i2c-imx.c 22.6 KB
Newer Older
D
Darius Augulis 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
/*
 *	Copyright (C) 2002 Motorola GSG-China
 *
 *	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.
 *
 * Author:
 *	Darius Augulis, Teltonika Inc.
 *
 * Desc.:
 *	Implementation of I2C Adapter/Algorithm Driver
 *	for I2C Bus integrated in Freescale i.MX/MXC processors
 *
 *	Derived from Motorola GSG China I2C example driver
 *
 *	Copyright (C) 2005 Torsten Koschorrek <koschorrek at synertronixx.de
 *	Copyright (C) 2005 Matthias Blaschke <blaschke at synertronixx.de
 *	Copyright (C) 2007 RightHand Technologies, Inc.
 *	Copyright (C) 2008 Darius Augulis <darius.augulis at teltonika.lt>
 *
28 29
 *	Copyright 2013 Freescale Semiconductor, Inc.
 *
D
Darius Augulis 已提交
30 31 32 33 34
 */

/** Includes *******************************************************************
*******************************************************************************/

35
#include <linux/clk.h>
D
Darius Augulis 已提交
36
#include <linux/delay.h>
37 38
#include <linux/err.h>
#include <linux/errno.h>
D
Darius Augulis 已提交
39
#include <linux/i2c.h>
40 41
#include <linux/init.h>
#include <linux/interrupt.h>
D
Darius Augulis 已提交
42
#include <linux/io.h>
43 44
#include <linux/kernel.h>
#include <linux/module.h>
45 46
#include <linux/of.h>
#include <linux/of_device.h>
47
#include <linux/platform_data/i2c-imx.h>
48 49 50
#include <linux/platform_device.h>
#include <linux/sched.h>
#include <linux/slab.h>
D
Darius Augulis 已提交
51 52 53 54 55 56 57 58 59 60

/** Defines ********************************************************************
*******************************************************************************/

/* This will be the driver name the kernel reports */
#define DRIVER_NAME "imx-i2c"

/* Default value */
#define IMX_I2C_BIT_RATE	100000	/* 100kHz */

61 62 63 64 65 66 67 68
/* IMX I2C registers:
 * the I2C register offset is different between SoCs,
 * to provid support for all these chips, split the
 * register offset into a fixed base address and a
 * variable shift value, then the full register offset
 * will be calculated by
 * reg_off = ( reg_base_addr << reg_shift)
 */
D
Darius Augulis 已提交
69
#define IMX_I2C_IADR	0x00	/* i2c slave address */
70 71 72 73 74 75
#define IMX_I2C_IFDR	0x01	/* i2c frequency divider */
#define IMX_I2C_I2CR	0x02	/* i2c control */
#define IMX_I2C_I2SR	0x03	/* i2c status */
#define IMX_I2C_I2DR	0x04	/* i2c transfer data */

#define IMX_I2C_REGSHIFT	2
76
#define VF610_I2C_REGSHIFT	0
D
Darius Augulis 已提交
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92

/* Bits of IMX I2C registers */
#define I2SR_RXAK	0x01
#define I2SR_IIF	0x02
#define I2SR_SRW	0x04
#define I2SR_IAL	0x10
#define I2SR_IBB	0x20
#define I2SR_IAAS	0x40
#define I2SR_ICF	0x80
#define I2CR_RSTA	0x04
#define I2CR_TXAK	0x08
#define I2CR_MTX	0x10
#define I2CR_MSTA	0x20
#define I2CR_IIEN	0x40
#define I2CR_IEN	0x80

93 94 95 96 97 98 99 100 101 102 103 104 105
/* register bits different operating codes definition:
 * 1) I2SR: Interrupt flags clear operation differ between SoCs:
 * - write zero to clear(w0c) INT flag on i.MX,
 * - but write one to clear(w1c) INT flag on Vybrid.
 * 2) I2CR: I2C module enable operation also differ between SoCs:
 * - set I2CR_IEN bit enable the module on i.MX,
 * - but clear I2CR_IEN bit enable the module on Vybrid.
 */
#define I2SR_CLR_OPCODE_W0C	0x0
#define I2SR_CLR_OPCODE_W1C	(I2SR_IAL | I2SR_IIF)
#define I2CR_IEN_OPCODE_0	0x0
#define I2CR_IEN_OPCODE_1	I2CR_IEN

D
Darius Augulis 已提交
106 107 108 109 110 111 112 113 114 115 116
/** Variables ******************************************************************
*******************************************************************************/

/*
 * sorted list of clock divider, register value pairs
 * taken from table 26-5, p.26-9, Freescale i.MX
 * Integrated Portable System Processor Reference Manual
 * Document Number: MC9328MXLRM, Rev. 5.1, 06/2007
 *
 * Duplicated divider values removed from list
 */
