espi_emul.h

Go to the documentation of this file.

/*
 * Copyright 2020 Google LLC
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_ESPI_SPI_EMUL_H_
#define ZEPHYR_INCLUDE_DRIVERS_ESPI_SPI_EMUL_H_
 
#include <zephyr/types.h>
#include <device.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define EMUL_ESPI_HOST_CHIPSEL 0
 
struct espi_emul;
 
typedef int (*emul_espi_api_set_vw)(struct espi_emul *emul,
                                    enum espi_vwire_signal vw,
                                    uint8_t level);
 
typedef int (*emul_espi_api_get_vw)(struct espi_emul *emul,
                                    enum espi_vwire_signal vw,
                                    uint8_t *level);
 
#ifdef CONFIG_ESPI_PERIPHERAL_ACPI_SHM_REGION
typedef uintptr_t (*emul_espi_api_get_acpi_shm)(struct espi_emul *emul);
#endif
 
typedef struct espi_emul *(*emul_find_emul)(const struct device *dev,
                                            unsigned int chipsel);
 
typedef int (*emul_trigger_event)(const struct device *dev,
                                  struct espi_event *evt);
 
struct emul_espi_device_api {
        emul_espi_api_set_vw set_vw;
        emul_espi_api_get_vw get_vw;
#ifdef CONFIG_ESPI_PERIPHERAL_ACPI_SHM_REGION
        emul_espi_api_get_acpi_shm get_acpi_shm;
#endif
};
 
struct espi_emul {
        sys_snode_t node;
        /* API provided for this device */
        const struct emul_espi_device_api *api;
        /* eSPI chip-select of the emulated device */
        uint16_t chipsel;
};
 
struct emul_espi_driver_api {
        /* The struct espi_driver_api has to be first in
         * struct emul_espi_driver_api to make pointer casting working
         */
        struct espi_driver_api espi_api;
        /* The rest, emulator specific functions */
        emul_trigger_event trigger_event;
        emul_find_emul find_emul;
};
 
int espi_emul_register(const struct device *dev, const char *name,
                       struct espi_emul *emul);
 
int emul_espi_host_send_vw(const struct device *espi_dev,
                           enum espi_vwire_signal vw, uint8_t level);
 
int emul_espi_host_port80_write(const struct device *espi_dev, uint32_t data);
 
#ifdef CONFIG_ESPI_PERIPHERAL_ACPI_SHM_REGION
uintptr_t emul_espi_host_get_acpi_shm(const struct device *espi_dev);
#endif
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_ESPI_SPI_EMUL_H_ */