ra8_cache_store_cfg_t Struct Reference

Injected dependencies + geometry for ra8_cache_store_init. More...

#include <ra8_cache_store.h>

Collaboration diagram for ra8_cache_store_cfg_t:

Data Fields
struct LX_NOR_FLASH_STRUCT *	nor_flash
	Caller-owned LevelX control block.
ra8_cache_store_nor_init_fn	nor_driver_init
	Injected physical-flash bind.
const char *	name
	LevelX partition name (may be NULL).
ra8_cache_store_entry_t *	index
	Caller-owned index array.
uint8_t *	staging
	Caller-owned >=1-sector scratch.
uint32_t	staging_bytes
	Bytes at staging (>= sector).
uint32_t	logical_sectors
	Usable LevelX logical-sector span.
uint16_t	index_cap
	Index slots (max live entries).
uint8_t	overprovision_pct
	GC headroom margin (0 => default).
bool	format
	Format (wipe) before open.

Detailed Description

Injected dependencies + geometry for ra8_cache_store_init.

Open/Closed seam: the store owns no globals; the LevelX control block, the physical-flash driver bind, and all RAM buffers are passed in. logical_sectors is how many LevelX logical sectors the store may use (the caller's reserved partition); overprovision_pct is the GC headroom margin reserved off that span.

Invariant

nor_flash, nor_driver_init, index, and staging are non-NULL; index_cap > 0; staging_bytes >= sector size.

Since

0.1.0

Definition at line 204 of file ra8_cache_store.h.

Field Documentation

format

bool ra8_cache_store_cfg_t::format

Format (wipe) before open.

Definition at line 214 of file ra8_cache_store.h.

Referenced by internal_open_levelx().

index

ra8_cache_store_entry_t* ra8_cache_store_cfg_t::index

Caller-owned index array.

Definition at line 208 of file ra8_cache_store.h.

Referenced by internal_init_fields(), and internal_validate_cfg().

index_cap

uint16_t ra8_cache_store_cfg_t::index_cap

Index slots (max live entries).

Definition at line 212 of file ra8_cache_store.h.

Referenced by internal_geometry(), internal_init_fields(), and internal_validate_cfg().

logical_sectors

uint32_t ra8_cache_store_cfg_t::logical_sectors

Usable LevelX logical-sector span.

Definition at line 211 of file ra8_cache_store.h.

Referenced by internal_geometry().

name

const char* ra8_cache_store_cfg_t::name

LevelX partition name (may be NULL).

Definition at line 207 of file ra8_cache_store.h.

Referenced by internal_open_levelx().

nor_driver_init

ra8_cache_store_nor_init_fn ra8_cache_store_cfg_t::nor_driver_init

Injected physical-flash bind.

Definition at line 206 of file ra8_cache_store.h.

Referenced by internal_open_levelx(), and internal_validate_cfg().

nor_flash

struct LX_NOR_FLASH_STRUCT* ra8_cache_store_cfg_t::nor_flash

Caller-owned LevelX control block.

Definition at line 205 of file ra8_cache_store.h.

Referenced by internal_init_fields(), and internal_validate_cfg().

overprovision_pct

uint8_t ra8_cache_store_cfg_t::overprovision_pct

GC headroom margin (0 => default).

Definition at line 213 of file ra8_cache_store.h.

Referenced by internal_geometry(), and internal_validate_cfg().

staging

uint8_t* ra8_cache_store_cfg_t::staging

Caller-owned >=1-sector scratch.

Definition at line 209 of file ra8_cache_store.h.

Referenced by internal_init_fields(), and internal_validate_cfg().

staging_bytes

uint32_t ra8_cache_store_cfg_t::staging_bytes

Bytes at staging (>= sector).

Definition at line 210 of file ra8_cache_store.h.

Referenced by internal_validate_cfg().

---

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

• libs/ra8_cache_store/inc/ra8_cache_store.h