AWS IoT Over-the-air Update
v2.0.0 (Release Candidate)
Client library for AWS IoT OTA
|
|
Go to the documentation of this file.
28 #ifndef OTA_PLATFORM_INTERFACE
29 #define OTA_PLATFORM_INTERFACE
72 typedef enum OtaPalMainStatus
106 #define OTA_PAL_ERR_MASK 0xffffffUL
107 #define OTA_PAL_SUB_BITS 24U
108 #define OTA_PAL_MAIN_ERR( err ) ( ( OtaPalMainStatus_t ) ( uint32_t ) ( ( uint32_t ) ( err ) >> ( uint32_t ) OTA_PAL_SUB_BITS ) )
109 #define OTA_PAL_SUB_ERR( err ) ( ( uint32_t ) ( err ) & ( uint32_t ) OTA_PAL_ERR_MASK )
110 #define OTA_PAL_COMBINE_ERR( main, sub ) ( ( uint32_t ) ( main ) << ( uint32_t ) OTA_PAL_SUB_BITS | ( uint32_t ) ( sub ) )
207 uint8_t *
const pData,
208 uint32_t blockSize );
291 typedef struct OtaPalInterface
@ OtaPalAbortFailed
Error trying to abort the OTA.
Definition: ota_platform_interface.h:84
OtaPalSetPlatformImageState_t setPlatformImageState
Set the state of the OTA update image.
Definition: ota_platform_interface.h:303
OtaPalGetPlatformImageState_t getPlatformImageState
Get the state of the OTA update image.
Definition: ota_platform_interface.h:304
OTA File Context Information.
Definition: ota_private.h:390
OtaImageState_t
OTA Image states.
Definition: ota_private.h:322
@ OtaPalUninitialized
Result is not yet initialized from PAL.
Definition: ota_platform_interface.h:75
@ OtaPalNullFileContext
The PAL is called with a NULL file context.
Definition: ota_platform_interface.h:77
OtaPalActivateNewImage_t activate
Activate the file received over-the-air.
Definition: ota_platform_interface.h:301
OtaPalWriteBlock_t writeBlock
Write a block of data to the specified file at the given offset.
Definition: ota_platform_interface.h:300
@ OtaPalRxFileTooLarge
The OTA receive file is too big for the platform to support.
Definition: ota_platform_interface.h:80
OtaPalCloseFile_t closeFile
Authenticate and close the receive file.
Definition: ota_platform_interface.h:299
OtaPalAbort_t abort
Abort an OTA transfer.
Definition: ota_platform_interface.h:297
Macros, enums, variables, and definitions internal to the OTA Agent module and shared by other OTA mo...
@ OtaPalFileClose
Error in low level file close.
Definition: ota_platform_interface.h:89
@ OtaPalSuccess
OTA platform interface success.
Definition: ota_platform_interface.h:74
OtaPalImageState_t
OTA Platform Image State.
Definition: ota_private.h:339
@ OtaPalSignatureCheckFailed
The signature check failed for the specified file.
Definition: ota_platform_interface.h:78
@ OtaPalRxFileCreateFailed
The PAL failed to create the OTA receive file.
Definition: ota_platform_interface.h:79
OtaPalCreateFileForRx_t createFile
Create a new receive file.
Definition: ota_platform_interface.h:298
@ OtaPalOutOfMemory
Out of memory.
Definition: ota_platform_interface.h:76
@ OtaPalCommitFailed
The acceptance commit of the new OTA image failed.
Definition: ota_platform_interface.h:86
OtaPalMainStatus_t
The OTA platform interface main status.
Definition: ota_platform_interface.h:73
@ OtaPalBadSignerCert
The signer certificate was not readable or zero length.
Definition: ota_platform_interface.h:82
OTA pal Interface structure.
Definition: ota_platform_interface.h:292
@ OtaPalActivateFailed
The activation of the new OTA image failed.
Definition: ota_platform_interface.h:87
@ OtaPalRejectFailed
Error trying to reject the OTA image.
Definition: ota_platform_interface.h:85
@ OtaPalBadImageState
The specified OTA image state was out of range.
Definition: ota_platform_interface.h:83
OtaPalResetDevice_t reset
Reset the device.
Definition: ota_platform_interface.h:302
@ OtaPalBootInfoCreateFailed
The PAL failed to create the OTA boot info file.
Definition: ota_platform_interface.h:81
@ OtaPalFileAbort
Error in low level file abort.
Definition: ota_platform_interface.h:88