2 * Atmel maXTouch Touchscreen driver
4 * Copyright (C) 2010 Samsung Electronics Co.Ltd
5 * Copyright (C) 2011-2014 Atmel Corporation
6 * Copyright (C) 2012 Google, Inc.
8 * Author: Joonyoung Shim <jy0922.shim@samsung.com>
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the License, or (at your
13 * option) any later version.
17 #include <linux/module.h>
18 #include <linux/init.h>
19 #include <linux/completion.h>
20 #include <linux/delay.h>
21 #include <linux/firmware.h>
22 #include <linux/i2c.h>
23 #include <linux/i2c/atmel_mxt_ts.h>
24 #include <linux/input/mt.h>
25 #include <linux/interrupt.h>
27 #include <linux/slab.h>
35 #define MXT_FW_NAME "maxtouch.fw"
36 #define MXT_CFG_NAME "maxtouch.cfg"
37 #define MXT_CFG_MAGIC "OBP_RAW V1"
41 #define MXT_FAMILY_ID 0x00
42 #define MXT_VARIANT_ID 0x01
43 #define MXT_VERSION 0x02
44 #define MXT_BUILD 0x03
45 #define MXT_MATRIX_X_SIZE 0x04
46 #define MXT_MATRIX_Y_SIZE 0x05
47 #define MXT_OBJECT_NUM 0x06
48 #define MXT_OBJECT_START 0x07
50 #define MXT_OBJECT_SIZE 6
51 #define MXT_INFO_CHECKSUM_SIZE 3
52 #define MXT_MAX_BLOCK_WRITE 256
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_MESSAGE_T5 object */
84 #define MXT_RPTID_NOMSG 0xff
86 /* MXT_GEN_COMMAND_T6 field */
87 #define MXT_COMMAND_RESET 0
88 #define MXT_COMMAND_BACKUPNV 1
89 #define MXT_COMMAND_CALIBRATE 2
90 #define MXT_COMMAND_REPORTALL 3
91 #define MXT_COMMAND_DIAGNOSTIC 5
93 /* Define for T6 status byte */
94 #define MXT_T6_STATUS_RESET (1 << 7)
95 #define MXT_T6_STATUS_OFL (1 << 6)
96 #define MXT_T6_STATUS_SIGERR (1 << 5)
97 #define MXT_T6_STATUS_CAL (1 << 4)
98 #define MXT_T6_STATUS_CFGERR (1 << 3)
99 #define MXT_T6_STATUS_COMSERR (1 << 2)
101 /* MXT_GEN_POWER_T7 field */
102 #define MXT_POWER_IDLEACQINT 0
103 #define MXT_POWER_ACTVACQINT 1
104 #define MXT_POWER_ACTV2IDLETO 2
106 /* MXT_GEN_ACQUIRE_T8 field */
107 #define MXT_ACQUIRE_CHRGTIME 0
108 #define MXT_ACQUIRE_TCHDRIFT 2
109 #define MXT_ACQUIRE_DRIFTST 3
110 #define MXT_ACQUIRE_TCHAUTOCAL 4
111 #define MXT_ACQUIRE_SYNC 5
112 #define MXT_ACQUIRE_ATCHCALST 6
113 #define MXT_ACQUIRE_ATCHCALSTHR 7
115 /* MXT_TOUCH_MULTI_T9 field */
116 #define MXT_TOUCH_CTRL 0
117 #define MXT_T9_ORIENT 9
118 #define MXT_T9_RANGE 18
120 /* MXT_TOUCH_MULTI_T9 status */
121 #define MXT_T9_UNGRIP (1 << 0)
122 #define MXT_T9_SUPPRESS (1 << 1)
123 #define MXT_T9_AMP (1 << 2)
124 #define MXT_T9_VECTOR (1 << 3)
125 #define MXT_T9_MOVE (1 << 4)
126 #define MXT_T9_RELEASE (1 << 5)
127 #define MXT_T9_PRESS (1 << 6)
128 #define MXT_T9_DETECT (1 << 7)
135 /* MXT_TOUCH_MULTI_T9 orient */
136 #define MXT_T9_ORIENT_SWITCH (1 << 0)
138 /* MXT_PROCI_GRIPFACE_T20 field */
139 #define MXT_GRIPFACE_CTRL 0
140 #define MXT_GRIPFACE_XLOGRIP 1
141 #define MXT_GRIPFACE_XHIGRIP 2
142 #define MXT_GRIPFACE_YLOGRIP 3
143 #define MXT_GRIPFACE_YHIGRIP 4
144 #define MXT_GRIPFACE_MAXTCHS 5
145 #define MXT_GRIPFACE_SZTHR1 7
146 #define MXT_GRIPFACE_SZTHR2 8
147 #define MXT_GRIPFACE_SHPTHR1 9
148 #define MXT_GRIPFACE_SHPTHR2 10
149 #define MXT_GRIPFACE_SUPEXTTO 11
151 /* MXT_PROCI_NOISE field */
152 #define MXT_NOISE_CTRL 0
153 #define MXT_NOISE_OUTFLEN 1
154 #define MXT_NOISE_GCAFUL_LSB 3
155 #define MXT_NOISE_GCAFUL_MSB 4
156 #define MXT_NOISE_GCAFLL_LSB 5
157 #define MXT_NOISE_GCAFLL_MSB 6
158 #define MXT_NOISE_ACTVGCAFVALID 7
159 #define MXT_NOISE_NOISETHR 8
160 #define MXT_NOISE_FREQHOPSCALE 10
161 #define MXT_NOISE_FREQ0 11
162 #define MXT_NOISE_FREQ1 12
163 #define MXT_NOISE_FREQ2 13
164 #define MXT_NOISE_FREQ3 14
165 #define MXT_NOISE_FREQ4 15
166 #define MXT_NOISE_IDLEGCAFVALID 16
168 /* MXT_SPT_COMMSCONFIG_T18 */
169 #define MXT_COMMS_CTRL 0
170 #define MXT_COMMS_CMD 1
172 /* MXT_SPT_CTECONFIG_T28 field */
173 #define MXT_CTE_CTRL 0
174 #define MXT_CTE_CMD 1
175 #define MXT_CTE_MODE 2
176 #define MXT_CTE_IDLEGCAFDEPTH 3
177 #define MXT_CTE_ACTVGCAFDEPTH 4
178 #define MXT_CTE_VOLTAGE 5
180 #define MXT_VOLTAGE_DEFAULT 2700000
181 #define MXT_VOLTAGE_STEP 10000
183 /* Define for MXT_GEN_COMMAND_T6 */
184 #define MXT_BOOT_VALUE 0xa5
185 #define MXT_RESET_VALUE 0x01
186 #define MXT_BACKUP_VALUE 0x55
189 #define MXT_BACKUP_TIME 50 /* msec */
190 #define MXT_RESET_TIME 200 /* msec */
191 #define MXT_RESET_TIMEOUT 3000 /* msec */
192 #define MXT_CRC_TIMEOUT 1000 /* msec */
193 #define MXT_FW_RESET_TIME 3000 /* msec */
194 #define MXT_FW_CHG_TIMEOUT 300 /* msec */
196 /* Command to unlock bootloader */
197 #define MXT_UNLOCK_CMD_MSB 0xaa
198 #define MXT_UNLOCK_CMD_LSB 0xdc
200 /* Bootloader mode status */
201 #define MXT_WAITING_BOOTLOAD_CMD 0xc0 /* valid 7 6 bit only */
202 #define MXT_WAITING_FRAME_DATA 0x80 /* valid 7 6 bit only */
203 #define MXT_FRAME_CRC_CHECK 0x02
204 #define MXT_FRAME_CRC_FAIL 0x03
205 #define MXT_FRAME_CRC_PASS 0x04
206 #define MXT_APP_CRC_FAIL 0x40 /* valid 7 8 bit only */
207 #define MXT_BOOT_STATUS_MASK 0x3f
208 #define MXT_BOOT_EXTENDED_ID (1 << 5)
209 #define MXT_BOOT_ID_MASK 0x1f
211 /* Touchscreen absolute values */
212 #define MXT_MAX_AREA 0xff
214 #define MXT_PIXELS_PER_MM 20
230 u8 instances_minus_one;
234 /* Each client has this additional data */
236 struct i2c_client *client;
237 struct input_dev *input_dev;
238 char phys[64]; /* device physical location */
239 const struct mxt_platform_data *pdata;
240 struct mxt_object *object_table;
241 struct mxt_info info;
253 /* Cached parameters from object table */
262 /* for fw update in bootloader */
263 struct completion bl_completion;
265 /* for reset handling */
266 struct completion reset_completion;
268 /* for config update handling */
269 struct completion crc_completion;
272 static size_t mxt_obj_size(const struct mxt_object *obj)
274 return obj->size_minus_one + 1;
277 static size_t mxt_obj_instances(const struct mxt_object *obj)
279 return obj->instances_minus_one + 1;
282 static bool mxt_object_readable(unsigned int type)
285 case MXT_GEN_COMMAND_T6:
286 case MXT_GEN_POWER_T7:
287 case MXT_GEN_ACQUIRE_T8:
288 case MXT_GEN_DATASOURCE_T53:
289 case MXT_TOUCH_MULTI_T9:
290 case MXT_TOUCH_KEYARRAY_T15:
291 case MXT_TOUCH_PROXIMITY_T23:
292 case MXT_TOUCH_PROXKEY_T52:
293 case MXT_PROCI_GRIPFACE_T20:
294 case MXT_PROCG_NOISE_T22:
295 case MXT_PROCI_ONETOUCH_T24:
296 case MXT_PROCI_TWOTOUCH_T27:
297 case MXT_PROCI_GRIP_T40:
298 case MXT_PROCI_PALM_T41:
299 case MXT_PROCI_TOUCHSUPPRESSION_T42:
300 case MXT_PROCI_STYLUS_T47:
301 case MXT_PROCG_NOISESUPPRESSION_T48:
302 case MXT_SPT_COMMSCONFIG_T18:
303 case MXT_SPT_GPIOPWM_T19:
304 case MXT_SPT_SELFTEST_T25:
305 case MXT_SPT_CTECONFIG_T28:
306 case MXT_SPT_USERDATA_T38:
307 case MXT_SPT_DIGITIZER_T43:
308 case MXT_SPT_CTECONFIG_T46:
315 static void mxt_dump_message(struct mxt_data *data, u8 *message)
317 dev_dbg(&data->client->dev, "message: %*ph\n",
318 data->T5_msg_size, message);
321 static int mxt_wait_for_completion(struct mxt_data *data,
322 struct completion *comp,
323 unsigned int timeout_ms)
325 struct device *dev = &data->client->dev;
326 unsigned long timeout = msecs_to_jiffies(timeout_ms);
329 ret = wait_for_completion_interruptible_timeout(comp, timeout);
332 } else if (ret == 0) {
333 dev_err(dev, "Wait for completion timed out.\n");
339 static int mxt_bootloader_read(struct mxt_data *data,
340 u8 *val, unsigned int count)
345 msg.addr = data->bootloader_addr;
346 msg.flags = data->client->flags & I2C_M_TEN;
347 msg.flags |= I2C_M_RD;
351 ret = i2c_transfer(data->client->adapter, &msg, 1);
356 ret = ret < 0 ? ret : -EIO;
357 dev_err(&data->client->dev, "%s: i2c recv failed (%d)\n",
364 static int mxt_bootloader_write(struct mxt_data *data,
365 const u8 * const val, unsigned int count)
370 msg.addr = data->bootloader_addr;
371 msg.flags = data->client->flags & I2C_M_TEN;
375 ret = i2c_transfer(data->client->adapter, &msg, 1);
379 ret = ret < 0 ? ret : -EIO;
380 dev_err(&data->client->dev, "%s: i2c send failed (%d)\n",
387 static int mxt_lookup_bootloader_address(struct mxt_data *data, bool retry)
389 u8 appmode = data->client->addr;
395 /* Chips after 1664S use different scheme */
396 if (retry || data->info.family_id >= 0xa2) {
397 bootloader = appmode - 0x24;
400 /* Fall through for normal case */
405 bootloader = appmode - 0x26;
408 dev_err(&data->client->dev,
409 "Appmode i2c address 0x%02x not found\n",
414 data->bootloader_addr = bootloader;
418 static int mxt_probe_bootloader(struct mxt_data *data, bool retry)
420 struct device *dev = &data->client->dev;
425 ret = mxt_lookup_bootloader_address(data, retry);
429 ret = mxt_bootloader_read(data, &val, 1);
433 /* Check app crc fail mode */
434 crc_failure = (val & ~MXT_BOOT_STATUS_MASK) == MXT_APP_CRC_FAIL;
436 dev_err(dev, "Detected bootloader, status:%02X%s\n",
437 val, crc_failure ? ", APP_CRC_FAIL" : "");
442 static u8 mxt_get_bootloader_version(struct mxt_data *data, u8 val)
444 struct device *dev = &data->client->dev;
447 if (val & MXT_BOOT_EXTENDED_ID) {
448 if (mxt_bootloader_read(data, &buf[0], 3) != 0) {
449 dev_err(dev, "%s: i2c failure\n", __func__);
453 dev_dbg(dev, "Bootloader ID:%d Version:%d\n", buf[1], buf[2]);
457 dev_dbg(dev, "Bootloader ID:%d\n", val & MXT_BOOT_ID_MASK);
463 static int mxt_check_bootloader(struct mxt_data *data, unsigned int state,
466 struct device *dev = &data->client->dev;
473 * In application update mode, the interrupt
474 * line signals state transitions. We must wait for the
475 * CHG assertion before reading the status byte.
476 * Once the status byte has been read, the line is deasserted.
478 ret = mxt_wait_for_completion(data, &data->bl_completion,
482 * TODO: handle -ERESTARTSYS better by terminating
483 * fw update process before returning to userspace
484 * by writing length 0x000 to device (iff we are in
485 * WAITING_FRAME_DATA state).
487 dev_err(dev, "Update wait error %d\n", ret);
492 ret = mxt_bootloader_read(data, &val, 1);
496 if (state == MXT_WAITING_BOOTLOAD_CMD)
497 val = mxt_get_bootloader_version(data, val);
500 case MXT_WAITING_BOOTLOAD_CMD:
501 case MXT_WAITING_FRAME_DATA:
502 case MXT_APP_CRC_FAIL:
503 val &= ~MXT_BOOT_STATUS_MASK;
505 case MXT_FRAME_CRC_PASS:
506 if (val == MXT_FRAME_CRC_CHECK) {
508 } else if (val == MXT_FRAME_CRC_FAIL) {
509 dev_err(dev, "Bootloader CRC fail\n");
518 dev_err(dev, "Invalid bootloader state %02X != %02X\n",
526 static int mxt_send_bootloader_cmd(struct mxt_data *data, bool unlock)
532 buf[0] = MXT_UNLOCK_CMD_LSB;
533 buf[1] = MXT_UNLOCK_CMD_MSB;
539 ret = mxt_bootloader_write(data, buf, 2);
546 static int __mxt_read_reg(struct i2c_client *client,
547 u16 reg, u16 len, void *val)
549 struct i2c_msg xfer[2];
554 buf[1] = (reg >> 8) & 0xff;
557 xfer[0].addr = client->addr;
563 xfer[1].addr = client->addr;
564 xfer[1].flags = I2C_M_RD;
568 ret = i2c_transfer(client->adapter, xfer, 2);
574 dev_err(&client->dev, "%s: i2c transfer failed (%d)\n",
581 static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len,
589 buf = kmalloc(count, GFP_KERNEL);
594 buf[1] = (reg >> 8) & 0xff;
595 memcpy(&buf[2], val, len);
597 ret = i2c_master_send(client, buf, count);
603 dev_err(&client->dev, "%s: i2c send failed (%d)\n",
611 static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
613 return __mxt_write_reg(client, reg, 1, &val);
616 static struct mxt_object *
617 mxt_get_object(struct mxt_data *data, u8 type)
619 struct mxt_object *object;
622 for (i = 0; i < data->info.object_num; i++) {
623 object = data->object_table + i;
624 if (object->type == type)
628 dev_warn(&data->client->dev, "Invalid object type T%u\n", type);
632 static void mxt_proc_t6_messages(struct mxt_data *data, u8 *msg)
634 struct device *dev = &data->client->dev;
636 u32 crc = msg[2] | (msg[3] << 8) | (msg[4] << 16);
638 complete(&data->crc_completion);
640 if (crc != data->config_crc) {
641 data->config_crc = crc;
642 dev_dbg(dev, "T6 Config Checksum: 0x%06X\n", crc);
646 if (status & MXT_T6_STATUS_RESET)
647 complete(&data->reset_completion);
649 /* Output debug if status has changed */
650 if (status != data->t6_status)
651 dev_dbg(dev, "T6 Status 0x%02X%s%s%s%s%s%s%s\n",
653 status == 0 ? " OK" : "",
654 status & MXT_T6_STATUS_RESET ? " RESET" : "",
655 status & MXT_T6_STATUS_OFL ? " OFL" : "",
656 status & MXT_T6_STATUS_SIGERR ? " SIGERR" : "",
657 status & MXT_T6_STATUS_CAL ? " CAL" : "",
658 status & MXT_T6_STATUS_CFGERR ? " CFGERR" : "",
659 status & MXT_T6_STATUS_COMSERR ? " COMSERR" : "");
661 /* Save current status */
662 data->t6_status = status;
665 static int mxt_read_message(struct mxt_data *data, u8 *message)
667 struct mxt_object *object;
670 object = mxt_get_object(data, MXT_GEN_MESSAGE_T5);
674 reg = object->start_address;
675 return __mxt_read_reg(data->client, reg,
676 data->T5_msg_size, message);
679 static int mxt_write_object(struct mxt_data *data,
680 u8 type, u8 offset, u8 val)
682 struct mxt_object *object;
685 object = mxt_get_object(data, type);
686 if (!object || offset >= mxt_obj_size(object))
689 reg = object->start_address;
690 return mxt_write_reg(data->client, reg + offset, val);
693 static void mxt_input_button(struct mxt_data *data, u8 *message)
695 struct input_dev *input = data->input_dev;
696 const struct mxt_platform_data *pdata = data->pdata;
700 /* Active-low switch */
701 for (i = 0; i < pdata->t19_num_keys; i++) {
702 if (pdata->t19_keymap[i] == KEY_RESERVED)
704 button = !(message[1] & (1 << i));
705 input_report_key(input, pdata->t19_keymap[i], button);
709 static void mxt_input_sync(struct mxt_data *data)
711 input_mt_report_pointer_emulation(data->input_dev,
712 data->pdata->t19_num_keys);
713 input_sync(data->input_dev);
716 static void mxt_input_touchevent(struct mxt_data *data, u8 *message)
718 struct device *dev = &data->client->dev;
719 struct input_dev *input_dev = data->input_dev;
727 id = message[0] - data->T9_reportid_min;
729 x = (message[2] << 4) | ((message[4] >> 4) & 0xf);
730 y = (message[3] << 4) | ((message[4] & 0xf));
732 /* Handle 10/12 bit switching */
733 if (data->max_x < 1024)
735 if (data->max_y < 1024)
739 amplitude = message[6];
742 "[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
744 (status & MXT_T9_DETECT) ? 'D' : '.',
745 (status & MXT_T9_PRESS) ? 'P' : '.',
746 (status & MXT_T9_RELEASE) ? 'R' : '.',
747 (status & MXT_T9_MOVE) ? 'M' : '.',
748 (status & MXT_T9_VECTOR) ? 'V' : '.',
749 (status & MXT_T9_AMP) ? 'A' : '.',
750 (status & MXT_T9_SUPPRESS) ? 'S' : '.',
751 (status & MXT_T9_UNGRIP) ? 'U' : '.',
752 x, y, area, amplitude);
754 input_mt_slot(input_dev, id);
756 if (status & MXT_T9_DETECT) {
758 * Multiple bits may be set if the host is slow to read
759 * the status messages, indicating all the events that
762 if (status & MXT_T9_RELEASE) {
763 input_mt_report_slot_state(input_dev,
765 mxt_input_sync(data);
769 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 1);
770 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
771 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
772 input_report_abs(input_dev, ABS_MT_PRESSURE, amplitude);
773 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
775 /* Touch no longer active, close out slot */
776 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 0);
780 static bool mxt_is_T9_message(struct mxt_data *data, u8 *msg)
783 return (id >= data->T9_reportid_min && id <= data->T9_reportid_max);
786 static irqreturn_t mxt_process_messages_until_invalid(struct mxt_data *data)
788 u8 *message = &data->msg_buf[0];
789 struct device *dev = &data->client->dev;
791 bool update_input = false;
794 if (mxt_read_message(data, message)) {
795 dev_err(dev, "Failed to read message\n");
799 reportid = message[0];
801 if (reportid == data->T6_reportid) {
802 mxt_proc_t6_messages(data, message);
803 } else if (!data->input_dev) {
805 * do not report events if input device
806 * is not yet registered
808 mxt_dump_message(data, message);
809 } else if (mxt_is_T9_message(data, message)) {
810 mxt_input_touchevent(data, message);
812 } else if (reportid == data->T19_reportid) {
813 mxt_input_button(data, message);
816 mxt_dump_message(data, message);
818 } while (reportid != MXT_RPTID_NOMSG);
821 mxt_input_sync(data);
826 static irqreturn_t mxt_interrupt(int irq, void *dev_id)
828 struct mxt_data *data = dev_id;
830 if (data->in_bootloader) {
831 /* bootloader state transition completion */
832 complete(&data->bl_completion);
836 if (!data->object_table)
839 return mxt_process_messages_until_invalid(data);
842 static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset,
847 int timeout_counter = 0;
850 reg = data->T6_address + cmd_offset;
852 ret = mxt_write_reg(data->client, reg, value);
861 ret = __mxt_read_reg(data->client, reg, 1, &command_register);
864 } while (command_register != 0 && timeout_counter++ <= 100);
866 if (timeout_counter > 100) {
867 dev_err(&data->client->dev, "Command failed!\n");
874 static int mxt_soft_reset(struct mxt_data *data)
876 struct device *dev = &data->client->dev;
879 dev_info(dev, "Resetting chip\n");
881 reinit_completion(&data->reset_completion);
883 ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false);
887 ret = mxt_wait_for_completion(data, &data->reset_completion,
895 static void mxt_update_crc(struct mxt_data *data, u8 cmd, u8 value)
898 * On failure, CRC is set to 0 and config will always be
901 data->config_crc = 0;
902 reinit_completion(&data->crc_completion);
904 mxt_t6_command(data, cmd, value, true);
907 * Wait for crc message. On failure, CRC is set to 0 and config will
908 * always be downloaded.
910 mxt_wait_for_completion(data, &data->crc_completion, MXT_CRC_TIMEOUT);
913 static void mxt_calc_crc24(u32 *crc, u8 firstbyte, u8 secondbyte)
915 static const unsigned int crcpoly = 0x80001B;
919 data_word = (secondbyte << 8) | firstbyte;
920 result = ((*crc << 1) ^ data_word);
922 if (result & 0x1000000)
928 static u32 mxt_calculate_crc(u8 *base, off_t start_off, off_t end_off)
931 u8 *ptr = base + start_off;
932 u8 *last_val = base + end_off - 1;
934 if (end_off < start_off)
937 while (ptr < last_val) {
938 mxt_calc_crc24(&crc, *ptr, *(ptr + 1));
942 /* if len is odd, fill the last byte with 0 */
944 mxt_calc_crc24(&crc, *ptr, 0);
953 * mxt_update_cfg - download configuration to chip
955 * Atmel Raw Config File Format
957 * The first four lines of the raw config file contain:
959 * 2) Chip ID Information (first 7 bytes of device memory)
960 * 3) Chip Information Block 24-bit CRC Checksum
961 * 4) Chip Configuration 24-bit CRC Checksum
963 * The rest of the file consists of one line per object instance:
964 * <TYPE> <INSTANCE> <SIZE> <CONTENTS>
966 * <TYPE> - 2-byte object type as hex
967 * <INSTANCE> - 2-byte object instance number as hex
968 * <SIZE> - 2-byte object size as hex
969 * <CONTENTS> - array of <SIZE> 1-byte hex values
971 static int mxt_update_cfg(struct mxt_data *data, const struct firmware *cfg)
973 struct device *dev = &data->client->dev;
974 struct mxt_info cfg_info;
975 struct mxt_object *object;
982 u32 info_crc, config_crc, calculated_crc;
984 size_t config_mem_size;
985 unsigned int type, instance, size;
989 mxt_update_crc(data, MXT_COMMAND_REPORTALL, 1);
991 if (strncmp(cfg->data, MXT_CFG_MAGIC, strlen(MXT_CFG_MAGIC))) {
992 dev_err(dev, "Unrecognised config file\n");
997 data_pos = strlen(MXT_CFG_MAGIC);
999 /* Load information block and check */
1000 for (i = 0; i < sizeof(struct mxt_info); i++) {
1001 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1002 (unsigned char *)&cfg_info + i,
1005 dev_err(dev, "Bad format\n");
1013 if (cfg_info.family_id != data->info.family_id) {
1014 dev_err(dev, "Family ID mismatch!\n");
1019 if (cfg_info.variant_id != data->info.variant_id) {
1020 dev_err(dev, "Variant ID mismatch!\n");
1026 ret = sscanf(cfg->data + data_pos, "%x%n", &info_crc, &offset);
1028 dev_err(dev, "Bad format: failed to parse Info CRC\n");
1034 ret = sscanf(cfg->data + data_pos, "%x%n", &config_crc, &offset);
1036 dev_err(dev, "Bad format: failed to parse Config CRC\n");
1043 * The Info Block CRC is calculated over mxt_info and the object
1044 * table. If it does not match then we are trying to load the
1045 * configuration from a different chip or firmware version, so
1046 * the configuration CRC is invalid anyway.
1048 if (info_crc == data->info_crc) {
1049 if (config_crc == 0 || data->config_crc == 0) {
1050 dev_info(dev, "CRC zero, attempting to apply config\n");
1051 } else if (config_crc == data->config_crc) {
1052 dev_dbg(dev, "Config CRC 0x%06X: OK\n",
1057 dev_info(dev, "Config CRC 0x%06X: does not match file 0x%06X\n",
1058 data->config_crc, config_crc);
1062 "Warning: Info CRC error - device=0x%06X file=0x%06X\n",
1063 data->info_crc, info_crc);
1066 /* Malloc memory to store configuration */
1067 cfg_start_ofs = MXT_OBJECT_START +
1068 data->info.object_num * sizeof(struct mxt_object) +
1069 MXT_INFO_CHECKSUM_SIZE;
1070 config_mem_size = data->mem_size - cfg_start_ofs;
1071 config_mem = kzalloc(config_mem_size, GFP_KERNEL);
1073 dev_err(dev, "Failed to allocate memory\n");
1078 while (data_pos < cfg->size) {
1079 /* Read type, instance, length */
1080 ret = sscanf(cfg->data + data_pos, "%x %x %x%n",
1081 &type, &instance, &size, &offset);
1085 } else if (ret != 3) {
1086 dev_err(dev, "Bad format: failed to parse object\n");
1092 object = mxt_get_object(data, type);
1095 for (i = 0; i < size; i++) {
1096 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1104 if (size > mxt_obj_size(object)) {
1106 * Either we are in fallback mode due to wrong
1107 * config or config from a later fw version,
1108 * or the file is corrupt or hand-edited.
1110 dev_warn(dev, "Discarding %zu byte(s) in T%u\n",
1111 size - mxt_obj_size(object), type);
1112 } else if (mxt_obj_size(object) > size) {
1114 * If firmware is upgraded, new bytes may be added to
1115 * end of objects. It is generally forward compatible
1116 * to zero these bytes - previous behaviour will be
1117 * retained. However this does invalidate the CRC and
1118 * will force fallback mode until the configuration is
1119 * updated. We warn here but do nothing else - the
1120 * malloc has zeroed the entire configuration.
1122 dev_warn(dev, "Zeroing %zu byte(s) in T%d\n",
1123 mxt_obj_size(object) - size, type);
1126 if (instance >= mxt_obj_instances(object)) {
1127 dev_err(dev, "Object instances exceeded!\n");
1132 reg = object->start_address + mxt_obj_size(object) * instance;
1134 for (i = 0; i < size; i++) {
1135 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1139 dev_err(dev, "Bad format in T%d\n", type);
1145 if (i > mxt_obj_size(object))
1148 byte_offset = reg + i - cfg_start_ofs;
1150 if ((byte_offset >= 0)
1151 && (byte_offset <= config_mem_size)) {
1152 *(config_mem + byte_offset) = val;
1154 dev_err(dev, "Bad object: reg:%d, T%d, ofs=%d\n",
1155 reg, object->type, byte_offset);
1162 /* Calculate crc of the received configs (not the raw config file) */
1163 if (data->T7_address < cfg_start_ofs) {
1164 dev_err(dev, "Bad T7 address, T7addr = %x, config offset %x\n",
1165 data->T7_address, cfg_start_ofs);
1170 calculated_crc = mxt_calculate_crc(config_mem,
1171 data->T7_address - cfg_start_ofs,
1174 if (config_crc > 0 && (config_crc != calculated_crc))
1175 dev_warn(dev, "Config CRC error, calculated=%06X, file=%06X\n",
1176 calculated_crc, config_crc);
1178 /* Write configuration as blocks */
1180 while (byte_offset < config_mem_size) {
1181 size = config_mem_size - byte_offset;
1183 if (size > MXT_MAX_BLOCK_WRITE)
1184 size = MXT_MAX_BLOCK_WRITE;
1186 ret = __mxt_write_reg(data->client,
1187 cfg_start_ofs + byte_offset,
1188 size, config_mem + byte_offset);
1190 dev_err(dev, "Config write error, ret=%d\n", ret);
1194 byte_offset += size;
1197 mxt_update_crc(data, MXT_COMMAND_BACKUPNV, MXT_BACKUP_VALUE);
1199 ret = mxt_soft_reset(data);
1203 dev_info(dev, "Config successfully updated\n");
1208 release_firmware(cfg);
1212 static int mxt_make_highchg(struct mxt_data *data)
1214 struct device *dev = &data->client->dev;
1218 /* Read dummy message to make high CHG pin */
1220 error = mxt_read_message(data, data->msg_buf);
1223 } while (data->msg_buf[0] != MXT_RPTID_NOMSG && --count);
1226 dev_err(dev, "CHG pin isn't cleared\n");
1233 static int mxt_acquire_irq(struct mxt_data *data)
1237 enable_irq(data->irq);
1239 error = mxt_make_highchg(data);
1246 static int mxt_get_info(struct mxt_data *data)
1248 struct i2c_client *client = data->client;
1249 struct mxt_info *info = &data->info;
1252 /* Read 7-byte info block starting at address 0 */
1253 error = __mxt_read_reg(client, MXT_INFO, sizeof(*info), info);
1260 static void mxt_free_object_table(struct mxt_data *data)
1262 input_unregister_device(data->input_dev);
1263 data->input_dev = NULL;
1265 kfree(data->object_table);
1266 data->object_table = NULL;
1267 kfree(data->msg_buf);
1268 data->msg_buf = NULL;
1269 data->T5_msg_size = 0;
1270 data->T6_reportid = 0;
1271 data->T7_address = 0;
1272 data->T9_reportid_min = 0;
1273 data->T9_reportid_max = 0;
1274 data->T19_reportid = 0;
1277 static int mxt_get_object_table(struct mxt_data *data)
1279 struct i2c_client *client = data->client;
1281 struct mxt_object *object_table;
1287 table_size = data->info.object_num * sizeof(struct mxt_object);
1288 object_table = kzalloc(table_size, GFP_KERNEL);
1289 if (!object_table) {
1290 dev_err(&data->client->dev, "Failed to allocate memory\n");
1294 error = __mxt_read_reg(client, MXT_OBJECT_START, table_size,
1297 kfree(object_table);
1301 /* Valid Report IDs start counting from 1 */
1304 for (i = 0; i < data->info.object_num; i++) {
1305 struct mxt_object *object = object_table + i;
1308 le16_to_cpus(&object->start_address);
1310 if (object->num_report_ids) {
1312 reportid += object->num_report_ids *
1313 mxt_obj_instances(object);
1314 max_id = reportid - 1;
1320 dev_dbg(&data->client->dev,
1321 "T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n",
1322 object->type, object->start_address,
1323 mxt_obj_size(object), mxt_obj_instances(object),
1326 switch (object->type) {
1327 case MXT_GEN_MESSAGE_T5:
1328 /* CRC not enabled, therefore don't read last byte */
1329 data->T5_msg_size = mxt_obj_size(object) - 1;
1330 case MXT_GEN_COMMAND_T6:
1331 data->T6_reportid = min_id;
1332 data->T6_address = object->start_address;
1334 case MXT_GEN_POWER_T7:
1335 data->T7_address = object->start_address;
1337 case MXT_TOUCH_MULTI_T9:
1338 data->T9_reportid_min = min_id;
1339 data->T9_reportid_max = max_id;
1341 case MXT_SPT_GPIOPWM_T19:
1342 data->T19_reportid = min_id;
1346 end_address = object->start_address
1347 + mxt_obj_size(object) * mxt_obj_instances(object) - 1;
1349 if (end_address >= data->mem_size)
1350 data->mem_size = end_address + 1;
1353 data->msg_buf = kzalloc(data->T5_msg_size, GFP_KERNEL);
1354 if (!data->msg_buf) {
1355 dev_err(&client->dev, "Failed to allocate message buffer\n");
1357 goto free_object_table;
1360 data->object_table = object_table;
1365 mxt_free_object_table(data);
1369 static int mxt_read_t9_resolution(struct mxt_data *data)
1371 struct i2c_client *client = data->client;
1373 struct t9_range range;
1374 unsigned char orient;
1375 struct mxt_object *object;
1377 object = mxt_get_object(data, MXT_TOUCH_MULTI_T9);
1381 error = __mxt_read_reg(client,
1382 object->start_address + MXT_T9_RANGE,
1383 sizeof(range), &range);
1387 le16_to_cpus(&range.x);
1388 le16_to_cpus(&range.y);
1390 error = __mxt_read_reg(client,
1391 object->start_address + MXT_T9_ORIENT,
1396 /* Handle default values */
1403 if (orient & MXT_T9_ORIENT_SWITCH) {
1404 data->max_x = range.y;
1405 data->max_y = range.x;
1407 data->max_x = range.x;
1408 data->max_y = range.y;
1411 dev_dbg(&client->dev,
1412 "Touchscreen size X%uY%u\n", data->max_x, data->max_y);
1417 static int mxt_input_open(struct input_dev *dev);
1418 static void mxt_input_close(struct input_dev *dev);
1420 static int mxt_initialize_t9_input_device(struct mxt_data *data)
1422 struct device *dev = &data->client->dev;
1423 const struct mxt_platform_data *pdata = data->pdata;
1424 struct input_dev *input_dev;
1426 unsigned int num_mt_slots;
1427 unsigned int mt_flags = 0;
1430 error = mxt_read_t9_resolution(data);
1432 dev_warn(dev, "Failed to initialize T9 resolution\n");
1434 input_dev = input_allocate_device();
1436 dev_err(dev, "Failed to allocate memory\n");
1440 input_dev->name = "Atmel maXTouch Touchscreen";
1441 input_dev->phys = data->phys;
1442 input_dev->id.bustype = BUS_I2C;
1443 input_dev->dev.parent = dev;
1444 input_dev->open = mxt_input_open;
1445 input_dev->close = mxt_input_close;
1447 __set_bit(EV_ABS, input_dev->evbit);
1448 __set_bit(EV_KEY, input_dev->evbit);
1449 __set_bit(BTN_TOUCH, input_dev->keybit);
1451 if (pdata->t19_num_keys) {
1452 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
1454 for (i = 0; i < pdata->t19_num_keys; i++)
1455 if (pdata->t19_keymap[i] != KEY_RESERVED)
1456 input_set_capability(input_dev, EV_KEY,
1457 pdata->t19_keymap[i]);
1459 mt_flags |= INPUT_MT_POINTER;
1461 input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM);
1462 input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM);
1463 input_abs_set_res(input_dev, ABS_MT_POSITION_X,
1465 input_abs_set_res(input_dev, ABS_MT_POSITION_Y,
1468 input_dev->name = "Atmel maXTouch Touchpad";
1471 /* For single touch */
1472 input_set_abs_params(input_dev, ABS_X,
1473 0, data->max_x, 0, 0);
1474 input_set_abs_params(input_dev, ABS_Y,
1475 0, data->max_y, 0, 0);
1476 input_set_abs_params(input_dev, ABS_PRESSURE,
1479 /* For multi touch */
1480 num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
1481 error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags);
1483 dev_err(dev, "Error %d initialising slots\n", error);
1487 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
1488 0, MXT_MAX_AREA, 0, 0);
1489 input_set_abs_params(input_dev, ABS_MT_POSITION_X,
1490 0, data->max_x, 0, 0);
1491 input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
1492 0, data->max_y, 0, 0);
1493 input_set_abs_params(input_dev, ABS_MT_PRESSURE,
1496 input_set_drvdata(input_dev, data);
1498 error = input_register_device(input_dev);
1500 dev_err(dev, "Error %d registering input device\n", error);
1504 data->input_dev = input_dev;
1509 input_free_device(input_dev);
1513 static int mxt_configure_objects(struct mxt_data *data,
1514 const struct firmware *cfg);
1516 static void mxt_config_cb(const struct firmware *cfg, void *ctx)
1518 mxt_configure_objects(ctx, cfg);
1521 static int mxt_initialize(struct mxt_data *data)
1523 struct i2c_client *client = data->client;
1525 bool alt_bootloader_addr = false;
1529 error = mxt_get_info(data);
1532 error = mxt_probe_bootloader(data, alt_bootloader_addr);
1534 if (alt_bootloader_addr) {
1535 /* Chip is not in appmode or bootloader mode */
1539 dev_info(&client->dev, "Trying alternate bootloader address\n");
1540 alt_bootloader_addr = true;
1541 goto retry_bootloader;
1544 dev_err(&client->dev, "Could not recover from bootloader mode\n");
1546 * We can reflash from this state, so do not
1549 data->in_bootloader = true;
1553 /* Attempt to exit bootloader into app mode */
1554 mxt_send_bootloader_cmd(data, false);
1555 msleep(MXT_FW_RESET_TIME);
1561 /* Get object table information */
1562 error = mxt_get_object_table(data);
1564 dev_err(&client->dev, "Error %d reading object table\n", error);
1568 mxt_acquire_irq(data);
1570 goto err_free_object_table;
1572 request_firmware_nowait(THIS_MODULE, true, MXT_CFG_NAME,
1573 &data->client->dev, GFP_KERNEL, data,
1578 err_free_object_table:
1579 mxt_free_object_table(data);
1583 static int mxt_configure_objects(struct mxt_data *data,
1584 const struct firmware *cfg)
1586 struct device *dev = &data->client->dev;
1587 struct mxt_info *info = &data->info;
1591 error = mxt_update_cfg(data, cfg);
1593 dev_warn(dev, "Error %d updating config\n", error);
1596 error = mxt_initialize_t9_input_device(data);
1601 "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n",
1602 info->family_id, info->variant_id, info->version >> 4,
1603 info->version & 0xf, info->build, info->object_num);
1608 /* Firmware Version is returned as Major.Minor.Build */
1609 static ssize_t mxt_fw_version_show(struct device *dev,
1610 struct device_attribute *attr, char *buf)
1612 struct mxt_data *data = dev_get_drvdata(dev);
1613 struct mxt_info *info = &data->info;
1614 return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
1615 info->version >> 4, info->version & 0xf, info->build);
1618 /* Hardware Version is returned as FamilyID.VariantID */
1619 static ssize_t mxt_hw_version_show(struct device *dev,
1620 struct device_attribute *attr, char *buf)
1622 struct mxt_data *data = dev_get_drvdata(dev);
1623 struct mxt_info *info = &data->info;
1624 return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
1625 info->family_id, info->variant_id);
1628 static ssize_t mxt_show_instance(char *buf, int count,
1629 struct mxt_object *object, int instance,
1634 if (mxt_obj_instances(object) > 1)
1635 count += scnprintf(buf + count, PAGE_SIZE - count,
1636 "Instance %u\n", instance);
1638 for (i = 0; i < mxt_obj_size(object); i++)
1639 count += scnprintf(buf + count, PAGE_SIZE - count,
1640 "\t[%2u]: %02x (%d)\n", i, val[i], val[i]);
1641 count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
1646 static ssize_t mxt_object_show(struct device *dev,
1647 struct device_attribute *attr, char *buf)
1649 struct mxt_data *data = dev_get_drvdata(dev);
1650 struct mxt_object *object;
1656 /* Pre-allocate buffer large enough to hold max sized object. */
1657 obuf = kmalloc(256, GFP_KERNEL);
1662 for (i = 0; i < data->info.object_num; i++) {
1663 object = data->object_table + i;
1665 if (!mxt_object_readable(object->type))
1668 count += scnprintf(buf + count, PAGE_SIZE - count,
1669 "T%u:\n", object->type);
1671 for (j = 0; j < mxt_obj_instances(object); j++) {
1672 u16 size = mxt_obj_size(object);
1673 u16 addr = object->start_address + j * size;
1675 error = __mxt_read_reg(data->client, addr, size, obuf);
1679 count = mxt_show_instance(buf, count, object, j, obuf);
1685 return error ?: count;
1688 static int mxt_check_firmware_format(struct device *dev,
1689 const struct firmware *fw)
1691 unsigned int pos = 0;
1694 while (pos < fw->size) {
1695 c = *(fw->data + pos);
1697 if (c < '0' || (c > '9' && c < 'A') || c > 'F')
1704 * To convert file try:
1705 * xxd -r -p mXTXXX__APP_VX-X-XX.enc > maxtouch.fw
1707 dev_err(dev, "Aborting: firmware file must be in binary format\n");
1712 static int mxt_load_fw(struct device *dev, const char *fn)
1714 struct mxt_data *data = dev_get_drvdata(dev);
1715 const struct firmware *fw = NULL;
1716 unsigned int frame_size;
1717 unsigned int pos = 0;
1718 unsigned int retry = 0;
1719 unsigned int frame = 0;
1722 ret = request_firmware(&fw, fn, dev);
1724 dev_err(dev, "Unable to open firmware %s\n", fn);
1728 /* Check for incorrect enc file */
1729 ret = mxt_check_firmware_format(dev, fw);
1731 goto release_firmware;
1733 if (!data->in_bootloader) {
1734 /* Change to the bootloader mode */
1735 data->in_bootloader = true;
1737 ret = mxt_t6_command(data, MXT_COMMAND_RESET,
1738 MXT_BOOT_VALUE, false);
1740 goto release_firmware;
1742 msleep(MXT_RESET_TIME);
1744 /* Do not need to scan since we know family ID */
1745 ret = mxt_lookup_bootloader_address(data, 0);
1747 goto release_firmware;
1749 enable_irq(data->irq);
1752 mxt_free_object_table(data);
1753 reinit_completion(&data->bl_completion);
1755 ret = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD, false);
1757 /* Bootloader may still be unlocked from previous attempt */
1758 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, false);
1762 dev_info(dev, "Unlocking bootloader\n");
1764 /* Unlock bootloader */
1765 ret = mxt_send_bootloader_cmd(data, true);
1770 while (pos < fw->size) {
1771 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, true);
1775 frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
1777 /* Take account of CRC bytes */
1780 /* Write one frame to device */
1781 ret = mxt_bootloader_write(data, fw->data + pos, frame_size);
1785 ret = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS, true);
1789 /* Back off by 20ms per retry */
1793 dev_err(dev, "Retry count exceeded\n");
1802 if (frame % 50 == 0)
1803 dev_dbg(dev, "Sent %d frames, %d/%zd bytes\n",
1804 frame, pos, fw->size);
1807 /* Wait for flash. */
1808 ret = mxt_wait_for_completion(data, &data->bl_completion,
1813 dev_dbg(dev, "Sent %d frames, %d bytes\n", frame, pos);
1816 * Wait for device to reset. Some bootloader versions do not assert
1817 * the CHG line after bootloading has finished, so ignore potential
1820 mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME);
1822 data->in_bootloader = false;
1825 disable_irq(data->irq);
1827 release_firmware(fw);
1831 static ssize_t mxt_update_fw_store(struct device *dev,
1832 struct device_attribute *attr,
1833 const char *buf, size_t count)
1835 struct mxt_data *data = dev_get_drvdata(dev);
1838 error = mxt_load_fw(dev, MXT_FW_NAME);
1840 dev_err(dev, "The firmware update failed(%d)\n", error);
1843 dev_info(dev, "The firmware update succeeded\n");
1845 error = mxt_initialize(data);
1853 static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
1854 static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
1855 static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
1856 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
1858 static struct attribute *mxt_attrs[] = {
1859 &dev_attr_fw_version.attr,
1860 &dev_attr_hw_version.attr,
1861 &dev_attr_object.attr,
1862 &dev_attr_update_fw.attr,
1866 static const struct attribute_group mxt_attr_group = {
1870 static void mxt_start(struct mxt_data *data)
1873 mxt_write_object(data,
1874 MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0x83);
1877 static void mxt_stop(struct mxt_data *data)
1880 mxt_write_object(data,
1881 MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0);
1884 static int mxt_input_open(struct input_dev *dev)
1886 struct mxt_data *data = input_get_drvdata(dev);
1893 static void mxt_input_close(struct input_dev *dev)
1895 struct mxt_data *data = input_get_drvdata(dev);
1901 static struct mxt_platform_data *mxt_parse_dt(struct i2c_client *client)
1903 struct mxt_platform_data *pdata;
1906 int proplen, i, ret;
1908 if (!client->dev.of_node)
1909 return ERR_PTR(-ENODEV);
1911 pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL);
1913 return ERR_PTR(-ENOMEM);
1915 if (of_find_property(client->dev.of_node, "linux,gpio-keymap",
1917 pdata->t19_num_keys = proplen / sizeof(u32);
1919 keymap = devm_kzalloc(&client->dev,
1920 pdata->t19_num_keys * sizeof(keymap[0]),
1923 return ERR_PTR(-ENOMEM);
1925 for (i = 0; i < pdata->t19_num_keys; i++) {
1926 ret = of_property_read_u32_index(client->dev.of_node,
1927 "linux,gpio-keymap", i, &keycode);
1929 keycode = KEY_RESERVED;
1931 keymap[i] = keycode;
1934 pdata->t19_keymap = keymap;
1940 static struct mxt_platform_data *mxt_parse_dt(struct i2c_client *client)
1942 dev_dbg(&client->dev, "No platform data specified\n");
1943 return ERR_PTR(-EINVAL);
1947 static int mxt_probe(struct i2c_client *client, const struct i2c_device_id *id)
1949 struct mxt_data *data;
1950 const struct mxt_platform_data *pdata;
1953 pdata = dev_get_platdata(&client->dev);
1955 pdata = mxt_parse_dt(client);
1957 return PTR_ERR(pdata);
1960 data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL);
1962 dev_err(&client->dev, "Failed to allocate memory\n");
1966 snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
1967 client->adapter->nr, client->addr);
1969 data->client = client;
1970 data->pdata = pdata;
1971 data->irq = client->irq;
1972 i2c_set_clientdata(client, data);
1974 init_completion(&data->bl_completion);
1975 init_completion(&data->reset_completion);
1976 init_completion(&data->crc_completion);
1978 error = request_threaded_irq(client->irq, NULL, mxt_interrupt,
1979 pdata->irqflags | IRQF_ONESHOT,
1980 client->name, data);
1982 dev_err(&client->dev, "Failed to register interrupt\n");
1986 disable_irq(client->irq);
1988 error = mxt_initialize(data);
1992 error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
1994 dev_err(&client->dev, "Failure %d creating sysfs group\n",
1996 goto err_free_object;
2002 mxt_free_object_table(data);
2004 free_irq(client->irq, data);
2010 static int mxt_remove(struct i2c_client *client)
2012 struct mxt_data *data = i2c_get_clientdata(client);
2014 sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
2015 free_irq(data->irq, data);
2016 input_unregister_device(data->input_dev);
2017 mxt_free_object_table(data);
2023 #ifdef CONFIG_PM_SLEEP
2024 static int mxt_suspend(struct device *dev)
2026 struct i2c_client *client = to_i2c_client(dev);
2027 struct mxt_data *data = i2c_get_clientdata(client);
2028 struct input_dev *input_dev = data->input_dev;
2030 mutex_lock(&input_dev->mutex);
2032 if (input_dev->users)
2035 mutex_unlock(&input_dev->mutex);
2040 static int mxt_resume(struct device *dev)
2042 struct i2c_client *client = to_i2c_client(dev);
2043 struct mxt_data *data = i2c_get_clientdata(client);
2044 struct input_dev *input_dev = data->input_dev;
2046 mxt_soft_reset(data);
2048 mutex_lock(&input_dev->mutex);
2050 if (input_dev->users)
2053 mutex_unlock(&input_dev->mutex);
2059 static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);
2061 static const struct of_device_id mxt_of_match[] = {
2062 { .compatible = "atmel,maxtouch", },
2065 MODULE_DEVICE_TABLE(of, mxt_of_match);
2067 static const struct i2c_device_id mxt_id[] = {
2068 { "qt602240_ts", 0 },
2069 { "atmel_mxt_ts", 0 },
2070 { "atmel_mxt_tp", 0 },
2074 MODULE_DEVICE_TABLE(i2c, mxt_id);
2076 static struct i2c_driver mxt_driver = {
2078 .name = "atmel_mxt_ts",
2079 .owner = THIS_MODULE,
2080 .of_match_table = of_match_ptr(mxt_of_match),
2084 .remove = mxt_remove,
2088 module_i2c_driver(mxt_driver);
2090 /* Module information */
2091 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
2092 MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
2093 MODULE_LICENSE("GPL");