atmel_mxt_ts.c 26.6 KB
Newer Older
1
/*
2
 * Atmel maXTouch Touchscreen driver
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
 *
 * Copyright (C) 2010 Samsung Electronics Co.Ltd
 * Author: Joonyoung Shim <jy0922.shim@samsung.com>
 *
 * This program is free software; you can redistribute  it and/or modify it
 * under  the terms of  the GNU General  Public License as published by the
 * Free Software Foundation;  either version 2 of the  License, or (at your
 * option) any later version.
 *
 */

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

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

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

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

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

48
#define MXT_OBJECT_SIZE		6
49 50

/* Object types */
51 52 53 54 55 56 57 58 59 60 61 62
#define MXT_DEBUG_DIAGNOSTIC	37
#define MXT_GEN_MESSAGE		5
#define MXT_GEN_COMMAND		6
#define MXT_GEN_POWER		7
#define MXT_GEN_ACQUIRE		8
#define MXT_TOUCH_MULTI		9
#define MXT_TOUCH_KEYARRAY	15
#define MXT_TOUCH_PROXIMITY	23
#define MXT_PROCI_GRIPFACE	20
#define MXT_PROCG_NOISE		22
#define MXT_PROCI_ONETOUCH	24
#define MXT_PROCI_TWOTOUCH	27
63
#define MXT_SPT_COMMSCONFIG	18
64 65 66
#define MXT_SPT_GPIOPWM		19
#define MXT_SPT_SELFTEST	25
#define MXT_SPT_CTECONFIG	28
67
#define MXT_SPT_USERDATA	38
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117

/* MXT_GEN_COMMAND field */
#define MXT_COMMAND_RESET	0
#define MXT_COMMAND_BACKUPNV	1
#define MXT_COMMAND_CALIBRATE	2
#define MXT_COMMAND_REPORTALL	3
#define MXT_COMMAND_DIAGNOSTIC	5

/* MXT_GEN_POWER field */
#define MXT_POWER_IDLEACQINT	0
#define MXT_POWER_ACTVACQINT	1
#define MXT_POWER_ACTV2IDLETO	2

/* MXT_GEN_ACQUIRE field */
#define MXT_ACQUIRE_CHRGTIME	0
#define MXT_ACQUIRE_TCHDRIFT	2
#define MXT_ACQUIRE_DRIFTST	3
#define MXT_ACQUIRE_TCHAUTOCAL	4
#define MXT_ACQUIRE_SYNC	5
#define MXT_ACQUIRE_ATCHCALST	6
#define MXT_ACQUIRE_ATCHCALSTHR	7

/* MXT_TOUCH_MULTI field */
#define MXT_TOUCH_CTRL		0
#define MXT_TOUCH_XORIGIN	1
#define MXT_TOUCH_YORIGIN	2
#define MXT_TOUCH_XSIZE		3
#define MXT_TOUCH_YSIZE		4
#define MXT_TOUCH_BLEN		6
#define MXT_TOUCH_TCHTHR	7
#define MXT_TOUCH_TCHDI		8
#define MXT_TOUCH_ORIENT	9
#define MXT_TOUCH_MOVHYSTI	11
#define MXT_TOUCH_MOVHYSTN	12
#define MXT_TOUCH_NUMTOUCH	14
#define MXT_TOUCH_MRGHYST	15
#define MXT_TOUCH_MRGTHR	16
#define MXT_TOUCH_AMPHYST	17
#define MXT_TOUCH_XRANGE_LSB	18
#define MXT_TOUCH_XRANGE_MSB	19
#define MXT_TOUCH_YRANGE_LSB	20
#define MXT_TOUCH_YRANGE_MSB	21
#define MXT_TOUCH_XLOCLIP	22
#define MXT_TOUCH_XHICLIP	23
#define MXT_TOUCH_YLOCLIP	24
#define MXT_TOUCH_YHICLIP	25
#define MXT_TOUCH_XEDGECTRL	26
#define MXT_TOUCH_XEDGEDIST	27
#define MXT_TOUCH_YEDGECTRL	28
#define MXT_TOUCH_YEDGEDIST	29
118
#define MXT_TOUCH_JUMPLIMIT	30
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159

/* MXT_PROCI_GRIPFACE field */
#define MXT_GRIPFACE_CTRL	0
#define MXT_GRIPFACE_XLOGRIP	1
#define MXT_GRIPFACE_XHIGRIP	2
#define MXT_GRIPFACE_YLOGRIP	3
#define MXT_GRIPFACE_YHIGRIP	4
#define MXT_GRIPFACE_MAXTCHS	5
#define MXT_GRIPFACE_SZTHR1	7
#define MXT_GRIPFACE_SZTHR2	8
#define MXT_GRIPFACE_SHPTHR1	9
#define MXT_GRIPFACE_SHPTHR2	10
#define MXT_GRIPFACE_SUPEXTTO	11

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

