2 * drivers/i2c/busses/i2c-ibm_iic.c
4 * Support for the IIC peripheral on IBM PPC 4xx
6 * Copyright (c) 2003, 2004 Zultys Technologies.
7 * Eugene Surovegin <eugene.surovegin@zultys.com> or <ebs@ebshome.net>
9 * Copyright (c) 2008 PIKA Technologies
10 * Sean MacLennan <smaclennan@pikatech.com>
12 * Based on original work by
13 * Ian DaSilva <idasilva@mvista.com>
14 * Armin Kuster <akuster@mvista.com>
15 * Matt Porter <mporter@mvista.com>
17 * Copyright 2000-2003 MontaVista Software Inc.
19 * Original driver version was highly leveraged from i2c-elektor.c
21 * Copyright 1995-97 Simon G. Vogl
22 * 1998-99 Hans Berglund
24 * With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi>
25 * and even Frodo Looijaard <frodol@dds.nl>
27 * This program is free software; you can redistribute it and/or modify it
28 * under the terms of the GNU General Public License as published by the
29 * Free Software Foundation; either version 2 of the License, or (at your
30 * option) any later version.
34 #include <linux/module.h>
35 #include <linux/kernel.h>
36 #include <linux/ioport.h>
37 #include <linux/delay.h>
38 #include <linux/slab.h>
39 #include <linux/init.h>
40 #include <linux/interrupt.h>
43 #include <linux/i2c.h>
44 #include <linux/i2c-id.h>
45 #include <linux/of_platform.h>
47 #include "i2c-ibm_iic.h"
49 #define DRIVER_VERSION "2.2"
51 MODULE_DESCRIPTION("IBM IIC driver v" DRIVER_VERSION);
52 MODULE_LICENSE("GPL");
54 static int iic_force_poll;
55 module_param(iic_force_poll, bool, 0);
56 MODULE_PARM_DESC(iic_force_poll, "Force polling mode");
58 static int iic_force_fast;
59 module_param(iic_force_fast, bool, 0);
60 MODULE_PARM_DESC(iic_force_fast, "Force fast mode (400 kHz)");
73 # define DBG(f,x...) printk(KERN_DEBUG "ibm-iic" f, ##x)
75 # define DBG(f,x...) ((void)0)
78 # define DBG2(f,x...) DBG(f, ##x)
80 # define DBG2(f,x...) ((void)0)
83 static void dump_iic_regs(const char* header, struct ibm_iic_private* dev)
85 volatile struct iic_regs __iomem *iic = dev->vaddr;
86 printk(KERN_DEBUG "ibm-iic%d: %s\n", dev->idx, header);
87 printk(KERN_DEBUG " cntl = 0x%02x, mdcntl = 0x%02x\n"
88 KERN_DEBUG " sts = 0x%02x, extsts = 0x%02x\n"
89 KERN_DEBUG " clkdiv = 0x%02x, xfrcnt = 0x%02x\n"
90 KERN_DEBUG " xtcntlss = 0x%02x, directcntl = 0x%02x\n",
91 in_8(&iic->cntl), in_8(&iic->mdcntl), in_8(&iic->sts),
92 in_8(&iic->extsts), in_8(&iic->clkdiv), in_8(&iic->xfrcnt),
93 in_8(&iic->xtcntlss), in_8(&iic->directcntl));
95 # define DUMP_REGS(h,dev) dump_iic_regs((h),(dev))
97 # define DUMP_REGS(h,dev) ((void)0)
100 /* Bus timings (in ns) for bit-banging */
101 static struct i2c_timings {
108 /* Standard mode (100 KHz) */
116 /* Fast mode (400 KHz) */
125 /* Enable/disable interrupt generation */
126 static inline void iic_interrupt_mode(struct ibm_iic_private* dev, int enable)
128 out_8(&dev->vaddr->intmsk, enable ? INTRMSK_EIMTC : 0);
132 * Initialize IIC interface.
134 static void iic_dev_init(struct ibm_iic_private* dev)
136 volatile struct iic_regs __iomem *iic = dev->vaddr;
138 DBG("%d: init\n", dev->idx);
140 /* Clear master address */
141 out_8(&iic->lmadr, 0);
142 out_8(&iic->hmadr, 0);
144 /* Clear slave address */
145 out_8(&iic->lsadr, 0);
146 out_8(&iic->hsadr, 0);
148 /* Clear status & extended status */
149 out_8(&iic->sts, STS_SCMP | STS_IRQA);
150 out_8(&iic->extsts, EXTSTS_IRQP | EXTSTS_IRQD | EXTSTS_LA
151 | EXTSTS_ICT | EXTSTS_XFRA);
153 /* Set clock divider */
154 out_8(&iic->clkdiv, dev->clckdiv);
156 /* Clear transfer count */
157 out_8(&iic->xfrcnt, 0);
159 /* Clear extended control and status */
160 out_8(&iic->xtcntlss, XTCNTLSS_SRC | XTCNTLSS_SRS | XTCNTLSS_SWC
163 /* Clear control register */
164 out_8(&iic->cntl, 0);
166 /* Enable interrupts if possible */
167 iic_interrupt_mode(dev, dev->irq >= 0);
169 /* Set mode control */
170 out_8(&iic->mdcntl, MDCNTL_FMDB | MDCNTL_EINT | MDCNTL_EUBS
171 | (dev->fast_mode ? MDCNTL_FSM : 0));
173 DUMP_REGS("iic_init", dev);
177 * Reset IIC interface
179 static void iic_dev_reset(struct ibm_iic_private* dev)
181 volatile struct iic_regs __iomem *iic = dev->vaddr;
185 DBG("%d: soft reset\n", dev->idx);
186 DUMP_REGS("reset", dev);
188 /* Place chip in the reset state */
189 out_8(&iic->xtcntlss, XTCNTLSS_SRST);
191 /* Check if bus is free */
192 dc = in_8(&iic->directcntl);
193 if (!DIRCTNL_FREE(dc)){
194 DBG("%d: trying to regain bus control\n", dev->idx);
196 /* Try to set bus free state */
197 out_8(&iic->directcntl, DIRCNTL_SDAC | DIRCNTL_SCC);
199 /* Wait until we regain bus control */
200 for (i = 0; i < 100; ++i){
201 dc = in_8(&iic->directcntl);
202 if (DIRCTNL_FREE(dc))
205 /* Toggle SCL line */
207 out_8(&iic->directcntl, dc);
210 out_8(&iic->directcntl, dc);
218 out_8(&iic->xtcntlss, 0);
220 /* Reinitialize interface */
225 * Do 0-length transaction using bit-banging through IIC_DIRECTCNTL register.
228 /* Wait for SCL and/or SDA to be high */
229 static int iic_dc_wait(volatile struct iic_regs __iomem *iic, u8 mask)
231 unsigned long x = jiffies + HZ / 28 + 2;
232 while ((in_8(&iic->directcntl) & mask) != mask){
233 if (unlikely(time_after(jiffies, x)))
240 static int iic_smbus_quick(struct ibm_iic_private* dev, const struct i2c_msg* p)
242 volatile struct iic_regs __iomem *iic = dev->vaddr;
243 const struct i2c_timings* t = &timings[dev->fast_mode ? 1 : 0];
247 /* Only 7-bit addresses are supported */
248 if (unlikely(p->flags & I2C_M_TEN)){
249 DBG("%d: smbus_quick - 10 bit addresses are not supported\n",
254 DBG("%d: smbus_quick(0x%02x)\n", dev->idx, p->addr);
256 /* Reset IIC interface */
257 out_8(&iic->xtcntlss, XTCNTLSS_SRST);
259 /* Wait for bus to become free */
260 out_8(&iic->directcntl, DIRCNTL_SDAC | DIRCNTL_SCC);
261 if (unlikely(iic_dc_wait(iic, DIRCNTL_MSDA | DIRCNTL_MSC)))
266 out_8(&iic->directcntl, DIRCNTL_SCC);
271 v = (u8)((p->addr << 1) | ((p->flags & I2C_M_RD) ? 1 : 0));
272 for (i = 0, mask = 0x80; i < 8; ++i, mask >>= 1){
273 out_8(&iic->directcntl, sda);
275 sda = (v & mask) ? DIRCNTL_SDAC : 0;
276 out_8(&iic->directcntl, sda);
279 out_8(&iic->directcntl, DIRCNTL_SCC | sda);
280 if (unlikely(iic_dc_wait(iic, DIRCNTL_MSC)))
286 out_8(&iic->directcntl, sda);
288 out_8(&iic->directcntl, DIRCNTL_SDAC);
290 out_8(&iic->directcntl, DIRCNTL_SDAC | DIRCNTL_SCC);
291 if (unlikely(iic_dc_wait(iic, DIRCNTL_MSC)))
293 res = (in_8(&iic->directcntl) & DIRCNTL_MSDA) ? -EREMOTEIO : 1;
297 out_8(&iic->directcntl, 0);
299 out_8(&iic->directcntl, DIRCNTL_SCC);
300 if (unlikely(iic_dc_wait(iic, DIRCNTL_MSC)))
303 out_8(&iic->directcntl, DIRCNTL_SDAC | DIRCNTL_SCC);
307 DBG("%d: smbus_quick -> %s\n", dev->idx, res ? "NACK" : "ACK");
310 out_8(&iic->xtcntlss, 0);
312 /* Reinitialize interface */
317 DBG("%d: smbus_quick - bus is stuck\n", dev->idx);
323 * IIC interrupt handler
325 static irqreturn_t iic_handler(int irq, void *dev_id)
327 struct ibm_iic_private* dev = (struct ibm_iic_private*)dev_id;
328 volatile struct iic_regs __iomem *iic = dev->vaddr;
330 DBG2("%d: irq handler, STS = 0x%02x, EXTSTS = 0x%02x\n",
331 dev->idx, in_8(&iic->sts), in_8(&iic->extsts));
333 /* Acknowledge IRQ and wakeup iic_wait_for_tc */
334 out_8(&iic->sts, STS_IRQA | STS_SCMP);
335 wake_up_interruptible(&dev->wq);
341 * Get master transfer result and clear errors if any.
342 * Returns the number of actually transferred bytes or error (<0)
344 static int iic_xfer_result(struct ibm_iic_private* dev)
346 volatile struct iic_regs __iomem *iic = dev->vaddr;
348 if (unlikely(in_8(&iic->sts) & STS_ERR)){
349 DBG("%d: xfer error, EXTSTS = 0x%02x\n", dev->idx,
352 /* Clear errors and possible pending IRQs */
353 out_8(&iic->extsts, EXTSTS_IRQP | EXTSTS_IRQD |
354 EXTSTS_LA | EXTSTS_ICT | EXTSTS_XFRA);
356 /* Flush master data buffer */
357 out_8(&iic->mdcntl, in_8(&iic->mdcntl) | MDCNTL_FMDB);
360 * If error happened during combined xfer
361 * IIC interface is usually stuck in some strange
362 * state, the only way out - soft reset.
364 if ((in_8(&iic->extsts) & EXTSTS_BCS_MASK) != EXTSTS_BCS_FREE){
365 DBG("%d: bus is stuck, resetting\n", dev->idx);
371 return in_8(&iic->xfrcnt) & XFRCNT_MTC_MASK;
375 * Try to abort active transfer.
377 static void iic_abort_xfer(struct ibm_iic_private* dev)
379 volatile struct iic_regs __iomem *iic = dev->vaddr;
382 DBG("%d: iic_abort_xfer\n", dev->idx);
384 out_8(&iic->cntl, CNTL_HMT);
387 * Wait for the abort command to complete.
388 * It's not worth to be optimized, just poll (timeout >= 1 tick)
391 while ((in_8(&iic->extsts) & EXTSTS_BCS_MASK) != EXTSTS_BCS_FREE){
392 if (time_after(jiffies, x)){
393 DBG("%d: abort timeout, resetting...\n", dev->idx);
400 /* Just to clear errors */
401 iic_xfer_result(dev);
405 * Wait for master transfer to complete.
406 * It puts current process to sleep until we get interrupt or timeout expires.
407 * Returns the number of transferred bytes or error (<0)
409 static int iic_wait_for_tc(struct ibm_iic_private* dev){
411 volatile struct iic_regs __iomem *iic = dev->vaddr;
416 ret = wait_event_interruptible_timeout(dev->wq,
417 !(in_8(&iic->sts) & STS_PT), dev->adap.timeout * HZ);
419 if (unlikely(ret < 0))
420 DBG("%d: wait interrupted\n", dev->idx);
421 else if (unlikely(in_8(&iic->sts) & STS_PT)){
422 DBG("%d: wait timeout\n", dev->idx);
428 unsigned long x = jiffies + dev->adap.timeout * HZ;
430 while (in_8(&iic->sts) & STS_PT){
431 if (unlikely(time_after(jiffies, x))){
432 DBG("%d: poll timeout\n", dev->idx);
437 if (unlikely(signal_pending(current))){
438 DBG("%d: poll interrupted\n", dev->idx);
446 if (unlikely(ret < 0))
449 ret = iic_xfer_result(dev);
451 DBG2("%d: iic_wait_for_tc -> %d\n", dev->idx, ret);
457 * Low level master transfer routine
459 static int iic_xfer_bytes(struct ibm_iic_private* dev, struct i2c_msg* pm,
462 volatile struct iic_regs __iomem *iic = dev->vaddr;
464 int i, j, loops, ret = 0;
467 u8 cntl = (in_8(&iic->cntl) & CNTL_AMD) | CNTL_PT;
468 if (pm->flags & I2C_M_RD)
471 loops = (len + 3) / 4;
472 for (i = 0; i < loops; ++i, len -= 4){
473 int count = len > 4 ? 4 : len;
474 u8 cmd = cntl | ((count - 1) << CNTL_TCT_SHIFT);
476 if (!(cntl & CNTL_RW))
477 for (j = 0; j < count; ++j)
478 out_8((void __iomem *)&iic->mdbuf, *buf++);
482 else if (combined_xfer)
485 DBG2("%d: xfer_bytes, %d, CNTL = 0x%02x\n", dev->idx, count, cmd);
488 out_8(&iic->cntl, cmd);
490 /* Wait for completion */
491 ret = iic_wait_for_tc(dev);
493 if (unlikely(ret < 0))
495 else if (unlikely(ret != count)){
496 DBG("%d: xfer_bytes, requested %d, transfered %d\n",
497 dev->idx, count, ret);
499 /* If it's not a last part of xfer, abort it */
500 if (combined_xfer || (i < loops - 1))
508 for (j = 0; j < count; ++j)
509 *buf++ = in_8((void __iomem *)&iic->mdbuf);
512 return ret > 0 ? 0 : ret;
516 * Set target slave address for master transfer
518 static inline void iic_address(struct ibm_iic_private* dev, struct i2c_msg* msg)
520 volatile struct iic_regs __iomem *iic = dev->vaddr;
521 u16 addr = msg->addr;
523 DBG2("%d: iic_address, 0x%03x (%d-bit)\n", dev->idx,
524 addr, msg->flags & I2C_M_TEN ? 10 : 7);
526 if (msg->flags & I2C_M_TEN){
527 out_8(&iic->cntl, CNTL_AMD);
528 out_8(&iic->lmadr, addr);
529 out_8(&iic->hmadr, 0xf0 | ((addr >> 7) & 0x06));
532 out_8(&iic->cntl, 0);
533 out_8(&iic->lmadr, addr << 1);
537 static inline int iic_invalid_address(const struct i2c_msg* p)
539 return (p->addr > 0x3ff) || (!(p->flags & I2C_M_TEN) && (p->addr > 0x7f));
542 static inline int iic_address_neq(const struct i2c_msg* p1,
543 const struct i2c_msg* p2)
545 return (p1->addr != p2->addr)
546 || ((p1->flags & I2C_M_TEN) != (p2->flags & I2C_M_TEN));
550 * Generic master transfer entrypoint.
551 * Returns the number of processed messages or error (<0)
553 static int iic_xfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
555 struct ibm_iic_private* dev = (struct ibm_iic_private*)(i2c_get_adapdata(adap));
556 volatile struct iic_regs __iomem *iic = dev->vaddr;
559 DBG2("%d: iic_xfer, %d msg(s)\n", dev->idx, num);
564 /* Check the sanity of the passed messages.
565 * Uhh, generic i2c layer is more suitable place for such code...
567 if (unlikely(iic_invalid_address(&msgs[0]))){
568 DBG("%d: invalid address 0x%03x (%d-bit)\n", dev->idx,
569 msgs[0].addr, msgs[0].flags & I2C_M_TEN ? 10 : 7);
572 for (i = 0; i < num; ++i){
573 if (unlikely(msgs[i].len <= 0)){
574 if (num == 1 && !msgs[0].len){
575 /* Special case for I2C_SMBUS_QUICK emulation.
576 * IBM IIC doesn't support 0-length transactions
577 * so we have to emulate them using bit-banging.
579 return iic_smbus_quick(dev, &msgs[0]);
581 DBG("%d: invalid len %d in msg[%d]\n", dev->idx,
585 if (unlikely(iic_address_neq(&msgs[0], &msgs[i]))){
586 DBG("%d: invalid addr in msg[%d]\n", dev->idx, i);
591 /* Check bus state */
592 if (unlikely((in_8(&iic->extsts) & EXTSTS_BCS_MASK) != EXTSTS_BCS_FREE)){
593 DBG("%d: iic_xfer, bus is not free\n", dev->idx);
595 /* Usually it means something serious has happend.
596 * We *cannot* have unfinished previous transfer
597 * so it doesn't make any sense to try to stop it.
598 * Probably we were not able to recover from the
600 * The only *reasonable* thing I can think of here
601 * is soft reset. --ebs
605 if ((in_8(&iic->extsts) & EXTSTS_BCS_MASK) != EXTSTS_BCS_FREE){
606 DBG("%d: iic_xfer, bus is still not free\n", dev->idx);
611 /* Flush master data buffer (just in case) */
612 out_8(&iic->mdcntl, in_8(&iic->mdcntl) | MDCNTL_FMDB);
615 /* Load slave address */
616 iic_address(dev, &msgs[0]);
618 /* Do real transfer */
619 for (i = 0; i < num && !ret; ++i)
620 ret = iic_xfer_bytes(dev, &msgs[i], i < num - 1);
622 return ret < 0 ? ret : num;
625 static u32 iic_func(struct i2c_adapter *adap)
627 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL | I2C_FUNC_10BIT_ADDR;
630 static const struct i2c_algorithm iic_algo = {
631 .master_xfer = iic_xfer,
632 .functionality = iic_func
636 * Calculates IICx_CLCKDIV value for a specific OPB clock frequency
638 static inline u8 iic_clckdiv(unsigned int opb)
640 /* Compatibility kludge, should go away after all cards
641 * are fixed to fill correct value for opbfreq.
642 * Previous driver version used hardcoded divider value 4,
643 * it corresponds to OPB frequency from the range (40, 50] MHz
646 printk(KERN_WARNING "ibm-iic: using compatibility value for OPB freq,"
647 " fix your board specific setup\n");
654 if (opb < 20 || opb > 150){
655 printk(KERN_WARNING "ibm-iic: invalid OPB clock frequency %u MHz\n",
657 opb = opb < 20 ? 20 : 150;
659 return (u8)((opb + 9) / 10 - 1);
662 static int __devinit iic_request_irq(struct of_device *ofdev,
663 struct ibm_iic_private *dev)
665 struct device_node *np = ofdev->node;
671 irq = irq_of_parse_and_map(np, 0);
673 dev_err(&ofdev->dev, "irq_of_parse_and_map failed\n");
677 /* Disable interrupts until we finish initialization, assumes
678 * level-sensitive IRQ setup...
680 iic_interrupt_mode(dev, 0);
681 if (request_irq(irq, iic_handler, 0, "IBM IIC", dev)) {
682 dev_err(&ofdev->dev, "request_irq %d failed\n", irq);
683 /* Fallback to the polling mode */
691 * Register single IIC interface
693 static int __devinit iic_probe(struct of_device *ofdev,
694 const struct of_device_id *match)
696 struct device_node *np = ofdev->node;
697 struct ibm_iic_private *dev;
698 struct i2c_adapter *adap;
699 const u32 *indexp, *freq;
702 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
704 dev_err(&ofdev->dev, "failed to allocate device data\n");
708 dev_set_drvdata(&ofdev->dev, dev);
710 indexp = of_get_property(np, "index", NULL);
712 dev_err(&ofdev->dev, "no index specified\n");
718 dev->vaddr = of_iomap(np, 0);
719 if (dev->vaddr == NULL) {
720 dev_err(&ofdev->dev, "failed to iomap device\n");
725 init_waitqueue_head(&dev->wq);
727 dev->irq = iic_request_irq(ofdev, dev);
728 if (dev->irq == NO_IRQ)
729 dev_warn(&ofdev->dev, "using polling mode\n");
731 /* Board specific settings */
732 if (iic_force_fast || of_get_property(np, "fast-mode", NULL))
735 freq = of_get_property(np, "clock-frequency", NULL);
737 freq = of_get_property(np->parent, "clock-frequency", NULL);
739 dev_err(&ofdev->dev, "Unable to get bus frequency\n");
745 dev->clckdiv = iic_clckdiv(*freq);
746 dev_dbg(&ofdev->dev, "clckdiv = %d\n", dev->clckdiv);
748 /* Initialize IIC interface */
751 /* Register it with i2c layer */
753 adap->dev.parent = &ofdev->dev;
754 strlcpy(adap->name, "IBM IIC", sizeof(adap->name));
755 i2c_set_adapdata(adap, dev);
756 adap->id = I2C_HW_OCP;
757 adap->class = I2C_CLASS_HWMON | I2C_CLASS_SPD;
758 adap->algo = &iic_algo;
762 ret = i2c_add_numbered_adapter(adap);
764 dev_err(&ofdev->dev, "failed to register i2c adapter\n");
768 dev_info(&ofdev->dev, "using %s mode\n",
769 dev->fast_mode ? "fast (400 kHz)" : "standard (100 kHz)");
774 if (dev->irq != NO_IRQ) {
775 iic_interrupt_mode(dev, 0);
776 free_irq(dev->irq, dev);
782 dev_set_drvdata(&ofdev->dev, NULL);
788 * Cleanup initialized IIC interface
790 static int __devexit iic_remove(struct of_device *ofdev)
792 struct ibm_iic_private *dev = dev_get_drvdata(&ofdev->dev);
794 dev_set_drvdata(&ofdev->dev, NULL);
796 i2c_del_adapter(&dev->adap);
798 if (dev->irq != NO_IRQ) {
799 iic_interrupt_mode(dev, 0);
800 free_irq(dev->irq, dev);
809 static const struct of_device_id ibm_iic_match[] = {
810 { .compatible = "ibm,iic", },
814 static struct of_platform_driver ibm_iic_driver = {
816 .match_table = ibm_iic_match,
818 .remove = __devexit_p(iic_remove),
821 static int __init iic_init(void)
823 return of_register_platform_driver(&ibm_iic_driver);
826 static void __exit iic_exit(void)
828 of_unregister_platform_driver(&ibm_iic_driver);
831 module_init(iic_init);
832 module_exit(iic_exit);