117 118 119 120
struct imx_i2c_clk_pair {
	u16	div;
	u16	val;
};
D
Darius Augulis 已提交
121

122
static struct imx_i2c_clk_pair imx_i2c_clk_div[] = {
D
Darius Augulis 已提交
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
	{ 22,	0x20 }, { 24,	0x21 }, { 26,	0x22 }, { 28,	0x23 },
	{ 30,	0x00 },	{ 32,	0x24 }, { 36,	0x25 }, { 40,	0x26 },
	{ 42,	0x03 }, { 44,	0x27 },	{ 48,	0x28 }, { 52,	0x05 },
	{ 56,	0x29 }, { 60,	0x06 }, { 64,	0x2A },	{ 72,	0x2B },
	{ 80,	0x2C }, { 88,	0x09 }, { 96,	0x2D }, { 104,	0x0A },
	{ 112,	0x2E }, { 128,	0x2F }, { 144,	0x0C }, { 160,	0x30 },
	{ 192,	0x31 },	{ 224,	0x32 }, { 240,	0x0F }, { 256,	0x33 },
	{ 288,	0x10 }, { 320,	0x34 },	{ 384,	0x35 }, { 448,	0x36 },
	{ 480,	0x13 }, { 512,	0x37 }, { 576,	0x14 },	{ 640,	0x38 },
	{ 768,	0x39 }, { 896,	0x3A }, { 960,	0x17 }, { 1024,	0x3B },
	{ 1152,	0x18 }, { 1280,	0x3C }, { 1536,	0x3D }, { 1792,	0x3E },
	{ 1920,	0x1B },	{ 2048,	0x3F }, { 2304,	0x1C }, { 2560,	0x1D },
	{ 3072,	0x1E }, { 3840,	0x1F }
};

138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
/* Vybrid VF610 clock divider, register value pairs */
static struct imx_i2c_clk_pair vf610_i2c_clk_div[] = {
	{ 20,   0x00 }, { 22,   0x01 }, { 24,   0x02 }, { 26,   0x03 },
	{ 28,   0x04 }, { 30,   0x05 }, { 32,   0x09 }, { 34,   0x06 },
	{ 36,   0x0A }, { 40,   0x07 }, { 44,   0x0C }, { 48,   0x0D },
	{ 52,   0x43 }, { 56,   0x0E }, { 60,   0x45 }, { 64,   0x12 },
	{ 68,   0x0F }, { 72,   0x13 }, { 80,   0x14 }, { 88,   0x15 },
	{ 96,   0x19 }, { 104,  0x16 }, { 112,  0x1A }, { 128,  0x17 },
	{ 136,  0x4F }, { 144,  0x1C }, { 160,  0x1D }, { 176,  0x55 },
	{ 192,  0x1E }, { 208,  0x56 }, { 224,  0x22 }, { 228,  0x24 },
	{ 240,  0x1F }, { 256,  0x23 }, { 288,  0x5C }, { 320,  0x25 },
	{ 384,  0x26 }, { 448,  0x2A }, { 480,  0x27 }, { 512,  0x2B },
	{ 576,  0x2C }, { 640,  0x2D }, { 768,  0x31 }, { 896,  0x32 },
	{ 960,  0x2F }, { 1024, 0x33 }, { 1152, 0x34 }, { 1280, 0x35 },
	{ 1536, 0x36 }, { 1792, 0x3A }, { 1920, 0x37 }, { 2048, 0x3B },
	{ 2304, 0x3C }, { 2560, 0x3D }, { 3072, 0x3E }, { 3584, 0x7A },
	{ 3840, 0x3F }, { 4096, 0x7B }, { 5120, 0x7D }, { 6144, 0x7E },
};

157 158 159
enum imx_i2c_type {
	IMX1_I2C,
	IMX21_I2C,
160
	VF610_I2C,
161 162
};

163 164 165 166 167 168 169 170 171
struct imx_i2c_hwdata {
	enum imx_i2c_type	devtype;
	unsigned		regshift;
	struct imx_i2c_clk_pair	*clk_div;
	unsigned		ndivs;
	unsigned		i2sr_clr_opcode;
	unsigned		i2cr_ien_opcode;
};

D
Darius Augulis 已提交
172 173 174 175 176 177
struct imx_i2c_struct {
	struct i2c_adapter	adapter;
	struct clk		*clk;
	void __iomem		*base;
	wait_queue_head_t	queue;
	unsigned long		i2csr;
178
	unsigned int 		disable_delay;
179
	int			stopped;
180
	unsigned int		ifdr; /* IMX_I2C_IFDR */
181 182
	unsigned int		cur_clk;
	unsigned int		bitrate;
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
	const struct imx_i2c_hwdata	*hwdata;
};

