HID: hid-multitouch: Only match MT interfaces
[firefly-linux-kernel-4.4.55.git] / drivers / hid / hid-multitouch.c
1 /*
2  *  HID driver for multitouch panels
3  *
4  *  Copyright (c) 2010-2012 Stephane Chatty <chatty@enac.fr>
5  *  Copyright (c) 2010-2012 Benjamin Tissoires <benjamin.tissoires@gmail.com>
6  *  Copyright (c) 2010-2012 Ecole Nationale de l'Aviation Civile, France
7  *
8  *  This code is partly based on hid-egalax.c:
9  *
10  *  Copyright (c) 2010 Stephane Chatty <chatty@enac.fr>
11  *  Copyright (c) 2010 Henrik Rydberg <rydberg@euromail.se>
12  *  Copyright (c) 2010 Canonical, Ltd.
13  *
14  *  This code is partly based on hid-3m-pct.c:
15  *
16  *  Copyright (c) 2009-2010 Stephane Chatty <chatty@enac.fr>
17  *  Copyright (c) 2010      Henrik Rydberg <rydberg@euromail.se>
18  *  Copyright (c) 2010      Canonical, Ltd.
19  *
20  */
21
22 /*
23  * This program is free software; you can redistribute it and/or modify it
24  * under the terms of the GNU General Public License as published by the Free
25  * Software Foundation; either version 2 of the License, or (at your option)
26  * any later version.
27  */
28
29 #include <linux/device.h>
30 #include <linux/hid.h>
31 #include <linux/module.h>
32 #include <linux/slab.h>
33 #include <linux/usb.h>
34 #include <linux/input/mt.h>
35 #include "usbhid/usbhid.h"
36
37
38 MODULE_AUTHOR("Stephane Chatty <chatty@enac.fr>");
39 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
40 MODULE_DESCRIPTION("HID multitouch panels");
41 MODULE_LICENSE("GPL");
42
43 #include "hid-ids.h"
44
45 /* quirks to control the device */
46 #define MT_QUIRK_NOT_SEEN_MEANS_UP      (1 << 0)
47 #define MT_QUIRK_SLOT_IS_CONTACTID      (1 << 1)
48 #define MT_QUIRK_CYPRESS                (1 << 2)
49 #define MT_QUIRK_SLOT_IS_CONTACTNUMBER  (1 << 3)
50 #define MT_QUIRK_ALWAYS_VALID           (1 << 4)
51 #define MT_QUIRK_VALID_IS_INRANGE       (1 << 5)
52 #define MT_QUIRK_VALID_IS_CONFIDENCE    (1 << 6)
53 #define MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE    (1 << 8)
54
55 struct mt_slot {
56         __s32 x, y, p, w, h;
57         __s32 contactid;        /* the device ContactID assigned to this slot */
58         bool touch_state;       /* is the touch valid? */
59         bool seen_in_this_frame;/* has this slot been updated */
60 };
61
62 struct mt_class {
63         __s32 name;     /* MT_CLS */
64         __s32 quirks;
65         __s32 sn_move;  /* Signal/noise ratio for move events */
66         __s32 sn_width; /* Signal/noise ratio for width events */
67         __s32 sn_height;        /* Signal/noise ratio for height events */
68         __s32 sn_pressure;      /* Signal/noise ratio for pressure events */
69         __u8 maxcontacts;
70         bool is_indirect;       /* true for touchpads */
71 };
72
73 struct mt_device {
74         struct mt_slot curdata; /* placeholder of incoming data */
75         struct mt_class mtclass;        /* our mt device class */
76         unsigned last_field_index;      /* last field index of the report */
77         unsigned last_slot_field;       /* the last field of a slot */
78         __s8 inputmode;         /* InputMode HID feature, -1 if non-existent */
79         __s8 maxcontact_report_id;      /* Maximum Contact Number HID feature,
80                                    -1 if non-existent */
81         __u8 num_received;      /* how many contacts we received */
82         __u8 num_expected;      /* expected last contact index */
83         __u8 maxcontacts;
84         __u8 touches_by_report; /* how many touches are present in one report:
85                                 * 1 means we should use a serial protocol
86                                 * > 1 means hybrid (multitouch) protocol */
87         bool curvalid;          /* is the current contact valid? */
88         struct mt_slot *slots;
89 };
90
91 /* classes of device behavior */
92 #define MT_CLS_DEFAULT                          0x0001
93
94 #define MT_CLS_SERIAL                           0x0002
95 #define MT_CLS_CONFIDENCE                       0x0003
96 #define MT_CLS_CONFIDENCE_CONTACT_ID            0x0004
97 #define MT_CLS_CONFIDENCE_MINUS_ONE             0x0005
98 #define MT_CLS_DUAL_INRANGE_CONTACTID           0x0006
99 #define MT_CLS_DUAL_INRANGE_CONTACTNUMBER       0x0007
100 #define MT_CLS_DUAL_NSMU_CONTACTID              0x0008
101 #define MT_CLS_INRANGE_CONTACTNUMBER            0x0009
102
103 /* vendor specific classes */
104 #define MT_CLS_3M                               0x0101
105 #define MT_CLS_CYPRESS                          0x0102
106 #define MT_CLS_EGALAX                           0x0103
107 #define MT_CLS_EGALAX_SERIAL                    0x0104
108 #define MT_CLS_TOPSEED                          0x0105
109 #define MT_CLS_PANASONIC                        0x0106
110
111 #define MT_DEFAULT_MAXCONTACT   10
112
113 #define MT_USB_DEVICE(v, p)     HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH, v, p)
114 #define MT_BT_DEVICE(v, p)      HID_DEVICE(BUS_BLUETOOTH, HID_GROUP_MULTITOUCH, v, p)
115
116 /*
117  * these device-dependent functions determine what slot corresponds
118  * to a valid contact that was just read.
119  */
120
121 static int cypress_compute_slot(struct mt_device *td)
122 {
123         if (td->curdata.contactid != 0 || td->num_received == 0)
124                 return td->curdata.contactid;
125         else
126                 return -1;
127 }
128
129 static int find_slot_from_contactid(struct mt_device *td)
130 {
131         int i;
132         for (i = 0; i < td->maxcontacts; ++i) {
133                 if (td->slots[i].contactid == td->curdata.contactid &&
134                         td->slots[i].touch_state)
135                         return i;
136         }
137         for (i = 0; i < td->maxcontacts; ++i) {
138                 if (!td->slots[i].seen_in_this_frame &&
139                         !td->slots[i].touch_state)
140                         return i;
141         }
142         /* should not occurs. If this happens that means
143          * that the device sent more touches that it says
144          * in the report descriptor. It is ignored then. */
145         return -1;
146 }
147
148 static struct mt_class mt_classes[] = {
149         { .name = MT_CLS_DEFAULT,
150                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP },
151         { .name = MT_CLS_SERIAL,
152                 .quirks = MT_QUIRK_ALWAYS_VALID},
153         { .name = MT_CLS_CONFIDENCE,
154                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE },
155         { .name = MT_CLS_CONFIDENCE_CONTACT_ID,
156                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
157                         MT_QUIRK_SLOT_IS_CONTACTID },
158         { .name = MT_CLS_CONFIDENCE_MINUS_ONE,
159                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
160                         MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE },
161         { .name = MT_CLS_DUAL_INRANGE_CONTACTID,
162                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
163                         MT_QUIRK_SLOT_IS_CONTACTID,
164                 .maxcontacts = 2 },
165         { .name = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
166                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
167                         MT_QUIRK_SLOT_IS_CONTACTNUMBER,
168                 .maxcontacts = 2 },
169         { .name = MT_CLS_DUAL_NSMU_CONTACTID,
170                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
171                         MT_QUIRK_SLOT_IS_CONTACTID,
172                 .maxcontacts = 2 },
173         { .name = MT_CLS_INRANGE_CONTACTNUMBER,
174                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
175                         MT_QUIRK_SLOT_IS_CONTACTNUMBER },
176
177         /*
178          * vendor specific classes
179          */
180         { .name = MT_CLS_3M,
181                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
182                         MT_QUIRK_SLOT_IS_CONTACTID,
183                 .sn_move = 2048,
184                 .sn_width = 128,
185                 .sn_height = 128 },
186         { .name = MT_CLS_CYPRESS,
187                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
188                         MT_QUIRK_CYPRESS,
189                 .maxcontacts = 10 },
190         { .name = MT_CLS_EGALAX,
191                 .quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
192                         MT_QUIRK_VALID_IS_INRANGE,
193                 .sn_move = 4096,
194                 .sn_pressure = 32,
195         },
196         { .name = MT_CLS_EGALAX_SERIAL,
197                 .quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
198                         MT_QUIRK_ALWAYS_VALID,
199                 .sn_move = 4096,
200                 .sn_pressure = 32,
201         },
202         { .name = MT_CLS_TOPSEED,
203                 .quirks = MT_QUIRK_ALWAYS_VALID,
204                 .is_indirect = true,
205                 .maxcontacts = 2,
206         },
207         { .name = MT_CLS_PANASONIC,
208                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP,
209                 .maxcontacts = 4 },
210
211         { }
212 };
213
214 static ssize_t mt_show_quirks(struct device *dev,
215                            struct device_attribute *attr,
216                            char *buf)
217 {
218         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
219         struct mt_device *td = hid_get_drvdata(hdev);
220
221         return sprintf(buf, "%u\n", td->mtclass.quirks);
222 }
223
224 static ssize_t mt_set_quirks(struct device *dev,
225                           struct device_attribute *attr,
226                           const char *buf, size_t count)
227 {
228         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
229         struct mt_device *td = hid_get_drvdata(hdev);
230
231         unsigned long val;
232
233         if (kstrtoul(buf, 0, &val))
234                 return -EINVAL;
235
236         td->mtclass.quirks = val;
237
238         return count;
239 }
240
241 static DEVICE_ATTR(quirks, S_IWUSR | S_IRUGO, mt_show_quirks, mt_set_quirks);
242
243 static struct attribute *sysfs_attrs[] = {
244         &dev_attr_quirks.attr,
245         NULL
246 };
247
248 static struct attribute_group mt_attribute_group = {
249         .attrs = sysfs_attrs
250 };
251
252 static void mt_feature_mapping(struct hid_device *hdev,
253                 struct hid_field *field, struct hid_usage *usage)
254 {
255         struct mt_device *td = hid_get_drvdata(hdev);
256
257         switch (usage->hid) {
258         case HID_DG_INPUTMODE:
259                 td->inputmode = field->report->id;
260                 break;
261         case HID_DG_CONTACTMAX:
262                 td->maxcontact_report_id = field->report->id;
263                 td->maxcontacts = field->value[0];
264                 if (td->mtclass.maxcontacts)
265                         /* check if the maxcontacts is given by the class */
266                         td->maxcontacts = td->mtclass.maxcontacts;
267
268                 break;
269         }
270 }
271
272 static void set_abs(struct input_dev *input, unsigned int code,
273                 struct hid_field *field, int snratio)
274 {
275         int fmin = field->logical_minimum;
276         int fmax = field->logical_maximum;
277         int fuzz = snratio ? (fmax - fmin) / snratio : 0;
278         input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
279 }
280
281 static void set_last_slot_field(struct hid_usage *usage, struct mt_device *td,
282                 struct hid_input *hi)
283 {
284         if (!test_bit(usage->hid, hi->input->absbit))
285                 td->last_slot_field = usage->hid;
286 }
287
288 static int mt_input_mapping(struct hid_device *hdev, struct hid_input *hi,
289                 struct hid_field *field, struct hid_usage *usage,
290                 unsigned long **bit, int *max)
291 {
292         struct mt_device *td = hid_get_drvdata(hdev);
293         struct mt_class *cls = &td->mtclass;
294         int code;
295
296         /* Only map fields from TouchScreen or TouchPad collections.
297         * We need to ignore fields that belong to other collections
298         * such as Mouse that might have the same GenericDesktop usages. */
299         if (field->application == HID_DG_TOUCHSCREEN)
300                 set_bit(INPUT_PROP_DIRECT, hi->input->propbit);
301         else if (field->application != HID_DG_TOUCHPAD)
302                 return 0;
303
304         /* In case of an indirect device (touchpad), we need to add
305          * specific BTN_TOOL_* to be handled by the synaptics xorg
306          * driver.
307          * We also consider that touchscreens providing buttons are touchpads.
308          */
309         if (field->application == HID_DG_TOUCHPAD ||
310             (usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON ||
311             cls->is_indirect) {
312                 set_bit(INPUT_PROP_POINTER, hi->input->propbit);
313                 set_bit(BTN_TOOL_FINGER, hi->input->keybit);
314                 set_bit(BTN_TOOL_DOUBLETAP, hi->input->keybit);
315                 set_bit(BTN_TOOL_TRIPLETAP, hi->input->keybit);
316                 set_bit(BTN_TOOL_QUADTAP, hi->input->keybit);
317         }
318
319         /* eGalax devices provide a Digitizer.Stylus input which overrides
320          * the correct Digitizers.Finger X/Y ranges.
321          * Let's just ignore this input. */
322         if (field->physical == HID_DG_STYLUS)
323                 return -1;
324
325         switch (usage->hid & HID_USAGE_PAGE) {
326
327         case HID_UP_GENDESK:
328                 switch (usage->hid) {
329                 case HID_GD_X:
330                         hid_map_usage(hi, usage, bit, max,
331                                         EV_ABS, ABS_MT_POSITION_X);
332                         set_abs(hi->input, ABS_MT_POSITION_X, field,
333                                 cls->sn_move);
334                         /* touchscreen emulation */
335                         set_abs(hi->input, ABS_X, field, cls->sn_move);
336                         set_last_slot_field(usage, td, hi);
337                         td->last_field_index = field->index;
338                         return 1;
339                 case HID_GD_Y:
340                         hid_map_usage(hi, usage, bit, max,
341                                         EV_ABS, ABS_MT_POSITION_Y);
342                         set_abs(hi->input, ABS_MT_POSITION_Y, field,
343                                 cls->sn_move);
344                         /* touchscreen emulation */
345                         set_abs(hi->input, ABS_Y, field, cls->sn_move);
346                         set_last_slot_field(usage, td, hi);
347                         td->last_field_index = field->index;
348                         return 1;
349                 }
350                 return 0;
351
352         case HID_UP_DIGITIZER:
353                 switch (usage->hid) {
354                 case HID_DG_INRANGE:
355                         set_last_slot_field(usage, td, hi);
356                         td->last_field_index = field->index;
357                         return 1;
358                 case HID_DG_CONFIDENCE:
359                         set_last_slot_field(usage, td, hi);
360                         td->last_field_index = field->index;
361                         return 1;
362                 case HID_DG_TIPSWITCH:
363                         hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_TOUCH);
364                         input_set_capability(hi->input, EV_KEY, BTN_TOUCH);
365                         set_last_slot_field(usage, td, hi);
366                         td->last_field_index = field->index;
367                         return 1;
368                 case HID_DG_CONTACTID:
369                         if (!td->maxcontacts)
370                                 td->maxcontacts = MT_DEFAULT_MAXCONTACT;
371                         input_mt_init_slots(hi->input, td->maxcontacts);
372                         td->last_slot_field = usage->hid;
373                         td->last_field_index = field->index;
374                         td->touches_by_report++;
375                         return 1;
376                 case HID_DG_WIDTH:
377                         hid_map_usage(hi, usage, bit, max,
378                                         EV_ABS, ABS_MT_TOUCH_MAJOR);
379                         set_abs(hi->input, ABS_MT_TOUCH_MAJOR, field,
380                                 cls->sn_width);
381                         set_last_slot_field(usage, td, hi);
382                         td->last_field_index = field->index;
383                         return 1;
384                 case HID_DG_HEIGHT:
385                         hid_map_usage(hi, usage, bit, max,
386                                         EV_ABS, ABS_MT_TOUCH_MINOR);
387                         set_abs(hi->input, ABS_MT_TOUCH_MINOR, field,
388                                 cls->sn_height);
389                         input_set_abs_params(hi->input,
390                                         ABS_MT_ORIENTATION, 0, 1, 0, 0);
391                         set_last_slot_field(usage, td, hi);
392                         td->last_field_index = field->index;
393                         return 1;
394                 case HID_DG_TIPPRESSURE:
395                         hid_map_usage(hi, usage, bit, max,
396                                         EV_ABS, ABS_MT_PRESSURE);
397                         set_abs(hi->input, ABS_MT_PRESSURE, field,
398                                 cls->sn_pressure);
399                         /* touchscreen emulation */
400                         set_abs(hi->input, ABS_PRESSURE, field,
401                                 cls->sn_pressure);
402                         set_last_slot_field(usage, td, hi);
403                         td->last_field_index = field->index;
404                         return 1;
405                 case HID_DG_CONTACTCOUNT:
406                         td->last_field_index = field->index;
407                         return 1;
408                 case HID_DG_CONTACTMAX:
409                         /* we don't set td->last_slot_field as contactcount and
410                          * contact max are global to the report */
411                         td->last_field_index = field->index;
412                         return -1;
413                 }
414                 case HID_DG_TOUCH:
415                         /* Legacy devices use TIPSWITCH and not TOUCH.
416                          * Let's just ignore this field. */
417                         return -1;
418                 /* let hid-input decide for the others */
419                 return 0;
420
421         case HID_UP_BUTTON:
422                 code = BTN_MOUSE + ((usage->hid - 1) & HID_USAGE);
423                 hid_map_usage(hi, usage, bit, max, EV_KEY, code);
424                 input_set_capability(hi->input, EV_KEY, code);
425                 return 1;
426
427         case 0xff000000:
428                 /* we do not want to map these: no input-oriented meaning */
429                 return -1;
430         }
431
432         return 0;
433 }
434
435 static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
436                 struct hid_field *field, struct hid_usage *usage,
437                 unsigned long **bit, int *max)
438 {
439         if (usage->type == EV_KEY || usage->type == EV_ABS)
440                 set_bit(usage->type, hi->input->evbit);
441
442         return -1;
443 }
444
445 static int mt_compute_slot(struct mt_device *td)
446 {
447         __s32 quirks = td->mtclass.quirks;
448
449         if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
450                 return td->curdata.contactid;
451
452         if (quirks & MT_QUIRK_CYPRESS)
453                 return cypress_compute_slot(td);
454
455         if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
456                 return td->num_received;
457
458         if (quirks & MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE)
459                 return td->curdata.contactid - 1;
460
461         return find_slot_from_contactid(td);
462 }
463
464 /*
465  * this function is called when a whole contact has been processed,
466  * so that it can assign it to a slot and store the data there
467  */
468 static void mt_complete_slot(struct mt_device *td)
469 {
470         td->curdata.seen_in_this_frame = true;
471         if (td->curvalid) {
472                 int slotnum = mt_compute_slot(td);
473
474                 if (slotnum >= 0 && slotnum < td->maxcontacts)
475                         td->slots[slotnum] = td->curdata;
476         }
477         td->num_received++;
478 }
479
480
481 /*
482  * this function is called when a whole packet has been received and processed,
483  * so that it can decide what to send to the input layer.
484  */
485 static void mt_emit_event(struct mt_device *td, struct input_dev *input)
486 {
487         int i;
488
489         for (i = 0; i < td->maxcontacts; ++i) {
490                 struct mt_slot *s = &(td->slots[i]);
491                 if ((td->mtclass.quirks & MT_QUIRK_NOT_SEEN_MEANS_UP) &&
492                         !s->seen_in_this_frame) {
493                         s->touch_state = false;
494                 }
495
496                 input_mt_slot(input, i);
497                 input_mt_report_slot_state(input, MT_TOOL_FINGER,
498                         s->touch_state);
499                 if (s->touch_state) {
500                         /* this finger is on the screen */
501                         int wide = (s->w > s->h);
502                         /* divided by two to match visual scale of touch */
503                         int major = max(s->w, s->h) >> 1;
504                         int minor = min(s->w, s->h) >> 1;
505
506                         input_event(input, EV_ABS, ABS_MT_POSITION_X, s->x);
507                         input_event(input, EV_ABS, ABS_MT_POSITION_Y, s->y);
508                         input_event(input, EV_ABS, ABS_MT_ORIENTATION, wide);
509                         input_event(input, EV_ABS, ABS_MT_PRESSURE, s->p);
510                         input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
511                         input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
512                 }
513                 s->seen_in_this_frame = false;
514
515         }
516
517         input_mt_report_pointer_emulation(input, true);
518         input_sync(input);
519         td->num_received = 0;
520 }
521
522
523
524 static int mt_event(struct hid_device *hid, struct hid_field *field,
525                                 struct hid_usage *usage, __s32 value)
526 {
527         struct mt_device *td = hid_get_drvdata(hid);
528         __s32 quirks = td->mtclass.quirks;
529
530         if (hid->claimed & HID_CLAIMED_INPUT && td->slots) {
531                 switch (usage->hid) {
532                 case HID_DG_INRANGE:
533                         if (quirks & MT_QUIRK_ALWAYS_VALID)
534                                 td->curvalid = true;
535                         else if (quirks & MT_QUIRK_VALID_IS_INRANGE)
536                                 td->curvalid = value;
537                         break;
538                 case HID_DG_TIPSWITCH:
539                         if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
540                                 td->curvalid = value;
541                         td->curdata.touch_state = value;
542                         break;
543                 case HID_DG_CONFIDENCE:
544                         if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
545                                 td->curvalid = value;
546                         break;
547                 case HID_DG_CONTACTID:
548                         td->curdata.contactid = value;
549                         break;
550                 case HID_DG_TIPPRESSURE:
551                         td->curdata.p = value;
552                         break;
553                 case HID_GD_X:
554                         td->curdata.x = value;
555                         break;
556                 case HID_GD_Y:
557                         td->curdata.y = value;
558                         break;
559                 case HID_DG_WIDTH:
560                         td->curdata.w = value;
561                         break;
562                 case HID_DG_HEIGHT:
563                         td->curdata.h = value;
564                         break;
565                 case HID_DG_CONTACTCOUNT:
566                         /*
567                          * Includes multi-packet support where subsequent
568                          * packets are sent with zero contactcount.
569                          */
570                         if (value)
571                                 td->num_expected = value;
572                         break;
573                 case HID_DG_TOUCH:
574                         /* do nothing */
575                         break;
576
577                 default:
578                         /* fallback to the generic hidinput handling */
579                         return 0;
580                 }
581
582                 if (usage->hid == td->last_slot_field)
583                         mt_complete_slot(td);
584
585                 if (field->index == td->last_field_index
586                         && td->num_received >= td->num_expected)
587                         mt_emit_event(td, field->hidinput->input);
588
589         }
590
591         /* we have handled the hidinput part, now remains hiddev */
592         if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
593                 hid->hiddev_hid_event(hid, field, usage, value);
594
595         return 1;
596 }
597
598 static void mt_set_input_mode(struct hid_device *hdev)
599 {
600         struct mt_device *td = hid_get_drvdata(hdev);
601         struct hid_report *r;
602         struct hid_report_enum *re;
603
604         if (td->inputmode < 0)
605                 return;
606
607         re = &(hdev->report_enum[HID_FEATURE_REPORT]);
608         r = re->report_id_hash[td->inputmode];
609         if (r) {
610                 r->field[0]->value[0] = 0x02;
611                 usbhid_submit_report(hdev, r, USB_DIR_OUT);
612         }
613 }
614
615 static void mt_set_maxcontacts(struct hid_device *hdev)
616 {
617         struct mt_device *td = hid_get_drvdata(hdev);
618         struct hid_report *r;
619         struct hid_report_enum *re;
620         int fieldmax, max;
621
622         if (td->maxcontact_report_id < 0)
623                 return;
624
625         if (!td->mtclass.maxcontacts)
626                 return;
627
628         re = &hdev->report_enum[HID_FEATURE_REPORT];
629         r = re->report_id_hash[td->maxcontact_report_id];
630         if (r) {
631                 max = td->mtclass.maxcontacts;
632                 fieldmax = r->field[0]->logical_maximum;
633                 max = min(fieldmax, max);
634                 if (r->field[0]->value[0] != max) {
635                         r->field[0]->value[0] = max;
636                         usbhid_submit_report(hdev, r, USB_DIR_OUT);
637                 }
638         }
639 }
640
641 static void mt_post_parse_default_settings(struct mt_device *td)
642 {
643         __s32 quirks = td->mtclass.quirks;
644
645         /* unknown serial device needs special quirks */
646         if (td->touches_by_report == 1) {
647                 quirks |= MT_QUIRK_ALWAYS_VALID;
648                 quirks &= ~MT_QUIRK_NOT_SEEN_MEANS_UP;
649                 quirks &= ~MT_QUIRK_VALID_IS_INRANGE;
650                 quirks &= ~MT_QUIRK_VALID_IS_CONFIDENCE;
651         }
652
653         td->mtclass.quirks = quirks;
654 }
655
656 static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
657 {
658         int ret, i;
659         struct mt_device *td;
660         struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */
661
662         if (id) {
663                 for (i = 0; mt_classes[i].name ; i++) {
664                         if (id->driver_data == mt_classes[i].name) {
665                                 mtclass = &(mt_classes[i]);
666                                 break;
667                         }
668                 }
669         }
670
671         /* This allows the driver to correctly support devices
672          * that emit events over several HID messages.
673          */
674         hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
675
676         td = kzalloc(sizeof(struct mt_device), GFP_KERNEL);
677         if (!td) {
678                 dev_err(&hdev->dev, "cannot allocate multitouch data\n");
679                 return -ENOMEM;
680         }
681         td->mtclass = *mtclass;
682         td->inputmode = -1;
683         td->maxcontact_report_id = -1;
684         hid_set_drvdata(hdev, td);
685
686         ret = hid_parse(hdev);
687         if (ret != 0)
688                 goto fail;
689
690         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
691         if (ret)
692                 goto fail;
693
694         if (id->vendor == HID_ANY_ID && id->product == HID_ANY_ID)
695                 mt_post_parse_default_settings(td);
696
697         td->slots = kzalloc(td->maxcontacts * sizeof(struct mt_slot),
698                                 GFP_KERNEL);
699         if (!td->slots) {
700                 dev_err(&hdev->dev, "cannot allocate multitouch slots\n");
701                 hid_hw_stop(hdev);
702                 ret = -ENOMEM;
703                 goto fail;
704         }
705
706         ret = sysfs_create_group(&hdev->dev.kobj, &mt_attribute_group);
707
708         mt_set_maxcontacts(hdev);
709         mt_set_input_mode(hdev);
710
711         return 0;
712
713 fail:
714         kfree(td);
715         return ret;
716 }
717
718 #ifdef CONFIG_PM
719 static int mt_reset_resume(struct hid_device *hdev)
720 {
721         mt_set_maxcontacts(hdev);
722         mt_set_input_mode(hdev);
723         return 0;
724 }
725 #endif
726
727 static void mt_remove(struct hid_device *hdev)
728 {
729         struct mt_device *td = hid_get_drvdata(hdev);
730         sysfs_remove_group(&hdev->dev.kobj, &mt_attribute_group);
731         hid_hw_stop(hdev);
732         kfree(td->slots);
733         kfree(td);
734         hid_set_drvdata(hdev, NULL);
735 }
736
737 static const struct hid_device_id mt_devices[] = {
738
739         /* 3M panels */
740         { .driver_data = MT_CLS_3M,
741                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
742                         USB_DEVICE_ID_3M1968) },
743         { .driver_data = MT_CLS_3M,
744                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
745                         USB_DEVICE_ID_3M2256) },
746         { .driver_data = MT_CLS_3M,
747                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
748                         USB_DEVICE_ID_3M3266) },
749
750         /* ActionStar panels */
751         { .driver_data = MT_CLS_DEFAULT,
752                 MT_USB_DEVICE(USB_VENDOR_ID_ACTIONSTAR,
753                         USB_DEVICE_ID_ACTIONSTAR_1011) },
754
755         /* Atmel panels */
756         { .driver_data = MT_CLS_SERIAL,
757                 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL,
758                         USB_DEVICE_ID_ATMEL_MULTITOUCH) },
759         { .driver_data = MT_CLS_SERIAL,
760                 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL,
761                         USB_DEVICE_ID_ATMEL_MXT_DIGITIZER) },
762
763         /* Cando panels */
764         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
765                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
766                         USB_DEVICE_ID_CANDO_MULTI_TOUCH) },
767         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
768                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
769                         USB_DEVICE_ID_CANDO_MULTI_TOUCH_10_1) },
770         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
771                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
772                         USB_DEVICE_ID_CANDO_MULTI_TOUCH_11_6) },
773         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
774                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
775                         USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6) },
776
777         /* Chunghwa Telecom touch panels */
778         {  .driver_data = MT_CLS_DEFAULT,
779                 MT_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT,
780                         USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH) },
781
782         /* CVTouch panels */
783         { .driver_data = MT_CLS_DEFAULT,
784                 MT_USB_DEVICE(USB_VENDOR_ID_CVTOUCH,
785                         USB_DEVICE_ID_CVTOUCH_SCREEN) },
786
787         /* Cypress panel */
788         { .driver_data = MT_CLS_CYPRESS,
789                 HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS,
790                         USB_DEVICE_ID_CYPRESS_TRUETOUCH) },
791
792         /* eGalax devices (resistive) */
793         { .driver_data = MT_CLS_EGALAX,
794                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
795                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D) },
796         { .driver_data = MT_CLS_EGALAX,
797                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
798                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E) },
799
800         /* eGalax devices (capacitive) */
801         { .driver_data = MT_CLS_EGALAX,
802                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
803                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C) },
804         { .driver_data = MT_CLS_EGALAX_SERIAL,
805                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
806                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7207) },
807         { .driver_data = MT_CLS_EGALAX_SERIAL,
808                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
809                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_725E) },
810         { .driver_data = MT_CLS_EGALAX_SERIAL,
811                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
812                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224) },
813         { .driver_data = MT_CLS_EGALAX_SERIAL,
814                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
815                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_722A) },
816         { .driver_data = MT_CLS_EGALAX,
817                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
818                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B) },
819         { .driver_data = MT_CLS_EGALAX_SERIAL,
820                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
821                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7262) },
822         { .driver_data = MT_CLS_EGALAX,
823                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
824                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1) },
825         { .driver_data = MT_CLS_EGALAX_SERIAL,
826                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
827                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72AA) },
828         { .driver_data = MT_CLS_EGALAX,
829                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
830                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA) },
831         { .driver_data = MT_CLS_EGALAX,
832                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
833                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302) },
834         { .driver_data = MT_CLS_EGALAX_SERIAL,
835                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
836                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7349) },
837         { .driver_data = MT_CLS_EGALAX_SERIAL,
838                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
839                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001) },
840
841         /* Elo TouchSystems IntelliTouch Plus panel */
842         { .driver_data = MT_CLS_DUAL_NSMU_CONTACTID,
843                 MT_USB_DEVICE(USB_VENDOR_ID_ELO,
844                         USB_DEVICE_ID_ELO_TS2515) },
845
846         /* GeneralTouch panel */
847         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
848                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
849                         USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
850
851         /* Gametel game controller */
852         { .driver_data = MT_CLS_DEFAULT,
853                 MT_BT_DEVICE(USB_VENDOR_ID_FRUCTEL,
854                         USB_DEVICE_ID_GAMETEL_MT_MODE) },
855
856         /* GoodTouch panels */
857         { .driver_data = MT_CLS_DEFAULT,
858                 MT_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH,
859                         USB_DEVICE_ID_GOODTOUCH_000f) },
860
861         /* Hanvon panels */
862         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
863                 MT_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT,
864                         USB_DEVICE_ID_HANVON_ALT_MULTITOUCH) },
865
866         /* Ideacom panel */
867         { .driver_data = MT_CLS_SERIAL,
868                 MT_USB_DEVICE(USB_VENDOR_ID_IDEACOM,
869                         USB_DEVICE_ID_IDEACOM_IDC6650) },
870         { .driver_data = MT_CLS_SERIAL,
871                 MT_USB_DEVICE(USB_VENDOR_ID_IDEACOM,
872                         USB_DEVICE_ID_IDEACOM_IDC6651) },
873
874         /* Ilitek dual touch panel */
875         {  .driver_data = MT_CLS_DEFAULT,
876                 MT_USB_DEVICE(USB_VENDOR_ID_ILITEK,
877                         USB_DEVICE_ID_ILITEK_MULTITOUCH) },
878
879         /* IRTOUCH panels */
880         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
881                 MT_USB_DEVICE(USB_VENDOR_ID_IRTOUCHSYSTEMS,
882                         USB_DEVICE_ID_IRTOUCH_INFRARED_USB) },
883
884         /* LG Display panels */
885         { .driver_data = MT_CLS_DEFAULT,
886                 MT_USB_DEVICE(USB_VENDOR_ID_LG,
887                         USB_DEVICE_ID_LG_MULTITOUCH) },
888
889         /* Lumio panels */
890         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
891                 MT_USB_DEVICE(USB_VENDOR_ID_LUMIO,
892                         USB_DEVICE_ID_CRYSTALTOUCH) },
893         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
894                 MT_USB_DEVICE(USB_VENDOR_ID_LUMIO,
895                         USB_DEVICE_ID_CRYSTALTOUCH_DUAL) },
896
897         /* MosArt panels */
898         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
899                 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
900                         USB_DEVICE_ID_ASUS_T91MT)},
901         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
902                 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
903                         USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO) },
904         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
905                 MT_USB_DEVICE(USB_VENDOR_ID_TURBOX,
906                         USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART) },
907
908         /* Panasonic panels */
909         { .driver_data = MT_CLS_PANASONIC,
910                 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
911                         USB_DEVICE_ID_PANABOARD_UBT780) },
912         { .driver_data = MT_CLS_PANASONIC,
913                 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
914                         USB_DEVICE_ID_PANABOARD_UBT880) },
915
916         /* PenMount panels */
917         { .driver_data = MT_CLS_CONFIDENCE,
918                 MT_USB_DEVICE(USB_VENDOR_ID_PENMOUNT,
919                         USB_DEVICE_ID_PENMOUNT_PCI) },
920
921         /* PixArt optical touch screen */
922         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
923                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
924                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN) },
925         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
926                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
927                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1) },
928         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
929                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
930                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2) },
931
932         /* PixCir-based panels */
933         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
934                 MT_USB_DEVICE(USB_VENDOR_ID_HANVON,
935                         USB_DEVICE_ID_HANVON_MULTITOUCH) },
936         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
937                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
938                         USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
939
940         /* Quanta-based panels */
941         { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
942                 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
943                         USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH) },
944         { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
945                 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
946                         USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001) },
947         { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
948                 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
949                         USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3008) },
950
951         /* Stantum panels */
952         { .driver_data = MT_CLS_CONFIDENCE,
953                 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM,
954                         USB_DEVICE_ID_MTP)},
955         { .driver_data = MT_CLS_CONFIDENCE,
956                 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM,
957                         USB_DEVICE_ID_MTP_STM)},
958         { .driver_data = MT_CLS_CONFIDENCE,
959                 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_SITRONIX,
960                         USB_DEVICE_ID_MTP_SITRONIX)},
961
962         /* TopSeed panels */
963         { .driver_data = MT_CLS_TOPSEED,
964                 MT_USB_DEVICE(USB_VENDOR_ID_TOPSEED2,
965                         USB_DEVICE_ID_TOPSEED2_PERIPAD_701) },
966
967         /* Touch International panels */
968         { .driver_data = MT_CLS_DEFAULT,
969                 MT_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL,
970                         USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH) },
971
972         /* Unitec panels */
973         { .driver_data = MT_CLS_DEFAULT,
974                 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
975                         USB_DEVICE_ID_UNITEC_USB_TOUCH_0709) },
976         { .driver_data = MT_CLS_DEFAULT,
977                 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
978                         USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19) },
979         /* XAT */
980         { .driver_data = MT_CLS_DEFAULT,
981                 MT_USB_DEVICE(USB_VENDOR_ID_XAT,
982                         USB_DEVICE_ID_XAT_CSR) },
983
984         /* Xiroku */
985         { .driver_data = MT_CLS_DEFAULT,
986                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
987                         USB_DEVICE_ID_XIROKU_SPX) },
988         { .driver_data = MT_CLS_DEFAULT,
989                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
990                         USB_DEVICE_ID_XIROKU_MPX) },
991         { .driver_data = MT_CLS_DEFAULT,
992                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
993                         USB_DEVICE_ID_XIROKU_CSR) },
994         { .driver_data = MT_CLS_DEFAULT,
995                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
996                         USB_DEVICE_ID_XIROKU_SPX1) },
997         { .driver_data = MT_CLS_DEFAULT,
998                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
999                         USB_DEVICE_ID_XIROKU_MPX1) },
1000         { .driver_data = MT_CLS_DEFAULT,
1001                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1002                         USB_DEVICE_ID_XIROKU_CSR1) },
1003         { .driver_data = MT_CLS_DEFAULT,
1004                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1005                         USB_DEVICE_ID_XIROKU_SPX2) },
1006         { .driver_data = MT_CLS_DEFAULT,
1007                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1008                         USB_DEVICE_ID_XIROKU_MPX2) },
1009         { .driver_data = MT_CLS_DEFAULT,
1010                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1011                         USB_DEVICE_ID_XIROKU_CSR2) },
1012
1013         /* Generic MT device */
1014         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH, HID_ANY_ID, HID_ANY_ID) },
1015         { }
1016 };
1017 MODULE_DEVICE_TABLE(hid, mt_devices);
1018
1019 static const struct hid_usage_id mt_grabbed_usages[] = {
1020         { HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
1021         { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
1022 };
1023
1024 static struct hid_driver mt_driver = {
1025         .name = "hid-multitouch",
1026         .id_table = mt_devices,
1027         .probe = mt_probe,
1028         .remove = mt_remove,
1029         .input_mapping = mt_input_mapping,
1030         .input_mapped = mt_input_mapped,
1031         .feature_mapping = mt_feature_mapping,
1032         .usage_table = mt_grabbed_usages,
1033         .event = mt_event,
1034 #ifdef CONFIG_PM
1035         .reset_resume = mt_reset_resume,
1036 #endif
1037 };
1038
1039 static int __init mt_init(void)
1040 {
1041         return hid_register_driver(&mt_driver);
1042 }
1043
1044 static void __exit mt_exit(void)
1045 {
1046         hid_unregister_driver(&mt_driver);
1047 }
1048
1049 module_init(mt_init);
1050 module_exit(mt_exit);