atmel_mxt_ts.c 62.4 KB
Newer Older
1
/*
2
 * Atmel maXTouch Touchscreen driver
3 4
 *
 * Copyright (C) 2010 Samsung Electronics Co.Ltd
5
 * Copyright (C) 2011-2014 Atmel Corporation
6 7
 * Copyright (C) 2012 Google, Inc.
 *
8 9 10 11 12 13 14 15 16
 * 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.
 *
 */

17 18
#include <linux/acpi.h>
#include <linux/dmi.h>
19
#include <linux/module.h>
20 21
#include <linux/init.h>
#include <linux/completion.h>
22 23 24
#include <linux/delay.h>
#include <linux/firmware.h>
#include <linux/i2c.h>
25
#include <linux/platform_data/atmel_mxt_ts.h>
26
#include <linux/input/mt.h>
27
#include <linux/interrupt.h>
28
#include <linux/of.h>
29
#include <linux/slab.h>
30
#include <asm/unaligned.h>
31

32
/* Firmware files */
33
#define MXT_FW_NAME		"maxtouch.fw"
34 35
#define MXT_CFG_NAME		"maxtouch.cfg"
#define MXT_CFG_MAGIC		"OBP_RAW V1"
36 37

/* Registers */
38 39
#define MXT_OBJECT_START	0x07
#define MXT_OBJECT_SIZE		6
40 41
#define MXT_INFO_CHECKSUM_SIZE	3
#define MXT_MAX_BLOCK_WRITE	256
42 43

/* Object types */
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
#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
71
#define MXT_TOUCH_MULTITOUCHSCREEN_T100 100
72

73 74 75
/* MXT_GEN_MESSAGE_T5 object */
#define MXT_RPTID_NOMSG		0xff

76
/* MXT_GEN_COMMAND_T6 field */
77 78 79 80 81 82
#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

83 84
/* Define for T6 status byte */
#define MXT_T6_STATUS_RESET	(1 << 7)
85 86 87 88 89
#define MXT_T6_STATUS_OFL	(1 << 6)
#define MXT_T6_STATUS_SIGERR	(1 << 5)
#define MXT_T6_STATUS_CAL	(1 << 4)
#define MXT_T6_STATUS_CFGERR	(1 << 3)
#define MXT_T6_STATUS_COMSERR	(1 << 2)
90

91
/* MXT_GEN_POWER_T7 field */
92 93 94 95 96 97 98
struct t7_config {
	u8 idle;
	u8 active;
} __packed;

#define MXT_POWER_CFG_RUN		0
#define MXT_POWER_CFG_DEEPSLEEP		1
99

100
/* MXT_TOUCH_MULTI_T9 field */
101
#define MXT_T9_CTRL		0
102 103 104
#define MXT_T9_ORIENT		9
#define MXT_T9_RANGE		18

105 106 107 108 109 110 111 112 113 114
/* MXT_TOUCH_MULTI_T9 status */
#define MXT_T9_UNGRIP		(1 << 0)
#define MXT_T9_SUPPRESS		(1 << 1)
#define MXT_T9_AMP		(1 << 2)
#define MXT_T9_VECTOR		(1 << 3)
#define MXT_T9_MOVE		(1 << 4)
#define MXT_T9_RELEASE		(1 << 5)
#define MXT_T9_PRESS		(1 << 6)
#define MXT_T9_DETECT		(1 << 7)

115 116 117 118 119
struct t9_range {
	u16 x;
	u16 y;
} __packed;

120 121
/* MXT_TOUCH_MULTI_T9 orient */
#define MXT_T9_ORIENT_SWITCH	(1 << 0)
122

123
/* MXT_SPT_COMMSCONFIG_T18 */
124 125 126
#define MXT_COMMS_CTRL		0
#define MXT_COMMS_CMD		1

127
/* Define for MXT_GEN_COMMAND_T6 */
128
#define MXT_BOOT_VALUE		0xa5
129
#define MXT_RESET_VALUE		0x01
130
#define MXT_BACKUP_VALUE	0x55
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 160 161
/* T100 Multiple Touch Touchscreen */
#define MXT_T100_CTRL		0
#define MXT_T100_CFG1		1
#define MXT_T100_TCHAUX		3
#define MXT_T100_XRANGE		13
#define MXT_T100_YRANGE		24

#define MXT_T100_CFG_SWITCHXY	BIT(5)

#define MXT_T100_TCHAUX_VECT	BIT(0)
#define MXT_T100_TCHAUX_AMPL	BIT(1)
#define MXT_T100_TCHAUX_AREA	BIT(2)

#define MXT_T100_DETECT		BIT(7)
#define MXT_T100_TYPE_MASK	0x70

enum t100_type {
	MXT_T100_TYPE_FINGER		= 1,
	MXT_T100_TYPE_PASSIVE_STYLUS	= 2,
	MXT_T100_TYPE_HOVERING_FINGER	= 4,
	MXT_T100_TYPE_GLOVE		= 5,
	MXT_T100_TYPE_LARGE_TOUCH	= 6,
};

#define MXT_DISTANCE_ACTIVE_TOUCH	0
#define MXT_DISTANCE_HOVERING		1

#define MXT_TOUCH_MAJOR_DEFAULT		1
#define MXT_PRESSURE_DEFAULT		1

162
/* Delay times */
163 164
#define MXT_BACKUP_TIME		50	/* msec */
#define MXT_RESET_TIME		200	/* msec */
165
#define MXT_RESET_TIMEOUT	3000	/* msec */
166
#define MXT_CRC_TIMEOUT		1000	/* msec */
167 168
#define MXT_FW_RESET_TIME	3000	/* msec */
#define MXT_FW_CHG_TIMEOUT	300	/* msec */
169 170

/* Command to unlock bootloader */
171 172
#define MXT_UNLOCK_CMD_MSB	0xaa
#define MXT_UNLOCK_CMD_LSB	0xdc
173 174

/* Bootloader mode status */
175 176 177 178 179 180 181
#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
182 183
#define MXT_BOOT_EXTENDED_ID	(1 << 5)
#define MXT_BOOT_ID_MASK	0x1f
184 185

/* Touchscreen absolute values */
186
#define MXT_MAX_AREA		0xff
187

188 189
#define MXT_PIXELS_PER_MM	20

190
struct mxt_info {
191 192 193 194 195 196 197 198 199
	u8 family_id;
	u8 variant_id;
	u8 version;
	u8 build;
	u8 matrix_xsize;
	u8 matrix_ysize;
	u8 object_num;
};

200
struct mxt_object {
201 202
	u8 type;
	u16 start_address;
203 204
	u8 size_minus_one;
	u8 instances_minus_one;
205
	u8 num_report_ids;
206
} __packed;
207 208

/* Each client has this additional data */
209
struct mxt_data {
210 211
	struct i2c_client *client;
	struct input_dev *input_dev;
212
	char phys[64];		/* device physical location */
213 214 215
	const struct mxt_platform_data *pdata;
	struct mxt_object *object_table;
	struct mxt_info info;
216
	unsigned int irq;
217 218
	unsigned int max_x;
	unsigned int max_y;
219
	bool in_bootloader;
220
	u16 mem_size;
221 222 223
	u8 t100_aux_ampl;
	u8 t100_aux_area;
	u8 t100_aux_vect;
224
	u8 max_reportid;
225
	u32 config_crc;
226
	u32 info_crc;
227
	u8 bootloader_addr;
228
	u8 *msg_buf;
229
	u8 t6_status;
230
	bool update_input;
231 232
	u8 last_message_count;
	u8 num_touchids;
233
	u8 multitouch;
234
	struct t7_config t7_cfg;
235 236

	/* Cached parameters from object table */
237
	u16 T5_address;
238
	u8 T5_msg_size;
239
	u8 T6_reportid;
240
	u16 T6_address;
241
	u16 T7_address;
242 243
	u8 T9_reportid_min;
	u8 T9_reportid_max;
244
	u8 T19_reportid;
245
	u16 T44_address;
246 247
	u8 T100_reportid_min;
	u8 T100_reportid_max;
248 249 250

	/* for fw update in bootloader */
	struct completion bl_completion;
251 252 253

	/* for reset handling */
	struct completion reset_completion;
254 255 256

	/* for config update handling */
	struct completion crc_completion;
257 258
};

259 260 261 262 263 264 265 266 267 268
static size_t mxt_obj_size(const struct mxt_object *obj)
{
	return obj->size_minus_one + 1;
}

static size_t mxt_obj_instances(const struct mxt_object *obj)
{
	return obj->instances_minus_one + 1;
}

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

302
static void mxt_dump_message(struct mxt_data *data, u8 *message)
303
{
304 305
	dev_dbg(&data->client->dev, "message: %*ph\n",
		data->T5_msg_size, message);
306 307
}

308 309 310
static int mxt_wait_for_completion(struct mxt_data *data,
				   struct completion *comp,
				   unsigned int timeout_ms)
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
{
	struct device *dev = &data->client->dev;
	unsigned long timeout = msecs_to_jiffies(timeout_ms);
	long ret;

	ret = wait_for_completion_interruptible_timeout(comp, timeout);
	if (ret < 0) {
		return ret;
	} else if (ret == 0) {
		dev_err(dev, "Wait for completion timed out.\n");
		return -ETIMEDOUT;
	}
	return 0;
}

326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
static int mxt_bootloader_read(struct mxt_data *data,
			       u8 *val, unsigned int count)
{
	int ret;
	struct i2c_msg msg;

	msg.addr = data->bootloader_addr;
	msg.flags = data->client->flags & I2C_M_TEN;
	msg.flags |= I2C_M_RD;
	msg.len = count;
	msg.buf = val;

	ret = i2c_transfer(data->client->adapter, &msg, 1);
	if (ret == 1) {
		ret = 0;
	} else {
		ret = ret < 0 ? ret : -EIO;
		dev_err(&data->client->dev, "%s: i2c recv failed (%d)\n",
			__func__, ret);
	}

	return ret;
}

static int mxt_bootloader_write(struct mxt_data *data,
				const u8 * const val, unsigned int count)
{
	int ret;
	struct i2c_msg msg;

	msg.addr = data->bootloader_addr;
	msg.flags = data->client->flags & I2C_M_TEN;
	msg.len = count;
	msg.buf = (u8 *)val;

	ret = i2c_transfer(data->client->adapter, &msg, 1);
	if (ret == 1) {
		ret = 0;
	} else {
		ret = ret < 0 ? ret : -EIO;
		dev_err(&data->client->dev, "%s: i2c send failed (%d)\n",
			__func__, ret);
	}

	return ret;
}

