MSPI Transfer API

MSPI Transfer API. More...

Data Structures
struct	mspi_ce_control
	MSPI Chip Select control structure. More...
struct	mspi_xfer_packet
	MSPI peripheral xfer packet format. More...
struct	mspi_xfer
	MSPI peripheral xfer format This includes transfer related settings that may require configuring the hardware. More...

Functions
int	mspi_transceive (const struct device *controller, const struct mspi_dev_id *dev_id, const struct mspi_xfer *req)
	Transfer request over MSPI.

Detailed Description

MSPI Transfer API.

Function Documentation

mspi_transceive()

int mspi_transceive	(	const struct device *	controller,
		const struct mspi_dev_id *	dev_id,
		const struct mspi_xfer *	req
	)

#include <include/zephyr/drivers/mspi.h>

Transfer request over MSPI.

This routines provides a generic interface to transfer a request synchronously/asynchronously.

The

See also

mspi_xfer allows for dynamically changing the transfer related Settings once the mode of operation is determined and configured. The API supports bulk transfers with different starting addresses and sizes with

mspi_xfer_packet. However, it is up to the controller implementation whether to support scatter IO and callback management. The controller can determine which user callback to trigger based on

mspi_bus_event_cb_mask upon completion of each async/sync transfer if the callback had been registered. Or not to trigger any callback at all with MSPI_BUS_NO_CB even if the callbacks are already registered.

Parameters

controller	Pointer to the device structure for the driver instance.
dev_id	Pointer to the device ID structure from a device.
req	Content of the request and request specific settings.

Return values

0	If successful.
-ENOTSUP
-EIO	General input / output error, failed to send over the bus.