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