373
static int mxt_lookup_bootloader_address(struct mxt_data *data, bool retry)
374 375 376 377 378 379 380
{
	u8 appmode = data->client->addr;
	u8 bootloader;

	switch (appmode) {
	case 0x4a:
	case 0x4b:
381
		/* Chips after 1664S use different scheme */
382
		if (retry || data->info.family_id >= 0xa2) {
383 384 385 386
			bootloader = appmode - 0x24;
			break;
		}
		/* Fall through for normal case */
387 388 389 390 391 392
	case 0x4c:
	case 0x4d:
	case 0x5a:
	case 0x5b:
		bootloader = appmode - 0x26;
		break;
393

394 395 396 397 398 399 400 401 402 403 404
	default:
		dev_err(&data->client->dev,
			"Appmode i2c address 0x%02x not found\n",
			appmode);
		return -EINVAL;
	}

	data->bootloader_addr = bootloader;
	return 0;
}

405
static int mxt_probe_bootloader(struct mxt_data *data, bool alt_address)
406 407
{
	struct device *dev = &data->client->dev;
408
	int error;
409 410 411
	u8 val;
	bool crc_failure;

412 413 414
	error = mxt_lookup_bootloader_address(data, alt_address);
	if (error)
		return error;
415

416 417 418
	error = mxt_bootloader_read(data, &val, 1);
	if (error)
		return error;
419 420 421 422 423 424 425 426 427 428

	/* Check app crc fail mode */
	crc_failure = (val & ~MXT_BOOT_STATUS_MASK) == MXT_APP_CRC_FAIL;

	dev_err(dev, "Detected bootloader, status:%02X%s\n",
			val, crc_failure ? ", APP_CRC_FAIL" : "");

	return 0;
}

429 430 431 432 433 434 435 436
static u8 mxt_get_bootloader_version(struct mxt_data *data, u8 val)
{
	struct device *dev = &data->client->dev;
	u8 buf[3];

	if (val & MXT_BOOT_EXTENDED_ID) {
		if (mxt_bootloader_read(data, &buf[0], 3) != 0) {
			dev_err(dev, "%s: i2c failure\n", __func__);
437
			return val;
438 439 440 441 442 443 444 445 446 447 448 449
		}

		dev_dbg(dev, "Bootloader ID:%d Version:%d\n", buf[1], buf[2]);

		return buf[0];
	} else {
		dev_dbg(dev, "Bootloader ID:%d\n", val & MXT_BOOT_ID_MASK);

		return val;
	}
}

450 451
static int mxt_check_bootloader(struct mxt_data *data, unsigned int state,
				bool wait)
452
{
453
	struct device *dev = &data->client->dev;
454
	u8 val;
455
	int ret;
456 457

recheck:
458
	if (wait) {
459 460 461 462 463 464
		/*
		 * In application update mode, the interrupt
		 * line signals state transitions. We must wait for the
		 * CHG assertion before reading the status byte.
		 * Once the status byte has been read, the line is deasserted.
		 */
465 466
		ret = mxt_wait_for_completion(data, &data->bl_completion,
					      MXT_FW_CHG_TIMEOUT);
467 468 469 470 471 472 473
		if (ret) {
			/*
			 * TODO: handle -ERESTARTSYS better by terminating
			 * fw update process before returning to userspace
			 * by writing length 0x000 to device (iff we are in
			 * WAITING_FRAME_DATA state).
			 */
474
			dev_err(dev, "Update wait error %d\n", ret);
475 476 477 478
			return ret;
		}
	}

479 480 481
	ret = mxt_bootloader_read(data, &val, 1);
	if (ret)
		return ret;
482

483 484 485
	if (state == MXT_WAITING_BOOTLOAD_CMD)
		val = mxt_get_bootloader_version(data, val);

486
	switch (state) {
487 488
	case MXT_WAITING_BOOTLOAD_CMD:
	case MXT_WAITING_FRAME_DATA:
489
	case MXT_APP_CRC_FAIL:
490
		val &= ~MXT_BOOT_STATUS_MASK;
491
		break;
492
	case MXT_FRAME_CRC_PASS:
493
		if (val == MXT_FRAME_CRC_CHECK) {
494
			goto recheck;
495 496 497 498
		} else if (val == MXT_FRAME_CRC_FAIL) {
			dev_err(dev, "Bootloader CRC fail\n");
			return -EINVAL;
		}
499 500 501 502 503 504
		break;
	default:
		return -EINVAL;
	}

	if (val != state) {
505
		dev_err(dev, "Invalid bootloader state %02X != %02X\n",
506
			val, state);
507 508 509 510 511 512
		return -EINVAL;
	}

	return 0;
}

513
static int mxt_send_bootloader_cmd(struct mxt_data *data, bool unlock)
514
{
515
	int ret;
516 517
	u8 buf[2];

518 519 520 521 522 523 524
	if (unlock) {
		buf[0] = MXT_UNLOCK_CMD_LSB;
		buf[1] = MXT_UNLOCK_CMD_MSB;
	} else {
		buf[0] = 0x01;
		buf[1] = 0x01;
	}
525

526 527 528
	ret = mxt_bootloader_write(data, buf, 2);
	if (ret)
		return ret;
529 530 531 532

	return 0;
}

533
static int __mxt_read_reg(struct i2c_client *client,
534 535 536 537
			       u16 reg, u16 len, void *val)
{
	struct i2c_msg xfer[2];
	u8 buf[2];
538
	int ret;
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554

	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;

555 556 557 558 559 560 561 562
	ret = i2c_transfer(client->adapter, xfer, 2);
	if (ret == 2) {
		ret = 0;
	} else {
		if (ret >= 0)
			ret = -EIO;
		dev_err(&client->dev, "%s: i2c transfer failed (%d)\n",
			__func__, ret);
563 564
	}

565
	return ret;
566 567
}

568 569
static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len,
			   const void *val)
570
{
571 572
	u8 *buf;
	size_t count;
573
	int ret;
574

575 576 577 578
	count = len + 2;
	buf = kmalloc(count, GFP_KERNEL);
	if (!buf)
		return -ENOMEM;
579 580 581

	buf[0] = reg & 0xff;
	buf[1] = (reg >> 8) & 0xff;
582
	memcpy(&buf[2], val, len);
583

584 585
	ret = i2c_master_send(client, buf, count);
	if (ret == count) {
586 587 588 589 590 591
		ret = 0;
	} else {
		if (ret >= 0)
			ret = -EIO;
		dev_err(&client->dev, "%s: i2c send failed (%d)\n",
			__func__, ret);
592 593
	}

594
	kfree(buf);
595
	return ret;
596 597
}

598
static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
599
{
600
	return __mxt_write_reg(client, reg, 1, &val);
601 602
}

603 604
static struct mxt_object *
mxt_get_object(struct mxt_data *data, u8 type)
605
{
606
	struct mxt_object *object;
607 608 609 610 611 612 613 614
	int i;

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

615
	dev_warn(&data->client->dev, "Invalid object type T%u\n", type);
616 617 618
	return NULL;
}

619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
static void mxt_proc_t6_messages(struct mxt_data *data, u8 *msg)
{
	struct device *dev = &data->client->dev;
	u8 status = msg[1];
	u32 crc = msg[2] | (msg[3] << 8) | (msg[4] << 16);

	complete(&data->crc_completion);

	if (crc != data->config_crc) {
		data->config_crc = crc;
		dev_dbg(dev, "T6 Config Checksum: 0x%06X\n", crc);
	}

	/* Detect reset */
	if (status & MXT_T6_STATUS_RESET)
		complete(&data->reset_completion);

	/* Output debug if status has changed */
	if (status != data->t6_status)
		dev_dbg(dev, "T6 Status 0x%02X%s%s%s%s%s%s%s\n",
			status,
			status == 0 ? " OK" : "",
			status & MXT_T6_STATUS_RESET ? " RESET" : "",
			status & MXT_T6_STATUS_OFL ? " OFL" : "",
			status & MXT_T6_STATUS_SIGERR ? " SIGERR" : "",
			status & MXT_T6_STATUS_CAL ? " CAL" : "",
			status & MXT_T6_STATUS_CFGERR ? " CFGERR" : "",
			status & MXT_T6_STATUS_COMSERR ? " COMSERR" : "");

	/* Save current status */
	data->t6_status = status;
}

652 653 654 655 656 657 658 659 660 661 662 663 664 665
static int mxt_write_object(struct mxt_data *data,
				 u8 type, u8 offset, u8 val)
{
	struct mxt_object *object;
	u16 reg;

	object = mxt_get_object(data, type);
	if (!object || offset >= mxt_obj_size(object))
		return -EINVAL;

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

666
static void mxt_input_button(struct mxt_data *data, u8 *message)
667 668
{
	struct input_dev *input = data->input_dev;
669
	const struct mxt_platform_data *pdata = data->pdata;
670 671
	int i;

672 673
	for (i = 0; i < pdata->t19_num_keys; i++) {
		if (pdata->t19_keymap[i] == KEY_RESERVED)
674
			continue;
675 676 677 678

		/* Active-low switch */
		input_report_key(input, pdata->t19_keymap[i],
				 !(message[1] & BIT(i)));
679 680 681
	}
}

682
static void mxt_input_sync(struct mxt_data *data)
683
{
684 685 686
	input_mt_report_pointer_emulation(data->input_dev,
					  data->pdata->t19_num_keys);
	input_sync(data->input_dev);
687 688
}

689
static void mxt_proc_t9_message(struct mxt_data *data, u8 *message)
690 691
{
	struct device *dev = &data->client->dev;
692
	struct input_dev *input_dev = data->input_dev;
693 694
	int id;
	u8 status;
695 696 697
	int x;
	int y;
	int area;
698
	int amplitude;
699

700 701 702 703
	id = message[0] - data->T9_reportid_min;
	status = message[1];
	x = (message[2] << 4) | ((message[4] >> 4) & 0xf);
	y = (message[3] << 4) | ((message[4] & 0xf));
704 705

	/* Handle 10/12 bit switching */
706
	if (data->max_x < 1024)
707
		x >>= 2;
708
	if (data->max_y < 1024)
709
		y >>= 2;
710

711 712
	area = message[5];
	amplitude = message[6];
713

714 715 716
	dev_dbg(dev,
		"[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
		id,
717 718 719 720 721 722 723 724
		(status & MXT_T9_DETECT) ? 'D' : '.',
		(status & MXT_T9_PRESS) ? 'P' : '.',
		(status & MXT_T9_RELEASE) ? 'R' : '.',
		(status & MXT_T9_MOVE) ? 'M' : '.',
		(status & MXT_T9_VECTOR) ? 'V' : '.',
		(status & MXT_T9_AMP) ? 'A' : '.',
		(status & MXT_T9_SUPPRESS) ? 'S' : '.',
		(status & MXT_T9_UNGRIP) ? 'U' : '.',
725
		x, y, area, amplitude);
726

727 728
	input_mt_slot(input_dev, id);

729
	if (status & MXT_T9_DETECT) {
730 731 732 733 734 735 736 737
		/*
		 * Multiple bits may be set if the host is slow to read
		 * the status messages, indicating all the events that
		 * have happened.
		 */
		if (status & MXT_T9_RELEASE) {
			input_mt_report_slot_state(input_dev,
						   MT_TOOL_FINGER, 0);
738
			mxt_input_sync(data);
739 740 741 742
		}

		/* Touch active */
		input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 1);
743 744
		input_report_abs(input_dev, ABS_MT_POSITION_X, x);
		input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
745
		input_report_abs(input_dev, ABS_MT_PRESSURE, amplitude);
746
		input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
747 748 749
	} else {
		/* Touch no longer active, close out slot */
		input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 0);
750
	}
