1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23#include <linux/kernel.h>
24#include <linux/module.h>
25#include <linux/init.h>
26#include <linux/delay.h>
27#include <linux/platform_device.h>
28#include <linux/interrupt.h>
29#include <linux/i2c.h>
30#include <linux/err.h>
31#include <linux/pm_runtime.h>
32#include <linux/clk.h>
33#include <linux/io.h>
34#include <linux/slab.h>
35#include <linux/i2c/i2c-sh_mobile.h>
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106enum sh_mobile_i2c_op {
107 OP_START = 0,
108 OP_TX_FIRST,
109 OP_TX,
110 OP_TX_STOP,
111 OP_TX_TO_RX,
112 OP_RX,
113 OP_RX_STOP,
114 OP_RX_STOP_DATA,
115};
116
117struct sh_mobile_i2c_data {
118 struct device *dev;
119 void __iomem *reg;
120 struct i2c_adapter adap;
121 unsigned long bus_speed;
122 struct clk *clk;
123 u_int8_t icic;
124 u_int8_t iccl;
125 u_int8_t icch;
126 u_int8_t flags;
127
128 spinlock_t lock;
129 wait_queue_head_t wait;
130 struct i2c_msg *msg;
131 int pos;
132 int sr;
133};
134
135#define IIC_FLAG_HAS_ICIC67 (1 << 0)
136
137#define NORMAL_SPEED 100000
138
139
140#define ICDR 0x00
141#define ICCR 0x04
142#define ICSR 0x08
143#define ICIC 0x0c
144#define ICCL 0x10
145#define ICCH 0x14
146
147
148#define ICCR_ICE 0x80
149#define ICCR_RACK 0x40
150#define ICCR_TRS 0x10
151#define ICCR_BBSY 0x04
152#define ICCR_SCP 0x01
153
154#define ICSR_SCLM 0x80
155#define ICSR_SDAM 0x40
156#define SW_DONE 0x20
157#define ICSR_BUSY 0x10
158#define ICSR_AL 0x08
159#define ICSR_TACK 0x04
160#define ICSR_WAIT 0x02
161#define ICSR_DTE 0x01
162
163#define ICIC_ICCLB8 0x80
164#define ICIC_ICCHB8 0x40
165#define ICIC_ALE 0x08
166#define ICIC_TACKE 0x04
167#define ICIC_WAITE 0x02
168#define ICIC_DTEE 0x01
169
170static void iic_wr(struct sh_mobile_i2c_data *pd, int offs, unsigned char data)
171{
172 if (offs == ICIC)
173 data |= pd->icic;
174
175 iowrite8(data, pd->reg + offs);
176}
177
178static unsigned char iic_rd(struct sh_mobile_i2c_data *pd, int offs)
179{
180 return ioread8(pd->reg + offs);
181}
182
183static void iic_set_clr(struct sh_mobile_i2c_data *pd, int offs,
184 unsigned char set, unsigned char clr)
185{
186 iic_wr(pd, offs, (iic_rd(pd, offs) | set) & ~clr);
187}
188
189static void activate_ch(struct sh_mobile_i2c_data *pd)
190{
191 unsigned long i2c_clk;
192 u_int32_t num;
193 u_int32_t denom;
194 u_int32_t tmp;
195
196
197 pm_runtime_get_sync(pd->dev);
198 clk_enable(pd->clk);
199
200
201 i2c_clk = clk_get_rate(pd->clk);
202
203
204
205
206
207
208 num = i2c_clk * 5;
209 denom = pd->bus_speed * 9;
210 tmp = num * 10 / denom;
211 if (tmp % 10 >= 5)
212 pd->iccl = (u_int8_t)((num/denom) + 1);
213 else
214 pd->iccl = (u_int8_t)(num/denom);
215
216
217 if (pd->flags & IIC_FLAG_HAS_ICIC67) {
218 if ((num/denom) > 0xff)
219 pd->icic |= ICIC_ICCLB8;
220 else
221 pd->icic &= ~ICIC_ICCLB8;
222 }
223
224
225
226 num = i2c_clk * 4;
227 tmp = num * 10 / denom;
228 if (tmp % 10 >= 5)
229 pd->icch = (u_int8_t)((num/denom) + 1);
230 else
231 pd->icch = (u_int8_t)(num/denom);
232
233
234 if (pd->flags & IIC_FLAG_HAS_ICIC67) {
235 if ((num/denom) > 0xff)
236 pd->icic |= ICIC_ICCHB8;
237 else
238 pd->icic &= ~ICIC_ICCHB8;
239 }
240
241
242 iic_set_clr(pd, ICCR, ICCR_ICE, 0);
243
244
245 iic_wr(pd, ICIC, 0);
246
247
248 iic_wr(pd, ICCL, pd->iccl);
249 iic_wr(pd, ICCH, pd->icch);
250}
251
252static void deactivate_ch(struct sh_mobile_i2c_data *pd)
253{
254
255 iic_wr(pd, ICSR, 0);
256 iic_wr(pd, ICIC, 0);
257
258
259 iic_set_clr(pd, ICCR, 0, ICCR_ICE);
260
261
262 clk_disable(pd->clk);
263 pm_runtime_put_sync(pd->dev);
264}
265
266static unsigned char i2c_op(struct sh_mobile_i2c_data *pd,
267 enum sh_mobile_i2c_op op, unsigned char data)
268{
269 unsigned char ret = 0;
270 unsigned long flags;
271
272 dev_dbg(pd->dev, "op %d, data in 0x%02x\n", op, data);
273
274 spin_lock_irqsave(&pd->lock, flags);
275
276 switch (op) {
277 case OP_START:
278 iic_wr(pd, ICCR, 0x94);
279 break;
280 case OP_TX_FIRST:
281 iic_wr(pd, ICIC, ICIC_WAITE | ICIC_ALE | ICIC_TACKE);
282 iic_wr(pd, ICDR, data);
283 break;
284 case OP_TX:
285 iic_wr(pd, ICDR, data);
286 break;
287 case OP_TX_STOP:
288 iic_wr(pd, ICDR, data);
289 iic_wr(pd, ICCR, 0x90);
290 break;
291 case OP_TX_TO_RX:
292 iic_wr(pd, ICCR, 0x81);
293 break;
294 case OP_RX:
295 ret = iic_rd(pd, ICDR);
296 break;
297 case OP_RX_STOP:
298 iic_wr(pd, ICIC,
299 ICIC_DTEE | ICIC_WAITE | ICIC_ALE | ICIC_TACKE);
300 iic_wr(pd, ICCR, 0xc0);
301 break;
302 case OP_RX_STOP_DATA:
303 iic_wr(pd, ICIC,
304 ICIC_DTEE | ICIC_WAITE | ICIC_ALE | ICIC_TACKE);
305 ret = iic_rd(pd, ICDR);
306 iic_wr(pd, ICCR, 0xc0);
307 break;
308 }
309
310 spin_unlock_irqrestore(&pd->lock, flags);
311
312 dev_dbg(pd->dev, "op %d, data out 0x%02x\n", op, ret);
313 return ret;
314}
315
316static int sh_mobile_i2c_is_first_byte(struct sh_mobile_i2c_data *pd)
317{
318 if (pd->pos == -1)
319 return 1;
320
321 return 0;
322}
323
324static int sh_mobile_i2c_is_last_byte(struct sh_mobile_i2c_data *pd)
325{
326 if (pd->pos == (pd->msg->len - 1))
327 return 1;
328
329 return 0;
330}
331
332static void sh_mobile_i2c_get_data(struct sh_mobile_i2c_data *pd,
333 unsigned char *buf)
334{
335 switch (pd->pos) {
336 case -1:
337 *buf = (pd->msg->addr & 0x7f) << 1;
338 *buf |= (pd->msg->flags & I2C_M_RD) ? 1 : 0;
339 break;
340 default:
341 *buf = pd->msg->buf[pd->pos];
342 }
343}
344
345static int sh_mobile_i2c_isr_tx(struct sh_mobile_i2c_data *pd)
346{
347 unsigned char data;
348
349 if (pd->pos == pd->msg->len)
350 return 1;
351
352 sh_mobile_i2c_get_data(pd, &data);
353
354 if (sh_mobile_i2c_is_last_byte(pd))
355 i2c_op(pd, OP_TX_STOP, data);
356 else if (sh_mobile_i2c_is_first_byte(pd))
357 i2c_op(pd, OP_TX_FIRST, data);
358 else
359 i2c_op(pd, OP_TX, data);
360
361 pd->pos++;
362 return 0;
363}
364
365static int sh_mobile_i2c_isr_rx(struct sh_mobile_i2c_data *pd)
366{
367 unsigned char data;
368 int real_pos;
369
370 do {
371 if (pd->pos <= -1) {
372 sh_mobile_i2c_get_data(pd, &data);
373
374 if (sh_mobile_i2c_is_first_byte(pd))
375 i2c_op(pd, OP_TX_FIRST, data);
376 else
377 i2c_op(pd, OP_TX, data);
378 break;
379 }
380
381 if (pd->pos == 0) {
382 i2c_op(pd, OP_TX_TO_RX, 0);
383 break;
384 }
385
386 real_pos = pd->pos - 2;
387
388 if (pd->pos == pd->msg->len) {
389 if (real_pos < 0) {
390 i2c_op(pd, OP_RX_STOP, 0);
391 break;
392 }
393 data = i2c_op(pd, OP_RX_STOP_DATA, 0);
394 } else
395 data = i2c_op(pd, OP_RX, 0);
396
397 if (real_pos >= 0)
398 pd->msg->buf[real_pos] = data;
399 } while (0);
400
401 pd->pos++;
402 return pd->pos == (pd->msg->len + 2);
403}
404
405static irqreturn_t sh_mobile_i2c_isr(int irq, void *dev_id)
406{
407 struct platform_device *dev = dev_id;
408 struct sh_mobile_i2c_data *pd = platform_get_drvdata(dev);
409 unsigned char sr;
410 int wakeup;
411
412 sr = iic_rd(pd, ICSR);
413 pd->sr |= sr;
414
415 dev_dbg(pd->dev, "i2c_isr 0x%02x 0x%02x %s %d %d!\n", sr, pd->sr,
416 (pd->msg->flags & I2C_M_RD) ? "read" : "write",
417 pd->pos, pd->msg->len);
418
419 if (sr & (ICSR_AL | ICSR_TACK)) {
420
421 iic_wr(pd, ICSR, sr & ~(ICSR_AL | ICSR_TACK));
422 wakeup = 0;
423 } else if (pd->msg->flags & I2C_M_RD)
424 wakeup = sh_mobile_i2c_isr_rx(pd);
425 else
426 wakeup = sh_mobile_i2c_isr_tx(pd);
427
428 if (sr & ICSR_WAIT)
429 iic_wr(pd, ICSR, sr & ~ICSR_WAIT);
430
431 if (wakeup) {
432 pd->sr |= SW_DONE;
433 wake_up(&pd->wait);
434 }
435
436 return IRQ_HANDLED;
437}
438
439static int start_ch(struct sh_mobile_i2c_data *pd, struct i2c_msg *usr_msg)
440{
441 if (usr_msg->len == 0 && (usr_msg->flags & I2C_M_RD)) {
442 dev_err(pd->dev, "Unsupported zero length i2c read\n");
443 return -EIO;
444 }
445
446
447 iic_set_clr(pd, ICCR, 0, ICCR_ICE);
448
449
450 iic_set_clr(pd, ICCR, ICCR_ICE, 0);
451
452
453 iic_wr(pd, ICCL, pd->iccl);
454 iic_wr(pd, ICCH, pd->icch);
455
456 pd->msg = usr_msg;
457 pd->pos = -1;
458 pd->sr = 0;
459
460
461 iic_wr(pd, ICIC, ICIC_DTEE | ICIC_WAITE | ICIC_ALE | ICIC_TACKE);
462 return 0;
463}
464
465static int sh_mobile_i2c_xfer(struct i2c_adapter *adapter,
466 struct i2c_msg *msgs,
467 int num)
468{
469 struct sh_mobile_i2c_data *pd = i2c_get_adapdata(adapter);
470 struct i2c_msg *msg;
471 int err = 0;
472 u_int8_t val;
473 int i, k, retry_count;
474
475 activate_ch(pd);
476
477
478 for (i = 0; i < num; i++) {
479 msg = &msgs[i];
480
481 err = start_ch(pd, msg);
482 if (err)
483 break;
484
485 i2c_op(pd, OP_START, 0);
486
487
488 k = wait_event_timeout(pd->wait,
489 pd->sr & (ICSR_TACK | SW_DONE),
490 5 * HZ);
491 if (!k)
492 dev_err(pd->dev, "Transfer request timed out\n");
493
494 retry_count = 1000;
495again:
496 val = iic_rd(pd, ICSR);
497
498 dev_dbg(pd->dev, "val 0x%02x pd->sr 0x%02x\n", val, pd->sr);
499
500
501
502
503
504 if (val & ICSR_BUSY) {
505 udelay(10);
506 if (retry_count--)
507 goto again;
508
509 err = -EIO;
510 dev_err(pd->dev, "Polling timed out\n");
511 break;
512 }
513
514
515 if ((val | pd->sr) & (ICSR_TACK | ICSR_AL)) {
516 err = -EIO;
517 break;
518 }
519 }
520
521 deactivate_ch(pd);
522
523 if (!err)
524 err = num;
525 return err;
526}
527
528static u32 sh_mobile_i2c_func(struct i2c_adapter *adapter)
529{
530 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
531}
532
533static struct i2c_algorithm sh_mobile_i2c_algorithm = {
534 .functionality = sh_mobile_i2c_func,
535 .master_xfer = sh_mobile_i2c_xfer,
536};
537
538static int sh_mobile_i2c_hook_irqs(struct platform_device *dev, int hook)
539{
540 struct resource *res;
541 int ret = -ENXIO;
542 int n, k = 0;
543
544 while ((res = platform_get_resource(dev, IORESOURCE_IRQ, k))) {
545 for (n = res->start; hook && n <= res->end; n++) {
546 if (request_irq(n, sh_mobile_i2c_isr, 0,
547 dev_name(&dev->dev), dev)) {
548 for (n--; n >= res->start; n--)
549 free_irq(n, dev);
550
551 goto rollback;
552 }
553 }
554 k++;
555 }
556
557 if (hook)
558 return k > 0 ? 0 : -ENOENT;
559
560 ret = 0;
561
562 rollback:
563 k--;
564
565 while (k >= 0) {
566 res = platform_get_resource(dev, IORESOURCE_IRQ, k);
567 for (n = res->start; n <= res->end; n++)
568 free_irq(n, dev);
569
570 k--;
571 }
572
573 return ret;
574}
575
576static int sh_mobile_i2c_probe(struct platform_device *dev)
577{
578 struct i2c_sh_mobile_platform_data *pdata = dev->dev.platform_data;
579 struct sh_mobile_i2c_data *pd;
580 struct i2c_adapter *adap;
581 struct resource *res;
582 int size;
583 int ret;
584
585 pd = kzalloc(sizeof(struct sh_mobile_i2c_data), GFP_KERNEL);
586 if (pd == NULL) {
587 dev_err(&dev->dev, "cannot allocate private data\n");
588 return -ENOMEM;
589 }
590
591 pd->clk = clk_get(&dev->dev, NULL);
592 if (IS_ERR(pd->clk)) {
593 dev_err(&dev->dev, "cannot get clock\n");
594 ret = PTR_ERR(pd->clk);
595 goto err;
596 }
597
598 ret = sh_mobile_i2c_hook_irqs(dev, 1);
599 if (ret) {
600 dev_err(&dev->dev, "cannot request IRQ\n");
601 goto err_clk;
602 }
603
604 pd->dev = &dev->dev;
605 platform_set_drvdata(dev, pd);
606
607 res = platform_get_resource(dev, IORESOURCE_MEM, 0);
608 if (res == NULL) {
609 dev_err(&dev->dev, "cannot find IO resource\n");
610 ret = -ENOENT;
611 goto err_irq;
612 }
613
614 size = resource_size(res);
615
616 pd->reg = ioremap(res->start, size);
617 if (pd->reg == NULL) {
618 dev_err(&dev->dev, "cannot map IO\n");
619 ret = -ENXIO;
620 goto err_irq;
621 }
622
623
624 pd->bus_speed = NORMAL_SPEED;
625 if (pdata && pdata->bus_speed)
626 pd->bus_speed = pdata->bus_speed;
627
628
629
630
631 if (size > 0x17)
632 pd->flags |= IIC_FLAG_HAS_ICIC67;
633
634
635
636
637
638
639
640
641
642
643
644 pm_suspend_ignore_children(&dev->dev, true);
645 pm_runtime_enable(&dev->dev);
646
647
648 adap = &pd->adap;
649 i2c_set_adapdata(adap, pd);
650
651 adap->owner = THIS_MODULE;
652 adap->algo = &sh_mobile_i2c_algorithm;
653 adap->dev.parent = &dev->dev;
654 adap->retries = 5;
655 adap->nr = dev->id;
656
657 strlcpy(adap->name, dev->name, sizeof(adap->name));
658
659 spin_lock_init(&pd->lock);
660 init_waitqueue_head(&pd->wait);
661
662 ret = i2c_add_numbered_adapter(adap);
663 if (ret < 0) {
664 dev_err(&dev->dev, "cannot add numbered adapter\n");
665 goto err_all;
666 }
667
668 dev_info(&dev->dev, "I2C adapter %d with bus speed %lu Hz\n",
669 adap->nr, pd->bus_speed);
670 return 0;
671
672 err_all:
673 iounmap(pd->reg);
674 err_irq:
675 sh_mobile_i2c_hook_irqs(dev, 0);
676 err_clk:
677 clk_put(pd->clk);
678 err:
679 kfree(pd);
680 return ret;
681}
682
683static int sh_mobile_i2c_remove(struct platform_device *dev)
684{
685 struct sh_mobile_i2c_data *pd = platform_get_drvdata(dev);
686
687 i2c_del_adapter(&pd->adap);
688 iounmap(pd->reg);
689 sh_mobile_i2c_hook_irqs(dev, 0);
690 clk_put(pd->clk);
691 pm_runtime_disable(&dev->dev);
692 kfree(pd);
693 return 0;
694}
695
696static int sh_mobile_i2c_runtime_nop(struct device *dev)
697{
698
699
700
701
702
703
704
705 return 0;
706}
707
708static const struct dev_pm_ops sh_mobile_i2c_dev_pm_ops = {
709 .runtime_suspend = sh_mobile_i2c_runtime_nop,
710 .runtime_resume = sh_mobile_i2c_runtime_nop,
711};
712
713static struct platform_driver sh_mobile_i2c_driver = {
714 .driver = {
715 .name = "i2c-sh_mobile",
716 .owner = THIS_MODULE,
717 .pm = &sh_mobile_i2c_dev_pm_ops,
718 },
719 .probe = sh_mobile_i2c_probe,
720 .remove = sh_mobile_i2c_remove,
721};
722
723static int __init sh_mobile_i2c_adap_init(void)
724{
725 return platform_driver_register(&sh_mobile_i2c_driver);
726}
727
728static void __exit sh_mobile_i2c_adap_exit(void)
729{
730 platform_driver_unregister(&sh_mobile_i2c_driver);
731}
732
733subsys_initcall(sh_mobile_i2c_adap_init);
734module_exit(sh_mobile_i2c_adap_exit);
735
736MODULE_DESCRIPTION("SuperH Mobile I2C Bus Controller driver");
737MODULE_AUTHOR("Magnus Damm");
738MODULE_LICENSE("GPL v2");
739MODULE_ALIAS("platform:i2c-sh_mobile");
740