Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
backend.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2020 Google LLC.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12#ifndef ZEPHYR_INCLUDE_MGMT_EC_HOST_CMD_BACKEND_H_
13#define ZEPHYR_INCLUDE_MGMT_EC_HOST_CMD_BACKEND_H_
14
15#include <zephyr/sys/__assert.h>
16#include <zephyr/device.h>
17#include <zephyr/drivers/gpio.h>
18#include <zephyr/kernel.h>
19#include <zephyr/types.h>
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
29 void *ctx;
30};
31
51 size_t len;
53 size_t len_max;
54};
55
66 void *buf;
68 size_t len;
70 size_t len_max;
71};
72
90typedef int (*ec_host_cmd_backend_api_init)(const struct ec_host_cmd_backend *backend,
91 struct ec_host_cmd_rx_ctx *rx_ctx,
92 struct ec_host_cmd_tx_buf *tx);
93
104typedef int (*ec_host_cmd_backend_api_send)(const struct ec_host_cmd_backend *backend);
105
110
122
129
136
148
160
165#ifdef __cplusplus
166}
167#endif
168
169#endif /* ZEPHYR_INCLUDE_MGMT_EC_HOST_CMD_EC_HOST_CMD_BACKEND_H_ */
Public APIs for GPIO drivers.
int(* ec_host_cmd_backend_api_send)(const struct ec_host_cmd_backend *backend)
Sends data to the host.
Definition backend.h:104
struct ec_host_cmd_backend * ec_host_cmd_backend_get_spi(struct gpio_dt_spec *cs)
Get the SPI Host Command backend pointer.
struct ec_host_cmd_backend * ec_host_cmd_backend_get_espi(const struct device *dev)
Get the eSPI Host Command backend pointer.
struct ec_host_cmd_backend * ec_host_cmd_backend_get_uart(const struct device *dev)
Get the UART Host Command backend pointer.
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.
Definition backend.h:90
struct ec_host_cmd_backend * ec_host_cmd_backend_get_shi_ite(void)
Get the SHI ITE Host Command backend pointer.
struct ec_host_cmd_backend * ec_host_cmd_backend_get_shi_npcx(void)
Get the SHI NPCX Host Command backend pointer.
Public kernel APIs.
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
Runtime device structure (in ROM) per driver instance.
Definition device.h:412
Definition backend.h:106
ec_host_cmd_backend_api_init init
Definition backend.h:107
ec_host_cmd_backend_api_send send
Definition backend.h:108
Definition backend.h:25
void * ctx
Context for the backed.
Definition backend.h:29
const struct ec_host_cmd_backend_api * api
API provided by the backed.
Definition backend.h:27
Context for host command backend and handler to pass rx data.
Definition backend.h:42
size_t len_max
Maximum number of bytes to receive with one request packet.
Definition backend.h:53
size_t len
Number of bytes written to buf by backend.
Definition backend.h:51
uint8_t * buf
Buffer to hold received data.
Definition backend.h:49
Context for host command backend and handler to pass tx data.
Definition backend.h:59
size_t len_max
Maximum number of bytes to send with one response packet.
Definition backend.h:70
void * buf
Data to write to the host The buffer is provided by the handler if CONFIG_EC_HOST_CMD_HANDLER_TX_BUFF...
Definition backend.h:66
size_t len
Number of bytes to write from buf.
Definition backend.h:68
Container for GPIO pin information specified in devicetree.
Definition gpio.h:288