drivers/i2c/busses/i2c-rcar.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Driver for the Renesas R-Car I2C unit
   4  *
   5  * Copyright (C) 2014-15 Wolfram Sang <wsa@sang-engineering.com>
   6  * Copyright (C) 2011-2015 Renesas Electronics Corporation
   7  *
   8  * Copyright (C) 2012-14 Renesas Solutions Corp.
   9  * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
  10  *
  11  * This file is based on the drivers/i2c/busses/i2c-sh7760.c
  12  * (c) 2005-2008 MSC Vertriebsges.m.b.H, Manuel Lauss <mlau@msc-ge.com>
  13  */
  14 #include <linux/bitops.h>
  15 #include <linux/clk.h>
  16 #include <linux/delay.h>
  17 #include <linux/dmaengine.h>
  18 #include <linux/dma-mapping.h>
  19 #include <linux/err.h>
  20 #include <linux/interrupt.h>
  21 #include <linux/io.h>
  22 #include <linux/i2c.h>
  23 #include <linux/kernel.h>
  24 #include <linux/module.h>
  25 #include <linux/of_device.h>
  26 #include <linux/platform_device.h>
  27 #include <linux/pm_runtime.h>
  28 #include <linux/reset.h>
  29 #include <linux/slab.h>
  30
  31 /* register offsets */
  32 #define ICSCR   0x00    /* slave ctrl */
  33 #define ICMCR   0x04    /* master ctrl */
  34 #define ICSSR   0x08    /* slave status */
  35 #define ICMSR   0x0C    /* master status */
  36 #define ICSIER  0x10    /* slave irq enable */
  37 #define ICMIER  0x14    /* master irq enable */
  38 #define ICCCR   0x18    /* clock dividers */
  39 #define ICSAR   0x1C    /* slave address */
  40 #define ICMAR   0x20    /* master address */
  41 #define ICRXTX  0x24    /* data port */
  42 #define ICDMAER 0x3c    /* DMA enable */
  43 #define ICFBSCR 0x38    /* first bit setup cycle */
  44
  45 /* ICSCR */
  46 #define SDBS    (1 << 3)        /* slave data buffer select */
  47 #define SIE     (1 << 2)        /* slave interface enable */
  48 #define GCAE    (1 << 1)        /* general call address enable */
  49 #define FNA     (1 << 0)        /* forced non acknowledgment */
  50
  51 /* ICMCR */
  52 #define MDBS    (1 << 7)        /* non-fifo mode switch */
  53 #define FSCL    (1 << 6)        /* override SCL pin */
  54 #define FSDA    (1 << 5)        /* override SDA pin */
  55 #define OBPC    (1 << 4)        /* override pins */
  56 #define MIE     (1 << 3)        /* master if enable */
  57 #define TSBE    (1 << 2)
  58 #define FSB     (1 << 1)        /* force stop bit */
  59 #define ESG     (1 << 0)        /* enable start bit gen */
  60
  61 /* ICSSR (also for ICSIER) */
  62 #define GCAR    (1 << 6)        /* general call received */
  63 #define STM     (1 << 5)        /* slave transmit mode */
  64 #define SSR     (1 << 4)        /* stop received */
  65 #define SDE     (1 << 3)        /* slave data empty */
  66 #define SDT     (1 << 2)        /* slave data transmitted */
  67 #define SDR     (1 << 1)        /* slave data received */
  68 #define SAR     (1 << 0)        /* slave addr received */
  69
  70 /* ICMSR (also for ICMIE) */
  71 #define MNR     (1 << 6)        /* nack received */
  72 #define MAL     (1 << 5)        /* arbitration lost */
  73 #define MST     (1 << 4)        /* sent a stop */
  74 #define MDE     (1 << 3)
  75 #define MDT     (1 << 2)
  76 #define MDR     (1 << 1)
  77 #define MAT     (1 << 0)        /* slave addr xfer done */
  78
  79 /* ICDMAER */
  80 #define RSDMAE  (1 << 3)        /* DMA Slave Received Enable */
  81 #define TSDMAE  (1 << 2)        /* DMA Slave Transmitted Enable */
  82 #define RMDMAE  (1 << 1)        /* DMA Master Received Enable */
  83 #define TMDMAE  (1 << 0)        /* DMA Master Transmitted Enable */
  84
  85 /* ICFBSCR */
  86 #define TCYC06  0x04            /*  6*Tcyc delay 1st bit between SDA and SCL */
  87 #define TCYC17  0x0f            /* 17*Tcyc delay 1st bit between SDA and SCL */
  88
  89
  90 #define RCAR_BUS_PHASE_START    (MDBS | MIE | ESG)
  91 #define RCAR_BUS_PHASE_DATA     (MDBS | MIE)
  92 #define RCAR_BUS_MASK_DATA      (~(ESG | FSB) & 0xFF)
  93 #define RCAR_BUS_PHASE_STOP     (MDBS | MIE | FSB)
  94
  95 #define RCAR_IRQ_SEND   (MNR | MAL | MST | MAT | MDE)
  96 #define RCAR_IRQ_RECV   (MNR | MAL | MST | MAT | MDR)
  97 #define RCAR_IRQ_STOP   (MST)
  98
  99 #define RCAR_IRQ_ACK_SEND       (~(MAT | MDE) & 0x7F)
 100 #define RCAR_IRQ_ACK_RECV       (~(MAT | MDR) & 0x7F)
 101
 102 #define ID_LAST_MSG     (1 << 0)
 103 #define ID_FIRST_MSG    (1 << 1)
 104 #define ID_DONE         (1 << 2)
 105 #define ID_ARBLOST      (1 << 3)
 106 #define ID_NACK         (1 << 4)
 107 /* persistent flags */
 108 #define ID_P_REP_AFTER_RD       BIT(29)
 109 #define ID_P_NO_RXDMA           BIT(30) /* HW forbids RXDMA sometimes */
 110 #define ID_P_PM_BLOCKED         BIT(31)
 111 #define ID_P_MASK               GENMASK(31, 29)
 112
 113 enum rcar_i2c_type {
 114         I2C_RCAR_GEN1,
 115         I2C_RCAR_GEN2,
 116         I2C_RCAR_GEN3,
 117 };
 118
 119 struct rcar_i2c_priv {
 120         u32 flags;
 121         void __iomem *io;
 122         struct i2c_adapter adap;
 123         struct i2c_msg *msg;
 124         int msgs_left;
 125         struct clk *clk;
 126
 127         wait_queue_head_t wait;
 128
 129         int pos;
 130         u32 icccr;
 131         u8 recovery_icmcr;      /* protected by adapter lock */
 132         enum rcar_i2c_type devtype;
 133         struct i2c_client *slave;
 134
 135         struct resource *res;
 136         struct dma_chan *dma_tx;
 137         struct dma_chan *dma_rx;
 138         struct scatterlist sg;
 139         enum dma_data_direction dma_direction;
 140
 141         struct reset_control *rstc;
 142         int irq;
 143 };
 144
 145 #define rcar_i2c_priv_to_dev(p)         ((p)->adap.dev.parent)
 146 #define rcar_i2c_is_recv(p)             ((p)->msg->flags & I2C_M_RD)
 147
 148 #define LOOP_TIMEOUT    1024
 149
 150
 151 static void rcar_i2c_write(struct rcar_i2c_priv *priv, int reg, u32 val)
 152 {
 153         writel(val, priv->io + reg);
 154 }
 155
 156 static u32 rcar_i2c_read(struct rcar_i2c_priv *priv, int reg)
 157 {
 158         return readl(priv->io + reg);
 159 }
 160
 161 static int rcar_i2c_get_scl(struct i2c_adapter *adap)
 162 {
 163         struct rcar_i2c_priv *priv = i2c_get_adapdata(adap);
 164
 165         return !!(rcar_i2c_read(priv, ICMCR) & FSCL);
 166
 167 };
 168
 169 static void rcar_i2c_set_scl(struct i2c_adapter *adap, int val)
 170 {
 171         struct rcar_i2c_priv *priv = i2c_get_adapdata(adap);
 172
 173         if (val)
 174                 priv->recovery_icmcr |= FSCL;
 175         else
 176                 priv->recovery_icmcr &= ~FSCL;
 177
 178         rcar_i2c_write(priv, ICMCR, priv->recovery_icmcr);
 179 };
 180
 181 static void rcar_i2c_set_sda(struct i2c_adapter *adap, int val)
 182 {
 183         struct rcar_i2c_priv *priv = i2c_get_adapdata(adap);
 184
 185         if (val)
 186                 priv->recovery_icmcr |= FSDA;
 187         else
 188                 priv->recovery_icmcr &= ~FSDA;
 189
 190         rcar_i2c_write(priv, ICMCR, priv->recovery_icmcr);
 191 };
 192
 193 static int rcar_i2c_get_bus_free(struct i2c_adapter *adap)
 194 {
 195         struct rcar_i2c_priv *priv = i2c_get_adapdata(adap);
 196
 197         return !(rcar_i2c_read(priv, ICMCR) & FSDA);
 198
 199 };
 200
 201 static struct i2c_bus_recovery_info rcar_i2c_bri = {
 202         .get_scl = rcar_i2c_get_scl,
 203         .set_scl = rcar_i2c_set_scl,
 204         .set_sda = rcar_i2c_set_sda,
 205         .get_bus_free = rcar_i2c_get_bus_free,
 206         .recover_bus = i2c_generic_scl_recovery,
 207 };
 208 static void rcar_i2c_init(struct rcar_i2c_priv *priv)
 209 {
 210         /* reset master mode */
 211         rcar_i2c_write(priv, ICMIER, 0);
 212         rcar_i2c_write(priv, ICMCR, MDBS);
 213         rcar_i2c_write(priv, ICMSR, 0);
 214         /* start clock */
 215         rcar_i2c_write(priv, ICCCR, priv->icccr);
 216 }
 217
 218 static int rcar_i2c_bus_barrier(struct rcar_i2c_priv *priv)
 219 {
 220         int i;
 221
 222         for (i = 0; i < LOOP_TIMEOUT; i++) {
 223                 /* make sure that bus is not busy */
 224                 if (!(rcar_i2c_read(priv, ICMCR) & FSDA))
 225                         return 0;
 226                 udelay(1);
 227         }
 228
 229         /* Waiting did not help, try to recover */
 230         priv->recovery_icmcr = MDBS | OBPC | FSDA | FSCL;
 231         return i2c_recover_bus(&priv->adap);
 232 }
 233
 234 static int rcar_i2c_clock_calculate(struct rcar_i2c_priv *priv, struct i2c_timings *t)
 235 {
 236         u32 scgd, cdf, round, ick, sum, scl, cdf_width;
 237         unsigned long rate;
 238         struct device *dev = rcar_i2c_priv_to_dev(priv);
 239
 240         /* Fall back to previously used values if not supplied */
 241         t->bus_freq_hz = t->bus_freq_hz ?: 100000;
 242         t->scl_fall_ns = t->scl_fall_ns ?: 35;
 243         t->scl_rise_ns = t->scl_rise_ns ?: 200;
 244         t->scl_int_delay_ns = t->scl_int_delay_ns ?: 50;
 245
 246         switch (priv->devtype) {
 247         case I2C_RCAR_GEN1:
 248                 cdf_width = 2;
 249                 break;
 250         case I2C_RCAR_GEN2:
 251         case I2C_RCAR_GEN3:
 252                 cdf_width = 3;
 253                 break;
 254         default:
 255                 dev_err(dev, "device type error\n");
 256                 return -EIO;
 257         }
 258
 259         /*
 260          * calculate SCL clock
 261          * see
 262          *      ICCCR
 263          *
 264          * ick  = clkp / (1 + CDF)
 265          * SCL  = ick / (20 + SCGD * 8 + F[(ticf + tr + intd) * ick])
 266          *
 267          * ick  : I2C internal clock < 20 MHz
 268          * ticf : I2C SCL falling time
 269          * tr   : I2C SCL rising  time
 270          * intd : LSI internal delay
 271          * clkp : peripheral_clk
 272          * F[]  : integer up-valuation
 273          */
 274         rate = clk_get_rate(priv->clk);
 275         cdf = rate / 20000000;
 276         if (cdf >= 1U << cdf_width) {
 277                 dev_err(dev, "Input clock %lu too high\n", rate);
 278                 return -EIO;
 279         }
 280         ick = rate / (cdf + 1);
 281
 282         /*
 283          * it is impossible to calculate large scale
 284          * number on u32. separate it
 285          *
 286          * F[(ticf + tr + intd) * ick] with sum = (ticf + tr + intd)
 287          *  = F[sum * ick / 1000000000]
 288          *  = F[(ick / 1000000) * sum / 1000]
 289          */
 290         sum = t->scl_fall_ns + t->scl_rise_ns + t->scl_int_delay_ns;
 291         round = (ick + 500000) / 1000000 * sum;
 292         round = (round + 500) / 1000;
 293
 294         /*
 295          * SCL  = ick / (20 + SCGD * 8 + F[(ticf + tr + intd) * ick])
 296          *
 297          * Calculation result (= SCL) should be less than
 298          * bus_speed for hardware safety
 299          *
 300          * We could use something along the lines of
 301          *      div = ick / (bus_speed + 1) + 1;
 302          *      scgd = (div - 20 - round + 7) / 8;
 303          *      scl = ick / (20 + (scgd * 8) + round);
 304          * (not fully verified) but that would get pretty involved
 305          */
 306         for (scgd = 0; scgd < 0x40; scgd++) {
 307                 scl = ick / (20 + (scgd * 8) + round);
 308                 if (scl <= t->bus_freq_hz)
 309                         goto scgd_find;
 310         }
 311         dev_err(dev, "it is impossible to calculate best SCL\n");
 312         return -EIO;
 313
 314 scgd_find:
 315         dev_dbg(dev, "clk %d/%d(%lu), round %u, CDF:0x%x, SCGD: 0x%x\n",
 316                 scl, t->bus_freq_hz, clk_get_rate(priv->clk), round, cdf, scgd);
 317
 318         /* keep icccr value */
 319         priv->icccr = scgd << cdf_width | cdf;
 320
 321         return 0;
 322 }
 323
 324 static void rcar_i2c_prepare_msg(struct rcar_i2c_priv *priv)
 325 {
 326         int read = !!rcar_i2c_is_recv(priv);
 327
 328         priv->pos = 0;
 329         if (priv->msgs_left == 1)
 330                 priv->flags |= ID_LAST_MSG;
 331
 332         rcar_i2c_write(priv, ICMAR, i2c_8bit_addr_from_msg(priv->msg));
 333         /*
 334          * We don't have a test case but the HW engineers say that the write order
 335          * of ICMSR and ICMCR depends on whether we issue START or REP_START. Since
 336          * it didn't cause a drawback for me, let's rather be safe than sorry.
 337          */
 338         if (priv->flags & ID_FIRST_MSG) {
 339                 rcar_i2c_write(priv, ICMSR, 0);
 340                 rcar_i2c_write(priv, ICMCR, RCAR_BUS_PHASE_START);
 341         } else {
 342                 if (priv->flags & ID_P_REP_AFTER_RD)
 343                         priv->flags &= ~ID_P_REP_AFTER_RD;
 344                 else
 345                         rcar_i2c_write(priv, ICMCR, RCAR_BUS_PHASE_START);
 346                 rcar_i2c_write(priv, ICMSR, 0);
 347         }
 348         rcar_i2c_write(priv, ICMIER, read ? RCAR_IRQ_RECV : RCAR_IRQ_SEND);
 349 }
 350
 351 static void rcar_i2c_next_msg(struct rcar_i2c_priv *priv)
 352 {
 353         priv->msg++;
 354         priv->msgs_left--;
 355         priv->flags &= ID_P_MASK;
 356         rcar_i2c_prepare_msg(priv);
 357 }
 358
 359 /*
 360  *              interrupt functions
 361  */
 362 static void rcar_i2c_dma_unmap(struct rcar_i2c_priv *priv)
 363 {
 364         struct dma_chan *chan = priv->dma_direction == DMA_FROM_DEVICE
 365                 ? priv->dma_rx : priv->dma_tx;
 366
 367         /* Disable DMA Master Received/Transmitted */
 368         rcar_i2c_write(priv, ICDMAER, 0);
 369
 370         /* Reset default delay */
 371         rcar_i2c_write(priv, ICFBSCR, TCYC06);
 372
 373         dma_unmap_single(chan->device->dev, sg_dma_address(&priv->sg),
 374                          sg_dma_len(&priv->sg), priv->dma_direction);
 375
 376         /* Gen3 can only do one RXDMA per transfer and we just completed it */
 377         if (priv->devtype == I2C_RCAR_GEN3 &&
 378             priv->dma_direction == DMA_FROM_DEVICE)
 379                 priv->flags |= ID_P_NO_RXDMA;
 380
 381         priv->dma_direction = DMA_NONE;
 382 }
 383
 384 static void rcar_i2c_cleanup_dma(struct rcar_i2c_priv *priv)
 385 {
 386         if (priv->dma_direction == DMA_NONE)
 387                 return;
 388         else if (priv->dma_direction == DMA_FROM_DEVICE)
 389                 dmaengine_terminate_all(priv->dma_rx);
 390         else if (priv->dma_direction == DMA_TO_DEVICE)
 391                 dmaengine_terminate_all(priv->dma_tx);
 392
 393         rcar_i2c_dma_unmap(priv);
 394 }
 395
 396 static void rcar_i2c_dma_callback(void *data)
 397 {
 398         struct rcar_i2c_priv *priv = data;
 399
 400         priv->pos += sg_dma_len(&priv->sg);
 401
 402         rcar_i2c_dma_unmap(priv);
 403 }
 404
 405 static void rcar_i2c_dma(struct rcar_i2c_priv *priv)
 406 {
 407         struct device *dev = rcar_i2c_priv_to_dev(priv);
 408         struct i2c_msg *msg = priv->msg;
 409         bool read = msg->flags & I2C_M_RD;
 410         enum dma_data_direction dir = read ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
 411         struct dma_chan *chan = read ? priv->dma_rx : priv->dma_tx;
 412         struct dma_async_tx_descriptor *txdesc;
 413         dma_addr_t dma_addr;
 414         dma_cookie_t cookie;
 415         unsigned char *buf;
 416         int len;
 417
 418         /* Do various checks to see if DMA is feasible at all */
 419         if (IS_ERR(chan) || msg->len < 8 || !(msg->flags & I2C_M_DMA_SAFE) ||
 420             (read && priv->flags & ID_P_NO_RXDMA))
 421                 return;
 422
 423         if (read) {
 424                 /*
 425                  * The last two bytes needs to be fetched using PIO in
 426                  * order for the STOP phase to work.
 427                  */
 428                 buf = priv->msg->buf;
 429                 len = priv->msg->len - 2;
 430         } else {
 431                 /*
 432                  * First byte in message was sent using PIO.
 433                  */
 434                 buf = priv->msg->buf + 1;
 435                 len = priv->msg->len - 1;
 436         }
 437
 438         dma_addr = dma_map_single(chan->device->dev, buf, len, dir);
 439         if (dma_mapping_error(chan->device->dev, dma_addr)) {
 440                 dev_dbg(dev, "dma map failed, using PIO\n");
 441                 return;
 442         }
 443
 444         sg_dma_len(&priv->sg) = len;
 445         sg_dma_address(&priv->sg) = dma_addr;
 446
 447         priv->dma_direction = dir;
 448
 449         txdesc = dmaengine_prep_slave_sg(chan, &priv->sg, 1,
 450                                          read ? DMA_DEV_TO_MEM : DMA_MEM_TO_DEV,
 451                                          DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 452         if (!txdesc) {
 453                 dev_dbg(dev, "dma prep slave sg failed, using PIO\n");
 454                 rcar_i2c_cleanup_dma(priv);
 455                 return;
 456         }
 457
 458         txdesc->callback = rcar_i2c_dma_callback;
 459         txdesc->callback_param = priv;
 460
 461         cookie = dmaengine_submit(txdesc);
 462         if (dma_submit_error(cookie)) {
 463                 dev_dbg(dev, "submitting dma failed, using PIO\n");
 464                 rcar_i2c_cleanup_dma(priv);
 465                 return;
 466         }
 467
 468         /* Set delay for DMA operations */
 469         rcar_i2c_write(priv, ICFBSCR, TCYC17);
 470
 471         /* Enable DMA Master Received/Transmitted */
 472         if (read)
 473                 rcar_i2c_write(priv, ICDMAER, RMDMAE);
 474         else
 475                 rcar_i2c_write(priv, ICDMAER, TMDMAE);
 476
 477         dma_async_issue_pending(chan);
 478 }
 479
 480 static void rcar_i2c_irq_send(struct rcar_i2c_priv *priv, u32 msr)
 481 {
 482         struct i2c_msg *msg = priv->msg;
 483
 484         /* FIXME: sometimes, unknown interrupt happened. Do nothing */
 485         if (!(msr & MDE))
 486                 return;
 487
 488         if (priv->pos < msg->len) {
 489                 /*
 490                  * Prepare next data to ICRXTX register.
 491                  * This data will go to _SHIFT_ register.
 492                  *
 493                  *    *
 494                  * [ICRXTX] -> [SHIFT] -> [I2C bus]
 495                  */
 496                 rcar_i2c_write(priv, ICRXTX, msg->buf[priv->pos]);
 497                 priv->pos++;
 498
 499                 /*
 500                  * Try to use DMA to transmit the rest of the data if
 501                  * address transfer phase just finished.
 502                  */
 503                 if (msr & MAT)
 504                         rcar_i2c_dma(priv);
 505         } else {
 506                 /*
 507                  * The last data was pushed to ICRXTX on _PREV_ empty irq.
 508                  * It is on _SHIFT_ register, and will sent to I2C bus.
 509                  *
 510                  *                *
 511                  * [ICRXTX] -> [SHIFT] -> [I2C bus]
 512                  */
 513
 514                 if (priv->flags & ID_LAST_MSG) {
 515                         /*
 516                          * If current msg is the _LAST_ msg,
 517                          * prepare stop condition here.
 518                          * ID_DONE will be set on STOP irq.
 519                          */
 520                         rcar_i2c_write(priv, ICMCR, RCAR_BUS_PHASE_STOP);
 521                 } else {
 522                         rcar_i2c_next_msg(priv);
 523                         return;
 524                 }
 525         }
 526
 527         rcar_i2c_write(priv, ICMSR, RCAR_IRQ_ACK_SEND);
 528 }
 529
 530 static void rcar_i2c_irq_recv(struct rcar_i2c_priv *priv, u32 msr)
 531 {
 532         struct i2c_msg *msg = priv->msg;
 533
 534         /* FIXME: sometimes, unknown interrupt happened. Do nothing */
 535         if (!(msr & MDR))
 536                 return;
 537
 538         if (msr & MAT) {
 539                 /*
 540                  * Address transfer phase finished, but no data at this point.
 541                  * Try to use DMA to receive data.
 542                  */
 543                 rcar_i2c_dma(priv);
 544         } else if (priv->pos < msg->len) {
 545                 /* get received data */
 546                 msg->buf[priv->pos] = rcar_i2c_read(priv, ICRXTX);
 547                 priv->pos++;
 548         }
 549
 550         /* If next received data is the _LAST_, go to new phase. */
 551         if (priv->pos + 1 == msg->len) {
 552                 if (priv->flags & ID_LAST_MSG) {
 553                         rcar_i2c_write(priv, ICMCR, RCAR_BUS_PHASE_STOP);
 554                 } else {
 555                         rcar_i2c_write(priv, ICMCR, RCAR_BUS_PHASE_START);
 556                         priv->flags |= ID_P_REP_AFTER_RD;
 557                 }
 558         }
 559
 560         if (priv->pos == msg->len && !(priv->flags & ID_LAST_MSG))
 561                 rcar_i2c_next_msg(priv);
 562         else
 563                 rcar_i2c_write(priv, ICMSR, RCAR_IRQ_ACK_RECV);
 564 }
 565
 566 static bool rcar_i2c_slave_irq(struct rcar_i2c_priv *priv)
 567 {
 568         u32 ssr_raw, ssr_filtered;
 569         u8 value;
 570
 571         ssr_raw = rcar_i2c_read(priv, ICSSR) & 0xff;
 572         ssr_filtered = ssr_raw & rcar_i2c_read(priv, ICSIER);
 573
 574         if (!ssr_filtered)
 575                 return false;
 576
 577         /* address detected */
 578         if (ssr_filtered & SAR) {
 579                 /* read or write request */
 580                 if (ssr_raw & STM) {
 581                         i2c_slave_event(priv->slave, I2C_SLAVE_READ_REQUESTED, &value);
 582                         rcar_i2c_write(priv, ICRXTX, value);
 583                         rcar_i2c_write(priv, ICSIER, SDE | SSR | SAR);
 584                 } else {
 585                         i2c_slave_event(priv->slave, I2C_SLAVE_WRITE_REQUESTED, &value);
 586                         rcar_i2c_read(priv, ICRXTX);    /* dummy read */
 587                         rcar_i2c_write(priv, ICSIER, SDR | SSR | SAR);
 588                 }
 589
 590                 /* Clear SSR, too, because of old STOPs to other clients than us */
 591                 rcar_i2c_write(priv, ICSSR, ~(SAR | SSR) & 0xff);
 592         }
 593
 594         /* master sent stop */
 595         if (ssr_filtered & SSR) {
 596                 i2c_slave_event(priv->slave, I2C_SLAVE_STOP, &value);
 597                 rcar_i2c_write(priv, ICSCR, SIE | SDBS); /* clear our NACK */
 598                 rcar_i2c_write(priv, ICSIER, SAR);
 599                 rcar_i2c_write(priv, ICSSR, ~SSR & 0xff);
 600         }
 601
 602         /* master wants to write to us */
 603         if (ssr_filtered & SDR) {
 604                 int ret;
 605
 606                 value = rcar_i2c_read(priv, ICRXTX);
 607                 ret = i2c_slave_event(priv->slave, I2C_SLAVE_WRITE_RECEIVED, &value);
 608                 /* Send NACK in case of error */
 609                 rcar_i2c_write(priv, ICSCR, SIE | SDBS | (ret < 0 ? FNA : 0));
 610                 rcar_i2c_write(priv, ICSSR, ~SDR & 0xff);
 611         }
 612
 613         /* master wants to read from us */
 614         if (ssr_filtered & SDE) {
 615                 i2c_slave_event(priv->slave, I2C_SLAVE_READ_PROCESSED, &value);
 616                 rcar_i2c_write(priv, ICRXTX, value);
 617                 rcar_i2c_write(priv, ICSSR, ~SDE & 0xff);
 618         }
 619
 620         return true;
 621 }
 622
 623 static irqreturn_t rcar_i2c_irq(int irq, void *ptr)
 624 {
 625         struct rcar_i2c_priv *priv = ptr;
 626         u32 msr, val;
 627
 628         /* Clear START or STOP immediately, except for REPSTART after read */
 629         if (likely(!(priv->flags & ID_P_REP_AFTER_RD))) {
 630                 val = rcar_i2c_read(priv, ICMCR);
 631                 rcar_i2c_write(priv, ICMCR, val & RCAR_BUS_MASK_DATA);
 632         }
 633
 634         msr = rcar_i2c_read(priv, ICMSR);
 635
 636         /* Only handle interrupts that are currently enabled */
 637         msr &= rcar_i2c_read(priv, ICMIER);
 638         if (!msr) {
 639                 if (rcar_i2c_slave_irq(priv))
 640                         return IRQ_HANDLED;
 641
 642                 return IRQ_NONE;
 643         }
 644
 645         /* Arbitration lost */
 646         if (msr & MAL) {
 647                 priv->flags |= ID_DONE | ID_ARBLOST;
 648                 goto out;
 649         }
 650
 651         /* Nack */
 652         if (msr & MNR) {
 653                 /* HW automatically sends STOP after received NACK */
 654                 rcar_i2c_write(priv, ICMIER, RCAR_IRQ_STOP);
 655                 priv->flags |= ID_NACK;
 656                 goto out;
 657         }
 658
 659         /* Stop */
 660         if (msr & MST) {
 661                 priv->msgs_left--; /* The last message also made it */
 662                 priv->flags |= ID_DONE;
 663                 goto out;
 664         }
 665
 666         if (rcar_i2c_is_recv(priv))
 667                 rcar_i2c_irq_recv(priv, msr);
 668         else
 669                 rcar_i2c_irq_send(priv, msr);
 670
 671 out:
 672         if (priv->flags & ID_DONE) {
 673                 rcar_i2c_write(priv, ICMIER, 0);
 674                 rcar_i2c_write(priv, ICMSR, 0);
 675                 wake_up(&priv->wait);
 676         }
 677
 678         return IRQ_HANDLED;
 679 }
 680
 681 static struct dma_chan *rcar_i2c_request_dma_chan(struct device *dev,
 682                                         enum dma_transfer_direction dir,
 683                                         dma_addr_t port_addr)
 684 {
 685         struct dma_chan *chan;
 686         struct dma_slave_config cfg;
 687         char *chan_name = dir == DMA_MEM_TO_DEV ? "tx" : "rx";
 688         int ret;
 689
 690         chan = dma_request_chan(dev, chan_name);
 691         if (IS_ERR(chan)) {
 692                 dev_dbg(dev, "request_channel failed for %s (%ld)\n",
 693                         chan_name, PTR_ERR(chan));
 694                 return chan;
 695         }
 696
 697         memset(&cfg, 0, sizeof(cfg));
 698         cfg.direction = dir;
 699         if (dir == DMA_MEM_TO_DEV) {
 700                 cfg.dst_addr = port_addr;
 701                 cfg.dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
 702         } else {
 703                 cfg.src_addr = port_addr;
 704                 cfg.src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
 705         }
 706
 707         ret = dmaengine_slave_config(chan, &cfg);
 708         if (ret) {
 709                 dev_dbg(dev, "slave_config failed for %s (%d)\n",
 710                         chan_name, ret);
 711                 dma_release_channel(chan);
 712                 return ERR_PTR(ret);
 713         }
 714
 715         dev_dbg(dev, "got DMA channel for %s\n", chan_name);
 716         return chan;
 717 }
 718
 719 static void rcar_i2c_request_dma(struct rcar_i2c_priv *priv,
 720                                  struct i2c_msg *msg)
 721 {
 722         struct device *dev = rcar_i2c_priv_to_dev(priv);
 723         bool read;
 724         struct dma_chan *chan;
 725         enum dma_transfer_direction dir;
 726
 727         read = msg->flags & I2C_M_RD;
 728
 729         chan = read ? priv->dma_rx : priv->dma_tx;
 730         if (PTR_ERR(chan) != -EPROBE_DEFER)
 731                 return;
 732
 733         dir = read ? DMA_DEV_TO_MEM : DMA_MEM_TO_DEV;
 734         chan = rcar_i2c_request_dma_chan(dev, dir, priv->res->start + ICRXTX);
 735
 736         if (read)
 737                 priv->dma_rx = chan;
 738         else
 739                 priv->dma_tx = chan;
 740 }
 741
 742 static void rcar_i2c_release_dma(struct rcar_i2c_priv *priv)
 743 {
 744         if (!IS_ERR(priv->dma_tx)) {
 745                 dma_release_channel(priv->dma_tx);
 746                 priv->dma_tx = ERR_PTR(-EPROBE_DEFER);
 747         }
 748
 749         if (!IS_ERR(priv->dma_rx)) {
 750                 dma_release_channel(priv->dma_rx);
 751                 priv->dma_rx = ERR_PTR(-EPROBE_DEFER);
 752         }
 753 }
 754
 755 /* I2C is a special case, we need to poll the status of a reset */
 756 static int rcar_i2c_do_reset(struct rcar_i2c_priv *priv)
 757 {
 758         int i, ret;
 759
 760         ret = reset_control_reset(priv->rstc);
 761         if (ret)
 762                 return ret;
 763
 764         for (i = 0; i < LOOP_TIMEOUT; i++) {
 765                 ret = reset_control_status(priv->rstc);
 766                 if (ret == 0)
 767                         return 0;
 768                 udelay(1);
 769         }
 770
 771         return -ETIMEDOUT;
 772 }
 773
 774 static int rcar_i2c_master_xfer(struct i2c_adapter *adap,
 775                                 struct i2c_msg *msgs,
 776                                 int num)
 777 {
 778         struct rcar_i2c_priv *priv = i2c_get_adapdata(adap);
 779         struct device *dev = rcar_i2c_priv_to_dev(priv);
 780         int i, ret;
 781         long time_left;
 782
 783         pm_runtime_get_sync(dev);
 784
 785         /* Check bus state before init otherwise bus busy info will be lost */
 786         ret = rcar_i2c_bus_barrier(priv);
 787         if (ret < 0)
 788                 goto out;
 789
 790         /* Gen3 needs a reset before allowing RXDMA once */
 791         if (priv->devtype == I2C_RCAR_GEN3) {
 792                 priv->flags |= ID_P_NO_RXDMA;
 793                 if (!IS_ERR(priv->rstc)) {
 794                         ret = rcar_i2c_do_reset(priv);
 795                         if (ret == 0)
 796                                 priv->flags &= ~ID_P_NO_RXDMA;
 797                 }
 798         }
 799
 800         rcar_i2c_init(priv);
 801
 802         for (i = 0; i < num; i++)
 803                 rcar_i2c_request_dma(priv, msgs + i);
 804
 805         /* init first message */
 806         priv->msg = msgs;
 807         priv->msgs_left = num;
 808         priv->flags = (priv->flags & ID_P_MASK) | ID_FIRST_MSG;
 809         rcar_i2c_prepare_msg(priv);
 810
 811         time_left = wait_event_timeout(priv->wait, priv->flags & ID_DONE,
 812                                      num * adap->timeout);
 813
 814         /* cleanup DMA if it couldn't complete properly due to an error */
 815         if (priv->dma_direction != DMA_NONE)
 816                 rcar_i2c_cleanup_dma(priv);
 817
 818         if (!time_left) {
 819                 rcar_i2c_init(priv);
 820                 ret = -ETIMEDOUT;
 821         } else if (priv->flags & ID_NACK) {
 822                 ret = -ENXIO;
 823         } else if (priv->flags & ID_ARBLOST) {
 824                 ret = -EAGAIN;
 825         } else {
 826                 ret = num - priv->msgs_left; /* The number of transfer */
 827         }
 828 out:
 829         pm_runtime_put(dev);
 830
 831         if (ret < 0 && ret != -ENXIO)
 832                 dev_err(dev, "error %d : %x\n", ret, priv->flags);
 833
 834         return ret;
 835 }
 836
 837 static int rcar_reg_slave(struct i2c_client *slave)
 838 {
 839         struct rcar_i2c_priv *priv = i2c_get_adapdata(slave->adapter);
 840
 841         if (priv->slave)
 842                 return -EBUSY;
 843
 844         if (slave->flags & I2C_CLIENT_TEN)
 845                 return -EAFNOSUPPORT;
 846
 847         /* Keep device active for slave address detection logic */
 848         pm_runtime_get_sync(rcar_i2c_priv_to_dev(priv));
 849
 850         priv->slave = slave;
 851         rcar_i2c_write(priv, ICSAR, slave->addr);
 852         rcar_i2c_write(priv, ICSSR, 0);
 853         rcar_i2c_write(priv, ICSIER, SAR);
 854         rcar_i2c_write(priv, ICSCR, SIE | SDBS);
 855
 856         return 0;
 857 }
 858
 859 static int rcar_unreg_slave(struct i2c_client *slave)
 860 {
 861         struct rcar_i2c_priv *priv = i2c_get_adapdata(slave->adapter);
 862
 863         WARN_ON(!priv->slave);
 864
 865         /* ensure no irq is running before clearing ptr */
 866         disable_irq(priv->irq);
 867         rcar_i2c_write(priv, ICSIER, 0);
 868         rcar_i2c_write(priv, ICSSR, 0);
 869         enable_irq(priv->irq);
 870         rcar_i2c_write(priv, ICSCR, SDBS);
 871         rcar_i2c_write(priv, ICSAR, 0); /* Gen2: must be 0 if not using slave */
 872
 873         priv->slave = NULL;
 874
 875         pm_runtime_put(rcar_i2c_priv_to_dev(priv));
 876
 877         return 0;
 878 }
 879
 880 static u32 rcar_i2c_func(struct i2c_adapter *adap)
 881 {
 882         /*
 883          * This HW can't do:
 884          * I2C_SMBUS_QUICK (setting FSB during START didn't work)
 885          * I2C_M_NOSTART (automatically sends address after START)
 886          * I2C_M_IGNORE_NAK (automatically sends STOP after NAK)
 887          */
 888         return I2C_FUNC_I2C | I2C_FUNC_SLAVE |
 889                 (I2C_FUNC_SMBUS_EMUL & ~I2C_FUNC_SMBUS_QUICK);
 890 }
 891
 892 static const struct i2c_algorithm rcar_i2c_algo = {
 893         .master_xfer    = rcar_i2c_master_xfer,
 894         .functionality  = rcar_i2c_func,
 895         .reg_slave      = rcar_reg_slave,
 896         .unreg_slave    = rcar_unreg_slave,
 897 };
 898
 899 static const struct i2c_adapter_quirks rcar_i2c_quirks = {
 900         .flags = I2C_AQ_NO_ZERO_LEN,
 901 };
 902
 903 static const struct of_device_id rcar_i2c_dt_ids[] = {
 904         { .compatible = "renesas,i2c-r8a7778", .data = (void *)I2C_RCAR_GEN1 },
 905         { .compatible = "renesas,i2c-r8a7779", .data = (void *)I2C_RCAR_GEN1 },
 906         { .compatible = "renesas,i2c-r8a7790", .data = (void *)I2C_RCAR_GEN2 },
 907         { .compatible = "renesas,i2c-r8a7791", .data = (void *)I2C_RCAR_GEN2 },
 908         { .compatible = "renesas,i2c-r8a7792", .data = (void *)I2C_RCAR_GEN2 },
 909         { .compatible = "renesas,i2c-r8a7793", .data = (void *)I2C_RCAR_GEN2 },
 910         { .compatible = "renesas,i2c-r8a7794", .data = (void *)I2C_RCAR_GEN2 },
 911         { .compatible = "renesas,i2c-r8a7795", .data = (void *)I2C_RCAR_GEN3 },
 912         { .compatible = "renesas,i2c-r8a7796", .data = (void *)I2C_RCAR_GEN3 },
 913         { .compatible = "renesas,i2c-rcar", .data = (void *)I2C_RCAR_GEN1 },    /* Deprecated */
 914         { .compatible = "renesas,rcar-gen1-i2c", .data = (void *)I2C_RCAR_GEN1 },
 915         { .compatible = "renesas,rcar-gen2-i2c", .data = (void *)I2C_RCAR_GEN2 },
 916         { .compatible = "renesas,rcar-gen3-i2c", .data = (void *)I2C_RCAR_GEN3 },
 917         {},
 918 };
 919 MODULE_DEVICE_TABLE(of, rcar_i2c_dt_ids);
 920
 921 static int rcar_i2c_probe(struct platform_device *pdev)
 922 {
 923         struct rcar_i2c_priv *priv;
 924         struct i2c_adapter *adap;
 925         struct device *dev = &pdev->dev;
 926         struct i2c_timings i2c_t;
 927         int ret;
 928
 929         priv = devm_kzalloc(dev, sizeof(struct rcar_i2c_priv), GFP_KERNEL);
 930         if (!priv)
 931                 return -ENOMEM;
 932
 933         priv->clk = devm_clk_get(dev, NULL);
 934         if (IS_ERR(priv->clk)) {
 935                 dev_err(dev, "cannot get clock\n");
 936                 return PTR_ERR(priv->clk);
 937         }
 938
 939         priv->res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 940
 941         priv->io = devm_ioremap_resource(dev, priv->res);
 942         if (IS_ERR(priv->io))
 943                 return PTR_ERR(priv->io);
 944
 945         priv->devtype = (enum rcar_i2c_type)of_device_get_match_data(dev);
 946         init_waitqueue_head(&priv->wait);
 947
 948         adap = &priv->adap;
 949         adap->nr = pdev->id;
 950         adap->algo = &rcar_i2c_algo;
 951         adap->class = I2C_CLASS_DEPRECATED;
 952         adap->retries = 3;
 953         adap->dev.parent = dev;
 954         adap->dev.of_node = dev->of_node;
 955         adap->bus_recovery_info = &rcar_i2c_bri;
 956         adap->quirks = &rcar_i2c_quirks;
 957         i2c_set_adapdata(adap, priv);
 958         strlcpy(adap->name, pdev->name, sizeof(adap->name));
 959
 960         i2c_parse_fw_timings(dev, &i2c_t, false);
 961
 962         /* Init DMA */
 963         sg_init_table(&priv->sg, 1);
 964         priv->dma_direction = DMA_NONE;
 965         priv->dma_rx = priv->dma_tx = ERR_PTR(-EPROBE_DEFER);
 966
 967         /* Activate device for clock calculation */
 968         pm_runtime_enable(dev);
 969         pm_runtime_get_sync(dev);
 970         ret = rcar_i2c_clock_calculate(priv, &i2c_t);
 971         if (ret < 0)
 972                 goto out_pm_put;
 973
 974         rcar_i2c_write(priv, ICSAR, 0); /* Gen2: must be 0 if not using slave */
 975
 976         if (priv->devtype == I2C_RCAR_GEN3) {
 977                 priv->rstc = devm_reset_control_get_exclusive(&pdev->dev, NULL);
 978                 if (!IS_ERR(priv->rstc)) {
 979                         ret = reset_control_status(priv->rstc);
 980                         if (ret < 0)
 981                                 priv->rstc = ERR_PTR(-ENOTSUPP);
 982                 }
 983         }
 984
 985         /* Stay always active when multi-master to keep arbitration working */
 986         if (of_property_read_bool(dev->of_node, "multi-master"))
 987                 priv->flags |= ID_P_PM_BLOCKED;
 988         else
 989                 pm_runtime_put(dev);
 990
 991
 992         priv->irq = platform_get_irq(pdev, 0);
 993         ret = devm_request_irq(dev, priv->irq, rcar_i2c_irq, 0, dev_name(dev), priv);
 994         if (ret < 0) {
 995                 dev_err(dev, "cannot get irq %d\n", priv->irq);
 996                 goto out_pm_disable;
 997         }
 998
 999         platform_set_drvdata(pdev, priv);
1000
1001         ret = i2c_add_numbered_adapter(adap);
1002         if (ret < 0)
1003                 goto out_pm_disable;
1004
1005         dev_info(dev, "probed\n");
1006
1007         return 0;
1008
1009  out_pm_put:
1010         pm_runtime_put(dev);
1011  out_pm_disable:
1012         pm_runtime_disable(dev);
1013         return ret;
1014 }
1015
1016 static int rcar_i2c_remove(struct platform_device *pdev)
1017 {
1018         struct rcar_i2c_priv *priv = platform_get_drvdata(pdev);
1019         struct device *dev = &pdev->dev;
1020
1021         i2c_del_adapter(&priv->adap);
1022         rcar_i2c_release_dma(priv);
1023         if (priv->flags & ID_P_PM_BLOCKED)
1024                 pm_runtime_put(dev);
1025         pm_runtime_disable(dev);
1026
1027         return 0;
1028 }
1029
1030 static struct platform_driver rcar_i2c_driver = {
1031         .driver = {
1032                 .name   = "i2c-rcar",
1033                 .of_match_table = rcar_i2c_dt_ids,
1034         },
1035         .probe          = rcar_i2c_probe,
1036         .remove         = rcar_i2c_remove,
1037 };
1038
1039 module_platform_driver(rcar_i2c_driver);
1040
1041 MODULE_LICENSE("GPL v2");
1042 MODULE_DESCRIPTION("Renesas R-Car I2C bus driver");
1043 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");