GNU Linux-libre 4.14.332-gnu1
[releases.git] / 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/input/mt.h>
46 #include <linux/string.h>
47 #include <linux/timer.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      BIT(0)
59 #define MT_QUIRK_SLOT_IS_CONTACTID      BIT(1)
60 #define MT_QUIRK_CYPRESS                BIT(2)
61 #define MT_QUIRK_SLOT_IS_CONTACTNUMBER  BIT(3)
62 #define MT_QUIRK_ALWAYS_VALID           BIT(4)
63 #define MT_QUIRK_VALID_IS_INRANGE       BIT(5)
64 #define MT_QUIRK_VALID_IS_CONFIDENCE    BIT(6)
65 #define MT_QUIRK_CONFIDENCE             BIT(7)
66 #define MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE    BIT(8)
67 #define MT_QUIRK_NO_AREA                BIT(9)
68 #define MT_QUIRK_IGNORE_DUPLICATES      BIT(10)
69 #define MT_QUIRK_HOVERING               BIT(11)
70 #define MT_QUIRK_CONTACT_CNT_ACCURATE   BIT(12)
71 #define MT_QUIRK_FORCE_GET_FEATURE      BIT(13)
72 #define MT_QUIRK_FIX_CONST_CONTACT_ID   BIT(14)
73 #define MT_QUIRK_TOUCH_SIZE_SCALING     BIT(15)
74 #define MT_QUIRK_STICKY_FINGERS         BIT(16)
75 #define MT_QUIRK_ASUS_CUSTOM_UP         BIT(17)
76
77 #define MT_INPUTMODE_TOUCHSCREEN        0x02
78 #define MT_INPUTMODE_TOUCHPAD           0x03
79
80 #define MT_BUTTONTYPE_CLICKPAD          0
81
82 #define MT_IO_FLAGS_RUNNING             0
83 #define MT_IO_FLAGS_ACTIVE_SLOTS        1
84 #define MT_IO_FLAGS_PENDING_SLOTS       2
85
86 struct mt_slot {
87         __s32 x, y, cx, cy, p, w, h;
88         __s32 contactid;        /* the device ContactID assigned to this slot */
89         bool touch_state;       /* is the touch valid? */
90         bool inrange_state;     /* is the finger in proximity of the sensor? */
91         bool confidence_state;  /* is the touch made by a finger? */
92 };
93
94 struct mt_class {
95         __s32 name;     /* MT_CLS */
96         __s32 quirks;
97         __s32 sn_move;  /* Signal/noise ratio for move events */
98         __s32 sn_width; /* Signal/noise ratio for width events */
99         __s32 sn_height;        /* Signal/noise ratio for height events */
100         __s32 sn_pressure;      /* Signal/noise ratio for pressure events */
101         __u8 maxcontacts;
102         bool is_indirect;       /* true for touchpads */
103         bool export_all_inputs; /* do not ignore mouse, keyboards, etc... */
104 };
105
106 struct mt_fields {
107         unsigned usages[HID_MAX_FIELDS];
108         unsigned int length;
109 };
110
111 struct mt_device {
112         struct mt_slot curdata; /* placeholder of incoming data */
113         struct mt_class mtclass;        /* our mt device class */
114         struct timer_list release_timer;        /* to release sticky fingers */
115         struct mt_fields *fields;       /* temporary placeholder for storing the
116                                            multitouch fields */
117         unsigned long mt_io_flags;      /* mt flags (MT_IO_FLAGS_*) */
118         int cc_index;   /* contact count field index in the report */
119         int cc_value_index;     /* contact count value index in the field */
120         unsigned last_slot_field;       /* the last field of a slot */
121         unsigned mt_report_id;  /* the report ID of the multitouch device */
122         unsigned long initial_quirks;   /* initial quirks state */
123         __s16 inputmode;        /* InputMode HID feature, -1 if non-existent */
124         __s16 inputmode_index;  /* InputMode HID feature index in the report */
125         __s16 maxcontact_report_id;     /* Maximum Contact Number HID feature,
126                                    -1 if non-existent */
127         __u8 inputmode_value;  /* InputMode HID feature value */
128         __u8 num_received;      /* how many contacts we received */
129         __u8 num_expected;      /* expected last contact index */
130         __u8 maxcontacts;
131         __u8 touches_by_report; /* how many touches are present in one report:
132                                 * 1 means we should use a serial protocol
133                                 * > 1 means hybrid (multitouch) protocol */
134         __u8 buttons_count;     /* number of physical buttons per touchpad */
135         bool is_buttonpad;      /* is this device a button pad? */
136         bool serial_maybe;      /* need to check for serial protocol */
137         bool curvalid;          /* is the current contact valid? */
138         unsigned mt_flags;      /* flags to pass to input-mt */
139 };
140
141 static void mt_post_parse_default_settings(struct mt_device *td);
142 static void mt_post_parse(struct mt_device *td);
143
144 /* classes of device behavior */
145 #define MT_CLS_DEFAULT                          0x0001
146
147 #define MT_CLS_SERIAL                           0x0002
148 #define MT_CLS_CONFIDENCE                       0x0003
149 #define MT_CLS_CONFIDENCE_CONTACT_ID            0x0004
150 #define MT_CLS_CONFIDENCE_MINUS_ONE             0x0005
151 #define MT_CLS_DUAL_INRANGE_CONTACTID           0x0006
152 #define MT_CLS_DUAL_INRANGE_CONTACTNUMBER       0x0007
153 /* reserved                                     0x0008 */
154 #define MT_CLS_INRANGE_CONTACTNUMBER            0x0009
155 #define MT_CLS_NSMU                             0x000a
156 /* reserved                                     0x0010 */
157 /* reserved                                     0x0011 */
158 #define MT_CLS_WIN_8                            0x0012
159 #define MT_CLS_EXPORT_ALL_INPUTS                0x0013
160 #define MT_CLS_WIN_8_DUAL                       0x0014
161
162 /* vendor specific classes */
163 #define MT_CLS_3M                               0x0101
164 /* reserved                                     0x0102 */
165 #define MT_CLS_EGALAX                           0x0103
166 #define MT_CLS_EGALAX_SERIAL                    0x0104
167 #define MT_CLS_TOPSEED                          0x0105
168 #define MT_CLS_PANASONIC                        0x0106
169 #define MT_CLS_FLATFROG                         0x0107
170 #define MT_CLS_GENERALTOUCH_TWOFINGERS          0x0108
171 #define MT_CLS_GENERALTOUCH_PWT_TENFINGERS      0x0109
172 #define MT_CLS_LG                               0x010a
173 #define MT_CLS_ASUS                             0x010b
174 #define MT_CLS_VTL                              0x0110
175 #define MT_CLS_GOOGLE                           0x0111
176
177 #define MT_DEFAULT_MAXCONTACT   10
178 #define MT_MAX_MAXCONTACT       250
179
180 #define MT_USB_DEVICE(v, p)     HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH, v, p)
181 #define MT_BT_DEVICE(v, p)      HID_DEVICE(BUS_BLUETOOTH, HID_GROUP_MULTITOUCH, v, p)
182
183 /*
184  * these device-dependent functions determine what slot corresponds
185  * to a valid contact that was just read.
186  */
187
188 static int cypress_compute_slot(struct mt_device *td)
189 {
190         if (td->curdata.contactid != 0 || td->num_received == 0)
191                 return td->curdata.contactid;
192         else
193                 return -1;
194 }
195
196 static struct mt_class mt_classes[] = {
197         { .name = MT_CLS_DEFAULT,
198                 .quirks = MT_QUIRK_ALWAYS_VALID |
199                         MT_QUIRK_CONTACT_CNT_ACCURATE },
200         { .name = MT_CLS_NSMU,
201                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP },
202         { .name = MT_CLS_SERIAL,
203                 .quirks = MT_QUIRK_ALWAYS_VALID},
204         { .name = MT_CLS_CONFIDENCE,
205                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE },
206         { .name = MT_CLS_CONFIDENCE_CONTACT_ID,
207                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
208                         MT_QUIRK_SLOT_IS_CONTACTID },
209         { .name = MT_CLS_CONFIDENCE_MINUS_ONE,
210                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
211                         MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE },
212         { .name = MT_CLS_DUAL_INRANGE_CONTACTID,
213                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
214                         MT_QUIRK_SLOT_IS_CONTACTID,
215                 .maxcontacts = 2 },
216         { .name = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
217                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
218                         MT_QUIRK_SLOT_IS_CONTACTNUMBER,
219                 .maxcontacts = 2 },
220         { .name = MT_CLS_INRANGE_CONTACTNUMBER,
221                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
222                         MT_QUIRK_SLOT_IS_CONTACTNUMBER },
223         { .name = MT_CLS_WIN_8,
224                 .quirks = MT_QUIRK_ALWAYS_VALID |
225                         MT_QUIRK_IGNORE_DUPLICATES |
226                         MT_QUIRK_HOVERING |
227                         MT_QUIRK_CONTACT_CNT_ACCURATE |
228                         MT_QUIRK_STICKY_FINGERS },
229         { .name = MT_CLS_EXPORT_ALL_INPUTS,
230                 .quirks = MT_QUIRK_ALWAYS_VALID |
231                         MT_QUIRK_CONTACT_CNT_ACCURATE,
232                 .export_all_inputs = true },
233         { .name = MT_CLS_WIN_8_DUAL,
234                 .quirks = MT_QUIRK_ALWAYS_VALID |
235                         MT_QUIRK_IGNORE_DUPLICATES |
236                         MT_QUIRK_HOVERING |
237                         MT_QUIRK_CONTACT_CNT_ACCURATE,
238                 .export_all_inputs = true },
239
240         /*
241          * vendor specific classes
242          */
243         { .name = MT_CLS_3M,
244                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
245                         MT_QUIRK_SLOT_IS_CONTACTID |
246                         MT_QUIRK_TOUCH_SIZE_SCALING,
247                 .sn_move = 2048,
248                 .sn_width = 128,
249                 .sn_height = 128,
250                 .maxcontacts = 60,
251         },
252         { .name = MT_CLS_EGALAX,
253                 .quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
254                         MT_QUIRK_VALID_IS_INRANGE,
255                 .sn_move = 4096,
256                 .sn_pressure = 32,
257         },
258         { .name = MT_CLS_EGALAX_SERIAL,
259                 .quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
260                         MT_QUIRK_ALWAYS_VALID,
261                 .sn_move = 4096,
262                 .sn_pressure = 32,
263         },
264         { .name = MT_CLS_TOPSEED,
265                 .quirks = MT_QUIRK_ALWAYS_VALID,
266                 .is_indirect = true,
267                 .maxcontacts = 2,
268         },
269         { .name = MT_CLS_PANASONIC,
270                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP,
271                 .maxcontacts = 4 },
272         { .name = MT_CLS_GENERALTOUCH_TWOFINGERS,
273                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
274                         MT_QUIRK_VALID_IS_INRANGE |
275                         MT_QUIRK_SLOT_IS_CONTACTID,
276                 .maxcontacts = 2
277         },
278         { .name = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
279                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
280                         MT_QUIRK_SLOT_IS_CONTACTID
281         },
282
283         { .name = MT_CLS_FLATFROG,
284                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
285                         MT_QUIRK_NO_AREA,
286                 .sn_move = 2048,
287                 .maxcontacts = 40,
288         },
289         { .name = MT_CLS_LG,
290                 .quirks = MT_QUIRK_ALWAYS_VALID |
291                         MT_QUIRK_FIX_CONST_CONTACT_ID |
292                         MT_QUIRK_IGNORE_DUPLICATES |
293                         MT_QUIRK_HOVERING |
294                         MT_QUIRK_CONTACT_CNT_ACCURATE },
295         { .name = MT_CLS_ASUS,
296                 .quirks = MT_QUIRK_ALWAYS_VALID |
297                         MT_QUIRK_CONTACT_CNT_ACCURATE |
298                         MT_QUIRK_ASUS_CUSTOM_UP },
299         { .name = MT_CLS_VTL,
300                 .quirks = MT_QUIRK_ALWAYS_VALID |
301                         MT_QUIRK_CONTACT_CNT_ACCURATE |
302                         MT_QUIRK_FORCE_GET_FEATURE,
303         },
304         { .name = MT_CLS_GOOGLE,
305                 .quirks = MT_QUIRK_ALWAYS_VALID |
306                         MT_QUIRK_CONTACT_CNT_ACCURATE |
307                         MT_QUIRK_SLOT_IS_CONTACTID |
308                         MT_QUIRK_HOVERING
309         },
310         { }
311 };
312
313 static ssize_t mt_show_quirks(struct device *dev,
314                            struct device_attribute *attr,
315                            char *buf)
316 {
317         struct hid_device *hdev = to_hid_device(dev);
318         struct mt_device *td = hid_get_drvdata(hdev);
319
320         return sprintf(buf, "%u\n", td->mtclass.quirks);
321 }
322
323 static ssize_t mt_set_quirks(struct device *dev,
324                           struct device_attribute *attr,
325                           const char *buf, size_t count)
326 {
327         struct hid_device *hdev = to_hid_device(dev);
328         struct mt_device *td = hid_get_drvdata(hdev);
329
330         unsigned long val;
331
332         if (kstrtoul(buf, 0, &val))
333                 return -EINVAL;
334
335         td->mtclass.quirks = val;
336
337         if (td->cc_index < 0)
338                 td->mtclass.quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
339
340         return count;
341 }
342
343 static DEVICE_ATTR(quirks, S_IWUSR | S_IRUGO, mt_show_quirks, mt_set_quirks);
344
345 static struct attribute *sysfs_attrs[] = {
346         &dev_attr_quirks.attr,
347         NULL
348 };
349
350 static const struct attribute_group mt_attribute_group = {
351         .attrs = sysfs_attrs
352 };
353
354 static void mt_get_feature(struct hid_device *hdev, struct hid_report *report)
355 {
356         struct mt_device *td = hid_get_drvdata(hdev);
357         int ret;
358         u32 size = hid_report_len(report);
359         u8 *buf;
360
361         /*
362          * Do not fetch the feature report if the device has been explicitly
363          * marked as non-capable.
364          */
365         if (td->initial_quirks & HID_QUIRK_NO_INIT_REPORTS)
366                 return;
367
368         buf = hid_alloc_report_buf(report, GFP_KERNEL);
369         if (!buf)
370                 return;
371
372         ret = hid_hw_raw_request(hdev, report->id, buf, size,
373                                  HID_FEATURE_REPORT, HID_REQ_GET_REPORT);
374         if (ret < 0) {
375                 dev_warn(&hdev->dev, "failed to fetch feature %d\n",
376                          report->id);
377         } else {
378                 ret = hid_report_raw_event(hdev, HID_FEATURE_REPORT, buf,
379                                            size, 0);
380                 if (ret)
381                         dev_warn(&hdev->dev, "failed to report feature\n");
382         }
383
384         kfree(buf);
385 }
386
387 static void mt_feature_mapping(struct hid_device *hdev,
388                 struct hid_field *field, struct hid_usage *usage)
389 {
390         struct mt_device *td = hid_get_drvdata(hdev);
391
392         switch (usage->hid) {
393         case HID_DG_INPUTMODE:
394                 /* Ignore if value index is out of bounds. */
395                 if (usage->usage_index >= field->report_count) {
396                         dev_err(&hdev->dev, "HID_DG_INPUTMODE out of range\n");
397                         break;
398                 }
399
400                 if (td->inputmode < 0) {
401                         td->inputmode = field->report->id;
402                         td->inputmode_index = usage->usage_index;
403                 } else {
404                         /*
405                          * Some elan panels wrongly declare 2 input mode
406                          * features, and silently ignore when we set the
407                          * value in the second field. Skip the second feature
408                          * and hope for the best.
409                          */
410                         dev_info(&hdev->dev,
411                                  "Ignoring the extra HID_DG_INPUTMODE\n");
412                 }
413
414                 break;
415         case HID_DG_CONTACTMAX:
416                 mt_get_feature(hdev, field->report);
417
418                 td->maxcontact_report_id = field->report->id;
419                 td->maxcontacts = field->value[0];
420                 if (!td->maxcontacts &&
421                     field->logical_maximum <= MT_MAX_MAXCONTACT)
422                         td->maxcontacts = field->logical_maximum;
423                 if (td->mtclass.maxcontacts)
424                         /* check if the maxcontacts is given by the class */
425                         td->maxcontacts = td->mtclass.maxcontacts;
426
427                 break;
428         case HID_DG_BUTTONTYPE:
429                 if (usage->usage_index >= field->report_count) {
430                         dev_err(&hdev->dev, "HID_DG_BUTTONTYPE out of range\n");
431                         break;
432                 }
433
434                 mt_get_feature(hdev, field->report);
435                 if (field->value[usage->usage_index] == MT_BUTTONTYPE_CLICKPAD)
436                         td->is_buttonpad = true;
437
438                 break;
439         case 0xff0000c5:
440                 /* Retrieve the Win8 blob once to enable some devices */
441                 if (usage->usage_index == 0)
442                         mt_get_feature(hdev, field->report);
443                 break;
444         }
445 }
446
447 static void set_abs(struct input_dev *input, unsigned int code,
448                 struct hid_field *field, int snratio)
449 {
450         int fmin = field->logical_minimum;
451         int fmax = field->logical_maximum;
452         int fuzz = snratio ? (fmax - fmin) / snratio : 0;
453         input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
454         input_abs_set_res(input, code, hidinput_calc_abs_res(field, code));
455 }
456
457 static void mt_store_field(struct hid_usage *usage, struct mt_device *td,
458                 struct hid_input *hi)
459 {
460         struct mt_fields *f = td->fields;
461
462         if (f->length >= HID_MAX_FIELDS)
463                 return;
464
465         f->usages[f->length++] = usage->hid;
466 }
467
468 static int mt_touch_input_mapping(struct hid_device *hdev, struct hid_input *hi,
469                 struct hid_field *field, struct hid_usage *usage,
470                 unsigned long **bit, int *max)
471 {
472         struct mt_device *td = hid_get_drvdata(hdev);
473         struct mt_class *cls = &td->mtclass;
474         int code;
475         struct hid_usage *prev_usage = NULL;
476
477         if (field->application == HID_DG_TOUCHSCREEN)
478                 td->mt_flags |= INPUT_MT_DIRECT;
479
480         /*
481          * Model touchscreens providing buttons as touchpads.
482          */
483         if (field->application == HID_DG_TOUCHPAD ||
484             (usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON) {
485                 td->mt_flags |= INPUT_MT_POINTER;
486                 td->inputmode_value = MT_INPUTMODE_TOUCHPAD;
487         }
488
489         /* count the buttons on touchpads */
490         if ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON)
491                 td->buttons_count++;
492
493         if (usage->usage_index)
494                 prev_usage = &field->usage[usage->usage_index - 1];
495
496         switch (usage->hid & HID_USAGE_PAGE) {
497
498         case HID_UP_GENDESK:
499                 switch (usage->hid) {
500                 case HID_GD_X:
501                         if (prev_usage && (prev_usage->hid == usage->hid)) {
502                                 hid_map_usage(hi, usage, bit, max,
503                                         EV_ABS, ABS_MT_TOOL_X);
504                                 set_abs(hi->input, ABS_MT_TOOL_X, field,
505                                         cls->sn_move);
506                         } else {
507                                 hid_map_usage(hi, usage, bit, max,
508                                         EV_ABS, ABS_MT_POSITION_X);
509                                 set_abs(hi->input, ABS_MT_POSITION_X, field,
510                                         cls->sn_move);
511                         }
512
513                         mt_store_field(usage, td, hi);
514                         return 1;
515                 case HID_GD_Y:
516                         if (prev_usage && (prev_usage->hid == usage->hid)) {
517                                 hid_map_usage(hi, usage, bit, max,
518                                         EV_ABS, ABS_MT_TOOL_Y);
519                                 set_abs(hi->input, ABS_MT_TOOL_Y, field,
520                                         cls->sn_move);
521                         } else {
522                                 hid_map_usage(hi, usage, bit, max,
523                                         EV_ABS, ABS_MT_POSITION_Y);
524                                 set_abs(hi->input, ABS_MT_POSITION_Y, field,
525                                         cls->sn_move);
526                         }
527
528                         mt_store_field(usage, td, hi);
529                         return 1;
530                 }
531                 return 0;
532
533         case HID_UP_DIGITIZER:
534                 switch (usage->hid) {
535                 case HID_DG_INRANGE:
536                         if (cls->quirks & MT_QUIRK_HOVERING) {
537                                 hid_map_usage(hi, usage, bit, max,
538                                         EV_ABS, ABS_MT_DISTANCE);
539                                 input_set_abs_params(hi->input,
540                                         ABS_MT_DISTANCE, 0, 1, 0, 0);
541                         }
542                         mt_store_field(usage, td, hi);
543                         return 1;
544                 case HID_DG_CONFIDENCE:
545                         if ((cls->name == MT_CLS_WIN_8 ||
546                                 cls->name == MT_CLS_WIN_8_DUAL) &&
547                                 field->application == HID_DG_TOUCHPAD)
548                                 cls->quirks |= MT_QUIRK_CONFIDENCE;
549                         mt_store_field(usage, td, hi);
550                         return 1;
551                 case HID_DG_TIPSWITCH:
552                         hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_TOUCH);
553                         input_set_capability(hi->input, EV_KEY, BTN_TOUCH);
554                         mt_store_field(usage, td, hi);
555                         return 1;
556                 case HID_DG_CONTACTID:
557                         mt_store_field(usage, td, hi);
558                         td->touches_by_report++;
559                         td->mt_report_id = field->report->id;
560                         return 1;
561                 case HID_DG_WIDTH:
562                         hid_map_usage(hi, usage, bit, max,
563                                         EV_ABS, ABS_MT_TOUCH_MAJOR);
564                         if (!(cls->quirks & MT_QUIRK_NO_AREA))
565                                 set_abs(hi->input, ABS_MT_TOUCH_MAJOR, field,
566                                         cls->sn_width);
567                         mt_store_field(usage, td, hi);
568                         return 1;
569                 case HID_DG_HEIGHT:
570                         hid_map_usage(hi, usage, bit, max,
571                                         EV_ABS, ABS_MT_TOUCH_MINOR);
572                         if (!(cls->quirks & MT_QUIRK_NO_AREA)) {
573                                 set_abs(hi->input, ABS_MT_TOUCH_MINOR, field,
574                                         cls->sn_height);
575                                 input_set_abs_params(hi->input,
576                                         ABS_MT_ORIENTATION, 0, 1, 0, 0);
577                         }
578                         mt_store_field(usage, td, hi);
579                         return 1;
580                 case HID_DG_TIPPRESSURE:
581                         hid_map_usage(hi, usage, bit, max,
582                                         EV_ABS, ABS_MT_PRESSURE);
583                         set_abs(hi->input, ABS_MT_PRESSURE, field,
584                                 cls->sn_pressure);
585                         mt_store_field(usage, td, hi);
586                         return 1;
587                 case HID_DG_CONTACTCOUNT:
588                         /* Ignore if indexes are out of bounds. */
589                         if (field->index >= field->report->maxfield ||
590                             usage->usage_index >= field->report_count)
591                                 return 1;
592                         td->cc_index = field->index;
593                         td->cc_value_index = usage->usage_index;
594                         return 1;
595                 case HID_DG_CONTACTMAX:
596                         /* we don't set td->last_slot_field as contactcount and
597                          * contact max are global to the report */
598                         return -1;
599                 case HID_DG_TOUCH:
600                         /* Legacy devices use TIPSWITCH and not TOUCH.
601                          * Let's just ignore this field. */
602                         return -1;
603                 }
604                 /* let hid-input decide for the others */
605                 return 0;
606
607         case HID_UP_BUTTON:
608                 code = BTN_MOUSE + ((usage->hid - 1) & HID_USAGE);
609                 /*
610                  * MS PTP spec says that external buttons left and right have
611                  * usages 2 and 3.
612                  */
613                 if ((cls->name == MT_CLS_WIN_8 ||
614                         cls->name == MT_CLS_WIN_8_DUAL) &&
615                     field->application == HID_DG_TOUCHPAD &&
616                     (usage->hid & HID_USAGE) > 1)
617                         code--;
618                 hid_map_usage(hi, usage, bit, max, EV_KEY, code);
619                 if (!*bit)
620                         return -1;
621                 input_set_capability(hi->input, EV_KEY, code);
622                 return 1;
623
624         case 0xff000000:
625                 /* we do not want to map these: no input-oriented meaning */
626                 return -1;
627         }
628
629         return 0;
630 }
631
632 static int mt_compute_slot(struct mt_device *td, struct input_dev *input)
633 {
634         __s32 quirks = td->mtclass.quirks;
635
636         if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
637                 return td->curdata.contactid;
638
639         if (quirks & MT_QUIRK_CYPRESS)
640                 return cypress_compute_slot(td);
641
642         if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
643                 return td->num_received;
644
645         if (quirks & MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE)
646                 return td->curdata.contactid - 1;
647
648         return input_mt_get_slot_by_key(input, td->curdata.contactid);
649 }
650
651 /*
652  * this function is called when a whole contact has been processed,
653  * so that it can assign it to a slot and store the data there
654  */
655 static void mt_complete_slot(struct mt_device *td, struct input_dev *input)
656 {
657         if ((td->mtclass.quirks & MT_QUIRK_CONTACT_CNT_ACCURATE) &&
658             td->num_received >= td->num_expected)
659                 return;
660
661         if (td->curvalid || (td->mtclass.quirks & MT_QUIRK_ALWAYS_VALID)) {
662                 int active;
663                 int slotnum = mt_compute_slot(td, input);
664                 struct mt_slot *s = &td->curdata;
665                 struct input_mt *mt = input->mt;
666
667                 if (slotnum < 0 || slotnum >= td->maxcontacts)
668                         return;
669
670                 if ((td->mtclass.quirks & MT_QUIRK_IGNORE_DUPLICATES) && mt) {
671                         struct input_mt_slot *slot = &mt->slots[slotnum];
672                         if (input_mt_is_active(slot) &&
673                             input_mt_is_used(mt, slot))
674                                 return;
675                 }
676
677                 if (!(td->mtclass.quirks & MT_QUIRK_CONFIDENCE))
678                         s->confidence_state = 1;
679                 active = (s->touch_state || s->inrange_state) &&
680                                                         s->confidence_state;
681
682                 input_mt_slot(input, slotnum);
683                 input_mt_report_slot_state(input, MT_TOOL_FINGER, active);
684                 if (active) {
685                         /* this finger is in proximity of the sensor */
686                         int wide = (s->w > s->h);
687                         int major = max(s->w, s->h);
688                         int minor = min(s->w, s->h);
689
690                         /*
691                          * divided by two to match visual scale of touch
692                          * for devices with this quirk
693                          */
694                         if (td->mtclass.quirks & MT_QUIRK_TOUCH_SIZE_SCALING) {
695                                 major = major >> 1;
696                                 minor = minor >> 1;
697                         }
698
699                         input_event(input, EV_ABS, ABS_MT_POSITION_X, s->x);
700                         input_event(input, EV_ABS, ABS_MT_POSITION_Y, s->y);
701                         input_event(input, EV_ABS, ABS_MT_TOOL_X, s->cx);
702                         input_event(input, EV_ABS, ABS_MT_TOOL_Y, s->cy);
703                         input_event(input, EV_ABS, ABS_MT_DISTANCE,
704                                 !s->touch_state);
705                         input_event(input, EV_ABS, ABS_MT_ORIENTATION, wide);
706                         input_event(input, EV_ABS, ABS_MT_PRESSURE, s->p);
707                         input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
708                         input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
709
710                         set_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags);
711                 }
712         }
713
714         td->num_received++;
715 }
716
717 /*
718  * this function is called when a whole packet has been received and processed,
719  * so that it can decide what to send to the input layer.
720  */
721 static void mt_sync_frame(struct mt_device *td, struct input_dev *input)
722 {
723         input_mt_sync_frame(input);
724         input_sync(input);
725         td->num_received = 0;
726         if (test_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags))
727                 set_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags);
728         else
729                 clear_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags);
730         clear_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags);
731 }
732
733 static int mt_touch_event(struct hid_device *hid, struct hid_field *field,
734                                 struct hid_usage *usage, __s32 value)
735 {
736         /* we will handle the hidinput part later, now remains hiddev */
737         if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
738                 hid->hiddev_hid_event(hid, field, usage, value);
739
740         return 1;
741 }
742
743 static void mt_process_mt_event(struct hid_device *hid, struct hid_field *field,
744                                 struct hid_usage *usage, __s32 value,
745                                 bool first_packet)
746 {
747         struct mt_device *td = hid_get_drvdata(hid);
748         __s32 cls = td->mtclass.name;
749         __s32 quirks = td->mtclass.quirks;
750         struct input_dev *input = field->hidinput->input;
751
752         if (hid->claimed & HID_CLAIMED_INPUT) {
753                 switch (usage->hid) {
754                 case HID_DG_INRANGE:
755                         if (quirks & MT_QUIRK_VALID_IS_INRANGE)
756                                 td->curvalid = value;
757                         if (quirks & MT_QUIRK_HOVERING)
758                                 td->curdata.inrange_state = value;
759                         break;
760                 case HID_DG_TIPSWITCH:
761                         if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
762                                 td->curvalid = value;
763                         td->curdata.touch_state = value;
764                         break;
765                 case HID_DG_CONFIDENCE:
766                         if (quirks & MT_QUIRK_CONFIDENCE)
767                                 td->curdata.confidence_state = value;
768                         if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
769                                 td->curvalid = value;
770                         break;
771                 case HID_DG_CONTACTID:
772                         td->curdata.contactid = value;
773                         break;
774                 case HID_DG_TIPPRESSURE:
775                         td->curdata.p = value;
776                         break;
777                 case HID_GD_X:
778                         if (usage->code == ABS_MT_TOOL_X)
779                                 td->curdata.cx = value;
780                         else
781                                 td->curdata.x = value;
782                         break;
783                 case HID_GD_Y:
784                         if (usage->code == ABS_MT_TOOL_Y)
785                                 td->curdata.cy = value;
786                         else
787                                 td->curdata.y = value;
788                         break;
789                 case HID_DG_WIDTH:
790                         td->curdata.w = value;
791                         break;
792                 case HID_DG_HEIGHT:
793                         td->curdata.h = value;
794                         break;
795                 case HID_DG_CONTACTCOUNT:
796                         break;
797                 case HID_DG_TOUCH:
798                         /* do nothing */
799                         break;
800
801                 default:
802                         /*
803                          * For Win8 PTP touchpads we should only look at
804                          * non finger/touch events in the first_packet of
805                          * a (possible) multi-packet frame.
806                          */
807                         if ((cls == MT_CLS_WIN_8 || cls == MT_CLS_WIN_8_DUAL) &&
808                             !first_packet)
809                                 return;
810
811                         if (usage->type)
812                                 input_event(input, usage->type, usage->code,
813                                                 value);
814                         return;
815                 }
816
817                 if (usage->usage_index + 1 == field->report_count) {
818                         /* we only take into account the last report. */
819                         if (usage->hid == td->last_slot_field)
820                                 mt_complete_slot(td, field->hidinput->input);
821                 }
822
823         }
824 }
825
826 static void mt_touch_report(struct hid_device *hid, struct hid_report *report)
827 {
828         struct mt_device *td = hid_get_drvdata(hid);
829         struct hid_field *field;
830         bool first_packet;
831         unsigned count;
832         int r, n;
833
834         /* sticky fingers release in progress, abort */
835         if (test_and_set_bit_lock(MT_IO_FLAGS_RUNNING, &td->mt_io_flags))
836                 return;
837
838         /*
839          * Includes multi-packet support where subsequent
840          * packets are sent with zero contactcount.
841          */
842         if (td->cc_index >= 0) {
843                 struct hid_field *field = report->field[td->cc_index];
844                 int value = field->value[td->cc_value_index];
845                 if (value)
846                         td->num_expected = value;
847         }
848
849         first_packet = td->num_received == 0;
850         for (r = 0; r < report->maxfield; r++) {
851                 field = report->field[r];
852                 count = field->report_count;
853
854                 if (!(HID_MAIN_ITEM_VARIABLE & field->flags))
855                         continue;
856
857                 for (n = 0; n < count; n++)
858                         mt_process_mt_event(hid, field, &field->usage[n],
859                                             field->value[n], first_packet);
860         }
861
862         if (td->num_received >= td->num_expected)
863                 mt_sync_frame(td, report->field[0]->hidinput->input);
864
865         /*
866          * Windows 8 specs says 2 things:
867          * - once a contact has been reported, it has to be reported in each
868          *   subsequent report
869          * - the report rate when fingers are present has to be at least
870          *   the refresh rate of the screen, 60 or 120 Hz
871          *
872          * I interprete this that the specification forces a report rate of
873          * at least 60 Hz for a touchscreen to be certified.
874          * Which means that if we do not get a report whithin 16 ms, either
875          * something wrong happens, either the touchscreen forgets to send
876          * a release. Taking a reasonable margin allows to remove issues
877          * with USB communication or the load of the machine.
878          *
879          * Given that Win 8 devices are forced to send a release, this will
880          * only affect laggish machines and the ones that have a firmware
881          * defect.
882          */
883         if (td->mtclass.quirks & MT_QUIRK_STICKY_FINGERS) {
884                 if (test_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags))
885                         mod_timer(&td->release_timer,
886                                   jiffies + msecs_to_jiffies(100));
887                 else
888                         del_timer(&td->release_timer);
889         }
890
891         clear_bit_unlock(MT_IO_FLAGS_RUNNING, &td->mt_io_flags);
892 }
893
894 static int mt_touch_input_configured(struct hid_device *hdev,
895                                         struct hid_input *hi)
896 {
897         struct mt_device *td = hid_get_drvdata(hdev);
898         struct mt_class *cls = &td->mtclass;
899         struct input_dev *input = hi->input;
900         int ret;
901
902         if (!td->maxcontacts)
903                 td->maxcontacts = MT_DEFAULT_MAXCONTACT;
904
905         mt_post_parse(td);
906         if (td->serial_maybe)
907                 mt_post_parse_default_settings(td);
908
909         if (cls->is_indirect)
910                 td->mt_flags |= INPUT_MT_POINTER;
911
912         if (cls->quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
913                 td->mt_flags |= INPUT_MT_DROP_UNUSED;
914
915         /* check for clickpads */
916         if ((td->mt_flags & INPUT_MT_POINTER) && (td->buttons_count == 1))
917                 td->is_buttonpad = true;
918
919         if (td->is_buttonpad)
920                 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
921
922         ret = input_mt_init_slots(input, td->maxcontacts, td->mt_flags);
923         if (ret)
924                 return ret;
925
926         td->mt_flags = 0;
927         return 0;
928 }
929
930 #define mt_map_key_clear(c)     hid_map_usage_clear(hi, usage, bit, \
931                                                     max, EV_KEY, (c))
932 static int mt_input_mapping(struct hid_device *hdev, struct hid_input *hi,
933                 struct hid_field *field, struct hid_usage *usage,
934                 unsigned long **bit, int *max)
935 {
936         struct mt_device *td = hid_get_drvdata(hdev);
937
938         /*
939          * If mtclass.export_all_inputs is not set, only map fields from
940          * TouchScreen or TouchPad collections. We need to ignore fields
941          * that belong to other collections such as Mouse that might have
942          * the same GenericDesktop usages.
943          */
944         if (!td->mtclass.export_all_inputs &&
945             field->application != HID_DG_TOUCHSCREEN &&
946             field->application != HID_DG_PEN &&
947             field->application != HID_DG_TOUCHPAD &&
948             field->application != HID_GD_KEYBOARD &&
949             field->application != HID_GD_SYSTEM_CONTROL &&
950             field->application != HID_CP_CONSUMER_CONTROL &&
951             field->application != HID_GD_WIRELESS_RADIO_CTLS &&
952             !(field->application == HID_VD_ASUS_CUSTOM_MEDIA_KEYS &&
953               td->mtclass.quirks & MT_QUIRK_ASUS_CUSTOM_UP))
954                 return -1;
955
956         /*
957          * Some Asus keyboard+touchpad devices have the hotkeys defined in the
958          * touchpad report descriptor. We need to treat these as an array to
959          * map usages to input keys.
960          */
961         if (field->application == HID_VD_ASUS_CUSTOM_MEDIA_KEYS &&
962             td->mtclass.quirks & MT_QUIRK_ASUS_CUSTOM_UP &&
963             (usage->hid & HID_USAGE_PAGE) == HID_UP_CUSTOM) {
964                 set_bit(EV_REP, hi->input->evbit);
965                 if (field->flags & HID_MAIN_ITEM_VARIABLE)
966                         field->flags &= ~HID_MAIN_ITEM_VARIABLE;
967                 switch (usage->hid & HID_USAGE) {
968                 case 0x10: mt_map_key_clear(KEY_BRIGHTNESSDOWN);        break;
969                 case 0x20: mt_map_key_clear(KEY_BRIGHTNESSUP);          break;
970                 case 0x35: mt_map_key_clear(KEY_DISPLAY_OFF);           break;
971                 case 0x6b: mt_map_key_clear(KEY_F21);                   break;
972                 case 0x6c: mt_map_key_clear(KEY_SLEEP);                 break;
973                 default:
974                         return -1;
975                 }
976                 return 1;
977         }
978
979         /*
980          * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
981          * for the stylus.
982          * The check for mt_report_id ensures we don't process
983          * HID_DG_CONTACTCOUNT from the pen report as it is outside the physical
984          * collection, but within the report ID.
985          */
986         if (field->physical == HID_DG_STYLUS)
987                 return 0;
988         else if ((field->physical == 0) &&
989                  (field->report->id != td->mt_report_id) &&
990                  (td->mt_report_id != -1))
991                 return 0;
992
993         if (field->application == HID_DG_TOUCHSCREEN ||
994             field->application == HID_DG_TOUCHPAD)
995                 return mt_touch_input_mapping(hdev, hi, field, usage, bit, max);
996
997         /* let hid-core decide for the others */
998         return 0;
999 }
1000
1001 static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
1002                 struct hid_field *field, struct hid_usage *usage,
1003                 unsigned long **bit, int *max)
1004 {
1005         /*
1006          * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
1007          * for the stylus.
1008          */
1009         if (field->physical == HID_DG_STYLUS)
1010                 return 0;
1011
1012         if (field->application == HID_DG_TOUCHSCREEN ||
1013             field->application == HID_DG_TOUCHPAD) {
1014                 /* We own these mappings, tell hid-input to ignore them */
1015                 return -1;
1016         }
1017
1018         /* let hid-core decide for the others */
1019         return 0;
1020 }
1021
1022 static int mt_event(struct hid_device *hid, struct hid_field *field,
1023                                 struct hid_usage *usage, __s32 value)
1024 {
1025         struct mt_device *td = hid_get_drvdata(hid);
1026
1027         if (field->report->id == td->mt_report_id)
1028                 return mt_touch_event(hid, field, usage, value);
1029
1030         return 0;
1031 }
1032
1033 static void mt_report(struct hid_device *hid, struct hid_report *report)
1034 {
1035         struct mt_device *td = hid_get_drvdata(hid);
1036         struct hid_field *field = report->field[0];
1037
1038         if (!(hid->claimed & HID_CLAIMED_INPUT))
1039                 return;
1040
1041         if (report->id == td->mt_report_id)
1042                 return mt_touch_report(hid, report);
1043
1044         if (field && field->hidinput && field->hidinput->input)
1045                 input_sync(field->hidinput->input);
1046 }
1047
1048 static void mt_set_input_mode(struct hid_device *hdev)
1049 {
1050         struct mt_device *td = hid_get_drvdata(hdev);
1051         struct hid_report *r;
1052         struct hid_report_enum *re;
1053         struct mt_class *cls = &td->mtclass;
1054         char *buf;
1055         u32 report_len;
1056
1057         if (td->inputmode < 0)
1058                 return;
1059
1060         re = &(hdev->report_enum[HID_FEATURE_REPORT]);
1061         r = re->report_id_hash[td->inputmode];
1062         if (r) {
1063                 if (cls->quirks & MT_QUIRK_FORCE_GET_FEATURE) {
1064                         report_len = hid_report_len(r);
1065                         buf = hid_alloc_report_buf(r, GFP_KERNEL);
1066                         if (!buf) {
1067                                 hid_err(hdev, "failed to allocate buffer for report\n");
1068                                 return;
1069                         }
1070                         hid_hw_raw_request(hdev, r->id, buf, report_len,
1071                                            HID_FEATURE_REPORT,
1072                                            HID_REQ_GET_REPORT);
1073                         kfree(buf);
1074                 }
1075                 r->field[0]->value[td->inputmode_index] = td->inputmode_value;
1076                 hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
1077         }
1078 }
1079
1080 static void mt_set_maxcontacts(struct hid_device *hdev)
1081 {
1082         struct mt_device *td = hid_get_drvdata(hdev);
1083         struct hid_report *r;
1084         struct hid_report_enum *re;
1085         int fieldmax, max;
1086
1087         if (td->maxcontact_report_id < 0)
1088                 return;
1089
1090         if (!td->mtclass.maxcontacts)
1091                 return;
1092
1093         re = &hdev->report_enum[HID_FEATURE_REPORT];
1094         r = re->report_id_hash[td->maxcontact_report_id];
1095         if (r) {
1096                 max = td->mtclass.maxcontacts;
1097                 fieldmax = r->field[0]->logical_maximum;
1098                 max = min(fieldmax, max);
1099                 if (r->field[0]->value[0] != max) {
1100                         r->field[0]->value[0] = max;
1101                         hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
1102                 }
1103         }
1104 }
1105
1106 static void mt_post_parse_default_settings(struct mt_device *td)
1107 {
1108         __s32 quirks = td->mtclass.quirks;
1109
1110         /* unknown serial device needs special quirks */
1111         if (td->touches_by_report == 1) {
1112                 quirks |= MT_QUIRK_ALWAYS_VALID;
1113                 quirks &= ~MT_QUIRK_NOT_SEEN_MEANS_UP;
1114                 quirks &= ~MT_QUIRK_VALID_IS_INRANGE;
1115                 quirks &= ~MT_QUIRK_VALID_IS_CONFIDENCE;
1116                 quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
1117         }
1118
1119         td->mtclass.quirks = quirks;
1120 }
1121
1122 static void mt_post_parse(struct mt_device *td)
1123 {
1124         struct mt_fields *f = td->fields;
1125         struct mt_class *cls = &td->mtclass;
1126
1127         if (td->touches_by_report > 0) {
1128                 int field_count_per_touch = f->length / td->touches_by_report;
1129                 td->last_slot_field = f->usages[field_count_per_touch - 1];
1130         }
1131
1132         if (td->cc_index < 0)
1133                 cls->quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
1134 }
1135
1136 static int mt_input_configured(struct hid_device *hdev, struct hid_input *hi)
1137 {
1138         struct mt_device *td = hid_get_drvdata(hdev);
1139         const char *suffix = NULL;
1140         struct hid_field *field = hi->report->field[0];
1141         int ret;
1142
1143         if (hi->report->id == td->mt_report_id) {
1144                 ret = mt_touch_input_configured(hdev, hi);
1145                 if (ret)
1146                         return ret;
1147         }
1148
1149         /*
1150          * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
1151          * for the stylus. Check this first, and then rely on the application
1152          * field.
1153          */
1154         if (hi->report->field[0]->physical == HID_DG_STYLUS) {
1155                 suffix = "Pen";
1156                 /* force BTN_STYLUS to allow tablet matching in udev */
1157                 __set_bit(BTN_STYLUS, hi->input->keybit);
1158         } else {
1159                 switch (field->application) {
1160                 case HID_GD_KEYBOARD:
1161                         suffix = "Keyboard";
1162                         break;
1163                 case HID_GD_KEYPAD:
1164                         suffix = "Keypad";
1165                         break;
1166                 case HID_GD_MOUSE:
1167                         suffix = "Mouse";
1168                         break;
1169                 case HID_DG_STYLUS:
1170                         suffix = "Pen";
1171                         /* force BTN_STYLUS to allow tablet matching in udev */
1172                         __set_bit(BTN_STYLUS, hi->input->keybit);
1173                         break;
1174                 case HID_DG_TOUCHSCREEN:
1175                         /* we do not set suffix = "Touchscreen" */
1176                         break;
1177                 case HID_DG_TOUCHPAD:
1178                         suffix = "Touchpad";
1179                         break;
1180                 case HID_GD_SYSTEM_CONTROL:
1181                         suffix = "System Control";
1182                         break;
1183                 case HID_CP_CONSUMER_CONTROL:
1184                         suffix = "Consumer Control";
1185                         break;
1186                 case HID_GD_WIRELESS_RADIO_CTLS:
1187                         suffix = "Wireless Radio Control";
1188                         break;
1189                 case HID_VD_ASUS_CUSTOM_MEDIA_KEYS:
1190                         suffix = "Custom Media Keys";
1191                         break;
1192                 default:
1193                         suffix = "UNKNOWN";
1194                         break;
1195                 }
1196         }
1197
1198         if (suffix)
1199                 hi->input->name = devm_kasprintf(&hdev->dev, GFP_KERNEL,
1200                                                  "%s %s", hdev->name, suffix);
1201
1202         return 0;
1203 }
1204
1205 static void mt_fix_const_field(struct hid_field *field, unsigned int usage)
1206 {
1207         if (field->usage[0].hid != usage ||
1208             !(field->flags & HID_MAIN_ITEM_CONSTANT))
1209                 return;
1210
1211         field->flags &= ~HID_MAIN_ITEM_CONSTANT;
1212         field->flags |= HID_MAIN_ITEM_VARIABLE;
1213 }
1214
1215 static void mt_fix_const_fields(struct hid_device *hdev, unsigned int usage)
1216 {
1217         struct hid_report *report;
1218         int i;
1219
1220         list_for_each_entry(report,
1221                             &hdev->report_enum[HID_INPUT_REPORT].report_list,
1222                             list) {
1223
1224                 if (!report->maxfield)
1225                         continue;
1226
1227                 for (i = 0; i < report->maxfield; i++)
1228                         if (report->field[i]->maxusage >= 1)
1229                                 mt_fix_const_field(report->field[i], usage);
1230         }
1231 }
1232
1233 static void mt_release_contacts(struct hid_device *hid)
1234 {
1235         struct hid_input *hidinput;
1236         struct mt_device *td = hid_get_drvdata(hid);
1237
1238         list_for_each_entry(hidinput, &hid->inputs, list) {
1239                 struct input_dev *input_dev = hidinput->input;
1240                 struct input_mt *mt = input_dev->mt;
1241                 int i;
1242
1243                 if (mt) {
1244                         for (i = 0; i < mt->num_slots; i++) {
1245                                 input_mt_slot(input_dev, i);
1246                                 input_mt_report_slot_state(input_dev,
1247                                                            MT_TOOL_FINGER,
1248                                                            false);
1249                         }
1250                         input_mt_sync_frame(input_dev);
1251                         input_sync(input_dev);
1252                 }
1253         }
1254
1255         td->num_received = 0;
1256 }
1257
1258 static void mt_expired_timeout(unsigned long arg)
1259 {
1260         struct hid_device *hdev = (void *)arg;
1261         struct mt_device *td = hid_get_drvdata(hdev);
1262
1263         /*
1264          * An input report came in just before we release the sticky fingers,
1265          * it will take care of the sticky fingers.
1266          */
1267         if (test_and_set_bit_lock(MT_IO_FLAGS_RUNNING, &td->mt_io_flags))
1268                 return;
1269         if (test_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags))
1270                 mt_release_contacts(hdev);
1271         clear_bit_unlock(MT_IO_FLAGS_RUNNING, &td->mt_io_flags);
1272 }
1273
1274 static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
1275 {
1276         int ret, i;
1277         struct mt_device *td;
1278         struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */
1279
1280         for (i = 0; mt_classes[i].name ; i++) {
1281                 if (id->driver_data == mt_classes[i].name) {
1282                         mtclass = &(mt_classes[i]);
1283                         break;
1284                 }
1285         }
1286
1287         td = devm_kzalloc(&hdev->dev, sizeof(struct mt_device), GFP_KERNEL);
1288         if (!td) {
1289                 dev_err(&hdev->dev, "cannot allocate multitouch data\n");
1290                 return -ENOMEM;
1291         }
1292         td->mtclass = *mtclass;
1293         td->inputmode = -1;
1294         td->maxcontact_report_id = -1;
1295         td->inputmode_value = MT_INPUTMODE_TOUCHSCREEN;
1296         td->cc_index = -1;
1297         td->mt_report_id = -1;
1298         hid_set_drvdata(hdev, td);
1299
1300         td->fields = devm_kzalloc(&hdev->dev, sizeof(struct mt_fields),
1301                                   GFP_KERNEL);
1302         if (!td->fields) {
1303                 dev_err(&hdev->dev, "cannot allocate multitouch fields data\n");
1304                 return -ENOMEM;
1305         }
1306
1307         if (id->vendor == HID_ANY_ID && id->product == HID_ANY_ID)
1308                 td->serial_maybe = true;
1309
1310         /*
1311          * Store the initial quirk state
1312          */
1313         td->initial_quirks = hdev->quirks;
1314
1315         /* This allows the driver to correctly support devices
1316          * that emit events over several HID messages.
1317          */
1318         hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
1319
1320         /*
1321          * This allows the driver to handle different input sensors
1322          * that emits events through different reports on the same HID
1323          * device.
1324          */
1325         hdev->quirks |= HID_QUIRK_MULTI_INPUT;
1326         hdev->quirks |= HID_QUIRK_NO_EMPTY_INPUT;
1327
1328         /*
1329          * Some multitouch screens do not like to be polled for input
1330          * reports. Fortunately, the Win8 spec says that all touches
1331          * should be sent during each report, making the initialization
1332          * of input reports unnecessary. For Win7 devices, well, let's hope
1333          * they will still be happy (this is only be a problem if a touch
1334          * was already there while probing the device).
1335          *
1336          * In addition some touchpads do not behave well if we read
1337          * all feature reports from them. Instead we prevent
1338          * initial report fetching and then selectively fetch each
1339          * report we are interested in.
1340          */
1341         hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
1342
1343         setup_timer(&td->release_timer, mt_expired_timeout, (long)hdev);
1344
1345         ret = hid_parse(hdev);
1346         if (ret != 0)
1347                 return ret;
1348
1349         if (mtclass->quirks & MT_QUIRK_FIX_CONST_CONTACT_ID)
1350                 mt_fix_const_fields(hdev, HID_DG_CONTACTID);
1351
1352         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
1353         if (ret)
1354                 return ret;
1355
1356         ret = sysfs_create_group(&hdev->dev.kobj, &mt_attribute_group);
1357         if (ret)
1358                 dev_warn(&hdev->dev, "Cannot allocate sysfs group for %s\n",
1359                                 hdev->name);
1360
1361         mt_set_maxcontacts(hdev);
1362         mt_set_input_mode(hdev);
1363
1364         /* release .fields memory as it is not used anymore */
1365         devm_kfree(&hdev->dev, td->fields);
1366         td->fields = NULL;
1367
1368         return 0;
1369 }
1370
1371 #ifdef CONFIG_PM
1372 static int mt_reset_resume(struct hid_device *hdev)
1373 {
1374         mt_release_contacts(hdev);
1375         mt_set_maxcontacts(hdev);
1376         mt_set_input_mode(hdev);
1377         return 0;
1378 }
1379
1380 static int mt_resume(struct hid_device *hdev)
1381 {
1382         /* Some Elan legacy devices require SET_IDLE to be set on resume.
1383          * It should be safe to send it to other devices too.
1384          * Tested on 3M, Stantum, Cypress, Zytronic, eGalax, and Elan panels. */
1385
1386         hid_hw_idle(hdev, 0, 0, HID_REQ_SET_IDLE);
1387
1388         return 0;
1389 }
1390 #endif
1391
1392 static void mt_remove(struct hid_device *hdev)
1393 {
1394         struct mt_device *td = hid_get_drvdata(hdev);
1395
1396         del_timer_sync(&td->release_timer);
1397
1398         sysfs_remove_group(&hdev->dev.kobj, &mt_attribute_group);
1399         hid_hw_stop(hdev);
1400         hdev->quirks = td->initial_quirks;
1401 }
1402
1403 /*
1404  * This list contains only:
1405  * - VID/PID of products not working with the default multitouch handling
1406  * - 2 generic rules.
1407  * So there is no point in adding here any device with MT_CLS_DEFAULT.
1408  */
1409 static const struct hid_device_id mt_devices[] = {
1410
1411         /* 3M panels */
1412         { .driver_data = MT_CLS_3M,
1413                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1414                         USB_DEVICE_ID_3M1968) },
1415         { .driver_data = MT_CLS_3M,
1416                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1417                         USB_DEVICE_ID_3M2256) },
1418         { .driver_data = MT_CLS_3M,
1419                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1420                         USB_DEVICE_ID_3M3266) },
1421
1422         /* Alps devices */
1423         { .driver_data = MT_CLS_WIN_8_DUAL,
1424                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1425                         USB_VENDOR_ID_ALPS_JP,
1426                         HID_DEVICE_ID_ALPS_U1_DUAL_PTP) },
1427         { .driver_data = MT_CLS_WIN_8_DUAL,
1428                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1429                         USB_VENDOR_ID_ALPS_JP,
1430                         HID_DEVICE_ID_ALPS_U1_DUAL_3BTN_PTP) },
1431
1432         /* Lenovo X1 TAB Gen 2 */
1433         { .driver_data = MT_CLS_WIN_8_DUAL,
1434                 HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1435                            USB_VENDOR_ID_LENOVO,
1436                            USB_DEVICE_ID_LENOVO_X1_TAB) },
1437
1438         /* Anton devices */
1439         { .driver_data = MT_CLS_EXPORT_ALL_INPUTS,
1440                 MT_USB_DEVICE(USB_VENDOR_ID_ANTON,
1441                         USB_DEVICE_ID_ANTON_TOUCH_PAD) },
1442
1443         /* Asus T304UA */
1444         { .driver_data = MT_CLS_ASUS,
1445                 HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1446                         USB_VENDOR_ID_ASUSTEK,
1447                         USB_DEVICE_ID_ASUSTEK_T304_KEYBOARD) },
1448
1449         /* Atmel panels */
1450         { .driver_data = MT_CLS_SERIAL,
1451                 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL,
1452                         USB_DEVICE_ID_ATMEL_MXT_DIGITIZER) },
1453
1454         /* Baanto multitouch devices */
1455         { .driver_data = MT_CLS_NSMU,
1456                 MT_USB_DEVICE(USB_VENDOR_ID_BAANTO,
1457                         USB_DEVICE_ID_BAANTO_MT_190W2) },
1458
1459         /* Cando panels */
1460         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1461                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1462                         USB_DEVICE_ID_CANDO_MULTI_TOUCH) },
1463         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1464                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1465                         USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6) },
1466
1467         /* Chunghwa Telecom touch panels */
1468         {  .driver_data = MT_CLS_NSMU,
1469                 MT_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT,
1470                         USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH) },
1471
1472         /* Cirque devices */
1473         { .driver_data = MT_CLS_WIN_8_DUAL,
1474                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1475                         I2C_VENDOR_ID_CIRQUE,
1476                         I2C_PRODUCT_ID_CIRQUE_121F) },
1477
1478         /* CJTouch panels */
1479         { .driver_data = MT_CLS_NSMU,
1480                 MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1481                         USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0020) },
1482         { .driver_data = MT_CLS_NSMU,
1483                 MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1484                         USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0040) },
1485
1486         /* CVTouch panels */
1487         { .driver_data = MT_CLS_NSMU,
1488                 MT_USB_DEVICE(USB_VENDOR_ID_CVTOUCH,
1489                         USB_DEVICE_ID_CVTOUCH_SCREEN) },
1490
1491         /* eGalax devices (resistive) */
1492         { .driver_data = MT_CLS_EGALAX,
1493                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1494                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D) },
1495         { .driver_data = MT_CLS_EGALAX,
1496                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1497                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E) },
1498
1499         /* eGalax devices (capacitive) */
1500         { .driver_data = MT_CLS_EGALAX_SERIAL,
1501                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1502                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7207) },
1503         { .driver_data = MT_CLS_EGALAX,
1504                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1505                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C) },
1506         { .driver_data = MT_CLS_EGALAX_SERIAL,
1507                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1508                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224) },
1509         { .driver_data = MT_CLS_EGALAX_SERIAL,
1510                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1511                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_722A) },
1512         { .driver_data = MT_CLS_EGALAX_SERIAL,
1513                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1514                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_725E) },
1515         { .driver_data = MT_CLS_EGALAX_SERIAL,
1516                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1517                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7262) },
1518         { .driver_data = MT_CLS_EGALAX,
1519                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1520                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B) },
1521         { .driver_data = MT_CLS_EGALAX,
1522                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1523                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1) },
1524         { .driver_data = MT_CLS_EGALAX_SERIAL,
1525                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1526                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72AA) },
1527         { .driver_data = MT_CLS_EGALAX,
1528                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1529                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72C4) },
1530         { .driver_data = MT_CLS_EGALAX,
1531                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1532                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72D0) },
1533         { .driver_data = MT_CLS_EGALAX,
1534                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1535                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA) },
1536         { .driver_data = MT_CLS_EGALAX,
1537                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1538                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302) },
1539         { .driver_data = MT_CLS_EGALAX_SERIAL,
1540                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1541                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7349) },
1542         { .driver_data = MT_CLS_EGALAX_SERIAL,
1543                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1544                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_73F7) },
1545         { .driver_data = MT_CLS_EGALAX_SERIAL,
1546                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1547                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001) },
1548         { .driver_data = MT_CLS_EGALAX,
1549                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1550                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_C002) },
1551
1552         /* Elitegroup panel */
1553         { .driver_data = MT_CLS_SERIAL,
1554                 MT_USB_DEVICE(USB_VENDOR_ID_ELITEGROUP,
1555                         USB_DEVICE_ID_ELITEGROUP_05D8) },
1556
1557         /* Flatfrog Panels */
1558         { .driver_data = MT_CLS_FLATFROG,
1559                 MT_USB_DEVICE(USB_VENDOR_ID_FLATFROG,
1560                         USB_DEVICE_ID_MULTITOUCH_3200) },
1561
1562         /* FocalTech Panels */
1563         { .driver_data = MT_CLS_SERIAL,
1564                 MT_USB_DEVICE(USB_VENDOR_ID_CYGNAL,
1565                         USB_DEVICE_ID_FOCALTECH_FTXXXX_MULTITOUCH) },
1566
1567         /* GeneralTouch panel */
1568         { .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1569                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1570                         USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
1571         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1572                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1573                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PWT_TENFINGERS) },
1574         { .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1575                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1576                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0101) },
1577         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1578                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1579                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0102) },
1580         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1581                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1582                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0106) },
1583         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1584                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1585                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_010A) },
1586         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1587                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1588                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_E100) },
1589
1590         /* Gametel game controller */
1591         { .driver_data = MT_CLS_NSMU,
1592                 MT_BT_DEVICE(USB_VENDOR_ID_FRUCTEL,
1593                         USB_DEVICE_ID_GAMETEL_MT_MODE) },
1594
1595         /* GoodTouch panels */
1596         { .driver_data = MT_CLS_NSMU,
1597                 MT_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH,
1598                         USB_DEVICE_ID_GOODTOUCH_000f) },
1599
1600         /* Hanvon panels */
1601         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1602                 MT_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT,
1603                         USB_DEVICE_ID_HANVON_ALT_MULTITOUCH) },
1604
1605         /* Ilitek dual touch panel */
1606         {  .driver_data = MT_CLS_NSMU,
1607                 MT_USB_DEVICE(USB_VENDOR_ID_ILITEK,
1608                         USB_DEVICE_ID_ILITEK_MULTITOUCH) },
1609
1610         /* LG Melfas panel */
1611         { .driver_data = MT_CLS_LG,
1612                 HID_USB_DEVICE(USB_VENDOR_ID_LG,
1613                         USB_DEVICE_ID_LG_MELFAS_MT) },
1614
1615         /* MosArt panels */
1616         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1617                 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
1618                         USB_DEVICE_ID_ASUS_T91MT)},
1619         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1620                 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
1621                         USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO) },
1622         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1623                 MT_USB_DEVICE(USB_VENDOR_ID_TURBOX,
1624                         USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART) },
1625
1626         /* Panasonic panels */
1627         { .driver_data = MT_CLS_PANASONIC,
1628                 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
1629                         USB_DEVICE_ID_PANABOARD_UBT780) },
1630         { .driver_data = MT_CLS_PANASONIC,
1631                 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
1632                         USB_DEVICE_ID_PANABOARD_UBT880) },
1633
1634         /* Novatek Panel */
1635         { .driver_data = MT_CLS_NSMU,
1636                 MT_USB_DEVICE(USB_VENDOR_ID_NOVATEK,
1637                         USB_DEVICE_ID_NOVATEK_PCT) },
1638
1639         /* Ntrig Panel */
1640         { .driver_data = MT_CLS_NSMU,
1641                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1642                         USB_VENDOR_ID_NTRIG, 0x1b05) },
1643
1644         /* PixArt optical touch screen */
1645         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1646                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1647                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN) },
1648         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1649                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1650                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1) },
1651         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1652                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1653                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2) },
1654
1655         /* PixCir-based panels */
1656         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1657                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1658                         USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
1659
1660         /* Quanta-based panels */
1661         { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
1662                 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
1663                         USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001) },
1664
1665         /* Stantum panels */
1666         { .driver_data = MT_CLS_CONFIDENCE,
1667                 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM,
1668                         USB_DEVICE_ID_MTP_STM)},
1669
1670         /* TopSeed panels */
1671         { .driver_data = MT_CLS_TOPSEED,
1672                 MT_USB_DEVICE(USB_VENDOR_ID_TOPSEED2,
1673                         USB_DEVICE_ID_TOPSEED2_PERIPAD_701) },
1674
1675         /* Touch International panels */
1676         { .driver_data = MT_CLS_NSMU,
1677                 MT_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL,
1678                         USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH) },
1679
1680         /* Unitec panels */
1681         { .driver_data = MT_CLS_NSMU,
1682                 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
1683                         USB_DEVICE_ID_UNITEC_USB_TOUCH_0709) },
1684         { .driver_data = MT_CLS_NSMU,
1685                 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
1686                         USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19) },
1687
1688         /* VTL panels */
1689         { .driver_data = MT_CLS_VTL,
1690                 MT_USB_DEVICE(USB_VENDOR_ID_VTL,
1691                         USB_DEVICE_ID_VTL_MULTITOUCH_FF3F) },
1692
1693         /* Wistron panels */
1694         { .driver_data = MT_CLS_NSMU,
1695                 MT_USB_DEVICE(USB_VENDOR_ID_WISTRON,
1696                         USB_DEVICE_ID_WISTRON_OPTICAL_TOUCH) },
1697
1698         /* XAT */
1699         { .driver_data = MT_CLS_NSMU,
1700                 MT_USB_DEVICE(USB_VENDOR_ID_XAT,
1701                         USB_DEVICE_ID_XAT_CSR) },
1702
1703         /* Xiroku */
1704         { .driver_data = MT_CLS_NSMU,
1705                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1706                         USB_DEVICE_ID_XIROKU_SPX) },
1707         { .driver_data = MT_CLS_NSMU,
1708                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1709                         USB_DEVICE_ID_XIROKU_MPX) },
1710         { .driver_data = MT_CLS_NSMU,
1711                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1712                         USB_DEVICE_ID_XIROKU_CSR) },
1713         { .driver_data = MT_CLS_NSMU,
1714                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1715                         USB_DEVICE_ID_XIROKU_SPX1) },
1716         { .driver_data = MT_CLS_NSMU,
1717                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1718                         USB_DEVICE_ID_XIROKU_MPX1) },
1719         { .driver_data = MT_CLS_NSMU,
1720                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1721                         USB_DEVICE_ID_XIROKU_CSR1) },
1722         { .driver_data = MT_CLS_NSMU,
1723                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1724                         USB_DEVICE_ID_XIROKU_SPX2) },
1725         { .driver_data = MT_CLS_NSMU,
1726                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1727                         USB_DEVICE_ID_XIROKU_MPX2) },
1728         { .driver_data = MT_CLS_NSMU,
1729                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1730                         USB_DEVICE_ID_XIROKU_CSR2) },
1731
1732         /* Google MT devices */
1733         { .driver_data = MT_CLS_GOOGLE,
1734                 HID_DEVICE(HID_BUS_ANY, HID_GROUP_ANY, USB_VENDOR_ID_GOOGLE,
1735                         USB_DEVICE_ID_GOOGLE_TOUCH_ROSE) },
1736
1737         /* Generic MT device */
1738         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH, HID_ANY_ID, HID_ANY_ID) },
1739
1740         /* Generic Win 8 certified MT device */
1741         {  .driver_data = MT_CLS_WIN_8,
1742                 HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH_WIN_8,
1743                         HID_ANY_ID, HID_ANY_ID) },
1744         { }
1745 };
1746 MODULE_DEVICE_TABLE(hid, mt_devices);
1747
1748 static const struct hid_usage_id mt_grabbed_usages[] = {
1749         { HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
1750         { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
1751 };
1752
1753 static struct hid_driver mt_driver = {
1754         .name = "hid-multitouch",
1755         .id_table = mt_devices,
1756         .probe = mt_probe,
1757         .remove = mt_remove,
1758         .input_mapping = mt_input_mapping,
1759         .input_mapped = mt_input_mapped,
1760         .input_configured = mt_input_configured,
1761         .feature_mapping = mt_feature_mapping,
1762         .usage_table = mt_grabbed_usages,
1763         .event = mt_event,
1764         .report = mt_report,
1765 #ifdef CONFIG_PM
1766         .reset_resume = mt_reset_resume,
1767         .resume = mt_resume,
1768 #endif
1769 };
1770 module_hid_driver(mt_driver);