atmel_mxt_ts.c 28.9 KB
Newer Older
1
/*
2
 * Atmel maXTouch Touchscreen driver
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
 *
 * Copyright (C) 2010 Samsung Electronics Co.Ltd
 * Author: Joonyoung Shim <jy0922.shim@samsung.com>
 *
 * 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.
 *
 */

#include <linux/module.h>
#include <linux/init.h>
#include <linux/delay.h>
#include <linux/firmware.h>
#include <linux/i2c.h>
19
#include <linux/i2c/atmel_mxt_ts.h>
20
#include <linux/input/mt.h>
21 22 23 24
#include <linux/interrupt.h>
#include <linux/slab.h>

/* Version */
25 26 27
#define MXT_VER_20		20
#define MXT_VER_21		21
#define MXT_VER_22		22
28 29

/* Slave addresses */
30 31 32 33
#define MXT_APP_LOW		0x4a
#define MXT_APP_HIGH		0x4b
#define MXT_BOOT_LOW		0x24
#define MXT_BOOT_HIGH		0x25
34 35

/* Firmware */
36
#define MXT_FW_NAME		"maxtouch.fw"
37 38

/* Registers */
39 40 41 42 43 44 45 46
#define MXT_FAMILY_ID		0x00
#define MXT_VARIANT_ID		0x01
#define MXT_VERSION		0x02
#define MXT_BUILD		0x03
#define MXT_MATRIX_X_SIZE	0x04
#define MXT_MATRIX_Y_SIZE	0x05
#define MXT_OBJECT_NUM		0x06
#define MXT_OBJECT_START	0x07
47

48
#define MXT_OBJECT_SIZE		6
49 50

/* Object types */
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
#define MXT_DEBUG_DIAGNOSTIC_T37	37
#define MXT_GEN_MESSAGE_T5		5
#define MXT_GEN_COMMAND_T6		6
#define MXT_GEN_POWER_T7		7
#define MXT_GEN_ACQUIRE_T8		8
#define MXT_GEN_DATASOURCE_T53		53
#define MXT_TOUCH_MULTI_T9		9
#define MXT_TOUCH_KEYARRAY_T15		15
#define MXT_TOUCH_PROXIMITY_T23		23
#define MXT_TOUCH_PROXKEY_T52		52
#define MXT_PROCI_GRIPFACE_T20		20
#define MXT_PROCG_NOISE_T22		22
#define MXT_PROCI_ONETOUCH_T24		24
#define MXT_PROCI_TWOTOUCH_T27		27
#define MXT_PROCI_GRIP_T40		40
#define MXT_PROCI_PALM_T41		41
#define MXT_PROCI_TOUCHSUPPRESSION_T42	42
#define MXT_PROCI_STYLUS_T47		47
#define MXT_PROCG_NOISESUPPRESSION_T48	48
#define MXT_SPT_COMMSCONFIG_T18		18
#define MXT_SPT_GPIOPWM_T19		19
#define MXT_SPT_SELFTEST_T25		25
#define MXT_SPT_CTECONFIG_T28		28
#define MXT_SPT_USERDATA_T38		38
#define MXT_SPT_DIGITIZER_T43		43
#define MXT_SPT_MESSAGECOUNT_T44	44
#define MXT_SPT_CTECONFIG_T46		46

/* MXT_GEN_COMMAND_T6 field */
80 81 82 83 84 85
#define MXT_COMMAND_RESET	0
#define MXT_COMMAND_BACKUPNV	1
#define MXT_COMMAND_CALIBRATE	2
#define MXT_COMMAND_REPORTALL	3
#define MXT_COMMAND_DIAGNOSTIC	5

86
/* MXT_GEN_POWER_T7 field */
87 88 89 90
#define MXT_POWER_IDLEACQINT	0
#define MXT_POWER_ACTVACQINT	1
#define MXT_POWER_ACTV2IDLETO	2

91
/* MXT_GEN_ACQUIRE_T8 field */
92 93 94 95 96 97 98 99
#define MXT_ACQUIRE_CHRGTIME	0
#define MXT_ACQUIRE_TCHDRIFT	2
#define MXT_ACQUIRE_DRIFTST	3
#define MXT_ACQUIRE_TCHAUTOCAL	4
#define MXT_ACQUIRE_SYNC	5
#define MXT_ACQUIRE_ATCHCALST	6
#define MXT_ACQUIRE_ATCHCALSTHR	7

100
/* MXT_TOUCH_MULTI_T9 field */
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
#define MXT_TOUCH_CTRL		0
#define MXT_TOUCH_XORIGIN	1
#define MXT_TOUCH_YORIGIN	2
#define MXT_TOUCH_XSIZE		3
#define MXT_TOUCH_YSIZE		4
#define MXT_TOUCH_BLEN		6
#define MXT_TOUCH_TCHTHR	7
#define MXT_TOUCH_TCHDI		8
#define MXT_TOUCH_ORIENT	9
#define MXT_TOUCH_MOVHYSTI	11
#define MXT_TOUCH_MOVHYSTN	12
#define MXT_TOUCH_NUMTOUCH	14
#define MXT_TOUCH_MRGHYST	15
#define MXT_TOUCH_MRGTHR	16
#define MXT_TOUCH_AMPHYST	17
#define MXT_TOUCH_XRANGE_LSB	18
#define MXT_TOUCH_XRANGE_MSB	19
#define MXT_TOUCH_YRANGE_LSB	20
#define MXT_TOUCH_YRANGE_MSB	21
#define MXT_TOUCH_XLOCLIP	22
#define MXT_TOUCH_XHICLIP	23
#define MXT_TOUCH_YLOCLIP	24
#define MXT_TOUCH_YHICLIP	25
#define MXT_TOUCH_XEDGECTRL	26
#define MXT_TOUCH_XEDGEDIST	27
#define MXT_TOUCH_YEDGECTRL	28
#define MXT_TOUCH_YEDGEDIST	29
128
#define MXT_TOUCH_JUMPLIMIT	30
129

