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.
8 * Author: Joonyoung Shim <jy0922.shim@samsung.com>
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the License, or (at your
13 * option) any later version.
17 #include <linux/acpi.h>
18 #include <linux/dmi.h>
19 #include <linux/module.h>
20 #include <linux/init.h>
21 #include <linux/completion.h>
22 #include <linux/delay.h>
23 #include <linux/firmware.h>
24 #include <linux/i2c.h>
25 #include <linux/platform_data/atmel_mxt_ts.h>
26 #include <linux/input/mt.h>
27 #include <linux/interrupt.h>
29 #include <linux/slab.h>
30 #include <asm/unaligned.h>
31 #include <media/v4l2-device.h>
32 #include <media/v4l2-ioctl.h>
33 #include <media/videobuf2-v4l2.h>
34 #include <media/videobuf2-vmalloc.h>
37 #define MXT_FW_NAME "maxtouch.fw"
38 #define MXT_CFG_NAME "maxtouch.cfg"
39 #define MXT_CFG_MAGIC "OBP_RAW V1"
42 #define MXT_OBJECT_START 0x07
43 #define MXT_OBJECT_SIZE 6
44 #define MXT_INFO_CHECKSUM_SIZE 3
45 #define MXT_MAX_BLOCK_WRITE 256
48 #define MXT_DEBUG_DIAGNOSTIC_T37 37
49 #define MXT_GEN_MESSAGE_T5 5
50 #define MXT_GEN_COMMAND_T6 6
51 #define MXT_GEN_POWER_T7 7
52 #define MXT_GEN_ACQUIRE_T8 8
53 #define MXT_GEN_DATASOURCE_T53 53
54 #define MXT_TOUCH_MULTI_T9 9
55 #define MXT_TOUCH_KEYARRAY_T15 15
56 #define MXT_TOUCH_PROXIMITY_T23 23
57 #define MXT_TOUCH_PROXKEY_T52 52
58 #define MXT_PROCI_GRIPFACE_T20 20
59 #define MXT_PROCG_NOISE_T22 22
60 #define MXT_PROCI_ONETOUCH_T24 24
61 #define MXT_PROCI_TWOTOUCH_T27 27
62 #define MXT_PROCI_GRIP_T40 40
63 #define MXT_PROCI_PALM_T41 41
64 #define MXT_PROCI_TOUCHSUPPRESSION_T42 42
65 #define MXT_PROCI_STYLUS_T47 47
66 #define MXT_PROCG_NOISESUPPRESSION_T48 48
67 #define MXT_SPT_COMMSCONFIG_T18 18
68 #define MXT_SPT_GPIOPWM_T19 19
69 #define MXT_SPT_SELFTEST_T25 25
70 #define MXT_SPT_CTECONFIG_T28 28
71 #define MXT_SPT_USERDATA_T38 38
72 #define MXT_SPT_DIGITIZER_T43 43
73 #define MXT_SPT_MESSAGECOUNT_T44 44
74 #define MXT_SPT_CTECONFIG_T46 46
75 #define MXT_TOUCH_MULTITOUCHSCREEN_T100 100
77 /* MXT_GEN_MESSAGE_T5 object */
78 #define MXT_RPTID_NOMSG 0xff
80 /* MXT_GEN_COMMAND_T6 field */
81 #define MXT_COMMAND_RESET 0
82 #define MXT_COMMAND_BACKUPNV 1
83 #define MXT_COMMAND_CALIBRATE 2
84 #define MXT_COMMAND_REPORTALL 3
85 #define MXT_COMMAND_DIAGNOSTIC 5
87 /* Define for T6 status byte */
88 #define MXT_T6_STATUS_RESET (1 << 7)
89 #define MXT_T6_STATUS_OFL (1 << 6)
90 #define MXT_T6_STATUS_SIGERR (1 << 5)
91 #define MXT_T6_STATUS_CAL (1 << 4)
92 #define MXT_T6_STATUS_CFGERR (1 << 3)
93 #define MXT_T6_STATUS_COMSERR (1 << 2)
95 /* MXT_GEN_POWER_T7 field */
101 #define MXT_POWER_CFG_RUN 0
102 #define MXT_POWER_CFG_DEEPSLEEP 1
104 /* MXT_TOUCH_MULTI_T9 field */
105 #define MXT_T9_CTRL 0
106 #define MXT_T9_XSIZE 3
107 #define MXT_T9_YSIZE 4
108 #define MXT_T9_ORIENT 9
109 #define MXT_T9_RANGE 18
111 /* MXT_TOUCH_MULTI_T9 status */
112 #define MXT_T9_UNGRIP (1 << 0)
113 #define MXT_T9_SUPPRESS (1 << 1)
114 #define MXT_T9_AMP (1 << 2)
115 #define MXT_T9_VECTOR (1 << 3)
116 #define MXT_T9_MOVE (1 << 4)
117 #define MXT_T9_RELEASE (1 << 5)
118 #define MXT_T9_PRESS (1 << 6)
119 #define MXT_T9_DETECT (1 << 7)
126 /* MXT_TOUCH_MULTI_T9 orient */
127 #define MXT_T9_ORIENT_SWITCH (1 << 0)
128 #define MXT_T9_ORIENT_INVERTX (1 << 1)
129 #define MXT_T9_ORIENT_INVERTY (1 << 2)
131 /* MXT_SPT_COMMSCONFIG_T18 */
132 #define MXT_COMMS_CTRL 0
133 #define MXT_COMMS_CMD 1
135 /* MXT_DEBUG_DIAGNOSTIC_T37 */
136 #define MXT_DIAGNOSTIC_PAGEUP 0x01
137 #define MXT_DIAGNOSTIC_DELTAS 0x10
138 #define MXT_DIAGNOSTIC_SIZE 128
141 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
144 u8 data[MXT_DIAGNOSTIC_SIZE];
148 /* Define for MXT_GEN_COMMAND_T6 */
149 #define MXT_BOOT_VALUE 0xa5
150 #define MXT_RESET_VALUE 0x01
151 #define MXT_BACKUP_VALUE 0x55
153 /* T100 Multiple Touch Touchscreen */
154 #define MXT_T100_CTRL 0
155 #define MXT_T100_CFG1 1
156 #define MXT_T100_TCHAUX 3
157 #define MXT_T100_XSIZE 9
158 #define MXT_T100_XRANGE 13
159 #define MXT_T100_YSIZE 20
160 #define MXT_T100_YRANGE 24
162 #define MXT_T100_CFG_SWITCHXY BIT(5)
163 #define MXT_T100_CFG_INVERTY BIT(6)
164 #define MXT_T100_CFG_INVERTX BIT(7)
166 #define MXT_T100_TCHAUX_VECT BIT(0)
167 #define MXT_T100_TCHAUX_AMPL BIT(1)
168 #define MXT_T100_TCHAUX_AREA BIT(2)
170 #define MXT_T100_DETECT BIT(7)
171 #define MXT_T100_TYPE_MASK 0x70
174 MXT_T100_TYPE_FINGER = 1,
175 MXT_T100_TYPE_PASSIVE_STYLUS = 2,
176 MXT_T100_TYPE_HOVERING_FINGER = 4,
177 MXT_T100_TYPE_GLOVE = 5,
178 MXT_T100_TYPE_LARGE_TOUCH = 6,
181 #define MXT_DISTANCE_ACTIVE_TOUCH 0
182 #define MXT_DISTANCE_HOVERING 1
184 #define MXT_TOUCH_MAJOR_DEFAULT 1
185 #define MXT_PRESSURE_DEFAULT 1
188 #define MXT_BACKUP_TIME 50 /* msec */
189 #define MXT_RESET_TIME 200 /* msec */
190 #define MXT_RESET_TIMEOUT 3000 /* msec */
191 #define MXT_CRC_TIMEOUT 1000 /* msec */
192 #define MXT_FW_RESET_TIME 3000 /* msec */
193 #define MXT_FW_CHG_TIMEOUT 300 /* msec */
195 /* Command to unlock bootloader */
196 #define MXT_UNLOCK_CMD_MSB 0xaa
197 #define MXT_UNLOCK_CMD_LSB 0xdc
199 /* Bootloader mode status */
200 #define MXT_WAITING_BOOTLOAD_CMD 0xc0 /* valid 7 6 bit only */
201 #define MXT_WAITING_FRAME_DATA 0x80 /* valid 7 6 bit only */
202 #define MXT_FRAME_CRC_CHECK 0x02
203 #define MXT_FRAME_CRC_FAIL 0x03
204 #define MXT_FRAME_CRC_PASS 0x04
205 #define MXT_APP_CRC_FAIL 0x40 /* valid 7 8 bit only */
206 #define MXT_BOOT_STATUS_MASK 0x3f
207 #define MXT_BOOT_EXTENDED_ID (1 << 5)
208 #define MXT_BOOT_ID_MASK 0x1f
210 /* Touchscreen absolute values */
211 #define MXT_MAX_AREA 0xff
213 #define MXT_PIXELS_PER_MM 20
229 u8 instances_minus_one;
235 u16 diag_cmd_address;
236 struct t37_debug *t37_buf;
237 unsigned int t37_pages;
238 unsigned int t37_nodes;
240 struct v4l2_device v4l2;
241 struct v4l2_pix_format format;
242 struct video_device vdev;
243 struct vb2_queue queue;
248 static const struct v4l2_file_operations mxt_video_fops = {
249 .owner = THIS_MODULE,
250 .open = v4l2_fh_open,
251 .release = vb2_fop_release,
252 .unlocked_ioctl = video_ioctl2,
253 .read = vb2_fop_read,
254 .mmap = vb2_fop_mmap,
255 .poll = vb2_fop_poll,
258 /* Each client has this additional data */
260 struct i2c_client *client;
261 struct input_dev *input_dev;
262 char phys[64]; /* device physical location */
263 const struct mxt_platform_data *pdata;
264 struct mxt_object *object_table;
265 struct mxt_info info;
286 u8 last_message_count;
289 struct t7_config t7_cfg;
292 /* Cached parameters from object table */
302 u8 T100_reportid_min;
303 u8 T100_reportid_max;
305 /* for fw update in bootloader */
306 struct completion bl_completion;
308 /* for reset handling */
309 struct completion reset_completion;
311 /* for config update handling */
312 struct completion crc_completion;
315 struct mxt_vb2_buffer {
316 struct vb2_buffer vb;
317 struct list_head list;
320 static size_t mxt_obj_size(const struct mxt_object *obj)
322 return obj->size_minus_one + 1;
325 static size_t mxt_obj_instances(const struct mxt_object *obj)
327 return obj->instances_minus_one + 1;
330 static bool mxt_object_readable(unsigned int type)
333 case MXT_GEN_COMMAND_T6:
334 case MXT_GEN_POWER_T7:
335 case MXT_GEN_ACQUIRE_T8:
336 case MXT_GEN_DATASOURCE_T53:
337 case MXT_TOUCH_MULTI_T9:
338 case MXT_TOUCH_KEYARRAY_T15:
339 case MXT_TOUCH_PROXIMITY_T23:
340 case MXT_TOUCH_PROXKEY_T52:
341 case MXT_PROCI_GRIPFACE_T20:
342 case MXT_PROCG_NOISE_T22:
343 case MXT_PROCI_ONETOUCH_T24:
344 case MXT_PROCI_TWOTOUCH_T27:
345 case MXT_PROCI_GRIP_T40:
346 case MXT_PROCI_PALM_T41:
347 case MXT_PROCI_TOUCHSUPPRESSION_T42:
348 case MXT_PROCI_STYLUS_T47:
349 case MXT_PROCG_NOISESUPPRESSION_T48:
350 case MXT_SPT_COMMSCONFIG_T18:
351 case MXT_SPT_GPIOPWM_T19:
352 case MXT_SPT_SELFTEST_T25:
353 case MXT_SPT_CTECONFIG_T28:
354 case MXT_SPT_USERDATA_T38:
355 case MXT_SPT_DIGITIZER_T43:
356 case MXT_SPT_CTECONFIG_T46:
363 static void mxt_dump_message(struct mxt_data *data, u8 *message)
365 dev_dbg(&data->client->dev, "message: %*ph\n",
366 data->T5_msg_size, message);
369 static int mxt_wait_for_completion(struct mxt_data *data,
370 struct completion *comp,
371 unsigned int timeout_ms)
373 struct device *dev = &data->client->dev;
374 unsigned long timeout = msecs_to_jiffies(timeout_ms);
377 ret = wait_for_completion_interruptible_timeout(comp, timeout);
380 } else if (ret == 0) {
381 dev_err(dev, "Wait for completion timed out.\n");
387 static int mxt_bootloader_read(struct mxt_data *data,
388 u8 *val, unsigned int count)
393 msg.addr = data->bootloader_addr;
394 msg.flags = data->client->flags & I2C_M_TEN;
395 msg.flags |= I2C_M_RD;
399 ret = i2c_transfer(data->client->adapter, &msg, 1);
403 ret = ret < 0 ? ret : -EIO;
404 dev_err(&data->client->dev, "%s: i2c recv failed (%d)\n",
411 static int mxt_bootloader_write(struct mxt_data *data,
412 const u8 * const val, unsigned int count)
417 msg.addr = data->bootloader_addr;
418 msg.flags = data->client->flags & I2C_M_TEN;
422 ret = i2c_transfer(data->client->adapter, &msg, 1);
426 ret = ret < 0 ? ret : -EIO;
427 dev_err(&data->client->dev, "%s: i2c send failed (%d)\n",
434 static int mxt_lookup_bootloader_address(struct mxt_data *data, bool retry)
436 u8 appmode = data->client->addr;
442 /* Chips after 1664S use different scheme */
443 if (retry || data->info.family_id >= 0xa2) {
444 bootloader = appmode - 0x24;
447 /* Fall through for normal case */
452 bootloader = appmode - 0x26;
456 dev_err(&data->client->dev,
457 "Appmode i2c address 0x%02x not found\n",
462 data->bootloader_addr = bootloader;
466 static int mxt_probe_bootloader(struct mxt_data *data, bool alt_address)
468 struct device *dev = &data->client->dev;
473 error = mxt_lookup_bootloader_address(data, alt_address);
477 error = mxt_bootloader_read(data, &val, 1);
481 /* Check app crc fail mode */
482 crc_failure = (val & ~MXT_BOOT_STATUS_MASK) == MXT_APP_CRC_FAIL;
484 dev_err(dev, "Detected bootloader, status:%02X%s\n",
485 val, crc_failure ? ", APP_CRC_FAIL" : "");
490 static u8 mxt_get_bootloader_version(struct mxt_data *data, u8 val)
492 struct device *dev = &data->client->dev;
495 if (val & MXT_BOOT_EXTENDED_ID) {
496 if (mxt_bootloader_read(data, &buf[0], 3) != 0) {
497 dev_err(dev, "%s: i2c failure\n", __func__);
501 dev_dbg(dev, "Bootloader ID:%d Version:%d\n", buf[1], buf[2]);
505 dev_dbg(dev, "Bootloader ID:%d\n", val & MXT_BOOT_ID_MASK);
511 static int mxt_check_bootloader(struct mxt_data *data, unsigned int state,
514 struct device *dev = &data->client->dev;
521 * In application update mode, the interrupt
522 * line signals state transitions. We must wait for the
523 * CHG assertion before reading the status byte.
524 * Once the status byte has been read, the line is deasserted.
526 ret = mxt_wait_for_completion(data, &data->bl_completion,
530 * TODO: handle -ERESTARTSYS better by terminating
531 * fw update process before returning to userspace
532 * by writing length 0x000 to device (iff we are in
533 * WAITING_FRAME_DATA state).
535 dev_err(dev, "Update wait error %d\n", ret);
540 ret = mxt_bootloader_read(data, &val, 1);
544 if (state == MXT_WAITING_BOOTLOAD_CMD)
545 val = mxt_get_bootloader_version(data, val);
548 case MXT_WAITING_BOOTLOAD_CMD:
549 case MXT_WAITING_FRAME_DATA:
550 case MXT_APP_CRC_FAIL:
551 val &= ~MXT_BOOT_STATUS_MASK;
553 case MXT_FRAME_CRC_PASS:
554 if (val == MXT_FRAME_CRC_CHECK) {
556 } else if (val == MXT_FRAME_CRC_FAIL) {
557 dev_err(dev, "Bootloader CRC fail\n");
566 dev_err(dev, "Invalid bootloader state %02X != %02X\n",
574 static int mxt_send_bootloader_cmd(struct mxt_data *data, bool unlock)
580 buf[0] = MXT_UNLOCK_CMD_LSB;
581 buf[1] = MXT_UNLOCK_CMD_MSB;
587 ret = mxt_bootloader_write(data, buf, 2);
594 static int __mxt_read_reg(struct i2c_client *client,
595 u16 reg, u16 len, void *val)
597 struct i2c_msg xfer[2];
602 buf[1] = (reg >> 8) & 0xff;
605 xfer[0].addr = client->addr;
611 xfer[1].addr = client->addr;
612 xfer[1].flags = I2C_M_RD;
616 ret = i2c_transfer(client->adapter, xfer, 2);
622 dev_err(&client->dev, "%s: i2c transfer failed (%d)\n",
629 static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len,
637 buf = kmalloc(count, GFP_KERNEL);
642 buf[1] = (reg >> 8) & 0xff;
643 memcpy(&buf[2], val, len);
645 ret = i2c_master_send(client, buf, count);
651 dev_err(&client->dev, "%s: i2c send failed (%d)\n",
659 static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
661 return __mxt_write_reg(client, reg, 1, &val);
664 static struct mxt_object *
665 mxt_get_object(struct mxt_data *data, u8 type)
667 struct mxt_object *object;
670 for (i = 0; i < data->info.object_num; i++) {
671 object = data->object_table + i;
672 if (object->type == type)
676 dev_warn(&data->client->dev, "Invalid object type T%u\n", type);
680 static void mxt_proc_t6_messages(struct mxt_data *data, u8 *msg)
682 struct device *dev = &data->client->dev;
684 u32 crc = msg[2] | (msg[3] << 8) | (msg[4] << 16);
686 complete(&data->crc_completion);
688 if (crc != data->config_crc) {
689 data->config_crc = crc;
690 dev_dbg(dev, "T6 Config Checksum: 0x%06X\n", crc);
694 if (status & MXT_T6_STATUS_RESET)
695 complete(&data->reset_completion);
697 /* Output debug if status has changed */
698 if (status != data->t6_status)
699 dev_dbg(dev, "T6 Status 0x%02X%s%s%s%s%s%s%s\n",
701 status == 0 ? " OK" : "",
702 status & MXT_T6_STATUS_RESET ? " RESET" : "",
703 status & MXT_T6_STATUS_OFL ? " OFL" : "",
704 status & MXT_T6_STATUS_SIGERR ? " SIGERR" : "",
705 status & MXT_T6_STATUS_CAL ? " CAL" : "",
706 status & MXT_T6_STATUS_CFGERR ? " CFGERR" : "",
707 status & MXT_T6_STATUS_COMSERR ? " COMSERR" : "");
709 /* Save current status */
710 data->t6_status = status;
713 static int mxt_write_object(struct mxt_data *data,
714 u8 type, u8 offset, u8 val)
716 struct mxt_object *object;
719 object = mxt_get_object(data, type);
720 if (!object || offset >= mxt_obj_size(object))
723 reg = object->start_address;
724 return mxt_write_reg(data->client, reg + offset, val);
727 static void mxt_input_button(struct mxt_data *data, u8 *message)
729 struct input_dev *input = data->input_dev;
730 const struct mxt_platform_data *pdata = data->pdata;
733 for (i = 0; i < pdata->t19_num_keys; i++) {
734 if (pdata->t19_keymap[i] == KEY_RESERVED)
737 /* Active-low switch */
738 input_report_key(input, pdata->t19_keymap[i],
739 !(message[1] & BIT(i)));
743 static void mxt_input_sync(struct mxt_data *data)
745 input_mt_report_pointer_emulation(data->input_dev,
746 data->pdata->t19_num_keys);
747 input_sync(data->input_dev);
750 static void mxt_proc_t9_message(struct mxt_data *data, u8 *message)
752 struct device *dev = &data->client->dev;
753 struct input_dev *input_dev = data->input_dev;
761 id = message[0] - data->T9_reportid_min;
763 x = (message[2] << 4) | ((message[4] >> 4) & 0xf);
764 y = (message[3] << 4) | ((message[4] & 0xf));
766 /* Handle 10/12 bit switching */
767 if (data->max_x < 1024)
769 if (data->max_y < 1024)
773 amplitude = message[6];
776 "[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
778 (status & MXT_T9_DETECT) ? 'D' : '.',
779 (status & MXT_T9_PRESS) ? 'P' : '.',
780 (status & MXT_T9_RELEASE) ? 'R' : '.',
781 (status & MXT_T9_MOVE) ? 'M' : '.',
782 (status & MXT_T9_VECTOR) ? 'V' : '.',
783 (status & MXT_T9_AMP) ? 'A' : '.',
784 (status & MXT_T9_SUPPRESS) ? 'S' : '.',
785 (status & MXT_T9_UNGRIP) ? 'U' : '.',
786 x, y, area, amplitude);
788 input_mt_slot(input_dev, id);
790 if (status & MXT_T9_DETECT) {
792 * Multiple bits may be set if the host is slow to read
793 * the status messages, indicating all the events that
796 if (status & MXT_T9_RELEASE) {
797 input_mt_report_slot_state(input_dev,
799 mxt_input_sync(data);
803 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 1);
804 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
805 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
806 input_report_abs(input_dev, ABS_MT_PRESSURE, amplitude);
807 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
809 /* Touch no longer active, close out slot */
810 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 0);
813 data->update_input = true;
816 static void mxt_proc_t100_message(struct mxt_data *data, u8 *message)
818 struct device *dev = &data->client->dev;
819 struct input_dev *input_dev = data->input_dev;
831 id = message[0] - data->T100_reportid_min - 2;
833 /* ignore SCRSTATUS events */
838 x = get_unaligned_le16(&message[2]);
839 y = get_unaligned_le16(&message[4]);
841 if (status & MXT_T100_DETECT) {
842 type = (status & MXT_T100_TYPE_MASK) >> 4;
845 case MXT_T100_TYPE_HOVERING_FINGER:
846 tool = MT_TOOL_FINGER;
847 distance = MXT_DISTANCE_HOVERING;
849 if (data->t100_aux_vect)
850 orientation = message[data->t100_aux_vect];
854 case MXT_T100_TYPE_FINGER:
855 case MXT_T100_TYPE_GLOVE:
856 tool = MT_TOOL_FINGER;
857 distance = MXT_DISTANCE_ACTIVE_TOUCH;
859 if (data->t100_aux_area)
860 major = message[data->t100_aux_area];
862 if (data->t100_aux_ampl)
863 pressure = message[data->t100_aux_ampl];
865 if (data->t100_aux_vect)
866 orientation = message[data->t100_aux_vect];
870 case MXT_T100_TYPE_PASSIVE_STYLUS:
874 * Passive stylus is reported with size zero so
877 major = MXT_TOUCH_MAJOR_DEFAULT;
879 if (data->t100_aux_ampl)
880 pressure = message[data->t100_aux_ampl];
884 case MXT_T100_TYPE_LARGE_TOUCH:
885 /* Ignore suppressed touch */
889 dev_dbg(dev, "Unexpected T100 type\n");
895 * Values reported should be non-zero if tool is touching the
898 if (!pressure && type != MXT_T100_TYPE_HOVERING_FINGER)
899 pressure = MXT_PRESSURE_DEFAULT;
901 input_mt_slot(input_dev, id);
903 if (status & MXT_T100_DETECT) {
904 dev_dbg(dev, "[%u] type:%u x:%u y:%u a:%02X p:%02X v:%02X\n",
905 id, type, x, y, major, pressure, orientation);
907 input_mt_report_slot_state(input_dev, tool, 1);
908 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
909 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
910 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, major);
911 input_report_abs(input_dev, ABS_MT_PRESSURE, pressure);
912 input_report_abs(input_dev, ABS_MT_DISTANCE, distance);
913 input_report_abs(input_dev, ABS_MT_ORIENTATION, orientation);
915 dev_dbg(dev, "[%u] release\n", id);
918 input_mt_report_slot_state(input_dev, 0, 0);
921 data->update_input = true;
924 static int mxt_proc_message(struct mxt_data *data, u8 *message)
926 u8 report_id = message[0];
928 if (report_id == MXT_RPTID_NOMSG)
931 if (report_id == data->T6_reportid) {
932 mxt_proc_t6_messages(data, message);
933 } else if (!data->input_dev) {
935 * Do not report events if input device
936 * is not yet registered.
938 mxt_dump_message(data, message);
939 } else if (report_id >= data->T9_reportid_min &&
940 report_id <= data->T9_reportid_max) {
941 mxt_proc_t9_message(data, message);
942 } else if (report_id >= data->T100_reportid_min &&
943 report_id <= data->T100_reportid_max) {
944 mxt_proc_t100_message(data, message);
945 } else if (report_id == data->T19_reportid) {
946 mxt_input_button(data, message);
947 data->update_input = true;
949 mxt_dump_message(data, message);
955 static int mxt_read_and_process_messages(struct mxt_data *data, u8 count)
957 struct device *dev = &data->client->dev;
962 /* Safety check for msg_buf */
963 if (count > data->max_reportid)
966 /* Process remaining messages if necessary */
967 ret = __mxt_read_reg(data->client, data->T5_address,
968 data->T5_msg_size * count, data->msg_buf);
970 dev_err(dev, "Failed to read %u messages (%d)\n", count, ret);
974 for (i = 0; i < count; i++) {
975 ret = mxt_proc_message(data,
976 data->msg_buf + data->T5_msg_size * i);
982 /* return number of messages read */
986 static irqreturn_t mxt_process_messages_t44(struct mxt_data *data)
988 struct device *dev = &data->client->dev;
992 /* Read T44 and T5 together */
993 ret = __mxt_read_reg(data->client, data->T44_address,
994 data->T5_msg_size + 1, data->msg_buf);
996 dev_err(dev, "Failed to read T44 and T5 (%d)\n", ret);
1000 count = data->msg_buf[0];
1003 * This condition may be caused by the CHG line being configured in
1004 * Mode 0. It results in unnecessary I2C operations but it is benign.
1009 if (count > data->max_reportid) {
1010 dev_warn(dev, "T44 count %d exceeded max report id\n", count);
1011 count = data->max_reportid;
1014 /* Process first message */
1015 ret = mxt_proc_message(data, data->msg_buf + 1);
1017 dev_warn(dev, "Unexpected invalid message\n");
1021 num_left = count - 1;
1023 /* Process remaining messages if necessary */
1025 ret = mxt_read_and_process_messages(data, num_left);
1028 else if (ret != num_left)
1029 dev_warn(dev, "Unexpected invalid message\n");
1033 if (data->update_input) {
1034 mxt_input_sync(data);
1035 data->update_input = false;
1041 static int mxt_process_messages_until_invalid(struct mxt_data *data)
1043 struct device *dev = &data->client->dev;
1047 count = data->max_reportid;
1049 /* Read messages until we force an invalid */
1051 read = mxt_read_and_process_messages(data, count);
1056 if (data->update_input) {
1057 mxt_input_sync(data);
1058 data->update_input = false;
1061 dev_err(dev, "CHG pin isn't cleared\n");
1065 static irqreturn_t mxt_process_messages(struct mxt_data *data)
1067 int total_handled, num_handled;
1068 u8 count = data->last_message_count;
1070 if (count < 1 || count > data->max_reportid)
1073 /* include final invalid message */
1074 total_handled = mxt_read_and_process_messages(data, count + 1);
1075 if (total_handled < 0)
1077 /* if there were invalid messages, then we are done */
1078 else if (total_handled <= count)
1081 /* keep reading two msgs until one is invalid or reportid limit */
1083 num_handled = mxt_read_and_process_messages(data, 2);
1084 if (num_handled < 0)
1087 total_handled += num_handled;
1089 if (num_handled < 2)
1091 } while (total_handled < data->num_touchids);
1094 data->last_message_count = total_handled;
1096 if (data->update_input) {
1097 mxt_input_sync(data);
1098 data->update_input = false;
1104 static irqreturn_t mxt_interrupt(int irq, void *dev_id)
1106 struct mxt_data *data = dev_id;
1108 if (data->in_bootloader) {
1109 /* bootloader state transition completion */
1110 complete(&data->bl_completion);
1114 if (!data->object_table)
1117 if (data->T44_address) {
1118 return mxt_process_messages_t44(data);
1120 return mxt_process_messages(data);
1124 static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset,
1125 u8 value, bool wait)
1128 u8 command_register;
1129 int timeout_counter = 0;
1132 reg = data->T6_address + cmd_offset;
1134 ret = mxt_write_reg(data->client, reg, value);
1143 ret = __mxt_read_reg(data->client, reg, 1, &command_register);
1146 } while (command_register != 0 && timeout_counter++ <= 100);
1148 if (timeout_counter > 100) {
1149 dev_err(&data->client->dev, "Command failed!\n");
1156 static int mxt_acquire_irq(struct mxt_data *data)
1160 enable_irq(data->irq);
1162 error = mxt_process_messages_until_invalid(data);
1169 static int mxt_soft_reset(struct mxt_data *data)
1171 struct device *dev = &data->client->dev;
1174 dev_info(dev, "Resetting device\n");
1176 disable_irq(data->irq);
1178 reinit_completion(&data->reset_completion);
1180 ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false);
1184 /* Ignore CHG line for 100ms after reset */
1187 mxt_acquire_irq(data);
1189 ret = mxt_wait_for_completion(data, &data->reset_completion,
1197 static void mxt_update_crc(struct mxt_data *data, u8 cmd, u8 value)
1200 * On failure, CRC is set to 0 and config will always be
1203 data->config_crc = 0;
1204 reinit_completion(&data->crc_completion);
1206 mxt_t6_command(data, cmd, value, true);
1209 * Wait for crc message. On failure, CRC is set to 0 and config will
1210 * always be downloaded.
1212 mxt_wait_for_completion(data, &data->crc_completion, MXT_CRC_TIMEOUT);
1215 static void mxt_calc_crc24(u32 *crc, u8 firstbyte, u8 secondbyte)
1217 static const unsigned int crcpoly = 0x80001B;
1221 data_word = (secondbyte << 8) | firstbyte;
1222 result = ((*crc << 1) ^ data_word);
1224 if (result & 0x1000000)
1230 static u32 mxt_calculate_crc(u8 *base, off_t start_off, off_t end_off)
1233 u8 *ptr = base + start_off;
1234 u8 *last_val = base + end_off - 1;
1236 if (end_off < start_off)
1239 while (ptr < last_val) {
1240 mxt_calc_crc24(&crc, *ptr, *(ptr + 1));
1244 /* if len is odd, fill the last byte with 0 */
1245 if (ptr == last_val)
1246 mxt_calc_crc24(&crc, *ptr, 0);
1248 /* Mask to 24-bit */
1254 static int mxt_prepare_cfg_mem(struct mxt_data *data,
1255 const struct firmware *cfg,
1256 unsigned int data_pos,
1257 unsigned int cfg_start_ofs,
1259 size_t config_mem_size)
1261 struct device *dev = &data->client->dev;
1262 struct mxt_object *object;
1263 unsigned int type, instance, size, byte_offset;
1270 while (data_pos < cfg->size) {
1271 /* Read type, instance, length */
1272 ret = sscanf(cfg->data + data_pos, "%x %x %x%n",
1273 &type, &instance, &size, &offset);
1277 } else if (ret != 3) {
1278 dev_err(dev, "Bad format: failed to parse object\n");
1283 object = mxt_get_object(data, type);
1286 for (i = 0; i < size; i++) {
1287 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1290 dev_err(dev, "Bad format in T%d at %d\n",
1299 if (size > mxt_obj_size(object)) {
1301 * Either we are in fallback mode due to wrong
1302 * config or config from a later fw version,
1303 * or the file is corrupt or hand-edited.
1305 dev_warn(dev, "Discarding %zu byte(s) in T%u\n",
1306 size - mxt_obj_size(object), type);
1307 } else if (mxt_obj_size(object) > size) {
1309 * If firmware is upgraded, new bytes may be added to
1310 * end of objects. It is generally forward compatible
1311 * to zero these bytes - previous behaviour will be
1312 * retained. However this does invalidate the CRC and
1313 * will force fallback mode until the configuration is
1314 * updated. We warn here but do nothing else - the
1315 * malloc has zeroed the entire configuration.
1317 dev_warn(dev, "Zeroing %zu byte(s) in T%d\n",
1318 mxt_obj_size(object) - size, type);
1321 if (instance >= mxt_obj_instances(object)) {
1322 dev_err(dev, "Object instances exceeded!\n");
1326 reg = object->start_address + mxt_obj_size(object) * instance;
1328 for (i = 0; i < size; i++) {
1329 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1333 dev_err(dev, "Bad format in T%d at %d\n",
1339 if (i > mxt_obj_size(object))
1342 byte_offset = reg + i - cfg_start_ofs;
1344 if (byte_offset >= 0 && byte_offset < config_mem_size) {
1345 *(config_mem + byte_offset) = val;
1347 dev_err(dev, "Bad object: reg:%d, T%d, ofs=%d\n",
1348 reg, object->type, byte_offset);
1357 static int mxt_upload_cfg_mem(struct mxt_data *data, unsigned int cfg_start,
1358 u8 *config_mem, size_t config_mem_size)
1360 unsigned int byte_offset = 0;
1363 /* Write configuration as blocks */
1364 while (byte_offset < config_mem_size) {
1365 unsigned int size = config_mem_size - byte_offset;
1367 if (size > MXT_MAX_BLOCK_WRITE)
1368 size = MXT_MAX_BLOCK_WRITE;
1370 error = __mxt_write_reg(data->client,
1371 cfg_start + byte_offset,
1372 size, config_mem + byte_offset);
1374 dev_err(&data->client->dev,
1375 "Config write error, ret=%d\n", error);
1379 byte_offset += size;
1385 static int mxt_init_t7_power_cfg(struct mxt_data *data);
1388 * mxt_update_cfg - download configuration to chip
1390 * Atmel Raw Config File Format
1392 * The first four lines of the raw config file contain:
1394 * 2) Chip ID Information (first 7 bytes of device memory)
1395 * 3) Chip Information Block 24-bit CRC Checksum
1396 * 4) Chip Configuration 24-bit CRC Checksum
1398 * The rest of the file consists of one line per object instance:
1399 * <TYPE> <INSTANCE> <SIZE> <CONTENTS>
1401 * <TYPE> - 2-byte object type as hex
1402 * <INSTANCE> - 2-byte object instance number as hex
1403 * <SIZE> - 2-byte object size as hex
1404 * <CONTENTS> - array of <SIZE> 1-byte hex values
1406 static int mxt_update_cfg(struct mxt_data *data, const struct firmware *cfg)
1408 struct device *dev = &data->client->dev;
1409 struct mxt_info cfg_info;
1415 u32 info_crc, config_crc, calculated_crc;
1417 size_t config_mem_size;
1419 mxt_update_crc(data, MXT_COMMAND_REPORTALL, 1);
1421 if (strncmp(cfg->data, MXT_CFG_MAGIC, strlen(MXT_CFG_MAGIC))) {
1422 dev_err(dev, "Unrecognised config file\n");
1426 data_pos = strlen(MXT_CFG_MAGIC);
1428 /* Load information block and check */
1429 for (i = 0; i < sizeof(struct mxt_info); i++) {
1430 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1431 (unsigned char *)&cfg_info + i,
1434 dev_err(dev, "Bad format\n");
1441 if (cfg_info.family_id != data->info.family_id) {
1442 dev_err(dev, "Family ID mismatch!\n");
1446 if (cfg_info.variant_id != data->info.variant_id) {
1447 dev_err(dev, "Variant ID mismatch!\n");
1452 ret = sscanf(cfg->data + data_pos, "%x%n", &info_crc, &offset);
1454 dev_err(dev, "Bad format: failed to parse Info CRC\n");
1459 ret = sscanf(cfg->data + data_pos, "%x%n", &config_crc, &offset);
1461 dev_err(dev, "Bad format: failed to parse Config CRC\n");
1467 * The Info Block CRC is calculated over mxt_info and the object
1468 * table. If it does not match then we are trying to load the
1469 * configuration from a different chip or firmware version, so
1470 * the configuration CRC is invalid anyway.
1472 if (info_crc == data->info_crc) {
1473 if (config_crc == 0 || data->config_crc == 0) {
1474 dev_info(dev, "CRC zero, attempting to apply config\n");
1475 } else if (config_crc == data->config_crc) {
1476 dev_dbg(dev, "Config CRC 0x%06X: OK\n",
1480 dev_info(dev, "Config CRC 0x%06X: does not match file 0x%06X\n",
1481 data->config_crc, config_crc);
1485 "Warning: Info CRC error - device=0x%06X file=0x%06X\n",
1486 data->info_crc, info_crc);
1489 /* Malloc memory to store configuration */
1490 cfg_start_ofs = MXT_OBJECT_START +
1491 data->info.object_num * sizeof(struct mxt_object) +
1492 MXT_INFO_CHECKSUM_SIZE;
1493 config_mem_size = data->mem_size - cfg_start_ofs;
1494 config_mem = kzalloc(config_mem_size, GFP_KERNEL);
1496 dev_err(dev, "Failed to allocate memory\n");
1500 ret = mxt_prepare_cfg_mem(data, cfg, data_pos, cfg_start_ofs,
1501 config_mem, config_mem_size);
1505 /* Calculate crc of the received configs (not the raw config file) */
1506 if (data->T7_address < cfg_start_ofs) {
1507 dev_err(dev, "Bad T7 address, T7addr = %x, config offset %x\n",
1508 data->T7_address, cfg_start_ofs);
1513 calculated_crc = mxt_calculate_crc(config_mem,
1514 data->T7_address - cfg_start_ofs,
1517 if (config_crc > 0 && config_crc != calculated_crc)
1518 dev_warn(dev, "Config CRC error, calculated=%06X, file=%06X\n",
1519 calculated_crc, config_crc);
1521 ret = mxt_upload_cfg_mem(data, cfg_start_ofs,
1522 config_mem, config_mem_size);
1526 mxt_update_crc(data, MXT_COMMAND_BACKUPNV, MXT_BACKUP_VALUE);
1528 ret = mxt_soft_reset(data);
1532 dev_info(dev, "Config successfully updated\n");
1534 /* T7 config may have changed */
1535 mxt_init_t7_power_cfg(data);
1542 static int mxt_get_info(struct mxt_data *data)
1544 struct i2c_client *client = data->client;
1545 struct mxt_info *info = &data->info;
1548 /* Read 7-byte info block starting at address 0 */
1549 error = __mxt_read_reg(client, 0, sizeof(*info), info);
1556 static void mxt_free_input_device(struct mxt_data *data)
1558 if (data->input_dev) {
1559 input_unregister_device(data->input_dev);
1560 data->input_dev = NULL;
1564 static void mxt_free_object_table(struct mxt_data *data)
1566 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
1567 video_unregister_device(&data->dbg.vdev);
1568 v4l2_device_unregister(&data->dbg.v4l2);
1571 kfree(data->object_table);
1572 data->object_table = NULL;
1573 kfree(data->msg_buf);
1574 data->msg_buf = NULL;
1575 data->T5_address = 0;
1576 data->T5_msg_size = 0;
1577 data->T6_reportid = 0;
1578 data->T7_address = 0;
1579 data->T9_reportid_min = 0;
1580 data->T9_reportid_max = 0;
1581 data->T19_reportid = 0;
1582 data->T44_address = 0;
1583 data->T100_reportid_min = 0;
1584 data->T100_reportid_max = 0;
1585 data->max_reportid = 0;
1588 static int mxt_get_object_table(struct mxt_data *data)
1590 struct i2c_client *client = data->client;
1592 struct mxt_object *object_table;
1598 table_size = data->info.object_num * sizeof(struct mxt_object);
1599 object_table = kzalloc(table_size, GFP_KERNEL);
1600 if (!object_table) {
1601 dev_err(&data->client->dev, "Failed to allocate memory\n");
1605 error = __mxt_read_reg(client, MXT_OBJECT_START, table_size,
1608 kfree(object_table);
1612 /* Valid Report IDs start counting from 1 */
1615 for (i = 0; i < data->info.object_num; i++) {
1616 struct mxt_object *object = object_table + i;
1619 le16_to_cpus(&object->start_address);
1621 if (object->num_report_ids) {
1623 reportid += object->num_report_ids *
1624 mxt_obj_instances(object);
1625 max_id = reportid - 1;
1631 dev_dbg(&data->client->dev,
1632 "T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n",
1633 object->type, object->start_address,
1634 mxt_obj_size(object), mxt_obj_instances(object),
1637 switch (object->type) {
1638 case MXT_GEN_MESSAGE_T5:
1639 if (data->info.family_id == 0x80 &&
1640 data->info.version < 0x20) {
1642 * On mXT224 firmware versions prior to V2.0
1643 * read and discard unused CRC byte otherwise
1644 * DMA reads are misaligned.
1646 data->T5_msg_size = mxt_obj_size(object);
1648 /* CRC not enabled, so skip last byte */
1649 data->T5_msg_size = mxt_obj_size(object) - 1;
1651 data->T5_address = object->start_address;
1653 case MXT_GEN_COMMAND_T6:
1654 data->T6_reportid = min_id;
1655 data->T6_address = object->start_address;
1657 case MXT_GEN_POWER_T7:
1658 data->T7_address = object->start_address;
1660 case MXT_TOUCH_MULTI_T9:
1661 data->multitouch = MXT_TOUCH_MULTI_T9;
1662 data->T9_reportid_min = min_id;
1663 data->T9_reportid_max = max_id;
1664 data->num_touchids = object->num_report_ids
1665 * mxt_obj_instances(object);
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");
1696 goto free_object_table;
1699 data->msg_buf = kcalloc(data->max_reportid,
1700 data->T5_msg_size, GFP_KERNEL);
1701 if (!data->msg_buf) {
1702 dev_err(&client->dev, "Failed to allocate message buffer\n");
1704 goto free_object_table;
1707 data->object_table = object_table;
1712 mxt_free_object_table(data);
1716 static int mxt_read_t9_resolution(struct mxt_data *data)
1718 struct i2c_client *client = data->client;
1720 struct t9_range range;
1721 unsigned char orient;
1722 struct mxt_object *object;
1724 object = mxt_get_object(data, MXT_TOUCH_MULTI_T9);
1728 error = __mxt_read_reg(client,
1729 object->start_address + MXT_T9_XSIZE,
1730 sizeof(data->xsize), &data->xsize);
1734 error = __mxt_read_reg(client,
1735 object->start_address + MXT_T9_YSIZE,
1736 sizeof(data->ysize), &data->ysize);
1740 error = __mxt_read_reg(client,
1741 object->start_address + MXT_T9_RANGE,
1742 sizeof(range), &range);
1746 data->max_x = get_unaligned_le16(&range.x);
1747 data->max_y = get_unaligned_le16(&range.y);
1749 error = __mxt_read_reg(client,
1750 object->start_address + MXT_T9_ORIENT,
1755 data->xy_switch = orient & MXT_T9_ORIENT_SWITCH;
1756 data->invertx = orient & MXT_T9_ORIENT_INVERTX;
1757 data->inverty = orient & MXT_T9_ORIENT_INVERTY;
1762 static int mxt_read_t100_config(struct mxt_data *data)
1764 struct i2c_client *client = data->client;
1766 struct mxt_object *object;
1767 u16 range_x, range_y;
1771 object = mxt_get_object(data, MXT_TOUCH_MULTITOUCHSCREEN_T100);
1775 /* read touchscreen dimensions */
1776 error = __mxt_read_reg(client,
1777 object->start_address + MXT_T100_XRANGE,
1778 sizeof(range_x), &range_x);
1782 data->max_x = get_unaligned_le16(&range_x);
1784 error = __mxt_read_reg(client,
1785 object->start_address + MXT_T100_YRANGE,
1786 sizeof(range_y), &range_y);
1790 data->max_y = get_unaligned_le16(&range_y);
1792 error = __mxt_read_reg(client,
1793 object->start_address + MXT_T100_XSIZE,
1794 sizeof(data->xsize), &data->xsize);
1798 error = __mxt_read_reg(client,
1799 object->start_address + MXT_T100_YSIZE,
1800 sizeof(data->ysize), &data->ysize);
1804 /* read orientation config */
1805 error = __mxt_read_reg(client,
1806 object->start_address + MXT_T100_CFG1,
1811 data->xy_switch = cfg & MXT_T100_CFG_SWITCHXY;
1812 data->invertx = cfg & MXT_T100_CFG_INVERTX;
1813 data->inverty = cfg & MXT_T100_CFG_INVERTY;
1815 /* allocate aux bytes */
1816 error = __mxt_read_reg(client,
1817 object->start_address + MXT_T100_TCHAUX,
1824 if (tchaux & MXT_T100_TCHAUX_VECT)
1825 data->t100_aux_vect = aux++;
1827 if (tchaux & MXT_T100_TCHAUX_AMPL)
1828 data->t100_aux_ampl = aux++;
1830 if (tchaux & MXT_T100_TCHAUX_AREA)
1831 data->t100_aux_area = aux++;
1833 dev_dbg(&client->dev,
1834 "T100 aux mappings vect:%u ampl:%u area:%u\n",
1835 data->t100_aux_vect, data->t100_aux_ampl, data->t100_aux_area);
1840 static int mxt_input_open(struct input_dev *dev);
1841 static void mxt_input_close(struct input_dev *dev);
1843 static void mxt_set_up_as_touchpad(struct input_dev *input_dev,
1844 struct mxt_data *data)
1846 const struct mxt_platform_data *pdata = data->pdata;
1849 input_dev->name = "Atmel maXTouch Touchpad";
1851 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
1853 input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM);
1854 input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM);
1855 input_abs_set_res(input_dev, ABS_MT_POSITION_X,
1857 input_abs_set_res(input_dev, ABS_MT_POSITION_Y,
1860 for (i = 0; i < pdata->t19_num_keys; i++)
1861 if (pdata->t19_keymap[i] != KEY_RESERVED)
1862 input_set_capability(input_dev, EV_KEY,
1863 pdata->t19_keymap[i]);
1866 static int mxt_initialize_input_device(struct mxt_data *data)
1868 const struct mxt_platform_data *pdata = data->pdata;
1869 struct device *dev = &data->client->dev;
1870 struct input_dev *input_dev;
1872 unsigned int num_mt_slots;
1873 unsigned int mt_flags = 0;
1875 switch (data->multitouch) {
1876 case MXT_TOUCH_MULTI_T9:
1877 num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
1878 error = mxt_read_t9_resolution(data);
1880 dev_warn(dev, "Failed to initialize T9 resolution\n");
1883 case MXT_TOUCH_MULTITOUCHSCREEN_T100:
1884 num_mt_slots = data->num_touchids;
1885 error = mxt_read_t100_config(data);
1887 dev_warn(dev, "Failed to read T100 config\n");
1891 dev_err(dev, "Invalid multitouch object\n");
1895 /* Handle default values and orientation switch */
1896 if (data->max_x == 0)
1899 if (data->max_y == 0)
1902 if (data->xy_switch)
1903 swap(data->max_x, data->max_y);
1905 dev_info(dev, "Touchscreen size X%uY%u\n", data->max_x, data->max_y);
1907 /* Register input device */
1908 input_dev = input_allocate_device();
1910 dev_err(dev, "Failed to allocate memory\n");
1914 input_dev->name = "Atmel maXTouch Touchscreen";
1915 input_dev->phys = data->phys;
1916 input_dev->id.bustype = BUS_I2C;
1917 input_dev->dev.parent = dev;
1918 input_dev->open = mxt_input_open;
1919 input_dev->close = mxt_input_close;
1921 input_set_capability(input_dev, EV_KEY, BTN_TOUCH);
1923 /* For single touch */
1924 input_set_abs_params(input_dev, ABS_X, 0, data->max_x, 0, 0);
1925 input_set_abs_params(input_dev, ABS_Y, 0, data->max_y, 0, 0);
1927 if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
1928 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1929 data->t100_aux_ampl)) {
1930 input_set_abs_params(input_dev, ABS_PRESSURE, 0, 255, 0, 0);
1933 /* If device has buttons we assume it is a touchpad */
1934 if (pdata->t19_num_keys) {
1935 mxt_set_up_as_touchpad(input_dev, data);
1936 mt_flags |= INPUT_MT_POINTER;
1938 mt_flags |= INPUT_MT_DIRECT;
1941 /* For multi touch */
1942 error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags);
1944 dev_err(dev, "Error %d initialising slots\n", error);
1948 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100) {
1949 input_set_abs_params(input_dev, ABS_MT_TOOL_TYPE,
1950 0, MT_TOOL_MAX, 0, 0);
1951 input_set_abs_params(input_dev, ABS_MT_DISTANCE,
1952 MXT_DISTANCE_ACTIVE_TOUCH,
1953 MXT_DISTANCE_HOVERING,
1957 input_set_abs_params(input_dev, ABS_MT_POSITION_X,
1958 0, data->max_x, 0, 0);
1959 input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
1960 0, data->max_y, 0, 0);
1962 if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
1963 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1964 data->t100_aux_area)) {
1965 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
1966 0, MXT_MAX_AREA, 0, 0);
1969 if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
1970 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1971 data->t100_aux_ampl)) {
1972 input_set_abs_params(input_dev, ABS_MT_PRESSURE,
1976 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1977 data->t100_aux_vect) {
1978 input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
1982 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1983 data->t100_aux_ampl) {
1984 input_set_abs_params(input_dev, ABS_MT_PRESSURE,
1988 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1989 data->t100_aux_vect) {
1990 input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
1994 input_set_drvdata(input_dev, data);
1996 error = input_register_device(input_dev);
1998 dev_err(dev, "Error %d registering input device\n", error);
2002 data->input_dev = input_dev;
2007 input_free_device(input_dev);
2011 static int mxt_configure_objects(struct mxt_data *data,
2012 const struct firmware *cfg);
2014 static void mxt_config_cb(const struct firmware *cfg, void *ctx)
2016 mxt_configure_objects(ctx, cfg);
2017 release_firmware(cfg);
2020 static int mxt_initialize(struct mxt_data *data)
2022 struct i2c_client *client = data->client;
2023 int recovery_attempts = 0;
2027 error = mxt_get_info(data);
2031 /* Check bootloader state */
2032 error = mxt_probe_bootloader(data, false);
2034 dev_info(&client->dev, "Trying alternate bootloader address\n");
2035 error = mxt_probe_bootloader(data, true);
2037 /* Chip is not in appmode or bootloader mode */
2042 /* OK, we are in bootloader, see if we can recover */
2043 if (++recovery_attempts > 1) {
2044 dev_err(&client->dev, "Could not recover from bootloader mode\n");
2046 * We can reflash from this state, so do not
2047 * abort initialization.
2049 data->in_bootloader = true;
2053 /* Attempt to exit bootloader into app mode */
2054 mxt_send_bootloader_cmd(data, false);
2055 msleep(MXT_FW_RESET_TIME);
2058 /* Get object table information */
2059 error = mxt_get_object_table(data);
2061 dev_err(&client->dev, "Error %d reading object table\n", error);
2065 error = mxt_acquire_irq(data);
2067 goto err_free_object_table;
2069 error = request_firmware_nowait(THIS_MODULE, true, MXT_CFG_NAME,
2070 &client->dev, GFP_KERNEL, data,
2073 dev_err(&client->dev, "Failed to invoke firmware loader: %d\n",
2075 goto err_free_object_table;
2080 err_free_object_table:
2081 mxt_free_object_table(data);
2085 static int mxt_set_t7_power_cfg(struct mxt_data *data, u8 sleep)
2087 struct device *dev = &data->client->dev;
2089 struct t7_config *new_config;
2090 struct t7_config deepsleep = { .active = 0, .idle = 0 };
2092 if (sleep == MXT_POWER_CFG_DEEPSLEEP)
2093 new_config = &deepsleep;
2095 new_config = &data->t7_cfg;
2097 error = __mxt_write_reg(data->client, data->T7_address,
2098 sizeof(data->t7_cfg), new_config);
2102 dev_dbg(dev, "Set T7 ACTV:%d IDLE:%d\n",
2103 new_config->active, new_config->idle);
2108 static int mxt_init_t7_power_cfg(struct mxt_data *data)
2110 struct device *dev = &data->client->dev;
2115 error = __mxt_read_reg(data->client, data->T7_address,
2116 sizeof(data->t7_cfg), &data->t7_cfg);
2120 if (data->t7_cfg.active == 0 || data->t7_cfg.idle == 0) {
2122 dev_dbg(dev, "T7 cfg zero, resetting\n");
2123 mxt_soft_reset(data);
2127 dev_dbg(dev, "T7 cfg zero after reset, overriding\n");
2128 data->t7_cfg.active = 20;
2129 data->t7_cfg.idle = 100;
2130 return mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
2134 dev_dbg(dev, "Initialized power cfg: ACTV %d, IDLE %d\n",
2135 data->t7_cfg.active, data->t7_cfg.idle);
2139 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
2140 static u16 mxt_get_debug_value(struct mxt_data *data, unsigned int x,
2143 struct mxt_dbg *dbg = &data->dbg;
2144 unsigned int ofs, page;
2146 ofs = (y + (x * data->info.matrix_ysize)) * sizeof(u16);
2147 page = ofs / MXT_DIAGNOSTIC_SIZE;
2148 ofs %= MXT_DIAGNOSTIC_SIZE;
2150 return get_unaligned_le16(&dbg->t37_buf[page].data[ofs]);
2153 static int mxt_convert_debug_pages(struct mxt_data *data, u16 *outbuf)
2155 struct mxt_dbg *dbg = &data->dbg;
2158 unsigned int i, rx, ry;
2160 for (i = 0; i < dbg->t37_nodes; i++) {
2161 /* Handle orientation */
2162 rx = data->xy_switch ? y : x;
2163 ry = data->xy_switch ? x : y;
2164 rx = data->invertx ? (data->xsize - 1 - rx) : rx;
2165 ry = data->inverty ? (data->ysize - 1 - ry) : ry;
2167 outbuf[i] = mxt_get_debug_value(data, rx, ry);
2170 if (++x >= (data->xy_switch ? data->ysize : data->xsize)) {
2179 static int mxt_read_diagnostic_debug(struct mxt_data *data, u8 mode,
2182 struct mxt_dbg *dbg = &data->dbg;
2187 struct t37_debug *p;
2190 for (page = 0; page < dbg->t37_pages; page++) {
2191 p = dbg->t37_buf + page;
2193 ret = mxt_write_reg(data->client, dbg->diag_cmd_address,
2201 /* Read back command byte */
2202 ret = __mxt_read_reg(data->client, dbg->diag_cmd_address,
2203 sizeof(cmd_poll), &cmd_poll);
2207 /* Field is cleared once the command has been processed */
2209 if (retries++ > 100)
2217 ret = __mxt_read_reg(data->client, dbg->t37_address,
2218 sizeof(struct t37_debug), p);
2222 if (p->mode != mode || p->page != page) {
2223 dev_err(&data->client->dev, "T37 page mismatch\n");
2227 dev_dbg(&data->client->dev, "%s page:%d retries:%d\n",
2228 __func__, page, retries);
2230 /* For remaining pages, write PAGEUP rather than mode */
2231 cmd = MXT_DIAGNOSTIC_PAGEUP;
2234 return mxt_convert_debug_pages(data, outbuf);
2237 static int mxt_queue_setup(struct vb2_queue *q,
2238 unsigned int *nbuffers, unsigned int *nplanes,
2239 unsigned int sizes[], struct device *alloc_devs[])
2241 struct mxt_data *data = q->drv_priv;
2242 size_t size = data->dbg.t37_nodes * sizeof(u16);
2245 return sizes[0] < size ? -EINVAL : 0;
2253 static void mxt_buffer_queue(struct vb2_buffer *vb)
2255 struct mxt_data *data = vb2_get_drv_priv(vb->vb2_queue);
2259 ptr = vb2_plane_vaddr(vb, 0);
2261 dev_err(&data->client->dev, "Error acquiring frame ptr\n");
2265 ret = mxt_read_diagnostic_debug(data, MXT_DIAGNOSTIC_DELTAS, ptr);
2269 vb2_set_plane_payload(vb, 0, data->dbg.t37_nodes * sizeof(u16));
2270 vb2_buffer_done(vb, VB2_BUF_STATE_DONE);
2274 vb2_buffer_done(vb, VB2_BUF_STATE_ERROR);
2277 /* V4L2 structures */
2278 static const struct vb2_ops mxt_queue_ops = {
2279 .queue_setup = mxt_queue_setup,
2280 .buf_queue = mxt_buffer_queue,
2281 .wait_prepare = vb2_ops_wait_prepare,
2282 .wait_finish = vb2_ops_wait_finish,
2285 static const struct vb2_queue mxt_queue = {
2286 .type = V4L2_BUF_TYPE_VIDEO_CAPTURE,
2287 .io_modes = VB2_MMAP | VB2_USERPTR | VB2_DMABUF | VB2_READ,
2288 .buf_struct_size = sizeof(struct mxt_vb2_buffer),
2289 .ops = &mxt_queue_ops,
2290 .mem_ops = &vb2_vmalloc_memops,
2291 .timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC,
2292 .min_buffers_needed = 1,
2295 static int mxt_vidioc_querycap(struct file *file, void *priv,
2296 struct v4l2_capability *cap)
2298 struct mxt_data *data = video_drvdata(file);
2300 strlcpy(cap->driver, "atmel_mxt_ts", sizeof(cap->driver));
2301 strlcpy(cap->card, "atmel_mxt_ts touch", sizeof(cap->card));
2302 snprintf(cap->bus_info, sizeof(cap->bus_info),
2303 "I2C:%s", dev_name(&data->client->dev));
2307 static int mxt_vidioc_enum_input(struct file *file, void *priv,
2308 struct v4l2_input *i)
2313 i->type = V4L2_INPUT_TYPE_TOUCH;
2314 strlcpy(i->name, "Mutual Capacitance Deltas", sizeof(i->name));
2318 static int mxt_set_input(struct mxt_data *data, unsigned int i)
2320 struct v4l2_pix_format *f = &data->dbg.format;
2325 f->width = data->xy_switch ? data->ysize : data->xsize;
2326 f->height = data->xy_switch ? data->xsize : data->ysize;
2327 f->pixelformat = V4L2_TCH_FMT_DELTA_TD16;
2328 f->field = V4L2_FIELD_NONE;
2329 f->colorspace = V4L2_COLORSPACE_RAW;
2330 f->bytesperline = f->width * sizeof(u16);
2331 f->sizeimage = f->width * f->height * sizeof(u16);
2333 data->dbg.input = i;
2338 static int mxt_vidioc_s_input(struct file *file, void *priv, unsigned int i)
2340 return mxt_set_input(video_drvdata(file), i);
2343 static int mxt_vidioc_g_input(struct file *file, void *priv, unsigned int *i)
2345 struct mxt_data *data = video_drvdata(file);
2347 *i = data->dbg.input;
2352 static int mxt_vidioc_fmt(struct file *file, void *priv, struct v4l2_format *f)
2354 struct mxt_data *data = video_drvdata(file);
2356 f->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
2357 f->fmt.pix = data->dbg.format;
2362 static int mxt_vidioc_enum_fmt(struct file *file, void *priv,
2363 struct v4l2_fmtdesc *fmt)
2365 if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
2368 fmt->pixelformat = V4L2_TCH_FMT_DELTA_TD16;
2372 static int mxt_vidioc_g_parm(struct file *file, void *fh,
2373 struct v4l2_streamparm *a)
2375 if (a->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
2378 a->parm.capture.readbuffers = 1;
2379 a->parm.capture.timeperframe.numerator = 1;
2380 a->parm.capture.timeperframe.denominator = 10;
2384 static const struct v4l2_ioctl_ops mxt_video_ioctl_ops = {
2385 .vidioc_querycap = mxt_vidioc_querycap,
2387 .vidioc_enum_fmt_vid_cap = mxt_vidioc_enum_fmt,
2388 .vidioc_s_fmt_vid_cap = mxt_vidioc_fmt,
2389 .vidioc_g_fmt_vid_cap = mxt_vidioc_fmt,
2390 .vidioc_try_fmt_vid_cap = mxt_vidioc_fmt,
2391 .vidioc_g_parm = mxt_vidioc_g_parm,
2393 .vidioc_enum_input = mxt_vidioc_enum_input,
2394 .vidioc_g_input = mxt_vidioc_g_input,
2395 .vidioc_s_input = mxt_vidioc_s_input,
2397 .vidioc_reqbufs = vb2_ioctl_reqbufs,
2398 .vidioc_create_bufs = vb2_ioctl_create_bufs,
2399 .vidioc_querybuf = vb2_ioctl_querybuf,
2400 .vidioc_qbuf = vb2_ioctl_qbuf,
2401 .vidioc_dqbuf = vb2_ioctl_dqbuf,
2402 .vidioc_expbuf = vb2_ioctl_expbuf,
2404 .vidioc_streamon = vb2_ioctl_streamon,
2405 .vidioc_streamoff = vb2_ioctl_streamoff,
2408 static const struct video_device mxt_video_device = {
2409 .name = "Atmel maxTouch",
2410 .fops = &mxt_video_fops,
2411 .ioctl_ops = &mxt_video_ioctl_ops,
2412 .release = video_device_release_empty,
2413 .device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_TOUCH |
2414 V4L2_CAP_READWRITE | V4L2_CAP_STREAMING,
2417 static void mxt_debug_init(struct mxt_data *data)
2419 struct mxt_dbg *dbg = &data->dbg;
2420 struct mxt_object *object;
2423 object = mxt_get_object(data, MXT_GEN_COMMAND_T6);
2427 dbg->diag_cmd_address = object->start_address + MXT_COMMAND_DIAGNOSTIC;
2429 object = mxt_get_object(data, MXT_DEBUG_DIAGNOSTIC_T37);
2433 if (mxt_obj_size(object) != sizeof(struct t37_debug)) {
2434 dev_warn(&data->client->dev, "Bad T37 size");
2438 dbg->t37_address = object->start_address;
2440 /* Calculate size of data and allocate buffer */
2441 dbg->t37_nodes = data->xsize * data->ysize;
2442 dbg->t37_pages = DIV_ROUND_UP(data->xsize * data->info.matrix_ysize *
2443 sizeof(u16), sizeof(dbg->t37_buf->data));
2445 dbg->t37_buf = devm_kmalloc_array(&data->client->dev, dbg->t37_pages,
2446 sizeof(struct t37_debug), GFP_KERNEL);
2450 /* init channel to zero */
2451 mxt_set_input(data, 0);
2453 /* register video device */
2454 snprintf(dbg->v4l2.name, sizeof(dbg->v4l2.name), "%s", "atmel_mxt_ts");
2455 error = v4l2_device_register(&data->client->dev, &dbg->v4l2);
2459 /* initialize the queue */
2460 mutex_init(&dbg->lock);
2461 dbg->queue = mxt_queue;
2462 dbg->queue.drv_priv = data;
2463 dbg->queue.lock = &dbg->lock;
2464 dbg->queue.dev = &data->client->dev;
2466 error = vb2_queue_init(&dbg->queue);
2468 goto error_unreg_v4l2;
2470 dbg->vdev = mxt_video_device;
2471 dbg->vdev.v4l2_dev = &dbg->v4l2;
2472 dbg->vdev.lock = &dbg->lock;
2473 dbg->vdev.vfl_dir = VFL_DIR_RX;
2474 dbg->vdev.queue = &dbg->queue;
2475 video_set_drvdata(&dbg->vdev, data);
2477 error = video_register_device(&dbg->vdev, VFL_TYPE_TOUCH, -1);
2479 goto error_unreg_v4l2;
2484 v4l2_device_unregister(&dbg->v4l2);
2486 dev_warn(&data->client->dev, "Error initializing T37\n");
2489 static void mxt_debug_init(struct mxt_data *data)
2494 static int mxt_configure_objects(struct mxt_data *data,
2495 const struct firmware *cfg)
2497 struct device *dev = &data->client->dev;
2498 struct mxt_info *info = &data->info;
2501 error = mxt_init_t7_power_cfg(data);
2503 dev_err(dev, "Failed to initialize power cfg\n");
2508 error = mxt_update_cfg(data, cfg);
2510 dev_warn(dev, "Error %d updating config\n", error);
2513 if (data->multitouch) {
2514 error = mxt_initialize_input_device(data);
2518 dev_warn(dev, "No touch object detected\n");
2521 mxt_debug_init(data);
2524 "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n",
2525 info->family_id, info->variant_id, info->version >> 4,
2526 info->version & 0xf, info->build, info->object_num);
2531 /* Firmware Version is returned as Major.Minor.Build */
2532 static ssize_t mxt_fw_version_show(struct device *dev,
2533 struct device_attribute *attr, char *buf)
2535 struct mxt_data *data = dev_get_drvdata(dev);
2536 struct mxt_info *info = &data->info;
2537 return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
2538 info->version >> 4, info->version & 0xf, info->build);
2541 /* Hardware Version is returned as FamilyID.VariantID */
2542 static ssize_t mxt_hw_version_show(struct device *dev,
2543 struct device_attribute *attr, char *buf)
2545 struct mxt_data *data = dev_get_drvdata(dev);
2546 struct mxt_info *info = &data->info;
2547 return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
2548 info->family_id, info->variant_id);
2551 static ssize_t mxt_show_instance(char *buf, int count,
2552 struct mxt_object *object, int instance,
2557 if (mxt_obj_instances(object) > 1)
2558 count += scnprintf(buf + count, PAGE_SIZE - count,
2559 "Instance %u\n", instance);
2561 for (i = 0; i < mxt_obj_size(object); i++)
2562 count += scnprintf(buf + count, PAGE_SIZE - count,
2563 "\t[%2u]: %02x (%d)\n", i, val[i], val[i]);
2564 count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
2569 static ssize_t mxt_object_show(struct device *dev,
2570 struct device_attribute *attr, char *buf)
2572 struct mxt_data *data = dev_get_drvdata(dev);
2573 struct mxt_object *object;
2579 /* Pre-allocate buffer large enough to hold max sized object. */
2580 obuf = kmalloc(256, GFP_KERNEL);
2585 for (i = 0; i < data->info.object_num; i++) {
2586 object = data->object_table + i;
2588 if (!mxt_object_readable(object->type))
2591 count += scnprintf(buf + count, PAGE_SIZE - count,
2592 "T%u:\n", object->type);
2594 for (j = 0; j < mxt_obj_instances(object); j++) {
2595 u16 size = mxt_obj_size(object);
2596 u16 addr = object->start_address + j * size;
2598 error = __mxt_read_reg(data->client, addr, size, obuf);
2602 count = mxt_show_instance(buf, count, object, j, obuf);
2608 return error ?: count;
2611 static int mxt_check_firmware_format(struct device *dev,
2612 const struct firmware *fw)
2614 unsigned int pos = 0;
2617 while (pos < fw->size) {
2618 c = *(fw->data + pos);
2620 if (c < '0' || (c > '9' && c < 'A') || c > 'F')
2627 * To convert file try:
2628 * xxd -r -p mXTXXX__APP_VX-X-XX.enc > maxtouch.fw
2630 dev_err(dev, "Aborting: firmware file must be in binary format\n");
2635 static int mxt_load_fw(struct device *dev, const char *fn)
2637 struct mxt_data *data = dev_get_drvdata(dev);
2638 const struct firmware *fw = NULL;
2639 unsigned int frame_size;
2640 unsigned int pos = 0;
2641 unsigned int retry = 0;
2642 unsigned int frame = 0;
2645 ret = request_firmware(&fw, fn, dev);
2647 dev_err(dev, "Unable to open firmware %s\n", fn);
2651 /* Check for incorrect enc file */
2652 ret = mxt_check_firmware_format(dev, fw);
2654 goto release_firmware;
2656 if (!data->in_bootloader) {
2657 /* Change to the bootloader mode */
2658 data->in_bootloader = true;
2660 ret = mxt_t6_command(data, MXT_COMMAND_RESET,
2661 MXT_BOOT_VALUE, false);
2663 goto release_firmware;
2665 msleep(MXT_RESET_TIME);
2667 /* Do not need to scan since we know family ID */
2668 ret = mxt_lookup_bootloader_address(data, 0);
2670 goto release_firmware;
2672 mxt_free_input_device(data);
2673 mxt_free_object_table(data);
2675 enable_irq(data->irq);
2678 reinit_completion(&data->bl_completion);
2680 ret = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD, false);
2682 /* Bootloader may still be unlocked from previous attempt */
2683 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, false);
2687 dev_info(dev, "Unlocking bootloader\n");
2689 /* Unlock bootloader */
2690 ret = mxt_send_bootloader_cmd(data, true);
2695 while (pos < fw->size) {
2696 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, true);
2700 frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
2702 /* Take account of CRC bytes */
2705 /* Write one frame to device */
2706 ret = mxt_bootloader_write(data, fw->data + pos, frame_size);
2710 ret = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS, true);
2714 /* Back off by 20ms per retry */
2718 dev_err(dev, "Retry count exceeded\n");
2727 if (frame % 50 == 0)
2728 dev_dbg(dev, "Sent %d frames, %d/%zd bytes\n",
2729 frame, pos, fw->size);
2732 /* Wait for flash. */
2733 ret = mxt_wait_for_completion(data, &data->bl_completion,
2738 dev_dbg(dev, "Sent %d frames, %d bytes\n", frame, pos);
2741 * Wait for device to reset. Some bootloader versions do not assert
2742 * the CHG line after bootloading has finished, so ignore potential
2745 mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME);
2747 data->in_bootloader = false;
2750 disable_irq(data->irq);
2752 release_firmware(fw);
2756 static ssize_t mxt_update_fw_store(struct device *dev,
2757 struct device_attribute *attr,
2758 const char *buf, size_t count)
2760 struct mxt_data *data = dev_get_drvdata(dev);
2763 error = mxt_load_fw(dev, MXT_FW_NAME);
2765 dev_err(dev, "The firmware update failed(%d)\n", error);
2768 dev_info(dev, "The firmware update succeeded\n");
2770 error = mxt_initialize(data);
2778 static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
2779 static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
2780 static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
2781 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
2783 static struct attribute *mxt_attrs[] = {
2784 &dev_attr_fw_version.attr,
2785 &dev_attr_hw_version.attr,
2786 &dev_attr_object.attr,
2787 &dev_attr_update_fw.attr,
2791 static const struct attribute_group mxt_attr_group = {
2795 static void mxt_start(struct mxt_data *data)
2797 switch (data->pdata->suspend_mode) {
2798 case MXT_SUSPEND_T9_CTRL:
2799 mxt_soft_reset(data);
2802 /* 0x83 = SCANEN | RPTEN | ENABLE */
2803 mxt_write_object(data,
2804 MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0x83);
2807 case MXT_SUSPEND_DEEP_SLEEP:
2809 mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
2811 /* Recalibrate since chip has been in deep sleep */
2812 mxt_t6_command(data, MXT_COMMAND_CALIBRATE, 1, false);
2818 static void mxt_stop(struct mxt_data *data)
2820 switch (data->pdata->suspend_mode) {
2821 case MXT_SUSPEND_T9_CTRL:
2823 mxt_write_object(data,
2824 MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0);
2827 case MXT_SUSPEND_DEEP_SLEEP:
2829 mxt_set_t7_power_cfg(data, MXT_POWER_CFG_DEEPSLEEP);
2834 static int mxt_input_open(struct input_dev *dev)
2836 struct mxt_data *data = input_get_drvdata(dev);
2843 static void mxt_input_close(struct input_dev *dev)
2845 struct mxt_data *data = input_get_drvdata(dev);
2851 static const struct mxt_platform_data *mxt_parse_dt(struct i2c_client *client)
2853 struct mxt_platform_data *pdata;
2854 struct device_node *np = client->dev.of_node;
2859 return ERR_PTR(-ENOENT);
2861 pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL);
2863 return ERR_PTR(-ENOMEM);
2865 if (of_find_property(np, "linux,gpio-keymap", &proplen)) {
2866 pdata->t19_num_keys = proplen / sizeof(u32);
2868 keymap = devm_kzalloc(&client->dev,
2869 pdata->t19_num_keys * sizeof(keymap[0]),
2872 return ERR_PTR(-ENOMEM);
2874 ret = of_property_read_u32_array(np, "linux,gpio-keymap",
2875 keymap, pdata->t19_num_keys);
2877 dev_warn(&client->dev,
2878 "Couldn't read linux,gpio-keymap: %d\n", ret);
2880 pdata->t19_keymap = keymap;
2883 pdata->suspend_mode = MXT_SUSPEND_DEEP_SLEEP;
2888 static const struct mxt_platform_data *mxt_parse_dt(struct i2c_client *client)
2890 return ERR_PTR(-ENOENT);
2896 struct mxt_acpi_platform_data {
2898 struct mxt_platform_data pdata;
2901 static unsigned int samus_touchpad_buttons[] = {
2908 static struct mxt_acpi_platform_data samus_platform_data[] = {
2913 .t19_num_keys = ARRAY_SIZE(samus_touchpad_buttons),
2914 .t19_keymap = samus_touchpad_buttons,
2924 static unsigned int chromebook_tp_buttons[] = {
2933 static struct mxt_acpi_platform_data chromebook_platform_data[] = {
2938 .t19_num_keys = ARRAY_SIZE(chromebook_tp_buttons),
2939 .t19_keymap = chromebook_tp_buttons,
2949 static const struct dmi_system_id mxt_dmi_table[] = {
2951 /* 2015 Google Pixel */
2952 .ident = "Chromebook Pixel 2",
2954 DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
2955 DMI_MATCH(DMI_PRODUCT_NAME, "Samus"),
2957 .driver_data = samus_platform_data,
2960 /* Other Google Chromebooks */
2961 .ident = "Chromebook",
2963 DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
2965 .driver_data = chromebook_platform_data,
2970 static const struct mxt_platform_data *mxt_parse_acpi(struct i2c_client *client)
2972 struct acpi_device *adev;
2973 const struct dmi_system_id *system_id;
2974 const struct mxt_acpi_platform_data *acpi_pdata;
2977 * Ignore ACPI devices representing bootloader mode.
2979 * This is a bit of a hack: Google Chromebook BIOS creates ACPI
2980 * devices for both application and bootloader modes, but we are
2981 * interested in application mode only (if device is in bootloader
2982 * mode we'll end up switching into application anyway). So far
2983 * application mode addresses were all above 0x40, so we'll use it
2986 if (client->addr < 0x40)
2987 return ERR_PTR(-ENXIO);
2989 adev = ACPI_COMPANION(&client->dev);
2991 return ERR_PTR(-ENOENT);
2993 system_id = dmi_first_match(mxt_dmi_table);
2995 return ERR_PTR(-ENOENT);
2997 acpi_pdata = system_id->driver_data;
2999 return ERR_PTR(-ENOENT);
3001 while (acpi_pdata->hid) {
3002 if (!strcmp(acpi_device_hid(adev), acpi_pdata->hid))
3003 return &acpi_pdata->pdata;
3008 return ERR_PTR(-ENOENT);
3011 static const struct mxt_platform_data *mxt_parse_acpi(struct i2c_client *client)
3013 return ERR_PTR(-ENOENT);
3017 static const struct mxt_platform_data *
3018 mxt_get_platform_data(struct i2c_client *client)
3020 const struct mxt_platform_data *pdata;
3022 pdata = dev_get_platdata(&client->dev);
3026 pdata = mxt_parse_dt(client);
3027 if (!IS_ERR(pdata) || PTR_ERR(pdata) != -ENOENT)
3030 pdata = mxt_parse_acpi(client);
3031 if (!IS_ERR(pdata) || PTR_ERR(pdata) != -ENOENT)
3034 dev_err(&client->dev, "No platform data specified\n");
3035 return ERR_PTR(-EINVAL);
3038 static int mxt_probe(struct i2c_client *client, const struct i2c_device_id *id)
3040 struct mxt_data *data;
3041 const struct mxt_platform_data *pdata;
3044 pdata = mxt_get_platform_data(client);
3046 return PTR_ERR(pdata);
3048 data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL);
3050 dev_err(&client->dev, "Failed to allocate memory\n");
3054 snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
3055 client->adapter->nr, client->addr);
3057 data->client = client;
3058 data->pdata = pdata;
3059 data->irq = client->irq;
3060 i2c_set_clientdata(client, data);
3062 init_completion(&data->bl_completion);
3063 init_completion(&data->reset_completion);
3064 init_completion(&data->crc_completion);
3066 error = request_threaded_irq(client->irq, NULL, mxt_interrupt,
3067 pdata->irqflags | IRQF_ONESHOT,
3068 client->name, data);
3070 dev_err(&client->dev, "Failed to register interrupt\n");
3074 disable_irq(client->irq);
3076 error = mxt_initialize(data);
3080 error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
3082 dev_err(&client->dev, "Failure %d creating sysfs group\n",
3084 goto err_free_object;
3090 mxt_free_input_device(data);
3091 mxt_free_object_table(data);
3093 free_irq(client->irq, data);
3099 static int mxt_remove(struct i2c_client *client)
3101 struct mxt_data *data = i2c_get_clientdata(client);
3103 sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
3104 free_irq(data->irq, data);
3105 mxt_free_input_device(data);
3106 mxt_free_object_table(data);
3112 static int __maybe_unused mxt_suspend(struct device *dev)
3114 struct i2c_client *client = to_i2c_client(dev);
3115 struct mxt_data *data = i2c_get_clientdata(client);
3116 struct input_dev *input_dev = data->input_dev;
3121 mutex_lock(&input_dev->mutex);
3123 if (input_dev->users)
3126 mutex_unlock(&input_dev->mutex);
3131 static int __maybe_unused mxt_resume(struct device *dev)
3133 struct i2c_client *client = to_i2c_client(dev);
3134 struct mxt_data *data = i2c_get_clientdata(client);
3135 struct input_dev *input_dev = data->input_dev;
3140 mutex_lock(&input_dev->mutex);
3142 if (input_dev->users)
3145 mutex_unlock(&input_dev->mutex);
3150 static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);
3152 static const struct of_device_id mxt_of_match[] = {
3153 { .compatible = "atmel,maxtouch", },
3156 MODULE_DEVICE_TABLE(of, mxt_of_match);
3159 static const struct acpi_device_id mxt_acpi_id[] = {
3160 { "ATML0000", 0 }, /* Touchpad */
3161 { "ATML0001", 0 }, /* Touchscreen */
3164 MODULE_DEVICE_TABLE(acpi, mxt_acpi_id);
3167 static const struct i2c_device_id mxt_id[] = {
3168 { "qt602240_ts", 0 },
3169 { "atmel_mxt_ts", 0 },
3170 { "atmel_mxt_tp", 0 },
3175 MODULE_DEVICE_TABLE(i2c, mxt_id);
3177 static struct i2c_driver mxt_driver = {
3179 .name = "atmel_mxt_ts",
3180 .of_match_table = of_match_ptr(mxt_of_match),
3181 .acpi_match_table = ACPI_PTR(mxt_acpi_id),
3185 .remove = mxt_remove,
3189 module_i2c_driver(mxt_driver);
3191 /* Module information */
3192 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
3193 MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
3194 MODULE_LICENSE("GPL");