atmel_mxt_ts.c 29.0 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 241
	u8 reportid;
	u8 message[7];
	u8 checksum;
};

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

/* Each client has this additional data */
251
struct mxt_data {
252 253
	struct i2c_client *client;
	struct input_dev *input_dev;
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 329
static void mxt_dump_message(struct device *dev,
				  struct mxt_message *message)
330 331 332 333 334 335 336 337 338 339 340 341
{
	dev_dbg(dev, "reportid:\t0x%x\n", message->reportid);
	dev_dbg(dev, "message1:\t0x%x\n", message->message[0]);
	dev_dbg(dev, "message2:\t0x%x\n", message->message[1]);
	dev_dbg(dev, "message3:\t0x%x\n", message->message[2]);
	dev_dbg(dev, "message4:\t0x%x\n", message->message[3]);
	dev_dbg(dev, "message5:\t0x%x\n", message->message[4]);
	dev_dbg(dev, "message6:\t0x%x\n", message->message[5]);
	dev_dbg(dev, "message7:\t0x%x\n", message->message[6]);
	dev_dbg(dev, "checksum:\t0x%x\n", message->checksum);
}

342
static int mxt_check_bootloader(struct i2c_client *client,
343 344 345 346 347 348 349 350 351 352 353
				     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) {
354 355 356
	case MXT_WAITING_BOOTLOAD_CMD:
	case MXT_WAITING_FRAME_DATA:
		val &= ~MXT_BOOT_STATUS_MASK;
357
		break;
358 359
	case MXT_FRAME_CRC_PASS:
		if (val == MXT_FRAME_CRC_CHECK)
360 361 362 363 364 365 366 367 368 369 370 371 372 373
			goto recheck;
		break;
	default:
		return -EINVAL;
	}

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

	return 0;
}

374
static int mxt_unlock_bootloader(struct i2c_client *client)
375 376 377
{
	u8 buf[2];

378 379
	buf[0] = MXT_UNLOCK_CMD_LSB;
	buf[1] = MXT_UNLOCK_CMD_MSB;
380 381 382 383 384 385 386 387 388

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

	return 0;
}

389
static int mxt_fw_write(struct i2c_client *client,
390 391 392 393 394 395 396 397 398 399
			     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;
}

400
static int __mxt_read_reg(struct i2c_client *client,
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
			       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;
}

429
static int mxt_read_reg(struct i2c_client *client, u16 reg, u8 *val)
430
{
431
	return __mxt_read_reg(client, reg, 1, val);
432 433
}

434
static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
{
	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;
}

450
static int mxt_read_object_table(struct i2c_client *client,
451 452
				      u16 reg, u8 *object_buf)
{
453
	return __mxt_read_reg(client, reg, MXT_OBJECT_SIZE,
454 455 456
				   object_buf);
}

457 458
static struct mxt_object *
mxt_get_object(struct mxt_data *data, u8 type)
459
{
460
	struct mxt_object *object;
461 462 463 464 465 466 467 468 469 470 471 472
	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;
}

473 474
static int mxt_read_message(struct mxt_data *data,
				 struct mxt_message *message)
475
{
476
	struct mxt_object *object;
477 478
	u16 reg;

479
	object = mxt_get_object(data, MXT_GEN_MESSAGE_T5);
480 481 482 483
	if (!object)
		return -EINVAL;

	reg = object->start_address;
484 485
	return __mxt_read_reg(data->client, reg,
			sizeof(struct mxt_message), message);
486 487
}

488
static int mxt_read_object(struct mxt_data *data,
489 490
				u8 type, u8 offset, u8 *val)
{
491
	struct mxt_object *object;
492 493
	u16 reg;

494
	object = mxt_get_object(data, type);
495 496 497 498
	if (!object)
		return -EINVAL;

	reg = object->start_address;
499
	return __mxt_read_reg(data->client, reg + offset, 1, val);
500 501
}

502
static int mxt_write_object(struct mxt_data *data,
503 504
				 u8 type, u8 offset, u8 val)
{
505
	struct mxt_object *object;
506 507
	u16 reg;

508
	object = mxt_get_object(data, type);
509 510 511 512
	if (!object)
		return -EINVAL;

	reg = object->start_address;
513
	return mxt_write_reg(data->client, reg + offset, val);
514 515
}