130
/* MXT_PROCI_GRIPFACE_T20 field */
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
#define MXT_GRIPFACE_CTRL	0
#define MXT_GRIPFACE_XLOGRIP	1
#define MXT_GRIPFACE_XHIGRIP	2
#define MXT_GRIPFACE_YLOGRIP	3
#define MXT_GRIPFACE_YHIGRIP	4
#define MXT_GRIPFACE_MAXTCHS	5
#define MXT_GRIPFACE_SZTHR1	7
#define MXT_GRIPFACE_SZTHR2	8
#define MXT_GRIPFACE_SHPTHR1	9
#define MXT_GRIPFACE_SHPTHR2	10
#define MXT_GRIPFACE_SUPEXTTO	11

/* MXT_PROCI_NOISE field */
#define MXT_NOISE_CTRL		0
#define MXT_NOISE_OUTFLEN	1
#define MXT_NOISE_GCAFUL_LSB	3
#define MXT_NOISE_GCAFUL_MSB	4
#define MXT_NOISE_GCAFLL_LSB	5
#define MXT_NOISE_GCAFLL_MSB	6
#define MXT_NOISE_ACTVGCAFVALID	7
#define MXT_NOISE_NOISETHR	8
#define MXT_NOISE_FREQHOPSCALE	10
#define MXT_NOISE_FREQ0		11
#define MXT_NOISE_FREQ1		12
#define MXT_NOISE_FREQ2		13
#define MXT_NOISE_FREQ3		14
#define MXT_NOISE_FREQ4		15
#define MXT_NOISE_IDLEGCAFVALID	16

160
/* MXT_SPT_COMMSCONFIG_T18 */
161 162 163
#define MXT_COMMS_CTRL		0
#define MXT_COMMS_CMD		1

164
/* MXT_SPT_CTECONFIG_T28 field */
165 166 167 168 169
#define MXT_CTE_CTRL		0
#define MXT_CTE_CMD		1
#define MXT_CTE_MODE		2
#define MXT_CTE_IDLEGCAFDEPTH	3
#define MXT_CTE_ACTVGCAFDEPTH	4
170
#define MXT_CTE_VOLTAGE		5
171 172 173 174

#define MXT_VOLTAGE_DEFAULT	2700000
#define MXT_VOLTAGE_STEP	10000

175
/* Define for MXT_GEN_COMMAND_T6 */
176 177 178 179 180 181
#define MXT_BOOT_VALUE		0xa5
#define MXT_BACKUP_VALUE	0x55
#define MXT_BACKUP_TIME		25	/* msec */
#define MXT_RESET_TIME		65	/* msec */

#define MXT_FWRESET_TIME	175	/* msec */
182 183

/* Command to unlock bootloader */
184 185
#define MXT_UNLOCK_CMD_MSB	0xaa
#define MXT_UNLOCK_CMD_LSB	0xdc
186 187

/* Bootloader mode status */
188 189 190 191 192 193 194
#define MXT_WAITING_BOOTLOAD_CMD	0xc0	/* valid 7 6 bit only */
#define MXT_WAITING_FRAME_DATA	0x80	/* valid 7 6 bit only */
#define MXT_FRAME_CRC_CHECK	0x02
#define MXT_FRAME_CRC_FAIL	0x03
#define MXT_FRAME_CRC_PASS	0x04
#define MXT_APP_CRC_FAIL	0x40	/* valid 7 8 bit only */
#define MXT_BOOT_STATUS_MASK	0x3f
195 196

/* Touch status */
197 198 199 200 201 202 203
#define MXT_SUPPRESS		(1 << 1)
#define MXT_AMP			(1 << 2)
#define MXT_VECTOR		(1 << 3)
#define MXT_MOVE		(1 << 4)
#define MXT_RELEASE		(1 << 5)
#define MXT_PRESS		(1 << 6)
#define MXT_DETECT		(1 << 7)
204

205 206 207 208 209
/* Touch orient bits */
#define MXT_XY_SWITCH		(1 << 0)
#define MXT_X_INVERT		(1 << 1)
#define MXT_Y_INVERT		(1 << 2)

210
/* Touchscreen absolute values */
211
#define MXT_MAX_AREA		0xff
212

213
#define MXT_MAX_FINGER		10
214

215
struct mxt_info {
216 217 218 219 220 221 222 223 224
	u8 family_id;
	u8 variant_id;
	u8 version;
	u8 build;
	u8 matrix_xsize;
	u8 matrix_ysize;
	u8 object_num;
};

225
struct mxt_object {
226 227 228 229 230 231 232 233 234 235
	u8 type;
	u16 start_address;
	u8 size;
	u8 instances;
	u8 num_report_ids;

	/* to map object and message */
	u8 max_reportid;
};

236
struct mxt_message {
237 238 239 240
	u8 reportid;
	u8 message[7];
};

241
struct mxt_finger {
242 243 244 245
	int status;
	int x;
	int y;
	int area;
246
	int pressure;
247 248 249
};

/* Each client has this additional data */
250
struct mxt_data {
251 252
	struct i2c_client *client;
	struct input_dev *input_dev;
253
	char phys[64];		/* device physical location */
254 255 256 257
	const struct mxt_platform_data *pdata;
	struct mxt_object *object_table;
	struct mxt_info info;
	struct mxt_finger finger[MXT_MAX_FINGER];
258
	unsigned int irq;
259 260
	unsigned int max_x;
	unsigned int max_y;
261 262
};