/* MXT_SPT_COMMSCONFIG */
#define MXT_COMMS_CTRL		0
#define MXT_COMMS_CMD		1

/* MXT_SPT_CTECONFIG field */
#define MXT_CTE_CTRL		0
#define MXT_CTE_CMD		1
#define MXT_CTE_MODE		2
#define MXT_CTE_IDLEGCAFDEPTH	3
#define MXT_CTE_ACTVGCAFDEPTH	4
160
#define MXT_CTE_VOLTAGE		5
161 162 163 164 165 166 167 168 169 170 171

#define MXT_VOLTAGE_DEFAULT	2700000
#define MXT_VOLTAGE_STEP	10000

/* Define for MXT_GEN_COMMAND */
#define MXT_BOOT_VALUE		0xa5
#define MXT_BACKUP_VALUE	0x55
#define MXT_BACKUP_TIME		25	/* msec */
#define MXT_RESET_TIME		65	/* msec */

#define MXT_FWRESET_TIME	175	/* msec */
172 173

/* Command to unlock bootloader */
174 175
#define MXT_UNLOCK_CMD_MSB	0xaa
#define MXT_UNLOCK_CMD_LSB	0xdc
176 177

/* Bootloader mode status */
178 179 180 181 182 183 184
#define MXT_WAITING_BOOTLOAD_CMD	0xc0	/* valid 7 6 bit only */
#define MXT_WAITING_FRAME_DATA	0x80	/* valid 7 6 bit only */
#define MXT_FRAME_CRC_CHECK	0x02
#define MXT_FRAME_CRC_FAIL	0x03
#define MXT_FRAME_CRC_PASS	0x04
#define MXT_APP_CRC_FAIL	0x40	/* valid 7 8 bit only */
#define MXT_BOOT_STATUS_MASK	0x3f
185 186

/* Touch status */
187 188 189 190 191 192 193
#define MXT_SUPPRESS		(1 << 1)
#define MXT_AMP			(1 << 2)
#define MXT_VECTOR		(1 << 3)
#define MXT_MOVE		(1 << 4)
#define MXT_RELEASE		(1 << 5)
#define MXT_PRESS		(1 << 6)
#define MXT_DETECT		(1 << 7)
194 195

/* Touchscreen absolute values */
196 197 198
#define MXT_MAX_XC		0x3ff
#define MXT_MAX_YC		0x3ff
#define MXT_MAX_AREA		0xff
199

200
#define MXT_MAX_FINGER		10
201

202
struct mxt_info {
203 204 205 206 207 208 209 210 211
	u8 family_id;
	u8 variant_id;
	u8 version;
	u8 build;
	u8 matrix_xsize;
	u8 matrix_ysize;
	u8 object_num;
};

