Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
mspi_driver_api Struct Reference

Driver Operations MSPI driver operations More...

#include <zephyr/drivers/mspi.h>

Data Fields

mspi_api_config config
  REQ Configure an MSPI controller.
mspi_api_dev_config dev_config
  REQ Configure an MSPI controller with device specific parameters.
mspi_api_get_channel_status get_channel_status
  REQ Query to see if it a channel is ready.
mspi_api_transceive transceive
  OPT Transfer request over MSPI.
mspi_api_register_callback register_callback
  OPT Register the mspi callback functions.
mspi_api_memmap_config memmap_config
  OPT Configure MSPI memory map settings.
mspi_api_scramble_config scramble_config
  OPT Configure MSPI scrambling settings.
mspi_api_timing_config timing_config
  OPT Configure MSPI timing settings.

Detailed Description

Driver Operations MSPI driver operations

This is the driver API structure any MSPI 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

◆ config

mspi_api_config mspi_driver_api::config

REQ Configure an MSPI controller.

◆ dev_config

mspi_api_dev_config mspi_driver_api::dev_config

REQ Configure an MSPI controller with device specific parameters.

◆ get_channel_status

mspi_api_get_channel_status mspi_driver_api::get_channel_status

REQ Query to see if it a channel is ready.

◆ memmap_config

mspi_api_memmap_config mspi_driver_api::memmap_config

OPT Configure MSPI memory map settings.

◆ register_callback

mspi_api_register_callback mspi_driver_api::register_callback

OPT Register the mspi callback functions.

◆ scramble_config

mspi_api_scramble_config mspi_driver_api::scramble_config

OPT Configure MSPI scrambling settings.

◆ timing_config

mspi_api_timing_config mspi_driver_api::timing_config

OPT Configure MSPI timing settings.

◆ transceive

mspi_api_transceive mspi_driver_api::transceive

OPT Transfer request over MSPI.


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