zms_fs Struct Reference

Zephyr Memory Storage file system structure. More...

#include <zms.h>

Data Fields
off_t	offset
	File system offset in flash.
uint64_t	ate_wra
	Allocation Table Entry (ATE) write address.
uint64_t	data_wra
	Data write address.
uint32_t	sector_size
	Storage system is split into sectors.
uint32_t	sector_count
	Number of sectors in the file system.
uint8_t	sector_cycle
	Current cycle counter of the active sector (pointed to by ate_wra)
bool	ready
	Flag indicating if the file system is initialized.
struct k_mutex	zms_lock
	Mutex used to lock flash writes.
const struct device *	flash_device
	Flash device runtime structure.
const struct flash_parameters *	flash_parameters
	Flash memory parameters structure.
size_t	ate_size
	Size of an Allocation Table Entry.

Detailed Description

Zephyr Memory Storage file system structure.

Field Documentation

ate_size

size_t zms_fs::ate_size

Size of an Allocation Table Entry.

ate_wra

uint64_t zms_fs::ate_wra

Allocation Table Entry (ATE) write address.

Addresses are stored as uint64_t:

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

data_wra

uint64_t zms_fs::data_wra

Data write address.

flash_device

const struct device* zms_fs::flash_device

Flash device runtime structure.

flash_parameters

const struct flash_parameters* zms_fs::flash_parameters

Flash memory parameters structure.

offset

off_t zms_fs::offset

File system offset in flash.

ready

bool zms_fs::ready

Flag indicating if the file system is initialized.

sector_count

uint32_t zms_fs::sector_count

Number of sectors in the file system.

sector_cycle

uint8_t zms_fs::sector_cycle

Current cycle counter of the active sector (pointed to by ate_wra)

sector_size

uint32_t zms_fs::sector_size

Storage system is split into sectors.

The sector size must be a multiple of erase-block-size if the device has erase capabilities

zms_lock

struct k_mutex zms_fs::zms_lock

Mutex used to lock flash writes.

---

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

• include/zephyr/fs/zms.h