mirror of
https://github.com/Telecominfraproject/OpenCellular.git
synced 2025-12-29 01:50:53 +00:00
e56ba2e689
This simply changes the constant '4' to MSG_PROTO_BYTES, which includes the postamble. This helps reduce magic constant values used in processing a packet. BUG=chrome-os-partner:8975 TEST=tested on daisy (with kernel mkbp driver change) Signed-off-by: David Hendricks <dhendrix@chromium.org> Change-Id: Id4634076ad63f45783354179dfebea4fd450fc1e
62 lines
1.7 KiB
C
62 lines
1.7 KiB
C
/* Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
|
|
* Use of this source code is governed by a BSD-style license that can be
|
|
* found in the LICENSE file.
|
|
*/
|
|
|
|
#ifndef __MESSAGE_IF_H
|
|
#define __MESSAGE_IF_H
|
|
|
|
#include <common.h>
|
|
|
|
/* Command interface between EC and AP */
|
|
|
|
enum {
|
|
/* Mask to convert a command byte into a command */
|
|
MSG_CMD_MASK = 0x7f,
|
|
|
|
/* The bytes which appear before the header in a message */
|
|
MSG_PREAMBLE = 0xff,
|
|
|
|
/* The header byte, which follows the preamble */
|
|
MSG_HEADER = 0xec,
|
|
|
|
MSG_HEADER_BYTES = 3,
|
|
MSG_TRAILER_BYTES = 2,
|
|
MSG_PROTO_BYTES = MSG_HEADER_BYTES + MSG_TRAILER_BYTES,
|
|
};
|
|
|
|
/* The command codes that we understand */
|
|
enum message_cmd_t {
|
|
CMDC_NOP, /* No operation / ping */
|
|
CMDC_ID, /* Read EC ID */
|
|
CMDC_KEY_STATE, /* Read key state */
|
|
};
|
|
|
|
|
|
/**
|
|
* Process a command received and return the response
|
|
*
|
|
* There is no time to compute a reply. The data should be ready
|
|
* immediately. This function can be called in interrupt context.
|
|
*
|
|
* The format of a reply is a sequence of bytes:
|
|
*
|
|
* <hdr> <len_lo> <len_hi> <msg bytes> <sum> <preamble bytes>
|
|
*
|
|
* The hdr byte is just a tag to indicate that the real message follows. It
|
|
* signals the end of any preamble required by the interface.
|
|
*
|
|
* The 16-bit length is the entire packet size, including the header, length
|
|
* bytes, message payload, checksum, and postamble byte.
|
|
*
|
|
* The checksum is calculated as the sum of the header, len byte and message.
|
|
*
|
|
* @param cmd Command to process (CMD_...)
|
|
* @param buff Pointer to buffer to store reponse
|
|
* @param max_len Maximum length of buffer
|
|
* @return number of bytes in reply, 0 if none, -1 for unknown command
|
|
*/
|
|
int message_process_cmd(int cmd, uint8_t *buff, int max_len);
|
|
|
|
#endif
|