static const struct imx_i2c_hwdata imx1_i2c_hwdata  = {
	.devtype		= IMX1_I2C,
	.regshift		= IMX_I2C_REGSHIFT,
	.clk_div		= imx_i2c_clk_div,
	.ndivs			= ARRAY_SIZE(imx_i2c_clk_div),
	.i2sr_clr_opcode	= I2SR_CLR_OPCODE_W0C,
	.i2cr_ien_opcode	= I2CR_IEN_OPCODE_1,

};

static const struct imx_i2c_hwdata imx21_i2c_hwdata  = {
	.devtype		= IMX21_I2C,
	.regshift		= IMX_I2C_REGSHIFT,
	.clk_div		= imx_i2c_clk_div,
	.ndivs			= ARRAY_SIZE(imx_i2c_clk_div),
	.i2sr_clr_opcode	= I2SR_CLR_OPCODE_W0C,
	.i2cr_ien_opcode	= I2CR_IEN_OPCODE_1,

204 205
};

206 207 208 209 210 211 212 213 214 215
static struct imx_i2c_hwdata vf610_i2c_hwdata = {
	.devtype		= VF610_I2C,
	.regshift		= VF610_I2C_REGSHIFT,
	.clk_div		= vf610_i2c_clk_div,
	.ndivs			= ARRAY_SIZE(vf610_i2c_clk_div),
	.i2sr_clr_opcode	= I2SR_CLR_OPCODE_W1C,
	.i2cr_ien_opcode	= I2CR_IEN_OPCODE_0,

};

216 217 218
static struct platform_device_id imx_i2c_devtype[] = {
	{
		.name = "imx1-i2c",
219
		.driver_data = (kernel_ulong_t)&imx1_i2c_hwdata,
220 221
	}, {
		.name = "imx21-i2c",
222
		.driver_data = (kernel_ulong_t)&imx21_i2c_hwdata,
223 224 225
	}, {
		/* sentinel */
	}
D
Darius Augulis 已提交
226
};
227
MODULE_DEVICE_TABLE(platform, imx_i2c_devtype);
D
Darius Augulis 已提交
228

229
static const struct of_device_id i2c_imx_dt_ids[] = {
230 231
	{ .compatible = "fsl,imx1-i2c", .data = &imx1_i2c_hwdata, },
	{ .compatible = "fsl,imx21-i2c", .data = &imx21_i2c_hwdata, },
232
	{ .compatible = "fsl,vf610-i2c", .data = &vf610_i2c_hwdata, },
233 234
	{ /* sentinel */ }
};
235
MODULE_DEVICE_TABLE(of, i2c_imx_dt_ids);
236

237 238
static inline int is_imx1_i2c(struct imx_i2c_struct *i2c_imx)
{
239
	return i2c_imx->hwdata->devtype == IMX1_I2C;
240 241
}

242 243 244
static inline void imx_i2c_write_reg(unsigned int val,
		struct imx_i2c_struct *i2c_imx, unsigned int reg)
{
245
	writeb(val, i2c_imx->base + (reg << i2c_imx->hwdata->regshift));
246 247 248 249 250
}

static inline unsigned char imx_i2c_read_reg(struct imx_i2c_struct *i2c_imx,
		unsigned int reg)
{
251
	return readb(i2c_imx->base + (reg << i2c_imx->hwdata->regshift));
252 253
}

D
Darius Augulis 已提交
254 255 256
/** Functions for IMX I2C adapter driver ***************************************
*******************************************************************************/

257
static int i2c_imx_bus_busy(struct imx_i2c_struct *i2c_imx, int for_busy)
D
Darius Augulis 已提交
258 259
{
	unsigned long orig_jiffies = jiffies;
260
	unsigned int temp;
D
Darius Augulis 已提交
261 262 263

	dev_dbg(&i2c_imx->adapter.dev, "<%s>\n", __func__);

264
	while (1) {
265
		temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2SR);
266 267 268 269 270 271 272 273

		/* check for arbitration lost */
		if (temp & I2SR_IAL) {
			temp &= ~I2SR_IAL;
			imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2SR);
			return -EAGAIN;
		}

274 275 276 277
		if (for_busy && (temp & I2SR_IBB))
			break;
		if (!for_busy && !(temp & I2SR_IBB))
			break;
A
Arnaud Patard 已提交
278
		if (time_after(jiffies, orig_jiffies + msecs_to_jiffies(500))) {
D
Darius Augulis 已提交
279 280
			dev_dbg(&i2c_imx->adapter.dev,
				"<%s> I2C bus is busy\n", __func__);
A
Arnaud Patard 已提交
281
			return -ETIMEDOUT;
D
Darius Augulis 已提交
282 283 284 285 286 287 288 289 290
		}
		schedule();
	}

	return 0;
}