516
static void mxt_input_report(struct mxt_data *data, int single_id)
517
{
518
	struct mxt_finger *finger = data->finger;
519 520 521 522 523
	struct input_dev *input_dev = data->input_dev;
	int status = finger[single_id].status;
	int finger_num = 0;
	int id;

524
	for (id = 0; id < MXT_MAX_FINGER; id++) {
525 526 527
		if (!finger[id].status)
			continue;

528 529 530
		input_mt_slot(input_dev, id);
		input_mt_report_slot_state(input_dev, MT_TOOL_FINGER,
				finger[id].status != MXT_RELEASE);
531

532
		if (finger[id].status != MXT_RELEASE) {
533
			finger_num++;
534 535 536 537 538 539
			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);
540 541
			input_report_abs(input_dev, ABS_MT_PRESSURE,
					finger[id].pressure);
542 543 544
		} else {
			finger[id].status = 0;
		}
545 546 547 548
	}

	input_report_key(input_dev, BTN_TOUCH, finger_num > 0);

549
	if (status != MXT_RELEASE) {
550 551
		input_report_abs(input_dev, ABS_X, finger[single_id].x);
		input_report_abs(input_dev, ABS_Y, finger[single_id].y);
552 553
		input_report_abs(input_dev,
				 ABS_PRESSURE, finger[single_id].pressure);
554 555 556 557 558
	}

	input_sync(input_dev);
}

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

	/* Check the touch is present on the screen */
571 572
	if (!(status & MXT_DETECT)) {
		if (status & MXT_RELEASE) {
573 574
			dev_dbg(dev, "[%d] released\n", id);

575 576
			finger[id].status = MXT_RELEASE;
			mxt_input_report(data, id);
577 578 579 580 581
		}
		return;
	}

	/* Check only AMP detection */
582
	if (!(status & (MXT_PRESS | MXT_MOVE)))
583 584
		return;

585 586 587 588 589 590 591
	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;

592
	area = message->message[4];
593
	pressure = message->message[5];
594 595

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

599 600
	finger[id].status = status & MXT_MOVE ?
				MXT_MOVE : MXT_PRESS;
601 602 603
	finger[id].x = x;
	finger[id].y = y;
	finger[id].area = area;
604
	finger[id].pressure = pressure;
605

606
	mxt_input_report(data, id);
607 608
}

609
static irqreturn_t mxt_interrupt(int irq, void *dev_id)
610
{
611 612 613
	struct mxt_data *data = dev_id;
	struct mxt_message message;
	struct mxt_object *object;
614 615 616 617 618 619 620
	struct device *dev = &data->client->dev;
	int id;
	u8 reportid;
	u8 max_reportid;
	u8 min_reportid;

	do {
621
		if (mxt_read_message(data, &message)) {
622 623 624 625 626 627
			dev_err(dev, "Failed to read message\n");
			goto end;
		}

		reportid = message.reportid;

628 629
		/* whether reportid is thing of MXT_TOUCH_MULTI_T9 */
		object = mxt_get_object(data, MXT_TOUCH_MULTI_T9);
630 631 632 633 634 635 636 637
		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)
638
			mxt_input_touchevent(data, &message, id);
639
		else
640
			mxt_dump_message(dev, &message);
641 642 643 644 645 646
	} while (reportid != 0xff);

end:
	return IRQ_HANDLED;
}

647
static int mxt_check_reg_init(struct mxt_data *data)
648
{
649
	const struct mxt_platform_data *pdata = data->pdata;
650
	struct mxt_object *object;
651 652
	struct device *dev = &data->client->dev;
	int index = 0;
653
	int i, j, config_offset;
654

655 656 657
	if (!pdata->config) {
		dev_dbg(dev, "No cfg data defined, skipping reg init\n");
		return 0;
658 659 660 661 662
	}

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

663
		if (!mxt_object_writable(object->type))
664 665
			continue;

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

	return 0;
}

683
static int mxt_make_highchg(struct mxt_data *data)
684 685
{
	struct device *dev = &data->client->dev;
686
	struct mxt_message message;
687 688 689 690 691
	int count = 10;
	int error;

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

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

	return 0;
}

