Linux Audio

Check our new training course

In-person Linux kernel drivers training

Jun 16-20, 2025
Register
Loading...
v4.6
 
   1/*
   2 * Atmel maXTouch Touchscreen driver
   3 *
   4 * Copyright (C) 2010 Samsung Electronics Co.Ltd
   5 * Copyright (C) 2011-2014 Atmel Corporation
   6 * Copyright (C) 2012 Google, Inc.
 
   7 *
   8 * Author: Joonyoung Shim <jy0922.shim@samsung.com>
   9 *
  10 * This program is free software; you can redistribute  it and/or modify it
  11 * under  the terms of  the GNU General  Public License as published by the
  12 * Free Software Foundation;  either version 2 of the  License, or (at your
  13 * option) any later version.
  14 *
  15 */
  16
  17#include <linux/acpi.h>
  18#include <linux/dmi.h>
  19#include <linux/module.h>
  20#include <linux/init.h>
  21#include <linux/completion.h>
  22#include <linux/delay.h>
  23#include <linux/firmware.h>
  24#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#define MXT_CFG_NAME		"maxtouch.cfg"
  35#define MXT_CFG_MAGIC		"OBP_RAW V1"
  36
  37/* Registers */
  38#define MXT_OBJECT_START	0x07
  39#define MXT_OBJECT_SIZE		6
  40#define MXT_INFO_CHECKSUM_SIZE	3
  41#define MXT_MAX_BLOCK_WRITE	256
  42
  43/* Object types */
  44#define MXT_DEBUG_DIAGNOSTIC_T37	37
  45#define MXT_GEN_MESSAGE_T5		5
  46#define MXT_GEN_COMMAND_T6		6
  47#define MXT_GEN_POWER_T7		7
  48#define MXT_GEN_ACQUIRE_T8		8
  49#define MXT_GEN_DATASOURCE_T53		53
  50#define MXT_TOUCH_MULTI_T9		9
  51#define MXT_TOUCH_KEYARRAY_T15		15
  52#define MXT_TOUCH_PROXIMITY_T23		23
  53#define MXT_TOUCH_PROXKEY_T52		52
  54#define MXT_PROCI_GRIPFACE_T20		20
  55#define MXT_PROCG_NOISE_T22		22
  56#define MXT_PROCI_ONETOUCH_T24		24
  57#define MXT_PROCI_TWOTOUCH_T27		27
  58#define MXT_PROCI_GRIP_T40		40
  59#define MXT_PROCI_PALM_T41		41
  60#define MXT_PROCI_TOUCHSUPPRESSION_T42	42
  61#define MXT_PROCI_STYLUS_T47		47
  62#define MXT_PROCG_NOISESUPPRESSION_T48	48
  63#define MXT_SPT_COMMSCONFIG_T18		18
  64#define MXT_SPT_GPIOPWM_T19		19
  65#define MXT_SPT_SELFTEST_T25		25
  66#define MXT_SPT_CTECONFIG_T28		28
  67#define MXT_SPT_USERDATA_T38		38
  68#define MXT_SPT_DIGITIZER_T43		43
  69#define MXT_SPT_MESSAGECOUNT_T44	44
  70#define MXT_SPT_CTECONFIG_T46		46
 
  71#define MXT_TOUCH_MULTITOUCHSCREEN_T100 100
  72
  73/* MXT_GEN_MESSAGE_T5 object */
  74#define MXT_RPTID_NOMSG		0xff
  75
  76/* MXT_GEN_COMMAND_T6 field */
  77#define MXT_COMMAND_RESET	0
  78#define MXT_COMMAND_BACKUPNV	1
  79#define MXT_COMMAND_CALIBRATE	2
  80#define MXT_COMMAND_REPORTALL	3
  81#define MXT_COMMAND_DIAGNOSTIC	5
  82
  83/* Define for T6 status byte */
  84#define MXT_T6_STATUS_RESET	(1 << 7)
  85#define MXT_T6_STATUS_OFL	(1 << 6)
  86#define MXT_T6_STATUS_SIGERR	(1 << 5)
  87#define MXT_T6_STATUS_CAL	(1 << 4)
  88#define MXT_T6_STATUS_CFGERR	(1 << 3)
  89#define MXT_T6_STATUS_COMSERR	(1 << 2)
  90
  91/* MXT_GEN_POWER_T7 field */
  92struct t7_config {
  93	u8 idle;
  94	u8 active;
  95} __packed;
  96
  97#define MXT_POWER_CFG_RUN		0
  98#define MXT_POWER_CFG_DEEPSLEEP		1
  99
 100/* MXT_TOUCH_MULTI_T9 field */
 101#define MXT_T9_CTRL		0
 
 
 102#define MXT_T9_ORIENT		9
 103#define MXT_T9_RANGE		18
 104
 105/* MXT_TOUCH_MULTI_T9 status */
 106#define MXT_T9_UNGRIP		(1 << 0)
 107#define MXT_T9_SUPPRESS		(1 << 1)
 108#define MXT_T9_AMP		(1 << 2)
 109#define MXT_T9_VECTOR		(1 << 3)
 110#define MXT_T9_MOVE		(1 << 4)
 111#define MXT_T9_RELEASE		(1 << 5)
 112#define MXT_T9_PRESS		(1 << 6)
 113#define MXT_T9_DETECT		(1 << 7)
 114
 115struct t9_range {
 116	__le16 x;
 117	__le16 y;
 118} __packed;
 119
 120/* MXT_TOUCH_MULTI_T9 orient */
 121#define MXT_T9_ORIENT_SWITCH	(1 << 0)
 
 
 122
 123/* MXT_SPT_COMMSCONFIG_T18 */
 124#define MXT_COMMS_CTRL		0
 125#define MXT_COMMS_CMD		1
 126
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 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/* T100 Multiple Touch Touchscreen */
 133#define MXT_T100_CTRL		0
 134#define MXT_T100_CFG1		1
 135#define MXT_T100_TCHAUX		3
 
 136#define MXT_T100_XRANGE		13
 
 137#define MXT_T100_YRANGE		24
 138
 139#define MXT_T100_CFG_SWITCHXY	BIT(5)
 
 
 140
 141#define MXT_T100_TCHAUX_VECT	BIT(0)
 142#define MXT_T100_TCHAUX_AMPL	BIT(1)
 143#define MXT_T100_TCHAUX_AREA	BIT(2)
 144
 145#define MXT_T100_DETECT		BIT(7)
 146#define MXT_T100_TYPE_MASK	0x70
 147
 148enum t100_type {
 149	MXT_T100_TYPE_FINGER		= 1,
 150	MXT_T100_TYPE_PASSIVE_STYLUS	= 2,
 151	MXT_T100_TYPE_HOVERING_FINGER	= 4,
 152	MXT_T100_TYPE_GLOVE		= 5,
 153	MXT_T100_TYPE_LARGE_TOUCH	= 6,
 154};
 155
 156#define MXT_DISTANCE_ACTIVE_TOUCH	0
 157#define MXT_DISTANCE_HOVERING		1
 158
 159#define MXT_TOUCH_MAJOR_DEFAULT		1
 160#define MXT_PRESSURE_DEFAULT		1
 161
 162/* Delay times */
 163#define MXT_BACKUP_TIME		50	/* msec */
 
 
 164#define MXT_RESET_TIME		200	/* msec */
 165#define MXT_RESET_TIMEOUT	3000	/* msec */
 166#define MXT_CRC_TIMEOUT		1000	/* msec */
 167#define MXT_FW_RESET_TIME	3000	/* msec */
 168#define MXT_FW_CHG_TIMEOUT	300	/* msec */
 169
 170/* Command to unlock bootloader */
 171#define MXT_UNLOCK_CMD_MSB	0xaa
 172#define MXT_UNLOCK_CMD_LSB	0xdc
 173
 174/* Bootloader mode status */
 175#define MXT_WAITING_BOOTLOAD_CMD	0xc0	/* valid 7 6 bit only */
 176#define MXT_WAITING_FRAME_DATA	0x80	/* valid 7 6 bit only */
 177#define MXT_FRAME_CRC_CHECK	0x02
 178#define MXT_FRAME_CRC_FAIL	0x03
 179#define MXT_FRAME_CRC_PASS	0x04
 180#define MXT_APP_CRC_FAIL	0x40	/* valid 7 8 bit only */
 181#define MXT_BOOT_STATUS_MASK	0x3f
 182#define MXT_BOOT_EXTENDED_ID	(1 << 5)
 183#define MXT_BOOT_ID_MASK	0x1f
 184
 185/* Touchscreen absolute values */
 186#define MXT_MAX_AREA		0xff
 187
 188#define MXT_PIXELS_PER_MM	20
 189
 190struct mxt_info {
 191	u8 family_id;
 192	u8 variant_id;
 193	u8 version;
 194	u8 build;
 195	u8 matrix_xsize;
 196	u8 matrix_ysize;
 197	u8 object_num;
 198};
 199
 200struct mxt_object {
 201	u8 type;
 202	u16 start_address;
 203	u8 size_minus_one;
 204	u8 instances_minus_one;
 205	u8 num_report_ids;
 206} __packed;
 207
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 208/* Each client has this additional data */
 209struct mxt_data {
 210	struct i2c_client *client;
 211	struct input_dev *input_dev;
 212	char phys[64];		/* device physical location */
 213	const struct mxt_platform_data *pdata;
 214	struct mxt_object *object_table;
 215	struct mxt_info info;
 
 216	unsigned int irq;
 217	unsigned int max_x;
 218	unsigned int max_y;
 
 
 219	bool xy_switch;
 
 
 220	bool in_bootloader;
 221	u16 mem_size;
 222	u8 t100_aux_ampl;
 223	u8 t100_aux_area;
 224	u8 t100_aux_vect;
 225	u8 max_reportid;
 226	u32 config_crc;
 227	u32 info_crc;
 228	u8 bootloader_addr;
 229	u8 *msg_buf;
 230	u8 t6_status;
 231	bool update_input;
 232	u8 last_message_count;
 233	u8 num_touchids;
 234	u8 multitouch;
 235	struct t7_config t7_cfg;
 
 
 236
 237	/* Cached parameters from object table */
 238	u16 T5_address;
 239	u8 T5_msg_size;
 240	u8 T6_reportid;
 241	u16 T6_address;
 242	u16 T7_address;
 
 243	u8 T9_reportid_min;
 244	u8 T9_reportid_max;
 245	u8 T19_reportid;
 246	u16 T44_address;
 247	u8 T100_reportid_min;
 248	u8 T100_reportid_max;
 249
 250	/* for fw update in bootloader */
 251	struct completion bl_completion;
 252
 253	/* for reset handling */
 254	struct completion reset_completion;
 255
 256	/* for config update handling */
 257	struct completion crc_completion;
 
 
 
 
 
 
 
 
 
 
 258};
 259
 260static size_t mxt_obj_size(const struct mxt_object *obj)
 261{
 262	return obj->size_minus_one + 1;
 263}
 264
 265static size_t mxt_obj_instances(const struct mxt_object *obj)
 266{
 267	return obj->instances_minus_one + 1;
 268}
 269
 270static bool mxt_object_readable(unsigned int type)
 271{
 272	switch (type) {
 273	case MXT_GEN_COMMAND_T6:
 274	case MXT_GEN_POWER_T7:
 275	case MXT_GEN_ACQUIRE_T8:
 276	case MXT_GEN_DATASOURCE_T53:
 277	case MXT_TOUCH_MULTI_T9:
 278	case MXT_TOUCH_KEYARRAY_T15:
 279	case MXT_TOUCH_PROXIMITY_T23:
 280	case MXT_TOUCH_PROXKEY_T52:
 
 281	case MXT_PROCI_GRIPFACE_T20:
 282	case MXT_PROCG_NOISE_T22:
 283	case MXT_PROCI_ONETOUCH_T24:
 284	case MXT_PROCI_TWOTOUCH_T27:
 285	case MXT_PROCI_GRIP_T40:
 286	case MXT_PROCI_PALM_T41:
 287	case MXT_PROCI_TOUCHSUPPRESSION_T42:
 288	case MXT_PROCI_STYLUS_T47:
 289	case MXT_PROCG_NOISESUPPRESSION_T48:
 290	case MXT_SPT_COMMSCONFIG_T18:
 291	case MXT_SPT_GPIOPWM_T19:
 292	case MXT_SPT_SELFTEST_T25:
 293	case MXT_SPT_CTECONFIG_T28:
 294	case MXT_SPT_USERDATA_T38:
 295	case MXT_SPT_DIGITIZER_T43:
 296	case MXT_SPT_CTECONFIG_T46:
 
 297		return true;
 298	default:
 299		return false;
 300	}
 301}
 302
 303static void mxt_dump_message(struct mxt_data *data, u8 *message)
 304{
 305	dev_dbg(&data->client->dev, "message: %*ph\n",
 306		data->T5_msg_size, message);
 307}
 308
 309static int mxt_wait_for_completion(struct mxt_data *data,
 310				   struct completion *comp,
 311				   unsigned int timeout_ms)
 312{
 313	struct device *dev = &data->client->dev;
 314	unsigned long timeout = msecs_to_jiffies(timeout_ms);
 315	long ret;
 316
 317	ret = wait_for_completion_interruptible_timeout(comp, timeout);
 318	if (ret < 0) {
 319		return ret;
 320	} else if (ret == 0) {
 321		dev_err(dev, "Wait for completion timed out.\n");
 322		return -ETIMEDOUT;
 323	}
 324	return 0;
 325}
 326
 327static int mxt_bootloader_read(struct mxt_data *data,
 328			       u8 *val, unsigned int count)
 329{
 330	int ret;
 331	struct i2c_msg msg;
 332
 333	msg.addr = data->bootloader_addr;
 334	msg.flags = data->client->flags & I2C_M_TEN;
 335	msg.flags |= I2C_M_RD;
 336	msg.len = count;
 337	msg.buf = val;
 338
 339	ret = i2c_transfer(data->client->adapter, &msg, 1);
 340	if (ret == 1) {
 341		ret = 0;
 342	} else {
 343		ret = ret < 0 ? ret : -EIO;
 344		dev_err(&data->client->dev, "%s: i2c recv failed (%d)\n",
 345			__func__, ret);
 346	}
 347
 348	return ret;
 349}
 350
 351static int mxt_bootloader_write(struct mxt_data *data,
 352				const u8 * const val, unsigned int count)
 353{
 354	int ret;
 355	struct i2c_msg msg;
 356
 357	msg.addr = data->bootloader_addr;
 358	msg.flags = data->client->flags & I2C_M_TEN;
 359	msg.len = count;
 360	msg.buf = (u8 *)val;
 361
 362	ret = i2c_transfer(data->client->adapter, &msg, 1);
 363	if (ret == 1) {
 364		ret = 0;
 365	} else {
 366		ret = ret < 0 ? ret : -EIO;
 367		dev_err(&data->client->dev, "%s: i2c send failed (%d)\n",
 368			__func__, ret);
 369	}
 370
 371	return ret;
 372}
 373
 374static int mxt_lookup_bootloader_address(struct mxt_data *data, bool retry)
 375{
 376	u8 appmode = data->client->addr;
 377	u8 bootloader;
 
 378
 379	switch (appmode) {
 380	case 0x4a:
 381	case 0x4b:
 382		/* Chips after 1664S use different scheme */
 383		if (retry || data->info.family_id >= 0xa2) {
 384			bootloader = appmode - 0x24;
 385			break;
 386		}
 387		/* Fall through for normal case */
 388	case 0x4c:
 389	case 0x4d:
 390	case 0x5a:
 391	case 0x5b:
 392		bootloader = appmode - 0x26;
 393		break;
 394
 395	default:
 396		dev_err(&data->client->dev,
 397			"Appmode i2c address 0x%02x not found\n",
 398			appmode);
 399		return -EINVAL;
 400	}
 401
 402	data->bootloader_addr = bootloader;
 403	return 0;
 404}
 405
 406static int mxt_probe_bootloader(struct mxt_data *data, bool alt_address)
 407{
 408	struct device *dev = &data->client->dev;
 409	int error;
 410	u8 val;
 411	bool crc_failure;
 412
 413	error = mxt_lookup_bootloader_address(data, alt_address);
 414	if (error)
 415		return error;
 416
 417	error = mxt_bootloader_read(data, &val, 1);
 418	if (error)
 419		return error;
 420
 421	/* Check app crc fail mode */
 422	crc_failure = (val & ~MXT_BOOT_STATUS_MASK) == MXT_APP_CRC_FAIL;
 423
 424	dev_err(dev, "Detected bootloader, status:%02X%s\n",
 425			val, crc_failure ? ", APP_CRC_FAIL" : "");
 426
 427	return 0;
 428}
 429
 430static u8 mxt_get_bootloader_version(struct mxt_data *data, u8 val)
 431{
 432	struct device *dev = &data->client->dev;
 433	u8 buf[3];
 434
 435	if (val & MXT_BOOT_EXTENDED_ID) {
 436		if (mxt_bootloader_read(data, &buf[0], 3) != 0) {
 437			dev_err(dev, "%s: i2c failure\n", __func__);
 438			return val;
 439		}
 440
 441		dev_dbg(dev, "Bootloader ID:%d Version:%d\n", buf[1], buf[2]);
 442
 443		return buf[0];
 444	} else {
 445		dev_dbg(dev, "Bootloader ID:%d\n", val & MXT_BOOT_ID_MASK);
 446
 447		return val;
 448	}
 449}
 450
 451static int mxt_check_bootloader(struct mxt_data *data, unsigned int state,
 452				bool wait)
 453{
 454	struct device *dev = &data->client->dev;
 455	u8 val;
 456	int ret;
 457
 458recheck:
 459	if (wait) {
 460		/*
 461		 * In application update mode, the interrupt
 462		 * line signals state transitions. We must wait for the
 463		 * CHG assertion before reading the status byte.
 464		 * Once the status byte has been read, the line is deasserted.
 465		 */
 466		ret = mxt_wait_for_completion(data, &data->bl_completion,
 467					      MXT_FW_CHG_TIMEOUT);
 468		if (ret) {
 469			/*
 470			 * TODO: handle -ERESTARTSYS better by terminating
 471			 * fw update process before returning to userspace
 472			 * by writing length 0x000 to device (iff we are in
 473			 * WAITING_FRAME_DATA state).
 474			 */
 475			dev_err(dev, "Update wait error %d\n", ret);
 476			return ret;
 477		}
 478	}
 479
 480	ret = mxt_bootloader_read(data, &val, 1);
 481	if (ret)
 482		return ret;
 483
 484	if (state == MXT_WAITING_BOOTLOAD_CMD)
 485		val = mxt_get_bootloader_version(data, val);
 486
 487	switch (state) {
 488	case MXT_WAITING_BOOTLOAD_CMD:
 489	case MXT_WAITING_FRAME_DATA:
 490	case MXT_APP_CRC_FAIL:
 491		val &= ~MXT_BOOT_STATUS_MASK;
 492		break;
 493	case MXT_FRAME_CRC_PASS:
 494		if (val == MXT_FRAME_CRC_CHECK) {
 495			goto recheck;
 496		} else if (val == MXT_FRAME_CRC_FAIL) {
 497			dev_err(dev, "Bootloader CRC fail\n");
 498			return -EINVAL;
 499		}
 500		break;
 501	default:
 502		return -EINVAL;
 503	}
 504
 505	if (val != state) {
 506		dev_err(dev, "Invalid bootloader state %02X != %02X\n",
 507			val, state);
 508		return -EINVAL;
 509	}
 510
 511	return 0;
 512}
 513
 514static int mxt_send_bootloader_cmd(struct mxt_data *data, bool unlock)
 515{
 516	int ret;
 517	u8 buf[2];
 518
 519	if (unlock) {
 520		buf[0] = MXT_UNLOCK_CMD_LSB;
 521		buf[1] = MXT_UNLOCK_CMD_MSB;
 522	} else {
 523		buf[0] = 0x01;
 524		buf[1] = 0x01;
 525	}
 526
 527	ret = mxt_bootloader_write(data, buf, 2);
 528	if (ret)
 529		return ret;
 530
 531	return 0;
 532}
 533
 534static int __mxt_read_reg(struct i2c_client *client,
 535			       u16 reg, u16 len, void *val)
 536{
 537	struct i2c_msg xfer[2];
 538	u8 buf[2];
 539	int ret;
 540
 541	buf[0] = reg & 0xff;
 542	buf[1] = (reg >> 8) & 0xff;
 543
 544	/* Write register */
 545	xfer[0].addr = client->addr;
 546	xfer[0].flags = 0;
 547	xfer[0].len = 2;
 548	xfer[0].buf = buf;
 549
 550	/* Read data */
 551	xfer[1].addr = client->addr;
 552	xfer[1].flags = I2C_M_RD;
 553	xfer[1].len = len;
 554	xfer[1].buf = val;
 555
 556	ret = i2c_transfer(client->adapter, xfer, 2);
 557	if (ret == 2) {
 558		ret = 0;
 559	} else {
 560		if (ret >= 0)
 561			ret = -EIO;
 562		dev_err(&client->dev, "%s: i2c transfer failed (%d)\n",
 563			__func__, ret);
 564	}
 565
 566	return ret;
 567}
 568
 569static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len,
 570			   const void *val)
 571{
 572	u8 *buf;
 573	size_t count;
 574	int ret;
 575
 576	count = len + 2;
 577	buf = kmalloc(count, GFP_KERNEL);
 578	if (!buf)
 579		return -ENOMEM;
 580
 581	buf[0] = reg & 0xff;
 582	buf[1] = (reg >> 8) & 0xff;
 583	memcpy(&buf[2], val, len);
 584
 585	ret = i2c_master_send(client, buf, count);
 586	if (ret == count) {
 587		ret = 0;
 588	} else {
 589		if (ret >= 0)
 590			ret = -EIO;
 591		dev_err(&client->dev, "%s: i2c send failed (%d)\n",
 592			__func__, ret);
 593	}
 594
 595	kfree(buf);
 596	return ret;
 597}
 598
 599static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
 600{
 601	return __mxt_write_reg(client, reg, 1, &val);
 602}
 603
 604static struct mxt_object *
 605mxt_get_object(struct mxt_data *data, u8 type)
 606{
 607	struct mxt_object *object;
 608	int i;
 609
 610	for (i = 0; i < data->info.object_num; i++) {
 611		object = data->object_table + i;
 612		if (object->type == type)
 613			return object;
 614	}
 615
 616	dev_warn(&data->client->dev, "Invalid object type T%u\n", type);
 617	return NULL;
 618}
 619
 620static void mxt_proc_t6_messages(struct mxt_data *data, u8 *msg)
 621{
 622	struct device *dev = &data->client->dev;
 623	u8 status = msg[1];
 624	u32 crc = msg[2] | (msg[3] << 8) | (msg[4] << 16);
 625
 626	complete(&data->crc_completion);
 627
 628	if (crc != data->config_crc) {
 629		data->config_crc = crc;
 630		dev_dbg(dev, "T6 Config Checksum: 0x%06X\n", crc);
 631	}
 632
 
 
 633	/* Detect reset */
 634	if (status & MXT_T6_STATUS_RESET)
 635		complete(&data->reset_completion);
 636
 637	/* Output debug if status has changed */
 638	if (status != data->t6_status)
 639		dev_dbg(dev, "T6 Status 0x%02X%s%s%s%s%s%s%s\n",
 640			status,
 641			status == 0 ? " OK" : "",
 642			status & MXT_T6_STATUS_RESET ? " RESET" : "",
 643			status & MXT_T6_STATUS_OFL ? " OFL" : "",
 644			status & MXT_T6_STATUS_SIGERR ? " SIGERR" : "",
 645			status & MXT_T6_STATUS_CAL ? " CAL" : "",
 646			status & MXT_T6_STATUS_CFGERR ? " CFGERR" : "",
 647			status & MXT_T6_STATUS_COMSERR ? " COMSERR" : "");
 648
 649	/* Save current status */
 650	data->t6_status = status;
 651}
 652
 653static int mxt_write_object(struct mxt_data *data,
 654				 u8 type, u8 offset, u8 val)
 655{
 656	struct mxt_object *object;
 657	u16 reg;
 658
 659	object = mxt_get_object(data, type);
 660	if (!object || offset >= mxt_obj_size(object))
 661		return -EINVAL;
 662
 663	reg = object->start_address;
 664	return mxt_write_reg(data->client, reg + offset, val);
 665}
 666
 667static void mxt_input_button(struct mxt_data *data, u8 *message)
 668{
 669	struct input_dev *input = data->input_dev;
 670	const struct mxt_platform_data *pdata = data->pdata;
 671	int i;
 672
 673	for (i = 0; i < pdata->t19_num_keys; i++) {
 674		if (pdata->t19_keymap[i] == KEY_RESERVED)
 675			continue;
 676
 677		/* Active-low switch */
 678		input_report_key(input, pdata->t19_keymap[i],
 679				 !(message[1] & BIT(i)));
 680	}
 681}
 682
 683static void mxt_input_sync(struct mxt_data *data)
 684{
 685	input_mt_report_pointer_emulation(data->input_dev,
 686					  data->pdata->t19_num_keys);
 687	input_sync(data->input_dev);
 688}
 689
 690static void mxt_proc_t9_message(struct mxt_data *data, u8 *message)
 691{
 692	struct device *dev = &data->client->dev;
 693	struct input_dev *input_dev = data->input_dev;
 694	int id;
 695	u8 status;
 696	int x;
 697	int y;
 698	int area;
 699	int amplitude;
 700
 701	id = message[0] - data->T9_reportid_min;
 702	status = message[1];
 703	x = (message[2] << 4) | ((message[4] >> 4) & 0xf);
 704	y = (message[3] << 4) | ((message[4] & 0xf));
 705
 706	/* Handle 10/12 bit switching */
 707	if (data->max_x < 1024)
 708		x >>= 2;
 709	if (data->max_y < 1024)
 710		y >>= 2;
 711
 712	area = message[5];
 713	amplitude = message[6];
 714
 715	dev_dbg(dev,
 716		"[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
 717		id,
 718		(status & MXT_T9_DETECT) ? 'D' : '.',
 719		(status & MXT_T9_PRESS) ? 'P' : '.',
 720		(status & MXT_T9_RELEASE) ? 'R' : '.',
 721		(status & MXT_T9_MOVE) ? 'M' : '.',
 722		(status & MXT_T9_VECTOR) ? 'V' : '.',
 723		(status & MXT_T9_AMP) ? 'A' : '.',
 724		(status & MXT_T9_SUPPRESS) ? 'S' : '.',
 725		(status & MXT_T9_UNGRIP) ? 'U' : '.',
 726		x, y, area, amplitude);
 727
 728	input_mt_slot(input_dev, id);
 729
 730	if (status & MXT_T9_DETECT) {
 731		/*
 732		 * Multiple bits may be set if the host is slow to read
 733		 * the status messages, indicating all the events that
 734		 * have happened.
 735		 */
 736		if (status & MXT_T9_RELEASE) {
 737			input_mt_report_slot_state(input_dev,
 738						   MT_TOOL_FINGER, 0);
 739			mxt_input_sync(data);
 740		}
 741
 
 
 
 
 742		/* Touch active */
 743		input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 1);
 744		input_report_abs(input_dev, ABS_MT_POSITION_X, x);
 745		input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
 746		input_report_abs(input_dev, ABS_MT_PRESSURE, amplitude);
 747		input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
 748	} else {
 749		/* Touch no longer active, close out slot */
 750		input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 0);
 751	}
 752
 753	data->update_input = true;
 754}
 755
 756static void mxt_proc_t100_message(struct mxt_data *data, u8 *message)
 757{
 758	struct device *dev = &data->client->dev;
 759	struct input_dev *input_dev = data->input_dev;
 760	int id;
 761	u8 status;
 762	u8 type = 0;
 763	u16 x;
 764	u16 y;
 765	int distance = 0;
 766	int tool = 0;
 767	u8 major = 0;
 768	u8 pressure = 0;
 769	u8 orientation = 0;
 770
 771	id = message[0] - data->T100_reportid_min - 2;
 772
 773	/* ignore SCRSTATUS events */
 774	if (id < 0)
 775		return;
 776
 777	status = message[1];
 778	x = get_unaligned_le16(&message[2]);
 779	y = get_unaligned_le16(&message[4]);
 780
 781	if (status & MXT_T100_DETECT) {
 782		type = (status & MXT_T100_TYPE_MASK) >> 4;
 783
 784		switch (type) {
 785		case MXT_T100_TYPE_HOVERING_FINGER:
 786			tool = MT_TOOL_FINGER;
 787			distance = MXT_DISTANCE_HOVERING;
 788
 789			if (data->t100_aux_vect)
 790				orientation = message[data->t100_aux_vect];
 791
 792			break;
 793
 794		case MXT_T100_TYPE_FINGER:
 795		case MXT_T100_TYPE_GLOVE:
 796			tool = MT_TOOL_FINGER;
 797			distance = MXT_DISTANCE_ACTIVE_TOUCH;
 798
 799			if (data->t100_aux_area)
 800				major = message[data->t100_aux_area];
 801
 802			if (data->t100_aux_ampl)
 803				pressure = message[data->t100_aux_ampl];
 804
 805			if (data->t100_aux_vect)
 806				orientation = message[data->t100_aux_vect];
 807
 808			break;
 809
 810		case MXT_T100_TYPE_PASSIVE_STYLUS:
 811			tool = MT_TOOL_PEN;
 812
 813			/*
 814			 * Passive stylus is reported with size zero so
 815			 * hardcode.
 816			 */
 817			major = MXT_TOUCH_MAJOR_DEFAULT;
 818
 819			if (data->t100_aux_ampl)
 820				pressure = message[data->t100_aux_ampl];
 821
 822			break;
 823
 824		case MXT_T100_TYPE_LARGE_TOUCH:
 825			/* Ignore suppressed touch */
 826			break;
 827
 828		default:
 829			dev_dbg(dev, "Unexpected T100 type\n");
 830			return;
 831		}
 832	}
 833
 834	/*
 835	 * Values reported should be non-zero if tool is touching the
 836	 * device
 837	 */
 838	if (!pressure && type != MXT_T100_TYPE_HOVERING_FINGER)
 839		pressure = MXT_PRESSURE_DEFAULT;
 840
 841	input_mt_slot(input_dev, id);
 842
 843	if (status & MXT_T100_DETECT) {
 844		dev_dbg(dev, "[%u] type:%u x:%u y:%u a:%02X p:%02X v:%02X\n",
 845			id, type, x, y, major, pressure, orientation);
 846
 847		input_mt_report_slot_state(input_dev, tool, 1);
 848		input_report_abs(input_dev, ABS_MT_POSITION_X, x);
 849		input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
 850		input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, major);
 851		input_report_abs(input_dev, ABS_MT_PRESSURE, pressure);
 852		input_report_abs(input_dev, ABS_MT_DISTANCE, distance);
 853		input_report_abs(input_dev, ABS_MT_ORIENTATION, orientation);
 854	} else {
 855		dev_dbg(dev, "[%u] release\n", id);
 856
 857		/* close out slot */
 858		input_mt_report_slot_state(input_dev, 0, 0);
 859	}
 860
 861	data->update_input = true;
 862}
 863
 864static int mxt_proc_message(struct mxt_data *data, u8 *message)
 865{
 866	u8 report_id = message[0];
 867
 868	if (report_id == MXT_RPTID_NOMSG)
 869		return 0;
 870
 871	if (report_id == data->T6_reportid) {
 872		mxt_proc_t6_messages(data, message);
 873	} else if (!data->input_dev) {
 874		/*
 875		 * Do not report events if input device
 876		 * is not yet registered.
 877		 */
 878		mxt_dump_message(data, message);
 879	} else if (report_id >= data->T9_reportid_min &&
 880		   report_id <= data->T9_reportid_max) {
 881		mxt_proc_t9_message(data, message);
 882	} else if (report_id >= data->T100_reportid_min &&
 883		   report_id <= data->T100_reportid_max) {
 884		mxt_proc_t100_message(data, message);
 885	} else if (report_id == data->T19_reportid) {
 886		mxt_input_button(data, message);
 887		data->update_input = true;
 888	} else {
 889		mxt_dump_message(data, message);
 890	}
 891
 892	return 1;
 893}
 894
 895static int mxt_read_and_process_messages(struct mxt_data *data, u8 count)
 896{
 897	struct device *dev = &data->client->dev;
 898	int ret;
 899	int i;
 900	u8 num_valid = 0;
 901
 902	/* Safety check for msg_buf */
 903	if (count > data->max_reportid)
 904		return -EINVAL;
 905
 906	/* Process remaining messages if necessary */
 907	ret = __mxt_read_reg(data->client, data->T5_address,
 908				data->T5_msg_size * count, data->msg_buf);
 909	if (ret) {
 910		dev_err(dev, "Failed to read %u messages (%d)\n", count, ret);
 911		return ret;
 912	}
 913
 914	for (i = 0;  i < count; i++) {
 915		ret = mxt_proc_message(data,
 916			data->msg_buf + data->T5_msg_size * i);
 917
 918		if (ret == 1)
 919			num_valid++;
 920	}
 921
 922	/* return number of messages read */
 923	return num_valid;
 924}
 925
 926static irqreturn_t mxt_process_messages_t44(struct mxt_data *data)
 927{
 928	struct device *dev = &data->client->dev;
 929	int ret;
 930	u8 count, num_left;
 931
 932	/* Read T44 and T5 together */
 933	ret = __mxt_read_reg(data->client, data->T44_address,
 934		data->T5_msg_size + 1, data->msg_buf);
 935	if (ret) {
 936		dev_err(dev, "Failed to read T44 and T5 (%d)\n", ret);
 937		return IRQ_NONE;
 938	}
 939
 940	count = data->msg_buf[0];
 941
 942	/*
 943	 * This condition may be caused by the CHG line being configured in
 944	 * Mode 0. It results in unnecessary I2C operations but it is benign.
 945	 */
 946	if (count == 0)
 947		return IRQ_NONE;
 948
 949	if (count > data->max_reportid) {
 950		dev_warn(dev, "T44 count %d exceeded max report id\n", count);
 951		count = data->max_reportid;
 952	}
 953
 954	/* Process first message */
 955	ret = mxt_proc_message(data, data->msg_buf + 1);
 956	if (ret < 0) {
 957		dev_warn(dev, "Unexpected invalid message\n");
 958		return IRQ_NONE;
 959	}
 960
 961	num_left = count - 1;
 962
 963	/* Process remaining messages if necessary */
 964	if (num_left) {
 965		ret = mxt_read_and_process_messages(data, num_left);
 966		if (ret < 0)
 967			goto end;
 968		else if (ret != num_left)
 969			dev_warn(dev, "Unexpected invalid message\n");
 970	}
 971
 972end:
 973	if (data->update_input) {
 974		mxt_input_sync(data);
 975		data->update_input = false;
 976	}
 977
 978	return IRQ_HANDLED;
 979}
 980
 981static int mxt_process_messages_until_invalid(struct mxt_data *data)
 982{
 983	struct device *dev = &data->client->dev;
 984	int count, read;
 985	u8 tries = 2;
 986
 987	count = data->max_reportid;
 988
 989	/* Read messages until we force an invalid */
 990	do {
 991		read = mxt_read_and_process_messages(data, count);
 992		if (read < count)
 993			return 0;
 994	} while (--tries);
 995
 996	if (data->update_input) {
 997		mxt_input_sync(data);
 998		data->update_input = false;
 999	}
1000
1001	dev_err(dev, "CHG pin isn't cleared\n");
1002	return -EBUSY;
1003}
1004
1005static irqreturn_t mxt_process_messages(struct mxt_data *data)
1006{
1007	int total_handled, num_handled;
1008	u8 count = data->last_message_count;
1009
1010	if (count < 1 || count > data->max_reportid)
1011		count = 1;
1012
1013	/* include final invalid message */
1014	total_handled = mxt_read_and_process_messages(data, count + 1);
1015	if (total_handled < 0)
1016		return IRQ_NONE;
1017	/* if there were invalid messages, then we are done */
1018	else if (total_handled <= count)
1019		goto update_count;
1020
1021	/* keep reading two msgs until one is invalid or reportid limit */
1022	do {
1023		num_handled = mxt_read_and_process_messages(data, 2);
1024		if (num_handled < 0)
1025			return IRQ_NONE;
1026
1027		total_handled += num_handled;
1028
1029		if (num_handled < 2)
1030			break;
1031	} while (total_handled < data->num_touchids);
1032
1033update_count:
1034	data->last_message_count = total_handled;
1035
1036	if (data->update_input) {
1037		mxt_input_sync(data);
1038		data->update_input = false;
1039	}
1040
1041	return IRQ_HANDLED;
1042}
1043
1044static irqreturn_t mxt_interrupt(int irq, void *dev_id)
1045{
1046	struct mxt_data *data = dev_id;
1047
1048	if (data->in_bootloader) {
1049		/* bootloader state transition completion */
1050		complete(&data->bl_completion);
1051		return IRQ_HANDLED;
1052	}
1053
1054	if (!data->object_table)
1055		return IRQ_HANDLED;
1056
1057	if (data->T44_address) {
1058		return mxt_process_messages_t44(data);
1059	} else {
1060		return mxt_process_messages(data);
1061	}
1062}
1063
1064static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset,
1065			  u8 value, bool wait)
1066{
1067	u16 reg;
1068	u8 command_register;
1069	int timeout_counter = 0;
1070	int ret;
1071
1072	reg = data->T6_address + cmd_offset;
1073
1074	ret = mxt_write_reg(data->client, reg, value);
1075	if (ret)
1076		return ret;
1077
1078	if (!wait)
1079		return 0;
1080
1081	do {
1082		msleep(20);
1083		ret = __mxt_read_reg(data->client, reg, 1, &command_register);
1084		if (ret)
1085			return ret;
1086	} while (command_register != 0 && timeout_counter++ <= 100);
1087
1088	if (timeout_counter > 100) {
1089		dev_err(&data->client->dev, "Command failed!\n");
1090		return -EIO;
1091	}
1092
1093	return 0;
1094}
1095
1096static int mxt_acquire_irq(struct mxt_data *data)
1097{
1098	int error;
1099
1100	enable_irq(data->irq);
1101
1102	error = mxt_process_messages_until_invalid(data);
1103	if (error)
1104		return error;
1105
1106	return 0;
1107}
1108
1109static int mxt_soft_reset(struct mxt_data *data)
1110{
1111	struct device *dev = &data->client->dev;
1112	int ret = 0;
1113
1114	dev_info(dev, "Resetting device\n");
1115
1116	disable_irq(data->irq);
1117
1118	reinit_completion(&data->reset_completion);
1119
1120	ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false);
1121	if (ret)
1122		return ret;
1123
1124	/* Ignore CHG line for 100ms after reset */
1125	msleep(100);
1126
1127	mxt_acquire_irq(data);
1128
1129	ret = mxt_wait_for_completion(data, &data->reset_completion,
1130				      MXT_RESET_TIMEOUT);
1131	if (ret)
1132		return ret;
1133
1134	return 0;
1135}
1136
1137static void mxt_update_crc(struct mxt_data *data, u8 cmd, u8 value)
1138{
1139	/*
1140	 * On failure, CRC is set to 0 and config will always be
1141	 * downloaded.
1142	 */
1143	data->config_crc = 0;
1144	reinit_completion(&data->crc_completion);
1145
1146	mxt_t6_command(data, cmd, value, true);
1147
1148	/*
1149	 * Wait for crc message. On failure, CRC is set to 0 and config will
1150	 * always be downloaded.
1151	 */
1152	mxt_wait_for_completion(data, &data->crc_completion, MXT_CRC_TIMEOUT);
1153}
1154
1155static void mxt_calc_crc24(u32 *crc, u8 firstbyte, u8 secondbyte)
1156{
1157	static const unsigned int crcpoly = 0x80001B;
1158	u32 result;
1159	u32 data_word;
1160
1161	data_word = (secondbyte << 8) | firstbyte;
1162	result = ((*crc << 1) ^ data_word);
1163
1164	if (result & 0x1000000)
1165		result ^= crcpoly;
1166
1167	*crc = result;
1168}
1169
1170static u32 mxt_calculate_crc(u8 *base, off_t start_off, off_t end_off)
1171{
1172	u32 crc = 0;
1173	u8 *ptr = base + start_off;
1174	u8 *last_val = base + end_off - 1;
1175
1176	if (end_off < start_off)
1177		return -EINVAL;
1178
1179	while (ptr < last_val) {
1180		mxt_calc_crc24(&crc, *ptr, *(ptr + 1));
1181		ptr += 2;
1182	}
1183
1184	/* if len is odd, fill the last byte with 0 */
1185	if (ptr == last_val)
1186		mxt_calc_crc24(&crc, *ptr, 0);
1187
1188	/* Mask to 24-bit */
1189	crc &= 0x00FFFFFF;
1190
1191	return crc;
1192}
1193
1194static int mxt_prepare_cfg_mem(struct mxt_data *data,
1195			       const struct firmware *cfg,
1196			       unsigned int data_pos,
1197			       unsigned int cfg_start_ofs,
1198			       u8 *config_mem,
1199			       size_t config_mem_size)
1200{
1201	struct device *dev = &data->client->dev;
1202	struct mxt_object *object;
1203	unsigned int type, instance, size, byte_offset;
1204	int offset;
1205	int ret;
1206	int i;
1207	u16 reg;
1208	u8 val;
1209
1210	while (data_pos < cfg->size) {
1211		/* Read type, instance, length */
1212		ret = sscanf(cfg->data + data_pos, "%x %x %x%n",
1213			     &type, &instance, &size, &offset);
1214		if (ret == 0) {
1215			/* EOF */
1216			break;
1217		} else if (ret != 3) {
1218			dev_err(dev, "Bad format: failed to parse object\n");
1219			return -EINVAL;
1220		}
1221		data_pos += offset;
1222
1223		object = mxt_get_object(data, type);
1224		if (!object) {
1225			/* Skip object */
1226			for (i = 0; i < size; i++) {
1227				ret = sscanf(cfg->data + data_pos, "%hhx%n",
1228					     &val, &offset);
1229				if (ret != 1) {
1230					dev_err(dev, "Bad format in T%d at %d\n",
1231						type, i);
1232					return -EINVAL;
1233				}
1234				data_pos += offset;
1235			}
1236			continue;
1237		}
1238
1239		if (size > mxt_obj_size(object)) {
1240			/*
1241			 * Either we are in fallback mode due to wrong
1242			 * config or config from a later fw version,
1243			 * or the file is corrupt or hand-edited.
1244			 */
1245			dev_warn(dev, "Discarding %zu byte(s) in T%u\n",
1246				 size - mxt_obj_size(object), type);
1247		} else if (mxt_obj_size(object) > size) {
1248			/*
1249			 * If firmware is upgraded, new bytes may be added to
1250			 * end of objects. It is generally forward compatible
1251			 * to zero these bytes - previous behaviour will be
1252			 * retained. However this does invalidate the CRC and
1253			 * will force fallback mode until the configuration is
1254			 * updated. We warn here but do nothing else - the
1255			 * malloc has zeroed the entire configuration.
1256			 */
1257			dev_warn(dev, "Zeroing %zu byte(s) in T%d\n",
1258				 mxt_obj_size(object) - size, type);
1259		}
1260
1261		if (instance >= mxt_obj_instances(object)) {
1262			dev_err(dev, "Object instances exceeded!\n");
1263			return -EINVAL;
1264		}
1265
1266		reg = object->start_address + mxt_obj_size(object) * instance;
1267
1268		for (i = 0; i < size; i++) {
1269			ret = sscanf(cfg->data + data_pos, "%hhx%n",
1270				     &val,
1271				     &offset);
1272			if (ret != 1) {
1273				dev_err(dev, "Bad format in T%d at %d\n",
1274					type, i);
1275				return -EINVAL;
1276			}
1277			data_pos += offset;
1278
1279			if (i > mxt_obj_size(object))
1280				continue;
1281
1282			byte_offset = reg + i - cfg_start_ofs;
1283
1284			if (byte_offset >= 0 && byte_offset < config_mem_size) {
1285				*(config_mem + byte_offset) = val;
1286			} else {
1287				dev_err(dev, "Bad object: reg:%d, T%d, ofs=%d\n",
1288					reg, object->type, byte_offset);
1289				return -EINVAL;
1290			}
1291		}
1292	}
1293
1294	return 0;
1295}
1296
1297static int mxt_upload_cfg_mem(struct mxt_data *data, unsigned int cfg_start,
1298			      u8 *config_mem, size_t config_mem_size)
1299{
1300	unsigned int byte_offset = 0;
1301	int error;
1302
1303	/* Write configuration as blocks */
1304	while (byte_offset < config_mem_size) {
1305		unsigned int size = config_mem_size - byte_offset;
1306
1307		if (size > MXT_MAX_BLOCK_WRITE)
1308			size = MXT_MAX_BLOCK_WRITE;
1309
1310		error = __mxt_write_reg(data->client,
1311					cfg_start + byte_offset,
1312					size, config_mem + byte_offset);
1313		if (error) {
1314			dev_err(&data->client->dev,
1315				"Config write error, ret=%d\n", error);
1316			return error;
1317		}
1318
1319		byte_offset += size;
1320	}
1321
1322	return 0;
1323}
1324
1325static int mxt_init_t7_power_cfg(struct mxt_data *data);
1326
1327/*
1328 * mxt_update_cfg - download configuration to chip
1329 *
1330 * Atmel Raw Config File Format
1331 *
1332 * The first four lines of the raw config file contain:
1333 *  1) Version
1334 *  2) Chip ID Information (first 7 bytes of device memory)
1335 *  3) Chip Information Block 24-bit CRC Checksum
1336 *  4) Chip Configuration 24-bit CRC Checksum
1337 *
1338 * The rest of the file consists of one line per object instance:
1339 *   <TYPE> <INSTANCE> <SIZE> <CONTENTS>
1340 *
1341 *   <TYPE> - 2-byte object type as hex
1342 *   <INSTANCE> - 2-byte object instance number as hex
1343 *   <SIZE> - 2-byte object size as hex
1344 *   <CONTENTS> - array of <SIZE> 1-byte hex values
1345 */
1346static int mxt_update_cfg(struct mxt_data *data, const struct firmware *cfg)
1347{
1348	struct device *dev = &data->client->dev;
1349	struct mxt_info cfg_info;
1350	int ret;
1351	int offset;
1352	int data_pos;
1353	int i;
1354	int cfg_start_ofs;
1355	u32 info_crc, config_crc, calculated_crc;
1356	u8 *config_mem;
1357	size_t config_mem_size;
 
 
 
 
 
 
1358
1359	mxt_update_crc(data, MXT_COMMAND_REPORTALL, 1);
1360
1361	if (strncmp(cfg->data, MXT_CFG_MAGIC, strlen(MXT_CFG_MAGIC))) {
1362		dev_err(dev, "Unrecognised config file\n");
1363		return -EINVAL;
 
1364	}
1365
1366	data_pos = strlen(MXT_CFG_MAGIC);
1367
1368	/* Load information block and check */
1369	for (i = 0; i < sizeof(struct mxt_info); i++) {
1370		ret = sscanf(cfg->data + data_pos, "%hhx%n",
1371			     (unsigned char *)&cfg_info + i,
1372			     &offset);
1373		if (ret != 1) {
1374			dev_err(dev, "Bad format\n");
1375			return -EINVAL;
 
1376		}
1377
1378		data_pos += offset;
1379	}
1380
1381	if (cfg_info.family_id != data->info.family_id) {
1382		dev_err(dev, "Family ID mismatch!\n");
1383		return -EINVAL;
 
1384	}
1385
1386	if (cfg_info.variant_id != data->info.variant_id) {
1387		dev_err(dev, "Variant ID mismatch!\n");
1388		return -EINVAL;
 
1389	}
1390
1391	/* Read CRCs */
1392	ret = sscanf(cfg->data + data_pos, "%x%n", &info_crc, &offset);
1393	if (ret != 1) {
1394		dev_err(dev, "Bad format: failed to parse Info CRC\n");
1395		return -EINVAL;
 
1396	}
1397	data_pos += offset;
1398
1399	ret = sscanf(cfg->data + data_pos, "%x%n", &config_crc, &offset);
1400	if (ret != 1) {
1401		dev_err(dev, "Bad format: failed to parse Config CRC\n");
1402		return -EINVAL;
 
1403	}
1404	data_pos += offset;
1405
1406	/*
1407	 * The Info Block CRC is calculated over mxt_info and the object
1408	 * table. If it does not match then we are trying to load the
1409	 * configuration from a different chip or firmware version, so
1410	 * the configuration CRC is invalid anyway.
1411	 */
1412	if (info_crc == data->info_crc) {
1413		if (config_crc == 0 || data->config_crc == 0) {
1414			dev_info(dev, "CRC zero, attempting to apply config\n");
1415		} else if (config_crc == data->config_crc) {
1416			dev_dbg(dev, "Config CRC 0x%06X: OK\n",
1417				 data->config_crc);
1418			return 0;
 
1419		} else {
1420			dev_info(dev, "Config CRC 0x%06X: does not match file 0x%06X\n",
1421				 data->config_crc, config_crc);
1422		}
1423	} else {
1424		dev_warn(dev,
1425			 "Warning: Info CRC error - device=0x%06X file=0x%06X\n",
1426			 data->info_crc, info_crc);
1427	}
1428
1429	/* Malloc memory to store configuration */
1430	cfg_start_ofs = MXT_OBJECT_START +
1431			data->info.object_num * sizeof(struct mxt_object) +
1432			MXT_INFO_CHECKSUM_SIZE;
1433	config_mem_size = data->mem_size - cfg_start_ofs;
1434	config_mem = kzalloc(config_mem_size, GFP_KERNEL);
1435	if (!config_mem) {
1436		dev_err(dev, "Failed to allocate memory\n");
1437		return -ENOMEM;
1438	}
1439
1440	ret = mxt_prepare_cfg_mem(data, cfg, data_pos, cfg_start_ofs,
1441				  config_mem, config_mem_size);
1442	if (ret)
1443		goto release_mem;
1444
1445	/* Calculate crc of the received configs (not the raw config file) */
1446	if (data->T7_address < cfg_start_ofs) {
1447		dev_err(dev, "Bad T7 address, T7addr = %x, config offset %x\n",
1448			data->T7_address, cfg_start_ofs);
1449		ret = 0;
1450		goto release_mem;
1451	}
 
 
 
 
 
1452
1453	calculated_crc = mxt_calculate_crc(config_mem,
1454					   data->T7_address - cfg_start_ofs,
1455					   config_mem_size);
1456
1457	if (config_crc > 0 && config_crc != calculated_crc)
1458		dev_warn(dev, "Config CRC error, calculated=%06X, file=%06X\n",
1459			 calculated_crc, config_crc);
1460
1461	ret = mxt_upload_cfg_mem(data, cfg_start_ofs,
1462				 config_mem, config_mem_size);
1463	if (ret)
1464		goto release_mem;
1465
1466	mxt_update_crc(data, MXT_COMMAND_BACKUPNV, MXT_BACKUP_VALUE);
1467
1468	ret = mxt_soft_reset(data);
1469	if (ret)
1470		goto release_mem;
1471
1472	dev_info(dev, "Config successfully updated\n");
1473
1474	/* T7 config may have changed */
1475	mxt_init_t7_power_cfg(data);
1476
1477release_mem:
1478	kfree(config_mem);
 
 
1479	return ret;
1480}
1481
1482static int mxt_get_info(struct mxt_data *data)
1483{
1484	struct i2c_client *client = data->client;
1485	struct mxt_info *info = &data->info;
1486	int error;
1487
1488	/* Read 7-byte info block starting at address 0 */
1489	error = __mxt_read_reg(client, 0, sizeof(*info), info);
1490	if (error)
1491		return error;
1492
1493	return 0;
1494}
1495
1496static void mxt_free_input_device(struct mxt_data *data)
1497{
1498	if (data->input_dev) {
1499		input_unregister_device(data->input_dev);
1500		data->input_dev = NULL;
1501	}
1502}
1503
1504static void mxt_free_object_table(struct mxt_data *data)
1505{
1506	kfree(data->object_table);
 
 
 
1507	data->object_table = NULL;
 
 
 
1508	kfree(data->msg_buf);
1509	data->msg_buf = NULL;
1510	data->T5_address = 0;
1511	data->T5_msg_size = 0;
1512	data->T6_reportid = 0;
1513	data->T7_address = 0;
 
1514	data->T9_reportid_min = 0;
1515	data->T9_reportid_max = 0;
1516	data->T19_reportid = 0;
1517	data->T44_address = 0;
1518	data->T100_reportid_min = 0;
1519	data->T100_reportid_max = 0;
1520	data->max_reportid = 0;
1521}
1522
1523static int mxt_get_object_table(struct mxt_data *data)
 
