backend.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Google LLC.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_MGMT_EC_HOST_CMD_BACKEND_H_
#define ZEPHYR_INCLUDE_MGMT_EC_HOST_CMD_BACKEND_H_
 
#include <zephyr/sys/__assert.h>
#include <zephyr/device.h>
#include <zephyr/drivers/gpio.h>
#include <zephyr/kernel.h>
#include <zephyr/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct ec_host_cmd_backend {
        const struct ec_host_cmd_backend_api *api;
        void *ctx;
};
 
struct ec_host_cmd_rx_ctx {
        uint8_t *buf;
        size_t len;
        size_t len_max;
};
 
struct ec_host_cmd_tx_buf {
        void *buf;
        size_t len;
        size_t len_max;
};
 
typedef int (*ec_host_cmd_backend_api_init)(const struct ec_host_cmd_backend *backend,
                                            struct ec_host_cmd_rx_ctx *rx_ctx,
                                            struct ec_host_cmd_tx_buf *tx);
 
typedef int (*ec_host_cmd_backend_api_send)(const struct ec_host_cmd_backend *backend);
 
struct ec_host_cmd_backend_api {
        ec_host_cmd_backend_api_init init;
        ec_host_cmd_backend_api_send send;
};
 
struct ec_host_cmd_backend *ec_host_cmd_backend_get_espi(const struct device *dev);
 
struct ec_host_cmd_backend *ec_host_cmd_backend_get_shi_npcx(void);
 
struct ec_host_cmd_backend *ec_host_cmd_backend_get_shi_ite(void);
 
struct ec_host_cmd_backend *ec_host_cmd_backend_get_uart(const struct device *dev);
 
struct ec_host_cmd_backend *ec_host_cmd_backend_get_spi(struct gpio_dt_spec *cs);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_MGMT_EC_HOST_CMD_EC_HOST_CMD_BACKEND_H_ */