ec_host_cmd.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_H_
#define ZEPHYR_INCLUDE_MGMT_EC_HOST_CMD_H_
 
#include <stdint.h>
 
struct ec_host_cmd_handler_args {
        const void *const input_buf;
        const uint16_t input_buf_size;
        void *const output_buf;
        uint16_t output_buf_size;
        const uint8_t version;
};
 
typedef enum ec_host_cmd_status (*ec_host_cmd_handler_cb)(
        struct ec_host_cmd_handler_args *args);
struct ec_host_cmd_handler {
        ec_host_cmd_handler_cb handler;
        uint16_t id;
        uint16_t version_mask;
        uint16_t min_rqt_size;
        uint16_t min_rsp_size;
};
 
#define EC_HOST_CMD_HANDLER(_function, _id, _version_mask, _request_type,      \
                            _response_type)                                    \
        const STRUCT_SECTION_ITERABLE(ec_host_cmd_handler, __cmd##_id) = {     \
                .id = _id,                                                     \
                .handler = _function,                                          \
                .version_mask = _version_mask,                                 \
                .min_rqt_size = sizeof(_request_type),                         \
                .min_rsp_size = sizeof(_response_type),                        \
        }
 
#define EC_HOST_CMD_HANDLER_UNBOUND(_function, _id, _version_mask)             \
        const STRUCT_SECTION_ITERABLE(ec_host_cmd_handler, __cmd##_id) = {     \
                .id = _id,                                                     \
                .handler = _function,                                          \
                .version_mask = _version_mask,                                 \
                .min_rqt_size = 0,                                             \
                .min_rsp_size = 0,                                             \
        }
 
struct ec_host_cmd_request_header {
        uint8_t prtcl_ver;
        uint8_t checksum;
        uint16_t cmd_id;
        uint8_t cmd_ver;
        uint8_t reserved;
        uint16_t data_len;
} __packed;
 
struct ec_host_cmd_response_header {
        uint8_t prtcl_ver;
        uint8_t checksum;
        uint16_t result;
        uint16_t data_len;
        uint16_t reserved;
} __packed;
 
/*
 * Host command response codes (16-bit).
 */
enum ec_host_cmd_status {
        EC_HOST_CMD_SUCCESS = 0,
        EC_HOST_CMD_INVALID_COMMAND = 1,
        EC_HOST_CMD_ERROR = 2,
        EC_HOST_CMD_INVALID_PARAM = 3,
        EC_HOST_CMD_ACCESS_DENIED = 4,
        EC_HOST_CMD_INVALID_RESPONSE = 5,
        EC_HOST_CMD_INVALID_VERSION = 6,
        EC_HOST_CMD_INVALID_CHECKSUM = 7,
        EC_HOST_CMD_IN_PROGRESS = 8,
        EC_HOST_CMD_UNAVAILABLE = 9,
        EC_HOST_CMD_TIMEOUT = 10,
        EC_HOST_CMD_OVERFLOW = 11,
        EC_HOST_CMD_INVALID_HEADER = 12,
        EC_HOST_CMD_REQUEST_TRUNCATED = 13,
        EC_HOST_CMD_RESPONSE_TOO_BIG = 14,
        EC_HOST_CMD_BUS_ERROR = 15,
        EC_HOST_CMD_BUSY = 16,
 
        EC_HOST_CMD_MAX = UINT16_MAX /* Force enum to be 16 bits */
} __packed;
 
#endif /* ZEPHYR_INCLUDE_MGMT_EC_HOST_CMD_H_ */