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 254 255 256
	const struct mxt_platform_data *pdata;
	struct mxt_object *object_table;
	struct mxt_info info;
	struct mxt_finger finger[MXT_MAX_FINGER];
257
	unsigned int irq;
258 259
	unsigned int max_x;
	unsigned int max_y;
260 261
};

262
static bool mxt_object_readable(unsigned int type)
263 264
{
	switch (type) {
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
	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:
290 291 292 293 294 295
		return true;
	default:
		return false;
	}
}

296
static bool mxt_object_writable(unsigned int type)
297 298
{
	switch (type) {
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
	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:
321 322 323 324 325 326
		return true;
	default:
		return false;
	}
}

327 328
static void mxt_dump_message(struct device *dev,
				  struct mxt_message *message)
329 330 331 332 333 334 335 336 337 338 339
{
	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]);
}

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

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

	return 0;
}

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

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

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

	return 0;
}

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

398
static int __mxt_read_reg(struct i2c_client *client,
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 424 425 426
			       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;
}

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

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

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

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

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

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

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

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

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

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

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

506
	object = mxt_get_object(data, type);
507
	if (!object || offset >= object->size + 1)
508 509 510
		return -EINVAL;

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

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

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

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

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

	input_report_key(input_dev, BTN_TOUCH, finger_num > 0);

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

	input_sync(input_dev);
}

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

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

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

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

583 584 585 586 587 588 589
	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;

590
	area = message->message[4];
591
	pressure = message->message[5];
592 593

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

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

604
	mxt_input_report(data, id);
605 606
}

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

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

		reportid = message.reportid;

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

end:
	return IRQ_HANDLED;
}

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

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

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

661
		if (!mxt_object_writable(object->type))
662 663
			continue;

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

	return 0;
}

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

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

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

	return 0;
}

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

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

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

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

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

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

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

746
		mxt_write_object(data, MXT_SPT_CTECONFIG_T28,
747
				MXT_CTE_VOLTAGE, voltage);
748 749 750
	}
}

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

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

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

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

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

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

	return 0;
}

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

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

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

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

825
	error = mxt_get_info(data);
826 827 828 829
	if (error)
		return error;

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

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

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

847
	mxt_handle_pdata(data);
848 849

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

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

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

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

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

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

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

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

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

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

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

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

	return count;
}

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

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

971
	ret = mxt_check_bootloader(client, MXT_WAITING_BOOTLOAD_CMD);
972 973 974 975
	if (ret)
		goto out;

	/* Unlock bootloader */
976
	mxt_unlock_bootloader(client);
977 978

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

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

	return ret;
}

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

	disable_irq(data->irq);

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

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

1038
		mxt_initialize(data);
1039 1040 1041 1042
	}

	enable_irq(data->irq);

1043 1044 1045 1046
	error = mxt_make_highchg(data);
	if (error)
		return error;

1047 1048 1049
	return count;
}

1050 1051
static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
1052

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

1059 1060
static const struct attribute_group mxt_attr_group = {
	.attrs = mxt_attrs,
1061 1062
};

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

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

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

1081
	mxt_start(data);
1082 1083 1084 1085

	return 0;
}

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

1090
	mxt_stop(data);
1091 1092
}

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

1101
	if (!pdata)
1102 1103
		return -EINVAL;

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

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

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

	mxt_calc_resolution(data);

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

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

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

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

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

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

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

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

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

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

	return 0;
}

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

	mutex_lock(&input_dev->mutex);

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

	mutex_unlock(&input_dev->mutex);

	return 0;
}

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

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

1229
	msleep(MXT_RESET_TIME);
1230 1231 1232 1233

	mutex_lock(&input_dev->mutex);

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

	mutex_unlock(&input_dev->mutex);

	return 0;
}
#endif

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

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

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

1263
module_i2c_driver(mxt_driver);
1264 1265 1266

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