drivers/hid/hid-multitouch.c

   1 /*
   2  *  HID driver for multitouch panels
   3  *
   4  *  Copyright (c) 2010-2012 Stephane Chatty <chatty@enac.fr>
   5  *  Copyright (c) 2010-2012 Benjamin Tissoires <benjamin.tissoires@gmail.com>
   6  *  Copyright (c) 2010-2012 Ecole Nationale de l'Aviation Civile, France
   7  *
   8  *  This code is partly based on hid-egalax.c:
   9  *
  10  *  Copyright (c) 2010 Stephane Chatty <chatty@enac.fr>
  11  *  Copyright (c) 2010 Henrik Rydberg <rydberg@euromail.se>
  12  *  Copyright (c) 2010 Canonical, Ltd.
  13  *
  14  *  This code is partly based on hid-3m-pct.c:
  15  *
  16  *  Copyright (c) 2009-2010 Stephane Chatty <chatty@enac.fr>
  17  *  Copyright (c) 2010      Henrik Rydberg <rydberg@euromail.se>
  18  *  Copyright (c) 2010      Canonical, Ltd.
  19  *
  20  */
  21
  22 /*
  23  * This program is free software; you can redistribute it and/or modify it
  24  * under the terms of the GNU General Public License as published by the Free
  25  * Software Foundation; either version 2 of the License, or (at your option)
  26  * any later version.
  27  */
  28
  29 #include <linux/device.h>
  30 #include <linux/hid.h>
  31 #include <linux/module.h>
  32 #include <linux/slab.h>
  33 #include <linux/usb.h>
  34 #include <linux/input/mt.h>
  35 #include "usbhid/usbhid.h"
  36
  37
  38 MODULE_AUTHOR("Stephane Chatty <chatty@enac.fr>");
  39 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
  40 MODULE_DESCRIPTION("HID multitouch panels");
  41 MODULE_LICENSE("GPL");
  42
  43 #include "hid-ids.h"
  44
  45 /* quirks to control the device */
  46 #define MT_QUIRK_NOT_SEEN_MEANS_UP      (1 << 0)
  47 #define MT_QUIRK_SLOT_IS_CONTACTID      (1 << 1)
  48 #define MT_QUIRK_CYPRESS                (1 << 2)
  49 #define MT_QUIRK_SLOT_IS_CONTACTNUMBER  (1 << 3)
  50 #define MT_QUIRK_ALWAYS_VALID           (1 << 4)
  51 #define MT_QUIRK_VALID_IS_INRANGE       (1 << 5)
  52 #define MT_QUIRK_VALID_IS_CONFIDENCE    (1 << 6)
  53 #define MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE    (1 << 8)
  54
  55 struct mt_slot {
  56         __s32 x, y, p, w, h;
  57         __s32 contactid;        /* the device ContactID assigned to this slot */
  58         bool touch_state;       /* is the touch valid? */
  59         bool seen_in_this_frame;/* has this slot been updated */
  60 };
  61
  62 struct mt_class {
  63         __s32 name;     /* MT_CLS */
  64         __s32 quirks;
  65         __s32 sn_move;  /* Signal/noise ratio for move events */
  66         __s32 sn_width; /* Signal/noise ratio for width events */
  67         __s32 sn_height;        /* Signal/noise ratio for height events */
  68         __s32 sn_pressure;      /* Signal/noise ratio for pressure events */
  69         __u8 maxcontacts;
  70         bool is_indirect;       /* true for touchpads */
  71 };
  72
  73 struct mt_device {
  74         struct mt_slot curdata; /* placeholder of incoming data */
  75         struct mt_class mtclass;        /* our mt device class */
  76         unsigned last_field_index;      /* last field index of the report */
  77         unsigned last_slot_field;       /* the last field of a slot */
  78         __s8 inputmode;         /* InputMode HID feature, -1 if non-existent */
  79         __s8 maxcontact_report_id;      /* Maximum Contact Number HID feature,
  80                                    -1 if non-existent */
  81         __u8 num_received;      /* how many contacts we received */
  82         __u8 num_expected;      /* expected last contact index */
  83         __u8 maxcontacts;
  84         bool curvalid;          /* is the current contact valid? */
  85         struct mt_slot *slots;
  86 };
  87
  88 /* classes of device behavior */
  89 #define MT_CLS_DEFAULT                          0x0001
  90
  91 #define MT_CLS_SERIAL                           0x0002
  92 #define MT_CLS_CONFIDENCE                       0x0003
  93 #define MT_CLS_CONFIDENCE_CONTACT_ID            0x0004
  94 #define MT_CLS_CONFIDENCE_MINUS_ONE             0x0005
  95 #define MT_CLS_DUAL_INRANGE_CONTACTID           0x0006
  96 #define MT_CLS_DUAL_INRANGE_CONTACTNUMBER       0x0007
  97 #define MT_CLS_DUAL_NSMU_CONTACTID              0x0008
  98 #define MT_CLS_INRANGE_CONTACTNUMBER            0x0009
  99
 100 /* vendor specific classes */
 101 #define MT_CLS_3M                               0x0101
 102 #define MT_CLS_CYPRESS                          0x0102
 103 #define MT_CLS_EGALAX                           0x0103
 104 #define MT_CLS_EGALAX_SERIAL                    0x0104
 105 #define MT_CLS_TOPSEED                          0x0105
 106 #define MT_CLS_PANASONIC                        0x0106
 107
 108 #define MT_DEFAULT_MAXCONTACT   10
 109
 110 /*
 111  * these device-dependent functions determine what slot corresponds
 112  * to a valid contact that was just read.
 113  */
 114
 115 static int cypress_compute_slot(struct mt_device *td)
 116 {
 117         if (td->curdata.contactid != 0 || td->num_received == 0)
 118                 return td->curdata.contactid;
 119         else
 120                 return -1;
 121 }
 122
 123 static int find_slot_from_contactid(struct mt_device *td)
 124 {
 125         int i;
 126         for (i = 0; i < td->maxcontacts; ++i) {
 127                 if (td->slots[i].contactid == td->curdata.contactid &&
 128                         td->slots[i].touch_state)
 129                         return i;
 130         }
 131         for (i = 0; i < td->maxcontacts; ++i) {
 132                 if (!td->slots[i].seen_in_this_frame &&
 133                         !td->slots[i].touch_state)
 134                         return i;
 135         }
 136         /* should not occurs. If this happens that means
 137          * that the device sent more touches that it says
 138          * in the report descriptor. It is ignored then. */
 139         return -1;
 140 }
 141
 142 static struct mt_class mt_classes[] = {
 143         { .name = MT_CLS_DEFAULT,
 144                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP },
 145         { .name = MT_CLS_SERIAL,
 146                 .quirks = MT_QUIRK_ALWAYS_VALID},
 147         { .name = MT_CLS_CONFIDENCE,
 148                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE },
 149         { .name = MT_CLS_CONFIDENCE_CONTACT_ID,
 150                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
 151                         MT_QUIRK_SLOT_IS_CONTACTID },
 152         { .name = MT_CLS_CONFIDENCE_MINUS_ONE,
 153                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
 154                         MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE },
 155         { .name = MT_CLS_DUAL_INRANGE_CONTACTID,
 156                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
 157                         MT_QUIRK_SLOT_IS_CONTACTID,
 158                 .maxcontacts = 2 },
 159         { .name = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
 160                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
 161                         MT_QUIRK_SLOT_IS_CONTACTNUMBER,
 162                 .maxcontacts = 2 },
 163         { .name = MT_CLS_DUAL_NSMU_CONTACTID,
 164                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
 165                         MT_QUIRK_SLOT_IS_CONTACTID,
 166                 .maxcontacts = 2 },
 167         { .name = MT_CLS_INRANGE_CONTACTNUMBER,
 168                 .quirks = MT_QUIRK_VALID_IS_INRANGE |
 169                         MT_QUIRK_SLOT_IS_CONTACTNUMBER },
 170
 171         /*
 172          * vendor specific classes
 173          */
 174         { .name = MT_CLS_3M,
 175                 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
 176                         MT_QUIRK_SLOT_IS_CONTACTID,
 177                 .sn_move = 2048,
 178                 .sn_width = 128,
 179                 .sn_height = 128 },
 180         { .name = MT_CLS_CYPRESS,
 181                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
 182                         MT_QUIRK_CYPRESS,
 183                 .maxcontacts = 10 },
 184         { .name = MT_CLS_EGALAX,
 185                 .quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
 186                         MT_QUIRK_VALID_IS_INRANGE,
 187                 .sn_move = 4096,
 188                 .sn_pressure = 32,
 189         },
 190         { .name = MT_CLS_EGALAX_SERIAL,
 191                 .quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
 192                         MT_QUIRK_ALWAYS_VALID,
 193                 .sn_move = 4096,
 194                 .sn_pressure = 32,
 195         },
 196         { .name = MT_CLS_TOPSEED,
 197                 .quirks = MT_QUIRK_ALWAYS_VALID,
 198                 .is_indirect = true,
 199                 .maxcontacts = 2,
 200         },
 201         { .name = MT_CLS_PANASONIC,
 202                 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP,
 203                 .maxcontacts = 4 },
 204
 205         { }
 206 };
 207
 208 static ssize_t mt_show_quirks(struct device *dev,
 209                            struct device_attribute *attr,
 210                            char *buf)
 211 {
 212         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
 213         struct mt_device *td = hid_get_drvdata(hdev);
 214
 215         return sprintf(buf, "%u\n", td->mtclass.quirks);
 216 }
 217
 218 static ssize_t mt_set_quirks(struct device *dev,
 219                           struct device_attribute *attr,
 220                           const char *buf, size_t count)
 221 {
 222         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
 223         struct mt_device *td = hid_get_drvdata(hdev);
 224
 225         unsigned long val;
 226
 227         if (kstrtoul(buf, 0, &val))
 228                 return -EINVAL;
 229
 230         td->mtclass.quirks = val;
 231
 232         return count;
 233 }
 234
 235 static DEVICE_ATTR(quirks, S_IWUSR | S_IRUGO, mt_show_quirks, mt_set_quirks);
 236
 237 static struct attribute *sysfs_attrs[] = {
 238         &dev_attr_quirks.attr,
 239         NULL
 240 };
 241
 242 static struct attribute_group mt_attribute_group = {
 243         .attrs = sysfs_attrs
 244 };
 245
 246 static void mt_feature_mapping(struct hid_device *hdev,
 247                 struct hid_field *field, struct hid_usage *usage)
 248 {
 249         struct mt_device *td = hid_get_drvdata(hdev);
 250
 251         switch (usage->hid) {
 252         case HID_DG_INPUTMODE:
 253                 td->inputmode = field->report->id;
 254                 break;
 255         case HID_DG_CONTACTMAX:
 256                 td->maxcontact_report_id = field->report->id;
 257                 td->maxcontacts = field->value[0];
 258                 if (td->mtclass.maxcontacts)
 259                         /* check if the maxcontacts is given by the class */
 260                         td->maxcontacts = td->mtclass.maxcontacts;
 261
 262                 break;
 263         }
 264 }
 265
 266 static void set_abs(struct input_dev *input, unsigned int code,
 267                 struct hid_field *field, int snratio)
 268 {
 269         int fmin = field->logical_minimum;
 270         int fmax = field->logical_maximum;
 271         int fuzz = snratio ? (fmax - fmin) / snratio : 0;
 272         input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
 273 }
 274
 275 static void set_last_slot_field(struct hid_usage *usage, struct mt_device *td,
 276                 struct hid_input *hi)
 277 {
 278         if (!test_bit(usage->hid, hi->input->absbit))
 279                 td->last_slot_field = usage->hid;
 280 }
 281
 282 static int mt_input_mapping(struct hid_device *hdev, struct hid_input *hi,
 283                 struct hid_field *field, struct hid_usage *usage,
 284                 unsigned long **bit, int *max)
 285 {
 286         struct mt_device *td = hid_get_drvdata(hdev);
 287         struct mt_class *cls = &td->mtclass;
 288         int code;
 289
 290         /* Only map fields from TouchScreen or TouchPad collections.
 291         * We need to ignore fields that belong to other collections
 292         * such as Mouse that might have the same GenericDesktop usages. */
 293         if (field->application == HID_DG_TOUCHSCREEN)
 294                 set_bit(INPUT_PROP_DIRECT, hi->input->propbit);
 295         else if (field->application != HID_DG_TOUCHPAD)
 296                 return 0;
 297
 298         /* In case of an indirect device (touchpad), we need to add
 299          * specific BTN_TOOL_* to be handled by the synaptics xorg
 300          * driver.
 301          * We also consider that touchscreens providing buttons are touchpads.
 302          */
 303         if (field->application == HID_DG_TOUCHPAD ||
 304             (usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON ||
 305             cls->is_indirect) {
 306                 set_bit(INPUT_PROP_POINTER, hi->input->propbit);
 307                 set_bit(BTN_TOOL_FINGER, hi->input->keybit);
 308                 set_bit(BTN_TOOL_DOUBLETAP, hi->input->keybit);
 309                 set_bit(BTN_TOOL_TRIPLETAP, hi->input->keybit);
 310                 set_bit(BTN_TOOL_QUADTAP, hi->input->keybit);
 311         }
 312
 313         /* eGalax devices provide a Digitizer.Stylus input which overrides
 314          * the correct Digitizers.Finger X/Y ranges.
 315          * Let's just ignore this input. */
 316         if (field->physical == HID_DG_STYLUS)
 317                 return -1;
 318
 319         switch (usage->hid & HID_USAGE_PAGE) {
 320
 321         case HID_UP_GENDESK:
 322                 switch (usage->hid) {
 323                 case HID_GD_X:
 324                         hid_map_usage(hi, usage, bit, max,
 325                                         EV_ABS, ABS_MT_POSITION_X);
 326                         set_abs(hi->input, ABS_MT_POSITION_X, field,
 327                                 cls->sn_move);
 328                         /* touchscreen emulation */
 329                         set_abs(hi->input, ABS_X, field, cls->sn_move);
 330                         set_last_slot_field(usage, td, hi);
 331                         td->last_field_index = field->index;
 332                         return 1;
 333                 case HID_GD_Y:
 334                         hid_map_usage(hi, usage, bit, max,
 335                                         EV_ABS, ABS_MT_POSITION_Y);
 336                         set_abs(hi->input, ABS_MT_POSITION_Y, field,
 337                                 cls->sn_move);
 338                         /* touchscreen emulation */
 339                         set_abs(hi->input, ABS_Y, field, cls->sn_move);
 340                         set_last_slot_field(usage, td, hi);
 341                         td->last_field_index = field->index;
 342                         return 1;
 343                 }
 344                 return 0;
 345
 346         case HID_UP_DIGITIZER:
 347                 switch (usage->hid) {
 348                 case HID_DG_INRANGE:
 349                         set_last_slot_field(usage, td, hi);
 350                         td->last_field_index = field->index;
 351                         return 1;
 352                 case HID_DG_CONFIDENCE:
 353                         set_last_slot_field(usage, td, hi);
 354                         td->last_field_index = field->index;
 355                         return 1;
 356                 case HID_DG_TIPSWITCH:
 357                         hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_TOUCH);
 358                         input_set_capability(hi->input, EV_KEY, BTN_TOUCH);
 359                         set_last_slot_field(usage, td, hi);
 360                         td->last_field_index = field->index;
 361                         return 1;
 362                 case HID_DG_CONTACTID:
 363                         if (!td->maxcontacts)
 364                                 td->maxcontacts = MT_DEFAULT_MAXCONTACT;
 365                         input_mt_init_slots(hi->input, td->maxcontacts);
 366                         td->last_slot_field = usage->hid;
 367                         td->last_field_index = field->index;
 368                         return 1;
 369                 case HID_DG_WIDTH:
 370                         hid_map_usage(hi, usage, bit, max,
 371                                         EV_ABS, ABS_MT_TOUCH_MAJOR);
 372                         set_abs(hi->input, ABS_MT_TOUCH_MAJOR, field,
 373                                 cls->sn_width);
 374                         set_last_slot_field(usage, td, hi);
 375                         td->last_field_index = field->index;
 376                         return 1;
 377                 case HID_DG_HEIGHT:
 378                         hid_map_usage(hi, usage, bit, max,
 379                                         EV_ABS, ABS_MT_TOUCH_MINOR);
 380                         set_abs(hi->input, ABS_MT_TOUCH_MINOR, field,
 381                                 cls->sn_height);
 382                         input_set_abs_params(hi->input,
 383                                         ABS_MT_ORIENTATION, 0, 1, 0, 0);
 384                         set_last_slot_field(usage, td, hi);
 385                         td->last_field_index = field->index;
 386                         return 1;
 387                 case HID_DG_TIPPRESSURE:
 388                         hid_map_usage(hi, usage, bit, max,
 389                                         EV_ABS, ABS_MT_PRESSURE);
 390                         set_abs(hi->input, ABS_MT_PRESSURE, field,
 391                                 cls->sn_pressure);
 392                         /* touchscreen emulation */
 393                         set_abs(hi->input, ABS_PRESSURE, field,
 394                                 cls->sn_pressure);
 395                         set_last_slot_field(usage, td, hi);
 396                         td->last_field_index = field->index;
 397                         return 1;
 398                 case HID_DG_CONTACTCOUNT:
 399                         td->last_field_index = field->index;
 400                         return 1;
 401                 case HID_DG_CONTACTMAX:
 402                         /* we don't set td->last_slot_field as contactcount and
 403                          * contact max are global to the report */
 404                         td->last_field_index = field->index;
 405                         return -1;
 406                 }
 407                 case HID_DG_TOUCH:
 408                         /* Legacy devices use TIPSWITCH and not TOUCH.
 409                          * Let's just ignore this field. */
 410                         return -1;
 411                 /* let hid-input decide for the others */
 412                 return 0;
 413
 414         case HID_UP_BUTTON:
 415                 code = BTN_MOUSE + ((usage->hid - 1) & HID_USAGE);
 416                 hid_map_usage(hi, usage, bit, max, EV_KEY, code);
 417                 input_set_capability(hi->input, EV_KEY, code);
 418                 return 1;
 419
 420         case 0xff000000:
 421                 /* we do not want to map these: no input-oriented meaning */
 422                 return -1;
 423         }
 424
 425         return 0;
 426 }
 427
 428 static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
 429                 struct hid_field *field, struct hid_usage *usage,
 430                 unsigned long **bit, int *max)
 431 {
 432         if (usage->type == EV_KEY || usage->type == EV_ABS)
 433                 set_bit(usage->type, hi->input->evbit);
 434
 435         return -1;
 436 }
 437
 438 static int mt_compute_slot(struct mt_device *td)
 439 {
 440         __s32 quirks = td->mtclass.quirks;
 441
 442         if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
 443                 return td->curdata.contactid;
 444
 445         if (quirks & MT_QUIRK_CYPRESS)
 446                 return cypress_compute_slot(td);
 447
 448         if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
 449                 return td->num_received;
 450
 451         if (quirks & MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE)
 452                 return td->curdata.contactid - 1;
 453
 454         return find_slot_from_contactid(td);
 455 }
 456
 457 /*
 458  * this function is called when a whole contact has been processed,
 459  * so that it can assign it to a slot and store the data there
 460  */
 461 static void mt_complete_slot(struct mt_device *td)
 462 {
 463         td->curdata.seen_in_this_frame = true;
 464         if (td->curvalid) {
 465                 int slotnum = mt_compute_slot(td);
 466
 467                 if (slotnum >= 0 && slotnum < td->maxcontacts)
 468                         td->slots[slotnum] = td->curdata;
 469         }
 470         td->num_received++;
 471 }
 472
 473
 474 /*
 475  * this function is called when a whole packet has been received and processed,
 476  * so that it can decide what to send to the input layer.
 477  */
 478 static void mt_emit_event(struct mt_device *td, struct input_dev *input)
 479 {
 480         int i;
 481
 482         for (i = 0; i < td->maxcontacts; ++i) {
 483                 struct mt_slot *s = &(td->slots[i]);
 484                 if ((td->mtclass.quirks & MT_QUIRK_NOT_SEEN_MEANS_UP) &&
 485                         !s->seen_in_this_frame) {
 486                         s->touch_state = false;
 487                 }
 488
 489                 input_mt_slot(input, i);
 490                 input_mt_report_slot_state(input, MT_TOOL_FINGER,
 491                         s->touch_state);
 492                 if (s->touch_state) {
 493                         /* this finger is on the screen */
 494                         int wide = (s->w > s->h);
 495                         /* divided by two to match visual scale of touch */
 496                         int major = max(s->w, s->h) >> 1;
 497                         int minor = min(s->w, s->h) >> 1;
 498
 499                         input_event(input, EV_ABS, ABS_MT_POSITION_X, s->x);
 500                         input_event(input, EV_ABS, ABS_MT_POSITION_Y, s->y);
 501                         input_event(input, EV_ABS, ABS_MT_ORIENTATION, wide);
 502                         input_event(input, EV_ABS, ABS_MT_PRESSURE, s->p);
 503                         input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
 504                         input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
 505                 }
 506                 s->seen_in_this_frame = false;
 507
 508         }
 509
 510         input_mt_report_pointer_emulation(input, true);
 511         input_sync(input);
 512         td->num_received = 0;
 513 }
 514
 515
 516
 517 static int mt_event(struct hid_device *hid, struct hid_field *field,
 518                                 struct hid_usage *usage, __s32 value)
 519 {
 520         struct mt_device *td = hid_get_drvdata(hid);
 521         __s32 quirks = td->mtclass.quirks;
 522
 523         if (hid->claimed & HID_CLAIMED_INPUT && td->slots) {
 524                 switch (usage->hid) {
 525                 case HID_DG_INRANGE:
 526                         if (quirks & MT_QUIRK_ALWAYS_VALID)
 527                                 td->curvalid = true;
 528                         else if (quirks & MT_QUIRK_VALID_IS_INRANGE)
 529                                 td->curvalid = value;
 530                         break;
 531                 case HID_DG_TIPSWITCH:
 532                         if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
 533                                 td->curvalid = value;
 534                         td->curdata.touch_state = value;
 535                         break;
 536                 case HID_DG_CONFIDENCE:
 537                         if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
 538                                 td->curvalid = value;
 539                         break;
 540                 case HID_DG_CONTACTID:
 541                         td->curdata.contactid = value;
 542                         break;
 543                 case HID_DG_TIPPRESSURE:
 544                         td->curdata.p = value;
 545                         break;
 546                 case HID_GD_X:
 547                         td->curdata.x = value;
 548                         break;
 549                 case HID_GD_Y:
 550                         td->curdata.y = value;
 551                         break;
 552                 case HID_DG_WIDTH:
 553                         td->curdata.w = value;
 554                         break;
 555                 case HID_DG_HEIGHT:
 556                         td->curdata.h = value;
 557                         break;
 558                 case HID_DG_CONTACTCOUNT:
 559                         /*
 560                          * Includes multi-packet support where subsequent
 561                          * packets are sent with zero contactcount.
 562                          */
 563                         if (value)
 564                                 td->num_expected = value;
 565                         break;
 566                 case HID_DG_TOUCH:
 567                         /* do nothing */
 568                         break;
 569
 570                 default:
 571                         /* fallback to the generic hidinput handling */
 572                         return 0;
 573                 }
 574
 575                 if (usage->hid == td->last_slot_field)
 576                         mt_complete_slot(td);
 577
 578                 if (field->index == td->last_field_index
 579                         && td->num_received >= td->num_expected)
 580                         mt_emit_event(td, field->hidinput->input);
 581
 582         }
 583
 584         /* we have handled the hidinput part, now remains hiddev */
 585         if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
 586                 hid->hiddev_hid_event(hid, field, usage, value);
 587
 588         return 1;
 589 }
 590
 591 static void mt_set_input_mode(struct hid_device *hdev)
 592 {
 593         struct mt_device *td = hid_get_drvdata(hdev);
 594         struct hid_report *r;
 595         struct hid_report_enum *re;
 596
 597         if (td->inputmode < 0)
 598                 return;
 599
 600         re = &(hdev->report_enum[HID_FEATURE_REPORT]);
 601         r = re->report_id_hash[td->inputmode];
 602         if (r) {
 603                 r->field[0]->value[0] = 0x02;
 604                 usbhid_submit_report(hdev, r, USB_DIR_OUT);
 605         }
 606 }
 607
 608 static void mt_set_maxcontacts(struct hid_device *hdev)
 609 {
 610         struct mt_device *td = hid_get_drvdata(hdev);
 611         struct hid_report *r;
 612         struct hid_report_enum *re;
 613         int fieldmax, max;
 614
 615         if (td->maxcontact_report_id < 0)
 616                 return;
 617
 618         if (!td->mtclass.maxcontacts)
 619                 return;
 620
 621         re = &hdev->report_enum[HID_FEATURE_REPORT];
 622         r = re->report_id_hash[td->maxcontact_report_id];
 623         if (r) {
 624                 max = td->mtclass.maxcontacts;
 625                 fieldmax = r->field[0]->logical_maximum;
 626                 max = min(fieldmax, max);
 627                 if (r->field[0]->value[0] != max) {
 628                         r->field[0]->value[0] = max;
 629                         usbhid_submit_report(hdev, r, USB_DIR_OUT);
 630                 }
 631         }
 632 }
 633
 634 static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
 635 {
 636         int ret, i;
 637         struct mt_device *td;
 638         struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */
 639
 640         if (id) {
 641                 for (i = 0; mt_classes[i].name ; i++) {
 642                         if (id->driver_data == mt_classes[i].name) {
 643                                 mtclass = &(mt_classes[i]);
 644                                 break;
 645                         }
 646                 }
 647         }
 648
 649         /* This allows the driver to correctly support devices
 650          * that emit events over several HID messages.
 651          */
 652         hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
 653         hdev->quirks &= ~HID_QUIRK_MULTITOUCH;
 654
 655         td = kzalloc(sizeof(struct mt_device), GFP_KERNEL);
 656         if (!td) {
 657                 dev_err(&hdev->dev, "cannot allocate multitouch data\n");
 658                 return -ENOMEM;
 659         }
 660         td->mtclass = *mtclass;
 661         td->inputmode = -1;
 662         td->maxcontact_report_id = -1;
 663         hid_set_drvdata(hdev, td);
 664
 665         ret = hid_parse(hdev);
 666         if (ret != 0)
 667                 goto fail;
 668
 669         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
 670         if (ret)
 671                 goto fail;
 672
 673         td->slots = kzalloc(td->maxcontacts * sizeof(struct mt_slot),
 674                                 GFP_KERNEL);
 675         if (!td->slots) {
 676                 dev_err(&hdev->dev, "cannot allocate multitouch slots\n");
 677                 hid_hw_stop(hdev);
 678                 ret = -ENOMEM;
 679                 goto fail;
 680         }
 681
 682         ret = sysfs_create_group(&hdev->dev.kobj, &mt_attribute_group);
 683
 684         mt_set_maxcontacts(hdev);
 685         mt_set_input_mode(hdev);
 686
 687         return 0;
 688
 689 fail:
 690         kfree(td);
 691         return ret;
 692 }
 693
 694 #ifdef CONFIG_PM
 695 static int mt_reset_resume(struct hid_device *hdev)
 696 {
 697         mt_set_maxcontacts(hdev);
 698         mt_set_input_mode(hdev);
 699         return 0;
 700 }
 701 #endif
 702
 703 static void mt_remove(struct hid_device *hdev)
 704 {
 705         struct mt_device *td = hid_get_drvdata(hdev);
 706         sysfs_remove_group(&hdev->dev.kobj, &mt_attribute_group);
 707         hid_hw_stop(hdev);
 708         kfree(td->slots);
 709         kfree(td);
 710         hid_set_drvdata(hdev, NULL);
 711 }
 712
 713 static const struct hid_device_id mt_devices[] = {
 714
 715         /* 3M panels */
 716         { .driver_data = MT_CLS_3M,
 717                 HID_USB_DEVICE(USB_VENDOR_ID_3M,
 718                         USB_DEVICE_ID_3M1968) },
 719         { .driver_data = MT_CLS_3M,
 720                 HID_USB_DEVICE(USB_VENDOR_ID_3M,
 721                         USB_DEVICE_ID_3M2256) },
 722         { .driver_data = MT_CLS_3M,
 723                 HID_USB_DEVICE(USB_VENDOR_ID_3M,
 724                         USB_DEVICE_ID_3M3266) },
 725
 726         /* ActionStar panels */
 727         { .driver_data = MT_CLS_DEFAULT,
 728                 HID_USB_DEVICE(USB_VENDOR_ID_ACTIONSTAR,
 729                         USB_DEVICE_ID_ACTIONSTAR_1011) },
 730
 731         /* Atmel panels */
 732         { .driver_data = MT_CLS_SERIAL,
 733                 HID_USB_DEVICE(USB_VENDOR_ID_ATMEL,
 734                         USB_DEVICE_ID_ATMEL_MULTITOUCH) },
 735         { .driver_data = MT_CLS_SERIAL,
 736                 HID_USB_DEVICE(USB_VENDOR_ID_ATMEL,
 737                         USB_DEVICE_ID_ATMEL_MXT_DIGITIZER) },
 738
 739         /* Cando panels */
 740         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
 741                 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
 742                         USB_DEVICE_ID_CANDO_MULTI_TOUCH) },
 743         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
 744                 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
 745                         USB_DEVICE_ID_CANDO_MULTI_TOUCH_10_1) },
 746         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
 747                 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
 748                         USB_DEVICE_ID_CANDO_MULTI_TOUCH_11_6) },
 749         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
 750                 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
 751                         USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6) },
 752
 753         /* Chunghwa Telecom touch panels */
 754         {  .driver_data = MT_CLS_DEFAULT,
 755                 HID_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT,
 756                         USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH) },
 757
 758         /* CVTouch panels */
 759         { .driver_data = MT_CLS_DEFAULT,
 760                 HID_USB_DEVICE(USB_VENDOR_ID_CVTOUCH,
 761                         USB_DEVICE_ID_CVTOUCH_SCREEN) },
 762
 763         /* Cypress panel */
 764         { .driver_data = MT_CLS_CYPRESS,
 765                 HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS,
 766                         USB_DEVICE_ID_CYPRESS_TRUETOUCH) },
 767
 768         /* eGalax devices (resistive) */
 769         { .driver_data = MT_CLS_EGALAX,
 770                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
 771                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D) },
 772         { .driver_data = MT_CLS_EGALAX,
 773                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
 774                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E) },
 775
 776         /* eGalax devices (capacitive) */
 777         { .driver_data = MT_CLS_EGALAX,
 778                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
 779                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C) },
 780         { .driver_data = MT_CLS_EGALAX_SERIAL,
 781                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
 782                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7207) },
 783         { .driver_data = MT_CLS_EGALAX_SERIAL,
 784                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
 785                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_725E) },
 786         { .driver_data = MT_CLS_EGALAX_SERIAL,
 787                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
 788                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224) },
 789         { .driver_data = MT_CLS_EGALAX_SERIAL,
 790                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
 791                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_722A) },
 792         { .driver_data = MT_CLS_EGALAX,
 793                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
 794                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B) },
 795         { .driver_data = MT_CLS_EGALAX_SERIAL,
 796                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
 797                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7262) },
 798         { .driver_data = MT_CLS_EGALAX,
 799                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
 800                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1) },
 801         { .driver_data = MT_CLS_EGALAX_SERIAL,
 802                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
 803                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72AA) },
 804         { .driver_data = MT_CLS_EGALAX,
 805                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
 806                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA) },
 807         { .driver_data = MT_CLS_EGALAX,
 808                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
 809                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302) },
 810         { .driver_data = MT_CLS_EGALAX_SERIAL,
 811                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
 812                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7349) },
 813         { .driver_data = MT_CLS_EGALAX_SERIAL,
 814                 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
 815                         USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001) },
 816
 817         /* Elo TouchSystems IntelliTouch Plus panel */
 818         { .driver_data = MT_CLS_DUAL_NSMU_CONTACTID,
 819                 HID_USB_DEVICE(USB_VENDOR_ID_ELO,
 820                         USB_DEVICE_ID_ELO_TS2515) },
 821
 822         /* GeneralTouch panel */
 823         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
 824                 HID_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
 825                         USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
 826
 827         /* GoodTouch panels */
 828         { .driver_data = MT_CLS_DEFAULT,
 829                 HID_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH,
 830                         USB_DEVICE_ID_GOODTOUCH_000f) },
 831
 832         /* Hanvon panels */
 833         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
 834                 HID_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT,
 835                         USB_DEVICE_ID_HANVON_ALT_MULTITOUCH) },
 836
 837         /* Ideacom panel */
 838         { .driver_data = MT_CLS_SERIAL,
 839                 HID_USB_DEVICE(USB_VENDOR_ID_IDEACOM,
 840                         USB_DEVICE_ID_IDEACOM_IDC6650) },
 841         { .driver_data = MT_CLS_SERIAL,
 842                 HID_USB_DEVICE(USB_VENDOR_ID_IDEACOM,
 843                         USB_DEVICE_ID_IDEACOM_IDC6651) },
 844
 845         /* Ilitek dual touch panel */
 846         {  .driver_data = MT_CLS_DEFAULT,
 847                 HID_USB_DEVICE(USB_VENDOR_ID_ILITEK,
 848                         USB_DEVICE_ID_ILITEK_MULTITOUCH) },
 849
 850         /* IRTOUCH panels */
 851         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
 852                 HID_USB_DEVICE(USB_VENDOR_ID_IRTOUCHSYSTEMS,
 853                         USB_DEVICE_ID_IRTOUCH_INFRARED_USB) },
 854
 855         /* LG Display panels */
 856         { .driver_data = MT_CLS_DEFAULT,
 857                 HID_USB_DEVICE(USB_VENDOR_ID_LG,
 858                         USB_DEVICE_ID_LG_MULTITOUCH) },
 859
 860         /* Lumio panels */
 861         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
 862                 HID_USB_DEVICE(USB_VENDOR_ID_LUMIO,
 863                         USB_DEVICE_ID_CRYSTALTOUCH) },
 864         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
 865                 HID_USB_DEVICE(USB_VENDOR_ID_LUMIO,
 866                         USB_DEVICE_ID_CRYSTALTOUCH_DUAL) },
 867
 868         /* MosArt panels */
 869         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
 870                 HID_USB_DEVICE(USB_VENDOR_ID_ASUS,
 871                         USB_DEVICE_ID_ASUS_T91MT)},
 872         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
 873                 HID_USB_DEVICE(USB_VENDOR_ID_ASUS,
 874                         USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO) },
 875         { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
 876                 HID_USB_DEVICE(USB_VENDOR_ID_TURBOX,
 877                         USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART) },
 878
 879         /* Panasonic panels */
 880         { .driver_data = MT_CLS_PANASONIC,
 881                 HID_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
 882                         USB_DEVICE_ID_PANABOARD_UBT780) },
 883         { .driver_data = MT_CLS_PANASONIC,
 884                 HID_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
 885                         USB_DEVICE_ID_PANABOARD_UBT880) },
 886
 887         /* PenMount panels */
 888         { .driver_data = MT_CLS_CONFIDENCE,
 889                 HID_USB_DEVICE(USB_VENDOR_ID_PENMOUNT,
 890                         USB_DEVICE_ID_PENMOUNT_PCI) },
 891
 892         /* PixArt optical touch screen */
 893         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
 894                 HID_USB_DEVICE(USB_VENDOR_ID_PIXART,
 895                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN) },
 896         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
 897                 HID_USB_DEVICE(USB_VENDOR_ID_PIXART,
 898                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1) },
 899         { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
 900                 HID_USB_DEVICE(USB_VENDOR_ID_PIXART,
 901                         USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2) },
 902
 903         /* PixCir-based panels */
 904         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
 905                 HID_USB_DEVICE(USB_VENDOR_ID_HANVON,
 906                         USB_DEVICE_ID_HANVON_MULTITOUCH) },
 907         { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
 908                 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
 909                         USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
 910
 911         /* Quanta-based panels */
 912         { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
 913                 HID_USB_DEVICE(USB_VENDOR_ID_QUANTA,
 914                         USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH) },
 915         { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
 916                 HID_USB_DEVICE(USB_VENDOR_ID_QUANTA,
 917                         USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001) },
 918         { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
 919                 HID_USB_DEVICE(USB_VENDOR_ID_QUANTA,
 920                         USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3008) },
 921
 922         /* Stantum panels */
 923         { .driver_data = MT_CLS_CONFIDENCE,
 924                 HID_USB_DEVICE(USB_VENDOR_ID_STANTUM,
 925                         USB_DEVICE_ID_MTP)},
 926         { .driver_data = MT_CLS_CONFIDENCE,
 927                 HID_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM,
 928                         USB_DEVICE_ID_MTP_STM)},
 929         { .driver_data = MT_CLS_CONFIDENCE,
 930                 HID_USB_DEVICE(USB_VENDOR_ID_STANTUM_SITRONIX,
 931                         USB_DEVICE_ID_MTP_SITRONIX)},
 932
 933         /* TopSeed panels */
 934         { .driver_data = MT_CLS_TOPSEED,
 935                 HID_USB_DEVICE(USB_VENDOR_ID_TOPSEED2,
 936                         USB_DEVICE_ID_TOPSEED2_PERIPAD_701) },
 937
 938         /* Touch International panels */
 939         { .driver_data = MT_CLS_DEFAULT,
 940                 HID_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL,
 941                         USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH) },
 942
 943         /* Unitec panels */
 944         { .driver_data = MT_CLS_DEFAULT,
 945                 HID_USB_DEVICE(USB_VENDOR_ID_UNITEC,
 946                         USB_DEVICE_ID_UNITEC_USB_TOUCH_0709) },
 947         { .driver_data = MT_CLS_DEFAULT,
 948                 HID_USB_DEVICE(USB_VENDOR_ID_UNITEC,
 949                         USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19) },
 950         /* XAT */
 951         { .driver_data = MT_CLS_DEFAULT,
 952                 HID_USB_DEVICE(USB_VENDOR_ID_XAT,
 953                         USB_DEVICE_ID_XAT_CSR) },
 954
 955         /* Xiroku */
 956         { .driver_data = MT_CLS_DEFAULT,
 957                 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
 958                         USB_DEVICE_ID_XIROKU_SPX) },
 959         { .driver_data = MT_CLS_DEFAULT,
 960                 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
 961                         USB_DEVICE_ID_XIROKU_MPX) },
 962         { .driver_data = MT_CLS_DEFAULT,
 963                 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
 964                         USB_DEVICE_ID_XIROKU_CSR) },
 965         { .driver_data = MT_CLS_DEFAULT,
 966                 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
 967                         USB_DEVICE_ID_XIROKU_SPX1) },
 968         { .driver_data = MT_CLS_DEFAULT,
 969                 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
 970                         USB_DEVICE_ID_XIROKU_MPX1) },
 971         { .driver_data = MT_CLS_DEFAULT,
 972                 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
 973                         USB_DEVICE_ID_XIROKU_CSR1) },
 974         { .driver_data = MT_CLS_DEFAULT,
 975                 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
 976                         USB_DEVICE_ID_XIROKU_SPX2) },
 977         { .driver_data = MT_CLS_DEFAULT,
 978                 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
 979                         USB_DEVICE_ID_XIROKU_MPX2) },
 980         { .driver_data = MT_CLS_DEFAULT,
 981                 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
 982                         USB_DEVICE_ID_XIROKU_CSR2) },
 983
 984         { }
 985 };
 986 MODULE_DEVICE_TABLE(hid, mt_devices);
 987
 988 static const struct hid_usage_id mt_grabbed_usages[] = {
 989         { HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
 990         { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
 991 };
 992
 993 static struct hid_driver mt_driver = {
 994         .name = "hid-multitouch",
 995         .id_table = mt_devices,
 996         .probe = mt_probe,
 997         .remove = mt_remove,
 998         .input_mapping = mt_input_mapping,
 999         .input_mapped = mt_input_mapped,
1000         .feature_mapping = mt_feature_mapping,
1001         .usage_table = mt_grabbed_usages,
1002         .event = mt_event,
1003 #ifdef CONFIG_PM
1004         .reset_resume = mt_reset_resume,
1005 #endif
1006 };
1007
1008 static int __init mt_init(void)
1009 {
1010         return hid_register_driver(&mt_driver);
1011 }
1012
1013 static void __exit mt_exit(void)
1014 {
1015         hid_unregister_driver(&mt_driver);
1016 }
1017
1018 module_init(mt_init);
1019 module_exit(mt_exit);