blob: 85ce548ff1526672fe383c663e97a75814704ce7 [file] [log] [blame]
Vladimir Barinov95a7f102007-10-13 23:56:30 +02001/*
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.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 * ----------------------------------------------------------------------------
25 *
26 */
27#include <linux/kernel.h>
28#include <linux/module.h>
29#include <linux/delay.h>
30#include <linux/i2c.h>
31#include <linux/clk.h>
32#include <linux/errno.h>
33#include <linux/sched.h>
34#include <linux/err.h>
35#include <linux/interrupt.h>
36#include <linux/platform_device.h>
37#include <linux/io.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090038#include <linux/slab.h>
Chaithrika U S82c0de12010-01-06 14:55:00 +053039#include <linux/cpufreq.h>
Philby John8574faf2010-01-11 22:39:44 +053040#include <linux/gpio.h>
Heiko Schocher5c3d8a42012-07-30 07:21:12 +000041#include <linux/of_i2c.h>
42#include <linux/of_device.h>
Vladimir Barinov95a7f102007-10-13 23:56:30 +020043
Russell Kinga09e64f2008-08-05 16:14:15 +010044#include <mach/hardware.h>
Russell Kinga09e64f2008-08-05 16:14:15 +010045#include <mach/i2c.h>
Vladimir Barinov95a7f102007-10-13 23:56:30 +020046
47/* ----- global defines ----------------------------------------------- */
48
49#define DAVINCI_I2C_TIMEOUT (1*HZ)
Philby John8574faf2010-01-11 22:39:44 +053050#define DAVINCI_I2C_MAX_TRIES 2
Vladimir Barinov95a7f102007-10-13 23:56:30 +020051#define I2C_DAVINCI_INTR_ALL (DAVINCI_I2C_IMR_AAS | \
52 DAVINCI_I2C_IMR_SCD | \
53 DAVINCI_I2C_IMR_ARDY | \
54 DAVINCI_I2C_IMR_NACK | \
55 DAVINCI_I2C_IMR_AL)
56
57#define DAVINCI_I2C_OAR_REG 0x00
58#define DAVINCI_I2C_IMR_REG 0x04
59#define DAVINCI_I2C_STR_REG 0x08
60#define DAVINCI_I2C_CLKL_REG 0x0c
61#define DAVINCI_I2C_CLKH_REG 0x10
62#define DAVINCI_I2C_CNT_REG 0x14
63#define DAVINCI_I2C_DRR_REG 0x18
64#define DAVINCI_I2C_SAR_REG 0x1c
65#define DAVINCI_I2C_DXR_REG 0x20
66#define DAVINCI_I2C_MDR_REG 0x24
67#define DAVINCI_I2C_IVR_REG 0x28
68#define DAVINCI_I2C_EMDR_REG 0x2c
69#define DAVINCI_I2C_PSC_REG 0x30
70
71#define DAVINCI_I2C_IVR_AAS 0x07
72#define DAVINCI_I2C_IVR_SCD 0x06
73#define DAVINCI_I2C_IVR_XRDY 0x05
74#define DAVINCI_I2C_IVR_RDR 0x04
75#define DAVINCI_I2C_IVR_ARDY 0x03
76#define DAVINCI_I2C_IVR_NACK 0x02
77#define DAVINCI_I2C_IVR_AL 0x01
78
Chaithrika U Sc062a252010-01-06 14:54:57 +053079#define DAVINCI_I2C_STR_BB BIT(12)
80#define DAVINCI_I2C_STR_RSFULL BIT(11)
81#define DAVINCI_I2C_STR_SCD BIT(5)
82#define DAVINCI_I2C_STR_ARDY BIT(2)
83#define DAVINCI_I2C_STR_NACK BIT(1)
84#define DAVINCI_I2C_STR_AL BIT(0)
Vladimir Barinov95a7f102007-10-13 23:56:30 +020085
Chaithrika U Sc062a252010-01-06 14:54:57 +053086#define DAVINCI_I2C_MDR_NACK BIT(15)
87#define DAVINCI_I2C_MDR_STT BIT(13)
88#define DAVINCI_I2C_MDR_STP BIT(11)
89#define DAVINCI_I2C_MDR_MST BIT(10)
90#define DAVINCI_I2C_MDR_TRX BIT(9)
91#define DAVINCI_I2C_MDR_XA BIT(8)
92#define DAVINCI_I2C_MDR_RM BIT(7)
93#define DAVINCI_I2C_MDR_IRS BIT(5)
Vladimir Barinov95a7f102007-10-13 23:56:30 +020094
Chaithrika U Sc062a252010-01-06 14:54:57 +053095#define DAVINCI_I2C_IMR_AAS BIT(6)
96#define DAVINCI_I2C_IMR_SCD BIT(5)
97#define DAVINCI_I2C_IMR_XRDY BIT(4)
98#define DAVINCI_I2C_IMR_RRDY BIT(3)
99#define DAVINCI_I2C_IMR_ARDY BIT(2)
100#define DAVINCI_I2C_IMR_NACK BIT(1)
101#define DAVINCI_I2C_IMR_AL BIT(0)
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200102
103struct davinci_i2c_dev {
104 struct device *dev;
105 void __iomem *base;
106 struct completion cmd_complete;
107 struct clk *clk;
108 int cmd_err;
109 u8 *buf;
110 size_t buf_len;
111 int irq;
Dirk Behmec6c7c722008-03-28 06:16:12 +0100112 int stop;
Troy Kisky5a0d5f52008-07-14 22:38:21 +0200113 u8 terminate;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200114 struct i2c_adapter adapter;
Chaithrika U S82c0de12010-01-06 14:55:00 +0530115#ifdef CONFIG_CPU_FREQ
116 struct completion xfr_complete;
117 struct notifier_block freq_transition;
118#endif
Heiko Schocher5c3d8a42012-07-30 07:21:12 +0000119 struct davinci_i2c_platform_data *pdata;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200120};
121
122/* default platform data to use if not supplied in the platform_device */
123static struct davinci_i2c_platform_data davinci_i2c_platform_data_default = {
124 .bus_freq = 100,
125 .bus_delay = 0,
126};
127
128static inline void davinci_i2c_write_reg(struct davinci_i2c_dev *i2c_dev,
129 int reg, u16 val)
130{
131 __raw_writew(val, i2c_dev->base + reg);
132}
133
134static inline u16 davinci_i2c_read_reg(struct davinci_i2c_dev *i2c_dev, int reg)
135{
136 return __raw_readw(i2c_dev->base + reg);
137}
138
Philby John8574faf2010-01-11 22:39:44 +0530139/* Generate a pulse on the i2c clock pin. */
140static void generic_i2c_clock_pulse(unsigned int scl_pin)
141{
142 u16 i;
143
144 if (scl_pin) {
145 /* Send high and low on the SCL line */
146 for (i = 0; i < 9; i++) {
147 gpio_set_value(scl_pin, 0);
148 udelay(20);
149 gpio_set_value(scl_pin, 1);
150 udelay(20);
151 }
152 }
153}
154
155/* This routine does i2c bus recovery as specified in the
156 * i2c protocol Rev. 03 section 3.16 titled "Bus clear"
157 */
158static void i2c_recover_bus(struct davinci_i2c_dev *dev)
159{
160 u32 flag = 0;
Heiko Schocher5c3d8a42012-07-30 07:21:12 +0000161 struct davinci_i2c_platform_data *pdata = dev->pdata;
Philby John8574faf2010-01-11 22:39:44 +0530162
163 dev_err(dev->dev, "initiating i2c bus recovery\n");
164 /* Send NACK to the slave */
165 flag = davinci_i2c_read_reg(dev, DAVINCI_I2C_MDR_REG);
166 flag |= DAVINCI_I2C_MDR_NACK;
167 /* write the data into mode register */
168 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, flag);
Heiko Schocher5c3d8a42012-07-30 07:21:12 +0000169 generic_i2c_clock_pulse(pdata->scl_pin);
Philby John8574faf2010-01-11 22:39:44 +0530170 /* Send STOP */
171 flag = davinci_i2c_read_reg(dev, DAVINCI_I2C_MDR_REG);
172 flag |= DAVINCI_I2C_MDR_STP;
173 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, flag);
174}
175
Chaithrika U S5ae5b112010-01-06 14:54:58 +0530176static inline void davinci_i2c_reset_ctrl(struct davinci_i2c_dev *i2c_dev,
177 int val)
178{
179 u16 w;
180
181 w = davinci_i2c_read_reg(i2c_dev, DAVINCI_I2C_MDR_REG);
182 if (!val) /* put I2C into reset */
183 w &= ~DAVINCI_I2C_MDR_IRS;
184 else /* take I2C out of reset */
185 w |= DAVINCI_I2C_MDR_IRS;
186
187 davinci_i2c_write_reg(i2c_dev, DAVINCI_I2C_MDR_REG, w);
188}
189
190static void i2c_davinci_calc_clk_dividers(struct davinci_i2c_dev *dev)
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200191{
Heiko Schocher5c3d8a42012-07-30 07:21:12 +0000192 struct davinci_i2c_platform_data *pdata = dev->pdata;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200193 u16 psc;
194 u32 clk;
Troy Kiskycc99ff72008-07-14 22:38:20 +0200195 u32 d;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200196 u32 clkh;
197 u32 clkl;
198 u32 input_clock = clk_get_rate(dev->clk);
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200199
200 /* NOTE: I2C Clock divider programming info
201 * As per I2C specs the following formulas provide prescaler
202 * and low/high divider values
203 * input clk --> PSC Div -----------> ICCL/H Div --> output clock
204 * module clk
205 *
206 * output clk = module clk / (PSC + 1) [ (ICCL + d) + (ICCH + d) ]
207 *
208 * Thus,
209 * (ICCL + ICCH) = clk = (input clk / ((psc +1) * output clk)) - 2d;
210 *
211 * where if PSC == 0, d = 7,
212 * if PSC == 1, d = 6
213 * if PSC > 1 , d = 5
214 */
215
Troy Kiskycc99ff72008-07-14 22:38:20 +0200216 /* get minimum of 7 MHz clock, but max of 12 MHz */
217 psc = (input_clock / 7000000) - 1;
218 if ((input_clock / (psc + 1)) > 12000000)
219 psc++; /* better to run under spec than over */
220 d = (psc >= 2) ? 5 : 7 - psc;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200221
Troy Kiskycc99ff72008-07-14 22:38:20 +0200222 clk = ((input_clock / (psc + 1)) / (pdata->bus_freq * 1000)) - (d << 1);
223 clkh = clk >> 1;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200224 clkl = clk - clkh;
225
226 davinci_i2c_write_reg(dev, DAVINCI_I2C_PSC_REG, psc);
227 davinci_i2c_write_reg(dev, DAVINCI_I2C_CLKH_REG, clkh);
228 davinci_i2c_write_reg(dev, DAVINCI_I2C_CLKL_REG, clkl);
229
Chaithrika U S5ae5b112010-01-06 14:54:58 +0530230 dev_dbg(dev->dev, "input_clock = %d, CLK = %d\n", input_clock, clk);
231}
232
233/*
234 * This function configures I2C and brings I2C out of reset.
235 * This function is called during I2C init function. This function
236 * also gets called if I2C encounters any errors.
237 */
238static int i2c_davinci_init(struct davinci_i2c_dev *dev)
239{
Heiko Schocher5c3d8a42012-07-30 07:21:12 +0000240 struct davinci_i2c_platform_data *pdata = dev->pdata;
Chaithrika U S5ae5b112010-01-06 14:54:58 +0530241
242 /* put I2C into reset */
243 davinci_i2c_reset_ctrl(dev, 0);
244
245 /* compute clock dividers */
246 i2c_davinci_calc_clk_dividers(dev);
247
David Brownell7605fa32009-07-06 15:48:36 -0700248 /* Respond at reserved "SMBus Host" slave address" (and zero);
249 * we seem to have no option to not respond...
250 */
251 davinci_i2c_write_reg(dev, DAVINCI_I2C_OAR_REG, 0x08);
252
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200253 dev_dbg(dev->dev, "PSC = %d\n",
254 davinci_i2c_read_reg(dev, DAVINCI_I2C_PSC_REG));
255 dev_dbg(dev->dev, "CLKL = %d\n",
256 davinci_i2c_read_reg(dev, DAVINCI_I2C_CLKL_REG));
257 dev_dbg(dev->dev, "CLKH = %d\n",
258 davinci_i2c_read_reg(dev, DAVINCI_I2C_CLKH_REG));
Troy Kiskycc99ff72008-07-14 22:38:20 +0200259 dev_dbg(dev->dev, "bus_freq = %dkHz, bus_delay = %d\n",
260 pdata->bus_freq, pdata->bus_delay);
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200261
Heiko Schocher5c3d8a42012-07-30 07:21:12 +0000262
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200263 /* Take the I2C module out of reset: */
Chaithrika U S5ae5b112010-01-06 14:54:58 +0530264 davinci_i2c_reset_ctrl(dev, 1);
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200265
266 /* Enable interrupts */
267 davinci_i2c_write_reg(dev, DAVINCI_I2C_IMR_REG, I2C_DAVINCI_INTR_ALL);
268
269 return 0;
270}
271
272/*
273 * Waiting for bus not busy
274 */
275static int i2c_davinci_wait_bus_not_busy(struct davinci_i2c_dev *dev,
276 char allow_sleep)
277{
278 unsigned long timeout;
Philby John8574faf2010-01-11 22:39:44 +0530279 static u16 to_cnt;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200280
Jean Delvare98a679c2009-03-28 21:34:43 +0100281 timeout = jiffies + dev->adapter.timeout;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200282 while (davinci_i2c_read_reg(dev, DAVINCI_I2C_STR_REG)
283 & DAVINCI_I2C_STR_BB) {
Philby John8574faf2010-01-11 22:39:44 +0530284 if (to_cnt <= DAVINCI_I2C_MAX_TRIES) {
285 if (time_after(jiffies, timeout)) {
286 dev_warn(dev->dev,
287 "timeout waiting for bus ready\n");
288 to_cnt++;
289 return -ETIMEDOUT;
290 } else {
291 to_cnt = 0;
292 i2c_recover_bus(dev);
293 i2c_davinci_init(dev);
294 }
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200295 }
296 if (allow_sleep)
297 schedule_timeout(1);
298 }
299
300 return 0;
301}
302
303/*
304 * Low level master read/write transaction. This function is called
305 * from i2c_davinci_xfer.
306 */
307static int
308i2c_davinci_xfer_msg(struct i2c_adapter *adap, struct i2c_msg *msg, int stop)
309{
310 struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
Heiko Schocher5c3d8a42012-07-30 07:21:12 +0000311 struct davinci_i2c_platform_data *pdata = dev->pdata;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200312 u32 flag;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200313 u16 w;
314 int r;
315
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200316 /* Introduce a delay, required for some boards (e.g Davinci EVM) */
317 if (pdata->bus_delay)
318 udelay(pdata->bus_delay);
319
320 /* set the slave address */
321 davinci_i2c_write_reg(dev, DAVINCI_I2C_SAR_REG, msg->addr);
322
323 dev->buf = msg->buf;
324 dev->buf_len = msg->len;
Dirk Behmec6c7c722008-03-28 06:16:12 +0100325 dev->stop = stop;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200326
327 davinci_i2c_write_reg(dev, DAVINCI_I2C_CNT_REG, dev->buf_len);
328
Troy Kisky2e743782008-07-14 22:38:21 +0200329 INIT_COMPLETION(dev->cmd_complete);
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200330 dev->cmd_err = 0;
331
Jon Poveyc5b4afe2010-10-12 13:47:05 +0900332 /* Take I2C out of reset and configure it as master */
333 flag = DAVINCI_I2C_MDR_IRS | DAVINCI_I2C_MDR_MST;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200334
335 /* if the slave address is ten bit address, enable XA bit */
336 if (msg->flags & I2C_M_TEN)
337 flag |= DAVINCI_I2C_MDR_XA;
338 if (!(msg->flags & I2C_M_RD))
339 flag |= DAVINCI_I2C_MDR_TRX;
Jon Poveyc5b4afe2010-10-12 13:47:05 +0900340 if (msg->len == 0)
Dirk Behmec6c7c722008-03-28 06:16:12 +0100341 flag |= DAVINCI_I2C_MDR_RM;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200342
343 /* Enable receive or transmit interrupts */
344 w = davinci_i2c_read_reg(dev, DAVINCI_I2C_IMR_REG);
345 if (msg->flags & I2C_M_RD)
Chaithrika U Sc062a252010-01-06 14:54:57 +0530346 w |= DAVINCI_I2C_IMR_RRDY;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200347 else
Chaithrika U Sc062a252010-01-06 14:54:57 +0530348 w |= DAVINCI_I2C_IMR_XRDY;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200349 davinci_i2c_write_reg(dev, DAVINCI_I2C_IMR_REG, w);
350
Troy Kisky5a0d5f52008-07-14 22:38:21 +0200351 dev->terminate = 0;
Dirk Behmec6c7c722008-03-28 06:16:12 +0100352
Dirk Behmec6c7c722008-03-28 06:16:12 +0100353 /*
Jon Poveyc5b4afe2010-10-12 13:47:05 +0900354 * Write mode register first as needed for correct behaviour
355 * on OMAP-L138, but don't set STT yet to avoid a race with XRDY
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300356 * occurring before we have loaded DXR
Jon Poveyc5b4afe2010-10-12 13:47:05 +0900357 */
358 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, flag);
359
360 /*
Dirk Behmec6c7c722008-03-28 06:16:12 +0100361 * First byte should be set here, not after interrupt,
362 * because transmit-data-ready interrupt can come before
363 * NACK-interrupt during sending of previous message and
364 * ICDXR may have wrong data
Jon Poveyc5b4afe2010-10-12 13:47:05 +0900365 * It also saves us one interrupt, slightly faster
Dirk Behmec6c7c722008-03-28 06:16:12 +0100366 */
367 if ((!(msg->flags & I2C_M_RD)) && dev->buf_len) {
368 davinci_i2c_write_reg(dev, DAVINCI_I2C_DXR_REG, *dev->buf++);
369 dev->buf_len--;
370 }
371
Jon Poveyc5b4afe2010-10-12 13:47:05 +0900372 /* Set STT to begin transmit now DXR is loaded */
373 flag |= DAVINCI_I2C_MDR_STT;
374 if (stop && msg->len != 0)
375 flag |= DAVINCI_I2C_MDR_STP;
Jon Povey4bba0fd2010-09-17 12:02:11 +0900376 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, flag);
377
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200378 r = wait_for_completion_interruptible_timeout(&dev->cmd_complete,
Jean Delvare98a679c2009-03-28 21:34:43 +0100379 dev->adapter.timeout);
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200380 if (r == 0) {
381 dev_err(dev->dev, "controller timed out\n");
Philby John8574faf2010-01-11 22:39:44 +0530382 i2c_recover_bus(dev);
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200383 i2c_davinci_init(dev);
Troy Kisky5a0d5f52008-07-14 22:38:21 +0200384 dev->buf_len = 0;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200385 return -ETIMEDOUT;
386 }
Troy Kisky5a0d5f52008-07-14 22:38:21 +0200387 if (dev->buf_len) {
388 /* This should be 0 if all bytes were transferred
389 * or dev->cmd_err denotes an error.
390 * A signal may have aborted the transfer.
391 */
392 if (r >= 0) {
393 dev_err(dev->dev, "abnormal termination buf_len=%i\n",
394 dev->buf_len);
395 r = -EREMOTEIO;
396 }
397 dev->terminate = 1;
398 wmb();
399 dev->buf_len = 0;
400 }
401 if (r < 0)
402 return r;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200403
404 /* no error */
405 if (likely(!dev->cmd_err))
406 return msg->len;
407
408 /* We have an error */
409 if (dev->cmd_err & DAVINCI_I2C_STR_AL) {
410 i2c_davinci_init(dev);
411 return -EIO;
412 }
413
414 if (dev->cmd_err & DAVINCI_I2C_STR_NACK) {
415 if (msg->flags & I2C_M_IGNORE_NAK)
416 return msg->len;
417 if (stop) {
418 w = davinci_i2c_read_reg(dev, DAVINCI_I2C_MDR_REG);
Chaithrika U Sc062a252010-01-06 14:54:57 +0530419 w |= DAVINCI_I2C_MDR_STP;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200420 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, w);
421 }
422 return -EREMOTEIO;
423 }
424 return -EIO;
425}
426
427/*
428 * Prepare controller for a transaction and call i2c_davinci_xfer_msg
429 */
430static int
431i2c_davinci_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
432{
433 struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
434 int i;
435 int ret;
436
Harvey Harrison08882d22008-04-22 22:16:47 +0200437 dev_dbg(dev->dev, "%s: msgs: %d\n", __func__, num);
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200438
439 ret = i2c_davinci_wait_bus_not_busy(dev, 1);
440 if (ret < 0) {
441 dev_warn(dev->dev, "timeout waiting for bus ready\n");
442 return ret;
443 }
444
445 for (i = 0; i < num; i++) {
446 ret = i2c_davinci_xfer_msg(adap, &msgs[i], (i == (num - 1)));
Troy Kiskyd868caa2008-07-14 22:38:20 +0200447 dev_dbg(dev->dev, "%s [%d/%d] ret: %d\n", __func__, i + 1, num,
448 ret);
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200449 if (ret < 0)
450 return ret;
451 }
Chaithrika U S82c0de12010-01-06 14:55:00 +0530452
453#ifdef CONFIG_CPU_FREQ
454 complete(&dev->xfr_complete);
455#endif
456
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200457 return num;
458}
459
460static u32 i2c_davinci_func(struct i2c_adapter *adap)
461{
Dirk Behmec6c7c722008-03-28 06:16:12 +0100462 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200463}
464
Troy Kisky5a0d5f52008-07-14 22:38:21 +0200465static void terminate_read(struct davinci_i2c_dev *dev)
466{
467 u16 w = davinci_i2c_read_reg(dev, DAVINCI_I2C_MDR_REG);
468 w |= DAVINCI_I2C_MDR_NACK;
469 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, w);
470
471 /* Throw away data */
472 davinci_i2c_read_reg(dev, DAVINCI_I2C_DRR_REG);
473 if (!dev->terminate)
474 dev_err(dev->dev, "RDR IRQ while no data requested\n");
475}
476static void terminate_write(struct davinci_i2c_dev *dev)
477{
478 u16 w = davinci_i2c_read_reg(dev, DAVINCI_I2C_MDR_REG);
479 w |= DAVINCI_I2C_MDR_RM | DAVINCI_I2C_MDR_STP;
480 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, w);
481
482 if (!dev->terminate)
David Brownell7605fa32009-07-06 15:48:36 -0700483 dev_dbg(dev->dev, "TDR IRQ while no data to send\n");
Troy Kisky5a0d5f52008-07-14 22:38:21 +0200484}
485
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200486/*
487 * Interrupt service routine. This gets called whenever an I2C interrupt
488 * occurs.
489 */
490static irqreturn_t i2c_davinci_isr(int this_irq, void *dev_id)
491{
492 struct davinci_i2c_dev *dev = dev_id;
493 u32 stat;
494 int count = 0;
495 u16 w;
496
497 while ((stat = davinci_i2c_read_reg(dev, DAVINCI_I2C_IVR_REG))) {
Harvey Harrison08882d22008-04-22 22:16:47 +0200498 dev_dbg(dev->dev, "%s: stat=0x%x\n", __func__, stat);
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200499 if (count++ == 100) {
500 dev_warn(dev->dev, "Too much work in one IRQ\n");
501 break;
502 }
503
504 switch (stat) {
505 case DAVINCI_I2C_IVR_AL:
Troy Kisky5a0d5f52008-07-14 22:38:21 +0200506 /* Arbitration lost, must retry */
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200507 dev->cmd_err |= DAVINCI_I2C_STR_AL;
Troy Kisky5a0d5f52008-07-14 22:38:21 +0200508 dev->buf_len = 0;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200509 complete(&dev->cmd_complete);
510 break;
511
512 case DAVINCI_I2C_IVR_NACK:
513 dev->cmd_err |= DAVINCI_I2C_STR_NACK;
Troy Kisky5a0d5f52008-07-14 22:38:21 +0200514 dev->buf_len = 0;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200515 complete(&dev->cmd_complete);
516 break;
517
518 case DAVINCI_I2C_IVR_ARDY:
Troy Kiskyb73a9ae2008-04-11 12:07:05 +0200519 davinci_i2c_write_reg(dev,
520 DAVINCI_I2C_STR_REG, DAVINCI_I2C_STR_ARDY);
Dirk Behmec6c7c722008-03-28 06:16:12 +0100521 if (((dev->buf_len == 0) && (dev->stop != 0)) ||
522 (dev->cmd_err & DAVINCI_I2C_STR_NACK)) {
523 w = davinci_i2c_read_reg(dev,
524 DAVINCI_I2C_MDR_REG);
525 w |= DAVINCI_I2C_MDR_STP;
526 davinci_i2c_write_reg(dev,
527 DAVINCI_I2C_MDR_REG, w);
528 }
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200529 complete(&dev->cmd_complete);
530 break;
531
532 case DAVINCI_I2C_IVR_RDR:
533 if (dev->buf_len) {
534 *dev->buf++ =
535 davinci_i2c_read_reg(dev,
536 DAVINCI_I2C_DRR_REG);
537 dev->buf_len--;
538 if (dev->buf_len)
539 continue;
540
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200541 davinci_i2c_write_reg(dev,
Troy Kiskyb73a9ae2008-04-11 12:07:05 +0200542 DAVINCI_I2C_STR_REG,
543 DAVINCI_I2C_IMR_RRDY);
Troy Kisky5a0d5f52008-07-14 22:38:21 +0200544 } else {
545 /* signal can terminate transfer */
546 terminate_read(dev);
547 }
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200548 break;
549
550 case DAVINCI_I2C_IVR_XRDY:
551 if (dev->buf_len) {
552 davinci_i2c_write_reg(dev, DAVINCI_I2C_DXR_REG,
553 *dev->buf++);
554 dev->buf_len--;
555 if (dev->buf_len)
556 continue;
557
558 w = davinci_i2c_read_reg(dev,
559 DAVINCI_I2C_IMR_REG);
Chaithrika U Sc062a252010-01-06 14:54:57 +0530560 w &= ~DAVINCI_I2C_IMR_XRDY;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200561 davinci_i2c_write_reg(dev,
562 DAVINCI_I2C_IMR_REG,
563 w);
Troy Kisky5a0d5f52008-07-14 22:38:21 +0200564 } else {
565 /* signal can terminate transfer */
566 terminate_write(dev);
567 }
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200568 break;
569
570 case DAVINCI_I2C_IVR_SCD:
Troy Kiskyb73a9ae2008-04-11 12:07:05 +0200571 davinci_i2c_write_reg(dev,
572 DAVINCI_I2C_STR_REG, DAVINCI_I2C_STR_SCD);
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200573 complete(&dev->cmd_complete);
574 break;
575
576 case DAVINCI_I2C_IVR_AAS:
David Brownell7605fa32009-07-06 15:48:36 -0700577 dev_dbg(dev->dev, "Address as slave interrupt\n");
578 break;
579
580 default:
581 dev_warn(dev->dev, "Unrecognized irq stat %d\n", stat);
582 break;
583 }
584 }
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200585
586 return count ? IRQ_HANDLED : IRQ_NONE;
587}
588
Chaithrika U S82c0de12010-01-06 14:55:00 +0530589#ifdef CONFIG_CPU_FREQ
590static int i2c_davinci_cpufreq_transition(struct notifier_block *nb,
591 unsigned long val, void *data)
592{
593 struct davinci_i2c_dev *dev;
594
595 dev = container_of(nb, struct davinci_i2c_dev, freq_transition);
596 if (val == CPUFREQ_PRECHANGE) {
597 wait_for_completion(&dev->xfr_complete);
598 davinci_i2c_reset_ctrl(dev, 0);
599 } else if (val == CPUFREQ_POSTCHANGE) {
600 i2c_davinci_calc_clk_dividers(dev);
601 davinci_i2c_reset_ctrl(dev, 1);
602 }
603
604 return 0;
605}
606
607static inline int i2c_davinci_cpufreq_register(struct davinci_i2c_dev *dev)
608{
609 dev->freq_transition.notifier_call = i2c_davinci_cpufreq_transition;
610
611 return cpufreq_register_notifier(&dev->freq_transition,
612 CPUFREQ_TRANSITION_NOTIFIER);
613}
614
615static inline void i2c_davinci_cpufreq_deregister(struct davinci_i2c_dev *dev)
616{
617 cpufreq_unregister_notifier(&dev->freq_transition,
618 CPUFREQ_TRANSITION_NOTIFIER);
619}
620#else
621static inline int i2c_davinci_cpufreq_register(struct davinci_i2c_dev *dev)
622{
623 return 0;
624}
625
626static inline void i2c_davinci_cpufreq_deregister(struct davinci_i2c_dev *dev)
627{
628}
629#endif
630
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200631static struct i2c_algorithm i2c_davinci_algo = {
632 .master_xfer = i2c_davinci_xfer,
633 .functionality = i2c_davinci_func,
634};
635
Heiko Schocher5c3d8a42012-07-30 07:21:12 +0000636static const struct of_device_id davinci_i2c_of_match[] = {
637 {.compatible = "ti,davinci-i2c", },
638 {},
639};
640MODULE_DEVICE_TABLE(of, davinci_i2c_of_match);
641
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200642static int davinci_i2c_probe(struct platform_device *pdev)
643{
644 struct davinci_i2c_dev *dev;
645 struct i2c_adapter *adap;
646 struct resource *mem, *irq, *ioarea;
647 int r;
648
649 /* NOTE: driver uses the static register mapping */
650 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
651 if (!mem) {
652 dev_err(&pdev->dev, "no mem resource?\n");
653 return -ENODEV;
654 }
655
656 irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
657 if (!irq) {
658 dev_err(&pdev->dev, "no irq resource?\n");
659 return -ENODEV;
660 }
661
Julia Lawall59330822009-07-05 08:37:50 +0200662 ioarea = request_mem_region(mem->start, resource_size(mem),
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200663 pdev->name);
664 if (!ioarea) {
665 dev_err(&pdev->dev, "I2C region already claimed\n");
666 return -EBUSY;
667 }
668
669 dev = kzalloc(sizeof(struct davinci_i2c_dev), GFP_KERNEL);
670 if (!dev) {
671 r = -ENOMEM;
672 goto err_release_region;
673 }
674
Troy Kisky2e743782008-07-14 22:38:21 +0200675 init_completion(&dev->cmd_complete);
Chaithrika U S82c0de12010-01-06 14:55:00 +0530676#ifdef CONFIG_CPU_FREQ
677 init_completion(&dev->xfr_complete);
678#endif
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200679 dev->dev = get_device(&pdev->dev);
680 dev->irq = irq->start;
Heiko Schocher5c3d8a42012-07-30 07:21:12 +0000681 dev->pdata = dev->dev->platform_data;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200682 platform_set_drvdata(pdev, dev);
683
Heiko Schocher5c3d8a42012-07-30 07:21:12 +0000684 if (!dev->pdata && pdev->dev.of_node) {
685 u32 prop;
686
687 dev->pdata = devm_kzalloc(&pdev->dev,
688 sizeof(struct davinci_i2c_platform_data), GFP_KERNEL);
689 if (!dev->pdata) {
690 r = -ENOMEM;
691 goto err_free_mem;
692 }
693 memcpy(dev->pdata, &davinci_i2c_platform_data_default,
694 sizeof(struct davinci_i2c_platform_data));
695 if (!of_property_read_u32(pdev->dev.of_node, "clock-frequency",
696 &prop))
697 dev->pdata->bus_freq = prop / 1000;
698 } else if (!dev->pdata) {
699 dev->pdata = &davinci_i2c_platform_data_default;
700 }
701
Kevin Hilmane164dde2009-07-06 15:48:35 -0700702 dev->clk = clk_get(&pdev->dev, NULL);
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200703 if (IS_ERR(dev->clk)) {
704 r = -ENODEV;
705 goto err_free_mem;
706 }
Murali Karicheri2bdbfa92012-08-30 18:10:36 +0000707 clk_prepare_enable(dev->clk);
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200708
Chaithrika U Sc062a252010-01-06 14:54:57 +0530709 dev->base = ioremap(mem->start, resource_size(mem));
710 if (!dev->base) {
711 r = -EBUSY;
712 goto err_mem_ioremap;
713 }
714
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200715 i2c_davinci_init(dev);
716
717 r = request_irq(dev->irq, i2c_davinci_isr, 0, pdev->name, dev);
718 if (r) {
719 dev_err(&pdev->dev, "failure requesting irq %i\n", dev->irq);
720 goto err_unuse_clocks;
721 }
722
Chaithrika U S82c0de12010-01-06 14:55:00 +0530723 r = i2c_davinci_cpufreq_register(dev);
724 if (r) {
725 dev_err(&pdev->dev, "failed to register cpufreq\n");
726 goto err_free_irq;
727 }
728
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200729 adap = &dev->adapter;
730 i2c_set_adapdata(adap, dev);
731 adap->owner = THIS_MODULE;
732 adap->class = I2C_CLASS_HWMON;
733 strlcpy(adap->name, "DaVinci I2C adapter", sizeof(adap->name));
734 adap->algo = &i2c_davinci_algo;
735 adap->dev.parent = &pdev->dev;
Jean Delvare98a679c2009-03-28 21:34:43 +0100736 adap->timeout = DAVINCI_I2C_TIMEOUT;
Heiko Schocher5c3d8a42012-07-30 07:21:12 +0000737 adap->dev.of_node = pdev->dev.of_node;
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200738
739 adap->nr = pdev->id;
740 r = i2c_add_numbered_adapter(adap);
741 if (r) {
742 dev_err(&pdev->dev, "failure adding adapter\n");
743 goto err_free_irq;
744 }
Heiko Schocher5c3d8a42012-07-30 07:21:12 +0000745 of_i2c_register_devices(adap);
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200746
747 return 0;
748
749err_free_irq:
750 free_irq(dev->irq, dev);
751err_unuse_clocks:
Chaithrika U Sc062a252010-01-06 14:54:57 +0530752 iounmap(dev->base);
753err_mem_ioremap:
Murali Karicheri2bdbfa92012-08-30 18:10:36 +0000754 clk_disable_unprepare(dev->clk);
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200755 clk_put(dev->clk);
756 dev->clk = NULL;
757err_free_mem:
758 platform_set_drvdata(pdev, NULL);
759 put_device(&pdev->dev);
760 kfree(dev);
761err_release_region:
Julia Lawall59330822009-07-05 08:37:50 +0200762 release_mem_region(mem->start, resource_size(mem));
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200763
764 return r;
765}
766
767static int davinci_i2c_remove(struct platform_device *pdev)
768{
769 struct davinci_i2c_dev *dev = platform_get_drvdata(pdev);
770 struct resource *mem;
771
Chaithrika U S82c0de12010-01-06 14:55:00 +0530772 i2c_davinci_cpufreq_deregister(dev);
773
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200774 platform_set_drvdata(pdev, NULL);
775 i2c_del_adapter(&dev->adapter);
776 put_device(&pdev->dev);
777
Murali Karicheri2bdbfa92012-08-30 18:10:36 +0000778 clk_disable_unprepare(dev->clk);
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200779 clk_put(dev->clk);
780 dev->clk = NULL;
781
782 davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, 0);
Marcus Folkesson9868a062012-05-03 15:56:36 +0200783 free_irq(dev->irq, dev);
Chaithrika U Sc062a252010-01-06 14:54:57 +0530784 iounmap(dev->base);
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200785 kfree(dev);
786
787 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
Julia Lawall59330822009-07-05 08:37:50 +0200788 release_mem_region(mem->start, resource_size(mem));
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200789 return 0;
790}
791
Chaithrika U S68f15de2010-01-06 14:54:59 +0530792#ifdef CONFIG_PM
793static int davinci_i2c_suspend(struct device *dev)
794{
795 struct platform_device *pdev = to_platform_device(dev);
796 struct davinci_i2c_dev *i2c_dev = platform_get_drvdata(pdev);
797
798 /* put I2C into reset */
799 davinci_i2c_reset_ctrl(i2c_dev, 0);
Murali Karicheri2bdbfa92012-08-30 18:10:36 +0000800 clk_disable_unprepare(i2c_dev->clk);
Chaithrika U S68f15de2010-01-06 14:54:59 +0530801
802 return 0;
803}
804
805static int davinci_i2c_resume(struct device *dev)
806{
807 struct platform_device *pdev = to_platform_device(dev);
808 struct davinci_i2c_dev *i2c_dev = platform_get_drvdata(pdev);
809
Murali Karicheri2bdbfa92012-08-30 18:10:36 +0000810 clk_prepare_enable(i2c_dev->clk);
Chaithrika U S68f15de2010-01-06 14:54:59 +0530811 /* take I2C out of reset */
812 davinci_i2c_reset_ctrl(i2c_dev, 1);
813
814 return 0;
815}
816
817static const struct dev_pm_ops davinci_i2c_pm = {
818 .suspend = davinci_i2c_suspend,
819 .resume = davinci_i2c_resume,
820};
821
822#define davinci_i2c_pm_ops (&davinci_i2c_pm)
823#else
824#define davinci_i2c_pm_ops NULL
825#endif
826
Kay Sieversadd8eda2008-04-22 22:16:49 +0200827/* work with hotplug and coldplug */
828MODULE_ALIAS("platform:i2c_davinci");
829
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200830static struct platform_driver davinci_i2c_driver = {
831 .probe = davinci_i2c_probe,
832 .remove = davinci_i2c_remove,
833 .driver = {
834 .name = "i2c_davinci",
835 .owner = THIS_MODULE,
Chaithrika U S68f15de2010-01-06 14:54:59 +0530836 .pm = davinci_i2c_pm_ops,
Heiko Schocher5c3d8a42012-07-30 07:21:12 +0000837 .of_match_table = of_match_ptr(davinci_i2c_of_match),
Vladimir Barinov95a7f102007-10-13 23:56:30 +0200838 },
839};
840
841/* I2C may be needed to bring up other drivers */
842static int __init davinci_i2c_init_driver(void)
843{
844 return platform_driver_register(&davinci_i2c_driver);
845}
846subsys_initcall(davinci_i2c_init_driver);
847
848static void __exit davinci_i2c_exit_driver(void)
849{
850 platform_driver_unregister(&davinci_i2c_driver);
851}
852module_exit(davinci_i2c_exit_driver);
853
854MODULE_AUTHOR("Texas Instruments India");
855MODULE_DESCRIPTION("TI DaVinci I2C bus adapter");
856MODULE_LICENSE("GPL");