2 * drivers/i2c/busses/i2c-rcar.c
4 * Copyright (C) 2012 Renesas Solutions Corp.
5 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
7 * This file is based on the drivers/i2c/busses/i2c-sh7760.c
8 * (c) 2005-2008 MSC Vertriebsges.m.b.H, Manuel Lauss <mlau@msc-ge.com>
10 * This file used out-of-tree driver i2c-rcar.c
11 * Copyright (C) 2011-2012 Renesas Electronics Corporation
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 #include <linux/clk.h>
27 #include <linux/delay.h>
28 #include <linux/err.h>
29 #include <linux/init.h>
30 #include <linux/interrupt.h>
32 #include <linux/i2c.h>
33 #include <linux/i2c/i2c-rcar.h>
34 #include <linux/kernel.h>
35 #include <linux/module.h>
36 #include <linux/of_device.h>
37 #include <linux/platform_device.h>
38 #include <linux/pm_runtime.h>
39 #include <linux/slab.h>
40 #include <linux/spinlock.h>
42 /* register offsets */
43 #define ICSCR 0x00 /* slave ctrl */
44 #define ICMCR 0x04 /* master ctrl */
45 #define ICSSR 0x08 /* slave status */
46 #define ICMSR 0x0C /* master status */
47 #define ICSIER 0x10 /* slave irq enable */
48 #define ICMIER 0x14 /* master irq enable */
49 #define ICCCR 0x18 /* clock dividers */
50 #define ICSAR 0x1C /* slave address */
51 #define ICMAR 0x20 /* master address */
52 #define ICRXTX 0x24 /* data port */
55 #define MDBS (1 << 7) /* non-fifo mode switch */
56 #define FSCL (1 << 6) /* override SCL pin */
57 #define FSDA (1 << 5) /* override SDA pin */
58 #define OBPC (1 << 4) /* override pins */
59 #define MIE (1 << 3) /* master if enable */
61 #define FSB (1 << 1) /* force stop bit */
62 #define ESG (1 << 0) /* en startbit gen */
65 #define MNR (1 << 6) /* nack received */
66 #define MAL (1 << 5) /* arbitration lost */
67 #define MST (1 << 4) /* sent a stop */
71 #define MAT (1 << 0) /* slave addr xfer done */
74 #define MNRE (1 << 6) /* nack irq en */
75 #define MALE (1 << 5) /* arblos irq en */
76 #define MSTE (1 << 4) /* stop irq en */
80 #define MATE (1 << 0) /* address sent irq en */
91 RCAR_IRQ_OPEN_FOR_SEND
,
92 RCAR_IRQ_OPEN_FOR_RECV
,
93 RCAR_IRQ_OPEN_FOR_STOP
,
99 #define ID_LAST_MSG (1 << 0)
100 #define ID_IOERROR (1 << 1)
101 #define ID_DONE (1 << 2)
102 #define ID_ARBLOST (1 << 3)
103 #define ID_NACK (1 << 4)
110 struct rcar_i2c_priv
{
112 struct i2c_adapter adap
;
116 wait_queue_head_t wait
;
122 enum rcar_i2c_type devtype
;
125 #define rcar_i2c_priv_to_dev(p) ((p)->adap.dev.parent)
126 #define rcar_i2c_is_recv(p) ((p)->msg->flags & I2C_M_RD)
128 #define rcar_i2c_flags_set(p, f) ((p)->flags |= (f))
129 #define rcar_i2c_flags_has(p, f) ((p)->flags & (f))
131 #define LOOP_TIMEOUT 1024
136 static void rcar_i2c_write(struct rcar_i2c_priv
*priv
, int reg
, u32 val
)
138 writel(val
, priv
->io
+ reg
);
141 static u32
rcar_i2c_read(struct rcar_i2c_priv
*priv
, int reg
)
143 return readl(priv
->io
+ reg
);
146 static void rcar_i2c_init(struct rcar_i2c_priv
*priv
)
150 * slave mode is not used on this driver
152 rcar_i2c_write(priv
, ICSIER
, 0);
153 rcar_i2c_write(priv
, ICSAR
, 0);
154 rcar_i2c_write(priv
, ICSCR
, 0);
155 rcar_i2c_write(priv
, ICSSR
, 0);
157 /* reset master mode */
158 rcar_i2c_write(priv
, ICMIER
, 0);
159 rcar_i2c_write(priv
, ICMCR
, 0);
160 rcar_i2c_write(priv
, ICMSR
, 0);
161 rcar_i2c_write(priv
, ICMAR
, 0);
164 static void rcar_i2c_irq_mask(struct rcar_i2c_priv
*priv
, int open
)
166 u32 val
= MNRE
| MALE
| MSTE
| MATE
; /* default */
169 case RCAR_IRQ_OPEN_FOR_SEND
:
170 val
|= MDEE
; /* default + send */
172 case RCAR_IRQ_OPEN_FOR_RECV
:
173 val
|= MDRE
; /* default + read */
175 case RCAR_IRQ_OPEN_FOR_STOP
:
176 val
= MSTE
; /* stop irq only */
180 val
= 0; /* all close */
183 rcar_i2c_write(priv
, ICMIER
, val
);
186 static void rcar_i2c_set_addr(struct rcar_i2c_priv
*priv
, u32 recv
)
188 rcar_i2c_write(priv
, ICMAR
, (priv
->msg
->addr
<< 1) | recv
);
192 * bus control functions
194 static int rcar_i2c_bus_barrier(struct rcar_i2c_priv
*priv
)
198 for (i
= 0; i
< LOOP_TIMEOUT
; i
++) {
199 /* make sure that bus is not busy */
200 if (!(rcar_i2c_read(priv
, ICMCR
) & FSDA
))
208 static void rcar_i2c_bus_phase(struct rcar_i2c_priv
*priv
, int phase
)
211 case RCAR_BUS_PHASE_ADDR
:
212 rcar_i2c_write(priv
, ICMCR
, MDBS
| MIE
| ESG
);
214 case RCAR_BUS_PHASE_DATA
:
215 rcar_i2c_write(priv
, ICMCR
, MDBS
| MIE
);
217 case RCAR_BUS_PHASE_STOP
:
218 rcar_i2c_write(priv
, ICMCR
, MDBS
| MIE
| FSB
);
226 static int rcar_i2c_clock_calculate(struct rcar_i2c_priv
*priv
,
230 struct clk
*clkp
= clk_get(dev
, NULL
);
238 dev_err(dev
, "couldn't get clock\n");
239 return PTR_ERR(clkp
);
242 switch (priv
->devtype
) {
250 dev_err(dev
, "device type error\n");
255 * calculate SCL clock
259 * ick = clkp / (1 + CDF)
260 * SCL = ick / (20 + SCGD * 8 + F[(ticf + tr + intd) * ick])
262 * ick : I2C internal clock < 20 MHz
263 * ticf : I2C SCL falling time = 35 ns here
264 * tr : I2C SCL rising time = 200 ns here
265 * intd : LSI internal delay = 50 ns here
266 * clkp : peripheral_clk
267 * F[] : integer up-valuation
269 rate
= clk_get_rate(clkp
);
270 cdf
= rate
/ 20000000;
271 if (cdf
>= 1 << cdf_width
) {
272 dev_err(dev
, "Input clock %lu too high\n", rate
);
275 ick
= rate
/ (cdf
+ 1);
278 * it is impossible to calculate large scale
279 * number on u32. separate it
281 * F[(ticf + tr + intd) * ick]
282 * = F[(35 + 200 + 50)ns * ick]
283 * = F[285 * ick / 1000000000]
284 * = F[(ick / 1000000) * 285 / 1000]
286 round
= (ick
+ 500000) / 1000000 * 285;
287 round
= (round
+ 500) / 1000;
290 * SCL = ick / (20 + SCGD * 8 + F[(ticf + tr + intd) * ick])
292 * Calculation result (= SCL) should be less than
293 * bus_speed for hardware safety
295 * We could use something along the lines of
296 * div = ick / (bus_speed + 1) + 1;
297 * scgd = (div - 20 - round + 7) / 8;
298 * scl = ick / (20 + (scgd * 8) + round);
299 * (not fully verified) but that would get pretty involved
301 for (scgd
= 0; scgd
< 0x40; scgd
++) {
302 scl
= ick
/ (20 + (scgd
* 8) + round
);
303 if (scl
<= bus_speed
)
306 dev_err(dev
, "it is impossible to calculate best SCL\n");
310 dev_dbg(dev
, "clk %d/%d(%lu), round %u, CDF:0x%x, SCGD: 0x%x\n",
311 scl
, bus_speed
, clk_get_rate(clkp
), round
, cdf
, scgd
);
316 priv
->icccr
= scgd
<< cdf_width
| cdf
;
321 static void rcar_i2c_clock_start(struct rcar_i2c_priv
*priv
)
323 rcar_i2c_write(priv
, ICCCR
, priv
->icccr
);
329 static u32
rcar_i2c_status_get(struct rcar_i2c_priv
*priv
)
331 return rcar_i2c_read(priv
, ICMSR
);
334 #define rcar_i2c_status_clear(priv) rcar_i2c_status_bit_clear(priv, 0xffffffff)
335 static void rcar_i2c_status_bit_clear(struct rcar_i2c_priv
*priv
, u32 bit
)
337 rcar_i2c_write(priv
, ICMSR
, ~bit
);
341 * recv/send functions
343 static int rcar_i2c_recv(struct rcar_i2c_priv
*priv
)
345 rcar_i2c_set_addr(priv
, 1);
346 rcar_i2c_status_clear(priv
);
347 rcar_i2c_bus_phase(priv
, RCAR_BUS_PHASE_ADDR
);
348 rcar_i2c_irq_mask(priv
, RCAR_IRQ_OPEN_FOR_RECV
);
353 static int rcar_i2c_send(struct rcar_i2c_priv
*priv
)
358 * It should check bus status when send case
360 ret
= rcar_i2c_bus_barrier(priv
);
364 rcar_i2c_set_addr(priv
, 0);
365 rcar_i2c_status_clear(priv
);
366 rcar_i2c_bus_phase(priv
, RCAR_BUS_PHASE_ADDR
);
367 rcar_i2c_irq_mask(priv
, RCAR_IRQ_OPEN_FOR_SEND
);
372 #define rcar_i2c_send_restart(priv) rcar_i2c_status_bit_clear(priv, (MAT | MDE))
373 #define rcar_i2c_recv_restart(priv) rcar_i2c_status_bit_clear(priv, (MAT | MDR))
376 * interrupt functions
378 static int rcar_i2c_irq_send(struct rcar_i2c_priv
*priv
, u32 msr
)
380 struct i2c_msg
*msg
= priv
->msg
;
384 * sometimes, unknown interrupt happened.
391 * If address transfer phase finished,
395 rcar_i2c_bus_phase(priv
, RCAR_BUS_PHASE_DATA
);
397 if (priv
->pos
< msg
->len
) {
399 * Prepare next data to ICRXTX register.
400 * This data will go to _SHIFT_ register.
403 * [ICRXTX] -> [SHIFT] -> [I2C bus]
405 rcar_i2c_write(priv
, ICRXTX
, msg
->buf
[priv
->pos
]);
410 * The last data was pushed to ICRXTX on _PREV_ empty irq.
411 * It is on _SHIFT_ register, and will sent to I2C bus.
414 * [ICRXTX] -> [SHIFT] -> [I2C bus]
417 if (priv
->flags
& ID_LAST_MSG
)
419 * If current msg is the _LAST_ msg,
420 * prepare stop condition here.
421 * ID_DONE will be set on STOP irq.
423 rcar_i2c_bus_phase(priv
, RCAR_BUS_PHASE_STOP
);
426 * If current msg is _NOT_ last msg,
427 * it doesn't call stop phase.
428 * thus, there is no STOP irq.
429 * return ID_DONE here.
434 rcar_i2c_send_restart(priv
);
439 static int rcar_i2c_irq_recv(struct rcar_i2c_priv
*priv
, u32 msr
)
441 struct i2c_msg
*msg
= priv
->msg
;
445 * sometimes, unknown interrupt happened.
453 * Address transfer phase finished,
454 * but, there is no data at this point.
457 } else if (priv
->pos
< msg
->len
) {
461 msg
->buf
[priv
->pos
] = rcar_i2c_read(priv
, ICRXTX
);
466 * If next received data is the _LAST_,
468 * otherwise, go to DATA phase.
470 if (priv
->pos
+ 1 >= msg
->len
)
471 rcar_i2c_bus_phase(priv
, RCAR_BUS_PHASE_STOP
);
473 rcar_i2c_bus_phase(priv
, RCAR_BUS_PHASE_DATA
);
475 rcar_i2c_recv_restart(priv
);
480 static irqreturn_t
rcar_i2c_irq(int irq
, void *ptr
)
482 struct rcar_i2c_priv
*priv
= ptr
;
483 struct device
*dev
= rcar_i2c_priv_to_dev(priv
);
486 /*-------------- spin lock -----------------*/
487 spin_lock(&priv
->lock
);
489 msr
= rcar_i2c_status_get(priv
);
498 * When arbitration lost, device become _slave_ mode.
500 dev_dbg(dev
, "Arbitration Lost\n");
501 rcar_i2c_flags_set(priv
, (ID_DONE
| ID_ARBLOST
));
509 dev_dbg(dev
, "Stop\n");
510 rcar_i2c_flags_set(priv
, ID_DONE
);
518 dev_dbg(dev
, "Nack\n");
520 /* go to stop phase */
521 rcar_i2c_bus_phase(priv
, RCAR_BUS_PHASE_STOP
);
522 rcar_i2c_irq_mask(priv
, RCAR_IRQ_OPEN_FOR_STOP
);
523 rcar_i2c_flags_set(priv
, ID_NACK
);
530 if (rcar_i2c_is_recv(priv
))
531 rcar_i2c_flags_set(priv
, rcar_i2c_irq_recv(priv
, msr
));
533 rcar_i2c_flags_set(priv
, rcar_i2c_irq_send(priv
, msr
));
536 if (rcar_i2c_flags_has(priv
, ID_DONE
)) {
537 rcar_i2c_irq_mask(priv
, RCAR_IRQ_CLOSE
);
538 rcar_i2c_status_clear(priv
);
539 wake_up(&priv
->wait
);
542 spin_unlock(&priv
->lock
);
543 /*-------------- spin unlock -----------------*/
548 static int rcar_i2c_master_xfer(struct i2c_adapter
*adap
,
549 struct i2c_msg
*msgs
,
552 struct rcar_i2c_priv
*priv
= i2c_get_adapdata(adap
);
553 struct device
*dev
= rcar_i2c_priv_to_dev(priv
);
557 pm_runtime_get_sync(dev
);
559 /*-------------- spin lock -----------------*/
560 spin_lock_irqsave(&priv
->lock
, flags
);
563 rcar_i2c_clock_start(priv
);
565 spin_unlock_irqrestore(&priv
->lock
, flags
);
566 /*-------------- spin unlock -----------------*/
569 for (i
= 0; i
< num
; i
++) {
570 /*-------------- spin lock -----------------*/
571 spin_lock_irqsave(&priv
->lock
, flags
);
574 priv
->msg
= &msgs
[i
];
577 if (priv
->msg
== &msgs
[num
- 1])
578 rcar_i2c_flags_set(priv
, ID_LAST_MSG
);
580 /* start send/recv */
581 if (rcar_i2c_is_recv(priv
))
582 ret
= rcar_i2c_recv(priv
);
584 ret
= rcar_i2c_send(priv
);
586 spin_unlock_irqrestore(&priv
->lock
, flags
);
587 /*-------------- spin unlock -----------------*/
595 timeout
= wait_event_timeout(priv
->wait
,
596 rcar_i2c_flags_has(priv
, ID_DONE
),
606 if (rcar_i2c_flags_has(priv
, ID_NACK
)) {
611 if (rcar_i2c_flags_has(priv
, ID_ARBLOST
)) {
616 if (rcar_i2c_flags_has(priv
, ID_IOERROR
)) {
621 ret
= i
+ 1; /* The number of transfer */
627 dev_err(dev
, "error %d : %x\n", ret
, priv
->flags
);
632 static u32
rcar_i2c_func(struct i2c_adapter
*adap
)
634 return I2C_FUNC_I2C
| I2C_FUNC_SMBUS_EMUL
;
637 static const struct i2c_algorithm rcar_i2c_algo
= {
638 .master_xfer
= rcar_i2c_master_xfer
,
639 .functionality
= rcar_i2c_func
,
642 static const struct of_device_id rcar_i2c_dt_ids
[] = {
643 { .compatible
= "renesas,i2c-rcar", .data
= (void *)I2C_RCAR_GEN1
},
644 { .compatible
= "renesas,i2c-r8a7778", .data
= (void *)I2C_RCAR_GEN1
},
645 { .compatible
= "renesas,i2c-r8a7779", .data
= (void *)I2C_RCAR_GEN1
},
646 { .compatible
= "renesas,i2c-r8a7790", .data
= (void *)I2C_RCAR_GEN2
},
649 MODULE_DEVICE_TABLE(of
, rcar_i2c_dt_ids
);
651 static int rcar_i2c_probe(struct platform_device
*pdev
)
653 struct i2c_rcar_platform_data
*pdata
= dev_get_platdata(&pdev
->dev
);
654 struct rcar_i2c_priv
*priv
;
655 struct i2c_adapter
*adap
;
656 struct resource
*res
;
657 struct device
*dev
= &pdev
->dev
;
661 priv
= devm_kzalloc(dev
, sizeof(struct rcar_i2c_priv
), GFP_KERNEL
);
663 dev_err(dev
, "no mem for private data\n");
667 bus_speed
= 100000; /* default 100 kHz */
668 ret
= of_property_read_u32(dev
->of_node
, "clock-frequency", &bus_speed
);
669 if (ret
< 0 && pdata
&& pdata
->bus_speed
)
670 bus_speed
= pdata
->bus_speed
;
672 if (pdev
->dev
.of_node
)
673 priv
->devtype
= (long)of_match_device(rcar_i2c_dt_ids
,
676 priv
->devtype
= platform_get_device_id(pdev
)->driver_data
;
678 ret
= rcar_i2c_clock_calculate(priv
, bus_speed
, dev
);
682 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
683 priv
->io
= devm_ioremap_resource(dev
, res
);
684 if (IS_ERR(priv
->io
))
685 return PTR_ERR(priv
->io
);
687 priv
->irq
= platform_get_irq(pdev
, 0);
688 init_waitqueue_head(&priv
->wait
);
689 spin_lock_init(&priv
->lock
);
693 adap
->algo
= &rcar_i2c_algo
;
694 adap
->class = I2C_CLASS_HWMON
| I2C_CLASS_SPD
;
696 adap
->dev
.parent
= dev
;
697 adap
->dev
.of_node
= dev
->of_node
;
698 i2c_set_adapdata(adap
, priv
);
699 strlcpy(adap
->name
, pdev
->name
, sizeof(adap
->name
));
701 ret
= devm_request_irq(dev
, priv
->irq
, rcar_i2c_irq
, 0,
702 dev_name(dev
), priv
);
704 dev_err(dev
, "cannot get irq %d\n", priv
->irq
);
708 ret
= i2c_add_numbered_adapter(adap
);
710 dev_err(dev
, "reg adap failed: %d\n", ret
);
714 pm_runtime_enable(dev
);
715 platform_set_drvdata(pdev
, priv
);
717 dev_info(dev
, "probed\n");
722 static int rcar_i2c_remove(struct platform_device
*pdev
)
724 struct rcar_i2c_priv
*priv
= platform_get_drvdata(pdev
);
725 struct device
*dev
= &pdev
->dev
;
727 i2c_del_adapter(&priv
->adap
);
728 pm_runtime_disable(dev
);
733 static struct platform_device_id rcar_i2c_id_table
[] = {
734 { "i2c-rcar", I2C_RCAR_GEN1
},
735 { "i2c-rcar_gen1", I2C_RCAR_GEN1
},
736 { "i2c-rcar_gen2", I2C_RCAR_GEN2
},
739 MODULE_DEVICE_TABLE(platform
, rcar_i2c_id_table
);
741 static struct platform_driver rcar_i2c_driver
= {
744 .owner
= THIS_MODULE
,
745 .of_match_table
= rcar_i2c_dt_ids
,
747 .probe
= rcar_i2c_probe
,
748 .remove
= rcar_i2c_remove
,
749 .id_table
= rcar_i2c_id_table
,
752 module_platform_driver(rcar_i2c_driver
);
754 MODULE_LICENSE("GPL");
755 MODULE_DESCRIPTION("Renesas R-Car I2C bus driver");
756 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");