2 * HID driver for multitouch panels
4 * Copyright (c) 2010-2012 Stephane Chatty <chatty@enac.fr>
5 * Copyright (c) 2010-2013 Benjamin Tissoires <benjamin.tissoires@gmail.com>
6 * Copyright (c) 2010-2012 Ecole Nationale de l'Aviation Civile, France
7 * Copyright (c) 2012-2013 Red Hat, Inc
9 * This code is partly based on hid-egalax.c:
11 * Copyright (c) 2010 Stephane Chatty <chatty@enac.fr>
12 * Copyright (c) 2010 Henrik Rydberg <rydberg@euromail.se>
13 * Copyright (c) 2010 Canonical, Ltd.
15 * This code is partly based on hid-3m-pct.c:
17 * Copyright (c) 2009-2010 Stephane Chatty <chatty@enac.fr>
18 * Copyright (c) 2010 Henrik Rydberg <rydberg@euromail.se>
19 * Copyright (c) 2010 Canonical, Ltd.
24 * This program is free software; you can redistribute it and/or modify it
25 * under the terms of the GNU General Public License as published by the Free
26 * Software Foundation; either version 2 of the License, or (at your option)
31 * This driver is regularly tested thanks to the tool hid-test[1].
32 * This tool relies on hid-replay[2] and a database of hid devices[3].
33 * Please run these regression tests before patching this module so that
34 * your patch won't break existing known devices.
36 * [1] https://github.com/bentiss/hid-test
37 * [2] https://github.com/bentiss/hid-replay
38 * [3] https://github.com/bentiss/hid-devices
41 #include <linux/device.h>
42 #include <linux/hid.h>
43 #include <linux/module.h>
44 #include <linux/slab.h>
45 #include <linux/input/mt.h>
46 #include <linux/jiffies.h>
47 #include <linux/string.h>
48 #include <linux/timer.h>
51 MODULE_AUTHOR("Stephane Chatty <chatty@enac.fr>");
52 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
53 MODULE_DESCRIPTION("HID multitouch panels");
54 MODULE_LICENSE("GPL");
58 /* quirks to control the device */
59 #define MT_QUIRK_NOT_SEEN_MEANS_UP BIT(0)
60 #define MT_QUIRK_SLOT_IS_CONTACTID BIT(1)
61 #define MT_QUIRK_CYPRESS BIT(2)
62 #define MT_QUIRK_SLOT_IS_CONTACTNUMBER BIT(3)
63 #define MT_QUIRK_ALWAYS_VALID BIT(4)
64 #define MT_QUIRK_VALID_IS_INRANGE BIT(5)
65 #define MT_QUIRK_VALID_IS_CONFIDENCE BIT(6)
66 #define MT_QUIRK_CONFIDENCE BIT(7)
67 #define MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE BIT(8)
68 #define MT_QUIRK_NO_AREA BIT(9)
69 #define MT_QUIRK_IGNORE_DUPLICATES BIT(10)
70 #define MT_QUIRK_HOVERING BIT(11)
71 #define MT_QUIRK_CONTACT_CNT_ACCURATE BIT(12)
72 #define MT_QUIRK_FORCE_GET_FEATURE BIT(13)
73 #define MT_QUIRK_FIX_CONST_CONTACT_ID BIT(14)
74 #define MT_QUIRK_TOUCH_SIZE_SCALING BIT(15)
75 #define MT_QUIRK_STICKY_FINGERS BIT(16)
76 #define MT_QUIRK_ASUS_CUSTOM_UP BIT(17)
77 #define MT_QUIRK_WIN8_PTP_BUTTONS BIT(18)
79 #define MT_INPUTMODE_TOUCHSCREEN 0x02
80 #define MT_INPUTMODE_TOUCHPAD 0x03
82 #define MT_BUTTONTYPE_CLICKPAD 0
85 HID_LATENCY_NORMAL = 0,
89 #define MT_IO_FLAGS_RUNNING 0
90 #define MT_IO_FLAGS_ACTIVE_SLOTS 1
91 #define MT_IO_FLAGS_PENDING_SLOTS 2
94 __s32 x, y, cx, cy, p, w, h, a;
95 __s32 contactid; /* the device ContactID assigned to this slot */
96 bool touch_state; /* is the touch valid? */
97 bool inrange_state; /* is the finger in proximity of the sensor? */
98 bool confidence_state; /* is the touch made by a finger? */
99 bool has_azimuth; /* the contact reports azimuth */
103 __s32 name; /* MT_CLS */
105 __s32 sn_move; /* Signal/noise ratio for move events */
106 __s32 sn_width; /* Signal/noise ratio for width events */
107 __s32 sn_height; /* Signal/noise ratio for height events */
108 __s32 sn_pressure; /* Signal/noise ratio for pressure events */
110 bool is_indirect; /* true for touchpads */
111 bool export_all_inputs; /* do not ignore mouse, keyboards, etc... */
115 unsigned usages[HID_MAX_FIELDS];
120 struct mt_slot curdata; /* placeholder of incoming data */
121 struct mt_class mtclass; /* our mt device class */
122 struct timer_list release_timer; /* to release sticky fingers */
123 struct hid_device *hdev; /* hid_device we're attached to */
124 struct mt_fields *fields; /* temporary placeholder for storing the
126 unsigned long mt_io_flags; /* mt flags (MT_IO_FLAGS_*) */
127 int cc_index; /* contact count field index in the report */
128 int cc_value_index; /* contact count value index in the field */
129 int scantime_index; /* scantime field index in the report */
130 int scantime_val_index; /* scantime value index in the field */
131 int prev_scantime; /* scantime reported in the previous packet */
132 int left_button_state; /* left button state */
133 unsigned last_slot_field; /* the last field of a slot */
134 unsigned mt_report_id; /* the report ID of the multitouch device */
135 __u8 inputmode_value; /* InputMode HID feature value */
136 __u8 num_received; /* how many contacts we received */
137 __u8 num_expected; /* expected last contact index */
139 __u8 touches_by_report; /* how many touches are present in one report:
140 * 1 means we should use a serial protocol
141 * > 1 means hybrid (multitouch) protocol */
142 __u8 buttons_count; /* number of physical buttons per touchpad */
143 bool is_buttonpad; /* is this device a button pad? */
144 bool serial_maybe; /* need to check for serial protocol */
145 bool curvalid; /* is the current contact valid? */
146 unsigned mt_flags; /* flags to pass to input-mt */
147 __s32 dev_time; /* the scan time provided by the device */
148 unsigned long jiffies; /* the frame's jiffies */
149 int timestamp; /* the timestamp to be sent */
152 static void mt_post_parse_default_settings(struct mt_device *td);
153 static void mt_post_parse(struct mt_device *td);
155 /* classes of device behavior */
156 #define MT_CLS_DEFAULT 0x0001
158 #define MT_CLS_SERIAL 0x0002
159 #define MT_CLS_CONFIDENCE 0x0003
160 #define MT_CLS_CONFIDENCE_CONTACT_ID 0x0004
161 #define MT_CLS_CONFIDENCE_MINUS_ONE 0x0005
162 #define MT_CLS_DUAL_INRANGE_CONTACTID 0x0006
163 #define MT_CLS_DUAL_INRANGE_CONTACTNUMBER 0x0007
164 /* reserved 0x0008 */
165 #define MT_CLS_INRANGE_CONTACTNUMBER 0x0009
166 #define MT_CLS_NSMU 0x000a
167 /* reserved 0x0010 */
168 /* reserved 0x0011 */
169 #define MT_CLS_WIN_8 0x0012
170 #define MT_CLS_EXPORT_ALL_INPUTS 0x0013
171 #define MT_CLS_WIN_8_DUAL 0x0014
173 /* vendor specific classes */
174 #define MT_CLS_3M 0x0101
175 /* reserved 0x0102 */
176 #define MT_CLS_EGALAX 0x0103
177 #define MT_CLS_EGALAX_SERIAL 0x0104
178 #define MT_CLS_TOPSEED 0x0105
179 #define MT_CLS_PANASONIC 0x0106
180 #define MT_CLS_FLATFROG 0x0107
181 #define MT_CLS_GENERALTOUCH_TWOFINGERS 0x0108
182 #define MT_CLS_GENERALTOUCH_PWT_TENFINGERS 0x0109
183 #define MT_CLS_LG 0x010a
184 #define MT_CLS_ASUS 0x010b
185 #define MT_CLS_VTL 0x0110
186 #define MT_CLS_GOOGLE 0x0111
187 #define MT_CLS_RAZER_BLADE_STEALTH 0x0112
189 #define MT_DEFAULT_MAXCONTACT 10
190 #define MT_MAX_MAXCONTACT 250
193 * Resync device and local timestamps after that many microseconds without
196 #define MAX_TIMESTAMP_INTERVAL 1000000
198 #define MT_USB_DEVICE(v, p) HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH, v, p)
199 #define MT_BT_DEVICE(v, p) HID_DEVICE(BUS_BLUETOOTH, HID_GROUP_MULTITOUCH, v, p)
202 * these device-dependent functions determine what slot corresponds
203 * to a valid contact that was just read.
206 static int cypress_compute_slot(struct mt_device *td)
208 if (td->curdata.contactid != 0 || td->num_received == 0)
209 return td->curdata.contactid;
214 static struct mt_class mt_classes[] = {
215 { .name = MT_CLS_DEFAULT,
216 .quirks = MT_QUIRK_ALWAYS_VALID |
217 MT_QUIRK_CONTACT_CNT_ACCURATE },
218 { .name = MT_CLS_NSMU,
219 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP },
220 { .name = MT_CLS_SERIAL,
221 .quirks = MT_QUIRK_ALWAYS_VALID},
222 { .name = MT_CLS_CONFIDENCE,
223 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE },
224 { .name = MT_CLS_CONFIDENCE_CONTACT_ID,
225 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
226 MT_QUIRK_SLOT_IS_CONTACTID },
227 { .name = MT_CLS_CONFIDENCE_MINUS_ONE,
228 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
229 MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE },
230 { .name = MT_CLS_DUAL_INRANGE_CONTACTID,
231 .quirks = MT_QUIRK_VALID_IS_INRANGE |
232 MT_QUIRK_SLOT_IS_CONTACTID,
234 { .name = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
235 .quirks = MT_QUIRK_VALID_IS_INRANGE |
236 MT_QUIRK_SLOT_IS_CONTACTNUMBER,
238 { .name = MT_CLS_INRANGE_CONTACTNUMBER,
239 .quirks = MT_QUIRK_VALID_IS_INRANGE |
240 MT_QUIRK_SLOT_IS_CONTACTNUMBER },
241 { .name = MT_CLS_WIN_8,
242 .quirks = MT_QUIRK_ALWAYS_VALID |
243 MT_QUIRK_IGNORE_DUPLICATES |
245 MT_QUIRK_CONTACT_CNT_ACCURATE |
246 MT_QUIRK_STICKY_FINGERS |
247 MT_QUIRK_WIN8_PTP_BUTTONS },
248 { .name = MT_CLS_EXPORT_ALL_INPUTS,
249 .quirks = MT_QUIRK_ALWAYS_VALID |
250 MT_QUIRK_CONTACT_CNT_ACCURATE,
251 .export_all_inputs = true },
252 { .name = MT_CLS_WIN_8_DUAL,
253 .quirks = MT_QUIRK_ALWAYS_VALID |
254 MT_QUIRK_IGNORE_DUPLICATES |
256 MT_QUIRK_CONTACT_CNT_ACCURATE |
257 MT_QUIRK_WIN8_PTP_BUTTONS,
258 .export_all_inputs = true },
261 * vendor specific classes
264 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
265 MT_QUIRK_SLOT_IS_CONTACTID |
266 MT_QUIRK_TOUCH_SIZE_SCALING,
272 { .name = MT_CLS_EGALAX,
273 .quirks = MT_QUIRK_SLOT_IS_CONTACTID |
274 MT_QUIRK_VALID_IS_INRANGE,
278 { .name = MT_CLS_EGALAX_SERIAL,
279 .quirks = MT_QUIRK_SLOT_IS_CONTACTID |
280 MT_QUIRK_ALWAYS_VALID,
284 { .name = MT_CLS_TOPSEED,
285 .quirks = MT_QUIRK_ALWAYS_VALID,
289 { .name = MT_CLS_PANASONIC,
290 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP,
292 { .name = MT_CLS_GENERALTOUCH_TWOFINGERS,
293 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
294 MT_QUIRK_VALID_IS_INRANGE |
295 MT_QUIRK_SLOT_IS_CONTACTID,
298 { .name = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
299 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
300 MT_QUIRK_SLOT_IS_CONTACTID
303 { .name = MT_CLS_FLATFROG,
304 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
310 .quirks = MT_QUIRK_ALWAYS_VALID |
311 MT_QUIRK_FIX_CONST_CONTACT_ID |
312 MT_QUIRK_IGNORE_DUPLICATES |
314 MT_QUIRK_CONTACT_CNT_ACCURATE },
315 { .name = MT_CLS_ASUS,
316 .quirks = MT_QUIRK_ALWAYS_VALID |
317 MT_QUIRK_CONTACT_CNT_ACCURATE |
318 MT_QUIRK_ASUS_CUSTOM_UP },
319 { .name = MT_CLS_VTL,
320 .quirks = MT_QUIRK_ALWAYS_VALID |
321 MT_QUIRK_CONTACT_CNT_ACCURATE |
322 MT_QUIRK_FORCE_GET_FEATURE,
324 { .name = MT_CLS_GOOGLE,
325 .quirks = MT_QUIRK_ALWAYS_VALID |
326 MT_QUIRK_CONTACT_CNT_ACCURATE |
327 MT_QUIRK_SLOT_IS_CONTACTID |
330 { .name = MT_CLS_RAZER_BLADE_STEALTH,
331 .quirks = MT_QUIRK_ALWAYS_VALID |
332 MT_QUIRK_IGNORE_DUPLICATES |
334 MT_QUIRK_CONTACT_CNT_ACCURATE |
335 MT_QUIRK_WIN8_PTP_BUTTONS,
340 static ssize_t mt_show_quirks(struct device *dev,
341 struct device_attribute *attr,
344 struct hid_device *hdev = to_hid_device(dev);
345 struct mt_device *td = hid_get_drvdata(hdev);
347 return sprintf(buf, "%u\n", td->mtclass.quirks);
350 static ssize_t mt_set_quirks(struct device *dev,
351 struct device_attribute *attr,
352 const char *buf, size_t count)
354 struct hid_device *hdev = to_hid_device(dev);
355 struct mt_device *td = hid_get_drvdata(hdev);
359 if (kstrtoul(buf, 0, &val))
362 td->mtclass.quirks = val;
364 if (td->cc_index < 0)
365 td->mtclass.quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
370 static DEVICE_ATTR(quirks, S_IWUSR | S_IRUGO, mt_show_quirks, mt_set_quirks);
372 static struct attribute *sysfs_attrs[] = {
373 &dev_attr_quirks.attr,
377 static const struct attribute_group mt_attribute_group = {
381 static void mt_get_feature(struct hid_device *hdev, struct hid_report *report)
384 u32 size = hid_report_len(report);
388 * Do not fetch the feature report if the device has been explicitly
389 * marked as non-capable.
391 if (hdev->quirks & HID_QUIRK_NO_INIT_REPORTS)
394 buf = hid_alloc_report_buf(report, GFP_KERNEL);
398 ret = hid_hw_raw_request(hdev, report->id, buf, size,
399 HID_FEATURE_REPORT, HID_REQ_GET_REPORT);
401 dev_warn(&hdev->dev, "failed to fetch feature %d\n",
404 ret = hid_report_raw_event(hdev, HID_FEATURE_REPORT, buf,
407 dev_warn(&hdev->dev, "failed to report feature\n");
413 static void mt_feature_mapping(struct hid_device *hdev,
414 struct hid_field *field, struct hid_usage *usage)
416 struct mt_device *td = hid_get_drvdata(hdev);
418 switch (usage->hid) {
419 case HID_DG_CONTACTMAX:
420 mt_get_feature(hdev, field->report);
422 td->maxcontacts = field->value[0];
423 if (!td->maxcontacts &&
424 field->logical_maximum <= MT_MAX_MAXCONTACT)
425 td->maxcontacts = field->logical_maximum;
426 if (td->mtclass.maxcontacts)
427 /* check if the maxcontacts is given by the class */
428 td->maxcontacts = td->mtclass.maxcontacts;
431 case HID_DG_BUTTONTYPE:
432 if (usage->usage_index >= field->report_count) {
433 dev_err(&hdev->dev, "HID_DG_BUTTONTYPE out of range\n");
437 mt_get_feature(hdev, field->report);
438 if (field->value[usage->usage_index] == MT_BUTTONTYPE_CLICKPAD)
439 td->is_buttonpad = true;
443 /* Retrieve the Win8 blob once to enable some devices */
444 if (usage->usage_index == 0)
445 mt_get_feature(hdev, field->report);
450 static void set_abs(struct input_dev *input, unsigned int code,
451 struct hid_field *field, int snratio)
453 int fmin = field->logical_minimum;
454 int fmax = field->logical_maximum;
455 int fuzz = snratio ? (fmax - fmin) / snratio : 0;
456 input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
457 input_abs_set_res(input, code, hidinput_calc_abs_res(field, code));
460 static void mt_store_field(struct hid_usage *usage, struct mt_device *td,
461 struct hid_input *hi)
463 struct mt_fields *f = td->fields;
465 if (f->length >= HID_MAX_FIELDS)
468 f->usages[f->length++] = usage->hid;
471 static int mt_touch_input_mapping(struct hid_device *hdev, struct hid_input *hi,
472 struct hid_field *field, struct hid_usage *usage,
473 unsigned long **bit, int *max)
475 struct mt_device *td = hid_get_drvdata(hdev);
476 struct mt_class *cls = &td->mtclass;
478 struct hid_usage *prev_usage = NULL;
480 if (field->application == HID_DG_TOUCHSCREEN)
481 td->mt_flags |= INPUT_MT_DIRECT;
484 * Model touchscreens providing buttons as touchpads.
486 if (field->application == HID_DG_TOUCHPAD ||
487 (usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON) {
488 td->mt_flags |= INPUT_MT_POINTER;
489 td->inputmode_value = MT_INPUTMODE_TOUCHPAD;
492 /* count the buttons on touchpads */
493 if ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON)
496 if (usage->usage_index)
497 prev_usage = &field->usage[usage->usage_index - 1];
499 switch (usage->hid & HID_USAGE_PAGE) {
502 switch (usage->hid) {
504 if (prev_usage && (prev_usage->hid == usage->hid)) {
505 hid_map_usage(hi, usage, bit, max,
506 EV_ABS, ABS_MT_TOOL_X);
507 set_abs(hi->input, ABS_MT_TOOL_X, field,
510 hid_map_usage(hi, usage, bit, max,
511 EV_ABS, ABS_MT_POSITION_X);
512 set_abs(hi->input, ABS_MT_POSITION_X, field,
516 mt_store_field(usage, td, hi);
519 if (prev_usage && (prev_usage->hid == usage->hid)) {
520 hid_map_usage(hi, usage, bit, max,
521 EV_ABS, ABS_MT_TOOL_Y);
522 set_abs(hi->input, ABS_MT_TOOL_Y, field,
525 hid_map_usage(hi, usage, bit, max,
526 EV_ABS, ABS_MT_POSITION_Y);
527 set_abs(hi->input, ABS_MT_POSITION_Y, field,
531 mt_store_field(usage, td, hi);
536 case HID_UP_DIGITIZER:
537 switch (usage->hid) {
539 if (cls->quirks & MT_QUIRK_HOVERING) {
540 hid_map_usage(hi, usage, bit, max,
541 EV_ABS, ABS_MT_DISTANCE);
542 input_set_abs_params(hi->input,
543 ABS_MT_DISTANCE, 0, 1, 0, 0);
545 mt_store_field(usage, td, hi);
547 case HID_DG_CONFIDENCE:
548 if ((cls->name == MT_CLS_WIN_8 ||
549 cls->name == MT_CLS_WIN_8_DUAL) &&
550 field->application == HID_DG_TOUCHPAD)
551 cls->quirks |= MT_QUIRK_CONFIDENCE;
552 mt_store_field(usage, td, hi);
554 case HID_DG_TIPSWITCH:
555 hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_TOUCH);
556 input_set_capability(hi->input, EV_KEY, BTN_TOUCH);
557 mt_store_field(usage, td, hi);
559 case HID_DG_CONTACTID:
560 mt_store_field(usage, td, hi);
561 td->touches_by_report++;
562 td->mt_report_id = field->report->id;
565 hid_map_usage(hi, usage, bit, max,
566 EV_ABS, ABS_MT_TOUCH_MAJOR);
567 if (!(cls->quirks & MT_QUIRK_NO_AREA))
568 set_abs(hi->input, ABS_MT_TOUCH_MAJOR, field,
570 mt_store_field(usage, td, hi);
573 hid_map_usage(hi, usage, bit, max,
574 EV_ABS, ABS_MT_TOUCH_MINOR);
575 if (!(cls->quirks & MT_QUIRK_NO_AREA)) {
576 set_abs(hi->input, ABS_MT_TOUCH_MINOR, field,
580 * Only set ABS_MT_ORIENTATION if it is not
581 * already set by the HID_DG_AZIMUTH usage.
583 if (!test_bit(ABS_MT_ORIENTATION,
585 input_set_abs_params(hi->input,
586 ABS_MT_ORIENTATION, 0, 1, 0, 0);
588 mt_store_field(usage, td, hi);
590 case HID_DG_TIPPRESSURE:
591 hid_map_usage(hi, usage, bit, max,
592 EV_ABS, ABS_MT_PRESSURE);
593 set_abs(hi->input, ABS_MT_PRESSURE, field,
595 mt_store_field(usage, td, hi);
597 case HID_DG_SCANTIME:
598 hid_map_usage(hi, usage, bit, max,
599 EV_MSC, MSC_TIMESTAMP);
600 input_set_capability(hi->input, EV_MSC, MSC_TIMESTAMP);
601 /* Ignore if indexes are out of bounds. */
602 if (field->index >= field->report->maxfield ||
603 usage->usage_index >= field->report_count)
605 td->scantime_index = field->index;
606 td->scantime_val_index = usage->usage_index;
608 * We don't set td->last_slot_field as scan time is
609 * global to the report.
612 case HID_DG_CONTACTCOUNT:
613 /* Ignore if indexes are out of bounds. */
614 if (field->index >= field->report->maxfield ||
615 usage->usage_index >= field->report_count)
617 td->cc_index = field->index;
618 td->cc_value_index = usage->usage_index;
621 hid_map_usage(hi, usage, bit, max,
622 EV_ABS, ABS_MT_ORIENTATION);
624 * Azimuth has the range of [0, MAX) representing a full
625 * revolution. Set ABS_MT_ORIENTATION to a quarter of
626 * MAX according the definition of ABS_MT_ORIENTATION
628 input_set_abs_params(hi->input, ABS_MT_ORIENTATION,
629 -field->logical_maximum / 4,
630 field->logical_maximum / 4,
632 field->logical_maximum / cls->sn_move : 0, 0);
633 mt_store_field(usage, td, hi);
635 case HID_DG_CONTACTMAX:
636 /* we don't set td->last_slot_field as contactcount and
637 * contact max are global to the report */
640 /* Legacy devices use TIPSWITCH and not TOUCH.
641 * Let's just ignore this field. */
644 /* let hid-input decide for the others */
648 code = BTN_MOUSE + ((usage->hid - 1) & HID_USAGE);
650 * MS PTP spec says that external buttons left and right have
653 if ((cls->quirks & MT_QUIRK_WIN8_PTP_BUTTONS) &&
654 field->application == HID_DG_TOUCHPAD &&
655 (usage->hid & HID_USAGE) > 1)
657 hid_map_usage(hi, usage, bit, max, EV_KEY, code);
658 input_set_capability(hi->input, EV_KEY, code);
662 /* we do not want to map these: no input-oriented meaning */
669 static int mt_compute_slot(struct mt_device *td, struct input_dev *input)
671 __s32 quirks = td->mtclass.quirks;
673 if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
674 return td->curdata.contactid;
676 if (quirks & MT_QUIRK_CYPRESS)
677 return cypress_compute_slot(td);
679 if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
680 return td->num_received;
682 if (quirks & MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE)
683 return td->curdata.contactid - 1;
685 return input_mt_get_slot_by_key(input, td->curdata.contactid);
689 * this function is called when a whole contact has been processed,
690 * so that it can assign it to a slot and store the data there
692 static void mt_complete_slot(struct mt_device *td, struct input_dev *input)
694 if ((td->mtclass.quirks & MT_QUIRK_CONTACT_CNT_ACCURATE) &&
695 td->num_received >= td->num_expected)
698 if (td->curvalid || (td->mtclass.quirks & MT_QUIRK_ALWAYS_VALID)) {
700 int slotnum = mt_compute_slot(td, input);
701 struct mt_slot *s = &td->curdata;
702 struct input_mt *mt = input->mt;
704 if (slotnum < 0 || slotnum >= td->maxcontacts)
707 if ((td->mtclass.quirks & MT_QUIRK_IGNORE_DUPLICATES) && mt) {
708 struct input_mt_slot *slot = &mt->slots[slotnum];
709 if (input_mt_is_active(slot) &&
710 input_mt_is_used(mt, slot))
714 if (!(td->mtclass.quirks & MT_QUIRK_CONFIDENCE))
715 s->confidence_state = true;
716 active = (s->touch_state || s->inrange_state) &&
719 input_mt_slot(input, slotnum);
720 input_mt_report_slot_state(input, MT_TOOL_FINGER, active);
722 /* this finger is in proximity of the sensor */
723 int wide = (s->w > s->h);
724 int major = max(s->w, s->h);
725 int minor = min(s->w, s->h);
726 int orientation = wide;
732 * divided by two to match visual scale of touch
733 * for devices with this quirk
735 if (td->mtclass.quirks & MT_QUIRK_TOUCH_SIZE_SCALING) {
740 input_event(input, EV_ABS, ABS_MT_POSITION_X, s->x);
741 input_event(input, EV_ABS, ABS_MT_POSITION_Y, s->y);
742 input_event(input, EV_ABS, ABS_MT_TOOL_X, s->cx);
743 input_event(input, EV_ABS, ABS_MT_TOOL_Y, s->cy);
744 input_event(input, EV_ABS, ABS_MT_DISTANCE,
746 input_event(input, EV_ABS, ABS_MT_ORIENTATION,
748 input_event(input, EV_ABS, ABS_MT_PRESSURE, s->p);
749 input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
750 input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
752 set_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags);
760 * this function is called when a whole packet has been received and processed,
761 * so that it can decide what to send to the input layer.
763 static void mt_sync_frame(struct mt_device *td, struct input_dev *input)
765 if (td->mtclass.quirks & MT_QUIRK_WIN8_PTP_BUTTONS)
766 input_event(input, EV_KEY, BTN_LEFT, td->left_button_state);
768 input_mt_sync_frame(input);
769 input_event(input, EV_MSC, MSC_TIMESTAMP, td->timestamp);
771 td->num_received = 0;
772 td->left_button_state = 0;
773 if (test_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags))
774 set_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags);
776 clear_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags);
777 clear_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags);
780 static int mt_compute_timestamp(struct mt_device *td, struct hid_field *field,
783 long delta = value - td->dev_time;
784 unsigned long jdelta = jiffies_to_usecs(jiffies - td->jiffies);
786 td->jiffies = jiffies;
787 td->dev_time = value;
790 delta += field->logical_maximum;
792 /* HID_DG_SCANTIME is expressed in 100us, we want it in us. */
795 if (jdelta > MAX_TIMESTAMP_INTERVAL)
796 /* No data received for a while, resync the timestamp. */
799 return td->timestamp + delta;
802 static int mt_touch_event(struct hid_device *hid, struct hid_field *field,
803 struct hid_usage *usage, __s32 value)
805 /* we will handle the hidinput part later, now remains hiddev */
806 if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
807 hid->hiddev_hid_event(hid, field, usage, value);
812 static void mt_process_mt_event(struct hid_device *hid, struct hid_field *field,
813 struct hid_usage *usage, __s32 value,
816 struct mt_device *td = hid_get_drvdata(hid);
817 __s32 quirks = td->mtclass.quirks;
818 struct input_dev *input = field->hidinput->input;
820 if (hid->claimed & HID_CLAIMED_INPUT) {
821 switch (usage->hid) {
823 if (quirks & MT_QUIRK_VALID_IS_INRANGE)
824 td->curvalid = value;
825 if (quirks & MT_QUIRK_HOVERING)
826 td->curdata.inrange_state = value;
828 case HID_DG_TIPSWITCH:
829 if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
830 td->curvalid = value;
831 td->curdata.touch_state = value;
833 case HID_DG_CONFIDENCE:
834 if (quirks & MT_QUIRK_CONFIDENCE)
835 td->curdata.confidence_state = value;
836 if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
837 td->curvalid = value;
839 case HID_DG_CONTACTID:
840 td->curdata.contactid = value;
842 case HID_DG_TIPPRESSURE:
843 td->curdata.p = value;
846 if (usage->code == ABS_MT_TOOL_X)
847 td->curdata.cx = value;
849 td->curdata.x = value;
852 if (usage->code == ABS_MT_TOOL_Y)
853 td->curdata.cy = value;
855 td->curdata.y = value;
858 td->curdata.w = value;
861 td->curdata.h = value;
863 case HID_DG_SCANTIME:
864 td->timestamp = mt_compute_timestamp(td, field, value);
866 case HID_DG_CONTACTCOUNT:
870 * Azimuth is counter-clockwise and ranges from [0, MAX)
871 * (a full revolution). Convert it to clockwise ranging
874 * Note that ABS_MT_ORIENTATION require us to report
875 * the limit of [-MAX/4, MAX/4], but the value can go
876 * out of range to [-MAX/2, MAX/2] to report an upside
879 if (value > field->logical_maximum / 2)
880 value -= field->logical_maximum;
881 td->curdata.a = -value;
882 td->curdata.has_azimuth = true;
890 * For Win8 PTP touchpads we should only look at
891 * non finger/touch events in the first_packet of
892 * a (possible) multi-packet frame.
894 if ((quirks & MT_QUIRK_WIN8_PTP_BUTTONS) &&
899 * For Win8 PTP touchpads we map both the clickpad click
900 * and any "external" left buttons to BTN_LEFT if a
901 * device claims to have both we need to report 1 for
902 * BTN_LEFT if either is pressed, so we or all values
903 * together and report the result in mt_sync_frame().
905 if ((quirks & MT_QUIRK_WIN8_PTP_BUTTONS) &&
906 usage->type == EV_KEY && usage->code == BTN_LEFT) {
907 td->left_button_state |= value;
912 input_event(input, usage->type, usage->code,
917 if (usage->usage_index + 1 == field->report_count) {
918 /* we only take into account the last report. */
919 if (usage->hid == td->last_slot_field)
920 mt_complete_slot(td, field->hidinput->input);
926 static void mt_touch_report(struct hid_device *hid, struct hid_report *report)
928 struct mt_device *td = hid_get_drvdata(hid);
929 struct hid_field *field;
932 int r, n, scantime = 0;
934 /* sticky fingers release in progress, abort */
935 if (test_and_set_bit(MT_IO_FLAGS_RUNNING, &td->mt_io_flags))
939 * Includes multi-packet support where subsequent
940 * packets are sent with zero contactcount.
942 if (td->scantime_index >= 0) {
943 field = report->field[td->scantime_index];
944 scantime = field->value[td->scantime_val_index];
946 if (td->cc_index >= 0) {
947 struct hid_field *field = report->field[td->cc_index];
948 int value = field->value[td->cc_value_index];
951 * For Win8 PTPs the first packet (td->num_received == 0) may
952 * have a contactcount of 0 if there only is a button event.
953 * We double check that this is not a continuation packet
954 * of a possible multi-packet frame be checking that the
955 * timestamp has changed.
957 if ((td->mtclass.quirks & MT_QUIRK_WIN8_PTP_BUTTONS) &&
958 td->num_received == 0 && td->prev_scantime != scantime)
959 td->num_expected = value;
960 /* A non 0 contact count always indicates a first packet */
962 td->num_expected = value;
964 td->prev_scantime = scantime;
966 first_packet = td->num_received == 0;
967 for (r = 0; r < report->maxfield; r++) {
968 field = report->field[r];
969 count = field->report_count;
971 if (!(HID_MAIN_ITEM_VARIABLE & field->flags))
974 for (n = 0; n < count; n++)
975 mt_process_mt_event(hid, field, &field->usage[n],
976 field->value[n], first_packet);
979 if (td->num_received >= td->num_expected)
980 mt_sync_frame(td, report->field[0]->hidinput->input);
983 * Windows 8 specs says 2 things:
984 * - once a contact has been reported, it has to be reported in each
986 * - the report rate when fingers are present has to be at least
987 * the refresh rate of the screen, 60 or 120 Hz
989 * I interprete this that the specification forces a report rate of
990 * at least 60 Hz for a touchscreen to be certified.
991 * Which means that if we do not get a report whithin 16 ms, either
992 * something wrong happens, either the touchscreen forgets to send
993 * a release. Taking a reasonable margin allows to remove issues
994 * with USB communication or the load of the machine.
996 * Given that Win 8 devices are forced to send a release, this will
997 * only affect laggish machines and the ones that have a firmware
1000 if (td->mtclass.quirks & MT_QUIRK_STICKY_FINGERS) {
1001 if (test_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags))
1002 mod_timer(&td->release_timer,
1003 jiffies + msecs_to_jiffies(100));
1005 del_timer(&td->release_timer);
1008 clear_bit(MT_IO_FLAGS_RUNNING, &td->mt_io_flags);
1011 static int mt_touch_input_configured(struct hid_device *hdev,
1012 struct hid_input *hi)
1014 struct mt_device *td = hid_get_drvdata(hdev);
1015 struct mt_class *cls = &td->mtclass;
1016 struct input_dev *input = hi->input;
1019 if (!td->maxcontacts)
1020 td->maxcontacts = MT_DEFAULT_MAXCONTACT;
1023 if (td->serial_maybe)
1024 mt_post_parse_default_settings(td);
1026 if (cls->is_indirect)
1027 td->mt_flags |= INPUT_MT_POINTER;
1029 if (cls->quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
1030 td->mt_flags |= INPUT_MT_DROP_UNUSED;
1032 /* check for clickpads */
1033 if ((td->mt_flags & INPUT_MT_POINTER) && (td->buttons_count == 1))
1034 td->is_buttonpad = true;
1036 if (td->is_buttonpad)
1037 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
1039 ret = input_mt_init_slots(input, td->maxcontacts, td->mt_flags);
1047 #define mt_map_key_clear(c) hid_map_usage_clear(hi, usage, bit, \
1049 static int mt_input_mapping(struct hid_device *hdev, struct hid_input *hi,
1050 struct hid_field *field, struct hid_usage *usage,
1051 unsigned long **bit, int *max)
1053 struct mt_device *td = hid_get_drvdata(hdev);
1056 * If mtclass.export_all_inputs is not set, only map fields from
1057 * TouchScreen or TouchPad collections. We need to ignore fields
1058 * that belong to other collections such as Mouse that might have
1059 * the same GenericDesktop usages.
1061 if (!td->mtclass.export_all_inputs &&
1062 field->application != HID_DG_TOUCHSCREEN &&
1063 field->application != HID_DG_PEN &&
1064 field->application != HID_DG_TOUCHPAD &&
1065 field->application != HID_GD_KEYBOARD &&
1066 field->application != HID_GD_SYSTEM_CONTROL &&
1067 field->application != HID_CP_CONSUMER_CONTROL &&
1068 field->application != HID_GD_WIRELESS_RADIO_CTLS &&
1069 !(field->application == HID_VD_ASUS_CUSTOM_MEDIA_KEYS &&
1070 td->mtclass.quirks & MT_QUIRK_ASUS_CUSTOM_UP))
1074 * Some Asus keyboard+touchpad devices have the hotkeys defined in the
1075 * touchpad report descriptor. We need to treat these as an array to
1076 * map usages to input keys.
1078 if (field->application == HID_VD_ASUS_CUSTOM_MEDIA_KEYS &&
1079 td->mtclass.quirks & MT_QUIRK_ASUS_CUSTOM_UP &&
1080 (usage->hid & HID_USAGE_PAGE) == HID_UP_CUSTOM) {
1081 set_bit(EV_REP, hi->input->evbit);
1082 if (field->flags & HID_MAIN_ITEM_VARIABLE)
1083 field->flags &= ~HID_MAIN_ITEM_VARIABLE;
1084 switch (usage->hid & HID_USAGE) {
1085 case 0x10: mt_map_key_clear(KEY_BRIGHTNESSDOWN); break;
1086 case 0x20: mt_map_key_clear(KEY_BRIGHTNESSUP); break;
1087 case 0x35: mt_map_key_clear(KEY_DISPLAY_OFF); break;
1088 case 0x6b: mt_map_key_clear(KEY_F21); break;
1089 case 0x6c: mt_map_key_clear(KEY_SLEEP); break;
1097 * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
1099 * The check for mt_report_id ensures we don't process
1100 * HID_DG_CONTACTCOUNT from the pen report as it is outside the physical
1101 * collection, but within the report ID.
1103 if (field->physical == HID_DG_STYLUS)
1105 else if ((field->physical == 0) &&
1106 (field->report->id != td->mt_report_id) &&
1107 (td->mt_report_id != -1))
1110 if (field->application == HID_DG_TOUCHSCREEN ||
1111 field->application == HID_DG_TOUCHPAD)
1112 return mt_touch_input_mapping(hdev, hi, field, usage, bit, max);
1114 /* let hid-core decide for the others */
1118 static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
1119 struct hid_field *field, struct hid_usage *usage,
1120 unsigned long **bit, int *max)
1123 * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
1126 if (field->physical == HID_DG_STYLUS)
1129 if (field->application == HID_DG_TOUCHSCREEN ||
1130 field->application == HID_DG_TOUCHPAD) {
1131 /* We own these mappings, tell hid-input to ignore them */
1135 /* let hid-core decide for the others */
1139 static int mt_event(struct hid_device *hid, struct hid_field *field,
1140 struct hid_usage *usage, __s32 value)
1142 struct mt_device *td = hid_get_drvdata(hid);
1144 if (field->report->id == td->mt_report_id)
1145 return mt_touch_event(hid, field, usage, value);
1150 static void mt_report(struct hid_device *hid, struct hid_report *report)
1152 struct mt_device *td = hid_get_drvdata(hid);
1153 struct hid_field *field = report->field[0];
1155 if (!(hid->claimed & HID_CLAIMED_INPUT))
1158 if (report->id == td->mt_report_id)
1159 return mt_touch_report(hid, report);
1161 if (field && field->hidinput && field->hidinput->input)
1162 input_sync(field->hidinput->input);
1165 static bool mt_need_to_apply_feature(struct hid_device *hdev,
1166 struct hid_field *field,
1167 struct hid_usage *usage,
1168 enum latency_mode latency,
1169 bool surface_switch,
1172 struct mt_device *td = hid_get_drvdata(hdev);
1173 struct mt_class *cls = &td->mtclass;
1174 struct hid_report *report = field->report;
1175 unsigned int index = usage->usage_index;
1180 switch (usage->hid) {
1181 case HID_DG_INPUTMODE:
1182 if (cls->quirks & MT_QUIRK_FORCE_GET_FEATURE) {
1183 report_len = hid_report_len(report);
1184 buf = hid_alloc_report_buf(report, GFP_KERNEL);
1187 "failed to allocate buffer for report\n");
1190 hid_hw_raw_request(hdev, report->id, buf, report_len,
1192 HID_REQ_GET_REPORT);
1196 field->value[index] = td->inputmode_value;
1199 case HID_DG_CONTACTMAX:
1200 if (td->mtclass.maxcontacts) {
1201 max = min_t(int, field->logical_maximum,
1202 td->mtclass.maxcontacts);
1203 if (field->value[index] != max) {
1204 field->value[index] = max;
1210 case HID_DG_LATENCYMODE:
1211 field->value[index] = latency;
1214 case HID_DG_SURFACESWITCH:
1215 field->value[index] = surface_switch;
1218 case HID_DG_BUTTONSWITCH:
1219 field->value[index] = button_switch;
1223 return false; /* no need to update the report */
1226 static void mt_set_modes(struct hid_device *hdev, enum latency_mode latency,
1227 bool surface_switch, bool button_switch)
1229 struct hid_report_enum *rep_enum;
1230 struct hid_report *rep;
1231 struct hid_usage *usage;
1235 rep_enum = &hdev->report_enum[HID_FEATURE_REPORT];
1236 list_for_each_entry(rep, &rep_enum->report_list, list) {
1237 update_report = false;
1239 for (i = 0; i < rep->maxfield; i++) {
1240 /* Ignore if report count is out of bounds. */
1241 if (rep->field[i]->report_count < 1)
1244 for (j = 0; j < rep->field[i]->maxusage; j++) {
1245 usage = &rep->field[i]->usage[j];
1247 if (mt_need_to_apply_feature(hdev,
1253 update_report = true;
1258 hid_hw_request(hdev, rep, HID_REQ_SET_REPORT);
1262 static void mt_post_parse_default_settings(struct mt_device *td)
1264 __s32 quirks = td->mtclass.quirks;
1266 /* unknown serial device needs special quirks */
1267 if (td->touches_by_report == 1) {
1268 quirks |= MT_QUIRK_ALWAYS_VALID;
1269 quirks &= ~MT_QUIRK_NOT_SEEN_MEANS_UP;
1270 quirks &= ~MT_QUIRK_VALID_IS_INRANGE;
1271 quirks &= ~MT_QUIRK_VALID_IS_CONFIDENCE;
1272 quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
1275 td->mtclass.quirks = quirks;
1278 static void mt_post_parse(struct mt_device *td)
1280 struct mt_fields *f = td->fields;
1281 struct mt_class *cls = &td->mtclass;
1283 if (td->touches_by_report > 0) {
1284 int field_count_per_touch = f->length / td->touches_by_report;
1285 td->last_slot_field = f->usages[field_count_per_touch - 1];
1288 if (td->cc_index < 0)
1289 cls->quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
1292 static int mt_input_configured(struct hid_device *hdev, struct hid_input *hi)
1294 struct mt_device *td = hid_get_drvdata(hdev);
1296 const char *suffix = NULL;
1297 unsigned int application = 0;
1298 struct hid_report *report;
1301 list_for_each_entry(report, &hi->reports, hidinput_list) {
1302 application = report->application;
1303 if (report->id == td->mt_report_id) {
1304 ret = mt_touch_input_configured(hdev, hi);
1310 * some egalax touchscreens have "application == DG_TOUCHSCREEN"
1311 * for the stylus. Check this first, and then rely on
1312 * the application field.
1314 if (report->field[0]->physical == HID_DG_STYLUS) {
1316 /* force BTN_STYLUS to allow tablet matching in udev */
1317 __set_bit(BTN_STYLUS, hi->input->keybit);
1322 switch (application) {
1323 case HID_GD_KEYBOARD:
1326 case HID_DG_TOUCHPAD:
1327 case HID_GD_SYSTEM_CONTROL:
1328 case HID_CP_CONSUMER_CONTROL:
1329 case HID_GD_WIRELESS_RADIO_CTLS:
1330 /* already handled by hid core */
1332 case HID_DG_TOUCHSCREEN:
1333 /* we do not set suffix = "Touchscreen" */
1334 hi->input->name = hdev->name;
1337 /* force BTN_STYLUS to allow tablet matching in udev */
1338 __set_bit(BTN_STYLUS, hi->input->keybit);
1340 case HID_VD_ASUS_CUSTOM_MEDIA_KEYS:
1341 suffix = "Custom Media Keys";
1350 name = devm_kzalloc(&hi->input->dev,
1351 strlen(hdev->name) + strlen(suffix) + 2,
1354 sprintf(name, "%s %s", hdev->name, suffix);
1355 hi->input->name = name;
1362 static void mt_fix_const_field(struct hid_field *field, unsigned int usage)
1364 if (field->usage[0].hid != usage ||
1365 !(field->flags & HID_MAIN_ITEM_CONSTANT))
1368 field->flags &= ~HID_MAIN_ITEM_CONSTANT;
1369 field->flags |= HID_MAIN_ITEM_VARIABLE;
1372 static void mt_fix_const_fields(struct hid_device *hdev, unsigned int usage)
1374 struct hid_report *report;
1377 list_for_each_entry(report,
1378 &hdev->report_enum[HID_INPUT_REPORT].report_list,
1381 if (!report->maxfield)
1384 for (i = 0; i < report->maxfield; i++)
1385 if (report->field[i]->maxusage >= 1)
1386 mt_fix_const_field(report->field[i], usage);
1390 static void mt_release_contacts(struct hid_device *hid)
1392 struct hid_input *hidinput;
1393 struct mt_device *td = hid_get_drvdata(hid);
1395 list_for_each_entry(hidinput, &hid->inputs, list) {
1396 struct input_dev *input_dev = hidinput->input;
1397 struct input_mt *mt = input_dev->mt;
1401 for (i = 0; i < mt->num_slots; i++) {
1402 input_mt_slot(input_dev, i);
1403 input_mt_report_slot_state(input_dev,
1407 input_mt_sync_frame(input_dev);
1408 input_sync(input_dev);
1412 td->num_received = 0;
1415 static void mt_expired_timeout(struct timer_list *t)
1417 struct mt_device *td = from_timer(td, t, release_timer);
1418 struct hid_device *hdev = td->hdev;
1421 * An input report came in just before we release the sticky fingers,
1422 * it will take care of the sticky fingers.
1424 if (test_and_set_bit(MT_IO_FLAGS_RUNNING, &td->mt_io_flags))
1426 if (test_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags))
1427 mt_release_contacts(hdev);
1428 clear_bit(MT_IO_FLAGS_RUNNING, &td->mt_io_flags);
1431 static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
1434 struct mt_device *td;
1435 struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */
1437 for (i = 0; mt_classes[i].name ; i++) {
1438 if (id->driver_data == mt_classes[i].name) {
1439 mtclass = &(mt_classes[i]);
1444 td = devm_kzalloc(&hdev->dev, sizeof(struct mt_device), GFP_KERNEL);
1446 dev_err(&hdev->dev, "cannot allocate multitouch data\n");
1450 td->mtclass = *mtclass;
1451 td->inputmode_value = MT_INPUTMODE_TOUCHSCREEN;
1453 td->scantime_index = -1;
1454 td->mt_report_id = -1;
1455 hid_set_drvdata(hdev, td);
1457 td->fields = devm_kzalloc(&hdev->dev, sizeof(struct mt_fields),
1460 dev_err(&hdev->dev, "cannot allocate multitouch fields data\n");
1464 if (id->vendor == HID_ANY_ID && id->product == HID_ANY_ID)
1465 td->serial_maybe = true;
1467 /* This allows the driver to correctly support devices
1468 * that emit events over several HID messages.
1470 hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
1473 * This allows the driver to handle different input sensors
1474 * that emits events through different applications on the same HID
1477 hdev->quirks |= HID_QUIRK_INPUT_PER_APP;
1479 timer_setup(&td->release_timer, mt_expired_timeout, 0);
1481 ret = hid_parse(hdev);
1485 if (mtclass->quirks & MT_QUIRK_FIX_CONST_CONTACT_ID)
1486 mt_fix_const_fields(hdev, HID_DG_CONTACTID);
1488 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
1492 ret = sysfs_create_group(&hdev->dev.kobj, &mt_attribute_group);
1494 dev_warn(&hdev->dev, "Cannot allocate sysfs group for %s\n",
1497 mt_set_modes(hdev, HID_LATENCY_NORMAL, true, true);
1499 /* release .fields memory as it is not used anymore */
1500 devm_kfree(&hdev->dev, td->fields);
1507 static int mt_reset_resume(struct hid_device *hdev)
1509 mt_release_contacts(hdev);
1510 mt_set_modes(hdev, HID_LATENCY_NORMAL, true, true);
1514 static int mt_resume(struct hid_device *hdev)
1516 /* Some Elan legacy devices require SET_IDLE to be set on resume.
1517 * It should be safe to send it to other devices too.
1518 * Tested on 3M, Stantum, Cypress, Zytronic, eGalax, and Elan panels. */
1520 hid_hw_idle(hdev, 0, 0, HID_REQ_SET_IDLE);
1526 static void mt_remove(struct hid_device *hdev)
1528 struct mt_device *td = hid_get_drvdata(hdev);
1530 del_timer_sync(&td->release_timer);
1532 sysfs_remove_group(&hdev->dev.kobj, &mt_attribute_group);
1537 * This list contains only:
1538 * - VID/PID of products not working with the default multitouch handling
1539 * - 2 generic rules.
1540 * So there is no point in adding here any device with MT_CLS_DEFAULT.
1542 static const struct hid_device_id mt_devices[] = {
1545 { .driver_data = MT_CLS_3M,
1546 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1547 USB_DEVICE_ID_3M1968) },
1548 { .driver_data = MT_CLS_3M,
1549 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1550 USB_DEVICE_ID_3M2256) },
1551 { .driver_data = MT_CLS_3M,
1552 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1553 USB_DEVICE_ID_3M3266) },
1556 { .driver_data = MT_CLS_WIN_8_DUAL,
1557 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1558 USB_VENDOR_ID_ALPS_JP,
1559 HID_DEVICE_ID_ALPS_U1_DUAL_PTP) },
1560 { .driver_data = MT_CLS_WIN_8_DUAL,
1561 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1562 USB_VENDOR_ID_ALPS_JP,
1563 HID_DEVICE_ID_ALPS_U1_DUAL_3BTN_PTP) },
1565 /* Lenovo X1 TAB Gen 2 */
1566 { .driver_data = MT_CLS_WIN_8_DUAL,
1567 HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1568 USB_VENDOR_ID_LENOVO,
1569 USB_DEVICE_ID_LENOVO_X1_TAB) },
1572 { .driver_data = MT_CLS_EXPORT_ALL_INPUTS,
1573 MT_USB_DEVICE(USB_VENDOR_ID_ANTON,
1574 USB_DEVICE_ID_ANTON_TOUCH_PAD) },
1577 { .driver_data = MT_CLS_ASUS,
1578 HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1579 USB_VENDOR_ID_ASUSTEK,
1580 USB_DEVICE_ID_ASUSTEK_T304_KEYBOARD) },
1583 { .driver_data = MT_CLS_SERIAL,
1584 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL,
1585 USB_DEVICE_ID_ATMEL_MXT_DIGITIZER) },
1587 /* Baanto multitouch devices */
1588 { .driver_data = MT_CLS_NSMU,
1589 MT_USB_DEVICE(USB_VENDOR_ID_BAANTO,
1590 USB_DEVICE_ID_BAANTO_MT_190W2) },
1593 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1594 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1595 USB_DEVICE_ID_CANDO_MULTI_TOUCH) },
1596 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1597 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1598 USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6) },
1600 /* Chunghwa Telecom touch panels */
1601 { .driver_data = MT_CLS_NSMU,
1602 MT_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT,
1603 USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH) },
1605 /* CJTouch panels */
1606 { .driver_data = MT_CLS_NSMU,
1607 MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1608 USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0020) },
1609 { .driver_data = MT_CLS_NSMU,
1610 MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1611 USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0040) },
1613 /* CVTouch panels */
1614 { .driver_data = MT_CLS_NSMU,
1615 MT_USB_DEVICE(USB_VENDOR_ID_CVTOUCH,
1616 USB_DEVICE_ID_CVTOUCH_SCREEN) },
1618 /* eGalax devices (resistive) */
1619 { .driver_data = MT_CLS_EGALAX,
1620 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1621 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D) },
1622 { .driver_data = MT_CLS_EGALAX,
1623 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1624 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E) },
1626 /* eGalax devices (capacitive) */
1627 { .driver_data = MT_CLS_EGALAX_SERIAL,
1628 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1629 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7207) },
1630 { .driver_data = MT_CLS_EGALAX,
1631 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1632 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C) },
1633 { .driver_data = MT_CLS_EGALAX_SERIAL,
1634 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1635 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224) },
1636 { .driver_data = MT_CLS_EGALAX_SERIAL,
1637 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1638 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_722A) },
1639 { .driver_data = MT_CLS_EGALAX_SERIAL,
1640 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1641 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_725E) },
1642 { .driver_data = MT_CLS_EGALAX_SERIAL,
1643 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1644 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7262) },
1645 { .driver_data = MT_CLS_EGALAX,
1646 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1647 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B) },
1648 { .driver_data = MT_CLS_EGALAX,
1649 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1650 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1) },
1651 { .driver_data = MT_CLS_EGALAX_SERIAL,
1652 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1653 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72AA) },
1654 { .driver_data = MT_CLS_EGALAX,
1655 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1656 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72C4) },
1657 { .driver_data = MT_CLS_EGALAX,
1658 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1659 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72D0) },
1660 { .driver_data = MT_CLS_EGALAX,
1661 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1662 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA) },
1663 { .driver_data = MT_CLS_EGALAX,
1664 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1665 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302) },
1666 { .driver_data = MT_CLS_EGALAX_SERIAL,
1667 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1668 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7349) },
1669 { .driver_data = MT_CLS_EGALAX_SERIAL,
1670 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1671 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_73F7) },
1672 { .driver_data = MT_CLS_EGALAX_SERIAL,
1673 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1674 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001) },
1676 /* Elitegroup panel */
1677 { .driver_data = MT_CLS_SERIAL,
1678 MT_USB_DEVICE(USB_VENDOR_ID_ELITEGROUP,
1679 USB_DEVICE_ID_ELITEGROUP_05D8) },
1681 /* Flatfrog Panels */
1682 { .driver_data = MT_CLS_FLATFROG,
1683 MT_USB_DEVICE(USB_VENDOR_ID_FLATFROG,
1684 USB_DEVICE_ID_MULTITOUCH_3200) },
1686 /* FocalTech Panels */
1687 { .driver_data = MT_CLS_SERIAL,
1688 MT_USB_DEVICE(USB_VENDOR_ID_CYGNAL,
1689 USB_DEVICE_ID_FOCALTECH_FTXXXX_MULTITOUCH) },
1691 /* GeneralTouch panel */
1692 { .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1693 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1694 USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
1695 { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1696 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1697 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PWT_TENFINGERS) },
1698 { .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1699 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1700 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0101) },
1701 { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1702 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1703 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0102) },
1704 { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1705 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1706 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0106) },
1707 { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1708 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1709 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_010A) },
1710 { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1711 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1712 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_E100) },
1714 /* Gametel game controller */
1715 { .driver_data = MT_CLS_NSMU,
1716 MT_BT_DEVICE(USB_VENDOR_ID_FRUCTEL,
1717 USB_DEVICE_ID_GAMETEL_MT_MODE) },
1719 /* GoodTouch panels */
1720 { .driver_data = MT_CLS_NSMU,
1721 MT_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH,
1722 USB_DEVICE_ID_GOODTOUCH_000f) },
1725 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1726 MT_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT,
1727 USB_DEVICE_ID_HANVON_ALT_MULTITOUCH) },
1729 /* Ilitek dual touch panel */
1730 { .driver_data = MT_CLS_NSMU,
1731 MT_USB_DEVICE(USB_VENDOR_ID_ILITEK,
1732 USB_DEVICE_ID_ILITEK_MULTITOUCH) },
1734 /* LG Melfas panel */
1735 { .driver_data = MT_CLS_LG,
1736 HID_USB_DEVICE(USB_VENDOR_ID_LG,
1737 USB_DEVICE_ID_LG_MELFAS_MT) },
1740 { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1741 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
1742 USB_DEVICE_ID_ASUS_T91MT)},
1743 { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1744 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
1745 USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO) },
1746 { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1747 MT_USB_DEVICE(USB_VENDOR_ID_TURBOX,
1748 USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART) },
1751 { .driver_data = MT_CLS_NSMU,
1752 MT_USB_DEVICE(USB_VENDOR_ID_NOVATEK,
1753 USB_DEVICE_ID_NOVATEK_PCT) },
1756 { .driver_data = MT_CLS_NSMU,
1757 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1758 USB_VENDOR_ID_NTRIG, 0x1b05) },
1760 /* Panasonic panels */
1761 { .driver_data = MT_CLS_PANASONIC,
1762 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
1763 USB_DEVICE_ID_PANABOARD_UBT780) },
1764 { .driver_data = MT_CLS_PANASONIC,
1765 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
1766 USB_DEVICE_ID_PANABOARD_UBT880) },
1768 /* PixArt optical touch screen */
1769 { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1770 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1771 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN) },
1772 { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1773 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1774 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1) },
1775 { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1776 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1777 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2) },
1779 /* PixCir-based panels */
1780 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1781 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1782 USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
1784 /* Quanta-based panels */
1785 { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
1786 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
1787 USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001) },
1789 /* Razer touchpads */
1790 { .driver_data = MT_CLS_RAZER_BLADE_STEALTH,
1791 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1792 USB_VENDOR_ID_SYNAPTICS, 0x8323) },
1794 /* Stantum panels */
1795 { .driver_data = MT_CLS_CONFIDENCE,
1796 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM,
1797 USB_DEVICE_ID_MTP_STM)},
1799 /* TopSeed panels */
1800 { .driver_data = MT_CLS_TOPSEED,
1801 MT_USB_DEVICE(USB_VENDOR_ID_TOPSEED2,
1802 USB_DEVICE_ID_TOPSEED2_PERIPAD_701) },
1804 /* Touch International panels */
1805 { .driver_data = MT_CLS_NSMU,
1806 MT_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL,
1807 USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH) },
1810 { .driver_data = MT_CLS_NSMU,
1811 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
1812 USB_DEVICE_ID_UNITEC_USB_TOUCH_0709) },
1813 { .driver_data = MT_CLS_NSMU,
1814 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
1815 USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19) },
1818 { .driver_data = MT_CLS_VTL,
1819 MT_USB_DEVICE(USB_VENDOR_ID_VTL,
1820 USB_DEVICE_ID_VTL_MULTITOUCH_FF3F) },
1822 /* Wistron panels */
1823 { .driver_data = MT_CLS_NSMU,
1824 MT_USB_DEVICE(USB_VENDOR_ID_WISTRON,
1825 USB_DEVICE_ID_WISTRON_OPTICAL_TOUCH) },
1828 { .driver_data = MT_CLS_NSMU,
1829 MT_USB_DEVICE(USB_VENDOR_ID_XAT,
1830 USB_DEVICE_ID_XAT_CSR) },
1833 { .driver_data = MT_CLS_NSMU,
1834 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1835 USB_DEVICE_ID_XIROKU_SPX) },
1836 { .driver_data = MT_CLS_NSMU,
1837 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1838 USB_DEVICE_ID_XIROKU_MPX) },
1839 { .driver_data = MT_CLS_NSMU,
1840 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1841 USB_DEVICE_ID_XIROKU_CSR) },
1842 { .driver_data = MT_CLS_NSMU,
1843 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1844 USB_DEVICE_ID_XIROKU_SPX1) },
1845 { .driver_data = MT_CLS_NSMU,
1846 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1847 USB_DEVICE_ID_XIROKU_MPX1) },
1848 { .driver_data = MT_CLS_NSMU,
1849 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1850 USB_DEVICE_ID_XIROKU_CSR1) },
1851 { .driver_data = MT_CLS_NSMU,
1852 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1853 USB_DEVICE_ID_XIROKU_SPX2) },
1854 { .driver_data = MT_CLS_NSMU,
1855 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1856 USB_DEVICE_ID_XIROKU_MPX2) },
1857 { .driver_data = MT_CLS_NSMU,
1858 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1859 USB_DEVICE_ID_XIROKU_CSR2) },
1861 /* Google MT devices */
1862 { .driver_data = MT_CLS_GOOGLE,
1863 HID_DEVICE(HID_BUS_ANY, HID_GROUP_ANY, USB_VENDOR_ID_GOOGLE,
1864 USB_DEVICE_ID_GOOGLE_TOUCH_ROSE) },
1866 /* Generic MT device */
1867 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH, HID_ANY_ID, HID_ANY_ID) },
1869 /* Generic Win 8 certified MT device */
1870 { .driver_data = MT_CLS_WIN_8,
1871 HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH_WIN_8,
1872 HID_ANY_ID, HID_ANY_ID) },
1875 MODULE_DEVICE_TABLE(hid, mt_devices);
1877 static const struct hid_usage_id mt_grabbed_usages[] = {
1878 { HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
1879 { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
1882 static struct hid_driver mt_driver = {
1883 .name = "hid-multitouch",
1884 .id_table = mt_devices,
1886 .remove = mt_remove,
1887 .input_mapping = mt_input_mapping,
1888 .input_mapped = mt_input_mapped,
1889 .input_configured = mt_input_configured,
1890 .feature_mapping = mt_feature_mapping,
1891 .usage_table = mt_grabbed_usages,
1893 .report = mt_report,
1895 .reset_resume = mt_reset_resume,
1896 .resume = mt_resume,
1899 module_hid_driver(mt_driver);