nRF5 SDK v15.0.0
Functions
Validation

Functions

void nrf_dfu_validation_init (void)
 Function for module initialization. More...
 
nrf_dfu_result_t nrf_dfu_validation_init_cmd_create (uint32_t size)
 Function called on reception of init command creation request. More...
 
nrf_dfu_result_t nrf_dfu_validation_init_cmd_append (uint8_t const *p_data, uint32_t length)
 Function called on reception of fragment of init command. More...
 
void nrf_dfu_validation_init_cmd_status_get (uint32_t *p_offset, uint32_t *p_crc, uint32_t *p_max_size)
 Function for getting init command status. More...
 
bool nrf_dfu_validation_init_cmd_present (void)
 Function for inquiring whether a valid init command has been received. More...
 
nrf_dfu_result_t nrf_dfu_validation_init_cmd_execute (uint32_t *p_dst_data_addr, uint32_t *p_data_len)
 Function for validating init command. More...
 
nrf_dfu_result_t nrf_dfu_validation_post_data_execute (uint32_t dst_data_addr, uint32_t data_len)
 Function for postvalidating the update. Function is called once all data is received. More...
 

Detailed Description

Function Documentation

void nrf_dfu_validation_init ( void  )

Function for module initialization.

Function checks if there is a valid init packet in DFU settings written in flash.

nrf_dfu_result_t nrf_dfu_validation_init_cmd_append ( uint8_t const *  p_data,
uint32_t  length 
)

Function called on reception of fragment of init command.

Parameters
[in]p_dataInit command fragment.
[in]lengthInit command fragment size.
Returns
Operation result. See nrf_dfu_result_t
nrf_dfu_result_t nrf_dfu_validation_init_cmd_create ( uint32_t  size)

Function called on reception of init command creation request.

Parameters
[in]sizeSize of incoming init packet.
Returns
Operation result. See nrf_dfu_result_t
nrf_dfu_result_t nrf_dfu_validation_init_cmd_execute ( uint32_t *  p_dst_data_addr,
uint32_t *  p_data_len 
)

Function for validating init command.

If init command is successfully validated Bank 1 details are written to out parameters.

Until nrf_dfu_validation_init_cmd_create is called, this function can be called again after the first time without side effects to retrieve address and length.

Parameters
[out]p_dst_data_addrBank 1 start address if validation is successful.
[out]p_data_lenBank 1 length if validation is successful.
Returns
Operation result. See nrf_dfu_result_t
bool nrf_dfu_validation_init_cmd_present ( void  )

Function for inquiring whether a valid init command has been received.

Returns
true if there is a valid init command. This can be true at boot time if the device was reset during a DFU operation.
void nrf_dfu_validation_init_cmd_status_get ( uint32_t *  p_offset,
uint32_t *  p_crc,
uint32_t *  p_max_size 
)

Function for getting init command status.

Parameters
[out]p_offsetCurrent offset.
[out]p_crcCurrent CRC.
[out]p_max_sizeMaximum size of init command.
nrf_dfu_result_t nrf_dfu_validation_post_data_execute ( uint32_t  dst_data_addr,
uint32_t  data_len 
)

Function for postvalidating the update. Function is called once all data is received.

Parameters
[in]dst_data_addrBank 1 start address.
[in]data_lenBank 1 length.
Returns
Operation result. See nrf_dfu_result_t

Documentation feedback | Developer Zone | Subscribe | Updated