ra8_io_blockdev_xspi_state_t Struct Reference

Caller-owned private state for an OSPI NOR block device. More...

#include <ra8_io_blockdev_xspi.h>

Data Fields
uint8_t	instance
	xSPI HAL instance index, 0 or 1 (private).
uint32_t	base_off
	Flash byte offset of logical block 0 (private).
uint32_t	block_count
	Number of 512-byte logical blocks (private).
bool	read_only
	true => writes and erases are rejected (private).

Detailed Description

Caller-owned private state for an OSPI NOR block device.

Zero-initialise and pass to ra8_io_blockdev_xspi_init, which fills it and binds it into a ra8_io_blockdev_t. Treat the fields as private. The state must out-live every call made through the device. The window described by base_off and block_count must lie within the physical flash and be whole-sector aligned (see ra8_io_blockdev_xspi_init).

Invariant

base_off is a multiple of 4096 (one erase sector).

block_count is a non-zero multiple of 8 (whole sectors).

instance is a valid xSPI instance (< 2).

Since

0.1.0

Definition at line 55 of file ra8_io_blockdev_xspi.h.

Field Documentation

base_off

uint32_t ra8_io_blockdev_xspi_state_t::base_off

Flash byte offset of logical block 0 (private).

Definition at line 57 of file ra8_io_blockdev_xspi.h.

Referenced by internal_write_one_sector(), internal_xspi_erase(), internal_xspi_read(), and ra8_io_blockdev_xspi_init().

block_count

uint32_t ra8_io_blockdev_xspi_state_t::block_count

Number of 512-byte logical blocks (private).

Definition at line 58 of file ra8_io_blockdev_xspi.h.

Referenced by internal_xspi_bounds(), internal_xspi_get_caps(), and ra8_io_blockdev_xspi_init().

instance

uint8_t ra8_io_blockdev_xspi_state_t::instance

xSPI HAL instance index, 0 or 1 (private).

Definition at line 56 of file ra8_io_blockdev_xspi.h.

Referenced by internal_write_one_sector(), internal_xspi_erase(), internal_xspi_read(), and ra8_io_blockdev_xspi_init().

read_only

bool ra8_io_blockdev_xspi_state_t::read_only

true => writes and erases are rejected (private).

Definition at line 59 of file ra8_io_blockdev_xspi.h.

Referenced by internal_xspi_erase(), internal_xspi_get_caps(), internal_xspi_write(), and ra8_io_blockdev_xspi_init().

---

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

• libs/ra8_io/inc/ra8_io_blockdev_xspi.h