263
static bool mxt_object_readable(unsigned int type)
264 265
{
	switch (type) {
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
	case MXT_GEN_MESSAGE_T5:
	case MXT_GEN_COMMAND_T6:
	case MXT_GEN_POWER_T7:
	case MXT_GEN_ACQUIRE_T8:
	case MXT_GEN_DATASOURCE_T53:
	case MXT_TOUCH_MULTI_T9:
	case MXT_TOUCH_KEYARRAY_T15:
	case MXT_TOUCH_PROXIMITY_T23:
	case MXT_TOUCH_PROXKEY_T52:
	case MXT_PROCI_GRIPFACE_T20:
	case MXT_PROCG_NOISE_T22:
	case MXT_PROCI_ONETOUCH_T24:
	case MXT_PROCI_TWOTOUCH_T27:
	case MXT_PROCI_GRIP_T40:
	case MXT_PROCI_PALM_T41:
	case MXT_PROCI_TOUCHSUPPRESSION_T42:
	case MXT_PROCI_STYLUS_T47:
	case MXT_PROCG_NOISESUPPRESSION_T48:
	case MXT_SPT_COMMSCONFIG_T18:
	case MXT_SPT_GPIOPWM_T19:
	case MXT_SPT_SELFTEST_T25:
	case MXT_SPT_CTECONFIG_T28:
	case MXT_SPT_USERDATA_T38:
	case MXT_SPT_DIGITIZER_T43:
	case MXT_SPT_CTECONFIG_T46:
291 292 293 294 295 296
		return true;
	default:
		return false;
	}
}

297
static bool mxt_object_writable(unsigned int type)
298 299
{
	switch (type) {
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
	case MXT_GEN_COMMAND_T6:
	case MXT_GEN_POWER_T7:
	case MXT_GEN_ACQUIRE_T8:
	case MXT_TOUCH_MULTI_T9:
	case MXT_TOUCH_KEYARRAY_T15:
	case MXT_TOUCH_PROXIMITY_T23:
	case MXT_TOUCH_PROXKEY_T52:
	case MXT_PROCI_GRIPFACE_T20:
	case MXT_PROCG_NOISE_T22:
	case MXT_PROCI_ONETOUCH_T24:
	case MXT_PROCI_TWOTOUCH_T27:
	case MXT_PROCI_GRIP_T40:
	case MXT_PROCI_PALM_T41:
	case MXT_PROCI_TOUCHSUPPRESSION_T42:
	case MXT_PROCI_STYLUS_T47:
	case MXT_PROCG_NOISESUPPRESSION_T48:
	case MXT_SPT_COMMSCONFIG_T18:
	case MXT_SPT_GPIOPWM_T19:
	case MXT_SPT_SELFTEST_T25:
	case MXT_SPT_CTECONFIG_T28:
	case MXT_SPT_DIGITIZER_T43:
	case MXT_SPT_CTECONFIG_T46:
322 323 324 325 326 327
		return true;
	default:
		return false;
	}
}

328
static void mxt_dump_message(struct device *dev,
329
			     struct mxt_message *message)
330
{
331 332 333 334
	dev_dbg(dev, "reportid: %u\tmessage: %02x %02x %02x %02x %02x %02x %02x\n",
		message->reportid, message->message[0], message->message[1],
		message->message[2], message->message[3], message->message[4],
		message->message[5], message->message[6]);
335 336
}

337
static int mxt_check_bootloader(struct i2c_client *client,
338 339 340 341 342 343 344 345 346 347 348
				     unsigned int state)
{
	u8 val;

recheck:
	if (i2c_master_recv(client, &val, 1) != 1) {
		dev_err(&client->dev, "%s: i2c recv failed\n", __func__);
		return -EIO;
	}

	switch (state) {
349 350 351
	case MXT_WAITING_BOOTLOAD_CMD:
	case MXT_WAITING_FRAME_DATA:
		val &= ~MXT_BOOT_STATUS_MASK;
352
		break;
353 354
	case MXT_FRAME_CRC_PASS:
		if (val == MXT_FRAME_CRC_CHECK)
355 356 357 358 359 360 361 362 363 364 365 366 367 368
			goto recheck;
		break;
	default:
		return -EINVAL;
	}

	if (val != state) {
		dev_err(&client->dev, "Unvalid bootloader mode state\n");
		return -EINVAL;
	}

	return 0;
}

369
static int mxt_unlock_bootloader(struct i2c_client *client)
370 371 372
{
	u8 buf[2];

373 374
	buf[0] = MXT_UNLOCK_CMD_LSB;
	buf[1] = MXT_UNLOCK_CMD_MSB;
375 376 377 378 379 380 381 382 383

	if (i2c_master_send(client, buf, 2) != 2) {
		dev_err(&client->dev, "%s: i2c send failed\n", __func__);
		return -EIO;
	}

	return 0;
}

384
static int mxt_fw_write(struct i2c_client *client,
385 386 387 388 389 390 391 392 393 394
			     const u8 *data, unsigned int frame_size)
{
	if (i2c_master_send(client, data, frame_size) != frame_size) {
		dev_err(&client->dev, "%s: i2c send failed\n", __func__);
		return -EIO;
	}

	return 0;
}

395
static int __mxt_read_reg(struct i2c_client *client,
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
			       u16 reg, u16 len, void *val)
{
	struct i2c_msg xfer[2];
	u8 buf[2];

	buf[0] = reg & 0xff;
	buf[1] = (reg >> 8) & 0xff;

	/* Write register */
	xfer[0].addr = client->addr;
	xfer[0].flags = 0;
	xfer[0].len = 2;
	xfer[0].buf = buf;

	/* Read data */
	xfer[1].addr = client->addr;
	xfer[1].flags = I2C_M_RD;
	xfer[1].len = len;
	xfer[1].buf = val;

	if (i2c_transfer(client->adapter, xfer, 2) != 2) {
		dev_err(&client->dev, "%s: i2c transfer failed\n", __func__);
		return -EIO;
	}

	return 0;
}

