2 * TI DAVINCI I2C adapter driver.
4 * Copyright (C) 2006 Texas Instruments.
5 * Copyright (C) 2007 MontaVista Software Inc.
7 * Updated by Vinod & Sudhakar Feb 2005
9 * ----------------------------------------------------------------------------
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 * ----------------------------------------------------------------------------
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/delay.h>
30 #include <linux/i2c.h>
31 #include <linux/clk.h>
32 #include <linux/errno.h>
33 #include <linux/sched.h>
34 #include <linux/err.h>
35 #include <linux/interrupt.h>
36 #include <linux/platform_device.h>
39 #include <asm/hardware.h>
40 #include <asm/mach-types.h>
42 #include <asm/arch/i2c.h>
44 /* ----- global defines ----------------------------------------------- */
46 #define DAVINCI_I2C_TIMEOUT (1*HZ)
47 #define I2C_DAVINCI_INTR_ALL (DAVINCI_I2C_IMR_AAS | \
48 DAVINCI_I2C_IMR_SCD | \
49 DAVINCI_I2C_IMR_ARDY | \
50 DAVINCI_I2C_IMR_NACK | \
53 #define DAVINCI_I2C_OAR_REG 0x00
54 #define DAVINCI_I2C_IMR_REG 0x04
55 #define DAVINCI_I2C_STR_REG 0x08
56 #define DAVINCI_I2C_CLKL_REG 0x0c
57 #define DAVINCI_I2C_CLKH_REG 0x10
58 #define DAVINCI_I2C_CNT_REG 0x14
59 #define DAVINCI_I2C_DRR_REG 0x18
60 #define DAVINCI_I2C_SAR_REG 0x1c
61 #define DAVINCI_I2C_DXR_REG 0x20
62 #define DAVINCI_I2C_MDR_REG 0x24
63 #define DAVINCI_I2C_IVR_REG 0x28
64 #define DAVINCI_I2C_EMDR_REG 0x2c
65 #define DAVINCI_I2C_PSC_REG 0x30
67 #define DAVINCI_I2C_IVR_AAS 0x07
68 #define DAVINCI_I2C_IVR_SCD 0x06
69 #define DAVINCI_I2C_IVR_XRDY 0x05
70 #define DAVINCI_I2C_IVR_RDR 0x04
71 #define DAVINCI_I2C_IVR_ARDY 0x03
72 #define DAVINCI_I2C_IVR_NACK 0x02
73 #define DAVINCI_I2C_IVR_AL 0x01
75 #define DAVINCI_I2C_STR_BB (1 << 12)
76 #define DAVINCI_I2C_STR_RSFULL (1 << 11)
77 #define DAVINCI_I2C_STR_SCD (1 << 5)
78 #define DAVINCI_I2C_STR_ARDY (1 << 2)
79 #define DAVINCI_I2C_STR_NACK (1 << 1)
80 #define DAVINCI_I2C_STR_AL (1 << 0)
82 #define DAVINCI_I2C_MDR_NACK (1 << 15)
83 #define DAVINCI_I2C_MDR_STT (1 << 13)
84 #define DAVINCI_I2C_MDR_STP (1 << 11)
85 #define DAVINCI_I2C_MDR_MST (1 << 10)
86 #define DAVINCI_I2C_MDR_TRX (1 << 9)
87 #define DAVINCI_I2C_MDR_XA (1 << 8)
88 #define DAVINCI_I2C_MDR_IRS (1 << 5)
90 #define DAVINCI_I2C_IMR_AAS (1 << 6)
91 #define DAVINCI_I2C_IMR_SCD (1 << 5)
92 #define DAVINCI_I2C_IMR_XRDY (1 << 4)
93 #define DAVINCI_I2C_IMR_RRDY (1 << 3)
94 #define DAVINCI_I2C_IMR_ARDY (1 << 2)
95 #define DAVINCI_I2C_IMR_NACK (1 << 1)
96 #define DAVINCI_I2C_IMR_AL (1 << 0)
98 #define MOD_REG_BIT(val, mask, set) do { \
106 struct davinci_i2c_dev {
109 struct completion cmd_complete;
115 struct i2c_adapter adapter;
118 /* default platform data to use if not supplied in the platform_device */
119 static struct davinci_i2c_platform_data davinci_i2c_platform_data_default = {
124 static inline void davinci_i2c_write_reg(struct davinci_i2c_dev *i2c_dev,
127 __raw_writew(val, i2c_dev->base + reg);
130 static inline u16 davinci_i2c_read_reg(struct davinci_i2c_dev *i2c_dev, int reg)
132 return __raw_readw(i2c_dev->base + reg);
136 * This functions configures I2C and brings I2C out of reset.
137 * This function is called during I2C init function. This function
138 * also gets called if I2C encounters any errors.
140 static int i2c_davinci_init(struct davinci_i2c_dev *dev)
142 struct davinci_i2c_platform_data *pdata = dev->dev->platform_data;
148 u32 input_clock = clk_get_rate(dev->clk);
152 pdata = &davinci_i2c_platform_data_default;
154 /* put I2C into reset */
155 w = davinci_i2c_read_reg(dev, DAVINCI_I2C_MDR_REG);
156 MOD_REG_BIT(w, DAVINCI_I2C_MDR_IRS, 0);
157 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, w);
159 /* NOTE: I2C Clock divider programming info
160 * As per I2C specs the following formulas provide prescaler
161 * and low/high divider values
162 * input clk --> PSC Div -----------> ICCL/H Div --> output clock
165 * output clk = module clk / (PSC + 1) [ (ICCL + d) + (ICCH + d) ]
168 * (ICCL + ICCH) = clk = (input clk / ((psc +1) * output clk)) - 2d;
170 * where if PSC == 0, d = 7,
175 /* get minimum of 7 MHz clock, but max of 12 MHz */
176 psc = (input_clock / 7000000) - 1;
177 if ((input_clock / (psc + 1)) > 12000000)
178 psc++; /* better to run under spec than over */
179 d = (psc >= 2) ? 5 : 7 - psc;
181 clk = ((input_clock / (psc + 1)) / (pdata->bus_freq * 1000)) - (d << 1);
185 davinci_i2c_write_reg(dev, DAVINCI_I2C_PSC_REG, psc);
186 davinci_i2c_write_reg(dev, DAVINCI_I2C_CLKH_REG, clkh);
187 davinci_i2c_write_reg(dev, DAVINCI_I2C_CLKL_REG, clkl);
189 dev_dbg(dev->dev, "input_clock = %d, CLK = %d\n", input_clock, clk);
190 dev_dbg(dev->dev, "PSC = %d\n",
191 davinci_i2c_read_reg(dev, DAVINCI_I2C_PSC_REG));
192 dev_dbg(dev->dev, "CLKL = %d\n",
193 davinci_i2c_read_reg(dev, DAVINCI_I2C_CLKL_REG));
194 dev_dbg(dev->dev, "CLKH = %d\n",
195 davinci_i2c_read_reg(dev, DAVINCI_I2C_CLKH_REG));
196 dev_dbg(dev->dev, "bus_freq = %dkHz, bus_delay = %d\n",
197 pdata->bus_freq, pdata->bus_delay);
199 /* Take the I2C module out of reset: */
200 w = davinci_i2c_read_reg(dev, DAVINCI_I2C_MDR_REG);
201 MOD_REG_BIT(w, DAVINCI_I2C_MDR_IRS, 1);
202 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, w);
204 /* Enable interrupts */
205 davinci_i2c_write_reg(dev, DAVINCI_I2C_IMR_REG, I2C_DAVINCI_INTR_ALL);
211 * Waiting for bus not busy
213 static int i2c_davinci_wait_bus_not_busy(struct davinci_i2c_dev *dev,
216 unsigned long timeout;
218 timeout = jiffies + DAVINCI_I2C_TIMEOUT;
219 while (davinci_i2c_read_reg(dev, DAVINCI_I2C_STR_REG)
220 & DAVINCI_I2C_STR_BB) {
221 if (time_after(jiffies, timeout)) {
223 "timeout waiting for bus ready\n");
234 * Low level master read/write transaction. This function is called
235 * from i2c_davinci_xfer.
238 i2c_davinci_xfer_msg(struct i2c_adapter *adap, struct i2c_msg *msg, int stop)
240 struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
241 struct davinci_i2c_platform_data *pdata = dev->dev->platform_data;
251 pdata = &davinci_i2c_platform_data_default;
252 /* Introduce a delay, required for some boards (e.g Davinci EVM) */
253 if (pdata->bus_delay)
254 udelay(pdata->bus_delay);
256 /* set the slave address */
257 davinci_i2c_write_reg(dev, DAVINCI_I2C_SAR_REG, msg->addr);
260 dev->buf_len = msg->len;
262 davinci_i2c_write_reg(dev, DAVINCI_I2C_CNT_REG, dev->buf_len);
264 init_completion(&dev->cmd_complete);
267 /* Clear any pending interrupts by reading the IVR */
268 stat = davinci_i2c_read_reg(dev, DAVINCI_I2C_IVR_REG);
270 /* Take I2C out of reset, configure it as master and set the
272 flag = DAVINCI_I2C_MDR_IRS | DAVINCI_I2C_MDR_MST | DAVINCI_I2C_MDR_STT;
274 /* if the slave address is ten bit address, enable XA bit */
275 if (msg->flags & I2C_M_TEN)
276 flag |= DAVINCI_I2C_MDR_XA;
277 if (!(msg->flags & I2C_M_RD))
278 flag |= DAVINCI_I2C_MDR_TRX;
280 flag |= DAVINCI_I2C_MDR_STP;
282 /* Enable receive or transmit interrupts */
283 w = davinci_i2c_read_reg(dev, DAVINCI_I2C_IMR_REG);
284 if (msg->flags & I2C_M_RD)
285 MOD_REG_BIT(w, DAVINCI_I2C_IMR_RRDY, 1);
287 MOD_REG_BIT(w, DAVINCI_I2C_IMR_XRDY, 1);
288 davinci_i2c_write_reg(dev, DAVINCI_I2C_IMR_REG, w);
290 /* write the data into mode register */
291 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, flag);
293 r = wait_for_completion_interruptible_timeout(&dev->cmd_complete,
294 DAVINCI_I2C_TIMEOUT);
300 dev_err(dev->dev, "controller timed out\n");
301 i2c_davinci_init(dev);
306 if (likely(!dev->cmd_err))
309 /* We have an error */
310 if (dev->cmd_err & DAVINCI_I2C_STR_AL) {
311 i2c_davinci_init(dev);
315 if (dev->cmd_err & DAVINCI_I2C_STR_NACK) {
316 if (msg->flags & I2C_M_IGNORE_NAK)
319 w = davinci_i2c_read_reg(dev, DAVINCI_I2C_MDR_REG);
320 MOD_REG_BIT(w, DAVINCI_I2C_MDR_STP, 1);
321 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, w);
329 * Prepare controller for a transaction and call i2c_davinci_xfer_msg
332 i2c_davinci_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
334 struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
338 dev_dbg(dev->dev, "%s: msgs: %d\n", __func__, num);
340 ret = i2c_davinci_wait_bus_not_busy(dev, 1);
342 dev_warn(dev->dev, "timeout waiting for bus ready\n");
346 for (i = 0; i < num; i++) {
347 ret = i2c_davinci_xfer_msg(adap, &msgs[i], (i == (num - 1)));
352 dev_dbg(dev->dev, "%s:%d ret: %d\n", __func__, __LINE__, ret);
357 static u32 i2c_davinci_func(struct i2c_adapter *adap)
359 return I2C_FUNC_I2C | (I2C_FUNC_SMBUS_EMUL & ~I2C_FUNC_SMBUS_QUICK);
363 * Interrupt service routine. This gets called whenever an I2C interrupt
366 static irqreturn_t i2c_davinci_isr(int this_irq, void *dev_id)
368 struct davinci_i2c_dev *dev = dev_id;
373 while ((stat = davinci_i2c_read_reg(dev, DAVINCI_I2C_IVR_REG))) {
374 dev_dbg(dev->dev, "%s: stat=0x%x\n", __func__, stat);
375 if (count++ == 100) {
376 dev_warn(dev->dev, "Too much work in one IRQ\n");
381 case DAVINCI_I2C_IVR_AL:
382 dev->cmd_err |= DAVINCI_I2C_STR_AL;
383 complete(&dev->cmd_complete);
386 case DAVINCI_I2C_IVR_NACK:
387 dev->cmd_err |= DAVINCI_I2C_STR_NACK;
388 complete(&dev->cmd_complete);
391 case DAVINCI_I2C_IVR_ARDY:
392 davinci_i2c_write_reg(dev,
393 DAVINCI_I2C_STR_REG, DAVINCI_I2C_STR_ARDY);
394 complete(&dev->cmd_complete);
397 case DAVINCI_I2C_IVR_RDR:
400 davinci_i2c_read_reg(dev,
401 DAVINCI_I2C_DRR_REG);
406 davinci_i2c_write_reg(dev,
408 DAVINCI_I2C_IMR_RRDY);
410 dev_err(dev->dev, "RDR IRQ while no "
414 case DAVINCI_I2C_IVR_XRDY:
416 davinci_i2c_write_reg(dev, DAVINCI_I2C_DXR_REG,
422 w = davinci_i2c_read_reg(dev,
423 DAVINCI_I2C_IMR_REG);
424 MOD_REG_BIT(w, DAVINCI_I2C_IMR_XRDY, 0);
425 davinci_i2c_write_reg(dev,
429 dev_err(dev->dev, "TDR IRQ while no data to "
433 case DAVINCI_I2C_IVR_SCD:
434 davinci_i2c_write_reg(dev,
435 DAVINCI_I2C_STR_REG, DAVINCI_I2C_STR_SCD);
436 complete(&dev->cmd_complete);
439 case DAVINCI_I2C_IVR_AAS:
440 dev_warn(dev->dev, "Address as slave interrupt\n");
444 return count ? IRQ_HANDLED : IRQ_NONE;
447 static struct i2c_algorithm i2c_davinci_algo = {
448 .master_xfer = i2c_davinci_xfer,
449 .functionality = i2c_davinci_func,
452 static int davinci_i2c_probe(struct platform_device *pdev)
454 struct davinci_i2c_dev *dev;
455 struct i2c_adapter *adap;
456 struct resource *mem, *irq, *ioarea;
459 /* NOTE: driver uses the static register mapping */
460 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
462 dev_err(&pdev->dev, "no mem resource?\n");
466 irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
468 dev_err(&pdev->dev, "no irq resource?\n");
472 ioarea = request_mem_region(mem->start, (mem->end - mem->start) + 1,
475 dev_err(&pdev->dev, "I2C region already claimed\n");
479 dev = kzalloc(sizeof(struct davinci_i2c_dev), GFP_KERNEL);
482 goto err_release_region;
485 dev->dev = get_device(&pdev->dev);
486 dev->irq = irq->start;
487 platform_set_drvdata(pdev, dev);
489 dev->clk = clk_get(&pdev->dev, "I2CCLK");
490 if (IS_ERR(dev->clk)) {
494 clk_enable(dev->clk);
496 dev->base = (void __iomem *)IO_ADDRESS(mem->start);
497 i2c_davinci_init(dev);
499 r = request_irq(dev->irq, i2c_davinci_isr, 0, pdev->name, dev);
501 dev_err(&pdev->dev, "failure requesting irq %i\n", dev->irq);
502 goto err_unuse_clocks;
505 adap = &dev->adapter;
506 i2c_set_adapdata(adap, dev);
507 adap->owner = THIS_MODULE;
508 adap->class = I2C_CLASS_HWMON;
509 strlcpy(adap->name, "DaVinci I2C adapter", sizeof(adap->name));
510 adap->algo = &i2c_davinci_algo;
511 adap->dev.parent = &pdev->dev;
517 r = i2c_add_numbered_adapter(adap);
519 dev_err(&pdev->dev, "failure adding adapter\n");
526 free_irq(dev->irq, dev);
528 clk_disable(dev->clk);
532 platform_set_drvdata(pdev, NULL);
533 put_device(&pdev->dev);
536 release_mem_region(mem->start, (mem->end - mem->start) + 1);
541 static int davinci_i2c_remove(struct platform_device *pdev)
543 struct davinci_i2c_dev *dev = platform_get_drvdata(pdev);
544 struct resource *mem;
546 platform_set_drvdata(pdev, NULL);
547 i2c_del_adapter(&dev->adapter);
548 put_device(&pdev->dev);
550 clk_disable(dev->clk);
554 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, 0);
555 free_irq(IRQ_I2C, dev);
558 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
559 release_mem_region(mem->start, (mem->end - mem->start) + 1);
563 /* work with hotplug and coldplug */
564 MODULE_ALIAS("platform:i2c_davinci");
566 static struct platform_driver davinci_i2c_driver = {
567 .probe = davinci_i2c_probe,
568 .remove = davinci_i2c_remove,
570 .name = "i2c_davinci",
571 .owner = THIS_MODULE,
575 /* I2C may be needed to bring up other drivers */
576 static int __init davinci_i2c_init_driver(void)
578 return platform_driver_register(&davinci_i2c_driver);
580 subsys_initcall(davinci_i2c_init_driver);
582 static void __exit davinci_i2c_exit_driver(void)
584 platform_driver_unregister(&davinci_i2c_driver);
586 module_exit(davinci_i2c_exit_driver);
588 MODULE_AUTHOR("Texas Instruments India");
589 MODULE_DESCRIPTION("TI DaVinci I2C bus adapter");
590 MODULE_LICENSE("GPL");