drivers/i2c/s3c24x0_i2c.c

   1 /*
   2  * (C) Copyright 2002
   3  * David Mueller, ELSOFT AG, d.mueller@elsoft.ch
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 /* This code should work for both the S3C2400 and the S3C2410
   9  * as they seem to have the same I2C controller inside.
  10  * The different address mapping is handled by the s3c24xx.h files below.
  11  */
  12
  13 #include <common.h>
  14 #include <fdtdec.h>
  15 #if (defined CONFIG_EXYNOS4 || defined CONFIG_EXYNOS5)
  16 #include <asm/arch/clk.h>
  17 #include <asm/arch/cpu.h>
  18 #include <asm/arch/pinmux.h>
  19 #else
  20 #include <asm/arch/s3c24x0_cpu.h>
  21 #endif
  22 #include <asm/io.h>
  23 #include <i2c.h>
  24 #include "s3c24x0_i2c.h"
  25
  26 #ifdef CONFIG_HARD_I2C
  27
  28 #define I2C_WRITE       0
  29 #define I2C_READ        1
  30
  31 #define I2C_OK          0
  32 #define I2C_NOK         1
  33 #define I2C_NACK        2
  34 #define I2C_NOK_LA      3       /* Lost arbitration */
  35 #define I2C_NOK_TOUT    4       /* time out */
  36
  37 #define I2CSTAT_BSY     0x20    /* Busy bit */
  38 #define I2CSTAT_NACK    0x01    /* Nack bit */
  39 #define I2CCON_ACKGEN   0x80    /* Acknowledge generation */
  40 #define I2CCON_IRPND    0x10    /* Interrupt pending bit */
  41 #define I2C_MODE_MT     0xC0    /* Master Transmit Mode */
  42 #define I2C_MODE_MR     0x80    /* Master Receive Mode */
  43 #define I2C_START_STOP  0x20    /* START / STOP */
  44 #define I2C_TXRX_ENA    0x10    /* I2C Tx/Rx enable */
  45
  46 #define I2C_TIMEOUT_MS 1000             /* 1 second */
  47
  48
  49 /*
  50  * For SPL boot some boards need i2c before SDRAM is initialised so force
  51  * variables to live in SRAM
  52  */
  53 static unsigned int g_current_bus __attribute__((section(".data")));
  54 #ifdef CONFIG_OF_CONTROL
  55 static struct s3c24x0_i2c_bus i2c_bus[CONFIG_MAX_I2C_NUM]
  56                         __attribute__((section(".data")));
  57 #endif
  58
  59 #if !(defined CONFIG_EXYNOS4 || defined CONFIG_EXYNOS5)
  60 static int GetI2CSDA(void)
  61 {
  62         struct s3c24x0_gpio *gpio = s3c24x0_get_base_gpio();
  63
  64 #ifdef CONFIG_S3C2410
  65         return (readl(&gpio->gpedat) & 0x8000) >> 15;
  66 #endif
  67 #ifdef CONFIG_S3C2400
  68         return (readl(&gpio->pgdat) & 0x0020) >> 5;
  69 #endif
  70 }
  71
  72 static void SetI2CSCL(int x)
  73 {
  74         struct s3c24x0_gpio *gpio = s3c24x0_get_base_gpio();
  75
  76 #ifdef CONFIG_S3C2410
  77         writel((readl(&gpio->gpedat) & ~0x4000) |
  78                                         (x & 1) << 14, &gpio->gpedat);
  79 #endif
  80 #ifdef CONFIG_S3C2400
  81         writel((readl(&gpio->pgdat) & ~0x0040) | (x & 1) << 6, &gpio->pgdat);
  82 #endif
  83 }
  84 #endif
  85
  86 /*
  87  * Wait til the byte transfer is completed.
  88  *
  89  * @param i2c- pointer to the appropriate i2c register bank.
  90  * @return I2C_OK, if transmission was ACKED
  91  *         I2C_NACK, if transmission was NACKED
  92  *         I2C_NOK_TIMEOUT, if transaction did not complete in I2C_TIMEOUT_MS
  93  */
  94
  95 static int WaitForXfer(struct s3c24x0_i2c *i2c)
  96 {
  97         ulong start_time = get_timer(0);
  98
  99         do {
 100                 if (readl(&i2c->iiccon) & I2CCON_IRPND)
 101                         return (readl(&i2c->iicstat) & I2CSTAT_NACK) ?
 102                                 I2C_NACK : I2C_OK;
 103         } while (get_timer(start_time) < I2C_TIMEOUT_MS);
 104
 105         return I2C_NOK_TOUT;
 106 }
 107
 108 static void ReadWriteByte(struct s3c24x0_i2c *i2c)
 109 {
 110         writel(readl(&i2c->iiccon) & ~I2CCON_IRPND, &i2c->iiccon);
 111 }
 112
 113 static struct s3c24x0_i2c *get_base_i2c(void)
 114 {
 115 #ifdef CONFIG_EXYNOS4
 116         struct s3c24x0_i2c *i2c = (struct s3c24x0_i2c *)(samsung_get_base_i2c()
 117                                                         + (EXYNOS4_I2C_SPACING
 118                                                         * g_current_bus));
 119         return i2c;
 120 #elif defined CONFIG_EXYNOS5
 121         struct s3c24x0_i2c *i2c = (struct s3c24x0_i2c *)(samsung_get_base_i2c()
 122                                                         + (EXYNOS5_I2C_SPACING
 123                                                         * g_current_bus));
 124         return i2c;
 125 #else
 126         return s3c24x0_get_base_i2c();
 127 #endif
 128 }
 129
 130 static void i2c_ch_init(struct s3c24x0_i2c *i2c, int speed, int slaveadd)
 131 {
 132         ulong freq, pres = 16, div;
 133 #if (defined CONFIG_EXYNOS4 || defined CONFIG_EXYNOS5)
 134         freq = get_i2c_clk();
 135 #else
 136         freq = get_PCLK();
 137 #endif
 138         /* calculate prescaler and divisor values */
 139         if ((freq / pres / (16 + 1)) > speed)
 140                 /* set prescaler to 512 */
 141                 pres = 512;
 142
 143         div = 0;
 144         while ((freq / pres / (div + 1)) > speed)
 145                 div++;
 146
 147         /* set prescaler, divisor according to freq, also set ACKGEN, IRQ */
 148         writel((div & 0x0F) | 0xA0 | ((pres == 512) ? 0x40 : 0), &i2c->iiccon);
 149
 150         /* init to SLAVE REVEIVE and set slaveaddr */
 151         writel(0, &i2c->iicstat);
 152         writel(slaveadd, &i2c->iicadd);
 153         /* program Master Transmit (and implicit STOP) */
 154         writel(I2C_MODE_MT | I2C_TXRX_ENA, &i2c->iicstat);
 155 }
 156
 157 /*
 158  * MULTI BUS I2C support
 159  */
 160
 161 #ifdef CONFIG_I2C_MULTI_BUS
 162 int i2c_set_bus_num(unsigned int bus)
 163 {
 164         struct s3c24x0_i2c *i2c;
 165
 166         i2c_bus = get_bus(bus);
 167         if (!i2c_bus)
 168                 return -1;
 169         }
 170
 171         g_current_bus = bus;
 172         i2c = get_base_i2c();
 173         i2c_ch_init(i2c, CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
 174
 175         return 0;
 176 }
 177
 178 unsigned int i2c_get_bus_num(void)
 179 {
 180         return g_current_bus;
 181 }
 182 #endif
 183
 184 void i2c_init(int speed, int slaveadd)
 185 {
 186         int i;
 187         struct s3c24x0_i2c *i2c;
 188 #if !(defined CONFIG_EXYNOS4 || defined CONFIG_EXYNOS5)
 189         struct s3c24x0_gpio *gpio = s3c24x0_get_base_gpio();
 190 #endif
 191         ulong start_time = get_timer(0);
 192
 193         /* By default i2c channel 0 is the current bus */
 194         g_current_bus = 0;
 195         i2c = get_base_i2c();
 196
 197         /*
 198          * In case the previous transfer is still going, wait to give it a
 199          * chance to finish.
 200          */
 201         while (readl(&i2c->iicstat) & I2CSTAT_BSY) {
 202                 if (get_timer(start_time) > I2C_TIMEOUT_MS) {
 203                         printf("%s: I2C bus busy for %p\n", __func__,
 204                                &i2c->iicstat);
 205                         return;
 206                 }
 207         }
 208
 209 #if !(defined CONFIG_EXYNOS4 || defined CONFIG_EXYNOS5)
 210         if ((readl(&i2c->iicstat) & I2CSTAT_BSY) || GetI2CSDA() == 0) {
 211 #ifdef CONFIG_S3C2410
 212                 ulong old_gpecon = readl(&gpio->gpecon);
 213 #endif
 214 #ifdef CONFIG_S3C2400
 215                 ulong old_gpecon = readl(&gpio->pgcon);
 216 #endif
 217                 /* bus still busy probably by (most) previously interrupted
 218                    transfer */
 219
 220 #ifdef CONFIG_S3C2410
 221                 /* set I2CSDA and I2CSCL (GPE15, GPE14) to GPIO */
 222                 writel((readl(&gpio->gpecon) & ~0xF0000000) | 0x10000000,
 223                        &gpio->gpecon);
 224 #endif
 225 #ifdef CONFIG_S3C2400
 226                 /* set I2CSDA and I2CSCL (PG5, PG6) to GPIO */
 227                 writel((readl(&gpio->pgcon) & ~0x00003c00) | 0x00001000,
 228                        &gpio->pgcon);
 229 #endif
 230
 231                 /* toggle I2CSCL until bus idle */
 232                 SetI2CSCL(0);
 233                 udelay(1000);
 234                 i = 10;
 235                 while ((i > 0) && (GetI2CSDA() != 1)) {
 236                         SetI2CSCL(1);
 237                         udelay(1000);
 238                         SetI2CSCL(0);
 239                         udelay(1000);
 240                         i--;
 241                 }
 242                 SetI2CSCL(1);
 243                 udelay(1000);
 244
 245                 /* restore pin functions */
 246 #ifdef CONFIG_S3C2410
 247                 writel(old_gpecon, &gpio->gpecon);
 248 #endif
 249 #ifdef CONFIG_S3C2400
 250                 writel(old_gpecon, &gpio->pgcon);
 251 #endif
 252         }
 253 #endif /* #if !(defined CONFIG_EXYNOS4 || defined CONFIG_EXYNOS5) */
 254         i2c_ch_init(i2c, speed, slaveadd);
 255 }
 256
 257 /*
 258  * cmd_type is 0 for write, 1 for read.
 259  *
 260  * addr_len can take any value from 0-255, it is only limited
 261  * by the char, we could make it larger if needed. If it is
 262  * 0 we skip the address write cycle.
 263  */
 264 static int i2c_transfer(struct s3c24x0_i2c *i2c,
 265                         unsigned char cmd_type,
 266                         unsigned char chip,
 267                         unsigned char addr[],
 268                         unsigned char addr_len,
 269                         unsigned char data[],
 270                         unsigned short data_len)
 271 {
 272         int i = 0, result;
 273         ulong start_time = get_timer(0);
 274
 275         if (data == 0 || data_len == 0) {
 276                 /*Don't support data transfer of no length or to address 0 */
 277                 debug("i2c_transfer: bad call\n");
 278                 return I2C_NOK;
 279         }
 280
 281         while (readl(&i2c->iicstat) & I2CSTAT_BSY) {
 282                 if (get_timer(start_time) > I2C_TIMEOUT_MS)
 283                         return I2C_NOK_TOUT;
 284         }
 285
 286         writel(readl(&i2c->iiccon) | I2CCON_ACKGEN, &i2c->iiccon);
 287
 288         /* Get the slave chip address going */
 289         writel(chip, &i2c->iicds);
 290         if ((cmd_type == I2C_WRITE) || (addr && addr_len))
 291                 writel(I2C_MODE_MT | I2C_TXRX_ENA | I2C_START_STOP,
 292                        &i2c->iicstat);
 293         else
 294                 writel(I2C_MODE_MR | I2C_TXRX_ENA | I2C_START_STOP,
 295                        &i2c->iicstat);
 296
 297         /* Wait for chip address to transmit. */
 298         result = WaitForXfer(i2c);
 299         if (result != I2C_OK)
 300                 goto bailout;
 301
 302         /* If register address needs to be transmitted - do it now. */
 303         if (addr && addr_len) {
 304                 while ((i < addr_len) && (result == I2C_OK)) {
 305                         writel(addr[i++], &i2c->iicds);
 306                         ReadWriteByte(i2c);
 307                         result = WaitForXfer(i2c);
 308                 }
 309                 i = 0;
 310                 if (result != I2C_OK)
 311                         goto bailout;
 312         }
 313
 314         switch (cmd_type) {
 315         case I2C_WRITE:
 316                 while ((i < data_len) && (result == I2C_OK)) {
 317                         writel(data[i++], &i2c->iicds);
 318                         ReadWriteByte(i2c);
 319                         result = WaitForXfer(i2c);
 320                 }
 321                 break;
 322
 323         case I2C_READ:
 324                 if (addr && addr_len) {
 325                         /*
 326                          * Register address has been sent, now send slave chip
 327                          * address again to start the actual read transaction.
 328                          */
 329                         writel(chip, &i2c->iicds);
 330
 331                         /* Generate a re-START. */
 332                         writel(I2C_MODE_MR | I2C_TXRX_ENA | I2C_START_STOP,
 333                                 &i2c->iicstat);
 334                         ReadWriteByte(i2c);
 335                         result = WaitForXfer(i2c);
 336
 337                         if (result != I2C_OK)
 338                                 goto bailout;
 339                 }
 340
 341                 while ((i < data_len) && (result == I2C_OK)) {
 342                         /* disable ACK for final READ */
 343                         if (i == data_len - 1)
 344                                 writel(readl(&i2c->iiccon)
 345                                        & ~I2CCON_ACKGEN,
 346                                        &i2c->iiccon);
 347                         ReadWriteByte(i2c);
 348                         result = WaitForXfer(i2c);
 349                         data[i++] = readl(&i2c->iicds);
 350                 }
 351                 if (result == I2C_NACK)
 352                         result = I2C_OK; /* Normal terminated read. */
 353                 break;
 354
 355         default:
 356                 debug("i2c_transfer: bad call\n");
 357                 result = I2C_NOK;
 358                 break;
 359         }
 360
 361 bailout:
 362         /* Send STOP. */
 363         writel(I2C_MODE_MR | I2C_TXRX_ENA, &i2c->iicstat);
 364         ReadWriteByte(i2c);
 365
 366         return result;
 367 }
 368
 369 int i2c_probe(uchar chip)
 370 {
 371         struct s3c24x0_i2c *i2c;
 372         uchar buf[1];
 373
 374         i2c = get_base_i2c();
 375         buf[0] = 0;
 376
 377         /*
 378          * What is needed is to send the chip address and verify that the
 379          * address was <ACK>ed (i.e. there was a chip at that address which
 380          * drove the data line low).
 381          */
 382         return i2c_transfer(i2c, I2C_READ, chip << 1, 0, 0, buf, 1) != I2C_OK;
 383 }
 384
 385 int i2c_read(uchar chip, uint addr, int alen, uchar *buffer, int len)
 386 {
 387         struct s3c24x0_i2c *i2c;
 388         uchar xaddr[4];
 389         int ret;
 390
 391         if (alen > 4) {
 392                 debug("I2C read: addr len %d not supported\n", alen);
 393                 return 1;
 394         }
 395
 396         if (alen > 0) {
 397                 xaddr[0] = (addr >> 24) & 0xFF;
 398                 xaddr[1] = (addr >> 16) & 0xFF;
 399                 xaddr[2] = (addr >> 8) & 0xFF;
 400                 xaddr[3] = addr & 0xFF;
 401         }
 402
 403 #ifdef CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW
 404         /*
 405          * EEPROM chips that implement "address overflow" are ones
 406          * like Catalyst 24WC04/08/16 which has 9/10/11 bits of
 407          * address and the extra bits end up in the "chip address"
 408          * bit slots. This makes a 24WC08 (1Kbyte) chip look like
 409          * four 256 byte chips.
 410          *
 411          * Note that we consider the length of the address field to
 412          * still be one byte because the extra address bits are
 413          * hidden in the chip address.
 414          */
 415         if (alen > 0)
 416                 chip |= ((addr >> (alen * 8)) &
 417                          CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW);
 418 #endif
 419         i2c = get_base_i2c();
 420         ret = i2c_transfer(i2c, I2C_READ, chip << 1, &xaddr[4 - alen], alen,
 421                         buffer, len);
 422         if (ret != 0) {
 423                 debug("I2c read: failed %d\n", ret);
 424                 return 1;
 425         }
 426         return 0;
 427 }
 428
 429 int i2c_write(uchar chip, uint addr, int alen, uchar *buffer, int len)
 430 {
 431         struct s3c24x0_i2c *i2c;
 432         uchar xaddr[4];
 433
 434         if (alen > 4) {
 435                 debug("I2C write: addr len %d not supported\n", alen);
 436                 return 1;
 437         }
 438
 439         if (alen > 0) {
 440                 xaddr[0] = (addr >> 24) & 0xFF;
 441                 xaddr[1] = (addr >> 16) & 0xFF;
 442                 xaddr[2] = (addr >> 8) & 0xFF;
 443                 xaddr[3] = addr & 0xFF;
 444         }
 445 #ifdef CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW
 446         /*
 447          * EEPROM chips that implement "address overflow" are ones
 448          * like Catalyst 24WC04/08/16 which has 9/10/11 bits of
 449          * address and the extra bits end up in the "chip address"
 450          * bit slots. This makes a 24WC08 (1Kbyte) chip look like
 451          * four 256 byte chips.
 452          *
 453          * Note that we consider the length of the address field to
 454          * still be one byte because the extra address bits are
 455          * hidden in the chip address.
 456          */
 457         if (alen > 0)
 458                 chip |= ((addr >> (alen * 8)) &
 459                          CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW);
 460 #endif
 461         i2c = get_base_i2c();
 462         return (i2c_transfer
 463                 (i2c, I2C_WRITE, chip << 1, &xaddr[4 - alen], alen, buffer,
 464                  len) != 0);
 465 }
 466
 467 #ifdef CONFIG_OF_CONTROL
 468 void board_i2c_init(const void *blob)
 469 {
 470         int i;
 471         int node_list[CONFIG_MAX_I2C_NUM];
 472         int count;
 473
 474         count = fdtdec_find_aliases_for_id(blob, "i2c",
 475                 COMPAT_SAMSUNG_S3C2440_I2C, node_list,
 476                 CONFIG_MAX_I2C_NUM);
 477
 478         for (i = 0; i < count; i++) {
 479                 struct s3c24x0_i2c_bus *bus;
 480                 int node = node_list[i];
 481
 482                 if (node <= 0)
 483                         continue;
 484                 bus = &i2c_bus[i];
 485                 bus->active = true;
 486                 bus->regs = (struct s3c24x0_i2c *)
 487                         fdtdec_get_addr(blob, node, "reg");
 488                 bus->id = pinmux_decode_periph_id(blob, node);
 489                 bus->node = node;
 490                 bus->bus_num = i;
 491                 exynos_pinmux_config(bus->id, 0);
 492         }
 493 }
 494
 495 /**
 496  * Get a pointer to the given bus index
 497  *
 498  * @bus_idx: Bus index to look up
 499  * @return pointer to bus, or NULL if invalid or not available
 500  */
 501 static struct s3c24x0_i2c_bus *get_bus(unsigned int bus_idx)
 502 {
 503         if (bus_idx < ARRAY_SIZE(i2c_bus)) {
 504                 struct s3c24x0_i2c_bus *bus;
 505
 506                 bus = &i2c_bus[bus_idx];
 507                 if (bus->active)
 508                         return bus;
 509         }
 510
 511         debug("Undefined bus: %d\n", bus_idx);
 512         return NULL;
 513 }
 514
 515 int i2c_get_bus_num_fdt(int node)
 516 {
 517         int i;
 518
 519         for (i = 0; i < ARRAY_SIZE(i2c_bus); i++) {
 520                 if (node == i2c_bus[i].node)
 521                         return i;
 522         }
 523
 524         debug("%s: Can't find any matched I2C bus\n", __func__);
 525         return -1;
 526 }
 527
 528 int i2c_reset_port_fdt(const void *blob, int node)
 529 {
 530         struct s3c24x0_i2c_bus *i2c;
 531         int bus;
 532
 533         bus = i2c_get_bus_num_fdt(node);
 534         if (bus < 0) {
 535                 debug("could not get bus for node %d\n", node);
 536                 return -1;
 537         }
 538
 539         i2c = get_bus(bus);
 540         if (!i2c) {
 541                 debug("get_bus() failed for node node %d\n", node);
 542                 return -1;
 543         }
 544
 545         i2c_ch_init(i2c->regs, CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
 546
 547         return 0;
 548 }
 549 #endif
 550
 551 #endif /* CONFIG_HARD_I2C */