Driver Operations SPI driver operations More...

#include <zephyr/drivers/spi.h>

Data Fields
spi_api_io	transceive
	REQ Read/write the specified amount of data from the SPI driver.
spi_api_io_async	transceive_async
	OPT Read/write the specified amount of data from the SPI driver asynchronously.
spi_api_iodev_submit	iodev_submit
	OPT Submit a SPI device with a request.
spi_api_release	release
	REQ Release the SPI device locked on and/or the CS by the current config.

Detailed Description

Driver Operations SPI driver operations

This is the driver API structure any SPI driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also: DEVICE_DT_INST_DEFINE(); DEVICE_DT_DEFINE(); DEVICE_API()

Field Documentation

◆ iodev_submit

spi_api_iodev_submit spi_driver_api::iodev_submit

OPT Submit a SPI device with a request.

Attention: Available only when the following Kconfig option is enabled: CONFIG_SPI_RTIO.

◆ release

spi_api_release spi_driver_api::release

REQ Release the SPI device locked on and/or the CS by the current config.

◆ transceive

spi_api_io spi_driver_api::transceive

REQ Read/write the specified amount of data from the SPI driver.

◆ transceive_async

spi_api_io_async spi_driver_api::transceive_async

OPT Read/write the specified amount of data from the SPI driver asynchronously.

Attention: Available only when the following Kconfig option is enabled: CONFIG_SPI_ASYNC.

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

zephyr/drivers/spi.h