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/input/mt.h>
27 #include <linux/interrupt.h>
29 #include <linux/property.h>
30 #include <linux/slab.h>
31 #include <linux/gpio/consumer.h>
32 #include <linux/property.h>
33 #include <asm/unaligned.h>
34 #include <media/v4l2-device.h>
35 #include <media/v4l2-ioctl.h>
36 #include <media/videobuf2-v4l2.h>
37 #include <media/videobuf2-vmalloc.h>
40 #define MXT_FW_NAME "maxtouch.fw"
41 #define MXT_CFG_NAME "maxtouch.cfg"
42 #define MXT_CFG_MAGIC "OBP_RAW V1"
45 #define MXT_OBJECT_START 0x07
46 #define MXT_OBJECT_SIZE 6
47 #define MXT_INFO_CHECKSUM_SIZE 3
48 #define MXT_MAX_BLOCK_WRITE 256
51 #define MXT_DEBUG_DIAGNOSTIC_T37 37
52 #define MXT_GEN_MESSAGE_T5 5
53 #define MXT_GEN_COMMAND_T6 6
54 #define MXT_GEN_POWER_T7 7
55 #define MXT_GEN_ACQUIRE_T8 8
56 #define MXT_GEN_DATASOURCE_T53 53
57 #define MXT_TOUCH_MULTI_T9 9
58 #define MXT_TOUCH_KEYARRAY_T15 15
59 #define MXT_TOUCH_PROXIMITY_T23 23
60 #define MXT_TOUCH_PROXKEY_T52 52
61 #define MXT_PROCI_GRIPFACE_T20 20
62 #define MXT_PROCG_NOISE_T22 22
63 #define MXT_PROCI_ONETOUCH_T24 24
64 #define MXT_PROCI_TWOTOUCH_T27 27
65 #define MXT_PROCI_GRIP_T40 40
66 #define MXT_PROCI_PALM_T41 41
67 #define MXT_PROCI_TOUCHSUPPRESSION_T42 42
68 #define MXT_PROCI_STYLUS_T47 47
69 #define MXT_PROCG_NOISESUPPRESSION_T48 48
70 #define MXT_SPT_COMMSCONFIG_T18 18
71 #define MXT_SPT_GPIOPWM_T19 19
72 #define MXT_SPT_SELFTEST_T25 25
73 #define MXT_SPT_CTECONFIG_T28 28
74 #define MXT_SPT_USERDATA_T38 38
75 #define MXT_SPT_DIGITIZER_T43 43
76 #define MXT_SPT_MESSAGECOUNT_T44 44
77 #define MXT_SPT_CTECONFIG_T46 46
78 #define MXT_TOUCH_MULTITOUCHSCREEN_T100 100
80 /* MXT_GEN_MESSAGE_T5 object */
81 #define MXT_RPTID_NOMSG 0xff
83 /* MXT_GEN_COMMAND_T6 field */
84 #define MXT_COMMAND_RESET 0
85 #define MXT_COMMAND_BACKUPNV 1
86 #define MXT_COMMAND_CALIBRATE 2
87 #define MXT_COMMAND_REPORTALL 3
88 #define MXT_COMMAND_DIAGNOSTIC 5
90 /* Define for T6 status byte */
91 #define MXT_T6_STATUS_RESET BIT(7)
92 #define MXT_T6_STATUS_OFL BIT(6)
93 #define MXT_T6_STATUS_SIGERR BIT(5)
94 #define MXT_T6_STATUS_CAL BIT(4)
95 #define MXT_T6_STATUS_CFGERR BIT(3)
96 #define MXT_T6_STATUS_COMSERR BIT(2)
98 /* MXT_GEN_POWER_T7 field */
104 #define MXT_POWER_CFG_RUN 0
105 #define MXT_POWER_CFG_DEEPSLEEP 1
107 /* MXT_TOUCH_MULTI_T9 field */
108 #define MXT_T9_CTRL 0
109 #define MXT_T9_XSIZE 3
110 #define MXT_T9_YSIZE 4
111 #define MXT_T9_ORIENT 9
112 #define MXT_T9_RANGE 18
114 /* MXT_TOUCH_MULTI_T9 status */
115 #define MXT_T9_UNGRIP BIT(0)
116 #define MXT_T9_SUPPRESS BIT(1)
117 #define MXT_T9_AMP BIT(2)
118 #define MXT_T9_VECTOR BIT(3)
119 #define MXT_T9_MOVE BIT(4)
120 #define MXT_T9_RELEASE BIT(5)
121 #define MXT_T9_PRESS BIT(6)
122 #define MXT_T9_DETECT BIT(7)
129 /* MXT_TOUCH_MULTI_T9 orient */
130 #define MXT_T9_ORIENT_SWITCH BIT(0)
131 #define MXT_T9_ORIENT_INVERTX BIT(1)
132 #define MXT_T9_ORIENT_INVERTY BIT(2)
134 /* MXT_SPT_COMMSCONFIG_T18 */
135 #define MXT_COMMS_CTRL 0
136 #define MXT_COMMS_CMD 1
138 /* MXT_DEBUG_DIAGNOSTIC_T37 */
139 #define MXT_DIAGNOSTIC_PAGEUP 0x01
140 #define MXT_DIAGNOSTIC_DELTAS 0x10
141 #define MXT_DIAGNOSTIC_REFS 0x11
142 #define MXT_DIAGNOSTIC_SIZE 128
144 #define MXT_FAMILY_1386 160
145 #define MXT1386_COLUMNS 3
146 #define MXT1386_PAGES_PER_COLUMN 8
149 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
152 u8 data[MXT_DIAGNOSTIC_SIZE];
156 /* Define for MXT_GEN_COMMAND_T6 */
157 #define MXT_BOOT_VALUE 0xa5
158 #define MXT_RESET_VALUE 0x01
159 #define MXT_BACKUP_VALUE 0x55
161 /* T100 Multiple Touch Touchscreen */
162 #define MXT_T100_CTRL 0
163 #define MXT_T100_CFG1 1
164 #define MXT_T100_TCHAUX 3
165 #define MXT_T100_XSIZE 9
166 #define MXT_T100_XRANGE 13
167 #define MXT_T100_YSIZE 20
168 #define MXT_T100_YRANGE 24
170 #define MXT_T100_CFG_SWITCHXY BIT(5)
171 #define MXT_T100_CFG_INVERTY BIT(6)
172 #define MXT_T100_CFG_INVERTX BIT(7)
174 #define MXT_T100_TCHAUX_VECT BIT(0)
175 #define MXT_T100_TCHAUX_AMPL BIT(1)
176 #define MXT_T100_TCHAUX_AREA BIT(2)
178 #define MXT_T100_DETECT BIT(7)
179 #define MXT_T100_TYPE_MASK 0x70
182 MXT_T100_TYPE_FINGER = 1,
183 MXT_T100_TYPE_PASSIVE_STYLUS = 2,
184 MXT_T100_TYPE_HOVERING_FINGER = 4,
185 MXT_T100_TYPE_GLOVE = 5,
186 MXT_T100_TYPE_LARGE_TOUCH = 6,
189 #define MXT_DISTANCE_ACTIVE_TOUCH 0
190 #define MXT_DISTANCE_HOVERING 1
192 #define MXT_TOUCH_MAJOR_DEFAULT 1
193 #define MXT_PRESSURE_DEFAULT 1
196 #define MXT_BACKUP_TIME 50 /* msec */
197 #define MXT_RESET_GPIO_TIME 20 /* msec */
198 #define MXT_RESET_INVALID_CHG 100 /* msec */
199 #define MXT_RESET_TIME 200 /* msec */
200 #define MXT_RESET_TIMEOUT 3000 /* msec */
201 #define MXT_CRC_TIMEOUT 1000 /* msec */
202 #define MXT_FW_RESET_TIME 3000 /* msec */
203 #define MXT_FW_CHG_TIMEOUT 300 /* msec */
205 /* Command to unlock bootloader */
206 #define MXT_UNLOCK_CMD_MSB 0xaa
207 #define MXT_UNLOCK_CMD_LSB 0xdc
209 /* Bootloader mode status */
210 #define MXT_WAITING_BOOTLOAD_CMD 0xc0 /* valid 7 6 bit only */
211 #define MXT_WAITING_FRAME_DATA 0x80 /* valid 7 6 bit only */
212 #define MXT_FRAME_CRC_CHECK 0x02
213 #define MXT_FRAME_CRC_FAIL 0x03
214 #define MXT_FRAME_CRC_PASS 0x04
215 #define MXT_APP_CRC_FAIL 0x40 /* valid 7 8 bit only */
216 #define MXT_BOOT_STATUS_MASK 0x3f
217 #define MXT_BOOT_EXTENDED_ID BIT(5)
218 #define MXT_BOOT_ID_MASK 0x1f
220 /* Touchscreen absolute values */
221 #define MXT_MAX_AREA 0xff
223 #define MXT_PIXELS_PER_MM 20
239 u8 instances_minus_one;
245 u16 diag_cmd_address;
246 struct t37_debug *t37_buf;
247 unsigned int t37_pages;
248 unsigned int t37_nodes;
250 struct v4l2_device v4l2;
251 struct v4l2_pix_format format;
252 struct video_device vdev;
253 struct vb2_queue queue;
258 enum v4l_dbg_inputs {
259 MXT_V4L_INPUT_DELTAS,
264 static const struct v4l2_file_operations mxt_video_fops = {
265 .owner = THIS_MODULE,
266 .open = v4l2_fh_open,
267 .release = vb2_fop_release,
268 .unlocked_ioctl = video_ioctl2,
269 .read = vb2_fop_read,
270 .mmap = vb2_fop_mmap,
271 .poll = vb2_fop_poll,
274 enum mxt_suspend_mode {
275 MXT_SUSPEND_DEEP_SLEEP = 0,
276 MXT_SUSPEND_T9_CTRL = 1,
279 /* Each client has this additional data */
281 struct i2c_client *client;
282 struct input_dev *input_dev;
283 char phys[64]; /* device physical location */
284 struct mxt_object *object_table;
285 struct mxt_info *info;
286 void *raw_info_block;
307 u8 last_message_count;
310 struct t7_config t7_cfg;
312 struct gpio_desc *reset_gpio;
314 /* Cached parameters from object table */
324 u8 T100_reportid_min;
325 u8 T100_reportid_max;
327 /* for fw update in bootloader */
328 struct completion bl_completion;
330 /* for reset handling */
331 struct completion reset_completion;
333 /* for config update handling */
334 struct completion crc_completion;
337 unsigned int t19_num_keys;
339 enum mxt_suspend_mode suspend_mode;
342 struct mxt_vb2_buffer {
343 struct vb2_buffer vb;
344 struct list_head list;
347 static size_t mxt_obj_size(const struct mxt_object *obj)
349 return obj->size_minus_one + 1;
352 static size_t mxt_obj_instances(const struct mxt_object *obj)
354 return obj->instances_minus_one + 1;
357 static bool mxt_object_readable(unsigned int type)
360 case MXT_GEN_COMMAND_T6:
361 case MXT_GEN_POWER_T7:
362 case MXT_GEN_ACQUIRE_T8:
363 case MXT_GEN_DATASOURCE_T53:
364 case MXT_TOUCH_MULTI_T9:
365 case MXT_TOUCH_KEYARRAY_T15:
366 case MXT_TOUCH_PROXIMITY_T23:
367 case MXT_TOUCH_PROXKEY_T52:
368 case MXT_TOUCH_MULTITOUCHSCREEN_T100:
369 case MXT_PROCI_GRIPFACE_T20:
370 case MXT_PROCG_NOISE_T22:
371 case MXT_PROCI_ONETOUCH_T24:
372 case MXT_PROCI_TWOTOUCH_T27:
373 case MXT_PROCI_GRIP_T40:
374 case MXT_PROCI_PALM_T41:
375 case MXT_PROCI_TOUCHSUPPRESSION_T42:
376 case MXT_PROCI_STYLUS_T47:
377 case MXT_PROCG_NOISESUPPRESSION_T48:
378 case MXT_SPT_COMMSCONFIG_T18:
379 case MXT_SPT_GPIOPWM_T19:
380 case MXT_SPT_SELFTEST_T25:
381 case MXT_SPT_CTECONFIG_T28:
382 case MXT_SPT_USERDATA_T38:
383 case MXT_SPT_DIGITIZER_T43:
384 case MXT_SPT_CTECONFIG_T46:
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 complete(&data->crc_completion);
717 if (crc != data->config_crc) {
718 data->config_crc = crc;
719 dev_dbg(dev, "T6 Config Checksum: 0x%06X\n", crc);
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);
831 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 1);
832 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
833 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
834 input_report_abs(input_dev, ABS_MT_PRESSURE, amplitude);
835 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
837 /* Touch no longer active, close out slot */
838 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 0);
841 data->update_input = true;
844 static void mxt_proc_t100_message(struct mxt_data *data, u8 *message)
846 struct device *dev = &data->client->dev;
847 struct input_dev *input_dev = data->input_dev;
859 id = message[0] - data->T100_reportid_min - 2;
861 /* ignore SCRSTATUS events */
866 x = get_unaligned_le16(&message[2]);
867 y = get_unaligned_le16(&message[4]);
869 if (status & MXT_T100_DETECT) {
870 type = (status & MXT_T100_TYPE_MASK) >> 4;
873 case MXT_T100_TYPE_HOVERING_FINGER:
874 tool = MT_TOOL_FINGER;
875 distance = MXT_DISTANCE_HOVERING;
877 if (data->t100_aux_vect)
878 orientation = message[data->t100_aux_vect];
882 case MXT_T100_TYPE_FINGER:
883 case MXT_T100_TYPE_GLOVE:
884 tool = MT_TOOL_FINGER;
885 distance = MXT_DISTANCE_ACTIVE_TOUCH;
887 if (data->t100_aux_area)
888 major = message[data->t100_aux_area];
890 if (data->t100_aux_ampl)
891 pressure = message[data->t100_aux_ampl];
893 if (data->t100_aux_vect)
894 orientation = message[data->t100_aux_vect];
898 case MXT_T100_TYPE_PASSIVE_STYLUS:
902 * Passive stylus is reported with size zero so
905 major = MXT_TOUCH_MAJOR_DEFAULT;
907 if (data->t100_aux_ampl)
908 pressure = message[data->t100_aux_ampl];
912 case MXT_T100_TYPE_LARGE_TOUCH:
913 /* Ignore suppressed touch */
917 dev_dbg(dev, "Unexpected T100 type\n");
923 * Values reported should be non-zero if tool is touching the
926 if (!pressure && type != MXT_T100_TYPE_HOVERING_FINGER)
927 pressure = MXT_PRESSURE_DEFAULT;
929 input_mt_slot(input_dev, id);
931 if (status & MXT_T100_DETECT) {
932 dev_dbg(dev, "[%u] type:%u x:%u y:%u a:%02X p:%02X v:%02X\n",
933 id, type, x, y, major, pressure, orientation);
935 input_mt_report_slot_state(input_dev, tool, 1);
936 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
937 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
938 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, major);
939 input_report_abs(input_dev, ABS_MT_PRESSURE, pressure);
940 input_report_abs(input_dev, ABS_MT_DISTANCE, distance);
941 input_report_abs(input_dev, ABS_MT_ORIENTATION, orientation);
943 dev_dbg(dev, "[%u] release\n", id);
946 input_mt_report_slot_state(input_dev, 0, 0);
949 data->update_input = true;
952 static int mxt_proc_message(struct mxt_data *data, u8 *message)
954 u8 report_id = message[0];
956 if (report_id == MXT_RPTID_NOMSG)
959 if (report_id == data->T6_reportid) {
960 mxt_proc_t6_messages(data, message);
961 } else if (!data->input_dev) {
963 * Do not report events if input device
964 * is not yet registered.
966 mxt_dump_message(data, message);
967 } else if (report_id >= data->T9_reportid_min &&
968 report_id <= data->T9_reportid_max) {
969 mxt_proc_t9_message(data, message);
970 } else if (report_id >= data->T100_reportid_min &&
971 report_id <= data->T100_reportid_max) {
972 mxt_proc_t100_message(data, message);
973 } else if (report_id == data->T19_reportid) {
974 mxt_input_button(data, message);
975 data->update_input = true;
977 mxt_dump_message(data, message);
983 static int mxt_read_and_process_messages(struct mxt_data *data, u8 count)
985 struct device *dev = &data->client->dev;
990 /* Safety check for msg_buf */
991 if (count > data->max_reportid)
994 /* Process remaining messages if necessary */
995 ret = __mxt_read_reg(data->client, data->T5_address,
996 data->T5_msg_size * count, data->msg_buf);
998 dev_err(dev, "Failed to read %u messages (%d)\n", count, ret);
1002 for (i = 0; i < count; i++) {
1003 ret = mxt_proc_message(data,
1004 data->msg_buf + data->T5_msg_size * i);
1010 /* return number of messages read */
1014 static irqreturn_t mxt_process_messages_t44(struct mxt_data *data)
1016 struct device *dev = &data->client->dev;
1020 /* Read T44 and T5 together */
1021 ret = __mxt_read_reg(data->client, data->T44_address,
1022 data->T5_msg_size + 1, data->msg_buf);
1024 dev_err(dev, "Failed to read T44 and T5 (%d)\n", ret);
1028 count = data->msg_buf[0];
1031 * This condition may be caused by the CHG line being configured in
1032 * Mode 0. It results in unnecessary I2C operations but it is benign.
1037 if (count > data->max_reportid) {
1038 dev_warn(dev, "T44 count %d exceeded max report id\n", count);
1039 count = data->max_reportid;
1042 /* Process first message */
1043 ret = mxt_proc_message(data, data->msg_buf + 1);
1045 dev_warn(dev, "Unexpected invalid message\n");
1049 num_left = count - 1;
1051 /* Process remaining messages if necessary */
1053 ret = mxt_read_and_process_messages(data, num_left);
1056 else if (ret != num_left)
1057 dev_warn(dev, "Unexpected invalid message\n");
1061 if (data->update_input) {
1062 mxt_input_sync(data);
1063 data->update_input = false;
1069 static int mxt_process_messages_until_invalid(struct mxt_data *data)
1071 struct device *dev = &data->client->dev;
1075 count = data->max_reportid;
1077 /* Read messages until we force an invalid */
1079 read = mxt_read_and_process_messages(data, count);
1084 if (data->update_input) {
1085 mxt_input_sync(data);
1086 data->update_input = false;
1089 dev_err(dev, "CHG pin isn't cleared\n");
1093 static irqreturn_t mxt_process_messages(struct mxt_data *data)
1095 int total_handled, num_handled;
1096 u8 count = data->last_message_count;
1098 if (count < 1 || count > data->max_reportid)
1101 /* include final invalid message */
1102 total_handled = mxt_read_and_process_messages(data, count + 1);
1103 if (total_handled < 0)
1105 /* if there were invalid messages, then we are done */
1106 else if (total_handled <= count)
1109 /* keep reading two msgs until one is invalid or reportid limit */
1111 num_handled = mxt_read_and_process_messages(data, 2);
1112 if (num_handled < 0)
1115 total_handled += num_handled;
1117 if (num_handled < 2)
1119 } while (total_handled < data->num_touchids);
1122 data->last_message_count = total_handled;
1124 if (data->update_input) {
1125 mxt_input_sync(data);
1126 data->update_input = false;
1132 static irqreturn_t mxt_interrupt(int irq, void *dev_id)
1134 struct mxt_data *data = dev_id;
1136 if (data->in_bootloader) {
1137 /* bootloader state transition completion */
1138 complete(&data->bl_completion);
1142 if (!data->object_table)
1145 if (data->T44_address) {
1146 return mxt_process_messages_t44(data);
1148 return mxt_process_messages(data);
1152 static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset,
1153 u8 value, bool wait)
1156 u8 command_register;
1157 int timeout_counter = 0;
1160 reg = data->T6_address + cmd_offset;
1162 ret = mxt_write_reg(data->client, reg, value);
1171 ret = __mxt_read_reg(data->client, reg, 1, &command_register);
1174 } while (command_register != 0 && timeout_counter++ <= 100);
1176 if (timeout_counter > 100) {
1177 dev_err(&data->client->dev, "Command failed!\n");
1184 static int mxt_acquire_irq(struct mxt_data *data)
1188 enable_irq(data->irq);
1190 error = mxt_process_messages_until_invalid(data);
1197 static int mxt_soft_reset(struct mxt_data *data)
1199 struct device *dev = &data->client->dev;
1202 dev_info(dev, "Resetting device\n");
1204 disable_irq(data->irq);
1206 reinit_completion(&data->reset_completion);
1208 ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false);
1212 /* Ignore CHG line for 100ms after reset */
1213 msleep(MXT_RESET_INVALID_CHG);
1215 mxt_acquire_irq(data);
1217 ret = mxt_wait_for_completion(data, &data->reset_completion,
1225 static void mxt_update_crc(struct mxt_data *data, u8 cmd, u8 value)
1228 * On failure, CRC is set to 0 and config will always be
1231 data->config_crc = 0;
1232 reinit_completion(&data->crc_completion);
1234 mxt_t6_command(data, cmd, value, true);
1237 * Wait for crc message. On failure, CRC is set to 0 and config will
1238 * always be downloaded.
1240 mxt_wait_for_completion(data, &data->crc_completion, MXT_CRC_TIMEOUT);
1243 static void mxt_calc_crc24(u32 *crc, u8 firstbyte, u8 secondbyte)
1245 static const unsigned int crcpoly = 0x80001B;
1249 data_word = (secondbyte << 8) | firstbyte;
1250 result = ((*crc << 1) ^ data_word);
1252 if (result & 0x1000000)
1258 static u32 mxt_calculate_crc(u8 *base, off_t start_off, off_t end_off)
1261 u8 *ptr = base + start_off;
1262 u8 *last_val = base + end_off - 1;
1264 if (end_off < start_off)
1267 while (ptr < last_val) {
1268 mxt_calc_crc24(&crc, *ptr, *(ptr + 1));
1272 /* if len is odd, fill the last byte with 0 */
1273 if (ptr == last_val)
1274 mxt_calc_crc24(&crc, *ptr, 0);
1276 /* Mask to 24-bit */
1282 static int mxt_prepare_cfg_mem(struct mxt_data *data,
1283 const struct firmware *cfg,
1284 unsigned int data_pos,
1285 unsigned int cfg_start_ofs,
1287 size_t config_mem_size)
1289 struct device *dev = &data->client->dev;
1290 struct mxt_object *object;
1291 unsigned int type, instance, size, byte_offset;
1298 while (data_pos < cfg->size) {
1299 /* Read type, instance, length */
1300 ret = sscanf(cfg->data + data_pos, "%x %x %x%n",
1301 &type, &instance, &size, &offset);
1305 } else if (ret != 3) {
1306 dev_err(dev, "Bad format: failed to parse object\n");
1311 object = mxt_get_object(data, type);
1314 for (i = 0; i < size; i++) {
1315 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1318 dev_err(dev, "Bad format in T%d at %d\n",
1327 if (size > mxt_obj_size(object)) {
1329 * Either we are in fallback mode due to wrong
1330 * config or config from a later fw version,
1331 * or the file is corrupt or hand-edited.
1333 dev_warn(dev, "Discarding %zu byte(s) in T%u\n",
1334 size - mxt_obj_size(object), type);
1335 } else if (mxt_obj_size(object) > size) {
1337 * If firmware is upgraded, new bytes may be added to
1338 * end of objects. It is generally forward compatible
1339 * to zero these bytes - previous behaviour will be
1340 * retained. However this does invalidate the CRC and
1341 * will force fallback mode until the configuration is
1342 * updated. We warn here but do nothing else - the
1343 * malloc has zeroed the entire configuration.
1345 dev_warn(dev, "Zeroing %zu byte(s) in T%d\n",
1346 mxt_obj_size(object) - size, type);
1349 if (instance >= mxt_obj_instances(object)) {
1350 dev_err(dev, "Object instances exceeded!\n");
1354 reg = object->start_address + mxt_obj_size(object) * instance;
1356 for (i = 0; i < size; i++) {
1357 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1361 dev_err(dev, "Bad format in T%d at %d\n",
1367 if (i > mxt_obj_size(object))
1370 byte_offset = reg + i - cfg_start_ofs;
1372 if (byte_offset >= 0 && byte_offset < config_mem_size) {
1373 *(config_mem + byte_offset) = val;
1375 dev_err(dev, "Bad object: reg:%d, T%d, ofs=%d\n",
1376 reg, object->type, byte_offset);
1385 static int mxt_upload_cfg_mem(struct mxt_data *data, unsigned int cfg_start,
1386 u8 *config_mem, size_t config_mem_size)
1388 unsigned int byte_offset = 0;
1391 /* Write configuration as blocks */
1392 while (byte_offset < config_mem_size) {
1393 unsigned int size = config_mem_size - byte_offset;
1395 if (size > MXT_MAX_BLOCK_WRITE)
1396 size = MXT_MAX_BLOCK_WRITE;
1398 error = __mxt_write_reg(data->client,
1399 cfg_start + byte_offset,
1400 size, config_mem + byte_offset);
1402 dev_err(&data->client->dev,
1403 "Config write error, ret=%d\n", error);
1407 byte_offset += size;
1413 static int mxt_init_t7_power_cfg(struct mxt_data *data);
1416 * mxt_update_cfg - download configuration to chip
1418 * Atmel Raw Config File Format
1420 * The first four lines of the raw config file contain:
1422 * 2) Chip ID Information (first 7 bytes of device memory)
1423 * 3) Chip Information Block 24-bit CRC Checksum
1424 * 4) Chip Configuration 24-bit CRC Checksum
1426 * The rest of the file consists of one line per object instance:
1427 * <TYPE> <INSTANCE> <SIZE> <CONTENTS>
1429 * <TYPE> - 2-byte object type as hex
1430 * <INSTANCE> - 2-byte object instance number as hex
1431 * <SIZE> - 2-byte object size as hex
1432 * <CONTENTS> - array of <SIZE> 1-byte hex values
1434 static int mxt_update_cfg(struct mxt_data *data, const struct firmware *cfg)
1436 struct device *dev = &data->client->dev;
1437 struct mxt_info cfg_info;
1443 u32 info_crc, config_crc, calculated_crc;
1445 size_t config_mem_size;
1447 mxt_update_crc(data, MXT_COMMAND_REPORTALL, 1);
1449 if (strncmp(cfg->data, MXT_CFG_MAGIC, strlen(MXT_CFG_MAGIC))) {
1450 dev_err(dev, "Unrecognised config file\n");
1454 data_pos = strlen(MXT_CFG_MAGIC);
1456 /* Load information block and check */
1457 for (i = 0; i < sizeof(struct mxt_info); i++) {
1458 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1459 (unsigned char *)&cfg_info + i,
1462 dev_err(dev, "Bad format\n");
1469 if (cfg_info.family_id != data->info->family_id) {
1470 dev_err(dev, "Family ID mismatch!\n");
1474 if (cfg_info.variant_id != data->info->variant_id) {
1475 dev_err(dev, "Variant ID mismatch!\n");
1480 ret = sscanf(cfg->data + data_pos, "%x%n", &info_crc, &offset);
1482 dev_err(dev, "Bad format: failed to parse Info CRC\n");
1487 ret = sscanf(cfg->data + data_pos, "%x%n", &config_crc, &offset);
1489 dev_err(dev, "Bad format: failed to parse Config CRC\n");
1495 * The Info Block CRC is calculated over mxt_info and the object
1496 * table. If it does not match then we are trying to load the
1497 * configuration from a different chip or firmware version, so
1498 * the configuration CRC is invalid anyway.
1500 if (info_crc == data->info_crc) {
1501 if (config_crc == 0 || data->config_crc == 0) {
1502 dev_info(dev, "CRC zero, attempting to apply config\n");
1503 } else if (config_crc == data->config_crc) {
1504 dev_dbg(dev, "Config CRC 0x%06X: OK\n",
1508 dev_info(dev, "Config CRC 0x%06X: does not match file 0x%06X\n",
1509 data->config_crc, config_crc);
1513 "Warning: Info CRC error - device=0x%06X file=0x%06X\n",
1514 data->info_crc, info_crc);
1517 /* Malloc memory to store configuration */
1518 cfg_start_ofs = MXT_OBJECT_START +
1519 data->info->object_num * sizeof(struct mxt_object) +
1520 MXT_INFO_CHECKSUM_SIZE;
1521 config_mem_size = data->mem_size - cfg_start_ofs;
1522 config_mem = kzalloc(config_mem_size, GFP_KERNEL);
1524 dev_err(dev, "Failed to allocate memory\n");
1528 ret = mxt_prepare_cfg_mem(data, cfg, data_pos, cfg_start_ofs,
1529 config_mem, config_mem_size);
1533 /* Calculate crc of the received configs (not the raw config file) */
1534 if (data->T7_address < cfg_start_ofs) {
1535 dev_err(dev, "Bad T7 address, T7addr = %x, config offset %x\n",
1536 data->T7_address, cfg_start_ofs);
1541 calculated_crc = mxt_calculate_crc(config_mem,
1542 data->T7_address - cfg_start_ofs,
1545 if (config_crc > 0 && config_crc != calculated_crc)
1546 dev_warn(dev, "Config CRC error, calculated=%06X, file=%06X\n",
1547 calculated_crc, config_crc);
1549 ret = mxt_upload_cfg_mem(data, cfg_start_ofs,
1550 config_mem, config_mem_size);
1554 mxt_update_crc(data, MXT_COMMAND_BACKUPNV, MXT_BACKUP_VALUE);
1556 ret = mxt_soft_reset(data);
1560 dev_info(dev, "Config successfully updated\n");
1562 /* T7 config may have changed */
1563 mxt_init_t7_power_cfg(data);
1570 static void mxt_free_input_device(struct mxt_data *data)
1572 if (data->input_dev) {
1573 input_unregister_device(data->input_dev);
1574 data->input_dev = NULL;
1578 static void mxt_free_object_table(struct mxt_data *data)
1580 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
1581 video_unregister_device(&data->dbg.vdev);
1582 v4l2_device_unregister(&data->dbg.v4l2);
1584 data->object_table = NULL;
1586 kfree(data->raw_info_block);
1587 data->raw_info_block = NULL;
1588 kfree(data->msg_buf);
1589 data->msg_buf = NULL;
1590 data->T5_address = 0;
1591 data->T5_msg_size = 0;
1592 data->T6_reportid = 0;
1593 data->T7_address = 0;
1594 data->T9_reportid_min = 0;
1595 data->T9_reportid_max = 0;
1596 data->T19_reportid = 0;
1597 data->T44_address = 0;
1598 data->T100_reportid_min = 0;
1599 data->T100_reportid_max = 0;
1600 data->max_reportid = 0;
1603 static int mxt_parse_object_table(struct mxt_data *data,
1604 struct mxt_object *object_table)
1606 struct i2c_client *client = data->client;
1611 /* Valid Report IDs start counting from 1 */
1614 for (i = 0; i < data->info->object_num; i++) {
1615 struct mxt_object *object = object_table + i;
1618 le16_to_cpus(&object->start_address);
1620 if (object->num_report_ids) {
1622 reportid += object->num_report_ids *
1623 mxt_obj_instances(object);
1624 max_id = reportid - 1;
1630 dev_dbg(&data->client->dev,
1631 "T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n",
1632 object->type, object->start_address,
1633 mxt_obj_size(object), mxt_obj_instances(object),
1636 switch (object->type) {
1637 case MXT_GEN_MESSAGE_T5:
1638 if (data->info->family_id == 0x80 &&
1639 data->info->version < 0x20) {
1641 * On mXT224 firmware versions prior to V2.0
1642 * read and discard unused CRC byte otherwise
1643 * DMA reads are misaligned.
1645 data->T5_msg_size = mxt_obj_size(object);
1647 /* CRC not enabled, so skip last byte */
1648 data->T5_msg_size = mxt_obj_size(object) - 1;
1650 data->T5_address = object->start_address;
1652 case MXT_GEN_COMMAND_T6:
1653 data->T6_reportid = min_id;
1654 data->T6_address = object->start_address;
1656 case MXT_GEN_POWER_T7:
1657 data->T7_address = object->start_address;
1659 case MXT_TOUCH_MULTI_T9:
1660 data->multitouch = MXT_TOUCH_MULTI_T9;
1661 /* Only handle messages from first T9 instance */
1662 data->T9_reportid_min = min_id;
1663 data->T9_reportid_max = min_id +
1664 object->num_report_ids - 1;
1665 data->num_touchids = object->num_report_ids;
1667 case MXT_SPT_MESSAGECOUNT_T44:
1668 data->T44_address = object->start_address;
1670 case MXT_SPT_GPIOPWM_T19:
1671 data->T19_reportid = min_id;
1673 case MXT_TOUCH_MULTITOUCHSCREEN_T100:
1674 data->multitouch = MXT_TOUCH_MULTITOUCHSCREEN_T100;
1675 data->T100_reportid_min = min_id;
1676 data->T100_reportid_max = max_id;
1677 /* first two report IDs reserved */
1678 data->num_touchids = object->num_report_ids - 2;
1682 end_address = object->start_address
1683 + mxt_obj_size(object) * mxt_obj_instances(object) - 1;
1685 if (end_address >= data->mem_size)
1686 data->mem_size = end_address + 1;
1689 /* Store maximum reportid */
1690 data->max_reportid = reportid;
1692 /* If T44 exists, T5 position has to be directly after */
1693 if (data->T44_address && (data->T5_address != data->T44_address + 1)) {
1694 dev_err(&client->dev, "Invalid T44 position\n");
1698 data->msg_buf = kcalloc(data->max_reportid,
1699 data->T5_msg_size, GFP_KERNEL);
1706 static int mxt_read_info_block(struct mxt_data *data)
1708 struct i2c_client *client = data->client;
1712 uint8_t num_objects;
1716 /* If info block already allocated, free it */
1717 if (data->raw_info_block)
1718 mxt_free_object_table(data);
1720 /* Read 7-byte ID information block starting at address 0 */
1721 size = sizeof(struct mxt_info);
1722 id_buf = kzalloc(size, GFP_KERNEL);
1726 error = __mxt_read_reg(client, 0, size, id_buf);
1730 /* Resize buffer to give space for rest of info block */
1731 num_objects = ((struct mxt_info *)id_buf)->object_num;
1732 size += (num_objects * sizeof(struct mxt_object))
1733 + MXT_INFO_CHECKSUM_SIZE;
1735 buf = krealloc(id_buf, size, GFP_KERNEL);
1742 /* Read rest of info block */
1743 error = __mxt_read_reg(client, MXT_OBJECT_START,
1744 size - MXT_OBJECT_START,
1745 id_buf + MXT_OBJECT_START);
1749 /* Extract & calculate checksum */
1750 crc_ptr = id_buf + size - MXT_INFO_CHECKSUM_SIZE;
1751 data->info_crc = crc_ptr[0] | (crc_ptr[1] << 8) | (crc_ptr[2] << 16);
1753 calculated_crc = mxt_calculate_crc(id_buf, 0,
1754 size - MXT_INFO_CHECKSUM_SIZE);
1757 * CRC mismatch can be caused by data corruption due to I2C comms
1758 * issue or else device is not using Object Based Protocol (eg i2c-hid)
1760 if ((data->info_crc == 0) || (data->info_crc != calculated_crc)) {
1761 dev_err(&client->dev,
1762 "Info Block CRC error calculated=0x%06X read=0x%06X\n",
1763 calculated_crc, data->info_crc);
1768 data->raw_info_block = id_buf;
1769 data->info = (struct mxt_info *)id_buf;
1771 dev_info(&client->dev,
1772 "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n",
1773 data->info->family_id, data->info->variant_id,
1774 data->info->version >> 4, data->info->version & 0xf,
1775 data->info->build, data->info->object_num);
1777 /* Parse object table information */
1778 error = mxt_parse_object_table(data, id_buf + MXT_OBJECT_START);
1780 dev_err(&client->dev, "Error %d parsing object table\n", error);
1781 mxt_free_object_table(data);
1785 data->object_table = (struct mxt_object *)(id_buf + MXT_OBJECT_START);
1794 static int mxt_read_t9_resolution(struct mxt_data *data)
1796 struct i2c_client *client = data->client;
1798 struct t9_range range;
1799 unsigned char orient;
1800 struct mxt_object *object;
1802 object = mxt_get_object(data, MXT_TOUCH_MULTI_T9);
1806 error = __mxt_read_reg(client,
1807 object->start_address + MXT_T9_XSIZE,
1808 sizeof(data->xsize), &data->xsize);
1812 error = __mxt_read_reg(client,
1813 object->start_address + MXT_T9_YSIZE,
1814 sizeof(data->ysize), &data->ysize);
1818 error = __mxt_read_reg(client,
1819 object->start_address + MXT_T9_RANGE,
1820 sizeof(range), &range);
1824 data->max_x = get_unaligned_le16(&range.x);
1825 data->max_y = get_unaligned_le16(&range.y);
1827 error = __mxt_read_reg(client,
1828 object->start_address + MXT_T9_ORIENT,
1833 data->xy_switch = orient & MXT_T9_ORIENT_SWITCH;
1834 data->invertx = orient & MXT_T9_ORIENT_INVERTX;
1835 data->inverty = orient & MXT_T9_ORIENT_INVERTY;
1840 static int mxt_read_t100_config(struct mxt_data *data)
1842 struct i2c_client *client = data->client;
1844 struct mxt_object *object;
1845 u16 range_x, range_y;
1849 object = mxt_get_object(data, MXT_TOUCH_MULTITOUCHSCREEN_T100);
1853 /* read touchscreen dimensions */
1854 error = __mxt_read_reg(client,
1855 object->start_address + MXT_T100_XRANGE,
1856 sizeof(range_x), &range_x);
1860 data->max_x = get_unaligned_le16(&range_x);
1862 error = __mxt_read_reg(client,
1863 object->start_address + MXT_T100_YRANGE,
1864 sizeof(range_y), &range_y);
1868 data->max_y = get_unaligned_le16(&range_y);
1870 error = __mxt_read_reg(client,
1871 object->start_address + MXT_T100_XSIZE,
1872 sizeof(data->xsize), &data->xsize);
1876 error = __mxt_read_reg(client,
1877 object->start_address + MXT_T100_YSIZE,
1878 sizeof(data->ysize), &data->ysize);
1882 /* read orientation config */
1883 error = __mxt_read_reg(client,
1884 object->start_address + MXT_T100_CFG1,
1889 data->xy_switch = cfg & MXT_T100_CFG_SWITCHXY;
1890 data->invertx = cfg & MXT_T100_CFG_INVERTX;
1891 data->inverty = cfg & MXT_T100_CFG_INVERTY;
1893 /* allocate aux bytes */
1894 error = __mxt_read_reg(client,
1895 object->start_address + MXT_T100_TCHAUX,
1902 if (tchaux & MXT_T100_TCHAUX_VECT)
1903 data->t100_aux_vect = aux++;
1905 if (tchaux & MXT_T100_TCHAUX_AMPL)
1906 data->t100_aux_ampl = aux++;
1908 if (tchaux & MXT_T100_TCHAUX_AREA)
1909 data->t100_aux_area = aux++;
1911 dev_dbg(&client->dev,
1912 "T100 aux mappings vect:%u ampl:%u area:%u\n",
1913 data->t100_aux_vect, data->t100_aux_ampl, data->t100_aux_area);
1918 static int mxt_input_open(struct input_dev *dev);
1919 static void mxt_input_close(struct input_dev *dev);
1921 static void mxt_set_up_as_touchpad(struct input_dev *input_dev,
1922 struct mxt_data *data)
1926 input_dev->name = "Atmel maXTouch Touchpad";
1928 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
1930 input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM);
1931 input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM);
1932 input_abs_set_res(input_dev, ABS_MT_POSITION_X,
1934 input_abs_set_res(input_dev, ABS_MT_POSITION_Y,
1937 for (i = 0; i < data->t19_num_keys; i++)
1938 if (data->t19_keymap[i] != KEY_RESERVED)
1939 input_set_capability(input_dev, EV_KEY,
1940 data->t19_keymap[i]);
1943 static int mxt_initialize_input_device(struct mxt_data *data)
1945 struct device *dev = &data->client->dev;
1946 struct input_dev *input_dev;
1948 unsigned int num_mt_slots;
1949 unsigned int mt_flags = 0;
1951 switch (data->multitouch) {
1952 case MXT_TOUCH_MULTI_T9:
1953 num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
1954 error = mxt_read_t9_resolution(data);
1956 dev_warn(dev, "Failed to initialize T9 resolution\n");
1959 case MXT_TOUCH_MULTITOUCHSCREEN_T100:
1960 num_mt_slots = data->num_touchids;
1961 error = mxt_read_t100_config(data);
1963 dev_warn(dev, "Failed to read T100 config\n");
1967 dev_err(dev, "Invalid multitouch object\n");
1971 /* Handle default values and orientation switch */
1972 if (data->max_x == 0)
1975 if (data->max_y == 0)
1978 if (data->xy_switch)
1979 swap(data->max_x, data->max_y);
1981 dev_info(dev, "Touchscreen size X%uY%u\n", data->max_x, data->max_y);
1983 /* Register input device */
1984 input_dev = input_allocate_device();
1986 dev_err(dev, "Failed to allocate memory\n");
1990 input_dev->name = "Atmel maXTouch Touchscreen";
1991 input_dev->phys = data->phys;
1992 input_dev->id.bustype = BUS_I2C;
1993 input_dev->dev.parent = dev;
1994 input_dev->open = mxt_input_open;
1995 input_dev->close = mxt_input_close;
1997 input_set_capability(input_dev, EV_KEY, BTN_TOUCH);
1999 /* For single touch */
2000 input_set_abs_params(input_dev, ABS_X, 0, data->max_x, 0, 0);
2001 input_set_abs_params(input_dev, ABS_Y, 0, data->max_y, 0, 0);
2003 if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
2004 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2005 data->t100_aux_ampl)) {
2006 input_set_abs_params(input_dev, ABS_PRESSURE, 0, 255, 0, 0);
2009 /* If device has buttons we assume it is a touchpad */
2010 if (data->t19_num_keys) {
2011 mxt_set_up_as_touchpad(input_dev, data);
2012 mt_flags |= INPUT_MT_POINTER;
2014 mt_flags |= INPUT_MT_DIRECT;
2017 /* For multi touch */
2018 error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags);
2020 dev_err(dev, "Error %d initialising slots\n", error);
2024 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100) {
2025 input_set_abs_params(input_dev, ABS_MT_TOOL_TYPE,
2026 0, MT_TOOL_MAX, 0, 0);
2027 input_set_abs_params(input_dev, ABS_MT_DISTANCE,
2028 MXT_DISTANCE_ACTIVE_TOUCH,
2029 MXT_DISTANCE_HOVERING,
2033 input_set_abs_params(input_dev, ABS_MT_POSITION_X,
2034 0, data->max_x, 0, 0);
2035 input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
2036 0, data->max_y, 0, 0);
2038 if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
2039 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2040 data->t100_aux_area)) {
2041 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
2042 0, MXT_MAX_AREA, 0, 0);
2045 if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
2046 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2047 data->t100_aux_ampl)) {
2048 input_set_abs_params(input_dev, ABS_MT_PRESSURE,
2052 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2053 data->t100_aux_vect) {
2054 input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
2058 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
2059 data->t100_aux_vect) {
2060 input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
2064 input_set_drvdata(input_dev, data);
2066 error = input_register_device(input_dev);
2068 dev_err(dev, "Error %d registering input device\n", error);
2072 data->input_dev = input_dev;
2077 input_free_device(input_dev);
2081 static int mxt_configure_objects(struct mxt_data *data,
2082 const struct firmware *cfg);
2084 static void mxt_config_cb(const struct firmware *cfg, void *ctx)
2086 mxt_configure_objects(ctx, cfg);
2087 release_firmware(cfg);
2090 static int mxt_initialize(struct mxt_data *data)
2092 struct i2c_client *client = data->client;
2093 int recovery_attempts = 0;
2097 error = mxt_read_info_block(data);
2101 /* Check bootloader state */
2102 error = mxt_probe_bootloader(data, false);
2104 dev_info(&client->dev, "Trying alternate bootloader address\n");
2105 error = mxt_probe_bootloader(data, true);
2107 /* Chip is not in appmode or bootloader mode */
2112 /* OK, we are in bootloader, see if we can recover */
2113 if (++recovery_attempts > 1) {
2114 dev_err(&client->dev, "Could not recover from bootloader mode\n");
2116 * We can reflash from this state, so do not
2117 * abort initialization.
2119 data->in_bootloader = true;
2123 /* Attempt to exit bootloader into app mode */
2124 mxt_send_bootloader_cmd(data, false);
2125 msleep(MXT_FW_RESET_TIME);
2128 error = mxt_acquire_irq(data);
2132 error = request_firmware_nowait(THIS_MODULE, true, MXT_CFG_NAME,
2133 &client->dev, GFP_KERNEL, data,
2136 dev_err(&client->dev, "Failed to invoke firmware loader: %d\n",
2144 static int mxt_set_t7_power_cfg(struct mxt_data *data, u8 sleep)
2146 struct device *dev = &data->client->dev;
2148 struct t7_config *new_config;
2149 struct t7_config deepsleep = { .active = 0, .idle = 0 };
2151 if (sleep == MXT_POWER_CFG_DEEPSLEEP)
2152 new_config = &deepsleep;
2154 new_config = &data->t7_cfg;
2156 error = __mxt_write_reg(data->client, data->T7_address,
2157 sizeof(data->t7_cfg), new_config);
2161 dev_dbg(dev, "Set T7 ACTV:%d IDLE:%d\n",
2162 new_config->active, new_config->idle);
2167 static int mxt_init_t7_power_cfg(struct mxt_data *data)
2169 struct device *dev = &data->client->dev;
2174 error = __mxt_read_reg(data->client, data->T7_address,
2175 sizeof(data->t7_cfg), &data->t7_cfg);
2179 if (data->t7_cfg.active == 0 || data->t7_cfg.idle == 0) {
2181 dev_dbg(dev, "T7 cfg zero, resetting\n");
2182 mxt_soft_reset(data);
2186 dev_dbg(dev, "T7 cfg zero after reset, overriding\n");
2187 data->t7_cfg.active = 20;
2188 data->t7_cfg.idle = 100;
2189 return mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
2193 dev_dbg(dev, "Initialized power cfg: ACTV %d, IDLE %d\n",
2194 data->t7_cfg.active, data->t7_cfg.idle);
2198 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
2199 static u16 mxt_get_debug_value(struct mxt_data *data, unsigned int x,
2202 struct mxt_info *info = data->info;
2203 struct mxt_dbg *dbg = &data->dbg;
2204 unsigned int ofs, page;
2205 unsigned int col = 0;
2206 unsigned int col_width;
2208 if (info->family_id == MXT_FAMILY_1386) {
2209 col_width = info->matrix_ysize / MXT1386_COLUMNS;
2210 col = y / col_width;
2213 col_width = info->matrix_ysize;
2216 ofs = (y + (x * col_width)) * sizeof(u16);
2217 page = ofs / MXT_DIAGNOSTIC_SIZE;
2218 ofs %= MXT_DIAGNOSTIC_SIZE;
2220 if (info->family_id == MXT_FAMILY_1386)
2221 page += col * MXT1386_PAGES_PER_COLUMN;
2223 return get_unaligned_le16(&dbg->t37_buf[page].data[ofs]);
2226 static int mxt_convert_debug_pages(struct mxt_data *data, u16 *outbuf)
2228 struct mxt_dbg *dbg = &data->dbg;
2231 unsigned int i, rx, ry;
2233 for (i = 0; i < dbg->t37_nodes; i++) {
2234 /* Handle orientation */
2235 rx = data->xy_switch ? y : x;
2236 ry = data->xy_switch ? x : y;
2237 rx = data->invertx ? (data->xsize - 1 - rx) : rx;
2238 ry = data->inverty ? (data->ysize - 1 - ry) : ry;
2240 outbuf[i] = mxt_get_debug_value(data, rx, ry);
2243 if (++x >= (data->xy_switch ? data->ysize : data->xsize)) {
2252 static int mxt_read_diagnostic_debug(struct mxt_data *data, u8 mode,
2255 struct mxt_dbg *dbg = &data->dbg;
2260 struct t37_debug *p;
2263 for (page = 0; page < dbg->t37_pages; page++) {
2264 p = dbg->t37_buf + page;
2266 ret = mxt_write_reg(data->client, dbg->diag_cmd_address,
2274 /* Read back command byte */
2275 ret = __mxt_read_reg(data->client, dbg->diag_cmd_address,
2276 sizeof(cmd_poll), &cmd_poll);
2280 /* Field is cleared once the command has been processed */
2282 if (retries++ > 100)
2290 ret = __mxt_read_reg(data->client, dbg->t37_address,
2291 sizeof(struct t37_debug), p);
2295 if (p->mode != mode || p->page != page) {
2296 dev_err(&data->client->dev, "T37 page mismatch\n");
2300 dev_dbg(&data->client->dev, "%s page:%d retries:%d\n",
2301 __func__, page, retries);
2303 /* For remaining pages, write PAGEUP rather than mode */
2304 cmd = MXT_DIAGNOSTIC_PAGEUP;
2307 return mxt_convert_debug_pages(data, outbuf);
2310 static int mxt_queue_setup(struct vb2_queue *q,
2311 unsigned int *nbuffers, unsigned int *nplanes,
2312 unsigned int sizes[], struct device *alloc_devs[])
2314 struct mxt_data *data = q->drv_priv;
2315 size_t size = data->dbg.t37_nodes * sizeof(u16);
2318 return sizes[0] < size ? -EINVAL : 0;
2326 static void mxt_buffer_queue(struct vb2_buffer *vb)
2328 struct mxt_data *data = vb2_get_drv_priv(vb->vb2_queue);
2333 ptr = vb2_plane_vaddr(vb, 0);
2335 dev_err(&data->client->dev, "Error acquiring frame ptr\n");
2339 switch (data->dbg.input) {
2340 case MXT_V4L_INPUT_DELTAS:
2342 mode = MXT_DIAGNOSTIC_DELTAS;
2345 case MXT_V4L_INPUT_REFS:
2346 mode = MXT_DIAGNOSTIC_REFS;
2350 ret = mxt_read_diagnostic_debug(data, mode, ptr);
2354 vb2_set_plane_payload(vb, 0, data->dbg.t37_nodes * sizeof(u16));
2355 vb2_buffer_done(vb, VB2_BUF_STATE_DONE);
2359 vb2_buffer_done(vb, VB2_BUF_STATE_ERROR);
2362 /* V4L2 structures */
2363 static const struct vb2_ops mxt_queue_ops = {
2364 .queue_setup = mxt_queue_setup,
2365 .buf_queue = mxt_buffer_queue,
2366 .wait_prepare = vb2_ops_wait_prepare,
2367 .wait_finish = vb2_ops_wait_finish,
2370 static const struct vb2_queue mxt_queue = {
2371 .type = V4L2_BUF_TYPE_VIDEO_CAPTURE,
2372 .io_modes = VB2_MMAP | VB2_USERPTR | VB2_DMABUF | VB2_READ,
2373 .buf_struct_size = sizeof(struct mxt_vb2_buffer),
2374 .ops = &mxt_queue_ops,
2375 .mem_ops = &vb2_vmalloc_memops,
2376 .timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC,
2377 .min_buffers_needed = 1,
2380 static int mxt_vidioc_querycap(struct file *file, void *priv,
2381 struct v4l2_capability *cap)
2383 struct mxt_data *data = video_drvdata(file);
2385 strlcpy(cap->driver, "atmel_mxt_ts", sizeof(cap->driver));
2386 strlcpy(cap->card, "atmel_mxt_ts touch", sizeof(cap->card));
2387 snprintf(cap->bus_info, sizeof(cap->bus_info),
2388 "I2C:%s", dev_name(&data->client->dev));
2392 static int mxt_vidioc_enum_input(struct file *file, void *priv,
2393 struct v4l2_input *i)
2395 if (i->index >= MXT_V4L_INPUT_MAX)
2398 i->type = V4L2_INPUT_TYPE_TOUCH;
2401 case MXT_V4L_INPUT_REFS:
2402 strlcpy(i->name, "Mutual Capacitance References",
2405 case MXT_V4L_INPUT_DELTAS:
2406 strlcpy(i->name, "Mutual Capacitance Deltas", sizeof(i->name));
2413 static int mxt_set_input(struct mxt_data *data, unsigned int i)
2415 struct v4l2_pix_format *f = &data->dbg.format;
2417 if (i >= MXT_V4L_INPUT_MAX)
2420 if (i == MXT_V4L_INPUT_DELTAS)
2421 f->pixelformat = V4L2_TCH_FMT_DELTA_TD16;
2423 f->pixelformat = V4L2_TCH_FMT_TU16;
2425 f->width = data->xy_switch ? data->ysize : data->xsize;
2426 f->height = data->xy_switch ? data->xsize : data->ysize;
2427 f->field = V4L2_FIELD_NONE;
2428 f->colorspace = V4L2_COLORSPACE_RAW;
2429 f->bytesperline = f->width * sizeof(u16);
2430 f->sizeimage = f->width * f->height * sizeof(u16);
2432 data->dbg.input = i;
2437 static int mxt_vidioc_s_input(struct file *file, void *priv, unsigned int i)
2439 return mxt_set_input(video_drvdata(file), i);
2442 static int mxt_vidioc_g_input(struct file *file, void *priv, unsigned int *i)
2444 struct mxt_data *data = video_drvdata(file);
2446 *i = data->dbg.input;
2451 static int mxt_vidioc_fmt(struct file *file, void *priv, struct v4l2_format *f)
2453 struct mxt_data *data = video_drvdata(file);
2455 f->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
2456 f->fmt.pix = data->dbg.format;
2461 static int mxt_vidioc_enum_fmt(struct file *file, void *priv,
2462 struct v4l2_fmtdesc *fmt)
2464 if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
2467 switch (fmt->index) {
2469 fmt->pixelformat = V4L2_TCH_FMT_TU16;
2473 fmt->pixelformat = V4L2_TCH_FMT_DELTA_TD16;
2483 static int mxt_vidioc_g_parm(struct file *file, void *fh,
2484 struct v4l2_streamparm *a)
2486 if (a->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
2489 a->parm.capture.readbuffers = 1;
2490 a->parm.capture.timeperframe.numerator = 1;
2491 a->parm.capture.timeperframe.denominator = 10;
2495 static const struct v4l2_ioctl_ops mxt_video_ioctl_ops = {
2496 .vidioc_querycap = mxt_vidioc_querycap,
2498 .vidioc_enum_fmt_vid_cap = mxt_vidioc_enum_fmt,
2499 .vidioc_s_fmt_vid_cap = mxt_vidioc_fmt,
2500 .vidioc_g_fmt_vid_cap = mxt_vidioc_fmt,
2501 .vidioc_try_fmt_vid_cap = mxt_vidioc_fmt,
2502 .vidioc_g_parm = mxt_vidioc_g_parm,
2504 .vidioc_enum_input = mxt_vidioc_enum_input,
2505 .vidioc_g_input = mxt_vidioc_g_input,
2506 .vidioc_s_input = mxt_vidioc_s_input,
2508 .vidioc_reqbufs = vb2_ioctl_reqbufs,
2509 .vidioc_create_bufs = vb2_ioctl_create_bufs,
2510 .vidioc_querybuf = vb2_ioctl_querybuf,
2511 .vidioc_qbuf = vb2_ioctl_qbuf,
2512 .vidioc_dqbuf = vb2_ioctl_dqbuf,
2513 .vidioc_expbuf = vb2_ioctl_expbuf,
2515 .vidioc_streamon = vb2_ioctl_streamon,
2516 .vidioc_streamoff = vb2_ioctl_streamoff,
2519 static const struct video_device mxt_video_device = {
2520 .name = "Atmel maxTouch",
2521 .fops = &mxt_video_fops,
2522 .ioctl_ops = &mxt_video_ioctl_ops,
2523 .release = video_device_release_empty,
2524 .device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_TOUCH |
2525 V4L2_CAP_READWRITE | V4L2_CAP_STREAMING,
2528 static void mxt_debug_init(struct mxt_data *data)
2530 struct mxt_info *info = data->info;
2531 struct mxt_dbg *dbg = &data->dbg;
2532 struct mxt_object *object;
2535 object = mxt_get_object(data, MXT_GEN_COMMAND_T6);
2539 dbg->diag_cmd_address = object->start_address + MXT_COMMAND_DIAGNOSTIC;
2541 object = mxt_get_object(data, MXT_DEBUG_DIAGNOSTIC_T37);
2545 if (mxt_obj_size(object) != sizeof(struct t37_debug)) {
2546 dev_warn(&data->client->dev, "Bad T37 size");
2550 dbg->t37_address = object->start_address;
2552 /* Calculate size of data and allocate buffer */
2553 dbg->t37_nodes = data->xsize * data->ysize;
2555 if (info->family_id == MXT_FAMILY_1386)
2556 dbg->t37_pages = MXT1386_COLUMNS * MXT1386_PAGES_PER_COLUMN;
2558 dbg->t37_pages = DIV_ROUND_UP(data->xsize *
2559 info->matrix_ysize *
2561 sizeof(dbg->t37_buf->data));
2563 dbg->t37_buf = devm_kmalloc_array(&data->client->dev, dbg->t37_pages,
2564 sizeof(struct t37_debug), GFP_KERNEL);
2568 /* init channel to zero */
2569 mxt_set_input(data, 0);
2571 /* register video device */
2572 snprintf(dbg->v4l2.name, sizeof(dbg->v4l2.name), "%s", "atmel_mxt_ts");
2573 error = v4l2_device_register(&data->client->dev, &dbg->v4l2);
2577 /* initialize the queue */
2578 mutex_init(&dbg->lock);
2579 dbg->queue = mxt_queue;
2580 dbg->queue.drv_priv = data;
2581 dbg->queue.lock = &dbg->lock;
2582 dbg->queue.dev = &data->client->dev;
2584 error = vb2_queue_init(&dbg->queue);
2586 goto error_unreg_v4l2;
2588 dbg->vdev = mxt_video_device;
2589 dbg->vdev.v4l2_dev = &dbg->v4l2;
2590 dbg->vdev.lock = &dbg->lock;
2591 dbg->vdev.vfl_dir = VFL_DIR_RX;
2592 dbg->vdev.queue = &dbg->queue;
2593 video_set_drvdata(&dbg->vdev, data);
2595 error = video_register_device(&dbg->vdev, VFL_TYPE_TOUCH, -1);
2597 goto error_unreg_v4l2;
2602 v4l2_device_unregister(&dbg->v4l2);
2604 dev_warn(&data->client->dev, "Error initializing T37\n");
2607 static void mxt_debug_init(struct mxt_data *data)
2612 static int mxt_configure_objects(struct mxt_data *data,
2613 const struct firmware *cfg)
2615 struct device *dev = &data->client->dev;
2618 error = mxt_init_t7_power_cfg(data);
2620 dev_err(dev, "Failed to initialize power cfg\n");
2625 error = mxt_update_cfg(data, cfg);
2627 dev_warn(dev, "Error %d updating config\n", error);
2630 if (data->multitouch) {
2631 error = mxt_initialize_input_device(data);
2635 dev_warn(dev, "No touch object detected\n");
2638 mxt_debug_init(data);
2643 /* Firmware Version is returned as Major.Minor.Build */
2644 static ssize_t mxt_fw_version_show(struct device *dev,
2645 struct device_attribute *attr, char *buf)
2647 struct mxt_data *data = dev_get_drvdata(dev);
2648 struct mxt_info *info = data->info;
2649 return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
2650 info->version >> 4, info->version & 0xf, info->build);
2653 /* Hardware Version is returned as FamilyID.VariantID */
2654 static ssize_t mxt_hw_version_show(struct device *dev,
2655 struct device_attribute *attr, char *buf)
2657 struct mxt_data *data = dev_get_drvdata(dev);
2658 struct mxt_info *info = data->info;
2659 return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
2660 info->family_id, info->variant_id);
2663 static ssize_t mxt_show_instance(char *buf, int count,
2664 struct mxt_object *object, int instance,
2669 if (mxt_obj_instances(object) > 1)
2670 count += scnprintf(buf + count, PAGE_SIZE - count,
2671 "Instance %u\n", instance);
2673 for (i = 0; i < mxt_obj_size(object); i++)
2674 count += scnprintf(buf + count, PAGE_SIZE - count,
2675 "\t[%2u]: %02x (%d)\n", i, val[i], val[i]);
2676 count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
2681 static ssize_t mxt_object_show(struct device *dev,
2682 struct device_attribute *attr, char *buf)
2684 struct mxt_data *data = dev_get_drvdata(dev);
2685 struct mxt_object *object;
2691 /* Pre-allocate buffer large enough to hold max sized object. */
2692 obuf = kmalloc(256, GFP_KERNEL);
2697 for (i = 0; i < data->info->object_num; i++) {
2698 object = data->object_table + i;
2700 if (!mxt_object_readable(object->type))
2703 count += scnprintf(buf + count, PAGE_SIZE - count,
2704 "T%u:\n", object->type);
2706 for (j = 0; j < mxt_obj_instances(object); j++) {
2707 u16 size = mxt_obj_size(object);
2708 u16 addr = object->start_address + j * size;
2710 error = __mxt_read_reg(data->client, addr, size, obuf);
2714 count = mxt_show_instance(buf, count, object, j, obuf);
2720 return error ?: count;
2723 static int mxt_check_firmware_format(struct device *dev,
2724 const struct firmware *fw)
2726 unsigned int pos = 0;
2729 while (pos < fw->size) {
2730 c = *(fw->data + pos);
2732 if (c < '0' || (c > '9' && c < 'A') || c > 'F')
2739 * To convert file try:
2740 * xxd -r -p mXTXXX__APP_VX-X-XX.enc > maxtouch.fw
2742 dev_err(dev, "Aborting: firmware file must be in binary format\n");
2747 static int mxt_load_fw(struct device *dev, const char *fn)
2749 struct mxt_data *data = dev_get_drvdata(dev);
2750 const struct firmware *fw = NULL;
2751 unsigned int frame_size;
2752 unsigned int pos = 0;
2753 unsigned int retry = 0;
2754 unsigned int frame = 0;
2757 ret = request_firmware(&fw, fn, dev);
2759 dev_err(dev, "Unable to open firmware %s\n", fn);
2763 /* Check for incorrect enc file */
2764 ret = mxt_check_firmware_format(dev, fw);
2766 goto release_firmware;
2768 if (!data->in_bootloader) {
2769 /* Change to the bootloader mode */
2770 data->in_bootloader = true;
2772 ret = mxt_t6_command(data, MXT_COMMAND_RESET,
2773 MXT_BOOT_VALUE, false);
2775 goto release_firmware;
2777 msleep(MXT_RESET_TIME);
2779 /* Do not need to scan since we know family ID */
2780 ret = mxt_lookup_bootloader_address(data, 0);
2782 goto release_firmware;
2784 mxt_free_input_device(data);
2785 mxt_free_object_table(data);
2787 enable_irq(data->irq);
2790 reinit_completion(&data->bl_completion);
2792 ret = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD, false);
2794 /* Bootloader may still be unlocked from previous attempt */
2795 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, false);
2799 dev_info(dev, "Unlocking bootloader\n");
2801 /* Unlock bootloader */
2802 ret = mxt_send_bootloader_cmd(data, true);
2807 while (pos < fw->size) {
2808 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, true);
2812 frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
2814 /* Take account of CRC bytes */
2817 /* Write one frame to device */
2818 ret = mxt_bootloader_write(data, fw->data + pos, frame_size);
2822 ret = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS, true);
2826 /* Back off by 20ms per retry */
2830 dev_err(dev, "Retry count exceeded\n");
2839 if (frame % 50 == 0)
2840 dev_dbg(dev, "Sent %d frames, %d/%zd bytes\n",
2841 frame, pos, fw->size);
2844 /* Wait for flash. */
2845 ret = mxt_wait_for_completion(data, &data->bl_completion,
2850 dev_dbg(dev, "Sent %d frames, %d bytes\n", frame, pos);
2853 * Wait for device to reset. Some bootloader versions do not assert
2854 * the CHG line after bootloading has finished, so ignore potential
2857 mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME);
2859 data->in_bootloader = false;
2862 disable_irq(data->irq);
2864 release_firmware(fw);
2868 static ssize_t mxt_update_fw_store(struct device *dev,
2869 struct device_attribute *attr,
2870 const char *buf, size_t count)
2872 struct mxt_data *data = dev_get_drvdata(dev);
2875 error = mxt_load_fw(dev, MXT_FW_NAME);
2877 dev_err(dev, "The firmware update failed(%d)\n", error);
2880 dev_info(dev, "The firmware update succeeded\n");
2882 error = mxt_initialize(data);
2890 static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
2891 static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
2892 static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
2893 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
2895 static struct attribute *mxt_attrs[] = {
2896 &dev_attr_fw_version.attr,
2897 &dev_attr_hw_version.attr,
2898 &dev_attr_object.attr,
2899 &dev_attr_update_fw.attr,
2903 static const struct attribute_group mxt_attr_group = {
2907 static void mxt_start(struct mxt_data *data)
2909 switch (data->suspend_mode) {
2910 case MXT_SUSPEND_T9_CTRL:
2911 mxt_soft_reset(data);
2914 /* 0x83 = SCANEN | RPTEN | ENABLE */
2915 mxt_write_object(data,
2916 MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0x83);
2919 case MXT_SUSPEND_DEEP_SLEEP:
2921 mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
2923 /* Recalibrate since chip has been in deep sleep */
2924 mxt_t6_command(data, MXT_COMMAND_CALIBRATE, 1, false);
2929 static void mxt_stop(struct mxt_data *data)
2931 switch (data->suspend_mode) {
2932 case MXT_SUSPEND_T9_CTRL:
2934 mxt_write_object(data,
2935 MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0);
2938 case MXT_SUSPEND_DEEP_SLEEP:
2940 mxt_set_t7_power_cfg(data, MXT_POWER_CFG_DEEPSLEEP);
2945 static int mxt_input_open(struct input_dev *dev)
2947 struct mxt_data *data = input_get_drvdata(dev);
2954 static void mxt_input_close(struct input_dev *dev)
2956 struct mxt_data *data = input_get_drvdata(dev);
2961 static int mxt_parse_device_properties(struct mxt_data *data)
2963 static const char keymap_property[] = "linux,gpio-keymap";
2964 struct device *dev = &data->client->dev;
2969 if (device_property_present(dev, keymap_property)) {
2970 n_keys = device_property_read_u32_array(dev, keymap_property,
2973 error = n_keys < 0 ? n_keys : -EINVAL;
2974 dev_err(dev, "invalid/malformed '%s' property: %d\n",
2975 keymap_property, error);
2979 keymap = devm_kmalloc_array(dev, n_keys, sizeof(*keymap),
2984 error = device_property_read_u32_array(dev, keymap_property,
2987 dev_err(dev, "failed to parse '%s' property: %d\n",
2988 keymap_property, error);
2992 data->t19_keymap = keymap;
2993 data->t19_num_keys = n_keys;
2999 static const struct dmi_system_id chromebook_T9_suspend_dmi[] = {
3002 DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
3003 DMI_MATCH(DMI_PRODUCT_NAME, "Link"),
3008 DMI_MATCH(DMI_PRODUCT_NAME, "Peppy"),
3014 static int mxt_probe(struct i2c_client *client, const struct i2c_device_id *id)
3016 struct mxt_data *data;
3020 * Ignore devices that do not have device properties attached to
3021 * them, as we need help determining whether we are dealing with
3022 * touch screen or touchpad.
3024 * So far on x86 the only users of Atmel touch controllers are
3025 * Chromebooks, and chromeos_laptop driver will ensure that
3026 * necessary properties are provided (if firmware does not do that).
3028 if (!device_property_present(&client->dev, "compatible"))
3032 * Ignore ACPI devices representing bootloader mode.
3034 * This is a bit of a hack: Google Chromebook BIOS creates ACPI
3035 * devices for both application and bootloader modes, but we are
3036 * interested in application mode only (if device is in bootloader
3037 * mode we'll end up switching into application anyway). So far
3038 * application mode addresses were all above 0x40, so we'll use it
3041 if (ACPI_COMPANION(&client->dev) && client->addr < 0x40)
3044 data = devm_kzalloc(&client->dev, sizeof(struct mxt_data), GFP_KERNEL);
3048 snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
3049 client->adapter->nr, client->addr);
3051 data->client = client;
3052 data->irq = client->irq;
3053 i2c_set_clientdata(client, data);
3055 init_completion(&data->bl_completion);
3056 init_completion(&data->reset_completion);
3057 init_completion(&data->crc_completion);
3059 data->suspend_mode = dmi_check_system(chromebook_T9_suspend_dmi) ?
3060 MXT_SUSPEND_T9_CTRL : MXT_SUSPEND_DEEP_SLEEP;
3062 error = mxt_parse_device_properties(data);
3066 data->reset_gpio = devm_gpiod_get_optional(&client->dev,
3067 "reset", GPIOD_OUT_LOW);
3068 if (IS_ERR(data->reset_gpio)) {
3069 error = PTR_ERR(data->reset_gpio);
3070 dev_err(&client->dev, "Failed to get reset gpio: %d\n", error);
3074 error = devm_request_threaded_irq(&client->dev, client->irq,
3075 NULL, mxt_interrupt, IRQF_ONESHOT,
3076 client->name, data);
3078 dev_err(&client->dev, "Failed to register interrupt\n");
3082 disable_irq(client->irq);
3084 if (data->reset_gpio) {
3085 msleep(MXT_RESET_GPIO_TIME);
3086 gpiod_set_value(data->reset_gpio, 1);
3087 msleep(MXT_RESET_INVALID_CHG);
3090 error = mxt_initialize(data);
3094 error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
3096 dev_err(&client->dev, "Failure %d creating sysfs group\n",
3098 goto err_free_object;
3104 mxt_free_input_device(data);
3105 mxt_free_object_table(data);
3109 static int mxt_remove(struct i2c_client *client)
3111 struct mxt_data *data = i2c_get_clientdata(client);
3113 disable_irq(data->irq);
3114 sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
3115 mxt_free_input_device(data);
3116 mxt_free_object_table(data);
3121 static int __maybe_unused mxt_suspend(struct device *dev)
3123 struct i2c_client *client = to_i2c_client(dev);
3124 struct mxt_data *data = i2c_get_clientdata(client);
3125 struct input_dev *input_dev = data->input_dev;
3130 mutex_lock(&input_dev->mutex);
3132 if (input_dev->users)
3135 mutex_unlock(&input_dev->mutex);
3140 static int __maybe_unused mxt_resume(struct device *dev)
3142 struct i2c_client *client = to_i2c_client(dev);
3143 struct mxt_data *data = i2c_get_clientdata(client);
3144 struct input_dev *input_dev = data->input_dev;
3149 mutex_lock(&input_dev->mutex);
3151 if (input_dev->users)
3154 mutex_unlock(&input_dev->mutex);
3159 static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);
3161 static const struct of_device_id mxt_of_match[] = {
3162 { .compatible = "atmel,maxtouch", },
3163 /* Compatibles listed below are deprecated */
3164 { .compatible = "atmel,qt602240_ts", },
3165 { .compatible = "atmel,atmel_mxt_ts", },
3166 { .compatible = "atmel,atmel_mxt_tp", },
3167 { .compatible = "atmel,mXT224", },
3170 MODULE_DEVICE_TABLE(of, mxt_of_match);
3173 static const struct acpi_device_id mxt_acpi_id[] = {
3174 { "ATML0000", 0 }, /* Touchpad */
3175 { "ATML0001", 0 }, /* Touchscreen */
3178 MODULE_DEVICE_TABLE(acpi, mxt_acpi_id);
3181 static const struct i2c_device_id mxt_id[] = {
3182 { "qt602240_ts", 0 },
3183 { "atmel_mxt_ts", 0 },
3184 { "atmel_mxt_tp", 0 },
3189 MODULE_DEVICE_TABLE(i2c, mxt_id);
3191 static struct i2c_driver mxt_driver = {
3193 .name = "atmel_mxt_ts",
3194 .of_match_table = mxt_of_match,
3195 .acpi_match_table = ACPI_PTR(mxt_acpi_id),
3199 .remove = mxt_remove,
3203 module_i2c_driver(mxt_driver);
3205 /* Module information */
3206 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
3207 MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
3208 MODULE_LICENSE("GPL");