424
static int mxt_read_reg(struct i2c_client *client, u16 reg, u8 *val)
425
{
426
	return __mxt_read_reg(client, reg, 1, val);
427 428
}

429
static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
{
	u8 buf[3];

	buf[0] = reg & 0xff;
	buf[1] = (reg >> 8) & 0xff;
	buf[2] = val;

	if (i2c_master_send(client, buf, 3) != 3) {
		dev_err(&client->dev, "%s: i2c send failed\n", __func__);
		return -EIO;
	}

	return 0;
}

445
static int mxt_read_object_table(struct i2c_client *client,
446 447
				      u16 reg, u8 *object_buf)
{
448
	return __mxt_read_reg(client, reg, MXT_OBJECT_SIZE,
449 450 451
				   object_buf);
}

452 453
static struct mxt_object *
mxt_get_object(struct mxt_data *data, u8 type)
454
{
455
	struct mxt_object *object;
456 457 458 459 460 461 462 463 464 465 466 467
	int i;

	for (i = 0; i < data->info.object_num; i++) {
		object = data->object_table + i;
		if (object->type == type)
			return object;
	}

	dev_err(&data->client->dev, "Invalid object type\n");
	return NULL;
}

468 469
static int mxt_read_message(struct mxt_data *data,
				 struct mxt_message *message)
470
{
471
	struct mxt_object *object;
472 473
	u16 reg;

474
	object = mxt_get_object(data, MXT_GEN_MESSAGE_T5);
475 476 477 478
	if (!object)
		return -EINVAL;

	reg = object->start_address;
479 480
	return __mxt_read_reg(data->client, reg,
			sizeof(struct mxt_message), message);
481 482
}

483
static int mxt_read_object(struct mxt_data *data,
484 485
				u8 type, u8 offset, u8 *val)
{
486
	struct mxt_object *object;
487 488
	u16 reg;

489
	object = mxt_get_object(data, type);
490 491 492 493
	if (!object)
		return -EINVAL;

	reg = object->start_address;
494
	return __mxt_read_reg(data->client, reg + offset, 1, val);
495 496
}

497
static int mxt_write_object(struct mxt_data *data,
498 499
				 u8 type, u8 offset, u8 val)
{
500
	struct mxt_object *object;
501 502
	u16 reg;

503
	object = mxt_get_object(data, type);
504
	if (!object || offset >= object->size + 1)
505 506 507
		return -EINVAL;

	reg = object->start_address;
508
	return mxt_write_reg(data->client, reg + offset, val);
509 510
}

511
static void mxt_input_report(struct mxt_data *data, int single_id)
512
{
513
	struct mxt_finger *finger = data->finger;
514 515 516 517 518
	struct input_dev *input_dev = data->input_dev;
	int status = finger[single_id].status;
	int finger_num = 0;
	int id;

519
	for (id = 0; id < MXT_MAX_FINGER; id++) {
520 521 522
		if (!finger[id].status)
			continue;

523 524 525
		input_mt_slot(input_dev, id);
		input_mt_report_slot_state(input_dev, MT_TOOL_FINGER,
				finger[id].status != MXT_RELEASE);
526

527
		if (finger[id].status != MXT_RELEASE) {
528
			finger_num++;
529 530 531 532 533 534
			input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR,
					finger[id].area);
			input_report_abs(input_dev, ABS_MT_POSITION_X,
					finger[id].x);
			input_report_abs(input_dev, ABS_MT_POSITION_Y,
					finger[id].y);
535 536
			input_report_abs(input_dev, ABS_MT_PRESSURE,
					finger[id].pressure);
537 538 539
		} else {
			finger[id].status = 0;
		}
540 541 542 543
	}

	input_report_key(input_dev, BTN_TOUCH, finger_num > 0);

544
	if (status != MXT_RELEASE) {
545 546
		input_report_abs(input_dev, ABS_X, finger[single_id].x);
		input_report_abs(input_dev, ABS_Y, finger[single_id].y);
547 548
		input_report_abs(input_dev,
				 ABS_PRESSURE, finger[single_id].pressure);
549 550 551 552 553
	}

	input_sync(input_dev);
}

554 555
static void mxt_input_touchevent(struct mxt_data *data,
				      struct mxt_message *message, int id)
556
{
557
	struct mxt_finger *finger = data->finger;
558 559 560 561 562
	struct device *dev = &data->client->dev;
	u8 status = message->message[0];
	int x;
	int y;
	int area;
563
	int pressure;
564 565

	/* Check the touch is present on the screen */
566 567
	if (!(status & MXT_DETECT)) {
		if (status & MXT_RELEASE) {
568 569
			dev_dbg(dev, "[%d] released\n", id);

570 571
			finger[id].status = MXT_RELEASE;
			mxt_input_report(data, id);
572 573 574 575 576
		}
		return;
	}

	/* Check only AMP detection */
577
	if (!(status & (MXT_PRESS | MXT_MOVE)))
578 579
		return;

580 581 582 583 584 585 586
	x = (message->message[1] << 4) | ((message->message[3] >> 4) & 0xf);
	y = (message->message[2] << 4) | ((message->message[3] & 0xf));
	if (data->max_x < 1024)
		x = x >> 2;
	if (data->max_y < 1024)
		y = y >> 2;

587
	area = message->message[4];
588
	pressure = message->message[5];
589 590

	dev_dbg(dev, "[%d] %s x: %d, y: %d, area: %d\n", id,
591
		status & MXT_MOVE ? "moved" : "pressed",
592 593
		x, y, area);

594 595
	finger[id].status = status & MXT_MOVE ?
				MXT_MOVE : MXT_PRESS;
596 597 598
	finger[id].x = x;
	finger[id].y = y;
	finger[id].area = area;
599
	finger[id].pressure = pressure;
600

601
	mxt_input_report(data, id);
602 603
}

