Standalone Bootloader#

Definition of the standalone bootloader interface.

Some functions in this file return an ::EmberStatus value. See error-def.h for definitions of all ::EmberStatus return values.

See bootloader-interface-standalone.h for source code.

Functions#

uint16_t

halGetStandaloneBootloaderVersion(void)

Detects if the standalone bootloader is installed, and if so returns the installed version.

EmberStatus

halLaunchStandaloneBootloader(uint8_t mode)

Quits the current application and launches the standalone bootloader (if installed).

Macros#

#define

NO_BOOTLOADER_MODE 0xFF

Define a numerical value for NO BOOTLOADER mode.

#define

STANDALONE_BOOTLOADER_NORMAL_MODE 1

Define a numerical value for the normal bootloader mode.

#define

STANDALONE_BOOTLOADER_RECOVERY_MODE 0

Define a numerical value for the recovery bootloader mode.

Function Documentation#

halGetStandaloneBootloaderVersion#

uint16_t halGetStandaloneBootloaderVersion (void )

Detects if the standalone bootloader is installed, and if so returns the installed version.

Parameters

N/A

A returned version of 0x1234 would indicate version 1.2 build 34

Returns

BOOTLOADER_INVALID_VERSION if the standalone bootloader is not present, or the version of the installed standalone bootloader.

Definition at line 44 of file platform/service/legacy_hal/inc/bootloader-interface-standalone.h

halLaunchStandaloneBootloader#

EmberStatus halLaunchStandaloneBootloader (uint8_t mode)

Quits the current application and launches the standalone bootloader (if installed).

Parameters

N/A

mode

Controls the mode in which the standalone bootloader will run. See the bootloader Application Note for full details. Options are:

STANDALONE_BOOTLOADER_NORMAL_MODE Will listen for an over-the-air image transfer on the current channel with current power settings.
STANDALONE_BOOTLOADER_RECOVERY_MODE Will listen for an over-the-air image transfer on the default channel with default power settings.

Both modes also allow an image transfer to begin via serial xmodem.

The function returns an error if the standalone bootloader is not present.

Returns

An ::EmberStatus error if the standalone bootloader is not present, or ::EMBER_SUCCESS.

Definition at line 77 of file platform/service/legacy_hal/inc/bootloader-interface-standalone.h

Macro Definition Documentation#

NO_BOOTLOADER_MODE#

#define NO_BOOTLOADER_MODE

Value:

0xFF

Define a numerical value for NO BOOTLOADER mode.

In other words, the bootloader should not be run.

Definition at line 49 of file platform/service/legacy_hal/inc/bootloader-interface-standalone.h