Application bootloader See Application for detailed documentation.

License#

Copyright 2018 Silicon Laboratories Inc. www.silabs.com

The licensor of this software is Silicon Laboratories Inc. Your use of this software is governed by the terms of Silicon Labs Master Software License Agreement (MSLA) available at www.silabs.com/about-us/legal/master-software-license-agreement. This software is distributed to you in Source Code format and is governed by the sections of the MSLA applicable to Source Code. 

/***************************************************************************/
#ifndef __APP_BOOTLOADER_H__
#define __APP_BOOTLOADER_H__


void bootloaderInit();
void bootloaderInitCustom();

void bootloaderAction(bool runRecovery);


BL_Status recoveryMode(void);

BL_Status processImage(bool install);

#endif //__APP_BOOTLOADER_H__

Required Custom Functions#

void
bootloaderInit()

Drives the app bootloader. If the ::runRecovery parameter is ::true, the recovery mode should be activated, otherwise it should attempt to install an image. This function should not return. It should always exit by resetting the the bootloader.

void
bootloaderInitCustom()

Drives the app bootloader. If the ::runRecovery parameter is ::true, the recovery mode should be activated, otherwise it should attempt to install an image. This function should not return. It should always exit by resetting the the bootloader.

void
bootloaderAction(bool runRecovery)

Drives the app bootloader. If the ::runRecovery parameter is ::true, the recovery mode should be activated, otherwise it should attempt to install an image. This function should not return. It should always exit by resetting the the bootloader.

Available Bootloader Library Functions#

Functions implemented by the bootloader library that may be used by custom functions.

BL_Status
recoveryMode(void)

Activates recoveryMode to receive a new image over xmodem.

BL_Status
processImage(bool install)

Processes an image in the external eeprom.

Required Custom Functions Documentation#

bootloaderInit#

void bootloaderInit ( runRecovery)

Drives the app bootloader. If the ::runRecovery parameter is ::true, the recovery mode should be activated, otherwise it should attempt to install an image. This function should not return. It should always exit by resetting the the bootloader.

Parameters
N/ArunRecovery

If ::true, recover mode is activated. Otherwise, normal image installation is activated.


Definition at line 33 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/common/app-bootloader.h

bootloaderInitCustom#

void bootloaderInitCustom ( runRecovery)

Drives the app bootloader. If the ::runRecovery parameter is ::true, the recovery mode should be activated, otherwise it should attempt to install an image. This function should not return. It should always exit by resetting the the bootloader.

Parameters
N/ArunRecovery

If ::true, recover mode is activated. Otherwise, normal image installation is activated.


Definition at line 34 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/common/app-bootloader.h

bootloaderAction#

void bootloaderAction (bool runRecovery)

Drives the app bootloader. If the ::runRecovery parameter is ::true, the recovery mode should be activated, otherwise it should attempt to install an image. This function should not return. It should always exit by resetting the the bootloader.

Parameters
N/ArunRecovery

If ::true, recover mode is activated. Otherwise, normal image installation is activated.


Definition at line 44 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/common/app-bootloader.h

Available Bootloader Library Functions Documentation#

recoveryMode#

BL_Status recoveryMode (void )

Activates recoveryMode to receive a new image over xmodem.

Parameters
N/A

Returns

  • BL_SUCCESS if an image was successfully received.


Definition at line 59 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/common/app-bootloader.h

processImage#

BL_Status processImage (bool install)

Processes an image in the external eeprom.

Parameters
N/Ainstall

If ::false, it will simply validate the image without touching main flash. If ::true, the image will be programmed to main flash.

Returns

  • BL_SUCCESS if an image was successfully installed/validated


Definition at line 66 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/common/app-bootloader.h