ODeV framework  v2
Data Structures | Typedefs | Functions
IBootVtbl.h File Reference

<DESCRIPTIOM> More...

#include "systp.h"
#include "systypes.h"
#include "syserror.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_INLINE sys_error_code_t IBootInit (IBoot *this)
 
SYS_DEFINE_INLINE boolean_t IBootCheckDFUTrigger (IBoot *this)
 
SYS_DEFINE_INLINE uint32_t IBootGetAppAdderss (IBoot *this)
 
SYS_DEFINE_INLINE sys_error_code_t IBootOnJampToApp (IBoot *this, uint32_t nAppDress)
 

Detailed Description

<DESCRIPTIOM>

Author
STMicroelectronics - ST-Korea - MCD Team
Version
1.0.0
Date
Nov 22, 2017
Attention

© COPYRIGHT 2017 STMicroelectronics

Licensed under MCD-ST Liberty SW License Agreement V2, (the "License"); You may not use this file except in compliance with the License. You may obtain a copy of the License at:

   http://www.st.com/software_license_agreement_liberty_v2

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Typedef Documentation

◆ IBoot_vtbl

typedef struct _IBoot_vtbl IBoot_vtbl

Create a type name for _IBoot_vtbl.

Function Documentation

◆ IBootCheckDFUTrigger()

SYS_DEFINE_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_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_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_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.