static int i2c_imx_trx_complete(struct imx_i2c_struct *i2c_imx)
{
291
	wait_event_timeout(i2c_imx->queue, i2c_imx->i2csr & I2SR_IIF, HZ / 10);
D
Darius Augulis 已提交
292

293
	if (unlikely(!(i2c_imx->i2csr & I2SR_IIF))) {
D
Darius Augulis 已提交
294 295 296 297 298 299 300 301 302 303
		dev_dbg(&i2c_imx->adapter.dev, "<%s> Timeout\n", __func__);
		return -ETIMEDOUT;
	}
	dev_dbg(&i2c_imx->adapter.dev, "<%s> TRX complete\n", __func__);
	i2c_imx->i2csr = 0;
	return 0;
}

static int i2c_imx_acked(struct imx_i2c_struct *i2c_imx)
{
304
	if (imx_i2c_read_reg(i2c_imx, IMX_I2C_I2SR) & I2SR_RXAK) {
D
Darius Augulis 已提交
305 306 307 308 309 310 311 312
		dev_dbg(&i2c_imx->adapter.dev, "<%s> No ACK\n", __func__);
		return -EIO;  /* No ACK */
	}

	dev_dbg(&i2c_imx->adapter.dev, "<%s> ACK received\n", __func__);
	return 0;
}

313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
static void i2c_imx_set_clk(struct imx_i2c_struct *i2c_imx)
{
	struct imx_i2c_clk_pair *i2c_clk_div = i2c_imx->hwdata->clk_div;
	unsigned int i2c_clk_rate;
	unsigned int div;
	int i;

	/* Divider value calculation */
	i2c_clk_rate = clk_get_rate(i2c_imx->clk);
	if (i2c_imx->cur_clk == i2c_clk_rate)
		return;
	else
		i2c_imx->cur_clk = i2c_clk_rate;

	div = (i2c_clk_rate + i2c_imx->bitrate - 1) / i2c_imx->bitrate;
	if (div < i2c_clk_div[0].div)
		i = 0;
	else if (div > i2c_clk_div[i2c_imx->hwdata->ndivs - 1].div)
		i = i2c_imx->hwdata->ndivs - 1;
	else
		for (i = 0; i2c_clk_div[i].div < div; i++);

	/* Store divider value */
	i2c_imx->ifdr = i2c_clk_div[i].val;

	/*
	 * There dummy delay is calculated.
	 * It should be about one I2C clock period long.
	 * This delay is used in I2C bus disable function
	 * to fix chip hardware bug.
	 */
	i2c_imx->disable_delay = (500000U * i2c_clk_div[i].div
		+ (i2c_clk_rate / 2) - 1) / (i2c_clk_rate / 2);

#ifdef CONFIG_I2C_DEBUG_BUS
	dev_dbg(&i2c_imx->adapter.dev, "I2C_CLK=%d, REQ DIV=%d\n",
		i2c_clk_rate, div);
	dev_dbg(&i2c_imx->adapter.dev, "IFDR[IC]=0x%x, REAL DIV=%d\n",
		i2c_clk_div[i].val, i2c_clk_div[i].div);
#endif
}

355
static int i2c_imx_start(struct imx_i2c_struct *i2c_imx)
D
Darius Augulis 已提交
356 357
{
	unsigned int temp = 0;
358
	int result;
D
Darius Augulis 已提交
359 360 361

	dev_dbg(&i2c_imx->adapter.dev, "<%s>\n", __func__);

362 363
	i2c_imx_set_clk(i2c_imx);

364 365 366
	result = clk_prepare_enable(i2c_imx->clk);
	if (result)
		return result;
367
	imx_i2c_write_reg(i2c_imx->ifdr, i2c_imx, IMX_I2C_IFDR);
D
Darius Augulis 已提交
368
	/* Enable I2C controller */
369 370
	imx_i2c_write_reg(i2c_imx->hwdata->i2sr_clr_opcode, i2c_imx, IMX_I2C_I2SR);
	imx_i2c_write_reg(i2c_imx->hwdata->i2cr_ien_opcode, i2c_imx, IMX_I2C_I2CR);
371 372 373 374

	/* Wait controller to be stable */
	udelay(50);

D
Darius Augulis 已提交
375
	/* Start I2C transaction */
376
	temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
D
Darius Augulis 已提交
377
	temp |= I2CR_MSTA;
378
	imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
379 380 381 382 383
	result = i2c_imx_bus_busy(i2c_imx, 1);
	if (result)
		return result;
	i2c_imx->stopped = 0;

D
Darius Augulis 已提交
384
	temp |= I2CR_IIEN | I2CR_MTX | I2CR_TXAK;
385
	imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
386
	return result;
D
Darius Augulis 已提交
387 388 389 390 391 392
}

