drivers/hid/hid-multitouch.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  *  HID driver for multitouch panels
   4  *
   5  *  Copyright (c) 2010-2012 Stephane Chatty <chatty@enac.fr>
   6  *  Copyright (c) 2010-2013 Benjamin Tissoires <benjamin.tissoires@gmail.com>
   7  *  Copyright (c) 2010-2012 Ecole Nationale de l'Aviation Civile, France
   8  *  Copyright (c) 2012-2013 Red Hat, Inc
   9  *
  10  *  This code is partly based on hid-egalax.c:
  11  *
  12  *  Copyright (c) 2010 Stephane Chatty <chatty@enac.fr>
  13  *  Copyright (c) 2010 Henrik Rydberg <rydberg@euromail.se>
  14  *  Copyright (c) 2010 Canonical, Ltd.
  15  *
  16  *  This code is partly based on hid-3m-pct.c:
  17  *
  18  *  Copyright (c) 2009-2010 Stephane Chatty <chatty@enac.fr>
  19  *  Copyright (c) 2010      Henrik Rydberg <rydberg@euromail.se>
  20  *  Copyright (c) 2010      Canonical, Ltd.
  21  */
  22
  23 /*
  24  */
  25
  26 /*
  27  * This driver is regularly tested thanks to the test suite in hid-tools[1].
  28  * Please run these regression tests before patching this module so that
  29  * your patch won't break existing known devices.
  30  *
  31  * [1] https://gitlab.freedesktop.org/libevdev/hid-tools
  32  */
  33
  34 #include <linux/device.h>
  35 #include <linux/hid.h>
  36 #include <linux/module.h>
  37 #include <linux/slab.h>
  38 #include <linux/input/mt.h>
  39 #include <linux/jiffies.h>
  40 #include <linux/string.h>
  41 #include <linux/timer.h>
  42
  43
  44 MODULE_AUTHOR("Stephane Chatty <chatty@enac.fr>");
  45 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
  46 MODULE_DESCRIPTION("HID multitouch panels");
  47 MODULE_LICENSE("GPL");
  48
  49 #include "hid-ids.h"
  50
  51 /* quirks to control the device */
  52 #define MT_QUIRK_NOT_SEEN_MEANS_UP      BIT(0)
  53 #define MT_QUIRK_SLOT_IS_CONTACTID      BIT(1)
  54 #define MT_QUIRK_CYPRESS                BIT(2)
  55 #define MT_QUIRK_SLOT_IS_CONTACTNUMBER  BIT(3)
  56 #define MT_QUIRK_ALWAYS_VALID           BIT(4)
  57 #define MT_QUIRK_VALID_IS_INRANGE       BIT(5)
  58 #define MT_QUIRK_VALID_IS_CONFIDENCE    BIT(6)
  59 #define MT_QUIRK_CONFIDENCE             BIT(7)
  60 #define MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE    BIT(8)
  61 #define MT_QUIRK_NO_AREA                BIT(9)
  62 #define MT_QUIRK_IGNORE_DUPLICATES      BIT(10)
  63 #define MT_QUIRK_HOVERING               BIT(11)
  64 #define MT_QUIRK_CONTACT_CNT_ACCURATE   BIT(12)
  65 #define MT_QUIRK_FORCE_GET_FEATURE      BIT(13)
  66 #define MT_QUIRK_FIX_CONST_CONTACT_ID   BIT(14)
  67 #define MT_QUIRK_TOUCH_SIZE_SCALING     BIT(15)
  68 #define MT_QUIRK_STICKY_FINGERS         BIT(16)
  69 #define MT_QUIRK_ASUS_CUSTOM_UP         BIT(17)
  70 #define MT_QUIRK_WIN8_PTP_BUTTONS       BIT(18)
  71 #define MT_QUIRK_SEPARATE_APP_REPORT    BIT(19)
  72 #define MT_QUIRK_FORCE_MULTI_INPUT      BIT(20)
  73
  74 #define MT_INPUTMODE_TOUCHSCREEN        0x02
  75 #define MT_INPUTMODE_TOUCHPAD           0x03
  76
  77 #define MT_BUTTONTYPE_CLICKPAD          0
  78
  79 enum latency_mode {
  80         HID_LATENCY_NORMAL = 0,
  81         HID_LATENCY_HIGH = 1,
  82 };
  83
  84 #define MT_IO_FLAGS_RUNNING             0
  85 #define MT_IO_FLAGS_ACTIVE_SLOTS        1
  86 #define MT_IO_FLAGS_PENDING_SLOTS       2
  87
  88 static const bool mtrue = true;         /* default for true */
  89 static const bool mfalse;               /* default for false */
  90 static const __s32 mzero;               /* default for 0 */
  91
  92 #define DEFAULT_TRUE    ((void *)&mtrue)
  93 #define DEFAULT_FALSE   ((void *)&mfalse)
  94 #define DEFAULT_ZERO    ((void *)&mzero)
  95
  96 struct mt_usages {
  97         struct list_head list;
  98         __s32 *x, *y, *cx, *cy, *p, *w, *h, *a;
  99         __s32 *contactid;       /* the device ContactID assigned to this slot */
 100         bool *tip_state;        /* is the touch valid? */
 101         bool *inrange_state;    /* is the finger in proximity of the sensor? */
 102         bool *confidence_state; /* is the touch made by a finger? */
 103 };
 104
 105 struct mt_application {
 106         struct list_head list;
 107         unsigned int application;
 108         unsigned int report_id;
 109         struct list_head mt_usages;     /* mt usages list */
 110
 111         __s32 quirks;
 112
 113         __s32 *scantime;                /* scantime reported */
 114         __s32 scantime_logical_max;     /* max value for raw scantime */
 115
 116         __s32 *raw_cc;                  /* contact count in the report */
 117         int left_button_state;          /* left button state */
 118         unsigned int mt_flags;          /* flags to pass to input-mt */
 119
 120         unsigned long *pending_palm_slots;      /* slots where we reported palm
 121                                                  * and need to release */
 122
 123         __u8 num_received;      /* how many contacts we received */
 124         __u8 num_expected;      /* expected last contact index */
 125         __u8 buttons_count;     /* number of physical buttons per touchpad */
 126         __u8 touches_by_report; /* how many touches are present in one report:
 127                                  * 1 means we should use a serial protocol
 128                                  * > 1 means hybrid (multitouch) protocol
 129                                  */
 130
 131         __s32 dev_time;         /* the scan time provided by the device */
 132         unsigned long jiffies;  /* the frame's jiffies */
 133         int timestamp;          /* the timestamp to be sent */
 134         int prev_scantime;              /* scantime reported previously */
 135
 136         bool have_contact_count;
 137 };
 138
 139 struct mt_class {
 140         __s32 name;     /* MT_CLS */
 141         __s32 quirks;
 142         __s32 sn_move;  /* Signal/noise ratio for move events */
 143         __s32 sn_width; /* Signal/noise ratio for width events */
 144         __s32 sn_height;        /* Signal/noise ratio for height events */
 145         __s32 sn_pressure;      /* Signal/noise ratio for pressure events */
 146         __u8 maxcontacts;
 147         bool is_indirect;       /* true for touchpads */
 148         bool export_all_inputs; /* do not ignore mouse, keyboards, etc... */
 149 };
 150
 151 struct mt_report_data {
 152         struct list_head list;
 153         struct hid_report *report;
 154         struct mt_application *application;
 155         bool is_mt_collection;
 156 };
 157
 158 struct mt_device {
 159         struct mt_class mtclass;        /* our mt device class */
 160         struct timer_list release_timer;        /* to release sticky fingers */
 161         struct hid_device *hdev;        /* hid_device we're attached to */
 162         unsigned long mt_io_flags;      /* mt flags (MT_IO_FLAGS_*) */
 163         __u8 inputmode_value;   /* InputMode HID feature value */
 164         __u8 maxcontacts;
 165         bool is_buttonpad;      /* is this device a button pad? */
 166         bool serial_maybe;      /* need to check for serial protocol */
 167
 168         struct list_head applications;
 169         struct list_head reports;
 170 };
 171
 172 static void mt_post_parse_default_settings(struct mt_device *td,
 173                                            struct mt_application *app);
 174 static void mt_post_parse(struct mt_device *td, struct mt_application *app);
 175
 176 /* classes of device behavior */
 177 #define MT_CLS_DEFAULT                          0x0001
 178
 179 #define MT_CLS_SERIAL                           0x0002
 180 #define MT_CLS_CONFIDENCE                       0x0003
 181 #define MT_CLS_CONFIDENCE_CONTACT_ID            0x0004
 182 #define MT_CLS_CONFIDENCE_MINUS_ONE             0x0005
 183 #define MT_CLS_DUAL_INRANGE_CONTACTID           0x0006
 184 #define MT_CLS_DUAL_INRANGE_CONTACTNUMBER       0x0007
 185 /* reserved                                     0x0008 */
 186 #define MT_CLS_INRANGE_CONTACTNUMBER            0x0009
 187 #define MT_CLS_NSMU                             0x000a
 188 /* reserved                                     0x0010 */
 189 /* reserved                                     0x0011 */
 190 #define MT_CLS_WIN_8                            0x0012
 191 #define MT_CLS_EXPORT_ALL_INPUTS                0x0013
 192 /* reserved                                     0x0014 */
 193 #define MT_CLS_WIN_8_FORCE_MULTI_INPUT          0x0015
 194
 195 /* vendor specific classes */
 196 #define MT_CLS_3M                               0x0101
 197 /* reserved                                     0x0102 */
 198 #define MT_CLS_EGALAX                           0x0103
 199 #define MT_CLS_EGALAX_SERIAL                    0x0104
 200 #define MT_CLS_TOPSEED                          0x0105
 201 #define MT_CLS_PANASONIC                        0x0106
 202 #define MT_CLS_FLATFROG                         0x0107
 203 #define MT_CLS_GENERALTOUCH_TWOFINGERS          0x0108
 204 #define MT_CLS_GENERALTOUCH_PWT_TENFINGERS      0x0109
 205 #define MT_CLS_LG                               0x010a
 206 #define MT_CLS_ASUS                             0x010b
 207 #define MT_CLS_VTL                              0x0110
 208 #define MT_CLS_GOOGLE                           0x0111
 209 #define MT_CLS_RAZER_BLADE_STEALTH              0x0112
 210 #define MT_CLS_SMART_TECH                       0x0113
 211
 212 #define MT_DEFAULT_MAXCONTACT   10
 213 #define MT_MAX_MAXCONTACT       250
 214
 215 /*
 216  * Resync device and local timestamps after that many microseconds without
 217  * receiving data.
 218  */
 219 #define MAX_TIMESTAMP_INTERVAL  1000000
 220
 221 #define MT_USB_DEVICE(v, p)     HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH, v, p)
 222 #define MT_BT_DEVICE(v, p)      HID_DEVICE(BUS_BLUETOOTH, HID_GROUP_MULTITOUCH, v, p)
 223
 224 /*
 225  * these device-dependent functions determine what slot corresponds
 226  * to a valid contact that was just read.
 227  */
 228
 229 static int cypress_compute_slot(struct mt_application *application,
 230                                 struct mt_usages *slot)
 231 {
 232         if (*slot->contactid != 0 || application->num_received == 0)
 233                 return *slot->contactid;
 234         else
 235                 return -1;
 236 }
 237
 238 static const struct mt_class mt_classes[] = {
 239         { .name = MT_CLS_DEFAULT,
 240                 .quirks = MT_QUIRK_ALWAYS_VALID |
 241                         MT_QUIRK_CONTACT_CNT_ACCURATE },
 242         { .name = MT_CLS_NSMU,
 243                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP },
 244         { .name = MT_CLS_SERIAL,
 245                 .quirks = MT_QUIRK_ALWAYS_VALID},
 246         { .name = MT_CLS_CONFIDENCE,
 247                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE },
 248         { .name = MT_CLS_CONFIDENCE_CONTACT_ID,
 249                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
 250                         MT_QUIRK_SLOT_IS_CONTACTID },
 251         { .name = MT_CLS_CONFIDENCE_MINUS_ONE,
 252                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
 253                         MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE },
 254         { .name = MT_CLS_DUAL_INRANGE_CONTACTID,
 255                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
 256                         MT_QUIRK_SLOT_IS_CONTACTID,
 257                 .maxcontacts = 2 },
 258         { .name = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
 259                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
 260                         MT_QUIRK_SLOT_IS_CONTACTNUMBER,
 261                 .maxcontacts = 2 },
 262         { .name = MT_CLS_INRANGE_CONTACTNUMBER,
 263                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
 264                         MT_QUIRK_SLOT_IS_CONTACTNUMBER },
 265         { .name = MT_CLS_WIN_8,
 266                 .quirks = MT_QUIRK_ALWAYS_VALID |
 267                         MT_QUIRK_IGNORE_DUPLICATES |
 268                         MT_QUIRK_HOVERING |
 269                         MT_QUIRK_CONTACT_CNT_ACCURATE |
 270                         MT_QUIRK_STICKY_FINGERS |
 271                         MT_QUIRK_WIN8_PTP_BUTTONS,
 272                 .export_all_inputs = true },
 273         { .name = MT_CLS_EXPORT_ALL_INPUTS,
 274                 .quirks = MT_QUIRK_ALWAYS_VALID |
 275                         MT_QUIRK_CONTACT_CNT_ACCURATE,
 276                 .export_all_inputs = true },
 277         { .name = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
 278                 .quirks = MT_QUIRK_ALWAYS_VALID |
 279                         MT_QUIRK_IGNORE_DUPLICATES |
 280                         MT_QUIRK_HOVERING |
 281                         MT_QUIRK_CONTACT_CNT_ACCURATE |
 282                         MT_QUIRK_STICKY_FINGERS |
 283                         MT_QUIRK_WIN8_PTP_BUTTONS |
 284                         MT_QUIRK_FORCE_MULTI_INPUT,
 285                 .export_all_inputs = true },
 286
 287         /*
 288          * vendor specific classes
 289          */
 290         { .name = MT_CLS_3M,
 291                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
 292                         MT_QUIRK_SLOT_IS_CONTACTID |
 293                         MT_QUIRK_TOUCH_SIZE_SCALING,
 294                 .sn_move = 2048,
 295                 .sn_width = 128,
 296                 .sn_height = 128,
 297                 .maxcontacts = 60,
 298         },
 299         { .name = MT_CLS_EGALAX,
 300                 .quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
 301                         MT_QUIRK_VALID_IS_INRANGE,
 302                 .sn_move = 4096,
 303                 .sn_pressure = 32,
 304         },
 305         { .name = MT_CLS_EGALAX_SERIAL,
 306                 .quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
 307                         MT_QUIRK_ALWAYS_VALID,
 308                 .sn_move = 4096,
 309                 .sn_pressure = 32,
 310         },
 311         { .name = MT_CLS_TOPSEED,
 312                 .quirks = MT_QUIRK_ALWAYS_VALID,
 313                 .is_indirect = true,
 314                 .maxcontacts = 2,
 315         },
 316         { .name = MT_CLS_PANASONIC,
 317                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP,
 318                 .maxcontacts = 4 },
 319         { .name = MT_CLS_GENERALTOUCH_TWOFINGERS,
 320                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
 321                         MT_QUIRK_VALID_IS_INRANGE |
 322                         MT_QUIRK_SLOT_IS_CONTACTID,
 323                 .maxcontacts = 2
 324         },
 325         { .name = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
 326                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
 327                         MT_QUIRK_SLOT_IS_CONTACTID
 328         },
 329
 330         { .name = MT_CLS_FLATFROG,
 331                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
 332                         MT_QUIRK_NO_AREA,
 333                 .sn_move = 2048,
 334                 .maxcontacts = 40,
 335         },
 336         { .name = MT_CLS_LG,
 337                 .quirks = MT_QUIRK_ALWAYS_VALID |
 338                         MT_QUIRK_FIX_CONST_CONTACT_ID |
 339                         MT_QUIRK_IGNORE_DUPLICATES |
 340                         MT_QUIRK_HOVERING |
 341                         MT_QUIRK_CONTACT_CNT_ACCURATE },
 342         { .name = MT_CLS_ASUS,
 343                 .quirks = MT_QUIRK_ALWAYS_VALID |
 344                         MT_QUIRK_CONTACT_CNT_ACCURATE |
 345                         MT_QUIRK_ASUS_CUSTOM_UP },
 346         { .name = MT_CLS_VTL,
 347                 .quirks = MT_QUIRK_ALWAYS_VALID |
 348                         MT_QUIRK_CONTACT_CNT_ACCURATE |
 349                         MT_QUIRK_FORCE_GET_FEATURE,
 350         },
 351         { .name = MT_CLS_GOOGLE,
 352                 .quirks = MT_QUIRK_ALWAYS_VALID |
 353                         MT_QUIRK_CONTACT_CNT_ACCURATE |
 354                         MT_QUIRK_SLOT_IS_CONTACTID |
 355                         MT_QUIRK_HOVERING
 356         },
 357         { .name = MT_CLS_RAZER_BLADE_STEALTH,
 358                 .quirks = MT_QUIRK_ALWAYS_VALID |
 359                         MT_QUIRK_IGNORE_DUPLICATES |
 360                         MT_QUIRK_HOVERING |
 361                         MT_QUIRK_CONTACT_CNT_ACCURATE |
 362                         MT_QUIRK_WIN8_PTP_BUTTONS,
 363         },
 364         { .name = MT_CLS_SMART_TECH,
 365                 .quirks = MT_QUIRK_ALWAYS_VALID |
 366                         MT_QUIRK_IGNORE_DUPLICATES |
 367                         MT_QUIRK_CONTACT_CNT_ACCURATE |
 368                         MT_QUIRK_SEPARATE_APP_REPORT,
 369         },
 370         { }
 371 };
 372
 373 static ssize_t mt_show_quirks(struct device *dev,
 374                            struct device_attribute *attr,
 375                            char *buf)
 376 {
 377         struct hid_device *hdev = to_hid_device(dev);
 378         struct mt_device *td = hid_get_drvdata(hdev);
 379
 380         return sprintf(buf, "%u\n", td->mtclass.quirks);
 381 }
 382
 383 static ssize_t mt_set_quirks(struct device *dev,
 384                           struct device_attribute *attr,
 385                           const char *buf, size_t count)
 386 {
 387         struct hid_device *hdev = to_hid_device(dev);
 388         struct mt_device *td = hid_get_drvdata(hdev);
 389         struct mt_application *application;
 390
 391         unsigned long val;
 392
 393         if (kstrtoul(buf, 0, &val))
 394                 return -EINVAL;
 395
 396         td->mtclass.quirks = val;
 397
 398         list_for_each_entry(application, &td->applications, list) {
 399                 application->quirks = val;
 400                 if (!application->have_contact_count)
 401                         application->quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
 402         }
 403
 404         return count;
 405 }
 406
 407 static DEVICE_ATTR(quirks, S_IWUSR | S_IRUGO, mt_show_quirks, mt_set_quirks);
 408
 409 static struct attribute *sysfs_attrs[] = {
 410         &dev_attr_quirks.attr,
 411         NULL
 412 };
 413
 414 static const struct attribute_group mt_attribute_group = {
 415         .attrs = sysfs_attrs
 416 };
 417
 418 static void mt_get_feature(struct hid_device *hdev, struct hid_report *report)
 419 {
 420         int ret;
 421         u32 size = hid_report_len(report);
 422         u8 *buf;
 423
 424         /*
 425          * Do not fetch the feature report if the device has been explicitly
 426          * marked as non-capable.
 427          */
 428         if (hdev->quirks & HID_QUIRK_NO_INIT_REPORTS)
 429                 return;
 430
 431         buf = hid_alloc_report_buf(report, GFP_KERNEL);
 432         if (!buf)
 433                 return;
 434
 435         ret = hid_hw_raw_request(hdev, report->id, buf, size,
 436                                  HID_FEATURE_REPORT, HID_REQ_GET_REPORT);
 437         if (ret < 0) {
 438                 dev_warn(&hdev->dev, "failed to fetch feature %d\n",
 439                          report->id);
 440         } else {
 441                 ret = hid_report_raw_event(hdev, HID_FEATURE_REPORT, buf,
 442                                            size, 0);
 443                 if (ret)
 444                         dev_warn(&hdev->dev, "failed to report feature\n");
 445         }
 446
 447         kfree(buf);
 448 }
 449
 450 static void mt_feature_mapping(struct hid_device *hdev,
 451                 struct hid_field *field, struct hid_usage *usage)
 452 {
 453         struct mt_device *td = hid_get_drvdata(hdev);
 454
 455         switch (usage->hid) {
 456         case HID_DG_CONTACTMAX:
 457                 mt_get_feature(hdev, field->report);
 458
 459                 td->maxcontacts = field->value[0];
 460                 if (!td->maxcontacts &&
 461                     field->logical_maximum <= MT_MAX_MAXCONTACT)
 462                         td->maxcontacts = field->logical_maximum;
 463                 if (td->mtclass.maxcontacts)
 464                         /* check if the maxcontacts is given by the class */
 465                         td->maxcontacts = td->mtclass.maxcontacts;
 466
 467                 break;
 468         case HID_DG_BUTTONTYPE:
 469                 if (usage->usage_index >= field->report_count) {
 470                         dev_err(&hdev->dev, "HID_DG_BUTTONTYPE out of range\n");
 471                         break;
 472                 }
 473
 474                 mt_get_feature(hdev, field->report);
 475                 if (field->value[usage->usage_index] == MT_BUTTONTYPE_CLICKPAD)
 476                         td->is_buttonpad = true;
 477
 478                 break;
 479         case 0xff0000c5:
 480                 /* Retrieve the Win8 blob once to enable some devices */
 481                 if (usage->usage_index == 0)
 482                         mt_get_feature(hdev, field->report);
 483                 break;
 484         }
 485 }
 486
 487 static void set_abs(struct input_dev *input, unsigned int code,
 488                 struct hid_field *field, int snratio)
 489 {
 490         int fmin = field->logical_minimum;
 491         int fmax = field->logical_maximum;
 492         int fuzz = snratio ? (fmax - fmin) / snratio : 0;
 493         input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
 494         input_abs_set_res(input, code, hidinput_calc_abs_res(field, code));
 495 }
 496
 497 static struct mt_usages *mt_allocate_usage(struct hid_device *hdev,
 498                                            struct mt_application *application)
 499 {
 500         struct mt_usages *usage;
 501
 502         usage = devm_kzalloc(&hdev->dev, sizeof(*usage), GFP_KERNEL);
 503         if (!usage)
 504                 return NULL;
 505
 506         /* set some defaults so we do not need to check for null pointers */
 507         usage->x = DEFAULT_ZERO;
 508         usage->y = DEFAULT_ZERO;
 509         usage->cx = DEFAULT_ZERO;
 510         usage->cy = DEFAULT_ZERO;
 511         usage->p = DEFAULT_ZERO;
 512         usage->w = DEFAULT_ZERO;
 513         usage->h = DEFAULT_ZERO;
 514         usage->a = DEFAULT_ZERO;
 515         usage->contactid = DEFAULT_ZERO;
 516         usage->tip_state = DEFAULT_FALSE;
 517         usage->inrange_state = DEFAULT_FALSE;
 518         usage->confidence_state = DEFAULT_TRUE;
 519
 520         list_add_tail(&usage->list, &application->mt_usages);
 521
 522         return usage;
 523 }
 524
 525 static struct mt_application *mt_allocate_application(struct mt_device *td,
 526                                                       struct hid_report *report)
 527 {
 528         unsigned int application = report->application;
 529         struct mt_application *mt_application;
 530
 531         mt_application = devm_kzalloc(&td->hdev->dev, sizeof(*mt_application),
 532                                       GFP_KERNEL);
 533         if (!mt_application)
 534                 return NULL;
 535
 536         mt_application->application = application;
 537         INIT_LIST_HEAD(&mt_application->mt_usages);
 538
 539         if (application == HID_DG_TOUCHSCREEN)
 540                 mt_application->mt_flags |= INPUT_MT_DIRECT;
 541
 542         /*
 543          * Model touchscreens providing buttons as touchpads.
 544          */
 545         if (application == HID_DG_TOUCHPAD) {
 546                 mt_application->mt_flags |= INPUT_MT_POINTER;
 547                 td->inputmode_value = MT_INPUTMODE_TOUCHPAD;
 548         }
 549
 550         mt_application->scantime = DEFAULT_ZERO;
 551         mt_application->raw_cc = DEFAULT_ZERO;
 552         mt_application->quirks = td->mtclass.quirks;
 553         mt_application->report_id = report->id;
 554
 555         list_add_tail(&mt_application->list, &td->applications);
 556
 557         return mt_application;
 558 }
 559
 560 static struct mt_application *mt_find_application(struct mt_device *td,
 561                                                   struct hid_report *report)
 562 {
 563         unsigned int application = report->application;
 564         struct mt_application *tmp, *mt_application = NULL;
 565
 566         list_for_each_entry(tmp, &td->applications, list) {
 567                 if (application == tmp->application) {
 568                         if (!(td->mtclass.quirks & MT_QUIRK_SEPARATE_APP_REPORT) ||
 569                             tmp->report_id == report->id) {
 570                                 mt_application = tmp;
 571                                 break;
 572                         }
 573                 }
 574         }
 575
 576         if (!mt_application)
 577                 mt_application = mt_allocate_application(td, report);
 578
 579         return mt_application;
 580 }
 581
 582 static struct mt_report_data *mt_allocate_report_data(struct mt_device *td,
 583                                                       struct hid_report *report)
 584 {
 585         struct mt_report_data *rdata;
 586         struct hid_field *field;
 587         int r, n;
 588
 589         rdata = devm_kzalloc(&td->hdev->dev, sizeof(*rdata), GFP_KERNEL);
 590         if (!rdata)
 591                 return NULL;
 592
 593         rdata->report = report;
 594         rdata->application = mt_find_application(td, report);
 595
 596         if (!rdata->application) {
 597                 devm_kfree(&td->hdev->dev, rdata);
 598                 return NULL;
 599         }
 600
 601         for (r = 0; r < report->maxfield; r++) {
 602                 field = report->field[r];
 603
 604                 if (!(HID_MAIN_ITEM_VARIABLE & field->flags))
 605                         continue;
 606
 607                 if (field->logical == HID_DG_FINGER || td->hdev->group != HID_GROUP_MULTITOUCH_WIN_8) {
 608                         for (n = 0; n < field->report_count; n++) {
 609                                 if (field->usage[n].hid == HID_DG_CONTACTID) {
 610                                         rdata->is_mt_collection = true;
 611                                         break;
 612                                 }
 613                         }
 614                 }
 615         }
 616
 617         list_add_tail(&rdata->list, &td->reports);
 618
 619         return rdata;
 620 }
 621
 622 static struct mt_report_data *mt_find_report_data(struct mt_device *td,
 623                                                   struct hid_report *report)
 624 {
 625         struct mt_report_data *tmp, *rdata = NULL;
 626
 627         list_for_each_entry(tmp, &td->reports, list) {
 628                 if (report == tmp->report) {
 629                         rdata = tmp;
 630                         break;
 631                 }
 632         }
 633
 634         if (!rdata)
 635                 rdata = mt_allocate_report_data(td, report);
 636
 637         return rdata;
 638 }
 639
 640 static void mt_store_field(struct hid_device *hdev,
 641                            struct mt_application *application,
 642                            __s32 *value,
 643                            size_t offset)
 644 {
 645         struct mt_usages *usage;
 646         __s32 **target;
 647
 648         if (list_empty(&application->mt_usages))
 649                 usage = mt_allocate_usage(hdev, application);
 650         else
 651                 usage = list_last_entry(&application->mt_usages,
 652                                         struct mt_usages,
 653                                         list);
 654
 655         if (!usage)
 656                 return;
 657
 658         target = (__s32 **)((char *)usage + offset);
 659
 660         /* the value has already been filled, create a new slot */
 661         if (*target != DEFAULT_TRUE &&
 662             *target != DEFAULT_FALSE &&
 663             *target != DEFAULT_ZERO) {
 664                 if (usage->contactid == DEFAULT_ZERO ||
 665                     usage->x == DEFAULT_ZERO ||
 666                     usage->y == DEFAULT_ZERO) {
 667                         hid_dbg(hdev,
 668                                 "ignoring duplicate usage on incomplete");
 669                         return;
 670                 }
 671                 usage = mt_allocate_usage(hdev, application);
 672                 if (!usage)
 673                         return;
 674
 675                 target = (__s32 **)((char *)usage + offset);
 676         }
 677
 678         *target = value;
 679 }
 680
 681 #define MT_STORE_FIELD(__name)                                          \
 682         mt_store_field(hdev, app,                                       \
 683                        &field->value[usage->usage_index],               \
 684                        offsetof(struct mt_usages, __name))
 685
 686 static int mt_touch_input_mapping(struct hid_device *hdev, struct hid_input *hi,
 687                 struct hid_field *field, struct hid_usage *usage,
 688                 unsigned long **bit, int *max, struct mt_application *app)
 689 {
 690         struct mt_device *td = hid_get_drvdata(hdev);
 691         struct mt_class *cls = &td->mtclass;
 692         int code;
 693         struct hid_usage *prev_usage = NULL;
 694
 695         /*
 696          * Model touchscreens providing buttons as touchpads.
 697          */
 698         if (field->application == HID_DG_TOUCHSCREEN &&
 699             (usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON) {
 700                 app->mt_flags |= INPUT_MT_POINTER;
 701                 td->inputmode_value = MT_INPUTMODE_TOUCHPAD;
 702         }
 703
 704         /* count the buttons on touchpads */
 705         if ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON)
 706                 app->buttons_count++;
 707
 708         if (usage->usage_index)
 709                 prev_usage = &field->usage[usage->usage_index - 1];
 710
 711         switch (usage->hid & HID_USAGE_PAGE) {
 712
 713         case HID_UP_GENDESK:
 714                 switch (usage->hid) {
 715                 case HID_GD_X:
 716                         if (prev_usage && (prev_usage->hid == usage->hid)) {
 717                                 code = ABS_MT_TOOL_X;
 718                                 MT_STORE_FIELD(cx);
 719                         } else {
 720                                 code = ABS_MT_POSITION_X;
 721                                 MT_STORE_FIELD(x);
 722                         }
 723
 724                         set_abs(hi->input, code, field, cls->sn_move);
 725
 726                         /*
 727                          * A system multi-axis that exports X and Y has a high
 728                          * chance of being used directly on a surface
 729                          */
 730                         if (field->application == HID_GD_SYSTEM_MULTIAXIS) {
 731                                 __set_bit(INPUT_PROP_DIRECT,
 732                                           hi->input->propbit);
 733                                 input_set_abs_params(hi->input,
 734                                                      ABS_MT_TOOL_TYPE,
 735                                                      MT_TOOL_DIAL,
 736                                                      MT_TOOL_DIAL, 0, 0);
 737                         }
 738
 739                         return 1;
 740                 case HID_GD_Y:
 741                         if (prev_usage && (prev_usage->hid == usage->hid)) {
 742                                 code = ABS_MT_TOOL_Y;
 743                                 MT_STORE_FIELD(cy);
 744                         } else {
 745                                 code = ABS_MT_POSITION_Y;
 746                                 MT_STORE_FIELD(y);
 747                         }
 748
 749                         set_abs(hi->input, code, field, cls->sn_move);
 750
 751                         return 1;
 752                 }
 753                 return 0;
 754
 755         case HID_UP_DIGITIZER:
 756                 switch (usage->hid) {
 757                 case HID_DG_INRANGE:
 758                         if (app->quirks & MT_QUIRK_HOVERING) {
 759                                 input_set_abs_params(hi->input,
 760                                         ABS_MT_DISTANCE, 0, 1, 0, 0);
 761                         }
 762                         MT_STORE_FIELD(inrange_state);
 763                         return 1;
 764                 case HID_DG_CONFIDENCE:
 765                         if ((cls->name == MT_CLS_WIN_8 ||
 766                              cls->name == MT_CLS_WIN_8_FORCE_MULTI_INPUT) &&
 767                                 (field->application == HID_DG_TOUCHPAD ||
 768                                  field->application == HID_DG_TOUCHSCREEN))
 769                                 app->quirks |= MT_QUIRK_CONFIDENCE;
 770
 771                         if (app->quirks & MT_QUIRK_CONFIDENCE)
 772                                 input_set_abs_params(hi->input,
 773                                                      ABS_MT_TOOL_TYPE,
 774                                                      MT_TOOL_FINGER,
 775                                                      MT_TOOL_PALM, 0, 0);
 776
 777                         MT_STORE_FIELD(confidence_state);
 778                         return 1;
 779                 case HID_DG_TIPSWITCH:
 780                         if (field->application != HID_GD_SYSTEM_MULTIAXIS)
 781                                 input_set_capability(hi->input,
 782                                                      EV_KEY, BTN_TOUCH);
 783                         MT_STORE_FIELD(tip_state);
 784                         return 1;
 785                 case HID_DG_CONTACTID:
 786                         MT_STORE_FIELD(contactid);
 787                         app->touches_by_report++;
 788                         return 1;
 789                 case HID_DG_WIDTH:
 790                         if (!(app->quirks & MT_QUIRK_NO_AREA))
 791                                 set_abs(hi->input, ABS_MT_TOUCH_MAJOR, field,
 792                                         cls->sn_width);
 793                         MT_STORE_FIELD(w);
 794                         return 1;
 795                 case HID_DG_HEIGHT:
 796                         if (!(app->quirks & MT_QUIRK_NO_AREA)) {
 797                                 set_abs(hi->input, ABS_MT_TOUCH_MINOR, field,
 798                                         cls->sn_height);
 799
 800                                 /*
 801                                  * Only set ABS_MT_ORIENTATION if it is not
 802                                  * already set by the HID_DG_AZIMUTH usage.
 803                                  */
 804                                 if (!test_bit(ABS_MT_ORIENTATION,
 805                                                 hi->input->absbit))
 806                                         input_set_abs_params(hi->input,
 807                                                 ABS_MT_ORIENTATION, 0, 1, 0, 0);
 808                         }
 809                         MT_STORE_FIELD(h);
 810                         return 1;
 811                 case HID_DG_TIPPRESSURE:
 812                         set_abs(hi->input, ABS_MT_PRESSURE, field,
 813                                 cls->sn_pressure);
 814                         MT_STORE_FIELD(p);
 815                         return 1;
 816                 case HID_DG_SCANTIME:
 817                         input_set_capability(hi->input, EV_MSC, MSC_TIMESTAMP);
 818                         app->scantime = &field->value[usage->usage_index];
 819                         app->scantime_logical_max = field->logical_maximum;
 820                         return 1;
 821                 case HID_DG_CONTACTCOUNT:
 822                         app->have_contact_count = true;
 823                         app->raw_cc = &field->value[usage->usage_index];
 824                         return 1;
 825                 case HID_DG_AZIMUTH:
 826                         /*
 827                          * Azimuth has the range of [0, MAX) representing a full
 828                          * revolution. Set ABS_MT_ORIENTATION to a quarter of
 829                          * MAX according the definition of ABS_MT_ORIENTATION
 830                          */
 831                         input_set_abs_params(hi->input, ABS_MT_ORIENTATION,
 832                                 -field->logical_maximum / 4,
 833                                 field->logical_maximum / 4,
 834                                 cls->sn_move ?
 835                                 field->logical_maximum / cls->sn_move : 0, 0);
 836                         MT_STORE_FIELD(a);
 837                         return 1;
 838                 case HID_DG_CONTACTMAX:
 839                         /* contact max are global to the report */
 840                         return -1;
 841                 case HID_DG_TOUCH:
 842                         /* Legacy devices use TIPSWITCH and not TOUCH.
 843                          * Let's just ignore this field. */
 844                         return -1;
 845                 }
 846                 /* let hid-input decide for the others */
 847                 return 0;
 848
 849         case HID_UP_BUTTON:
 850                 code = BTN_MOUSE + ((usage->hid - 1) & HID_USAGE);
 851                 /*
 852                  * MS PTP spec says that external buttons left and right have
 853                  * usages 2 and 3.
 854                  */
 855                 if ((app->quirks & MT_QUIRK_WIN8_PTP_BUTTONS) &&
 856                     field->application == HID_DG_TOUCHPAD &&
 857                     (usage->hid & HID_USAGE) > 1)
 858                         code--;
 859
 860                 if (field->application == HID_GD_SYSTEM_MULTIAXIS)
 861                         code = BTN_0  + ((usage->hid - 1) & HID_USAGE);
 862
 863                 hid_map_usage(hi, usage, bit, max, EV_KEY, code);
 864                 if (!*bit)
 865                         return -1;
 866                 input_set_capability(hi->input, EV_KEY, code);
 867                 return 1;
 868
 869         case 0xff000000:
 870                 /* we do not want to map these: no input-oriented meaning */
 871                 return -1;
 872         }
 873
 874         return 0;
 875 }
 876
 877 static int mt_compute_slot(struct mt_device *td, struct mt_application *app,
 878                            struct mt_usages *slot,
 879                            struct input_dev *input)
 880 {
 881         __s32 quirks = app->quirks;
 882
 883         if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
 884                 return *slot->contactid;
 885
 886         if (quirks & MT_QUIRK_CYPRESS)
 887                 return cypress_compute_slot(app, slot);
 888
 889         if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
 890                 return app->num_received;
 891
 892         if (quirks & MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE)
 893                 return *slot->contactid - 1;
 894
 895         return input_mt_get_slot_by_key(input, *slot->contactid);
 896 }
 897
 898 static void mt_release_pending_palms(struct mt_device *td,
 899                                      struct mt_application *app,
 900                                      struct input_dev *input)
 901 {
 902         int slotnum;
 903         bool need_sync = false;
 904
 905         for_each_set_bit(slotnum, app->pending_palm_slots, td->maxcontacts) {
 906                 clear_bit(slotnum, app->pending_palm_slots);
 907
 908                 input_mt_slot(input, slotnum);
 909                 input_mt_report_slot_inactive(input);
 910
 911                 need_sync = true;
 912         }
 913
 914         if (need_sync) {
 915                 input_mt_sync_frame(input);
 916                 input_sync(input);
 917         }
 918 }
 919
 920 /*
 921  * this function is called when a whole packet has been received and processed,
 922  * so that it can decide what to send to the input layer.
 923  */
 924 static void mt_sync_frame(struct mt_device *td, struct mt_application *app,
 925                           struct input_dev *input)
 926 {
 927         if (app->quirks & MT_QUIRK_WIN8_PTP_BUTTONS)
 928                 input_event(input, EV_KEY, BTN_LEFT, app->left_button_state);
 929
 930         input_mt_sync_frame(input);
 931         input_event(input, EV_MSC, MSC_TIMESTAMP, app->timestamp);
 932         input_sync(input);
 933
 934         mt_release_pending_palms(td, app, input);
 935
 936         app->num_received = 0;
 937         app->left_button_state = 0;
 938
 939         if (test_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags))
 940                 set_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags);
 941         else
 942                 clear_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags);
 943         clear_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags);
 944 }
 945
 946 static int mt_compute_timestamp(struct mt_application *app, __s32 value)
 947 {
 948         long delta = value - app->prev_scantime;
 949         unsigned long jdelta = jiffies_to_usecs(jiffies - app->jiffies);
 950
 951         app->jiffies = jiffies;
 952
 953         if (delta < 0)
 954                 delta += app->scantime_logical_max;
 955
 956         /* HID_DG_SCANTIME is expressed in 100us, we want it in us. */
 957         delta *= 100;
 958
 959         if (jdelta > MAX_TIMESTAMP_INTERVAL)
 960                 /* No data received for a while, resync the timestamp. */
 961                 return 0;
 962         else
 963                 return app->timestamp + delta;
 964 }
 965
 966 static int mt_touch_event(struct hid_device *hid, struct hid_field *field,
 967                                 struct hid_usage *usage, __s32 value)
 968 {
 969         /* we will handle the hidinput part later, now remains hiddev */
 970         if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
 971                 hid->hiddev_hid_event(hid, field, usage, value);
 972
 973         return 1;
 974 }
 975
 976 static int mt_process_slot(struct mt_device *td, struct input_dev *input,
 977                             struct mt_application *app,
 978                             struct mt_usages *slot)
 979 {
 980         struct input_mt *mt = input->mt;
 981         __s32 quirks = app->quirks;
 982         bool valid = true;
 983         bool confidence_state = true;
 984         bool inrange_state = false;
 985         int active;
 986         int slotnum;
 987         int tool = MT_TOOL_FINGER;
 988
 989         if (!slot)
 990                 return -EINVAL;
 991
 992         if ((quirks & MT_QUIRK_CONTACT_CNT_ACCURATE) &&
 993             app->num_received >= app->num_expected)
 994                 return -EAGAIN;
 995
 996         if (!(quirks & MT_QUIRK_ALWAYS_VALID)) {
 997                 if (quirks & MT_QUIRK_VALID_IS_INRANGE)
 998                         valid = *slot->inrange_state;
 999                 if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
1000                         valid = *slot->tip_state;
1001                 if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
1002                         valid = *slot->confidence_state;
1003
1004                 if (!valid)
1005                         return 0;
1006         }
1007
1008         slotnum = mt_compute_slot(td, app, slot, input);
1009         if (slotnum < 0 || slotnum >= td->maxcontacts)
1010                 return 0;
1011
1012         if ((quirks & MT_QUIRK_IGNORE_DUPLICATES) && mt) {
1013                 struct input_mt_slot *i_slot = &mt->slots[slotnum];
1014
1015                 if (input_mt_is_active(i_slot) &&
1016                     input_mt_is_used(mt, i_slot))
1017                         return -EAGAIN;
1018         }
1019
1020         if (quirks & MT_QUIRK_CONFIDENCE)
1021                 confidence_state = *slot->confidence_state;
1022
1023         if (quirks & MT_QUIRK_HOVERING)
1024                 inrange_state = *slot->inrange_state;
1025
1026         active = *slot->tip_state || inrange_state;
1027
1028         if (app->application == HID_GD_SYSTEM_MULTIAXIS)
1029                 tool = MT_TOOL_DIAL;
1030         else if (unlikely(!confidence_state)) {
1031                 tool = MT_TOOL_PALM;
1032                 if (!active && mt &&
1033                     input_mt_is_active(&mt->slots[slotnum])) {
1034                         /*
1035                          * The non-confidence was reported for
1036                          * previously valid contact that is also no
1037                          * longer valid. We can't simply report
1038                          * lift-off as userspace will not be aware
1039                          * of non-confidence, so we need to split
1040                          * it into 2 events: active MT_TOOL_PALM
1041                          * and a separate liftoff.
1042                          */
1043                         active = true;
1044                         set_bit(slotnum, app->pending_palm_slots);
1045                 }
1046         }
1047
1048         input_mt_slot(input, slotnum);
1049         input_mt_report_slot_state(input, tool, active);
1050         if (active) {
1051                 /* this finger is in proximity of the sensor */
1052                 int wide = (*slot->w > *slot->h);
1053                 int major = max(*slot->w, *slot->h);
1054                 int minor = min(*slot->w, *slot->h);
1055                 int orientation = wide;
1056                 int max_azimuth;
1057                 int azimuth;
1058
1059                 if (slot->a != DEFAULT_ZERO) {
1060                         /*
1061                          * Azimuth is counter-clockwise and ranges from [0, MAX)
1062                          * (a full revolution). Convert it to clockwise ranging
1063                          * [-MAX/2, MAX/2].
1064                          *
1065                          * Note that ABS_MT_ORIENTATION require us to report
1066                          * the limit of [-MAX/4, MAX/4], but the value can go
1067                          * out of range to [-MAX/2, MAX/2] to report an upside
1068                          * down ellipsis.
1069                          */
1070                         azimuth = *slot->a;
1071                         max_azimuth = input_abs_get_max(input,
1072                                                         ABS_MT_ORIENTATION);
1073                         if (azimuth > max_azimuth * 2)
1074                                 azimuth -= max_azimuth * 4;
1075                         orientation = -azimuth;
1076                 }
1077
1078                 if (quirks & MT_QUIRK_TOUCH_SIZE_SCALING) {
1079                         /*
1080                          * divided by two to match visual scale of touch
1081                          * for devices with this quirk
1082                          */
1083                         major = major >> 1;
1084                         minor = minor >> 1;
1085                 }
1086
1087                 input_event(input, EV_ABS, ABS_MT_POSITION_X, *slot->x);
1088                 input_event(input, EV_ABS, ABS_MT_POSITION_Y, *slot->y);
1089                 input_event(input, EV_ABS, ABS_MT_TOOL_X, *slot->cx);
1090                 input_event(input, EV_ABS, ABS_MT_TOOL_Y, *slot->cy);
1091                 input_event(input, EV_ABS, ABS_MT_DISTANCE, !*slot->tip_state);
1092                 input_event(input, EV_ABS, ABS_MT_ORIENTATION, orientation);
1093                 input_event(input, EV_ABS, ABS_MT_PRESSURE, *slot->p);
1094                 input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
1095                 input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
1096
1097                 set_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags);
1098         }
1099
1100         return 0;
1101 }
1102
1103 static void mt_process_mt_event(struct hid_device *hid,
1104                                 struct mt_application *app,
1105                                 struct hid_field *field,
1106                                 struct hid_usage *usage,
1107                                 __s32 value,
1108                                 bool first_packet)
1109 {
1110         __s32 quirks = app->quirks;
1111         struct input_dev *input = field->hidinput->input;
1112
1113         if (!usage->type || !(hid->claimed & HID_CLAIMED_INPUT))
1114                 return;
1115
1116         if (quirks & MT_QUIRK_WIN8_PTP_BUTTONS) {
1117
1118                 /*
1119                  * For Win8 PTP touchpads we should only look at
1120                  * non finger/touch events in the first_packet of a
1121                  * (possible) multi-packet frame.
1122                  */
1123                 if (!first_packet)
1124                         return;
1125
1126                 /*
1127                  * For Win8 PTP touchpads we map both the clickpad click
1128                  * and any "external" left buttons to BTN_LEFT if a
1129                  * device claims to have both we need to report 1 for
1130                  * BTN_LEFT if either is pressed, so we or all values
1131                  * together and report the result in mt_sync_frame().
1132                  */
1133                 if (usage->type == EV_KEY && usage->code == BTN_LEFT) {
1134                         app->left_button_state |= value;
1135                         return;
1136                 }
1137         }
1138
1139         input_event(input, usage->type, usage->code, value);
1140 }
1141
1142 static void mt_touch_report(struct hid_device *hid,
1143                             struct mt_report_data *rdata)
1144 {
1145         struct mt_device *td = hid_get_drvdata(hid);
1146         struct hid_report *report = rdata->report;
1147         struct mt_application *app = rdata->application;
1148         struct hid_field *field;
1149         struct input_dev *input;
1150         struct mt_usages *slot;
1151         bool first_packet;
1152         unsigned count;
1153         int r, n;
1154         int scantime = 0;
1155         int contact_count = -1;
1156
1157         /* sticky fingers release in progress, abort */
1158         if (test_and_set_bit_lock(MT_IO_FLAGS_RUNNING, &td->mt_io_flags))
1159                 return;
1160
1161         scantime = *app->scantime;
1162         app->timestamp = mt_compute_timestamp(app, scantime);
1163         if (app->raw_cc != DEFAULT_ZERO)
1164                 contact_count = *app->raw_cc;
1165
1166         /*
1167          * Includes multi-packet support where subsequent
1168          * packets are sent with zero contactcount.
1169          */
1170         if (contact_count >= 0) {
1171                 /*
1172                  * For Win8 PTPs the first packet (td->num_received == 0) may
1173                  * have a contactcount of 0 if there only is a button event.
1174                  * We double check that this is not a continuation packet
1175                  * of a possible multi-packet frame be checking that the
1176                  * timestamp has changed.
1177                  */
1178                 if ((app->quirks & MT_QUIRK_WIN8_PTP_BUTTONS) &&
1179                     app->num_received == 0 &&
1180                     app->prev_scantime != scantime)
1181                         app->num_expected = contact_count;
1182                 /* A non 0 contact count always indicates a first packet */
1183                 else if (contact_count)
1184                         app->num_expected = contact_count;
1185         }
1186         app->prev_scantime = scantime;
1187
1188         first_packet = app->num_received == 0;
1189
1190         input = report->field[0]->hidinput->input;
1191
1192         list_for_each_entry(slot, &app->mt_usages, list) {
1193                 if (!mt_process_slot(td, input, app, slot))
1194                         app->num_received++;
1195         }
1196
1197         for (r = 0; r < report->maxfield; r++) {
1198                 field = report->field[r];
1199                 count = field->report_count;
1200
1201                 if (!(HID_MAIN_ITEM_VARIABLE & field->flags))
1202                         continue;
1203
1204                 for (n = 0; n < count; n++)
1205                         mt_process_mt_event(hid, app, field,
1206                                             &field->usage[n], field->value[n],
1207                                             first_packet);
1208         }
1209
1210         if (app->num_received >= app->num_expected)
1211                 mt_sync_frame(td, app, input);
1212
1213         /*
1214          * Windows 8 specs says 2 things:
1215          * - once a contact has been reported, it has to be reported in each
1216          *   subsequent report
1217          * - the report rate when fingers are present has to be at least
1218          *   the refresh rate of the screen, 60 or 120 Hz
1219          *
1220          * I interprete this that the specification forces a report rate of
1221          * at least 60 Hz for a touchscreen to be certified.
1222          * Which means that if we do not get a report whithin 16 ms, either
1223          * something wrong happens, either the touchscreen forgets to send
1224          * a release. Taking a reasonable margin allows to remove issues
1225          * with USB communication or the load of the machine.
1226          *
1227          * Given that Win 8 devices are forced to send a release, this will
1228          * only affect laggish machines and the ones that have a firmware
1229          * defect.
1230          */
1231         if (app->quirks & MT_QUIRK_STICKY_FINGERS) {
1232                 if (test_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags))
1233                         mod_timer(&td->release_timer,
1234                                   jiffies + msecs_to_jiffies(100));
1235                 else
1236                         del_timer(&td->release_timer);
1237         }
1238
1239         clear_bit_unlock(MT_IO_FLAGS_RUNNING, &td->mt_io_flags);
1240 }
1241
1242 static int mt_touch_input_configured(struct hid_device *hdev,
1243                                      struct hid_input *hi,
1244                                      struct mt_application *app)
1245 {
1246         struct mt_device *td = hid_get_drvdata(hdev);
1247         struct mt_class *cls = &td->mtclass;
1248         struct input_dev *input = hi->input;
1249         int ret;
1250
1251         if (!td->maxcontacts)
1252                 td->maxcontacts = MT_DEFAULT_MAXCONTACT;
1253
1254         mt_post_parse(td, app);
1255         if (td->serial_maybe)
1256                 mt_post_parse_default_settings(td, app);
1257
1258         if (cls->is_indirect)
1259                 app->mt_flags |= INPUT_MT_POINTER;
1260
1261         if (app->quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
1262                 app->mt_flags |= INPUT_MT_DROP_UNUSED;
1263
1264         /* check for clickpads */
1265         if ((app->mt_flags & INPUT_MT_POINTER) &&
1266             (app->buttons_count == 1))
1267                 td->is_buttonpad = true;
1268
1269         if (td->is_buttonpad)
1270                 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
1271
1272         app->pending_palm_slots = devm_kcalloc(&hi->input->dev,
1273                                                BITS_TO_LONGS(td->maxcontacts),
1274                                                sizeof(long),
1275                                                GFP_KERNEL);
1276         if (!app->pending_palm_slots)
1277                 return -ENOMEM;
1278
1279         ret = input_mt_init_slots(input, td->maxcontacts, app->mt_flags);
1280         if (ret)
1281                 return ret;
1282
1283         app->mt_flags = 0;
1284         return 0;
1285 }
1286
1287 #define mt_map_key_clear(c)     hid_map_usage_clear(hi, usage, bit, \
1288                                                     max, EV_KEY, (c))
1289 static int mt_input_mapping(struct hid_device *hdev, struct hid_input *hi,
1290                 struct hid_field *field, struct hid_usage *usage,
1291                 unsigned long **bit, int *max)
1292 {
1293         struct mt_device *td = hid_get_drvdata(hdev);
1294         struct mt_application *application;
1295         struct mt_report_data *rdata;
1296
1297         rdata = mt_find_report_data(td, field->report);
1298         if (!rdata) {
1299                 hid_err(hdev, "failed to allocate data for report\n");
1300                 return 0;
1301         }
1302
1303         application = rdata->application;
1304
1305         /*
1306          * If mtclass.export_all_inputs is not set, only map fields from
1307          * TouchScreen or TouchPad collections. We need to ignore fields
1308          * that belong to other collections such as Mouse that might have
1309          * the same GenericDesktop usages.
1310          */
1311         if (!td->mtclass.export_all_inputs &&
1312             field->application != HID_DG_TOUCHSCREEN &&
1313             field->application != HID_DG_PEN &&
1314             field->application != HID_DG_TOUCHPAD &&
1315             field->application != HID_GD_KEYBOARD &&
1316             field->application != HID_GD_SYSTEM_CONTROL &&
1317             field->application != HID_CP_CONSUMER_CONTROL &&
1318             field->application != HID_GD_WIRELESS_RADIO_CTLS &&
1319             field->application != HID_GD_SYSTEM_MULTIAXIS &&
1320             !(field->application == HID_VD_ASUS_CUSTOM_MEDIA_KEYS &&
1321               application->quirks & MT_QUIRK_ASUS_CUSTOM_UP))
1322                 return -1;
1323
1324         /*
1325          * Some Asus keyboard+touchpad devices have the hotkeys defined in the
1326          * touchpad report descriptor. We need to treat these as an array to
1327          * map usages to input keys.
1328          */
1329         if (field->application == HID_VD_ASUS_CUSTOM_MEDIA_KEYS &&
1330             application->quirks & MT_QUIRK_ASUS_CUSTOM_UP &&
1331             (usage->hid & HID_USAGE_PAGE) == HID_UP_CUSTOM) {
1332                 set_bit(EV_REP, hi->input->evbit);
1333                 if (field->flags & HID_MAIN_ITEM_VARIABLE)
1334                         field->flags &= ~HID_MAIN_ITEM_VARIABLE;
1335                 switch (usage->hid & HID_USAGE) {
1336                 case 0x10: mt_map_key_clear(KEY_BRIGHTNESSDOWN);        break;
1337                 case 0x20: mt_map_key_clear(KEY_BRIGHTNESSUP);          break;
1338                 case 0x35: mt_map_key_clear(KEY_DISPLAY_OFF);           break;
1339                 case 0x6b: mt_map_key_clear(KEY_F21);                   break;
1340                 case 0x6c: mt_map_key_clear(KEY_SLEEP);                 break;
1341                 default:
1342                         return -1;
1343                 }
1344                 return 1;
1345         }
1346
1347         if (rdata->is_mt_collection)
1348                 return mt_touch_input_mapping(hdev, hi, field, usage, bit, max,
1349                                               application);
1350
1351         /*
1352          * some egalax touchscreens have "application == DG_TOUCHSCREEN"
1353          * for the stylus. Overwrite the hid_input application
1354          */
1355         if (field->physical == HID_DG_STYLUS)
1356                 hi->application = HID_DG_STYLUS;
1357
1358         /* let hid-core decide for the others */
1359         return 0;
1360 }
1361
1362 static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
1363                 struct hid_field *field, struct hid_usage *usage,
1364                 unsigned long **bit, int *max)
1365 {
1366         struct mt_device *td = hid_get_drvdata(hdev);
1367         struct mt_report_data *rdata;
1368
1369         rdata = mt_find_report_data(td, field->report);
1370         if (rdata && rdata->is_mt_collection) {
1371                 /* We own these mappings, tell hid-input to ignore them */
1372                 return -1;
1373         }
1374
1375         /* let hid-core decide for the others */
1376         return 0;
1377 }
1378
1379 static int mt_event(struct hid_device *hid, struct hid_field *field,
1380                                 struct hid_usage *usage, __s32 value)
1381 {
1382         struct mt_device *td = hid_get_drvdata(hid);
1383         struct mt_report_data *rdata;
1384
1385         rdata = mt_find_report_data(td, field->report);
1386         if (rdata && rdata->is_mt_collection)
1387                 return mt_touch_event(hid, field, usage, value);
1388
1389         return 0;
1390 }
1391
1392 static void mt_report(struct hid_device *hid, struct hid_report *report)
1393 {
1394         struct mt_device *td = hid_get_drvdata(hid);
1395         struct hid_field *field = report->field[0];
1396         struct mt_report_data *rdata;
1397
1398         if (!(hid->claimed & HID_CLAIMED_INPUT))
1399                 return;
1400
1401         rdata = mt_find_report_data(td, report);
1402         if (rdata && rdata->is_mt_collection)
1403                 return mt_touch_report(hid, rdata);
1404
1405         if (field && field->hidinput && field->hidinput->input)
1406                 input_sync(field->hidinput->input);
1407 }
1408
1409 static bool mt_need_to_apply_feature(struct hid_device *hdev,
1410                                      struct hid_field *field,
1411                                      struct hid_usage *usage,
1412                                      enum latency_mode latency,
1413                                      bool surface_switch,
1414                                      bool button_switch,
1415                                      bool *inputmode_found)
1416 {
1417         struct mt_device *td = hid_get_drvdata(hdev);
1418         struct mt_class *cls = &td->mtclass;
1419         struct hid_report *report = field->report;
1420         unsigned int index = usage->usage_index;
1421         char *buf;
1422         u32 report_len;
1423         int max;
1424
1425         switch (usage->hid) {
1426         case HID_DG_INPUTMODE:
1427                 /*
1428                  * Some elan panels wrongly declare 2 input mode features,
1429                  * and silently ignore when we set the value in the second
1430                  * field. Skip the second feature and hope for the best.
1431                  */
1432                 if (*inputmode_found)
1433                         return false;
1434
1435                 if (cls->quirks & MT_QUIRK_FORCE_GET_FEATURE) {
1436                         report_len = hid_report_len(report);
1437                         buf = hid_alloc_report_buf(report, GFP_KERNEL);
1438                         if (!buf) {
1439                                 hid_err(hdev,
1440                                         "failed to allocate buffer for report\n");
1441                                 return false;
1442                         }
1443                         hid_hw_raw_request(hdev, report->id, buf, report_len,
1444                                            HID_FEATURE_REPORT,
1445                                            HID_REQ_GET_REPORT);
1446                         kfree(buf);
1447                 }
1448
1449                 field->value[index] = td->inputmode_value;
1450                 *inputmode_found = true;
1451                 return true;
1452
1453         case HID_DG_CONTACTMAX:
1454                 if (cls->maxcontacts) {
1455                         max = min_t(int, field->logical_maximum,
1456                                     cls->maxcontacts);
1457                         if (field->value[index] != max) {
1458                                 field->value[index] = max;
1459                                 return true;
1460                         }
1461                 }
1462                 break;
1463
1464         case HID_DG_LATENCYMODE:
1465                 field->value[index] = latency;
1466                 return true;
1467
1468         case HID_DG_SURFACESWITCH:
1469                 field->value[index] = surface_switch;
1470                 return true;
1471
1472         case HID_DG_BUTTONSWITCH:
1473                 field->value[index] = button_switch;
1474                 return true;
1475         }
1476
1477         return false; /* no need to update the report */
1478 }
1479
1480 static void mt_set_modes(struct hid_device *hdev, enum latency_mode latency,
1481                          bool surface_switch, bool button_switch)
1482 {
1483         struct hid_report_enum *rep_enum;
1484         struct hid_report *rep;
1485         struct hid_usage *usage;
1486         int i, j;
1487         bool update_report;
1488         bool inputmode_found = false;
1489
1490         rep_enum = &hdev->report_enum[HID_FEATURE_REPORT];
1491         list_for_each_entry(rep, &rep_enum->report_list, list) {
1492                 update_report = false;
1493
1494                 for (i = 0; i < rep->maxfield; i++) {
1495                         /* Ignore if report count is out of bounds. */
1496                         if (rep->field[i]->report_count < 1)
1497                                 continue;
1498
1499                         for (j = 0; j < rep->field[i]->maxusage; j++) {
1500                                 usage = &rep->field[i]->usage[j];
1501
1502                                 if (mt_need_to_apply_feature(hdev,
1503                                                              rep->field[i],
1504                                                              usage,
1505                                                              latency,
1506                                                              surface_switch,
1507                                                              button_switch,
1508                                                              &inputmode_found))
1509                                         update_report = true;
1510                         }
1511                 }
1512
1513                 if (update_report)
1514                         hid_hw_request(hdev, rep, HID_REQ_SET_REPORT);
1515         }
1516 }
1517
1518 static void mt_post_parse_default_settings(struct mt_device *td,
1519                                            struct mt_application *app)
1520 {
1521         __s32 quirks = app->quirks;
1522
1523         /* unknown serial device needs special quirks */
1524         if (list_is_singular(&app->mt_usages)) {
1525                 quirks |= MT_QUIRK_ALWAYS_VALID;
1526                 quirks &= ~MT_QUIRK_NOT_SEEN_MEANS_UP;
1527                 quirks &= ~MT_QUIRK_VALID_IS_INRANGE;
1528                 quirks &= ~MT_QUIRK_VALID_IS_CONFIDENCE;
1529                 quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
1530         }
1531
1532         app->quirks = quirks;
1533 }
1534
1535 static void mt_post_parse(struct mt_device *td, struct mt_application *app)
1536 {
1537         if (!app->have_contact_count)
1538                 app->quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
1539 }
1540
1541 static int mt_input_configured(struct hid_device *hdev, struct hid_input *hi)
1542 {
1543         struct mt_device *td = hid_get_drvdata(hdev);
1544         char *name;
1545         const char *suffix = NULL;
1546         struct mt_report_data *rdata;
1547         struct mt_application *mt_application = NULL;
1548         struct hid_report *report;
1549         int ret;
1550
1551         list_for_each_entry(report, &hi->reports, hidinput_list) {
1552                 rdata = mt_find_report_data(td, report);
1553                 if (!rdata) {
1554                         hid_err(hdev, "failed to allocate data for report\n");
1555                         return -ENOMEM;
1556                 }
1557
1558                 mt_application = rdata->application;
1559
1560                 if (rdata->is_mt_collection) {
1561                         ret = mt_touch_input_configured(hdev, hi,
1562                                                         mt_application);
1563                         if (ret)
1564                                 return ret;
1565                 }
1566         }
1567
1568         switch (hi->application) {
1569         case HID_GD_KEYBOARD:
1570         case HID_GD_KEYPAD:
1571         case HID_GD_MOUSE:
1572         case HID_DG_TOUCHPAD:
1573         case HID_GD_SYSTEM_CONTROL:
1574         case HID_CP_CONSUMER_CONTROL:
1575         case HID_GD_WIRELESS_RADIO_CTLS:
1576         case HID_GD_SYSTEM_MULTIAXIS:
1577                 /* already handled by hid core */
1578                 break;
1579         case HID_DG_TOUCHSCREEN:
1580                 /* we do not set suffix = "Touchscreen" */
1581                 hi->input->name = hdev->name;
1582                 break;
1583         case HID_VD_ASUS_CUSTOM_MEDIA_KEYS:
1584                 suffix = "Custom Media Keys";
1585                 break;
1586         case HID_DG_STYLUS:
1587                 /* force BTN_STYLUS to allow tablet matching in udev */
1588                 __set_bit(BTN_STYLUS, hi->input->keybit);
1589                 fallthrough;
1590         case HID_DG_PEN:
1591                 suffix = "Stylus";
1592                 break;
1593         default:
1594                 suffix = "UNKNOWN";
1595                 break;
1596         }
1597
1598         if (suffix) {
1599                 name = devm_kzalloc(&hi->input->dev,
1600                                     strlen(hdev->name) + strlen(suffix) + 2,
1601                                     GFP_KERNEL);
1602                 if (name) {
1603                         sprintf(name, "%s %s", hdev->name, suffix);
1604                         hi->input->name = name;
1605                 }
1606         }
1607
1608         return 0;
1609 }
1610
1611 static void mt_fix_const_field(struct hid_field *field, unsigned int usage)
1612 {
1613         if (field->usage[0].hid != usage ||
1614             !(field->flags & HID_MAIN_ITEM_CONSTANT))
1615                 return;
1616
1617         field->flags &= ~HID_MAIN_ITEM_CONSTANT;
1618         field->flags |= HID_MAIN_ITEM_VARIABLE;
1619 }
1620
1621 static void mt_fix_const_fields(struct hid_device *hdev, unsigned int usage)
1622 {
1623         struct hid_report *report;
1624         int i;
1625
1626         list_for_each_entry(report,
1627                             &hdev->report_enum[HID_INPUT_REPORT].report_list,
1628                             list) {
1629
1630                 if (!report->maxfield)
1631                         continue;
1632
1633                 for (i = 0; i < report->maxfield; i++)
1634                         if (report->field[i]->maxusage >= 1)
1635                                 mt_fix_const_field(report->field[i], usage);
1636         }
1637 }
1638
1639 static void mt_release_contacts(struct hid_device *hid)
1640 {
1641         struct hid_input *hidinput;
1642         struct mt_application *application;
1643         struct mt_device *td = hid_get_drvdata(hid);
1644
1645         list_for_each_entry(hidinput, &hid->inputs, list) {
1646                 struct input_dev *input_dev = hidinput->input;
1647                 struct input_mt *mt = input_dev->mt;
1648                 int i;
1649
1650                 if (mt) {
1651                         for (i = 0; i < mt->num_slots; i++) {
1652                                 input_mt_slot(input_dev, i);
1653                                 input_mt_report_slot_inactive(input_dev);
1654                         }
1655                         input_mt_sync_frame(input_dev);
1656                         input_sync(input_dev);
1657                 }
1658         }
1659
1660         list_for_each_entry(application, &td->applications, list) {
1661                 application->num_received = 0;
1662         }
1663 }
1664
1665 static void mt_expired_timeout(struct timer_list *t)
1666 {
1667         struct mt_device *td = from_timer(td, t, release_timer);
1668         struct hid_device *hdev = td->hdev;
1669
1670         /*
1671          * An input report came in just before we release the sticky fingers,
1672          * it will take care of the sticky fingers.
1673          */
1674         if (test_and_set_bit_lock(MT_IO_FLAGS_RUNNING, &td->mt_io_flags))
1675                 return;
1676         if (test_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags))
1677                 mt_release_contacts(hdev);
1678         clear_bit_unlock(MT_IO_FLAGS_RUNNING, &td->mt_io_flags);
1679 }
1680
1681 static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
1682 {
1683         int ret, i;
1684         struct mt_device *td;
1685         const struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */
1686
1687         for (i = 0; mt_classes[i].name ; i++) {
1688                 if (id->driver_data == mt_classes[i].name) {
1689                         mtclass = &(mt_classes[i]);
1690                         break;
1691                 }
1692         }
1693
1694         td = devm_kzalloc(&hdev->dev, sizeof(struct mt_device), GFP_KERNEL);
1695         if (!td) {
1696                 dev_err(&hdev->dev, "cannot allocate multitouch data\n");
1697                 return -ENOMEM;
1698         }
1699         td->hdev = hdev;
1700         td->mtclass = *mtclass;
1701         td->inputmode_value = MT_INPUTMODE_TOUCHSCREEN;
1702         hid_set_drvdata(hdev, td);
1703
1704         INIT_LIST_HEAD(&td->applications);
1705         INIT_LIST_HEAD(&td->reports);
1706
1707         if (id->vendor == HID_ANY_ID && id->product == HID_ANY_ID)
1708                 td->serial_maybe = true;
1709
1710         /* This allows the driver to correctly support devices
1711          * that emit events over several HID messages.
1712          */
1713         hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
1714
1715         /*
1716          * This allows the driver to handle different input sensors
1717          * that emits events through different applications on the same HID
1718          * device.
1719          */
1720         hdev->quirks |= HID_QUIRK_INPUT_PER_APP;
1721
1722         if (id->group != HID_GROUP_MULTITOUCH_WIN_8)
1723                 hdev->quirks |= HID_QUIRK_MULTI_INPUT;
1724
1725         if (mtclass->quirks & MT_QUIRK_FORCE_MULTI_INPUT) {
1726                 hdev->quirks &= ~HID_QUIRK_INPUT_PER_APP;
1727                 hdev->quirks |= HID_QUIRK_MULTI_INPUT;
1728         }
1729
1730         timer_setup(&td->release_timer, mt_expired_timeout, 0);
1731
1732         ret = hid_parse(hdev);
1733         if (ret != 0)
1734                 return ret;
1735
1736         if (mtclass->quirks & MT_QUIRK_FIX_CONST_CONTACT_ID)
1737                 mt_fix_const_fields(hdev, HID_DG_CONTACTID);
1738
1739         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
1740         if (ret)
1741                 return ret;
1742
1743         ret = sysfs_create_group(&hdev->dev.kobj, &mt_attribute_group);
1744         if (ret)
1745                 dev_warn(&hdev->dev, "Cannot allocate sysfs group for %s\n",
1746                                 hdev->name);
1747
1748         mt_set_modes(hdev, HID_LATENCY_NORMAL, true, true);
1749
1750         return 0;
1751 }
1752
1753 #ifdef CONFIG_PM
1754 static int mt_reset_resume(struct hid_device *hdev)
1755 {
1756         mt_release_contacts(hdev);
1757         mt_set_modes(hdev, HID_LATENCY_NORMAL, true, true);
1758         return 0;
1759 }
1760
1761 static int mt_resume(struct hid_device *hdev)
1762 {
1763         /* Some Elan legacy devices require SET_IDLE to be set on resume.
1764          * It should be safe to send it to other devices too.
1765          * Tested on 3M, Stantum, Cypress, Zytronic, eGalax, and Elan panels. */
1766
1767         hid_hw_idle(hdev, 0, 0, HID_REQ_SET_IDLE);
1768
1769         return 0;
1770 }
1771 #endif
1772
1773 static void mt_remove(struct hid_device *hdev)
1774 {
1775         struct mt_device *td = hid_get_drvdata(hdev);
1776
1777         del_timer_sync(&td->release_timer);
1778
1779         sysfs_remove_group(&hdev->dev.kobj, &mt_attribute_group);
1780         hid_hw_stop(hdev);
1781 }
1782
1783 /*
1784  * This list contains only:
1785  * - VID/PID of products not working with the default multitouch handling
1786  * - 2 generic rules.
1787  * So there is no point in adding here any device with MT_CLS_DEFAULT.
1788  */
1789 static const struct hid_device_id mt_devices[] = {
1790
1791         /* 3M panels */
1792         { .driver_data = MT_CLS_3M,
1793                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1794                         USB_DEVICE_ID_3M1968) },
1795         { .driver_data = MT_CLS_3M,
1796                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1797                         USB_DEVICE_ID_3M2256) },
1798         { .driver_data = MT_CLS_3M,
1799                 MT_USB_DEVICE(USB_VENDOR_ID_3M,
1800                         USB_DEVICE_ID_3M3266) },
1801
1802         /* Anton devices */
1803         { .driver_data = MT_CLS_EXPORT_ALL_INPUTS,
1804                 MT_USB_DEVICE(USB_VENDOR_ID_ANTON,
1805                         USB_DEVICE_ID_ANTON_TOUCH_PAD) },
1806
1807         /* Asus T304UA */
1808         { .driver_data = MT_CLS_ASUS,
1809                 HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1810                         USB_VENDOR_ID_ASUSTEK,
1811                         USB_DEVICE_ID_ASUSTEK_T304_KEYBOARD) },
1812
1813         /* Atmel panels */
1814         { .driver_data = MT_CLS_SERIAL,
1815                 MT_USB_DEVICE(USB_VENDOR_ID_ATMEL,
1816                         USB_DEVICE_ID_ATMEL_MXT_DIGITIZER) },
1817
1818         /* Baanto multitouch devices */
1819         { .driver_data = MT_CLS_NSMU,
1820                 MT_USB_DEVICE(USB_VENDOR_ID_BAANTO,
1821                         USB_DEVICE_ID_BAANTO_MT_190W2) },
1822
1823         /* Cando panels */
1824         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1825                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1826                         USB_DEVICE_ID_CANDO_MULTI_TOUCH) },
1827         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1828                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1829                         USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6) },
1830
1831         /* Chunghwa Telecom touch panels */
1832         {  .driver_data = MT_CLS_NSMU,
1833                 MT_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT,
1834                         USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH) },
1835
1836         /* CJTouch panels */
1837         { .driver_data = MT_CLS_NSMU,
1838                 MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1839                         USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0020) },
1840         { .driver_data = MT_CLS_NSMU,
1841                 MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1842                         USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0040) },
1843
1844         /* CVTouch panels */
1845         { .driver_data = MT_CLS_NSMU,
1846                 MT_USB_DEVICE(USB_VENDOR_ID_CVTOUCH,
1847                         USB_DEVICE_ID_CVTOUCH_SCREEN) },
1848
1849         /* eGalax devices (resistive) */
1850         { .driver_data = MT_CLS_EGALAX,
1851                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1852                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D) },
1853         { .driver_data = MT_CLS_EGALAX,
1854                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1855                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E) },
1856
1857         /* eGalax devices (capacitive) */
1858         { .driver_data = MT_CLS_EGALAX_SERIAL,
1859                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1860                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7207) },
1861         { .driver_data = MT_CLS_EGALAX,
1862                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1863                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C) },
1864         { .driver_data = MT_CLS_EGALAX_SERIAL,
1865                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1866                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224) },
1867         { .driver_data = MT_CLS_EGALAX_SERIAL,
1868                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1869                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_722A) },
1870         { .driver_data = MT_CLS_EGALAX_SERIAL,
1871                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1872                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_725E) },
1873         { .driver_data = MT_CLS_EGALAX_SERIAL,
1874                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1875                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7262) },
1876         { .driver_data = MT_CLS_EGALAX,
1877                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1878                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B) },
1879         { .driver_data = MT_CLS_EGALAX,
1880                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1881                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1) },
1882         { .driver_data = MT_CLS_EGALAX_SERIAL,
1883                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1884                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72AA) },
1885         { .driver_data = MT_CLS_EGALAX,
1886                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1887                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72C4) },
1888         { .driver_data = MT_CLS_EGALAX,
1889                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1890                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72D0) },
1891         { .driver_data = MT_CLS_EGALAX,
1892                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1893                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA) },
1894         { .driver_data = MT_CLS_EGALAX,
1895                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1896                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302) },
1897         { .driver_data = MT_CLS_EGALAX_SERIAL,
1898                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1899                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7349) },
1900         { .driver_data = MT_CLS_EGALAX_SERIAL,
1901                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1902                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_73F7) },
1903         { .driver_data = MT_CLS_EGALAX_SERIAL,
1904                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1905                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001) },
1906         { .driver_data = MT_CLS_EGALAX,
1907                 MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1908                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_C002) },
1909
1910         /* Elan devices */
1911         { .driver_data = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
1912                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1913                         USB_VENDOR_ID_ELAN, 0x313a) },
1914
1915         /* Elitegroup panel */
1916         { .driver_data = MT_CLS_SERIAL,
1917                 MT_USB_DEVICE(USB_VENDOR_ID_ELITEGROUP,
1918                         USB_DEVICE_ID_ELITEGROUP_05D8) },
1919
1920         /* Flatfrog Panels */
1921         { .driver_data = MT_CLS_FLATFROG,
1922                 MT_USB_DEVICE(USB_VENDOR_ID_FLATFROG,
1923                         USB_DEVICE_ID_MULTITOUCH_3200) },
1924
1925         /* FocalTech Panels */
1926         { .driver_data = MT_CLS_SERIAL,
1927                 MT_USB_DEVICE(USB_VENDOR_ID_CYGNAL,
1928                         USB_DEVICE_ID_FOCALTECH_FTXXXX_MULTITOUCH) },
1929
1930         /* GeneralTouch panel */
1931         { .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1932                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1933                         USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
1934         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1935                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1936                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PWT_TENFINGERS) },
1937         { .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1938                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1939                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0101) },
1940         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1941                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1942                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0102) },
1943         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1944                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1945                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0106) },
1946         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1947                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1948                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_010A) },
1949         { .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1950                 MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1951                         USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_E100) },
1952
1953         /* Gametel game controller */
1954         { .driver_data = MT_CLS_NSMU,
1955                 MT_BT_DEVICE(USB_VENDOR_ID_FRUCTEL,
1956                         USB_DEVICE_ID_GAMETEL_MT_MODE) },
1957
1958         /* GoodTouch panels */
1959         { .driver_data = MT_CLS_NSMU,
1960                 MT_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH,
1961                         USB_DEVICE_ID_GOODTOUCH_000f) },
1962
1963         /* Hanvon panels */
1964         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1965                 MT_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT,
1966                         USB_DEVICE_ID_HANVON_ALT_MULTITOUCH) },
1967
1968         /* Ilitek dual touch panel */
1969         {  .driver_data = MT_CLS_NSMU,
1970                 MT_USB_DEVICE(USB_VENDOR_ID_ILITEK,
1971                         USB_DEVICE_ID_ILITEK_MULTITOUCH) },
1972
1973         /* LG Melfas panel */
1974         { .driver_data = MT_CLS_LG,
1975                 HID_USB_DEVICE(USB_VENDOR_ID_LG,
1976                         USB_DEVICE_ID_LG_MELFAS_MT) },
1977         { .driver_data = MT_CLS_LG,
1978                 HID_DEVICE(BUS_I2C, HID_GROUP_GENERIC,
1979                         USB_VENDOR_ID_LG, I2C_DEVICE_ID_LG_7010) },
1980
1981         /* Lenovo X1 TAB Gen 2 */
1982         { .driver_data = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
1983                 HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1984                            USB_VENDOR_ID_LENOVO,
1985                            USB_DEVICE_ID_LENOVO_X1_TAB) },
1986
1987         /* Lenovo X1 TAB Gen 3 */
1988         { .driver_data = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
1989                 HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1990                            USB_VENDOR_ID_LENOVO,
1991                            USB_DEVICE_ID_LENOVO_X1_TAB3) },
1992
1993         /* Lenovo X12 TAB Gen 1 */
1994         { .driver_data = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
1995                 HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1996                            USB_VENDOR_ID_LENOVO,
1997                            USB_DEVICE_ID_LENOVO_X12_TAB) },
1998
1999         /* MosArt panels */
2000         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
2001                 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
2002                         USB_DEVICE_ID_ASUS_T91MT)},
2003         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
2004                 MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
2005                         USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO) },
2006         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
2007                 MT_USB_DEVICE(USB_VENDOR_ID_TURBOX,
2008                         USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART) },
2009
2010         /* Novatek Panel */
2011         { .driver_data = MT_CLS_NSMU,
2012                 MT_USB_DEVICE(USB_VENDOR_ID_NOVATEK,
2013                         USB_DEVICE_ID_NOVATEK_PCT) },
2014
2015         /* Ntrig Panel */
2016         { .driver_data = MT_CLS_NSMU,
2017                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
2018                         USB_VENDOR_ID_NTRIG, 0x1b05) },
2019
2020         /* Panasonic panels */
2021         { .driver_data = MT_CLS_PANASONIC,
2022                 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
2023                         USB_DEVICE_ID_PANABOARD_UBT780) },
2024         { .driver_data = MT_CLS_PANASONIC,
2025                 MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
2026                         USB_DEVICE_ID_PANABOARD_UBT880) },
2027
2028         /* PixArt optical touch screen */
2029         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
2030                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
2031                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN) },
2032         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
2033                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
2034                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1) },
2035         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
2036                 MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
2037                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2) },
2038
2039         /* PixCir-based panels */
2040         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
2041                 MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
2042                         USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
2043
2044         /* Quanta-based panels */
2045         { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
2046                 MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
2047                         USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001) },
2048
2049         /* Razer touchpads */
2050         { .driver_data = MT_CLS_RAZER_BLADE_STEALTH,
2051                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
2052                         USB_VENDOR_ID_SYNAPTICS, 0x8323) },
2053
2054         /* Smart Tech panels */
2055         { .driver_data = MT_CLS_SMART_TECH,
2056                 MT_USB_DEVICE(0x0b8c, 0x0092)},
2057
2058         /* Stantum panels */
2059         { .driver_data = MT_CLS_CONFIDENCE,
2060                 MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM,
2061                         USB_DEVICE_ID_MTP_STM)},
2062
2063         /* Synaptics devices */
2064         { .driver_data = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
2065                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
2066                         USB_VENDOR_ID_SYNAPTICS, 0xce08) },
2067
2068         { .driver_data = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
2069                 HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
2070                         USB_VENDOR_ID_SYNAPTICS, 0xce09) },
2071
2072         /* TopSeed panels */
2073         { .driver_data = MT_CLS_TOPSEED,
2074                 MT_USB_DEVICE(USB_VENDOR_ID_TOPSEED2,
2075                         USB_DEVICE_ID_TOPSEED2_PERIPAD_701) },
2076
2077         /* Touch International panels */
2078         { .driver_data = MT_CLS_NSMU,
2079                 MT_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL,
2080                         USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH) },
2081
2082         /* Unitec panels */
2083         { .driver_data = MT_CLS_NSMU,
2084                 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
2085                         USB_DEVICE_ID_UNITEC_USB_TOUCH_0709) },
2086         { .driver_data = MT_CLS_NSMU,
2087                 MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
2088                         USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19) },
2089
2090         /* VTL panels */
2091         { .driver_data = MT_CLS_VTL,
2092                 MT_USB_DEVICE(USB_VENDOR_ID_VTL,
2093                         USB_DEVICE_ID_VTL_MULTITOUCH_FF3F) },
2094
2095         /* Wistron panels */
2096         { .driver_data = MT_CLS_NSMU,
2097                 MT_USB_DEVICE(USB_VENDOR_ID_WISTRON,
2098                         USB_DEVICE_ID_WISTRON_OPTICAL_TOUCH) },
2099
2100         /* XAT */
2101         { .driver_data = MT_CLS_NSMU,
2102                 MT_USB_DEVICE(USB_VENDOR_ID_XAT,
2103                         USB_DEVICE_ID_XAT_CSR) },
2104
2105         /* Xiroku */
2106         { .driver_data = MT_CLS_NSMU,
2107                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2108                         USB_DEVICE_ID_XIROKU_SPX) },
2109         { .driver_data = MT_CLS_NSMU,
2110                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2111                         USB_DEVICE_ID_XIROKU_MPX) },
2112         { .driver_data = MT_CLS_NSMU,
2113                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2114                         USB_DEVICE_ID_XIROKU_CSR) },
2115         { .driver_data = MT_CLS_NSMU,
2116                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2117                         USB_DEVICE_ID_XIROKU_SPX1) },
2118         { .driver_data = MT_CLS_NSMU,
2119                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2120                         USB_DEVICE_ID_XIROKU_MPX1) },
2121         { .driver_data = MT_CLS_NSMU,
2122                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2123                         USB_DEVICE_ID_XIROKU_CSR1) },
2124         { .driver_data = MT_CLS_NSMU,
2125                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2126                         USB_DEVICE_ID_XIROKU_SPX2) },
2127         { .driver_data = MT_CLS_NSMU,
2128                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2129                         USB_DEVICE_ID_XIROKU_MPX2) },
2130         { .driver_data = MT_CLS_NSMU,
2131                 MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2132                         USB_DEVICE_ID_XIROKU_CSR2) },
2133
2134         /* Google MT devices */
2135         { .driver_data = MT_CLS_GOOGLE,
2136                 HID_DEVICE(HID_BUS_ANY, HID_GROUP_ANY, USB_VENDOR_ID_GOOGLE,
2137                         USB_DEVICE_ID_GOOGLE_TOUCH_ROSE) },
2138         { .driver_data = MT_CLS_GOOGLE,
2139                 HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8, USB_VENDOR_ID_GOOGLE,
2140                         USB_DEVICE_ID_GOOGLE_WHISKERS) },
2141
2142         /* Generic MT device */
2143         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH, HID_ANY_ID, HID_ANY_ID) },
2144
2145         /* Generic Win 8 certified MT device */
2146         {  .driver_data = MT_CLS_WIN_8,
2147                 HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH_WIN_8,
2148                         HID_ANY_ID, HID_ANY_ID) },
2149         { }
2150 };
2151 MODULE_DEVICE_TABLE(hid, mt_devices);
2152
2153 static const struct hid_usage_id mt_grabbed_usages[] = {
2154         { HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
2155         { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
2156 };
2157
2158 static struct hid_driver mt_driver = {
2159         .name = "hid-multitouch",
2160         .id_table = mt_devices,
2161         .probe = mt_probe,
2162         .remove = mt_remove,
2163         .input_mapping = mt_input_mapping,
2164         .input_mapped = mt_input_mapped,
2165         .input_configured = mt_input_configured,
2166         .feature_mapping = mt_feature_mapping,
2167         .usage_table = mt_grabbed_usages,
2168         .event = mt_event,
2169         .report = mt_report,
2170 #ifdef CONFIG_PM
2171         .reset_resume = mt_reset_resume,
2172         .resume = mt_resume,
2173 #endif
2174 };
2175 module_hid_driver(mt_driver);