CHROMIUM: mfd: chromeos_ec: update EC<->AP protocol
authorVincent Palatin <vpalatin@chromium.org>
Tue, 15 May 2012 18:29:34 +0000 (11:29 -0700)
committerOlof Johansson <olofj@chromium.org>
Wed, 20 Jun 2012 19:07:53 +0000 (12:07 -0700)
we switch to a common protocol for all platforms.
This will allow us to support flashing commands.

Signed-off-by: Vincent Palatin <vpalatin@chromium.org>
BUG=chrome-os-partner:9614
TEST=on Daisy, test keyboard input in ChromeOS with new EC.

Change-Id: If5304fabffaa932304bbe7ba1e21d5ee653a2c96
Reviewed-on: https://gerrit-int.chromium.org/17855
Reviewed-by: Luigi Semenzato <semenzato@google.com>
Commit-Ready: Vincent Palatin <vpalatin@chromium.org>
Tested-by: Vincent Palatin <vpalatin@chromium.org>
drivers/input/keyboard/mkbp.c
drivers/mfd/chromeos_ec.c
include/linux/mfd/chromeos_ec.h
include/linux/mfd/chromeos_ec_commands.h [new file with mode: 0644]

index 2fe555a..7bc66d8 100644 (file)
@@ -31,6 +31,7 @@
 #include <linux/input.h>
 #include <linux/kernel.h>
 #include <linux/mfd/chromeos_ec.h>
+#include <linux/mfd/chromeos_ec_commands.h>
 #include <linux/notifier.h>
 #include <linux/platform_device.h>
 #include <linux/slab.h>
@@ -238,8 +239,8 @@ static int mkbp_work(struct notifier_block *nb,
                                                    notifier);
        uint8_t kb_state[MKBP_NUM_COLS];
 
-       ret = mkbp_dev->ec->send_command(mkbp_dev->ec, MKBP_CMDC_KEY_STATE,
-                                   kb_state, MKBP_NUM_COLS);
+       ret = mkbp_dev->ec->command_recv(mkbp_dev->ec, EC_CMD_MKBP_STATE,
+                                        kb_state, MKBP_NUM_COLS);
        if (ret >= 0)
                mkbp_process(mkbp_dev, kb_state, ret);
 
index 559e619..66a61c0 100644 (file)
 #include <linux/interrupt.h>
 #include <linux/mfd/core.h>
 #include <linux/mfd/chromeos_ec.h>
+#include <linux/mfd/chromeos_ec_commands.h>
 #include <linux/platform_device.h>
 #include <linux/slab.h>
 
 
-#define MKBP_MAX_TRIES 3
+#define COMMAND_MAX_TRIES 3
 
