1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Atmel maXTouch Touchscreen driver
5 * Copyright (C) 2010 Samsung Electronics Co.Ltd
6 * Copyright (C) 2011-2014 Atmel Corporation
7 * Copyright (C) 2012 Google, Inc.
8 * Copyright (C) 2016 Zodiac Inflight Innovations
13 #include <linux/acpi.h>
14 #include <linux/dmi.h>
15 #include <linux/module.h>
16 #include <linux/init.h>
17 #include <linux/completion.h>
18 #include <linux/delay.h>
19 #include <linux/firmware.h>
20 #include <linux/i2c.h>
21 #include <linux/input/mt.h>
22 #include <linux/interrupt.h>
23 #include <linux/irq.h>
25 #include <linux/property.h>
26 #include <linux/slab.h>
27 #include <linux/regulator/consumer.h>
28 #include <linux/gpio/consumer.h>
29 #include <asm/unaligned.h>
30 #include <media/v4l2-device.h>
31 #include <media/v4l2-ioctl.h>
32 #include <media/videobuf2-v4l2.h>
33 #include <media/videobuf2-vmalloc.h>
34 #include <dt-bindings/input/atmel-maxtouch.h>
37 #define MXT_FW_NAME "maxtouch.fw"
38 #define MXT_CFG_NAME "maxtouch.cfg"
39 #define MXT_CFG_MAGIC "OBP_RAW V1"
42 #define MXT_OBJECT_START 0x07
43 #define MXT_OBJECT_SIZE 6
44 #define MXT_INFO_CHECKSUM_SIZE 3
45 #define MXT_MAX_BLOCK_WRITE 256
48 #define MXT_DEBUG_DIAGNOSTIC_T37 37
49 #define MXT_GEN_MESSAGE_T5 5
50 #define MXT_GEN_COMMAND_T6 6
51 #define MXT_GEN_POWER_T7 7
52 #define MXT_GEN_ACQUIRE_T8 8
53 #define MXT_GEN_DATASOURCE_T53 53
54 #define MXT_TOUCH_MULTI_T9 9
55 #define MXT_TOUCH_KEYARRAY_T15 15
56 #define MXT_TOUCH_PROXIMITY_T23 23
57 #define MXT_TOUCH_PROXKEY_T52 52
58 #define MXT_PROCI_GRIPFACE_T20 20
59 #define MXT_PROCG_NOISE_T22 22
60 #define MXT_PROCI_ONETOUCH_T24 24
61 #define MXT_PROCI_TWOTOUCH_T27 27
62 #define MXT_PROCI_GRIP_T40 40
63 #define MXT_PROCI_PALM_T41 41
64 #define MXT_PROCI_TOUCHSUPPRESSION_T42 42
65 #define MXT_PROCI_STYLUS_T47 47
66 #define MXT_PROCG_NOISESUPPRESSION_T48 48
67 #define MXT_SPT_COMMSCONFIG_T18 18
68 #define MXT_SPT_GPIOPWM_T19 19
69 #define MXT_SPT_SELFTEST_T25 25
70 #define MXT_SPT_CTECONFIG_T28 28
71 #define MXT_SPT_USERDATA_T38 38
72 #define MXT_SPT_DIGITIZER_T43 43
73 #define MXT_SPT_MESSAGECOUNT_T44 44
74 #define MXT_SPT_CTECONFIG_T46 46
75 #define MXT_SPT_DYNAMICCONFIGURATIONCONTAINER_T71 71
76 #define MXT_TOUCH_MULTITOUCHSCREEN_T100 100
78 /* MXT_GEN_MESSAGE_T5 object */
79 #define MXT_RPTID_NOMSG 0xff
81 /* MXT_GEN_COMMAND_T6 field */
82 #define MXT_COMMAND_RESET 0
83 #define MXT_COMMAND_BACKUPNV 1
84 #define MXT_COMMAND_CALIBRATE 2
85 #define MXT_COMMAND_REPORTALL 3
86 #define MXT_COMMAND_DIAGNOSTIC 5
88 /* Define for T6 status byte */
89 #define MXT_T6_STATUS_RESET BIT(7)
90 #define MXT_T6_STATUS_OFL BIT(6)
91 #define MXT_T6_STATUS_SIGERR BIT(5)
92 #define MXT_T6_STATUS_CAL BIT(4)
93 #define MXT_T6_STATUS_CFGERR BIT(3)
94 #define MXT_T6_STATUS_COMSERR BIT(2)
96 /* MXT_GEN_POWER_T7 field */
102 #define MXT_POWER_CFG_RUN 0
103 #define MXT_POWER_CFG_DEEPSLEEP 1
105 /* MXT_TOUCH_MULTI_T9 field */
106 #define MXT_T9_CTRL 0
107 #define MXT_T9_XSIZE 3
108 #define MXT_T9_YSIZE 4
109 #define MXT_T9_ORIENT 9
110 #define MXT_T9_RANGE 18
112 /* MXT_TOUCH_MULTI_T9 status */
113 #define MXT_T9_UNGRIP BIT(0)
114 #define MXT_T9_SUPPRESS BIT(1)
115 #define MXT_T9_AMP BIT(2)
116 #define MXT_T9_VECTOR BIT(3)
117 #define MXT_T9_MOVE BIT(4)
118 #define MXT_T9_RELEASE BIT(5)
119 #define MXT_T9_PRESS BIT(6)
120 #define MXT_T9_DETECT BIT(7)
127 /* MXT_TOUCH_MULTI_T9 orient */
128 #define MXT_T9_ORIENT_SWITCH BIT(0)
129 #define MXT_T9_ORIENT_INVERTX BIT(1)
130 #define MXT_T9_ORIENT_INVERTY BIT(2)
132 /* MXT_SPT_COMMSCONFIG_T18 */
133 #define MXT_COMMS_CTRL 0
134 #define MXT_COMMS_CMD 1
135 #define MXT_COMMS_RETRIGEN BIT(6)
137 /* MXT_DEBUG_DIAGNOSTIC_T37 */
138 #define MXT_DIAGNOSTIC_PAGEUP 0x01
139 #define MXT_DIAGNOSTIC_DELTAS 0x10
140 #define MXT_DIAGNOSTIC_REFS 0x11
141 #define MXT_DIAGNOSTIC_SIZE 128
143 #define MXT_FAMILY_1386 160
144 #define MXT1386_COLUMNS 3
145 #define MXT1386_PAGES_PER_COLUMN 8
148 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
151 u8 data[MXT_DIAGNOSTIC_SIZE];
155 /* Define for MXT_GEN_COMMAND_T6 */
156 #define MXT_BOOT_VALUE 0xa5
157 #define MXT_RESET_VALUE 0x01
158 #define MXT_BACKUP_VALUE 0x55
160 /* T100 Multiple Touch Touchscreen */
161 #define MXT_T100_CTRL 0
162 #define MXT_T100_CFG1 1
163 #define MXT_T100_TCHAUX 3
164 #define MXT_T100_XSIZE 9
165 #define MXT_T100_XRANGE 13
166 #define MXT_T100_YSIZE 20
167 #define MXT_T100_YRANGE 24
169 #define MXT_T100_CFG_SWITCHXY BIT(5)
170 #define MXT_T100_CFG_INVERTY BIT(6)
171 #define MXT_T100_CFG_INVERTX BIT(7)
173 #define MXT_T100_TCHAUX_VECT BIT(0)
174 #define MXT_T100_TCHAUX_AMPL BIT(1)
175 #define MXT_T100_TCHAUX_AREA BIT(2)
177 #define MXT_T100_DETECT BIT(7)
178 #define MXT_T100_TYPE_MASK 0x70
181 MXT_T100_TYPE_FINGER = 1,
182 MXT_T100_TYPE_PASSIVE_STYLUS = 2,
183 MXT_T100_TYPE_HOVERING_FINGER = 4,
184 MXT_T100_TYPE_GLOVE = 5,
185 MXT_T100_TYPE_LARGE_TOUCH = 6,
188 #define MXT_DISTANCE_ACTIVE_TOUCH 0
189 #define MXT_DISTANCE_HOVERING 1
191 #define MXT_TOUCH_MAJOR_DEFAULT 1
192 #define MXT_PRESSURE_DEFAULT 1
195 #define MXT_BACKUP_TIME 50 /* msec */
196 #define MXT_RESET_GPIO_TIME 20 /* msec */
197 #define MXT_RESET_INVALID_CHG 100 /* msec */
198 #define MXT_RESET_TIME 200 /* msec */
199 #define MXT_RESET_TIMEOUT 3000 /* msec */
200 #define MXT_CRC_TIMEOUT 1000 /* msec */
201 #define MXT_FW_RESET_TIME 3000 /* msec */
202 #define MXT_FW_CHG_TIMEOUT 300 /* msec */
203 #define MXT_WAKEUP_TIME 25 /* msec */
205 /* Command to unlock bootloader */
206 #define MXT_UNLOCK_CMD_MSB 0xaa
207 #define MXT_UNLOCK_CMD_LSB 0xdc
209 /* Bootloader mode status */
210 #define MXT_WAITING_BOOTLOAD_CMD 0xc0 /* valid 7 6 bit only */
211 #define MXT_WAITING_FRAME_DATA 0x80 /* valid 7 6 bit only */
212 #define MXT_FRAME_CRC_CHECK 0x02
213 #define MXT_FRAME_CRC_FAIL 0x03
214 #define MXT_FRAME_CRC_PASS 0x04
215 #define MXT_APP_CRC_FAIL 0x40 /* valid 7 8 bit only */
216 #define MXT_BOOT_STATUS_MASK 0x3f
217 #define MXT_BOOT_EXTENDED_ID BIT(5)
218 #define MXT_BOOT_ID_MASK 0x1f
220 /* Touchscreen absolute values */
221 #define MXT_MAX_AREA 0xff
223 #define MXT_PIXELS_PER_MM 20
239 u8 instances_minus_one;
245 u16 diag_cmd_address;
246 struct t37_debug *t37_buf;
247 unsigned int t37_pages;
248 unsigned int t37_nodes;
250 struct v4l2_device v4l2;
251 struct v4l2_pix_format format;
252 struct video_device vdev;
253 struct vb2_queue queue;
258 enum v4l_dbg_inputs {
259 MXT_V4L_INPUT_DELTAS,
264 enum mxt_suspend_mode {
265 MXT_SUSPEND_DEEP_SLEEP = 0,
266 MXT_SUSPEND_T9_CTRL = 1,
269 /* Config update context */
279 struct mxt_info info;
282 /* Each client has this additional data */
284 struct i2c_client *client;
285 struct input_dev *input_dev;
286 char phys[64]; /* device physical location */
287 struct mxt_object *object_table;
288 struct mxt_info *info;
289 void *raw_info_block;
310 u8 last_message_count;
313 struct t7_config t7_cfg;
315 struct regulator_bulk_data regulators[2];
316 struct gpio_desc *reset_gpio;
317 struct gpio_desc *wake_gpio;
318 bool use_retrigen_workaround;
320 /* Cached parameters from object table */
332 u8 T100_reportid_min;
333 u8 T100_reportid_max;
335 /* for fw update in bootloader */
336 struct completion bl_completion;
338 /* for reset handling */
339 struct completion reset_completion;
341 /* for config update handling */
342 struct completion crc_completion;
345 unsigned int t19_num_keys;
347 enum mxt_suspend_mode suspend_mode;
352 struct mxt_vb2_buffer {
353 struct vb2_buffer vb;
354 struct list_head list;
357 static size_t mxt_obj_size(const struct mxt_object *obj)
359 return obj->size_minus_one + 1;
362 static size_t mxt_obj_instances(const struct mxt_object *obj)
364 return obj->instances_minus_one + 1;
367 static bool mxt_object_readable(unsigned int type)
370 case MXT_GEN_COMMAND_T6:
371 case MXT_GEN_POWER_T7:
372 case MXT_GEN_ACQUIRE_T8:
373 case MXT_GEN_DATASOURCE_T53:
374 case MXT_TOUCH_MULTI_T9:
375 case MXT_TOUCH_KEYARRAY_T15:
376 case MXT_TOUCH_PROXIMITY_T23:
377 case MXT_TOUCH_PROXKEY_T52:
378 case MXT_TOUCH_MULTITOUCHSCREEN_T100:
379 case MXT_PROCI_GRIPFACE_T20:
380 case MXT_PROCG_NOISE_T22:
381 case MXT_PROCI_ONETOUCH_T24:
382 case MXT_PROCI_TWOTOUCH_T27:
383 case MXT_PROCI_GRIP_T40:
384 case MXT_PROCI_PALM_T41:
385 case MXT_PROCI_TOUCHSUPPRESSION_T42:
386 case MXT_PROCI_STYLUS_T47:
387 case MXT_PROCG_NOISESUPPRESSION_T48:
388 case MXT_SPT_COMMSCONFIG_T18:
389 case MXT_SPT_GPIOPWM_T19:
390 case MXT_SPT_SELFTEST_T25:
391 case MXT_SPT_CTECONFIG_T28:
392 case MXT_SPT_USERDATA_T38:
393 case MXT_SPT_DIGITIZER_T43:
394 case MXT_SPT_CTECONFIG_T46:
395 case MXT_SPT_DYNAMICCONFIGURATIONCONTAINER_T71:
402 static void mxt_dump_message(struct mxt_data *data, u8 *message)
404 dev_dbg(&data->client->dev, "message: %*ph\n",
405 data->T5_msg_size, message);
408 static int mxt_wait_for_completion(struct mxt_data *data,
409 struct completion *comp,
410 unsigned int timeout_ms)
412 struct device *dev = &data->client->dev;
413 unsigned long timeout = msecs_to_jiffies(timeout_ms);
416 ret = wait_for_completion_interruptible_timeout(comp, timeout);
419 } else if (ret == 0) {
420 dev_err(dev, "Wait for completion timed out.\n");
426 static int mxt_bootloader_read(struct mxt_data *data,
427 u8 *val, unsigned int count)
432 msg.addr = data->bootloader_addr;
433 msg.flags = data->client->flags & I2C_M_TEN;
434 msg.flags |= I2C_M_RD;
438 ret = i2c_transfer(data->client->adapter, &msg, 1);
442 ret = ret < 0 ? ret : -EIO;
443 dev_err(&data->client->dev, "%s: i2c recv failed (%d)\n",
450 static int mxt_bootloader_write(struct mxt_data *data,
451 const u8 * const val, unsigned int count)
456 msg.addr = data->bootloader_addr;
457 msg.flags = data->client->flags & I2C_M_TEN;
461 ret = i2c_transfer(data->client->adapter, &msg, 1);
465 ret = ret < 0 ? ret : -EIO;
466 dev_err(&data->client->dev, "%s: i2c send failed (%d)\n",
473 static int mxt_lookup_bootloader_address(struct mxt_data *data, bool retry)
475 u8 appmode = data->client->addr;
477 u8 family_id = data->info ? data->info->family_id : 0;
482 /* Chips after 1664S use different scheme */
483 if (retry || family_id >= 0xa2) {
484 bootloader = appmode - 0x24;
487 fallthrough; /* for normal case */
492 bootloader = appmode - 0x26;
496 dev_err(&data->client->dev,
497 "Appmode i2c address 0x%02x not found\n",
502 data->bootloader_addr = bootloader;
506 static int mxt_probe_bootloader(struct mxt_data *data, bool alt_address)
508 struct device *dev = &data->client->dev;
513 error = mxt_lookup_bootloader_address(data, alt_address);
517 error = mxt_bootloader_read(data, &val, 1);
521 /* Check app crc fail mode */
522 crc_failure = (val & ~MXT_BOOT_STATUS_MASK) == MXT_APP_CRC_FAIL;
524 dev_err(dev, "Detected bootloader, status:%02X%s\n",
525 val, crc_failure ? ", APP_CRC_FAIL" : "");
530 static u8 mxt_get_bootloader_version(struct mxt_data *data, u8 val)
532 struct device *dev = &data->client->dev;
535 if (val & MXT_BOOT_EXTENDED_ID) {
536 if (mxt_bootloader_read(data, &buf[0], 3) != 0) {
537 dev_err(dev, "%s: i2c failure\n", __func__);
541 dev_dbg(dev, "Bootloader ID:%d Version:%d\n", buf[1], buf[2]);
545 dev_dbg(dev, "Bootloader ID:%d\n", val & MXT_BOOT_ID_MASK);
551 static int mxt_check_bootloader(struct mxt_data *data, unsigned int state,
554 struct device *dev = &data->client->dev;
561 * In application update mode, the interrupt
562 * line signals state transitions. We must wait for the
563 * CHG assertion before reading the status byte.
564 * Once the status byte has been read, the line is deasserted.
566 ret = mxt_wait_for_completion(data, &data->bl_completion,
570 * TODO: handle -ERESTARTSYS better by terminating
571 * fw update process before returning to userspace
572 * by writing length 0x000 to device (iff we are in
573 * WAITING_FRAME_DATA state).
575 dev_err(dev, "Update wait error %d\n", ret);
580 ret = mxt_bootloader_read(data, &val, 1);
584 if (state == MXT_WAITING_BOOTLOAD_CMD)
585 val = mxt_get_bootloader_version(data, val);
588 case MXT_WAITING_BOOTLOAD_CMD:
589 case MXT_WAITING_FRAME_DATA:
590 case MXT_APP_CRC_FAIL:
591 val &= ~MXT_BOOT_STATUS_MASK;
593 case MXT_FRAME_CRC_PASS:
594 if (val == MXT_FRAME_CRC_CHECK) {
596 } else if (val == MXT_FRAME_CRC_FAIL) {
597 dev_err(dev, "Bootloader CRC fail\n");
606 dev_err(dev, "Invalid bootloader state %02X != %02X\n",
614 static int mxt_send_bootloader_cmd(struct mxt_data *data, bool unlock)
619 buf[0] = MXT_UNLOCK_CMD_LSB;
620 buf[1] = MXT_UNLOCK_CMD_MSB;
626 return mxt_bootloader_write(data, buf, sizeof(buf));
629 static bool mxt_wakeup_toggle(struct i2c_client *client,
630 bool wake_up, bool in_i2c)
632 struct mxt_data *data = i2c_get_clientdata(client);
634 switch (data->wakeup_method) {
635 case ATMEL_MXT_WAKEUP_I2C_SCL:
640 case ATMEL_MXT_WAKEUP_GPIO:
644 gpiod_set_value(data->wake_gpio, wake_up);
652 dev_dbg(&client->dev, "waking up controller\n");
654 msleep(MXT_WAKEUP_TIME);
660 static int __mxt_read_reg(struct i2c_client *client,
661 u16 reg, u16 len, void *val)
663 struct i2c_msg xfer[2];
664 bool retried = false;
669 buf[1] = (reg >> 8) & 0xff;
672 xfer[0].addr = client->addr;
678 xfer[1].addr = client->addr;
679 xfer[1].flags = I2C_M_RD;
684 ret = i2c_transfer(client->adapter, xfer, 2);
687 } else if (!retried && mxt_wakeup_toggle(client, true, true)) {
693 dev_err(&client->dev, "%s: i2c transfer failed (%d)\n",
700 static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len,
703 bool retried = false;
709 buf = kmalloc(count, GFP_KERNEL);
714 buf[1] = (reg >> 8) & 0xff;
715 memcpy(&buf[2], val, len);
718 ret = i2c_master_send(client, buf, count);
721 } else if (!retried && mxt_wakeup_toggle(client, true, true)) {
727 dev_err(&client->dev, "%s: i2c send failed (%d)\n",
735 static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
737 return __mxt_write_reg(client, reg, 1, &val);
740 static struct mxt_object *
741 mxt_get_object(struct mxt_data *data, u8 type)
743 struct mxt_object *object;
746 for (i = 0; i < data->info->object_num; i++) {
747 object = data->object_table + i;
748 if (object->type == type)
752 dev_warn(&data->client->dev, "Invalid object type T%u\n", type);
756 static void mxt_proc_t6_messages(struct mxt_data *data, u8 *msg)
758 struct device *dev = &data->client->dev;
760 u32 crc = msg[2] | (msg[3] << 8) | (msg[4] << 16);
762 if (crc != data->config_crc) {
763 data->config_crc = crc;
764 dev_dbg(dev, "T6 Config Checksum: 0x%06X\n", crc);
767 complete(&data->crc_completion);
770 if (status & MXT_T6_STATUS_RESET)
771 complete(&data->reset_completion);
773 /* Output debug if status has changed */
774 if (status != data->t6_status)
775 dev_dbg(dev, "T6 Status 0x%02X%s%s%s%s%s%s%s\n",
777 status == 0 ? " OK" : "",
778 status & MXT_T6_STATUS_RESET ? " RESET" : "",
779 status & MXT_T6_STATUS_OFL ? " OFL" : "",
780 status & MXT_T6_STATUS_SIGERR ? " SIGERR" : "",
781 status & MXT_T6_STATUS_CAL ? " CAL" : "",
782 status & MXT_T6_STATUS_CFGERR ? " CFGERR" : "",
783 status & MXT_T6_STATUS_COMSERR ? " COMSERR" : "");
785 /* Save current status */
786 data->t6_status = status;
789 static int mxt_write_object(struct mxt_data *data,
790 u8 type, u8 offset, u8 val)
792 struct mxt_object *object;
795 object = mxt_get_object(data, type);
796 if (!object || offset >= mxt_obj_size(object))
799 reg = object->start_address;
800 return mxt_write_reg(data->client, reg + offset, val);
803 static void mxt_input_button(struct mxt_data *data, u8 *message)
805 struct input_dev *input = data->input_dev;
808 for (i = 0; i < data->t19_num_keys; i++) {
809 if (data->t19_keymap[i] == KEY_RESERVED)
812 /* Active-low switch */
813 input_report_key(input, data->t19_keymap[i],
814 !(message[1] & BIT(i)));
818 static void mxt_input_sync(struct mxt_data *data)
820 input_mt_report_pointer_emulation(data->input_dev,
822 input_sync(data->input_dev);
825 static void mxt_proc_t9_message(struct mxt_data *data, u8 *message)
827 struct device *dev = &data->client->dev;
828 struct input_dev *input_dev = data->input_dev;
836 id = message[0] - data->T9_reportid_min;
838 x = (message[2] << 4) | ((message[4] >> 4) & 0xf);
839 y = (message[3] << 4) | ((message[4] & 0xf));
841 /* Handle 10/12 bit switching */
842 if (data->max_x < 1024)
844 if (data->max_y < 1024)
848 amplitude = message[6];
851 "[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
853 (status & MXT_T9_DETECT) ? 'D' : '.',
854 (status & MXT_T9_PRESS) ? 'P' : '.',
855 (status & MXT_T9_RELEASE) ? 'R' : '.',
856 (status & MXT_T9_MOVE) ? 'M' : '.',
857 (status & MXT_T9_VECTOR) ? 'V' : '.',
858 (status & MXT_T9_AMP) ? 'A' : '.',
859 (status & MXT_T9_SUPPRESS) ? 'S' : '.',
860 (status & MXT_T9_UNGRIP) ? 'U' : '.',
861 x, y, area, amplitude);
863 input_mt_slot(input_dev, id);
865 if (status & MXT_T9_DETECT) {
867 * Multiple bits may be set if the host is slow to read
868 * the status messages, indicating all the events that
871 if (status & MXT_T9_RELEASE) {
872 input_mt_report_slot_inactive(input_dev);
873 mxt_input_sync(data);
876 /* if active, pressure must be non-zero */
878 amplitude = MXT_PRESSURE_DEFAULT;
881 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 1);
882 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
883 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
884 input_report_abs(input_dev, ABS_MT_PRESSURE, amplitude);
885 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
887 /* Touch no longer active, close out slot */
888 input_mt_report_slot_inactive(input_dev);
891 data->update_input = true;
894 static void mxt_proc_t100_message(struct mxt_data *data, u8 *message)
896 struct device *dev = &data->client->dev;
897 struct input_dev *input_dev = data->input_dev;
909 id = message[0] - data->T100_reportid_min - 2;
911 /* ignore SCRSTATUS events */
916 x = get_unaligned_le16(&message[2]);
917 y = get_unaligned_le16(&message[4]);
919 if (status & MXT_T100_DETECT) {
920 type = (status & MXT_T100_TYPE_MASK) >> 4;
923 case MXT_T100_TYPE_HOVERING_FINGER:
924 tool = MT_TOOL_FINGER;
925 distance = MXT_DISTANCE_HOVERING;
927 if (data->t100_aux_vect)
928 orientation = message[data->t100_aux_vect];
932 case MXT_T100_TYPE_FINGER:
933 case MXT_T100_TYPE_GLOVE:
934 tool = MT_TOOL_FINGER;
935 distance = MXT_DISTANCE_ACTIVE_TOUCH;
937 if (data->t100_aux_area)
938 major = message[data->t100_aux_area];
940 if (data->t100_aux_ampl)
941 pressure = message[data->t100_aux_ampl];
943 if (data->t100_aux_vect)
944 orientation = message[data->t100_aux_vect];
948 case MXT_T100_TYPE_PASSIVE_STYLUS:
952 * Passive stylus is reported with size zero so
955 major = MXT_TOUCH_MAJOR_DEFAULT;
957 if (data->t100_aux_ampl)
958 pressure = message[data->t100_aux_ampl];
962 case MXT_T100_TYPE_LARGE_TOUCH:
963 /* Ignore suppressed touch */
967 dev_dbg(dev, "Unexpected T100 type\n");
973 * Values reported should be non-zero if tool is touching the
976 if (!pressure && type != MXT_T100_TYPE_HOVERING_FINGER)
977 pressure = MXT_PRESSURE_DEFAULT;
979 input_mt_slot(input_dev, id);
981 if (status & MXT_T100_DETECT) {
982 dev_dbg(dev, "[%u] type:%u x:%u y:%u a:%02X p:%02X v:%02X\n",
983 id, type, x, y, major, pressure, orientation);
985 input_mt_report_slot_state(input_dev, tool, 1);
986 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
987 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
988 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, major);
989 input_report_abs(input_dev, ABS_MT_PRESSURE, pressure);
990 input_report_abs(input_dev, ABS_MT_DISTANCE, distance);
991 input_report_abs(input_dev, ABS_MT_ORIENTATION, orientation);
993 dev_dbg(dev, "[%u] release\n", id);
996 input_mt_report_slot_inactive(input_dev);
999 data->update_input = true;
1002 static int mxt_proc_message(struct mxt_data *data, u8 *message)
1004 u8 report_id = message[0];
1006 if (report_id == MXT_RPTID_NOMSG)
1009 if (report_id == data->T6_reportid) {
1010 mxt_proc_t6_messages(data, message);
1011 } else if (!data->input_dev) {
1013 * Do not report events if input device
1014 * is not yet registered.
1016 mxt_dump_message(data, message);
1017 } else if (report_id >= data->T9_reportid_min &&
1018 report_id <= data->T9_reportid_max) {
1019 mxt_proc_t9_message(data, message);
1020 } else if (report_id >= data->T100_reportid_min &&
1021 report_id <= data->T100_reportid_max) {
1022 mxt_proc_t100_message(data, message);
1023 } else if (report_id == data->T19_reportid) {
1024 mxt_input_button(data, message);
1025 data->update_input = true;
1027 mxt_dump_message(data, message);
1033 static int mxt_read_and_process_messages(struct mxt_data *data, u8 count)
1035 struct device *dev = &data->client->dev;
1040 /* Safety check for msg_buf */
1041 if (count > data->max_reportid)
1044 /* Process remaining messages if necessary */
1045 ret = __mxt_read_reg(data->client, data->T5_address,
1046 data->T5_msg_size * count, data->msg_buf);
1048 dev_err(dev, "Failed to read %u messages (%d)\n", count, ret);
1052 for (i = 0; i < count; i++) {
1053 ret = mxt_proc_message(data,
1054 data->msg_buf + data->T5_msg_size * i);
1060 /* return number of messages read */
1064 static irqreturn_t mxt_process_messages_t44(struct mxt_data *data)
1066 struct device *dev = &data->client->dev;
1070 /* Read T44 and T5 together */
1071 ret = __mxt_read_reg(data->client, data->T44_address,
1072 data->T5_msg_size + 1, data->msg_buf);
1074 dev_err(dev, "Failed to read T44 and T5 (%d)\n", ret);
1078 count = data->msg_buf[0];
1081 * This condition may be caused by the CHG line being configured in
1082 * Mode 0. It results in unnecessary I2C operations but it is benign.
1087 if (count > data->max_reportid) {
1088 dev_warn(dev, "T44 count %d exceeded max report id\n", count);
1089 count = data->max_reportid;
1092 /* Process first message */
1093 ret = mxt_proc_message(data, data->msg_buf + 1);
1095 dev_warn(dev, "Unexpected invalid message\n");
1099 num_left = count - 1;
1101 /* Process remaining messages if necessary */
1103 ret = mxt_read_and_process_messages(data, num_left);
1106 else if (ret != num_left)
1107 dev_warn(dev, "Unexpected invalid message\n");
1111 if (data->update_input) {
1112 mxt_input_sync(data);
1113 data->update_input = false;
1119 static int mxt_process_messages_until_invalid(struct mxt_data *data)
1121 struct device *dev = &data->client->dev;
1125 count = data->max_reportid;
1127 /* Read messages until we force an invalid */
1129 read = mxt_read_and_process_messages(data, count);
1134 if (data->update_input) {
1135 mxt_input_sync(data);
1136 data->update_input = false;
1139 dev_err(dev, "CHG pin isn't cleared\n");
1143 static irqreturn_t mxt_process_messages(struct mxt_data *data)
1145 int total_handled, num_handled;
1146 u8 count = data->last_message_count;
1148 if (count < 1 || count > data->max_reportid)
1151 /* include final invalid message */
1152 total_handled = mxt_read_and_process_messages(data, count + 1);
1153 if (total_handled < 0)
1155 /* if there were invalid messages, then we are done */
1156 else if (total_handled <= count)
1159 /* keep reading two msgs until one is invalid or reportid limit */
1161 num_handled = mxt_read_and_process_messages(data, 2);
1162 if (num_handled < 0)
1165 total_handled += num_handled;
1167 if (num_handled < 2)
1169 } while (total_handled < data->num_touchids);
1172 data->last_message_count = total_handled;
1174 if (data->update_input) {
1175 mxt_input_sync(data);
1176 data->update_input = false;
1182 static irqreturn_t mxt_interrupt(int irq, void *dev_id)
1184 struct mxt_data *data = dev_id;
1186 if (data->in_bootloader) {
1187 /* bootloader state transition completion */
1188 complete(&data->bl_completion);
1192 if (!data->object_table)
1195 if (data->T44_address) {
1196 return mxt_process_messages_t44(data);
1198 return mxt_process_messages(data);
1202 static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset,
1203 u8 value, bool wait)
1206 u8 command_register;
1207 int timeout_counter = 0;
1210 reg = data->T6_address + cmd_offset;
1212 ret = mxt_write_reg(data->client, reg, value);
1221 ret = __mxt_read_reg(data->client, reg, 1, &command_register);
1224 } while (command_register != 0 && timeout_counter++ <= 100);
1226 if (timeout_counter > 100) {
1227 dev_err(&data->client->dev, "Command failed!\n");
1234 static int mxt_acquire_irq(struct mxt_data *data)
1238 enable_irq(data->irq);
1240 if (data->use_retrigen_workaround) {
1241 error = mxt_process_messages_until_invalid(data);
1249 static int mxt_soft_reset(struct mxt_data *data)
1251 struct device *dev = &data->client->dev;
1254 dev_info(dev, "Resetting device\n");
1256 disable_irq(data->irq);
1258 reinit_completion(&data->reset_completion);
1260 ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false);
1264 /* Ignore CHG line for 100ms after reset */
1265 msleep(MXT_RESET_INVALID_CHG);
1267 mxt_acquire_irq(data);
1269 ret = mxt_wait_for_completion(data, &data->reset_completion,
1277 static void mxt_update_crc(struct mxt_data *data, u8 cmd, u8 value)
1280 * On failure, CRC is set to 0 and config will always be
1283 data->config_crc = 0;
1284 reinit_completion(&data->crc_completion);
1286 mxt_t6_command(data, cmd, value, true);
1289 * Wait for crc message. On failure, CRC is set to 0 and config will
1290 * always be downloaded.
1292 mxt_wait_for_completion(data, &data->crc_completion, MXT_CRC_TIMEOUT);
1295 static void mxt_calc_crc24(u32 *crc, u8 firstbyte, u8 secondbyte)
1297 static const unsigned int crcpoly = 0x80001B;
1301 data_word = (secondbyte << 8) | firstbyte;
1302 result = ((*crc << 1) ^ data_word);
1304 if (result & 0x1000000)
1310 static u32 mxt_calculate_crc(u8 *base, off_t start_off, off_t end_off)
1313 u8 *ptr = base + start_off;
1314 u8 *last_val = base + end_off - 1;
1316 if (end_off < start_off)
1319 while (ptr < last_val) {
1320 mxt_calc_crc24(&crc, *ptr, *(ptr + 1));
1324 /* if len is odd, fill the last byte with 0 */
1325 if (ptr == last_val)
1326 mxt_calc_crc24(&crc, *ptr, 0);
1328 /* Mask to 24-bit */
1334 static int mxt_check_retrigen(struct mxt_data *data)
1336 struct i2c_client *client = data->client;
1339 struct irq_data *irqd;
1341 data->use_retrigen_workaround = false;
1343 irqd = irq_get_irq_data(data->irq);
1347 if (irqd_is_level_type(irqd))
1350 if (data->T18_address) {
1351 error = __mxt_read_reg(client,
1352 data->T18_address + MXT_COMMS_CTRL,
1357 if (val & MXT_COMMS_RETRIGEN)
1361 dev_warn(&client->dev, "Enabling RETRIGEN workaround\n");
1362 data->use_retrigen_workaround = true;
1366 static int mxt_prepare_cfg_mem(struct mxt_data *data, struct mxt_cfg *cfg)
1368 struct device *dev = &data->client->dev;
1369 struct mxt_object *object;
1370 unsigned int type, instance, size, byte_offset;
1377 while (cfg->raw_pos < cfg->raw_size) {
1378 /* Read type, instance, length */
1379 ret = sscanf(cfg->raw + cfg->raw_pos, "%x %x %x%n",
1380 &type, &instance, &size, &offset);
1384 } else if (ret != 3) {
1385 dev_err(dev, "Bad format: failed to parse object\n");
1388 cfg->raw_pos += offset;
1390 object = mxt_get_object(data, type);
1393 for (i = 0; i < size; i++) {
1394 ret = sscanf(cfg->raw + cfg->raw_pos, "%hhx%n",
1397 dev_err(dev, "Bad format in T%d at %d\n",
1401 cfg->raw_pos += offset;
1406 if (size > mxt_obj_size(object)) {
1408 * Either we are in fallback mode due to wrong
1409 * config or config from a later fw version,
1410 * or the file is corrupt or hand-edited.
1412 dev_warn(dev, "Discarding %zu byte(s) in T%u\n",
1413 size - mxt_obj_size(object), type);
1414 } else if (mxt_obj_size(object) > size) {
1416 * If firmware is upgraded, new bytes may be added to
1417 * end of objects. It is generally forward compatible
1418 * to zero these bytes - previous behaviour will be
1419 * retained. However this does invalidate the CRC and
1420 * will force fallback mode until the configuration is
1421 * updated. We warn here but do nothing else - the
1422 * malloc has zeroed the entire configuration.
1424 dev_warn(dev, "Zeroing %zu byte(s) in T%d\n",
1425 mxt_obj_size(object) - size, type);
1428 if (instance >= mxt_obj_instances(object)) {
1429 dev_err(dev, "Object instances exceeded!\n");
1433 reg = object->start_address + mxt_obj_size(object) * instance;
1435 for (i = 0; i < size; i++) {
1436 ret = sscanf(cfg->raw + cfg->raw_pos, "%hhx%n",
1440 dev_err(dev, "Bad format in T%d at %d\n",
1444 cfg->raw_pos += offset;
1446 if (i > mxt_obj_size(object))
1449 byte_offset = reg + i - cfg->start_ofs;
1451 if (byte_offset >= 0 && byte_offset < cfg->mem_size) {
1452 *(cfg->mem + byte_offset) = val;
1454 dev_err(dev, "Bad object: reg:%d, T%d, ofs=%d\n",
1455 reg, object->type, byte_offset);
1464 static int mxt_upload_cfg_mem(struct mxt_data *data, struct mxt_cfg *cfg)
1466 unsigned int byte_offset = 0;
1469 /* Write configuration as blocks */
1470 while (byte_offset < cfg->mem_size) {
1471 unsigned int size = cfg->mem_size - byte_offset;
1473 if (size > MXT_MAX_BLOCK_WRITE)
1474 size = MXT_MAX_BLOCK_WRITE;
1476 error = __mxt_write_reg(data->client,
1477 cfg->start_ofs + byte_offset,
1478 size, cfg->mem + byte_offset);
1480 dev_err(&data->client->dev,
1481 "Config write error, ret=%d\n", error);
1485 byte_offset += size;
1491 static int mxt_init_t7_power_cfg(struct mxt_data *data);
1494 * mxt_update_cfg - download configuration to chip
1496 * Atmel Raw Config File Format
1498 * The first four lines of the raw config file contain:
1500 * 2) Chip ID Information (first 7 bytes of device memory)
1501 * 3) Chip Information Block 24-bit CRC Checksum
1502 * 4) Chip Configuration 24-bit CRC Checksum
1504 * The rest of the file consists of one line per object instance:
1505 * <TYPE> <INSTANCE> <SIZE> <CONTENTS>
1507 * <TYPE> - 2-byte object type as hex
1508 * <INSTANCE> - 2-byte object instance number as hex
1509 * <SIZE> - 2-byte object size as hex
1510 * <CONTENTS> - array of <SIZE> 1-byte hex values
1512 static int mxt_update_cfg(struct mxt_data *data, const struct firmware *fw)
1514 struct device *dev = &data->client->dev;
1519 u32 info_crc, config_crc, calculated_crc;
1522 /* Make zero terminated copy of the OBP_RAW file */
1523 cfg.raw = kmemdup_nul(fw->data, fw->size, GFP_KERNEL);
1527 cfg.raw_size = fw->size;
1529 mxt_update_crc(data, MXT_COMMAND_REPORTALL, 1);
1531 if (strncmp(cfg.raw, MXT_CFG_MAGIC, strlen(MXT_CFG_MAGIC))) {
1532 dev_err(dev, "Unrecognised config file\n");
1537 cfg.raw_pos = strlen(MXT_CFG_MAGIC);
1539 /* Load information block and check */
1540 for (i = 0; i < sizeof(struct mxt_info); i++) {
1541 ret = sscanf(cfg.raw + cfg.raw_pos, "%hhx%n",
1542 (unsigned char *)&cfg.info + i,
1545 dev_err(dev, "Bad format\n");
1550 cfg.raw_pos += offset;
1553 if (cfg.info.family_id != data->info->family_id) {
1554 dev_err(dev, "Family ID mismatch!\n");
1559 if (cfg.info.variant_id != data->info->variant_id) {
1560 dev_err(dev, "Variant ID mismatch!\n");
1566 ret = sscanf(cfg.raw + cfg.raw_pos, "%x%n", &info_crc, &offset);
1568 dev_err(dev, "Bad format: failed to parse Info CRC\n");
1572 cfg.raw_pos += offset;
1574 ret = sscanf(cfg.raw + cfg.raw_pos, "%x%n", &config_crc, &offset);
1576 dev_err(dev, "Bad format: failed to parse Config CRC\n");
1580 cfg.raw_pos += offset;
1583 * The Info Block CRC is calculated over mxt_info and the object
1584 * table. If it does not match then we are trying to load the
1585 * configuration from a different chip or firmware version, so
1586 * the configuration CRC is invalid anyway.
1588 if (info_crc == data->info_crc) {
1589 if (config_crc == 0 || data->config_crc == 0) {
1590 dev_info(dev, "CRC zero, attempting to apply config\n");
1591 } else if (config_crc == data->config_crc) {
1592 dev_dbg(dev, "Config CRC 0x%06X: OK\n",
1597 dev_info(dev, "Config CRC 0x%06X: does not match file 0x%06X\n",
1598 data->config_crc, config_crc);
1602 "Warning: Info CRC error - device=0x%06X file=0x%06X\n",
1603 data->info_crc, info_crc);
1606 /* Malloc memory to store configuration */
1607 cfg.start_ofs = MXT_OBJECT_START +
1608 data->info->object_num * sizeof(struct mxt_object) +
1609 MXT_INFO_CHECKSUM_SIZE;
1610 cfg.mem_size = data->mem_size - cfg.start_ofs;
1611 cfg.mem = kzalloc(cfg.mem_size, GFP_KERNEL);
1617 ret = mxt_prepare_cfg_mem(data, &cfg);
1621 /* Calculate crc of the received configs (not the raw config file) */
1622 if (data->T71_address)
1623 crc_start = data->T71_address;
1624 else if (data->T7_address)
1625 crc_start = data->T7_address;
1627 dev_warn(dev, "Could not find CRC start\n");
1629 if (crc_start > cfg.start_ofs) {
1630 calculated_crc = mxt_calculate_crc(cfg.mem,
1631 crc_start - cfg.start_ofs,
1634 if (config_crc > 0 && config_crc != calculated_crc)
1635 dev_warn(dev, "Config CRC in file inconsistent, calculated=%06X, file=%06X\n",
1636 calculated_crc, config_crc);
1639 ret = mxt_upload_cfg_mem(data, &cfg);
1643 mxt_update_crc(data, MXT_COMMAND_BACKUPNV, MXT_BACKUP_VALUE);
1645 ret = mxt_check_retrigen(data);
1649 ret = mxt_soft_reset(data);
1653 dev_info(dev, "Config successfully updated\n");
1655 /* T7 config may have changed */
1656 mxt_init_t7_power_cfg(data);
1665 static void mxt_free_input_device(struct mxt_data *data)
1667 if (data->input_dev) {
1668 input_unregister_device(data->input_dev);
1669 data->input_dev = NULL;
1673 static void mxt_free_object_table(struct mxt_data *data)
1675 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
1676 video_unregister_device(&data->dbg.vdev);
1677 v4l2_device_unregister(&data->dbg.v4l2);
1679 data->object_table = NULL;
1681 kfree(data->raw_info_block);
1682 data->raw_info_block = NULL;
1683 kfree(data->msg_buf);
1684 data->msg_buf = NULL;
1685 data->T5_address = 0;
1686 data->T5_msg_size = 0;
1687 data->T6_reportid = 0;
1688 data->T7_address = 0;
1689 data->T71_address = 0;
1690 data->T9_reportid_min = 0;
1691 data->T9_reportid_max = 0;
1692 data->T18_address = 0;
1693 data->T19_reportid = 0;
1694 data->T44_address = 0;
1695 data->T100_reportid_min = 0;
1696 data->T100_reportid_max = 0;
1697 data->max_reportid = 0;
1700 static int mxt_parse_object_table(struct mxt_data *data,
1701 struct mxt_object *object_table)
1703 struct i2c_client *client = data->client;
1708 /* Valid Report IDs start counting from 1 */
1711 for (i = 0; i < data->info->object_num; i++) {
1712 struct mxt_object *object = object_table + i;
1715 le16_to_cpus(&object->start_address);
1717 if (object->num_report_ids) {
1719 reportid += object->num_report_ids *
1720 mxt_obj_instances(object);
1721 max_id = reportid - 1;
1727 dev_dbg(&data->client->dev,
1728 "T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n",
1729 object->type, object->start_address,
1730 mxt_obj_size(object), mxt_obj_instances(object),
1733 switch (object->type) {
1734 case MXT_GEN_MESSAGE_T5:
1735 if (data->info->family_id == 0x80 &&
1736 data->info->version < 0x20) {
1738 * On mXT224 firmware versions prior to V2.0
1739 * read and discard unused CRC byte otherwise
1740 * DMA reads are misaligned.
1742 data->T5_msg_size = mxt_obj_size(object);
1744 /* CRC not enabled, so skip last byte */
1745 data->T5_msg_size = mxt_obj_size(object) - 1;
1747 data->T5_address = object->start_address;
1749 case MXT_GEN_COMMAND_T6:
1750 data->T6_reportid = min_id;
1751 data->T6_address = object->start_address;
1753 case MXT_GEN_POWER_T7:
1754 data->T7_address = object->start_address;
1756 case MXT_SPT_DYNAMICCONFIGURATIONCONTAINER_T71:
1757 data->T71_address = object->start_address;
1759 case MXT_TOUCH_MULTI_T9:
1760 data->multitouch = MXT_TOUCH_MULTI_T9;
1761 /* Only handle messages from first T9 instance */
1762 data->T9_reportid_min = min_id;
1763 data->T9_reportid_max = min_id +
1764 object->num_report_ids - 1;
1765 data->num_touchids = object->num_report_ids;
1767 case MXT_SPT_COMMSCONFIG_T18:
1768 data->T18_address = object->start_address;
1770 case MXT_SPT_MESSAGECOUNT_T44:
1771 data->T44_address = object->start_address;
1773 case MXT_SPT_GPIOPWM_T19:
1774 data->T19_reportid = min_id;
1776 case MXT_TOUCH_MULTITOUCHSCREEN_T100:
1777 data->multitouch = MXT_TOUCH_MULTITOUCHSCREEN_T100;
1778 data->T100_reportid_min = min_id;
1779 data->T100_reportid_max = max_id;
1780 /* first two report IDs reserved */
1781 data->num_touchids = object->num_report_ids - 2;
1785 end_address = object->start_address
1786 + mxt_obj_size(object) * mxt_obj_instances(object) - 1;
1788 if (end_address >= data->mem_size)
1789 data->mem_size = end_address + 1;
1792 /* Store maximum reportid */
1793 data->max_reportid = reportid;
1795 /* If T44 exists, T5 position has to be directly after */
1796 if (data->T44_address && (data->T5_address != data->T44_address + 1)) {
1797 dev_err(&client->dev, "Invalid T44 position\n");
1801 data->msg_buf = kcalloc(data->max_reportid,
1802 data->T5_msg_size, GFP_KERNEL);
1809 static int mxt_read_info_block(struct mxt_data *data)
1811 struct i2c_client *client = data->client;
1815 uint8_t num_objects;
1819 /* If info block already allocated, free it */
1820 if (data->raw_info_block)
1821 mxt_free_object_table(data);
1823 /* Read 7-byte ID information block starting at address 0 */
1824 size = sizeof(struct mxt_info);
1825 id_buf = kzalloc(size, GFP_KERNEL);
1829 error = __mxt_read_reg(client, 0, size, id_buf);
1833 /* Resize buffer to give space for rest of info block */
1834 num_objects = ((struct mxt_info *)id_buf)->object_num;
1835 size += (num_objects * sizeof(struct mxt_object))
1836 + MXT_INFO_CHECKSUM_SIZE;
1838 buf = krealloc(id_buf, size, GFP_KERNEL);
1845 /* Read rest of info block */
1846 error = __mxt_read_reg(client, MXT_OBJECT_START,
1847 size - MXT_OBJECT_START,
1848 id_buf + MXT_OBJECT_START);
1852 /* Extract & calculate checksum */
1853 crc_ptr = id_buf + size - MXT_INFO_CHECKSUM_SIZE;
1854 data->info_crc = crc_ptr[0] | (crc_ptr[1] << 8) | (crc_ptr[2] << 16);
1856 calculated_crc = mxt_calculate_crc(id_buf, 0,
1857 size - MXT_INFO_CHECKSUM_SIZE);
1860 * CRC mismatch can be caused by data corruption due to I2C comms
1861 * issue or else device is not using Object Based Protocol (eg i2c-hid)
1863 if ((data->info_crc == 0) || (data->info_crc != calculated_crc)) {
1864 dev_err(&client->dev,
1865 "Info Block CRC error calculated=0x%06X read=0x%06X\n",
1866 calculated_crc, data->info_crc);
1871 data->raw_info_block = id_buf;
1872 data->info = (struct mxt_info *)id_buf;
1874 dev_info(&client->dev,
1875 "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n",
1876 data->info->family_id, data->info->variant_id,
1877 data->info->version >> 4, data->info->version & 0xf,
1878 data->info->build, data->info->object_num);
1880 /* Parse object table information */
1881 error = mxt_parse_object_table(data, id_buf + MXT_OBJECT_START);
1883 dev_err(&client->dev, "Error %d parsing object table\n", error);
1884 mxt_free_object_table(data);
1888 data->object_table = (struct mxt_object *)(id_buf + MXT_OBJECT_START);
1897 static int mxt_read_t9_resolution(struct mxt_data *data)
1899 struct i2c_client *client = data->client;
1901 struct t9_range range;
1902 unsigned char orient;
1903 struct mxt_object *object;
1905 object = mxt_get_object(data, MXT_TOUCH_MULTI_T9);
1909 error = __mxt_read_reg(client,
1910 object->start_address + MXT_T9_XSIZE,
1911 sizeof(data->xsize), &data->xsize);
1915 error = __mxt_read_reg(client,
1916 object->start_address + MXT_T9_YSIZE,
1917 sizeof(data->ysize), &data->ysize);
1921 error = __mxt_read_reg(client,
1922 object->start_address + MXT_T9_RANGE,
1923 sizeof(range), &range);
1927 data->max_x = get_unaligned_le16(&range.x);
1928 data->max_y = get_unaligned_le16(&range.y);
1930 error = __mxt_read_reg(client,
1931 object->start_address + MXT_T9_ORIENT,
1936 data->xy_switch = orient & MXT_T9_ORIENT_SWITCH;
1937 data->invertx = orient & MXT_T9_ORIENT_INVERTX;
1938 data->inverty = orient & MXT_T9_ORIENT_INVERTY;
1943 static int mxt_read_t100_config(struct mxt_data *data)
1945 struct i2c_client *client = data->client;
1947 struct mxt_object *object;
1948 u16 range_x, range_y;
1952 object = mxt_get_object(data, MXT_TOUCH_MULTITOUCHSCREEN_T100);
1956 /* read touchscreen dimensions */
1957 error = __mxt_read_reg(client,
1958 object->start_address + MXT_T100_XRANGE,
1959 sizeof(range_x), &range_x);
1963 data->max_x = get_unaligned_le16(&range_x);
1965 error = __mxt_read_reg(client,
1966 object->start_address + MXT_T100_YRANGE,
1967 sizeof(range_y), &range_y);
1971 data->max_y = get_unaligned_le16(&range_y);
1973 error = __mxt_read_reg(client,
1974 object->start_address + MXT_T100_XSIZE,
1975 sizeof(data->xsize), &data->xsize);
1979 error = __mxt_read_reg(client,
1980 object->start_address + MXT_T100_YSIZE,
1981 sizeof(data->ysize), &data->ysize);
1985 /* read orientation config */
1986 error = __mxt_read_reg(client,
1987 object->start_address + MXT_T100_CFG1,
1992 data->xy_switch = cfg & MXT_T100_CFG_SWITCHXY;
1993 data->invertx = cfg & MXT_T100_CFG_INVERTX;
1994 data->inverty = cfg & MXT_T100_CFG_INVERTY;
1996 /* allocate aux bytes */
1997 error = __mxt_read_reg(client,
1998 object->start_address + MXT_T100_TCHAUX,
2005 if (tchaux & MXT_T100_TCHAUX_VECT)
2006 data->t100_aux_vect = aux++;
2008 if (tchaux & MXT_T100_TCHAUX_AMPL)
2009 data->t100_aux_ampl = aux++;
2011 if (tchaux & MXT_T100_TCHAUX_AREA)
2012 data->t100_aux_area = aux++;
2014 dev_dbg(&client->dev,
2015 "T100 aux mappings vect:%u ampl:%u area:%u\n",
2016 data->t100_aux_vect, data->t100_aux_ampl, data->t100_aux_area);
2021 static int mxt_input_open(struct input_dev *dev);
2022 static void mxt_input_close(struct input_dev *dev);
2024 static void mxt_set_up_as_touchpad(struct input_dev *input_dev,
2025 struct mxt_data *data)
2029 input_dev->name = "Atmel maXTouch Touchpad";
2031 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
2033 input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM);
2034 input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM);
2035 input_abs_set_res(input_dev, ABS_MT_POSITION_X,
2037 input_abs_set_res(input_dev, ABS_MT_POSITION_Y,
2040 for (i = 0; i < data->t19_num_keys; i++)
2041 if (data->t19_keymap[i] != KEY_RESERVED)
2042 input_set_capability(input_dev, EV_KEY,
2043 data->t19_keymap[i]);
2046 static int mxt_initialize_input_device(struct mxt_data *data)
2048 struct device *dev = &data->client->dev;
2049 struct input_dev *input_dev;
2051 unsigned int num_mt_slots;
2052 unsigned int mt_flags = 0;
2054 switch (data->multitouch) {
2055 case MXT_TOUCH_MULTI_T9:
2056 num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
2057 error = mxt_read_t9_resolution(data);
2059 dev_warn(dev, "Failed to initialize T9 resolution\n");
2062 case MXT_TOUCH_MULTITOUCHSCREEN_T100:
2063 num_mt_slots = data->num_touchids;
2064 error = mxt_read_t100_config(data);
2066 dev_warn(dev, "Failed to read T100 config\n");
2070 dev_err(dev, "Invalid multitouch object\n");
2074 /* Handle default values and orientation switch */
2075 if (data->max_x == 0)
2078 if (data->max_y == 0)
2081 if (data->xy_switch)
2082 swap(data->max_x, data->max_y);
2084 dev_info(dev, "Touchscreen size X%uY%u\n", data->max_x, data->max_y);
2086 /* Register input device */
2087 input_dev = input_allocate_device();
2091 input_dev->name = "Atmel maXTouch Touchscreen";
2092 input_dev->phys = data->phys;
2093 input_dev->id.bustype = BUS_I2C;
2094 input_dev->dev.parent = dev;
2095 input_dev->open = mxt_input_open;
2096 input_dev->close = mxt_input_close;
2098 input_set_capability(input_dev, EV_KEY, BTN_TOUCH);
2100 /* For single touch */
2101 input_set_abs_params(input_dev, ABS_X, 0, data->max_x, 0, 0);
2102 input_set_abs_params(input_dev, ABS_Y, 0, data->max_y, 0, 0);
2104 if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
2105 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2106 data->t100_aux_ampl)) {
2107 input_set_abs_params(input_dev, ABS_PRESSURE, 0, 255, 0, 0);
2110 /* If device has buttons we assume it is a touchpad */
2111 if (data->t19_num_keys) {
2112 mxt_set_up_as_touchpad(input_dev, data);
2113 mt_flags |= INPUT_MT_POINTER;
2115 mt_flags |= INPUT_MT_DIRECT;
2118 /* For multi touch */
2119 error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags);
2121 dev_err(dev, "Error %d initialising slots\n", error);
2125 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100) {
2126 input_set_abs_params(input_dev, ABS_MT_TOOL_TYPE,
2127 0, MT_TOOL_MAX, 0, 0);
2128 input_set_abs_params(input_dev, ABS_MT_DISTANCE,
2129 MXT_DISTANCE_ACTIVE_TOUCH,
2130 MXT_DISTANCE_HOVERING,
2134 input_set_abs_params(input_dev, ABS_MT_POSITION_X,
2135 0, data->max_x, 0, 0);
2136 input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
2137 0, data->max_y, 0, 0);
2139 if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
2140 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2141 data->t100_aux_area)) {
2142 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
2143 0, MXT_MAX_AREA, 0, 0);
2146 if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
2147 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2148 data->t100_aux_ampl)) {
2149 input_set_abs_params(input_dev, ABS_MT_PRESSURE,
2153 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2154 data->t100_aux_vect) {
2155 input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
2159 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2160 data->t100_aux_vect) {
2161 input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
2165 input_set_drvdata(input_dev, data);
2167 error = input_register_device(input_dev);
2169 dev_err(dev, "Error %d registering input device\n", error);
2173 data->input_dev = input_dev;
2178 input_free_device(input_dev);
2182 static int mxt_configure_objects(struct mxt_data *data,
2183 const struct firmware *cfg);
2185 static void mxt_config_cb(const struct firmware *cfg, void *ctx)
2187 mxt_configure_objects(ctx, cfg);
2188 release_firmware(cfg);
2191 static int mxt_initialize(struct mxt_data *data)
2193 struct i2c_client *client = data->client;
2194 int recovery_attempts = 0;
2198 error = mxt_read_info_block(data);
2202 /* Check bootloader state */
2203 error = mxt_probe_bootloader(data, false);
2205 dev_info(&client->dev, "Trying alternate bootloader address\n");
2206 error = mxt_probe_bootloader(data, true);
2208 /* Chip is not in appmode or bootloader mode */
2213 /* OK, we are in bootloader, see if we can recover */
2214 if (++recovery_attempts > 1) {
2215 dev_err(&client->dev, "Could not recover from bootloader mode\n");
2217 * We can reflash from this state, so do not
2218 * abort initialization.
2220 data->in_bootloader = true;
2224 /* Attempt to exit bootloader into app mode */
2225 mxt_send_bootloader_cmd(data, false);
2226 msleep(MXT_FW_RESET_TIME);
2229 error = mxt_check_retrigen(data);
2233 error = mxt_acquire_irq(data);
2237 error = request_firmware_nowait(THIS_MODULE, true, MXT_CFG_NAME,
2238 &client->dev, GFP_KERNEL, data,
2241 dev_err(&client->dev, "Failed to invoke firmware loader: %d\n",
2249 static int mxt_set_t7_power_cfg(struct mxt_data *data, u8 sleep)
2251 struct device *dev = &data->client->dev;
2253 struct t7_config *new_config;
2254 struct t7_config deepsleep = { .active = 0, .idle = 0 };
2256 if (sleep == MXT_POWER_CFG_DEEPSLEEP)
2257 new_config = &deepsleep;
2259 new_config = &data->t7_cfg;
2261 error = __mxt_write_reg(data->client, data->T7_address,
2262 sizeof(data->t7_cfg), new_config);
2266 dev_dbg(dev, "Set T7 ACTV:%d IDLE:%d\n",
2267 new_config->active, new_config->idle);
2272 static int mxt_init_t7_power_cfg(struct mxt_data *data)
2274 struct device *dev = &data->client->dev;
2279 error = __mxt_read_reg(data->client, data->T7_address,
2280 sizeof(data->t7_cfg), &data->t7_cfg);
2284 if (data->t7_cfg.active == 0 || data->t7_cfg.idle == 0) {
2286 dev_dbg(dev, "T7 cfg zero, resetting\n");
2287 mxt_soft_reset(data);
2291 dev_dbg(dev, "T7 cfg zero after reset, overriding\n");
2292 data->t7_cfg.active = 20;
2293 data->t7_cfg.idle = 100;
2294 return mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
2298 dev_dbg(dev, "Initialized power cfg: ACTV %d, IDLE %d\n",
2299 data->t7_cfg.active, data->t7_cfg.idle);
2303 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
2304 static const struct v4l2_file_operations mxt_video_fops = {
2305 .owner = THIS_MODULE,
2306 .open = v4l2_fh_open,
2307 .release = vb2_fop_release,
2308 .unlocked_ioctl = video_ioctl2,
2309 .read = vb2_fop_read,
2310 .mmap = vb2_fop_mmap,
2311 .poll = vb2_fop_poll,
2314 static u16 mxt_get_debug_value(struct mxt_data *data, unsigned int x,
2317 struct mxt_info *info = data->info;
2318 struct mxt_dbg *dbg = &data->dbg;
2319 unsigned int ofs, page;
2320 unsigned int col = 0;
2321 unsigned int col_width;
2323 if (info->family_id == MXT_FAMILY_1386) {
2324 col_width = info->matrix_ysize / MXT1386_COLUMNS;
2325 col = y / col_width;
2328 col_width = info->matrix_ysize;
2331 ofs = (y + (x * col_width)) * sizeof(u16);
2332 page = ofs / MXT_DIAGNOSTIC_SIZE;
2333 ofs %= MXT_DIAGNOSTIC_SIZE;
2335 if (info->family_id == MXT_FAMILY_1386)
2336 page += col * MXT1386_PAGES_PER_COLUMN;
2338 return get_unaligned_le16(&dbg->t37_buf[page].data[ofs]);
2341 static int mxt_convert_debug_pages(struct mxt_data *data, u16 *outbuf)
2343 struct mxt_dbg *dbg = &data->dbg;
2346 unsigned int i, rx, ry;
2348 for (i = 0; i < dbg->t37_nodes; i++) {
2349 /* Handle orientation */
2350 rx = data->xy_switch ? y : x;
2351 ry = data->xy_switch ? x : y;
2352 rx = data->invertx ? (data->xsize - 1 - rx) : rx;
2353 ry = data->inverty ? (data->ysize - 1 - ry) : ry;
2355 outbuf[i] = mxt_get_debug_value(data, rx, ry);
2358 if (++x >= (data->xy_switch ? data->ysize : data->xsize)) {
2367 static int mxt_read_diagnostic_debug(struct mxt_data *data, u8 mode,
2370 struct mxt_dbg *dbg = &data->dbg;
2375 struct t37_debug *p;
2378 for (page = 0; page < dbg->t37_pages; page++) {
2379 p = dbg->t37_buf + page;
2381 ret = mxt_write_reg(data->client, dbg->diag_cmd_address,
2389 /* Read back command byte */
2390 ret = __mxt_read_reg(data->client, dbg->diag_cmd_address,
2391 sizeof(cmd_poll), &cmd_poll);
2395 /* Field is cleared once the command has been processed */
2397 if (retries++ > 100)
2405 ret = __mxt_read_reg(data->client, dbg->t37_address,
2406 sizeof(struct t37_debug), p);
2410 if (p->mode != mode || p->page != page) {
2411 dev_err(&data->client->dev, "T37 page mismatch\n");
2415 dev_dbg(&data->client->dev, "%s page:%d retries:%d\n",
2416 __func__, page, retries);
2418 /* For remaining pages, write PAGEUP rather than mode */
2419 cmd = MXT_DIAGNOSTIC_PAGEUP;
2422 return mxt_convert_debug_pages(data, outbuf);
2425 static int mxt_queue_setup(struct vb2_queue *q,
2426 unsigned int *nbuffers, unsigned int *nplanes,
2427 unsigned int sizes[], struct device *alloc_devs[])
2429 struct mxt_data *data = q->drv_priv;
2430 size_t size = data->dbg.t37_nodes * sizeof(u16);
2433 return sizes[0] < size ? -EINVAL : 0;
2441 static void mxt_buffer_queue(struct vb2_buffer *vb)
2443 struct mxt_data *data = vb2_get_drv_priv(vb->vb2_queue);
2448 ptr = vb2_plane_vaddr(vb, 0);
2450 dev_err(&data->client->dev, "Error acquiring frame ptr\n");
2454 switch (data->dbg.input) {
2455 case MXT_V4L_INPUT_DELTAS:
2457 mode = MXT_DIAGNOSTIC_DELTAS;
2460 case MXT_V4L_INPUT_REFS:
2461 mode = MXT_DIAGNOSTIC_REFS;
2465 ret = mxt_read_diagnostic_debug(data, mode, ptr);
2469 vb2_set_plane_payload(vb, 0, data->dbg.t37_nodes * sizeof(u16));
2470 vb2_buffer_done(vb, VB2_BUF_STATE_DONE);
2474 vb2_buffer_done(vb, VB2_BUF_STATE_ERROR);
2477 /* V4L2 structures */
2478 static const struct vb2_ops mxt_queue_ops = {
2479 .queue_setup = mxt_queue_setup,
2480 .buf_queue = mxt_buffer_queue,
2481 .wait_prepare = vb2_ops_wait_prepare,
2482 .wait_finish = vb2_ops_wait_finish,
2485 static const struct vb2_queue mxt_queue = {
2486 .type = V4L2_BUF_TYPE_VIDEO_CAPTURE,
2487 .io_modes = VB2_MMAP | VB2_USERPTR | VB2_DMABUF | VB2_READ,
2488 .buf_struct_size = sizeof(struct mxt_vb2_buffer),
2489 .ops = &mxt_queue_ops,
2490 .mem_ops = &vb2_vmalloc_memops,
2491 .timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC,
2492 .min_buffers_needed = 1,
2495 static int mxt_vidioc_querycap(struct file *file, void *priv,
2496 struct v4l2_capability *cap)
2498 struct mxt_data *data = video_drvdata(file);
2500 strlcpy(cap->driver, "atmel_mxt_ts", sizeof(cap->driver));
2501 strlcpy(cap->card, "atmel_mxt_ts touch", sizeof(cap->card));
2502 snprintf(cap->bus_info, sizeof(cap->bus_info),
2503 "I2C:%s", dev_name(&data->client->dev));
2507 static int mxt_vidioc_enum_input(struct file *file, void *priv,
2508 struct v4l2_input *i)
2510 if (i->index >= MXT_V4L_INPUT_MAX)
2513 i->type = V4L2_INPUT_TYPE_TOUCH;
2516 case MXT_V4L_INPUT_REFS:
2517 strlcpy(i->name, "Mutual Capacitance References",
2520 case MXT_V4L_INPUT_DELTAS:
2521 strlcpy(i->name, "Mutual Capacitance Deltas", sizeof(i->name));
2528 static int mxt_set_input(struct mxt_data *data, unsigned int i)
2530 struct v4l2_pix_format *f = &data->dbg.format;
2532 if (i >= MXT_V4L_INPUT_MAX)
2535 if (i == MXT_V4L_INPUT_DELTAS)
2536 f->pixelformat = V4L2_TCH_FMT_DELTA_TD16;
2538 f->pixelformat = V4L2_TCH_FMT_TU16;
2540 f->width = data->xy_switch ? data->ysize : data->xsize;
2541 f->height = data->xy_switch ? data->xsize : data->ysize;
2542 f->field = V4L2_FIELD_NONE;
2543 f->colorspace = V4L2_COLORSPACE_RAW;
2544 f->bytesperline = f->width * sizeof(u16);
2545 f->sizeimage = f->width * f->height * sizeof(u16);
2547 data->dbg.input = i;
2552 static int mxt_vidioc_s_input(struct file *file, void *priv, unsigned int i)
2554 return mxt_set_input(video_drvdata(file), i);
2557 static int mxt_vidioc_g_input(struct file *file, void *priv, unsigned int *i)
2559 struct mxt_data *data = video_drvdata(file);
2561 *i = data->dbg.input;
2566 static int mxt_vidioc_fmt(struct file *file, void *priv, struct v4l2_format *f)
2568 struct mxt_data *data = video_drvdata(file);
2570 f->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
2571 f->fmt.pix = data->dbg.format;
2576 static int mxt_vidioc_enum_fmt(struct file *file, void *priv,
2577 struct v4l2_fmtdesc *fmt)
2579 if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
2582 switch (fmt->index) {
2584 fmt->pixelformat = V4L2_TCH_FMT_TU16;
2588 fmt->pixelformat = V4L2_TCH_FMT_DELTA_TD16;
2598 static int mxt_vidioc_g_parm(struct file *file, void *fh,
2599 struct v4l2_streamparm *a)
2601 if (a->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
2604 a->parm.capture.readbuffers = 1;
2605 a->parm.capture.timeperframe.numerator = 1;
2606 a->parm.capture.timeperframe.denominator = 10;
2610 static const struct v4l2_ioctl_ops mxt_video_ioctl_ops = {
2611 .vidioc_querycap = mxt_vidioc_querycap,
2613 .vidioc_enum_fmt_vid_cap = mxt_vidioc_enum_fmt,
2614 .vidioc_s_fmt_vid_cap = mxt_vidioc_fmt,
2615 .vidioc_g_fmt_vid_cap = mxt_vidioc_fmt,
2616 .vidioc_try_fmt_vid_cap = mxt_vidioc_fmt,
2617 .vidioc_g_parm = mxt_vidioc_g_parm,
2619 .vidioc_enum_input = mxt_vidioc_enum_input,
2620 .vidioc_g_input = mxt_vidioc_g_input,
2621 .vidioc_s_input = mxt_vidioc_s_input,
2623 .vidioc_reqbufs = vb2_ioctl_reqbufs,
2624 .vidioc_create_bufs = vb2_ioctl_create_bufs,
2625 .vidioc_querybuf = vb2_ioctl_querybuf,
2626 .vidioc_qbuf = vb2_ioctl_qbuf,
2627 .vidioc_dqbuf = vb2_ioctl_dqbuf,
2628 .vidioc_expbuf = vb2_ioctl_expbuf,
2630 .vidioc_streamon = vb2_ioctl_streamon,
2631 .vidioc_streamoff = vb2_ioctl_streamoff,
2634 static const struct video_device mxt_video_device = {
2635 .name = "Atmel maxTouch",
2636 .fops = &mxt_video_fops,
2637 .ioctl_ops = &mxt_video_ioctl_ops,
2638 .release = video_device_release_empty,
2639 .device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_TOUCH |
2640 V4L2_CAP_READWRITE | V4L2_CAP_STREAMING,
2643 static void mxt_debug_init(struct mxt_data *data)
2645 struct mxt_info *info = data->info;
2646 struct mxt_dbg *dbg = &data->dbg;
2647 struct mxt_object *object;
2650 object = mxt_get_object(data, MXT_GEN_COMMAND_T6);
2654 dbg->diag_cmd_address = object->start_address + MXT_COMMAND_DIAGNOSTIC;
2656 object = mxt_get_object(data, MXT_DEBUG_DIAGNOSTIC_T37);
2660 if (mxt_obj_size(object) != sizeof(struct t37_debug)) {
2661 dev_warn(&data->client->dev, "Bad T37 size");
2665 dbg->t37_address = object->start_address;
2667 /* Calculate size of data and allocate buffer */
2668 dbg->t37_nodes = data->xsize * data->ysize;
2670 if (info->family_id == MXT_FAMILY_1386)
2671 dbg->t37_pages = MXT1386_COLUMNS * MXT1386_PAGES_PER_COLUMN;
2673 dbg->t37_pages = DIV_ROUND_UP(data->xsize *
2674 info->matrix_ysize *
2676 sizeof(dbg->t37_buf->data));
2678 dbg->t37_buf = devm_kmalloc_array(&data->client->dev, dbg->t37_pages,
2679 sizeof(struct t37_debug), GFP_KERNEL);
2683 /* init channel to zero */
2684 mxt_set_input(data, 0);
2686 /* register video device */
2687 snprintf(dbg->v4l2.name, sizeof(dbg->v4l2.name), "%s", "atmel_mxt_ts");
2688 error = v4l2_device_register(&data->client->dev, &dbg->v4l2);
2692 /* initialize the queue */
2693 mutex_init(&dbg->lock);
2694 dbg->queue = mxt_queue;
2695 dbg->queue.drv_priv = data;
2696 dbg->queue.lock = &dbg->lock;
2697 dbg->queue.dev = &data->client->dev;
2699 error = vb2_queue_init(&dbg->queue);
2701 goto error_unreg_v4l2;
2703 dbg->vdev = mxt_video_device;
2704 dbg->vdev.v4l2_dev = &dbg->v4l2;
2705 dbg->vdev.lock = &dbg->lock;
2706 dbg->vdev.vfl_dir = VFL_DIR_RX;
2707 dbg->vdev.queue = &dbg->queue;
2708 video_set_drvdata(&dbg->vdev, data);
2710 error = video_register_device(&dbg->vdev, VFL_TYPE_TOUCH, -1);
2712 goto error_unreg_v4l2;
2717 v4l2_device_unregister(&dbg->v4l2);
2719 dev_warn(&data->client->dev, "Error initializing T37\n");
2722 static void mxt_debug_init(struct mxt_data *data)
2727 static int mxt_configure_objects(struct mxt_data *data,
2728 const struct firmware *cfg)
2730 struct device *dev = &data->client->dev;
2733 error = mxt_init_t7_power_cfg(data);
2735 dev_err(dev, "Failed to initialize power cfg\n");
2740 error = mxt_update_cfg(data, cfg);
2742 dev_warn(dev, "Error %d updating config\n", error);
2745 if (data->multitouch) {
2746 error = mxt_initialize_input_device(data);
2750 dev_warn(dev, "No touch object detected\n");
2753 mxt_debug_init(data);
2758 /* Firmware Version is returned as Major.Minor.Build */
2759 static ssize_t mxt_fw_version_show(struct device *dev,
2760 struct device_attribute *attr, char *buf)
2762 struct mxt_data *data = dev_get_drvdata(dev);
2763 struct mxt_info *info = data->info;
2764 return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
2765 info->version >> 4, info->version & 0xf, info->build);
2768 /* Hardware Version is returned as FamilyID.VariantID */
2769 static ssize_t mxt_hw_version_show(struct device *dev,
2770 struct device_attribute *attr, char *buf)
2772 struct mxt_data *data = dev_get_drvdata(dev);
2773 struct mxt_info *info = data->info;
2774 return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
2775 info->family_id, info->variant_id);
2778 static ssize_t mxt_show_instance(char *buf, int count,
2779 struct mxt_object *object, int instance,
2784 if (mxt_obj_instances(object) > 1)
2785 count += scnprintf(buf + count, PAGE_SIZE - count,
2786 "Instance %u\n", instance);
2788 for (i = 0; i < mxt_obj_size(object); i++)
2789 count += scnprintf(buf + count, PAGE_SIZE - count,
2790 "\t[%2u]: %02x (%d)\n", i, val[i], val[i]);
2791 count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
2796 static ssize_t mxt_object_show(struct device *dev,
2797 struct device_attribute *attr, char *buf)
2799 struct mxt_data *data = dev_get_drvdata(dev);
2800 struct mxt_object *object;
2806 /* Pre-allocate buffer large enough to hold max sized object. */
2807 obuf = kmalloc(256, GFP_KERNEL);
2812 for (i = 0; i < data->info->object_num; i++) {
2813 object = data->object_table + i;
2815 if (!mxt_object_readable(object->type))
2818 count += scnprintf(buf + count, PAGE_SIZE - count,
2819 "T%u:\n", object->type);
2821 for (j = 0; j < mxt_obj_instances(object); j++) {
2822 u16 size = mxt_obj_size(object);
2823 u16 addr = object->start_address + j * size;
2825 error = __mxt_read_reg(data->client, addr, size, obuf);
2829 count = mxt_show_instance(buf, count, object, j, obuf);
2835 return error ?: count;
2838 static int mxt_check_firmware_format(struct device *dev,
2839 const struct firmware *fw)
2841 unsigned int pos = 0;
2844 while (pos < fw->size) {
2845 c = *(fw->data + pos);
2847 if (c < '0' || (c > '9' && c < 'A') || c > 'F')
2854 * To convert file try:
2855 * xxd -r -p mXTXXX__APP_VX-X-XX.enc > maxtouch.fw
2857 dev_err(dev, "Aborting: firmware file must be in binary format\n");
2862 static int mxt_load_fw(struct device *dev, const char *fn)
2864 struct mxt_data *data = dev_get_drvdata(dev);
2865 const struct firmware *fw = NULL;
2866 unsigned int frame_size;
2867 unsigned int pos = 0;
2868 unsigned int retry = 0;
2869 unsigned int frame = 0;
2872 ret = request_firmware(&fw, fn, dev);
2874 dev_err(dev, "Unable to open firmware %s\n", fn);
2878 /* Check for incorrect enc file */
2879 ret = mxt_check_firmware_format(dev, fw);
2881 goto release_firmware;
2883 if (!data->in_bootloader) {
2884 /* Change to the bootloader mode */
2885 data->in_bootloader = true;
2887 ret = mxt_t6_command(data, MXT_COMMAND_RESET,
2888 MXT_BOOT_VALUE, false);
2890 goto release_firmware;
2892 msleep(MXT_RESET_TIME);
2894 /* Do not need to scan since we know family ID */
2895 ret = mxt_lookup_bootloader_address(data, 0);
2897 goto release_firmware;
2899 mxt_free_input_device(data);
2900 mxt_free_object_table(data);
2902 enable_irq(data->irq);
2905 reinit_completion(&data->bl_completion);
2907 ret = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD, false);
2909 /* Bootloader may still be unlocked from previous attempt */
2910 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, false);
2914 dev_info(dev, "Unlocking bootloader\n");
2916 /* Unlock bootloader */
2917 ret = mxt_send_bootloader_cmd(data, true);
2922 while (pos < fw->size) {
2923 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, true);
2927 frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
2929 /* Take account of CRC bytes */
2932 /* Write one frame to device */
2933 ret = mxt_bootloader_write(data, fw->data + pos, frame_size);
2937 ret = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS, true);
2941 /* Back off by 20ms per retry */
2945 dev_err(dev, "Retry count exceeded\n");
2954 if (frame % 50 == 0)
2955 dev_dbg(dev, "Sent %d frames, %d/%zd bytes\n",
2956 frame, pos, fw->size);
2959 /* Wait for flash. */
2960 ret = mxt_wait_for_completion(data, &data->bl_completion,
2965 dev_dbg(dev, "Sent %d frames, %d bytes\n", frame, pos);
2968 * Wait for device to reset. Some bootloader versions do not assert
2969 * the CHG line after bootloading has finished, so ignore potential
2972 mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME);
2974 data->in_bootloader = false;
2977 disable_irq(data->irq);
2979 release_firmware(fw);
2983 static ssize_t mxt_update_fw_store(struct device *dev,
2984 struct device_attribute *attr,
2985 const char *buf, size_t count)
2987 struct mxt_data *data = dev_get_drvdata(dev);
2990 error = mxt_load_fw(dev, MXT_FW_NAME);
2992 dev_err(dev, "The firmware update failed(%d)\n", error);
2995 dev_info(dev, "The firmware update succeeded\n");
2997 error = mxt_initialize(data);
3005 static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
3006 static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
3007 static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
3008 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
3010 static struct attribute *mxt_attrs[] = {
3011 &dev_attr_fw_version.attr,
3012 &dev_attr_hw_version.attr,
3013 &dev_attr_object.attr,
3014 &dev_attr_update_fw.attr,
3018 static const struct attribute_group mxt_attr_group = {
3022 static void mxt_start(struct mxt_data *data)
3024 mxt_wakeup_toggle(data->client, true, false);
3026 switch (data->suspend_mode) {
3027 case MXT_SUSPEND_T9_CTRL:
3028 mxt_soft_reset(data);
3031 /* 0x83 = SCANEN | RPTEN | ENABLE */
3032 mxt_write_object(data,
3033 MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0x83);
3036 case MXT_SUSPEND_DEEP_SLEEP:
3038 mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
3040 /* Recalibrate since chip has been in deep sleep */
3041 mxt_t6_command(data, MXT_COMMAND_CALIBRATE, 1, false);
3046 static void mxt_stop(struct mxt_data *data)
3048 switch (data->suspend_mode) {
3049 case MXT_SUSPEND_T9_CTRL:
3051 mxt_write_object(data,
3052 MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0);
3055 case MXT_SUSPEND_DEEP_SLEEP:
3057 mxt_set_t7_power_cfg(data, MXT_POWER_CFG_DEEPSLEEP);
3061 mxt_wakeup_toggle(data->client, false, false);
3064 static int mxt_input_open(struct input_dev *dev)
3066 struct mxt_data *data = input_get_drvdata(dev);
3073 static void mxt_input_close(struct input_dev *dev)
3075 struct mxt_data *data = input_get_drvdata(dev);
3080 static int mxt_parse_device_properties(struct mxt_data *data)
3082 static const char keymap_property[] = "linux,gpio-keymap";
3083 struct device *dev = &data->client->dev;
3088 if (device_property_present(dev, keymap_property)) {
3089 n_keys = device_property_count_u32(dev, keymap_property);
3091 error = n_keys < 0 ? n_keys : -EINVAL;
3092 dev_err(dev, "invalid/malformed '%s' property: %d\n",
3093 keymap_property, error);
3097 keymap = devm_kmalloc_array(dev, n_keys, sizeof(*keymap),
3102 error = device_property_read_u32_array(dev, keymap_property,
3105 dev_err(dev, "failed to parse '%s' property: %d\n",
3106 keymap_property, error);
3110 data->t19_keymap = keymap;
3111 data->t19_num_keys = n_keys;
3117 static const struct dmi_system_id chromebook_T9_suspend_dmi[] = {
3120 DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
3121 DMI_MATCH(DMI_PRODUCT_NAME, "Link"),
3126 DMI_MATCH(DMI_PRODUCT_NAME, "Peppy"),
3132 static int mxt_probe(struct i2c_client *client, const struct i2c_device_id *id)
3134 struct mxt_data *data;
3138 * Ignore devices that do not have device properties attached to
3139 * them, as we need help determining whether we are dealing with
3140 * touch screen or touchpad.
3142 * So far on x86 the only users of Atmel touch controllers are
3143 * Chromebooks, and chromeos_laptop driver will ensure that
3144 * necessary properties are provided (if firmware does not do that).
3146 if (!device_property_present(&client->dev, "compatible"))
3150 * Ignore ACPI devices representing bootloader mode.
3152 * This is a bit of a hack: Google Chromebook BIOS creates ACPI
3153 * devices for both application and bootloader modes, but we are
3154 * interested in application mode only (if device is in bootloader
3155 * mode we'll end up switching into application anyway). So far
3156 * application mode addresses were all above 0x40, so we'll use it
3159 if (ACPI_COMPANION(&client->dev) && client->addr < 0x40)
3162 data = devm_kzalloc(&client->dev, sizeof(struct mxt_data), GFP_KERNEL);
3166 snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
3167 client->adapter->nr, client->addr);
3169 data->client = client;
3170 data->irq = client->irq;
3171 i2c_set_clientdata(client, data);
3173 init_completion(&data->bl_completion);
3174 init_completion(&data->reset_completion);
3175 init_completion(&data->crc_completion);
3177 data->suspend_mode = dmi_check_system(chromebook_T9_suspend_dmi) ?
3178 MXT_SUSPEND_T9_CTRL : MXT_SUSPEND_DEEP_SLEEP;
3180 error = mxt_parse_device_properties(data);
3185 * VDDA is the analog voltage supply 2.57..3.47 V
3186 * VDD is the digital voltage supply 1.71..3.47 V
3188 data->regulators[0].supply = "vdda";
3189 data->regulators[1].supply = "vdd";
3190 error = devm_regulator_bulk_get(&client->dev, ARRAY_SIZE(data->regulators),
3193 if (error != -EPROBE_DEFER)
3194 dev_err(&client->dev, "Failed to get regulators %d\n",
3199 /* Request the RESET line as asserted so we go into reset */
3200 data->reset_gpio = devm_gpiod_get_optional(&client->dev,
3201 "reset", GPIOD_OUT_HIGH);
3202 if (IS_ERR(data->reset_gpio)) {
3203 error = PTR_ERR(data->reset_gpio);
3204 dev_err(&client->dev, "Failed to get reset gpio: %d\n", error);
3208 /* Request the WAKE line as asserted so we go out of sleep */
3209 data->wake_gpio = devm_gpiod_get_optional(&client->dev,
3210 "wake", GPIOD_OUT_HIGH);
3211 if (IS_ERR(data->wake_gpio)) {
3212 error = PTR_ERR(data->wake_gpio);
3213 dev_err(&client->dev, "Failed to get wake gpio: %d\n", error);
3217 error = devm_request_threaded_irq(&client->dev, client->irq,
3218 NULL, mxt_interrupt,
3219 IRQF_ONESHOT | IRQF_NO_AUTOEN,
3220 client->name, data);
3222 dev_err(&client->dev, "Failed to register interrupt\n");
3226 error = regulator_bulk_enable(ARRAY_SIZE(data->regulators),
3229 dev_err(&client->dev, "failed to enable regulators: %d\n",
3234 * The device takes 40ms to come up after power-on according
3235 * to the mXT224 datasheet, page 13.
3237 msleep(MXT_BACKUP_TIME);
3239 if (data->reset_gpio) {
3240 /* Wait a while and then de-assert the RESET GPIO line */
3241 msleep(MXT_RESET_GPIO_TIME);
3242 gpiod_set_value(data->reset_gpio, 0);
3243 msleep(MXT_RESET_INVALID_CHG);
3247 * Controllers like mXT1386 have a dedicated WAKE line that could be
3248 * connected to a GPIO or to I2C SCL pin, or permanently asserted low.
3250 * This WAKE line is used for waking controller from a deep-sleep and
3251 * it needs to be asserted low for 25 milliseconds before I2C transfers
3252 * could be accepted by controller if it was in a deep-sleep mode.
3253 * Controller will go into sleep automatically after 2 seconds of
3254 * inactivity if WAKE line is deasserted and deep sleep is activated.
3256 * If WAKE line is connected to I2C SCL pin, then the first I2C transfer
3257 * will get an instant NAK and transfer needs to be retried after 25ms.
3259 * If WAKE line is connected to a GPIO line, the line must be asserted
3260 * 25ms before the host attempts to communicate with the controller.
3262 device_property_read_u32(&client->dev, "atmel,wakeup-method",
3263 &data->wakeup_method);
3265 error = mxt_initialize(data);
3267 goto err_disable_regulators;
3269 error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
3271 dev_err(&client->dev, "Failure %d creating sysfs group\n",
3273 goto err_free_object;
3279 mxt_free_input_device(data);
3280 mxt_free_object_table(data);
3281 err_disable_regulators:
3282 regulator_bulk_disable(ARRAY_SIZE(data->regulators),
3287 static int mxt_remove(struct i2c_client *client)
3289 struct mxt_data *data = i2c_get_clientdata(client);
3291 disable_irq(data->irq);
3292 sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
3293 mxt_free_input_device(data);
3294 mxt_free_object_table(data);
3295 regulator_bulk_disable(ARRAY_SIZE(data->regulators),
3301 static int __maybe_unused mxt_suspend(struct device *dev)
3303 struct i2c_client *client = to_i2c_client(dev);
3304 struct mxt_data *data = i2c_get_clientdata(client);
3305 struct input_dev *input_dev = data->input_dev;
3310 mutex_lock(&input_dev->mutex);
3312 if (input_device_enabled(input_dev))
3315 mutex_unlock(&input_dev->mutex);
3317 disable_irq(data->irq);
3322 static int __maybe_unused mxt_resume(struct device *dev)
3324 struct i2c_client *client = to_i2c_client(dev);
3325 struct mxt_data *data = i2c_get_clientdata(client);
3326 struct input_dev *input_dev = data->input_dev;
3331 enable_irq(data->irq);
3333 mutex_lock(&input_dev->mutex);
3335 if (input_device_enabled(input_dev))
3338 mutex_unlock(&input_dev->mutex);
3343 static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);
3345 static const struct of_device_id mxt_of_match[] = {
3346 { .compatible = "atmel,maxtouch", },
3347 /* Compatibles listed below are deprecated */
3348 { .compatible = "atmel,qt602240_ts", },
3349 { .compatible = "atmel,atmel_mxt_ts", },
3350 { .compatible = "atmel,atmel_mxt_tp", },
3351 { .compatible = "atmel,mXT224", },
3354 MODULE_DEVICE_TABLE(of, mxt_of_match);
3357 static const struct acpi_device_id mxt_acpi_id[] = {
3358 { "ATML0000", 0 }, /* Touchpad */
3359 { "ATML0001", 0 }, /* Touchscreen */
3362 MODULE_DEVICE_TABLE(acpi, mxt_acpi_id);
3365 static const struct i2c_device_id mxt_id[] = {
3366 { "qt602240_ts", 0 },
3367 { "atmel_mxt_ts", 0 },
3368 { "atmel_mxt_tp", 0 },
3373 MODULE_DEVICE_TABLE(i2c, mxt_id);
3375 static struct i2c_driver mxt_driver = {
3377 .name = "atmel_mxt_ts",
3378 .of_match_table = mxt_of_match,
3379 .acpi_match_table = ACPI_PTR(mxt_acpi_id),
3383 .remove = mxt_remove,
3387 module_i2c_driver(mxt_driver);
3389 /* Module information */
3391 MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
3392 MODULE_LICENSE("GPL");