751 752

	data->update_input = true;
753 754
}

755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
static void mxt_proc_t100_message(struct mxt_data *data, u8 *message)
{
	struct device *dev = &data->client->dev;
	struct input_dev *input_dev = data->input_dev;
	int id;
	u8 status;
	u8 type = 0;
	u16 x;
	u16 y;
	int distance = 0;
	int tool = 0;
	u8 major = 0;
	u8 pressure = 0;
	u8 orientation = 0;

	id = message[0] - data->T100_reportid_min - 2;

	/* ignore SCRSTATUS events */
	if (id < 0)
		return;

	status = message[1];
	x = get_unaligned_le16(&message[2]);
	y = get_unaligned_le16(&message[4]);

	if (status & MXT_T100_DETECT) {
		type = (status & MXT_T100_TYPE_MASK) >> 4;

		switch (type) {
		case MXT_T100_TYPE_HOVERING_FINGER:
			tool = MT_TOOL_FINGER;
			distance = MXT_DISTANCE_HOVERING;

			if (data->t100_aux_vect)
				orientation = message[data->t100_aux_vect];

			break;

		case MXT_T100_TYPE_FINGER:
		case MXT_T100_TYPE_GLOVE:
			tool = MT_TOOL_FINGER;
			distance = MXT_DISTANCE_ACTIVE_TOUCH;

			if (data->t100_aux_area)
				major = message[data->t100_aux_area];

			if (data->t100_aux_ampl)
				pressure = message[data->t100_aux_ampl];

			if (data->t100_aux_vect)
				orientation = message[data->t100_aux_vect];

			break;

		case MXT_T100_TYPE_PASSIVE_STYLUS:
			tool = MT_TOOL_PEN;

			/*
			 * Passive stylus is reported with size zero so
			 * hardcode.
			 */
			major = MXT_TOUCH_MAJOR_DEFAULT;

			if (data->t100_aux_ampl)
				pressure = message[data->t100_aux_ampl];

			break;

		case MXT_T100_TYPE_LARGE_TOUCH:
			/* Ignore suppressed touch */
			break;

		default:
			dev_dbg(dev, "Unexpected T100 type\n");
			return;
		}
	}

	/*
	 * Values reported should be non-zero if tool is touching the
	 * device
	 */
	if (!pressure && type != MXT_T100_TYPE_HOVERING_FINGER)
		pressure = MXT_PRESSURE_DEFAULT;

	input_mt_slot(input_dev, id);

	if (status & MXT_T100_DETECT) {
		dev_dbg(dev, "[%u] type:%u x:%u y:%u a:%02X p:%02X v:%02X\n",
			id, type, x, y, major, pressure, orientation);

		input_mt_report_slot_state(input_dev, tool, 1);
		input_report_abs(input_dev, ABS_MT_POSITION_X, x);
		input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
		input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, major);
		input_report_abs(input_dev, ABS_MT_PRESSURE, pressure);
		input_report_abs(input_dev, ABS_MT_DISTANCE, distance);
		input_report_abs(input_dev, ABS_MT_ORIENTATION, orientation);
	} else {
		dev_dbg(dev, "[%u] release\n", id);

		/* close out slot */
		input_mt_report_slot_state(input_dev, 0, 0);
	}

	data->update_input = true;
}

863
static int mxt_proc_message(struct mxt_data *data, u8 *message)
864
{
865 866 867 868 869 870 871 872 873 874 875 876 877
	u8 report_id = message[0];

	if (report_id == MXT_RPTID_NOMSG)
		return 0;

	if (report_id == data->T6_reportid) {
		mxt_proc_t6_messages(data, message);
	} else if (!data->input_dev) {
		/*
		 * Do not report events if input device
		 * is not yet registered.
		 */
		mxt_dump_message(data, message);
878 879
	} else if (report_id >= data->T9_reportid_min &&
		   report_id <= data->T9_reportid_max) {
880
		mxt_proc_t9_message(data, message);
881 882 883
	} else if (report_id >= data->T100_reportid_min &&
		   report_id <= data->T100_reportid_max) {
		mxt_proc_t100_message(data, message);
884 885 886 887 888 889 890 891
	} else if (report_id == data->T19_reportid) {
		mxt_input_button(data, message);
		data->update_input = true;
	} else {
		mxt_dump_message(data, message);
	}

	return 1;
892 893
}

894
static int mxt_read_and_process_messages(struct mxt_data *data, u8 count)
895 896
{
	struct device *dev = &data->client->dev;
897
	int ret;
898 899 900 901 902 903
	int i;
	u8 num_valid = 0;

	/* Safety check for msg_buf */
	if (count > data->max_reportid)
		return -EINVAL;
904

905
	/* Process remaining messages if necessary */
906
	ret = __mxt_read_reg(data->client, data->T5_address,
907
				data->T5_msg_size * count, data->msg_buf);
908
	if (ret) {
909
		dev_err(dev, "Failed to read %u messages (%d)\n", count, ret);
910 911
		return ret;
	}
912

913 914 915 916 917 918 919 920 921 922
	for (i = 0;  i < count; i++) {
		ret = mxt_proc_message(data,
			data->msg_buf + data->T5_msg_size * i);

		if (ret == 1)
			num_valid++;
	}

	/* return number of messages read */
	return num_valid;
923
}
924

925
static irqreturn_t mxt_process_messages_t44(struct mxt_data *data)
926
{
927
	struct device *dev = &data->client->dev;
928
	int ret;
929
	u8 count, num_left;
930

931 932 933 934 935 936 937 938 939 940 941
	/* Read T44 and T5 together */
	ret = __mxt_read_reg(data->client, data->T44_address,
		data->T5_msg_size + 1, data->msg_buf);
	if (ret) {
		dev_err(dev, "Failed to read T44 and T5 (%d)\n", ret);
		return IRQ_NONE;
	}

	count = data->msg_buf[0];

	if (count == 0) {
942 943 944 945 946 947
		/*
		 * This condition is caused by the CHG line being configured
		 * in Mode 0. It results in unnecessary I2C operations but it
		 * is benign.
		 */
		dev_dbg(dev, "Interrupt triggered but zero messages\n");
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
		return IRQ_NONE;
	} else if (count > data->max_reportid) {
		dev_err(dev, "T44 count %d exceeded max report id\n", count);
		count = data->max_reportid;
	}

	/* Process first message */
	ret = mxt_proc_message(data, data->msg_buf + 1);
	if (ret < 0) {
		dev_warn(dev, "Unexpected invalid message\n");
		return IRQ_NONE;
	}

	num_left = count - 1;

	/* Process remaining messages if necessary */
	if (num_left) {
		ret = mxt_read_and_process_messages(data, num_left);
966
		if (ret < 0)
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
			goto end;
		else if (ret != num_left)
			dev_warn(dev, "Unexpected invalid message\n");
	}

end:
	if (data->update_input) {
		mxt_input_sync(data);
		data->update_input = false;
	}

	return IRQ_HANDLED;
}

static int mxt_process_messages_until_invalid(struct mxt_data *data)
{
	struct device *dev = &data->client->dev;
	int count, read;
	u8 tries = 2;

	count = data->max_reportid;

	/* Read messages until we force an invalid */
	do {
		read = mxt_read_and_process_messages(data, count);
		if (read < count)
			return 0;
	} while (--tries);

	if (data->update_input) {
		mxt_input_sync(data);
		data->update_input = false;
	}

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

static irqreturn_t mxt_process_messages(struct mxt_data *data)
{
	int total_handled, num_handled;
	u8 count = data->last_message_count;

	if (count < 1 || count > data->max_reportid)
		count = 1;

	/* include final invalid message */
	total_handled = mxt_read_and_process_messages(data, count + 1);
	if (total_handled < 0)
		return IRQ_NONE;
	/* if there were invalid messages, then we are done */
	else if (total_handled <= count)
		goto update_count;

	/* keep reading two msgs until one is invalid or reportid limit */
	do {
		num_handled = mxt_read_and_process_messages(data, 2);
		if (num_handled < 0)
1025
			return IRQ_NONE;
1026 1027 1028 1029 1030 1031 1032 1033 1034

		total_handled += num_handled;

		if (num_handled < 2)
			break;
	} while (total_handled < data->num_touchids);

update_count:
	data->last_message_count = total_handled;
1035 1036

	if (data->update_input) {
1037
		mxt_input_sync(data);
1038 1039
		data->update_input = false;
	}
1040

1041 1042 1043
	return IRQ_HANDLED;
}

1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
static irqreturn_t mxt_interrupt(int irq, void *dev_id)
{
	struct mxt_data *data = dev_id;

	if (data->in_bootloader) {
		/* bootloader state transition completion */
		complete(&data->bl_completion);
		return IRQ_HANDLED;
	}

1054 1055 1056
	if (!data->object_table)
		return IRQ_HANDLED;

1057 1058 1059 1060 1061
	if (data->T44_address) {
		return mxt_process_messages_t44(data);
	} else {
		return mxt_process_messages(data);
	}
1062 1063
}

1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset,
			  u8 value, bool wait)
{
	u16 reg;
	u8 command_register;
	int timeout_counter = 0;
	int ret;

	reg = data->T6_address + cmd_offset;

	ret = mxt_write_reg(data->client, reg, value);
	if (ret)
		return ret;

	if (!wait)
		return 0;

	do {
		msleep(20);
		ret = __mxt_read_reg(data->client, reg, 1, &command_register);
		if (ret)
			return ret;
	} while (command_register != 0 && timeout_counter++ <= 100);

	if (timeout_counter > 100) {
		dev_err(&data->client->dev, "Command failed!\n");
		return -EIO;
	}

	return 0;
}

