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 * Based on original work by
10 * Ian DaSilva <idasilva@mvista.com>
11 * Armin Kuster <akuster@mvista.com>
12 * Matt Porter <mporter@mvista.com>
14 * Copyright 2000-2003 MontaVista Software Inc.
16 * Original driver version was highly leveraged from i2c-elektor.c
18 * Copyright 1995-97 Simon G. Vogl
19 * 1998-99 Hans Berglund
21 * With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi>
22 * and even Frodo Looijaard <frodol@dds.nl>
24 * This program is free software; you can redistribute it and/or modify it
25 * under the terms of the GNU General Public License as published by the
26 * Free Software Foundation; either version 2 of the License, or (at your
27 * option) any later version.
31 #include <linux/module.h>
32 #include <linux/kernel.h>
33 #include <linux/ioport.h>
34 #include <linux/delay.h>
35 #include <linux/slab.h>
36 #include <linux/init.h>
37 #include <linux/interrupt.h>
40 #include <linux/i2c.h>
41 #include <linux/i2c-id.h>
43 #include <asm/ibm4xx.h>
45 #include "i2c-ibm_iic.h"
47 #define DRIVER_VERSION "2.1"
49 MODULE_DESCRIPTION("IBM IIC driver v" DRIVER_VERSION);
50 MODULE_LICENSE("GPL");
52 static int iic_force_poll;
53 module_param(iic_force_poll, bool, 0);
54 MODULE_PARM_DESC(iic_force_poll, "Force polling mode");
56 static int iic_force_fast;
57 module_param(iic_force_fast, bool, 0);
58 MODULE_PARM_DESC(iic_force_fast, "Force fast mode (400 kHz)");
71 # define DBG(f,x...) printk(KERN_DEBUG "ibm-iic" f, ##x)
73 # define DBG(f,x...) ((void)0)
76 # define DBG2(f,x...) DBG(f, ##x)
78 # define DBG2(f,x...) ((void)0)
81 static void dump_iic_regs(const char* header, struct ibm_iic_private* dev)
83 volatile struct iic_regs __iomem *iic = dev->vaddr;
84 printk(KERN_DEBUG "ibm-iic%d: %s\n", dev->idx, header);
85 printk(KERN_DEBUG " cntl = 0x%02x, mdcntl = 0x%02x\n"
86 KERN_DEBUG " sts = 0x%02x, extsts = 0x%02x\n"
87 KERN_DEBUG " clkdiv = 0x%02x, xfrcnt = 0x%02x\n"
88 KERN_DEBUG " xtcntlss = 0x%02x, directcntl = 0x%02x\n",
89 in_8(&iic->cntl), in_8(&iic->mdcntl), in_8(&iic->sts),
90 in_8(&iic->extsts), in_8(&iic->clkdiv), in_8(&iic->xfrcnt),
91 in_8(&iic->xtcntlss), in_8(&iic->directcntl));
93 # define DUMP_REGS(h,dev) dump_iic_regs((h),(dev))
95 # define DUMP_REGS(h,dev) ((void)0)
98 /* Bus timings (in ns) for bit-banging */
99 static struct i2c_timings {
106 /* Standard mode (100 KHz) */
114 /* Fast mode (400 KHz) */
123 /* Enable/disable interrupt generation */
124 static inline void iic_interrupt_mode(struct ibm_iic_private* dev, int enable)
126 out_8(&dev->vaddr->intmsk, enable ? INTRMSK_EIMTC : 0);
130 * Initialize IIC interface.
132 static void iic_dev_init(struct ibm_iic_private* dev)
134 volatile struct iic_regs __iomem *iic = dev->vaddr;
136 DBG("%d: init\n", dev->idx);
138 /* Clear master address */
139 out_8(&iic->lmadr, 0);
140 out_8(&iic->hmadr, 0);
142 /* Clear slave address */
143 out_8(&iic->lsadr, 0);
144 out_8(&iic->hsadr, 0);
146 /* Clear status & extended status */
147 out_8(&iic->sts, STS_SCMP | STS_IRQA);
148 out_8(&iic->extsts, EXTSTS_IRQP | EXTSTS_IRQD | EXTSTS_LA
149 | EXTSTS_ICT | EXTSTS_XFRA);
151 /* Set clock divider */
152 out_8(&iic->clkdiv, dev->clckdiv);
154 /* Clear transfer count */
155 out_8(&iic->xfrcnt, 0);
157 /* Clear extended control and status */
158 out_8(&iic->xtcntlss, XTCNTLSS_SRC | XTCNTLSS_SRS | XTCNTLSS_SWC
161 /* Clear control register */
162 out_8(&iic->cntl, 0);
164 /* Enable interrupts if possible */
165 iic_interrupt_mode(dev, dev->irq >= 0);
167 /* Set mode control */
168 out_8(&iic->mdcntl, MDCNTL_FMDB | MDCNTL_EINT | MDCNTL_EUBS
169 | (dev->fast_mode ? MDCNTL_FSM : 0));
171 DUMP_REGS("iic_init", dev);
175 * Reset IIC interface
177 static void iic_dev_reset(struct ibm_iic_private* dev)
179 volatile struct iic_regs __iomem *iic = dev->vaddr;
183 DBG("%d: soft reset\n", dev->idx);
184 DUMP_REGS("reset", dev);
186 /* Place chip in the reset state */
187 out_8(&iic->xtcntlss, XTCNTLSS_SRST);
189 /* Check if bus is free */
190 dc = in_8(&iic->directcntl);
191 if (!DIRCTNL_FREE(dc)){
192 DBG("%d: trying to regain bus control\n", dev->idx);
194 /* Try to set bus free state */
195 out_8(&iic->directcntl, DIRCNTL_SDAC | DIRCNTL_SCC);
197 /* Wait until we regain bus control */
198 for (i = 0; i < 100; ++i){
199 dc = in_8(&iic->directcntl);
200 if (DIRCTNL_FREE(dc))
203 /* Toggle SCL line */
205 out_8(&iic->directcntl, dc);
208 out_8(&iic->directcntl, dc);
216 out_8(&iic->xtcntlss, 0);
218 /* Reinitialize interface */
223 * Do 0-length transaction using bit-banging through IIC_DIRECTCNTL register.
226 /* Wait for SCL and/or SDA to be high */
227 static int iic_dc_wait(volatile struct iic_regs __iomem *iic, u8 mask)
229 unsigned long x = jiffies + HZ / 28 + 2;
230 while ((in_8(&iic->directcntl) & mask) != mask){
231 if (unlikely(time_after(jiffies, x)))
238 static int iic_smbus_quick(struct ibm_iic_private* dev, const struct i2c_msg* p)
240 volatile struct iic_regs __iomem *iic = dev->vaddr;
241 const struct i2c_timings* t = &timings[dev->fast_mode ? 1 : 0];
245 /* Only 7-bit addresses are supported */
246 if (unlikely(p->flags & I2C_M_TEN)){
247 DBG("%d: smbus_quick - 10 bit addresses are not supported\n",
252 DBG("%d: smbus_quick(0x%02x)\n", dev->idx, p->addr);
254 /* Reset IIC interface */
255 out_8(&iic->xtcntlss, XTCNTLSS_SRST);
257 /* Wait for bus to become free */
258 out_8(&iic->directcntl, DIRCNTL_SDAC | DIRCNTL_SCC);
259 if (unlikely(iic_dc_wait(iic, DIRCNTL_MSDA | DIRCNTL_MSC)))
264 out_8(&iic->directcntl, DIRCNTL_SCC);
269 v = (u8)((p->addr << 1) | ((p->flags & I2C_M_RD) ? 1 : 0));
270 for (i = 0, mask = 0x80; i < 8; ++i, mask >>= 1){
271 out_8(&iic->directcntl, sda);
273 sda = (v & mask) ? DIRCNTL_SDAC : 0;
274 out_8(&iic->directcntl, sda);
277 out_8(&iic->directcntl, DIRCNTL_SCC | sda);
278 if (unlikely(iic_dc_wait(iic, DIRCNTL_MSC)))
284 out_8(&iic->directcntl, sda);
286 out_8(&iic->directcntl, DIRCNTL_SDAC);
288 out_8(&iic->directcntl, DIRCNTL_SDAC | DIRCNTL_SCC);
289 if (unlikely(iic_dc_wait(iic, DIRCNTL_MSC)))
291 res = (in_8(&iic->directcntl) & DIRCNTL_MSDA) ? -EREMOTEIO : 1;
295 out_8(&iic->directcntl, 0);
297 out_8(&iic->directcntl, DIRCNTL_SCC);
298 if (unlikely(iic_dc_wait(iic, DIRCNTL_MSC)))
301 out_8(&iic->directcntl, DIRCNTL_SDAC | DIRCNTL_SCC);
305 DBG("%d: smbus_quick -> %s\n", dev->idx, res ? "NACK" : "ACK");
308 out_8(&iic->xtcntlss, 0);
310 /* Reinitialize interface */
315 DBG("%d: smbus_quick - bus is stuck\n", dev->idx);
321 * IIC interrupt handler
323 static irqreturn_t iic_handler(int irq, void *dev_id)
325 struct ibm_iic_private* dev = (struct ibm_iic_private*)dev_id;
326 volatile struct iic_regs __iomem *iic = dev->vaddr;
328 DBG2("%d: irq handler, STS = 0x%02x, EXTSTS = 0x%02x\n",
329 dev->idx, in_8(&iic->sts), in_8(&iic->extsts));
331 /* Acknowledge IRQ and wakeup iic_wait_for_tc */
332 out_8(&iic->sts, STS_IRQA | STS_SCMP);
333 wake_up_interruptible(&dev->wq);
339 * Get master transfer result and clear errors if any.
340 * Returns the number of actually transferred bytes or error (<0)
342 static int iic_xfer_result(struct ibm_iic_private* dev)
344 volatile struct iic_regs __iomem *iic = dev->vaddr;
346 if (unlikely(in_8(&iic->sts) & STS_ERR)){
347 DBG("%d: xfer error, EXTSTS = 0x%02x\n", dev->idx,
350 /* Clear errors and possible pending IRQs */
351 out_8(&iic->extsts, EXTSTS_IRQP | EXTSTS_IRQD |
352 EXTSTS_LA | EXTSTS_ICT | EXTSTS_XFRA);
354 /* Flush master data buffer */
355 out_8(&iic->mdcntl, in_8(&iic->mdcntl) | MDCNTL_FMDB);
358 * If error happened during combined xfer
359 * IIC interface is usually stuck in some strange
360 * state, the only way out - soft reset.
362 if ((in_8(&iic->extsts) & EXTSTS_BCS_MASK) != EXTSTS_BCS_FREE){
363 DBG("%d: bus is stuck, resetting\n", dev->idx);
369 return in_8(&iic->xfrcnt) & XFRCNT_MTC_MASK;
373 * Try to abort active transfer.
375 static void iic_abort_xfer(struct ibm_iic_private* dev)
377 volatile struct iic_regs __iomem *iic = dev->vaddr;
380 DBG("%d: iic_abort_xfer\n", dev->idx);
382 out_8(&iic->cntl, CNTL_HMT);
385 * Wait for the abort command to complete.
386 * It's not worth to be optimized, just poll (timeout >= 1 tick)
389 while ((in_8(&iic->extsts) & EXTSTS_BCS_MASK) != EXTSTS_BCS_FREE){
390 if (time_after(jiffies, x)){
391 DBG("%d: abort timeout, resetting...\n", dev->idx);
398 /* Just to clear errors */
399 iic_xfer_result(dev);
403 * Wait for master transfer to complete.
404 * It puts current process to sleep until we get interrupt or timeout expires.
405 * Returns the number of transferred bytes or error (<0)
407 static int iic_wait_for_tc(struct ibm_iic_private* dev){
409 volatile struct iic_regs __iomem *iic = dev->vaddr;
414 ret = wait_event_interruptible_timeout(dev->wq,
415 !(in_8(&iic->sts) & STS_PT), dev->adap.timeout * HZ);
417 if (unlikely(ret < 0))
418 DBG("%d: wait interrupted\n", dev->idx);
419 else if (unlikely(in_8(&iic->sts) & STS_PT)){
420 DBG("%d: wait timeout\n", dev->idx);
426 unsigned long x = jiffies + dev->adap.timeout * HZ;
428 while (in_8(&iic->sts) & STS_PT){
429 if (unlikely(time_after(jiffies, x))){
430 DBG("%d: poll timeout\n", dev->idx);
435 if (unlikely(signal_pending(current))){
436 DBG("%d: poll interrupted\n", dev->idx);
444 if (unlikely(ret < 0))
447 ret = iic_xfer_result(dev);
449 DBG2("%d: iic_wait_for_tc -> %d\n", dev->idx, ret);
455 * Low level master transfer routine
457 static int iic_xfer_bytes(struct ibm_iic_private* dev, struct i2c_msg* pm,
460 volatile struct iic_regs __iomem *iic = dev->vaddr;
462 int i, j, loops, ret = 0;
465 u8 cntl = (in_8(&iic->cntl) & CNTL_AMD) | CNTL_PT;
466 if (pm->flags & I2C_M_RD)
469 loops = (len + 3) / 4;
470 for (i = 0; i < loops; ++i, len -= 4){
471 int count = len > 4 ? 4 : len;
472 u8 cmd = cntl | ((count - 1) << CNTL_TCT_SHIFT);
474 if (!(cntl & CNTL_RW))
475 for (j = 0; j < count; ++j)
476 out_8((void __iomem *)&iic->mdbuf, *buf++);
480 else if (combined_xfer)
483 DBG2("%d: xfer_bytes, %d, CNTL = 0x%02x\n", dev->idx, count, cmd);
486 out_8(&iic->cntl, cmd);
488 /* Wait for completion */
489 ret = iic_wait_for_tc(dev);
491 if (unlikely(ret < 0))
493 else if (unlikely(ret != count)){
494 DBG("%d: xfer_bytes, requested %d, transfered %d\n",
495 dev->idx, count, ret);
497 /* If it's not a last part of xfer, abort it */
498 if (combined_xfer || (i < loops - 1))
506 for (j = 0; j < count; ++j)
507 *buf++ = in_8((void __iomem *)&iic->mdbuf);
510 return ret > 0 ? 0 : ret;
514 * Set target slave address for master transfer
516 static inline void iic_address(struct ibm_iic_private* dev, struct i2c_msg* msg)
518 volatile struct iic_regs __iomem *iic = dev->vaddr;
519 u16 addr = msg->addr;
521 DBG2("%d: iic_address, 0x%03x (%d-bit)\n", dev->idx,
522 addr, msg->flags & I2C_M_TEN ? 10 : 7);
524 if (msg->flags & I2C_M_TEN){
525 out_8(&iic->cntl, CNTL_AMD);
526 out_8(&iic->lmadr, addr);
527 out_8(&iic->hmadr, 0xf0 | ((addr >> 7) & 0x06));
530 out_8(&iic->cntl, 0);
531 out_8(&iic->lmadr, addr << 1);
535 static inline int iic_invalid_address(const struct i2c_msg* p)
537 return (p->addr > 0x3ff) || (!(p->flags & I2C_M_TEN) && (p->addr > 0x7f));
540 static inline int iic_address_neq(const struct i2c_msg* p1,
541 const struct i2c_msg* p2)
543 return (p1->addr != p2->addr)
544 || ((p1->flags & I2C_M_TEN) != (p2->flags & I2C_M_TEN));
548 * Generic master transfer entrypoint.
549 * Returns the number of processed messages or error (<0)
551 static int iic_xfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
553 struct ibm_iic_private* dev = (struct ibm_iic_private*)(i2c_get_adapdata(adap));
554 volatile struct iic_regs __iomem *iic = dev->vaddr;
557 DBG2("%d: iic_xfer, %d msg(s)\n", dev->idx, num);
562 /* Check the sanity of the passed messages.
563 * Uhh, generic i2c layer is more suitable place for such code...
565 if (unlikely(iic_invalid_address(&msgs[0]))){
566 DBG("%d: invalid address 0x%03x (%d-bit)\n", dev->idx,
567 msgs[0].addr, msgs[0].flags & I2C_M_TEN ? 10 : 7);
570 for (i = 0; i < num; ++i){
571 if (unlikely(msgs[i].len <= 0)){
572 if (num == 1 && !msgs[0].len){
573 /* Special case for I2C_SMBUS_QUICK emulation.
574 * IBM IIC doesn't support 0-length transactions
575 * so we have to emulate them using bit-banging.
577 return iic_smbus_quick(dev, &msgs[0]);
579 DBG("%d: invalid len %d in msg[%d]\n", dev->idx,
583 if (unlikely(iic_address_neq(&msgs[0], &msgs[i]))){
584 DBG("%d: invalid addr in msg[%d]\n", dev->idx, i);
589 /* Check bus state */
590 if (unlikely((in_8(&iic->extsts) & EXTSTS_BCS_MASK) != EXTSTS_BCS_FREE)){
591 DBG("%d: iic_xfer, bus is not free\n", dev->idx);
593 /* Usually it means something serious has happend.
594 * We *cannot* have unfinished previous transfer
595 * so it doesn't make any sense to try to stop it.
596 * Probably we were not able to recover from the
598 * The only *reasonable* thing I can think of here
599 * is soft reset. --ebs
603 if ((in_8(&iic->extsts) & EXTSTS_BCS_MASK) != EXTSTS_BCS_FREE){
604 DBG("%d: iic_xfer, bus is still not free\n", dev->idx);
609 /* Flush master data buffer (just in case) */
610 out_8(&iic->mdcntl, in_8(&iic->mdcntl) | MDCNTL_FMDB);
613 /* Load slave address */
614 iic_address(dev, &msgs[0]);
616 /* Do real transfer */
617 for (i = 0; i < num && !ret; ++i)
618 ret = iic_xfer_bytes(dev, &msgs[i], i < num - 1);
620 return ret < 0 ? ret : num;
623 static u32 iic_func(struct i2c_adapter *adap)
625 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL | I2C_FUNC_10BIT_ADDR;
628 static const struct i2c_algorithm iic_algo = {
629 .master_xfer = iic_xfer,
630 .functionality = iic_func
634 * Calculates IICx_CLCKDIV value for a specific OPB clock frequency
636 static inline u8 iic_clckdiv(unsigned int opb)
638 /* Compatibility kludge, should go away after all cards
639 * are fixed to fill correct value for opbfreq.
640 * Previous driver version used hardcoded divider value 4,
641 * it corresponds to OPB frequency from the range (40, 50] MHz
644 printk(KERN_WARNING "ibm-iic: using compatibility value for OPB freq,"
645 " fix your board specific setup\n");
652 if (opb < 20 || opb > 150){
653 printk(KERN_CRIT "ibm-iic: invalid OPB clock frequency %u MHz\n",
655 opb = opb < 20 ? 20 : 150;
657 return (u8)((opb + 9) / 10 - 1);
661 * Register single IIC interface
663 static int __devinit iic_probe(struct ocp_device *ocp){
665 struct ibm_iic_private* dev;
666 struct i2c_adapter* adap;
667 struct ocp_func_iic_data* iic_data = ocp->def->additions;
671 printk(KERN_WARNING"ibm-iic%d: missing additional data!\n",
674 if (!(dev = kzalloc(sizeof(*dev), GFP_KERNEL))) {
675 printk(KERN_CRIT "ibm-iic%d: failed to allocate device data\n",
680 dev->idx = ocp->def->index;
681 ocp_set_drvdata(ocp, dev);
683 if (!request_mem_region(ocp->def->paddr, sizeof(struct iic_regs),
689 if (!(dev->vaddr = ioremap(ocp->def->paddr, sizeof(struct iic_regs)))){
690 printk(KERN_CRIT "ibm-iic%d: failed to ioremap device registers\n",
696 init_waitqueue_head(&dev->wq);
698 dev->irq = iic_force_poll ? -1 : ocp->def->irq;
700 /* Disable interrupts until we finish initialization,
701 assumes level-sensitive IRQ setup...
703 iic_interrupt_mode(dev, 0);
704 if (request_irq(dev->irq, iic_handler, 0, "IBM IIC", dev)){
705 printk(KERN_ERR "ibm-iic%d: request_irq %d failed\n",
707 /* Fallback to the polling mode */
713 printk(KERN_WARNING "ibm-iic%d: using polling mode\n",
716 /* Board specific settings */
717 dev->fast_mode = iic_force_fast ? 1 : (iic_data ? iic_data->fast_mode : 0);
719 /* clckdiv is the same for *all* IIC interfaces,
720 * but I'd rather make a copy than introduce another global. --ebs
722 dev->clckdiv = iic_clckdiv(ocp_sys_info.opb_bus_freq);
723 DBG("%d: clckdiv = %d\n", dev->idx, dev->clckdiv);
725 /* Initialize IIC interface */
728 /* Register it with i2c layer */
730 adap->dev.parent = &ocp->dev;
731 strcpy(adap->name, "IBM IIC");
732 i2c_set_adapdata(adap, dev);
733 adap->id = I2C_HW_OCP;
734 adap->class = I2C_CLASS_HWMON;
735 adap->algo = &iic_algo;
736 adap->client_register = NULL;
737 adap->client_unregister = NULL;
741 * If "dev->idx" is negative we consider it as zero.
742 * The reason to do so is to avoid sysfs names that only make
743 * sense when there are multiple adapters.
745 adap->nr = dev->idx >= 0 ? dev->idx : 0;
747 if ((ret = i2c_add_numbered_adapter(adap)) < 0) {
748 printk(KERN_CRIT "ibm-iic%d: failed to register i2c adapter\n",
753 printk(KERN_INFO "ibm-iic%d: using %s mode\n", dev->idx,
754 dev->fast_mode ? "fast (400 kHz)" : "standard (100 kHz)");
760 iic_interrupt_mode(dev, 0);
761 free_irq(dev->irq, dev);
766 release_mem_region(ocp->def->paddr, sizeof(struct iic_regs));
768 ocp_set_drvdata(ocp, NULL);
774 * Cleanup initialized IIC interface
776 static void __devexit iic_remove(struct ocp_device *ocp)
778 struct ibm_iic_private* dev = (struct ibm_iic_private*)ocp_get_drvdata(ocp);
780 if (i2c_del_adapter(&dev->adap)){
781 printk(KERN_CRIT "ibm-iic%d: failed to delete i2c adapter :(\n",
783 /* That's *very* bad, just shutdown IRQ ... */
785 iic_interrupt_mode(dev, 0);
786 free_irq(dev->irq, dev);
791 iic_interrupt_mode(dev, 0);
792 free_irq(dev->irq, dev);
795 release_mem_region(ocp->def->paddr, sizeof(struct iic_regs));
800 static struct ocp_device_id ibm_iic_ids[] __devinitdata =
802 { .vendor = OCP_VENDOR_IBM, .function = OCP_FUNC_IIC },
803 { .vendor = OCP_VENDOR_INVALID }
806 MODULE_DEVICE_TABLE(ocp, ibm_iic_ids);
808 static struct ocp_driver ibm_iic_driver =
811 .id_table = ibm_iic_ids,
813 .remove = __devexit_p(iic_remove),
814 #if defined(CONFIG_PM)
820 static int __init iic_init(void)
822 printk(KERN_INFO "IBM IIC driver v" DRIVER_VERSION "\n");
823 return ocp_register_driver(&ibm_iic_driver);
826 static void __exit iic_exit(void)
828 ocp_unregister_driver(&ibm_iic_driver);
831 module_init(iic_init);
832 module_exit(iic_exit);