705
static void mxt_handle_pdata(struct mxt_data *data)
706
{
707
	const struct mxt_platform_data *pdata = data->pdata;
708 709 710
	u8 voltage;

	/* Set touchscreen lines */
711
	mxt_write_object(data, MXT_TOUCH_MULTI_T9, MXT_TOUCH_XSIZE,
712
			pdata->x_line);
713
	mxt_write_object(data, MXT_TOUCH_MULTI_T9, MXT_TOUCH_YSIZE,
714 715 716
			pdata->y_line);

	/* Set touchscreen orient */
717
	mxt_write_object(data, MXT_TOUCH_MULTI_T9, MXT_TOUCH_ORIENT,
718 719 720
			pdata->orient);

	/* Set touchscreen burst length */
721
	mxt_write_object(data, MXT_TOUCH_MULTI_T9,
722
			MXT_TOUCH_BLEN, pdata->blen);
723 724

	/* Set touchscreen threshold */
725
	mxt_write_object(data, MXT_TOUCH_MULTI_T9,
726
			MXT_TOUCH_TCHTHR, pdata->threshold);
727 728

	/* Set touchscreen resolution */
729
	mxt_write_object(data, MXT_TOUCH_MULTI_T9,
730
			MXT_TOUCH_XRANGE_LSB, (pdata->x_size - 1) & 0xff);
731
	mxt_write_object(data, MXT_TOUCH_MULTI_T9,
732
			MXT_TOUCH_XRANGE_MSB, (pdata->x_size - 1) >> 8);
733
	mxt_write_object(data, MXT_TOUCH_MULTI_T9,
734
			MXT_TOUCH_YRANGE_LSB, (pdata->y_size - 1) & 0xff);
735
	mxt_write_object(data, MXT_TOUCH_MULTI_T9,
736
			MXT_TOUCH_YRANGE_MSB, (pdata->y_size - 1) >> 8);
737 738

	/* Set touchscreen voltage */
739
	if (pdata->voltage) {
740 741 742
		if (pdata->voltage < MXT_VOLTAGE_DEFAULT) {
			voltage = (MXT_VOLTAGE_DEFAULT - pdata->voltage) /
				MXT_VOLTAGE_STEP;
743 744
			voltage = 0xff - voltage + 1;
		} else
745 746
			voltage = (pdata->voltage - MXT_VOLTAGE_DEFAULT) /
				MXT_VOLTAGE_STEP;
747

748
		mxt_write_object(data, MXT_SPT_CTECONFIG_T28,
749
				MXT_CTE_VOLTAGE, voltage);
750 751 752
	}
}

753
static int mxt_get_info(struct mxt_data *data)
754 755
{
	struct i2c_client *client = data->client;
756
	struct mxt_info *info = &data->info;
757 758 759
	int error;
	u8 val;

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

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

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

775
	error = mxt_read_reg(client, MXT_BUILD, &val);
776 777 778 779
	if (error)
		return error;
	info->build = val;

780
	error = mxt_read_reg(client, MXT_OBJECT_NUM, &val);
781 782 783 784 785 786 787
	if (error)
		return error;
	info->object_num = val;

	return 0;
}

788
static int mxt_get_object_table(struct mxt_data *data)
789 790 791 792 793
{
	int error;
	int i;
	u16 reg;
	u8 reportid = 0;
794
	u8 buf[MXT_OBJECT_SIZE];
795 796

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

799 800
		reg = MXT_OBJECT_START + MXT_OBJECT_SIZE * i;
		error = mxt_read_object_table(data->client, reg, buf);
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
		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;
}

820
static int mxt_initialize(struct mxt_data *data)
821 822
{
	struct i2c_client *client = data->client;
823
	struct mxt_info *info = &data->info;
824 825 826
	int error;
	u8 val;

827
	error = mxt_get_info(data);
828 829 830 831
	if (error)
		return error;

	data->object_table = kcalloc(info->object_num,
832
				     sizeof(struct mxt_object),
833 834 835 836 837 838 839
				     GFP_KERNEL);
	if (!data->object_table) {
		dev_err(&client->dev, "Failed to allocate memory\n");
		return -ENOMEM;
	}

	/* Get object table information */
840
	error = mxt_get_object_table(data);
841 842 843 844
	if (error)
		return error;

	/* Check register init values */
845
	error = mxt_check_reg_init(data);
846 847 848
	if (error)
		return error;

849
	mxt_handle_pdata(data);
850 851

	/* Backup to memory */
852
	mxt_write_object(data, MXT_GEN_COMMAND_T6,
853 854 855
			MXT_COMMAND_BACKUPNV,
			MXT_BACKUP_VALUE);
	msleep(MXT_BACKUP_TIME);
856 857

	/* Soft reset */
858
	mxt_write_object(data, MXT_GEN_COMMAND_T6,
859 860
			MXT_COMMAND_RESET, 1);
	msleep(MXT_RESET_TIME);
861 862

	/* Update matrix size at info struct */
863
	error = mxt_read_reg(client, MXT_MATRIX_X_SIZE, &val);
864 865 866 867
	if (error)
		return error;
	info->matrix_xsize = val;

868
	error = mxt_read_reg(client, MXT_MATRIX_Y_SIZE, &val);
869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
	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;
}

