i2c-omap.c 34.8 KB
Newer Older
1 2 3 4 5
/*
 * TI OMAP I2C master mode driver
 *
 * Copyright (C) 2003 MontaVista Software, Inc.
 * Copyright (C) 2005 Nokia Corporation
T
Tony Lindgren 已提交
6
 * Copyright (C) 2004 - 2007 Texas Instruments.
7
 *
T
Tony Lindgren 已提交
8 9 10 11 12 13 14
 * Originally written by MontaVista Software, Inc.
 * Additional contributions by:
 *	Tony Lindgren <tony@atomide.com>
 *	Imre Deak <imre.deak@nokia.com>
 *	Juha Yrjölä <juha.yrjola@solidboot.com>
 *	Syed Khasim <x0khasim@ti.com>
 *	Nishant Menon <nm@ti.com>
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 */

#include <linux/module.h>
#include <linux/delay.h>
#include <linux/i2c.h>
#include <linux/err.h>
#include <linux/interrupt.h>
#include <linux/completion.h>
#include <linux/platform_device.h>
#include <linux/clk.h>
T
Tony Lindgren 已提交
35
#include <linux/io.h>
36 37
#include <linux/of.h>
#include <linux/of_device.h>
38
#include <linux/slab.h>
39
#include <linux/i2c-omap.h>
40
#include <linux/pm_runtime.h>
41

42
/* I2C controller revisions */
43
#define OMAP_I2C_OMAP1_REV_2		0x20
44 45

/* I2C controller revisions present on specific hardware */
46 47 48 49
#define OMAP_I2C_REV_ON_2430		0x00000036
#define OMAP_I2C_REV_ON_3430_3530	0x0000003C
#define OMAP_I2C_REV_ON_3630		0x00000040
#define OMAP_I2C_REV_ON_4430_PLUS	0x50400002
50

51 52 53
/* timeout waiting for the controller to respond */
#define OMAP_I2C_TIMEOUT (msecs_to_jiffies(1000))

54 55 56
/* timeout for pm runtime autosuspend */
#define OMAP_I2C_PM_TIMEOUT		1000	/* ms */

57
/* For OMAP3 I2C_IV has changed to I2C_WE (wakeup enable) */
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
enum {
	OMAP_I2C_REV_REG = 0,
	OMAP_I2C_IE_REG,
	OMAP_I2C_STAT_REG,
	OMAP_I2C_IV_REG,
	OMAP_I2C_WE_REG,
	OMAP_I2C_SYSS_REG,
	OMAP_I2C_BUF_REG,
	OMAP_I2C_CNT_REG,
	OMAP_I2C_DATA_REG,
	OMAP_I2C_SYSC_REG,
	OMAP_I2C_CON_REG,
	OMAP_I2C_OA_REG,
	OMAP_I2C_SA_REG,
	OMAP_I2C_PSC_REG,
	OMAP_I2C_SCLL_REG,
	OMAP_I2C_SCLH_REG,
	OMAP_I2C_SYSTEST_REG,
	OMAP_I2C_BUFSTAT_REG,
77 78 79 80 81 82
	/* only on OMAP4430 */
	OMAP_I2C_IP_V2_REVNB_LO,
	OMAP_I2C_IP_V2_REVNB_HI,
	OMAP_I2C_IP_V2_IRQSTATUS_RAW,
	OMAP_I2C_IP_V2_IRQENABLE_SET,
	OMAP_I2C_IP_V2_IRQENABLE_CLR,
83
};
84 85

/* I2C Interrupt Enable Register (OMAP_I2C_IE): */
86 87
#define OMAP_I2C_IE_XDR		(1 << 14)	/* TX Buffer drain int enable */
#define OMAP_I2C_IE_RDR		(1 << 13)	/* RX Buffer drain int enable */
88 89 90 91 92 93 94
#define OMAP_I2C_IE_XRDY	(1 << 4)	/* TX data ready int enable */
#define OMAP_I2C_IE_RRDY	(1 << 3)	/* RX data ready int enable */
#define OMAP_I2C_IE_ARDY	(1 << 2)	/* Access ready int enable */
#define OMAP_I2C_IE_NACK	(1 << 1)	/* No ack interrupt enable */
#define OMAP_I2C_IE_AL		(1 << 0)	/* Arbitration lost int ena */

/* I2C Status Register (OMAP_I2C_STAT): */
95 96
#define OMAP_I2C_STAT_XDR	(1 << 14)	/* TX Buffer draining */
#define OMAP_I2C_STAT_RDR	(1 << 13)	/* RX Buffer draining */
97 98 99 100 101 102 103 104 105 106 107
#define OMAP_I2C_STAT_BB	(1 << 12)	/* Bus busy */
#define OMAP_I2C_STAT_ROVR	(1 << 11)	/* Receive overrun */
#define OMAP_I2C_STAT_XUDF	(1 << 10)	/* Transmit underflow */
#define OMAP_I2C_STAT_AAS	(1 << 9)	/* Address as slave */
#define OMAP_I2C_STAT_AD0	(1 << 8)	/* Address zero */
#define OMAP_I2C_STAT_XRDY	(1 << 4)	/* Transmit data ready */
#define OMAP_I2C_STAT_RRDY	(1 << 3)	/* Receive data ready */
#define OMAP_I2C_STAT_ARDY	(1 << 2)	/* Register access ready */
#define OMAP_I2C_STAT_NACK	(1 << 1)	/* No ack interrupt enable */
#define OMAP_I2C_STAT_AL	(1 << 0)	/* Arbitration lost int ena */

108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
/* I2C WE wakeup enable register */
#define OMAP_I2C_WE_XDR_WE	(1 << 14)	/* TX drain wakup */
#define OMAP_I2C_WE_RDR_WE	(1 << 13)	/* RX drain wakeup */
#define OMAP_I2C_WE_AAS_WE	(1 << 9)	/* Address as slave wakeup*/
#define OMAP_I2C_WE_BF_WE	(1 << 8)	/* Bus free wakeup */
#define OMAP_I2C_WE_STC_WE	(1 << 6)	/* Start condition wakeup */
#define OMAP_I2C_WE_GC_WE	(1 << 5)	/* General call wakeup */
#define OMAP_I2C_WE_DRDY_WE	(1 << 3)	/* TX/RX data ready wakeup */
#define OMAP_I2C_WE_ARDY_WE	(1 << 2)	/* Reg access ready wakeup */
#define OMAP_I2C_WE_NACK_WE	(1 << 1)	/* No acknowledgment wakeup */
#define OMAP_I2C_WE_AL_WE	(1 << 0)	/* Arbitration lost wakeup */

#define OMAP_I2C_WE_ALL		(OMAP_I2C_WE_XDR_WE | OMAP_I2C_WE_RDR_WE | \
				OMAP_I2C_WE_AAS_WE | OMAP_I2C_WE_BF_WE | \
				OMAP_I2C_WE_STC_WE | OMAP_I2C_WE_GC_WE | \
				OMAP_I2C_WE_DRDY_WE | OMAP_I2C_WE_ARDY_WE | \
				OMAP_I2C_WE_NACK_WE | OMAP_I2C_WE_AL_WE)

126 127
/* I2C Buffer Configuration Register (OMAP_I2C_BUF): */
#define OMAP_I2C_BUF_RDMA_EN	(1 << 15)	/* RX DMA channel enable */
128
#define OMAP_I2C_BUF_RXFIF_CLR	(1 << 14)	/* RX FIFO Clear */
129
#define OMAP_I2C_BUF_XDMA_EN	(1 << 7)	/* TX DMA channel enable */
130
#define OMAP_I2C_BUF_TXFIF_CLR	(1 << 6)	/* TX FIFO Clear */
131 132 133 134

