Storage API accessible from the application.

Public Attributes#

uint32_t

Version of this struct.

void(*

Get information about the storage – capabilities, layout, configuration.

int32_t(*

Get information about storage slot – size, location.

int32_t(*

Read bytes from slot into buffer.

int32_t(*

Write bytes from buffer into slot.

void(*

Get application minimum version.

int32_t(*

Mark a list of slots for bootload.

int32_t(*

Mark a list of slots for bootload.

int32_t(*

Append a slot to bootload list.

int32_t(*

Start image parsing.

int32_t(*

Continue image verification.

int32_t(*

Get app and bootloader upgrade information from storage slot.

bool(*

Check whether the bootloader storage is busy.

int32_t(*

Read raw bytes from storage.

int32_t(*

Write bytes to raw storage.

int32_t(*

Erase storage.

int32_t(*

Get configured DMA channel.

int32_t(*

Erase an entire slot.

Public Attribute Documentation#

version#

uint32_t BootloaderStorageFunctions_t::version

Version of this struct.


getInfo#

void(* BootloaderStorageFunctions_t::getInfo)(BootloaderStorageInformation_t *info)

Get information about the storage – capabilities, layout, configuration.


getSlotInfo#

int32_t(* BootloaderStorageFunctions_t::getSlotInfo)(uint32_t slotId, BootloaderStorageSlot_t *slot)

Get information about storage slot – size, location.


read#

int32_t(* BootloaderStorageFunctions_t::read)(uint32_t slotId, uint32_t offset, uint8_t *buffer, size_t length)

Read bytes from slot into buffer.


write#

int32_t(* BootloaderStorageFunctions_t::write)(uint32_t slotId, uint32_t offset, uint8_t *buffer, size_t length)

Write bytes from buffer into slot.


getAppMinVersion#

void(* BootloaderStorageFunctions_t::getAppMinVersion) (uint32_t *version)

Get application minimum version.


setImagesToBootload#

int32_t(* BootloaderStorageFunctions_t::setImagesToBootload)(int32_t *slotIds, size_t length)

Mark a list of slots for bootload.


getImagesToBootload#

int32_t(* BootloaderStorageFunctions_t::getImagesToBootload)(int32_t *slotIds, size_t length)

Mark a list of slots for bootload.


appendImageToBootloadList#

int32_t(* BootloaderStorageFunctions_t::appendImageToBootloadList)(int32_t slotId)

Append a slot to bootload list.


initParseImage#

int32_t(* BootloaderStorageFunctions_t::initParseImage)(uint32_t slotId, BootloaderParserContext_t *context, size_t contextSize)

Start image parsing.


verifyImage#

int32_t(* BootloaderStorageFunctions_t::verifyImage)(BootloaderParserContext_t *context, BootloaderParserCallback_t metadataCallback)

Continue image verification.


getImageInfo#

int32_t(* BootloaderStorageFunctions_t::getImageInfo)(BootloaderParserContext_t *context, ApplicationData_t *appInfo, uint32_t *bootloaderVersion)

Get app and bootloader upgrade information from storage slot.


isBusy#

bool(* BootloaderStorageFunctions_t::isBusy)(void)

Check whether the bootloader storage is busy.


readRaw#

int32_t(* BootloaderStorageFunctions_t::readRaw)(uint32_t address, uint8_t *buffer, size_t length)

Read raw bytes from storage.


writeRaw#

int32_t(* BootloaderStorageFunctions_t::writeRaw)(uint32_t address, uint8_t *buffer, size_t length)

Write bytes to raw storage.


eraseRaw#

int32_t(* BootloaderStorageFunctions_t::eraseRaw)(uint32_t address, size_t length)

Erase storage.


getDMAchannel#

int32_t(* BootloaderStorageFunctions_t::getDMAchannel)(void)

Get configured DMA channel.


erase#

int32_t(* BootloaderStorageFunctions_t::erase) (uint32_t slotId)

Erase an entire slot.