886 887 888 889 890 891 892 893 894 895 896 897 898 899
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;
	}
}

900
static ssize_t mxt_object_show(struct device *dev,
901 902
				    struct device_attribute *attr, char *buf)
{
903 904
	struct mxt_data *data = dev_get_drvdata(dev);
	struct mxt_object *object;
905 906 907 908 909 910 911 912
	int count = 0;
	int i, j;
	int error;
	u8 val;

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

913 914
		count += snprintf(buf + count, PAGE_SIZE - count,
				"Object[%d] (Type %d)\n",
915
				i + 1, object->type);
916 917
		if (count >= PAGE_SIZE)
			return PAGE_SIZE - 1;
918

919
		if (!mxt_object_readable(object->type)) {
920 921 922 923
			count += snprintf(buf + count, PAGE_SIZE - count,
					"\n");
			if (count >= PAGE_SIZE)
				return PAGE_SIZE - 1;
924 925 926 927
			continue;
		}

		for (j = 0; j < object->size + 1; j++) {
928
			error = mxt_read_object(data,
929 930 931 932
						object->type, j, &val);
			if (error)
				return error;

933 934 935 936
			count += snprintf(buf + count, PAGE_SIZE - count,
					"\t[%2d]: %02x (%d)\n", j, val, val);
			if (count >= PAGE_SIZE)
				return PAGE_SIZE - 1;
937 938
		}

939 940 941
		count += snprintf(buf + count, PAGE_SIZE - count, "\n");
		if (count >= PAGE_SIZE)
			return PAGE_SIZE - 1;
942 943 944 945 946
	}

	return count;
}

947
static int mxt_load_fw(struct device *dev, const char *fn)
948
{
949
	struct mxt_data *data = dev_get_drvdata(dev);
950 951 952 953 954 955 956 957 958 959 960 961 962
	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 */
963
	mxt_write_object(data, MXT_GEN_COMMAND_T6,
964 965
			MXT_COMMAND_RESET, MXT_BOOT_VALUE);
	msleep(MXT_RESET_TIME);
966 967

	/* Change to slave address of bootloader */
968 969
	if (client->addr == MXT_APP_LOW)
		client->addr = MXT_BOOT_LOW;
970
	else
971
		client->addr = MXT_BOOT_HIGH;
972

973
	ret = mxt_check_bootloader(client, MXT_WAITING_BOOTLOAD_CMD);
974 975 976 977
	if (ret)
		goto out;

	/* Unlock bootloader */
978
	mxt_unlock_bootloader(client);
979 980

	while (pos < fw->size) {
981 982
		ret = mxt_check_bootloader(client,
						MXT_WAITING_FRAME_DATA);
983 984 985 986 987 988 989 990 991 992 993
		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 */
994
		mxt_fw_write(client, fw->data + pos, frame_size);
995

996 997
		ret = mxt_check_bootloader(client,
						MXT_FRAME_CRC_PASS);
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
		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 */
1010 1011
	if (client->addr == MXT_BOOT_LOW)
		client->addr = MXT_APP_LOW;
1012
	else
1013
		client->addr = MXT_APP_HIGH;
1014 1015 1016 1017

	return ret;
}

1018
static ssize_t mxt_update_fw_store(struct device *dev,
1019 1020 1021
					struct device_attribute *attr,
					const char *buf, size_t count)
{
1022
	struct mxt_data *data = dev_get_drvdata(dev);
1023 1024 1025 1026
	int error;

	disable_irq(data->irq);

1027
	error = mxt_load_fw(dev, MXT_FW_NAME);
1028 1029 1030 1031 1032 1033 1034
	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 */
1035
		msleep(MXT_FWRESET_TIME);
1036 1037 1038 1039

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

1040
		mxt_initialize(data);
1041 1042 1043 1044
	}

	enable_irq(data->irq);

1045 1046 1047 1048
	error = mxt_make_highchg(data);
	if (error)
		return error;

1049 1050 1051
	return count;
}

