Merge tag 'efi-2020-04-rc3' of https://gitlab.denx.de/u-boot/custodians/u-boot-efi
[oweals/u-boot.git] / drivers / i2c / i2c-cdns.c
index 1c9fda8f66767bd13d18ac48e4639e3a303500e9..ac15da2c67ffea715dc5b3ece1c4b032dcd9f44b 100644 (file)
@@ -1,24 +1,23 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * Copyright (C) 2015 Moritz Fischer <moritz.fischer@ettus.com>
  * IP from Cadence (ID T-CS-PE-0007-100, Version R1p10f2)
  *
  * This file is based on: drivers/i2c/zynq_i2c.c,
  * with added driver-model support and code cleanup.
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #include <common.h>
+#include <dm.h>
 #include <linux/types.h>
 #include <linux/io.h>
 #include <linux/errno.h>
-#include <dm/device.h>
 #include <dm/root.h>
 #include <i2c.h>
 #include <fdtdec.h>
 #include <mapmem.h>
-
-DECLARE_GLOBAL_DATA_PTR;
+#include <wait_bit.h>
+#include <clk.h>
 
 /* i2c register set */
 struct cdns_i2c_regs {
@@ -65,10 +64,24 @@ struct cdns_i2c_regs {
 #define CDNS_I2C_INTERRUPT_RXUNF       0x00000080
 #define CDNS_I2C_INTERRUPT_ARBLOST     0x00000200
 
+#define CDNS_I2C_INTERRUPTS_MASK       (CDNS_I2C_INTERRUPT_COMP | \
+                                       CDNS_I2C_INTERRUPT_DATA | \
+                                       CDNS_I2C_INTERRUPT_NACK | \
+                                       CDNS_I2C_INTERRUPT_TO | \
+                                       CDNS_I2C_INTERRUPT_SLVRDY | \
+                                       CDNS_I2C_INTERRUPT_RXOVF | \
+                                       CDNS_I2C_INTERRUPT_TXOVF | \
+                                       CDNS_I2C_INTERRUPT_RXUNF | \
+                                       CDNS_I2C_INTERRUPT_ARBLOST)
+
 #define CDNS_I2C_FIFO_DEPTH            16
 #define CDNS_I2C_TRANSFER_SIZE_MAX     255 /* Controller transfer limit */
+#define CDNS_I2C_TRANSFER_SIZE         (CDNS_I2C_TRANSFER_SIZE_MAX - 3)
+
 #define CDNS_I2C_BROKEN_HOLD_BIT       BIT(0)
 
+#define CDNS_I2C_ARB_LOST_MAX_RETRIES  10
+
 #ifdef DEBUG
 static void cdns_i2c_debug_status(struct cdns_i2c_regs *cdns_i2c)
 {
@@ -200,7 +213,7 @@ static int cdns_i2c_set_bus_speed(struct udevice *dev, unsigned int speed)
        unsigned long speed_p = speed;
        int ret = 0;
 
-       if (speed > 400000) {
+       if (speed > I2C_SPEED_FAST_RATE) {
                debug("%s, failed to set clock speed to %u\n", __func__,
                      speed);
                return -EINVAL;
@@ -223,105 +236,162 @@ static int cdns_i2c_set_bus_speed(struct udevice *dev, unsigned int speed)
        return 0;
 }
 
-/* Probe to see if a chip is present. */
-static int cdns_i2c_probe_chip(struct udevice *bus, uint chip_addr,
-                               uint chip_flags)
+static inline u32 is_arbitration_lost(struct cdns_i2c_regs *regs)
 {
-       struct i2c_cdns_bus *i2c_bus = dev_get_priv(bus);
-       struct cdns_i2c_regs *regs = i2c_bus->regs;
-
-       /* Attempt to read a byte */
-       setbits_le32(&regs->control, CDNS_I2C_CONTROL_CLR_FIFO |
-               CDNS_I2C_CONTROL_RW);
-       clrbits_le32(&regs->control, CDNS_I2C_CONTROL_HOLD);
-       writel(0xFF, &regs->interrupt_status);
-       writel(chip_addr, &regs->address);
-       writel(1, &regs->transfer_size);
-
-       return (cdns_i2c_wait(regs, CDNS_I2C_INTERRUPT_COMP |
-               CDNS_I2C_INTERRUPT_NACK) &
-               CDNS_I2C_INTERRUPT_COMP) ? 0 : -ETIMEDOUT;
+       return (readl(&regs->interrupt_status) & CDNS_I2C_INTERRUPT_ARBLOST);
 }
 
 static int cdns_i2c_write_data(struct i2c_cdns_bus *i2c_bus, u32 addr, u8 *data,
                               u32 len)
 {
        u8 *cur_data = data;
-
        struct cdns_i2c_regs *regs = i2c_bus->regs;
+       u32 ret;
 
+       /* Set the controller in Master transmit mode and clear FIFO */
        setbits_le32(&regs->control, CDNS_I2C_CONTROL_CLR_FIFO);
+       clrbits_le32(&regs->control, CDNS_I2C_CONTROL_RW);
 
+       /* Check message size against FIFO depth, and set hold bus bit
+        * if it is greater than FIFO depth
+        */
+       if (len > CDNS_I2C_FIFO_DEPTH)
+               setbits_le32(&regs->control, CDNS_I2C_CONTROL_HOLD);
 
-       clrbits_le32(&regs->control, CDNS_I2C_CONTROL_RW);
+       /* Clear the interrupts in status register */
+       writel(CDNS_I2C_INTERRUPTS_MASK, &regs->interrupt_status);
 
-       writel(0xFF, &regs->interrupt_status);
        writel(addr, &regs->address);
 
-       while (len--) {
+       while (len-- && !is_arbitration_lost(regs)) {
                writel(*(cur_data++), &regs->data);
-               if (readl(&regs->transfer_size) == CDNS_I2C_FIFO_DEPTH) {
-                       if (!cdns_i2c_wait(regs, CDNS_I2C_INTERRUPT_COMP)) {
-                               /* Release the bus */
-                               clrbits_le32(&regs->control,
-                                            CDNS_I2C_CONTROL_HOLD);
-                               return -ETIMEDOUT;
-                       }
+               if (len && readl(&regs->transfer_size) == CDNS_I2C_FIFO_DEPTH) {
+                       ret = cdns_i2c_wait(regs, CDNS_I2C_INTERRUPT_COMP |
+                                           CDNS_I2C_INTERRUPT_ARBLOST);
+                       if (ret & CDNS_I2C_INTERRUPT_ARBLOST)
+                               return -EAGAIN;
+                       if (ret & CDNS_I2C_INTERRUPT_COMP)
+                               continue;
+                       /* Release the bus */
+                       clrbits_le32(&regs->control,
+                                    CDNS_I2C_CONTROL_HOLD);
+                       return -ETIMEDOUT;
                }
        }
 
+       if (len && is_arbitration_lost(regs))
+               return -EAGAIN;
+
        /* All done... release the bus */
        if (!i2c_bus->hold_flag)
                clrbits_le32(&regs->control, CDNS_I2C_CONTROL_HOLD);
 
        /* Wait for the address and data to be sent */
-       if (!cdns_i2c_wait(regs, CDNS_I2C_INTERRUPT_COMP))
+       ret = cdns_i2c_wait(regs, CDNS_I2C_INTERRUPT_COMP |
+                           CDNS_I2C_INTERRUPT_ARBLOST);
+       if (!(ret & (CDNS_I2C_INTERRUPT_ARBLOST |
+                    CDNS_I2C_INTERRUPT_COMP)))
                return -ETIMEDOUT;
+       if (ret & CDNS_I2C_INTERRUPT_ARBLOST)
+               return -EAGAIN;
+
        return 0;
 }
 
+static inline bool cdns_is_hold_quirk(int hold_quirk, int curr_recv_count)
+{
+       return hold_quirk && (curr_recv_count == CDNS_I2C_FIFO_DEPTH + 1);
+}
+
 static int cdns_i2c_read_data(struct i2c_cdns_bus *i2c_bus, u32 addr, u8 *data,
-                             u32 len)
+                             u32 recv_count)
 {
-       u32 status;
-       u32 i = 0;
        u8 *cur_data = data;
-
-       /* TODO: Fix this */
        struct cdns_i2c_regs *regs = i2c_bus->regs;
+       u32 curr_recv_count;
+       int updatetx, hold_quirk;
+       u32 ret;
 
-       /* Check the hardware can handle the requested bytes */
-       if ((len < 0))
-               return -EINVAL;
+       curr_recv_count = recv_count;
+
+       /* Check for the message size against the FIFO depth */
+       if (recv_count > CDNS_I2C_FIFO_DEPTH)
+               setbits_le32(&regs->control, CDNS_I2C_CONTROL_HOLD);
 
        setbits_le32(&regs->control, CDNS_I2C_CONTROL_CLR_FIFO |
                CDNS_I2C_CONTROL_RW);
 
+       if (recv_count > CDNS_I2C_TRANSFER_SIZE) {
+               curr_recv_count = CDNS_I2C_TRANSFER_SIZE;
+               writel(curr_recv_count, &regs->transfer_size);
+       } else {
+               writel(recv_count, &regs->transfer_size);
+       }
+
        /* Start reading data */
        writel(addr, &regs->address);
-       writel(len, &regs->transfer_size);
 
-       /* Wait for data */
-       do {
-               status = cdns_i2c_wait(regs, CDNS_I2C_INTERRUPT_COMP |
-                       CDNS_I2C_INTERRUPT_DATA);
-               if (!status) {
-                       /* Release the bus */
-                       clrbits_le32(&regs->control, CDNS_I2C_CONTROL_HOLD);
-                       return -ETIMEDOUT;
+       updatetx = recv_count > curr_recv_count;
+
+       hold_quirk = (i2c_bus->quirks & CDNS_I2C_BROKEN_HOLD_BIT) && updatetx;
+
+       while (recv_count && !is_arbitration_lost(regs)) {
+               while (readl(&regs->status) & CDNS_I2C_STATUS_RXDV) {
+                       if (recv_count < CDNS_I2C_FIFO_DEPTH &&
+                           !i2c_bus->hold_flag) {
+                               clrbits_le32(&regs->control,
+                                            CDNS_I2C_CONTROL_HOLD);
+                       }
+                       *(cur_data)++ = readl(&regs->data);
+                       recv_count--;
+                       curr_recv_count--;
+
+                       if (cdns_is_hold_quirk(hold_quirk, curr_recv_count))
+                               break;
                }
-               debug("Read %d bytes\n",
-                     len - readl(&regs->transfer_size));
-               for (; i < len - readl(&regs->transfer_size); i++)
-                       *(cur_data++) = readl(&regs->data);
-       } while (readl(&regs->transfer_size) != 0);
-       /* All done... release the bus */
-       if (!i2c_bus->hold_flag)
-               clrbits_le32(&regs->control, CDNS_I2C_CONTROL_HOLD);
 
-#ifdef DEBUG
-       cdns_i2c_debug_status(regs);
-#endif
+               if (cdns_is_hold_quirk(hold_quirk, curr_recv_count)) {
+                       /* wait while fifo is full */
+                       while (readl(&regs->transfer_size) !=
+                                    (curr_recv_count - CDNS_I2C_FIFO_DEPTH))
+                               ;
+                       /*
+                        * Check number of bytes to be received against maximum
+                        * transfer size and update register accordingly.
+                        */
+                       if ((recv_count - CDNS_I2C_FIFO_DEPTH) >
+                           CDNS_I2C_TRANSFER_SIZE) {
+                               writel(CDNS_I2C_TRANSFER_SIZE,
+                                      &regs->transfer_size);
+                               curr_recv_count = CDNS_I2C_TRANSFER_SIZE +
+                                       CDNS_I2C_FIFO_DEPTH;
+                       } else {
+                               writel(recv_count - CDNS_I2C_FIFO_DEPTH,
+                                      &regs->transfer_size);
+                               curr_recv_count = recv_count;
+                       }
+               } else if (recv_count && !hold_quirk && !curr_recv_count) {
+                       writel(addr, &regs->address);
+                       if (recv_count > CDNS_I2C_TRANSFER_SIZE) {
+                               writel(CDNS_I2C_TRANSFER_SIZE,
+                                      &regs->transfer_size);
+                               curr_recv_count = CDNS_I2C_TRANSFER_SIZE;
+                       } else {
+                               writel(recv_count, &regs->transfer_size);
+                               curr_recv_count = recv_count;
+                       }
+               }
+       }
+
+       /* Wait for the address and data to be sent */
+       ret = cdns_i2c_wait(regs, CDNS_I2C_INTERRUPT_COMP |
+                           CDNS_I2C_INTERRUPT_ARBLOST);
+       if (!(ret & (CDNS_I2C_INTERRUPT_ARBLOST |
+                    CDNS_I2C_INTERRUPT_COMP)))
+               return -ETIMEDOUT;
+       if (ret & CDNS_I2C_INTERRUPT_ARBLOST)
+               return -EAGAIN;
+
        return 0;
 }
 
@@ -329,8 +399,11 @@ static int cdns_i2c_xfer(struct udevice *dev, struct i2c_msg *msg,
                         int nmsgs)
 {
        struct i2c_cdns_bus *i2c_bus = dev_get_priv(dev);
-       int ret, count;
+       int ret = 0;
+       int count;
        bool hold_quirk;
+       struct i2c_msg *message = msg;
+       int num_msgs = nmsgs;
 
        hold_quirk = !!(i2c_bus->quirks & CDNS_I2C_BROKEN_HOLD_BIT);
 
@@ -356,7 +429,8 @@ static int cdns_i2c_xfer(struct udevice *dev, struct i2c_msg *msg,
        }
 
        debug("i2c_xfer: %d messages\n", nmsgs);
-       for (; nmsgs > 0; nmsgs--, msg++) {
+       for (u8 retry = 0; retry < CDNS_I2C_ARB_LOST_MAX_RETRIES &&
+            nmsgs > 0; nmsgs--, msg++) {
                debug("i2c_xfer: chip=0x%x, len=0x%x\n", msg->addr, msg->len);
                if (msg->flags & I2C_M_RD) {
                        ret = cdns_i2c_read_data(i2c_bus, msg->addr, msg->buf,
@@ -365,13 +439,22 @@ static int cdns_i2c_xfer(struct udevice *dev, struct i2c_msg *msg,
                        ret = cdns_i2c_write_data(i2c_bus, msg->addr, msg->buf,
                                                  msg->len);
                }
+               if (ret == -EAGAIN) {
+                       msg = message;
+                       nmsgs = num_msgs;
+                       retry++;
+                       printf("%s,arbitration lost, retrying:%d\n", __func__,
+                              retry);
+                       continue;
+               }
+
                if (ret) {
                        debug("i2c_write: error sending\n");
                        return -EREMOTEIO;
                }
        }
 
-       return 0;
+       return ret;
 }
 
 static int cdns_i2c_ofdata_to_platdata(struct udevice *dev)
@@ -379,22 +462,27 @@ static int cdns_i2c_ofdata_to_platdata(struct udevice *dev)
        struct i2c_cdns_bus *i2c_bus = dev_get_priv(dev);
        struct cdns_i2c_platform_data *pdata =
                (struct cdns_i2c_platform_data *)dev_get_driver_data(dev);
+       struct clk clk;
+       int ret;
 
-       i2c_bus->regs = (struct cdns_i2c_regs *)dev_get_addr(dev);
+       i2c_bus->regs = (struct cdns_i2c_regs *)dev_read_addr(dev);
        if (!i2c_bus->regs)
                return -ENOMEM;
 
        if (pdata)
                i2c_bus->quirks = pdata->quirks;
 
-       i2c_bus->input_freq = 100000000; /* TODO hardcode input freq for now */
+       ret = clk_get_by_index(dev, 0, &clk);
+       if (ret)
+               return ret;
+
+       i2c_bus->input_freq = clk_get_rate(&clk);
 
        return 0;
 }
 
 static const struct dm_i2c_ops cdns_i2c_ops = {
        .xfer = cdns_i2c_xfer,
-       .probe_chip = cdns_i2c_probe_chip,
        .set_bus_speed = cdns_i2c_set_bus_speed,
 };