DFU settings

Functions
ret_code_t	nrf_dfu_settings_adv_name_copy (nrf_dfu_adv_name_t *p_adv_name)
	Function for copying the advertisement name from DFU settings to RAM. More...
void	nrf_dfu_settings_init (void)
	Function for initializing the DFU settings module. More...
ret_code_t	nrf_dfu_settings_peer_data_copy (nrf_dfu_peer_data_t *p_data)
	Function for copying peer data from DFU settings to RAM. More...
ret_code_t	nrf_dfu_settings_shared_data_erase (void)
	Function for erasing shared data in DFU settings. More...
bool	nrf_dfu_settings_shared_data_is_valid (void)
	Function for validating data shared by application in DFU settings. More...
ret_code_t	nrf_dfu_settings_write (void)
	Function for writing DFU settings to flash. More...

Variables
nrf_dfu_settings_t	s_dfu_settings
	Global settings. More...

Detailed Description

Function Documentation

ret_code_t nrf_dfu_settings_adv_name_copy

(

nrf_dfu_adv_name_t *

p_adv_name

)

Function for copying the advertisement name from DFU settings to RAM.

Parameters

[in,out]

p_adv_name

Structure to copy the new advertisement name to.

Return values

NRF_SUCCESS	Advertisement name was successfully copied.
NRF_ERROR_NULL	p_adv_name was NULL.

void nrf_dfu_settings_init

(

void

)

Function for initializing the DFU settings module.

Note

FLASH will be initialized assuming SD disabled configuration. NVM driver will be used directly.

ret_code_t nrf_dfu_settings_peer_data_copy

(

nrf_dfu_peer_data_t *

p_data

)

Function for copying peer data from DFU settings to RAM.

Parameters

[in,out]

p_data

Structure to copy peer data to.

Return values

NRF_SUCCESS	Peer data was successfully copied.
NRF_ERROR_NULL	p_data was NULL.

ret_code_t nrf_dfu_settings_shared_data_erase

(

void

)

Function for erasing shared data in DFU settings.

Returns

NRF_SUCCESS is shared data was successfully erased.

bool nrf_dfu_settings_shared_data_is_valid

(

void

)

Function for validating data shared by application in DFU settings.

Returns

True if shared data is validated by CRC, false if not.

ret_code_t nrf_dfu_settings_write

(

void

)

Function for writing DFU settings to flash.

Return values

NRF_SUCCESS	If the write process was successfully initiated.
NRF_ERROR_INTERNAL	If a flash error occurred.

Variable Documentation

nrf_dfu_settings_t s_dfu_settings

Global settings.

Note

Using this variable is not thread-safe.