static void i2c_imx_stop(struct imx_i2c_struct *i2c_imx)
{
	unsigned int temp = 0;

393 394 395
	if (!i2c_imx->stopped) {
		/* Stop I2C transaction */
		dev_dbg(&i2c_imx->adapter.dev, "<%s>\n", __func__);
396
		temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
397
		temp &= ~(I2CR_MSTA | I2CR_MTX);
398
		imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
399
	}
400
	if (is_imx1_i2c(i2c_imx)) {
401 402 403 404 405 406
		/*
		 * This delay caused by an i.MXL hardware bug.
		 * If no (or too short) delay, no "STOP" bit will be generated.
		 */
		udelay(i2c_imx->disable_delay);
	}
407

408
	if (!i2c_imx->stopped) {
409
		i2c_imx_bus_busy(i2c_imx, 0);
410 411
		i2c_imx->stopped = 1;
	}
412

D
Darius Augulis 已提交
413
	/* Disable I2C controller */
414 415
	temp = i2c_imx->hwdata->i2cr_ien_opcode ^ I2CR_IEN,
	imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
416
	clk_disable_unprepare(i2c_imx->clk);
D
Darius Augulis 已提交
417 418 419 420 421 422 423
}

static irqreturn_t i2c_imx_isr(int irq, void *dev_id)
{
	struct imx_i2c_struct *i2c_imx = dev_id;
	unsigned int temp;

424
	temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2SR);
D
Darius Augulis 已提交
425 426 427 428
	if (temp & I2SR_IIF) {
		/* save status register */
		i2c_imx->i2csr = temp;
		temp &= ~I2SR_IIF;
429
		temp |= (i2c_imx->hwdata->i2sr_clr_opcode & I2SR_IIF);
430
		imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2SR);
431
		wake_up(&i2c_imx->queue);
D
Darius Augulis 已提交
432 433 434 435 436 437 438 439 440 441 442 443 444 445
		return IRQ_HANDLED;
	}

	return IRQ_NONE;
}

static int i2c_imx_write(struct imx_i2c_struct *i2c_imx, struct i2c_msg *msgs)
{
	int i, result;

	dev_dbg(&i2c_imx->adapter.dev, "<%s> write slave address: addr=0x%x\n",
		__func__, msgs->addr << 1);

	/* write slave address */
446
	imx_i2c_write_reg(msgs->addr << 1, i2c_imx, IMX_I2C_I2DR);
D
Darius Augulis 已提交
447 448 449 450 451 452 453 454 455 456 457 458 459
	result = i2c_imx_trx_complete(i2c_imx);
	if (result)
		return result;
	result = i2c_imx_acked(i2c_imx);
	if (result)
		return result;
	dev_dbg(&i2c_imx->adapter.dev, "<%s> write data\n", __func__);

	/* write data */
	for (i = 0; i < msgs->len; i++) {
		dev_dbg(&i2c_imx->adapter.dev,
			"<%s> write byte: B%d=0x%X\n",
			__func__, i, msgs->buf[i]);
460
		imx_i2c_write_reg(msgs->buf[i], i2c_imx, IMX_I2C_I2DR);
D
Darius Augulis 已提交
461 462 463 464 465 466 467 468 469 470
		result = i2c_imx_trx_complete(i2c_imx);
		if (result)
			return result;
		result = i2c_imx_acked(i2c_imx);
		if (result)
			return result;
	}
	return 0;
}