static int mxt_soft_reset(struct mxt_data *data)
{
	struct device *dev = &data->client->dev;
	int ret = 0;

1101 1102 1103
	dev_info(dev, "Resetting device\n");

	disable_irq(data->irq);
1104 1105 1106 1107 1108 1109 1110

	reinit_completion(&data->reset_completion);

	ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false);
	if (ret)
		return ret;

1111 1112 1113 1114 1115
	/* Ignore CHG line for 100ms after reset */
	msleep(100);

	enable_irq(data->irq);

1116 1117 1118 1119 1120 1121 1122 1123
	ret = mxt_wait_for_completion(data, &data->reset_completion,
				      MXT_RESET_TIMEOUT);
	if (ret)
		return ret;

	return 0;
}

1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
static void mxt_update_crc(struct mxt_data *data, u8 cmd, u8 value)
{
	/*
	 * On failure, CRC is set to 0 and config will always be
	 * downloaded.
	 */
	data->config_crc = 0;
	reinit_completion(&data->crc_completion);

	mxt_t6_command(data, cmd, value, true);

	/*
	 * Wait for crc message. On failure, CRC is set to 0 and config will
	 * always be downloaded.
	 */
	mxt_wait_for_completion(data, &data->crc_completion, MXT_CRC_TIMEOUT);
}

1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
static void mxt_calc_crc24(u32 *crc, u8 firstbyte, u8 secondbyte)
{
	static const unsigned int crcpoly = 0x80001B;
	u32 result;
	u32 data_word;

	data_word = (secondbyte << 8) | firstbyte;
	result = ((*crc << 1) ^ data_word);

	if (result & 0x1000000)
		result ^= crcpoly;

	*crc = result;
}

static u32 mxt_calculate_crc(u8 *base, off_t start_off, off_t end_off)
{
	u32 crc = 0;
	u8 *ptr = base + start_off;
	u8 *last_val = base + end_off - 1;

	if (end_off < start_off)
		return -EINVAL;

	while (ptr < last_val) {
		mxt_calc_crc24(&crc, *ptr, *(ptr + 1));
		ptr += 2;
	}

	/* if len is odd, fill the last byte with 0 */
	if (ptr == last_val)
		mxt_calc_crc24(&crc, *ptr, 0);

	/* Mask to 24-bit */
	crc &= 0x00FFFFFF;

	return crc;
}

1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
static int mxt_prepare_cfg_mem(struct mxt_data *data,
			       const struct firmware *cfg,
			       unsigned int data_pos,
			       unsigned int cfg_start_ofs,
			       u8 *config_mem,
			       size_t config_mem_size)
{
	struct device *dev = &data->client->dev;
	struct mxt_object *object;
	unsigned int type, instance, size, byte_offset;
	int offset;
	int ret;
	int i;
	u16 reg;
	u8 val;

	while (data_pos < cfg->size) {
		/* Read type, instance, length */
		ret = sscanf(cfg->data + data_pos, "%x %x %x%n",
			     &type, &instance, &size, &offset);
		if (ret == 0) {
			/* EOF */
			break;
		} else if (ret != 3) {
			dev_err(dev, "Bad format: failed to parse object\n");
			return -EINVAL;
		}
		data_pos += offset;

		object = mxt_get_object(data, type);
		if (!object) {
			/* Skip object */
			for (i = 0; i < size; i++) {
				ret = sscanf(cfg->data + data_pos, "%hhx%n",
1215 1216 1217 1218 1219 1220
					     &val, &offset);
				if (ret != 1) {
					dev_err(dev, "Bad format in T%d at %d\n",
						type, i);
					return -EINVAL;
				}
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
				data_pos += offset;
			}
			continue;
		}

		if (size > mxt_obj_size(object)) {
			/*
			 * Either we are in fallback mode due to wrong
			 * config or config from a later fw version,
			 * or the file is corrupt or hand-edited.
			 */
			dev_warn(dev, "Discarding %zu byte(s) in T%u\n",
				 size - mxt_obj_size(object), type);
		} else if (mxt_obj_size(object) > size) {
			/*
			 * If firmware is upgraded, new bytes may be added to
			 * end of objects. It is generally forward compatible
			 * to zero these bytes - previous behaviour will be
			 * retained. However this does invalidate the CRC and
			 * will force fallback mode until the configuration is
			 * updated. We warn here but do nothing else - the
			 * malloc has zeroed the entire configuration.
			 */
			dev_warn(dev, "Zeroing %zu byte(s) in T%d\n",
				 mxt_obj_size(object) - size, type);
		}

		if (instance >= mxt_obj_instances(object)) {
			dev_err(dev, "Object instances exceeded!\n");
			return -EINVAL;
		}

		reg = object->start_address + mxt_obj_size(object) * instance;

		for (i = 0; i < size; i++) {
			ret = sscanf(cfg->data + data_pos, "%hhx%n",
				     &val,
				     &offset);
			if (ret != 1) {
1260 1261
				dev_err(dev, "Bad format in T%d at %d\n",
					type, i);
1262 1263 1264 1265 1266 1267 1268 1269 1270
				return -EINVAL;
			}
			data_pos += offset;

			if (i > mxt_obj_size(object))
				continue;

			byte_offset = reg + i - cfg_start_ofs;

1271
			if (byte_offset >= 0 && byte_offset < config_mem_size) {
1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311
				*(config_mem + byte_offset) = val;
			} else {
				dev_err(dev, "Bad object: reg:%d, T%d, ofs=%d\n",
					reg, object->type, byte_offset);
				return -EINVAL;
			}
		}
	}

	return 0;
}

static int mxt_upload_cfg_mem(struct mxt_data *data, unsigned int cfg_start,
			      u8 *config_mem, size_t config_mem_size)
{
	unsigned int byte_offset = 0;
	int error;

	/* Write configuration as blocks */
	while (byte_offset < config_mem_size) {
		unsigned int size = config_mem_size - byte_offset;

		if (size > MXT_MAX_BLOCK_WRITE)
			size = MXT_MAX_BLOCK_WRITE;

		error = __mxt_write_reg(data->client,
					cfg_start + byte_offset,
					size, config_mem + byte_offset);
		if (error) {
			dev_err(&data->client->dev,
				"Config write error, ret=%d\n", error);
			return error;
		}

		byte_offset += size;
	}

	return 0;
}

1312 1313
static int mxt_init_t7_power_cfg(struct mxt_data *data);

1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
/*
 * mxt_update_cfg - download configuration to chip
 *
 * Atmel Raw Config File Format
 *
 * The first four lines of the raw config file contain:
 *  1) Version
 *  2) Chip ID Information (first 7 bytes of device memory)
 *  3) Chip Information Block 24-bit CRC Checksum
 *  4) Chip Configuration 24-bit CRC Checksum
 *
 * The rest of the file consists of one line per object instance:
 *   <TYPE> <INSTANCE> <SIZE> <CONTENTS>
 *
 *   <TYPE> - 2-byte object type as hex
 *   <INSTANCE> - 2-byte object instance number as hex
 *   <SIZE> - 2-byte object size as hex
 *   <CONTENTS> - array of <SIZE> 1-byte hex values
 */
static int mxt_update_cfg(struct mxt_data *data, const struct firmware *cfg)
1334 1335
{
	struct device *dev = &data->client->dev;
1336
	struct mxt_info cfg_info;
1337
	int ret;
1338
	int offset;
1339
	int data_pos;
1340
	int i;
1341 1342 1343 1344
	int cfg_start_ofs;
	u32 info_crc, config_crc, calculated_crc;
	u8 *config_mem;
	size_t config_mem_size;
1345

1346 1347 1348 1349
	mxt_update_crc(data, MXT_COMMAND_REPORTALL, 1);

	if (strncmp(cfg->data, MXT_CFG_MAGIC, strlen(MXT_CFG_MAGIC))) {
		dev_err(dev, "Unrecognised config file\n");
1350
		return -EINVAL;
1351 1352
	}

1353
	data_pos = strlen(MXT_CFG_MAGIC);
1354 1355 1356

	/* Load information block and check */
	for (i = 0; i < sizeof(struct mxt_info); i++) {
1357
		ret = sscanf(cfg->data + data_pos, "%hhx%n",
1358 1359 1360 1361
			     (unsigned char *)&cfg_info + i,
			     &offset);
		if (ret != 1) {
			dev_err(dev, "Bad format\n");
1362
			return -EINVAL;
1363
		}
1364

1365
		data_pos += offset;
1366 1367
	}

1368 1369
	if (cfg_info.family_id != data->info.family_id) {
		dev_err(dev, "Family ID mismatch!\n");
1370
		return -EINVAL;
1371
	}
1372

1373 1374
	if (cfg_info.variant_id != data->info.variant_id) {
		dev_err(dev, "Variant ID mismatch!\n");
1375
		return -EINVAL;
1376
	}
1377

1378 1379
	/* Read CRCs */
	ret = sscanf(cfg->data + data_pos, "%x%n", &info_crc, &offset);
1380 1381
	if (ret != 1) {
		dev_err(dev, "Bad format: failed to parse Info CRC\n");
1382
		return -EINVAL;
1383
	}
1384
	data_pos += offset;
1385

1386
	ret = sscanf(cfg->data + data_pos, "%x%n", &config_crc, &offset);
1387 1388
	if (ret != 1) {
		dev_err(dev, "Bad format: failed to parse Config CRC\n");
1389
		return -EINVAL;
1390
	}
1391
	data_pos += offset;
1392

1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404
	/*
	 * The Info Block CRC is calculated over mxt_info and the object
	 * table. If it does not match then we are trying to load the
	 * configuration from a different chip or firmware version, so
	 * the configuration CRC is invalid anyway.
	 */
	if (info_crc == data->info_crc) {
		if (config_crc == 0 || data->config_crc == 0) {
			dev_info(dev, "CRC zero, attempting to apply config\n");
		} else if (config_crc == data->config_crc) {
			dev_dbg(dev, "Config CRC 0x%06X: OK\n",
				 data->config_crc);
1405
			return 0;
1406 1407 1408 1409 1410 1411 1412 1413
		} else {
			dev_info(dev, "Config CRC 0x%06X: does not match file 0x%06X\n",
				 data->config_crc, config_crc);
		}
	} else {
		dev_warn(dev,
			 "Warning: Info CRC error - device=0x%06X file=0x%06X\n",
			 data->info_crc, info_crc);
1414 1415
	}

1416 1417 1418 1419 1420 1421 1422 1423
	/* Malloc memory to store configuration */
	cfg_start_ofs = MXT_OBJECT_START +
			data->info.object_num * sizeof(struct mxt_object) +
			MXT_INFO_CHECKSUM_SIZE;
	config_mem_size = data->mem_size - cfg_start_ofs;
	config_mem = kzalloc(config_mem_size, GFP_KERNEL);
	if (!config_mem) {
		dev_err(dev, "Failed to allocate memory\n");
1424
		return -ENOMEM;
1425
	}
1426

1427 1428 1429 1430
	ret = mxt_prepare_cfg_mem(data, cfg, data_pos, cfg_start_ofs,
				  config_mem, config_mem_size);
	if (ret)
		goto release_mem;
1431

1432 1433 1434 1435 1436 1437 1438
	/* Calculate crc of the received configs (not the raw config file) */
	if (data->T7_address < cfg_start_ofs) {
		dev_err(dev, "Bad T7 address, T7addr = %x, config offset %x\n",
			data->T7_address, cfg_start_ofs);
		ret = 0;
		goto release_mem;
	}
1439

1440 1441 1442 1443
	calculated_crc = mxt_calculate_crc(config_mem,
					   data->T7_address - cfg_start_ofs,
					   config_mem_size);

1444
	if (config_crc > 0 && config_crc != calculated_crc)
1445 1446 1447
		dev_warn(dev, "Config CRC error, calculated=%06X, file=%06X\n",
			 calculated_crc, config_crc);

1448 1449 1450 1451
	ret = mxt_upload_cfg_mem(data, cfg_start_ofs,
				 config_mem, config_mem_size);
	if (ret)
		goto release_mem;
1452

1453 1454 1455 1456
	mxt_update_crc(data, MXT_COMMAND_BACKUPNV, MXT_BACKUP_VALUE);

	ret = mxt_soft_reset(data);
	if (ret)
1457
		goto release_mem;
1458 1459 1460

	dev_info(dev, "Config successfully updated\n");

1461 1462 1463
	/* T7 config may have changed */
	mxt_init_t7_power_cfg(data);

1464 1465
release_mem:
	kfree(config_mem);
1466
	return ret;
1467 1468
}

