]> Pileus Git - ~andy/linux/blob - drivers/hid/hid-multitouch.c
HID: detect Win 8 multitouch devices in core
[~andy/linux] / drivers / hid / hid-multitouch.c
1 /*
2  *  HID driver for multitouch panels
3  *
4  *  Copyright (c) 2010-2012 Stephane Chatty <chatty@enac.fr>
5  *  Copyright (c) 2010-2013 Benjamin Tissoires <benjamin.tissoires@gmail.com>
6  *  Copyright (c) 2010-2012 Ecole Nationale de l'Aviation Civile, France
7  *  Copyright (c) 2012-2013 Red Hat, Inc
8  *
9  *  This code is partly based on hid-egalax.c:
10  *
11  *  Copyright (c) 2010 Stephane Chatty <chatty@enac.fr>
12  *  Copyright (c) 2010 Henrik Rydberg <rydberg@euromail.se>
13  *  Copyright (c) 2010 Canonical, Ltd.
14  *
15  *  This code is partly based on hid-3m-pct.c:
16  *
17  *  Copyright (c) 2009-2010 Stephane Chatty <chatty@enac.fr>
18  *  Copyright (c) 2010      Henrik Rydberg <rydberg@euromail.se>
19  *  Copyright (c) 2010      Canonical, Ltd.
20  *
21  */
22
23 /*
24  * This program is free software; you can redistribute it and/or modify it
25  * under the terms of the GNU General Public License as published by the Free
26  * Software Foundation; either version 2 of the License, or (at your option)
27  * any later version.
28  */
29
30 /*
31  * This driver is regularly tested thanks to the tool hid-test[1].
32  * This tool relies on hid-replay[2] and a database of hid devices[3].
33  * Please run these regression tests before patching this module so that
34  * your patch won't break existing known devices.
35  *
36  * [1] https://github.com/bentiss/hid-test
37  * [2] https://github.com/bentiss/hid-replay
38  * [3] https://github.com/bentiss/hid-devices
39  */
40
41 #include <linux/device.h>
42 #include <linux/hid.h>
43 #include <linux/module.h>
44 #include <linux/slab.h>
45 #include <linux/usb.h>
46 #include <linux/input/mt.h>
47 #include <linux/string.h>
48
49
50 MODULE_AUTHOR("Stephane Chatty <chatty@enac.fr>");
51 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
52 MODULE_DESCRIPTION("HID multitouch panels");
53 MODULE_LICENSE("GPL");
54
55 #include "hid-ids.h"
56
57 /* quirks to control the device */
58 #define MT_QUIRK_NOT_SEEN_MEANS_UP      (1 << 0)
59 #define MT_QUIRK_SLOT_IS_CONTACTID      (1 << 1)
60 #define MT_QUIRK_CYPRESS                (1 << 2)
61 #define MT_QUIRK_SLOT_IS_CONTACTNUMBER  (1 << 3)
62 #define MT_QUIRK_ALWAYS_VALID           (1 << 4)
63 #define MT_QUIRK_VALID_IS_INRANGE       (1 << 5)
64 #define MT_QUIRK_VALID_IS_CONFIDENCE    (1 << 6)
65 #define MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE    (1 << 8)
66 #define MT_QUIRK_NO_AREA                (1 << 9)
67 #define MT_QUIRK_IGNORE_DUPLICATES      (1 << 10)
68 #define MT_QUIRK_HOVERING               (1 << 11)
69 #define MT_QUIRK_CONTACT_CNT_ACCURATE   (1 << 12)
70
71 struct mt_slot {
72         __s32 x, y, cx, cy, p, w, h;
73         __s32 contactid;        /* the device ContactID assigned to this slot */
74         bool touch_state;       /* is the touch valid? */
75         bool inrange_state;     /* is the finger in proximity of the sensor? */
76 };
77
78 struct mt_class {
79         __s32 name;     /* MT_CLS */
80         __s32 quirks;
81         __s32 sn_move;  /* Signal/noise ratio for move events */
82         __s32 sn_width; /* Signal/noise ratio for width events */
83         __s32 sn_height;        /* Signal/noise ratio for height events */
84         __s32 sn_pressure;      /* Signal/noise ratio for pressure events */
85         __u8 maxcontacts;
86         bool is_indirect;       /* true for touchpads */
87 };
88
89 struct mt_fields {
90         unsigned usages[HID_MAX_FIELDS];
91         unsigned int length;
92 };
93
94 struct mt_device {
95         struct mt_slot curdata; /* placeholder of incoming data */
96         struct mt_class mtclass;        /* our mt device class */
97         struct mt_fields *fields;       /* temporary placeholder for storing the
98                                            multitouch fields */
99         int cc_index;   /* contact count field index in the report */
100         int cc_value_index;     /* contact count value index in the field */
101         unsigned last_slot_field;       /* the last field of a slot */
102         unsigned mt_report_id;  /* the report ID of the multitouch device */
103         unsigned pen_report_id; /* the report ID of the pen device */
104         __s8 inputmode;         /* InputMode HID feature, -1 if non-existent */
105         __s8 inputmode_index;   /* InputMode HID feature index in the report */
106         __s8 maxcontact_report_id;      /* Maximum Contact Number HID feature,
107                                    -1 if non-existent */
108         __u8 num_received;      /* how many contacts we received */
109         __u8 num_expected;      /* expected last contact index */
110         __u8 maxcontacts;
111         __u8 touches_by_report; /* how many touches are present in one report:
112                                 * 1 means we should use a serial protocol
113                                 * > 1 means hybrid (multitouch) protocol */
114         bool serial_maybe;      /* need to check for serial protocol */
115         bool curvalid;          /* is the current contact valid? */
116         unsigned mt_flags;      /* flags to pass to input-mt */
117 };
118
119 static void mt_post_parse_default_settings(struct mt_device *td);
120 static void mt_post_parse(struct mt_device *td);
121
122 /* classes of device behavior */
123 #define MT_CLS_DEFAULT                          0x0001
124
125 #define MT_CLS_SERIAL                           0x0002
126 #define MT_CLS_CONFIDENCE                       0x0003
127 #define MT_CLS_CONFIDENCE_CONTACT_ID            0x0004
128 #define MT_CLS_CONFIDENCE_MINUS_ONE             0x0005
129 #define MT_CLS_DUAL_INRANGE_CONTACTID           0x0006
130 #define MT_CLS_DUAL_INRANGE_CONTACTNUMBER       0x0007
131 #define MT_CLS_DUAL_NSMU_CONTACTID              0x0008
132 #define MT_CLS_INRANGE_CONTACTNUMBER            0x0009
133 #define MT_CLS_NSMU                             0x000a
134 #define MT_CLS_DUAL_CONTACT_NUMBER              0x0010
135 #define MT_CLS_DUAL_CONTACT_ID                  0x0011
136 #define MT_CLS_WIN_8                            0x0012
137
138 /* vendor specific classes */
139 #define MT_CLS_3M                               0x0101
140 #define MT_CLS_CYPRESS                          0x0102
141 #define MT_CLS_EGALAX                           0x0103
142 #define MT_CLS_EGALAX_SERIAL                    0x0104
143 #define MT_CLS_TOPSEED                          0x0105
144 #define MT_CLS_PANASONIC                        0x0106
145 #define MT_CLS_FLATFROG                         0x0107
146 #define MT_CLS_GENERALTOUCH_TWOFINGERS          0x0108
147 #define MT_CLS_GENERALTOUCH_PWT_TENFINGERS      0x0109
148
149 #define MT_DEFAULT_MAXCONTACT   10
150 #define MT_MAX_MAXCONTACT       250
151
152 #define MT_USB_DEVICE(v, p)     HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH, v, p)
153 #define MT_BT_DEVICE(v, p)      HID_DEVICE(BUS_BLUETOOTH, HID_GROUP_MULTITOUCH, v, p)
154
155 /*
156  * these device-dependent functions determine what slot corresponds
157  * to a valid contact that was just read.
158  */
159
160 static int cypress_compute_slot(struct mt_device *td)
161 {
162         if (td->curdata.contactid != 0 || td->num_received == 0)
163                 return td->curdata.contactid;
164         else
165                 return -1;
166 }
167
168 static struct mt_class mt_classes[] = {
169         { .name = MT_CLS_DEFAULT,
170                 .quirks = MT_QUIRK_ALWAYS_VALID |
171                         MT_QUIRK_CONTACT_CNT_ACCURATE },
172         { .name = MT_CLS_NSMU,
173                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP },
174         { .name = MT_CLS_SERIAL,
175                 .quirks = MT_QUIRK_ALWAYS_VALID},
176         { .name = MT_CLS_CONFIDENCE,
177                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE },
178         { .name = MT_CLS_CONFIDENCE_CONTACT_ID,
179                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
180                         MT_QUIRK_SLOT_IS_CONTACTID },
181         { .name = MT_CLS_CONFIDENCE_MINUS_ONE,
182                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
183                         MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE },
184         { .name = MT_CLS_DUAL_INRANGE_CONTACTID,
185                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
186                         MT_QUIRK_SLOT_IS_CONTACTID,
187                 .maxcontacts = 2 },
188         { .name = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
189                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
190                         MT_QUIRK_SLOT_IS_CONTACTNUMBER,
191                 .maxcontacts = 2 },
192         { .name = MT_CLS_DUAL_NSMU_CONTACTID,
193                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
194                         MT_QUIRK_SLOT_IS_CONTACTID,
195                 .maxcontacts = 2 },
196         { .name = MT_CLS_INRANGE_CONTACTNUMBER,
197                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
198                         MT_QUIRK_SLOT_IS_CONTACTNUMBER },
199         { .name = MT_CLS_DUAL_CONTACT_NUMBER,
200                 .quirks = MT_QUIRK_ALWAYS_VALID |
201                         MT_QUIRK_CONTACT_CNT_ACCURATE |
202                         MT_QUIRK_SLOT_IS_CONTACTNUMBER,
203                 .maxcontacts = 2 },
204         { .name = MT_CLS_DUAL_CONTACT_ID,
205                 .quirks = MT_QUIRK_ALWAYS_VALID |
206                         MT_QUIRK_CONTACT_CNT_ACCURATE |
207                         MT_QUIRK_SLOT_IS_CONTACTID,
208                 .maxcontacts = 2 },
209         { .name = MT_CLS_WIN_8,
210                 .quirks = MT_QUIRK_ALWAYS_VALID |
211                         MT_QUIRK_IGNORE_DUPLICATES |
212                         MT_QUIRK_HOVERING |
213                         MT_QUIRK_CONTACT_CNT_ACCURATE },
214
215         /*
216          * vendor specific classes
217          */
218         { .name = MT_CLS_3M,
219                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
220                         MT_QUIRK_SLOT_IS_CONTACTID,
221                 .sn_move = 2048,
222                 .sn_width = 128,
223                 .sn_height = 128,
224                 .maxcontacts = 60,
225         },
226         { .name = MT_CLS_CYPRESS,
227                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
228                         MT_QUIRK_CYPRESS,
229                 .maxcontacts = 10 },
230         { .name = MT_CLS_EGALAX,
231                 .quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
232                         MT_QUIRK_VALID_IS_INRANGE,
233                 .sn_move = 4096,
234                 .sn_pressure = 32,
235         },
236         { .name = MT_CLS_EGALAX_SERIAL,
237                 .quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
238                         MT_QUIRK_ALWAYS_VALID,
239                 .sn_move = 4096,
240                 .sn_pressure = 32,
241         },
242         { .name = MT_CLS_TOPSEED,
243                 .quirks = MT_QUIRK_ALWAYS_VALID,
244                 .is_indirect = true,
245                 .maxcontacts = 2,
246         },
247         { .name = MT_CLS_PANASONIC,
248                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP,
249                 .maxcontacts = 4 },
250         { .name = MT_CLS_GENERALTOUCH_TWOFINGERS,
251                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
252                         MT_QUIRK_VALID_IS_INRANGE |
253                         MT_QUIRK_SLOT_IS_CONTACTNUMBER,
254                 .maxcontacts = 2
255         },
256         { .name = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
257                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
258                         MT_QUIRK_SLOT_IS_CONTACTNUMBER
259         },
260
261         { .name = MT_CLS_FLATFROG,
262                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
263                         MT_QUIRK_NO_AREA,
264                 .sn_move = 2048,
265                 .maxcontacts = 40,
266         },
267         { }
268 };
269
270 static ssize_t mt_show_quirks(struct device *dev,
271                            struct device_attribute *attr,
272                            char *buf)
273 {
274         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
275         struct mt_device *td = hid_get_drvdata(hdev);
276
277         return sprintf(buf, "%u\n", td->mtclass.quirks);
278 }
279
280 static ssize_t mt_set_quirks(struct device *dev,
281                           struct device_attribute *attr,
282                           const char *buf, size_t count)
283 {
284         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
285         struct mt_device *td = hid_get_drvdata(hdev);
286
287         unsigned long val;
288
289         if (kstrtoul(buf, 0, &val))
290                 return -EINVAL;
291
292         td->mtclass.quirks = val;
293
294         if (td->cc_index < 0)
295                 td->mtclass.quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
296
297         return count;
298 }
299
300 static DEVICE_ATTR(quirks, S_IWUSR | S_IRUGO, mt_show_quirks, mt_set_quirks);
301
302 static struct attribute *sysfs_attrs[] = {
303         &dev_attr_quirks.attr,
304         NULL
305 };
306
307 static struct attribute_group mt_attribute_group = {
308         .attrs = sysfs_attrs
309 };
310
311 static void mt_feature_mapping(struct hid_device *hdev,
312                 struct hid_field *field, struct hid_usage *usage)
313 {
314         struct mt_device *td = hid_get_drvdata(hdev);
315         int i;
316
317         switch (usage->hid) {
318         case HID_DG_INPUTMODE:
319                 td->inputmode = field->report->id;
320                 td->inputmode_index = 0; /* has to be updated below */
321
322                 for (i=0; i < field->maxusage; i++) {
323                         if (field->usage[i].hid == usage->hid) {
324                                 td->inputmode_index = i;
325                                 break;
326                         }
327                 }
328
329                 break;
330         case HID_DG_CONTACTMAX:
331                 td->maxcontact_report_id = field->report->id;
332                 td->maxcontacts = field->value[0];
333                 if (!td->maxcontacts &&
334                     field->logical_maximum <= MT_MAX_MAXCONTACT)
335                         td->maxcontacts = field->logical_maximum;
336                 if (td->mtclass.maxcontacts)
337                         /* check if the maxcontacts is given by the class */
338                         td->maxcontacts = td->mtclass.maxcontacts;
339
340                 break;
341         }
342 }
343
344 static void set_abs(struct input_dev *input, unsigned int code,
345                 struct hid_field *field, int snratio)
346 {
347         int fmin = field->logical_minimum;
348         int fmax = field->logical_maximum;
349         int fuzz = snratio ? (fmax - fmin) / snratio : 0;
350         input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
351         input_abs_set_res(input, code, hidinput_calc_abs_res(field, code));
352 }
353
354 static void mt_store_field(struct hid_usage *usage, struct mt_device *td,
355                 struct hid_input *hi)
356 {
357         struct mt_fields *f = td->fields;
358
359         if (f->length >= HID_MAX_FIELDS)
360                 return;
361
362         f->usages[f->length++] = usage->hid;
363 }
364
365 static int mt_pen_input_mapping(struct hid_device *hdev, struct hid_input *hi,
366                 struct hid_field *field, struct hid_usage *usage,
367                 unsigned long **bit, int *max)
368 {
369         struct mt_device *td = hid_get_drvdata(hdev);
370
371         td->pen_report_id = field->report->id;
372
373         return 0;
374 }
375
376 static int mt_pen_input_mapped(struct hid_device *hdev, struct hid_input *hi,
377                 struct hid_field *field, struct hid_usage *usage,
378                 unsigned long **bit, int *max)
379 {
380         return 0;
381 }
382
383 static int mt_pen_event(struct hid_device *hid, struct hid_field *field,
384                                 struct hid_usage *usage, __s32 value)
385 {
386         /* let hid-input handle it */
387         return 0;
388 }
389
390 static void mt_pen_report(struct hid_device *hid, struct hid_report *report)
391 {
392         struct hid_field *field = report->field[0];
393
394         input_sync(field->hidinput->input);
395 }
396
397 static void mt_pen_input_configured(struct hid_device *hdev,
398                                         struct hid_input *hi)
399 {
400         /* force BTN_STYLUS to allow tablet matching in udev */
401         __set_bit(BTN_STYLUS, hi->input->keybit);
402 }
403
404 static int mt_touch_input_mapping(struct hid_device *hdev, struct hid_input *hi,
405                 struct hid_field *field, struct hid_usage *usage,
406                 unsigned long **bit, int *max)
407 {
408         struct mt_device *td = hid_get_drvdata(hdev);
409         struct mt_class *cls = &td->mtclass;
410         int code;
411         struct hid_usage *prev_usage = NULL;
412
413         if (field->application == HID_DG_TOUCHSCREEN)
414                 td->mt_flags |= INPUT_MT_DIRECT;
415
416         /*
417          * Model touchscreens providing buttons as touchpads.
418          */
419         if (field->application == HID_DG_TOUCHPAD ||
420             (usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON)
421                 td->mt_flags |= INPUT_MT_POINTER;
422
423         if (usage->usage_index)
424                 prev_usage = &field->usage[usage->usage_index - 1];
425
426         switch (usage->hid & HID_USAGE_PAGE) {
427
428         case HID_UP_GENDESK:
429                 switch (usage->hid) {
430                 case HID_GD_X:
431                         if (prev_usage && (prev_usage->hid == usage->hid)) {
432                                 hid_map_usage(hi, usage, bit, max,
433                                         EV_ABS, ABS_MT_TOOL_X);
434                                 set_abs(hi->input, ABS_MT_TOOL_X, field,
435                                         cls->sn_move);
436                         } else {
437                                 hid_map_usage(hi, usage, bit, max,
438                                         EV_ABS, ABS_MT_POSITION_X);
439                                 set_abs(hi->input, ABS_MT_POSITION_X, field,
440                                         cls->sn_move);
441                         }
442
443                         mt_store_field(usage, td, hi);
444                         return 1;
445                 case HID_GD_Y:
446                         if (prev_usage && (prev_usage->hid == usage->hid)) {
447                                 hid_map_usage(hi, usage, bit, max,
448                                         EV_ABS, ABS_MT_TOOL_Y);
449                                 set_abs(hi->input, ABS_MT_TOOL_Y, field,
450                                         cls->sn_move);
451                         } else {
452                                 hid_map_usage(hi, usage, bit, max,
453                                         EV_ABS, ABS_MT_POSITION_Y);
454                                 set_abs(hi->input, ABS_MT_POSITION_Y, field,
455                                         cls->sn_move);
456                         }
457
458                         mt_store_field(usage, td, hi);
459                         return 1;
460                 }
461                 return 0;
462
463         case HID_UP_DIGITIZER:
464                 switch (usage->hid) {
465                 case HID_DG_INRANGE:
466                         if (cls->quirks & MT_QUIRK_HOVERING) {
467                                 hid_map_usage(hi, usage, bit, max,
468                                         EV_ABS, ABS_MT_DISTANCE);
469                                 input_set_abs_params(hi->input,
470                                         ABS_MT_DISTANCE, 0, 1, 0, 0);
471                         }
472                         mt_store_field(usage, td, hi);
473                         return 1;
474                 case HID_DG_CONFIDENCE:
475                         mt_store_field(usage, td, hi);
476                         return 1;
477                 case HID_DG_TIPSWITCH:
478                         hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_TOUCH);
479                         input_set_capability(hi->input, EV_KEY, BTN_TOUCH);
480                         mt_store_field(usage, td, hi);
481                         return 1;
482                 case HID_DG_CONTACTID:
483                         mt_store_field(usage, td, hi);
484                         td->touches_by_report++;
485                         td->mt_report_id = field->report->id;
486                         return 1;
487                 case HID_DG_WIDTH:
488                         hid_map_usage(hi, usage, bit, max,
489                                         EV_ABS, ABS_MT_TOUCH_MAJOR);
490                         if (!(cls->quirks & MT_QUIRK_NO_AREA))
491                                 set_abs(hi->input, ABS_MT_TOUCH_MAJOR, field,
492                                         cls->sn_width);
493                         mt_store_field(usage, td, hi);
494                         return 1;
495                 case HID_DG_HEIGHT:
496                         hid_map_usage(hi, usage, bit, max,
497                                         EV_ABS, ABS_MT_TOUCH_MINOR);
498                         if (!(cls->quirks & MT_QUIRK_NO_AREA)) {
499                                 set_abs(hi->input, ABS_MT_TOUCH_MINOR, field,
500                                         cls->sn_height);
501                                 input_set_abs_params(hi->input,
502                                         ABS_MT_ORIENTATION, 0, 1, 0, 0);
503                         }
504                         mt_store_field(usage, td, hi);
505                         return 1;
506                 case HID_DG_TIPPRESSURE:
507                         hid_map_usage(hi, usage, bit, max,
508                                         EV_ABS, ABS_MT_PRESSURE);
509                         set_abs(hi->input, ABS_MT_PRESSURE, field,
510                                 cls->sn_pressure);
511                         mt_store_field(usage, td, hi);
512                         return 1;
513                 case HID_DG_CONTACTCOUNT:
514                         td->cc_index = field->index;
515                         td->cc_value_index = usage->usage_index;
516                         return 1;
517                 case HID_DG_CONTACTMAX:
518                         /* we don't set td->last_slot_field as contactcount and
519                          * contact max are global to the report */
520                         return -1;
521                 case HID_DG_TOUCH:
522                         /* Legacy devices use TIPSWITCH and not TOUCH.
523                          * Let's just ignore this field. */
524                         return -1;
525                 }
526                 /* let hid-input decide for the others */
527                 return 0;
528
529         case HID_UP_BUTTON:
530                 code = BTN_MOUSE + ((usage->hid - 1) & HID_USAGE);
531                 hid_map_usage(hi, usage, bit, max, EV_KEY, code);
532                 input_set_capability(hi->input, EV_KEY, code);
533                 return 1;
534
535         case 0xff000000:
536                 /* we do not want to map these: no input-oriented meaning */
537                 return -1;
538         }
539
540         return 0;
541 }
542
543 static int mt_touch_input_mapped(struct hid_device *hdev, struct hid_input *hi,
544                 struct hid_field *field, struct hid_usage *usage,
545                 unsigned long **bit, int *max)
546 {
547         if (usage->type == EV_KEY || usage->type == EV_ABS)
548                 set_bit(usage->type, hi->input->evbit);
549
550         return -1;
551 }
552
553 static int mt_compute_slot(struct mt_device *td, struct input_dev *input)
554 {
555         __s32 quirks = td->mtclass.quirks;
556
557         if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
558                 return td->curdata.contactid;
559
560         if (quirks & MT_QUIRK_CYPRESS)
561                 return cypress_compute_slot(td);
562
563         if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
564                 return td->num_received;
565
566         if (quirks & MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE)
567                 return td->curdata.contactid - 1;
568
569         return input_mt_get_slot_by_key(input, td->curdata.contactid);
570 }
571
572 /*
573  * this function is called when a whole contact has been processed,
574  * so that it can assign it to a slot and store the data there
575  */
576 static void mt_complete_slot(struct mt_device *td, struct input_dev *input)
577 {
578         if ((td->mtclass.quirks & MT_QUIRK_CONTACT_CNT_ACCURATE) &&
579             td->num_received >= td->num_expected)
580                 return;
581
582         if (td->curvalid || (td->mtclass.quirks & MT_QUIRK_ALWAYS_VALID)) {
583                 int slotnum = mt_compute_slot(td, input);
584                 struct mt_slot *s = &td->curdata;
585                 struct input_mt *mt = input->mt;
586
587                 if (slotnum < 0 || slotnum >= td->maxcontacts)
588                         return;
589
590                 if ((td->mtclass.quirks & MT_QUIRK_IGNORE_DUPLICATES) && mt) {
591                         struct input_mt_slot *slot = &mt->slots[slotnum];
592                         if (input_mt_is_active(slot) &&
593                             input_mt_is_used(mt, slot))
594                                 return;
595                 }
596
597                 input_mt_slot(input, slotnum);
598                 input_mt_report_slot_state(input, MT_TOOL_FINGER,
599                         s->touch_state || s->inrange_state);
600                 if (s->touch_state || s->inrange_state) {
601                         /* this finger is in proximity of the sensor */
602                         int wide = (s->w > s->h);
603                         /* divided by two to match visual scale of touch */
604                         int major = max(s->w, s->h) >> 1;
605                         int minor = min(s->w, s->h) >> 1;
606
607                         input_event(input, EV_ABS, ABS_MT_POSITION_X, s->x);
608                         input_event(input, EV_ABS, ABS_MT_POSITION_Y, s->y);
609                         input_event(input, EV_ABS, ABS_MT_TOOL_X, s->cx);
610                         input_event(input, EV_ABS, ABS_MT_TOOL_Y, s->cy);
611                         input_event(input, EV_ABS, ABS_MT_DISTANCE,
612                                 !s->touch_state);
613                         input_event(input, EV_ABS, ABS_MT_ORIENTATION, wide);
614                         input_event(input, EV_ABS, ABS_MT_PRESSURE, s->p);
615                         input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
616                         input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
617                 }
618         }
619
620         td->num_received++;
621 }
622
623 /*
624  * this function is called when a whole packet has been received and processed,
625  * so that it can decide what to send to the input layer.
626  */
627 static void mt_sync_frame(struct mt_device *td, struct input_dev *input)
628 {
629         input_mt_sync_frame(input);
630         input_sync(input);
631         td->num_received = 0;
632 }
633
634 static int mt_touch_event(struct hid_device *hid, struct hid_field *field,
635                                 struct hid_usage *usage, __s32 value)
636 {
637         /* we will handle the hidinput part later, now remains hiddev */
638         if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
639                 hid->hiddev_hid_event(hid, field, usage, value);
640
641         return 1;
642 }
643
644 static void mt_process_mt_event(struct hid_device *hid, struct hid_field *field,
645                                 struct hid_usage *usage, __s32 value)
646 {
647         struct mt_device *td = hid_get_drvdata(hid);
648         __s32 quirks = td->mtclass.quirks;
649         struct input_dev *input = field->hidinput->input;
650
651         if (hid->claimed & HID_CLAIMED_INPUT) {
652                 switch (usage->hid) {
653                 case HID_DG_INRANGE:
654                         if (quirks & MT_QUIRK_VALID_IS_INRANGE)
655                                 td->curvalid = value;
656                         if (quirks & MT_QUIRK_HOVERING)
657                                 td->curdata.inrange_state = value;
658                         break;
659                 case HID_DG_TIPSWITCH:
660                         if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
661                                 td->curvalid = value;
662                         td->curdata.touch_state = value;
663                         break;
664                 case HID_DG_CONFIDENCE:
665                         if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
666                                 td->curvalid = value;
667                         break;
668                 case HID_DG_CONTACTID:
669                         td->curdata.contactid = value;
670                         break;
671                 case HID_DG_TIPPRESSURE:
672                         td->curdata.p = value;
673                         break;
674                 case HID_GD_X:
675                         if (usage->code == ABS_MT_TOOL_X)
676                                 td->curdata.cx = value;
677                         else
678                                 td->curdata.x = value;
679                         break;
680                 case HID_GD_Y:
681                         if (usage->code == ABS_MT_TOOL_Y)
682                                 td->curdata.cy = value;
683                         else
684                                 td->curdata.y = value;
685                         break;
686                 case HID_DG_WIDTH:
687                         td->curdata.w = value;
688                         break;
689                 case HID_DG_HEIGHT:
690                         td->curdata.h = value;
691                         break;
692                 case HID_DG_CONTACTCOUNT:
693                         break;
694                 case HID_DG_TOUCH:
695                         /* do nothing */
696                         break;
697
698                 default:
699                         if (usage->type)
700                                 input_event(input, usage->type, usage->code,
701                                                 value);
702                         return;
703                 }
704
705                 if (usage->usage_index + 1 == field->report_count) {
706                         /* we only take into account the last report. */
707                         if (usage->hid == td->last_slot_field)
708                                 mt_complete_slot(td, field->hidinput->input);
709                 }
710
711         }
712 }
713
714 static void mt_touch_report(struct hid_device *hid, struct hid_report *report)
715 {
716         struct mt_device *td = hid_get_drvdata(hid);
717         struct hid_field *field;
718         unsigned count;
719         int r, n;
720
721         /*
722          * Includes multi-packet support where subsequent
723          * packets are sent with zero contactcount.
724          */
725         if (td->cc_index >= 0) {
726                 struct hid_field *field = report->field[td->cc_index];
727                 int value = field->value[td->cc_value_index];
728                 if (value)
729                         td->num_expected = value;
730         }
731
732         for (r = 0; r < report->maxfield; r++) {
733                 field = report->field[r];
734                 count = field->report_count;
735
736                 if (!(HID_MAIN_ITEM_VARIABLE & field->flags))
737                         continue;
738
739                 for (n = 0; n < count; n++)
740                         mt_process_mt_event(hid, field, &field->usage[n],
741                                         field->value[n]);
742         }
743
744         if (td->num_received >= td->num_expected)
745                 mt_sync_frame(td, report->field[0]->hidinput->input);
746 }
747
748 static void mt_touch_input_configured(struct hid_device *hdev,
749                                         struct hid_input *hi)
750 {
751         struct mt_device *td = hid_get_drvdata(hdev);
752         struct mt_class *cls = &td->mtclass;
753         struct input_dev *input = hi->input;
754
755         if (!td->maxcontacts)
756                 td->maxcontacts = MT_DEFAULT_MAXCONTACT;
757
758         mt_post_parse(td);
759         if (td->serial_maybe)
760                 mt_post_parse_default_settings(td);
761
762         if (cls->is_indirect)
763                 td->mt_flags |= INPUT_MT_POINTER;
764
765         if (cls->quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
766                 td->mt_flags |= INPUT_MT_DROP_UNUSED;
767
768         input_mt_init_slots(input, td->maxcontacts, td->mt_flags);
769
770         td->mt_flags = 0;
771 }
772
773 static int mt_input_mapping(struct hid_device *hdev, struct hid_input *hi,
774                 struct hid_field *field, struct hid_usage *usage,
775                 unsigned long **bit, int *max)
776 {
777         /* Only map fields from TouchScreen or TouchPad collections.
778         * We need to ignore fields that belong to other collections
779         * such as Mouse that might have the same GenericDesktop usages. */
780         if (field->application != HID_DG_TOUCHSCREEN &&
781             field->application != HID_DG_PEN &&
782             field->application != HID_DG_TOUCHPAD)
783                 return -1;
784
785         if (field->physical == HID_DG_STYLUS)
786                 return mt_pen_input_mapping(hdev, hi, field, usage, bit, max);
787
788         return mt_touch_input_mapping(hdev, hi, field, usage, bit, max);
789 }
790
791 static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
792                 struct hid_field *field, struct hid_usage *usage,
793                 unsigned long **bit, int *max)
794 {
795         if (field->physical == HID_DG_STYLUS)
796                 return mt_pen_input_mapped(hdev, hi, field, usage, bit, max);
797
798         return mt_touch_input_mapped(hdev, hi, field, usage, bit, max);
799 }
800
801 static int mt_event(struct hid_device *hid, struct hid_field *field,
802                                 struct hid_usage *usage, __s32 value)
803 {
804         struct mt_device *td = hid_get_drvdata(hid);
805
806         if (field->report->id == td->mt_report_id)
807                 return mt_touch_event(hid, field, usage, value);
808
809         if (field->report->id == td->pen_report_id)
810                 return mt_pen_event(hid, field, usage, value);
811
812         /* ignore other reports */
813         return 1;
814 }
815
816 static void mt_report(struct hid_device *hid, struct hid_report *report)
817 {
818         struct mt_device *td = hid_get_drvdata(hid);
819
820         if (!(hid->claimed & HID_CLAIMED_INPUT))
821                 return;
822
823         if (report->id == td->mt_report_id)
824                 mt_touch_report(hid, report);
825
826         if (report->id == td->pen_report_id)
827                 mt_pen_report(hid, report);
828 }
829
830 static void mt_set_input_mode(struct hid_device *hdev)
831 {
832         struct mt_device *td = hid_get_drvdata(hdev);
833         struct hid_report *r;
834         struct hid_report_enum *re;
835
836         if (td->inputmode < 0)
837                 return;
838
839         re = &(hdev->report_enum[HID_FEATURE_REPORT]);
840         r = re->report_id_hash[td->inputmode];
841         if (r) {
842                 r->field[0]->value[td->inputmode_index] = 0x02;
843                 hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
844         }
845 }
846
847 static void mt_set_maxcontacts(struct hid_device *hdev)
848 {
849         struct mt_device *td = hid_get_drvdata(hdev);
850         struct hid_report *r;
851         struct hid_report_enum *re;
852         int fieldmax, max;
853
854         if (td->maxcontact_report_id < 0)
855                 return;
856
857         if (!td->mtclass.maxcontacts)
858                 return;
859
860         re = &hdev->report_enum[HID_FEATURE_REPORT];
861         r = re->report_id_hash[td->maxcontact_report_id];
862         if (r) {
863                 max = td->mtclass.maxcontacts;
864                 fieldmax = r->field[0]->logical_maximum;
865                 max = min(fieldmax, max);
866                 if (r->field[0]->value[0] != max) {
867                         r->field[0]->value[0] = max;
868                         hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
869                 }
870         }
871 }
872
873 static void mt_post_parse_default_settings(struct mt_device *td)
874 {
875         __s32 quirks = td->mtclass.quirks;
876
877         /* unknown serial device needs special quirks */
878         if (td->touches_by_report == 1) {
879                 quirks |= MT_QUIRK_ALWAYS_VALID;
880                 quirks &= ~MT_QUIRK_NOT_SEEN_MEANS_UP;
881                 quirks &= ~MT_QUIRK_VALID_IS_INRANGE;
882                 quirks &= ~MT_QUIRK_VALID_IS_CONFIDENCE;
883                 quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
884         }
885
886         td->mtclass.quirks = quirks;
887 }
888
889 static void mt_post_parse(struct mt_device *td)
890 {
891         struct mt_fields *f = td->fields;
892         struct mt_class *cls = &td->mtclass;
893
894         if (td->touches_by_report > 0) {
895                 int field_count_per_touch = f->length / td->touches_by_report;
896                 td->last_slot_field = f->usages[field_count_per_touch - 1];
897         }
898
899         if (td->cc_index < 0)
900                 cls->quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
901 }
902
903 static void mt_input_configured(struct hid_device *hdev, struct hid_input *hi)
904 {
905         struct mt_device *td = hid_get_drvdata(hdev);
906         char *name;
907         const char *suffix = NULL;
908
909         if (hi->report->id == td->mt_report_id)
910                 mt_touch_input_configured(hdev, hi);
911
912         if (hi->report->field[0]->physical == HID_DG_STYLUS) {
913                 suffix = "Pen";
914                 mt_pen_input_configured(hdev, hi);
915         }
916
917         if (suffix) {
918                 name = devm_kzalloc(&hi->input->dev,
919                                     strlen(hdev->name) + strlen(suffix) + 2,
920                                     GFP_KERNEL);
921                 if (name) {
922                         sprintf(name, "%s %s", hdev->name, suffix);
923                         hi->input->name = name;
924                 }
925         }
926 }
927
928 static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
929 {
930         int ret, i;
931         struct mt_device *td;
932         struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */
933
934         for (i = 0; mt_classes[i].name ; i++) {
935                 if (id->driver_data == mt_classes[i].name) {
936                         mtclass = &(mt_classes[i]);
937                         break;
938                 }
939         }
940
941         /* This allows the driver to correctly support devices
942          * that emit events over several HID messages.
943          */
944         hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
945
946         /*
947          * This allows the driver to handle different input sensors
948          * that emits events through different reports on the same HID
949          * device.
950          */
951         hdev->quirks |= HID_QUIRK_MULTI_INPUT;
952         hdev->quirks |= HID_QUIRK_NO_EMPTY_INPUT;
953
954         td = devm_kzalloc(&hdev->dev, sizeof(struct mt_device), GFP_KERNEL);
955         if (!td) {
956                 dev_err(&hdev->dev, "cannot allocate multitouch data\n");
957                 return -ENOMEM;
958         }
959         td->mtclass = *mtclass;
960         td->inputmode = -1;
961         td->maxcontact_report_id = -1;
962         td->cc_index = -1;
963         td->mt_report_id = -1;
964         td->pen_report_id = -1;
965         hid_set_drvdata(hdev, td);
966
967         td->fields = devm_kzalloc(&hdev->dev, sizeof(struct mt_fields),
968                                   GFP_KERNEL);
969         if (!td->fields) {
970                 dev_err(&hdev->dev, "cannot allocate multitouch fields data\n");
971                 return -ENOMEM;
972         }
973
974         if (id->vendor == HID_ANY_ID && id->product == HID_ANY_ID)
975                 td->serial_maybe = true;
976
977         ret = hid_parse(hdev);
978         if (ret != 0)
979                 return ret;
980
981         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
982         if (ret)
983                 return ret;
984
985         ret = sysfs_create_group(&hdev->dev.kobj, &mt_attribute_group);
986
987         mt_set_maxcontacts(hdev);
988         mt_set_input_mode(hdev);
989
990         /* release .fields memory as it is not used anymore */
991         devm_kfree(&hdev->dev, td->fields);
992         td->fields = NULL;
993
994         return 0;
995 }
996
997 #ifdef CONFIG_PM
998 static int mt_reset_resume(struct hid_device *hdev)
999 {
1000         mt_set_maxcontacts(hdev);
1001         mt_set_input_mode(hdev);
1002         return 0;
1003 }
1004
1005 static int mt_resume(struct hid_device *hdev)
1006 {
1007         /* Some Elan legacy devices require SET_IDLE to be set on resume.
1008          * It should be safe to send it to other devices too.
1009          * Tested on 3M, Stantum, Cypress, Zytronic, eGalax, and Elan panels. */
1010
1011         hid_hw_idle(hdev, 0, 0, HID_REQ_SET_IDLE);
1012
1013         return 0;
1014 }
1015 #endif
1016
1017 static void mt_remove(struct hid_device *hdev)
1018 {
1019         sysfs_remove_group(&hdev->dev.kobj, &mt_attribute_group);
1020         hid_hw_stop(hdev);
1021 }
1022
1023 static const struct hid_device_id mt_devices[] = {
1024
1025         /* 3M panels */
1026         { .driver_data = MT_CLS_3M,
1027                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1028                         USB_DEVICE_ID_3M1968) },
1029         { .driver_data = MT_CLS_3M,
1030                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1031                         USB_DEVICE_ID_3M2256) },
1032         { .driver_data = MT_CLS_3M,
1033                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1034                         USB_DEVICE_ID_3M3266) },
1035
1036         /* ActionStar panels */
1037         { .driver_data = MT_CLS_NSMU,
1038                 MT_USB_DEVICE(USB_VENDOR_ID_ACTIONSTAR,
1039                         USB_DEVICE_ID_ACTIONSTAR_1011) },
1040
1041         /* Atmel panels */
1042         { .driver_data = MT_CLS_SERIAL,
1043                 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL,
1044                         USB_DEVICE_ID_ATMEL_MULTITOUCH) },
1045         { .driver_data = MT_CLS_SERIAL,
1046                 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL,
1047                         USB_DEVICE_ID_ATMEL_MXT_DIGITIZER) },
1048
1049         /* Baanto multitouch devices */
1050         { .driver_data = MT_CLS_NSMU,
1051                 MT_USB_DEVICE(USB_VENDOR_ID_BAANTO,
1052                         USB_DEVICE_ID_BAANTO_MT_190W2) },
1053         /* Cando panels */
1054         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1055                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1056                         USB_DEVICE_ID_CANDO_MULTI_TOUCH) },
1057         { .driver_data = MT_CLS_DUAL_CONTACT_NUMBER,
1058                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1059                         USB_DEVICE_ID_CANDO_MULTI_TOUCH_10_1) },
1060         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1061                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1062                         USB_DEVICE_ID_CANDO_MULTI_TOUCH_11_6) },
1063         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1064                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1065                         USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6) },
1066
1067         /* Chunghwa Telecom touch panels */
1068         {  .driver_data = MT_CLS_NSMU,
1069                 MT_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT,
1070                         USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH) },
1071
1072         /* CVTouch panels */
1073         { .driver_data = MT_CLS_NSMU,
1074                 MT_USB_DEVICE(USB_VENDOR_ID_CVTOUCH,
1075                         USB_DEVICE_ID_CVTOUCH_SCREEN) },
1076
1077         /* Cypress panel */
1078         { .driver_data = MT_CLS_CYPRESS,
1079                 HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS,
1080                         USB_DEVICE_ID_CYPRESS_TRUETOUCH) },
1081
1082         /* Data Modul easyMaxTouch */
1083         { .driver_data = MT_CLS_DEFAULT,
1084                 MT_USB_DEVICE(USB_VENDOR_ID_DATA_MODUL,
1085                         USB_VENDOR_ID_DATA_MODUL_EASYMAXTOUCH) },
1086
1087         /* eGalax devices (resistive) */
1088         { .driver_data = MT_CLS_EGALAX,
1089                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1090                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D) },
1091         { .driver_data = MT_CLS_EGALAX,
1092                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1093                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E) },
1094
1095         /* eGalax devices (capacitive) */
1096         { .driver_data = MT_CLS_EGALAX_SERIAL,
1097                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1098                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7207) },
1099         { .driver_data = MT_CLS_EGALAX,
1100                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1101                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C) },
1102         { .driver_data = MT_CLS_EGALAX_SERIAL,
1103                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1104                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224) },
1105         { .driver_data = MT_CLS_EGALAX_SERIAL,
1106                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1107                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_722A) },
1108         { .driver_data = MT_CLS_EGALAX_SERIAL,
1109                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1110                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_725E) },
1111         { .driver_data = MT_CLS_EGALAX_SERIAL,
1112                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1113                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7262) },
1114         { .driver_data = MT_CLS_EGALAX,
1115                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1116                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B) },
1117         { .driver_data = MT_CLS_EGALAX,
1118                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1119                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1) },
1120         { .driver_data = MT_CLS_EGALAX_SERIAL,
1121                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1122                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72AA) },
1123         { .driver_data = MT_CLS_EGALAX,
1124                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1125                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72C4) },
1126         { .driver_data = MT_CLS_EGALAX,
1127                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1128                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72D0) },
1129         { .driver_data = MT_CLS_EGALAX,
1130                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1131                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA) },
1132         { .driver_data = MT_CLS_EGALAX,
1133                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1134                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302) },
1135         { .driver_data = MT_CLS_EGALAX_SERIAL,
1136                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1137                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7349) },
1138         { .driver_data = MT_CLS_EGALAX_SERIAL,
1139                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1140                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_73F7) },
1141         { .driver_data = MT_CLS_EGALAX_SERIAL,
1142                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1143                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001) },
1144
1145         /* Elo TouchSystems IntelliTouch Plus panel */
1146         { .driver_data = MT_CLS_DUAL_CONTACT_ID,
1147                 MT_USB_DEVICE(USB_VENDOR_ID_ELO,
1148                         USB_DEVICE_ID_ELO_TS2515) },
1149
1150         /* Flatfrog Panels */
1151         { .driver_data = MT_CLS_FLATFROG,
1152                 MT_USB_DEVICE(USB_VENDOR_ID_FLATFROG,
1153                         USB_DEVICE_ID_MULTITOUCH_3200) },
1154
1155         /* GeneralTouch panel */
1156         { .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1157                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1158                         USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
1159         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1160                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1161                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PWT_TENFINGERS) },
1162
1163         /* Gametel game controller */
1164         { .driver_data = MT_CLS_NSMU,
1165                 MT_BT_DEVICE(USB_VENDOR_ID_FRUCTEL,
1166                         USB_DEVICE_ID_GAMETEL_MT_MODE) },
1167
1168         /* GoodTouch panels */
1169         { .driver_data = MT_CLS_NSMU,
1170                 MT_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH,
1171                         USB_DEVICE_ID_GOODTOUCH_000f) },
1172
1173         /* Hanvon panels */
1174         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1175                 MT_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT,
1176                         USB_DEVICE_ID_HANVON_ALT_MULTITOUCH) },
1177
1178         /* Ideacom panel */
1179         { .driver_data = MT_CLS_SERIAL,
1180                 MT_USB_DEVICE(USB_VENDOR_ID_IDEACOM,
1181                         USB_DEVICE_ID_IDEACOM_IDC6650) },
1182         { .driver_data = MT_CLS_SERIAL,
1183                 MT_USB_DEVICE(USB_VENDOR_ID_IDEACOM,
1184                         USB_DEVICE_ID_IDEACOM_IDC6651) },
1185
1186         /* Ilitek dual touch panel */
1187         {  .driver_data = MT_CLS_NSMU,
1188                 MT_USB_DEVICE(USB_VENDOR_ID_ILITEK,
1189                         USB_DEVICE_ID_ILITEK_MULTITOUCH) },
1190
1191         /* IRTOUCH panels */
1192         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1193                 MT_USB_DEVICE(USB_VENDOR_ID_IRTOUCHSYSTEMS,
1194                         USB_DEVICE_ID_IRTOUCH_INFRARED_USB) },
1195
1196         /* LG Display panels */
1197         { .driver_data = MT_CLS_DEFAULT,
1198                 MT_USB_DEVICE(USB_VENDOR_ID_LG,
1199                         USB_DEVICE_ID_LG_MULTITOUCH) },
1200
1201         /* Lumio panels */
1202         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1203                 MT_USB_DEVICE(USB_VENDOR_ID_LUMIO,
1204                         USB_DEVICE_ID_CRYSTALTOUCH) },
1205         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1206                 MT_USB_DEVICE(USB_VENDOR_ID_LUMIO,
1207                         USB_DEVICE_ID_CRYSTALTOUCH_DUAL) },
1208
1209         /* MosArt panels */
1210         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1211                 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
1212                         USB_DEVICE_ID_ASUS_T91MT)},
1213         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1214                 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
1215                         USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO) },
1216         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1217                 MT_USB_DEVICE(USB_VENDOR_ID_TURBOX,
1218                         USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART) },
1219
1220         /* Nexio panels */
1221         { .driver_data = MT_CLS_DEFAULT,
1222                 MT_USB_DEVICE(USB_VENDOR_ID_NEXIO,
1223                         USB_DEVICE_ID_NEXIO_MULTITOUCH_420)},
1224
1225         /* Panasonic panels */
1226         { .driver_data = MT_CLS_PANASONIC,
1227                 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
1228                         USB_DEVICE_ID_PANABOARD_UBT780) },
1229         { .driver_data = MT_CLS_PANASONIC,
1230                 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
1231                         USB_DEVICE_ID_PANABOARD_UBT880) },
1232
1233         /* Novatek Panel */
1234         { .driver_data = MT_CLS_NSMU,
1235                 MT_USB_DEVICE(USB_VENDOR_ID_NOVATEK,
1236                         USB_DEVICE_ID_NOVATEK_PCT) },
1237
1238         /* PenMount panels */
1239         { .driver_data = MT_CLS_CONFIDENCE,
1240                 MT_USB_DEVICE(USB_VENDOR_ID_PENMOUNT,
1241                         USB_DEVICE_ID_PENMOUNT_PCI) },
1242
1243         /* PixArt optical touch screen */
1244         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1245                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1246                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN) },
1247         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1248                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1249                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1) },
1250         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1251                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1252                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2) },
1253
1254         /* PixCir-based panels */
1255         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1256                 MT_USB_DEVICE(USB_VENDOR_ID_HANVON,
1257                         USB_DEVICE_ID_HANVON_MULTITOUCH) },
1258         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1259                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1260                         USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
1261
1262         /* Quanta-based panels */
1263         { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
1264                 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
1265                         USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH) },
1266         { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
1267                 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
1268                         USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001) },
1269         { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
1270                 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
1271                         USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3008) },
1272
1273         /* Stantum panels */
1274         { .driver_data = MT_CLS_CONFIDENCE,
1275                 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM,
1276                         USB_DEVICE_ID_MTP)},
1277         { .driver_data = MT_CLS_CONFIDENCE,
1278                 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM,
1279                         USB_DEVICE_ID_MTP_STM)},
1280         { .driver_data = MT_CLS_DEFAULT,
1281                 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_SITRONIX,
1282                         USB_DEVICE_ID_MTP_SITRONIX)},
1283
1284         /* TopSeed panels */
1285         { .driver_data = MT_CLS_TOPSEED,
1286                 MT_USB_DEVICE(USB_VENDOR_ID_TOPSEED2,
1287                         USB_DEVICE_ID_TOPSEED2_PERIPAD_701) },
1288
1289         /* Touch International panels */
1290         { .driver_data = MT_CLS_NSMU,
1291                 MT_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL,
1292                         USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH) },
1293
1294         /* Unitec panels */
1295         { .driver_data = MT_CLS_NSMU,
1296                 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
1297                         USB_DEVICE_ID_UNITEC_USB_TOUCH_0709) },
1298         { .driver_data = MT_CLS_NSMU,
1299                 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
1300                         USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19) },
1301         /* XAT */
1302         { .driver_data = MT_CLS_NSMU,
1303                 MT_USB_DEVICE(USB_VENDOR_ID_XAT,
1304                         USB_DEVICE_ID_XAT_CSR) },
1305
1306         /* Xiroku */
1307         { .driver_data = MT_CLS_NSMU,
1308                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1309                         USB_DEVICE_ID_XIROKU_SPX) },
1310         { .driver_data = MT_CLS_NSMU,
1311                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1312                         USB_DEVICE_ID_XIROKU_MPX) },
1313         { .driver_data = MT_CLS_NSMU,
1314                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1315                         USB_DEVICE_ID_XIROKU_CSR) },
1316         { .driver_data = MT_CLS_NSMU,
1317                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1318                         USB_DEVICE_ID_XIROKU_SPX1) },
1319         { .driver_data = MT_CLS_NSMU,
1320                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1321                         USB_DEVICE_ID_XIROKU_MPX1) },
1322         { .driver_data = MT_CLS_NSMU,
1323                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1324                         USB_DEVICE_ID_XIROKU_CSR1) },
1325         { .driver_data = MT_CLS_NSMU,
1326                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1327                         USB_DEVICE_ID_XIROKU_SPX2) },
1328         { .driver_data = MT_CLS_NSMU,
1329                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1330                         USB_DEVICE_ID_XIROKU_MPX2) },
1331         { .driver_data = MT_CLS_NSMU,
1332                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1333                         USB_DEVICE_ID_XIROKU_CSR2) },
1334
1335         /* Zytronic panels */
1336         { .driver_data = MT_CLS_SERIAL,
1337                 MT_USB_DEVICE(USB_VENDOR_ID_ZYTRONIC,
1338                         USB_DEVICE_ID_ZYTRONIC_ZXY100) },
1339
1340         /* Generic MT device */
1341         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH, HID_ANY_ID, HID_ANY_ID) },
1342
1343         /* Generic Win 8 certified MT device */
1344         {  .driver_data = MT_CLS_WIN_8,
1345                 HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH_WIN_8,
1346                         HID_ANY_ID, HID_ANY_ID) },
1347         { }
1348 };
1349 MODULE_DEVICE_TABLE(hid, mt_devices);
1350
1351 static const struct hid_usage_id mt_grabbed_usages[] = {
1352         { HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
1353         { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
1354 };
1355
1356 static struct hid_driver mt_driver = {
1357         .name = "hid-multitouch",
1358         .id_table = mt_devices,
1359         .probe = mt_probe,
1360         .remove = mt_remove,
1361         .input_mapping = mt_input_mapping,
1362         .input_mapped = mt_input_mapped,
1363         .input_configured = mt_input_configured,
1364         .feature_mapping = mt_feature_mapping,
1365         .usage_table = mt_grabbed_usages,
1366         .event = mt_event,
1367         .report = mt_report,
1368 #ifdef CONFIG_PM
1369         .reset_resume = mt_reset_resume,
1370         .resume = mt_resume,
1371 #endif
1372 };
1373 module_hid_driver(mt_driver);