drivers/hid/hid-multitouch.c

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