Microchip® Advanced Software Framework

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Defines

     Specifies the macros and defines used by the OTA APIs.

Macros

#define HFD_INVALID_HANDLER   (0xff)
 
#define MAX_FILE_READ_STEP   128
 
#define OTA_FORMAT_VER_0   (0)
 
#define OTA_FORMAT_VER_1   (1)
 
#define OTA_FORMAT_VER_2   (2)
 
#define OTA_MAGIC_VALUE   (0x1ABCDEF9)
 
#define OTA_SHA256_DIGEST_SIZE   (32)
 
#define OTA_STATUS_INVALID   (0x23987718)
 
#define OTA_STATUS_VALID   (0x12526285)
 

#define HFD_INVALID_HANDLER   (0xff)

Defines an ID which symbolizes an invalid handler.

Referenced by m2m_ota_host_file_erase(), m2m_ota_host_file_get(), m2m_ota_host_file_read_hif(), and m2m_ota_host_file_read_spi().

#define MAX_FILE_READ_STEP   128

Max amount of bytes to read a file via HIF messages.

#define OTA_FORMAT_VER_0   (0)

Control structure format version 0.
Format used until version 19.2.2.

#define OTA_FORMAT_VER_1   (1)

Control structure format version 1.
Starting from 19.3.0 CRC is used and sequence number is used.

#define OTA_FORMAT_VER_2   (2)

Control structure format version 2.
Starting from 19.6.1 a flexible flash map is used.

#define OTA_MAGIC_VALUE   (0x1ABCDEF9)

Magic value set at the beginning of the OTA image header

#define OTA_SHA256_DIGEST_SIZE   (32)

Sha256 digest size in the OTA image, the sha256 digest is set at the beginning of image before the OTA header

#define OTA_STATUS_INVALID   (0x23987718)

Magic value updated in the Control structure in case of ROLLBACK image InValid

#define OTA_STATUS_VALID   (0x12526285)

Magic value updated in the Control structure in case of ROLLBACK image Valid