misc: imx8: scu: add i.MX8QM support
[oweals/u-boot.git] / drivers / misc / cros_ec_i2c.c
index 0fbab991b5b0af8d121a6e71efc720665fe2b60d..cdd55f5aa85cfab427700ebbd16202d0896ee157 100644 (file)
@@ -1,9 +1,8 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * Chromium OS cros_ec driver - I2C interface
  *
  * Copyright (c) 2012 The Chromium OS Authors.
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 /*
@@ -14,6 +13,7 @@
  */
 
 #include <common.h>
+#include <dm.h>
 #include <i2c.h>
 #include <cros_ec.h>
 
 #define debug_trace(fmt, b...)
 #endif
 
-int cros_ec_i2c_command(struct cros_ec_dev *dev, uint8_t cmd, int cmd_version,
-                    const uint8_t *dout, int dout_len,
-                    uint8_t **dinp, int din_len)
+/**
+ * Request format for protocol v3
+ * byte 0      0xda (EC_COMMAND_PROTOCOL_3)
+ * byte 1-8    struct ec_host_request
+ * byte 10-    response data
+ */
+struct ec_host_request_i2c {
+       /* Always 0xda to backward compatible with v2 struct */
+       uint8_t  command_protocol;
+       struct ec_host_request ec_request;
+} __packed;
+
+/*
+ * Response format for protocol v3
+ * byte 0      result code
+ * byte 1      packet_length
+ * byte 2-9    struct ec_host_response
+ * byte 10-    response data
+ */
+struct ec_host_response_i2c {
+       uint8_t result;
+       uint8_t packet_length;
+       struct ec_host_response ec_response;
+} __packed;
+
+static int cros_ec_i2c_packet(struct udevice *udev, int out_bytes, int in_bytes)
 {
-       int old_bus = 0;
+       struct cros_ec_dev *dev = dev_get_uclass_priv(udev);
+       struct dm_i2c_chip *chip = dev_get_parent_platdata(udev);
+       struct ec_host_request_i2c *ec_request_i2c =
+               (struct ec_host_request_i2c *)dev->dout;
+       struct ec_host_response_i2c *ec_response_i2c =
+               (struct ec_host_response_i2c *)dev->din;
+       struct i2c_msg i2c_msg[2];
+       int ret;
+
+       i2c_msg[0].addr = chip->chip_addr;
+       i2c_msg[0].flags = 0;
+       i2c_msg[1].addr = chip->chip_addr;
+       i2c_msg[1].flags = I2C_M_RD;
+
+       /* one extra byte, to indicate v3 */
+       i2c_msg[0].len = out_bytes + 1;
+       i2c_msg[0].buf = dev->dout;
+
+       /* stitch on EC_COMMAND_PROTOCOL_3 */
+       memmove(&ec_request_i2c->ec_request, dev->dout, out_bytes);
+       ec_request_i2c->command_protocol = EC_COMMAND_PROTOCOL_3;
+
+       /* two extra bytes for v3 */
+       i2c_msg[1].len = in_bytes + 2;
+       i2c_msg[1].buf = dev->din;
+
+       ret = dm_i2c_xfer(udev, &i2c_msg[0], 2);
+       if (ret) {
+               printf("%s: Could not execute transfer: %d\n", __func__, ret);
+               return ret;
+       }
+
+       /* When we send a v3 request to v2 ec, ec won't recognize the 0xda
+        * (EC_COMMAND_PROTOCOL_3) and will return with status
+        * EC_RES_INVALID_COMMAND with zero data length
+        *
+        * In case of invalid command for v3 protocol the data length
+        * will be at least sizeof(struct ec_host_response)
+        */
+       if (ec_response_i2c->result == EC_RES_INVALID_COMMAND &&
+           ec_response_i2c->packet_length == 0)
+               return -EPROTONOSUPPORT;
+
+       if (ec_response_i2c->packet_length < sizeof(struct ec_host_response)) {
+               printf("%s: response of %u bytes too short; not a full hdr\n",
+                      __func__, ec_response_i2c->packet_length);
+               return -EBADMSG;
+       }
+
+
+       /* drop result and packet_len */
+       memmove(dev->din, &ec_response_i2c->ec_response, in_bytes);
+
+       return in_bytes;
+}
+
+static int cros_ec_i2c_command(struct udevice *udev, uint8_t cmd,
+                              int cmd_version, const uint8_t *dout,
+                              int dout_len, uint8_t **dinp, int din_len)
+{
+       struct cros_ec_dev *dev = dev_get_uclass_priv(udev);
+       struct dm_i2c_chip *chip = dev_get_parent_platdata(udev);
+       struct i2c_msg i2c_msg[2];
        /* version8, cmd8, arglen8, out8[dout_len], csum8 */
        int out_bytes = dout_len + 4;
        /* response8, arglen8, in8[din_len], checksum8 */
@@ -35,9 +120,7 @@ int cros_ec_i2c_command(struct cros_ec_dev *dev, uint8_t cmd, int cmd_version,
        uint8_t *ptr;
        /* Receive input data, so that args will be dword aligned */
        uint8_t *in_ptr;
-       int ret;
-
-       old_bus = i2c_get_bus_num();
+       int len, csum, ret;
 
        /*
         * Sanity-check I/O sizes given transaction overhead in internal
@@ -54,6 +137,11 @@ int cros_ec_i2c_command(struct cros_ec_dev *dev, uint8_t cmd, int cmd_version,
        assert(dout_len >= 0);
        assert(dinp);
 
+       i2c_msg[0].addr = chip->chip_addr;
+       i2c_msg[0].len = out_bytes;
+       i2c_msg[0].buf = dev->dout;
+       i2c_msg[0].flags = 0;
+
        /*
         * Copy command and data into output buffer so we can do a single I2C
         * burst transaction.
@@ -67,80 +155,59 @@ int cros_ec_i2c_command(struct cros_ec_dev *dev, uint8_t cmd, int cmd_version,
         * will be dword aligned.
         */
        in_ptr = dev->din + sizeof(int64_t);
-       if (!dev->cmd_version_is_supported) {
-               /* Send an old-style command */
-               *ptr++ = cmd;
-               out_bytes = dout_len + 1;
-               in_bytes = din_len + 2;
-               in_ptr--;       /* Expect just a status byte */
-       } else {
-               *ptr++ = EC_CMD_VERSION0 + cmd_version;
-               *ptr++ = cmd;
-               *ptr++ = dout_len;
-               in_ptr -= 2;    /* Expect status, length bytes */
+
+       if (dev->protocol_version != 2) {
+               /* Something we don't support */
+               debug("%s: Protocol version %d unsupported\n",
+                     __func__, dev->protocol_version);
+               return -1;
        }
+
+       *ptr++ = EC_CMD_VERSION0 + cmd_version;
+       *ptr++ = cmd;
+       *ptr++ = dout_len;
+       in_ptr -= 2;    /* Expect status, length bytes */
+
        memcpy(ptr, dout, dout_len);
        ptr += dout_len;
 
-       if (dev->cmd_version_is_supported)
-               *ptr++ = (uint8_t)
-                        cros_ec_calc_checksum(dev->dout, dout_len + 3);
+       *ptr++ = (uint8_t)
+               cros_ec_calc_checksum(dev->dout, dout_len + 3);
 
-       /* Set to the proper i2c bus */
-       if (i2c_set_bus_num(dev->bus_num)) {
-               debug("%s: Cannot change to I2C bus %d\n", __func__,
-                       dev->bus_num);
-               return -1;
-       }
+       i2c_msg[1].addr = chip->chip_addr;
+       i2c_msg[1].len = in_bytes;
+       i2c_msg[1].buf = in_ptr;
+       i2c_msg[1].flags = I2C_M_RD;
 
        /* Send output data */
        cros_ec_dump_data("out", -1, dev->dout, out_bytes);
-       ret = i2c_write(dev->addr, 0, 0, dev->dout, out_bytes);
+
+       ret = dm_i2c_xfer(udev, &i2c_msg[0], 2);
        if (ret) {
-               debug("%s: Cannot complete I2C write to 0x%x\n",
-                       __func__, dev->addr);
+               debug("%s: Could not execute transfer to %s\n", __func__,
+                     udev->name);
                ret = -1;
        }
 
-       if (!ret) {
-               ret = i2c_read(dev->addr, 0, 0, in_ptr, in_bytes);
-               if (ret) {
-                       debug("%s: Cannot complete I2C read from 0x%x\n",
-                               __func__, dev->addr);
-                       ret = -1;
-               }
-       }
-
-       /* Return to original bus number */
-       i2c_set_bus_num(old_bus);
-       if (ret)
-               return ret;
-
        if (*in_ptr != EC_RES_SUCCESS) {
                debug("%s: Received bad result code %d\n", __func__, *in_ptr);
                return -(int)*in_ptr;
        }
 
-       if (dev->cmd_version_is_supported) {
-               int len, csum;
-
-               len = in_ptr[1];
-               if (len + 3 > sizeof(dev->din)) {
-                       debug("%s: Received length %#02x too large\n",
-                             __func__, len);
-                       return -1;
-               }
-               csum = cros_ec_calc_checksum(in_ptr, 2 + len);
-               if (csum != in_ptr[2 + len]) {
-                       debug("%s: Invalid checksum rx %#02x, calced %#02x\n",
-                             __func__, in_ptr[2 + din_len], csum);
-                       return -1;
-               }
-               din_len = min(din_len, len);
-               cros_ec_dump_data("in", -1, in_ptr, din_len + 3);
-       } else {
-               cros_ec_dump_data("in (old)", -1, in_ptr, in_bytes);
+       len = in_ptr[1];
+       if (len + 3 > sizeof(dev->din)) {
+               debug("%s: Received length %#02x too large\n",
+                     __func__, len);
+               return -1;
        }
+       csum = cros_ec_calc_checksum(in_ptr, 2 + len);
+       if (csum != in_ptr[2 + len]) {
+               debug("%s: Invalid checksum rx %#02x, calced %#02x\n",
+                     __func__, in_ptr[2 + din_len], csum);
+               return -1;
+       }
+       din_len = min(din_len, len);
+       cros_ec_dump_data("in", -1, in_ptr, din_len + 3);
 
        /* Return pointer to dword-aligned input data, if any */
        *dinp = dev->din + sizeof(int64_t);
@@ -148,37 +215,25 @@ int cros_ec_i2c_command(struct cros_ec_dev *dev, uint8_t cmd, int cmd_version,
        return din_len;
 }
 
-int cros_ec_i2c_decode_fdt(struct cros_ec_dev *dev, const void *blob)
+static int cros_ec_probe(struct udevice *dev)
 {
-       /* Decode interface-specific FDT params */
-       dev->max_frequency = fdtdec_get_int(blob, dev->node,
-                                           "i2c-max-frequency", 100000);
-       dev->bus_num = i2c_get_bus_num_fdt(dev->parent_node);
-       if (dev->bus_num == -1) {
-               debug("%s: Failed to read bus number\n", __func__);
-               return -1;
-       }
-       dev->addr = fdtdec_get_int(blob, dev->node, "reg", -1);
-       if (dev->addr == -1) {
-               debug("%s: Failed to read device address\n", __func__);
-               return -1;
-       }
-
-       return 0;
+       return cros_ec_register(dev);
 }
 
-/**
- * Initialize I2C protocol.
- *
- * @param dev          CROS_EC device
- * @param blob         Device tree blob
- * @return 0 if ok, -1 on error
- */
-int cros_ec_i2c_init(struct cros_ec_dev *dev, const void *blob)
-{
-       i2c_init(dev->max_frequency, dev->addr);
-
-       dev->cmd_version_is_supported = 0;
-
-       return 0;
-}
+static struct dm_cros_ec_ops cros_ec_ops = {
+       .command = cros_ec_i2c_command,
+       .packet = cros_ec_i2c_packet,
+};
+
+static const struct udevice_id cros_ec_ids[] = {
+       { .compatible = "google,cros-ec-i2c" },
+       { }
+};
+
+U_BOOT_DRIVER(cros_ec_i2c) = {
+       .name           = "cros_ec_i2c",
+       .id             = UCLASS_CROS_EC,
+       .of_match       = cros_ec_ids,
+       .probe          = cros_ec_probe,
+       .ops            = &cros_ec_ops,
+};