kernel/drivers/hid/hid-multitouch.c

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