Zephyr API Documentation 4.0.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
backend.h File Reference

Public APIs for Host Command backends that respond to host commands. More...

#include <zephyr/sys/__assert.h>
#include <zephyr/device.h>
#include <zephyr/drivers/gpio.h>
#include <zephyr/kernel.h>
#include <zephyr/types.h>

Go to the source code of this file.

Data Structures

struct  ec_host_cmd_backend
 
struct  ec_host_cmd_rx_ctx
 Context for host command backend and handler to pass rx data. More...
 
struct  ec_host_cmd_tx_buf
 Context for host command backend and handler to pass tx data. More...
 
struct  ec_host_cmd_backend_api
 

Typedefs

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)
 Initialize a host command backend.
 
typedef int(* ec_host_cmd_backend_api_send) (const struct ec_host_cmd_backend *backend)
 Sends data to the host.
 

Functions

struct ec_host_cmd_backendec_host_cmd_backend_get_espi (const struct device *dev)
 Get the eSPI Host Command backend pointer.
 
struct ec_host_cmd_backendec_host_cmd_backend_get_shi_npcx (void)
 Get the SHI NPCX Host Command backend pointer.
 
struct ec_host_cmd_backendec_host_cmd_backend_get_shi_ite (void)
 Get the SHI ITE Host Command backend pointer.
 
struct ec_host_cmd_backendec_host_cmd_backend_get_uart (const struct device *dev)
 Get the UART Host Command backend pointer.
 
struct ec_host_cmd_backendec_host_cmd_backend_get_spi (struct gpio_dt_spec *cs)
 Get the SPI Host Command backend pointer.
 

Detailed Description

Public APIs for Host Command backends that respond to host commands.