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
,
217 { .name
= MT_CLS_FLATFROG
,
218 .quirks
= MT_QUIRK_NOT_SEEN_MEANS_UP
|
226 static ssize_t
mt_show_quirks(struct device
*dev
,
227 struct device_attribute
*attr
,
230 struct hid_device
*hdev
= container_of(dev
, struct hid_device
, dev
);
231 struct mt_device
*td
= hid_get_drvdata(hdev
);
233 return sprintf(buf
, "%u\n", td
->mtclass
.quirks
);
236 static ssize_t
mt_set_quirks(struct device
*dev
,
237 struct device_attribute
*attr
,
238 const char *buf
, size_t count
)
240 struct hid_device
*hdev
= container_of(dev
, struct hid_device
, dev
);
241 struct mt_device
*td
= hid_get_drvdata(hdev
);
245 if (kstrtoul(buf
, 0, &val
))
248 td
->mtclass
.quirks
= val
;
253 static DEVICE_ATTR(quirks
, S_IWUSR
| S_IRUGO
, mt_show_quirks
, mt_set_quirks
);
255 static struct attribute
*sysfs_attrs
[] = {
256 &dev_attr_quirks
.attr
,
260 static struct attribute_group mt_attribute_group
= {
264 static void mt_feature_mapping(struct hid_device
*hdev
,
265 struct hid_field
*field
, struct hid_usage
*usage
)
267 struct mt_device
*td
= hid_get_drvdata(hdev
);
270 switch (usage
->hid
) {
271 case HID_DG_INPUTMODE
:
272 td
->inputmode
= field
->report
->id
;
273 td
->inputmode_index
= 0; /* has to be updated below */
275 for (i
=0; i
< field
->maxusage
; i
++) {
276 if (field
->usage
[i
].hid
== usage
->hid
) {
277 td
->inputmode_index
= i
;
283 case HID_DG_CONTACTMAX
:
284 td
->maxcontact_report_id
= field
->report
->id
;
285 td
->maxcontacts
= field
->value
[0];
286 if (td
->mtclass
.maxcontacts
)
287 /* check if the maxcontacts is given by the class */
288 td
->maxcontacts
= td
->mtclass
.maxcontacts
;
294 static void set_abs(struct input_dev
*input
, unsigned int code
,
295 struct hid_field
*field
, int snratio
)
297 int fmin
= field
->logical_minimum
;
298 int fmax
= field
->logical_maximum
;
299 int fuzz
= snratio
? (fmax
- fmin
) / snratio
: 0;
300 input_set_abs_params(input
, code
, fmin
, fmax
, fuzz
, 0);
303 static void mt_store_field(struct hid_usage
*usage
, struct mt_device
*td
,
304 struct hid_input
*hi
)
306 struct mt_fields
*f
= td
->fields
;
308 if (f
->length
>= HID_MAX_FIELDS
)
311 f
->usages
[f
->length
++] = usage
->hid
;
314 static int mt_input_mapping(struct hid_device
*hdev
, struct hid_input
*hi
,
315 struct hid_field
*field
, struct hid_usage
*usage
,
316 unsigned long **bit
, int *max
)
318 struct mt_device
*td
= hid_get_drvdata(hdev
);
319 struct mt_class
*cls
= &td
->mtclass
;
322 /* Only map fields from TouchScreen or TouchPad collections.
323 * We need to ignore fields that belong to other collections
324 * such as Mouse that might have the same GenericDesktop usages. */
325 if (field
->application
== HID_DG_TOUCHSCREEN
)
326 td
->mt_flags
|= INPUT_MT_DIRECT
;
327 else if (field
->application
!= HID_DG_TOUCHPAD
)
331 * Model touchscreens providing buttons as touchpads.
333 if (field
->application
== HID_DG_TOUCHPAD
||
334 (usage
->hid
& HID_USAGE_PAGE
) == HID_UP_BUTTON
)
335 td
->mt_flags
|= INPUT_MT_POINTER
;
337 /* eGalax devices provide a Digitizer.Stylus input which overrides
338 * the correct Digitizers.Finger X/Y ranges.
339 * Let's just ignore this input. */
340 if (field
->physical
== HID_DG_STYLUS
)
343 switch (usage
->hid
& HID_USAGE_PAGE
) {
346 switch (usage
->hid
) {
348 hid_map_usage(hi
, usage
, bit
, max
,
349 EV_ABS
, ABS_MT_POSITION_X
);
350 set_abs(hi
->input
, ABS_MT_POSITION_X
, field
,
352 mt_store_field(usage
, td
, hi
);
353 td
->last_field_index
= field
->index
;
356 hid_map_usage(hi
, usage
, bit
, max
,
357 EV_ABS
, ABS_MT_POSITION_Y
);
358 set_abs(hi
->input
, ABS_MT_POSITION_Y
, field
,
360 mt_store_field(usage
, td
, hi
);
361 td
->last_field_index
= field
->index
;
366 case HID_UP_DIGITIZER
:
367 switch (usage
->hid
) {
369 mt_store_field(usage
, td
, hi
);
370 td
->last_field_index
= field
->index
;
372 case HID_DG_CONFIDENCE
:
373 mt_store_field(usage
, td
, hi
);
374 td
->last_field_index
= field
->index
;
376 case HID_DG_TIPSWITCH
:
377 hid_map_usage(hi
, usage
, bit
, max
, EV_KEY
, BTN_TOUCH
);
378 input_set_capability(hi
->input
, EV_KEY
, BTN_TOUCH
);
379 mt_store_field(usage
, td
, hi
);
380 td
->last_field_index
= field
->index
;
382 case HID_DG_CONTACTID
:
383 mt_store_field(usage
, td
, hi
);
384 td
->last_field_index
= field
->index
;
385 td
->touches_by_report
++;
388 hid_map_usage(hi
, usage
, bit
, max
,
389 EV_ABS
, ABS_MT_TOUCH_MAJOR
);
390 if (!(cls
->quirks
& MT_QUIRK_NO_AREA
))
391 set_abs(hi
->input
, ABS_MT_TOUCH_MAJOR
, field
,
393 mt_store_field(usage
, td
, hi
);
394 td
->last_field_index
= field
->index
;
397 hid_map_usage(hi
, usage
, bit
, max
,
398 EV_ABS
, ABS_MT_TOUCH_MINOR
);
399 if (!(cls
->quirks
& MT_QUIRK_NO_AREA
)) {
400 set_abs(hi
->input
, ABS_MT_TOUCH_MINOR
, field
,
402 input_set_abs_params(hi
->input
,
403 ABS_MT_ORIENTATION
, 0, 1, 0, 0);
405 mt_store_field(usage
, td
, hi
);
406 td
->last_field_index
= field
->index
;
408 case HID_DG_TIPPRESSURE
:
409 hid_map_usage(hi
, usage
, bit
, max
,
410 EV_ABS
, ABS_MT_PRESSURE
);
411 set_abs(hi
->input
, ABS_MT_PRESSURE
, field
,
413 mt_store_field(usage
, td
, hi
);
414 td
->last_field_index
= field
->index
;
416 case HID_DG_CONTACTCOUNT
:
417 td
->last_field_index
= field
->index
;
419 case HID_DG_CONTACTMAX
:
420 /* we don't set td->last_slot_field as contactcount and
421 * contact max are global to the report */
422 td
->last_field_index
= field
->index
;
426 /* Legacy devices use TIPSWITCH and not TOUCH.
427 * Let's just ignore this field. */
429 /* let hid-input decide for the others */
433 code
= BTN_MOUSE
+ ((usage
->hid
- 1) & HID_USAGE
);
434 hid_map_usage(hi
, usage
, bit
, max
, EV_KEY
, code
);
435 input_set_capability(hi
->input
, EV_KEY
, code
);
439 /* we do not want to map these: no input-oriented meaning */
446 static int mt_input_mapped(struct hid_device
*hdev
, struct hid_input
*hi
,
447 struct hid_field
*field
, struct hid_usage
*usage
,
448 unsigned long **bit
, int *max
)
450 if (usage
->type
== EV_KEY
|| usage
->type
== EV_ABS
)
451 set_bit(usage
->type
, hi
->input
->evbit
);
456 static int mt_compute_slot(struct mt_device
*td
, struct input_dev
*input
)
458 __s32 quirks
= td
->mtclass
.quirks
;
460 if (quirks
& MT_QUIRK_SLOT_IS_CONTACTID
)
461 return td
->curdata
.contactid
;
463 if (quirks
& MT_QUIRK_CYPRESS
)
464 return cypress_compute_slot(td
);
466 if (quirks
& MT_QUIRK_SLOT_IS_CONTACTNUMBER
)
467 return td
->num_received
;
469 if (quirks
& MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE
)
470 return td
->curdata
.contactid
- 1;
472 return input_mt_get_slot_by_key(input
, td
->curdata
.contactid
);
476 * this function is called when a whole contact has been processed,
477 * so that it can assign it to a slot and store the data there
479 static void mt_complete_slot(struct mt_device
*td
, struct input_dev
*input
)
482 int slotnum
= mt_compute_slot(td
, input
);
483 struct mt_slot
*s
= &td
->curdata
;
485 if (slotnum
< 0 || slotnum
>= td
->maxcontacts
)
488 input_mt_slot(input
, slotnum
);
489 input_mt_report_slot_state(input
, MT_TOOL_FINGER
,
491 if (s
->touch_state
) {
492 /* this finger is on the screen */
493 int wide
= (s
->w
> s
->h
);
494 /* divided by two to match visual scale of touch */
495 int major
= max(s
->w
, s
->h
) >> 1;
496 int minor
= min(s
->w
, s
->h
) >> 1;
498 input_event(input
, EV_ABS
, ABS_MT_POSITION_X
, s
->x
);
499 input_event(input
, EV_ABS
, ABS_MT_POSITION_Y
, s
->y
);
500 input_event(input
, EV_ABS
, ABS_MT_ORIENTATION
, wide
);
501 input_event(input
, EV_ABS
, ABS_MT_PRESSURE
, s
->p
);
502 input_event(input
, EV_ABS
, ABS_MT_TOUCH_MAJOR
, major
);
503 input_event(input
, EV_ABS
, ABS_MT_TOUCH_MINOR
, minor
);
511 * this function is called when a whole packet has been received and processed,
512 * so that it can decide what to send to the input layer.
514 static void mt_sync_frame(struct mt_device
*td
, struct input_dev
*input
)
516 input_mt_sync_frame(input
);
518 td
->num_received
= 0;
521 static int mt_event(struct hid_device
*hid
, struct hid_field
*field
,
522 struct hid_usage
*usage
, __s32 value
)
524 struct mt_device
*td
= hid_get_drvdata(hid
);
525 __s32 quirks
= td
->mtclass
.quirks
;
527 if (hid
->claimed
& HID_CLAIMED_INPUT
) {
528 switch (usage
->hid
) {
530 if (quirks
& MT_QUIRK_ALWAYS_VALID
)
532 else if (quirks
& MT_QUIRK_VALID_IS_INRANGE
)
533 td
->curvalid
= value
;
535 case HID_DG_TIPSWITCH
:
536 if (quirks
& MT_QUIRK_NOT_SEEN_MEANS_UP
)
537 td
->curvalid
= value
;
538 td
->curdata
.touch_state
= value
;
540 case HID_DG_CONFIDENCE
:
541 if (quirks
& MT_QUIRK_VALID_IS_CONFIDENCE
)
542 td
->curvalid
= value
;
544 case HID_DG_CONTACTID
:
545 td
->curdata
.contactid
= value
;
547 case HID_DG_TIPPRESSURE
:
548 td
->curdata
.p
= value
;
551 td
->curdata
.x
= value
;
554 td
->curdata
.y
= value
;
557 td
->curdata
.w
= value
;
560 td
->curdata
.h
= value
;
562 case HID_DG_CONTACTCOUNT
:
564 * Includes multi-packet support where subsequent
565 * packets are sent with zero contactcount.
568 td
->num_expected
= value
;
575 /* fallback to the generic hidinput handling */
579 if (usage
->hid
== td
->last_slot_field
)
580 mt_complete_slot(td
, field
->hidinput
->input
);
582 if (field
->index
== td
->last_field_index
583 && td
->num_received
>= td
->num_expected
)
584 mt_sync_frame(td
, field
->hidinput
->input
);
588 /* we have handled the hidinput part, now remains hiddev */
589 if (hid
->claimed
& HID_CLAIMED_HIDDEV
&& hid
->hiddev_hid_event
)
590 hid
->hiddev_hid_event(hid
, field
, usage
, value
);
595 static void mt_set_input_mode(struct hid_device
*hdev
)
597 struct mt_device
*td
= hid_get_drvdata(hdev
);
598 struct hid_report
*r
;
599 struct hid_report_enum
*re
;
601 if (td
->inputmode
< 0)
604 re
= &(hdev
->report_enum
[HID_FEATURE_REPORT
]);
605 r
= re
->report_id_hash
[td
->inputmode
];
607 r
->field
[0]->value
[td
->inputmode_index
] = 0x02;
608 usbhid_submit_report(hdev
, r
, USB_DIR_OUT
);
612 static void mt_set_maxcontacts(struct hid_device
*hdev
)
614 struct mt_device
*td
= hid_get_drvdata(hdev
);
615 struct hid_report
*r
;
616 struct hid_report_enum
*re
;
619 if (td
->maxcontact_report_id
< 0)
622 if (!td
->mtclass
.maxcontacts
)
625 re
= &hdev
->report_enum
[HID_FEATURE_REPORT
];
626 r
= re
->report_id_hash
[td
->maxcontact_report_id
];
628 max
= td
->mtclass
.maxcontacts
;
629 fieldmax
= r
->field
[0]->logical_maximum
;
630 max
= min(fieldmax
, max
);
631 if (r
->field
[0]->value
[0] != max
) {
632 r
->field
[0]->value
[0] = max
;
633 usbhid_submit_report(hdev
, r
, USB_DIR_OUT
);
638 static void mt_post_parse_default_settings(struct mt_device
*td
)
640 __s32 quirks
= td
->mtclass
.quirks
;
642 /* unknown serial device needs special quirks */
643 if (td
->touches_by_report
== 1) {
644 quirks
|= MT_QUIRK_ALWAYS_VALID
;
645 quirks
&= ~MT_QUIRK_NOT_SEEN_MEANS_UP
;
646 quirks
&= ~MT_QUIRK_VALID_IS_INRANGE
;
647 quirks
&= ~MT_QUIRK_VALID_IS_CONFIDENCE
;
650 td
->mtclass
.quirks
= quirks
;
653 static void mt_post_parse(struct mt_device
*td
)
655 struct mt_fields
*f
= td
->fields
;
657 if (td
->touches_by_report
> 0) {
658 int field_count_per_touch
= f
->length
/ td
->touches_by_report
;
659 td
->last_slot_field
= f
->usages
[field_count_per_touch
- 1];
663 static void mt_input_configured(struct hid_device
*hdev
, struct hid_input
*hi
)
666 struct mt_device
*td
= hid_get_drvdata(hdev
);
667 struct mt_class
*cls
= &td
->mtclass
;
668 struct input_dev
*input
= hi
->input
;
670 /* Only initialize slots for MT input devices */
671 if (!test_bit(ABS_MT_POSITION_X
, input
->absbit
))
674 if (!td
->maxcontacts
)
675 td
->maxcontacts
= MT_DEFAULT_MAXCONTACT
;
678 if (td
->serial_maybe
)
679 mt_post_parse_default_settings(td
);
681 if (cls
->is_indirect
)
682 td
->mt_flags
|= INPUT_MT_POINTER
;
684 if (cls
->quirks
& MT_QUIRK_NOT_SEEN_MEANS_UP
)
685 td
->mt_flags
|= INPUT_MT_DROP_UNUSED
;
687 input_mt_init_slots(input
, td
->maxcontacts
, td
->mt_flags
);
692 static int mt_probe(struct hid_device
*hdev
, const struct hid_device_id
*id
)
695 struct mt_device
*td
;
696 struct mt_class
*mtclass
= mt_classes
; /* MT_CLS_DEFAULT */
698 for (i
= 0; mt_classes
[i
].name
; i
++) {
699 if (id
->driver_data
== mt_classes
[i
].name
) {
700 mtclass
= &(mt_classes
[i
]);
705 /* This allows the driver to correctly support devices
706 * that emit events over several HID messages.
708 hdev
->quirks
|= HID_QUIRK_NO_INPUT_SYNC
;
710 td
= kzalloc(sizeof(struct mt_device
), GFP_KERNEL
);
712 dev_err(&hdev
->dev
, "cannot allocate multitouch data\n");
715 td
->mtclass
= *mtclass
;
717 td
->maxcontact_report_id
= -1;
718 hid_set_drvdata(hdev
, td
);
720 td
->fields
= kzalloc(sizeof(struct mt_fields
), GFP_KERNEL
);
722 dev_err(&hdev
->dev
, "cannot allocate multitouch fields data\n");
727 if (id
->vendor
== HID_ANY_ID
&& id
->product
== HID_ANY_ID
)
728 td
->serial_maybe
= true;
730 ret
= hid_parse(hdev
);
734 ret
= hid_hw_start(hdev
, HID_CONNECT_DEFAULT
);
738 ret
= sysfs_create_group(&hdev
->dev
.kobj
, &mt_attribute_group
);
740 mt_set_maxcontacts(hdev
);
741 mt_set_input_mode(hdev
);
755 static int mt_reset_resume(struct hid_device
*hdev
)
757 mt_set_maxcontacts(hdev
);
758 mt_set_input_mode(hdev
);
762 static int mt_resume(struct hid_device
*hdev
)
764 struct usb_interface
*intf
;
765 struct usb_host_interface
*interface
;
766 struct usb_device
*dev
;
768 if (hdev
->bus
!= BUS_USB
)
771 intf
= to_usb_interface(hdev
->dev
.parent
);
772 interface
= intf
->cur_altsetting
;
773 dev
= hid_to_usb_dev(hdev
);
775 /* Some Elan legacy devices require SET_IDLE to be set on resume.
776 * It should be safe to send it to other devices too.
777 * Tested on 3M, Stantum, Cypress, Zytronic, eGalax, and Elan panels. */
779 usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
781 USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
782 0, interface
->desc
.bInterfaceNumber
,
783 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
789 static void mt_remove(struct hid_device
*hdev
)
791 struct mt_device
*td
= hid_get_drvdata(hdev
);
792 sysfs_remove_group(&hdev
->dev
.kobj
, &mt_attribute_group
);
795 hid_set_drvdata(hdev
, NULL
);
798 static const struct hid_device_id mt_devices
[] = {
801 { .driver_data
= MT_CLS_3M
,
802 MT_USB_DEVICE(USB_VENDOR_ID_3M
,
803 USB_DEVICE_ID_3M1968
) },
804 { .driver_data
= MT_CLS_3M
,
805 MT_USB_DEVICE(USB_VENDOR_ID_3M
,
806 USB_DEVICE_ID_3M2256
) },
807 { .driver_data
= MT_CLS_3M
,
808 MT_USB_DEVICE(USB_VENDOR_ID_3M
,
809 USB_DEVICE_ID_3M3266
) },
811 /* ActionStar panels */
812 { .driver_data
= MT_CLS_DEFAULT
,
813 MT_USB_DEVICE(USB_VENDOR_ID_ACTIONSTAR
,
814 USB_DEVICE_ID_ACTIONSTAR_1011
) },
817 { .driver_data
= MT_CLS_SERIAL
,
818 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL
,
819 USB_DEVICE_ID_ATMEL_MULTITOUCH
) },
820 { .driver_data
= MT_CLS_SERIAL
,
821 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL
,
822 USB_DEVICE_ID_ATMEL_MXT_DIGITIZER
) },
824 /* Baanto multitouch devices */
825 { .driver_data
= MT_CLS_DEFAULT
,
826 MT_USB_DEVICE(USB_VENDOR_ID_BAANTO
,
827 USB_DEVICE_ID_BAANTO_MT_190W2
) },
829 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
830 MT_USB_DEVICE(USB_VENDOR_ID_CANDO
,
831 USB_DEVICE_ID_CANDO_MULTI_TOUCH
) },
832 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
833 MT_USB_DEVICE(USB_VENDOR_ID_CANDO
,
834 USB_DEVICE_ID_CANDO_MULTI_TOUCH_10_1
) },
835 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
836 MT_USB_DEVICE(USB_VENDOR_ID_CANDO
,
837 USB_DEVICE_ID_CANDO_MULTI_TOUCH_11_6
) },
838 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
839 MT_USB_DEVICE(USB_VENDOR_ID_CANDO
,
840 USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6
) },
842 /* Chunghwa Telecom touch panels */
843 { .driver_data
= MT_CLS_DEFAULT
,
844 MT_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT
,
845 USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH
) },
848 { .driver_data
= MT_CLS_DEFAULT
,
849 MT_USB_DEVICE(USB_VENDOR_ID_CVTOUCH
,
850 USB_DEVICE_ID_CVTOUCH_SCREEN
) },
853 { .driver_data
= MT_CLS_CYPRESS
,
854 HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS
,
855 USB_DEVICE_ID_CYPRESS_TRUETOUCH
) },
857 /* eGalax devices (resistive) */
858 { .driver_data
= MT_CLS_EGALAX
,
859 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
860 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D
) },
861 { .driver_data
= MT_CLS_EGALAX
,
862 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
863 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E
) },
865 /* eGalax devices (capacitive) */
866 { .driver_data
= MT_CLS_EGALAX
,
867 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
868 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C
) },
869 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
870 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
871 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7207
) },
872 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
873 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
874 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_725E
) },
875 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
876 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
877 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224
) },
878 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
879 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
880 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_722A
) },
881 { .driver_data
= MT_CLS_EGALAX
,
882 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
883 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B
) },
884 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
885 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
886 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7262
) },
887 { .driver_data
= MT_CLS_EGALAX
,
888 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
889 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1
) },
890 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
891 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
892 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72AA
) },
893 { .driver_data
= MT_CLS_EGALAX
,
894 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
895 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA
) },
896 { .driver_data
= MT_CLS_EGALAX
,
897 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
898 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302
) },
899 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
900 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
901 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7349
) },
902 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
903 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
904 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_73F7
) },
905 { .driver_data
= MT_CLS_EGALAX_SERIAL
,
906 MT_USB_DEVICE(USB_VENDOR_ID_DWAV
,
907 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001
) },
908 { .driver_data
= MT_CLS_EGALAX
,
909 HID_USB_DEVICE(USB_VENDOR_ID_DWAV
,
910 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224
) },
911 { .driver_data
= MT_CLS_EGALAX
,
912 HID_USB_DEVICE(USB_VENDOR_ID_DWAV
,
913 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72D0
) },
914 { .driver_data
= MT_CLS_EGALAX
,
915 HID_USB_DEVICE(USB_VENDOR_ID_DWAV
,
916 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72C4
) },
918 /* Elo TouchSystems IntelliTouch Plus panel */
919 { .driver_data
= MT_CLS_DUAL_NSMU_CONTACTID
,
920 MT_USB_DEVICE(USB_VENDOR_ID_ELO
,
921 USB_DEVICE_ID_ELO_TS2515
) },
923 /* Flatfrog Panels */
924 { .driver_data
= MT_CLS_FLATFROG
,
925 MT_USB_DEVICE(USB_VENDOR_ID_FLATFROG
,
926 USB_DEVICE_ID_MULTITOUCH_3200
) },
928 /* GeneralTouch panel */
929 { .driver_data
= MT_CLS_GENERALTOUCH_TWOFINGERS
,
930 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH
,
931 USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS
) },
932 { .driver_data
= MT_CLS_GENERALTOUCH_PWT_TENFINGERS
,
933 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH
,
934 USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PWT_TENFINGERS
) },
936 /* Gametel game controller */
937 { .driver_data
= MT_CLS_DEFAULT
,
938 MT_BT_DEVICE(USB_VENDOR_ID_FRUCTEL
,
939 USB_DEVICE_ID_GAMETEL_MT_MODE
) },
941 /* GoodTouch panels */
942 { .driver_data
= MT_CLS_DEFAULT
,
943 MT_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH
,
944 USB_DEVICE_ID_GOODTOUCH_000f
) },
947 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTID
,
948 MT_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT
,
949 USB_DEVICE_ID_HANVON_ALT_MULTITOUCH
) },
952 { .driver_data
= MT_CLS_SERIAL
,
953 MT_USB_DEVICE(USB_VENDOR_ID_IDEACOM
,
954 USB_DEVICE_ID_IDEACOM_IDC6650
) },
955 { .driver_data
= MT_CLS_SERIAL
,
956 MT_USB_DEVICE(USB_VENDOR_ID_IDEACOM
,
957 USB_DEVICE_ID_IDEACOM_IDC6651
) },
959 /* Ilitek dual touch panel */
960 { .driver_data
= MT_CLS_DEFAULT
,
961 MT_USB_DEVICE(USB_VENDOR_ID_ILITEK
,
962 USB_DEVICE_ID_ILITEK_MULTITOUCH
) },
965 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTID
,
966 MT_USB_DEVICE(USB_VENDOR_ID_IRTOUCHSYSTEMS
,
967 USB_DEVICE_ID_IRTOUCH_INFRARED_USB
) },
969 /* LG Display panels */
970 { .driver_data
= MT_CLS_DEFAULT
,
971 MT_USB_DEVICE(USB_VENDOR_ID_LG
,
972 USB_DEVICE_ID_LG_MULTITOUCH
) },
975 { .driver_data
= MT_CLS_CONFIDENCE_MINUS_ONE
,
976 MT_USB_DEVICE(USB_VENDOR_ID_LUMIO
,
977 USB_DEVICE_ID_CRYSTALTOUCH
) },
978 { .driver_data
= MT_CLS_CONFIDENCE_MINUS_ONE
,
979 MT_USB_DEVICE(USB_VENDOR_ID_LUMIO
,
980 USB_DEVICE_ID_CRYSTALTOUCH_DUAL
) },
983 { .driver_data
= MT_CLS_CONFIDENCE_MINUS_ONE
,
984 MT_USB_DEVICE(USB_VENDOR_ID_ASUS
,
985 USB_DEVICE_ID_ASUS_T91MT
)},
986 { .driver_data
= MT_CLS_CONFIDENCE_MINUS_ONE
,
987 MT_USB_DEVICE(USB_VENDOR_ID_ASUS
,
988 USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO
) },
989 { .driver_data
= MT_CLS_CONFIDENCE_MINUS_ONE
,
990 MT_USB_DEVICE(USB_VENDOR_ID_TURBOX
,
991 USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART
) },
993 /* Panasonic panels */
994 { .driver_data
= MT_CLS_PANASONIC
,
995 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC
,
996 USB_DEVICE_ID_PANABOARD_UBT780
) },
997 { .driver_data
= MT_CLS_PANASONIC
,
998 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC
,
999 USB_DEVICE_ID_PANABOARD_UBT880
) },
1002 { .driver_data
= MT_CLS_DEFAULT
,
1003 MT_USB_DEVICE(USB_VENDOR_ID_NOVATEK
,
1004 USB_DEVICE_ID_NOVATEK_PCT
) },
1006 /* PenMount panels */
1007 { .driver_data
= MT_CLS_CONFIDENCE
,
1008 MT_USB_DEVICE(USB_VENDOR_ID_PENMOUNT
,
1009 USB_DEVICE_ID_PENMOUNT_PCI
) },
1011 /* PixArt optical touch screen */
1012 { .driver_data
= MT_CLS_INRANGE_CONTACTNUMBER
,
1013 MT_USB_DEVICE(USB_VENDOR_ID_PIXART
,
1014 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN
) },
1015 { .driver_data
= MT_CLS_INRANGE_CONTACTNUMBER
,
1016 MT_USB_DEVICE(USB_VENDOR_ID_PIXART
,
1017 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1
) },
1018 { .driver_data
= MT_CLS_INRANGE_CONTACTNUMBER
,
1019 MT_USB_DEVICE(USB_VENDOR_ID_PIXART
,
1020 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2
) },
1022 /* PixCir-based panels */
1023 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTID
,
1024 MT_USB_DEVICE(USB_VENDOR_ID_HANVON
,
1025 USB_DEVICE_ID_HANVON_MULTITOUCH
) },
1026 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTID
,
1027 MT_USB_DEVICE(USB_VENDOR_ID_CANDO
,
1028 USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH
) },
1030 /* Quanta-based panels */
1031 { .driver_data
= MT_CLS_CONFIDENCE_CONTACT_ID
,
1032 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA
,
1033 USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH
) },
1034 { .driver_data
= MT_CLS_CONFIDENCE_CONTACT_ID
,
1035 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA
,
1036 USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001
) },
1037 { .driver_data
= MT_CLS_CONFIDENCE_CONTACT_ID
,
1038 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA
,
1039 USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3008
) },
1041 /* Stantum panels */
1042 { .driver_data
= MT_CLS_CONFIDENCE
,
1043 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM
,
1044 USB_DEVICE_ID_MTP
)},
1045 { .driver_data
= MT_CLS_CONFIDENCE
,
1046 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM
,
1047 USB_DEVICE_ID_MTP_STM
)},
1048 { .driver_data
= MT_CLS_CONFIDENCE
,
1049 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_SITRONIX
,
1050 USB_DEVICE_ID_MTP_SITRONIX
)},
1052 /* TopSeed panels */
1053 { .driver_data
= MT_CLS_TOPSEED
,
1054 MT_USB_DEVICE(USB_VENDOR_ID_TOPSEED2
,
1055 USB_DEVICE_ID_TOPSEED2_PERIPAD_701
) },
1057 /* Touch International panels */
1058 { .driver_data
= MT_CLS_DEFAULT
,
1059 MT_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL
,
1060 USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH
) },
1063 { .driver_data
= MT_CLS_DEFAULT
,
1064 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC
,
1065 USB_DEVICE_ID_UNITEC_USB_TOUCH_0709
) },
1066 { .driver_data
= MT_CLS_DEFAULT
,
1067 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC
,
1068 USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19
) },
1070 { .driver_data
= MT_CLS_DEFAULT
,
1071 MT_USB_DEVICE(USB_VENDOR_ID_XAT
,
1072 USB_DEVICE_ID_XAT_CSR
) },
1075 { .driver_data
= MT_CLS_DEFAULT
,
1076 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1077 USB_DEVICE_ID_XIROKU_SPX
) },
1078 { .driver_data
= MT_CLS_DEFAULT
,
1079 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1080 USB_DEVICE_ID_XIROKU_MPX
) },
1081 { .driver_data
= MT_CLS_DEFAULT
,
1082 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1083 USB_DEVICE_ID_XIROKU_CSR
) },
1084 { .driver_data
= MT_CLS_DEFAULT
,
1085 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1086 USB_DEVICE_ID_XIROKU_SPX1
) },
1087 { .driver_data
= MT_CLS_DEFAULT
,
1088 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1089 USB_DEVICE_ID_XIROKU_MPX1
) },
1090 { .driver_data
= MT_CLS_DEFAULT
,
1091 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1092 USB_DEVICE_ID_XIROKU_CSR1
) },
1093 { .driver_data
= MT_CLS_DEFAULT
,
1094 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1095 USB_DEVICE_ID_XIROKU_SPX2
) },
1096 { .driver_data
= MT_CLS_DEFAULT
,
1097 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1098 USB_DEVICE_ID_XIROKU_MPX2
) },
1099 { .driver_data
= MT_CLS_DEFAULT
,
1100 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU
,
1101 USB_DEVICE_ID_XIROKU_CSR2
) },
1103 /* Zytronic panels */
1104 { .driver_data
= MT_CLS_SERIAL
,
1105 MT_USB_DEVICE(USB_VENDOR_ID_ZYTRONIC
,
1106 USB_DEVICE_ID_ZYTRONIC_ZXY100
) },
1108 /* Generic MT device */
1109 { HID_DEVICE(HID_BUS_ANY
, HID_GROUP_MULTITOUCH
, HID_ANY_ID
, HID_ANY_ID
) },
1112 MODULE_DEVICE_TABLE(hid
, mt_devices
);
1114 static const struct hid_usage_id mt_grabbed_usages
[] = {
1115 { HID_ANY_ID
, HID_ANY_ID
, HID_ANY_ID
},
1116 { HID_ANY_ID
- 1, HID_ANY_ID
- 1, HID_ANY_ID
- 1}
1119 static struct hid_driver mt_driver
= {
1120 .name
= "hid-multitouch",
1121 .id_table
= mt_devices
,
1123 .remove
= mt_remove
,
1124 .input_mapping
= mt_input_mapping
,
1125 .input_mapped
= mt_input_mapped
,
1126 .input_configured
= mt_input_configured
,
1127 .feature_mapping
= mt_feature_mapping
,
1128 .usage_table
= mt_grabbed_usages
,
1131 .reset_resume
= mt_reset_resume
,
1132 .resume
= mt_resume
,
1136 static int __init
mt_init(void)
1138 return hid_register_driver(&mt_driver
);
1141 static void __exit
mt_exit(void)
1143 hid_unregister_driver(&mt_driver
);
1146 module_init(mt_init
);
1147 module_exit(mt_exit
);