Standalone#

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). The function returns an error if the standalone bootloader is not present.

Macros#

#define
NO_BOOTLOADER_MODE 0xFF

Define a numerical value for NO BOOTLOADER mode. In other words, the bootloader should not be run.

#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
TypeDirectionArgument NameDescription
voidN/A

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

Returns


halLaunchStandaloneBootloader#

EmberStatus halLaunchStandaloneBootloader (uint8_t mode)

Quits the current application and launches the standalone bootloader (if installed). The function returns an error if the standalone bootloader is not present.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Amode

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

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

Returns