2 * Atmel maXTouch Touchscreen driver
4 * Copyright (C) 2010 Samsung Electronics Co.Ltd
5 * Copyright (C) 2011-2014 Atmel Corporation
6 * Copyright (C) 2012 Google, Inc.
7 * Copyright (C) 2016 Zodiac Inflight Innovations
9 * Author: Joonyoung Shim <jy0922.shim@samsung.com>
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the
13 * Free Software Foundation; either version 2 of the License, or (at your
14 * option) any later version.
18 #include <linux/acpi.h>
19 #include <linux/dmi.h>
20 #include <linux/module.h>
21 #include <linux/init.h>
22 #include <linux/completion.h>
23 #include <linux/delay.h>
24 #include <linux/firmware.h>
25 #include <linux/i2c.h>
26 #include <linux/platform_data/atmel_mxt_ts.h>
27 #include <linux/input/mt.h>
28 #include <linux/interrupt.h>
30 #include <linux/slab.h>
31 #include <linux/gpio/consumer.h>
32 #include <asm/unaligned.h>
33 #include <media/v4l2-device.h>
34 #include <media/v4l2-ioctl.h>
35 #include <media/videobuf2-v4l2.h>
36 #include <media/videobuf2-vmalloc.h>
39 #define MXT_FW_NAME "maxtouch.fw"
40 #define MXT_CFG_NAME "maxtouch.cfg"
41 #define MXT_CFG_MAGIC "OBP_RAW V1"
44 #define MXT_OBJECT_START 0x07
45 #define MXT_OBJECT_SIZE 6
46 #define MXT_INFO_CHECKSUM_SIZE 3
47 #define MXT_MAX_BLOCK_WRITE 256
50 #define MXT_DEBUG_DIAGNOSTIC_T37 37
51 #define MXT_GEN_MESSAGE_T5 5
52 #define MXT_GEN_COMMAND_T6 6
53 #define MXT_GEN_POWER_T7 7
54 #define MXT_GEN_ACQUIRE_T8 8
55 #define MXT_GEN_DATASOURCE_T53 53
56 #define MXT_TOUCH_MULTI_T9 9
57 #define MXT_TOUCH_KEYARRAY_T15 15
58 #define MXT_TOUCH_PROXIMITY_T23 23
59 #define MXT_TOUCH_PROXKEY_T52 52
60 #define MXT_PROCI_GRIPFACE_T20 20
61 #define MXT_PROCG_NOISE_T22 22
62 #define MXT_PROCI_ONETOUCH_T24 24
63 #define MXT_PROCI_TWOTOUCH_T27 27
64 #define MXT_PROCI_GRIP_T40 40
65 #define MXT_PROCI_PALM_T41 41
66 #define MXT_PROCI_TOUCHSUPPRESSION_T42 42
67 #define MXT_PROCI_STYLUS_T47 47
68 #define MXT_PROCG_NOISESUPPRESSION_T48 48
69 #define MXT_SPT_COMMSCONFIG_T18 18
70 #define MXT_SPT_GPIOPWM_T19 19
71 #define MXT_SPT_SELFTEST_T25 25
72 #define MXT_SPT_CTECONFIG_T28 28
73 #define MXT_SPT_USERDATA_T38 38
74 #define MXT_SPT_DIGITIZER_T43 43
75 #define MXT_SPT_MESSAGECOUNT_T44 44
76 #define MXT_SPT_CTECONFIG_T46 46
77 #define MXT_TOUCH_MULTITOUCHSCREEN_T100 100
79 /* MXT_GEN_MESSAGE_T5 object */
80 #define MXT_RPTID_NOMSG 0xff
82 /* MXT_GEN_COMMAND_T6 field */
83 #define MXT_COMMAND_RESET 0
84 #define MXT_COMMAND_BACKUPNV 1
85 #define MXT_COMMAND_CALIBRATE 2
86 #define MXT_COMMAND_REPORTALL 3
87 #define MXT_COMMAND_DIAGNOSTIC 5
89 /* Define for T6 status byte */
90 #define MXT_T6_STATUS_RESET (1 << 7)
91 #define MXT_T6_STATUS_OFL (1 << 6)
92 #define MXT_T6_STATUS_SIGERR (1 << 5)
93 #define MXT_T6_STATUS_CAL (1 << 4)
94 #define MXT_T6_STATUS_CFGERR (1 << 3)
95 #define MXT_T6_STATUS_COMSERR (1 << 2)
97 /* MXT_GEN_POWER_T7 field */
103 #define MXT_POWER_CFG_RUN 0
104 #define MXT_POWER_CFG_DEEPSLEEP 1
106 /* MXT_TOUCH_MULTI_T9 field */
107 #define MXT_T9_CTRL 0
108 #define MXT_T9_XSIZE 3
109 #define MXT_T9_YSIZE 4
110 #define MXT_T9_ORIENT 9
111 #define MXT_T9_RANGE 18
113 /* MXT_TOUCH_MULTI_T9 status */
114 #define MXT_T9_UNGRIP (1 << 0)
115 #define MXT_T9_SUPPRESS (1 << 1)
116 #define MXT_T9_AMP (1 << 2)
117 #define MXT_T9_VECTOR (1 << 3)
118 #define MXT_T9_MOVE (1 << 4)
119 #define MXT_T9_RELEASE (1 << 5)
120 #define MXT_T9_PRESS (1 << 6)
121 #define MXT_T9_DETECT (1 << 7)
128 /* MXT_TOUCH_MULTI_T9 orient */
129 #define MXT_T9_ORIENT_SWITCH (1 << 0)
130 #define MXT_T9_ORIENT_INVERTX (1 << 1)
131 #define MXT_T9_ORIENT_INVERTY (1 << 2)
133 /* MXT_SPT_COMMSCONFIG_T18 */
134 #define MXT_COMMS_CTRL 0
135 #define MXT_COMMS_CMD 1
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_TIME 200 /* msec */
197 #define MXT_RESET_TIMEOUT 3000 /* msec */
198 #define MXT_CRC_TIMEOUT 1000 /* msec */
199 #define MXT_FW_RESET_TIME 3000 /* msec */
200 #define MXT_FW_CHG_TIMEOUT 300 /* msec */
202 /* Command to unlock bootloader */
203 #define MXT_UNLOCK_CMD_MSB 0xaa
204 #define MXT_UNLOCK_CMD_LSB 0xdc
206 /* Bootloader mode status */
207 #define MXT_WAITING_BOOTLOAD_CMD 0xc0 /* valid 7 6 bit only */
208 #define MXT_WAITING_FRAME_DATA 0x80 /* valid 7 6 bit only */
209 #define MXT_FRAME_CRC_CHECK 0x02
210 #define MXT_FRAME_CRC_FAIL 0x03
211 #define MXT_FRAME_CRC_PASS 0x04
212 #define MXT_APP_CRC_FAIL 0x40 /* valid 7 8 bit only */
213 #define MXT_BOOT_STATUS_MASK 0x3f
214 #define MXT_BOOT_EXTENDED_ID (1 << 5)
215 #define MXT_BOOT_ID_MASK 0x1f
217 /* Touchscreen absolute values */
218 #define MXT_MAX_AREA 0xff
220 #define MXT_PIXELS_PER_MM 20
236 u8 instances_minus_one;
242 u16 diag_cmd_address;
243 struct t37_debug *t37_buf;
244 unsigned int t37_pages;
245 unsigned int t37_nodes;
247 struct v4l2_device v4l2;
248 struct v4l2_pix_format format;
249 struct video_device vdev;
250 struct vb2_queue queue;
255 enum v4l_dbg_inputs {
256 MXT_V4L_INPUT_DELTAS,
261 static const struct v4l2_file_operations mxt_video_fops = {
262 .owner = THIS_MODULE,
263 .open = v4l2_fh_open,
264 .release = vb2_fop_release,
265 .unlocked_ioctl = video_ioctl2,
266 .read = vb2_fop_read,
267 .mmap = vb2_fop_mmap,
268 .poll = vb2_fop_poll,
271 /* Each client has this additional data */
273 struct i2c_client *client;
274 struct input_dev *input_dev;
275 char phys[64]; /* device physical location */
276 const struct mxt_platform_data *pdata;
277 struct mxt_object *object_table;
278 struct mxt_info *info;
279 void *raw_info_block;
300 u8 last_message_count;
303 struct t7_config t7_cfg;
305 struct gpio_desc *reset_gpio;
307 /* Cached parameters from object table */
317 u8 T100_reportid_min;
318 u8 T100_reportid_max;
320 /* for fw update in bootloader */
321 struct completion bl_completion;
323 /* for reset handling */
324 struct completion reset_completion;
326 /* for config update handling */
327 struct completion crc_completion;
330 struct mxt_vb2_buffer {
331 struct vb2_buffer vb;
332 struct list_head list;
335 static size_t mxt_obj_size(const struct mxt_object *obj)
337 return obj->size_minus_one + 1;
340 static size_t mxt_obj_instances(const struct mxt_object *obj)
342 return obj->instances_minus_one + 1;
345 static bool mxt_object_readable(unsigned int type)
348 case MXT_GEN_COMMAND_T6:
349 case MXT_GEN_POWER_T7:
350 case MXT_GEN_ACQUIRE_T8:
351 case MXT_GEN_DATASOURCE_T53:
352 case MXT_TOUCH_MULTI_T9:
353 case MXT_TOUCH_KEYARRAY_T15:
354 case MXT_TOUCH_PROXIMITY_T23:
355 case MXT_TOUCH_PROXKEY_T52:
356 case MXT_TOUCH_MULTITOUCHSCREEN_T100:
357 case MXT_PROCI_GRIPFACE_T20:
358 case MXT_PROCG_NOISE_T22:
359 case MXT_PROCI_ONETOUCH_T24:
360 case MXT_PROCI_TWOTOUCH_T27:
361 case MXT_PROCI_GRIP_T40:
362 case MXT_PROCI_PALM_T41:
363 case MXT_PROCI_TOUCHSUPPRESSION_T42:
364 case MXT_PROCI_STYLUS_T47:
365 case MXT_PROCG_NOISESUPPRESSION_T48:
366 case MXT_SPT_COMMSCONFIG_T18:
367 case MXT_SPT_GPIOPWM_T19:
368 case MXT_SPT_SELFTEST_T25:
369 case MXT_SPT_CTECONFIG_T28:
370 case MXT_SPT_USERDATA_T38:
371 case MXT_SPT_DIGITIZER_T43:
372 case MXT_SPT_CTECONFIG_T46:
379 static void mxt_dump_message(struct mxt_data *data, u8 *message)
381 dev_dbg(&data->client->dev, "message: %*ph\n",
382 data->T5_msg_size, message);
385 static int mxt_wait_for_completion(struct mxt_data *data,
386 struct completion *comp,
387 unsigned int timeout_ms)
389 struct device *dev = &data->client->dev;
390 unsigned long timeout = msecs_to_jiffies(timeout_ms);
393 ret = wait_for_completion_interruptible_timeout(comp, timeout);
396 } else if (ret == 0) {
397 dev_err(dev, "Wait for completion timed out.\n");
403 static int mxt_bootloader_read(struct mxt_data *data,
404 u8 *val, unsigned int count)
409 msg.addr = data->bootloader_addr;
410 msg.flags = data->client->flags & I2C_M_TEN;
411 msg.flags |= I2C_M_RD;
415 ret = i2c_transfer(data->client->adapter, &msg, 1);
419 ret = ret < 0 ? ret : -EIO;
420 dev_err(&data->client->dev, "%s: i2c recv failed (%d)\n",
427 static int mxt_bootloader_write(struct mxt_data *data,
428 const u8 * const val, unsigned int count)
433 msg.addr = data->bootloader_addr;
434 msg.flags = data->client->flags & I2C_M_TEN;
438 ret = i2c_transfer(data->client->adapter, &msg, 1);
442 ret = ret < 0 ? ret : -EIO;
443 dev_err(&data->client->dev, "%s: i2c send failed (%d)\n",
450 static int mxt_lookup_bootloader_address(struct mxt_data *data, bool retry)
452 u8 appmode = data->client->addr;
454 u8 family_id = data->info ? data->info->family_id : 0;
459 /* Chips after 1664S use different scheme */
460 if (retry || family_id >= 0xa2) {
461 bootloader = appmode - 0x24;
464 /* Fall through for normal case */
469 bootloader = appmode - 0x26;
473 dev_err(&data->client->dev,
474 "Appmode i2c address 0x%02x not found\n",
479 data->bootloader_addr = bootloader;
483 static int mxt_probe_bootloader(struct mxt_data *data, bool alt_address)
485 struct device *dev = &data->client->dev;
490 error = mxt_lookup_bootloader_address(data, alt_address);
494 error = mxt_bootloader_read(data, &val, 1);
498 /* Check app crc fail mode */
499 crc_failure = (val & ~MXT_BOOT_STATUS_MASK) == MXT_APP_CRC_FAIL;
501 dev_err(dev, "Detected bootloader, status:%02X%s\n",
502 val, crc_failure ? ", APP_CRC_FAIL" : "");
507 static u8 mxt_get_bootloader_version(struct mxt_data *data, u8 val)
509 struct device *dev = &data->client->dev;
512 if (val & MXT_BOOT_EXTENDED_ID) {
513 if (mxt_bootloader_read(data, &buf[0], 3) != 0) {
514 dev_err(dev, "%s: i2c failure\n", __func__);
518 dev_dbg(dev, "Bootloader ID:%d Version:%d\n", buf[1], buf[2]);
522 dev_dbg(dev, "Bootloader ID:%d\n", val & MXT_BOOT_ID_MASK);
528 static int mxt_check_bootloader(struct mxt_data *data, unsigned int state,
531 struct device *dev = &data->client->dev;
538 * In application update mode, the interrupt
539 * line signals state transitions. We must wait for the
540 * CHG assertion before reading the status byte.
541 * Once the status byte has been read, the line is deasserted.
543 ret = mxt_wait_for_completion(data, &data->bl_completion,
547 * TODO: handle -ERESTARTSYS better by terminating
548 * fw update process before returning to userspace
549 * by writing length 0x000 to device (iff we are in
550 * WAITING_FRAME_DATA state).
552 dev_err(dev, "Update wait error %d\n", ret);
557 ret = mxt_bootloader_read(data, &val, 1);
561 if (state == MXT_WAITING_BOOTLOAD_CMD)
562 val = mxt_get_bootloader_version(data, val);
565 case MXT_WAITING_BOOTLOAD_CMD:
566 case MXT_WAITING_FRAME_DATA:
567 case MXT_APP_CRC_FAIL:
568 val &= ~MXT_BOOT_STATUS_MASK;
570 case MXT_FRAME_CRC_PASS:
571 if (val == MXT_FRAME_CRC_CHECK) {
573 } else if (val == MXT_FRAME_CRC_FAIL) {
574 dev_err(dev, "Bootloader CRC fail\n");
583 dev_err(dev, "Invalid bootloader state %02X != %02X\n",
591 static int mxt_send_bootloader_cmd(struct mxt_data *data, bool unlock)
597 buf[0] = MXT_UNLOCK_CMD_LSB;
598 buf[1] = MXT_UNLOCK_CMD_MSB;
604 ret = mxt_bootloader_write(data, buf, 2);
611 static int __mxt_read_reg(struct i2c_client *client,
612 u16 reg, u16 len, void *val)
614 struct i2c_msg xfer[2];
619 buf[1] = (reg >> 8) & 0xff;
622 xfer[0].addr = client->addr;
628 xfer[1].addr = client->addr;
629 xfer[1].flags = I2C_M_RD;
633 ret = i2c_transfer(client->adapter, xfer, 2);
639 dev_err(&client->dev, "%s: i2c transfer failed (%d)\n",
646 static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len,
654 buf = kmalloc(count, GFP_KERNEL);
659 buf[1] = (reg >> 8) & 0xff;
660 memcpy(&buf[2], val, len);
662 ret = i2c_master_send(client, buf, count);
668 dev_err(&client->dev, "%s: i2c send failed (%d)\n",
676 static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
678 return __mxt_write_reg(client, reg, 1, &val);
681 static struct mxt_object *
682 mxt_get_object(struct mxt_data *data, u8 type)
684 struct mxt_object *object;
687 for (i = 0; i < data->info->object_num; i++) {
688 object = data->object_table + i;
689 if (object->type == type)
693 dev_warn(&data->client->dev, "Invalid object type T%u\n", type);
697 static void mxt_proc_t6_messages(struct mxt_data *data, u8 *msg)
699 struct device *dev = &data->client->dev;
701 u32 crc = msg[2] | (msg[3] << 8) | (msg[4] << 16);
703 complete(&data->crc_completion);
705 if (crc != data->config_crc) {
706 data->config_crc = crc;
707 dev_dbg(dev, "T6 Config Checksum: 0x%06X\n", crc);
711 if (status & MXT_T6_STATUS_RESET)
712 complete(&data->reset_completion);
714 /* Output debug if status has changed */
715 if (status != data->t6_status)
716 dev_dbg(dev, "T6 Status 0x%02X%s%s%s%s%s%s%s\n",
718 status == 0 ? " OK" : "",
719 status & MXT_T6_STATUS_RESET ? " RESET" : "",
720 status & MXT_T6_STATUS_OFL ? " OFL" : "",
721 status & MXT_T6_STATUS_SIGERR ? " SIGERR" : "",
722 status & MXT_T6_STATUS_CAL ? " CAL" : "",
723 status & MXT_T6_STATUS_CFGERR ? " CFGERR" : "",
724 status & MXT_T6_STATUS_COMSERR ? " COMSERR" : "");
726 /* Save current status */
727 data->t6_status = status;
730 static int mxt_write_object(struct mxt_data *data,
731 u8 type, u8 offset, u8 val)
733 struct mxt_object *object;
736 object = mxt_get_object(data, type);
737 if (!object || offset >= mxt_obj_size(object))
740 reg = object->start_address;
741 return mxt_write_reg(data->client, reg + offset, val);
744 static void mxt_input_button(struct mxt_data *data, u8 *message)
746 struct input_dev *input = data->input_dev;
747 const struct mxt_platform_data *pdata = data->pdata;
750 for (i = 0; i < pdata->t19_num_keys; i++) {
751 if (pdata->t19_keymap[i] == KEY_RESERVED)
754 /* Active-low switch */
755 input_report_key(input, pdata->t19_keymap[i],
756 !(message[1] & BIT(i)));
760 static void mxt_input_sync(struct mxt_data *data)
762 input_mt_report_pointer_emulation(data->input_dev,
763 data->pdata->t19_num_keys);
764 input_sync(data->input_dev);
767 static void mxt_proc_t9_message(struct mxt_data *data, u8 *message)
769 struct device *dev = &data->client->dev;
770 struct input_dev *input_dev = data->input_dev;
778 id = message[0] - data->T9_reportid_min;
780 x = (message[2] << 4) | ((message[4] >> 4) & 0xf);
781 y = (message[3] << 4) | ((message[4] & 0xf));
783 /* Handle 10/12 bit switching */
784 if (data->max_x < 1024)
786 if (data->max_y < 1024)
790 amplitude = message[6];
793 "[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
795 (status & MXT_T9_DETECT) ? 'D' : '.',
796 (status & MXT_T9_PRESS) ? 'P' : '.',
797 (status & MXT_T9_RELEASE) ? 'R' : '.',
798 (status & MXT_T9_MOVE) ? 'M' : '.',
799 (status & MXT_T9_VECTOR) ? 'V' : '.',
800 (status & MXT_T9_AMP) ? 'A' : '.',
801 (status & MXT_T9_SUPPRESS) ? 'S' : '.',
802 (status & MXT_T9_UNGRIP) ? 'U' : '.',
803 x, y, area, amplitude);
805 input_mt_slot(input_dev, id);
807 if (status & MXT_T9_DETECT) {
809 * Multiple bits may be set if the host is slow to read
810 * the status messages, indicating all the events that
813 if (status & MXT_T9_RELEASE) {
814 input_mt_report_slot_state(input_dev,
816 mxt_input_sync(data);
820 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 1);
821 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
822 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
823 input_report_abs(input_dev, ABS_MT_PRESSURE, amplitude);
824 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
826 /* Touch no longer active, close out slot */
827 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 0);
830 data->update_input = true;
833 static void mxt_proc_t100_message(struct mxt_data *data, u8 *message)
835 struct device *dev = &data->client->dev;
836 struct input_dev *input_dev = data->input_dev;
848 id = message[0] - data->T100_reportid_min - 2;
850 /* ignore SCRSTATUS events */
855 x = get_unaligned_le16(&message[2]);
856 y = get_unaligned_le16(&message[4]);
858 if (status & MXT_T100_DETECT) {
859 type = (status & MXT_T100_TYPE_MASK) >> 4;
862 case MXT_T100_TYPE_HOVERING_FINGER:
863 tool = MT_TOOL_FINGER;
864 distance = MXT_DISTANCE_HOVERING;
866 if (data->t100_aux_vect)
867 orientation = message[data->t100_aux_vect];
871 case MXT_T100_TYPE_FINGER:
872 case MXT_T100_TYPE_GLOVE:
873 tool = MT_TOOL_FINGER;
874 distance = MXT_DISTANCE_ACTIVE_TOUCH;
876 if (data->t100_aux_area)
877 major = message[data->t100_aux_area];
879 if (data->t100_aux_ampl)
880 pressure = message[data->t100_aux_ampl];
882 if (data->t100_aux_vect)
883 orientation = message[data->t100_aux_vect];
887 case MXT_T100_TYPE_PASSIVE_STYLUS:
891 * Passive stylus is reported with size zero so
894 major = MXT_TOUCH_MAJOR_DEFAULT;
896 if (data->t100_aux_ampl)
897 pressure = message[data->t100_aux_ampl];
901 case MXT_T100_TYPE_LARGE_TOUCH:
902 /* Ignore suppressed touch */
906 dev_dbg(dev, "Unexpected T100 type\n");
912 * Values reported should be non-zero if tool is touching the
915 if (!pressure && type != MXT_T100_TYPE_HOVERING_FINGER)
916 pressure = MXT_PRESSURE_DEFAULT;
918 input_mt_slot(input_dev, id);
920 if (status & MXT_T100_DETECT) {
921 dev_dbg(dev, "[%u] type:%u x:%u y:%u a:%02X p:%02X v:%02X\n",
922 id, type, x, y, major, pressure, orientation);
924 input_mt_report_slot_state(input_dev, tool, 1);
925 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
926 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
927 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, major);
928 input_report_abs(input_dev, ABS_MT_PRESSURE, pressure);
929 input_report_abs(input_dev, ABS_MT_DISTANCE, distance);
930 input_report_abs(input_dev, ABS_MT_ORIENTATION, orientation);
932 dev_dbg(dev, "[%u] release\n", id);
935 input_mt_report_slot_state(input_dev, 0, 0);
938 data->update_input = true;
941 static int mxt_proc_message(struct mxt_data *data, u8 *message)
943 u8 report_id = message[0];
945 if (report_id == MXT_RPTID_NOMSG)
948 if (report_id == data->T6_reportid) {
949 mxt_proc_t6_messages(data, message);
950 } else if (!data->input_dev) {
952 * Do not report events if input device
953 * is not yet registered.
955 mxt_dump_message(data, message);
956 } else if (report_id >= data->T9_reportid_min &&
957 report_id <= data->T9_reportid_max) {
958 mxt_proc_t9_message(data, message);
959 } else if (report_id >= data->T100_reportid_min &&
960 report_id <= data->T100_reportid_max) {
961 mxt_proc_t100_message(data, message);
962 } else if (report_id == data->T19_reportid) {
963 mxt_input_button(data, message);
964 data->update_input = true;
966 mxt_dump_message(data, message);
972 static int mxt_read_and_process_messages(struct mxt_data *data, u8 count)
974 struct device *dev = &data->client->dev;
979 /* Safety check for msg_buf */
980 if (count > data->max_reportid)
983 /* Process remaining messages if necessary */
984 ret = __mxt_read_reg(data->client, data->T5_address,
985 data->T5_msg_size * count, data->msg_buf);
987 dev_err(dev, "Failed to read %u messages (%d)\n", count, ret);
991 for (i = 0; i < count; i++) {
992 ret = mxt_proc_message(data,
993 data->msg_buf + data->T5_msg_size * i);
999 /* return number of messages read */
1003 static irqreturn_t mxt_process_messages_t44(struct mxt_data *data)
1005 struct device *dev = &data->client->dev;
1009 /* Read T44 and T5 together */
1010 ret = __mxt_read_reg(data->client, data->T44_address,
1011 data->T5_msg_size + 1, data->msg_buf);
1013 dev_err(dev, "Failed to read T44 and T5 (%d)\n", ret);
1017 count = data->msg_buf[0];
1020 * This condition may be caused by the CHG line being configured in
1021 * Mode 0. It results in unnecessary I2C operations but it is benign.
1026 if (count > data->max_reportid) {
1027 dev_warn(dev, "T44 count %d exceeded max report id\n", count);
1028 count = data->max_reportid;
1031 /* Process first message */
1032 ret = mxt_proc_message(data, data->msg_buf + 1);
1034 dev_warn(dev, "Unexpected invalid message\n");
1038 num_left = count - 1;
1040 /* Process remaining messages if necessary */
1042 ret = mxt_read_and_process_messages(data, num_left);
1045 else if (ret != num_left)
1046 dev_warn(dev, "Unexpected invalid message\n");
1050 if (data->update_input) {
1051 mxt_input_sync(data);
1052 data->update_input = false;
1058 static int mxt_process_messages_until_invalid(struct mxt_data *data)
1060 struct device *dev = &data->client->dev;
1064 count = data->max_reportid;
1066 /* Read messages until we force an invalid */
1068 read = mxt_read_and_process_messages(data, count);
1073 if (data->update_input) {
1074 mxt_input_sync(data);
1075 data->update_input = false;
1078 dev_err(dev, "CHG pin isn't cleared\n");
1082 static irqreturn_t mxt_process_messages(struct mxt_data *data)
1084 int total_handled, num_handled;
1085 u8 count = data->last_message_count;
1087 if (count < 1 || count > data->max_reportid)
1090 /* include final invalid message */
1091 total_handled = mxt_read_and_process_messages(data, count + 1);
1092 if (total_handled < 0)
1094 /* if there were invalid messages, then we are done */
1095 else if (total_handled <= count)
1098 /* keep reading two msgs until one is invalid or reportid limit */
1100 num_handled = mxt_read_and_process_messages(data, 2);
1101 if (num_handled < 0)
1104 total_handled += num_handled;
1106 if (num_handled < 2)
1108 } while (total_handled < data->num_touchids);
1111 data->last_message_count = total_handled;
1113 if (data->update_input) {
1114 mxt_input_sync(data);
1115 data->update_input = false;
1121 static irqreturn_t mxt_interrupt(int irq, void *dev_id)
1123 struct mxt_data *data = dev_id;
1125 if (data->in_bootloader) {
1126 /* bootloader state transition completion */
1127 complete(&data->bl_completion);
1131 if (!data->object_table)
1134 if (data->T44_address) {
1135 return mxt_process_messages_t44(data);
1137 return mxt_process_messages(data);
1141 static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset,
1142 u8 value, bool wait)
1145 u8 command_register;
1146 int timeout_counter = 0;
1149 reg = data->T6_address + cmd_offset;
1151 ret = mxt_write_reg(data->client, reg, value);
1160 ret = __mxt_read_reg(data->client, reg, 1, &command_register);
1163 } while (command_register != 0 && timeout_counter++ <= 100);
1165 if (timeout_counter > 100) {
1166 dev_err(&data->client->dev, "Command failed!\n");
1173 static int mxt_acquire_irq(struct mxt_data *data)
1177 enable_irq(data->irq);
1179 error = mxt_process_messages_until_invalid(data);
1186 static int mxt_soft_reset(struct mxt_data *data)
1188 struct device *dev = &data->client->dev;
1191 dev_info(dev, "Resetting device\n");
1193 disable_irq(data->irq);
1195 reinit_completion(&data->reset_completion);
1197 ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false);
1201 /* Ignore CHG line for 100ms after reset */
1204 mxt_acquire_irq(data);
1206 ret = mxt_wait_for_completion(data, &data->reset_completion,
1214 static void mxt_update_crc(struct mxt_data *data, u8 cmd, u8 value)
1217 * On failure, CRC is set to 0 and config will always be
1220 data->config_crc = 0;
1221 reinit_completion(&data->crc_completion);
1223 mxt_t6_command(data, cmd, value, true);
1226 * Wait for crc message. On failure, CRC is set to 0 and config will
1227 * always be downloaded.
1229 mxt_wait_for_completion(data, &data->crc_completion, MXT_CRC_TIMEOUT);
1232 static void mxt_calc_crc24(u32 *crc, u8 firstbyte, u8 secondbyte)
1234 static const unsigned int crcpoly = 0x80001B;
1238 data_word = (secondbyte << 8) | firstbyte;
1239 result = ((*crc << 1) ^ data_word);
1241 if (result & 0x1000000)
1247 static u32 mxt_calculate_crc(u8 *base, off_t start_off, off_t end_off)
1250 u8 *ptr = base + start_off;
1251 u8 *last_val = base + end_off - 1;
1253 if (end_off < start_off)
1256 while (ptr < last_val) {
1257 mxt_calc_crc24(&crc, *ptr, *(ptr + 1));
1261 /* if len is odd, fill the last byte with 0 */
1262 if (ptr == last_val)
1263 mxt_calc_crc24(&crc, *ptr, 0);
1265 /* Mask to 24-bit */
1271 static int mxt_prepare_cfg_mem(struct mxt_data *data,
1272 const struct firmware *cfg,
1273 unsigned int data_pos,
1274 unsigned int cfg_start_ofs,
1276 size_t config_mem_size)
1278 struct device *dev = &data->client->dev;
1279 struct mxt_object *object;
1280 unsigned int type, instance, size, byte_offset;
1287 while (data_pos < cfg->size) {
1288 /* Read type, instance, length */
1289 ret = sscanf(cfg->data + data_pos, "%x %x %x%n",
1290 &type, &instance, &size, &offset);
1294 } else if (ret != 3) {
1295 dev_err(dev, "Bad format: failed to parse object\n");
1300 object = mxt_get_object(data, type);
1303 for (i = 0; i < size; i++) {
1304 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1307 dev_err(dev, "Bad format in T%d at %d\n",
1316 if (size > mxt_obj_size(object)) {
1318 * Either we are in fallback mode due to wrong
1319 * config or config from a later fw version,
1320 * or the file is corrupt or hand-edited.
1322 dev_warn(dev, "Discarding %zu byte(s) in T%u\n",
1323 size - mxt_obj_size(object), type);
1324 } else if (mxt_obj_size(object) > size) {
1326 * If firmware is upgraded, new bytes may be added to
1327 * end of objects. It is generally forward compatible
1328 * to zero these bytes - previous behaviour will be
1329 * retained. However this does invalidate the CRC and
1330 * will force fallback mode until the configuration is
1331 * updated. We warn here but do nothing else - the
1332 * malloc has zeroed the entire configuration.
1334 dev_warn(dev, "Zeroing %zu byte(s) in T%d\n",
1335 mxt_obj_size(object) - size, type);
1338 if (instance >= mxt_obj_instances(object)) {
1339 dev_err(dev, "Object instances exceeded!\n");
1343 reg = object->start_address + mxt_obj_size(object) * instance;
1345 for (i = 0; i < size; i++) {
1346 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1350 dev_err(dev, "Bad format in T%d at %d\n",
1356 if (i > mxt_obj_size(object))
1359 byte_offset = reg + i - cfg_start_ofs;
1361 if (byte_offset >= 0 && byte_offset < config_mem_size) {
1362 *(config_mem + byte_offset) = val;
1364 dev_err(dev, "Bad object: reg:%d, T%d, ofs=%d\n",
1365 reg, object->type, byte_offset);
1374 static int mxt_upload_cfg_mem(struct mxt_data *data, unsigned int cfg_start,
1375 u8 *config_mem, size_t config_mem_size)
1377 unsigned int byte_offset = 0;
1380 /* Write configuration as blocks */
1381 while (byte_offset < config_mem_size) {
1382 unsigned int size = config_mem_size - byte_offset;
1384 if (size > MXT_MAX_BLOCK_WRITE)
1385 size = MXT_MAX_BLOCK_WRITE;
1387 error = __mxt_write_reg(data->client,
1388 cfg_start + byte_offset,
1389 size, config_mem + byte_offset);
1391 dev_err(&data->client->dev,
1392 "Config write error, ret=%d\n", error);
1396 byte_offset += size;
1402 static int mxt_init_t7_power_cfg(struct mxt_data *data);
1405 * mxt_update_cfg - download configuration to chip
1407 * Atmel Raw Config File Format
1409 * The first four lines of the raw config file contain:
1411 * 2) Chip ID Information (first 7 bytes of device memory)
1412 * 3) Chip Information Block 24-bit CRC Checksum
1413 * 4) Chip Configuration 24-bit CRC Checksum
1415 * The rest of the file consists of one line per object instance:
1416 * <TYPE> <INSTANCE> <SIZE> <CONTENTS>
1418 * <TYPE> - 2-byte object type as hex
1419 * <INSTANCE> - 2-byte object instance number as hex
1420 * <SIZE> - 2-byte object size as hex
1421 * <CONTENTS> - array of <SIZE> 1-byte hex values
1423 static int mxt_update_cfg(struct mxt_data *data, const struct firmware *cfg)
1425 struct device *dev = &data->client->dev;
1426 struct mxt_info cfg_info;
1432 u32 info_crc, config_crc, calculated_crc;
1434 size_t config_mem_size;
1436 mxt_update_crc(data, MXT_COMMAND_REPORTALL, 1);
1438 if (strncmp(cfg->data, MXT_CFG_MAGIC, strlen(MXT_CFG_MAGIC))) {
1439 dev_err(dev, "Unrecognised config file\n");
1443 data_pos = strlen(MXT_CFG_MAGIC);
1445 /* Load information block and check */
1446 for (i = 0; i < sizeof(struct mxt_info); i++) {
1447 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1448 (unsigned char *)&cfg_info + i,
1451 dev_err(dev, "Bad format\n");
1458 if (cfg_info.family_id != data->info->family_id) {
1459 dev_err(dev, "Family ID mismatch!\n");
1463 if (cfg_info.variant_id != data->info->variant_id) {
1464 dev_err(dev, "Variant ID mismatch!\n");
1469 ret = sscanf(cfg->data + data_pos, "%x%n", &info_crc, &offset);
1471 dev_err(dev, "Bad format: failed to parse Info CRC\n");
1476 ret = sscanf(cfg->data + data_pos, "%x%n", &config_crc, &offset);
1478 dev_err(dev, "Bad format: failed to parse Config CRC\n");
1484 * The Info Block CRC is calculated over mxt_info and the object
1485 * table. If it does not match then we are trying to load the
1486 * configuration from a different chip or firmware version, so
1487 * the configuration CRC is invalid anyway.
1489 if (info_crc == data->info_crc) {
1490 if (config_crc == 0 || data->config_crc == 0) {
1491 dev_info(dev, "CRC zero, attempting to apply config\n");
1492 } else if (config_crc == data->config_crc) {
1493 dev_dbg(dev, "Config CRC 0x%06X: OK\n",
1497 dev_info(dev, "Config CRC 0x%06X: does not match file 0x%06X\n",
1498 data->config_crc, config_crc);
1502 "Warning: Info CRC error - device=0x%06X file=0x%06X\n",
1503 data->info_crc, info_crc);
1506 /* Malloc memory to store configuration */
1507 cfg_start_ofs = MXT_OBJECT_START +
1508 data->info->object_num * sizeof(struct mxt_object) +
1509 MXT_INFO_CHECKSUM_SIZE;
1510 config_mem_size = data->mem_size - cfg_start_ofs;
1511 config_mem = kzalloc(config_mem_size, GFP_KERNEL);
1513 dev_err(dev, "Failed to allocate memory\n");
1517 ret = mxt_prepare_cfg_mem(data, cfg, data_pos, cfg_start_ofs,
1518 config_mem, config_mem_size);
1522 /* Calculate crc of the received configs (not the raw config file) */
1523 if (data->T7_address < cfg_start_ofs) {
1524 dev_err(dev, "Bad T7 address, T7addr = %x, config offset %x\n",
1525 data->T7_address, cfg_start_ofs);
1530 calculated_crc = mxt_calculate_crc(config_mem,
1531 data->T7_address - cfg_start_ofs,
1534 if (config_crc > 0 && config_crc != calculated_crc)
1535 dev_warn(dev, "Config CRC error, calculated=%06X, file=%06X\n",
1536 calculated_crc, config_crc);
1538 ret = mxt_upload_cfg_mem(data, cfg_start_ofs,
1539 config_mem, config_mem_size);
1543 mxt_update_crc(data, MXT_COMMAND_BACKUPNV, MXT_BACKUP_VALUE);
1545 ret = mxt_soft_reset(data);
1549 dev_info(dev, "Config successfully updated\n");
1551 /* T7 config may have changed */
1552 mxt_init_t7_power_cfg(data);
1559 static void mxt_free_input_device(struct mxt_data *data)
1561 if (data->input_dev) {
1562 input_unregister_device(data->input_dev);
1563 data->input_dev = NULL;
1567 static void mxt_free_object_table(struct mxt_data *data)
1569 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
1570 video_unregister_device(&data->dbg.vdev);
1571 v4l2_device_unregister(&data->dbg.v4l2);
1573 data->object_table = NULL;
1575 kfree(data->raw_info_block);
1576 data->raw_info_block = NULL;
1577 kfree(data->msg_buf);
1578 data->msg_buf = NULL;
1579 data->T5_address = 0;
1580 data->T5_msg_size = 0;
1581 data->T6_reportid = 0;
1582 data->T7_address = 0;
1583 data->T9_reportid_min = 0;
1584 data->T9_reportid_max = 0;
1585 data->T19_reportid = 0;
1586 data->T44_address = 0;
1587 data->T100_reportid_min = 0;
1588 data->T100_reportid_max = 0;
1589 data->max_reportid = 0;
1592 static int mxt_parse_object_table(struct mxt_data *data,
1593 struct mxt_object *object_table)
1595 struct i2c_client *client = data->client;
1600 /* Valid Report IDs start counting from 1 */
1603 for (i = 0; i < data->info->object_num; i++) {
1604 struct mxt_object *object = object_table + i;
1607 le16_to_cpus(&object->start_address);
1609 if (object->num_report_ids) {
1611 reportid += object->num_report_ids *
1612 mxt_obj_instances(object);
1613 max_id = reportid - 1;
1619 dev_dbg(&data->client->dev,
1620 "T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n",
1621 object->type, object->start_address,
1622 mxt_obj_size(object), mxt_obj_instances(object),
1625 switch (object->type) {
1626 case MXT_GEN_MESSAGE_T5:
1627 if (data->info->family_id == 0x80 &&
1628 data->info->version < 0x20) {
1630 * On mXT224 firmware versions prior to V2.0
1631 * read and discard unused CRC byte otherwise
1632 * DMA reads are misaligned.
1634 data->T5_msg_size = mxt_obj_size(object);
1636 /* CRC not enabled, so skip last byte */
1637 data->T5_msg_size = mxt_obj_size(object) - 1;
1639 data->T5_address = object->start_address;
1641 case MXT_GEN_COMMAND_T6:
1642 data->T6_reportid = min_id;
1643 data->T6_address = object->start_address;
1645 case MXT_GEN_POWER_T7:
1646 data->T7_address = object->start_address;
1648 case MXT_TOUCH_MULTI_T9:
1649 data->multitouch = MXT_TOUCH_MULTI_T9;
1650 data->T9_reportid_min = min_id;
1651 data->T9_reportid_max = max_id;
1652 data->num_touchids = object->num_report_ids
1653 * mxt_obj_instances(object);
1655 case MXT_SPT_MESSAGECOUNT_T44:
1656 data->T44_address = object->start_address;
1658 case MXT_SPT_GPIOPWM_T19:
1659 data->T19_reportid = min_id;
1661 case MXT_TOUCH_MULTITOUCHSCREEN_T100:
1662 data->multitouch = MXT_TOUCH_MULTITOUCHSCREEN_T100;
1663 data->T100_reportid_min = min_id;
1664 data->T100_reportid_max = max_id;
1665 /* first two report IDs reserved */
1666 data->num_touchids = object->num_report_ids - 2;
1670 end_address = object->start_address
1671 + mxt_obj_size(object) * mxt_obj_instances(object) - 1;
1673 if (end_address >= data->mem_size)
1674 data->mem_size = end_address + 1;
1677 /* Store maximum reportid */
1678 data->max_reportid = reportid;
1680 /* If T44 exists, T5 position has to be directly after */
1681 if (data->T44_address && (data->T5_address != data->T44_address + 1)) {
1682 dev_err(&client->dev, "Invalid T44 position\n");
1686 data->msg_buf = kcalloc(data->max_reportid,
1687 data->T5_msg_size, GFP_KERNEL);
1694 static int mxt_read_info_block(struct mxt_data *data)
1696 struct i2c_client *client = data->client;
1700 uint8_t num_objects;
1704 /* If info block already allocated, free it */
1705 if (data->raw_info_block)
1706 mxt_free_object_table(data);
1708 /* Read 7-byte ID information block starting at address 0 */
1709 size = sizeof(struct mxt_info);
1710 id_buf = kzalloc(size, GFP_KERNEL);
1714 error = __mxt_read_reg(client, 0, size, id_buf);
1718 /* Resize buffer to give space for rest of info block */
1719 num_objects = ((struct mxt_info *)id_buf)->object_num;
1720 size += (num_objects * sizeof(struct mxt_object))
1721 + MXT_INFO_CHECKSUM_SIZE;
1723 buf = krealloc(id_buf, size, GFP_KERNEL);
1730 /* Read rest of info block */
1731 error = __mxt_read_reg(client, MXT_OBJECT_START,
1732 size - MXT_OBJECT_START,
1733 id_buf + MXT_OBJECT_START);
1737 /* Extract & calculate checksum */
1738 crc_ptr = id_buf + size - MXT_INFO_CHECKSUM_SIZE;
1739 data->info_crc = crc_ptr[0] | (crc_ptr[1] << 8) | (crc_ptr[2] << 16);
1741 calculated_crc = mxt_calculate_crc(id_buf, 0,
1742 size - MXT_INFO_CHECKSUM_SIZE);
1745 * CRC mismatch can be caused by data corruption due to I2C comms
1746 * issue or else device is not using Object Based Protocol (eg i2c-hid)
1748 if ((data->info_crc == 0) || (data->info_crc != calculated_crc)) {
1749 dev_err(&client->dev,
1750 "Info Block CRC error calculated=0x%06X read=0x%06X\n",
1751 calculated_crc, data->info_crc);
1756 data->raw_info_block = id_buf;
1757 data->info = (struct mxt_info *)id_buf;
1759 dev_info(&client->dev,
1760 "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n",
1761 data->info->family_id, data->info->variant_id,
1762 data->info->version >> 4, data->info->version & 0xf,
1763 data->info->build, data->info->object_num);
1765 /* Parse object table information */
1766 error = mxt_parse_object_table(data, id_buf + MXT_OBJECT_START);
1768 dev_err(&client->dev, "Error %d parsing object table\n", error);
1769 mxt_free_object_table(data);
1773 data->object_table = (struct mxt_object *)(id_buf + MXT_OBJECT_START);
1782 static int mxt_read_t9_resolution(struct mxt_data *data)
1784 struct i2c_client *client = data->client;
1786 struct t9_range range;
1787 unsigned char orient;
1788 struct mxt_object *object;
1790 object = mxt_get_object(data, MXT_TOUCH_MULTI_T9);
1794 error = __mxt_read_reg(client,
1795 object->start_address + MXT_T9_XSIZE,
1796 sizeof(data->xsize), &data->xsize);
1800 error = __mxt_read_reg(client,
1801 object->start_address + MXT_T9_YSIZE,
1802 sizeof(data->ysize), &data->ysize);
1806 error = __mxt_read_reg(client,
1807 object->start_address + MXT_T9_RANGE,
1808 sizeof(range), &range);
1812 data->max_x = get_unaligned_le16(&range.x);
1813 data->max_y = get_unaligned_le16(&range.y);
1815 error = __mxt_read_reg(client,
1816 object->start_address + MXT_T9_ORIENT,
1821 data->xy_switch = orient & MXT_T9_ORIENT_SWITCH;
1822 data->invertx = orient & MXT_T9_ORIENT_INVERTX;
1823 data->inverty = orient & MXT_T9_ORIENT_INVERTY;
1828 static int mxt_read_t100_config(struct mxt_data *data)
1830 struct i2c_client *client = data->client;
1832 struct mxt_object *object;
1833 u16 range_x, range_y;
1837 object = mxt_get_object(data, MXT_TOUCH_MULTITOUCHSCREEN_T100);
1841 /* read touchscreen dimensions */
1842 error = __mxt_read_reg(client,
1843 object->start_address + MXT_T100_XRANGE,
1844 sizeof(range_x), &range_x);
1848 data->max_x = get_unaligned_le16(&range_x);
1850 error = __mxt_read_reg(client,
1851 object->start_address + MXT_T100_YRANGE,
1852 sizeof(range_y), &range_y);
1856 data->max_y = get_unaligned_le16(&range_y);
1858 error = __mxt_read_reg(client,
1859 object->start_address + MXT_T100_XSIZE,
1860 sizeof(data->xsize), &data->xsize);
1864 error = __mxt_read_reg(client,
1865 object->start_address + MXT_T100_YSIZE,
1866 sizeof(data->ysize), &data->ysize);
1870 /* read orientation config */
1871 error = __mxt_read_reg(client,
1872 object->start_address + MXT_T100_CFG1,
1877 data->xy_switch = cfg & MXT_T100_CFG_SWITCHXY;
1878 data->invertx = cfg & MXT_T100_CFG_INVERTX;
1879 data->inverty = cfg & MXT_T100_CFG_INVERTY;
1881 /* allocate aux bytes */
1882 error = __mxt_read_reg(client,
1883 object->start_address + MXT_T100_TCHAUX,
1890 if (tchaux & MXT_T100_TCHAUX_VECT)
1891 data->t100_aux_vect = aux++;
1893 if (tchaux & MXT_T100_TCHAUX_AMPL)
1894 data->t100_aux_ampl = aux++;
1896 if (tchaux & MXT_T100_TCHAUX_AREA)
1897 data->t100_aux_area = aux++;
1899 dev_dbg(&client->dev,
1900 "T100 aux mappings vect:%u ampl:%u area:%u\n",
1901 data->t100_aux_vect, data->t100_aux_ampl, data->t100_aux_area);
1906 static int mxt_input_open(struct input_dev *dev);
1907 static void mxt_input_close(struct input_dev *dev);
1909 static void mxt_set_up_as_touchpad(struct input_dev *input_dev,
1910 struct mxt_data *data)
1912 const struct mxt_platform_data *pdata = data->pdata;
1915 input_dev->name = "Atmel maXTouch Touchpad";
1917 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
1919 input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM);
1920 input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM);
1921 input_abs_set_res(input_dev, ABS_MT_POSITION_X,
1923 input_abs_set_res(input_dev, ABS_MT_POSITION_Y,
1926 for (i = 0; i < pdata->t19_num_keys; i++)
1927 if (pdata->t19_keymap[i] != KEY_RESERVED)
1928 input_set_capability(input_dev, EV_KEY,
1929 pdata->t19_keymap[i]);
1932 static int mxt_initialize_input_device(struct mxt_data *data)
1934 const struct mxt_platform_data *pdata = data->pdata;
1935 struct device *dev = &data->client->dev;
1936 struct input_dev *input_dev;
1938 unsigned int num_mt_slots;
1939 unsigned int mt_flags = 0;
1941 switch (data->multitouch) {
1942 case MXT_TOUCH_MULTI_T9:
1943 num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
1944 error = mxt_read_t9_resolution(data);
1946 dev_warn(dev, "Failed to initialize T9 resolution\n");
1949 case MXT_TOUCH_MULTITOUCHSCREEN_T100:
1950 num_mt_slots = data->num_touchids;
1951 error = mxt_read_t100_config(data);
1953 dev_warn(dev, "Failed to read T100 config\n");
1957 dev_err(dev, "Invalid multitouch object\n");
1961 /* Handle default values and orientation switch */
1962 if (data->max_x == 0)
1965 if (data->max_y == 0)
1968 if (data->xy_switch)
1969 swap(data->max_x, data->max_y);
1971 dev_info(dev, "Touchscreen size X%uY%u\n", data->max_x, data->max_y);
1973 /* Register input device */
1974 input_dev = input_allocate_device();
1976 dev_err(dev, "Failed to allocate memory\n");
1980 input_dev->name = "Atmel maXTouch Touchscreen";
1981 input_dev->phys = data->phys;
1982 input_dev->id.bustype = BUS_I2C;
1983 input_dev->dev.parent = dev;
1984 input_dev->open = mxt_input_open;
1985 input_dev->close = mxt_input_close;
1987 input_set_capability(input_dev, EV_KEY, BTN_TOUCH);
1989 /* For single touch */
1990 input_set_abs_params(input_dev, ABS_X, 0, data->max_x, 0, 0);
1991 input_set_abs_params(input_dev, ABS_Y, 0, data->max_y, 0, 0);
1993 if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
1994 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1995 data->t100_aux_ampl)) {
1996 input_set_abs_params(input_dev, ABS_PRESSURE, 0, 255, 0, 0);
1999 /* If device has buttons we assume it is a touchpad */
2000 if (pdata->t19_num_keys) {
2001 mxt_set_up_as_touchpad(input_dev, data);
2002 mt_flags |= INPUT_MT_POINTER;
2004 mt_flags |= INPUT_MT_DIRECT;
2007 /* For multi touch */
2008 error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags);
2010 dev_err(dev, "Error %d initialising slots\n", error);
2014 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100) {
2015 input_set_abs_params(input_dev, ABS_MT_TOOL_TYPE,
2016 0, MT_TOOL_MAX, 0, 0);
2017 input_set_abs_params(input_dev, ABS_MT_DISTANCE,
2018 MXT_DISTANCE_ACTIVE_TOUCH,
2019 MXT_DISTANCE_HOVERING,
2023 input_set_abs_params(input_dev, ABS_MT_POSITION_X,
2024 0, data->max_x, 0, 0);
2025 input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
2026 0, data->max_y, 0, 0);
2028 if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
2029 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2030 data->t100_aux_area)) {
2031 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
2032 0, MXT_MAX_AREA, 0, 0);
2035 if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
2036 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2037 data->t100_aux_ampl)) {
2038 input_set_abs_params(input_dev, ABS_MT_PRESSURE,
2042 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2043 data->t100_aux_vect) {
2044 input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
2048 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2049 data->t100_aux_ampl) {
2050 input_set_abs_params(input_dev, ABS_MT_PRESSURE,
2054 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2055 data->t100_aux_vect) {
2056 input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
2060 input_set_drvdata(input_dev, data);
2062 error = input_register_device(input_dev);
2064 dev_err(dev, "Error %d registering input device\n", error);
2068 data->input_dev = input_dev;
2073 input_free_device(input_dev);
2077 static int mxt_configure_objects(struct mxt_data *data,
2078 const struct firmware *cfg);
2080 static void mxt_config_cb(const struct firmware *cfg, void *ctx)
2082 mxt_configure_objects(ctx, cfg);
2083 release_firmware(cfg);
2086 static int mxt_initialize(struct mxt_data *data)
2088 struct i2c_client *client = data->client;
2089 int recovery_attempts = 0;
2093 error = mxt_read_info_block(data);
2097 /* Check bootloader state */
2098 error = mxt_probe_bootloader(data, false);
2100 dev_info(&client->dev, "Trying alternate bootloader address\n");
2101 error = mxt_probe_bootloader(data, true);
2103 /* Chip is not in appmode or bootloader mode */
2108 /* OK, we are in bootloader, see if we can recover */
2109 if (++recovery_attempts > 1) {
2110 dev_err(&client->dev, "Could not recover from bootloader mode\n");
2112 * We can reflash from this state, so do not
2113 * abort initialization.
2115 data->in_bootloader = true;
2119 /* Attempt to exit bootloader into app mode */
2120 mxt_send_bootloader_cmd(data, false);
2121 msleep(MXT_FW_RESET_TIME);
2124 error = mxt_acquire_irq(data);
2128 error = request_firmware_nowait(THIS_MODULE, true, MXT_CFG_NAME,
2129 &client->dev, GFP_KERNEL, data,
2132 dev_err(&client->dev, "Failed to invoke firmware loader: %d\n",
2140 static int mxt_set_t7_power_cfg(struct mxt_data *data, u8 sleep)
2142 struct device *dev = &data->client->dev;
2144 struct t7_config *new_config;
2145 struct t7_config deepsleep = { .active = 0, .idle = 0 };
2147 if (sleep == MXT_POWER_CFG_DEEPSLEEP)
2148 new_config = &deepsleep;
2150 new_config = &data->t7_cfg;
2152 error = __mxt_write_reg(data->client, data->T7_address,
2153 sizeof(data->t7_cfg), new_config);
2157 dev_dbg(dev, "Set T7 ACTV:%d IDLE:%d\n",
2158 new_config->active, new_config->idle);
2163 static int mxt_init_t7_power_cfg(struct mxt_data *data)
2165 struct device *dev = &data->client->dev;
2170 error = __mxt_read_reg(data->client, data->T7_address,
2171 sizeof(data->t7_cfg), &data->t7_cfg);
2175 if (data->t7_cfg.active == 0 || data->t7_cfg.idle == 0) {
2177 dev_dbg(dev, "T7 cfg zero, resetting\n");
2178 mxt_soft_reset(data);
2182 dev_dbg(dev, "T7 cfg zero after reset, overriding\n");
2183 data->t7_cfg.active = 20;
2184 data->t7_cfg.idle = 100;
2185 return mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
2189 dev_dbg(dev, "Initialized power cfg: ACTV %d, IDLE %d\n",
2190 data->t7_cfg.active, data->t7_cfg.idle);
2194 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
2195 static u16 mxt_get_debug_value(struct mxt_data *data, unsigned int x,
2198 struct mxt_info *info = data->info;
2199 struct mxt_dbg *dbg = &data->dbg;
2200 unsigned int ofs, page;
2201 unsigned int col = 0;
2202 unsigned int col_width;
2204 if (info->family_id == MXT_FAMILY_1386) {
2205 col_width = info->matrix_ysize / MXT1386_COLUMNS;
2206 col = y / col_width;
2209 col_width = info->matrix_ysize;
2212 ofs = (y + (x * col_width)) * sizeof(u16);
2213 page = ofs / MXT_DIAGNOSTIC_SIZE;
2214 ofs %= MXT_DIAGNOSTIC_SIZE;
2216 if (info->family_id == MXT_FAMILY_1386)
2217 page += col * MXT1386_PAGES_PER_COLUMN;
2219 return get_unaligned_le16(&dbg->t37_buf[page].data[ofs]);
2222 static int mxt_convert_debug_pages(struct mxt_data *data, u16 *outbuf)
2224 struct mxt_dbg *dbg = &data->dbg;
2227 unsigned int i, rx, ry;
2229 for (i = 0; i < dbg->t37_nodes; i++) {
2230 /* Handle orientation */
2231 rx = data->xy_switch ? y : x;
2232 ry = data->xy_switch ? x : y;
2233 rx = data->invertx ? (data->xsize - 1 - rx) : rx;
2234 ry = data->inverty ? (data->ysize - 1 - ry) : ry;
2236 outbuf[i] = mxt_get_debug_value(data, rx, ry);
2239 if (++x >= (data->xy_switch ? data->ysize : data->xsize)) {
2248 static int mxt_read_diagnostic_debug(struct mxt_data *data, u8 mode,
2251 struct mxt_dbg *dbg = &data->dbg;
2256 struct t37_debug *p;
2259 for (page = 0; page < dbg->t37_pages; page++) {
2260 p = dbg->t37_buf + page;
2262 ret = mxt_write_reg(data->client, dbg->diag_cmd_address,
2270 /* Read back command byte */
2271 ret = __mxt_read_reg(data->client, dbg->diag_cmd_address,
2272 sizeof(cmd_poll), &cmd_poll);
2276 /* Field is cleared once the command has been processed */
2278 if (retries++ > 100)
2286 ret = __mxt_read_reg(data->client, dbg->t37_address,
2287 sizeof(struct t37_debug), p);
2291 if (p->mode != mode || p->page != page) {
2292 dev_err(&data->client->dev, "T37 page mismatch\n");
2296 dev_dbg(&data->client->dev, "%s page:%d retries:%d\n",
2297 __func__, page, retries);
2299 /* For remaining pages, write PAGEUP rather than mode */
2300 cmd = MXT_DIAGNOSTIC_PAGEUP;
2303 return mxt_convert_debug_pages(data, outbuf);
2306 static int mxt_queue_setup(struct vb2_queue *q,
2307 unsigned int *nbuffers, unsigned int *nplanes,
2308 unsigned int sizes[], struct device *alloc_devs[])
2310 struct mxt_data *data = q->drv_priv;
2311 size_t size = data->dbg.t37_nodes * sizeof(u16);
2314 return sizes[0] < size ? -EINVAL : 0;
2322 static void mxt_buffer_queue(struct vb2_buffer *vb)
2324 struct mxt_data *data = vb2_get_drv_priv(vb->vb2_queue);
2329 ptr = vb2_plane_vaddr(vb, 0);
2331 dev_err(&data->client->dev, "Error acquiring frame ptr\n");
2335 switch (data->dbg.input) {
2336 case MXT_V4L_INPUT_DELTAS:
2338 mode = MXT_DIAGNOSTIC_DELTAS;
2341 case MXT_V4L_INPUT_REFS:
2342 mode = MXT_DIAGNOSTIC_REFS;
2346 ret = mxt_read_diagnostic_debug(data, mode, ptr);
2350 vb2_set_plane_payload(vb, 0, data->dbg.t37_nodes * sizeof(u16));
2351 vb2_buffer_done(vb, VB2_BUF_STATE_DONE);
2355 vb2_buffer_done(vb, VB2_BUF_STATE_ERROR);
2358 /* V4L2 structures */
2359 static const struct vb2_ops mxt_queue_ops = {
2360 .queue_setup = mxt_queue_setup,
2361 .buf_queue = mxt_buffer_queue,
2362 .wait_prepare = vb2_ops_wait_prepare,
2363 .wait_finish = vb2_ops_wait_finish,
2366 static const struct vb2_queue mxt_queue = {
2367 .type = V4L2_BUF_TYPE_VIDEO_CAPTURE,
2368 .io_modes = VB2_MMAP | VB2_USERPTR | VB2_DMABUF | VB2_READ,
2369 .buf_struct_size = sizeof(struct mxt_vb2_buffer),
2370 .ops = &mxt_queue_ops,
2371 .mem_ops = &vb2_vmalloc_memops,
2372 .timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC,
2373 .min_buffers_needed = 1,
2376 static int mxt_vidioc_querycap(struct file *file, void *priv,
2377 struct v4l2_capability *cap)
2379 struct mxt_data *data = video_drvdata(file);
2381 strlcpy(cap->driver, "atmel_mxt_ts", sizeof(cap->driver));
2382 strlcpy(cap->card, "atmel_mxt_ts touch", sizeof(cap->card));
2383 snprintf(cap->bus_info, sizeof(cap->bus_info),
2384 "I2C:%s", dev_name(&data->client->dev));
2388 static int mxt_vidioc_enum_input(struct file *file, void *priv,
2389 struct v4l2_input *i)
2391 if (i->index >= MXT_V4L_INPUT_MAX)
2394 i->type = V4L2_INPUT_TYPE_TOUCH;
2397 case MXT_V4L_INPUT_REFS:
2398 strlcpy(i->name, "Mutual Capacitance References",
2401 case MXT_V4L_INPUT_DELTAS:
2402 strlcpy(i->name, "Mutual Capacitance Deltas", sizeof(i->name));
2409 static int mxt_set_input(struct mxt_data *data, unsigned int i)
2411 struct v4l2_pix_format *f = &data->dbg.format;
2413 if (i >= MXT_V4L_INPUT_MAX)
2416 if (i == MXT_V4L_INPUT_DELTAS)
2417 f->pixelformat = V4L2_TCH_FMT_DELTA_TD16;
2419 f->pixelformat = V4L2_TCH_FMT_TU16;
2421 f->width = data->xy_switch ? data->ysize : data->xsize;
2422 f->height = data->xy_switch ? data->xsize : data->ysize;
2423 f->field = V4L2_FIELD_NONE;
2424 f->colorspace = V4L2_COLORSPACE_RAW;
2425 f->bytesperline = f->width * sizeof(u16);
2426 f->sizeimage = f->width * f->height * sizeof(u16);
2428 data->dbg.input = i;
2433 static int mxt_vidioc_s_input(struct file *file, void *priv, unsigned int i)
2435 return mxt_set_input(video_drvdata(file), i);
2438 static int mxt_vidioc_g_input(struct file *file, void *priv, unsigned int *i)
2440 struct mxt_data *data = video_drvdata(file);
2442 *i = data->dbg.input;
2447 static int mxt_vidioc_fmt(struct file *file, void *priv, struct v4l2_format *f)
2449 struct mxt_data *data = video_drvdata(file);
2451 f->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
2452 f->fmt.pix = data->dbg.format;
2457 static int mxt_vidioc_enum_fmt(struct file *file, void *priv,
2458 struct v4l2_fmtdesc *fmt)
2460 if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
2463 switch (fmt->index) {
2465 fmt->pixelformat = V4L2_TCH_FMT_TU16;
2469 fmt->pixelformat = V4L2_TCH_FMT_DELTA_TD16;
2479 static int mxt_vidioc_g_parm(struct file *file, void *fh,
2480 struct v4l2_streamparm *a)
2482 if (a->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
2485 a->parm.capture.readbuffers = 1;
2486 a->parm.capture.timeperframe.numerator = 1;
2487 a->parm.capture.timeperframe.denominator = 10;
2491 static const struct v4l2_ioctl_ops mxt_video_ioctl_ops = {
2492 .vidioc_querycap = mxt_vidioc_querycap,
2494 .vidioc_enum_fmt_vid_cap = mxt_vidioc_enum_fmt,
2495 .vidioc_s_fmt_vid_cap = mxt_vidioc_fmt,
2496 .vidioc_g_fmt_vid_cap = mxt_vidioc_fmt,
2497 .vidioc_try_fmt_vid_cap = mxt_vidioc_fmt,
2498 .vidioc_g_parm = mxt_vidioc_g_parm,
2500 .vidioc_enum_input = mxt_vidioc_enum_input,
2501 .vidioc_g_input = mxt_vidioc_g_input,
2502 .vidioc_s_input = mxt_vidioc_s_input,
2504 .vidioc_reqbufs = vb2_ioctl_reqbufs,
2505 .vidioc_create_bufs = vb2_ioctl_create_bufs,
2506 .vidioc_querybuf = vb2_ioctl_querybuf,
2507 .vidioc_qbuf = vb2_ioctl_qbuf,
2508 .vidioc_dqbuf = vb2_ioctl_dqbuf,
2509 .vidioc_expbuf = vb2_ioctl_expbuf,
2511 .vidioc_streamon = vb2_ioctl_streamon,
2512 .vidioc_streamoff = vb2_ioctl_streamoff,
2515 static const struct video_device mxt_video_device = {
2516 .name = "Atmel maxTouch",
2517 .fops = &mxt_video_fops,
2518 .ioctl_ops = &mxt_video_ioctl_ops,
2519 .release = video_device_release_empty,
2520 .device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_TOUCH |
2521 V4L2_CAP_READWRITE | V4L2_CAP_STREAMING,
2524 static void mxt_debug_init(struct mxt_data *data)
2526 struct mxt_info *info = data->info;
2527 struct mxt_dbg *dbg = &data->dbg;
2528 struct mxt_object *object;
2531 object = mxt_get_object(data, MXT_GEN_COMMAND_T6);
2535 dbg->diag_cmd_address = object->start_address + MXT_COMMAND_DIAGNOSTIC;
2537 object = mxt_get_object(data, MXT_DEBUG_DIAGNOSTIC_T37);
2541 if (mxt_obj_size(object) != sizeof(struct t37_debug)) {
2542 dev_warn(&data->client->dev, "Bad T37 size");
2546 dbg->t37_address = object->start_address;
2548 /* Calculate size of data and allocate buffer */
2549 dbg->t37_nodes = data->xsize * data->ysize;
2551 if (info->family_id == MXT_FAMILY_1386)
2552 dbg->t37_pages = MXT1386_COLUMNS * MXT1386_PAGES_PER_COLUMN;
2554 dbg->t37_pages = DIV_ROUND_UP(data->xsize *
2555 info->matrix_ysize *
2557 sizeof(dbg->t37_buf->data));
2559 dbg->t37_buf = devm_kmalloc_array(&data->client->dev, dbg->t37_pages,
2560 sizeof(struct t37_debug), GFP_KERNEL);
2564 /* init channel to zero */
2565 mxt_set_input(data, 0);
2567 /* register video device */
2568 snprintf(dbg->v4l2.name, sizeof(dbg->v4l2.name), "%s", "atmel_mxt_ts");
2569 error = v4l2_device_register(&data->client->dev, &dbg->v4l2);
2573 /* initialize the queue */
2574 mutex_init(&dbg->lock);
2575 dbg->queue = mxt_queue;
2576 dbg->queue.drv_priv = data;
2577 dbg->queue.lock = &dbg->lock;
2578 dbg->queue.dev = &data->client->dev;
2580 error = vb2_queue_init(&dbg->queue);
2582 goto error_unreg_v4l2;
2584 dbg->vdev = mxt_video_device;
2585 dbg->vdev.v4l2_dev = &dbg->v4l2;
2586 dbg->vdev.lock = &dbg->lock;
2587 dbg->vdev.vfl_dir = VFL_DIR_RX;
2588 dbg->vdev.queue = &dbg->queue;
2589 video_set_drvdata(&dbg->vdev, data);
2591 error = video_register_device(&dbg->vdev, VFL_TYPE_TOUCH, -1);
2593 goto error_unreg_v4l2;
2598 v4l2_device_unregister(&dbg->v4l2);
2600 dev_warn(&data->client->dev, "Error initializing T37\n");
2603 static void mxt_debug_init(struct mxt_data *data)
2608 static int mxt_configure_objects(struct mxt_data *data,
2609 const struct firmware *cfg)
2611 struct device *dev = &data->client->dev;
2614 error = mxt_init_t7_power_cfg(data);
2616 dev_err(dev, "Failed to initialize power cfg\n");
2621 error = mxt_update_cfg(data, cfg);
2623 dev_warn(dev, "Error %d updating config\n", error);
2626 if (data->multitouch) {
2627 error = mxt_initialize_input_device(data);
2631 dev_warn(dev, "No touch object detected\n");
2634 mxt_debug_init(data);
2639 /* Firmware Version is returned as Major.Minor.Build */
2640 static ssize_t mxt_fw_version_show(struct device *dev,
2641 struct device_attribute *attr, char *buf)
2643 struct mxt_data *data = dev_get_drvdata(dev);
2644 struct mxt_info *info = data->info;
2645 return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
2646 info->version >> 4, info->version & 0xf, info->build);
2649 /* Hardware Version is returned as FamilyID.VariantID */
2650 static ssize_t mxt_hw_version_show(struct device *dev,
2651 struct device_attribute *attr, char *buf)
2653 struct mxt_data *data = dev_get_drvdata(dev);
2654 struct mxt_info *info = data->info;
2655 return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
2656 info->family_id, info->variant_id);
2659 static ssize_t mxt_show_instance(char *buf, int count,
2660 struct mxt_object *object, int instance,
2665 if (mxt_obj_instances(object) > 1)
2666 count += scnprintf(buf + count, PAGE_SIZE - count,
2667 "Instance %u\n", instance);
2669 for (i = 0; i < mxt_obj_size(object); i++)
2670 count += scnprintf(buf + count, PAGE_SIZE - count,
2671 "\t[%2u]: %02x (%d)\n", i, val[i], val[i]);
2672 count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
2677 static ssize_t mxt_object_show(struct device *dev,
2678 struct device_attribute *attr, char *buf)
2680 struct mxt_data *data = dev_get_drvdata(dev);
2681 struct mxt_object *object;
2687 /* Pre-allocate buffer large enough to hold max sized object. */
2688 obuf = kmalloc(256, GFP_KERNEL);
2693 for (i = 0; i < data->info->object_num; i++) {
2694 object = data->object_table + i;
2696 if (!mxt_object_readable(object->type))
2699 count += scnprintf(buf + count, PAGE_SIZE - count,
2700 "T%u:\n", object->type);
2702 for (j = 0; j < mxt_obj_instances(object); j++) {
2703 u16 size = mxt_obj_size(object);
2704 u16 addr = object->start_address + j * size;
2706 error = __mxt_read_reg(data->client, addr, size, obuf);
2710 count = mxt_show_instance(buf, count, object, j, obuf);
2716 return error ?: count;
2719 static int mxt_check_firmware_format(struct device *dev,
2720 const struct firmware *fw)
2722 unsigned int pos = 0;
2725 while (pos < fw->size) {
2726 c = *(fw->data + pos);
2728 if (c < '0' || (c > '9' && c < 'A') || c > 'F')
2735 * To convert file try:
2736 * xxd -r -p mXTXXX__APP_VX-X-XX.enc > maxtouch.fw
2738 dev_err(dev, "Aborting: firmware file must be in binary format\n");
2743 static int mxt_load_fw(struct device *dev, const char *fn)
2745 struct mxt_data *data = dev_get_drvdata(dev);
2746 const struct firmware *fw = NULL;
2747 unsigned int frame_size;
2748 unsigned int pos = 0;
2749 unsigned int retry = 0;
2750 unsigned int frame = 0;
2753 ret = request_firmware(&fw, fn, dev);
2755 dev_err(dev, "Unable to open firmware %s\n", fn);
2759 /* Check for incorrect enc file */
2760 ret = mxt_check_firmware_format(dev, fw);
2762 goto release_firmware;
2764 if (!data->in_bootloader) {
2765 /* Change to the bootloader mode */
2766 data->in_bootloader = true;
2768 ret = mxt_t6_command(data, MXT_COMMAND_RESET,
2769 MXT_BOOT_VALUE, false);
2771 goto release_firmware;
2773 msleep(MXT_RESET_TIME);
2775 /* Do not need to scan since we know family ID */
2776 ret = mxt_lookup_bootloader_address(data, 0);
2778 goto release_firmware;
2780 mxt_free_input_device(data);
2781 mxt_free_object_table(data);
2783 enable_irq(data->irq);
2786 reinit_completion(&data->bl_completion);
2788 ret = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD, false);
2790 /* Bootloader may still be unlocked from previous attempt */
2791 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, false);
2795 dev_info(dev, "Unlocking bootloader\n");
2797 /* Unlock bootloader */
2798 ret = mxt_send_bootloader_cmd(data, true);
2803 while (pos < fw->size) {
2804 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, true);
2808 frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
2810 /* Take account of CRC bytes */
2813 /* Write one frame to device */
2814 ret = mxt_bootloader_write(data, fw->data + pos, frame_size);
2818 ret = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS, true);
2822 /* Back off by 20ms per retry */
2826 dev_err(dev, "Retry count exceeded\n");
2835 if (frame % 50 == 0)
2836 dev_dbg(dev, "Sent %d frames, %d/%zd bytes\n",
2837 frame, pos, fw->size);
2840 /* Wait for flash. */
2841 ret = mxt_wait_for_completion(data, &data->bl_completion,
2846 dev_dbg(dev, "Sent %d frames, %d bytes\n", frame, pos);
2849 * Wait for device to reset. Some bootloader versions do not assert
2850 * the CHG line after bootloading has finished, so ignore potential
2853 mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME);
2855 data->in_bootloader = false;
2858 disable_irq(data->irq);
2860 release_firmware(fw);
2864 static ssize_t mxt_update_fw_store(struct device *dev,
2865 struct device_attribute *attr,
2866 const char *buf, size_t count)
2868 struct mxt_data *data = dev_get_drvdata(dev);
2871 error = mxt_load_fw(dev, MXT_FW_NAME);
2873 dev_err(dev, "The firmware update failed(%d)\n", error);
2876 dev_info(dev, "The firmware update succeeded\n");
2878 error = mxt_initialize(data);
2886 static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
2887 static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
2888 static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
2889 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
2891 static struct attribute *mxt_attrs[] = {
2892 &dev_attr_fw_version.attr,
2893 &dev_attr_hw_version.attr,
2894 &dev_attr_object.attr,
2895 &dev_attr_update_fw.attr,
2899 static const struct attribute_group mxt_attr_group = {
2903 static void mxt_start(struct mxt_data *data)
2905 switch (data->pdata->suspend_mode) {
2906 case MXT_SUSPEND_T9_CTRL:
2907 mxt_soft_reset(data);
2910 /* 0x83 = SCANEN | RPTEN | ENABLE */
2911 mxt_write_object(data,
2912 MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0x83);
2915 case MXT_SUSPEND_DEEP_SLEEP:
2917 mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
2919 /* Recalibrate since chip has been in deep sleep */
2920 mxt_t6_command(data, MXT_COMMAND_CALIBRATE, 1, false);
2926 static void mxt_stop(struct mxt_data *data)
2928 switch (data->pdata->suspend_mode) {
2929 case MXT_SUSPEND_T9_CTRL:
2931 mxt_write_object(data,
2932 MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0);
2935 case MXT_SUSPEND_DEEP_SLEEP:
2937 mxt_set_t7_power_cfg(data, MXT_POWER_CFG_DEEPSLEEP);
2942 static int mxt_input_open(struct input_dev *dev)
2944 struct mxt_data *data = input_get_drvdata(dev);
2951 static void mxt_input_close(struct input_dev *dev)
2953 struct mxt_data *data = input_get_drvdata(dev);
2959 static const struct mxt_platform_data *mxt_parse_dt(struct i2c_client *client)
2961 struct mxt_platform_data *pdata;
2962 struct device_node *np = client->dev.of_node;
2967 return ERR_PTR(-ENOENT);
2969 pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL);
2971 return ERR_PTR(-ENOMEM);
2973 if (of_find_property(np, "linux,gpio-keymap", &proplen)) {
2974 pdata->t19_num_keys = proplen / sizeof(u32);
2976 keymap = devm_kzalloc(&client->dev,
2977 pdata->t19_num_keys * sizeof(keymap[0]),
2980 return ERR_PTR(-ENOMEM);
2982 ret = of_property_read_u32_array(np, "linux,gpio-keymap",
2983 keymap, pdata->t19_num_keys);
2985 dev_warn(&client->dev,
2986 "Couldn't read linux,gpio-keymap: %d\n", ret);
2988 pdata->t19_keymap = keymap;
2991 pdata->suspend_mode = MXT_SUSPEND_DEEP_SLEEP;
2996 static const struct mxt_platform_data *mxt_parse_dt(struct i2c_client *client)
2998 return ERR_PTR(-ENOENT);
3004 struct mxt_acpi_platform_data {
3006 struct mxt_platform_data pdata;
3009 static unsigned int samus_touchpad_buttons[] = {
3016 static struct mxt_acpi_platform_data samus_platform_data[] = {
3021 .t19_num_keys = ARRAY_SIZE(samus_touchpad_buttons),
3022 .t19_keymap = samus_touchpad_buttons,
3032 static unsigned int chromebook_tp_buttons[] = {
3041 static struct mxt_acpi_platform_data chromebook_platform_data[] = {
3046 .t19_num_keys = ARRAY_SIZE(chromebook_tp_buttons),
3047 .t19_keymap = chromebook_tp_buttons,
3057 static const struct dmi_system_id mxt_dmi_table[] = {
3059 /* 2015 Google Pixel */
3060 .ident = "Chromebook Pixel 2",
3062 DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
3063 DMI_MATCH(DMI_PRODUCT_NAME, "Samus"),
3065 .driver_data = samus_platform_data,
3068 /* Samsung Chromebook Pro */
3069 .ident = "Samsung Chromebook Pro",
3071 DMI_MATCH(DMI_SYS_VENDOR, "Google"),
3072 DMI_MATCH(DMI_PRODUCT_NAME, "Caroline"),
3074 .driver_data = samus_platform_data,
3077 /* Other Google Chromebooks */
3078 .ident = "Chromebook",
3080 DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
3082 .driver_data = chromebook_platform_data,
3087 static const struct mxt_platform_data *mxt_parse_acpi(struct i2c_client *client)
3089 struct acpi_device *adev;
3090 const struct dmi_system_id *system_id;
3091 const struct mxt_acpi_platform_data *acpi_pdata;
3094 * Ignore ACPI devices representing bootloader mode.
3096 * This is a bit of a hack: Google Chromebook BIOS creates ACPI
3097 * devices for both application and bootloader modes, but we are
3098 * interested in application mode only (if device is in bootloader
3099 * mode we'll end up switching into application anyway). So far
3100 * application mode addresses were all above 0x40, so we'll use it
3103 if (client->addr < 0x40)
3104 return ERR_PTR(-ENXIO);
3106 adev = ACPI_COMPANION(&client->dev);
3108 return ERR_PTR(-ENOENT);
3110 system_id = dmi_first_match(mxt_dmi_table);
3112 return ERR_PTR(-ENOENT);
3114 acpi_pdata = system_id->driver_data;
3116 return ERR_PTR(-ENOENT);
3118 while (acpi_pdata->hid) {
3119 if (!strcmp(acpi_device_hid(adev), acpi_pdata->hid))
3120 return &acpi_pdata->pdata;
3125 return ERR_PTR(-ENOENT);
3128 static const struct mxt_platform_data *mxt_parse_acpi(struct i2c_client *client)
3130 return ERR_PTR(-ENOENT);
3134 static const struct mxt_platform_data *
3135 mxt_get_platform_data(struct i2c_client *client)
3137 const struct mxt_platform_data *pdata;
3139 pdata = dev_get_platdata(&client->dev);
3143 pdata = mxt_parse_dt(client);
3144 if (!IS_ERR(pdata) || PTR_ERR(pdata) != -ENOENT)
3147 pdata = mxt_parse_acpi(client);
3148 if (!IS_ERR(pdata) || PTR_ERR(pdata) != -ENOENT)
3151 dev_err(&client->dev, "No platform data specified\n");
3152 return ERR_PTR(-EINVAL);
3155 static int mxt_probe(struct i2c_client *client, const struct i2c_device_id *id)
3157 struct mxt_data *data;
3158 const struct mxt_platform_data *pdata;
3161 pdata = mxt_get_platform_data(client);
3163 return PTR_ERR(pdata);
3165 data = devm_kzalloc(&client->dev, sizeof(struct mxt_data), GFP_KERNEL);
3169 snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
3170 client->adapter->nr, client->addr);
3172 data->client = client;
3173 data->pdata = pdata;
3174 data->irq = client->irq;
3175 i2c_set_clientdata(client, data);
3177 init_completion(&data->bl_completion);
3178 init_completion(&data->reset_completion);
3179 init_completion(&data->crc_completion);
3181 data->reset_gpio = devm_gpiod_get_optional(&client->dev,
3182 "reset", GPIOD_OUT_LOW);
3183 if (IS_ERR(data->reset_gpio)) {
3184 error = PTR_ERR(data->reset_gpio);
3185 dev_err(&client->dev, "Failed to get reset gpio: %d\n", error);
3189 error = devm_request_threaded_irq(&client->dev, client->irq,
3190 NULL, mxt_interrupt,
3191 pdata->irqflags | IRQF_ONESHOT,
3192 client->name, data);
3194 dev_err(&client->dev, "Failed to register interrupt\n");
3198 if (data->reset_gpio) {
3199 data->in_bootloader = true;
3200 msleep(MXT_RESET_TIME);
3201 reinit_completion(&data->bl_completion);
3202 gpiod_set_value(data->reset_gpio, 1);
3203 error = mxt_wait_for_completion(data, &data->bl_completion,
3207 data->in_bootloader = false;
3210 disable_irq(client->irq);
3212 error = mxt_initialize(data);
3216 error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
3218 dev_err(&client->dev, "Failure %d creating sysfs group\n",
3220 goto err_free_object;
3226 mxt_free_input_device(data);
3227 mxt_free_object_table(data);
3231 static int mxt_remove(struct i2c_client *client)
3233 struct mxt_data *data = i2c_get_clientdata(client);
3235 disable_irq(data->irq);
3236 sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
3237 mxt_free_input_device(data);
3238 mxt_free_object_table(data);
3243 static int __maybe_unused mxt_suspend(struct device *dev)
3245 struct i2c_client *client = to_i2c_client(dev);
3246 struct mxt_data *data = i2c_get_clientdata(client);
3247 struct input_dev *input_dev = data->input_dev;
3252 mutex_lock(&input_dev->mutex);
3254 if (input_dev->users)
3257 mutex_unlock(&input_dev->mutex);
3262 static int __maybe_unused mxt_resume(struct device *dev)
3264 struct i2c_client *client = to_i2c_client(dev);
3265 struct mxt_data *data = i2c_get_clientdata(client);
3266 struct input_dev *input_dev = data->input_dev;
3271 mutex_lock(&input_dev->mutex);
3273 if (input_dev->users)
3276 mutex_unlock(&input_dev->mutex);
3281 static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);
3283 static const struct of_device_id mxt_of_match[] = {
3284 { .compatible = "atmel,maxtouch", },
3285 /* Compatibles listed below are deprecated */
3286 { .compatible = "atmel,qt602240_ts", },
3287 { .compatible = "atmel,atmel_mxt_ts", },
3288 { .compatible = "atmel,atmel_mxt_tp", },
3289 { .compatible = "atmel,mXT224", },
3292 MODULE_DEVICE_TABLE(of, mxt_of_match);
3295 static const struct acpi_device_id mxt_acpi_id[] = {
3296 { "ATML0000", 0 }, /* Touchpad */
3297 { "ATML0001", 0 }, /* Touchscreen */
3300 MODULE_DEVICE_TABLE(acpi, mxt_acpi_id);
3303 static const struct i2c_device_id mxt_id[] = {
3304 { "qt602240_ts", 0 },
3305 { "atmel_mxt_ts", 0 },
3306 { "atmel_mxt_tp", 0 },
3311 MODULE_DEVICE_TABLE(i2c, mxt_id);
3313 static struct i2c_driver mxt_driver = {
3315 .name = "atmel_mxt_ts",
3316 .of_match_table = of_match_ptr(mxt_of_match),
3317 .acpi_match_table = ACPI_PTR(mxt_acpi_id),
3321 .remove = mxt_remove,
3325 module_i2c_driver(mxt_driver);
3327 /* Module information */
3328 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
3329 MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
3330 MODULE_LICENSE("GPL");