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