604
static irqreturn_t mxt_interrupt(int irq, void *dev_id)
605
{
606 607 608
	struct mxt_data *data = dev_id;
	struct mxt_message message;
	struct mxt_object *object;
609 610 611 612 613 614 615
	struct device *dev = &data->client->dev;
	int id;
	u8 reportid;
	u8 max_reportid;
	u8 min_reportid;

	do {
616
		if (mxt_read_message(data, &message)) {
617 618 619 620 621 622
			dev_err(dev, "Failed to read message\n");
			goto end;
		}

		reportid = message.reportid;

623 624
		/* whether reportid is thing of MXT_TOUCH_MULTI_T9 */
		object = mxt_get_object(data, MXT_TOUCH_MULTI_T9);
625 626 627 628 629 630 631 632
		if (!object)
			goto end;

		max_reportid = object->max_reportid;
		min_reportid = max_reportid - object->num_report_ids + 1;
		id = reportid - min_reportid;

		if (reportid >= min_reportid && reportid <= max_reportid)
633
			mxt_input_touchevent(data, &message, id);
634
		else
635
			mxt_dump_message(dev, &message);
636 637 638 639 640 641
	} while (reportid != 0xff);

end:
	return IRQ_HANDLED;
}

642
static int mxt_check_reg_init(struct mxt_data *data)
643
{
644
	const struct mxt_platform_data *pdata = data->pdata;
645
	struct mxt_object *object;
646 647
	struct device *dev = &data->client->dev;
	int index = 0;
648
	int i, j, config_offset;
649

650 651 652
	if (!pdata->config) {
		dev_dbg(dev, "No cfg data defined, skipping reg init\n");
		return 0;
653 654 655 656 657
	}

	for (i = 0; i < data->info.object_num; i++) {
		object = data->object_table + i;

658
		if (!mxt_object_writable(object->type))
659 660
			continue;

661 662 663
		for (j = 0;
		     j < (object->size + 1) * (object->instances + 1);
		     j++) {
664 665 666 667 668
			config_offset = index + j;
			if (config_offset > pdata->config_length) {
				dev_err(dev, "Not enough config data!\n");
				return -EINVAL;
			}
669
			mxt_write_object(data, object->type, j,
670 671
					 pdata->config[config_offset]);
		}
672
		index += (object->size + 1) * (object->instances + 1);
673 674 675 676 677
	}

	return 0;
}

678
static int mxt_make_highchg(struct mxt_data *data)
679 680
{
	struct device *dev = &data->client->dev;
681
	struct mxt_message message;
682 683 684 685 686
	int count = 10;
	int error;

	/* Read dummy message to make high CHG pin */
	do {
687
		error = mxt_read_message(data, &message);
688 689
		if (error)
			return error;
690
	} while (message.reportid != 0xff && --count);
691 692 693 694 695 696 697 698 699

	if (!count) {
		dev_err(dev, "CHG pin isn't cleared\n");
		return -EBUSY;
	}

	return 0;
}

700
static void mxt_handle_pdata(struct mxt_data *data)
701
{
702
	const struct mxt_platform_data *pdata = data->pdata;
703 704 705
	u8 voltage;

	/* Set touchscreen lines */
706
	mxt_write_object(data, MXT_TOUCH_MULTI_T9, MXT_TOUCH_XSIZE,
707
			pdata->x_line);
708
	mxt_write_object(data, MXT_TOUCH_MULTI_T9, MXT_TOUCH_YSIZE,
709 710 711
			pdata->y_line);

	/* Set touchscreen orient */
712
	mxt_write_object(data, MXT_TOUCH_MULTI_T9, MXT_TOUCH_ORIENT,
713 714 715
			pdata->orient);

	/* Set touchscreen burst length */
716
	mxt_write_object(data, MXT_TOUCH_MULTI_T9,
717
			MXT_TOUCH_BLEN, pdata->blen);
718 719

	/* Set touchscreen threshold */
720
	mxt_write_object(data, MXT_TOUCH_MULTI_T9,
721
			MXT_TOUCH_TCHTHR, pdata->threshold);
722 723

	/* Set touchscreen resolution */
724
	mxt_write_object(data, MXT_TOUCH_MULTI_T9,
725
			MXT_TOUCH_XRANGE_LSB, (pdata->x_size - 1) & 0xff);
726
	mxt_write_object(data, MXT_TOUCH_MULTI_T9,
727
			MXT_TOUCH_XRANGE_MSB, (pdata->x_size - 1) >> 8);
728
	mxt_write_object(data, MXT_TOUCH_MULTI_T9,
729
			MXT_TOUCH_YRANGE_LSB, (pdata->y_size - 1) & 0xff);
730
	mxt_write_object(data, MXT_TOUCH_MULTI_T9,
731
			MXT_TOUCH_YRANGE_MSB, (pdata->y_size - 1) >> 8);
732 733

	/* Set touchscreen voltage */
734
	if (pdata->voltage) {
735 736 737
		if (pdata->voltage < MXT_VOLTAGE_DEFAULT) {
			voltage = (MXT_VOLTAGE_DEFAULT - pdata->voltage) /
				MXT_VOLTAGE_STEP;
738 739
			voltage = 0xff - voltage + 1;
		} else
740 741
			voltage = (pdata->voltage - MXT_VOLTAGE_DEFAULT) /
				MXT_VOLTAGE_STEP;
742

743
		mxt_write_object(data, MXT_SPT_CTECONFIG_T28,
744
				MXT_CTE_VOLTAGE, voltage);
745 746 747
	}
}

