blob: f184d822d3d448a1133454a08b117ce0c7c49f1a [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
Shinya Kuribayashi201d6a72009-11-06 21:50:40 +090093#define DW_IC_INTR_DEFAULT_MASK (DW_IC_INTR_RX_FULL | \
94 DW_IC_INTR_TX_EMPTY | \
95 DW_IC_INTR_TX_ABRT | \
96 DW_IC_INTR_STOP_DET)
97
Baruch Siach1ab52cf2009-06-22 16:36:29 +030098#define DW_IC_STATUS_ACTIVITY 0x1
99
100#define DW_IC_ERR_TX_ABRT 0x1
101
102/*
103 * status codes
104 */
105#define STATUS_IDLE 0x0
106#define STATUS_WRITE_IN_PROGRESS 0x1
107#define STATUS_READ_IN_PROGRESS 0x2
108
109#define TIMEOUT 20 /* ms */
110
111/*
112 * hardware abort codes from the DW_IC_TX_ABRT_SOURCE register
113 *
114 * only expected abort codes are listed here
115 * refer to the datasheet for the full list
116 */
117#define ABRT_7B_ADDR_NOACK 0
118#define ABRT_10ADDR1_NOACK 1
119#define ABRT_10ADDR2_NOACK 2
120#define ABRT_TXDATA_NOACK 3
121#define ABRT_GCALL_NOACK 4
122#define ABRT_GCALL_READ 5
123#define ABRT_SBYTE_ACKDET 7
124#define ABRT_SBYTE_NORSTRT 9
125#define ABRT_10B_RD_NORSTRT 10
126#define ARB_MASTER_DIS 11
127#define ARB_LOST 12
128
129static char *abort_sources[] = {
130 [ABRT_7B_ADDR_NOACK] =
131 "slave address not acknowledged (7bit mode)",
132 [ABRT_10ADDR1_NOACK] =
133 "first address byte not acknowledged (10bit mode)",
134 [ABRT_10ADDR2_NOACK] =
135 "second address byte not acknowledged (10bit mode)",
136 [ABRT_TXDATA_NOACK] =
137 "data not acknowledged",
138 [ABRT_GCALL_NOACK] =
139 "no acknowledgement for a general call",
140 [ABRT_GCALL_READ] =
141 "read after general call",
142 [ABRT_SBYTE_ACKDET] =
143 "start byte acknowledged",
144 [ABRT_SBYTE_NORSTRT] =
145 "trying to send start byte when restart is disabled",
146 [ABRT_10B_RD_NORSTRT] =
147 "trying to read when restart is disabled (10bit mode)",
148 [ARB_MASTER_DIS] =
149 "trying to use disabled adapter",
150 [ARB_LOST] =
151 "lost arbitration",
152};
153
154/**
155 * struct dw_i2c_dev - private i2c-designware data
156 * @dev: driver model device node
157 * @base: IO registers pointer
158 * @cmd_complete: tx completion indicator
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300159 * @lock: protect this struct and IO registers
160 * @clk: input reference clock
161 * @cmd_err: run time hadware error code
162 * @msgs: points to an array of messages currently being transfered
163 * @msgs_num: the number of elements in msgs
164 * @msg_write_idx: the element index of the current tx message in the msgs
165 * array
166 * @tx_buf_len: the length of the current tx buffer
167 * @tx_buf: the current tx buffer
168 * @msg_read_idx: the element index of the current rx message in the msgs
169 * array
170 * @rx_buf_len: the length of the current rx buffer
171 * @rx_buf: the current rx buffer
172 * @msg_err: error status of the current transfer
173 * @status: i2c master status, one of STATUS_*
174 * @abort_source: copy of the TX_ABRT_SOURCE register
175 * @irq: interrupt number for the i2c master
176 * @adapter: i2c subsystem adapter node
177 * @tx_fifo_depth: depth of the hardware tx fifo
178 * @rx_fifo_depth: depth of the hardware rx fifo
179 */
180struct dw_i2c_dev {
181 struct device *dev;
182 void __iomem *base;
183 struct completion cmd_complete;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300184 struct mutex lock;
185 struct clk *clk;
186 int cmd_err;
187 struct i2c_msg *msgs;
188 int msgs_num;
189 int msg_write_idx;
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900190 u32 tx_buf_len;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300191 u8 *tx_buf;
192 int msg_read_idx;
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900193 u32 rx_buf_len;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300194 u8 *rx_buf;
195 int msg_err;
196 unsigned int status;
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900197 u32 abort_source;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300198 int irq;
199 struct i2c_adapter adapter;
200 unsigned int tx_fifo_depth;
201 unsigned int rx_fifo_depth;
202};
203
Shinya Kuribayashid60c7e82009-11-06 21:47:01 +0900204static u32
205i2c_dw_scl_hcnt(u32 ic_clk, u32 tSYMBOL, u32 tf, int cond, int offset)
206{
207 /*
208 * DesignWare I2C core doesn't seem to have solid strategy to meet
209 * the tHD;STA timing spec. Configuring _HCNT based on tHIGH spec
210 * will result in violation of the tHD;STA spec.
211 */
212 if (cond)
213 /*
214 * Conditional expression:
215 *
216 * IC_[FS]S_SCL_HCNT + (1+4+3) >= IC_CLK * tHIGH
217 *
218 * This is based on the DW manuals, and represents an ideal
219 * configuration. The resulting I2C bus speed will be
220 * faster than any of the others.
221 *
222 * If your hardware is free from tHD;STA issue, try this one.
223 */
224 return (ic_clk * tSYMBOL + 5000) / 10000 - 8 + offset;
225 else
226 /*
227 * Conditional expression:
228 *
229 * IC_[FS]S_SCL_HCNT + 3 >= IC_CLK * (tHD;STA + tf)
230 *
231 * This is just experimental rule; the tHD;STA period turned
232 * out to be proportinal to (_HCNT + 3). With this setting,
233 * we could meet both tHIGH and tHD;STA timing specs.
234 *
235 * If unsure, you'd better to take this alternative.
236 *
237 * The reason why we need to take into account "tf" here,
238 * is the same as described in i2c_dw_scl_lcnt().
239 */
240 return (ic_clk * (tSYMBOL + tf) + 5000) / 10000 - 3 + offset;
241}
242
243static u32 i2c_dw_scl_lcnt(u32 ic_clk, u32 tLOW, u32 tf, int offset)
244{
245 /*
246 * Conditional expression:
247 *
248 * IC_[FS]S_SCL_LCNT + 1 >= IC_CLK * (tLOW + tf)
249 *
250 * DW I2C core starts counting the SCL CNTs for the LOW period
251 * of the SCL clock (tLOW) as soon as it pulls the SCL line.
252 * In order to meet the tLOW timing spec, we need to take into
253 * account the fall time of SCL signal (tf). Default tf value
254 * should be 0.3 us, for safety.
255 */
256 return ((ic_clk * (tLOW + tf) + 5000) / 10000) - 1 + offset;
257}
258
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300259/**
260 * i2c_dw_init() - initialize the designware i2c master hardware
261 * @dev: device private data
262 *
263 * This functions configures and enables the I2C master.
264 * This function is called during I2C init function, and in case of timeout at
265 * run time.
266 */
267static void i2c_dw_init(struct dw_i2c_dev *dev)
268{
269 u32 input_clock_khz = clk_get_rate(dev->clk) / 1000;
Shinya Kuribayashid60c7e82009-11-06 21:47:01 +0900270 u32 ic_con, hcnt, lcnt;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300271
272 /* Disable the adapter */
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900273 writel(0, dev->base + DW_IC_ENABLE);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300274
275 /* set standard and fast speed deviders for high/low periods */
Shinya Kuribayashid60c7e82009-11-06 21:47:01 +0900276
277 /* Standard-mode */
278 hcnt = i2c_dw_scl_hcnt(input_clock_khz,
279 40, /* tHD;STA = tHIGH = 4.0 us */
280 3, /* tf = 0.3 us */
281 0, /* 0: DW default, 1: Ideal */
282 0); /* No offset */
283 lcnt = i2c_dw_scl_lcnt(input_clock_khz,
284 47, /* tLOW = 4.7 us */
285 3, /* tf = 0.3 us */
286 0); /* No offset */
287 writel(hcnt, dev->base + DW_IC_SS_SCL_HCNT);
288 writel(lcnt, dev->base + DW_IC_SS_SCL_LCNT);
289 dev_dbg(dev->dev, "Standard-mode HCNT:LCNT = %d:%d\n", hcnt, lcnt);
290
291 /* Fast-mode */
292 hcnt = i2c_dw_scl_hcnt(input_clock_khz,
293 6, /* tHD;STA = tHIGH = 0.6 us */
294 3, /* tf = 0.3 us */
295 0, /* 0: DW default, 1: Ideal */
296 0); /* No offset */
297 lcnt = i2c_dw_scl_lcnt(input_clock_khz,
298 13, /* tLOW = 1.3 us */
299 3, /* tf = 0.3 us */
300 0); /* No offset */
301 writel(hcnt, dev->base + DW_IC_FS_SCL_HCNT);
302 writel(lcnt, dev->base + DW_IC_FS_SCL_LCNT);
303 dev_dbg(dev->dev, "Fast-mode HCNT:LCNT = %d:%d\n", hcnt, lcnt);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300304
Shinya Kuribayashi4cb6d1d2009-11-06 21:48:12 +0900305 /* Configure Tx/Rx FIFO threshold levels */
306 writel(dev->tx_fifo_depth - 1, dev->base + DW_IC_TX_TL);
307 writel(0, dev->base + DW_IC_RX_TL);
308
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300309 /* configure the i2c master */
310 ic_con = DW_IC_CON_MASTER | DW_IC_CON_SLAVE_DISABLE |
311 DW_IC_CON_RESTART_EN | DW_IC_CON_SPEED_FAST;
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900312 writel(ic_con, dev->base + DW_IC_CON);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300313}
314
315/*
316 * Waiting for bus not busy
317 */
318static int i2c_dw_wait_bus_not_busy(struct dw_i2c_dev *dev)
319{
320 int timeout = TIMEOUT;
321
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900322 while (readl(dev->base + DW_IC_STATUS) & DW_IC_STATUS_ACTIVITY) {
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300323 if (timeout <= 0) {
324 dev_warn(dev->dev, "timeout waiting for bus ready\n");
325 return -ETIMEDOUT;
326 }
327 timeout--;
328 mdelay(1);
329 }
330
331 return 0;
332}
333
Shinya Kuribayashi81e798b2009-11-06 21:48:55 +0900334static void i2c_dw_xfer_init(struct dw_i2c_dev *dev)
335{
336 struct i2c_msg *msgs = dev->msgs;
337 u32 ic_con;
338
339 /* Disable the adapter */
340 writel(0, dev->base + DW_IC_ENABLE);
341
342 /* set the slave (target) address */
343 writel(msgs[dev->msg_write_idx].addr, dev->base + DW_IC_TAR);
344
345 /* if the slave address is ten bit address, enable 10BITADDR */
346 ic_con = readl(dev->base + DW_IC_CON);
347 if (msgs[dev->msg_write_idx].flags & I2C_M_TEN)
348 ic_con |= DW_IC_CON_10BITADDR_MASTER;
349 else
350 ic_con &= ~DW_IC_CON_10BITADDR_MASTER;
351 writel(ic_con, dev->base + DW_IC_CON);
352
353 /* Enable the adapter */
354 writel(1, dev->base + DW_IC_ENABLE);
Shinya Kuribayashi201d6a72009-11-06 21:50:40 +0900355
356 /* Enable interrupts */
357 writel(DW_IC_INTR_DEFAULT_MASK, dev->base + DW_IC_INTR_MASK);
Shinya Kuribayashi81e798b2009-11-06 21:48:55 +0900358}
359
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300360/*
Shinya Kuribayashi201d6a72009-11-06 21:50:40 +0900361 * Initiate (and continue) low level master read/write transaction.
362 * This function is only called from i2c_dw_isr, and pumping i2c_msg
363 * messages into the tx buffer. Even if the size of i2c_msg data is
364 * longer than the size of the tx buffer, it handles everything.
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300365 */
366static void
Shinya Kuribayashie77cf232009-11-06 21:46:04 +0900367i2c_dw_xfer_msg(struct dw_i2c_dev *dev)
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300368{
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300369 struct i2c_msg *msgs = dev->msgs;
Shinya Kuribayashi81e798b2009-11-06 21:48:55 +0900370 u32 intr_mask;
Shinya Kuribayashiae722222009-11-06 21:49:39 +0900371 int tx_limit, rx_limit;
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900372 u32 addr = msgs[dev->msg_write_idx].addr;
373 u32 buf_len = dev->tx_buf_len;
Shinya Kuribayashi26ea15b2009-11-06 21:49:14 +0900374 u8 *buf = dev->tx_buf;;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300375
Shinya Kuribayashi201d6a72009-11-06 21:50:40 +0900376 intr_mask = DW_IC_INTR_DEFAULT_MASK;
Shinya Kuribayashic70c5cd2009-11-06 21:47:30 +0900377
Shinya Kuribayashi6d2ea482009-11-06 21:46:29 +0900378 for (; dev->msg_write_idx < dev->msgs_num; dev->msg_write_idx++) {
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300379 /* if target address has changed, we need to
380 * reprogram the target address in the i2c
381 * adapter when we are done with this transfer
382 */
383 if (msgs[dev->msg_write_idx].addr != addr)
384 return;
385
386 if (msgs[dev->msg_write_idx].len == 0) {
387 dev_err(dev->dev,
388 "%s: invalid message length\n", __func__);
389 dev->msg_err = -EINVAL;
390 return;
391 }
392
393 if (!(dev->status & STATUS_WRITE_IN_PROGRESS)) {
394 /* new i2c_msg */
Shinya Kuribayashi26ea15b2009-11-06 21:49:14 +0900395 buf = msgs[dev->msg_write_idx].buf;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300396 buf_len = msgs[dev->msg_write_idx].len;
397 }
398
Shinya Kuribayashiae722222009-11-06 21:49:39 +0900399 tx_limit = dev->tx_fifo_depth - readl(dev->base + DW_IC_TXFLR);
400 rx_limit = dev->rx_fifo_depth - readl(dev->base + DW_IC_RXFLR);
401
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300402 while (buf_len > 0 && tx_limit > 0 && rx_limit > 0) {
403 if (msgs[dev->msg_write_idx].flags & I2C_M_RD) {
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900404 writel(0x100, dev->base + DW_IC_DATA_CMD);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300405 rx_limit--;
406 } else
Shinya Kuribayashi26ea15b2009-11-06 21:49:14 +0900407 writel(*buf++, dev->base + DW_IC_DATA_CMD);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300408 tx_limit--; buf_len--;
409 }
Shinya Kuribayashic70c5cd2009-11-06 21:47:30 +0900410
Shinya Kuribayashi26ea15b2009-11-06 21:49:14 +0900411 dev->tx_buf = buf;
Shinya Kuribayashic70c5cd2009-11-06 21:47:30 +0900412 dev->tx_buf_len = buf_len;
413
414 if (buf_len > 0) {
415 /* more bytes to be written */
Shinya Kuribayashic70c5cd2009-11-06 21:47:30 +0900416 dev->status |= STATUS_WRITE_IN_PROGRESS;
417 break;
Shinya Kuribayashi201d6a72009-11-06 21:50:40 +0900418 } else {
Shinya Kuribayashic70c5cd2009-11-06 21:47:30 +0900419 dev->status &= ~STATUS_WRITE_IN_PROGRESS;
Shinya Kuribayashi201d6a72009-11-06 21:50:40 +0900420 intr_mask &= ~DW_IC_INTR_TX_EMPTY;
421 }
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300422 }
423
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900424 writel(intr_mask, dev->base + DW_IC_INTR_MASK);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300425}
426
427static void
Shinya Kuribayashi78839bd2009-11-06 21:45:39 +0900428i2c_dw_read(struct dw_i2c_dev *dev)
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300429{
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300430 struct i2c_msg *msgs = dev->msgs;
Shinya Kuribayashiae722222009-11-06 21:49:39 +0900431 int rx_valid;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300432
Shinya Kuribayashi6d2ea482009-11-06 21:46:29 +0900433 for (; dev->msg_read_idx < dev->msgs_num; dev->msg_read_idx++) {
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900434 u32 len;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300435 u8 *buf;
436
437 if (!(msgs[dev->msg_read_idx].flags & I2C_M_RD))
438 continue;
439
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300440 if (!(dev->status & STATUS_READ_IN_PROGRESS)) {
441 len = msgs[dev->msg_read_idx].len;
442 buf = msgs[dev->msg_read_idx].buf;
443 } else {
444 len = dev->rx_buf_len;
445 buf = dev->rx_buf;
446 }
447
Shinya Kuribayashiae722222009-11-06 21:49:39 +0900448 rx_valid = readl(dev->base + DW_IC_RXFLR);
449
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300450 for (; len > 0 && rx_valid > 0; len--, rx_valid--)
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900451 *buf++ = readl(dev->base + DW_IC_DATA_CMD);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300452
453 if (len > 0) {
454 dev->status |= STATUS_READ_IN_PROGRESS;
455 dev->rx_buf_len = len;
456 dev->rx_buf = buf;
457 return;
458 } else
459 dev->status &= ~STATUS_READ_IN_PROGRESS;
460 }
461}
462
463/*
464 * Prepare controller for a transaction and call i2c_dw_xfer_msg
465 */
466static int
467i2c_dw_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
468{
469 struct dw_i2c_dev *dev = i2c_get_adapdata(adap);
470 int ret;
471
472 dev_dbg(dev->dev, "%s: msgs: %d\n", __func__, num);
473
474 mutex_lock(&dev->lock);
475
476 INIT_COMPLETION(dev->cmd_complete);
477 dev->msgs = msgs;
478 dev->msgs_num = num;
479 dev->cmd_err = 0;
480 dev->msg_write_idx = 0;
481 dev->msg_read_idx = 0;
482 dev->msg_err = 0;
483 dev->status = STATUS_IDLE;
484
485 ret = i2c_dw_wait_bus_not_busy(dev);
486 if (ret < 0)
487 goto done;
488
489 /* start the transfers */
Shinya Kuribayashi81e798b2009-11-06 21:48:55 +0900490 i2c_dw_xfer_init(dev);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300491
492 /* wait for tx to complete */
493 ret = wait_for_completion_interruptible_timeout(&dev->cmd_complete, HZ);
494 if (ret == 0) {
495 dev_err(dev->dev, "controller timed out\n");
496 i2c_dw_init(dev);
497 ret = -ETIMEDOUT;
498 goto done;
499 } else if (ret < 0)
500 goto done;
501
502 if (dev->msg_err) {
503 ret = dev->msg_err;
504 goto done;
505 }
506
507 /* no error */
508 if (likely(!dev->cmd_err)) {
Shinya Kuribayashi07745392009-11-06 21:47:51 +0900509 /* Disable the adapter */
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900510 writel(0, dev->base + DW_IC_ENABLE);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300511 ret = num;
512 goto done;
513 }
514
515 /* We have an error */
516 if (dev->cmd_err == DW_IC_ERR_TX_ABRT) {
517 unsigned long abort_source = dev->abort_source;
518 int i;
519
520 for_each_bit(i, &abort_source, ARRAY_SIZE(abort_sources)) {
521 dev_err(dev->dev, "%s: %s\n", __func__, abort_sources[i]);
522 }
523 }
524 ret = -EIO;
525
526done:
527 mutex_unlock(&dev->lock);
528
529 return ret;
530}
531
532static u32 i2c_dw_func(struct i2c_adapter *adap)
533{
Shinya Kuribayashi52d7e432009-11-06 21:50:02 +0900534 return I2C_FUNC_I2C |
535 I2C_FUNC_10BIT_ADDR |
536 I2C_FUNC_SMBUS_BYTE |
537 I2C_FUNC_SMBUS_BYTE_DATA |
538 I2C_FUNC_SMBUS_WORD_DATA |
539 I2C_FUNC_SMBUS_I2C_BLOCK;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300540}
541
Shinya Kuribayashie28000a2009-11-06 21:44:37 +0900542static u32 i2c_dw_read_clear_intrbits(struct dw_i2c_dev *dev)
543{
544 u32 stat;
545
546 /*
547 * The IC_INTR_STAT register just indicates "enabled" interrupts.
548 * Ths unmasked raw version of interrupt status bits are available
549 * in the IC_RAW_INTR_STAT register.
550 *
551 * That is,
552 * stat = readl(IC_INTR_STAT);
553 * equals to,
554 * stat = readl(IC_RAW_INTR_STAT) & readl(IC_INTR_MASK);
555 *
556 * The raw version might be useful for debugging purposes.
557 */
558 stat = readl(dev->base + DW_IC_INTR_STAT);
559
560 /*
561 * Do not use the IC_CLR_INTR register to clear interrupts, or
562 * you'll miss some interrupts, triggered during the period from
563 * readl(IC_INTR_STAT) to readl(IC_CLR_INTR).
564 *
565 * Instead, use the separately-prepared IC_CLR_* registers.
566 */
567 if (stat & DW_IC_INTR_RX_UNDER)
568 readl(dev->base + DW_IC_CLR_RX_UNDER);
569 if (stat & DW_IC_INTR_RX_OVER)
570 readl(dev->base + DW_IC_CLR_RX_OVER);
571 if (stat & DW_IC_INTR_TX_OVER)
572 readl(dev->base + DW_IC_CLR_TX_OVER);
573 if (stat & DW_IC_INTR_RD_REQ)
574 readl(dev->base + DW_IC_CLR_RD_REQ);
575 if (stat & DW_IC_INTR_TX_ABRT) {
576 /*
577 * The IC_TX_ABRT_SOURCE register is cleared whenever
578 * the IC_CLR_TX_ABRT is read. Preserve it beforehand.
579 */
580 dev->abort_source = readl(dev->base + DW_IC_TX_ABRT_SOURCE);
581 readl(dev->base + DW_IC_CLR_TX_ABRT);
582 }
583 if (stat & DW_IC_INTR_RX_DONE)
584 readl(dev->base + DW_IC_CLR_RX_DONE);
585 if (stat & DW_IC_INTR_ACTIVITY)
586 readl(dev->base + DW_IC_CLR_ACTIVITY);
587 if (stat & DW_IC_INTR_STOP_DET)
588 readl(dev->base + DW_IC_CLR_STOP_DET);
589 if (stat & DW_IC_INTR_START_DET)
590 readl(dev->base + DW_IC_CLR_START_DET);
591 if (stat & DW_IC_INTR_GEN_CALL)
592 readl(dev->base + DW_IC_CLR_GEN_CALL);
593
594 return stat;
595}
596
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300597/*
598 * Interrupt service routine. This gets called whenever an I2C interrupt
599 * occurs.
600 */
601static irqreturn_t i2c_dw_isr(int this_irq, void *dev_id)
602{
603 struct dw_i2c_dev *dev = dev_id;
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900604 u32 stat;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300605
Shinya Kuribayashie28000a2009-11-06 21:44:37 +0900606 stat = i2c_dw_read_clear_intrbits(dev);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300607 dev_dbg(dev->dev, "%s: stat=0x%x\n", __func__, stat);
Shinya Kuribayashie28000a2009-11-06 21:44:37 +0900608
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300609 if (stat & DW_IC_INTR_TX_ABRT) {
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300610 dev->cmd_err |= DW_IC_ERR_TX_ABRT;
611 dev->status = STATUS_IDLE;
Shinya Kuribayashi07745392009-11-06 21:47:51 +0900612 }
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300613
Shinya Kuribayashi21a89d42009-11-06 21:48:33 +0900614 if (stat & DW_IC_INTR_RX_FULL)
Shinya Kuribayashi07745392009-11-06 21:47:51 +0900615 i2c_dw_read(dev);
Shinya Kuribayashi21a89d42009-11-06 21:48:33 +0900616
617 if (stat & DW_IC_INTR_TX_EMPTY)
Shinya Kuribayashi07745392009-11-06 21:47:51 +0900618 i2c_dw_xfer_msg(dev);
Shinya Kuribayashi07745392009-11-06 21:47:51 +0900619
620 /*
621 * No need to modify or disable the interrupt mask here.
622 * i2c_dw_xfer_msg() will take care of it according to
623 * the current transmit status.
624 */
625
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300626 if (stat & (DW_IC_INTR_TX_ABRT | DW_IC_INTR_STOP_DET))
627 complete(&dev->cmd_complete);
628
629 return IRQ_HANDLED;
630}
631
632static struct i2c_algorithm i2c_dw_algo = {
633 .master_xfer = i2c_dw_xfer,
634 .functionality = i2c_dw_func,
635};
636
637static int __devinit dw_i2c_probe(struct platform_device *pdev)
638{
639 struct dw_i2c_dev *dev;
640 struct i2c_adapter *adap;
Shinya Kuribayashi91b52ca2009-11-06 21:45:07 +0900641 struct resource *mem, *ioarea;
642 int irq, r;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300643
644 /* NOTE: driver uses the static register mapping */
645 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
646 if (!mem) {
647 dev_err(&pdev->dev, "no mem resource?\n");
648 return -EINVAL;
649 }
650
Shinya Kuribayashi91b52ca2009-11-06 21:45:07 +0900651 irq = platform_get_irq(pdev, 0);
652 if (irq < 0) {
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300653 dev_err(&pdev->dev, "no irq resource?\n");
Shinya Kuribayashi91b52ca2009-11-06 21:45:07 +0900654 return irq; /* -ENXIO */
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300655 }
656
657 ioarea = request_mem_region(mem->start, resource_size(mem),
658 pdev->name);
659 if (!ioarea) {
660 dev_err(&pdev->dev, "I2C region already claimed\n");
661 return -EBUSY;
662 }
663
664 dev = kzalloc(sizeof(struct dw_i2c_dev), GFP_KERNEL);
665 if (!dev) {
666 r = -ENOMEM;
667 goto err_release_region;
668 }
669
670 init_completion(&dev->cmd_complete);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300671 mutex_init(&dev->lock);
672 dev->dev = get_device(&pdev->dev);
Shinya Kuribayashi91b52ca2009-11-06 21:45:07 +0900673 dev->irq = irq;
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300674 platform_set_drvdata(pdev, dev);
675
676 dev->clk = clk_get(&pdev->dev, NULL);
677 if (IS_ERR(dev->clk)) {
678 r = -ENODEV;
679 goto err_free_mem;
680 }
681 clk_enable(dev->clk);
682
683 dev->base = ioremap(mem->start, resource_size(mem));
684 if (dev->base == NULL) {
685 dev_err(&pdev->dev, "failure mapping io resources\n");
686 r = -EBUSY;
687 goto err_unuse_clocks;
688 }
689 {
690 u32 param1 = readl(dev->base + DW_IC_COMP_PARAM_1);
691
692 dev->tx_fifo_depth = ((param1 >> 16) & 0xff) + 1;
693 dev->rx_fifo_depth = ((param1 >> 8) & 0xff) + 1;
694 }
695 i2c_dw_init(dev);
696
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900697 writel(0, dev->base + DW_IC_INTR_MASK); /* disable IRQ */
Shinya Kuribayashi201d6a72009-11-06 21:50:40 +0900698 r = request_irq(dev->irq, i2c_dw_isr, IRQF_DISABLED, pdev->name, dev);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300699 if (r) {
700 dev_err(&pdev->dev, "failure requesting irq %i\n", dev->irq);
701 goto err_iounmap;
702 }
703
704 adap = &dev->adapter;
705 i2c_set_adapdata(adap, dev);
706 adap->owner = THIS_MODULE;
707 adap->class = I2C_CLASS_HWMON;
708 strlcpy(adap->name, "Synopsys DesignWare I2C adapter",
709 sizeof(adap->name));
710 adap->algo = &i2c_dw_algo;
711 adap->dev.parent = &pdev->dev;
712
713 adap->nr = pdev->id;
714 r = i2c_add_numbered_adapter(adap);
715 if (r) {
716 dev_err(&pdev->dev, "failure adding adapter\n");
717 goto err_free_irq;
718 }
719
720 return 0;
721
722err_free_irq:
723 free_irq(dev->irq, dev);
724err_iounmap:
725 iounmap(dev->base);
726err_unuse_clocks:
727 clk_disable(dev->clk);
728 clk_put(dev->clk);
729 dev->clk = NULL;
730err_free_mem:
731 platform_set_drvdata(pdev, NULL);
732 put_device(&pdev->dev);
733 kfree(dev);
734err_release_region:
735 release_mem_region(mem->start, resource_size(mem));
736
737 return r;
738}
739
740static int __devexit dw_i2c_remove(struct platform_device *pdev)
741{
742 struct dw_i2c_dev *dev = platform_get_drvdata(pdev);
743 struct resource *mem;
744
745 platform_set_drvdata(pdev, NULL);
746 i2c_del_adapter(&dev->adapter);
747 put_device(&pdev->dev);
748
749 clk_disable(dev->clk);
750 clk_put(dev->clk);
751 dev->clk = NULL;
752
Shinya Kuribayashied5e1dd2009-11-06 21:43:52 +0900753 writel(0, dev->base + DW_IC_ENABLE);
Baruch Siach1ab52cf2009-06-22 16:36:29 +0300754 free_irq(dev->irq, dev);
755 kfree(dev);
756
757 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
758 release_mem_region(mem->start, resource_size(mem));
759 return 0;
760}
761
762/* work with hotplug and coldplug */
763MODULE_ALIAS("platform:i2c_designware");
764
765static struct platform_driver dw_i2c_driver = {
766 .remove = __devexit_p(dw_i2c_remove),
767 .driver = {
768 .name = "i2c_designware",
769 .owner = THIS_MODULE,
770 },
771};
772
773static int __init dw_i2c_init_driver(void)
774{
775 return platform_driver_probe(&dw_i2c_driver, dw_i2c_probe);
776}
777module_init(dw_i2c_init_driver);
778
779static void __exit dw_i2c_exit_driver(void)
780{
781 platform_driver_unregister(&dw_i2c_driver);
782}
783module_exit(dw_i2c_exit_driver);
784
785MODULE_AUTHOR("Baruch Siach <baruch@tkos.co.il>");
786MODULE_DESCRIPTION("Synopsys DesignWare I2C bus adapter");
787MODULE_LICENSE("GPL");