blob: 40a1e4bc92f189b8127f6ae38a4f90a12b83282f [file] [log] [blame]
Komal Shah010d4422006-08-13 23:44:09 +02001/*
2 * TI OMAP I2C master mode driver
3 *
4 * Copyright (C) 2003 MontaVista Software, Inc.
Komal Shah010d4422006-08-13 23:44:09 +02005 * Copyright (C) 2005 Nokia Corporation
Tony Lindgrenc1a473b2008-11-21 13:39:47 -08006 * Copyright (C) 2004 - 2007 Texas Instruments.
Komal Shah010d4422006-08-13 23:44:09 +02007 *
Tony Lindgrenc1a473b2008-11-21 13:39:47 -08008 * 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>
Komal Shah010d4422006-08-13 23:44:09 +020015 *
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.
20 *
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.
25 *
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.
29 */
30
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>
Tony Lindgrenc1a473b2008-11-21 13:39:47 -080039#include <linux/io.h>
Komal Shah010d4422006-08-13 23:44:09 +020040
41/* timeout waiting for the controller to respond */
42#define OMAP_I2C_TIMEOUT (msecs_to_jiffies(1000))
43
44#define OMAP_I2C_REV_REG 0x00
45#define OMAP_I2C_IE_REG 0x04
46#define OMAP_I2C_STAT_REG 0x08
47#define OMAP_I2C_IV_REG 0x0c
48#define OMAP_I2C_SYSS_REG 0x10
49#define OMAP_I2C_BUF_REG 0x14
50#define OMAP_I2C_CNT_REG 0x18
51#define OMAP_I2C_DATA_REG 0x1c
52#define OMAP_I2C_SYSC_REG 0x20
53#define OMAP_I2C_CON_REG 0x24
54#define OMAP_I2C_OA_REG 0x28
55#define OMAP_I2C_SA_REG 0x2c
56#define OMAP_I2C_PSC_REG 0x30
57#define OMAP_I2C_SCLL_REG 0x34
58#define OMAP_I2C_SCLH_REG 0x38
59#define OMAP_I2C_SYSTEST_REG 0x3c
Nishanth Menonb6ee52c2008-11-21 13:39:46 -080060#define OMAP_I2C_BUFSTAT_REG 0x40
Komal Shah010d4422006-08-13 23:44:09 +020061
62/* I2C Interrupt Enable Register (OMAP_I2C_IE): */
Nishanth Menonb6ee52c2008-11-21 13:39:46 -080063#define OMAP_I2C_IE_XDR (1 << 14) /* TX Buffer drain int enable */
64#define OMAP_I2C_IE_RDR (1 << 13) /* RX Buffer drain int enable */
Komal Shah010d4422006-08-13 23:44:09 +020065#define OMAP_I2C_IE_XRDY (1 << 4) /* TX data ready int enable */
66#define OMAP_I2C_IE_RRDY (1 << 3) /* RX data ready int enable */
67#define OMAP_I2C_IE_ARDY (1 << 2) /* Access ready int enable */
68#define OMAP_I2C_IE_NACK (1 << 1) /* No ack interrupt enable */
69#define OMAP_I2C_IE_AL (1 << 0) /* Arbitration lost int ena */
70
71/* I2C Status Register (OMAP_I2C_STAT): */
Nishanth Menonb6ee52c2008-11-21 13:39:46 -080072#define OMAP_I2C_STAT_XDR (1 << 14) /* TX Buffer draining */
73#define OMAP_I2C_STAT_RDR (1 << 13) /* RX Buffer draining */
Komal Shah010d4422006-08-13 23:44:09 +020074#define OMAP_I2C_STAT_BB (1 << 12) /* Bus busy */
75#define OMAP_I2C_STAT_ROVR (1 << 11) /* Receive overrun */
76#define OMAP_I2C_STAT_XUDF (1 << 10) /* Transmit underflow */
77#define OMAP_I2C_STAT_AAS (1 << 9) /* Address as slave */
78#define OMAP_I2C_STAT_AD0 (1 << 8) /* Address zero */
79#define OMAP_I2C_STAT_XRDY (1 << 4) /* Transmit data ready */
80#define OMAP_I2C_STAT_RRDY (1 << 3) /* Receive data ready */
81#define OMAP_I2C_STAT_ARDY (1 << 2) /* Register access ready */
82#define OMAP_I2C_STAT_NACK (1 << 1) /* No ack interrupt enable */
83#define OMAP_I2C_STAT_AL (1 << 0) /* Arbitration lost int ena */
84
85/* I2C Buffer Configuration Register (OMAP_I2C_BUF): */
86#define OMAP_I2C_BUF_RDMA_EN (1 << 15) /* RX DMA channel enable */
Nishanth Menonb6ee52c2008-11-21 13:39:46 -080087#define OMAP_I2C_BUF_RXFIF_CLR (1 << 14) /* RX FIFO Clear */
Komal Shah010d4422006-08-13 23:44:09 +020088#define OMAP_I2C_BUF_XDMA_EN (1 << 7) /* TX DMA channel enable */
Nishanth Menonb6ee52c2008-11-21 13:39:46 -080089#define OMAP_I2C_BUF_TXFIF_CLR (1 << 6) /* TX FIFO Clear */
Komal Shah010d4422006-08-13 23:44:09 +020090
91/* I2C Configuration Register (OMAP_I2C_CON): */
92#define OMAP_I2C_CON_EN (1 << 15) /* I2C module enable */
93#define OMAP_I2C_CON_BE (1 << 14) /* Big endian mode */
Nishanth Menonb6ee52c2008-11-21 13:39:46 -080094#define OMAP_I2C_CON_OPMODE_HS (1 << 12) /* High Speed support */
Komal Shah010d4422006-08-13 23:44:09 +020095#define OMAP_I2C_CON_STB (1 << 11) /* Start byte mode (master) */
96#define OMAP_I2C_CON_MST (1 << 10) /* Master/slave mode */
97#define OMAP_I2C_CON_TRX (1 << 9) /* TX/RX mode (master only) */
98#define OMAP_I2C_CON_XA (1 << 8) /* Expand address */
99#define OMAP_I2C_CON_RM (1 << 2) /* Repeat mode (master only) */
100#define OMAP_I2C_CON_STP (1 << 1) /* Stop cond (master only) */
101#define OMAP_I2C_CON_STT (1 << 0) /* Start condition (master) */
102
Syed Mohammed Khasim4574eb62008-11-21 13:39:45 -0800103/* I2C SCL time value when Master */
104#define OMAP_I2C_SCLL_HSSCLL 8
105#define OMAP_I2C_SCLH_HSSCLH 8
106
Komal Shah010d4422006-08-13 23:44:09 +0200107/* I2C System Test Register (OMAP_I2C_SYSTEST): */
108#ifdef DEBUG
109#define OMAP_I2C_SYSTEST_ST_EN (1 << 15) /* System test enable */
110#define OMAP_I2C_SYSTEST_FREE (1 << 14) /* Free running mode */
111#define OMAP_I2C_SYSTEST_TMODE_MASK (3 << 12) /* Test mode select */
112#define OMAP_I2C_SYSTEST_TMODE_SHIFT (12) /* Test mode select */
113#define OMAP_I2C_SYSTEST_SCL_I (1 << 3) /* SCL line sense in */
114#define OMAP_I2C_SYSTEST_SCL_O (1 << 2) /* SCL line drive out */
115#define OMAP_I2C_SYSTEST_SDA_I (1 << 1) /* SDA line sense in */
116#define OMAP_I2C_SYSTEST_SDA_O (1 << 0) /* SDA line drive out */
117#endif
118
119/* I2C System Status register (OMAP_I2C_SYSS): */
120#define OMAP_I2C_SYSS_RDONE (1 << 0) /* Reset Done */
121
122/* I2C System Configuration Register (OMAP_I2C_SYSC): */
123#define OMAP_I2C_SYSC_SRST (1 << 1) /* Soft Reset */
124
Komal Shah010d4422006-08-13 23:44:09 +0200125struct omap_i2c_dev {
126 struct device *dev;
127 void __iomem *base; /* virtual */
128 int irq;
129 struct clk *iclk; /* Interface clock */
130 struct clk *fclk; /* Functional clock */
131 struct completion cmd_complete;
132 struct resource *ioarea;
Syed Mohammed Khasim4574eb62008-11-21 13:39:45 -0800133 u32 speed; /* Speed of bus in Khz */
Komal Shah010d4422006-08-13 23:44:09 +0200134 u16 cmd_err;
135 u8 *buf;
136 size_t buf_len;
137 struct i2c_adapter adapter;
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800138 u8 fifo_size; /* use as flag and value
139 * fifo_size==0 implies no fifo
140 * if set, should be trsh+1
141 */
Komal Shah010d4422006-08-13 23:44:09 +0200142 unsigned rev1:1;
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800143 unsigned b_hw:1; /* bad h/w fixes */
Tony Lindgrenf08ac4e2008-03-23 20:28:20 +0100144 unsigned idle:1;
145 u16 iestate; /* Saved interrupt register */
Komal Shah010d4422006-08-13 23:44:09 +0200146};
147
148static inline void omap_i2c_write_reg(struct omap_i2c_dev *i2c_dev,
149 int reg, u16 val)
150{
151 __raw_writew(val, i2c_dev->base + reg);
152}
153
154static inline u16 omap_i2c_read_reg(struct omap_i2c_dev *i2c_dev, int reg)
155{
156 return __raw_readw(i2c_dev->base + reg);
157}
158
Paul Walmsley510be9c2008-11-21 13:39:46 -0800159static int __init omap_i2c_get_clocks(struct omap_i2c_dev *dev)
Komal Shah010d4422006-08-13 23:44:09 +0200160{
Chandra shekhar3d522fb2008-11-21 13:39:46 -0800161 if (cpu_is_omap16xx() || cpu_class_is_omap2()) {
Komal Shah010d4422006-08-13 23:44:09 +0200162 dev->iclk = clk_get(dev->dev, "i2c_ick");
163 if (IS_ERR(dev->iclk)) {
164 dev->iclk = NULL;
165 return -ENODEV;
166 }
167 }
168
169 dev->fclk = clk_get(dev->dev, "i2c_fck");
170 if (IS_ERR(dev->fclk)) {
171 if (dev->iclk != NULL) {
172 clk_put(dev->iclk);
173 dev->iclk = NULL;
174 }
175 dev->fclk = NULL;
176 return -ENODEV;
177 }
178
179 return 0;
180}
181
182static void omap_i2c_put_clocks(struct omap_i2c_dev *dev)
183{
184 clk_put(dev->fclk);
185 dev->fclk = NULL;
186 if (dev->iclk != NULL) {
187 clk_put(dev->iclk);
188 dev->iclk = NULL;
189 }
190}
191
Tony Lindgrenf08ac4e2008-03-23 20:28:20 +0100192static void omap_i2c_unidle(struct omap_i2c_dev *dev)
Komal Shah010d4422006-08-13 23:44:09 +0200193{
Paul Walmsley3831f152008-11-21 13:39:47 -0800194 WARN_ON(!dev->idle);
195
Komal Shah010d4422006-08-13 23:44:09 +0200196 if (dev->iclk != NULL)
197 clk_enable(dev->iclk);
198 clk_enable(dev->fclk);
Paul Walmsley0cbbcff2008-11-21 13:39:45 -0800199 dev->idle = 0;
Tony Lindgrenf08ac4e2008-03-23 20:28:20 +0100200 if (dev->iestate)
201 omap_i2c_write_reg(dev, OMAP_I2C_IE_REG, dev->iestate);
Komal Shah010d4422006-08-13 23:44:09 +0200202}
203
Tony Lindgrenf08ac4e2008-03-23 20:28:20 +0100204static void omap_i2c_idle(struct omap_i2c_dev *dev)
Komal Shah010d4422006-08-13 23:44:09 +0200205{
Tony Lindgrenf08ac4e2008-03-23 20:28:20 +0100206 u16 iv;
207
Paul Walmsley3831f152008-11-21 13:39:47 -0800208 WARN_ON(dev->idle);
209
Tony Lindgrenf08ac4e2008-03-23 20:28:20 +0100210 dev->iestate = omap_i2c_read_reg(dev, OMAP_I2C_IE_REG);
211 omap_i2c_write_reg(dev, OMAP_I2C_IE_REG, 0);
Paul Walmsley0cbbcff2008-11-21 13:39:45 -0800212 if (dev->rev1) {
Tony Lindgrenc1a473b2008-11-21 13:39:47 -0800213 iv = omap_i2c_read_reg(dev, OMAP_I2C_IV_REG); /* Read clears */
Paul Walmsley0cbbcff2008-11-21 13:39:45 -0800214 } else {
Tony Lindgrenf08ac4e2008-03-23 20:28:20 +0100215 omap_i2c_write_reg(dev, OMAP_I2C_STAT_REG, dev->iestate);
Paul Walmsley0cbbcff2008-11-21 13:39:45 -0800216
217 /* Flush posted write before the dev->idle store occurs */
218 omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG);
219 }
220 dev->idle = 1;
Tony Lindgrenf08ac4e2008-03-23 20:28:20 +0100221 clk_disable(dev->fclk);
Komal Shah010d4422006-08-13 23:44:09 +0200222 if (dev->iclk != NULL)
223 clk_disable(dev->iclk);
Komal Shah010d4422006-08-13 23:44:09 +0200224}
225
226static int omap_i2c_init(struct omap_i2c_dev *dev)
227{
Syed Mohammed Khasim4574eb62008-11-21 13:39:45 -0800228 u16 psc = 0, scll = 0, sclh = 0;
229 u16 fsscll = 0, fssclh = 0, hsscll = 0, hssclh = 0;
Komal Shah010d4422006-08-13 23:44:09 +0200230 unsigned long fclk_rate = 12000000;
231 unsigned long timeout;
Syed Mohammed Khasim4574eb62008-11-21 13:39:45 -0800232 unsigned long internal_clk = 0;
Komal Shah010d4422006-08-13 23:44:09 +0200233
234 if (!dev->rev1) {
235 omap_i2c_write_reg(dev, OMAP_I2C_SYSC_REG, OMAP_I2C_SYSC_SRST);
236 /* For some reason we need to set the EN bit before the
237 * reset done bit gets set. */
238 timeout = jiffies + OMAP_I2C_TIMEOUT;
239 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_EN);
240 while (!(omap_i2c_read_reg(dev, OMAP_I2C_SYSS_REG) &
241 OMAP_I2C_SYSS_RDONE)) {
242 if (time_after(jiffies, timeout)) {
Joe Perchesfce3ff02007-12-12 13:45:24 +0100243 dev_warn(dev->dev, "timeout waiting "
Komal Shah010d4422006-08-13 23:44:09 +0200244 "for controller reset\n");
245 return -ETIMEDOUT;
246 }
247 msleep(1);
248 }
249 }
250 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
251
252 if (cpu_class_is_omap1()) {
253 struct clk *armxor_ck;
254
255 armxor_ck = clk_get(NULL, "armxor_ck");
256 if (IS_ERR(armxor_ck))
257 dev_warn(dev->dev, "Could not get armxor_ck\n");
258 else {
259 fclk_rate = clk_get_rate(armxor_ck);
260 clk_put(armxor_ck);
261 }
262 /* TRM for 5912 says the I2C clock must be prescaled to be
263 * between 7 - 12 MHz. The XOR input clock is typically
264 * 12, 13 or 19.2 MHz. So we should have code that produces:
265 *
266 * XOR MHz Divider Prescaler
267 * 12 1 0
268 * 13 2 1
269 * 19.2 2 1
270 */
Jean Delvared7aef132006-12-10 21:21:34 +0100271 if (fclk_rate > 12000000)
272 psc = fclk_rate / 12000000;
Komal Shah010d4422006-08-13 23:44:09 +0200273 }
274
Chandra shekhar3d522fb2008-11-21 13:39:46 -0800275 if (cpu_is_omap2430() || cpu_is_omap34xx()) {
Syed Mohammed Khasim4574eb62008-11-21 13:39:45 -0800276
277 /* HSI2C controller internal clk rate should be 19.2 Mhz */
278 internal_clk = 19200;
279 fclk_rate = clk_get_rate(dev->fclk) / 1000;
280
281 /* Compute prescaler divisor */
282 psc = fclk_rate / internal_clk;
283 psc = psc - 1;
284
285 /* If configured for High Speed */
286 if (dev->speed > 400) {
287 /* For first phase of HS mode */
288 fsscll = internal_clk / (400 * 2) - 6;
289 fssclh = internal_clk / (400 * 2) - 6;
290
291 /* For second phase of HS mode */
292 hsscll = fclk_rate / (dev->speed * 2) - 6;
293 hssclh = fclk_rate / (dev->speed * 2) - 6;
294 } else {
295 /* To handle F/S modes */
296 fsscll = internal_clk / (dev->speed * 2) - 6;
297 fssclh = internal_clk / (dev->speed * 2) - 6;
298 }
299 scll = (hsscll << OMAP_I2C_SCLL_HSSCLL) | fsscll;
300 sclh = (hssclh << OMAP_I2C_SCLH_HSSCLH) | fssclh;
301 } else {
302 /* Program desired operating rate */
303 fclk_rate /= (psc + 1) * 1000;
304 if (psc > 2)
305 psc = 2;
306 scll = fclk_rate / (dev->speed * 2) - 7 + psc;
307 sclh = fclk_rate / (dev->speed * 2) - 7 + psc;
308 }
309
Komal Shah010d4422006-08-13 23:44:09 +0200310 /* Setup clock prescaler to obtain approx 12MHz I2C module clock: */
311 omap_i2c_write_reg(dev, OMAP_I2C_PSC_REG, psc);
312
Syed Mohammed Khasim4574eb62008-11-21 13:39:45 -0800313 /* SCL low and high time values */
314 omap_i2c_write_reg(dev, OMAP_I2C_SCLL_REG, scll);
315 omap_i2c_write_reg(dev, OMAP_I2C_SCLH_REG, sclh);
Komal Shah010d4422006-08-13 23:44:09 +0200316
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800317 if (dev->fifo_size)
318 /* Note: setup required fifo size - 1 */
319 omap_i2c_write_reg(dev, OMAP_I2C_BUF_REG,
320 (dev->fifo_size - 1) << 8 | /* RTRSH */
321 OMAP_I2C_BUF_RXFIF_CLR |
322 (dev->fifo_size - 1) | /* XTRSH */
323 OMAP_I2C_BUF_TXFIF_CLR);
324
Komal Shah010d4422006-08-13 23:44:09 +0200325 /* Take the I2C module out of reset: */
326 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_EN);
327
328 /* Enable interrupts */
329 omap_i2c_write_reg(dev, OMAP_I2C_IE_REG,
Tony Lindgrenc1a473b2008-11-21 13:39:47 -0800330 (OMAP_I2C_IE_XRDY | OMAP_I2C_IE_RRDY |
331 OMAP_I2C_IE_ARDY | OMAP_I2C_IE_NACK |
332 OMAP_I2C_IE_AL) | ((dev->fifo_size) ?
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800333 (OMAP_I2C_IE_RDR | OMAP_I2C_IE_XDR) : 0));
Komal Shah010d4422006-08-13 23:44:09 +0200334 return 0;
335}
336
337/*
338 * Waiting on Bus Busy
339 */
340static int omap_i2c_wait_for_bb(struct omap_i2c_dev *dev)
341{
342 unsigned long timeout;
343
344 timeout = jiffies + OMAP_I2C_TIMEOUT;
345 while (omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG) & OMAP_I2C_STAT_BB) {
346 if (time_after(jiffies, timeout)) {
347 dev_warn(dev->dev, "timeout waiting for bus ready\n");
348 return -ETIMEDOUT;
349 }
350 msleep(1);
351 }
352
353 return 0;
354}
355
356/*
357 * Low level master read/write transaction.
358 */
359static int omap_i2c_xfer_msg(struct i2c_adapter *adap,
360 struct i2c_msg *msg, int stop)
361{
362 struct omap_i2c_dev *dev = i2c_get_adapdata(adap);
363 int r;
364 u16 w;
365
366 dev_dbg(dev->dev, "addr: 0x%04x, len: %d, flags: 0x%x, stop: %d\n",
367 msg->addr, msg->len, msg->flags, stop);
368
369 if (msg->len == 0)
370 return -EINVAL;
371
372 omap_i2c_write_reg(dev, OMAP_I2C_SA_REG, msg->addr);
373
374 /* REVISIT: Could the STB bit of I2C_CON be used with probing? */
375 dev->buf = msg->buf;
376 dev->buf_len = msg->len;
377
378 omap_i2c_write_reg(dev, OMAP_I2C_CNT_REG, dev->buf_len);
379
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800380 /* Clear the FIFO Buffers */
381 w = omap_i2c_read_reg(dev, OMAP_I2C_BUF_REG);
382 w |= OMAP_I2C_BUF_RXFIF_CLR | OMAP_I2C_BUF_TXFIF_CLR;
383 omap_i2c_write_reg(dev, OMAP_I2C_BUF_REG, w);
384
Komal Shah010d4422006-08-13 23:44:09 +0200385 init_completion(&dev->cmd_complete);
386 dev->cmd_err = 0;
387
388 w = OMAP_I2C_CON_EN | OMAP_I2C_CON_MST | OMAP_I2C_CON_STT;
Syed Mohammed Khasim4574eb62008-11-21 13:39:45 -0800389
390 /* High speed configuration */
391 if (dev->speed > 400)
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800392 w |= OMAP_I2C_CON_OPMODE_HS;
Syed Mohammed Khasim4574eb62008-11-21 13:39:45 -0800393
Komal Shah010d4422006-08-13 23:44:09 +0200394 if (msg->flags & I2C_M_TEN)
395 w |= OMAP_I2C_CON_XA;
396 if (!(msg->flags & I2C_M_RD))
397 w |= OMAP_I2C_CON_TRX;
Tony Lindgrenc1a473b2008-11-21 13:39:47 -0800398
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800399 if (!dev->b_hw && stop)
Komal Shah010d4422006-08-13 23:44:09 +0200400 w |= OMAP_I2C_CON_STP;
Tony Lindgrenc1a473b2008-11-21 13:39:47 -0800401
Komal Shah010d4422006-08-13 23:44:09 +0200402 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);
403
Jarkko Nikulab7af3492008-11-21 13:39:45 -0800404 /*
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800405 * Don't write stt and stp together on some hardware.
406 */
407 if (dev->b_hw && stop) {
408 unsigned long delay = jiffies + OMAP_I2C_TIMEOUT;
409 u16 con = omap_i2c_read_reg(dev, OMAP_I2C_CON_REG);
410 while (con & OMAP_I2C_CON_STT) {
411 con = omap_i2c_read_reg(dev, OMAP_I2C_CON_REG);
412
413 /* Let the user know if i2c is in a bad state */
414 if (time_after(jiffies, delay)) {
415 dev_err(dev->dev, "controller timed out "
416 "waiting for start condition to finish\n");
417 return -ETIMEDOUT;
418 }
419 cpu_relax();
420 }
421
422 w |= OMAP_I2C_CON_STP;
423 w &= ~OMAP_I2C_CON_STT;
424 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);
425 }
426
427 /*
Jarkko Nikulab7af3492008-11-21 13:39:45 -0800428 * REVISIT: We should abort the transfer on signals, but the bus goes
429 * into arbitration and we're currently unable to recover from it.
430 */
431 r = wait_for_completion_timeout(&dev->cmd_complete,
432 OMAP_I2C_TIMEOUT);
Komal Shah010d4422006-08-13 23:44:09 +0200433 dev->buf_len = 0;
434 if (r < 0)
435 return r;
436 if (r == 0) {
437 dev_err(dev->dev, "controller timed out\n");
438 omap_i2c_init(dev);
439 return -ETIMEDOUT;
440 }
441
442 if (likely(!dev->cmd_err))
443 return 0;
444
445 /* We have an error */
446 if (dev->cmd_err & (OMAP_I2C_STAT_AL | OMAP_I2C_STAT_ROVR |
447 OMAP_I2C_STAT_XUDF)) {
448 omap_i2c_init(dev);
449 return -EIO;
450 }
451
452 if (dev->cmd_err & OMAP_I2C_STAT_NACK) {
453 if (msg->flags & I2C_M_IGNORE_NAK)
454 return 0;
455 if (stop) {
456 w = omap_i2c_read_reg(dev, OMAP_I2C_CON_REG);
457 w |= OMAP_I2C_CON_STP;
458 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);
459 }
460 return -EREMOTEIO;
461 }
462 return -EIO;
463}
464
465
466/*
467 * Prepare controller for a transaction and call omap_i2c_xfer_msg
468 * to do the work during IRQ processing.
469 */
470static int
471omap_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
472{
473 struct omap_i2c_dev *dev = i2c_get_adapdata(adap);
474 int i;
475 int r;
476
Tony Lindgrenf08ac4e2008-03-23 20:28:20 +0100477 omap_i2c_unidle(dev);
Komal Shah010d4422006-08-13 23:44:09 +0200478
Tony Lindgrenc1a473b2008-11-21 13:39:47 -0800479 r = omap_i2c_wait_for_bb(dev);
480 if (r < 0)
Komal Shah010d4422006-08-13 23:44:09 +0200481 goto out;
482
483 for (i = 0; i < num; i++) {
484 r = omap_i2c_xfer_msg(adap, &msgs[i], (i == (num - 1)));
485 if (r != 0)
486 break;
487 }
488
489 if (r == 0)
490 r = num;
491out:
Tony Lindgrenf08ac4e2008-03-23 20:28:20 +0100492 omap_i2c_idle(dev);
Komal Shah010d4422006-08-13 23:44:09 +0200493 return r;
494}
495
496static u32
497omap_i2c_func(struct i2c_adapter *adap)
498{
499 return I2C_FUNC_I2C | (I2C_FUNC_SMBUS_EMUL & ~I2C_FUNC_SMBUS_QUICK);
500}
501
502static inline void
503omap_i2c_complete_cmd(struct omap_i2c_dev *dev, u16 err)
504{
505 dev->cmd_err |= err;
506 complete(&dev->cmd_complete);
507}
508
509static inline void
510omap_i2c_ack_stat(struct omap_i2c_dev *dev, u16 stat)
511{
512 omap_i2c_write_reg(dev, OMAP_I2C_STAT_REG, stat);
513}
514
Paul Walmsley43469d8e2008-11-21 13:39:47 -0800515/* rev1 devices are apparently only on some 15xx */
516#ifdef CONFIG_ARCH_OMAP15XX
517
Komal Shah010d4422006-08-13 23:44:09 +0200518static irqreturn_t
David Howells7d12e782006-10-05 14:55:46 +0100519omap_i2c_rev1_isr(int this_irq, void *dev_id)
Komal Shah010d4422006-08-13 23:44:09 +0200520{
521 struct omap_i2c_dev *dev = dev_id;
522 u16 iv, w;
523
Tony Lindgrenf08ac4e2008-03-23 20:28:20 +0100524 if (dev->idle)
525 return IRQ_NONE;
526
Komal Shah010d4422006-08-13 23:44:09 +0200527 iv = omap_i2c_read_reg(dev, OMAP_I2C_IV_REG);
528 switch (iv) {
529 case 0x00: /* None */
530 break;
531 case 0x01: /* Arbitration lost */
532 dev_err(dev->dev, "Arbitration lost\n");
533 omap_i2c_complete_cmd(dev, OMAP_I2C_STAT_AL);
534 break;
535 case 0x02: /* No acknowledgement */
536 omap_i2c_complete_cmd(dev, OMAP_I2C_STAT_NACK);
537 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_STP);
538 break;
539 case 0x03: /* Register access ready */
540 omap_i2c_complete_cmd(dev, 0);
541 break;
542 case 0x04: /* Receive data ready */
543 if (dev->buf_len) {
544 w = omap_i2c_read_reg(dev, OMAP_I2C_DATA_REG);
545 *dev->buf++ = w;
546 dev->buf_len--;
547 if (dev->buf_len) {
548 *dev->buf++ = w >> 8;
549 dev->buf_len--;
550 }
551 } else
552 dev_err(dev->dev, "RRDY IRQ while no data requested\n");
553 break;
554 case 0x05: /* Transmit data ready */
555 if (dev->buf_len) {
556 w = *dev->buf++;
557 dev->buf_len--;
558 if (dev->buf_len) {
559 w |= *dev->buf++ << 8;
560 dev->buf_len--;
561 }
562 omap_i2c_write_reg(dev, OMAP_I2C_DATA_REG, w);
563 } else
564 dev_err(dev->dev, "XRDY IRQ while no data to send\n");
565 break;
566 default:
567 return IRQ_NONE;
568 }
569
570 return IRQ_HANDLED;
571}
Paul Walmsley43469d8e2008-11-21 13:39:47 -0800572#else
Tony Lindgrenc1a473b2008-11-21 13:39:47 -0800573#define omap_i2c_rev1_isr NULL
Paul Walmsley43469d8e2008-11-21 13:39:47 -0800574#endif
Komal Shah010d4422006-08-13 23:44:09 +0200575
576static irqreturn_t
David Howells7d12e782006-10-05 14:55:46 +0100577omap_i2c_isr(int this_irq, void *dev_id)
Komal Shah010d4422006-08-13 23:44:09 +0200578{
579 struct omap_i2c_dev *dev = dev_id;
580 u16 bits;
581 u16 stat, w;
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800582 int err, count = 0;
Komal Shah010d4422006-08-13 23:44:09 +0200583
Tony Lindgrenf08ac4e2008-03-23 20:28:20 +0100584 if (dev->idle)
585 return IRQ_NONE;
586
Komal Shah010d4422006-08-13 23:44:09 +0200587 bits = omap_i2c_read_reg(dev, OMAP_I2C_IE_REG);
588 while ((stat = (omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG))) & bits) {
589 dev_dbg(dev->dev, "IRQ (ISR = 0x%04x)\n", stat);
590 if (count++ == 100) {
591 dev_warn(dev->dev, "Too much work in one IRQ\n");
592 break;
593 }
594
595 omap_i2c_write_reg(dev, OMAP_I2C_STAT_REG, stat);
596
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800597 err = 0;
598 if (stat & OMAP_I2C_STAT_NACK) {
599 err |= OMAP_I2C_STAT_NACK;
600 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG,
601 OMAP_I2C_CON_STP);
602 }
603 if (stat & OMAP_I2C_STAT_AL) {
604 dev_err(dev->dev, "Arbitration lost\n");
605 err |= OMAP_I2C_STAT_AL;
606 }
607 if (stat & (OMAP_I2C_STAT_ARDY | OMAP_I2C_STAT_NACK |
608 OMAP_I2C_STAT_AL))
609 omap_i2c_complete_cmd(dev, err);
610 if (stat & (OMAP_I2C_STAT_RRDY | OMAP_I2C_STAT_RDR)) {
611 u8 num_bytes = 1;
612 if (dev->fifo_size) {
613 if (stat & OMAP_I2C_STAT_RRDY)
614 num_bytes = dev->fifo_size;
615 else
616 num_bytes = omap_i2c_read_reg(dev,
617 OMAP_I2C_BUFSTAT_REG);
618 }
619 while (num_bytes) {
620 num_bytes--;
621 w = omap_i2c_read_reg(dev, OMAP_I2C_DATA_REG);
622 if (dev->buf_len) {
623 *dev->buf++ = w;
624 dev->buf_len--;
625 /* Data reg from 2430 is 8 bit wide */
Chandra shekhar3d522fb2008-11-21 13:39:46 -0800626 if (!cpu_is_omap2430() &&
627 !cpu_is_omap34xx()) {
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800628 if (dev->buf_len) {
629 *dev->buf++ = w >> 8;
630 dev->buf_len--;
631 }
632 }
633 } else {
634 if (stat & OMAP_I2C_STAT_RRDY)
635 dev_err(dev->dev,
636 "RRDY IRQ while no data"
637 " requested\n");
638 if (stat & OMAP_I2C_STAT_RDR)
639 dev_err(dev->dev,
640 "RDR IRQ while no data"
641 " requested\n");
642 break;
643 }
644 }
645 omap_i2c_ack_stat(dev,
646 stat & (OMAP_I2C_STAT_RRDY | OMAP_I2C_STAT_RDR));
Komal Shah010d4422006-08-13 23:44:09 +0200647 continue;
648 }
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800649 if (stat & (OMAP_I2C_STAT_XRDY | OMAP_I2C_STAT_XDR)) {
650 u8 num_bytes = 1;
651 if (dev->fifo_size) {
652 if (stat & OMAP_I2C_STAT_XRDY)
653 num_bytes = dev->fifo_size;
654 else
655 num_bytes = omap_i2c_read_reg(dev,
656 OMAP_I2C_BUFSTAT_REG);
657 }
658 while (num_bytes) {
659 num_bytes--;
660 w = 0;
Komal Shah010d4422006-08-13 23:44:09 +0200661 if (dev->buf_len) {
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800662 w = *dev->buf++;
Komal Shah010d4422006-08-13 23:44:09 +0200663 dev->buf_len--;
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800664 /* Data reg from 2430 is 8 bit wide */
Chandra shekhar3d522fb2008-11-21 13:39:46 -0800665 if (!cpu_is_omap2430() &&
666 !cpu_is_omap34xx()) {
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800667 if (dev->buf_len) {
668 w |= *dev->buf++ << 8;
669 dev->buf_len--;
670 }
671 }
672 } else {
673 if (stat & OMAP_I2C_STAT_XRDY)
674 dev_err(dev->dev,
675 "XRDY IRQ while no "
676 "data to send\n");
677 if (stat & OMAP_I2C_STAT_XDR)
678 dev_err(dev->dev,
679 "XDR IRQ while no "
680 "data to send\n");
681 break;
Komal Shah010d4422006-08-13 23:44:09 +0200682 }
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800683 omap_i2c_write_reg(dev, OMAP_I2C_DATA_REG, w);
684 }
685 omap_i2c_ack_stat(dev,
686 stat & (OMAP_I2C_STAT_XRDY | OMAP_I2C_STAT_XDR));
Komal Shah010d4422006-08-13 23:44:09 +0200687 continue;
688 }
689 if (stat & OMAP_I2C_STAT_ROVR) {
690 dev_err(dev->dev, "Receive overrun\n");
691 dev->cmd_err |= OMAP_I2C_STAT_ROVR;
692 }
693 if (stat & OMAP_I2C_STAT_XUDF) {
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800694 dev_err(dev->dev, "Transmit underflow\n");
Komal Shah010d4422006-08-13 23:44:09 +0200695 dev->cmd_err |= OMAP_I2C_STAT_XUDF;
696 }
Komal Shah010d4422006-08-13 23:44:09 +0200697 }
698
699 return count ? IRQ_HANDLED : IRQ_NONE;
700}
701
Jean Delvare8f9082c2006-09-03 22:39:46 +0200702static const struct i2c_algorithm omap_i2c_algo = {
Komal Shah010d4422006-08-13 23:44:09 +0200703 .master_xfer = omap_i2c_xfer,
704 .functionality = omap_i2c_func,
705};
706
Paul Walmsley510be9c2008-11-21 13:39:46 -0800707static int __init
Komal Shah010d4422006-08-13 23:44:09 +0200708omap_i2c_probe(struct platform_device *pdev)
709{
710 struct omap_i2c_dev *dev;
711 struct i2c_adapter *adap;
712 struct resource *mem, *irq, *ioarea;
713 int r;
Chandra shekhar3d522fb2008-11-21 13:39:46 -0800714 u32 speed = 0;
Komal Shah010d4422006-08-13 23:44:09 +0200715
716 /* NOTE: driver uses the static register mapping */
717 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
718 if (!mem) {
719 dev_err(&pdev->dev, "no mem resource?\n");
720 return -ENODEV;
721 }
722 irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
723 if (!irq) {
724 dev_err(&pdev->dev, "no irq resource?\n");
725 return -ENODEV;
726 }
727
728 ioarea = request_mem_region(mem->start, (mem->end - mem->start) + 1,
729 pdev->name);
730 if (!ioarea) {
731 dev_err(&pdev->dev, "I2C region already claimed\n");
732 return -EBUSY;
733 }
734
Komal Shah010d4422006-08-13 23:44:09 +0200735 dev = kzalloc(sizeof(struct omap_i2c_dev), GFP_KERNEL);
736 if (!dev) {
737 r = -ENOMEM;
738 goto err_release_region;
739 }
740
Syed Mohammed Khasim4574eb62008-11-21 13:39:45 -0800741 if (pdev->dev.platform_data != NULL)
Chandra shekhar3d522fb2008-11-21 13:39:46 -0800742 speed = *(u32 *)pdev->dev.platform_data;
Syed Mohammed Khasim4574eb62008-11-21 13:39:45 -0800743 else
Chandra shekhar3d522fb2008-11-21 13:39:46 -0800744 speed = 100; /* Defualt speed */
Syed Mohammed Khasim4574eb62008-11-21 13:39:45 -0800745
Chandra shekhar3d522fb2008-11-21 13:39:46 -0800746 dev->speed = speed;
Paul Walmsley3831f152008-11-21 13:39:47 -0800747 dev->idle = 1;
Komal Shah010d4422006-08-13 23:44:09 +0200748 dev->dev = &pdev->dev;
749 dev->irq = irq->start;
Russell King55c381e2008-09-04 14:07:22 +0100750 dev->base = ioremap(mem->start, mem->end - mem->start + 1);
751 if (!dev->base) {
752 r = -ENOMEM;
753 goto err_free_mem;
754 }
755
Komal Shah010d4422006-08-13 23:44:09 +0200756 platform_set_drvdata(pdev, dev);
757
758 if ((r = omap_i2c_get_clocks(dev)) != 0)
Russell King55c381e2008-09-04 14:07:22 +0100759 goto err_iounmap;
Komal Shah010d4422006-08-13 23:44:09 +0200760
Tony Lindgrenf08ac4e2008-03-23 20:28:20 +0100761 omap_i2c_unidle(dev);
Komal Shah010d4422006-08-13 23:44:09 +0200762
763 if (cpu_is_omap15xx())
764 dev->rev1 = omap_i2c_read_reg(dev, OMAP_I2C_REV_REG) < 0x20;
765
Chandra shekhar3d522fb2008-11-21 13:39:46 -0800766 if (cpu_is_omap2430() || cpu_is_omap34xx()) {
Nishanth Menonb6ee52c2008-11-21 13:39:46 -0800767 u16 s;
768
769 /* Set up the fifo size - Get total size */
770 s = (omap_i2c_read_reg(dev, OMAP_I2C_BUFSTAT_REG) >> 14) & 0x3;
771 dev->fifo_size = 0x8 << s;
772
773 /*
774 * Set up notification threshold as half the total available
775 * size. This is to ensure that we can handle the status on int
776 * call back latencies.
777 */
778 dev->fifo_size = (dev->fifo_size / 2);
779 dev->b_hw = 1; /* Enable hardware fixes */
780 }
781
Komal Shah010d4422006-08-13 23:44:09 +0200782 /* reset ASAP, clearing any IRQs */
783 omap_i2c_init(dev);
784
785 r = request_irq(dev->irq, dev->rev1 ? omap_i2c_rev1_isr : omap_i2c_isr,
786 0, pdev->name, dev);
787
788 if (r) {
789 dev_err(dev->dev, "failure requesting irq %i\n", dev->irq);
790 goto err_unuse_clocks;
791 }
792 r = omap_i2c_read_reg(dev, OMAP_I2C_REV_REG) & 0xff;
793 dev_info(dev->dev, "bus %d rev%d.%d at %d kHz\n",
Syed Mohammed Khasim4574eb62008-11-21 13:39:45 -0800794 pdev->id, r >> 4, r & 0xf, dev->speed);
Komal Shah010d4422006-08-13 23:44:09 +0200795
Paul Walmsley3831f152008-11-21 13:39:47 -0800796 omap_i2c_idle(dev);
797
Komal Shah010d4422006-08-13 23:44:09 +0200798 adap = &dev->adapter;
799 i2c_set_adapdata(adap, dev);
800 adap->owner = THIS_MODULE;
801 adap->class = I2C_CLASS_HWMON;
802 strncpy(adap->name, "OMAP I2C adapter", sizeof(adap->name));
803 adap->algo = &omap_i2c_algo;
804 adap->dev.parent = &pdev->dev;
805
806 /* i2c device drivers may be active on return from add_adapter() */
David Brownell7c175492007-05-01 23:26:32 +0200807 adap->nr = pdev->id;
808 r = i2c_add_numbered_adapter(adap);
Komal Shah010d4422006-08-13 23:44:09 +0200809 if (r) {
810 dev_err(dev->dev, "failure adding adapter\n");
811 goto err_free_irq;
812 }
813
Komal Shah010d4422006-08-13 23:44:09 +0200814 return 0;
815
816err_free_irq:
817 free_irq(dev->irq, dev);
818err_unuse_clocks:
Tony Lindgren3e397522008-01-14 21:53:30 +0100819 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
Tony Lindgrenf08ac4e2008-03-23 20:28:20 +0100820 omap_i2c_idle(dev);
Komal Shah010d4422006-08-13 23:44:09 +0200821 omap_i2c_put_clocks(dev);
Russell King55c381e2008-09-04 14:07:22 +0100822err_iounmap:
823 iounmap(dev->base);
Komal Shah010d4422006-08-13 23:44:09 +0200824err_free_mem:
825 platform_set_drvdata(pdev, NULL);
826 kfree(dev);
827err_release_region:
Komal Shah010d4422006-08-13 23:44:09 +0200828 release_mem_region(mem->start, (mem->end - mem->start) + 1);
829
830 return r;
831}
832
833static int
834omap_i2c_remove(struct platform_device *pdev)
835{
836 struct omap_i2c_dev *dev = platform_get_drvdata(pdev);
837 struct resource *mem;
838
839 platform_set_drvdata(pdev, NULL);
840
841 free_irq(dev->irq, dev);
842 i2c_del_adapter(&dev->adapter);
843 omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
844 omap_i2c_put_clocks(dev);
Russell King55c381e2008-09-04 14:07:22 +0100845 iounmap(dev->base);
Komal Shah010d4422006-08-13 23:44:09 +0200846 kfree(dev);
847 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
848 release_mem_region(mem->start, (mem->end - mem->start) + 1);
849 return 0;
850}
851
852static struct platform_driver omap_i2c_driver = {
853 .probe = omap_i2c_probe,
854 .remove = omap_i2c_remove,
855 .driver = {
856 .name = "i2c_omap",
857 .owner = THIS_MODULE,
858 },
859};
860
861/* I2C may be needed to bring up other drivers */
862static int __init
863omap_i2c_init_driver(void)
864{
865 return platform_driver_register(&omap_i2c_driver);
866}
867subsys_initcall(omap_i2c_init_driver);
868
869static void __exit omap_i2c_exit_driver(void)
870{
871 platform_driver_unregister(&omap_i2c_driver);
872}
873module_exit(omap_i2c_exit_driver);
874
875MODULE_AUTHOR("MontaVista Software, Inc. (and others)");
876MODULE_DESCRIPTION("TI OMAP I2C bus adapter");
877MODULE_LICENSE("GPL");
Kay Sieversadd8eda2008-04-22 22:16:49 +0200878MODULE_ALIAS("platform:i2c_omap");