MSPI Driver Backend API

Data Structures
struct	mspi_driver_api
	Driver Operations MSPI driver operations More...

Typedefs
typedef int(*	mspi_api_config) (const struct mspi_dt_spec *spec)
	Configure an MSPI controller.
typedef int(*	mspi_api_dev_config) (const struct device *controller, const struct mspi_dev_id *dev_id, const enum mspi_dev_cfg_mask param_mask, const struct mspi_dev_cfg *cfg)
	Configure an MSPI controller with device specific parameters.
typedef int(*	mspi_api_get_channel_status) (const struct device *controller, uint8_t ch)
	Query to see if it a channel is ready.
typedef int(*	mspi_api_transceive) (const struct device *controller, const struct mspi_dev_id *dev_id, const struct mspi_xfer *req)
	Transfer request over MSPI.
typedef int(*	mspi_api_register_callback) (const struct device *controller, const struct mspi_dev_id *dev_id, const enum mspi_bus_event evt_type, mspi_callback_handler_t cb, struct mspi_callback_context *ctx)
	Register the mspi callback functions.
typedef int(*	mspi_api_memmap_config) (const struct device *controller, const struct mspi_dev_id *dev_id, const struct mspi_memmap_cfg *memmap_cfg)
	Configure MSPI memory map settings.
typedef int(*	mspi_api_scramble_config) (const struct device *controller, const struct mspi_dev_id *dev_id, const struct mspi_scramble_cfg *scramble_cfg)
	Configure MSPI scrambling settings.
typedef int(*	mspi_api_timing_config) (const struct device *controller, const struct mspi_dev_id *dev_id, const uint32_t param_mask, void *timing_cfg)
	Configure MSPI timing settings.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a MSPI driver.

Typedef Documentation

mspi_api_config

typedef int(* mspi_api_config) (const struct mspi_dt_spec *spec)

#include <zephyr/drivers/mspi.h>

Configure an MSPI controller.

See mspi_config() for argument description.

mspi_api_dev_config

typedef int(* mspi_api_dev_config) (const struct device *controller, const struct mspi_dev_id *dev_id, const enum mspi_dev_cfg_mask param_mask, const struct mspi_dev_cfg *cfg)

#include <zephyr/drivers/mspi.h>

Configure an MSPI controller with device specific parameters.

See mspi_dev_config() for argument description.

mspi_api_get_channel_status

typedef int(* mspi_api_get_channel_status) (const struct device *controller, uint8_t ch)

#include <zephyr/drivers/mspi.h>

Query to see if it a channel is ready.

See mspi_get_channel_status() for argument description.

mspi_api_memmap_config

typedef int(* mspi_api_memmap_config) (const struct device *controller, const struct mspi_dev_id *dev_id, const struct mspi_memmap_cfg *memmap_cfg)

#include <zephyr/drivers/mspi.h>

Configure MSPI memory map settings.

See mspi_memmap_config() for argument description.

mspi_api_register_callback

typedef int(* mspi_api_register_callback) (const struct device *controller, const struct mspi_dev_id *dev_id, const enum mspi_bus_event evt_type, mspi_callback_handler_t cb, struct mspi_callback_context *ctx)

#include <zephyr/drivers/mspi.h>

Register the mspi callback functions.

See mspi_register_callback() for argument description.

mspi_api_scramble_config

typedef int(* mspi_api_scramble_config) (const struct device *controller, const struct mspi_dev_id *dev_id, const struct mspi_scramble_cfg *scramble_cfg)

#include <zephyr/drivers/mspi.h>

Configure MSPI scrambling settings.

See mspi_scramble_config() for argument description.

mspi_api_timing_config

typedef int(* mspi_api_timing_config) (const struct device *controller, const struct mspi_dev_id *dev_id, const uint32_t param_mask, void *timing_cfg)

#include <zephyr/drivers/mspi.h>

Configure MSPI timing settings.

See mspi_timing_config() for argument description.

mspi_api_transceive

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

#include <zephyr/drivers/mspi.h>

Transfer request over MSPI.

See mspi_transceive() for argument description.