nRF5 IoT SDK  v0.9.0
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Bootloader images

Internal Device Firmware Update module interface. More...

Functions

void bootloader_settings_load (bootloader_settings_t *p_bootloader_settings)
 Function for loading the bootloader settings. More...
 
void bootloader_settings_save (bootloader_settings_t *p_bootloader_settings)
 Function for saving the bootloader settings. More...
 
uint32_t dfu_bl_image_validate (void)
 Function for checking if new bootloader will be installed. More...
 
uint32_t dfu_app_image_validate (void)
 Function for validating that new application has been correctly installed. More...
 
uint32_t dfu_sd_image_validate (void)
 Function for validating that new SoftDevice has been correctly installed. More...
 
uint32_t dfu_bl_image_swap (void)
 Function for swapping existing bootloader with newly received. More...
 
uint32_t dfu_sd_image_swap (void)
 Function for swapping existing SoftDevice with newly received. More...
 
uint32_t dfu_app_image_swap (void)
 Function for swapping existing application with newly received. More...
 

Detailed Description

Internal Device Firmware Update module interface.

Function Documentation

void bootloader_settings_load ( bootloader_settings_t p_bootloader_settings)

Function for loading the bootloader settings.

This function is defined as an interface function. The implementation of this is system specific and needs to be implemented by a user module.

Parameters
[out]p_bootloader_settingsCurrent bootloader settings.
void bootloader_settings_save ( bootloader_settings_t p_bootloader_settings)

Function for saving the bootloader settings.

This function is defined as an interface function. The implementation of this is system specific and needs to be implemented by a user module.

Parameters
[in]p_bootloader_settingsNew bootloader settings.
uint32_t dfu_app_image_swap ( void  )

Function for swapping existing application with newly received.

Returns
NRF_SUCCESS on succesfull swapping. For error code please refer to sd_mbr_command_copy_sd_t.
uint32_t dfu_app_image_validate ( void  )

Function for validating that new application has been correctly installed.

The function will also compare the copied version against the firmware source, and mark it as installed if comparisson is a success before returning.

Returns
NRF_SUCCESS if install was successful. NRF_ERROR_NULL if the images differs.
uint32_t dfu_bl_image_swap ( void  )

Function for swapping existing bootloader with newly received.

Note
This function will not return any error code but rather reset the chip after. If an error occurs during copy of bootloader, this will be resumed by the system on power-on again.
Returns
NRF_SUCCESS on succesfull swapping. For error code please refer to sd_mbr_command_copy_bl_t.
uint32_t dfu_bl_image_validate ( void  )

Function for checking if new bootloader will be installed.

The function will also compare the copied version against the firmware source, and mark it as installed if comparisson is a success before returning.

Returns
NRF_SUCCESS if install was successful. NRF_ERROR_NULL if the images differs.
uint32_t dfu_sd_image_swap ( void  )

Function for swapping existing SoftDevice with newly received.

Returns
NRF_SUCCESS on succesfull swapping. For error code please refer to sd_mbr_command_copy_sd_t.
uint32_t dfu_sd_image_validate ( void  )

Function for validating that new SoftDevice has been correctly installed.

The function will also compare the copied version against the firmware source, and mark it as installed if comparisson is a success before returning.

Returns
NRF_SUCCESS if install was successful. NRF_ERROR_NULL if the images differs.