Bootload#

bootload_getUpgradeLocation#

uint32_t bootload_getUpgradeLocation (void )

Get base address of the bootloader upgrade image.

Returns

• Returns the base address of bootloader upgrade image.

bootload_getBootloaderVersion#

uint32_t bootload_getBootloaderVersion (void )

Get the version of the bootloader.

Returns

• Returns the version of the bootloader.

bootload_getApplicationVersion#

bool bootload_getApplicationVersion (uint32_t * version)

Get the version of the application.

Returns

• Returns true if the version was retrieved successfully

bootload_checkApplicationPropertiesMagic#

bool bootload_checkApplicationPropertiesMagic (void * appProperties)

Check application properties magic.

Returns

• True if the application properties magic is valid.

bootload_checkApplicationPropertiesVersion#

bool bootload_checkApplicationPropertiesVersion (void * appProperties)

Check application properties struct version.

Returns

• True if the application properties struct version is compatible with the bootloader.

bootload_verifyApplication#

bool bootload_verifyApplication (uint32_t startAddress)

Verify the application image stored in the Flash memory starting at the address startAddress.

If secure boot is enforced, the function will only return true if the cryptographic signature of the application is valid. Else, the application is verified according to the signature type defined in the ApplicationProperties_t structure embedded in the application. Silicon Labs wireless stacks declare this structure. Applications, which are not using a full wireless stack may need to instantiate the structure.

Examples of results when secure boot is not enforced:

• App has no signature: Valid if initial stack pointer and program counter have reasonable values

• App has CRC checksum: Valid if checksum is valid

• App has ECDSA signature: Valid if ECDSA signature is valid.

When secure boot is enforced, only ECDSA-signed applications with a valid signature are considered valid.

Returns

• True if the image is deemed valid

bootload_bootloaderCallback#

void bootload_bootloaderCallback (uint32_t offset, uint8_t data, size_t length, void * context)

Bootloader upgrade callback implementation.

bootload_applicationCallback#

void bootload_applicationCallback (uint32_t address, uint8_t data, size_t length, void * context)

Image data callback implementation.

bootload_commitBootloaderUpgrade#

bool bootload_commitBootloaderUpgrade (uint32_t upgradeAddress, uint32_t size)

Perform a bootloader upgrade using the upgrade image present at upgradeAddress with length size.

If the bootloader upgrade process starts successfully, this function does not return and execution will resume from the reset handler of the upgraded bootloader.

Returns

• False if the bootloader upgrade process didn't start

bootload_verifyApplicationVersion#

bool bootload_verifyApplicationVersion (uint32_t appVersion, bool checkRemainingAppUpgrades)

Verify the application version for rollback protection.

Returns

• True if the application version is higher or equal than the application versions seen. False if the application version is lower than the application versions seen. False if no remaining application upgrades are left when checkRemainingAppUpgrades is true.

bootload_storeApplicationVersion#

bool bootload_storeApplicationVersion (uint32_t startAddress)

Store the application version.

Note

• Only the version of the verified application should be stored.

Returns

• True if application version is successfully stored.

bootload_remainingApplicationUpgrades#

uint32_t bootload_remainingApplicationUpgrades (void )

Count the total remaining number of application upgrades.

Returns

• remaining number of application upgrades.

bootload_storeApplicationVersionResetMagic#

void bootload_storeApplicationVersionResetMagic (void )

Store application version reset magic.

Note

• Store application version reset magic to ensure that application versions are cleaned after a bootloader upgrade.

bootload_removeStoredApplicationVersions#

void bootload_removeStoredApplicationVersions (void )

Clean the application versions seen.

Note

• The application versions are cleaned only if this is requested with a magic and the application version storage is not already empty.

bootload_getApplicationVersionStorageCapacity#

uint32_t bootload_getApplicationVersionStorageCapacity (void )

Get the application version storage capacity.

Returns

• Application version storage capacity.

bootload_getApplicationVersionStoragePtr#

uint32_t * bootload_getApplicationVersionStoragePtr (uint32_t index)

Get the address of the application version storage buffer.

Returns

• Address of the application version storage buffer with the given index.

bootload_gotCertificate#

bool bootload_gotCertificate (void * appProp)

Check whether the application contains a certificate.

Returns

• True if application contains a certificate.

bootload_verifyCertificate#

bool bootload_verifyCertificate (void * cert)

Verify a certificate with a bootloader certificate.

Returns

• True if certificate is verified.

bootload_verifyApplicationCertificate#

bool bootload_verifyApplicationCertificate (void * appProp, void * gotCert)

Verify the application certificate.

Note

• This function will always return true if certificate support is not enabled. Also true if appProp does not contain any certificate and direct signed applications can be accepted.

Returns

• True if application certificate is verified.