/* I2C Configuration Register (OMAP_I2C_CON): */
#define OMAP_I2C_CON_EN		(1 << 15)	/* I2C module enable */
#define OMAP_I2C_CON_BE		(1 << 14)	/* Big endian mode */
135
#define OMAP_I2C_CON_OPMODE_HS	(1 << 12)	/* High Speed support */
136 137 138 139 140 141 142 143
#define OMAP_I2C_CON_STB	(1 << 11)	/* Start byte mode (master) */
#define OMAP_I2C_CON_MST	(1 << 10)	/* Master/slave mode */
#define OMAP_I2C_CON_TRX	(1 << 9)	/* TX/RX mode (master only) */
#define OMAP_I2C_CON_XA		(1 << 8)	/* Expand address */
#define OMAP_I2C_CON_RM		(1 << 2)	/* Repeat mode (master only) */
#define OMAP_I2C_CON_STP	(1 << 1)	/* Stop cond (master only) */
#define OMAP_I2C_CON_STT	(1 << 0)	/* Start condition (master) */

144 145 146 147
/* I2C SCL time value when Master */
#define OMAP_I2C_SCLL_HSSCLL	8
#define OMAP_I2C_SCLH_HSSCLH	8

148 149 150 151 152 153 154 155 156 157 158 159
/* I2C System Test Register (OMAP_I2C_SYSTEST): */
#ifdef DEBUG
#define OMAP_I2C_SYSTEST_ST_EN		(1 << 15)	/* System test enable */
#define OMAP_I2C_SYSTEST_FREE		(1 << 14)	/* Free running mode */
#define OMAP_I2C_SYSTEST_TMODE_MASK	(3 << 12)	/* Test mode select */
#define OMAP_I2C_SYSTEST_TMODE_SHIFT	(12)		/* Test mode select */
#define OMAP_I2C_SYSTEST_SCL_I		(1 << 3)	/* SCL line sense in */
#define OMAP_I2C_SYSTEST_SCL_O		(1 << 2)	/* SCL line drive out */
#define OMAP_I2C_SYSTEST_SDA_I		(1 << 1)	/* SDA line sense in */
#define OMAP_I2C_SYSTEST_SDA_O		(1 << 0)	/* SDA line drive out */
#endif

160 161 162 163 164 165 166 167 168 169 170 171
/* OCP_SYSSTATUS bit definitions */
#define SYSS_RESETDONE_MASK		(1 << 0)

/* OCP_SYSCONFIG bit definitions */
#define SYSC_CLOCKACTIVITY_MASK		(0x3 << 8)
#define SYSC_SIDLEMODE_MASK		(0x3 << 3)
#define SYSC_ENAWAKEUP_MASK		(1 << 2)
#define SYSC_SOFTRESET_MASK		(1 << 1)
#define SYSC_AUTOIDLE_MASK		(1 << 0)

#define SYSC_IDLEMODE_SMART		0x2
#define SYSC_CLOCKACTIVITY_FCLK		0x2
172

173 174
/* Errata definitions */
#define I2C_OMAP_ERRATA_I207		(1 << 0)
175
#define I2C_OMAP_ERRATA_I462		(1 << 1)
176

177 178
#define OMAP_I2C_IP_V2_INTERRUPTS_MASK	0x6FFF

179
struct omap_i2c_dev {
180
	spinlock_t		lock;		/* IRQ synchronization */
181 182 183
	struct device		*dev;
	void __iomem		*base;		/* virtual */
	int			irq;
184
	int			reg_shift;      /* bit shift for I2C register addresses */
185 186
	struct completion	cmd_complete;
	struct resource		*ioarea;
187 188 189
	u32			latency;	/* maximum mpu wkup latency */
	void			(*set_mpu_wkup_lat)(struct device *dev,
						    long latency);
190 191
	u32			speed;		/* Speed of bus in kHz */
	u32			flags;
192
	u16			scheme;
193 194
	u16			cmd_err;
	u8			*buf;
195
	u8			*regs;
196 197
	size_t			buf_len;
	struct i2c_adapter	adapter;
198
	u8			threshold;
199 200 201 202
	u8			fifo_size;	/* use as flag and value
						 * fifo_size==0 implies no fifo
						 * if set, should be trsh+1
						 */
203
	u32			rev;
204
	unsigned		b_hw:1;		/* bad h/w fixes */
205
	unsigned		receiver:1;	/* true when we're in receiver mode */
T
Tony Lindgren 已提交
206
	u16			iestate;	/* Saved interrupt register */
207 208 209 210 211
	u16			pscstate;
	u16			scllstate;
	u16			sclhstate;
	u16			syscstate;
	u16			westate;
212
	u16			errata;
213 214
};

215
static const u8 reg_map_ip_v1[] = {
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
	[OMAP_I2C_REV_REG] = 0x00,
	[OMAP_I2C_IE_REG] = 0x01,
	[OMAP_I2C_STAT_REG] = 0x02,
	[OMAP_I2C_IV_REG] = 0x03,
	[OMAP_I2C_WE_REG] = 0x03,
	[OMAP_I2C_SYSS_REG] = 0x04,
	[OMAP_I2C_BUF_REG] = 0x05,
	[OMAP_I2C_CNT_REG] = 0x06,
	[OMAP_I2C_DATA_REG] = 0x07,
	[OMAP_I2C_SYSC_REG] = 0x08,
	[OMAP_I2C_CON_REG] = 0x09,
	[OMAP_I2C_OA_REG] = 0x0a,
	[OMAP_I2C_SA_REG] = 0x0b,
	[OMAP_I2C_PSC_REG] = 0x0c,
	[OMAP_I2C_SCLL_REG] = 0x0d,
	[OMAP_I2C_SCLH_REG] = 0x0e,
	[OMAP_I2C_SYSTEST_REG] = 0x0f,
	[OMAP_I2C_BUFSTAT_REG] = 0x10,
};

236
static const u8 reg_map_ip_v2[] = {
237 238 239 240 241 242 243 244 245
	[OMAP_I2C_REV_REG] = 0x04,
	[OMAP_I2C_IE_REG] = 0x2c,
	[OMAP_I2C_STAT_REG] = 0x28,
	[OMAP_I2C_IV_REG] = 0x34,
	[OMAP_I2C_WE_REG] = 0x34,
	[OMAP_I2C_SYSS_REG] = 0x90,
	[OMAP_I2C_BUF_REG] = 0x94,
	[OMAP_I2C_CNT_REG] = 0x98,
	[OMAP_I2C_DATA_REG] = 0x9c,
246
	[OMAP_I2C_SYSC_REG] = 0x10,
247 248 249 250 251 252 253 254
	[OMAP_I2C_CON_REG] = 0xa4,
	[OMAP_I2C_OA_REG] = 0xa8,
	[OMAP_I2C_SA_REG] = 0xac,
	[OMAP_I2C_PSC_REG] = 0xb0,
	[OMAP_I2C_SCLL_REG] = 0xb4,
	[OMAP_I2C_SCLH_REG] = 0xb8,
	[OMAP_I2C_SYSTEST_REG] = 0xbC,
	[OMAP_I2C_BUFSTAT_REG] = 0xc0,
255 256 257 258 259
	[OMAP_I2C_IP_V2_REVNB_LO] = 0x00,
	[OMAP_I2C_IP_V2_REVNB_HI] = 0x04,
	[OMAP_I2C_IP_V2_IRQSTATUS_RAW] = 0x24,
	[OMAP_I2C_IP_V2_IRQENABLE_SET] = 0x2c,
	[OMAP_I2C_IP_V2_IRQENABLE_CLR] = 0x30,
260 261
};

