1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (C) 2013 Wolfram Sang <wsa@sang-engineering.com>
6 * Copyright (C) 2013 Renesas Solutions Corp.
10 * This i2c core has a lot of interrupts, namely 8. We use their chaining as
11 * some kind of state machine.
13 * 1) The main xfer routine kicks off a transmission by putting the start bit
14 * (or repeated start) on the bus and enabling the transmit interrupt (TIE)
15 * since we need to send the target address + RW bit in every case.
17 * 2) TIE sends target address + RW bit and selects how to continue.
19 * 3a) Write case: We keep utilizing TIE as long as we have data to send. If we
20 * are done, we switch over to the transmission done interrupt (TEIE) and mark
21 * the message as completed (includes sending STOP) there.
23 * 3b) Read case: We switch over to receive interrupt (RIE). One dummy read is
24 * needed to start clocking, then we keep receiving until we are done. Note
25 * that we use the RDRFS mode all the time, i.e. we ACK/NACK every byte by
26 * writing to the ACKBT bit. I tried using the RDRFS mode only at the end of a
27 * message to create the final NACK as sketched in the datasheet. This caused
28 * some subtle races (when byte n was processed and byte n+1 was already
29 * waiting), though, and I started with the safe approach.
31 * 4) If we got a NACK somewhere, we flag the error and stop the transmission
34 * Also check the comments in the interrupt routines for some gory details.
37 #include <linux/clk.h>
38 #include <linux/completion.h>
39 #include <linux/err.h>
40 #include <linux/i2c.h>
41 #include <linux/interrupt.h>
43 #include <linux/module.h>
45 #include <linux/platform_device.h>
46 #include <linux/pm_runtime.h>
47 #include <linux/reset.h>
49 #define ICCR1_ICE 0x80
50 #define ICCR1_IICRST 0x40
51 #define ICCR1_SOWP 0x10
53 #define ICCR2_BBSY 0x80
58 #define ICMR1_CKS_MASK 0x70
59 #define ICMR1_BCWP 0x08
60 #define ICMR1_CKS(_x) ((((_x) << 4) & ICMR1_CKS_MASK) | ICMR1_BCWP)
62 #define ICMR3_RDRFS 0x20
63 #define ICMR3_ACKWP 0x10
64 #define ICMR3_ACKBT 0x08
66 #define ICFER_FMPE 0x80
68 #define ICIER_TIE 0x80
69 #define ICIER_TEIE 0x40
70 #define ICIER_RIE 0x20
71 #define ICIER_NAKIE 0x10
72 #define ICIER_SPIE 0x08
74 #define ICSR2_NACKF 0x10
76 #define ICBR_RESERVED 0xe0 /* Should be 1 on writes */
78 #define RIIC_INIT_MSG -1
108 const struct riic_of_data
*info
;
109 struct completion msg_done
;
110 struct i2c_adapter adapter
;
112 struct reset_control
*rstc
;
113 struct i2c_timings i2c_t
;
116 struct riic_irq_desc
{
122 static inline void riic_writeb(struct riic_dev
*riic
, u8 val
, u8 offset
)
124 writeb(val
, riic
->base
+ riic
->info
->regs
[offset
]);
127 static inline u8
riic_readb(struct riic_dev
*riic
, u8 offset
)
129 return readb(riic
->base
+ riic
->info
->regs
[offset
]);
132 static inline void riic_clear_set_bit(struct riic_dev
*riic
, u8 clear
, u8 set
, u8 reg
)
134 riic_writeb(riic
, (riic_readb(riic
, reg
) & ~clear
) | set
, reg
);
137 static int riic_xfer(struct i2c_adapter
*adap
, struct i2c_msg msgs
[], int num
)
139 struct riic_dev
*riic
= i2c_get_adapdata(adap
);
140 struct device
*dev
= adap
->dev
.parent
;
141 unsigned long time_left
;
145 ret
= pm_runtime_resume_and_get(dev
);
149 if (riic_readb(riic
, RIIC_ICCR2
) & ICCR2_BBSY
) {
154 reinit_completion(&riic
->msg_done
);
157 riic_writeb(riic
, 0, RIIC_ICSR2
);
159 for (i
= 0, start_bit
= ICCR2_ST
; i
< num
; i
++) {
160 riic
->bytes_left
= RIIC_INIT_MSG
;
161 riic
->buf
= msgs
[i
].buf
;
162 riic
->msg
= &msgs
[i
];
163 riic
->is_last
= (i
== num
- 1);
165 riic_writeb(riic
, ICIER_NAKIE
| ICIER_TIE
, RIIC_ICIER
);
167 riic_writeb(riic
, start_bit
, RIIC_ICCR2
);
169 time_left
= wait_for_completion_timeout(&riic
->msg_done
, riic
->adapter
.timeout
);
171 riic
->err
= -ETIMEDOUT
;
176 start_bit
= ICCR2_RS
;
180 pm_runtime_mark_last_busy(dev
);
181 pm_runtime_put_autosuspend(dev
);
183 return riic
->err
?: num
;
186 static irqreturn_t
riic_tdre_isr(int irq
, void *data
)
188 struct riic_dev
*riic
= data
;
191 if (!riic
->bytes_left
)
194 if (riic
->bytes_left
== RIIC_INIT_MSG
) {
195 if (riic
->msg
->flags
& I2C_M_RD
)
196 /* On read, switch over to receive interrupt */
197 riic_clear_set_bit(riic
, ICIER_TIE
, ICIER_RIE
, RIIC_ICIER
);
199 /* On write, initialize length */
200 riic
->bytes_left
= riic
->msg
->len
;
202 val
= i2c_8bit_addr_from_msg(riic
->msg
);
210 * Switch to transmission ended interrupt when done. Do check here
211 * after bytes_left was initialized to support SMBUS_QUICK (new msg has
214 if (riic
->bytes_left
== 0)
215 riic_clear_set_bit(riic
, ICIER_TIE
, ICIER_TEIE
, RIIC_ICIER
);
218 * This acks the TIE interrupt. We get another TIE immediately if our
219 * value could be moved to the shadow shift register right away. So
220 * this must be after updates to ICIER (where we want to disable TIE)!
222 riic_writeb(riic
, val
, RIIC_ICDRT
);
227 static irqreturn_t
riic_tend_isr(int irq
, void *data
)
229 struct riic_dev
*riic
= data
;
231 if (riic_readb(riic
, RIIC_ICSR2
) & ICSR2_NACKF
) {
232 /* We got a NACKIE */
233 riic_readb(riic
, RIIC_ICDRR
); /* dummy read */
234 riic_clear_set_bit(riic
, ICSR2_NACKF
, 0, RIIC_ICSR2
);
236 } else if (riic
->bytes_left
) {
240 if (riic
->is_last
|| riic
->err
) {
241 riic_clear_set_bit(riic
, ICIER_TEIE
, ICIER_SPIE
, RIIC_ICIER
);
242 riic_writeb(riic
, ICCR2_SP
, RIIC_ICCR2
);
244 /* Transfer is complete, but do not send STOP */
245 riic_clear_set_bit(riic
, ICIER_TEIE
, 0, RIIC_ICIER
);
246 complete(&riic
->msg_done
);
252 static irqreturn_t
riic_rdrf_isr(int irq
, void *data
)
254 struct riic_dev
*riic
= data
;
256 if (!riic
->bytes_left
)
259 if (riic
->bytes_left
== RIIC_INIT_MSG
) {
260 riic
->bytes_left
= riic
->msg
->len
;
261 riic_readb(riic
, RIIC_ICDRR
); /* dummy read */
265 if (riic
->bytes_left
== 1) {
266 /* STOP must come before we set ACKBT! */
268 riic_clear_set_bit(riic
, 0, ICIER_SPIE
, RIIC_ICIER
);
269 riic_writeb(riic
, ICCR2_SP
, RIIC_ICCR2
);
272 riic_clear_set_bit(riic
, 0, ICMR3_ACKBT
, RIIC_ICMR3
);
275 riic_clear_set_bit(riic
, ICMR3_ACKBT
, 0, RIIC_ICMR3
);
278 /* Reading acks the RIE interrupt */
279 *riic
->buf
= riic_readb(riic
, RIIC_ICDRR
);
286 static irqreturn_t
riic_stop_isr(int irq
, void *data
)
288 struct riic_dev
*riic
= data
;
290 /* read back registers to confirm writes have fully propagated */
291 riic_writeb(riic
, 0, RIIC_ICSR2
);
292 riic_readb(riic
, RIIC_ICSR2
);
293 riic_writeb(riic
, 0, RIIC_ICIER
);
294 riic_readb(riic
, RIIC_ICIER
);
296 complete(&riic
->msg_done
);
301 static u32
riic_func(struct i2c_adapter
*adap
)
303 return I2C_FUNC_I2C
| I2C_FUNC_SMBUS_EMUL
;
306 static const struct i2c_algorithm riic_algo
= {
308 .functionality
= riic_func
,
311 static int riic_init_hw(struct riic_dev
*riic
)
315 int total_ticks
, cks
, brl
, brh
;
316 struct i2c_timings
*t
= &riic
->i2c_t
;
317 struct device
*dev
= riic
->adapter
.dev
.parent
;
318 bool fast_mode_plus
= riic
->info
->fast_mode_plus
;
319 u32 max_freq
= fast_mode_plus
? I2C_MAX_FAST_MODE_PLUS_FREQ
320 : I2C_MAX_FAST_MODE_FREQ
;
322 if (t
->bus_freq_hz
> max_freq
)
323 return dev_err_probe(&riic
->adapter
.dev
, -EINVAL
,
324 "unsupported bus speed %uHz (%u max)\n",
325 t
->bus_freq_hz
, max_freq
);
327 rate
= clk_get_rate(riic
->clk
);
330 * Assume the default register settings:
331 * FER.SCLE = 1 (SCL sync circuit enabled, adds 2 or 3 cycles)
332 * FER.NFE = 1 (noise circuit enabled)
333 * MR3.NF = 0 (1 cycle of noise filtered out)
335 * Freq (CKS=000) = (I2CCLK + tr + tf)/ (BRH + 3 + 1) + (BRL + 3 + 1)
336 * Freq (CKS!=000) = (I2CCLK + tr + tf)/ (BRH + 2 + 1) + (BRL + 2 + 1)
340 * Determine reference clock rate. We must be able to get the desired
341 * frequency with only 62 clock ticks max (31 high, 31 low).
342 * Aim for a duty of 60% LOW, 40% HIGH.
344 total_ticks
= DIV_ROUND_UP(rate
, t
->bus_freq_hz
?: 1);
346 for (cks
= 0; cks
< 7; cks
++) {
348 * 60% low time must be less than BRL + 2 + 1
349 * BRL max register value is 0x1F.
351 brl
= ((total_ticks
* 6) / 10);
352 if (brl
<= (0x1F + 3))
359 if (brl
> (0x1F + 3)) {
360 dev_err(&riic
->adapter
.dev
, "invalid speed (%lu). Too slow.\n",
361 (unsigned long)t
->bus_freq_hz
);
365 brh
= total_ticks
- brl
;
367 /* Remove automatic clock ticks for sync circuit and NF */
377 * Remove clock ticks for rise and fall times. Convert ns to clock
380 brl
-= t
->scl_fall_ns
/ (1000000000 / rate
);
381 brh
-= t
->scl_rise_ns
/ (1000000000 / rate
);
383 /* Adjust for min register values for when SCLE=1 and NFE=1 */
389 pr_debug("i2c-riic: freq=%lu, duty=%d, fall=%lu, rise=%lu, cks=%d, brl=%d, brh=%d\n",
390 rate
/ total_ticks
, ((brl
+ 3) * 100) / (brl
+ brh
+ 6),
391 t
->scl_fall_ns
/ (1000000000 / rate
),
392 t
->scl_rise_ns
/ (1000000000 / rate
), cks
, brl
, brh
);
394 ret
= pm_runtime_resume_and_get(dev
);
398 /* Changing the order of accessing IICRST and ICE may break things! */
399 riic_writeb(riic
, ICCR1_IICRST
| ICCR1_SOWP
, RIIC_ICCR1
);
400 riic_clear_set_bit(riic
, 0, ICCR1_ICE
, RIIC_ICCR1
);
402 riic_writeb(riic
, ICMR1_CKS(cks
), RIIC_ICMR1
);
403 riic_writeb(riic
, brh
| ICBR_RESERVED
, RIIC_ICBRH
);
404 riic_writeb(riic
, brl
| ICBR_RESERVED
, RIIC_ICBRL
);
406 riic_writeb(riic
, 0, RIIC_ICSER
);
407 riic_writeb(riic
, ICMR3_ACKWP
| ICMR3_RDRFS
, RIIC_ICMR3
);
409 if (fast_mode_plus
&& t
->bus_freq_hz
> I2C_MAX_FAST_MODE_FREQ
)
410 riic_clear_set_bit(riic
, 0, ICFER_FMPE
, RIIC_ICFER
);
412 riic_clear_set_bit(riic
, ICCR1_IICRST
, 0, RIIC_ICCR1
);
414 pm_runtime_mark_last_busy(dev
);
415 pm_runtime_put_autosuspend(dev
);
419 static struct riic_irq_desc riic_irqs
[] = {
420 { .res_num
= 0, .isr
= riic_tend_isr
, .name
= "riic-tend" },
421 { .res_num
= 1, .isr
= riic_rdrf_isr
, .name
= "riic-rdrf" },
422 { .res_num
= 2, .isr
= riic_tdre_isr
, .name
= "riic-tdre" },
423 { .res_num
= 3, .isr
= riic_stop_isr
, .name
= "riic-stop" },
424 { .res_num
= 5, .isr
= riic_tend_isr
, .name
= "riic-nack" },
427 static void riic_reset_control_assert(void *data
)
429 reset_control_assert(data
);
432 static int riic_i2c_probe(struct platform_device
*pdev
)
434 struct device
*dev
= &pdev
->dev
;
435 struct riic_dev
*riic
;
436 struct i2c_adapter
*adap
;
439 riic
= devm_kzalloc(dev
, sizeof(*riic
), GFP_KERNEL
);
443 riic
->base
= devm_platform_ioremap_resource(pdev
, 0);
444 if (IS_ERR(riic
->base
))
445 return PTR_ERR(riic
->base
);
447 riic
->clk
= devm_clk_get(dev
, NULL
);
448 if (IS_ERR(riic
->clk
)) {
449 dev_err(dev
, "missing controller clock");
450 return PTR_ERR(riic
->clk
);
453 riic
->rstc
= devm_reset_control_get_optional_exclusive(dev
, NULL
);
454 if (IS_ERR(riic
->rstc
))
455 return dev_err_probe(dev
, PTR_ERR(riic
->rstc
),
456 "Error: missing reset ctrl\n");
458 ret
= reset_control_deassert(riic
->rstc
);
462 ret
= devm_add_action_or_reset(dev
, riic_reset_control_assert
, riic
->rstc
);
466 for (i
= 0; i
< ARRAY_SIZE(riic_irqs
); i
++) {
467 ret
= platform_get_irq(pdev
, riic_irqs
[i
].res_num
);
471 ret
= devm_request_irq(dev
, ret
, riic_irqs
[i
].isr
,
472 0, riic_irqs
[i
].name
, riic
);
474 dev_err(dev
, "failed to request irq %s\n", riic_irqs
[i
].name
);
479 riic
->info
= of_device_get_match_data(dev
);
481 adap
= &riic
->adapter
;
482 i2c_set_adapdata(adap
, riic
);
483 strscpy(adap
->name
, "Renesas RIIC adapter", sizeof(adap
->name
));
484 adap
->owner
= THIS_MODULE
;
485 adap
->algo
= &riic_algo
;
486 adap
->dev
.parent
= dev
;
487 adap
->dev
.of_node
= dev
->of_node
;
489 init_completion(&riic
->msg_done
);
491 i2c_parse_fw_timings(dev
, &riic
->i2c_t
, true);
493 /* Default 0 to save power. Can be overridden via sysfs for lower latency. */
494 pm_runtime_set_autosuspend_delay(dev
, 0);
495 pm_runtime_use_autosuspend(dev
);
496 pm_runtime_enable(dev
);
498 ret
= riic_init_hw(riic
);
502 ret
= i2c_add_adapter(adap
);
506 platform_set_drvdata(pdev
, riic
);
508 dev_info(dev
, "registered with %dHz bus speed\n", riic
->i2c_t
.bus_freq_hz
);
512 pm_runtime_disable(dev
);
513 pm_runtime_dont_use_autosuspend(dev
);
517 static void riic_i2c_remove(struct platform_device
*pdev
)
519 struct riic_dev
*riic
= platform_get_drvdata(pdev
);
520 struct device
*dev
= &pdev
->dev
;
523 ret
= pm_runtime_resume_and_get(dev
);
525 riic_writeb(riic
, 0, RIIC_ICIER
);
528 i2c_del_adapter(&riic
->adapter
);
529 pm_runtime_disable(dev
);
530 pm_runtime_dont_use_autosuspend(dev
);
533 static const u8 riic_rz_a_regs
[RIIC_REG_END
] = {
548 static const struct riic_of_data riic_rz_a_info
= {
549 .regs
= riic_rz_a_regs
,
550 .fast_mode_plus
= true,
553 static const struct riic_of_data riic_rz_a1h_info
= {
554 .regs
= riic_rz_a_regs
,
557 static const u8 riic_rz_v2h_regs
[RIIC_REG_END
] = {
572 static const struct riic_of_data riic_rz_v2h_info
= {
573 .regs
= riic_rz_v2h_regs
,
574 .fast_mode_plus
= true,
577 static int riic_i2c_suspend(struct device
*dev
)
579 struct riic_dev
*riic
= dev_get_drvdata(dev
);
582 ret
= pm_runtime_resume_and_get(dev
);
586 i2c_mark_adapter_suspended(&riic
->adapter
);
588 /* Disable output on SDA, SCL pins. */
589 riic_clear_set_bit(riic
, ICCR1_ICE
, 0, RIIC_ICCR1
);
591 pm_runtime_mark_last_busy(dev
);
592 pm_runtime_put_sync(dev
);
594 return reset_control_assert(riic
->rstc
);
597 static int riic_i2c_resume(struct device
*dev
)
599 struct riic_dev
*riic
= dev_get_drvdata(dev
);
602 ret
= reset_control_deassert(riic
->rstc
);
606 ret
= riic_init_hw(riic
);
609 * In case this happens there is no way to recover from this
610 * state. The driver will remain loaded. We want to avoid
611 * keeping the reset line de-asserted for no reason.
613 reset_control_assert(riic
->rstc
);
617 i2c_mark_adapter_resumed(&riic
->adapter
);
622 static const struct dev_pm_ops riic_i2c_pm_ops
= {
623 SYSTEM_SLEEP_PM_OPS(riic_i2c_suspend
, riic_i2c_resume
)
626 static const struct of_device_id riic_i2c_dt_ids
[] = {
627 { .compatible
= "renesas,riic-rz", .data
= &riic_rz_a_info
},
628 { .compatible
= "renesas,riic-r7s72100", .data
= &riic_rz_a1h_info
, },
629 { .compatible
= "renesas,riic-r9a09g057", .data
= &riic_rz_v2h_info
},
633 static struct platform_driver riic_i2c_driver
= {
634 .probe
= riic_i2c_probe
,
635 .remove_new
= riic_i2c_remove
,
638 .of_match_table
= riic_i2c_dt_ids
,
639 .pm
= pm_ptr(&riic_i2c_pm_ops
),
643 module_platform_driver(riic_i2c_driver
);
645 MODULE_DESCRIPTION("Renesas RIIC adapter");
646 MODULE_AUTHOR("Wolfram Sang <wsa@sang-engineering.com>");
647 MODULE_LICENSE("GPL v2");
648 MODULE_DEVICE_TABLE(of
, riic_i2c_dt_ids
);