1524{
1525	struct i2c_client *client = data->client;
1526	size_t table_size;
1527	struct mxt_object *object_table;
1528	int error;
1529	int i;
1530	u8 reportid;
1531	u16 end_address;
1532
1533	table_size = data->info.object_num * sizeof(struct mxt_object);
1534	object_table = kzalloc(table_size, GFP_KERNEL);
1535	if (!object_table) {
1536		dev_err(&data->client->dev, "Failed to allocate memory\n");
1537		return -ENOMEM;
1538	}
1539
1540	error = __mxt_read_reg(client, MXT_OBJECT_START, table_size,
1541			object_table);
1542	if (error) {
1543		kfree(object_table);
1544		return error;
1545	}
1546
1547	/* Valid Report IDs start counting from 1 */
1548	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			max_id = reportid - 1;
1561		} else {
1562			min_id = 0;
1563			max_id = 0;
1564		}
1565
1566		dev_dbg(&data->client->dev,
1567			"T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n",
1568			object->type, object->start_address,
1569			mxt_obj_size(object), mxt_obj_instances(object),
1570			min_id, max_id);
1571
1572		switch (object->type) {
1573		case MXT_GEN_MESSAGE_T5:
1574			if (data->info.family_id == 0x80 &&
1575			    data->info.version < 0x20) {
1576				/*
1577				 * On mXT224 firmware versions prior to V2.0
1578				 * read and discard unused CRC byte otherwise
1579				 * DMA reads are misaligned.
1580				 */
1581				data->T5_msg_size = mxt_obj_size(object);
1582			} else {
1583				/* CRC not enabled, so skip last byte */
1584				data->T5_msg_size = mxt_obj_size(object) - 1;
1585			}
1586			data->T5_address = object->start_address;
1587			break;
1588		case MXT_GEN_COMMAND_T6:
1589			data->T6_reportid = min_id;
1590			data->T6_address = object->start_address;
1591			break;
1592		case MXT_GEN_POWER_T7:
1593			data->T7_address = object->start_address;
1594			break;
 
 
 
1595		case MXT_TOUCH_MULTI_T9:
1596			data->multitouch = MXT_TOUCH_MULTI_T9;
 
1597			data->T9_reportid_min = min_id;
1598			data->T9_reportid_max = max_id;
1599			data->num_touchids = object->num_report_ids
1600						* mxt_obj_instances(object);
1601			break;
1602		case MXT_SPT_MESSAGECOUNT_T44:
1603			data->T44_address = object->start_address;
1604			break;
1605		case MXT_SPT_GPIOPWM_T19:
1606			data->T19_reportid = min_id;
1607			break;
1608		case MXT_TOUCH_MULTITOUCHSCREEN_T100:
1609			data->multitouch = MXT_TOUCH_MULTITOUCHSCREEN_T100;
1610			data->T100_reportid_min = min_id;
1611			data->T100_reportid_max = max_id;
1612			/* first two report IDs reserved */
1613			data->num_touchids = object->num_report_ids - 2;
1614			break;
1615		}
1616
1617		end_address = object->start_address
1618			+ mxt_obj_size(object) * mxt_obj_instances(object) - 1;
1619
1620		if (end_address >= data->mem_size)
1621			data->mem_size = end_address + 1;
1622	}
1623
1624	/* Store maximum reportid */
1625	data->max_reportid = reportid;
1626
1627	/* If T44 exists, T5 position has to be directly after */
1628	if (data->T44_address && (data->T5_address != data->T44_address + 1)) {
1629		dev_err(&client->dev, "Invalid T44 position\n");
1630		error = -EINVAL;
1631		goto free_object_table;
1632	}
1633
1634	data->msg_buf = kcalloc(data->max_reportid,
1635				data->T5_msg_size, GFP_KERNEL);
1636	if (!data->msg_buf) {
1637		dev_err(&client->dev, "Failed to allocate message buffer\n");
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1638		error = -ENOMEM;
1639		goto free_object_table;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1640	}
1641
1642	data->object_table = object_table;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1643
1644	return 0;
1645
1646free_object_table:
1647	mxt_free_object_table(data);
1648	return error;
1649}
1650
1651static int mxt_read_t9_resolution(struct mxt_data *data)
1652{
1653	struct i2c_client *client = data->client;
1654	int error;
1655	struct t9_range range;
1656	unsigned char orient;
1657	struct mxt_object *object;
1658
1659	object = mxt_get_object(data, MXT_TOUCH_MULTI_T9);
1660	if (!object)
1661		return -EINVAL;
1662
1663	error = __mxt_read_reg(client,
 
 
 
 
 
 
 
 
 
 
 
 
1664			       object->start_address + MXT_T9_RANGE,
1665			       sizeof(range), &range);
1666	if (error)
1667		return error;
1668
1669	data->max_x = get_unaligned_le16(&range.x);
1670	data->max_y = get_unaligned_le16(&range.y);
1671
1672	error =  __mxt_read_reg(client,
1673				object->start_address + MXT_T9_ORIENT,
1674				1, &orient);
1675	if (error)
1676		return error;
1677
1678	data->xy_switch = orient & MXT_T9_ORIENT_SWITCH;
 
 
1679
1680	return 0;
1681}
1682
1683static int mxt_read_t100_config(struct mxt_data *data)
1684{
1685	struct i2c_client *client = data->client;
1686	int error;
1687	struct mxt_object *object;
1688	u16 range_x, range_y;
1689	u8 cfg, tchaux;
1690	u8 aux;
1691
1692	object = mxt_get_object(data, MXT_TOUCH_MULTITOUCHSCREEN_T100);
1693	if (!object)
1694		return -EINVAL;
1695
1696	/* read touchscreen dimensions */
1697	error = __mxt_read_reg(client,
1698			       object->start_address + MXT_T100_XRANGE,
1699			       sizeof(range_x), &range_x);
1700	if (error)
1701		return error;
1702
1703	data->max_x = get_unaligned_le16(&range_x);
1704
1705	error = __mxt_read_reg(client,
1706			       object->start_address + MXT_T100_YRANGE,
1707			       sizeof(range_y), &range_y);
1708	if (error)
1709		return error;
1710
1711	data->max_y = get_unaligned_le16(&range_y);
1712
 
 
 
 
 
 
 
 
 
 
 
 
1713	/* read orientation config */
1714	error =  __mxt_read_reg(client,
1715				object->start_address + MXT_T100_CFG1,
1716				1, &cfg);
1717	if (error)
1718		return error;
1719
1720	data->xy_switch = cfg & MXT_T100_CFG_SWITCHXY;
 
 
1721
1722	/* allocate aux bytes */
1723	error =  __mxt_read_reg(client,
1724				object->start_address + MXT_T100_TCHAUX,
1725				1, &tchaux);
1726	if (error)
1727		return error;
1728
1729	aux = 6;
1730
1731	if (tchaux & MXT_T100_TCHAUX_VECT)
1732		data->t100_aux_vect = aux++;
1733
1734	if (tchaux & MXT_T100_TCHAUX_AMPL)
1735		data->t100_aux_ampl = aux++;
1736
1737	if (tchaux & MXT_T100_TCHAUX_AREA)
1738		data->t100_aux_area = aux++;
1739
1740	dev_dbg(&client->dev,
1741		"T100 aux mappings vect:%u ampl:%u area:%u\n",
1742		data->t100_aux_vect, data->t100_aux_ampl, data->t100_aux_area);
1743
1744	return 0;
1745}
1746
1747static int mxt_input_open(struct input_dev *dev);
1748static void mxt_input_close(struct input_dev *dev);
1749
1750static void mxt_set_up_as_touchpad(struct input_dev *input_dev,
1751				   struct mxt_data *data)
1752{
1753	const struct mxt_platform_data *pdata = data->pdata;
1754	int i;
1755
1756	input_dev->name = "Atmel maXTouch Touchpad";
1757
1758	__set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
1759
1760	input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM);
1761	input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM);
1762	input_abs_set_res(input_dev, ABS_MT_POSITION_X,
1763			  MXT_PIXELS_PER_MM);
1764	input_abs_set_res(input_dev, ABS_MT_POSITION_Y,
1765			  MXT_PIXELS_PER_MM);
1766
1767	for (i = 0; i < pdata->t19_num_keys; i++)
1768		if (pdata->t19_keymap[i] != KEY_RESERVED)
1769			input_set_capability(input_dev, EV_KEY,
1770					     pdata->t19_keymap[i]);
1771}
1772
1773static int mxt_initialize_input_device(struct mxt_data *data)
1774{
1775	const struct mxt_platform_data *pdata = data->pdata;
1776	struct device *dev = &data->client->dev;
1777	struct input_dev *input_dev;
1778	int error;
1779	unsigned int num_mt_slots;
1780	unsigned int mt_flags = 0;
1781
1782	switch (data->multitouch) {
1783	case MXT_TOUCH_MULTI_T9:
1784		num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
1785		error = mxt_read_t9_resolution(data);
1786		if (error)
1787			dev_warn(dev, "Failed to initialize T9 resolution\n");
1788		break;
1789
1790	case MXT_TOUCH_MULTITOUCHSCREEN_T100:
1791		num_mt_slots = data->num_touchids;
1792		error = mxt_read_t100_config(data);
1793		if (error)
1794			dev_warn(dev, "Failed to read T100 config\n");
1795		break;
1796
1797	default:
1798		dev_err(dev, "Invalid multitouch object\n");
1799		return -EINVAL;
1800	}
1801
1802	/* Handle default values and orientation switch */
1803	if (data->max_x == 0)
1804		data->max_x = 1023;
1805
1806	if (data->max_y == 0)
1807		data->max_y = 1023;
1808
1809	if (data->xy_switch)
1810		swap(data->max_x, data->max_y);
1811
1812	dev_info(dev, "Touchscreen size X%uY%u\n", data->max_x, data->max_y);
1813
1814	/* Register input device */
1815	input_dev = input_allocate_device();
1816	if (!input_dev) {
1817		dev_err(dev, "Failed to allocate memory\n");
1818		return -ENOMEM;
1819	}
1820
1821	input_dev->name = "Atmel maXTouch Touchscreen";
1822	input_dev->phys = data->phys;
1823	input_dev->id.bustype = BUS_I2C;
1824	input_dev->dev.parent = dev;
1825	input_dev->open = mxt_input_open;
1826	input_dev->close = mxt_input_close;
1827
1828	input_set_capability(input_dev, EV_KEY, BTN_TOUCH);
1829
1830	/* For single touch */
1831	input_set_abs_params(input_dev, ABS_X, 0, data->max_x, 0, 0);
1832	input_set_abs_params(input_dev, ABS_Y, 0, data->max_y, 0, 0);
1833
1834	if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
1835	    (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1836	     data->t100_aux_ampl)) {
1837		input_set_abs_params(input_dev, ABS_PRESSURE, 0, 255, 0, 0);
1838	}
1839
1840	/* If device has buttons we assume it is a touchpad */
1841	if (pdata->t19_num_keys) {
1842		mxt_set_up_as_touchpad(input_dev, data);
1843		mt_flags |= INPUT_MT_POINTER;
1844	} else {
1845		mt_flags |= INPUT_MT_DIRECT;
1846	}
1847
1848	/* For multi touch */
1849	error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags);
1850	if (error) {
1851		dev_err(dev, "Error %d initialising slots\n", error);
1852		goto err_free_mem;
1853	}
1854
1855	if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100) {
1856		input_set_abs_params(input_dev, ABS_MT_TOOL_TYPE,
1857				     0, MT_TOOL_MAX, 0, 0);
1858		input_set_abs_params(input_dev, ABS_MT_DISTANCE,
1859				     MXT_DISTANCE_ACTIVE_TOUCH,
1860				     MXT_DISTANCE_HOVERING,
1861				     0, 0);
1862	}
1863
1864	input_set_abs_params(input_dev, ABS_MT_POSITION_X,
1865			     0, data->max_x, 0, 0);
1866	input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
1867			     0, data->max_y, 0, 0);
1868
1869	if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
1870	    (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1871	     data->t100_aux_area)) {
1872		input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
1873				     0, MXT_MAX_AREA, 0, 0);
1874	}
1875
1876	if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
1877	    (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1878	     data->t100_aux_ampl)) {
1879		input_set_abs_params(input_dev, ABS_MT_PRESSURE,
1880				     0, 255, 0, 0);
1881	}
1882
1883	if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1884	    data->t100_aux_vect) {
1885		input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
1886				     0, 255, 0, 0);
1887	}
1888
1889	if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1890	    data->t100_aux_ampl) {
1891		input_set_abs_params(input_dev, ABS_MT_PRESSURE,
1892				     0, 255, 0, 0);
1893	}
1894
1895	if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1896	    data->t100_aux_vect) {
1897		input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
1898				     0, 255, 0, 0);
1899	}
1900
1901	input_set_drvdata(input_dev, data);
1902
1903	error = input_register_device(input_dev);
1904	if (error) {
1905		dev_err(dev, "Error %d registering input device\n", error);
1906		goto err_free_mem;
1907	}
1908
1909	data->input_dev = input_dev;
1910
1911	return 0;
1912
1913err_free_mem:
1914	input_free_device(input_dev);
1915	return error;
1916}
1917
1918static int mxt_configure_objects(struct mxt_data *data,
1919				 const struct firmware *cfg);
1920
1921static void mxt_config_cb(const struct firmware *cfg, void *ctx)
1922{
1923	mxt_configure_objects(ctx, cfg);
1924	release_firmware(cfg);
1925}
1926
1927static int mxt_initialize(struct mxt_data *data)
1928{
1929	struct i2c_client *client = data->client;
1930	int recovery_attempts = 0;
1931	int error;
1932
1933	while (1) {
1934		error = mxt_get_info(data);
1935		if (!error)
1936			break;
1937
1938		/* Check bootloader state */
1939		error = mxt_probe_bootloader(data, false);
1940		if (error) {
1941			dev_info(&client->dev, "Trying alternate bootloader address\n");
1942			error = mxt_probe_bootloader(data, true);
1943			if (error) {
1944				/* Chip is not in appmode or bootloader mode */
1945				return error;
1946			}
1947		}
1948
1949		/* OK, we are in bootloader, see if we can recover */
1950		if (++recovery_attempts > 1) {
1951			dev_err(&client->dev, "Could not recover from bootloader mode\n");
1952			/*
1953			 * We can reflash from this state, so do not
1954			 * abort initialization.
1955			 */
1956			data->in_bootloader = true;
1957			return 0;
1958		}
1959
1960		/* Attempt to exit bootloader into app mode */
1961		mxt_send_bootloader_cmd(data, false);
1962		msleep(MXT_FW_RESET_TIME);
1963	}
1964
1965	/* Get object table information */
1966	error = mxt_get_object_table(data);
1967	if (error) {
1968		dev_err(&client->dev, "Error %d reading object table\n", error);
1969		return error;
1970	}
1971
1972	error = mxt_acquire_irq(data);
1973	if (error)
1974		goto err_free_object_table;
1975
1976	error = request_firmware_nowait(THIS_MODULE, true, MXT_CFG_NAME,
1977					&client->dev, GFP_KERNEL, data,
1978					mxt_config_cb);
1979	if (error) {
1980		dev_err(&client->dev, "Failed to invoke firmware loader: %d\n",
1981			error);
1982		goto err_free_object_table;
1983	}
1984
1985	return 0;
1986
1987err_free_object_table:
1988	mxt_free_object_table(data);
1989	return error;
1990}
1991
1992static int mxt_set_t7_power_cfg(struct mxt_data *data, u8 sleep)
1993{
1994	struct device *dev = &data->client->dev;
1995	int error;
1996	struct t7_config *new_config;
1997	struct t7_config deepsleep = { .active = 0, .idle = 0 };
1998
1999	if (sleep == MXT_POWER_CFG_DEEPSLEEP)
2000		new_config = &deepsleep;
2001	else
2002		new_config = &data->t7_cfg;
2003
2004	error = __mxt_write_reg(data->client, data->T7_address,
2005				sizeof(data->t7_cfg), new_config);
2006	if (error)
2007		return error;
2008
2009	dev_dbg(dev, "Set T7 ACTV:%d IDLE:%d\n",
2010		new_config->active, new_config->idle);
2011
2012	return 0;
2013}
2014
2015static int mxt_init_t7_power_cfg(struct mxt_data *data)
2016{
2017	struct device *dev = &data->client->dev;
2018	int error;
2019	bool retry = false;
2020
2021recheck:
2022	error = __mxt_read_reg(data->client, data->T7_address,
2023				sizeof(data->t7_cfg), &data->t7_cfg);
2024	if (error)
2025		return error;
2026
2027	if (data->t7_cfg.active == 0 || data->t7_cfg.idle == 0) {
2028		if (!retry) {
2029			dev_dbg(dev, "T7 cfg zero, resetting\n");
2030			mxt_soft_reset(data);
2031			retry = true;
2032			goto recheck;
2033		} else {
2034			dev_dbg(dev, "T7 cfg zero after reset, overriding\n");
2035			data->t7_cfg.active = 20;
2036			data->t7_cfg.idle = 100;
2037			return mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
2038		}
2039	}
2040
2041	dev_dbg(dev, "Initialized power cfg: ACTV %d, IDLE %d\n",
2042		data->t7_cfg.active, data->t7_cfg.idle);
2043	return 0;
2044}
2045
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2046static int mxt_configure_objects(struct mxt_data *data,
2047				 const struct firmware *cfg)
2048{
2049	struct device *dev = &data->client->dev;
2050	struct mxt_info *info = &data->info;
2051	int error;
2052
2053	error = mxt_init_t7_power_cfg(data);
2054	if (error) {
2055		dev_err(dev, "Failed to initialize power cfg\n");
2056		return error;
2057	}
2058
2059	if (cfg) {
2060		error = mxt_update_cfg(data, cfg);
2061		if (error)
2062			dev_warn(dev, "Error %d updating config\n", error);
2063	}
2064
2065	if (data->multitouch) {
2066		error = mxt_initialize_input_device(data);
2067		if (error)
2068			return error;
2069	} else {
2070		dev_warn(dev, "No touch object detected\n");
2071	}
2072
2073	dev_info(dev,
2074		 "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n",
2075		 info->family_id, info->variant_id, info->version >> 4,
2076		 info->version & 0xf, info->build, info->object_num);
2077
2078	return 0;
2079}
2080
2081/* Firmware Version is returned as Major.Minor.Build */
2082static ssize_t mxt_fw_version_show(struct device *dev,
2083				   struct device_attribute *attr, char *buf)
2084{
2085	struct mxt_data *data = dev_get_drvdata(dev);
2086	struct mxt_info *info = &data->info;
2087	return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
2088			 info->version >> 4, info->version & 0xf, info->build);
2089}
2090
2091/* Hardware Version is returned as FamilyID.VariantID */
2092static ssize_t mxt_hw_version_show(struct device *dev,
2093				   struct device_attribute *attr, char *buf)
2094{
2095	struct mxt_data *data = dev_get_drvdata(dev);
2096	struct mxt_info *info = &data->info;
2097	return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
2098			 info->family_id, info->variant_id);
2099}
2100
2101static ssize_t mxt_show_instance(char *buf, int count,
2102				 struct mxt_object *object, int instance,
2103				 const u8 *val)
2104{
2105	int i;
2106
2107	if (mxt_obj_instances(object) > 1)
2108		count += scnprintf(buf + count, PAGE_SIZE - count,
2109				   "Instance %u\n", instance);
2110
2111	for (i = 0; i < mxt_obj_size(object); i++)
2112		count += scnprintf(buf + count, PAGE_SIZE - count,
2113				"\t[%2u]: %02x (%d)\n", i, val[i], val[i]);
2114	count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
2115
2116	return count;
2117}
2118
2119static ssize_t mxt_object_show(struct device *dev,
2120				    struct device_attribute *attr, char *buf)
2121{
2122	struct mxt_data *data = dev_get_drvdata(dev);
2123	struct mxt_object *object;
2124	int count = 0;
2125	int i, j;
2126	int error;
2127	u8 *obuf;
2128
2129	/* Pre-allocate buffer large enough to hold max sized object. */
2130	obuf = kmalloc(256, GFP_KERNEL);
2131	if (!obuf)
2132		return -ENOMEM;
2133
2134	error = 0;
2135	for (i = 0; i < data->info.object_num; i++) {
2136		object = data->object_table + i;
2137
2138		if (!mxt_object_readable(object->type))
2139			continue;
2140
2141		count += scnprintf(buf + count, PAGE_SIZE - count,
2142				"T%u:\n", object->type);
2143
2144		for (j = 0; j < mxt_obj_instances(object); j++) {
2145			u16 size = mxt_obj_size(object);
2146			u16 addr = object->start_address + j * size;
2147
2148			error = __mxt_read_reg(data->client, addr, size, obuf);
2149			if (error)
2150				goto done;
2151
2152			count = mxt_show_instance(buf, count, object, j, obuf);
2153		}
2154	}
2155
2156done:
2157	kfree(obuf);
2158	return error ?: count;
2159}
2160
2161static int mxt_check_firmware_format(struct device *dev,
2162				     const struct firmware *fw)
2163{
2164	unsigned int pos = 0;
2165	char c;
2166
2167	while (pos < fw->size) {
2168		c = *(fw->data + pos);
2169
2170		if (c < '0' || (c > '9' && c < 'A') || c > 'F')
2171			return 0;
2172
2173		pos++;
2174	}
2175
2176	/*
2177	 * To convert file try:
2178	 * xxd -r -p mXTXXX__APP_VX-X-XX.enc > maxtouch.fw
2179	 */
2180	dev_err(dev, "Aborting: firmware file must be in binary format\n");
2181
2182	return -EINVAL;
2183}
2184
2185static int mxt_load_fw(struct device *dev, const char *fn)
2186{
2187	struct mxt_data *data = dev_get_drvdata(dev);
2188	const struct firmware *fw = NULL;
2189	unsigned int frame_size;
2190	unsigned int pos = 0;
2191	unsigned int retry = 0;
2192	unsigned int frame = 0;
2193	int ret;
2194
2195	ret = request_firmware(&fw, fn, dev);
2196	if (ret) {
2197		dev_err(dev, "Unable to open firmware %s\n", fn);
2198		return ret;
2199	}
2200
2201	/* Check for incorrect enc file */
2202	ret = mxt_check_firmware_format(dev, fw);
2203	if (ret)
2204		goto release_firmware;
2205
2206	if (!data->in_bootloader) {
2207		/* Change to the bootloader mode */
2208		data->in_bootloader = true;
2209
2210		ret = mxt_t6_command(data, MXT_COMMAND_RESET,
2211				     MXT_BOOT_VALUE, false);
2212		if (ret)
2213			goto release_firmware;
2214
2215		msleep(MXT_RESET_TIME);
2216
2217		/* Do not need to scan since we know family ID */
2218		ret = mxt_lookup_bootloader_address(data, 0);
2219		if (ret)
2220			goto release_firmware;
2221
2222		mxt_free_input_device(data);
2223		mxt_free_object_table(data);
2224	} else {
2225		enable_irq(data->irq);
2226	}
2227
2228	reinit_completion(&data->bl_completion);
2229
2230	ret = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD, false);
2231	if (ret) {
2232		/* Bootloader may still be unlocked from previous attempt */
2233		ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, false);
2234		if (ret)
2235			goto disable_irq;
2236	} else {
2237		dev_info(dev, "Unlocking bootloader\n");
2238
2239		/* Unlock bootloader */
2240		ret = mxt_send_bootloader_cmd(data, true);
2241		if (ret)
2242			goto disable_irq;
2243	}
2244
2245	while (pos < fw->size) {
2246		ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, true);
2247		if (ret)
2248			goto disable_irq;
2249
2250		frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
2251
2252		/* Take account of CRC bytes */
2253		frame_size += 2;
2254
2255		/* Write one frame to device */
2256		ret = mxt_bootloader_write(data, fw->data + pos, frame_size);
2257		if (ret)
2258			goto disable_irq;
2259
2260		ret = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS, true);
2261		if (ret) {
2262			retry++;
2263
2264			/* Back off by 20ms per retry */
2265			msleep(retry * 20);
2266
2267			if (retry > 20) {
2268				dev_err(dev, "Retry count exceeded\n");
2269				goto disable_irq;
2270			}
2271		} else {
2272			retry = 0;
2273			pos += frame_size;
2274			frame++;
2275		}
2276
2277		if (frame % 50 == 0)
2278			dev_dbg(dev, "Sent %d frames, %d/%zd bytes\n",
2279				frame, pos, fw->size);
2280	}
2281
2282	/* Wait for flash. */
2283	ret = mxt_wait_for_completion(data, &data->bl_completion,
2284				      MXT_FW_RESET_TIME);
2285	if (ret)
2286		goto disable_irq;
2287
2288	dev_dbg(dev, "Sent %d frames, %d bytes\n", frame, pos);
2289
2290	/*
2291	 * Wait for device to reset. Some bootloader versions do not assert
2292	 * the CHG line after bootloading has finished, so ignore potential
2293	 * errors.
2294	 */
2295	mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME);
2296
2297	data->in_bootloader = false;
2298
2299disable_irq:
2300	disable_irq(data->irq);
2301release_firmware:
2302	release_firmware(fw);
2303	return ret;
2304}
2305
2306static ssize_t mxt_update_fw_store(struct device *dev,
2307					struct device_attribute *attr,
2308					const char *buf, size_t count)
2309{
2310	struct mxt_data *data = dev_get_drvdata(dev);
2311	int error;
2312
2313	error = mxt_load_fw(dev, MXT_FW_NAME);
2314	if (error) {
2315		dev_err(dev, "The firmware update failed(%d)\n", error);
2316		count = error;
2317	} else {
2318		dev_info(dev, "The firmware update succeeded\n");
2319
2320		error = mxt_initialize(data);
2321		if (error)
2322			return error;
2323	}
2324
2325	return count;
2326}
2327
2328static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
2329static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
2330static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
2331static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
2332
2333static struct attribute *mxt_attrs[] = {
2334	&dev_attr_fw_version.attr,
2335	&dev_attr_hw_version.attr,
2336	&dev_attr_object.attr,
2337	&dev_attr_update_fw.attr,
2338	NULL
2339};
2340
2341static const struct attribute_group mxt_attr_group = {
2342	.attrs = mxt_attrs,
2343};
2344
2345static void mxt_start(struct mxt_data *data)
2346{
2347	switch (data->pdata->suspend_mode) {
2348	case MXT_SUSPEND_T9_CTRL:
2349		mxt_soft_reset(data);
2350
2351		/* Touch enable */
2352		/* 0x83 = SCANEN | RPTEN | ENABLE */
2353		mxt_write_object(data,
2354				MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0x83);
2355		break;
2356
2357	case MXT_SUSPEND_DEEP_SLEEP:
2358	default:
2359		mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
2360
2361		/* Recalibrate since chip has been in deep sleep */
2362		mxt_t6_command(data, MXT_COMMAND_CALIBRATE, 1, false);
2363		break;
2364	}
2365
2366}
2367
2368static void mxt_stop(struct mxt_data *data)
2369{
2370	switch (data->pdata->suspend_mode) {
2371	case MXT_SUSPEND_T9_CTRL:
2372		/* Touch disable */
2373		mxt_write_object(data,
2374				MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0);
2375		break;
2376
2377	case MXT_SUSPEND_DEEP_SLEEP:
2378	default:
2379		mxt_set_t7_power_cfg(data, MXT_POWER_CFG_DEEPSLEEP);
2380		break;
2381	}
2382}
2383
2384static int mxt_input_open(struct input_dev *dev)
2385{
2386	struct mxt_data *data = input_get_drvdata(dev);
2387
2388	mxt_start(data);
2389
2390	return 0;
2391}
2392
2393static void mxt_input_close(struct input_dev *dev)
2394{
2395	struct mxt_data *data = input_get_drvdata(dev);
2396
2397	mxt_stop(data);
2398}
2399
2400#ifdef CONFIG_OF
2401static const struct mxt_platform_data *mxt_parse_dt(struct i2c_client *client)
2402{
2403	struct mxt_platform_data *pdata;
2404	struct device_node *np = client->dev.of_node;
2405	u32 *keymap;
2406	int proplen, ret;
2407
2408	if (!np)
2409		return ERR_PTR(-ENOENT);
2410
2411	pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL);
2412	if (!pdata)
2413		return ERR_PTR(-ENOMEM);
2414
2415	if (of_find_property(np, "linux,gpio-keymap", &proplen)) {
2416		pdata->t19_num_keys = proplen / sizeof(u32);
 
 
 
 
 
 
2417
2418		keymap = devm_kzalloc(&client->dev,
2419				pdata->t19_num_keys * sizeof(keymap[0]),
2420				GFP_KERNEL);
2421		if (!keymap)
2422			return ERR_PTR(-ENOMEM);
2423
2424		ret = of_property_read_u32_array(np, "linux,gpio-keymap",
2425						 keymap, pdata->t19_num_keys);
2426		if (ret)
2427			dev_warn(&client->dev,
2428				 "Couldn't read linux,gpio-keymap: %d\n", ret);
 
 
2429
2430		pdata->t19_keymap = keymap;
 
2431	}
2432
2433	pdata->suspend_mode = MXT_SUSPEND_DEEP_SLEEP;
2434
2435	return pdata;
2436}
2437#else
2438static const struct mxt_platform_data *mxt_parse_dt(struct i2c_client *client)
2439{
2440	return ERR_PTR(-ENOENT);
2441}
2442#endif
2443
2444#ifdef CONFIG_ACPI
2445
2446struct mxt_acpi_platform_data {
2447	const char *hid;
2448	struct mxt_platform_data pdata;
2449};
2450
2451static unsigned int samus_touchpad_buttons[] = {
2452	KEY_RESERVED,
2453	KEY_RESERVED,
2454	KEY_RESERVED,
2455	BTN_LEFT
2456};
2457
2458static struct mxt_acpi_platform_data samus_platform_data[] = {
2459	{
2460		/* Touchpad */
2461		.hid	= "ATML0000",
2462		.pdata	= {
2463			.t19_num_keys	= ARRAY_SIZE(samus_touchpad_buttons),
2464			.t19_keymap	= samus_touchpad_buttons,
2465		},
2466	},
2467	{
2468		/* Touchscreen */
2469		.hid	= "ATML0001",
2470	},
2471	{ }
2472};
2473
2474static unsigned int chromebook_tp_buttons[] = {
2475	KEY_RESERVED,
2476	KEY_RESERVED,
2477	KEY_RESERVED,
2478	KEY_RESERVED,
2479	KEY_RESERVED,
2480	BTN_LEFT
2481};
2482
2483static struct mxt_acpi_platform_data chromebook_platform_data[] = {
2484	{
2485		/* Touchpad */
2486		.hid	= "ATML0000",
2487		.pdata	= {
2488			.t19_num_keys	= ARRAY_SIZE(chromebook_tp_buttons),
2489			.t19_keymap	= chromebook_tp_buttons,
2490		},
2491	},
2492	{
2493		/* Touchscreen */
2494		.hid	= "ATML0001",
2495	},
2496	{ }
2497};
2498
2499static const struct dmi_system_id mxt_dmi_table[] = {
2500	{
2501		/* 2015 Google Pixel */
2502		.ident = "Chromebook Pixel 2",
2503		.matches = {
2504			DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
2505			DMI_MATCH(DMI_PRODUCT_NAME, "Samus"),
2506		},
2507		.driver_data = samus_platform_data,
2508	},
2509	{
2510		/* Other Google Chromebooks */
2511		.ident = "Chromebook",
2512		.matches = {
2513			DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
2514		},
2515		.driver_data = chromebook_platform_data,
2516	},
2517	{ }
2518};
2519
2520static const struct mxt_platform_data *mxt_parse_acpi(struct i2c_client *client)
2521{
2522	struct acpi_device *adev;
2523	const struct dmi_system_id *system_id;
2524	const struct mxt_acpi_platform_data *acpi_pdata;
 
 
 
 
 
 
 
 
 
 
 
2525
2526	/*
2527	 * Ignore ACPI devices representing bootloader mode.
2528	 *
2529	 * This is a bit of a hack: Google Chromebook BIOS creates ACPI
2530	 * devices for both application and bootloader modes, but we are
2531	 * interested in application mode only (if device is in bootloader
2532	 * mode we'll end up switching into application anyway). So far
2533	 * application mode addresses were all above 0x40, so we'll use it
2534	 * as a threshold.
2535	 */
2536	if (client->addr < 0x40)
2537		return ERR_PTR(-ENXIO);
2538
2539	adev = ACPI_COMPANION(&client->dev);
2540	if (!adev)
2541		return ERR_PTR(-ENOENT);
2542
2543	system_id = dmi_first_match(mxt_dmi_table);
2544	if (!system_id)
2545		return ERR_PTR(-ENOENT);
2546
2547	acpi_pdata = system_id->driver_data;
2548	if (!acpi_pdata)
2549		return ERR_PTR(-ENOENT);
2550
2551	while (acpi_pdata->hid) {
2552		if (!strcmp(acpi_device_hid(adev), acpi_pdata->hid))
2553			return &acpi_pdata->pdata;
2554
2555		acpi_pdata++;
2556	}
2557
2558	return ERR_PTR(-ENOENT);
2559}
2560#else
2561static const struct mxt_platform_data *mxt_parse_acpi(struct i2c_client *client)
2562{
2563	return ERR_PTR(-ENOENT);
2564}
2565#endif
2566
2567static const struct mxt_platform_data *
2568mxt_get_platform_data(struct i2c_client *client)
2569{
2570	const struct mxt_platform_data *pdata;
2571
2572	pdata = dev_get_platdata(&client->dev);
2573	if (pdata)
2574		return pdata;
2575
2576	pdata = mxt_parse_dt(client);
2577	if (!IS_ERR(pdata) || PTR_ERR(pdata) != -ENOENT)
2578		return pdata;
2579
2580	pdata = mxt_parse_acpi(client);
2581	if (!IS_ERR(pdata) || PTR_ERR(pdata) != -ENOENT)
2582		return pdata;
2583
2584	dev_err(&client->dev, "No platform data specified\n");
2585	return ERR_PTR(-EINVAL);
2586}
2587
2588static int mxt_probe(struct i2c_client *client, const struct i2c_device_id *id)
2589{
2590	struct mxt_data *data;
2591	const struct mxt_platform_data *pdata;
2592	int error;
2593
2594	pdata = mxt_get_platform_data(client);
2595	if (IS_ERR(pdata))
2596		return PTR_ERR(pdata);
2597
2598	data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL);
2599	if (!data) {
2600		dev_err(&client->dev, "Failed to allocate memory\n");
2601		return -ENOMEM;
2602	}
2603
2604	snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
2605		 client->adapter->nr, client->addr);
2606
2607	data->client = client;
2608	data->pdata = pdata;
2609	data->irq = client->irq;
2610	i2c_set_clientdata(client, data);
2611
2612	init_completion(&data->bl_completion);
2613	init_completion(&data->reset_completion);
2614	init_completion(&data->crc_completion);
2615
2616	error = request_threaded_irq(client->irq, NULL, mxt_interrupt,
2617				     pdata->irqflags | IRQF_ONESHOT,
2618				     client->name, data);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2619	if (error) {
2620		dev_err(&client->dev, "Failed to register interrupt\n");
2621		goto err_free_mem;
2622	}
2623
2624	disable_irq(client->irq);
2625
 
 
 
 
 
 
2626	error = mxt_initialize(data);
2627	if (error)
2628		goto err_free_irq;
2629
2630	error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
2631	if (error) {
2632		dev_err(&client->dev, "Failure %d creating sysfs group\n",
2633			error);
2634		goto err_free_object;
2635	}
2636
2637	return 0;
2638
2639err_free_object:
2640	mxt_free_input_device(data);
2641	mxt_free_object_table(data);
2642err_free_irq:
2643	free_irq(client->irq, data);
2644err_free_mem:
2645	kfree(data);
2646	return error;
2647}
2648
2649static int mxt_remove(struct i2c_client *client)
2650{
2651	struct mxt_data *data = i2c_get_clientdata(client);
2652
 
2653	sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
2654	free_irq(data->irq, data);
2655	mxt_free_input_device(data);
2656	mxt_free_object_table(data);
2657	kfree(data);
2658
2659	return 0;
2660}
2661
2662static int __maybe_unused mxt_suspend(struct device *dev)
2663{
2664	struct i2c_client *client = to_i2c_client(dev);
2665	struct mxt_data *data = i2c_get_clientdata(client);
2666	struct input_dev *input_dev = data->input_dev;
2667
2668	if (!input_dev)
2669		return 0;
2670
2671	mutex_lock(&input_dev->mutex);
2672
2673	if (input_dev->users)
2674		mxt_stop(data);
2675
2676	mutex_unlock(&input_dev->mutex);
2677
2678	return 0;
2679}
2680
2681static int __maybe_unused mxt_resume(struct device *dev)
2682{
2683	struct i2c_client *client = to_i2c_client(dev);
2684	struct mxt_data *data = i2c_get_clientdata(client);
2685	struct input_dev *input_dev = data->input_dev;
2686
2687	if (!input_dev)
2688		return 0;
2689
2690	mutex_lock(&input_dev->mutex);
2691
2692	if (input_dev->users)
2693		mxt_start(data);
2694
2695	mutex_unlock(&input_dev->mutex);
2696
2697	return 0;
2698}
2699
2700static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);
2701
2702static const struct of_device_id mxt_of_match[] = {
2703	{ .compatible = "atmel,maxtouch", },
 
 
 
 
 
2704	{},
2705};
2706MODULE_DEVICE_TABLE(of, mxt_of_match);
2707
2708#ifdef CONFIG_ACPI
2709static const struct acpi_device_id mxt_acpi_id[] = {
2710	{ "ATML0000", 0 },	/* Touchpad */
2711	{ "ATML0001", 0 },	/* Touchscreen */
2712	{ }
2713};
2714MODULE_DEVICE_TABLE(acpi, mxt_acpi_id);
2715#endif
2716
2717static const struct i2c_device_id mxt_id[] = {
2718	{ "qt602240_ts", 0 },
2719	{ "atmel_mxt_ts", 0 },
2720	{ "atmel_mxt_tp", 0 },
2721	{ "maxtouch", 0 },
2722	{ "mXT224", 0 },
2723	{ }
2724};
2725MODULE_DEVICE_TABLE(i2c, mxt_id);
2726
2727static struct i2c_driver mxt_driver = {
2728	.driver = {
2729		.name	= "atmel_mxt_ts",
2730		.of_match_table = of_match_ptr(mxt_of_match),
2731		.acpi_match_table = ACPI_PTR(mxt_acpi_id),
2732		.pm	= &mxt_pm_ops,
2733	},
2734	.probe		= mxt_probe,
2735	.remove		= mxt_remove,
2736	.id_table	= mxt_id,
2737};
2738
2739module_i2c_driver(mxt_driver);
2740
2741/* Module information */
2742MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
2743MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
2744MODULE_LICENSE("GPL");
v5.4
   1// SPDX-License-Identifier: GPL-2.0-or-later
   2/*
   3 * Atmel maXTouch Touchscreen driver
   4 *
   5 * Copyright (C) 2010 Samsung Electronics Co.Ltd
   6 * Copyright (C) 2011-2014 Atmel Corporation
   7 * Copyright (C) 2012 Google, Inc.
   8 * Copyright (C) 2016 Zodiac Inflight Innovations
   9 *
  10 * Author: Joonyoung Shim <jy0922.shim@samsung.com>
 
 
 
 
 
 
  11 */
  12
  13#include <linux/acpi.h>
  14#include <linux/dmi.h>
  15#include <linux/module.h>
  16#include <linux/init.h>
  17#include <linux/completion.h>
  18#include <linux/delay.h>
  19#include <linux/firmware.h>
  20#include <linux/i2c.h>
 
  21#include <linux/input/mt.h>
  22#include <linux/interrupt.h>
  23#include <linux/of.h>
  24#include <linux/property.h>
  25#include <linux/slab.h>
  26#include <linux/gpio/consumer.h>
  27#include <asm/unaligned.h>
  28#include <media/v4l2-device.h>
  29#include <media/v4l2-ioctl.h>
  30#include <media/videobuf2-v4l2.h>
  31#include <media/videobuf2-vmalloc.h>
  32
  33/* Firmware files */
  34#define MXT_FW_NAME		"maxtouch.fw"
  35#define MXT_CFG_NAME		"maxtouch.cfg"
  36#define MXT_CFG_MAGIC		"OBP_RAW V1"
  37
  38/* Registers */
  39#define MXT_OBJECT_START	0x07
  40#define MXT_OBJECT_SIZE		6
  41#define MXT_INFO_CHECKSUM_SIZE	3
  42#define MXT_MAX_BLOCK_WRITE	256
  43
  44/* Object types */
  45#define MXT_DEBUG_DIAGNOSTIC_T37	37
  46#define MXT_GEN_MESSAGE_T5		5
  47#define MXT_GEN_COMMAND_T6		6
  48#define MXT_GEN_POWER_T7		7
  49#define MXT_GEN_ACQUIRE_T8		8
  50#define MXT_GEN_DATASOURCE_T53		53
  51#define MXT_TOUCH_MULTI_T9		9
  52#define MXT_TOUCH_KEYARRAY_T15		15
  53#define MXT_TOUCH_PROXIMITY_T23		23
  54#define MXT_TOUCH_PROXKEY_T52		52
  55#define MXT_PROCI_GRIPFACE_T20		20
  56#define MXT_PROCG_NOISE_T22		22
  57#define MXT_PROCI_ONETOUCH_T24		24
  58#define MXT_PROCI_TWOTOUCH_T27		27
  59#define MXT_PROCI_GRIP_T40		40
  60#define MXT_PROCI_PALM_T41		41
  61#define MXT_PROCI_TOUCHSUPPRESSION_T42	42
  62#define MXT_PROCI_STYLUS_T47		47
  63#define MXT_PROCG_NOISESUPPRESSION_T48	48
  64#define MXT_SPT_COMMSCONFIG_T18		18
  65#define MXT_SPT_GPIOPWM_T19		19
  66#define MXT_SPT_SELFTEST_T25		25
  67#define MXT_SPT_CTECONFIG_T28		28
  68#define MXT_SPT_USERDATA_T38		38
  69#define MXT_SPT_DIGITIZER_T43		43
  70#define MXT_SPT_MESSAGECOUNT_T44	44
  71#define MXT_SPT_CTECONFIG_T46		46
  72#define MXT_SPT_DYNAMICCONFIGURATIONCONTAINER_T71 71
  73#define MXT_TOUCH_MULTITOUCHSCREEN_T100 100
  74
  75/* MXT_GEN_MESSAGE_T5 object */
  76#define MXT_RPTID_NOMSG		0xff
  77
  78/* MXT_GEN_COMMAND_T6 field */
  79#define MXT_COMMAND_RESET	0
  80#define MXT_COMMAND_BACKUPNV	1
  81#define MXT_COMMAND_CALIBRATE	2
  82#define MXT_COMMAND_REPORTALL	3
  83#define MXT_COMMAND_DIAGNOSTIC	5
  84
  85/* Define for T6 status byte */
  86#define MXT_T6_STATUS_RESET	BIT(7)
  87#define MXT_T6_STATUS_OFL	BIT(6)
  88#define MXT_T6_STATUS_SIGERR	BIT(5)
  89#define MXT_T6_STATUS_CAL	BIT(4)
  90#define MXT_T6_STATUS_CFGERR	BIT(3)
  91#define MXT_T6_STATUS_COMSERR	BIT(2)
  92
  93/* MXT_GEN_POWER_T7 field */
  94struct t7_config {
  95	u8 idle;
  96	u8 active;
  97} __packed;
  98
  99#define MXT_POWER_CFG_RUN		0
 100#define MXT_POWER_CFG_DEEPSLEEP		1
 101
 102/* MXT_TOUCH_MULTI_T9 field */
 103#define MXT_T9_CTRL		0
 104#define MXT_T9_XSIZE		3
 105#define MXT_T9_YSIZE		4
 106#define MXT_T9_ORIENT		9
 107#define MXT_T9_RANGE		18
 108
 109/* MXT_TOUCH_MULTI_T9 status */
 110#define MXT_T9_UNGRIP		BIT(0)
 111#define MXT_T9_SUPPRESS		BIT(1)
 112#define MXT_T9_AMP		BIT(2)
 113#define MXT_T9_VECTOR		BIT(3)
 114#define MXT_T9_MOVE		BIT(4)
 115#define MXT_T9_RELEASE		BIT(5)
 116#define MXT_T9_PRESS		BIT(6)
 117#define MXT_T9_DETECT		BIT(7)
 118
 119struct t9_range {
 120	__le16 x;
 121	__le16 y;
 122} __packed;
 123
 124/* MXT_TOUCH_MULTI_T9 orient */
 125#define MXT_T9_ORIENT_SWITCH	BIT(0)
 126#define MXT_T9_ORIENT_INVERTX	BIT(1)
 127#define MXT_T9_ORIENT_INVERTY	BIT(2)
 128
 129/* MXT_SPT_COMMSCONFIG_T18 */
 130#define MXT_COMMS_CTRL		0
 131#define MXT_COMMS_CMD		1
 132
 133/* MXT_DEBUG_DIAGNOSTIC_T37 */
 134#define MXT_DIAGNOSTIC_PAGEUP	0x01
 135#define MXT_DIAGNOSTIC_DELTAS	0x10
 136#define MXT_DIAGNOSTIC_REFS	0x11
 137#define MXT_DIAGNOSTIC_SIZE	128
 138
 139#define MXT_FAMILY_1386			160
 140#define MXT1386_COLUMNS			3
 141#define MXT1386_PAGES_PER_COLUMN	8
 142
 143struct t37_debug {
 144#ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
 145	u8 mode;
 146	u8 page;
 147	u8 data[MXT_DIAGNOSTIC_SIZE];
 148#endif
 149};
 150
 151/* Define for MXT_GEN_COMMAND_T6 */
 152#define MXT_BOOT_VALUE		0xa5
 153#define MXT_RESET_VALUE		0x01
 154#define MXT_BACKUP_VALUE	0x55
 155
 156/* T100 Multiple Touch Touchscreen */
 157#define MXT_T100_CTRL		0
 158#define MXT_T100_CFG1		1
 159#define MXT_T100_TCHAUX		3
 160#define MXT_T100_XSIZE		9
 161#define MXT_T100_XRANGE		13
 162#define MXT_T100_YSIZE		20
 163#define MXT_T100_YRANGE		24
 164
 165#define MXT_T100_CFG_SWITCHXY	BIT(5)
 166#define MXT_T100_CFG_INVERTY	BIT(6)
 167#define MXT_T100_CFG_INVERTX	BIT(7)
 168
 169#define MXT_T100_TCHAUX_VECT	BIT(0)
 170#define MXT_T100_TCHAUX_AMPL	BIT(1)
 171#define MXT_T100_TCHAUX_AREA	BIT(2)
 172
 173#define MXT_T100_DETECT		BIT(7)
 174#define MXT_T100_TYPE_MASK	0x70
 175
 176enum t100_type {
 177	MXT_T100_TYPE_FINGER		= 1,
 178	MXT_T100_TYPE_PASSIVE_STYLUS	= 2,
 179	MXT_T100_TYPE_HOVERING_FINGER	= 4,
 180	MXT_T100_TYPE_GLOVE		= 5,
 181	MXT_T100_TYPE_LARGE_TOUCH	= 6,
 182};
 183
 184#define MXT_DISTANCE_ACTIVE_TOUCH	0
 185#define MXT_DISTANCE_HOVERING		1
 186
 187#define MXT_TOUCH_MAJOR_DEFAULT		1
 188#define MXT_PRESSURE_DEFAULT		1
 189
 190/* Delay times */
 191#define MXT_BACKUP_TIME		50	/* msec */
 192#define MXT_RESET_GPIO_TIME	20	/* msec */
 193#define MXT_RESET_INVALID_CHG	100	/* msec */
 194#define MXT_RESET_TIME		200	/* msec */
 195#define MXT_RESET_TIMEOUT	3000	/* msec */
 196#define MXT_CRC_TIMEOUT		1000	/* msec */
 197#define MXT_FW_RESET_TIME	3000	/* msec */
 198#define MXT_FW_CHG_TIMEOUT	300	/* msec */
 199
 200/* Command to unlock bootloader */
 201#define MXT_UNLOCK_CMD_MSB	0xaa
 202#define MXT_UNLOCK_CMD_LSB	0xdc
 203
 204/* Bootloader mode status */
 205#define MXT_WAITING_BOOTLOAD_CMD	0xc0	/* valid 7 6 bit only */
 206#define MXT_WAITING_FRAME_DATA	0x80	/* valid 7 6 bit only */
 207#define MXT_FRAME_CRC_CHECK	0x02
 208#define MXT_FRAME_CRC_FAIL	0x03
 209#define MXT_FRAME_CRC_PASS	0x04
 210#define MXT_APP_CRC_FAIL	0x40	/* valid 7 8 bit only */
 211#define MXT_BOOT_STATUS_MASK	0x3f
 212#define MXT_BOOT_EXTENDED_ID	BIT(5)
 213#define MXT_BOOT_ID_MASK	0x1f
 214
 215/* Touchscreen absolute values */
 216#define MXT_MAX_AREA		0xff
 217
 218#define MXT_PIXELS_PER_MM	20
 219
 220struct mxt_info {
 221	u8 family_id;
 222	u8 variant_id;
 223	u8 version;
 224	u8 build;
 225	u8 matrix_xsize;
 226	u8 matrix_ysize;
 227	u8 object_num;
 228};
 229
 230struct mxt_object {
 231	u8 type;
 232	u16 start_address;
 233	u8 size_minus_one;
 234	u8 instances_minus_one;
 235	u8 num_report_ids;
 236} __packed;
 237
 238struct mxt_dbg {
 239	u16 t37_address;
 240	u16 diag_cmd_address;
 241	struct t37_debug *t37_buf;
 242	unsigned int t37_pages;
 243	unsigned int t37_nodes;
 244
 245	struct v4l2_device v4l2;
 246	struct v4l2_pix_format format;
 247	struct video_device vdev;
 248	struct vb2_queue queue;
 249	struct mutex lock;
 250	int input;
 251};
 252
 253enum v4l_dbg_inputs {
 254	MXT_V4L_INPUT_DELTAS,
 255	MXT_V4L_INPUT_REFS,
 256	MXT_V4L_INPUT_MAX,
 257};
 258
 259enum mxt_suspend_mode {
 260	MXT_SUSPEND_DEEP_SLEEP	= 0,
 261	MXT_SUSPEND_T9_CTRL	= 1,
 262};
 263
 264/* Config update context */
 265struct mxt_cfg {
 266	u8 *raw;
 267	size_t raw_size;
 268	off_t raw_pos;
 269
 270	u8 *mem;
 271	size_t mem_size;
 272	int start_ofs;
 273
 274	struct mxt_info info;
 275};
 276
 277/* Each client has this additional data */
 278struct mxt_data {
 279	struct i2c_client *client;
 280	struct input_dev *input_dev;
 281	char phys[64];		/* device physical location */
 
 282	struct mxt_object *object_table;
 283	struct mxt_info *info;
 284	void *raw_info_block;
 285	unsigned int irq;
 286	unsigned int max_x;
 287	unsigned int max_y;
 288	bool invertx;
 289	bool inverty;
 290	bool xy_switch;
 291	u8 xsize;
 292	u8 ysize;
 293	bool in_bootloader;
 294	u16 mem_size;
 295	u8 t100_aux_ampl;
 296	u8 t100_aux_area;
 297	u8 t100_aux_vect;
 298	u8 max_reportid;
 299	u32 config_crc;
 300	u32 info_crc;
 301	u8 bootloader_addr;
 302	u8 *msg_buf;
 303	u8 t6_status;
 304	bool update_input;
 305	u8 last_message_count;
 306	u8 num_touchids;
 307	u8 multitouch;
 308	struct t7_config t7_cfg;
 309	struct mxt_dbg dbg;
 310	struct gpio_desc *reset_gpio;
 311
 312	/* Cached parameters from object table */
 313	u16 T5_address;
 314	u8 T5_msg_size;
 315	u8 T6_reportid;
 316	u16 T6_address;
 317	u16 T7_address;
 318	u16 T71_address;
 319	u8 T9_reportid_min;
 320	u8 T9_reportid_max;
 321	u8 T19_reportid;
 322	u16 T44_address;
 323	u8 T100_reportid_min;
 324	u8 T100_reportid_max;
 325
 326	/* for fw update in bootloader */
 327	struct completion bl_completion;
 328
 329	/* for reset handling */
 330	struct completion reset_completion;
 331
 332	/* for config update handling */
 333	struct completion crc_completion;
 334
 335	u32 *t19_keymap;
 336	unsigned int t19_num_keys;
 337
 338	enum mxt_suspend_mode suspend_mode;
 339};
 340
 341struct mxt_vb2_buffer {
 342	struct vb2_buffer	vb;
 343	struct list_head	list;
 344};
 345
 346static size_t mxt_obj_size(const struct mxt_object *obj)
 347{
 348	return obj->size_minus_one + 1;
 349}
 350
 351static size_t mxt_obj_instances(const struct mxt_object *obj)
 352{
 353	return obj->instances_minus_one + 1;
 354}
 355
 356static bool mxt_object_readable(unsigned int type)
 357{
 358	switch (type) {
 359	case MXT_GEN_COMMAND_T6:
 360	case MXT_GEN_POWER_T7:
 361	case MXT_GEN_ACQUIRE_T8:
 362	case MXT_GEN_DATASOURCE_T53:
 363	case MXT_TOUCH_MULTI_T9:
 364	case MXT_TOUCH_KEYARRAY_T15:
 365	case MXT_TOUCH_PROXIMITY_T23:
 366	case MXT_TOUCH_PROXKEY_T52:
 367	case MXT_TOUCH_MULTITOUCHSCREEN_T100:
 368	case MXT_PROCI_GRIPFACE_T20:
 369	case MXT_PROCG_NOISE_T22:
 370	case MXT_PROCI_ONETOUCH_T24:
 371	case MXT_PROCI_TWOTOUCH_T27:
 372	case MXT_PROCI_GRIP_T40:
 373	case MXT_PROCI_PALM_T41:
 374	case MXT_PROCI_TOUCHSUPPRESSION_T42:
 375	case MXT_PROCI_STYLUS_T47:
 376	case MXT_PROCG_NOISESUPPRESSION_T48:
 377	case MXT_SPT_COMMSCONFIG_T18:
 378	case MXT_SPT_GPIOPWM_T19:
 379	case MXT_SPT_SELFTEST_T25:
 380	case MXT_SPT_CTECONFIG_T28:
 381	case MXT_SPT_USERDATA_T38:
 382	case MXT_SPT_DIGITIZER_T43:
 383	case MXT_SPT_CTECONFIG_T46:
 384	case MXT_SPT_DYNAMICCONFIGURATIONCONTAINER_T71:
 385		return true;
 386	default:
 387		return false;
 388	}
 389}
 390
 391static void mxt_dump_message(struct mxt_data *data, u8 *message)
 392{
 393	dev_dbg(&data->client->dev, "message: %*ph\n",
 394		data->T5_msg_size, message);
 395}
 396
 397static int mxt_wait_for_completion(struct mxt_data *data,
 398				   struct completion *comp,
 399				   unsigned int timeout_ms)
 400{
 401	struct device *dev = &data->client->dev;
 402	unsigned long timeout = msecs_to_jiffies(timeout_ms);
 403	long ret;
 404
 405	ret = wait_for_completion_interruptible_timeout(comp, timeout);
 406	if (ret < 0) {
 407		return ret;
 408	} else if (ret == 0) {
 409		dev_err(dev, "Wait for completion timed out.\n");
 410		return -ETIMEDOUT;
 411	}
 412	return 0;
 413}
 414
 415static int mxt_bootloader_read(struct mxt_data *data,
 416			       u8 *val, unsigned int count)
 417{
 418	int ret;
 419	struct i2c_msg msg;
 420
 421	msg.addr = data->bootloader_addr;
 422	msg.flags = data->client->flags & I2C_M_TEN;
 423	msg.flags |= I2C_M_RD;
 424	msg.len = count;
 425	msg.buf = val;
 426
 427	ret = i2c_transfer(data->client->adapter, &msg, 1);
 428	if (ret == 1) {
 429		ret = 0;
 430	} else {
 431		ret = ret < 0 ? ret : -EIO;
 432		dev_err(&data->client->dev, "%s: i2c recv failed (%d)\n",
 433			__func__, ret);
 434	}
 435
 436	return ret;
 437}
 438
 439static int mxt_bootloader_write(struct mxt_data *data,
 440				const u8 * const val, unsigned int count)
 441{
 442	int ret;
 443	struct i2c_msg msg;
 444
 445	msg.addr = data->bootloader_addr;
 446	msg.flags = data->client->flags & I2C_M_TEN;
 447	msg.len = count;
 448	msg.buf = (u8 *)val;
 449
 450	ret = i2c_transfer(data->client->adapter, &msg, 1);
 451	if (ret == 1) {
 452		ret = 0;
 453	} else {
 454		ret = ret < 0 ? ret : -EIO;
 455		dev_err(&data->client->dev, "%s: i2c send failed (%d)\n",
 456			__func__, ret);
 457	}
 458
 459	return ret;
 460}
 461
 462static int mxt_lookup_bootloader_address(struct mxt_data *data, bool retry)
 463{
 464	u8 appmode = data->client->addr;
 465	u8 bootloader;
 466	u8 family_id = data->info ? data->info->family_id : 0;
 467
 468	switch (appmode) {
 469	case 0x4a:
 470	case 0x4b:
 471		/* Chips after 1664S use different scheme */
 472		if (retry || family_id >= 0xa2) {
 473			bootloader = appmode - 0x24;
 474			break;
 475		}
 476		/* Fall through - for normal case */
 477	case 0x4c:
 478	case 0x4d:
 479	case 0x5a:
 480	case 0x5b:
 481		bootloader = appmode - 0x26;
 482		break;
 483
 484	default:
 485		dev_err(&data->client->dev,
 486			"Appmode i2c address 0x%02x not found\n",
 487			appmode);
 488		return -EINVAL;
 489	}
 490
 491	data->bootloader_addr = bootloader;
 492	return 0;
 493}
 494
 495static int mxt_probe_bootloader(struct mxt_data *data, bool alt_address)
 496{
 497	struct device *dev = &data->client->dev;
 498	int error;
 499	u8 val;
 500	bool crc_failure;
 501
 502	error = mxt_lookup_bootloader_address(data, alt_address);
 503	if (error)
 504		return error;
 505
 506	error = mxt_bootloader_read(data, &val, 1);
 507	if (error)
 508		return error;
 509
 510	/* Check app crc fail mode */
 511	crc_failure = (val & ~MXT_BOOT_STATUS_MASK) == MXT_APP_CRC_FAIL;
 512
 513	dev_err(dev, "Detected bootloader, status:%02X%s\n",
 514			val, crc_failure ? ", APP_CRC_FAIL" : "");
 515
 516	return 0;
 517}
 518
 519static u8 mxt_get_bootloader_version(struct mxt_data *data, u8 val)
 520{
 521	struct device *dev = &data->client->dev;
 522	u8 buf[3];
 523
 524	if (val & MXT_BOOT_EXTENDED_ID) {
 525		if (mxt_bootloader_read(data, &buf[0], 3) != 0) {
 526			dev_err(dev, "%s: i2c failure\n", __func__);
 527			return val;
 528		}
 529
 530		dev_dbg(dev, "Bootloader ID:%d Version:%d\n", buf[1], buf[2]);
 531
 532		return buf[0];
 533	} else {
 534		dev_dbg(dev, "Bootloader ID:%d\n", val & MXT_BOOT_ID_MASK);
 535
 536		return val;
 537	}
 538}
 539
 540static int mxt_check_bootloader(struct mxt_data *data, unsigned int state,
 541				bool wait)
 542{
 543	struct device *dev = &data->client->dev;
 544	u8 val;
 545	int ret;
 546
 547recheck:
 548	if (wait) {
 549		/*
 550		 * In application update mode, the interrupt
 551		 * line signals state transitions. We must wait for the
 552		 * CHG assertion before reading the status byte.
 553		 * Once the status byte has been read, the line is deasserted.
 554		 */
 555		ret = mxt_wait_for_completion(data, &data->bl_completion,
 556					      MXT_FW_CHG_TIMEOUT);
 557		if (ret) {
 558			/*
 559			 * TODO: handle -ERESTARTSYS better by terminating
 560			 * fw update process before returning to userspace
 561			 * by writing length 0x000 to device (iff we are in
 562			 * WAITING_FRAME_DATA state).
 563			 */
 564			dev_err(dev, "Update wait error %d\n", ret);
 565			return ret;
 566		}
 567	}
 568
 569	ret = mxt_bootloader_read(data, &val, 1);
 570	if (ret)
 571		return ret;
 572
 573	if (state == MXT_WAITING_BOOTLOAD_CMD)
 574		val = mxt_get_bootloader_version(data, val);
 575
 576	switch (state) {
 577	case MXT_WAITING_BOOTLOAD_CMD:
 578	case MXT_WAITING_FRAME_DATA:
 579	case MXT_APP_CRC_FAIL:
 580		val &= ~MXT_BOOT_STATUS_MASK;
 581		break;
 582	case MXT_FRAME_CRC_PASS:
 583		if (val == MXT_FRAME_CRC_CHECK) {
 584			goto recheck;
 585		} else if (val == MXT_FRAME_CRC_FAIL) {
 586			dev_err(dev, "Bootloader CRC fail\n");
 587			return -EINVAL;
 588		}
 589		break;
 590	default:
 591		return -EINVAL;
 592	}
 593
 594	if (val != state) {
 595		dev_err(dev, "Invalid bootloader state %02X != %02X\n",
 596			val, state);
 597		return -EINVAL;
 598	}
 599
 600	return 0;
 601}
 602
 603static int mxt_send_bootloader_cmd(struct mxt_data *data, bool unlock)
 604{
 605	int ret;
 606	u8 buf[2];
 607
 608	if (unlock) {
 609		buf[0] = MXT_UNLOCK_CMD_LSB;
 610		buf[1] = MXT_UNLOCK_CMD_MSB;
 611	} else {
 612		buf[0] = 0x01;
 613		buf[1] = 0x01;
 614	}
 615
 616	ret = mxt_bootloader_write(data, buf, 2);
 617	if (ret)
 618		return ret;
 619
 620	return 0;
 621}
 622
 623static int __mxt_read_reg(struct i2c_client *client,
 624			       u16 reg, u16 len, void *val)
 625{
 626	struct i2c_msg xfer[2];
 627	u8 buf[2];
 628	int ret;
 629
 630	buf[0] = reg & 0xff;
 631	buf[1] = (reg >> 8) & 0xff;
 632
 633	/* Write register */
 634	xfer[0].addr = client->addr;
 635	xfer[0].flags = 0;
 636	xfer[0].len = 2;
 637	xfer[0].buf = buf;
 638
 639	/* Read data */
 640	xfer[1].addr = client->addr;
 641	xfer[1].flags = I2C_M_RD;
 642	xfer[1].len = len;
 643	xfer[1].buf = val;
 644
 645	ret = i2c_transfer(client->adapter, xfer, 2);
 646	if (ret == 2) {
 647		ret = 0;
 648	} else {
 649		if (ret >= 0)
 650			ret = -EIO;
 651		dev_err(&client->dev, "%s: i2c transfer failed (%d)\n",
 652			__func__, ret);
 653	}
 654
 655	return ret;
 656}
 657
 658static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len,
 659			   const void *val)
 660{
 661	u8 *buf;
 662	size_t count;
 663	int ret;
 664
 665	count = len + 2;
 666	buf = kmalloc(count, GFP_KERNEL);
 667	if (!buf)
 668		return -ENOMEM;
 669
 670	buf[0] = reg & 0xff;
 671	buf[1] = (reg >> 8) & 0xff;
 672	memcpy(&buf[2], val, len);
 673
 674	ret = i2c_master_send(client, buf, count);
 675	if (ret == count) {
 676		ret = 0;
 677	} else {
 678		if (ret >= 0)
 679			ret = -EIO;
 680		dev_err(&client->dev, "%s: i2c send failed (%d)\n",
 681			__func__, ret);
 682	}
 683
 684	kfree(buf);
 685	return ret;
 686}
 687
 688static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
 689{
 690	return __mxt_write_reg(client, reg, 1, &val);
 691}
 692
 693static struct mxt_object *
 694mxt_get_object(struct mxt_data *data, u8 type)
 695{
 696	struct mxt_object *object;
 697	int i;
 698
 699	for (i = 0; i < data->info->object_num; i++) {
 700		object = data->object_table + i;
 701		if (object->type == type)
 702			return object;
 703	}
 704
 705	dev_warn(&data->client->dev, "Invalid object type T%u\n", type);
 706	return NULL;
 707}
 708
 709static void mxt_proc_t6_messages(struct mxt_data *data, u8 *msg)
 710{
 711	struct device *dev = &data->client->dev;
 712	u8 status = msg[1];
 713	u32 crc = msg[2] | (msg[3] << 8) | (msg[4] << 16);
 714
 
 
 715	if (crc != data->config_crc) {
 716		data->config_crc = crc;
 717		dev_dbg(dev, "T6 Config Checksum: 0x%06X\n", crc);
 718	}
 719
 720	complete(&data->crc_completion);
 721
 722	/* Detect reset */
 723	if (status & MXT_T6_STATUS_RESET)
 724		complete(&data->reset_completion);
 725
 726	/* Output debug if status has changed */
 727	if (status != data->t6_status)
 728		dev_dbg(dev, "T6 Status 0x%02X%s%s%s%s%s%s%s\n",
 729			status,
 730			status == 0 ? " OK" : "",
 731			status & MXT_T6_STATUS_RESET ? " RESET" : "",
 732			status & MXT_T6_STATUS_OFL ? " OFL" : "",
 733			status & MXT_T6_STATUS_SIGERR ? " SIGERR" : "",
 734			status & MXT_T6_STATUS_CAL ? " CAL" : "",
 735			status & MXT_T6_STATUS_CFGERR ? " CFGERR" : "",
 736			status & MXT_T6_STATUS_COMSERR ? " COMSERR" : "");
 737
 738	/* Save current status */
 739	data->t6_status = status;
 740}
 741
 742static int mxt_write_object(struct mxt_data *data,
 743				 u8 type, u8 offset, u8 val)
 744{
 745	struct mxt_object *object;
 746	u16 reg;
 747
 748	object = mxt_get_object(data, type);
 749	if (!object || offset >= mxt_obj_size(object))
 750		return -EINVAL;
 751
 752	reg = object->start_address;
 753	return mxt_write_reg(data->client, reg + offset, val);
 754}
 755
 756static void mxt_input_button(struct mxt_data *data, u8 *message)
 757{
 758	struct input_dev *input = data->input_dev;
 
 759	int i;
 760
 761	for (i = 0; i < data->t19_num_keys; i++) {
 762		if (data->t19_keymap[i] == KEY_RESERVED)
 763			continue;
 764
 765		/* Active-low switch */
 766		input_report_key(input, data->t19_keymap[i],
 767				 !(message[1] & BIT(i)));
 768	}
 769}
 770
 771static void mxt_input_sync(struct mxt_data *data)
 772{
 773	input_mt_report_pointer_emulation(data->input_dev,
 774					  data->t19_num_keys);
 775	input_sync(data->input_dev);
 776}
 777
 778static void mxt_proc_t9_message(struct mxt_data *data, u8 *message)
 779{
 780	struct device *dev = &data->client->dev;
 781	struct input_dev *input_dev = data->input_dev;
 782	int id;
 783	u8 status;
 784	int x;
 785	int y;
 786	int area;
 787	int amplitude;
 788
 789	id = message[0] - data->T9_reportid_min;
 790	status = message[1];
 791	x = (message[2] << 4) | ((message[4] >> 4) & 0xf);
 792	y = (message[3] << 4) | ((message[4] & 0xf));
 793
 794	/* Handle 10/12 bit switching */
 795	if (data->max_x < 1024)
 796		x >>= 2;
 797	if (data->max_y < 1024)
 798		y >>= 2;
 799
 800	area = message[5];
 801	amplitude = message[6];
 802
 803	dev_dbg(dev,
 804		"[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
 805		id,
 806		(status & MXT_T9_DETECT) ? 'D' : '.',
 807		(status & MXT_T9_PRESS) ? 'P' : '.',
 808		(status & MXT_T9_RELEASE) ? 'R' : '.',
 809		(status & MXT_T9_MOVE) ? 'M' : '.',
 810		(status & MXT_T9_VECTOR) ? 'V' : '.',
 811		(status & MXT_T9_AMP) ? 'A' : '.',
 812		(status & MXT_T9_SUPPRESS) ? 'S' : '.',
 813		(status & MXT_T9_UNGRIP) ? 'U' : '.',
 814		x, y, area, amplitude);
 815
 816	input_mt_slot(input_dev, id);
 817
 818	if (status & MXT_T9_DETECT) {
 819		/*
 820		 * Multiple bits may be set if the host is slow to read
 821		 * the status messages, indicating all the events that
 822		 * have happened.
 823		 */
 824		if (status & MXT_T9_RELEASE) {
 825			input_mt_report_slot_state(input_dev,
 826						   MT_TOOL_FINGER, 0);
 827			mxt_input_sync(data);
 828		}
 829
 830		/* if active, pressure must be non-zero */
 831		if (!amplitude)
 832			amplitude = MXT_PRESSURE_DEFAULT;
 833
 834		/* Touch active */
 835		input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 1);
 836		input_report_abs(input_dev, ABS_MT_POSITION_X, x);
 837		input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
 838		input_report_abs(input_dev, ABS_MT_PRESSURE, amplitude);
 839		input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
 840	} else {
 841		/* Touch no longer active, close out slot */
 842		input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 0);
 843	}
 844
 845	data->update_input = true;
 846}
 847
 848static void mxt_proc_t100_message(struct mxt_data *data, u8 *message)
 849{
 850	struct device *dev = &data->client->dev;
 851	struct input_dev *input_dev = data->input_dev;
 852	int id;
 853	u8 status;
 854	u8 type = 0;
 855	u16 x;
 856	u16 y;
 857	int distance = 0;
 858	int tool = 0;
 859	u8 major = 0;
 860	u8 pressure = 0;
 861	u8 orientation = 0;
 862
 863	id = message[0] - data->T100_reportid_min - 2;
 864
 865	/* ignore SCRSTATUS events */
 866	if (id < 0)
 867		return;
 868
 869	status = message[1];
 870	x = get_unaligned_le16(&message[2]);
 871	y = get_unaligned_le16(&message[4]);
 872
 873	if (status & MXT_T100_DETECT) {
 874		type = (status & MXT_T100_TYPE_MASK) >> 4;
 875
 876		switch (type) {
 877		case MXT_T100_TYPE_HOVERING_FINGER:
 878			tool = MT_TOOL_FINGER;
 879			distance = MXT_DISTANCE_HOVERING;
 880
 881			if (data->t100_aux_vect)
 882				orientation = message[data->t100_aux_vect];
 883
 884			break;
 885
 886		case MXT_T100_TYPE_FINGER:
 887		case MXT_T100_TYPE_GLOVE:
 888			tool = MT_TOOL_FINGER;
 889			distance = MXT_DISTANCE_ACTIVE_TOUCH;
 890
 891			if (data->t100_aux_area)
 892				major = message[data->t100_aux_area];
 893
 894			if (data->t100_aux_ampl)
 895				pressure = message[data->t100_aux_ampl];
 896
 897			if (data->t100_aux_vect)
 898				orientation = message[data->t100_aux_vect];
 899
 900			break;
 901
 902		case MXT_T100_TYPE_PASSIVE_STYLUS:
 903			tool = MT_TOOL_PEN;
 904
 905			/*
 906			 * Passive stylus is reported with size zero so
 907			 * hardcode.
 908			 */
 909			major = MXT_TOUCH_MAJOR_DEFAULT;
 910
 911			if (data->t100_aux_ampl)
 912				pressure = message[data->t100_aux_ampl];
 913
 914			break;
 915
 916		case MXT_T100_TYPE_LARGE_TOUCH:
 917			/* Ignore suppressed touch */
 918			break;
 919
 920		default:
 921			dev_dbg(dev, "Unexpected T100 type\n");
 922			return;
 923		}
 924	}
 925
 926	/*
 927	 * Values reported should be non-zero if tool is touching the
 928	 * device
 929	 */
 930	if (!pressure && type != MXT_T100_TYPE_HOVERING_FINGER)
 931		pressure = MXT_PRESSURE_DEFAULT;
 932
 933	input_mt_slot(input_dev, id);
 934
 935	if (status & MXT_T100_DETECT) {
 936		dev_dbg(dev, "[%u] type:%u x:%u y:%u a:%02X p:%02X v:%02X\n",
 937			id, type, x, y, major, pressure, orientation);
 938
 939		input_mt_report_slot_state(input_dev, tool, 1);
 940		input_report_abs(input_dev, ABS_MT_POSITION_X, x);
 941		input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
 942		input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, major);
 943		input_report_abs(input_dev, ABS_MT_PRESSURE, pressure);
 944		input_report_abs(input_dev, ABS_MT_DISTANCE, distance);
 945		input_report_abs(input_dev, ABS_MT_ORIENTATION, orientation);
 946	} else {
 947		dev_dbg(dev, "[%u] release\n", id);
 948
 949		/* close out slot */
 950		input_mt_report_slot_state(input_dev, 0, 0);
 951	}
 952
 953	data->update_input = true;
 954}
 955
 956static int mxt_proc_message(struct mxt_data *data, u8 *message)
 957{
 958	u8 report_id = message[0];
 959
 960	if (report_id == MXT_RPTID_NOMSG)
 961		return 0;
 962
 963	if (report_id == data->T6_reportid) {
 964		mxt_proc_t6_messages(data, message);
 965	} else if (!data->input_dev) {
 966		/*
 967		 * Do not report events if input device
 968		 * is not yet registered.
 969		 */
 970		mxt_dump_message(data, message);
 971	} else if (report_id >= data->T9_reportid_min &&
 972		   report_id <= data->T9_reportid_max) {
 973		mxt_proc_t9_message(data, message);
 974	} else if (report_id >= data->T100_reportid_min &&
 975		   report_id <= data->T100_reportid_max) {
 976		mxt_proc_t100_message(data, message);
 977	} else if (report_id == data->T19_reportid) {
 978		mxt_input_button(data, message);
 979		data->update_input = true;
 980	} else {
 981		mxt_dump_message(data, message);
 982	}
 983
 984	return 1;
 985}
 986
 987static int mxt_read_and_process_messages(struct mxt_data *data, u8 count)
 988{
 989	struct device *dev = &data->client->dev;
 990	int ret;
 991	int i;
 992	u8 num_valid = 0;
 993
 994	/* Safety check for msg_buf */
 995	if (count > data->max_reportid)
 996		return -EINVAL;
 997
 998	/* Process remaining messages if necessary */
 999	ret = __mxt_read_reg(data->client, data->T5_address,
1000				data->T5_msg_size * count, data->msg_buf);
1001	if (ret) {
1002		dev_err(dev, "Failed to read %u messages (%d)\n", count, ret);
1003		return ret;
1004	}
1005
1006	for (i = 0;  i < count; i++) {
1007		ret = mxt_proc_message(data,
1008			data->msg_buf + data->T5_msg_size * i);
1009
1010		if (ret == 1)
1011			num_valid++;
1012	}
1013
1014	/* return number of messages read */
1015	return num_valid;
1016}
1017
1018static irqreturn_t mxt_process_messages_t44(struct mxt_data *data)
1019{
1020	struct device *dev = &data->client->dev;
1021	int ret;
1022	u8 count, num_left;
1023
1024	/* Read T44 and T5 together */
1025	ret = __mxt_read_reg(data->client, data->T44_address,
1026		data->T5_msg_size + 1, data->msg_buf);
1027	if (ret) {
1028		dev_err(dev, "Failed to read T44 and T5 (%d)\n", ret);
1029		return IRQ_NONE;
1030	}
1031
1032	count = data->msg_buf[0];
1033
1034	/*
1035	 * This condition may be caused by the CHG line being configured in
1036	 * Mode 0. It results in unnecessary I2C operations but it is benign.
1037	 */
1038	if (count == 0)
1039		return IRQ_NONE;
1040
1041	if (count > data->max_reportid) {
1042		dev_warn(dev, "T44 count %d exceeded max report id\n", count);
1043		count = data->max_reportid;
1044	}
1045
1046	/* Process first message */
1047	ret = mxt_proc_message(data, data->msg_buf + 1);
1048	if (ret < 0) {
1049		dev_warn(dev, "Unexpected invalid message\n");
1050		return IRQ_NONE;
1051	}
1052
1053	num_left = count - 1;
1054
1055	/* Process remaining messages if necessary */
1056	if (num_left) {
1057		ret = mxt_read_and_process_messages(data, num_left);
1058		if (ret < 0)
1059			goto end;
1060		else if (ret != num_left)
1061			dev_warn(dev, "Unexpected invalid message\n");
1062	}
1063
1064end:
1065	if (data->update_input) {
1066		mxt_input_sync(data);
1067		data->update_input = false;
1068	}
1069
1070	return IRQ_HANDLED;
1071}
1072
1073static int mxt_process_messages_until_invalid(struct mxt_data *data)
1074{
1075	struct device *dev = &data->client->dev;
1076	int count, read;
1077	u8 tries = 2;
1078
1079	count = data->max_reportid;
1080
1081	/* Read messages until we force an invalid */
1082	do {
1083		read = mxt_read_and_process_messages(data, count);
1084		if (read < count)
1085			return 0;
1086	} while (--tries);
1087
1088	if (data->update_input) {
1089		mxt_input_sync(data);
1090		data->update_input = false;
1091	}
1092
1093	dev_err(dev, "CHG pin isn't cleared\n");
1094	return -EBUSY;
1095}
1096
1097static irqreturn_t mxt_process_messages(struct mxt_data *data)
1098{
1099	int total_handled, num_handled;
1100	u8 count = data->last_message_count;
1101
1102	if (count < 1 || count > data->max_reportid)
1103		count = 1;
1104
1105	/* include final invalid message */
1106	total_handled = mxt_read_and_process_messages(data, count + 1);
1107	if (total_handled < 0)
1108		return IRQ_NONE;
1109	/* if there were invalid messages, then we are done */
1110	else if (total_handled <= count)
1111		goto update_count;
1112
1113	/* keep reading two msgs until one is invalid or reportid limit */
1114	do {
1115		num_handled = mxt_read_and_process_messages(data, 2);
1116		if (num_handled < 0)
1117			return IRQ_NONE;
1118
1119		total_handled += num_handled;
1120
1121		if (num_handled < 2)
1122			break;
1123	} while (total_handled < data->num_touchids);
1124
1125update_count:
1126	data->last_message_count = total_handled;
1127
1128	if (data->update_input) {
1129		mxt_input_sync(data);
1130		data->update_input = false;
1131	}
1132
1133	return IRQ_HANDLED;
1134}
1135
1136static irqreturn_t mxt_interrupt(int irq, void *dev_id)
1137{
1138	struct mxt_data *data = dev_id;
1139
1140	if (data->in_bootloader) {
1141		/* bootloader state transition completion */
1142		complete(&data->bl_completion);
1143		return IRQ_HANDLED;
1144	}
1145
1146	if (!data->object_table)
1147		return IRQ_HANDLED;
1148
1149	if (data->T44_address) {
1150		return mxt_process_messages_t44(data);
1151	} else {
1152		return mxt_process_messages(data);
1153	}
1154}
1155
1156static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset,
1157			  u8 value, bool wait)
1158{
1159	u16 reg;
1160	u8 command_register;
1161	int timeout_counter = 0;
1162	int ret;
1163
1164	reg = data->T6_address + cmd_offset;
1165
1166	ret = mxt_write_reg(data->client, reg, value);
1167	if (ret)
1168		return ret;
1169
1170	if (!wait)
1171		return 0;
1172
1173	do {
1174		msleep(20);
1175		ret = __mxt_read_reg(data->client, reg, 1, &command_register);
1176		if (ret)
1177			return ret;
1178	} while (command_register != 0 && timeout_counter++ <= 100);
1179
1180	if (timeout_counter > 100) {
1181		dev_err(&data->client->dev, "Command failed!\n");
1182		return -EIO;
1183	}
1184
1185	return 0;
1186}
1187
1188static int mxt_acquire_irq(struct mxt_data *data)
1189{
1190	int error;
1191
1192	enable_irq(data->irq);
1193
1194	error = mxt_process_messages_until_invalid(data);
1195	if (error)
1196		return error;
1197
1198	return 0;
1199}
1200
1201static int mxt_soft_reset(struct mxt_data *data)
1202{
1203	struct device *dev = &data->client->dev;
1204	int ret = 0;
1205
1206	dev_info(dev, "Resetting device\n");
1207
1208	disable_irq(data->irq);
1209
1210	reinit_completion(&data->reset_completion);
1211
1212	ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false);
1213	if (ret)
1214		return ret;
1215
1216	/* Ignore CHG line for 100ms after reset */
1217	msleep(MXT_RESET_INVALID_CHG);
1218
1219	mxt_acquire_irq(data);
1220
1221	ret = mxt_wait_for_completion(data, &data->reset_completion,
1222				      MXT_RESET_TIMEOUT);
1223	if (ret)
1224		return ret;
1225
1226	return 0;
1227}
1228
1229static void mxt_update_crc(struct mxt_data *data, u8 cmd, u8 value)
1230{
1231	/*
1232	 * On failure, CRC is set to 0 and config will always be
1233	 * downloaded.
1234	 */
1235	data->config_crc = 0;
1236	reinit_completion(&data->crc_completion);
1237
1238	mxt_t6_command(data, cmd, value, true);
1239
1240	/*
1241	 * Wait for crc message. On failure, CRC is set to 0 and config will
1242	 * always be downloaded.
1243	 */
1244	mxt_wait_for_completion(data, &data->crc_completion, MXT_CRC_TIMEOUT);
1245}
1246
1247static void mxt_calc_crc24(u32 *crc, u8 firstbyte, u8 secondbyte)
1248{
1249	static const unsigned int crcpoly = 0x80001B;
1250	u32 result;
1251	u32 data_word;
1252
1253	data_word = (secondbyte << 8) | firstbyte;
1254	result = ((*crc << 1) ^ data_word);
1255
1256	if (result & 0x1000000)
1257		result ^= crcpoly;
1258
1259	*crc = result;
1260}
1261
1262static u32 mxt_calculate_crc(u8 *base, off_t start_off, off_t end_off)
1263{
1264	u32 crc = 0;
1265	u8 *ptr = base + start_off;
1266	u8 *last_val = base + end_off - 1;
1267
1268	if (end_off < start_off)
1269		return -EINVAL;
1270
1271	while (ptr < last_val) {
1272		mxt_calc_crc24(&crc, *ptr, *(ptr + 1));
1273		ptr += 2;
1274	}
1275
1276	/* if len is odd, fill the last byte with 0 */
1277	if (ptr == last_val)
1278		mxt_calc_crc24(&crc, *ptr, 0);
1279
1280	/* Mask to 24-bit */
1281	crc &= 0x00FFFFFF;
1282
1283	return crc;
1284}
1285
1286static int mxt_prepare_cfg_mem(struct mxt_data *data, struct mxt_cfg *cfg)
 
 
 
 
 
