Storage#

storage_init#

int32_t storage_init (void )

Initialize the storage component.

Returns

• Error code indicating success or failure.

Return values

• BOOTLOADER_OK: on success

• BOOTLOADER_ERROR_INIT_STORAGE: on failure

storage_main#

int32_t storage_main (void )

Main function for storage component.

Returns

• BOOTLOADER_OK on success, else error code

storage_shutdown#

int32_t storage_shutdown (void )

Shutdown storage component.

Returns

• Error code indicating success or failure.

Return values

• BOOTLOADER_OK: on success

• BOOTLOADER_ERROR_INIT_STORAGE: on failure

storage_getInfo#

void storage_getInfo (BootloaderStorageInformation_t * info)

Get information about the storage component running on the device.

storage_getSlotInfo#

int32_t storage_getSlotInfo (uint32_t slotId, BootloaderStorageSlot_t * slot)

Get information about the layout of a storage slot.

Returns

• BOOTLOADER_OK on success, else error code in BOOTLOADER_ERROR_STORAGE_BASE range

storage_getSlotMetadata#

int32_t storage_getSlotMetadata (BootloaderParserContext_t * context, ApplicationData_t * appInfo, uint32_t * bootloaderVersion)

Get information about the contents of a storage slot.

Note

• storage_initParseSlotmust be called before calling this function to initialize the context.

• If the slot does not contain an application or a bootloader, the the corresponding values are set to zero.

Returns

• BOOTLOADER_OK on success

storage_initParseSlot#

int32_t storage_initParseSlot (uint32_t slotId, BootloaderParserContext_t * context, size_t contextSize)

Initialize the context variable for checking a slot and trying to parse the image contained in it.

Returns

• BOOTLOADER_OK on success, else error code in BOOTLOADER_ERROR_PARSE_BASE range

storage_verifySlot#

int32_t storage_verifySlot (BootloaderParserContext_t * context, BootloaderParserCallback_t metadataCallback)

Check the given slot for a valid image.

Call this function continuously until it stops returning. BOOTLOADER_ERROR_PARSE_CONTINUE.

The function returns BOOTLOADER_ERROR_PARSE_SUCCESS if the image in the slot was successfully verified. For detailed information on the parsed image, see imageProperties in the context variable.

Returns

• BOOTLOADER_ERROR_PARSE_CONTINUE if the parsing is not complete, BOOTLOADER_ERROR_PARSE_SUCCESS on success.

storage_upgradeSeFromSlot#

bool storage_upgradeSeFromSlot (uint32_t slotId)

Upgrade SE using image contained in a slot.

Note

• This function assumes the image located in the slotId has been verified first.

Returns

• True if the operation succeeded

storage_bootloadBootloaderFromSlot#

bool storage_bootloadBootloaderFromSlot (uint32_t slotId, uint32_t version)

Bootload a bootloader image contained in a slot.

Note

• This function assumes the image located in the slotId has been verified first.

Returns

• True if operation succeeded

storage_bootloadApplicationFromSlot#

bool storage_bootloadApplicationFromSlot (uint32_t slotId, uint32_t version)

Bootload an image contained in a slot.

Note

• This function assumes the image located in slotId has been verified first.

Returns

• True if the operation succeeded

storage_eraseSlot#

int32_t storage_eraseSlot (uint32_t slotId)

Erase the contents of a storage slot including all data and metadata.

Returns

• BOOTLOADER_OK on success, else error code in BOOTLOADER_ERROR_STORAGE_BASE range

storage_readSlot#

int32_t storage_readSlot (uint32_t slotId, uint32_t offset, uint8_t * buffer, size_t numBytes)

Read a number of words from a storage slot.

Returns

• BOOTLOADER_OK on success, else error code in BOOTLOADER_ERROR_STORAGE_BASE range

storage_writeSlot#

int32_t storage_writeSlot (uint32_t slotId, uint32_t offset, uint8_t * data, size_t numBytes)

Write a number of words to a storage slot.

Returns

• BOOTLOADER_OK on success, else error code in BOOTLOADER_ERROR_STORAGE_BASE range

storage_readRaw#

int32_t storage_readRaw (uint32_t address, uint8_t * buffer, size_t numBytes)

Read number of words from raw storage.

Returns

• BOOTLOADER_OK on success, else error code in BOOTLOADER_ERROR_STORAGE_BASE range

storage_writeRaw#

int32_t storage_writeRaw (uint32_t address, uint8_t * data, size_t numBytes)

Write a number of words to raw storage.

Returns

• BOOTLOADER_OK on success, else error code in BOOTLOADER_ERROR_STORAGE_BASE range

storage_getDMAchannel#

int32_t storage_getDMAchannel (void )

Get allocated DMA channel for MSC write.

Returns

• A positive number channel. -1 if DMA-based MSC write is not enabled.

storage_eraseRaw#

int32_t storage_eraseRaw (uint32_t address, size_t length)

Erase the raw storage.

Note

• Some devices, such as Flash-based storages, have restrictions on the alignment and size of erased regions. The details of the limitations of a particular storage can be found by reading the BootloaderStorageInformation_t struct using storage_getInfo.

Returns

• BOOTLOADER_OK on success, else error code in BOOTLOADER_ERROR_STORAGE_BASE range

storage_isBusy#

bool storage_isBusy (void )

Poll the storage implementation and check whether it is busy.

Returns

• True if the storage is busy

storage_getSpiUsartPPUSATD#

uint32_t storage_getSpiUsartPPUSATD (uint32_t * ppusatdNr)

Get PPUSATD word of the (E)USART in use.

Returns

• Word representing the PPUSATD bit field of the (E)USART in use. 0 if not found.

BOOTLOADER_STORAGE_FUNCTIONS_VERSION#

#define BOOTLOADER_STORAGE_FUNCTIONS_VERSION

0x00000100

Version number for bootloader storage functions struct.