262 263 264
static inline void omap_i2c_write_reg(struct omap_i2c_dev *i2c_dev,
				      int reg, u16 val)
{
265
	writew_relaxed(val, i2c_dev->base +
266
			(i2c_dev->regs[reg] << i2c_dev->reg_shift));
267 268 269 270
}

static inline u16 omap_i2c_read_reg(struct omap_i2c_dev *i2c_dev, int reg)
{
271
	return readw_relaxed(i2c_dev->base +
272
				(i2c_dev->regs[reg] << i2c_dev->reg_shift));
273 274
}

275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
static void __omap_i2c_init(struct omap_i2c_dev *dev)
{

	omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);

	/* Setup clock prescaler to obtain approx 12MHz I2C module clock: */
	omap_i2c_write_reg(dev, OMAP_I2C_PSC_REG, dev->pscstate);

	/* SCL low and high time values */
	omap_i2c_write_reg(dev, OMAP_I2C_SCLL_REG, dev->scllstate);
	omap_i2c_write_reg(dev, OMAP_I2C_SCLH_REG, dev->sclhstate);
	if (dev->rev >= OMAP_I2C_REV_ON_3430_3530)
		omap_i2c_write_reg(dev, OMAP_I2C_WE_REG, dev->westate);

	/* Take the I2C module out of reset: */
	omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_EN);

	/*
	 * Don't write to this register if the IE state is 0 as it can
	 * cause deadlock.
	 */
	if (dev->iestate)
		omap_i2c_write_reg(dev, OMAP_I2C_IE_REG, dev->iestate);
}

300
static int omap_i2c_reset(struct omap_i2c_dev *dev)
301 302
{
	unsigned long timeout;
S
Shubhrajyoti D 已提交
303 304
	u16 sysc;

305
	if (dev->rev >= OMAP_I2C_OMAP1_REV_2) {
S
Shubhrajyoti D 已提交
306 307
		sysc = omap_i2c_read_reg(dev, OMAP_I2C_SYSC_REG);

308 309 310 311 312
		/* Disable I2C controller before soft reset */
		omap_i2c_write_reg(dev, OMAP_I2C_CON_REG,
			omap_i2c_read_reg(dev, OMAP_I2C_CON_REG) &
				~(OMAP_I2C_CON_EN));

313
		omap_i2c_write_reg(dev, OMAP_I2C_SYSC_REG, SYSC_SOFTRESET_MASK);
314 315 316 317 318
		/* For some reason we need to set the EN bit before the
		 * reset done bit gets set. */
		timeout = jiffies + OMAP_I2C_TIMEOUT;
		omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_EN);
		while (!(omap_i2c_read_reg(dev, OMAP_I2C_SYSS_REG) &
319
			 SYSS_RESETDONE_MASK)) {
320
			if (time_after(jiffies, timeout)) {
321
				dev_warn(dev->dev, "timeout waiting "
322 323 324 325 326
						"for controller reset\n");
				return -ETIMEDOUT;
			}
			msleep(1);
		}
327 328

		/* SYSC register is cleared by the reset; rewrite it */
S
Shubhrajyoti D 已提交
329
		omap_i2c_write_reg(dev, OMAP_I2C_SYSC_REG, sysc);
330

331
	}
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
	return 0;
}

static int omap_i2c_init(struct omap_i2c_dev *dev)
{
	u16 psc = 0, scll = 0, sclh = 0;
	u16 fsscll = 0, fssclh = 0, hsscll = 0, hssclh = 0;
	unsigned long fclk_rate = 12000000;
	unsigned long internal_clk = 0;
	struct clk *fclk;

	if (dev->rev >= OMAP_I2C_REV_ON_3430_3530) {
		/*
		 * Enabling all wakup sources to stop I2C freezing on
		 * WFI instruction.
		 * REVISIT: Some wkup sources might not be needed.
		 */
		dev->westate = OMAP_I2C_WE_ALL;
	}
351

352
	if (dev->flags & OMAP_I2C_FLAG_ALWAYS_ARMXOR_CLK) {
R
Russell King 已提交
353 354 355 356 357 358
		/*
		 * The I2C functional clock is the armxor_ck, so there's
		 * no need to get "armxor_ck" separately.  Now, if OMAP2420
		 * always returns 12MHz for the functional clock, we can
		 * do this bit unconditionally.
		 */
359 360 361
		fclk = clk_get(dev->dev, "fck");
		fclk_rate = clk_get_rate(fclk);
		clk_put(fclk);
R
Russell King 已提交
362

363 364 365 366 367 368 369 370 371
		/* TRM for 5912 says the I2C clock must be prescaled to be
		 * between 7 - 12 MHz. The XOR input clock is typically
		 * 12, 13 or 19.2 MHz. So we should have code that produces:
		 *
		 * XOR MHz	Divider		Prescaler
		 * 12		1		0
		 * 13		2		1
		 * 19.2		2		1
		 */
372 373
		if (fclk_rate > 12000000)
			psc = fclk_rate / 12000000;
374 375
	}

376
	if (!(dev->flags & OMAP_I2C_FLAG_SIMPLE_CLOCK)) {
377

378 379 380 381 382 383
		/*
		 * HSI2C controller internal clk rate should be 19.2 Mhz for
		 * HS and for all modes on 2430. On 34xx we can use lower rate
		 * to get longer filter period for better noise suppression.
		 * The filter is iclk (fclk for HS) period.
		 */
384
		if (dev->speed > 400 ||
385
			       dev->flags & OMAP_I2C_FLAG_FORCE_19200_INT_CLK)
386 387 388 389 390
			internal_clk = 19200;
		else if (dev->speed > 100)
			internal_clk = 9600;
		else
			internal_clk = 4000;
391 392 393
		fclk = clk_get(dev->dev, "fck");
		fclk_rate = clk_get_rate(fclk) / 1000;
		clk_put(fclk);
394 395 396 397 398 399 400

		/* Compute prescaler divisor */
		psc = fclk_rate / internal_clk;
		psc = psc - 1;

		/* If configured for High Speed */
		if (dev->speed > 400) {
401 402
			unsigned long scl;

403
			/* For first phase of HS mode */
404 405 406
			scl = internal_clk / 400;
			fsscll = scl - (scl / 3) - 7;
			fssclh = (scl / 3) - 5;
407 408

			/* For second phase of HS mode */
409 410 411 412 413 414 415 416 417 418
			scl = fclk_rate / dev->speed;
			hsscll = scl - (scl / 3) - 7;
			hssclh = (scl / 3) - 5;
		} else if (dev->speed > 100) {
			unsigned long scl;

			/* Fast mode */
			scl = internal_clk / dev->speed;
			fsscll = scl - (scl / 3) - 7;
			fssclh = (scl / 3) - 5;
419
		} else {
420 421 422
			/* Standard mode */
			fsscll = internal_clk / (dev->speed * 2) - 7;
			fssclh = internal_clk / (dev->speed * 2) - 5;
423 424 425 426 427 428 429 430 431 432 433 434
		}
		scll = (hsscll << OMAP_I2C_SCLL_HSSCLL) | fsscll;
		sclh = (hssclh << OMAP_I2C_SCLH_HSSCLH) | fssclh;
	} else {
		/* Program desired operating rate */
		fclk_rate /= (psc + 1) * 1000;
		if (psc > 2)
			psc = 2;
		scll = fclk_rate / (dev->speed * 2) - 7 + psc;
		sclh = fclk_rate / (dev->speed * 2) - 7 + psc;
	}

435
	dev->iestate = (OMAP_I2C_IE_XRDY | OMAP_I2C_IE_RRDY |
T
Tony Lindgren 已提交
436 437
			OMAP_I2C_IE_ARDY | OMAP_I2C_IE_NACK |
			OMAP_I2C_IE_AL)  | ((dev->fifo_size) ?
438
				(OMAP_I2C_IE_RDR | OMAP_I2C_IE_XDR) : 0);
439 440 441 442 443 444 445

	dev->pscstate = psc;
	dev->scllstate = scll;
	dev->sclhstate = sclh;

	__omap_i2c_init(dev);

446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
	return 0;
}

