XDK API  3.6.0
Documentation
Modules | Files | Data Structures | Typedefs
FotaCopyAgent

API of the copyAgent. More...

+ Collaboration diagram for FotaCopyAgent:

Modules

 Block512CopyAgent
 This will support the copy agent fuinctionalities for Block 512. Supports upgrade and downgrade of the Firmware.
 

Files

file  BCDS_FotaCopyAgent.h
 

Data Structures

struct  FotaCopyAgent_S
 

Typedefs

typedef Retcode_T(* FotaCopyAgent_Deinitialize_T )(void)
 Deinitialize the agent. More...
 
typedef Retcode_T(* FotaCopyAgent_Initialize_T )(FotaRegistryAgent_T *registryAgent, EventHub_T *hub, FotaPartitionAgent_T *primaryPartitionAgent, FotaPartitionAgent_T *backupPartitionAgent, FotaPartitionAgent_T *downloadPartitionAgent)
 During the initialization, the agent will save in his internal context the different handle to 3 already initialized partitionAgents, registryAgent and EventHub. More...
 
typedef Retcode_T(* FotaCopyAgent_Rollback_T )(void)
 Copy always from backup to primary partition. If eventHub was given, messages will also transit through it. More...
 
typedef struct FotaCopyAgent_S FotaCopyAgent_T
 
typedef Retcode_T(* FotaCopyAgent_Update_T )(void)
 Copy always from primary to backup partition and download to primary partition. If eventHub was given, messages will also transit through it. More...
 

Detailed Description

It's role is to swap paritions.


Data Structure Documentation

struct FotaCopyAgent_S

Exposed interface fo the copy agent.

+ Collaboration diagram for FotaCopyAgent_S:

Data Fields

FotaCopyAgent_Deinitialize_T Deinitialize
 
FotaCopyAgent_Initialize_T Initialize
 
FotaCopyAgent_Rollback_T Rollback
 
FotaCopyAgent_Update_T Update
 

Field Documentation

Typedef Documentation

typedef Retcode_T(* FotaCopyAgent_Deinitialize_T)(void)
Returns
RETCODE_OK Deinit successful
typedef Retcode_T(* FotaCopyAgent_Initialize_T)(FotaRegistryAgent_T *registryAgent, EventHub_T *hub, FotaPartitionAgent_T *primaryPartitionAgent, FotaPartitionAgent_T *backupPartitionAgent, FotaPartitionAgent_T *downloadPartitionAgent)
Parameters
[in]FotaRegistryAgent_T* registryAgent This agent is used to save the internal state of the agent before a reboot.
[in]EventHub_T* hub This hub allows to the agent to communicate in an asynchrony way with the application using it. In the case of the bootloader, NULL can be provided here.
[in]FotaPartitionAgent_T* primaryPartitionAgent This agent handle the primary partition (where the bootloader will jump).
[in]FotaPartitionAgent_T* backupPartitionAgent This agent handle the backup partition (where we will store our primary partition after a fota).
[in]FotaPartitionAgent_T* downloadPartitionAgent This agent handle the download partition (where we will store our new firmware after a fota).
Returns
RETCODE_NULL_POINTER A null pointer was provided (not applicable to the eventHub)
FOTA_CPY_SIZE_WRONG The 3 partitionAgents does not have a same partition size set
RETCODE_OK Initialization was successful.
typedef Retcode_T(* FotaCopyAgent_Rollback_T)(void)
Returns
#RETXXXXXXX The partition agents will return errors and this function will forward them
RETCODE_OK Swap was successful
typedef Retcode_T(* FotaCopyAgent_Update_T)(void)
Returns
#RETXXXXXXX The partition agents will return errors and this function will forward them
RETCODE_OK Swap was successful

All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:51 by doxygen 1.8.8