OTA Storage Simple EEPROM#

API and Callbacks for the OTA Storage Simple EEPROM Component.

This is a driver for the Over-the-Air simple storage module component. It uses an EEPROM as the underlying storage device. It provides a means to record data being read or written, as well as metadata with information about how far along a client download is. It can be used either by an OTA Client or an OTA Server. Note that this component assumes that the flash storage does not have read-modify-write support. Users should ensure this value matches the flash storage device used by the application. A mismatch between the project-configured value and the actual flash storage support value will result in an application that asserts upon startup.

API#

uint32_t

otaStorageEepromGetStorageStartAddress()

uint32_t

otaStorageEepromGetStorageEndAddress()

uint32_t

otaStorageEepromGetImageInfoStartAddress()

Callbacks#

void

emberAfPluginOtaStorageSimpleEepromEraseCompleteCallback(bool success)

Erase complete.

Functions#

void

emAfOtaStorageWriteInt32uToEeprom(uint32_t value, uint32_t realOffset)

uint32_t

emAfOtaStorageReadInt32uFromEeprom(uint32_t realOffset)

void

emAfStorageEepromUpdateDownloadOffset(uint32_t offset, bool finalOffset)

bool

emAfOtaStorageDriverGetRealOffset(uint32_t *offset, uint32_t *length)

Macros#

#define

SOC_BOOTLOADING_SUPPORT_ENABLED false

#define

SOC_BOOTLOADING_SUPPORT_TEXT "no"

#define

READ_MODIFY_WRITE_SUPPORT_TEXT "no"

#define

EEPROM_START EMBER_AF_PLUGIN_OTA_STORAGE_SIMPLE_EEPROM_STORAGE_START

#define

EEPROM_END EMBER_AF_PLUGIN_OTA_STORAGE_SIMPLE_EEPROM_STORAGE_END

#define

SAVE_RATE EMBER_AF_PLUGIN_OTA_STORAGE_SIMPLE_EEPROM_DOWNLOAD_OFFSET_SAVE_RATE

#define

DEFAULT_SLOT 0

#define

USE_FIRST_SLOT 0

#define

USE_LAST_SLOT 1

#define

USE_SPECIFIC_SLOT 2

#define

DO_NOT_USE_SLOTS 3

#define

SLOT_STRATEGY EMBER_AF_PLUGIN_OTA_STORAGE_SIMPLE_EEPROM_GECKO_BOOTLOADER_STORAGE_SUPPORT

#define

MAX_IMAGE_INFO_AND_OTA_HEADER_SIZE 2048

#define

MAX_WORD_SIZE 4

#define

MAGIC_NUMBER_INDEX 0

#define

MAGIC_NUMBER_SIZE 8

#define

VERSION_NUMBER_INDEX (MAGIC_NUMBER_INDEX + MAGIC_NUMBER_SIZE)

#define

VERSION_NUMBER_SIZE 4

#define

MAGIC_NUMBER 0x01, 0x09, 0x05, 0x01, 0x00, 0x02, 0x00, 0x00

#define

VERSION_NUMBER 0x00, 0x00, 0x00, 0x03

#define

EBL_START_OFFSET_INDEX (VERSION_NUMBER_INDEX + VERSION_NUMBER_SIZE)

#define

EBL_START_OFFSET_SIZE 4

#define

SAVED_DOWNLOAD_OFFSET_INDEX (EBL_START_OFFSET_INDEX + EBL_START_OFFSET_SIZE)

#define

MAX_BYTEMASK_LENGTH 1024

#define

OTA_HEADER_INDEX (SAVED_DOWNLOAD_OFFSET_INDEX + MAX_BYTEMASK_LENGTH)

#define

MINIMUM_FILE_SIZE_TO_STORE_OFFSET (OTA_MINIMUM_HEADER_LENGTH)

API Documentation#

otaStorageEepromGetStorageStartAddress#

uint32_t otaStorageEepromGetStorageStartAddress ()

otaStorageEepromGetStorageEndAddress#

uint32_t otaStorageEepromGetStorageEndAddress ()

otaStorageEepromGetImageInfoStartAddress#

uint32_t otaStorageEepromGetImageInfoStartAddress ()

Callbacks Documentation#

emberAfPluginOtaStorageSimpleEepromEraseCompleteCallback#

void emberAfPluginOtaStorageSimpleEepromEraseCompleteCallback (bool success)

Erase complete.

Parameters

Type	Direction	Argument Name	Description
bool	N/A	success	The result of the erase operation. Ver.: always

Called when an EEPROM erase operation has completed.

Function Documentation#

emAfOtaStorageWriteInt32uToEeprom#

void emAfOtaStorageWriteInt32uToEeprom (uint32_t value, uint32_t realOffset)

Parameters

Type	Direction	Argument Name	Description
uint32_t	N/A	value
uint32_t	N/A	realOffset

emAfOtaStorageReadInt32uFromEeprom#

uint32_t emAfOtaStorageReadInt32uFromEeprom (uint32_t realOffset)

Parameters

Type	Direction	Argument Name	Description
uint32_t	N/A	realOffset

emAfStorageEepromUpdateDownloadOffset#

void emAfStorageEepromUpdateDownloadOffset (uint32_t offset, bool finalOffset)

Parameters

Type	Direction	Argument Name	Description
uint32_t	N/A	offset
bool	N/A	finalOffset

emAfOtaStorageDriverGetRealOffset#

bool emAfOtaStorageDriverGetRealOffset (uint32_t * offset, uint32_t * length)

Parameters

Type	Direction	Argument Name	Description
uint32_t *	N/A	offset
uint32_t *	N/A	length