GNU Linux-libre 5.4.241-gnu1
[releases.git] / drivers / hid / hid-multitouch.c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *  HID driver for multitouch panels
4  *
5  *  Copyright (c) 2010-2012 Stephane Chatty <chatty@enac.fr>
6  *  Copyright (c) 2010-2013 Benjamin Tissoires <benjamin.tissoires@gmail.com>
7  *  Copyright (c) 2010-2012 Ecole Nationale de l'Aviation Civile, France
8  *  Copyright (c) 2012-2013 Red Hat, Inc
9  *
10  *  This code is partly based on hid-egalax.c:
11  *
12  *  Copyright (c) 2010 Stephane Chatty <chatty@enac.fr>
13  *  Copyright (c) 2010 Henrik Rydberg <rydberg@euromail.se>
14  *  Copyright (c) 2010 Canonical, Ltd.
15  *
16  *  This code is partly based on hid-3m-pct.c:
17  *
18  *  Copyright (c) 2009-2010 Stephane Chatty <chatty@enac.fr>
19  *  Copyright (c) 2010      Henrik Rydberg <rydberg@euromail.se>
20  *  Copyright (c) 2010      Canonical, Ltd.
21  */
22
23 /*
24  */
25
26 /*
27  * This driver is regularly tested thanks to the test suite in hid-tools[1].
28  * Please run these regression tests before patching this module so that
29  * your patch won't break existing known devices.
30  *
31  * [1] https://gitlab.freedesktop.org/libevdev/hid-tools
32  */
33
34 #include <linux/device.h>
35 #include <linux/hid.h>
36 #include <linux/module.h>
37 #include <linux/slab.h>
38 #include <linux/input/mt.h>
39 #include <linux/jiffies.h>
40 #include <linux/string.h>
41 #include <linux/timer.h>
42
43
44 MODULE_AUTHOR("Stephane Chatty <chatty@enac.fr>");
45 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
46 MODULE_DESCRIPTION("HID multitouch panels");
47 MODULE_LICENSE("GPL");
48
49 #include "hid-ids.h"
50
51 /* quirks to control the device */
52 #define MT_QUIRK_NOT_SEEN_MEANS_UP      BIT(0)
53 #define MT_QUIRK_SLOT_IS_CONTACTID      BIT(1)
54 #define MT_QUIRK_CYPRESS                BIT(2)
55 #define MT_QUIRK_SLOT_IS_CONTACTNUMBER  BIT(3)
56 #define MT_QUIRK_ALWAYS_VALID           BIT(4)
57 #define MT_QUIRK_VALID_IS_INRANGE       BIT(5)
58 #define MT_QUIRK_VALID_IS_CONFIDENCE    BIT(6)
59 #define MT_QUIRK_CONFIDENCE             BIT(7)
60 #define MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE    BIT(8)
61 #define MT_QUIRK_NO_AREA                BIT(9)
62 #define MT_QUIRK_IGNORE_DUPLICATES      BIT(10)
63 #define MT_QUIRK_HOVERING               BIT(11)
64 #define MT_QUIRK_CONTACT_CNT_ACCURATE   BIT(12)
65 #define MT_QUIRK_FORCE_GET_FEATURE      BIT(13)
66 #define MT_QUIRK_FIX_CONST_CONTACT_ID   BIT(14)
67 #define MT_QUIRK_TOUCH_SIZE_SCALING     BIT(15)
68 #define MT_QUIRK_STICKY_FINGERS         BIT(16)
69 #define MT_QUIRK_ASUS_CUSTOM_UP         BIT(17)
70 #define MT_QUIRK_WIN8_PTP_BUTTONS       BIT(18)
71 #define MT_QUIRK_SEPARATE_APP_REPORT    BIT(19)
72 #define MT_QUIRK_FORCE_MULTI_INPUT      BIT(20)
73
74 #define MT_INPUTMODE_TOUCHSCREEN        0x02
75 #define MT_INPUTMODE_TOUCHPAD           0x03
76
77 #define MT_BUTTONTYPE_CLICKPAD          0
78
79 enum latency_mode {
80         HID_LATENCY_NORMAL = 0,
81         HID_LATENCY_HIGH = 1,
82 };
83
84 #define MT_IO_FLAGS_RUNNING             0
85 #define MT_IO_FLAGS_ACTIVE_SLOTS        1
86 #define MT_IO_FLAGS_PENDING_SLOTS       2
87
88 static const bool mtrue = true;         /* default for true */
89 static const bool mfalse;               /* default for false */
90 static const __s32 mzero;               /* default for 0 */
91
92 #define DEFAULT_TRUE    ((void *)&mtrue)
93 #define DEFAULT_FALSE   ((void *)&mfalse)
94 #define DEFAULT_ZERO    ((void *)&mzero)
95
96 struct mt_usages {
97         struct list_head list;
98         __s32 *x, *y, *cx, *cy, *p, *w, *h, *a;
99         __s32 *contactid;       /* the device ContactID assigned to this slot */
100         bool *tip_state;        /* is the touch valid? */
101         bool *inrange_state;    /* is the finger in proximity of the sensor? */
102         bool *confidence_state; /* is the touch made by a finger? */
103 };
104
105 struct mt_application {
106         struct list_head list;
107         unsigned int application;
108         unsigned int report_id;
109         struct list_head mt_usages;     /* mt usages list */
110
111         __s32 quirks;
112
113         __s32 *scantime;                /* scantime reported */
114         __s32 scantime_logical_max;     /* max value for raw scantime */
115
116         __s32 *raw_cc;                  /* contact count in the report */
117         int left_button_state;          /* left button state */
118         unsigned int mt_flags;          /* flags to pass to input-mt */
119
120         unsigned long *pending_palm_slots;      /* slots where we reported palm
121                                                  * and need to release */
122
123         __u8 num_received;      /* how many contacts we received */
124         __u8 num_expected;      /* expected last contact index */
125         __u8 buttons_count;     /* number of physical buttons per touchpad */
126         __u8 touches_by_report; /* how many touches are present in one report:
127                                  * 1 means we should use a serial protocol
128                                  * > 1 means hybrid (multitouch) protocol
129                                  */
130
131         __s32 dev_time;         /* the scan time provided by the device */
132         unsigned long jiffies;  /* the frame's jiffies */
133         int timestamp;          /* the timestamp to be sent */
134         int prev_scantime;              /* scantime reported previously */
135
136         bool have_contact_count;
137 };
138
139 struct mt_class {
140         __s32 name;     /* MT_CLS */
141         __s32 quirks;
142         __s32 sn_move;  /* Signal/noise ratio for move events */
143         __s32 sn_width; /* Signal/noise ratio for width events */
144         __s32 sn_height;        /* Signal/noise ratio for height events */
145         __s32 sn_pressure;      /* Signal/noise ratio for pressure events */
146         __u8 maxcontacts;
147         bool is_indirect;       /* true for touchpads */
148         bool export_all_inputs; /* do not ignore mouse, keyboards, etc... */
149 };
150
151 struct mt_report_data {
152         struct list_head list;
153         struct hid_report *report;
154         struct mt_application *application;
155         bool is_mt_collection;
156 };
157
158 struct mt_device {
159         struct mt_class mtclass;        /* our mt device class */
160         struct timer_list release_timer;        /* to release sticky fingers */
161         struct hid_device *hdev;        /* hid_device we're attached to */
162         unsigned long mt_io_flags;      /* mt flags (MT_IO_FLAGS_*) */
163         __u8 inputmode_value;   /* InputMode HID feature value */
164         __u8 maxcontacts;
165         bool is_buttonpad;      /* is this device a button pad? */
166         bool serial_maybe;      /* need to check for serial protocol */
167
168         struct list_head applications;
169         struct list_head reports;
170 };
171
172 static void mt_post_parse_default_settings(struct mt_device *td,
173                                            struct mt_application *app);
174 static void mt_post_parse(struct mt_device *td, struct mt_application *app);
175
176 /* classes of device behavior */
177 #define MT_CLS_DEFAULT                          0x0001
178
179 #define MT_CLS_SERIAL                           0x0002
180 #define MT_CLS_CONFIDENCE                       0x0003
181 #define MT_CLS_CONFIDENCE_CONTACT_ID            0x0004
182 #define MT_CLS_CONFIDENCE_MINUS_ONE             0x0005
183 #define MT_CLS_DUAL_INRANGE_CONTACTID           0x0006
184 #define MT_CLS_DUAL_INRANGE_CONTACTNUMBER       0x0007
185 /* reserved                                     0x0008 */
186 #define MT_CLS_INRANGE_CONTACTNUMBER            0x0009
187 #define MT_CLS_NSMU                             0x000a
188 /* reserved                                     0x0010 */
189 /* reserved                                     0x0011 */
190 #define MT_CLS_WIN_8                            0x0012
191 #define MT_CLS_EXPORT_ALL_INPUTS                0x0013
192 #define MT_CLS_WIN_8_DUAL                       0x0014
193 #define MT_CLS_WIN_8_FORCE_MULTI_INPUT          0x0015
194
195 /* vendor specific classes */
196 #define MT_CLS_3M                               0x0101
197 /* reserved                                     0x0102 */
198 #define MT_CLS_EGALAX                           0x0103
199 #define MT_CLS_EGALAX_SERIAL                    0x0104
200 #define MT_CLS_TOPSEED                          0x0105
201 #define MT_CLS_PANASONIC                        0x0106
202 #define MT_CLS_FLATFROG                         0x0107
203 #define MT_CLS_GENERALTOUCH_TWOFINGERS          0x0108
204 #define MT_CLS_GENERALTOUCH_PWT_TENFINGERS      0x0109
205 #define MT_CLS_LG                               0x010a
206 #define MT_CLS_ASUS                             0x010b
207 #define MT_CLS_VTL                              0x0110
208 #define MT_CLS_GOOGLE                           0x0111
209 #define MT_CLS_RAZER_BLADE_STEALTH              0x0112
210 #define MT_CLS_SMART_TECH                       0x0113
211
212 #define MT_DEFAULT_MAXCONTACT   10
213 #define MT_MAX_MAXCONTACT       250
214
215 /*
216  * Resync device and local timestamps after that many microseconds without
217  * receiving data.
218  */
219 #define MAX_TIMESTAMP_INTERVAL  1000000
220
221 #define MT_USB_DEVICE(v, p)     HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH, v, p)
222 #define MT_BT_DEVICE(v, p)      HID_DEVICE(BUS_BLUETOOTH, HID_GROUP_MULTITOUCH, v, p)
223
224 /*
225  * these device-dependent functions determine what slot corresponds
226  * to a valid contact that was just read.
227  */
228
229 static int cypress_compute_slot(struct mt_application *application,
230                                 struct mt_usages *slot)
231 {
232         if (*slot->contactid != 0 || application->num_received == 0)
233                 return *slot->contactid;
234         else
235                 return -1;
236 }
237
238 static const struct mt_class mt_classes[] = {
239         { .name = MT_CLS_DEFAULT,
240                 .quirks = MT_QUIRK_ALWAYS_VALID |
241                         MT_QUIRK_CONTACT_CNT_ACCURATE },
242         { .name = MT_CLS_NSMU,
243                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP },
244         { .name = MT_CLS_SERIAL,
245                 .quirks = MT_QUIRK_ALWAYS_VALID},
246         { .name = MT_CLS_CONFIDENCE,
247                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE },
248         { .name = MT_CLS_CONFIDENCE_CONTACT_ID,
249                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
250                         MT_QUIRK_SLOT_IS_CONTACTID },
251         { .name = MT_CLS_CONFIDENCE_MINUS_ONE,
252                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
253                         MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE },
254         { .name = MT_CLS_DUAL_INRANGE_CONTACTID,
255                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
256                         MT_QUIRK_SLOT_IS_CONTACTID,
257                 .maxcontacts = 2 },
258         { .name = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
259                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
260                         MT_QUIRK_SLOT_IS_CONTACTNUMBER,
261                 .maxcontacts = 2 },
262         { .name = MT_CLS_INRANGE_CONTACTNUMBER,
263                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
264                         MT_QUIRK_SLOT_IS_CONTACTNUMBER },
265         { .name = MT_CLS_WIN_8,
266                 .quirks = MT_QUIRK_ALWAYS_VALID |
267                         MT_QUIRK_IGNORE_DUPLICATES |
268                         MT_QUIRK_HOVERING |
269                         MT_QUIRK_CONTACT_CNT_ACCURATE |
270                         MT_QUIRK_STICKY_FINGERS |
271                         MT_QUIRK_WIN8_PTP_BUTTONS,
272                 .export_all_inputs = true },
273         { .name = MT_CLS_EXPORT_ALL_INPUTS,
274                 .quirks = MT_QUIRK_ALWAYS_VALID |
275                         MT_QUIRK_CONTACT_CNT_ACCURATE,
276                 .export_all_inputs = true },
277         { .name = MT_CLS_WIN_8_DUAL,
278                 .quirks = MT_QUIRK_ALWAYS_VALID |
279                         MT_QUIRK_IGNORE_DUPLICATES |
280                         MT_QUIRK_HOVERING |
281                         MT_QUIRK_CONTACT_CNT_ACCURATE |
282                         MT_QUIRK_WIN8_PTP_BUTTONS,
283                 .export_all_inputs = true },
284         { .name = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
285                 .quirks = MT_QUIRK_ALWAYS_VALID |
286                         MT_QUIRK_IGNORE_DUPLICATES |
287                         MT_QUIRK_HOVERING |
288                         MT_QUIRK_CONTACT_CNT_ACCURATE |
289                         MT_QUIRK_STICKY_FINGERS |
290                         MT_QUIRK_WIN8_PTP_BUTTONS |
291                         MT_QUIRK_FORCE_MULTI_INPUT,
292                 .export_all_inputs = true },
293
294         /*
295          * vendor specific classes
296          */
297         { .name = MT_CLS_3M,
298                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
299                         MT_QUIRK_SLOT_IS_CONTACTID |
300                         MT_QUIRK_TOUCH_SIZE_SCALING,
301                 .sn_move = 2048,
302                 .sn_width = 128,
303                 .sn_height = 128,
304                 .maxcontacts = 60,
305         },
306         { .name = MT_CLS_EGALAX,
307                 .quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
308                         MT_QUIRK_VALID_IS_INRANGE,
309                 .sn_move = 4096,
310                 .sn_pressure = 32,
311         },
312         { .name = MT_CLS_EGALAX_SERIAL,
313                 .quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
314                         MT_QUIRK_ALWAYS_VALID,
315                 .sn_move = 4096,
316                 .sn_pressure = 32,
317         },
318         { .name = MT_CLS_TOPSEED,
319                 .quirks = MT_QUIRK_ALWAYS_VALID,
320                 .is_indirect = true,
321                 .maxcontacts = 2,
322         },
323         { .name = MT_CLS_PANASONIC,
324                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP,
325                 .maxcontacts = 4 },
326         { .name = MT_CLS_GENERALTOUCH_TWOFINGERS,
327                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
328                         MT_QUIRK_VALID_IS_INRANGE |
329                         MT_QUIRK_SLOT_IS_CONTACTID,
330                 .maxcontacts = 2
331         },
332         { .name = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
333                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
334                         MT_QUIRK_SLOT_IS_CONTACTID
335         },
336
337         { .name = MT_CLS_FLATFROG,
338                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
339                         MT_QUIRK_NO_AREA,
340                 .sn_move = 2048,
341                 .maxcontacts = 40,
342         },
343         { .name = MT_CLS_LG,
344                 .quirks = MT_QUIRK_ALWAYS_VALID |
345                         MT_QUIRK_FIX_CONST_CONTACT_ID |
346                         MT_QUIRK_IGNORE_DUPLICATES |
347                         MT_QUIRK_HOVERING |
348                         MT_QUIRK_CONTACT_CNT_ACCURATE },
349         { .name = MT_CLS_ASUS,
350                 .quirks = MT_QUIRK_ALWAYS_VALID |
351                         MT_QUIRK_CONTACT_CNT_ACCURATE |
352                         MT_QUIRK_ASUS_CUSTOM_UP },
353         { .name = MT_CLS_VTL,
354                 .quirks = MT_QUIRK_ALWAYS_VALID |
355                         MT_QUIRK_CONTACT_CNT_ACCURATE |
356                         MT_QUIRK_FORCE_GET_FEATURE,
357         },
358         { .name = MT_CLS_GOOGLE,
359                 .quirks = MT_QUIRK_ALWAYS_VALID |
360                         MT_QUIRK_CONTACT_CNT_ACCURATE |
361                         MT_QUIRK_SLOT_IS_CONTACTID |
362                         MT_QUIRK_HOVERING
363         },
364         { .name = MT_CLS_RAZER_BLADE_STEALTH,
365                 .quirks = MT_QUIRK_ALWAYS_VALID |
366                         MT_QUIRK_IGNORE_DUPLICATES |
367                         MT_QUIRK_HOVERING |
368                         MT_QUIRK_CONTACT_CNT_ACCURATE |
369                         MT_QUIRK_WIN8_PTP_BUTTONS,
370         },
371         { .name = MT_CLS_SMART_TECH,
372                 .quirks = MT_QUIRK_ALWAYS_VALID |
373                         MT_QUIRK_IGNORE_DUPLICATES |
374                         MT_QUIRK_CONTACT_CNT_ACCURATE |
375                         MT_QUIRK_SEPARATE_APP_REPORT,
376         },
377         { }
378 };
379
380 static ssize_t mt_show_quirks(struct device *dev,
381                            struct device_attribute *attr,
382                            char *buf)
383 {
384         struct hid_device *hdev = to_hid_device(dev);
385         struct mt_device *td = hid_get_drvdata(hdev);
386
387         return sprintf(buf, "%u\n", td->mtclass.quirks);
388 }
389
390 static ssize_t mt_set_quirks(struct device *dev,
391                           struct device_attribute *attr,
392                           const char *buf, size_t count)
393 {
394         struct hid_device *hdev = to_hid_device(dev);
395         struct mt_device *td = hid_get_drvdata(hdev);
396         struct mt_application *application;
397
398         unsigned long val;
399
400         if (kstrtoul(buf, 0, &val))
401                 return -EINVAL;
402
403         td->mtclass.quirks = val;
404
405         list_for_each_entry(application, &td->applications, list) {
406                 application->quirks = val;
407                 if (!application->have_contact_count)
408                         application->quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
409         }
410
411         return count;
412 }
413
414 static DEVICE_ATTR(quirks, S_IWUSR | S_IRUGO, mt_show_quirks, mt_set_quirks);
415
416 static struct attribute *sysfs_attrs[] = {
417         &dev_attr_quirks.attr,
418         NULL
419 };
420
421 static const struct attribute_group mt_attribute_group = {
422         .attrs = sysfs_attrs
423 };
424
425 static void mt_get_feature(struct hid_device *hdev, struct hid_report *report)
426 {
427         int ret;
428         u32 size = hid_report_len(report);
429         u8 *buf;
430
431         /*
432          * Do not fetch the feature report if the device has been explicitly
433          * marked as non-capable.
434          */
435         if (hdev->quirks & HID_QUIRK_NO_INIT_REPORTS)
436                 return;
437
438         buf = hid_alloc_report_buf(report, GFP_KERNEL);
439         if (!buf)
440                 return;
441
442         ret = hid_hw_raw_request(hdev, report->id, buf, size,
443                                  HID_FEATURE_REPORT, HID_REQ_GET_REPORT);
444         if (ret < 0) {
445                 dev_warn(&hdev->dev, "failed to fetch feature %d\n",
446                          report->id);
447         } else {
448                 ret = hid_report_raw_event(hdev, HID_FEATURE_REPORT, buf,
449                                            size, 0);
450                 if (ret)
451                         dev_warn(&hdev->dev, "failed to report feature\n");
452         }
453
454         kfree(buf);
455 }
456
457 static void mt_feature_mapping(struct hid_device *hdev,
458                 struct hid_field *field, struct hid_usage *usage)
459 {
460         struct mt_device *td = hid_get_drvdata(hdev);
461
462         switch (usage->hid) {
463         case HID_DG_CONTACTMAX:
464                 mt_get_feature(hdev, field->report);
465
466                 td->maxcontacts = field->value[0];
467                 if (!td->maxcontacts &&
468                     field->logical_maximum <= MT_MAX_MAXCONTACT)
469                         td->maxcontacts = field->logical_maximum;
470                 if (td->mtclass.maxcontacts)
471                         /* check if the maxcontacts is given by the class */
472                         td->maxcontacts = td->mtclass.maxcontacts;
473
474                 break;
475         case HID_DG_BUTTONTYPE:
476                 if (usage->usage_index >= field->report_count) {
477                         dev_err(&hdev->dev, "HID_DG_BUTTONTYPE out of range\n");
478                         break;
479                 }
480
481                 mt_get_feature(hdev, field->report);
482                 if (field->value[usage->usage_index] == MT_BUTTONTYPE_CLICKPAD)
483                         td->is_buttonpad = true;
484
485                 break;
486         case 0xff0000c5:
487                 /* Retrieve the Win8 blob once to enable some devices */
488                 if (usage->usage_index == 0)
489                         mt_get_feature(hdev, field->report);
490                 break;
491         }
492 }
493
494 static void set_abs(struct input_dev *input, unsigned int code,
495                 struct hid_field *field, int snratio)
496 {
497         int fmin = field->logical_minimum;
498         int fmax = field->logical_maximum;
499         int fuzz = snratio ? (fmax - fmin) / snratio : 0;
500         input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
501         input_abs_set_res(input, code, hidinput_calc_abs_res(field, code));
502 }
503
504 static struct mt_usages *mt_allocate_usage(struct hid_device *hdev,
505                                            struct mt_application *application)
506 {
507         struct mt_usages *usage;
508
509         usage = devm_kzalloc(&hdev->dev, sizeof(*usage), GFP_KERNEL);
510         if (!usage)
511                 return NULL;
512
513         /* set some defaults so we do not need to check for null pointers */
514         usage->x = DEFAULT_ZERO;
515         usage->y = DEFAULT_ZERO;
516         usage->cx = DEFAULT_ZERO;
517         usage->cy = DEFAULT_ZERO;
518         usage->p = DEFAULT_ZERO;
519         usage->w = DEFAULT_ZERO;
520         usage->h = DEFAULT_ZERO;
521         usage->a = DEFAULT_ZERO;
522         usage->contactid = DEFAULT_ZERO;
523         usage->tip_state = DEFAULT_FALSE;
524         usage->inrange_state = DEFAULT_FALSE;
525         usage->confidence_state = DEFAULT_TRUE;
526
527         list_add_tail(&usage->list, &application->mt_usages);
528
529         return usage;
530 }
531
532 static struct mt_application *mt_allocate_application(struct mt_device *td,
533                                                       struct hid_report *report)
534 {
535         unsigned int application = report->application;
536         struct mt_application *mt_application;
537
538         mt_application = devm_kzalloc(&td->hdev->dev, sizeof(*mt_application),
539                                       GFP_KERNEL);
540         if (!mt_application)
541                 return NULL;
542
543         mt_application->application = application;
544         INIT_LIST_HEAD(&mt_application->mt_usages);
545
546         if (application == HID_DG_TOUCHSCREEN)
547                 mt_application->mt_flags |= INPUT_MT_DIRECT;
548
549         /*
550          * Model touchscreens providing buttons as touchpads.
551          */
552         if (application == HID_DG_TOUCHPAD) {
553                 mt_application->mt_flags |= INPUT_MT_POINTER;
554                 td->inputmode_value = MT_INPUTMODE_TOUCHPAD;
555         }
556
557         mt_application->scantime = DEFAULT_ZERO;
558         mt_application->raw_cc = DEFAULT_ZERO;
559         mt_application->quirks = td->mtclass.quirks;
560         mt_application->report_id = report->id;
561
562         list_add_tail(&mt_application->list, &td->applications);
563
564         return mt_application;
565 }
566
567 static struct mt_application *mt_find_application(struct mt_device *td,
568                                                   struct hid_report *report)
569 {
570         unsigned int application = report->application;
571         struct mt_application *tmp, *mt_application = NULL;
572
573         list_for_each_entry(tmp, &td->applications, list) {
574                 if (application == tmp->application) {
575                         if (!(td->mtclass.quirks & MT_QUIRK_SEPARATE_APP_REPORT) ||
576                             tmp->report_id == report->id) {
577                                 mt_application = tmp;
578                                 break;
579                         }
580                 }
581         }
582
583         if (!mt_application)
584                 mt_application = mt_allocate_application(td, report);
585
586         return mt_application;
587 }
588
589 static struct mt_report_data *mt_allocate_report_data(struct mt_device *td,
590                                                       struct hid_report *report)
591 {
592         struct mt_report_data *rdata;
593         struct hid_field *field;
594         int r, n;
595
596         rdata = devm_kzalloc(&td->hdev->dev, sizeof(*rdata), GFP_KERNEL);
597         if (!rdata)
598                 return NULL;
599
600         rdata->report = report;
601         rdata->application = mt_find_application(td, report);
602
603         if (!rdata->application) {
604                 devm_kfree(&td->hdev->dev, rdata);
605                 return NULL;
606         }
607
608         for (r = 0; r < report->maxfield; r++) {
609                 field = report->field[r];
610
611                 if (!(HID_MAIN_ITEM_VARIABLE & field->flags))
612                         continue;
613
614                 if (field->logical == HID_DG_FINGER || td->hdev->group != HID_GROUP_MULTITOUCH_WIN_8) {
615                         for (n = 0; n < field->report_count; n++) {
616                                 if (field->usage[n].hid == HID_DG_CONTACTID) {
617                                         rdata->is_mt_collection = true;
618                                         break;
619                                 }
620                         }
621                 }
622         }
623
624         list_add_tail(&rdata->list, &td->reports);
625
626         return rdata;
627 }
628
629 static struct mt_report_data *mt_find_report_data(struct mt_device *td,
630                                                   struct hid_report *report)
631 {
632         struct mt_report_data *tmp, *rdata = NULL;
633
634         list_for_each_entry(tmp, &td->reports, list) {
635                 if (report == tmp->report) {
636                         rdata = tmp;
637                         break;
638                 }
639         }
640
641         if (!rdata)
642                 rdata = mt_allocate_report_data(td, report);
643
644         return rdata;
645 }
646
647 static void mt_store_field(struct hid_device *hdev,
648                            struct mt_application *application,
649                            __s32 *value,
650                            size_t offset)
651 {
652         struct mt_usages *usage;
653         __s32 **target;
654
655         if (list_empty(&application->mt_usages))
656                 usage = mt_allocate_usage(hdev, application);
657         else
658                 usage = list_last_entry(&application->mt_usages,
659                                         struct mt_usages,
660                                         list);
661
662         if (!usage)
663                 return;
664
665         target = (__s32 **)((char *)usage + offset);
666
667         /* the value has already been filled, create a new slot */
668         if (*target != DEFAULT_TRUE &&
669             *target != DEFAULT_FALSE &&
670             *target != DEFAULT_ZERO) {
671                 if (usage->contactid == DEFAULT_ZERO ||
672                     usage->x == DEFAULT_ZERO ||
673                     usage->y == DEFAULT_ZERO) {
674                         hid_dbg(hdev,
675                                 "ignoring duplicate usage on incomplete");
676                         return;
677                 }
678                 usage = mt_allocate_usage(hdev, application);
679                 if (!usage)
680                         return;
681
682                 target = (__s32 **)((char *)usage + offset);
683         }
684
685         *target = value;
686 }
687
688 #define MT_STORE_FIELD(__name)                                          \
689         mt_store_field(hdev, app,                                       \
690                        &field->value[usage->usage_index],               \
691                        offsetof(struct mt_usages, __name))
692
693 static int mt_touch_input_mapping(struct hid_device *hdev, struct hid_input *hi,
694                 struct hid_field *field, struct hid_usage *usage,
695                 unsigned long **bit, int *max, struct mt_application *app)
696 {
697         struct mt_device *td = hid_get_drvdata(hdev);
698         struct mt_class *cls = &td->mtclass;
699         int code;
700         struct hid_usage *prev_usage = NULL;
701
702         /*
703          * Model touchscreens providing buttons as touchpads.
704          */
705         if (field->application == HID_DG_TOUCHSCREEN &&
706             (usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON) {
707                 app->mt_flags |= INPUT_MT_POINTER;
708                 td->inputmode_value = MT_INPUTMODE_TOUCHPAD;
709         }
710
711         /* count the buttons on touchpads */
712         if ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON)
713                 app->buttons_count++;
714
715         if (usage->usage_index)
716                 prev_usage = &field->usage[usage->usage_index - 1];
717
718         switch (usage->hid & HID_USAGE_PAGE) {
719
720         case HID_UP_GENDESK:
721                 switch (usage->hid) {
722                 case HID_GD_X:
723                         if (prev_usage && (prev_usage->hid == usage->hid)) {
724                                 code = ABS_MT_TOOL_X;
725                                 MT_STORE_FIELD(cx);
726                         } else {
727                                 code = ABS_MT_POSITION_X;
728                                 MT_STORE_FIELD(x);
729                         }
730
731                         set_abs(hi->input, code, field, cls->sn_move);
732
733                         /*
734                          * A system multi-axis that exports X and Y has a high
735                          * chance of being used directly on a surface
736                          */
737                         if (field->application == HID_GD_SYSTEM_MULTIAXIS) {
738                                 __set_bit(INPUT_PROP_DIRECT,
739                                           hi->input->propbit);
740                                 input_set_abs_params(hi->input,
741                                                      ABS_MT_TOOL_TYPE,
742                                                      MT_TOOL_DIAL,
743                                                      MT_TOOL_DIAL, 0, 0);
744                         }
745
746                         return 1;
747                 case HID_GD_Y:
748                         if (prev_usage && (prev_usage->hid == usage->hid)) {
749                                 code = ABS_MT_TOOL_Y;
750                                 MT_STORE_FIELD(cy);
751                         } else {
752                                 code = ABS_MT_POSITION_Y;
753                                 MT_STORE_FIELD(y);
754                         }
755
756                         set_abs(hi->input, code, field, cls->sn_move);
757
758                         return 1;
759                 }
760                 return 0;
761
762         case HID_UP_DIGITIZER:
763                 switch (usage->hid) {
764                 case HID_DG_INRANGE:
765                         if (app->quirks & MT_QUIRK_HOVERING) {
766                                 input_set_abs_params(hi->input,
767                                         ABS_MT_DISTANCE, 0, 1, 0, 0);
768                         }
769                         MT_STORE_FIELD(inrange_state);
770                         return 1;
771                 case HID_DG_CONFIDENCE:
772                         if ((cls->name == MT_CLS_WIN_8 ||
773                                 cls->name == MT_CLS_WIN_8_DUAL) &&
774                                 (field->application == HID_DG_TOUCHPAD ||
775                                  field->application == HID_DG_TOUCHSCREEN))
776                                 app->quirks |= MT_QUIRK_CONFIDENCE;
777
778                         if (app->quirks & MT_QUIRK_CONFIDENCE)
779                                 input_set_abs_params(hi->input,
780                                                      ABS_MT_TOOL_TYPE,
781                                                      MT_TOOL_FINGER,
782                                                      MT_TOOL_PALM, 0, 0);
783
784                         MT_STORE_FIELD(confidence_state);
785                         return 1;
786                 case HID_DG_TIPSWITCH:
787                         if (field->application != HID_GD_SYSTEM_MULTIAXIS)
788                                 input_set_capability(hi->input,
789                                                      EV_KEY, BTN_TOUCH);
790                         MT_STORE_FIELD(tip_state);
791                         return 1;
792                 case HID_DG_CONTACTID:
793                         MT_STORE_FIELD(contactid);
794                         app->touches_by_report++;
795                         return 1;
796                 case HID_DG_WIDTH:
797                         if (!(app->quirks & MT_QUIRK_NO_AREA))
798                                 set_abs(hi->input, ABS_MT_TOUCH_MAJOR, field,
799                                         cls->sn_width);
800                         MT_STORE_FIELD(w);
801                         return 1;
802                 case HID_DG_HEIGHT:
803                         if (!(app->quirks & MT_QUIRK_NO_AREA)) {
804                                 set_abs(hi->input, ABS_MT_TOUCH_MINOR, field,
805                                         cls->sn_height);
806
807                                 /*
808                                  * Only set ABS_MT_ORIENTATION if it is not
809                                  * already set by the HID_DG_AZIMUTH usage.
810                                  */
811                                 if (!test_bit(ABS_MT_ORIENTATION,
812                                                 hi->input->absbit))
813                                         input_set_abs_params(hi->input,
814                                                 ABS_MT_ORIENTATION, 0, 1, 0, 0);
815                         }
816                         MT_STORE_FIELD(h);
817                         return 1;
818                 case HID_DG_TIPPRESSURE:
819                         set_abs(hi->input, ABS_MT_PRESSURE, field,
820                                 cls->sn_pressure);
821                         MT_STORE_FIELD(p);
822                         return 1;
823                 case HID_DG_SCANTIME:
824                         input_set_capability(hi->input, EV_MSC, MSC_TIMESTAMP);
825                         app->scantime = &field->value[usage->usage_index];
826                         app->scantime_logical_max = field->logical_maximum;
827                         return 1;
828                 case HID_DG_CONTACTCOUNT:
829                         app->have_contact_count = true;
830                         app->raw_cc = &field->value[usage->usage_index];
831                         return 1;
832                 case HID_DG_AZIMUTH:
833                         /*
834                          * Azimuth has the range of [0, MAX) representing a full
835                          * revolution. Set ABS_MT_ORIENTATION to a quarter of
836                          * MAX according the definition of ABS_MT_ORIENTATION
837                          */
838                         input_set_abs_params(hi->input, ABS_MT_ORIENTATION,
839                                 -field->logical_maximum / 4,
840                                 field->logical_maximum / 4,
841                                 cls->sn_move ?
842                                 field->logical_maximum / cls->sn_move : 0, 0);
843                         MT_STORE_FIELD(a);
844                         return 1;
845                 case HID_DG_CONTACTMAX:
846                         /* contact max are global to the report */
847                         return -1;
848                 case HID_DG_TOUCH:
849                         /* Legacy devices use TIPSWITCH and not TOUCH.
850                          * Let's just ignore this field. */
851                         return -1;
852                 }
853                 /* let hid-input decide for the others */
854                 return 0;
855
856         case HID_UP_BUTTON:
857                 code = BTN_MOUSE + ((usage->hid - 1) & HID_USAGE);
858                 /*
859                  * MS PTP spec says that external buttons left and right have
860                  * usages 2 and 3.
861                  */
862                 if ((app->quirks & MT_QUIRK_WIN8_PTP_BUTTONS) &&
863                     field->application == HID_DG_TOUCHPAD &&
864                     (usage->hid & HID_USAGE) > 1)
865                         code--;
866
867                 if (field->application == HID_GD_SYSTEM_MULTIAXIS)
868                         code = BTN_0  + ((usage->hid - 1) & HID_USAGE);
869
870                 hid_map_usage(hi, usage, bit, max, EV_KEY, code);
871                 if (!*bit)
872                         return -1;
873                 input_set_capability(hi->input, EV_KEY, code);
874                 return 1;
875
876         case 0xff000000:
877                 /* we do not want to map these: no input-oriented meaning */
878                 return -1;
879         }
880
881         return 0;
882 }
883
884 static int mt_compute_slot(struct mt_device *td, struct mt_application *app,
885                            struct mt_usages *slot,
886                            struct input_dev *input)
887 {
888         __s32 quirks = app->quirks;
889
890         if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
891                 return *slot->contactid;
892
893         if (quirks & MT_QUIRK_CYPRESS)
894                 return cypress_compute_slot(app, slot);
895
896         if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
897                 return app->num_received;
898
899         if (quirks & MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE)
900                 return *slot->contactid - 1;
901
902         return input_mt_get_slot_by_key(input, *slot->contactid);
903 }
904
905 static void mt_release_pending_palms(struct mt_device *td,
906                                      struct mt_application *app,
907                                      struct input_dev *input)
908 {
909         int slotnum;
910         bool need_sync = false;
911
912         for_each_set_bit(slotnum, app->pending_palm_slots, td->maxcontacts) {
913                 clear_bit(slotnum, app->pending_palm_slots);
914
915                 input_mt_slot(input, slotnum);
916                 input_mt_report_slot_state(input, MT_TOOL_PALM, false);
917
918                 need_sync = true;
919         }
920
921         if (need_sync) {
922                 input_mt_sync_frame(input);
923                 input_sync(input);
924         }
925 }
926
927 /*
928  * this function is called when a whole packet has been received and processed,
929  * so that it can decide what to send to the input layer.
930  */
931 static void mt_sync_frame(struct mt_device *td, struct mt_application *app,
932                           struct input_dev *input)
933 {
934         if (app->quirks & MT_QUIRK_WIN8_PTP_BUTTONS)
935                 input_event(input, EV_KEY, BTN_LEFT, app->left_button_state);
936
937         input_mt_sync_frame(input);
938         input_event(input, EV_MSC, MSC_TIMESTAMP, app->timestamp);
939         input_sync(input);
940
941         mt_release_pending_palms(td, app, input);
942
943         app->num_received = 0;
944         app->left_button_state = 0;
945
946         if (test_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags))
947                 set_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags);
948         else
949                 clear_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags);
950         clear_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags);
951 }
952
953 static int mt_compute_timestamp(struct mt_application *app, __s32 value)
954 {
955         long delta = value - app->prev_scantime;
956         unsigned long jdelta = jiffies_to_usecs(jiffies - app->jiffies);
957
958         app->jiffies = jiffies;
959
960         if (delta < 0)
961                 delta += app->scantime_logical_max;
962
963         /* HID_DG_SCANTIME is expressed in 100us, we want it in us. */
964         delta *= 100;
965
966         if (jdelta > MAX_TIMESTAMP_INTERVAL)
967                 /* No data received for a while, resync the timestamp. */
968                 return 0;
969         else
970                 return app->timestamp + delta;
971 }
972
973 static int mt_touch_event(struct hid_device *hid, struct hid_field *field,
974                                 struct hid_usage *usage, __s32 value)
975 {
976         /* we will handle the hidinput part later, now remains hiddev */
977         if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
978                 hid->hiddev_hid_event(hid, field, usage, value);
979
980         return 1;
981 }
982
983 static int mt_process_slot(struct mt_device *td, struct input_dev *input,
984                             struct mt_application *app,
985                             struct mt_usages *slot)
986 {
987         struct input_mt *mt = input->mt;
988         __s32 quirks = app->quirks;
989         bool valid = true;
990         bool confidence_state = true;
991         bool inrange_state = false;
992         int active;
993         int slotnum;
994         int tool = MT_TOOL_FINGER;
995
996         if (!slot)
997                 return -EINVAL;
998
999         if ((quirks & MT_QUIRK_CONTACT_CNT_ACCURATE) &&
1000             app->num_received >= app->num_expected)
1001                 return -EAGAIN;
1002
1003         if (!(quirks & MT_QUIRK_ALWAYS_VALID)) {
1004                 if (quirks & MT_QUIRK_VALID_IS_INRANGE)
1005                         valid = *slot->inrange_state;
1006                 if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
1007                         valid = *slot->tip_state;
1008                 if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
1009                         valid = *slot->confidence_state;
1010
1011                 if (!valid)
1012                         return 0;
1013         }
1014
1015         slotnum = mt_compute_slot(td, app, slot, input);
1016         if (slotnum < 0 || slotnum >= td->maxcontacts)
1017                 return 0;
1018
1019         if ((quirks & MT_QUIRK_IGNORE_DUPLICATES) && mt) {
1020                 struct input_mt_slot *i_slot = &mt->slots[slotnum];
1021
1022                 if (input_mt_is_active(i_slot) &&
1023                     input_mt_is_used(mt, i_slot))
1024                         return -EAGAIN;
1025         }
1026
1027         if (quirks & MT_QUIRK_CONFIDENCE)
1028                 confidence_state = *slot->confidence_state;
1029
1030         if (quirks & MT_QUIRK_HOVERING)
1031                 inrange_state = *slot->inrange_state;
1032
1033         active = *slot->tip_state || inrange_state;
1034
1035         if (app->application == HID_GD_SYSTEM_MULTIAXIS)
1036                 tool = MT_TOOL_DIAL;
1037         else if (unlikely(!confidence_state)) {
1038                 tool = MT_TOOL_PALM;
1039                 if (!active && mt &&
1040                     input_mt_is_active(&mt->slots[slotnum])) {
1041                         /*
1042                          * The non-confidence was reported for
1043                          * previously valid contact that is also no
1044                          * longer valid. We can't simply report
1045                          * lift-off as userspace will not be aware
1046                          * of non-confidence, so we need to split
1047                          * it into 2 events: active MT_TOOL_PALM
1048                          * and a separate liftoff.
1049                          */
1050                         active = true;
1051                         set_bit(slotnum, app->pending_palm_slots);
1052                 }
1053         }
1054
1055         input_mt_slot(input, slotnum);
1056         input_mt_report_slot_state(input, tool, active);
1057         if (active) {
1058                 /* this finger is in proximity of the sensor */
1059                 int wide = (*slot->w > *slot->h);
1060                 int major = max(*slot->w, *slot->h);
1061                 int minor = min(*slot->w, *slot->h);
1062                 int orientation = wide;
1063                 int max_azimuth;
1064                 int azimuth;
1065
1066                 if (slot->a != DEFAULT_ZERO) {
1067                         /*
1068                          * Azimuth is counter-clockwise and ranges from [0, MAX)
1069                          * (a full revolution). Convert it to clockwise ranging
1070                          * [-MAX/2, MAX/2].
1071                          *
1072                          * Note that ABS_MT_ORIENTATION require us to report
1073                          * the limit of [-MAX/4, MAX/4], but the value can go
1074                          * out of range to [-MAX/2, MAX/2] to report an upside
1075                          * down ellipsis.
1076                          */
1077                         azimuth = *slot->a;
1078                         max_azimuth = input_abs_get_max(input,
1079                                                         ABS_MT_ORIENTATION);
1080                         if (azimuth > max_azimuth * 2)
1081                                 azimuth -= max_azimuth * 4;
1082                         orientation = -azimuth;
1083                 }
1084
1085                 if (quirks & MT_QUIRK_TOUCH_SIZE_SCALING) {
1086                         /*
1087                          * divided by two to match visual scale of touch
1088                          * for devices with this quirk
1089                          */
1090                         major = major >> 1;
1091                         minor = minor >> 1;
1092                 }
1093
1094                 input_event(input, EV_ABS, ABS_MT_POSITION_X, *slot->x);
1095                 input_event(input, EV_ABS, ABS_MT_POSITION_Y, *slot->y);
1096                 input_event(input, EV_ABS, ABS_MT_TOOL_X, *slot->cx);
1097                 input_event(input, EV_ABS, ABS_MT_TOOL_Y, *slot->cy);
1098                 input_event(input, EV_ABS, ABS_MT_DISTANCE, !*slot->tip_state);
1099                 input_event(input, EV_ABS, ABS_MT_ORIENTATION, orientation);
1100                 input_event(input, EV_ABS, ABS_MT_PRESSURE, *slot->p);
1101                 input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
1102                 input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
1103
1104                 set_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags);
1105         }
1106
1107         return 0;
1108 }
1109
1110 static void mt_process_mt_event(struct hid_device *hid,
1111                                 struct mt_application *app,
1112                                 struct hid_field *field,
1113                                 struct hid_usage *usage,
1114                                 __s32 value,
1115                                 bool first_packet)
1116 {
1117         __s32 quirks = app->quirks;
1118         struct input_dev *input = field->hidinput->input;
1119
1120         if (!usage->type || !(hid->claimed & HID_CLAIMED_INPUT))
1121                 return;
1122
1123         if (quirks & MT_QUIRK_WIN8_PTP_BUTTONS) {
1124
1125                 /*
1126                  * For Win8 PTP touchpads we should only look at
1127                  * non finger/touch events in the first_packet of a
1128                  * (possible) multi-packet frame.
1129                  */
1130                 if (!first_packet)
1131                         return;
1132
1133                 /*
1134                  * For Win8 PTP touchpads we map both the clickpad click
1135                  * and any "external" left buttons to BTN_LEFT if a
1136                  * device claims to have both we need to report 1 for
1137                  * BTN_LEFT if either is pressed, so we or all values
1138                  * together and report the result in mt_sync_frame().
1139                  */
1140                 if (usage->type == EV_KEY && usage->code == BTN_LEFT) {
1141                         app->left_button_state |= value;
1142                         return;
1143                 }
1144         }
1145
1146         input_event(input, usage->type, usage->code, value);
1147 }
1148
1149 static void mt_touch_report(struct hid_device *hid,
1150                             struct mt_report_data *rdata)
1151 {
1152         struct mt_device *td = hid_get_drvdata(hid);
1153         struct hid_report *report = rdata->report;
1154         struct mt_application *app = rdata->application;
1155         struct hid_field *field;
1156         struct input_dev *input;
1157         struct mt_usages *slot;
1158         bool first_packet;
1159         unsigned count;
1160         int r, n;
1161         int scantime = 0;
1162         int contact_count = -1;
1163
1164         /* sticky fingers release in progress, abort */
1165         if (test_and_set_bit_lock(MT_IO_FLAGS_RUNNING, &td->mt_io_flags))
1166                 return;
1167
1168         scantime = *app->scantime;
1169         app->timestamp = mt_compute_timestamp(app, scantime);
1170         if (app->raw_cc != DEFAULT_ZERO)
1171                 contact_count = *app->raw_cc;
1172
1173         /*
1174          * Includes multi-packet support where subsequent
1175          * packets are sent with zero contactcount.
1176          */
1177         if (contact_count >= 0) {
1178                 /*
1179                  * For Win8 PTPs the first packet (td->num_received == 0) may
1180                  * have a contactcount of 0 if there only is a button event.
1181                  * We double check that this is not a continuation packet
1182                  * of a possible multi-packet frame be checking that the
1183                  * timestamp has changed.
1184                  */
1185                 if ((app->quirks & MT_QUIRK_WIN8_PTP_BUTTONS) &&
1186                     app->num_received == 0 &&
1187                     app->prev_scantime != scantime)
1188                         app->num_expected = contact_count;
1189                 /* A non 0 contact count always indicates a first packet */
1190                 else if (contact_count)
1191                         app->num_expected = contact_count;
1192         }
1193         app->prev_scantime = scantime;
1194
1195         first_packet = app->num_received == 0;
1196
1197         input = report->field[0]->hidinput->input;
1198
1199         list_for_each_entry(slot, &app->mt_usages, list) {
1200                 if (!mt_process_slot(td, input, app, slot))
1201                         app->num_received++;
1202         }
1203
1204         for (r = 0; r < report->maxfield; r++) {
1205                 field = report->field[r];
1206                 count = field->report_count;
1207
1208                 if (!(HID_MAIN_ITEM_VARIABLE & field->flags))
1209                         continue;
1210
1211                 for (n = 0; n < count; n++)
1212                         mt_process_mt_event(hid, app, field,
1213                                             &field->usage[n], field->value[n],
1214                                             first_packet);
1215         }
1216
1217         if (app->num_received >= app->num_expected)
1218                 mt_sync_frame(td, app, input);
1219
1220         /*
1221          * Windows 8 specs says 2 things:
1222          * - once a contact has been reported, it has to be reported in each
1223          *   subsequent report
1224          * - the report rate when fingers are present has to be at least
1225          *   the refresh rate of the screen, 60 or 120 Hz
1226          *
1227          * I interprete this that the specification forces a report rate of
1228          * at least 60 Hz for a touchscreen to be certified.
1229          * Which means that if we do not get a report whithin 16 ms, either
1230          * something wrong happens, either the touchscreen forgets to send
1231          * a release. Taking a reasonable margin allows to remove issues
1232          * with USB communication or the load of the machine.
1233          *
1234          * Given that Win 8 devices are forced to send a release, this will
1235          * only affect laggish machines and the ones that have a firmware
1236          * defect.
1237          */
1238         if (app->quirks & MT_QUIRK_STICKY_FINGERS) {
1239                 if (test_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags))
1240                         mod_timer(&td->release_timer,
1241                                   jiffies + msecs_to_jiffies(100));
1242                 else
1243                         del_timer(&td->release_timer);
1244         }
1245
1246         clear_bit_unlock(MT_IO_FLAGS_RUNNING, &td->mt_io_flags);
1247 }
1248
1249 static int mt_touch_input_configured(struct hid_device *hdev,
1250                                      struct hid_input *hi,
1251                                      struct mt_application *app)
1252 {
1253         struct mt_device *td = hid_get_drvdata(hdev);
1254         struct mt_class *cls = &td->mtclass;
1255         struct input_dev *input = hi->input;
1256         int ret;
1257
1258         if (!td->maxcontacts)
1259                 td->maxcontacts = MT_DEFAULT_MAXCONTACT;
1260
1261         mt_post_parse(td, app);
1262         if (td->serial_maybe)
1263                 mt_post_parse_default_settings(td, app);
1264
1265         if (cls->is_indirect)
1266                 app->mt_flags |= INPUT_MT_POINTER;
1267
1268         if (app->quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
1269                 app->mt_flags |= INPUT_MT_DROP_UNUSED;
1270
1271         /* check for clickpads */
1272         if ((app->mt_flags & INPUT_MT_POINTER) &&
1273             (app->buttons_count == 1))
1274                 td->is_buttonpad = true;
1275
1276         if (td->is_buttonpad)
1277                 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
1278
1279         app->pending_palm_slots = devm_kcalloc(&hi->input->dev,
1280                                                BITS_TO_LONGS(td->maxcontacts),
1281                                                sizeof(long),
1282                                                GFP_KERNEL);
1283         if (!app->pending_palm_slots)
1284                 return -ENOMEM;
1285
1286         ret = input_mt_init_slots(input, td->maxcontacts, app->mt_flags);
1287         if (ret)
1288                 return ret;
1289
1290         app->mt_flags = 0;
1291         return 0;
1292 }
1293
1294 #define mt_map_key_clear(c)     hid_map_usage_clear(hi, usage, bit, \
1295                                                     max, EV_KEY, (c))
1296 static int mt_input_mapping(struct hid_device *hdev, struct hid_input *hi,
1297                 struct hid_field *field, struct hid_usage *usage,
1298                 unsigned long **bit, int *max)
1299 {
1300         struct mt_device *td = hid_get_drvdata(hdev);
1301         struct mt_application *application;
1302         struct mt_report_data *rdata;
1303
1304         rdata = mt_find_report_data(td, field->report);
1305         if (!rdata) {
1306                 hid_err(hdev, "failed to allocate data for report\n");
1307                 return 0;
1308         }
1309
1310         application = rdata->application;
1311
1312         /*
1313          * If mtclass.export_all_inputs is not set, only map fields from
1314          * TouchScreen or TouchPad collections. We need to ignore fields
1315          * that belong to other collections such as Mouse that might have
1316          * the same GenericDesktop usages.
1317          */
1318         if (!td->mtclass.export_all_inputs &&
1319             field->application != HID_DG_TOUCHSCREEN &&
1320             field->application != HID_DG_PEN &&
1321             field->application != HID_DG_TOUCHPAD &&
1322             field->application != HID_GD_KEYBOARD &&
1323             field->application != HID_GD_SYSTEM_CONTROL &&
1324             field->application != HID_CP_CONSUMER_CONTROL &&
1325             field->application != HID_GD_WIRELESS_RADIO_CTLS &&
1326             field->application != HID_GD_SYSTEM_MULTIAXIS &&
1327             !(field->application == HID_VD_ASUS_CUSTOM_MEDIA_KEYS &&
1328               application->quirks & MT_QUIRK_ASUS_CUSTOM_UP))
1329                 return -1;
1330
1331         /*
1332          * Some Asus keyboard+touchpad devices have the hotkeys defined in the
1333          * touchpad report descriptor. We need to treat these as an array to
1334          * map usages to input keys.
1335          */
1336         if (field->application == HID_VD_ASUS_CUSTOM_MEDIA_KEYS &&
1337             application->quirks & MT_QUIRK_ASUS_CUSTOM_UP &&
1338             (usage->hid & HID_USAGE_PAGE) == HID_UP_CUSTOM) {
1339                 set_bit(EV_REP, hi->input->evbit);
1340                 if (field->flags & HID_MAIN_ITEM_VARIABLE)
1341                         field->flags &= ~HID_MAIN_ITEM_VARIABLE;
1342                 switch (usage->hid & HID_USAGE) {
1343                 case 0x10: mt_map_key_clear(KEY_BRIGHTNESSDOWN);        break;
1344                 case 0x20: mt_map_key_clear(KEY_BRIGHTNESSUP);          break;
1345                 case 0x35: mt_map_key_clear(KEY_DISPLAY_OFF);           break;
1346                 case 0x6b: mt_map_key_clear(KEY_F21);                   break;
1347                 case 0x6c: mt_map_key_clear(KEY_SLEEP);                 break;
1348                 default:
1349                         return -1;
1350                 }
1351                 return 1;
1352         }
1353
1354         if (rdata->is_mt_collection)
1355                 return mt_touch_input_mapping(hdev, hi, field, usage, bit, max,
1356                                               application);
1357
1358         /*
1359          * some egalax touchscreens have "application == DG_TOUCHSCREEN"
1360          * for the stylus. Overwrite the hid_input application
1361          */
1362         if (field->physical == HID_DG_STYLUS)
1363                 hi->application = HID_DG_STYLUS;
1364
1365         /* let hid-core decide for the others */
1366         return 0;
1367 }
1368
1369 static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
1370                 struct hid_field *field, struct hid_usage *usage,
1371                 unsigned long **bit, int *max)
1372 {
1373         struct mt_device *td = hid_get_drvdata(hdev);
1374         struct mt_report_data *rdata;
1375
1376         rdata = mt_find_report_data(td, field->report);
1377         if (rdata && rdata->is_mt_collection) {
1378                 /* We own these mappings, tell hid-input to ignore them */
1379                 return -1;
1380         }
1381
1382         /* let hid-core decide for the others */
1383         return 0;
1384 }
1385
1386 static int mt_event(struct hid_device *hid, struct hid_field *field,
1387                                 struct hid_usage *usage, __s32 value)
1388 {
1389         struct mt_device *td = hid_get_drvdata(hid);
1390         struct mt_report_data *rdata;
1391
1392         rdata = mt_find_report_data(td, field->report);
1393         if (rdata && rdata->is_mt_collection)
1394                 return mt_touch_event(hid, field, usage, value);
1395
1396         return 0;
1397 }
1398
1399 static void mt_report(struct hid_device *hid, struct hid_report *report)
1400 {
1401         struct mt_device *td = hid_get_drvdata(hid);
1402         struct hid_field *field = report->field[0];
1403         struct mt_report_data *rdata;
1404
1405         if (!(hid->claimed & HID_CLAIMED_INPUT))
1406                 return;
1407
1408         rdata = mt_find_report_data(td, report);
1409         if (rdata && rdata->is_mt_collection)
1410                 return mt_touch_report(hid, rdata);
1411
1412         if (field && field->hidinput && field->hidinput->input)
1413                 input_sync(field->hidinput->input);
1414 }
1415
1416 static bool mt_need_to_apply_feature(struct hid_device *hdev,
1417                                      struct hid_field *field,
1418                                      struct hid_usage *usage,
1419                                      enum latency_mode latency,
1420                                      bool surface_switch,
1421                                      bool button_switch,
1422                                      bool *inputmode_found)
1423 {
1424         struct mt_device *td = hid_get_drvdata(hdev);
1425         struct mt_class *cls = &td->mtclass;
1426         struct hid_report *report = field->report;
1427         unsigned int index = usage->usage_index;
1428         char *buf;
1429         u32 report_len;
1430         int max;
1431
1432         switch (usage->hid) {
1433         case HID_DG_INPUTMODE:
1434                 /*
1435                  * Some elan panels wrongly declare 2 input mode features,
1436                  * and silently ignore when we set the value in the second
1437                  * field. Skip the second feature and hope for the best.
1438                  */
1439                 if (*inputmode_found)
1440                         return false;
1441
1442                 if (cls->quirks & MT_QUIRK_FORCE_GET_FEATURE) {
1443                         report_len = hid_report_len(report);
1444                         buf = hid_alloc_report_buf(report, GFP_KERNEL);
1445                         if (!buf) {
1446                                 hid_err(hdev,
1447                                         "failed to allocate buffer for report\n");
1448                                 return false;
1449                         }
1450                         hid_hw_raw_request(hdev, report->id, buf, report_len,
1451                                            HID_FEATURE_REPORT,
1452                                            HID_REQ_GET_REPORT);
1453                         kfree(buf);
1454                 }
1455
1456                 field->value[index] = td->inputmode_value;
1457                 *inputmode_found = true;
1458                 return true;
1459
1460         case HID_DG_CONTACTMAX:
1461                 if (cls->maxcontacts) {
1462                         max = min_t(int, field->logical_maximum,
1463                                     cls->maxcontacts);
1464                         if (field->value[index] != max) {
1465                                 field->value[index] = max;
1466                                 return true;
1467                         }
1468                 }
1469                 break;
1470
1471         case HID_DG_LATENCYMODE:
1472                 field->value[index] = latency;
1473                 return true;
1474
1475         case HID_DG_SURFACESWITCH:
1476                 field->value[index] = surface_switch;
1477                 return true;
1478
1479         case HID_DG_BUTTONSWITCH:
1480                 field->value[index] = button_switch;
1481                 return true;
1482         }
1483
1484         return false; /* no need to update the report */
1485 }
1486
1487 static void mt_set_modes(struct hid_device *hdev, enum latency_mode latency,
1488                          bool surface_switch, bool button_switch)
1489 {
1490         struct hid_report_enum *rep_enum;
1491         struct hid_report *rep;
1492         struct hid_usage *usage;
1493         int i, j;
1494         bool update_report;
1495         bool inputmode_found = false;
1496
1497         rep_enum = &hdev->report_enum[HID_FEATURE_REPORT];
1498         list_for_each_entry(rep, &rep_enum->report_list, list) {
1499                 update_report = false;
1500
1501                 for (i = 0; i < rep->maxfield; i++) {
1502                         /* Ignore if report count is out of bounds. */
1503                         if (rep->field[i]->report_count < 1)
1504                                 continue;
1505
1506                         for (j = 0; j < rep->field[i]->maxusage; j++) {
1507                                 usage = &rep->field[i]->usage[j];
1508
1509                                 if (mt_need_to_apply_feature(hdev,
1510                                                              rep->field[i],
1511                                                              usage,
1512                                                              latency,
1513                                                              surface_switch,
1514                                                              button_switch,
1515                                                              &inputmode_found))
1516                                         update_report = true;
1517                         }
1518                 }
1519
1520                 if (update_report)
1521                         hid_hw_request(hdev, rep, HID_REQ_SET_REPORT);
1522         }
1523 }
1524
1525 static void mt_post_parse_default_settings(struct mt_device *td,
1526                                            struct mt_application *app)
1527 {
1528         __s32 quirks = app->quirks;
1529
1530         /* unknown serial device needs special quirks */
1531         if (list_is_singular(&app->mt_usages)) {
1532                 quirks |= MT_QUIRK_ALWAYS_VALID;
1533                 quirks &= ~MT_QUIRK_NOT_SEEN_MEANS_UP;
1534                 quirks &= ~MT_QUIRK_VALID_IS_INRANGE;
1535                 quirks &= ~MT_QUIRK_VALID_IS_CONFIDENCE;
1536                 quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
1537         }
1538
1539         app->quirks = quirks;
1540 }
1541
1542 static void mt_post_parse(struct mt_device *td, struct mt_application *app)
1543 {
1544         if (!app->have_contact_count)
1545                 app->quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
1546 }
1547
1548 static int mt_input_configured(struct hid_device *hdev, struct hid_input *hi)
1549 {
1550         struct mt_device *td = hid_get_drvdata(hdev);
1551         char *name;
1552         const char *suffix = NULL;
1553         struct mt_report_data *rdata;
1554         struct mt_application *mt_application = NULL;
1555         struct hid_report *report;
1556         int ret;
1557
1558         list_for_each_entry(report, &hi->reports, hidinput_list) {
1559                 rdata = mt_find_report_data(td, report);
1560                 if (!rdata) {
1561                         hid_err(hdev, "failed to allocate data for report\n");
1562                         return -ENOMEM;
1563                 }
1564
1565                 mt_application = rdata->application;
1566
1567                 if (rdata->is_mt_collection) {
1568                         ret = mt_touch_input_configured(hdev, hi,
1569                                                         mt_application);
1570                         if (ret)
1571                                 return ret;
1572                 }
1573         }
1574
1575         switch (hi->application) {
1576         case HID_GD_KEYBOARD:
1577         case HID_GD_KEYPAD:
1578         case HID_GD_MOUSE:
1579         case HID_DG_TOUCHPAD:
1580         case HID_GD_SYSTEM_CONTROL:
1581         case HID_CP_CONSUMER_CONTROL:
1582         case HID_GD_WIRELESS_RADIO_CTLS:
1583         case HID_GD_SYSTEM_MULTIAXIS:
1584                 /* already handled by hid core */
1585                 break;
1586         case HID_DG_TOUCHSCREEN:
1587                 /* we do not set suffix = "Touchscreen" */
1588                 hi->input->name = hdev->name;
1589                 break;
1590         case HID_VD_ASUS_CUSTOM_MEDIA_KEYS:
1591                 suffix = "Custom Media Keys";
1592                 break;
1593         case HID_DG_STYLUS:
1594                 /* force BTN_STYLUS to allow tablet matching in udev */
1595                 __set_bit(BTN_STYLUS, hi->input->keybit);
1596                 fallthrough;
1597         case HID_DG_PEN:
1598                 suffix = "Stylus";
1599                 break;
1600         default:
1601                 suffix = "UNKNOWN";
1602                 break;
1603         }
1604
1605         if (suffix) {
1606                 name = devm_kzalloc(&hi->input->dev,
1607                                     strlen(hdev->name) + strlen(suffix) + 2,
1608                                     GFP_KERNEL);
1609                 if (name) {
1610                         sprintf(name, "%s %s", hdev->name, suffix);
1611                         hi->input->name = name;
1612                 }
1613         }
1614
1615         return 0;
1616 }
1617
1618 static void mt_fix_const_field(struct hid_field *field, unsigned int usage)
1619 {
1620         if (field->usage[0].hid != usage ||
1621             !(field->flags & HID_MAIN_ITEM_CONSTANT))
1622                 return;
1623
1624         field->flags &= ~HID_MAIN_ITEM_CONSTANT;
1625         field->flags |= HID_MAIN_ITEM_VARIABLE;
1626 }
1627
1628 static void mt_fix_const_fields(struct hid_device *hdev, unsigned int usage)
1629 {
1630         struct hid_report *report;
1631         int i;
1632
1633         list_for_each_entry(report,
1634                             &hdev->report_enum[HID_INPUT_REPORT].report_list,
1635                             list) {
1636
1637                 if (!report->maxfield)
1638                         continue;
1639
1640                 for (i = 0; i < report->maxfield; i++)
1641                         if (report->field[i]->maxusage >= 1)
1642                                 mt_fix_const_field(report->field[i], usage);
1643         }
1644 }
1645
1646 static void mt_release_contacts(struct hid_device *hid)
1647 {
1648         struct hid_input *hidinput;
1649         struct mt_application *application;
1650         struct mt_device *td = hid_get_drvdata(hid);
1651
1652         list_for_each_entry(hidinput, &hid->inputs, list) {
1653                 struct input_dev *input_dev = hidinput->input;
1654                 struct input_mt *mt = input_dev->mt;
1655                 int i;
1656
1657                 if (mt) {
1658                         for (i = 0; i < mt->num_slots; i++) {
1659                                 input_mt_slot(input_dev, i);
1660                                 input_mt_report_slot_state(input_dev,
1661                                                            MT_TOOL_FINGER,
1662                                                            false);
1663                         }
1664                         input_mt_sync_frame(input_dev);
1665                         input_sync(input_dev);
1666                 }
1667         }
1668
1669         list_for_each_entry(application, &td->applications, list) {
1670                 application->num_received = 0;
1671         }
1672 }
1673
1674 static void mt_expired_timeout(struct timer_list *t)
1675 {
1676         struct mt_device *td = from_timer(td, t, release_timer);
1677         struct hid_device *hdev = td->hdev;
1678
1679         /*
1680          * An input report came in just before we release the sticky fingers,
1681          * it will take care of the sticky fingers.
1682          */
1683         if (test_and_set_bit_lock(MT_IO_FLAGS_RUNNING, &td->mt_io_flags))
1684                 return;
1685         if (test_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags))
1686                 mt_release_contacts(hdev);
1687         clear_bit_unlock(MT_IO_FLAGS_RUNNING, &td->mt_io_flags);
1688 }
1689
1690 static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
1691 {
1692         int ret, i;
1693         struct mt_device *td;
1694         const struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */
1695
1696         for (i = 0; mt_classes[i].name ; i++) {
1697                 if (id->driver_data == mt_classes[i].name) {
1698                         mtclass = &(mt_classes[i]);
1699                         break;
1700                 }
1701         }
1702
1703         td = devm_kzalloc(&hdev->dev, sizeof(struct mt_device), GFP_KERNEL);
1704         if (!td) {
1705                 dev_err(&hdev->dev, "cannot allocate multitouch data\n");
1706                 return -ENOMEM;
1707         }
1708         td->hdev = hdev;
1709         td->mtclass = *mtclass;
1710         td->inputmode_value = MT_INPUTMODE_TOUCHSCREEN;
1711         hid_set_drvdata(hdev, td);
1712
1713         INIT_LIST_HEAD(&td->applications);
1714         INIT_LIST_HEAD(&td->reports);
1715
1716         if (id->vendor == HID_ANY_ID && id->product == HID_ANY_ID)
1717                 td->serial_maybe = true;
1718
1719         /* This allows the driver to correctly support devices
1720          * that emit events over several HID messages.
1721          */
1722         hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
1723
1724         /*
1725          * This allows the driver to handle different input sensors
1726          * that emits events through different applications on the same HID
1727          * device.
1728          */
1729         hdev->quirks |= HID_QUIRK_INPUT_PER_APP;
1730
1731         if (id->group != HID_GROUP_MULTITOUCH_WIN_8)
1732                 hdev->quirks |= HID_QUIRK_MULTI_INPUT;
1733
1734         if (mtclass->quirks & MT_QUIRK_FORCE_MULTI_INPUT) {
1735                 hdev->quirks &= ~HID_QUIRK_INPUT_PER_APP;
1736                 hdev->quirks |= HID_QUIRK_MULTI_INPUT;
1737         }
1738
1739         timer_setup(&td->release_timer, mt_expired_timeout, 0);
1740
1741         ret = hid_parse(hdev);
1742         if (ret != 0)
1743                 return ret;
1744
1745         if (mtclass->quirks & MT_QUIRK_FIX_CONST_CONTACT_ID)
1746                 mt_fix_const_fields(hdev, HID_DG_CONTACTID);
1747
1748         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
1749         if (ret)
1750                 return ret;
1751
1752         ret = sysfs_create_group(&hdev->dev.kobj, &mt_attribute_group);
1753         if (ret)
1754                 dev_warn(&hdev->dev, "Cannot allocate sysfs group for %s\n",
1755                                 hdev->name);
1756
1757         mt_set_modes(hdev, HID_LATENCY_NORMAL, true, true);
1758
1759         return 0;
1760 }
1761
1762 #ifdef CONFIG_PM
1763 static int mt_reset_resume(struct hid_device *hdev)
1764 {
1765         mt_release_contacts(hdev);
1766         mt_set_modes(hdev, HID_LATENCY_NORMAL, true, true);
1767         return 0;
1768 }
1769
1770 static int mt_resume(struct hid_device *hdev)
1771 {
1772         /* Some Elan legacy devices require SET_IDLE to be set on resume.
1773          * It should be safe to send it to other devices too.
1774          * Tested on 3M, Stantum, Cypress, Zytronic, eGalax, and Elan panels. */
1775
1776         hid_hw_idle(hdev, 0, 0, HID_REQ_SET_IDLE);
1777
1778         return 0;
1779 }
1780 #endif
1781
1782 static void mt_remove(struct hid_device *hdev)
1783 {
1784         struct mt_device *td = hid_get_drvdata(hdev);
1785
1786         del_timer_sync(&td->release_timer);
1787
1788         sysfs_remove_group(&hdev->dev.kobj, &mt_attribute_group);
1789         hid_hw_stop(hdev);
1790 }
1791
1792 /*
1793  * This list contains only:
1794  * - VID/PID of products not working with the default multitouch handling
1795  * - 2 generic rules.
1796  * So there is no point in adding here any device with MT_CLS_DEFAULT.
1797  */
1798 static const struct hid_device_id mt_devices[] = {
1799
1800         /* 3M panels */
1801         { .driver_data = MT_CLS_3M,
1802                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1803                         USB_DEVICE_ID_3M1968) },
1804         { .driver_data = MT_CLS_3M,
1805                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1806                         USB_DEVICE_ID_3M2256) },
1807         { .driver_data = MT_CLS_3M,
1808                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1809                         USB_DEVICE_ID_3M3266) },
1810
1811         /* Alps devices */
1812         { .driver_data = MT_CLS_WIN_8_DUAL,
1813                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1814                         USB_VENDOR_ID_ALPS_JP,
1815                         HID_DEVICE_ID_ALPS_U1_DUAL_PTP) },
1816         { .driver_data = MT_CLS_WIN_8_DUAL,
1817                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1818                         USB_VENDOR_ID_ALPS_JP,
1819                         HID_DEVICE_ID_ALPS_U1_DUAL_3BTN_PTP) },
1820         { .driver_data = MT_CLS_WIN_8_DUAL,
1821                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1822                         USB_VENDOR_ID_ALPS_JP,
1823                         HID_DEVICE_ID_ALPS_1222) },
1824
1825         /* Lenovo X1 TAB Gen 2 */
1826         { .driver_data = MT_CLS_WIN_8_DUAL,
1827                 HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1828                            USB_VENDOR_ID_LENOVO,
1829                            USB_DEVICE_ID_LENOVO_X1_TAB) },
1830
1831         /* Lenovo X1 TAB Gen 3 */
1832         { .driver_data = MT_CLS_WIN_8_DUAL,
1833                 HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1834                            USB_VENDOR_ID_LENOVO,
1835                            USB_DEVICE_ID_LENOVO_X1_TAB3) },
1836
1837         /* Anton devices */
1838         { .driver_data = MT_CLS_EXPORT_ALL_INPUTS,
1839                 MT_USB_DEVICE(USB_VENDOR_ID_ANTON,
1840                         USB_DEVICE_ID_ANTON_TOUCH_PAD) },
1841
1842         /* Asus T304UA */
1843         { .driver_data = MT_CLS_ASUS,
1844                 HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1845                         USB_VENDOR_ID_ASUSTEK,
1846                         USB_DEVICE_ID_ASUSTEK_T304_KEYBOARD) },
1847
1848         /* Atmel panels */
1849         { .driver_data = MT_CLS_SERIAL,
1850                 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL,
1851                         USB_DEVICE_ID_ATMEL_MXT_DIGITIZER) },
1852
1853         /* Baanto multitouch devices */
1854         { .driver_data = MT_CLS_NSMU,
1855                 MT_USB_DEVICE(USB_VENDOR_ID_BAANTO,
1856                         USB_DEVICE_ID_BAANTO_MT_190W2) },
1857
1858         /* Cando panels */
1859         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1860                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1861                         USB_DEVICE_ID_CANDO_MULTI_TOUCH) },
1862         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1863                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1864                         USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6) },
1865
1866         /* Chunghwa Telecom touch panels */
1867         {  .driver_data = MT_CLS_NSMU,
1868                 MT_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT,
1869                         USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH) },
1870
1871         /* Cirque devices */
1872         { .driver_data = MT_CLS_WIN_8_DUAL,
1873                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1874                         I2C_VENDOR_ID_CIRQUE,
1875                         I2C_PRODUCT_ID_CIRQUE_121F) },
1876
1877         /* CJTouch panels */
1878         { .driver_data = MT_CLS_NSMU,
1879                 MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1880                         USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0020) },
1881         { .driver_data = MT_CLS_NSMU,
1882                 MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1883                         USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0040) },
1884
1885         /* CVTouch panels */
1886         { .driver_data = MT_CLS_NSMU,
1887                 MT_USB_DEVICE(USB_VENDOR_ID_CVTOUCH,
1888                         USB_DEVICE_ID_CVTOUCH_SCREEN) },
1889
1890         /* eGalax devices (resistive) */
1891         { .driver_data = MT_CLS_EGALAX,
1892                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1893                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D) },
1894         { .driver_data = MT_CLS_EGALAX,
1895                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1896                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E) },
1897
1898         /* eGalax devices (capacitive) */
1899         { .driver_data = MT_CLS_EGALAX_SERIAL,
1900                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1901                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7207) },
1902         { .driver_data = MT_CLS_EGALAX,
1903                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1904                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C) },
1905         { .driver_data = MT_CLS_EGALAX_SERIAL,
1906                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1907                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224) },
1908         { .driver_data = MT_CLS_EGALAX_SERIAL,
1909                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1910                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_722A) },
1911         { .driver_data = MT_CLS_EGALAX_SERIAL,
1912                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1913                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_725E) },
1914         { .driver_data = MT_CLS_EGALAX_SERIAL,
1915                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1916                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7262) },
1917         { .driver_data = MT_CLS_EGALAX,
1918                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1919                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B) },
1920         { .driver_data = MT_CLS_EGALAX,
1921                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1922                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1) },
1923         { .driver_data = MT_CLS_EGALAX_SERIAL,
1924                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1925                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72AA) },
1926         { .driver_data = MT_CLS_EGALAX,
1927                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1928                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72C4) },
1929         { .driver_data = MT_CLS_EGALAX,
1930                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1931                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72D0) },
1932         { .driver_data = MT_CLS_EGALAX,
1933                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1934                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA) },
1935         { .driver_data = MT_CLS_EGALAX,
1936                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1937                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302) },
1938         { .driver_data = MT_CLS_EGALAX_SERIAL,
1939                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1940                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7349) },
1941         { .driver_data = MT_CLS_EGALAX_SERIAL,
1942                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1943                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_73F7) },
1944         { .driver_data = MT_CLS_EGALAX_SERIAL,
1945                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1946                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001) },
1947         { .driver_data = MT_CLS_EGALAX,
1948                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1949                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_C002) },
1950
1951         /* Elan devices */
1952         { .driver_data = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
1953                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1954                         USB_VENDOR_ID_ELAN, 0x313a) },
1955
1956         { .driver_data = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
1957                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1958                         USB_VENDOR_ID_ELAN, 0x3148) },
1959
1960         /* Elitegroup panel */
1961         { .driver_data = MT_CLS_SERIAL,
1962                 MT_USB_DEVICE(USB_VENDOR_ID_ELITEGROUP,
1963                         USB_DEVICE_ID_ELITEGROUP_05D8) },
1964
1965         /* Flatfrog Panels */
1966         { .driver_data = MT_CLS_FLATFROG,
1967                 MT_USB_DEVICE(USB_VENDOR_ID_FLATFROG,
1968                         USB_DEVICE_ID_MULTITOUCH_3200) },
1969
1970         /* FocalTech Panels */
1971         { .driver_data = MT_CLS_SERIAL,
1972                 MT_USB_DEVICE(USB_VENDOR_ID_CYGNAL,
1973                         USB_DEVICE_ID_FOCALTECH_FTXXXX_MULTITOUCH) },
1974
1975         /* GeneralTouch panel */
1976         { .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1977                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1978                         USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
1979         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1980                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1981                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PWT_TENFINGERS) },
1982         { .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1983                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1984                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0101) },
1985         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1986                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1987                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0102) },
1988         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1989                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1990                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0106) },
1991         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1992                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1993                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_010A) },
1994         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1995                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1996                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_E100) },
1997
1998         /* Gametel game controller */
1999         { .driver_data = MT_CLS_NSMU,
2000                 MT_BT_DEVICE(USB_VENDOR_ID_FRUCTEL,
2001                         USB_DEVICE_ID_GAMETEL_MT_MODE) },
2002
2003         /* GoodTouch panels */
2004         { .driver_data = MT_CLS_NSMU,
2005                 MT_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH,
2006                         USB_DEVICE_ID_GOODTOUCH_000f) },
2007
2008         /* Hanvon panels */
2009         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
2010                 MT_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT,
2011                         USB_DEVICE_ID_HANVON_ALT_MULTITOUCH) },
2012
2013         /* Ilitek dual touch panel */
2014         {  .driver_data = MT_CLS_NSMU,
2015                 MT_USB_DEVICE(USB_VENDOR_ID_ILITEK,
2016                         USB_DEVICE_ID_ILITEK_MULTITOUCH) },
2017
2018         /* LG Melfas panel */
2019         { .driver_data = MT_CLS_LG,
2020                 HID_USB_DEVICE(USB_VENDOR_ID_LG,
2021                         USB_DEVICE_ID_LG_MELFAS_MT) },
2022         { .driver_data = MT_CLS_LG,
2023                 HID_DEVICE(BUS_I2C, HID_GROUP_GENERIC,
2024                         USB_VENDOR_ID_LG, I2C_DEVICE_ID_LG_7010) },
2025
2026         /* MosArt panels */
2027         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
2028                 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
2029                         USB_DEVICE_ID_ASUS_T91MT)},
2030         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
2031                 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
2032                         USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO) },
2033         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
2034                 MT_USB_DEVICE(USB_VENDOR_ID_TURBOX,
2035                         USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART) },
2036
2037         /* Novatek Panel */
2038         { .driver_data = MT_CLS_NSMU,
2039                 MT_USB_DEVICE(USB_VENDOR_ID_NOVATEK,
2040                         USB_DEVICE_ID_NOVATEK_PCT) },
2041
2042         /* Ntrig Panel */
2043         { .driver_data = MT_CLS_NSMU,
2044                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
2045                         USB_VENDOR_ID_NTRIG, 0x1b05) },
2046
2047         /* Panasonic panels */
2048         { .driver_data = MT_CLS_PANASONIC,
2049                 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
2050                         USB_DEVICE_ID_PANABOARD_UBT780) },
2051         { .driver_data = MT_CLS_PANASONIC,
2052                 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
2053                         USB_DEVICE_ID_PANABOARD_UBT880) },
2054
2055         /* PixArt optical touch screen */
2056         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
2057                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
2058                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN) },
2059         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
2060                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
2061                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1) },
2062         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
2063                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
2064                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2) },
2065
2066         /* PixCir-based panels */
2067         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
2068                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
2069                         USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
2070
2071         /* Quanta-based panels */
2072         { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
2073                 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
2074                         USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001) },
2075
2076         /* Razer touchpads */
2077         { .driver_data = MT_CLS_RAZER_BLADE_STEALTH,
2078                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
2079                         USB_VENDOR_ID_SYNAPTICS, 0x8323) },
2080
2081         /* Smart Tech panels */
2082         { .driver_data = MT_CLS_SMART_TECH,
2083                 MT_USB_DEVICE(0x0b8c, 0x0092)},
2084
2085         /* Stantum panels */
2086         { .driver_data = MT_CLS_CONFIDENCE,
2087                 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM,
2088                         USB_DEVICE_ID_MTP_STM)},
2089
2090         /* Synaptics devices */
2091         { .driver_data = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
2092                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
2093                         USB_VENDOR_ID_SYNAPTICS, 0xce08) },
2094
2095         { .driver_data = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
2096                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
2097                         USB_VENDOR_ID_SYNAPTICS, 0xce09) },
2098
2099         /* TopSeed panels */
2100         { .driver_data = MT_CLS_TOPSEED,
2101                 MT_USB_DEVICE(USB_VENDOR_ID_TOPSEED2,
2102                         USB_DEVICE_ID_TOPSEED2_PERIPAD_701) },
2103
2104         /* Touch International panels */
2105         { .driver_data = MT_CLS_NSMU,
2106                 MT_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL,
2107                         USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH) },
2108
2109         /* Unitec panels */
2110         { .driver_data = MT_CLS_NSMU,
2111                 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
2112                         USB_DEVICE_ID_UNITEC_USB_TOUCH_0709) },
2113         { .driver_data = MT_CLS_NSMU,
2114                 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
2115                         USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19) },
2116
2117         /* VTL panels */
2118         { .driver_data = MT_CLS_VTL,
2119                 MT_USB_DEVICE(USB_VENDOR_ID_VTL,
2120                         USB_DEVICE_ID_VTL_MULTITOUCH_FF3F) },
2121
2122         /* Wistron panels */
2123         { .driver_data = MT_CLS_NSMU,
2124                 MT_USB_DEVICE(USB_VENDOR_ID_WISTRON,
2125                         USB_DEVICE_ID_WISTRON_OPTICAL_TOUCH) },
2126
2127         /* XAT */
2128         { .driver_data = MT_CLS_NSMU,
2129                 MT_USB_DEVICE(USB_VENDOR_ID_XAT,
2130                         USB_DEVICE_ID_XAT_CSR) },
2131
2132         /* Xiroku */
2133         { .driver_data = MT_CLS_NSMU,
2134                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2135                         USB_DEVICE_ID_XIROKU_SPX) },
2136         { .driver_data = MT_CLS_NSMU,
2137                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2138                         USB_DEVICE_ID_XIROKU_MPX) },
2139         { .driver_data = MT_CLS_NSMU,
2140                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2141                         USB_DEVICE_ID_XIROKU_CSR) },
2142         { .driver_data = MT_CLS_NSMU,
2143                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2144                         USB_DEVICE_ID_XIROKU_SPX1) },
2145         { .driver_data = MT_CLS_NSMU,
2146                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2147                         USB_DEVICE_ID_XIROKU_MPX1) },
2148         { .driver_data = MT_CLS_NSMU,
2149                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2150                         USB_DEVICE_ID_XIROKU_CSR1) },
2151         { .driver_data = MT_CLS_NSMU,
2152                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2153                         USB_DEVICE_ID_XIROKU_SPX2) },
2154         { .driver_data = MT_CLS_NSMU,
2155                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2156                         USB_DEVICE_ID_XIROKU_MPX2) },
2157         { .driver_data = MT_CLS_NSMU,
2158                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2159                         USB_DEVICE_ID_XIROKU_CSR2) },
2160
2161         /* Google MT devices */
2162         { .driver_data = MT_CLS_GOOGLE,
2163                 HID_DEVICE(HID_BUS_ANY, HID_GROUP_ANY, USB_VENDOR_ID_GOOGLE,
2164                         USB_DEVICE_ID_GOOGLE_TOUCH_ROSE) },
2165         { .driver_data = MT_CLS_GOOGLE,
2166                 HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8, USB_VENDOR_ID_GOOGLE,
2167                         USB_DEVICE_ID_GOOGLE_WHISKERS) },
2168
2169         /* Generic MT device */
2170         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH, HID_ANY_ID, HID_ANY_ID) },
2171
2172         /* Generic Win 8 certified MT device */
2173         {  .driver_data = MT_CLS_WIN_8,
2174                 HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH_WIN_8,
2175                         HID_ANY_ID, HID_ANY_ID) },
2176         { }
2177 };
2178 MODULE_DEVICE_TABLE(hid, mt_devices);
2179
2180 static const struct hid_usage_id mt_grabbed_usages[] = {
2181         { HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
2182         { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
2183 };
2184
2185 static struct hid_driver mt_driver = {
2186         .name = "hid-multitouch",
2187         .id_table = mt_devices,
2188         .probe = mt_probe,
2189         .remove = mt_remove,
2190         .input_mapping = mt_input_mapping,
2191         .input_mapped = mt_input_mapped,
2192         .input_configured = mt_input_configured,
2193         .feature_mapping = mt_feature_mapping,
2194         .usage_table = mt_grabbed_usages,
2195         .event = mt_event,
2196         .report = mt_report,
2197 #ifdef CONFIG_PM
2198         .reset_resume = mt_reset_resume,
2199         .resume = mt_resume,
2200 #endif
2201 };
2202 module_hid_driver(mt_driver);