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