2 * HID driver for multitouch panels
4 * Copyright (c) 2010-2012 Stephane Chatty <chatty@enac.fr>
5 * Copyright (c) 2010-2012 Benjamin Tissoires <benjamin.tissoires@gmail.com>
6 * Copyright (c) 2010-2012 Ecole Nationale de l'Aviation Civile, France
8 * This code is partly based on hid-egalax.c:
10 * Copyright (c) 2010 Stephane Chatty <chatty@enac.fr>
11 * Copyright (c) 2010 Henrik Rydberg <rydberg@euromail.se>
12 * Copyright (c) 2010 Canonical, Ltd.
14 * This code is partly based on hid-3m-pct.c:
16 * Copyright (c) 2009-2010 Stephane Chatty <chatty@enac.fr>
17 * Copyright (c) 2010 Henrik Rydberg <rydberg@euromail.se>
18 * Copyright (c) 2010 Canonical, Ltd.
23 * This program is free software; you can redistribute it and/or modify it
24 * under the terms of the GNU General Public License as published by the Free
25 * Software Foundation; either version 2 of the License, or (at your option)
29 #include <linux/device.h>
30 #include <linux/hid.h>
31 #include <linux/module.h>
32 #include <linux/slab.h>
33 #include <linux/usb.h>
34 #include <linux/input/mt.h>
35 #include "usbhid/usbhid.h"
38 MODULE_AUTHOR("Stephane Chatty <chatty@enac.fr>");
39 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
40 MODULE_DESCRIPTION("HID multitouch panels");
41 MODULE_LICENSE("GPL");
45 /* quirks to control the device */
46 #define MT_QUIRK_NOT_SEEN_MEANS_UP (1 << 0)
47 #define MT_QUIRK_SLOT_IS_CONTACTID (1 << 1)
48 #define MT_QUIRK_CYPRESS (1 << 2)
49 #define MT_QUIRK_SLOT_IS_CONTACTNUMBER (1 << 3)
50 #define MT_QUIRK_ALWAYS_VALID (1 << 4)
51 #define MT_QUIRK_VALID_IS_INRANGE (1 << 5)
52 #define MT_QUIRK_VALID_IS_CONFIDENCE (1 << 6)
53 #define MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE (1 << 8)
54 #define MT_QUIRK_NO_AREA (1 << 9)
58 __s32 contactid
; /* the device ContactID assigned to this slot */
59 bool touch_state
; /* is the touch valid? */
63 __s32 name
; /* MT_CLS */
65 __s32 sn_move
; /* Signal/noise ratio for move events */
66 __s32 sn_width
; /* Signal/noise ratio for width events */
67 __s32 sn_height
; /* Signal/noise ratio for height events */
68 __s32 sn_pressure
; /* Signal/noise ratio for pressure events */
70 bool is_indirect
; /* true for touchpads */
74 unsigned usages
[HID_MAX_FIELDS
];
79 struct mt_slot curdata
; /* placeholder of incoming data */
80 struct mt_class mtclass
; /* our mt device class */
81 struct mt_fields
*fields
; /* temporary placeholder for storing the
83 unsigned last_field_index
; /* last field index of the report */
84 unsigned last_slot_field
; /* the last field of a slot */
85 __s8 inputmode
; /* InputMode HID feature, -1 if non-existent */
86 __s8 inputmode_index
; /* InputMode HID feature index in the report */
87 __s8 maxcontact_report_id
; /* Maximum Contact Number HID feature,
89 __u8 num_received
; /* how many contacts we received */
90 __u8 num_expected
; /* expected last contact index */
92 __u8 touches_by_report
; /* how many touches are present in one report:
93 * 1 means we should use a serial protocol
94 * > 1 means hybrid (multitouch) protocol */
95 bool serial_maybe
; /* need to check for serial protocol */
96 bool curvalid
; /* is the current contact valid? */
97 unsigned mt_flags
; /* flags to pass to input-mt */
100 /* classes of device behavior */
101 #define MT_CLS_DEFAULT 0x0001
103 #define MT_CLS_SERIAL 0x0002
104 #define MT_CLS_CONFIDENCE 0x0003
105 #define MT_CLS_CONFIDENCE_CONTACT_ID 0x0004
106 #define MT_CLS_CONFIDENCE_MINUS_ONE 0x0005
107 #define MT_CLS_DUAL_INRANGE_CONTACTID 0x0006
108 #define MT_CLS_DUAL_INRANGE_CONTACTNUMBER 0x0007
109 #define MT_CLS_DUAL_NSMU_CONTACTID 0x0008
110 #define MT_CLS_INRANGE_CONTACTNUMBER 0x0009
112 /* vendor specific classes */
113 #define MT_CLS_3M 0x0101
114 #define MT_CLS_CYPRESS 0x0102
115 #define MT_CLS_EGALAX 0x0103
116 #define MT_CLS_EGALAX_SERIAL 0x0104
117 #define MT_CLS_TOPSEED 0x0105
118 #define MT_CLS_PANASONIC 0x0106
119 #define MT_CLS_FLATFROG 0x0107
120 #define MT_CLS_GENERALTOUCH_TWOFINGERS 0x0108
121 #define MT_CLS_GENERALTOUCH_PWT_TENFINGERS 0x0109
123 #define MT_DEFAULT_MAXCONTACT 10
125 #define MT_USB_DEVICE(v, p) HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH, v, p)
126 #define MT_BT_DEVICE(v, p) HID_DEVICE(BUS_BLUETOOTH, HID_GROUP_MULTITOUCH, v, p)
129 * these device-dependent functions determine what slot corresponds
130 * to a valid contact that was just read.
133 static int cypress_compute_slot(struct mt_device
*td
)
135 if (td
->curdata
.contactid
!= 0 || td
->num_received
== 0)
136 return td
->curdata
.contactid
;
141 static struct mt_class mt_classes
[] = {
142 { .name
= MT_CLS_DEFAULT
,
143 .quirks
= MT_QUIRK_NOT_SEEN_MEANS_UP
},
144 { .name
= MT_CLS_SERIAL
,
145 .quirks
= MT_QUIRK_ALWAYS_VALID
},
146 { .name
= MT_CLS_CONFIDENCE
,
147 .quirks
= MT_QUIRK_VALID_IS_CONFIDENCE
},
148 { .name
= MT_CLS_CONFIDENCE_CONTACT_ID
,
149 .quirks
= MT_QUIRK_VALID_IS_CONFIDENCE
|
150 MT_QUIRK_SLOT_IS_CONTACTID
},
151 { .name
= MT_CLS_CONFIDENCE_MINUS_ONE
,
152 .quirks
= MT_QUIRK_VALID_IS_CONFIDENCE
|
153 MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE
},
154 { .name
= MT_CLS_DUAL_INRANGE_CONTACTID
,
155 .quirks
= MT_QUIRK_VALID_IS_INRANGE
|
156 MT_QUIRK_SLOT_IS_CONTACTID
,
158 { .name
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
159 .quirks
= MT_QUIRK_VALID_IS_INRANGE
|
160 MT_QUIRK_SLOT_IS_CONTACTNUMBER
,
162 { .name
= MT_CLS_DUAL_NSMU_CONTACTID
,
163 .quirks
= MT_QUIRK_NOT_SEEN_MEANS_UP
|
164 MT_QUIRK_SLOT_IS_CONTACTID
,
166 { .name
= MT_CLS_INRANGE_CONTACTNUMBER
,
167 .quirks
= MT_QUIRK_VALID_IS_INRANGE
|
168 MT_QUIRK_SLOT_IS_CONTACTNUMBER
},
171 * vendor specific classes
174 .quirks
= MT_QUIRK_VALID_IS_CONFIDENCE
|
175 MT_QUIRK_SLOT_IS_CONTACTID
,
181 { .name
= MT_CLS_CYPRESS
,
182 .quirks
= MT_QUIRK_NOT_SEEN_MEANS_UP
|
185 { .name
= MT_CLS_EGALAX
,
186 .quirks
= MT_QUIRK_SLOT_IS_CONTACTID
|
187 MT_QUIRK_VALID_IS_INRANGE
,
191 { .name
= MT_CLS_EGALAX_SERIAL
,
192 .quirks
= MT_QUIRK_SLOT_IS_CONTACTID
|
193 MT_QUIRK_ALWAYS_VALID
,
197 { .name
= MT_CLS_TOPSEED
,
198 .quirks
= MT_QUIRK_ALWAYS_VALID
,
202 { .name
= MT_CLS_PANASONIC
,
203 .quirks
= MT_QUIRK_NOT_SEEN_MEANS_UP
,
205 { .name
= MT_CLS_GENERALTOUCH_TWOFINGERS
,
206 .quirks
= MT_QUIRK_NOT_SEEN_MEANS_UP
|
207 MT_QUIRK_VALID_IS_INRANGE
|
208 MT_QUIRK_SLOT_IS_CONTACTNUMBER
,
211 { .name
= MT_CLS_GENERALTOUCH_PWT_TENFINGERS
,
212 .quirks
= MT_QUIRK_NOT_SEEN_MEANS_UP
|
213 MT_QUIRK_SLOT_IS_CONTACTNUMBER
216 { .name
= MT_CLS_FLATFROG
,
217 .quirks
= MT_QUIRK_NOT_SEEN_MEANS_UP
|
225 static ssize_t
mt_show_quirks(struct device
*dev
,
226 struct device_attribute
*attr
,
229 struct hid_device
*hdev
= container_of(dev
, struct hid_device
, dev
);
230 struct mt_device
*td
= hid_get_drvdata(hdev
);
232 return sprintf(buf
, "%u\n", td
->mtclass
.quirks
);
235 static ssize_t
mt_set_quirks(struct device
*dev
,
236 struct device_attribute
*attr
,
237 const char *buf
, size_t count
)
239 struct hid_device
*hdev
= container_of(dev
, struct hid_device
, dev
);
240 struct mt_device
*td
= hid_get_drvdata(hdev
);
244 if (kstrtoul(buf
, 0, &val
))
247 td
->mtclass
.quirks
= val
;
252 static DEVICE_ATTR(quirks
, S_IWUSR
| S_IRUGO
, mt_show_quirks
, mt_set_quirks
);
254 static struct attribute
*sysfs_attrs
[] = {
255 &dev_attr_quirks
.attr
,
259 static struct attribute_group mt_attribute_group
= {
263 static void mt_feature_mapping(struct hid_device
*hdev
,
264 struct hid_field
*field
, struct hid_usage
*usage
)
266 struct mt_device
*td
= hid_get_drvdata(hdev
);
269 switch (usage
->hid
) {
270 case HID_DG_INPUTMODE
:
271 td
->inputmode
= field
->report
->id
;
272 td
->inputmode_index
= 0; /* has to be updated below */
274 for (i
=0; i
< field
->maxusage
; i
++) {
275 if (field
->usage
[i
].hid
== usage
->hid
) {
276 td
->inputmode_index
= i
;
282 case HID_DG_CONTACTMAX
:
283 td
->maxcontact_report_id
= field
->report
->id
;
284 td
->maxcontacts
= field
->value
[0];
285 if (td
->mtclass
.maxcontacts
)
286 /* check if the maxcontacts is given by the class */
287 td
->maxcontacts
= td
->mtclass
.maxcontacts
;
293 static void set_abs(struct input_dev
*input
, unsigned int code
,
294 struct hid_field
*field
, int snratio
)
296 int fmin
= field
->logical_minimum
;
297 int fmax
= field
->logical_maximum
;
298 int fuzz
= snratio
? (fmax
- fmin
) / snratio
: 0;
299 input_set_abs_params(input
, code
, fmin
, fmax
, fuzz
, 0);
302 static void mt_store_field(struct hid_usage
*usage
, struct mt_device
*td
,
303 struct hid_input
*hi
)
305 struct mt_fields
*f
= td
->fields
;
307 if (f
->length
>= HID_MAX_FIELDS
)
310 f
->usages
[f
->length
++] = usage
->hid
;
313 static int mt_input_mapping(struct hid_device
*hdev
, struct hid_input
*hi
,
314 struct hid_field
*field
, struct hid_usage
*usage
,
315 unsigned long **bit
, int *max
)
317 struct mt_device
*td
= hid_get_drvdata(hdev
);
318 struct mt_class
*cls
= &td
->mtclass
;
321 /* Only map fields from TouchScreen or TouchPad collections.
322 * We need to ignore fields that belong to other collections
323 * such as Mouse that might have the same GenericDesktop usages. */
324 if (field
->application
== HID_DG_TOUCHSCREEN
)
325 td
->mt_flags
|= INPUT_MT_DIRECT
;
326 else if (field
->application
!= HID_DG_TOUCHPAD
)
330 * Model touchscreens providing buttons as touchpads.
332 if (field
->application
== HID_DG_TOUCHPAD
||
333 (usage
->hid
& HID_USAGE_PAGE
) == HID_UP_BUTTON
)
334 td
->mt_flags
|= INPUT_MT_POINTER
;
336 /* eGalax devices provide a Digitizer.Stylus input which overrides
337 * the correct Digitizers.Finger X/Y ranges.
338 * Let's just ignore this input. */
339 if (field
->physical
== HID_DG_STYLUS
)
342 switch (usage
->hid
& HID_USAGE_PAGE
) {
345 switch (usage
->hid
) {
347 hid_map_usage(hi
, usage
, bit
, max
,
348 EV_ABS
, ABS_MT_POSITION_X
);
349 set_abs(hi
->input
, ABS_MT_POSITION_X
, field
,
351 mt_store_field(usage
, td
, hi
);
352 td
->last_field_index
= field
->index
;
355 hid_map_usage(hi
, usage
, bit
, max
,
356 EV_ABS
, ABS_MT_POSITION_Y
);
357 set_abs(hi
->input
, ABS_MT_POSITION_Y
, field
,
359 mt_store_field(usage
, td
, hi
);
360 td
->last_field_index
= field
->index
;
365 case HID_UP_DIGITIZER
:
366 switch (usage
->hid
) {
368 mt_store_field(usage
, td
, hi
);
369 td
->last_field_index
= field
->index
;
371 case HID_DG_CONFIDENCE
:
372 mt_store_field(usage
, td
, hi
);
373 td
->last_field_index
= field
->index
;
375 case HID_DG_TIPSWITCH
:
376 hid_map_usage(hi
, usage
, bit
, max
, EV_KEY
, BTN_TOUCH
);
377 input_set_capability(hi
->input
, EV_KEY
, BTN_TOUCH
);
378 mt_store_field(usage
, td
, hi
);
379 td
->last_field_index
= field
->index
;
381 case HID_DG_CONTACTID
:
382 mt_store_field(usage
, td
, hi
);
383 td
->last_field_index
= field
->index
;
384 td
->touches_by_report
++;
387 hid_map_usage(hi
, usage
, bit
, max
,
388 EV_ABS
, ABS_MT_TOUCH_MAJOR
);
389 if (!(cls
->quirks
& MT_QUIRK_NO_AREA
))
390 set_abs(hi
->input
, ABS_MT_TOUCH_MAJOR
, field
,
392 mt_store_field(usage
, td
, hi
);
393 td
->last_field_index
= field
->index
;
396 hid_map_usage(hi
, usage
, bit
, max
,
397 EV_ABS
, ABS_MT_TOUCH_MINOR
);
398 if (!(cls
->quirks
& MT_QUIRK_NO_AREA
)) {
399 set_abs(hi
->input
, ABS_MT_TOUCH_MINOR
, field
,
401 input_set_abs_params(hi
->input
,
402 ABS_MT_ORIENTATION
, 0, 1, 0, 0);
404 mt_store_field(usage
, td
, hi
);
405 td
->last_field_index
= field
->index
;
407 case HID_DG_TIPPRESSURE
:
408 hid_map_usage(hi
, usage
, bit
, max
,
409 EV_ABS
, ABS_MT_PRESSURE
);
410 set_abs(hi
->input
, ABS_MT_PRESSURE
, field
,
412 mt_store_field(usage
, td
, hi
);
413 td
->last_field_index
= field
->index
;
415 case HID_DG_CONTACTCOUNT
:
416 td
->last_field_index
= field
->index
;
418 case HID_DG_CONTACTMAX
:
419 /* we don't set td->last_slot_field as contactcount and
420 * contact max are global to the report */
421 td
->last_field_index
= field
->index
;
424 /* Legacy devices use TIPSWITCH and not TOUCH.
425 * Let's just ignore this field. */
428 /* let hid-input decide for the others */
432 code
= BTN_MOUSE
+ ((usage
->hid
- 1) & HID_USAGE
);
433 hid_map_usage(hi
, usage
, bit
, max
, EV_KEY
, code
);
434 input_set_capability(hi
->input
, EV_KEY
, code
);
438 /* we do not want to map these: no input-oriented meaning */
445 static int mt_input_mapped(struct hid_device
*hdev
, struct hid_input
*hi
,
446 struct hid_field
*field
, struct hid_usage
*usage
,
447 unsigned long **bit
, int *max
)
449 if (usage
->type
== EV_KEY
|| usage
->type
== EV_ABS
)
450 set_bit(usage
->type
, hi
->input
->evbit
);
455 static int mt_compute_slot(struct mt_device
*td
, struct input_dev
*input
)
457 __s32 quirks
= td
->mtclass
.quirks
;
459 if (quirks
& MT_QUIRK_SLOT_IS_CONTACTID
)
460 return td
->curdata
.contactid
;
462 if (quirks
& MT_QUIRK_CYPRESS
)
463 return cypress_compute_slot(td
);
465 if (quirks
& MT_QUIRK_SLOT_IS_CONTACTNUMBER
)
466 return td
->num_received
;
468 if (quirks
& MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE
)
469 return td
->curdata
.contactid
- 1;
471 return input_mt_get_slot_by_key(input
, td
->curdata
.contactid
);
475 * this function is called when a whole contact has been processed,
476 * so that it can assign it to a slot and store the data there
478 static void mt_complete_slot(struct mt_device
*td
, struct input_dev
*input
)
481 int slotnum
= mt_compute_slot(td
, input
);
482 struct mt_slot
*s
= &td
->curdata
;
484 if (slotnum
< 0 || slotnum
>= td
->maxcontacts
)
487 input_mt_slot(input
, slotnum
);
488 input_mt_report_slot_state(input
, MT_TOOL_FINGER
,
490 if (s
->touch_state
) {
491 /* this finger is on the screen */
492 int wide
= (s
->w
> s
->h
);
493 /* divided by two to match visual scale of touch */
494 int major
= max(s
->w
, s
->h
) >> 1;
495 int minor
= min(s
->w
, s
->h
) >> 1;
497 input_event(input
, EV_ABS
, ABS_MT_POSITION_X
, s
->x
);
498 input_event(input
, EV_ABS
, ABS_MT_POSITION_Y
, s
->y
);
499 input_event(input
, EV_ABS
, ABS_MT_ORIENTATION
, wide
);
500 input_event(input
, EV_ABS
, ABS_MT_PRESSURE
, s
->p
);
501 input_event(input
, EV_ABS
, ABS_MT_TOUCH_MAJOR
, major
);
502 input_event(input
, EV_ABS
, ABS_MT_TOUCH_MINOR
, minor
);
510 * this function is called when a whole packet has been received and processed,
511 * so that it can decide what to send to the input layer.
513 static void mt_sync_frame(struct mt_device
*td
, struct input_dev
*input
)
515 input_mt_sync_frame(input
);
517 td
->num_received
= 0;
520 static int mt_event(struct hid_device
*hid
, struct hid_field
*field
,
521 struct hid_usage
*usage
, __s32 value
)
523 struct mt_device
*td
= hid_get_drvdata(hid
);
524 __s32 quirks
= td
->mtclass
.quirks
;
526 if (hid
->claimed
& HID_CLAIMED_INPUT
) {
527 switch (usage
->hid
) {
529 if (quirks
& MT_QUIRK_ALWAYS_VALID
)
531 else if (quirks
& MT_QUIRK_VALID_IS_INRANGE
)
532 td
->curvalid
= value
;
534 case HID_DG_TIPSWITCH
:
535 if (quirks
& MT_QUIRK_NOT_SEEN_MEANS_UP
)
536 td
->curvalid
= value
;
537 td
->curdata
.touch_state
= value
;
539 case HID_DG_CONFIDENCE
:
540 if (quirks
& MT_QUIRK_VALID_IS_CONFIDENCE
)
541 td
->curvalid
= value
;
543 case HID_DG_CONTACTID
:
544 td
->curdata
.contactid
= value
;
546 case HID_DG_TIPPRESSURE
:
547 td
->curdata
.p
= value
;
550 td
->curdata
.x
= value
;
553 td
->curdata
.y
= value
;
556 td
->curdata
.w
= value
;
559 td
->curdata
.h
= value
;
561 case HID_DG_CONTACTCOUNT
:
563 * Includes multi-packet support where subsequent
564 * packets are sent with zero contactcount.
567 td
->num_expected
= value
;
574 /* fallback to the generic hidinput handling */
578 if (usage
->hid
== td
->last_slot_field
)
579 mt_complete_slot(td
, field
->hidinput
->input
);
581 if (field
->index
== td
->last_field_index
582 && td
->num_received
>= td
->num_expected
)
583 mt_sync_frame(td
, field
->hidinput
->input
);
587 /* we have handled the hidinput part, now remains hiddev */
588 if (hid
->claimed
& HID_CLAIMED_HIDDEV
&& hid
->hiddev_hid_event
)
589 hid
->hiddev_hid_event(hid
, field
, usage
, value
);
594 static void mt_set_input_mode(struct hid_device
*hdev
)
596 struct mt_device
*td
= hid_get_drvdata(hdev
);
597 struct hid_report
*r
;
598 struct hid_report_enum
*re
;
600 if (td
->inputmode
< 0)
603 re
= &(hdev
->report_enum
[HID_FEATURE_REPORT
]);
604 r
= re
->report_id_hash
[td
->inputmode
];
606 r
->field
[0]->value
[td
->inputmode_index
] = 0x02;
607 usbhid_submit_report(hdev
, r
, USB_DIR_OUT
);
611 static void mt_set_maxcontacts(struct hid_device
*hdev
)
613 struct mt_device
*td
= hid_get_drvdata(hdev
);
614 struct hid_report
*r
;
615 struct hid_report_enum
*re
;
618 if (td
->maxcontact_report_id
< 0)
621 if (!td
->mtclass
.maxcontacts
)
624 re
= &hdev
->report_enum
[HID_FEATURE_REPORT
];
625 r
= re
->report_id_hash
[td
->maxcontact_report_id
];
627 max
= td
->mtclass
.maxcontacts
;
628 fieldmax
= r
->field
[0]->logical_maximum
;
629 max
= min(fieldmax
, max
);
630 if (r
->field
[0]->value
[0] != max
) {
631 r
->field
[0]->value
[0] = max
;
632 usbhid_submit_report(hdev
, r
, USB_DIR_OUT
);
637 static void mt_post_parse_default_settings(struct mt_device
*td
)
639 __s32 quirks
= td
->mtclass
.quirks
;
641 /* unknown serial device needs special quirks */
642 if (td
->touches_by_report
== 1) {
643 quirks
|= MT_QUIRK_ALWAYS_VALID
;
644 quirks
&= ~MT_QUIRK_NOT_SEEN_MEANS_UP
;
645 quirks
&= ~MT_QUIRK_VALID_IS_INRANGE
;
646 quirks
&= ~MT_QUIRK_VALID_IS_CONFIDENCE
;
649 td
->mtclass
.quirks
= quirks
;
652 static void mt_post_parse(struct mt_device
*td
)
654 struct mt_fields
*f
= td
->fields
;
656 if (td
->touches_by_report
> 0) {
657 int field_count_per_touch
= f
->length
/ td
->touches_by_report
;
658 td
->last_slot_field
= f
->usages
[field_count_per_touch
- 1];
662 static void mt_input_configured(struct hid_device
*hdev
, struct hid_input
*hi
)
665 struct mt_device
*td
= hid_get_drvdata(hdev
);
666 struct mt_class
*cls
= &td
->mtclass
;
667 struct input_dev
*input
= hi
->input
;
669 /* Only initialize slots for MT input devices */
670 if (!test_bit(ABS_MT_POSITION_X
, input
->absbit
))
673 if (!td
->maxcontacts
)
674 td
->maxcontacts
= MT_DEFAULT_MAXCONTACT
;
677 if (td
->serial_maybe
)
678 mt_post_parse_default_settings(td
);
680 if (cls
->is_indirect
)
681 td
->mt_flags
|= INPUT_MT_POINTER
;
683 if (cls
->quirks
& MT_QUIRK_NOT_SEEN_MEANS_UP
)
684 td
->mt_flags
|= INPUT_MT_DROP_UNUSED
;
686 input_mt_init_slots(input
, td
->maxcontacts
, td
->mt_flags
);
691 static int mt_probe(struct hid_device
*hdev
, const struct hid_device_id
*id
)
694 struct mt_device
*td
;
695 struct mt_class
*mtclass
= mt_classes
; /* MT_CLS_DEFAULT */
697 for (i
= 0; mt_classes
[i
].name
; i
++) {
698 if (id
->driver_data
== mt_classes
[i
].name
) {
699 mtclass
= &(mt_classes
[i
]);
704 /* This allows the driver to correctly support devices
705 * that emit events over several HID messages.
707 hdev
->quirks
|= HID_QUIRK_NO_INPUT_SYNC
;
709 td
= kzalloc(sizeof(struct mt_device
), GFP_KERNEL
);
711 dev_err(&hdev
->dev
, "cannot allocate multitouch data\n");
714 td
->mtclass
= *mtclass
;
716 td
->maxcontact_report_id
= -1;
717 hid_set_drvdata(hdev
, td
);
719 td
->fields
= kzalloc(sizeof(struct mt_fields
), GFP_KERNEL
);
721 dev_err(&hdev
->dev
, "cannot allocate multitouch fields data\n");
726 if (id
->vendor
== HID_ANY_ID
&& id
->product
== HID_ANY_ID
)
727 td
->serial_maybe
= true;
729 ret
= hid_parse(hdev
);
733 ret
= hid_hw_start(hdev
, HID_CONNECT_DEFAULT
);
737 ret
= sysfs_create_group(&hdev
->dev
.kobj
, &mt_attribute_group
);
739 mt_set_maxcontacts(hdev
);
740 mt_set_input_mode(hdev
);
754 static int mt_reset_resume(struct hid_device
*hdev
)
756 mt_set_maxcontacts(hdev
);
757 mt_set_input_mode(hdev
);
761 static int mt_resume(struct hid_device
*hdev
)
763 struct usb_interface
*intf
;
764 struct usb_host_interface
*interface
;
765 struct usb_device
*dev
;
767 if (hdev
->bus
!= BUS_USB
)
770 intf
= to_usb_interface(hdev
->dev
.parent
);
771 interface
= intf
->cur_altsetting
;
772 dev
= hid_to_usb_dev(hdev
);
774 /* Some Elan legacy devices require SET_IDLE to be set on resume.
775 * It should be safe to send it to other devices too.
776 * Tested on 3M, Stantum, Cypress, Zytronic, eGalax, and Elan panels. */
778 usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
780 USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
781 0, interface
->desc
.bInterfaceNumber
,
782 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
788 static void mt_remove(struct hid_device
*hdev
)
790 struct mt_device
*td
= hid_get_drvdata(hdev
);
791 sysfs_remove_group(&hdev
->dev
.kobj
, &mt_attribute_group
);
794 hid_set_drvdata(hdev
, NULL
);
797 static const struct hid_device_id mt_devices
[] = {
800 { .driver_data
= MT_CLS_3M
,
801 MT_USB_DEVICE(USB_VENDOR_ID_3M
,
802 USB_DEVICE_ID_3M1968
) },
803 { .driver_data
= MT_CLS_3M
,
804 MT_USB_DEVICE(USB_VENDOR_ID_3M
,
805 USB_DEVICE_ID_3M2256
) },
806 { .driver_data
= MT_CLS_3M
,
807 MT_USB_DEVICE(USB_VENDOR_ID_3M
,
808 USB_DEVICE_ID_3M3266
) },
810 /* ActionStar panels */
811 { .driver_data
= MT_CLS_DEFAULT
,
812 MT_USB_DEVICE(USB_VENDOR_ID_ACTIONSTAR
,
813 USB_DEVICE_ID_ACTIONSTAR_1011
) },
816 { .driver_data
= MT_CLS_SERIAL
,
817 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL
,
818 USB_DEVICE_ID_ATMEL_MULTITOUCH
) },
819 { .driver_data
= MT_CLS_SERIAL
,
820 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL
,
821 USB_DEVICE_ID_ATMEL_MXT_DIGITIZER
) },
823 /* Baanto multitouch devices */
824 { .driver_data
= MT_CLS_DEFAULT
,
825 MT_USB_DEVICE(USB_VENDOR_ID_BAANTO
,
826 USB_DEVICE_ID_BAANTO_MT_190W2
) },
828 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
829 MT_USB_DEVICE(USB_VENDOR_ID_CANDO
,
830 USB_DEVICE_ID_CANDO_MULTI_TOUCH
) },
831 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
832 MT_USB_DEVICE(USB_VENDOR_ID_CANDO
,
833 USB_DEVICE_ID_CANDO_MULTI_TOUCH_10_1
) },
834 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
835 MT_USB_DEVICE(USB_VENDOR_ID_CANDO
,
836 USB_DEVICE_ID_CANDO_MULTI_TOUCH_11_6
) },
837 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
838 MT_USB_DEVICE(USB_VENDOR_ID_CANDO
,
839 USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6
) },
841 /* Chunghwa Telecom touch panels */
842 { .driver_data
= MT_CLS_DEFAULT
,
843 MT_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT
,
844 USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH
) },
847 { .driver_data
= MT_CLS_DEFAULT
,
848 MT_USB_DEVICE(USB_VENDOR_ID_CVTOUCH
,
849 USB_DEVICE_ID_CVTOUCH_SCREEN
) },
852 { .driver_data
= MT_CLS_CYPRESS
,
853 HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS
,
854 USB_DEVICE_ID_CYPRESS_TRUETOUCH
) },
856 /* eGalax devices (resistive) */
857 { .driver_data
= MT_CLS_EGALAX
,
858 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
859 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D
) },
860 { .driver_data
= MT_CLS_EGALAX
,
861 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
862 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E
) },
864 /* eGalax devices (capacitive) */
865 { .driver_data
= MT_CLS_EGALAX
,
866 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
867 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C
) },
868 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
869 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
870 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7207
) },
871 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
872 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
873 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_725E
) },
874 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
875 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
876 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224
) },
877 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
878 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
879 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_722A
) },
880 { .driver_data
= MT_CLS_EGALAX
,
881 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
882 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B
) },
883 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
884 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
885 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7262
) },
886 { .driver_data
= MT_CLS_EGALAX
,
887 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
888 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1
) },
889 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
890 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
891 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72AA
) },
892 { .driver_data
= MT_CLS_EGALAX
,
893 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
894 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA
) },
895 { .driver_data
= MT_CLS_EGALAX
,
896 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
897 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302
) },
898 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
899 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
900 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7349
) },
901 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
902 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
903 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_73F7
) },
904 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
905 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
906 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001
) },
907 { .driver_data
= MT_CLS_EGALAX
,
908 HID_USB_DEVICE(USB_VENDOR_ID_DWAV
,
909 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224
) },
910 { .driver_data
= MT_CLS_EGALAX
,
911 HID_USB_DEVICE(USB_VENDOR_ID_DWAV
,
912 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72D0
) },
913 { .driver_data
= MT_CLS_EGALAX
,
914 HID_USB_DEVICE(USB_VENDOR_ID_DWAV
,
915 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72C4
) },
917 /* Elo TouchSystems IntelliTouch Plus panel */
918 { .driver_data
= MT_CLS_DUAL_NSMU_CONTACTID
,
919 MT_USB_DEVICE(USB_VENDOR_ID_ELO
,
920 USB_DEVICE_ID_ELO_TS2515
) },
922 /* Flatfrog Panels */
923 { .driver_data
= MT_CLS_FLATFROG
,
924 MT_USB_DEVICE(USB_VENDOR_ID_FLATFROG
,
925 USB_DEVICE_ID_MULTITOUCH_3200
) },
927 /* GeneralTouch panel */
928 { .driver_data
= MT_CLS_GENERALTOUCH_TWOFINGERS
,
929 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH
,
930 USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS
) },
931 { .driver_data
= MT_CLS_GENERALTOUCH_PWT_TENFINGERS
,
932 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH
,
933 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PWT_TENFINGERS
) },
935 /* Gametel game controller */
936 { .driver_data
= MT_CLS_DEFAULT
,
937 MT_BT_DEVICE(USB_VENDOR_ID_FRUCTEL
,
938 USB_DEVICE_ID_GAMETEL_MT_MODE
) },
940 /* GoodTouch panels */
941 { .driver_data
= MT_CLS_DEFAULT
,
942 MT_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH
,
943 USB_DEVICE_ID_GOODTOUCH_000f
) },
946 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTID
,
947 MT_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT
,
948 USB_DEVICE_ID_HANVON_ALT_MULTITOUCH
) },
951 { .driver_data
= MT_CLS_SERIAL
,
952 MT_USB_DEVICE(USB_VENDOR_ID_IDEACOM
,
953 USB_DEVICE_ID_IDEACOM_IDC6650
) },
954 { .driver_data
= MT_CLS_SERIAL
,
955 MT_USB_DEVICE(USB_VENDOR_ID_IDEACOM
,
956 USB_DEVICE_ID_IDEACOM_IDC6651
) },
958 /* Ilitek dual touch panel */
959 { .driver_data
= MT_CLS_DEFAULT
,
960 MT_USB_DEVICE(USB_VENDOR_ID_ILITEK
,
961 USB_DEVICE_ID_ILITEK_MULTITOUCH
) },
964 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTID
,
965 MT_USB_DEVICE(USB_VENDOR_ID_IRTOUCHSYSTEMS
,
966 USB_DEVICE_ID_IRTOUCH_INFRARED_USB
) },
968 /* LG Display panels */
969 { .driver_data
= MT_CLS_DEFAULT
,
970 MT_USB_DEVICE(USB_VENDOR_ID_LG
,
971 USB_DEVICE_ID_LG_MULTITOUCH
) },
974 { .driver_data
= MT_CLS_CONFIDENCE_MINUS_ONE
,
975 MT_USB_DEVICE(USB_VENDOR_ID_LUMIO
,
976 USB_DEVICE_ID_CRYSTALTOUCH
) },
977 { .driver_data
= MT_CLS_CONFIDENCE_MINUS_ONE
,
978 MT_USB_DEVICE(USB_VENDOR_ID_LUMIO
,
979 USB_DEVICE_ID_CRYSTALTOUCH_DUAL
) },
982 { .driver_data
= MT_CLS_CONFIDENCE_MINUS_ONE
,
983 MT_USB_DEVICE(USB_VENDOR_ID_ASUS
,
984 USB_DEVICE_ID_ASUS_T91MT
)},
985 { .driver_data
= MT_CLS_CONFIDENCE_MINUS_ONE
,
986 MT_USB_DEVICE(USB_VENDOR_ID_ASUS
,
987 USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO
) },
988 { .driver_data
= MT_CLS_CONFIDENCE_MINUS_ONE
,
989 MT_USB_DEVICE(USB_VENDOR_ID_TURBOX
,
990 USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART
) },
992 /* Panasonic panels */
993 { .driver_data
= MT_CLS_PANASONIC
,
994 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC
,
995 USB_DEVICE_ID_PANABOARD_UBT780
) },
996 { .driver_data
= MT_CLS_PANASONIC
,
997 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC
,
998 USB_DEVICE_ID_PANABOARD_UBT880
) },
1001 { .driver_data
= MT_CLS_DEFAULT
,
1002 MT_USB_DEVICE(USB_VENDOR_ID_NOVATEK
,
1003 USB_DEVICE_ID_NOVATEK_PCT
) },
1005 /* PenMount panels */
1006 { .driver_data
= MT_CLS_CONFIDENCE
,
1007 MT_USB_DEVICE(USB_VENDOR_ID_PENMOUNT
,
1008 USB_DEVICE_ID_PENMOUNT_PCI
) },
1010 /* PixArt optical touch screen */
1011 { .driver_data
= MT_CLS_INRANGE_CONTACTNUMBER
,
1012 MT_USB_DEVICE(USB_VENDOR_ID_PIXART
,
1013 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN
) },
1014 { .driver_data
= MT_CLS_INRANGE_CONTACTNUMBER
,
1015 MT_USB_DEVICE(USB_VENDOR_ID_PIXART
,
1016 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1
) },
1017 { .driver_data
= MT_CLS_INRANGE_CONTACTNUMBER
,
1018 MT_USB_DEVICE(USB_VENDOR_ID_PIXART
,
1019 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2
) },
1021 /* PixCir-based panels */
1022 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTID
,
1023 MT_USB_DEVICE(USB_VENDOR_ID_HANVON
,
1024 USB_DEVICE_ID_HANVON_MULTITOUCH
) },
1025 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTID
,
1026 MT_USB_DEVICE(USB_VENDOR_ID_CANDO
,
1027 USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH
) },
1029 /* Quanta-based panels */
1030 { .driver_data
= MT_CLS_CONFIDENCE_CONTACT_ID
,
1031 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA
,
1032 USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH
) },
1033 { .driver_data
= MT_CLS_CONFIDENCE_CONTACT_ID
,
1034 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA
,
1035 USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001
) },
1036 { .driver_data
= MT_CLS_CONFIDENCE_CONTACT_ID
,
1037 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA
,
1038 USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3008
) },
1040 /* Stantum panels */
1041 { .driver_data
= MT_CLS_CONFIDENCE
,
1042 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM
,
1043 USB_DEVICE_ID_MTP
)},
1044 { .driver_data
= MT_CLS_CONFIDENCE
,
1045 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM
,
1046 USB_DEVICE_ID_MTP_STM
)},
1047 { .driver_data
= MT_CLS_CONFIDENCE
,
1048 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_SITRONIX
,
1049 USB_DEVICE_ID_MTP_SITRONIX
)},
1051 /* TopSeed panels */
1052 { .driver_data
= MT_CLS_TOPSEED
,
1053 MT_USB_DEVICE(USB_VENDOR_ID_TOPSEED2
,
1054 USB_DEVICE_ID_TOPSEED2_PERIPAD_701
) },
1056 /* Touch International panels */
1057 { .driver_data
= MT_CLS_DEFAULT
,
1058 MT_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL
,
1059 USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH
) },
1062 { .driver_data
= MT_CLS_DEFAULT
,
1063 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC
,
1064 USB_DEVICE_ID_UNITEC_USB_TOUCH_0709
) },
1065 { .driver_data
= MT_CLS_DEFAULT
,
1066 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC
,
1067 USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19
) },
1069 { .driver_data
= MT_CLS_DEFAULT
,
1070 MT_USB_DEVICE(USB_VENDOR_ID_XAT
,
1071 USB_DEVICE_ID_XAT_CSR
) },
1074 { .driver_data
= MT_CLS_DEFAULT
,
1075 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1076 USB_DEVICE_ID_XIROKU_SPX
) },
1077 { .driver_data
= MT_CLS_DEFAULT
,
1078 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1079 USB_DEVICE_ID_XIROKU_MPX
) },
1080 { .driver_data
= MT_CLS_DEFAULT
,
1081 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1082 USB_DEVICE_ID_XIROKU_CSR
) },
1083 { .driver_data
= MT_CLS_DEFAULT
,
1084 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1085 USB_DEVICE_ID_XIROKU_SPX1
) },
1086 { .driver_data
= MT_CLS_DEFAULT
,
1087 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1088 USB_DEVICE_ID_XIROKU_MPX1
) },
1089 { .driver_data
= MT_CLS_DEFAULT
,
1090 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1091 USB_DEVICE_ID_XIROKU_CSR1
) },
1092 { .driver_data
= MT_CLS_DEFAULT
,
1093 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1094 USB_DEVICE_ID_XIROKU_SPX2
) },
1095 { .driver_data
= MT_CLS_DEFAULT
,
1096 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1097 USB_DEVICE_ID_XIROKU_MPX2
) },
1098 { .driver_data
= MT_CLS_DEFAULT
,
1099 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1100 USB_DEVICE_ID_XIROKU_CSR2
) },
1102 /* Zytronic panels */
1103 { .driver_data
= MT_CLS_SERIAL
,
1104 MT_USB_DEVICE(USB_VENDOR_ID_ZYTRONIC
,
1105 USB_DEVICE_ID_ZYTRONIC_ZXY100
) },
1107 /* Generic MT device */
1108 { HID_DEVICE(HID_BUS_ANY
, HID_GROUP_MULTITOUCH
, HID_ANY_ID
, HID_ANY_ID
) },
1111 MODULE_DEVICE_TABLE(hid
, mt_devices
);
1113 static const struct hid_usage_id mt_grabbed_usages
[] = {
1114 { HID_ANY_ID
, HID_ANY_ID
, HID_ANY_ID
},
1115 { HID_ANY_ID
- 1, HID_ANY_ID
- 1, HID_ANY_ID
- 1}
1118 static struct hid_driver mt_driver
= {
1119 .name
= "hid-multitouch",
1120 .id_table
= mt_devices
,
1122 .remove
= mt_remove
,
1123 .input_mapping
= mt_input_mapping
,
1124 .input_mapped
= mt_input_mapped
,
1125 .input_configured
= mt_input_configured
,
1126 .feature_mapping
= mt_feature_mapping
,
1127 .usage_table
= mt_grabbed_usages
,
1130 .reset_resume
= mt_reset_resume
,
1131 .resume
= mt_resume
,
1135 static int __init
mt_init(void)
1137 return hid_register_driver(&mt_driver
);
1140 static void __exit
mt_exit(void)
1142 hid_unregister_driver(&mt_driver
);
1145 module_init(mt_init
);
1146 module_exit(mt_exit
);