212
struct mxt_object {
213 214 215 216 217 218 219 220 221 222
	u8 type;
	u16 start_address;
	u8 size;
	u8 instances;
	u8 num_report_ids;

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

223
struct mxt_message {
224 225 226 227 228
	u8 reportid;
	u8 message[7];
	u8 checksum;
};

229
struct mxt_finger {
230 231 232 233 234 235 236
	int status;
	int x;
	int y;
	int area;
};

/* Each client has this additional data */
237
struct mxt_data {
238 239
	struct i2c_client *client;
	struct input_dev *input_dev;
240 241 242 243
	const struct mxt_platform_data *pdata;
	struct mxt_object *object_table;
	struct mxt_info info;
	struct mxt_finger finger[MXT_MAX_FINGER];
244 245 246
	unsigned int irq;
};

247
static bool mxt_object_readable(unsigned int type)
248 249
{
	switch (type) {
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
	case MXT_GEN_MESSAGE:
	case MXT_GEN_COMMAND:
	case MXT_GEN_POWER:
	case MXT_GEN_ACQUIRE:
	case MXT_TOUCH_MULTI:
	case MXT_TOUCH_KEYARRAY:
	case MXT_TOUCH_PROXIMITY:
	case MXT_PROCI_GRIPFACE:
	case MXT_PROCG_NOISE:
	case MXT_PROCI_ONETOUCH:
	case MXT_PROCI_TWOTOUCH:
	case MXT_SPT_COMMSCONFIG:
	case MXT_SPT_GPIOPWM:
	case MXT_SPT_SELFTEST:
	case MXT_SPT_CTECONFIG:
	case MXT_SPT_USERDATA:
266 267 268 269 270 271
		return true;
	default:
		return false;
	}
}

272
static bool mxt_object_writable(unsigned int type)
273 274
{
	switch (type) {
275 276 277 278 279 280 281 282 283 284 285 286 287
	case MXT_GEN_COMMAND:
	case MXT_GEN_POWER:
	case MXT_GEN_ACQUIRE:
	case MXT_TOUCH_MULTI:
	case MXT_TOUCH_KEYARRAY:
	case MXT_TOUCH_PROXIMITY:
	case MXT_PROCI_GRIPFACE:
	case MXT_PROCG_NOISE:
	case MXT_PROCI_ONETOUCH:
	case MXT_PROCI_TWOTOUCH:
	case MXT_SPT_GPIOPWM:
	case MXT_SPT_SELFTEST:
	case MXT_SPT_CTECONFIG:
288 289 290 291 292 293
		return true;
	default:
		return false;
	}
}

294 295
static void mxt_dump_message(struct device *dev,
				  struct mxt_message *message)
296 297 298 299 300 301 302 303 304 305 306 307
{
	dev_dbg(dev, "reportid:\t0x%x\n", message->reportid);
	dev_dbg(dev, "message1:\t0x%x\n", message->message[0]);
	dev_dbg(dev, "message2:\t0x%x\n", message->message[1]);
	dev_dbg(dev, "message3:\t0x%x\n", message->message[2]);
	dev_dbg(dev, "message4:\t0x%x\n", message->message[3]);
	dev_dbg(dev, "message5:\t0x%x\n", message->message[4]);
	dev_dbg(dev, "message6:\t0x%x\n", message->message[5]);
	dev_dbg(dev, "message7:\t0x%x\n", message->message[6]);
	dev_dbg(dev, "checksum:\t0x%x\n", message->checksum);
}

308
static int mxt_check_bootloader(struct i2c_client *client,
309 310 311 312 313 314 315 316 317 318 319
				     unsigned int state)
{
	u8 val;

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

	switch (state) {
320 321 322
	case MXT_WAITING_BOOTLOAD_CMD:
	case MXT_WAITING_FRAME_DATA:
		val &= ~MXT_BOOT_STATUS_MASK;
323
		break;
324 325
	case MXT_FRAME_CRC_PASS:
		if (val == MXT_FRAME_CRC_CHECK)
326 327 328 329 330 331 332 333 334 335 336 337 338 339
			goto recheck;
		break;
	default:
		return -EINVAL;
	}

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

	return 0;
}

340
static int mxt_unlock_bootloader(struct i2c_client *client)
341 342 343
{
	u8 buf[2];

344 345
	buf[0] = MXT_UNLOCK_CMD_LSB;
	buf[1] = MXT_UNLOCK_CMD_MSB;
346 347 348 349 350 351 352 353 354

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

	return 0;
}

355
static int mxt_fw_write(struct i2c_client *client,
356 357 358 359 360 361 362 363 364 365
			     const u8 *data, unsigned int frame_size)
{
	if (i2c_master_send(client, data, frame_size) != frame_size) {
		dev_err(&client->dev, "%s: i2c send failed\n", __func__);
		return -EIO;
	}

	return 0;
}

366
static int __mxt_read_reg(struct i2c_client *client,
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
			       u16 reg, u16 len, void *val)
{
	struct i2c_msg xfer[2];
	u8 buf[2];

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

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

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

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

	return 0;
}

395
static int mxt_read_reg(struct i2c_client *client, u16 reg, u8 *val)
396
{
397
	return __mxt_read_reg(client, reg, 1, val);
398 399
}

400
static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
{
	u8 buf[3];

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

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

	return 0;
}

416
static int mxt_read_object_table(struct i2c_client *client,
417 418
				      u16 reg, u8 *object_buf)
{
419
	return __mxt_read_reg(client, reg, MXT_OBJECT_SIZE,
420 421 422
				   object_buf);
}

423 424
static struct mxt_object *
mxt_get_object(struct mxt_data *data, u8 type)
425
{
426
	struct mxt_object *object;
427 428 429 430 431 432 433 434 435 436 437 438
	int i;

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

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

439 440
static int mxt_read_message(struct mxt_data *data,
				 struct mxt_message *message)
441
{
442
	struct mxt_object *object;
443 444
	u16 reg;

445
	object = mxt_get_object(data, MXT_GEN_MESSAGE);
446 447 448 449
	if (!object)
		return -EINVAL;

	reg = object->start_address;
450 451
	return __mxt_read_reg(data->client, reg,
			sizeof(struct mxt_message), message);
452 453
}

454
static int mxt_read_object(struct mxt_data *data,
455 456
				u8 type, u8 offset, u8 *val)
{
457
	struct mxt_object *object;
458 459
	u16 reg;

460
	object = mxt_get_object(data, type);
461 462 463 464
	if (!object)
		return -EINVAL;

	reg = object->start_address;
465
	return __mxt_read_reg(data->client, reg + offset, 1, val);
466 467
}

468
static int mxt_write_object(struct mxt_data *data,
469 470
				 u8 type, u8 offset, u8 val)
{
471
	struct mxt_object *object;
472 473
	u16 reg;

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

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

482
static void mxt_input_report(struct mxt_data *data, int single_id)
483
{
484
	struct mxt_finger *finger = data->finger;
485 486 487 488 489
	struct input_dev *input_dev = data->input_dev;
	int status = finger[single_id].status;
	int finger_num = 0;
	int id;

490
	for (id = 0; id < MXT_MAX_FINGER; id++) {
491 492 493 494
		if (!finger[id].status)
			continue;

		input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR,
495
				finger[id].status != MXT_RELEASE ?
496 497 498 499 500 501 502
				finger[id].area : 0);
		input_report_abs(input_dev, ABS_MT_POSITION_X,
				finger[id].x);
		input_report_abs(input_dev, ABS_MT_POSITION_Y,
				finger[id].y);
		input_mt_sync(input_dev);

503
		if (finger[id].status == MXT_RELEASE)
504 505 506 507 508 509 510
			finger[id].status = 0;
		else
			finger_num++;
	}

	input_report_key(input_dev, BTN_TOUCH, finger_num > 0);

511
	if (status != MXT_RELEASE) {
512 513 514 515 516 517 518
		input_report_abs(input_dev, ABS_X, finger[single_id].x);
		input_report_abs(input_dev, ABS_Y, finger[single_id].y);
	}

	input_sync(input_dev);
}

519 520
static void mxt_input_touchevent(struct mxt_data *data,
				      struct mxt_message *message, int id)
521
{
522
	struct mxt_finger *finger = data->finger;
523 524 525 526 527 528 529
	struct device *dev = &data->client->dev;
	u8 status = message->message[0];
	int x;
	int y;
	int area;

	/* Check the touch is present on the screen */
530 531
	if (!(status & MXT_DETECT)) {
		if (status & MXT_RELEASE) {
532 533
			dev_dbg(dev, "[%d] released\n", id);

534 535
			finger[id].status = MXT_RELEASE;
			mxt_input_report(data, id);
536 537 538 539 540
		}
		return;
	}

	/* Check only AMP detection */
541
	if (!(status & (MXT_PRESS | MXT_MOVE)))
542 543 544 545 546 547 548
		return;

	x = (message->message[1] << 2) | ((message->message[3] & ~0x3f) >> 6);
	y = (message->message[2] << 2) | ((message->message[3] & ~0xf3) >> 2);
	area = message->message[4];

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

552 553
	finger[id].status = status & MXT_MOVE ?
				MXT_MOVE : MXT_PRESS;
554 555 556 557
	finger[id].x = x;
	finger[id].y = y;
	finger[id].area = area;

558
	mxt_input_report(data, id);
559 560
}

561
static irqreturn_t mxt_interrupt(int irq, void *dev_id)
562
{
563 564 565
	struct mxt_data *data = dev_id;
	struct mxt_message message;
	struct mxt_object *object;
566 567 568 569 570 571 572
	struct device *dev = &data->client->dev;
	int id;
	u8 reportid;
	u8 max_reportid;
	u8 min_reportid;

	do {
573
		if (mxt_read_message(data, &message)) {
574 575 576 577 578 579
			dev_err(dev, "Failed to read message\n");
			goto end;
		}

		reportid = message.reportid;

580 581
		/* whether reportid is thing of MXT_TOUCH_MULTI */
		object = mxt_get_object(data, MXT_TOUCH_MULTI);
582 583 584 585 586 587 588 589
		if (!object)
			goto end;

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

		if (reportid >= min_reportid && reportid <= max_reportid)
590
			mxt_input_touchevent(data, &message, id);
591
		else
592
			mxt_dump_message(dev, &message);
593 594 595 596 597 598
	} while (reportid != 0xff);

end:
	return IRQ_HANDLED;
}

599
static int mxt_check_reg_init(struct mxt_data *data)
600
{
601
	const struct mxt_platform_data *pdata = data->pdata;
602
	struct mxt_object *object;
603 604
	struct device *dev = &data->client->dev;
	int index = 0;
605
	int i, j, config_offset;
606

607 608 609
	if (!pdata->config) {
		dev_dbg(dev, "No cfg data defined, skipping reg init\n");
		return 0;
610 611 612 613 614
	}

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

615
		if (!mxt_object_writable(object->type))
616 617
			continue;

618 619 620 621 622 623
		for (j = 0; j < object->size + 1; j++) {
			config_offset = index + j;
			if (config_offset > pdata->config_length) {
				dev_err(dev, "Not enough config data!\n");
				return -EINVAL;
			}
624
			mxt_write_object(data, object->type, j,
625 626
					 pdata->config[config_offset]);
		}
627 628 629 630 631 632
		index += object->size + 1;
	}

	return 0;
}

633
static int mxt_make_highchg(struct mxt_data *data)
634 635
{
	struct device *dev = &data->client->dev;
636
	struct mxt_message message;
637 638 639 640 641
	int count = 10;
	int error;

	/* Read dummy message to make high CHG pin */
	do {
642
		error = mxt_read_message(data, &message);
643 644
		if (error)
			return error;
645
	} while (message.reportid != 0xff && --count);
646 647 648 649 650 651 652 653 654

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

	return 0;
}

655
static void mxt_handle_pdata(struct mxt_data *data)
656
{
657
	const struct mxt_platform_data *pdata = data->pdata;
658 659 660
	u8 voltage;

	/* Set touchscreen lines */
661
	mxt_write_object(data, MXT_TOUCH_MULTI, MXT_TOUCH_XSIZE,
662
			pdata->x_line);
663
	mxt_write_object(data, MXT_TOUCH_MULTI, MXT_TOUCH_YSIZE,
664 665 666
			pdata->y_line);

	/* Set touchscreen orient */
667
	mxt_write_object(data, MXT_TOUCH_MULTI, MXT_TOUCH_ORIENT,
668 669 670
			pdata->orient);

	/* Set touchscreen burst length */
671 672
	mxt_write_object(data, MXT_TOUCH_MULTI,
			MXT_TOUCH_BLEN, pdata->blen);
673 674

	/* Set touchscreen threshold */
675 676
	mxt_write_object(data, MXT_TOUCH_MULTI,
			MXT_TOUCH_TCHTHR, pdata->threshold);
677 678

	/* Set touchscreen resolution */
679 680 681 682 683 684 685 686
	mxt_write_object(data, MXT_TOUCH_MULTI,
			MXT_TOUCH_XRANGE_LSB, (pdata->x_size - 1) & 0xff);
	mxt_write_object(data, MXT_TOUCH_MULTI,
			MXT_TOUCH_XRANGE_MSB, (pdata->x_size - 1) >> 8);
	mxt_write_object(data, MXT_TOUCH_MULTI,
			MXT_TOUCH_YRANGE_LSB, (pdata->y_size - 1) & 0xff);
	mxt_write_object(data, MXT_TOUCH_MULTI,
			MXT_TOUCH_YRANGE_MSB, (pdata->y_size - 1) >> 8);
687 688

	/* Set touchscreen voltage */
689
	if (pdata->voltage) {
690 691 692
		if (pdata->voltage < MXT_VOLTAGE_DEFAULT) {
			voltage = (MXT_VOLTAGE_DEFAULT - pdata->voltage) /
				MXT_VOLTAGE_STEP;
693 694
			voltage = 0xff - voltage + 1;
		} else
695 696
			voltage = (pdata->voltage - MXT_VOLTAGE_DEFAULT) /
				MXT_VOLTAGE_STEP;
697

698 699
		mxt_write_object(data, MXT_SPT_CTECONFIG,
				MXT_CTE_VOLTAGE, voltage);
700 701 702
	}
}

703
static int mxt_get_info(struct mxt_data *data)
704 705
{
	struct i2c_client *client = data->client;
706
	struct mxt_info *info = &data->info;
707 708 709
	int error;
	u8 val;

710
	error = mxt_read_reg(client, MXT_FAMILY_ID, &val);
711 712 713 714
	if (error)
		return error;
	info->family_id = val;

715
	error = mxt_read_reg(client, MXT_VARIANT_ID, &val);
716 717 718 719
	if (error)
		return error;
	info->variant_id = val;

720
	error = mxt_read_reg(client, MXT_VERSION, &val);
721 722 723 724
	if (error)
		return error;
	info->version = val;

725
	error = mxt_read_reg(client, MXT_BUILD, &val);
726 727 728 729
	if (error)
		return error;
	info->build = val;

730
	error = mxt_read_reg(client, MXT_OBJECT_NUM, &val);
731 732 733 734 735 736 737
	if (error)
		return error;
	info->object_num = val;

	return 0;
}

738
static int mxt_get_object_table(struct mxt_data *data)
739 740 741 742 743
{
	int error;
	int i;
	u16 reg;
	u8 reportid = 0;
744
	u8 buf[MXT_OBJECT_SIZE];
745 746

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

749 750
		reg = MXT_OBJECT_START + MXT_OBJECT_SIZE * i;
		error = mxt_read_object_table(data->client, reg, buf);
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
		if (error)
			return error;

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

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

	return 0;
}

770
static int mxt_initialize(struct mxt_data *data)
771 772
{
	struct i2c_client *client = data->client;
773
	struct mxt_info *info = &data->info;
774 775 776
	int error;
	u8 val;

777
	error = mxt_get_info(data);
778 779 780 781
	if (error)
		return error;

	data->object_table = kcalloc(info->object_num,
782
				     sizeof(struct mxt_object),
783 784 785 786 787 788 789
				     GFP_KERNEL);
	if (!data->object_table) {
		dev_err(&client->dev, "Failed to allocate memory\n");
		return -ENOMEM;
	}

	/* Get object table information */
790
	error = mxt_get_object_table(data);
791 792 793 794
	if (error)
		return error;

	/* Check register init values */
795
	error = mxt_check_reg_init(data);
796 797 798
	if (error)
		return error;

799
	error = mxt_make_highchg(data);
800 801 802
	if (error)
		return error;

803
	mxt_handle_pdata(data);
804 805

	/* Backup to memory */
806 807 808 809
	mxt_write_object(data, MXT_GEN_COMMAND,
			MXT_COMMAND_BACKUPNV,
			MXT_BACKUP_VALUE);
	msleep(MXT_BACKUP_TIME);
810 811

	/* Soft reset */
812 813 814
	mxt_write_object(data, MXT_GEN_COMMAND,
			MXT_COMMAND_RESET, 1);
	msleep(MXT_RESET_TIME);
815 816

	/* Update matrix size at info struct */
817
	error = mxt_read_reg(client, MXT_MATRIX_X_SIZE, &val);
818 819 820 821
	if (error)
		return error;
	info->matrix_xsize = val;

822
	error = mxt_read_reg(client, MXT_MATRIX_Y_SIZE, &val);
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
	if (error)
		return error;
	info->matrix_ysize = val;

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

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

	return 0;
}

840
static ssize_t mxt_object_show(struct device *dev,
841 842
				    struct device_attribute *attr, char *buf)
{
843 844
	struct mxt_data *data = dev_get_drvdata(dev);
	struct mxt_object *object;
845 846 847 848 849 850 851 852 853 854 855 856
	int count = 0;
	int i, j;
	int error;
	u8 val;

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

