mspi_emul.h

Go to the documentation of this file.

/*
 * Copyright 2020 Google LLC
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_MSPI_EMUL_H_
#define ZEPHYR_INCLUDE_DRIVERS_MSPI_EMUL_H_
 
#include <zephyr/device.h>
#include <zephyr/drivers/emul.h>
#include <zephyr/drivers/mspi.h>
#include <zephyr/sys/slist.h>
#include <zephyr/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct mspi_emul;
 
typedef struct mspi_emul *(*mspi_emul_find_emul)(const struct device *dev,
                                                 uint16_t dev_idx);
 
typedef int (*mspi_emul_trigger_event)(const struct device *dev,
                                       enum mspi_bus_event evt_type);
 
typedef int (*emul_mspi_dev_api_transceive)(const struct emul *target,
                                            const struct mspi_xfer_packet *packets,
                                            uint32_t num_packet,
                                            bool async,
                                            uint32_t timeout);
 
struct emul_mspi_device_api {
        emul_mspi_dev_api_transceive transceive;
};
 
struct mspi_emul {
        sys_snode_t                  node;
        const struct emul            *target;
        const struct emul_mspi_device_api *api;
        uint16_t                     dev_idx;
};
 
struct emul_mspi_driver_api {
        /* The struct mspi_driver_api has to be first in
         * struct emul_mspi_driver_api to make pointer casting working
         */
        struct mspi_driver_api       mspi_api;
        /* The rest, emulator specific functions */
        mspi_emul_trigger_event      trigger_event;
        mspi_emul_find_emul          find_emul;
};
 
int mspi_emul_register(const struct device *dev, struct mspi_emul *emul);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_MSPI_EMUL_H_ */