1 // SPDX-License-Identifier: GPL-2.0
3 * Driver for the Renesas R-Car I2C unit
6 * Copyright (C) 2011-2019 Renesas Electronics Corporation
8 * Copyright (C) 2012-14 Renesas Solutions Corp.
11 * This file is based on the drivers/i2c/busses/i2c-sh7760.c
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>
22 #include <linux/iopoll.h>
23 #include <linux/i2c.h>
24 #include <linux/i2c-smbus.h>
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/of_device.h>
28 #include <linux/platform_device.h>
29 #include <linux/pm_runtime.h>
30 #include <linux/reset.h>
31 #include <linux/slab.h>
33 /* register offsets */
34 #define ICSCR 0x00 /* slave ctrl */
35 #define ICMCR 0x04 /* master ctrl */
36 #define ICSSR 0x08 /* slave status */
37 #define ICMSR 0x0C /* master status */
38 #define ICSIER 0x10 /* slave irq enable */
39 #define ICMIER 0x14 /* master irq enable */
40 #define ICCCR 0x18 /* clock dividers */
41 #define ICSAR 0x1C /* slave address */
42 #define ICMAR 0x20 /* master address */
43 #define ICRXTX 0x24 /* data port */
44 #define ICFBSCR 0x38 /* first bit setup cycle (Gen3) */
45 #define ICDMAER 0x3c /* DMA enable (Gen3) */
48 #define SDBS BIT(3) /* slave data buffer select */
49 #define SIE BIT(2) /* slave interface enable */
50 #define GCAE BIT(1) /* general call address enable */
51 #define FNA BIT(0) /* forced non acknowledgment */
54 #define MDBS BIT(7) /* non-fifo mode switch */
55 #define FSCL BIT(6) /* override SCL pin */
56 #define FSDA BIT(5) /* override SDA pin */
57 #define OBPC BIT(4) /* override pins */
58 #define MIE BIT(3) /* master if enable */
60 #define FSB BIT(1) /* force stop bit */
61 #define ESG BIT(0) /* enable start bit gen */
63 /* ICSSR (also for ICSIER) */
64 #define GCAR BIT(6) /* general call received */
65 #define STM BIT(5) /* slave transmit mode */
66 #define SSR BIT(4) /* stop received */
67 #define SDE BIT(3) /* slave data empty */
68 #define SDT BIT(2) /* slave data transmitted */
69 #define SDR BIT(1) /* slave data received */
70 #define SAR BIT(0) /* slave addr received */
72 /* ICMSR (also for ICMIE) */
73 #define MNR BIT(6) /* nack received */
74 #define MAL BIT(5) /* arbitration lost */
75 #define MST BIT(4) /* sent a stop */
79 #define MAT BIT(0) /* slave addr xfer done */
82 #define RSDMAE BIT(3) /* DMA Slave Received Enable */
83 #define TSDMAE BIT(2) /* DMA Slave Transmitted Enable */
84 #define RMDMAE BIT(1) /* DMA Master Received Enable */
85 #define TMDMAE BIT(0) /* DMA Master Transmitted Enable */
88 #define TCYC17 0x0f /* 17*Tcyc delay 1st bit between SDA and SCL */
90 #define RCAR_MIN_DMA_LEN 8
92 #define RCAR_BUS_PHASE_START (MDBS | MIE | ESG)
93 #define RCAR_BUS_PHASE_DATA (MDBS | MIE)
94 #define RCAR_BUS_PHASE_STOP (MDBS | MIE | FSB)
96 #define RCAR_IRQ_SEND (MNR | MAL | MST | MAT | MDE)
97 #define RCAR_IRQ_RECV (MNR | MAL | MST | MAT | MDR)
98 #define RCAR_IRQ_STOP (MST)
100 #define ID_LAST_MSG BIT(0)
101 #define ID_REP_AFTER_RD BIT(1)
102 #define ID_DONE BIT(2)
103 #define ID_ARBLOST BIT(3)
104 #define ID_NACK BIT(4)
105 #define ID_EPROTO BIT(5)
106 /* persistent flags */
107 #define ID_P_NOT_ATOMIC BIT(28)
108 #define ID_P_HOST_NOTIFY 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, 28)
119 struct rcar_i2c_priv {
122 struct i2c_adapter adap;
127 wait_queue_head_t wait;
131 u8 recovery_icmcr; /* protected by adapter lock */
132 enum rcar_i2c_type devtype;
133 struct i2c_client *slave;
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;
141 struct reset_control *rstc;
144 struct i2c_client *host_notify_client;
147 #define rcar_i2c_priv_to_dev(p) ((p)->adap.dev.parent)
148 #define rcar_i2c_is_recv(p) ((p)->msg->flags & I2C_M_RD)
150 static void rcar_i2c_write(struct rcar_i2c_priv *priv, int reg, u32 val)
152 writel(val, priv->io + reg);
155 static u32 rcar_i2c_read(struct rcar_i2c_priv *priv, int reg)
157 return readl(priv->io + reg);
160 static void rcar_i2c_clear_irq(struct rcar_i2c_priv *priv, u32 val)
162 writel(~val & 0x7f, priv->io + ICMSR);
165 static int rcar_i2c_get_scl(struct i2c_adapter *adap)
167 struct rcar_i2c_priv *priv = i2c_get_adapdata(adap);
169 return !!(rcar_i2c_read(priv, ICMCR) & FSCL);
173 static void rcar_i2c_set_scl(struct i2c_adapter *adap, int val)
175 struct rcar_i2c_priv *priv = i2c_get_adapdata(adap);
178 priv->recovery_icmcr |= FSCL;
180 priv->recovery_icmcr &= ~FSCL;
182 rcar_i2c_write(priv, ICMCR, priv->recovery_icmcr);
185 static void rcar_i2c_set_sda(struct i2c_adapter *adap, int val)
187 struct rcar_i2c_priv *priv = i2c_get_adapdata(adap);
190 priv->recovery_icmcr |= FSDA;
192 priv->recovery_icmcr &= ~FSDA;
194 rcar_i2c_write(priv, ICMCR, priv->recovery_icmcr);
197 static int rcar_i2c_get_bus_free(struct i2c_adapter *adap)
199 struct rcar_i2c_priv *priv = i2c_get_adapdata(adap);
201 return !(rcar_i2c_read(priv, ICMCR) & FSDA);
205 static struct i2c_bus_recovery_info rcar_i2c_bri = {
206 .get_scl = rcar_i2c_get_scl,
207 .set_scl = rcar_i2c_set_scl,
208 .set_sda = rcar_i2c_set_sda,
209 .get_bus_free = rcar_i2c_get_bus_free,
210 .recover_bus = i2c_generic_scl_recovery,
212 static void rcar_i2c_init(struct rcar_i2c_priv *priv)
214 /* reset master mode */
215 rcar_i2c_write(priv, ICMIER, 0);
216 rcar_i2c_write(priv, ICMCR, MDBS);
217 rcar_i2c_write(priv, ICMSR, 0);
219 rcar_i2c_write(priv, ICCCR, priv->icccr);
221 if (priv->devtype == I2C_RCAR_GEN3)
222 rcar_i2c_write(priv, ICFBSCR, TCYC17);
226 static int rcar_i2c_bus_barrier(struct rcar_i2c_priv *priv)
231 ret = readl_poll_timeout(priv->io + ICMCR, val, !(val & FSDA), 10,
234 /* Waiting did not help, try to recover */
235 priv->recovery_icmcr = MDBS | OBPC | FSDA | FSCL;
236 ret = i2c_recover_bus(&priv->adap);
242 static int rcar_i2c_clock_calculate(struct rcar_i2c_priv *priv)
244 u32 scgd, cdf, round, ick, sum, scl, cdf_width;
246 struct device *dev = rcar_i2c_priv_to_dev(priv);
247 struct i2c_timings t = {
248 .bus_freq_hz = I2C_MAX_STANDARD_MODE_FREQ,
251 .scl_int_delay_ns = 50,
254 /* Fall back to previously used values if not supplied */
255 i2c_parse_fw_timings(dev, &t, false);
257 switch (priv->devtype) {
266 dev_err(dev, "device type error\n");
271 * calculate SCL clock
275 * ick = clkp / (1 + CDF)
276 * SCL = ick / (20 + SCGD * 8 + F[(ticf + tr + intd) * ick])
278 * ick : I2C internal clock < 20 MHz
279 * ticf : I2C SCL falling time
280 * tr : I2C SCL rising time
281 * intd : LSI internal delay
282 * clkp : peripheral_clk
283 * F[] : integer up-valuation
285 rate = clk_get_rate(priv->clk);
286 cdf = rate / 20000000;
287 if (cdf >= 1U << cdf_width) {
288 dev_err(dev, "Input clock %lu too high\n", rate);
291 ick = rate / (cdf + 1);
294 * it is impossible to calculate large scale
295 * number on u32. separate it
297 * F[(ticf + tr + intd) * ick] with sum = (ticf + tr + intd)
298 * = F[sum * ick / 1000000000]
299 * = F[(ick / 1000000) * sum / 1000]
301 sum = t.scl_fall_ns + t.scl_rise_ns + t.scl_int_delay_ns;
302 round = (ick + 500000) / 1000000 * sum;
303 round = (round + 500) / 1000;
306 * SCL = ick / (20 + SCGD * 8 + F[(ticf + tr + intd) * ick])
308 * Calculation result (= SCL) should be less than
309 * bus_speed for hardware safety
311 * We could use something along the lines of
312 * div = ick / (bus_speed + 1) + 1;
313 * scgd = (div - 20 - round + 7) / 8;
314 * scl = ick / (20 + (scgd * 8) + round);
315 * (not fully verified) but that would get pretty involved
317 for (scgd = 0; scgd < 0x40; scgd++) {
318 scl = ick / (20 + (scgd * 8) + round);
319 if (scl <= t.bus_freq_hz)
322 dev_err(dev, "it is impossible to calculate best SCL\n");
326 dev_dbg(dev, "clk %d/%d(%lu), round %u, CDF:0x%x, SCGD: 0x%x\n",
327 scl, t.bus_freq_hz, rate, round, cdf, scgd);
329 /* keep icccr value */
330 priv->icccr = scgd << cdf_width | cdf;
336 * We don't have a test case but the HW engineers say that the write order of
337 * ICMSR and ICMCR depends on whether we issue START or REP_START. So, ICMSR
338 * handling is outside of this function. First messages clear ICMSR before this
339 * function, interrupt handlers clear the relevant bits after this function.
341 static void rcar_i2c_prepare_msg(struct rcar_i2c_priv *priv)
343 int read = !!rcar_i2c_is_recv(priv);
344 bool rep_start = !(priv->flags & ID_REP_AFTER_RD);
347 priv->flags &= ID_P_MASK;
349 if (priv->msgs_left == 1)
350 priv->flags |= ID_LAST_MSG;
352 rcar_i2c_write(priv, ICMAR, i2c_8bit_addr_from_msg(priv->msg));
353 if (priv->flags & ID_P_NOT_ATOMIC)
354 rcar_i2c_write(priv, ICMIER, read ? RCAR_IRQ_RECV : RCAR_IRQ_SEND);
357 rcar_i2c_write(priv, ICMCR, RCAR_BUS_PHASE_START);
360 static void rcar_i2c_first_msg(struct rcar_i2c_priv *priv,
361 struct i2c_msg *msgs, int num)
364 priv->msgs_left = num;
365 rcar_i2c_write(priv, ICMSR, 0); /* must be before preparing msg */
366 rcar_i2c_prepare_msg(priv);
369 static void rcar_i2c_next_msg(struct rcar_i2c_priv *priv)
373 rcar_i2c_prepare_msg(priv);
374 /* ICMSR handling must come afterwards in the irq handler */
377 static void rcar_i2c_cleanup_dma(struct rcar_i2c_priv *priv, bool terminate)
379 struct dma_chan *chan = priv->dma_direction == DMA_FROM_DEVICE
380 ? priv->dma_rx : priv->dma_tx;
382 /* only allowed from thread context! */
384 dmaengine_terminate_sync(chan);
386 dma_unmap_single(chan->device->dev, sg_dma_address(&priv->sg),
387 sg_dma_len(&priv->sg), priv->dma_direction);
389 /* Gen3 can only do one RXDMA per transfer and we just completed it */
390 if (priv->devtype == I2C_RCAR_GEN3 &&
391 priv->dma_direction == DMA_FROM_DEVICE)
392 priv->flags |= ID_P_NO_RXDMA;
394 priv->dma_direction = DMA_NONE;
396 /* Disable DMA Master Received/Transmitted, must be last! */
397 rcar_i2c_write(priv, ICDMAER, 0);
400 static void rcar_i2c_dma_callback(void *data)
402 struct rcar_i2c_priv *priv = data;
404 priv->pos += sg_dma_len(&priv->sg);
406 rcar_i2c_cleanup_dma(priv, false);
409 static bool rcar_i2c_dma(struct rcar_i2c_priv *priv)
411 struct device *dev = rcar_i2c_priv_to_dev(priv);
412 struct i2c_msg *msg = priv->msg;
413 bool read = msg->flags & I2C_M_RD;
414 enum dma_data_direction dir = read ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
415 struct dma_chan *chan = read ? priv->dma_rx : priv->dma_tx;
416 struct dma_async_tx_descriptor *txdesc;
422 /* Do various checks to see if DMA is feasible at all */
423 if (!(priv->flags & ID_P_NOT_ATOMIC) || IS_ERR(chan) || msg->len < RCAR_MIN_DMA_LEN ||
424 !(msg->flags & I2C_M_DMA_SAFE) || (read && priv->flags & ID_P_NO_RXDMA))
429 * The last two bytes needs to be fetched using PIO in
430 * order for the STOP phase to work.
432 buf = priv->msg->buf;
433 len = priv->msg->len - 2;
436 * First byte in message was sent using PIO.
438 buf = priv->msg->buf + 1;
439 len = priv->msg->len - 1;
442 dma_addr = dma_map_single(chan->device->dev, buf, len, dir);
443 if (dma_mapping_error(chan->device->dev, dma_addr)) {
444 dev_dbg(dev, "dma map failed, using PIO\n");
448 sg_dma_len(&priv->sg) = len;
449 sg_dma_address(&priv->sg) = dma_addr;
451 priv->dma_direction = dir;
453 txdesc = dmaengine_prep_slave_sg(chan, &priv->sg, 1,
454 read ? DMA_DEV_TO_MEM : DMA_MEM_TO_DEV,
455 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
457 dev_dbg(dev, "dma prep slave sg failed, using PIO\n");
458 rcar_i2c_cleanup_dma(priv, false);
462 txdesc->callback = rcar_i2c_dma_callback;
463 txdesc->callback_param = priv;
465 cookie = dmaengine_submit(txdesc);
466 if (dma_submit_error(cookie)) {
467 dev_dbg(dev, "submitting dma failed, using PIO\n");
468 rcar_i2c_cleanup_dma(priv, false);
472 /* Enable DMA Master Received/Transmitted */
474 rcar_i2c_write(priv, ICDMAER, RMDMAE);
476 rcar_i2c_write(priv, ICDMAER, TMDMAE);
478 dma_async_issue_pending(chan);
482 static void rcar_i2c_irq_send(struct rcar_i2c_priv *priv, u32 msr)
484 struct i2c_msg *msg = priv->msg;
485 u32 irqs_to_clear = MDE;
487 /* FIXME: sometimes, unknown interrupt happened. Do nothing */
492 irqs_to_clear |= MAT;
494 /* Check if DMA can be enabled and take over */
495 if (priv->pos == 1 && rcar_i2c_dma(priv))
498 if (priv->pos < msg->len) {
500 * Prepare next data to ICRXTX register.
501 * This data will go to _SHIFT_ register.
504 * [ICRXTX] -> [SHIFT] -> [I2C bus]
506 rcar_i2c_write(priv, ICRXTX, msg->buf[priv->pos]);
510 * The last data was pushed to ICRXTX on _PREV_ empty irq.
511 * It is on _SHIFT_ register, and will sent to I2C bus.
514 * [ICRXTX] -> [SHIFT] -> [I2C bus]
517 if (priv->flags & ID_LAST_MSG)
519 * If current msg is the _LAST_ msg,
520 * prepare stop condition here.
521 * ID_DONE will be set on STOP irq.
523 rcar_i2c_write(priv, ICMCR, RCAR_BUS_PHASE_STOP);
525 rcar_i2c_next_msg(priv);
528 rcar_i2c_clear_irq(priv, irqs_to_clear);
531 static void rcar_i2c_irq_recv(struct rcar_i2c_priv *priv, u32 msr)
533 struct i2c_msg *msg = priv->msg;
534 bool recv_len_init = priv->pos == 0 && msg->flags & I2C_M_RECV_LEN;
535 u32 irqs_to_clear = MDR;
537 /* FIXME: sometimes, unknown interrupt happened. Do nothing */
542 irqs_to_clear |= MAT;
544 * Address transfer phase finished, but no data at this point.
545 * Try to use DMA to receive data.
548 } else if (priv->pos < msg->len) {
549 /* get received data */
550 u8 data = rcar_i2c_read(priv, ICRXTX);
552 msg->buf[priv->pos] = data;
554 if (data == 0 || data > I2C_SMBUS_BLOCK_MAX) {
555 priv->flags |= ID_DONE | ID_EPROTO;
558 msg->len += msg->buf[0];
559 /* Enough data for DMA? */
560 if (rcar_i2c_dma(priv))
562 /* new length after RECV_LEN now properly initialized */
563 recv_len_init = false;
569 * If next received data is the _LAST_ and we are not waiting for a new
570 * length because of RECV_LEN, then go to a new phase.
572 if (priv->pos + 1 == msg->len && !recv_len_init) {
573 if (priv->flags & ID_LAST_MSG) {
574 rcar_i2c_write(priv, ICMCR, RCAR_BUS_PHASE_STOP);
576 rcar_i2c_write(priv, ICMCR, RCAR_BUS_PHASE_START);
577 priv->flags |= ID_REP_AFTER_RD;
581 if (priv->pos == msg->len && !(priv->flags & ID_LAST_MSG))
582 rcar_i2c_next_msg(priv);
584 rcar_i2c_clear_irq(priv, irqs_to_clear);
587 static bool rcar_i2c_slave_irq(struct rcar_i2c_priv *priv)
589 u32 ssr_raw, ssr_filtered;
592 ssr_raw = rcar_i2c_read(priv, ICSSR) & 0xff;
593 ssr_filtered = ssr_raw & rcar_i2c_read(priv, ICSIER);
598 /* address detected */
599 if (ssr_filtered & SAR) {
600 /* read or write request */
602 i2c_slave_event(priv->slave, I2C_SLAVE_READ_REQUESTED, &value);
603 rcar_i2c_write(priv, ICRXTX, value);
604 rcar_i2c_write(priv, ICSIER, SDE | SSR | SAR);
606 i2c_slave_event(priv->slave, I2C_SLAVE_WRITE_REQUESTED, &value);
607 rcar_i2c_read(priv, ICRXTX); /* dummy read */
608 rcar_i2c_write(priv, ICSIER, SDR | SSR | SAR);
611 /* Clear SSR, too, because of old STOPs to other clients than us */
612 rcar_i2c_write(priv, ICSSR, ~(SAR | SSR) & 0xff);
615 /* master sent stop */
616 if (ssr_filtered & SSR) {
617 i2c_slave_event(priv->slave, I2C_SLAVE_STOP, &value);
618 rcar_i2c_write(priv, ICSCR, SIE | SDBS); /* clear our NACK */
619 rcar_i2c_write(priv, ICSIER, SAR);
620 rcar_i2c_write(priv, ICSSR, ~SSR & 0xff);
623 /* master wants to write to us */
624 if (ssr_filtered & SDR) {
627 value = rcar_i2c_read(priv, ICRXTX);
628 ret = i2c_slave_event(priv->slave, I2C_SLAVE_WRITE_RECEIVED, &value);
629 /* Send NACK in case of error */
630 rcar_i2c_write(priv, ICSCR, SIE | SDBS | (ret < 0 ? FNA : 0));
631 rcar_i2c_write(priv, ICSSR, ~SDR & 0xff);
634 /* master wants to read from us */
635 if (ssr_filtered & SDE) {
636 i2c_slave_event(priv->slave, I2C_SLAVE_READ_PROCESSED, &value);
637 rcar_i2c_write(priv, ICRXTX, value);
638 rcar_i2c_write(priv, ICSSR, ~SDE & 0xff);
645 * This driver has a lock-free design because there are IP cores (at least
646 * R-Car Gen2) which have an inherent race condition in their hardware design.
647 * There, we need to switch to RCAR_BUS_PHASE_DATA as soon as possible after
648 * the interrupt was generated, otherwise an unwanted repeated message gets
649 * generated. It turned out that taking a spinlock at the beginning of the ISR
650 * was already causing repeated messages. Thus, this driver was converted to
651 * the now lockless behaviour. Please keep this in mind when hacking the driver.
652 * R-Car Gen3 seems to have this fixed but earlier versions than R-Car Gen2 are
653 * likely affected. Therefore, we have different interrupt handler entries.
655 static irqreturn_t rcar_i2c_irq(int irq, struct rcar_i2c_priv *priv, u32 msr)
658 if (rcar_i2c_slave_irq(priv))
664 /* Arbitration lost */
666 priv->flags |= ID_DONE | ID_ARBLOST;
672 /* HW automatically sends STOP after received NACK */
673 if (priv->flags & ID_P_NOT_ATOMIC)
674 rcar_i2c_write(priv, ICMIER, RCAR_IRQ_STOP);
675 priv->flags |= ID_NACK;
681 priv->msgs_left--; /* The last message also made it */
682 priv->flags |= ID_DONE;
686 if (rcar_i2c_is_recv(priv))
687 rcar_i2c_irq_recv(priv, msr);
689 rcar_i2c_irq_send(priv, msr);
692 if (priv->flags & ID_DONE) {
693 rcar_i2c_write(priv, ICMIER, 0);
694 rcar_i2c_write(priv, ICMSR, 0);
695 if (priv->flags & ID_P_NOT_ATOMIC)
696 wake_up(&priv->wait);
702 static irqreturn_t rcar_i2c_gen2_irq(int irq, void *ptr)
704 struct rcar_i2c_priv *priv = ptr;
707 /* Clear START or STOP immediately, except for REPSTART after read */
708 if (likely(!(priv->flags & ID_REP_AFTER_RD)))
709 rcar_i2c_write(priv, ICMCR, RCAR_BUS_PHASE_DATA);
711 /* Only handle interrupts that are currently enabled */
712 msr = rcar_i2c_read(priv, ICMSR);
713 if (priv->flags & ID_P_NOT_ATOMIC)
714 msr &= rcar_i2c_read(priv, ICMIER);
716 return rcar_i2c_irq(irq, priv, msr);
719 static irqreturn_t rcar_i2c_gen3_irq(int irq, void *ptr)
721 struct rcar_i2c_priv *priv = ptr;
724 /* Only handle interrupts that are currently enabled */
725 msr = rcar_i2c_read(priv, ICMSR);
726 if (priv->flags & ID_P_NOT_ATOMIC)
727 msr &= rcar_i2c_read(priv, ICMIER);
730 * Clear START or STOP immediately, except for REPSTART after read or
731 * if a spurious interrupt was detected.
733 if (likely(!(priv->flags & ID_REP_AFTER_RD) && msr))
734 rcar_i2c_write(priv, ICMCR, RCAR_BUS_PHASE_DATA);
736 return rcar_i2c_irq(irq, priv, msr);
739 static struct dma_chan *rcar_i2c_request_dma_chan(struct device *dev,
740 enum dma_transfer_direction dir,
741 dma_addr_t port_addr)
743 struct dma_chan *chan;
744 struct dma_slave_config cfg;
745 char *chan_name = dir == DMA_MEM_TO_DEV ? "tx" : "rx";
748 chan = dma_request_chan(dev, chan_name);
750 dev_dbg(dev, "request_channel failed for %s (%ld)\n",
751 chan_name, PTR_ERR(chan));
755 memset(&cfg, 0, sizeof(cfg));
757 if (dir == DMA_MEM_TO_DEV) {
758 cfg.dst_addr = port_addr;
759 cfg.dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
761 cfg.src_addr = port_addr;
762 cfg.src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
765 ret = dmaengine_slave_config(chan, &cfg);
767 dev_dbg(dev, "slave_config failed for %s (%d)\n",
769 dma_release_channel(chan);
773 dev_dbg(dev, "got DMA channel for %s\n", chan_name);
777 static void rcar_i2c_request_dma(struct rcar_i2c_priv *priv,
780 struct device *dev = rcar_i2c_priv_to_dev(priv);
782 struct dma_chan *chan;
783 enum dma_transfer_direction dir;
785 read = msg->flags & I2C_M_RD;
787 chan = read ? priv->dma_rx : priv->dma_tx;
788 if (PTR_ERR(chan) != -EPROBE_DEFER)
791 dir = read ? DMA_DEV_TO_MEM : DMA_MEM_TO_DEV;
792 chan = rcar_i2c_request_dma_chan(dev, dir, priv->res->start + ICRXTX);
800 static void rcar_i2c_release_dma(struct rcar_i2c_priv *priv)
802 if (!IS_ERR(priv->dma_tx)) {
803 dma_release_channel(priv->dma_tx);
804 priv->dma_tx = ERR_PTR(-EPROBE_DEFER);
807 if (!IS_ERR(priv->dma_rx)) {
808 dma_release_channel(priv->dma_rx);
809 priv->dma_rx = ERR_PTR(-EPROBE_DEFER);
813 /* I2C is a special case, we need to poll the status of a reset */
814 static int rcar_i2c_do_reset(struct rcar_i2c_priv *priv)
818 ret = reset_control_reset(priv->rstc);
822 return read_poll_timeout_atomic(reset_control_status, ret, ret == 0, 1,
823 100, false, priv->rstc);
826 static int rcar_i2c_master_xfer(struct i2c_adapter *adap,
827 struct i2c_msg *msgs,
830 struct rcar_i2c_priv *priv = i2c_get_adapdata(adap);
831 struct device *dev = rcar_i2c_priv_to_dev(priv);
835 priv->flags |= ID_P_NOT_ATOMIC;
837 pm_runtime_get_sync(dev);
839 /* Check bus state before init otherwise bus busy info will be lost */
840 ret = rcar_i2c_bus_barrier(priv);
844 /* Gen3 needs a reset before allowing RXDMA once */
845 if (priv->devtype == I2C_RCAR_GEN3) {
846 priv->flags |= ID_P_NO_RXDMA;
847 if (!IS_ERR(priv->rstc)) {
848 ret = rcar_i2c_do_reset(priv);
850 priv->flags &= ~ID_P_NO_RXDMA;
856 for (i = 0; i < num; i++)
857 rcar_i2c_request_dma(priv, msgs + i);
859 rcar_i2c_first_msg(priv, msgs, num);
861 time_left = wait_event_timeout(priv->wait, priv->flags & ID_DONE,
862 num * adap->timeout);
864 /* cleanup DMA if it couldn't complete properly due to an error */
865 if (priv->dma_direction != DMA_NONE)
866 rcar_i2c_cleanup_dma(priv, true);
871 } else if (priv->flags & ID_NACK) {
873 } else if (priv->flags & ID_ARBLOST) {
875 } else if (priv->flags & ID_EPROTO) {
878 ret = num - priv->msgs_left; /* The number of transfer */
883 if (ret < 0 && ret != -ENXIO)
884 dev_err(dev, "error %d : %x\n", ret, priv->flags);
889 static int rcar_i2c_master_xfer_atomic(struct i2c_adapter *adap,
890 struct i2c_msg *msgs,
893 struct rcar_i2c_priv *priv = i2c_get_adapdata(adap);
894 struct device *dev = rcar_i2c_priv_to_dev(priv);
899 priv->flags &= ~ID_P_NOT_ATOMIC;
901 pm_runtime_get_sync(dev);
903 /* Check bus state before init otherwise bus busy info will be lost */
904 ret = rcar_i2c_bus_barrier(priv);
909 rcar_i2c_first_msg(priv, msgs, num);
911 j = jiffies + num * adap->timeout;
913 u32 msr = rcar_i2c_read(priv, ICMSR);
915 msr &= (rcar_i2c_is_recv(priv) ? RCAR_IRQ_RECV : RCAR_IRQ_SEND) | RCAR_IRQ_STOP;
918 if (priv->devtype < I2C_RCAR_GEN3)
919 rcar_i2c_gen2_irq(0, priv);
921 rcar_i2c_gen3_irq(0, priv);
924 time_left = time_before_eq(jiffies, j);
925 } while (!(priv->flags & ID_DONE) && time_left);
930 } else if (priv->flags & ID_NACK) {
932 } else if (priv->flags & ID_ARBLOST) {
934 } else if (priv->flags & ID_EPROTO) {
937 ret = num - priv->msgs_left; /* The number of transfer */
942 if (ret < 0 && ret != -ENXIO)
943 dev_err(dev, "error %d : %x\n", ret, priv->flags);
948 static int rcar_reg_slave(struct i2c_client *slave)
950 struct rcar_i2c_priv *priv = i2c_get_adapdata(slave->adapter);
955 if (slave->flags & I2C_CLIENT_TEN)
956 return -EAFNOSUPPORT;
958 /* Keep device active for slave address detection logic */
959 pm_runtime_get_sync(rcar_i2c_priv_to_dev(priv));
962 rcar_i2c_write(priv, ICSAR, slave->addr);
963 rcar_i2c_write(priv, ICSSR, 0);
964 rcar_i2c_write(priv, ICSIER, SAR);
965 rcar_i2c_write(priv, ICSCR, SIE | SDBS);
970 static int rcar_unreg_slave(struct i2c_client *slave)
972 struct rcar_i2c_priv *priv = i2c_get_adapdata(slave->adapter);
974 WARN_ON(!priv->slave);
976 /* ensure no irq is running before clearing ptr */
977 disable_irq(priv->irq);
978 rcar_i2c_write(priv, ICSIER, 0);
979 rcar_i2c_write(priv, ICSSR, 0);
980 enable_irq(priv->irq);
981 rcar_i2c_write(priv, ICSCR, SDBS);
982 rcar_i2c_write(priv, ICSAR, 0); /* Gen2: must be 0 if not using slave */
986 pm_runtime_put(rcar_i2c_priv_to_dev(priv));
991 static u32 rcar_i2c_func(struct i2c_adapter *adap)
993 struct rcar_i2c_priv *priv = i2c_get_adapdata(adap);
997 * I2C_SMBUS_QUICK (setting FSB during START didn't work)
998 * I2C_M_NOSTART (automatically sends address after START)
999 * I2C_M_IGNORE_NAK (automatically sends STOP after NAK)
1001 u32 func = I2C_FUNC_I2C | I2C_FUNC_SLAVE |
1002 (I2C_FUNC_SMBUS_EMUL_ALL & ~I2C_FUNC_SMBUS_QUICK);
1004 if (priv->flags & ID_P_HOST_NOTIFY)
1005 func |= I2C_FUNC_SMBUS_HOST_NOTIFY;
1010 static const struct i2c_algorithm rcar_i2c_algo = {
1011 .master_xfer = rcar_i2c_master_xfer,
1012 .master_xfer_atomic = rcar_i2c_master_xfer_atomic,
1013 .functionality = rcar_i2c_func,
1014 .reg_slave = rcar_reg_slave,
1015 .unreg_slave = rcar_unreg_slave,
1018 static const struct i2c_adapter_quirks rcar_i2c_quirks = {
1019 .flags = I2C_AQ_NO_ZERO_LEN,
1022 static const struct of_device_id rcar_i2c_dt_ids[] = {
1023 { .compatible = "renesas,i2c-r8a7778", .data = (void *)I2C_RCAR_GEN1 },
1024 { .compatible = "renesas,i2c-r8a7779", .data = (void *)I2C_RCAR_GEN1 },
1025 { .compatible = "renesas,i2c-r8a7790", .data = (void *)I2C_RCAR_GEN2 },
1026 { .compatible = "renesas,i2c-r8a7791", .data = (void *)I2C_RCAR_GEN2 },
1027 { .compatible = "renesas,i2c-r8a7792", .data = (void *)I2C_RCAR_GEN2 },
1028 { .compatible = "renesas,i2c-r8a7793", .data = (void *)I2C_RCAR_GEN2 },
1029 { .compatible = "renesas,i2c-r8a7794", .data = (void *)I2C_RCAR_GEN2 },
1030 { .compatible = "renesas,i2c-r8a7795", .data = (void *)I2C_RCAR_GEN3 },
1031 { .compatible = "renesas,i2c-r8a7796", .data = (void *)I2C_RCAR_GEN3 },
1032 { .compatible = "renesas,rcar-gen1-i2c", .data = (void *)I2C_RCAR_GEN1 },
1033 { .compatible = "renesas,rcar-gen2-i2c", .data = (void *)I2C_RCAR_GEN2 },
1034 { .compatible = "renesas,rcar-gen3-i2c", .data = (void *)I2C_RCAR_GEN3 },
1035 { .compatible = "renesas,rcar-gen4-i2c", .data = (void *)I2C_RCAR_GEN3 },
1038 MODULE_DEVICE_TABLE(of, rcar_i2c_dt_ids);
1040 static int rcar_i2c_probe(struct platform_device *pdev)
1042 struct rcar_i2c_priv *priv;
1043 struct i2c_adapter *adap;
1044 struct device *dev = &pdev->dev;
1045 unsigned long irqflags = 0;
1046 irqreturn_t (*irqhandler)(int irq, void *ptr) = rcar_i2c_gen3_irq;
1049 /* Otherwise logic will break because some bytes must always use PIO */
1050 BUILD_BUG_ON_MSG(RCAR_MIN_DMA_LEN < 3, "Invalid min DMA length");
1052 priv = devm_kzalloc(dev, sizeof(struct rcar_i2c_priv), GFP_KERNEL);
1056 priv->clk = devm_clk_get(dev, NULL);
1057 if (IS_ERR(priv->clk)) {
1058 dev_err(dev, "cannot get clock\n");
1059 return PTR_ERR(priv->clk);
1062 priv->io = devm_platform_get_and_ioremap_resource(pdev, 0, &priv->res);
1063 if (IS_ERR(priv->io))
1064 return PTR_ERR(priv->io);
1066 priv->devtype = (enum rcar_i2c_type)of_device_get_match_data(dev);
1067 init_waitqueue_head(&priv->wait);
1070 adap->nr = pdev->id;
1071 adap->algo = &rcar_i2c_algo;
1072 adap->class = I2C_CLASS_DEPRECATED;
1074 adap->dev.parent = dev;
1075 adap->dev.of_node = dev->of_node;
1076 adap->bus_recovery_info = &rcar_i2c_bri;
1077 adap->quirks = &rcar_i2c_quirks;
1078 i2c_set_adapdata(adap, priv);
1079 strscpy(adap->name, pdev->name, sizeof(adap->name));
1082 sg_init_table(&priv->sg, 1);
1083 priv->dma_direction = DMA_NONE;
1084 priv->dma_rx = priv->dma_tx = ERR_PTR(-EPROBE_DEFER);
1086 /* Activate device for clock calculation */
1087 pm_runtime_enable(dev);
1088 pm_runtime_get_sync(dev);
1089 ret = rcar_i2c_clock_calculate(priv);
1091 pm_runtime_put(dev);
1092 goto out_pm_disable;
1095 rcar_i2c_write(priv, ICSAR, 0); /* Gen2: must be 0 if not using slave */
1097 if (priv->devtype < I2C_RCAR_GEN3) {
1098 irqflags |= IRQF_NO_THREAD;
1099 irqhandler = rcar_i2c_gen2_irq;
1102 if (priv->devtype == I2C_RCAR_GEN3) {
1103 priv->rstc = devm_reset_control_get_exclusive(&pdev->dev, NULL);
1104 if (!IS_ERR(priv->rstc)) {
1105 ret = reset_control_status(priv->rstc);
1107 priv->rstc = ERR_PTR(-ENOTSUPP);
1111 /* Stay always active when multi-master to keep arbitration working */
1112 if (of_property_read_bool(dev->of_node, "multi-master"))
1113 priv->flags |= ID_P_PM_BLOCKED;
1115 pm_runtime_put(dev);
1117 if (of_property_read_bool(dev->of_node, "smbus"))
1118 priv->flags |= ID_P_HOST_NOTIFY;
1120 ret = platform_get_irq(pdev, 0);
1124 ret = devm_request_irq(dev, priv->irq, irqhandler, irqflags, dev_name(dev), priv);
1126 dev_err(dev, "cannot get irq %d\n", priv->irq);
1130 platform_set_drvdata(pdev, priv);
1132 ret = i2c_add_numbered_adapter(adap);
1136 if (priv->flags & ID_P_HOST_NOTIFY) {
1137 priv->host_notify_client = i2c_new_slave_host_notify_device(adap);
1138 if (IS_ERR(priv->host_notify_client)) {
1139 ret = PTR_ERR(priv->host_notify_client);
1140 goto out_del_device;
1144 dev_info(dev, "probed\n");
1149 i2c_del_adapter(&priv->adap);
1151 if (priv->flags & ID_P_PM_BLOCKED)
1152 pm_runtime_put(dev);
1154 pm_runtime_disable(dev);
1158 static int rcar_i2c_remove(struct platform_device *pdev)
1160 struct rcar_i2c_priv *priv = platform_get_drvdata(pdev);
1161 struct device *dev = &pdev->dev;
1163 if (priv->host_notify_client)
1164 i2c_free_slave_host_notify_device(priv->host_notify_client);
1165 i2c_del_adapter(&priv->adap);
1166 rcar_i2c_release_dma(priv);
1167 if (priv->flags & ID_P_PM_BLOCKED)
1168 pm_runtime_put(dev);
1169 pm_runtime_disable(dev);
1174 #ifdef CONFIG_PM_SLEEP
1175 static int rcar_i2c_suspend(struct device *dev)
1177 struct rcar_i2c_priv *priv = dev_get_drvdata(dev);
1179 i2c_mark_adapter_suspended(&priv->adap);
1183 static int rcar_i2c_resume(struct device *dev)
1185 struct rcar_i2c_priv *priv = dev_get_drvdata(dev);
1187 i2c_mark_adapter_resumed(&priv->adap);
1191 static const struct dev_pm_ops rcar_i2c_pm_ops = {
1192 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(rcar_i2c_suspend, rcar_i2c_resume)
1195 #define DEV_PM_OPS (&rcar_i2c_pm_ops)
1197 #define DEV_PM_OPS NULL
1198 #endif /* CONFIG_PM_SLEEP */
1200 static struct platform_driver rcar_i2c_driver = {
1203 .of_match_table = rcar_i2c_dt_ids,
1206 .probe = rcar_i2c_probe,
1207 .remove = rcar_i2c_remove,
1210 module_platform_driver(rcar_i2c_driver);
1212 MODULE_LICENSE("GPL v2");
1213 MODULE_DESCRIPTION("Renesas R-Car I2C bus driver");