-/* Send a one-byte command to the keyboard and receive a response of length
- * BUF_LEN.  Return BUF_LEN, or a negative error code.
- */
-static int mkbp_command_noretry(struct chromeos_ec_device *ec_dev,
-                               char cmd, uint8_t *buf, int buf_len)
+static int cros_ec_command_xfer_noretry(struct chromeos_ec_device *ec_dev,
+                                       struct chromeos_ec_msg *msg)
 {
        int ret;
        int i;
        int packet_len;
-       uint8_t *packet;
-       uint8_t sum;
+       u8 res_code;
+       u8 *out_buf = NULL;
+       u8 *in_buf = NULL;
+       u8 sum;
+       struct i2c_msg i2c_msg[2];
 
-       /* allocate larger packet (one extra byte for checksum) */
-       packet_len = buf_len + MKBP_MSG_PROTO_BYTES;
-       packet = kzalloc(packet_len, GFP_KERNEL);
-       if (!packet)
-               return -ENOMEM;
+       i2c_msg[0].addr = ec_dev->client->addr;
+       i2c_msg[0].flags = 0;
+       i2c_msg[1].addr = ec_dev->client->addr;
+       i2c_msg[1].flags = I2C_M_RD;
 
-       /* send command to EC */
-       ret = i2c_master_send(ec_dev->client, &cmd, 1);
-       if (ret < 0) {
-               dev_err(ec_dev->dev, "i2c send failed: %d\n", ret);
-               goto done;
+       if (msg->in_len) {
+               /* allocate larger packet
+                * (one byte for checksum, one for result code)
+                */
+               packet_len = msg->in_len + 2;
+               in_buf = kzalloc(packet_len, GFP_KERNEL);
+               if (!in_buf)
+                       goto done;
+               i2c_msg[1].len = packet_len;
+               i2c_msg[1].buf = (char *)in_buf;
+       } else {
+               i2c_msg[1].len = 1;
+               i2c_msg[1].buf = (char *)&res_code;
+       }
+
+       if (msg->out_len) {
+               /* allocate larger packet
+                * (one byte for checksum, one for command code)
+                */
+               packet_len = msg->out_len + 2;
+               out_buf = kzalloc(packet_len, GFP_KERNEL);
+               if (!out_buf)
+                       goto done;
+               i2c_msg[0].len = packet_len;
+               i2c_msg[0].buf = (char *)out_buf;
+               out_buf[0] = msg->cmd;
+
+               /* copy message payload and compute checksum */
+               for (i = 0, sum = 0; i < msg->out_len; i++) {
+                       out_buf[i + 1] = msg->out_buf[i];
+                       sum += out_buf[i + 1];
+               }
+               out_buf[msg->out_len + 1] = sum;
+       } else {
+               i2c_msg[0].len = 1;
+               i2c_msg[0].buf = (char *)&msg->cmd;
        }
-       /* receive response */
-       ret = i2c_master_recv(ec_dev->client, packet, packet_len);
+
+       /* send command to EC and read answer */
+       ret = i2c_transfer(ec_dev->client->adapter, i2c_msg, 2);
        if (ret < 0) {
-               dev_err(ec_dev->dev, "i2c receive failed: %d\n", ret);
+               dev_err(ec_dev->dev, "i2c transfer failed: %d\n", ret);
                goto done;
-       } else if (ret != packet_len) {
-               dev_err(ec_dev->dev, "expected %d bytes, got %d\n",
-                       packet_len, ret);
+       } else if (ret != 2) {
+               dev_err(ec_dev->dev, "failed to get response: %d\n", ret);
                ret = -EIO;
                goto done;
        }
-       /* copy response packet payload and compute checksum */
-       for (i = 0, sum = 0; i < buf_len; i++) {
-               buf[i] = packet[i];
-               sum += buf[i];
+
+       /* check response error code */
+       if (i2c_msg[1].buf[0]) {
+               dev_warn(ec_dev->dev, "command 0x%02x returned an error %d\n",
+                        msg->cmd, i2c_msg[1].buf[0]);
+               ret = -EINVAL;
+               goto done;
        }
+       if (msg->in_len) {
+               /* copy response packet payload and compute checksum */
+               for (i = 0, sum = 0; i < msg->in_len; i++) {
+                       msg->in_buf[i] = in_buf[i + 1];
+                       sum += in_buf[i + 1];
+               }
 #ifdef DEBUG
-       dev_dbg(ec_dev->dev, "packet: ");
-       for (i = 0; i < packet_len; i++) {
-               printk(" %02x", packet[i]);
-       }
-       printk(", sum = %02x\n", sum);
+               dev_dbg(ec_dev->dev, "packet: ");
+               for (i = 0; i < i2c_msg[1].len; i++)
+                       dev_dbg(ec_dev->dev, " %02x", in_buf[i]);
+               dev_dbg(ec_dev->dev, ", sum = %02x\n", sum);
 #endif
-       if (sum != packet[packet_len - 1]) {
-               dev_err(ec_dev->dev, "bad keyboard packet checksum\n");
-               ret = -EIO;
-               goto done;
+               if (sum != in_buf[msg->in_len + 1]) {
+                       dev_err(ec_dev->dev, "bad packet checksum\n");
+                       ret = -EBADMSG;
+                       goto done;
+               }
        }
-       ret = buf_len;
+
+       ret = 0;
  done:
-       kfree(packet);
+       kfree(in_buf);
+       kfree(out_buf);
        return ret;
 }
 
-static int mkbp_command(struct chromeos_ec_device *ec_dev,
-                       char cmd, uint8_t *buf, int buf_len)
+static int cros_ec_command_xfer(struct chromeos_ec_device *ec_dev,
+                                struct chromeos_ec_msg *msg)
 {
-       int try;
+       int tries;
        int ret;
        /*
         * Try the command a few times in case there are transmission errors.
         * It is possible that this is overkill, but we don't completely trust
         * i2c.
         */
-       for (try = 0; try < MKBP_MAX_TRIES; try++) {
-               ret = mkbp_command_noretry(ec_dev, cmd, buf, buf_len);
+       for (tries = 0; tries < COMMAND_MAX_TRIES; tries++) {
+               ret = cros_ec_command_xfer_noretry(ec_dev, msg);
                if (ret >= 0)
                        return ret;
        }
        dev_err(ec_dev->dev, "mkbp_command failed with %d (%d tries)\n",
-               ret, try);
+               ret, tries);
        return ret;
 }
 
+static int cros_ec_command_raw(struct chromeos_ec_device *ec_dev,
+                              struct i2c_msg *msgs, int num)
+{
+       return i2c_transfer(ec_dev->client->adapter, msgs, num);
+}
+
+static int cros_ec_command_recv(struct chromeos_ec_device *ec_dev,
+                               char cmd, void *buf, int buf_len)
+{
+       struct chromeos_ec_msg msg;
+
+       msg.cmd = cmd;
+       msg.in_buf = buf;
+       msg.in_len = buf_len;
+       msg.out_buf = NULL;
+       msg.out_len = 0;
+
+       return cros_ec_command_xfer(ec_dev, &msg);
+}
+
+static int cros_ec_command_send(struct chromeos_ec_device *ec_dev,
+                               char cmd, void *buf, int buf_len)
+{
+       struct chromeos_ec_msg msg;
+
+       msg.cmd = cmd;
+       msg.out_buf = buf;
+       msg.out_len = buf_len;
+       msg.in_buf = NULL;
+       msg.in_len = 0;
+
+       return cros_ec_command_xfer(ec_dev, &msg);
+}
+
 static irqreturn_t ec_irq_thread(int irq, void *data)
 {
        struct chromeos_ec_device *ec = data;
@@ -120,20 +196,19 @@ static irqreturn_t ec_irq_thread(int irq, void *data)
        return IRQ_HANDLED;
 }
 
-static int __devinit mkbp_check_protocol_version(struct chromeos_ec_device *ec)
+static int __devinit check_protocol_version(struct chromeos_ec_device *ec)
 {
        int ret;
-       char buf[4];
-       static char expected_version[4] = {1, 0, 0, 0};
-       int i;
+       struct ec_response_proto_version data;
 
-       ret = mkbp_command(ec, MKBP_CMDC_PROTO_VER, buf, sizeof(buf));
+       ret = cros_ec_command_recv(ec, EC_CMD_PROTO_VERSION,
+                                  &data, sizeof(data));
        if (ret < 0)
                return ret;
-       for (i = 0; i < sizeof(expected_version); i++) {
-               if (buf[i] != expected_version[i])
-                       return -EPROTONOSUPPORT;
-       }
+       dev_info(ec->dev, "protocol version: %d\n", data.version);
+       if (data.version != EC_PROTO_VERSION)
+               return -EPROTONOSUPPORT;
+
        return 0;
 }
 
@@ -164,7 +239,10 @@ static int __devinit cros_ec_probe(struct i2c_client *client,
        ec_dev->dev = dev;
        i2c_set_clientdata(client, ec_dev);
        ec_dev->irq = client->irq;
-       ec_dev->send_command = mkbp_command;
+       ec_dev->command_send = cros_ec_command_send;
+       ec_dev->command_recv = cros_ec_command_recv;
+       ec_dev->command_xfer = cros_ec_command_xfer;
+       ec_dev->command_raw  = cros_ec_command_raw;
 
        BLOCKING_INIT_NOTIFIER_HEAD(&ec_dev->event_notifier);
 
@@ -176,13 +254,14 @@ static int __devinit cros_ec_probe(struct i2c_client *client,
                goto fail;
        }
 
-       err = mkbp_check_protocol_version(ec_dev);
+       err = check_protocol_version(ec_dev);
        if (err < 0) {
                dev_err(dev, "protocol version check failed: %d\n", err);
                goto fail_irq;
        }
 
-       err = mfd_add_devices(dev, 0, cros_devs, ARRAY_SIZE(cros_devs),
+       err = mfd_add_devices(dev, 0, cros_devs,
+                             ARRAY_SIZE(cros_devs),
                              NULL, ec_dev->irq);
        if (err)
                goto fail_irq;
index 2604a1e..989713b 100644 (file)
  *
  *
  * ChromeOS EC multi function device
- * and MKBP (matrix keyboard protocol) message-based protocol definitions.
  */
 
 #ifndef __LINUX_MFD_CHROMEOS_EC_H
 #define __LINUX_MFD_CHROMEOS_EC_H
 
-enum {
-       /* Mask to convert a command byte into a command */
-       MKBP_MSG_TRAILER_BYTES  = 1,
-       MKBP_MSG_PROTO_BYTES    = MKBP_MSG_TRAILER_BYTES,
-};
-
-/* The EC command codes */
+struct i2c_msg;
 
-enum message_cmd_t {
-       /* EC control/status messages */
-       MKBP_CMDC_PROTO_VER =   0x00,   /* Read protocol version */
-       MKBP_CMDC_NOP =         0x01,   /* No operation / ping */
-       MKBP_CMDC_ID =          0x02,   /* Read EC ID */
-
-       /* Functional messages */
-       MKBP_CMDC_KEY_STATE =   0x20,   /* Read key state */
+struct chromeos_ec_msg {
+       u8 cmd;
+       uint8_t *out_buf;
+       int out_len;
+       uint8_t *in_buf;
+       int in_len;
 };
 
-
 struct chromeos_ec_device {
        struct device *dev;
        struct i2c_client *client;
        int irq;
        struct blocking_notifier_head event_notifier;
-       int (*send_command)(struct chromeos_ec_device *ec,
-                       char cmd, uint8_t *buf, int buf_len);
+       int (*command_send)(struct chromeos_ec_device *ec,
+                       char cmd, void *out_buf, int out_len);
+       int (*command_recv)(struct chromeos_ec_device *ec,
+                       char cmd, void *in_buf, int in_len);
+       int (*command_xfer)(struct chromeos_ec_device *ec,
+                       struct chromeos_ec_msg *msg);
+       int (*command_raw)(struct chromeos_ec_device *ec,
+                       struct i2c_msg *msgs, int num);
 };
 
 #endif /* __LINUX_MFD_CHROMEOS_EC_H */
diff --git a/include/linux/mfd/chromeos_ec_commands.h b/include/linux/mfd/chromeos_ec_commands.h
new file mode 100644 (file)
index 0000000..309ed1c
--- /dev/null
@@ -0,0 +1,557 @@
+/* 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.
+ */
+
+/* Host communication command constants for Chrome EC */
+
+#ifndef __CROS_EC_COMMANDS_H
+#define __CROS_EC_COMMANDS_H
+
+/* Protocol overview
+ *
+ * request:  CMD [ P0 P1 P2 ... Pn S ]
+ * response: ERR [ P0 P1 P2 ... Pn S ]
+ *
+ * where the bytes are defined as follow :
+ *      - CMD is the command code. (defined by EC_CMD_ constants)
+ *      - ERR is the error code. (defined by EC_RES_ constants)
+ *      - Px is the optional payload.
+ *        it is not sent if the error code is not success.
+ *        (defined by ec_params_ and ec_response_ structures)
+ *      - S is the checksum which is the sum of all payload bytes.
+ *
+ * On LPC, CMD and ERR are sent/received at EC_LPC_ADDR_KERNEL|USER_CMD
+ * and the payloads are sent/received at EC_LPC_ADDR_KERNEL|USER_PARAM.
+ * On I2C, all bytes are sent serially in the same message.
+ */
+
+
+/* During the development stage, the LPC bus has high error bit rate.
+ * Using checksum can detect the error and trigger re-transmit.
+ * FIXME: remove this after mass production.
+ */
+#define SUPPORT_CHECKSUM
+
+/* Current version of this protocol */
+#define EC_PROTO_VERSION          0x00000002
+
+/* I/O addresses for LPC commands */
+#define EC_LPC_ADDR_KERNEL_DATA   0x62
+#define EC_LPC_ADDR_KERNEL_CMD    0x66
+#define EC_LPC_ADDR_KERNEL_PARAM 0x800
+#define EC_LPC_ADDR_USER_DATA    0x200
+#define EC_LPC_ADDR_USER_CMD     0x204
+#define EC_LPC_ADDR_USER_PARAM   0x880
+#define EC_PARAM_SIZE          128  /* Size of each param area in bytes */
+
+/* EC command register bit functions */
+#define EC_LPC_CMDR_DATA       (1 << 0)
+#define EC_LPC_CMDR_PENDING    (1 << 1)
+#define EC_LPC_CMDR_BUSY       (1 << 2)
+#define EC_LPC_CMDR_CMD                (1 << 3)
+#define EC_LPC_CMDR_ACPI_BRST  (1 << 4)
+#define EC_LPC_CMDR_SCI                (1 << 5)
+#define EC_LPC_CMDR_SMI                (1 << 6)
+
+#define EC_LPC_ADDR_MEMMAP       0x900
+#define EC_MEMMAP_SIZE         255 /* ACPI IO buffer max is 255 bytes */
+#define EC_MEMMAP_TEXT_MAX     8   /* Size of a string in the memory map */
+
+/* The offset address of each type of data in mapped memory. */
+#define EC_MEMMAP_TEMP_SENSOR 0x00
+#define EC_MEMMAP_FAN         0x10
+#define EC_MEMMAP_SWITCHES    0x30
+#define EC_MEMMAP_HOST_EVENTS 0x34
+#define EC_MEMMAP_BATT_VOLT   0x40 /* Battery Present Voltage */
+#define EC_MEMMAP_BATT_RATE   0x44 /* Battery Present Rate */
+#define EC_MEMMAP_BATT_CAP    0x48 /* Battery Remaining Capacity */
+#define EC_MEMMAP_BATT_FLAG   0x4c /* Battery State, defined below */
+#define EC_MEMMAP_BATT_DCAP   0x50 /* Battery Design Capacity */
+#define EC_MEMMAP_BATT_DVLT   0x54 /* Battery Design Voltage */
+#define EC_MEMMAP_BATT_LFCC   0x58 /* Battery Last Full Charge Capacity */
+#define EC_MEMMAP_BATT_CCNT   0x5c /* Battery Cycle Count */
+#define EC_MEMMAP_BATT_MFGR   0x60 /* Battery Manufacturer String */
+#define EC_MEMMAP_BATT_MODEL  0x68 /* Battery Model Number String */
+#define EC_MEMMAP_BATT_SERIAL 0x70 /* Battery Serial Number String */
+#define EC_MEMMAP_BATT_TYPE   0x78 /* Battery Type String */
+
+/* Battery bit flags at EC_MEMMAP_BATT_FLAG. */
+#define EC_BATT_FLAG_AC_PRESENT   0x01
+#define EC_BATT_FLAG_BATT_PRESENT 0x02
+#define EC_BATT_FLAG_DISCHARGING  0x04
+#define EC_BATT_FLAG_CHARGING     0x08
+#define EC_BATT_FLAG_LEVEL_CRITICAL 0x10
+
+/* Switch flags at EC_MEMMAP_SWITCHES */
+#define EC_SWITCH_LID_OPEN               0x01
+#define EC_SWITCH_POWER_BUTTON_PRESSED   0x02
+#define EC_SWITCH_WRITE_PROTECT_DISABLED 0x04
+/* Recovery requested via keyboard */
+#define EC_SWITCH_KEYBOARD_RECOVERY      0x08
+/* Recovery requested via dedicated signal (from servo board) */
+#define EC_SWITCH_DEDICATED_RECOVERY     0x10
+/* Fake developer switch (for testing) */
+#define EC_SWITCH_FAKE_DEVELOPER         0x20
+
+/* The offset of temperature value stored in mapped memory.
+ * This allows reporting a temperature range of
+ * 200K to 454K = -73C to 181C.
+ */
+#define EC_TEMP_SENSOR_OFFSET 200
+
+/*
+ * This header file is used in coreboot both in C and ACPI code.
+ * The ACPI code is pre-processed to handle constants but the ASL
+ * compiler is unable to handle actual C code so keep it separate.
+ */
+#ifndef __ACPI__
+
+/* LPC command status byte masks */
+/* EC has written a byte in the data register and host hasn't read it yet */
+#define EC_LPC_STATUS_TO_HOST     0x01
+/* Host has written a command/data byte and the EC hasn't read it yet */
+#define EC_LPC_STATUS_FROM_HOST   0x02
+/* EC is processing a command */
+#define EC_LPC_STATUS_PROCESSING  0x04
+/* Last write to EC was a command, not data */
+#define EC_LPC_STATUS_LAST_CMD    0x08
+/* EC is in burst mode.  Chrome EC doesn't support this, so this bit is never
+ * set. */
+#define EC_LPC_STATUS_BURST_MODE  0x10
+/* SCI event is pending (requesting SCI query) */
+#define EC_LPC_STATUS_SCI_PENDING 0x20
+/* SMI event is pending (requesting SMI query) */
+#define EC_LPC_STATUS_SMI_PENDING 0x40
+/* (reserved) */
+#define EC_LPC_STATUS_RESERVED    0x80
+
+/* EC is busy.  This covers both the EC processing a command, and the host has
+ * written a new command but the EC hasn't picked it up yet. */
+#define EC_LPC_STATUS_BUSY_MASK \
+       (EC_LPC_STATUS_FROM_HOST | EC_LPC_STATUS_PROCESSING)
+
+/* Host command response codes */
+/* TODO: move these so they don't overlap SCI/SMI data? */
+enum ec_status {
+       EC_RES_SUCCESS = 0,
+       EC_RES_INVALID_COMMAND = 1,
+       EC_RES_ERROR = 2,
+       EC_RES_INVALID_PARAM = 3,
+       EC_RES_ACCESS_DENIED = 4,
+};
+
+
+/* Host event codes.  Note these are 1-based, not 0-based, because ACPI query
+ * EC command uses code 0 to mean "no event pending".  We explicitly specify
+ * each value in the enum listing so they won't change if we delete/insert an
+ * item or rearrange the list (it needs to be stable across platforms, not
+ * just within a single compiled instance). */
+enum host_event_code {
+       EC_HOST_EVENT_LID_CLOSED = 1,
+       EC_HOST_EVENT_LID_OPEN = 2,
+       EC_HOST_EVENT_POWER_BUTTON = 3,
+       EC_HOST_EVENT_AC_CONNECTED = 4,
+       EC_HOST_EVENT_AC_DISCONNECTED = 5,
+       EC_HOST_EVENT_BATTERY_LOW = 6,
+       EC_HOST_EVENT_BATTERY_CRITICAL = 7,
+       EC_HOST_EVENT_BATTERY = 8,
+       EC_HOST_EVENT_THERMAL_THRESHOLD = 9,
+       EC_HOST_EVENT_THERMAL_OVERLOAD = 10,
+       EC_HOST_EVENT_THERMAL = 11,
+       EC_HOST_EVENT_USB_CHARGER = 12,
+       EC_HOST_EVENT_KEY_PRESSED = 13,
+};
+/* Host event mask */
+#define EC_HOST_EVENT_MASK(event_code) (1 << ((event_code) - 1))
+
+/* Notes on commands:
+ *
+ * Each command is an 8-byte command value.  Commands which take
+ * params or return response data specify structs for that data.  If
+ * no struct is specified, the command does not input or output data,
+ * respectively. */
+
+/*****************************************************************************/
+/* General / test commands */
+
+/* Get protocol version, used to deal with non-backward compatible protocol
+ * changes. */
+#define EC_CMD_PROTO_VERSION 0x00
+struct ec_response_proto_version {
+       uint32_t version;
+} __attribute__ ((packed));
+
+/* Hello.  This is a simple command to test the EC is responsive to
+ * commands. */
+#define EC_CMD_HELLO 0x01
+struct ec_params_hello {
+       uint32_t in_data;  /* Pass anything here */
+} __attribute__ ((packed));
+struct ec_response_hello {
+       uint32_t out_data;  /* Output will be in_data + 0x01020304 */
+} __attribute__ ((packed));
+
+
+/* Get version number */
+#define EC_CMD_GET_VERSION 0x02
+enum ec_current_image {
+       EC_IMAGE_UNKNOWN = 0,
+       EC_IMAGE_RO,
+       EC_IMAGE_RW_A,
+       EC_IMAGE_RW_B
+};
+struct ec_response_get_version {
+       /* Null-terminated version strings for RO, RW-A, RW-B */
+       char version_string_ro[32];
+       char version_string_rw_a[32];
+       char version_string_rw_b[32];
+       uint32_t current_image;  /* One of ec_current_image */
+} __attribute__ ((packed));
+
+
+/* Read test */
+#define EC_CMD_READ_TEST 0x03
+struct ec_params_read_test {
+       uint32_t offset;   /* Starting value for read buffer */
+       uint32_t size;     /* Size to read in bytes */
+} __attribute__ ((packed));
+struct ec_response_read_test {
+       uint32_t data[32];
+} __attribute__ ((packed));
+
+
+/* Get build information */
+#define EC_CMD_GET_BUILD_INFO 0x04
+struct ec_response_get_build_info {
+       char build_string[EC_PARAM_SIZE];
+} __attribute__ ((packed));
+
+
+/* Get chip info */
+#define EC_CMD_GET_CHIP_INFO 0x05
+struct ec_response_get_chip_info {
+       /* Null-terminated strings */
+       char vendor[32];
+       char name[32];
+       char revision[32];  /* Mask version */
+} __attribute__ ((packed));
+
+
+/*****************************************************************************/
+/* Flash commands */
+
+/* Maximum bytes that can be read/written in a single command */
+#define EC_FLASH_SIZE_MAX 64
+
+/* Get flash info */
+#define EC_CMD_FLASH_INFO 0x10
+struct ec_response_flash_info {
+       /* Usable flash size, in bytes */
+       uint32_t flash_size;
+       /* Write block size.  Write offset and size must be a multiple
+        * of this. */
+       uint32_t write_block_size;
+       /* Erase block size.  Erase offset and size must be a multiple
+        * of this. */
+       uint32_t erase_block_size;
+       /* Protection block size.  Protection offset and size must be a
+        * multiple of this. */
+       uint32_t protect_block_size;
+} __attribute__ ((packed));
+
+/* Read flash */
+#define EC_CMD_FLASH_READ 0x11
+struct ec_params_flash_read {
+       uint32_t offset;   /* Byte offset to read */
+       uint32_t size;     /* Size to read in bytes */
+} __attribute__ ((packed));
+struct ec_response_flash_read {
+       uint8_t data[EC_FLASH_SIZE_MAX];
+} __attribute__ ((packed));
+
+/* Write flash */
+#define EC_CMD_FLASH_WRITE 0x12
+struct ec_params_flash_write {
+       uint32_t offset;   /* Byte offset to write */
+       uint32_t size;     /* Size to write in bytes */
+       uint8_t data[EC_FLASH_SIZE_MAX];
+} __attribute__ ((packed));
+
+/* Erase flash */
+#define EC_CMD_FLASH_ERASE 0x13
+struct ec_params_flash_erase {
+       uint32_t offset;   /* Byte offset to erase */
+       uint32_t size;     /* Size to erase in bytes */
+} __attribute__ ((packed));
+
+/* Flashmap offset */
+#define EC_CMD_FLASH_GET_FLASHMAP 0x14
+struct ec_response_flash_flashmap {
+       uint32_t offset;   /* Flashmap offset */
+} __attribute__ ((packed));
+
+/* Enable/disable flash write protect */
+#define EC_CMD_FLASH_WP_ENABLE 0x15
+struct ec_params_flash_wp_enable {
+       uint32_t enable_wp;
+} __attribute__ ((packed));
+
+/* Get flash write protection commit state */
+#define EC_CMD_FLASH_WP_GET_STATE 0x16
+struct ec_response_flash_wp_enable {
+       uint32_t enable_wp;
+} __attribute__ ((packed));
+
+/* Set/get flash write protection range */
+#define EC_CMD_FLASH_WP_SET_RANGE 0x17
+struct ec_params_flash_wp_range {
+       /* Byte offset aligned to info.protect_block_size */
+       uint32_t offset;
+       /* Size should be multiply of info.protect_block_size */
+       uint32_t size;
+} __attribute__ ((packed));
+
+#define EC_CMD_FLASH_WP_GET_RANGE 0x18
+struct ec_response_flash_wp_range {
+       uint32_t offset;
+       uint32_t size;
+} __attribute__ ((packed));
+
+/* Read flash write protection GPIO pin */
+#define EC_CMD_FLASH_WP_GET_GPIO 0x19
+struct ec_params_flash_wp_gpio {
+       uint32_t pin_no;
+} __attribute__ ((packed));
+struct ec_response_flash_wp_gpio {
+       uint32_t value;
+} __attribute__ ((packed));
+
+#ifdef SUPPORT_CHECKSUM
+/* Checksum a range of flash datq */
+#define EC_CMD_FLASH_CHECKSUM 0x1f
+struct ec_params_flash_checksum {
+       uint32_t offset;   /* Byte offset to read */
+       uint32_t size;     /* Size to read in bytes */
+} __attribute__ ((packed));
+struct ec_response_flash_checksum {
+       uint8_t checksum;
+} __attribute__ ((packed));
+#define BYTE_IN(sum, byte) do {  \
+               sum = (sum << 1) | (sum >> 7);  \
+               sum ^= (byte ^ 0x53);  \
+       } while (0)
+#endif  /* SUPPORT_CHECKSUM */
+
+/*****************************************************************************/
+/* PWM commands */
+
+/* Get fan RPM */
+#define EC_CMD_PWM_GET_FAN_RPM 0x20
+struct ec_response_pwm_get_fan_rpm {
+       uint32_t rpm;
+} __attribute__ ((packed));
+
+/* Set target fan RPM */
+#define EC_CMD_PWM_SET_FAN_TARGET_RPM 0x21
+struct ec_params_pwm_set_fan_target_rpm {
+       uint32_t rpm;
+} __attribute__ ((packed));
+
+/* Get keyboard backlight */
+#define EC_CMD_PWM_GET_KEYBOARD_BACKLIGHT 0x22
+struct ec_response_pwm_get_keyboard_backlight {
+       uint8_t percent;
+} __attribute__ ((packed));
+
+/* Set keyboard backlight */
+#define EC_CMD_PWM_SET_KEYBOARD_BACKLIGHT 0x23
+struct ec_params_pwm_set_keyboard_backlight {
+       uint8_t percent;
+} __attribute__ ((packed));
+
+/*****************************************************************************/
+/* Lightbar commands. This looks worse than it is. Since we only use one LPC
+ * command to say "talk to the lightbar", we put the "and tell it to do X"
+ * part into a subcommand. We'll make separate structs for subcommands with
+ * different input args, so that we know how much to expect. */
+#define EC_CMD_LIGHTBAR_CMD 0x28
+struct ec_params_lightbar_cmd {
+       union {
+               union {
+                       uint8_t cmd;
+                       struct {
+                               uint8_t cmd;
+                       } dump, off, on, init, get_seq;
+                       struct num {
+                               uint8_t cmd;
+                               uint8_t num;
+                       } brightness, seq;
+
+                       struct reg {
+                               uint8_t cmd;
+                               uint8_t ctrl, reg, value;
+                       } reg;
+                       struct rgb {
+                               uint8_t cmd;
+                               uint8_t led, red, green, blue;
+                       } rgb;
+               } in;
+               union {
+                       struct dump {
+                               struct {
+                                       uint8_t reg;
+                                       uint8_t ic0;
+                                       uint8_t ic1;
+                               } vals[23];
+                       } dump;
+                       struct get_seq {
+                               uint8_t num;
+                       } get_seq;
+                       struct {
+                               /* no return params */
+                       } off, on, init, brightness, seq, reg, rgb;
+               } out;
+       };
+} __attribute__ ((packed));
+
+/*****************************************************************************/
+/* USB charging control commands */
+
+/* Set USB port charging mode */
+#define EC_CMD_USB_CHARGE_SET_MODE 0x30
+struct ec_params_usb_charge_set_mode {
+       uint8_t usb_port_id;
+       uint8_t mode;
+} __attribute__ ((packed));
+
+/*****************************************************************************/
+/* Persistent storage for host */
+
+/* Maximum bytes that can be read/written in a single command */
+#define EC_PSTORE_SIZE_MAX 64
+
+/* Get persistent storage info */
+#define EC_CMD_PSTORE_INFO 0x40
+struct ec_response_pstore_info {
+       /* Persistent storage size, in bytes */
+       uint32_t pstore_size;
+       /* Access size.  Read/write offset and size must be a multiple
+        * of this. */
+       uint32_t access_size;
+} __attribute__ ((packed));
+
+/* Read persistent storage */
+#define EC_CMD_PSTORE_READ 0x41
+struct ec_params_pstore_read {
+       uint32_t offset;   /* Byte offset to read */
+       uint32_t size;     /* Size to read in bytes */
+} __attribute__ ((packed));
+struct ec_response_pstore_read {
+       uint8_t data[EC_PSTORE_SIZE_MAX];
+} __attribute__ ((packed));
+
+/* Write persistent storage */
+#define EC_CMD_PSTORE_WRITE 0x42
+struct ec_params_pstore_write {
+       uint32_t offset;   /* Byte offset to write */
+       uint32_t size;     /* Size to write in bytes */
+       uint8_t data[EC_PSTORE_SIZE_MAX];
+} __attribute__ ((packed));
+
+/*****************************************************************************/
+/* Thermal engine commands */
+
+/* Set thershold value */
+#define EC_CMD_THERMAL_SET_THRESHOLD 0x50
+struct ec_params_thermal_set_threshold {
+       uint8_t sensor_type;
+       uint8_t threshold_id;
+       uint16_t value;
+} __attribute__ ((packed));
+
+/* Get threshold value */
+#define EC_CMD_THERMAL_GET_THRESHOLD 0x51
+struct ec_params_thermal_get_threshold {
+       uint8_t sensor_type;
+       uint8_t threshold_id;
+} __attribute__ ((packed));
+struct ec_response_thermal_get_threshold {
+       uint16_t value;
+} __attribute__ ((packed));
+
+/* Toggling automatic fan control */
+#define EC_CMD_THERMAL_AUTO_FAN_CTRL 0x52
+
+/*****************************************************************************/
+/* Matrix KeyBoard Protocol */
+
+/* Read key state */
+#define EC_CMD_MKBP_STATE 0x60
+struct ec_response_mkbp_state {
+       uint8_t cols[32];
+} __attribute__ ((packed));
+
+/* Provide information about the matrix : number of rows and columns */
+#define EC_CMD_MKBP_INFO 0x61
+struct ec_response_mkbp_info {
+       uint32_t rows;
+       uint32_t cols;
+} __attribute__ ((packed));
+
+/*****************************************************************************/
+/* Host event commands */
+
+/* Host event mask params and response structures, shared by all of the host
+ * event commands below. */
+struct ec_params_host_event_mask {
+       uint32_t mask;
+} __attribute__ ((packed));
+
+struct ec_response_host_event_mask {
+       uint32_t mask;
+} __attribute__ ((packed));
+
+/* These all use ec_response_host_event_mask */
+#define EC_CMD_HOST_EVENT_GET_SMI_MASK  0x88
+#define EC_CMD_HOST_EVENT_GET_SCI_MASK  0x89
+#define EC_CMD_HOST_EVENT_GET_WAKE_MASK 0x8d
+
+/* These all use ec_params_host_event_mask */
+#define EC_CMD_HOST_EVENT_SET_SMI_MASK  0x8a
+#define EC_CMD_HOST_EVENT_SET_SCI_MASK  0x8b
+#define EC_CMD_HOST_EVENT_CLEAR         0x8c
+#define EC_CMD_HOST_EVENT_SET_WAKE_MASK 0x8e
+
+/*****************************************************************************/
+/* Special commands
+ *
+ * These do not follow the normal rules for commands.  See each command for
+ * details. */
+
+/* ACPI Query Embedded Controller
+ *
+ * This clears the lowest-order bit in the currently pending host events, and
+ * sets the result code to the 1-based index of the bit (event 0x00000001 = 1,
+ * event 0x80000000 = 32), or 0 if no event was pending. */
+#define EC_CMD_ACPI_QUERY_EVENT 0x84
+
+/* Reboot
+ *
+ * This command will work even when the EC LPC interface is busy, because the
+ * reboot command is processed at interrupt level.  Note that when the EC
+ * reboots, the host will reboot too, so there is no response to this
+ * command. */
+#define EC_CMD_REBOOT 0xd1  /* Think "die" */
+
+#define EC_CMD_REBOOT_EC 0xd2
+#define EC_CMD_REBOOT_BIT_RECOVERY (1 << 0)
+
+struct ec_params_reboot_ec {
+       uint8_t target;  /* enum ec_current_image */
+       uint8_t reboot_flags;
+} __attribute__ ((packed));
+
+#endif  /* !__ACPI__ */
+
+#endif  /* __CROS_EC_COMMANDS_H */