2 * TI OMAP I2C master mode driver
4 * Copyright (C) 2003 MontaVista Software, Inc.
5 * Copyright (C) 2004 Texas Instruments.
7 * Updated to work with multiple I2C interfaces on 24xx by
8 * Tony Lindgren <tony@atomide.com> and Imre Deak <imre.deak@nokia.com>
9 * Copyright (C) 2005 Nokia Corporation
11 * Cleaned up by Juha Yrjölä <juha.yrjola@nokia.com>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #include <linux/module.h>
29 #include <linux/delay.h>
30 #include <linux/i2c.h>
31 #include <linux/err.h>
32 #include <linux/interrupt.h>
33 #include <linux/completion.h>
34 #include <linux/platform_device.h>
35 #include <linux/clk.h>
39 /* timeout waiting for the controller to respond */
40 #define OMAP_I2C_TIMEOUT (msecs_to_jiffies(1000))
42 #define OMAP_I2C_REV_REG 0x00
43 #define OMAP_I2C_IE_REG 0x04
44 #define OMAP_I2C_STAT_REG 0x08
45 #define OMAP_I2C_IV_REG 0x0c
46 #define OMAP_I2C_SYSS_REG 0x10
47 #define OMAP_I2C_BUF_REG 0x14
48 #define OMAP_I2C_CNT_REG 0x18
49 #define OMAP_I2C_DATA_REG 0x1c
50 #define OMAP_I2C_SYSC_REG 0x20
51 #define OMAP_I2C_CON_REG 0x24
52 #define OMAP_I2C_OA_REG 0x28
53 #define OMAP_I2C_SA_REG 0x2c
54 #define OMAP_I2C_PSC_REG 0x30
55 #define OMAP_I2C_SCLL_REG 0x34
56 #define OMAP_I2C_SCLH_REG 0x38
57 #define OMAP_I2C_SYSTEST_REG 0x3c
59 /* I2C Interrupt Enable Register (OMAP_I2C_IE): */
60 #define OMAP_I2C_IE_XRDY (1 << 4) /* TX data ready int enable */
61 #define OMAP_I2C_IE_RRDY (1 << 3) /* RX data ready int enable */
62 #define OMAP_I2C_IE_ARDY (1 << 2) /* Access ready int enable */
63 #define OMAP_I2C_IE_NACK (1 << 1) /* No ack interrupt enable */
64 #define OMAP_I2C_IE_AL (1 << 0) /* Arbitration lost int ena */
66 /* I2C Status Register (OMAP_I2C_STAT): */
67 #define OMAP_I2C_STAT_SBD (1 << 15) /* Single byte data */
68 #define OMAP_I2C_STAT_BB (1 << 12) /* Bus busy */
69 #define OMAP_I2C_STAT_ROVR (1 << 11) /* Receive overrun */
70 #define OMAP_I2C_STAT_XUDF (1 << 10) /* Transmit underflow */
71 #define OMAP_I2C_STAT_AAS (1 << 9) /* Address as slave */
72 #define OMAP_I2C_STAT_AD0 (1 << 8) /* Address zero */
73 #define OMAP_I2C_STAT_XRDY (1 << 4) /* Transmit data ready */
74 #define OMAP_I2C_STAT_RRDY (1 << 3) /* Receive data ready */
75 #define OMAP_I2C_STAT_ARDY (1 << 2) /* Register access ready */
76 #define OMAP_I2C_STAT_NACK (1 << 1) /* No ack interrupt enable */
77 #define OMAP_I2C_STAT_AL (1 << 0) /* Arbitration lost int ena */
79 /* I2C Buffer Configuration Register (OMAP_I2C_BUF): */
80 #define OMAP_I2C_BUF_RDMA_EN (1 << 15) /* RX DMA channel enable */
81 #define OMAP_I2C_BUF_XDMA_EN (1 << 7) /* TX DMA channel enable */
83 /* I2C Configuration Register (OMAP_I2C_CON): */
84 #define OMAP_I2C_CON_EN (1 << 15) /* I2C module enable */
85 #define OMAP_I2C_CON_BE (1 << 14) /* Big endian mode */
86 #define OMAP_I2C_CON_STB (1 << 11) /* Start byte mode (master) */
87 #define OMAP_I2C_CON_MST (1 << 10) /* Master/slave mode */
88 #define OMAP_I2C_CON_TRX (1 << 9) /* TX/RX mode (master only) */
89 #define OMAP_I2C_CON_XA (1 << 8) /* Expand address */
90 #define OMAP_I2C_CON_RM (1 << 2) /* Repeat mode (master only) */
91 #define OMAP_I2C_CON_STP (1 << 1) /* Stop cond (master only) */
92 #define OMAP_I2C_CON_STT (1 << 0) /* Start condition (master) */
94 /* I2C System Test Register (OMAP_I2C_SYSTEST): */
96 #define OMAP_I2C_SYSTEST_ST_EN (1 << 15) /* System test enable */
97 #define OMAP_I2C_SYSTEST_FREE (1 << 14) /* Free running mode */
98 #define OMAP_I2C_SYSTEST_TMODE_MASK (3 << 12) /* Test mode select */
99 #define OMAP_I2C_SYSTEST_TMODE_SHIFT (12) /* Test mode select */
100 #define OMAP_I2C_SYSTEST_SCL_I (1 << 3) /* SCL line sense in */
101 #define OMAP_I2C_SYSTEST_SCL_O (1 << 2) /* SCL line drive out */
102 #define OMAP_I2C_SYSTEST_SDA_I (1 << 1) /* SDA line sense in */
103 #define OMAP_I2C_SYSTEST_SDA_O (1 << 0) /* SDA line drive out */
106 /* I2C System Status register (OMAP_I2C_SYSS): */
107 #define OMAP_I2C_SYSS_RDONE (1 << 0) /* Reset Done */
109 /* I2C System Configuration Register (OMAP_I2C_SYSC): */
110 #define OMAP_I2C_SYSC_SRST (1 << 1) /* Soft Reset */
112 /* REVISIT: Use platform_data instead of module parameters */
113 /* Fast Mode = 400 kHz, Standard = 100 kHz */
114 static int clock
= 100; /* Default: 100 kHz */
115 module_param(clock
, int, 0);
116 MODULE_PARM_DESC(clock
, "Set I2C clock in kHz: 400=fast mode (default == 100)");
118 struct omap_i2c_dev
{
120 void __iomem
*base
; /* virtual */
122 struct clk
*iclk
; /* Interface clock */
123 struct clk
*fclk
; /* Functional clock */
124 struct completion cmd_complete
;
125 struct resource
*ioarea
;
129 struct i2c_adapter adapter
;
133 static inline void omap_i2c_write_reg(struct omap_i2c_dev
*i2c_dev
,
136 __raw_writew(val
, i2c_dev
->base
+ reg
);
139 static inline u16
omap_i2c_read_reg(struct omap_i2c_dev
*i2c_dev
, int reg
)
141 return __raw_readw(i2c_dev
->base
+ reg
);
144 static int omap_i2c_get_clocks(struct omap_i2c_dev
*dev
)
146 if (cpu_is_omap16xx() || cpu_is_omap24xx()) {
147 dev
->iclk
= clk_get(dev
->dev
, "i2c_ick");
148 if (IS_ERR(dev
->iclk
)) {
154 dev
->fclk
= clk_get(dev
->dev
, "i2c_fck");
155 if (IS_ERR(dev
->fclk
)) {
156 if (dev
->iclk
!= NULL
) {
167 static void omap_i2c_put_clocks(struct omap_i2c_dev
*dev
)
171 if (dev
->iclk
!= NULL
) {
177 static void omap_i2c_enable_clocks(struct omap_i2c_dev
*dev
)
179 if (dev
->iclk
!= NULL
)
180 clk_enable(dev
->iclk
);
181 clk_enable(dev
->fclk
);
184 static void omap_i2c_disable_clocks(struct omap_i2c_dev
*dev
)
186 if (dev
->iclk
!= NULL
)
187 clk_disable(dev
->iclk
);
188 clk_disable(dev
->fclk
);
191 static int omap_i2c_init(struct omap_i2c_dev
*dev
)
194 unsigned long fclk_rate
= 12000000;
195 unsigned long timeout
;
198 omap_i2c_write_reg(dev
, OMAP_I2C_SYSC_REG
, OMAP_I2C_SYSC_SRST
);
199 /* For some reason we need to set the EN bit before the
200 * reset done bit gets set. */
201 timeout
= jiffies
+ OMAP_I2C_TIMEOUT
;
202 omap_i2c_write_reg(dev
, OMAP_I2C_CON_REG
, OMAP_I2C_CON_EN
);
203 while (!(omap_i2c_read_reg(dev
, OMAP_I2C_SYSS_REG
) &
204 OMAP_I2C_SYSS_RDONE
)) {
205 if (time_after(jiffies
, timeout
)) {
206 dev_warn(dev
->dev
, "timeout waiting"
207 "for controller reset\n");
213 omap_i2c_write_reg(dev
, OMAP_I2C_CON_REG
, 0);
215 if (cpu_class_is_omap1()) {
216 struct clk
*armxor_ck
;
218 armxor_ck
= clk_get(NULL
, "armxor_ck");
219 if (IS_ERR(armxor_ck
))
220 dev_warn(dev
->dev
, "Could not get armxor_ck\n");
222 fclk_rate
= clk_get_rate(armxor_ck
);
225 /* TRM for 5912 says the I2C clock must be prescaled to be
226 * between 7 - 12 MHz. The XOR input clock is typically
227 * 12, 13 or 19.2 MHz. So we should have code that produces:
229 * XOR MHz Divider Prescaler
234 if (fclk_rate
> 12000000)
235 psc
= fclk_rate
/ 12000000;
238 /* Setup clock prescaler to obtain approx 12MHz I2C module clock: */
239 omap_i2c_write_reg(dev
, OMAP_I2C_PSC_REG
, psc
);
241 /* Program desired operating rate */
242 fclk_rate
/= (psc
+ 1) * 1000;
246 omap_i2c_write_reg(dev
, OMAP_I2C_SCLL_REG
,
247 fclk_rate
/ (clock
* 2) - 7 + psc
);
248 omap_i2c_write_reg(dev
, OMAP_I2C_SCLH_REG
,
249 fclk_rate
/ (clock
* 2) - 7 + psc
);
251 /* Take the I2C module out of reset: */
252 omap_i2c_write_reg(dev
, OMAP_I2C_CON_REG
, OMAP_I2C_CON_EN
);
254 /* Enable interrupts */
255 omap_i2c_write_reg(dev
, OMAP_I2C_IE_REG
,
256 (OMAP_I2C_IE_XRDY
| OMAP_I2C_IE_RRDY
|
257 OMAP_I2C_IE_ARDY
| OMAP_I2C_IE_NACK
|
263 * Waiting on Bus Busy
265 static int omap_i2c_wait_for_bb(struct omap_i2c_dev
*dev
)
267 unsigned long timeout
;
269 timeout
= jiffies
+ OMAP_I2C_TIMEOUT
;
270 while (omap_i2c_read_reg(dev
, OMAP_I2C_STAT_REG
) & OMAP_I2C_STAT_BB
) {
271 if (time_after(jiffies
, timeout
)) {
272 dev_warn(dev
->dev
, "timeout waiting for bus ready\n");
282 * Low level master read/write transaction.
284 static int omap_i2c_xfer_msg(struct i2c_adapter
*adap
,
285 struct i2c_msg
*msg
, int stop
)
287 struct omap_i2c_dev
*dev
= i2c_get_adapdata(adap
);
291 dev_dbg(dev
->dev
, "addr: 0x%04x, len: %d, flags: 0x%x, stop: %d\n",
292 msg
->addr
, msg
->len
, msg
->flags
, stop
);
297 omap_i2c_write_reg(dev
, OMAP_I2C_SA_REG
, msg
->addr
);
299 /* REVISIT: Could the STB bit of I2C_CON be used with probing? */
301 dev
->buf_len
= msg
->len
;
303 omap_i2c_write_reg(dev
, OMAP_I2C_CNT_REG
, dev
->buf_len
);
305 init_completion(&dev
->cmd_complete
);
308 w
= OMAP_I2C_CON_EN
| OMAP_I2C_CON_MST
| OMAP_I2C_CON_STT
;
309 if (msg
->flags
& I2C_M_TEN
)
310 w
|= OMAP_I2C_CON_XA
;
311 if (!(msg
->flags
& I2C_M_RD
))
312 w
|= OMAP_I2C_CON_TRX
;
314 w
|= OMAP_I2C_CON_STP
;
315 omap_i2c_write_reg(dev
, OMAP_I2C_CON_REG
, w
);
317 r
= wait_for_completion_interruptible_timeout(&dev
->cmd_complete
,
323 dev_err(dev
->dev
, "controller timed out\n");
328 if (likely(!dev
->cmd_err
))
331 /* We have an error */
332 if (dev
->cmd_err
& (OMAP_I2C_STAT_AL
| OMAP_I2C_STAT_ROVR
|
333 OMAP_I2C_STAT_XUDF
)) {
338 if (dev
->cmd_err
& OMAP_I2C_STAT_NACK
) {
339 if (msg
->flags
& I2C_M_IGNORE_NAK
)
342 w
= omap_i2c_read_reg(dev
, OMAP_I2C_CON_REG
);
343 w
|= OMAP_I2C_CON_STP
;
344 omap_i2c_write_reg(dev
, OMAP_I2C_CON_REG
, w
);
353 * Prepare controller for a transaction and call omap_i2c_xfer_msg
354 * to do the work during IRQ processing.
357 omap_i2c_xfer(struct i2c_adapter
*adap
, struct i2c_msg msgs
[], int num
)
359 struct omap_i2c_dev
*dev
= i2c_get_adapdata(adap
);
363 omap_i2c_enable_clocks(dev
);
365 /* REVISIT: initialize and use adap->retries. This is an optional
367 if ((r
= omap_i2c_wait_for_bb(dev
)) < 0)
370 for (i
= 0; i
< num
; i
++) {
371 r
= omap_i2c_xfer_msg(adap
, &msgs
[i
], (i
== (num
- 1)));
379 omap_i2c_disable_clocks(dev
);
384 omap_i2c_func(struct i2c_adapter
*adap
)
386 return I2C_FUNC_I2C
| (I2C_FUNC_SMBUS_EMUL
& ~I2C_FUNC_SMBUS_QUICK
);
390 omap_i2c_complete_cmd(struct omap_i2c_dev
*dev
, u16 err
)
393 complete(&dev
->cmd_complete
);
397 omap_i2c_ack_stat(struct omap_i2c_dev
*dev
, u16 stat
)
399 omap_i2c_write_reg(dev
, OMAP_I2C_STAT_REG
, stat
);
403 omap_i2c_rev1_isr(int this_irq
, void *dev_id
)
405 struct omap_i2c_dev
*dev
= dev_id
;
408 iv
= omap_i2c_read_reg(dev
, OMAP_I2C_IV_REG
);
410 case 0x00: /* None */
412 case 0x01: /* Arbitration lost */
413 dev_err(dev
->dev
, "Arbitration lost\n");
414 omap_i2c_complete_cmd(dev
, OMAP_I2C_STAT_AL
);
416 case 0x02: /* No acknowledgement */
417 omap_i2c_complete_cmd(dev
, OMAP_I2C_STAT_NACK
);
418 omap_i2c_write_reg(dev
, OMAP_I2C_CON_REG
, OMAP_I2C_CON_STP
);
420 case 0x03: /* Register access ready */
421 omap_i2c_complete_cmd(dev
, 0);
423 case 0x04: /* Receive data ready */
425 w
= omap_i2c_read_reg(dev
, OMAP_I2C_DATA_REG
);
429 *dev
->buf
++ = w
>> 8;
433 dev_err(dev
->dev
, "RRDY IRQ while no data requested\n");
435 case 0x05: /* Transmit data ready */
440 w
|= *dev
->buf
++ << 8;
443 omap_i2c_write_reg(dev
, OMAP_I2C_DATA_REG
, w
);
445 dev_err(dev
->dev
, "XRDY IRQ while no data to send\n");
455 omap_i2c_isr(int this_irq
, void *dev_id
)
457 struct omap_i2c_dev
*dev
= dev_id
;
462 bits
= omap_i2c_read_reg(dev
, OMAP_I2C_IE_REG
);
463 while ((stat
= (omap_i2c_read_reg(dev
, OMAP_I2C_STAT_REG
))) & bits
) {
464 dev_dbg(dev
->dev
, "IRQ (ISR = 0x%04x)\n", stat
);
465 if (count
++ == 100) {
466 dev_warn(dev
->dev
, "Too much work in one IRQ\n");
470 omap_i2c_write_reg(dev
, OMAP_I2C_STAT_REG
, stat
);
472 if (stat
& OMAP_I2C_STAT_ARDY
) {
473 omap_i2c_complete_cmd(dev
, 0);
476 if (stat
& OMAP_I2C_STAT_RRDY
) {
477 w
= omap_i2c_read_reg(dev
, OMAP_I2C_DATA_REG
);
482 *dev
->buf
++ = w
>> 8;
486 dev_err(dev
->dev
, "RRDY IRQ while no data"
488 omap_i2c_ack_stat(dev
, OMAP_I2C_STAT_RRDY
);
491 if (stat
& OMAP_I2C_STAT_XRDY
) {
497 w
|= *dev
->buf
++ << 8;
501 dev_err(dev
->dev
, "XRDY IRQ while no"
503 omap_i2c_write_reg(dev
, OMAP_I2C_DATA_REG
, w
);
504 omap_i2c_ack_stat(dev
, OMAP_I2C_STAT_XRDY
);
507 if (stat
& OMAP_I2C_STAT_ROVR
) {
508 dev_err(dev
->dev
, "Receive overrun\n");
509 dev
->cmd_err
|= OMAP_I2C_STAT_ROVR
;
511 if (stat
& OMAP_I2C_STAT_XUDF
) {
512 dev_err(dev
->dev
, "Transmit overflow\n");
513 dev
->cmd_err
|= OMAP_I2C_STAT_XUDF
;
515 if (stat
& OMAP_I2C_STAT_NACK
) {
516 omap_i2c_complete_cmd(dev
, OMAP_I2C_STAT_NACK
);
517 omap_i2c_write_reg(dev
, OMAP_I2C_CON_REG
,
520 if (stat
& OMAP_I2C_STAT_AL
) {
521 dev_err(dev
->dev
, "Arbitration lost\n");
522 omap_i2c_complete_cmd(dev
, OMAP_I2C_STAT_AL
);
526 return count
? IRQ_HANDLED
: IRQ_NONE
;
529 static const struct i2c_algorithm omap_i2c_algo
= {
530 .master_xfer
= omap_i2c_xfer
,
531 .functionality
= omap_i2c_func
,
535 omap_i2c_probe(struct platform_device
*pdev
)
537 struct omap_i2c_dev
*dev
;
538 struct i2c_adapter
*adap
;
539 struct resource
*mem
, *irq
, *ioarea
;
542 /* NOTE: driver uses the static register mapping */
543 mem
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
545 dev_err(&pdev
->dev
, "no mem resource?\n");
548 irq
= platform_get_resource(pdev
, IORESOURCE_IRQ
, 0);
550 dev_err(&pdev
->dev
, "no irq resource?\n");
554 ioarea
= request_mem_region(mem
->start
, (mem
->end
- mem
->start
) + 1,
557 dev_err(&pdev
->dev
, "I2C region already claimed\n");
562 clock
= 400; /* Fast mode */
564 clock
= 100; /* Standard mode */
566 dev
= kzalloc(sizeof(struct omap_i2c_dev
), GFP_KERNEL
);
569 goto err_release_region
;
572 dev
->dev
= &pdev
->dev
;
573 dev
->irq
= irq
->start
;
574 dev
->base
= (void __iomem
*) IO_ADDRESS(mem
->start
);
575 platform_set_drvdata(pdev
, dev
);
577 if ((r
= omap_i2c_get_clocks(dev
)) != 0)
580 omap_i2c_enable_clocks(dev
);
582 if (cpu_is_omap15xx())
583 dev
->rev1
= omap_i2c_read_reg(dev
, OMAP_I2C_REV_REG
) < 0x20;
585 /* reset ASAP, clearing any IRQs */
588 r
= request_irq(dev
->irq
, dev
->rev1
? omap_i2c_rev1_isr
: omap_i2c_isr
,
592 dev_err(dev
->dev
, "failure requesting irq %i\n", dev
->irq
);
593 goto err_unuse_clocks
;
595 r
= omap_i2c_read_reg(dev
, OMAP_I2C_REV_REG
) & 0xff;
596 dev_info(dev
->dev
, "bus %d rev%d.%d at %d kHz\n",
597 pdev
->id
, r
>> 4, r
& 0xf, clock
);
599 adap
= &dev
->adapter
;
600 i2c_set_adapdata(adap
, dev
);
601 adap
->owner
= THIS_MODULE
;
602 adap
->class = I2C_CLASS_HWMON
;
603 strncpy(adap
->name
, "OMAP I2C adapter", sizeof(adap
->name
));
604 adap
->algo
= &omap_i2c_algo
;
605 adap
->dev
.parent
= &pdev
->dev
;
607 /* i2c device drivers may be active on return from add_adapter() */
609 r
= i2c_add_numbered_adapter(adap
);
611 dev_err(dev
->dev
, "failure adding adapter\n");
615 omap_i2c_disable_clocks(dev
);
620 free_irq(dev
->irq
, dev
);
622 omap_i2c_disable_clocks(dev
);
623 omap_i2c_put_clocks(dev
);
625 platform_set_drvdata(pdev
, NULL
);
628 omap_i2c_write_reg(dev
, OMAP_I2C_CON_REG
, 0);
629 release_mem_region(mem
->start
, (mem
->end
- mem
->start
) + 1);
635 omap_i2c_remove(struct platform_device
*pdev
)
637 struct omap_i2c_dev
*dev
= platform_get_drvdata(pdev
);
638 struct resource
*mem
;
640 platform_set_drvdata(pdev
, NULL
);
642 free_irq(dev
->irq
, dev
);
643 i2c_del_adapter(&dev
->adapter
);
644 omap_i2c_write_reg(dev
, OMAP_I2C_CON_REG
, 0);
645 omap_i2c_put_clocks(dev
);
647 mem
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
648 release_mem_region(mem
->start
, (mem
->end
- mem
->start
) + 1);
652 static struct platform_driver omap_i2c_driver
= {
653 .probe
= omap_i2c_probe
,
654 .remove
= omap_i2c_remove
,
657 .owner
= THIS_MODULE
,
661 /* I2C may be needed to bring up other drivers */
663 omap_i2c_init_driver(void)
665 return platform_driver_register(&omap_i2c_driver
);
667 subsys_initcall(omap_i2c_init_driver
);
669 static void __exit
omap_i2c_exit_driver(void)
671 platform_driver_unregister(&omap_i2c_driver
);
673 module_exit(omap_i2c_exit_driver
);
675 MODULE_AUTHOR("MontaVista Software, Inc. (and others)");
676 MODULE_DESCRIPTION("TI OMAP I2C bus adapter");
677 MODULE_LICENSE("GPL");