sol_memmap_map Struct Reference

Memory map basic struct. More...

#include <sol-memmap-storage.h>

Data Fields
const struct sol_str_table_ptr *	entries
	Entries on map, containing name, offset and size. More...
const char *	path
	Where to find the storage. More...
uint32_t	timeout
	Timeout, in milliseconds, of writing operations. More...
uint8_t	version
	Version of map. More...

Detailed Description

Memory map basic struct.

This struct holds informations about a memory map.

Field Documentation

const struct sol_str_table_ptr* sol_memmap_map::entries

Entries on map, containing name, offset and size.

const char* sol_memmap_map::path

Where to find the storage.

On Linux, it is the file mapping the storage, like /dev/nvram. Optionally, it can also be in the form create,<bus_type>,<rel_path>,<devnumber>,<devname>, where:

• bus_type is the bus type (supported values are: i2c),
• rel_path is the relative path for the device on /sys/devices, like platform/80860F41:05,
• devnumber is the device number on the bus, like 0x50, and
• devname is the device name, the one recognized by its driver. On Zephyr, this field must adhere to the form <driver_name>,<min_erase_size>,<max_rw_size>,<mem_offset>, where:
• driver_name is the driver name string,
• erase_size is the minimum erasable section size,
• max_rw_size is the maximum read/write sizes allowed and
• mem_offset is the flash memory's starting offset (all sizes in bytes).

uint32_t sol_memmap_map::timeout

Timeout, in milliseconds, of writing operations.

After a write is requested, a timer will run and group all writing operations until it expires, when real writing will be performed

uint8_t sol_memmap_map::version

Version of map.

Functions will refuse to read/write on storage if this version and the one storad differs

---

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

• src/lib/io/include/sol-memmap-storage.h