1287{
1288	struct device *dev = &data->client->dev;
1289	struct mxt_object *object;
1290	unsigned int type, instance, size, byte_offset;
1291	int offset;
1292	int ret;
1293	int i;
1294	u16 reg;
1295	u8 val;
1296
1297	while (cfg->raw_pos < cfg->raw_size) {
1298		/* Read type, instance, length */
1299		ret = sscanf(cfg->raw + cfg->raw_pos, "%x %x %x%n",
1300			     &type, &instance, &size, &offset);
1301		if (ret == 0) {
1302			/* EOF */
1303			break;
1304		} else if (ret != 3) {
1305			dev_err(dev, "Bad format: failed to parse object\n");
1306			return -EINVAL;
1307		}
1308		cfg->raw_pos += offset;
1309
1310		object = mxt_get_object(data, type);
1311		if (!object) {
1312			/* Skip object */
1313			for (i = 0; i < size; i++) {
1314				ret = sscanf(cfg->raw + cfg->raw_pos, "%hhx%n",
1315					     &val, &offset);
1316				if (ret != 1) {
1317					dev_err(dev, "Bad format in T%d at %d\n",
1318						type, i);
1319					return -EINVAL;
1320				}
1321				cfg->raw_pos += offset;
1322			}
1323			continue;
1324		}
1325
1326		if (size > mxt_obj_size(object)) {
1327			/*
1328			 * Either we are in fallback mode due to wrong
1329			 * config or config from a later fw version,
1330			 * or the file is corrupt or hand-edited.
1331			 */
1332			dev_warn(dev, "Discarding %zu byte(s) in T%u\n",
1333				 size - mxt_obj_size(object), type);
1334		} else if (mxt_obj_size(object) > size) {
1335			/*
1336			 * If firmware is upgraded, new bytes may be added to
1337			 * end of objects. It is generally forward compatible
1338			 * to zero these bytes - previous behaviour will be
1339			 * retained. However this does invalidate the CRC and
1340			 * will force fallback mode until the configuration is
1341			 * updated. We warn here but do nothing else - the
1342			 * malloc has zeroed the entire configuration.
1343			 */
1344			dev_warn(dev, "Zeroing %zu byte(s) in T%d\n",
1345				 mxt_obj_size(object) - size, type);
1346		}
1347
1348		if (instance >= mxt_obj_instances(object)) {
1349			dev_err(dev, "Object instances exceeded!\n");
1350			return -EINVAL;
1351		}
1352
1353		reg = object->start_address + mxt_obj_size(object) * instance;
1354
1355		for (i = 0; i < size; i++) {
1356			ret = sscanf(cfg->raw + cfg->raw_pos, "%hhx%n",
1357				     &val,
1358				     &offset);
1359			if (ret != 1) {
1360				dev_err(dev, "Bad format in T%d at %d\n",
1361					type, i);
1362				return -EINVAL;
1363			}
1364			cfg->raw_pos += offset;
1365
1366			if (i > mxt_obj_size(object))
1367				continue;
1368
1369			byte_offset = reg + i - cfg->start_ofs;
1370
1371			if (byte_offset >= 0 && byte_offset < cfg->mem_size) {
1372				*(cfg->mem + byte_offset) = val;
1373			} else {
1374				dev_err(dev, "Bad object: reg:%d, T%d, ofs=%d\n",
1375					reg, object->type, byte_offset);
1376				return -EINVAL;
1377			}
1378		}
1379	}
1380
1381	return 0;
1382}
1383
1384static int mxt_upload_cfg_mem(struct mxt_data *data, struct mxt_cfg *cfg)
 