1469 1470 1471 1472 1473 1474
static int mxt_acquire_irq(struct mxt_data *data)
{
	int error;

	enable_irq(data->irq);

1475
	error = mxt_process_messages_until_invalid(data);
1476 1477 1478 1479 1480 1481
	if (error)
		return error;

	return 0;
}

1482
static int mxt_get_info(struct mxt_data *data)
1483 1484
{
	struct i2c_client *client = data->client;
1485
	struct mxt_info *info = &data->info;
1486 1487
	int error;

1488
	/* Read 7-byte info block starting at address 0 */
1489
	error = __mxt_read_reg(client, 0, sizeof(*info), info);
1490 1491 1492 1493 1494 1495
	if (error)
		return error;

	return 0;
}

1496
static void mxt_free_input_device(struct mxt_data *data)
1497
{
1498 1499 1500 1501 1502
	if (data->input_dev) {
		input_unregister_device(data->input_dev);
		data->input_dev = NULL;
	}
}
1503

1504 1505
static void mxt_free_object_table(struct mxt_data *data)
{
1506 1507 1508 1509
	kfree(data->object_table);
	data->object_table = NULL;
	kfree(data->msg_buf);
	data->msg_buf = NULL;
1510
	data->T5_address = 0;
1511 1512 1513 1514 1515 1516
	data->T5_msg_size = 0;
	data->T6_reportid = 0;
	data->T7_address = 0;
	data->T9_reportid_min = 0;
	data->T9_reportid_max = 0;
	data->T19_reportid = 0;
1517
	data->T44_address = 0;
1518 1519
	data->T100_reportid_min = 0;
	data->T100_reportid_max = 0;
1520
	data->max_reportid = 0;
1521 1522
}

1523
static int mxt_get_object_table(struct mxt_data *data)
1524
{
1525 1526
	struct i2c_client *client = data->client;
	size_t table_size;
1527
	struct mxt_object *object_table;
1528 1529
	int error;
	int i;
1530
	u8 reportid;
1531
	u16 end_address;
1532 1533

	table_size = data->info.object_num * sizeof(struct mxt_object);
1534 1535 1536 1537 1538 1539
	object_table = kzalloc(table_size, GFP_KERNEL);
	if (!object_table) {
		dev_err(&data->client->dev, "Failed to allocate memory\n");
		return -ENOMEM;
	}

1540
	error = __mxt_read_reg(client, MXT_OBJECT_START, table_size,
1541 1542 1543
			object_table);
	if (error) {
		kfree(object_table);
1544
		return error;
1545
	}
1546

1547 1548
	/* Valid Report IDs start counting from 1 */
	reportid = 1;
1549
	data->mem_size = 0;
1550
	for (i = 0; i < data->info.object_num; i++) {
1551
		struct mxt_object *object = object_table + i;
1552
		u8 min_id, max_id;
1553

1554
		le16_to_cpus(&object->start_address);
1555 1556

		if (object->num_report_ids) {
1557
			min_id = reportid;
1558
			reportid += object->num_report_ids *
1559
					mxt_obj_instances(object);
1560 1561 1562 1563 1564 1565 1566
			max_id = reportid - 1;
		} else {
			min_id = 0;
			max_id = 0;
		}

		dev_dbg(&data->client->dev,
1567
			"T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n",
1568 1569 1570
			object->type, object->start_address,
			mxt_obj_size(object), mxt_obj_instances(object),
			min_id, max_id);
1571 1572

		switch (object->type) {
1573
		case MXT_GEN_MESSAGE_T5:
1574 1575
			if (data->info.family_id == 0x80 &&
			    data->info.version < 0x20) {
1576
				/*
1577 1578 1579
				 * On mXT224 firmware versions prior to V2.0
				 * read and discard unused CRC byte otherwise
				 * DMA reads are misaligned.
1580 1581 1582 1583 1584 1585
				 */
				data->T5_msg_size = mxt_obj_size(object);
			} else {
				/* CRC not enabled, so skip last byte */
				data->T5_msg_size = mxt_obj_size(object) - 1;
			}
1586
			data->T5_address = object->start_address;
1587
			break;
1588 1589
		case MXT_GEN_COMMAND_T6:
			data->T6_reportid = min_id;
1590
			data->T6_address = object->start_address;
1591
			break;
1592 1593 1594
		case MXT_GEN_POWER_T7:
			data->T7_address = object->start_address;
			break;
1595
		case MXT_TOUCH_MULTI_T9:
1596
			data->multitouch = MXT_TOUCH_MULTI_T9;
1597 1598
			data->T9_reportid_min = min_id;
			data->T9_reportid_max = max_id;
1599 1600 1601 1602 1603
			data->num_touchids = object->num_report_ids
						* mxt_obj_instances(object);
			break;
		case MXT_SPT_MESSAGECOUNT_T44:
			data->T44_address = object->start_address;
1604
			break;
1605 1606 1607
		case MXT_SPT_GPIOPWM_T19:
			data->T19_reportid = min_id;
			break;
1608 1609 1610 1611 1612 1613 1614
		case MXT_TOUCH_MULTITOUCHSCREEN_T100:
			data->multitouch = MXT_TOUCH_MULTITOUCHSCREEN_T100;
			data->T100_reportid_min = min_id;
			data->T100_reportid_max = max_id;
			/* first two report IDs reserved */
			data->num_touchids = object->num_report_ids - 2;
			break;
1615
		}
1616 1617 1618 1619 1620 1621

		end_address = object->start_address
			+ mxt_obj_size(object) * mxt_obj_instances(object) - 1;

		if (end_address >= data->mem_size)
			data->mem_size = end_address + 1;
1622 1623
	}

1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635
	/* Store maximum reportid */
	data->max_reportid = reportid;

	/* If T44 exists, T5 position has to be directly after */
	if (data->T44_address && (data->T5_address != data->T44_address + 1)) {
		dev_err(&client->dev, "Invalid T44 position\n");
		error = -EINVAL;
		goto free_object_table;
	}

	data->msg_buf = kcalloc(data->max_reportid,
				data->T5_msg_size, GFP_KERNEL);
1636 1637 1638 1639 1640 1641
	if (!data->msg_buf) {
		dev_err(&client->dev, "Failed to allocate message buffer\n");
		error = -ENOMEM;
		goto free_object_table;
	}

1642 1643
	data->object_table = object_table;

1644 1645
	return 0;

1646 1647 1648
free_object_table:
	mxt_free_object_table(data);
	return error;
1649 1650
}

1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684
static int mxt_read_t9_resolution(struct mxt_data *data)
{
	struct i2c_client *client = data->client;
	int error;
	struct t9_range range;
	unsigned char orient;
	struct mxt_object *object;

	object = mxt_get_object(data, MXT_TOUCH_MULTI_T9);
	if (!object)
		return -EINVAL;

	error = __mxt_read_reg(client,
			       object->start_address + MXT_T9_RANGE,
			       sizeof(range), &range);
	if (error)
		return error;

	le16_to_cpus(&range.x);
	le16_to_cpus(&range.y);

	error =  __mxt_read_reg(client,
				object->start_address + MXT_T9_ORIENT,
				1, &orient);
	if (error)
		return error;

	/* Handle default values */
	if (range.x == 0)
		range.x = 1023;

	if (range.y == 0)
		range.y = 1023;

1685
	if (orient & MXT_T9_ORIENT_SWITCH) {
1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698
		data->max_x = range.y;
		data->max_y = range.x;
	} else {
		data->max_x = range.x;
		data->max_y = range.y;
	}

	dev_dbg(&client->dev,
		"Touchscreen size X%uY%u\n", data->max_x, data->max_y);

	return 0;
}

