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;
213 td->last_field_index = field->index;
216 if (quirks & MT_QUIRK_EGALAX_XYZ_FIXUP)
217 field->logical_maximum = 32760;
218 hid_map_usage(hi, usage, bit, max,
219 EV_ABS, ABS_MT_POSITION_Y);
220 set_abs(hi->input, ABS_MT_POSITION_Y, field,
222 /* touchscreen emulation */
223 set_abs(hi->input, ABS_Y, field, cls->sn_move);
224 td->last_slot_field = usage->hid;
225 td->last_field_index = field->index;
230 case HID_UP_DIGITIZER:
231 switch (usage->hid) {
233 td->last_slot_field = usage->hid;
234 td->last_field_index = field->index;
236 case HID_DG_CONFIDENCE:
237 td->last_slot_field = usage->hid;
238 td->last_field_index = field->index;
240 case HID_DG_TIPSWITCH:
241 hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_TOUCH);
242 input_set_capability(hi->input, EV_KEY, BTN_TOUCH);
243 td->last_slot_field = usage->hid;
244 td->last_field_index = field->index;
246 case HID_DG_CONTACTID:
247 input_mt_init_slots(hi->input, td->maxcontacts);
248 td->last_slot_field = usage->hid;
249 td->last_field_index = field->index;
252 hid_map_usage(hi, usage, bit, max,
253 EV_ABS, ABS_MT_TOUCH_MAJOR);
254 set_abs(hi->input, ABS_MT_TOUCH_MAJOR, field,
256 td->last_slot_field = usage->hid;
257 td->last_field_index = field->index;
260 hid_map_usage(hi, usage, bit, max,
261 EV_ABS, ABS_MT_TOUCH_MINOR);
262 set_abs(hi->input, ABS_MT_TOUCH_MINOR, field,
264 input_set_abs_params(hi->input,
265 ABS_MT_ORIENTATION, 0, 1, 0, 0);
266 td->last_slot_field = usage->hid;
267 td->last_field_index = field->index;
269 case HID_DG_TIPPRESSURE:
270 if (quirks & MT_QUIRK_EGALAX_XYZ_FIXUP)
271 field->logical_minimum = 0;
272 hid_map_usage(hi, usage, bit, max,
273 EV_ABS, ABS_MT_PRESSURE);
274 set_abs(hi->input, ABS_MT_PRESSURE, field,
276 /* touchscreen emulation */
277 set_abs(hi->input, ABS_PRESSURE, field,
279 td->last_slot_field = usage->hid;
280 td->last_field_index = field->index;
282 case HID_DG_CONTACTCOUNT:
283 td->last_field_index = field->index;
285 case HID_DG_CONTACTMAX:
286 /* we don't set td->last_slot_field as contactcount and
287 * contact max are global to the report */
288 td->last_field_index = field->index;
291 /* let hid-input decide for the others */
295 /* we do not want to map these: no input-oriented meaning */
302 static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
303 struct hid_field *field, struct hid_usage *usage,
304 unsigned long **bit, int *max)
306 if (usage->type == EV_KEY || usage->type == EV_ABS)
307 set_bit(usage->type, hi->input->evbit);
312 static int mt_compute_slot(struct mt_device *td)
314 __s32 quirks = td->mtclass->quirks;
316 if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
317 return td->curdata.contactid;
319 if (quirks & MT_QUIRK_CYPRESS)
320 return cypress_compute_slot(td);
322 if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
323 return td->num_received;
325 return find_slot_from_contactid(td);
329 * this function is called when a whole contact has been processed,
330 * so that it can assign it to a slot and store the data there
332 static void mt_complete_slot(struct mt_device *td)
334 td->curdata.seen_in_this_frame = true;
336 int slotnum = mt_compute_slot(td);
338 if (slotnum >= 0 && slotnum < td->maxcontacts)
339 td->slots[slotnum] = td->curdata;
346 * this function is called when a whole packet has been received and processed,
347 * so that it can decide what to send to the input layer.
349 static void mt_emit_event(struct mt_device *td, struct input_dev *input)
353 for (i = 0; i < td->maxcontacts; ++i) {
354 struct mt_slot *s = &(td->slots[i]);
355 if ((td->mtclass->quirks & MT_QUIRK_NOT_SEEN_MEANS_UP) &&
356 !s->seen_in_this_frame) {
357 s->touch_state = false;
360 input_mt_slot(input, i);
361 input_mt_report_slot_state(input, MT_TOOL_FINGER,
363 if (s->touch_state) {
364 /* this finger is on the screen */
365 int wide = (s->w > s->h);
366 /* divided by two to match visual scale of touch */
367 int major = max(s->w, s->h) >> 1;
368 int minor = min(s->w, s->h) >> 1;
370 input_event(input, EV_ABS, ABS_MT_POSITION_X, s->x);
371 input_event(input, EV_ABS, ABS_MT_POSITION_Y, s->y);
372 input_event(input, EV_ABS, ABS_MT_ORIENTATION, wide);
373 input_event(input, EV_ABS, ABS_MT_PRESSURE, s->p);
374 input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
375 input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
377 s->seen_in_this_frame = false;
381 input_mt_report_pointer_emulation(input, true);
383 td->num_received = 0;
388 static int mt_event(struct hid_device *hid, struct hid_field *field,
389 struct hid_usage *usage, __s32 value)
391 struct mt_device *td = hid_get_drvdata(hid);
392 __s32 quirks = td->mtclass->quirks;
394 if (hid->claimed & HID_CLAIMED_INPUT && td->slots) {
395 switch (usage->hid) {
397 if (quirks & MT_QUIRK_VALID_IS_INRANGE)
398 td->curvalid = value;
400 case HID_DG_TIPSWITCH:
401 if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
402 td->curvalid = value;
403 td->curdata.touch_state = value;
405 case HID_DG_CONFIDENCE:
406 if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
407 td->curvalid = value;
409 case HID_DG_CONTACTID:
410 td->curdata.contactid = value;
412 case HID_DG_TIPPRESSURE:
413 td->curdata.p = value;
416 td->curdata.x = value;
419 td->curdata.y = value;
422 td->curdata.w = value;
425 td->curdata.h = value;
427 case HID_DG_CONTACTCOUNT:
429 * Includes multi-packet support where subsequent
430 * packets are sent with zero contactcount.
433 td->num_expected = value;
437 /* fallback to the generic hidinput handling */
441 if (usage->hid == td->last_slot_field) {
442 mt_complete_slot(td);
445 if (field->index == td->last_field_index
446 && td->num_received >= td->num_expected)
447 mt_emit_event(td, field->hidinput->input);
451 /* we have handled the hidinput part, now remains hiddev */
452 if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
453 hid->hiddev_hid_event(hid, field, usage, value);
458 static void mt_set_input_mode(struct hid_device *hdev)
460 struct mt_device *td = hid_get_drvdata(hdev);
461 struct hid_report *r;
462 struct hid_report_enum *re;
464 if (td->inputmode < 0)
467 re = &(hdev->report_enum[HID_FEATURE_REPORT]);
468 r = re->report_id_hash[td->inputmode];
470 r->field[0]->value[0] = 0x02;
471 usbhid_submit_report(hdev, r, USB_DIR_OUT);
475 static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
478 struct mt_device *td;
479 struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */
481 for (i = 0; mt_classes[i].name ; i++) {
482 if (id->driver_data == mt_classes[i].name) {
483 mtclass = &(mt_classes[i]);
488 /* This allows the driver to correctly support devices
489 * that emit events over several HID messages.
491 hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
493 td = kzalloc(sizeof(struct mt_device), GFP_KERNEL);
495 dev_err(&hdev->dev, "cannot allocate multitouch data\n");
498 td->mtclass = mtclass;
500 hid_set_drvdata(hdev, td);
502 ret = hid_parse(hdev);
506 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
510 if (!td->maxcontacts)
511 td->maxcontacts = MT_DEFAULT_MAXCONTACT;
513 td->slots = kzalloc(td->maxcontacts * sizeof(struct mt_slot),
516 dev_err(&hdev->dev, "cannot allocate multitouch slots\n");
522 mt_set_input_mode(hdev);
532 static int mt_reset_resume(struct hid_device *hdev)
534 mt_set_input_mode(hdev);
539 static void mt_remove(struct hid_device *hdev)
541 struct mt_device *td = hid_get_drvdata(hdev);
545 hid_set_drvdata(hdev, NULL);
548 static const struct hid_device_id mt_devices[] = {
551 { .driver_data = MT_CLS_3M,
552 HID_USB_DEVICE(USB_VENDOR_ID_3M,
553 USB_DEVICE_ID_3M1968) },
554 { .driver_data = MT_CLS_3M,
555 HID_USB_DEVICE(USB_VENDOR_ID_3M,
556 USB_DEVICE_ID_3M2256) },
559 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
560 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
561 USB_DEVICE_ID_CANDO_MULTI_TOUCH) },
562 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
563 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
564 USB_DEVICE_ID_CANDO_MULTI_TOUCH_10_1) },
565 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
566 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
567 USB_DEVICE_ID_CANDO_MULTI_TOUCH_11_6) },
568 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
569 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
570 USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6) },
573 { .driver_data = MT_CLS_CYPRESS,
574 HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS,
575 USB_DEVICE_ID_CYPRESS_TRUETOUCH) },
577 /* GeneralTouch panel */
578 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
579 HID_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
580 USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
583 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
584 HID_USB_DEVICE(USB_VENDOR_ID_IRTOUCHSYSTEMS,
585 USB_DEVICE_ID_IRTOUCH_INFRARED_USB) },
587 /* PixCir-based panels */
588 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
589 HID_USB_DEVICE(USB_VENDOR_ID_HANVON,
590 USB_DEVICE_ID_HANVON_MULTITOUCH) },
591 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
592 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
593 USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
595 /* Resistive eGalax devices */
596 { .driver_data = MT_CLS_EGALAX,
597 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
598 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH) },
599 { .driver_data = MT_CLS_EGALAX,
600 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
601 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH3) },
603 /* Capacitive eGalax devices */
604 { .driver_data = MT_CLS_EGALAX,
605 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
606 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH1) },
607 { .driver_data = MT_CLS_EGALAX,
608 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
609 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH2) },
610 { .driver_data = MT_CLS_EGALAX,
611 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
612 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH4) },
615 { .driver_data = MT_CLS_STANTUM,
616 HID_USB_DEVICE(USB_VENDOR_ID_STANTUM,
618 { .driver_data = MT_CLS_STANTUM,
619 HID_USB_DEVICE(USB_VENDOR_ID_STANTUM,
620 USB_DEVICE_ID_MTP_STM)},
621 { .driver_data = MT_CLS_STANTUM,
622 HID_USB_DEVICE(USB_VENDOR_ID_STANTUM,
623 USB_DEVICE_ID_MTP_SITRONIX)},
627 MODULE_DEVICE_TABLE(hid, mt_devices);
629 static const struct hid_usage_id mt_grabbed_usages[] = {
630 { HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
631 { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
634 static struct hid_driver mt_driver = {
635 .name = "hid-multitouch",
636 .id_table = mt_devices,
639 .input_mapping = mt_input_mapping,
640 .input_mapped = mt_input_mapped,
641 .feature_mapping = mt_feature_mapping,
642 .usage_table = mt_grabbed_usages,
645 .reset_resume = mt_reset_resume,
649 static int __init mt_init(void)
651 return hid_register_driver(&mt_driver);
654 static void __exit mt_exit(void)
656 hid_unregister_driver(&mt_driver);
659 module_init(mt_init);
660 module_exit(mt_exit);