2 * HID driver for multitouch panels
4 * Copyright (c) 2010-2011 Stephane Chatty <chatty@enac.fr>
5 * Copyright (c) 2010-2011 Benjamin Tissoires <benjamin.tissoires@gmail.com>
6 * Copyright (c) 2010-2011 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_VALID_IS_INRANGE (1 << 4)
51 #define MT_QUIRK_VALID_IS_CONFIDENCE (1 << 5)
52 #define MT_QUIRK_EGALAX_XYZ_FIXUP (1 << 6)
56 __s32 contactid
; /* the device ContactID assigned to this slot */
57 bool touch_state
; /* is the touch valid? */
58 bool seen_in_this_frame
;/* has this slot been updated */
62 struct mt_slot curdata
; /* placeholder of incoming data */
63 struct mt_class
*mtclass
; /* our mt device class */
64 unsigned last_field_index
; /* last field index of the report */
65 unsigned last_slot_field
; /* the last field of a slot */
66 __s8 inputmode
; /* InputMode HID feature, -1 if non-existent */
67 __u8 num_received
; /* how many contacts we received */
68 __u8 num_expected
; /* expected last contact index */
70 bool curvalid
; /* is the current contact valid? */
71 struct mt_slot
*slots
;
75 __s32 name
; /* MT_CLS */
77 __s32 sn_move
; /* Signal/noise ratio for move events */
78 __s32 sn_width
; /* Signal/noise ratio for width events */
79 __s32 sn_height
; /* Signal/noise ratio for height events */
80 __s32 sn_pressure
; /* Signal/noise ratio for pressure events */
84 /* classes of device behavior */
85 #define MT_CLS_DEFAULT 1
86 #define MT_CLS_DUAL_INRANGE_CONTACTID 2
87 #define MT_CLS_DUAL_INRANGE_CONTACTNUMBER 3
88 #define MT_CLS_CYPRESS 4
89 #define MT_CLS_EGALAX 5
90 #define MT_CLS_STANTUM 6
93 #define MT_DEFAULT_MAXCONTACT 10
96 * these device-dependent functions determine what slot corresponds
97 * to a valid contact that was just read.
100 static int cypress_compute_slot(struct mt_device
*td
)
102 if (td
->curdata
.contactid
!= 0 || td
->num_received
== 0)
103 return td
->curdata
.contactid
;
108 static int find_slot_from_contactid(struct mt_device
*td
)
111 for (i
= 0; i
< td
->maxcontacts
; ++i
) {
112 if (td
->slots
[i
].contactid
== td
->curdata
.contactid
&&
113 td
->slots
[i
].touch_state
)
116 for (i
= 0; i
< td
->maxcontacts
; ++i
) {
117 if (!td
->slots
[i
].seen_in_this_frame
&&
118 !td
->slots
[i
].touch_state
)
121 /* should not occurs. If this happens that means
122 * that the device sent more touches that it says
123 * in the report descriptor. It is ignored then. */
127 struct mt_class mt_classes
[] = {
128 { .name
= MT_CLS_DEFAULT
,
129 .quirks
= MT_QUIRK_NOT_SEEN_MEANS_UP
},
130 { .name
= MT_CLS_DUAL_INRANGE_CONTACTID
,
131 .quirks
= MT_QUIRK_VALID_IS_INRANGE
|
132 MT_QUIRK_SLOT_IS_CONTACTID
,
134 { .name
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
135 .quirks
= MT_QUIRK_VALID_IS_INRANGE
|
136 MT_QUIRK_SLOT_IS_CONTACTNUMBER
,
138 { .name
= MT_CLS_CYPRESS
,
139 .quirks
= MT_QUIRK_NOT_SEEN_MEANS_UP
|
143 { .name
= MT_CLS_EGALAX
,
144 .quirks
= MT_QUIRK_SLOT_IS_CONTACTID
|
145 MT_QUIRK_VALID_IS_INRANGE
|
146 MT_QUIRK_EGALAX_XYZ_FIXUP
,
151 { .name
= MT_CLS_STANTUM
,
152 .quirks
= MT_QUIRK_VALID_IS_CONFIDENCE
},
154 .quirks
= MT_QUIRK_VALID_IS_CONFIDENCE
|
155 MT_QUIRK_SLOT_IS_CONTACTID
,
163 static void mt_feature_mapping(struct hid_device
*hdev
,
164 struct hid_field
*field
, struct hid_usage
*usage
)
166 struct mt_device
*td
= hid_get_drvdata(hdev
);
168 switch (usage
->hid
) {
169 case HID_DG_INPUTMODE
:
170 td
->inputmode
= field
->report
->id
;
172 case HID_DG_CONTACTMAX
:
173 td
->maxcontacts
= field
->value
[0];
174 if (td
->mtclass
->maxcontacts
)
175 /* check if the maxcontacts is given by the class */
176 td
->maxcontacts
= td
->mtclass
->maxcontacts
;
182 static void set_abs(struct input_dev
*input
, unsigned int code
,
183 struct hid_field
*field
, int snratio
)
185 int fmin
= field
->logical_minimum
;
186 int fmax
= field
->logical_maximum
;
187 int fuzz
= snratio
? (fmax
- fmin
) / snratio
: 0;
188 input_set_abs_params(input
, code
, fmin
, fmax
, fuzz
, 0);
191 static int mt_input_mapping(struct hid_device
*hdev
, struct hid_input
*hi
,
192 struct hid_field
*field
, struct hid_usage
*usage
,
193 unsigned long **bit
, int *max
)
195 struct mt_device
*td
= hid_get_drvdata(hdev
);
196 struct mt_class
*cls
= td
->mtclass
;
197 __s32 quirks
= cls
->quirks
;
199 switch (usage
->hid
& HID_USAGE_PAGE
) {
202 switch (usage
->hid
) {
204 if (quirks
& MT_QUIRK_EGALAX_XYZ_FIXUP
)
205 field
->logical_maximum
= 32760;
206 hid_map_usage(hi
, usage
, bit
, max
,
207 EV_ABS
, ABS_MT_POSITION_X
);
208 set_abs(hi
->input
, ABS_MT_POSITION_X
, field
,
210 /* touchscreen emulation */
211 set_abs(hi
->input
, ABS_X
, field
, cls
->sn_move
);
212 td
->last_slot_field
= usage
->hid
;
215 if (quirks
& MT_QUIRK_EGALAX_XYZ_FIXUP
)
216 field
->logical_maximum
= 32760;
217 hid_map_usage(hi
, usage
, bit
, max
,
218 EV_ABS
, ABS_MT_POSITION_Y
);
219 set_abs(hi
->input
, ABS_MT_POSITION_Y
, field
,
221 /* touchscreen emulation */
222 set_abs(hi
->input
, ABS_Y
, field
, cls
->sn_move
);
223 td
->last_slot_field
= usage
->hid
;
228 case HID_UP_DIGITIZER
:
229 switch (usage
->hid
) {
231 td
->last_slot_field
= usage
->hid
;
233 case HID_DG_CONFIDENCE
:
234 td
->last_slot_field
= usage
->hid
;
236 case HID_DG_TIPSWITCH
:
237 hid_map_usage(hi
, usage
, bit
, max
, EV_KEY
, BTN_TOUCH
);
238 input_set_capability(hi
->input
, EV_KEY
, BTN_TOUCH
);
239 td
->last_slot_field
= usage
->hid
;
241 case HID_DG_CONTACTID
:
242 input_mt_init_slots(hi
->input
, td
->maxcontacts
);
243 td
->last_slot_field
= usage
->hid
;
246 hid_map_usage(hi
, usage
, bit
, max
,
247 EV_ABS
, ABS_MT_TOUCH_MAJOR
);
248 set_abs(hi
->input
, ABS_MT_TOUCH_MAJOR
, field
,
250 td
->last_slot_field
= usage
->hid
;
253 hid_map_usage(hi
, usage
, bit
, max
,
254 EV_ABS
, ABS_MT_TOUCH_MINOR
);
255 set_abs(hi
->input
, ABS_MT_TOUCH_MINOR
, field
,
257 input_set_abs_params(hi
->input
,
258 ABS_MT_ORIENTATION
, 0, 1, 0, 0);
259 td
->last_slot_field
= usage
->hid
;
261 case HID_DG_TIPPRESSURE
:
262 if (quirks
& MT_QUIRK_EGALAX_XYZ_FIXUP
)
263 field
->logical_minimum
= 0;
264 hid_map_usage(hi
, usage
, bit
, max
,
265 EV_ABS
, ABS_MT_PRESSURE
);
266 set_abs(hi
->input
, ABS_MT_PRESSURE
, field
,
268 /* touchscreen emulation */
269 set_abs(hi
->input
, ABS_PRESSURE
, field
,
271 td
->last_slot_field
= usage
->hid
;
273 case HID_DG_CONTACTCOUNT
:
274 td
->last_field_index
= field
->report
->maxfield
- 1;
276 case HID_DG_CONTACTMAX
:
277 /* we don't set td->last_slot_field as contactcount and
278 * contact max are global to the report */
281 /* let hid-input decide for the others */
285 /* we do not want to map these: no input-oriented meaning */
292 static int mt_input_mapped(struct hid_device
*hdev
, struct hid_input
*hi
,
293 struct hid_field
*field
, struct hid_usage
*usage
,
294 unsigned long **bit
, int *max
)
296 if (usage
->type
== EV_KEY
|| usage
->type
== EV_ABS
)
297 set_bit(usage
->type
, hi
->input
->evbit
);
302 static int mt_compute_slot(struct mt_device
*td
)
304 __s32 quirks
= td
->mtclass
->quirks
;
306 if (quirks
& MT_QUIRK_SLOT_IS_CONTACTID
)
307 return td
->curdata
.contactid
;
309 if (quirks
& MT_QUIRK_CYPRESS
)
310 return cypress_compute_slot(td
);
312 if (quirks
& MT_QUIRK_SLOT_IS_CONTACTNUMBER
)
313 return td
->num_received
;
315 return find_slot_from_contactid(td
);
319 * this function is called when a whole contact has been processed,
320 * so that it can assign it to a slot and store the data there
322 static void mt_complete_slot(struct mt_device
*td
)
324 td
->curdata
.seen_in_this_frame
= true;
326 int slotnum
= mt_compute_slot(td
);
328 if (slotnum
>= 0 && slotnum
< td
->maxcontacts
)
329 td
->slots
[slotnum
] = td
->curdata
;
336 * this function is called when a whole packet has been received and processed,
337 * so that it can decide what to send to the input layer.
339 static void mt_emit_event(struct mt_device
*td
, struct input_dev
*input
)
343 for (i
= 0; i
< td
->maxcontacts
; ++i
) {
344 struct mt_slot
*s
= &(td
->slots
[i
]);
345 if ((td
->mtclass
->quirks
& MT_QUIRK_NOT_SEEN_MEANS_UP
) &&
346 !s
->seen_in_this_frame
) {
347 s
->touch_state
= false;
350 input_mt_slot(input
, i
);
351 input_mt_report_slot_state(input
, MT_TOOL_FINGER
,
353 if (s
->touch_state
) {
354 /* this finger is on the screen */
355 int wide
= (s
->w
> s
->h
);
356 /* divided by two to match visual scale of touch */
357 int major
= max(s
->w
, s
->h
) >> 1;
358 int minor
= min(s
->w
, s
->h
) >> 1;
360 input_event(input
, EV_ABS
, ABS_MT_POSITION_X
, s
->x
);
361 input_event(input
, EV_ABS
, ABS_MT_POSITION_Y
, s
->y
);
362 input_event(input
, EV_ABS
, ABS_MT_ORIENTATION
, wide
);
363 input_event(input
, EV_ABS
, ABS_MT_PRESSURE
, s
->p
);
364 input_event(input
, EV_ABS
, ABS_MT_TOUCH_MAJOR
, major
);
365 input_event(input
, EV_ABS
, ABS_MT_TOUCH_MINOR
, minor
);
367 s
->seen_in_this_frame
= false;
371 input_mt_report_pointer_emulation(input
, true);
373 td
->num_received
= 0;
378 static int mt_event(struct hid_device
*hid
, struct hid_field
*field
,
379 struct hid_usage
*usage
, __s32 value
)
381 struct mt_device
*td
= hid_get_drvdata(hid
);
382 __s32 quirks
= td
->mtclass
->quirks
;
384 if (hid
->claimed
& HID_CLAIMED_INPUT
&& td
->slots
) {
385 switch (usage
->hid
) {
387 if (quirks
& MT_QUIRK_VALID_IS_INRANGE
)
388 td
->curvalid
= value
;
390 case HID_DG_TIPSWITCH
:
391 if (quirks
& MT_QUIRK_NOT_SEEN_MEANS_UP
)
392 td
->curvalid
= value
;
393 td
->curdata
.touch_state
= value
;
395 case HID_DG_CONFIDENCE
:
396 if (quirks
& MT_QUIRK_VALID_IS_CONFIDENCE
)
397 td
->curvalid
= value
;
399 case HID_DG_CONTACTID
:
400 td
->curdata
.contactid
= value
;
402 case HID_DG_TIPPRESSURE
:
403 td
->curdata
.p
= value
;
406 td
->curdata
.x
= value
;
409 td
->curdata
.y
= value
;
412 td
->curdata
.w
= value
;
415 td
->curdata
.h
= value
;
417 case HID_DG_CONTACTCOUNT
:
419 * Includes multi-packet support where subsequent
420 * packets are sent with zero contactcount.
423 td
->num_expected
= value
;
427 if (td
->last_field_index
428 && field
->index
== td
->last_field_index
)
429 /* we reach here when the last field in the
430 * report is not related to multitouch.
431 * This is not good. As a temporary solution,
432 * we trigger our mt event completion and
436 /* fallback to the generic hidinput handling */
440 if (usage
->hid
== td
->last_slot_field
) {
441 mt_complete_slot(td
);
442 if (!td
->last_field_index
)
443 mt_emit_event(td
, field
->hidinput
->input
);
446 if (field
->index
== td
->last_field_index
447 && td
->num_received
>= td
->num_expected
)
448 mt_emit_event(td
, field
->hidinput
->input
);
452 /* we have handled the hidinput part, now remains hiddev */
453 if (hid
->claimed
& HID_CLAIMED_HIDDEV
&& hid
->hiddev_hid_event
)
454 hid
->hiddev_hid_event(hid
, field
, usage
, value
);
459 static void mt_set_input_mode(struct hid_device
*hdev
)
461 struct mt_device
*td
= hid_get_drvdata(hdev
);
462 struct hid_report
*r
;
463 struct hid_report_enum
*re
;
465 if (td
->inputmode
< 0)
468 re
= &(hdev
->report_enum
[HID_FEATURE_REPORT
]);
469 r
= re
->report_id_hash
[td
->inputmode
];
471 r
->field
[0]->value
[0] = 0x02;
472 usbhid_submit_report(hdev
, r
, USB_DIR_OUT
);
476 static int mt_probe(struct hid_device
*hdev
, const struct hid_device_id
*id
)
479 struct mt_device
*td
;
480 struct mt_class
*mtclass
= mt_classes
; /* MT_CLS_DEFAULT */
482 for (i
= 0; mt_classes
[i
].name
; i
++) {
483 if (id
->driver_data
== mt_classes
[i
].name
) {
484 mtclass
= &(mt_classes
[i
]);
489 /* This allows the driver to correctly support devices
490 * that emit events over several HID messages.
492 hdev
->quirks
|= HID_QUIRK_NO_INPUT_SYNC
;
494 td
= kzalloc(sizeof(struct mt_device
), GFP_KERNEL
);
496 dev_err(&hdev
->dev
, "cannot allocate multitouch data\n");
499 td
->mtclass
= mtclass
;
501 hid_set_drvdata(hdev
, td
);
503 ret
= hid_parse(hdev
);
507 ret
= hid_hw_start(hdev
, HID_CONNECT_DEFAULT
);
511 if (!td
->maxcontacts
)
512 td
->maxcontacts
= MT_DEFAULT_MAXCONTACT
;
514 td
->slots
= kzalloc(td
->maxcontacts
* sizeof(struct mt_slot
),
517 dev_err(&hdev
->dev
, "cannot allocate multitouch slots\n");
523 mt_set_input_mode(hdev
);
533 static int mt_reset_resume(struct hid_device
*hdev
)
535 mt_set_input_mode(hdev
);
540 static void mt_remove(struct hid_device
*hdev
)
542 struct mt_device
*td
= hid_get_drvdata(hdev
);
546 hid_set_drvdata(hdev
, NULL
);
549 static const struct hid_device_id mt_devices
[] = {
552 { .driver_data
= MT_CLS_3M
,
553 HID_USB_DEVICE(USB_VENDOR_ID_3M
,
554 USB_DEVICE_ID_3M1968
) },
555 { .driver_data
= MT_CLS_3M
,
556 HID_USB_DEVICE(USB_VENDOR_ID_3M
,
557 USB_DEVICE_ID_3M2256
) },
560 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
561 HID_USB_DEVICE(USB_VENDOR_ID_CANDO
,
562 USB_DEVICE_ID_CANDO_MULTI_TOUCH
) },
563 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
564 HID_USB_DEVICE(USB_VENDOR_ID_CANDO
,
565 USB_DEVICE_ID_CANDO_MULTI_TOUCH_10_1
) },
566 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
567 HID_USB_DEVICE(USB_VENDOR_ID_CANDO
,
568 USB_DEVICE_ID_CANDO_MULTI_TOUCH_11_6
) },
569 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
570 HID_USB_DEVICE(USB_VENDOR_ID_CANDO
,
571 USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6
) },
574 { .driver_data
= MT_CLS_CYPRESS
,
575 HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS
,
576 USB_DEVICE_ID_CYPRESS_TRUETOUCH
) },
578 /* GeneralTouch panel */
579 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTNUMBER
,
580 HID_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH
,
581 USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS
) },
584 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTID
,
585 HID_USB_DEVICE(USB_VENDOR_ID_IRTOUCHSYSTEMS
,
586 USB_DEVICE_ID_IRTOUCH_INFRARED_USB
) },
588 /* PixCir-based panels */
589 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTID
,
590 HID_USB_DEVICE(USB_VENDOR_ID_HANVON
,
591 USB_DEVICE_ID_HANVON_MULTITOUCH
) },
592 { .driver_data
= MT_CLS_DUAL_INRANGE_CONTACTID
,
593 HID_USB_DEVICE(USB_VENDOR_ID_CANDO
,
594 USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH
) },
596 /* Resistive eGalax devices */
597 { .driver_data
= MT_CLS_EGALAX
,
598 HID_USB_DEVICE(USB_VENDOR_ID_DWAV
,
599 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH
) },
600 { .driver_data
= MT_CLS_EGALAX
,
601 HID_USB_DEVICE(USB_VENDOR_ID_DWAV
,
602 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH3
) },
604 /* Capacitive eGalax devices */
605 { .driver_data
= MT_CLS_EGALAX
,
606 HID_USB_DEVICE(USB_VENDOR_ID_DWAV
,
607 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH1
) },
608 { .driver_data
= MT_CLS_EGALAX
,
609 HID_USB_DEVICE(USB_VENDOR_ID_DWAV
,
610 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH2
) },
611 { .driver_data
= MT_CLS_EGALAX
,
612 HID_USB_DEVICE(USB_VENDOR_ID_DWAV
,
613 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH4
) },
616 { .driver_data
= MT_CLS_STANTUM
,
617 HID_USB_DEVICE(USB_VENDOR_ID_STANTUM
,
619 { .driver_data
= MT_CLS_STANTUM
,
620 HID_USB_DEVICE(USB_VENDOR_ID_STANTUM
,
621 USB_DEVICE_ID_MTP_STM
)},
622 { .driver_data
= MT_CLS_STANTUM
,
623 HID_USB_DEVICE(USB_VENDOR_ID_STANTUM
,
624 USB_DEVICE_ID_MTP_SITRONIX
)},
628 MODULE_DEVICE_TABLE(hid
, mt_devices
);
630 static const struct hid_usage_id mt_grabbed_usages
[] = {
631 { HID_ANY_ID
, HID_ANY_ID
, HID_ANY_ID
},
632 { HID_ANY_ID
- 1, HID_ANY_ID
- 1, HID_ANY_ID
- 1}
635 static struct hid_driver mt_driver
= {
636 .name
= "hid-multitouch",
637 .id_table
= mt_devices
,
640 .input_mapping
= mt_input_mapping
,
641 .input_mapped
= mt_input_mapped
,
642 .feature_mapping
= mt_feature_mapping
,
643 .usage_table
= mt_grabbed_usages
,
646 .reset_resume
= mt_reset_resume
,
650 static int __init
mt_init(void)
652 return hid_register_driver(&mt_driver
);
655 static void __exit
mt_exit(void)
657 hid_unregister_driver(&mt_driver
);
660 module_init(mt_init
);
661 module_exit(mt_exit
);