blob: 0eea0dd35895808a989456c017931b69d28e06bc [file] [log] [blame]
Baruch Siach1ab52cf2009-06-22 16:36:29 +03001/*
2 * Synopsys Designware I2C adapter driver (master only).
3 *
4 * Based on the TI DAVINCI I2C adapter driver.
5 *
6 * Copyright (C) 2006 Texas Instruments.
7 * Copyright (C) 2007 MontaVista Software Inc.
8 * Copyright (C) 2009 Provigent Ltd.
9 *
10 * ----------------------------------------------------------------------------
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 * ----------------------------------------------------------------------------
26 *
27 */
28#include <linux/kernel.h>
29#include <linux/module.h>
30#include <linux/delay.h>
31#include <linux/i2c.h>
32#include <linux/clk.h>
33#include <linux/errno.h>
34#include <linux/sched.h>
35#include <linux/err.h>
36#include <linux/interrupt.h>
37#include <linux/platform_device.h>
38#include <linux/io.h>
39
40/*
41 * Registers offset
42 */
43#define DW_IC_CON 0x0
44#define DW_IC_TAR 0x4
45#define DW_IC_DATA_CMD 0x10
46#define DW_IC_SS_SCL_HCNT 0x14
47#define DW_IC_SS_SCL_LCNT 0x18
48#define DW_IC_FS_SCL_HCNT 0x1c
49#define DW_IC_FS_SCL_LCNT 0x20
50#define DW_IC_INTR_STAT 0x2c
51#define DW_IC_INTR_MASK 0x30
Shinya Kuribayashie28000a2009-11-06 21:44:37 +090052#define DW_IC_RAW_INTR_STAT 0x34
Shinya Kuribayashi4cb6d1d2009-11-06 21:48:12 +090053#define DW_IC_RX_TL 0x38
54#define DW_IC_TX_TL 0x3c
Baruch Siach1ab52cf2009-06-22 16:36:29 +030055#define DW_IC_CLR_INTR 0x40
Shinya Kuribayashie28000a2009-11-06 21:44:37 +090056#define DW_IC_CLR_RX_UNDER 0x44
57#define DW_IC_CLR_RX_OVER 0x48
58#define DW_IC_CLR_TX_OVER 0x4c
59#define DW_IC_CLR_RD_REQ 0x50
60#define DW_IC_CLR_TX_ABRT 0x54
61#define DW_IC_CLR_RX_DONE 0x58
62#define DW_IC_CLR_ACTIVITY 0x5c
63#define DW_IC_CLR_STOP_DET 0x60
64#define DW_IC_CLR_START_DET 0x64
65#define DW_IC_CLR_GEN_CALL 0x68
Baruch Siach1ab52cf2009-06-22 16:36:29 +030066#define DW_IC_ENABLE 0x6c
67#define DW_IC_STATUS 0x70
68#define DW_IC_TXFLR 0x74
69#define DW_IC_RXFLR 0x78
70#define DW_IC_COMP_PARAM_1 0xf4
71#define DW_IC_TX_ABRT_SOURCE 0x80
72
73#define DW_IC_CON_MASTER 0x1
74#define DW_IC_CON_SPEED_STD 0x2
75#define DW_IC_CON_SPEED_FAST 0x4
76#define DW_IC_CON_10BITADDR_MASTER 0x10
77#define DW_IC_CON_RESTART_EN 0x20
78#define DW_IC_CON_SLAVE_DISABLE 0x40
79
Shinya Kuribayashie28000a2009-11-06 21:44:37 +090080#define DW_IC_INTR_RX_UNDER 0x001
81#define DW_IC_INTR_RX_OVER 0x002
82#define DW_IC_INTR_RX_FULL 0x004
83#define DW_IC_INTR_TX_OVER 0x008
84#define DW_IC_INTR_TX_EMPTY 0x010
85#define DW_IC_INTR_RD_REQ 0x020
86#define DW_IC_INTR_TX_ABRT 0x040
87#define DW_IC_INTR_RX_DONE 0x080
88#define DW_IC_INTR_ACTIVITY 0x100
Baruch Siach1ab52cf2009-06-22 16:36:29 +030089#define DW_IC_INTR_STOP_DET 0x200
Shinya Kuribayashie28000a2009-11-06 21:44:37 +090090#define DW_IC_INTR_START_DET 0x400
91#define DW_IC_INTR_GEN_CALL 0x800
Baruch Siach1ab52cf2009-06-22 16:36:29 +030092
93#define DW_IC_STATUS_ACTIVITY 0x1
94
95#define DW_IC_ERR_TX_ABRT 0x1
96
97/*
98 * status codes
99 */
100#define STATUS_IDLE 0x0
101#define STATUS_WRITE_IN_PROGRESS 0x1
102#define STATUS_READ_IN_PROGRESS 0x2
103
104#define TIMEOUT 20 /* ms */
105
106/*
107 * hardware abort codes from the DW_IC_TX_ABRT_SOURCE register
108 *
109 * only expected abort codes are listed here
110 * refer to the datasheet for the full list
111 */
112#define ABRT_7B_ADDR_NOACK 0
113#define ABRT_10ADDR1_NOACK 1
114#define ABRT_10ADDR2_NOACK 2
115#define ABRT_TXDATA_NOACK 3
116#define ABRT_GCALL_NOACK 4
117#define ABRT_GCALL_READ 5
118#define ABRT_SBYTE_ACKDET 7
119#define ABRT_SBYTE_NORSTRT 9
120#define ABRT_10B_RD_NORSTRT 10
121#define ARB_MASTER_DIS 11
122#define ARB_LOST 12
123
124static char *abort_sources[] = {
125 [ABRT_7B_ADDR_NOACK] =
126 "slave address not acknowledged (7bit mode)",
127 [ABRT_10ADDR1_NOACK] =
128 "first address byte not acknowledged (10bit mode)",
129 [ABRT_10ADDR2_NOACK] =
130 "second address byte not acknowledged (10bit mode)",
131 [ABRT_TXDATA_NOACK] =
132 "data not acknowledged",
133 [ABRT_GCALL_NOACK] =
134 "no acknowledgement for a general call",
135 [ABRT_GCALL_READ] =
136 "read after general call",
137 [ABRT_SBYTE_ACKDET] =
138 "start byte acknowledged",
139 [ABRT_SBYTE_NORSTRT] =
140 "trying to send start byte when restart is disabled",
141 [ABRT_10B_RD_NORSTRT] =
142 "trying to read when restart is disabled (10bit mode)",
143 [ARB_MASTER_DIS] =
144 "trying to use disabled adapter",
145 [ARB_LOST] =
146 "lost arbitration",
147};
148
149/**
150 * struct dw_i2c_dev - private i2c-designware data
151 * @dev: driver model device node
152 * @base: IO registers pointer
153 * @cmd_complete: tx completion indicator
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300154 * @lock: protect this struct and IO registers
155 * @clk: input reference clock
156 * @cmd_err: run time hadware error code
157 * @msgs: points to an array of messages currently being transfered
158 * @msgs_num: the number of elements in msgs
159 * @msg_write_idx: the element index of the current tx message in the msgs
160 * array
161 * @tx_buf_len: the length of the current tx buffer
162 * @tx_buf: the current tx buffer
163 * @msg_read_idx: the element index of the current rx message in the msgs
164 * array
165 * @rx_buf_len: the length of the current rx buffer
166 * @rx_buf: the current rx buffer
167 * @msg_err: error status of the current transfer
168 * @status: i2c master status, one of STATUS_*
169 * @abort_source: copy of the TX_ABRT_SOURCE register
170 * @irq: interrupt number for the i2c master
171 * @adapter: i2c subsystem adapter node
172 * @tx_fifo_depth: depth of the hardware tx fifo
173 * @rx_fifo_depth: depth of the hardware rx fifo
174 */
175struct dw_i2c_dev {
176 struct device *dev;
177 void __iomem *base;
178 struct completion cmd_complete;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300179 struct mutex lock;
180 struct clk *clk;
181 int cmd_err;
182 struct i2c_msg *msgs;
183 int msgs_num;
184 int msg_write_idx;
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900185 u32 tx_buf_len;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300186 u8 *tx_buf;
187 int msg_read_idx;
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900188 u32 rx_buf_len;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300189 u8 *rx_buf;
190 int msg_err;
191 unsigned int status;
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900192 u32 abort_source;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300193 int irq;
194 struct i2c_adapter adapter;
195 unsigned int tx_fifo_depth;
196 unsigned int rx_fifo_depth;
197};
198
Shinya Kuribayashid60c7e82009-11-06 21:47:01 +0900199static u32
200i2c_dw_scl_hcnt(u32 ic_clk, u32 tSYMBOL, u32 tf, int cond, int offset)
201{
202 /*
203 * DesignWare I2C core doesn't seem to have solid strategy to meet
204 * the tHD;STA timing spec. Configuring _HCNT based on tHIGH spec
205 * will result in violation of the tHD;STA spec.
206 */
207 if (cond)
208 /*
209 * Conditional expression:
210 *
211 * IC_[FS]S_SCL_HCNT + (1+4+3) >= IC_CLK * tHIGH
212 *
213 * This is based on the DW manuals, and represents an ideal
214 * configuration. The resulting I2C bus speed will be
215 * faster than any of the others.
216 *
217 * If your hardware is free from tHD;STA issue, try this one.
218 */
219 return (ic_clk * tSYMBOL + 5000) / 10000 - 8 + offset;
220 else
221 /*
222 * Conditional expression:
223 *
224 * IC_[FS]S_SCL_HCNT + 3 >= IC_CLK * (tHD;STA + tf)
225 *
226 * This is just experimental rule; the tHD;STA period turned
227 * out to be proportinal to (_HCNT + 3). With this setting,
228 * we could meet both tHIGH and tHD;STA timing specs.
229 *
230 * If unsure, you'd better to take this alternative.
231 *
232 * The reason why we need to take into account "tf" here,
233 * is the same as described in i2c_dw_scl_lcnt().
234 */
235 return (ic_clk * (tSYMBOL + tf) + 5000) / 10000 - 3 + offset;
236}
237
238static u32 i2c_dw_scl_lcnt(u32 ic_clk, u32 tLOW, u32 tf, int offset)
239{
240 /*
241 * Conditional expression:
242 *
243 * IC_[FS]S_SCL_LCNT + 1 >= IC_CLK * (tLOW + tf)
244 *
245 * DW I2C core starts counting the SCL CNTs for the LOW period
246 * of the SCL clock (tLOW) as soon as it pulls the SCL line.
247 * In order to meet the tLOW timing spec, we need to take into
248 * account the fall time of SCL signal (tf). Default tf value
249 * should be 0.3 us, for safety.
250 */
251 return ((ic_clk * (tLOW + tf) + 5000) / 10000) - 1 + offset;
252}
253
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300254/**
255 * i2c_dw_init() - initialize the designware i2c master hardware
256 * @dev: device private data
257 *
258 * This functions configures and enables the I2C master.
259 * This function is called during I2C init function, and in case of timeout at
260 * run time.
261 */
262static void i2c_dw_init(struct dw_i2c_dev *dev)
263{
264 u32 input_clock_khz = clk_get_rate(dev->clk) / 1000;
Shinya Kuribayashid60c7e82009-11-06 21:47:01 +0900265 u32 ic_con, hcnt, lcnt;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300266
267 /* Disable the adapter */
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900268 writel(0, dev->base + DW_IC_ENABLE);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300269
270 /* set standard and fast speed deviders for high/low periods */
Shinya Kuribayashid60c7e82009-11-06 21:47:01 +0900271
272 /* Standard-mode */
273 hcnt = i2c_dw_scl_hcnt(input_clock_khz,
274 40, /* tHD;STA = tHIGH = 4.0 us */
275 3, /* tf = 0.3 us */
276 0, /* 0: DW default, 1: Ideal */
277 0); /* No offset */
278 lcnt = i2c_dw_scl_lcnt(input_clock_khz,
279 47, /* tLOW = 4.7 us */
280 3, /* tf = 0.3 us */
281 0); /* No offset */
282 writel(hcnt, dev->base + DW_IC_SS_SCL_HCNT);
283 writel(lcnt, dev->base + DW_IC_SS_SCL_LCNT);
284 dev_dbg(dev->dev, "Standard-mode HCNT:LCNT = %d:%d\n", hcnt, lcnt);
285
286 /* Fast-mode */
287 hcnt = i2c_dw_scl_hcnt(input_clock_khz,
288 6, /* tHD;STA = tHIGH = 0.6 us */
289 3, /* tf = 0.3 us */
290 0, /* 0: DW default, 1: Ideal */
291 0); /* No offset */
292 lcnt = i2c_dw_scl_lcnt(input_clock_khz,
293 13, /* tLOW = 1.3 us */
294 3, /* tf = 0.3 us */
295 0); /* No offset */
296 writel(hcnt, dev->base + DW_IC_FS_SCL_HCNT);
297 writel(lcnt, dev->base + DW_IC_FS_SCL_LCNT);
298 dev_dbg(dev->dev, "Fast-mode HCNT:LCNT = %d:%d\n", hcnt, lcnt);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300299
Shinya Kuribayashi4cb6d1d2009-11-06 21:48:12 +0900300 /* Configure Tx/Rx FIFO threshold levels */
301 writel(dev->tx_fifo_depth - 1, dev->base + DW_IC_TX_TL);
302 writel(0, dev->base + DW_IC_RX_TL);
303
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300304 /* configure the i2c master */
305 ic_con = DW_IC_CON_MASTER | DW_IC_CON_SLAVE_DISABLE |
306 DW_IC_CON_RESTART_EN | DW_IC_CON_SPEED_FAST;
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900307 writel(ic_con, dev->base + DW_IC_CON);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300308}
309
310/*
311 * Waiting for bus not busy
312 */
313static int i2c_dw_wait_bus_not_busy(struct dw_i2c_dev *dev)
314{
315 int timeout = TIMEOUT;
316
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900317 while (readl(dev->base + DW_IC_STATUS) & DW_IC_STATUS_ACTIVITY) {
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300318 if (timeout <= 0) {
319 dev_warn(dev->dev, "timeout waiting for bus ready\n");
320 return -ETIMEDOUT;
321 }
322 timeout--;
323 mdelay(1);
324 }
325
326 return 0;
327}
328
329/*
330 * Initiate low level master read/write transaction.
331 * This function is called from i2c_dw_xfer when starting a transfer.
Shinya Kuribayashi07745392009-11-06 21:47:51 +0900332 * This function is also called from i2c_dw_isr to continue a transfer
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300333 * that is longer than the size of the TX FIFO.
334 */
335static void
Shinya Kuribayashie77cf232009-11-06 21:46:04 +0900336i2c_dw_xfer_msg(struct dw_i2c_dev *dev)
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300337{
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300338 struct i2c_msg *msgs = dev->msgs;
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900339 u32 ic_con, intr_mask;
340 int tx_limit = dev->tx_fifo_depth - readl(dev->base + DW_IC_TXFLR);
341 int rx_limit = dev->rx_fifo_depth - readl(dev->base + DW_IC_RXFLR);
342 u32 addr = msgs[dev->msg_write_idx].addr;
343 u32 buf_len = dev->tx_buf_len;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300344
Shinya Kuribayashic70c5cd2009-11-06 21:47:30 +0900345 intr_mask = DW_IC_INTR_STOP_DET | DW_IC_INTR_TX_ABRT;
346
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300347 if (!(dev->status & STATUS_WRITE_IN_PROGRESS)) {
348 /* Disable the adapter */
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900349 writel(0, dev->base + DW_IC_ENABLE);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300350
351 /* set the slave (target) address */
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900352 writel(msgs[dev->msg_write_idx].addr, dev->base + DW_IC_TAR);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300353
354 /* if the slave address is ten bit address, enable 10BITADDR */
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900355 ic_con = readl(dev->base + DW_IC_CON);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300356 if (msgs[dev->msg_write_idx].flags & I2C_M_TEN)
357 ic_con |= DW_IC_CON_10BITADDR_MASTER;
358 else
359 ic_con &= ~DW_IC_CON_10BITADDR_MASTER;
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900360 writel(ic_con, dev->base + DW_IC_CON);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300361
362 /* Enable the adapter */
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900363 writel(1, dev->base + DW_IC_ENABLE);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300364 }
365
Shinya Kuribayashi6d2ea482009-11-06 21:46:29 +0900366 for (; dev->msg_write_idx < dev->msgs_num; dev->msg_write_idx++) {
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300367 /* if target address has changed, we need to
368 * reprogram the target address in the i2c
369 * adapter when we are done with this transfer
370 */
371 if (msgs[dev->msg_write_idx].addr != addr)
372 return;
373
374 if (msgs[dev->msg_write_idx].len == 0) {
375 dev_err(dev->dev,
376 "%s: invalid message length\n", __func__);
377 dev->msg_err = -EINVAL;
378 return;
379 }
380
381 if (!(dev->status & STATUS_WRITE_IN_PROGRESS)) {
382 /* new i2c_msg */
383 dev->tx_buf = msgs[dev->msg_write_idx].buf;
384 buf_len = msgs[dev->msg_write_idx].len;
385 }
386
387 while (buf_len > 0 && tx_limit > 0 && rx_limit > 0) {
388 if (msgs[dev->msg_write_idx].flags & I2C_M_RD) {
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900389 writel(0x100, dev->base + DW_IC_DATA_CMD);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300390 rx_limit--;
391 } else
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900392 writel(*(dev->tx_buf++),
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300393 dev->base + DW_IC_DATA_CMD);
394 tx_limit--; buf_len--;
395 }
Shinya Kuribayashic70c5cd2009-11-06 21:47:30 +0900396
397 dev->tx_buf_len = buf_len;
398
399 if (buf_len > 0) {
400 /* more bytes to be written */
401 intr_mask |= DW_IC_INTR_TX_EMPTY;
402 dev->status |= STATUS_WRITE_IN_PROGRESS;
403 break;
404 } else
405 dev->status &= ~STATUS_WRITE_IN_PROGRESS;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300406 }
407
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900408 writel(intr_mask, dev->base + DW_IC_INTR_MASK);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300409}
410
411static void
Shinya Kuribayashi78839bd2009-11-06 21:45:39 +0900412i2c_dw_read(struct dw_i2c_dev *dev)
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300413{
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300414 struct i2c_msg *msgs = dev->msgs;
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900415 u32 addr = msgs[dev->msg_read_idx].addr;
416 int rx_valid = readl(dev->base + DW_IC_RXFLR);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300417
Shinya Kuribayashi6d2ea482009-11-06 21:46:29 +0900418 for (; dev->msg_read_idx < dev->msgs_num; dev->msg_read_idx++) {
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900419 u32 len;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300420 u8 *buf;
421
422 if (!(msgs[dev->msg_read_idx].flags & I2C_M_RD))
423 continue;
424
425 /* different i2c client, reprogram the i2c adapter */
426 if (msgs[dev->msg_read_idx].addr != addr)
427 return;
428
429 if (!(dev->status & STATUS_READ_IN_PROGRESS)) {
430 len = msgs[dev->msg_read_idx].len;
431 buf = msgs[dev->msg_read_idx].buf;
432 } else {
433 len = dev->rx_buf_len;
434 buf = dev->rx_buf;
435 }
436
437 for (; len > 0 && rx_valid > 0; len--, rx_valid--)
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900438 *buf++ = readl(dev->base + DW_IC_DATA_CMD);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300439
440 if (len > 0) {
441 dev->status |= STATUS_READ_IN_PROGRESS;
442 dev->rx_buf_len = len;
443 dev->rx_buf = buf;
444 return;
445 } else
446 dev->status &= ~STATUS_READ_IN_PROGRESS;
447 }
448}
449
450/*
451 * Prepare controller for a transaction and call i2c_dw_xfer_msg
452 */
453static int
454i2c_dw_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
455{
456 struct dw_i2c_dev *dev = i2c_get_adapdata(adap);
457 int ret;
458
459 dev_dbg(dev->dev, "%s: msgs: %d\n", __func__, num);
460
461 mutex_lock(&dev->lock);
462
463 INIT_COMPLETION(dev->cmd_complete);
464 dev->msgs = msgs;
465 dev->msgs_num = num;
466 dev->cmd_err = 0;
467 dev->msg_write_idx = 0;
468 dev->msg_read_idx = 0;
469 dev->msg_err = 0;
470 dev->status = STATUS_IDLE;
471
472 ret = i2c_dw_wait_bus_not_busy(dev);
473 if (ret < 0)
474 goto done;
475
476 /* start the transfers */
Shinya Kuribayashie77cf232009-11-06 21:46:04 +0900477 i2c_dw_xfer_msg(dev);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300478
479 /* wait for tx to complete */
480 ret = wait_for_completion_interruptible_timeout(&dev->cmd_complete, HZ);
481 if (ret == 0) {
482 dev_err(dev->dev, "controller timed out\n");
483 i2c_dw_init(dev);
484 ret = -ETIMEDOUT;
485 goto done;
486 } else if (ret < 0)
487 goto done;
488
489 if (dev->msg_err) {
490 ret = dev->msg_err;
491 goto done;
492 }
493
494 /* no error */
495 if (likely(!dev->cmd_err)) {
Shinya Kuribayashi07745392009-11-06 21:47:51 +0900496 /* Disable the adapter */
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900497 writel(0, dev->base + DW_IC_ENABLE);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300498 ret = num;
499 goto done;
500 }
501
502 /* We have an error */
503 if (dev->cmd_err == DW_IC_ERR_TX_ABRT) {
504 unsigned long abort_source = dev->abort_source;
505 int i;
506
507 for_each_bit(i, &abort_source, ARRAY_SIZE(abort_sources)) {
508 dev_err(dev->dev, "%s: %s\n", __func__, abort_sources[i]);
509 }
510 }
511 ret = -EIO;
512
513done:
514 mutex_unlock(&dev->lock);
515
516 return ret;
517}
518
519static u32 i2c_dw_func(struct i2c_adapter *adap)
520{
521 return I2C_FUNC_I2C | I2C_FUNC_10BIT_ADDR;
522}
523
Shinya Kuribayashie28000a2009-11-06 21:44:37 +0900524static u32 i2c_dw_read_clear_intrbits(struct dw_i2c_dev *dev)
525{
526 u32 stat;
527
528 /*
529 * The IC_INTR_STAT register just indicates "enabled" interrupts.
530 * Ths unmasked raw version of interrupt status bits are available
531 * in the IC_RAW_INTR_STAT register.
532 *
533 * That is,
534 * stat = readl(IC_INTR_STAT);
535 * equals to,
536 * stat = readl(IC_RAW_INTR_STAT) & readl(IC_INTR_MASK);
537 *
538 * The raw version might be useful for debugging purposes.
539 */
540 stat = readl(dev->base + DW_IC_INTR_STAT);
541
542 /*
543 * Do not use the IC_CLR_INTR register to clear interrupts, or
544 * you'll miss some interrupts, triggered during the period from
545 * readl(IC_INTR_STAT) to readl(IC_CLR_INTR).
546 *
547 * Instead, use the separately-prepared IC_CLR_* registers.
548 */
549 if (stat & DW_IC_INTR_RX_UNDER)
550 readl(dev->base + DW_IC_CLR_RX_UNDER);
551 if (stat & DW_IC_INTR_RX_OVER)
552 readl(dev->base + DW_IC_CLR_RX_OVER);
553 if (stat & DW_IC_INTR_TX_OVER)
554 readl(dev->base + DW_IC_CLR_TX_OVER);
555 if (stat & DW_IC_INTR_RD_REQ)
556 readl(dev->base + DW_IC_CLR_RD_REQ);
557 if (stat & DW_IC_INTR_TX_ABRT) {
558 /*
559 * The IC_TX_ABRT_SOURCE register is cleared whenever
560 * the IC_CLR_TX_ABRT is read. Preserve it beforehand.
561 */
562 dev->abort_source = readl(dev->base + DW_IC_TX_ABRT_SOURCE);
563 readl(dev->base + DW_IC_CLR_TX_ABRT);
564 }
565 if (stat & DW_IC_INTR_RX_DONE)
566 readl(dev->base + DW_IC_CLR_RX_DONE);
567 if (stat & DW_IC_INTR_ACTIVITY)
568 readl(dev->base + DW_IC_CLR_ACTIVITY);
569 if (stat & DW_IC_INTR_STOP_DET)
570 readl(dev->base + DW_IC_CLR_STOP_DET);
571 if (stat & DW_IC_INTR_START_DET)
572 readl(dev->base + DW_IC_CLR_START_DET);
573 if (stat & DW_IC_INTR_GEN_CALL)
574 readl(dev->base + DW_IC_CLR_GEN_CALL);
575
576 return stat;
577}
578
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300579/*
580 * Interrupt service routine. This gets called whenever an I2C interrupt
581 * occurs.
582 */
583static irqreturn_t i2c_dw_isr(int this_irq, void *dev_id)
584{
585 struct dw_i2c_dev *dev = dev_id;
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900586 u32 stat;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300587
Shinya Kuribayashie28000a2009-11-06 21:44:37 +0900588 stat = i2c_dw_read_clear_intrbits(dev);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300589 dev_dbg(dev->dev, "%s: stat=0x%x\n", __func__, stat);
Shinya Kuribayashie28000a2009-11-06 21:44:37 +0900590
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300591 if (stat & DW_IC_INTR_TX_ABRT) {
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300592 dev->cmd_err |= DW_IC_ERR_TX_ABRT;
593 dev->status = STATUS_IDLE;
Shinya Kuribayashi07745392009-11-06 21:47:51 +0900594 }
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300595
Shinya Kuribayashi07745392009-11-06 21:47:51 +0900596 if (stat & DW_IC_INTR_TX_EMPTY) {
597 i2c_dw_read(dev);
598 i2c_dw_xfer_msg(dev);
599 }
600
601 /*
602 * No need to modify or disable the interrupt mask here.
603 * i2c_dw_xfer_msg() will take care of it according to
604 * the current transmit status.
605 */
606
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300607 if (stat & (DW_IC_INTR_TX_ABRT | DW_IC_INTR_STOP_DET))
608 complete(&dev->cmd_complete);
609
610 return IRQ_HANDLED;
611}
612
613static struct i2c_algorithm i2c_dw_algo = {
614 .master_xfer = i2c_dw_xfer,
615 .functionality = i2c_dw_func,
616};
617
618static int __devinit dw_i2c_probe(struct platform_device *pdev)
619{
620 struct dw_i2c_dev *dev;
621 struct i2c_adapter *adap;
Shinya Kuribayashi91b52ca2009-11-06 21:45:07 +0900622 struct resource *mem, *ioarea;
623 int irq, r;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300624
625 /* NOTE: driver uses the static register mapping */
626 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
627 if (!mem) {
628 dev_err(&pdev->dev, "no mem resource?\n");
629 return -EINVAL;
630 }
631
Shinya Kuribayashi91b52ca2009-11-06 21:45:07 +0900632 irq = platform_get_irq(pdev, 0);
633 if (irq < 0) {
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300634 dev_err(&pdev->dev, "no irq resource?\n");
Shinya Kuribayashi91b52ca2009-11-06 21:45:07 +0900635 return irq; /* -ENXIO */
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300636 }
637
638 ioarea = request_mem_region(mem->start, resource_size(mem),
639 pdev->name);
640 if (!ioarea) {
641 dev_err(&pdev->dev, "I2C region already claimed\n");
642 return -EBUSY;
643 }
644
645 dev = kzalloc(sizeof(struct dw_i2c_dev), GFP_KERNEL);
646 if (!dev) {
647 r = -ENOMEM;
648 goto err_release_region;
649 }
650
651 init_completion(&dev->cmd_complete);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300652 mutex_init(&dev->lock);
653 dev->dev = get_device(&pdev->dev);
Shinya Kuribayashi91b52ca2009-11-06 21:45:07 +0900654 dev->irq = irq;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300655 platform_set_drvdata(pdev, dev);
656
657 dev->clk = clk_get(&pdev->dev, NULL);
658 if (IS_ERR(dev->clk)) {
659 r = -ENODEV;
660 goto err_free_mem;
661 }
662 clk_enable(dev->clk);
663
664 dev->base = ioremap(mem->start, resource_size(mem));
665 if (dev->base == NULL) {
666 dev_err(&pdev->dev, "failure mapping io resources\n");
667 r = -EBUSY;
668 goto err_unuse_clocks;
669 }
670 {
671 u32 param1 = readl(dev->base + DW_IC_COMP_PARAM_1);
672
673 dev->tx_fifo_depth = ((param1 >> 16) & 0xff) + 1;
674 dev->rx_fifo_depth = ((param1 >> 8) & 0xff) + 1;
675 }
676 i2c_dw_init(dev);
677
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900678 writel(0, dev->base + DW_IC_INTR_MASK); /* disable IRQ */
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300679 r = request_irq(dev->irq, i2c_dw_isr, 0, pdev->name, dev);
680 if (r) {
681 dev_err(&pdev->dev, "failure requesting irq %i\n", dev->irq);
682 goto err_iounmap;
683 }
684
685 adap = &dev->adapter;
686 i2c_set_adapdata(adap, dev);
687 adap->owner = THIS_MODULE;
688 adap->class = I2C_CLASS_HWMON;
689 strlcpy(adap->name, "Synopsys DesignWare I2C adapter",
690 sizeof(adap->name));
691 adap->algo = &i2c_dw_algo;
692 adap->dev.parent = &pdev->dev;
693
694 adap->nr = pdev->id;
695 r = i2c_add_numbered_adapter(adap);
696 if (r) {
697 dev_err(&pdev->dev, "failure adding adapter\n");
698 goto err_free_irq;
699 }
700
701 return 0;
702
703err_free_irq:
704 free_irq(dev->irq, dev);
705err_iounmap:
706 iounmap(dev->base);
707err_unuse_clocks:
708 clk_disable(dev->clk);
709 clk_put(dev->clk);
710 dev->clk = NULL;
711err_free_mem:
712 platform_set_drvdata(pdev, NULL);
713 put_device(&pdev->dev);
714 kfree(dev);
715err_release_region:
716 release_mem_region(mem->start, resource_size(mem));
717
718 return r;
719}
720
721static int __devexit dw_i2c_remove(struct platform_device *pdev)
722{
723 struct dw_i2c_dev *dev = platform_get_drvdata(pdev);
724 struct resource *mem;
725
726 platform_set_drvdata(pdev, NULL);
727 i2c_del_adapter(&dev->adapter);
728 put_device(&pdev->dev);
729
730 clk_disable(dev->clk);
731 clk_put(dev->clk);
732 dev->clk = NULL;
733
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900734 writel(0, dev->base + DW_IC_ENABLE);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300735 free_irq(dev->irq, dev);
736 kfree(dev);
737
738 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
739 release_mem_region(mem->start, resource_size(mem));
740 return 0;
741}
742
743/* work with hotplug and coldplug */
744MODULE_ALIAS("platform:i2c_designware");
745
746static struct platform_driver dw_i2c_driver = {
747 .remove = __devexit_p(dw_i2c_remove),
748 .driver = {
749 .name = "i2c_designware",
750 .owner = THIS_MODULE,
751 },
752};
753
754static int __init dw_i2c_init_driver(void)
755{
756 return platform_driver_probe(&dw_i2c_driver, dw_i2c_probe);
757}
758module_init(dw_i2c_init_driver);
759
760static void __exit dw_i2c_exit_driver(void)
761{
762 platform_driver_unregister(&dw_i2c_driver);
763}
764module_exit(dw_i2c_exit_driver);
765
766MODULE_AUTHOR("Baruch Siach <baruch@tkos.co.il>");
767MODULE_DESCRIPTION("Synopsys DesignWare I2C bus adapter");
768MODULE_LICENSE("GPL");