2 * 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).
5 * Author: Mark A. Greer <mgreer@mvista.com>
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
12 #include <linux/kernel.h>
13 #include <linux/slab.h>
14 #include <linux/module.h>
15 #include <linux/spinlock.h>
16 #include <linux/i2c.h>
17 #include <linux/interrupt.h>
18 #include <linux/mv643xx_i2c.h>
19 #include <linux/platform_device.h>
22 #include <linux/of_device.h>
23 #include <linux/of_irq.h>
24 #include <linux/clk.h>
25 #include <linux/err.h>
26 #include <linux/delay.h>
28 #define MV64XXX_I2C_ADDR_ADDR(val) ((val & 0x7f) << 1)
29 #define MV64XXX_I2C_BAUD_DIV_N(val) (val & 0x7)
30 #define MV64XXX_I2C_BAUD_DIV_M(val) ((val & 0xf) << 3)
32 #define MV64XXX_I2C_REG_CONTROL_ACK 0x00000004
33 #define MV64XXX_I2C_REG_CONTROL_IFLG 0x00000008
34 #define MV64XXX_I2C_REG_CONTROL_STOP 0x00000010
35 #define MV64XXX_I2C_REG_CONTROL_START 0x00000020
36 #define MV64XXX_I2C_REG_CONTROL_TWSIEN 0x00000040
37 #define MV64XXX_I2C_REG_CONTROL_INTEN 0x00000080
39 /* Ctlr status values */
40 #define MV64XXX_I2C_STATUS_BUS_ERR 0x00
41 #define MV64XXX_I2C_STATUS_MAST_START 0x08
42 #define MV64XXX_I2C_STATUS_MAST_REPEAT_START 0x10
43 #define MV64XXX_I2C_STATUS_MAST_WR_ADDR_ACK 0x18
44 #define MV64XXX_I2C_STATUS_MAST_WR_ADDR_NO_ACK 0x20
45 #define MV64XXX_I2C_STATUS_MAST_WR_ACK 0x28
46 #define MV64XXX_I2C_STATUS_MAST_WR_NO_ACK 0x30
47 #define MV64XXX_I2C_STATUS_MAST_LOST_ARB 0x38
48 #define MV64XXX_I2C_STATUS_MAST_RD_ADDR_ACK 0x40
49 #define MV64XXX_I2C_STATUS_MAST_RD_ADDR_NO_ACK 0x48
50 #define MV64XXX_I2C_STATUS_MAST_RD_DATA_ACK 0x50
51 #define MV64XXX_I2C_STATUS_MAST_RD_DATA_NO_ACK 0x58
52 #define MV64XXX_I2C_STATUS_MAST_WR_ADDR_2_ACK 0xd0
53 #define MV64XXX_I2C_STATUS_MAST_WR_ADDR_2_NO_ACK 0xd8
54 #define MV64XXX_I2C_STATUS_MAST_RD_ADDR_2_ACK 0xe0
55 #define MV64XXX_I2C_STATUS_MAST_RD_ADDR_2_NO_ACK 0xe8
56 #define MV64XXX_I2C_STATUS_NO_STATUS 0xf8
58 /* Register defines (I2C bridge) */
59 #define MV64XXX_I2C_REG_TX_DATA_LO 0xc0
60 #define MV64XXX_I2C_REG_TX_DATA_HI 0xc4
61 #define MV64XXX_I2C_REG_RX_DATA_LO 0xc8
62 #define MV64XXX_I2C_REG_RX_DATA_HI 0xcc
63 #define MV64XXX_I2C_REG_BRIDGE_CONTROL 0xd0
64 #define MV64XXX_I2C_REG_BRIDGE_STATUS 0xd4
65 #define MV64XXX_I2C_REG_BRIDGE_INTR_CAUSE 0xd8
66 #define MV64XXX_I2C_REG_BRIDGE_INTR_MASK 0xdC
67 #define MV64XXX_I2C_REG_BRIDGE_TIMING 0xe0
69 /* Bridge Control values */
70 #define MV64XXX_I2C_BRIDGE_CONTROL_WR 0x00000001
71 #define MV64XXX_I2C_BRIDGE_CONTROL_RD 0x00000002
72 #define MV64XXX_I2C_BRIDGE_CONTROL_ADDR_SHIFT 2
73 #define MV64XXX_I2C_BRIDGE_CONTROL_ADDR_EXT 0x00001000
74 #define MV64XXX_I2C_BRIDGE_CONTROL_TX_SIZE_SHIFT 13
75 #define MV64XXX_I2C_BRIDGE_CONTROL_RX_SIZE_SHIFT 16
76 #define MV64XXX_I2C_BRIDGE_CONTROL_ENABLE 0x00080000
78 /* Bridge Status values */
79 #define MV64XXX_I2C_BRIDGE_STATUS_ERROR 0x00000001
80 #define MV64XXX_I2C_STATUS_OFFLOAD_ERROR 0xf0000001
81 #define MV64XXX_I2C_STATUS_OFFLOAD_OK 0xf0000000
86 MV64XXX_I2C_STATE_INVALID,
87 MV64XXX_I2C_STATE_IDLE,
88 MV64XXX_I2C_STATE_WAITING_FOR_START_COND,
89 MV64XXX_I2C_STATE_WAITING_FOR_RESTART,
90 MV64XXX_I2C_STATE_WAITING_FOR_ADDR_1_ACK,
91 MV64XXX_I2C_STATE_WAITING_FOR_ADDR_2_ACK,
92 MV64XXX_I2C_STATE_WAITING_FOR_SLAVE_ACK,
93 MV64XXX_I2C_STATE_WAITING_FOR_SLAVE_DATA,
98 MV64XXX_I2C_ACTION_INVALID,
99 MV64XXX_I2C_ACTION_CONTINUE,
100 MV64XXX_I2C_ACTION_OFFLOAD_SEND_START,
101 MV64XXX_I2C_ACTION_SEND_START,
102 MV64XXX_I2C_ACTION_SEND_RESTART,
103 MV64XXX_I2C_ACTION_OFFLOAD_RESTART,
104 MV64XXX_I2C_ACTION_SEND_ADDR_1,
105 MV64XXX_I2C_ACTION_SEND_ADDR_2,
106 MV64XXX_I2C_ACTION_SEND_DATA,
107 MV64XXX_I2C_ACTION_RCV_DATA,
108 MV64XXX_I2C_ACTION_RCV_DATA_STOP,
109 MV64XXX_I2C_ACTION_SEND_STOP,
110 MV64XXX_I2C_ACTION_OFFLOAD_SEND_STOP,
113 struct mv64xxx_i2c_regs {
123 struct mv64xxx_i2c_data {
124 struct i2c_msg *msgs;
131 void __iomem *reg_base;
132 struct mv64xxx_i2c_regs reg_offsets;
142 #if defined(CONFIG_HAVE_CLK)
145 wait_queue_head_t waitq;
148 struct i2c_adapter adapter;
149 bool offload_enabled;
150 /* 5us delay in order to avoid repeated start timing violation */
154 static struct mv64xxx_i2c_regs mv64xxx_i2c_regs_mv64xxx = {
164 static struct mv64xxx_i2c_regs mv64xxx_i2c_regs_sun4i = {
175 mv64xxx_i2c_prepare_for_io(struct mv64xxx_i2c_data *drv_data,
181 drv_data->byte_posn = 0;
182 drv_data->bytes_left = msg->len;
183 drv_data->aborting = 0;
185 drv_data->cntl_bits = MV64XXX_I2C_REG_CONTROL_ACK |
186 MV64XXX_I2C_REG_CONTROL_INTEN | MV64XXX_I2C_REG_CONTROL_TWSIEN;
188 if (msg->flags & I2C_M_RD)
191 if (msg->flags & I2C_M_TEN) {
192 drv_data->addr1 = 0xf0 | (((u32)msg->addr & 0x300) >> 7) | dir;
193 drv_data->addr2 = (u32)msg->addr & 0xff;
195 drv_data->addr1 = MV64XXX_I2C_ADDR_ADDR((u32)msg->addr) | dir;
200 static int mv64xxx_i2c_offload_msg(struct mv64xxx_i2c_data *drv_data)
202 unsigned long data_reg_hi = 0;
203 unsigned long data_reg_lo = 0;
204 unsigned long ctrl_reg;
205 struct i2c_msg *msg = drv_data->msgs;
208 drv_data->byte_posn = 0;
209 drv_data->bytes_left = msg->len;
210 drv_data->aborting = 0;
212 /* Only regular transactions can be offloaded */
213 if ((msg->flags & ~(I2C_M_TEN | I2C_M_RD)) != 0)
216 /* Only 1-8 byte transfers can be offloaded */
217 if (msg->len < 1 || msg->len > 8)
220 /* Build transaction */
221 ctrl_reg = MV64XXX_I2C_BRIDGE_CONTROL_ENABLE |
222 (msg->addr << MV64XXX_I2C_BRIDGE_CONTROL_ADDR_SHIFT);
224 if ((msg->flags & I2C_M_TEN) != 0)
225 ctrl_reg |= MV64XXX_I2C_BRIDGE_CONTROL_ADDR_EXT;
227 if ((msg->flags & I2C_M_RD) == 0) {
228 u8 local_buf[8] = { 0 };
230 memcpy(local_buf, msg->buf, msg->len);
231 data_reg_lo = cpu_to_le32(*((u32 *)local_buf));
232 data_reg_hi = cpu_to_le32(*((u32 *)(local_buf+4)));
234 ctrl_reg |= MV64XXX_I2C_BRIDGE_CONTROL_WR |
235 (msg->len - 1) << MV64XXX_I2C_BRIDGE_CONTROL_TX_SIZE_SHIFT;
238 drv_data->reg_base + MV64XXX_I2C_REG_TX_DATA_LO);
240 drv_data->reg_base + MV64XXX_I2C_REG_TX_DATA_HI);
243 ctrl_reg |= MV64XXX_I2C_BRIDGE_CONTROL_RD |
244 (msg->len - 1) << MV64XXX_I2C_BRIDGE_CONTROL_RX_SIZE_SHIFT;
247 /* Execute transaction */
248 writel(ctrl_reg, drv_data->reg_base + MV64XXX_I2C_REG_BRIDGE_CONTROL);
254 mv64xxx_i2c_update_offload_data(struct mv64xxx_i2c_data *drv_data)
256 struct i2c_msg *msg = drv_data->msg;
258 if (msg->flags & I2C_M_RD) {
259 u32 data_reg_lo = readl(drv_data->reg_base +
260 MV64XXX_I2C_REG_RX_DATA_LO);
261 u32 data_reg_hi = readl(drv_data->reg_base +
262 MV64XXX_I2C_REG_RX_DATA_HI);
263 u8 local_buf[8] = { 0 };
265 *((u32 *)local_buf) = le32_to_cpu(data_reg_lo);
266 *((u32 *)(local_buf+4)) = le32_to_cpu(data_reg_hi);
267 memcpy(msg->buf, local_buf, msg->len);
272 *****************************************************************************
274 * Finite State Machine & Interrupt Routines
276 *****************************************************************************
279 /* Reset hardware and initialize FSM */
281 mv64xxx_i2c_hw_init(struct mv64xxx_i2c_data *drv_data)
283 if (drv_data->offload_enabled) {
284 writel(0, drv_data->reg_base + MV64XXX_I2C_REG_BRIDGE_CONTROL);
285 writel(0, drv_data->reg_base + MV64XXX_I2C_REG_BRIDGE_TIMING);
286 writel(0, drv_data->reg_base +
287 MV64XXX_I2C_REG_BRIDGE_INTR_CAUSE);
288 writel(0, drv_data->reg_base +
289 MV64XXX_I2C_REG_BRIDGE_INTR_MASK);
292 writel(0, drv_data->reg_base + drv_data->reg_offsets.soft_reset);
293 writel(MV64XXX_I2C_BAUD_DIV_M(drv_data->freq_m) | MV64XXX_I2C_BAUD_DIV_N(drv_data->freq_n),
294 drv_data->reg_base + drv_data->reg_offsets.clock);
295 writel(0, drv_data->reg_base + drv_data->reg_offsets.addr);
296 writel(0, drv_data->reg_base + drv_data->reg_offsets.ext_addr);
297 writel(MV64XXX_I2C_REG_CONTROL_TWSIEN | MV64XXX_I2C_REG_CONTROL_STOP,
298 drv_data->reg_base + drv_data->reg_offsets.control);
299 drv_data->state = MV64XXX_I2C_STATE_IDLE;
303 mv64xxx_i2c_fsm(struct mv64xxx_i2c_data *drv_data, u32 status)
306 * If state is idle, then this is likely the remnants of an old
307 * operation that driver has given up on or the user has killed.
308 * If so, issue the stop condition and go to idle.
310 if (drv_data->state == MV64XXX_I2C_STATE_IDLE) {
311 drv_data->action = MV64XXX_I2C_ACTION_SEND_STOP;
315 /* The status from the ctlr [mostly] tells us what to do next */
317 /* Start condition interrupt */
318 case MV64XXX_I2C_STATUS_MAST_START: /* 0x08 */
319 case MV64XXX_I2C_STATUS_MAST_REPEAT_START: /* 0x10 */
320 drv_data->action = MV64XXX_I2C_ACTION_SEND_ADDR_1;
321 drv_data->state = MV64XXX_I2C_STATE_WAITING_FOR_ADDR_1_ACK;
324 /* Performing a write */
325 case MV64XXX_I2C_STATUS_MAST_WR_ADDR_ACK: /* 0x18 */
326 if (drv_data->msg->flags & I2C_M_TEN) {
327 drv_data->action = MV64XXX_I2C_ACTION_SEND_ADDR_2;
329 MV64XXX_I2C_STATE_WAITING_FOR_ADDR_2_ACK;
333 case MV64XXX_I2C_STATUS_MAST_WR_ADDR_2_ACK: /* 0xd0 */
334 case MV64XXX_I2C_STATUS_MAST_WR_ACK: /* 0x28 */
335 if ((drv_data->bytes_left == 0)
336 || (drv_data->aborting
337 && (drv_data->byte_posn != 0))) {
338 if (drv_data->send_stop || drv_data->aborting) {
339 drv_data->action = MV64XXX_I2C_ACTION_SEND_STOP;
340 drv_data->state = MV64XXX_I2C_STATE_IDLE;
343 MV64XXX_I2C_ACTION_SEND_RESTART;
345 MV64XXX_I2C_STATE_WAITING_FOR_RESTART;
348 drv_data->action = MV64XXX_I2C_ACTION_SEND_DATA;
350 MV64XXX_I2C_STATE_WAITING_FOR_SLAVE_ACK;
351 drv_data->bytes_left--;
355 /* Performing a read */
356 case MV64XXX_I2C_STATUS_MAST_RD_ADDR_ACK: /* 40 */
357 if (drv_data->msg->flags & I2C_M_TEN) {
358 drv_data->action = MV64XXX_I2C_ACTION_SEND_ADDR_2;
360 MV64XXX_I2C_STATE_WAITING_FOR_ADDR_2_ACK;
364 case MV64XXX_I2C_STATUS_MAST_RD_ADDR_2_ACK: /* 0xe0 */
365 if (drv_data->bytes_left == 0) {
366 drv_data->action = MV64XXX_I2C_ACTION_SEND_STOP;
367 drv_data->state = MV64XXX_I2C_STATE_IDLE;
371 case MV64XXX_I2C_STATUS_MAST_RD_DATA_ACK: /* 0x50 */
372 if (status != MV64XXX_I2C_STATUS_MAST_RD_DATA_ACK)
373 drv_data->action = MV64XXX_I2C_ACTION_CONTINUE;
375 drv_data->action = MV64XXX_I2C_ACTION_RCV_DATA;
376 drv_data->bytes_left--;
378 drv_data->state = MV64XXX_I2C_STATE_WAITING_FOR_SLAVE_DATA;
380 if ((drv_data->bytes_left == 1) || drv_data->aborting)
381 drv_data->cntl_bits &= ~MV64XXX_I2C_REG_CONTROL_ACK;
384 case MV64XXX_I2C_STATUS_MAST_RD_DATA_NO_ACK: /* 0x58 */
385 drv_data->action = MV64XXX_I2C_ACTION_RCV_DATA_STOP;
386 drv_data->state = MV64XXX_I2C_STATE_IDLE;
389 case MV64XXX_I2C_STATUS_MAST_WR_ADDR_NO_ACK: /* 0x20 */
390 case MV64XXX_I2C_STATUS_MAST_WR_NO_ACK: /* 30 */
391 case MV64XXX_I2C_STATUS_MAST_RD_ADDR_NO_ACK: /* 48 */
392 /* Doesn't seem to be a device at other end */
393 drv_data->action = MV64XXX_I2C_ACTION_SEND_STOP;
394 drv_data->state = MV64XXX_I2C_STATE_IDLE;
395 drv_data->rc = -ENXIO;
398 case MV64XXX_I2C_STATUS_OFFLOAD_OK:
399 if (drv_data->send_stop || drv_data->aborting) {
400 drv_data->action = MV64XXX_I2C_ACTION_OFFLOAD_SEND_STOP;
401 drv_data->state = MV64XXX_I2C_STATE_IDLE;
403 drv_data->action = MV64XXX_I2C_ACTION_OFFLOAD_RESTART;
404 drv_data->state = MV64XXX_I2C_STATE_WAITING_FOR_RESTART;
409 dev_err(&drv_data->adapter.dev,
410 "mv64xxx_i2c_fsm: Ctlr Error -- state: 0x%x, "
411 "status: 0x%x, addr: 0x%x, flags: 0x%x\n",
412 drv_data->state, status, drv_data->msg->addr,
413 drv_data->msg->flags);
414 drv_data->action = MV64XXX_I2C_ACTION_SEND_STOP;
415 mv64xxx_i2c_hw_init(drv_data);
421 mv64xxx_i2c_do_action(struct mv64xxx_i2c_data *drv_data)
423 switch(drv_data->action) {
424 case MV64XXX_I2C_ACTION_OFFLOAD_RESTART:
425 mv64xxx_i2c_update_offload_data(drv_data);
426 writel(0, drv_data->reg_base + MV64XXX_I2C_REG_BRIDGE_CONTROL);
427 writel(0, drv_data->reg_base +
428 MV64XXX_I2C_REG_BRIDGE_INTR_CAUSE);
430 case MV64XXX_I2C_ACTION_SEND_RESTART:
431 /* We should only get here if we have further messages */
432 BUG_ON(drv_data->num_msgs == 0);
435 drv_data->num_msgs--;
436 if (!(drv_data->offload_enabled &&
437 mv64xxx_i2c_offload_msg(drv_data))) {
438 drv_data->cntl_bits |= MV64XXX_I2C_REG_CONTROL_START;
439 writel(drv_data->cntl_bits,
440 drv_data->reg_base + drv_data->reg_offsets.control);
442 /* Setup for the next message */
443 mv64xxx_i2c_prepare_for_io(drv_data, drv_data->msgs);
445 if (drv_data->errata_delay)
449 * We're never at the start of the message here, and by this
450 * time it's already too late to do any protocol mangling.
451 * Thankfully, do not advertise support for that feature.
453 drv_data->send_stop = drv_data->num_msgs == 1;
456 case MV64XXX_I2C_ACTION_CONTINUE:
457 writel(drv_data->cntl_bits,
458 drv_data->reg_base + drv_data->reg_offsets.control);
461 case MV64XXX_I2C_ACTION_OFFLOAD_SEND_START:
462 if (!mv64xxx_i2c_offload_msg(drv_data))
465 drv_data->action = MV64XXX_I2C_ACTION_SEND_START;
467 case MV64XXX_I2C_ACTION_SEND_START:
468 writel(drv_data->cntl_bits | MV64XXX_I2C_REG_CONTROL_START,
469 drv_data->reg_base + drv_data->reg_offsets.control);
472 case MV64XXX_I2C_ACTION_SEND_ADDR_1:
473 writel(drv_data->addr1,
474 drv_data->reg_base + drv_data->reg_offsets.data);
475 writel(drv_data->cntl_bits,
476 drv_data->reg_base + drv_data->reg_offsets.control);
479 case MV64XXX_I2C_ACTION_SEND_ADDR_2:
480 writel(drv_data->addr2,
481 drv_data->reg_base + drv_data->reg_offsets.data);
482 writel(drv_data->cntl_bits,
483 drv_data->reg_base + drv_data->reg_offsets.control);
486 case MV64XXX_I2C_ACTION_SEND_DATA:
487 writel(drv_data->msg->buf[drv_data->byte_posn++],
488 drv_data->reg_base + drv_data->reg_offsets.data);
489 writel(drv_data->cntl_bits,
490 drv_data->reg_base + drv_data->reg_offsets.control);
493 case MV64XXX_I2C_ACTION_RCV_DATA:
494 drv_data->msg->buf[drv_data->byte_posn++] =
495 readl(drv_data->reg_base + drv_data->reg_offsets.data);
496 writel(drv_data->cntl_bits,
497 drv_data->reg_base + drv_data->reg_offsets.control);
500 case MV64XXX_I2C_ACTION_RCV_DATA_STOP:
501 drv_data->msg->buf[drv_data->byte_posn++] =
502 readl(drv_data->reg_base + drv_data->reg_offsets.data);
503 drv_data->cntl_bits &= ~MV64XXX_I2C_REG_CONTROL_INTEN;
504 writel(drv_data->cntl_bits | MV64XXX_I2C_REG_CONTROL_STOP,
505 drv_data->reg_base + drv_data->reg_offsets.control);
507 if (drv_data->errata_delay)
510 wake_up(&drv_data->waitq);
513 case MV64XXX_I2C_ACTION_INVALID:
515 dev_err(&drv_data->adapter.dev,
516 "mv64xxx_i2c_do_action: Invalid action: %d\n",
521 case MV64XXX_I2C_ACTION_SEND_STOP:
522 drv_data->cntl_bits &= ~MV64XXX_I2C_REG_CONTROL_INTEN;
523 writel(drv_data->cntl_bits | MV64XXX_I2C_REG_CONTROL_STOP,
524 drv_data->reg_base + drv_data->reg_offsets.control);
526 wake_up(&drv_data->waitq);
529 case MV64XXX_I2C_ACTION_OFFLOAD_SEND_STOP:
530 mv64xxx_i2c_update_offload_data(drv_data);
531 writel(0, drv_data->reg_base + MV64XXX_I2C_REG_BRIDGE_CONTROL);
532 writel(0, drv_data->reg_base +
533 MV64XXX_I2C_REG_BRIDGE_INTR_CAUSE);
535 wake_up(&drv_data->waitq);
541 mv64xxx_i2c_intr(int irq, void *dev_id)
543 struct mv64xxx_i2c_data *drv_data = dev_id;
546 irqreturn_t rc = IRQ_NONE;
548 spin_lock_irqsave(&drv_data->lock, flags);
550 if (drv_data->offload_enabled) {
551 while (readl(drv_data->reg_base +
552 MV64XXX_I2C_REG_BRIDGE_INTR_CAUSE)) {
553 int reg_status = readl(drv_data->reg_base +
554 MV64XXX_I2C_REG_BRIDGE_STATUS);
555 if (reg_status & MV64XXX_I2C_BRIDGE_STATUS_ERROR)
556 status = MV64XXX_I2C_STATUS_OFFLOAD_ERROR;
558 status = MV64XXX_I2C_STATUS_OFFLOAD_OK;
559 mv64xxx_i2c_fsm(drv_data, status);
560 mv64xxx_i2c_do_action(drv_data);
564 while (readl(drv_data->reg_base + drv_data->reg_offsets.control) &
565 MV64XXX_I2C_REG_CONTROL_IFLG) {
566 status = readl(drv_data->reg_base + drv_data->reg_offsets.status);
567 mv64xxx_i2c_fsm(drv_data, status);
568 mv64xxx_i2c_do_action(drv_data);
571 spin_unlock_irqrestore(&drv_data->lock, flags);
577 *****************************************************************************
579 * I2C Msg Execution Routines
581 *****************************************************************************
584 mv64xxx_i2c_wait_for_completion(struct mv64xxx_i2c_data *drv_data)
590 time_left = wait_event_timeout(drv_data->waitq,
591 !drv_data->block, drv_data->adapter.timeout);
593 spin_lock_irqsave(&drv_data->lock, flags);
594 if (!time_left) { /* Timed out */
595 drv_data->rc = -ETIMEDOUT;
597 } else if (time_left < 0) { /* Interrupted/Error */
598 drv_data->rc = time_left; /* errno value */
602 if (abort && drv_data->block) {
603 drv_data->aborting = 1;
604 spin_unlock_irqrestore(&drv_data->lock, flags);
606 time_left = wait_event_timeout(drv_data->waitq,
607 !drv_data->block, drv_data->adapter.timeout);
609 if ((time_left <= 0) && drv_data->block) {
610 drv_data->state = MV64XXX_I2C_STATE_IDLE;
611 dev_err(&drv_data->adapter.dev,
612 "mv64xxx: I2C bus locked, block: %d, "
613 "time_left: %d\n", drv_data->block,
615 mv64xxx_i2c_hw_init(drv_data);
618 spin_unlock_irqrestore(&drv_data->lock, flags);
622 mv64xxx_i2c_execute_msg(struct mv64xxx_i2c_data *drv_data, struct i2c_msg *msg,
627 spin_lock_irqsave(&drv_data->lock, flags);
628 if (drv_data->offload_enabled) {
629 drv_data->action = MV64XXX_I2C_ACTION_OFFLOAD_SEND_START;
630 drv_data->state = MV64XXX_I2C_STATE_WAITING_FOR_START_COND;
632 mv64xxx_i2c_prepare_for_io(drv_data, msg);
634 drv_data->action = MV64XXX_I2C_ACTION_SEND_START;
635 drv_data->state = MV64XXX_I2C_STATE_WAITING_FOR_START_COND;
637 drv_data->send_stop = is_last;
639 mv64xxx_i2c_do_action(drv_data);
640 spin_unlock_irqrestore(&drv_data->lock, flags);
642 mv64xxx_i2c_wait_for_completion(drv_data);
647 *****************************************************************************
649 * I2C Core Support Routines (Interface to higher level I2C code)
651 *****************************************************************************
654 mv64xxx_i2c_functionality(struct i2c_adapter *adap)
656 return I2C_FUNC_I2C | I2C_FUNC_10BIT_ADDR | I2C_FUNC_SMBUS_EMUL;
660 mv64xxx_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
662 struct mv64xxx_i2c_data *drv_data = i2c_get_adapdata(adap);
665 BUG_ON(drv_data->msgs != NULL);
666 drv_data->msgs = msgs;
667 drv_data->num_msgs = num;
669 rc = mv64xxx_i2c_execute_msg(drv_data, &msgs[0], num == 1);
673 drv_data->num_msgs = 0;
674 drv_data->msgs = NULL;
679 static const struct i2c_algorithm mv64xxx_i2c_algo = {
680 .master_xfer = mv64xxx_i2c_xfer,
681 .functionality = mv64xxx_i2c_functionality,
685 *****************************************************************************
687 * Driver Interface & Early Init Routines
689 *****************************************************************************
691 static const struct of_device_id mv64xxx_i2c_of_match_table[] = {
692 { .compatible = "allwinner,sun4i-i2c", .data = &mv64xxx_i2c_regs_sun4i},
693 { .compatible = "marvell,mv64xxx-i2c", .data = &mv64xxx_i2c_regs_mv64xxx},
694 { .compatible = "marvell,mv78230-i2c", .data = &mv64xxx_i2c_regs_mv64xxx},
695 { .compatible = "marvell,mv78230-a0-i2c", .data = &mv64xxx_i2c_regs_mv64xxx},
698 MODULE_DEVICE_TABLE(of, mv64xxx_i2c_of_match_table);
701 #ifdef CONFIG_HAVE_CLK
703 mv64xxx_calc_freq(const int tclk, const int n, const int m)
705 return tclk / (10 * (m + 1) * (2 << n));
709 mv64xxx_find_baud_factors(const u32 req_freq, const u32 tclk, u32 *best_n,
712 int freq, delta, best_delta = INT_MAX;
715 for (n = 0; n <= 7; n++)
716 for (m = 0; m <= 15; m++) {
717 freq = mv64xxx_calc_freq(tclk, n, m);
718 delta = req_freq - freq;
719 if (delta >= 0 && delta < best_delta) {
727 if (best_delta == INT_MAX)
731 #endif /* CONFIG_HAVE_CLK */
734 mv64xxx_of_config(struct mv64xxx_i2c_data *drv_data,
737 /* CLK is mandatory when using DT to describe the i2c bus. We
738 * need to know tclk in order to calculate bus clock
741 #if !defined(CONFIG_HAVE_CLK)
742 /* Have OF but no CLK */
745 const struct of_device_id *device;
746 struct device_node *np = dev->of_node;
750 if (IS_ERR(drv_data->clk)) {
754 tclk = clk_get_rate(drv_data->clk);
756 rc = of_property_read_u32(np, "clock-frequency", &bus_freq);
758 bus_freq = 100000; /* 100kHz by default */
760 if (!mv64xxx_find_baud_factors(bus_freq, tclk,
761 &drv_data->freq_n, &drv_data->freq_m)) {
765 drv_data->irq = irq_of_parse_and_map(np, 0);
767 /* Its not yet defined how timeouts will be specified in device tree.
768 * So hard code the value to 1 second.
770 drv_data->adapter.timeout = HZ;
772 device = of_match_device(mv64xxx_i2c_of_match_table, dev);
776 memcpy(&drv_data->reg_offsets, device->data, sizeof(drv_data->reg_offsets));
779 * For controllers embedded in new SoCs activate the
780 * Transaction Generator support and the errata fix.
782 if (of_device_is_compatible(np, "marvell,mv78230-i2c")) {
783 drv_data->offload_enabled = true;
784 drv_data->errata_delay = true;
787 if (of_device_is_compatible(np, "marvell,mv78230-a0-i2c")) {
788 drv_data->offload_enabled = false;
789 drv_data->errata_delay = true;
795 #else /* CONFIG_OF */
797 mv64xxx_of_config(struct mv64xxx_i2c_data *drv_data,
802 #endif /* CONFIG_OF */
805 mv64xxx_i2c_probe(struct platform_device *pd)
807 struct mv64xxx_i2c_data *drv_data;
808 struct mv64xxx_i2c_pdata *pdata = dev_get_platdata(&pd->dev);
812 if ((!pdata && !pd->dev.of_node))
815 drv_data = devm_kzalloc(&pd->dev, sizeof(struct mv64xxx_i2c_data),
820 r = platform_get_resource(pd, IORESOURCE_MEM, 0);
821 drv_data->reg_base = devm_ioremap_resource(&pd->dev, r);
822 if (IS_ERR(drv_data->reg_base))
823 return PTR_ERR(drv_data->reg_base);
825 strlcpy(drv_data->adapter.name, MV64XXX_I2C_CTLR_NAME " adapter",
826 sizeof(drv_data->adapter.name));
828 init_waitqueue_head(&drv_data->waitq);
829 spin_lock_init(&drv_data->lock);
831 #if defined(CONFIG_HAVE_CLK)
832 /* Not all platforms have a clk */
833 drv_data->clk = devm_clk_get(&pd->dev, NULL);
834 if (!IS_ERR(drv_data->clk)) {
835 clk_prepare(drv_data->clk);
836 clk_enable(drv_data->clk);
840 drv_data->freq_m = pdata->freq_m;
841 drv_data->freq_n = pdata->freq_n;
842 drv_data->irq = platform_get_irq(pd, 0);
843 drv_data->adapter.timeout = msecs_to_jiffies(pdata->timeout);
844 drv_data->offload_enabled = false;
845 memcpy(&drv_data->reg_offsets, &mv64xxx_i2c_regs_mv64xxx, sizeof(drv_data->reg_offsets));
846 } else if (pd->dev.of_node) {
847 rc = mv64xxx_of_config(drv_data, &pd->dev);
851 if (drv_data->irq < 0) {
856 drv_data->adapter.dev.parent = &pd->dev;
857 drv_data->adapter.algo = &mv64xxx_i2c_algo;
858 drv_data->adapter.owner = THIS_MODULE;
859 drv_data->adapter.class = I2C_CLASS_HWMON | I2C_CLASS_SPD;
860 drv_data->adapter.nr = pd->id;
861 drv_data->adapter.dev.of_node = pd->dev.of_node;
862 platform_set_drvdata(pd, drv_data);
863 i2c_set_adapdata(&drv_data->adapter, drv_data);
865 mv64xxx_i2c_hw_init(drv_data);
867 rc = request_irq(drv_data->irq, mv64xxx_i2c_intr, 0,
868 MV64XXX_I2C_CTLR_NAME, drv_data);
870 dev_err(&drv_data->adapter.dev,
871 "mv64xxx: Can't register intr handler irq%d: %d\n",
874 } else if ((rc = i2c_add_numbered_adapter(&drv_data->adapter)) != 0) {
875 dev_err(&drv_data->adapter.dev,
876 "mv64xxx: Can't add i2c adapter, rc: %d\n", -rc);
883 free_irq(drv_data->irq, drv_data);
885 #if defined(CONFIG_HAVE_CLK)
886 /* Not all platforms have a clk */
887 if (!IS_ERR(drv_data->clk)) {
888 clk_disable(drv_data->clk);
889 clk_unprepare(drv_data->clk);
896 mv64xxx_i2c_remove(struct platform_device *dev)
898 struct mv64xxx_i2c_data *drv_data = platform_get_drvdata(dev);
900 i2c_del_adapter(&drv_data->adapter);
901 free_irq(drv_data->irq, drv_data);
902 #if defined(CONFIG_HAVE_CLK)
903 /* Not all platforms have a clk */
904 if (!IS_ERR(drv_data->clk)) {
905 clk_disable(drv_data->clk);
906 clk_unprepare(drv_data->clk);
913 static struct platform_driver mv64xxx_i2c_driver = {
914 .probe = mv64xxx_i2c_probe,
915 .remove = mv64xxx_i2c_remove,
917 .owner = THIS_MODULE,
918 .name = MV64XXX_I2C_CTLR_NAME,
919 .of_match_table = mv64xxx_i2c_of_match_table,
923 module_platform_driver(mv64xxx_i2c_driver);
925 MODULE_AUTHOR("Mark A. Greer <mgreer@mvista.com>");
926 MODULE_DESCRIPTION("Marvell mv64xxx host bridge i2c ctlr driver");
927 MODULE_LICENSE("GPL");