IBootVtbl.h File Reference

<DESCRIPTIOM> More...

#include "services/eloom_sysbase.h"

Include dependency graph for IBootVtbl.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_IBoot_vtbl
struct	_IBoot

Typedefs
typedef struct _IBoot_vtbl	IBoot_vtbl

Functions
SYS_DEFINE_STATIC_INLINE sys_error_code_t	IBootInit (IBoot *_this)
SYS_DEFINE_STATIC_INLINE boolean_t	IBootCheckDFUTrigger (IBoot *_this)
SYS_DEFINE_STATIC_INLINE uint32_t	IBootGetAppAdderss (IBoot *_this)
SYS_DEFINE_STATIC_INLINE sys_error_code_t	IBootOnJampToApp (IBoot *_this, uint32_t nAppDress)

Detailed Description

<DESCRIPTIOM>

Author

STMicroelectronics - ST-Korea - MCD Team

Version

3.0.0

Date

Nov 22, 2017

Attention

Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Typedef Documentation

IBoot_vtbl

typedef struct _IBoot_vtbl IBoot_vtbl

Create a type name for _IBoot_vtbl.

Function Documentation

IBootCheckDFUTrigger()

SYS_DEFINE_STATIC_INLINE boolean_t IBootCheckDFUTrigger ( IBoot *  _this )

inline

Check if the DFU condition occurs. If it is TRUE the bootloader enters the DFU mode,

Parameters

_this

[IN] specifies a pointer to the object.

Returns

TRUE if the system must enter the DFU mode, FALSE otherwise.

IBootGetAppAdderss()

SYS_DEFINE_STATIC_INLINE uint32_t IBootGetAppAdderss ( IBoot *  _this )

inline

Used by the system to retrieve the address of the application to start.

Parameters

_this

[IN] specifies a pointer to the object.

Returns

the address where is located the application to start.

IBootInit()

SYS_DEFINE_STATIC_INLINE sys_error_code_t IBootInit ( IBoot *  _this )

inline

Initialize the interface IBoot. It should be called after the object allocation and before using the object.

Parameters

_this

[IN] specifies a pointer to the object.

Returns

SYS_NO_ERROR_CODE if success, an error code otherwise.

IBootOnJampToApp()

SYS_DEFINE_STATIC_INLINE sys_error_code_t IBootOnJampToApp ( IBoot *  _this, uint32_t  nAppDress  )

inline

Called by the system before the jump to the other application. It can be used to perform some operations before the jump and also to stop the system from jump,.

Parameters

_this	[IN] specifies a pointer to the object.
nAppDress	[IN] specifies the address of the application to start.

Returns

SYS_NO_ERROR_CODE if the system can continue with the jump, an application specific error code otherwise.