blob: 6356439454eee1c382d29e8948bb3b818479aacb [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tzachi Perelsteina0832792007-11-12 19:38:51 +02002 * Driver for the i2c controller on the Marvell line of host bridges
3 * (e.g, gt642[46]0, mv643[46]0, mv644[46]0, and Orion SoC family).
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 * Author: Mark A. Greer <mgreer@mvista.com>
6 *
7 * 2005 (c) MontaVista, Software, Inc. This file is licensed under
8 * the terms of the GNU General Public License version 2. This program
9 * is licensed "as is" without any warranty of any kind, whether express
10 * or implied.
11 */
12#include <linux/kernel.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090013#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/module.h>
15#include <linux/spinlock.h>
16#include <linux/i2c.h>
17#include <linux/interrupt.h>
Tzachi Perelsteina0832792007-11-12 19:38:51 +020018#include <linux/mv643xx_i2c.h>
Russell Kingd052d1b2005-10-29 19:07:23 +010019#include <linux/platform_device.h>
H Hartley Sweeten21782182010-05-21 18:41:01 +020020#include <linux/io.h>
Andrew Lunnb61d1572012-07-22 12:51:35 +020021#include <linux/of.h>
22#include <linux/of_irq.h>
23#include <linux/of_i2c.h>
24#include <linux/clk.h>
25#include <linux/err.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
27/* Register defines */
28#define MV64XXX_I2C_REG_SLAVE_ADDR 0x00
29#define MV64XXX_I2C_REG_DATA 0x04
30#define MV64XXX_I2C_REG_CONTROL 0x08
31#define MV64XXX_I2C_REG_STATUS 0x0c
32#define MV64XXX_I2C_REG_BAUD 0x0c
33#define MV64XXX_I2C_REG_EXT_SLAVE_ADDR 0x10
34#define MV64XXX_I2C_REG_SOFT_RESET 0x1c
35
36#define MV64XXX_I2C_REG_CONTROL_ACK 0x00000004
37#define MV64XXX_I2C_REG_CONTROL_IFLG 0x00000008
38#define MV64XXX_I2C_REG_CONTROL_STOP 0x00000010
39#define MV64XXX_I2C_REG_CONTROL_START 0x00000020
40#define MV64XXX_I2C_REG_CONTROL_TWSIEN 0x00000040
41#define MV64XXX_I2C_REG_CONTROL_INTEN 0x00000080
42
43/* Ctlr status values */
44#define MV64XXX_I2C_STATUS_BUS_ERR 0x00
45#define MV64XXX_I2C_STATUS_MAST_START 0x08
46#define MV64XXX_I2C_STATUS_MAST_REPEAT_START 0x10
47#define MV64XXX_I2C_STATUS_MAST_WR_ADDR_ACK 0x18
48#define MV64XXX_I2C_STATUS_MAST_WR_ADDR_NO_ACK 0x20
49#define MV64XXX_I2C_STATUS_MAST_WR_ACK 0x28
50#define MV64XXX_I2C_STATUS_MAST_WR_NO_ACK 0x30
51#define MV64XXX_I2C_STATUS_MAST_LOST_ARB 0x38
52#define MV64XXX_I2C_STATUS_MAST_RD_ADDR_ACK 0x40
53#define MV64XXX_I2C_STATUS_MAST_RD_ADDR_NO_ACK 0x48
54#define MV64XXX_I2C_STATUS_MAST_RD_DATA_ACK 0x50
55#define MV64XXX_I2C_STATUS_MAST_RD_DATA_NO_ACK 0x58
56#define MV64XXX_I2C_STATUS_MAST_WR_ADDR_2_ACK 0xd0
57#define MV64XXX_I2C_STATUS_MAST_WR_ADDR_2_NO_ACK 0xd8
58#define MV64XXX_I2C_STATUS_MAST_RD_ADDR_2_ACK 0xe0
59#define MV64XXX_I2C_STATUS_MAST_RD_ADDR_2_NO_ACK 0xe8
60#define MV64XXX_I2C_STATUS_NO_STATUS 0xf8
61
62/* Driver states */
63enum {
64 MV64XXX_I2C_STATE_INVALID,
65 MV64XXX_I2C_STATE_IDLE,
66 MV64XXX_I2C_STATE_WAITING_FOR_START_COND,
Rodolfo Giomettieda6bee2010-11-26 17:06:56 +010067 MV64XXX_I2C_STATE_WAITING_FOR_RESTART,
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 MV64XXX_I2C_STATE_WAITING_FOR_ADDR_1_ACK,
69 MV64XXX_I2C_STATE_WAITING_FOR_ADDR_2_ACK,
70 MV64XXX_I2C_STATE_WAITING_FOR_SLAVE_ACK,
71 MV64XXX_I2C_STATE_WAITING_FOR_SLAVE_DATA,
Linus Torvalds1da177e2005-04-16 15:20:36 -070072};
73
74/* Driver actions */
75enum {
76 MV64XXX_I2C_ACTION_INVALID,
77 MV64XXX_I2C_ACTION_CONTINUE,
78 MV64XXX_I2C_ACTION_SEND_START,
Rodolfo Giomettieda6bee2010-11-26 17:06:56 +010079 MV64XXX_I2C_ACTION_SEND_RESTART,
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 MV64XXX_I2C_ACTION_SEND_ADDR_1,
81 MV64XXX_I2C_ACTION_SEND_ADDR_2,
82 MV64XXX_I2C_ACTION_SEND_DATA,
83 MV64XXX_I2C_ACTION_RCV_DATA,
84 MV64XXX_I2C_ACTION_RCV_DATA_STOP,
85 MV64XXX_I2C_ACTION_SEND_STOP,
86};
87
88struct mv64xxx_i2c_data {
Russell King4243fa02013-05-16 21:39:12 +010089 struct i2c_msg *msgs;
90 int num_msgs;
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 int irq;
92 u32 state;
93 u32 action;
Mark A. Greere91c0212005-12-18 17:22:01 +010094 u32 aborting;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 u32 cntl_bits;
96 void __iomem *reg_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 u32 addr1;
98 u32 addr2;
99 u32 bytes_left;
100 u32 byte_posn;
Rodolfo Giomettieda6bee2010-11-26 17:06:56 +0100101 u32 send_stop;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 u32 block;
103 int rc;
104 u32 freq_m;
105 u32 freq_n;
Andrew Lunnb61d1572012-07-22 12:51:35 +0200106#if defined(CONFIG_HAVE_CLK)
107 struct clk *clk;
108#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 wait_queue_head_t waitq;
110 spinlock_t lock;
111 struct i2c_msg *msg;
112 struct i2c_adapter adapter;
113};
114
Russell King3420afb2013-05-16 21:38:11 +0100115static void
116mv64xxx_i2c_prepare_for_io(struct mv64xxx_i2c_data *drv_data,
117 struct i2c_msg *msg)
118{
119 u32 dir = 0;
120
121 drv_data->msg = msg;
122 drv_data->byte_posn = 0;
123 drv_data->bytes_left = msg->len;
124 drv_data->aborting = 0;
125 drv_data->rc = 0;
126 drv_data->cntl_bits = MV64XXX_I2C_REG_CONTROL_ACK |
127 MV64XXX_I2C_REG_CONTROL_INTEN | MV64XXX_I2C_REG_CONTROL_TWSIEN;
128
129 if (msg->flags & I2C_M_RD)
130 dir = 1;
131
132 if (msg->flags & I2C_M_TEN) {
133 drv_data->addr1 = 0xf0 | (((u32)msg->addr & 0x300) >> 7) | dir;
134 drv_data->addr2 = (u32)msg->addr & 0xff;
135 } else {
136 drv_data->addr1 = ((u32)msg->addr & 0x7f) << 1 | dir;
137 drv_data->addr2 = 0;
138 }
139}
140
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141/*
142 *****************************************************************************
143 *
144 * Finite State Machine & Interrupt Routines
145 *
146 *****************************************************************************
147 */
Dale Farnswortha07ad1c2007-08-14 18:37:14 +0200148
149/* Reset hardware and initialize FSM */
150static void
151mv64xxx_i2c_hw_init(struct mv64xxx_i2c_data *drv_data)
152{
153 writel(0, drv_data->reg_base + MV64XXX_I2C_REG_SOFT_RESET);
154 writel((((drv_data->freq_m & 0xf) << 3) | (drv_data->freq_n & 0x7)),
155 drv_data->reg_base + MV64XXX_I2C_REG_BAUD);
156 writel(0, drv_data->reg_base + MV64XXX_I2C_REG_SLAVE_ADDR);
157 writel(0, drv_data->reg_base + MV64XXX_I2C_REG_EXT_SLAVE_ADDR);
158 writel(MV64XXX_I2C_REG_CONTROL_TWSIEN | MV64XXX_I2C_REG_CONTROL_STOP,
159 drv_data->reg_base + MV64XXX_I2C_REG_CONTROL);
160 drv_data->state = MV64XXX_I2C_STATE_IDLE;
161}
162
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163static void
164mv64xxx_i2c_fsm(struct mv64xxx_i2c_data *drv_data, u32 status)
165{
166 /*
167 * If state is idle, then this is likely the remnants of an old
168 * operation that driver has given up on or the user has killed.
169 * If so, issue the stop condition and go to idle.
170 */
171 if (drv_data->state == MV64XXX_I2C_STATE_IDLE) {
172 drv_data->action = MV64XXX_I2C_ACTION_SEND_STOP;
173 return;
174 }
175
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 /* The status from the ctlr [mostly] tells us what to do next */
177 switch (status) {
178 /* Start condition interrupt */
179 case MV64XXX_I2C_STATUS_MAST_START: /* 0x08 */
180 case MV64XXX_I2C_STATUS_MAST_REPEAT_START: /* 0x10 */
181 drv_data->action = MV64XXX_I2C_ACTION_SEND_ADDR_1;
182 drv_data->state = MV64XXX_I2C_STATE_WAITING_FOR_ADDR_1_ACK;
183 break;
184
185 /* Performing a write */
186 case MV64XXX_I2C_STATUS_MAST_WR_ADDR_ACK: /* 0x18 */
187 if (drv_data->msg->flags & I2C_M_TEN) {
188 drv_data->action = MV64XXX_I2C_ACTION_SEND_ADDR_2;
189 drv_data->state =
190 MV64XXX_I2C_STATE_WAITING_FOR_ADDR_2_ACK;
191 break;
192 }
193 /* FALLTHRU */
194 case MV64XXX_I2C_STATUS_MAST_WR_ADDR_2_ACK: /* 0xd0 */
195 case MV64XXX_I2C_STATUS_MAST_WR_ACK: /* 0x28 */
Mark A. Greere91c0212005-12-18 17:22:01 +0100196 if ((drv_data->bytes_left == 0)
197 || (drv_data->aborting
198 && (drv_data->byte_posn != 0))) {
Russell King4243fa02013-05-16 21:39:12 +0100199 if (drv_data->send_stop || drv_data->aborting) {
Rodolfo Giomettieda6bee2010-11-26 17:06:56 +0100200 drv_data->action = MV64XXX_I2C_ACTION_SEND_STOP;
201 drv_data->state = MV64XXX_I2C_STATE_IDLE;
202 } else {
203 drv_data->action =
204 MV64XXX_I2C_ACTION_SEND_RESTART;
205 drv_data->state =
206 MV64XXX_I2C_STATE_WAITING_FOR_RESTART;
207 }
Mark A. Greere91c0212005-12-18 17:22:01 +0100208 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 drv_data->action = MV64XXX_I2C_ACTION_SEND_DATA;
210 drv_data->state =
211 MV64XXX_I2C_STATE_WAITING_FOR_SLAVE_ACK;
212 drv_data->bytes_left--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 }
214 break;
215
216 /* Performing a read */
217 case MV64XXX_I2C_STATUS_MAST_RD_ADDR_ACK: /* 40 */
218 if (drv_data->msg->flags & I2C_M_TEN) {
219 drv_data->action = MV64XXX_I2C_ACTION_SEND_ADDR_2;
220 drv_data->state =
221 MV64XXX_I2C_STATE_WAITING_FOR_ADDR_2_ACK;
222 break;
223 }
224 /* FALLTHRU */
225 case MV64XXX_I2C_STATUS_MAST_RD_ADDR_2_ACK: /* 0xe0 */
226 if (drv_data->bytes_left == 0) {
227 drv_data->action = MV64XXX_I2C_ACTION_SEND_STOP;
228 drv_data->state = MV64XXX_I2C_STATE_IDLE;
229 break;
230 }
231 /* FALLTHRU */
232 case MV64XXX_I2C_STATUS_MAST_RD_DATA_ACK: /* 0x50 */
233 if (status != MV64XXX_I2C_STATUS_MAST_RD_DATA_ACK)
234 drv_data->action = MV64XXX_I2C_ACTION_CONTINUE;
235 else {
236 drv_data->action = MV64XXX_I2C_ACTION_RCV_DATA;
237 drv_data->bytes_left--;
238 }
239 drv_data->state = MV64XXX_I2C_STATE_WAITING_FOR_SLAVE_DATA;
240
Mark A. Greere91c0212005-12-18 17:22:01 +0100241 if ((drv_data->bytes_left == 1) || drv_data->aborting)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 drv_data->cntl_bits &= ~MV64XXX_I2C_REG_CONTROL_ACK;
243 break;
244
245 case MV64XXX_I2C_STATUS_MAST_RD_DATA_NO_ACK: /* 0x58 */
246 drv_data->action = MV64XXX_I2C_ACTION_RCV_DATA_STOP;
247 drv_data->state = MV64XXX_I2C_STATE_IDLE;
248 break;
249
250 case MV64XXX_I2C_STATUS_MAST_WR_ADDR_NO_ACK: /* 0x20 */
251 case MV64XXX_I2C_STATUS_MAST_WR_NO_ACK: /* 30 */
252 case MV64XXX_I2C_STATUS_MAST_RD_ADDR_NO_ACK: /* 48 */
253 /* Doesn't seem to be a device at other end */
254 drv_data->action = MV64XXX_I2C_ACTION_SEND_STOP;
255 drv_data->state = MV64XXX_I2C_STATE_IDLE;
256 drv_data->rc = -ENODEV;
257 break;
258
259 default:
260 dev_err(&drv_data->adapter.dev,
261 "mv64xxx_i2c_fsm: Ctlr Error -- state: 0x%x, "
262 "status: 0x%x, addr: 0x%x, flags: 0x%x\n",
263 drv_data->state, status, drv_data->msg->addr,
264 drv_data->msg->flags);
265 drv_data->action = MV64XXX_I2C_ACTION_SEND_STOP;
Dale Farnswortha07ad1c2007-08-14 18:37:14 +0200266 mv64xxx_i2c_hw_init(drv_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 drv_data->rc = -EIO;
268 }
269}
270
271static void
272mv64xxx_i2c_do_action(struct mv64xxx_i2c_data *drv_data)
273{
274 switch(drv_data->action) {
Rodolfo Giomettieda6bee2010-11-26 17:06:56 +0100275 case MV64XXX_I2C_ACTION_SEND_RESTART:
Russell King4243fa02013-05-16 21:39:12 +0100276 /* We should only get here if we have further messages */
277 BUG_ON(drv_data->num_msgs == 0);
278
Rodolfo Giomettieda6bee2010-11-26 17:06:56 +0100279 drv_data->cntl_bits |= MV64XXX_I2C_REG_CONTROL_START;
Rodolfo Giomettieda6bee2010-11-26 17:06:56 +0100280 writel(drv_data->cntl_bits,
281 drv_data->reg_base + MV64XXX_I2C_REG_CONTROL);
Russell King4243fa02013-05-16 21:39:12 +0100282
283 drv_data->msgs++;
284 drv_data->num_msgs--;
285
286 /* Setup for the next message */
287 mv64xxx_i2c_prepare_for_io(drv_data, drv_data->msgs);
288
289 /*
290 * We're never at the start of the message here, and by this
291 * time it's already too late to do any protocol mangling.
292 * Thankfully, do not advertise support for that feature.
293 */
294 drv_data->send_stop = drv_data->num_msgs == 1;
Rodolfo Giomettieda6bee2010-11-26 17:06:56 +0100295 break;
296
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 case MV64XXX_I2C_ACTION_CONTINUE:
298 writel(drv_data->cntl_bits,
299 drv_data->reg_base + MV64XXX_I2C_REG_CONTROL);
300 break;
301
302 case MV64XXX_I2C_ACTION_SEND_START:
303 writel(drv_data->cntl_bits | MV64XXX_I2C_REG_CONTROL_START,
304 drv_data->reg_base + MV64XXX_I2C_REG_CONTROL);
305 break;
306
307 case MV64XXX_I2C_ACTION_SEND_ADDR_1:
308 writel(drv_data->addr1,
309 drv_data->reg_base + MV64XXX_I2C_REG_DATA);
310 writel(drv_data->cntl_bits,
311 drv_data->reg_base + MV64XXX_I2C_REG_CONTROL);
312 break;
313
314 case MV64XXX_I2C_ACTION_SEND_ADDR_2:
315 writel(drv_data->addr2,
316 drv_data->reg_base + MV64XXX_I2C_REG_DATA);
317 writel(drv_data->cntl_bits,
318 drv_data->reg_base + MV64XXX_I2C_REG_CONTROL);
319 break;
320
321 case MV64XXX_I2C_ACTION_SEND_DATA:
322 writel(drv_data->msg->buf[drv_data->byte_posn++],
323 drv_data->reg_base + MV64XXX_I2C_REG_DATA);
324 writel(drv_data->cntl_bits,
325 drv_data->reg_base + MV64XXX_I2C_REG_CONTROL);
326 break;
327
328 case MV64XXX_I2C_ACTION_RCV_DATA:
329 drv_data->msg->buf[drv_data->byte_posn++] =
330 readl(drv_data->reg_base + MV64XXX_I2C_REG_DATA);
331 writel(drv_data->cntl_bits,
332 drv_data->reg_base + MV64XXX_I2C_REG_CONTROL);
333 break;
334
335 case MV64XXX_I2C_ACTION_RCV_DATA_STOP:
336 drv_data->msg->buf[drv_data->byte_posn++] =
337 readl(drv_data->reg_base + MV64XXX_I2C_REG_DATA);
338 drv_data->cntl_bits &= ~MV64XXX_I2C_REG_CONTROL_INTEN;
339 writel(drv_data->cntl_bits | MV64XXX_I2C_REG_CONTROL_STOP,
340 drv_data->reg_base + MV64XXX_I2C_REG_CONTROL);
341 drv_data->block = 0;
Russell Kingd295a862013-05-16 10:30:59 +0000342 wake_up(&drv_data->waitq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 break;
344
345 case MV64XXX_I2C_ACTION_INVALID:
346 default:
347 dev_err(&drv_data->adapter.dev,
348 "mv64xxx_i2c_do_action: Invalid action: %d\n",
349 drv_data->action);
350 drv_data->rc = -EIO;
351 /* FALLTHRU */
352 case MV64XXX_I2C_ACTION_SEND_STOP:
353 drv_data->cntl_bits &= ~MV64XXX_I2C_REG_CONTROL_INTEN;
354 writel(drv_data->cntl_bits | MV64XXX_I2C_REG_CONTROL_STOP,
355 drv_data->reg_base + MV64XXX_I2C_REG_CONTROL);
356 drv_data->block = 0;
Russell Kingd295a862013-05-16 10:30:59 +0000357 wake_up(&drv_data->waitq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 break;
359 }
360}
361
Mikael Petterssonb0999cc2009-09-07 12:00:13 +0200362static irqreturn_t
David Howells7d12e782006-10-05 14:55:46 +0100363mv64xxx_i2c_intr(int irq, void *dev_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364{
365 struct mv64xxx_i2c_data *drv_data = dev_id;
366 unsigned long flags;
367 u32 status;
Mikael Petterssonb0999cc2009-09-07 12:00:13 +0200368 irqreturn_t rc = IRQ_NONE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
370 spin_lock_irqsave(&drv_data->lock, flags);
371 while (readl(drv_data->reg_base + MV64XXX_I2C_REG_CONTROL) &
372 MV64XXX_I2C_REG_CONTROL_IFLG) {
373 status = readl(drv_data->reg_base + MV64XXX_I2C_REG_STATUS);
374 mv64xxx_i2c_fsm(drv_data, status);
375 mv64xxx_i2c_do_action(drv_data);
376 rc = IRQ_HANDLED;
377 }
378 spin_unlock_irqrestore(&drv_data->lock, flags);
379
380 return rc;
381}
382
383/*
384 *****************************************************************************
385 *
386 * I2C Msg Execution Routines
387 *
388 *****************************************************************************
389 */
390static void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391mv64xxx_i2c_wait_for_completion(struct mv64xxx_i2c_data *drv_data)
392{
393 long time_left;
394 unsigned long flags;
395 char abort = 0;
396
Russell Kingd295a862013-05-16 10:30:59 +0000397 time_left = wait_event_timeout(drv_data->waitq,
Jean Delvare8a52c6b2009-03-28 21:34:43 +0100398 !drv_data->block, drv_data->adapter.timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399
400 spin_lock_irqsave(&drv_data->lock, flags);
401 if (!time_left) { /* Timed out */
402 drv_data->rc = -ETIMEDOUT;
403 abort = 1;
404 } else if (time_left < 0) { /* Interrupted/Error */
405 drv_data->rc = time_left; /* errno value */
406 abort = 1;
407 }
408
409 if (abort && drv_data->block) {
Mark A. Greere91c0212005-12-18 17:22:01 +0100410 drv_data->aborting = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 spin_unlock_irqrestore(&drv_data->lock, flags);
412
413 time_left = wait_event_timeout(drv_data->waitq,
Jean Delvare8a52c6b2009-03-28 21:34:43 +0100414 !drv_data->block, drv_data->adapter.timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
Mark A. Greere91c0212005-12-18 17:22:01 +0100416 if ((time_left <= 0) && drv_data->block) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 drv_data->state = MV64XXX_I2C_STATE_IDLE;
418 dev_err(&drv_data->adapter.dev,
Mark A. Greere91c0212005-12-18 17:22:01 +0100419 "mv64xxx: I2C bus locked, block: %d, "
420 "time_left: %d\n", drv_data->block,
421 (int)time_left);
Dale Farnswortha07ad1c2007-08-14 18:37:14 +0200422 mv64xxx_i2c_hw_init(drv_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 }
424 } else
425 spin_unlock_irqrestore(&drv_data->lock, flags);
426}
427
428static int
Rodolfo Giomettieda6bee2010-11-26 17:06:56 +0100429mv64xxx_i2c_execute_msg(struct mv64xxx_i2c_data *drv_data, struct i2c_msg *msg,
Russell King4243fa02013-05-16 21:39:12 +0100430 int is_last)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431{
432 unsigned long flags;
433
434 spin_lock_irqsave(&drv_data->lock, flags);
435 mv64xxx_i2c_prepare_for_io(drv_data, msg);
436
Russell King4243fa02013-05-16 21:39:12 +0100437 drv_data->action = MV64XXX_I2C_ACTION_SEND_START;
438 drv_data->state = MV64XXX_I2C_STATE_WAITING_FOR_START_COND;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439
Rodolfo Giomettieda6bee2010-11-26 17:06:56 +0100440 drv_data->send_stop = is_last;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 drv_data->block = 1;
442 mv64xxx_i2c_do_action(drv_data);
443 spin_unlock_irqrestore(&drv_data->lock, flags);
444
445 mv64xxx_i2c_wait_for_completion(drv_data);
446 return drv_data->rc;
447}
448
449/*
450 *****************************************************************************
451 *
452 * I2C Core Support Routines (Interface to higher level I2C code)
453 *
454 *****************************************************************************
455 */
456static u32
457mv64xxx_i2c_functionality(struct i2c_adapter *adap)
458{
459 return I2C_FUNC_I2C | I2C_FUNC_10BIT_ADDR | I2C_FUNC_SMBUS_EMUL;
460}
461
462static int
463mv64xxx_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
464{
465 struct mv64xxx_i2c_data *drv_data = i2c_get_adapdata(adap);
Russell King4243fa02013-05-16 21:39:12 +0100466 int rc, ret = num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
Russell King4243fa02013-05-16 21:39:12 +0100468 BUG_ON(drv_data->msgs != NULL);
469 drv_data->msgs = msgs;
470 drv_data->num_msgs = num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
Russell King4243fa02013-05-16 21:39:12 +0100472 rc = mv64xxx_i2c_execute_msg(drv_data, &msgs[0], num == 1);
473 if (rc < 0)
474 ret = rc;
475
476 drv_data->num_msgs = 0;
477 drv_data->msgs = NULL;
478
479 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480}
481
Jean Delvare8f9082c2006-09-03 22:39:46 +0200482static const struct i2c_algorithm mv64xxx_i2c_algo = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 .master_xfer = mv64xxx_i2c_xfer,
484 .functionality = mv64xxx_i2c_functionality,
485};
486
487/*
488 *****************************************************************************
489 *
490 * Driver Interface & Early Init Routines
491 *
492 *****************************************************************************
493 */
Andrew Lunnb61d1572012-07-22 12:51:35 +0200494#ifdef CONFIG_OF
Bill Pemberton0b255e92012-11-27 15:59:38 -0500495static int
Andrew Lunnb61d1572012-07-22 12:51:35 +0200496mv64xxx_calc_freq(const int tclk, const int n, const int m)
497{
498 return tclk / (10 * (m + 1) * (2 << n));
499}
500
Bill Pemberton0b255e92012-11-27 15:59:38 -0500501static bool
Andrew Lunnb61d1572012-07-22 12:51:35 +0200502mv64xxx_find_baud_factors(const u32 req_freq, const u32 tclk, u32 *best_n,
503 u32 *best_m)
504{
505 int freq, delta, best_delta = INT_MAX;
506 int m, n;
507
508 for (n = 0; n <= 7; n++)
509 for (m = 0; m <= 15; m++) {
510 freq = mv64xxx_calc_freq(tclk, n, m);
511 delta = req_freq - freq;
512 if (delta >= 0 && delta < best_delta) {
513 *best_m = m;
514 *best_n = n;
515 best_delta = delta;
516 }
517 if (best_delta == 0)
518 return true;
519 }
520 if (best_delta == INT_MAX)
521 return false;
522 return true;
523}
524
Bill Pemberton0b255e92012-11-27 15:59:38 -0500525static int
Andrew Lunnb61d1572012-07-22 12:51:35 +0200526mv64xxx_of_config(struct mv64xxx_i2c_data *drv_data,
527 struct device_node *np)
528{
529 u32 bus_freq, tclk;
530 int rc = 0;
531
532 /* CLK is mandatory when using DT to describe the i2c bus. We
533 * need to know tclk in order to calculate bus clock
534 * factors.
535 */
536#if !defined(CONFIG_HAVE_CLK)
537 /* Have OF but no CLK */
538 return -ENODEV;
539#else
540 if (IS_ERR(drv_data->clk)) {
541 rc = -ENODEV;
542 goto out;
543 }
544 tclk = clk_get_rate(drv_data->clk);
545 of_property_read_u32(np, "clock-frequency", &bus_freq);
546 if (!mv64xxx_find_baud_factors(bus_freq, tclk,
547 &drv_data->freq_n, &drv_data->freq_m)) {
548 rc = -EINVAL;
549 goto out;
550 }
551 drv_data->irq = irq_of_parse_and_map(np, 0);
552
553 /* Its not yet defined how timeouts will be specified in device tree.
554 * So hard code the value to 1 second.
555 */
556 drv_data->adapter.timeout = HZ;
557out:
558 return rc;
559#endif
560}
561#else /* CONFIG_OF */
Bill Pemberton0b255e92012-11-27 15:59:38 -0500562static int
Andrew Lunnb61d1572012-07-22 12:51:35 +0200563mv64xxx_of_config(struct mv64xxx_i2c_data *drv_data,
564 struct device_node *np)
565{
566 return -ENODEV;
567}
568#endif /* CONFIG_OF */
569
Bill Pemberton0b255e92012-11-27 15:59:38 -0500570static int
Russell King3ae5eae2005-11-09 22:32:44 +0000571mv64xxx_i2c_probe(struct platform_device *pd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 struct mv64xxx_i2c_data *drv_data;
Russell King3ae5eae2005-11-09 22:32:44 +0000574 struct mv64xxx_i2c_pdata *pdata = pd->dev.platform_data;
Russell King16874b02013-05-16 21:33:09 +0100575 struct resource *r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 int rc;
577
Andrew Lunnb61d1572012-07-22 12:51:35 +0200578 if ((!pdata && !pd->dev.of_node))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 return -ENODEV;
580
Russell King2c911102013-05-16 21:35:10 +0100581 drv_data = devm_kzalloc(&pd->dev, sizeof(struct mv64xxx_i2c_data),
582 GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 if (!drv_data)
584 return -ENOMEM;
585
Russell King16874b02013-05-16 21:33:09 +0100586 r = platform_get_resource(pd, IORESOURCE_MEM, 0);
587 drv_data->reg_base = devm_ioremap_resource(&pd->dev, r);
Russell King2c911102013-05-16 21:35:10 +0100588 if (IS_ERR(drv_data->reg_base))
589 return PTR_ERR(drv_data->reg_base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
Mark A. Greere91c0212005-12-18 17:22:01 +0100591 strlcpy(drv_data->adapter.name, MV64XXX_I2C_CTLR_NAME " adapter",
David Brownell2096b952007-05-01 23:26:28 +0200592 sizeof(drv_data->adapter.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593
594 init_waitqueue_head(&drv_data->waitq);
595 spin_lock_init(&drv_data->lock);
596
Andrew Lunnb61d1572012-07-22 12:51:35 +0200597#if defined(CONFIG_HAVE_CLK)
598 /* Not all platforms have a clk */
Russell King4c5c95f2013-05-16 21:34:10 +0100599 drv_data->clk = devm_clk_get(&pd->dev, NULL);
Andrew Lunnb61d1572012-07-22 12:51:35 +0200600 if (!IS_ERR(drv_data->clk)) {
601 clk_prepare(drv_data->clk);
602 clk_enable(drv_data->clk);
603 }
604#endif
605 if (pdata) {
606 drv_data->freq_m = pdata->freq_m;
607 drv_data->freq_n = pdata->freq_n;
608 drv_data->irq = platform_get_irq(pd, 0);
609 drv_data->adapter.timeout = msecs_to_jiffies(pdata->timeout);
610 } else if (pd->dev.of_node) {
611 rc = mv64xxx_of_config(drv_data, pd->dev.of_node);
612 if (rc)
Russell King2c911102013-05-16 21:35:10 +0100613 goto exit_clk;
Andrew Lunnb61d1572012-07-22 12:51:35 +0200614 }
David Vrabel48944732006-01-19 17:56:29 +0000615 if (drv_data->irq < 0) {
616 rc = -ENXIO;
Russell King2c911102013-05-16 21:35:10 +0100617 goto exit_clk;
David Vrabel48944732006-01-19 17:56:29 +0000618 }
Andrew Lunnb61d1572012-07-22 12:51:35 +0200619
Jean Delvare12a917f2007-02-13 22:09:03 +0100620 drv_data->adapter.dev.parent = &pd->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 drv_data->adapter.algo = &mv64xxx_i2c_algo;
622 drv_data->adapter.owner = THIS_MODULE;
Jean Delvare3401b2f2008-07-14 22:38:29 +0200623 drv_data->adapter.class = I2C_CLASS_HWMON | I2C_CLASS_SPD;
Dale Farnsworth65b22ad2007-07-12 14:12:29 +0200624 drv_data->adapter.nr = pd->id;
Andrew Lunnb61d1572012-07-22 12:51:35 +0200625 drv_data->adapter.dev.of_node = pd->dev.of_node;
Russell King3ae5eae2005-11-09 22:32:44 +0000626 platform_set_drvdata(pd, drv_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 i2c_set_adapdata(&drv_data->adapter, drv_data);
628
Maxime Bizon3269bb62007-01-05 17:54:05 +0100629 mv64xxx_i2c_hw_init(drv_data);
630
Russell King0c195af2013-05-16 21:36:11 +0100631 rc = request_irq(drv_data->irq, mv64xxx_i2c_intr, 0,
632 MV64XXX_I2C_CTLR_NAME, drv_data);
633 if (rc) {
Mark A. Greerdfded4a2005-12-16 11:08:43 -0800634 dev_err(&drv_data->adapter.dev,
Russell King0c195af2013-05-16 21:36:11 +0100635 "mv64xxx: Can't register intr handler irq%d: %d\n",
636 drv_data->irq, rc);
Russell King2c911102013-05-16 21:35:10 +0100637 goto exit_clk;
Dale Farnsworth65b22ad2007-07-12 14:12:29 +0200638 } else if ((rc = i2c_add_numbered_adapter(&drv_data->adapter)) != 0) {
Mark A. Greerdfded4a2005-12-16 11:08:43 -0800639 dev_err(&drv_data->adapter.dev,
640 "mv64xxx: Can't add i2c adapter, rc: %d\n", -rc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 goto exit_free_irq;
642 }
643
Andrew Lunnb61d1572012-07-22 12:51:35 +0200644 of_i2c_register_devices(&drv_data->adapter);
645
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 return 0;
647
Russell King2c911102013-05-16 21:35:10 +0100648exit_free_irq:
649 free_irq(drv_data->irq, drv_data);
650exit_clk:
Andrew Lunnb61d1572012-07-22 12:51:35 +0200651#if defined(CONFIG_HAVE_CLK)
652 /* Not all platforms have a clk */
653 if (!IS_ERR(drv_data->clk)) {
654 clk_disable(drv_data->clk);
655 clk_unprepare(drv_data->clk);
656 }
657#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 return rc;
659}
660
Bill Pemberton0b255e92012-11-27 15:59:38 -0500661static int
Russell King3ae5eae2005-11-09 22:32:44 +0000662mv64xxx_i2c_remove(struct platform_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663{
Russell King3ae5eae2005-11-09 22:32:44 +0000664 struct mv64xxx_i2c_data *drv_data = platform_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
Lars-Peter Clausenbf51a8c2013-03-09 08:16:46 +0000666 i2c_del_adapter(&drv_data->adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 free_irq(drv_data->irq, drv_data);
Andrew Lunnb61d1572012-07-22 12:51:35 +0200668#if defined(CONFIG_HAVE_CLK)
669 /* Not all platforms have a clk */
670 if (!IS_ERR(drv_data->clk)) {
671 clk_disable(drv_data->clk);
672 clk_unprepare(drv_data->clk);
673 }
674#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675
Lars-Peter Clausenbf51a8c2013-03-09 08:16:46 +0000676 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677}
678
Bill Pemberton0b255e92012-11-27 15:59:38 -0500679static const struct of_device_id mv64xxx_i2c_of_match_table[] = {
Andrew Lunnb61d1572012-07-22 12:51:35 +0200680 { .compatible = "marvell,mv64xxx-i2c", },
681 {}
682};
683MODULE_DEVICE_TABLE(of, mv64xxx_i2c_of_match_table);
684
Russell King3ae5eae2005-11-09 22:32:44 +0000685static struct platform_driver mv64xxx_i2c_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 .probe = mv64xxx_i2c_probe,
Bill Pemberton0b255e92012-11-27 15:59:38 -0500687 .remove = mv64xxx_i2c_remove,
Russell King3ae5eae2005-11-09 22:32:44 +0000688 .driver = {
689 .owner = THIS_MODULE,
690 .name = MV64XXX_I2C_CTLR_NAME,
Andrew Lunnb61d1572012-07-22 12:51:35 +0200691 .of_match_table = of_match_ptr(mv64xxx_i2c_of_match_table),
Russell King3ae5eae2005-11-09 22:32:44 +0000692 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693};
694
Axel Lina3664b52012-01-12 20:32:04 +0100695module_platform_driver(mv64xxx_i2c_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
697MODULE_AUTHOR("Mark A. Greer <mgreer@mvista.com>");
698MODULE_DESCRIPTION("Marvell mv64xxx host bridge i2c ctlr driver");
699MODULE_LICENSE("GPL");