471
static int i2c_imx_read(struct imx_i2c_struct *i2c_imx, struct i2c_msg *msgs, bool is_lastmsg)
D
Darius Augulis 已提交
472 473 474
{
	int i, result;
	unsigned int temp;
475
	int block_data = msgs->flags & I2C_M_RECV_LEN;
D
Darius Augulis 已提交
476 477 478 479 480 481

	dev_dbg(&i2c_imx->adapter.dev,
		"<%s> write slave address: addr=0x%x\n",
		__func__, (msgs->addr << 1) | 0x01);

	/* write slave address */
482
	imx_i2c_write_reg((msgs->addr << 1) | 0x01, i2c_imx, IMX_I2C_I2DR);
D
Darius Augulis 已提交
483 484 485 486 487 488 489 490 491 492
	result = i2c_imx_trx_complete(i2c_imx);
	if (result)
		return result;
	result = i2c_imx_acked(i2c_imx);
	if (result)
		return result;

	dev_dbg(&i2c_imx->adapter.dev, "<%s> setup bus\n", __func__);

	/* setup bus to read data */
493
	temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
D
Darius Augulis 已提交
494
	temp &= ~I2CR_MTX;
495 496 497 498 499 500

	/*
	 * Reset the I2CR_TXAK flag initially for SMBus block read since the
	 * length is unknown
	 */
	if ((msgs->len - 1) || block_data)
D
Darius Augulis 已提交
501
		temp &= ~I2CR_TXAK;
502 503
	imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
	imx_i2c_read_reg(i2c_imx, IMX_I2C_I2DR); /* dummy read */
D
Darius Augulis 已提交
504 505 506 507 508

	dev_dbg(&i2c_imx->adapter.dev, "<%s> read data\n", __func__);

	/* read data */
	for (i = 0; i < msgs->len; i++) {
509
		u8 len = 0;
D
Darius Augulis 已提交
510 511 512
		result = i2c_imx_trx_complete(i2c_imx);
		if (result)
			return result;
513 514 515 516 517 518 519 520 521 522 523 524 525 526
		/*
		 * First byte is the length of remaining packet
		 * in the SMBus block data read. Add it to
		 * msgs->len.
		 */
		if ((!i) && block_data) {
			len = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2DR);
			if ((len == 0) || (len > I2C_SMBUS_BLOCK_MAX))
				return -EPROTO;
			dev_dbg(&i2c_imx->adapter.dev,
				"<%s> read length: 0x%X\n",
				__func__, len);
			msgs->len += len;
		}
D
Darius Augulis 已提交
527
		if (i == (msgs->len - 1)) {
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
			if (is_lastmsg) {
				/*
				 * It must generate STOP before read I2DR to prevent
				 * controller from generating another clock cycle
				 */
				dev_dbg(&i2c_imx->adapter.dev,
					"<%s> clear MSTA\n", __func__);
				temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
				temp &= ~(I2CR_MSTA | I2CR_MTX);
				imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
				i2c_imx_bus_busy(i2c_imx, 0);
				i2c_imx->stopped = 1;
			} else {
				/*
				 * For i2c master receiver repeat restart operation like:
				 * read -> repeat MSTA -> read/write
				 * The controller must set MTX before read the last byte in
				 * the first read operation, otherwise the first read cost
				 * one extra clock cycle.
				 */
				temp = readb(i2c_imx->base + IMX_I2C_I2CR);
				temp |= I2CR_MTX;
				writeb(temp, i2c_imx->base + IMX_I2C_I2CR);
			}
D
Darius Augulis 已提交
552 553 554
		} else if (i == (msgs->len - 2)) {
			dev_dbg(&i2c_imx->adapter.dev,
				"<%s> set TXAK\n", __func__);
555
			temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
D
Darius Augulis 已提交
556
			temp |= I2CR_TXAK;
557
			imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
D
Darius Augulis 已提交
558
		}
559 560 561 562
		if ((!i) && block_data)
			msgs->buf[0] = len;
		else
			msgs->buf[i] =  imx_i2c_read_reg(i2c_imx, IMX_I2C_I2DR);
D
Darius Augulis 已提交
563 564 565 566 567 568 569 570 571 572 573 574
		dev_dbg(&i2c_imx->adapter.dev,
			"<%s> read byte: B%d=0x%X\n",
			__func__, i, msgs->buf[i]);
	}
	return 0;
}

static int i2c_imx_xfer(struct i2c_adapter *adapter,
						struct i2c_msg *msgs, int num)
{
	unsigned int i, temp;
	int result;
575
	bool is_lastmsg = false;
D
Darius Augulis 已提交
576 577 578 579
	struct imx_i2c_struct *i2c_imx = i2c_get_adapdata(adapter);

	dev_dbg(&i2c_imx->adapter.dev, "<%s>\n", __func__);

580 581
	/* Start I2C transfer */
	result = i2c_imx_start(i2c_imx);
D
Darius Augulis 已提交
582 583 584 585 586
	if (result)
		goto fail0;

	/* read/write data */
	for (i = 0; i < num; i++) {
587 588 589
		if (i == num - 1)
			is_lastmsg = true;

D
Darius Augulis 已提交
590 591 592
		if (i) {
			dev_dbg(&i2c_imx->adapter.dev,
				"<%s> repeated start\n", __func__);
593
			temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
D
Darius Augulis 已提交
594
			temp |= I2CR_RSTA;
595
			imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
596 597 598
			result =  i2c_imx_bus_busy(i2c_imx, 1);
			if (result)
				goto fail0;
D
Darius Augulis 已提交
599 600 601 602 603
		}
		dev_dbg(&i2c_imx->adapter.dev,
			"<%s> transfer message: %d\n", __func__, i);
		/* write/read data */
#ifdef CONFIG_I2C_DEBUG_BUS
604
		temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
D
Darius Augulis 已提交
605 606 607 608 609
		dev_dbg(&i2c_imx->adapter.dev, "<%s> CONTROL: IEN=%d, IIEN=%d, "
			"MSTA=%d, MTX=%d, TXAK=%d, RSTA=%d\n", __func__,
			(temp & I2CR_IEN ? 1 : 0), (temp & I2CR_IIEN ? 1 : 0),
			(temp & I2CR_MSTA ? 1 : 0), (temp & I2CR_MTX ? 1 : 0),
			(temp & I2CR_TXAK ? 1 : 0), (temp & I2CR_RSTA ? 1 : 0));
610
		temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2SR);
D
Darius Augulis 已提交
611 612 613 614 615 616 617 618 619
		dev_dbg(&i2c_imx->adapter.dev,
			"<%s> STATUS: ICF=%d, IAAS=%d, IBB=%d, "
			"IAL=%d, SRW=%d, IIF=%d, RXAK=%d\n", __func__,
			(temp & I2SR_ICF ? 1 : 0), (temp & I2SR_IAAS ? 1 : 0),
			(temp & I2SR_IBB ? 1 : 0), (temp & I2SR_IAL ? 1 : 0),
			(temp & I2SR_SRW ? 1 : 0), (temp & I2SR_IIF ? 1 : 0),
			(temp & I2SR_RXAK ? 1 : 0));
#endif
		if (msgs[i].flags & I2C_M_RD)
620
			result = i2c_imx_read(i2c_imx, &msgs[i], is_lastmsg);
D
Darius Augulis 已提交
621 622
		else
			result = i2c_imx_write(i2c_imx, &msgs[i]);
A
Arnaud Patard 已提交
623 624
		if (result)
			goto fail0;
D
Darius Augulis 已提交
625 626 627 628 629 630 631 632 633 634 635 636 637 638
	}

