nRF5 SDK v14.0.0
Data Fields
nrf_fstorage_t Struct Reference

An fstorage instance. More...

#include <nrf_fstorage.h>

Data Fields

struct nrf_fstorage_api_tp_api
 The API implementation used by this instance.
 
nrf_fstorage_info_tp_flash_info
 Information about the implementation functionality and the flash peripheral.
 
nrf_fstorage_evt_handler_t evt_handler
 The event handler function. More...
 
uint32_t start_addr
 The beginning of the flash space on which this fstorage instance should operate. All flash operations must be within the address specified in this field and end_addr. More...
 
uint32_t end_addr
 The last address (exclusive) of flash on which this fstorage instance should operate. All flash operations must be within the address specified in this field and start_addr. More...
 

Detailed Description

An fstorage instance.

Use the NRF_FSTORAGE_DEF macro to define an fstorage instance. Each instance must have a unique memory buffer, which is implementation-dependent and defined in the implementation header file.

An instance contains information about the flash, such as the program and erase units, and implementation-specific functionality. In addition, every instance must specify the boundaries of the flash in which the instance is allowed to operate. These boundaries must be set manually by the user. They provide additional safety when performing flash operations. However, they do not provide any form of automatic partitioning of the flash.

Field Documentation

uint32_t nrf_fstorage_t::end_addr

The last address (exclusive) of flash on which this fstorage instance should operate. All flash operations must be within the address specified in this field and start_addr.

This field must be set manually.

nrf_fstorage_evt_handler_t nrf_fstorage_t::evt_handler

The event handler function.

If set to NULL, no events will be sent.

uint32_t nrf_fstorage_t::start_addr

The beginning of the flash space on which this fstorage instance should operate. All flash operations must be within the address specified in this field and end_addr.

This field must be set manually.


The documentation for this struct was generated from the following file:

Documentation feedback | Developer Zone | Subscribe | Updated