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.
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;
254 u8 last_message_count;
257 /* Cached parameters from object table */
268 /* for fw update in bootloader */
269 struct completion bl_completion;
271 /* for reset handling */
272 struct completion reset_completion;
274 /* for config update handling */
275 struct completion crc_completion;
278 static size_t mxt_obj_size(const struct mxt_object *obj)
280 return obj->size_minus_one + 1;
283 static size_t mxt_obj_instances(const struct mxt_object *obj)
285 return obj->instances_minus_one + 1;
288 static bool mxt_object_readable(unsigned int type)
291 case MXT_GEN_COMMAND_T6:
292 case MXT_GEN_POWER_T7:
293 case MXT_GEN_ACQUIRE_T8:
294 case MXT_GEN_DATASOURCE_T53:
295 case MXT_TOUCH_MULTI_T9:
296 case MXT_TOUCH_KEYARRAY_T15:
297 case MXT_TOUCH_PROXIMITY_T23:
298 case MXT_TOUCH_PROXKEY_T52:
299 case MXT_PROCI_GRIPFACE_T20:
300 case MXT_PROCG_NOISE_T22:
301 case MXT_PROCI_ONETOUCH_T24:
302 case MXT_PROCI_TWOTOUCH_T27:
303 case MXT_PROCI_GRIP_T40:
304 case MXT_PROCI_PALM_T41:
305 case MXT_PROCI_TOUCHSUPPRESSION_T42:
306 case MXT_PROCI_STYLUS_T47:
307 case MXT_PROCG_NOISESUPPRESSION_T48:
308 case MXT_SPT_COMMSCONFIG_T18:
309 case MXT_SPT_GPIOPWM_T19:
310 case MXT_SPT_SELFTEST_T25:
311 case MXT_SPT_CTECONFIG_T28:
312 case MXT_SPT_USERDATA_T38:
313 case MXT_SPT_DIGITIZER_T43:
314 case MXT_SPT_CTECONFIG_T46:
321 static void mxt_dump_message(struct mxt_data *data, u8 *message)
323 dev_dbg(&data->client->dev, "message: %*ph\n",
324 data->T5_msg_size, message);
327 static int mxt_wait_for_completion(struct mxt_data *data,
328 struct completion *comp,
329 unsigned int timeout_ms)
331 struct device *dev = &data->client->dev;
332 unsigned long timeout = msecs_to_jiffies(timeout_ms);
335 ret = wait_for_completion_interruptible_timeout(comp, timeout);
338 } else if (ret == 0) {
339 dev_err(dev, "Wait for completion timed out.\n");
345 static int mxt_bootloader_read(struct mxt_data *data,
346 u8 *val, unsigned int count)
351 msg.addr = data->bootloader_addr;
352 msg.flags = data->client->flags & I2C_M_TEN;
353 msg.flags |= I2C_M_RD;
357 ret = i2c_transfer(data->client->adapter, &msg, 1);
361 ret = ret < 0 ? ret : -EIO;
362 dev_err(&data->client->dev, "%s: i2c recv failed (%d)\n",
369 static int mxt_bootloader_write(struct mxt_data *data,
370 const u8 * const val, unsigned int count)
375 msg.addr = data->bootloader_addr;
376 msg.flags = data->client->flags & I2C_M_TEN;
380 ret = i2c_transfer(data->client->adapter, &msg, 1);
384 ret = ret < 0 ? ret : -EIO;
385 dev_err(&data->client->dev, "%s: i2c send failed (%d)\n",
392 static int mxt_lookup_bootloader_address(struct mxt_data *data, bool retry)
394 u8 appmode = data->client->addr;
400 /* Chips after 1664S use different scheme */
401 if (retry || data->info.family_id >= 0xa2) {
402 bootloader = appmode - 0x24;
405 /* Fall through for normal case */
410 bootloader = appmode - 0x26;
414 dev_err(&data->client->dev,
415 "Appmode i2c address 0x%02x not found\n",
420 data->bootloader_addr = bootloader;
424 static int mxt_probe_bootloader(struct mxt_data *data, bool alt_address)
426 struct device *dev = &data->client->dev;
431 error = mxt_lookup_bootloader_address(data, alt_address);
435 error = mxt_bootloader_read(data, &val, 1);
439 /* Check app crc fail mode */
440 crc_failure = (val & ~MXT_BOOT_STATUS_MASK) == MXT_APP_CRC_FAIL;
442 dev_err(dev, "Detected bootloader, status:%02X%s\n",
443 val, crc_failure ? ", APP_CRC_FAIL" : "");
448 static u8 mxt_get_bootloader_version(struct mxt_data *data, u8 val)
450 struct device *dev = &data->client->dev;
453 if (val & MXT_BOOT_EXTENDED_ID) {
454 if (mxt_bootloader_read(data, &buf[0], 3) != 0) {
455 dev_err(dev, "%s: i2c failure\n", __func__);
459 dev_dbg(dev, "Bootloader ID:%d Version:%d\n", buf[1], buf[2]);
463 dev_dbg(dev, "Bootloader ID:%d\n", val & MXT_BOOT_ID_MASK);
469 static int mxt_check_bootloader(struct mxt_data *data, unsigned int state,
472 struct device *dev = &data->client->dev;
479 * In application update mode, the interrupt
480 * line signals state transitions. We must wait for the
481 * CHG assertion before reading the status byte.
482 * Once the status byte has been read, the line is deasserted.
484 ret = mxt_wait_for_completion(data, &data->bl_completion,
488 * TODO: handle -ERESTARTSYS better by terminating
489 * fw update process before returning to userspace
490 * by writing length 0x000 to device (iff we are in
491 * WAITING_FRAME_DATA state).
493 dev_err(dev, "Update wait error %d\n", ret);
498 ret = mxt_bootloader_read(data, &val, 1);
502 if (state == MXT_WAITING_BOOTLOAD_CMD)
503 val = mxt_get_bootloader_version(data, val);
506 case MXT_WAITING_BOOTLOAD_CMD:
507 case MXT_WAITING_FRAME_DATA:
508 case MXT_APP_CRC_FAIL:
509 val &= ~MXT_BOOT_STATUS_MASK;
511 case MXT_FRAME_CRC_PASS:
512 if (val == MXT_FRAME_CRC_CHECK) {
514 } else if (val == MXT_FRAME_CRC_FAIL) {
515 dev_err(dev, "Bootloader CRC fail\n");
524 dev_err(dev, "Invalid bootloader state %02X != %02X\n",
532 static int mxt_send_bootloader_cmd(struct mxt_data *data, bool unlock)
538 buf[0] = MXT_UNLOCK_CMD_LSB;
539 buf[1] = MXT_UNLOCK_CMD_MSB;
545 ret = mxt_bootloader_write(data, buf, 2);
552 static int __mxt_read_reg(struct i2c_client *client,
553 u16 reg, u16 len, void *val)
555 struct i2c_msg xfer[2];
560 buf[1] = (reg >> 8) & 0xff;
563 xfer[0].addr = client->addr;
569 xfer[1].addr = client->addr;
570 xfer[1].flags = I2C_M_RD;
574 ret = i2c_transfer(client->adapter, xfer, 2);
580 dev_err(&client->dev, "%s: i2c transfer failed (%d)\n",
587 static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len,
595 buf = kmalloc(count, GFP_KERNEL);
600 buf[1] = (reg >> 8) & 0xff;
601 memcpy(&buf[2], val, len);
603 ret = i2c_master_send(client, buf, count);
609 dev_err(&client->dev, "%s: i2c send failed (%d)\n",
617 static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
619 return __mxt_write_reg(client, reg, 1, &val);
622 static struct mxt_object *
623 mxt_get_object(struct mxt_data *data, u8 type)
625 struct mxt_object *object;
628 for (i = 0; i < data->info.object_num; i++) {
629 object = data->object_table + i;
630 if (object->type == type)
634 dev_warn(&data->client->dev, "Invalid object type T%u\n", type);
638 static void mxt_proc_t6_messages(struct mxt_data *data, u8 *msg)
640 struct device *dev = &data->client->dev;
642 u32 crc = msg[2] | (msg[3] << 8) | (msg[4] << 16);
644 complete(&data->crc_completion);
646 if (crc != data->config_crc) {
647 data->config_crc = crc;
648 dev_dbg(dev, "T6 Config Checksum: 0x%06X\n", crc);
652 if (status & MXT_T6_STATUS_RESET)
653 complete(&data->reset_completion);
655 /* Output debug if status has changed */
656 if (status != data->t6_status)
657 dev_dbg(dev, "T6 Status 0x%02X%s%s%s%s%s%s%s\n",
659 status == 0 ? " OK" : "",
660 status & MXT_T6_STATUS_RESET ? " RESET" : "",
661 status & MXT_T6_STATUS_OFL ? " OFL" : "",
662 status & MXT_T6_STATUS_SIGERR ? " SIGERR" : "",
663 status & MXT_T6_STATUS_CAL ? " CAL" : "",
664 status & MXT_T6_STATUS_CFGERR ? " CFGERR" : "",
665 status & MXT_T6_STATUS_COMSERR ? " COMSERR" : "");
667 /* Save current status */
668 data->t6_status = status;
671 static int mxt_write_object(struct mxt_data *data,
672 u8 type, u8 offset, u8 val)
674 struct mxt_object *object;
677 object = mxt_get_object(data, type);
678 if (!object || offset >= mxt_obj_size(object))
681 reg = object->start_address;
682 return mxt_write_reg(data->client, reg + offset, val);
685 static void mxt_input_button(struct mxt_data *data, u8 *message)
687 struct input_dev *input = data->input_dev;
688 const struct mxt_platform_data *pdata = data->pdata;
692 /* Active-low switch */
693 for (i = 0; i < pdata->t19_num_keys; i++) {
694 if (pdata->t19_keymap[i] == KEY_RESERVED)
696 button = !(message[1] & (1 << i));
697 input_report_key(input, pdata->t19_keymap[i], button);
701 static void mxt_input_sync(struct mxt_data *data)
703 input_mt_report_pointer_emulation(data->input_dev,
704 data->pdata->t19_num_keys);
705 input_sync(data->input_dev);
708 static void mxt_proc_t9_message(struct mxt_data *data, u8 *message)
710 struct device *dev = &data->client->dev;
711 struct input_dev *input_dev = data->input_dev;
719 id = message[0] - data->T9_reportid_min;
721 x = (message[2] << 4) | ((message[4] >> 4) & 0xf);
722 y = (message[3] << 4) | ((message[4] & 0xf));
724 /* Handle 10/12 bit switching */
725 if (data->max_x < 1024)
727 if (data->max_y < 1024)
731 amplitude = message[6];
734 "[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
736 (status & MXT_T9_DETECT) ? 'D' : '.',
737 (status & MXT_T9_PRESS) ? 'P' : '.',
738 (status & MXT_T9_RELEASE) ? 'R' : '.',
739 (status & MXT_T9_MOVE) ? 'M' : '.',
740 (status & MXT_T9_VECTOR) ? 'V' : '.',
741 (status & MXT_T9_AMP) ? 'A' : '.',
742 (status & MXT_T9_SUPPRESS) ? 'S' : '.',
743 (status & MXT_T9_UNGRIP) ? 'U' : '.',
744 x, y, area, amplitude);
746 input_mt_slot(input_dev, id);
748 if (status & MXT_T9_DETECT) {
750 * Multiple bits may be set if the host is slow to read
751 * the status messages, indicating all the events that
754 if (status & MXT_T9_RELEASE) {
755 input_mt_report_slot_state(input_dev,
757 mxt_input_sync(data);
761 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 1);
762 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
763 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
764 input_report_abs(input_dev, ABS_MT_PRESSURE, amplitude);
765 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
767 /* Touch no longer active, close out slot */
768 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 0);
771 data->update_input = true;
774 static int mxt_proc_message(struct mxt_data *data, u8 *message)
776 u8 report_id = message[0];
778 if (report_id == MXT_RPTID_NOMSG)
781 if (report_id == data->T6_reportid) {
782 mxt_proc_t6_messages(data, message);
783 } else if (!data->input_dev) {
785 * Do not report events if input device
786 * is not yet registered.
788 mxt_dump_message(data, message);
789 } else if (report_id >= data->T9_reportid_min
790 && report_id <= data->T9_reportid_max) {
791 mxt_proc_t9_message(data, message);
792 } else if (report_id == data->T19_reportid) {
793 mxt_input_button(data, message);
794 data->update_input = true;
796 mxt_dump_message(data, message);
802 static int mxt_read_and_process_messages(struct mxt_data *data, u8 count)
804 struct device *dev = &data->client->dev;
809 /* Safety check for msg_buf */
810 if (count > data->max_reportid)
813 /* Process remaining messages if necessary */
814 ret = __mxt_read_reg(data->client, data->T5_address,
815 data->T5_msg_size * count, data->msg_buf);
817 dev_err(dev, "Failed to read %u messages (%d)\n", count, ret);
821 for (i = 0; i < count; i++) {
822 ret = mxt_proc_message(data,
823 data->msg_buf + data->T5_msg_size * i);
829 /* return number of messages read */
833 static irqreturn_t mxt_process_messages_t44(struct mxt_data *data)
835 struct device *dev = &data->client->dev;
839 /* Read T44 and T5 together */
840 ret = __mxt_read_reg(data->client, data->T44_address,
841 data->T5_msg_size + 1, data->msg_buf);
843 dev_err(dev, "Failed to read T44 and T5 (%d)\n", ret);
847 count = data->msg_buf[0];
851 * This condition is caused by the CHG line being configured
852 * in Mode 0. It results in unnecessary I2C operations but it
855 dev_dbg(dev, "Interrupt triggered but zero messages\n");
857 } else if (count > data->max_reportid) {
858 dev_err(dev, "T44 count %d exceeded max report id\n", count);
859 count = data->max_reportid;
862 /* Process first message */
863 ret = mxt_proc_message(data, data->msg_buf + 1);
865 dev_warn(dev, "Unexpected invalid message\n");
869 num_left = count - 1;
871 /* Process remaining messages if necessary */
873 ret = mxt_read_and_process_messages(data, num_left);
876 else if (ret != num_left)
877 dev_warn(dev, "Unexpected invalid message\n");
881 if (data->update_input) {
882 mxt_input_sync(data);
883 data->update_input = false;
889 static int mxt_process_messages_until_invalid(struct mxt_data *data)
891 struct device *dev = &data->client->dev;
895 count = data->max_reportid;
897 /* Read messages until we force an invalid */
899 read = mxt_read_and_process_messages(data, count);
904 if (data->update_input) {
905 mxt_input_sync(data);
906 data->update_input = false;
909 dev_err(dev, "CHG pin isn't cleared\n");
913 static irqreturn_t mxt_process_messages(struct mxt_data *data)
915 int total_handled, num_handled;
916 u8 count = data->last_message_count;
918 if (count < 1 || count > data->max_reportid)
921 /* include final invalid message */
922 total_handled = mxt_read_and_process_messages(data, count + 1);
923 if (total_handled < 0)
925 /* if there were invalid messages, then we are done */
926 else if (total_handled <= count)
929 /* keep reading two msgs until one is invalid or reportid limit */
931 num_handled = mxt_read_and_process_messages(data, 2);
935 total_handled += num_handled;
939 } while (total_handled < data->num_touchids);
942 data->last_message_count = total_handled;
944 if (data->update_input) {
945 mxt_input_sync(data);
946 data->update_input = false;
952 static irqreturn_t mxt_interrupt(int irq, void *dev_id)
954 struct mxt_data *data = dev_id;
956 if (data->in_bootloader) {
957 /* bootloader state transition completion */
958 complete(&data->bl_completion);
962 if (!data->object_table)
965 if (data->T44_address) {
966 return mxt_process_messages_t44(data);
968 return mxt_process_messages(data);
972 static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset,
977 int timeout_counter = 0;
980 reg = data->T6_address + cmd_offset;
982 ret = mxt_write_reg(data->client, reg, value);
991 ret = __mxt_read_reg(data->client, reg, 1, &command_register);
994 } while (command_register != 0 && timeout_counter++ <= 100);
996 if (timeout_counter > 100) {
997 dev_err(&data->client->dev, "Command failed!\n");
1004 static int mxt_soft_reset(struct mxt_data *data)
1006 struct device *dev = &data->client->dev;
1009 dev_info(dev, "Resetting chip\n");
1011 reinit_completion(&data->reset_completion);
1013 ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false);
1017 ret = mxt_wait_for_completion(data, &data->reset_completion,
1025 static void mxt_update_crc(struct mxt_data *data, u8 cmd, u8 value)
1028 * On failure, CRC is set to 0 and config will always be
1031 data->config_crc = 0;
1032 reinit_completion(&data->crc_completion);
1034 mxt_t6_command(data, cmd, value, true);
1037 * Wait for crc message. On failure, CRC is set to 0 and config will
1038 * always be downloaded.
1040 mxt_wait_for_completion(data, &data->crc_completion, MXT_CRC_TIMEOUT);
1043 static void mxt_calc_crc24(u32 *crc, u8 firstbyte, u8 secondbyte)
1045 static const unsigned int crcpoly = 0x80001B;
1049 data_word = (secondbyte << 8) | firstbyte;
1050 result = ((*crc << 1) ^ data_word);
1052 if (result & 0x1000000)
1058 static u32 mxt_calculate_crc(u8 *base, off_t start_off, off_t end_off)
1061 u8 *ptr = base + start_off;
1062 u8 *last_val = base + end_off - 1;
1064 if (end_off < start_off)
1067 while (ptr < last_val) {
1068 mxt_calc_crc24(&crc, *ptr, *(ptr + 1));
1072 /* if len is odd, fill the last byte with 0 */
1073 if (ptr == last_val)
1074 mxt_calc_crc24(&crc, *ptr, 0);
1076 /* Mask to 24-bit */
1082 static int mxt_prepare_cfg_mem(struct mxt_data *data,
1083 const struct firmware *cfg,
1084 unsigned int data_pos,
1085 unsigned int cfg_start_ofs,
1087 size_t config_mem_size)
1089 struct device *dev = &data->client->dev;
1090 struct mxt_object *object;
1091 unsigned int type, instance, size, byte_offset;
1098 while (data_pos < cfg->size) {
1099 /* Read type, instance, length */
1100 ret = sscanf(cfg->data + data_pos, "%x %x %x%n",
1101 &type, &instance, &size, &offset);
1105 } else if (ret != 3) {
1106 dev_err(dev, "Bad format: failed to parse object\n");
1111 object = mxt_get_object(data, type);
1114 for (i = 0; i < size; i++) {
1115 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1118 dev_err(dev, "Bad format in T%d at %d\n",
1127 if (size > mxt_obj_size(object)) {
1129 * Either we are in fallback mode due to wrong
1130 * config or config from a later fw version,
1131 * or the file is corrupt or hand-edited.
1133 dev_warn(dev, "Discarding %zu byte(s) in T%u\n",
1134 size - mxt_obj_size(object), type);
1135 } else if (mxt_obj_size(object) > size) {
1137 * If firmware is upgraded, new bytes may be added to
1138 * end of objects. It is generally forward compatible
1139 * to zero these bytes - previous behaviour will be
1140 * retained. However this does invalidate the CRC and
1141 * will force fallback mode until the configuration is
1142 * updated. We warn here but do nothing else - the
1143 * malloc has zeroed the entire configuration.
1145 dev_warn(dev, "Zeroing %zu byte(s) in T%d\n",
1146 mxt_obj_size(object) - size, type);
1149 if (instance >= mxt_obj_instances(object)) {
1150 dev_err(dev, "Object instances exceeded!\n");
1154 reg = object->start_address + mxt_obj_size(object) * instance;
1156 for (i = 0; i < size; i++) {
1157 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1161 dev_err(dev, "Bad format in T%d at %d\n",
1167 if (i > mxt_obj_size(object))
1170 byte_offset = reg + i - cfg_start_ofs;
1172 if (byte_offset >= 0 && byte_offset < config_mem_size) {
1173 *(config_mem + byte_offset) = val;
1175 dev_err(dev, "Bad object: reg:%d, T%d, ofs=%d\n",
1176 reg, object->type, byte_offset);
1185 static int mxt_upload_cfg_mem(struct mxt_data *data, unsigned int cfg_start,
1186 u8 *config_mem, size_t config_mem_size)
1188 unsigned int byte_offset = 0;
1191 /* Write configuration as blocks */
1192 while (byte_offset < config_mem_size) {
1193 unsigned int size = config_mem_size - byte_offset;
1195 if (size > MXT_MAX_BLOCK_WRITE)
1196 size = MXT_MAX_BLOCK_WRITE;
1198 error = __mxt_write_reg(data->client,
1199 cfg_start + byte_offset,
1200 size, config_mem + byte_offset);
1202 dev_err(&data->client->dev,
1203 "Config write error, ret=%d\n", error);
1207 byte_offset += size;
1214 * mxt_update_cfg - download configuration to chip
1216 * Atmel Raw Config File Format
1218 * The first four lines of the raw config file contain:
1220 * 2) Chip ID Information (first 7 bytes of device memory)
1221 * 3) Chip Information Block 24-bit CRC Checksum
1222 * 4) Chip Configuration 24-bit CRC Checksum
1224 * The rest of the file consists of one line per object instance:
1225 * <TYPE> <INSTANCE> <SIZE> <CONTENTS>
1227 * <TYPE> - 2-byte object type as hex
1228 * <INSTANCE> - 2-byte object instance number as hex
1229 * <SIZE> - 2-byte object size as hex
1230 * <CONTENTS> - array of <SIZE> 1-byte hex values
1232 static int mxt_update_cfg(struct mxt_data *data, const struct firmware *cfg)
1234 struct device *dev = &data->client->dev;
1235 struct mxt_info cfg_info;
1241 u32 info_crc, config_crc, calculated_crc;
1243 size_t config_mem_size;
1245 mxt_update_crc(data, MXT_COMMAND_REPORTALL, 1);
1247 if (strncmp(cfg->data, MXT_CFG_MAGIC, strlen(MXT_CFG_MAGIC))) {
1248 dev_err(dev, "Unrecognised config file\n");
1252 data_pos = strlen(MXT_CFG_MAGIC);
1254 /* Load information block and check */
1255 for (i = 0; i < sizeof(struct mxt_info); i++) {
1256 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1257 (unsigned char *)&cfg_info + i,
1260 dev_err(dev, "Bad format\n");
1267 if (cfg_info.family_id != data->info.family_id) {
1268 dev_err(dev, "Family ID mismatch!\n");
1272 if (cfg_info.variant_id != data->info.variant_id) {
1273 dev_err(dev, "Variant ID mismatch!\n");
1278 ret = sscanf(cfg->data + data_pos, "%x%n", &info_crc, &offset);
1280 dev_err(dev, "Bad format: failed to parse Info CRC\n");
1285 ret = sscanf(cfg->data + data_pos, "%x%n", &config_crc, &offset);
1287 dev_err(dev, "Bad format: failed to parse Config CRC\n");
1293 * The Info Block CRC is calculated over mxt_info and the object
1294 * table. If it does not match then we are trying to load the
1295 * configuration from a different chip or firmware version, so
1296 * the configuration CRC is invalid anyway.
1298 if (info_crc == data->info_crc) {
1299 if (config_crc == 0 || data->config_crc == 0) {
1300 dev_info(dev, "CRC zero, attempting to apply config\n");
1301 } else if (config_crc == data->config_crc) {
1302 dev_dbg(dev, "Config CRC 0x%06X: OK\n",
1306 dev_info(dev, "Config CRC 0x%06X: does not match file 0x%06X\n",
1307 data->config_crc, config_crc);
1311 "Warning: Info CRC error - device=0x%06X file=0x%06X\n",
1312 data->info_crc, info_crc);
1315 /* Malloc memory to store configuration */
1316 cfg_start_ofs = MXT_OBJECT_START +
1317 data->info.object_num * sizeof(struct mxt_object) +
1318 MXT_INFO_CHECKSUM_SIZE;
1319 config_mem_size = data->mem_size - cfg_start_ofs;
1320 config_mem = kzalloc(config_mem_size, GFP_KERNEL);
1322 dev_err(dev, "Failed to allocate memory\n");
1326 ret = mxt_prepare_cfg_mem(data, cfg, data_pos, cfg_start_ofs,
1327 config_mem, config_mem_size);
1331 /* Calculate crc of the received configs (not the raw config file) */
1332 if (data->T7_address < cfg_start_ofs) {
1333 dev_err(dev, "Bad T7 address, T7addr = %x, config offset %x\n",
1334 data->T7_address, cfg_start_ofs);
1339 calculated_crc = mxt_calculate_crc(config_mem,
1340 data->T7_address - cfg_start_ofs,
1343 if (config_crc > 0 && config_crc != calculated_crc)
1344 dev_warn(dev, "Config CRC error, calculated=%06X, file=%06X\n",
1345 calculated_crc, config_crc);
1347 ret = mxt_upload_cfg_mem(data, cfg_start_ofs,
1348 config_mem, config_mem_size);
1352 mxt_update_crc(data, MXT_COMMAND_BACKUPNV, MXT_BACKUP_VALUE);
1354 ret = mxt_soft_reset(data);
1358 dev_info(dev, "Config successfully updated\n");
1365 static int mxt_acquire_irq(struct mxt_data *data)
1369 enable_irq(data->irq);
1371 error = mxt_process_messages_until_invalid(data);
1378 static int mxt_get_info(struct mxt_data *data)
1380 struct i2c_client *client = data->client;
1381 struct mxt_info *info = &data->info;
1384 /* Read 7-byte info block starting at address 0 */
1385 error = __mxt_read_reg(client, MXT_INFO, sizeof(*info), info);
1392 static void mxt_free_input_device(struct mxt_data *data)
1394 if (data->input_dev) {
1395 input_unregister_device(data->input_dev);
1396 data->input_dev = NULL;
1400 static void mxt_free_object_table(struct mxt_data *data)
1402 kfree(data->object_table);
1403 data->object_table = NULL;
1404 kfree(data->msg_buf);
1405 data->msg_buf = NULL;
1406 data->T5_address = 0;
1407 data->T5_msg_size = 0;
1408 data->T6_reportid = 0;
1409 data->T7_address = 0;
1410 data->T9_reportid_min = 0;
1411 data->T9_reportid_max = 0;
1412 data->T19_reportid = 0;
1413 data->T44_address = 0;
1414 data->max_reportid = 0;
1417 static int mxt_get_object_table(struct mxt_data *data)
1419 struct i2c_client *client = data->client;
1421 struct mxt_object *object_table;
1427 table_size = data->info.object_num * sizeof(struct mxt_object);
1428 object_table = kzalloc(table_size, GFP_KERNEL);
1429 if (!object_table) {
1430 dev_err(&data->client->dev, "Failed to allocate memory\n");
1434 error = __mxt_read_reg(client, MXT_OBJECT_START, table_size,
1437 kfree(object_table);
1441 /* Valid Report IDs start counting from 1 */
1444 for (i = 0; i < data->info.object_num; i++) {
1445 struct mxt_object *object = object_table + i;
1448 le16_to_cpus(&object->start_address);
1450 if (object->num_report_ids) {
1452 reportid += object->num_report_ids *
1453 mxt_obj_instances(object);
1454 max_id = reportid - 1;
1460 dev_dbg(&data->client->dev,
1461 "T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n",
1462 object->type, object->start_address,
1463 mxt_obj_size(object), mxt_obj_instances(object),
1466 switch (object->type) {
1467 case MXT_GEN_MESSAGE_T5:
1468 if (data->info.family_id == 0x80 &&
1469 data->info.version < 0x20) {
1471 * On mXT224 firmware versions prior to V2.0
1472 * read and discard unused CRC byte otherwise
1473 * DMA reads are misaligned.
1475 data->T5_msg_size = mxt_obj_size(object);
1477 /* CRC not enabled, so skip last byte */
1478 data->T5_msg_size = mxt_obj_size(object) - 1;
1480 data->T5_address = object->start_address;
1482 case MXT_GEN_COMMAND_T6:
1483 data->T6_reportid = min_id;
1484 data->T6_address = object->start_address;
1486 case MXT_GEN_POWER_T7:
1487 data->T7_address = object->start_address;
1489 case MXT_TOUCH_MULTI_T9:
1490 data->T9_reportid_min = min_id;
1491 data->T9_reportid_max = max_id;
1492 data->num_touchids = object->num_report_ids
1493 * mxt_obj_instances(object);
1495 case MXT_SPT_MESSAGECOUNT_T44:
1496 data->T44_address = object->start_address;
1498 case MXT_SPT_GPIOPWM_T19:
1499 data->T19_reportid = min_id;
1503 end_address = object->start_address
1504 + mxt_obj_size(object) * mxt_obj_instances(object) - 1;
1506 if (end_address >= data->mem_size)
1507 data->mem_size = end_address + 1;
1510 /* Store maximum reportid */
1511 data->max_reportid = reportid;
1513 /* If T44 exists, T5 position has to be directly after */
1514 if (data->T44_address && (data->T5_address != data->T44_address + 1)) {
1515 dev_err(&client->dev, "Invalid T44 position\n");
1517 goto free_object_table;
1520 data->msg_buf = kcalloc(data->max_reportid,
1521 data->T5_msg_size, GFP_KERNEL);
1522 if (!data->msg_buf) {
1523 dev_err(&client->dev, "Failed to allocate message buffer\n");
1525 goto free_object_table;
1528 data->object_table = object_table;
1533 mxt_free_object_table(data);
1537 static int mxt_read_t9_resolution(struct mxt_data *data)
1539 struct i2c_client *client = data->client;
1541 struct t9_range range;
1542 unsigned char orient;
1543 struct mxt_object *object;
1545 object = mxt_get_object(data, MXT_TOUCH_MULTI_T9);
1549 error = __mxt_read_reg(client,
1550 object->start_address + MXT_T9_RANGE,
1551 sizeof(range), &range);
1555 le16_to_cpus(&range.x);
1556 le16_to_cpus(&range.y);
1558 error = __mxt_read_reg(client,
1559 object->start_address + MXT_T9_ORIENT,
1564 /* Handle default values */
1571 if (orient & MXT_T9_ORIENT_SWITCH) {
1572 data->max_x = range.y;
1573 data->max_y = range.x;
1575 data->max_x = range.x;
1576 data->max_y = range.y;
1579 dev_dbg(&client->dev,
1580 "Touchscreen size X%uY%u\n", data->max_x, data->max_y);
1585 static int mxt_input_open(struct input_dev *dev);
1586 static void mxt_input_close(struct input_dev *dev);
1588 static int mxt_initialize_t9_input_device(struct mxt_data *data)
1590 struct device *dev = &data->client->dev;
1591 const struct mxt_platform_data *pdata = data->pdata;
1592 struct input_dev *input_dev;
1594 unsigned int num_mt_slots;
1595 unsigned int mt_flags = 0;
1598 error = mxt_read_t9_resolution(data);
1600 dev_warn(dev, "Failed to initialize T9 resolution\n");
1602 input_dev = input_allocate_device();
1604 dev_err(dev, "Failed to allocate memory\n");
1608 input_dev->name = "Atmel maXTouch Touchscreen";
1609 input_dev->phys = data->phys;
1610 input_dev->id.bustype = BUS_I2C;
1611 input_dev->dev.parent = dev;
1612 input_dev->open = mxt_input_open;
1613 input_dev->close = mxt_input_close;
1615 __set_bit(EV_ABS, input_dev->evbit);
1616 __set_bit(EV_KEY, input_dev->evbit);
1617 __set_bit(BTN_TOUCH, input_dev->keybit);
1619 if (pdata->t19_num_keys) {
1620 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
1622 for (i = 0; i < pdata->t19_num_keys; i++)
1623 if (pdata->t19_keymap[i] != KEY_RESERVED)
1624 input_set_capability(input_dev, EV_KEY,
1625 pdata->t19_keymap[i]);
1627 mt_flags |= INPUT_MT_POINTER;
1629 input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM);
1630 input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM);
1631 input_abs_set_res(input_dev, ABS_MT_POSITION_X,
1633 input_abs_set_res(input_dev, ABS_MT_POSITION_Y,
1636 input_dev->name = "Atmel maXTouch Touchpad";
1639 /* For single touch */
1640 input_set_abs_params(input_dev, ABS_X,
1641 0, data->max_x, 0, 0);
1642 input_set_abs_params(input_dev, ABS_Y,
1643 0, data->max_y, 0, 0);
1644 input_set_abs_params(input_dev, ABS_PRESSURE,
1647 /* For multi touch */
1648 num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
1649 error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags);
1651 dev_err(dev, "Error %d initialising slots\n", error);
1655 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
1656 0, MXT_MAX_AREA, 0, 0);
1657 input_set_abs_params(input_dev, ABS_MT_POSITION_X,
1658 0, data->max_x, 0, 0);
1659 input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
1660 0, data->max_y, 0, 0);
1661 input_set_abs_params(input_dev, ABS_MT_PRESSURE,
1664 input_set_drvdata(input_dev, data);
1666 error = input_register_device(input_dev);
1668 dev_err(dev, "Error %d registering input device\n", error);
1672 data->input_dev = input_dev;
1677 input_free_device(input_dev);
1681 static int mxt_configure_objects(struct mxt_data *data,
1682 const struct firmware *cfg);
1684 static void mxt_config_cb(const struct firmware *cfg, void *ctx)
1686 mxt_configure_objects(ctx, cfg);
1687 release_firmware(cfg);
1690 static int mxt_initialize(struct mxt_data *data)
1692 struct i2c_client *client = data->client;
1693 int recovery_attempts = 0;
1697 error = mxt_get_info(data);
1701 /* Check bootloader state */
1702 error = mxt_probe_bootloader(data, false);
1704 dev_info(&client->dev, "Trying alternate bootloader address\n");
1705 error = mxt_probe_bootloader(data, true);
1707 /* Chip is not in appmode or bootloader mode */
1712 /* OK, we are in bootloader, see if we can recover */
1713 if (++recovery_attempts > 1) {
1714 dev_err(&client->dev, "Could not recover from bootloader mode\n");
1716 * We can reflash from this state, so do not
1717 * abort initialization.
1719 data->in_bootloader = true;
1723 /* Attempt to exit bootloader into app mode */
1724 mxt_send_bootloader_cmd(data, false);
1725 msleep(MXT_FW_RESET_TIME);
1728 /* Get object table information */
1729 error = mxt_get_object_table(data);
1731 dev_err(&client->dev, "Error %d reading object table\n", error);
1735 error = mxt_acquire_irq(data);
1737 goto err_free_object_table;
1739 error = request_firmware_nowait(THIS_MODULE, true, MXT_CFG_NAME,
1740 &client->dev, GFP_KERNEL, data,
1743 dev_err(&client->dev, "Failed to invoke firmware loader: %d\n",
1745 goto err_free_object_table;
1750 err_free_object_table:
1751 mxt_free_object_table(data);
1755 static int mxt_configure_objects(struct mxt_data *data,
1756 const struct firmware *cfg)
1758 struct device *dev = &data->client->dev;
1759 struct mxt_info *info = &data->info;
1763 error = mxt_update_cfg(data, cfg);
1765 dev_warn(dev, "Error %d updating config\n", error);
1768 error = mxt_initialize_t9_input_device(data);
1773 "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n",
1774 info->family_id, info->variant_id, info->version >> 4,
1775 info->version & 0xf, info->build, info->object_num);
1780 /* Firmware Version is returned as Major.Minor.Build */
1781 static ssize_t mxt_fw_version_show(struct device *dev,
1782 struct device_attribute *attr, char *buf)
1784 struct mxt_data *data = dev_get_drvdata(dev);
1785 struct mxt_info *info = &data->info;
1786 return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
1787 info->version >> 4, info->version & 0xf, info->build);
1790 /* Hardware Version is returned as FamilyID.VariantID */
1791 static ssize_t mxt_hw_version_show(struct device *dev,
1792 struct device_attribute *attr, char *buf)
1794 struct mxt_data *data = dev_get_drvdata(dev);
1795 struct mxt_info *info = &data->info;
1796 return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
1797 info->family_id, info->variant_id);
1800 static ssize_t mxt_show_instance(char *buf, int count,
1801 struct mxt_object *object, int instance,
1806 if (mxt_obj_instances(object) > 1)
1807 count += scnprintf(buf + count, PAGE_SIZE - count,
1808 "Instance %u\n", instance);
1810 for (i = 0; i < mxt_obj_size(object); i++)
1811 count += scnprintf(buf + count, PAGE_SIZE - count,
1812 "\t[%2u]: %02x (%d)\n", i, val[i], val[i]);
1813 count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
1818 static ssize_t mxt_object_show(struct device *dev,
1819 struct device_attribute *attr, char *buf)
1821 struct mxt_data *data = dev_get_drvdata(dev);
1822 struct mxt_object *object;
1828 /* Pre-allocate buffer large enough to hold max sized object. */
1829 obuf = kmalloc(256, GFP_KERNEL);
1834 for (i = 0; i < data->info.object_num; i++) {
1835 object = data->object_table + i;
1837 if (!mxt_object_readable(object->type))
1840 count += scnprintf(buf + count, PAGE_SIZE - count,
1841 "T%u:\n", object->type);
1843 for (j = 0; j < mxt_obj_instances(object); j++) {
1844 u16 size = mxt_obj_size(object);
1845 u16 addr = object->start_address + j * size;
1847 error = __mxt_read_reg(data->client, addr, size, obuf);
1851 count = mxt_show_instance(buf, count, object, j, obuf);
1857 return error ?: count;
1860 static int mxt_check_firmware_format(struct device *dev,
1861 const struct firmware *fw)
1863 unsigned int pos = 0;
1866 while (pos < fw->size) {
1867 c = *(fw->data + pos);
1869 if (c < '0' || (c > '9' && c < 'A') || c > 'F')
1876 * To convert file try:
1877 * xxd -r -p mXTXXX__APP_VX-X-XX.enc > maxtouch.fw
1879 dev_err(dev, "Aborting: firmware file must be in binary format\n");
1884 static int mxt_load_fw(struct device *dev, const char *fn)
1886 struct mxt_data *data = dev_get_drvdata(dev);
1887 const struct firmware *fw = NULL;
1888 unsigned int frame_size;
1889 unsigned int pos = 0;
1890 unsigned int retry = 0;
1891 unsigned int frame = 0;
1894 ret = request_firmware(&fw, fn, dev);
1896 dev_err(dev, "Unable to open firmware %s\n", fn);
1900 /* Check for incorrect enc file */
1901 ret = mxt_check_firmware_format(dev, fw);
1903 goto release_firmware;
1905 if (!data->in_bootloader) {
1906 /* Change to the bootloader mode */
1907 data->in_bootloader = true;
1909 ret = mxt_t6_command(data, MXT_COMMAND_RESET,
1910 MXT_BOOT_VALUE, false);
1912 goto release_firmware;
1914 msleep(MXT_RESET_TIME);
1916 /* Do not need to scan since we know family ID */
1917 ret = mxt_lookup_bootloader_address(data, 0);
1919 goto release_firmware;
1921 mxt_free_input_device(data);
1922 mxt_free_object_table(data);
1924 enable_irq(data->irq);
1927 reinit_completion(&data->bl_completion);
1929 ret = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD, false);
1931 /* Bootloader may still be unlocked from previous attempt */
1932 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, false);
1936 dev_info(dev, "Unlocking bootloader\n");
1938 /* Unlock bootloader */
1939 ret = mxt_send_bootloader_cmd(data, true);
1944 while (pos < fw->size) {
1945 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, true);
1949 frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
1951 /* Take account of CRC bytes */
1954 /* Write one frame to device */
1955 ret = mxt_bootloader_write(data, fw->data + pos, frame_size);
1959 ret = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS, true);
1963 /* Back off by 20ms per retry */
1967 dev_err(dev, "Retry count exceeded\n");
1976 if (frame % 50 == 0)
1977 dev_dbg(dev, "Sent %d frames, %d/%zd bytes\n",
1978 frame, pos, fw->size);
1981 /* Wait for flash. */
1982 ret = mxt_wait_for_completion(data, &data->bl_completion,
1987 dev_dbg(dev, "Sent %d frames, %d bytes\n", frame, pos);
1990 * Wait for device to reset. Some bootloader versions do not assert
1991 * the CHG line after bootloading has finished, so ignore potential
1994 mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME);
1996 data->in_bootloader = false;
1999 disable_irq(data->irq);
2001 release_firmware(fw);
2005 static ssize_t mxt_update_fw_store(struct device *dev,
2006 struct device_attribute *attr,
2007 const char *buf, size_t count)
2009 struct mxt_data *data = dev_get_drvdata(dev);
2012 error = mxt_load_fw(dev, MXT_FW_NAME);
2014 dev_err(dev, "The firmware update failed(%d)\n", error);
2017 dev_info(dev, "The firmware update succeeded\n");
2019 error = mxt_initialize(data);
2027 static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
2028 static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
2029 static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
2030 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
2032 static struct attribute *mxt_attrs[] = {
2033 &dev_attr_fw_version.attr,
2034 &dev_attr_hw_version.attr,
2035 &dev_attr_object.attr,
2036 &dev_attr_update_fw.attr,
2040 static const struct attribute_group mxt_attr_group = {
2044 static void mxt_start(struct mxt_data *data)
2047 mxt_write_object(data,
2048 MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0x83);
2051 static void mxt_stop(struct mxt_data *data)
2054 mxt_write_object(data,
2055 MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0);
2058 static int mxt_input_open(struct input_dev *dev)
2060 struct mxt_data *data = input_get_drvdata(dev);
2067 static void mxt_input_close(struct input_dev *dev)
2069 struct mxt_data *data = input_get_drvdata(dev);
2075 static struct mxt_platform_data *mxt_parse_dt(struct i2c_client *client)
2077 struct mxt_platform_data *pdata;
2080 int proplen, i, ret;
2082 if (!client->dev.of_node)
2083 return ERR_PTR(-ENODEV);
2085 pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL);
2087 return ERR_PTR(-ENOMEM);
2089 if (of_find_property(client->dev.of_node, "linux,gpio-keymap",
2091 pdata->t19_num_keys = proplen / sizeof(u32);
2093 keymap = devm_kzalloc(&client->dev,
2094 pdata->t19_num_keys * sizeof(keymap[0]),
2097 return ERR_PTR(-ENOMEM);
2099 for (i = 0; i < pdata->t19_num_keys; i++) {
2100 ret = of_property_read_u32_index(client->dev.of_node,
2101 "linux,gpio-keymap", i, &keycode);
2103 keycode = KEY_RESERVED;
2105 keymap[i] = keycode;
2108 pdata->t19_keymap = keymap;
2114 static struct mxt_platform_data *mxt_parse_dt(struct i2c_client *client)
2116 dev_dbg(&client->dev, "No platform data specified\n");
2117 return ERR_PTR(-EINVAL);
2121 static int mxt_probe(struct i2c_client *client, const struct i2c_device_id *id)
2123 struct mxt_data *data;
2124 const struct mxt_platform_data *pdata;
2127 pdata = dev_get_platdata(&client->dev);
2129 pdata = mxt_parse_dt(client);
2131 return PTR_ERR(pdata);
2134 data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL);
2136 dev_err(&client->dev, "Failed to allocate memory\n");
2140 snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
2141 client->adapter->nr, client->addr);
2143 data->client = client;
2144 data->pdata = pdata;
2145 data->irq = client->irq;
2146 i2c_set_clientdata(client, data);
2148 init_completion(&data->bl_completion);
2149 init_completion(&data->reset_completion);
2150 init_completion(&data->crc_completion);
2152 error = request_threaded_irq(client->irq, NULL, mxt_interrupt,
2153 pdata->irqflags | IRQF_ONESHOT,
2154 client->name, data);
2156 dev_err(&client->dev, "Failed to register interrupt\n");
2160 disable_irq(client->irq);
2162 error = mxt_initialize(data);
2166 error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
2168 dev_err(&client->dev, "Failure %d creating sysfs group\n",
2170 goto err_free_object;
2176 mxt_free_input_device(data);
2177 mxt_free_object_table(data);
2179 free_irq(client->irq, data);
2185 static int mxt_remove(struct i2c_client *client)
2187 struct mxt_data *data = i2c_get_clientdata(client);
2189 sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
2190 free_irq(data->irq, data);
2191 mxt_free_input_device(data);
2192 mxt_free_object_table(data);
2198 static int __maybe_unused mxt_suspend(struct device *dev)
2200 struct i2c_client *client = to_i2c_client(dev);
2201 struct mxt_data *data = i2c_get_clientdata(client);
2202 struct input_dev *input_dev = data->input_dev;
2204 mutex_lock(&input_dev->mutex);
2206 if (input_dev->users)
2209 mutex_unlock(&input_dev->mutex);
2214 static int __maybe_unused mxt_resume(struct device *dev)
2216 struct i2c_client *client = to_i2c_client(dev);
2217 struct mxt_data *data = i2c_get_clientdata(client);
2218 struct input_dev *input_dev = data->input_dev;
2220 mxt_soft_reset(data);
2222 mutex_lock(&input_dev->mutex);
2224 if (input_dev->users)
2227 mutex_unlock(&input_dev->mutex);
2232 static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);
2234 static const struct of_device_id mxt_of_match[] = {
2235 { .compatible = "atmel,maxtouch", },
2238 MODULE_DEVICE_TABLE(of, mxt_of_match);
2240 static const struct i2c_device_id mxt_id[] = {
2241 { "qt602240_ts", 0 },
2242 { "atmel_mxt_ts", 0 },
2243 { "atmel_mxt_tp", 0 },
2247 MODULE_DEVICE_TABLE(i2c, mxt_id);
2249 static struct i2c_driver mxt_driver = {
2251 .name = "atmel_mxt_ts",
2252 .owner = THIS_MODULE,
2253 .of_match_table = of_match_ptr(mxt_of_match),
2257 .remove = mxt_remove,
2261 module_i2c_driver(mxt_driver);
2263 /* Module information */
2265 MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
2266 MODULE_LICENSE("GPL");