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/string.h>
47 #include <linux/timer.h>
50 MODULE_AUTHOR("Stephane Chatty <chatty@enac.fr>");
51 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
52 MODULE_DESCRIPTION("HID multitouch panels");
53 MODULE_LICENSE("GPL");
57 /* quirks to control the device */
58 #define MT_QUIRK_NOT_SEEN_MEANS_UP BIT(0)
59 #define MT_QUIRK_SLOT_IS_CONTACTID BIT(1)
60 #define MT_QUIRK_CYPRESS BIT(2)
61 #define MT_QUIRK_SLOT_IS_CONTACTNUMBER BIT(3)
62 #define MT_QUIRK_ALWAYS_VALID BIT(4)
63 #define MT_QUIRK_VALID_IS_INRANGE BIT(5)
64 #define MT_QUIRK_VALID_IS_CONFIDENCE BIT(6)
65 #define MT_QUIRK_CONFIDENCE BIT(7)
66 #define MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE BIT(8)
67 #define MT_QUIRK_NO_AREA BIT(9)
68 #define MT_QUIRK_IGNORE_DUPLICATES BIT(10)
69 #define MT_QUIRK_HOVERING BIT(11)
70 #define MT_QUIRK_CONTACT_CNT_ACCURATE BIT(12)
71 #define MT_QUIRK_FORCE_GET_FEATURE BIT(13)
72 #define MT_QUIRK_FIX_CONST_CONTACT_ID BIT(14)
73 #define MT_QUIRK_TOUCH_SIZE_SCALING BIT(15)
74 #define MT_QUIRK_STICKY_FINGERS BIT(16)
76 #define MT_INPUTMODE_TOUCHSCREEN 0x02
77 #define MT_INPUTMODE_TOUCHPAD 0x03
79 #define MT_BUTTONTYPE_CLICKPAD 0
81 #define MT_IO_FLAGS_RUNNING 0
82 #define MT_IO_FLAGS_ACTIVE_SLOTS 1
83 #define MT_IO_FLAGS_PENDING_SLOTS 2
86 __s32 x
, y
, cx
, cy
, p
, w
, h
;
87 __s32 contactid
; /* the device ContactID assigned to this slot */
88 bool touch_state
; /* is the touch valid? */
89 bool inrange_state
; /* is the finger in proximity of the sensor? */
90 bool confidence_state
; /* is the touch made by a finger? */
94 __s32 name
; /* MT_CLS */
96 __s32 sn_move
; /* Signal/noise ratio for move events */
97 __s32 sn_width
; /* Signal/noise ratio for width events */
98 __s32 sn_height
; /* Signal/noise ratio for height events */
99 __s32 sn_pressure
; /* Signal/noise ratio for pressure events */
101 bool is_indirect
; /* true for touchpads */
102 bool export_all_inputs
; /* do not ignore mouse, keyboards, etc... */
106 unsigned usages
[HID_MAX_FIELDS
];
111 struct mt_slot curdata
; /* placeholder of incoming data */
112 struct mt_class mtclass
; /* our mt device class */
113 struct timer_list release_timer
; /* to release sticky fingers */
114 struct mt_fields
*fields
; /* temporary placeholder for storing the
116 unsigned long mt_io_flags
; /* mt flags (MT_IO_FLAGS_*) */
117 int cc_index
; /* contact count field index in the report */
118 int cc_value_index
; /* contact count value index in the field */
119 unsigned last_slot_field
; /* the last field of a slot */
120 unsigned mt_report_id
; /* the report ID of the multitouch device */
121 unsigned long initial_quirks
; /* initial quirks state */
122 __s16 inputmode
; /* InputMode HID feature, -1 if non-existent */
123 __s16 inputmode_index
; /* InputMode HID feature index in the report */
124 __s16 maxcontact_report_id
; /* Maximum Contact Number HID feature,
125 -1 if non-existent */
126 __u8 inputmode_value
; /* InputMode HID feature value */
127 __u8 num_received
; /* how many contacts we received */
128 __u8 num_expected
; /* expected last contact index */
130 __u8 touches_by_report
; /* how many touches are present in one report:
131 * 1 means we should use a serial protocol
132 * > 1 means hybrid (multitouch) protocol */
133 __u8 buttons_count
; /* number of physical buttons per touchpad */
134 bool is_buttonpad
; /* is this device a button pad? */
135 bool serial_maybe
; /* need to check for serial protocol */
136 bool curvalid
; /* is the current contact valid? */
137 unsigned mt_flags
; /* flags to pass to input-mt */
140 static void mt_post_parse_default_settings(struct mt_device
*td
);
141 static void mt_post_parse(struct mt_device
*td
);
143 /* classes of device behavior */
144 #define MT_CLS_DEFAULT 0x0001
146 #define MT_CLS_SERIAL 0x0002
147 #define MT_CLS_CONFIDENCE 0x0003
148 #define MT_CLS_CONFIDENCE_CONTACT_ID 0x0004
149 #define MT_CLS_CONFIDENCE_MINUS_ONE 0x0005
150 #define MT_CLS_DUAL_INRANGE_CONTACTID 0x0006
151 #define MT_CLS_DUAL_INRANGE_CONTACTNUMBER 0x0007
152 /* reserved 0x0008 */
153 #define MT_CLS_INRANGE_CONTACTNUMBER 0x0009
154 #define MT_CLS_NSMU 0x000a
155 /* reserved 0x0010 */
156 /* reserved 0x0011 */
157 #define MT_CLS_WIN_8 0x0012
158 #define MT_CLS_EXPORT_ALL_INPUTS 0x0013
159 #define MT_CLS_WIN_8_DUAL 0x0014
161 /* vendor specific classes */
162 #define MT_CLS_3M 0x0101
163 /* reserved 0x0102 */
164 #define MT_CLS_EGALAX 0x0103
165 #define MT_CLS_EGALAX_SERIAL 0x0104
166 #define MT_CLS_TOPSEED 0x0105
167 #define MT_CLS_PANASONIC 0x0106
168 #define MT_CLS_FLATFROG 0x0107
169 #define MT_CLS_GENERALTOUCH_TWOFINGERS 0x0108
170 #define MT_CLS_GENERALTOUCH_PWT_TENFINGERS 0x0109
171 #define MT_CLS_LG 0x010a
172 #define MT_CLS_VTL 0x0110
173 #define MT_CLS_GOOGLE 0x0111
175 #define MT_DEFAULT_MAXCONTACT 10
176 #define MT_MAX_MAXCONTACT 250
178 #define MT_USB_DEVICE(v, p) HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH, v, p)
179 #define MT_BT_DEVICE(v, p) HID_DEVICE(BUS_BLUETOOTH, HID_GROUP_MULTITOUCH, v, p)
182 * these device-dependent functions determine what slot corresponds
183 * to a valid contact that was just read.
186 static int cypress_compute_slot(struct mt_device
*td
)
188 if (td
->curdata
.contactid
!= 0 || td
->num_received
== 0)
189 return td
->curdata
.contactid
;
194 static struct mt_class mt_classes
[] = {
195 { .name
= MT_CLS_DEFAULT
,
196 .quirks
= MT_QUIRK_ALWAYS_VALID
|
197 MT_QUIRK_CONTACT_CNT_ACCURATE
},
198 { .name
= MT_CLS_NSMU
,
199 .quirks
= MT_QUIRK_NOT_SEEN_MEANS_UP
},
200 { .name
= MT_CLS_SERIAL
,
201 .quirks
= MT_QUIRK_ALWAYS_VALID
},
202 { .name
= MT_CLS_CONFIDENCE
,
203 .quirks
= MT_QUIRK_VALID_IS_CONFIDENCE
},
204 { .name
= MT_CLS_CONFIDENCE_CONTACT_ID
,
205 .quirks
= MT_QUIRK_VALID_IS_CONFIDENCE
|
206 MT_QUIRK_SLOT_IS_CONTACTID
},
207 { .name
= MT_CLS_CONFIDENCE_MINUS_ONE
,
208 .quirks
= MT_QUIRK_VALID_IS_CONFIDENCE
|
209 MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE
},
210 { .name
= MT_CLS_DUAL_INRANGE_CONTACTID
,
211 .quirks
= MT_QUIRK_VALID_IS_INRANGE
|
212 MT_QUIRK_SLOT_IS_CONTACTID
,
214 { .name
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
215 .quirks
= MT_QUIRK_VALID_IS_INRANGE
|
216 MT_QUIRK_SLOT_IS_CONTACTNUMBER
,
218 { .name
= MT_CLS_INRANGE_CONTACTNUMBER
,
219 .quirks
= MT_QUIRK_VALID_IS_INRANGE
|
220 MT_QUIRK_SLOT_IS_CONTACTNUMBER
},
221 { .name
= MT_CLS_WIN_8
,
222 .quirks
= MT_QUIRK_ALWAYS_VALID
|
223 MT_QUIRK_IGNORE_DUPLICATES
|
225 MT_QUIRK_CONTACT_CNT_ACCURATE
|
226 MT_QUIRK_STICKY_FINGERS
},
227 { .name
= MT_CLS_EXPORT_ALL_INPUTS
,
228 .quirks
= MT_QUIRK_ALWAYS_VALID
|
229 MT_QUIRK_CONTACT_CNT_ACCURATE
,
230 .export_all_inputs
= true },
231 { .name
= MT_CLS_WIN_8_DUAL
,
232 .quirks
= MT_QUIRK_ALWAYS_VALID
|
233 MT_QUIRK_IGNORE_DUPLICATES
|
235 MT_QUIRK_CONTACT_CNT_ACCURATE
,
236 .export_all_inputs
= true },
239 * vendor specific classes
242 .quirks
= MT_QUIRK_VALID_IS_CONFIDENCE
|
243 MT_QUIRK_SLOT_IS_CONTACTID
|
244 MT_QUIRK_TOUCH_SIZE_SCALING
,
250 { .name
= MT_CLS_EGALAX
,
251 .quirks
= MT_QUIRK_SLOT_IS_CONTACTID
|
252 MT_QUIRK_VALID_IS_INRANGE
,
256 { .name
= MT_CLS_EGALAX_SERIAL
,
257 .quirks
= MT_QUIRK_SLOT_IS_CONTACTID
|
258 MT_QUIRK_ALWAYS_VALID
,
262 { .name
= MT_CLS_TOPSEED
,
263 .quirks
= MT_QUIRK_ALWAYS_VALID
,
267 { .name
= MT_CLS_PANASONIC
,
268 .quirks
= MT_QUIRK_NOT_SEEN_MEANS_UP
,
270 { .name
= MT_CLS_GENERALTOUCH_TWOFINGERS
,
271 .quirks
= MT_QUIRK_NOT_SEEN_MEANS_UP
|
272 MT_QUIRK_VALID_IS_INRANGE
|
273 MT_QUIRK_SLOT_IS_CONTACTID
,
276 { .name
= MT_CLS_GENERALTOUCH_PWT_TENFINGERS
,
277 .quirks
= MT_QUIRK_NOT_SEEN_MEANS_UP
|
278 MT_QUIRK_SLOT_IS_CONTACTID
281 { .name
= MT_CLS_FLATFROG
,
282 .quirks
= MT_QUIRK_NOT_SEEN_MEANS_UP
|
288 .quirks
= MT_QUIRK_ALWAYS_VALID
|
289 MT_QUIRK_FIX_CONST_CONTACT_ID
|
290 MT_QUIRK_IGNORE_DUPLICATES
|
292 MT_QUIRK_CONTACT_CNT_ACCURATE
},
293 { .name
= MT_CLS_VTL
,
294 .quirks
= MT_QUIRK_ALWAYS_VALID
|
295 MT_QUIRK_CONTACT_CNT_ACCURATE
|
296 MT_QUIRK_FORCE_GET_FEATURE
,
298 { .name
= MT_CLS_GOOGLE
,
299 .quirks
= MT_QUIRK_ALWAYS_VALID
|
300 MT_QUIRK_CONTACT_CNT_ACCURATE
|
301 MT_QUIRK_SLOT_IS_CONTACTID
|
307 static ssize_t
mt_show_quirks(struct device
*dev
,
308 struct device_attribute
*attr
,
311 struct hid_device
*hdev
= to_hid_device(dev
);
312 struct mt_device
*td
= hid_get_drvdata(hdev
);
314 return sprintf(buf
, "%u\n", td
->mtclass
.quirks
);
317 static ssize_t
mt_set_quirks(struct device
*dev
,
318 struct device_attribute
*attr
,
319 const char *buf
, size_t count
)
321 struct hid_device
*hdev
= to_hid_device(dev
);
322 struct mt_device
*td
= hid_get_drvdata(hdev
);
326 if (kstrtoul(buf
, 0, &val
))
329 td
->mtclass
.quirks
= val
;
331 if (td
->cc_index
< 0)
332 td
->mtclass
.quirks
&= ~MT_QUIRK_CONTACT_CNT_ACCURATE
;
337 static DEVICE_ATTR(quirks
, S_IWUSR
| S_IRUGO
, mt_show_quirks
, mt_set_quirks
);
339 static struct attribute
*sysfs_attrs
[] = {
340 &dev_attr_quirks
.attr
,
344 static struct attribute_group mt_attribute_group
= {
348 static void mt_get_feature(struct hid_device
*hdev
, struct hid_report
*report
)
350 struct mt_device
*td
= hid_get_drvdata(hdev
);
351 int ret
, size
= hid_report_len(report
);
355 * Do not fetch the feature report if the device has been explicitly
356 * marked as non-capable.
358 if (td
->initial_quirks
& HID_QUIRK_NO_INIT_REPORTS
)
361 buf
= hid_alloc_report_buf(report
, GFP_KERNEL
);
365 ret
= hid_hw_raw_request(hdev
, report
->id
, buf
, size
,
366 HID_FEATURE_REPORT
, HID_REQ_GET_REPORT
);
368 dev_warn(&hdev
->dev
, "failed to fetch feature %d\n",
371 ret
= hid_report_raw_event(hdev
, HID_FEATURE_REPORT
, buf
,
374 dev_warn(&hdev
->dev
, "failed to report feature\n");
380 static void mt_feature_mapping(struct hid_device
*hdev
,
381 struct hid_field
*field
, struct hid_usage
*usage
)
383 struct mt_device
*td
= hid_get_drvdata(hdev
);
385 switch (usage
->hid
) {
386 case HID_DG_INPUTMODE
:
387 /* Ignore if value index is out of bounds. */
388 if (usage
->usage_index
>= field
->report_count
) {
389 dev_err(&hdev
->dev
, "HID_DG_INPUTMODE out of range\n");
393 if (td
->inputmode
< 0) {
394 td
->inputmode
= field
->report
->id
;
395 td
->inputmode_index
= usage
->usage_index
;
398 * Some elan panels wrongly declare 2 input mode
399 * features, and silently ignore when we set the
400 * value in the second field. Skip the second feature
401 * and hope for the best.
404 "Ignoring the extra HID_DG_INPUTMODE\n");
408 case HID_DG_CONTACTMAX
:
409 mt_get_feature(hdev
, field
->report
);
411 td
->maxcontact_report_id
= field
->report
->id
;
412 td
->maxcontacts
= field
->value
[0];
413 if (!td
->maxcontacts
&&
414 field
->logical_maximum
<= MT_MAX_MAXCONTACT
)
415 td
->maxcontacts
= field
->logical_maximum
;
416 if (td
->mtclass
.maxcontacts
)
417 /* check if the maxcontacts is given by the class */
418 td
->maxcontacts
= td
->mtclass
.maxcontacts
;
421 case HID_DG_BUTTONTYPE
:
422 if (usage
->usage_index
>= field
->report_count
) {
423 dev_err(&hdev
->dev
, "HID_DG_BUTTONTYPE out of range\n");
427 mt_get_feature(hdev
, field
->report
);
428 if (field
->value
[usage
->usage_index
] == MT_BUTTONTYPE_CLICKPAD
)
429 td
->is_buttonpad
= true;
433 /* Retrieve the Win8 blob once to enable some devices */
434 if (usage
->usage_index
== 0)
435 mt_get_feature(hdev
, field
->report
);
440 static void set_abs(struct input_dev
*input
, unsigned int code
,
441 struct hid_field
*field
, int snratio
)
443 int fmin
= field
->logical_minimum
;
444 int fmax
= field
->logical_maximum
;
445 int fuzz
= snratio
? (fmax
- fmin
) / snratio
: 0;
446 input_set_abs_params(input
, code
, fmin
, fmax
, fuzz
, 0);
447 input_abs_set_res(input
, code
, hidinput_calc_abs_res(field
, code
));
450 static void mt_store_field(struct hid_usage
*usage
, struct mt_device
*td
,
451 struct hid_input
*hi
)
453 struct mt_fields
*f
= td
->fields
;
455 if (f
->length
>= HID_MAX_FIELDS
)
458 f
->usages
[f
->length
++] = usage
->hid
;
461 static int mt_touch_input_mapping(struct hid_device
*hdev
, struct hid_input
*hi
,
462 struct hid_field
*field
, struct hid_usage
*usage
,
463 unsigned long **bit
, int *max
)
465 struct mt_device
*td
= hid_get_drvdata(hdev
);
466 struct mt_class
*cls
= &td
->mtclass
;
468 struct hid_usage
*prev_usage
= NULL
;
470 if (field
->application
== HID_DG_TOUCHSCREEN
)
471 td
->mt_flags
|= INPUT_MT_DIRECT
;
474 * Model touchscreens providing buttons as touchpads.
476 if (field
->application
== HID_DG_TOUCHPAD
||
477 (usage
->hid
& HID_USAGE_PAGE
) == HID_UP_BUTTON
) {
478 td
->mt_flags
|= INPUT_MT_POINTER
;
479 td
->inputmode_value
= MT_INPUTMODE_TOUCHPAD
;
482 /* count the buttons on touchpads */
483 if ((usage
->hid
& HID_USAGE_PAGE
) == HID_UP_BUTTON
)
486 if (usage
->usage_index
)
487 prev_usage
= &field
->usage
[usage
->usage_index
- 1];
489 switch (usage
->hid
& HID_USAGE_PAGE
) {
492 switch (usage
->hid
) {
494 if (prev_usage
&& (prev_usage
->hid
== usage
->hid
)) {
495 hid_map_usage(hi
, usage
, bit
, max
,
496 EV_ABS
, ABS_MT_TOOL_X
);
497 set_abs(hi
->input
, ABS_MT_TOOL_X
, field
,
500 hid_map_usage(hi
, usage
, bit
, max
,
501 EV_ABS
, ABS_MT_POSITION_X
);
502 set_abs(hi
->input
, ABS_MT_POSITION_X
, field
,
506 mt_store_field(usage
, td
, hi
);
509 if (prev_usage
&& (prev_usage
->hid
== usage
->hid
)) {
510 hid_map_usage(hi
, usage
, bit
, max
,
511 EV_ABS
, ABS_MT_TOOL_Y
);
512 set_abs(hi
->input
, ABS_MT_TOOL_Y
, field
,
515 hid_map_usage(hi
, usage
, bit
, max
,
516 EV_ABS
, ABS_MT_POSITION_Y
);
517 set_abs(hi
->input
, ABS_MT_POSITION_Y
, field
,
521 mt_store_field(usage
, td
, hi
);
526 case HID_UP_DIGITIZER
:
527 switch (usage
->hid
) {
529 if (cls
->quirks
& MT_QUIRK_HOVERING
) {
530 hid_map_usage(hi
, usage
, bit
, max
,
531 EV_ABS
, ABS_MT_DISTANCE
);
532 input_set_abs_params(hi
->input
,
533 ABS_MT_DISTANCE
, 0, 1, 0, 0);
535 mt_store_field(usage
, td
, hi
);
537 case HID_DG_CONFIDENCE
:
538 if ((cls
->name
== MT_CLS_WIN_8
||
539 cls
->name
== MT_CLS_WIN_8_DUAL
) &&
540 field
->application
== HID_DG_TOUCHPAD
)
541 cls
->quirks
|= MT_QUIRK_CONFIDENCE
;
542 mt_store_field(usage
, td
, hi
);
544 case HID_DG_TIPSWITCH
:
545 hid_map_usage(hi
, usage
, bit
, max
, EV_KEY
, BTN_TOUCH
);
546 input_set_capability(hi
->input
, EV_KEY
, BTN_TOUCH
);
547 mt_store_field(usage
, td
, hi
);
549 case HID_DG_CONTACTID
:
550 mt_store_field(usage
, td
, hi
);
551 td
->touches_by_report
++;
552 td
->mt_report_id
= field
->report
->id
;
555 hid_map_usage(hi
, usage
, bit
, max
,
556 EV_ABS
, ABS_MT_TOUCH_MAJOR
);
557 if (!(cls
->quirks
& MT_QUIRK_NO_AREA
))
558 set_abs(hi
->input
, ABS_MT_TOUCH_MAJOR
, field
,
560 mt_store_field(usage
, td
, hi
);
563 hid_map_usage(hi
, usage
, bit
, max
,
564 EV_ABS
, ABS_MT_TOUCH_MINOR
);
565 if (!(cls
->quirks
& MT_QUIRK_NO_AREA
)) {
566 set_abs(hi
->input
, ABS_MT_TOUCH_MINOR
, field
,
568 input_set_abs_params(hi
->input
,
569 ABS_MT_ORIENTATION
, 0, 1, 0, 0);
571 mt_store_field(usage
, td
, hi
);
573 case HID_DG_TIPPRESSURE
:
574 hid_map_usage(hi
, usage
, bit
, max
,
575 EV_ABS
, ABS_MT_PRESSURE
);
576 set_abs(hi
->input
, ABS_MT_PRESSURE
, field
,
578 mt_store_field(usage
, td
, hi
);
580 case HID_DG_CONTACTCOUNT
:
581 /* Ignore if indexes are out of bounds. */
582 if (field
->index
>= field
->report
->maxfield
||
583 usage
->usage_index
>= field
->report_count
)
585 td
->cc_index
= field
->index
;
586 td
->cc_value_index
= usage
->usage_index
;
588 case HID_DG_CONTACTMAX
:
589 /* we don't set td->last_slot_field as contactcount and
590 * contact max are global to the report */
593 /* Legacy devices use TIPSWITCH and not TOUCH.
594 * Let's just ignore this field. */
597 /* let hid-input decide for the others */
601 code
= BTN_MOUSE
+ ((usage
->hid
- 1) & HID_USAGE
);
603 * MS PTP spec says that external buttons left and right have
606 if ((cls
->name
== MT_CLS_WIN_8
||
607 cls
->name
== MT_CLS_WIN_8_DUAL
) &&
608 field
->application
== HID_DG_TOUCHPAD
&&
609 (usage
->hid
& HID_USAGE
) > 1)
611 hid_map_usage(hi
, usage
, bit
, max
, EV_KEY
, code
);
612 input_set_capability(hi
->input
, EV_KEY
, code
);
616 /* we do not want to map these: no input-oriented meaning */
623 static int mt_touch_input_mapped(struct hid_device
*hdev
, struct hid_input
*hi
,
624 struct hid_field
*field
, struct hid_usage
*usage
,
625 unsigned long **bit
, int *max
)
627 if (usage
->type
== EV_KEY
|| usage
->type
== EV_ABS
)
628 set_bit(usage
->type
, hi
->input
->evbit
);
633 static int mt_compute_slot(struct mt_device
*td
, struct input_dev
*input
)
635 __s32 quirks
= td
->mtclass
.quirks
;
637 if (quirks
& MT_QUIRK_SLOT_IS_CONTACTID
)
638 return td
->curdata
.contactid
;
640 if (quirks
& MT_QUIRK_CYPRESS
)
641 return cypress_compute_slot(td
);
643 if (quirks
& MT_QUIRK_SLOT_IS_CONTACTNUMBER
)
644 return td
->num_received
;
646 if (quirks
& MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE
)
647 return td
->curdata
.contactid
- 1;
649 return input_mt_get_slot_by_key(input
, td
->curdata
.contactid
);
653 * this function is called when a whole contact has been processed,
654 * so that it can assign it to a slot and store the data there
656 static void mt_complete_slot(struct mt_device
*td
, struct input_dev
*input
)
658 if ((td
->mtclass
.quirks
& MT_QUIRK_CONTACT_CNT_ACCURATE
) &&
659 td
->num_received
>= td
->num_expected
)
662 if (td
->curvalid
|| (td
->mtclass
.quirks
& MT_QUIRK_ALWAYS_VALID
)) {
664 int slotnum
= mt_compute_slot(td
, input
);
665 struct mt_slot
*s
= &td
->curdata
;
666 struct input_mt
*mt
= input
->mt
;
668 if (slotnum
< 0 || slotnum
>= td
->maxcontacts
)
671 if ((td
->mtclass
.quirks
& MT_QUIRK_IGNORE_DUPLICATES
) && mt
) {
672 struct input_mt_slot
*slot
= &mt
->slots
[slotnum
];
673 if (input_mt_is_active(slot
) &&
674 input_mt_is_used(mt
, slot
))
678 if (!(td
->mtclass
.quirks
& MT_QUIRK_CONFIDENCE
))
679 s
->confidence_state
= 1;
680 active
= (s
->touch_state
|| s
->inrange_state
) &&
683 input_mt_slot(input
, slotnum
);
684 input_mt_report_slot_state(input
, MT_TOOL_FINGER
, active
);
686 /* this finger is in proximity of the sensor */
687 int wide
= (s
->w
> s
->h
);
688 int major
= max(s
->w
, s
->h
);
689 int minor
= min(s
->w
, s
->h
);
692 * divided by two to match visual scale of touch
693 * for devices with this quirk
695 if (td
->mtclass
.quirks
& MT_QUIRK_TOUCH_SIZE_SCALING
) {
700 input_event(input
, EV_ABS
, ABS_MT_POSITION_X
, s
->x
);
701 input_event(input
, EV_ABS
, ABS_MT_POSITION_Y
, s
->y
);
702 input_event(input
, EV_ABS
, ABS_MT_TOOL_X
, s
->cx
);
703 input_event(input
, EV_ABS
, ABS_MT_TOOL_Y
, s
->cy
);
704 input_event(input
, EV_ABS
, ABS_MT_DISTANCE
,
706 input_event(input
, EV_ABS
, ABS_MT_ORIENTATION
, wide
);
707 input_event(input
, EV_ABS
, ABS_MT_PRESSURE
, s
->p
);
708 input_event(input
, EV_ABS
, ABS_MT_TOUCH_MAJOR
, major
);
709 input_event(input
, EV_ABS
, ABS_MT_TOUCH_MINOR
, minor
);
711 set_bit(MT_IO_FLAGS_ACTIVE_SLOTS
, &td
->mt_io_flags
);
719 * this function is called when a whole packet has been received and processed,
720 * so that it can decide what to send to the input layer.
722 static void mt_sync_frame(struct mt_device
*td
, struct input_dev
*input
)
724 input_mt_sync_frame(input
);
726 td
->num_received
= 0;
727 if (test_bit(MT_IO_FLAGS_ACTIVE_SLOTS
, &td
->mt_io_flags
))
728 set_bit(MT_IO_FLAGS_PENDING_SLOTS
, &td
->mt_io_flags
);
730 clear_bit(MT_IO_FLAGS_PENDING_SLOTS
, &td
->mt_io_flags
);
731 clear_bit(MT_IO_FLAGS_ACTIVE_SLOTS
, &td
->mt_io_flags
);
734 static int mt_touch_event(struct hid_device
*hid
, struct hid_field
*field
,
735 struct hid_usage
*usage
, __s32 value
)
737 /* we will handle the hidinput part later, now remains hiddev */
738 if (hid
->claimed
& HID_CLAIMED_HIDDEV
&& hid
->hiddev_hid_event
)
739 hid
->hiddev_hid_event(hid
, field
, usage
, value
);
744 static void mt_process_mt_event(struct hid_device
*hid
, struct hid_field
*field
,
745 struct hid_usage
*usage
, __s32 value
)
747 struct mt_device
*td
= hid_get_drvdata(hid
);
748 __s32 quirks
= td
->mtclass
.quirks
;
749 struct input_dev
*input
= field
->hidinput
->input
;
751 if (hid
->claimed
& HID_CLAIMED_INPUT
) {
752 switch (usage
->hid
) {
754 if (quirks
& MT_QUIRK_VALID_IS_INRANGE
)
755 td
->curvalid
= value
;
756 if (quirks
& MT_QUIRK_HOVERING
)
757 td
->curdata
.inrange_state
= value
;
759 case HID_DG_TIPSWITCH
:
760 if (quirks
& MT_QUIRK_NOT_SEEN_MEANS_UP
)
761 td
->curvalid
= value
;
762 td
->curdata
.touch_state
= value
;
764 case HID_DG_CONFIDENCE
:
765 if (quirks
& MT_QUIRK_CONFIDENCE
)
766 td
->curdata
.confidence_state
= value
;
767 if (quirks
& MT_QUIRK_VALID_IS_CONFIDENCE
)
768 td
->curvalid
= value
;
770 case HID_DG_CONTACTID
:
771 td
->curdata
.contactid
= value
;
773 case HID_DG_TIPPRESSURE
:
774 td
->curdata
.p
= value
;
777 if (usage
->code
== ABS_MT_TOOL_X
)
778 td
->curdata
.cx
= value
;
780 td
->curdata
.x
= value
;
783 if (usage
->code
== ABS_MT_TOOL_Y
)
784 td
->curdata
.cy
= value
;
786 td
->curdata
.y
= value
;
789 td
->curdata
.w
= value
;
792 td
->curdata
.h
= value
;
794 case HID_DG_CONTACTCOUNT
:
802 input_event(input
, usage
->type
, usage
->code
,
807 if (usage
->usage_index
+ 1 == field
->report_count
) {
808 /* we only take into account the last report. */
809 if (usage
->hid
== td
->last_slot_field
)
810 mt_complete_slot(td
, field
->hidinput
->input
);
816 static void mt_touch_report(struct hid_device
*hid
, struct hid_report
*report
)
818 struct mt_device
*td
= hid_get_drvdata(hid
);
819 struct hid_field
*field
;
823 /* sticky fingers release in progress, abort */
824 if (test_and_set_bit(MT_IO_FLAGS_RUNNING
, &td
->mt_io_flags
))
828 * Includes multi-packet support where subsequent
829 * packets are sent with zero contactcount.
831 if (td
->cc_index
>= 0) {
832 struct hid_field
*field
= report
->field
[td
->cc_index
];
833 int value
= field
->value
[td
->cc_value_index
];
835 td
->num_expected
= value
;
838 for (r
= 0; r
< report
->maxfield
; r
++) {
839 field
= report
->field
[r
];
840 count
= field
->report_count
;
842 if (!(HID_MAIN_ITEM_VARIABLE
& field
->flags
))
845 for (n
= 0; n
< count
; n
++)
846 mt_process_mt_event(hid
, field
, &field
->usage
[n
],
850 if (td
->num_received
>= td
->num_expected
)
851 mt_sync_frame(td
, report
->field
[0]->hidinput
->input
);
854 * Windows 8 specs says 2 things:
855 * - once a contact has been reported, it has to be reported in each
857 * - the report rate when fingers are present has to be at least
858 * the refresh rate of the screen, 60 or 120 Hz
860 * I interprete this that the specification forces a report rate of
861 * at least 60 Hz for a touchscreen to be certified.
862 * Which means that if we do not get a report whithin 16 ms, either
863 * something wrong happens, either the touchscreen forgets to send
864 * a release. Taking a reasonable margin allows to remove issues
865 * with USB communication or the load of the machine.
867 * Given that Win 8 devices are forced to send a release, this will
868 * only affect laggish machines and the ones that have a firmware
871 if (td
->mtclass
.quirks
& MT_QUIRK_STICKY_FINGERS
) {
872 if (test_bit(MT_IO_FLAGS_PENDING_SLOTS
, &td
->mt_io_flags
))
873 mod_timer(&td
->release_timer
,
874 jiffies
+ msecs_to_jiffies(100));
876 del_timer(&td
->release_timer
);
879 clear_bit(MT_IO_FLAGS_RUNNING
, &td
->mt_io_flags
);
882 static int mt_touch_input_configured(struct hid_device
*hdev
,
883 struct hid_input
*hi
)
885 struct mt_device
*td
= hid_get_drvdata(hdev
);
886 struct mt_class
*cls
= &td
->mtclass
;
887 struct input_dev
*input
= hi
->input
;
890 if (!td
->maxcontacts
)
891 td
->maxcontacts
= MT_DEFAULT_MAXCONTACT
;
894 if (td
->serial_maybe
)
895 mt_post_parse_default_settings(td
);
897 if (cls
->is_indirect
)
898 td
->mt_flags
|= INPUT_MT_POINTER
;
900 if (cls
->quirks
& MT_QUIRK_NOT_SEEN_MEANS_UP
)
901 td
->mt_flags
|= INPUT_MT_DROP_UNUSED
;
903 /* check for clickpads */
904 if ((td
->mt_flags
& INPUT_MT_POINTER
) && (td
->buttons_count
== 1))
905 td
->is_buttonpad
= true;
907 if (td
->is_buttonpad
)
908 __set_bit(INPUT_PROP_BUTTONPAD
, input
->propbit
);
910 ret
= input_mt_init_slots(input
, td
->maxcontacts
, td
->mt_flags
);
918 static int mt_input_mapping(struct hid_device
*hdev
, struct hid_input
*hi
,
919 struct hid_field
*field
, struct hid_usage
*usage
,
920 unsigned long **bit
, int *max
)
922 struct mt_device
*td
= hid_get_drvdata(hdev
);
925 * If mtclass.export_all_inputs is not set, only map fields from
926 * TouchScreen or TouchPad collections. We need to ignore fields
927 * that belong to other collections such as Mouse that might have
928 * the same GenericDesktop usages.
930 if (!td
->mtclass
.export_all_inputs
&&
931 field
->application
!= HID_DG_TOUCHSCREEN
&&
932 field
->application
!= HID_DG_PEN
&&
933 field
->application
!= HID_DG_TOUCHPAD
&&
934 field
->application
!= HID_GD_KEYBOARD
&&
935 field
->application
!= HID_CP_CONSUMER_CONTROL
)
939 * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
941 * The check for mt_report_id ensures we don't process
942 * HID_DG_CONTACTCOUNT from the pen report as it is outside the physical
943 * collection, but within the report ID.
945 if (field
->physical
== HID_DG_STYLUS
)
947 else if ((field
->physical
== 0) &&
948 (field
->report
->id
!= td
->mt_report_id
) &&
949 (td
->mt_report_id
!= -1))
952 if (field
->application
== HID_DG_TOUCHSCREEN
||
953 field
->application
== HID_DG_TOUCHPAD
)
954 return mt_touch_input_mapping(hdev
, hi
, field
, usage
, bit
, max
);
956 /* let hid-core decide for the others */
960 static int mt_input_mapped(struct hid_device
*hdev
, struct hid_input
*hi
,
961 struct hid_field
*field
, struct hid_usage
*usage
,
962 unsigned long **bit
, int *max
)
965 * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
968 if (field
->physical
== HID_DG_STYLUS
)
971 if (field
->application
== HID_DG_TOUCHSCREEN
||
972 field
->application
== HID_DG_TOUCHPAD
)
973 return mt_touch_input_mapped(hdev
, hi
, field
, usage
, bit
, max
);
975 /* let hid-core decide for the others */
979 static int mt_event(struct hid_device
*hid
, struct hid_field
*field
,
980 struct hid_usage
*usage
, __s32 value
)
982 struct mt_device
*td
= hid_get_drvdata(hid
);
984 if (field
->report
->id
== td
->mt_report_id
)
985 return mt_touch_event(hid
, field
, usage
, value
);
990 static void mt_report(struct hid_device
*hid
, struct hid_report
*report
)
992 struct mt_device
*td
= hid_get_drvdata(hid
);
993 struct hid_field
*field
= report
->field
[0];
995 if (!(hid
->claimed
& HID_CLAIMED_INPUT
))
998 if (report
->id
== td
->mt_report_id
)
999 return mt_touch_report(hid
, report
);
1001 if (field
&& field
->hidinput
&& field
->hidinput
->input
)
1002 input_sync(field
->hidinput
->input
);
1005 static void mt_set_input_mode(struct hid_device
*hdev
)
1007 struct mt_device
*td
= hid_get_drvdata(hdev
);
1008 struct hid_report
*r
;
1009 struct hid_report_enum
*re
;
1010 struct mt_class
*cls
= &td
->mtclass
;
1014 if (td
->inputmode
< 0)
1017 re
= &(hdev
->report_enum
[HID_FEATURE_REPORT
]);
1018 r
= re
->report_id_hash
[td
->inputmode
];
1020 if (cls
->quirks
& MT_QUIRK_FORCE_GET_FEATURE
) {
1021 report_len
= hid_report_len(r
);
1022 buf
= hid_alloc_report_buf(r
, GFP_KERNEL
);
1024 hid_err(hdev
, "failed to allocate buffer for report\n");
1027 hid_hw_raw_request(hdev
, r
->id
, buf
, report_len
,
1029 HID_REQ_GET_REPORT
);
1032 r
->field
[0]->value
[td
->inputmode_index
] = td
->inputmode_value
;
1033 hid_hw_request(hdev
, r
, HID_REQ_SET_REPORT
);
1037 static void mt_set_maxcontacts(struct hid_device
*hdev
)
1039 struct mt_device
*td
= hid_get_drvdata(hdev
);
1040 struct hid_report
*r
;
1041 struct hid_report_enum
*re
;
1044 if (td
->maxcontact_report_id
< 0)
1047 if (!td
->mtclass
.maxcontacts
)
1050 re
= &hdev
->report_enum
[HID_FEATURE_REPORT
];
1051 r
= re
->report_id_hash
[td
->maxcontact_report_id
];
1053 max
= td
->mtclass
.maxcontacts
;
1054 fieldmax
= r
->field
[0]->logical_maximum
;
1055 max
= min(fieldmax
, max
);
1056 if (r
->field
[0]->value
[0] != max
) {
1057 r
->field
[0]->value
[0] = max
;
1058 hid_hw_request(hdev
, r
, HID_REQ_SET_REPORT
);
1063 static void mt_post_parse_default_settings(struct mt_device
*td
)
1065 __s32 quirks
= td
->mtclass
.quirks
;
1067 /* unknown serial device needs special quirks */
1068 if (td
->touches_by_report
== 1) {
1069 quirks
|= MT_QUIRK_ALWAYS_VALID
;
1070 quirks
&= ~MT_QUIRK_NOT_SEEN_MEANS_UP
;
1071 quirks
&= ~MT_QUIRK_VALID_IS_INRANGE
;
1072 quirks
&= ~MT_QUIRK_VALID_IS_CONFIDENCE
;
1073 quirks
&= ~MT_QUIRK_CONTACT_CNT_ACCURATE
;
1076 td
->mtclass
.quirks
= quirks
;
1079 static void mt_post_parse(struct mt_device
*td
)
1081 struct mt_fields
*f
= td
->fields
;
1082 struct mt_class
*cls
= &td
->mtclass
;
1084 if (td
->touches_by_report
> 0) {
1085 int field_count_per_touch
= f
->length
/ td
->touches_by_report
;
1086 td
->last_slot_field
= f
->usages
[field_count_per_touch
- 1];
1089 if (td
->cc_index
< 0)
1090 cls
->quirks
&= ~MT_QUIRK_CONTACT_CNT_ACCURATE
;
1093 static int mt_input_configured(struct hid_device
*hdev
, struct hid_input
*hi
)
1095 struct mt_device
*td
= hid_get_drvdata(hdev
);
1097 const char *suffix
= NULL
;
1098 struct hid_field
*field
= hi
->report
->field
[0];
1101 if (hi
->report
->id
== td
->mt_report_id
) {
1102 ret
= mt_touch_input_configured(hdev
, hi
);
1108 * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
1109 * for the stylus. Check this first, and then rely on the application
1112 if (hi
->report
->field
[0]->physical
== HID_DG_STYLUS
) {
1114 /* force BTN_STYLUS to allow tablet matching in udev */
1115 __set_bit(BTN_STYLUS
, hi
->input
->keybit
);
1117 switch (field
->application
) {
1118 case HID_GD_KEYBOARD
:
1119 suffix
= "Keyboard";
1129 /* force BTN_STYLUS to allow tablet matching in udev */
1130 __set_bit(BTN_STYLUS
, hi
->input
->keybit
);
1132 case HID_DG_TOUCHSCREEN
:
1133 /* we do not set suffix = "Touchscreen" */
1135 case HID_DG_TOUCHPAD
:
1136 suffix
= "Touchpad";
1138 case HID_GD_SYSTEM_CONTROL
:
1139 suffix
= "System Control";
1141 case HID_CP_CONSUMER_CONTROL
:
1142 suffix
= "Consumer Control";
1151 name
= devm_kzalloc(&hi
->input
->dev
,
1152 strlen(hdev
->name
) + strlen(suffix
) + 2,
1155 sprintf(name
, "%s %s", hdev
->name
, suffix
);
1156 hi
->input
->name
= name
;
1163 static void mt_fix_const_field(struct hid_field
*field
, unsigned int usage
)
1165 if (field
->usage
[0].hid
!= usage
||
1166 !(field
->flags
& HID_MAIN_ITEM_CONSTANT
))
1169 field
->flags
&= ~HID_MAIN_ITEM_CONSTANT
;
1170 field
->flags
|= HID_MAIN_ITEM_VARIABLE
;
1173 static void mt_fix_const_fields(struct hid_device
*hdev
, unsigned int usage
)
1175 struct hid_report
*report
;
1178 list_for_each_entry(report
,
1179 &hdev
->report_enum
[HID_INPUT_REPORT
].report_list
,
1182 if (!report
->maxfield
)
1185 for (i
= 0; i
< report
->maxfield
; i
++)
1186 if (report
->field
[i
]->maxusage
>= 1)
1187 mt_fix_const_field(report
->field
[i
], usage
);
1191 static void mt_release_contacts(struct hid_device
*hid
)
1193 struct hid_input
*hidinput
;
1194 struct mt_device
*td
= hid_get_drvdata(hid
);
1196 list_for_each_entry(hidinput
, &hid
->inputs
, list
) {
1197 struct input_dev
*input_dev
= hidinput
->input
;
1198 struct input_mt
*mt
= input_dev
->mt
;
1202 for (i
= 0; i
< mt
->num_slots
; i
++) {
1203 input_mt_slot(input_dev
, i
);
1204 input_mt_report_slot_state(input_dev
,
1208 input_mt_sync_frame(input_dev
);
1209 input_sync(input_dev
);
1213 td
->num_received
= 0;
1216 static void mt_expired_timeout(unsigned long arg
)
1218 struct hid_device
*hdev
= (void *)arg
;
1219 struct mt_device
*td
= hid_get_drvdata(hdev
);
1222 * An input report came in just before we release the sticky fingers,
1223 * it will take care of the sticky fingers.
1225 if (test_and_set_bit(MT_IO_FLAGS_RUNNING
, &td
->mt_io_flags
))
1227 if (test_bit(MT_IO_FLAGS_PENDING_SLOTS
, &td
->mt_io_flags
))
1228 mt_release_contacts(hdev
);
1229 clear_bit(MT_IO_FLAGS_RUNNING
, &td
->mt_io_flags
);
1232 static int mt_probe(struct hid_device
*hdev
, const struct hid_device_id
*id
)
1235 struct mt_device
*td
;
1236 struct mt_class
*mtclass
= mt_classes
; /* MT_CLS_DEFAULT */
1238 for (i
= 0; mt_classes
[i
].name
; i
++) {
1239 if (id
->driver_data
== mt_classes
[i
].name
) {
1240 mtclass
= &(mt_classes
[i
]);
1245 td
= devm_kzalloc(&hdev
->dev
, sizeof(struct mt_device
), GFP_KERNEL
);
1247 dev_err(&hdev
->dev
, "cannot allocate multitouch data\n");
1250 td
->mtclass
= *mtclass
;
1252 td
->maxcontact_report_id
= -1;
1253 td
->inputmode_value
= MT_INPUTMODE_TOUCHSCREEN
;
1255 td
->mt_report_id
= -1;
1256 hid_set_drvdata(hdev
, td
);
1258 td
->fields
= devm_kzalloc(&hdev
->dev
, sizeof(struct mt_fields
),
1261 dev_err(&hdev
->dev
, "cannot allocate multitouch fields data\n");
1265 if (id
->vendor
== HID_ANY_ID
&& id
->product
== HID_ANY_ID
)
1266 td
->serial_maybe
= true;
1269 * Store the initial quirk state
1271 td
->initial_quirks
= hdev
->quirks
;
1273 /* This allows the driver to correctly support devices
1274 * that emit events over several HID messages.
1276 hdev
->quirks
|= HID_QUIRK_NO_INPUT_SYNC
;
1279 * This allows the driver to handle different input sensors
1280 * that emits events through different reports on the same HID
1283 hdev
->quirks
|= HID_QUIRK_MULTI_INPUT
;
1284 hdev
->quirks
|= HID_QUIRK_NO_EMPTY_INPUT
;
1287 * Some multitouch screens do not like to be polled for input
1288 * reports. Fortunately, the Win8 spec says that all touches
1289 * should be sent during each report, making the initialization
1290 * of input reports unnecessary. For Win7 devices, well, let's hope
1291 * they will still be happy (this is only be a problem if a touch
1292 * was already there while probing the device).
1294 * In addition some touchpads do not behave well if we read
1295 * all feature reports from them. Instead we prevent
1296 * initial report fetching and then selectively fetch each
1297 * report we are interested in.
1299 hdev
->quirks
|= HID_QUIRK_NO_INIT_REPORTS
;
1301 setup_timer(&td
->release_timer
, mt_expired_timeout
, (long)hdev
);
1303 ret
= hid_parse(hdev
);
1307 if (mtclass
->quirks
& MT_QUIRK_FIX_CONST_CONTACT_ID
)
1308 mt_fix_const_fields(hdev
, HID_DG_CONTACTID
);
1310 ret
= hid_hw_start(hdev
, HID_CONNECT_DEFAULT
);
1314 ret
= sysfs_create_group(&hdev
->dev
.kobj
, &mt_attribute_group
);
1316 dev_warn(&hdev
->dev
, "Cannot allocate sysfs group for %s\n",
1319 mt_set_maxcontacts(hdev
);
1320 mt_set_input_mode(hdev
);
1322 /* release .fields memory as it is not used anymore */
1323 devm_kfree(&hdev
->dev
, td
->fields
);
1330 static int mt_reset_resume(struct hid_device
*hdev
)
1332 mt_release_contacts(hdev
);
1333 mt_set_maxcontacts(hdev
);
1334 mt_set_input_mode(hdev
);
1338 static int mt_resume(struct hid_device
*hdev
)
1340 /* Some Elan legacy devices require SET_IDLE to be set on resume.
1341 * It should be safe to send it to other devices too.
1342 * Tested on 3M, Stantum, Cypress, Zytronic, eGalax, and Elan panels. */
1344 hid_hw_idle(hdev
, 0, 0, HID_REQ_SET_IDLE
);
1350 static void mt_remove(struct hid_device
*hdev
)
1352 struct mt_device
*td
= hid_get_drvdata(hdev
);
1354 del_timer_sync(&td
->release_timer
);
1356 sysfs_remove_group(&hdev
->dev
.kobj
, &mt_attribute_group
);
1358 hdev
->quirks
= td
->initial_quirks
;
1362 * This list contains only:
1363 * - VID/PID of products not working with the default multitouch handling
1364 * - 2 generic rules.
1365 * So there is no point in adding here any device with MT_CLS_DEFAULT.
1367 static const struct hid_device_id mt_devices
[] = {
1370 { .driver_data
= MT_CLS_3M
,
1371 MT_USB_DEVICE(USB_VENDOR_ID_3M
,
1372 USB_DEVICE_ID_3M1968
) },
1373 { .driver_data
= MT_CLS_3M
,
1374 MT_USB_DEVICE(USB_VENDOR_ID_3M
,
1375 USB_DEVICE_ID_3M2256
) },
1376 { .driver_data
= MT_CLS_3M
,
1377 MT_USB_DEVICE(USB_VENDOR_ID_3M
,
1378 USB_DEVICE_ID_3M3266
) },
1381 { .driver_data
= MT_CLS_WIN_8_DUAL
,
1382 HID_DEVICE(BUS_I2C
, HID_GROUP_MULTITOUCH_WIN_8
,
1383 USB_VENDOR_ID_ALPS_JP
,
1384 HID_DEVICE_ID_ALPS_U1_DUAL_PTP
) },
1385 { .driver_data
= MT_CLS_WIN_8_DUAL
,
1386 HID_DEVICE(BUS_I2C
, HID_GROUP_MULTITOUCH_WIN_8
,
1387 USB_VENDOR_ID_ALPS_JP
,
1388 HID_DEVICE_ID_ALPS_U1_DUAL_3BTN_PTP
) },
1391 { .driver_data
= MT_CLS_EXPORT_ALL_INPUTS
,
1392 MT_USB_DEVICE(USB_VENDOR_ID_ANTON
,
1393 USB_DEVICE_ID_ANTON_TOUCH_PAD
) },
1396 { .driver_data
= MT_CLS_SERIAL
,
1397 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL
,
1398 USB_DEVICE_ID_ATMEL_MXT_DIGITIZER
) },
1400 /* Baanto multitouch devices */
1401 { .driver_data
= MT_CLS_NSMU
,
1402 MT_USB_DEVICE(USB_VENDOR_ID_BAANTO
,
1403 USB_DEVICE_ID_BAANTO_MT_190W2
) },
1406 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
1407 MT_USB_DEVICE(USB_VENDOR_ID_CANDO
,
1408 USB_DEVICE_ID_CANDO_MULTI_TOUCH
) },
1409 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
1410 MT_USB_DEVICE(USB_VENDOR_ID_CANDO
,
1411 USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6
) },
1413 /* Chunghwa Telecom touch panels */
1414 { .driver_data
= MT_CLS_NSMU
,
1415 MT_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT
,
1416 USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH
) },
1418 /* CJTouch panels */
1419 { .driver_data
= MT_CLS_NSMU
,
1420 MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH
,
1421 USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0020
) },
1422 { .driver_data
= MT_CLS_NSMU
,
1423 MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH
,
1424 USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0040
) },
1426 /* CVTouch panels */
1427 { .driver_data
= MT_CLS_NSMU
,
1428 MT_USB_DEVICE(USB_VENDOR_ID_CVTOUCH
,
1429 USB_DEVICE_ID_CVTOUCH_SCREEN
) },
1431 /* eGalax devices (resistive) */
1432 { .driver_data
= MT_CLS_EGALAX
,
1433 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1434 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D
) },
1435 { .driver_data
= MT_CLS_EGALAX
,
1436 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1437 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E
) },
1439 /* eGalax devices (capacitive) */
1440 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
1441 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1442 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7207
) },
1443 { .driver_data
= MT_CLS_EGALAX
,
1444 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1445 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C
) },
1446 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
1447 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1448 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224
) },
1449 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
1450 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1451 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_722A
) },
1452 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
1453 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1454 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_725E
) },
1455 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
1456 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1457 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7262
) },
1458 { .driver_data
= MT_CLS_EGALAX
,
1459 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1460 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B
) },
1461 { .driver_data
= MT_CLS_EGALAX
,
1462 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1463 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1
) },
1464 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
1465 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1466 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72AA
) },
1467 { .driver_data
= MT_CLS_EGALAX
,
1468 HID_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1469 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72C4
) },
1470 { .driver_data
= MT_CLS_EGALAX
,
1471 HID_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1472 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72D0
) },
1473 { .driver_data
= MT_CLS_EGALAX
,
1474 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1475 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA
) },
1476 { .driver_data
= MT_CLS_EGALAX
,
1477 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1478 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302
) },
1479 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
1480 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1481 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7349
) },
1482 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
1483 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1484 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_73F7
) },
1485 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
1486 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
1487 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001
) },
1489 /* Elitegroup panel */
1490 { .driver_data
= MT_CLS_SERIAL
,
1491 MT_USB_DEVICE(USB_VENDOR_ID_ELITEGROUP
,
1492 USB_DEVICE_ID_ELITEGROUP_05D8
) },
1494 /* Flatfrog Panels */
1495 { .driver_data
= MT_CLS_FLATFROG
,
1496 MT_USB_DEVICE(USB_VENDOR_ID_FLATFROG
,
1497 USB_DEVICE_ID_MULTITOUCH_3200
) },
1499 /* FocalTech Panels */
1500 { .driver_data
= MT_CLS_SERIAL
,
1501 MT_USB_DEVICE(USB_VENDOR_ID_CYGNAL
,
1502 USB_DEVICE_ID_FOCALTECH_FTXXXX_MULTITOUCH
) },
1504 /* GeneralTouch panel */
1505 { .driver_data
= MT_CLS_GENERALTOUCH_TWOFINGERS
,
1506 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH
,
1507 USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS
) },
1508 { .driver_data
= MT_CLS_GENERALTOUCH_PWT_TENFINGERS
,
1509 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH
,
1510 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PWT_TENFINGERS
) },
1511 { .driver_data
= MT_CLS_GENERALTOUCH_TWOFINGERS
,
1512 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH
,
1513 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0101
) },
1514 { .driver_data
= MT_CLS_GENERALTOUCH_PWT_TENFINGERS
,
1515 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH
,
1516 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0102
) },
1517 { .driver_data
= MT_CLS_GENERALTOUCH_PWT_TENFINGERS
,
1518 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH
,
1519 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0106
) },
1520 { .driver_data
= MT_CLS_GENERALTOUCH_PWT_TENFINGERS
,
1521 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH
,
1522 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_010A
) },
1523 { .driver_data
= MT_CLS_GENERALTOUCH_PWT_TENFINGERS
,
1524 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH
,
1525 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_E100
) },
1527 /* Gametel game controller */
1528 { .driver_data
= MT_CLS_NSMU
,
1529 MT_BT_DEVICE(USB_VENDOR_ID_FRUCTEL
,
1530 USB_DEVICE_ID_GAMETEL_MT_MODE
) },
1532 /* GoodTouch panels */
1533 { .driver_data
= MT_CLS_NSMU
,
1534 MT_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH
,
1535 USB_DEVICE_ID_GOODTOUCH_000f
) },
1538 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTID
,
1539 MT_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT
,
1540 USB_DEVICE_ID_HANVON_ALT_MULTITOUCH
) },
1542 /* Ilitek dual touch panel */
1543 { .driver_data
= MT_CLS_NSMU
,
1544 MT_USB_DEVICE(USB_VENDOR_ID_ILITEK
,
1545 USB_DEVICE_ID_ILITEK_MULTITOUCH
) },
1547 /* LG Melfas panel */
1548 { .driver_data
= MT_CLS_LG
,
1549 HID_USB_DEVICE(USB_VENDOR_ID_LG
,
1550 USB_DEVICE_ID_LG_MELFAS_MT
) },
1553 { .driver_data
= MT_CLS_CONFIDENCE_MINUS_ONE
,
1554 MT_USB_DEVICE(USB_VENDOR_ID_ASUS
,
1555 USB_DEVICE_ID_ASUS_T91MT
)},
1556 { .driver_data
= MT_CLS_CONFIDENCE_MINUS_ONE
,
1557 MT_USB_DEVICE(USB_VENDOR_ID_ASUS
,
1558 USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO
) },
1559 { .driver_data
= MT_CLS_CONFIDENCE_MINUS_ONE
,
1560 MT_USB_DEVICE(USB_VENDOR_ID_TURBOX
,
1561 USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART
) },
1563 /* Panasonic panels */
1564 { .driver_data
= MT_CLS_PANASONIC
,
1565 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC
,
1566 USB_DEVICE_ID_PANABOARD_UBT780
) },
1567 { .driver_data
= MT_CLS_PANASONIC
,
1568 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC
,
1569 USB_DEVICE_ID_PANABOARD_UBT880
) },
1572 { .driver_data
= MT_CLS_NSMU
,
1573 MT_USB_DEVICE(USB_VENDOR_ID_NOVATEK
,
1574 USB_DEVICE_ID_NOVATEK_PCT
) },
1577 { .driver_data
= MT_CLS_NSMU
,
1578 HID_DEVICE(BUS_I2C
, HID_GROUP_MULTITOUCH_WIN_8
,
1579 USB_VENDOR_ID_NTRIG
, 0x1b05) },
1581 /* PixArt optical touch screen */
1582 { .driver_data
= MT_CLS_INRANGE_CONTACTNUMBER
,
1583 MT_USB_DEVICE(USB_VENDOR_ID_PIXART
,
1584 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN
) },
1585 { .driver_data
= MT_CLS_INRANGE_CONTACTNUMBER
,
1586 MT_USB_DEVICE(USB_VENDOR_ID_PIXART
,
1587 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1
) },
1588 { .driver_data
= MT_CLS_INRANGE_CONTACTNUMBER
,
1589 MT_USB_DEVICE(USB_VENDOR_ID_PIXART
,
1590 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2
) },
1592 /* PixCir-based panels */
1593 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTID
,
1594 MT_USB_DEVICE(USB_VENDOR_ID_CANDO
,
1595 USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH
) },
1597 /* Quanta-based panels */
1598 { .driver_data
= MT_CLS_CONFIDENCE_CONTACT_ID
,
1599 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA
,
1600 USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001
) },
1602 /* Stantum panels */
1603 { .driver_data
= MT_CLS_CONFIDENCE
,
1604 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM
,
1605 USB_DEVICE_ID_MTP_STM
)},
1607 /* TopSeed panels */
1608 { .driver_data
= MT_CLS_TOPSEED
,
1609 MT_USB_DEVICE(USB_VENDOR_ID_TOPSEED2
,
1610 USB_DEVICE_ID_TOPSEED2_PERIPAD_701
) },
1612 /* Touch International panels */
1613 { .driver_data
= MT_CLS_NSMU
,
1614 MT_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL
,
1615 USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH
) },
1618 { .driver_data
= MT_CLS_NSMU
,
1619 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC
,
1620 USB_DEVICE_ID_UNITEC_USB_TOUCH_0709
) },
1621 { .driver_data
= MT_CLS_NSMU
,
1622 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC
,
1623 USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19
) },
1626 { .driver_data
= MT_CLS_VTL
,
1627 MT_USB_DEVICE(USB_VENDOR_ID_VTL
,
1628 USB_DEVICE_ID_VTL_MULTITOUCH_FF3F
) },
1630 /* Wistron panels */
1631 { .driver_data
= MT_CLS_NSMU
,
1632 MT_USB_DEVICE(USB_VENDOR_ID_WISTRON
,
1633 USB_DEVICE_ID_WISTRON_OPTICAL_TOUCH
) },
1636 { .driver_data
= MT_CLS_NSMU
,
1637 MT_USB_DEVICE(USB_VENDOR_ID_XAT
,
1638 USB_DEVICE_ID_XAT_CSR
) },
1641 { .driver_data
= MT_CLS_NSMU
,
1642 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1643 USB_DEVICE_ID_XIROKU_SPX
) },
1644 { .driver_data
= MT_CLS_NSMU
,
1645 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1646 USB_DEVICE_ID_XIROKU_MPX
) },
1647 { .driver_data
= MT_CLS_NSMU
,
1648 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1649 USB_DEVICE_ID_XIROKU_CSR
) },
1650 { .driver_data
= MT_CLS_NSMU
,
1651 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1652 USB_DEVICE_ID_XIROKU_SPX1
) },
1653 { .driver_data
= MT_CLS_NSMU
,
1654 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1655 USB_DEVICE_ID_XIROKU_MPX1
) },
1656 { .driver_data
= MT_CLS_NSMU
,
1657 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1658 USB_DEVICE_ID_XIROKU_CSR1
) },
1659 { .driver_data
= MT_CLS_NSMU
,
1660 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1661 USB_DEVICE_ID_XIROKU_SPX2
) },
1662 { .driver_data
= MT_CLS_NSMU
,
1663 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1664 USB_DEVICE_ID_XIROKU_MPX2
) },
1665 { .driver_data
= MT_CLS_NSMU
,
1666 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1667 USB_DEVICE_ID_XIROKU_CSR2
) },
1669 /* Google MT devices */
1670 { .driver_data
= MT_CLS_GOOGLE
,
1671 HID_DEVICE(HID_BUS_ANY
, HID_GROUP_ANY
, USB_VENDOR_ID_GOOGLE
,
1672 USB_DEVICE_ID_GOOGLE_TOUCH_ROSE
) },
1674 /* Generic MT device */
1675 { HID_DEVICE(HID_BUS_ANY
, HID_GROUP_MULTITOUCH
, HID_ANY_ID
, HID_ANY_ID
) },
1677 /* Generic Win 8 certified MT device */
1678 { .driver_data
= MT_CLS_WIN_8
,
1679 HID_DEVICE(HID_BUS_ANY
, HID_GROUP_MULTITOUCH_WIN_8
,
1680 HID_ANY_ID
, HID_ANY_ID
) },
1683 MODULE_DEVICE_TABLE(hid
, mt_devices
);
1685 static const struct hid_usage_id mt_grabbed_usages
[] = {
1686 { HID_ANY_ID
, HID_ANY_ID
, HID_ANY_ID
},
1687 { HID_ANY_ID
- 1, HID_ANY_ID
- 1, HID_ANY_ID
- 1}
1690 static struct hid_driver mt_driver
= {
1691 .name
= "hid-multitouch",
1692 .id_table
= mt_devices
,
1694 .remove
= mt_remove
,
1695 .input_mapping
= mt_input_mapping
,
1696 .input_mapped
= mt_input_mapped
,
1697 .input_configured
= mt_input_configured
,
1698 .feature_mapping
= mt_feature_mapping
,
1699 .usage_table
= mt_grabbed_usages
,
1701 .report
= mt_report
,
1703 .reset_resume
= mt_reset_resume
,
1704 .resume
= mt_resume
,
1707 module_hid_driver(mt_driver
);