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
10 * Author: Joonyoung Shim <jy0922.shim@samsung.com>
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>
24 #include <linux/property.h>
25 #include <linux/slab.h>
26 #include <linux/gpio/consumer.h>
27 #include <asm/unaligned.h>
28 #include <media/v4l2-device.h>
29 #include <media/v4l2-ioctl.h>
30 #include <media/videobuf2-v4l2.h>
31 #include <media/videobuf2-vmalloc.h>
34 #define MXT_FW_NAME "maxtouch.fw"
35 #define MXT_CFG_NAME "maxtouch.cfg"
36 #define MXT_CFG_MAGIC "OBP_RAW V1"
39 #define MXT_OBJECT_START 0x07
40 #define MXT_OBJECT_SIZE 6
41 #define MXT_INFO_CHECKSUM_SIZE 3
42 #define MXT_MAX_BLOCK_WRITE 256
45 #define MXT_DEBUG_DIAGNOSTIC_T37 37
46 #define MXT_GEN_MESSAGE_T5 5
47 #define MXT_GEN_COMMAND_T6 6
48 #define MXT_GEN_POWER_T7 7
49 #define MXT_GEN_ACQUIRE_T8 8
50 #define MXT_GEN_DATASOURCE_T53 53
51 #define MXT_TOUCH_MULTI_T9 9
52 #define MXT_TOUCH_KEYARRAY_T15 15
53 #define MXT_TOUCH_PROXIMITY_T23 23
54 #define MXT_TOUCH_PROXKEY_T52 52
55 #define MXT_PROCI_GRIPFACE_T20 20
56 #define MXT_PROCG_NOISE_T22 22
57 #define MXT_PROCI_ONETOUCH_T24 24
58 #define MXT_PROCI_TWOTOUCH_T27 27
59 #define MXT_PROCI_GRIP_T40 40
60 #define MXT_PROCI_PALM_T41 41
61 #define MXT_PROCI_TOUCHSUPPRESSION_T42 42
62 #define MXT_PROCI_STYLUS_T47 47
63 #define MXT_PROCG_NOISESUPPRESSION_T48 48
64 #define MXT_SPT_COMMSCONFIG_T18 18
65 #define MXT_SPT_GPIOPWM_T19 19
66 #define MXT_SPT_SELFTEST_T25 25
67 #define MXT_SPT_CTECONFIG_T28 28
68 #define MXT_SPT_USERDATA_T38 38
69 #define MXT_SPT_DIGITIZER_T43 43
70 #define MXT_SPT_MESSAGECOUNT_T44 44
71 #define MXT_SPT_CTECONFIG_T46 46
72 #define MXT_SPT_DYNAMICCONFIGURATIONCONTAINER_T71 71
73 #define MXT_TOUCH_MULTITOUCHSCREEN_T100 100
75 /* MXT_GEN_MESSAGE_T5 object */
76 #define MXT_RPTID_NOMSG 0xff
78 /* MXT_GEN_COMMAND_T6 field */
79 #define MXT_COMMAND_RESET 0
80 #define MXT_COMMAND_BACKUPNV 1
81 #define MXT_COMMAND_CALIBRATE 2
82 #define MXT_COMMAND_REPORTALL 3
83 #define MXT_COMMAND_DIAGNOSTIC 5
85 /* Define for T6 status byte */
86 #define MXT_T6_STATUS_RESET BIT(7)
87 #define MXT_T6_STATUS_OFL BIT(6)
88 #define MXT_T6_STATUS_SIGERR BIT(5)
89 #define MXT_T6_STATUS_CAL BIT(4)
90 #define MXT_T6_STATUS_CFGERR BIT(3)
91 #define MXT_T6_STATUS_COMSERR BIT(2)
93 /* MXT_GEN_POWER_T7 field */
99 #define MXT_POWER_CFG_RUN 0
100 #define MXT_POWER_CFG_DEEPSLEEP 1
102 /* MXT_TOUCH_MULTI_T9 field */
103 #define MXT_T9_CTRL 0
104 #define MXT_T9_XSIZE 3
105 #define MXT_T9_YSIZE 4
106 #define MXT_T9_ORIENT 9
107 #define MXT_T9_RANGE 18
109 /* MXT_TOUCH_MULTI_T9 status */
110 #define MXT_T9_UNGRIP BIT(0)
111 #define MXT_T9_SUPPRESS BIT(1)
112 #define MXT_T9_AMP BIT(2)
113 #define MXT_T9_VECTOR BIT(3)
114 #define MXT_T9_MOVE BIT(4)
115 #define MXT_T9_RELEASE BIT(5)
116 #define MXT_T9_PRESS BIT(6)
117 #define MXT_T9_DETECT BIT(7)
124 /* MXT_TOUCH_MULTI_T9 orient */
125 #define MXT_T9_ORIENT_SWITCH BIT(0)
126 #define MXT_T9_ORIENT_INVERTX BIT(1)
127 #define MXT_T9_ORIENT_INVERTY BIT(2)
129 /* MXT_SPT_COMMSCONFIG_T18 */
130 #define MXT_COMMS_CTRL 0
131 #define MXT_COMMS_CMD 1
133 /* MXT_DEBUG_DIAGNOSTIC_T37 */
134 #define MXT_DIAGNOSTIC_PAGEUP 0x01
135 #define MXT_DIAGNOSTIC_DELTAS 0x10
136 #define MXT_DIAGNOSTIC_REFS 0x11
137 #define MXT_DIAGNOSTIC_SIZE 128
139 #define MXT_FAMILY_1386 160
140 #define MXT1386_COLUMNS 3
141 #define MXT1386_PAGES_PER_COLUMN 8
144 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
147 u8 data[MXT_DIAGNOSTIC_SIZE];
151 /* Define for MXT_GEN_COMMAND_T6 */
152 #define MXT_BOOT_VALUE 0xa5
153 #define MXT_RESET_VALUE 0x01
154 #define MXT_BACKUP_VALUE 0x55
156 /* T100 Multiple Touch Touchscreen */
157 #define MXT_T100_CTRL 0
158 #define MXT_T100_CFG1 1
159 #define MXT_T100_TCHAUX 3
160 #define MXT_T100_XSIZE 9
161 #define MXT_T100_XRANGE 13
162 #define MXT_T100_YSIZE 20
163 #define MXT_T100_YRANGE 24
165 #define MXT_T100_CFG_SWITCHXY BIT(5)
166 #define MXT_T100_CFG_INVERTY BIT(6)
167 #define MXT_T100_CFG_INVERTX BIT(7)
169 #define MXT_T100_TCHAUX_VECT BIT(0)
170 #define MXT_T100_TCHAUX_AMPL BIT(1)
171 #define MXT_T100_TCHAUX_AREA BIT(2)
173 #define MXT_T100_DETECT BIT(7)
174 #define MXT_T100_TYPE_MASK 0x70
177 MXT_T100_TYPE_FINGER = 1,
178 MXT_T100_TYPE_PASSIVE_STYLUS = 2,
179 MXT_T100_TYPE_HOVERING_FINGER = 4,
180 MXT_T100_TYPE_GLOVE = 5,
181 MXT_T100_TYPE_LARGE_TOUCH = 6,
184 #define MXT_DISTANCE_ACTIVE_TOUCH 0
185 #define MXT_DISTANCE_HOVERING 1
187 #define MXT_TOUCH_MAJOR_DEFAULT 1
188 #define MXT_PRESSURE_DEFAULT 1
191 #define MXT_BACKUP_TIME 50 /* msec */
192 #define MXT_RESET_GPIO_TIME 20 /* msec */
193 #define MXT_RESET_INVALID_CHG 100 /* msec */
194 #define MXT_RESET_TIME 200 /* msec */
195 #define MXT_RESET_TIMEOUT 3000 /* msec */
196 #define MXT_CRC_TIMEOUT 1000 /* msec */
197 #define MXT_FW_RESET_TIME 3000 /* msec */
198 #define MXT_FW_CHG_TIMEOUT 300 /* msec */
200 /* Command to unlock bootloader */
201 #define MXT_UNLOCK_CMD_MSB 0xaa
202 #define MXT_UNLOCK_CMD_LSB 0xdc
204 /* Bootloader mode status */
205 #define MXT_WAITING_BOOTLOAD_CMD 0xc0 /* valid 7 6 bit only */
206 #define MXT_WAITING_FRAME_DATA 0x80 /* valid 7 6 bit only */
207 #define MXT_FRAME_CRC_CHECK 0x02
208 #define MXT_FRAME_CRC_FAIL 0x03
209 #define MXT_FRAME_CRC_PASS 0x04
210 #define MXT_APP_CRC_FAIL 0x40 /* valid 7 8 bit only */
211 #define MXT_BOOT_STATUS_MASK 0x3f
212 #define MXT_BOOT_EXTENDED_ID BIT(5)
213 #define MXT_BOOT_ID_MASK 0x1f
215 /* Touchscreen absolute values */
216 #define MXT_MAX_AREA 0xff
218 #define MXT_PIXELS_PER_MM 20
234 u8 instances_minus_one;
240 u16 diag_cmd_address;
241 struct t37_debug *t37_buf;
242 unsigned int t37_pages;
243 unsigned int t37_nodes;
245 struct v4l2_device v4l2;
246 struct v4l2_pix_format format;
247 struct video_device vdev;
248 struct vb2_queue queue;
253 enum v4l_dbg_inputs {
254 MXT_V4L_INPUT_DELTAS,
259 enum mxt_suspend_mode {
260 MXT_SUSPEND_DEEP_SLEEP = 0,
261 MXT_SUSPEND_T9_CTRL = 1,
264 /* Config update context */
274 struct mxt_info info;
277 /* Each client has this additional data */
279 struct i2c_client *client;
280 struct input_dev *input_dev;
281 char phys[64]; /* device physical location */
282 struct mxt_object *object_table;
283 struct mxt_info *info;
284 void *raw_info_block;
305 u8 last_message_count;
308 struct t7_config t7_cfg;
310 struct gpio_desc *reset_gpio;
312 /* Cached parameters from object table */
323 u8 T100_reportid_min;
324 u8 T100_reportid_max;
326 /* for fw update in bootloader */
327 struct completion bl_completion;
329 /* for reset handling */
330 struct completion reset_completion;
332 /* for config update handling */
333 struct completion crc_completion;
336 unsigned int t19_num_keys;
338 enum mxt_suspend_mode suspend_mode;
341 struct mxt_vb2_buffer {
342 struct vb2_buffer vb;
343 struct list_head list;
346 static size_t mxt_obj_size(const struct mxt_object *obj)
348 return obj->size_minus_one + 1;
351 static size_t mxt_obj_instances(const struct mxt_object *obj)
353 return obj->instances_minus_one + 1;
356 static bool mxt_object_readable(unsigned int type)
359 case MXT_GEN_COMMAND_T6:
360 case MXT_GEN_POWER_T7:
361 case MXT_GEN_ACQUIRE_T8:
362 case MXT_GEN_DATASOURCE_T53:
363 case MXT_TOUCH_MULTI_T9:
364 case MXT_TOUCH_KEYARRAY_T15:
365 case MXT_TOUCH_PROXIMITY_T23:
366 case MXT_TOUCH_PROXKEY_T52:
367 case MXT_TOUCH_MULTITOUCHSCREEN_T100:
368 case MXT_PROCI_GRIPFACE_T20:
369 case MXT_PROCG_NOISE_T22:
370 case MXT_PROCI_ONETOUCH_T24:
371 case MXT_PROCI_TWOTOUCH_T27:
372 case MXT_PROCI_GRIP_T40:
373 case MXT_PROCI_PALM_T41:
374 case MXT_PROCI_TOUCHSUPPRESSION_T42:
375 case MXT_PROCI_STYLUS_T47:
376 case MXT_PROCG_NOISESUPPRESSION_T48:
377 case MXT_SPT_COMMSCONFIG_T18:
378 case MXT_SPT_GPIOPWM_T19:
379 case MXT_SPT_SELFTEST_T25:
380 case MXT_SPT_CTECONFIG_T28:
381 case MXT_SPT_USERDATA_T38:
382 case MXT_SPT_DIGITIZER_T43:
383 case MXT_SPT_CTECONFIG_T46:
384 case MXT_SPT_DYNAMICCONFIGURATIONCONTAINER_T71:
391 static void mxt_dump_message(struct mxt_data *data, u8 *message)
393 dev_dbg(&data->client->dev, "message: %*ph\n",
394 data->T5_msg_size, message);
397 static int mxt_wait_for_completion(struct mxt_data *data,
398 struct completion *comp,
399 unsigned int timeout_ms)
401 struct device *dev = &data->client->dev;
402 unsigned long timeout = msecs_to_jiffies(timeout_ms);
405 ret = wait_for_completion_interruptible_timeout(comp, timeout);
408 } else if (ret == 0) {
409 dev_err(dev, "Wait for completion timed out.\n");
415 static int mxt_bootloader_read(struct mxt_data *data,
416 u8 *val, unsigned int count)
421 msg.addr = data->bootloader_addr;
422 msg.flags = data->client->flags & I2C_M_TEN;
423 msg.flags |= I2C_M_RD;
427 ret = i2c_transfer(data->client->adapter, &msg, 1);
431 ret = ret < 0 ? ret : -EIO;
432 dev_err(&data->client->dev, "%s: i2c recv failed (%d)\n",
439 static int mxt_bootloader_write(struct mxt_data *data,
440 const u8 * const val, unsigned int count)
445 msg.addr = data->bootloader_addr;
446 msg.flags = data->client->flags & I2C_M_TEN;
450 ret = i2c_transfer(data->client->adapter, &msg, 1);
454 ret = ret < 0 ? ret : -EIO;
455 dev_err(&data->client->dev, "%s: i2c send failed (%d)\n",
462 static int mxt_lookup_bootloader_address(struct mxt_data *data, bool retry)
464 u8 appmode = data->client->addr;
466 u8 family_id = data->info ? data->info->family_id : 0;
471 /* Chips after 1664S use different scheme */
472 if (retry || family_id >= 0xa2) {
473 bootloader = appmode - 0x24;
476 /* Fall through - for normal case */
481 bootloader = appmode - 0x26;
485 dev_err(&data->client->dev,
486 "Appmode i2c address 0x%02x not found\n",
491 data->bootloader_addr = bootloader;
495 static int mxt_probe_bootloader(struct mxt_data *data, bool alt_address)
497 struct device *dev = &data->client->dev;
502 error = mxt_lookup_bootloader_address(data, alt_address);
506 error = mxt_bootloader_read(data, &val, 1);
510 /* Check app crc fail mode */
511 crc_failure = (val & ~MXT_BOOT_STATUS_MASK) == MXT_APP_CRC_FAIL;
513 dev_err(dev, "Detected bootloader, status:%02X%s\n",
514 val, crc_failure ? ", APP_CRC_FAIL" : "");
519 static u8 mxt_get_bootloader_version(struct mxt_data *data, u8 val)
521 struct device *dev = &data->client->dev;
524 if (val & MXT_BOOT_EXTENDED_ID) {
525 if (mxt_bootloader_read(data, &buf[0], 3) != 0) {
526 dev_err(dev, "%s: i2c failure\n", __func__);
530 dev_dbg(dev, "Bootloader ID:%d Version:%d\n", buf[1], buf[2]);
534 dev_dbg(dev, "Bootloader ID:%d\n", val & MXT_BOOT_ID_MASK);
540 static int mxt_check_bootloader(struct mxt_data *data, unsigned int state,
543 struct device *dev = &data->client->dev;
550 * In application update mode, the interrupt
551 * line signals state transitions. We must wait for the
552 * CHG assertion before reading the status byte.
553 * Once the status byte has been read, the line is deasserted.
555 ret = mxt_wait_for_completion(data, &data->bl_completion,
559 * TODO: handle -ERESTARTSYS better by terminating
560 * fw update process before returning to userspace
561 * by writing length 0x000 to device (iff we are in
562 * WAITING_FRAME_DATA state).
564 dev_err(dev, "Update wait error %d\n", ret);
569 ret = mxt_bootloader_read(data, &val, 1);
573 if (state == MXT_WAITING_BOOTLOAD_CMD)
574 val = mxt_get_bootloader_version(data, val);
577 case MXT_WAITING_BOOTLOAD_CMD:
578 case MXT_WAITING_FRAME_DATA:
579 case MXT_APP_CRC_FAIL:
580 val &= ~MXT_BOOT_STATUS_MASK;
582 case MXT_FRAME_CRC_PASS:
583 if (val == MXT_FRAME_CRC_CHECK) {
585 } else if (val == MXT_FRAME_CRC_FAIL) {
586 dev_err(dev, "Bootloader CRC fail\n");
595 dev_err(dev, "Invalid bootloader state %02X != %02X\n",
603 static int mxt_send_bootloader_cmd(struct mxt_data *data, bool unlock)
609 buf[0] = MXT_UNLOCK_CMD_LSB;
610 buf[1] = MXT_UNLOCK_CMD_MSB;
616 ret = mxt_bootloader_write(data, buf, 2);
623 static int __mxt_read_reg(struct i2c_client *client,
624 u16 reg, u16 len, void *val)
626 struct i2c_msg xfer[2];
631 buf[1] = (reg >> 8) & 0xff;
634 xfer[0].addr = client->addr;
640 xfer[1].addr = client->addr;
641 xfer[1].flags = I2C_M_RD;
645 ret = i2c_transfer(client->adapter, xfer, 2);
651 dev_err(&client->dev, "%s: i2c transfer failed (%d)\n",
658 static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len,
666 buf = kmalloc(count, GFP_KERNEL);
671 buf[1] = (reg >> 8) & 0xff;
672 memcpy(&buf[2], val, len);
674 ret = i2c_master_send(client, buf, count);
680 dev_err(&client->dev, "%s: i2c send failed (%d)\n",
688 static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
690 return __mxt_write_reg(client, reg, 1, &val);
693 static struct mxt_object *
694 mxt_get_object(struct mxt_data *data, u8 type)
696 struct mxt_object *object;
699 for (i = 0; i < data->info->object_num; i++) {
700 object = data->object_table + i;
701 if (object->type == type)
705 dev_warn(&data->client->dev, "Invalid object type T%u\n", type);
709 static void mxt_proc_t6_messages(struct mxt_data *data, u8 *msg)
711 struct device *dev = &data->client->dev;
713 u32 crc = msg[2] | (msg[3] << 8) | (msg[4] << 16);
715 if (crc != data->config_crc) {
716 data->config_crc = crc;
717 dev_dbg(dev, "T6 Config Checksum: 0x%06X\n", crc);
720 complete(&data->crc_completion);
723 if (status & MXT_T6_STATUS_RESET)
724 complete(&data->reset_completion);
726 /* Output debug if status has changed */
727 if (status != data->t6_status)
728 dev_dbg(dev, "T6 Status 0x%02X%s%s%s%s%s%s%s\n",
730 status == 0 ? " OK" : "",
731 status & MXT_T6_STATUS_RESET ? " RESET" : "",
732 status & MXT_T6_STATUS_OFL ? " OFL" : "",
733 status & MXT_T6_STATUS_SIGERR ? " SIGERR" : "",
734 status & MXT_T6_STATUS_CAL ? " CAL" : "",
735 status & MXT_T6_STATUS_CFGERR ? " CFGERR" : "",
736 status & MXT_T6_STATUS_COMSERR ? " COMSERR" : "");
738 /* Save current status */
739 data->t6_status = status;
742 static int mxt_write_object(struct mxt_data *data,
743 u8 type, u8 offset, u8 val)
745 struct mxt_object *object;
748 object = mxt_get_object(data, type);
749 if (!object || offset >= mxt_obj_size(object))
752 reg = object->start_address;
753 return mxt_write_reg(data->client, reg + offset, val);
756 static void mxt_input_button(struct mxt_data *data, u8 *message)
758 struct input_dev *input = data->input_dev;
761 for (i = 0; i < data->t19_num_keys; i++) {
762 if (data->t19_keymap[i] == KEY_RESERVED)
765 /* Active-low switch */
766 input_report_key(input, data->t19_keymap[i],
767 !(message[1] & BIT(i)));
771 static void mxt_input_sync(struct mxt_data *data)
773 input_mt_report_pointer_emulation(data->input_dev,
775 input_sync(data->input_dev);
778 static void mxt_proc_t9_message(struct mxt_data *data, u8 *message)
780 struct device *dev = &data->client->dev;
781 struct input_dev *input_dev = data->input_dev;
789 id = message[0] - data->T9_reportid_min;
791 x = (message[2] << 4) | ((message[4] >> 4) & 0xf);
792 y = (message[3] << 4) | ((message[4] & 0xf));
794 /* Handle 10/12 bit switching */
795 if (data->max_x < 1024)
797 if (data->max_y < 1024)
801 amplitude = message[6];
804 "[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
806 (status & MXT_T9_DETECT) ? 'D' : '.',
807 (status & MXT_T9_PRESS) ? 'P' : '.',
808 (status & MXT_T9_RELEASE) ? 'R' : '.',
809 (status & MXT_T9_MOVE) ? 'M' : '.',
810 (status & MXT_T9_VECTOR) ? 'V' : '.',
811 (status & MXT_T9_AMP) ? 'A' : '.',
812 (status & MXT_T9_SUPPRESS) ? 'S' : '.',
813 (status & MXT_T9_UNGRIP) ? 'U' : '.',
814 x, y, area, amplitude);
816 input_mt_slot(input_dev, id);
818 if (status & MXT_T9_DETECT) {
820 * Multiple bits may be set if the host is slow to read
821 * the status messages, indicating all the events that
824 if (status & MXT_T9_RELEASE) {
825 input_mt_report_slot_state(input_dev,
827 mxt_input_sync(data);
830 /* if active, pressure must be non-zero */
832 amplitude = MXT_PRESSURE_DEFAULT;
835 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 1);
836 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
837 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
838 input_report_abs(input_dev, ABS_MT_PRESSURE, amplitude);
839 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
841 /* Touch no longer active, close out slot */
842 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 0);
845 data->update_input = true;
848 static void mxt_proc_t100_message(struct mxt_data *data, u8 *message)
850 struct device *dev = &data->client->dev;
851 struct input_dev *input_dev = data->input_dev;
863 id = message[0] - data->T100_reportid_min - 2;
865 /* ignore SCRSTATUS events */
870 x = get_unaligned_le16(&message[2]);
871 y = get_unaligned_le16(&message[4]);
873 if (status & MXT_T100_DETECT) {
874 type = (status & MXT_T100_TYPE_MASK) >> 4;
877 case MXT_T100_TYPE_HOVERING_FINGER:
878 tool = MT_TOOL_FINGER;
879 distance = MXT_DISTANCE_HOVERING;
881 if (data->t100_aux_vect)
882 orientation = message[data->t100_aux_vect];
886 case MXT_T100_TYPE_FINGER:
887 case MXT_T100_TYPE_GLOVE:
888 tool = MT_TOOL_FINGER;
889 distance = MXT_DISTANCE_ACTIVE_TOUCH;
891 if (data->t100_aux_area)
892 major = message[data->t100_aux_area];
894 if (data->t100_aux_ampl)
895 pressure = message[data->t100_aux_ampl];
897 if (data->t100_aux_vect)
898 orientation = message[data->t100_aux_vect];
902 case MXT_T100_TYPE_PASSIVE_STYLUS:
906 * Passive stylus is reported with size zero so
909 major = MXT_TOUCH_MAJOR_DEFAULT;
911 if (data->t100_aux_ampl)
912 pressure = message[data->t100_aux_ampl];
916 case MXT_T100_TYPE_LARGE_TOUCH:
917 /* Ignore suppressed touch */
921 dev_dbg(dev, "Unexpected T100 type\n");
927 * Values reported should be non-zero if tool is touching the
930 if (!pressure && type != MXT_T100_TYPE_HOVERING_FINGER)
931 pressure = MXT_PRESSURE_DEFAULT;
933 input_mt_slot(input_dev, id);
935 if (status & MXT_T100_DETECT) {
936 dev_dbg(dev, "[%u] type:%u x:%u y:%u a:%02X p:%02X v:%02X\n",
937 id, type, x, y, major, pressure, orientation);
939 input_mt_report_slot_state(input_dev, tool, 1);
940 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
941 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
942 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, major);
943 input_report_abs(input_dev, ABS_MT_PRESSURE, pressure);
944 input_report_abs(input_dev, ABS_MT_DISTANCE, distance);
945 input_report_abs(input_dev, ABS_MT_ORIENTATION, orientation);
947 dev_dbg(dev, "[%u] release\n", id);
950 input_mt_report_slot_state(input_dev, 0, 0);
953 data->update_input = true;
956 static int mxt_proc_message(struct mxt_data *data, u8 *message)
958 u8 report_id = message[0];
960 if (report_id == MXT_RPTID_NOMSG)
963 if (report_id == data->T6_reportid) {
964 mxt_proc_t6_messages(data, message);
965 } else if (!data->input_dev) {
967 * Do not report events if input device
968 * is not yet registered.
970 mxt_dump_message(data, message);
971 } else if (report_id >= data->T9_reportid_min &&
972 report_id <= data->T9_reportid_max) {
973 mxt_proc_t9_message(data, message);
974 } else if (report_id >= data->T100_reportid_min &&
975 report_id <= data->T100_reportid_max) {
976 mxt_proc_t100_message(data, message);
977 } else if (report_id == data->T19_reportid) {
978 mxt_input_button(data, message);
979 data->update_input = true;
981 mxt_dump_message(data, message);
987 static int mxt_read_and_process_messages(struct mxt_data *data, u8 count)
989 struct device *dev = &data->client->dev;
994 /* Safety check for msg_buf */
995 if (count > data->max_reportid)
998 /* Process remaining messages if necessary */
999 ret = __mxt_read_reg(data->client, data->T5_address,
1000 data->T5_msg_size * count, data->msg_buf);
1002 dev_err(dev, "Failed to read %u messages (%d)\n", count, ret);
1006 for (i = 0; i < count; i++) {
1007 ret = mxt_proc_message(data,
1008 data->msg_buf + data->T5_msg_size * i);
1014 /* return number of messages read */
1018 static irqreturn_t mxt_process_messages_t44(struct mxt_data *data)
1020 struct device *dev = &data->client->dev;
1024 /* Read T44 and T5 together */
1025 ret = __mxt_read_reg(data->client, data->T44_address,
1026 data->T5_msg_size + 1, data->msg_buf);
1028 dev_err(dev, "Failed to read T44 and T5 (%d)\n", ret);
1032 count = data->msg_buf[0];
1035 * This condition may be caused by the CHG line being configured in
1036 * Mode 0. It results in unnecessary I2C operations but it is benign.
1041 if (count > data->max_reportid) {
1042 dev_warn(dev, "T44 count %d exceeded max report id\n", count);
1043 count = data->max_reportid;
1046 /* Process first message */
1047 ret = mxt_proc_message(data, data->msg_buf + 1);
1049 dev_warn(dev, "Unexpected invalid message\n");
1053 num_left = count - 1;
1055 /* Process remaining messages if necessary */
1057 ret = mxt_read_and_process_messages(data, num_left);
1060 else if (ret != num_left)
1061 dev_warn(dev, "Unexpected invalid message\n");
1065 if (data->update_input) {
1066 mxt_input_sync(data);
1067 data->update_input = false;
1073 static int mxt_process_messages_until_invalid(struct mxt_data *data)
1075 struct device *dev = &data->client->dev;
1079 count = data->max_reportid;
1081 /* Read messages until we force an invalid */
1083 read = mxt_read_and_process_messages(data, count);
1088 if (data->update_input) {
1089 mxt_input_sync(data);
1090 data->update_input = false;
1093 dev_err(dev, "CHG pin isn't cleared\n");
1097 static irqreturn_t mxt_process_messages(struct mxt_data *data)
1099 int total_handled, num_handled;
1100 u8 count = data->last_message_count;
1102 if (count < 1 || count > data->max_reportid)
1105 /* include final invalid message */
1106 total_handled = mxt_read_and_process_messages(data, count + 1);
1107 if (total_handled < 0)
1109 /* if there were invalid messages, then we are done */
1110 else if (total_handled <= count)
1113 /* keep reading two msgs until one is invalid or reportid limit */
1115 num_handled = mxt_read_and_process_messages(data, 2);
1116 if (num_handled < 0)
1119 total_handled += num_handled;
1121 if (num_handled < 2)
1123 } while (total_handled < data->num_touchids);
1126 data->last_message_count = total_handled;
1128 if (data->update_input) {
1129 mxt_input_sync(data);
1130 data->update_input = false;
1136 static irqreturn_t mxt_interrupt(int irq, void *dev_id)
1138 struct mxt_data *data = dev_id;
1140 if (data->in_bootloader) {
1141 /* bootloader state transition completion */
1142 complete(&data->bl_completion);
1146 if (!data->object_table)
1149 if (data->T44_address) {
1150 return mxt_process_messages_t44(data);
1152 return mxt_process_messages(data);
1156 static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset,
1157 u8 value, bool wait)
1160 u8 command_register;
1161 int timeout_counter = 0;
1164 reg = data->T6_address + cmd_offset;
1166 ret = mxt_write_reg(data->client, reg, value);
1175 ret = __mxt_read_reg(data->client, reg, 1, &command_register);
1178 } while (command_register != 0 && timeout_counter++ <= 100);
1180 if (timeout_counter > 100) {
1181 dev_err(&data->client->dev, "Command failed!\n");
1188 static int mxt_acquire_irq(struct mxt_data *data)
1192 enable_irq(data->irq);
1194 error = mxt_process_messages_until_invalid(data);
1201 static int mxt_soft_reset(struct mxt_data *data)
1203 struct device *dev = &data->client->dev;
1206 dev_info(dev, "Resetting device\n");
1208 disable_irq(data->irq);
1210 reinit_completion(&data->reset_completion);
1212 ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false);
1216 /* Ignore CHG line for 100ms after reset */
1217 msleep(MXT_RESET_INVALID_CHG);
1219 mxt_acquire_irq(data);
1221 ret = mxt_wait_for_completion(data, &data->reset_completion,
1229 static void mxt_update_crc(struct mxt_data *data, u8 cmd, u8 value)
1232 * On failure, CRC is set to 0 and config will always be
1235 data->config_crc = 0;
1236 reinit_completion(&data->crc_completion);
1238 mxt_t6_command(data, cmd, value, true);
1241 * Wait for crc message. On failure, CRC is set to 0 and config will
1242 * always be downloaded.
1244 mxt_wait_for_completion(data, &data->crc_completion, MXT_CRC_TIMEOUT);
1247 static void mxt_calc_crc24(u32 *crc, u8 firstbyte, u8 secondbyte)
1249 static const unsigned int crcpoly = 0x80001B;
1253 data_word = (secondbyte << 8) | firstbyte;
1254 result = ((*crc << 1) ^ data_word);
1256 if (result & 0x1000000)
1262 static u32 mxt_calculate_crc(u8 *base, off_t start_off, off_t end_off)
1265 u8 *ptr = base + start_off;
1266 u8 *last_val = base + end_off - 1;
1268 if (end_off < start_off)
1271 while (ptr < last_val) {
1272 mxt_calc_crc24(&crc, *ptr, *(ptr + 1));
1276 /* if len is odd, fill the last byte with 0 */
1277 if (ptr == last_val)
1278 mxt_calc_crc24(&crc, *ptr, 0);
1280 /* Mask to 24-bit */
1286 static int mxt_prepare_cfg_mem(struct mxt_data *data, struct mxt_cfg *cfg)
1288 struct device *dev = &data->client->dev;
1289 struct mxt_object *object;
1290 unsigned int type, instance, size, byte_offset;
1297 while (cfg->raw_pos < cfg->raw_size) {
1298 /* Read type, instance, length */
1299 ret = sscanf(cfg->raw + cfg->raw_pos, "%x %x %x%n",
1300 &type, &instance, &size, &offset);
1304 } else if (ret != 3) {
1305 dev_err(dev, "Bad format: failed to parse object\n");
1308 cfg->raw_pos += offset;
1310 object = mxt_get_object(data, type);
1313 for (i = 0; i < size; i++) {
1314 ret = sscanf(cfg->raw + cfg->raw_pos, "%hhx%n",
1317 dev_err(dev, "Bad format in T%d at %d\n",
1321 cfg->raw_pos += offset;
1326 if (size > mxt_obj_size(object)) {
1328 * Either we are in fallback mode due to wrong
1329 * config or config from a later fw version,
1330 * or the file is corrupt or hand-edited.
1332 dev_warn(dev, "Discarding %zu byte(s) in T%u\n",
1333 size - mxt_obj_size(object), type);
1334 } else if (mxt_obj_size(object) > size) {
1336 * If firmware is upgraded, new bytes may be added to
1337 * end of objects. It is generally forward compatible
1338 * to zero these bytes - previous behaviour will be
1339 * retained. However this does invalidate the CRC and
1340 * will force fallback mode until the configuration is
1341 * updated. We warn here but do nothing else - the
1342 * malloc has zeroed the entire configuration.
1344 dev_warn(dev, "Zeroing %zu byte(s) in T%d\n",
1345 mxt_obj_size(object) - size, type);
1348 if (instance >= mxt_obj_instances(object)) {
1349 dev_err(dev, "Object instances exceeded!\n");
1353 reg = object->start_address + mxt_obj_size(object) * instance;
1355 for (i = 0; i < size; i++) {
1356 ret = sscanf(cfg->raw + cfg->raw_pos, "%hhx%n",
1360 dev_err(dev, "Bad format in T%d at %d\n",
1364 cfg->raw_pos += offset;
1366 if (i > mxt_obj_size(object))
1369 byte_offset = reg + i - cfg->start_ofs;
1371 if (byte_offset >= 0 && byte_offset < cfg->mem_size) {
1372 *(cfg->mem + byte_offset) = val;
1374 dev_err(dev, "Bad object: reg:%d, T%d, ofs=%d\n",
1375 reg, object->type, byte_offset);
1384 static int mxt_upload_cfg_mem(struct mxt_data *data, struct mxt_cfg *cfg)
1386 unsigned int byte_offset = 0;
1389 /* Write configuration as blocks */
1390 while (byte_offset < cfg->mem_size) {
1391 unsigned int size = cfg->mem_size - byte_offset;
1393 if (size > MXT_MAX_BLOCK_WRITE)
1394 size = MXT_MAX_BLOCK_WRITE;
1396 error = __mxt_write_reg(data->client,
1397 cfg->start_ofs + byte_offset,
1398 size, cfg->mem + byte_offset);
1400 dev_err(&data->client->dev,
1401 "Config write error, ret=%d\n", error);
1405 byte_offset += size;
1411 static int mxt_init_t7_power_cfg(struct mxt_data *data);
1414 * mxt_update_cfg - download configuration to chip
1416 * Atmel Raw Config File Format
1418 * The first four lines of the raw config file contain:
1420 * 2) Chip ID Information (first 7 bytes of device memory)
1421 * 3) Chip Information Block 24-bit CRC Checksum
1422 * 4) Chip Configuration 24-bit CRC Checksum
1424 * The rest of the file consists of one line per object instance:
1425 * <TYPE> <INSTANCE> <SIZE> <CONTENTS>
1427 * <TYPE> - 2-byte object type as hex
1428 * <INSTANCE> - 2-byte object instance number as hex
1429 * <SIZE> - 2-byte object size as hex
1430 * <CONTENTS> - array of <SIZE> 1-byte hex values
1432 static int mxt_update_cfg(struct mxt_data *data, const struct firmware *fw)
1434 struct device *dev = &data->client->dev;
1439 u32 info_crc, config_crc, calculated_crc;
1442 /* Make zero terminated copy of the OBP_RAW file */
1443 cfg.raw = kmemdup_nul(fw->data, fw->size, GFP_KERNEL);
1447 cfg.raw_size = fw->size;
1449 mxt_update_crc(data, MXT_COMMAND_REPORTALL, 1);
1451 if (strncmp(cfg.raw, MXT_CFG_MAGIC, strlen(MXT_CFG_MAGIC))) {
1452 dev_err(dev, "Unrecognised config file\n");
1457 cfg.raw_pos = strlen(MXT_CFG_MAGIC);
1459 /* Load information block and check */
1460 for (i = 0; i < sizeof(struct mxt_info); i++) {
1461 ret = sscanf(cfg.raw + cfg.raw_pos, "%hhx%n",
1462 (unsigned char *)&cfg.info + i,
1465 dev_err(dev, "Bad format\n");
1470 cfg.raw_pos += offset;
1473 if (cfg.info.family_id != data->info->family_id) {
1474 dev_err(dev, "Family ID mismatch!\n");
1479 if (cfg.info.variant_id != data->info->variant_id) {
1480 dev_err(dev, "Variant ID mismatch!\n");
1486 ret = sscanf(cfg.raw + cfg.raw_pos, "%x%n", &info_crc, &offset);
1488 dev_err(dev, "Bad format: failed to parse Info CRC\n");
1492 cfg.raw_pos += offset;
1494 ret = sscanf(cfg.raw + cfg.raw_pos, "%x%n", &config_crc, &offset);
1496 dev_err(dev, "Bad format: failed to parse Config CRC\n");
1500 cfg.raw_pos += offset;
1503 * The Info Block CRC is calculated over mxt_info and the object
1504 * table. If it does not match then we are trying to load the
1505 * configuration from a different chip or firmware version, so
1506 * the configuration CRC is invalid anyway.
1508 if (info_crc == data->info_crc) {
1509 if (config_crc == 0 || data->config_crc == 0) {
1510 dev_info(dev, "CRC zero, attempting to apply config\n");
1511 } else if (config_crc == data->config_crc) {
1512 dev_dbg(dev, "Config CRC 0x%06X: OK\n",
1516 dev_info(dev, "Config CRC 0x%06X: does not match file 0x%06X\n",
1517 data->config_crc, config_crc);
1521 "Warning: Info CRC error - device=0x%06X file=0x%06X\n",
1522 data->info_crc, info_crc);
1525 /* Malloc memory to store configuration */
1526 cfg.start_ofs = MXT_OBJECT_START +
1527 data->info->object_num * sizeof(struct mxt_object) +
1528 MXT_INFO_CHECKSUM_SIZE;
1529 cfg.mem_size = data->mem_size - cfg.start_ofs;
1530 cfg.mem = kzalloc(cfg.mem_size, GFP_KERNEL);
1536 ret = mxt_prepare_cfg_mem(data, &cfg);
1540 /* Calculate crc of the received configs (not the raw config file) */
1541 if (data->T71_address)
1542 crc_start = data->T71_address;
1543 else if (data->T7_address)
1544 crc_start = data->T7_address;
1546 dev_warn(dev, "Could not find CRC start\n");
1548 if (crc_start > cfg.start_ofs) {
1549 calculated_crc = mxt_calculate_crc(cfg.mem,
1550 crc_start - cfg.start_ofs,
1553 if (config_crc > 0 && config_crc != calculated_crc)
1554 dev_warn(dev, "Config CRC in file inconsistent, calculated=%06X, file=%06X\n",
1555 calculated_crc, config_crc);
1558 ret = mxt_upload_cfg_mem(data, &cfg);
1562 mxt_update_crc(data, MXT_COMMAND_BACKUPNV, MXT_BACKUP_VALUE);
1564 ret = mxt_soft_reset(data);
1568 dev_info(dev, "Config successfully updated\n");
1570 /* T7 config may have changed */
1571 mxt_init_t7_power_cfg(data);
1580 static void mxt_free_input_device(struct mxt_data *data)
1582 if (data->input_dev) {
1583 input_unregister_device(data->input_dev);
1584 data->input_dev = NULL;
1588 static void mxt_free_object_table(struct mxt_data *data)
1590 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
1591 video_unregister_device(&data->dbg.vdev);
1592 v4l2_device_unregister(&data->dbg.v4l2);
1594 data->object_table = NULL;
1596 kfree(data->raw_info_block);
1597 data->raw_info_block = NULL;
1598 kfree(data->msg_buf);
1599 data->msg_buf = NULL;
1600 data->T5_address = 0;
1601 data->T5_msg_size = 0;
1602 data->T6_reportid = 0;
1603 data->T7_address = 0;
1604 data->T71_address = 0;
1605 data->T9_reportid_min = 0;
1606 data->T9_reportid_max = 0;
1607 data->T19_reportid = 0;
1608 data->T44_address = 0;
1609 data->T100_reportid_min = 0;
1610 data->T100_reportid_max = 0;
1611 data->max_reportid = 0;
1614 static int mxt_parse_object_table(struct mxt_data *data,
1615 struct mxt_object *object_table)
1617 struct i2c_client *client = data->client;
1622 /* Valid Report IDs start counting from 1 */
1625 for (i = 0; i < data->info->object_num; i++) {
1626 struct mxt_object *object = object_table + i;
1629 le16_to_cpus(&object->start_address);
1631 if (object->num_report_ids) {
1633 reportid += object->num_report_ids *
1634 mxt_obj_instances(object);
1635 max_id = reportid - 1;
1641 dev_dbg(&data->client->dev,
1642 "T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n",
1643 object->type, object->start_address,
1644 mxt_obj_size(object), mxt_obj_instances(object),
1647 switch (object->type) {
1648 case MXT_GEN_MESSAGE_T5:
1649 if (data->info->family_id == 0x80 &&
1650 data->info->version < 0x20) {
1652 * On mXT224 firmware versions prior to V2.0
1653 * read and discard unused CRC byte otherwise
1654 * DMA reads are misaligned.
1656 data->T5_msg_size = mxt_obj_size(object);
1658 /* CRC not enabled, so skip last byte */
1659 data->T5_msg_size = mxt_obj_size(object) - 1;
1661 data->T5_address = object->start_address;
1663 case MXT_GEN_COMMAND_T6:
1664 data->T6_reportid = min_id;
1665 data->T6_address = object->start_address;
1667 case MXT_GEN_POWER_T7:
1668 data->T7_address = object->start_address;
1670 case MXT_SPT_DYNAMICCONFIGURATIONCONTAINER_T71:
1671 data->T71_address = object->start_address;
1673 case MXT_TOUCH_MULTI_T9:
1674 data->multitouch = MXT_TOUCH_MULTI_T9;
1675 /* Only handle messages from first T9 instance */
1676 data->T9_reportid_min = min_id;
1677 data->T9_reportid_max = min_id +
1678 object->num_report_ids - 1;
1679 data->num_touchids = object->num_report_ids;
1681 case MXT_SPT_MESSAGECOUNT_T44:
1682 data->T44_address = object->start_address;
1684 case MXT_SPT_GPIOPWM_T19:
1685 data->T19_reportid = min_id;
1687 case MXT_TOUCH_MULTITOUCHSCREEN_T100:
1688 data->multitouch = MXT_TOUCH_MULTITOUCHSCREEN_T100;
1689 data->T100_reportid_min = min_id;
1690 data->T100_reportid_max = max_id;
1691 /* first two report IDs reserved */
1692 data->num_touchids = object->num_report_ids - 2;
1696 end_address = object->start_address
1697 + mxt_obj_size(object) * mxt_obj_instances(object) - 1;
1699 if (end_address >= data->mem_size)
1700 data->mem_size = end_address + 1;
1703 /* Store maximum reportid */
1704 data->max_reportid = reportid;
1706 /* If T44 exists, T5 position has to be directly after */
1707 if (data->T44_address && (data->T5_address != data->T44_address + 1)) {
1708 dev_err(&client->dev, "Invalid T44 position\n");
1712 data->msg_buf = kcalloc(data->max_reportid,
1713 data->T5_msg_size, GFP_KERNEL);
1720 static int mxt_read_info_block(struct mxt_data *data)
1722 struct i2c_client *client = data->client;
1726 uint8_t num_objects;
1730 /* If info block already allocated, free it */
1731 if (data->raw_info_block)
1732 mxt_free_object_table(data);
1734 /* Read 7-byte ID information block starting at address 0 */
1735 size = sizeof(struct mxt_info);
1736 id_buf = kzalloc(size, GFP_KERNEL);
1740 error = __mxt_read_reg(client, 0, size, id_buf);
1744 /* Resize buffer to give space for rest of info block */
1745 num_objects = ((struct mxt_info *)id_buf)->object_num;
1746 size += (num_objects * sizeof(struct mxt_object))
1747 + MXT_INFO_CHECKSUM_SIZE;
1749 buf = krealloc(id_buf, size, GFP_KERNEL);
1756 /* Read rest of info block */
1757 error = __mxt_read_reg(client, MXT_OBJECT_START,
1758 size - MXT_OBJECT_START,
1759 id_buf + MXT_OBJECT_START);
1763 /* Extract & calculate checksum */
1764 crc_ptr = id_buf + size - MXT_INFO_CHECKSUM_SIZE;
1765 data->info_crc = crc_ptr[0] | (crc_ptr[1] << 8) | (crc_ptr[2] << 16);
1767 calculated_crc = mxt_calculate_crc(id_buf, 0,
1768 size - MXT_INFO_CHECKSUM_SIZE);
1771 * CRC mismatch can be caused by data corruption due to I2C comms
1772 * issue or else device is not using Object Based Protocol (eg i2c-hid)
1774 if ((data->info_crc == 0) || (data->info_crc != calculated_crc)) {
1775 dev_err(&client->dev,
1776 "Info Block CRC error calculated=0x%06X read=0x%06X\n",
1777 calculated_crc, data->info_crc);
1782 data->raw_info_block = id_buf;
1783 data->info = (struct mxt_info *)id_buf;
1785 dev_info(&client->dev,
1786 "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n",
1787 data->info->family_id, data->info->variant_id,
1788 data->info->version >> 4, data->info->version & 0xf,
1789 data->info->build, data->info->object_num);
1791 /* Parse object table information */
1792 error = mxt_parse_object_table(data, id_buf + MXT_OBJECT_START);
1794 dev_err(&client->dev, "Error %d parsing object table\n", error);
1795 mxt_free_object_table(data);
1799 data->object_table = (struct mxt_object *)(id_buf + MXT_OBJECT_START);
1808 static int mxt_read_t9_resolution(struct mxt_data *data)
1810 struct i2c_client *client = data->client;
1812 struct t9_range range;
1813 unsigned char orient;
1814 struct mxt_object *object;
1816 object = mxt_get_object(data, MXT_TOUCH_MULTI_T9);
1820 error = __mxt_read_reg(client,
1821 object->start_address + MXT_T9_XSIZE,
1822 sizeof(data->xsize), &data->xsize);
1826 error = __mxt_read_reg(client,
1827 object->start_address + MXT_T9_YSIZE,
1828 sizeof(data->ysize), &data->ysize);
1832 error = __mxt_read_reg(client,
1833 object->start_address + MXT_T9_RANGE,
1834 sizeof(range), &range);
1838 data->max_x = get_unaligned_le16(&range.x);
1839 data->max_y = get_unaligned_le16(&range.y);
1841 error = __mxt_read_reg(client,
1842 object->start_address + MXT_T9_ORIENT,
1847 data->xy_switch = orient & MXT_T9_ORIENT_SWITCH;
1848 data->invertx = orient & MXT_T9_ORIENT_INVERTX;
1849 data->inverty = orient & MXT_T9_ORIENT_INVERTY;
1854 static int mxt_read_t100_config(struct mxt_data *data)
1856 struct i2c_client *client = data->client;
1858 struct mxt_object *object;
1859 u16 range_x, range_y;
1863 object = mxt_get_object(data, MXT_TOUCH_MULTITOUCHSCREEN_T100);
1867 /* read touchscreen dimensions */
1868 error = __mxt_read_reg(client,
1869 object->start_address + MXT_T100_XRANGE,
1870 sizeof(range_x), &range_x);
1874 data->max_x = get_unaligned_le16(&range_x);
1876 error = __mxt_read_reg(client,
1877 object->start_address + MXT_T100_YRANGE,
1878 sizeof(range_y), &range_y);
1882 data->max_y = get_unaligned_le16(&range_y);
1884 error = __mxt_read_reg(client,
1885 object->start_address + MXT_T100_XSIZE,
1886 sizeof(data->xsize), &data->xsize);
1890 error = __mxt_read_reg(client,
1891 object->start_address + MXT_T100_YSIZE,
1892 sizeof(data->ysize), &data->ysize);
1896 /* read orientation config */
1897 error = __mxt_read_reg(client,
1898 object->start_address + MXT_T100_CFG1,
1903 data->xy_switch = cfg & MXT_T100_CFG_SWITCHXY;
1904 data->invertx = cfg & MXT_T100_CFG_INVERTX;
1905 data->inverty = cfg & MXT_T100_CFG_INVERTY;
1907 /* allocate aux bytes */
1908 error = __mxt_read_reg(client,
1909 object->start_address + MXT_T100_TCHAUX,
1916 if (tchaux & MXT_T100_TCHAUX_VECT)
1917 data->t100_aux_vect = aux++;
1919 if (tchaux & MXT_T100_TCHAUX_AMPL)
1920 data->t100_aux_ampl = aux++;
1922 if (tchaux & MXT_T100_TCHAUX_AREA)
1923 data->t100_aux_area = aux++;
1925 dev_dbg(&client->dev,
1926 "T100 aux mappings vect:%u ampl:%u area:%u\n",
1927 data->t100_aux_vect, data->t100_aux_ampl, data->t100_aux_area);
1932 static int mxt_input_open(struct input_dev *dev);
1933 static void mxt_input_close(struct input_dev *dev);
1935 static void mxt_set_up_as_touchpad(struct input_dev *input_dev,
1936 struct mxt_data *data)
1940 input_dev->name = "Atmel maXTouch Touchpad";
1942 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
1944 input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM);
1945 input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM);
1946 input_abs_set_res(input_dev, ABS_MT_POSITION_X,
1948 input_abs_set_res(input_dev, ABS_MT_POSITION_Y,
1951 for (i = 0; i < data->t19_num_keys; i++)
1952 if (data->t19_keymap[i] != KEY_RESERVED)
1953 input_set_capability(input_dev, EV_KEY,
1954 data->t19_keymap[i]);
1957 static int mxt_initialize_input_device(struct mxt_data *data)
1959 struct device *dev = &data->client->dev;
1960 struct input_dev *input_dev;
1962 unsigned int num_mt_slots;
1963 unsigned int mt_flags = 0;
1965 switch (data->multitouch) {
1966 case MXT_TOUCH_MULTI_T9:
1967 num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
1968 error = mxt_read_t9_resolution(data);
1970 dev_warn(dev, "Failed to initialize T9 resolution\n");
1973 case MXT_TOUCH_MULTITOUCHSCREEN_T100:
1974 num_mt_slots = data->num_touchids;
1975 error = mxt_read_t100_config(data);
1977 dev_warn(dev, "Failed to read T100 config\n");
1981 dev_err(dev, "Invalid multitouch object\n");
1985 /* Handle default values and orientation switch */
1986 if (data->max_x == 0)
1989 if (data->max_y == 0)
1992 if (data->xy_switch)
1993 swap(data->max_x, data->max_y);
1995 dev_info(dev, "Touchscreen size X%uY%u\n", data->max_x, data->max_y);
1997 /* Register input device */
1998 input_dev = input_allocate_device();
2002 input_dev->name = "Atmel maXTouch Touchscreen";
2003 input_dev->phys = data->phys;
2004 input_dev->id.bustype = BUS_I2C;
2005 input_dev->dev.parent = dev;
2006 input_dev->open = mxt_input_open;
2007 input_dev->close = mxt_input_close;
2009 input_set_capability(input_dev, EV_KEY, BTN_TOUCH);
2011 /* For single touch */
2012 input_set_abs_params(input_dev, ABS_X, 0, data->max_x, 0, 0);
2013 input_set_abs_params(input_dev, ABS_Y, 0, data->max_y, 0, 0);
2015 if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
2016 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2017 data->t100_aux_ampl)) {
2018 input_set_abs_params(input_dev, ABS_PRESSURE, 0, 255, 0, 0);
2021 /* If device has buttons we assume it is a touchpad */
2022 if (data->t19_num_keys) {
2023 mxt_set_up_as_touchpad(input_dev, data);
2024 mt_flags |= INPUT_MT_POINTER;
2026 mt_flags |= INPUT_MT_DIRECT;
2029 /* For multi touch */
2030 error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags);
2032 dev_err(dev, "Error %d initialising slots\n", error);
2036 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100) {
2037 input_set_abs_params(input_dev, ABS_MT_TOOL_TYPE,
2038 0, MT_TOOL_MAX, 0, 0);
2039 input_set_abs_params(input_dev, ABS_MT_DISTANCE,
2040 MXT_DISTANCE_ACTIVE_TOUCH,
2041 MXT_DISTANCE_HOVERING,
2045 input_set_abs_params(input_dev, ABS_MT_POSITION_X,
2046 0, data->max_x, 0, 0);
2047 input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
2048 0, data->max_y, 0, 0);
2050 if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
2051 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2052 data->t100_aux_area)) {
2053 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
2054 0, MXT_MAX_AREA, 0, 0);
2057 if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
2058 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2059 data->t100_aux_ampl)) {
2060 input_set_abs_params(input_dev, ABS_MT_PRESSURE,
2064 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2065 data->t100_aux_vect) {
2066 input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
2070 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2071 data->t100_aux_vect) {
2072 input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
2076 input_set_drvdata(input_dev, data);
2078 error = input_register_device(input_dev);
2080 dev_err(dev, "Error %d registering input device\n", error);
2084 data->input_dev = input_dev;
2089 input_free_device(input_dev);
2093 static int mxt_configure_objects(struct mxt_data *data,
2094 const struct firmware *cfg);
2096 static void mxt_config_cb(const struct firmware *cfg, void *ctx)
2098 mxt_configure_objects(ctx, cfg);
2099 release_firmware(cfg);
2102 static int mxt_initialize(struct mxt_data *data)
2104 struct i2c_client *client = data->client;
2105 int recovery_attempts = 0;
2109 error = mxt_read_info_block(data);
2113 /* Check bootloader state */
2114 error = mxt_probe_bootloader(data, false);
2116 dev_info(&client->dev, "Trying alternate bootloader address\n");
2117 error = mxt_probe_bootloader(data, true);
2119 /* Chip is not in appmode or bootloader mode */
2124 /* OK, we are in bootloader, see if we can recover */
2125 if (++recovery_attempts > 1) {
2126 dev_err(&client->dev, "Could not recover from bootloader mode\n");
2128 * We can reflash from this state, so do not
2129 * abort initialization.
2131 data->in_bootloader = true;
2135 /* Attempt to exit bootloader into app mode */
2136 mxt_send_bootloader_cmd(data, false);
2137 msleep(MXT_FW_RESET_TIME);
2140 error = mxt_acquire_irq(data);
2144 error = request_firmware_nowait(THIS_MODULE, true, MXT_CFG_NAME,
2145 &client->dev, GFP_KERNEL, data,
2148 dev_err(&client->dev, "Failed to invoke firmware loader: %d\n",
2156 static int mxt_set_t7_power_cfg(struct mxt_data *data, u8 sleep)
2158 struct device *dev = &data->client->dev;
2160 struct t7_config *new_config;
2161 struct t7_config deepsleep = { .active = 0, .idle = 0 };
2163 if (sleep == MXT_POWER_CFG_DEEPSLEEP)
2164 new_config = &deepsleep;
2166 new_config = &data->t7_cfg;
2168 error = __mxt_write_reg(data->client, data->T7_address,
2169 sizeof(data->t7_cfg), new_config);
2173 dev_dbg(dev, "Set T7 ACTV:%d IDLE:%d\n",
2174 new_config->active, new_config->idle);
2179 static int mxt_init_t7_power_cfg(struct mxt_data *data)
2181 struct device *dev = &data->client->dev;
2186 error = __mxt_read_reg(data->client, data->T7_address,
2187 sizeof(data->t7_cfg), &data->t7_cfg);
2191 if (data->t7_cfg.active == 0 || data->t7_cfg.idle == 0) {
2193 dev_dbg(dev, "T7 cfg zero, resetting\n");
2194 mxt_soft_reset(data);
2198 dev_dbg(dev, "T7 cfg zero after reset, overriding\n");
2199 data->t7_cfg.active = 20;
2200 data->t7_cfg.idle = 100;
2201 return mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
2205 dev_dbg(dev, "Initialized power cfg: ACTV %d, IDLE %d\n",
2206 data->t7_cfg.active, data->t7_cfg.idle);
2210 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
2211 static const struct v4l2_file_operations mxt_video_fops = {
2212 .owner = THIS_MODULE,
2213 .open = v4l2_fh_open,
2214 .release = vb2_fop_release,
2215 .unlocked_ioctl = video_ioctl2,
2216 .read = vb2_fop_read,
2217 .mmap = vb2_fop_mmap,
2218 .poll = vb2_fop_poll,
2221 static u16 mxt_get_debug_value(struct mxt_data *data, unsigned int x,
2224 struct mxt_info *info = data->info;
2225 struct mxt_dbg *dbg = &data->dbg;
2226 unsigned int ofs, page;
2227 unsigned int col = 0;
2228 unsigned int col_width;
2230 if (info->family_id == MXT_FAMILY_1386) {
2231 col_width = info->matrix_ysize / MXT1386_COLUMNS;
2232 col = y / col_width;
2235 col_width = info->matrix_ysize;
2238 ofs = (y + (x * col_width)) * sizeof(u16);
2239 page = ofs / MXT_DIAGNOSTIC_SIZE;
2240 ofs %= MXT_DIAGNOSTIC_SIZE;
2242 if (info->family_id == MXT_FAMILY_1386)
2243 page += col * MXT1386_PAGES_PER_COLUMN;
2245 return get_unaligned_le16(&dbg->t37_buf[page].data[ofs]);
2248 static int mxt_convert_debug_pages(struct mxt_data *data, u16 *outbuf)
2250 struct mxt_dbg *dbg = &data->dbg;
2253 unsigned int i, rx, ry;
2255 for (i = 0; i < dbg->t37_nodes; i++) {
2256 /* Handle orientation */
2257 rx = data->xy_switch ? y : x;
2258 ry = data->xy_switch ? x : y;
2259 rx = data->invertx ? (data->xsize - 1 - rx) : rx;
2260 ry = data->inverty ? (data->ysize - 1 - ry) : ry;
2262 outbuf[i] = mxt_get_debug_value(data, rx, ry);
2265 if (++x >= (data->xy_switch ? data->ysize : data->xsize)) {
2274 static int mxt_read_diagnostic_debug(struct mxt_data *data, u8 mode,
2277 struct mxt_dbg *dbg = &data->dbg;
2282 struct t37_debug *p;
2285 for (page = 0; page < dbg->t37_pages; page++) {
2286 p = dbg->t37_buf + page;
2288 ret = mxt_write_reg(data->client, dbg->diag_cmd_address,
2296 /* Read back command byte */
2297 ret = __mxt_read_reg(data->client, dbg->diag_cmd_address,
2298 sizeof(cmd_poll), &cmd_poll);
2302 /* Field is cleared once the command has been processed */
2304 if (retries++ > 100)
2312 ret = __mxt_read_reg(data->client, dbg->t37_address,
2313 sizeof(struct t37_debug), p);
2317 if (p->mode != mode || p->page != page) {
2318 dev_err(&data->client->dev, "T37 page mismatch\n");
2322 dev_dbg(&data->client->dev, "%s page:%d retries:%d\n",
2323 __func__, page, retries);
2325 /* For remaining pages, write PAGEUP rather than mode */
2326 cmd = MXT_DIAGNOSTIC_PAGEUP;
2329 return mxt_convert_debug_pages(data, outbuf);
2332 static int mxt_queue_setup(struct vb2_queue *q,
2333 unsigned int *nbuffers, unsigned int *nplanes,
2334 unsigned int sizes[], struct device *alloc_devs[])
2336 struct mxt_data *data = q->drv_priv;
2337 size_t size = data->dbg.t37_nodes * sizeof(u16);
2340 return sizes[0] < size ? -EINVAL : 0;
2348 static void mxt_buffer_queue(struct vb2_buffer *vb)
2350 struct mxt_data *data = vb2_get_drv_priv(vb->vb2_queue);
2355 ptr = vb2_plane_vaddr(vb, 0);
2357 dev_err(&data->client->dev, "Error acquiring frame ptr\n");
2361 switch (data->dbg.input) {
2362 case MXT_V4L_INPUT_DELTAS:
2364 mode = MXT_DIAGNOSTIC_DELTAS;
2367 case MXT_V4L_INPUT_REFS:
2368 mode = MXT_DIAGNOSTIC_REFS;
2372 ret = mxt_read_diagnostic_debug(data, mode, ptr);
2376 vb2_set_plane_payload(vb, 0, data->dbg.t37_nodes * sizeof(u16));
2377 vb2_buffer_done(vb, VB2_BUF_STATE_DONE);
2381 vb2_buffer_done(vb, VB2_BUF_STATE_ERROR);
2384 /* V4L2 structures */
2385 static const struct vb2_ops mxt_queue_ops = {
2386 .queue_setup = mxt_queue_setup,
2387 .buf_queue = mxt_buffer_queue,
2388 .wait_prepare = vb2_ops_wait_prepare,
2389 .wait_finish = vb2_ops_wait_finish,
2392 static const struct vb2_queue mxt_queue = {
2393 .type = V4L2_BUF_TYPE_VIDEO_CAPTURE,
2394 .io_modes = VB2_MMAP | VB2_USERPTR | VB2_DMABUF | VB2_READ,
2395 .buf_struct_size = sizeof(struct mxt_vb2_buffer),
2396 .ops = &mxt_queue_ops,
2397 .mem_ops = &vb2_vmalloc_memops,
2398 .timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC,
2399 .min_buffers_needed = 1,
2402 static int mxt_vidioc_querycap(struct file *file, void *priv,
2403 struct v4l2_capability *cap)
2405 struct mxt_data *data = video_drvdata(file);
2407 strlcpy(cap->driver, "atmel_mxt_ts", sizeof(cap->driver));
2408 strlcpy(cap->card, "atmel_mxt_ts touch", sizeof(cap->card));
2409 snprintf(cap->bus_info, sizeof(cap->bus_info),
2410 "I2C:%s", dev_name(&data->client->dev));
2414 static int mxt_vidioc_enum_input(struct file *file, void *priv,
2415 struct v4l2_input *i)
2417 if (i->index >= MXT_V4L_INPUT_MAX)
2420 i->type = V4L2_INPUT_TYPE_TOUCH;
2423 case MXT_V4L_INPUT_REFS:
2424 strlcpy(i->name, "Mutual Capacitance References",
2427 case MXT_V4L_INPUT_DELTAS:
2428 strlcpy(i->name, "Mutual Capacitance Deltas", sizeof(i->name));
2435 static int mxt_set_input(struct mxt_data *data, unsigned int i)
2437 struct v4l2_pix_format *f = &data->dbg.format;
2439 if (i >= MXT_V4L_INPUT_MAX)
2442 if (i == MXT_V4L_INPUT_DELTAS)
2443 f->pixelformat = V4L2_TCH_FMT_DELTA_TD16;
2445 f->pixelformat = V4L2_TCH_FMT_TU16;
2447 f->width = data->xy_switch ? data->ysize : data->xsize;
2448 f->height = data->xy_switch ? data->xsize : data->ysize;
2449 f->field = V4L2_FIELD_NONE;
2450 f->colorspace = V4L2_COLORSPACE_RAW;
2451 f->bytesperline = f->width * sizeof(u16);
2452 f->sizeimage = f->width * f->height * sizeof(u16);
2454 data->dbg.input = i;
2459 static int mxt_vidioc_s_input(struct file *file, void *priv, unsigned int i)
2461 return mxt_set_input(video_drvdata(file), i);
2464 static int mxt_vidioc_g_input(struct file *file, void *priv, unsigned int *i)
2466 struct mxt_data *data = video_drvdata(file);
2468 *i = data->dbg.input;
2473 static int mxt_vidioc_fmt(struct file *file, void *priv, struct v4l2_format *f)
2475 struct mxt_data *data = video_drvdata(file);
2477 f->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
2478 f->fmt.pix = data->dbg.format;
2483 static int mxt_vidioc_enum_fmt(struct file *file, void *priv,
2484 struct v4l2_fmtdesc *fmt)
2486 if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
2489 switch (fmt->index) {
2491 fmt->pixelformat = V4L2_TCH_FMT_TU16;
2495 fmt->pixelformat = V4L2_TCH_FMT_DELTA_TD16;
2505 static int mxt_vidioc_g_parm(struct file *file, void *fh,
2506 struct v4l2_streamparm *a)
2508 if (a->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
2511 a->parm.capture.readbuffers = 1;
2512 a->parm.capture.timeperframe.numerator = 1;
2513 a->parm.capture.timeperframe.denominator = 10;
2517 static const struct v4l2_ioctl_ops mxt_video_ioctl_ops = {
2518 .vidioc_querycap = mxt_vidioc_querycap,
2520 .vidioc_enum_fmt_vid_cap = mxt_vidioc_enum_fmt,
2521 .vidioc_s_fmt_vid_cap = mxt_vidioc_fmt,
2522 .vidioc_g_fmt_vid_cap = mxt_vidioc_fmt,
2523 .vidioc_try_fmt_vid_cap = mxt_vidioc_fmt,
2524 .vidioc_g_parm = mxt_vidioc_g_parm,
2526 .vidioc_enum_input = mxt_vidioc_enum_input,
2527 .vidioc_g_input = mxt_vidioc_g_input,
2528 .vidioc_s_input = mxt_vidioc_s_input,
2530 .vidioc_reqbufs = vb2_ioctl_reqbufs,
2531 .vidioc_create_bufs = vb2_ioctl_create_bufs,
2532 .vidioc_querybuf = vb2_ioctl_querybuf,
2533 .vidioc_qbuf = vb2_ioctl_qbuf,
2534 .vidioc_dqbuf = vb2_ioctl_dqbuf,
2535 .vidioc_expbuf = vb2_ioctl_expbuf,
2537 .vidioc_streamon = vb2_ioctl_streamon,
2538 .vidioc_streamoff = vb2_ioctl_streamoff,
2541 static const struct video_device mxt_video_device = {
2542 .name = "Atmel maxTouch",
2543 .fops = &mxt_video_fops,
2544 .ioctl_ops = &mxt_video_ioctl_ops,
2545 .release = video_device_release_empty,
2546 .device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_TOUCH |
2547 V4L2_CAP_READWRITE | V4L2_CAP_STREAMING,
2550 static void mxt_debug_init(struct mxt_data *data)
2552 struct mxt_info *info = data->info;
2553 struct mxt_dbg *dbg = &data->dbg;
2554 struct mxt_object *object;
2557 object = mxt_get_object(data, MXT_GEN_COMMAND_T6);
2561 dbg->diag_cmd_address = object->start_address + MXT_COMMAND_DIAGNOSTIC;
2563 object = mxt_get_object(data, MXT_DEBUG_DIAGNOSTIC_T37);
2567 if (mxt_obj_size(object) != sizeof(struct t37_debug)) {
2568 dev_warn(&data->client->dev, "Bad T37 size");
2572 dbg->t37_address = object->start_address;
2574 /* Calculate size of data and allocate buffer */
2575 dbg->t37_nodes = data->xsize * data->ysize;
2577 if (info->family_id == MXT_FAMILY_1386)
2578 dbg->t37_pages = MXT1386_COLUMNS * MXT1386_PAGES_PER_COLUMN;
2580 dbg->t37_pages = DIV_ROUND_UP(data->xsize *
2581 info->matrix_ysize *
2583 sizeof(dbg->t37_buf->data));
2585 dbg->t37_buf = devm_kmalloc_array(&data->client->dev, dbg->t37_pages,
2586 sizeof(struct t37_debug), GFP_KERNEL);
2590 /* init channel to zero */
2591 mxt_set_input(data, 0);
2593 /* register video device */
2594 snprintf(dbg->v4l2.name, sizeof(dbg->v4l2.name), "%s", "atmel_mxt_ts");
2595 error = v4l2_device_register(&data->client->dev, &dbg->v4l2);
2599 /* initialize the queue */
2600 mutex_init(&dbg->lock);
2601 dbg->queue = mxt_queue;
2602 dbg->queue.drv_priv = data;
2603 dbg->queue.lock = &dbg->lock;
2604 dbg->queue.dev = &data->client->dev;
2606 error = vb2_queue_init(&dbg->queue);
2608 goto error_unreg_v4l2;
2610 dbg->vdev = mxt_video_device;
2611 dbg->vdev.v4l2_dev = &dbg->v4l2;
2612 dbg->vdev.lock = &dbg->lock;
2613 dbg->vdev.vfl_dir = VFL_DIR_RX;
2614 dbg->vdev.queue = &dbg->queue;
2615 video_set_drvdata(&dbg->vdev, data);
2617 error = video_register_device(&dbg->vdev, VFL_TYPE_TOUCH, -1);
2619 goto error_unreg_v4l2;
2624 v4l2_device_unregister(&dbg->v4l2);
2626 dev_warn(&data->client->dev, "Error initializing T37\n");
2629 static void mxt_debug_init(struct mxt_data *data)
2634 static int mxt_configure_objects(struct mxt_data *data,
2635 const struct firmware *cfg)
2637 struct device *dev = &data->client->dev;
2640 error = mxt_init_t7_power_cfg(data);
2642 dev_err(dev, "Failed to initialize power cfg\n");
2647 error = mxt_update_cfg(data, cfg);
2649 dev_warn(dev, "Error %d updating config\n", error);
2652 if (data->multitouch) {
2653 error = mxt_initialize_input_device(data);
2657 dev_warn(dev, "No touch object detected\n");
2660 mxt_debug_init(data);
2665 /* Firmware Version is returned as Major.Minor.Build */
2666 static ssize_t mxt_fw_version_show(struct device *dev,
2667 struct device_attribute *attr, char *buf)
2669 struct mxt_data *data = dev_get_drvdata(dev);
2670 struct mxt_info *info = data->info;
2671 return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
2672 info->version >> 4, info->version & 0xf, info->build);
2675 /* Hardware Version is returned as FamilyID.VariantID */
2676 static ssize_t mxt_hw_version_show(struct device *dev,
2677 struct device_attribute *attr, char *buf)
2679 struct mxt_data *data = dev_get_drvdata(dev);
2680 struct mxt_info *info = data->info;
2681 return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
2682 info->family_id, info->variant_id);
2685 static ssize_t mxt_show_instance(char *buf, int count,
2686 struct mxt_object *object, int instance,
2691 if (mxt_obj_instances(object) > 1)
2692 count += scnprintf(buf + count, PAGE_SIZE - count,
2693 "Instance %u\n", instance);
2695 for (i = 0; i < mxt_obj_size(object); i++)
2696 count += scnprintf(buf + count, PAGE_SIZE - count,
2697 "\t[%2u]: %02x (%d)\n", i, val[i], val[i]);
2698 count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
2703 static ssize_t mxt_object_show(struct device *dev,
2704 struct device_attribute *attr, char *buf)
2706 struct mxt_data *data = dev_get_drvdata(dev);
2707 struct mxt_object *object;
2713 /* Pre-allocate buffer large enough to hold max sized object. */
2714 obuf = kmalloc(256, GFP_KERNEL);
2719 for (i = 0; i < data->info->object_num; i++) {
2720 object = data->object_table + i;
2722 if (!mxt_object_readable(object->type))
2725 count += scnprintf(buf + count, PAGE_SIZE - count,
2726 "T%u:\n", object->type);
2728 for (j = 0; j < mxt_obj_instances(object); j++) {
2729 u16 size = mxt_obj_size(object);
2730 u16 addr = object->start_address + j * size;
2732 error = __mxt_read_reg(data->client, addr, size, obuf);
2736 count = mxt_show_instance(buf, count, object, j, obuf);
2742 return error ?: count;
2745 static int mxt_check_firmware_format(struct device *dev,
2746 const struct firmware *fw)
2748 unsigned int pos = 0;
2751 while (pos < fw->size) {
2752 c = *(fw->data + pos);
2754 if (c < '0' || (c > '9' && c < 'A') || c > 'F')
2761 * To convert file try:
2762 * xxd -r -p mXTXXX__APP_VX-X-XX.enc > maxtouch.fw
2764 dev_err(dev, "Aborting: firmware file must be in binary format\n");
2769 static int mxt_load_fw(struct device *dev, const char *fn)
2771 struct mxt_data *data = dev_get_drvdata(dev);
2772 const struct firmware *fw = NULL;
2773 unsigned int frame_size;
2774 unsigned int pos = 0;
2775 unsigned int retry = 0;
2776 unsigned int frame = 0;
2779 ret = request_firmware(&fw, fn, dev);
2781 dev_err(dev, "Unable to open firmware %s\n", fn);
2785 /* Check for incorrect enc file */
2786 ret = mxt_check_firmware_format(dev, fw);
2788 goto release_firmware;
2790 if (!data->in_bootloader) {
2791 /* Change to the bootloader mode */
2792 data->in_bootloader = true;
2794 ret = mxt_t6_command(data, MXT_COMMAND_RESET,
2795 MXT_BOOT_VALUE, false);
2797 goto release_firmware;
2799 msleep(MXT_RESET_TIME);
2801 /* Do not need to scan since we know family ID */
2802 ret = mxt_lookup_bootloader_address(data, 0);
2804 goto release_firmware;
2806 mxt_free_input_device(data);
2807 mxt_free_object_table(data);
2809 enable_irq(data->irq);
2812 reinit_completion(&data->bl_completion);
2814 ret = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD, false);
2816 /* Bootloader may still be unlocked from previous attempt */
2817 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, false);
2821 dev_info(dev, "Unlocking bootloader\n");
2823 /* Unlock bootloader */
2824 ret = mxt_send_bootloader_cmd(data, true);
2829 while (pos < fw->size) {
2830 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, true);
2834 frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
2836 /* Take account of CRC bytes */
2839 /* Write one frame to device */
2840 ret = mxt_bootloader_write(data, fw->data + pos, frame_size);
2844 ret = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS, true);
2848 /* Back off by 20ms per retry */
2852 dev_err(dev, "Retry count exceeded\n");
2861 if (frame % 50 == 0)
2862 dev_dbg(dev, "Sent %d frames, %d/%zd bytes\n",
2863 frame, pos, fw->size);
2866 /* Wait for flash. */
2867 ret = mxt_wait_for_completion(data, &data->bl_completion,
2872 dev_dbg(dev, "Sent %d frames, %d bytes\n", frame, pos);
2875 * Wait for device to reset. Some bootloader versions do not assert
2876 * the CHG line after bootloading has finished, so ignore potential
2879 mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME);
2881 data->in_bootloader = false;
2884 disable_irq(data->irq);
2886 release_firmware(fw);
2890 static ssize_t mxt_update_fw_store(struct device *dev,
2891 struct device_attribute *attr,
2892 const char *buf, size_t count)
2894 struct mxt_data *data = dev_get_drvdata(dev);
2897 error = mxt_load_fw(dev, MXT_FW_NAME);
2899 dev_err(dev, "The firmware update failed(%d)\n", error);
2902 dev_info(dev, "The firmware update succeeded\n");
2904 error = mxt_initialize(data);
2912 static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
2913 static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
2914 static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
2915 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
2917 static struct attribute *mxt_attrs[] = {
2918 &dev_attr_fw_version.attr,
2919 &dev_attr_hw_version.attr,
2920 &dev_attr_object.attr,
2921 &dev_attr_update_fw.attr,
2925 static const struct attribute_group mxt_attr_group = {
2929 static void mxt_start(struct mxt_data *data)
2931 switch (data->suspend_mode) {
2932 case MXT_SUSPEND_T9_CTRL:
2933 mxt_soft_reset(data);
2936 /* 0x83 = SCANEN | RPTEN | ENABLE */
2937 mxt_write_object(data,
2938 MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0x83);
2941 case MXT_SUSPEND_DEEP_SLEEP:
2943 mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
2945 /* Recalibrate since chip has been in deep sleep */
2946 mxt_t6_command(data, MXT_COMMAND_CALIBRATE, 1, false);
2951 static void mxt_stop(struct mxt_data *data)
2953 switch (data->suspend_mode) {
2954 case MXT_SUSPEND_T9_CTRL:
2956 mxt_write_object(data,
2957 MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0);
2960 case MXT_SUSPEND_DEEP_SLEEP:
2962 mxt_set_t7_power_cfg(data, MXT_POWER_CFG_DEEPSLEEP);
2967 static int mxt_input_open(struct input_dev *dev)
2969 struct mxt_data *data = input_get_drvdata(dev);
2976 static void mxt_input_close(struct input_dev *dev)
2978 struct mxt_data *data = input_get_drvdata(dev);
2983 static int mxt_parse_device_properties(struct mxt_data *data)
2985 static const char keymap_property[] = "linux,gpio-keymap";
2986 struct device *dev = &data->client->dev;
2991 if (device_property_present(dev, keymap_property)) {
2992 n_keys = device_property_read_u32_array(dev, keymap_property,
2995 error = n_keys < 0 ? n_keys : -EINVAL;
2996 dev_err(dev, "invalid/malformed '%s' property: %d\n",
2997 keymap_property, error);
3001 keymap = devm_kmalloc_array(dev, n_keys, sizeof(*keymap),
3006 error = device_property_read_u32_array(dev, keymap_property,
3009 dev_err(dev, "failed to parse '%s' property: %d\n",
3010 keymap_property, error);
3014 data->t19_keymap = keymap;
3015 data->t19_num_keys = n_keys;
3021 static const struct dmi_system_id chromebook_T9_suspend_dmi[] = {
3024 DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
3025 DMI_MATCH(DMI_PRODUCT_NAME, "Link"),
3030 DMI_MATCH(DMI_PRODUCT_NAME, "Peppy"),
3036 static int mxt_probe(struct i2c_client *client, const struct i2c_device_id *id)
3038 struct mxt_data *data;
3042 * Ignore devices that do not have device properties attached to
3043 * them, as we need help determining whether we are dealing with
3044 * touch screen or touchpad.
3046 * So far on x86 the only users of Atmel touch controllers are
3047 * Chromebooks, and chromeos_laptop driver will ensure that
3048 * necessary properties are provided (if firmware does not do that).
3050 if (!device_property_present(&client->dev, "compatible"))
3054 * Ignore ACPI devices representing bootloader mode.
3056 * This is a bit of a hack: Google Chromebook BIOS creates ACPI
3057 * devices for both application and bootloader modes, but we are
3058 * interested in application mode only (if device is in bootloader
3059 * mode we'll end up switching into application anyway). So far
3060 * application mode addresses were all above 0x40, so we'll use it
3063 if (ACPI_COMPANION(&client->dev) && client->addr < 0x40)
3066 data = devm_kzalloc(&client->dev, sizeof(struct mxt_data), GFP_KERNEL);
3070 snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
3071 client->adapter->nr, client->addr);
3073 data->client = client;
3074 data->irq = client->irq;
3075 i2c_set_clientdata(client, data);
3077 init_completion(&data->bl_completion);
3078 init_completion(&data->reset_completion);
3079 init_completion(&data->crc_completion);
3081 data->suspend_mode = dmi_check_system(chromebook_T9_suspend_dmi) ?
3082 MXT_SUSPEND_T9_CTRL : MXT_SUSPEND_DEEP_SLEEP;
3084 error = mxt_parse_device_properties(data);
3088 data->reset_gpio = devm_gpiod_get_optional(&client->dev,
3089 "reset", GPIOD_OUT_LOW);
3090 if (IS_ERR(data->reset_gpio)) {
3091 error = PTR_ERR(data->reset_gpio);
3092 dev_err(&client->dev, "Failed to get reset gpio: %d\n", error);
3096 error = devm_request_threaded_irq(&client->dev, client->irq,
3097 NULL, mxt_interrupt, IRQF_ONESHOT,
3098 client->name, data);
3100 dev_err(&client->dev, "Failed to register interrupt\n");
3104 disable_irq(client->irq);
3106 if (data->reset_gpio) {
3107 msleep(MXT_RESET_GPIO_TIME);
3108 gpiod_set_value(data->reset_gpio, 1);
3109 msleep(MXT_RESET_INVALID_CHG);
3112 error = mxt_initialize(data);
3116 error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
3118 dev_err(&client->dev, "Failure %d creating sysfs group\n",
3120 goto err_free_object;
3126 mxt_free_input_device(data);
3127 mxt_free_object_table(data);
3131 static int mxt_remove(struct i2c_client *client)
3133 struct mxt_data *data = i2c_get_clientdata(client);
3135 disable_irq(data->irq);
3136 sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
3137 mxt_free_input_device(data);
3138 mxt_free_object_table(data);
3143 static int __maybe_unused mxt_suspend(struct device *dev)
3145 struct i2c_client *client = to_i2c_client(dev);
3146 struct mxt_data *data = i2c_get_clientdata(client);
3147 struct input_dev *input_dev = data->input_dev;
3152 mutex_lock(&input_dev->mutex);
3154 if (input_dev->users)
3157 mutex_unlock(&input_dev->mutex);
3162 static int __maybe_unused mxt_resume(struct device *dev)
3164 struct i2c_client *client = to_i2c_client(dev);
3165 struct mxt_data *data = i2c_get_clientdata(client);
3166 struct input_dev *input_dev = data->input_dev;
3171 mutex_lock(&input_dev->mutex);
3173 if (input_dev->users)
3176 mutex_unlock(&input_dev->mutex);
3181 static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);
3183 static const struct of_device_id mxt_of_match[] = {
3184 { .compatible = "atmel,maxtouch", },
3185 /* Compatibles listed below are deprecated */
3186 { .compatible = "atmel,qt602240_ts", },
3187 { .compatible = "atmel,atmel_mxt_ts", },
3188 { .compatible = "atmel,atmel_mxt_tp", },
3189 { .compatible = "atmel,mXT224", },
3192 MODULE_DEVICE_TABLE(of, mxt_of_match);
3195 static const struct acpi_device_id mxt_acpi_id[] = {
3196 { "ATML0000", 0 }, /* Touchpad */
3197 { "ATML0001", 0 }, /* Touchscreen */
3200 MODULE_DEVICE_TABLE(acpi, mxt_acpi_id);
3203 static const struct i2c_device_id mxt_id[] = {
3204 { "qt602240_ts", 0 },
3205 { "atmel_mxt_ts", 0 },
3206 { "atmel_mxt_tp", 0 },
3211 MODULE_DEVICE_TABLE(i2c, mxt_id);
3213 static struct i2c_driver mxt_driver = {
3215 .name = "atmel_mxt_ts",
3216 .of_match_table = mxt_of_match,
3217 .acpi_match_table = ACPI_PTR(mxt_acpi_id),
3221 .remove = mxt_remove,
3225 module_i2c_driver(mxt_driver);
3227 /* Module information */
3228 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
3229 MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
3230 MODULE_LICENSE("GPL");