drivers/usb/input/hid-core.c

   1 /*
   2  *  USB HID support for Linux
   3  *
   4  *  Copyright (c) 1999 Andreas Gal
   5  *  Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
   6  *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
   7  */
   8
   9 /*
  10  * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU General Public License as published by the Free
  12  * Software Foundation; either version 2 of the License, or (at your option)
  13  * any later version.
  14  */
  15
  16 #include <linux/module.h>
  17 #include <linux/slab.h>
  18 #include <linux/init.h>
  19 #include <linux/kernel.h>
  20 #include <linux/sched.h>
  21 #include <linux/list.h>
  22 #include <linux/mm.h>
  23 #include <linux/smp_lock.h>
  24 #include <linux/spinlock.h>
  25 #include <asm/unaligned.h>
  26 #include <asm/byteorder.h>
  27 #include <linux/input.h>
  28 #include <linux/wait.h>
  29
  30 #undef DEBUG
  31 #undef DEBUG_DATA
  32
  33 #include <linux/usb.h>
  34
  35 #include "hid.h"
  36 #include <linux/hiddev.h>
  37
  38 /*
  39  * Version Information
  40  */
  41
  42 #define DRIVER_VERSION "v2.6"
  43 #define DRIVER_AUTHOR "Andreas Gal, Vojtech Pavlik"
  44 #define DRIVER_DESC "USB HID core driver"
  45 #define DRIVER_LICENSE "GPL"
  46
  47 static char *hid_types[] = {"Device", "Pointer", "Mouse", "Device", "Joystick",
  48                                 "Gamepad", "Keyboard", "Keypad", "Multi-Axis Controller"};
  49 /*
  50  * Module parameters.
  51  */
  52
  53 static unsigned int hid_mousepoll_interval;
  54 module_param_named(mousepoll, hid_mousepoll_interval, uint, 0644);
  55 MODULE_PARM_DESC(mousepoll, "Polling interval of mice");
  56
  57 /*
  58  * Register a new report for a device.
  59  */
  60
  61 static struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id)
  62 {
  63         struct hid_report_enum *report_enum = device->report_enum + type;
  64         struct hid_report *report;
  65
  66         if (report_enum->report_id_hash[id])
  67                 return report_enum->report_id_hash[id];
  68
  69         if (!(report = kzalloc(sizeof(struct hid_report), GFP_KERNEL)))
  70                 return NULL;
  71
  72         if (id != 0)
  73                 report_enum->numbered = 1;
  74
  75         report->id = id;
  76         report->type = type;
  77         report->size = 0;
  78         report->device = device;
  79         report_enum->report_id_hash[id] = report;
  80
  81         list_add_tail(&report->list, &report_enum->report_list);
  82
  83         return report;
  84 }
  85
  86 /*
  87  * Register a new field for this report.
  88  */
  89
  90 static struct hid_field *hid_register_field(struct hid_report *report, unsigned usages, unsigned values)
  91 {
  92         struct hid_field *field;
  93
  94         if (report->maxfield == HID_MAX_FIELDS) {
  95                 dbg("too many fields in report");
  96                 return NULL;
  97         }
  98
  99         if (!(field = kzalloc(sizeof(struct hid_field) + usages * sizeof(struct hid_usage)
 100                 + values * sizeof(unsigned), GFP_KERNEL))) return NULL;
 101
 102         field->index = report->maxfield++;
 103         report->field[field->index] = field;
 104         field->usage = (struct hid_usage *)(field + 1);
 105         field->value = (unsigned *)(field->usage + usages);
 106         field->report = report;
 107
 108         return field;
 109 }
 110
 111 /*
 112  * Open a collection. The type/usage is pushed on the stack.
 113  */
 114
 115 static int open_collection(struct hid_parser *parser, unsigned type)
 116 {
 117         struct hid_collection *collection;
 118         unsigned usage;
 119
 120         usage = parser->local.usage[0];
 121
 122         if (parser->collection_stack_ptr == HID_COLLECTION_STACK_SIZE) {
 123                 dbg("collection stack overflow");
 124                 return -1;
 125         }
 126
 127         if (parser->device->maxcollection == parser->device->collection_size) {
 128                 collection = kmalloc(sizeof(struct hid_collection) *
 129                                 parser->device->collection_size * 2, GFP_KERNEL);
 130                 if (collection == NULL) {
 131                         dbg("failed to reallocate collection array");
 132                         return -1;
 133                 }
 134                 memcpy(collection, parser->device->collection,
 135                         sizeof(struct hid_collection) *
 136                         parser->device->collection_size);
 137                 memset(collection + parser->device->collection_size, 0,
 138                         sizeof(struct hid_collection) *
 139                         parser->device->collection_size);
 140                 kfree(parser->device->collection);
 141                 parser->device->collection = collection;
 142                 parser->device->collection_size *= 2;
 143         }
 144
 145         parser->collection_stack[parser->collection_stack_ptr++] =
 146                 parser->device->maxcollection;
 147
 148         collection = parser->device->collection +
 149                 parser->device->maxcollection++;
 150         collection->type = type;
 151         collection->usage = usage;
 152         collection->level = parser->collection_stack_ptr - 1;
 153
 154         if (type == HID_COLLECTION_APPLICATION)
 155                 parser->device->maxapplication++;
 156
 157         return 0;
 158 }
 159
 160 /*
 161  * Close a collection.
 162  */
 163
 164 static int close_collection(struct hid_parser *parser)
 165 {
 166         if (!parser->collection_stack_ptr) {
 167                 dbg("collection stack underflow");
 168                 return -1;
 169         }
 170         parser->collection_stack_ptr--;
 171         return 0;
 172 }
 173
 174 /*
 175  * Climb up the stack, search for the specified collection type
 176  * and return the usage.
 177  */
 178
 179 static unsigned hid_lookup_collection(struct hid_parser *parser, unsigned type)
 180 {
 181         int n;
 182         for (n = parser->collection_stack_ptr - 1; n >= 0; n--)
 183                 if (parser->device->collection[parser->collection_stack[n]].type == type)
 184                         return parser->device->collection[parser->collection_stack[n]].usage;
 185         return 0; /* we know nothing about this usage type */
 186 }
 187
 188 /*
 189  * Add a usage to the temporary parser table.
 190  */
 191
 192 static int hid_add_usage(struct hid_parser *parser, unsigned usage)
 193 {
 194         if (parser->local.usage_index >= HID_MAX_USAGES) {
 195                 dbg("usage index exceeded");
 196                 return -1;
 197         }
 198         parser->local.usage[parser->local.usage_index] = usage;
 199         parser->local.collection_index[parser->local.usage_index] =
 200                 parser->collection_stack_ptr ?
 201                 parser->collection_stack[parser->collection_stack_ptr - 1] : 0;
 202         parser->local.usage_index++;
 203         return 0;
 204 }
 205
 206 /*
 207  * Register a new field for this report.
 208  */
 209
 210 static int hid_add_field(struct hid_parser *parser, unsigned report_type, unsigned flags)
 211 {
 212         struct hid_report *report;
 213         struct hid_field *field;
 214         int usages;
 215         unsigned offset;
 216         int i;
 217
 218         if (!(report = hid_register_report(parser->device, report_type, parser->global.report_id))) {
 219                 dbg("hid_register_report failed");
 220                 return -1;
 221         }
 222
 223         if (parser->global.logical_maximum < parser->global.logical_minimum) {
 224                 dbg("logical range invalid %d %d", parser->global.logical_minimum, parser->global.logical_maximum);
 225                 return -1;
 226         }
 227
 228         offset = report->size;
 229         report->size += parser->global.report_size * parser->global.report_count;
 230
 231         if (!parser->local.usage_index) /* Ignore padding fields */
 232                 return 0;
 233
 234         usages = max_t(int, parser->local.usage_index, parser->global.report_count);
 235
 236         if ((field = hid_register_field(report, usages, parser->global.report_count)) == NULL)
 237                 return 0;
 238
 239         field->physical = hid_lookup_collection(parser, HID_COLLECTION_PHYSICAL);
 240         field->logical = hid_lookup_collection(parser, HID_COLLECTION_LOGICAL);
 241         field->application = hid_lookup_collection(parser, HID_COLLECTION_APPLICATION);
 242
 243         for (i = 0; i < usages; i++) {
 244                 int j = i;
 245                 /* Duplicate the last usage we parsed if we have excess values */
 246                 if (i >= parser->local.usage_index)
 247                         j = parser->local.usage_index - 1;
 248                 field->usage[i].hid = parser->local.usage[j];
 249                 field->usage[i].collection_index =
 250                         parser->local.collection_index[j];
 251         }
 252
 253         field->maxusage = usages;
 254         field->flags = flags;
 255         field->report_offset = offset;
 256         field->report_type = report_type;
 257         field->report_size = parser->global.report_size;
 258         field->report_count = parser->global.report_count;
 259         field->logical_minimum = parser->global.logical_minimum;
 260         field->logical_maximum = parser->global.logical_maximum;
 261         field->physical_minimum = parser->global.physical_minimum;
 262         field->physical_maximum = parser->global.physical_maximum;
 263         field->unit_exponent = parser->global.unit_exponent;
 264         field->unit = parser->global.unit;
 265
 266         return 0;
 267 }
 268
 269 /*
 270  * Read data value from item.
 271  */
 272
 273 static __inline__ __u32 item_udata(struct hid_item *item)
 274 {
 275         switch (item->size) {
 276                 case 1: return item->data.u8;
 277                 case 2: return item->data.u16;
 278                 case 4: return item->data.u32;
 279         }
 280         return 0;
 281 }
 282
 283 static __inline__ __s32 item_sdata(struct hid_item *item)
 284 {
 285         switch (item->size) {
 286                 case 1: return item->data.s8;
 287                 case 2: return item->data.s16;
 288                 case 4: return item->data.s32;
 289         }
 290         return 0;
 291 }
 292
 293 /*
 294  * Process a global item.
 295  */
 296
 297 static int hid_parser_global(struct hid_parser *parser, struct hid_item *item)
 298 {
 299         switch (item->tag) {
 300
 301                 case HID_GLOBAL_ITEM_TAG_PUSH:
 302
 303                         if (parser->global_stack_ptr == HID_GLOBAL_STACK_SIZE) {
 304                                 dbg("global enviroment stack overflow");
 305                                 return -1;
 306                         }
 307
 308                         memcpy(parser->global_stack + parser->global_stack_ptr++,
 309                                 &parser->global, sizeof(struct hid_global));
 310                         return 0;
 311
 312                 case HID_GLOBAL_ITEM_TAG_POP:
 313
 314                         if (!parser->global_stack_ptr) {
 315                                 dbg("global enviroment stack underflow");
 316                                 return -1;
 317                         }
 318
 319                         memcpy(&parser->global, parser->global_stack + --parser->global_stack_ptr,
 320                                 sizeof(struct hid_global));
 321                         return 0;
 322
 323                 case HID_GLOBAL_ITEM_TAG_USAGE_PAGE:
 324                         parser->global.usage_page = item_udata(item);
 325                         return 0;
 326
 327                 case HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM:
 328                         parser->global.logical_minimum = item_sdata(item);
 329                         return 0;
 330
 331                 case HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM:
 332                         if (parser->global.logical_minimum < 0)
 333                                 parser->global.logical_maximum = item_sdata(item);
 334                         else
 335                                 parser->global.logical_maximum = item_udata(item);
 336                         return 0;
 337
 338                 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM:
 339                         parser->global.physical_minimum = item_sdata(item);
 340                         return 0;
 341
 342                 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM:
 343                         if (parser->global.physical_minimum < 0)
 344                                 parser->global.physical_maximum = item_sdata(item);
 345                         else
 346                                 parser->global.physical_maximum = item_udata(item);
 347                         return 0;
 348
 349                 case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT:
 350                         parser->global.unit_exponent = item_sdata(item);
 351                         return 0;
 352
 353                 case HID_GLOBAL_ITEM_TAG_UNIT:
 354                         parser->global.unit = item_udata(item);
 355                         return 0;
 356
 357                 case HID_GLOBAL_ITEM_TAG_REPORT_SIZE:
 358                         if ((parser->global.report_size = item_udata(item)) > 32) {
 359                                 dbg("invalid report_size %d", parser->global.report_size);
 360                                 return -1;
 361                         }
 362                         return 0;
 363
 364                 case HID_GLOBAL_ITEM_TAG_REPORT_COUNT:
 365                         if ((parser->global.report_count = item_udata(item)) > HID_MAX_USAGES) {
 366                                 dbg("invalid report_count %d", parser->global.report_count);
 367                                 return -1;
 368                         }
 369                         return 0;
 370
 371                 case HID_GLOBAL_ITEM_TAG_REPORT_ID:
 372                         if ((parser->global.report_id = item_udata(item)) == 0) {
 373                                 dbg("report_id 0 is invalid");
 374                                 return -1;
 375                         }
 376                         return 0;
 377
 378                 default:
 379                         dbg("unknown global tag 0x%x", item->tag);
 380                         return -1;
 381         }
 382 }
 383
 384 /*
 385  * Process a local item.
 386  */
 387
 388 static int hid_parser_local(struct hid_parser *parser, struct hid_item *item)
 389 {
 390         __u32 data;
 391         unsigned n;
 392
 393         if (item->size == 0) {
 394                 dbg("item data expected for local item");
 395                 return -1;
 396         }
 397
 398         data = item_udata(item);
 399
 400         switch (item->tag) {
 401
 402                 case HID_LOCAL_ITEM_TAG_DELIMITER:
 403
 404                         if (data) {
 405                                 /*
 406                                  * We treat items before the first delimiter
 407                                  * as global to all usage sets (branch 0).
 408                                  * In the moment we process only these global
 409                                  * items and the first delimiter set.
 410                                  */
 411                                 if (parser->local.delimiter_depth != 0) {
 412                                         dbg("nested delimiters");
 413                                         return -1;
 414                                 }
 415                                 parser->local.delimiter_depth++;
 416                                 parser->local.delimiter_branch++;
 417                         } else {
 418                                 if (parser->local.delimiter_depth < 1) {
 419                                         dbg("bogus close delimiter");
 420                                         return -1;
 421                                 }
 422                                 parser->local.delimiter_depth--;
 423                         }
 424                         return 1;
 425
 426                 case HID_LOCAL_ITEM_TAG_USAGE:
 427
 428                         if (parser->local.delimiter_branch > 1) {
 429                                 dbg("alternative usage ignored");
 430                                 return 0;
 431                         }
 432
 433                         if (item->size <= 2)
 434                                 data = (parser->global.usage_page << 16) + data;
 435
 436                         return hid_add_usage(parser, data);
 437
 438                 case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:
 439
 440                         if (parser->local.delimiter_branch > 1) {
 441                                 dbg("alternative usage ignored");
 442                                 return 0;
 443                         }
 444
 445                         if (item->size <= 2)
 446                                 data = (parser->global.usage_page << 16) + data;
 447
 448                         parser->local.usage_minimum = data;
 449                         return 0;
 450
 451                 case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:
 452
 453                         if (parser->local.delimiter_branch > 1) {
 454                                 dbg("alternative usage ignored");
 455                                 return 0;
 456                         }
 457
 458                         if (item->size <= 2)
 459                                 data = (parser->global.usage_page << 16) + data;
 460
 461                         for (n = parser->local.usage_minimum; n <= data; n++)
 462                                 if (hid_add_usage(parser, n)) {
 463                                         dbg("hid_add_usage failed\n");
 464                                         return -1;
 465                                 }
 466                         return 0;
 467
 468                 default:
 469
 470                         dbg("unknown local item tag 0x%x", item->tag);
 471                         return 0;
 472         }
 473         return 0;
 474 }
 475
 476 /*
 477  * Process a main item.
 478  */
 479
 480 static int hid_parser_main(struct hid_parser *parser, struct hid_item *item)
 481 {
 482         __u32 data;
 483         int ret;
 484
 485         data = item_udata(item);
 486
 487         switch (item->tag) {
 488                 case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION:
 489                         ret = open_collection(parser, data & 0xff);
 490                         break;
 491                 case HID_MAIN_ITEM_TAG_END_COLLECTION:
 492                         ret = close_collection(parser);
 493                         break;
 494                 case HID_MAIN_ITEM_TAG_INPUT:
 495                         ret = hid_add_field(parser, HID_INPUT_REPORT, data);
 496                         break;
 497                 case HID_MAIN_ITEM_TAG_OUTPUT:
 498                         ret = hid_add_field(parser, HID_OUTPUT_REPORT, data);
 499                         break;
 500                 case HID_MAIN_ITEM_TAG_FEATURE:
 501                         ret = hid_add_field(parser, HID_FEATURE_REPORT, data);
 502                         break;
 503                 default:
 504                         dbg("unknown main item tag 0x%x", item->tag);
 505                         ret = 0;
 506         }
 507
 508         memset(&parser->local, 0, sizeof(parser->local));       /* Reset the local parser environment */
 509
 510         return ret;
 511 }
 512
 513 /*
 514  * Process a reserved item.
 515  */
 516
 517 static int hid_parser_reserved(struct hid_parser *parser, struct hid_item *item)
 518 {
 519         dbg("reserved item type, tag 0x%x", item->tag);
 520         return 0;
 521 }
 522
 523 /*
 524  * Free a report and all registered fields. The field->usage and
 525  * field->value table's are allocated behind the field, so we need
 526  * only to free(field) itself.
 527  */
 528
 529 static void hid_free_report(struct hid_report *report)
 530 {
 531         unsigned n;
 532
 533         for (n = 0; n < report->maxfield; n++)
 534                 kfree(report->field[n]);
 535         kfree(report);
 536 }
 537
 538 /*
 539  * Free a device structure, all reports, and all fields.
 540  */
 541
 542 static void hid_free_device(struct hid_device *device)
 543 {
 544         unsigned i,j;
 545
 546         for (i = 0; i < HID_REPORT_TYPES; i++) {
 547                 struct hid_report_enum *report_enum = device->report_enum + i;
 548
 549                 for (j = 0; j < 256; j++) {
 550                         struct hid_report *report = report_enum->report_id_hash[j];
 551                         if (report)
 552                                 hid_free_report(report);
 553                 }
 554         }
 555
 556         kfree(device->rdesc);
 557         kfree(device);
 558 }
 559
 560 /*
 561  * Fetch a report description item from the data stream. We support long
 562  * items, though they are not used yet.
 563  */
 564
 565 static u8 *fetch_item(__u8 *start, __u8 *end, struct hid_item *item)
 566 {
 567         u8 b;
 568
 569         if ((end - start) <= 0)
 570                 return NULL;
 571
 572         b = *start++;
 573
 574         item->type = (b >> 2) & 3;
 575         item->tag  = (b >> 4) & 15;
 576
 577         if (item->tag == HID_ITEM_TAG_LONG) {
 578
 579                 item->format = HID_ITEM_FORMAT_LONG;
 580
 581                 if ((end - start) < 2)
 582                         return NULL;
 583
 584                 item->size = *start++;
 585                 item->tag  = *start++;
 586
 587                 if ((end - start) < item->size)
 588                         return NULL;
 589
 590                 item->data.longdata = start;
 591                 start += item->size;
 592                 return start;
 593         }
 594
 595         item->format = HID_ITEM_FORMAT_SHORT;
 596         item->size = b & 3;
 597
 598         switch (item->size) {
 599
 600                 case 0:
 601                         return start;
 602
 603                 case 1:
 604                         if ((end - start) < 1)
 605                                 return NULL;
 606                         item->data.u8 = *start++;
 607                         return start;
 608
 609                 case 2:
 610                         if ((end - start) < 2)
 611                                 return NULL;
 612                         item->data.u16 = le16_to_cpu(get_unaligned((__le16*)start));
 613                         start = (__u8 *)((__le16 *)start + 1);
 614                         return start;
 615
 616                 case 3:
 617                         item->size++;
 618                         if ((end - start) < 4)
 619                                 return NULL;
 620                         item->data.u32 = le32_to_cpu(get_unaligned((__le32*)start));
 621                         start = (__u8 *)((__le32 *)start + 1);
 622                         return start;
 623         }
 624
 625         return NULL;
 626 }
 627
 628 /*
 629  * Parse a report description into a hid_device structure. Reports are
 630  * enumerated, fields are attached to these reports.
 631  */
 632
 633 static struct hid_device *hid_parse_report(__u8 *start, unsigned size)
 634 {
 635         struct hid_device *device;
 636         struct hid_parser *parser;
 637         struct hid_item item;
 638         __u8 *end;
 639         unsigned i;
 640         static int (*dispatch_type[])(struct hid_parser *parser,
 641                                       struct hid_item *item) = {
 642                 hid_parser_main,
 643                 hid_parser_global,
 644                 hid_parser_local,
 645                 hid_parser_reserved
 646         };
 647
 648         if (!(device = kzalloc(sizeof(struct hid_device), GFP_KERNEL)))
 649                 return NULL;
 650
 651         if (!(device->collection = kzalloc(sizeof(struct hid_collection) *
 652                                    HID_DEFAULT_NUM_COLLECTIONS, GFP_KERNEL))) {
 653                 kfree(device);
 654                 return NULL;
 655         }
 656         device->collection_size = HID_DEFAULT_NUM_COLLECTIONS;
 657
 658         for (i = 0; i < HID_REPORT_TYPES; i++)
 659                 INIT_LIST_HEAD(&device->report_enum[i].report_list);
 660
 661         if (!(device->rdesc = (__u8 *)kmalloc(size, GFP_KERNEL))) {
 662                 kfree(device->collection);
 663                 kfree(device);
 664                 return NULL;
 665         }
 666         memcpy(device->rdesc, start, size);
 667         device->rsize = size;
 668
 669         if (!(parser = kzalloc(sizeof(struct hid_parser), GFP_KERNEL))) {
 670                 kfree(device->rdesc);
 671                 kfree(device->collection);
 672                 kfree(device);
 673                 return NULL;
 674         }
 675         parser->device = device;
 676
 677         end = start + size;
 678         while ((start = fetch_item(start, end, &item)) != NULL) {
 679
 680                 if (item.format != HID_ITEM_FORMAT_SHORT) {
 681                         dbg("unexpected long global item");
 682                         kfree(device->collection);
 683                         hid_free_device(device);
 684                         kfree(parser);
 685                         return NULL;
 686                 }
 687
 688                 if (dispatch_type[item.type](parser, &item)) {
 689                         dbg("item %u %u %u %u parsing failed\n",
 690                                 item.format, (unsigned)item.size, (unsigned)item.type, (unsigned)item.tag);
 691                         kfree(device->collection);
 692                         hid_free_device(device);
 693                         kfree(parser);
 694                         return NULL;
 695                 }
 696
 697                 if (start == end) {
 698                         if (parser->collection_stack_ptr) {
 699                                 dbg("unbalanced collection at end of report description");
 700                                 kfree(device->collection);
 701                                 hid_free_device(device);
 702                                 kfree(parser);
 703                                 return NULL;
 704                         }
 705                         if (parser->local.delimiter_depth) {
 706                                 dbg("unbalanced delimiter at end of report description");
 707                                 kfree(device->collection);
 708                                 hid_free_device(device);
 709                                 kfree(parser);
 710                                 return NULL;
 711                         }
 712                         kfree(parser);
 713                         return device;
 714                 }
 715         }
 716
 717         dbg("item fetching failed at offset %d\n", (int)(end - start));
 718         kfree(device->collection);
 719         hid_free_device(device);
 720         kfree(parser);
 721         return NULL;
 722 }
 723
 724 /*
 725  * Convert a signed n-bit integer to signed 32-bit integer. Common
 726  * cases are done through the compiler, the screwed things has to be
 727  * done by hand.
 728  */
 729
 730 static __inline__ __s32 snto32(__u32 value, unsigned n)
 731 {
 732         switch (n) {
 733                 case 8:  return ((__s8)value);
 734                 case 16: return ((__s16)value);
 735                 case 32: return ((__s32)value);
 736         }
 737         return value & (1 << (n - 1)) ? value | (-1 << n) : value;
 738 }
 739
 740 /*
 741  * Convert a signed 32-bit integer to a signed n-bit integer.
 742  */
 743
 744 static __inline__ __u32 s32ton(__s32 value, unsigned n)
 745 {
 746         __s32 a = value >> (n - 1);
 747         if (a && a != -1)
 748                 return value < 0 ? 1 << (n - 1) : (1 << (n - 1)) - 1;
 749         return value & ((1 << n) - 1);
 750 }
 751
 752 /*
 753  * Extract/implement a data field from/to a report.
 754  */
 755
 756 static __inline__ __u32 extract(__u8 *report, unsigned offset, unsigned n)
 757 {
 758         report += (offset >> 5) << 2; offset &= 31;
 759         return (le64_to_cpu(get_unaligned((__le64*)report)) >> offset) & ((1ULL << n) - 1);
 760 }
 761
 762 static __inline__ void implement(__u8 *report, unsigned offset, unsigned n, __u32 value)
 763 {
 764         report += (offset >> 5) << 2; offset &= 31;
 765         put_unaligned((get_unaligned((__le64*)report)
 766                 & cpu_to_le64(~((((__u64) 1 << n) - 1) << offset)))
 767                 | cpu_to_le64((__u64)value << offset), (__le64*)report);
 768 }
 769
 770 /*
 771  * Search an array for a value.
 772  */
 773
 774 static __inline__ int search(__s32 *array, __s32 value, unsigned n)
 775 {
 776         while (n--) {
 777                 if (*array++ == value)
 778                         return 0;
 779         }
 780         return -1;
 781 }
 782
 783 static void hid_process_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value, int interrupt, struct pt_regs *regs)
 784 {
 785         hid_dump_input(usage, value);
 786         if (hid->claimed & HID_CLAIMED_INPUT)
 787                 hidinput_hid_event(hid, field, usage, value, regs);
 788         if (hid->claimed & HID_CLAIMED_HIDDEV && interrupt)
 789                 hiddev_hid_event(hid, field, usage, value, regs);
 790 }
 791
 792 /*
 793  * Analyse a received field, and fetch the data from it. The field
 794  * content is stored for next report processing (we do differential
 795  * reporting to the layer).
 796  */
 797
 798 static void hid_input_field(struct hid_device *hid, struct hid_field *field, __u8 *data, int interrupt, struct pt_regs *regs)
 799 {
 800         unsigned n;
 801         unsigned count = field->report_count;
 802         unsigned offset = field->report_offset;
 803         unsigned size = field->report_size;
 804         __s32 min = field->logical_minimum;
 805         __s32 max = field->logical_maximum;
 806         __s32 *value;
 807
 808         if (!(value = kmalloc(sizeof(__s32) * count, GFP_ATOMIC)))
 809                 return;
 810
 811         for (n = 0; n < count; n++) {
 812
 813                         value[n] = min < 0 ? snto32(extract(data, offset + n * size, size), size) :
 814                                                     extract(data, offset + n * size, size);
 815
 816                         if (!(field->flags & HID_MAIN_ITEM_VARIABLE) /* Ignore report if ErrorRollOver */
 817                             && value[n] >= min && value[n] <= max
 818                             && field->usage[value[n] - min].hid == HID_UP_KEYBOARD + 1)
 819                                 goto exit;
 820         }
 821
 822         for (n = 0; n < count; n++) {
 823
 824                 if (HID_MAIN_ITEM_VARIABLE & field->flags) {
 825                         hid_process_event(hid, field, &field->usage[n], value[n], interrupt, regs);
 826                         continue;
 827                 }
 828
 829                 if (field->value[n] >= min && field->value[n] <= max
 830                         && field->usage[field->value[n] - min].hid
 831                         && search(value, field->value[n], count))
 832                                 hid_process_event(hid, field, &field->usage[field->value[n] - min], 0, interrupt, regs);
 833
 834                 if (value[n] >= min && value[n] <= max
 835                         && field->usage[value[n] - min].hid
 836                         && search(field->value, value[n], count))
 837                                 hid_process_event(hid, field, &field->usage[value[n] - min], 1, interrupt, regs);
 838         }
 839
 840         memcpy(field->value, value, count * sizeof(__s32));
 841 exit:
 842         kfree(value);
 843 }
 844
 845 static int hid_input_report(int type, struct urb *urb, int interrupt, struct pt_regs *regs)
 846 {
 847         struct hid_device *hid = urb->context;
 848         struct hid_report_enum *report_enum = hid->report_enum + type;
 849         u8 *data = urb->transfer_buffer;
 850         int len = urb->actual_length;
 851         struct hid_report *report;
 852         int n, size;
 853
 854         if (!len) {
 855                 dbg("empty report");
 856                 return -1;
 857         }
 858
 859 #ifdef DEBUG_DATA
 860         printk(KERN_DEBUG __FILE__ ": report (size %u) (%snumbered)\n", len, report_enum->numbered ? "" : "un");
 861 #endif
 862
 863         n = 0;                          /* Normally report number is 0 */
 864         if (report_enum->numbered) {    /* Device uses numbered reports, data[0] is report number */
 865                 n = *data++;
 866                 len--;
 867         }
 868
 869 #ifdef DEBUG_DATA
 870         {
 871                 int i;
 872                 printk(KERN_DEBUG __FILE__ ": report %d (size %u) = ", n, len);
 873                 for (i = 0; i < len; i++)
 874                         printk(" %02x", data[i]);
 875                 printk("\n");
 876         }
 877 #endif
 878
 879         if (!(report = report_enum->report_id_hash[n])) {
 880                 dbg("undefined report_id %d received", n);
 881                 return -1;
 882         }
 883
 884         size = ((report->size - 1) >> 3) + 1;
 885
 886         if (len < size) {
 887                 dbg("report %d is too short, (%d < %d)", report->id, len, size);
 888                 memset(data + len, 0, size - len);
 889         }
 890
 891         if (hid->claimed & HID_CLAIMED_HIDDEV)
 892                 hiddev_report_event(hid, report);
 893
 894         for (n = 0; n < report->maxfield; n++)
 895                 hid_input_field(hid, report->field[n], data, interrupt, regs);
 896
 897         if (hid->claimed & HID_CLAIMED_INPUT)
 898                 hidinput_report_event(hid, report);
 899
 900         return 0;
 901 }
 902
 903 /*
 904  * Input submission and I/O error handler.
 905  */
 906
 907 static void hid_io_error(struct hid_device *hid);
 908
 909 /* Start up the input URB */
 910 static int hid_start_in(struct hid_device *hid)
 911 {
 912         unsigned long flags;
 913         int rc = 0;
 914
 915         spin_lock_irqsave(&hid->inlock, flags);
 916         if (hid->open > 0 && !test_bit(HID_SUSPENDED, &hid->iofl) &&
 917                         !test_and_set_bit(HID_IN_RUNNING, &hid->iofl)) {
 918                 rc = usb_submit_urb(hid->urbin, GFP_ATOMIC);
 919                 if (rc != 0)
 920                         clear_bit(HID_IN_RUNNING, &hid->iofl);
 921         }
 922         spin_unlock_irqrestore(&hid->inlock, flags);
 923         return rc;
 924 }
 925
 926 /* I/O retry timer routine */
 927 static void hid_retry_timeout(unsigned long _hid)
 928 {
 929         struct hid_device *hid = (struct hid_device *) _hid;
 930
 931         dev_dbg(&hid->intf->dev, "retrying intr urb\n");
 932         if (hid_start_in(hid))
 933                 hid_io_error(hid);
 934 }
 935
 936 /* Workqueue routine to reset the device */
 937 static void hid_reset(void *_hid)
 938 {
 939         struct hid_device *hid = (struct hid_device *) _hid;
 940         int rc_lock, rc;
 941
 942         dev_dbg(&hid->intf->dev, "resetting device\n");
 943         rc = rc_lock = usb_lock_device_for_reset(hid->dev, hid->intf);
 944         if (rc_lock >= 0) {
 945                 rc = usb_reset_composite_device(hid->dev, hid->intf);
 946                 if (rc_lock)
 947                         usb_unlock_device(hid->dev);
 948         }
 949         clear_bit(HID_RESET_PENDING, &hid->iofl);
 950
 951         switch (rc) {
 952         case 0:
 953                 if (!test_bit(HID_IN_RUNNING, &hid->iofl))
 954                         hid_io_error(hid);
 955                 break;
 956         default:
 957                 err("can't reset device, %s-%s/input%d, status %d",
 958                                 hid->dev->bus->bus_name,
 959                                 hid->dev->devpath,
 960                                 hid->ifnum, rc);
 961                 /* FALLTHROUGH */
 962         case -EHOSTUNREACH:
 963         case -ENODEV:
 964         case -EINTR:
 965                 break;
 966         }
 967 }
 968
 969 /* Main I/O error handler */
 970 static void hid_io_error(struct hid_device *hid)
 971 {
 972         unsigned long flags;
 973
 974         spin_lock_irqsave(&hid->inlock, flags);
 975
 976         /* Stop when disconnected */
 977         if (usb_get_intfdata(hid->intf) == NULL)
 978                 goto done;
 979
 980         /* When an error occurs, retry at increasing intervals */
 981         if (hid->retry_delay == 0) {
 982                 hid->retry_delay = 13;  /* Then 26, 52, 104, 104, ... */
 983                 hid->stop_retry = jiffies + msecs_to_jiffies(1000);
 984         } else if (hid->retry_delay < 100)
 985                 hid->retry_delay *= 2;
 986
 987         if (time_after(jiffies, hid->stop_retry)) {
 988
 989                 /* Retries failed, so do a port reset */
 990                 if (!test_and_set_bit(HID_RESET_PENDING, &hid->iofl)) {
 991                         if (schedule_work(&hid->reset_work))
 992                                 goto done;
 993                         clear_bit(HID_RESET_PENDING, &hid->iofl);
 994                 }
 995         }
 996
 997         mod_timer(&hid->io_retry,
 998                         jiffies + msecs_to_jiffies(hid->retry_delay));
 999 done:
1000         spin_unlock_irqrestore(&hid->inlock, flags);
1001 }
1002
1003 /*
1004  * Input interrupt completion handler.
1005  */
1006
1007 static void hid_irq_in(struct urb *urb, struct pt_regs *regs)
1008 {
1009         struct hid_device       *hid = urb->context;
1010         int                     status;
1011
1012         switch (urb->status) {
1013                 case 0:                 /* success */
1014                         hid->retry_delay = 0;
1015                         hid_input_report(HID_INPUT_REPORT, urb, 1, regs);
1016                         break;
1017                 case -ECONNRESET:       /* unlink */
1018                 case -ENOENT:
1019                 case -ESHUTDOWN:        /* unplug */
1020                         clear_bit(HID_IN_RUNNING, &hid->iofl);
1021                         return;
1022                 case -EILSEQ:           /* protocol error or unplug */
1023                 case -EPROTO:           /* protocol error or unplug */
1024                 case -ETIMEDOUT:        /* NAK */
1025                         clear_bit(HID_IN_RUNNING, &hid->iofl);
1026                         hid_io_error(hid);
1027                         return;
1028                 default:                /* error */
1029                         warn("input irq status %d received", urb->status);
1030         }
1031
1032         status = usb_submit_urb(urb, SLAB_ATOMIC);
1033         if (status) {
1034                 clear_bit(HID_IN_RUNNING, &hid->iofl);
1035                 if (status != -EPERM) {
1036                         err("can't resubmit intr, %s-%s/input%d, status %d",
1037                                         hid->dev->bus->bus_name,
1038                                         hid->dev->devpath,
1039                                         hid->ifnum, status);
1040                         hid_io_error(hid);
1041                 }
1042         }
1043 }
1044
1045 /*
1046  * Output the field into the report.
1047  */
1048
1049 static void hid_output_field(struct hid_field *field, __u8 *data)
1050 {
1051         unsigned count = field->report_count;
1052         unsigned offset = field->report_offset;
1053         unsigned size = field->report_size;
1054         unsigned n;
1055
1056         for (n = 0; n < count; n++) {
1057                 if (field->logical_minimum < 0) /* signed values */
1058                         implement(data, offset + n * size, size, s32ton(field->value[n], size));
1059                 else                            /* unsigned values */
1060                         implement(data, offset + n * size, size, field->value[n]);
1061         }
1062 }
1063
1064 /*
1065  * Create a report.
1066  */
1067
1068 static void hid_output_report(struct hid_report *report, __u8 *data)
1069 {
1070         unsigned n;
1071
1072         if (report->id > 0)
1073                 *data++ = report->id;
1074
1075         for (n = 0; n < report->maxfield; n++)
1076                 hid_output_field(report->field[n], data);
1077 }
1078
1079 /*
1080  * Set a field value. The report this field belongs to has to be
1081  * created and transferred to the device, to set this value in the
1082  * device.
1083  */
1084
1085 int hid_set_field(struct hid_field *field, unsigned offset, __s32 value)
1086 {
1087         unsigned size = field->report_size;
1088
1089         hid_dump_input(field->usage + offset, value);
1090
1091         if (offset >= field->report_count) {
1092                 dbg("offset (%d) exceeds report_count (%d)", offset, field->report_count);
1093                 hid_dump_field(field, 8);
1094                 return -1;
1095         }
1096         if (field->logical_minimum < 0) {
1097                 if (value != snto32(s32ton(value, size), size)) {
1098                         dbg("value %d is out of range", value);
1099                         return -1;
1100                 }
1101         }
1102         field->value[offset] = value;
1103         return 0;
1104 }
1105
1106 /*
1107  * Find a report field with a specified HID usage.
1108  */
1109
1110 struct hid_field *hid_find_field_by_usage(struct hid_device *hid, __u32 wanted_usage, int type)
1111 {
1112         struct hid_report *report;
1113         int i;
1114
1115         list_for_each_entry(report, &hid->report_enum[type].report_list, list)
1116                 for (i = 0; i < report->maxfield; i++)
1117                         if (report->field[i]->logical == wanted_usage)
1118                                 return report->field[i];
1119         return NULL;
1120 }
1121
1122 static int hid_submit_out(struct hid_device *hid)
1123 {
1124         struct hid_report *report;
1125
1126         report = hid->out[hid->outtail];
1127
1128         hid_output_report(report, hid->outbuf);
1129         hid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
1130         hid->urbout->dev = hid->dev;
1131
1132         dbg("submitting out urb");
1133
1134         if (usb_submit_urb(hid->urbout, GFP_ATOMIC)) {
1135                 err("usb_submit_urb(out) failed");
1136                 return -1;
1137         }
1138
1139         return 0;
1140 }
1141
1142 static int hid_submit_ctrl(struct hid_device *hid)
1143 {
1144         struct hid_report *report;
1145         unsigned char dir;
1146         int len;
1147
1148         report = hid->ctrl[hid->ctrltail].report;
1149         dir = hid->ctrl[hid->ctrltail].dir;
1150
1151         len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
1152         if (dir == USB_DIR_OUT) {
1153                 hid_output_report(report, hid->ctrlbuf);
1154                 hid->urbctrl->pipe = usb_sndctrlpipe(hid->dev, 0);
1155                 hid->urbctrl->transfer_buffer_length = len;
1156         } else {
1157                 int maxpacket, padlen;
1158
1159                 hid->urbctrl->pipe = usb_rcvctrlpipe(hid->dev, 0);
1160                 maxpacket = usb_maxpacket(hid->dev, hid->urbctrl->pipe, 0);
1161                 if (maxpacket > 0) {
1162                         padlen = (len + maxpacket - 1) / maxpacket;
1163                         padlen *= maxpacket;
1164                         if (padlen > hid->bufsize)
1165                                 padlen = hid->bufsize;
1166                 } else
1167                         padlen = 0;
1168                 hid->urbctrl->transfer_buffer_length = padlen;
1169         }
1170         hid->urbctrl->dev = hid->dev;
1171
1172         hid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
1173         hid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
1174         hid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
1175         hid->cr->wIndex = cpu_to_le16(hid->ifnum);
1176         hid->cr->wLength = cpu_to_le16(len);
1177
1178         dbg("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u",
1179                 hid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
1180                 hid->cr->wValue, hid->cr->wIndex, hid->cr->wLength);
1181
1182         if (usb_submit_urb(hid->urbctrl, GFP_ATOMIC)) {
1183                 err("usb_submit_urb(ctrl) failed");
1184                 return -1;
1185         }
1186
1187         return 0;
1188 }
1189
1190 /*
1191  * Output interrupt completion handler.
1192  */
1193
1194 static void hid_irq_out(struct urb *urb, struct pt_regs *regs)
1195 {
1196         struct hid_device *hid = urb->context;
1197         unsigned long flags;
1198         int unplug = 0;
1199
1200         switch (urb->status) {
1201                 case 0:                 /* success */
1202                         break;
1203                 case -ESHUTDOWN:        /* unplug */
1204                         unplug = 1;
1205                 case -EILSEQ:           /* protocol error or unplug */
1206                 case -EPROTO:           /* protocol error or unplug */
1207                 case -ECONNRESET:       /* unlink */
1208                 case -ENOENT:
1209                         break;
1210                 default:                /* error */
1211                         warn("output irq status %d received", urb->status);
1212         }
1213
1214         spin_lock_irqsave(&hid->outlock, flags);
1215
1216         if (unplug)
1217                 hid->outtail = hid->outhead;
1218         else
1219                 hid->outtail = (hid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
1220
1221         if (hid->outhead != hid->outtail) {
1222                 if (hid_submit_out(hid)) {
1223                         clear_bit(HID_OUT_RUNNING, &hid->iofl);
1224                         wake_up(&hid->wait);
1225                 }
1226                 spin_unlock_irqrestore(&hid->outlock, flags);
1227                 return;
1228         }
1229
1230         clear_bit(HID_OUT_RUNNING, &hid->iofl);
1231         spin_unlock_irqrestore(&hid->outlock, flags);
1232         wake_up(&hid->wait);
1233 }
1234
1235 /*
1236  * Control pipe completion handler.
1237  */
1238
1239 static void hid_ctrl(struct urb *urb, struct pt_regs *regs)
1240 {
1241         struct hid_device *hid = urb->context;
1242         unsigned long flags;
1243         int unplug = 0;
1244
1245         spin_lock_irqsave(&hid->ctrllock, flags);
1246
1247         switch (urb->status) {
1248                 case 0:                 /* success */
1249                         if (hid->ctrl[hid->ctrltail].dir == USB_DIR_IN)
1250                                 hid_input_report(hid->ctrl[hid->ctrltail].report->type, urb, 0, regs);
1251                         break;
1252                 case -ESHUTDOWN:        /* unplug */
1253                         unplug = 1;
1254                 case -EILSEQ:           /* protocol error or unplug */
1255                 case -EPROTO:           /* protocol error or unplug */
1256                 case -ECONNRESET:       /* unlink */
1257                 case -ENOENT:
1258                 case -EPIPE:            /* report not available */
1259                         break;
1260                 default:                /* error */
1261                         warn("ctrl urb status %d received", urb->status);
1262         }
1263
1264         if (unplug)
1265                 hid->ctrltail = hid->ctrlhead;
1266         else
1267                 hid->ctrltail = (hid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
1268
1269         if (hid->ctrlhead != hid->ctrltail) {
1270                 if (hid_submit_ctrl(hid)) {
1271                         clear_bit(HID_CTRL_RUNNING, &hid->iofl);
1272                         wake_up(&hid->wait);
1273                 }
1274                 spin_unlock_irqrestore(&hid->ctrllock, flags);
1275                 return;
1276         }
1277
1278         clear_bit(HID_CTRL_RUNNING, &hid->iofl);
1279         spin_unlock_irqrestore(&hid->ctrllock, flags);
1280         wake_up(&hid->wait);
1281 }
1282
1283 void hid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
1284 {
1285         int head;
1286         unsigned long flags;
1287
1288         if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
1289                 return;
1290
1291         if (hid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
1292
1293                 spin_lock_irqsave(&hid->outlock, flags);
1294
1295                 if ((head = (hid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == hid->outtail) {
1296                         spin_unlock_irqrestore(&hid->outlock, flags);
1297                         warn("output queue full");
1298                         return;
1299                 }
1300
1301                 hid->out[hid->outhead] = report;
1302                 hid->outhead = head;
1303
1304                 if (!test_and_set_bit(HID_OUT_RUNNING, &hid->iofl))
1305                         if (hid_submit_out(hid))
1306                                 clear_bit(HID_OUT_RUNNING, &hid->iofl);
1307
1308                 spin_unlock_irqrestore(&hid->outlock, flags);
1309                 return;
1310         }
1311
1312         spin_lock_irqsave(&hid->ctrllock, flags);
1313
1314         if ((head = (hid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == hid->ctrltail) {
1315                 spin_unlock_irqrestore(&hid->ctrllock, flags);
1316                 warn("control queue full");
1317                 return;
1318         }
1319
1320         hid->ctrl[hid->ctrlhead].report = report;
1321         hid->ctrl[hid->ctrlhead].dir = dir;
1322         hid->ctrlhead = head;
1323
1324         if (!test_and_set_bit(HID_CTRL_RUNNING, &hid->iofl))
1325                 if (hid_submit_ctrl(hid))
1326                         clear_bit(HID_CTRL_RUNNING, &hid->iofl);
1327
1328         spin_unlock_irqrestore(&hid->ctrllock, flags);
1329 }
1330
1331 int hid_wait_io(struct hid_device *hid)
1332 {
1333         if (!wait_event_timeout(hid->wait, (!test_bit(HID_CTRL_RUNNING, &hid->iofl) &&
1334                                         !test_bit(HID_OUT_RUNNING, &hid->iofl)),
1335                                         10*HZ)) {
1336                 dbg("timeout waiting for ctrl or out queue to clear");
1337                 return -1;
1338         }
1339
1340         return 0;
1341 }
1342
1343 static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
1344 {
1345         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1346                 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
1347                 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
1348 }
1349
1350 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
1351                 unsigned char type, void *buf, int size)
1352 {
1353         int result, retries = 4;
1354
1355         memset(buf,0,size);     // Make sure we parse really received data
1356
1357         do {
1358                 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
1359                                 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
1360                                 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
1361                 retries--;
1362         } while (result < size && retries);
1363         return result;
1364 }
1365
1366 int hid_open(struct hid_device *hid)
1367 {
1368         ++hid->open;
1369         if (hid_start_in(hid))
1370                 hid_io_error(hid);
1371         return 0;
1372 }
1373
1374 void hid_close(struct hid_device *hid)
1375 {
1376         if (!--hid->open)
1377                 usb_kill_urb(hid->urbin);
1378 }
1379
1380 #define USB_VENDOR_ID_PANJIT            0x134c
1381
1382 /*
1383  * Initialize all reports
1384  */
1385
1386 void hid_init_reports(struct hid_device *hid)
1387 {
1388         struct hid_report *report;
1389         int err, ret;
1390
1391         list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
1392                 hid_submit_report(hid, report, USB_DIR_IN);
1393
1394         list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
1395                 hid_submit_report(hid, report, USB_DIR_IN);
1396
1397         err = 0;
1398         ret = hid_wait_io(hid);
1399         while (ret) {
1400                 err |= ret;
1401                 if (test_bit(HID_CTRL_RUNNING, &hid->iofl))
1402                         usb_kill_urb(hid->urbctrl);
1403                 if (test_bit(HID_OUT_RUNNING, &hid->iofl))
1404                         usb_kill_urb(hid->urbout);
1405                 ret = hid_wait_io(hid);
1406         }
1407
1408         if (err)
1409                 warn("timeout initializing reports");
1410 }
1411
1412 #define USB_VENDOR_ID_WACOM             0x056a
1413 #define USB_DEVICE_ID_WACOM_PENPARTNER  0x0000
1414 #define USB_DEVICE_ID_WACOM_GRAPHIRE    0x0010
1415 #define USB_DEVICE_ID_WACOM_INTUOS      0x0020
1416 #define USB_DEVICE_ID_WACOM_PL          0x0030
1417 #define USB_DEVICE_ID_WACOM_INTUOS2     0x0040
1418 #define USB_DEVICE_ID_WACOM_VOLITO      0x0060
1419 #define USB_DEVICE_ID_WACOM_PTU         0x0003
1420 #define USB_DEVICE_ID_WACOM_INTUOS3     0x00B0
1421 #define USB_DEVICE_ID_WACOM_CINTIQ      0x003F
1422 #define USB_DEVICE_ID_WACOM_DTF         0x00C0
1423
1424 #define USB_VENDOR_ID_ACECAD            0x0460
1425 #define USB_DEVICE_ID_ACECAD_FLAIR      0x0004
1426 #define USB_DEVICE_ID_ACECAD_302        0x0008
1427
1428 #define USB_VENDOR_ID_KBGEAR            0x084e
1429 #define USB_DEVICE_ID_KBGEAR_JAMSTUDIO  0x1001
1430
1431 #define USB_VENDOR_ID_AIPTEK            0x08ca
1432 #define USB_DEVICE_ID_AIPTEK_01         0x0001
1433 #define USB_DEVICE_ID_AIPTEK_10         0x0010
1434 #define USB_DEVICE_ID_AIPTEK_20         0x0020
1435 #define USB_DEVICE_ID_AIPTEK_21         0x0021
1436 #define USB_DEVICE_ID_AIPTEK_22         0x0022
1437 #define USB_DEVICE_ID_AIPTEK_23         0x0023
1438 #define USB_DEVICE_ID_AIPTEK_24         0x0024
1439
1440 #define USB_VENDOR_ID_GRIFFIN           0x077d
1441 #define USB_DEVICE_ID_POWERMATE         0x0410
1442 #define USB_DEVICE_ID_SOUNDKNOB         0x04AA
1443
1444 #define USB_VENDOR_ID_ATEN              0x0557
1445 #define USB_DEVICE_ID_ATEN_UC100KM      0x2004
1446 #define USB_DEVICE_ID_ATEN_CS124U       0x2202
1447 #define USB_DEVICE_ID_ATEN_2PORTKVM     0x2204
1448 #define USB_DEVICE_ID_ATEN_4PORTKVM     0x2205
1449 #define USB_DEVICE_ID_ATEN_4PORTKVMC    0x2208
1450
1451 #define USB_VENDOR_ID_TOPMAX            0x0663
1452 #define USB_DEVICE_ID_TOPMAX_COBRAPAD   0x0103
1453
1454 #define USB_VENDOR_ID_HAPP              0x078b
1455 #define USB_DEVICE_ID_UGCI_DRIVING      0x0010
1456 #define USB_DEVICE_ID_UGCI_FLYING       0x0020
1457 #define USB_DEVICE_ID_UGCI_FIGHTING     0x0030
1458
1459 #define USB_VENDOR_ID_MGE               0x0463
1460 #define USB_DEVICE_ID_MGE_UPS           0xffff
1461 #define USB_DEVICE_ID_MGE_UPS1          0x0001
1462
1463 #define USB_VENDOR_ID_ONTRAK            0x0a07
1464 #define USB_DEVICE_ID_ONTRAK_ADU100     0x0064
1465
1466 #define USB_VENDOR_ID_ESSENTIAL_REALITY 0x0d7f
1467 #define USB_DEVICE_ID_ESSENTIAL_REALITY_P5 0x0100
1468
1469 #define USB_VENDOR_ID_A4TECH            0x09da
1470 #define USB_DEVICE_ID_A4TECH_WCP32PU    0x0006
1471
1472 #define USB_VENDOR_ID_AASHIMA           0x06d6
1473 #define USB_DEVICE_ID_AASHIMA_GAMEPAD   0x0025
1474 #define USB_DEVICE_ID_AASHIMA_PREDATOR  0x0026
1475
1476 #define USB_VENDOR_ID_CYPRESS           0x04b4
1477 #define USB_DEVICE_ID_CYPRESS_MOUSE     0x0001
1478 #define USB_DEVICE_ID_CYPRESS_HIDCOM    0x5500
1479 #define USB_DEVICE_ID_CYPRESS_ULTRAMOUSE        0x7417
1480
1481 #define USB_VENDOR_ID_BERKSHIRE         0x0c98
1482 #define USB_DEVICE_ID_BERKSHIRE_PCWD    0x1140
1483
1484 #define USB_VENDOR_ID_ALPS              0x0433
1485 #define USB_DEVICE_ID_IBM_GAMEPAD       0x1101
1486
1487 #define USB_VENDOR_ID_SAITEK            0x06a3
1488 #define USB_DEVICE_ID_SAITEK_RUMBLEPAD  0xff17
1489
1490 #define USB_VENDOR_ID_NEC               0x073e
1491 #define USB_DEVICE_ID_NEC_USB_GAME_PAD  0x0301
1492
1493 #define USB_VENDOR_ID_CHIC              0x05fe
1494 #define USB_DEVICE_ID_CHIC_GAMEPAD      0x0014
1495
1496 #define USB_VENDOR_ID_GLAB              0x06c2
1497 #define USB_DEVICE_ID_4_PHIDGETSERVO_30 0x0038
1498 #define USB_DEVICE_ID_1_PHIDGETSERVO_30 0x0039
1499 #define USB_DEVICE_ID_8_8_8_IF_KIT      0x0045
1500 #define USB_DEVICE_ID_0_0_4_IF_KIT      0x0040
1501 #define USB_DEVICE_ID_0_8_8_IF_KIT      0x0053
1502
1503 #define USB_VENDOR_ID_WISEGROUP         0x0925
1504 #define USB_DEVICE_ID_1_PHIDGETSERVO_20 0x8101
1505 #define USB_DEVICE_ID_4_PHIDGETSERVO_20 0x8104
1506 #define USB_DEVICE_ID_DUAL_USB_JOYPAD   0x8866
1507
1508 #define USB_VENDOR_ID_CODEMERCS         0x07c0
1509 #define USB_DEVICE_ID_CODEMERCS_IOW40   0x1500
1510 #define USB_DEVICE_ID_CODEMERCS_IOW24   0x1501
1511 #define USB_DEVICE_ID_CODEMERCS_IOW48   0x1502
1512 #define USB_DEVICE_ID_CODEMERCS_IOW28   0x1503
1513
1514 #define USB_VENDOR_ID_DELORME           0x1163
1515 #define USB_DEVICE_ID_DELORME_EARTHMATE 0x0100
1516 #define USB_DEVICE_ID_DELORME_EM_LT20   0x0200
1517
1518 #define USB_VENDOR_ID_MCC               0x09db
1519 #define USB_DEVICE_ID_MCC_PMD1024LS     0x0076
1520 #define USB_DEVICE_ID_MCC_PMD1208LS     0x007a
1521
1522 #define USB_VENDOR_ID_VERNIER           0x08f7
1523 #define USB_DEVICE_ID_VERNIER_LABPRO    0x0001
1524 #define USB_DEVICE_ID_VERNIER_GOTEMP    0x0002
1525 #define USB_DEVICE_ID_VERNIER_SKIP      0x0003
1526 #define USB_DEVICE_ID_VERNIER_CYCLOPS   0x0004
1527
1528 #define USB_VENDOR_ID_LD                0x0f11
1529 #define USB_DEVICE_ID_LD_CASSY          0x1000
1530 #define USB_DEVICE_ID_LD_POCKETCASSY    0x1010
1531 #define USB_DEVICE_ID_LD_MOBILECASSY    0x1020
1532 #define USB_DEVICE_ID_LD_JWM            0x1080
1533 #define USB_DEVICE_ID_LD_DMMP           0x1081
1534 #define USB_DEVICE_ID_LD_UMIP           0x1090
1535 #define USB_DEVICE_ID_LD_XRAY1          0x1100
1536 #define USB_DEVICE_ID_LD_XRAY2          0x1101
1537 #define USB_DEVICE_ID_LD_VIDEOCOM       0x1200
1538 #define USB_DEVICE_ID_LD_COM3LAB        0x2000
1539 #define USB_DEVICE_ID_LD_TELEPORT       0x2010
1540 #define USB_DEVICE_ID_LD_NETWORKANALYSER 0x2020
1541 #define USB_DEVICE_ID_LD_POWERCONTROL   0x2030
1542 #define USB_DEVICE_ID_LD_MACHINETEST    0x2040
1543
1544 #define USB_VENDOR_ID_APPLE             0x05ac
1545 #define USB_DEVICE_ID_APPLE_MIGHTYMOUSE 0x0304
1546
1547 #define USB_VENDOR_ID_CHERRY            0x046a
1548 #define USB_DEVICE_ID_CHERRY_CYMOTION   0x0023
1549
1550 #define USB_VENDOR_ID_YEALINK           0x6993
1551 #define USB_DEVICE_ID_YEALINK_P1K_P4K_B2K       0xb001
1552 /*
1553  * Alphabetically sorted blacklist by quirk type.
1554  */
1555
1556 static const struct hid_blacklist {
1557         __u16 idVendor;
1558         __u16 idProduct;
1559         unsigned quirks;
1560 } hid_blacklist[] = {
1561
1562         { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_01, HID_QUIRK_IGNORE },
1563         { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_10, HID_QUIRK_IGNORE },
1564         { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_20, HID_QUIRK_IGNORE },
1565         { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_21, HID_QUIRK_IGNORE },
1566         { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_22, HID_QUIRK_IGNORE },
1567         { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_23, HID_QUIRK_IGNORE },
1568         { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_24, HID_QUIRK_IGNORE },
1569         { USB_VENDOR_ID_BERKSHIRE, USB_DEVICE_ID_BERKSHIRE_PCWD, HID_QUIRK_IGNORE },
1570         { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW40, HID_QUIRK_IGNORE },
1571         { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW24, HID_QUIRK_IGNORE },
1572         { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW48, HID_QUIRK_IGNORE },
1573         { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW28, HID_QUIRK_IGNORE },
1574         { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_HIDCOM, HID_QUIRK_IGNORE },
1575         { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_ULTRAMOUSE, HID_QUIRK_IGNORE },
1576         { USB_VENDOR_ID_DELORME, USB_DEVICE_ID_DELORME_EARTHMATE, HID_QUIRK_IGNORE },
1577         { USB_VENDOR_ID_DELORME, USB_DEVICE_ID_DELORME_EM_LT20, HID_QUIRK_IGNORE },
1578         { USB_VENDOR_ID_ESSENTIAL_REALITY, USB_DEVICE_ID_ESSENTIAL_REALITY_P5, HID_QUIRK_IGNORE },
1579         { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_4_PHIDGETSERVO_30, HID_QUIRK_IGNORE },
1580         { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_1_PHIDGETSERVO_30, HID_QUIRK_IGNORE },
1581         { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_8_8_8_IF_KIT, HID_QUIRK_IGNORE },
1582         { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_0_4_IF_KIT, HID_QUIRK_IGNORE },
1583         { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_8_8_IF_KIT, HID_QUIRK_IGNORE },
1584         { USB_VENDOR_ID_GRIFFIN, USB_DEVICE_ID_POWERMATE, HID_QUIRK_IGNORE },
1585         { USB_VENDOR_ID_GRIFFIN, USB_DEVICE_ID_SOUNDKNOB, HID_QUIRK_IGNORE },
1586         { USB_VENDOR_ID_KBGEAR, USB_DEVICE_ID_KBGEAR_JAMSTUDIO, HID_QUIRK_IGNORE },
1587         { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_CASSY, HID_QUIRK_IGNORE },
1588         { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POCKETCASSY, HID_QUIRK_IGNORE },
1589         { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MOBILECASSY, HID_QUIRK_IGNORE },
1590         { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_JWM, HID_QUIRK_IGNORE },
1591         { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_DMMP, HID_QUIRK_IGNORE },
1592         { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_UMIP, HID_QUIRK_IGNORE },
1593         { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_XRAY1, HID_QUIRK_IGNORE },
1594         { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_XRAY2, HID_QUIRK_IGNORE },
1595         { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_VIDEOCOM, HID_QUIRK_IGNORE },
1596         { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_COM3LAB, HID_QUIRK_IGNORE },
1597         { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_TELEPORT, HID_QUIRK_IGNORE },
1598         { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_NETWORKANALYSER, HID_QUIRK_IGNORE },
1599         { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POWERCONTROL, HID_QUIRK_IGNORE },
1600         { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MACHINETEST, HID_QUIRK_IGNORE },
1601         { USB_VENDOR_ID_MCC, USB_DEVICE_ID_MCC_PMD1024LS, HID_QUIRK_IGNORE },
1602         { USB_VENDOR_ID_MCC, USB_DEVICE_ID_MCC_PMD1208LS, HID_QUIRK_IGNORE },
1603         { USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS, HID_QUIRK_IGNORE },
1604         { USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS1, HID_QUIRK_IGNORE },
1605         { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100, HID_QUIRK_IGNORE },
1606         { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 100, HID_QUIRK_IGNORE },
1607         { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 200, HID_QUIRK_IGNORE },
1608         { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 300, HID_QUIRK_IGNORE },
1609         { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 400, HID_QUIRK_IGNORE },
1610         { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 500, HID_QUIRK_IGNORE },
1611         { USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_LABPRO, HID_QUIRK_IGNORE },
1612         { USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_GOTEMP, HID_QUIRK_IGNORE },
1613         { USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_SKIP, HID_QUIRK_IGNORE },
1614         { USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_CYCLOPS, HID_QUIRK_IGNORE },
1615         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PENPARTNER, HID_QUIRK_IGNORE },
1616         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE, HID_QUIRK_IGNORE },
1617         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE + 1, HID_QUIRK_IGNORE },
1618         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE + 2, HID_QUIRK_IGNORE },
1619         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE + 3, HID_QUIRK_IGNORE },
1620         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE + 4, HID_QUIRK_IGNORE },
1621         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS, HID_QUIRK_IGNORE },
1622         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS + 1, HID_QUIRK_IGNORE },
1623         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS + 2, HID_QUIRK_IGNORE },
1624         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS + 3, HID_QUIRK_IGNORE },
1625         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS + 4, HID_QUIRK_IGNORE },
1626         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL, HID_QUIRK_IGNORE },
1627         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 1, HID_QUIRK_IGNORE },
1628         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 2, HID_QUIRK_IGNORE },
1629         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 3, HID_QUIRK_IGNORE },
1630         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 4, HID_QUIRK_IGNORE },
1631         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 5, HID_QUIRK_IGNORE },
1632         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 7, HID_QUIRK_IGNORE },
1633         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 8, HID_QUIRK_IGNORE },
1634         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 9, HID_QUIRK_IGNORE },
1635         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 1, HID_QUIRK_IGNORE },
1636         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 2, HID_QUIRK_IGNORE },
1637         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 3, HID_QUIRK_IGNORE },
1638         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 4, HID_QUIRK_IGNORE },
1639         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 5, HID_QUIRK_IGNORE },
1640         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 7, HID_QUIRK_IGNORE },
1641         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_VOLITO, HID_QUIRK_IGNORE },
1642         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_VOLITO + 1, HID_QUIRK_IGNORE },
1643         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_VOLITO + 2, HID_QUIRK_IGNORE },
1644         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_VOLITO + 3, HID_QUIRK_IGNORE },
1645         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_VOLITO + 4, HID_QUIRK_IGNORE },
1646         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE + 5, HID_QUIRK_IGNORE },
1647         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE + 6, HID_QUIRK_IGNORE },
1648         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PTU, HID_QUIRK_IGNORE },
1649         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS3, HID_QUIRK_IGNORE },
1650         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS3 + 1, HID_QUIRK_IGNORE },
1651         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS3 + 2, HID_QUIRK_IGNORE },
1652         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS3 + 3, HID_QUIRK_IGNORE },
1653         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS3 + 4, HID_QUIRK_IGNORE },
1654         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS3 + 5, HID_QUIRK_IGNORE },
1655         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_CINTIQ, HID_QUIRK_IGNORE },
1656         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_DTF, HID_QUIRK_IGNORE },
1657         { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_DTF + 3, HID_QUIRK_IGNORE },
1658         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_4_PHIDGETSERVO_20, HID_QUIRK_IGNORE },
1659         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_1_PHIDGETSERVO_20, HID_QUIRK_IGNORE },
1660         { USB_VENDOR_ID_YEALINK, USB_DEVICE_ID_YEALINK_P1K_P4K_B2K, HID_QUIRK_IGNORE },
1661
1662         { USB_VENDOR_ID_ACECAD, USB_DEVICE_ID_ACECAD_FLAIR, HID_QUIRK_IGNORE },
1663         { USB_VENDOR_ID_ACECAD, USB_DEVICE_ID_ACECAD_302, HID_QUIRK_IGNORE },
1664
1665         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
1666         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
1667         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
1668         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
1669         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
1670         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
1671
1672         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE, HID_QUIRK_MIGHTYMOUSE | HID_QUIRK_INVERT_HWHEEL },
1673         { USB_VENDOR_ID_A4TECH, USB_DEVICE_ID_A4TECH_WCP32PU, HID_QUIRK_2WHEEL_MOUSE_HACK_7 },
1674         { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_MOUSE, HID_QUIRK_2WHEEL_MOUSE_HACK_5 },
1675
1676         { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_GAMEPAD, HID_QUIRK_BADPAD },
1677         { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_PREDATOR, HID_QUIRK_BADPAD },
1678         { USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
1679         { USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
1680         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1681         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1682         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1683         { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
1684         { USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
1685         { USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },
1686
1687         { USB_VENDOR_ID_CHERRY, USB_DEVICE_ID_CHERRY_CYMOTION, HID_QUIRK_CYMOTION },
1688
1689         { USB_VENDOR_ID_APPLE, 0x020E, HID_QUIRK_POWERBOOK_HAS_FN },
1690         { USB_VENDOR_ID_APPLE, 0x020F, HID_QUIRK_POWERBOOK_HAS_FN },
1691         { USB_VENDOR_ID_APPLE, 0x0214, HID_QUIRK_POWERBOOK_HAS_FN },
1692         { USB_VENDOR_ID_APPLE, 0x0215, HID_QUIRK_POWERBOOK_HAS_FN },
1693         { USB_VENDOR_ID_APPLE, 0x0216, HID_QUIRK_POWERBOOK_HAS_FN },
1694         { USB_VENDOR_ID_APPLE, 0x0217, HID_QUIRK_POWERBOOK_HAS_FN },
1695         { USB_VENDOR_ID_APPLE, 0x0218, HID_QUIRK_POWERBOOK_HAS_FN },
1696         { USB_VENDOR_ID_APPLE, 0x0219, HID_QUIRK_POWERBOOK_HAS_FN },
1697         { USB_VENDOR_ID_APPLE, 0x030A, HID_QUIRK_POWERBOOK_HAS_FN },
1698         { USB_VENDOR_ID_APPLE, 0x030B, HID_QUIRK_POWERBOOK_HAS_FN },
1699
1700         { USB_VENDOR_ID_PANJIT, 0x0001, HID_QUIRK_IGNORE },
1701         { USB_VENDOR_ID_PANJIT, 0x0002, HID_QUIRK_IGNORE },
1702         { USB_VENDOR_ID_PANJIT, 0x0003, HID_QUIRK_IGNORE },
1703         { USB_VENDOR_ID_PANJIT, 0x0004, HID_QUIRK_IGNORE },
1704
1705         { 0, 0 }
1706 };
1707
1708 /*
1709  * Traverse the supplied list of reports and find the longest
1710  */
1711 static void hid_find_max_report(struct hid_device *hid, unsigned int type, int *max)
1712 {
1713         struct hid_report *report;
1714         int size;
1715
1716         list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
1717                 size = ((report->size - 1) >> 3) + 1;
1718                 if (type == HID_INPUT_REPORT && hid->report_enum[type].numbered)
1719                         size++;
1720                 if (*max < size)
1721                         *max = size;
1722         }
1723 }
1724
1725 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
1726 {
1727         if (!(hid->inbuf = usb_buffer_alloc(dev, hid->bufsize, SLAB_ATOMIC, &hid->inbuf_dma)))
1728                 return -1;
1729         if (!(hid->outbuf = usb_buffer_alloc(dev, hid->bufsize, SLAB_ATOMIC, &hid->outbuf_dma)))
1730                 return -1;
1731         if (!(hid->cr = usb_buffer_alloc(dev, sizeof(*(hid->cr)), SLAB_ATOMIC, &hid->cr_dma)))
1732                 return -1;
1733         if (!(hid->ctrlbuf = usb_buffer_alloc(dev, hid->bufsize, SLAB_ATOMIC, &hid->ctrlbuf_dma)))
1734                 return -1;
1735
1736         return 0;
1737 }
1738
1739 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
1740 {
1741         if (hid->inbuf)
1742                 usb_buffer_free(dev, hid->bufsize, hid->inbuf, hid->inbuf_dma);
1743         if (hid->outbuf)
1744                 usb_buffer_free(dev, hid->bufsize, hid->outbuf, hid->outbuf_dma);
1745         if (hid->cr)
1746                 usb_buffer_free(dev, sizeof(*(hid->cr)), hid->cr, hid->cr_dma);
1747         if (hid->ctrlbuf)
1748                 usb_buffer_free(dev, hid->bufsize, hid->ctrlbuf, hid->ctrlbuf_dma);
1749 }
1750
1751 /*
1752  * Cherry Cymotion keyboard have an invalid HID report descriptor,
1753  * that needs fixing before we can parse it.
1754  */
1755
1756 static void hid_fixup_cymotion_descriptor(char *rdesc, int rsize)
1757 {
1758         if (rsize >= 17 && rdesc[11] == 0x3c && rdesc[12] == 0x02) {
1759                 info("Fixing up Cherry Cymotion report descriptor");
1760                 rdesc[11] = rdesc[16] = 0xff;
1761                 rdesc[12] = rdesc[17] = 0x03;
1762         }
1763 }
1764
1765 static struct hid_device *usb_hid_configure(struct usb_interface *intf)
1766 {
1767         struct usb_host_interface *interface = intf->cur_altsetting;
1768         struct usb_device *dev = interface_to_usbdev (intf);
1769         struct hid_descriptor *hdesc;
1770         struct hid_device *hid;
1771         unsigned quirks = 0, rsize = 0;
1772         char *rdesc;
1773         int n, len, insize = 0;
1774
1775         for (n = 0; hid_blacklist[n].idVendor; n++)
1776                 if ((hid_blacklist[n].idVendor == le16_to_cpu(dev->descriptor.idVendor)) &&
1777                         (hid_blacklist[n].idProduct == le16_to_cpu(dev->descriptor.idProduct)))
1778                                 quirks = hid_blacklist[n].quirks;
1779
1780         /* Many keyboards and mice don't like to be polled for reports,
1781          * so we will always set the HID_QUIRK_NOGET flag for them. */
1782         if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
1783                 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
1784                         interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
1785                                 quirks |= HID_QUIRK_NOGET;
1786         }
1787
1788         if (quirks & HID_QUIRK_IGNORE)
1789                 return NULL;
1790
1791         if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
1792             (!interface->desc.bNumEndpoints ||
1793              usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
1794                 dbg("class descriptor not present\n");
1795                 return NULL;
1796         }
1797
1798         for (n = 0; n < hdesc->bNumDescriptors; n++)
1799                 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
1800                         rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
1801
1802         if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
1803                 dbg("weird size of report descriptor (%u)", rsize);
1804                 return NULL;
1805         }
1806
1807         if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
1808                 dbg("couldn't allocate rdesc memory");
1809                 return NULL;
1810         }
1811
1812         hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
1813
1814         if ((n = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber, HID_DT_REPORT, rdesc, rsize)) < 0) {
1815                 dbg("reading report descriptor failed");
1816                 kfree(rdesc);
1817                 return NULL;
1818         }
1819
1820         if ((quirks & HID_QUIRK_CYMOTION))
1821                 hid_fixup_cymotion_descriptor(rdesc, rsize);
1822
1823 #ifdef DEBUG_DATA
1824         printk(KERN_DEBUG __FILE__ ": report descriptor (size %u, read %d) = ", rsize, n);
1825         for (n = 0; n < rsize; n++)
1826                 printk(" %02x", (unsigned char) rdesc[n]);
1827         printk("\n");
1828 #endif
1829
1830         if (!(hid = hid_parse_report(rdesc, n))) {
1831                 dbg("parsing report descriptor failed");
1832                 kfree(rdesc);
1833                 return NULL;
1834         }
1835
1836         kfree(rdesc);
1837         hid->quirks = quirks;
1838
1839         hid->bufsize = HID_MIN_BUFFER_SIZE;
1840         hid_find_max_report(hid, HID_INPUT_REPORT, &hid->bufsize);
1841         hid_find_max_report(hid, HID_OUTPUT_REPORT, &hid->bufsize);
1842         hid_find_max_report(hid, HID_FEATURE_REPORT, &hid->bufsize);
1843
1844         if (hid->bufsize > HID_MAX_BUFFER_SIZE)
1845                 hid->bufsize = HID_MAX_BUFFER_SIZE;
1846
1847         hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
1848
1849         if (insize > HID_MAX_BUFFER_SIZE)
1850                 insize = HID_MAX_BUFFER_SIZE;
1851
1852         if (hid_alloc_buffers(dev, hid)) {
1853                 hid_free_buffers(dev, hid);
1854                 goto fail;
1855         }
1856
1857         for (n = 0; n < interface->desc.bNumEndpoints; n++) {
1858
1859                 struct usb_endpoint_descriptor *endpoint;
1860                 int pipe;
1861                 int interval;
1862
1863                 endpoint = &interface->endpoint[n].desc;
1864                 if ((endpoint->bmAttributes & 3) != 3)          /* Not an interrupt endpoint */
1865                         continue;
1866
1867                 interval = endpoint->bInterval;
1868
1869                 /* Change the polling interval of mice. */
1870                 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
1871                         interval = hid_mousepoll_interval;
1872
1873                 if (endpoint->bEndpointAddress & USB_DIR_IN) {
1874                         if (hid->urbin)
1875                                 continue;
1876                         if (!(hid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
1877                                 goto fail;
1878                         pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
1879                         usb_fill_int_urb(hid->urbin, dev, pipe, hid->inbuf, insize,
1880                                          hid_irq_in, hid, interval);
1881                         hid->urbin->transfer_dma = hid->inbuf_dma;
1882                         hid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1883                 } else {
1884                         if (hid->urbout)
1885                                 continue;
1886                         if (!(hid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
1887                                 goto fail;
1888                         pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
1889                         usb_fill_int_urb(hid->urbout, dev, pipe, hid->outbuf, 0,
1890                                          hid_irq_out, hid, interval);
1891                         hid->urbout->transfer_dma = hid->outbuf_dma;
1892                         hid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1893                 }
1894         }
1895
1896         if (!hid->urbin) {
1897                 err("couldn't find an input interrupt endpoint");
1898                 goto fail;
1899         }
1900
1901         init_waitqueue_head(&hid->wait);
1902
1903         INIT_WORK(&hid->reset_work, hid_reset, hid);
1904         setup_timer(&hid->io_retry, hid_retry_timeout, (unsigned long) hid);
1905
1906         spin_lock_init(&hid->inlock);
1907         spin_lock_init(&hid->outlock);
1908         spin_lock_init(&hid->ctrllock);
1909
1910         hid->version = le16_to_cpu(hdesc->bcdHID);
1911         hid->country = hdesc->bCountryCode;
1912         hid->dev = dev;
1913         hid->intf = intf;
1914         hid->ifnum = interface->desc.bInterfaceNumber;
1915
1916         hid->name[0] = 0;
1917
1918         if (dev->manufacturer)
1919                 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
1920
1921         if (dev->product) {
1922                 if (dev->manufacturer)
1923                         strlcat(hid->name, " ", sizeof(hid->name));
1924                 strlcat(hid->name, dev->product, sizeof(hid->name));
1925         }
1926
1927         if (!strlen(hid->name))
1928                 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
1929                          le16_to_cpu(dev->descriptor.idVendor),
1930                          le16_to_cpu(dev->descriptor.idProduct));
1931
1932         usb_make_path(dev, hid->phys, sizeof(hid->phys));
1933         strlcat(hid->phys, "/input", sizeof(hid->phys));
1934         len = strlen(hid->phys);
1935         if (len < sizeof(hid->phys) - 1)
1936                 snprintf(hid->phys + len, sizeof(hid->phys) - len,
1937                          "%d", intf->altsetting[0].desc.bInterfaceNumber);
1938
1939         if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
1940                 hid->uniq[0] = 0;
1941
1942         hid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
1943         if (!hid->urbctrl)
1944                 goto fail;
1945
1946         usb_fill_control_urb(hid->urbctrl, dev, 0, (void *) hid->cr,
1947                              hid->ctrlbuf, 1, hid_ctrl, hid);
1948         hid->urbctrl->setup_dma = hid->cr_dma;
1949         hid->urbctrl->transfer_dma = hid->ctrlbuf_dma;
1950         hid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP);
1951
1952         return hid;
1953
1954 fail:
1955
1956         if (hid->urbin)
1957                 usb_free_urb(hid->urbin);
1958         if (hid->urbout)
1959                 usb_free_urb(hid->urbout);
1960         if (hid->urbctrl)
1961                 usb_free_urb(hid->urbctrl);
1962         hid_free_buffers(dev, hid);
1963         hid_free_device(hid);
1964
1965         return NULL;
1966 }
1967
1968 static void hid_disconnect(struct usb_interface *intf)
1969 {
1970         struct hid_device *hid = usb_get_intfdata (intf);
1971
1972         if (!hid)
1973                 return;
1974
1975         spin_lock_irq(&hid->inlock);    /* Sync with error handler */
1976         usb_set_intfdata(intf, NULL);
1977         spin_unlock_irq(&hid->inlock);
1978         usb_kill_urb(hid->urbin);
1979         usb_kill_urb(hid->urbout);
1980         usb_kill_urb(hid->urbctrl);
1981
1982         del_timer_sync(&hid->io_retry);
1983         flush_scheduled_work();
1984
1985         if (hid->claimed & HID_CLAIMED_INPUT)
1986                 hidinput_disconnect(hid);
1987         if (hid->claimed & HID_CLAIMED_HIDDEV)
1988                 hiddev_disconnect(hid);
1989
1990         usb_free_urb(hid->urbin);
1991         usb_free_urb(hid->urbctrl);
1992         if (hid->urbout)
1993                 usb_free_urb(hid->urbout);
1994
1995         hid_free_buffers(hid->dev, hid);
1996         hid_free_device(hid);
1997 }
1998
1999 static int hid_probe(struct usb_interface *intf, const struct usb_device_id *id)
2000 {
2001         struct hid_device *hid;
2002         char path[64];
2003         int i;
2004         char *c;
2005
2006         dbg("HID probe called for ifnum %d",
2007                         intf->altsetting->desc.bInterfaceNumber);
2008
2009         if (!(hid = usb_hid_configure(intf)))
2010                 return -ENODEV;
2011
2012         hid_init_reports(hid);
2013         hid_dump_device(hid);
2014
2015         if (!hidinput_connect(hid))
2016                 hid->claimed |= HID_CLAIMED_INPUT;
2017         if (!hiddev_connect(hid))
2018                 hid->claimed |= HID_CLAIMED_HIDDEV;
2019
2020         usb_set_intfdata(intf, hid);
2021
2022         if (!hid->claimed) {
2023                 printk ("HID device not claimed by input or hiddev\n");
2024                 hid_disconnect(intf);
2025                 return -ENODEV;
2026         }
2027
2028         printk(KERN_INFO);
2029
2030         if (hid->claimed & HID_CLAIMED_INPUT)
2031                 printk("input");
2032         if (hid->claimed == (HID_CLAIMED_INPUT | HID_CLAIMED_HIDDEV))
2033                 printk(",");
2034         if (hid->claimed & HID_CLAIMED_HIDDEV)
2035                 printk("hiddev%d", hid->minor);
2036
2037         c = "Device";
2038         for (i = 0; i < hid->maxcollection; i++) {
2039                 if (hid->collection[i].type == HID_COLLECTION_APPLICATION &&
2040                     (hid->collection[i].usage & HID_USAGE_PAGE) == HID_UP_GENDESK &&
2041                     (hid->collection[i].usage & 0xffff) < ARRAY_SIZE(hid_types)) {
2042                         c = hid_types[hid->collection[i].usage & 0xffff];
2043                         break;
2044                 }
2045         }
2046
2047         usb_make_path(interface_to_usbdev(intf), path, 63);
2048
2049         printk(": USB HID v%x.%02x %s [%s] on %s\n",
2050                 hid->version >> 8, hid->version & 0xff, c, hid->name, path);
2051
2052         return 0;
2053 }
2054
2055 static int hid_suspend(struct usb_interface *intf, pm_message_t message)
2056 {
2057         struct hid_device *hid = usb_get_intfdata (intf);
2058
2059         spin_lock_irq(&hid->inlock);    /* Sync with error handler */
2060         set_bit(HID_SUSPENDED, &hid->iofl);
2061         spin_unlock_irq(&hid->inlock);
2062         del_timer(&hid->io_retry);
2063         usb_kill_urb(hid->urbin);
2064         dev_dbg(&intf->dev, "suspend\n");
2065         return 0;
2066 }
2067
2068 static int hid_resume(struct usb_interface *intf)
2069 {
2070         struct hid_device *hid = usb_get_intfdata (intf);
2071         int status;
2072
2073         clear_bit(HID_SUSPENDED, &hid->iofl);
2074         hid->retry_delay = 0;
2075         status = hid_start_in(hid);
2076         dev_dbg(&intf->dev, "resume status %d\n", status);
2077         return status;
2078 }
2079
2080 /* Treat USB reset pretty much the same as suspend/resume */
2081 static void hid_pre_reset(struct usb_interface *intf)
2082 {
2083         /* FIXME: What if the interface is already suspended? */
2084         hid_suspend(intf, PMSG_ON);
2085 }
2086
2087 static void hid_post_reset(struct usb_interface *intf)
2088 {
2089         struct usb_device *dev = interface_to_usbdev (intf);
2090
2091         hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
2092         /* FIXME: Any more reinitialization needed? */
2093
2094         hid_resume(intf);
2095 }
2096
2097 static struct usb_device_id hid_usb_ids [] = {
2098         { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2099                 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
2100         { }                                             /* Terminating entry */
2101 };
2102
2103 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
2104
2105 static struct usb_driver hid_driver = {
2106         .name =         "usbhid",
2107         .probe =        hid_probe,
2108         .disconnect =   hid_disconnect,
2109         .suspend =      hid_suspend,
2110         .resume =       hid_resume,
2111         .pre_reset =    hid_pre_reset,
2112         .post_reset =   hid_post_reset,
2113         .id_table =     hid_usb_ids,
2114 };
2115
2116 static int __init hid_init(void)
2117 {
2118         int retval;
2119         retval = hiddev_init();
2120         if (retval)
2121                 goto hiddev_init_fail;
2122         retval = usb_register(&hid_driver);
2123         if (retval)
2124                 goto usb_register_fail;
2125         info(DRIVER_VERSION ":" DRIVER_DESC);
2126
2127         return 0;
2128 usb_register_fail:
2129         hiddev_exit();
2130 hiddev_init_fail:
2131         return retval;
2132 }
2133
2134 static void __exit hid_exit(void)
2135 {
2136         usb_deregister(&hid_driver);
2137         hiddev_exit();
2138 }
2139
2140 module_init(hid_init);
2141 module_exit(hid_exit);
2142
2143 MODULE_AUTHOR(DRIVER_AUTHOR);
2144 MODULE_DESCRIPTION(DRIVER_DESC);
2145 MODULE_LICENSE(DRIVER_LICENSE);