Zephyr API Documentation 4.0.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches

Non-volatile Storage File system structure. More...

#include <nvs.h>

Data Fields

off_t offset
 File system offset in flash.
 
uint32_t ate_wra
 Allocation table entry write address.
 
uint32_t data_wra
 Data write address.
 
uint16_t sector_size
 File system is split into sectors, each sector must be multiple of erase-block-size.
 
uint16_t sector_count
 Number of sectors in the file system.
 
bool ready
 Flag indicating if the file system is initialized.
 
struct k_mutex nvs_lock
 Mutex.
 
const struct deviceflash_device
 Flash device runtime structure.
 
const struct flash_parametersflash_parameters
 Flash memory parameters structure.
 

Detailed Description

Non-volatile Storage File system structure.

Field Documentation

◆ ate_wra

uint32_t nvs_fs::ate_wra

Allocation table entry write address.

Addresses are stored as uint32_t:

  • high 2 bytes correspond to the sector
  • low 2 bytes are the offset in the sector

◆ data_wra

uint32_t nvs_fs::data_wra

Data write address.

◆ flash_device

const struct device* nvs_fs::flash_device

Flash device runtime structure.

◆ flash_parameters

const struct flash_parameters* nvs_fs::flash_parameters

Flash memory parameters structure.

◆ nvs_lock

struct k_mutex nvs_fs::nvs_lock

Mutex.

◆ offset

off_t nvs_fs::offset

File system offset in flash.

◆ ready

bool nvs_fs::ready

Flag indicating if the file system is initialized.

◆ sector_count

uint16_t nvs_fs::sector_count

Number of sectors in the file system.

◆ sector_size

uint16_t nvs_fs::sector_size

File system is split into sectors, each sector must be multiple of erase-block-size.


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