1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776
static int mxt_read_t100_config(struct mxt_data *data)
{
	struct i2c_client *client = data->client;
	int error;
	struct mxt_object *object;
	u16 range_x, range_y;
	u8 cfg, tchaux;
	u8 aux;

	object = mxt_get_object(data, MXT_TOUCH_MULTITOUCHSCREEN_T100);
	if (!object)
		return -EINVAL;

	error = __mxt_read_reg(client,
			       object->start_address + MXT_T100_XRANGE,
			       sizeof(range_x), &range_x);
	if (error)
		return error;

	le16_to_cpus(&range_x);

	error = __mxt_read_reg(client,
			       object->start_address + MXT_T100_YRANGE,
			       sizeof(range_y), &range_y);
	if (error)
		return error;

	le16_to_cpus(&range_y);

	error =  __mxt_read_reg(client,
				object->start_address + MXT_T100_CFG1,
				1, &cfg);
	if (error)
		return error;

	error =  __mxt_read_reg(client,
				object->start_address + MXT_T100_TCHAUX,
				1, &tchaux);
	if (error)
		return error;

	/* Handle default values */
	if (range_x == 0)
		range_x = 1023;

	if (range_y == 0)
		range_y = 1023;

	if (cfg & MXT_T100_CFG_SWITCHXY) {
		data->max_x = range_y;
		data->max_y = range_x;
	} else {
		data->max_x = range_x;
		data->max_y = range_y;
	}

	/* allocate aux bytes */
	aux = 6;

	if (tchaux & MXT_T100_TCHAUX_VECT)
		data->t100_aux_vect = aux++;

	if (tchaux & MXT_T100_TCHAUX_AMPL)
		data->t100_aux_ampl = aux++;

	if (tchaux & MXT_T100_TCHAUX_AREA)
		data->t100_aux_area = aux++;

	dev_dbg(&client->dev,
		"T100 aux mappings vect:%u ampl:%u area:%u\n",
		data->t100_aux_vect, data->t100_aux_ampl, data->t100_aux_area);

	dev_info(&client->dev,
		 "T100 Touchscreen size X%uY%u\n", data->max_x, data->max_y);

	return 0;
}

1777 1778 1779
static int mxt_input_open(struct input_dev *dev);
static void mxt_input_close(struct input_dev *dev);

1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802
static void mxt_set_up_as_touchpad(struct input_dev *input_dev,
				   struct mxt_data *data)
{
	const struct mxt_platform_data *pdata = data->pdata;
	int i;

	input_dev->name = "Atmel maXTouch Touchpad";

	__set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);

	input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM);
	input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM);
	input_abs_set_res(input_dev, ABS_MT_POSITION_X,
			  MXT_PIXELS_PER_MM);
	input_abs_set_res(input_dev, ABS_MT_POSITION_Y,
			  MXT_PIXELS_PER_MM);

	for (i = 0; i < pdata->t19_num_keys; i++)
		if (pdata->t19_keymap[i] != KEY_RESERVED)
			input_set_capability(input_dev, EV_KEY,
					     pdata->t19_keymap[i]);
}

1803
static int mxt_initialize_input_device(struct mxt_data *data)
1804 1805
{
	const struct mxt_platform_data *pdata = data->pdata;
1806
	struct device *dev = &data->client->dev;
1807 1808 1809 1810 1811
	struct input_dev *input_dev;
	int error;
	unsigned int num_mt_slots;
	unsigned int mt_flags = 0;

1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830
	switch (data->multitouch) {
	case MXT_TOUCH_MULTI_T9:
		num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
		error = mxt_read_t9_resolution(data);
		if (error)
			dev_warn(dev, "Failed to initialize T9 resolution\n");
		break;

	case MXT_TOUCH_MULTITOUCHSCREEN_T100:
		num_mt_slots = data->num_touchids;
		error = mxt_read_t100_config(data);
		if (error)
			dev_warn(dev, "Failed to read T100 config\n");
		break;

	default:
		dev_err(dev, "Invalid multitouch object\n");
		return -EINVAL;
	}
1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844

	input_dev = input_allocate_device();
	if (!input_dev) {
		dev_err(dev, "Failed to allocate memory\n");
		return -ENOMEM;
	}

	input_dev->name = "Atmel maXTouch Touchscreen";
	input_dev->phys = data->phys;
	input_dev->id.bustype = BUS_I2C;
	input_dev->dev.parent = dev;
	input_dev->open = mxt_input_open;
	input_dev->close = mxt_input_close;

1845
	input_set_capability(input_dev, EV_KEY, BTN_TOUCH);
1846 1847

	/* For single touch */
1848 1849 1850 1851 1852 1853 1854 1855
	input_set_abs_params(input_dev, ABS_X, 0, data->max_x, 0, 0);
	input_set_abs_params(input_dev, ABS_Y, 0, data->max_y, 0, 0);

	if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
	    (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
	     data->t100_aux_ampl)) {
		input_set_abs_params(input_dev, ABS_PRESSURE, 0, 255, 0, 0);
	}
1856

1857 1858 1859 1860 1861 1862
	/* If device has buttons we assume it is a touchpad */
	if (pdata->t19_num_keys) {
		mxt_set_up_as_touchpad(input_dev, data);
		mt_flags |= INPUT_MT_POINTER;
	}

1863 1864 1865 1866 1867 1868 1869
	/* For multi touch */
	error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags);
	if (error) {
		dev_err(dev, "Error %d initialising slots\n", error);
		goto err_free_mem;
	}

1870 1871 1872 1873 1874 1875 1876 1877 1878
	if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100) {
		input_set_abs_params(input_dev, ABS_MT_TOOL_TYPE,
				     0, MT_TOOL_MAX, 0, 0);
		input_set_abs_params(input_dev, ABS_MT_DISTANCE,
				     MXT_DISTANCE_ACTIVE_TOUCH,
				     MXT_DISTANCE_HOVERING,
				     0, 0);
	}

1879 1880 1881 1882
	input_set_abs_params(input_dev, ABS_MT_POSITION_X,
			     0, data->max_x, 0, 0);
	input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
			     0, data->max_y, 0, 0);
1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914

	if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
	    (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
	     data->t100_aux_area)) {
		input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
				     0, MXT_MAX_AREA, 0, 0);
	}

	if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
	    (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
	     data->t100_aux_ampl)) {
		input_set_abs_params(input_dev, ABS_MT_PRESSURE,
				     0, 255, 0, 0);
	}

	if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
	    data->t100_aux_vect) {
		input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
				     0, 255, 0, 0);
	}

	if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
	    data->t100_aux_ampl) {
		input_set_abs_params(input_dev, ABS_MT_PRESSURE,
				     0, 255, 0, 0);
	}

	if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
	    data->t100_aux_vect) {
		input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
				     0, 255, 0, 0);
	}
1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932

	input_set_drvdata(input_dev, data);

	error = input_register_device(input_dev);
	if (error) {
		dev_err(dev, "Error %d registering input device\n", error);
		goto err_free_mem;
	}

	data->input_dev = input_dev;

	return 0;

err_free_mem:
	input_free_device(input_dev);
	return error;
}

1933 1934 1935 1936 1937 1938
static int mxt_configure_objects(struct mxt_data *data,
				 const struct firmware *cfg);

static void mxt_config_cb(const struct firmware *cfg, void *ctx)
{
	mxt_configure_objects(ctx, cfg);
1939
	release_firmware(cfg);
1940 1941
}

1942
static int mxt_initialize(struct mxt_data *data)
1943 1944
{
	struct i2c_client *client = data->client;
1945
	int recovery_attempts = 0;
1946 1947
	int error;

1948 1949 1950 1951 1952 1953 1954
	while (1) {
		error = mxt_get_info(data);
		if (!error)
			break;

		/* Check bootloader state */
		error = mxt_probe_bootloader(data, false);
1955
		if (error) {
1956 1957 1958
			dev_info(&client->dev, "Trying alternate bootloader address\n");
			error = mxt_probe_bootloader(data, true);
			if (error) {
1959 1960 1961
				/* Chip is not in appmode or bootloader mode */
				return error;
			}
1962
		}
1963

1964 1965 1966 1967 1968 1969 1970 1971 1972
		/* OK, we are in bootloader, see if we can recover */
		if (++recovery_attempts > 1) {
			dev_err(&client->dev, "Could not recover from bootloader mode\n");
			/*
			 * We can reflash from this state, so do not
			 * abort initialization.
			 */
			data->in_bootloader = true;
			return 0;
1973
		}
1974 1975 1976 1977

		/* Attempt to exit bootloader into app mode */
		mxt_send_bootloader_cmd(data, false);
		msleep(MXT_FW_RESET_TIME);
1978
	}
1979 1980

	/* Get object table information */
1981
	error = mxt_get_object_table(data);
1982 1983
	if (error) {
		dev_err(&client->dev, "Error %d reading object table\n", error);
1984
		return error;
1985
	}
1986

1987
	error = mxt_acquire_irq(data);
1988 1989 1990
	if (error)
		goto err_free_object_table;

1991 1992 1993 1994 1995 1996 1997 1998
	error = request_firmware_nowait(THIS_MODULE, true, MXT_CFG_NAME,
					&client->dev, GFP_KERNEL, data,
					mxt_config_cb);
	if (error) {
		dev_err(&client->dev, "Failed to invoke firmware loader: %d\n",
			error);
		goto err_free_object_table;
	}
1999 2000 2001 2002 2003 2004 2005 2006

	return 0;

err_free_object_table:
	mxt_free_object_table(data);
	return error;
}

2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060
static int mxt_set_t7_power_cfg(struct mxt_data *data, u8 sleep)
{
	struct device *dev = &data->client->dev;
	int error;
	struct t7_config *new_config;
	struct t7_config deepsleep = { .active = 0, .idle = 0 };

	if (sleep == MXT_POWER_CFG_DEEPSLEEP)
		new_config = &deepsleep;
	else
		new_config = &data->t7_cfg;

	error = __mxt_write_reg(data->client, data->T7_address,
				sizeof(data->t7_cfg), new_config);
	if (error)
		return error;

	dev_dbg(dev, "Set T7 ACTV:%d IDLE:%d\n",
		new_config->active, new_config->idle);

	return 0;
}

static int mxt_init_t7_power_cfg(struct mxt_data *data)
{
	struct device *dev = &data->client->dev;
	int error;
	bool retry = false;

recheck:
	error = __mxt_read_reg(data->client, data->T7_address,
				sizeof(data->t7_cfg), &data->t7_cfg);
	if (error)
		return error;

	if (data->t7_cfg.active == 0 || data->t7_cfg.idle == 0) {
		if (!retry) {
			dev_dbg(dev, "T7 cfg zero, resetting\n");
			mxt_soft_reset(data);
			retry = true;
			goto recheck;
		} else {
			dev_dbg(dev, "T7 cfg zero after reset, overriding\n");
			data->t7_cfg.active = 20;
			data->t7_cfg.idle = 100;
			return mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
		}
	}

	dev_dbg(dev, "Initialized power cfg: ACTV %d, IDLE %d\n",
		data->t7_cfg.active, data->t7_cfg.idle);
	return 0;
}

