drivers/i2c/mvtwsi.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Driver for the TWSI (i2c) controller found on the Marvell
   4  * orion5x and kirkwood SoC families.
   5  *
   6  * Author: Albert Aribaud <albert.u.boot@aribaud.net>
   7  * Copyright (c) 2010 Albert Aribaud.
   8  */
   9
  10 #include <common.h>
  11 #include <i2c.h>
  12 #include <linux/errno.h>
  13 #include <asm/io.h>
  14 #include <linux/bitops.h>
  15 #include <linux/compat.h>
  16 #ifdef CONFIG_DM_I2C
  17 #include <dm.h>
  18 #endif
  19
  20 DECLARE_GLOBAL_DATA_PTR;
  21
  22 /*
  23  * Include a file that will provide CONFIG_I2C_MVTWSI_BASE*, and possibly other
  24  * settings
  25  */
  26
  27 #ifndef CONFIG_DM_I2C
  28 #if defined(CONFIG_ARCH_ORION5X)
  29 #include <asm/arch/orion5x.h>
  30 #elif (defined(CONFIG_KIRKWOOD) || defined(CONFIG_ARCH_MVEBU))
  31 #include <asm/arch/soc.h>
  32 #elif defined(CONFIG_ARCH_SUNXI)
  33 #include <asm/arch/i2c.h>
  34 #else
  35 #error Driver mvtwsi not supported by SoC or board
  36 #endif
  37 #endif /* CONFIG_DM_I2C */
  38
  39 /*
  40  * On SUNXI, we get CONFIG_SYS_TCLK from this include, so we want to
  41  * always have it.
  42  */
  43 #if defined(CONFIG_DM_I2C) && defined(CONFIG_ARCH_SUNXI)
  44 #include <asm/arch/i2c.h>
  45 #endif
  46
  47 /*
  48  * TWSI register structure
  49  */
  50
  51 #ifdef CONFIG_ARCH_SUNXI
  52
  53 struct  mvtwsi_registers {
  54         u32 slave_address;
  55         u32 xtnd_slave_addr;
  56         u32 data;
  57         u32 control;
  58         u32 status;
  59         u32 baudrate;
  60         u32 soft_reset;
  61         u32 debug; /* Dummy field for build compatibility with mvebu */
  62 };
  63
  64 #else
  65
  66 struct  mvtwsi_registers {
  67         u32 slave_address;
  68         u32 data;
  69         u32 control;
  70         union {
  71                 u32 status;     /* When reading */
  72                 u32 baudrate;   /* When writing */
  73         };
  74         u32 xtnd_slave_addr;
  75         u32 reserved0[2];
  76         u32 soft_reset;
  77         u32 reserved1[27];
  78         u32 debug;
  79 };
  80
  81 #endif
  82
  83 #ifdef CONFIG_DM_I2C
  84 struct mvtwsi_i2c_dev {
  85         /* TWSI Register base for the device */
  86         struct mvtwsi_registers *base;
  87         /* Number of the device (determined from cell-index property) */
  88         int index;
  89         /* The I2C slave address for the device */
  90         u8 slaveadd;
  91         /* The configured I2C speed in Hz */
  92         uint speed;
  93         /* The current length of a clock period (depending on speed) */
  94         uint tick;
  95 };
  96 #endif /* CONFIG_DM_I2C */
  97
  98 /*
  99  * enum mvtwsi_ctrl_register_fields - Bit masks for flags in the control
 100  * register
 101  */
 102 enum mvtwsi_ctrl_register_fields {
 103         /* Acknowledge bit */
 104         MVTWSI_CONTROL_ACK      = 0x00000004,
 105         /* Interrupt flag */
 106         MVTWSI_CONTROL_IFLG     = 0x00000008,
 107         /* Stop bit */
 108         MVTWSI_CONTROL_STOP     = 0x00000010,
 109         /* Start bit */
 110         MVTWSI_CONTROL_START    = 0x00000020,
 111         /* I2C enable */
 112         MVTWSI_CONTROL_TWSIEN   = 0x00000040,
 113         /* Interrupt enable */
 114         MVTWSI_CONTROL_INTEN    = 0x00000080,
 115 };
 116
 117 /*
 118  * On sun6i and newer, IFLG is a write-clear bit, which is cleared by writing 1;
 119  * on other platforms, it is a normal r/w bit, which is cleared by writing 0.
 120  */
 121
 122 #ifdef CONFIG_SUNXI_GEN_SUN6I
 123 #define MVTWSI_CONTROL_CLEAR_IFLG       0x00000008
 124 #else
 125 #define MVTWSI_CONTROL_CLEAR_IFLG       0x00000000
 126 #endif
 127
 128 /*
 129  * enum mvstwsi_status_values - Possible values of I2C controller's status
 130  * register
 131  *
 132  * Only those statuses expected in normal master operation on
 133  * non-10-bit-address devices are specified.
 134  *
 135  * Every status that's unexpected during normal operation (bus errors,
 136  * arbitration losses, missing ACKs...) is passed back to the caller as an error
 137  * code.
 138  */
 139 enum mvstwsi_status_values {
 140         /* START condition transmitted */
 141         MVTWSI_STATUS_START             = 0x08,
 142         /* Repeated START condition transmitted */
 143         MVTWSI_STATUS_REPEATED_START    = 0x10,
 144         /* Address + write bit transmitted, ACK received */
 145         MVTWSI_STATUS_ADDR_W_ACK        = 0x18,
 146         /* Data transmitted, ACK received */
 147         MVTWSI_STATUS_DATA_W_ACK        = 0x28,
 148         /* Address + read bit transmitted, ACK received */
 149         MVTWSI_STATUS_ADDR_R_ACK        = 0x40,
 150         /* Address + read bit transmitted, ACK not received */
 151         MVTWSI_STATUS_ADDR_R_NAK        = 0x48,
 152         /* Data received, ACK transmitted */
 153         MVTWSI_STATUS_DATA_R_ACK        = 0x50,
 154         /* Data received, ACK not transmitted */
 155         MVTWSI_STATUS_DATA_R_NAK        = 0x58,
 156         /* No relevant status */
 157         MVTWSI_STATUS_IDLE              = 0xF8,
 158 };
 159
 160 /*
 161  * enum mvstwsi_ack_flags - Determine whether a read byte should be
 162  * acknowledged or not.
 163  */
 164 enum mvtwsi_ack_flags {
 165         /* Send NAK after received byte */
 166         MVTWSI_READ_NAK = 0,
 167         /* Send ACK after received byte */
 168         MVTWSI_READ_ACK = 1,
 169 };
 170
 171 /*
 172  * calc_tick() - Calculate the duration of a clock cycle from the I2C speed
 173  *
 174  * @speed:      The speed in Hz to calculate the clock cycle duration for.
 175  * @return The duration of a clock cycle in ns.
 176  */
 177 inline uint calc_tick(uint speed)
 178 {
 179         /* One tick = the duration of a period at the specified speed in ns (we
 180          * add 100 ns to be on the safe side) */
 181         return (1000000000u / speed) + 100;
 182 }
 183
 184 #ifndef CONFIG_DM_I2C
 185
 186 /*
 187  * twsi_get_base() - Get controller register base for specified adapter
 188  *
 189  * @adap:       Adapter to get the register base for.
 190  * @return Register base for the specified adapter.
 191  */
 192 static struct mvtwsi_registers *twsi_get_base(struct i2c_adapter *adap)
 193 {
 194         switch (adap->hwadapnr) {
 195 #ifdef CONFIG_I2C_MVTWSI_BASE0
 196         case 0:
 197                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE0;
 198 #endif
 199 #ifdef CONFIG_I2C_MVTWSI_BASE1
 200         case 1:
 201                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE1;
 202 #endif
 203 #ifdef CONFIG_I2C_MVTWSI_BASE2
 204         case 2:
 205                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE2;
 206 #endif
 207 #ifdef CONFIG_I2C_MVTWSI_BASE3
 208         case 3:
 209                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE3;
 210 #endif
 211 #ifdef CONFIG_I2C_MVTWSI_BASE4
 212         case 4:
 213                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE4;
 214 #endif
 215 #ifdef CONFIG_I2C_MVTWSI_BASE5
 216         case 5:
 217                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE5;
 218 #endif
 219         default:
 220                 printf("Missing mvtwsi controller %d base\n", adap->hwadapnr);
 221                 break;
 222         }
 223
 224         return NULL;
 225 }
 226 #endif
 227
 228 /*
 229  * enum mvtwsi_error_class - types of I2C errors
 230  */
 231 enum mvtwsi_error_class {
 232         /* The controller returned a different status than expected */
 233         MVTWSI_ERROR_WRONG_STATUS       = 0x01,
 234         /* The controller timed out */
 235         MVTWSI_ERROR_TIMEOUT            = 0x02,
 236 };
 237
 238 /*
 239  * mvtwsi_error() - Build I2C return code from error information
 240  *
 241  * For debugging purposes, this function packs some information of an occurred
 242  * error into a return code. These error codes are returned from I2C API
 243  * functions (i2c_{read,write}, dm_i2c_{read,write}, etc.).
 244  *
 245  * @ec:         The error class of the error (enum mvtwsi_error_class).
 246  * @lc:         The last value of the control register.
 247  * @ls:         The last value of the status register.
 248  * @es:         The expected value of the status register.
 249  * @return The generated error code.
 250  */
 251 inline uint mvtwsi_error(uint ec, uint lc, uint ls, uint es)
 252 {
 253         return ((ec << 24) & 0xFF000000)
 254                | ((lc << 16) & 0x00FF0000)
 255                | ((ls << 8) & 0x0000FF00)
 256                | (es & 0xFF);
 257 }
 258
 259 /*
 260  * twsi_wait() - Wait for I2C bus interrupt flag and check status, or time out.
 261  *
 262  * @return Zero if status is as expected, or a non-zero code if either a time
 263  *         out occurred, or the status was not the expected one.
 264  */
 265 static int twsi_wait(struct mvtwsi_registers *twsi, int expected_status,
 266                      uint tick)
 267 {
 268         int control, status;
 269         int timeout = 1000;
 270
 271         do {
 272                 control = readl(&twsi->control);
 273                 if (control & MVTWSI_CONTROL_IFLG) {
 274                         /*
 275                          * On Armada 38x it seems that the controller works as
 276                          * if it first set the MVTWSI_CONTROL_IFLAG in the
 277                          * control register and only after that it changed the
 278                          * status register.
 279                          * This sometimes caused weird bugs which only appeared
 280                          * on selected I2C speeds and even then only sometimes.
 281                          * We therefore add here a simple ndealy(100), which
 282                          * seems to fix this weird bug.
 283                          */
 284                         ndelay(100);
 285                         status = readl(&twsi->status);
 286                         if (status == expected_status)
 287                                 return 0;
 288                         else
 289                                 return mvtwsi_error(
 290                                         MVTWSI_ERROR_WRONG_STATUS,
 291                                         control, status, expected_status);
 292                 }
 293                 ndelay(tick); /* One clock cycle */
 294         } while (timeout--);
 295         status = readl(&twsi->status);
 296         return mvtwsi_error(MVTWSI_ERROR_TIMEOUT, control, status,
 297                             expected_status);
 298 }
 299
 300 /*
 301  * twsi_start() - Assert a START condition on the bus.
 302  *
 303  * This function is used in both single I2C transactions and inside
 304  * back-to-back transactions (repeated starts).
 305  *
 306  * @twsi:               The MVTWSI register structure to use.
 307  * @expected_status:    The I2C bus status expected to be asserted after the
 308  *                      operation completion.
 309  * @tick:               The duration of a clock cycle at the current I2C speed.
 310  * @return Zero if status is as expected, or a non-zero code if either a time
 311  *         out occurred or the status was not the expected one.
 312  */
 313 static int twsi_start(struct mvtwsi_registers *twsi, int expected_status,
 314                       uint tick)
 315 {
 316         /* Assert START */
 317         writel(MVTWSI_CONTROL_TWSIEN | MVTWSI_CONTROL_START |
 318                MVTWSI_CONTROL_CLEAR_IFLG, &twsi->control);
 319         /* Wait for controller to process START */
 320         return twsi_wait(twsi, expected_status, tick);
 321 }
 322
 323 /*
 324  * twsi_send() - Send a byte on the I2C bus.
 325  *
 326  * The byte may be part of an address byte or data.
 327  *
 328  * @twsi:               The MVTWSI register structure to use.
 329  * @byte:               The byte to send.
 330  * @expected_status:    The I2C bus status expected to be asserted after the
 331  *                      operation completion.
 332  * @tick:               The duration of a clock cycle at the current I2C speed.
 333  * @return Zero if status is as expected, or a non-zero code if either a time
 334  *         out occurred or the status was not the expected one.
 335  */
 336 static int twsi_send(struct mvtwsi_registers *twsi, u8 byte,
 337                      int expected_status, uint tick)
 338 {
 339         /* Write byte to data register for sending */
 340         writel(byte, &twsi->data);
 341         /* Clear any pending interrupt -- that will cause sending */
 342         writel(MVTWSI_CONTROL_TWSIEN | MVTWSI_CONTROL_CLEAR_IFLG,
 343                &twsi->control);
 344         /* Wait for controller to receive byte, and check ACK */
 345         return twsi_wait(twsi, expected_status, tick);
 346 }
 347
 348 /*
 349  * twsi_recv() - Receive a byte on the I2C bus.
 350  *
 351  * The static variable mvtwsi_control_flags controls whether we ack or nak.
 352  *
 353  * @twsi:               The MVTWSI register structure to use.
 354  * @byte:               The byte to send.
 355  * @ack_flag:           Flag that determines whether the received byte should
 356  *                      be acknowledged by the controller or not (sent ACK/NAK).
 357  * @tick:               The duration of a clock cycle at the current I2C speed.
 358  * @return Zero if status is as expected, or a non-zero code if either a time
 359  *         out occurred or the status was not the expected one.
 360  */
 361 static int twsi_recv(struct mvtwsi_registers *twsi, u8 *byte, int ack_flag,
 362                      uint tick)
 363 {
 364         int expected_status, status, control;
 365
 366         /* Compute expected status based on passed ACK flag */
 367         expected_status = ack_flag ? MVTWSI_STATUS_DATA_R_ACK :
 368                           MVTWSI_STATUS_DATA_R_NAK;
 369         /* Acknowledge *previous state*, and launch receive */
 370         control = MVTWSI_CONTROL_TWSIEN;
 371         control |= ack_flag == MVTWSI_READ_ACK ? MVTWSI_CONTROL_ACK : 0;
 372         writel(control | MVTWSI_CONTROL_CLEAR_IFLG, &twsi->control);
 373         /* Wait for controller to receive byte, and assert ACK or NAK */
 374         status = twsi_wait(twsi, expected_status, tick);
 375         /* If we did receive the expected byte, store it */
 376         if (status == 0)
 377                 *byte = readl(&twsi->data);
 378         return status;
 379 }
 380
 381 /*
 382  * twsi_stop() - Assert a STOP condition on the bus.
 383  *
 384  * This function is also used to force the bus back to idle state (SDA =
 385  * SCL = 1).
 386  *
 387  * @twsi:       The MVTWSI register structure to use.
 388  * @tick:       The duration of a clock cycle at the current I2C speed.
 389  * @return Zero if the operation succeeded, or a non-zero code if a time out
 390  *         occurred.
 391  */
 392 static int twsi_stop(struct mvtwsi_registers *twsi, uint tick)
 393 {
 394         int control, stop_status;
 395         int status = 0;
 396         int timeout = 1000;
 397
 398         /* Assert STOP */
 399         control = MVTWSI_CONTROL_TWSIEN | MVTWSI_CONTROL_STOP;
 400         writel(control | MVTWSI_CONTROL_CLEAR_IFLG, &twsi->control);
 401         /* Wait for IDLE; IFLG won't rise, so we can't use twsi_wait() */
 402         do {
 403                 stop_status = readl(&twsi->status);
 404                 if (stop_status == MVTWSI_STATUS_IDLE)
 405                         break;
 406                 ndelay(tick); /* One clock cycle */
 407         } while (timeout--);
 408         control = readl(&twsi->control);
 409         if (stop_status != MVTWSI_STATUS_IDLE)
 410                 status = mvtwsi_error(MVTWSI_ERROR_TIMEOUT,
 411                                       control, status, MVTWSI_STATUS_IDLE);
 412         return status;
 413 }
 414
 415 /*
 416  * twsi_calc_freq() - Compute I2C frequency depending on m and n parameters.
 417  *
 418  * @n:          Parameter 'n' for the frequency calculation algorithm.
 419  * @m:          Parameter 'm' for the frequency calculation algorithm.
 420  * @return The I2C frequency corresponding to the passed m and n parameters.
 421  */
 422 static uint twsi_calc_freq(const int n, const int m)
 423 {
 424 #ifdef CONFIG_ARCH_SUNXI
 425         return CONFIG_SYS_TCLK / (10 * (m + 1) * (1 << n));
 426 #else
 427         return CONFIG_SYS_TCLK / (10 * (m + 1) * (2 << n));
 428 #endif
 429 }
 430
 431 /*
 432  * twsi_reset() - Reset the I2C controller.
 433  *
 434  * Resetting the controller also resets the baud rate and slave address, hence
 435  * they must be re-established after the reset.
 436  *
 437  * @twsi:       The MVTWSI register structure to use.
 438  */
 439 static void twsi_reset(struct mvtwsi_registers *twsi)
 440 {
 441         /* Reset controller */
 442         writel(0, &twsi->soft_reset);
 443         /* Wait 2 ms -- this is what the Marvell LSP does */
 444         udelay(20000);
 445 }
 446
 447 /*
 448  * __twsi_i2c_set_bus_speed() - Set the speed of the I2C controller.
 449  *
 450  * This function sets baud rate to the highest possible value that does not
 451  * exceed the requested rate.
 452  *
 453  * @twsi:               The MVTWSI register structure to use.
 454  * @requested_speed:    The desired frequency the controller should run at
 455  *                      in Hz.
 456  * @return The actual frequency the controller was configured to.
 457  */
 458 static uint __twsi_i2c_set_bus_speed(struct mvtwsi_registers *twsi,
 459                                      uint requested_speed)
 460 {
 461         uint tmp_speed, highest_speed, n, m;
 462         uint baud = 0x44; /* Baud rate after controller reset */
 463
 464         highest_speed = 0;
 465         /* Successively try m, n combinations, and use the combination
 466          * resulting in the largest speed that's not above the requested
 467          * speed */
 468         for (n = 0; n < 8; n++) {
 469                 for (m = 0; m < 16; m++) {
 470                         tmp_speed = twsi_calc_freq(n, m);
 471                         if ((tmp_speed <= requested_speed) &&
 472                             (tmp_speed > highest_speed)) {
 473                                 highest_speed = tmp_speed;
 474                                 baud = (m << 3) | n;
 475                         }
 476                 }
 477         }
 478         writel(baud, &twsi->baudrate);
 479
 480         /* Wait for controller for one tick */
 481 #ifdef CONFIG_DM_I2C
 482         ndelay(calc_tick(highest_speed));
 483 #else
 484         ndelay(10000);
 485 #endif
 486         return highest_speed;
 487 }
 488
 489 /*
 490  * __twsi_i2c_init() - Initialize the I2C controller.
 491  *
 492  * @twsi:               The MVTWSI register structure to use.
 493  * @speed:              The initial frequency the controller should run at
 494  *                      in Hz.
 495  * @slaveadd:           The I2C address to be set for the I2C master.
 496  * @actual_speed:       A output parameter that receives the actual frequency
 497  *                      in Hz the controller was set to by the function.
 498  * @return Zero if the operation succeeded, or a non-zero code if a time out
 499  *         occurred.
 500  */
 501 static void __twsi_i2c_init(struct mvtwsi_registers *twsi, int speed,
 502                             int slaveadd, uint *actual_speed)
 503 {
 504         uint tmp_speed;
 505
 506         /* Reset controller */
 507         twsi_reset(twsi);
 508         /* Set speed */
 509         tmp_speed = __twsi_i2c_set_bus_speed(twsi, speed);
 510         if (actual_speed)
 511                 *actual_speed = tmp_speed;
 512         /* Set slave address; even though we don't use it */
 513         writel(slaveadd, &twsi->slave_address);
 514         writel(0, &twsi->xtnd_slave_addr);
 515         /* Assert STOP, but don't care for the result */
 516 #ifdef CONFIG_DM_I2C
 517         (void) twsi_stop(twsi, calc_tick(*actual_speed));
 518 #else
 519         (void) twsi_stop(twsi, 10000);
 520 #endif
 521 }
 522
 523 /*
 524  * i2c_begin() - Start a I2C transaction.
 525  *
 526  * Begin a I2C transaction with a given expected start status and chip address.
 527  * A START is asserted, and the address byte is sent to the I2C controller. The
 528  * expected address status will be derived from the direction bit (bit 0) of
 529  * the address byte.
 530  *
 531  * @twsi:                       The MVTWSI register structure to use.
 532  * @expected_start_status:      The I2C status the controller is expected to
 533  *                              assert after the address byte was sent.
 534  * @addr:                       The address byte to be sent.
 535  * @tick:                       The duration of a clock cycle at the current
 536  *                              I2C speed.
 537  * @return Zero if the operation succeeded, or a non-zero code if a time out or
 538  *         unexpected I2C status occurred.
 539  */
 540 static int i2c_begin(struct mvtwsi_registers *twsi, int expected_start_status,
 541                      u8 addr, uint tick)
 542 {
 543         int status, expected_addr_status;
 544
 545         /* Compute the expected address status from the direction bit in
 546          * the address byte */
 547         if (addr & 1) /* Reading */
 548                 expected_addr_status = MVTWSI_STATUS_ADDR_R_ACK;
 549         else /* Writing */
 550                 expected_addr_status = MVTWSI_STATUS_ADDR_W_ACK;
 551         /* Assert START */
 552         status = twsi_start(twsi, expected_start_status, tick);
 553         /* Send out the address if the start went well */
 554         if (status == 0)
 555                 status = twsi_send(twsi, addr, expected_addr_status, tick);
 556         /* Return 0, or the status of the first failure */
 557         return status;
 558 }
 559
 560 /*
 561  * __twsi_i2c_probe_chip() - Probe the given I2C chip address.
 562  *
 563  * This function begins a I2C read transaction, does a dummy read and NAKs; if
 564  * the procedure succeeds, the chip is considered to be present.
 565  *
 566  * @twsi:       The MVTWSI register structure to use.
 567  * @chip:       The chip address to probe.
 568  * @tick:       The duration of a clock cycle at the current I2C speed.
 569  * @return Zero if the operation succeeded, or a non-zero code if a time out or
 570  *         unexpected I2C status occurred.
 571  */
 572 static int __twsi_i2c_probe_chip(struct mvtwsi_registers *twsi, uchar chip,
 573                                  uint tick)
 574 {
 575         u8 dummy_byte;
 576         int status;
 577
 578         /* Begin i2c read */
 579         status = i2c_begin(twsi, MVTWSI_STATUS_START, (chip << 1) | 1, tick);
 580         /* Dummy read was accepted: receive byte, but NAK it. */
 581         if (status == 0)
 582                 status = twsi_recv(twsi, &dummy_byte, MVTWSI_READ_NAK, tick);
 583         /* Stop transaction */
 584         twsi_stop(twsi, tick);
 585         /* Return 0, or the status of the first failure */
 586         return status;
 587 }
 588
 589 /*
 590  * __twsi_i2c_read() - Read data from a I2C chip.
 591  *
 592  * This function begins a I2C write transaction, and transmits the address
 593  * bytes; then begins a I2C read transaction, and receives the data bytes.
 594  *
 595  * NOTE: Some devices want a stop right before the second start, while some
 596  * will choke if it is there. Since deciding this is not yet supported in
 597  * higher level APIs, we need to make a decision here, and for the moment that
 598  * will be a repeated start without a preceding stop.
 599  *
 600  * @twsi:       The MVTWSI register structure to use.
 601  * @chip:       The chip address to read from.
 602  * @addr:       The address bytes to send.
 603  * @alen:       The length of the address bytes in bytes.
 604  * @data:       The buffer to receive the data read from the chip (has to have
 605  *              a size of at least 'length' bytes).
 606  * @length:     The amount of data to be read from the chip in bytes.
 607  * @tick:       The duration of a clock cycle at the current I2C speed.
 608  * @return Zero if the operation succeeded, or a non-zero code if a time out or
 609  *         unexpected I2C status occurred.
 610  */
 611 static int __twsi_i2c_read(struct mvtwsi_registers *twsi, uchar chip,
 612                            u8 *addr, int alen, uchar *data, int length,
 613                            uint tick)
 614 {
 615         int status = 0;
 616         int stop_status;
 617         int expected_start = MVTWSI_STATUS_START;
 618
 619         if (alen > 0) {
 620                 /* Begin i2c write to send the address bytes */
 621                 status = i2c_begin(twsi, expected_start, (chip << 1), tick);
 622                 /* Send address bytes */
 623                 while ((status == 0) && alen--)
 624                         status = twsi_send(twsi, addr[alen],
 625                                            MVTWSI_STATUS_DATA_W_ACK, tick);
 626                 /* Send repeated STARTs after the initial START */
 627                 expected_start = MVTWSI_STATUS_REPEATED_START;
 628         }
 629         /* Begin i2c read to receive data bytes */
 630         if (status == 0)
 631                 status = i2c_begin(twsi, expected_start, (chip << 1) | 1, tick);
 632         /* Receive actual data bytes; set NAK if we if we have nothing more to
 633          * read */
 634         while ((status == 0) && length--)
 635                 status = twsi_recv(twsi, data++,
 636                                    length > 0 ?
 637                                    MVTWSI_READ_ACK : MVTWSI_READ_NAK, tick);
 638         /* Stop transaction */
 639         stop_status = twsi_stop(twsi, tick);
 640         /* Return 0, or the status of the first failure */
 641         return status != 0 ? status : stop_status;
 642 }
 643
 644 /*
 645  * __twsi_i2c_write() - Send data to a I2C chip.
 646  *
 647  * This function begins a I2C write transaction, and transmits the address
 648  * bytes; then begins a new I2C write transaction, and sends the data bytes.
 649  *
 650  * @twsi:       The MVTWSI register structure to use.
 651  * @chip:       The chip address to read from.
 652  * @addr:       The address bytes to send.
 653  * @alen:       The length of the address bytes in bytes.
 654  * @data:       The buffer containing the data to be sent to the chip.
 655  * @length:     The length of data to be sent to the chip in bytes.
 656  * @tick:       The duration of a clock cycle at the current I2C speed.
 657  * @return Zero if the operation succeeded, or a non-zero code if a time out or
 658  *         unexpected I2C status occurred.
 659  */
 660 static int __twsi_i2c_write(struct mvtwsi_registers *twsi, uchar chip,
 661                             u8 *addr, int alen, uchar *data, int length,
 662                             uint tick)
 663 {
 664         int status, stop_status;
 665
 666         /* Begin i2c write to send first the address bytes, then the
 667          * data bytes */
 668         status = i2c_begin(twsi, MVTWSI_STATUS_START, (chip << 1), tick);
 669         /* Send address bytes */
 670         while ((status == 0) && (alen-- > 0))
 671                 status = twsi_send(twsi, addr[alen], MVTWSI_STATUS_DATA_W_ACK,
 672                                    tick);
 673         /* Send data bytes */
 674         while ((status == 0) && (length-- > 0))
 675                 status = twsi_send(twsi, *(data++), MVTWSI_STATUS_DATA_W_ACK,
 676                                    tick);
 677         /* Stop transaction */
 678         stop_status = twsi_stop(twsi, tick);
 679         /* Return 0, or the status of the first failure */
 680         return status != 0 ? status : stop_status;
 681 }
 682
 683 #ifndef CONFIG_DM_I2C
 684 static void twsi_i2c_init(struct i2c_adapter *adap, int speed,
 685                           int slaveadd)
 686 {
 687         struct mvtwsi_registers *twsi = twsi_get_base(adap);
 688         __twsi_i2c_init(twsi, speed, slaveadd, NULL);
 689 }
 690
 691 static uint twsi_i2c_set_bus_speed(struct i2c_adapter *adap,
 692                                    uint requested_speed)
 693 {
 694         struct mvtwsi_registers *twsi = twsi_get_base(adap);
 695         __twsi_i2c_set_bus_speed(twsi, requested_speed);
 696         return 0;
 697 }
 698
 699 static int twsi_i2c_probe(struct i2c_adapter *adap, uchar chip)
 700 {
 701         struct mvtwsi_registers *twsi = twsi_get_base(adap);
 702         return __twsi_i2c_probe_chip(twsi, chip, 10000);
 703 }
 704
 705 static int twsi_i2c_read(struct i2c_adapter *adap, uchar chip, uint addr,
 706                          int alen, uchar *data, int length)
 707 {
 708         struct mvtwsi_registers *twsi = twsi_get_base(adap);
 709         u8 addr_bytes[4];
 710
 711         addr_bytes[0] = (addr >> 0) & 0xFF;
 712         addr_bytes[1] = (addr >> 8) & 0xFF;
 713         addr_bytes[2] = (addr >> 16) & 0xFF;
 714         addr_bytes[3] = (addr >> 24) & 0xFF;
 715
 716         return __twsi_i2c_read(twsi, chip, addr_bytes, alen, data, length,
 717                                10000);
 718 }
 719
 720 static int twsi_i2c_write(struct i2c_adapter *adap, uchar chip, uint addr,
 721                           int alen, uchar *data, int length)
 722 {
 723         struct mvtwsi_registers *twsi = twsi_get_base(adap);
 724         u8 addr_bytes[4];
 725
 726         addr_bytes[0] = (addr >> 0) & 0xFF;
 727         addr_bytes[1] = (addr >> 8) & 0xFF;
 728         addr_bytes[2] = (addr >> 16) & 0xFF;
 729         addr_bytes[3] = (addr >> 24) & 0xFF;
 730
 731         return __twsi_i2c_write(twsi, chip, addr_bytes, alen, data, length,
 732                                 10000);
 733 }
 734
 735 #ifdef CONFIG_I2C_MVTWSI_BASE0
 736 U_BOOT_I2C_ADAP_COMPLETE(twsi0, twsi_i2c_init, twsi_i2c_probe,
 737                          twsi_i2c_read, twsi_i2c_write,
 738                          twsi_i2c_set_bus_speed,
 739                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 0)
 740 #endif
 741 #ifdef CONFIG_I2C_MVTWSI_BASE1
 742 U_BOOT_I2C_ADAP_COMPLETE(twsi1, twsi_i2c_init, twsi_i2c_probe,
 743                          twsi_i2c_read, twsi_i2c_write,
 744                          twsi_i2c_set_bus_speed,
 745                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 1)
 746
 747 #endif
 748 #ifdef CONFIG_I2C_MVTWSI_BASE2
 749 U_BOOT_I2C_ADAP_COMPLETE(twsi2, twsi_i2c_init, twsi_i2c_probe,
 750                          twsi_i2c_read, twsi_i2c_write,
 751                          twsi_i2c_set_bus_speed,
 752                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 2)
 753
 754 #endif
 755 #ifdef CONFIG_I2C_MVTWSI_BASE3
 756 U_BOOT_I2C_ADAP_COMPLETE(twsi3, twsi_i2c_init, twsi_i2c_probe,
 757                          twsi_i2c_read, twsi_i2c_write,
 758                          twsi_i2c_set_bus_speed,
 759                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 3)
 760
 761 #endif
 762 #ifdef CONFIG_I2C_MVTWSI_BASE4
 763 U_BOOT_I2C_ADAP_COMPLETE(twsi4, twsi_i2c_init, twsi_i2c_probe,
 764                          twsi_i2c_read, twsi_i2c_write,
 765                          twsi_i2c_set_bus_speed,
 766                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 4)
 767
 768 #endif
 769 #ifdef CONFIG_I2C_MVTWSI_BASE5
 770 U_BOOT_I2C_ADAP_COMPLETE(twsi5, twsi_i2c_init, twsi_i2c_probe,
 771                          twsi_i2c_read, twsi_i2c_write,
 772                          twsi_i2c_set_bus_speed,
 773                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 5)
 774
 775 #endif
 776 #else /* CONFIG_DM_I2C */
 777
 778 static int mvtwsi_i2c_probe_chip(struct udevice *bus, u32 chip_addr,
 779                                  u32 chip_flags)
 780 {
 781         struct mvtwsi_i2c_dev *dev = dev_get_priv(bus);
 782         return __twsi_i2c_probe_chip(dev->base, chip_addr, dev->tick);
 783 }
 784
 785 static int mvtwsi_i2c_set_bus_speed(struct udevice *bus, uint speed)
 786 {
 787         struct mvtwsi_i2c_dev *dev = dev_get_priv(bus);
 788
 789         dev->speed = __twsi_i2c_set_bus_speed(dev->base, speed);
 790         dev->tick = calc_tick(dev->speed);
 791
 792         return 0;
 793 }
 794
 795 static int mvtwsi_i2c_ofdata_to_platdata(struct udevice *bus)
 796 {
 797         struct mvtwsi_i2c_dev *dev = dev_get_priv(bus);
 798
 799         dev->base = devfdt_get_addr_ptr(bus);
 800
 801         if (!dev->base)
 802                 return -ENOMEM;
 803
 804         dev->index = fdtdec_get_int(gd->fdt_blob, dev_of_offset(bus),
 805                                     "cell-index", -1);
 806         dev->slaveadd = fdtdec_get_int(gd->fdt_blob, dev_of_offset(bus),
 807                                        "u-boot,i2c-slave-addr", 0x0);
 808         dev->speed = dev_read_u32_default(bus, "clock-frequency",
 809                                           I2C_SPEED_STANDARD_RATE);
 810
 811         return 0;
 812 }
 813
 814 static void twsi_disable_i2c_slave(struct mvtwsi_registers *twsi)
 815 {
 816         clrbits_le32(&twsi->debug, BIT(18));
 817 }
 818
 819 static int mvtwsi_i2c_bind(struct udevice *bus)
 820 {
 821         struct mvtwsi_registers *twsi = devfdt_get_addr_ptr(bus);
 822
 823         /* Disable the hidden slave in i2c0 of these platforms */
 824         if ((IS_ENABLED(CONFIG_ARMADA_38X) || IS_ENABLED(CONFIG_KIRKWOOD))
 825                         && bus->req_seq == 0)
 826                 twsi_disable_i2c_slave(twsi);
 827
 828         return 0;
 829 }
 830
 831 static int mvtwsi_i2c_probe(struct udevice *bus)
 832 {
 833         struct mvtwsi_i2c_dev *dev = dev_get_priv(bus);
 834         uint actual_speed;
 835
 836         __twsi_i2c_init(dev->base, dev->speed, dev->slaveadd, &actual_speed);
 837         dev->speed = actual_speed;
 838         dev->tick = calc_tick(dev->speed);
 839         return 0;
 840 }
 841
 842 static int mvtwsi_i2c_xfer(struct udevice *bus, struct i2c_msg *msg, int nmsgs)
 843 {
 844         struct mvtwsi_i2c_dev *dev = dev_get_priv(bus);
 845         struct i2c_msg *dmsg, *omsg, dummy;
 846
 847         memset(&dummy, 0, sizeof(struct i2c_msg));
 848
 849         /* We expect either two messages (one with an offset and one with the
 850          * actual data) or one message (just data or offset/data combined) */
 851         if (nmsgs > 2 || nmsgs == 0) {
 852                 debug("%s: Only one or two messages are supported.", __func__);
 853                 return -1;
 854         }
 855
 856         omsg = nmsgs == 1 ? &dummy : msg;
 857         dmsg = nmsgs == 1 ? msg : msg + 1;
 858
 859         if (dmsg->flags & I2C_M_RD)
 860                 return __twsi_i2c_read(dev->base, dmsg->addr, omsg->buf,
 861                                        omsg->len, dmsg->buf, dmsg->len,
 862                                        dev->tick);
 863         else
 864                 return __twsi_i2c_write(dev->base, dmsg->addr, omsg->buf,
 865                                         omsg->len, dmsg->buf, dmsg->len,
 866                                         dev->tick);
 867 }
 868
 869 static const struct dm_i2c_ops mvtwsi_i2c_ops = {
 870         .xfer           = mvtwsi_i2c_xfer,
 871         .probe_chip     = mvtwsi_i2c_probe_chip,
 872         .set_bus_speed  = mvtwsi_i2c_set_bus_speed,
 873 };
 874
 875 static const struct udevice_id mvtwsi_i2c_ids[] = {
 876         { .compatible = "marvell,mv64xxx-i2c", },
 877         { .compatible = "marvell,mv78230-i2c", },
 878         { .compatible = "allwinner,sun6i-a31-i2c", },
 879         { /* sentinel */ }
 880 };
 881
 882 U_BOOT_DRIVER(i2c_mvtwsi) = {
 883         .name = "i2c_mvtwsi",
 884         .id = UCLASS_I2C,
 885         .of_match = mvtwsi_i2c_ids,
 886         .bind = mvtwsi_i2c_bind,
 887         .probe = mvtwsi_i2c_probe,
 888         .ofdata_to_platdata = mvtwsi_i2c_ofdata_to_platdata,
 889         .priv_auto_alloc_size = sizeof(struct mvtwsi_i2c_dev),
 890         .ops = &mvtwsi_i2c_ops,
 891 };
 892 #endif /* CONFIG_DM_I2C */