fail0:
	/* Stop I2C transfer */
	i2c_imx_stop(i2c_imx);

	dev_dbg(&i2c_imx->adapter.dev, "<%s> exit with: %s: %d\n", __func__,
		(result < 0) ? "error" : "success msg",
			(result < 0) ? result : num);
	return (result < 0) ? result : num;
}

static u32 i2c_imx_func(struct i2c_adapter *adapter)
{
639 640
	return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL
		| I2C_FUNC_SMBUS_READ_BLOCK_DATA;
D
Darius Augulis 已提交
641 642 643 644 645 646 647
}

static struct i2c_algorithm i2c_imx_algo = {
	.master_xfer	= i2c_imx_xfer,
	.functionality	= i2c_imx_func,
};

648
static int i2c_imx_probe(struct platform_device *pdev)
D
Darius Augulis 已提交
649
{
650 651
	const struct of_device_id *of_id = of_match_device(i2c_imx_dt_ids,
							   &pdev->dev);
D
Darius Augulis 已提交
652 653
	struct imx_i2c_struct *i2c_imx;
	struct resource *res;
J
Jingoo Han 已提交
654
	struct imxi2c_platform_data *pdata = dev_get_platdata(&pdev->dev);
D
Darius Augulis 已提交
655
	void __iomem *base;
656
	int irq, ret;
D
Darius Augulis 已提交
657 658 659 660 661 662

	dev_dbg(&pdev->dev, "<%s>\n", __func__);

	irq = platform_get_irq(pdev, 0);
	if (irq < 0) {
		dev_err(&pdev->dev, "can't get irq number\n");
663
		return irq;
D
Darius Augulis 已提交
664 665
	}

666
	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
667 668 669
	base = devm_ioremap_resource(&pdev->dev, res);
	if (IS_ERR(base))
		return PTR_ERR(base);
D
Darius Augulis 已提交
670

671
	i2c_imx = devm_kzalloc(&pdev->dev, sizeof(*i2c_imx), GFP_KERNEL);
672
	if (!i2c_imx)
673
		return -ENOMEM;
674

675
	if (of_id)
676
		i2c_imx->hwdata = of_id->data;
677
	else
678 679
		i2c_imx->hwdata = (struct imx_i2c_hwdata *)
				platform_get_device_id(pdev)->driver_data;
680

D
Darius Augulis 已提交
681
	/* Setup i2c_imx driver structure */
682
	strlcpy(i2c_imx->adapter.name, pdev->name, sizeof(i2c_imx->adapter.name));
D
Darius Augulis 已提交
683 684 685 686
	i2c_imx->adapter.owner		= THIS_MODULE;
	i2c_imx->adapter.algo		= &i2c_imx_algo;
	i2c_imx->adapter.dev.parent	= &pdev->dev;
	i2c_imx->adapter.nr 		= pdev->id;
687
	i2c_imx->adapter.dev.of_node	= pdev->dev.of_node;
D
Darius Augulis 已提交
688 689 690
	i2c_imx->base			= base;

	/* Get I2C clock */
691
	i2c_imx->clk = devm_clk_get(&pdev->dev, NULL);
D
Darius Augulis 已提交
692 693
	if (IS_ERR(i2c_imx->clk)) {
		dev_err(&pdev->dev, "can't get I2C clock\n");
694
		return PTR_ERR(i2c_imx->clk);
D
Darius Augulis 已提交
695 696
	}

697 698 699 700 701
	ret = clk_prepare_enable(i2c_imx->clk);
	if (ret) {
		dev_err(&pdev->dev, "can't enable I2C clock\n");
		return ret;
	}
D
Darius Augulis 已提交
702
	/* Request IRQ */
703 704
	ret = devm_request_irq(&pdev->dev, irq, i2c_imx_isr, 0,
				pdev->name, i2c_imx);
D
Darius Augulis 已提交
705
	if (ret) {
706
		dev_err(&pdev->dev, "can't claim irq %d\n", irq);
707
		goto clk_disable;
D
Darius Augulis 已提交
708 709 710 711 712 713 714 715 716
	}

	/* Init queue */
	init_waitqueue_head(&i2c_imx->queue);

	/* Set up adapter data */
	i2c_set_adapdata(&i2c_imx->adapter, i2c_imx);

	/* Set up clock divider */
717
	i2c_imx->bitrate = IMX_I2C_BIT_RATE;
718
	ret = of_property_read_u32(pdev->dev.of_node,
719
				   "clock-frequency", &i2c_imx->bitrate);
720
	if (ret < 0 && pdata && pdata->bitrate)
721
		i2c_imx->bitrate = pdata->bitrate;
D
Darius Augulis 已提交
722 723

	/* Set up chip registers to defaults */
724 725 726
	imx_i2c_write_reg(i2c_imx->hwdata->i2cr_ien_opcode ^ I2CR_IEN,
			i2c_imx, IMX_I2C_I2CR);
	imx_i2c_write_reg(i2c_imx->hwdata->i2sr_clr_opcode, i2c_imx, IMX_I2C_I2SR);
D
Darius Augulis 已提交
727 728 729 730 731

	/* Add I2C adapter */
	ret = i2c_add_numbered_adapter(&i2c_imx->adapter);
	if (ret < 0) {
		dev_err(&pdev->dev, "registration failed\n");
732
		goto clk_disable;
D
Darius Augulis 已提交
733 734 735 736
	}

	/* Set up platform driver data */
	platform_set_drvdata(pdev, i2c_imx);
737
	clk_disable_unprepare(i2c_imx->clk);
D
Darius Augulis 已提交
738

739
	dev_dbg(&i2c_imx->adapter.dev, "claimed irq %d\n", irq);
740
	dev_dbg(&i2c_imx->adapter.dev, "device resources: %pR\n", res);
D
Darius Augulis 已提交
741 742
	dev_dbg(&i2c_imx->adapter.dev, "adapter name: \"%s\"\n",
		i2c_imx->adapter.name);
743
	dev_info(&i2c_imx->adapter.dev, "IMX I2C adapter registered\n");
D
Darius Augulis 已提交
744 745

	return 0;   /* Return OK */
746 747 748 749

clk_disable:
	clk_disable_unprepare(i2c_imx->clk);
	return ret;
D
Darius Augulis 已提交
750 751
}