1052 1053
static DEVICE_ATTR(object, 0444, mxt_object_show, NULL);
static DEVICE_ATTR(update_fw, 0664, NULL, mxt_update_fw_store);
1054

1055
static struct attribute *mxt_attrs[] = {
1056 1057 1058 1059 1060
	&dev_attr_object.attr,
	&dev_attr_update_fw.attr,
	NULL
};

1061 1062
static const struct attribute_group mxt_attr_group = {
	.attrs = mxt_attrs,
1063 1064
};

1065
static void mxt_start(struct mxt_data *data)
1066 1067
{
	/* Touch enable */
1068
	mxt_write_object(data,
1069
			MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0x83);
1070 1071
}

1072
static void mxt_stop(struct mxt_data *data)
1073 1074
{
	/* Touch disable */
1075
	mxt_write_object(data,
1076
			MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0);
1077 1078
}

1079
static int mxt_input_open(struct input_dev *dev)
1080
{
1081
	struct mxt_data *data = input_get_drvdata(dev);
1082

1083
	mxt_start(data);
1084 1085 1086 1087

	return 0;
}

1088
static void mxt_input_close(struct input_dev *dev)
1089
{
1090
	struct mxt_data *data = input_get_drvdata(dev);
1091

1092
	mxt_stop(data);
1093 1094
}

1095
static int __devinit mxt_probe(struct i2c_client *client,
1096 1097
		const struct i2c_device_id *id)
{
1098
	const struct mxt_platform_data *pdata = client->dev.platform_data;
1099
	struct mxt_data *data;
1100 1101 1102
	struct input_dev *input_dev;
	int error;

1103
	if (!pdata)
1104 1105
		return -EINVAL;

1106
	data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL);
1107 1108 1109 1110 1111 1112 1113
	input_dev = input_allocate_device();
	if (!data || !input_dev) {
		dev_err(&client->dev, "Failed to allocate memory\n");
		error = -ENOMEM;
		goto err_free_mem;
	}

1114
	input_dev->name = "Atmel maXTouch Touchscreen";
1115 1116
	input_dev->id.bustype = BUS_I2C;
	input_dev->dev.parent = &client->dev;
1117 1118
	input_dev->open = mxt_input_open;
	input_dev->close = mxt_input_close;
1119

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

	mxt_calc_resolution(data);

1127 1128 1129 1130 1131 1132
	__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,
1133
			     0, data->max_x, 0, 0);
1134
	input_set_abs_params(input_dev, ABS_Y,
1135
			     0, data->max_y, 0, 0);
1136 1137
	input_set_abs_params(input_dev, ABS_PRESSURE,
			     0, 255, 0, 0);
1138 1139

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

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

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

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

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

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

1172
	error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
	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;
}

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

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

	return 0;
}

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

	mutex_lock(&input_dev->mutex);

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

	mutex_unlock(&input_dev->mutex);

	return 0;
}

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

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

1231
	msleep(MXT_RESET_TIME);
1232 1233 1234 1235

	mutex_lock(&input_dev->mutex);

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

	mutex_unlock(&input_dev->mutex);

	return 0;
}
1242

1243 1244 1245
static const struct dev_pm_ops mxt_pm_ops = {
	.suspend	= mxt_suspend,
	.resume		= mxt_resume,
1246
};
1247 1248
#endif

1249
static const struct i2c_device_id mxt_id[] = {
1250
	{ "qt602240_ts", 0 },
1251
	{ "atmel_mxt_ts", 0 },
1252
	{ "mXT224", 0 },
1253 1254
	{ }
};
1255
MODULE_DEVICE_TABLE(i2c, mxt_id);
1256

1257
static struct i2c_driver mxt_driver = {
1258
	.driver = {
1259
		.name	= "atmel_mxt_ts",
1260
		.owner	= THIS_MODULE,
1261
#ifdef CONFIG_PM
1262
		.pm	= &mxt_pm_ops,
1263
#endif
1264
	},
1265 1266 1267
	.probe		= mxt_probe,
	.remove		= __devexit_p(mxt_remove),
	.id_table	= mxt_id,
1268 1269
};

1270
module_i2c_driver(mxt_driver);
1271 1272 1273

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