2 * Atmel maXTouch Touchscreen driver
4 * Copyright (C) 2010 Samsung Electronics Co.Ltd
5 * Copyright (C) 2012 Google, Inc.
7 * Author: Joonyoung Shim <jy0922.shim@samsung.com>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation; either version 2 of the License, or (at your
12 * option) any later version.
16 #include <linux/module.h>
17 #include <linux/init.h>
18 #include <linux/completion.h>
19 #include <linux/delay.h>
20 #include <linux/firmware.h>
21 #include <linux/i2c.h>
22 #include <linux/i2c/atmel_mxt_ts.h>
23 #include <linux/input/mt.h>
24 #include <linux/interrupt.h>
25 #include <linux/slab.h>
33 #define MXT_FW_NAME "maxtouch.fw"
37 #define MXT_FAMILY_ID 0x00
38 #define MXT_VARIANT_ID 0x01
39 #define MXT_VERSION 0x02
40 #define MXT_BUILD 0x03
41 #define MXT_MATRIX_X_SIZE 0x04
42 #define MXT_MATRIX_Y_SIZE 0x05
43 #define MXT_OBJECT_NUM 0x06
44 #define MXT_OBJECT_START 0x07
46 #define MXT_OBJECT_SIZE 6
49 #define MXT_DEBUG_DIAGNOSTIC_T37 37
50 #define MXT_GEN_MESSAGE_T5 5
51 #define MXT_GEN_COMMAND_T6 6
52 #define MXT_GEN_POWER_T7 7
53 #define MXT_GEN_ACQUIRE_T8 8
54 #define MXT_GEN_DATASOURCE_T53 53
55 #define MXT_TOUCH_MULTI_T9 9
56 #define MXT_TOUCH_KEYARRAY_T15 15
57 #define MXT_TOUCH_PROXIMITY_T23 23
58 #define MXT_TOUCH_PROXKEY_T52 52
59 #define MXT_PROCI_GRIPFACE_T20 20
60 #define MXT_PROCG_NOISE_T22 22
61 #define MXT_PROCI_ONETOUCH_T24 24
62 #define MXT_PROCI_TWOTOUCH_T27 27
63 #define MXT_PROCI_GRIP_T40 40
64 #define MXT_PROCI_PALM_T41 41
65 #define MXT_PROCI_TOUCHSUPPRESSION_T42 42
66 #define MXT_PROCI_STYLUS_T47 47
67 #define MXT_PROCG_NOISESUPPRESSION_T48 48
68 #define MXT_SPT_COMMSCONFIG_T18 18
69 #define MXT_SPT_GPIOPWM_T19 19
70 #define MXT_SPT_SELFTEST_T25 25
71 #define MXT_SPT_CTECONFIG_T28 28
72 #define MXT_SPT_USERDATA_T38 38
73 #define MXT_SPT_DIGITIZER_T43 43
74 #define MXT_SPT_MESSAGECOUNT_T44 44
75 #define MXT_SPT_CTECONFIG_T46 46
77 /* MXT_GEN_COMMAND_T6 field */
78 #define MXT_COMMAND_RESET 0
79 #define MXT_COMMAND_BACKUPNV 1
80 #define MXT_COMMAND_CALIBRATE 2
81 #define MXT_COMMAND_REPORTALL 3
82 #define MXT_COMMAND_DIAGNOSTIC 5
84 /* Define for T6 status byte */
85 #define MXT_T6_STATUS_RESET (1 << 7)
87 /* MXT_GEN_POWER_T7 field */
88 #define MXT_POWER_IDLEACQINT 0
89 #define MXT_POWER_ACTVACQINT 1
90 #define MXT_POWER_ACTV2IDLETO 2
92 /* MXT_GEN_ACQUIRE_T8 field */
93 #define MXT_ACQUIRE_CHRGTIME 0
94 #define MXT_ACQUIRE_TCHDRIFT 2
95 #define MXT_ACQUIRE_DRIFTST 3
96 #define MXT_ACQUIRE_TCHAUTOCAL 4
97 #define MXT_ACQUIRE_SYNC 5
98 #define MXT_ACQUIRE_ATCHCALST 6
99 #define MXT_ACQUIRE_ATCHCALSTHR 7
101 /* MXT_TOUCH_MULTI_T9 field */
102 #define MXT_TOUCH_CTRL 0
103 #define MXT_TOUCH_XORIGIN 1
104 #define MXT_TOUCH_YORIGIN 2
105 #define MXT_TOUCH_XSIZE 3
106 #define MXT_TOUCH_YSIZE 4
107 #define MXT_TOUCH_BLEN 6
108 #define MXT_TOUCH_TCHTHR 7
109 #define MXT_TOUCH_TCHDI 8
110 #define MXT_TOUCH_ORIENT 9
111 #define MXT_TOUCH_MOVHYSTI 11
112 #define MXT_TOUCH_MOVHYSTN 12
113 #define MXT_TOUCH_NUMTOUCH 14
114 #define MXT_TOUCH_MRGHYST 15
115 #define MXT_TOUCH_MRGTHR 16
116 #define MXT_TOUCH_AMPHYST 17
117 #define MXT_TOUCH_XRANGE_LSB 18
118 #define MXT_TOUCH_XRANGE_MSB 19
119 #define MXT_TOUCH_YRANGE_LSB 20
120 #define MXT_TOUCH_YRANGE_MSB 21
121 #define MXT_TOUCH_XLOCLIP 22
122 #define MXT_TOUCH_XHICLIP 23
123 #define MXT_TOUCH_YLOCLIP 24
124 #define MXT_TOUCH_YHICLIP 25
125 #define MXT_TOUCH_XEDGECTRL 26
126 #define MXT_TOUCH_XEDGEDIST 27
127 #define MXT_TOUCH_YEDGECTRL 28
128 #define MXT_TOUCH_YEDGEDIST 29
129 #define MXT_TOUCH_JUMPLIMIT 30
131 /* MXT_PROCI_GRIPFACE_T20 field */
132 #define MXT_GRIPFACE_CTRL 0
133 #define MXT_GRIPFACE_XLOGRIP 1
134 #define MXT_GRIPFACE_XHIGRIP 2
135 #define MXT_GRIPFACE_YLOGRIP 3
136 #define MXT_GRIPFACE_YHIGRIP 4
137 #define MXT_GRIPFACE_MAXTCHS 5
138 #define MXT_GRIPFACE_SZTHR1 7
139 #define MXT_GRIPFACE_SZTHR2 8
140 #define MXT_GRIPFACE_SHPTHR1 9
141 #define MXT_GRIPFACE_SHPTHR2 10
142 #define MXT_GRIPFACE_SUPEXTTO 11
144 /* MXT_PROCI_NOISE field */
145 #define MXT_NOISE_CTRL 0
146 #define MXT_NOISE_OUTFLEN 1
147 #define MXT_NOISE_GCAFUL_LSB 3
148 #define MXT_NOISE_GCAFUL_MSB 4
149 #define MXT_NOISE_GCAFLL_LSB 5
150 #define MXT_NOISE_GCAFLL_MSB 6
151 #define MXT_NOISE_ACTVGCAFVALID 7
152 #define MXT_NOISE_NOISETHR 8
153 #define MXT_NOISE_FREQHOPSCALE 10
154 #define MXT_NOISE_FREQ0 11
155 #define MXT_NOISE_FREQ1 12
156 #define MXT_NOISE_FREQ2 13
157 #define MXT_NOISE_FREQ3 14
158 #define MXT_NOISE_FREQ4 15
159 #define MXT_NOISE_IDLEGCAFVALID 16
161 /* MXT_SPT_COMMSCONFIG_T18 */
162 #define MXT_COMMS_CTRL 0
163 #define MXT_COMMS_CMD 1
165 /* MXT_SPT_CTECONFIG_T28 field */
166 #define MXT_CTE_CTRL 0
167 #define MXT_CTE_CMD 1
168 #define MXT_CTE_MODE 2
169 #define MXT_CTE_IDLEGCAFDEPTH 3
170 #define MXT_CTE_ACTVGCAFDEPTH 4
171 #define MXT_CTE_VOLTAGE 5
173 #define MXT_VOLTAGE_DEFAULT 2700000
174 #define MXT_VOLTAGE_STEP 10000
176 /* Define for MXT_GEN_COMMAND_T6 */
177 #define MXT_BOOT_VALUE 0xa5
178 #define MXT_RESET_VALUE 0x01
179 #define MXT_BACKUP_VALUE 0x55
182 #define MXT_BACKUP_TIME 50 /* msec */
183 #define MXT_RESET_TIME 200 /* msec */
184 #define MXT_RESET_TIMEOUT 3000 /* msec */
185 #define MXT_CRC_TIMEOUT 1000 /* msec */
186 #define MXT_FW_RESET_TIME 3000 /* msec */
187 #define MXT_FW_CHG_TIMEOUT 300 /* msec */
189 /* Command to unlock bootloader */
190 #define MXT_UNLOCK_CMD_MSB 0xaa
191 #define MXT_UNLOCK_CMD_LSB 0xdc
193 /* Bootloader mode status */
194 #define MXT_WAITING_BOOTLOAD_CMD 0xc0 /* valid 7 6 bit only */
195 #define MXT_WAITING_FRAME_DATA 0x80 /* valid 7 6 bit only */
196 #define MXT_FRAME_CRC_CHECK 0x02
197 #define MXT_FRAME_CRC_FAIL 0x03
198 #define MXT_FRAME_CRC_PASS 0x04
199 #define MXT_APP_CRC_FAIL 0x40 /* valid 7 8 bit only */
200 #define MXT_BOOT_STATUS_MASK 0x3f
201 #define MXT_BOOT_EXTENDED_ID (1 << 5)
202 #define MXT_BOOT_ID_MASK 0x1f
205 #define MXT_UNGRIP (1 << 0)
206 #define MXT_SUPPRESS (1 << 1)
207 #define MXT_AMP (1 << 2)
208 #define MXT_VECTOR (1 << 3)
209 #define MXT_MOVE (1 << 4)
210 #define MXT_RELEASE (1 << 5)
211 #define MXT_PRESS (1 << 6)
212 #define MXT_DETECT (1 << 7)
214 /* Touch orient bits */
215 #define MXT_XY_SWITCH (1 << 0)
216 #define MXT_X_INVERT (1 << 1)
217 #define MXT_Y_INVERT (1 << 2)
219 /* Touchscreen absolute values */
220 #define MXT_MAX_AREA 0xff
222 #define MXT_PIXELS_PER_MM 20
238 u8 instances_minus_one;
247 /* Each client has this additional data */
249 struct i2c_client *client;
250 struct input_dev *input_dev;
251 char phys[64]; /* device physical location */
252 const struct mxt_platform_data *pdata;
253 struct mxt_object *object_table;
254 struct mxt_info info;
262 /* Cached parameters from object table */
269 /* for fw update in bootloader */
270 struct completion bl_completion;
272 /* for reset handling */
273 struct completion reset_completion;
275 /* for config update handling */
276 struct completion crc_completion;
279 static size_t mxt_obj_size(const struct mxt_object *obj)
281 return obj->size_minus_one + 1;
284 static size_t mxt_obj_instances(const struct mxt_object *obj)
286 return obj->instances_minus_one + 1;
289 static bool mxt_object_readable(unsigned int type)
292 case MXT_GEN_COMMAND_T6:
293 case MXT_GEN_POWER_T7:
294 case MXT_GEN_ACQUIRE_T8:
295 case MXT_GEN_DATASOURCE_T53:
296 case MXT_TOUCH_MULTI_T9:
297 case MXT_TOUCH_KEYARRAY_T15:
298 case MXT_TOUCH_PROXIMITY_T23:
299 case MXT_TOUCH_PROXKEY_T52:
300 case MXT_PROCI_GRIPFACE_T20:
301 case MXT_PROCG_NOISE_T22:
302 case MXT_PROCI_ONETOUCH_T24:
303 case MXT_PROCI_TWOTOUCH_T27:
304 case MXT_PROCI_GRIP_T40:
305 case MXT_PROCI_PALM_T41:
306 case MXT_PROCI_TOUCHSUPPRESSION_T42:
307 case MXT_PROCI_STYLUS_T47:
308 case MXT_PROCG_NOISESUPPRESSION_T48:
309 case MXT_SPT_COMMSCONFIG_T18:
310 case MXT_SPT_GPIOPWM_T19:
311 case MXT_SPT_SELFTEST_T25:
312 case MXT_SPT_CTECONFIG_T28:
313 case MXT_SPT_USERDATA_T38:
314 case MXT_SPT_DIGITIZER_T43:
315 case MXT_SPT_CTECONFIG_T46:
322 static bool mxt_object_writable(unsigned int type)
325 case MXT_GEN_COMMAND_T6:
326 case MXT_GEN_POWER_T7:
327 case MXT_GEN_ACQUIRE_T8:
328 case MXT_TOUCH_MULTI_T9:
329 case MXT_TOUCH_KEYARRAY_T15:
330 case MXT_TOUCH_PROXIMITY_T23:
331 case MXT_TOUCH_PROXKEY_T52:
332 case MXT_PROCI_GRIPFACE_T20:
333 case MXT_PROCG_NOISE_T22:
334 case MXT_PROCI_ONETOUCH_T24:
335 case MXT_PROCI_TWOTOUCH_T27:
336 case MXT_PROCI_GRIP_T40:
337 case MXT_PROCI_PALM_T41:
338 case MXT_PROCI_TOUCHSUPPRESSION_T42:
339 case MXT_PROCI_STYLUS_T47:
340 case MXT_PROCG_NOISESUPPRESSION_T48:
341 case MXT_SPT_COMMSCONFIG_T18:
342 case MXT_SPT_GPIOPWM_T19:
343 case MXT_SPT_SELFTEST_T25:
344 case MXT_SPT_CTECONFIG_T28:
345 case MXT_SPT_DIGITIZER_T43:
346 case MXT_SPT_CTECONFIG_T46:
353 static void mxt_dump_message(struct device *dev,
354 struct mxt_message *message)
356 dev_dbg(dev, "reportid: %u\tmessage: %*ph\n",
357 message->reportid, 7, message->message);
360 static int mxt_wait_for_completion(struct mxt_data *data,
361 struct completion *comp,
362 unsigned int timeout_ms)
364 struct device *dev = &data->client->dev;
365 unsigned long timeout = msecs_to_jiffies(timeout_ms);
368 ret = wait_for_completion_interruptible_timeout(comp, timeout);
371 } else if (ret == 0) {
372 dev_err(dev, "Wait for completion timed out.\n");
378 static int mxt_bootloader_read(struct mxt_data *data,
379 u8 *val, unsigned int count)
384 msg.addr = data->bootloader_addr;
385 msg.flags = data->client->flags & I2C_M_TEN;
386 msg.flags |= I2C_M_RD;
390 ret = i2c_transfer(data->client->adapter, &msg, 1);
395 ret = ret < 0 ? ret : -EIO;
396 dev_err(&data->client->dev, "%s: i2c recv failed (%d)\n",
403 static int mxt_bootloader_write(struct mxt_data *data,
404 const u8 * const val, unsigned int count)
409 msg.addr = data->bootloader_addr;
410 msg.flags = data->client->flags & I2C_M_TEN;
414 ret = i2c_transfer(data->client->adapter, &msg, 1);
418 ret = ret < 0 ? ret : -EIO;
419 dev_err(&data->client->dev, "%s: i2c send failed (%d)\n",
426 static int mxt_lookup_bootloader_address(struct mxt_data *data)
428 u8 appmode = data->client->addr;
438 bootloader = appmode - 0x26;
441 dev_err(&data->client->dev,
442 "Appmode i2c address 0x%02x not found\n",
447 data->bootloader_addr = bootloader;
451 static u8 mxt_get_bootloader_version(struct mxt_data *data, u8 val)
453 struct device *dev = &data->client->dev;
456 if (val & MXT_BOOT_EXTENDED_ID) {
457 if (mxt_bootloader_read(data, &buf[0], 3) != 0) {
458 dev_err(dev, "%s: i2c failure\n", __func__);
462 dev_dbg(dev, "Bootloader ID:%d Version:%d\n", buf[1], buf[2]);
466 dev_dbg(dev, "Bootloader ID:%d\n", val & MXT_BOOT_ID_MASK);
472 static int mxt_check_bootloader(struct mxt_data *data, unsigned int state)
474 struct device *dev = &data->client->dev;
479 if (state != MXT_WAITING_BOOTLOAD_CMD) {
481 * In application update mode, the interrupt
482 * line signals state transitions. We must wait for the
483 * CHG assertion before reading the status byte.
484 * Once the status byte has been read, the line is deasserted.
486 ret = mxt_wait_for_completion(data, &data->bl_completion,
490 * TODO: handle -ERESTARTSYS better by terminating
491 * fw update process before returning to userspace
492 * by writing length 0x000 to device (iff we are in
493 * WAITING_FRAME_DATA state).
495 dev_err(dev, "Update wait error %d\n", ret);
500 ret = mxt_bootloader_read(data, &val, 1);
504 if (state == MXT_WAITING_BOOTLOAD_CMD)
505 val = mxt_get_bootloader_version(data, val);
508 case MXT_WAITING_BOOTLOAD_CMD:
509 case MXT_WAITING_FRAME_DATA:
510 val &= ~MXT_BOOT_STATUS_MASK;
512 case MXT_FRAME_CRC_PASS:
513 if (val == MXT_FRAME_CRC_CHECK) {
515 } else if (val == MXT_FRAME_CRC_FAIL) {
516 dev_err(dev, "Bootloader CRC fail\n");
525 dev_err(dev, "Invalid bootloader state %02X != %02X\n",
533 static int mxt_unlock_bootloader(struct mxt_data *data)
538 buf[0] = MXT_UNLOCK_CMD_LSB;
539 buf[1] = MXT_UNLOCK_CMD_MSB;
541 ret = mxt_bootloader_write(data, buf, 2);
548 static int __mxt_read_reg(struct i2c_client *client,
549 u16 reg, u16 len, void *val)
551 struct i2c_msg xfer[2];
556 buf[1] = (reg >> 8) & 0xff;
559 xfer[0].addr = client->addr;
565 xfer[1].addr = client->addr;
566 xfer[1].flags = I2C_M_RD;
570 ret = i2c_transfer(client->adapter, xfer, 2);
576 dev_err(&client->dev, "%s: i2c transfer failed (%d)\n",
583 static int mxt_read_reg(struct i2c_client *client, u16 reg, u8 *val)
585 return __mxt_read_reg(client, reg, 1, val);
588 static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len,
596 buf = kmalloc(count, GFP_KERNEL);
601 buf[1] = (reg >> 8) & 0xff;
602 memcpy(&buf[2], val, len);
604 ret = i2c_master_send(client, buf, count);
610 dev_err(&client->dev, "%s: i2c send failed (%d)\n",
618 static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
620 return __mxt_write_reg(client, reg, 1, &val);
623 static struct mxt_object *
624 mxt_get_object(struct mxt_data *data, u8 type)
626 struct mxt_object *object;
629 for (i = 0; i < data->info.object_num; i++) {
630 object = data->object_table + i;
631 if (object->type == type)
635 dev_err(&data->client->dev, "Invalid object type T%u\n", type);
639 static int mxt_read_message(struct mxt_data *data,
640 struct mxt_message *message)
642 struct mxt_object *object;
645 object = mxt_get_object(data, MXT_GEN_MESSAGE_T5);
649 reg = object->start_address;
650 return __mxt_read_reg(data->client, reg,
651 sizeof(struct mxt_message), message);
654 static int mxt_write_object(struct mxt_data *data,
655 u8 type, u8 offset, u8 val)
657 struct mxt_object *object;
660 object = mxt_get_object(data, type);
661 if (!object || offset >= mxt_obj_size(object))
664 reg = object->start_address;
665 return mxt_write_reg(data->client, reg + offset, val);
668 static void mxt_input_button(struct mxt_data *data, struct mxt_message *message)
670 struct input_dev *input = data->input_dev;
671 const struct mxt_platform_data *pdata = data->pdata;
675 /* Active-low switch */
676 for (i = 0; i < pdata->t19_num_keys; i++) {
677 if (pdata->t19_keymap[i] == KEY_RESERVED)
679 button = !(message->message[0] & (1 << i));
680 input_report_key(input, pdata->t19_keymap[i], button);
684 static void mxt_input_touchevent(struct mxt_data *data,
685 struct mxt_message *message, int id)
687 struct device *dev = &data->client->dev;
688 u8 status = message->message[0];
689 struct input_dev *input_dev = data->input_dev;
695 x = (message->message[1] << 4) | ((message->message[3] >> 4) & 0xf);
696 y = (message->message[2] << 4) | ((message->message[3] & 0xf));
697 if (data->max_x < 1024)
699 if (data->max_y < 1024)
702 area = message->message[4];
703 pressure = message->message[5];
706 "[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
708 (status & MXT_DETECT) ? 'D' : '.',
709 (status & MXT_PRESS) ? 'P' : '.',
710 (status & MXT_RELEASE) ? 'R' : '.',
711 (status & MXT_MOVE) ? 'M' : '.',
712 (status & MXT_VECTOR) ? 'V' : '.',
713 (status & MXT_AMP) ? 'A' : '.',
714 (status & MXT_SUPPRESS) ? 'S' : '.',
715 (status & MXT_UNGRIP) ? 'U' : '.',
716 x, y, area, pressure);
718 input_mt_slot(input_dev, id);
719 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER,
720 status & MXT_DETECT);
722 if (status & MXT_DETECT) {
723 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
724 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
725 input_report_abs(input_dev, ABS_MT_PRESSURE, pressure);
726 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
730 static u16 mxt_extract_T6_csum(const u8 *csum)
732 return csum[0] | (csum[1] << 8) | (csum[2] << 16);
735 static bool mxt_is_T9_message(struct mxt_data *data, struct mxt_message *msg)
737 u8 id = msg->reportid;
738 return (id >= data->T9_reportid_min && id <= data->T9_reportid_max);
741 static irqreturn_t mxt_process_messages_until_invalid(struct mxt_data *data)
743 struct mxt_message message;
744 const u8 *payload = &message.message[0];
745 struct device *dev = &data->client->dev;
747 bool update_input = false;
751 if (mxt_read_message(data, &message)) {
752 dev_err(dev, "Failed to read message\n");
756 reportid = message.reportid;
758 if (reportid == data->T6_reportid) {
759 u8 status = payload[0];
761 crc = mxt_extract_T6_csum(&payload[1]);
762 if (crc != data->config_crc) {
763 data->config_crc = crc;
764 complete(&data->crc_completion);
767 dev_dbg(dev, "Status: %02x Config Checksum: %06x\n",
768 status, data->config_crc);
770 if (status & MXT_T6_STATUS_RESET)
771 complete(&data->reset_completion);
772 } else if (mxt_is_T9_message(data, &message)) {
773 int id = reportid - data->T9_reportid_min;
774 mxt_input_touchevent(data, &message, id);
776 } else if (message.reportid == data->T19_reportid) {
777 mxt_input_button(data, &message);
780 mxt_dump_message(dev, &message);
782 } while (reportid != 0xff);
785 input_mt_report_pointer_emulation(data->input_dev, false);
786 input_sync(data->input_dev);
792 static irqreturn_t mxt_interrupt(int irq, void *dev_id)
794 struct mxt_data *data = dev_id;
796 if (data->in_bootloader) {
797 /* bootloader state transition completion */
798 complete(&data->bl_completion);
802 return mxt_process_messages_until_invalid(data);
805 static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset,
810 int timeout_counter = 0;
813 reg = data->T6_address + cmd_offset;
815 ret = mxt_write_reg(data->client, reg, value);
824 ret = __mxt_read_reg(data->client, reg, 1, &command_register);
827 } while (command_register != 0 && timeout_counter++ <= 100);
829 if (timeout_counter > 100) {
830 dev_err(&data->client->dev, "Command failed!\n");
837 static int mxt_soft_reset(struct mxt_data *data)
839 struct device *dev = &data->client->dev;
842 dev_info(dev, "Resetting chip\n");
844 reinit_completion(&data->reset_completion);
846 ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false);
850 ret = mxt_wait_for_completion(data, &data->reset_completion,
858 static void mxt_update_crc(struct mxt_data *data, u8 cmd, u8 value)
861 * On failure, CRC is set to 0 and config will always be
864 data->config_crc = 0;
865 reinit_completion(&data->crc_completion);
867 mxt_t6_command(data, cmd, value, true);
870 * Wait for crc message. On failure, CRC is set to 0 and config will
871 * always be downloaded.
873 mxt_wait_for_completion(data, &data->crc_completion, MXT_CRC_TIMEOUT);
876 static int mxt_check_reg_init(struct mxt_data *data)
878 const struct mxt_platform_data *pdata = data->pdata;
879 struct mxt_object *object;
880 struct device *dev = &data->client->dev;
885 if (!pdata->config) {
886 dev_dbg(dev, "No cfg data defined, skipping reg init\n");
890 mxt_update_crc(data, MXT_COMMAND_REPORTALL, 1);
892 if (data->config_crc == pdata->config_crc) {
893 dev_info(dev, "Config CRC 0x%06X: OK\n", data->config_crc);
897 dev_info(dev, "Config CRC 0x%06X: does not match 0x%06X\n",
898 data->config_crc, pdata->config_crc);
900 for (i = 0; i < data->info.object_num; i++) {
901 object = data->object_table + i;
903 if (!mxt_object_writable(object->type))
906 size = mxt_obj_size(object) * mxt_obj_instances(object);
907 if (index + size > pdata->config_length) {
908 dev_err(dev, "Not enough config data!\n");
912 ret = __mxt_write_reg(data->client, object->start_address,
913 size, &pdata->config[index]);
919 mxt_update_crc(data, MXT_COMMAND_BACKUPNV, MXT_BACKUP_VALUE);
921 ret = mxt_soft_reset(data);
925 dev_info(dev, "Config successfully updated\n");
930 static int mxt_make_highchg(struct mxt_data *data)
932 struct device *dev = &data->client->dev;
933 struct mxt_message message;
937 /* Read dummy message to make high CHG pin */
939 error = mxt_read_message(data, &message);
942 } while (message.reportid != 0xff && --count);
945 dev_err(dev, "CHG pin isn't cleared\n");
952 static int mxt_get_info(struct mxt_data *data)
954 struct i2c_client *client = data->client;
955 struct mxt_info *info = &data->info;
958 /* Read 7-byte info block starting at address 0 */
959 error = __mxt_read_reg(client, MXT_INFO, sizeof(*info), info);
966 static int mxt_get_object_table(struct mxt_data *data)
968 struct i2c_client *client = data->client;
974 table_size = data->info.object_num * sizeof(struct mxt_object);
975 error = __mxt_read_reg(client, MXT_OBJECT_START, table_size,
980 /* Valid Report IDs start counting from 1 */
982 for (i = 0; i < data->info.object_num; i++) {
983 struct mxt_object *object = data->object_table + i;
986 le16_to_cpus(&object->start_address);
988 if (object->num_report_ids) {
990 reportid += object->num_report_ids *
991 mxt_obj_instances(object);
992 max_id = reportid - 1;
998 dev_dbg(&data->client->dev,
999 "T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n",
1000 object->type, object->start_address,
1001 mxt_obj_size(object), mxt_obj_instances(object),
1004 switch (object->type) {
1005 case MXT_GEN_COMMAND_T6:
1006 data->T6_reportid = min_id;
1007 data->T6_address = object->start_address;
1009 case MXT_TOUCH_MULTI_T9:
1010 data->T9_reportid_min = min_id;
1011 data->T9_reportid_max = max_id;
1013 case MXT_SPT_GPIOPWM_T19:
1014 data->T19_reportid = min_id;
1022 static void mxt_free_object_table(struct mxt_data *data)
1024 kfree(data->object_table);
1025 data->object_table = NULL;
1026 data->T6_reportid = 0;
1027 data->T9_reportid_min = 0;
1028 data->T9_reportid_max = 0;
1029 data->T19_reportid = 0;
1032 static int mxt_initialize(struct mxt_data *data)
1034 struct i2c_client *client = data->client;
1035 struct mxt_info *info = &data->info;
1039 error = mxt_get_info(data);
1043 data->object_table = kcalloc(info->object_num,
1044 sizeof(struct mxt_object),
1046 if (!data->object_table) {
1047 dev_err(&client->dev, "Failed to allocate memory\n");
1051 /* Get object table information */
1052 error = mxt_get_object_table(data);
1054 dev_err(&client->dev, "Error %d reading object table\n", error);
1055 goto err_free_object_table;
1058 /* Check register init values */
1059 error = mxt_check_reg_init(data);
1061 dev_err(&client->dev, "Error %d initializing configuration\n",
1063 goto err_free_object_table;
1066 /* Update matrix size at info struct */
1067 error = mxt_read_reg(client, MXT_MATRIX_X_SIZE, &val);
1069 goto err_free_object_table;
1070 info->matrix_xsize = val;
1072 error = mxt_read_reg(client, MXT_MATRIX_Y_SIZE, &val);
1074 goto err_free_object_table;
1075 info->matrix_ysize = val;
1077 dev_info(&client->dev,
1078 "Family: %u Variant: %u Firmware V%u.%u.%02X\n",
1079 info->family_id, info->variant_id, info->version >> 4,
1080 info->version & 0xf, info->build);
1082 dev_info(&client->dev,
1083 "Matrix X Size: %u Matrix Y Size: %u Objects: %u\n",
1084 info->matrix_xsize, info->matrix_ysize,
1089 err_free_object_table:
1090 mxt_free_object_table(data);
1094 static void mxt_calc_resolution(struct mxt_data *data)
1096 unsigned int max_x = data->pdata->x_size - 1;
1097 unsigned int max_y = data->pdata->y_size - 1;
1099 if (data->pdata->orient & MXT_XY_SWITCH) {
1100 data->max_x = max_y;
1101 data->max_y = max_x;
1103 data->max_x = max_x;
1104 data->max_y = max_y;
1108 /* Firmware Version is returned as Major.Minor.Build */
1109 static ssize_t mxt_fw_version_show(struct device *dev,
1110 struct device_attribute *attr, char *buf)
1112 struct mxt_data *data = dev_get_drvdata(dev);
1113 struct mxt_info *info = &data->info;
1114 return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
1115 info->version >> 4, info->version & 0xf, info->build);
1118 /* Hardware Version is returned as FamilyID.VariantID */
1119 static ssize_t mxt_hw_version_show(struct device *dev,
1120 struct device_attribute *attr, char *buf)
1122 struct mxt_data *data = dev_get_drvdata(dev);
1123 struct mxt_info *info = &data->info;
1124 return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
1125 info->family_id, info->variant_id);
1128 static ssize_t mxt_show_instance(char *buf, int count,
1129 struct mxt_object *object, int instance,
1134 if (mxt_obj_instances(object) > 1)
1135 count += scnprintf(buf + count, PAGE_SIZE - count,
1136 "Instance %u\n", instance);
1138 for (i = 0; i < mxt_obj_size(object); i++)
1139 count += scnprintf(buf + count, PAGE_SIZE - count,
1140 "\t[%2u]: %02x (%d)\n", i, val[i], val[i]);
1141 count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
1146 static ssize_t mxt_object_show(struct device *dev,
1147 struct device_attribute *attr, char *buf)
1149 struct mxt_data *data = dev_get_drvdata(dev);
1150 struct mxt_object *object;
1156 /* Pre-allocate buffer large enough to hold max sized object. */
1157 obuf = kmalloc(256, GFP_KERNEL);
1162 for (i = 0; i < data->info.object_num; i++) {
1163 object = data->object_table + i;
1165 if (!mxt_object_readable(object->type))
1168 count += scnprintf(buf + count, PAGE_SIZE - count,
1169 "T%u:\n", object->type);
1171 for (j = 0; j < mxt_obj_instances(object); j++) {
1172 u16 size = mxt_obj_size(object);
1173 u16 addr = object->start_address + j * size;
1175 error = __mxt_read_reg(data->client, addr, size, obuf);
1179 count = mxt_show_instance(buf, count, object, j, obuf);
1185 return error ?: count;
1188 static int mxt_check_firmware_format(struct device *dev,
1189 const struct firmware *fw)
1191 unsigned int pos = 0;
1194 while (pos < fw->size) {
1195 c = *(fw->data + pos);
1197 if (c < '0' || (c > '9' && c < 'A') || c > 'F')
1204 * To convert file try:
1205 * xxd -r -p mXTXXX__APP_VX-X-XX.enc > maxtouch.fw
1207 dev_err(dev, "Aborting: firmware file must be in binary format\n");
1212 static int mxt_load_fw(struct device *dev, const char *fn)
1214 struct mxt_data *data = dev_get_drvdata(dev);
1215 const struct firmware *fw = NULL;
1216 unsigned int frame_size;
1217 unsigned int pos = 0;
1218 unsigned int retry = 0;
1219 unsigned int frame = 0;
1222 ret = request_firmware(&fw, fn, dev);
1224 dev_err(dev, "Unable to open firmware %s\n", fn);
1228 /* Check for incorrect enc file */
1229 ret = mxt_check_firmware_format(dev, fw);
1231 goto release_firmware;
1233 ret = mxt_lookup_bootloader_address(data);
1235 goto release_firmware;
1237 /* Change to the bootloader mode */
1238 data->in_bootloader = true;
1240 ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_BOOT_VALUE, false);
1242 goto release_firmware;
1244 msleep(MXT_RESET_TIME);
1246 reinit_completion(&data->bl_completion);
1248 ret = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD);
1252 /* Unlock bootloader */
1253 mxt_unlock_bootloader(data);
1255 while (pos < fw->size) {
1256 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA);
1260 frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
1262 /* Take account of CRC bytes */
1265 /* Write one frame to device */
1266 ret = mxt_bootloader_write(data, fw->data + pos, frame_size);
1270 ret = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS);
1274 /* Back off by 20ms per retry */
1278 dev_err(dev, "Retry count exceeded\n");
1287 if (frame % 50 == 0)
1288 dev_dbg(dev, "Sent %d frames, %d/%zd bytes\n",
1289 frame, pos, fw->size);
1292 /* Wait for flash. */
1293 ret = mxt_wait_for_completion(data, &data->bl_completion,
1298 dev_dbg(dev, "Sent %d frames, %d bytes\n", frame, pos);
1301 * Wait for device to reset. Some bootloader versions do not assert
1302 * the CHG line after bootloading has finished, so ignore potential
1305 mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME);
1307 data->in_bootloader = false;
1310 disable_irq(data->irq);
1312 release_firmware(fw);
1316 static ssize_t mxt_update_fw_store(struct device *dev,
1317 struct device_attribute *attr,
1318 const char *buf, size_t count)
1320 struct mxt_data *data = dev_get_drvdata(dev);
1323 error = mxt_load_fw(dev, MXT_FW_NAME);
1325 dev_err(dev, "The firmware update failed(%d)\n", error);
1328 dev_info(dev, "The firmware update succeeded\n");
1330 mxt_free_object_table(data);
1332 mxt_initialize(data);
1334 enable_irq(data->irq);
1336 error = mxt_make_highchg(data);
1344 static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
1345 static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
1346 static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
1347 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
1349 static struct attribute *mxt_attrs[] = {
1350 &dev_attr_fw_version.attr,
1351 &dev_attr_hw_version.attr,
1352 &dev_attr_object.attr,
1353 &dev_attr_update_fw.attr,
1357 static const struct attribute_group mxt_attr_group = {
1361 static void mxt_start(struct mxt_data *data)
1364 mxt_write_object(data,
1365 MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0x83);
1368 static void mxt_stop(struct mxt_data *data)
1371 mxt_write_object(data,
1372 MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0);
1375 static int mxt_input_open(struct input_dev *dev)
1377 struct mxt_data *data = input_get_drvdata(dev);
1384 static void mxt_input_close(struct input_dev *dev)
1386 struct mxt_data *data = input_get_drvdata(dev);
1391 static int mxt_probe(struct i2c_client *client,
1392 const struct i2c_device_id *id)
1394 const struct mxt_platform_data *pdata = dev_get_platdata(&client->dev);
1395 struct mxt_data *data;
1396 struct input_dev *input_dev;
1398 unsigned int num_mt_slots;
1399 unsigned int mt_flags = 0;
1405 data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL);
1406 input_dev = input_allocate_device();
1407 if (!data || !input_dev) {
1408 dev_err(&client->dev, "Failed to allocate memory\n");
1413 input_dev->name = "Atmel maXTouch Touchscreen";
1414 snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
1415 client->adapter->nr, client->addr);
1417 input_dev->phys = data->phys;
1419 input_dev->id.bustype = BUS_I2C;
1420 input_dev->dev.parent = &client->dev;
1421 input_dev->open = mxt_input_open;
1422 input_dev->close = mxt_input_close;
1424 data->client = client;
1425 data->input_dev = input_dev;
1426 data->pdata = pdata;
1427 data->irq = client->irq;
1429 init_completion(&data->bl_completion);
1430 init_completion(&data->reset_completion);
1431 init_completion(&data->crc_completion);
1433 mxt_calc_resolution(data);
1435 error = mxt_initialize(data);
1439 __set_bit(EV_ABS, input_dev->evbit);
1440 __set_bit(EV_KEY, input_dev->evbit);
1441 __set_bit(BTN_TOUCH, input_dev->keybit);
1443 if (pdata->t19_num_keys) {
1444 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
1446 for (i = 0; i < pdata->t19_num_keys; i++)
1447 if (pdata->t19_keymap[i] != KEY_RESERVED)
1448 input_set_capability(input_dev, EV_KEY,
1449 pdata->t19_keymap[i]);
1451 mt_flags |= INPUT_MT_POINTER;
1453 input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM);
1454 input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM);
1455 input_abs_set_res(input_dev, ABS_MT_POSITION_X,
1457 input_abs_set_res(input_dev, ABS_MT_POSITION_Y,
1460 input_dev->name = "Atmel maXTouch Touchpad";
1463 /* For single touch */
1464 input_set_abs_params(input_dev, ABS_X,
1465 0, data->max_x, 0, 0);
1466 input_set_abs_params(input_dev, ABS_Y,
1467 0, data->max_y, 0, 0);
1468 input_set_abs_params(input_dev, ABS_PRESSURE,
1471 /* For multi touch */
1472 num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
1473 error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags);
1475 goto err_free_object;
1476 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
1477 0, MXT_MAX_AREA, 0, 0);
1478 input_set_abs_params(input_dev, ABS_MT_POSITION_X,
1479 0, data->max_x, 0, 0);
1480 input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
1481 0, data->max_y, 0, 0);
1482 input_set_abs_params(input_dev, ABS_MT_PRESSURE,
1485 input_set_drvdata(input_dev, data);
1486 i2c_set_clientdata(client, data);
1488 error = request_threaded_irq(client->irq, NULL, mxt_interrupt,
1489 pdata->irqflags | IRQF_ONESHOT,
1490 client->name, data);
1492 dev_err(&client->dev, "Failed to register interrupt\n");
1493 goto err_free_object;
1496 error = mxt_make_highchg(data);
1500 error = input_register_device(input_dev);
1502 dev_err(&client->dev, "Error %d registering input device\n",
1507 error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
1509 dev_err(&client->dev, "Failure %d creating sysfs group\n",
1511 goto err_unregister_device;
1516 err_unregister_device:
1517 input_unregister_device(input_dev);
1520 free_irq(client->irq, data);
1522 kfree(data->object_table);
1524 input_free_device(input_dev);
1529 static int mxt_remove(struct i2c_client *client)
1531 struct mxt_data *data = i2c_get_clientdata(client);
1533 sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
1534 free_irq(data->irq, data);
1535 input_unregister_device(data->input_dev);
1536 kfree(data->object_table);
1542 #ifdef CONFIG_PM_SLEEP
1543 static int mxt_suspend(struct device *dev)
1545 struct i2c_client *client = to_i2c_client(dev);
1546 struct mxt_data *data = i2c_get_clientdata(client);
1547 struct input_dev *input_dev = data->input_dev;
1549 mutex_lock(&input_dev->mutex);
1551 if (input_dev->users)
1554 mutex_unlock(&input_dev->mutex);
1559 static int mxt_resume(struct device *dev)
1561 struct i2c_client *client = to_i2c_client(dev);
1562 struct mxt_data *data = i2c_get_clientdata(client);
1563 struct input_dev *input_dev = data->input_dev;
1565 mxt_soft_reset(data);
1567 mutex_lock(&input_dev->mutex);
1569 if (input_dev->users)
1572 mutex_unlock(&input_dev->mutex);
1578 static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);
1580 static const struct i2c_device_id mxt_id[] = {
1581 { "qt602240_ts", 0 },
1582 { "atmel_mxt_ts", 0 },
1583 { "atmel_mxt_tp", 0 },
1587 MODULE_DEVICE_TABLE(i2c, mxt_id);
1589 static struct i2c_driver mxt_driver = {
1591 .name = "atmel_mxt_ts",
1592 .owner = THIS_MODULE,
1596 .remove = mxt_remove,
1600 module_i2c_driver(mxt_driver);
1602 /* Module information */
1603 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
1604 MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
1605 MODULE_LICENSE("GPL");