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/of_address.h>
45 #include <linux/of_irq.h>
46 #include <linux/of_platform.h>
48 #include "i2c-ibm_iic.h"
50 #define DRIVER_VERSION "2.2"
52 MODULE_DESCRIPTION("IBM IIC driver v" DRIVER_VERSION
);
53 MODULE_LICENSE("GPL");
55 static bool iic_force_poll
;
56 module_param(iic_force_poll
, bool, 0);
57 MODULE_PARM_DESC(iic_force_poll
, "Force polling mode");
59 static bool iic_force_fast
;
60 module_param(iic_force_fast
, bool, 0);
61 MODULE_PARM_DESC(iic_force_fast
, "Force fast mode (400 kHz)");
74 # define DBG(f,x...) printk(KERN_DEBUG "ibm-iic" f, ##x)
76 # define DBG(f,x...) ((void)0)
79 # define DBG2(f,x...) DBG(f, ##x)
81 # define DBG2(f,x...) ((void)0)
84 static void dump_iic_regs(const char* header
, struct ibm_iic_private
* dev
)
86 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
87 printk(KERN_DEBUG
"ibm-iic%d: %s\n", dev
->idx
, header
);
89 " cntl = 0x%02x, mdcntl = 0x%02x\n"
90 " sts = 0x%02x, extsts = 0x%02x\n"
91 " clkdiv = 0x%02x, xfrcnt = 0x%02x\n"
92 " xtcntlss = 0x%02x, directcntl = 0x%02x\n",
93 in_8(&iic
->cntl
), in_8(&iic
->mdcntl
), in_8(&iic
->sts
),
94 in_8(&iic
->extsts
), in_8(&iic
->clkdiv
), in_8(&iic
->xfrcnt
),
95 in_8(&iic
->xtcntlss
), in_8(&iic
->directcntl
));
97 # define DUMP_REGS(h,dev) dump_iic_regs((h),(dev))
99 # define DUMP_REGS(h,dev) ((void)0)
102 /* Bus timings (in ns) for bit-banging */
103 static struct i2c_timings
{
110 /* Standard mode (100 KHz) */
118 /* Fast mode (400 KHz) */
127 /* Enable/disable interrupt generation */
128 static inline void iic_interrupt_mode(struct ibm_iic_private
* dev
, int enable
)
130 out_8(&dev
->vaddr
->intmsk
, enable
? INTRMSK_EIMTC
: 0);
134 * Initialize IIC interface.
136 static void iic_dev_init(struct ibm_iic_private
* dev
)
138 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
140 DBG("%d: init\n", dev
->idx
);
142 /* Clear master address */
143 out_8(&iic
->lmadr
, 0);
144 out_8(&iic
->hmadr
, 0);
146 /* Clear slave address */
147 out_8(&iic
->lsadr
, 0);
148 out_8(&iic
->hsadr
, 0);
150 /* Clear status & extended status */
151 out_8(&iic
->sts
, STS_SCMP
| STS_IRQA
);
152 out_8(&iic
->extsts
, EXTSTS_IRQP
| EXTSTS_IRQD
| EXTSTS_LA
153 | EXTSTS_ICT
| EXTSTS_XFRA
);
155 /* Set clock divider */
156 out_8(&iic
->clkdiv
, dev
->clckdiv
);
158 /* Clear transfer count */
159 out_8(&iic
->xfrcnt
, 0);
161 /* Clear extended control and status */
162 out_8(&iic
->xtcntlss
, XTCNTLSS_SRC
| XTCNTLSS_SRS
| XTCNTLSS_SWC
165 /* Clear control register */
166 out_8(&iic
->cntl
, 0);
168 /* Enable interrupts if possible */
169 iic_interrupt_mode(dev
, dev
->irq
>= 0);
171 /* Set mode control */
172 out_8(&iic
->mdcntl
, MDCNTL_FMDB
| MDCNTL_EINT
| MDCNTL_EUBS
173 | (dev
->fast_mode
? MDCNTL_FSM
: 0));
175 DUMP_REGS("iic_init", dev
);
179 * Reset IIC interface
181 static void iic_dev_reset(struct ibm_iic_private
* dev
)
183 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
187 DBG("%d: soft reset\n", dev
->idx
);
188 DUMP_REGS("reset", dev
);
190 /* Place chip in the reset state */
191 out_8(&iic
->xtcntlss
, XTCNTLSS_SRST
);
193 /* Check if bus is free */
194 dc
= in_8(&iic
->directcntl
);
195 if (!DIRCTNL_FREE(dc
)){
196 DBG("%d: trying to regain bus control\n", dev
->idx
);
198 /* Try to set bus free state */
199 out_8(&iic
->directcntl
, DIRCNTL_SDAC
| DIRCNTL_SCC
);
201 /* Wait until we regain bus control */
202 for (i
= 0; i
< 100; ++i
){
203 dc
= in_8(&iic
->directcntl
);
204 if (DIRCTNL_FREE(dc
))
207 /* Toggle SCL line */
209 out_8(&iic
->directcntl
, dc
);
212 out_8(&iic
->directcntl
, dc
);
220 out_8(&iic
->xtcntlss
, 0);
222 /* Reinitialize interface */
227 * Do 0-length transaction using bit-banging through IIC_DIRECTCNTL register.
230 /* Wait for SCL and/or SDA to be high */
231 static int iic_dc_wait(volatile struct iic_regs __iomem
*iic
, u8 mask
)
233 unsigned long x
= jiffies
+ HZ
/ 28 + 2;
234 while ((in_8(&iic
->directcntl
) & mask
) != mask
){
235 if (unlikely(time_after(jiffies
, x
)))
242 static int iic_smbus_quick(struct ibm_iic_private
* dev
, const struct i2c_msg
* p
)
244 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
245 const struct i2c_timings
* t
= &timings
[dev
->fast_mode
? 1 : 0];
249 /* Only 7-bit addresses are supported */
250 if (unlikely(p
->flags
& I2C_M_TEN
)){
251 DBG("%d: smbus_quick - 10 bit addresses are not supported\n",
256 DBG("%d: smbus_quick(0x%02x)\n", dev
->idx
, p
->addr
);
258 /* Reset IIC interface */
259 out_8(&iic
->xtcntlss
, XTCNTLSS_SRST
);
261 /* Wait for bus to become free */
262 out_8(&iic
->directcntl
, DIRCNTL_SDAC
| DIRCNTL_SCC
);
263 if (unlikely(iic_dc_wait(iic
, DIRCNTL_MSDA
| DIRCNTL_MSC
)))
268 out_8(&iic
->directcntl
, DIRCNTL_SCC
);
273 v
= (u8
)((p
->addr
<< 1) | ((p
->flags
& I2C_M_RD
) ? 1 : 0));
274 for (i
= 0, mask
= 0x80; i
< 8; ++i
, mask
>>= 1){
275 out_8(&iic
->directcntl
, sda
);
277 sda
= (v
& mask
) ? DIRCNTL_SDAC
: 0;
278 out_8(&iic
->directcntl
, sda
);
281 out_8(&iic
->directcntl
, DIRCNTL_SCC
| sda
);
282 if (unlikely(iic_dc_wait(iic
, DIRCNTL_MSC
)))
288 out_8(&iic
->directcntl
, sda
);
290 out_8(&iic
->directcntl
, DIRCNTL_SDAC
);
292 out_8(&iic
->directcntl
, DIRCNTL_SDAC
| DIRCNTL_SCC
);
293 if (unlikely(iic_dc_wait(iic
, DIRCNTL_MSC
)))
295 res
= (in_8(&iic
->directcntl
) & DIRCNTL_MSDA
) ? -EREMOTEIO
: 1;
299 out_8(&iic
->directcntl
, 0);
301 out_8(&iic
->directcntl
, DIRCNTL_SCC
);
302 if (unlikely(iic_dc_wait(iic
, DIRCNTL_MSC
)))
305 out_8(&iic
->directcntl
, DIRCNTL_SDAC
| DIRCNTL_SCC
);
309 DBG("%d: smbus_quick -> %s\n", dev
->idx
, res
? "NACK" : "ACK");
312 out_8(&iic
->xtcntlss
, 0);
314 /* Reinitialize interface */
319 DBG("%d: smbus_quick - bus is stuck\n", dev
->idx
);
325 * IIC interrupt handler
327 static irqreturn_t
iic_handler(int irq
, void *dev_id
)
329 struct ibm_iic_private
* dev
= (struct ibm_iic_private
*)dev_id
;
330 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
332 DBG2("%d: irq handler, STS = 0x%02x, EXTSTS = 0x%02x\n",
333 dev
->idx
, in_8(&iic
->sts
), in_8(&iic
->extsts
));
335 /* Acknowledge IRQ and wakeup iic_wait_for_tc */
336 out_8(&iic
->sts
, STS_IRQA
| STS_SCMP
);
337 wake_up_interruptible(&dev
->wq
);
343 * Get master transfer result and clear errors if any.
344 * Returns the number of actually transferred bytes or error (<0)
346 static int iic_xfer_result(struct ibm_iic_private
* dev
)
348 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
350 if (unlikely(in_8(&iic
->sts
) & STS_ERR
)){
351 DBG("%d: xfer error, EXTSTS = 0x%02x\n", dev
->idx
,
354 /* Clear errors and possible pending IRQs */
355 out_8(&iic
->extsts
, EXTSTS_IRQP
| EXTSTS_IRQD
|
356 EXTSTS_LA
| EXTSTS_ICT
| EXTSTS_XFRA
);
358 /* Flush master data buffer */
359 out_8(&iic
->mdcntl
, in_8(&iic
->mdcntl
) | MDCNTL_FMDB
);
362 * If error happened during combined xfer
363 * IIC interface is usually stuck in some strange
364 * state, the only way out - soft reset.
366 if ((in_8(&iic
->extsts
) & EXTSTS_BCS_MASK
) != EXTSTS_BCS_FREE
){
367 DBG("%d: bus is stuck, resetting\n", dev
->idx
);
373 return in_8(&iic
->xfrcnt
) & XFRCNT_MTC_MASK
;
377 * Try to abort active transfer.
379 static void iic_abort_xfer(struct ibm_iic_private
* dev
)
381 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
384 DBG("%d: iic_abort_xfer\n", dev
->idx
);
386 out_8(&iic
->cntl
, CNTL_HMT
);
389 * Wait for the abort command to complete.
390 * It's not worth to be optimized, just poll (timeout >= 1 tick)
393 while ((in_8(&iic
->extsts
) & EXTSTS_BCS_MASK
) != EXTSTS_BCS_FREE
){
394 if (time_after(jiffies
, x
)){
395 DBG("%d: abort timeout, resetting...\n", dev
->idx
);
402 /* Just to clear errors */
403 iic_xfer_result(dev
);
407 * Wait for master transfer to complete.
408 * It puts current process to sleep until we get interrupt or timeout expires.
409 * Returns the number of transferred bytes or error (<0)
411 static int iic_wait_for_tc(struct ibm_iic_private
* dev
){
413 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
418 ret
= wait_event_interruptible_timeout(dev
->wq
,
419 !(in_8(&iic
->sts
) & STS_PT
), dev
->adap
.timeout
);
421 if (unlikely(ret
< 0))
422 DBG("%d: wait interrupted\n", dev
->idx
);
423 else if (unlikely(in_8(&iic
->sts
) & STS_PT
)){
424 DBG("%d: wait timeout\n", dev
->idx
);
430 unsigned long x
= jiffies
+ dev
->adap
.timeout
;
432 while (in_8(&iic
->sts
) & STS_PT
){
433 if (unlikely(time_after(jiffies
, x
))){
434 DBG("%d: poll timeout\n", dev
->idx
);
439 if (unlikely(signal_pending(current
))){
440 DBG("%d: poll interrupted\n", dev
->idx
);
448 if (unlikely(ret
< 0))
451 ret
= iic_xfer_result(dev
);
453 DBG2("%d: iic_wait_for_tc -> %d\n", dev
->idx
, ret
);
459 * Low level master transfer routine
461 static int iic_xfer_bytes(struct ibm_iic_private
* dev
, struct i2c_msg
* pm
,
464 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
466 int i
, j
, loops
, ret
= 0;
469 u8 cntl
= (in_8(&iic
->cntl
) & CNTL_AMD
) | CNTL_PT
;
470 if (pm
->flags
& I2C_M_RD
)
473 loops
= (len
+ 3) / 4;
474 for (i
= 0; i
< loops
; ++i
, len
-= 4){
475 int count
= len
> 4 ? 4 : len
;
476 u8 cmd
= cntl
| ((count
- 1) << CNTL_TCT_SHIFT
);
478 if (!(cntl
& CNTL_RW
))
479 for (j
= 0; j
< count
; ++j
)
480 out_8((void __iomem
*)&iic
->mdbuf
, *buf
++);
484 else if (combined_xfer
)
487 DBG2("%d: xfer_bytes, %d, CNTL = 0x%02x\n", dev
->idx
, count
, cmd
);
490 out_8(&iic
->cntl
, cmd
);
492 /* Wait for completion */
493 ret
= iic_wait_for_tc(dev
);
495 if (unlikely(ret
< 0))
497 else if (unlikely(ret
!= count
)){
498 DBG("%d: xfer_bytes, requested %d, transferred %d\n",
499 dev
->idx
, count
, ret
);
501 /* If it's not a last part of xfer, abort it */
502 if (combined_xfer
|| (i
< loops
- 1))
510 for (j
= 0; j
< count
; ++j
)
511 *buf
++ = in_8((void __iomem
*)&iic
->mdbuf
);
514 return ret
> 0 ? 0 : ret
;
518 * Set target slave address for master transfer
520 static inline void iic_address(struct ibm_iic_private
* dev
, struct i2c_msg
* msg
)
522 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
523 u16 addr
= msg
->addr
;
525 DBG2("%d: iic_address, 0x%03x (%d-bit)\n", dev
->idx
,
526 addr
, msg
->flags
& I2C_M_TEN
? 10 : 7);
528 if (msg
->flags
& I2C_M_TEN
){
529 out_8(&iic
->cntl
, CNTL_AMD
);
530 out_8(&iic
->lmadr
, addr
);
531 out_8(&iic
->hmadr
, 0xf0 | ((addr
>> 7) & 0x06));
534 out_8(&iic
->cntl
, 0);
535 out_8(&iic
->lmadr
, addr
<< 1);
539 static inline int iic_invalid_address(const struct i2c_msg
* p
)
541 return (p
->addr
> 0x3ff) || (!(p
->flags
& I2C_M_TEN
) && (p
->addr
> 0x7f));
544 static inline int iic_address_neq(const struct i2c_msg
* p1
,
545 const struct i2c_msg
* p2
)
547 return (p1
->addr
!= p2
->addr
)
548 || ((p1
->flags
& I2C_M_TEN
) != (p2
->flags
& I2C_M_TEN
));
552 * Generic master transfer entrypoint.
553 * Returns the number of processed messages or error (<0)
555 static int iic_xfer(struct i2c_adapter
*adap
, struct i2c_msg
*msgs
, int num
)
557 struct ibm_iic_private
* dev
= (struct ibm_iic_private
*)(i2c_get_adapdata(adap
));
558 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
561 DBG2("%d: iic_xfer, %d msg(s)\n", dev
->idx
, num
);
566 /* Check the sanity of the passed messages.
567 * Uhh, generic i2c layer is more suitable place for such code...
569 if (unlikely(iic_invalid_address(&msgs
[0]))){
570 DBG("%d: invalid address 0x%03x (%d-bit)\n", dev
->idx
,
571 msgs
[0].addr
, msgs
[0].flags
& I2C_M_TEN
? 10 : 7);
574 for (i
= 0; i
< num
; ++i
){
575 if (unlikely(msgs
[i
].len
<= 0)){
576 if (num
== 1 && !msgs
[0].len
){
577 /* Special case for I2C_SMBUS_QUICK emulation.
578 * IBM IIC doesn't support 0-length transactions
579 * so we have to emulate them using bit-banging.
581 return iic_smbus_quick(dev
, &msgs
[0]);
583 DBG("%d: invalid len %d in msg[%d]\n", dev
->idx
,
587 if (unlikely(iic_address_neq(&msgs
[0], &msgs
[i
]))){
588 DBG("%d: invalid addr in msg[%d]\n", dev
->idx
, i
);
593 /* Check bus state */
594 if (unlikely((in_8(&iic
->extsts
) & EXTSTS_BCS_MASK
) != EXTSTS_BCS_FREE
)){
595 DBG("%d: iic_xfer, bus is not free\n", dev
->idx
);
597 /* Usually it means something serious has happened.
598 * We *cannot* have unfinished previous transfer
599 * so it doesn't make any sense to try to stop it.
600 * Probably we were not able to recover from the
602 * The only *reasonable* thing I can think of here
603 * is soft reset. --ebs
607 if ((in_8(&iic
->extsts
) & EXTSTS_BCS_MASK
) != EXTSTS_BCS_FREE
){
608 DBG("%d: iic_xfer, bus is still not free\n", dev
->idx
);
613 /* Flush master data buffer (just in case) */
614 out_8(&iic
->mdcntl
, in_8(&iic
->mdcntl
) | MDCNTL_FMDB
);
617 /* Load slave address */
618 iic_address(dev
, &msgs
[0]);
620 /* Do real transfer */
621 for (i
= 0; i
< num
&& !ret
; ++i
)
622 ret
= iic_xfer_bytes(dev
, &msgs
[i
], i
< num
- 1);
624 return ret
< 0 ? ret
: num
;
627 static u32
iic_func(struct i2c_adapter
*adap
)
629 return I2C_FUNC_I2C
| I2C_FUNC_SMBUS_EMUL
| I2C_FUNC_10BIT_ADDR
;
632 static const struct i2c_algorithm iic_algo
= {
633 .master_xfer
= iic_xfer
,
634 .functionality
= iic_func
638 * Calculates IICx_CLCKDIV value for a specific OPB clock frequency
640 static inline u8
iic_clckdiv(unsigned int opb
)
642 /* Compatibility kludge, should go away after all cards
643 * are fixed to fill correct value for opbfreq.
644 * Previous driver version used hardcoded divider value 4,
645 * it corresponds to OPB frequency from the range (40, 50] MHz
648 printk(KERN_WARNING
"ibm-iic: using compatibility value for OPB freq,"
649 " fix your board specific setup\n");
656 if (opb
< 20 || opb
> 150){
657 printk(KERN_WARNING
"ibm-iic: invalid OPB clock frequency %u MHz\n",
659 opb
= opb
< 20 ? 20 : 150;
661 return (u8
)((opb
+ 9) / 10 - 1);
664 static int iic_request_irq(struct platform_device
*ofdev
,
665 struct ibm_iic_private
*dev
)
667 struct device_node
*np
= ofdev
->dev
.of_node
;
673 irq
= irq_of_parse_and_map(np
, 0);
675 dev_err(&ofdev
->dev
, "irq_of_parse_and_map failed\n");
679 /* Disable interrupts until we finish initialization, assumes
680 * level-sensitive IRQ setup...
682 iic_interrupt_mode(dev
, 0);
683 if (request_irq(irq
, iic_handler
, 0, "IBM IIC", dev
)) {
684 dev_err(&ofdev
->dev
, "request_irq %d failed\n", irq
);
685 /* Fallback to the polling mode */
693 * Register single IIC interface
695 static int iic_probe(struct platform_device
*ofdev
)
697 struct device_node
*np
= ofdev
->dev
.of_node
;
698 struct ibm_iic_private
*dev
;
699 struct i2c_adapter
*adap
;
703 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
705 dev_err(&ofdev
->dev
, "failed to allocate device data\n");
709 platform_set_drvdata(ofdev
, dev
);
711 dev
->vaddr
= of_iomap(np
, 0);
712 if (dev
->vaddr
== NULL
) {
713 dev_err(&ofdev
->dev
, "failed to iomap device\n");
718 init_waitqueue_head(&dev
->wq
);
720 dev
->irq
= iic_request_irq(ofdev
, dev
);
722 dev_warn(&ofdev
->dev
, "using polling mode\n");
724 /* Board specific settings */
725 if (iic_force_fast
|| of_get_property(np
, "fast-mode", NULL
))
728 freq
= of_get_property(np
, "clock-frequency", NULL
);
730 freq
= of_get_property(np
->parent
, "clock-frequency", NULL
);
732 dev_err(&ofdev
->dev
, "Unable to get bus frequency\n");
738 dev
->clckdiv
= iic_clckdiv(*freq
);
739 dev_dbg(&ofdev
->dev
, "clckdiv = %d\n", dev
->clckdiv
);
741 /* Initialize IIC interface */
744 /* Register it with i2c layer */
746 adap
->dev
.parent
= &ofdev
->dev
;
747 adap
->dev
.of_node
= of_node_get(np
);
748 strlcpy(adap
->name
, "IBM IIC", sizeof(adap
->name
));
749 i2c_set_adapdata(adap
, dev
);
750 adap
->class = I2C_CLASS_HWMON
| I2C_CLASS_SPD
;
751 adap
->algo
= &iic_algo
;
754 ret
= i2c_add_adapter(adap
);
756 dev_err(&ofdev
->dev
, "failed to register i2c adapter\n");
760 dev_info(&ofdev
->dev
, "using %s mode\n",
761 dev
->fast_mode
? "fast (400 kHz)" : "standard (100 kHz)");
767 iic_interrupt_mode(dev
, 0);
768 free_irq(dev
->irq
, dev
);
779 * Cleanup initialized IIC interface
781 static int iic_remove(struct platform_device
*ofdev
)
783 struct ibm_iic_private
*dev
= platform_get_drvdata(ofdev
);
785 i2c_del_adapter(&dev
->adap
);
788 iic_interrupt_mode(dev
, 0);
789 free_irq(dev
->irq
, dev
);
798 static const struct of_device_id ibm_iic_match
[] = {
799 { .compatible
= "ibm,iic", },
803 static struct platform_driver ibm_iic_driver
= {
806 .owner
= THIS_MODULE
,
807 .of_match_table
= ibm_iic_match
,
810 .remove
= iic_remove
,
813 module_platform_driver(ibm_iic_driver
);