/*
 * Waiting on Bus Busy
 */
static int omap_i2c_wait_for_bb(struct omap_i2c_dev *dev)
{
	unsigned long timeout;

	timeout = jiffies + OMAP_I2C_TIMEOUT;
	while (omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG) & OMAP_I2C_STAT_BB) {
		if (time_after(jiffies, timeout)) {
			dev_warn(dev->dev, "timeout waiting for bus ready\n");
			return -ETIMEDOUT;
		}
		msleep(1);
	}

	return 0;
}

468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
static void omap_i2c_resize_fifo(struct omap_i2c_dev *dev, u8 size, bool is_rx)
{
	u16		buf;

	if (dev->flags & OMAP_I2C_FLAG_NO_FIFO)
		return;

	/*
	 * Set up notification threshold based on message size. We're doing
	 * this to try and avoid draining feature as much as possible. Whenever
	 * we have big messages to transfer (bigger than our total fifo size)
	 * then we might use draining feature to transfer the remaining bytes.
	 */

	dev->threshold = clamp(size, (u8) 1, dev->fifo_size);

	buf = omap_i2c_read_reg(dev, OMAP_I2C_BUF_REG);

	if (is_rx) {
		/* Clear RX Threshold */
		buf &= ~(0x3f << 8);
		buf |= ((dev->threshold - 1) << 8) | OMAP_I2C_BUF_RXFIF_CLR;
	} else {
		/* Clear TX Threshold */
		buf &= ~0x3f;
		buf |= (dev->threshold - 1) | OMAP_I2C_BUF_TXFIF_CLR;
	}

	omap_i2c_write_reg(dev, OMAP_I2C_BUF_REG, buf);

498
	if (dev->rev < OMAP_I2C_REV_ON_3630)
499 500 501
		dev->b_hw = 1; /* Enable hardware fixes */

	/* calculate wakeup latency constraint for MPU */
502 503 504
	if (dev->set_mpu_wkup_lat != NULL)
		dev->latency = (1000000 * dev->threshold) /
			(1000 * dev->speed / 8);
505 506
}

507 508 509 510 511 512 513
/*
 * Low level master read/write transaction.
 */
static int omap_i2c_xfer_msg(struct i2c_adapter *adap,
			     struct i2c_msg *msg, int stop)
{
	struct omap_i2c_dev *dev = i2c_get_adapdata(adap);
514
	unsigned long timeout;
515 516 517 518 519 520 521 522
	u16 w;

	dev_dbg(dev->dev, "addr: 0x%04x, len: %d, flags: 0x%x, stop: %d\n",
		msg->addr, msg->len, msg->flags, stop);

	if (msg->len == 0)
		return -EINVAL;

523 524 525
	dev->receiver = !!(msg->flags & I2C_M_RD);
	omap_i2c_resize_fifo(dev, msg->len, dev->receiver);

526 527 528 529 530 531
	omap_i2c_write_reg(dev, OMAP_I2C_SA_REG, msg->addr);

	/* REVISIT: Could the STB bit of I2C_CON be used with probing? */
	dev->buf = msg->buf;
	dev->buf_len = msg->len;

532 533 534
	/* make sure writes to dev->buf_len are ordered */
	barrier();

535 536
	omap_i2c_write_reg(dev, OMAP_I2C_CNT_REG, dev->buf_len);

537 538 539 540 541
	/* Clear the FIFO Buffers */
	w = omap_i2c_read_reg(dev, OMAP_I2C_BUF_REG);
	w |= OMAP_I2C_BUF_RXFIF_CLR | OMAP_I2C_BUF_TXFIF_CLR;
	omap_i2c_write_reg(dev, OMAP_I2C_BUF_REG, w);

542
	reinit_completion(&dev->cmd_complete);
543 544 545
	dev->cmd_err = 0;

	w = OMAP_I2C_CON_EN | OMAP_I2C_CON_MST | OMAP_I2C_CON_STT;
546 547 548

	/* High speed configuration */
	if (dev->speed > 400)
549
		w |= OMAP_I2C_CON_OPMODE_HS;
550

551 552
	if (msg->flags & I2C_M_STOP)
		stop = 1;
553 554 555 556
	if (msg->flags & I2C_M_TEN)
		w |= OMAP_I2C_CON_XA;
	if (!(msg->flags & I2C_M_RD))
		w |= OMAP_I2C_CON_TRX;
T
Tony Lindgren 已提交
557

558
	if (!dev->b_hw && stop)
559
		w |= OMAP_I2C_CON_STP;
T
Tony Lindgren 已提交
560

561 562
	omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);

563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
	/*
	 * Don't write stt and stp together on some hardware.
	 */
	if (dev->b_hw && stop) {
		unsigned long delay = jiffies + OMAP_I2C_TIMEOUT;
		u16 con = omap_i2c_read_reg(dev, OMAP_I2C_CON_REG);
		while (con & OMAP_I2C_CON_STT) {
			con = omap_i2c_read_reg(dev, OMAP_I2C_CON_REG);

			/* Let the user know if i2c is in a bad state */
			if (time_after(jiffies, delay)) {
				dev_err(dev->dev, "controller timed out "
				"waiting for start condition to finish\n");
				return -ETIMEDOUT;
			}
			cpu_relax();
		}

		w |= OMAP_I2C_CON_STP;
		w &= ~OMAP_I2C_CON_STT;
		omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);
	}

586 587 588 589
	/*
	 * REVISIT: We should abort the transfer on signals, but the bus goes
	 * into arbitration and we're currently unable to recover from it.
	 */
590 591 592
	timeout = wait_for_completion_timeout(&dev->cmd_complete,
						OMAP_I2C_TIMEOUT);
	if (timeout == 0) {
593
		dev_err(dev->dev, "controller timed out\n");
594 595
		omap_i2c_reset(dev);
		__omap_i2c_init(dev);
596 597 598 599 600 601 602 603 604
		return -ETIMEDOUT;
	}

	if (likely(!dev->cmd_err))
		return 0;

	/* We have an error */
	if (dev->cmd_err & (OMAP_I2C_STAT_AL | OMAP_I2C_STAT_ROVR |
			    OMAP_I2C_STAT_XUDF)) {
605 606
		omap_i2c_reset(dev);
		__omap_i2c_init(dev);
607 608 609 610 611 612
		return -EIO;
	}

	if (dev->cmd_err & OMAP_I2C_STAT_NACK) {
		if (msg->flags & I2C_M_IGNORE_NAK)
			return 0;
613 614 615 616

		w = omap_i2c_read_reg(dev, OMAP_I2C_CON_REG);
		w |= OMAP_I2C_CON_STP;
		omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
		return -EREMOTEIO;
	}
	return -EIO;
}