		count += sprintf(buf + count,
				"Object Table Element %d(Type %d)\n",
				i + 1, object->type);

857
		if (!mxt_object_readable(object->type)) {
858 859 860 861 862
			count += sprintf(buf + count, "\n");
			continue;
		}

		for (j = 0; j < object->size + 1; j++) {
863
			error = mxt_read_object(data,
864 865 866 867 868 869 870 871 872 873 874 875 876 877
						object->type, j, &val);
			if (error)
				return error;

			count += sprintf(buf + count,
					"  Byte %d: 0x%x (%d)\n", j, val, val);
		}

		count += sprintf(buf + count, "\n");
	}

	return count;
}

878
static int mxt_load_fw(struct device *dev, const char *fn)
879
{
880
	struct mxt_data *data = dev_get_drvdata(dev);
881 882 883 884 885 886 887 888 889 890 891 892 893
	struct i2c_client *client = data->client;
	const struct firmware *fw = NULL;
	unsigned int frame_size;
	unsigned int pos = 0;
	int ret;

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

	/* Change to the bootloader mode */
894 895 896
	mxt_write_object(data, MXT_GEN_COMMAND,
			MXT_COMMAND_RESET, MXT_BOOT_VALUE);
	msleep(MXT_RESET_TIME);
897 898

	/* Change to slave address of bootloader */
899 900
	if (client->addr == MXT_APP_LOW)
		client->addr = MXT_BOOT_LOW;
901
	else
902
		client->addr = MXT_BOOT_HIGH;
903

904
	ret = mxt_check_bootloader(client, MXT_WAITING_BOOTLOAD_CMD);
905 906 907 908
	if (ret)
		goto out;

	/* Unlock bootloader */
909
	mxt_unlock_bootloader(client);
910 911

	while (pos < fw->size) {
912 913
		ret = mxt_check_bootloader(client,
						MXT_WAITING_FRAME_DATA);
914 915 916 917 918 919 920 921 922 923 924
		if (ret)
			goto out;

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

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

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

927 928
		ret = mxt_check_bootloader(client,
						MXT_FRAME_CRC_PASS);
929 930 931 932 933 934 935 936 937 938 939 940
		if (ret)
			goto out;

		pos += frame_size;

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

out:
	release_firmware(fw);

	/* Change to slave address of application */
941 942
	if (client->addr == MXT_BOOT_LOW)
		client->addr = MXT_APP_LOW;
943
	else
944
		client->addr = MXT_APP_HIGH;
945 946 947 948

	return ret;
}

949
static ssize_t mxt_update_fw_store(struct device *dev,
950 951 952
					struct device_attribute *attr,
					const char *buf, size_t count)
{
953
	struct mxt_data *data = dev_get_drvdata(dev);
954 955 956 957
	int error;

	disable_irq(data->irq);

958
	error = mxt_load_fw(dev, MXT_FW_NAME);
959 960 961 962 963 964 965
	if (error) {
		dev_err(dev, "The firmware update failed(%d)\n", error);
		count = error;
	} else {
		dev_dbg(dev, "The firmware update succeeded\n");

		/* Wait for reset */
966
		msleep(MXT_FWRESET_TIME);
967 968 969 970

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

971
		mxt_initialize(data);
972 973 974 975 976 977 978
	}

	enable_irq(data->irq);

	return count;
}

979 980
static DEVICE_ATTR(object, 0444, mxt_object_show, NULL);
static DEVICE_ATTR(update_fw, 0664, NULL, mxt_update_fw_store);
981

982
static struct attribute *mxt_attrs[] = {
983 984 985 986 987
	&dev_attr_object.attr,
	&dev_attr_update_fw.attr,
	NULL
};

988 989
static const struct attribute_group mxt_attr_group = {
	.attrs = mxt_attrs,
990 991
};

992
static void mxt_start(struct mxt_data *data)
993 994
{
	/* Touch enable */
995 996
	mxt_write_object(data,
			MXT_TOUCH_MULTI, MXT_TOUCH_CTRL, 0x83);
997 998
}

999
static void mxt_stop(struct mxt_data *data)
1000 1001
{
	/* Touch disable */
1002 1003
	mxt_write_object(data,
			MXT_TOUCH_MULTI, MXT_TOUCH_CTRL, 0);
1004 1005
}

1006
static int mxt_input_open(struct input_dev *dev)
1007
{
1008
	struct mxt_data *data = input_get_drvdata(dev);
1009

1010
	mxt_start(data);
1011 1012 1013 1014

	return 0;
}

1015
static void mxt_input_close(struct input_dev *dev)
1016
{
1017
	struct mxt_data *data = input_get_drvdata(dev);
1018

1019
	mxt_stop(data);
1020 1021
}

1022
static int __devinit mxt_probe(struct i2c_client *client,
1023 1024
		const struct i2c_device_id *id)
{
1025
	const struct mxt_platform_data *pdata = client->dev.platform_data;
1026
	struct mxt_data *data;
1027 1028 1029
	struct input_dev *input_dev;
	int error;

1030
	if (!pdata)
1031 1032
		return -EINVAL;

1033
	data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL);
1034 1035 1036 1037 1038 1039 1040
	input_dev = input_allocate_device();
	if (!data || !input_dev) {
		dev_err(&client->dev, "Failed to allocate memory\n");
		error = -ENOMEM;
		goto err_free_mem;
	}

1041
	input_dev->name = "Atmel maXTouch Touchscreen";
1042 1043
	input_dev->id.bustype = BUS_I2C;
	input_dev->dev.parent = &client->dev;
1044 1045
	input_dev->open = mxt_input_open;
	input_dev->close = mxt_input_close;
1046 1047 1048 1049 1050 1051 1052

	__set_bit(EV_ABS, input_dev->evbit);
	__set_bit(EV_KEY, input_dev->evbit);
	__set_bit(BTN_TOUCH, input_dev->keybit);

	/* For single touch */
	input_set_abs_params(input_dev, ABS_X,
1053
			     0, MXT_MAX_XC, 0, 0);
1054
	input_set_abs_params(input_dev, ABS_Y,
1055
			     0, MXT_MAX_YC, 0, 0);
1056 1057 1058

	/* For multi touch */
	input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
1059
			     0, MXT_MAX_AREA, 0, 0);
