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)
78 #define MT_INPUTMODE_TOUCHSCREEN 0x02
79 #define MT_INPUTMODE_TOUCHPAD 0x03
81 #define MT_BUTTONTYPE_CLICKPAD 0
83 #define MT_IO_FLAGS_RUNNING 0
84 #define MT_IO_FLAGS_ACTIVE_SLOTS 1
85 #define MT_IO_FLAGS_PENDING_SLOTS 2
88 __s32 x, y, cx, cy, p, w, h;
89 __s32 contactid; /* the device ContactID assigned to this slot */
90 bool touch_state; /* is the touch valid? */
91 bool inrange_state; /* is the finger in proximity of the sensor? */
92 bool confidence_state; /* is the touch made by a finger? */
96 __s32 name; /* MT_CLS */
98 __s32 sn_move; /* Signal/noise ratio for move events */
99 __s32 sn_width; /* Signal/noise ratio for width events */
100 __s32 sn_height; /* Signal/noise ratio for height events */
101 __s32 sn_pressure; /* Signal/noise ratio for pressure events */
103 bool is_indirect; /* true for touchpads */
104 bool export_all_inputs; /* do not ignore mouse, keyboards, etc... */
108 unsigned usages[HID_MAX_FIELDS];
113 struct mt_slot curdata; /* placeholder of incoming data */
114 struct mt_class mtclass; /* our mt device class */
115 struct timer_list release_timer; /* to release sticky fingers */
116 struct mt_fields *fields; /* temporary placeholder for storing the
118 unsigned long mt_io_flags; /* mt flags (MT_IO_FLAGS_*) */
119 int cc_index; /* contact count field index in the report */
120 int cc_value_index; /* contact count value index in the field */
121 unsigned last_slot_field; /* the last field of a slot */
122 unsigned mt_report_id; /* the report ID of the multitouch device */
123 unsigned long initial_quirks; /* initial quirks state */
124 __s16 inputmode; /* InputMode HID feature, -1 if non-existent */
125 __s16 inputmode_index; /* InputMode HID feature index in the report */
126 __s16 maxcontact_report_id; /* Maximum Contact Number HID feature,
127 -1 if non-existent */
128 __u8 inputmode_value; /* InputMode HID feature value */
129 __u8 num_received; /* how many contacts we received */
130 __u8 num_expected; /* expected last contact index */
132 __u8 touches_by_report; /* how many touches are present in one report:
133 * 1 means we should use a serial protocol
134 * > 1 means hybrid (multitouch) protocol */
135 __u8 buttons_count; /* number of physical buttons per touchpad */
136 bool is_buttonpad; /* is this device a button pad? */
137 bool serial_maybe; /* need to check for serial protocol */
138 bool curvalid; /* is the current contact valid? */
139 unsigned mt_flags; /* flags to pass to input-mt */
140 __s32 dev_time; /* the scan time provided by the device */
141 unsigned long jiffies; /* the frame's jiffies */
142 int timestamp; /* the timestamp to be sent */
145 static void mt_post_parse_default_settings(struct mt_device *td);
146 static void mt_post_parse(struct mt_device *td);
148 /* classes of device behavior */
149 #define MT_CLS_DEFAULT 0x0001
151 #define MT_CLS_SERIAL 0x0002
152 #define MT_CLS_CONFIDENCE 0x0003
153 #define MT_CLS_CONFIDENCE_CONTACT_ID 0x0004
154 #define MT_CLS_CONFIDENCE_MINUS_ONE 0x0005
155 #define MT_CLS_DUAL_INRANGE_CONTACTID 0x0006
156 #define MT_CLS_DUAL_INRANGE_CONTACTNUMBER 0x0007
157 /* reserved 0x0008 */
158 #define MT_CLS_INRANGE_CONTACTNUMBER 0x0009
159 #define MT_CLS_NSMU 0x000a
160 /* reserved 0x0010 */
161 /* reserved 0x0011 */
162 #define MT_CLS_WIN_8 0x0012
163 #define MT_CLS_EXPORT_ALL_INPUTS 0x0013
164 #define MT_CLS_WIN_8_DUAL 0x0014
166 /* vendor specific classes */
167 #define MT_CLS_3M 0x0101
168 /* reserved 0x0102 */
169 #define MT_CLS_EGALAX 0x0103
170 #define MT_CLS_EGALAX_SERIAL 0x0104
171 #define MT_CLS_TOPSEED 0x0105
172 #define MT_CLS_PANASONIC 0x0106
173 #define MT_CLS_FLATFROG 0x0107
174 #define MT_CLS_GENERALTOUCH_TWOFINGERS 0x0108
175 #define MT_CLS_GENERALTOUCH_PWT_TENFINGERS 0x0109
176 #define MT_CLS_LG 0x010a
177 #define MT_CLS_ASUS 0x010b
178 #define MT_CLS_VTL 0x0110
179 #define MT_CLS_GOOGLE 0x0111
181 #define MT_DEFAULT_MAXCONTACT 10
182 #define MT_MAX_MAXCONTACT 250
185 * Resync device and local timestamps after that many microseconds without
188 #define MAX_TIMESTAMP_INTERVAL 1000000
190 #define MT_USB_DEVICE(v, p) HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH, v, p)
191 #define MT_BT_DEVICE(v, p) HID_DEVICE(BUS_BLUETOOTH, HID_GROUP_MULTITOUCH, v, p)
194 * these device-dependent functions determine what slot corresponds
195 * to a valid contact that was just read.
198 static int cypress_compute_slot(struct mt_device *td)
200 if (td->curdata.contactid != 0 || td->num_received == 0)
201 return td->curdata.contactid;
206 static struct mt_class mt_classes[] = {
207 { .name = MT_CLS_DEFAULT,
208 .quirks = MT_QUIRK_ALWAYS_VALID |
209 MT_QUIRK_CONTACT_CNT_ACCURATE },
210 { .name = MT_CLS_NSMU,
211 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP },
212 { .name = MT_CLS_SERIAL,
213 .quirks = MT_QUIRK_ALWAYS_VALID},
214 { .name = MT_CLS_CONFIDENCE,
215 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE },
216 { .name = MT_CLS_CONFIDENCE_CONTACT_ID,
217 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
218 MT_QUIRK_SLOT_IS_CONTACTID },
219 { .name = MT_CLS_CONFIDENCE_MINUS_ONE,
220 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
221 MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE },
222 { .name = MT_CLS_DUAL_INRANGE_CONTACTID,
223 .quirks = MT_QUIRK_VALID_IS_INRANGE |
224 MT_QUIRK_SLOT_IS_CONTACTID,
226 { .name = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
227 .quirks = MT_QUIRK_VALID_IS_INRANGE |
228 MT_QUIRK_SLOT_IS_CONTACTNUMBER,
230 { .name = MT_CLS_INRANGE_CONTACTNUMBER,
231 .quirks = MT_QUIRK_VALID_IS_INRANGE |
232 MT_QUIRK_SLOT_IS_CONTACTNUMBER },
233 { .name = MT_CLS_WIN_8,
234 .quirks = MT_QUIRK_ALWAYS_VALID |
235 MT_QUIRK_IGNORE_DUPLICATES |
237 MT_QUIRK_CONTACT_CNT_ACCURATE |
238 MT_QUIRK_STICKY_FINGERS },
239 { .name = MT_CLS_EXPORT_ALL_INPUTS,
240 .quirks = MT_QUIRK_ALWAYS_VALID |
241 MT_QUIRK_CONTACT_CNT_ACCURATE,
242 .export_all_inputs = true },
243 { .name = MT_CLS_WIN_8_DUAL,
244 .quirks = MT_QUIRK_ALWAYS_VALID |
245 MT_QUIRK_IGNORE_DUPLICATES |
247 MT_QUIRK_CONTACT_CNT_ACCURATE,
248 .export_all_inputs = true },
251 * vendor specific classes
254 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
255 MT_QUIRK_SLOT_IS_CONTACTID |
256 MT_QUIRK_TOUCH_SIZE_SCALING,
262 { .name = MT_CLS_EGALAX,
263 .quirks = MT_QUIRK_SLOT_IS_CONTACTID |
264 MT_QUIRK_VALID_IS_INRANGE,
268 { .name = MT_CLS_EGALAX_SERIAL,
269 .quirks = MT_QUIRK_SLOT_IS_CONTACTID |
270 MT_QUIRK_ALWAYS_VALID,
274 { .name = MT_CLS_TOPSEED,
275 .quirks = MT_QUIRK_ALWAYS_VALID,
279 { .name = MT_CLS_PANASONIC,
280 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP,
282 { .name = MT_CLS_GENERALTOUCH_TWOFINGERS,
283 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
284 MT_QUIRK_VALID_IS_INRANGE |
285 MT_QUIRK_SLOT_IS_CONTACTID,
288 { .name = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
289 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
290 MT_QUIRK_SLOT_IS_CONTACTID
293 { .name = MT_CLS_FLATFROG,
294 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
300 .quirks = MT_QUIRK_ALWAYS_VALID |
301 MT_QUIRK_FIX_CONST_CONTACT_ID |
302 MT_QUIRK_IGNORE_DUPLICATES |
304 MT_QUIRK_CONTACT_CNT_ACCURATE },
305 { .name = MT_CLS_ASUS,
306 .quirks = MT_QUIRK_ALWAYS_VALID |
307 MT_QUIRK_CONTACT_CNT_ACCURATE |
308 MT_QUIRK_ASUS_CUSTOM_UP },
309 { .name = MT_CLS_VTL,
310 .quirks = MT_QUIRK_ALWAYS_VALID |
311 MT_QUIRK_CONTACT_CNT_ACCURATE |
312 MT_QUIRK_FORCE_GET_FEATURE,
314 { .name = MT_CLS_GOOGLE,
315 .quirks = MT_QUIRK_ALWAYS_VALID |
316 MT_QUIRK_CONTACT_CNT_ACCURATE |
317 MT_QUIRK_SLOT_IS_CONTACTID |
323 static ssize_t mt_show_quirks(struct device *dev,
324 struct device_attribute *attr,
327 struct hid_device *hdev = to_hid_device(dev);
328 struct mt_device *td = hid_get_drvdata(hdev);
330 return sprintf(buf, "%u\n", td->mtclass.quirks);
333 static ssize_t mt_set_quirks(struct device *dev,
334 struct device_attribute *attr,
335 const char *buf, size_t count)
337 struct hid_device *hdev = to_hid_device(dev);
338 struct mt_device *td = hid_get_drvdata(hdev);
342 if (kstrtoul(buf, 0, &val))
345 td->mtclass.quirks = val;
347 if (td->cc_index < 0)
348 td->mtclass.quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
353 static DEVICE_ATTR(quirks, S_IWUSR | S_IRUGO, mt_show_quirks, mt_set_quirks);
355 static struct attribute *sysfs_attrs[] = {
356 &dev_attr_quirks.attr,
360 static const struct attribute_group mt_attribute_group = {
364 static void mt_get_feature(struct hid_device *hdev, struct hid_report *report)
366 struct mt_device *td = hid_get_drvdata(hdev);
367 int ret, size = hid_report_len(report);
371 * Do not fetch the feature report if the device has been explicitly
372 * marked as non-capable.
374 if (td->initial_quirks & HID_QUIRK_NO_INIT_REPORTS)
377 buf = hid_alloc_report_buf(report, GFP_KERNEL);
381 ret = hid_hw_raw_request(hdev, report->id, buf, size,
382 HID_FEATURE_REPORT, HID_REQ_GET_REPORT);
384 dev_warn(&hdev->dev, "failed to fetch feature %d\n",
387 ret = hid_report_raw_event(hdev, HID_FEATURE_REPORT, buf,
390 dev_warn(&hdev->dev, "failed to report feature\n");
396 static void mt_feature_mapping(struct hid_device *hdev,
397 struct hid_field *field, struct hid_usage *usage)
399 struct mt_device *td = hid_get_drvdata(hdev);
401 switch (usage->hid) {
402 case HID_DG_INPUTMODE:
403 /* Ignore if value index is out of bounds. */
404 if (usage->usage_index >= field->report_count) {
405 dev_err(&hdev->dev, "HID_DG_INPUTMODE out of range\n");
409 if (td->inputmode < 0) {
410 td->inputmode = field->report->id;
411 td->inputmode_index = usage->usage_index;
414 * Some elan panels wrongly declare 2 input mode
415 * features, and silently ignore when we set the
416 * value in the second field. Skip the second feature
417 * and hope for the best.
420 "Ignoring the extra HID_DG_INPUTMODE\n");
424 case HID_DG_CONTACTMAX:
425 mt_get_feature(hdev, field->report);
427 td->maxcontact_report_id = field->report->id;
428 td->maxcontacts = field->value[0];
429 if (!td->maxcontacts &&
430 field->logical_maximum <= MT_MAX_MAXCONTACT)
431 td->maxcontacts = field->logical_maximum;
432 if (td->mtclass.maxcontacts)
433 /* check if the maxcontacts is given by the class */
434 td->maxcontacts = td->mtclass.maxcontacts;
437 case HID_DG_BUTTONTYPE:
438 if (usage->usage_index >= field->report_count) {
439 dev_err(&hdev->dev, "HID_DG_BUTTONTYPE out of range\n");
443 mt_get_feature(hdev, field->report);
444 if (field->value[usage->usage_index] == MT_BUTTONTYPE_CLICKPAD)
445 td->is_buttonpad = true;
449 /* Retrieve the Win8 blob once to enable some devices */
450 if (usage->usage_index == 0)
451 mt_get_feature(hdev, field->report);
456 static void set_abs(struct input_dev *input, unsigned int code,
457 struct hid_field *field, int snratio)
459 int fmin = field->logical_minimum;
460 int fmax = field->logical_maximum;
461 int fuzz = snratio ? (fmax - fmin) / snratio : 0;
462 input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
463 input_abs_set_res(input, code, hidinput_calc_abs_res(field, code));
466 static void mt_store_field(struct hid_usage *usage, struct mt_device *td,
467 struct hid_input *hi)
469 struct mt_fields *f = td->fields;
471 if (f->length >= HID_MAX_FIELDS)
474 f->usages[f->length++] = usage->hid;
477 static int mt_touch_input_mapping(struct hid_device *hdev, struct hid_input *hi,
478 struct hid_field *field, struct hid_usage *usage,
479 unsigned long **bit, int *max)
481 struct mt_device *td = hid_get_drvdata(hdev);
482 struct mt_class *cls = &td->mtclass;
484 struct hid_usage *prev_usage = NULL;
486 if (field->application == HID_DG_TOUCHSCREEN)
487 td->mt_flags |= INPUT_MT_DIRECT;
490 * Model touchscreens providing buttons as touchpads.
492 if (field->application == HID_DG_TOUCHPAD ||
493 (usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON) {
494 td->mt_flags |= INPUT_MT_POINTER;
495 td->inputmode_value = MT_INPUTMODE_TOUCHPAD;
498 /* count the buttons on touchpads */
499 if ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON)
502 if (usage->usage_index)
503 prev_usage = &field->usage[usage->usage_index - 1];
505 switch (usage->hid & HID_USAGE_PAGE) {
508 switch (usage->hid) {
510 if (prev_usage && (prev_usage->hid == usage->hid)) {
511 hid_map_usage(hi, usage, bit, max,
512 EV_ABS, ABS_MT_TOOL_X);
513 set_abs(hi->input, ABS_MT_TOOL_X, field,
516 hid_map_usage(hi, usage, bit, max,
517 EV_ABS, ABS_MT_POSITION_X);
518 set_abs(hi->input, ABS_MT_POSITION_X, field,
522 mt_store_field(usage, td, hi);
525 if (prev_usage && (prev_usage->hid == usage->hid)) {
526 hid_map_usage(hi, usage, bit, max,
527 EV_ABS, ABS_MT_TOOL_Y);
528 set_abs(hi->input, ABS_MT_TOOL_Y, field,
531 hid_map_usage(hi, usage, bit, max,
532 EV_ABS, ABS_MT_POSITION_Y);
533 set_abs(hi->input, ABS_MT_POSITION_Y, field,
537 mt_store_field(usage, td, hi);
542 case HID_UP_DIGITIZER:
543 switch (usage->hid) {
545 if (cls->quirks & MT_QUIRK_HOVERING) {
546 hid_map_usage(hi, usage, bit, max,
547 EV_ABS, ABS_MT_DISTANCE);
548 input_set_abs_params(hi->input,
549 ABS_MT_DISTANCE, 0, 1, 0, 0);
551 mt_store_field(usage, td, hi);
553 case HID_DG_CONFIDENCE:
554 if ((cls->name == MT_CLS_WIN_8 ||
555 cls->name == MT_CLS_WIN_8_DUAL) &&
556 field->application == HID_DG_TOUCHPAD)
557 cls->quirks |= MT_QUIRK_CONFIDENCE;
558 mt_store_field(usage, td, hi);
560 case HID_DG_TIPSWITCH:
561 hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_TOUCH);
562 input_set_capability(hi->input, EV_KEY, BTN_TOUCH);
563 mt_store_field(usage, td, hi);
565 case HID_DG_CONTACTID:
566 mt_store_field(usage, td, hi);
567 td->touches_by_report++;
568 td->mt_report_id = field->report->id;
571 hid_map_usage(hi, usage, bit, max,
572 EV_ABS, ABS_MT_TOUCH_MAJOR);
573 if (!(cls->quirks & MT_QUIRK_NO_AREA))
574 set_abs(hi->input, ABS_MT_TOUCH_MAJOR, field,
576 mt_store_field(usage, td, hi);
579 hid_map_usage(hi, usage, bit, max,
580 EV_ABS, ABS_MT_TOUCH_MINOR);
581 if (!(cls->quirks & MT_QUIRK_NO_AREA)) {
582 set_abs(hi->input, ABS_MT_TOUCH_MINOR, field,
584 input_set_abs_params(hi->input,
585 ABS_MT_ORIENTATION, 0, 1, 0, 0);
587 mt_store_field(usage, td, hi);
589 case HID_DG_TIPPRESSURE:
590 hid_map_usage(hi, usage, bit, max,
591 EV_ABS, ABS_MT_PRESSURE);
592 set_abs(hi->input, ABS_MT_PRESSURE, field,
594 mt_store_field(usage, td, hi);
596 case HID_DG_SCANTIME:
597 hid_map_usage(hi, usage, bit, max,
598 EV_MSC, MSC_TIMESTAMP);
599 input_set_capability(hi->input, EV_MSC, MSC_TIMESTAMP);
600 mt_store_field(usage, td, hi);
602 case HID_DG_CONTACTCOUNT:
603 /* Ignore if indexes are out of bounds. */
604 if (field->index >= field->report->maxfield ||
605 usage->usage_index >= field->report_count)
607 td->cc_index = field->index;
608 td->cc_value_index = usage->usage_index;
610 case HID_DG_CONTACTMAX:
611 /* we don't set td->last_slot_field as contactcount and
612 * contact max are global to the report */
615 /* Legacy devices use TIPSWITCH and not TOUCH.
616 * Let's just ignore this field. */
619 /* let hid-input decide for the others */
623 code = BTN_MOUSE + ((usage->hid - 1) & HID_USAGE);
625 * MS PTP spec says that external buttons left and right have
628 if ((cls->name == MT_CLS_WIN_8 ||
629 cls->name == MT_CLS_WIN_8_DUAL) &&
630 field->application == HID_DG_TOUCHPAD &&
631 (usage->hid & HID_USAGE) > 1)
633 hid_map_usage(hi, usage, bit, max, EV_KEY, code);
634 input_set_capability(hi->input, EV_KEY, code);
638 /* we do not want to map these: no input-oriented meaning */
645 static int mt_compute_slot(struct mt_device *td, struct input_dev *input)
647 __s32 quirks = td->mtclass.quirks;
649 if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
650 return td->curdata.contactid;
652 if (quirks & MT_QUIRK_CYPRESS)
653 return cypress_compute_slot(td);
655 if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
656 return td->num_received;
658 if (quirks & MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE)
659 return td->curdata.contactid - 1;
661 return input_mt_get_slot_by_key(input, td->curdata.contactid);
665 * this function is called when a whole contact has been processed,
666 * so that it can assign it to a slot and store the data there
668 static void mt_complete_slot(struct mt_device *td, struct input_dev *input)
670 if ((td->mtclass.quirks & MT_QUIRK_CONTACT_CNT_ACCURATE) &&
671 td->num_received >= td->num_expected)
674 if (td->curvalid || (td->mtclass.quirks & MT_QUIRK_ALWAYS_VALID)) {
676 int slotnum = mt_compute_slot(td, input);
677 struct mt_slot *s = &td->curdata;
678 struct input_mt *mt = input->mt;
680 if (slotnum < 0 || slotnum >= td->maxcontacts)
683 if ((td->mtclass.quirks & MT_QUIRK_IGNORE_DUPLICATES) && mt) {
684 struct input_mt_slot *slot = &mt->slots[slotnum];
685 if (input_mt_is_active(slot) &&
686 input_mt_is_used(mt, slot))
690 if (!(td->mtclass.quirks & MT_QUIRK_CONFIDENCE))
691 s->confidence_state = 1;
692 active = (s->touch_state || s->inrange_state) &&
695 input_mt_slot(input, slotnum);
696 input_mt_report_slot_state(input, MT_TOOL_FINGER, active);
698 /* this finger is in proximity of the sensor */
699 int wide = (s->w > s->h);
700 int major = max(s->w, s->h);
701 int minor = min(s->w, s->h);
704 * divided by two to match visual scale of touch
705 * for devices with this quirk
707 if (td->mtclass.quirks & MT_QUIRK_TOUCH_SIZE_SCALING) {
712 input_event(input, EV_ABS, ABS_MT_POSITION_X, s->x);
713 input_event(input, EV_ABS, ABS_MT_POSITION_Y, s->y);
714 input_event(input, EV_ABS, ABS_MT_TOOL_X, s->cx);
715 input_event(input, EV_ABS, ABS_MT_TOOL_Y, s->cy);
716 input_event(input, EV_ABS, ABS_MT_DISTANCE,
718 input_event(input, EV_ABS, ABS_MT_ORIENTATION, wide);
719 input_event(input, EV_ABS, ABS_MT_PRESSURE, s->p);
720 input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
721 input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
723 set_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags);
731 * this function is called when a whole packet has been received and processed,
732 * so that it can decide what to send to the input layer.
734 static void mt_sync_frame(struct mt_device *td, struct input_dev *input)
736 input_mt_sync_frame(input);
737 input_event(input, EV_MSC, MSC_TIMESTAMP, td->timestamp);
739 td->num_received = 0;
740 if (test_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags))
741 set_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags);
743 clear_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags);
744 clear_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags);
747 static int mt_compute_timestamp(struct mt_device *td, struct hid_field *field,
750 long delta = value - td->dev_time;
751 unsigned long jdelta = jiffies_to_usecs(jiffies - td->jiffies);
753 td->jiffies = jiffies;
754 td->dev_time = value;
757 delta += field->logical_maximum;
759 /* HID_DG_SCANTIME is expressed in 100us, we want it in us. */
762 if (jdelta > MAX_TIMESTAMP_INTERVAL)
763 /* No data received for a while, resync the timestamp. */
766 return td->timestamp + delta;
769 static int mt_touch_event(struct hid_device *hid, struct hid_field *field,
770 struct hid_usage *usage, __s32 value)
772 /* we will handle the hidinput part later, now remains hiddev */
773 if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
774 hid->hiddev_hid_event(hid, field, usage, value);
779 static void mt_process_mt_event(struct hid_device *hid, struct hid_field *field,
780 struct hid_usage *usage, __s32 value)
782 struct mt_device *td = hid_get_drvdata(hid);
783 __s32 quirks = td->mtclass.quirks;
784 struct input_dev *input = field->hidinput->input;
786 if (hid->claimed & HID_CLAIMED_INPUT) {
787 switch (usage->hid) {
789 if (quirks & MT_QUIRK_VALID_IS_INRANGE)
790 td->curvalid = value;
791 if (quirks & MT_QUIRK_HOVERING)
792 td->curdata.inrange_state = value;
794 case HID_DG_TIPSWITCH:
795 if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
796 td->curvalid = value;
797 td->curdata.touch_state = value;
799 case HID_DG_CONFIDENCE:
800 if (quirks & MT_QUIRK_CONFIDENCE)
801 td->curdata.confidence_state = value;
802 if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
803 td->curvalid = value;
805 case HID_DG_CONTACTID:
806 td->curdata.contactid = value;
808 case HID_DG_TIPPRESSURE:
809 td->curdata.p = value;
812 if (usage->code == ABS_MT_TOOL_X)
813 td->curdata.cx = value;
815 td->curdata.x = value;
818 if (usage->code == ABS_MT_TOOL_Y)
819 td->curdata.cy = value;
821 td->curdata.y = value;
824 td->curdata.w = value;
827 td->curdata.h = value;
829 case HID_DG_SCANTIME:
830 td->timestamp = mt_compute_timestamp(td, field, value);
832 case HID_DG_CONTACTCOUNT:
840 input_event(input, usage->type, usage->code,
845 if (usage->usage_index + 1 == field->report_count) {
846 /* we only take into account the last report. */
847 if (usage->hid == td->last_slot_field)
848 mt_complete_slot(td, field->hidinput->input);
854 static void mt_touch_report(struct hid_device *hid, struct hid_report *report)
856 struct mt_device *td = hid_get_drvdata(hid);
857 struct hid_field *field;
861 /* sticky fingers release in progress, abort */
862 if (test_and_set_bit(MT_IO_FLAGS_RUNNING, &td->mt_io_flags))
866 * Includes multi-packet support where subsequent
867 * packets are sent with zero contactcount.
869 if (td->cc_index >= 0) {
870 struct hid_field *field = report->field[td->cc_index];
871 int value = field->value[td->cc_value_index];
873 td->num_expected = value;
876 for (r = 0; r < report->maxfield; r++) {
877 field = report->field[r];
878 count = field->report_count;
880 if (!(HID_MAIN_ITEM_VARIABLE & field->flags))
883 for (n = 0; n < count; n++)
884 mt_process_mt_event(hid, field, &field->usage[n],
888 if (td->num_received >= td->num_expected)
889 mt_sync_frame(td, report->field[0]->hidinput->input);
892 * Windows 8 specs says 2 things:
893 * - once a contact has been reported, it has to be reported in each
895 * - the report rate when fingers are present has to be at least
896 * the refresh rate of the screen, 60 or 120 Hz
898 * I interprete this that the specification forces a report rate of
899 * at least 60 Hz for a touchscreen to be certified.
900 * Which means that if we do not get a report whithin 16 ms, either
901 * something wrong happens, either the touchscreen forgets to send
902 * a release. Taking a reasonable margin allows to remove issues
903 * with USB communication or the load of the machine.
905 * Given that Win 8 devices are forced to send a release, this will
906 * only affect laggish machines and the ones that have a firmware
909 if (td->mtclass.quirks & MT_QUIRK_STICKY_FINGERS) {
910 if (test_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags))
911 mod_timer(&td->release_timer,
912 jiffies + msecs_to_jiffies(100));
914 del_timer(&td->release_timer);
917 clear_bit(MT_IO_FLAGS_RUNNING, &td->mt_io_flags);
920 static int mt_touch_input_configured(struct hid_device *hdev,
921 struct hid_input *hi)
923 struct mt_device *td = hid_get_drvdata(hdev);
924 struct mt_class *cls = &td->mtclass;
925 struct input_dev *input = hi->input;
928 if (!td->maxcontacts)
929 td->maxcontacts = MT_DEFAULT_MAXCONTACT;
932 if (td->serial_maybe)
933 mt_post_parse_default_settings(td);
935 if (cls->is_indirect)
936 td->mt_flags |= INPUT_MT_POINTER;
938 if (cls->quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
939 td->mt_flags |= INPUT_MT_DROP_UNUSED;
941 /* check for clickpads */
942 if ((td->mt_flags & INPUT_MT_POINTER) && (td->buttons_count == 1))
943 td->is_buttonpad = true;
945 if (td->is_buttonpad)
946 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
948 ret = input_mt_init_slots(input, td->maxcontacts, td->mt_flags);
956 #define mt_map_key_clear(c) hid_map_usage_clear(hi, usage, bit, \
958 static int mt_input_mapping(struct hid_device *hdev, struct hid_input *hi,
959 struct hid_field *field, struct hid_usage *usage,
960 unsigned long **bit, int *max)
962 struct mt_device *td = hid_get_drvdata(hdev);
965 * If mtclass.export_all_inputs is not set, only map fields from
966 * TouchScreen or TouchPad collections. We need to ignore fields
967 * that belong to other collections such as Mouse that might have
968 * the same GenericDesktop usages.
970 if (!td->mtclass.export_all_inputs &&
971 field->application != HID_DG_TOUCHSCREEN &&
972 field->application != HID_DG_PEN &&
973 field->application != HID_DG_TOUCHPAD &&
974 field->application != HID_GD_KEYBOARD &&
975 field->application != HID_GD_SYSTEM_CONTROL &&
976 field->application != HID_CP_CONSUMER_CONTROL &&
977 field->application != HID_GD_WIRELESS_RADIO_CTLS &&
978 !(field->application == HID_VD_ASUS_CUSTOM_MEDIA_KEYS &&
979 td->mtclass.quirks & MT_QUIRK_ASUS_CUSTOM_UP))
983 * Some Asus keyboard+touchpad devices have the hotkeys defined in the
984 * touchpad report descriptor. We need to treat these as an array to
985 * map usages to input keys.
987 if (field->application == HID_VD_ASUS_CUSTOM_MEDIA_KEYS &&
988 td->mtclass.quirks & MT_QUIRK_ASUS_CUSTOM_UP &&
989 (usage->hid & HID_USAGE_PAGE) == HID_UP_CUSTOM) {
990 set_bit(EV_REP, hi->input->evbit);
991 if (field->flags & HID_MAIN_ITEM_VARIABLE)
992 field->flags &= ~HID_MAIN_ITEM_VARIABLE;
993 switch (usage->hid & HID_USAGE) {
994 case 0x10: mt_map_key_clear(KEY_BRIGHTNESSDOWN); break;
995 case 0x20: mt_map_key_clear(KEY_BRIGHTNESSUP); break;
996 case 0x35: mt_map_key_clear(KEY_DISPLAY_OFF); break;
997 case 0x6b: mt_map_key_clear(KEY_F21); break;
998 case 0x6c: mt_map_key_clear(KEY_SLEEP); break;
1006 * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
1008 * The check for mt_report_id ensures we don't process
1009 * HID_DG_CONTACTCOUNT from the pen report as it is outside the physical
1010 * collection, but within the report ID.
1012 if (field->physical == HID_DG_STYLUS)
1014 else if ((field->physical == 0) &&
1015 (field->report->id != td->mt_report_id) &&
1016 (td->mt_report_id != -1))
1019 if (field->application == HID_DG_TOUCHSCREEN ||
1020 field->application == HID_DG_TOUCHPAD)
1021 return mt_touch_input_mapping(hdev, hi, field, usage, bit, max);
1023 /* let hid-core decide for the others */
1027 static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
1028 struct hid_field *field, struct hid_usage *usage,
1029 unsigned long **bit, int *max)
1032 * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
1035 if (field->physical == HID_DG_STYLUS)
1038 if (field->application == HID_DG_TOUCHSCREEN ||
1039 field->application == HID_DG_TOUCHPAD) {
1040 /* We own these mappings, tell hid-input to ignore them */
1044 /* let hid-core decide for the others */
1048 static int mt_event(struct hid_device *hid, struct hid_field *field,
1049 struct hid_usage *usage, __s32 value)
1051 struct mt_device *td = hid_get_drvdata(hid);
1053 if (field->report->id == td->mt_report_id)
1054 return mt_touch_event(hid, field, usage, value);
1059 static void mt_report(struct hid_device *hid, struct hid_report *report)
1061 struct mt_device *td = hid_get_drvdata(hid);
1062 struct hid_field *field = report->field[0];
1064 if (!(hid->claimed & HID_CLAIMED_INPUT))
1067 if (report->id == td->mt_report_id)
1068 return mt_touch_report(hid, report);
1070 if (field && field->hidinput && field->hidinput->input)
1071 input_sync(field->hidinput->input);
1074 static void mt_set_input_mode(struct hid_device *hdev)
1076 struct mt_device *td = hid_get_drvdata(hdev);
1077 struct hid_report *r;
1078 struct hid_report_enum *re;
1079 struct mt_class *cls = &td->mtclass;
1083 if (td->inputmode < 0)
1086 re = &(hdev->report_enum[HID_FEATURE_REPORT]);
1087 r = re->report_id_hash[td->inputmode];
1089 if (cls->quirks & MT_QUIRK_FORCE_GET_FEATURE) {
1090 report_len = hid_report_len(r);
1091 buf = hid_alloc_report_buf(r, GFP_KERNEL);
1093 hid_err(hdev, "failed to allocate buffer for report\n");
1096 hid_hw_raw_request(hdev, r->id, buf, report_len,
1098 HID_REQ_GET_REPORT);
1101 r->field[0]->value[td->inputmode_index] = td->inputmode_value;
1102 hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
1106 static void mt_set_maxcontacts(struct hid_device *hdev)
1108 struct mt_device *td = hid_get_drvdata(hdev);
1109 struct hid_report *r;
1110 struct hid_report_enum *re;
1113 if (td->maxcontact_report_id < 0)
1116 if (!td->mtclass.maxcontacts)
1119 re = &hdev->report_enum[HID_FEATURE_REPORT];
1120 r = re->report_id_hash[td->maxcontact_report_id];
1122 max = td->mtclass.maxcontacts;
1123 fieldmax = r->field[0]->logical_maximum;
1124 max = min(fieldmax, max);
1125 if (r->field[0]->value[0] != max) {
1126 r->field[0]->value[0] = max;
1127 hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
1132 static void mt_post_parse_default_settings(struct mt_device *td)
1134 __s32 quirks = td->mtclass.quirks;
1136 /* unknown serial device needs special quirks */
1137 if (td->touches_by_report == 1) {
1138 quirks |= MT_QUIRK_ALWAYS_VALID;
1139 quirks &= ~MT_QUIRK_NOT_SEEN_MEANS_UP;
1140 quirks &= ~MT_QUIRK_VALID_IS_INRANGE;
1141 quirks &= ~MT_QUIRK_VALID_IS_CONFIDENCE;
1142 quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
1145 td->mtclass.quirks = quirks;
1148 static void mt_post_parse(struct mt_device *td)
1150 struct mt_fields *f = td->fields;
1151 struct mt_class *cls = &td->mtclass;
1153 if (td->touches_by_report > 0) {
1154 int field_count_per_touch = f->length / td->touches_by_report;
1155 td->last_slot_field = f->usages[field_count_per_touch - 1];
1158 if (td->cc_index < 0)
1159 cls->quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
1162 static int mt_input_configured(struct hid_device *hdev, struct hid_input *hi)
1164 struct mt_device *td = hid_get_drvdata(hdev);
1166 const char *suffix = NULL;
1167 struct hid_field *field = hi->report->field[0];
1170 if (hi->report->id == td->mt_report_id) {
1171 ret = mt_touch_input_configured(hdev, hi);
1177 * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
1178 * for the stylus. Check this first, and then rely on the application
1181 if (hi->report->field[0]->physical == HID_DG_STYLUS) {
1183 /* force BTN_STYLUS to allow tablet matching in udev */
1184 __set_bit(BTN_STYLUS, hi->input->keybit);
1186 switch (field->application) {
1187 case HID_GD_KEYBOARD:
1188 suffix = "Keyboard";
1198 /* force BTN_STYLUS to allow tablet matching in udev */
1199 __set_bit(BTN_STYLUS, hi->input->keybit);
1201 case HID_DG_TOUCHSCREEN:
1202 /* we do not set suffix = "Touchscreen" */
1204 case HID_DG_TOUCHPAD:
1205 suffix = "Touchpad";
1207 case HID_GD_SYSTEM_CONTROL:
1208 suffix = "System Control";
1210 case HID_CP_CONSUMER_CONTROL:
1211 suffix = "Consumer Control";
1213 case HID_GD_WIRELESS_RADIO_CTLS:
1214 suffix = "Wireless Radio Control";
1216 case HID_VD_ASUS_CUSTOM_MEDIA_KEYS:
1217 suffix = "Custom Media Keys";
1226 name = devm_kzalloc(&hi->input->dev,
1227 strlen(hdev->name) + strlen(suffix) + 2,
1230 sprintf(name, "%s %s", hdev->name, suffix);
1231 hi->input->name = name;
1238 static void mt_fix_const_field(struct hid_field *field, unsigned int usage)
1240 if (field->usage[0].hid != usage ||
1241 !(field->flags & HID_MAIN_ITEM_CONSTANT))
1244 field->flags &= ~HID_MAIN_ITEM_CONSTANT;
1245 field->flags |= HID_MAIN_ITEM_VARIABLE;
1248 static void mt_fix_const_fields(struct hid_device *hdev, unsigned int usage)
1250 struct hid_report *report;
1253 list_for_each_entry(report,
1254 &hdev->report_enum[HID_INPUT_REPORT].report_list,
1257 if (!report->maxfield)
1260 for (i = 0; i < report->maxfield; i++)
1261 if (report->field[i]->maxusage >= 1)
1262 mt_fix_const_field(report->field[i], usage);
1266 static void mt_release_contacts(struct hid_device *hid)
1268 struct hid_input *hidinput;
1269 struct mt_device *td = hid_get_drvdata(hid);
1271 list_for_each_entry(hidinput, &hid->inputs, list) {
1272 struct input_dev *input_dev = hidinput->input;
1273 struct input_mt *mt = input_dev->mt;
1277 for (i = 0; i < mt->num_slots; i++) {
1278 input_mt_slot(input_dev, i);
1279 input_mt_report_slot_state(input_dev,
1283 input_mt_sync_frame(input_dev);
1284 input_sync(input_dev);
1288 td->num_received = 0;
1291 static void mt_expired_timeout(unsigned long arg)
1293 struct hid_device *hdev = (void *)arg;
1294 struct mt_device *td = hid_get_drvdata(hdev);
1297 * An input report came in just before we release the sticky fingers,
1298 * it will take care of the sticky fingers.
1300 if (test_and_set_bit(MT_IO_FLAGS_RUNNING, &td->mt_io_flags))
1302 if (test_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags))
1303 mt_release_contacts(hdev);
1304 clear_bit(MT_IO_FLAGS_RUNNING, &td->mt_io_flags);
1307 static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
1310 struct mt_device *td;
1311 struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */
1313 for (i = 0; mt_classes[i].name ; i++) {
1314 if (id->driver_data == mt_classes[i].name) {
1315 mtclass = &(mt_classes[i]);
1320 td = devm_kzalloc(&hdev->dev, sizeof(struct mt_device), GFP_KERNEL);
1322 dev_err(&hdev->dev, "cannot allocate multitouch data\n");
1325 td->mtclass = *mtclass;
1327 td->maxcontact_report_id = -1;
1328 td->inputmode_value = MT_INPUTMODE_TOUCHSCREEN;
1330 td->mt_report_id = -1;
1331 hid_set_drvdata(hdev, td);
1333 td->fields = devm_kzalloc(&hdev->dev, sizeof(struct mt_fields),
1336 dev_err(&hdev->dev, "cannot allocate multitouch fields data\n");
1340 if (id->vendor == HID_ANY_ID && id->product == HID_ANY_ID)
1341 td->serial_maybe = true;
1344 * Store the initial quirk state
1346 td->initial_quirks = hdev->quirks;
1348 /* This allows the driver to correctly support devices
1349 * that emit events over several HID messages.
1351 hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
1354 * This allows the driver to handle different input sensors
1355 * that emits events through different reports on the same HID
1358 hdev->quirks |= HID_QUIRK_MULTI_INPUT;
1359 hdev->quirks |= HID_QUIRK_NO_EMPTY_INPUT;
1362 * Some multitouch screens do not like to be polled for input
1363 * reports. Fortunately, the Win8 spec says that all touches
1364 * should be sent during each report, making the initialization
1365 * of input reports unnecessary. For Win7 devices, well, let's hope
1366 * they will still be happy (this is only be a problem if a touch
1367 * was already there while probing the device).
1369 * In addition some touchpads do not behave well if we read
1370 * all feature reports from them. Instead we prevent
1371 * initial report fetching and then selectively fetch each
1372 * report we are interested in.
1374 hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
1376 setup_timer(&td->release_timer, mt_expired_timeout, (long)hdev);
1378 ret = hid_parse(hdev);
1382 if (mtclass->quirks & MT_QUIRK_FIX_CONST_CONTACT_ID)
1383 mt_fix_const_fields(hdev, HID_DG_CONTACTID);
1385 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
1389 ret = sysfs_create_group(&hdev->dev.kobj, &mt_attribute_group);
1391 dev_warn(&hdev->dev, "Cannot allocate sysfs group for %s\n",
1394 mt_set_maxcontacts(hdev);
1395 mt_set_input_mode(hdev);
1397 /* release .fields memory as it is not used anymore */
1398 devm_kfree(&hdev->dev, td->fields);
1405 static int mt_reset_resume(struct hid_device *hdev)
1407 mt_release_contacts(hdev);
1408 mt_set_maxcontacts(hdev);
1409 mt_set_input_mode(hdev);
1413 static int mt_resume(struct hid_device *hdev)
1415 /* Some Elan legacy devices require SET_IDLE to be set on resume.
1416 * It should be safe to send it to other devices too.
1417 * Tested on 3M, Stantum, Cypress, Zytronic, eGalax, and Elan panels. */
1419 hid_hw_idle(hdev, 0, 0, HID_REQ_SET_IDLE);
1425 static void mt_remove(struct hid_device *hdev)
1427 struct mt_device *td = hid_get_drvdata(hdev);
1429 del_timer_sync(&td->release_timer);
1431 sysfs_remove_group(&hdev->dev.kobj, &mt_attribute_group);
1433 hdev->quirks = td->initial_quirks;
1437 * This list contains only:
1438 * - VID/PID of products not working with the default multitouch handling
1439 * - 2 generic rules.
1440 * So there is no point in adding here any device with MT_CLS_DEFAULT.
1442 static const struct hid_device_id mt_devices[] = {
1445 { .driver_data = MT_CLS_3M,
1446 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1447 USB_DEVICE_ID_3M1968) },
1448 { .driver_data = MT_CLS_3M,
1449 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1450 USB_DEVICE_ID_3M2256) },
1451 { .driver_data = MT_CLS_3M,
1452 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1453 USB_DEVICE_ID_3M3266) },
1456 { .driver_data = MT_CLS_WIN_8_DUAL,
1457 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1458 USB_VENDOR_ID_ALPS_JP,
1459 HID_DEVICE_ID_ALPS_U1_DUAL_PTP) },
1460 { .driver_data = MT_CLS_WIN_8_DUAL,
1461 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1462 USB_VENDOR_ID_ALPS_JP,
1463 HID_DEVICE_ID_ALPS_U1_DUAL_3BTN_PTP) },
1465 /* Lenovo X1 TAB Gen 2 */
1466 { .driver_data = MT_CLS_WIN_8_DUAL,
1467 HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1468 USB_VENDOR_ID_LENOVO,
1469 USB_DEVICE_ID_LENOVO_X1_TAB) },
1472 { .driver_data = MT_CLS_EXPORT_ALL_INPUTS,
1473 MT_USB_DEVICE(USB_VENDOR_ID_ANTON,
1474 USB_DEVICE_ID_ANTON_TOUCH_PAD) },
1477 { .driver_data = MT_CLS_ASUS,
1478 HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1479 USB_VENDOR_ID_ASUSTEK,
1480 USB_DEVICE_ID_ASUSTEK_T304_KEYBOARD) },
1483 { .driver_data = MT_CLS_SERIAL,
1484 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL,
1485 USB_DEVICE_ID_ATMEL_MXT_DIGITIZER) },
1487 /* Baanto multitouch devices */
1488 { .driver_data = MT_CLS_NSMU,
1489 MT_USB_DEVICE(USB_VENDOR_ID_BAANTO,
1490 USB_DEVICE_ID_BAANTO_MT_190W2) },
1493 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1494 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1495 USB_DEVICE_ID_CANDO_MULTI_TOUCH) },
1496 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1497 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1498 USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6) },
1500 /* Chunghwa Telecom touch panels */
1501 { .driver_data = MT_CLS_NSMU,
1502 MT_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT,
1503 USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH) },
1505 /* CJTouch panels */
1506 { .driver_data = MT_CLS_NSMU,
1507 MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1508 USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0020) },
1509 { .driver_data = MT_CLS_NSMU,
1510 MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1511 USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0040) },
1513 /* CVTouch panels */
1514 { .driver_data = MT_CLS_NSMU,
1515 MT_USB_DEVICE(USB_VENDOR_ID_CVTOUCH,
1516 USB_DEVICE_ID_CVTOUCH_SCREEN) },
1518 /* eGalax devices (resistive) */
1519 { .driver_data = MT_CLS_EGALAX,
1520 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1521 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D) },
1522 { .driver_data = MT_CLS_EGALAX,
1523 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1524 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E) },
1526 /* eGalax devices (capacitive) */
1527 { .driver_data = MT_CLS_EGALAX_SERIAL,
1528 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1529 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7207) },
1530 { .driver_data = MT_CLS_EGALAX,
1531 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1532 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C) },
1533 { .driver_data = MT_CLS_EGALAX_SERIAL,
1534 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1535 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224) },
1536 { .driver_data = MT_CLS_EGALAX_SERIAL,
1537 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1538 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_722A) },
1539 { .driver_data = MT_CLS_EGALAX_SERIAL,
1540 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1541 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_725E) },
1542 { .driver_data = MT_CLS_EGALAX_SERIAL,
1543 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1544 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7262) },
1545 { .driver_data = MT_CLS_EGALAX,
1546 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1547 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B) },
1548 { .driver_data = MT_CLS_EGALAX,
1549 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1550 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1) },
1551 { .driver_data = MT_CLS_EGALAX_SERIAL,
1552 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1553 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72AA) },
1554 { .driver_data = MT_CLS_EGALAX,
1555 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1556 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72C4) },
1557 { .driver_data = MT_CLS_EGALAX,
1558 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1559 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72D0) },
1560 { .driver_data = MT_CLS_EGALAX,
1561 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1562 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA) },
1563 { .driver_data = MT_CLS_EGALAX,
1564 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1565 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302) },
1566 { .driver_data = MT_CLS_EGALAX_SERIAL,
1567 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1568 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7349) },
1569 { .driver_data = MT_CLS_EGALAX_SERIAL,
1570 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1571 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_73F7) },
1572 { .driver_data = MT_CLS_EGALAX_SERIAL,
1573 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1574 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001) },
1576 /* Elitegroup panel */
1577 { .driver_data = MT_CLS_SERIAL,
1578 MT_USB_DEVICE(USB_VENDOR_ID_ELITEGROUP,
1579 USB_DEVICE_ID_ELITEGROUP_05D8) },
1581 /* Flatfrog Panels */
1582 { .driver_data = MT_CLS_FLATFROG,
1583 MT_USB_DEVICE(USB_VENDOR_ID_FLATFROG,
1584 USB_DEVICE_ID_MULTITOUCH_3200) },
1586 /* FocalTech Panels */
1587 { .driver_data = MT_CLS_SERIAL,
1588 MT_USB_DEVICE(USB_VENDOR_ID_CYGNAL,
1589 USB_DEVICE_ID_FOCALTECH_FTXXXX_MULTITOUCH) },
1591 /* GeneralTouch panel */
1592 { .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1593 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1594 USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
1595 { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1596 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1597 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PWT_TENFINGERS) },
1598 { .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1599 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1600 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0101) },
1601 { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1602 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1603 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0102) },
1604 { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1605 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1606 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0106) },
1607 { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1608 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1609 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_010A) },
1610 { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1611 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1612 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_E100) },
1614 /* Gametel game controller */
1615 { .driver_data = MT_CLS_NSMU,
1616 MT_BT_DEVICE(USB_VENDOR_ID_FRUCTEL,
1617 USB_DEVICE_ID_GAMETEL_MT_MODE) },
1619 /* GoodTouch panels */
1620 { .driver_data = MT_CLS_NSMU,
1621 MT_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH,
1622 USB_DEVICE_ID_GOODTOUCH_000f) },
1625 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1626 MT_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT,
1627 USB_DEVICE_ID_HANVON_ALT_MULTITOUCH) },
1629 /* Ilitek dual touch panel */
1630 { .driver_data = MT_CLS_NSMU,
1631 MT_USB_DEVICE(USB_VENDOR_ID_ILITEK,
1632 USB_DEVICE_ID_ILITEK_MULTITOUCH) },
1634 /* LG Melfas panel */
1635 { .driver_data = MT_CLS_LG,
1636 HID_USB_DEVICE(USB_VENDOR_ID_LG,
1637 USB_DEVICE_ID_LG_MELFAS_MT) },
1640 { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1641 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
1642 USB_DEVICE_ID_ASUS_T91MT)},
1643 { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1644 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
1645 USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO) },
1646 { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1647 MT_USB_DEVICE(USB_VENDOR_ID_TURBOX,
1648 USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART) },
1650 /* Panasonic panels */
1651 { .driver_data = MT_CLS_PANASONIC,
1652 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
1653 USB_DEVICE_ID_PANABOARD_UBT780) },
1654 { .driver_data = MT_CLS_PANASONIC,
1655 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
1656 USB_DEVICE_ID_PANABOARD_UBT880) },
1659 { .driver_data = MT_CLS_NSMU,
1660 MT_USB_DEVICE(USB_VENDOR_ID_NOVATEK,
1661 USB_DEVICE_ID_NOVATEK_PCT) },
1664 { .driver_data = MT_CLS_NSMU,
1665 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1666 USB_VENDOR_ID_NTRIG, 0x1b05) },
1668 /* PixArt optical touch screen */
1669 { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1670 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1671 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN) },
1672 { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1673 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1674 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1) },
1675 { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1676 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1677 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2) },
1679 /* PixCir-based panels */
1680 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1681 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1682 USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
1684 /* Quanta-based panels */
1685 { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
1686 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
1687 USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001) },
1689 /* Stantum panels */
1690 { .driver_data = MT_CLS_CONFIDENCE,
1691 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM,
1692 USB_DEVICE_ID_MTP_STM)},
1694 /* TopSeed panels */
1695 { .driver_data = MT_CLS_TOPSEED,
1696 MT_USB_DEVICE(USB_VENDOR_ID_TOPSEED2,
1697 USB_DEVICE_ID_TOPSEED2_PERIPAD_701) },
1699 /* Touch International panels */
1700 { .driver_data = MT_CLS_NSMU,
1701 MT_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL,
1702 USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH) },
1705 { .driver_data = MT_CLS_NSMU,
1706 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
1707 USB_DEVICE_ID_UNITEC_USB_TOUCH_0709) },
1708 { .driver_data = MT_CLS_NSMU,
1709 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
1710 USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19) },
1713 { .driver_data = MT_CLS_VTL,
1714 MT_USB_DEVICE(USB_VENDOR_ID_VTL,
1715 USB_DEVICE_ID_VTL_MULTITOUCH_FF3F) },
1717 /* Wistron panels */
1718 { .driver_data = MT_CLS_NSMU,
1719 MT_USB_DEVICE(USB_VENDOR_ID_WISTRON,
1720 USB_DEVICE_ID_WISTRON_OPTICAL_TOUCH) },
1723 { .driver_data = MT_CLS_NSMU,
1724 MT_USB_DEVICE(USB_VENDOR_ID_XAT,
1725 USB_DEVICE_ID_XAT_CSR) },
1728 { .driver_data = MT_CLS_NSMU,
1729 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1730 USB_DEVICE_ID_XIROKU_SPX) },
1731 { .driver_data = MT_CLS_NSMU,
1732 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1733 USB_DEVICE_ID_XIROKU_MPX) },
1734 { .driver_data = MT_CLS_NSMU,
1735 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1736 USB_DEVICE_ID_XIROKU_CSR) },
1737 { .driver_data = MT_CLS_NSMU,
1738 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1739 USB_DEVICE_ID_XIROKU_SPX1) },
1740 { .driver_data = MT_CLS_NSMU,
1741 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1742 USB_DEVICE_ID_XIROKU_MPX1) },
1743 { .driver_data = MT_CLS_NSMU,
1744 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1745 USB_DEVICE_ID_XIROKU_CSR1) },
1746 { .driver_data = MT_CLS_NSMU,
1747 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1748 USB_DEVICE_ID_XIROKU_SPX2) },
1749 { .driver_data = MT_CLS_NSMU,
1750 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1751 USB_DEVICE_ID_XIROKU_MPX2) },
1752 { .driver_data = MT_CLS_NSMU,
1753 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1754 USB_DEVICE_ID_XIROKU_CSR2) },
1756 /* Google MT devices */
1757 { .driver_data = MT_CLS_GOOGLE,
1758 HID_DEVICE(HID_BUS_ANY, HID_GROUP_ANY, USB_VENDOR_ID_GOOGLE,
1759 USB_DEVICE_ID_GOOGLE_TOUCH_ROSE) },
1761 /* Generic MT device */
1762 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH, HID_ANY_ID, HID_ANY_ID) },
1764 /* Generic Win 8 certified MT device */
1765 { .driver_data = MT_CLS_WIN_8,
1766 HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH_WIN_8,
1767 HID_ANY_ID, HID_ANY_ID) },
1770 MODULE_DEVICE_TABLE(hid, mt_devices);
1772 static const struct hid_usage_id mt_grabbed_usages[] = {
1773 { HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
1774 { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
1777 static struct hid_driver mt_driver = {
1778 .name = "hid-multitouch",
1779 .id_table = mt_devices,
1781 .remove = mt_remove,
1782 .input_mapping = mt_input_mapping,
1783 .input_mapped = mt_input_mapped,
1784 .input_configured = mt_input_configured,
1785 .feature_mapping = mt_feature_mapping,
1786 .usage_table = mt_grabbed_usages,
1788 .report = mt_report,
1790 .reset_resume = mt_reset_resume,
1791 .resume = mt_resume,
1794 module_hid_driver(mt_driver);