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                 td->inputmode = field->report->id;
 361                 td->inputmode_index = usage->usage_index;
 362
 363                 break;
 364         case HID_DG_CONTACTMAX:
 365                 mt_get_feature(hdev, field->report);
 366
 367                 td->maxcontact_report_id = field->report->id;
 368                 td->maxcontacts = field->value[0];
 369                 if (!td->maxcontacts &&
 370                     field->logical_maximum <= MT_MAX_MAXCONTACT)
 371                         td->maxcontacts = field->logical_maximum;
 372                 if (td->mtclass.maxcontacts)
 373                         /* check if the maxcontacts is given by the class */
 374                         td->maxcontacts = td->mtclass.maxcontacts;
 375
 376                 break;
 377         case HID_DG_BUTTONTYPE:
 378                 if (usage->usage_index >= field->report_count) {
 379                         dev_err(&hdev->dev, "HID_DG_BUTTONTYPE out of range\n");
 380                         break;
 381                 }
 382
 383                 mt_get_feature(hdev, field->report);
 384                 if (field->value[usage->usage_index] == MT_BUTTONTYPE_CLICKPAD)
 385                         td->is_buttonpad = true;
 386
 387                 break;
 388         }
 389 }
 390
 391 static void set_abs(struct input_dev *input, unsigned int code,
 392                 struct hid_field *field, int snratio)
 393 {
 394         int fmin = field->logical_minimum;
 395         int fmax = field->logical_maximum;
 396         int fuzz = snratio ? (fmax - fmin) / snratio : 0;
 397         input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
 398         input_abs_set_res(input, code, hidinput_calc_abs_res(field, code));
 399 }
 400
 401 static void mt_store_field(struct hid_usage *usage, struct mt_device *td,
 402                 struct hid_input *hi)
 403 {
 404         struct mt_fields *f = td->fields;
 405
 406         if (f->length >= HID_MAX_FIELDS)
 407                 return;
 408
 409         f->usages[f->length++] = usage->hid;
 410 }
 411
 412 static int mt_touch_input_mapping(struct hid_device *hdev, struct hid_input *hi,
 413                 struct hid_field *field, struct hid_usage *usage,
 414                 unsigned long **bit, int *max)
 415 {
 416         struct mt_device *td = hid_get_drvdata(hdev);
 417         struct mt_class *cls = &td->mtclass;
 418         int code;
 419         struct hid_usage *prev_usage = NULL;
 420
 421         if (field->application == HID_DG_TOUCHSCREEN)
 422                 td->mt_flags |= INPUT_MT_DIRECT;
 423
 424         /*
 425          * Model touchscreens providing buttons as touchpads.
 426          */
 427         if (field->application == HID_DG_TOUCHPAD ||
 428             (usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON) {
 429                 td->mt_flags |= INPUT_MT_POINTER;
 430                 td->inputmode_value = MT_INPUTMODE_TOUCHPAD;
 431         }
 432
 433         /* count the buttons on touchpads */
 434         if ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON)
 435                 td->buttons_count++;
 436
 437         /* Only map fields from TouchScreen or TouchPad collections.
 438          * We need to ignore fields that belong to other collections
 439          * such as Mouse that might have the same GenericDesktop usages. */
 440         if (field->application == HID_DG_TOUCHSCREEN)
 441                 set_bit(INPUT_PROP_DIRECT, hi->input->propbit);
 442         else if (field->application == HID_DG_TOUCHPAD)
 443                 set_bit(INPUT_PROP_POINTER, hi->input->propbit);
 444         else
 445                 return 0;
 446
 447         if (usage->usage_index)
 448                 prev_usage = &field->usage[usage->usage_index - 1];
 449
 450         switch (usage->hid & HID_USAGE_PAGE) {
 451
 452         case HID_UP_GENDESK:
 453                 switch (usage->hid) {
 454                 case HID_GD_X:
 455                         if (prev_usage && (prev_usage->hid == usage->hid)) {
 456                                 hid_map_usage(hi, usage, bit, max,
 457                                         EV_ABS, ABS_MT_TOOL_X);
 458                                 set_abs(hi->input, ABS_MT_TOOL_X, field,
 459                                         cls->sn_move);
 460                         } else {
 461                                 hid_map_usage(hi, usage, bit, max,
 462                                         EV_ABS, ABS_MT_POSITION_X);
 463                                 set_abs(hi->input, ABS_MT_POSITION_X, field,
 464                                         cls->sn_move);
 465                         }
 466
 467                         mt_store_field(usage, td, hi);
 468                         return 1;
 469                 case HID_GD_Y:
 470                         if (prev_usage && (prev_usage->hid == usage->hid)) {
 471                                 hid_map_usage(hi, usage, bit, max,
 472                                         EV_ABS, ABS_MT_TOOL_Y);
 473                                 set_abs(hi->input, ABS_MT_TOOL_Y, field,
 474                                         cls->sn_move);
 475                         } else {
 476                                 hid_map_usage(hi, usage, bit, max,
 477                                         EV_ABS, ABS_MT_POSITION_Y);
 478                                 set_abs(hi->input, ABS_MT_POSITION_Y, field,
 479                                         cls->sn_move);
 480                         }
 481
 482                         mt_store_field(usage, td, hi);
 483                         return 1;
 484                 }
 485                 return 0;
 486
 487         case HID_UP_DIGITIZER:
 488                 switch (usage->hid) {
 489                 case HID_DG_INRANGE:
 490                         if (cls->quirks & MT_QUIRK_HOVERING) {
 491                                 hid_map_usage(hi, usage, bit, max,
 492                                         EV_ABS, ABS_MT_DISTANCE);
 493                                 input_set_abs_params(hi->input,
 494                                         ABS_MT_DISTANCE, 0, 1, 0, 0);
 495                         }
 496                         mt_store_field(usage, td, hi);
 497                         return 1;
 498                 case HID_DG_CONFIDENCE:
 499                         mt_store_field(usage, td, hi);
 500                         return 1;
 501                 case HID_DG_TIPSWITCH:
 502                         hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_TOUCH);
 503                         input_set_capability(hi->input, EV_KEY, BTN_TOUCH);
 504                         mt_store_field(usage, td, hi);
 505                         return 1;
 506                 case HID_DG_CONTACTID:
 507                         mt_store_field(usage, td, hi);
 508                         td->touches_by_report++;
 509                         td->mt_report_id = field->report->id;
 510                         return 1;
 511                 case HID_DG_WIDTH:
 512                         hid_map_usage(hi, usage, bit, max,
 513                                         EV_ABS, ABS_MT_TOUCH_MAJOR);
 514                         if (!(cls->quirks & MT_QUIRK_NO_AREA))
 515                                 set_abs(hi->input, ABS_MT_TOUCH_MAJOR, field,
 516                                         cls->sn_width);
 517                         mt_store_field(usage, td, hi);
 518                         return 1;
 519                 case HID_DG_HEIGHT:
 520                         hid_map_usage(hi, usage, bit, max,
 521                                         EV_ABS, ABS_MT_TOUCH_MINOR);
 522                         if (!(cls->quirks & MT_QUIRK_NO_AREA)) {
 523                                 set_abs(hi->input, ABS_MT_TOUCH_MINOR, field,
 524                                         cls->sn_height);
 525                                 input_set_abs_params(hi->input,
 526                                         ABS_MT_ORIENTATION, 0, 1, 0, 0);
 527                         }
 528                         mt_store_field(usage, td, hi);
 529                         return 1;
 530                 case HID_DG_TIPPRESSURE:
 531                         hid_map_usage(hi, usage, bit, max,
 532                                         EV_ABS, ABS_MT_PRESSURE);
 533                         set_abs(hi->input, ABS_MT_PRESSURE, field,
 534                                 cls->sn_pressure);
 535                         mt_store_field(usage, td, hi);
 536                         return 1;
 537                 case HID_DG_CONTACTCOUNT:
 538                         /* Ignore if indexes are out of bounds. */
 539                         if (field->index >= field->report->maxfield ||
 540                             usage->usage_index >= field->report_count)
 541                                 return 1;
 542                         td->cc_index = field->index;
 543                         td->cc_value_index = usage->usage_index;
 544                         return 1;
 545                 case HID_DG_CONTACTMAX:
 546                         /* we don't set td->last_slot_field as contactcount and
 547                          * contact max are global to the report */
 548                         return -1;
 549                 case HID_DG_TOUCH:
 550                         /* Legacy devices use TIPSWITCH and not TOUCH.
 551                          * Let's just ignore this field. */
 552                         return -1;
 553                 }
 554                 /* let hid-input decide for the others */
 555                 return 0;
 556
 557         case HID_UP_BUTTON:
 558                 code = BTN_MOUSE + ((usage->hid - 1) & HID_USAGE);
 559                 hid_map_usage(hi, usage, bit, max, EV_KEY, code);
 560                 input_set_capability(hi->input, EV_KEY, code);
 561                 return 1;
 562
 563         case 0xff000000:
 564                 /* we do not want to map these: no input-oriented meaning */
 565                 return -1;
 566         }
 567
 568         return 0;
 569 }
 570
 571 static int mt_touch_input_mapped(struct hid_device *hdev, struct hid_input *hi,
 572                 struct hid_field *field, struct hid_usage *usage,
 573                 unsigned long **bit, int *max)
 574 {
 575         if (usage->type == EV_KEY || usage->type == EV_ABS)
 576                 set_bit(usage->type, hi->input->evbit);
 577
 578         return -1;
 579 }
 580
 581 static int mt_compute_slot(struct mt_device *td, struct input_dev *input)
 582 {
 583         __s32 quirks = td->mtclass.quirks;
 584
 585         if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
 586                 return td->curdata.contactid;
 587
 588         if (quirks & MT_QUIRK_CYPRESS)
 589                 return cypress_compute_slot(td);
 590
 591         if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
 592                 return td->num_received;
 593
 594         if (quirks & MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE)
 595                 return td->curdata.contactid - 1;
 596
 597         return input_mt_get_slot_by_key(input, td->curdata.contactid);
 598 }
 599
 600 /*
 601  * this function is called when a whole contact has been processed,
 602  * so that it can assign it to a slot and store the data there
 603  */
 604 static void mt_complete_slot(struct mt_device *td, struct input_dev *input)
 605 {
 606         if ((td->mtclass.quirks & MT_QUIRK_CONTACT_CNT_ACCURATE) &&
 607             td->num_received >= td->num_expected)
 608                 return;
 609
 610         if (td->curvalid || (td->mtclass.quirks & MT_QUIRK_ALWAYS_VALID)) {
 611                 int slotnum = mt_compute_slot(td, input);
 612                 struct mt_slot *s = &td->curdata;
 613                 struct input_mt *mt = input->mt;
 614
 615                 if (slotnum < 0 || slotnum >= td->maxcontacts)
 616                         return;
 617
 618                 if ((td->mtclass.quirks & MT_QUIRK_IGNORE_DUPLICATES) && mt) {
 619                         struct input_mt_slot *slot = &mt->slots[slotnum];
 620                         if (input_mt_is_active(slot) &&
 621                             input_mt_is_used(mt, slot))
 622                                 return;
 623                 }
 624
 625                 input_mt_slot(input, slotnum);
 626                 input_mt_report_slot_state(input, MT_TOOL_FINGER,
 627                         s->touch_state || s->inrange_state);
 628                 if (s->touch_state || s->inrange_state) {
 629                         /* this finger is in proximity of the sensor */
 630                         int wide = (s->w > s->h);
 631                         /* divided by two to match visual scale of touch */
 632                         int major = max(s->w, s->h) >> 1;
 633                         int minor = min(s->w, s->h) >> 1;
 634
 635                         input_event(input, EV_ABS, ABS_MT_POSITION_X, s->x);
 636                         input_event(input, EV_ABS, ABS_MT_POSITION_Y, s->y);
 637                         input_event(input, EV_ABS, ABS_MT_TOOL_X, s->cx);
 638                         input_event(input, EV_ABS, ABS_MT_TOOL_Y, s->cy);
 639                         input_event(input, EV_ABS, ABS_MT_DISTANCE,
 640                                 !s->touch_state);
 641                         input_event(input, EV_ABS, ABS_MT_ORIENTATION, wide);
 642                         input_event(input, EV_ABS, ABS_MT_PRESSURE, s->p);
 643                         input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
 644                         input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
 645                 }
 646         }
 647
 648         td->num_received++;
 649 }
 650
 651 /*
 652  * this function is called when a whole packet has been received and processed,
 653  * so that it can decide what to send to the input layer.
 654  */
 655 static void mt_sync_frame(struct mt_device *td, struct input_dev *input)
 656 {
 657         input_mt_sync_frame(input);
 658         input_sync(input);
 659         td->num_received = 0;
 660 }
 661
 662 static int mt_touch_event(struct hid_device *hid, struct hid_field *field,
 663                                 struct hid_usage *usage, __s32 value)
 664 {
 665         /* we will handle the hidinput part later, now remains hiddev */
 666         if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
 667                 hid->hiddev_hid_event(hid, field, usage, value);
 668
 669         return 1;
 670 }
 671
 672 static void mt_process_mt_event(struct hid_device *hid, struct hid_field *field,
 673                                 struct hid_usage *usage, __s32 value)
 674 {
 675         struct mt_device *td = hid_get_drvdata(hid);
 676         __s32 quirks = td->mtclass.quirks;
 677         struct input_dev *input = field->hidinput->input;
 678
 679         if (hid->claimed & HID_CLAIMED_INPUT) {
 680                 switch (usage->hid) {
 681                 case HID_DG_INRANGE:
 682                         if (quirks & MT_QUIRK_VALID_IS_INRANGE)
 683                                 td->curvalid = value;
 684                         if (quirks & MT_QUIRK_HOVERING)
 685                                 td->curdata.inrange_state = value;
 686                         break;
 687                 case HID_DG_TIPSWITCH:
 688                         if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
 689                                 td->curvalid = value;
 690                         td->curdata.touch_state = value;
 691                         break;
 692                 case HID_DG_CONFIDENCE:
 693                         if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
 694                                 td->curvalid = value;
 695                         break;
 696                 case HID_DG_CONTACTID:
 697                         td->curdata.contactid = value;
 698                         break;
 699                 case HID_DG_TIPPRESSURE:
 700                         td->curdata.p = value;
 701                         break;
 702                 case HID_GD_X:
 703                         if (usage->code == ABS_MT_TOOL_X)
 704                                 td->curdata.cx = value;
 705                         else
 706                                 td->curdata.x = value;
 707                         break;
 708                 case HID_GD_Y:
 709                         if (usage->code == ABS_MT_TOOL_Y)
 710                                 td->curdata.cy = value;
 711                         else
 712                                 td->curdata.y = value;
 713                         break;
 714                 case HID_DG_WIDTH:
 715                         td->curdata.w = value;
 716                         break;
 717                 case HID_DG_HEIGHT:
 718                         td->curdata.h = value;
 719                         break;
 720                 case HID_DG_CONTACTCOUNT:
 721                         break;
 722                 case HID_DG_TOUCH:
 723                         /* do nothing */
 724                         break;
 725
 726                 default:
 727                         if (usage->type)
 728                                 input_event(input, usage->type, usage->code,
 729                                                 value);
 730                         return;
 731                 }
 732
 733                 if (usage->usage_index + 1 == field->report_count) {
 734                         /* we only take into account the last report. */
 735                         if (usage->hid == td->last_slot_field)
 736                                 mt_complete_slot(td, field->hidinput->input);
 737                 }
 738
 739         }
 740 }
 741
 742 static void mt_touch_report(struct hid_device *hid, struct hid_report *report)
 743 {
 744         struct mt_device *td = hid_get_drvdata(hid);
 745         struct hid_field *field;
 746         unsigned count;
 747         int r, n;
 748
 749         /*
 750          * Includes multi-packet support where subsequent
 751          * packets are sent with zero contactcount.
 752          */
 753         if (td->cc_index >= 0) {
 754                 struct hid_field *field = report->field[td->cc_index];
 755                 int value = field->value[td->cc_value_index];
 756                 if (value)
 757                         td->num_expected = value;
 758         }
 759
 760         for (r = 0; r < report->maxfield; r++) {
 761                 field = report->field[r];
 762                 count = field->report_count;
 763
 764                 if (!(HID_MAIN_ITEM_VARIABLE & field->flags))
 765                         continue;
 766
 767                 for (n = 0; n < count; n++)
 768                         mt_process_mt_event(hid, field, &field->usage[n],
 769                                         field->value[n]);
 770         }
 771
 772         if (td->num_received >= td->num_expected)
 773                 mt_sync_frame(td, report->field[0]->hidinput->input);
 774 }
 775
 776 static int mt_touch_input_configured(struct hid_device *hdev,
 777                                         struct hid_input *hi)
 778 {
 779         struct mt_device *td = hid_get_drvdata(hdev);
 780         struct mt_class *cls = &td->mtclass;
 781         struct input_dev *input = hi->input;
 782         int ret;
 783
 784         if (!td->maxcontacts)
 785                 td->maxcontacts = MT_DEFAULT_MAXCONTACT;
 786
 787         mt_post_parse(td);
 788         if (td->serial_maybe)
 789                 mt_post_parse_default_settings(td);
 790
 791         if (cls->is_indirect)
 792                 td->mt_flags |= INPUT_MT_POINTER;
 793
 794         if (cls->quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
 795                 td->mt_flags |= INPUT_MT_DROP_UNUSED;
 796
 797         /* check for clickpads */
 798         if ((td->mt_flags & INPUT_MT_POINTER) && (td->buttons_count == 1))
 799                 td->is_buttonpad = true;
 800
 801         if (td->is_buttonpad)
 802                 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
 803
 804         ret = input_mt_init_slots(input, td->maxcontacts, td->mt_flags);
 805         if (ret)
 806                 return ret;
 807
 808         td->mt_flags = 0;
 809         return 0;
 810 }
 811
 812 static int mt_input_mapping(struct hid_device *hdev, struct hid_input *hi,
 813                 struct hid_field *field, struct hid_usage *usage,
 814                 unsigned long **bit, int *max)
 815 {
 816         struct mt_device *td = hid_get_drvdata(hdev);
 817
 818         /*
 819          * If mtclass.export_all_inputs is not set, only map fields from
 820          * TouchScreen or TouchPad collections. We need to ignore fields
 821          * that belong to other collections such as Mouse that might have
 822          * the same GenericDesktop usages.
 823          */
 824         if (!td->mtclass.export_all_inputs &&
 825             field->application != HID_DG_TOUCHSCREEN &&
 826             field->application != HID_DG_PEN &&
 827             field->application != HID_DG_TOUCHPAD)
 828                 return -1;
 829
 830         /*
 831          * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
 832          * for the stylus.
 833          * The check for mt_report_id ensures we don't process
 834          * HID_DG_CONTACTCOUNT from the pen report as it is outside the physical
 835          * collection, but within the report ID.
 836          */
 837         if (field->physical == HID_DG_STYLUS)
 838                 return 0;
 839         else if ((field->physical == 0) &&
 840                  (field->report->id != td->mt_report_id) &&
 841                  (td->mt_report_id != -1))
 842                 return 0;
 843
 844         if (field->application == HID_DG_TOUCHSCREEN ||
 845             field->application == HID_DG_TOUCHPAD)
 846                 return mt_touch_input_mapping(hdev, hi, field, usage, bit, max);
 847
 848         /* let hid-core decide for the others */
 849         return 0;
 850 }
 851
 852 static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
 853                 struct hid_field *field, struct hid_usage *usage,
 854                 unsigned long **bit, int *max)
 855 {
 856         /*
 857          * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
 858          * for the stylus.
 859          */
 860         if (field->physical == HID_DG_STYLUS)
 861                 return 0;
 862
 863         if (field->application == HID_DG_TOUCHSCREEN ||
 864             field->application == HID_DG_TOUCHPAD)
 865                 return mt_touch_input_mapped(hdev, hi, field, usage, bit, max);
 866
 867         /* let hid-core decide for the others */
 868         return 0;
 869 }
 870
 871 static int mt_event(struct hid_device *hid, struct hid_field *field,
 872                                 struct hid_usage *usage, __s32 value)
 873 {
 874         struct mt_device *td = hid_get_drvdata(hid);
 875
 876         if (field->report->id == td->mt_report_id)
 877                 return mt_touch_event(hid, field, usage, value);
 878
 879         return 0;
 880 }
 881
 882 static void mt_report(struct hid_device *hid, struct hid_report *report)
 883 {
 884         struct mt_device *td = hid_get_drvdata(hid);
 885         struct hid_field *field = report->field[0];
 886
 887         if (!(hid->claimed & HID_CLAIMED_INPUT))
 888                 return;
 889
 890         if (report->id == td->mt_report_id)
 891                 return mt_touch_report(hid, report);
 892
 893         if (field && field->hidinput && field->hidinput->input)
 894                 input_sync(field->hidinput->input);
 895 }
 896
 897 static void mt_set_input_mode(struct hid_device *hdev)
 898 {
 899         struct mt_device *td = hid_get_drvdata(hdev);
 900         struct hid_report *r;
 901         struct hid_report_enum *re;
 902         struct mt_class *cls = &td->mtclass;
 903         char *buf;
 904         int report_len;
 905
 906         if (td->inputmode < 0)
 907                 return;
 908
 909         re = &(hdev->report_enum[HID_FEATURE_REPORT]);
 910         r = re->report_id_hash[td->inputmode];
 911         if (r) {
 912                 if (cls->quirks & MT_QUIRK_FORCE_GET_FEATURE) {
 913                         report_len = hid_report_len(r);
 914                         buf = hid_alloc_report_buf(r, GFP_KERNEL);
 915                         if (!buf) {
 916                                 hid_err(hdev, "failed to allocate buffer for report\n");
 917                                 return;
 918                         }
 919                         hid_hw_raw_request(hdev, r->id, buf, report_len,
 920                                            HID_FEATURE_REPORT,
 921                                            HID_REQ_GET_REPORT);
 922                         kfree(buf);
 923                 }
 924                 r->field[0]->value[td->inputmode_index] = td->inputmode_value;
 925                 hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
 926         }
 927 }
 928
 929 static void mt_set_maxcontacts(struct hid_device *hdev)
 930 {
 931         struct mt_device *td = hid_get_drvdata(hdev);
 932         struct hid_report *r;
 933         struct hid_report_enum *re;
 934         int fieldmax, max;
 935
 936         if (td->maxcontact_report_id < 0)
 937                 return;
 938
 939         if (!td->mtclass.maxcontacts)
 940                 return;
 941
 942         re = &hdev->report_enum[HID_FEATURE_REPORT];
 943         r = re->report_id_hash[td->maxcontact_report_id];
 944         if (r) {
 945                 max = td->mtclass.maxcontacts;
 946                 fieldmax = r->field[0]->logical_maximum;
 947                 max = min(fieldmax, max);
 948                 if (r->field[0]->value[0] != max) {
 949                         r->field[0]->value[0] = max;
 950                         hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
 951                 }
 952         }
 953 }
 954
 955 static void mt_post_parse_default_settings(struct mt_device *td)
 956 {
 957         __s32 quirks = td->mtclass.quirks;
 958
 959         /* unknown serial device needs special quirks */
 960         if (td->touches_by_report == 1) {
 961                 quirks |= MT_QUIRK_ALWAYS_VALID;
 962                 quirks &= ~MT_QUIRK_NOT_SEEN_MEANS_UP;
 963                 quirks &= ~MT_QUIRK_VALID_IS_INRANGE;
 964                 quirks &= ~MT_QUIRK_VALID_IS_CONFIDENCE;
 965                 quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
 966         }
 967
 968         td->mtclass.quirks = quirks;
 969 }
 970
 971 static void mt_post_parse(struct mt_device *td)
 972 {
 973         struct mt_fields *f = td->fields;
 974         struct mt_class *cls = &td->mtclass;
 975
 976         if (td->touches_by_report > 0) {
 977                 int field_count_per_touch = f->length / td->touches_by_report;
 978                 td->last_slot_field = f->usages[field_count_per_touch - 1];
 979         }
 980
 981         if (td->cc_index < 0)
 982                 cls->quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
 983 }
 984
 985 static int mt_input_configured(struct hid_device *hdev, struct hid_input *hi)
 986 {
 987         struct mt_device *td = hid_get_drvdata(hdev);
 988         char *name;
 989         const char *suffix = NULL;
 990         struct hid_field *field = hi->report->field[0];
 991         int ret;
 992
 993         if (hi->report->id == td->mt_report_id) {
 994                 ret = mt_touch_input_configured(hdev, hi);
 995                 if (ret)
 996                         return ret;
 997         }
 998
 999         /*
1000          * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
1001          * for the stylus. Check this first, and then rely on the application
1002          * field.
1003          */
1004         if (hi->report->field[0]->physical == HID_DG_STYLUS) {
1005                 suffix = "Pen";
1006                 /* force BTN_STYLUS to allow tablet matching in udev */
1007                 __set_bit(BTN_STYLUS, hi->input->keybit);
1008         } else {
1009                 switch (field->application) {
1010                 case HID_GD_KEYBOARD:
1011                         suffix = "Keyboard";
1012                         break;
1013                 case HID_GD_KEYPAD:
1014                         suffix = "Keypad";
1015                         break;
1016                 case HID_GD_MOUSE:
1017                         suffix = "Mouse";
1018                         break;
1019                 case HID_DG_STYLUS:
1020                         suffix = "Pen";
1021                         /* force BTN_STYLUS to allow tablet matching in udev */
1022                         __set_bit(BTN_STYLUS, hi->input->keybit);
1023                         break;
1024                 case HID_DG_TOUCHSCREEN:
1025                         /* we do not set suffix = "Touchscreen" */
1026                         break;
1027                 case HID_DG_TOUCHPAD:
1028                         suffix = "Touchpad";
1029                         break;
1030                 case HID_GD_SYSTEM_CONTROL:
1031                         suffix = "System Control";
1032                         break;
1033                 case HID_CP_CONSUMER_CONTROL:
1034                         suffix = "Consumer Control";
1035                         break;
1036                 default:
1037                         suffix = "UNKNOWN";
1038                         break;
1039                 }
1040         }
1041
1042         if (suffix) {
1043                 name = devm_kzalloc(&hi->input->dev,
1044                                     strlen(hdev->name) + strlen(suffix) + 2,
1045                                     GFP_KERNEL);
1046                 if (name) {
1047                         sprintf(name, "%s %s", hdev->name, suffix);
1048                         hi->input->name = name;
1049                 }
1050         }
1051
1052         return 0;
1053 }
1054
1055 static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
1056 {
1057         int ret, i;
1058         struct mt_device *td;
1059         struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */
1060
1061         for (i = 0; mt_classes[i].name ; i++) {
1062                 if (id->driver_data == mt_classes[i].name) {
1063                         mtclass = &(mt_classes[i]);
1064                         break;
1065                 }
1066         }
1067
1068         /* This allows the driver to correctly support devices
1069          * that emit events over several HID messages.
1070          */
1071         hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
1072
1073         /*
1074          * This allows the driver to handle different input sensors
1075          * that emits events through different reports on the same HID
1076          * device.
1077          */
1078         hdev->quirks |= HID_QUIRK_MULTI_INPUT;
1079         hdev->quirks |= HID_QUIRK_NO_EMPTY_INPUT;
1080
1081         /*
1082          * Handle special quirks for Windows 8 certified devices.
1083          */
1084         if (id->group == HID_GROUP_MULTITOUCH_WIN_8)
1085                 /*
1086                  * Some multitouch screens do not like to be polled for input
1087                  * reports. Fortunately, the Win8 spec says that all touches
1088                  * should be sent during each report, making the initialization
1089                  * of input reports unnecessary.
1090                  *
1091                  * In addition some touchpads do not behave well if we read
1092                  * all feature reports from them. Instead we prevent
1093                  * initial report fetching and then selectively fetch each
1094                  * report we are interested in.
1095                  */
1096                 hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
1097
1098         td = devm_kzalloc(&hdev->dev, sizeof(struct mt_device), GFP_KERNEL);
1099         if (!td) {
1100                 dev_err(&hdev->dev, "cannot allocate multitouch data\n");
1101                 return -ENOMEM;
1102         }
1103         td->mtclass = *mtclass;
1104         td->inputmode = -1;
1105         td->maxcontact_report_id = -1;
1106         td->inputmode_value = MT_INPUTMODE_TOUCHSCREEN;
1107         td->cc_index = -1;
1108         td->mt_report_id = -1;
1109         hid_set_drvdata(hdev, td);
1110
1111         td->fields = devm_kzalloc(&hdev->dev, sizeof(struct mt_fields),
1112                                   GFP_KERNEL);
1113         if (!td->fields) {
1114                 dev_err(&hdev->dev, "cannot allocate multitouch fields data\n");
1115                 return -ENOMEM;
1116         }
1117
1118         if (id->vendor == HID_ANY_ID && id->product == HID_ANY_ID)
1119                 td->serial_maybe = true;
1120
1121         ret = hid_parse(hdev);
1122         if (ret != 0)
1123                 return ret;
1124
1125         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
1126         if (ret)
1127                 return ret;
1128
1129         ret = sysfs_create_group(&hdev->dev.kobj, &mt_attribute_group);
1130
1131         mt_set_maxcontacts(hdev);
1132         mt_set_input_mode(hdev);
1133
1134         /* release .fields memory as it is not used anymore */
1135         devm_kfree(&hdev->dev, td->fields);
1136         td->fields = NULL;
1137
1138         return 0;
1139 }
1140
1141 #ifdef CONFIG_PM
1142 static int mt_reset_resume(struct hid_device *hdev)
1143 {
1144         mt_set_maxcontacts(hdev);
1145         mt_set_input_mode(hdev);
1146         return 0;
1147 }
1148
1149 static int mt_resume(struct hid_device *hdev)
1150 {
1151         /* Some Elan legacy devices require SET_IDLE to be set on resume.
1152          * It should be safe to send it to other devices too.
1153          * Tested on 3M, Stantum, Cypress, Zytronic, eGalax, and Elan panels. */
1154
1155         hid_hw_idle(hdev, 0, 0, HID_REQ_SET_IDLE);
1156
1157         return 0;
1158 }
1159 #endif
1160
1161 static void mt_remove(struct hid_device *hdev)
1162 {
1163         sysfs_remove_group(&hdev->dev.kobj, &mt_attribute_group);
1164         hid_hw_stop(hdev);
1165 }
1166
1167 /*
1168  * This list contains only:
1169  * - VID/PID of products not working with the default multitouch handling
1170  * - 2 generic rules.
1171  * So there is no point in adding here any device with MT_CLS_DEFAULT.
1172  */
1173 static const struct hid_device_id mt_devices[] = {
1174
1175         /* 3M panels */
1176         { .driver_data = MT_CLS_3M,
1177                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1178                         USB_DEVICE_ID_3M1968) },
1179         { .driver_data = MT_CLS_3M,
1180                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1181                         USB_DEVICE_ID_3M2256) },
1182         { .driver_data = MT_CLS_3M,
1183                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1184                         USB_DEVICE_ID_3M3266) },
1185
1186         /* Anton devices */
1187         { .driver_data = MT_CLS_EXPORT_ALL_INPUTS,
1188                 MT_USB_DEVICE(USB_VENDOR_ID_ANTON,
1189                         USB_DEVICE_ID_ANTON_TOUCH_PAD) },
1190
1191         /* Atmel panels */
1192         { .driver_data = MT_CLS_SERIAL,
1193                 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL,
1194                         USB_DEVICE_ID_ATMEL_MXT_DIGITIZER) },
1195
1196         /* Baanto multitouch devices */
1197         { .driver_data = MT_CLS_NSMU,
1198                 MT_USB_DEVICE(USB_VENDOR_ID_BAANTO,
1199                         USB_DEVICE_ID_BAANTO_MT_190W2) },
1200
1201         /* Cando panels */
1202         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1203                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1204                         USB_DEVICE_ID_CANDO_MULTI_TOUCH) },
1205         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1206                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1207                         USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6) },
1208
1209         /* Chunghwa Telecom touch panels */
1210         {  .driver_data = MT_CLS_NSMU,
1211                 MT_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT,
1212                         USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH) },
1213
1214         /* CJTouch panels */
1215         { .driver_data = MT_CLS_NSMU,
1216                 MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1217                         USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0020) },
1218         { .driver_data = MT_CLS_NSMU,
1219                 MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1220                         USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0040) },
1221
1222         /* CVTouch panels */
1223         { .driver_data = MT_CLS_NSMU,
1224                 MT_USB_DEVICE(USB_VENDOR_ID_CVTOUCH,
1225                         USB_DEVICE_ID_CVTOUCH_SCREEN) },
1226
1227         /* eGalax devices (resistive) */
1228         { .driver_data = MT_CLS_EGALAX,
1229                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1230                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D) },
1231         { .driver_data = MT_CLS_EGALAX,
1232                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1233                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E) },
1234
1235         /* eGalax devices (capacitive) */
1236         { .driver_data = MT_CLS_EGALAX_SERIAL,
1237                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1238                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7207) },
1239         { .driver_data = MT_CLS_EGALAX,
1240                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1241                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C) },
1242         { .driver_data = MT_CLS_EGALAX_SERIAL,
1243                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1244                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224) },
1245         { .driver_data = MT_CLS_EGALAX_SERIAL,
1246                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1247                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_722A) },
1248         { .driver_data = MT_CLS_EGALAX_SERIAL,
1249                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1250                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_725E) },
1251         { .driver_data = MT_CLS_EGALAX_SERIAL,
1252                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1253                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7262) },
1254         { .driver_data = MT_CLS_EGALAX,
1255                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1256                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B) },
1257         { .driver_data = MT_CLS_EGALAX,
1258                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1259                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1) },
1260         { .driver_data = MT_CLS_EGALAX_SERIAL,
1261                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1262                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72AA) },
1263         { .driver_data = MT_CLS_EGALAX,
1264                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1265                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72C4) },
1266         { .driver_data = MT_CLS_EGALAX,
1267                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1268                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72D0) },
1269         { .driver_data = MT_CLS_EGALAX,
1270                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1271                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA) },
1272         { .driver_data = MT_CLS_EGALAX,
1273                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1274                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302) },
1275         { .driver_data = MT_CLS_EGALAX_SERIAL,
1276                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1277                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7349) },
1278         { .driver_data = MT_CLS_EGALAX_SERIAL,
1279                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1280                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_73F7) },
1281         { .driver_data = MT_CLS_EGALAX_SERIAL,
1282                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1283                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001) },
1284
1285         /* Elitegroup panel */
1286         { .driver_data = MT_CLS_SERIAL,
1287                 MT_USB_DEVICE(USB_VENDOR_ID_ELITEGROUP,
1288                         USB_DEVICE_ID_ELITEGROUP_05D8) },
1289
1290         /* Flatfrog Panels */
1291         { .driver_data = MT_CLS_FLATFROG,
1292                 MT_USB_DEVICE(USB_VENDOR_ID_FLATFROG,
1293                         USB_DEVICE_ID_MULTITOUCH_3200) },
1294
1295         /* FocalTech Panels */
1296         { .driver_data = MT_CLS_SERIAL,
1297                 MT_USB_DEVICE(USB_VENDOR_ID_CYGNAL,
1298                         USB_DEVICE_ID_FOCALTECH_FTXXXX_MULTITOUCH) },
1299
1300         /* GeneralTouch panel */
1301         { .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1302                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1303                         USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
1304         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1305                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1306                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PWT_TENFINGERS) },
1307         { .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1308                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1309                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0101) },
1310         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1311                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1312                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0102) },
1313         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1314                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1315                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0106) },
1316         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1317                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1318                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_010A) },
1319         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1320                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1321                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_E100) },
1322
1323         /* Gametel game controller */
1324         { .driver_data = MT_CLS_NSMU,
1325                 MT_BT_DEVICE(USB_VENDOR_ID_FRUCTEL,
1326                         USB_DEVICE_ID_GAMETEL_MT_MODE) },
1327
1328         /* GoodTouch panels */
1329         { .driver_data = MT_CLS_NSMU,
1330                 MT_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH,
1331                         USB_DEVICE_ID_GOODTOUCH_000f) },
1332
1333         /* Hanvon panels */
1334         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1335                 MT_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT,
1336                         USB_DEVICE_ID_HANVON_ALT_MULTITOUCH) },
1337
1338         /* Ilitek dual touch panel */
1339         {  .driver_data = MT_CLS_NSMU,
1340                 MT_USB_DEVICE(USB_VENDOR_ID_ILITEK,
1341                         USB_DEVICE_ID_ILITEK_MULTITOUCH) },
1342
1343         /* MosArt panels */
1344         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1345                 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
1346                         USB_DEVICE_ID_ASUS_T91MT)},
1347         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1348                 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
1349                         USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO) },
1350         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1351                 MT_USB_DEVICE(USB_VENDOR_ID_TURBOX,
1352                         USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART) },
1353
1354         /* Panasonic panels */
1355         { .driver_data = MT_CLS_PANASONIC,
1356                 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
1357                         USB_DEVICE_ID_PANABOARD_UBT780) },
1358         { .driver_data = MT_CLS_PANASONIC,
1359                 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
1360                         USB_DEVICE_ID_PANABOARD_UBT880) },
1361
1362         /* Novatek Panel */
1363         { .driver_data = MT_CLS_NSMU,
1364                 MT_USB_DEVICE(USB_VENDOR_ID_NOVATEK,
1365                         USB_DEVICE_ID_NOVATEK_PCT) },
1366
1367         /* PixArt optical touch screen */
1368         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1369                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1370                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN) },
1371         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1372                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1373                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1) },
1374         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1375                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1376                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2) },
1377
1378         /* PixCir-based panels */
1379         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1380                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1381                         USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
1382
1383         /* Quanta-based panels */
1384         { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
1385                 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
1386                         USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001) },
1387
1388         /* Stantum panels */
1389         { .driver_data = MT_CLS_CONFIDENCE,
1390                 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM,
1391                         USB_DEVICE_ID_MTP_STM)},
1392
1393         /* TopSeed panels */
1394         { .driver_data = MT_CLS_TOPSEED,
1395                 MT_USB_DEVICE(USB_VENDOR_ID_TOPSEED2,
1396                         USB_DEVICE_ID_TOPSEED2_PERIPAD_701) },
1397
1398         /* Touch International panels */
1399         { .driver_data = MT_CLS_NSMU,
1400                 MT_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL,
1401                         USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH) },
1402
1403         /* Unitec panels */
1404         { .driver_data = MT_CLS_NSMU,
1405                 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
1406                         USB_DEVICE_ID_UNITEC_USB_TOUCH_0709) },
1407         { .driver_data = MT_CLS_NSMU,
1408                 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
1409                         USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19) },
1410
1411         /* VTL panels */
1412         { .driver_data = MT_CLS_VTL,
1413                 MT_USB_DEVICE(USB_VENDOR_ID_VTL,
1414                         USB_DEVICE_ID_VTL_MULTITOUCH_FF3F) },
1415
1416         /* Wistron panels */
1417         { .driver_data = MT_CLS_NSMU,
1418                 MT_USB_DEVICE(USB_VENDOR_ID_WISTRON,
1419                         USB_DEVICE_ID_WISTRON_OPTICAL_TOUCH) },
1420
1421         /* XAT */
1422         { .driver_data = MT_CLS_NSMU,
1423                 MT_USB_DEVICE(USB_VENDOR_ID_XAT,
1424                         USB_DEVICE_ID_XAT_CSR) },
1425
1426         /* Xiroku */
1427         { .driver_data = MT_CLS_NSMU,
1428                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1429                         USB_DEVICE_ID_XIROKU_SPX) },
1430         { .driver_data = MT_CLS_NSMU,
1431                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1432                         USB_DEVICE_ID_XIROKU_MPX) },
1433         { .driver_data = MT_CLS_NSMU,
1434                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1435                         USB_DEVICE_ID_XIROKU_CSR) },
1436         { .driver_data = MT_CLS_NSMU,
1437                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1438                         USB_DEVICE_ID_XIROKU_SPX1) },
1439         { .driver_data = MT_CLS_NSMU,
1440                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1441                         USB_DEVICE_ID_XIROKU_MPX1) },
1442         { .driver_data = MT_CLS_NSMU,
1443                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1444                         USB_DEVICE_ID_XIROKU_CSR1) },
1445         { .driver_data = MT_CLS_NSMU,
1446                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1447                         USB_DEVICE_ID_XIROKU_SPX2) },
1448         { .driver_data = MT_CLS_NSMU,
1449                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1450                         USB_DEVICE_ID_XIROKU_MPX2) },
1451         { .driver_data = MT_CLS_NSMU,
1452                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1453                         USB_DEVICE_ID_XIROKU_CSR2) },
1454
1455         /* Generic MT device */
1456         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH, HID_ANY_ID, HID_ANY_ID) },
1457
1458         /* Generic Win 8 certified MT device */
1459         {  .driver_data = MT_CLS_WIN_8,
1460                 HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH_WIN_8,
1461                         HID_ANY_ID, HID_ANY_ID) },
1462         { }
1463 };
1464 MODULE_DEVICE_TABLE(hid, mt_devices);
1465
1466 static const struct hid_usage_id mt_grabbed_usages[] = {
1467         { HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
1468         { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
1469 };
1470
1471 static struct hid_driver mt_driver = {
1472         .name = "hid-multitouch",
1473         .id_table = mt_devices,
1474         .probe = mt_probe,
1475         .remove = mt_remove,
1476         .input_mapping = mt_input_mapping,
1477         .input_mapped = mt_input_mapped,
1478         .input_configured = mt_input_configured,
1479         .feature_mapping = mt_feature_mapping,
1480         .usage_table = mt_grabbed_usages,
1481         .event = mt_event,
1482         .report = mt_report,
1483 #ifdef CONFIG_PM
1484         .reset_resume = mt_reset_resume,
1485         .resume = mt_resume,
1486 #endif
1487 };
1488 module_hid_driver(mt_driver);