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