748
static int mxt_get_info(struct mxt_data *data)
749 750
{
	struct i2c_client *client = data->client;
751
	struct mxt_info *info = &data->info;
752 753 754
	int error;
	u8 val;

755
	error = mxt_read_reg(client, MXT_FAMILY_ID, &val);
756 757 758 759
	if (error)
		return error;
	info->family_id = val;

760
	error = mxt_read_reg(client, MXT_VARIANT_ID, &val);
761 762 763 764
	if (error)
		return error;
	info->variant_id = val;

765
	error = mxt_read_reg(client, MXT_VERSION, &val);
766 767 768 769
	if (error)
		return error;
	info->version = val;

770
	error = mxt_read_reg(client, MXT_BUILD, &val);
771 772 773 774
	if (error)
		return error;
	info->build = val;

775
	error = mxt_read_reg(client, MXT_OBJECT_NUM, &val);
776 777 778 779 780 781 782
	if (error)
		return error;
	info->object_num = val;

	return 0;
}

783
static int mxt_get_object_table(struct mxt_data *data)
784 785 786 787 788
{
	int error;
	int i;
	u16 reg;
	u8 reportid = 0;
789
	u8 buf[MXT_OBJECT_SIZE];
790 791

	for (i = 0; i < data->info.object_num; i++) {
792
		struct mxt_object *object = data->object_table + i;
793

794 795
		reg = MXT_OBJECT_START + MXT_OBJECT_SIZE * i;
		error = mxt_read_object_table(data->client, reg, buf);
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
		if (error)
			return error;

		object->type = buf[0];
		object->start_address = (buf[2] << 8) | buf[1];
		object->size = buf[3];
		object->instances = buf[4];
		object->num_report_ids = buf[5];

		if (object->num_report_ids) {
			reportid += object->num_report_ids *
					(object->instances + 1);
			object->max_reportid = reportid;
		}
	}

	return 0;
}

815
static int mxt_initialize(struct mxt_data *data)
816 817
{
	struct i2c_client *client = data->client;
818
	struct mxt_info *info = &data->info;
819 820 821
	int error;
	u8 val;

822
	error = mxt_get_info(data);
823 824 825 826
	if (error)
		return error;

	data->object_table = kcalloc(info->object_num,
827
				     sizeof(struct mxt_object),
828 829 830 831 832 833 834
				     GFP_KERNEL);
	if (!data->object_table) {
		dev_err(&client->dev, "Failed to allocate memory\n");
		return -ENOMEM;
	}

	/* Get object table information */
835
	error = mxt_get_object_table(data);
836 837 838 839
	if (error)
		return error;

	/* Check register init values */
840
	error = mxt_check_reg_init(data);
841 842 843
	if (error)
		return error;

844
	mxt_handle_pdata(data);
845 846

	/* Backup to memory */
847
	mxt_write_object(data, MXT_GEN_COMMAND_T6,
848 849 850
			MXT_COMMAND_BACKUPNV,
			MXT_BACKUP_VALUE);
	msleep(MXT_BACKUP_TIME);
851 852

	/* Soft reset */
853
	mxt_write_object(data, MXT_GEN_COMMAND_T6,
854 855
			MXT_COMMAND_RESET, 1);
	msleep(MXT_RESET_TIME);
856 857

	/* Update matrix size at info struct */
858
	error = mxt_read_reg(client, MXT_MATRIX_X_SIZE, &val);
859 860 861 862
	if (error)
		return error;
	info->matrix_xsize = val;

863
	error = mxt_read_reg(client, MXT_MATRIX_Y_SIZE, &val);
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
	if (error)
		return error;
	info->matrix_ysize = val;

	dev_info(&client->dev,
			"Family ID: %d Variant ID: %d Version: %d Build: %d\n",
			info->family_id, info->variant_id, info->version,
			info->build);

	dev_info(&client->dev,
			"Matrix X Size: %d Matrix Y Size: %d Object Num: %d\n",
			info->matrix_xsize, info->matrix_ysize,
			info->object_num);

	return 0;
}

881 882 883 884 885 886 887 888 889 890 891 892 893 894
static void mxt_calc_resolution(struct mxt_data *data)
{
	unsigned int max_x = data->pdata->x_size - 1;
	unsigned int max_y = data->pdata->y_size - 1;

	if (data->pdata->orient & MXT_XY_SWITCH) {
		data->max_x = max_y;
		data->max_y = max_x;
	} else {
		data->max_x = max_x;
		data->max_y = max_y;
	}
}

895
static ssize_t mxt_object_show(struct device *dev,
896 897
				    struct device_attribute *attr, char *buf)
{
898 899
	struct mxt_data *data = dev_get_drvdata(dev);
	struct mxt_object *object;
900 901 902 903 904 905 906 907
	int count = 0;
	int i, j;
	int error;
	u8 val;