/*
 * Prepare controller for a transaction and call omap_i2c_xfer_msg
 * to do the work during IRQ processing.
 */
static int
omap_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
{
	struct omap_i2c_dev *dev = i2c_get_adapdata(adap);
	int i;
	int r;

634
	r = pm_runtime_get_sync(dev->dev);
635
	if (r < 0)
636
		goto out;
637

T
Tony Lindgren 已提交
638 639
	r = omap_i2c_wait_for_bb(dev);
	if (r < 0)
640 641
		goto out;

642 643
	if (dev->set_mpu_wkup_lat != NULL)
		dev->set_mpu_wkup_lat(dev->dev, dev->latency);
644

645 646 647 648 649 650 651 652
	for (i = 0; i < num; i++) {
		r = omap_i2c_xfer_msg(adap, &msgs[i], (i == (num - 1)));
		if (r != 0)
			break;
	}

	if (r == 0)
		r = num;
653 654

	omap_i2c_wait_for_bb(dev);
655 656 657 658

	if (dev->set_mpu_wkup_lat != NULL)
		dev->set_mpu_wkup_lat(dev->dev, -1);

659
out:
660 661
	pm_runtime_mark_last_busy(dev->dev);
	pm_runtime_put_autosuspend(dev->dev);
662 663 664 665 666 667
	return r;
}

static u32
omap_i2c_func(struct i2c_adapter *adap)
{
668 669
	return I2C_FUNC_I2C | (I2C_FUNC_SMBUS_EMUL & ~I2C_FUNC_SMBUS_QUICK) |
	       I2C_FUNC_PROTOCOL_MANGLING;
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
}

static inline void
omap_i2c_complete_cmd(struct omap_i2c_dev *dev, u16 err)
{
	dev->cmd_err |= err;
	complete(&dev->cmd_complete);
}

static inline void
omap_i2c_ack_stat(struct omap_i2c_dev *dev, u16 stat)
{
	omap_i2c_write_reg(dev, OMAP_I2C_STAT_REG, stat);
}

685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
static inline void i2c_omap_errata_i207(struct omap_i2c_dev *dev, u16 stat)
{
	/*
	 * I2C Errata(Errata Nos. OMAP2: 1.67, OMAP3: 1.8)
	 * Not applicable for OMAP4.
	 * Under certain rare conditions, RDR could be set again
	 * when the bus is busy, then ignore the interrupt and
	 * clear the interrupt.
	 */
	if (stat & OMAP_I2C_STAT_RDR) {
		/* Step 1: If RDR is set, clear it */
		omap_i2c_ack_stat(dev, OMAP_I2C_STAT_RDR);

		/* Step 2: */
		if (!(omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG)
						& OMAP_I2C_STAT_BB)) {

			/* Step 3: */
			if (omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG)
						& OMAP_I2C_STAT_RDR) {
				omap_i2c_ack_stat(dev, OMAP_I2C_STAT_RDR);
				dev_dbg(dev->dev, "RDR when bus is busy.\n");
			}

		}
	}
}

713 714 715
/* rev1 devices are apparently only on some 15xx */
#ifdef CONFIG_ARCH_OMAP15XX

716
static irqreturn_t
717
omap_i2c_omap1_isr(int this_irq, void *dev_id)
718 719 720 721
{
	struct omap_i2c_dev *dev = dev_id;
	u16 iv, w;

722
	if (pm_runtime_suspended(dev->dev))
T
Tony Lindgren 已提交
723 724
		return IRQ_NONE;

725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
	iv = omap_i2c_read_reg(dev, OMAP_I2C_IV_REG);
	switch (iv) {
	case 0x00:	/* None */
		break;
	case 0x01:	/* Arbitration lost */
		dev_err(dev->dev, "Arbitration lost\n");
		omap_i2c_complete_cmd(dev, OMAP_I2C_STAT_AL);
		break;
	case 0x02:	/* No acknowledgement */
		omap_i2c_complete_cmd(dev, OMAP_I2C_STAT_NACK);
		omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_STP);
		break;
	case 0x03:	/* Register access ready */
		omap_i2c_complete_cmd(dev, 0);
		break;
	case 0x04:	/* Receive data ready */
		if (dev->buf_len) {
			w = omap_i2c_read_reg(dev, OMAP_I2C_DATA_REG);
			*dev->buf++ = w;
			dev->buf_len--;
			if (dev->buf_len) {
				*dev->buf++ = w >> 8;
				dev->buf_len--;
			}
		} else
			dev_err(dev->dev, "RRDY IRQ while no data requested\n");
		break;
	case 0x05:	/* Transmit data ready */
		if (dev->buf_len) {
			w = *dev->buf++;
			dev->buf_len--;
			if (dev->buf_len) {
				w |= *dev->buf++ << 8;
				dev->buf_len--;
			}
			omap_i2c_write_reg(dev, OMAP_I2C_DATA_REG, w);
		} else
			dev_err(dev->dev, "XRDY IRQ while no data to send\n");
		break;
	default:
		return IRQ_NONE;
	}

	return IRQ_HANDLED;
}
770
#else
771
#define omap_i2c_omap1_isr		NULL
772
#endif
773

774
/*
775
 * OMAP3430 Errata i462: When an XRDY/XDR is hit, wait for XUDF before writing
776 777 778
 * data to DATA_REG. Otherwise some data bytes can be lost while transferring
 * them from the memory to the I2C interface.
 */
779
static int errata_omap3_i462(struct omap_i2c_dev *dev)
780
{
781
	unsigned long timeout = 10000;
782
	u16 stat;
783

784 785 786 787 788 789
	do {
		stat = omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG);
		if (stat & OMAP_I2C_STAT_XUDF)
			break;

		if (stat & (OMAP_I2C_STAT_NACK | OMAP_I2C_STAT_AL)) {
790
			omap_i2c_ack_stat(dev, (OMAP_I2C_STAT_XRDY |
791
							OMAP_I2C_STAT_XDR));
792 793 794 795 796 797 798 799
			if (stat & OMAP_I2C_STAT_NACK) {
				dev->cmd_err |= OMAP_I2C_STAT_NACK;
				omap_i2c_ack_stat(dev, OMAP_I2C_STAT_NACK);
			}

			if (stat & OMAP_I2C_STAT_AL) {
				dev_err(dev->dev, "Arbitration lost\n");
				dev->cmd_err |= OMAP_I2C_STAT_AL;
800
				omap_i2c_ack_stat(dev, OMAP_I2C_STAT_AL);
801 802
			}

803
			return -EIO;
804
		}
805

806
		cpu_relax();
807
	} while (--timeout);
808

809 810 811 812 813
	if (!timeout) {
		dev_err(dev->dev, "timeout waiting on XUDF bit\n");
		return 0;
	}

814 815 816
	return 0;
}

