Zephyr API 3.6.99
Loading...
Searching...
No Matches
ec_host_cmd_request_header Struct Reference

Header for requests from host to embedded controller. More...

#include <ec_host_cmd.h>

Data Fields

uint8_t prtcl_ver
 Should be 3.
 
uint8_t checksum
 Checksum of response and data; sum of all bytes including checksum.
 
uint16_t cmd_id
 Id of command that is being sent.
 
uint8_t cmd_ver
 Version of the specific cmd_id being requested.
 
uint8_t reserved
 Unused byte in current protocol version; set to 0.
 
uint16_t data_len
 Length of data which follows this header.
 

Detailed Description

Header for requests from host to embedded controller.

Represent the over-the-wire header in LE format for host command requests. This represent version 3 of the host command header. The requests are always sent from host to embedded controller.

Field Documentation

◆ checksum

uint8_t ec_host_cmd_request_header::checksum

Checksum of response and data; sum of all bytes including checksum.

Should total to 0.

◆ cmd_id

uint16_t ec_host_cmd_request_header::cmd_id

Id of command that is being sent.

◆ cmd_ver

uint8_t ec_host_cmd_request_header::cmd_ver

Version of the specific cmd_id being requested.

Valid versions start at 0.

◆ data_len

uint16_t ec_host_cmd_request_header::data_len

Length of data which follows this header.

◆ prtcl_ver

uint8_t ec_host_cmd_request_header::prtcl_ver

Should be 3.

The EC will return EC_HOST_CMD_INVALID_HEADER if it receives a header with a version it doesn't know how to parse.

◆ reserved

uint8_t ec_host_cmd_request_header::reserved

Unused byte in current protocol version; set to 0.


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