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.
Callbacks#
void
sl_zigbee_af_ota_storage_simple_eeprom_erase_complete_cb(bool success)
Erase complete.
Functions#
void
sli_zigbee_af_ota_storage_write_int32u_to_eeprom(uint32_t value, uint32_t realOffset)
uint32_t
sli_zigbee_af_ota_storage_read_int32u_from_eeprom(uint32_t realOffset)
void
sli_zigbee_af_storage_eeprom_update_download_offset(uint32_t offset, bool finalOffset)
bool
sli_zigbee_af_ota_storage_driver_get_real_offset(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 SL_ZIGBEE_AF_PLUGIN_OTA_STORAGE_SIMPLE_EEPROM_STORAGE_START
#define
EEPROM_END SL_ZIGBEE_AF_PLUGIN_OTA_STORAGE_SIMPLE_EEPROM_STORAGE_END
#define
SAVE_RATE SL_ZIGBEE_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 SL_ZIGBEE_AF_PLUGIN_OTA_STORAGE_SIMPLE_EEPROM_GECKO_BOOTLOADER_STORAGE_SUPPORT
#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
MAX_IMAGE_INFO_AND_OTA_HEADER_SIZE (MAX_BYTEMASK_LENGTH + 1024)
#define
MINIMUM_FILE_SIZE_TO_STORE_OFFSET (OTA_MINIMUM_HEADER_LENGTH)
API Documentation#
otaStorageEepromGetStorageStartAddress#
uint32_t otaStorageEepromGetStorageStartAddress ()
Definition at line
250 of file app/framework/plugin/ota-storage-simple-eeprom/ota-storage-eeprom.hotaStorageEepromGetStorageEndAddress#
uint32_t otaStorageEepromGetStorageEndAddress ()
Definition at line
251 of file app/framework/plugin/ota-storage-simple-eeprom/ota-storage-eeprom.hotaStorageEepromGetImageInfoStartAddress#
uint32_t otaStorageEepromGetImageInfoStartAddress ()
Definition at line
252 of file app/framework/plugin/ota-storage-simple-eeprom/ota-storage-eeprom.hCallbacks Documentation#
sl_zigbee_af_ota_storage_simple_eeprom_erase_complete_cb#
void sl_zigbee_af_ota_storage_simple_eeprom_erase_complete_cb (bool success)
Erase complete.
Parameters
| N/A | success | The result of the erase operation. Ver.: always |
Called when an EEPROM erase operation has completed.
Definition at line
273 of file app/framework/plugin/ota-storage-simple-eeprom/ota-storage-eeprom.hFunction Documentation#
sli_zigbee_af_ota_storage_write_int32u_to_eeprom#
void sli_zigbee_af_ota_storage_write_int32u_to_eeprom (uint32_t value, uint32_t realOffset)
Parameters
| N/A | value | |
| N/A | realOffset |
Definition at line
256 of file app/framework/plugin/ota-storage-simple-eeprom/ota-storage-eeprom.hsli_zigbee_af_ota_storage_read_int32u_from_eeprom#
uint32_t sli_zigbee_af_ota_storage_read_int32u_from_eeprom (uint32_t realOffset)
Parameters
| N/A | realOffset |
Definition at line
257 of file app/framework/plugin/ota-storage-simple-eeprom/ota-storage-eeprom.hsli_zigbee_af_storage_eeprom_update_download_offset#
void sli_zigbee_af_storage_eeprom_update_download_offset (uint32_t offset, bool finalOffset)
Parameters
| N/A | offset | |
| N/A | finalOffset |
Definition at line
258 of file app/framework/plugin/ota-storage-simple-eeprom/ota-storage-eeprom.hsli_zigbee_af_ota_storage_driver_get_real_offset#
bool sli_zigbee_af_ota_storage_driver_get_real_offset (uint32_t * offset, uint32_t * length)
Parameters
| N/A | offset | |
| N/A | length |
Definition at line
260 of file app/framework/plugin/ota-storage-simple-eeprom/ota-storage-eeprom.h