	for (i = 0; i < data->info.object_num; i++) {
		object = data->object_table + i;

908 909
		count += snprintf(buf + count, PAGE_SIZE - count,
				"Object[%d] (Type %d)\n",
910
				i + 1, object->type);
911 912
		if (count >= PAGE_SIZE)
			return PAGE_SIZE - 1;
913

914
		if (!mxt_object_readable(object->type)) {
915 916 917 918
			count += snprintf(buf + count, PAGE_SIZE - count,
					"\n");
			if (count >= PAGE_SIZE)
				return PAGE_SIZE - 1;
919 920 921 922
			continue;
		}

		for (j = 0; j < object->size + 1; j++) {
923
			error = mxt_read_object(data,
924 925 926 927
						object->type, j, &val);
			if (error)
				return error;

928 929 930 931
			count += snprintf(buf + count, PAGE_SIZE - count,
					"\t[%2d]: %02x (%d)\n", j, val, val);
			if (count >= PAGE_SIZE)
				return PAGE_SIZE - 1;
932 933
		}

934 935 936
		count += snprintf(buf + count, PAGE_SIZE - count, "\n");
		if (count >= PAGE_SIZE)
			return PAGE_SIZE - 1;
937 938 939 940 941
	}

	return count;
}

942
static int mxt_load_fw(struct device *dev, const char *fn)
943
{
944
	struct mxt_data *data = dev_get_drvdata(dev);
945 946 947 948 949 950 951 952 953 954 955 956 957
	struct i2c_client *client = data->client;
	const struct firmware *fw = NULL;
	unsigned int frame_size;
	unsigned int pos = 0;
	int ret;

	ret = request_firmware(&fw, fn, dev);
	if (ret) {
		dev_err(dev, "Unable to open firmware %s\n", fn);
		return ret;
	}

	/* Change to the bootloader mode */
958
	mxt_write_object(data, MXT_GEN_COMMAND_T6,
959 960
			MXT_COMMAND_RESET, MXT_BOOT_VALUE);
	msleep(MXT_RESET_TIME);
961 962

	/* Change to slave address of bootloader */
963 964
	if (client->addr == MXT_APP_LOW)
		client->addr = MXT_BOOT_LOW;
965
	else
966
		client->addr = MXT_BOOT_HIGH;
967

968
	ret = mxt_check_bootloader(client, MXT_WAITING_BOOTLOAD_CMD);
969 970 971 972
	if (ret)
		goto out;

	/* Unlock bootloader */
973
	mxt_unlock_bootloader(client);
974 975

	while (pos < fw->size) {
976 977
		ret = mxt_check_bootloader(client,
						MXT_WAITING_FRAME_DATA);
978 979 980 981 982 983 984 985 986 987 988
		if (ret)
			goto out;

		frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));

		/* We should add 2 at frame size as the the firmware data is not
		 * included the CRC bytes.
		 */
		frame_size += 2;

		/* Write one frame to device */
989
		mxt_fw_write(client, fw->data + pos, frame_size);
990

991 992
		ret = mxt_check_bootloader(client,
						MXT_FRAME_CRC_PASS);
993 994 995 996 997 998 999 1000 1001 1002 1003 1004
		if (ret)
			goto out;

		pos += frame_size;

		dev_dbg(dev, "Updated %d bytes / %zd bytes\n", pos, fw->size);
	}

out:
	release_firmware(fw);

	/* Change to slave address of application */
1005 1006
	if (client->addr == MXT_BOOT_LOW)
		client->addr = MXT_APP_LOW;
1007
	else
1008
		client->addr = MXT_APP_HIGH;
1009 1010 1011 1012

	return ret;
}

1013
static ssize_t mxt_update_fw_store(struct device *dev,
1014 1015 1016
					struct device_attribute *attr,
					const char *buf, size_t count)
{
1017
	struct mxt_data *data = dev_get_drvdata(dev);
1018 1019 1020 1021
	int error;

	disable_irq(data->irq);

1022
	error = mxt_load_fw(dev, MXT_FW_NAME);
1023 1024 1025 1026 1027 1028 1029
	if (error) {
		dev_err(dev, "The firmware update failed(%d)\n", error);
		count = error;
	} else {
		dev_dbg(dev, "The firmware update succeeded\n");

		/* Wait for reset */
1030
		msleep(MXT_FWRESET_TIME);
1031 1032 1033 1034

		kfree(data->object_table);
		data->object_table = NULL;

1035
		mxt_initialize(data);
1036 1037 1038 1039
	}

	enable_irq(data->irq);

1040 1041 1042 1043
	error = mxt_make_highchg(data);
	if (error)
		return error;

1044 1045 1046
	return count;
}

1047 1048
static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
1049

1050
static struct attribute *mxt_attrs[] = {
1051 1052 1053 1054 1055
	&dev_attr_object.attr,
	&dev_attr_update_fw.attr,
	NULL
};

1056 1057
static const struct attribute_group mxt_attr_group = {
	.attrs = mxt_attrs,
1058 1059
};

1060
static void mxt_start(struct mxt_data *data)
1061 1062
{
	/* Touch enable */
1063
	mxt_write_object(data,
1064
			MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0x83);
1065 1066
}

1067
static void mxt_stop(struct mxt_data *data)
1068 1069
{
	/* Touch disable */
1070
	mxt_write_object(data,
1071
			MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0);
1072 1073
}

1074
static int mxt_input_open(struct input_dev *dev)
1075
{
1076
	struct mxt_data *data = input_get_drvdata(dev);
1077

1078
	mxt_start(data);
1079 1080 1081 1082

	return 0;
}

1083
static void mxt_input_close(struct input_dev *dev)
1084
{
1085
	struct mxt_data *data = input_get_drvdata(dev);
1086

1087
	mxt_stop(data);
1088 1089
}

1090
static int __devinit mxt_probe(struct i2c_client *client,
1091 1092
		const struct i2c_device_id *id)
{
1093
	const struct mxt_platform_data *pdata = client->dev.platform_data;
1094
	struct mxt_data *data;
1095 1096 1097
	struct input_dev *input_dev;
	int error;

1098
	if (!pdata)
1099 1100
		return -EINVAL;

1101
	data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL);
