Initial release

Fork of nrf51-sdk by Lancaster University

Embed: (wiki syntax)

« Back to documentation index

Bootloader API.

Bootloader API.

Bootloader module interface. More...

Modules

 Types and definitions.
 

Bootloader module type and definitions.


Functions

uint32_t bootloader_init (void)
 Function for initializing the Bootloader.
bool bootloader_app_is_valid (uint32_t app_addr)
 Function for validating application region in flash.
uint32_t bootloader_dfu_start (void)
 Function for starting the Device Firmware Update.
void bootloader_app_start (uint32_t app_addr)
 Function for exiting bootloader and booting into application.
void bootloader_settings_get (bootloader_settings_t *const p_settings)
 Function for retrieving the bootloader settings.
void bootloader_dfu_update_process (dfu_update_status_t update_status)
 Function for processing DFU status update.
bool bootloader_dfu_sd_in_progress (void)
 Function getting state of SoftDevice update in progress.
uint32_t bootloader_dfu_sd_update_continue (void)
 Function for continuing the Device Firmware Update of a SoftDevice.
uint32_t bootloader_dfu_sd_update_finalize (void)
 Function for finalizing the Device Firmware Update of a SoftDevice.

Detailed Description

Bootloader module interface.


Function Documentation

bool bootloader_app_is_valid ( uint32_t  app_addr )

Function for validating application region in flash.

Parameters:
[in]app_addrAddress to the region in flash where the application is stored.
Return values:
trueIf Application region is valid.
falseIf Application region is not valid.
void bootloader_app_start ( uint32_t  app_addr )

Function for exiting bootloader and booting into application.

This function will disable SoftDevice and all interrupts before jumping to application. The SoftDevice vector table base for interrupt forwarding will be set the application address.

Parameters:
[in]app_addrAddress to the region where the application is stored.
bool bootloader_dfu_sd_in_progress ( void   )

Function getting state of SoftDevice update in progress.

After a successfull SoftDevice transfer the system restarts in orderto disable SoftDevice and complete the update.

Return values:
trueA SoftDevice update is in progress. This indicates that second stage of a SoftDevice update procedure can be initiated.
falseNo SoftDevice update is in progress.
uint32_t bootloader_dfu_sd_update_continue ( void   )

Function for continuing the Device Firmware Update of a SoftDevice.

Return values:
NRF_SUCCESSIf the final stage of SoftDevice update was successful.
uint32_t bootloader_dfu_sd_update_finalize ( void   )

Function for finalizing the Device Firmware Update of a SoftDevice.

Return values:
NRF_SUCCESSIf the final stage of SoftDevice update was successful.
uint32_t bootloader_dfu_start ( void   )

Function for starting the Device Firmware Update.

Return values:
NRF_SUCCESSIf new application image was successfully transferred.
void bootloader_dfu_update_process ( dfu_update_status_t  update_status )

Function for processing DFU status update.

Parameters:
[in]update_statusDFU update status.
uint32_t bootloader_init ( void   )

Function for initializing the Bootloader.

Return values:
NRF_SUCCESSIf bootloader was succesfully initialized.
void bootloader_settings_get ( bootloader_settings_t *const   p_settings )

Function for retrieving the bootloader settings.

Parameters:
[out]p_settingsA copy of the current bootloader settings is returned in the structure provided.