1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * TI OMAP I2C master mode driver
5 * Copyright (C) 2003 MontaVista Software, Inc.
6 * Copyright (C) 2005 Nokia Corporation
7 * Copyright (C) 2004 - 2007 Texas Instruments.
9 * Originally written by MontaVista Software, Inc.
10 * Additional contributions by:
11 * Tony Lindgren <tony@atomide.com>
12 * Imre Deak <imre.deak@nokia.com>
13 * Juha Yrjölä <juha.yrjola@solidboot.com>
14 * Syed Khasim <x0khasim@ti.com>
15 * Nishant Menon <nm@ti.com>
18 #include <linux/module.h>
19 #include <linux/delay.h>
20 #include <linux/i2c.h>
21 #include <linux/err.h>
22 #include <linux/interrupt.h>
23 #include <linux/completion.h>
24 #include <linux/platform_device.h>
25 #include <linux/clk.h>
28 #include <linux/slab.h>
29 #include <linux/platform_data/i2c-omap.h>
30 #include <linux/pm_runtime.h>
31 #include <linux/pinctrl/consumer.h>
32 #include <linux/property.h>
34 /* I2C controller revisions */
35 #define OMAP_I2C_OMAP1_REV_2 0x20
37 /* I2C controller revisions present on specific hardware */
38 #define OMAP_I2C_REV_ON_2430 0x00000036
39 #define OMAP_I2C_REV_ON_3430_3530 0x0000003C
40 #define OMAP_I2C_REV_ON_3630 0x00000040
41 #define OMAP_I2C_REV_ON_4430_PLUS 0x50400002
43 /* timeout waiting for the controller to respond */
44 #define OMAP_I2C_TIMEOUT (msecs_to_jiffies(1000))
46 /* timeout for pm runtime autosuspend */
47 #define OMAP_I2C_PM_TIMEOUT 1000 /* ms */
49 /* timeout for making decision on bus free status */
50 #define OMAP_I2C_BUS_FREE_TIMEOUT (msecs_to_jiffies(10))
52 /* For OMAP3 I2C_IV has changed to I2C_WE (wakeup enable) */
72 /* only on OMAP4430 */
73 OMAP_I2C_IP_V2_REVNB_LO
,
74 OMAP_I2C_IP_V2_REVNB_HI
,
75 OMAP_I2C_IP_V2_IRQSTATUS_RAW
,
76 OMAP_I2C_IP_V2_IRQENABLE_SET
,
77 OMAP_I2C_IP_V2_IRQENABLE_CLR
,
80 /* I2C Interrupt Enable Register (OMAP_I2C_IE): */
81 #define OMAP_I2C_IE_XDR (1 << 14) /* TX Buffer drain int enable */
82 #define OMAP_I2C_IE_RDR (1 << 13) /* RX Buffer drain int enable */
83 #define OMAP_I2C_IE_XRDY (1 << 4) /* TX data ready int enable */
84 #define OMAP_I2C_IE_RRDY (1 << 3) /* RX data ready int enable */
85 #define OMAP_I2C_IE_ARDY (1 << 2) /* Access ready int enable */
86 #define OMAP_I2C_IE_NACK (1 << 1) /* No ack interrupt enable */
87 #define OMAP_I2C_IE_AL (1 << 0) /* Arbitration lost int ena */
89 /* I2C Status Register (OMAP_I2C_STAT): */
90 #define OMAP_I2C_STAT_XDR (1 << 14) /* TX Buffer draining */
91 #define OMAP_I2C_STAT_RDR (1 << 13) /* RX Buffer draining */
92 #define OMAP_I2C_STAT_BB (1 << 12) /* Bus busy */
93 #define OMAP_I2C_STAT_ROVR (1 << 11) /* Receive overrun */
94 #define OMAP_I2C_STAT_XUDF (1 << 10) /* Transmit underflow */
95 #define OMAP_I2C_STAT_AAS (1 << 9) /* Address as slave */
96 #define OMAP_I2C_STAT_BF (1 << 8) /* Bus Free */
97 #define OMAP_I2C_STAT_XRDY (1 << 4) /* Transmit data ready */
98 #define OMAP_I2C_STAT_RRDY (1 << 3) /* Receive data ready */
99 #define OMAP_I2C_STAT_ARDY (1 << 2) /* Register access ready */
100 #define OMAP_I2C_STAT_NACK (1 << 1) /* No ack interrupt enable */
101 #define OMAP_I2C_STAT_AL (1 << 0) /* Arbitration lost int ena */
103 /* I2C WE wakeup enable register */
104 #define OMAP_I2C_WE_XDR_WE (1 << 14) /* TX drain wakup */
105 #define OMAP_I2C_WE_RDR_WE (1 << 13) /* RX drain wakeup */
106 #define OMAP_I2C_WE_AAS_WE (1 << 9) /* Address as slave wakeup*/
107 #define OMAP_I2C_WE_BF_WE (1 << 8) /* Bus free wakeup */
108 #define OMAP_I2C_WE_STC_WE (1 << 6) /* Start condition wakeup */
109 #define OMAP_I2C_WE_GC_WE (1 << 5) /* General call wakeup */
110 #define OMAP_I2C_WE_DRDY_WE (1 << 3) /* TX/RX data ready wakeup */
111 #define OMAP_I2C_WE_ARDY_WE (1 << 2) /* Reg access ready wakeup */
112 #define OMAP_I2C_WE_NACK_WE (1 << 1) /* No acknowledgment wakeup */
113 #define OMAP_I2C_WE_AL_WE (1 << 0) /* Arbitration lost wakeup */
115 #define OMAP_I2C_WE_ALL (OMAP_I2C_WE_XDR_WE | OMAP_I2C_WE_RDR_WE | \
116 OMAP_I2C_WE_AAS_WE | OMAP_I2C_WE_BF_WE | \
117 OMAP_I2C_WE_STC_WE | OMAP_I2C_WE_GC_WE | \
118 OMAP_I2C_WE_DRDY_WE | OMAP_I2C_WE_ARDY_WE | \
119 OMAP_I2C_WE_NACK_WE | OMAP_I2C_WE_AL_WE)
121 /* I2C Buffer Configuration Register (OMAP_I2C_BUF): */
122 #define OMAP_I2C_BUF_RDMA_EN (1 << 15) /* RX DMA channel enable */
123 #define OMAP_I2C_BUF_RXFIF_CLR (1 << 14) /* RX FIFO Clear */
124 #define OMAP_I2C_BUF_XDMA_EN (1 << 7) /* TX DMA channel enable */
125 #define OMAP_I2C_BUF_TXFIF_CLR (1 << 6) /* TX FIFO Clear */
127 /* I2C Configuration Register (OMAP_I2C_CON): */
128 #define OMAP_I2C_CON_EN (1 << 15) /* I2C module enable */
129 #define OMAP_I2C_CON_BE (1 << 14) /* Big endian mode */
130 #define OMAP_I2C_CON_OPMODE_HS (1 << 12) /* High Speed support */
131 #define OMAP_I2C_CON_STB (1 << 11) /* Start byte mode (master) */
132 #define OMAP_I2C_CON_MST (1 << 10) /* Master/slave mode */
133 #define OMAP_I2C_CON_TRX (1 << 9) /* TX/RX mode (master only) */
134 #define OMAP_I2C_CON_XA (1 << 8) /* Expand address */
135 #define OMAP_I2C_CON_RM (1 << 2) /* Repeat mode (master only) */
136 #define OMAP_I2C_CON_STP (1 << 1) /* Stop cond (master only) */
137 #define OMAP_I2C_CON_STT (1 << 0) /* Start condition (master) */
139 /* I2C SCL time value when Master */
140 #define OMAP_I2C_SCLL_HSSCLL 8
141 #define OMAP_I2C_SCLH_HSSCLH 8
143 /* I2C System Test Register (OMAP_I2C_SYSTEST): */
144 #define OMAP_I2C_SYSTEST_ST_EN (1 << 15) /* System test enable */
145 #define OMAP_I2C_SYSTEST_FREE (1 << 14) /* Free running mode */
146 #define OMAP_I2C_SYSTEST_TMODE_MASK (3 << 12) /* Test mode select */
147 #define OMAP_I2C_SYSTEST_TMODE_SHIFT (12) /* Test mode select */
148 /* Functional mode */
149 #define OMAP_I2C_SYSTEST_SCL_I_FUNC (1 << 8) /* SCL line input value */
150 #define OMAP_I2C_SYSTEST_SCL_O_FUNC (1 << 7) /* SCL line output value */
151 #define OMAP_I2C_SYSTEST_SDA_I_FUNC (1 << 6) /* SDA line input value */
152 #define OMAP_I2C_SYSTEST_SDA_O_FUNC (1 << 5) /* SDA line output value */
153 /* SDA/SCL IO mode */
154 #define OMAP_I2C_SYSTEST_SCL_I (1 << 3) /* SCL line sense in */
155 #define OMAP_I2C_SYSTEST_SCL_O (1 << 2) /* SCL line drive out */
156 #define OMAP_I2C_SYSTEST_SDA_I (1 << 1) /* SDA line sense in */
157 #define OMAP_I2C_SYSTEST_SDA_O (1 << 0) /* SDA line drive out */
159 /* OCP_SYSSTATUS bit definitions */
160 #define SYSS_RESETDONE_MASK (1 << 0)
162 /* OCP_SYSCONFIG bit definitions */
163 #define SYSC_CLOCKACTIVITY_MASK (0x3 << 8)
164 #define SYSC_SIDLEMODE_MASK (0x3 << 3)
165 #define SYSC_ENAWAKEUP_MASK (1 << 2)
166 #define SYSC_SOFTRESET_MASK (1 << 1)
167 #define SYSC_AUTOIDLE_MASK (1 << 0)
169 #define SYSC_IDLEMODE_SMART 0x2
170 #define SYSC_CLOCKACTIVITY_FCLK 0x2
172 /* Errata definitions */
173 #define I2C_OMAP_ERRATA_I207 (1 << 0)
174 #define I2C_OMAP_ERRATA_I462 (1 << 1)
176 #define OMAP_I2C_IP_V2_INTERRUPTS_MASK 0x6FFF
178 struct omap_i2c_dev
{
180 void __iomem
*base
; /* virtual */
182 int reg_shift
; /* bit shift for I2C register addresses */
183 struct completion cmd_complete
;
184 struct resource
*ioarea
;
185 u32 latency
; /* maximum mpu wkup latency */
186 void (*set_mpu_wkup_lat
)(struct device
*dev
,
188 u32 speed
; /* Speed of bus in kHz */
195 struct i2c_adapter adapter
;
197 u8 fifo_size
; /* use as flag and value
198 * fifo_size==0 implies no fifo
199 * if set, should be trsh+1
202 unsigned b_hw
:1; /* bad h/w fixes */
203 unsigned bb_valid
:1; /* true when BB-bit reflects
206 unsigned receiver
:1; /* true when we're in receiver mode */
207 u16 iestate
; /* Saved interrupt register */
216 static const u8 reg_map_ip_v1
[] = {
217 [OMAP_I2C_REV_REG
] = 0x00,
218 [OMAP_I2C_IE_REG
] = 0x01,
219 [OMAP_I2C_STAT_REG
] = 0x02,
220 [OMAP_I2C_IV_REG
] = 0x03,
221 [OMAP_I2C_WE_REG
] = 0x03,
222 [OMAP_I2C_SYSS_REG
] = 0x04,
223 [OMAP_I2C_BUF_REG
] = 0x05,
224 [OMAP_I2C_CNT_REG
] = 0x06,
225 [OMAP_I2C_DATA_REG
] = 0x07,
226 [OMAP_I2C_SYSC_REG
] = 0x08,
227 [OMAP_I2C_CON_REG
] = 0x09,
228 [OMAP_I2C_OA_REG
] = 0x0a,
229 [OMAP_I2C_SA_REG
] = 0x0b,
230 [OMAP_I2C_PSC_REG
] = 0x0c,
231 [OMAP_I2C_SCLL_REG
] = 0x0d,
232 [OMAP_I2C_SCLH_REG
] = 0x0e,
233 [OMAP_I2C_SYSTEST_REG
] = 0x0f,
234 [OMAP_I2C_BUFSTAT_REG
] = 0x10,
237 static const u8 reg_map_ip_v2
[] = {
238 [OMAP_I2C_REV_REG
] = 0x04,
239 [OMAP_I2C_IE_REG
] = 0x2c,
240 [OMAP_I2C_STAT_REG
] = 0x28,
241 [OMAP_I2C_IV_REG
] = 0x34,
242 [OMAP_I2C_WE_REG
] = 0x34,
243 [OMAP_I2C_SYSS_REG
] = 0x90,
244 [OMAP_I2C_BUF_REG
] = 0x94,
245 [OMAP_I2C_CNT_REG
] = 0x98,
246 [OMAP_I2C_DATA_REG
] = 0x9c,
247 [OMAP_I2C_SYSC_REG
] = 0x10,
248 [OMAP_I2C_CON_REG
] = 0xa4,
249 [OMAP_I2C_OA_REG
] = 0xa8,
250 [OMAP_I2C_SA_REG
] = 0xac,
251 [OMAP_I2C_PSC_REG
] = 0xb0,
252 [OMAP_I2C_SCLL_REG
] = 0xb4,
253 [OMAP_I2C_SCLH_REG
] = 0xb8,
254 [OMAP_I2C_SYSTEST_REG
] = 0xbC,
255 [OMAP_I2C_BUFSTAT_REG
] = 0xc0,
256 [OMAP_I2C_IP_V2_REVNB_LO
] = 0x00,
257 [OMAP_I2C_IP_V2_REVNB_HI
] = 0x04,
258 [OMAP_I2C_IP_V2_IRQSTATUS_RAW
] = 0x24,
259 [OMAP_I2C_IP_V2_IRQENABLE_SET
] = 0x2c,
260 [OMAP_I2C_IP_V2_IRQENABLE_CLR
] = 0x30,
263 static int omap_i2c_xfer_data(struct omap_i2c_dev
*omap
);
265 static inline void omap_i2c_write_reg(struct omap_i2c_dev
*omap
,
268 writew_relaxed(val
, omap
->base
+
269 (omap
->regs
[reg
] << omap
->reg_shift
));
272 static inline u16
omap_i2c_read_reg(struct omap_i2c_dev
*omap
, int reg
)
274 return readw_relaxed(omap
->base
+
275 (omap
->regs
[reg
] << omap
->reg_shift
));
278 static void __omap_i2c_init(struct omap_i2c_dev
*omap
)
281 omap_i2c_write_reg(omap
, OMAP_I2C_CON_REG
, 0);
283 /* Setup clock prescaler to obtain approx 12MHz I2C module clock: */
284 omap_i2c_write_reg(omap
, OMAP_I2C_PSC_REG
, omap
->pscstate
);
286 /* SCL low and high time values */
287 omap_i2c_write_reg(omap
, OMAP_I2C_SCLL_REG
, omap
->scllstate
);
288 omap_i2c_write_reg(omap
, OMAP_I2C_SCLH_REG
, omap
->sclhstate
);
289 if (omap
->rev
>= OMAP_I2C_REV_ON_3430_3530
)
290 omap_i2c_write_reg(omap
, OMAP_I2C_WE_REG
, omap
->westate
);
292 /* Take the I2C module out of reset: */
293 omap_i2c_write_reg(omap
, OMAP_I2C_CON_REG
, OMAP_I2C_CON_EN
);
296 * NOTE: right after setting CON_EN, STAT_BB could be 0 while the
297 * bus is busy. It will be changed to 1 on the next IP FCLK clock.
298 * udelay(1) will be enough to fix that.
302 * Don't write to this register if the IE state is 0 as it can
306 omap_i2c_write_reg(omap
, OMAP_I2C_IE_REG
, omap
->iestate
);
309 static int omap_i2c_reset(struct omap_i2c_dev
*omap
)
311 unsigned long timeout
;
314 if (omap
->rev
>= OMAP_I2C_OMAP1_REV_2
) {
315 sysc
= omap_i2c_read_reg(omap
, OMAP_I2C_SYSC_REG
);
317 /* Disable I2C controller before soft reset */
318 omap_i2c_write_reg(omap
, OMAP_I2C_CON_REG
,
319 omap_i2c_read_reg(omap
, OMAP_I2C_CON_REG
) &
322 omap_i2c_write_reg(omap
, OMAP_I2C_SYSC_REG
, SYSC_SOFTRESET_MASK
);
323 /* For some reason we need to set the EN bit before the
324 * reset done bit gets set. */
325 timeout
= jiffies
+ OMAP_I2C_TIMEOUT
;
326 omap_i2c_write_reg(omap
, OMAP_I2C_CON_REG
, OMAP_I2C_CON_EN
);
327 while (!(omap_i2c_read_reg(omap
, OMAP_I2C_SYSS_REG
) &
328 SYSS_RESETDONE_MASK
)) {
329 if (time_after(jiffies
, timeout
)) {
330 dev_warn(omap
->dev
, "timeout waiting "
331 "for controller reset\n");
337 /* SYSC register is cleared by the reset; rewrite it */
338 omap_i2c_write_reg(omap
, OMAP_I2C_SYSC_REG
, sysc
);
340 if (omap
->rev
> OMAP_I2C_REV_ON_3430_3530
) {
341 /* Schedule I2C-bus monitoring on the next transfer */
349 static int omap_i2c_init(struct omap_i2c_dev
*omap
)
351 u16 psc
= 0, scll
= 0, sclh
= 0;
352 u16 fsscll
= 0, fssclh
= 0, hsscll
= 0, hssclh
= 0;
353 unsigned long fclk_rate
= 12000000;
354 unsigned long internal_clk
= 0;
358 if (omap
->rev
>= OMAP_I2C_REV_ON_3430_3530
) {
360 * Enabling all wakup sources to stop I2C freezing on
362 * REVISIT: Some wkup sources might not be needed.
364 omap
->westate
= OMAP_I2C_WE_ALL
;
367 if (omap
->flags
& OMAP_I2C_FLAG_ALWAYS_ARMXOR_CLK
) {
369 * The I2C functional clock is the armxor_ck, so there's
370 * no need to get "armxor_ck" separately. Now, if OMAP2420
371 * always returns 12MHz for the functional clock, we can
372 * do this bit unconditionally.
374 fclk
= clk_get(omap
->dev
, "fck");
376 error
= PTR_ERR(fclk
);
377 dev_err(omap
->dev
, "could not get fck: %i\n", error
);
382 fclk_rate
= clk_get_rate(fclk
);
385 /* TRM for 5912 says the I2C clock must be prescaled to be
386 * between 7 - 12 MHz. The XOR input clock is typically
387 * 12, 13 or 19.2 MHz. So we should have code that produces:
389 * XOR MHz Divider Prescaler
394 if (fclk_rate
> 12000000)
395 psc
= fclk_rate
/ 12000000;
398 if (!(omap
->flags
& OMAP_I2C_FLAG_SIMPLE_CLOCK
)) {
401 * HSI2C controller internal clk rate should be 19.2 Mhz for
402 * HS and for all modes on 2430. On 34xx we can use lower rate
403 * to get longer filter period for better noise suppression.
404 * The filter is iclk (fclk for HS) period.
406 if (omap
->speed
> 400 ||
407 omap
->flags
& OMAP_I2C_FLAG_FORCE_19200_INT_CLK
)
408 internal_clk
= 19200;
409 else if (omap
->speed
> 100)
413 fclk
= clk_get(omap
->dev
, "fck");
415 error
= PTR_ERR(fclk
);
416 dev_err(omap
->dev
, "could not get fck: %i\n", error
);
420 fclk_rate
= clk_get_rate(fclk
) / 1000;
423 /* Compute prescaler divisor */
424 psc
= fclk_rate
/ internal_clk
;
427 /* If configured for High Speed */
428 if (omap
->speed
> 400) {
431 /* For first phase of HS mode */
432 scl
= internal_clk
/ 400;
433 fsscll
= scl
- (scl
/ 3) - 7;
434 fssclh
= (scl
/ 3) - 5;
436 /* For second phase of HS mode */
437 scl
= fclk_rate
/ omap
->speed
;
438 hsscll
= scl
- (scl
/ 3) - 7;
439 hssclh
= (scl
/ 3) - 5;
440 } else if (omap
->speed
> 100) {
444 scl
= internal_clk
/ omap
->speed
;
445 fsscll
= scl
- (scl
/ 3) - 7;
446 fssclh
= (scl
/ 3) - 5;
449 fsscll
= internal_clk
/ (omap
->speed
* 2) - 7;
450 fssclh
= internal_clk
/ (omap
->speed
* 2) - 5;
452 scll
= (hsscll
<< OMAP_I2C_SCLL_HSSCLL
) | fsscll
;
453 sclh
= (hssclh
<< OMAP_I2C_SCLH_HSSCLH
) | fssclh
;
455 /* Program desired operating rate */
456 fclk_rate
/= (psc
+ 1) * 1000;
459 scll
= fclk_rate
/ (omap
->speed
* 2) - 7 + psc
;
460 sclh
= fclk_rate
/ (omap
->speed
* 2) - 7 + psc
;
463 omap
->iestate
= (OMAP_I2C_IE_XRDY
| OMAP_I2C_IE_RRDY
|
464 OMAP_I2C_IE_ARDY
| OMAP_I2C_IE_NACK
|
465 OMAP_I2C_IE_AL
) | ((omap
->fifo_size
) ?
466 (OMAP_I2C_IE_RDR
| OMAP_I2C_IE_XDR
) : 0);
468 omap
->pscstate
= psc
;
469 omap
->scllstate
= scll
;
470 omap
->sclhstate
= sclh
;
472 if (omap
->rev
<= OMAP_I2C_REV_ON_3430_3530
) {
473 /* Not implemented */
477 __omap_i2c_init(omap
);
483 * Try bus recovery, but only if SDA is actually low.
485 static int omap_i2c_recover_bus(struct omap_i2c_dev
*omap
)
489 systest
= omap_i2c_read_reg(omap
, OMAP_I2C_SYSTEST_REG
);
490 if ((systest
& OMAP_I2C_SYSTEST_SCL_I_FUNC
) &&
491 (systest
& OMAP_I2C_SYSTEST_SDA_I_FUNC
))
492 return 0; /* bus seems to already be fine */
493 if (!(systest
& OMAP_I2C_SYSTEST_SCL_I_FUNC
))
494 return -EBUSY
; /* recovery would not fix SCL */
495 return i2c_recover_bus(&omap
->adapter
);
499 * Waiting on Bus Busy
501 static int omap_i2c_wait_for_bb(struct omap_i2c_dev
*omap
)
503 unsigned long timeout
;
505 timeout
= jiffies
+ OMAP_I2C_TIMEOUT
;
506 while (omap_i2c_read_reg(omap
, OMAP_I2C_STAT_REG
) & OMAP_I2C_STAT_BB
) {
507 if (time_after(jiffies
, timeout
))
508 return omap_i2c_recover_bus(omap
);
516 * Wait while BB-bit doesn't reflect the I2C bus state
518 * In a multimaster environment, after IP software reset, BB-bit value doesn't
519 * correspond to the current bus state. It may happen what BB-bit will be 0,
520 * while the bus is busy due to another I2C master activity.
521 * Here are BB-bit values after reset:
527 * Later, if IP detect SDA=0 and SCL=1 (ACK) or SDA 1->0 while SCL=1 (START)
528 * combinations on the bus, it set BB-bit to 1.
529 * If IP detect SDA 0->1 while SCL=1 (STOP) combination on the bus,
530 * it set BB-bit to 0 and BF to 1.
531 * BB and BF bits correctly tracks the bus state while IP is suspended
532 * BB bit became valid on the next FCLK clock after CON_EN bit set
535 * 1. Any transfer started when BB=0 and bus is busy wouldn't be
536 * completed by IP and results in controller timeout.
537 * 2. Any transfer started when BB=0 and SCL=0 results in IP
538 * starting to drive SDA low. In that case IP corrupt data
540 * 3. Any transfer started in the middle of another master's transfer
541 * results in unpredictable results and data corruption
543 static int omap_i2c_wait_for_bb_valid(struct omap_i2c_dev
*omap
)
545 unsigned long bus_free_timeout
= 0;
546 unsigned long timeout
;
553 timeout
= jiffies
+ OMAP_I2C_TIMEOUT
;
555 stat
= omap_i2c_read_reg(omap
, OMAP_I2C_STAT_REG
);
557 * We will see BB or BF event in a case IP had detected any
558 * activity on the I2C bus. Now IP correctly tracks the bus
559 * state. BB-bit value is valid.
561 if (stat
& (OMAP_I2C_STAT_BB
| OMAP_I2C_STAT_BF
))
565 * Otherwise, we must look signals on the bus to make
566 * the right decision.
568 systest
= omap_i2c_read_reg(omap
, OMAP_I2C_SYSTEST_REG
);
569 if ((systest
& OMAP_I2C_SYSTEST_SCL_I_FUNC
) &&
570 (systest
& OMAP_I2C_SYSTEST_SDA_I_FUNC
)) {
572 bus_free_timeout
= jiffies
+
573 OMAP_I2C_BUS_FREE_TIMEOUT
;
578 * SDA and SCL lines was high for 10 ms without bus
579 * activity detected. The bus is free. Consider
580 * BB-bit value is valid.
582 if (time_after(jiffies
, bus_free_timeout
))
588 if (time_after(jiffies
, timeout
)) {
590 * SDA or SCL were low for the entire timeout without
591 * any activity detected. Most likely, a slave is
592 * locking up the bus with no master driving the clock.
594 dev_warn(omap
->dev
, "timeout waiting for bus ready\n");
595 return omap_i2c_recover_bus(omap
);
605 static void omap_i2c_resize_fifo(struct omap_i2c_dev
*omap
, u8 size
, bool is_rx
)
609 if (omap
->flags
& OMAP_I2C_FLAG_NO_FIFO
)
613 * Set up notification threshold based on message size. We're doing
614 * this to try and avoid draining feature as much as possible. Whenever
615 * we have big messages to transfer (bigger than our total fifo size)
616 * then we might use draining feature to transfer the remaining bytes.
619 omap
->threshold
= clamp(size
, (u8
) 1, omap
->fifo_size
);
621 buf
= omap_i2c_read_reg(omap
, OMAP_I2C_BUF_REG
);
624 /* Clear RX Threshold */
626 buf
|= ((omap
->threshold
- 1) << 8) | OMAP_I2C_BUF_RXFIF_CLR
;
628 /* Clear TX Threshold */
630 buf
|= (omap
->threshold
- 1) | OMAP_I2C_BUF_TXFIF_CLR
;
633 omap_i2c_write_reg(omap
, OMAP_I2C_BUF_REG
, buf
);
635 if (omap
->rev
< OMAP_I2C_REV_ON_3630
)
636 omap
->b_hw
= 1; /* Enable hardware fixes */
638 /* calculate wakeup latency constraint for MPU */
639 if (omap
->set_mpu_wkup_lat
!= NULL
)
640 omap
->latency
= (1000000 * omap
->threshold
) /
641 (1000 * omap
->speed
/ 8);
644 static void omap_i2c_wait(struct omap_i2c_dev
*omap
)
647 u16 mask
= omap_i2c_read_reg(omap
, OMAP_I2C_IE_REG
);
651 stat
= omap_i2c_read_reg(omap
, OMAP_I2C_STAT_REG
);
653 } while (!(stat
& mask
) && count
< 5);
657 * Low level master read/write transaction.
659 static int omap_i2c_xfer_msg(struct i2c_adapter
*adap
,
660 struct i2c_msg
*msg
, int stop
, bool polling
)
662 struct omap_i2c_dev
*omap
= i2c_get_adapdata(adap
);
663 unsigned long time_left
;
667 dev_dbg(omap
->dev
, "addr: 0x%04x, len: %d, flags: 0x%x, stop: %d\n",
668 msg
->addr
, msg
->len
, msg
->flags
, stop
);
670 omap
->receiver
= !!(msg
->flags
& I2C_M_RD
);
671 omap_i2c_resize_fifo(omap
, msg
->len
, omap
->receiver
);
673 omap_i2c_write_reg(omap
, OMAP_I2C_SA_REG
, msg
->addr
);
675 /* REVISIT: Could the STB bit of I2C_CON be used with probing? */
676 omap
->buf
= msg
->buf
;
677 omap
->buf_len
= msg
->len
;
679 /* make sure writes to omap->buf_len are ordered */
682 omap_i2c_write_reg(omap
, OMAP_I2C_CNT_REG
, omap
->buf_len
);
684 /* Clear the FIFO Buffers */
685 w
= omap_i2c_read_reg(omap
, OMAP_I2C_BUF_REG
);
686 w
|= OMAP_I2C_BUF_RXFIF_CLR
| OMAP_I2C_BUF_TXFIF_CLR
;
687 omap_i2c_write_reg(omap
, OMAP_I2C_BUF_REG
, w
);
690 reinit_completion(&omap
->cmd_complete
);
693 w
= OMAP_I2C_CON_EN
| OMAP_I2C_CON_MST
| OMAP_I2C_CON_STT
;
695 /* High speed configuration */
696 if (omap
->speed
> 400)
697 w
|= OMAP_I2C_CON_OPMODE_HS
;
699 if (msg
->flags
& I2C_M_STOP
)
701 if (msg
->flags
& I2C_M_TEN
)
702 w
|= OMAP_I2C_CON_XA
;
703 if (!(msg
->flags
& I2C_M_RD
))
704 w
|= OMAP_I2C_CON_TRX
;
706 if (!omap
->b_hw
&& stop
)
707 w
|= OMAP_I2C_CON_STP
;
709 * NOTE: STAT_BB bit could became 1 here if another master occupy
710 * the bus. IP successfully complete transfer when the bus will be
711 * free again (BB reset to 0).
713 omap_i2c_write_reg(omap
, OMAP_I2C_CON_REG
, w
);
716 * Don't write stt and stp together on some hardware.
718 if (omap
->b_hw
&& stop
) {
719 unsigned long delay
= jiffies
+ OMAP_I2C_TIMEOUT
;
720 u16 con
= omap_i2c_read_reg(omap
, OMAP_I2C_CON_REG
);
721 while (con
& OMAP_I2C_CON_STT
) {
722 con
= omap_i2c_read_reg(omap
, OMAP_I2C_CON_REG
);
724 /* Let the user know if i2c is in a bad state */
725 if (time_after(jiffies
, delay
)) {
726 dev_err(omap
->dev
, "controller timed out "
727 "waiting for start condition to finish\n");
733 w
|= OMAP_I2C_CON_STP
;
734 w
&= ~OMAP_I2C_CON_STT
;
735 omap_i2c_write_reg(omap
, OMAP_I2C_CON_REG
, w
);
739 * REVISIT: We should abort the transfer on signals, but the bus goes
740 * into arbitration and we're currently unable to recover from it.
743 time_left
= wait_for_completion_timeout(&omap
->cmd_complete
,
748 ret
= omap_i2c_xfer_data(omap
);
749 } while (ret
== -EAGAIN
);
754 if (time_left
== 0) {
755 omap_i2c_reset(omap
);
756 __omap_i2c_init(omap
);
760 if (likely(!omap
->cmd_err
))
763 /* We have an error */
764 if (omap
->cmd_err
& (OMAP_I2C_STAT_ROVR
| OMAP_I2C_STAT_XUDF
)) {
765 omap_i2c_reset(omap
);
766 __omap_i2c_init(omap
);
770 if (omap
->cmd_err
& OMAP_I2C_STAT_AL
)
773 if (omap
->cmd_err
& OMAP_I2C_STAT_NACK
) {
774 if (msg
->flags
& I2C_M_IGNORE_NAK
)
777 w
= omap_i2c_read_reg(omap
, OMAP_I2C_CON_REG
);
778 w
|= OMAP_I2C_CON_STP
;
779 omap_i2c_write_reg(omap
, OMAP_I2C_CON_REG
, w
);
787 * Prepare controller for a transaction and call omap_i2c_xfer_msg
788 * to do the work during IRQ processing.
791 omap_i2c_xfer_common(struct i2c_adapter
*adap
, struct i2c_msg msgs
[], int num
,
794 struct omap_i2c_dev
*omap
= i2c_get_adapdata(adap
);
798 r
= pm_runtime_get_sync(omap
->dev
);
802 r
= omap_i2c_wait_for_bb_valid(omap
);
806 r
= omap_i2c_wait_for_bb(omap
);
810 if (omap
->set_mpu_wkup_lat
!= NULL
)
811 omap
->set_mpu_wkup_lat(omap
->dev
, omap
->latency
);
813 for (i
= 0; i
< num
; i
++) {
814 r
= omap_i2c_xfer_msg(adap
, &msgs
[i
], (i
== (num
- 1)),
823 omap_i2c_wait_for_bb(omap
);
825 if (omap
->set_mpu_wkup_lat
!= NULL
)
826 omap
->set_mpu_wkup_lat(omap
->dev
, -1);
829 pm_runtime_mark_last_busy(omap
->dev
);
830 pm_runtime_put_autosuspend(omap
->dev
);
835 omap_i2c_xfer_irq(struct i2c_adapter
*adap
, struct i2c_msg msgs
[], int num
)
837 return omap_i2c_xfer_common(adap
, msgs
, num
, false);
841 omap_i2c_xfer_polling(struct i2c_adapter
*adap
, struct i2c_msg msgs
[], int num
)
843 return omap_i2c_xfer_common(adap
, msgs
, num
, true);
847 omap_i2c_func(struct i2c_adapter
*adap
)
849 return I2C_FUNC_I2C
| (I2C_FUNC_SMBUS_EMUL
& ~I2C_FUNC_SMBUS_QUICK
) |
850 I2C_FUNC_PROTOCOL_MANGLING
;
854 omap_i2c_complete_cmd(struct omap_i2c_dev
*omap
, u16 err
)
856 omap
->cmd_err
|= err
;
857 complete(&omap
->cmd_complete
);
861 omap_i2c_ack_stat(struct omap_i2c_dev
*omap
, u16 stat
)
863 omap_i2c_write_reg(omap
, OMAP_I2C_STAT_REG
, stat
);
866 static inline void i2c_omap_errata_i207(struct omap_i2c_dev
*omap
, u16 stat
)
869 * I2C Errata(Errata Nos. OMAP2: 1.67, OMAP3: 1.8)
870 * Not applicable for OMAP4.
871 * Under certain rare conditions, RDR could be set again
872 * when the bus is busy, then ignore the interrupt and
873 * clear the interrupt.
875 if (stat
& OMAP_I2C_STAT_RDR
) {
876 /* Step 1: If RDR is set, clear it */
877 omap_i2c_ack_stat(omap
, OMAP_I2C_STAT_RDR
);
880 if (!(omap_i2c_read_reg(omap
, OMAP_I2C_STAT_REG
)
881 & OMAP_I2C_STAT_BB
)) {
884 if (omap_i2c_read_reg(omap
, OMAP_I2C_STAT_REG
)
885 & OMAP_I2C_STAT_RDR
) {
886 omap_i2c_ack_stat(omap
, OMAP_I2C_STAT_RDR
);
887 dev_dbg(omap
->dev
, "RDR when bus is busy.\n");
894 /* rev1 devices are apparently only on some 15xx */
895 #ifdef CONFIG_ARCH_OMAP15XX
898 omap_i2c_omap1_isr(int this_irq
, void *dev_id
)
900 struct omap_i2c_dev
*omap
= dev_id
;
903 if (pm_runtime_suspended(omap
->dev
))
906 iv
= omap_i2c_read_reg(omap
, OMAP_I2C_IV_REG
);
908 case 0x00: /* None */
910 case 0x01: /* Arbitration lost */
911 dev_err(omap
->dev
, "Arbitration lost\n");
912 omap_i2c_complete_cmd(omap
, OMAP_I2C_STAT_AL
);
914 case 0x02: /* No acknowledgement */
915 omap_i2c_complete_cmd(omap
, OMAP_I2C_STAT_NACK
);
916 omap_i2c_write_reg(omap
, OMAP_I2C_CON_REG
, OMAP_I2C_CON_STP
);
918 case 0x03: /* Register access ready */
919 omap_i2c_complete_cmd(omap
, 0);
921 case 0x04: /* Receive data ready */
923 w
= omap_i2c_read_reg(omap
, OMAP_I2C_DATA_REG
);
927 *omap
->buf
++ = w
>> 8;
931 dev_err(omap
->dev
, "RRDY IRQ while no data requested\n");
933 case 0x05: /* Transmit data ready */
938 w
|= *omap
->buf
++ << 8;
941 omap_i2c_write_reg(omap
, OMAP_I2C_DATA_REG
, w
);
943 dev_err(omap
->dev
, "XRDY IRQ while no data to send\n");
952 #define omap_i2c_omap1_isr NULL
956 * OMAP3430 Errata i462: When an XRDY/XDR is hit, wait for XUDF before writing
957 * data to DATA_REG. Otherwise some data bytes can be lost while transferring
958 * them from the memory to the I2C interface.
960 static int errata_omap3_i462(struct omap_i2c_dev
*omap
)
962 unsigned long timeout
= 10000;
966 stat
= omap_i2c_read_reg(omap
, OMAP_I2C_STAT_REG
);
967 if (stat
& OMAP_I2C_STAT_XUDF
)
970 if (stat
& (OMAP_I2C_STAT_NACK
| OMAP_I2C_STAT_AL
)) {
971 omap_i2c_ack_stat(omap
, (OMAP_I2C_STAT_XRDY
|
973 if (stat
& OMAP_I2C_STAT_NACK
) {
974 omap
->cmd_err
|= OMAP_I2C_STAT_NACK
;
975 omap_i2c_ack_stat(omap
, OMAP_I2C_STAT_NACK
);
978 if (stat
& OMAP_I2C_STAT_AL
) {
979 dev_err(omap
->dev
, "Arbitration lost\n");
980 omap
->cmd_err
|= OMAP_I2C_STAT_AL
;
981 omap_i2c_ack_stat(omap
, OMAP_I2C_STAT_AL
);
991 dev_err(omap
->dev
, "timeout waiting on XUDF bit\n");
998 static void omap_i2c_receive_data(struct omap_i2c_dev
*omap
, u8 num_bytes
,
1003 while (num_bytes
--) {
1004 w
= omap_i2c_read_reg(omap
, OMAP_I2C_DATA_REG
);
1009 * Data reg in 2430, omap3 and
1010 * omap4 is 8 bit wide
1012 if (omap
->flags
& OMAP_I2C_FLAG_16BIT_DATA_REG
) {
1013 *omap
->buf
++ = w
>> 8;
1019 static int omap_i2c_transmit_data(struct omap_i2c_dev
*omap
, u8 num_bytes
,
1024 while (num_bytes
--) {
1029 * Data reg in 2430, omap3 and
1030 * omap4 is 8 bit wide
1032 if (omap
->flags
& OMAP_I2C_FLAG_16BIT_DATA_REG
) {
1033 w
|= *omap
->buf
++ << 8;
1037 if (omap
->errata
& I2C_OMAP_ERRATA_I462
) {
1040 ret
= errata_omap3_i462(omap
);
1045 omap_i2c_write_reg(omap
, OMAP_I2C_DATA_REG
, w
);
1052 omap_i2c_isr(int irq
, void *dev_id
)
1054 struct omap_i2c_dev
*omap
= dev_id
;
1055 irqreturn_t ret
= IRQ_HANDLED
;
1059 stat
= omap_i2c_read_reg(omap
, OMAP_I2C_STAT_REG
);
1060 mask
= omap_i2c_read_reg(omap
, OMAP_I2C_IE_REG
) & ~OMAP_I2C_STAT_NACK
;
1063 ret
= IRQ_WAKE_THREAD
;
1068 static int omap_i2c_xfer_data(struct omap_i2c_dev
*omap
)
1072 int err
= 0, count
= 0;
1075 bits
= omap_i2c_read_reg(omap
, OMAP_I2C_IE_REG
);
1076 stat
= omap_i2c_read_reg(omap
, OMAP_I2C_STAT_REG
);
1079 /* If we're in receiver mode, ignore XDR/XRDY */
1081 stat
&= ~(OMAP_I2C_STAT_XDR
| OMAP_I2C_STAT_XRDY
);
1083 stat
&= ~(OMAP_I2C_STAT_RDR
| OMAP_I2C_STAT_RRDY
);
1086 /* my work here is done */
1091 dev_dbg(omap
->dev
, "IRQ (ISR = 0x%04x)\n", stat
);
1092 if (count
++ == 100) {
1093 dev_warn(omap
->dev
, "Too much work in one IRQ\n");
1097 if (stat
& OMAP_I2C_STAT_NACK
) {
1098 err
|= OMAP_I2C_STAT_NACK
;
1099 omap_i2c_ack_stat(omap
, OMAP_I2C_STAT_NACK
);
1102 if (stat
& OMAP_I2C_STAT_AL
) {
1103 dev_err(omap
->dev
, "Arbitration lost\n");
1104 err
|= OMAP_I2C_STAT_AL
;
1105 omap_i2c_ack_stat(omap
, OMAP_I2C_STAT_AL
);
1109 * ProDB0017052: Clear ARDY bit twice
1111 if (stat
& OMAP_I2C_STAT_ARDY
)
1112 omap_i2c_ack_stat(omap
, OMAP_I2C_STAT_ARDY
);
1114 if (stat
& (OMAP_I2C_STAT_ARDY
| OMAP_I2C_STAT_NACK
|
1115 OMAP_I2C_STAT_AL
)) {
1116 omap_i2c_ack_stat(omap
, (OMAP_I2C_STAT_RRDY
|
1118 OMAP_I2C_STAT_XRDY
|
1120 OMAP_I2C_STAT_ARDY
));
1124 if (stat
& OMAP_I2C_STAT_RDR
) {
1127 if (omap
->fifo_size
)
1128 num_bytes
= omap
->buf_len
;
1130 if (omap
->errata
& I2C_OMAP_ERRATA_I207
) {
1131 i2c_omap_errata_i207(omap
, stat
);
1132 num_bytes
= (omap_i2c_read_reg(omap
,
1133 OMAP_I2C_BUFSTAT_REG
) >> 8) & 0x3F;
1136 omap_i2c_receive_data(omap
, num_bytes
, true);
1137 omap_i2c_ack_stat(omap
, OMAP_I2C_STAT_RDR
);
1141 if (stat
& OMAP_I2C_STAT_RRDY
) {
1144 if (omap
->threshold
)
1145 num_bytes
= omap
->threshold
;
1147 omap_i2c_receive_data(omap
, num_bytes
, false);
1148 omap_i2c_ack_stat(omap
, OMAP_I2C_STAT_RRDY
);
1152 if (stat
& OMAP_I2C_STAT_XDR
) {
1156 if (omap
->fifo_size
)
1157 num_bytes
= omap
->buf_len
;
1159 ret
= omap_i2c_transmit_data(omap
, num_bytes
, true);
1163 omap_i2c_ack_stat(omap
, OMAP_I2C_STAT_XDR
);
1167 if (stat
& OMAP_I2C_STAT_XRDY
) {
1171 if (omap
->threshold
)
1172 num_bytes
= omap
->threshold
;
1174 ret
= omap_i2c_transmit_data(omap
, num_bytes
, false);
1178 omap_i2c_ack_stat(omap
, OMAP_I2C_STAT_XRDY
);
1182 if (stat
& OMAP_I2C_STAT_ROVR
) {
1183 dev_err(omap
->dev
, "Receive overrun\n");
1184 err
|= OMAP_I2C_STAT_ROVR
;
1185 omap_i2c_ack_stat(omap
, OMAP_I2C_STAT_ROVR
);
1189 if (stat
& OMAP_I2C_STAT_XUDF
) {
1190 dev_err(omap
->dev
, "Transmit underflow\n");
1191 err
|= OMAP_I2C_STAT_XUDF
;
1192 omap_i2c_ack_stat(omap
, OMAP_I2C_STAT_XUDF
);
1201 omap_i2c_isr_thread(int this_irq
, void *dev_id
)
1204 struct omap_i2c_dev
*omap
= dev_id
;
1206 ret
= omap_i2c_xfer_data(omap
);
1208 omap_i2c_complete_cmd(omap
, ret
);
1213 static const struct i2c_algorithm omap_i2c_algo
= {
1214 .master_xfer
= omap_i2c_xfer_irq
,
1215 .master_xfer_atomic
= omap_i2c_xfer_polling
,
1216 .functionality
= omap_i2c_func
,
1219 static const struct i2c_adapter_quirks omap_i2c_quirks
= {
1220 .flags
= I2C_AQ_NO_ZERO_LEN
,
1224 static struct omap_i2c_bus_platform_data omap2420_pdata
= {
1225 .rev
= OMAP_I2C_IP_VERSION_1
,
1226 .flags
= OMAP_I2C_FLAG_NO_FIFO
|
1227 OMAP_I2C_FLAG_SIMPLE_CLOCK
|
1228 OMAP_I2C_FLAG_16BIT_DATA_REG
|
1229 OMAP_I2C_FLAG_BUS_SHIFT_2
,
1232 static struct omap_i2c_bus_platform_data omap2430_pdata
= {
1233 .rev
= OMAP_I2C_IP_VERSION_1
,
1234 .flags
= OMAP_I2C_FLAG_BUS_SHIFT_2
|
1235 OMAP_I2C_FLAG_FORCE_19200_INT_CLK
,
1238 static struct omap_i2c_bus_platform_data omap3_pdata
= {
1239 .rev
= OMAP_I2C_IP_VERSION_1
,
1240 .flags
= OMAP_I2C_FLAG_BUS_SHIFT_2
,
1243 static struct omap_i2c_bus_platform_data omap4_pdata
= {
1244 .rev
= OMAP_I2C_IP_VERSION_2
,
1247 static const struct of_device_id omap_i2c_of_match
[] = {
1249 .compatible
= "ti,omap4-i2c",
1250 .data
= &omap4_pdata
,
1253 .compatible
= "ti,omap3-i2c",
1254 .data
= &omap3_pdata
,
1257 .compatible
= "ti,omap2430-i2c",
1258 .data
= &omap2430_pdata
,
1261 .compatible
= "ti,omap2420-i2c",
1262 .data
= &omap2420_pdata
,
1266 MODULE_DEVICE_TABLE(of
, omap_i2c_of_match
);
1269 #define OMAP_I2C_SCHEME(rev) ((rev & 0xc000) >> 14)
1271 #define OMAP_I2C_REV_SCHEME_0_MAJOR(rev) (rev >> 4)
1272 #define OMAP_I2C_REV_SCHEME_0_MINOR(rev) (rev & 0xf)
1274 #define OMAP_I2C_REV_SCHEME_1_MAJOR(rev) ((rev & 0x0700) >> 7)
1275 #define OMAP_I2C_REV_SCHEME_1_MINOR(rev) (rev & 0x1f)
1276 #define OMAP_I2C_SCHEME_0 0
1277 #define OMAP_I2C_SCHEME_1 1
1279 static int omap_i2c_get_scl(struct i2c_adapter
*adap
)
1281 struct omap_i2c_dev
*dev
= i2c_get_adapdata(adap
);
1284 reg
= omap_i2c_read_reg(dev
, OMAP_I2C_SYSTEST_REG
);
1286 return reg
& OMAP_I2C_SYSTEST_SCL_I_FUNC
;
1289 static int omap_i2c_get_sda(struct i2c_adapter
*adap
)
1291 struct omap_i2c_dev
*dev
= i2c_get_adapdata(adap
);
1294 reg
= omap_i2c_read_reg(dev
, OMAP_I2C_SYSTEST_REG
);
1296 return reg
& OMAP_I2C_SYSTEST_SDA_I_FUNC
;
1299 static void omap_i2c_set_scl(struct i2c_adapter
*adap
, int val
)
1301 struct omap_i2c_dev
*dev
= i2c_get_adapdata(adap
);
1304 reg
= omap_i2c_read_reg(dev
, OMAP_I2C_SYSTEST_REG
);
1306 reg
|= OMAP_I2C_SYSTEST_SCL_O
;
1308 reg
&= ~OMAP_I2C_SYSTEST_SCL_O
;
1309 omap_i2c_write_reg(dev
, OMAP_I2C_SYSTEST_REG
, reg
);
1312 static void omap_i2c_prepare_recovery(struct i2c_adapter
*adap
)
1314 struct omap_i2c_dev
*dev
= i2c_get_adapdata(adap
);
1317 reg
= omap_i2c_read_reg(dev
, OMAP_I2C_SYSTEST_REG
);
1318 /* enable test mode */
1319 reg
|= OMAP_I2C_SYSTEST_ST_EN
;
1320 /* select SDA/SCL IO mode */
1321 reg
|= 3 << OMAP_I2C_SYSTEST_TMODE_SHIFT
;
1322 /* set SCL to high-impedance state (reset value is 0) */
1323 reg
|= OMAP_I2C_SYSTEST_SCL_O
;
1324 /* set SDA to high-impedance state (reset value is 0) */
1325 reg
|= OMAP_I2C_SYSTEST_SDA_O
;
1326 omap_i2c_write_reg(dev
, OMAP_I2C_SYSTEST_REG
, reg
);
1329 static void omap_i2c_unprepare_recovery(struct i2c_adapter
*adap
)
1331 struct omap_i2c_dev
*dev
= i2c_get_adapdata(adap
);
1334 reg
= omap_i2c_read_reg(dev
, OMAP_I2C_SYSTEST_REG
);
1335 /* restore reset values */
1336 reg
&= ~OMAP_I2C_SYSTEST_ST_EN
;
1337 reg
&= ~OMAP_I2C_SYSTEST_TMODE_MASK
;
1338 reg
&= ~OMAP_I2C_SYSTEST_SCL_O
;
1339 reg
&= ~OMAP_I2C_SYSTEST_SDA_O
;
1340 omap_i2c_write_reg(dev
, OMAP_I2C_SYSTEST_REG
, reg
);
1343 static struct i2c_bus_recovery_info omap_i2c_bus_recovery_info
= {
1344 .get_scl
= omap_i2c_get_scl
,
1345 .get_sda
= omap_i2c_get_sda
,
1346 .set_scl
= omap_i2c_set_scl
,
1347 .prepare_recovery
= omap_i2c_prepare_recovery
,
1348 .unprepare_recovery
= omap_i2c_unprepare_recovery
,
1349 .recover_bus
= i2c_generic_scl_recovery
,
1353 omap_i2c_probe(struct platform_device
*pdev
)
1355 struct omap_i2c_dev
*omap
;
1356 struct i2c_adapter
*adap
;
1357 const struct omap_i2c_bus_platform_data
*pdata
=
1358 dev_get_platdata(&pdev
->dev
);
1359 struct device_node
*node
= pdev
->dev
.of_node
;
1365 irq
= platform_get_irq(pdev
, 0);
1369 omap
= devm_kzalloc(&pdev
->dev
, sizeof(struct omap_i2c_dev
), GFP_KERNEL
);
1373 omap
->base
= devm_platform_ioremap_resource(pdev
, 0);
1374 if (IS_ERR(omap
->base
))
1375 return PTR_ERR(omap
->base
);
1377 if (pdev
->dev
.of_node
) {
1378 u32 freq
= I2C_MAX_STANDARD_MODE_FREQ
;
1380 pdata
= device_get_match_data(&pdev
->dev
);
1381 omap
->flags
= pdata
->flags
;
1383 of_property_read_u32(node
, "clock-frequency", &freq
);
1384 /* convert DT freq value in Hz into kHz for speed */
1385 omap
->speed
= freq
/ 1000;
1386 } else if (pdata
!= NULL
) {
1387 omap
->speed
= pdata
->clkrate
;
1388 omap
->flags
= pdata
->flags
;
1389 omap
->set_mpu_wkup_lat
= pdata
->set_mpu_wkup_lat
;
1392 omap
->dev
= &pdev
->dev
;
1395 platform_set_drvdata(pdev
, omap
);
1396 init_completion(&omap
->cmd_complete
);
1398 omap
->reg_shift
= (omap
->flags
>> OMAP_I2C_FLAG_BUS_SHIFT__SHIFT
) & 3;
1400 pm_runtime_enable(omap
->dev
);
1401 pm_runtime_set_autosuspend_delay(omap
->dev
, OMAP_I2C_PM_TIMEOUT
);
1402 pm_runtime_use_autosuspend(omap
->dev
);
1404 r
= pm_runtime_resume_and_get(omap
->dev
);
1406 goto err_disable_pm
;
1409 * Read the Rev hi bit-[15:14] ie scheme this is 1 indicates ver2.
1410 * On omap1/3/2 Offset 4 is IE Reg the bit [15:14] is 0 at reset.
1411 * Also since the omap_i2c_read_reg uses reg_map_ip_* a
1412 * readw_relaxed is done.
1414 rev
= readw_relaxed(omap
->base
+ 0x04);
1416 omap
->scheme
= OMAP_I2C_SCHEME(rev
);
1417 switch (omap
->scheme
) {
1418 case OMAP_I2C_SCHEME_0
:
1419 omap
->regs
= (u8
*)reg_map_ip_v1
;
1420 omap
->rev
= omap_i2c_read_reg(omap
, OMAP_I2C_REV_REG
);
1421 minor
= OMAP_I2C_REV_SCHEME_0_MAJOR(omap
->rev
);
1422 major
= OMAP_I2C_REV_SCHEME_0_MAJOR(omap
->rev
);
1424 case OMAP_I2C_SCHEME_1
:
1426 omap
->regs
= (u8
*)reg_map_ip_v2
;
1428 omap_i2c_read_reg(omap
, OMAP_I2C_IP_V2_REVNB_LO
);
1429 minor
= OMAP_I2C_REV_SCHEME_1_MINOR(rev
);
1430 major
= OMAP_I2C_REV_SCHEME_1_MAJOR(rev
);
1436 if (omap
->rev
>= OMAP_I2C_REV_ON_2430
&&
1437 omap
->rev
< OMAP_I2C_REV_ON_4430_PLUS
)
1438 omap
->errata
|= I2C_OMAP_ERRATA_I207
;
1440 if (omap
->rev
<= OMAP_I2C_REV_ON_3430_3530
)
1441 omap
->errata
|= I2C_OMAP_ERRATA_I462
;
1443 if (!(omap
->flags
& OMAP_I2C_FLAG_NO_FIFO
)) {
1446 /* Set up the fifo size - Get total size */
1447 s
= (omap_i2c_read_reg(omap
, OMAP_I2C_BUFSTAT_REG
) >> 14) & 0x3;
1448 omap
->fifo_size
= 0x8 << s
;
1451 * Set up notification threshold as half the total available
1452 * size. This is to ensure that we can handle the status on int
1453 * call back latencies.
1456 omap
->fifo_size
= (omap
->fifo_size
/ 2);
1458 if (omap
->rev
< OMAP_I2C_REV_ON_3630
)
1459 omap
->b_hw
= 1; /* Enable hardware fixes */
1461 /* calculate wakeup latency constraint for MPU */
1462 if (omap
->set_mpu_wkup_lat
!= NULL
)
1463 omap
->latency
= (1000000 * omap
->fifo_size
) /
1464 (1000 * omap
->speed
/ 8);
1467 /* reset ASAP, clearing any IRQs */
1468 omap_i2c_init(omap
);
1470 if (omap
->rev
< OMAP_I2C_OMAP1_REV_2
)
1471 r
= devm_request_irq(&pdev
->dev
, omap
->irq
, omap_i2c_omap1_isr
,
1472 IRQF_NO_SUSPEND
, pdev
->name
, omap
);
1474 r
= devm_request_threaded_irq(&pdev
->dev
, omap
->irq
,
1475 omap_i2c_isr
, omap_i2c_isr_thread
,
1476 IRQF_NO_SUSPEND
| IRQF_ONESHOT
,
1480 dev_err(omap
->dev
, "failure requesting irq %i\n", omap
->irq
);
1481 goto err_unuse_clocks
;
1484 adap
= &omap
->adapter
;
1485 i2c_set_adapdata(adap
, omap
);
1486 adap
->owner
= THIS_MODULE
;
1487 adap
->class = I2C_CLASS_DEPRECATED
;
1488 strscpy(adap
->name
, "OMAP I2C adapter", sizeof(adap
->name
));
1489 adap
->algo
= &omap_i2c_algo
;
1490 adap
->quirks
= &omap_i2c_quirks
;
1491 adap
->dev
.parent
= &pdev
->dev
;
1492 adap
->dev
.of_node
= pdev
->dev
.of_node
;
1493 adap
->bus_recovery_info
= &omap_i2c_bus_recovery_info
;
1495 /* i2c device drivers may be active on return from add_adapter() */
1496 adap
->nr
= pdev
->id
;
1497 r
= i2c_add_numbered_adapter(adap
);
1499 goto err_unuse_clocks
;
1501 dev_info(omap
->dev
, "bus %d rev%d.%d at %d kHz\n", adap
->nr
,
1502 major
, minor
, omap
->speed
);
1504 pm_runtime_mark_last_busy(omap
->dev
);
1505 pm_runtime_put_autosuspend(omap
->dev
);
1510 omap_i2c_write_reg(omap
, OMAP_I2C_CON_REG
, 0);
1511 pm_runtime_dont_use_autosuspend(omap
->dev
);
1512 pm_runtime_put_sync(omap
->dev
);
1514 pm_runtime_disable(&pdev
->dev
);
1519 static void omap_i2c_remove(struct platform_device
*pdev
)
1521 struct omap_i2c_dev
*omap
= platform_get_drvdata(pdev
);
1524 i2c_del_adapter(&omap
->adapter
);
1526 ret
= pm_runtime_get_sync(&pdev
->dev
);
1528 dev_err(omap
->dev
, "Failed to resume hardware, skip disable\n");
1530 omap_i2c_write_reg(omap
, OMAP_I2C_CON_REG
, 0);
1532 pm_runtime_dont_use_autosuspend(&pdev
->dev
);
1533 pm_runtime_put_sync(&pdev
->dev
);
1534 pm_runtime_disable(&pdev
->dev
);
1537 static int omap_i2c_runtime_suspend(struct device
*dev
)
1539 struct omap_i2c_dev
*omap
= dev_get_drvdata(dev
);
1541 omap
->iestate
= omap_i2c_read_reg(omap
, OMAP_I2C_IE_REG
);
1543 if (omap
->scheme
== OMAP_I2C_SCHEME_0
)
1544 omap_i2c_write_reg(omap
, OMAP_I2C_IE_REG
, 0);
1546 omap_i2c_write_reg(omap
, OMAP_I2C_IP_V2_IRQENABLE_CLR
,
1547 OMAP_I2C_IP_V2_INTERRUPTS_MASK
);
1549 if (omap
->rev
< OMAP_I2C_OMAP1_REV_2
) {
1550 omap_i2c_read_reg(omap
, OMAP_I2C_IV_REG
); /* Read clears */
1552 omap_i2c_write_reg(omap
, OMAP_I2C_STAT_REG
, omap
->iestate
);
1554 /* Flush posted write */
1555 omap_i2c_read_reg(omap
, OMAP_I2C_STAT_REG
);
1558 pinctrl_pm_select_sleep_state(dev
);
1563 static int omap_i2c_runtime_resume(struct device
*dev
)
1565 struct omap_i2c_dev
*omap
= dev_get_drvdata(dev
);
1567 pinctrl_pm_select_default_state(dev
);
1572 __omap_i2c_init(omap
);
1577 static int omap_i2c_suspend(struct device
*dev
)
1580 * If the controller is autosuspended, there is no way to wakeup it once
1581 * runtime pm is disabled (in suspend_late()).
1582 * But a device may need the controller up during suspend_noirq() or
1584 * Wakeup the controller while runtime pm is enabled, so it is available
1585 * until its suspend_noirq(), and from resume_noirq().
1587 return pm_runtime_resume_and_get(dev
);
1590 static int omap_i2c_resume(struct device
*dev
)
1592 pm_runtime_mark_last_busy(dev
);
1593 pm_runtime_put_autosuspend(dev
);
1598 static const struct dev_pm_ops omap_i2c_pm_ops
= {
1599 NOIRQ_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend
,
1600 pm_runtime_force_resume
)
1601 SYSTEM_SLEEP_PM_OPS(omap_i2c_suspend
, omap_i2c_resume
)
1602 RUNTIME_PM_OPS(omap_i2c_runtime_suspend
,
1603 omap_i2c_runtime_resume
, NULL
)
1606 static struct platform_driver omap_i2c_driver
= {
1607 .probe
= omap_i2c_probe
,
1608 .remove
= omap_i2c_remove
,
1611 .pm
= pm_ptr(&omap_i2c_pm_ops
),
1612 .of_match_table
= of_match_ptr(omap_i2c_of_match
),
1616 /* I2C may be needed to bring up other drivers */
1618 omap_i2c_init_driver(void)
1620 return platform_driver_register(&omap_i2c_driver
);
1622 subsys_initcall(omap_i2c_init_driver
);
1624 static void __exit
omap_i2c_exit_driver(void)
1626 platform_driver_unregister(&omap_i2c_driver
);
1628 module_exit(omap_i2c_exit_driver
);
1630 MODULE_AUTHOR("MontaVista Software, Inc. (and others)");
1631 MODULE_DESCRIPTION("TI OMAP I2C bus adapter");
1632 MODULE_LICENSE("GPL");
1633 MODULE_ALIAS("platform:omap_i2c");