drivers/i2c/mvtwsi.c

   1 /*
   2  * Driver for the TWSI (i2c) controller found on the Marvell
   3  * orion5x and kirkwood SoC families.
   4  *
   5  * Author: Albert Aribaud <albert.u.boot@aribaud.net>
   6  * Copyright (c) 2010 Albert Aribaud.
   7  *
   8  * SPDX-License-Identifier:     GPL-2.0+
   9  */
  10
  11 #include <common.h>
  12 #include <i2c.h>
  13 #include <asm/errno.h>
  14 #include <asm/io.h>
  15
  16 /*
  17  * Include a file that will provide CONFIG_I2C_MVTWSI_BASE*, and possibly other
  18  * settings
  19  */
  20
  21 #if defined(CONFIG_ORION5X)
  22 #include <asm/arch/orion5x.h>
  23 #elif (defined(CONFIG_KIRKWOOD) || defined(CONFIG_ARCH_MVEBU))
  24 #include <asm/arch/soc.h>
  25 #elif defined(CONFIG_SUNXI)
  26 #include <asm/arch/i2c.h>
  27 #else
  28 #error Driver mvtwsi not supported by SoC or board
  29 #endif
  30
  31 /*
  32  * TWSI register structure
  33  */
  34
  35 #ifdef CONFIG_SUNXI
  36
  37 struct  mvtwsi_registers {
  38         u32 slave_address;
  39         u32 xtnd_slave_addr;
  40         u32 data;
  41         u32 control;
  42         u32 status;
  43         u32 baudrate;
  44         u32 soft_reset;
  45 };
  46
  47 #else
  48
  49 struct  mvtwsi_registers {
  50         u32 slave_address;
  51         u32 data;
  52         u32 control;
  53         union {
  54                 u32 status;     /* When reading */
  55                 u32 baudrate;   /* When writing */
  56         };
  57         u32 xtnd_slave_addr;
  58         u32 reserved[2];
  59         u32 soft_reset;
  60 };
  61
  62 #endif
  63
  64 /*
  65  * enum mvtwsi_ctrl_register_fields - Bit masks for flags in the control
  66  * register
  67  */
  68 enum mvtwsi_ctrl_register_fields {
  69         /* Acknowledge bit */
  70         MVTWSI_CONTROL_ACK      = 0x00000004,
  71         /* Interrupt flag */
  72         MVTWSI_CONTROL_IFLG     = 0x00000008,
  73         /* Stop bit */
  74         MVTWSI_CONTROL_STOP     = 0x00000010,
  75         /* Start bit */
  76         MVTWSI_CONTROL_START    = 0x00000020,
  77         /* I2C enable */
  78         MVTWSI_CONTROL_TWSIEN   = 0x00000040,
  79         /* Interrupt enable */
  80         MVTWSI_CONTROL_INTEN    = 0x00000080,
  81 };
  82
  83 /*
  84  * On sun6i and newer, IFLG is a write-clear bit, which is cleared by writing 1;
  85  * on other platforms, it is a normal r/w bit, which is cleared by writing 0.
  86  */
  87
  88 #ifdef CONFIG_SUNXI_GEN_SUN6I
  89 #define MVTWSI_CONTROL_CLEAR_IFLG       0x00000008
  90 #else
  91 #define MVTWSI_CONTROL_CLEAR_IFLG       0x00000000
  92 #endif
  93
  94 /*
  95  * enum mvstwsi_status_values - Possible values of I2C controller's status
  96  * register
  97  *
  98  * Only those statuses expected in normal master operation on
  99  * non-10-bit-address devices are specified.
 100  *
 101  * Every status that's unexpected during normal operation (bus errors,
 102  * arbitration losses, missing ACKs...) is passed back to the caller as an error
 103  * code.
 104  */
 105 enum mvstwsi_status_values {
 106         /* START condition transmitted */
 107         MVTWSI_STATUS_START             = 0x08,
 108         /* Repeated START condition transmitted */
 109         MVTWSI_STATUS_REPEATED_START    = 0x10,
 110         /* Address + write bit transmitted, ACK received */
 111         MVTWSI_STATUS_ADDR_W_ACK        = 0x18,
 112         /* Data transmitted, ACK received */
 113         MVTWSI_STATUS_DATA_W_ACK        = 0x28,
 114         /* Address + read bit transmitted, ACK received */
 115         MVTWSI_STATUS_ADDR_R_ACK        = 0x40,
 116         /* Address + read bit transmitted, ACK not received */
 117         MVTWSI_STATUS_ADDR_R_NAK        = 0x48,
 118         /* Data received, ACK transmitted */
 119         MVTWSI_STATUS_DATA_R_ACK        = 0x50,
 120         /* Data received, ACK not transmitted */
 121         MVTWSI_STATUS_DATA_R_NAK        = 0x58,
 122         /* No relevant status */
 123         MVTWSI_STATUS_IDLE              = 0xF8,
 124 };
 125
 126 /*
 127  * enum mvstwsi_ack_flags - Determine whether a read byte should be
 128  * acknowledged or not.
 129  */
 130 enum mvtwsi_ack_flags {
 131         /* Send NAK after received byte */
 132         MVTWSI_READ_NAK = 0,
 133         /* Send ACK after received byte */
 134         MVTWSI_READ_ACK = 1,
 135 };
 136
 137 /*
 138  * MVTWSI controller base
 139  */
 140
 141 static struct mvtwsi_registers *twsi_get_base(struct i2c_adapter *adap)
 142 {
 143         switch (adap->hwadapnr) {
 144 #ifdef CONFIG_I2C_MVTWSI_BASE0
 145         case 0:
 146                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE0;
 147 #endif
 148 #ifdef CONFIG_I2C_MVTWSI_BASE1
 149         case 1:
 150                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE1;
 151 #endif
 152 #ifdef CONFIG_I2C_MVTWSI_BASE2
 153         case 2:
 154                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE2;
 155 #endif
 156 #ifdef CONFIG_I2C_MVTWSI_BASE3
 157         case 3:
 158                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE3;
 159 #endif
 160 #ifdef CONFIG_I2C_MVTWSI_BASE4
 161         case 4:
 162                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE4;
 163 #endif
 164 #ifdef CONFIG_I2C_MVTWSI_BASE5
 165         case 5:
 166                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE5;
 167 #endif
 168         default:
 169                 printf("Missing mvtwsi controller %d base\n", adap->hwadapnr);
 170                 break;
 171         }
 172
 173         return NULL;
 174 }
 175
 176 /*
 177  * enum mvtwsi_error_class - types of I2C errors
 178  */
 179 enum mvtwsi_error_class {
 180         /* The controller returned a different status than expected */
 181         MVTWSI_ERROR_WRONG_STATUS       = 0x01,
 182         /* The controller timed out */
 183         MVTWSI_ERROR_TIMEOUT            = 0x02,
 184 };
 185
 186 /*
 187  * mvtwsi_error() - Build I2C return code from error information
 188  *
 189  * For debugging purposes, this function packs some information of an occurred
 190  * error into a return code. These error codes are returned from I2C API
 191  * functions (i2c_{read,write}, dm_i2c_{read,write}, etc.).
 192  *
 193  * @ec:         The error class of the error (enum mvtwsi_error_class).
 194  * @lc:         The last value of the control register.
 195  * @ls:         The last value of the status register.
 196  * @es:         The expected value of the status register.
 197  * @return The generated error code.
 198  */
 199 inline uint mvtwsi_error(uint ec, uint lc, uint ls, uint es)
 200 {
 201         return ((ec << 24) & 0xFF000000)
 202                | ((lc << 16) & 0x00FF0000)
 203                | ((ls << 8) & 0x0000FF00)
 204                | (es & 0xFF);
 205 }
 206
 207 /*
 208  * Wait for IFLG to raise, or return 'timeout.' Then, if the status is as
 209  * expected, return 0 (ok) or 'wrong status' otherwise.
 210  */
 211 static int twsi_wait(struct i2c_adapter *adap, int expected_status)
 212 {
 213         struct mvtwsi_registers *twsi = twsi_get_base(adap);
 214         int control, status;
 215         int timeout = 1000;
 216
 217         do {
 218                 control = readl(&twsi->control);
 219                 if (control & MVTWSI_CONTROL_IFLG) {
 220                         status = readl(&twsi->status);
 221                         if (status == expected_status)
 222                                 return 0;
 223                         else
 224                                 return mvtwsi_error(
 225                                         MVTWSI_ERROR_WRONG_STATUS,
 226                                         control, status, expected_status);
 227                 }
 228                 udelay(10); /* One clock cycle at 100 kHz */
 229         } while (timeout--);
 230         status = readl(&twsi->status);
 231         return mvtwsi_error(MVTWSI_ERROR_TIMEOUT, control, status,
 232                             expected_status);
 233 }
 234
 235 /*
 236  * Assert the START condition, either in a single I2C transaction
 237  * or inside back-to-back ones (repeated starts).
 238  */
 239 static int twsi_start(struct i2c_adapter *adap, int expected_status)
 240 {
 241         struct mvtwsi_registers *twsi = twsi_get_base(adap);
 242
 243         /* Assert START */
 244         writel(MVTWSI_CONTROL_TWSIEN | MVTWSI_CONTROL_START |
 245                MVTWSI_CONTROL_CLEAR_IFLG, &twsi->control);
 246         /* Wait for controller to process START */
 247         return twsi_wait(adap, expected_status);
 248 }
 249
 250 /*
 251  * Send a byte (i2c address or data).
 252  */
 253 static int twsi_send(struct i2c_adapter *adap, u8 byte, int expected_status)
 254 {
 255         struct mvtwsi_registers *twsi = twsi_get_base(adap);
 256
 257         /* Write byte to data register for sending */
 258         writel(byte, &twsi->data);
 259         /* Clear any pending interrupt -- that will cause sending */
 260         writel(MVTWSI_CONTROL_TWSIEN | MVTWSI_CONTROL_CLEAR_IFLG,
 261                &twsi->control);
 262         /* Wait for controller to receive byte, and check ACK */
 263         return twsi_wait(adap, expected_status);
 264 }
 265
 266 /*
 267  * Receive a byte.
 268  */
 269 static int twsi_recv(struct i2c_adapter *adap, u8 *byte, int ack_flag)
 270 {
 271         struct mvtwsi_registers *twsi = twsi_get_base(adap);
 272         int expected_status, status, control;
 273
 274         /* Compute expected status based on passed ACK flag */
 275         expected_status = ack_flag ? MVTWSI_STATUS_DATA_R_ACK :
 276                           MVTWSI_STATUS_DATA_R_NAK;
 277         /* Acknowledge *previous state*, and launch receive */
 278         control = MVTWSI_CONTROL_TWSIEN;
 279         control |= ack_flag == MVTWSI_READ_ACK ? MVTWSI_CONTROL_ACK : 0;
 280         writel(control | MVTWSI_CONTROL_CLEAR_IFLG, &twsi->control);
 281         /* Wait for controller to receive byte, and assert ACK or NAK */
 282         status = twsi_wait(adap, expected_status);
 283         /* If we did receive the expected byte, store it */
 284         if (status == 0)
 285                 *byte = readl(&twsi->data);
 286         return status;
 287 }
 288
 289 /*
 290  * Assert the STOP condition.
 291  * This is also used to force the bus back to idle (SDA = SCL = 1).
 292  */
 293 static int twsi_stop(struct i2c_adapter *adap)
 294 {
 295         struct mvtwsi_registers *twsi = twsi_get_base(adap);
 296         int control, stop_status;
 297         int status = 0;
 298         int timeout = 1000;
 299
 300         /* Assert STOP */
 301         control = MVTWSI_CONTROL_TWSIEN | MVTWSI_CONTROL_STOP;
 302         writel(control | MVTWSI_CONTROL_CLEAR_IFLG, &twsi->control);
 303         /* Wait for IDLE; IFLG won't rise, so we can't use twsi_wait() */
 304         do {
 305                 stop_status = readl(&twsi->status);
 306                 if (stop_status == MVTWSI_STATUS_IDLE)
 307                         break;
 308                 udelay(10); /* One clock cycle at 100 kHz */
 309         } while (timeout--);
 310         control = readl(&twsi->control);
 311         if (stop_status != MVTWSI_STATUS_IDLE)
 312                 status = mvtwsi_error(MVTWSI_ERROR_TIMEOUT,
 313                                       control, status, MVTWSI_STATUS_IDLE);
 314         return status;
 315 }
 316
 317 static uint twsi_calc_freq(const int n, const int m)
 318 {
 319 #ifdef CONFIG_SUNXI
 320         return CONFIG_SYS_TCLK / (10 * (m + 1) * (1 << n));
 321 #else
 322         return CONFIG_SYS_TCLK / (10 * (m + 1) * (2 << n));
 323 #endif
 324 }
 325
 326 /*
 327  * Reset controller.
 328  * Controller reset also resets the baud rate and slave address, so
 329  * they must be re-established afterwards.
 330  */
 331 static void twsi_reset(struct i2c_adapter *adap)
 332 {
 333         struct mvtwsi_registers *twsi = twsi_get_base(adap);
 334
 335         /* Reset controller */
 336         writel(0, &twsi->soft_reset);
 337         /* Wait 2 ms -- this is what the Marvell LSP does */
 338         udelay(20000);
 339 }
 340
 341 /*
 342  * Sets baud to the highest possible value not exceeding the requested one.
 343  */
 344 static uint __twsi_i2c_set_bus_speed(struct i2c_adapter *adap,
 345                                      uint requested_speed)
 346 {
 347         struct mvtwsi_registers *twsi = twsi_get_base(adap);
 348         uint tmp_speed, highest_speed, n, m;
 349         uint baud = 0x44; /* Baud rate after controller reset */
 350
 351         highest_speed = 0;
 352         /* Successively try m, n combinations, and use the combination
 353          * resulting in the largest speed that's not above the requested
 354          * speed */
 355         for (n = 0; n < 8; n++) {
 356                 for (m = 0; m < 16; m++) {
 357                         tmp_speed = twsi_calc_freq(n, m);
 358                         if ((tmp_speed <= requested_speed) &&
 359                             (tmp_speed > highest_speed)) {
 360                                 highest_speed = tmp_speed;
 361                                 baud = (m << 3) | n;
 362                         }
 363                 }
 364         }
 365         writel(baud, &twsi->baudrate);
 366         return 0;
 367 }
 368
 369 static void __twsi_i2c_init(struct i2c_adapter *adap, int speed, int slaveadd)
 370 {
 371         struct mvtwsi_registers *twsi = twsi_get_base(adap);
 372
 373         /* Reset controller */
 374         twsi_reset(adap);
 375         /* Set speed */
 376         __twsi_i2c_set_bus_speed(adap, speed);
 377         /* Set slave address; even though we don't use it */
 378         writel(slaveadd, &twsi->slave_address);
 379         writel(0, &twsi->xtnd_slave_addr);
 380         /* Assert STOP, but don't care for the result */
 381         (void) twsi_stop(adap);
 382 }
 383
 384 /*
 385  * Begin I2C transaction with expected start status, at given address.
 386  * Expected address status will derive from direction bit (bit 0) in addr.
 387  */
 388 static int i2c_begin(struct i2c_adapter *adap, int expected_start_status,
 389                      u8 addr)
 390 {
 391         int status, expected_addr_status;
 392
 393         /* Compute the expected address status from the direction bit in
 394          * the address byte */
 395         if (addr & 1) /* Reading */
 396                 expected_addr_status = MVTWSI_STATUS_ADDR_R_ACK;
 397         else /* Writing */
 398                 expected_addr_status = MVTWSI_STATUS_ADDR_W_ACK;
 399         /* Assert START */
 400         status = twsi_start(adap, expected_start_status);
 401         /* Send out the address if the start went well */
 402         if (status == 0)
 403                 status = twsi_send(adap, addr, expected_addr_status);
 404         /* Return 0, or the status of the first failure */
 405         return status;
 406 }
 407
 408 /*
 409  * Begin read, nak data byte, end.
 410  */
 411 static int __twsi_i2c_probe_chip(struct i2c_adapter *adap, uchar chip)
 412 {
 413         u8 dummy_byte;
 414         int status;
 415
 416         /* Begin i2c read */
 417         status = i2c_begin(adap, MVTWSI_STATUS_START, (chip << 1) | 1);
 418         /* Dummy read was accepted: receive byte, but NAK it. */
 419         if (status == 0)
 420                 status = twsi_recv(adap, &dummy_byte, MVTWSI_READ_NAK);
 421         /* Stop transaction */
 422         twsi_stop(adap);
 423         /* Return 0, or the status of the first failure */
 424         return status;
 425 }
 426
 427 /*
 428  * Begin write, send address byte(s), begin read, receive data bytes, end.
 429  *
 430  * NOTE: Some devices want a stop right before the second start, while some
 431  * will choke if it is there. Since deciding this is not yet supported in
 432  * higher level APIs, we need to make a decision here, and for the moment that
 433  * will be a repeated start without a preceding stop.
 434  */
 435 static int __twsi_i2c_read(struct i2c_adapter *adap, uchar chip, uint addr,
 436                            int alen, uchar *data, int length)
 437 {
 438         int status = 0;
 439         int stop_status;
 440
 441         /* Begin i2c write to send the address bytes */
 442         status = i2c_begin(adap, MVTWSI_STATUS_START, (chip << 1));
 443         /* Send address bytes */
 444         while ((status == 0) && alen--)
 445                 status = twsi_send(adap, addr >> (8*alen),
 446                         MVTWSI_STATUS_DATA_W_ACK);
 447         /* Begin i2c read to receive data bytes */
 448         if (status == 0)
 449                 status = i2c_begin(adap, MVTWSI_STATUS_REPEATED_START,
 450                                    (chip << 1) | 1);
 451         /* Receive actual data bytes; set NAK if we if we have nothing more to
 452          * read */
 453         while ((status == 0) && length--)
 454                 status = twsi_recv(adap, data++,
 455                                    length > 0 ?
 456                                    MVTWSI_READ_ACK : MVTWSI_READ_NAK);
 457         /* Stop transaction */
 458         stop_status = twsi_stop(adap);
 459         /* Return 0, or the status of the first failure */
 460         return status != 0 ? status : stop_status;
 461 }
 462
 463 /*
 464  * Begin write, send address byte(s), send data bytes, end.
 465  */
 466 static int __twsi_i2c_write(struct i2c_adapter *adap, uchar chip, uint addr,
 467                             int alen, uchar *data, int length)
 468 {
 469         int status, stop_status;
 470
 471         /* Begin i2c write to send first the address bytes, then the
 472          * data bytes */
 473         status = i2c_begin(adap, MVTWSI_STATUS_START, (chip << 1));
 474         /* Send address bytes */
 475         while ((status == 0) && alen--)
 476                 status = twsi_send(adap, addr >> (8*alen),
 477                         MVTWSI_STATUS_DATA_W_ACK);
 478         /* Send data bytes */
 479         while ((status == 0) && (length-- > 0))
 480                 status = twsi_send(adap, *(data++), MVTWSI_STATUS_DATA_W_ACK);
 481         /* Stop transaction */
 482         stop_status = twsi_stop(adap);
 483         /* Return 0, or the status of the first failure */
 484         return status != 0 ? status : stop_status;
 485 }
 486
 487 static void twsi_i2c_init(struct i2c_adapter *adap, int speed,
 488                           int slaveadd)
 489 {
 490         __twsi_i2c_init(adap, speed, slaveadd);
 491 }
 492
 493 static uint twsi_i2c_set_bus_speed(struct i2c_adapter *adap,
 494                                    uint requested_speed)
 495 {
 496         return __twsi_i2c_set_bus_speed(adap, requested_speed);
 497 }
 498
 499 static int twsi_i2c_probe(struct i2c_adapter *adap, uchar chip)
 500 {
 501         return __twsi_i2c_probe_chip(adap, chip);
 502 }
 503
 504 static int twsi_i2c_read(struct i2c_adapter *adap, uchar chip, uint addr,
 505                          int alen, uchar *data, int length)
 506 {
 507         return __twsi_i2c_read(adap, chip, addr, alen, data, length);
 508 }
 509
 510 static int twsi_i2c_write(struct i2c_adapter *adap, uchar chip, uint addr,
 511                           int alen, uchar *data, int length)
 512 {
 513         return __twsi_i2c_write(adap, chip, addr, alen, data, length);
 514 }
 515
 516 #ifdef CONFIG_I2C_MVTWSI_BASE0
 517 U_BOOT_I2C_ADAP_COMPLETE(twsi0, twsi_i2c_init, twsi_i2c_probe,
 518                          twsi_i2c_read, twsi_i2c_write,
 519                          twsi_i2c_set_bus_speed,
 520                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 0)
 521 #endif
 522 #ifdef CONFIG_I2C_MVTWSI_BASE1
 523 U_BOOT_I2C_ADAP_COMPLETE(twsi1, twsi_i2c_init, twsi_i2c_probe,
 524                          twsi_i2c_read, twsi_i2c_write,
 525                          twsi_i2c_set_bus_speed,
 526                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 1)
 527
 528 #endif
 529 #ifdef CONFIG_I2C_MVTWSI_BASE2
 530 U_BOOT_I2C_ADAP_COMPLETE(twsi2, twsi_i2c_init, twsi_i2c_probe,
 531                          twsi_i2c_read, twsi_i2c_write,
 532                          twsi_i2c_set_bus_speed,
 533                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 2)
 534
 535 #endif
 536 #ifdef CONFIG_I2C_MVTWSI_BASE3
 537 U_BOOT_I2C_ADAP_COMPLETE(twsi3, twsi_i2c_init, twsi_i2c_probe,
 538                          twsi_i2c_read, twsi_i2c_write,
 539                          twsi_i2c_set_bus_speed,
 540                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 3)
 541
 542 #endif
 543 #ifdef CONFIG_I2C_MVTWSI_BASE4
 544 U_BOOT_I2C_ADAP_COMPLETE(twsi4, twsi_i2c_init, twsi_i2c_probe,
 545                          twsi_i2c_read, twsi_i2c_write,
 546                          twsi_i2c_set_bus_speed,
 547                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 4)
 548
 549 #endif
 550 #ifdef CONFIG_I2C_MVTWSI_BASE5
 551 U_BOOT_I2C_ADAP_COMPLETE(twsi5, twsi_i2c_init, twsi_i2c_probe,
 552                          twsi_i2c_read, twsi_i2c_write,
 553                          twsi_i2c_set_bus_speed,
 554                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 5)
 555
 556 #endif