OTA Storage Common#

API and Callbacks for the OTA Storage Common Component.

Common code for any storage module implementing an Over-the-Air bootload cluster. It is used by either the Zigbee or legacy Ember Standalone bootloader implementations.

Modules#

OTA Storage

API#

bool

sl_zigbee_af_is_ota_image_id_valid(const sl_zigbee_af_ota_image_id_t *idToCompare)

A call to check if the OTA Image ID is valid.

Macros#

#define

OTA_MINIMUM_HEADER_LENGTH (20 + 32 + 4)

Defines the minimum header length for the OTA file.

#define

OTA_MAXIMUM_HEADER_LENGTH (OTA_MINIMUM_HEADER_LENGTH + 1 + 8 + 4)

Defines the maximum header length for the OTA file.

#define

OTA_MAXIMUM_HEADER_LENGTH_2_BYTE_ALIGNED (OTA_MAXIMUM_HEADER_LENGTH + 1)

#define

OTA_MAXIMUM_HEADER_LENGTH_4_BYTE_ALIGNED (OTA_MAXIMUM_HEADER_LENGTH + 3)

#define

OTA_FILE_MAGIC_NUMBER 0x0BEEF11EL

#define

MAGIC_NUMBER_OFFSET 0

#define

HEADER_VERSION_OFFSET 4

#define

HEADER_LENGTH_OFFSET 6

#define

FIELD_CONTROL_OFFSET 8

#define

MANUFACTURER_ID_OFFSET 10

#define

IMAGE_TYPE_ID_OFFSET 12

#define

VERSION_OFFSET 14

#define

STACK_VERSION_OFFSET 18

#define

HEADER_STRING_OFFSET 20

#define

IMAGE_SIZE_OFFSET 52

#define

OPTIONAL_FIELDS_OFFSET 56

#define

HEADER_LENGTH_FIELD_LENGTH 2

#define

TAG_OVERHEAD (2 + 4)

Tag Overhead. 2 bytes for the Tag ID and 4 bytes for the length.

#define

isValidHeaderVersion (headerVersion)

Check if the header version is valid.

#define

SECURITY_CREDENTIAL_VERSION_FIELD_PRESENT_MASK 0x0001

#define

DEVICE_SPECIFIC_FILE_PRESENT_MASK 0x0002

#define

HARDWARE_VERSIONS_PRESENT_MASK 0x0004

#define

headerHasSecurityCredentials (header)

Check if the header has security credentials present.

#define

headerHasUpgradeFileDest (header)

Check if the header has an upgrade file destination.

#define

headerHasHardwareVersions (header)

Check if the header has the hardware version present.

#define

SIGNATURE_TAG_DATA_SIZE (EUI64_SIZE + SL_ZIGBEE_SIGNATURE_SIZE)

#define

SIGNATURE_283K1_TAG_DATA_SIZE (EUI64_SIZE + SL_ZIGBEE_SIGNATURE_283K1_SIZE)

#define

INVALID_MANUFACTURER_ID 0xFFFF

#define

INVALID_DEVICE_ID 0xFFFF

#define

INVALID_FIRMWARE_VERSION 0xFFFFFFFFUL

#define

INVALID_EUI64 { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }

#define

INVALID_OTA_IMAGE_ID undefined

#define

INVALID_SLOT (uint32_t)-1

#define

DEFAULT_SLOT 0

Default to using storage slot 0.

API Documentation#

sl_zigbee_af_is_ota_image_id_valid#

bool sl_zigbee_af_is_ota_image_id_valid (const sl_zigbee_af_ota_image_id_t * idToCompare)

A call to check if the OTA Image ID is valid.

Parameters

Type	Direction	Argument Name	Description
const sl_zigbee_af_ota_image_id_t *	[in]	idToCompare	a pointer of type: sl_zigbee_af_ota_image_id_t referring to the OTA image ID

Returns

A ::bool value returning true if the OTA Id is valid