1060
	input_set_abs_params(input_dev, ABS_MT_POSITION_X,
1061
			     0, MXT_MAX_XC, 0, 0);
1062
	input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
1063
			     0, MXT_MAX_YC, 0, 0);
1064 1065 1066 1067 1068

	input_set_drvdata(input_dev, data);

	data->client = client;
	data->input_dev = input_dev;
1069
	data->pdata = pdata;
1070 1071 1072 1073
	data->irq = client->irq;

	i2c_set_clientdata(client, data);

1074
	error = mxt_initialize(data);
1075 1076 1077
	if (error)
		goto err_free_object;

1078
	error = request_threaded_irq(client->irq, NULL, mxt_interrupt,
1079
			pdata->irqflags, client->dev.driver->name, data);
1080 1081 1082 1083 1084 1085 1086 1087 1088
	if (error) {
		dev_err(&client->dev, "Failed to register interrupt\n");
		goto err_free_object;
	}

	error = input_register_device(input_dev);
	if (error)
		goto err_free_irq;

1089
	error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
	if (error)
		goto err_unregister_device;

	return 0;

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

1108
static int __devexit mxt_remove(struct i2c_client *client)
1109
{
1110
	struct mxt_data *data = i2c_get_clientdata(client);
1111

1112
	sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
1113 1114 1115 1116 1117 1118 1119 1120 1121
	free_irq(data->irq, data);
	input_unregister_device(data->input_dev);
	kfree(data->object_table);
	kfree(data);

	return 0;
}

