![]() |
nRF5 SDK
v12.3.0
|
| Choose documentation: | nRF5 SDK | S130 SoftDevice API | S132 SoftDevice API | S212 SoftDevice API | S332 SoftDevice API |
Data Structures | |
| struct | nrf_dfu_req_t |
| Definition of a DFU request sent from the transport layer. More... | |
| struct | nrf_dfu_res_t |
| Response used during DFU operations. More... | |
Enumerations | |
| enum | nrf_dfu_obj_type_t { NRF_DFU_OBJ_TYPE_INVALID, NRF_DFU_OBJ_TYPE_COMMAND, NRF_DFU_OBJ_TYPE_DATA } |
| DFU object types. More... | |
| enum | nrf_dfu_req_op_t { NRF_DFU_OBJECT_OP_NONE = 0, NRF_DFU_OBJECT_OP_CREATE = 1, NRF_DFU_OBJECT_OP_WRITE = 2, NRF_DFU_OBJECT_OP_EXECUTE = 3, NRF_DFU_OBJECT_OP_CRC = 4, NRF_DFU_OBJECT_OP_SELECT = 6, NRF_DFU_OBJECT_OP_OTHER = 7 } |
| DFU request operation codes. More... | |
| enum | nrf_dfu_res_code_t { NRF_DFU_RES_CODE_INVALID = 0x00, NRF_DFU_RES_CODE_SUCCESS = 0x01, NRF_DFU_RES_CODE_OP_CODE_NOT_SUPPORTED = 0x02, NRF_DFU_RES_CODE_INVALID_PARAMETER = 0x03, NRF_DFU_RES_CODE_INSUFFICIENT_RESOURCES = 0x04, NRF_DFU_RES_CODE_INVALID_OBJECT = 0x05, NRF_DFU_RES_CODE_UNSUPPORTED_TYPE = 0x07, NRF_DFU_RES_CODE_OPERATION_NOT_PERMITTED = 0x08, NRF_DFU_RES_CODE_OPERATION_FAILED = 0x0A, NRF_DFU_RES_CODE_EXT_ERROR = 0x0B } |
| DFU request result codes. More... | |
Functions | |
| uint32_t | nrf_dfu_req_handler_init (void) |
| Function for initializing the request handling module. More... | |
| nrf_dfu_res_code_t | nrf_dfu_req_handler_on_req (void *p_context, nrf_dfu_req_t *p_req, nrf_dfu_res_t *p_res) |
| Function type for handling a DFU request. More... | |
| enum nrf_dfu_obj_type_t |
| enum nrf_dfu_req_op_t |
DFU request operation codes.
The DFU transport layer creates request events of these types. The implementation of nrf_dfu_req_handler_on_req handles requests of these types.
| enum nrf_dfu_res_code_t |
DFU request result codes.
The DFU transport layer creates request events of types nrf_dfu_req_op_t, which are handled by nrf_dfu_req_handler_on_req. That functions returns one of these result codes.
| uint32_t nrf_dfu_req_handler_init | ( | void | ) |
Function for initializing the request handling module.
This function initializes the flash with or without the SoftDevice, depending on the project configuration.
| NRF_SUCCESS | If the operation was successful. |
| NRF_ERROR_INVALID_STATE | If the fstorage module could not be initiated or the SoftDevice could not set the event handler. |
| nrf_dfu_res_code_t nrf_dfu_req_handler_on_req | ( | void * | p_context, |
| nrf_dfu_req_t * | p_req, | ||
| nrf_dfu_res_t * | p_res | ||
| ) |
Function type for handling a DFU request.
| [in,out] | p_context | Pointer to context-specific RAM required for running the command request. This value may be NULL if the command request does not require context-specific RAM. |
| [in,out] | p_req | Pointer to the structure holding the DFU request. |
| [in,out] | p_res | Pointer to the structure holding the DFU response. |
| NRF_DFU_RES_CODE_SUCCESS | If the command request was executed successfully. Any other error code indicates that the request could not be handled. |