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/interrupt.h>
40 #include <linux/sched/signal.h>
44 #include <linux/i2c.h>
45 #include <linux/of_address.h>
46 #include <linux/of_irq.h>
47 #include <linux/of_platform.h>
49 #include "i2c-ibm_iic.h"
51 #define DRIVER_VERSION "2.2"
53 MODULE_DESCRIPTION("IBM IIC driver v" DRIVER_VERSION
);
54 MODULE_LICENSE("GPL");
56 static bool iic_force_poll
;
57 module_param(iic_force_poll
, bool, 0);
58 MODULE_PARM_DESC(iic_force_poll
, "Force polling mode");
60 static bool iic_force_fast
;
61 module_param(iic_force_fast
, bool, 0);
62 MODULE_PARM_DESC(iic_force_fast
, "Force fast mode (400 kHz)");
75 # define DBG(f,x...) printk(KERN_DEBUG "ibm-iic" f, ##x)
77 # define DBG(f,x...) ((void)0)
80 # define DBG2(f,x...) DBG(f, ##x)
82 # define DBG2(f,x...) ((void)0)
85 static void dump_iic_regs(const char* header
, struct ibm_iic_private
* dev
)
87 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
88 printk(KERN_DEBUG
"ibm-iic%d: %s\n", dev
->idx
, header
);
90 " cntl = 0x%02x, mdcntl = 0x%02x\n"
91 " sts = 0x%02x, extsts = 0x%02x\n"
92 " clkdiv = 0x%02x, xfrcnt = 0x%02x\n"
93 " xtcntlss = 0x%02x, directcntl = 0x%02x\n",
94 in_8(&iic
->cntl
), in_8(&iic
->mdcntl
), in_8(&iic
->sts
),
95 in_8(&iic
->extsts
), in_8(&iic
->clkdiv
), in_8(&iic
->xfrcnt
),
96 in_8(&iic
->xtcntlss
), in_8(&iic
->directcntl
));
98 # define DUMP_REGS(h,dev) dump_iic_regs((h),(dev))
100 # define DUMP_REGS(h,dev) ((void)0)
103 /* Bus timings (in ns) for bit-banging */
104 static struct ibm_iic_timings
{
111 /* Standard mode (100 KHz) */
119 /* Fast mode (400 KHz) */
128 /* Enable/disable interrupt generation */
129 static inline void iic_interrupt_mode(struct ibm_iic_private
* dev
, int enable
)
131 out_8(&dev
->vaddr
->intmsk
, enable
? INTRMSK_EIMTC
: 0);
135 * Initialize IIC interface.
137 static void iic_dev_init(struct ibm_iic_private
* dev
)
139 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
141 DBG("%d: init\n", dev
->idx
);
143 /* Clear master address */
144 out_8(&iic
->lmadr
, 0);
145 out_8(&iic
->hmadr
, 0);
147 /* Clear slave address */
148 out_8(&iic
->lsadr
, 0);
149 out_8(&iic
->hsadr
, 0);
151 /* Clear status & extended status */
152 out_8(&iic
->sts
, STS_SCMP
| STS_IRQA
);
153 out_8(&iic
->extsts
, EXTSTS_IRQP
| EXTSTS_IRQD
| EXTSTS_LA
154 | EXTSTS_ICT
| EXTSTS_XFRA
);
156 /* Set clock divider */
157 out_8(&iic
->clkdiv
, dev
->clckdiv
);
159 /* Clear transfer count */
160 out_8(&iic
->xfrcnt
, 0);
162 /* Clear extended control and status */
163 out_8(&iic
->xtcntlss
, XTCNTLSS_SRC
| XTCNTLSS_SRS
| XTCNTLSS_SWC
166 /* Clear control register */
167 out_8(&iic
->cntl
, 0);
169 /* Enable interrupts if possible */
170 iic_interrupt_mode(dev
, dev
->irq
>= 0);
172 /* Set mode control */
173 out_8(&iic
->mdcntl
, MDCNTL_FMDB
| MDCNTL_EINT
| MDCNTL_EUBS
174 | (dev
->fast_mode
? MDCNTL_FSM
: 0));
176 DUMP_REGS("iic_init", dev
);
180 * Reset IIC interface
182 static void iic_dev_reset(struct ibm_iic_private
* dev
)
184 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
188 DBG("%d: soft reset\n", dev
->idx
);
189 DUMP_REGS("reset", dev
);
191 /* Place chip in the reset state */
192 out_8(&iic
->xtcntlss
, XTCNTLSS_SRST
);
194 /* Check if bus is free */
195 dc
= in_8(&iic
->directcntl
);
196 if (!DIRCTNL_FREE(dc
)){
197 DBG("%d: trying to regain bus control\n", dev
->idx
);
199 /* Try to set bus free state */
200 out_8(&iic
->directcntl
, DIRCNTL_SDAC
| DIRCNTL_SCC
);
202 /* Wait until we regain bus control */
203 for (i
= 0; i
< 100; ++i
){
204 dc
= in_8(&iic
->directcntl
);
205 if (DIRCTNL_FREE(dc
))
208 /* Toggle SCL line */
210 out_8(&iic
->directcntl
, dc
);
213 out_8(&iic
->directcntl
, dc
);
221 out_8(&iic
->xtcntlss
, 0);
223 /* Reinitialize interface */
228 * Do 0-length transaction using bit-banging through IIC_DIRECTCNTL register.
231 /* Wait for SCL and/or SDA to be high */
232 static int iic_dc_wait(volatile struct iic_regs __iomem
*iic
, u8 mask
)
234 unsigned long x
= jiffies
+ HZ
/ 28 + 2;
235 while ((in_8(&iic
->directcntl
) & mask
) != mask
){
236 if (unlikely(time_after(jiffies
, x
)))
243 static int iic_smbus_quick(struct ibm_iic_private
* dev
, const struct i2c_msg
* p
)
245 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
246 const struct ibm_iic_timings
*t
= &timings
[dev
->fast_mode
? 1 : 0];
250 /* Only 7-bit addresses are supported */
251 if (unlikely(p
->flags
& I2C_M_TEN
)){
252 DBG("%d: smbus_quick - 10 bit addresses are not supported\n",
257 DBG("%d: smbus_quick(0x%02x)\n", dev
->idx
, p
->addr
);
259 /* Reset IIC interface */
260 out_8(&iic
->xtcntlss
, XTCNTLSS_SRST
);
262 /* Wait for bus to become free */
263 out_8(&iic
->directcntl
, DIRCNTL_SDAC
| DIRCNTL_SCC
);
264 if (unlikely(iic_dc_wait(iic
, DIRCNTL_MSDA
| DIRCNTL_MSC
)))
269 out_8(&iic
->directcntl
, DIRCNTL_SCC
);
274 v
= i2c_8bit_addr_from_msg(p
);
275 for (i
= 0, mask
= 0x80; i
< 8; ++i
, mask
>>= 1){
276 out_8(&iic
->directcntl
, sda
);
278 sda
= (v
& mask
) ? DIRCNTL_SDAC
: 0;
279 out_8(&iic
->directcntl
, sda
);
282 out_8(&iic
->directcntl
, DIRCNTL_SCC
| sda
);
283 if (unlikely(iic_dc_wait(iic
, DIRCNTL_MSC
)))
289 out_8(&iic
->directcntl
, sda
);
291 out_8(&iic
->directcntl
, DIRCNTL_SDAC
);
293 out_8(&iic
->directcntl
, DIRCNTL_SDAC
| DIRCNTL_SCC
);
294 if (unlikely(iic_dc_wait(iic
, DIRCNTL_MSC
)))
296 res
= (in_8(&iic
->directcntl
) & DIRCNTL_MSDA
) ? -EREMOTEIO
: 1;
300 out_8(&iic
->directcntl
, 0);
302 out_8(&iic
->directcntl
, DIRCNTL_SCC
);
303 if (unlikely(iic_dc_wait(iic
, DIRCNTL_MSC
)))
306 out_8(&iic
->directcntl
, DIRCNTL_SDAC
| DIRCNTL_SCC
);
310 DBG("%d: smbus_quick -> %s\n", dev
->idx
, res
? "NACK" : "ACK");
313 out_8(&iic
->xtcntlss
, 0);
315 /* Reinitialize interface */
320 DBG("%d: smbus_quick - bus is stuck\n", dev
->idx
);
326 * IIC interrupt handler
328 static irqreturn_t
iic_handler(int irq
, void *dev_id
)
330 struct ibm_iic_private
* dev
= (struct ibm_iic_private
*)dev_id
;
331 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
333 DBG2("%d: irq handler, STS = 0x%02x, EXTSTS = 0x%02x\n",
334 dev
->idx
, in_8(&iic
->sts
), in_8(&iic
->extsts
));
336 /* Acknowledge IRQ and wakeup iic_wait_for_tc */
337 out_8(&iic
->sts
, STS_IRQA
| STS_SCMP
);
338 wake_up_interruptible(&dev
->wq
);
344 * Get master transfer result and clear errors if any.
345 * Returns the number of actually transferred bytes or error (<0)
347 static int iic_xfer_result(struct ibm_iic_private
* dev
)
349 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
351 if (unlikely(in_8(&iic
->sts
) & STS_ERR
)){
352 DBG("%d: xfer error, EXTSTS = 0x%02x\n", dev
->idx
,
355 /* Clear errors and possible pending IRQs */
356 out_8(&iic
->extsts
, EXTSTS_IRQP
| EXTSTS_IRQD
|
357 EXTSTS_LA
| EXTSTS_ICT
| EXTSTS_XFRA
);
359 /* Flush master data buffer */
360 out_8(&iic
->mdcntl
, in_8(&iic
->mdcntl
) | MDCNTL_FMDB
);
363 * If error happened during combined xfer
364 * IIC interface is usually stuck in some strange
365 * state, the only way out - soft reset.
367 if ((in_8(&iic
->extsts
) & EXTSTS_BCS_MASK
) != EXTSTS_BCS_FREE
){
368 DBG("%d: bus is stuck, resetting\n", dev
->idx
);
374 return in_8(&iic
->xfrcnt
) & XFRCNT_MTC_MASK
;
378 * Try to abort active transfer.
380 static void iic_abort_xfer(struct ibm_iic_private
* dev
)
382 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
385 DBG("%d: iic_abort_xfer\n", dev
->idx
);
387 out_8(&iic
->cntl
, CNTL_HMT
);
390 * Wait for the abort command to complete.
391 * It's not worth to be optimized, just poll (timeout >= 1 tick)
394 while ((in_8(&iic
->extsts
) & EXTSTS_BCS_MASK
) != EXTSTS_BCS_FREE
){
395 if (time_after(jiffies
, x
)){
396 DBG("%d: abort timeout, resetting...\n", dev
->idx
);
403 /* Just to clear errors */
404 iic_xfer_result(dev
);
408 * Wait for master transfer to complete.
409 * It puts current process to sleep until we get interrupt or timeout expires.
410 * Returns the number of transferred bytes or error (<0)
412 static int iic_wait_for_tc(struct ibm_iic_private
* dev
){
414 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
419 ret
= wait_event_interruptible_timeout(dev
->wq
,
420 !(in_8(&iic
->sts
) & STS_PT
), dev
->adap
.timeout
);
422 if (unlikely(ret
< 0))
423 DBG("%d: wait interrupted\n", dev
->idx
);
424 else if (unlikely(in_8(&iic
->sts
) & STS_PT
)){
425 DBG("%d: wait timeout\n", dev
->idx
);
431 unsigned long x
= jiffies
+ dev
->adap
.timeout
;
433 while (in_8(&iic
->sts
) & STS_PT
){
434 if (unlikely(time_after(jiffies
, x
))){
435 DBG("%d: poll timeout\n", dev
->idx
);
440 if (unlikely(signal_pending(current
))){
441 DBG("%d: poll interrupted\n", dev
->idx
);
449 if (unlikely(ret
< 0))
452 ret
= iic_xfer_result(dev
);
454 DBG2("%d: iic_wait_for_tc -> %d\n", dev
->idx
, ret
);
460 * Low level master transfer routine
462 static int iic_xfer_bytes(struct ibm_iic_private
* dev
, struct i2c_msg
* pm
,
465 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
467 int i
, j
, loops
, ret
= 0;
470 u8 cntl
= (in_8(&iic
->cntl
) & CNTL_AMD
) | CNTL_PT
;
471 if (pm
->flags
& I2C_M_RD
)
474 loops
= (len
+ 3) / 4;
475 for (i
= 0; i
< loops
; ++i
, len
-= 4){
476 int count
= len
> 4 ? 4 : len
;
477 u8 cmd
= cntl
| ((count
- 1) << CNTL_TCT_SHIFT
);
479 if (!(cntl
& CNTL_RW
))
480 for (j
= 0; j
< count
; ++j
)
481 out_8((void __iomem
*)&iic
->mdbuf
, *buf
++);
485 else if (combined_xfer
)
488 DBG2("%d: xfer_bytes, %d, CNTL = 0x%02x\n", dev
->idx
, count
, cmd
);
491 out_8(&iic
->cntl
, cmd
);
493 /* Wait for completion */
494 ret
= iic_wait_for_tc(dev
);
496 if (unlikely(ret
< 0))
498 else if (unlikely(ret
!= count
)){
499 DBG("%d: xfer_bytes, requested %d, transferred %d\n",
500 dev
->idx
, count
, ret
);
502 /* If it's not a last part of xfer, abort it */
503 if (combined_xfer
|| (i
< loops
- 1))
511 for (j
= 0; j
< count
; ++j
)
512 *buf
++ = in_8((void __iomem
*)&iic
->mdbuf
);
515 return ret
> 0 ? 0 : ret
;
519 * Set target slave address for master transfer
521 static inline void iic_address(struct ibm_iic_private
* dev
, struct i2c_msg
* msg
)
523 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
524 u16 addr
= msg
->addr
;
526 DBG2("%d: iic_address, 0x%03x (%d-bit)\n", dev
->idx
,
527 addr
, msg
->flags
& I2C_M_TEN
? 10 : 7);
529 if (msg
->flags
& I2C_M_TEN
){
530 out_8(&iic
->cntl
, CNTL_AMD
);
531 out_8(&iic
->lmadr
, addr
);
532 out_8(&iic
->hmadr
, 0xf0 | ((addr
>> 7) & 0x06));
535 out_8(&iic
->cntl
, 0);
536 out_8(&iic
->lmadr
, addr
<< 1);
540 static inline int iic_invalid_address(const struct i2c_msg
* p
)
542 return (p
->addr
> 0x3ff) || (!(p
->flags
& I2C_M_TEN
) && (p
->addr
> 0x7f));
545 static inline int iic_address_neq(const struct i2c_msg
* p1
,
546 const struct i2c_msg
* p2
)
548 return (p1
->addr
!= p2
->addr
)
549 || ((p1
->flags
& I2C_M_TEN
) != (p2
->flags
& I2C_M_TEN
));
553 * Generic master transfer entrypoint.
554 * Returns the number of processed messages or error (<0)
556 static int iic_xfer(struct i2c_adapter
*adap
, struct i2c_msg
*msgs
, int num
)
558 struct ibm_iic_private
* dev
= (struct ibm_iic_private
*)(i2c_get_adapdata(adap
));
559 volatile struct iic_regs __iomem
*iic
= dev
->vaddr
;
562 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 happened.
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 iic_request_irq(struct platform_device
*ofdev
,
663 struct ibm_iic_private
*dev
)
665 struct device_node
*np
= ofdev
->dev
.of_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 iic_probe(struct platform_device
*ofdev
)
695 struct device_node
*np
= ofdev
->dev
.of_node
;
696 struct ibm_iic_private
*dev
;
697 struct i2c_adapter
*adap
;
701 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
703 dev_err(&ofdev
->dev
, "failed to allocate device data\n");
707 platform_set_drvdata(ofdev
, dev
);
709 dev
->vaddr
= of_iomap(np
, 0);
710 if (dev
->vaddr
== NULL
) {
711 dev_err(&ofdev
->dev
, "failed to iomap device\n");
716 init_waitqueue_head(&dev
->wq
);
718 dev
->irq
= iic_request_irq(ofdev
, dev
);
720 dev_warn(&ofdev
->dev
, "using polling mode\n");
722 /* Board specific settings */
723 if (iic_force_fast
|| of_get_property(np
, "fast-mode", NULL
))
726 freq
= of_get_property(np
, "clock-frequency", NULL
);
728 freq
= of_get_property(np
->parent
, "clock-frequency", NULL
);
730 dev_err(&ofdev
->dev
, "Unable to get bus frequency\n");
736 dev
->clckdiv
= iic_clckdiv(*freq
);
737 dev_dbg(&ofdev
->dev
, "clckdiv = %d\n", dev
->clckdiv
);
739 /* Initialize IIC interface */
742 /* Register it with i2c layer */
744 adap
->dev
.parent
= &ofdev
->dev
;
745 adap
->dev
.of_node
= of_node_get(np
);
746 strlcpy(adap
->name
, "IBM IIC", sizeof(adap
->name
));
747 i2c_set_adapdata(adap
, dev
);
748 adap
->class = I2C_CLASS_HWMON
| I2C_CLASS_SPD
;
749 adap
->algo
= &iic_algo
;
752 ret
= i2c_add_adapter(adap
);
756 dev_info(&ofdev
->dev
, "using %s mode\n",
757 dev
->fast_mode
? "fast (400 kHz)" : "standard (100 kHz)");
763 iic_interrupt_mode(dev
, 0);
764 free_irq(dev
->irq
, dev
);
775 * Cleanup initialized IIC interface
777 static int iic_remove(struct platform_device
*ofdev
)
779 struct ibm_iic_private
*dev
= platform_get_drvdata(ofdev
);
781 i2c_del_adapter(&dev
->adap
);
784 iic_interrupt_mode(dev
, 0);
785 free_irq(dev
->irq
, dev
);
794 static const struct of_device_id ibm_iic_match
[] = {
795 { .compatible
= "ibm,iic", },
798 MODULE_DEVICE_TABLE(of
, ibm_iic_match
);
800 static struct platform_driver ibm_iic_driver
= {
803 .of_match_table
= ibm_iic_match
,
806 .remove
= iic_remove
,
809 module_platform_driver(ibm_iic_driver
);