Zephyr API Documentation 4.0.0-rc3
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
ec_host_cmd_handler_args Struct Reference

Arguments passed into every installed host command handler. More...

#include <ec_host_cmd.h>

Data Fields

void * reserved
 Reserved for compatibility.
 
uint16_t command
 Command identifier.
 
uint8_t version
 The version of the host command that is being requested.
 
const void * input_buf
 The incoming data that can be cast to the handlers request type.
 
uint16_t input_buf_size
 The number of valid bytes that can be read from input_buf.
 
void * output_buf
 The data written to this buffer will be send to the host.
 
uint16_t output_buf_max
 Maximum number of bytes that can be written to the output_buf.
 
uint16_t output_buf_size
 Number of bytes of output_buf to send to the host.
 

Detailed Description

Arguments passed into every installed host command handler.

Field Documentation

◆ command

uint16_t ec_host_cmd_handler_args::command

Command identifier.

◆ input_buf

const void* ec_host_cmd_handler_args::input_buf

The incoming data that can be cast to the handlers request type.

◆ input_buf_size

uint16_t ec_host_cmd_handler_args::input_buf_size

The number of valid bytes that can be read from input_buf.

◆ output_buf

void* ec_host_cmd_handler_args::output_buf

The data written to this buffer will be send to the host.

◆ output_buf_max

uint16_t ec_host_cmd_handler_args::output_buf_max

Maximum number of bytes that can be written to the output_buf.

◆ output_buf_size

uint16_t ec_host_cmd_handler_args::output_buf_size

Number of bytes of output_buf to send to the host.

◆ reserved

void* ec_host_cmd_handler_args::reserved

Reserved for compatibility.

◆ version

uint8_t ec_host_cmd_handler_args::version

The version of the host command that is being requested.

This will be a value that has been static registered as valid for the handler.


The documentation for this struct was generated from the following file: