drivers/hid/hid-multitouch.c

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