drivers/i2c/mxc_i2c.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * i2c driver for Freescale i.MX series
   4  *
   5  * (c) 2007 Pengutronix, Sascha Hauer <s.hauer@pengutronix.de>
   6  * (c) 2011 Marek Vasut <marek.vasut@gmail.com>
   7  *
   8  * Based on i2c-imx.c from linux kernel:
   9  *  Copyright (C) 2005 Torsten Koschorrek <koschorrek at synertronixx.de>
  10  *  Copyright (C) 2005 Matthias Blaschke <blaschke at synertronixx.de>
  11  *  Copyright (C) 2007 RightHand Technologies, Inc.
  12  *  Copyright (C) 2008 Darius Augulis <darius.augulis at teltonika.lt>
  13  *
  14  */
  15
  16 #include <common.h>
  17 #include <asm/arch/clock.h>
  18 #include <asm/arch/imx-regs.h>
  19 #include <dm/device_compat.h>
  20 #include <linux/errno.h>
  21 #include <asm/mach-imx/mxc_i2c.h>
  22 #include <asm/mach-imx/sys_proto.h>
  23 #include <asm/io.h>
  24 #include <i2c.h>
  25 #include <watchdog.h>
  26 #include <dm.h>
  27 #include <dm/pinctrl.h>
  28 #include <fdtdec.h>
  29
  30 DECLARE_GLOBAL_DATA_PTR;
  31
  32 #define I2C_QUIRK_FLAG          (1 << 0)
  33
  34 #define IMX_I2C_REGSHIFT        2
  35 #define VF610_I2C_REGSHIFT      0
  36
  37 #define I2C_EARLY_INIT_INDEX            0
  38 #ifdef CONFIG_SYS_I2C_IFDR_DIV
  39 #define I2C_IFDR_DIV_CONSERVATIVE       CONFIG_SYS_I2C_IFDR_DIV
  40 #else
  41 #define I2C_IFDR_DIV_CONSERVATIVE       0x7e
  42 #endif
  43
  44 /* Register index */
  45 #define IADR    0
  46 #define IFDR    1
  47 #define I2CR    2
  48 #define I2SR    3
  49 #define I2DR    4
  50
  51 #define I2CR_IIEN       (1 << 6)
  52 #define I2CR_MSTA       (1 << 5)
  53 #define I2CR_MTX        (1 << 4)
  54 #define I2CR_TX_NO_AK   (1 << 3)
  55 #define I2CR_RSTA       (1 << 2)
  56
  57 #define I2SR_ICF        (1 << 7)
  58 #define I2SR_IBB        (1 << 5)
  59 #define I2SR_IAL        (1 << 4)
  60 #define I2SR_IIF        (1 << 1)
  61 #define I2SR_RX_NO_AK   (1 << 0)
  62
  63 #ifdef I2C_QUIRK_REG
  64 #define I2CR_IEN        (0 << 7)
  65 #define I2CR_IDIS       (1 << 7)
  66 #define I2SR_IIF_CLEAR  (1 << 1)
  67 #else
  68 #define I2CR_IEN        (1 << 7)
  69 #define I2CR_IDIS       (0 << 7)
  70 #define I2SR_IIF_CLEAR  (0 << 1)
  71 #endif
  72
  73 #ifdef I2C_QUIRK_REG
  74 static u16 i2c_clk_div[60][2] = {
  75         { 20,   0x00 }, { 22,   0x01 }, { 24,   0x02 }, { 26,   0x03 },
  76         { 28,   0x04 }, { 30,   0x05 }, { 32,   0x09 }, { 34,   0x06 },
  77         { 36,   0x0A }, { 40,   0x07 }, { 44,   0x0C }, { 48,   0x0D },
  78         { 52,   0x43 }, { 56,   0x0E }, { 60,   0x45 }, { 64,   0x12 },
  79         { 68,   0x0F }, { 72,   0x13 }, { 80,   0x14 }, { 88,   0x15 },
  80         { 96,   0x19 }, { 104,  0x16 }, { 112,  0x1A }, { 128,  0x17 },
  81         { 136,  0x4F }, { 144,  0x1C }, { 160,  0x1D }, { 176,  0x55 },
  82         { 192,  0x1E }, { 208,  0x56 }, { 224,  0x22 }, { 228,  0x24 },
  83         { 240,  0x1F }, { 256,  0x23 }, { 288,  0x5C }, { 320,  0x25 },
  84         { 384,  0x26 }, { 448,  0x2A }, { 480,  0x27 }, { 512,  0x2B },
  85         { 576,  0x2C }, { 640,  0x2D }, { 768,  0x31 }, { 896,  0x32 },
  86         { 960,  0x2F }, { 1024, 0x33 }, { 1152, 0x34 }, { 1280, 0x35 },
  87         { 1536, 0x36 }, { 1792, 0x3A }, { 1920, 0x37 }, { 2048, 0x3B },
  88         { 2304, 0x3C }, { 2560, 0x3D }, { 3072, 0x3E }, { 3584, 0x7A },
  89         { 3840, 0x3F }, { 4096, 0x7B }, { 5120, 0x7D }, { 6144, 0x7E },
  90 };
  91 #else
  92 static u16 i2c_clk_div[50][2] = {
  93         { 22,   0x20 }, { 24,   0x21 }, { 26,   0x22 }, { 28,   0x23 },
  94         { 30,   0x00 }, { 32,   0x24 }, { 36,   0x25 }, { 40,   0x26 },
  95         { 42,   0x03 }, { 44,   0x27 }, { 48,   0x28 }, { 52,   0x05 },
  96         { 56,   0x29 }, { 60,   0x06 }, { 64,   0x2A }, { 72,   0x2B },
  97         { 80,   0x2C }, { 88,   0x09 }, { 96,   0x2D }, { 104,  0x0A },
  98         { 112,  0x2E }, { 128,  0x2F }, { 144,  0x0C }, { 160,  0x30 },
  99         { 192,  0x31 }, { 224,  0x32 }, { 240,  0x0F }, { 256,  0x33 },
 100         { 288,  0x10 }, { 320,  0x34 }, { 384,  0x35 }, { 448,  0x36 },
 101         { 480,  0x13 }, { 512,  0x37 }, { 576,  0x14 }, { 640,  0x38 },
 102         { 768,  0x39 }, { 896,  0x3A }, { 960,  0x17 }, { 1024, 0x3B },
 103         { 1152, 0x18 }, { 1280, 0x3C }, { 1536, 0x3D }, { 1792, 0x3E },
 104         { 1920, 0x1B }, { 2048, 0x3F }, { 2304, 0x1C }, { 2560, 0x1D },
 105         { 3072, 0x1E }, { 3840, 0x1F }
 106 };
 107 #endif
 108
 109 #ifndef CONFIG_SYS_MXC_I2C1_SPEED
 110 #define CONFIG_SYS_MXC_I2C1_SPEED 100000
 111 #endif
 112 #ifndef CONFIG_SYS_MXC_I2C2_SPEED
 113 #define CONFIG_SYS_MXC_I2C2_SPEED 100000
 114 #endif
 115 #ifndef CONFIG_SYS_MXC_I2C3_SPEED
 116 #define CONFIG_SYS_MXC_I2C3_SPEED 100000
 117 #endif
 118 #ifndef CONFIG_SYS_MXC_I2C4_SPEED
 119 #define CONFIG_SYS_MXC_I2C4_SPEED 100000
 120 #endif
 121
 122 #ifndef CONFIG_SYS_MXC_I2C1_SLAVE
 123 #define CONFIG_SYS_MXC_I2C1_SLAVE 0
 124 #endif
 125 #ifndef CONFIG_SYS_MXC_I2C2_SLAVE
 126 #define CONFIG_SYS_MXC_I2C2_SLAVE 0
 127 #endif
 128 #ifndef CONFIG_SYS_MXC_I2C3_SLAVE
 129 #define CONFIG_SYS_MXC_I2C3_SLAVE 0
 130 #endif
 131 #ifndef CONFIG_SYS_MXC_I2C4_SLAVE
 132 #define CONFIG_SYS_MXC_I2C4_SLAVE 0
 133 #endif
 134
 135 /*
 136  * Calculate and set proper clock divider
 137  */
 138 static uint8_t i2c_imx_get_clk(struct mxc_i2c_bus *i2c_bus, unsigned int rate)
 139 {
 140         unsigned int i2c_clk_rate;
 141         unsigned int div;
 142         u8 clk_div;
 143
 144 #if defined(CONFIG_MX31)
 145         struct clock_control_regs *sc_regs =
 146                 (struct clock_control_regs *)CCM_BASE;
 147
 148         /* start the required I2C clock */
 149         writel(readl(&sc_regs->cgr0) | (3 << CONFIG_SYS_I2C_CLK_OFFSET),
 150                 &sc_regs->cgr0);
 151 #endif
 152
 153         /* Divider value calculation */
 154 #if CONFIG_IS_ENABLED(CLK)
 155         i2c_clk_rate = clk_get_rate(&i2c_bus->per_clk);
 156 #else
 157         i2c_clk_rate = mxc_get_clock(MXC_I2C_CLK);
 158 #endif
 159
 160         div = (i2c_clk_rate + rate - 1) / rate;
 161         if (div < i2c_clk_div[0][0])
 162                 clk_div = 0;
 163         else if (div > i2c_clk_div[ARRAY_SIZE(i2c_clk_div) - 1][0])
 164                 clk_div = ARRAY_SIZE(i2c_clk_div) - 1;
 165         else
 166                 for (clk_div = 0; i2c_clk_div[clk_div][0] < div; clk_div++)
 167                         ;
 168
 169         /* Store divider value */
 170         return clk_div;
 171 }
 172
 173 /*
 174  * Set I2C Bus speed
 175  */
 176 static int bus_i2c_set_bus_speed(struct mxc_i2c_bus *i2c_bus, int speed)
 177 {
 178         ulong base = i2c_bus->base;
 179         bool quirk = i2c_bus->driver_data & I2C_QUIRK_FLAG ? true : false;
 180         u8 clk_idx = i2c_imx_get_clk(i2c_bus, speed);
 181         u8 idx = i2c_clk_div[clk_idx][1];
 182         int reg_shift = quirk ? VF610_I2C_REGSHIFT : IMX_I2C_REGSHIFT;
 183
 184         if (!base)
 185                 return -EINVAL;
 186
 187         /* Store divider value */
 188         writeb(idx, base + (IFDR << reg_shift));
 189
 190         /* Reset module */
 191         writeb(I2CR_IDIS, base + (I2CR << reg_shift));
 192         writeb(0, base + (I2SR << reg_shift));
 193         return 0;
 194 }
 195
 196 #define ST_BUS_IDLE (0 | (I2SR_IBB << 8))
 197 #define ST_BUS_BUSY (I2SR_IBB | (I2SR_IBB << 8))
 198 #define ST_IIF (I2SR_IIF | (I2SR_IIF << 8))
 199
 200 static int wait_for_sr_state(struct mxc_i2c_bus *i2c_bus, unsigned state)
 201 {
 202         unsigned sr;
 203         ulong elapsed;
 204         bool quirk = i2c_bus->driver_data & I2C_QUIRK_FLAG ? true : false;
 205         int reg_shift = quirk ? VF610_I2C_REGSHIFT : IMX_I2C_REGSHIFT;
 206         ulong base = i2c_bus->base;
 207         ulong start_time = get_timer(0);
 208         for (;;) {
 209                 sr = readb(base + (I2SR << reg_shift));
 210                 if (sr & I2SR_IAL) {
 211                         if (quirk)
 212                                 writeb(sr | I2SR_IAL, base +
 213                                        (I2SR << reg_shift));
 214                         else
 215                                 writeb(sr & ~I2SR_IAL, base +
 216                                        (I2SR << reg_shift));
 217                         printf("%s: Arbitration lost sr=%x cr=%x state=%x\n",
 218                                 __func__, sr, readb(base + (I2CR << reg_shift)),
 219                                 state);
 220                         return -ERESTART;
 221                 }
 222                 if ((sr & (state >> 8)) == (unsigned char)state)
 223                         return sr;
 224                 WATCHDOG_RESET();
 225                 elapsed = get_timer(start_time);
 226                 if (elapsed > (CONFIG_SYS_HZ / 10))     /* .1 seconds */
 227                         break;
 228         }
 229         printf("%s: failed sr=%x cr=%x state=%x\n", __func__,
 230                sr, readb(base + (I2CR << reg_shift)), state);
 231         return -ETIMEDOUT;
 232 }
 233
 234 static int tx_byte(struct mxc_i2c_bus *i2c_bus, u8 byte)
 235 {
 236         int ret;
 237         int reg_shift = i2c_bus->driver_data & I2C_QUIRK_FLAG ?
 238                         VF610_I2C_REGSHIFT : IMX_I2C_REGSHIFT;
 239         ulong base = i2c_bus->base;
 240
 241         writeb(I2SR_IIF_CLEAR, base + (I2SR << reg_shift));
 242         writeb(byte, base + (I2DR << reg_shift));
 243
 244         ret = wait_for_sr_state(i2c_bus, ST_IIF);
 245         if (ret < 0)
 246                 return ret;
 247         if (ret & I2SR_RX_NO_AK)
 248                 return -EREMOTEIO;
 249         return 0;
 250 }
 251
 252 /*
 253  * Stub implementations for outer i2c slave operations.
 254  */
 255 void __i2c_force_reset_slave(void)
 256 {
 257 }
 258 void i2c_force_reset_slave(void)
 259         __attribute__((weak, alias("__i2c_force_reset_slave")));
 260
 261 /*
 262  * Stop I2C transaction
 263  */
 264 static void i2c_imx_stop(struct mxc_i2c_bus *i2c_bus)
 265 {
 266         int ret;
 267         int reg_shift = i2c_bus->driver_data & I2C_QUIRK_FLAG ?
 268                         VF610_I2C_REGSHIFT : IMX_I2C_REGSHIFT;
 269         ulong base = i2c_bus->base;
 270         unsigned int temp = readb(base + (I2CR << reg_shift));
 271
 272         temp &= ~(I2CR_MSTA | I2CR_MTX);
 273         writeb(temp, base + (I2CR << reg_shift));
 274         ret = wait_for_sr_state(i2c_bus, ST_BUS_IDLE);
 275         if (ret < 0)
 276                 printf("%s:trigger stop failed\n", __func__);
 277 }
 278
 279 /*
 280  * Send start signal, chip address and
 281  * write register address
 282  */
 283 static int i2c_init_transfer_(struct mxc_i2c_bus *i2c_bus, u8 chip,
 284                               u32 addr, int alen)
 285 {
 286         unsigned int temp;
 287         int ret;
 288         bool quirk = i2c_bus->driver_data & I2C_QUIRK_FLAG ? true : false;
 289         ulong base = i2c_bus->base;
 290         int reg_shift = quirk ? VF610_I2C_REGSHIFT : IMX_I2C_REGSHIFT;
 291
 292         /* Reset i2c slave */
 293         i2c_force_reset_slave();
 294
 295         /* Enable I2C controller */
 296         if (quirk)
 297                 ret = readb(base + (I2CR << reg_shift)) & I2CR_IDIS;
 298         else
 299                 ret = !(readb(base + (I2CR << reg_shift)) & I2CR_IEN);
 300
 301         if (ret) {
 302                 writeb(I2CR_IEN, base + (I2CR << reg_shift));
 303                 /* Wait for controller to be stable */
 304                 udelay(50);
 305         }
 306
 307         if (readb(base + (IADR << reg_shift)) == (chip << 1))
 308                 writeb((chip << 1) ^ 2, base + (IADR << reg_shift));
 309         writeb(I2SR_IIF_CLEAR, base + (I2SR << reg_shift));
 310         ret = wait_for_sr_state(i2c_bus, ST_BUS_IDLE);
 311         if (ret < 0)
 312                 return ret;
 313
 314         /* Start I2C transaction */
 315         temp = readb(base + (I2CR << reg_shift));
 316         temp |= I2CR_MSTA;
 317         writeb(temp, base + (I2CR << reg_shift));
 318
 319         ret = wait_for_sr_state(i2c_bus, ST_BUS_BUSY);
 320         if (ret < 0)
 321                 return ret;
 322
 323         temp |= I2CR_MTX | I2CR_TX_NO_AK;
 324         writeb(temp, base + (I2CR << reg_shift));
 325
 326         if (alen >= 0)  {
 327                 /* write slave address */
 328                 ret = tx_byte(i2c_bus, chip << 1);
 329                 if (ret < 0)
 330                         return ret;
 331
 332                 while (alen--) {
 333                         ret = tx_byte(i2c_bus, (addr >> (alen * 8)) & 0xff);
 334                         if (ret < 0)
 335                                 return ret;
 336                 }
 337         }
 338
 339         return 0;
 340 }
 341
 342 #ifndef CONFIG_DM_I2C
 343 int i2c_idle_bus(struct mxc_i2c_bus *i2c_bus)
 344 {
 345         if (i2c_bus && i2c_bus->idle_bus_fn)
 346                 return i2c_bus->idle_bus_fn(i2c_bus->idle_bus_data);
 347         return 0;
 348 }
 349 #else
 350 /*
 351  * See Linux Documentation/devicetree/bindings/i2c/i2c-imx.txt
 352  * "
 353  *  scl-gpios: specify the gpio related to SCL pin
 354  *  sda-gpios: specify the gpio related to SDA pin
 355  *  add pinctrl to configure i2c pins to gpio function for i2c
 356  *  bus recovery, call it "gpio" state
 357  * "
 358  *
 359  * The i2c_idle_bus is an implementation following Linux Kernel.
 360  */
 361 int i2c_idle_bus(struct mxc_i2c_bus *i2c_bus)
 362 {
 363         struct udevice *bus = i2c_bus->bus;
 364         struct dm_i2c_bus *i2c = dev_get_uclass_priv(bus);
 365         struct gpio_desc *scl_gpio = &i2c_bus->scl_gpio;
 366         struct gpio_desc *sda_gpio = &i2c_bus->sda_gpio;
 367         int sda, scl, idle_sclks;
 368         int i, ret = 0;
 369         ulong elapsed, start_time;
 370
 371         if (pinctrl_select_state(bus, "gpio")) {
 372                 dev_dbg(bus, "Can not to switch to use gpio pinmux\n");
 373                 /*
 374                  * GPIO pinctrl for i2c force idle is not a must,
 375                  * but it is strongly recommended to be used.
 376                  * Because it can help you to recover from bad
 377                  * i2c bus state. Do not return failure, because
 378                  * it is not a must.
 379                  */
 380                 return 0;
 381         }
 382
 383         dm_gpio_set_dir_flags(scl_gpio, GPIOD_IS_IN);
 384         dm_gpio_set_dir_flags(sda_gpio, GPIOD_IS_IN);
 385         scl = dm_gpio_get_value(scl_gpio);
 386         sda = dm_gpio_get_value(sda_gpio);
 387
 388         if ((sda & scl) == 1)
 389                 goto exit;              /* Bus is idle already */
 390
 391         /*
 392          * In most cases it is just enough to generate 8 + 1 SCLK
 393          * clocks to recover I2C slave device from 'stuck' state
 394          * (when for example SW reset was performed, in the middle of
 395          * I2C transmission).
 396          *
 397          * However, there are devices which send data in packets of
 398          * N bytes (N > 1). In such case we do need N * 8 + 1 SCLK
 399          * clocks.
 400          */
 401         idle_sclks = 8 + 1;
 402
 403         if (i2c->max_transaction_bytes > 0)
 404                 idle_sclks = i2c->max_transaction_bytes * 8 + 1;
 405         /* Send high and low on the SCL line */
 406         for (i = 0; i < idle_sclks; i++) {
 407                 dm_gpio_set_dir_flags(scl_gpio, GPIOD_IS_OUT);
 408                 dm_gpio_set_value(scl_gpio, 0);
 409                 udelay(50);
 410                 dm_gpio_set_dir_flags(scl_gpio, GPIOD_IS_IN);
 411                 udelay(50);
 412         }
 413         start_time = get_timer(0);
 414         for (;;) {
 415                 dm_gpio_set_dir_flags(scl_gpio, GPIOD_IS_IN);
 416                 dm_gpio_set_dir_flags(sda_gpio, GPIOD_IS_IN);
 417                 scl = dm_gpio_get_value(scl_gpio);
 418                 sda = dm_gpio_get_value(sda_gpio);
 419                 if ((sda & scl) == 1)
 420                         break;
 421                 WATCHDOG_RESET();
 422                 elapsed = get_timer(start_time);
 423                 if (elapsed > (CONFIG_SYS_HZ / 5)) {    /* .2 seconds */
 424                         ret = -EBUSY;
 425                         printf("%s: failed to clear bus, sda=%d scl=%d\n", __func__, sda, scl);
 426                         break;
 427                 }
 428         }
 429
 430 exit:
 431         pinctrl_select_state(bus, "default");
 432         return ret;
 433 }
 434 #endif
 435
 436 static int i2c_init_transfer(struct mxc_i2c_bus *i2c_bus, u8 chip,
 437                              u32 addr, int alen)
 438 {
 439         int retry;
 440         int ret;
 441         int reg_shift = i2c_bus->driver_data & I2C_QUIRK_FLAG ?
 442                         VF610_I2C_REGSHIFT : IMX_I2C_REGSHIFT;
 443
 444         if (!i2c_bus->base)
 445                 return -EINVAL;
 446
 447         for (retry = 0; retry < 3; retry++) {
 448                 ret = i2c_init_transfer_(i2c_bus, chip, addr, alen);
 449                 if (ret >= 0)
 450                         return 0;
 451                 i2c_imx_stop(i2c_bus);
 452                 if (ret == -EREMOTEIO)
 453                         return ret;
 454
 455                 printf("%s: failed for chip 0x%x retry=%d\n", __func__, chip,
 456                                 retry);
 457                 if (ret != -ERESTART)
 458                         /* Disable controller */
 459                         writeb(I2CR_IDIS, i2c_bus->base + (I2CR << reg_shift));
 460                 udelay(100);
 461                 if (i2c_idle_bus(i2c_bus) < 0)
 462                         break;
 463         }
 464         printf("%s: give up i2c_regs=0x%lx\n", __func__, i2c_bus->base);
 465         return ret;
 466 }
 467
 468
 469 static int i2c_write_data(struct mxc_i2c_bus *i2c_bus, u8 chip, const u8 *buf,
 470                           int len)
 471 {
 472         int i, ret = 0;
 473
 474         debug("i2c_write_data: chip=0x%x, len=0x%x\n", chip, len);
 475         debug("write_data: ");
 476         /* use rc for counter */
 477         for (i = 0; i < len; ++i)
 478                 debug(" 0x%02x", buf[i]);
 479         debug("\n");
 480
 481         for (i = 0; i < len; i++) {
 482                 ret = tx_byte(i2c_bus, buf[i]);
 483                 if (ret < 0) {
 484                         debug("i2c_write_data(): rc=%d\n", ret);
 485                         break;
 486                 }
 487         }
 488
 489         return ret;
 490 }
 491
 492 /* Will generate a STOP after the last byte if "last" is true, i.e. this is the
 493  * final message of a transaction.  If not, it switches the bus back to TX mode
 494  * and does not send a STOP, leaving the bus in a state where a repeated start
 495  * and address can be sent for another message.
 496  */
 497 static int i2c_read_data(struct mxc_i2c_bus *i2c_bus, uchar chip, uchar *buf,
 498                          int len, bool last)
 499 {
 500         int ret;
 501         unsigned int temp;
 502         int i;
 503         int reg_shift = i2c_bus->driver_data & I2C_QUIRK_FLAG ?
 504                         VF610_I2C_REGSHIFT : IMX_I2C_REGSHIFT;
 505         ulong base = i2c_bus->base;
 506
 507         debug("i2c_read_data: chip=0x%x, len=0x%x\n", chip, len);
 508
 509         /* setup bus to read data */
 510         temp = readb(base + (I2CR << reg_shift));
 511         temp &= ~(I2CR_MTX | I2CR_TX_NO_AK);
 512         if (len == 1)
 513                 temp |= I2CR_TX_NO_AK;
 514         writeb(temp, base + (I2CR << reg_shift));
 515         writeb(I2SR_IIF_CLEAR, base + (I2SR << reg_shift));
 516         /* dummy read to clear ICF */
 517         readb(base + (I2DR << reg_shift));
 518
 519         /* read data */
 520         for (i = 0; i < len; i++) {
 521                 ret = wait_for_sr_state(i2c_bus, ST_IIF);
 522                 if (ret < 0) {
 523                         debug("i2c_read_data(): ret=%d\n", ret);
 524                         i2c_imx_stop(i2c_bus);
 525                         return ret;
 526                 }
 527
 528                 if (i == (len - 1)) {
 529                         /* Final byte has already been received by master!  When
 530                          * we read it from I2DR, the master will start another
 531                          * cycle.  We must program it first to send a STOP or
 532                          * switch to TX to avoid this.
 533                          */
 534                         if (last) {
 535                                 i2c_imx_stop(i2c_bus);
 536                         } else {
 537                                 /* Final read, no stop, switch back to tx */
 538                                 temp = readb(base + (I2CR << reg_shift));
 539                                 temp |= I2CR_MTX | I2CR_TX_NO_AK;
 540                                 writeb(temp, base + (I2CR << reg_shift));
 541                         }
 542                 } else if (i == (len - 2)) {
 543                         /* Master has already recevied penultimate byte.  When
 544                          * we read it from I2DR, master will start RX of final
 545                          * byte.  We must set TX_NO_AK now so it does not ACK
 546                          * that final byte.
 547                          */
 548                         temp = readb(base + (I2CR << reg_shift));
 549                         temp |= I2CR_TX_NO_AK;
 550                         writeb(temp, base + (I2CR << reg_shift));
 551                 }
 552
 553                 writeb(I2SR_IIF_CLEAR, base + (I2SR << reg_shift));
 554                 buf[i] = readb(base + (I2DR << reg_shift));
 555         }
 556
 557         /* reuse ret for counter*/
 558         for (ret = 0; ret < len; ++ret)
 559                 debug(" 0x%02x", buf[ret]);
 560         debug("\n");
 561
 562         /* It is not clear to me that this is necessary */
 563         if (last)
 564                 i2c_imx_stop(i2c_bus);
 565         return 0;
 566 }
 567
 568 int __enable_i2c_clk(unsigned char enable, unsigned int i2c_num)
 569 {
 570         return 1;
 571 }
 572
 573 int enable_i2c_clk(unsigned char enable, unsigned int i2c_num)
 574         __attribute__((weak, alias("__enable_i2c_clk")));
 575
 576 #ifndef CONFIG_DM_I2C
 577 /*
 578  * Read data from I2C device
 579  *
 580  * The transactions use the syntax defined in the Linux kernel I2C docs.
 581  *
 582  * If alen is > 0, then this function will send a transaction of the form:
 583  *     S Chip Wr [A] Addr [A] S Chip Rd [A] [data] A ... NA P
 584  * This is a normal I2C register read: writing the register address, then doing
 585  * a repeated start and reading the data.
 586  *
 587  * If alen == 0, then we get this transaction:
 588  *     S Chip Wr [A] S Chip Rd [A] [data] A ... NA P
 589  * This is somewhat unusual, though valid, transaction.  It addresses the chip
 590  * in write mode, but doesn't actually write any register address or data, then
 591  * does a repeated start and reads data.
 592  *
 593  * If alen < 0, then we get this transaction:
 594  *     S Chip Rd [A] [data] A ... NA P
 595  * The chip is addressed in read mode and then data is read.  No register
 596  * address is written first.  This is perfectly valid on most devices and
 597  * required on some (usually those that don't act like an array of registers).
 598  */
 599 static int bus_i2c_read(struct mxc_i2c_bus *i2c_bus, u8 chip, u32 addr,
 600                         int alen, u8 *buf, int len)
 601 {
 602         int ret = 0;
 603         u32 temp;
 604         int reg_shift = i2c_bus->driver_data & I2C_QUIRK_FLAG ?
 605                 VF610_I2C_REGSHIFT : IMX_I2C_REGSHIFT;
 606         ulong base = i2c_bus->base;
 607
 608         ret = i2c_init_transfer(i2c_bus, chip, addr, alen);
 609         if (ret < 0)
 610                 return ret;
 611
 612         if (alen >= 0) {
 613                 temp = readb(base + (I2CR << reg_shift));
 614                 temp |= I2CR_RSTA;
 615                 writeb(temp, base + (I2CR << reg_shift));
 616         }
 617
 618         ret = tx_byte(i2c_bus, (chip << 1) | 1);
 619         if (ret < 0) {
 620                 i2c_imx_stop(i2c_bus);
 621                 return ret;
 622         }
 623
 624         ret = i2c_read_data(i2c_bus, chip, buf, len, true);
 625
 626         i2c_imx_stop(i2c_bus);
 627         return ret;
 628 }
 629
 630 /*
 631  * Write data to I2C device
 632  *
 633  * If alen > 0, we get this transaction:
 634  *    S Chip Wr [A] addr [A] data [A] ... [A] P
 635  * An ordinary write register command.
 636  *
 637  * If alen == 0, then we get this:
 638  *    S Chip Wr [A] data [A] ... [A] P
 639  * This is a simple I2C write.
 640  *
 641  * If alen < 0, then we get this:
 642  *    S data [A] ... [A] P
 643  * This is most likely NOT something that should be used.  It doesn't send the
 644  * chip address first, so in effect, the first byte of data will be used as the
 645  * address.
 646  */
 647 static int bus_i2c_write(struct mxc_i2c_bus *i2c_bus, u8 chip, u32 addr,
 648                          int alen, const u8 *buf, int len)
 649 {
 650         int ret = 0;
 651
 652         ret = i2c_init_transfer(i2c_bus, chip, addr, alen);
 653         if (ret < 0)
 654                 return ret;
 655
 656         ret = i2c_write_data(i2c_bus, chip, buf, len);
 657
 658         i2c_imx_stop(i2c_bus);
 659
 660         return ret;
 661 }
 662
 663 #if !defined(I2C2_BASE_ADDR)
 664 #define I2C2_BASE_ADDR  0
 665 #endif
 666
 667 #if !defined(I2C3_BASE_ADDR)
 668 #define I2C3_BASE_ADDR  0
 669 #endif
 670
 671 #if !defined(I2C4_BASE_ADDR)
 672 #define I2C4_BASE_ADDR  0
 673 #endif
 674
 675 #if !defined(I2C5_BASE_ADDR)
 676 #define I2C5_BASE_ADDR 0
 677 #endif
 678
 679 #if !defined(I2C6_BASE_ADDR)
 680 #define I2C6_BASE_ADDR 0
 681 #endif
 682
 683 #if !defined(I2C7_BASE_ADDR)
 684 #define I2C7_BASE_ADDR 0
 685 #endif
 686
 687 #if !defined(I2C8_BASE_ADDR)
 688 #define I2C8_BASE_ADDR 0
 689 #endif
 690
 691 static struct mxc_i2c_bus mxc_i2c_buses[] = {
 692 #if defined(CONFIG_ARCH_LS1021A) || defined(CONFIG_VF610) || \
 693         defined(CONFIG_FSL_LAYERSCAPE)
 694         { 0, I2C1_BASE_ADDR, I2C_QUIRK_FLAG },
 695         { 1, I2C2_BASE_ADDR, I2C_QUIRK_FLAG },
 696         { 2, I2C3_BASE_ADDR, I2C_QUIRK_FLAG },
 697         { 3, I2C4_BASE_ADDR, I2C_QUIRK_FLAG },
 698         { 4, I2C5_BASE_ADDR, I2C_QUIRK_FLAG },
 699         { 5, I2C6_BASE_ADDR, I2C_QUIRK_FLAG },
 700         { 6, I2C7_BASE_ADDR, I2C_QUIRK_FLAG },
 701         { 7, I2C8_BASE_ADDR, I2C_QUIRK_FLAG },
 702 #else
 703         { 0, I2C1_BASE_ADDR, 0 },
 704         { 1, I2C2_BASE_ADDR, 0 },
 705         { 2, I2C3_BASE_ADDR, 0 },
 706         { 3, I2C4_BASE_ADDR, 0 },
 707         { 4, I2C5_BASE_ADDR, 0 },
 708         { 5, I2C6_BASE_ADDR, 0 },
 709         { 6, I2C7_BASE_ADDR, 0 },
 710         { 7, I2C8_BASE_ADDR, 0 },
 711 #endif
 712 };
 713
 714 struct mxc_i2c_bus *i2c_get_base(struct i2c_adapter *adap)
 715 {
 716         return &mxc_i2c_buses[adap->hwadapnr];
 717 }
 718
 719 static int mxc_i2c_read(struct i2c_adapter *adap, uint8_t chip,
 720                                 uint addr, int alen, uint8_t *buffer,
 721                                 int len)
 722 {
 723         return bus_i2c_read(i2c_get_base(adap), chip, addr, alen, buffer, len);
 724 }
 725
 726 static int mxc_i2c_write(struct i2c_adapter *adap, uint8_t chip,
 727                                 uint addr, int alen, uint8_t *buffer,
 728                                 int len)
 729 {
 730         return bus_i2c_write(i2c_get_base(adap), chip, addr, alen, buffer, len);
 731 }
 732
 733 /*
 734  * Test if a chip at a given address responds (probe the chip)
 735  */
 736 static int mxc_i2c_probe(struct i2c_adapter *adap, uint8_t chip)
 737 {
 738         return bus_i2c_write(i2c_get_base(adap), chip, 0, 0, NULL, 0);
 739 }
 740
 741 void bus_i2c_init(int index, int speed, int unused,
 742                   int (*idle_bus_fn)(void *p), void *idle_bus_data)
 743 {
 744         int ret;
 745
 746         if (index >= ARRAY_SIZE(mxc_i2c_buses)) {
 747                 debug("Error i2c index\n");
 748                 return;
 749         }
 750
 751         if (CONFIG_IS_ENABLED(IMX_MODULE_FUSE)) {
 752                 if (i2c_fused((ulong)mxc_i2c_buses[index].base)) {
 753                         printf("SoC fuse indicates I2C@0x%lx is unavailable.\n",
 754                                (ulong)mxc_i2c_buses[index].base);
 755                         return;
 756                 }
 757         }
 758
 759         /*
 760          * Warning: Be careful to allow the assignment to a static
 761          * variable here. This function could be called while U-Boot is
 762          * still running in flash memory. So such assignment is equal
 763          * to write data to flash without erasing.
 764          */
 765         if (idle_bus_fn)
 766                 mxc_i2c_buses[index].idle_bus_fn = idle_bus_fn;
 767         if (idle_bus_data)
 768                 mxc_i2c_buses[index].idle_bus_data = idle_bus_data;
 769
 770         ret = enable_i2c_clk(1, index);
 771         if (ret < 0) {
 772                 debug("I2C-%d clk fail to enable.\n", index);
 773                 return;
 774         }
 775
 776         bus_i2c_set_bus_speed(&mxc_i2c_buses[index], speed);
 777 }
 778
 779 /*
 780  * Early init I2C for prepare read the clk through I2C.
 781  */
 782 void i2c_early_init_f(void)
 783 {
 784         ulong base = mxc_i2c_buses[I2C_EARLY_INIT_INDEX].base;
 785         bool quirk = mxc_i2c_buses[I2C_EARLY_INIT_INDEX].driver_data
 786                                         & I2C_QUIRK_FLAG ? true : false;
 787         int reg_shift = quirk ? VF610_I2C_REGSHIFT : IMX_I2C_REGSHIFT;
 788
 789         /* Set I2C divider value */
 790         writeb(I2C_IFDR_DIV_CONSERVATIVE, base + (IFDR << reg_shift));
 791         /* Reset module */
 792         writeb(I2CR_IDIS, base + (I2CR << reg_shift));
 793         writeb(0, base + (I2SR << reg_shift));
 794         /* Enable I2C */
 795         writeb(I2CR_IEN, base + (I2CR << reg_shift));
 796 }
 797
 798 /*
 799  * Init I2C Bus
 800  */
 801 static void mxc_i2c_init(struct i2c_adapter *adap, int speed, int slaveaddr)
 802 {
 803         bus_i2c_init(adap->hwadapnr, speed, slaveaddr, NULL, NULL);
 804 }
 805
 806 /*
 807  * Set I2C Speed
 808  */
 809 static u32 mxc_i2c_set_bus_speed(struct i2c_adapter *adap, uint speed)
 810 {
 811         return bus_i2c_set_bus_speed(i2c_get_base(adap), speed);
 812 }
 813
 814 /*
 815  * Register mxc i2c adapters
 816  */
 817 #ifdef CONFIG_SYS_I2C_MXC_I2C1
 818 U_BOOT_I2C_ADAP_COMPLETE(mxc0, mxc_i2c_init, mxc_i2c_probe,
 819                          mxc_i2c_read, mxc_i2c_write,
 820                          mxc_i2c_set_bus_speed,
 821                          CONFIG_SYS_MXC_I2C1_SPEED,
 822                          CONFIG_SYS_MXC_I2C1_SLAVE, 0)
 823 #endif
 824
 825 #ifdef CONFIG_SYS_I2C_MXC_I2C2
 826 U_BOOT_I2C_ADAP_COMPLETE(mxc1, mxc_i2c_init, mxc_i2c_probe,
 827                          mxc_i2c_read, mxc_i2c_write,
 828                          mxc_i2c_set_bus_speed,
 829                          CONFIG_SYS_MXC_I2C2_SPEED,
 830                          CONFIG_SYS_MXC_I2C2_SLAVE, 1)
 831 #endif
 832
 833 #ifdef CONFIG_SYS_I2C_MXC_I2C3
 834 U_BOOT_I2C_ADAP_COMPLETE(mxc2, mxc_i2c_init, mxc_i2c_probe,
 835                          mxc_i2c_read, mxc_i2c_write,
 836                          mxc_i2c_set_bus_speed,
 837                          CONFIG_SYS_MXC_I2C3_SPEED,
 838                          CONFIG_SYS_MXC_I2C3_SLAVE, 2)
 839 #endif
 840
 841 #ifdef CONFIG_SYS_I2C_MXC_I2C4
 842 U_BOOT_I2C_ADAP_COMPLETE(mxc3, mxc_i2c_init, mxc_i2c_probe,
 843                          mxc_i2c_read, mxc_i2c_write,
 844                          mxc_i2c_set_bus_speed,
 845                          CONFIG_SYS_MXC_I2C4_SPEED,
 846                          CONFIG_SYS_MXC_I2C4_SLAVE, 3)
 847 #endif
 848
 849 #ifdef CONFIG_SYS_I2C_MXC_I2C5
 850 U_BOOT_I2C_ADAP_COMPLETE(mxc4, mxc_i2c_init, mxc_i2c_probe,
 851                          mxc_i2c_read, mxc_i2c_write,
 852                          mxc_i2c_set_bus_speed,
 853                          CONFIG_SYS_MXC_I2C5_SPEED,
 854                          CONFIG_SYS_MXC_I2C5_SLAVE, 4)
 855 #endif
 856
 857 #ifdef CONFIG_SYS_I2C_MXC_I2C6
 858 U_BOOT_I2C_ADAP_COMPLETE(mxc5, mxc_i2c_init, mxc_i2c_probe,
 859                          mxc_i2c_read, mxc_i2c_write,
 860                          mxc_i2c_set_bus_speed,
 861                          CONFIG_SYS_MXC_I2C6_SPEED,
 862                          CONFIG_SYS_MXC_I2C6_SLAVE, 5)
 863 #endif
 864
 865 #ifdef CONFIG_SYS_I2C_MXC_I2C7
 866 U_BOOT_I2C_ADAP_COMPLETE(mxc6, mxc_i2c_init, mxc_i2c_probe,
 867                          mxc_i2c_read, mxc_i2c_write,
 868                          mxc_i2c_set_bus_speed,
 869                          CONFIG_SYS_MXC_I2C7_SPEED,
 870                          CONFIG_SYS_MXC_I2C7_SLAVE, 6)
 871 #endif
 872
 873 #ifdef CONFIG_SYS_I2C_MXC_I2C8
 874 U_BOOT_I2C_ADAP_COMPLETE(mxc7, mxc_i2c_init, mxc_i2c_probe,
 875                          mxc_i2c_read, mxc_i2c_write,
 876                          mxc_i2c_set_bus_speed,
 877                          CONFIG_SYS_MXC_I2C8_SPEED,
 878                          CONFIG_SYS_MXC_I2C8_SLAVE, 7)
 879 #endif
 880
 881 #else
 882
 883 static int mxc_i2c_set_bus_speed(struct udevice *bus, unsigned int speed)
 884 {
 885         struct mxc_i2c_bus *i2c_bus = dev_get_priv(bus);
 886
 887         return bus_i2c_set_bus_speed(i2c_bus, speed);
 888 }
 889
 890 static int mxc_i2c_probe(struct udevice *bus)
 891 {
 892         struct mxc_i2c_bus *i2c_bus = dev_get_priv(bus);
 893         const void *fdt = gd->fdt_blob;
 894         int node = dev_of_offset(bus);
 895         fdt_addr_t addr;
 896         int ret, ret2;
 897
 898         i2c_bus->driver_data = dev_get_driver_data(bus);
 899
 900         addr = devfdt_get_addr(bus);
 901         if (addr == FDT_ADDR_T_NONE)
 902                 return -EINVAL;
 903
 904         if (CONFIG_IS_ENABLED(IMX_MODULE_FUSE)) {
 905                 if (i2c_fused((ulong)addr)) {
 906                         printf("SoC fuse indicates I2C@0x%lx is unavailable.\n",
 907                                (ulong)addr);
 908                         return -ENODEV;
 909                 }
 910         }
 911
 912         i2c_bus->base = addr;
 913         i2c_bus->index = bus->seq;
 914         i2c_bus->bus = bus;
 915
 916         /* Enable clk */
 917 #if CONFIG_IS_ENABLED(CLK)
 918         ret = clk_get_by_index(bus, 0, &i2c_bus->per_clk);
 919         if (ret) {
 920                 printf("Failed to get i2c clk\n");
 921                 return ret;
 922         }
 923         ret = clk_enable(&i2c_bus->per_clk);
 924         if (ret) {
 925                 printf("Failed to enable i2c clk\n");
 926                 return ret;
 927         }
 928 #else
 929         ret = enable_i2c_clk(1, bus->seq);
 930         if (ret < 0)
 931                 return ret;
 932 #endif
 933
 934         /*
 935          * See Documentation/devicetree/bindings/i2c/i2c-imx.txt
 936          * Use gpio to force bus idle when necessary.
 937          */
 938         ret = fdt_stringlist_search(fdt, node, "pinctrl-names", "gpio");
 939         if (ret < 0) {
 940                 debug("i2c bus %d at 0x%2lx, no gpio pinctrl state.\n", bus->seq, i2c_bus->base);
 941         } else {
 942                 ret = gpio_request_by_name_nodev(offset_to_ofnode(node),
 943                                 "scl-gpios", 0, &i2c_bus->scl_gpio,
 944                                 GPIOD_IS_OUT);
 945                 ret2 = gpio_request_by_name_nodev(offset_to_ofnode(node),
 946                                 "sda-gpios", 0, &i2c_bus->sda_gpio,
 947                                 GPIOD_IS_OUT);
 948                 if (!dm_gpio_is_valid(&i2c_bus->sda_gpio) ||
 949                     !dm_gpio_is_valid(&i2c_bus->scl_gpio) ||
 950                     ret || ret2) {
 951                         dev_err(dev, "i2c bus %d at %lu, fail to request scl/sda gpio\n", bus->seq, i2c_bus->base);
 952                         return -EINVAL;
 953                 }
 954         }
 955
 956         /*
 957          * Pinmux settings are in board file now, until pinmux is supported,
 958          * we can set pinmux here in probe function.
 959          */
 960
 961         debug("i2c : controller bus %d at %lu , speed %d: ",
 962               bus->seq, i2c_bus->base,
 963               i2c_bus->speed);
 964
 965         return 0;
 966 }
 967
 968 /* Sends: S Addr Wr [A|NA] P */
 969 static int mxc_i2c_probe_chip(struct udevice *bus, u32 chip_addr,
 970                               u32 chip_flags)
 971 {
 972         int ret;
 973         struct mxc_i2c_bus *i2c_bus = dev_get_priv(bus);
 974
 975         ret = i2c_init_transfer(i2c_bus, chip_addr, 0, 0);
 976         if (ret < 0) {
 977                 debug("%s failed, ret = %d\n", __func__, ret);
 978                 return ret;
 979         }
 980
 981         i2c_imx_stop(i2c_bus);
 982
 983         return 0;
 984 }
 985
 986 static int mxc_i2c_xfer(struct udevice *bus, struct i2c_msg *msg, int nmsgs)
 987 {
 988         struct mxc_i2c_bus *i2c_bus = dev_get_priv(bus);
 989         int ret = 0;
 990         ulong base = i2c_bus->base;
 991         int reg_shift = i2c_bus->driver_data & I2C_QUIRK_FLAG ?
 992                 VF610_I2C_REGSHIFT : IMX_I2C_REGSHIFT;
 993         int read_mode;
 994
 995         /* Here address len is set to -1 to not send any address at first.
 996          * Otherwise i2c_init_transfer will send the chip address with write
 997          * mode set.  This is wrong if the 1st message is read.
 998          */
 999         ret = i2c_init_transfer(i2c_bus, msg->addr, 0, -1);
1000         if (ret < 0) {
1001                 debug("i2c_init_transfer error: %d\n", ret);
1002                 return ret;
1003         }
1004
1005         read_mode = -1; /* So it's always different on the first message */
1006         for (; nmsgs > 0; nmsgs--, msg++) {
1007                 const int msg_is_read = !!(msg->flags & I2C_M_RD);
1008
1009                 debug("i2c_xfer: chip=0x%x, len=0x%x, dir=%c\n", msg->addr,
1010                       msg->len, msg_is_read ? 'R' : 'W');
1011
1012                 if (msg_is_read != read_mode) {
1013                         /* Send repeated start if not 1st message */
1014                         if (read_mode != -1) {
1015                                 debug("i2c_xfer: [RSTART]\n");
1016                                 ret = readb(base + (I2CR << reg_shift));
1017                                 ret |= I2CR_RSTA;
1018                                 writeb(ret, base + (I2CR << reg_shift));
1019                         }
1020                         debug("i2c_xfer: [ADDR %02x | %c]\n", msg->addr,
1021                               msg_is_read ? 'R' : 'W');
1022                         ret = tx_byte(i2c_bus, (msg->addr << 1) | msg_is_read);
1023                         if (ret < 0) {
1024                                 debug("i2c_xfer: [STOP]\n");
1025                                 i2c_imx_stop(i2c_bus);
1026                                 break;
1027                         }
1028                         read_mode = msg_is_read;
1029                 }
1030
1031                 if (msg->flags & I2C_M_RD)
1032                         ret = i2c_read_data(i2c_bus, msg->addr, msg->buf,
1033                                             msg->len, nmsgs == 1 ||
1034                                                       (msg->flags & I2C_M_STOP));
1035                 else
1036                         ret = i2c_write_data(i2c_bus, msg->addr, msg->buf,
1037                                              msg->len);
1038
1039                 if (ret < 0)
1040                         break;
1041         }
1042
1043         if (ret)
1044                 debug("i2c_write: error sending\n");
1045
1046         i2c_imx_stop(i2c_bus);
1047
1048         return ret;
1049 }
1050
1051 static const struct dm_i2c_ops mxc_i2c_ops = {
1052         .xfer           = mxc_i2c_xfer,
1053         .probe_chip     = mxc_i2c_probe_chip,
1054         .set_bus_speed  = mxc_i2c_set_bus_speed,
1055 };
1056
1057 static const struct udevice_id mxc_i2c_ids[] = {
1058         { .compatible = "fsl,imx21-i2c", },
1059         { .compatible = "fsl,vf610-i2c", .data = I2C_QUIRK_FLAG, },
1060         {}
1061 };
1062
1063 U_BOOT_DRIVER(i2c_mxc) = {
1064         .name = "i2c_mxc",
1065         .id = UCLASS_I2C,
1066         .of_match = mxc_i2c_ids,
1067         .probe = mxc_i2c_probe,
1068         .priv_auto_alloc_size = sizeof(struct mxc_i2c_bus),
1069         .ops = &mxc_i2c_ops,
1070         .flags = DM_FLAG_PRE_RELOC,
1071 };
1072 #endif