817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
static void omap_i2c_receive_data(struct omap_i2c_dev *dev, u8 num_bytes,
		bool is_rdr)
{
	u16		w;

	while (num_bytes--) {
		w = omap_i2c_read_reg(dev, OMAP_I2C_DATA_REG);
		*dev->buf++ = w;
		dev->buf_len--;

		/*
		 * Data reg in 2430, omap3 and
		 * omap4 is 8 bit wide
		 */
		if (dev->flags & OMAP_I2C_FLAG_16BIT_DATA_REG) {
832 833
			*dev->buf++ = w >> 8;
			dev->buf_len--;
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
		}
	}
}

static int omap_i2c_transmit_data(struct omap_i2c_dev *dev, u8 num_bytes,
		bool is_xdr)
{
	u16		w;

	while (num_bytes--) {
		w = *dev->buf++;
		dev->buf_len--;

		/*
		 * Data reg in 2430, omap3 and
		 * omap4 is 8 bit wide
		 */
		if (dev->flags & OMAP_I2C_FLAG_16BIT_DATA_REG) {
852 853
			w |= *dev->buf++ << 8;
			dev->buf_len--;
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
		}

		if (dev->errata & I2C_OMAP_ERRATA_I462) {
			int ret;

			ret = errata_omap3_i462(dev);
			if (ret < 0)
				return ret;
		}

		omap_i2c_write_reg(dev, OMAP_I2C_DATA_REG, w);
	}

	return 0;
}

870
static irqreturn_t
871
omap_i2c_isr(int irq, void *dev_id)
872 873
{
	struct omap_i2c_dev *dev = dev_id;
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
	irqreturn_t ret = IRQ_HANDLED;
	u16 mask;
	u16 stat;

	spin_lock(&dev->lock);
	mask = omap_i2c_read_reg(dev, OMAP_I2C_IE_REG);
	stat = omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG);

	if (stat & mask)
		ret = IRQ_WAKE_THREAD;

	spin_unlock(&dev->lock);

	return ret;
}

890
static irqreturn_t
891
omap_i2c_isr_thread(int this_irq, void *dev_id)
892 893
{
	struct omap_i2c_dev *dev = dev_id;
894
	unsigned long flags;
895
	u16 bits;
896
	u16 stat;
897
	int err = 0, count = 0;
898

899
	spin_lock_irqsave(&dev->lock, flags);
900 901 902 903 904
	do {
		bits = omap_i2c_read_reg(dev, OMAP_I2C_IE_REG);
		stat = omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG);
		stat &= bits;

905 906 907 908 909
		/* If we're in receiver mode, ignore XDR/XRDY */
		if (dev->receiver)
			stat &= ~(OMAP_I2C_STAT_XDR | OMAP_I2C_STAT_XRDY);
		else
			stat &= ~(OMAP_I2C_STAT_RDR | OMAP_I2C_STAT_RRDY);
910

911 912
		if (!stat) {
			/* my work here is done */
F
Felipe Balbi 已提交
913
			goto out;
914
		}
T
Tony Lindgren 已提交
915

916 917 918 919 920 921
		dev_dbg(dev->dev, "IRQ (ISR = 0x%04x)\n", stat);
		if (count++ == 100) {
			dev_warn(dev->dev, "Too much work in one IRQ\n");
			break;
		}

F
Felipe Balbi 已提交
922
		if (stat & OMAP_I2C_STAT_NACK) {
923
			err |= OMAP_I2C_STAT_NACK;
F
Felipe Balbi 已提交
924
			omap_i2c_ack_stat(dev, OMAP_I2C_STAT_NACK);
F
Felipe Balbi 已提交
925
			break;
F
Felipe Balbi 已提交
926
		}
J
Jan Weitzel 已提交
927

928 929 930
		if (stat & OMAP_I2C_STAT_AL) {
			dev_err(dev->dev, "Arbitration lost\n");
			err |= OMAP_I2C_STAT_AL;
F
Felipe Balbi 已提交
931
			omap_i2c_ack_stat(dev, OMAP_I2C_STAT_AL);
F
Felipe Balbi 已提交
932
			break;
933
		}
F
Felipe Balbi 已提交
934

935
		/*
936
		 * ProDB0017052: Clear ARDY bit twice
937
		 */
T
Taras Kondratiuk 已提交
938 939 940
		if (stat & OMAP_I2C_STAT_ARDY)
			omap_i2c_ack_stat(dev, OMAP_I2C_STAT_ARDY);

941
		if (stat & (OMAP_I2C_STAT_ARDY | OMAP_I2C_STAT_NACK |
942
					OMAP_I2C_STAT_AL)) {
943 944 945 946 947
			omap_i2c_ack_stat(dev, (OMAP_I2C_STAT_RRDY |
						OMAP_I2C_STAT_RDR |
						OMAP_I2C_STAT_XRDY |
						OMAP_I2C_STAT_XDR |
						OMAP_I2C_STAT_ARDY));
F
Felipe Balbi 已提交
948
			break;
949
		}
F
Felipe Balbi 已提交
950

951
		if (stat & OMAP_I2C_STAT_RDR) {
952
			u8 num_bytes = 1;
953

954 955 956
			if (dev->fifo_size)
				num_bytes = dev->buf_len;

957
			omap_i2c_receive_data(dev, num_bytes, true);
958

959 960 961
			if (dev->errata & I2C_OMAP_ERRATA_I207)
				i2c_omap_errata_i207(dev, stat);

962
			omap_i2c_ack_stat(dev, OMAP_I2C_STAT_RDR);
963
			continue;
964 965 966 967 968
		}

		if (stat & OMAP_I2C_STAT_RRDY) {
			u8 num_bytes = 1;

969 970
			if (dev->threshold)
				num_bytes = dev->threshold;
971

972
			omap_i2c_receive_data(dev, num_bytes, false);
973
			omap_i2c_ack_stat(dev, OMAP_I2C_STAT_RRDY);
974 975
			continue;
		}
F
Felipe Balbi 已提交
976

977
		if (stat & OMAP_I2C_STAT_XDR) {
978
			u8 num_bytes = 1;
979
			int ret;
980 981 982 983

			if (dev->fifo_size)
				num_bytes = dev->buf_len;

984 985
			ret = omap_i2c_transmit_data(dev, num_bytes, true);
			if (ret < 0)
F
Felipe Balbi 已提交
986
				break;
987 988

			omap_i2c_ack_stat(dev, OMAP_I2C_STAT_XDR);
989
			continue;
990 991 992 993
		}

		if (stat & OMAP_I2C_STAT_XRDY) {
			u8 num_bytes = 1;
994
			int ret;
995

996 997
			if (dev->threshold)
				num_bytes = dev->threshold;
998

999 1000
			ret = omap_i2c_transmit_data(dev, num_bytes, false);
			if (ret < 0)
F
Felipe Balbi 已提交
1001
				break;
1002 1003

			omap_i2c_ack_stat(dev, OMAP_I2C_STAT_XRDY);
1004 1005
			continue;
		}
F
Felipe Balbi 已提交
1006

1007 1008
		if (stat & OMAP_I2C_STAT_ROVR) {
			dev_err(dev->dev, "Receive overrun\n");
F
Felipe Balbi 已提交
1009 1010
			err |= OMAP_I2C_STAT_ROVR;
			omap_i2c_ack_stat(dev, OMAP_I2C_STAT_ROVR);
F
Felipe Balbi 已提交
1011
			break;
1012
		}
F
Felipe Balbi 已提交
1013

1014
		if (stat & OMAP_I2C_STAT_XUDF) {
1015
			dev_err(dev->dev, "Transmit underflow\n");
F
Felipe Balbi 已提交
1016 1017
			err |= OMAP_I2C_STAT_XUDF;
			omap_i2c_ack_stat(dev, OMAP_I2C_STAT_XUDF);
F
Felipe Balbi 已提交
1018
			break;
1019
		}
1020
	} while (stat);