752
static int i2c_imx_remove(struct platform_device *pdev)
D
Darius Augulis 已提交
753 754 755 756 757 758 759 760
{
	struct imx_i2c_struct *i2c_imx = platform_get_drvdata(pdev);

	/* remove adapter */
	dev_dbg(&i2c_imx->adapter.dev, "adapter removed\n");
	i2c_del_adapter(&i2c_imx->adapter);

	/* setup chip registers to defaults */
761 762 763 764
	imx_i2c_write_reg(0, i2c_imx, IMX_I2C_IADR);
	imx_i2c_write_reg(0, i2c_imx, IMX_I2C_IFDR);
	imx_i2c_write_reg(0, i2c_imx, IMX_I2C_I2CR);
	imx_i2c_write_reg(0, i2c_imx, IMX_I2C_I2SR);
D
Darius Augulis 已提交
765 766 767 768 769

	return 0;
}

static struct platform_driver i2c_imx_driver = {
770 771
	.probe = i2c_imx_probe,
	.remove = i2c_imx_remove,
D
Darius Augulis 已提交
772 773 774
	.driver	= {
		.name	= DRIVER_NAME,
		.owner	= THIS_MODULE,
775
		.of_match_table = i2c_imx_dt_ids,
776 777
	},
	.id_table	= imx_i2c_devtype,
D
Darius Augulis 已提交
778 779 780 781
};

static int __init i2c_adap_imx_init(void)
{
782
	return platform_driver_register(&i2c_imx_driver);
D
Darius Augulis 已提交
783
}
784
subsys_initcall(i2c_adap_imx_init);
D
Darius Augulis 已提交
785 786 787 788 789 790 791 792 793 794 795

static void __exit i2c_adap_imx_exit(void)
{
	platform_driver_unregister(&i2c_imx_driver);
}
module_exit(i2c_adap_imx_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Darius Augulis");
MODULE_DESCRIPTION("I2C adapter driver for IMX I2C bus");
MODULE_ALIAS("platform:" DRIVER_NAME);