2061 2062 2063 2064 2065 2066 2067
static int mxt_configure_objects(struct mxt_data *data,
				 const struct firmware *cfg)
{
	struct device *dev = &data->client->dev;
	struct mxt_info *info = &data->info;
	int error;

2068 2069 2070 2071 2072 2073
	error = mxt_init_t7_power_cfg(data);
	if (error) {
		dev_err(dev, "Failed to initialize power cfg\n");
		return error;
	}

2074 2075 2076 2077
	if (cfg) {
		error = mxt_update_cfg(data, cfg);
		if (error)
			dev_warn(dev, "Error %d updating config\n", error);
2078
	}
2079

2080 2081 2082 2083 2084 2085 2086
	if (data->multitouch) {
		error = mxt_initialize_input_device(data);
		if (error)
			return error;
	} else {
		dev_warn(dev, "No touch object detected\n");
	}
2087

2088
	dev_info(dev,
2089 2090 2091
		 "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n",
		 info->family_id, info->variant_id, info->version >> 4,
		 info->version & 0xf, info->build, info->object_num);
2092 2093 2094 2095

	return 0;
}

2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115
/* Firmware Version is returned as Major.Minor.Build */
static ssize_t mxt_fw_version_show(struct device *dev,
				   struct device_attribute *attr, char *buf)
{
	struct mxt_data *data = dev_get_drvdata(dev);
	struct mxt_info *info = &data->info;
	return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
			 info->version >> 4, info->version & 0xf, info->build);
}

/* Hardware Version is returned as FamilyID.VariantID */
static ssize_t mxt_hw_version_show(struct device *dev,
				   struct device_attribute *attr, char *buf)
{
	struct mxt_data *data = dev_get_drvdata(dev);
	struct mxt_info *info = &data->info;
	return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
			 info->family_id, info->variant_id);
}

2116 2117 2118 2119 2120 2121
static ssize_t mxt_show_instance(char *buf, int count,
				 struct mxt_object *object, int instance,
				 const u8 *val)
{
	int i;

2122
	if (mxt_obj_instances(object) > 1)
2123 2124 2125
		count += scnprintf(buf + count, PAGE_SIZE - count,
				   "Instance %u\n", instance);

2126
	for (i = 0; i < mxt_obj_size(object); i++)
2127 2128 2129 2130 2131 2132 2133
		count += scnprintf(buf + count, PAGE_SIZE - count,
				"\t[%2u]: %02x (%d)\n", i, val[i], val[i]);
	count += scnprintf(buf + count, PAGE_SIZE - count, "\n");

	return count;
}

2134
static ssize_t mxt_object_show(struct device *dev,
2135 2136
				    struct device_attribute *attr, char *buf)
{
2137 2138
	struct mxt_data *data = dev_get_drvdata(dev);
	struct mxt_object *object;
2139 2140 2141
	int count = 0;
	int i, j;
	int error;
2142
	u8 *obuf;
2143

2144 2145 2146 2147
	/* Pre-allocate buffer large enough to hold max sized object. */
	obuf = kmalloc(256, GFP_KERNEL);
	if (!obuf)
		return -ENOMEM;
2148

2149
	error = 0;
2150 2151 2152
	for (i = 0; i < data->info.object_num; i++) {
		object = data->object_table + i;

2153
		if (!mxt_object_readable(object->type))
2154 2155
			continue;

2156 2157
		count += scnprintf(buf + count, PAGE_SIZE - count,
				"T%u:\n", object->type);
2158

2159 2160
		for (j = 0; j < mxt_obj_instances(object); j++) {
			u16 size = mxt_obj_size(object);
2161
			u16 addr = object->start_address + j * size;
2162

2163
			error = __mxt_read_reg(data->client, addr, size, obuf);
2164
			if (error)
2165
				goto done;
2166

2167
			count = mxt_show_instance(buf, count, object, j, obuf);
2168 2169 2170
		}
	}

2171
done:
2172 2173
	kfree(obuf);
	return error ?: count;
2174 2175
}

2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199
static int mxt_check_firmware_format(struct device *dev,
				     const struct firmware *fw)
{
	unsigned int pos = 0;
	char c;

	while (pos < fw->size) {
		c = *(fw->data + pos);

		if (c < '0' || (c > '9' && c < 'A') || c > 'F')
			return 0;

		pos++;
	}

	/*
	 * To convert file try:
	 * xxd -r -p mXTXXX__APP_VX-X-XX.enc > maxtouch.fw
	 */
	dev_err(dev, "Aborting: firmware file must be in binary format\n");

	return -EINVAL;
}

2200
static int mxt_load_fw(struct device *dev, const char *fn)
2201
{
2202
	struct mxt_data *data = dev_get_drvdata(dev);
2203 2204 2205
	const struct firmware *fw = NULL;
	unsigned int frame_size;
	unsigned int pos = 0;
2206
	unsigned int retry = 0;
2207
	unsigned int frame = 0;
2208 2209 2210 2211 2212 2213 2214 2215
	int ret;

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

2216 2217 2218 2219 2220
	/* Check for incorrect enc file */
	ret = mxt_check_firmware_format(dev, fw);
	if (ret)
		goto release_firmware;

2221 2222 2223
	if (!data->in_bootloader) {
		/* Change to the bootloader mode */
		data->in_bootloader = true;
2224

2225 2226 2227 2228
		ret = mxt_t6_command(data, MXT_COMMAND_RESET,
				     MXT_BOOT_VALUE, false);
		if (ret)
			goto release_firmware;
2229

2230
		msleep(MXT_RESET_TIME);
2231 2232 2233 2234 2235

		/* Do not need to scan since we know family ID */
		ret = mxt_lookup_bootloader_address(data, 0);
		if (ret)
			goto release_firmware;
2236 2237 2238

		mxt_free_input_device(data);
		mxt_free_object_table(data);
2239 2240
	} else {
		enable_irq(data->irq);
2241
	}
2242

2243 2244
	reinit_completion(&data->bl_completion);

2245 2246 2247 2248 2249 2250 2251 2252
	ret = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD, false);
	if (ret) {
		/* Bootloader may still be unlocked from previous attempt */
		ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, false);
		if (ret)
			goto disable_irq;
	} else {
		dev_info(dev, "Unlocking bootloader\n");
2253

2254
		/* Unlock bootloader */
2255
		ret = mxt_send_bootloader_cmd(data, true);
2256 2257 2258
		if (ret)
			goto disable_irq;
	}
2259 2260

	while (pos < fw->size) {
2261
		ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, true);
2262
		if (ret)
2263
			goto disable_irq;
2264 2265 2266

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

2267
		/* Take account of CRC bytes */
2268 2269 2270
		frame_size += 2;

		/* Write one frame to device */
2271 2272 2273
		ret = mxt_bootloader_write(data, fw->data + pos, frame_size);
		if (ret)
			goto disable_irq;
2274

2275
		ret = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS, true);
2276 2277 2278 2279 2280
		if (ret) {
			retry++;

			/* Back off by 20ms per retry */
			msleep(retry * 20);
2281

2282 2283 2284 2285 2286 2287 2288
			if (retry > 20) {
				dev_err(dev, "Retry count exceeded\n");
				goto disable_irq;
			}
		} else {
			retry = 0;
			pos += frame_size;
2289
			frame++;
2290
		}
2291

2292 2293 2294
		if (frame % 50 == 0)
			dev_dbg(dev, "Sent %d frames, %d/%zd bytes\n",
				frame, pos, fw->size);
2295 2296
	}

2297
	/* Wait for flash. */
2298 2299
	ret = mxt_wait_for_completion(data, &data->bl_completion,
				      MXT_FW_RESET_TIME);
2300 2301 2302
	if (ret)
		goto disable_irq;

2303 2304
	dev_dbg(dev, "Sent %d frames, %d bytes\n", frame, pos);

2305 2306 2307 2308 2309
	/*
	 * Wait for device to reset. Some bootloader versions do not assert
	 * the CHG line after bootloading has finished, so ignore potential
	 * errors.
	 */
2310
	mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME);
2311

2312 2313 2314 2315
	data->in_bootloader = false;

disable_irq:
	disable_irq(data->irq);
2316
release_firmware:
2317 2318 2319 2320
	release_firmware(fw);
	return ret;
}

2321
static ssize_t mxt_update_fw_store(struct device *dev,
2322 2323 2324
					struct device_attribute *attr,
					const char *buf, size_t count)
{
2325
	struct mxt_data *data = dev_get_drvdata(dev);
2326 2327
	int error;

2328
	error = mxt_load_fw(dev, MXT_FW_NAME);
2329 2330 2331 2332
	if (error) {
		dev_err(dev, "The firmware update failed(%d)\n", error);
		count = error;
	} else {
2333 2334
		dev_info(dev, "The firmware update succeeded\n");

2335
		error = mxt_initialize(data);
2336 2337 2338
		if (error)
			return error;
	}
2339

2340 2341 2342
	return count;
}

2343 2344
static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
2345 2346
static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
2347

2348
static struct attribute *mxt_attrs[] = {
2349 2350
	&dev_attr_fw_version.attr,
	&dev_attr_hw_version.attr,
2351 2352 2353 2354 2355
	&dev_attr_object.attr,
	&dev_attr_update_fw.attr,
	NULL
};

2356 2357
static const struct attribute_group mxt_attr_group = {
	.attrs = mxt_attrs,
2358 2359
};

2360
static void mxt_start(struct mxt_data *data)
2361
{
2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380
	switch (data->pdata->suspend_mode) {
	case MXT_SUSPEND_T9_CTRL:
		mxt_soft_reset(data);

		/* Touch enable */
		/* 0x83 = SCANEN | RPTEN | ENABLE */
		mxt_write_object(data,
				MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0x83);
		break;

	case MXT_SUSPEND_DEEP_SLEEP:
	default:
		mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);

		/* Recalibrate since chip has been in deep sleep */
		mxt_t6_command(data, MXT_COMMAND_CALIBRATE, 1, false);
		break;
	}

2381 2382
}

2383
static void mxt_stop(struct mxt_data *data)
2384
{
2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396
	switch (data->pdata->suspend_mode) {
	case MXT_SUSPEND_T9_CTRL:
		/* Touch disable */
		mxt_write_object(data,
				MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0);
		break;

	case MXT_SUSPEND_DEEP_SLEEP:
	default:
		mxt_set_t7_power_cfg(data, MXT_POWER_CFG_DEEPSLEEP);
		break;
	}
2397 2398
}

