nRF Connect SDK Bare Metal API 2.0.99
Loading...
Searching...
No Matches
NCS Bare Metal Storage library

Library that provides abstractions for operations such as read, write, and erase on non-volatile memory. More...

Data Structures

struct  bm_storage_evt
 Storage event. More...
 
struct  bm_storage_info
 Information about the non-volatile memory. More...
 
struct  bm_storage_api
 Backend API. More...
 
struct  bm_storage
 Storage instance. More...
 
struct  bm_storage_config
 Configuration for storage instance initialization. More...
 

Typedefs

typedef void(* bm_storage_evt_handler_t) (struct bm_storage_evt *evt)
 Storage event handler type.
 

Enumerations

enum  bm_storage_evt_type { BM_STORAGE_EVT_WRITE_RESULT , BM_STORAGE_EVT_ERASE_RESULT }
 Event IDs. More...
 

Functions

int bm_storage_init (struct bm_storage *storage, const struct bm_storage_config *config)
 Initialize a storage instance.
 
int bm_storage_uninit (struct bm_storage *storage)
 Uninitialize a storage instance.
 
int bm_storage_read (const struct bm_storage *storage, uint32_t src, void *dest, uint32_t len)
 Read data from storage.
 
int bm_storage_write (const struct bm_storage *storage, uint32_t dest, const void *src, uint32_t len, void *ctx)
 Write data to storage.
 
int bm_storage_erase (const struct bm_storage *storage, uint32_t addr, uint32_t len, void *ctx)
 Erase data from storage.
 
bool bm_storage_is_busy (const struct bm_storage *storage)
 Query the status of a storage instance.
 
const struct bm_storage_infobm_storage_nvm_info_get (const struct bm_storage *storage)
 Retrieve NVM storage information.
 
void bm_storage_evt_dispatch (const struct bm_storage *storage, struct bm_storage_evt *evt)
 Dispatch a storage event to the application's event handler.
 

Detailed Description

Library that provides abstractions for operations such as read, write, and erase on non-volatile memory.