drivers/i2c/mxc_i2c.c

   1 /*
   2  * i2c driver for Freescale i.MX series
   3  *
   4  * (c) 2007 Pengutronix, Sascha Hauer <s.hauer@pengutronix.de>
   5  * (c) 2011 Marek Vasut <marek.vasut@gmail.com>
   6  *
   7  * Based on i2c-imx.c from linux kernel:
   8  *  Copyright (C) 2005 Torsten Koschorrek <koschorrek at synertronixx.de>
   9  *  Copyright (C) 2005 Matthias Blaschke <blaschke at synertronixx.de>
  10  *  Copyright (C) 2007 RightHand Technologies, Inc.
  11  *  Copyright (C) 2008 Darius Augulis <darius.augulis at teltonika.lt>
  12  *
  13  *
  14  * See file CREDITS for list of people who contributed to this
  15  * project.
  16  *
  17  * This program is free software; you can redistribute it and/or
  18  * modify it under the terms of the GNU General Public License as
  19  * published by the Free Software Foundation; either version 2 of
  20  * the License, or (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program; if not, write to the Free Software
  29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  30  * MA 02111-1307 USA
  31  */
  32
  33 #include <common.h>
  34 #include <asm/arch/clock.h>
  35 #include <asm/arch/imx-regs.h>
  36 #include <asm/errno.h>
  37 #include <asm/io.h>
  38 #include <i2c.h>
  39 #include <watchdog.h>
  40
  41 struct mxc_i2c_regs {
  42         uint32_t        iadr;
  43         uint32_t        ifdr;
  44         uint32_t        i2cr;
  45         uint32_t        i2sr;
  46         uint32_t        i2dr;
  47 };
  48
  49 #define I2CR_IEN        (1 << 7)
  50 #define I2CR_IIEN       (1 << 6)
  51 #define I2CR_MSTA       (1 << 5)
  52 #define I2CR_MTX        (1 << 4)
  53 #define I2CR_TX_NO_AK   (1 << 3)
  54 #define I2CR_RSTA       (1 << 2)
  55
  56 #define I2SR_ICF        (1 << 7)
  57 #define I2SR_IBB        (1 << 5)
  58 #define I2SR_IAL        (1 << 4)
  59 #define I2SR_IIF        (1 << 1)
  60 #define I2SR_RX_NO_AK   (1 << 0)
  61
  62 #if defined(CONFIG_HARD_I2C) && !defined(CONFIG_SYS_I2C_BASE)
  63 #error "define CONFIG_SYS_I2C_BASE to use the mxc_i2c driver"
  64 #endif
  65
  66 static u16 i2c_clk_div[50][2] = {
  67         { 22,   0x20 }, { 24,   0x21 }, { 26,   0x22 }, { 28,   0x23 },
  68         { 30,   0x00 }, { 32,   0x24 }, { 36,   0x25 }, { 40,   0x26 },
  69         { 42,   0x03 }, { 44,   0x27 }, { 48,   0x28 }, { 52,   0x05 },
  70         { 56,   0x29 }, { 60,   0x06 }, { 64,   0x2A }, { 72,   0x2B },
  71         { 80,   0x2C }, { 88,   0x09 }, { 96,   0x2D }, { 104,  0x0A },
  72         { 112,  0x2E }, { 128,  0x2F }, { 144,  0x0C }, { 160,  0x30 },
  73         { 192,  0x31 }, { 224,  0x32 }, { 240,  0x0F }, { 256,  0x33 },
  74         { 288,  0x10 }, { 320,  0x34 }, { 384,  0x35 }, { 448,  0x36 },
  75         { 480,  0x13 }, { 512,  0x37 }, { 576,  0x14 }, { 640,  0x38 },
  76         { 768,  0x39 }, { 896,  0x3A }, { 960,  0x17 }, { 1024, 0x3B },
  77         { 1152, 0x18 }, { 1280, 0x3C }, { 1536, 0x3D }, { 1792, 0x3E },
  78         { 1920, 0x1B }, { 2048, 0x3F }, { 2304, 0x1C }, { 2560, 0x1D },
  79         { 3072, 0x1E }, { 3840, 0x1F }
  80 };
  81
  82 /*
  83  * Calculate and set proper clock divider
  84  */
  85 static uint8_t i2c_imx_get_clk(unsigned int rate)
  86 {
  87         unsigned int i2c_clk_rate;
  88         unsigned int div;
  89         u8 clk_div;
  90
  91 #if defined(CONFIG_MX31)
  92         struct clock_control_regs *sc_regs =
  93                 (struct clock_control_regs *)CCM_BASE;
  94
  95         /* start the required I2C clock */
  96         writel(readl(&sc_regs->cgr0) | (3 << CONFIG_SYS_I2C_CLK_OFFSET),
  97                 &sc_regs->cgr0);
  98 #endif
  99
 100         /* Divider value calculation */
 101         i2c_clk_rate = mxc_get_clock(MXC_IPG_PERCLK);
 102         div = (i2c_clk_rate + rate - 1) / rate;
 103         if (div < i2c_clk_div[0][0])
 104                 clk_div = 0;
 105         else if (div > i2c_clk_div[ARRAY_SIZE(i2c_clk_div) - 1][0])
 106                 clk_div = ARRAY_SIZE(i2c_clk_div) - 1;
 107         else
 108                 for (clk_div = 0; i2c_clk_div[clk_div][0] < div; clk_div++)
 109                         ;
 110
 111         /* Store divider value */
 112         return clk_div;
 113 }
 114
 115 /*
 116  * Set I2C Bus speed
 117  */
 118 int bus_i2c_set_bus_speed(void *base, int speed)
 119 {
 120         struct mxc_i2c_regs *i2c_regs = (struct mxc_i2c_regs *)base;
 121         u8 clk_idx = i2c_imx_get_clk(speed);
 122         u8 idx = i2c_clk_div[clk_idx][1];
 123
 124         /* Store divider value */
 125         writeb(idx, &i2c_regs->ifdr);
 126
 127         /* Reset module */
 128         writeb(0, &i2c_regs->i2cr);
 129         writeb(0, &i2c_regs->i2sr);
 130         return 0;
 131 }
 132
 133 /*
 134  * Get I2C Speed
 135  */
 136 unsigned int bus_i2c_get_bus_speed(void *base)
 137 {
 138         struct mxc_i2c_regs *i2c_regs = (struct mxc_i2c_regs *)base;
 139         u8 clk_idx = readb(&i2c_regs->ifdr);
 140         u8 clk_div;
 141
 142         for (clk_div = 0; i2c_clk_div[clk_div][1] != clk_idx; clk_div++)
 143                 ;
 144
 145         return mxc_get_clock(MXC_IPG_PERCLK) / i2c_clk_div[clk_div][0];
 146 }
 147
 148 #define ST_BUS_IDLE (0 | (I2SR_IBB << 8))
 149 #define ST_BUS_BUSY (I2SR_IBB | (I2SR_IBB << 8))
 150 #define ST_IIF (I2SR_IIF | (I2SR_IIF << 8))
 151
 152 static int wait_for_sr_state(struct mxc_i2c_regs *i2c_regs, unsigned state)
 153 {
 154         unsigned sr;
 155         ulong elapsed;
 156         ulong start_time = get_timer(0);
 157         for (;;) {
 158                 sr = readb(&i2c_regs->i2sr);
 159                 if (sr & I2SR_IAL) {
 160                         writeb(sr & ~I2SR_IAL, &i2c_regs->i2sr);
 161                         printf("%s: Arbitration lost sr=%x cr=%x state=%x\n",
 162                                 __func__, sr, readb(&i2c_regs->i2cr), state);
 163                         return -ERESTART;
 164                 }
 165                 if ((sr & (state >> 8)) == (unsigned char)state)
 166                         return sr;
 167                 WATCHDOG_RESET();
 168                 elapsed = get_timer(start_time);
 169                 if (elapsed > (CONFIG_SYS_HZ / 10))     /* .1 seconds */
 170                         break;
 171         }
 172         printf("%s: failed sr=%x cr=%x state=%x\n", __func__,
 173                         sr, readb(&i2c_regs->i2cr), state);
 174         return -ETIMEDOUT;
 175 }
 176
 177 static int tx_byte(struct mxc_i2c_regs *i2c_regs, u8 byte)
 178 {
 179         int ret;
 180
 181         writeb(0, &i2c_regs->i2sr);
 182         writeb(byte, &i2c_regs->i2dr);
 183         ret = wait_for_sr_state(i2c_regs, ST_IIF);
 184         if (ret < 0)
 185                 return ret;
 186         if (ret & I2SR_RX_NO_AK)
 187                 return -ENODEV;
 188         return 0;
 189 }
 190
 191 /*
 192  * Stop I2C transaction
 193  */
 194 static void i2c_imx_stop(struct mxc_i2c_regs *i2c_regs)
 195 {
 196         int ret;
 197         unsigned int temp = readb(&i2c_regs->i2cr);
 198
 199         temp &= ~(I2CR_MSTA | I2CR_MTX);
 200         writeb(temp, &i2c_regs->i2cr);
 201         ret = wait_for_sr_state(i2c_regs, ST_BUS_IDLE);
 202         if (ret < 0)
 203                 printf("%s:trigger stop failed\n", __func__);
 204 }
 205
 206 /*
 207  * Send start signal, chip address and
 208  * write register address
 209  */
 210 static int i2c_init_transfer_(struct mxc_i2c_regs *i2c_regs,
 211                 uchar chip, uint addr, int alen)
 212 {
 213         unsigned int temp;
 214         int ret;
 215
 216         /* Enable I2C controller */
 217         if (!(readb(&i2c_regs->i2cr) & I2CR_IEN)) {
 218                 writeb(I2CR_IEN, &i2c_regs->i2cr);
 219                 /* Wait for controller to be stable */
 220                 udelay(50);
 221         }
 222         if (readb(&i2c_regs->iadr) == (chip << 1))
 223                 writeb((chip << 1) ^ 2, &i2c_regs->iadr);
 224         writeb(0, &i2c_regs->i2sr);
 225         ret = wait_for_sr_state(i2c_regs, ST_BUS_IDLE);
 226         if (ret < 0)
 227                 return ret;
 228
 229         /* Start I2C transaction */
 230         temp = readb(&i2c_regs->i2cr);
 231         temp |= I2CR_MSTA;
 232         writeb(temp, &i2c_regs->i2cr);
 233
 234         ret = wait_for_sr_state(i2c_regs, ST_BUS_BUSY);
 235         if (ret < 0)
 236                 return ret;
 237
 238         temp |= I2CR_MTX | I2CR_TX_NO_AK;
 239         writeb(temp, &i2c_regs->i2cr);
 240
 241         /* write slave address */
 242         ret = tx_byte(i2c_regs, chip << 1);
 243         if (ret < 0)
 244                 return ret;
 245
 246         while (alen--) {
 247                 ret = tx_byte(i2c_regs, (addr >> (alen * 8)) & 0xff);
 248                 if (ret < 0)
 249                         return ret;
 250         }
 251         return 0;
 252 }
 253
 254 static int i2c_init_transfer(struct mxc_i2c_regs *i2c_regs,
 255                 uchar chip, uint addr, int alen)
 256 {
 257         int retry;
 258         int ret;
 259         for (retry = 0; retry < 3; retry++) {
 260                 ret = i2c_init_transfer_(i2c_regs, chip, addr, alen);
 261                 if (ret >= 0)
 262                         return 0;
 263                 i2c_imx_stop(i2c_regs);
 264                 if (ret == -ENODEV)
 265                         return ret;
 266
 267                 printf("%s: failed for chip 0x%x retry=%d\n", __func__, chip,
 268                                 retry);
 269                 if (ret != -ERESTART)
 270                         writeb(0, &i2c_regs->i2cr);     /* Disable controller */
 271                 udelay(100);
 272         }
 273         printf("%s: give up i2c_regs=%p\n", __func__, i2c_regs);
 274         return ret;
 275 }
 276
 277 /*
 278  * Read data from I2C device
 279  */
 280 int bus_i2c_read(void *base, uchar chip, uint addr, int alen, uchar *buf,
 281                 int len)
 282 {
 283         int ret;
 284         unsigned int temp;
 285         int i;
 286         struct mxc_i2c_regs *i2c_regs = (struct mxc_i2c_regs *)base;
 287
 288         ret = i2c_init_transfer(i2c_regs, chip, addr, alen);
 289         if (ret < 0)
 290                 return ret;
 291
 292         temp = readb(&i2c_regs->i2cr);
 293         temp |= I2CR_RSTA;
 294         writeb(temp, &i2c_regs->i2cr);
 295
 296         ret = tx_byte(i2c_regs, (chip << 1) | 1);
 297         if (ret < 0) {
 298                 i2c_imx_stop(i2c_regs);
 299                 return ret;
 300         }
 301
 302         /* setup bus to read data */
 303         temp = readb(&i2c_regs->i2cr);
 304         temp &= ~(I2CR_MTX | I2CR_TX_NO_AK);
 305         if (len == 1)
 306                 temp |= I2CR_TX_NO_AK;
 307         writeb(temp, &i2c_regs->i2cr);
 308         writeb(0, &i2c_regs->i2sr);
 309         readb(&i2c_regs->i2dr);         /* dummy read to clear ICF */
 310
 311         /* read data */
 312         for (i = 0; i < len; i++) {
 313                 ret = wait_for_sr_state(i2c_regs, ST_IIF);
 314                 if (ret < 0) {
 315                         i2c_imx_stop(i2c_regs);
 316                         return ret;
 317                 }
 318
 319                 /*
 320                  * It must generate STOP before read I2DR to prevent
 321                  * controller from generating another clock cycle
 322                  */
 323                 if (i == (len - 1)) {
 324                         i2c_imx_stop(i2c_regs);
 325                 } else if (i == (len - 2)) {
 326                         temp = readb(&i2c_regs->i2cr);
 327                         temp |= I2CR_TX_NO_AK;
 328                         writeb(temp, &i2c_regs->i2cr);
 329                 }
 330                 writeb(0, &i2c_regs->i2sr);
 331                 buf[i] = readb(&i2c_regs->i2dr);
 332         }
 333         i2c_imx_stop(i2c_regs);
 334         return 0;
 335 }
 336
 337 /*
 338  * Write data to I2C device
 339  */
 340 int bus_i2c_write(void *base, uchar chip, uint addr, int alen,
 341                 const uchar *buf, int len)
 342 {
 343         int ret;
 344         int i;
 345         struct mxc_i2c_regs *i2c_regs = (struct mxc_i2c_regs *)base;
 346
 347         ret = i2c_init_transfer(i2c_regs, chip, addr, alen);
 348         if (ret < 0)
 349                 return ret;
 350
 351         for (i = 0; i < len; i++) {
 352                 ret = tx_byte(i2c_regs, buf[i]);
 353                 if (ret < 0)
 354                         break;
 355         }
 356         i2c_imx_stop(i2c_regs);
 357         return ret;
 358 }
 359
 360 struct i2c_parms {
 361         void *base;
 362         void *idle_bus_data;
 363         int (*idle_bus_fn)(void *p);
 364 };
 365
 366 struct sram_data {
 367         unsigned curr_i2c_bus;
 368         struct i2c_parms i2c_data[3];
 369 };
 370
 371 /*
 372  * For SPL boot some boards need i2c before SDRAM is initialized so force
 373  * variables to live in SRAM
 374  */
 375 static struct sram_data __attribute__((section(".data"))) srdata;
 376
 377 void *get_base(void)
 378 {
 379 #ifdef CONFIG_SYS_I2C_BASE
 380 #ifdef CONFIG_I2C_MULTI_BUS
 381         void *ret = srdata.i2c_data[srdata.curr_i2c_bus].base;
 382         if (ret)
 383                 return ret;
 384 #endif
 385         return (void *)CONFIG_SYS_I2C_BASE;
 386 #elif defined(CONFIG_I2C_MULTI_BUS)
 387         return srdata.i2c_data[srdata.curr_i2c_bus].base;
 388 #else
 389         return srdata.i2c_data[0].base;
 390 #endif
 391 }
 392
 393 int i2c_read(uchar chip, uint addr, int alen, uchar *buf, int len)
 394 {
 395         return bus_i2c_read(get_base(), chip, addr, alen, buf, len);
 396 }
 397
 398 int i2c_write(uchar chip, uint addr, int alen, uchar *buf, int len)
 399 {
 400         return bus_i2c_write(get_base(), chip, addr, alen, buf, len);
 401 }
 402
 403 /*
 404  * Test if a chip at a given address responds (probe the chip)
 405  */
 406 int i2c_probe(uchar chip)
 407 {
 408         return bus_i2c_write(get_base(), chip, 0, 0, NULL, 0);
 409 }
 410
 411 void bus_i2c_init(void *base, int speed, int unused,
 412                 int (*idle_bus_fn)(void *p), void *idle_bus_data)
 413 {
 414         int i = 0;
 415         struct i2c_parms *p = srdata.i2c_data;
 416         if (!base)
 417                 return;
 418         for (;;) {
 419                 if (!p->base || (p->base == base)) {
 420                         p->base = base;
 421                         if (idle_bus_fn) {
 422                                 p->idle_bus_fn = idle_bus_fn;
 423                                 p->idle_bus_data = idle_bus_data;
 424                         }
 425                         break;
 426                 }
 427                 p++;
 428                 i++;
 429                 if (i >= ARRAY_SIZE(srdata.i2c_data))
 430                         return;
 431         }
 432         bus_i2c_set_bus_speed(base, speed);
 433 }
 434
 435 /*
 436  * Init I2C Bus
 437  */
 438 void i2c_init(int speed, int unused)
 439 {
 440         bus_i2c_init(get_base(), speed, unused, NULL, NULL);
 441 }
 442
 443 /*
 444  * Set I2C Speed
 445  */
 446 int i2c_set_bus_speed(unsigned int speed)
 447 {
 448         return bus_i2c_set_bus_speed(get_base(), speed);
 449 }
 450
 451 /*
 452  * Get I2C Speed
 453  */
 454 unsigned int i2c_get_bus_speed(void)
 455 {
 456         return bus_i2c_get_bus_speed(get_base());
 457 }