Storage API accessible from the application.

Public Attributes#

uint32_t
version

Version of this struct.

void(*
getInfo

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

int32_t(*
getSlotInfo

Get information about storage slot – size, location.

int32_t(*
read

Read bytes from slot into buffer.

int32_t(*
write

Write bytes from buffer into slot.

int32_t(*
erase

Erase an entire slot.

int32_t(*
setImagesToBootload

Mark a list of slots for bootload.

int32_t(*
getImagesToBootload

Mark a list of slots for bootload.

int32_t(*
appendImageToBootloadList

Append a slot to bootload list.

int32_t(*
initParseImage

Start image parsing.

int32_t(*
verifyImage

Continue image verification.

int32_t(*
getImageInfo

Get app and bootloader upgrade information from storage slot.

bool(*
isBusy

Check whether the bootloader storage is busy.

int32_t(*
readRaw

Read raw bytes from storage.

int32_t(*
writeRaw

Write bytes to raw storage.

int32_t(*
eraseRaw

Erase storage.

int32_t(*
getDMAchannel

Get configured DMA channel.

Public Attribute Documentation#

version#

uint32_t BootloaderStorageFunctions_t::version

Version of this struct.


Definition at line 156 of file platform/bootloader/api/btl_interface_storage.h

getInfo#

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

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


Definition at line 158 of file platform/bootloader/api/btl_interface_storage.h

getSlotInfo#

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

Get information about storage slot – size, location.


Definition at line 160 of file platform/bootloader/api/btl_interface_storage.h

read#

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

Read bytes from slot into buffer.


Definition at line 162 of file platform/bootloader/api/btl_interface_storage.h

write#

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

Write bytes from buffer into slot.


Definition at line 167 of file platform/bootloader/api/btl_interface_storage.h

erase#

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

Erase an entire slot.


Definition at line 172 of file platform/bootloader/api/btl_interface_storage.h

setImagesToBootload#

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

Mark a list of slots for bootload.


Definition at line 175 of file platform/bootloader/api/btl_interface_storage.h

getImagesToBootload#

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

Mark a list of slots for bootload.


Definition at line 177 of file platform/bootloader/api/btl_interface_storage.h

appendImageToBootloadList#

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

Append a slot to bootload list.


Definition at line 179 of file platform/bootloader/api/btl_interface_storage.h

initParseImage#

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

Start image parsing.


Definition at line 182 of file platform/bootloader/api/btl_interface_storage.h

verifyImage#

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

Continue image verification.


Definition at line 186 of file platform/bootloader/api/btl_interface_storage.h

getImageInfo#

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

Get app and bootloader upgrade information from storage slot.


Definition at line 189 of file platform/bootloader/api/btl_interface_storage.h

isBusy#

bool(* BootloaderStorageFunctions_t::isBusy) (void)

Check whether the bootloader storage is busy.


Definition at line 193 of file platform/bootloader/api/btl_interface_storage.h

readRaw#

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

Read raw bytes from storage.


Definition at line 195 of file platform/bootloader/api/btl_interface_storage.h

writeRaw#

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

Write bytes to raw storage.


Definition at line 197 of file platform/bootloader/api/btl_interface_storage.h

eraseRaw#

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

Erase storage.


Definition at line 199 of file platform/bootloader/api/btl_interface_storage.h

getDMAchannel#

int32_t(* BootloaderStorageFunctions_t::getDMAchannel) (void)

Get configured DMA channel.


Definition at line 201 of file platform/bootloader/api/btl_interface_storage.h