#ifdef CONFIG_PM
1122
static int mxt_suspend(struct device *dev)
1123
{
1124
	struct i2c_client *client = to_i2c_client(dev);
1125
	struct mxt_data *data = i2c_get_clientdata(client);
1126 1127 1128 1129 1130
	struct input_dev *input_dev = data->input_dev;

	mutex_lock(&input_dev->mutex);

	if (input_dev->users)
1131
		mxt_stop(data);
1132 1133 1134 1135 1136 1137

	mutex_unlock(&input_dev->mutex);

	return 0;
}

1138
static int mxt_resume(struct device *dev)
1139
{
1140
	struct i2c_client *client = to_i2c_client(dev);
1141
	struct mxt_data *data = i2c_get_clientdata(client);
1142 1143 1144
	struct input_dev *input_dev = data->input_dev;

	/* Soft reset */
1145 1146
	mxt_write_object(data, MXT_GEN_COMMAND,
			MXT_COMMAND_RESET, 1);
1147

1148
	msleep(MXT_RESET_TIME);
1149 1150 1151 1152

	mutex_lock(&input_dev->mutex);

	if (input_dev->users)
1153
		mxt_start(data);
1154 1155 1156 1157 1158

	mutex_unlock(&input_dev->mutex);

	return 0;
}
1159