1385{
1386	unsigned int byte_offset = 0;
1387	int error;
1388
1389	/* Write configuration as blocks */
1390	while (byte_offset < cfg->mem_size) {
1391		unsigned int size = cfg->mem_size - byte_offset;
1392
1393		if (size > MXT_MAX_BLOCK_WRITE)
1394			size = MXT_MAX_BLOCK_WRITE;
1395
1396		error = __mxt_write_reg(data->client,
1397					cfg->start_ofs + byte_offset,
1398					size, cfg->mem + byte_offset);
1399		if (error) {
1400			dev_err(&data->client->dev,
1401				"Config write error, ret=%d\n", error);
1402			return error;
1403		}
1404
1405		byte_offset += size;
1406	}
1407
1408	return 0;
1409}
1410
1411static int mxt_init_t7_power_cfg(struct mxt_data *data);
1412
1413/*
1414 * mxt_update_cfg - download configuration to chip
1415 *
1416 * Atmel Raw Config File Format
1417 *
1418 * The first four lines of the raw config file contain:
1419 *  1) Version
1420 *  2) Chip ID Information (first 7 bytes of device memory)
1421 *  3) Chip Information Block 24-bit CRC Checksum
1422 *  4) Chip Configuration 24-bit CRC Checksum
1423 *
1424 * The rest of the file consists of one line per object instance:
1425 *   <TYPE> <INSTANCE> <SIZE> <CONTENTS>
1426 *
1427 *   <TYPE> - 2-byte object type as hex
1428 *   <INSTANCE> - 2-byte object instance number as hex
1429 *   <SIZE> - 2-byte object size as hex
1430 *   <CONTENTS> - array of <SIZE> 1-byte hex values
1431 */
1432static int mxt_update_cfg(struct mxt_data *data, const struct firmware *fw)
1433{
1434	struct device *dev = &data->client->dev;
1435	struct mxt_cfg cfg;
1436	int ret;
1437	int offset;
 
1438	int i;
 
1439	u32 info_crc, config_crc, calculated_crc;
1440	u16 crc_start = 0;
1441
1442	/* Make zero terminated copy of the OBP_RAW file */
1443	cfg.raw = kmemdup_nul(fw->data, fw->size, GFP_KERNEL);
1444	if (!cfg.raw)
1445		return -ENOMEM;
1446
1447	cfg.raw_size = fw->size;
1448
1449	mxt_update_crc(data, MXT_COMMAND_REPORTALL, 1);
1450
1451	if (strncmp(cfg.raw, MXT_CFG_MAGIC, strlen(MXT_CFG_MAGIC))) {
1452		dev_err(dev, "Unrecognised config file\n");
1453		ret = -EINVAL;
1454		goto release_raw;
1455	}
1456
1457	cfg.raw_pos = strlen(MXT_CFG_MAGIC);
1458
1459	/* Load information block and check */
1460	for (i = 0; i < sizeof(struct mxt_info); i++) {
1461		ret = sscanf(cfg.raw + cfg.raw_pos, "%hhx%n",
1462			     (unsigned char *)&cfg.info + i,
1463			     &offset);
1464		if (ret != 1) {
1465			dev_err(dev, "Bad format\n");
1466			ret = -EINVAL;
1467			goto release_raw;
1468		}
1469
1470		cfg.raw_pos += offset;
1471	}
1472
1473	if (cfg.info.family_id != data->info->family_id) {
1474		dev_err(dev, "Family ID mismatch!\n");
1475		ret = -EINVAL;
1476		goto release_raw;
1477	}
1478
1479	if (cfg.info.variant_id != data->info->variant_id) {
1480		dev_err(dev, "Variant ID mismatch!\n");
1481		ret = -EINVAL;
1482		goto release_raw;
1483	}
1484
1485	/* Read CRCs */
1486	ret = sscanf(cfg.raw + cfg.raw_pos, "%x%n", &info_crc, &offset);
1487	if (ret != 1) {
1488		dev_err(dev, "Bad format: failed to parse Info CRC\n");
1489		ret = -EINVAL;
1490		goto release_raw;
1491	}
1492	cfg.raw_pos += offset;
1493
1494	ret = sscanf(cfg.raw + cfg.raw_pos, "%x%n", &config_crc, &offset);
1495	if (ret != 1) {
1496		dev_err(dev, "Bad format: failed to parse Config CRC\n");
1497		ret = -EINVAL;
1498		goto release_raw;
1499	}
1500	cfg.raw_pos += offset;
1501
1502	/*
1503	 * The Info Block CRC is calculated over mxt_info and the object
1504	 * table. If it does not match then we are trying to load the
1505	 * configuration from a different chip or firmware version, so
1506	 * the configuration CRC is invalid anyway.
1507	 */
1508	if (info_crc == data->info_crc) {
1509		if (config_crc == 0 || data->config_crc == 0) {
1510			dev_info(dev, "CRC zero, attempting to apply config\n");
1511		} else if (config_crc == data->config_crc) {
1512			dev_dbg(dev, "Config CRC 0x%06X: OK\n",
1513				 data->config_crc);
1514			ret = 0;
1515			goto release_raw;
1516		} else {
1517			dev_info(dev, "Config CRC 0x%06X: does not match file 0x%06X\n",
1518				 data->config_crc, config_crc);
1519		}
1520	} else {
1521		dev_warn(dev,
1522			 "Warning: Info CRC error - device=0x%06X file=0x%06X\n",
1523			 data->info_crc, info_crc);
1524	}
1525
1526	/* Malloc memory to store configuration */
1527	cfg.start_ofs = MXT_OBJECT_START +
1528			data->info->object_num * sizeof(struct mxt_object) +
1529			MXT_INFO_CHECKSUM_SIZE;
1530	cfg.mem_size = data->mem_size - cfg.start_ofs;
1531	cfg.mem = kzalloc(cfg.mem_size, GFP_KERNEL);
1532	if (!cfg.mem) {
1533		ret = -ENOMEM;
1534		goto release_raw;
1535	}
1536
1537	ret = mxt_prepare_cfg_mem(data, &cfg);
 
1538	if (ret)
1539		goto release_mem;
1540
1541	/* Calculate crc of the received configs (not the raw config file) */
1542	if (data->T71_address)
1543		crc_start = data->T71_address;
1544	else if (data->T7_address)
1545		crc_start = data->T7_address;
1546	else
1547		dev_warn(dev, "Could not find CRC start\n");
1548
1549	if (crc_start > cfg.start_ofs) {
1550		calculated_crc = mxt_calculate_crc(cfg.mem,
1551						   crc_start - cfg.start_ofs,
1552						   cfg.mem_size);
1553
1554		if (config_crc > 0 && config_crc != calculated_crc)
1555			dev_warn(dev, "Config CRC in file inconsistent, calculated=%06X, file=%06X\n",
1556				 calculated_crc, config_crc);
1557	}
 
 
 
1558
1559	ret = mxt_upload_cfg_mem(data, &cfg);
 
1560	if (ret)
1561		goto release_mem;
1562
1563	mxt_update_crc(data, MXT_COMMAND_BACKUPNV, MXT_BACKUP_VALUE);
1564
1565	ret = mxt_soft_reset(data);
1566	if (ret)
1567		goto release_mem;
1568
1569	dev_info(dev, "Config successfully updated\n");
1570
1571	/* T7 config may have changed */
1572	mxt_init_t7_power_cfg(data);
1573
1574release_mem:
1575	kfree(cfg.mem);
1576release_raw:
1577	kfree(cfg.raw);
1578	return ret;
1579}
1580
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1581static void mxt_free_input_device(struct mxt_data *data)
1582{
1583	if (data->input_dev) {
1584		input_unregister_device(data->input_dev);
1585		data->input_dev = NULL;
1586	}
1587}
1588
1589static void mxt_free_object_table(struct mxt_data *data)
1590{
1591#ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
1592	video_unregister_device(&data->dbg.vdev);
1593	v4l2_device_unregister(&data->dbg.v4l2);
1594#endif
1595	data->object_table = NULL;
1596	data->info = NULL;
1597	kfree(data->raw_info_block);
1598	data->raw_info_block = NULL;
1599	kfree(data->msg_buf);
1600	data->msg_buf = NULL;
1601	data->T5_address = 0;
1602	data->T5_msg_size = 0;
1603	data->T6_reportid = 0;
1604	data->T7_address = 0;
1605	data->T71_address = 0;
1606	data->T9_reportid_min = 0;
1607	data->T9_reportid_max = 0;
1608	data->T19_reportid = 0;
1609	data->T44_address = 0;
1610	data->T100_reportid_min = 0;
1611	data->T100_reportid_max = 0;
1612	data->max_reportid = 0;
1613}
1614
1615static int mxt_parse_object_table(struct mxt_data *data,
1616				  struct mxt_object *object_table)
1617{
1618	struct i2c_client *client = data->client;
 
 
 
1619	int i;
1620	u8 reportid;
1621	u16 end_address;
1622
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1623	/* Valid Report IDs start counting from 1 */
1624	reportid = 1;
1625	data->mem_size = 0;
1626	for (i = 0; i < data->info->object_num; i++) {
1627		struct mxt_object *object = object_table + i;
1628		u8 min_id, max_id;
1629
1630		le16_to_cpus(&object->start_address);
1631
1632		if (object->num_report_ids) {
1633			min_id = reportid;
1634			reportid += object->num_report_ids *
1635					mxt_obj_instances(object);
1636			max_id = reportid - 1;
1637		} else {
1638			min_id = 0;
1639			max_id = 0;
1640		}
1641
1642		dev_dbg(&data->client->dev,
1643			"T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n",
1644			object->type, object->start_address,
1645			mxt_obj_size(object), mxt_obj_instances(object),
1646			min_id, max_id);
1647
1648		switch (object->type) {
1649		case MXT_GEN_MESSAGE_T5:
1650			if (data->info->family_id == 0x80 &&
1651			    data->info->version < 0x20) {
1652				/*
1653				 * On mXT224 firmware versions prior to V2.0
1654				 * read and discard unused CRC byte otherwise
1655				 * DMA reads are misaligned.
1656				 */
1657				data->T5_msg_size = mxt_obj_size(object);
1658			} else {
1659				/* CRC not enabled, so skip last byte */
1660				data->T5_msg_size = mxt_obj_size(object) - 1;
1661			}
1662			data->T5_address = object->start_address;
1663			break;
1664		case MXT_GEN_COMMAND_T6:
1665			data->T6_reportid = min_id;
1666			data->T6_address = object->start_address;
1667			break;
1668		case MXT_GEN_POWER_T7:
1669			data->T7_address = object->start_address;
1670			break;
1671		case MXT_SPT_DYNAMICCONFIGURATIONCONTAINER_T71:
1672			data->T71_address = object->start_address;
1673			break;
1674		case MXT_TOUCH_MULTI_T9:
1675			data->multitouch = MXT_TOUCH_MULTI_T9;
1676			/* Only handle messages from first T9 instance */
1677			data->T9_reportid_min = min_id;
1678			data->T9_reportid_max = min_id +
1679						object->num_report_ids - 1;
1680			data->num_touchids = object->num_report_ids;
1681			break;
1682		case MXT_SPT_MESSAGECOUNT_T44:
1683			data->T44_address = object->start_address;
1684			break;
1685		case MXT_SPT_GPIOPWM_T19:
1686			data->T19_reportid = min_id;
1687			break;
1688		case MXT_TOUCH_MULTITOUCHSCREEN_T100:
1689			data->multitouch = MXT_TOUCH_MULTITOUCHSCREEN_T100;
1690			data->T100_reportid_min = min_id;
1691			data->T100_reportid_max = max_id;
1692			/* first two report IDs reserved */
1693			data->num_touchids = object->num_report_ids - 2;
1694			break;
1695		}
1696
1697		end_address = object->start_address
1698			+ mxt_obj_size(object) * mxt_obj_instances(object) - 1;
1699
1700		if (end_address >= data->mem_size)
1701			data->mem_size = end_address + 1;
1702	}
1703
1704	/* Store maximum reportid */
1705	data->max_reportid = reportid;
1706
1707	/* If T44 exists, T5 position has to be directly after */
1708	if (data->T44_address && (data->T5_address != data->T44_address + 1)) {
1709		dev_err(&client->dev, "Invalid T44 position\n");
1710		return -EINVAL;
 
1711	}
1712
1713	data->msg_buf = kcalloc(data->max_reportid,
1714				data->T5_msg_size, GFP_KERNEL);
1715	if (!data->msg_buf)
1716		return -ENOMEM;
1717
1718	return 0;
1719}
1720
1721static int mxt_read_info_block(struct mxt_data *data)
1722{
1723	struct i2c_client *client = data->client;
1724	int error;
1725	size_t size;
1726	void *id_buf, *buf;
1727	uint8_t num_objects;
1728	u32 calculated_crc;
1729	u8 *crc_ptr;
1730
1731	/* If info block already allocated, free it */
1732	if (data->raw_info_block)
1733		mxt_free_object_table(data);
1734
1735	/* Read 7-byte ID information block starting at address 0 */
1736	size = sizeof(struct mxt_info);
1737	id_buf = kzalloc(size, GFP_KERNEL);
1738	if (!id_buf)
1739		return -ENOMEM;
1740
1741	error = __mxt_read_reg(client, 0, size, id_buf);
1742	if (error)
1743		goto err_free_mem;
1744
1745	/* Resize buffer to give space for rest of info block */
1746	num_objects = ((struct mxt_info *)id_buf)->object_num;
1747	size += (num_objects * sizeof(struct mxt_object))
1748		+ MXT_INFO_CHECKSUM_SIZE;
1749
1750	buf = krealloc(id_buf, size, GFP_KERNEL);
1751	if (!buf) {
1752		error = -ENOMEM;
1753		goto err_free_mem;
1754	}
1755	id_buf = buf;
1756
1757	/* Read rest of info block */
1758	error = __mxt_read_reg(client, MXT_OBJECT_START,
1759			       size - MXT_OBJECT_START,
1760			       id_buf + MXT_OBJECT_START);
1761	if (error)
1762		goto err_free_mem;
1763
1764	/* Extract & calculate checksum */
1765	crc_ptr = id_buf + size - MXT_INFO_CHECKSUM_SIZE;
1766	data->info_crc = crc_ptr[0] | (crc_ptr[1] << 8) | (crc_ptr[2] << 16);
1767
1768	calculated_crc = mxt_calculate_crc(id_buf, 0,
1769					   size - MXT_INFO_CHECKSUM_SIZE);
1770
1771	/*
1772	 * CRC mismatch can be caused by data corruption due to I2C comms
1773	 * issue or else device is not using Object Based Protocol (eg i2c-hid)
1774	 */
1775	if ((data->info_crc == 0) || (data->info_crc != calculated_crc)) {
1776		dev_err(&client->dev,
1777			"Info Block CRC error calculated=0x%06X read=0x%06X\n",
1778			calculated_crc, data->info_crc);
1779		error = -EIO;
1780		goto err_free_mem;
1781	}
1782
1783	data->raw_info_block = id_buf;
1784	data->info = (struct mxt_info *)id_buf;
1785
1786	dev_info(&client->dev,
1787		 "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n",
1788		 data->info->family_id, data->info->variant_id,
1789		 data->info->version >> 4, data->info->version & 0xf,
1790		 data->info->build, data->info->object_num);
1791
1792	/* Parse object table information */
1793	error = mxt_parse_object_table(data, id_buf + MXT_OBJECT_START);
1794	if (error) {
1795		dev_err(&client->dev, "Error %d parsing object table\n", error);
1796		mxt_free_object_table(data);
1797		goto err_free_mem;
1798	}
1799
1800	data->object_table = (struct mxt_object *)(id_buf + MXT_OBJECT_START);
1801
1802	return 0;
1803
1804err_free_mem:
1805	kfree(id_buf);
1806	return error;
1807}
1808
1809static int mxt_read_t9_resolution(struct mxt_data *data)
1810{
1811	struct i2c_client *client = data->client;
1812	int error;
1813	struct t9_range range;
1814	unsigned char orient;
1815	struct mxt_object *object;
1816
1817	object = mxt_get_object(data, MXT_TOUCH_MULTI_T9);
1818	if (!object)
1819		return -EINVAL;
1820
1821	error = __mxt_read_reg(client,
1822			       object->start_address + MXT_T9_XSIZE,
1823			       sizeof(data->xsize), &data->xsize);
1824	if (error)
1825		return error;
1826
1827	error = __mxt_read_reg(client,
1828			       object->start_address + MXT_T9_YSIZE,
1829			       sizeof(data->ysize), &data->ysize);
1830	if (error)
1831		return error;
1832
1833	error = __mxt_read_reg(client,
1834			       object->start_address + MXT_T9_RANGE,
1835			       sizeof(range), &range);
1836	if (error)
1837		return error;
1838
1839	data->max_x = get_unaligned_le16(&range.x);
1840	data->max_y = get_unaligned_le16(&range.y);
1841
1842	error =  __mxt_read_reg(client,
1843				object->start_address + MXT_T9_ORIENT,
1844				1, &orient);
1845	if (error)
1846		return error;
1847
1848	data->xy_switch = orient & MXT_T9_ORIENT_SWITCH;
1849	data->invertx = orient & MXT_T9_ORIENT_INVERTX;
1850	data->inverty = orient & MXT_T9_ORIENT_INVERTY;
1851
1852	return 0;
1853}
1854
1855static int mxt_read_t100_config(struct mxt_data *data)
1856{
1857	struct i2c_client *client = data->client;
1858	int error;
1859	struct mxt_object *object;
1860	u16 range_x, range_y;
1861	u8 cfg, tchaux;
1862	u8 aux;
1863
1864	object = mxt_get_object(data, MXT_TOUCH_MULTITOUCHSCREEN_T100);
1865	if (!object)
1866		return -EINVAL;
1867
1868	/* read touchscreen dimensions */
1869	error = __mxt_read_reg(client,
1870			       object->start_address + MXT_T100_XRANGE,
1871			       sizeof(range_x), &range_x);
1872	if (error)
1873		return error;
1874
1875	data->max_x = get_unaligned_le16(&range_x);
1876
1877	error = __mxt_read_reg(client,
1878			       object->start_address + MXT_T100_YRANGE,
1879			       sizeof(range_y), &range_y);
1880	if (error)
1881		return error;
1882
1883	data->max_y = get_unaligned_le16(&range_y);
1884
1885	error = __mxt_read_reg(client,
1886			       object->start_address + MXT_T100_XSIZE,
1887			       sizeof(data->xsize), &data->xsize);
1888	if (error)
1889		return error;
1890
1891	error = __mxt_read_reg(client,
1892			       object->start_address + MXT_T100_YSIZE,
1893			       sizeof(data->ysize), &data->ysize);
1894	if (error)
1895		return error;
1896
1897	/* read orientation config */
1898	error =  __mxt_read_reg(client,
1899				object->start_address + MXT_T100_CFG1,
1900				1, &cfg);
1901	if (error)
1902		return error;
1903
1904	data->xy_switch = cfg & MXT_T100_CFG_SWITCHXY;
1905	data->invertx = cfg & MXT_T100_CFG_INVERTX;
1906	data->inverty = cfg & MXT_T100_CFG_INVERTY;
1907
1908	/* allocate aux bytes */
1909	error =  __mxt_read_reg(client,
1910				object->start_address + MXT_T100_TCHAUX,
1911				1, &tchaux);
1912	if (error)
1913		return error;
1914
1915	aux = 6;
1916
1917	if (tchaux & MXT_T100_TCHAUX_VECT)
1918		data->t100_aux_vect = aux++;
1919
1920	if (tchaux & MXT_T100_TCHAUX_AMPL)
1921		data->t100_aux_ampl = aux++;
1922
1923	if (tchaux & MXT_T100_TCHAUX_AREA)
1924		data->t100_aux_area = aux++;
1925
1926	dev_dbg(&client->dev,
1927		"T100 aux mappings vect:%u ampl:%u area:%u\n",
1928		data->t100_aux_vect, data->t100_aux_ampl, data->t100_aux_area);
1929
1930	return 0;
1931}
1932
1933static int mxt_input_open(struct input_dev *dev);
1934static void mxt_input_close(struct input_dev *dev);
1935
1936static void mxt_set_up_as_touchpad(struct input_dev *input_dev,
1937				   struct mxt_data *data)
1938{
 
1939	int i;
1940
1941	input_dev->name = "Atmel maXTouch Touchpad";
1942
1943	__set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
1944
1945	input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM);
1946	input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM);
1947	input_abs_set_res(input_dev, ABS_MT_POSITION_X,
1948			  MXT_PIXELS_PER_MM);
1949	input_abs_set_res(input_dev, ABS_MT_POSITION_Y,
1950			  MXT_PIXELS_PER_MM);
1951
1952	for (i = 0; i < data->t19_num_keys; i++)
1953		if (data->t19_keymap[i] != KEY_RESERVED)
1954			input_set_capability(input_dev, EV_KEY,
1955					     data->t19_keymap[i]);
1956}
1957
1958static int mxt_initialize_input_device(struct mxt_data *data)
1959{
 
1960	struct device *dev = &data->client->dev;
1961	struct input_dev *input_dev;
1962	int error;
1963	unsigned int num_mt_slots;
1964	unsigned int mt_flags = 0;
1965
1966	switch (data->multitouch) {
1967	case MXT_TOUCH_MULTI_T9:
1968		num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
1969		error = mxt_read_t9_resolution(data);
1970		if (error)
1971			dev_warn(dev, "Failed to initialize T9 resolution\n");
1972		break;
1973
1974	case MXT_TOUCH_MULTITOUCHSCREEN_T100:
1975		num_mt_slots = data->num_touchids;
1976		error = mxt_read_t100_config(data);
1977		if (error)
1978			dev_warn(dev, "Failed to read T100 config\n");
1979		break;
1980
1981	default:
1982		dev_err(dev, "Invalid multitouch object\n");
1983		return -EINVAL;
1984	}
1985
1986	/* Handle default values and orientation switch */
1987	if (data->max_x == 0)
1988		data->max_x = 1023;
1989
1990	if (data->max_y == 0)
1991		data->max_y = 1023;
1992
1993	if (data->xy_switch)
1994		swap(data->max_x, data->max_y);
1995
1996	dev_info(dev, "Touchscreen size X%uY%u\n", data->max_x, data->max_y);
1997
1998	/* Register input device */
1999	input_dev = input_allocate_device();
2000	if (!input_dev)
 
2001		return -ENOMEM;
 
2002
2003	input_dev->name = "Atmel maXTouch Touchscreen";
2004	input_dev->phys = data->phys;
2005	input_dev->id.bustype = BUS_I2C;
2006	input_dev->dev.parent = dev;
2007	input_dev->open = mxt_input_open;
2008	input_dev->close = mxt_input_close;
2009
2010	input_set_capability(input_dev, EV_KEY, BTN_TOUCH);
2011
2012	/* For single touch */
2013	input_set_abs_params(input_dev, ABS_X, 0, data->max_x, 0, 0);
2014	input_set_abs_params(input_dev, ABS_Y, 0, data->max_y, 0, 0);
2015
2016	if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
2017	    (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2018	     data->t100_aux_ampl)) {
2019		input_set_abs_params(input_dev, ABS_PRESSURE, 0, 255, 0, 0);
2020	}
2021
2022	/* If device has buttons we assume it is a touchpad */
2023	if (data->t19_num_keys) {
2024		mxt_set_up_as_touchpad(input_dev, data);
2025		mt_flags |= INPUT_MT_POINTER;
2026	} else {
2027		mt_flags |= INPUT_MT_DIRECT;
2028	}
2029
2030	/* For multi touch */
2031	error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags);
2032	if (error) {
2033		dev_err(dev, "Error %d initialising slots\n", error);
2034		goto err_free_mem;
2035	}
2036
2037	if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100) {
2038		input_set_abs_params(input_dev, ABS_MT_TOOL_TYPE,
2039				     0, MT_TOOL_MAX, 0, 0);
2040		input_set_abs_params(input_dev, ABS_MT_DISTANCE,
2041				     MXT_DISTANCE_ACTIVE_TOUCH,
2042				     MXT_DISTANCE_HOVERING,
2043				     0, 0);
2044	}
2045
2046	input_set_abs_params(input_dev, ABS_MT_POSITION_X,
2047			     0, data->max_x, 0, 0);
2048	input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
2049			     0, data->max_y, 0, 0);
2050
2051	if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
2052	    (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2053	     data->t100_aux_area)) {
2054		input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
2055				     0, MXT_MAX_AREA, 0, 0);
2056	}
2057
2058	if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
2059	    (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2060	     data->t100_aux_ampl)) {
2061		input_set_abs_params(input_dev, ABS_MT_PRESSURE,
2062				     0, 255, 0, 0);
2063	}
2064
2065	if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2066	    data->t100_aux_vect) {
2067		input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
2068				     0, 255, 0, 0);
2069	}
2070
2071	if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
 
 
 
 
 
 
2072	    data->t100_aux_vect) {
2073		input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
2074				     0, 255, 0, 0);
2075	}
2076
2077	input_set_drvdata(input_dev, data);
2078
2079	error = input_register_device(input_dev);
2080	if (error) {
2081		dev_err(dev, "Error %d registering input device\n", error);
2082		goto err_free_mem;
2083	}
2084
2085	data->input_dev = input_dev;
2086
2087	return 0;
2088
2089err_free_mem:
2090	input_free_device(input_dev);
2091	return error;
2092}
2093
2094static int mxt_configure_objects(struct mxt_data *data,
2095				 const struct firmware *cfg);
2096
2097static void mxt_config_cb(const struct firmware *cfg, void *ctx)
2098{
2099	mxt_configure_objects(ctx, cfg);
2100	release_firmware(cfg);
2101}
2102
2103static int mxt_initialize(struct mxt_data *data)
2104{
2105	struct i2c_client *client = data->client;
2106	int recovery_attempts = 0;
2107	int error;
2108
2109	while (1) {
2110		error = mxt_read_info_block(data);
2111		if (!error)
2112			break;
2113
2114		/* Check bootloader state */
2115		error = mxt_probe_bootloader(data, false);
2116		if (error) {
2117			dev_info(&client->dev, "Trying alternate bootloader address\n");
2118			error = mxt_probe_bootloader(data, true);
2119			if (error) {
2120				/* Chip is not in appmode or bootloader mode */
2121				return error;
2122			}
2123		}
2124
2125		/* OK, we are in bootloader, see if we can recover */
2126		if (++recovery_attempts > 1) {
2127			dev_err(&client->dev, "Could not recover from bootloader mode\n");
2128			/*
2129			 * We can reflash from this state, so do not
2130			 * abort initialization.
2131			 */
2132			data->in_bootloader = true;
2133			return 0;
2134		}
2135
2136		/* Attempt to exit bootloader into app mode */
2137		mxt_send_bootloader_cmd(data, false);
2138		msleep(MXT_FW_RESET_TIME);
2139	}
2140
 
 
 
 
 
 
 
2141	error = mxt_acquire_irq(data);
2142	if (error)
2143		return error;
2144
2145	error = request_firmware_nowait(THIS_MODULE, true, MXT_CFG_NAME,
2146					&client->dev, GFP_KERNEL, data,
2147					mxt_config_cb);
2148	if (error) {
2149		dev_err(&client->dev, "Failed to invoke firmware loader: %d\n",
2150			error);
2151		return error;
2152	}
2153
2154	return 0;
 
 
 
 
2155}
2156
2157static int mxt_set_t7_power_cfg(struct mxt_data *data, u8 sleep)
2158{
2159	struct device *dev = &data->client->dev;
2160	int error;
2161	struct t7_config *new_config;
2162	struct t7_config deepsleep = { .active = 0, .idle = 0 };
2163
2164	if (sleep == MXT_POWER_CFG_DEEPSLEEP)
2165		new_config = &deepsleep;
2166	else
2167		new_config = &data->t7_cfg;
2168
2169	error = __mxt_write_reg(data->client, data->T7_address,
2170				sizeof(data->t7_cfg), new_config);
2171	if (error)
2172		return error;
2173
2174	dev_dbg(dev, "Set T7 ACTV:%d IDLE:%d\n",
2175		new_config->active, new_config->idle);
2176
2177	return 0;
2178}
2179
2180static int mxt_init_t7_power_cfg(struct mxt_data *data)
2181{
2182	struct device *dev = &data->client->dev;
2183	int error;
2184	bool retry = false;
2185
2186recheck:
2187	error = __mxt_read_reg(data->client, data->T7_address,
2188				sizeof(data->t7_cfg), &data->t7_cfg);
2189	if (error)
2190		return error;
2191
2192	if (data->t7_cfg.active == 0 || data->t7_cfg.idle == 0) {
2193		if (!retry) {
2194			dev_dbg(dev, "T7 cfg zero, resetting\n");
2195			mxt_soft_reset(data);
2196			retry = true;
2197			goto recheck;
2198		} else {
2199			dev_dbg(dev, "T7 cfg zero after reset, overriding\n");
2200			data->t7_cfg.active = 20;
2201			data->t7_cfg.idle = 100;
2202			return mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
2203		}
2204	}
2205
2206	dev_dbg(dev, "Initialized power cfg: ACTV %d, IDLE %d\n",
2207		data->t7_cfg.active, data->t7_cfg.idle);
2208	return 0;
2209}
2210
2211#ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
2212static const struct v4l2_file_operations mxt_video_fops = {
2213	.owner = THIS_MODULE,
2214	.open = v4l2_fh_open,
2215	.release = vb2_fop_release,
2216	.unlocked_ioctl = video_ioctl2,
2217	.read = vb2_fop_read,
2218	.mmap = vb2_fop_mmap,
2219	.poll = vb2_fop_poll,
2220};
2221
2222static u16 mxt_get_debug_value(struct mxt_data *data, unsigned int x,
2223			       unsigned int y)
2224{
2225	struct mxt_info *info = data->info;
2226	struct mxt_dbg *dbg = &data->dbg;
2227	unsigned int ofs, page;
2228	unsigned int col = 0;
2229	unsigned int col_width;
2230
2231	if (info->family_id == MXT_FAMILY_1386) {
2232		col_width = info->matrix_ysize / MXT1386_COLUMNS;
2233		col = y / col_width;
2234		y = y % col_width;
2235	} else {
2236		col_width = info->matrix_ysize;
2237	}
2238
2239	ofs = (y + (x * col_width)) * sizeof(u16);
2240	page = ofs / MXT_DIAGNOSTIC_SIZE;
2241	ofs %= MXT_DIAGNOSTIC_SIZE;
2242
2243	if (info->family_id == MXT_FAMILY_1386)
2244		page += col * MXT1386_PAGES_PER_COLUMN;
2245
2246	return get_unaligned_le16(&dbg->t37_buf[page].data[ofs]);
2247}
2248
2249static int mxt_convert_debug_pages(struct mxt_data *data, u16 *outbuf)
2250{
2251	struct mxt_dbg *dbg = &data->dbg;
2252	unsigned int x = 0;
2253	unsigned int y = 0;
2254	unsigned int i, rx, ry;
2255
2256	for (i = 0; i < dbg->t37_nodes; i++) {
2257		/* Handle orientation */
2258		rx = data->xy_switch ? y : x;
2259		ry = data->xy_switch ? x : y;
2260		rx = data->invertx ? (data->xsize - 1 - rx) : rx;
2261		ry = data->inverty ? (data->ysize - 1 - ry) : ry;
2262
2263		outbuf[i] = mxt_get_debug_value(data, rx, ry);
2264
2265		/* Next value */
2266		if (++x >= (data->xy_switch ? data->ysize : data->xsize)) {
2267			x = 0;
2268			y++;
2269		}
2270	}
2271
2272	return 0;
2273}
2274
2275static int mxt_read_diagnostic_debug(struct mxt_data *data, u8 mode,
2276				     u16 *outbuf)
2277{
2278	struct mxt_dbg *dbg = &data->dbg;
2279	int retries = 0;
2280	int page;
2281	int ret;
2282	u8 cmd = mode;
2283	struct t37_debug *p;
2284	u8 cmd_poll;
2285
2286	for (page = 0; page < dbg->t37_pages; page++) {
2287		p = dbg->t37_buf + page;
2288
2289		ret = mxt_write_reg(data->client, dbg->diag_cmd_address,
2290				    cmd);
2291		if (ret)
2292			return ret;
2293
2294		retries = 0;
2295		msleep(20);
2296wait_cmd:
2297		/* Read back command byte */
2298		ret = __mxt_read_reg(data->client, dbg->diag_cmd_address,
2299				     sizeof(cmd_poll), &cmd_poll);
2300		if (ret)
2301			return ret;
2302
2303		/* Field is cleared once the command has been processed */
2304		if (cmd_poll) {
2305			if (retries++ > 100)
2306				return -EINVAL;
2307
2308			msleep(20);
2309			goto wait_cmd;
2310		}
2311
2312		/* Read T37 page */
2313		ret = __mxt_read_reg(data->client, dbg->t37_address,
2314				     sizeof(struct t37_debug), p);
2315		if (ret)
2316			return ret;
2317
2318		if (p->mode != mode || p->page != page) {
2319			dev_err(&data->client->dev, "T37 page mismatch\n");
2320			return -EINVAL;
2321		}
2322
2323		dev_dbg(&data->client->dev, "%s page:%d retries:%d\n",
2324			__func__, page, retries);
2325
2326		/* For remaining pages, write PAGEUP rather than mode */
2327		cmd = MXT_DIAGNOSTIC_PAGEUP;
2328	}
2329
2330	return mxt_convert_debug_pages(data, outbuf);
2331}
2332
2333static int mxt_queue_setup(struct vb2_queue *q,
2334		       unsigned int *nbuffers, unsigned int *nplanes,
2335		       unsigned int sizes[], struct device *alloc_devs[])
2336{
2337	struct mxt_data *data = q->drv_priv;
2338	size_t size = data->dbg.t37_nodes * sizeof(u16);
2339
2340	if (*nplanes)
2341		return sizes[0] < size ? -EINVAL : 0;
2342
2343	*nplanes = 1;
2344	sizes[0] = size;
2345
2346	return 0;
2347}
2348
2349static void mxt_buffer_queue(struct vb2_buffer *vb)
2350{
2351	struct mxt_data *data = vb2_get_drv_priv(vb->vb2_queue);
2352	u16 *ptr;
2353	int ret;
2354	u8 mode;
2355
2356	ptr = vb2_plane_vaddr(vb, 0);
2357	if (!ptr) {
2358		dev_err(&data->client->dev, "Error acquiring frame ptr\n");
2359		goto fault;
2360	}
2361
2362	switch (data->dbg.input) {
2363	case MXT_V4L_INPUT_DELTAS:
2364	default:
2365		mode = MXT_DIAGNOSTIC_DELTAS;
2366		break;
2367
2368	case MXT_V4L_INPUT_REFS:
2369		mode = MXT_DIAGNOSTIC_REFS;
2370		break;
2371	}
2372
2373	ret = mxt_read_diagnostic_debug(data, mode, ptr);
2374	if (ret)
2375		goto fault;
2376
2377	vb2_set_plane_payload(vb, 0, data->dbg.t37_nodes * sizeof(u16));
2378	vb2_buffer_done(vb, VB2_BUF_STATE_DONE);
2379	return;
2380
2381fault:
2382	vb2_buffer_done(vb, VB2_BUF_STATE_ERROR);
2383}
2384
2385/* V4L2 structures */
2386static const struct vb2_ops mxt_queue_ops = {
2387	.queue_setup		= mxt_queue_setup,
2388	.buf_queue		= mxt_buffer_queue,
2389	.wait_prepare		= vb2_ops_wait_prepare,
2390	.wait_finish		= vb2_ops_wait_finish,
2391};
2392
2393static const struct vb2_queue mxt_queue = {
2394	.type = V4L2_BUF_TYPE_VIDEO_CAPTURE,
2395	.io_modes = VB2_MMAP | VB2_USERPTR | VB2_DMABUF | VB2_READ,
2396	.buf_struct_size = sizeof(struct mxt_vb2_buffer),
2397	.ops = &mxt_queue_ops,
2398	.mem_ops = &vb2_vmalloc_memops,
2399	.timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC,
2400	.min_buffers_needed = 1,
2401};
2402
2403static int mxt_vidioc_querycap(struct file *file, void *priv,
2404				 struct v4l2_capability *cap)
2405{
2406	struct mxt_data *data = video_drvdata(file);
2407
2408	strlcpy(cap->driver, "atmel_mxt_ts", sizeof(cap->driver));
2409	strlcpy(cap->card, "atmel_mxt_ts touch", sizeof(cap->card));
2410	snprintf(cap->bus_info, sizeof(cap->bus_info),
2411		 "I2C:%s", dev_name(&data->client->dev));
2412	return 0;
2413}
2414
2415static int mxt_vidioc_enum_input(struct file *file, void *priv,
2416				   struct v4l2_input *i)
2417{
2418	if (i->index >= MXT_V4L_INPUT_MAX)
2419		return -EINVAL;
2420
2421	i->type = V4L2_INPUT_TYPE_TOUCH;
2422
2423	switch (i->index) {
2424	case MXT_V4L_INPUT_REFS:
2425		strlcpy(i->name, "Mutual Capacitance References",
2426			sizeof(i->name));
2427		break;
2428	case MXT_V4L_INPUT_DELTAS:
2429		strlcpy(i->name, "Mutual Capacitance Deltas", sizeof(i->name));
2430		break;
2431	}
2432
2433	return 0;
2434}
2435
2436static int mxt_set_input(struct mxt_data *data, unsigned int i)
2437{
2438	struct v4l2_pix_format *f = &data->dbg.format;
2439
2440	if (i >= MXT_V4L_INPUT_MAX)
2441		return -EINVAL;
2442
2443	if (i == MXT_V4L_INPUT_DELTAS)
2444		f->pixelformat = V4L2_TCH_FMT_DELTA_TD16;
2445	else
2446		f->pixelformat = V4L2_TCH_FMT_TU16;
2447
2448	f->width = data->xy_switch ? data->ysize : data->xsize;
2449	f->height = data->xy_switch ? data->xsize : data->ysize;
2450	f->field = V4L2_FIELD_NONE;
2451	f->colorspace = V4L2_COLORSPACE_RAW;
2452	f->bytesperline = f->width * sizeof(u16);
2453	f->sizeimage = f->width * f->height * sizeof(u16);
2454
2455	data->dbg.input = i;
2456
2457	return 0;
2458}
2459
2460static int mxt_vidioc_s_input(struct file *file, void *priv, unsigned int i)
2461{
2462	return mxt_set_input(video_drvdata(file), i);
2463}
2464
2465static int mxt_vidioc_g_input(struct file *file, void *priv, unsigned int *i)
2466{
2467	struct mxt_data *data = video_drvdata(file);
2468
2469	*i = data->dbg.input;
2470
2471	return 0;
2472}
2473
2474static int mxt_vidioc_fmt(struct file *file, void *priv, struct v4l2_format *f)
2475{
2476	struct mxt_data *data = video_drvdata(file);
2477
2478	f->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
2479	f->fmt.pix = data->dbg.format;
2480
2481	return 0;
2482}
2483
2484static int mxt_vidioc_enum_fmt(struct file *file, void *priv,
2485				 struct v4l2_fmtdesc *fmt)
2486{
2487	if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
2488		return -EINVAL;
2489
2490	switch (fmt->index) {
2491	case 0:
2492		fmt->pixelformat = V4L2_TCH_FMT_TU16;
2493		break;
2494
2495	case 1:
2496		fmt->pixelformat = V4L2_TCH_FMT_DELTA_TD16;
2497		break;
2498
2499	default:
2500		return -EINVAL;
2501	}
2502
2503	return 0;
2504}
2505
2506static int mxt_vidioc_g_parm(struct file *file, void *fh,
2507			     struct v4l2_streamparm *a)
2508{
2509	if (a->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
2510		return -EINVAL;
2511
2512	a->parm.capture.readbuffers = 1;
2513	a->parm.capture.timeperframe.numerator = 1;
2514	a->parm.capture.timeperframe.denominator = 10;
2515	return 0;
2516}
2517
2518static const struct v4l2_ioctl_ops mxt_video_ioctl_ops = {
2519	.vidioc_querycap        = mxt_vidioc_querycap,
2520
2521	.vidioc_enum_fmt_vid_cap = mxt_vidioc_enum_fmt,
2522	.vidioc_s_fmt_vid_cap   = mxt_vidioc_fmt,
2523	.vidioc_g_fmt_vid_cap   = mxt_vidioc_fmt,
2524	.vidioc_try_fmt_vid_cap	= mxt_vidioc_fmt,
2525	.vidioc_g_parm		= mxt_vidioc_g_parm,
2526
2527	.vidioc_enum_input      = mxt_vidioc_enum_input,
2528	.vidioc_g_input         = mxt_vidioc_g_input,
2529	.vidioc_s_input         = mxt_vidioc_s_input,
2530
2531	.vidioc_reqbufs         = vb2_ioctl_reqbufs,
2532	.vidioc_create_bufs     = vb2_ioctl_create_bufs,
2533	.vidioc_querybuf        = vb2_ioctl_querybuf,
2534	.vidioc_qbuf            = vb2_ioctl_qbuf,
2535	.vidioc_dqbuf           = vb2_ioctl_dqbuf,
2536	.vidioc_expbuf          = vb2_ioctl_expbuf,
2537
2538	.vidioc_streamon        = vb2_ioctl_streamon,
2539	.vidioc_streamoff       = vb2_ioctl_streamoff,
2540};
2541
2542static const struct video_device mxt_video_device = {
2543	.name = "Atmel maxTouch",
2544	.fops = &mxt_video_fops,
2545	.ioctl_ops = &mxt_video_ioctl_ops,
2546	.release = video_device_release_empty,
2547	.device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_TOUCH |
2548		       V4L2_CAP_READWRITE | V4L2_CAP_STREAMING,
2549};
2550
2551static void mxt_debug_init(struct mxt_data *data)
2552{
2553	struct mxt_info *info = data->info;
2554	struct mxt_dbg *dbg = &data->dbg;
2555	struct mxt_object *object;
2556	int error;
2557
2558	object = mxt_get_object(data, MXT_GEN_COMMAND_T6);
2559	if (!object)
2560		goto error;
2561
2562	dbg->diag_cmd_address = object->start_address + MXT_COMMAND_DIAGNOSTIC;
2563
2564	object = mxt_get_object(data, MXT_DEBUG_DIAGNOSTIC_T37);
2565	if (!object)
2566		goto error;
2567
2568	if (mxt_obj_size(object) != sizeof(struct t37_debug)) {
2569		dev_warn(&data->client->dev, "Bad T37 size");
2570		goto error;
2571	}
2572
2573	dbg->t37_address = object->start_address;
2574
2575	/* Calculate size of data and allocate buffer */
2576	dbg->t37_nodes = data->xsize * data->ysize;
2577
2578	if (info->family_id == MXT_FAMILY_1386)
2579		dbg->t37_pages = MXT1386_COLUMNS * MXT1386_PAGES_PER_COLUMN;
2580	else
2581		dbg->t37_pages = DIV_ROUND_UP(data->xsize *
2582					      info->matrix_ysize *
2583					      sizeof(u16),
2584					      sizeof(dbg->t37_buf->data));
2585
2586	dbg->t37_buf = devm_kmalloc_array(&data->client->dev, dbg->t37_pages,
2587					  sizeof(struct t37_debug), GFP_KERNEL);
2588	if (!dbg->t37_buf)
2589		goto error;
2590
2591	/* init channel to zero */
2592	mxt_set_input(data, 0);
2593
2594	/* register video device */
2595	snprintf(dbg->v4l2.name, sizeof(dbg->v4l2.name), "%s", "atmel_mxt_ts");
2596	error = v4l2_device_register(&data->client->dev, &dbg->v4l2);
2597	if (error)
2598		goto error;
2599
2600	/* initialize the queue */
2601	mutex_init(&dbg->lock);
2602	dbg->queue = mxt_queue;
2603	dbg->queue.drv_priv = data;
2604	dbg->queue.lock = &dbg->lock;
2605	dbg->queue.dev = &data->client->dev;
2606
2607	error = vb2_queue_init(&dbg->queue);
2608	if (error)
2609		goto error_unreg_v4l2;
2610
2611	dbg->vdev = mxt_video_device;
2612	dbg->vdev.v4l2_dev = &dbg->v4l2;
2613	dbg->vdev.lock = &dbg->lock;
2614	dbg->vdev.vfl_dir = VFL_DIR_RX;
2615	dbg->vdev.queue = &dbg->queue;
2616	video_set_drvdata(&dbg->vdev, data);
2617
2618	error = video_register_device(&dbg->vdev, VFL_TYPE_TOUCH, -1);
2619	if (error)
2620		goto error_unreg_v4l2;
2621
2622	return;
2623
2624error_unreg_v4l2:
2625	v4l2_device_unregister(&dbg->v4l2);
2626error:
2627	dev_warn(&data->client->dev, "Error initializing T37\n");
2628}
2629#else
2630static void mxt_debug_init(struct mxt_data *data)
2631{
2632}
2633#endif
2634
2635static int mxt_configure_objects(struct mxt_data *data,
2636				 const struct firmware *cfg)
2637{
2638	struct device *dev = &data->client->dev;
 
2639	int error;
2640
2641	error = mxt_init_t7_power_cfg(data);
2642	if (error) {
2643		dev_err(dev, "Failed to initialize power cfg\n");
2644		return error;
2645	}
2646
2647	if (cfg) {
2648		error = mxt_update_cfg(data, cfg);
2649		if (error)
2650			dev_warn(dev, "Error %d updating config\n", error);
2651	}
2652
2653	if (data->multitouch) {
2654		error = mxt_initialize_input_device(data);
2655		if (error)
2656			return error;
2657	} else {
2658		dev_warn(dev, "No touch object detected\n");
2659	}
2660
2661	mxt_debug_init(data);
 
 
 
2662
2663	return 0;
2664}
2665
2666/* Firmware Version is returned as Major.Minor.Build */
2667static ssize_t mxt_fw_version_show(struct device *dev,
2668				   struct device_attribute *attr, char *buf)
2669{
2670	struct mxt_data *data = dev_get_drvdata(dev);
2671	struct mxt_info *info = data->info;
2672	return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
2673			 info->version >> 4, info->version & 0xf, info->build);
2674}
2675
2676/* Hardware Version is returned as FamilyID.VariantID */
2677static ssize_t mxt_hw_version_show(struct device *dev,
2678				   struct device_attribute *attr, char *buf)
2679{
2680	struct mxt_data *data = dev_get_drvdata(dev);
2681	struct mxt_info *info = data->info;
2682	return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
2683			 info->family_id, info->variant_id);
2684}
2685
2686static ssize_t mxt_show_instance(char *buf, int count,
2687				 struct mxt_object *object, int instance,
2688				 const u8 *val)
2689{
2690	int i;
2691
2692	if (mxt_obj_instances(object) > 1)
2693		count += scnprintf(buf + count, PAGE_SIZE - count,
2694				   "Instance %u\n", instance);
2695
2696	for (i = 0; i < mxt_obj_size(object); i++)
2697		count += scnprintf(buf + count, PAGE_SIZE - count,
2698				"\t[%2u]: %02x (%d)\n", i, val[i], val[i]);
2699	count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
2700
2701	return count;
2702}
2703
2704static ssize_t mxt_object_show(struct device *dev,
2705				    struct device_attribute *attr, char *buf)
2706{
2707	struct mxt_data *data = dev_get_drvdata(dev);
2708	struct mxt_object *object;
2709	int count = 0;
2710	int i, j;
2711	int error;
2712	u8 *obuf;
2713
2714	/* Pre-allocate buffer large enough to hold max sized object. */
2715	obuf = kmalloc(256, GFP_KERNEL);
2716	if (!obuf)
2717		return -ENOMEM;
2718
2719	error = 0;
2720	for (i = 0; i < data->info->object_num; i++) {
2721		object = data->object_table + i;
2722
2723		if (!mxt_object_readable(object->type))
2724			continue;
2725
2726		count += scnprintf(buf + count, PAGE_SIZE - count,
2727				"T%u:\n", object->type);
2728
2729		for (j = 0; j < mxt_obj_instances(object); j++) {
2730			u16 size = mxt_obj_size(object);
2731			u16 addr = object->start_address + j * size;
2732
2733			error = __mxt_read_reg(data->client, addr, size, obuf);
2734			if (error)
2735				goto done;
2736
2737			count = mxt_show_instance(buf, count, object, j, obuf);
2738		}
2739	}
2740
2741done:
2742	kfree(obuf);
2743	return error ?: count;
2744}
2745
2746static int mxt_check_firmware_format(struct device *dev,
2747				     const struct firmware *fw)
2748{
2749	unsigned int pos = 0;
2750	char c;
2751
2752	while (pos < fw->size) {
2753		c = *(fw->data + pos);
2754
2755		if (c < '0' || (c > '9' && c < 'A') || c > 'F')
2756			return 0;
2757
2758		pos++;
2759	}
2760
2761	/*
2762	 * To convert file try:
2763	 * xxd -r -p mXTXXX__APP_VX-X-XX.enc > maxtouch.fw
2764	 */
2765	dev_err(dev, "Aborting: firmware file must be in binary format\n");
2766
2767	return -EINVAL;
2768}
2769
2770static int mxt_load_fw(struct device *dev, const char *fn)
2771{
2772	struct mxt_data *data = dev_get_drvdata(dev);
2773	const struct firmware *fw = NULL;
2774	unsigned int frame_size;
2775	unsigned int pos = 0;
2776	unsigned int retry = 0;
2777	unsigned int frame = 0;
2778	int ret;
2779
2780	ret = request_firmware(&fw, fn, dev);
2781	if (ret) {
2782		dev_err(dev, "Unable to open firmware %s\n", fn);
2783		return ret;
2784	}
2785
2786	/* Check for incorrect enc file */
2787	ret = mxt_check_firmware_format(dev, fw);
2788	if (ret)
2789		goto release_firmware;
2790
2791	if (!data->in_bootloader) {
2792		/* Change to the bootloader mode */
2793		data->in_bootloader = true;
2794
2795		ret = mxt_t6_command(data, MXT_COMMAND_RESET,
2796				     MXT_BOOT_VALUE, false);
2797		if (ret)
2798			goto release_firmware;
2799
2800		msleep(MXT_RESET_TIME);
2801
2802		/* Do not need to scan since we know family ID */
2803		ret = mxt_lookup_bootloader_address(data, 0);
2804		if (ret)
2805			goto release_firmware;
2806
2807		mxt_free_input_device(data);
2808		mxt_free_object_table(data);
2809	} else {
2810		enable_irq(data->irq);
2811	}
2812
2813	reinit_completion(&data->bl_completion);
2814
2815	ret = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD, false);
2816	if (ret) {
2817		/* Bootloader may still be unlocked from previous attempt */
2818		ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, false);
2819		if (ret)
2820			goto disable_irq;
2821	} else {
2822		dev_info(dev, "Unlocking bootloader\n");
2823
2824		/* Unlock bootloader */
2825		ret = mxt_send_bootloader_cmd(data, true);
2826		if (ret)
2827			goto disable_irq;
2828	}
2829
2830	while (pos < fw->size) {
2831		ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, true);
2832		if (ret)
2833			goto disable_irq;
2834
2835		frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
2836
2837		/* Take account of CRC bytes */
2838		frame_size += 2;
2839
2840		/* Write one frame to device */
2841		ret = mxt_bootloader_write(data, fw->data + pos, frame_size);
2842		if (ret)
2843			goto disable_irq;
2844
2845		ret = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS, true);
2846		if (ret) {
2847			retry++;
2848
2849			/* Back off by 20ms per retry */
2850			msleep(retry * 20);
2851
2852			if (retry > 20) {
2853				dev_err(dev, "Retry count exceeded\n");
2854				goto disable_irq;
2855			}
2856		} else {
2857			retry = 0;
2858			pos += frame_size;
2859			frame++;
2860		}
2861
2862		if (frame % 50 == 0)
2863			dev_dbg(dev, "Sent %d frames, %d/%zd bytes\n",
2864				frame, pos, fw->size);
2865	}
2866
2867	/* Wait for flash. */
2868	ret = mxt_wait_for_completion(data, &data->bl_completion,
2869				      MXT_FW_RESET_TIME);
2870	if (ret)
2871		goto disable_irq;
2872
2873	dev_dbg(dev, "Sent %d frames, %d bytes\n", frame, pos);
2874
2875	/*
2876	 * Wait for device to reset. Some bootloader versions do not assert
2877	 * the CHG line after bootloading has finished, so ignore potential
2878	 * errors.
2879	 */
2880	mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME);
2881
2882	data->in_bootloader = false;
2883
2884disable_irq:
2885	disable_irq(data->irq);
2886release_firmware:
2887	release_firmware(fw);
2888	return ret;
2889}
2890
2891static ssize_t mxt_update_fw_store(struct device *dev,
2892					struct device_attribute *attr,
2893					const char *buf, size_t count)
2894{
2895	struct mxt_data *data = dev_get_drvdata(dev);
2896	int error;
2897
2898	error = mxt_load_fw(dev, MXT_FW_NAME);
2899	if (error) {
2900		dev_err(dev, "The firmware update failed(%d)\n", error);
2901		count = error;
2902	} else {
2903		dev_info(dev, "The firmware update succeeded\n");
2904
2905		error = mxt_initialize(data);
2906		if (error)
2907			return error;
2908	}
2909
2910	return count;
2911}
2912
2913static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
2914static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
2915static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
2916static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
2917
2918static struct attribute *mxt_attrs[] = {
2919	&dev_attr_fw_version.attr,
2920	&dev_attr_hw_version.attr,
2921	&dev_attr_object.attr,
2922	&dev_attr_update_fw.attr,
2923	NULL
2924};
2925
2926static const struct attribute_group mxt_attr_group = {
2927	.attrs = mxt_attrs,
2928};
2929
2930static void mxt_start(struct mxt_data *data)
2931{
2932	switch (data->suspend_mode) {
2933	case MXT_SUSPEND_T9_CTRL:
2934		mxt_soft_reset(data);
2935
2936		/* Touch enable */
2937		/* 0x83 = SCANEN | RPTEN | ENABLE */
2938		mxt_write_object(data,
2939				MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0x83);
2940		break;
2941
2942	case MXT_SUSPEND_DEEP_SLEEP:
2943	default:
2944		mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
2945
2946		/* Recalibrate since chip has been in deep sleep */
2947		mxt_t6_command(data, MXT_COMMAND_CALIBRATE, 1, false);
2948		break;
2949	}
 
2950}
2951
2952static void mxt_stop(struct mxt_data *data)
2953{
2954	switch (data->suspend_mode) {
2955	case MXT_SUSPEND_T9_CTRL:
2956		/* Touch disable */
2957		mxt_write_object(data,
2958				MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0);
2959		break;
2960
2961	case MXT_SUSPEND_DEEP_SLEEP:
2962	default:
2963		mxt_set_t7_power_cfg(data, MXT_POWER_CFG_DEEPSLEEP);
2964		break;
2965	}
2966}
2967
2968static int mxt_input_open(struct input_dev *dev)
2969{
2970	struct mxt_data *data = input_get_drvdata(dev);
2971
2972	mxt_start(data);
2973
2974	return 0;
2975}
2976
2977static void mxt_input_close(struct input_dev *dev)
2978{
2979	struct mxt_data *data = input_get_drvdata(dev);
2980
2981	mxt_stop(data);
2982}
2983
2984static int mxt_parse_device_properties(struct mxt_data *data)
 
