]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/i2c/busses/i2c-davinci.c
Merge remote-tracking branches 'regmap/topic/mmio', 'regmap/topic/rbtree' and 'regmap...
[mirror_ubuntu-artful-kernel.git] / drivers / i2c / busses / i2c-davinci.c
CommitLineData
95a7f10e
VB
1/*
2 * TI DAVINCI I2C adapter driver.
3 *
4 * Copyright (C) 2006 Texas Instruments.
5 * Copyright (C) 2007 MontaVista Software Inc.
6 *
7 * Updated by Vinod & Sudhakar Feb 2005
8 *
9 * ----------------------------------------------------------------------------
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
95a7f10e
VB
20 * ----------------------------------------------------------------------------
21 *
22 */
23#include <linux/kernel.h>
24#include <linux/module.h>
25#include <linux/delay.h>
26#include <linux/i2c.h>
27#include <linux/clk.h>
28#include <linux/errno.h>
29#include <linux/sched.h>
30#include <linux/err.h>
31#include <linux/interrupt.h>
32#include <linux/platform_device.h>
33#include <linux/io.h>
5a0e3ad6 34#include <linux/slab.h>
82c0de11 35#include <linux/cpufreq.h>
8574faf9 36#include <linux/gpio.h>
5c3d8a46 37#include <linux/of_device.h>
ec2a0833 38#include <linux/platform_data/i2c-davinci.h>
95a7f10e
VB
39
40/* ----- global defines ----------------------------------------------- */
41
42#define DAVINCI_I2C_TIMEOUT (1*HZ)
8574faf9 43#define DAVINCI_I2C_MAX_TRIES 2
41c8d452
AS
44#define DAVINCI_I2C_OWN_ADDRESS 0x08
45#define I2C_DAVINCI_INTR_ALL (DAVINCI_I2C_IMR_SCD | \
95a7f10e
VB
46 DAVINCI_I2C_IMR_ARDY | \
47 DAVINCI_I2C_IMR_NACK | \
48 DAVINCI_I2C_IMR_AL)
49
50#define DAVINCI_I2C_OAR_REG 0x00
51#define DAVINCI_I2C_IMR_REG 0x04
52#define DAVINCI_I2C_STR_REG 0x08
53#define DAVINCI_I2C_CLKL_REG 0x0c
54#define DAVINCI_I2C_CLKH_REG 0x10
55#define DAVINCI_I2C_CNT_REG 0x14
56#define DAVINCI_I2C_DRR_REG 0x18
57#define DAVINCI_I2C_SAR_REG 0x1c
58#define DAVINCI_I2C_DXR_REG 0x20
59#define DAVINCI_I2C_MDR_REG 0x24
60#define DAVINCI_I2C_IVR_REG 0x28
61#define DAVINCI_I2C_EMDR_REG 0x2c
62#define DAVINCI_I2C_PSC_REG 0x30
7ef97e9a
GS
63#define DAVINCI_I2C_FUNC_REG 0x48
64#define DAVINCI_I2C_DIR_REG 0x4c
65#define DAVINCI_I2C_DIN_REG 0x50
66#define DAVINCI_I2C_DOUT_REG 0x54
67#define DAVINCI_I2C_DSET_REG 0x58
68#define DAVINCI_I2C_DCLR_REG 0x5c
95a7f10e
VB
69
70#define DAVINCI_I2C_IVR_AAS 0x07
71#define DAVINCI_I2C_IVR_SCD 0x06
72#define DAVINCI_I2C_IVR_XRDY 0x05
73#define DAVINCI_I2C_IVR_RDR 0x04
74#define DAVINCI_I2C_IVR_ARDY 0x03
75#define DAVINCI_I2C_IVR_NACK 0x02
76#define DAVINCI_I2C_IVR_AL 0x01
77
c062a251
C
78#define DAVINCI_I2C_STR_BB BIT(12)
79#define DAVINCI_I2C_STR_RSFULL BIT(11)
80#define DAVINCI_I2C_STR_SCD BIT(5)
81#define DAVINCI_I2C_STR_ARDY BIT(2)
82#define DAVINCI_I2C_STR_NACK BIT(1)
83#define DAVINCI_I2C_STR_AL BIT(0)
84
85#define DAVINCI_I2C_MDR_NACK BIT(15)
86#define DAVINCI_I2C_MDR_STT BIT(13)
87#define DAVINCI_I2C_MDR_STP BIT(11)
88#define DAVINCI_I2C_MDR_MST BIT(10)
89#define DAVINCI_I2C_MDR_TRX BIT(9)
90#define DAVINCI_I2C_MDR_XA BIT(8)
91#define DAVINCI_I2C_MDR_RM BIT(7)
92#define DAVINCI_I2C_MDR_IRS BIT(5)
93
94#define DAVINCI_I2C_IMR_AAS BIT(6)
95#define DAVINCI_I2C_IMR_SCD BIT(5)
96#define DAVINCI_I2C_IMR_XRDY BIT(4)
97#define DAVINCI_I2C_IMR_RRDY BIT(3)
98#define DAVINCI_I2C_IMR_ARDY BIT(2)
99#define DAVINCI_I2C_IMR_NACK BIT(1)
100#define DAVINCI_I2C_IMR_AL BIT(0)
95a7f10e 101
7ef97e9a
GS
102/* set SDA and SCL as GPIO */
103#define DAVINCI_I2C_FUNC_PFUNC0 BIT(0)
104
105/* set SCL as output when used as GPIO*/
106#define DAVINCI_I2C_DIR_PDIR0 BIT(0)
107/* set SDA as output when used as GPIO*/
108#define DAVINCI_I2C_DIR_PDIR1 BIT(1)
109
110/* read SCL GPIO level */
111#define DAVINCI_I2C_DIN_PDIN0 BIT(0)
112/* read SDA GPIO level */
113#define DAVINCI_I2C_DIN_PDIN1 BIT(1)
114
115/*set the SCL GPIO high */
116#define DAVINCI_I2C_DSET_PDSET0 BIT(0)
117/*set the SDA GPIO high */
118#define DAVINCI_I2C_DSET_PDSET1 BIT(1)
119
120/* set the SCL GPIO low */
121#define DAVINCI_I2C_DCLR_PDCLR0 BIT(0)
122/* set the SDA GPIO low */
123#define DAVINCI_I2C_DCLR_PDCLR1 BIT(1)
124
95a7f10e
VB
125struct davinci_i2c_dev {
126 struct device *dev;
127 void __iomem *base;
128 struct completion cmd_complete;
129 struct clk *clk;
130 int cmd_err;
131 u8 *buf;
132 size_t buf_len;
133 int irq;
c6c7c729 134 int stop;
5a0d5f5f 135 u8 terminate;
95a7f10e 136 struct i2c_adapter adapter;
82c0de11
C
137#ifdef CONFIG_CPU_FREQ
138 struct completion xfr_complete;
139 struct notifier_block freq_transition;
140#endif
5c3d8a46 141 struct davinci_i2c_platform_data *pdata;
95a7f10e
VB
142};
143
144/* default platform data to use if not supplied in the platform_device */
145static struct davinci_i2c_platform_data davinci_i2c_platform_data_default = {
146 .bus_freq = 100,
147 .bus_delay = 0,
148};
149
150static inline void davinci_i2c_write_reg(struct davinci_i2c_dev *i2c_dev,
151 int reg, u16 val)
152{
a238dcfa 153 writew_relaxed(val, i2c_dev->base + reg);
95a7f10e
VB
154}
155
156static inline u16 davinci_i2c_read_reg(struct davinci_i2c_dev *i2c_dev, int reg)
157{
a238dcfa 158 return readw_relaxed(i2c_dev->base + reg);
95a7f10e
VB
159}
160
5ae5b113
C
161static inline void davinci_i2c_reset_ctrl(struct davinci_i2c_dev *i2c_dev,
162 int val)
163{
164 u16 w;
165
166 w = davinci_i2c_read_reg(i2c_dev, DAVINCI_I2C_MDR_REG);
167 if (!val) /* put I2C into reset */
168 w &= ~DAVINCI_I2C_MDR_IRS;
169 else /* take I2C out of reset */
170 w |= DAVINCI_I2C_MDR_IRS;
171
172 davinci_i2c_write_reg(i2c_dev, DAVINCI_I2C_MDR_REG, w);
173}
174
175static void i2c_davinci_calc_clk_dividers(struct davinci_i2c_dev *dev)
95a7f10e 176{
5c3d8a46 177 struct davinci_i2c_platform_data *pdata = dev->pdata;
95a7f10e
VB
178 u16 psc;
179 u32 clk;
cc99ff70 180 u32 d;
95a7f10e
VB
181 u32 clkh;
182 u32 clkl;
183 u32 input_clock = clk_get_rate(dev->clk);
35780e86 184 struct device_node *of_node = dev->dev->of_node;
95a7f10e
VB
185
186 /* NOTE: I2C Clock divider programming info
187 * As per I2C specs the following formulas provide prescaler
188 * and low/high divider values
189 * input clk --> PSC Div -----------> ICCL/H Div --> output clock
190 * module clk
191 *
192 * output clk = module clk / (PSC + 1) [ (ICCL + d) + (ICCH + d) ]
193 *
194 * Thus,
195 * (ICCL + ICCH) = clk = (input clk / ((psc +1) * output clk)) - 2d;
196 *
197 * where if PSC == 0, d = 7,
198 * if PSC == 1, d = 6
199 * if PSC > 1 , d = 5
35780e86
AS
200 *
201 * Note:
202 * d is always 6 on Keystone I2C controller
95a7f10e
VB
203 */
204
87cb5b42
AS
205 /*
206 * Both Davinci and current Keystone User Guides recommend a value
207 * between 7MHz and 12MHz. In reality 7MHz module clock doesn't
208 * always produce enough margin between SDA and SCL transitions.
209 * Measurements show that the higher the module clock is, the
210 * bigger is the margin, providing more reliable communication.
211 * So we better target for 12MHz.
212 */
213 psc = (input_clock / 12000000) - 1;
cc99ff70
TK
214 if ((input_clock / (psc + 1)) > 12000000)
215 psc++; /* better to run under spec than over */
216 d = (psc >= 2) ? 5 : 7 - psc;
95a7f10e 217
35780e86
AS
218 if (of_node && of_device_is_compatible(of_node, "ti,keystone-i2c"))
219 d = 6;
220
955fc950
AS
221 clk = ((input_clock / (psc + 1)) / (pdata->bus_freq * 1000));
222 /* Avoid driving the bus too fast because of rounding errors above */
223 if (input_clock / (psc + 1) / clk > pdata->bus_freq * 1000)
224 clk++;
225 /*
226 * According to I2C-BUS Spec 2.1, in FAST-MODE LOW period should be at
227 * least 1.3uS, which is not the case with 50% duty cycle. Driving HIGH
228 * to LOW ratio as 1 to 2 is more safe.
229 */
230 if (pdata->bus_freq > 100)
231 clkl = (clk << 1) / 3;
232 else
233 clkl = (clk >> 1);
234 /*
235 * It's not always possible to have 1 to 2 ratio when d=7, so fall back
236 * to minimal possible clkh in this case.
237 */
238 if (clk >= clkl + d) {
239 clkh = clk - clkl - d;
240 clkl -= d;
241 } else {
242 clkh = 0;
243 clkl = clk - (d << 1);
244 }
95a7f10e
VB
245
246 davinci_i2c_write_reg(dev, DAVINCI_I2C_PSC_REG, psc);
247 davinci_i2c_write_reg(dev, DAVINCI_I2C_CLKH_REG, clkh);
248 davinci_i2c_write_reg(dev, DAVINCI_I2C_CLKL_REG, clkl);
249
5ae5b113
C
250 dev_dbg(dev->dev, "input_clock = %d, CLK = %d\n", input_clock, clk);
251}
252
253/*
254 * This function configures I2C and brings I2C out of reset.
255 * This function is called during I2C init function. This function
256 * also gets called if I2C encounters any errors.
257 */
258static int i2c_davinci_init(struct davinci_i2c_dev *dev)
259{
5c3d8a46 260 struct davinci_i2c_platform_data *pdata = dev->pdata;
5ae5b113
C
261
262 /* put I2C into reset */
263 davinci_i2c_reset_ctrl(dev, 0);
264
265 /* compute clock dividers */
266 i2c_davinci_calc_clk_dividers(dev);
267
7605fa3b
DB
268 /* Respond at reserved "SMBus Host" slave address" (and zero);
269 * we seem to have no option to not respond...
270 */
41c8d452 271 davinci_i2c_write_reg(dev, DAVINCI_I2C_OAR_REG, DAVINCI_I2C_OWN_ADDRESS);
7605fa3b 272
95a7f10e
VB
273 dev_dbg(dev->dev, "PSC = %d\n",
274 davinci_i2c_read_reg(dev, DAVINCI_I2C_PSC_REG));
275 dev_dbg(dev->dev, "CLKL = %d\n",
276 davinci_i2c_read_reg(dev, DAVINCI_I2C_CLKL_REG));
277 dev_dbg(dev->dev, "CLKH = %d\n",
278 davinci_i2c_read_reg(dev, DAVINCI_I2C_CLKH_REG));
cc99ff70
TK
279 dev_dbg(dev->dev, "bus_freq = %dkHz, bus_delay = %d\n",
280 pdata->bus_freq, pdata->bus_delay);
95a7f10e 281
5c3d8a46 282
95a7f10e 283 /* Take the I2C module out of reset: */
5ae5b113 284 davinci_i2c_reset_ctrl(dev, 1);
95a7f10e
VB
285
286 /* Enable interrupts */
287 davinci_i2c_write_reg(dev, DAVINCI_I2C_IMR_REG, I2C_DAVINCI_INTR_ALL);
288
289 return 0;
290}
291
2e65676f
GS
292/*
293 * This routine does i2c bus recovery by using i2c_generic_gpio_recovery
294 * which is provided by I2C Bus recovery infrastructure.
295 */
296static void davinci_i2c_prepare_recovery(struct i2c_adapter *adap)
297{
298 struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
299
300 /* Disable interrupts */
301 davinci_i2c_write_reg(dev, DAVINCI_I2C_IMR_REG, 0);
302
303 /* put I2C into reset */
304 davinci_i2c_reset_ctrl(dev, 0);
305}
306
307static void davinci_i2c_unprepare_recovery(struct i2c_adapter *adap)
308{
309 struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
310
311 i2c_davinci_init(dev);
312}
313
314static struct i2c_bus_recovery_info davinci_i2c_gpio_recovery_info = {
315 .recover_bus = i2c_generic_gpio_recovery,
316 .prepare_recovery = davinci_i2c_prepare_recovery,
317 .unprepare_recovery = davinci_i2c_unprepare_recovery,
318};
319
7ef97e9a
GS
320static void davinci_i2c_set_scl(struct i2c_adapter *adap, int val)
321{
322 struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
323
324 if (val)
325 davinci_i2c_write_reg(dev, DAVINCI_I2C_DSET_REG,
326 DAVINCI_I2C_DSET_PDSET0);
327 else
328 davinci_i2c_write_reg(dev, DAVINCI_I2C_DCLR_REG,
329 DAVINCI_I2C_DCLR_PDCLR0);
330}
331
332static int davinci_i2c_get_scl(struct i2c_adapter *adap)
333{
334 struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
335 int val;
336
337 /* read the state of SCL */
338 val = davinci_i2c_read_reg(dev, DAVINCI_I2C_DIN_REG);
339 return val & DAVINCI_I2C_DIN_PDIN0;
340}
341
342static int davinci_i2c_get_sda(struct i2c_adapter *adap)
343{
344 struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
345 int val;
346
347 /* read the state of SDA */
348 val = davinci_i2c_read_reg(dev, DAVINCI_I2C_DIN_REG);
349 return val & DAVINCI_I2C_DIN_PDIN1;
350}
351
352static void davinci_i2c_scl_prepare_recovery(struct i2c_adapter *adap)
353{
354 struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
355
356 davinci_i2c_prepare_recovery(adap);
357
358 /* SCL output, SDA input */
359 davinci_i2c_write_reg(dev, DAVINCI_I2C_DIR_REG, DAVINCI_I2C_DIR_PDIR0);
360
361 /* change to GPIO mode */
362 davinci_i2c_write_reg(dev, DAVINCI_I2C_FUNC_REG,
363 DAVINCI_I2C_FUNC_PFUNC0);
364}
365
366static void davinci_i2c_scl_unprepare_recovery(struct i2c_adapter *adap)
367{
368 struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
369
370 /* change back to I2C mode */
371 davinci_i2c_write_reg(dev, DAVINCI_I2C_FUNC_REG, 0);
372
373 davinci_i2c_unprepare_recovery(adap);
374}
375
376static struct i2c_bus_recovery_info davinci_i2c_scl_recovery_info = {
377 .recover_bus = i2c_generic_scl_recovery,
378 .set_scl = davinci_i2c_set_scl,
379 .get_scl = davinci_i2c_get_scl,
380 .get_sda = davinci_i2c_get_sda,
381 .prepare_recovery = davinci_i2c_scl_prepare_recovery,
382 .unprepare_recovery = davinci_i2c_scl_unprepare_recovery,
383};
384
95a7f10e
VB
385/*
386 * Waiting for bus not busy
387 */
72a956c5 388static int i2c_davinci_wait_bus_not_busy(struct davinci_i2c_dev *dev)
95a7f10e 389{
72a956c5
AS
390 unsigned long timeout = jiffies + dev->adapter.timeout;
391
392 do {
393 if (!(davinci_i2c_read_reg(dev, DAVINCI_I2C_STR_REG) & DAVINCI_I2C_STR_BB))
394 return 0;
395 schedule_timeout_uninterruptible(1);
396 } while (time_before_eq(jiffies, timeout));
397
398 dev_warn(dev->dev, "timeout waiting for bus ready\n");
399 i2c_recover_bus(&dev->adapter);
400
401 /*
402 * if bus is still "busy" here, it's most probably a HW problem like
403 * short-circuit
404 */
405 if (davinci_i2c_read_reg(dev, DAVINCI_I2C_STR_REG) & DAVINCI_I2C_STR_BB)
406 return -EIO;
95a7f10e
VB
407
408 return 0;
409}
410
411/*
412 * Low level master read/write transaction. This function is called
413 * from i2c_davinci_xfer.
414 */
415static int
416i2c_davinci_xfer_msg(struct i2c_adapter *adap, struct i2c_msg *msg, int stop)
417{
418 struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
5c3d8a46 419 struct davinci_i2c_platform_data *pdata = dev->pdata;
95a7f10e 420 u32 flag;
95a7f10e 421 u16 w;
d9e1f441 422 unsigned long time_left;
95a7f10e 423
41c8d452
AS
424 if (msg->addr == DAVINCI_I2C_OWN_ADDRESS) {
425 dev_warn(dev->dev, "transfer to own address aborted\n");
426 return -EADDRNOTAVAIL;
427 }
428
95a7f10e
VB
429 /* Introduce a delay, required for some boards (e.g Davinci EVM) */
430 if (pdata->bus_delay)
431 udelay(pdata->bus_delay);
432
433 /* set the slave address */
434 davinci_i2c_write_reg(dev, DAVINCI_I2C_SAR_REG, msg->addr);
435
436 dev->buf = msg->buf;
437 dev->buf_len = msg->len;
c6c7c729 438 dev->stop = stop;
95a7f10e
VB
439
440 davinci_i2c_write_reg(dev, DAVINCI_I2C_CNT_REG, dev->buf_len);
441
16735d02 442 reinit_completion(&dev->cmd_complete);
95a7f10e
VB
443 dev->cmd_err = 0;
444
c5b4afec
JP
445 /* Take I2C out of reset and configure it as master */
446 flag = DAVINCI_I2C_MDR_IRS | DAVINCI_I2C_MDR_MST;
95a7f10e
VB
447
448 /* if the slave address is ten bit address, enable XA bit */
449 if (msg->flags & I2C_M_TEN)
450 flag |= DAVINCI_I2C_MDR_XA;
451 if (!(msg->flags & I2C_M_RD))
452 flag |= DAVINCI_I2C_MDR_TRX;
c5b4afec 453 if (msg->len == 0)
c6c7c729 454 flag |= DAVINCI_I2C_MDR_RM;
95a7f10e
VB
455
456 /* Enable receive or transmit interrupts */
457 w = davinci_i2c_read_reg(dev, DAVINCI_I2C_IMR_REG);
458 if (msg->flags & I2C_M_RD)
c062a251 459 w |= DAVINCI_I2C_IMR_RRDY;
95a7f10e 460 else
c062a251 461 w |= DAVINCI_I2C_IMR_XRDY;
95a7f10e
VB
462 davinci_i2c_write_reg(dev, DAVINCI_I2C_IMR_REG, w);
463
5a0d5f5f 464 dev->terminate = 0;
c6c7c729 465
c5b4afec
JP
466 /*
467 * Write mode register first as needed for correct behaviour
468 * on OMAP-L138, but don't set STT yet to avoid a race with XRDY
25985edc 469 * occurring before we have loaded DXR
c5b4afec
JP
470 */
471 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, flag);
472
c6c7c729
DB
473 /*
474 * First byte should be set here, not after interrupt,
475 * because transmit-data-ready interrupt can come before
476 * NACK-interrupt during sending of previous message and
477 * ICDXR may have wrong data
c5b4afec 478 * It also saves us one interrupt, slightly faster
c6c7c729
DB
479 */
480 if ((!(msg->flags & I2C_M_RD)) && dev->buf_len) {
481 davinci_i2c_write_reg(dev, DAVINCI_I2C_DXR_REG, *dev->buf++);
482 dev->buf_len--;
483 }
484
c5b4afec
JP
485 /* Set STT to begin transmit now DXR is loaded */
486 flag |= DAVINCI_I2C_MDR_STT;
487 if (stop && msg->len != 0)
488 flag |= DAVINCI_I2C_MDR_STP;
4bba0fd8
JP
489 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, flag);
490
d9e1f441
NMG
491 time_left = wait_for_completion_timeout(&dev->cmd_complete,
492 dev->adapter.timeout);
493 if (!time_left) {
95a7f10e 494 dev_err(dev->dev, "controller timed out\n");
2e65676f 495 i2c_recover_bus(adap);
5a0d5f5f 496 dev->buf_len = 0;
95a7f10e
VB
497 return -ETIMEDOUT;
498 }
5a0d5f5f
TK
499 if (dev->buf_len) {
500 /* This should be 0 if all bytes were transferred
501 * or dev->cmd_err denotes an error.
5a0d5f5f 502 */
d9e1f441
NMG
503 dev_err(dev->dev, "abnormal termination buf_len=%i\n",
504 dev->buf_len);
5a0d5f5f
TK
505 dev->terminate = 1;
506 wmb();
507 dev->buf_len = 0;
d9e1f441 508 return -EREMOTEIO;
5a0d5f5f 509 }
95a7f10e
VB
510
511 /* no error */
512 if (likely(!dev->cmd_err))
513 return msg->len;
514
515 /* We have an error */
516 if (dev->cmd_err & DAVINCI_I2C_STR_AL) {
517 i2c_davinci_init(dev);
518 return -EIO;
519 }
520
521 if (dev->cmd_err & DAVINCI_I2C_STR_NACK) {
522 if (msg->flags & I2C_M_IGNORE_NAK)
523 return msg->len;
9ea359f7
GS
524 w = davinci_i2c_read_reg(dev, DAVINCI_I2C_MDR_REG);
525 w |= DAVINCI_I2C_MDR_STP;
526 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, w);
95a7f10e
VB
527 return -EREMOTEIO;
528 }
529 return -EIO;
530}
531
532/*
533 * Prepare controller for a transaction and call i2c_davinci_xfer_msg
534 */
535static int
536i2c_davinci_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
537{
538 struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
539 int i;
540 int ret;
541
08882d20 542 dev_dbg(dev->dev, "%s: msgs: %d\n", __func__, num);
95a7f10e 543
72a956c5 544 ret = i2c_davinci_wait_bus_not_busy(dev);
95a7f10e
VB
545 if (ret < 0) {
546 dev_warn(dev->dev, "timeout waiting for bus ready\n");
547 return ret;
548 }
549
550 for (i = 0; i < num; i++) {
551 ret = i2c_davinci_xfer_msg(adap, &msgs[i], (i == (num - 1)));
d868caa1
TK
552 dev_dbg(dev->dev, "%s [%d/%d] ret: %d\n", __func__, i + 1, num,
553 ret);
95a7f10e
VB
554 if (ret < 0)
555 return ret;
556 }
82c0de11
C
557
558#ifdef CONFIG_CPU_FREQ
559 complete(&dev->xfr_complete);
560#endif
561
95a7f10e
VB
562 return num;
563}
564
565static u32 i2c_davinci_func(struct i2c_adapter *adap)
566{
c6c7c729 567 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
95a7f10e
VB
568}
569
5a0d5f5f
TK
570static void terminate_read(struct davinci_i2c_dev *dev)
571{
572 u16 w = davinci_i2c_read_reg(dev, DAVINCI_I2C_MDR_REG);
573 w |= DAVINCI_I2C_MDR_NACK;
574 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, w);
575
576 /* Throw away data */
577 davinci_i2c_read_reg(dev, DAVINCI_I2C_DRR_REG);
578 if (!dev->terminate)
579 dev_err(dev->dev, "RDR IRQ while no data requested\n");
580}
581static void terminate_write(struct davinci_i2c_dev *dev)
582{
583 u16 w = davinci_i2c_read_reg(dev, DAVINCI_I2C_MDR_REG);
584 w |= DAVINCI_I2C_MDR_RM | DAVINCI_I2C_MDR_STP;
585 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, w);
586
587 if (!dev->terminate)
7605fa3b 588 dev_dbg(dev->dev, "TDR IRQ while no data to send\n");
5a0d5f5f
TK
589}
590
95a7f10e
VB
591/*
592 * Interrupt service routine. This gets called whenever an I2C interrupt
593 * occurs.
594 */
595static irqreturn_t i2c_davinci_isr(int this_irq, void *dev_id)
596{
597 struct davinci_i2c_dev *dev = dev_id;
598 u32 stat;
599 int count = 0;
600 u16 w;
601
602 while ((stat = davinci_i2c_read_reg(dev, DAVINCI_I2C_IVR_REG))) {
08882d20 603 dev_dbg(dev->dev, "%s: stat=0x%x\n", __func__, stat);
95a7f10e
VB
604 if (count++ == 100) {
605 dev_warn(dev->dev, "Too much work in one IRQ\n");
606 break;
607 }
608
609 switch (stat) {
610 case DAVINCI_I2C_IVR_AL:
5a0d5f5f 611 /* Arbitration lost, must retry */
95a7f10e 612 dev->cmd_err |= DAVINCI_I2C_STR_AL;
5a0d5f5f 613 dev->buf_len = 0;
95a7f10e
VB
614 complete(&dev->cmd_complete);
615 break;
616
617 case DAVINCI_I2C_IVR_NACK:
618 dev->cmd_err |= DAVINCI_I2C_STR_NACK;
5a0d5f5f 619 dev->buf_len = 0;
95a7f10e
VB
620 complete(&dev->cmd_complete);
621 break;
622
623 case DAVINCI_I2C_IVR_ARDY:
b73a9aec
TK
624 davinci_i2c_write_reg(dev,
625 DAVINCI_I2C_STR_REG, DAVINCI_I2C_STR_ARDY);
c6c7c729
DB
626 if (((dev->buf_len == 0) && (dev->stop != 0)) ||
627 (dev->cmd_err & DAVINCI_I2C_STR_NACK)) {
628 w = davinci_i2c_read_reg(dev,
629 DAVINCI_I2C_MDR_REG);
630 w |= DAVINCI_I2C_MDR_STP;
631 davinci_i2c_write_reg(dev,
632 DAVINCI_I2C_MDR_REG, w);
633 }
95a7f10e
VB
634 complete(&dev->cmd_complete);
635 break;
636
637 case DAVINCI_I2C_IVR_RDR:
638 if (dev->buf_len) {
639 *dev->buf++ =
640 davinci_i2c_read_reg(dev,
641 DAVINCI_I2C_DRR_REG);
642 dev->buf_len--;
643 if (dev->buf_len)
644 continue;
645
95a7f10e 646 davinci_i2c_write_reg(dev,
b73a9aec
TK
647 DAVINCI_I2C_STR_REG,
648 DAVINCI_I2C_IMR_RRDY);
5a0d5f5f
TK
649 } else {
650 /* signal can terminate transfer */
651 terminate_read(dev);
652 }
95a7f10e
VB
653 break;
654
655 case DAVINCI_I2C_IVR_XRDY:
656 if (dev->buf_len) {
657 davinci_i2c_write_reg(dev, DAVINCI_I2C_DXR_REG,
658 *dev->buf++);
659 dev->buf_len--;
660 if (dev->buf_len)
661 continue;
662
663 w = davinci_i2c_read_reg(dev,
664 DAVINCI_I2C_IMR_REG);
c062a251 665 w &= ~DAVINCI_I2C_IMR_XRDY;
95a7f10e
VB
666 davinci_i2c_write_reg(dev,
667 DAVINCI_I2C_IMR_REG,
668 w);
5a0d5f5f
TK
669 } else {
670 /* signal can terminate transfer */
671 terminate_write(dev);
672 }
95a7f10e
VB
673 break;
674
675 case DAVINCI_I2C_IVR_SCD:
b73a9aec
TK
676 davinci_i2c_write_reg(dev,
677 DAVINCI_I2C_STR_REG, DAVINCI_I2C_STR_SCD);
95a7f10e
VB
678 complete(&dev->cmd_complete);
679 break;
680
681 case DAVINCI_I2C_IVR_AAS:
7605fa3b
DB
682 dev_dbg(dev->dev, "Address as slave interrupt\n");
683 break;
684
685 default:
686 dev_warn(dev->dev, "Unrecognized irq stat %d\n", stat);
687 break;
688 }
689 }
95a7f10e
VB
690
691 return count ? IRQ_HANDLED : IRQ_NONE;
692}
693
82c0de11
C
694#ifdef CONFIG_CPU_FREQ
695static int i2c_davinci_cpufreq_transition(struct notifier_block *nb,
696 unsigned long val, void *data)
697{
698 struct davinci_i2c_dev *dev;
699
700 dev = container_of(nb, struct davinci_i2c_dev, freq_transition);
701 if (val == CPUFREQ_PRECHANGE) {
702 wait_for_completion(&dev->xfr_complete);
703 davinci_i2c_reset_ctrl(dev, 0);
704 } else if (val == CPUFREQ_POSTCHANGE) {
705 i2c_davinci_calc_clk_dividers(dev);
706 davinci_i2c_reset_ctrl(dev, 1);
707 }
708
709 return 0;
710}
711
712static inline int i2c_davinci_cpufreq_register(struct davinci_i2c_dev *dev)
713{
714 dev->freq_transition.notifier_call = i2c_davinci_cpufreq_transition;
715
716 return cpufreq_register_notifier(&dev->freq_transition,
717 CPUFREQ_TRANSITION_NOTIFIER);
718}
719
720static inline void i2c_davinci_cpufreq_deregister(struct davinci_i2c_dev *dev)
721{
722 cpufreq_unregister_notifier(&dev->freq_transition,
723 CPUFREQ_TRANSITION_NOTIFIER);
724}
725#else
726static inline int i2c_davinci_cpufreq_register(struct davinci_i2c_dev *dev)
727{
728 return 0;
729}
730
731static inline void i2c_davinci_cpufreq_deregister(struct davinci_i2c_dev *dev)
732{
733}
734#endif
735
95a7f10e
VB
736static struct i2c_algorithm i2c_davinci_algo = {
737 .master_xfer = i2c_davinci_xfer,
738 .functionality = i2c_davinci_func,
739};
740
5c3d8a46
HS
741static const struct of_device_id davinci_i2c_of_match[] = {
742 {.compatible = "ti,davinci-i2c", },
35780e86 743 {.compatible = "ti,keystone-i2c", },
5c3d8a46
HS
744 {},
745};
746MODULE_DEVICE_TABLE(of, davinci_i2c_of_match);
747
95a7f10e
VB
748static int davinci_i2c_probe(struct platform_device *pdev)
749{
750 struct davinci_i2c_dev *dev;
751 struct i2c_adapter *adap;
2c6ef04f
GS
752 struct resource *mem;
753 int r, irq;
754
755 irq = platform_get_irq(pdev, 0);
756 if (irq <= 0) {
757 if (!irq)
758 irq = -ENXIO;
759 if (irq != -EPROBE_DEFER)
760 dev_err(&pdev->dev,
761 "can't get irq resource ret=%d\n", irq);
762 return irq;
95a7f10e
VB
763 }
764
85796843
VBM
765 dev = devm_kzalloc(&pdev->dev, sizeof(struct davinci_i2c_dev),
766 GFP_KERNEL);
95a7f10e 767 if (!dev) {
85796843
VBM
768 dev_err(&pdev->dev, "Memory allocation failed\n");
769 return -ENOMEM;
95a7f10e
VB
770 }
771
2e743787 772 init_completion(&dev->cmd_complete);
82c0de11
C
773#ifdef CONFIG_CPU_FREQ
774 init_completion(&dev->xfr_complete);
775#endif
c4df5000 776 dev->dev = &pdev->dev;
2c6ef04f 777 dev->irq = irq;
1e2c2390 778 dev->pdata = dev_get_platdata(&pdev->dev);
95a7f10e
VB
779 platform_set_drvdata(pdev, dev);
780
5c3d8a46
HS
781 if (!dev->pdata && pdev->dev.of_node) {
782 u32 prop;
783
784 dev->pdata = devm_kzalloc(&pdev->dev,
785 sizeof(struct davinci_i2c_platform_data), GFP_KERNEL);
c4df5000
WS
786 if (!dev->pdata)
787 return -ENOMEM;
788
5c3d8a46
HS
789 memcpy(dev->pdata, &davinci_i2c_platform_data_default,
790 sizeof(struct davinci_i2c_platform_data));
791 if (!of_property_read_u32(pdev->dev.of_node, "clock-frequency",
792 &prop))
793 dev->pdata->bus_freq = prop / 1000;
7ef97e9a
GS
794
795 dev->pdata->has_pfunc =
796 of_property_read_bool(pdev->dev.of_node,
797 "ti,has-pfunc");
5c3d8a46
HS
798 } else if (!dev->pdata) {
799 dev->pdata = &davinci_i2c_platform_data_default;
800 }
801
85796843 802 dev->clk = devm_clk_get(&pdev->dev, NULL);
c4df5000
WS
803 if (IS_ERR(dev->clk))
804 return -ENODEV;
2bdbfa9c 805 clk_prepare_enable(dev->clk);
95a7f10e 806
3cc2d009 807 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
85796843
VBM
808 dev->base = devm_ioremap_resource(&pdev->dev, mem);
809 if (IS_ERR(dev->base)) {
810 r = PTR_ERR(dev->base);
811 goto err_unuse_clocks;
c062a251
C
812 }
813
95a7f10e
VB
814 i2c_davinci_init(dev);
815
85796843
VBM
816 r = devm_request_irq(&pdev->dev, dev->irq, i2c_davinci_isr, 0,
817 pdev->name, dev);
95a7f10e
VB
818 if (r) {
819 dev_err(&pdev->dev, "failure requesting irq %i\n", dev->irq);
820 goto err_unuse_clocks;
821 }
822
82c0de11
C
823 r = i2c_davinci_cpufreq_register(dev);
824 if (r) {
825 dev_err(&pdev->dev, "failed to register cpufreq\n");
85796843 826 goto err_unuse_clocks;
82c0de11
C
827 }
828
95a7f10e
VB
829 adap = &dev->adapter;
830 i2c_set_adapdata(adap, dev);
831 adap->owner = THIS_MODULE;
adcb82a9 832 adap->class = I2C_CLASS_DEPRECATED;
95a7f10e
VB
833 strlcpy(adap->name, "DaVinci I2C adapter", sizeof(adap->name));
834 adap->algo = &i2c_davinci_algo;
835 adap->dev.parent = &pdev->dev;
98a679ca 836 adap->timeout = DAVINCI_I2C_TIMEOUT;
5c3d8a46 837 adap->dev.of_node = pdev->dev.of_node;
95a7f10e 838
7ef97e9a
GS
839 if (dev->pdata->has_pfunc)
840 adap->bus_recovery_info = &davinci_i2c_scl_recovery_info;
841 else if (dev->pdata->scl_pin) {
2e65676f
GS
842 adap->bus_recovery_info = &davinci_i2c_gpio_recovery_info;
843 adap->bus_recovery_info->scl_gpio = dev->pdata->scl_pin;
844 adap->bus_recovery_info->sda_gpio = dev->pdata->sda_pin;
845 }
846
95a7f10e
VB
847 adap->nr = pdev->id;
848 r = i2c_add_numbered_adapter(adap);
849 if (r) {
850 dev_err(&pdev->dev, "failure adding adapter\n");
85796843 851 goto err_unuse_clocks;
95a7f10e
VB
852 }
853
854 return 0;
855
95a7f10e 856err_unuse_clocks:
2bdbfa9c 857 clk_disable_unprepare(dev->clk);
95a7f10e 858 dev->clk = NULL;
95a7f10e
VB
859 return r;
860}
861
862static int davinci_i2c_remove(struct platform_device *pdev)
863{
864 struct davinci_i2c_dev *dev = platform_get_drvdata(pdev);
95a7f10e 865
82c0de11
C
866 i2c_davinci_cpufreq_deregister(dev);
867
95a7f10e 868 i2c_del_adapter(&dev->adapter);
95a7f10e 869
2bdbfa9c 870 clk_disable_unprepare(dev->clk);
95a7f10e
VB
871 dev->clk = NULL;
872
873 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, 0);
95a7f10e 874
95a7f10e
VB
875 return 0;
876}
877
68f15de9
C
878#ifdef CONFIG_PM
879static int davinci_i2c_suspend(struct device *dev)
880{
881 struct platform_device *pdev = to_platform_device(dev);
882 struct davinci_i2c_dev *i2c_dev = platform_get_drvdata(pdev);
883
884 /* put I2C into reset */
885 davinci_i2c_reset_ctrl(i2c_dev, 0);
2bdbfa9c 886 clk_disable_unprepare(i2c_dev->clk);
68f15de9
C
887
888 return 0;
889}
890
891static int davinci_i2c_resume(struct device *dev)
892{
893 struct platform_device *pdev = to_platform_device(dev);
894 struct davinci_i2c_dev *i2c_dev = platform_get_drvdata(pdev);
895
2bdbfa9c 896 clk_prepare_enable(i2c_dev->clk);
68f15de9
C
897 /* take I2C out of reset */
898 davinci_i2c_reset_ctrl(i2c_dev, 1);
899
900 return 0;
901}
902
903static const struct dev_pm_ops davinci_i2c_pm = {
904 .suspend = davinci_i2c_suspend,
905 .resume = davinci_i2c_resume,
906};
907
908#define davinci_i2c_pm_ops (&davinci_i2c_pm)
909#else
910#define davinci_i2c_pm_ops NULL
911#endif
912
add8eda7
KS
913/* work with hotplug and coldplug */
914MODULE_ALIAS("platform:i2c_davinci");
915
95a7f10e
VB
916static struct platform_driver davinci_i2c_driver = {
917 .probe = davinci_i2c_probe,
918 .remove = davinci_i2c_remove,
919 .driver = {
920 .name = "i2c_davinci",
68f15de9 921 .pm = davinci_i2c_pm_ops,
4e905323 922 .of_match_table = davinci_i2c_of_match,
95a7f10e
VB
923 },
924};
925
926/* I2C may be needed to bring up other drivers */
927static int __init davinci_i2c_init_driver(void)
928{
929 return platform_driver_register(&davinci_i2c_driver);
930}
931subsys_initcall(davinci_i2c_init_driver);
932
933static void __exit davinci_i2c_exit_driver(void)
934{
935 platform_driver_unregister(&davinci_i2c_driver);
936}
937module_exit(davinci_i2c_exit_driver);
938
939MODULE_AUTHOR("Texas Instruments India");
940MODULE_DESCRIPTION("TI DaVinci I2C bus adapter");
941MODULE_LICENSE("GPL");