2 * TI OMAP I2C master mode driver
4 * Copyright (C) 2003 MontaVista Software, Inc.
5 * Copyright (C) 2005 Nokia Corporation
6 * Copyright (C) 2004 - 2007 Texas Instruments.
8 * Originally written by MontaVista Software, Inc.
9 * Additional contributions by:
10 * Tony Lindgren <tony@atomide.com>
11 * Imre Deak <imre.deak@nokia.com>
12 * Juha Yrjölä <juha.yrjola@solidboot.com>
13 * Syed Khasim <x0khasim@ti.com>
14 * Nishant Menon <nm@ti.com>
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
31 #include <linux/module.h>
32 #include <linux/delay.h>
33 #include <linux/i2c.h>
34 #include <linux/err.h>
35 #include <linux/interrupt.h>
36 #include <linux/completion.h>
37 #include <linux/platform_device.h>
38 #include <linux/clk.h>
40 #include <linux/slab.h>
42 /* I2C controller revisions */
43 #define OMAP_I2C_REV_2 0x20
45 /* I2C controller revisions present on specific hardware */
46 #define OMAP_I2C_REV_ON_2430 0x36
47 #define OMAP_I2C_REV_ON_3430 0x3C
48 #define OMAP_I2C_REV_ON_4430 0x40
50 /* timeout waiting for the controller to respond */
51 #define OMAP_I2C_TIMEOUT (msecs_to_jiffies(1000))
53 /* For OMAP3 I2C_IV has changed to I2C_WE (wakeup enable) */
75 OMAP_I2C_IRQSTATUS_RAW,
76 OMAP_I2C_IRQENABLE_SET,
77 OMAP_I2C_IRQENABLE_CLR,
80 /* I2C Interrupt Enable Register (OMAP_I2C_IE): */
81 #define OMAP_I2C_IE_XDR (1 << 14) /* TX Buffer drain int enable */
82 #define OMAP_I2C_IE_RDR (1 << 13) /* RX Buffer drain int enable */
83 #define OMAP_I2C_IE_XRDY (1 << 4) /* TX data ready int enable */
84 #define OMAP_I2C_IE_RRDY (1 << 3) /* RX data ready int enable */
85 #define OMAP_I2C_IE_ARDY (1 << 2) /* Access ready int enable */
86 #define OMAP_I2C_IE_NACK (1 << 1) /* No ack interrupt enable */
87 #define OMAP_I2C_IE_AL (1 << 0) /* Arbitration lost int ena */
89 /* I2C Status Register (OMAP_I2C_STAT): */
90 #define OMAP_I2C_STAT_XDR (1 << 14) /* TX Buffer draining */
91 #define OMAP_I2C_STAT_RDR (1 << 13) /* RX Buffer draining */
92 #define OMAP_I2C_STAT_BB (1 << 12) /* Bus busy */
93 #define OMAP_I2C_STAT_ROVR (1 << 11) /* Receive overrun */
94 #define OMAP_I2C_STAT_XUDF (1 << 10) /* Transmit underflow */
95 #define OMAP_I2C_STAT_AAS (1 << 9) /* Address as slave */
96 #define OMAP_I2C_STAT_AD0 (1 << 8) /* Address zero */
97 #define OMAP_I2C_STAT_XRDY (1 << 4) /* Transmit data ready */
98 #define OMAP_I2C_STAT_RRDY (1 << 3) /* Receive data ready */
99 #define OMAP_I2C_STAT_ARDY (1 << 2) /* Register access ready */
100 #define OMAP_I2C_STAT_NACK (1 << 1) /* No ack interrupt enable */
101 #define OMAP_I2C_STAT_AL (1 << 0) /* Arbitration lost int ena */
103 /* I2C WE wakeup enable register */
104 #define OMAP_I2C_WE_XDR_WE (1 << 14) /* TX drain wakup */
105 #define OMAP_I2C_WE_RDR_WE (1 << 13) /* RX drain wakeup */
106 #define OMAP_I2C_WE_AAS_WE (1 << 9) /* Address as slave wakeup*/
107 #define OMAP_I2C_WE_BF_WE (1 << 8) /* Bus free wakeup */
108 #define OMAP_I2C_WE_STC_WE (1 << 6) /* Start condition wakeup */
109 #define OMAP_I2C_WE_GC_WE (1 << 5) /* General call wakeup */
110 #define OMAP_I2C_WE_DRDY_WE (1 << 3) /* TX/RX data ready wakeup */
111 #define OMAP_I2C_WE_ARDY_WE (1 << 2) /* Reg access ready wakeup */
112 #define OMAP_I2C_WE_NACK_WE (1 << 1) /* No acknowledgment wakeup */
113 #define OMAP_I2C_WE_AL_WE (1 << 0) /* Arbitration lost wakeup */
115 #define OMAP_I2C_WE_ALL (OMAP_I2C_WE_XDR_WE | OMAP_I2C_WE_RDR_WE | \
116 OMAP_I2C_WE_AAS_WE | OMAP_I2C_WE_BF_WE | \
117 OMAP_I2C_WE_STC_WE | OMAP_I2C_WE_GC_WE | \
118 OMAP_I2C_WE_DRDY_WE | OMAP_I2C_WE_ARDY_WE | \
119 OMAP_I2C_WE_NACK_WE | OMAP_I2C_WE_AL_WE)
121 /* I2C Buffer Configuration Register (OMAP_I2C_BUF): */
122 #define OMAP_I2C_BUF_RDMA_EN (1 << 15) /* RX DMA channel enable */
123 #define OMAP_I2C_BUF_RXFIF_CLR (1 << 14) /* RX FIFO Clear */
124 #define OMAP_I2C_BUF_XDMA_EN (1 << 7) /* TX DMA channel enable */
125 #define OMAP_I2C_BUF_TXFIF_CLR (1 << 6) /* TX FIFO Clear */
127 /* I2C Configuration Register (OMAP_I2C_CON): */
128 #define OMAP_I2C_CON_EN (1 << 15) /* I2C module enable */
129 #define OMAP_I2C_CON_BE (1 << 14) /* Big endian mode */
130 #define OMAP_I2C_CON_OPMODE_HS (1 << 12) /* High Speed support */
131 #define OMAP_I2C_CON_STB (1 << 11) /* Start byte mode (master) */
132 #define OMAP_I2C_CON_MST (1 << 10) /* Master/slave mode */
133 #define OMAP_I2C_CON_TRX (1 << 9) /* TX/RX mode (master only) */
134 #define OMAP_I2C_CON_XA (1 << 8) /* Expand address */
135 #define OMAP_I2C_CON_RM (1 << 2) /* Repeat mode (master only) */
136 #define OMAP_I2C_CON_STP (1 << 1) /* Stop cond (master only) */
137 #define OMAP_I2C_CON_STT (1 << 0) /* Start condition (master) */
139 /* I2C SCL time value when Master */
140 #define OMAP_I2C_SCLL_HSSCLL 8
141 #define OMAP_I2C_SCLH_HSSCLH 8
143 /* I2C System Test Register (OMAP_I2C_SYSTEST): */
145 #define OMAP_I2C_SYSTEST_ST_EN (1 << 15) /* System test enable */
146 #define OMAP_I2C_SYSTEST_FREE (1 << 14) /* Free running mode */
147 #define OMAP_I2C_SYSTEST_TMODE_MASK (3 << 12) /* Test mode select */
148 #define OMAP_I2C_SYSTEST_TMODE_SHIFT (12) /* Test mode select */
149 #define OMAP_I2C_SYSTEST_SCL_I (1 << 3) /* SCL line sense in */
150 #define OMAP_I2C_SYSTEST_SCL_O (1 << 2) /* SCL line drive out */
151 #define OMAP_I2C_SYSTEST_SDA_I (1 << 1) /* SDA line sense in */
152 #define OMAP_I2C_SYSTEST_SDA_O (1 << 0) /* SDA line drive out */
155 /* OCP_SYSSTATUS bit definitions */
156 #define SYSS_RESETDONE_MASK (1 << 0)
158 /* OCP_SYSCONFIG bit definitions */
159 #define SYSC_CLOCKACTIVITY_MASK (0x3 << 8)
160 #define SYSC_SIDLEMODE_MASK (0x3 << 3)
161 #define SYSC_ENAWAKEUP_MASK (1 << 2)
162 #define SYSC_SOFTRESET_MASK (1 << 1)
163 #define SYSC_AUTOIDLE_MASK (1 << 0)
165 #define SYSC_IDLEMODE_SMART 0x2
166 #define SYSC_CLOCKACTIVITY_FCLK 0x2
169 struct omap_i2c_dev {
171 void __iomem *base; /* virtual */
173 int reg_shift; /* bit shift for I2C register addresses */
174 struct clk *iclk; /* Interface clock */
175 struct clk *fclk; /* Functional clock */
176 struct completion cmd_complete;
177 struct resource *ioarea;
178 u32 speed; /* Speed of bus in Khz */
183 struct i2c_adapter adapter;
184 u8 fifo_size; /* use as flag and value
185 * fifo_size==0 implies no fifo
186 * if set, should be trsh+1
189 unsigned b_hw:1; /* bad h/w fixes */
191 u16 iestate; /* Saved interrupt register */
200 const static u8 reg_map[] = {
201 [OMAP_I2C_REV_REG] = 0x00,
202 [OMAP_I2C_IE_REG] = 0x01,
203 [OMAP_I2C_STAT_REG] = 0x02,
204 [OMAP_I2C_IV_REG] = 0x03,
205 [OMAP_I2C_WE_REG] = 0x03,
206 [OMAP_I2C_SYSS_REG] = 0x04,
207 [OMAP_I2C_BUF_REG] = 0x05,
208 [OMAP_I2C_CNT_REG] = 0x06,
209 [OMAP_I2C_DATA_REG] = 0x07,
210 [OMAP_I2C_SYSC_REG] = 0x08,
211 [OMAP_I2C_CON_REG] = 0x09,
212 [OMAP_I2C_OA_REG] = 0x0a,
213 [OMAP_I2C_SA_REG] = 0x0b,
214 [OMAP_I2C_PSC_REG] = 0x0c,
215 [OMAP_I2C_SCLL_REG] = 0x0d,
216 [OMAP_I2C_SCLH_REG] = 0x0e,
217 [OMAP_I2C_SYSTEST_REG] = 0x0f,
218 [OMAP_I2C_BUFSTAT_REG] = 0x10,
221 const static u8 omap4_reg_map[] = {
222 [OMAP_I2C_REV_REG] = 0x04,
223 [OMAP_I2C_IE_REG] = 0x2c,
224 [OMAP_I2C_STAT_REG] = 0x28,
225 [OMAP_I2C_IV_REG] = 0x34,
226 [OMAP_I2C_WE_REG] = 0x34,
227 [OMAP_I2C_SYSS_REG] = 0x90,
228 [OMAP_I2C_BUF_REG] = 0x94,
229 [OMAP_I2C_CNT_REG] = 0x98,
230 [OMAP_I2C_DATA_REG] = 0x9c,
231 [OMAP_I2C_SYSC_REG] = 0x20,
232 [OMAP_I2C_CON_REG] = 0xa4,
233 [OMAP_I2C_OA_REG] = 0xa8,
234 [OMAP_I2C_SA_REG] = 0xac,
235 [OMAP_I2C_PSC_REG] = 0xb0,
236 [OMAP_I2C_SCLL_REG] = 0xb4,
237 [OMAP_I2C_SCLH_REG] = 0xb8,
238 [OMAP_I2C_SYSTEST_REG] = 0xbC,
239 [OMAP_I2C_BUFSTAT_REG] = 0xc0,
240 [OMAP_I2C_REVNB_LO] = 0x00,
241 [OMAP_I2C_REVNB_HI] = 0x04,
242 [OMAP_I2C_IRQSTATUS_RAW] = 0x24,
243 [OMAP_I2C_IRQENABLE_SET] = 0x2c,
244 [OMAP_I2C_IRQENABLE_CLR] = 0x30,
247 static inline void omap_i2c_write_reg(struct omap_i2c_dev *i2c_dev,
250 __raw_writew(val, i2c_dev->base +
251 (i2c_dev->regs[reg] << i2c_dev->reg_shift));
254 static inline u16 omap_i2c_read_reg(struct omap_i2c_dev *i2c_dev, int reg)
256 return __raw_readw(i2c_dev->base +
257 (i2c_dev->regs[reg] << i2c_dev->reg_shift));
260 static int __init omap_i2c_get_clocks(struct omap_i2c_dev *dev)
264 dev->iclk = clk_get(dev->dev, "ick");
265 if (IS_ERR(dev->iclk)) {
266 ret = PTR_ERR(dev->iclk);
271 dev->fclk = clk_get(dev->dev, "fck");
272 if (IS_ERR(dev->fclk)) {
273 ret = PTR_ERR(dev->fclk);
274 if (dev->iclk != NULL) {
285 static void omap_i2c_put_clocks(struct omap_i2c_dev *dev)
293 static void omap_i2c_unidle(struct omap_i2c_dev *dev)
297 clk_enable(dev->iclk);
298 clk_enable(dev->fclk);
299 if (cpu_is_omap34xx()) {
300 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
301 omap_i2c_write_reg(dev, OMAP_I2C_PSC_REG, dev->pscstate);
302 omap_i2c_write_reg(dev, OMAP_I2C_SCLL_REG, dev->scllstate);
303 omap_i2c_write_reg(dev, OMAP_I2C_SCLH_REG, dev->sclhstate);
304 omap_i2c_write_reg(dev, OMAP_I2C_BUF_REG, dev->bufstate);
305 omap_i2c_write_reg(dev, OMAP_I2C_SYSC_REG, dev->syscstate);
306 omap_i2c_write_reg(dev, OMAP_I2C_WE_REG, dev->westate);
307 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_EN);
312 * Don't write to this register if the IE state is 0 as it can
316 omap_i2c_write_reg(dev, OMAP_I2C_IE_REG, dev->iestate);
319 static void omap_i2c_idle(struct omap_i2c_dev *dev)
325 dev->iestate = omap_i2c_read_reg(dev, OMAP_I2C_IE_REG);
326 if (dev->rev >= OMAP_I2C_REV_ON_4430)
327 omap_i2c_write_reg(dev, OMAP_I2C_IRQENABLE_CLR, 1);
329 omap_i2c_write_reg(dev, OMAP_I2C_IE_REG, 0);
331 if (dev->rev < OMAP_I2C_REV_2) {
332 iv = omap_i2c_read_reg(dev, OMAP_I2C_IV_REG); /* Read clears */
334 omap_i2c_write_reg(dev, OMAP_I2C_STAT_REG, dev->iestate);
336 /* Flush posted write before the dev->idle store occurs */
337 omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG);
340 clk_disable(dev->fclk);
341 clk_disable(dev->iclk);
344 static int omap_i2c_init(struct omap_i2c_dev *dev)
346 u16 psc = 0, scll = 0, sclh = 0, buf = 0;
347 u16 fsscll = 0, fssclh = 0, hsscll = 0, hssclh = 0;
348 unsigned long fclk_rate = 12000000;
349 unsigned long timeout;
350 unsigned long internal_clk = 0;
352 if (dev->rev >= OMAP_I2C_REV_2) {
353 /* Disable I2C controller before soft reset */
354 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG,
355 omap_i2c_read_reg(dev, OMAP_I2C_CON_REG) &
358 omap_i2c_write_reg(dev, OMAP_I2C_SYSC_REG, SYSC_SOFTRESET_MASK);
359 /* For some reason we need to set the EN bit before the
360 * reset done bit gets set. */
361 timeout = jiffies + OMAP_I2C_TIMEOUT;
362 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_EN);
363 while (!(omap_i2c_read_reg(dev, OMAP_I2C_SYSS_REG) &
364 SYSS_RESETDONE_MASK)) {
365 if (time_after(jiffies, timeout)) {
366 dev_warn(dev->dev, "timeout waiting "
367 "for controller reset\n");
373 /* SYSC register is cleared by the reset; rewrite it */
374 if (dev->rev == OMAP_I2C_REV_ON_2430) {
376 omap_i2c_write_reg(dev, OMAP_I2C_SYSC_REG,
379 } else if (dev->rev >= OMAP_I2C_REV_ON_3430) {
380 dev->syscstate = SYSC_AUTOIDLE_MASK;
381 dev->syscstate |= SYSC_ENAWAKEUP_MASK;
382 dev->syscstate |= (SYSC_IDLEMODE_SMART <<
383 __ffs(SYSC_SIDLEMODE_MASK));
384 dev->syscstate |= (SYSC_CLOCKACTIVITY_FCLK <<
385 __ffs(SYSC_CLOCKACTIVITY_MASK));
387 omap_i2c_write_reg(dev, OMAP_I2C_SYSC_REG,
390 * Enabling all wakup sources to stop I2C freezing on
392 * REVISIT: Some wkup sources might not be needed.
394 dev->westate = OMAP_I2C_WE_ALL;
395 if (dev->rev < OMAP_I2C_REV_ON_4430)
396 omap_i2c_write_reg(dev, OMAP_I2C_WE_REG,
400 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
402 if (cpu_class_is_omap1()) {
404 * The I2C functional clock is the armxor_ck, so there's
405 * no need to get "armxor_ck" separately. Now, if OMAP2420
406 * always returns 12MHz for the functional clock, we can
407 * do this bit unconditionally.
409 fclk_rate = clk_get_rate(dev->fclk);
411 /* TRM for 5912 says the I2C clock must be prescaled to be
412 * between 7 - 12 MHz. The XOR input clock is typically
413 * 12, 13 or 19.2 MHz. So we should have code that produces:
415 * XOR MHz Divider Prescaler
420 if (fclk_rate > 12000000)
421 psc = fclk_rate / 12000000;
424 if (!(cpu_class_is_omap1() || cpu_is_omap2420())) {
427 * HSI2C controller internal clk rate should be 19.2 Mhz for
428 * HS and for all modes on 2430. On 34xx we can use lower rate
429 * to get longer filter period for better noise suppression.
430 * The filter is iclk (fclk for HS) period.
432 if (dev->speed > 400 || cpu_is_omap2430())
433 internal_clk = 19200;
434 else if (dev->speed > 100)
438 fclk_rate = clk_get_rate(dev->fclk) / 1000;
440 /* Compute prescaler divisor */
441 psc = fclk_rate / internal_clk;
444 /* If configured for High Speed */
445 if (dev->speed > 400) {
448 /* For first phase of HS mode */
449 scl = internal_clk / 400;
450 fsscll = scl - (scl / 3) - 7;
451 fssclh = (scl / 3) - 5;
453 /* For second phase of HS mode */
454 scl = fclk_rate / dev->speed;
455 hsscll = scl - (scl / 3) - 7;
456 hssclh = (scl / 3) - 5;
457 } else if (dev->speed > 100) {
461 scl = internal_clk / dev->speed;
462 fsscll = scl - (scl / 3) - 7;
463 fssclh = (scl / 3) - 5;
466 fsscll = internal_clk / (dev->speed * 2) - 7;
467 fssclh = internal_clk / (dev->speed * 2) - 5;
469 scll = (hsscll << OMAP_I2C_SCLL_HSSCLL) | fsscll;
470 sclh = (hssclh << OMAP_I2C_SCLH_HSSCLH) | fssclh;
472 /* Program desired operating rate */
473 fclk_rate /= (psc + 1) * 1000;
476 scll = fclk_rate / (dev->speed * 2) - 7 + psc;
477 sclh = fclk_rate / (dev->speed * 2) - 7 + psc;
480 /* Setup clock prescaler to obtain approx 12MHz I2C module clock: */
481 omap_i2c_write_reg(dev, OMAP_I2C_PSC_REG, psc);
483 /* SCL low and high time values */
484 omap_i2c_write_reg(dev, OMAP_I2C_SCLL_REG, scll);
485 omap_i2c_write_reg(dev, OMAP_I2C_SCLH_REG, sclh);
487 if (dev->fifo_size) {
488 /* Note: setup required fifo size - 1. RTRSH and XTRSH */
489 buf = (dev->fifo_size - 1) << 8 | OMAP_I2C_BUF_RXFIF_CLR |
490 (dev->fifo_size - 1) | OMAP_I2C_BUF_TXFIF_CLR;
491 omap_i2c_write_reg(dev, OMAP_I2C_BUF_REG, buf);
494 /* Take the I2C module out of reset: */
495 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_EN);
497 /* Enable interrupts */
498 dev->iestate = (OMAP_I2C_IE_XRDY | OMAP_I2C_IE_RRDY |
499 OMAP_I2C_IE_ARDY | OMAP_I2C_IE_NACK |
500 OMAP_I2C_IE_AL) | ((dev->fifo_size) ?
501 (OMAP_I2C_IE_RDR | OMAP_I2C_IE_XDR) : 0);
502 omap_i2c_write_reg(dev, OMAP_I2C_IE_REG, dev->iestate);
503 if (cpu_is_omap34xx()) {
505 dev->scllstate = scll;
506 dev->sclhstate = sclh;
513 * Waiting on Bus Busy
515 static int omap_i2c_wait_for_bb(struct omap_i2c_dev *dev)
517 unsigned long timeout;
519 timeout = jiffies + OMAP_I2C_TIMEOUT;
520 while (omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG) & OMAP_I2C_STAT_BB) {
521 if (time_after(jiffies, timeout)) {
522 dev_warn(dev->dev, "timeout waiting for bus ready\n");
532 * Low level master read/write transaction.
534 static int omap_i2c_xfer_msg(struct i2c_adapter *adap,
535 struct i2c_msg *msg, int stop)
537 struct omap_i2c_dev *dev = i2c_get_adapdata(adap);
541 dev_dbg(dev->dev, "addr: 0x%04x, len: %d, flags: 0x%x, stop: %d\n",
542 msg->addr, msg->len, msg->flags, stop);
547 omap_i2c_write_reg(dev, OMAP_I2C_SA_REG, msg->addr);
549 /* REVISIT: Could the STB bit of I2C_CON be used with probing? */
551 dev->buf_len = msg->len;
553 omap_i2c_write_reg(dev, OMAP_I2C_CNT_REG, dev->buf_len);
555 /* Clear the FIFO Buffers */
556 w = omap_i2c_read_reg(dev, OMAP_I2C_BUF_REG);
557 w |= OMAP_I2C_BUF_RXFIF_CLR | OMAP_I2C_BUF_TXFIF_CLR;
558 omap_i2c_write_reg(dev, OMAP_I2C_BUF_REG, w);
560 init_completion(&dev->cmd_complete);
563 w = OMAP_I2C_CON_EN | OMAP_I2C_CON_MST | OMAP_I2C_CON_STT;
565 /* High speed configuration */
566 if (dev->speed > 400)
567 w |= OMAP_I2C_CON_OPMODE_HS;
569 if (msg->flags & I2C_M_TEN)
570 w |= OMAP_I2C_CON_XA;
571 if (!(msg->flags & I2C_M_RD))
572 w |= OMAP_I2C_CON_TRX;
574 if (!dev->b_hw && stop)
575 w |= OMAP_I2C_CON_STP;
577 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);
580 * Don't write stt and stp together on some hardware.
582 if (dev->b_hw && stop) {
583 unsigned long delay = jiffies + OMAP_I2C_TIMEOUT;
584 u16 con = omap_i2c_read_reg(dev, OMAP_I2C_CON_REG);
585 while (con & OMAP_I2C_CON_STT) {
586 con = omap_i2c_read_reg(dev, OMAP_I2C_CON_REG);
588 /* Let the user know if i2c is in a bad state */
589 if (time_after(jiffies, delay)) {
590 dev_err(dev->dev, "controller timed out "
591 "waiting for start condition to finish\n");
597 w |= OMAP_I2C_CON_STP;
598 w &= ~OMAP_I2C_CON_STT;
599 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);
603 * REVISIT: We should abort the transfer on signals, but the bus goes
604 * into arbitration and we're currently unable to recover from it.
606 r = wait_for_completion_timeout(&dev->cmd_complete,
612 dev_err(dev->dev, "controller timed out\n");
617 if (likely(!dev->cmd_err))
620 /* We have an error */
621 if (dev->cmd_err & (OMAP_I2C_STAT_AL | OMAP_I2C_STAT_ROVR |
622 OMAP_I2C_STAT_XUDF)) {
627 if (dev->cmd_err & OMAP_I2C_STAT_NACK) {
628 if (msg->flags & I2C_M_IGNORE_NAK)
631 w = omap_i2c_read_reg(dev, OMAP_I2C_CON_REG);
632 w |= OMAP_I2C_CON_STP;
633 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);
642 * Prepare controller for a transaction and call omap_i2c_xfer_msg
643 * to do the work during IRQ processing.
646 omap_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
648 struct omap_i2c_dev *dev = i2c_get_adapdata(adap);
652 omap_i2c_unidle(dev);
654 r = omap_i2c_wait_for_bb(dev);
658 for (i = 0; i < num; i++) {
659 r = omap_i2c_xfer_msg(adap, &msgs[i], (i == (num - 1)));
672 omap_i2c_func(struct i2c_adapter *adap)
674 return I2C_FUNC_I2C | (I2C_FUNC_SMBUS_EMUL & ~I2C_FUNC_SMBUS_QUICK);
678 omap_i2c_complete_cmd(struct omap_i2c_dev *dev, u16 err)
681 complete(&dev->cmd_complete);
685 omap_i2c_ack_stat(struct omap_i2c_dev *dev, u16 stat)
687 omap_i2c_write_reg(dev, OMAP_I2C_STAT_REG, stat);
690 /* rev1 devices are apparently only on some 15xx */
691 #ifdef CONFIG_ARCH_OMAP15XX
694 omap_i2c_rev1_isr(int this_irq, void *dev_id)
696 struct omap_i2c_dev *dev = dev_id;
702 iv = omap_i2c_read_reg(dev, OMAP_I2C_IV_REG);
704 case 0x00: /* None */
706 case 0x01: /* Arbitration lost */
707 dev_err(dev->dev, "Arbitration lost\n");
708 omap_i2c_complete_cmd(dev, OMAP_I2C_STAT_AL);
710 case 0x02: /* No acknowledgement */
711 omap_i2c_complete_cmd(dev, OMAP_I2C_STAT_NACK);
712 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_STP);
714 case 0x03: /* Register access ready */
715 omap_i2c_complete_cmd(dev, 0);
717 case 0x04: /* Receive data ready */
719 w = omap_i2c_read_reg(dev, OMAP_I2C_DATA_REG);
723 *dev->buf++ = w >> 8;
727 dev_err(dev->dev, "RRDY IRQ while no data requested\n");
729 case 0x05: /* Transmit data ready */
734 w |= *dev->buf++ << 8;
737 omap_i2c_write_reg(dev, OMAP_I2C_DATA_REG, w);
739 dev_err(dev->dev, "XRDY IRQ while no data to send\n");
748 #define omap_i2c_rev1_isr NULL
752 omap_i2c_isr(int this_irq, void *dev_id)
754 struct omap_i2c_dev *dev = dev_id;
762 bits = omap_i2c_read_reg(dev, OMAP_I2C_IE_REG);
763 while ((stat = (omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG))) & bits) {
764 dev_dbg(dev->dev, "IRQ (ISR = 0x%04x)\n", stat);
765 if (count++ == 100) {
766 dev_warn(dev->dev, "Too much work in one IRQ\n");
773 * Ack the stat in one go, but [R/X]DR and [R/X]RDY should be
774 * acked after the data operation is complete.
775 * Ref: TRM SWPU114Q Figure 18-31
777 omap_i2c_write_reg(dev, OMAP_I2C_STAT_REG, stat &
778 ~(OMAP_I2C_STAT_RRDY | OMAP_I2C_STAT_RDR |
779 OMAP_I2C_STAT_XRDY | OMAP_I2C_STAT_XDR));
781 if (stat & OMAP_I2C_STAT_NACK) {
782 err |= OMAP_I2C_STAT_NACK;
783 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG,
786 if (stat & OMAP_I2C_STAT_AL) {
787 dev_err(dev->dev, "Arbitration lost\n");
788 err |= OMAP_I2C_STAT_AL;
790 if (stat & (OMAP_I2C_STAT_ARDY | OMAP_I2C_STAT_NACK |
792 omap_i2c_ack_stat(dev, stat &
793 (OMAP_I2C_STAT_RRDY | OMAP_I2C_STAT_RDR |
794 OMAP_I2C_STAT_XRDY | OMAP_I2C_STAT_XDR));
795 omap_i2c_complete_cmd(dev, err);
798 if (stat & (OMAP_I2C_STAT_RRDY | OMAP_I2C_STAT_RDR)) {
800 if (dev->fifo_size) {
801 if (stat & OMAP_I2C_STAT_RRDY)
802 num_bytes = dev->fifo_size;
803 else /* read RXSTAT on RDR interrupt */
804 num_bytes = (omap_i2c_read_reg(dev,
805 OMAP_I2C_BUFSTAT_REG)
810 w = omap_i2c_read_reg(dev, OMAP_I2C_DATA_REG);
815 * Data reg in 2430, omap3 and
816 * omap4 is 8 bit wide
818 if (cpu_class_is_omap1() ||
821 *dev->buf++ = w >> 8;
826 if (stat & OMAP_I2C_STAT_RRDY)
828 "RRDY IRQ while no data"
830 if (stat & OMAP_I2C_STAT_RDR)
832 "RDR IRQ while no data"
837 omap_i2c_ack_stat(dev,
838 stat & (OMAP_I2C_STAT_RRDY | OMAP_I2C_STAT_RDR));
841 if (stat & (OMAP_I2C_STAT_XRDY | OMAP_I2C_STAT_XDR)) {
843 if (dev->fifo_size) {
844 if (stat & OMAP_I2C_STAT_XRDY)
845 num_bytes = dev->fifo_size;
846 else /* read TXSTAT on XDR interrupt */
847 num_bytes = omap_i2c_read_reg(dev,
848 OMAP_I2C_BUFSTAT_REG)
858 * Data reg in 2430, omap3 and
859 * omap4 is 8 bit wide
861 if (cpu_class_is_omap1() ||
864 w |= *dev->buf++ << 8;
869 if (stat & OMAP_I2C_STAT_XRDY)
873 if (stat & OMAP_I2C_STAT_XDR)
881 * OMAP3430 Errata 1.153: When an XRDY/XDR
882 * is hit, wait for XUDF before writing data
883 * to DATA_REG. Otherwise some data bytes can
884 * be lost while transferring them from the
885 * memory to the I2C interface.
888 if (dev->rev <= OMAP_I2C_REV_ON_3430) {
889 while (!(stat & OMAP_I2C_STAT_XUDF)) {
890 if (stat & (OMAP_I2C_STAT_NACK | OMAP_I2C_STAT_AL)) {
891 omap_i2c_ack_stat(dev, stat & (OMAP_I2C_STAT_XRDY | OMAP_I2C_STAT_XDR));
892 err |= OMAP_I2C_STAT_XUDF;
896 stat = omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG);
900 omap_i2c_write_reg(dev, OMAP_I2C_DATA_REG, w);
902 omap_i2c_ack_stat(dev,
903 stat & (OMAP_I2C_STAT_XRDY | OMAP_I2C_STAT_XDR));
906 if (stat & OMAP_I2C_STAT_ROVR) {
907 dev_err(dev->dev, "Receive overrun\n");
908 dev->cmd_err |= OMAP_I2C_STAT_ROVR;
910 if (stat & OMAP_I2C_STAT_XUDF) {
911 dev_err(dev->dev, "Transmit underflow\n");
912 dev->cmd_err |= OMAP_I2C_STAT_XUDF;
916 return count ? IRQ_HANDLED : IRQ_NONE;
919 static const struct i2c_algorithm omap_i2c_algo = {
920 .master_xfer = omap_i2c_xfer,
921 .functionality = omap_i2c_func,
925 omap_i2c_probe(struct platform_device *pdev)
927 struct omap_i2c_dev *dev;
928 struct i2c_adapter *adap;
929 struct resource *mem, *irq, *ioarea;
934 /* NOTE: driver uses the static register mapping */
935 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
937 dev_err(&pdev->dev, "no mem resource?\n");
940 irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
942 dev_err(&pdev->dev, "no irq resource?\n");
946 ioarea = request_mem_region(mem->start, resource_size(mem),
949 dev_err(&pdev->dev, "I2C region already claimed\n");
953 dev = kzalloc(sizeof(struct omap_i2c_dev), GFP_KERNEL);
956 goto err_release_region;
959 if (pdev->dev.platform_data != NULL)
960 speed = *(u32 *)pdev->dev.platform_data;
962 speed = 100; /* Defualt speed */
966 dev->dev = &pdev->dev;
967 dev->irq = irq->start;
968 dev->base = ioremap(mem->start, resource_size(mem));
974 platform_set_drvdata(pdev, dev);
976 if (cpu_is_omap7xx())
978 else if (cpu_is_omap44xx())
983 if ((r = omap_i2c_get_clocks(dev)) != 0)
986 if (cpu_is_omap44xx())
987 dev->regs = (u8 *) omap4_reg_map;
989 dev->regs = (u8 *) reg_map;
991 omap_i2c_unidle(dev);
993 dev->rev = omap_i2c_read_reg(dev, OMAP_I2C_REV_REG) & 0xff;
995 if (!(cpu_class_is_omap1() || cpu_is_omap2420())) {
998 /* Set up the fifo size - Get total size */
999 s = (omap_i2c_read_reg(dev, OMAP_I2C_BUFSTAT_REG) >> 14) & 0x3;
1000 dev->fifo_size = 0x8 << s;
1003 * Set up notification threshold as half the total available
1004 * size. This is to ensure that we can handle the status on int
1005 * call back latencies.
1007 if (dev->rev >= OMAP_I2C_REV_ON_4430) {
1009 dev->b_hw = 0; /* Disable hardware fixes */
1011 dev->fifo_size = (dev->fifo_size / 2);
1012 dev->b_hw = 1; /* Enable hardware fixes */
1016 /* reset ASAP, clearing any IRQs */
1019 isr = (dev->rev < OMAP_I2C_REV_2) ? omap_i2c_rev1_isr : omap_i2c_isr;
1020 r = request_irq(dev->irq, isr, 0, pdev->name, dev);
1023 dev_err(dev->dev, "failure requesting irq %i\n", dev->irq);
1024 goto err_unuse_clocks;
1027 dev_info(dev->dev, "bus %d rev%d.%d at %d kHz\n",
1028 pdev->id, dev->rev >> 4, dev->rev & 0xf, dev->speed);
1032 adap = &dev->adapter;
1033 i2c_set_adapdata(adap, dev);
1034 adap->owner = THIS_MODULE;
1035 adap->class = I2C_CLASS_HWMON;
1036 strlcpy(adap->name, "OMAP I2C adapter", sizeof(adap->name));
1037 adap->algo = &omap_i2c_algo;
1038 adap->dev.parent = &pdev->dev;
1040 /* i2c device drivers may be active on return from add_adapter() */
1041 adap->nr = pdev->id;
1042 r = i2c_add_numbered_adapter(adap);
1044 dev_err(dev->dev, "failure adding adapter\n");
1051 free_irq(dev->irq, dev);
1053 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
1055 omap_i2c_put_clocks(dev);
1059 platform_set_drvdata(pdev, NULL);
1062 release_mem_region(mem->start, resource_size(mem));
1068 omap_i2c_remove(struct platform_device *pdev)
1070 struct omap_i2c_dev *dev = platform_get_drvdata(pdev);
1071 struct resource *mem;
1073 platform_set_drvdata(pdev, NULL);
1075 free_irq(dev->irq, dev);
1076 i2c_del_adapter(&dev->adapter);
1077 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
1078 omap_i2c_put_clocks(dev);
1081 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1082 release_mem_region(mem->start, resource_size(mem));
1086 static struct platform_driver omap_i2c_driver = {
1087 .probe = omap_i2c_probe,
1088 .remove = omap_i2c_remove,
1091 .owner = THIS_MODULE,
1095 /* I2C may be needed to bring up other drivers */
1097 omap_i2c_init_driver(void)
1099 return platform_driver_register(&omap_i2c_driver);
1101 subsys_initcall(omap_i2c_init_driver);
1103 static void __exit omap_i2c_exit_driver(void)
1105 platform_driver_unregister(&omap_i2c_driver);
1107 module_exit(omap_i2c_exit_driver);
1109 MODULE_AUTHOR("MontaVista Software, Inc. (and others)");
1110 MODULE_DESCRIPTION("TI OMAP I2C bus adapter");
1111 MODULE_LICENSE("GPL");
1112 MODULE_ALIAS("platform:i2c_omap");