Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
|
MSPI Driver APIs . More...
Topics | |
MSPI Configure API | |
MSPI Configure API . | |
MSPI Transfer API | |
MSPI Transfer API . | |
MSPI callback API | |
MSPI callback API . | |
Data Structures | |
struct | mspi_driver_api |
Typedefs | |
typedef int(* | mspi_api_config) (const struct mspi_dt_spec *spec) |
MSPI driver API definition and system call entry points. | |
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) |
typedef int(* | mspi_api_get_channel_status) (const struct device *controller, uint8_t ch) |
typedef int(* | mspi_api_transceive) (const struct device *controller, const struct mspi_dev_id *dev_id, const struct mspi_xfer *req) |
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) |
typedef int(* | mspi_api_xip_config) (const struct device *controller, const struct mspi_dev_id *dev_id, const struct mspi_xip_cfg *xip_cfg) |
typedef int(* | mspi_api_scramble_config) (const struct device *controller, const struct mspi_dev_id *dev_id, const struct mspi_scramble_cfg *scramble_cfg) |
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) |
MSPI Driver APIs .
typedef int(* mspi_api_config) (const struct mspi_dt_spec *spec) |
#include <zephyr/drivers/mspi.h>
MSPI driver API definition and system call entry points.
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>
#include <zephyr/drivers/mspi.h>
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>
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>
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>
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>
typedef int(* mspi_api_xip_config) (const struct device *controller, const struct mspi_dev_id *dev_id, const struct mspi_xip_cfg *xip_cfg) |
#include <zephyr/drivers/mspi.h>
enum mspi_bus_event |
#include <zephyr/drivers/mspi.h>
MSPI bus event.
This is a preliminary list of events. I encourage the community to fill it up.
Enumerator | |
---|---|
MSPI_BUS_RESET | |
MSPI_BUS_ERROR | |
MSPI_BUS_XFER_COMPLETE | |
MSPI_BUS_EVENT_MAX |
#include <zephyr/drivers/mspi.h>
MSPI bus event callback mask This is a preliminary list same as mspi_bus_event.
I encourage the community to fill it up.
Enumerator | |
---|---|
MSPI_BUS_NO_CB | |
MSPI_BUS_RESET_CB | |
MSPI_BUS_ERROR_CB | |
MSPI_BUS_XFER_COMPLETE_CB |
enum mspi_ce_polarity |
#include <zephyr/drivers/mspi.h>
MSPI chip enable polarity.
Enumerator | |
---|---|
MSPI_CE_ACTIVE_LOW | |
MSPI_CE_ACTIVE_HIGH |
enum mspi_cpp_mode |
#include <zephyr/drivers/mspi.h>
MSPI Polarity & Phase Modes.
Enumerator | |
---|---|
MSPI_CPP_MODE_0 | |
MSPI_CPP_MODE_1 | |
MSPI_CPP_MODE_2 | |
MSPI_CPP_MODE_3 |
enum mspi_data_rate |
#include <zephyr/drivers/mspi.h>
MSPI data rate capabilities SINGLE stands for single data rate for all phases.
DUAL stands for dual data rate for all phases. S_S_D stands for single data rate for command and address phases but dual data rate for data phase. S_D_D stands for single data rate for command phase but dual data rate for address and data phases.
Enumerator | |
---|---|
MSPI_DATA_RATE_SINGLE | |
MSPI_DATA_RATE_S_S_D | |
MSPI_DATA_RATE_S_D_D | |
MSPI_DATA_RATE_DUAL | |
MSPI_DATA_RATE_MAX |
enum mspi_dev_cfg_mask |
#include <zephyr/drivers/mspi.h>
MSPI controller device specific configuration mask.
enum mspi_duplex |
enum mspi_endian |
#include <zephyr/drivers/mspi.h>
MSPI Endian.
Enumerator | |
---|---|
MSPI_XFER_LITTLE_ENDIAN | |
MSPI_XFER_BIG_ENDIAN |
enum mspi_io_mode |
#include <zephyr/drivers/mspi.h>
MSPI I/O mode capabilities Postfix like 1_4_4 stands for the number of lines used for command, address and data phases.
Mode with no postfix has the same number of lines for all phases.
enum mspi_op_mode |
#include <zephyr/drivers/mspi.h>
MSPI operational mode.
Enumerator | |
---|---|
MSPI_OP_MODE_CONTROLLER | |
MSPI_OP_MODE_PERIPHERAL |
enum mspi_xfer_direction |
enum mspi_xfer_mode |
enum mspi_xip_permit |
#include <zephyr/drivers/mspi.h>
MSPI XIP access permissions.
Enumerator | |
---|---|
MSPI_XIP_READ_WRITE | |
MSPI_XIP_READ_ONLY |