drivers/hid/hid-multitouch.c

   1 /*
   2  *  HID driver for multitouch panels
   3  *
   4  *  Copyright (c) 2010-2012 Stephane Chatty <chatty@enac.fr>
   5  *  Copyright (c) 2010-2013 Benjamin Tissoires <benjamin.tissoires@gmail.com>
   6  *  Copyright (c) 2010-2012 Ecole Nationale de l'Aviation Civile, France
   7  *  Copyright (c) 2012-2013 Red Hat, Inc
   8  *
   9  *  This code is partly based on hid-egalax.c:
  10  *
  11  *  Copyright (c) 2010 Stephane Chatty <chatty@enac.fr>
  12  *  Copyright (c) 2010 Henrik Rydberg <rydberg@euromail.se>
  13  *  Copyright (c) 2010 Canonical, Ltd.
  14  *
  15  *  This code is partly based on hid-3m-pct.c:
  16  *
  17  *  Copyright (c) 2009-2010 Stephane Chatty <chatty@enac.fr>
  18  *  Copyright (c) 2010      Henrik Rydberg <rydberg@euromail.se>
  19  *  Copyright (c) 2010      Canonical, Ltd.
  20  *
  21  */
  22
  23 /*
  24  * This program is free software; you can redistribute it and/or modify it
  25  * under the terms of the GNU General Public License as published by the Free
  26  * Software Foundation; either version 2 of the License, or (at your option)
  27  * any later version.
  28  */
  29
  30 /*
  31  * This driver is regularly tested thanks to the tool hid-test[1].
  32  * This tool relies on hid-replay[2] and a database of hid devices[3].
  33  * Please run these regression tests before patching this module so that
  34  * your patch won't break existing known devices.
  35  *
  36  * [1] https://github.com/bentiss/hid-test
  37  * [2] https://github.com/bentiss/hid-replay
  38  * [3] https://github.com/bentiss/hid-devices
  39  */
  40
  41 #include <linux/device.h>
  42 #include <linux/hid.h>
  43 #include <linux/module.h>
  44 #include <linux/slab.h>
  45 #include <linux/usb.h>
  46 #include <linux/input/mt.h>
  47 #include <linux/string.h>
  48
  49
  50 MODULE_AUTHOR("Stephane Chatty <chatty@enac.fr>");
  51 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
  52 MODULE_DESCRIPTION("HID multitouch panels");
  53 MODULE_LICENSE("GPL");
  54
  55 #include "hid-ids.h"
  56
  57 /* quirks to control the device */
  58 #define MT_QUIRK_NOT_SEEN_MEANS_UP      (1 << 0)
  59 #define MT_QUIRK_SLOT_IS_CONTACTID      (1 << 1)
  60 #define MT_QUIRK_CYPRESS                (1 << 2)
  61 #define MT_QUIRK_SLOT_IS_CONTACTNUMBER  (1 << 3)
  62 #define MT_QUIRK_ALWAYS_VALID           (1 << 4)
  63 #define MT_QUIRK_VALID_IS_INRANGE       (1 << 5)
  64 #define MT_QUIRK_VALID_IS_CONFIDENCE    (1 << 6)
  65 #define MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE    (1 << 8)
  66 #define MT_QUIRK_NO_AREA                (1 << 9)
  67 #define MT_QUIRK_IGNORE_DUPLICATES      (1 << 10)
  68 #define MT_QUIRK_HOVERING               (1 << 11)
  69 #define MT_QUIRK_CONTACT_CNT_ACCURATE   (1 << 12)
  70
  71 struct mt_slot {
  72         __s32 x, y, cx, cy, p, w, h;
  73         __s32 contactid;        /* the device ContactID assigned to this slot */
  74         bool touch_state;       /* is the touch valid? */
  75         bool inrange_state;     /* is the finger in proximity of the sensor? */
  76 };
  77
  78 struct mt_class {
  79         __s32 name;     /* MT_CLS */
  80         __s32 quirks;
  81         __s32 sn_move;  /* Signal/noise ratio for move events */
  82         __s32 sn_width; /* Signal/noise ratio for width events */
  83         __s32 sn_height;        /* Signal/noise ratio for height events */
  84         __s32 sn_pressure;      /* Signal/noise ratio for pressure events */
  85         __u8 maxcontacts;
  86         bool is_indirect;       /* true for touchpads */
  87 };
  88
  89 struct mt_fields {
  90         unsigned usages[HID_MAX_FIELDS];
  91         unsigned int length;
  92 };
  93
  94 struct mt_device {
  95         struct mt_slot curdata; /* placeholder of incoming data */
  96         struct mt_class mtclass;        /* our mt device class */
  97         struct mt_fields *fields;       /* temporary placeholder for storing the
  98                                            multitouch fields */
  99         int cc_index;   /* contact count field index in the report */
 100         int cc_value_index;     /* contact count value index in the field */
 101         unsigned last_slot_field;       /* the last field of a slot */
 102         unsigned mt_report_id;  /* the report ID of the multitouch device */
 103         unsigned pen_report_id; /* the report ID of the pen device */
 104         __s16 inputmode;        /* InputMode HID feature, -1 if non-existent */
 105         __s16 inputmode_index;  /* InputMode HID feature index in the report */
 106         __s16 maxcontact_report_id;     /* Maximum Contact Number HID feature,
 107                                    -1 if non-existent */
 108         __u8 num_received;      /* how many contacts we received */
 109         __u8 num_expected;      /* expected last contact index */
 110         __u8 maxcontacts;
 111         __u8 touches_by_report; /* how many touches are present in one report:
 112                                 * 1 means we should use a serial protocol
 113                                 * > 1 means hybrid (multitouch) protocol */
 114         bool serial_maybe;      /* need to check for serial protocol */
 115         bool curvalid;          /* is the current contact valid? */
 116         unsigned mt_flags;      /* flags to pass to input-mt */
 117 };
 118
 119 static void mt_post_parse_default_settings(struct mt_device *td);
 120 static void mt_post_parse(struct mt_device *td);
 121
 122 /* classes of device behavior */
 123 #define MT_CLS_DEFAULT                          0x0001
 124
 125 #define MT_CLS_SERIAL                           0x0002
 126 #define MT_CLS_CONFIDENCE                       0x0003
 127 #define MT_CLS_CONFIDENCE_CONTACT_ID            0x0004
 128 #define MT_CLS_CONFIDENCE_MINUS_ONE             0x0005
 129 #define MT_CLS_DUAL_INRANGE_CONTACTID           0x0006
 130 #define MT_CLS_DUAL_INRANGE_CONTACTNUMBER       0x0007
 131 #define MT_CLS_DUAL_NSMU_CONTACTID              0x0008
 132 #define MT_CLS_INRANGE_CONTACTNUMBER            0x0009
 133 #define MT_CLS_NSMU                             0x000a
 134 #define MT_CLS_DUAL_CONTACT_NUMBER              0x0010
 135 #define MT_CLS_DUAL_CONTACT_ID                  0x0011
 136 #define MT_CLS_WIN_8                            0x0012
 137
 138 /* vendor specific classes */
 139 #define MT_CLS_3M                               0x0101
 140 #define MT_CLS_CYPRESS                          0x0102
 141 #define MT_CLS_EGALAX                           0x0103
 142 #define MT_CLS_EGALAX_SERIAL                    0x0104
 143 #define MT_CLS_TOPSEED                          0x0105
 144 #define MT_CLS_PANASONIC                        0x0106
 145 #define MT_CLS_FLATFROG                         0x0107
 146 #define MT_CLS_GENERALTOUCH_TWOFINGERS          0x0108
 147 #define MT_CLS_GENERALTOUCH_PWT_TENFINGERS      0x0109
 148
 149 #define MT_DEFAULT_MAXCONTACT   10
 150 #define MT_MAX_MAXCONTACT       250
 151
 152 #define MT_USB_DEVICE(v, p)     HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH, v, p)
 153 #define MT_BT_DEVICE(v, p)      HID_DEVICE(BUS_BLUETOOTH, HID_GROUP_MULTITOUCH, v, p)
 154
 155 /*
 156  * these device-dependent functions determine what slot corresponds
 157  * to a valid contact that was just read.
 158  */
 159
 160 static int cypress_compute_slot(struct mt_device *td)
 161 {
 162         if (td->curdata.contactid != 0 || td->num_received == 0)
 163                 return td->curdata.contactid;
 164         else
 165                 return -1;
 166 }
 167
 168 static struct mt_class mt_classes[] = {
 169         { .name = MT_CLS_DEFAULT,
 170                 .quirks = MT_QUIRK_ALWAYS_VALID |
 171                         MT_QUIRK_CONTACT_CNT_ACCURATE },
 172         { .name = MT_CLS_NSMU,
 173                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP },
 174         { .name = MT_CLS_SERIAL,
 175                 .quirks = MT_QUIRK_ALWAYS_VALID},
 176         { .name = MT_CLS_CONFIDENCE,
 177                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE },
 178         { .name = MT_CLS_CONFIDENCE_CONTACT_ID,
 179                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
 180                         MT_QUIRK_SLOT_IS_CONTACTID },
 181         { .name = MT_CLS_CONFIDENCE_MINUS_ONE,
 182                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
 183                         MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE },
 184         { .name = MT_CLS_DUAL_INRANGE_CONTACTID,
 185                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
 186                         MT_QUIRK_SLOT_IS_CONTACTID,
 187                 .maxcontacts = 2 },
 188         { .name = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
 189                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
 190                         MT_QUIRK_SLOT_IS_CONTACTNUMBER,
 191                 .maxcontacts = 2 },
 192         { .name = MT_CLS_DUAL_NSMU_CONTACTID,
 193                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
 194                         MT_QUIRK_SLOT_IS_CONTACTID,
 195                 .maxcontacts = 2 },
 196         { .name = MT_CLS_INRANGE_CONTACTNUMBER,
 197                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
 198                         MT_QUIRK_SLOT_IS_CONTACTNUMBER },
 199         { .name = MT_CLS_DUAL_CONTACT_NUMBER,
 200                 .quirks = MT_QUIRK_ALWAYS_VALID |
 201                         MT_QUIRK_CONTACT_CNT_ACCURATE |
 202                         MT_QUIRK_SLOT_IS_CONTACTNUMBER,
 203                 .maxcontacts = 2 },
 204         { .name = MT_CLS_DUAL_CONTACT_ID,
 205                 .quirks = MT_QUIRK_ALWAYS_VALID |
 206                         MT_QUIRK_CONTACT_CNT_ACCURATE |
 207                         MT_QUIRK_SLOT_IS_CONTACTID,
 208                 .maxcontacts = 2 },
 209         { .name = MT_CLS_WIN_8,
 210                 .quirks = MT_QUIRK_ALWAYS_VALID |
 211                         MT_QUIRK_IGNORE_DUPLICATES |
 212                         MT_QUIRK_HOVERING |
 213                         MT_QUIRK_CONTACT_CNT_ACCURATE },
 214
 215         /*
 216          * vendor specific classes
 217          */
 218         { .name = MT_CLS_3M,
 219                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
 220                         MT_QUIRK_SLOT_IS_CONTACTID,
 221                 .sn_move = 2048,
 222                 .sn_width = 128,
 223                 .sn_height = 128,
 224                 .maxcontacts = 60,
 225         },
 226         { .name = MT_CLS_CYPRESS,
 227                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
 228                         MT_QUIRK_CYPRESS,
 229                 .maxcontacts = 10 },
 230         { .name = MT_CLS_EGALAX,
 231                 .quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
 232                         MT_QUIRK_VALID_IS_INRANGE,
 233                 .sn_move = 4096,
 234                 .sn_pressure = 32,
 235         },
 236         { .name = MT_CLS_EGALAX_SERIAL,
 237                 .quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
 238                         MT_QUIRK_ALWAYS_VALID,
 239                 .sn_move = 4096,
 240                 .sn_pressure = 32,
 241         },
 242         { .name = MT_CLS_TOPSEED,
 243                 .quirks = MT_QUIRK_ALWAYS_VALID,
 244                 .is_indirect = true,
 245                 .maxcontacts = 2,
 246         },
 247         { .name = MT_CLS_PANASONIC,
 248                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP,
 249                 .maxcontacts = 4 },
 250         { .name = MT_CLS_GENERALTOUCH_TWOFINGERS,
 251                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
 252                         MT_QUIRK_VALID_IS_INRANGE |
 253                         MT_QUIRK_SLOT_IS_CONTACTID,
 254                 .maxcontacts = 2
 255         },
 256         { .name = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
 257                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
 258                         MT_QUIRK_SLOT_IS_CONTACTID
 259         },
 260
 261         { .name = MT_CLS_FLATFROG,
 262                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
 263                         MT_QUIRK_NO_AREA,
 264                 .sn_move = 2048,
 265                 .maxcontacts = 40,
 266         },
 267         { }
 268 };
 269
 270 static ssize_t mt_show_quirks(struct device *dev,
 271                            struct device_attribute *attr,
 272                            char *buf)
 273 {
 274         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
 275         struct mt_device *td = hid_get_drvdata(hdev);
 276
 277         return sprintf(buf, "%u\n", td->mtclass.quirks);
 278 }
 279
 280 static ssize_t mt_set_quirks(struct device *dev,
 281                           struct device_attribute *attr,
 282                           const char *buf, size_t count)
 283 {
 284         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
 285         struct mt_device *td = hid_get_drvdata(hdev);
 286
 287         unsigned long val;
 288
 289         if (kstrtoul(buf, 0, &val))
 290                 return -EINVAL;
 291
 292         td->mtclass.quirks = val;
 293
 294         if (td->cc_index < 0)
 295                 td->mtclass.quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
 296
 297         return count;
 298 }
 299
 300 static DEVICE_ATTR(quirks, S_IWUSR | S_IRUGO, mt_show_quirks, mt_set_quirks);
 301
 302 static struct attribute *sysfs_attrs[] = {
 303         &dev_attr_quirks.attr,
 304         NULL
 305 };
 306
 307 static struct attribute_group mt_attribute_group = {
 308         .attrs = sysfs_attrs
 309 };
 310
 311 static void mt_feature_mapping(struct hid_device *hdev,
 312                 struct hid_field *field, struct hid_usage *usage)
 313 {
 314         struct mt_device *td = hid_get_drvdata(hdev);
 315
 316         switch (usage->hid) {
 317         case HID_DG_INPUTMODE:
 318                 /* Ignore if value index is out of bounds. */
 319                 if (usage->usage_index >= field->report_count) {
 320                         dev_err(&hdev->dev, "HID_DG_INPUTMODE out of range\n");
 321                         break;
 322                 }
 323
 324                 td->inputmode = field->report->id;
 325                 td->inputmode_index = usage->usage_index;
 326
 327                 break;
 328         case HID_DG_CONTACTMAX:
 329                 td->maxcontact_report_id = field->report->id;
 330                 td->maxcontacts = field->value[0];
 331                 if (!td->maxcontacts &&
 332                     field->logical_maximum <= MT_MAX_MAXCONTACT)
 333                         td->maxcontacts = field->logical_maximum;
 334                 if (td->mtclass.maxcontacts)
 335                         /* check if the maxcontacts is given by the class */
 336                         td->maxcontacts = td->mtclass.maxcontacts;
 337
 338                 break;
 339         }
 340 }
 341
 342 static void set_abs(struct input_dev *input, unsigned int code,
 343                 struct hid_field *field, int snratio)
 344 {
 345         int fmin = field->logical_minimum;
 346         int fmax = field->logical_maximum;
 347         int fuzz = snratio ? (fmax - fmin) / snratio : 0;
 348         input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
 349         input_abs_set_res(input, code, hidinput_calc_abs_res(field, code));
 350 }
 351
 352 static void mt_store_field(struct hid_usage *usage, struct mt_device *td,
 353                 struct hid_input *hi)
 354 {
 355         struct mt_fields *f = td->fields;
 356
 357         if (f->length >= HID_MAX_FIELDS)
 358                 return;
 359
 360         f->usages[f->length++] = usage->hid;
 361 }
 362
 363 static int mt_pen_input_mapping(struct hid_device *hdev, struct hid_input *hi,
 364                 struct hid_field *field, struct hid_usage *usage,
 365                 unsigned long **bit, int *max)
 366 {
 367         struct mt_device *td = hid_get_drvdata(hdev);
 368
 369         td->pen_report_id = field->report->id;
 370
 371         return 0;
 372 }
 373
 374 static int mt_pen_input_mapped(struct hid_device *hdev, struct hid_input *hi,
 375                 struct hid_field *field, struct hid_usage *usage,
 376                 unsigned long **bit, int *max)
 377 {
 378         return 0;
 379 }
 380
 381 static int mt_pen_event(struct hid_device *hid, struct hid_field *field,
 382                                 struct hid_usage *usage, __s32 value)
 383 {
 384         /* let hid-input handle it */
 385         return 0;
 386 }
 387
 388 static void mt_pen_report(struct hid_device *hid, struct hid_report *report)
 389 {
 390         struct hid_field *field = report->field[0];
 391
 392         input_sync(field->hidinput->input);
 393 }
 394
 395 static void mt_pen_input_configured(struct hid_device *hdev,
 396                                         struct hid_input *hi)
 397 {
 398         /* force BTN_STYLUS to allow tablet matching in udev */
 399         __set_bit(BTN_STYLUS, hi->input->keybit);
 400 }
 401
 402 static int mt_touch_input_mapping(struct hid_device *hdev, struct hid_input *hi,
 403                 struct hid_field *field, struct hid_usage *usage,
 404                 unsigned long **bit, int *max)
 405 {
 406         struct mt_device *td = hid_get_drvdata(hdev);
 407         struct mt_class *cls = &td->mtclass;
 408         int code;
 409         struct hid_usage *prev_usage = NULL;
 410
 411         if (field->application == HID_DG_TOUCHSCREEN)
 412                 td->mt_flags |= INPUT_MT_DIRECT;
 413
 414         /*
 415          * Model touchscreens providing buttons as touchpads.
 416          */
 417         if (field->application == HID_DG_TOUCHPAD ||
 418             (usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON)
 419                 td->mt_flags |= INPUT_MT_POINTER;
 420
 421         if (usage->usage_index)
 422                 prev_usage = &field->usage[usage->usage_index - 1];
 423
 424         switch (usage->hid & HID_USAGE_PAGE) {
 425
 426         case HID_UP_GENDESK:
 427                 switch (usage->hid) {
 428                 case HID_GD_X:
 429                         if (prev_usage && (prev_usage->hid == usage->hid)) {
 430                                 hid_map_usage(hi, usage, bit, max,
 431                                         EV_ABS, ABS_MT_TOOL_X);
 432                                 set_abs(hi->input, ABS_MT_TOOL_X, field,
 433                                         cls->sn_move);
 434                         } else {
 435                                 hid_map_usage(hi, usage, bit, max,
 436                                         EV_ABS, ABS_MT_POSITION_X);
 437                                 set_abs(hi->input, ABS_MT_POSITION_X, field,
 438                                         cls->sn_move);
 439                         }
 440
 441                         mt_store_field(usage, td, hi);
 442                         return 1;
 443                 case HID_GD_Y:
 444                         if (prev_usage && (prev_usage->hid == usage->hid)) {
 445                                 hid_map_usage(hi, usage, bit, max,
 446                                         EV_ABS, ABS_MT_TOOL_Y);
 447                                 set_abs(hi->input, ABS_MT_TOOL_Y, field,
 448                                         cls->sn_move);
 449                         } else {
 450                                 hid_map_usage(hi, usage, bit, max,
 451                                         EV_ABS, ABS_MT_POSITION_Y);
 452                                 set_abs(hi->input, ABS_MT_POSITION_Y, field,
 453                                         cls->sn_move);
 454                         }
 455
 456                         mt_store_field(usage, td, hi);
 457                         return 1;
 458                 }
 459                 return 0;
 460
 461         case HID_UP_DIGITIZER:
 462                 switch (usage->hid) {
 463                 case HID_DG_INRANGE:
 464                         if (cls->quirks & MT_QUIRK_HOVERING) {
 465                                 hid_map_usage(hi, usage, bit, max,
 466                                         EV_ABS, ABS_MT_DISTANCE);
 467                                 input_set_abs_params(hi->input,
 468                                         ABS_MT_DISTANCE, 0, 1, 0, 0);
 469                         }
 470                         mt_store_field(usage, td, hi);
 471                         return 1;
 472                 case HID_DG_CONFIDENCE:
 473                         mt_store_field(usage, td, hi);
 474                         return 1;
 475                 case HID_DG_TIPSWITCH:
 476                         hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_TOUCH);
 477                         input_set_capability(hi->input, EV_KEY, BTN_TOUCH);
 478                         mt_store_field(usage, td, hi);
 479                         return 1;
 480                 case HID_DG_CONTACTID:
 481                         mt_store_field(usage, td, hi);
 482                         td->touches_by_report++;
 483                         td->mt_report_id = field->report->id;
 484                         return 1;
 485                 case HID_DG_WIDTH:
 486                         hid_map_usage(hi, usage, bit, max,
 487                                         EV_ABS, ABS_MT_TOUCH_MAJOR);
 488                         if (!(cls->quirks & MT_QUIRK_NO_AREA))
 489                                 set_abs(hi->input, ABS_MT_TOUCH_MAJOR, field,
 490                                         cls->sn_width);
 491                         mt_store_field(usage, td, hi);
 492                         return 1;
 493                 case HID_DG_HEIGHT:
 494                         hid_map_usage(hi, usage, bit, max,
 495                                         EV_ABS, ABS_MT_TOUCH_MINOR);
 496                         if (!(cls->quirks & MT_QUIRK_NO_AREA)) {
 497                                 set_abs(hi->input, ABS_MT_TOUCH_MINOR, field,
 498                                         cls->sn_height);
 499                                 input_set_abs_params(hi->input,
 500                                         ABS_MT_ORIENTATION, 0, 1, 0, 0);
 501                         }
 502                         mt_store_field(usage, td, hi);
 503                         return 1;
 504                 case HID_DG_TIPPRESSURE:
 505                         hid_map_usage(hi, usage, bit, max,
 506                                         EV_ABS, ABS_MT_PRESSURE);
 507                         set_abs(hi->input, ABS_MT_PRESSURE, field,
 508                                 cls->sn_pressure);
 509                         mt_store_field(usage, td, hi);
 510                         return 1;
 511                 case HID_DG_CONTACTCOUNT:
 512                         /* Ignore if indexes are out of bounds. */
 513                         if (field->index >= field->report->maxfield ||
 514                             usage->usage_index >= field->report_count)
 515                                 return 1;
 516                         td->cc_index = field->index;
 517                         td->cc_value_index = usage->usage_index;
 518                         return 1;
 519                 case HID_DG_CONTACTMAX:
 520                         /* we don't set td->last_slot_field as contactcount and
 521                          * contact max are global to the report */
 522                         return -1;
 523                 case HID_DG_TOUCH:
 524                         /* Legacy devices use TIPSWITCH and not TOUCH.
 525                          * Let's just ignore this field. */
 526                         return -1;
 527                 }
 528                 /* let hid-input decide for the others */
 529                 return 0;
 530
 531         case HID_UP_BUTTON:
 532                 code = BTN_MOUSE + ((usage->hid - 1) & HID_USAGE);
 533                 hid_map_usage(hi, usage, bit, max, EV_KEY, code);
 534                 input_set_capability(hi->input, EV_KEY, code);
 535                 return 1;
 536
 537         case 0xff000000:
 538                 /* we do not want to map these: no input-oriented meaning */
 539                 return -1;
 540         }
 541
 542         return 0;
 543 }
 544
 545 static int mt_touch_input_mapped(struct hid_device *hdev, struct hid_input *hi,
 546                 struct hid_field *field, struct hid_usage *usage,
 547                 unsigned long **bit, int *max)
 548 {
 549         if (usage->type == EV_KEY || usage->type == EV_ABS)
 550                 set_bit(usage->type, hi->input->evbit);
 551
 552         return -1;
 553 }
 554
 555 static int mt_compute_slot(struct mt_device *td, struct input_dev *input)
 556 {
 557         __s32 quirks = td->mtclass.quirks;
 558
 559         if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
 560                 return td->curdata.contactid;
 561
 562         if (quirks & MT_QUIRK_CYPRESS)
 563                 return cypress_compute_slot(td);
 564
 565         if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
 566                 return td->num_received;
 567
 568         if (quirks & MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE)
 569                 return td->curdata.contactid - 1;
 570
 571         return input_mt_get_slot_by_key(input, td->curdata.contactid);
 572 }
 573
 574 /*
 575  * this function is called when a whole contact has been processed,
 576  * so that it can assign it to a slot and store the data there
 577  */
 578 static void mt_complete_slot(struct mt_device *td, struct input_dev *input)
 579 {
 580         if ((td->mtclass.quirks & MT_QUIRK_CONTACT_CNT_ACCURATE) &&
 581             td->num_received >= td->num_expected)
 582                 return;
 583
 584         if (td->curvalid || (td->mtclass.quirks & MT_QUIRK_ALWAYS_VALID)) {
 585                 int slotnum = mt_compute_slot(td, input);
 586                 struct mt_slot *s = &td->curdata;
 587                 struct input_mt *mt = input->mt;
 588
 589                 if (slotnum < 0 || slotnum >= td->maxcontacts)
 590                         return;
 591
 592                 if ((td->mtclass.quirks & MT_QUIRK_IGNORE_DUPLICATES) && mt) {
 593                         struct input_mt_slot *slot = &mt->slots[slotnum];
 594                         if (input_mt_is_active(slot) &&
 595                             input_mt_is_used(mt, slot))
 596                                 return;
 597                 }
 598
 599                 input_mt_slot(input, slotnum);
 600                 input_mt_report_slot_state(input, MT_TOOL_FINGER,
 601                         s->touch_state || s->inrange_state);
 602                 if (s->touch_state || s->inrange_state) {
 603                         /* this finger is in proximity of the sensor */
 604                         int wide = (s->w > s->h);
 605                         /* divided by two to match visual scale of touch */
 606                         int major = max(s->w, s->h) >> 1;
 607                         int minor = min(s->w, s->h) >> 1;
 608
 609                         input_event(input, EV_ABS, ABS_MT_POSITION_X, s->x);
 610                         input_event(input, EV_ABS, ABS_MT_POSITION_Y, s->y);
 611                         input_event(input, EV_ABS, ABS_MT_TOOL_X, s->cx);
 612                         input_event(input, EV_ABS, ABS_MT_TOOL_Y, s->cy);
 613                         input_event(input, EV_ABS, ABS_MT_DISTANCE,
 614                                 !s->touch_state);
 615                         input_event(input, EV_ABS, ABS_MT_ORIENTATION, wide);
 616                         input_event(input, EV_ABS, ABS_MT_PRESSURE, s->p);
 617                         input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
 618                         input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
 619                 }
 620         }
 621
 622         td->num_received++;
 623 }
 624
 625 /*
 626  * this function is called when a whole packet has been received and processed,
 627  * so that it can decide what to send to the input layer.
 628  */
 629 static void mt_sync_frame(struct mt_device *td, struct input_dev *input)
 630 {
 631         input_mt_sync_frame(input);
 632         input_sync(input);
 633         td->num_received = 0;
 634 }
 635
 636 static int mt_touch_event(struct hid_device *hid, struct hid_field *field,
 637                                 struct hid_usage *usage, __s32 value)
 638 {
 639         /* we will handle the hidinput part later, now remains hiddev */
 640         if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
 641                 hid->hiddev_hid_event(hid, field, usage, value);
 642
 643         return 1;
 644 }
 645
 646 static void mt_process_mt_event(struct hid_device *hid, struct hid_field *field,
 647                                 struct hid_usage *usage, __s32 value)
 648 {
 649         struct mt_device *td = hid_get_drvdata(hid);
 650         __s32 quirks = td->mtclass.quirks;
 651         struct input_dev *input = field->hidinput->input;
 652
 653         if (hid->claimed & HID_CLAIMED_INPUT) {
 654                 switch (usage->hid) {
 655                 case HID_DG_INRANGE:
 656                         if (quirks & MT_QUIRK_VALID_IS_INRANGE)
 657                                 td->curvalid = value;
 658                         if (quirks & MT_QUIRK_HOVERING)
 659                                 td->curdata.inrange_state = value;
 660                         break;
 661                 case HID_DG_TIPSWITCH:
 662                         if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
 663                                 td->curvalid = value;
 664                         td->curdata.touch_state = value;
 665                         break;
 666                 case HID_DG_CONFIDENCE:
 667                         if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
 668                                 td->curvalid = value;
 669                         break;
 670                 case HID_DG_CONTACTID:
 671                         td->curdata.contactid = value;
 672                         break;
 673                 case HID_DG_TIPPRESSURE:
 674                         td->curdata.p = value;
 675                         break;
 676                 case HID_GD_X:
 677                         if (usage->code == ABS_MT_TOOL_X)
 678                                 td->curdata.cx = value;
 679                         else
 680                                 td->curdata.x = value;
 681                         break;
 682                 case HID_GD_Y:
 683                         if (usage->code == ABS_MT_TOOL_Y)
 684                                 td->curdata.cy = value;
 685                         else
 686                                 td->curdata.y = value;
 687                         break;
 688                 case HID_DG_WIDTH:
 689                         td->curdata.w = value;
 690                         break;
 691                 case HID_DG_HEIGHT:
 692                         td->curdata.h = value;
 693                         break;
 694                 case HID_DG_CONTACTCOUNT:
 695                         break;
 696                 case HID_DG_TOUCH:
 697                         /* do nothing */
 698                         break;
 699
 700                 default:
 701                         if (usage->type)
 702                                 input_event(input, usage->type, usage->code,
 703                                                 value);
 704                         return;
 705                 }
 706
 707                 if (usage->usage_index + 1 == field->report_count) {
 708                         /* we only take into account the last report. */
 709                         if (usage->hid == td->last_slot_field)
 710                                 mt_complete_slot(td, field->hidinput->input);
 711                 }
 712
 713         }
 714 }
 715
 716 static void mt_touch_report(struct hid_device *hid, struct hid_report *report)
 717 {
 718         struct mt_device *td = hid_get_drvdata(hid);
 719         struct hid_field *field;
 720         unsigned count;
 721         int r, n;
 722
 723         /*
 724          * Includes multi-packet support where subsequent
 725          * packets are sent with zero contactcount.
 726          */
 727         if (td->cc_index >= 0) {
 728                 struct hid_field *field = report->field[td->cc_index];
 729                 int value = field->value[td->cc_value_index];
 730                 if (value)
 731                         td->num_expected = value;
 732         }
 733
 734         for (r = 0; r < report->maxfield; r++) {
 735                 field = report->field[r];
 736                 count = field->report_count;
 737
 738                 if (!(HID_MAIN_ITEM_VARIABLE & field->flags))
 739                         continue;
 740
 741                 for (n = 0; n < count; n++)
 742                         mt_process_mt_event(hid, field, &field->usage[n],
 743                                         field->value[n]);
 744         }
 745
 746         if (td->num_received >= td->num_expected)
 747                 mt_sync_frame(td, report->field[0]->hidinput->input);
 748 }
 749
 750 static void mt_touch_input_configured(struct hid_device *hdev,
 751                                         struct hid_input *hi)
 752 {
 753         struct mt_device *td = hid_get_drvdata(hdev);
 754         struct mt_class *cls = &td->mtclass;
 755         struct input_dev *input = hi->input;
 756
 757         if (!td->maxcontacts)
 758                 td->maxcontacts = MT_DEFAULT_MAXCONTACT;
 759
 760         mt_post_parse(td);
 761         if (td->serial_maybe)
 762                 mt_post_parse_default_settings(td);
 763
 764         if (cls->is_indirect)
 765                 td->mt_flags |= INPUT_MT_POINTER;
 766
 767         if (cls->quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
 768                 td->mt_flags |= INPUT_MT_DROP_UNUSED;
 769
 770         input_mt_init_slots(input, td->maxcontacts, td->mt_flags);
 771
 772         td->mt_flags = 0;
 773 }
 774
 775 static int mt_input_mapping(struct hid_device *hdev, struct hid_input *hi,
 776                 struct hid_field *field, struct hid_usage *usage,
 777                 unsigned long **bit, int *max)
 778 {
 779         /* Only map fields from TouchScreen or TouchPad collections.
 780         * We need to ignore fields that belong to other collections
 781         * such as Mouse that might have the same GenericDesktop usages. */
 782         if (field->application != HID_DG_TOUCHSCREEN &&
 783             field->application != HID_DG_PEN &&
 784             field->application != HID_DG_TOUCHPAD)
 785                 return -1;
 786
 787         if (field->physical == HID_DG_STYLUS)
 788                 return mt_pen_input_mapping(hdev, hi, field, usage, bit, max);
 789
 790         return mt_touch_input_mapping(hdev, hi, field, usage, bit, max);
 791 }
 792
 793 static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
 794                 struct hid_field *field, struct hid_usage *usage,
 795                 unsigned long **bit, int *max)
 796 {
 797         if (field->physical == HID_DG_STYLUS)
 798                 return mt_pen_input_mapped(hdev, hi, field, usage, bit, max);
 799
 800         return mt_touch_input_mapped(hdev, hi, field, usage, bit, max);
 801 }
 802
 803 static int mt_event(struct hid_device *hid, struct hid_field *field,
 804                                 struct hid_usage *usage, __s32 value)
 805 {
 806         struct mt_device *td = hid_get_drvdata(hid);
 807
 808         if (field->report->id == td->mt_report_id)
 809                 return mt_touch_event(hid, field, usage, value);
 810
 811         if (field->report->id == td->pen_report_id)
 812                 return mt_pen_event(hid, field, usage, value);
 813
 814         /* ignore other reports */
 815         return 1;
 816 }
 817
 818 static void mt_report(struct hid_device *hid, struct hid_report *report)
 819 {
 820         struct mt_device *td = hid_get_drvdata(hid);
 821
 822         if (!(hid->claimed & HID_CLAIMED_INPUT))
 823                 return;
 824
 825         if (report->id == td->mt_report_id)
 826                 mt_touch_report(hid, report);
 827
 828         if (report->id == td->pen_report_id)
 829                 mt_pen_report(hid, report);
 830 }
 831
 832 static void mt_set_input_mode(struct hid_device *hdev)
 833 {
 834         struct mt_device *td = hid_get_drvdata(hdev);
 835         struct hid_report *r;
 836         struct hid_report_enum *re;
 837
 838         if (td->inputmode < 0)
 839                 return;
 840
 841         re = &(hdev->report_enum[HID_FEATURE_REPORT]);
 842         r = re->report_id_hash[td->inputmode];
 843         if (r) {
 844                 r->field[0]->value[td->inputmode_index] = 0x02;
 845                 hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
 846         }
 847 }
 848
 849 static void mt_set_maxcontacts(struct hid_device *hdev)
 850 {
 851         struct mt_device *td = hid_get_drvdata(hdev);
 852         struct hid_report *r;
 853         struct hid_report_enum *re;
 854         int fieldmax, max;
 855
 856         if (td->maxcontact_report_id < 0)
 857                 return;
 858
 859         if (!td->mtclass.maxcontacts)
 860                 return;
 861
 862         re = &hdev->report_enum[HID_FEATURE_REPORT];
 863         r = re->report_id_hash[td->maxcontact_report_id];
 864         if (r) {
 865                 max = td->mtclass.maxcontacts;
 866                 fieldmax = r->field[0]->logical_maximum;
 867                 max = min(fieldmax, max);
 868                 if (r->field[0]->value[0] != max) {
 869                         r->field[0]->value[0] = max;
 870                         hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
 871                 }
 872         }
 873 }
 874
 875 static void mt_post_parse_default_settings(struct mt_device *td)
 876 {
 877         __s32 quirks = td->mtclass.quirks;
 878
 879         /* unknown serial device needs special quirks */
 880         if (td->touches_by_report == 1) {
 881                 quirks |= MT_QUIRK_ALWAYS_VALID;
 882                 quirks &= ~MT_QUIRK_NOT_SEEN_MEANS_UP;
 883                 quirks &= ~MT_QUIRK_VALID_IS_INRANGE;
 884                 quirks &= ~MT_QUIRK_VALID_IS_CONFIDENCE;
 885                 quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
 886         }
 887
 888         td->mtclass.quirks = quirks;
 889 }
 890
 891 static void mt_post_parse(struct mt_device *td)
 892 {
 893         struct mt_fields *f = td->fields;
 894         struct mt_class *cls = &td->mtclass;
 895
 896         if (td->touches_by_report > 0) {
 897                 int field_count_per_touch = f->length / td->touches_by_report;
 898                 td->last_slot_field = f->usages[field_count_per_touch - 1];
 899         }
 900
 901         if (td->cc_index < 0)
 902                 cls->quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
 903 }
 904
 905 static void mt_input_configured(struct hid_device *hdev, struct hid_input *hi)
 906 {
 907         struct mt_device *td = hid_get_drvdata(hdev);
 908         char *name;
 909         const char *suffix = NULL;
 910
 911         if (hi->report->id == td->mt_report_id)
 912                 mt_touch_input_configured(hdev, hi);
 913
 914         if (hi->report->field[0]->physical == HID_DG_STYLUS) {
 915                 suffix = "Pen";
 916                 mt_pen_input_configured(hdev, hi);
 917         }
 918
 919         if (suffix) {
 920                 name = devm_kzalloc(&hi->input->dev,
 921                                     strlen(hdev->name) + strlen(suffix) + 2,
 922                                     GFP_KERNEL);
 923                 if (name) {
 924                         sprintf(name, "%s %s", hdev->name, suffix);
 925                         hi->input->name = name;
 926                 }
 927         }
 928 }
 929
 930 static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
 931 {
 932         int ret, i;
 933         struct mt_device *td;
 934         struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */
 935
 936         for (i = 0; mt_classes[i].name ; i++) {
 937                 if (id->driver_data == mt_classes[i].name) {
 938                         mtclass = &(mt_classes[i]);
 939                         break;
 940                 }
 941         }
 942
 943         /* This allows the driver to correctly support devices
 944          * that emit events over several HID messages.
 945          */
 946         hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
 947
 948         /*
 949          * This allows the driver to handle different input sensors
 950          * that emits events through different reports on the same HID
 951          * device.
 952          */
 953         hdev->quirks |= HID_QUIRK_MULTI_INPUT;
 954         hdev->quirks |= HID_QUIRK_NO_EMPTY_INPUT;
 955
 956         /*
 957          * Handle special quirks for Windows 8 certified devices.
 958          */
 959         if (id->group == HID_GROUP_MULTITOUCH_WIN_8)
 960                 /*
 961                  * Some multitouch screens do not like to be polled for input
 962                  * reports. Fortunately, the Win8 spec says that all touches
 963                  * should be sent during each report, making the initialization
 964                  * of input reports unnecessary.
 965                  */
 966                 hdev->quirks |= HID_QUIRK_NO_INIT_INPUT_REPORTS;
 967
 968         td = devm_kzalloc(&hdev->dev, sizeof(struct mt_device), GFP_KERNEL);
 969         if (!td) {
 970                 dev_err(&hdev->dev, "cannot allocate multitouch data\n");
 971                 return -ENOMEM;
 972         }
 973         td->mtclass = *mtclass;
 974         td->inputmode = -1;
 975         td->maxcontact_report_id = -1;
 976         td->cc_index = -1;
 977         td->mt_report_id = -1;
 978         td->pen_report_id = -1;
 979         hid_set_drvdata(hdev, td);
 980
 981         td->fields = devm_kzalloc(&hdev->dev, sizeof(struct mt_fields),
 982                                   GFP_KERNEL);
 983         if (!td->fields) {
 984                 dev_err(&hdev->dev, "cannot allocate multitouch fields data\n");
 985                 return -ENOMEM;
 986         }
 987
 988         if (id->vendor == HID_ANY_ID && id->product == HID_ANY_ID)
 989                 td->serial_maybe = true;
 990
 991         ret = hid_parse(hdev);
 992         if (ret != 0)
 993                 return ret;
 994
 995         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
 996         if (ret)
 997                 return ret;
 998
 999         ret = sysfs_create_group(&hdev->dev.kobj, &mt_attribute_group);
1000
1001         mt_set_maxcontacts(hdev);
1002         mt_set_input_mode(hdev);
1003
1004         /* release .fields memory as it is not used anymore */
1005         devm_kfree(&hdev->dev, td->fields);
1006         td->fields = NULL;
1007
1008         return 0;
1009 }
1010
1011 #ifdef CONFIG_PM
1012 static int mt_reset_resume(struct hid_device *hdev)
1013 {
1014         mt_set_maxcontacts(hdev);
1015         mt_set_input_mode(hdev);
1016         return 0;
1017 }
1018
1019 static int mt_resume(struct hid_device *hdev)
1020 {
1021         /* Some Elan legacy devices require SET_IDLE to be set on resume.
1022          * It should be safe to send it to other devices too.
1023          * Tested on 3M, Stantum, Cypress, Zytronic, eGalax, and Elan panels. */
1024
1025         hid_hw_idle(hdev, 0, 0, HID_REQ_SET_IDLE);
1026
1027         return 0;
1028 }
1029 #endif
1030
1031 static void mt_remove(struct hid_device *hdev)
1032 {
1033         sysfs_remove_group(&hdev->dev.kobj, &mt_attribute_group);
1034         hid_hw_stop(hdev);
1035 }
1036
1037 static const struct hid_device_id mt_devices[] = {
1038
1039         /* 3M panels */
1040         { .driver_data = MT_CLS_3M,
1041                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1042                         USB_DEVICE_ID_3M1968) },
1043         { .driver_data = MT_CLS_3M,
1044                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1045                         USB_DEVICE_ID_3M2256) },
1046         { .driver_data = MT_CLS_3M,
1047                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1048                         USB_DEVICE_ID_3M3266) },
1049
1050         /* ActionStar panels */
1051         { .driver_data = MT_CLS_NSMU,
1052                 MT_USB_DEVICE(USB_VENDOR_ID_ACTIONSTAR,
1053                         USB_DEVICE_ID_ACTIONSTAR_1011) },
1054
1055         /* Atmel panels */
1056         { .driver_data = MT_CLS_SERIAL,
1057                 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL,
1058                         USB_DEVICE_ID_ATMEL_MULTITOUCH) },
1059         { .driver_data = MT_CLS_SERIAL,
1060                 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL,
1061                         USB_DEVICE_ID_ATMEL_MXT_DIGITIZER) },
1062
1063         /* Baanto multitouch devices */
1064         { .driver_data = MT_CLS_NSMU,
1065                 MT_USB_DEVICE(USB_VENDOR_ID_BAANTO,
1066                         USB_DEVICE_ID_BAANTO_MT_190W2) },
1067         /* Cando panels */
1068         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1069                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1070                         USB_DEVICE_ID_CANDO_MULTI_TOUCH) },
1071         { .driver_data = MT_CLS_DUAL_CONTACT_NUMBER,
1072                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1073                         USB_DEVICE_ID_CANDO_MULTI_TOUCH_10_1) },
1074         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1075                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1076                         USB_DEVICE_ID_CANDO_MULTI_TOUCH_11_6) },
1077         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1078                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1079                         USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6) },
1080
1081         /* Chunghwa Telecom touch panels */
1082         {  .driver_data = MT_CLS_NSMU,
1083                 MT_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT,
1084                         USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH) },
1085
1086         /* CVTouch panels */
1087         { .driver_data = MT_CLS_NSMU,
1088                 MT_USB_DEVICE(USB_VENDOR_ID_CVTOUCH,
1089                         USB_DEVICE_ID_CVTOUCH_SCREEN) },
1090
1091         /* Cypress panel */
1092         { .driver_data = MT_CLS_CYPRESS,
1093                 HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS,
1094                         USB_DEVICE_ID_CYPRESS_TRUETOUCH) },
1095
1096         /* Data Modul easyMaxTouch */
1097         { .driver_data = MT_CLS_DEFAULT,
1098                 MT_USB_DEVICE(USB_VENDOR_ID_DATA_MODUL,
1099                         USB_VENDOR_ID_DATA_MODUL_EASYMAXTOUCH) },
1100
1101         /* eGalax devices (resistive) */
1102         { .driver_data = MT_CLS_EGALAX,
1103                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1104                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D) },
1105         { .driver_data = MT_CLS_EGALAX,
1106                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1107                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E) },
1108
1109         /* eGalax devices (capacitive) */
1110         { .driver_data = MT_CLS_EGALAX_SERIAL,
1111                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1112                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7207) },
1113         { .driver_data = MT_CLS_EGALAX,
1114                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1115                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C) },
1116         { .driver_data = MT_CLS_EGALAX_SERIAL,
1117                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1118                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224) },
1119         { .driver_data = MT_CLS_EGALAX_SERIAL,
1120                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1121                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_722A) },
1122         { .driver_data = MT_CLS_EGALAX_SERIAL,
1123                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1124                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_725E) },
1125         { .driver_data = MT_CLS_EGALAX_SERIAL,
1126                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1127                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7262) },
1128         { .driver_data = MT_CLS_EGALAX,
1129                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1130                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B) },
1131         { .driver_data = MT_CLS_EGALAX,
1132                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1133                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1) },
1134         { .driver_data = MT_CLS_EGALAX_SERIAL,
1135                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1136                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72AA) },
1137         { .driver_data = MT_CLS_EGALAX,
1138                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1139                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72C4) },
1140         { .driver_data = MT_CLS_EGALAX,
1141                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1142                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72D0) },
1143         { .driver_data = MT_CLS_EGALAX,
1144                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1145                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA) },
1146         { .driver_data = MT_CLS_EGALAX,
1147                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1148                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302) },
1149         { .driver_data = MT_CLS_EGALAX_SERIAL,
1150                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1151                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7349) },
1152         { .driver_data = MT_CLS_EGALAX_SERIAL,
1153                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1154                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_73F7) },
1155         { .driver_data = MT_CLS_EGALAX_SERIAL,
1156                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1157                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001) },
1158
1159         /* Elo TouchSystems IntelliTouch Plus panel */
1160         { .driver_data = MT_CLS_DUAL_CONTACT_ID,
1161                 MT_USB_DEVICE(USB_VENDOR_ID_ELO,
1162                         USB_DEVICE_ID_ELO_TS2515) },
1163
1164         /* Flatfrog Panels */
1165         { .driver_data = MT_CLS_FLATFROG,
1166                 MT_USB_DEVICE(USB_VENDOR_ID_FLATFROG,
1167                         USB_DEVICE_ID_MULTITOUCH_3200) },
1168
1169         /* GeneralTouch panel */
1170         { .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1171                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1172                         USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
1173         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1174                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1175                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PWT_TENFINGERS) },
1176         { .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1177                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1178                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0101) },
1179         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1180                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1181                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0102) },
1182         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1183                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1184                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0106) },
1185         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1186                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1187                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_010A) },
1188         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1189                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1190                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_E100) },
1191
1192         /* Gametel game controller */
1193         { .driver_data = MT_CLS_NSMU,
1194                 MT_BT_DEVICE(USB_VENDOR_ID_FRUCTEL,
1195                         USB_DEVICE_ID_GAMETEL_MT_MODE) },
1196
1197         /* GoodTouch panels */
1198         { .driver_data = MT_CLS_NSMU,
1199                 MT_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH,
1200                         USB_DEVICE_ID_GOODTOUCH_000f) },
1201
1202         /* Hanvon panels */
1203         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1204                 MT_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT,
1205                         USB_DEVICE_ID_HANVON_ALT_MULTITOUCH) },
1206
1207         /* Ideacom panel */
1208         { .driver_data = MT_CLS_SERIAL,
1209                 MT_USB_DEVICE(USB_VENDOR_ID_IDEACOM,
1210                         USB_DEVICE_ID_IDEACOM_IDC6650) },
1211         { .driver_data = MT_CLS_SERIAL,
1212                 MT_USB_DEVICE(USB_VENDOR_ID_IDEACOM,
1213                         USB_DEVICE_ID_IDEACOM_IDC6651) },
1214
1215         /* Ilitek dual touch panel */
1216         {  .driver_data = MT_CLS_NSMU,
1217                 MT_USB_DEVICE(USB_VENDOR_ID_ILITEK,
1218                         USB_DEVICE_ID_ILITEK_MULTITOUCH) },
1219
1220         /* IRTOUCH panels */
1221         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1222                 MT_USB_DEVICE(USB_VENDOR_ID_IRTOUCHSYSTEMS,
1223                         USB_DEVICE_ID_IRTOUCH_INFRARED_USB) },
1224
1225         /* LG Display panels */
1226         { .driver_data = MT_CLS_DEFAULT,
1227                 MT_USB_DEVICE(USB_VENDOR_ID_LG,
1228                         USB_DEVICE_ID_LG_MULTITOUCH) },
1229
1230         /* Lumio panels */
1231         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1232                 MT_USB_DEVICE(USB_VENDOR_ID_LUMIO,
1233                         USB_DEVICE_ID_CRYSTALTOUCH) },
1234         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1235                 MT_USB_DEVICE(USB_VENDOR_ID_LUMIO,
1236                         USB_DEVICE_ID_CRYSTALTOUCH_DUAL) },
1237
1238         /* MosArt panels */
1239         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1240                 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
1241                         USB_DEVICE_ID_ASUS_T91MT)},
1242         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1243                 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
1244                         USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO) },
1245         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1246                 MT_USB_DEVICE(USB_VENDOR_ID_TURBOX,
1247                         USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART) },
1248
1249         /* Nexio panels */
1250         { .driver_data = MT_CLS_DEFAULT,
1251                 MT_USB_DEVICE(USB_VENDOR_ID_NEXIO,
1252                         USB_DEVICE_ID_NEXIO_MULTITOUCH_420)},
1253
1254         /* Panasonic panels */
1255         { .driver_data = MT_CLS_PANASONIC,
1256                 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
1257                         USB_DEVICE_ID_PANABOARD_UBT780) },
1258         { .driver_data = MT_CLS_PANASONIC,
1259                 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
1260                         USB_DEVICE_ID_PANABOARD_UBT880) },
1261
1262         /* Novatek Panel */
1263         { .driver_data = MT_CLS_NSMU,
1264                 MT_USB_DEVICE(USB_VENDOR_ID_NOVATEK,
1265                         USB_DEVICE_ID_NOVATEK_PCT) },
1266
1267         /* PenMount panels */
1268         { .driver_data = MT_CLS_CONFIDENCE,
1269                 MT_USB_DEVICE(USB_VENDOR_ID_PENMOUNT,
1270                         USB_DEVICE_ID_PENMOUNT_PCI) },
1271
1272         /* PixArt optical touch screen */
1273         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1274                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1275                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN) },
1276         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1277                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1278                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1) },
1279         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1280                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1281                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2) },
1282
1283         /* PixCir-based panels */
1284         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1285                 MT_USB_DEVICE(USB_VENDOR_ID_HANVON,
1286                         USB_DEVICE_ID_HANVON_MULTITOUCH) },
1287         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1288                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1289                         USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
1290
1291         /* Quanta-based panels */
1292         { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
1293                 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
1294                         USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH) },
1295         { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
1296                 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
1297                         USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001) },
1298         { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
1299                 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
1300                         USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3008) },
1301
1302         /* SiS panels */
1303         { .driver_data = MT_CLS_DEFAULT,
1304                 HID_USB_DEVICE(USB_VENDOR_ID_SIS2_TOUCH,
1305                 USB_DEVICE_ID_SIS9200_TOUCH) },
1306         { .driver_data = MT_CLS_DEFAULT,
1307                 HID_USB_DEVICE(USB_VENDOR_ID_SIS2_TOUCH,
1308                 USB_DEVICE_ID_SIS817_TOUCH) },
1309
1310         /* Stantum panels */
1311         { .driver_data = MT_CLS_CONFIDENCE,
1312                 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM,
1313                         USB_DEVICE_ID_MTP)},
1314         { .driver_data = MT_CLS_CONFIDENCE,
1315                 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM,
1316                         USB_DEVICE_ID_MTP_STM)},
1317         { .driver_data = MT_CLS_DEFAULT,
1318                 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_SITRONIX,
1319                         USB_DEVICE_ID_MTP_SITRONIX)},
1320
1321         /* TopSeed panels */
1322         { .driver_data = MT_CLS_TOPSEED,
1323                 MT_USB_DEVICE(USB_VENDOR_ID_TOPSEED2,
1324                         USB_DEVICE_ID_TOPSEED2_PERIPAD_701) },
1325
1326         /* Touch International panels */
1327         { .driver_data = MT_CLS_NSMU,
1328                 MT_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL,
1329                         USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH) },
1330
1331         /* Unitec panels */
1332         { .driver_data = MT_CLS_NSMU,
1333                 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
1334                         USB_DEVICE_ID_UNITEC_USB_TOUCH_0709) },
1335         { .driver_data = MT_CLS_NSMU,
1336                 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
1337                         USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19) },
1338
1339         /* Wistron panels */
1340         { .driver_data = MT_CLS_NSMU,
1341                 MT_USB_DEVICE(USB_VENDOR_ID_WISTRON,
1342                         USB_DEVICE_ID_WISTRON_OPTICAL_TOUCH) },
1343
1344         /* XAT */
1345         { .driver_data = MT_CLS_NSMU,
1346                 MT_USB_DEVICE(USB_VENDOR_ID_XAT,
1347                         USB_DEVICE_ID_XAT_CSR) },
1348
1349         /* Xiroku */
1350         { .driver_data = MT_CLS_NSMU,
1351                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1352                         USB_DEVICE_ID_XIROKU_SPX) },
1353         { .driver_data = MT_CLS_NSMU,
1354                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1355                         USB_DEVICE_ID_XIROKU_MPX) },
1356         { .driver_data = MT_CLS_NSMU,
1357                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1358                         USB_DEVICE_ID_XIROKU_CSR) },
1359         { .driver_data = MT_CLS_NSMU,
1360                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1361                         USB_DEVICE_ID_XIROKU_SPX1) },
1362         { .driver_data = MT_CLS_NSMU,
1363                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1364                         USB_DEVICE_ID_XIROKU_MPX1) },
1365         { .driver_data = MT_CLS_NSMU,
1366                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1367                         USB_DEVICE_ID_XIROKU_CSR1) },
1368         { .driver_data = MT_CLS_NSMU,
1369                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1370                         USB_DEVICE_ID_XIROKU_SPX2) },
1371         { .driver_data = MT_CLS_NSMU,
1372                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1373                         USB_DEVICE_ID_XIROKU_MPX2) },
1374         { .driver_data = MT_CLS_NSMU,
1375                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1376                         USB_DEVICE_ID_XIROKU_CSR2) },
1377
1378         /* Zytronic panels */
1379         { .driver_data = MT_CLS_SERIAL,
1380                 MT_USB_DEVICE(USB_VENDOR_ID_ZYTRONIC,
1381                         USB_DEVICE_ID_ZYTRONIC_ZXY100) },
1382
1383         /* Generic MT device */
1384         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH, HID_ANY_ID, HID_ANY_ID) },
1385
1386         /* Generic Win 8 certified MT device */
1387         {  .driver_data = MT_CLS_WIN_8,
1388                 HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH_WIN_8,
1389                         HID_ANY_ID, HID_ANY_ID) },
1390         { }
1391 };
1392 MODULE_DEVICE_TABLE(hid, mt_devices);
1393
1394 static const struct hid_usage_id mt_grabbed_usages[] = {
1395         { HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
1396         { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
1397 };
1398
1399 static struct hid_driver mt_driver = {
1400         .name = "hid-multitouch",
1401         .id_table = mt_devices,
1402         .probe = mt_probe,
1403         .remove = mt_remove,
1404         .input_mapping = mt_input_mapping,
1405         .input_mapped = mt_input_mapped,
1406         .input_configured = mt_input_configured,
1407         .feature_mapping = mt_feature_mapping,
1408         .usage_table = mt_grabbed_usages,
1409         .event = mt_event,
1410         .report = mt_report,
1411 #ifdef CONFIG_PM
1412         .reset_resume = mt_reset_resume,
1413         .resume = mt_resume,
1414 #endif
1415 };
1416 module_hid_driver(mt_driver);