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