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