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

API of the Partition agent. More...

+ Collaboration diagram for FotaPartitionAgent:

Modules

 CC26XXPartitionAgent
 Supports the partition agent functionalities for TI CC26XX internal Flash memory. All necessary file system based functionalities are supported.
 
 EFM32XXPartitionAgent
 Supports the partition agent functionalities for efm32xx internal Flash memory. All necessary file system based functionalities are supported.
 
 MX25R8035FPartitionAgent
 Supports the partition agent functionalities for MX25R8035F External Flash memory. All necessary file system based functionalities are supported.
 
 SDCardPartitionAgent
 Supports the partition agent functionalities for SD card. All necessary file system based functionalities are supported.
 
 W25X40PartitionAgent
 Supports the partition agent functionalities for W25X40CL External Flash memory. All necessary file system based functionalities are supported.
 

Files

file  BCDS_FotaPartitionAgent.h
 

Data Structures

struct  FotaPartitionAgent_S
 

Typedefs

typedef uint32_t FotaPartitionAgent_Adr_T
 This enum represents the different FOTA Partition addresses. More...
 
typedef Retcode_T(* FotaPartitionAgent_Deinitialize_T )(void *self)
 Deinit the agent. More...
 
typedef Retcode_T(* FotaPartitionAgent_ErasePartition_T )(void *self)
 Erase the partition. More...
 
typedef Retcode_T(* FotaPartitionAgent_Flush_T )(void *self)
 Flush into the partition. More...
 
typedef Retcode_T(* FotaPartitionAgent_GetSavedSize_T )(void *self, uint32_t *size)
 Get the number of data saved into the partition. More...
 
typedef Retcode_T(* FotaPartitionAgent_Initialize_T )(void *self, FotaRegistryAgent_T *registryAgent, EventHub_T *hub, FotaPartitionAgent_Adr_T partition, uint32_t partitionSize)
 Initialization of a partition agent. More...
 
typedef Retcode_T(* FotaPartitionAgent_Read_T )(void *self, uint8_t *buffer, uint32_t offset, uint32_t size)
 Read on the partition. More...
 
typedef struct FotaPartitionAgent_S FotaPartitionAgent_T
 
typedef Retcode_T(* FotaPartitionAgent_Write_T )(void *self, uint8_t *buffer, uint32_t offset, uint32_t size)
 Write on the partition. More...
 

Detailed Description

It's role is to take care of a defined partition on a defined storage.


Data Structure Documentation

struct FotaPartitionAgent_S

Typedef Documentation

typedef uint32_t FotaPartitionAgent_Adr_T
typedef Retcode_T(* FotaPartitionAgent_Deinitialize_T)(void *self)
Parameters
[in]void* self Pointer on a FotaPartitionAgent_T object.
Returns
RETCODE_NULL_POINTER A null pointer was provided.
Based on the W25X40CL_PowerOff status (Only for W25X40CLPartitionAgent)
RETCODE_OK
typedef Retcode_T(* FotaPartitionAgent_ErasePartition_T)(void *self)
Parameters
[in]void* self Pointer on a FotaPartitionAgent_T object.
Returns
RETCODE_NULL_POINTER A null pointer was provided.
#XXXX_FILE_ERASE_ERROR File erase fails (based on the selected partition)
RETCODE_INVALID_PARAM when the selected partition is not a download or backup partition (based on the selected partition)
RETCODE_OK File erase successful
typedef Retcode_T(* FotaPartitionAgent_Flush_T)(void *self)
Parameters
[in]void* self Pointer on a FotaPartitionAgent_T object.
Returns
RETCODE_NULL_POINTER A null pointer was provided.
RETCODE_INVALID_PARAM when the selected partition is not a download or backup partition (based on the selected partition)
RETCODE_OK
typedef Retcode_T(* FotaPartitionAgent_GetSavedSize_T)(void *self, uint32_t *size)
Parameters
[in]void* self Pointer on a FotaPartitionAgent_T object.
[out]uint32_t* size Return the size that was saved.
Returns
RETCODE_NULL_POINTER A null pointer was provided.
RETCODE_INVALID_PARAM when the selected partition is not a download or backup partition (based on the selected partition)
SDCARD_NOT_DETECTED if the SDcard insertion fails (Only for SD card partition agent)
RETCODE_OK
typedef Retcode_T(* FotaPartitionAgent_Initialize_T)(void *self, FotaRegistryAgent_T *registryAgent, EventHub_T *hub, FotaPartitionAgent_Adr_T partition, uint32_t partitionSize)
Parameters
[in]void* self Pointer on a FotaPartitionAgent_T object.
[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]FotaPartitionAgent_Adr_Tpartition Start address of the partition.
[in]uint32_tpartitionSize Size of the partition.
Returns
RETCODE_NULL_POINTER A null pointer was provided.
RETCODE_OK Partition agent initialize successfully
typedef Retcode_T(* FotaPartitionAgent_Read_T)(void *self, uint8_t *buffer, uint32_t offset, uint32_t size)
Parameters
[in]void* self Pointer on a FotaPartitionAgent_T object.
[in]uint8_t* buffer Pointer of a buffer of data to copy.
[in]uint32_toffset Relative offset on the partition.
[in]uint32_tsize Size to read.
Returns
RETCODE_NULL_POINTER A null pointer was provided.
#XXXX_OUT_OF_STORAGE while reading the data from out of storage (based on the selected partition)
#XXXX_FILE_READ_ERROR File read fails (based on the selected partition)
RETCODE_OK File read successful
typedef Retcode_T(* FotaPartitionAgent_Write_T)(void *self, uint8_t *buffer, uint32_t offset, uint32_t size)
Parameters
[in]void* self Pointer on a FotaPartitionAgent_T object.
[in]uint8_t* buffer Pointer of a buffer of data to copy.
[in]uint32_toffset Relative offset on the partition.
[in]uint32_tsize Size to write.
Returns
RETCODE_NULL_POINTER A null pointer was provided.
#XXXX_OUT_OF_STORAGE while writing the data to out of storage (based on the selected partition)
#XXXX_FILE_WRITE_ERROR File write fails (based on the selected partition)
RETCODE_OK File write 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