2985{
2986	static const char keymap_property[] = "linux,gpio-keymap";
2987	struct device *dev = &data->client->dev;
2988	u32 *keymap;
2989	int n_keys;
2990	int error;
 
 
 
 
 
 
2991
2992	if (device_property_present(dev, keymap_property)) {
2993		n_keys = device_property_count_u32(dev, keymap_property);
2994		if (n_keys <= 0) {
2995			error = n_keys < 0 ? n_keys : -EINVAL;
2996			dev_err(dev, "invalid/malformed '%s' property: %d\n",
2997				keymap_property, error);
2998			return error;
2999		}
3000
3001		keymap = devm_kmalloc_array(dev, n_keys, sizeof(*keymap),
3002					    GFP_KERNEL);
 
3003		if (!keymap)
3004			return -ENOMEM;
3005
3006		error = device_property_read_u32_array(dev, keymap_property,
3007						       keymap, n_keys);
3008		if (error) {
3009			dev_err(dev, "failed to parse '%s' property: %d\n",
3010				keymap_property, error);
3011			return error;
3012		}
3013
3014		data->t19_keymap = keymap;
3015		data->t19_num_keys = n_keys;
3016	}
3017
3018	return 0;
 
 
 
 
 
 
 
3019}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3020
3021static const struct dmi_system_id chromebook_T9_suspend_dmi[] = {
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3022	{
 
 
 
 
 
 
 
 
 
 
3023		.matches = {
3024			DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
3025			DMI_MATCH(DMI_PRODUCT_NAME, "Link"),
3026		},
 
3027	},
3028	{
 
 
3029		.matches = {
3030			DMI_MATCH(DMI_PRODUCT_NAME, "Peppy"),
3031		},
 
3032	},
3033	{ }
3034};
3035
3036static int mxt_probe(struct i2c_client *client, const struct i2c_device_id *id)
3037{
3038	struct mxt_data *data;
3039	int error;
3040
3041	/*
3042	 * Ignore devices that do not have device properties attached to
3043	 * them, as we need help determining whether we are dealing with
3044	 * touch screen or touchpad.
3045	 *
3046	 * So far on x86 the only users of Atmel touch controllers are
3047	 * Chromebooks, and chromeos_laptop driver will ensure that
3048	 * necessary properties are provided (if firmware does not do that).
3049	 */
3050	if (!device_property_present(&client->dev, "compatible"))
3051		return -ENXIO;
3052
3053	/*
3054	 * Ignore ACPI devices representing bootloader mode.
3055	 *
3056	 * This is a bit of a hack: Google Chromebook BIOS creates ACPI
3057	 * devices for both application and bootloader modes, but we are
3058	 * interested in application mode only (if device is in bootloader
3059	 * mode we'll end up switching into application anyway). So far
3060	 * application mode addresses were all above 0x40, so we'll use it
3061	 * as a threshold.
3062	 */
3063	if (ACPI_COMPANION(&client->dev) && client->addr < 0x40)
3064		return -ENXIO;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3065
3066	data = devm_kzalloc(&client->dev, sizeof(struct mxt_data), GFP_KERNEL);
3067	if (!data)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3068		return -ENOMEM;
 
3069
3070	snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
3071		 client->adapter->nr, client->addr);
3072
3073	data->client = client;
 
