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