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_APP_LOW 0x4a
34 #define MXT_APP_HIGH 0x4b
35 #define MXT_BOOT_LOW 0x24
36 #define MXT_BOOT_HIGH 0x25
39 #define MXT_FW_NAME "maxtouch.fw"
43 #define MXT_FAMILY_ID 0x00
44 #define MXT_VARIANT_ID 0x01
45 #define MXT_VERSION 0x02
46 #define MXT_BUILD 0x03
47 #define MXT_MATRIX_X_SIZE 0x04
48 #define MXT_MATRIX_Y_SIZE 0x05
49 #define MXT_OBJECT_NUM 0x06
50 #define MXT_OBJECT_START 0x07
52 #define MXT_OBJECT_SIZE 6
55 #define MXT_DEBUG_DIAGNOSTIC_T37 37
56 #define MXT_GEN_MESSAGE_T5 5
57 #define MXT_GEN_COMMAND_T6 6
58 #define MXT_GEN_POWER_T7 7
59 #define MXT_GEN_ACQUIRE_T8 8
60 #define MXT_GEN_DATASOURCE_T53 53
61 #define MXT_TOUCH_MULTI_T9 9
62 #define MXT_TOUCH_KEYARRAY_T15 15
63 #define MXT_TOUCH_PROXIMITY_T23 23
64 #define MXT_TOUCH_PROXKEY_T52 52
65 #define MXT_PROCI_GRIPFACE_T20 20
66 #define MXT_PROCG_NOISE_T22 22
67 #define MXT_PROCI_ONETOUCH_T24 24
68 #define MXT_PROCI_TWOTOUCH_T27 27
69 #define MXT_PROCI_GRIP_T40 40
70 #define MXT_PROCI_PALM_T41 41
71 #define MXT_PROCI_TOUCHSUPPRESSION_T42 42
72 #define MXT_PROCI_STYLUS_T47 47
73 #define MXT_PROCG_NOISESUPPRESSION_T48 48
74 #define MXT_SPT_COMMSCONFIG_T18 18
75 #define MXT_SPT_GPIOPWM_T19 19
76 #define MXT_SPT_SELFTEST_T25 25
77 #define MXT_SPT_CTECONFIG_T28 28
78 #define MXT_SPT_USERDATA_T38 38
79 #define MXT_SPT_DIGITIZER_T43 43
80 #define MXT_SPT_MESSAGECOUNT_T44 44
81 #define MXT_SPT_CTECONFIG_T46 46
83 /* MXT_GEN_COMMAND_T6 field */
84 #define MXT_COMMAND_RESET 0
85 #define MXT_COMMAND_BACKUPNV 1
86 #define MXT_COMMAND_CALIBRATE 2
87 #define MXT_COMMAND_REPORTALL 3
88 #define MXT_COMMAND_DIAGNOSTIC 5
90 /* Define for T6 status byte */
91 #define MXT_T6_STATUS_RESET (1 << 7)
93 /* MXT_GEN_POWER_T7 field */
94 #define MXT_POWER_IDLEACQINT 0
95 #define MXT_POWER_ACTVACQINT 1
96 #define MXT_POWER_ACTV2IDLETO 2
98 /* MXT_GEN_ACQUIRE_T8 field */
99 #define MXT_ACQUIRE_CHRGTIME 0
100 #define MXT_ACQUIRE_TCHDRIFT 2
101 #define MXT_ACQUIRE_DRIFTST 3
102 #define MXT_ACQUIRE_TCHAUTOCAL 4
103 #define MXT_ACQUIRE_SYNC 5
104 #define MXT_ACQUIRE_ATCHCALST 6
105 #define MXT_ACQUIRE_ATCHCALSTHR 7
107 /* MXT_TOUCH_MULTI_T9 field */
108 #define MXT_TOUCH_CTRL 0
109 #define MXT_TOUCH_XORIGIN 1
110 #define MXT_TOUCH_YORIGIN 2
111 #define MXT_TOUCH_XSIZE 3
112 #define MXT_TOUCH_YSIZE 4
113 #define MXT_TOUCH_BLEN 6
114 #define MXT_TOUCH_TCHTHR 7
115 #define MXT_TOUCH_TCHDI 8
116 #define MXT_TOUCH_ORIENT 9
117 #define MXT_TOUCH_MOVHYSTI 11
118 #define MXT_TOUCH_MOVHYSTN 12
119 #define MXT_TOUCH_NUMTOUCH 14
120 #define MXT_TOUCH_MRGHYST 15
121 #define MXT_TOUCH_MRGTHR 16
122 #define MXT_TOUCH_AMPHYST 17
123 #define MXT_TOUCH_XRANGE_LSB 18
124 #define MXT_TOUCH_XRANGE_MSB 19
125 #define MXT_TOUCH_YRANGE_LSB 20
126 #define MXT_TOUCH_YRANGE_MSB 21
127 #define MXT_TOUCH_XLOCLIP 22
128 #define MXT_TOUCH_XHICLIP 23
129 #define MXT_TOUCH_YLOCLIP 24
130 #define MXT_TOUCH_YHICLIP 25
131 #define MXT_TOUCH_XEDGECTRL 26
132 #define MXT_TOUCH_XEDGEDIST 27
133 #define MXT_TOUCH_YEDGECTRL 28
134 #define MXT_TOUCH_YEDGEDIST 29
135 #define MXT_TOUCH_JUMPLIMIT 30
137 /* MXT_PROCI_GRIPFACE_T20 field */
138 #define MXT_GRIPFACE_CTRL 0
139 #define MXT_GRIPFACE_XLOGRIP 1
140 #define MXT_GRIPFACE_XHIGRIP 2
141 #define MXT_GRIPFACE_YLOGRIP 3
142 #define MXT_GRIPFACE_YHIGRIP 4
143 #define MXT_GRIPFACE_MAXTCHS 5
144 #define MXT_GRIPFACE_SZTHR1 7
145 #define MXT_GRIPFACE_SZTHR2 8
146 #define MXT_GRIPFACE_SHPTHR1 9
147 #define MXT_GRIPFACE_SHPTHR2 10
148 #define MXT_GRIPFACE_SUPEXTTO 11
150 /* MXT_PROCI_NOISE field */
151 #define MXT_NOISE_CTRL 0
152 #define MXT_NOISE_OUTFLEN 1
153 #define MXT_NOISE_GCAFUL_LSB 3
154 #define MXT_NOISE_GCAFUL_MSB 4
155 #define MXT_NOISE_GCAFLL_LSB 5
156 #define MXT_NOISE_GCAFLL_MSB 6
157 #define MXT_NOISE_ACTVGCAFVALID 7
158 #define MXT_NOISE_NOISETHR 8
159 #define MXT_NOISE_FREQHOPSCALE 10
160 #define MXT_NOISE_FREQ0 11
161 #define MXT_NOISE_FREQ1 12
162 #define MXT_NOISE_FREQ2 13
163 #define MXT_NOISE_FREQ3 14
164 #define MXT_NOISE_FREQ4 15
165 #define MXT_NOISE_IDLEGCAFVALID 16
167 /* MXT_SPT_COMMSCONFIG_T18 */
168 #define MXT_COMMS_CTRL 0
169 #define MXT_COMMS_CMD 1
171 /* MXT_SPT_CTECONFIG_T28 field */
172 #define MXT_CTE_CTRL 0
173 #define MXT_CTE_CMD 1
174 #define MXT_CTE_MODE 2
175 #define MXT_CTE_IDLEGCAFDEPTH 3
176 #define MXT_CTE_ACTVGCAFDEPTH 4
177 #define MXT_CTE_VOLTAGE 5
179 #define MXT_VOLTAGE_DEFAULT 2700000
180 #define MXT_VOLTAGE_STEP 10000
182 /* Define for MXT_GEN_COMMAND_T6 */
183 #define MXT_BOOT_VALUE 0xa5
184 #define MXT_RESET_VALUE 0x01
185 #define MXT_BACKUP_VALUE 0x55
188 #define MXT_BACKUP_TIME 50 /* msec */
189 #define MXT_RESET_TIME 200 /* msec */
190 #define MXT_RESET_TIMEOUT 3000 /* msec */
191 #define MXT_FW_RESET_TIME 3000 /* msec */
192 #define MXT_FW_CHG_TIMEOUT 300 /* msec */
194 /* Command to unlock bootloader */
195 #define MXT_UNLOCK_CMD_MSB 0xaa
196 #define MXT_UNLOCK_CMD_LSB 0xdc
198 /* Bootloader mode status */
199 #define MXT_WAITING_BOOTLOAD_CMD 0xc0 /* valid 7 6 bit only */
200 #define MXT_WAITING_FRAME_DATA 0x80 /* valid 7 6 bit only */
201 #define MXT_FRAME_CRC_CHECK 0x02
202 #define MXT_FRAME_CRC_FAIL 0x03
203 #define MXT_FRAME_CRC_PASS 0x04
204 #define MXT_APP_CRC_FAIL 0x40 /* valid 7 8 bit only */
205 #define MXT_BOOT_STATUS_MASK 0x3f
208 #define MXT_UNGRIP (1 << 0)
209 #define MXT_SUPPRESS (1 << 1)
210 #define MXT_AMP (1 << 2)
211 #define MXT_VECTOR (1 << 3)
212 #define MXT_MOVE (1 << 4)
213 #define MXT_RELEASE (1 << 5)
214 #define MXT_PRESS (1 << 6)
215 #define MXT_DETECT (1 << 7)
217 /* Touch orient bits */
218 #define MXT_XY_SWITCH (1 << 0)
219 #define MXT_X_INVERT (1 << 1)
220 #define MXT_Y_INVERT (1 << 2)
222 /* Touchscreen absolute values */
223 #define MXT_MAX_AREA 0xff
225 #define MXT_PIXELS_PER_MM 20
241 u8 instances_minus_one;
250 /* Each client has this additional data */
252 struct i2c_client *client;
253 struct input_dev *input_dev;
254 char phys[64]; /* device physical location */
255 const struct mxt_platform_data *pdata;
256 struct mxt_object *object_table;
257 struct mxt_info info;
263 /* Cached parameters from object table */
270 /* for fw update in bootloader */
271 struct completion bl_completion;
273 /* for reset handling */
274 struct completion reset_completion;
277 static size_t mxt_obj_size(const struct mxt_object *obj)
279 return obj->size_minus_one + 1;
282 static size_t mxt_obj_instances(const struct mxt_object *obj)
284 return obj->instances_minus_one + 1;
287 static bool mxt_object_readable(unsigned int type)
290 case MXT_GEN_COMMAND_T6:
291 case MXT_GEN_POWER_T7:
292 case MXT_GEN_ACQUIRE_T8:
293 case MXT_GEN_DATASOURCE_T53:
294 case MXT_TOUCH_MULTI_T9:
295 case MXT_TOUCH_KEYARRAY_T15:
296 case MXT_TOUCH_PROXIMITY_T23:
297 case MXT_TOUCH_PROXKEY_T52:
298 case MXT_PROCI_GRIPFACE_T20:
299 case MXT_PROCG_NOISE_T22:
300 case MXT_PROCI_ONETOUCH_T24:
301 case MXT_PROCI_TWOTOUCH_T27:
302 case MXT_PROCI_GRIP_T40:
303 case MXT_PROCI_PALM_T41:
304 case MXT_PROCI_TOUCHSUPPRESSION_T42:
305 case MXT_PROCI_STYLUS_T47:
306 case MXT_PROCG_NOISESUPPRESSION_T48:
307 case MXT_SPT_COMMSCONFIG_T18:
308 case MXT_SPT_GPIOPWM_T19:
309 case MXT_SPT_SELFTEST_T25:
310 case MXT_SPT_CTECONFIG_T28:
311 case MXT_SPT_USERDATA_T38:
312 case MXT_SPT_DIGITIZER_T43:
313 case MXT_SPT_CTECONFIG_T46:
320 static bool mxt_object_writable(unsigned int type)
323 case MXT_GEN_COMMAND_T6:
324 case MXT_GEN_POWER_T7:
325 case MXT_GEN_ACQUIRE_T8:
326 case MXT_TOUCH_MULTI_T9:
327 case MXT_TOUCH_KEYARRAY_T15:
328 case MXT_TOUCH_PROXIMITY_T23:
329 case MXT_TOUCH_PROXKEY_T52:
330 case MXT_PROCI_GRIPFACE_T20:
331 case MXT_PROCG_NOISE_T22:
332 case MXT_PROCI_ONETOUCH_T24:
333 case MXT_PROCI_TWOTOUCH_T27:
334 case MXT_PROCI_GRIP_T40:
335 case MXT_PROCI_PALM_T41:
336 case MXT_PROCI_TOUCHSUPPRESSION_T42:
337 case MXT_PROCI_STYLUS_T47:
338 case MXT_PROCG_NOISESUPPRESSION_T48:
339 case MXT_SPT_COMMSCONFIG_T18:
340 case MXT_SPT_GPIOPWM_T19:
341 case MXT_SPT_SELFTEST_T25:
342 case MXT_SPT_CTECONFIG_T28:
343 case MXT_SPT_DIGITIZER_T43:
344 case MXT_SPT_CTECONFIG_T46:
351 static void mxt_dump_message(struct device *dev,
352 struct mxt_message *message)
354 dev_dbg(dev, "reportid: %u\tmessage: %*ph\n",
355 message->reportid, 7, message->message);
358 static int mxt_wait_for_completion(struct mxt_data *data,
359 struct completion *comp,
360 unsigned int timeout_ms)
362 struct device *dev = &data->client->dev;
363 unsigned long timeout = msecs_to_jiffies(timeout_ms);
366 ret = wait_for_completion_interruptible_timeout(comp, timeout);
369 } else if (ret == 0) {
370 dev_err(dev, "Wait for completion timed out.\n");
376 static int mxt_check_bootloader(struct mxt_data *data, unsigned int state)
378 struct i2c_client *client = data->client;
383 if (state != MXT_WAITING_BOOTLOAD_CMD) {
385 * In application update mode, the interrupt
386 * line signals state transitions. We must wait for the
387 * CHG assertion before reading the status byte.
388 * Once the status byte has been read, the line is deasserted.
390 ret = mxt_wait_for_completion(data, &data->bl_completion,
394 * TODO: handle -ERESTARTSYS better by terminating
395 * fw update process before returning to userspace
396 * by writing length 0x000 to device (iff we are in
397 * WAITING_FRAME_DATA state).
399 dev_err(&client->dev, "Update wait error %d\n", ret);
404 if (i2c_master_recv(client, &val, 1) != 1) {
405 dev_err(&client->dev, "%s: i2c recv failed\n", __func__);
410 case MXT_WAITING_BOOTLOAD_CMD:
411 case MXT_WAITING_FRAME_DATA:
412 val &= ~MXT_BOOT_STATUS_MASK;
414 case MXT_FRAME_CRC_PASS:
415 if (val == MXT_FRAME_CRC_CHECK)
423 dev_err(&client->dev, "Unvalid bootloader mode state\n");
430 static int mxt_unlock_bootloader(struct i2c_client *client)
434 buf[0] = MXT_UNLOCK_CMD_LSB;
435 buf[1] = MXT_UNLOCK_CMD_MSB;
437 if (i2c_master_send(client, buf, 2) != 2) {
438 dev_err(&client->dev, "%s: i2c send failed\n", __func__);
445 static int mxt_fw_write(struct i2c_client *client,
446 const u8 *data, unsigned int frame_size)
448 if (i2c_master_send(client, data, frame_size) != frame_size) {
449 dev_err(&client->dev, "%s: i2c send failed\n", __func__);
456 static int __mxt_read_reg(struct i2c_client *client,
457 u16 reg, u16 len, void *val)
459 struct i2c_msg xfer[2];
464 buf[1] = (reg >> 8) & 0xff;
467 xfer[0].addr = client->addr;
473 xfer[1].addr = client->addr;
474 xfer[1].flags = I2C_M_RD;
478 ret = i2c_transfer(client->adapter, xfer, 2);
484 dev_err(&client->dev, "%s: i2c transfer failed (%d)\n",
491 static int mxt_read_reg(struct i2c_client *client, u16 reg, u8 *val)
493 return __mxt_read_reg(client, reg, 1, val);
496 static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len,
504 buf = kmalloc(count, GFP_KERNEL);
509 buf[1] = (reg >> 8) & 0xff;
510 memcpy(&buf[2], val, len);
512 ret = i2c_master_send(client, buf, count);
518 dev_err(&client->dev, "%s: i2c send failed (%d)\n",
526 static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
528 return __mxt_write_reg(client, reg, 1, &val);
531 static struct mxt_object *
532 mxt_get_object(struct mxt_data *data, u8 type)
534 struct mxt_object *object;
537 for (i = 0; i < data->info.object_num; i++) {
538 object = data->object_table + i;
539 if (object->type == type)
543 dev_err(&data->client->dev, "Invalid object type\n");
547 static int mxt_read_message(struct mxt_data *data,
548 struct mxt_message *message)
550 struct mxt_object *object;
553 object = mxt_get_object(data, MXT_GEN_MESSAGE_T5);
557 reg = object->start_address;
558 return __mxt_read_reg(data->client, reg,
559 sizeof(struct mxt_message), message);
562 static int mxt_write_object(struct mxt_data *data,
563 u8 type, u8 offset, u8 val)
565 struct mxt_object *object;
568 object = mxt_get_object(data, type);
569 if (!object || offset >= mxt_obj_size(object))
572 reg = object->start_address;
573 return mxt_write_reg(data->client, reg + offset, val);
576 static void mxt_input_button(struct mxt_data *data, struct mxt_message *message)
578 struct input_dev *input = data->input_dev;
579 const struct mxt_platform_data *pdata = data->pdata;
583 /* Active-low switch */
584 for (i = 0; i < pdata->t19_num_keys; i++) {
585 if (pdata->t19_keymap[i] == KEY_RESERVED)
587 button = !(message->message[0] & (1 << i));
588 input_report_key(input, pdata->t19_keymap[i], button);
592 static void mxt_input_touchevent(struct mxt_data *data,
593 struct mxt_message *message, int id)
595 struct device *dev = &data->client->dev;
596 u8 status = message->message[0];
597 struct input_dev *input_dev = data->input_dev;
603 x = (message->message[1] << 4) | ((message->message[3] >> 4) & 0xf);
604 y = (message->message[2] << 4) | ((message->message[3] & 0xf));
605 if (data->max_x < 1024)
607 if (data->max_y < 1024)
610 area = message->message[4];
611 pressure = message->message[5];
614 "[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
616 (status & MXT_DETECT) ? 'D' : '.',
617 (status & MXT_PRESS) ? 'P' : '.',
618 (status & MXT_RELEASE) ? 'R' : '.',
619 (status & MXT_MOVE) ? 'M' : '.',
620 (status & MXT_VECTOR) ? 'V' : '.',
621 (status & MXT_AMP) ? 'A' : '.',
622 (status & MXT_SUPPRESS) ? 'S' : '.',
623 (status & MXT_UNGRIP) ? 'U' : '.',
624 x, y, area, pressure);
626 input_mt_slot(input_dev, id);
627 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER,
628 status & MXT_DETECT);
630 if (status & MXT_DETECT) {
631 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
632 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
633 input_report_abs(input_dev, ABS_MT_PRESSURE, pressure);
634 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
638 static unsigned mxt_extract_T6_csum(const u8 *csum)
640 return csum[0] | (csum[1] << 8) | (csum[2] << 16);
643 static bool mxt_is_T9_message(struct mxt_data *data, struct mxt_message *msg)
645 u8 id = msg->reportid;
646 return (id >= data->T9_reportid_min && id <= data->T9_reportid_max);
649 static irqreturn_t mxt_process_messages_until_invalid(struct mxt_data *data)
651 struct mxt_message message;
652 const u8 *payload = &message.message[0];
653 struct device *dev = &data->client->dev;
655 bool update_input = false;
658 if (mxt_read_message(data, &message)) {
659 dev_err(dev, "Failed to read message\n");
663 reportid = message.reportid;
665 if (reportid == data->T6_reportid) {
666 u8 status = payload[0];
667 unsigned csum = mxt_extract_T6_csum(&payload[1]);
668 dev_dbg(dev, "Status: %02x Config Checksum: %06x\n",
671 if (status & MXT_T6_STATUS_RESET)
672 complete(&data->reset_completion);
673 } else if (mxt_is_T9_message(data, &message)) {
674 int id = reportid - data->T9_reportid_min;
675 mxt_input_touchevent(data, &message, id);
677 } else if (message.reportid == data->T19_reportid) {
678 mxt_input_button(data, &message);
681 mxt_dump_message(dev, &message);
683 } while (reportid != 0xff);
686 input_mt_report_pointer_emulation(data->input_dev, false);
687 input_sync(data->input_dev);
693 static irqreturn_t mxt_interrupt(int irq, void *dev_id)
695 struct mxt_data *data = dev_id;
697 if (data->in_bootloader) {
698 /* bootloader state transition completion */
699 complete(&data->bl_completion);
703 return mxt_process_messages_until_invalid(data);
706 static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset,
711 int timeout_counter = 0;
714 reg = data->T6_address + cmd_offset;
716 ret = mxt_write_reg(data->client, reg, value);
725 ret = __mxt_read_reg(data->client, reg, 1, &command_register);
728 } while (command_register != 0 && timeout_counter++ <= 100);
730 if (timeout_counter > 100) {
731 dev_err(&data->client->dev, "Command failed!\n");
738 static int mxt_soft_reset(struct mxt_data *data)
740 struct device *dev = &data->client->dev;
743 dev_info(dev, "Resetting chip\n");
745 reinit_completion(&data->reset_completion);
747 ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false);
751 ret = mxt_wait_for_completion(data, &data->reset_completion,
759 static int mxt_check_reg_init(struct mxt_data *data)
761 const struct mxt_platform_data *pdata = data->pdata;
762 struct mxt_object *object;
763 struct device *dev = &data->client->dev;
768 if (!pdata->config) {
769 dev_dbg(dev, "No cfg data defined, skipping reg init\n");
773 for (i = 0; i < data->info.object_num; i++) {
774 object = data->object_table + i;
776 if (!mxt_object_writable(object->type))
779 size = mxt_obj_size(object) * mxt_obj_instances(object);
780 if (index + size > pdata->config_length) {
781 dev_err(dev, "Not enough config data!\n");
785 ret = __mxt_write_reg(data->client, object->start_address,
786 size, &pdata->config[index]);
795 static int mxt_make_highchg(struct mxt_data *data)
797 struct device *dev = &data->client->dev;
798 struct mxt_message message;
802 /* Read dummy message to make high CHG pin */
804 error = mxt_read_message(data, &message);
807 } while (message.reportid != 0xff && --count);
810 dev_err(dev, "CHG pin isn't cleared\n");
817 static int mxt_get_info(struct mxt_data *data)
819 struct i2c_client *client = data->client;
820 struct mxt_info *info = &data->info;
823 /* Read 7-byte info block starting at address 0 */
824 error = __mxt_read_reg(client, MXT_INFO, sizeof(*info), info);
831 static int mxt_get_object_table(struct mxt_data *data)
833 struct i2c_client *client = data->client;
839 table_size = data->info.object_num * sizeof(struct mxt_object);
840 error = __mxt_read_reg(client, MXT_OBJECT_START, table_size,
845 /* Valid Report IDs start counting from 1 */
847 for (i = 0; i < data->info.object_num; i++) {
848 struct mxt_object *object = data->object_table + i;
851 le16_to_cpus(&object->start_address);
853 if (object->num_report_ids) {
855 reportid += object->num_report_ids *
856 mxt_obj_instances(object);
857 max_id = reportid - 1;
863 dev_dbg(&data->client->dev,
864 "Type %2d Start %3d Size %3zd Instances %2zd ReportIDs %3u : %3u\n",
865 object->type, object->start_address,
866 mxt_obj_size(object), mxt_obj_instances(object),
869 switch (object->type) {
870 case MXT_GEN_COMMAND_T6:
871 data->T6_reportid = min_id;
872 data->T6_address = object->start_address;
874 case MXT_TOUCH_MULTI_T9:
875 data->T9_reportid_min = min_id;
876 data->T9_reportid_max = max_id;
878 case MXT_SPT_GPIOPWM_T19:
879 data->T19_reportid = min_id;
887 static void mxt_free_object_table(struct mxt_data *data)
889 kfree(data->object_table);
890 data->object_table = NULL;
891 data->T6_reportid = 0;
892 data->T9_reportid_min = 0;
893 data->T9_reportid_max = 0;
894 data->T19_reportid = 0;
897 static int mxt_initialize(struct mxt_data *data)
899 struct i2c_client *client = data->client;
900 struct mxt_info *info = &data->info;
904 error = mxt_get_info(data);
908 data->object_table = kcalloc(info->object_num,
909 sizeof(struct mxt_object),
911 if (!data->object_table) {
912 dev_err(&client->dev, "Failed to allocate memory\n");
916 /* Get object table information */
917 error = mxt_get_object_table(data);
919 goto err_free_object_table;
921 /* Check register init values */
922 error = mxt_check_reg_init(data);
924 goto err_free_object_table;
926 error = mxt_t6_command(data, MXT_COMMAND_BACKUPNV,
927 MXT_BACKUP_VALUE, false);
929 mxt_soft_reset(data);
931 /* Update matrix size at info struct */
932 error = mxt_read_reg(client, MXT_MATRIX_X_SIZE, &val);
934 goto err_free_object_table;
935 info->matrix_xsize = val;
937 error = mxt_read_reg(client, MXT_MATRIX_Y_SIZE, &val);
939 goto err_free_object_table;
940 info->matrix_ysize = val;
942 dev_info(&client->dev,
943 "Family ID: %u Variant ID: %u Major.Minor.Build: %u.%u.%02X\n",
944 info->family_id, info->variant_id, info->version >> 4,
945 info->version & 0xf, info->build);
947 dev_info(&client->dev,
948 "Matrix X Size: %u Matrix Y Size: %u Object Num: %u\n",
949 info->matrix_xsize, info->matrix_ysize,
954 err_free_object_table:
955 mxt_free_object_table(data);
959 static void mxt_calc_resolution(struct mxt_data *data)
961 unsigned int max_x = data->pdata->x_size - 1;
962 unsigned int max_y = data->pdata->y_size - 1;
964 if (data->pdata->orient & MXT_XY_SWITCH) {
973 /* Firmware Version is returned as Major.Minor.Build */
974 static ssize_t mxt_fw_version_show(struct device *dev,
975 struct device_attribute *attr, char *buf)
977 struct mxt_data *data = dev_get_drvdata(dev);
978 struct mxt_info *info = &data->info;
979 return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
980 info->version >> 4, info->version & 0xf, info->build);
983 /* Hardware Version is returned as FamilyID.VariantID */
984 static ssize_t mxt_hw_version_show(struct device *dev,
985 struct device_attribute *attr, char *buf)
987 struct mxt_data *data = dev_get_drvdata(dev);
988 struct mxt_info *info = &data->info;
989 return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
990 info->family_id, info->variant_id);
993 static ssize_t mxt_show_instance(char *buf, int count,
994 struct mxt_object *object, int instance,
999 if (mxt_obj_instances(object) > 1)
1000 count += scnprintf(buf + count, PAGE_SIZE - count,
1001 "Instance %u\n", instance);
1003 for (i = 0; i < mxt_obj_size(object); i++)
1004 count += scnprintf(buf + count, PAGE_SIZE - count,
1005 "\t[%2u]: %02x (%d)\n", i, val[i], val[i]);
1006 count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
1011 static ssize_t mxt_object_show(struct device *dev,
1012 struct device_attribute *attr, char *buf)
1014 struct mxt_data *data = dev_get_drvdata(dev);
1015 struct mxt_object *object;
1021 /* Pre-allocate buffer large enough to hold max sized object. */
1022 obuf = kmalloc(256, GFP_KERNEL);
1027 for (i = 0; i < data->info.object_num; i++) {
1028 object = data->object_table + i;
1030 if (!mxt_object_readable(object->type))
1033 count += scnprintf(buf + count, PAGE_SIZE - count,
1034 "T%u:\n", object->type);
1036 for (j = 0; j < mxt_obj_instances(object); j++) {
1037 u16 size = mxt_obj_size(object);
1038 u16 addr = object->start_address + j * size;
1040 error = __mxt_read_reg(data->client, addr, size, obuf);
1044 count = mxt_show_instance(buf, count, object, j, obuf);
1050 return error ?: count;
1053 static int mxt_load_fw(struct device *dev, const char *fn)
1055 struct mxt_data *data = dev_get_drvdata(dev);
1056 struct i2c_client *client = data->client;
1057 const struct firmware *fw = NULL;
1058 unsigned int frame_size;
1059 unsigned int pos = 0;
1062 ret = request_firmware(&fw, fn, dev);
1064 dev_err(dev, "Unable to open firmware %s\n", fn);
1068 /* Change to the bootloader mode */
1069 data->in_bootloader = true;
1071 ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_BOOT_VALUE, false);
1073 goto release_firmware;
1075 msleep(MXT_RESET_TIME);
1077 /* Change to slave address of bootloader */
1078 if (client->addr == MXT_APP_LOW)
1079 client->addr = MXT_BOOT_LOW;
1081 client->addr = MXT_BOOT_HIGH;
1083 reinit_completion(&data->bl_completion);
1085 ret = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD);
1089 /* Unlock bootloader */
1090 mxt_unlock_bootloader(client);
1092 while (pos < fw->size) {
1093 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA);
1097 frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
1099 /* We should add 2 at frame size as the the firmware data is not
1100 * included the CRC bytes.
1104 /* Write one frame to device */
1105 mxt_fw_write(client, fw->data + pos, frame_size);
1107 ret = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS);
1113 dev_dbg(dev, "Updated %d bytes / %zd bytes\n", pos, fw->size);
1116 /* Wait for flash. */
1117 ret = mxt_wait_for_completion(data, &data->bl_completion,
1123 * Wait for device to reset. Some bootloader versions do not assert
1124 * the CHG line after bootloading has finished, so ignore potential
1127 mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME);
1129 data->in_bootloader = false;
1132 disable_irq(data->irq);
1134 release_firmware(fw);
1136 /* Change to slave address of application */
1137 if (client->addr == MXT_BOOT_LOW)
1138 client->addr = MXT_APP_LOW;
1140 client->addr = MXT_APP_HIGH;
1145 static ssize_t mxt_update_fw_store(struct device *dev,
1146 struct device_attribute *attr,
1147 const char *buf, size_t count)
1149 struct mxt_data *data = dev_get_drvdata(dev);
1152 error = mxt_load_fw(dev, MXT_FW_NAME);
1154 dev_err(dev, "The firmware update failed(%d)\n", error);
1157 dev_dbg(dev, "The firmware update succeeded\n");
1158 mxt_free_object_table(data);
1160 mxt_initialize(data);
1162 enable_irq(data->irq);
1164 error = mxt_make_highchg(data);
1172 static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
1173 static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
1174 static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
1175 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
1177 static struct attribute *mxt_attrs[] = {
1178 &dev_attr_fw_version.attr,
1179 &dev_attr_hw_version.attr,
1180 &dev_attr_object.attr,
1181 &dev_attr_update_fw.attr,
1185 static const struct attribute_group mxt_attr_group = {
1189 static void mxt_start(struct mxt_data *data)
1192 mxt_write_object(data,
1193 MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0x83);
1196 static void mxt_stop(struct mxt_data *data)
1199 mxt_write_object(data,
1200 MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0);
1203 static int mxt_input_open(struct input_dev *dev)
1205 struct mxt_data *data = input_get_drvdata(dev);
1212 static void mxt_input_close(struct input_dev *dev)
1214 struct mxt_data *data = input_get_drvdata(dev);
1219 static int mxt_probe(struct i2c_client *client,
1220 const struct i2c_device_id *id)
1222 const struct mxt_platform_data *pdata = dev_get_platdata(&client->dev);
1223 struct mxt_data *data;
1224 struct input_dev *input_dev;
1226 unsigned int num_mt_slots;
1227 unsigned int mt_flags = 0;
1233 data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL);
1234 input_dev = input_allocate_device();
1235 if (!data || !input_dev) {
1236 dev_err(&client->dev, "Failed to allocate memory\n");
1241 input_dev->name = "Atmel maXTouch Touchscreen";
1242 snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
1243 client->adapter->nr, client->addr);
1245 input_dev->phys = data->phys;
1247 input_dev->id.bustype = BUS_I2C;
1248 input_dev->dev.parent = &client->dev;
1249 input_dev->open = mxt_input_open;
1250 input_dev->close = mxt_input_close;
1252 data->client = client;
1253 data->input_dev = input_dev;
1254 data->pdata = pdata;
1255 data->irq = client->irq;
1257 init_completion(&data->bl_completion);
1258 init_completion(&data->reset_completion);
1260 mxt_calc_resolution(data);
1262 error = mxt_initialize(data);
1266 __set_bit(EV_ABS, input_dev->evbit);
1267 __set_bit(EV_KEY, input_dev->evbit);
1268 __set_bit(BTN_TOUCH, input_dev->keybit);
1270 if (pdata->t19_num_keys) {
1271 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
1273 for (i = 0; i < pdata->t19_num_keys; i++)
1274 if (pdata->t19_keymap[i] != KEY_RESERVED)
1275 input_set_capability(input_dev, EV_KEY,
1276 pdata->t19_keymap[i]);
1278 mt_flags |= INPUT_MT_POINTER;
1280 input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM);
1281 input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM);
1282 input_abs_set_res(input_dev, ABS_MT_POSITION_X,
1284 input_abs_set_res(input_dev, ABS_MT_POSITION_Y,
1287 input_dev->name = "Atmel maXTouch Touchpad";
1290 /* For single touch */
1291 input_set_abs_params(input_dev, ABS_X,
1292 0, data->max_x, 0, 0);
1293 input_set_abs_params(input_dev, ABS_Y,
1294 0, data->max_y, 0, 0);
1295 input_set_abs_params(input_dev, ABS_PRESSURE,
1298 /* For multi touch */
1299 num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
1300 error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags);
1302 goto err_free_object;
1303 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
1304 0, MXT_MAX_AREA, 0, 0);
1305 input_set_abs_params(input_dev, ABS_MT_POSITION_X,
1306 0, data->max_x, 0, 0);
1307 input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
1308 0, data->max_y, 0, 0);
1309 input_set_abs_params(input_dev, ABS_MT_PRESSURE,
1312 input_set_drvdata(input_dev, data);
1313 i2c_set_clientdata(client, data);
1315 error = request_threaded_irq(client->irq, NULL, mxt_interrupt,
1316 pdata->irqflags | IRQF_ONESHOT,
1317 client->name, data);
1319 dev_err(&client->dev, "Failed to register interrupt\n");
1320 goto err_free_object;
1323 error = mxt_make_highchg(data);
1327 error = input_register_device(input_dev);
1331 error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
1333 goto err_unregister_device;
1337 err_unregister_device:
1338 input_unregister_device(input_dev);
1341 free_irq(client->irq, data);
1343 kfree(data->object_table);
1345 input_free_device(input_dev);
1350 static int mxt_remove(struct i2c_client *client)
1352 struct mxt_data *data = i2c_get_clientdata(client);
1354 sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
1355 free_irq(data->irq, data);
1356 input_unregister_device(data->input_dev);
1357 kfree(data->object_table);
1363 #ifdef CONFIG_PM_SLEEP
1364 static int mxt_suspend(struct device *dev)
1366 struct i2c_client *client = to_i2c_client(dev);
1367 struct mxt_data *data = i2c_get_clientdata(client);
1368 struct input_dev *input_dev = data->input_dev;
1370 mutex_lock(&input_dev->mutex);
1372 if (input_dev->users)
1375 mutex_unlock(&input_dev->mutex);
1380 static int mxt_resume(struct device *dev)
1382 struct i2c_client *client = to_i2c_client(dev);
1383 struct mxt_data *data = i2c_get_clientdata(client);
1384 struct input_dev *input_dev = data->input_dev;
1386 mxt_soft_reset(data);
1388 mutex_lock(&input_dev->mutex);
1390 if (input_dev->users)
1393 mutex_unlock(&input_dev->mutex);
1399 static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);
1401 static const struct i2c_device_id mxt_id[] = {
1402 { "qt602240_ts", 0 },
1403 { "atmel_mxt_ts", 0 },
1404 { "atmel_mxt_tp", 0 },
1408 MODULE_DEVICE_TABLE(i2c, mxt_id);
1410 static struct i2c_driver mxt_driver = {
1412 .name = "atmel_mxt_ts",
1413 .owner = THIS_MODULE,
1417 .remove = mxt_remove,
1421 module_i2c_driver(mxt_driver);
1423 /* Module information */
1424 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
1425 MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
1426 MODULE_LICENSE("GPL");