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_IIF        (1 << 1)
  59 #define I2SR_RX_NO_AK   (1 << 0)
  60
  61 #ifdef CONFIG_SYS_I2C_BASE
  62 #define I2C_BASE        CONFIG_SYS_I2C_BASE
  63 #else
  64 #error "define CONFIG_SYS_I2C_BASE to use the mxc_i2c driver"
  65 #endif
  66
  67 static u16 i2c_clk_div[50][2] = {
  68         { 22,   0x20 }, { 24,   0x21 }, { 26,   0x22 }, { 28,   0x23 },
  69         { 30,   0x00 }, { 32,   0x24 }, { 36,   0x25 }, { 40,   0x26 },
  70         { 42,   0x03 }, { 44,   0x27 }, { 48,   0x28 }, { 52,   0x05 },
  71         { 56,   0x29 }, { 60,   0x06 }, { 64,   0x2A }, { 72,   0x2B },
  72         { 80,   0x2C }, { 88,   0x09 }, { 96,   0x2D }, { 104,  0x0A },
  73         { 112,  0x2E }, { 128,  0x2F }, { 144,  0x0C }, { 160,  0x30 },
  74         { 192,  0x31 }, { 224,  0x32 }, { 240,  0x0F }, { 256,  0x33 },
  75         { 288,  0x10 }, { 320,  0x34 }, { 384,  0x35 }, { 448,  0x36 },
  76         { 480,  0x13 }, { 512,  0x37 }, { 576,  0x14 }, { 640,  0x38 },
  77         { 768,  0x39 }, { 896,  0x3A }, { 960,  0x17 }, { 1024, 0x3B },
  78         { 1152, 0x18 }, { 1280, 0x3C }, { 1536, 0x3D }, { 1792, 0x3E },
  79         { 1920, 0x1B }, { 2048, 0x3F }, { 2304, 0x1C }, { 2560, 0x1D },
  80         { 3072, 0x1E }, { 3840, 0x1F }
  81 };
  82
  83 /*
  84  * Calculate and set proper clock divider
  85  */
  86 static uint8_t i2c_imx_get_clk(unsigned int rate)
  87 {
  88         unsigned int i2c_clk_rate;
  89         unsigned int div;
  90         u8 clk_div;
  91
  92 #if defined(CONFIG_MX31)
  93         struct clock_control_regs *sc_regs =
  94                 (struct clock_control_regs *)CCM_BASE;
  95
  96         /* start the required I2C clock */
  97         writel(readl(&sc_regs->cgr0) | (3 << CONFIG_SYS_I2C_CLK_OFFSET),
  98                 &sc_regs->cgr0);
  99 #endif
 100
 101         /* Divider value calculation */
 102         i2c_clk_rate = mxc_get_clock(MXC_IPG_PERCLK);
 103         div = (i2c_clk_rate + rate - 1) / rate;
 104         if (div < i2c_clk_div[0][0])
 105                 clk_div = 0;
 106         else if (div > i2c_clk_div[ARRAY_SIZE(i2c_clk_div) - 1][0])
 107                 clk_div = ARRAY_SIZE(i2c_clk_div) - 1;
 108         else
 109                 for (clk_div = 0; i2c_clk_div[clk_div][0] < div; clk_div++)
 110                         ;
 111
 112         /* Store divider value */
 113         return clk_div;
 114 }
 115
 116 /*
 117  * Reset I2C Controller
 118  */
 119 void i2c_reset(void)
 120 {
 121         struct mxc_i2c_regs *i2c_regs = (struct mxc_i2c_regs *)I2C_BASE;
 122
 123         writeb(0, &i2c_regs->i2cr);     /* Reset module */
 124         writeb(0, &i2c_regs->i2sr);
 125 }
 126
 127 /*
 128  * Init I2C Bus
 129  */
 130 void i2c_init(int speed, int unused)
 131 {
 132         struct mxc_i2c_regs *i2c_regs = (struct mxc_i2c_regs *)I2C_BASE;
 133         u8 clk_idx = i2c_imx_get_clk(speed);
 134         u8 idx = i2c_clk_div[clk_idx][1];
 135
 136         /* Store divider value */
 137         writeb(idx, &i2c_regs->ifdr);
 138
 139         i2c_reset();
 140 }
 141
 142 /*
 143  * Set I2C Speed
 144  */
 145 int i2c_set_bus_speed(unsigned int speed)
 146 {
 147         i2c_init(speed, 0);
 148         return 0;
 149 }
 150
 151 /*
 152  * Get I2C Speed
 153  */
 154 unsigned int i2c_get_bus_speed(void)
 155 {
 156         struct mxc_i2c_regs *i2c_regs = (struct mxc_i2c_regs *)I2C_BASE;
 157         u8 clk_idx = readb(&i2c_regs->ifdr);
 158         u8 clk_div;
 159
 160         for (clk_div = 0; i2c_clk_div[clk_div][1] != clk_idx; clk_div++)
 161                 ;
 162
 163         return mxc_get_clock(MXC_IPG_PERCLK) / i2c_clk_div[clk_div][0];
 164 }
 165
 166 #define ST_BUS_IDLE (0 | (I2SR_IBB << 8))
 167 #define ST_BUS_BUSY (I2SR_IBB | (I2SR_IBB << 8))
 168 #define ST_IIF (I2SR_IIF | (I2SR_IIF << 8))
 169
 170 static int wait_for_sr_state(struct mxc_i2c_regs *i2c_regs, unsigned state)
 171 {
 172         unsigned sr;
 173         ulong elapsed;
 174         ulong start_time = get_timer(0);
 175         for (;;) {
 176                 sr = readb(&i2c_regs->i2sr);
 177                 if ((sr & (state >> 8)) == (unsigned char)state)
 178                         return sr;
 179                 WATCHDOG_RESET();
 180                 elapsed = get_timer(start_time);
 181                 if (elapsed > (CONFIG_SYS_HZ / 10))     /* .1 seconds */
 182                         break;
 183         }
 184         printf("%s: failed sr=%x cr=%x state=%x\n", __func__,
 185                         sr, readb(&i2c_regs->i2cr), state);
 186         return -ETIMEDOUT;
 187 }
 188
 189 static int tx_byte(struct mxc_i2c_regs *i2c_regs, u8 byte)
 190 {
 191         int ret;
 192
 193         writeb(0, &i2c_regs->i2sr);
 194         writeb(byte, &i2c_regs->i2dr);
 195         ret = wait_for_sr_state(i2c_regs, ST_IIF);
 196         if (ret < 0)
 197                 return ret;
 198         if (ret & I2SR_RX_NO_AK)
 199                 return -ENODEV;
 200         return 0;
 201 }
 202
 203 /*
 204  * Start the controller
 205  */
 206 int i2c_imx_start(void)
 207 {
 208         struct mxc_i2c_regs *i2c_regs = (struct mxc_i2c_regs *)I2C_BASE;
 209         unsigned int temp = 0;
 210         int result;
 211
 212         /* Enable I2C controller */
 213         writeb(0, &i2c_regs->i2sr);
 214         writeb(I2CR_IEN, &i2c_regs->i2cr);
 215
 216         /* Wait controller to be stable */
 217         udelay(50);
 218
 219         /* Start I2C transaction */
 220         temp = readb(&i2c_regs->i2cr);
 221         temp |= I2CR_MSTA;
 222         writeb(temp, &i2c_regs->i2cr);
 223
 224         result = wait_for_sr_state(i2c_regs, ST_BUS_BUSY);
 225         if (result < 0)
 226                 return result;
 227
 228         temp |= I2CR_MTX | I2CR_TX_NO_AK;
 229         writeb(temp, &i2c_regs->i2cr);
 230
 231         return 0;
 232 }
 233
 234 /*
 235  * Stop the controller
 236  */
 237 void i2c_imx_stop(void)
 238 {
 239         int ret;
 240         struct mxc_i2c_regs *i2c_regs = (struct mxc_i2c_regs *)I2C_BASE;
 241         unsigned int temp = 0;
 242
 243         /* Stop I2C transaction */
 244         temp = readb(&i2c_regs->i2cr);
 245         temp &= ~(I2CR_MSTA | I2CR_MTX);
 246         writeb(temp, &i2c_regs->i2cr);
 247
 248         ret = wait_for_sr_state(i2c_regs, ST_BUS_IDLE);
 249         if (ret < 0)
 250                 printf("%s:trigger stop failed\n", __func__);
 251         /* Disable I2C controller */
 252         writeb(0, &i2c_regs->i2cr);
 253 }
 254
 255 /*
 256  * Send start signal, chip address and
 257  * write register address
 258  */
 259 static int i2c_init_transfer(struct mxc_i2c_regs *i2c_regs,
 260                 uchar chip, uint addr, int alen)
 261 {
 262         int ret = i2c_imx_start();
 263         if (ret)
 264                 goto exit;
 265
 266         /* write slave address */
 267         ret = tx_byte(i2c_regs, chip << 1);
 268         if (ret < 0)
 269                 goto exit;
 270
 271         while (alen--) {
 272                 ret = tx_byte(i2c_regs, (addr >> (alen * 8)) & 0xff);
 273                 if (ret < 0)
 274                         goto exit;
 275         }
 276         return 0;
 277 exit:
 278         i2c_imx_stop();
 279         return ret;
 280 }
 281
 282 /*
 283  * Read data from I2C device
 284  */
 285 int i2c_read(uchar chip, uint addr, int alen, uchar *buf, int len)
 286 {
 287         struct mxc_i2c_regs *i2c_regs = (struct mxc_i2c_regs *)I2C_BASE;
 288         int ret;
 289         unsigned int temp;
 290         int i;
 291
 292         ret = i2c_init_transfer(i2c_regs, chip, addr, alen);
 293         if (ret < 0)
 294                 return ret;
 295
 296         temp = readb(&i2c_regs->i2cr);
 297         temp |= I2CR_RSTA;
 298         writeb(temp, &i2c_regs->i2cr);
 299
 300         ret = tx_byte(i2c_regs, (chip << 1) | 1);
 301         if (ret < 0) {
 302                 i2c_imx_stop();
 303                 return ret;
 304         }
 305
 306         /* setup bus to read data */
 307         temp = readb(&i2c_regs->i2cr);
 308         temp &= ~(I2CR_MTX | I2CR_TX_NO_AK);
 309         if (len == 1)
 310                 temp |= I2CR_TX_NO_AK;
 311         writeb(temp, &i2c_regs->i2cr);
 312         writeb(0, &i2c_regs->i2sr);
 313         readb(&i2c_regs->i2dr);         /* dummy read to clear ICF */
 314
 315         /* read data */
 316         for (i = 0; i < len; i++) {
 317                 ret = wait_for_sr_state(i2c_regs, ST_IIF);
 318                 if (ret < 0) {
 319                         i2c_imx_stop();
 320                         return ret;
 321                 }
 322
 323                 /*
 324                  * It must generate STOP before read I2DR to prevent
 325                  * controller from generating another clock cycle
 326                  */
 327                 if (i == (len - 1)) {
 328                         temp = readb(&i2c_regs->i2cr);
 329                         temp &= ~(I2CR_MSTA | I2CR_MTX);
 330                         writeb(temp, &i2c_regs->i2cr);
 331                         wait_for_sr_state(i2c_regs, ST_BUS_IDLE);
 332                 } else if (i == (len - 2)) {
 333                         temp = readb(&i2c_regs->i2cr);
 334                         temp |= I2CR_TX_NO_AK;
 335                         writeb(temp, &i2c_regs->i2cr);
 336                 }
 337                 writeb(0, &i2c_regs->i2sr);
 338                 buf[i] = readb(&i2c_regs->i2dr);
 339         }
 340
 341         i2c_imx_stop();
 342
 343         return 0;
 344 }
 345
 346 /*
 347  * Write data to I2C device
 348  */
 349 int i2c_write(uchar chip, uint addr, int alen, uchar *buf, int len)
 350 {
 351         struct mxc_i2c_regs *i2c_regs = (struct mxc_i2c_regs *)I2C_BASE;
 352         int ret;
 353         int i;
 354
 355         ret = i2c_init_transfer(i2c_regs, chip, addr, alen);
 356         if (ret < 0)
 357                 return ret;
 358
 359         for (i = 0; i < len; i++) {
 360                 ret = tx_byte(i2c_regs, buf[i]);
 361                 if (ret < 0)
 362                         break;
 363         }
 364
 365         i2c_imx_stop();
 366
 367         return ret;
 368 }
 369
 370 /*
 371  * Test if a chip at a given address responds (probe the chip)
 372  */
 373 int i2c_probe(uchar chip)
 374 {
 375         return i2c_write(chip, 0, 0, NULL, 0);
 376 }