1160 1161 1162
static const struct dev_pm_ops mxt_pm_ops = {
	.suspend	= mxt_suspend,
	.resume		= mxt_resume,
1163
};
1164 1165
#endif

1166
static const struct i2c_device_id mxt_id[] = {
1167
	{ "qt602240_ts", 0 },
1168
	{ "atmel_mxt_ts", 0 },
1169
	{ "mXT224", 0 },
1170 1171
	{ }
};
1172
MODULE_DEVICE_TABLE(i2c, mxt_id);
1173

1174
static struct i2c_driver mxt_driver = {
1175
	.driver = {
1176
		.name	= "atmel_mxt_ts",
1177
		.owner	= THIS_MODULE,
1178
#ifdef CONFIG_PM
1179
		.pm	= &mxt_pm_ops,
1180
#endif
1181
	},
1182 1183 1184
	.probe		= mxt_probe,
	.remove		= __devexit_p(mxt_remove),
	.id_table	= mxt_id,
1185 1186
};

1187
static int __init mxt_init(void)
1188
{
1189
	return i2c_add_driver(&mxt_driver);
1190 1191
}

1192
static void __exit mxt_exit(void)
1193
{
1194
	i2c_del_driver(&mxt_driver);
1195 1196
}

1197 1198
module_init(mxt_init);
module_exit(mxt_exit);
1199 1200 1201

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