1021

F
Felipe Balbi 已提交
1022
	omap_i2c_complete_cmd(dev, err);
F
Felipe Balbi 已提交
1023 1024

out:
1025
	spin_unlock_irqrestore(&dev->lock, flags);
1026

1027
	return IRQ_HANDLED;
1028 1029
}

1030
static const struct i2c_algorithm omap_i2c_algo = {
1031 1032 1033 1034
	.master_xfer	= omap_i2c_xfer,
	.functionality	= omap_i2c_func,
};

1035
#ifdef CONFIG_OF
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
static struct omap_i2c_bus_platform_data omap2420_pdata = {
	.rev = OMAP_I2C_IP_VERSION_1,
	.flags = OMAP_I2C_FLAG_NO_FIFO |
			OMAP_I2C_FLAG_SIMPLE_CLOCK |
			OMAP_I2C_FLAG_16BIT_DATA_REG |
			OMAP_I2C_FLAG_BUS_SHIFT_2,
};

static struct omap_i2c_bus_platform_data omap2430_pdata = {
	.rev = OMAP_I2C_IP_VERSION_1,
	.flags = OMAP_I2C_FLAG_BUS_SHIFT_2 |
			OMAP_I2C_FLAG_FORCE_19200_INT_CLK,
};

1050 1051
static struct omap_i2c_bus_platform_data omap3_pdata = {
	.rev = OMAP_I2C_IP_VERSION_1,
1052
	.flags = OMAP_I2C_FLAG_BUS_SHIFT_2,
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
};

static struct omap_i2c_bus_platform_data omap4_pdata = {
	.rev = OMAP_I2C_IP_VERSION_2,
};

static const struct of_device_id omap_i2c_of_match[] = {
	{
		.compatible = "ti,omap4-i2c",
		.data = &omap4_pdata,
	},
	{
		.compatible = "ti,omap3-i2c",
		.data = &omap3_pdata,
	},
1068 1069 1070 1071 1072 1073 1074 1075
	{
		.compatible = "ti,omap2430-i2c",
		.data = &omap2430_pdata,
	},
	{
		.compatible = "ti,omap2420-i2c",
		.data = &omap2420_pdata,
	},
1076 1077 1078 1079 1080
	{ },
};
MODULE_DEVICE_TABLE(of, omap_i2c_of_match);
#endif

1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
#define OMAP_I2C_SCHEME(rev)		((rev & 0xc000) >> 14)

#define OMAP_I2C_REV_SCHEME_0_MAJOR(rev) (rev >> 4)
#define OMAP_I2C_REV_SCHEME_0_MINOR(rev) (rev & 0xf)

#define OMAP_I2C_REV_SCHEME_1_MAJOR(rev) ((rev & 0x0700) >> 7)
#define OMAP_I2C_REV_SCHEME_1_MINOR(rev) (rev & 0x1f)
#define OMAP_I2C_SCHEME_0		0
#define OMAP_I2C_SCHEME_1		1

1091
static int
1092 1093 1094 1095
omap_i2c_probe(struct platform_device *pdev)
{
	struct omap_i2c_dev	*dev;
	struct i2c_adapter	*adap;
1096
	struct resource		*mem;
1097
	const struct omap_i2c_bus_platform_data *pdata =
J
Jingoo Han 已提交
1098
		dev_get_platdata(&pdev->dev);
1099 1100
	struct device_node	*node = pdev->dev.of_node;
	const struct of_device_id *match;
1101
	int irq;
1102
	int r;
1103
	u32 rev;
1104
	u16 minor, major;
1105

1106 1107
	irq = platform_get_irq(pdev, 0);
	if (irq < 0) {
1108
		dev_err(&pdev->dev, "no irq resource?\n");
1109
		return irq;
1110 1111
	}

F
Felipe Balbi 已提交
1112
	dev = devm_kzalloc(&pdev->dev, sizeof(struct omap_i2c_dev), GFP_KERNEL);
1113
	if (!dev)
F
Felipe Balbi 已提交
1114
		return -ENOMEM;
1115

1116
	mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1117 1118 1119
	dev->base = devm_ioremap_resource(&pdev->dev, mem);
	if (IS_ERR(dev->base))
		return PTR_ERR(dev->base);
1120

1121
	match = of_match_device(of_match_ptr(omap_i2c_of_match), &pdev->dev);
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
	if (match) {
		u32 freq = 100000; /* default to 100000 Hz */

		pdata = match->data;
		dev->flags = pdata->flags;

		of_property_read_u32(node, "clock-frequency", &freq);
		/* convert DT freq value in Hz into kHz for speed */
		dev->speed = freq / 1000;
	} else if (pdata != NULL) {
		dev->speed = pdata->clkrate;
		dev->flags = pdata->flags;
1134
		dev->set_mpu_wkup_lat = pdata->set_mpu_wkup_lat;
1135
	}
1136

1137
	dev->dev = &pdev->dev;
1138
	dev->irq = irq;
1139

1140
	spin_lock_init(&dev->lock);
1141

1142
	platform_set_drvdata(pdev, dev);
1143
	init_completion(&dev->cmd_complete);
1144

1145
	dev->reg_shift = (dev->flags >> OMAP_I2C_FLAG_BUS_SHIFT__SHIFT) & 3;
1146

1147
	pm_runtime_enable(dev->dev);
1148 1149 1150
	pm_runtime_set_autosuspend_delay(dev->dev, OMAP_I2C_PM_TIMEOUT);
	pm_runtime_use_autosuspend(dev->dev);

1151
	r = pm_runtime_get_sync(dev->dev);
1152
	if (r < 0)
1153
		goto err_free_mem;
1154

1155 1156 1157 1158
	/*
	 * Read the Rev hi bit-[15:14] ie scheme this is 1 indicates ver2.
	 * On omap1/3/2 Offset 4 is IE Reg the bit [15:14] is 0 at reset.
	 * Also since the omap_i2c_read_reg uses reg_map_ip_* a
1159
	 * readw_relaxed is done.
1160
	 */
1161
	rev = readw_relaxed(dev->base + 0x04);
1162

1163 1164
	dev->scheme = OMAP_I2C_SCHEME(rev);
	switch (dev->scheme) {
1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
	case OMAP_I2C_SCHEME_0:
		dev->regs = (u8 *)reg_map_ip_v1;
		dev->rev = omap_i2c_read_reg(dev, OMAP_I2C_REV_REG);
		minor = OMAP_I2C_REV_SCHEME_0_MAJOR(dev->rev);
		major = OMAP_I2C_REV_SCHEME_0_MAJOR(dev->rev);
		break;
	case OMAP_I2C_SCHEME_1:
		/* FALLTHROUGH */
	default:
		dev->regs = (u8 *)reg_map_ip_v2;
		rev = (rev << 16) |
			omap_i2c_read_reg(dev, OMAP_I2C_IP_V2_REVNB_LO);
		minor = OMAP_I2C_REV_SCHEME_1_MINOR(rev);
		major = OMAP_I2C_REV_SCHEME_1_MAJOR(rev);
		dev->rev = rev;
	}
1181

1182 1183
	dev->errata = 0;

1184 1185
	if (dev->rev >= OMAP_I2C_REV_ON_2430 &&
			dev->rev < OMAP_I2C_REV_ON_4430_PLUS)
1186 1187
		dev->errata |= I2C_OMAP_ERRATA_I207;

1188
	if (dev->rev <= OMAP_I2C_REV_ON_3430_3530)
1189
		dev->errata |= I2C_OMAP_ERRATA_I462;
1190

1191
	if (!(dev->flags & OMAP_I2C_FLAG_NO_FIFO)) {
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
		u16 s;

		/* Set up the fifo size - Get total size */
		s = (omap_i2c_read_reg(dev, OMAP_I2C_BUFSTAT_REG) >> 14) & 0x3;
		dev->fifo_size = 0x8 << s;

		/*
		 * Set up notification threshold as half the total available
		 * size. This is to ensure that we can handle the status on int
		 * call back latencies.
		 */
1203 1204 1205

		dev->fifo_size = (dev->fifo_size / 2);

1206
		if (dev->rev < OMAP_I2C_REV_ON_3630)
1207
			dev->b_hw = 1; /* Enable hardware fixes */
1208

1209
		/* calculate wakeup latency constraint for MPU */
1210 1211 1212
		if (dev->set_mpu_wkup_lat != NULL)
			dev->latency = (1000000 * dev->fifo_size) /
				       (1000 * dev->speed / 8);
1213 1214
	}

1215 1216 1217
	/* reset ASAP, clearing any IRQs */
	omap_i2c_init(dev);

1218 1219 1220 1221 1222 1223 1224 1225
	if (dev->rev < OMAP_I2C_OMAP1_REV_2)
		r = devm_request_irq(&pdev->dev, dev->irq, omap_i2c_omap1_isr,
				IRQF_NO_SUSPEND, pdev->name, dev);
	else
		r = devm_request_threaded_irq(&pdev->dev, dev->irq,
				omap_i2c_isr, omap_i2c_isr_thread,
				IRQF_NO_SUSPEND | IRQF_ONESHOT,
				pdev->name, dev);
1226 1227 1228 1229 1230

	if (r) {
		dev_err(dev->dev, "failure requesting irq %i\n", dev->irq);
		goto err_unuse_clocks;
	}
1231

1232 1233 1234
	adap = &dev->adapter;
	i2c_set_adapdata(adap, dev);
	adap->owner = THIS_MODULE;
1235
	adap->class = I2C_CLASS_DEPRECATED;
1236
	strlcpy(adap->name, "OMAP I2C adapter", sizeof(adap->name));
1237 1238
	adap->algo = &omap_i2c_algo;
	adap->dev.parent = &pdev->dev;
1239
	adap->dev.of_node = pdev->dev.of_node;
1240 1241

	/* i2c device drivers may be active on return from add_adapter() */
1242 1243
	adap->nr = pdev->id;
	r = i2c_add_numbered_adapter(adap);
1244 1245
	if (r) {
		dev_err(dev->dev, "failure adding adapter\n");
F
Felipe Balbi 已提交
1246
		goto err_unuse_clocks;
1247 1248
	}

S
Shubhrajyoti D 已提交
1249 1250
	dev_info(dev->dev, "bus %d rev%d.%d at %d kHz\n", adap->nr,
		 major, minor, dev->speed);
1251

1252 1253
	pm_runtime_mark_last_busy(dev->dev);
	pm_runtime_put_autosuspend(dev->dev);
1254

1255 1256 1257
	return 0;

err_unuse_clocks:
1258
	omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
1259
	pm_runtime_put(dev->dev);
1260
	pm_runtime_disable(&pdev->dev);
1261 1262 1263 1264 1265
err_free_mem:

	return r;
}

