Philip Holifield / nrf51-sdk

from bbc microbit library

Fork of nrf51-sdk by Lancaster University

Embed: (wiki syntax)

« Back to documentation index

Persistent Memory Interface Data Types
Data Structures | Typedefs

Persistent Memory Interface Data Types
[Persistent Storage Interface]

Data Types needed for interfacing with persistent memory. More...

Data Structures

struct  pstorage_module_param_t
 Struct containing module registration context. More...

Typedefs

typedef void(* pstorage_ntf_cb_t )(pstorage_handle_t *p_handle, uint8_t op_code, uint32_t result, uint8_t *p_data, uint32_t data_len)
 Persistent storage operation completion callback function type.

Detailed Description

Data Types needed for interfacing with persistent memory.

Typedef Documentation

typedef void(* pstorage_ntf_cb_t)(pstorage_handle_t *p_handle, uint8_t op_code, uint32_t result, uint8_t *p_data, uint32_t data_len)

Persistent storage operation completion callback function type.

The persistent storage operation completion callback is used by the interface to report success or failure of a flash operation. Since data is not copied for a store operation, a callback is an indication that the resident memory can now be reused or freed.

Parameters:
[in]handleIdentifies the module and block for the callback that is received.
[in]op_codeIdentifies the operation for the event that is notified.
[in]resultIdentifies the result of a flash access operation. NRF_SUCCESS implies operation succeeded.
Note:
Unmanaged (abnormal behaviour) error codes from the SoftDevice flash access API are forwarded as is and are expected to be handled by the application. For details refer to the implementation file and corresponding SoftDevice flash API documentation.
Parameters:
[in]p_dataIdentifies the application data pointer. For a store operation, this points to the resident source of application memory that the application can now free or reuse. When there is a clear operation, this is NULL since no application pointer is needed for this operation.
[in]data_lenLength data the application provided for the operation.

Definition at line 95 of file pstorage.h.

Generated on Tue Jul 12 2022 15:58:38 by  doxygen 1.7.2