1102 1103 1104 1105 1106 1107 1108
	input_dev = input_allocate_device();
	if (!data || !input_dev) {
		dev_err(&client->dev, "Failed to allocate memory\n");
		error = -ENOMEM;
		goto err_free_mem;
	}

1109
	input_dev->name = "Atmel maXTouch Touchscreen";
1110 1111 1112 1113
	snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
		 client->adapter->nr, client->addr);
	input_dev->phys = data->phys;

1114 1115
	input_dev->id.bustype = BUS_I2C;
	input_dev->dev.parent = &client->dev;
1116 1117
	input_dev->open = mxt_input_open;
	input_dev->close = mxt_input_close;
1118

1119 1120 1121 1122 1123 1124 1125
	data->client = client;
	data->input_dev = input_dev;
	data->pdata = pdata;
	data->irq = client->irq;

	mxt_calc_resolution(data);

1126 1127 1128 1129 1130 1131
	__set_bit(EV_ABS, input_dev->evbit);
	__set_bit(EV_KEY, input_dev->evbit);
	__set_bit(BTN_TOUCH, input_dev->keybit);

	/* For single touch */
	input_set_abs_params(input_dev, ABS_X,
1132
			     0, data->max_x, 0, 0);
1133
	input_set_abs_params(input_dev, ABS_Y,
1134
			     0, data->max_y, 0, 0);
1135 1136
	input_set_abs_params(input_dev, ABS_PRESSURE,
			     0, 255, 0, 0);
1137 1138

	/* For multi touch */
1139
	input_mt_init_slots(input_dev, MXT_MAX_FINGER);
1140
	input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
1141
			     0, MXT_MAX_AREA, 0, 0);
1142
	input_set_abs_params(input_dev, ABS_MT_POSITION_X,
1143
			     0, data->max_x, 0, 0);
1144
	input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
1145
			     0, data->max_y, 0, 0);
1146 1147
	input_set_abs_params(input_dev, ABS_MT_PRESSURE,
			     0, 255, 0, 0);
1148 1149 1150 1151

	input_set_drvdata(input_dev, data);
	i2c_set_clientdata(client, data);

1152
	error = mxt_initialize(data);
1153 1154 1155
	if (error)
		goto err_free_object;

1156
	error = request_threaded_irq(client->irq, NULL, mxt_interrupt,
1157
			pdata->irqflags, client->name, data);
1158 1159 1160 1161 1162
	if (error) {
		dev_err(&client->dev, "Failed to register interrupt\n");
		goto err_free_object;
	}

1163 1164 1165 1166
	error = mxt_make_highchg(data);
	if (error)
		goto err_free_irq;

1167 1168 1169 1170
	error = input_register_device(input_dev);
	if (error)
		goto err_free_irq;

1171
	error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
	if (error)
		goto err_unregister_device;

	return 0;

err_unregister_device:
	input_unregister_device(input_dev);
	input_dev = NULL;
err_free_irq:
	free_irq(client->irq, data);
err_free_object:
	kfree(data->object_table);
err_free_mem:
	input_free_device(input_dev);
	kfree(data);
	return error;
}

1190
static int __devexit mxt_remove(struct i2c_client *client)
1191
{
1192
	struct mxt_data *data = i2c_get_clientdata(client);
1193

1194
	sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
1195 1196 1197 1198 1199 1200 1201 1202
	free_irq(data->irq, data);
	input_unregister_device(data->input_dev);
	kfree(data->object_table);
	kfree(data);

	return 0;
}

1203
#ifdef CONFIG_PM_SLEEP
1204
static int mxt_suspend(struct device *dev)
1205
{
1206
	struct i2c_client *client = to_i2c_client(dev);
1207
	struct mxt_data *data = i2c_get_clientdata(client);
1208 1209 1210 1211 1212
	struct input_dev *input_dev = data->input_dev;

	mutex_lock(&input_dev->mutex);

	if (input_dev->users)
1213
		mxt_stop(data);
1214 1215 1216 1217 1218 1219

	mutex_unlock(&input_dev->mutex);

	return 0;
}

1220
static int mxt_resume(struct device *dev)
1221
{
1222
	struct i2c_client *client = to_i2c_client(dev);
1223
	struct mxt_data *data = i2c_get_clientdata(client);
1224 1225 1226
	struct input_dev *input_dev = data->input_dev;

	/* Soft reset */
1227
	mxt_write_object(data, MXT_GEN_COMMAND_T6,
1228
			MXT_COMMAND_RESET, 1);
1229

1230
	msleep(MXT_RESET_TIME);
1231 1232 1233 1234

	mutex_lock(&input_dev->mutex);

	if (input_dev->users)
1235
		mxt_start(data);
1236 1237 1238 1239 1240 1241 1242

	mutex_unlock(&input_dev->mutex);

	return 0;
}
#endif

1243 1244
static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);

1245
static const struct i2c_device_id mxt_id[] = {
1246
	{ "qt602240_ts", 0 },
1247
	{ "atmel_mxt_ts", 0 },
1248
	{ "mXT224", 0 },
1249 1250
	{ }
};
1251
MODULE_DEVICE_TABLE(i2c, mxt_id);
1252

1253
static struct i2c_driver mxt_driver = {
1254
	.driver = {
1255
		.name	= "atmel_mxt_ts",
1256
		.owner	= THIS_MODULE,
1257
		.pm	= &mxt_pm_ops,
1258
	},
1259 1260 1261
	.probe		= mxt_probe,
	.remove		= __devexit_p(mxt_remove),
	.id_table	= mxt_id,
1262 1263
};

1264
module_i2c_driver(mxt_driver);
1265 1266 1267

/* Module information */
MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
1268
MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
1269
MODULE_LICENSE("GPL");