1266
static int omap_i2c_remove(struct platform_device *pdev)
1267 1268
{
	struct omap_i2c_dev	*dev = platform_get_drvdata(pdev);
1269
	int ret;
1270 1271

	i2c_del_adapter(&dev->adapter);
1272
	ret = pm_runtime_get_sync(&pdev->dev);
1273
	if (ret < 0)
1274 1275
		return ret;

1276
	omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
1277
	pm_runtime_put(&pdev->dev);
1278
	pm_runtime_disable(&pdev->dev);
1279 1280 1281
	return 0;
}

1282
#ifdef CONFIG_PM
1283 1284 1285 1286 1287
#ifdef CONFIG_PM_RUNTIME
static int omap_i2c_runtime_suspend(struct device *dev)
{
	struct platform_device *pdev = to_platform_device(dev);
	struct omap_i2c_dev *_dev = platform_get_drvdata(pdev);
1288 1289

	_dev->iestate = omap_i2c_read_reg(_dev, OMAP_I2C_IE_REG);
1290

1291 1292 1293 1294 1295
	if (_dev->scheme == OMAP_I2C_SCHEME_0)
		omap_i2c_write_reg(_dev, OMAP_I2C_IE_REG, 0);
	else
		omap_i2c_write_reg(_dev, OMAP_I2C_IP_V2_IRQENABLE_CLR,
				   OMAP_I2C_IP_V2_INTERRUPTS_MASK);
1296

1297
	if (_dev->rev < OMAP_I2C_OMAP1_REV_2) {
1298
		omap_i2c_read_reg(_dev, OMAP_I2C_IV_REG); /* Read clears */
1299 1300
	} else {
		omap_i2c_write_reg(_dev, OMAP_I2C_STAT_REG, _dev->iestate);
1301

1302 1303 1304
		/* Flush posted write */
		omap_i2c_read_reg(_dev, OMAP_I2C_STAT_REG);
	}
1305 1306 1307 1308 1309 1310 1311 1312 1313

	return 0;
}

static int omap_i2c_runtime_resume(struct device *dev)
{
	struct platform_device *pdev = to_platform_device(dev);
	struct omap_i2c_dev *_dev = platform_get_drvdata(pdev);

1314 1315 1316
	if (!_dev->regs)
		return 0;

1317
	__omap_i2c_init(_dev);
1318 1319 1320

	return 0;
}
1321
#endif /* CONFIG_PM_RUNTIME */
1322 1323

static struct dev_pm_ops omap_i2c_pm_ops = {
1324 1325
	SET_RUNTIME_PM_OPS(omap_i2c_runtime_suspend,
			   omap_i2c_runtime_resume, NULL)
1326 1327 1328 1329
};
#define OMAP_I2C_PM_OPS (&omap_i2c_pm_ops)
#else
#define OMAP_I2C_PM_OPS NULL
1330
#endif /* CONFIG_PM */
1331

1332 1333
static struct platform_driver omap_i2c_driver = {
	.probe		= omap_i2c_probe,
1334
	.remove		= omap_i2c_remove,
1335
	.driver		= {
1336
		.name	= "omap_i2c",
1337
		.owner	= THIS_MODULE,
1338
		.pm	= OMAP_I2C_PM_OPS,
1339
		.of_match_table = of_match_ptr(omap_i2c_of_match),
1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359
	},
};

/* I2C may be needed to bring up other drivers */
static int __init
omap_i2c_init_driver(void)
{
	return platform_driver_register(&omap_i2c_driver);
}
subsys_initcall(omap_i2c_init_driver);

static void __exit omap_i2c_exit_driver(void)
{
	platform_driver_unregister(&omap_i2c_driver);
}
module_exit(omap_i2c_exit_driver);

MODULE_AUTHOR("MontaVista Software, Inc. (and others)");
MODULE_DESCRIPTION("TI OMAP I2C bus adapter");
MODULE_LICENSE("GPL");
1360
MODULE_ALIAS("platform:omap_i2c");