ra8_io_spi_bus_t Struct Reference

Caller-allocated SPI-bus handle binding a backend to its context. More...

#include <ra8_io_spi_bus.h>

Collaboration diagram for ra8_io_spi_bus_t:

Data Fields
const ra8_io_spi_bus_iface_t *	iface
	Bound backend vtable (private).
void *	ctx
	Backend-private context (private).

Detailed Description

Caller-allocated SPI-bus handle binding a backend to its context.

Zero-initialise (= {}) and pass to a backend _bind_*() helper, which fills the vtable and context. Treat the fields as private; reach the bus only through the ra8_io_spi_bus_* functions below. The handle must out-live every call made through it (including calls made through an ra8_spi_bus_ops_t filled by ra8_io_spi_bus_as_ops).

Invariant

iface is non-NULL once a backend has been bound.

Since

0.1.0

Definition at line 100 of file ra8_io_spi_bus.h.

Field Documentation

ctx

void* ra8_io_spi_bus_t::ctx

Backend-private context (private).

Definition at line 102 of file ra8_io_spi_bus.h.

Referenced by ra8_io_spi_bus_bind_sci_spi(), ra8_io_spi_bus_bind_spi_b(), ra8_io_spi_bus_set_clock(), ra8_io_spi_bus_write_read(), and ra8_io_spi_bus_xfer8().

iface

const ra8_io_spi_bus_iface_t* ra8_io_spi_bus_t::iface

Bound backend vtable (private).

Definition at line 101 of file ra8_io_spi_bus.h.

Referenced by internal_validate(), ra8_io_spi_bus_bind_sci_spi(), ra8_io_spi_bus_bind_spi_b(), ra8_io_spi_bus_set_clock(), ra8_io_spi_bus_write_read(), and ra8_io_spi_bus_xfer8().

---

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

• libs/ra8_io/inc/ra8_io_spi_bus.h