2399
static int mxt_input_open(struct input_dev *dev)
2400
{
2401
	struct mxt_data *data = input_get_drvdata(dev);
2402

2403
	mxt_start(data);
2404 2405 2406 2407

	return 0;
}

2408
static void mxt_input_close(struct input_dev *dev)
2409
{
2410
	struct mxt_data *data = input_get_drvdata(dev);
2411

2412
	mxt_stop(data);
2413 2414
}

2415
#ifdef CONFIG_OF
2416
static const struct mxt_platform_data *mxt_parse_dt(struct i2c_client *client)
2417 2418
{
	struct mxt_platform_data *pdata;
2419
	struct device_node *np = client->dev.of_node;
2420
	u32 *keymap;
2421
	int proplen, ret;
2422

2423
	if (!np)
2424
		return ERR_PTR(-ENOENT);
2425 2426 2427 2428 2429

	pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL);
	if (!pdata)
		return ERR_PTR(-ENOMEM);

2430
	if (of_find_property(np, "linux,gpio-keymap", &proplen)) {
2431 2432 2433 2434 2435 2436 2437 2438
		pdata->t19_num_keys = proplen / sizeof(u32);

		keymap = devm_kzalloc(&client->dev,
				pdata->t19_num_keys * sizeof(keymap[0]),
				GFP_KERNEL);
		if (!keymap)
			return ERR_PTR(-ENOMEM);

2439 2440 2441 2442 2443
		ret = of_property_read_u32_array(np, "linux,gpio-keymap",
						 keymap, pdata->t19_num_keys);
		if (ret)
			dev_warn(&client->dev,
				 "Couldn't read linux,gpio-keymap: %d\n", ret);
2444 2445 2446 2447

		pdata->t19_keymap = keymap;
	}

2448 2449
	pdata->suspend_mode = MXT_SUSPEND_DEEP_SLEEP;

2450 2451 2452
	return pdata;
}
#else
2453
static const struct mxt_platform_data *mxt_parse_dt(struct i2c_client *client)
2454
{
2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545
	return ERR_PTR(-ENOENT);
}
#endif

#ifdef CONFIG_ACPI

struct mxt_acpi_platform_data {
	const char *hid;
	struct mxt_platform_data pdata;
};

static unsigned int samus_touchpad_buttons[] = {
	KEY_RESERVED,
	KEY_RESERVED,
	KEY_RESERVED,
	BTN_LEFT
};

static struct mxt_acpi_platform_data samus_platform_data[] = {
	{
		/* Touchpad */
		.hid	= "ATML0000",
		.pdata	= {
			.t19_num_keys	= ARRAY_SIZE(samus_touchpad_buttons),
			.t19_keymap	= samus_touchpad_buttons,
		},
	},
	{
		/* Touchscreen */
		.hid	= "ATML0001",
	},
	{ }
};

static const struct dmi_system_id mxt_dmi_table[] = {
	{
		/* 2015 Google Pixel */
		.ident = "Chromebook Pixel 2",
		.matches = {
			DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
			DMI_MATCH(DMI_PRODUCT_NAME, "Samus"),
		},
		.driver_data = samus_platform_data,
	},
	{ }
};

static const struct mxt_platform_data *mxt_parse_acpi(struct i2c_client *client)
{
	struct acpi_device *adev;
	const struct dmi_system_id *system_id;
	const struct mxt_acpi_platform_data *acpi_pdata;

	/*
	 * Ignore ACPI devices representing bootloader mode.
	 *
	 * This is a bit of a hack: Google Chromebook BIOS creates ACPI
	 * devices for both application and bootloader modes, but we are
	 * interested in application mode only (if device is in bootloader
	 * mode we'll end up switching into application anyway). So far
	 * application mode addresses were all above 0x40, so we'll use it
	 * as a threshold.
	 */
	if (client->addr < 0x40)
		return ERR_PTR(-ENXIO);

	adev = ACPI_COMPANION(&client->dev);
	if (!adev)
		return ERR_PTR(-ENOENT);

	system_id = dmi_first_match(mxt_dmi_table);
	if (!system_id)
		return ERR_PTR(-ENOENT);

	acpi_pdata = system_id->driver_data;
	if (!acpi_pdata)
		return ERR_PTR(-ENOENT);

	while (acpi_pdata->hid) {
		if (!strcmp(acpi_device_hid(adev), acpi_pdata->hid))
			return &acpi_pdata->pdata;

		acpi_pdata++;
	}

	return ERR_PTR(-ENOENT);
}
#else
static const struct mxt_platform_data *mxt_parse_acpi(struct i2c_client *client)
{
	return ERR_PTR(-ENOENT);
2546 2547 2548
}
#endif

2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569
static const struct mxt_platform_data *
mxt_get_platform_data(struct i2c_client *client)
{
	const struct mxt_platform_data *pdata;

	pdata = dev_get_platdata(&client->dev);
	if (pdata)
		return pdata;

	pdata = mxt_parse_dt(client);
	if (!IS_ERR(pdata) || PTR_ERR(pdata) != -ENOENT)
		return pdata;

	pdata = mxt_parse_acpi(client);
	if (!IS_ERR(pdata) || PTR_ERR(pdata) != -ENOENT)
		return pdata;

	dev_err(&client->dev, "No platform data specified\n");
	return ERR_PTR(-EINVAL);
}

2570
static int mxt_probe(struct i2c_client *client, const struct i2c_device_id *id)
2571
{
2572
	struct mxt_data *data;
2573
	const struct mxt_platform_data *pdata;
2574 2575
	int error;

2576 2577 2578
	pdata = mxt_get_platform_data(client);
	if (IS_ERR(pdata))
		return PTR_ERR(pdata);
2579

2580
	data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL);
2581
	if (!data) {
2582
		dev_err(&client->dev, "Failed to allocate memory\n");
2583
		return -ENOMEM;
2584 2585
	}

2586 2587
	snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
		 client->adapter->nr, client->addr);
2588

2589 2590 2591
	data->client = client;
	data->pdata = pdata;
	data->irq = client->irq;
2592
	i2c_set_clientdata(client, data);
2593

2594
	init_completion(&data->bl_completion);
2595
	init_completion(&data->reset_completion);
2596
	init_completion(&data->crc_completion);
2597

2598 2599 2600 2601 2602 2603 2604 2605 2606 2607
	error = request_threaded_irq(client->irq, NULL, mxt_interrupt,
				     pdata->irqflags | IRQF_ONESHOT,
				     client->name, data);
	if (error) {
		dev_err(&client->dev, "Failed to register interrupt\n");
		goto err_free_mem;
	}

	disable_irq(client->irq);

2608 2609
	error = mxt_initialize(data);
	if (error)
2610
		goto err_free_irq;
2611

2612
	error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
2613 2614 2615
	if (error) {
		dev_err(&client->dev, "Failure %d creating sysfs group\n",
			error);
2616
		goto err_free_object;
2617
	}
2618 2619 2620 2621

	return 0;

err_free_object:
2622
	mxt_free_input_device(data);
2623
	mxt_free_object_table(data);
2624 2625
err_free_irq:
	free_irq(client->irq, data);
2626 2627 2628 2629 2630
err_free_mem:
	kfree(data);
	return error;
}

B
Bill Pemberton 已提交
2631
static int mxt_remove(struct i2c_client *client)
2632
{
2633
	struct mxt_data *data = i2c_get_clientdata(client);
2634

2635
	sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
2636
	free_irq(data->irq, data);
2637
	mxt_free_input_device(data);
2638
	mxt_free_object_table(data);
2639 2640 2641 2642 2643
	kfree(data);

	return 0;
}

2644
static int __maybe_unused mxt_suspend(struct device *dev)
2645
{
2646
	struct i2c_client *client = to_i2c_client(dev);
2647
	struct mxt_data *data = i2c_get_clientdata(client);
2648 2649
	struct input_dev *input_dev = data->input_dev;

2650 2651 2652
	if (!input_dev)
		return 0;

2653 2654 2655
	mutex_lock(&input_dev->mutex);

	if (input_dev->users)
2656
		mxt_stop(data);
2657 2658 2659 2660 2661 2662

	mutex_unlock(&input_dev->mutex);

	return 0;
}

2663
static int __maybe_unused mxt_resume(struct device *dev)
2664
{
2665
	struct i2c_client *client = to_i2c_client(dev);
2666
	struct mxt_data *data = i2c_get_clientdata(client);
2667 2668
	struct input_dev *input_dev = data->input_dev;

2669 2670 2671
	if (!input_dev)
		return 0;

2672 2673 2674
	mutex_lock(&input_dev->mutex);

	if (input_dev->users)
2675
		mxt_start(data);
2676 2677 2678 2679 2680 2681

	mutex_unlock(&input_dev->mutex);

	return 0;
}

2682 2683
static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);

2684 2685 2686 2687 2688 2689
static const struct of_device_id mxt_of_match[] = {
	{ .compatible = "atmel,maxtouch", },
	{},
};
MODULE_DEVICE_TABLE(of, mxt_of_match);

2690 2691 2692 2693 2694 2695 2696 2697 2698
#ifdef CONFIG_ACPI
static const struct acpi_device_id mxt_acpi_id[] = {
	{ "ATML0000", 0 },	/* Touchpad */
	{ "ATML0001", 0 },	/* Touchscreen */
	{ }
};
MODULE_DEVICE_TABLE(acpi, mxt_acpi_id);
#endif

2699
static const struct i2c_device_id mxt_id[] = {
2700
	{ "qt602240_ts", 0 },
2701
	{ "atmel_mxt_ts", 0 },
2702
	{ "atmel_mxt_tp", 0 },
2703
	{ "mXT224", 0 },
2704 2705
	{ }
};
2706
MODULE_DEVICE_TABLE(i2c, mxt_id);
2707

2708
static struct i2c_driver mxt_driver = {
2709
	.driver = {
2710
		.name	= "atmel_mxt_ts",
2711
		.of_match_table = of_match_ptr(mxt_of_match),
2712
		.acpi_match_table = ACPI_PTR(mxt_acpi_id),
2713
		.pm	= &mxt_pm_ops,
2714
	},
2715
	.probe		= mxt_probe,
B
Bill Pemberton 已提交
2716
	.remove		= mxt_remove,
2717
	.id_table	= mxt_id,
2718 2719
};

2720
module_i2c_driver(mxt_driver);
2721 2722 2723

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