3074	data->irq = client->irq;
3075	i2c_set_clientdata(client, data);
3076
3077	init_completion(&data->bl_completion);
3078	init_completion(&data->reset_completion);
3079	init_completion(&data->crc_completion);
3080
3081	data->suspend_mode = dmi_check_system(chromebook_T9_suspend_dmi) ?
3082		MXT_SUSPEND_T9_CTRL : MXT_SUSPEND_DEEP_SLEEP;
3083
3084	error = mxt_parse_device_properties(data);
3085	if (error)
3086		return error;
3087
3088	data->reset_gpio = devm_gpiod_get_optional(&client->dev,
3089						   "reset", GPIOD_OUT_LOW);
3090	if (IS_ERR(data->reset_gpio)) {
3091		error = PTR_ERR(data->reset_gpio);
3092		dev_err(&client->dev, "Failed to get reset gpio: %d\n", error);
3093		return error;
3094	}
3095
3096	error = devm_request_threaded_irq(&client->dev, client->irq,
3097					  NULL, mxt_interrupt, IRQF_ONESHOT,
3098					  client->name, data);
3099	if (error) {
3100		dev_err(&client->dev, "Failed to register interrupt\n");
3101		return error;
3102	}
3103
3104	disable_irq(client->irq);
3105
3106	if (data->reset_gpio) {
3107		msleep(MXT_RESET_GPIO_TIME);
3108		gpiod_set_value(data->reset_gpio, 1);
3109		msleep(MXT_RESET_INVALID_CHG);
3110	}
3111
3112	error = mxt_initialize(data);
3113	if (error)
3114		return error;
3115
3116	error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
3117	if (error) {
3118		dev_err(&client->dev, "Failure %d creating sysfs group\n",
3119			error);
3120		goto err_free_object;
3121	}
3122
3123	return 0;
3124
3125err_free_object:
3126	mxt_free_input_device(data);
3127	mxt_free_object_table(data);
 
 
 
 
3128	return error;
3129}
3130
3131static int mxt_remove(struct i2c_client *client)
3132{
3133	struct mxt_data *data = i2c_get_clientdata(client);
3134
3135	disable_irq(data->irq);
3136	sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
 
3137	mxt_free_input_device(data);
3138	mxt_free_object_table(data);
 
3139
3140	return 0;
3141}
3142
3143static int __maybe_unused mxt_suspend(struct device *dev)
3144{
3145	struct i2c_client *client = to_i2c_client(dev);
3146	struct mxt_data *data = i2c_get_clientdata(client);
3147	struct input_dev *input_dev = data->input_dev;
3148
3149	if (!input_dev)
3150		return 0;
3151
3152	mutex_lock(&input_dev->mutex);
3153
3154	if (input_dev->users)
3155		mxt_stop(data);
3156
3157	mutex_unlock(&input_dev->mutex);
3158
3159	return 0;
3160}
3161
3162static int __maybe_unused mxt_resume(struct device *dev)
3163{
3164	struct i2c_client *client = to_i2c_client(dev);
3165	struct mxt_data *data = i2c_get_clientdata(client);
3166	struct input_dev *input_dev = data->input_dev;
3167
3168	if (!input_dev)
3169		return 0;
3170
3171	mutex_lock(&input_dev->mutex);
3172
3173	if (input_dev->users)
3174		mxt_start(data);
3175
3176	mutex_unlock(&input_dev->mutex);
3177
3178	return 0;
3179}
3180
3181static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);
3182
3183static const struct of_device_id mxt_of_match[] = {
3184	{ .compatible = "atmel,maxtouch", },
3185	/* Compatibles listed below are deprecated */
3186	{ .compatible = "atmel,qt602240_ts", },
3187	{ .compatible = "atmel,atmel_mxt_ts", },
3188	{ .compatible = "atmel,atmel_mxt_tp", },
3189	{ .compatible = "atmel,mXT224", },
3190	{},
3191};
3192MODULE_DEVICE_TABLE(of, mxt_of_match);
3193
3194#ifdef CONFIG_ACPI
3195static const struct acpi_device_id mxt_acpi_id[] = {
3196	{ "ATML0000", 0 },	/* Touchpad */
3197	{ "ATML0001", 0 },	/* Touchscreen */
3198	{ }
3199};
3200MODULE_DEVICE_TABLE(acpi, mxt_acpi_id);
3201#endif
3202
3203static const struct i2c_device_id mxt_id[] = {
3204	{ "qt602240_ts", 0 },
3205	{ "atmel_mxt_ts", 0 },
3206	{ "atmel_mxt_tp", 0 },
3207	{ "maxtouch", 0 },
3208	{ "mXT224", 0 },
3209	{ }
3210};
3211MODULE_DEVICE_TABLE(i2c, mxt_id);
3212
3213static struct i2c_driver mxt_driver = {
3214	.driver = {
3215		.name	= "atmel_mxt_ts",
3216		.of_match_table = mxt_of_match,
3217		.acpi_match_table = ACPI_PTR(mxt_acpi_id),
3218		.pm	= &mxt_pm_ops,
3219	},
3220	.probe		= mxt_probe,
3221	.remove		= mxt_remove,
3222	.id_table	= mxt_id,
3223};
3224
3225module_i2c_driver(mxt_driver);
3226
3227/* Module information */
3228MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
3229MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
3230MODULE_LICENSE("GPL");