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 /* Hack to enable zero length transfers and smbus quick until clean fix
43 /* timeout waiting for the controller to respond */
44 #define OMAP_I2C_TIMEOUT (msecs_to_jiffies(1000))
46 #define OMAP_I2C_REV_REG 0x00
47 #define OMAP_I2C_IE_REG 0x04
48 #define OMAP_I2C_STAT_REG 0x08
49 #define OMAP_I2C_IV_REG 0x0c
50 #define OMAP_I2C_SYSS_REG 0x10
51 #define OMAP_I2C_BUF_REG 0x14
52 #define OMAP_I2C_CNT_REG 0x18
53 #define OMAP_I2C_DATA_REG 0x1c
54 #define OMAP_I2C_SYSC_REG 0x20
55 #define OMAP_I2C_CON_REG 0x24
56 #define OMAP_I2C_OA_REG 0x28
57 #define OMAP_I2C_SA_REG 0x2c
58 #define OMAP_I2C_PSC_REG 0x30
59 #define OMAP_I2C_SCLL_REG 0x34
60 #define OMAP_I2C_SCLH_REG 0x38
61 #define OMAP_I2C_SYSTEST_REG 0x3c
63 /* I2C Interrupt Enable Register (OMAP_I2C_IE): */
64 #define OMAP_I2C_IE_XRDY (1 << 4) /* TX data ready int enable */
65 #define OMAP_I2C_IE_RRDY (1 << 3) /* RX data ready int enable */
66 #define OMAP_I2C_IE_ARDY (1 << 2) /* Access ready int enable */
67 #define OMAP_I2C_IE_NACK (1 << 1) /* No ack interrupt enable */
68 #define OMAP_I2C_IE_AL (1 << 0) /* Arbitration lost int ena */
70 /* I2C Status Register (OMAP_I2C_STAT): */
71 #define OMAP_I2C_STAT_SBD (1 << 15) /* Single byte data */
72 #define OMAP_I2C_STAT_BB (1 << 12) /* Bus busy */
73 #define OMAP_I2C_STAT_ROVR (1 << 11) /* Receive overrun */
74 #define OMAP_I2C_STAT_XUDF (1 << 10) /* Transmit underflow */
75 #define OMAP_I2C_STAT_AAS (1 << 9) /* Address as slave */
76 #define OMAP_I2C_STAT_AD0 (1 << 8) /* Address zero */
77 #define OMAP_I2C_STAT_XRDY (1 << 4) /* Transmit data ready */
78 #define OMAP_I2C_STAT_RRDY (1 << 3) /* Receive data ready */
79 #define OMAP_I2C_STAT_ARDY (1 << 2) /* Register access ready */
80 #define OMAP_I2C_STAT_NACK (1 << 1) /* No ack interrupt enable */
81 #define OMAP_I2C_STAT_AL (1 << 0) /* Arbitration lost int ena */
83 /* I2C Buffer Configuration Register (OMAP_I2C_BUF): */
84 #define OMAP_I2C_BUF_RDMA_EN (1 << 15) /* RX DMA channel enable */
85 #define OMAP_I2C_BUF_XDMA_EN (1 << 7) /* TX DMA channel enable */
87 /* I2C Configuration Register (OMAP_I2C_CON): */
88 #define OMAP_I2C_CON_EN (1 << 15) /* I2C module enable */
89 #define OMAP_I2C_CON_BE (1 << 14) /* Big endian mode */
90 #define OMAP_I2C_CON_STB (1 << 11) /* Start byte mode (master) */
91 #define OMAP_I2C_CON_MST (1 << 10) /* Master/slave mode */
92 #define OMAP_I2C_CON_TRX (1 << 9) /* TX/RX mode (master only) */
93 #define OMAP_I2C_CON_XA (1 << 8) /* Expand address */
94 #define OMAP_I2C_CON_RM (1 << 2) /* Repeat mode (master only) */
95 #define OMAP_I2C_CON_STP (1 << 1) /* Stop cond (master only) */
96 #define OMAP_I2C_CON_STT (1 << 0) /* Start condition (master) */
98 /* I2C System Test Register (OMAP_I2C_SYSTEST): */
100 #define OMAP_I2C_SYSTEST_ST_EN (1 << 15) /* System test enable */
101 #define OMAP_I2C_SYSTEST_FREE (1 << 14) /* Free running mode */
102 #define OMAP_I2C_SYSTEST_TMODE_MASK (3 << 12) /* Test mode select */
103 #define OMAP_I2C_SYSTEST_TMODE_SHIFT (12) /* Test mode select */
104 #define OMAP_I2C_SYSTEST_SCL_I (1 << 3) /* SCL line sense in */
105 #define OMAP_I2C_SYSTEST_SCL_O (1 << 2) /* SCL line drive out */
106 #define OMAP_I2C_SYSTEST_SDA_I (1 << 1) /* SDA line sense in */
107 #define OMAP_I2C_SYSTEST_SDA_O (1 << 0) /* SDA line drive out */
110 /* I2C System Status register (OMAP_I2C_SYSS): */
111 #define OMAP_I2C_SYSS_RDONE (1 << 0) /* Reset Done */
113 /* I2C System Configuration Register (OMAP_I2C_SYSC): */
114 #define OMAP_I2C_SYSC_SRST (1 << 1) /* Soft Reset */
116 /* REVISIT: Use platform_data instead of module parameters */
117 /* Fast Mode = 400 kHz, Standard = 100 kHz */
118 static int clock = 100; /* Default: 100 kHz */
119 module_param(clock, int, 0);
120 MODULE_PARM_DESC(clock, "Set I2C clock in kHz: 400=fast mode (default == 100)");
122 struct omap_i2c_dev {
124 void __iomem *base; /* virtual */
126 struct clk *iclk; /* Interface clock */
127 struct clk *fclk; /* Functional clock */
128 struct completion cmd_complete;
129 struct resource *ioarea;
133 struct i2c_adapter adapter;
137 static inline void omap_i2c_write_reg(struct omap_i2c_dev *i2c_dev,
140 __raw_writew(val, i2c_dev->base + reg);
143 static inline u16 omap_i2c_read_reg(struct omap_i2c_dev *i2c_dev, int reg)
145 return __raw_readw(i2c_dev->base + reg);
148 static int omap_i2c_get_clocks(struct omap_i2c_dev *dev)
150 if (cpu_is_omap16xx() || cpu_is_omap24xx()) {
151 dev->iclk = clk_get(dev->dev, "i2c_ick");
152 if (IS_ERR(dev->iclk)) {
158 dev->fclk = clk_get(dev->dev, "i2c_fck");
159 if (IS_ERR(dev->fclk)) {
160 if (dev->iclk != NULL) {
171 static void omap_i2c_put_clocks(struct omap_i2c_dev *dev)
175 if (dev->iclk != NULL) {
181 static void omap_i2c_enable_clocks(struct omap_i2c_dev *dev)
183 if (dev->iclk != NULL)
184 clk_enable(dev->iclk);
185 clk_enable(dev->fclk);
188 static void omap_i2c_disable_clocks(struct omap_i2c_dev *dev)
190 if (dev->iclk != NULL)
191 clk_disable(dev->iclk);
192 clk_disable(dev->fclk);
195 static int omap_i2c_init(struct omap_i2c_dev *dev)
198 unsigned long fclk_rate = 12000000;
199 unsigned long timeout;
202 omap_i2c_write_reg(dev, OMAP_I2C_SYSC_REG, OMAP_I2C_SYSC_SRST);
203 /* For some reason we need to set the EN bit before the
204 * reset done bit gets set. */
205 timeout = jiffies + OMAP_I2C_TIMEOUT;
206 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_EN);
207 while (!(omap_i2c_read_reg(dev, OMAP_I2C_SYSS_REG) &
208 OMAP_I2C_SYSS_RDONE)) {
209 if (time_after(jiffies, timeout)) {
210 dev_warn(dev->dev, "timeout waiting"
211 "for controller reset\n");
217 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
219 if (cpu_class_is_omap1()) {
220 struct clk *armxor_ck;
222 armxor_ck = clk_get(NULL, "armxor_ck");
223 if (IS_ERR(armxor_ck))
224 dev_warn(dev->dev, "Could not get armxor_ck\n");
226 fclk_rate = clk_get_rate(armxor_ck);
229 /* TRM for 5912 says the I2C clock must be prescaled to be
230 * between 7 - 12 MHz. The XOR input clock is typically
231 * 12, 13 or 19.2 MHz. So we should have code that produces:
233 * XOR MHz Divider Prescaler
238 if (fclk_rate > 12000000)
239 psc = fclk_rate / 12000000;
242 /* Setup clock prescaler to obtain approx 12MHz I2C module clock: */
243 omap_i2c_write_reg(dev, OMAP_I2C_PSC_REG, psc);
245 /* Program desired operating rate */
246 fclk_rate /= (psc + 1) * 1000;
250 omap_i2c_write_reg(dev, OMAP_I2C_SCLL_REG,
251 fclk_rate / (clock * 2) - 7 + psc);
252 omap_i2c_write_reg(dev, OMAP_I2C_SCLH_REG,
253 fclk_rate / (clock * 2) - 7 + psc);
255 /* Take the I2C module out of reset: */
256 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_EN);
258 /* Enable interrupts */
259 omap_i2c_write_reg(dev, OMAP_I2C_IE_REG,
260 (OMAP_I2C_IE_XRDY | OMAP_I2C_IE_RRDY |
261 OMAP_I2C_IE_ARDY | OMAP_I2C_IE_NACK |
267 * Waiting on Bus Busy
269 static int omap_i2c_wait_for_bb(struct omap_i2c_dev *dev)
271 unsigned long timeout;
273 timeout = jiffies + OMAP_I2C_TIMEOUT;
274 while (omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG) & OMAP_I2C_STAT_BB) {
275 if (time_after(jiffies, timeout)) {
276 dev_warn(dev->dev, "timeout waiting for bus ready\n");
286 * Low level master read/write transaction.
288 static int omap_i2c_xfer_msg(struct i2c_adapter *adap,
289 struct i2c_msg *msg, int stop)
291 struct omap_i2c_dev *dev = i2c_get_adapdata(adap);
298 dev_dbg(dev->dev, "addr: 0x%04x, len: %d, flags: 0x%x, stop: %d\n",
299 msg->addr, msg->len, msg->flags, stop);
305 omap_i2c_write_reg(dev, OMAP_I2C_SA_REG, msg->addr);
307 /* REVISIT: Could the STB bit of I2C_CON be used with probing? */
309 dev->buf_len = msg->len;
313 omap_i2c_write_reg(dev, OMAP_I2C_SA_REG, msg->addr);
314 /* REVISIT: Remove this hack when we can get I2C chips from board-*.c
316 * Sigh, seems we can't do zero length transactions. Thus, we
317 * can't probe for devices w/o actually sending/receiving at least
318 * a single byte. So we'll set count to 1 for the zero length
319 * transaction case and hope we don't cause grief for some
320 * arbitrary device due to random byte write/read during
324 dev->buf = &zero_byte;
328 dev->buf_len = msg->len;
332 omap_i2c_write_reg(dev, OMAP_I2C_CNT_REG, dev->buf_len);
334 init_completion(&dev->cmd_complete);
337 w = OMAP_I2C_CON_EN | OMAP_I2C_CON_MST | OMAP_I2C_CON_STT;
338 if (msg->flags & I2C_M_TEN)
339 w |= OMAP_I2C_CON_XA;
340 if (!(msg->flags & I2C_M_RD))
341 w |= OMAP_I2C_CON_TRX;
343 w |= OMAP_I2C_CON_STP;
344 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);
346 r = wait_for_completion_timeout(&dev->cmd_complete,
352 dev_err(dev->dev, "controller timed out\n");
357 if (likely(!dev->cmd_err))
360 /* We have an error */
361 if (dev->cmd_err & (OMAP_I2C_STAT_AL | OMAP_I2C_STAT_ROVR |
362 OMAP_I2C_STAT_XUDF)) {
367 if (dev->cmd_err & OMAP_I2C_STAT_NACK) {
368 if (msg->flags & I2C_M_IGNORE_NAK)
371 w = omap_i2c_read_reg(dev, OMAP_I2C_CON_REG);
372 w |= OMAP_I2C_CON_STP;
373 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);
382 * Prepare controller for a transaction and call omap_i2c_xfer_msg
383 * to do the work during IRQ processing.
386 omap_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
388 struct omap_i2c_dev *dev = i2c_get_adapdata(adap);
392 omap_i2c_enable_clocks(dev);
394 /* REVISIT: initialize and use adap->retries. This is an optional
396 if ((r = omap_i2c_wait_for_bb(dev)) < 0)
399 for (i = 0; i < num; i++) {
400 r = omap_i2c_xfer_msg(adap, &msgs[i], (i == (num - 1)));
408 omap_i2c_disable_clocks(dev);
413 omap_i2c_func(struct i2c_adapter *adap)
416 return I2C_FUNC_I2C | (I2C_FUNC_SMBUS_EMUL & ~I2C_FUNC_SMBUS_QUICK);
418 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
423 omap_i2c_complete_cmd(struct omap_i2c_dev *dev, u16 err)
426 complete(&dev->cmd_complete);
430 omap_i2c_ack_stat(struct omap_i2c_dev *dev, u16 stat)
432 omap_i2c_write_reg(dev, OMAP_I2C_STAT_REG, stat);
436 omap_i2c_rev1_isr(int this_irq, void *dev_id)
438 struct omap_i2c_dev *dev = dev_id;
441 iv = omap_i2c_read_reg(dev, OMAP_I2C_IV_REG);
443 case 0x00: /* None */
445 case 0x01: /* Arbitration lost */
446 dev_err(dev->dev, "Arbitration lost\n");
447 omap_i2c_complete_cmd(dev, OMAP_I2C_STAT_AL);
449 case 0x02: /* No acknowledgement */
450 omap_i2c_complete_cmd(dev, OMAP_I2C_STAT_NACK);
451 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_STP);
453 case 0x03: /* Register access ready */
454 omap_i2c_complete_cmd(dev, 0);
456 case 0x04: /* Receive data ready */
458 w = omap_i2c_read_reg(dev, OMAP_I2C_DATA_REG);
462 *dev->buf++ = w >> 8;
466 dev_err(dev->dev, "RRDY IRQ while no data requested\n");
468 case 0x05: /* Transmit data ready */
473 w |= *dev->buf++ << 8;
476 omap_i2c_write_reg(dev, OMAP_I2C_DATA_REG, w);
478 dev_err(dev->dev, "XRDY IRQ while no data to send\n");
488 omap_i2c_isr(int this_irq, void *dev_id)
490 struct omap_i2c_dev *dev = dev_id;
495 bits = omap_i2c_read_reg(dev, OMAP_I2C_IE_REG);
496 while ((stat = (omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG))) & bits) {
497 dev_dbg(dev->dev, "IRQ (ISR = 0x%04x)\n", stat);
498 if (count++ == 100) {
499 dev_warn(dev->dev, "Too much work in one IRQ\n");
503 omap_i2c_write_reg(dev, OMAP_I2C_STAT_REG, stat);
505 if (stat & OMAP_I2C_STAT_ARDY) {
506 omap_i2c_complete_cmd(dev, 0);
509 if (stat & OMAP_I2C_STAT_RRDY) {
510 w = omap_i2c_read_reg(dev, OMAP_I2C_DATA_REG);
515 * Data reg in 2430 is 8 bit wide,
517 if (!cpu_is_omap2430()) {
519 *dev->buf++ = w >> 8;
524 dev_err(dev->dev, "RRDY IRQ while no data"
526 omap_i2c_ack_stat(dev, OMAP_I2C_STAT_RRDY);
529 if (stat & OMAP_I2C_STAT_XRDY) {
535 * Data reg in 2430 is 8 bit wide,
537 if (!cpu_is_omap2430()) {
539 w |= *dev->buf++ << 8;
544 dev_err(dev->dev, "XRDY IRQ while no"
546 omap_i2c_write_reg(dev, OMAP_I2C_DATA_REG, w);
547 omap_i2c_ack_stat(dev, OMAP_I2C_STAT_XRDY);
550 if (stat & OMAP_I2C_STAT_ROVR) {
551 dev_err(dev->dev, "Receive overrun\n");
552 dev->cmd_err |= OMAP_I2C_STAT_ROVR;
554 if (stat & OMAP_I2C_STAT_XUDF) {
555 dev_err(dev->dev, "Transmit overflow\n");
556 dev->cmd_err |= OMAP_I2C_STAT_XUDF;
558 if (stat & OMAP_I2C_STAT_NACK) {
559 omap_i2c_complete_cmd(dev, OMAP_I2C_STAT_NACK);
560 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG,
563 if (stat & OMAP_I2C_STAT_AL) {
564 dev_err(dev->dev, "Arbitration lost\n");
565 omap_i2c_complete_cmd(dev, OMAP_I2C_STAT_AL);
569 return count ? IRQ_HANDLED : IRQ_NONE;
572 static const struct i2c_algorithm omap_i2c_algo = {
573 .master_xfer = omap_i2c_xfer,
574 .functionality = omap_i2c_func,
578 omap_i2c_probe(struct platform_device *pdev)
580 struct omap_i2c_dev *dev;
581 struct i2c_adapter *adap;
582 struct resource *mem, *irq, *ioarea;
585 /* NOTE: driver uses the static register mapping */
586 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
588 dev_err(&pdev->dev, "no mem resource?\n");
591 irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
593 dev_err(&pdev->dev, "no irq resource?\n");
597 ioarea = request_mem_region(mem->start, (mem->end - mem->start) + 1,
600 dev_err(&pdev->dev, "I2C region already claimed\n");
605 clock = 400; /* Fast mode */
607 clock = 100; /* Standard mode */
609 dev = kzalloc(sizeof(struct omap_i2c_dev), GFP_KERNEL);
612 goto err_release_region;
615 dev->dev = &pdev->dev;
616 dev->irq = irq->start;
617 dev->base = (void __iomem *) IO_ADDRESS(mem->start);
618 platform_set_drvdata(pdev, dev);
620 if ((r = omap_i2c_get_clocks(dev)) != 0)
623 omap_i2c_enable_clocks(dev);
625 if (cpu_is_omap15xx())
626 dev->rev1 = omap_i2c_read_reg(dev, OMAP_I2C_REV_REG) < 0x20;
628 /* reset ASAP, clearing any IRQs */
631 r = request_irq(dev->irq, dev->rev1 ? omap_i2c_rev1_isr : omap_i2c_isr,
635 dev_err(dev->dev, "failure requesting irq %i\n", dev->irq);
636 goto err_unuse_clocks;
638 r = omap_i2c_read_reg(dev, OMAP_I2C_REV_REG) & 0xff;
639 dev_info(dev->dev, "bus %d rev%d.%d at %d kHz\n",
640 pdev->id, r >> 4, r & 0xf, clock);
642 adap = &dev->adapter;
643 i2c_set_adapdata(adap, dev);
644 adap->owner = THIS_MODULE;
645 adap->class = I2C_CLASS_HWMON;
646 strncpy(adap->name, "OMAP I2C adapter", sizeof(adap->name));
647 adap->algo = &omap_i2c_algo;
648 adap->dev.parent = &pdev->dev;
650 /* i2c device drivers may be active on return from add_adapter() */
652 r = i2c_add_numbered_adapter(adap);
654 dev_err(dev->dev, "failure adding adapter\n");
658 omap_i2c_disable_clocks(dev);
663 free_irq(dev->irq, dev);
665 omap_i2c_disable_clocks(dev);
666 omap_i2c_put_clocks(dev);
668 platform_set_drvdata(pdev, NULL);
671 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
672 release_mem_region(mem->start, (mem->end - mem->start) + 1);
678 omap_i2c_remove(struct platform_device *pdev)
680 struct omap_i2c_dev *dev = platform_get_drvdata(pdev);
681 struct resource *mem;
683 platform_set_drvdata(pdev, NULL);
685 free_irq(dev->irq, dev);
686 i2c_del_adapter(&dev->adapter);
687 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
688 omap_i2c_put_clocks(dev);
690 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
691 release_mem_region(mem->start, (mem->end - mem->start) + 1);
695 static struct platform_driver omap_i2c_driver = {
696 .probe = omap_i2c_probe,
697 .remove = omap_i2c_remove,
700 .owner = THIS_MODULE,
704 /* I2C may be needed to bring up other drivers */
706 omap_i2c_init_driver(void)
708 return platform_driver_register(&omap_i2c_driver);
710 subsys_initcall(omap_i2c_init_driver);
712 static void __exit omap_i2c_exit_driver(void)
714 platform_driver_unregister(&omap_i2c_driver);
716 module_exit(omap_i2c_exit_driver);
718 MODULE_AUTHOR("MontaVista Software, Inc. (and others)");
719 MODULE_DESCRIPTION("TI OMAP I2C bus adapter");
720 MODULE_LICENSE("GPL");