drivers/i2c/busses/i2c-aspeed.c

   1 /*
   2  *  Aspeed 24XX/25XX I2C Controller.
   3  *
   4  *  Copyright (C) 2012-2017 ASPEED Technology Inc.
   5  *  Copyright 2017 IBM Corporation
   6  *  Copyright 2017 Google, Inc.
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License version 2 as
  10  *  published by the Free Software Foundation.
  11  */
  12
  13 #include <linux/clk.h>
  14 #include <linux/completion.h>
  15 #include <linux/err.h>
  16 #include <linux/errno.h>
  17 #include <linux/i2c.h>
  18 #include <linux/init.h>
  19 #include <linux/interrupt.h>
  20 #include <linux/io.h>
  21 #include <linux/irq.h>
  22 #include <linux/irqchip/chained_irq.h>
  23 #include <linux/irqdomain.h>
  24 #include <linux/kernel.h>
  25 #include <linux/module.h>
  26 #include <linux/of_address.h>
  27 #include <linux/of_irq.h>
  28 #include <linux/of_platform.h>
  29 #include <linux/platform_device.h>
  30 #include <linux/slab.h>
  31
  32 /* I2C Register */
  33 #define ASPEED_I2C_FUN_CTRL_REG                         0x00
  34 #define ASPEED_I2C_AC_TIMING_REG1                       0x04
  35 #define ASPEED_I2C_AC_TIMING_REG2                       0x08
  36 #define ASPEED_I2C_INTR_CTRL_REG                        0x0c
  37 #define ASPEED_I2C_INTR_STS_REG                         0x10
  38 #define ASPEED_I2C_CMD_REG                              0x14
  39 #define ASPEED_I2C_DEV_ADDR_REG                         0x18
  40 #define ASPEED_I2C_BYTE_BUF_REG                         0x20
  41
  42 /* Global Register Definition */
  43 /* 0x00 : I2C Interrupt Status Register  */
  44 /* 0x08 : I2C Interrupt Target Assignment  */
  45
  46 /* Device Register Definition */
  47 /* 0x00 : I2CD Function Control Register  */
  48 #define ASPEED_I2CD_MULTI_MASTER_DIS                    BIT(15)
  49 #define ASPEED_I2CD_SDA_DRIVE_1T_EN                     BIT(8)
  50 #define ASPEED_I2CD_M_SDA_DRIVE_1T_EN                   BIT(7)
  51 #define ASPEED_I2CD_M_HIGH_SPEED_EN                     BIT(6)
  52 #define ASPEED_I2CD_SLAVE_EN                            BIT(1)
  53 #define ASPEED_I2CD_MASTER_EN                           BIT(0)
  54
  55 /* 0x04 : I2CD Clock and AC Timing Control Register #1 */
  56 #define ASPEED_I2CD_TIME_SCL_HIGH_SHIFT                 16
  57 #define ASPEED_I2CD_TIME_SCL_HIGH_MASK                  GENMASK(19, 16)
  58 #define ASPEED_I2CD_TIME_SCL_LOW_SHIFT                  12
  59 #define ASPEED_I2CD_TIME_SCL_LOW_MASK                   GENMASK(15, 12)
  60 #define ASPEED_I2CD_TIME_BASE_DIVISOR_MASK              GENMASK(3, 0)
  61 #define ASPEED_I2CD_TIME_SCL_REG_MAX                    GENMASK(3, 0)
  62 /* 0x08 : I2CD Clock and AC Timing Control Register #2 */
  63 #define ASPEED_NO_TIMEOUT_CTRL                          0
  64
  65 /* 0x0c : I2CD Interrupt Control Register &
  66  * 0x10 : I2CD Interrupt Status Register
  67  *
  68  * These share bit definitions, so use the same values for the enable &
  69  * status bits.
  70  */
  71 #define ASPEED_I2CD_INTR_SDA_DL_TIMEOUT                 BIT(14)
  72 #define ASPEED_I2CD_INTR_BUS_RECOVER_DONE               BIT(13)
  73 #define ASPEED_I2CD_INTR_SLAVE_MATCH                    BIT(7)
  74 #define ASPEED_I2CD_INTR_SCL_TIMEOUT                    BIT(6)
  75 #define ASPEED_I2CD_INTR_ABNORMAL                       BIT(5)
  76 #define ASPEED_I2CD_INTR_NORMAL_STOP                    BIT(4)
  77 #define ASPEED_I2CD_INTR_ARBIT_LOSS                     BIT(3)
  78 #define ASPEED_I2CD_INTR_RX_DONE                        BIT(2)
  79 #define ASPEED_I2CD_INTR_TX_NAK                         BIT(1)
  80 #define ASPEED_I2CD_INTR_TX_ACK                         BIT(0)
  81 #define ASPEED_I2CD_INTR_ALL                                                   \
  82                 (ASPEED_I2CD_INTR_SDA_DL_TIMEOUT |                             \
  83                  ASPEED_I2CD_INTR_BUS_RECOVER_DONE |                           \
  84                  ASPEED_I2CD_INTR_SCL_TIMEOUT |                                \
  85                  ASPEED_I2CD_INTR_ABNORMAL |                                   \
  86                  ASPEED_I2CD_INTR_NORMAL_STOP |                                \
  87                  ASPEED_I2CD_INTR_ARBIT_LOSS |                                 \
  88                  ASPEED_I2CD_INTR_RX_DONE |                                    \
  89                  ASPEED_I2CD_INTR_TX_NAK |                                     \
  90                  ASPEED_I2CD_INTR_TX_ACK)
  91
  92 /* 0x14 : I2CD Command/Status Register   */
  93 #define ASPEED_I2CD_SCL_LINE_STS                        BIT(18)
  94 #define ASPEED_I2CD_SDA_LINE_STS                        BIT(17)
  95 #define ASPEED_I2CD_BUS_BUSY_STS                        BIT(16)
  96 #define ASPEED_I2CD_BUS_RECOVER_CMD                     BIT(11)
  97
  98 /* Command Bit */
  99 #define ASPEED_I2CD_M_STOP_CMD                          BIT(5)
 100 #define ASPEED_I2CD_M_S_RX_CMD_LAST                     BIT(4)
 101 #define ASPEED_I2CD_M_RX_CMD                            BIT(3)
 102 #define ASPEED_I2CD_S_TX_CMD                            BIT(2)
 103 #define ASPEED_I2CD_M_TX_CMD                            BIT(1)
 104 #define ASPEED_I2CD_M_START_CMD                         BIT(0)
 105
 106 /* 0x18 : I2CD Slave Device Address Register   */
 107 #define ASPEED_I2CD_DEV_ADDR_MASK                       GENMASK(6, 0)
 108
 109 enum aspeed_i2c_master_state {
 110         ASPEED_I2C_MASTER_START,
 111         ASPEED_I2C_MASTER_TX_FIRST,
 112         ASPEED_I2C_MASTER_TX,
 113         ASPEED_I2C_MASTER_RX_FIRST,
 114         ASPEED_I2C_MASTER_RX,
 115         ASPEED_I2C_MASTER_STOP,
 116         ASPEED_I2C_MASTER_INACTIVE,
 117 };
 118
 119 enum aspeed_i2c_slave_state {
 120         ASPEED_I2C_SLAVE_START,
 121         ASPEED_I2C_SLAVE_READ_REQUESTED,
 122         ASPEED_I2C_SLAVE_READ_PROCESSED,
 123         ASPEED_I2C_SLAVE_WRITE_REQUESTED,
 124         ASPEED_I2C_SLAVE_WRITE_RECEIVED,
 125         ASPEED_I2C_SLAVE_STOP,
 126 };
 127
 128 struct aspeed_i2c_bus {
 129         struct i2c_adapter              adap;
 130         struct device                   *dev;
 131         void __iomem                    *base;
 132         /* Synchronizes I/O mem access to base. */
 133         spinlock_t                      lock;
 134         struct completion               cmd_complete;
 135         unsigned long                   parent_clk_frequency;
 136         u32                             bus_frequency;
 137         /* Transaction state. */
 138         enum aspeed_i2c_master_state    master_state;
 139         struct i2c_msg                  *msgs;
 140         size_t                          buf_index;
 141         size_t                          msgs_index;
 142         size_t                          msgs_count;
 143         bool                            send_stop;
 144         int                             cmd_err;
 145         /* Protected only by i2c_lock_bus */
 146         int                             master_xfer_result;
 147 #if IS_ENABLED(CONFIG_I2C_SLAVE)
 148         struct i2c_client               *slave;
 149         enum aspeed_i2c_slave_state     slave_state;
 150 #endif /* CONFIG_I2C_SLAVE */
 151 };
 152
 153 static int aspeed_i2c_reset(struct aspeed_i2c_bus *bus);
 154
 155 static int aspeed_i2c_recover_bus(struct aspeed_i2c_bus *bus)
 156 {
 157         unsigned long time_left, flags;
 158         int ret = 0;
 159         u32 command;
 160
 161         spin_lock_irqsave(&bus->lock, flags);
 162         command = readl(bus->base + ASPEED_I2C_CMD_REG);
 163
 164         if (command & ASPEED_I2CD_SDA_LINE_STS) {
 165                 /* Bus is idle: no recovery needed. */
 166                 if (command & ASPEED_I2CD_SCL_LINE_STS)
 167                         goto out;
 168                 dev_dbg(bus->dev, "SCL hung (state %x), attempting recovery\n",
 169                         command);
 170
 171                 reinit_completion(&bus->cmd_complete);
 172                 writel(ASPEED_I2CD_M_STOP_CMD, bus->base + ASPEED_I2C_CMD_REG);
 173                 spin_unlock_irqrestore(&bus->lock, flags);
 174
 175                 time_left = wait_for_completion_timeout(
 176                                 &bus->cmd_complete, bus->adap.timeout);
 177
 178                 spin_lock_irqsave(&bus->lock, flags);
 179                 if (time_left == 0)
 180                         goto reset_out;
 181                 else if (bus->cmd_err)
 182                         goto reset_out;
 183                 /* Recovery failed. */
 184                 else if (!(readl(bus->base + ASPEED_I2C_CMD_REG) &
 185                            ASPEED_I2CD_SCL_LINE_STS))
 186                         goto reset_out;
 187         /* Bus error. */
 188         } else {
 189                 dev_dbg(bus->dev, "SDA hung (state %x), attempting recovery\n",
 190                         command);
 191
 192                 reinit_completion(&bus->cmd_complete);
 193                 /* Writes 1 to 8 SCL clock cycles until SDA is released. */
 194                 writel(ASPEED_I2CD_BUS_RECOVER_CMD,
 195                        bus->base + ASPEED_I2C_CMD_REG);
 196                 spin_unlock_irqrestore(&bus->lock, flags);
 197
 198                 time_left = wait_for_completion_timeout(
 199                                 &bus->cmd_complete, bus->adap.timeout);
 200
 201                 spin_lock_irqsave(&bus->lock, flags);
 202                 if (time_left == 0)
 203                         goto reset_out;
 204                 else if (bus->cmd_err)
 205                         goto reset_out;
 206                 /* Recovery failed. */
 207                 else if (!(readl(bus->base + ASPEED_I2C_CMD_REG) &
 208                            ASPEED_I2CD_SDA_LINE_STS))
 209                         goto reset_out;
 210         }
 211
 212 out:
 213         spin_unlock_irqrestore(&bus->lock, flags);
 214
 215         return ret;
 216
 217 reset_out:
 218         spin_unlock_irqrestore(&bus->lock, flags);
 219
 220         return aspeed_i2c_reset(bus);
 221 }
 222
 223 #if IS_ENABLED(CONFIG_I2C_SLAVE)
 224 static bool aspeed_i2c_slave_irq(struct aspeed_i2c_bus *bus)
 225 {
 226         u32 command, irq_status, status_ack = 0;
 227         struct i2c_client *slave = bus->slave;
 228         bool irq_handled = true;
 229         u8 value;
 230
 231         spin_lock(&bus->lock);
 232         if (!slave) {
 233                 irq_handled = false;
 234                 goto out;
 235         }
 236
 237         command = readl(bus->base + ASPEED_I2C_CMD_REG);
 238         irq_status = readl(bus->base + ASPEED_I2C_INTR_STS_REG);
 239
 240         /* Slave was requested, restart state machine. */
 241         if (irq_status & ASPEED_I2CD_INTR_SLAVE_MATCH) {
 242                 status_ack |= ASPEED_I2CD_INTR_SLAVE_MATCH;
 243                 bus->slave_state = ASPEED_I2C_SLAVE_START;
 244         }
 245
 246         /* Slave is not currently active, irq was for someone else. */
 247         if (bus->slave_state == ASPEED_I2C_SLAVE_STOP) {
 248                 irq_handled = false;
 249                 goto out;
 250         }
 251
 252         dev_dbg(bus->dev, "slave irq status 0x%08x, cmd 0x%08x\n",
 253                 irq_status, command);
 254
 255         /* Slave was sent something. */
 256         if (irq_status & ASPEED_I2CD_INTR_RX_DONE) {
 257                 value = readl(bus->base + ASPEED_I2C_BYTE_BUF_REG) >> 8;
 258                 /* Handle address frame. */
 259                 if (bus->slave_state == ASPEED_I2C_SLAVE_START) {
 260                         if (value & 0x1)
 261                                 bus->slave_state =
 262                                                 ASPEED_I2C_SLAVE_READ_REQUESTED;
 263                         else
 264                                 bus->slave_state =
 265                                                 ASPEED_I2C_SLAVE_WRITE_REQUESTED;
 266                 }
 267                 status_ack |= ASPEED_I2CD_INTR_RX_DONE;
 268         }
 269
 270         /* Slave was asked to stop. */
 271         if (irq_status & ASPEED_I2CD_INTR_NORMAL_STOP) {
 272                 status_ack |= ASPEED_I2CD_INTR_NORMAL_STOP;
 273                 bus->slave_state = ASPEED_I2C_SLAVE_STOP;
 274         }
 275         if (irq_status & ASPEED_I2CD_INTR_TX_NAK) {
 276                 status_ack |= ASPEED_I2CD_INTR_TX_NAK;
 277                 bus->slave_state = ASPEED_I2C_SLAVE_STOP;
 278         }
 279
 280         switch (bus->slave_state) {
 281         case ASPEED_I2C_SLAVE_READ_REQUESTED:
 282                 if (irq_status & ASPEED_I2CD_INTR_TX_ACK)
 283                         dev_err(bus->dev, "Unexpected ACK on read request.\n");
 284                 bus->slave_state = ASPEED_I2C_SLAVE_READ_PROCESSED;
 285
 286                 i2c_slave_event(slave, I2C_SLAVE_READ_REQUESTED, &value);
 287                 writel(value, bus->base + ASPEED_I2C_BYTE_BUF_REG);
 288                 writel(ASPEED_I2CD_S_TX_CMD, bus->base + ASPEED_I2C_CMD_REG);
 289                 break;
 290         case ASPEED_I2C_SLAVE_READ_PROCESSED:
 291                 status_ack |= ASPEED_I2CD_INTR_TX_ACK;
 292                 if (!(irq_status & ASPEED_I2CD_INTR_TX_ACK))
 293                         dev_err(bus->dev,
 294                                 "Expected ACK after processed read.\n");
 295                 i2c_slave_event(slave, I2C_SLAVE_READ_PROCESSED, &value);
 296                 writel(value, bus->base + ASPEED_I2C_BYTE_BUF_REG);
 297                 writel(ASPEED_I2CD_S_TX_CMD, bus->base + ASPEED_I2C_CMD_REG);
 298                 break;
 299         case ASPEED_I2C_SLAVE_WRITE_REQUESTED:
 300                 bus->slave_state = ASPEED_I2C_SLAVE_WRITE_RECEIVED;
 301                 i2c_slave_event(slave, I2C_SLAVE_WRITE_REQUESTED, &value);
 302                 break;
 303         case ASPEED_I2C_SLAVE_WRITE_RECEIVED:
 304                 i2c_slave_event(slave, I2C_SLAVE_WRITE_RECEIVED, &value);
 305                 break;
 306         case ASPEED_I2C_SLAVE_STOP:
 307                 i2c_slave_event(slave, I2C_SLAVE_STOP, &value);
 308                 break;
 309         default:
 310                 dev_err(bus->dev, "unhandled slave_state: %d\n",
 311                         bus->slave_state);
 312                 break;
 313         }
 314
 315         if (status_ack != irq_status)
 316                 dev_err(bus->dev,
 317                         "irq handled != irq. expected %x, but was %x\n",
 318                         irq_status, status_ack);
 319         writel(status_ack, bus->base + ASPEED_I2C_INTR_STS_REG);
 320
 321 out:
 322         spin_unlock(&bus->lock);
 323         return irq_handled;
 324 }
 325 #endif /* CONFIG_I2C_SLAVE */
 326
 327 /* precondition: bus.lock has been acquired. */
 328 static void aspeed_i2c_do_start(struct aspeed_i2c_bus *bus)
 329 {
 330         u32 command = ASPEED_I2CD_M_START_CMD | ASPEED_I2CD_M_TX_CMD;
 331         struct i2c_msg *msg = &bus->msgs[bus->msgs_index];
 332         u8 slave_addr = msg->addr << 1;
 333
 334         bus->master_state = ASPEED_I2C_MASTER_START;
 335         bus->buf_index = 0;
 336
 337         if (msg->flags & I2C_M_RD) {
 338                 slave_addr |= 1;
 339                 command |= ASPEED_I2CD_M_RX_CMD;
 340                 /* Need to let the hardware know to NACK after RX. */
 341                 if (msg->len == 1 && !(msg->flags & I2C_M_RECV_LEN))
 342                         command |= ASPEED_I2CD_M_S_RX_CMD_LAST;
 343         }
 344
 345         writel(slave_addr, bus->base + ASPEED_I2C_BYTE_BUF_REG);
 346         writel(command, bus->base + ASPEED_I2C_CMD_REG);
 347 }
 348
 349 /* precondition: bus.lock has been acquired. */
 350 static void aspeed_i2c_do_stop(struct aspeed_i2c_bus *bus)
 351 {
 352         bus->master_state = ASPEED_I2C_MASTER_STOP;
 353         writel(ASPEED_I2CD_M_STOP_CMD, bus->base + ASPEED_I2C_CMD_REG);
 354 }
 355
 356 /* precondition: bus.lock has been acquired. */
 357 static void aspeed_i2c_next_msg_or_stop(struct aspeed_i2c_bus *bus)
 358 {
 359         if (bus->msgs_index + 1 < bus->msgs_count) {
 360                 bus->msgs_index++;
 361                 aspeed_i2c_do_start(bus);
 362         } else {
 363                 aspeed_i2c_do_stop(bus);
 364         }
 365 }
 366
 367 static int aspeed_i2c_is_irq_error(u32 irq_status)
 368 {
 369         if (irq_status & ASPEED_I2CD_INTR_ARBIT_LOSS)
 370                 return -EAGAIN;
 371         if (irq_status & (ASPEED_I2CD_INTR_SDA_DL_TIMEOUT |
 372                           ASPEED_I2CD_INTR_SCL_TIMEOUT))
 373                 return -EBUSY;
 374         if (irq_status & (ASPEED_I2CD_INTR_ABNORMAL))
 375                 return -EPROTO;
 376
 377         return 0;
 378 }
 379
 380 static bool aspeed_i2c_master_irq(struct aspeed_i2c_bus *bus)
 381 {
 382         u32 irq_status, status_ack = 0, command = 0;
 383         struct i2c_msg *msg;
 384         u8 recv_byte;
 385         int ret;
 386
 387         spin_lock(&bus->lock);
 388         irq_status = readl(bus->base + ASPEED_I2C_INTR_STS_REG);
 389         /* Ack all interrupt bits. */
 390         writel(irq_status, bus->base + ASPEED_I2C_INTR_STS_REG);
 391
 392         if (irq_status & ASPEED_I2CD_INTR_BUS_RECOVER_DONE) {
 393                 bus->master_state = ASPEED_I2C_MASTER_INACTIVE;
 394                 status_ack |= ASPEED_I2CD_INTR_BUS_RECOVER_DONE;
 395                 goto out_complete;
 396         }
 397
 398         /*
 399          * We encountered an interrupt that reports an error: the hardware
 400          * should clear the command queue effectively taking us back to the
 401          * INACTIVE state.
 402          */
 403         ret = aspeed_i2c_is_irq_error(irq_status);
 404         if (ret < 0) {
 405                 dev_dbg(bus->dev, "received error interrupt: 0x%08x",
 406                         irq_status);
 407                 bus->cmd_err = ret;
 408                 bus->master_state = ASPEED_I2C_MASTER_INACTIVE;
 409                 goto out_complete;
 410         }
 411
 412         /* We are in an invalid state; reset bus to a known state. */
 413         if (!bus->msgs) {
 414                 dev_err(bus->dev, "bus in unknown state");
 415                 bus->cmd_err = -EIO;
 416                 if (bus->master_state != ASPEED_I2C_MASTER_STOP)
 417                         aspeed_i2c_do_stop(bus);
 418                 goto out_no_complete;
 419         }
 420         msg = &bus->msgs[bus->msgs_index];
 421
 422         /*
 423          * START is a special case because we still have to handle a subsequent
 424          * TX or RX immediately after we handle it, so we handle it here and
 425          * then update the state and handle the new state below.
 426          */
 427         if (bus->master_state == ASPEED_I2C_MASTER_START) {
 428                 if (unlikely(!(irq_status & ASPEED_I2CD_INTR_TX_ACK))) {
 429                         pr_devel("no slave present at %02x", msg->addr);
 430                         status_ack |= ASPEED_I2CD_INTR_TX_NAK;
 431                         bus->cmd_err = -ENXIO;
 432                         aspeed_i2c_do_stop(bus);
 433                         goto out_no_complete;
 434                 }
 435                 status_ack |= ASPEED_I2CD_INTR_TX_ACK;
 436                 if (msg->len == 0) { /* SMBUS_QUICK */
 437                         aspeed_i2c_do_stop(bus);
 438                         goto out_no_complete;
 439                 }
 440                 if (msg->flags & I2C_M_RD)
 441                         bus->master_state = ASPEED_I2C_MASTER_RX_FIRST;
 442                 else
 443                         bus->master_state = ASPEED_I2C_MASTER_TX_FIRST;
 444         }
 445
 446         switch (bus->master_state) {
 447         case ASPEED_I2C_MASTER_TX:
 448                 if (unlikely(irq_status & ASPEED_I2CD_INTR_TX_NAK)) {
 449                         dev_dbg(bus->dev, "slave NACKed TX");
 450                         status_ack |= ASPEED_I2CD_INTR_TX_NAK;
 451                         goto error_and_stop;
 452                 } else if (unlikely(!(irq_status & ASPEED_I2CD_INTR_TX_ACK))) {
 453                         dev_err(bus->dev, "slave failed to ACK TX");
 454                         goto error_and_stop;
 455                 }
 456                 status_ack |= ASPEED_I2CD_INTR_TX_ACK;
 457                 /* fallthrough intended */
 458         case ASPEED_I2C_MASTER_TX_FIRST:
 459                 if (bus->buf_index < msg->len) {
 460                         bus->master_state = ASPEED_I2C_MASTER_TX;
 461                         writel(msg->buf[bus->buf_index++],
 462                                bus->base + ASPEED_I2C_BYTE_BUF_REG);
 463                         writel(ASPEED_I2CD_M_TX_CMD,
 464                                bus->base + ASPEED_I2C_CMD_REG);
 465                 } else {
 466                         aspeed_i2c_next_msg_or_stop(bus);
 467                 }
 468                 goto out_no_complete;
 469         case ASPEED_I2C_MASTER_RX_FIRST:
 470                 /* RX may not have completed yet (only address cycle) */
 471                 if (!(irq_status & ASPEED_I2CD_INTR_RX_DONE))
 472                         goto out_no_complete;
 473                 /* fallthrough intended */
 474         case ASPEED_I2C_MASTER_RX:
 475                 if (unlikely(!(irq_status & ASPEED_I2CD_INTR_RX_DONE))) {
 476                         dev_err(bus->dev, "master failed to RX");
 477                         goto error_and_stop;
 478                 }
 479                 status_ack |= ASPEED_I2CD_INTR_RX_DONE;
 480
 481                 recv_byte = readl(bus->base + ASPEED_I2C_BYTE_BUF_REG) >> 8;
 482                 msg->buf[bus->buf_index++] = recv_byte;
 483
 484                 if (msg->flags & I2C_M_RECV_LEN) {
 485                         if (unlikely(recv_byte > I2C_SMBUS_BLOCK_MAX)) {
 486                                 bus->cmd_err = -EPROTO;
 487                                 aspeed_i2c_do_stop(bus);
 488                                 goto out_no_complete;
 489                         }
 490                         msg->len = recv_byte +
 491                                         ((msg->flags & I2C_CLIENT_PEC) ? 2 : 1);
 492                         msg->flags &= ~I2C_M_RECV_LEN;
 493                 }
 494
 495                 if (bus->buf_index < msg->len) {
 496                         bus->master_state = ASPEED_I2C_MASTER_RX;
 497                         command = ASPEED_I2CD_M_RX_CMD;
 498                         if (bus->buf_index + 1 == msg->len)
 499                                 command |= ASPEED_I2CD_M_S_RX_CMD_LAST;
 500                         writel(command, bus->base + ASPEED_I2C_CMD_REG);
 501                 } else {
 502                         aspeed_i2c_next_msg_or_stop(bus);
 503                 }
 504                 goto out_no_complete;
 505         case ASPEED_I2C_MASTER_STOP:
 506                 if (unlikely(!(irq_status & ASPEED_I2CD_INTR_NORMAL_STOP))) {
 507                         dev_err(bus->dev, "master failed to STOP");
 508                         bus->cmd_err = -EIO;
 509                         /* Do not STOP as we have already tried. */
 510                 } else {
 511                         status_ack |= ASPEED_I2CD_INTR_NORMAL_STOP;
 512                 }
 513
 514                 bus->master_state = ASPEED_I2C_MASTER_INACTIVE;
 515                 goto out_complete;
 516         case ASPEED_I2C_MASTER_INACTIVE:
 517                 dev_err(bus->dev,
 518                         "master received interrupt 0x%08x, but is inactive",
 519                         irq_status);
 520                 bus->cmd_err = -EIO;
 521                 /* Do not STOP as we should be inactive. */
 522                 goto out_complete;
 523         default:
 524                 WARN(1, "unknown master state\n");
 525                 bus->master_state = ASPEED_I2C_MASTER_INACTIVE;
 526                 bus->cmd_err = -EINVAL;
 527                 goto out_complete;
 528         }
 529 error_and_stop:
 530         bus->cmd_err = -EIO;
 531         aspeed_i2c_do_stop(bus);
 532         goto out_no_complete;
 533 out_complete:
 534         bus->msgs = NULL;
 535         if (bus->cmd_err)
 536                 bus->master_xfer_result = bus->cmd_err;
 537         else
 538                 bus->master_xfer_result = bus->msgs_index + 1;
 539         complete(&bus->cmd_complete);
 540 out_no_complete:
 541         if (irq_status != status_ack)
 542                 dev_err(bus->dev,
 543                         "irq handled != irq. expected 0x%08x, but was 0x%08x\n",
 544                         irq_status, status_ack);
 545         spin_unlock(&bus->lock);
 546         return !!irq_status;
 547 }
 548
 549 static irqreturn_t aspeed_i2c_bus_irq(int irq, void *dev_id)
 550 {
 551         struct aspeed_i2c_bus *bus = dev_id;
 552
 553 #if IS_ENABLED(CONFIG_I2C_SLAVE)
 554         if (aspeed_i2c_slave_irq(bus)) {
 555                 dev_dbg(bus->dev, "irq handled by slave.\n");
 556                 return IRQ_HANDLED;
 557         }
 558 #endif /* CONFIG_I2C_SLAVE */
 559
 560         return aspeed_i2c_master_irq(bus) ? IRQ_HANDLED : IRQ_NONE;
 561 }
 562
 563 static int aspeed_i2c_master_xfer(struct i2c_adapter *adap,
 564                                   struct i2c_msg *msgs, int num)
 565 {
 566         struct aspeed_i2c_bus *bus = i2c_get_adapdata(adap);
 567         unsigned long time_left, flags;
 568         int ret = 0;
 569
 570         spin_lock_irqsave(&bus->lock, flags);
 571         bus->cmd_err = 0;
 572
 573         /* If bus is busy, attempt recovery. We assume a single master
 574          * environment.
 575          */
 576         if (readl(bus->base + ASPEED_I2C_CMD_REG) & ASPEED_I2CD_BUS_BUSY_STS) {
 577                 spin_unlock_irqrestore(&bus->lock, flags);
 578                 ret = aspeed_i2c_recover_bus(bus);
 579                 if (ret)
 580                         return ret;
 581                 spin_lock_irqsave(&bus->lock, flags);
 582         }
 583
 584         bus->cmd_err = 0;
 585         bus->msgs = msgs;
 586         bus->msgs_index = 0;
 587         bus->msgs_count = num;
 588
 589         reinit_completion(&bus->cmd_complete);
 590         aspeed_i2c_do_start(bus);
 591         spin_unlock_irqrestore(&bus->lock, flags);
 592
 593         time_left = wait_for_completion_timeout(&bus->cmd_complete,
 594                                                 bus->adap.timeout);
 595
 596         if (time_left == 0)
 597                 return -ETIMEDOUT;
 598         else
 599                 return bus->master_xfer_result;
 600 }
 601
 602 static u32 aspeed_i2c_functionality(struct i2c_adapter *adap)
 603 {
 604         return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL | I2C_FUNC_SMBUS_BLOCK_DATA;
 605 }
 606
 607 #if IS_ENABLED(CONFIG_I2C_SLAVE)
 608 /* precondition: bus.lock has been acquired. */
 609 static void __aspeed_i2c_reg_slave(struct aspeed_i2c_bus *bus, u16 slave_addr)
 610 {
 611         u32 addr_reg_val, func_ctrl_reg_val;
 612
 613         /* Set slave addr. */
 614         addr_reg_val = readl(bus->base + ASPEED_I2C_DEV_ADDR_REG);
 615         addr_reg_val &= ~ASPEED_I2CD_DEV_ADDR_MASK;
 616         addr_reg_val |= slave_addr & ASPEED_I2CD_DEV_ADDR_MASK;
 617         writel(addr_reg_val, bus->base + ASPEED_I2C_DEV_ADDR_REG);
 618
 619         /* Turn on slave mode. */
 620         func_ctrl_reg_val = readl(bus->base + ASPEED_I2C_FUN_CTRL_REG);
 621         func_ctrl_reg_val |= ASPEED_I2CD_SLAVE_EN;
 622         writel(func_ctrl_reg_val, bus->base + ASPEED_I2C_FUN_CTRL_REG);
 623 }
 624
 625 static int aspeed_i2c_reg_slave(struct i2c_client *client)
 626 {
 627         struct aspeed_i2c_bus *bus = i2c_get_adapdata(client->adapter);
 628         unsigned long flags;
 629
 630         spin_lock_irqsave(&bus->lock, flags);
 631         if (bus->slave) {
 632                 spin_unlock_irqrestore(&bus->lock, flags);
 633                 return -EINVAL;
 634         }
 635
 636         __aspeed_i2c_reg_slave(bus, client->addr);
 637
 638         bus->slave = client;
 639         bus->slave_state = ASPEED_I2C_SLAVE_STOP;
 640         spin_unlock_irqrestore(&bus->lock, flags);
 641
 642         return 0;
 643 }
 644
 645 static int aspeed_i2c_unreg_slave(struct i2c_client *client)
 646 {
 647         struct aspeed_i2c_bus *bus = i2c_get_adapdata(client->adapter);
 648         u32 func_ctrl_reg_val;
 649         unsigned long flags;
 650
 651         spin_lock_irqsave(&bus->lock, flags);
 652         if (!bus->slave) {
 653                 spin_unlock_irqrestore(&bus->lock, flags);
 654                 return -EINVAL;
 655         }
 656
 657         /* Turn off slave mode. */
 658         func_ctrl_reg_val = readl(bus->base + ASPEED_I2C_FUN_CTRL_REG);
 659         func_ctrl_reg_val &= ~ASPEED_I2CD_SLAVE_EN;
 660         writel(func_ctrl_reg_val, bus->base + ASPEED_I2C_FUN_CTRL_REG);
 661
 662         bus->slave = NULL;
 663         spin_unlock_irqrestore(&bus->lock, flags);
 664
 665         return 0;
 666 }
 667 #endif /* CONFIG_I2C_SLAVE */
 668
 669 static const struct i2c_algorithm aspeed_i2c_algo = {
 670         .master_xfer    = aspeed_i2c_master_xfer,
 671         .functionality  = aspeed_i2c_functionality,
 672 #if IS_ENABLED(CONFIG_I2C_SLAVE)
 673         .reg_slave      = aspeed_i2c_reg_slave,
 674         .unreg_slave    = aspeed_i2c_unreg_slave,
 675 #endif /* CONFIG_I2C_SLAVE */
 676 };
 677
 678 static u32 aspeed_i2c_get_clk_reg_val(u32 divisor)
 679 {
 680         u32 base_clk, clk_high, clk_low, tmp;
 681
 682         /*
 683          * The actual clock frequency of SCL is:
 684          *      SCL_freq = APB_freq / (base_freq * (SCL_high + SCL_low))
 685          *               = APB_freq / divisor
 686          * where base_freq is a programmable clock divider; its value is
 687          *      base_freq = 1 << base_clk
 688          * SCL_high is the number of base_freq clock cycles that SCL stays high
 689          * and SCL_low is the number of base_freq clock cycles that SCL stays
 690          * low for a period of SCL.
 691          * The actual register has a minimum SCL_high and SCL_low minimum of 1;
 692          * thus, they start counting at zero. So
 693          *      SCL_high = clk_high + 1
 694          *      SCL_low  = clk_low + 1
 695          * Thus,
 696          *      SCL_freq = APB_freq /
 697          *              ((1 << base_clk) * (clk_high + 1 + clk_low + 1))
 698          * The documentation recommends clk_high >= 8 and clk_low >= 7 when
 699          * possible; this last constraint gives us the following solution:
 700          */
 701         base_clk = divisor > 33 ? ilog2((divisor - 1) / 32) + 1 : 0;
 702         tmp = divisor / (1 << base_clk);
 703         clk_high = tmp / 2 + tmp % 2;
 704         clk_low = tmp - clk_high;
 705
 706         clk_high -= 1;
 707         clk_low -= 1;
 708
 709         return ((clk_high << ASPEED_I2CD_TIME_SCL_HIGH_SHIFT)
 710                 & ASPEED_I2CD_TIME_SCL_HIGH_MASK)
 711                         | ((clk_low << ASPEED_I2CD_TIME_SCL_LOW_SHIFT)
 712                            & ASPEED_I2CD_TIME_SCL_LOW_MASK)
 713                         | (base_clk & ASPEED_I2CD_TIME_BASE_DIVISOR_MASK);
 714 }
 715
 716 /* precondition: bus.lock has been acquired. */
 717 static int aspeed_i2c_init_clk(struct aspeed_i2c_bus *bus)
 718 {
 719         u32 divisor, clk_reg_val;
 720
 721         divisor = bus->parent_clk_frequency / bus->bus_frequency;
 722         clk_reg_val = aspeed_i2c_get_clk_reg_val(divisor);
 723         writel(clk_reg_val, bus->base + ASPEED_I2C_AC_TIMING_REG1);
 724         writel(ASPEED_NO_TIMEOUT_CTRL, bus->base + ASPEED_I2C_AC_TIMING_REG2);
 725
 726         return 0;
 727 }
 728
 729 /* precondition: bus.lock has been acquired. */
 730 static int aspeed_i2c_init(struct aspeed_i2c_bus *bus,
 731                              struct platform_device *pdev)
 732 {
 733         u32 fun_ctrl_reg = ASPEED_I2CD_MASTER_EN;
 734         int ret;
 735
 736         /* Disable everything. */
 737         writel(0, bus->base + ASPEED_I2C_FUN_CTRL_REG);
 738
 739         ret = aspeed_i2c_init_clk(bus);
 740         if (ret < 0)
 741                 return ret;
 742
 743         if (!of_property_read_bool(pdev->dev.of_node, "multi-master"))
 744                 fun_ctrl_reg |= ASPEED_I2CD_MULTI_MASTER_DIS;
 745
 746         /* Enable Master Mode */
 747         writel(readl(bus->base + ASPEED_I2C_FUN_CTRL_REG) | fun_ctrl_reg,
 748                bus->base + ASPEED_I2C_FUN_CTRL_REG);
 749
 750 #if IS_ENABLED(CONFIG_I2C_SLAVE)
 751         /* If slave has already been registered, re-enable it. */
 752         if (bus->slave)
 753                 __aspeed_i2c_reg_slave(bus, bus->slave->addr);
 754 #endif /* CONFIG_I2C_SLAVE */
 755
 756         /* Set interrupt generation of I2C controller */
 757         writel(ASPEED_I2CD_INTR_ALL, bus->base + ASPEED_I2C_INTR_CTRL_REG);
 758
 759         return 0;
 760 }
 761
 762 static int aspeed_i2c_reset(struct aspeed_i2c_bus *bus)
 763 {
 764         struct platform_device *pdev = to_platform_device(bus->dev);
 765         unsigned long flags;
 766         int ret;
 767
 768         spin_lock_irqsave(&bus->lock, flags);
 769
 770         /* Disable and ack all interrupts. */
 771         writel(0, bus->base + ASPEED_I2C_INTR_CTRL_REG);
 772         writel(0xffffffff, bus->base + ASPEED_I2C_INTR_STS_REG);
 773
 774         ret = aspeed_i2c_init(bus, pdev);
 775
 776         spin_unlock_irqrestore(&bus->lock, flags);
 777
 778         return ret;
 779 }
 780
 781 static int aspeed_i2c_probe_bus(struct platform_device *pdev)
 782 {
 783         struct aspeed_i2c_bus *bus;
 784         struct clk *parent_clk;
 785         struct resource *res;
 786         int irq, ret;
 787
 788         bus = devm_kzalloc(&pdev->dev, sizeof(*bus), GFP_KERNEL);
 789         if (!bus)
 790                 return -ENOMEM;
 791
 792         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 793         bus->base = devm_ioremap_resource(&pdev->dev, res);
 794         if (IS_ERR(bus->base))
 795                 return PTR_ERR(bus->base);
 796
 797         parent_clk = devm_clk_get(&pdev->dev, NULL);
 798         if (IS_ERR(parent_clk))
 799                 return PTR_ERR(parent_clk);
 800         bus->parent_clk_frequency = clk_get_rate(parent_clk);
 801         /* We just need the clock rate, we don't actually use the clk object. */
 802         devm_clk_put(&pdev->dev, parent_clk);
 803
 804         ret = of_property_read_u32(pdev->dev.of_node,
 805                                    "bus-frequency", &bus->bus_frequency);
 806         if (ret < 0) {
 807                 dev_err(&pdev->dev,
 808                         "Could not read bus-frequency property\n");
 809                 bus->bus_frequency = 100000;
 810         }
 811
 812         /* Initialize the I2C adapter */
 813         spin_lock_init(&bus->lock);
 814         init_completion(&bus->cmd_complete);
 815         bus->adap.owner = THIS_MODULE;
 816         bus->adap.retries = 0;
 817         bus->adap.timeout = 5 * HZ;
 818         bus->adap.algo = &aspeed_i2c_algo;
 819         bus->adap.dev.parent = &pdev->dev;
 820         bus->adap.dev.of_node = pdev->dev.of_node;
 821         strlcpy(bus->adap.name, pdev->name, sizeof(bus->adap.name));
 822         i2c_set_adapdata(&bus->adap, bus);
 823
 824         bus->dev = &pdev->dev;
 825
 826         /* Clean up any left over interrupt state. */
 827         writel(0, bus->base + ASPEED_I2C_INTR_CTRL_REG);
 828         writel(0xffffffff, bus->base + ASPEED_I2C_INTR_STS_REG);
 829         /*
 830          * bus.lock does not need to be held because the interrupt handler has
 831          * not been enabled yet.
 832          */
 833         ret = aspeed_i2c_init(bus, pdev);
 834         if (ret < 0)
 835                 return ret;
 836
 837         irq = irq_of_parse_and_map(pdev->dev.of_node, 0);
 838         ret = devm_request_irq(&pdev->dev, irq, aspeed_i2c_bus_irq,
 839                                0, dev_name(&pdev->dev), bus);
 840         if (ret < 0)
 841                 return ret;
 842
 843         ret = i2c_add_adapter(&bus->adap);
 844         if (ret < 0)
 845                 return ret;
 846
 847         platform_set_drvdata(pdev, bus);
 848
 849         dev_info(bus->dev, "i2c bus %d registered, irq %d\n",
 850                  bus->adap.nr, irq);
 851
 852         return 0;
 853 }
 854
 855 static int aspeed_i2c_remove_bus(struct platform_device *pdev)
 856 {
 857         struct aspeed_i2c_bus *bus = platform_get_drvdata(pdev);
 858         unsigned long flags;
 859
 860         spin_lock_irqsave(&bus->lock, flags);
 861
 862         /* Disable everything. */
 863         writel(0, bus->base + ASPEED_I2C_FUN_CTRL_REG);
 864         writel(0, bus->base + ASPEED_I2C_INTR_CTRL_REG);
 865
 866         spin_unlock_irqrestore(&bus->lock, flags);
 867
 868         i2c_del_adapter(&bus->adap);
 869
 870         return 0;
 871 }
 872
 873 static const struct of_device_id aspeed_i2c_bus_of_table[] = {
 874         { .compatible = "aspeed,ast2400-i2c-bus", },
 875         { .compatible = "aspeed,ast2500-i2c-bus", },
 876         { },
 877 };
 878 MODULE_DEVICE_TABLE(of, aspeed_i2c_bus_of_table);
 879
 880 static struct platform_driver aspeed_i2c_bus_driver = {
 881         .probe          = aspeed_i2c_probe_bus,
 882         .remove         = aspeed_i2c_remove_bus,
 883         .driver         = {
 884                 .name           = "aspeed-i2c-bus",
 885                 .of_match_table = aspeed_i2c_bus_of_table,
 886         },
 887 };
 888 module_platform_driver(aspeed_i2c_bus_driver);
 889
 890 MODULE_AUTHOR("Brendan Higgins <brendanhiggins@google.com>");
 891 MODULE_DESCRIPTION("Aspeed I2C Bus Driver");
 892 MODULE_LICENSE("GPL v2");