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/device.h>
#include <zephyr/drivers/emul.h>
#include <zephyr/drivers/espi.h>
#include <zephyr/sys/slist.h>
#include <zephyr/types.h>

 
#ifdef __cplusplus
extern "C" {
#endif
 
#define EMUL_ESPI_HOST_CHIPSEL 0
 
struct espi_emul;

typedef int (*emul_espi_api_set_vw)(const struct emul *target, enum espi_vwire_signal vw,
                                    uint8_t level);

typedef int (*emul_espi_api_get_vw)(const struct emul *target, enum espi_vwire_signal vw,
                                    uint8_t *level);

typedef uintptr_t (*emul_espi_api_get_acpi_shm)(const struct emul *target);

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;
#if defined(CONFIG_ESPI_PERIPHERAL_ACPI_SHM_REGION) || defined(__DOXYGEN__)
        emul_espi_api_get_acpi_shm get_acpi_shm;
#endif
};

struct espi_emul {
        sys_snode_t node;
        const struct emul *target;
        const struct emul_espi_device_api *api;
        uint16_t chipsel;
};

__subsystem 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;
};

DEVICE_API_EXTENDS(emul_espi, espi, espi_api);

int espi_emul_register(const struct device *dev, 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);

uintptr_t emul_espi_host_get_acpi_shm(const struct device *espi_dev);
 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_DRIVERS_ESPI_SPI_EMUL_H_ */