SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/hid/hid-core.c

   1 /*
   2  *  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  *  Copyright (c) 2006-2007 Jiri Kosina
   8  */
   9
  10 /*
  11  * This program is free software; you can redistribute it and/or modify it
  12  * under the terms of the GNU General Public License as published by the Free
  13  * Software Foundation; either version 2 of the License, or (at your option)
  14  * any later version.
  15  */
  16
  17 #include <linux/module.h>
  18 #include <linux/slab.h>
  19 #include <linux/init.h>
  20 #include <linux/kernel.h>
  21 #include <linux/list.h>
  22 #include <linux/mm.h>
  23 #include <linux/spinlock.h>
  24 #include <asm/unaligned.h>
  25 #include <asm/byteorder.h>
  26 #include <linux/input.h>
  27 #include <linux/wait.h>
  28 #include <linux/vmalloc.h>
  29 #include <linux/sched.h>
  30
  31 #include <linux/hid.h>
  32 #include <linux/hiddev.h>
  33 #include <linux/hid-debug.h>
  34 #include <linux/hidraw.h>
  35
  36 #include "hid-ids.h"
  37
  38 /*
  39  * Version Information
  40  */
  41
  42 #define DRIVER_DESC "HID core driver"
  43 #define DRIVER_LICENSE "GPL"
  44
  45 int hid_debug = 0;
  46 module_param_named(debug, hid_debug, int, 0600);
  47 MODULE_PARM_DESC(debug, "toggle HID debugging messages");
  48 EXPORT_SYMBOL_GPL(hid_debug);
  49
  50 /*
  51  * Register a new report for a device.
  52  */
  53
  54 struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id)
  55 {
  56         struct hid_report_enum *report_enum = device->report_enum + type;
  57         struct hid_report *report;
  58
  59         if (report_enum->report_id_hash[id])
  60                 return report_enum->report_id_hash[id];
  61
  62         if (!(report = kzalloc(sizeof(struct hid_report), GFP_KERNEL)))
  63                 return NULL;
  64
  65         if (id != 0)
  66                 report_enum->numbered = 1;
  67
  68         report->id = id;
  69         report->type = type;
  70         report->size = 0;
  71         report->device = device;
  72         report_enum->report_id_hash[id] = report;
  73
  74         list_add_tail(&report->list, &report_enum->report_list);
  75
  76         return report;
  77 }
  78 EXPORT_SYMBOL_GPL(hid_register_report);
  79
  80 /*
  81  * Register a new field for this report.
  82  */
  83
  84 static struct hid_field *hid_register_field(struct hid_report *report, unsigned usages, unsigned values)
  85 {
  86         struct hid_field *field;
  87
  88         if (report->maxfield == HID_MAX_FIELDS) {
  89                 dbg_hid("too many fields in report\n");
  90                 return NULL;
  91         }
  92
  93         if (!(field = kzalloc(sizeof(struct hid_field) + usages * sizeof(struct hid_usage)
  94                 + values * sizeof(unsigned), GFP_KERNEL))) return NULL;
  95
  96         field->index = report->maxfield++;
  97         report->field[field->index] = field;
  98         field->usage = (struct hid_usage *)(field + 1);
  99         field->value = (s32 *)(field->usage + usages);
 100         field->report = report;
 101
 102         return field;
 103 }
 104
 105 /*
 106  * Open a collection. The type/usage is pushed on the stack.
 107  */
 108
 109 static int open_collection(struct hid_parser *parser, unsigned type)
 110 {
 111         struct hid_collection *collection;
 112         unsigned usage;
 113
 114         usage = parser->local.usage[0];
 115
 116         if (parser->collection_stack_ptr == HID_COLLECTION_STACK_SIZE) {
 117                 dbg_hid("collection stack overflow\n");
 118                 return -1;
 119         }
 120
 121         if (parser->device->maxcollection == parser->device->collection_size) {
 122                 collection = kmalloc(sizeof(struct hid_collection) *
 123                                 parser->device->collection_size * 2, GFP_KERNEL);
 124                 if (collection == NULL) {
 125                         dbg_hid("failed to reallocate collection array\n");
 126                         return -1;
 127                 }
 128                 memcpy(collection, parser->device->collection,
 129                         sizeof(struct hid_collection) *
 130                         parser->device->collection_size);
 131                 memset(collection + parser->device->collection_size, 0,
 132                         sizeof(struct hid_collection) *
 133                         parser->device->collection_size);
 134                 kfree(parser->device->collection);
 135                 parser->device->collection = collection;
 136                 parser->device->collection_size *= 2;
 137         }
 138
 139         parser->collection_stack[parser->collection_stack_ptr++] =
 140                 parser->device->maxcollection;
 141
 142         collection = parser->device->collection +
 143                 parser->device->maxcollection++;
 144         collection->type = type;
 145         collection->usage = usage;
 146         collection->level = parser->collection_stack_ptr - 1;
 147
 148         if (type == HID_COLLECTION_APPLICATION)
 149                 parser->device->maxapplication++;
 150
 151         return 0;
 152 }
 153
 154 /*
 155  * Close a collection.
 156  */
 157
 158 static int close_collection(struct hid_parser *parser)
 159 {
 160         if (!parser->collection_stack_ptr) {
 161                 dbg_hid("collection stack underflow\n");
 162                 return -1;
 163         }
 164         parser->collection_stack_ptr--;
 165         return 0;
 166 }
 167
 168 /*
 169  * Climb up the stack, search for the specified collection type
 170  * and return the usage.
 171  */
 172
 173 static unsigned hid_lookup_collection(struct hid_parser *parser, unsigned type)
 174 {
 175         int n;
 176         for (n = parser->collection_stack_ptr - 1; n >= 0; n--)
 177                 if (parser->device->collection[parser->collection_stack[n]].type == type)
 178                         return parser->device->collection[parser->collection_stack[n]].usage;
 179         return 0; /* we know nothing about this usage type */
 180 }
 181
 182 /*
 183  * Add a usage to the temporary parser table.
 184  */
 185
 186 static int hid_add_usage(struct hid_parser *parser, unsigned usage)
 187 {
 188         if (parser->local.usage_index >= HID_MAX_USAGES) {
 189                 dbg_hid("usage index exceeded\n");
 190                 return -1;
 191         }
 192         parser->local.usage[parser->local.usage_index] = usage;
 193         parser->local.collection_index[parser->local.usage_index] =
 194                 parser->collection_stack_ptr ?
 195                 parser->collection_stack[parser->collection_stack_ptr - 1] : 0;
 196         parser->local.usage_index++;
 197         return 0;
 198 }
 199
 200 /*
 201  * Register a new field for this report.
 202  */
 203
 204 static int hid_add_field(struct hid_parser *parser, unsigned report_type, unsigned flags)
 205 {
 206         struct hid_report *report;
 207         struct hid_field *field;
 208         int usages;
 209         unsigned offset;
 210         int i;
 211
 212         if (!(report = hid_register_report(parser->device, report_type, parser->global.report_id))) {
 213                 dbg_hid("hid_register_report failed\n");
 214                 return -1;
 215         }
 216
 217         if (parser->global.logical_maximum < parser->global.logical_minimum) {
 218                 dbg_hid("logical range invalid %d %d\n", parser->global.logical_minimum, parser->global.logical_maximum);
 219                 return -1;
 220         }
 221
 222         offset = report->size;
 223         report->size += parser->global.report_size * parser->global.report_count;
 224
 225         if (!parser->local.usage_index) /* Ignore padding fields */
 226                 return 0;
 227
 228         usages = max_t(int, parser->local.usage_index, parser->global.report_count);
 229
 230         if ((field = hid_register_field(report, usages, parser->global.report_count)) == NULL)
 231                 return 0;
 232
 233         field->physical = hid_lookup_collection(parser, HID_COLLECTION_PHYSICAL);
 234         field->logical = hid_lookup_collection(parser, HID_COLLECTION_LOGICAL);
 235         field->application = hid_lookup_collection(parser, HID_COLLECTION_APPLICATION);
 236
 237         for (i = 0; i < usages; i++) {
 238                 int j = i;
 239                 /* Duplicate the last usage we parsed if we have excess values */
 240                 if (i >= parser->local.usage_index)
 241                         j = parser->local.usage_index - 1;
 242                 field->usage[i].hid = parser->local.usage[j];
 243                 field->usage[i].collection_index =
 244                         parser->local.collection_index[j];
 245         }
 246
 247         field->maxusage = usages;
 248         field->flags = flags;
 249         field->report_offset = offset;
 250         field->report_type = report_type;
 251         field->report_size = parser->global.report_size;
 252         field->report_count = parser->global.report_count;
 253         field->logical_minimum = parser->global.logical_minimum;
 254         field->logical_maximum = parser->global.logical_maximum;
 255         field->physical_minimum = parser->global.physical_minimum;
 256         field->physical_maximum = parser->global.physical_maximum;
 257         field->unit_exponent = parser->global.unit_exponent;
 258         field->unit = parser->global.unit;
 259
 260         return 0;
 261 }
 262
 263 /*
 264  * Read data value from item.
 265  */
 266
 267 static u32 item_udata(struct hid_item *item)
 268 {
 269         switch (item->size) {
 270         case 1: return item->data.u8;
 271         case 2: return item->data.u16;
 272         case 4: return item->data.u32;
 273         }
 274         return 0;
 275 }
 276
 277 static s32 item_sdata(struct hid_item *item)
 278 {
 279         switch (item->size) {
 280         case 1: return item->data.s8;
 281         case 2: return item->data.s16;
 282         case 4: return item->data.s32;
 283         }
 284         return 0;
 285 }
 286
 287 /*
 288  * Process a global item.
 289  */
 290
 291 static int hid_parser_global(struct hid_parser *parser, struct hid_item *item)
 292 {
 293         switch (item->tag) {
 294         case HID_GLOBAL_ITEM_TAG_PUSH:
 295
 296                 if (parser->global_stack_ptr == HID_GLOBAL_STACK_SIZE) {
 297                         dbg_hid("global enviroment stack overflow\n");
 298                         return -1;
 299                 }
 300
 301                 memcpy(parser->global_stack + parser->global_stack_ptr++,
 302                         &parser->global, sizeof(struct hid_global));
 303                 return 0;
 304
 305         case HID_GLOBAL_ITEM_TAG_POP:
 306
 307                 if (!parser->global_stack_ptr) {
 308                         dbg_hid("global enviroment stack underflow\n");
 309                         return -1;
 310                 }
 311
 312                 memcpy(&parser->global, parser->global_stack +
 313                         --parser->global_stack_ptr, sizeof(struct hid_global));
 314                 return 0;
 315
 316         case HID_GLOBAL_ITEM_TAG_USAGE_PAGE:
 317                 parser->global.usage_page = item_udata(item);
 318                 return 0;
 319
 320         case HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM:
 321                 parser->global.logical_minimum = item_sdata(item);
 322                 return 0;
 323
 324         case HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM:
 325                 if (parser->global.logical_minimum < 0)
 326                         parser->global.logical_maximum = item_sdata(item);
 327                 else
 328                         parser->global.logical_maximum = item_udata(item);
 329                 return 0;
 330
 331         case HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM:
 332                 parser->global.physical_minimum = item_sdata(item);
 333                 return 0;
 334
 335         case HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM:
 336                 if (parser->global.physical_minimum < 0)
 337                         parser->global.physical_maximum = item_sdata(item);
 338                 else
 339                         parser->global.physical_maximum = item_udata(item);
 340                 return 0;
 341
 342         case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT:
 343                 parser->global.unit_exponent = item_sdata(item);
 344                 return 0;
 345
 346         case HID_GLOBAL_ITEM_TAG_UNIT:
 347                 parser->global.unit = item_udata(item);
 348                 return 0;
 349
 350         case HID_GLOBAL_ITEM_TAG_REPORT_SIZE:
 351                 parser->global.report_size = item_udata(item);
 352                 if (parser->global.report_size > 32) {
 353                         dbg_hid("invalid report_size %d\n",
 354                                         parser->global.report_size);
 355                         return -1;
 356                 }
 357                 return 0;
 358
 359         case HID_GLOBAL_ITEM_TAG_REPORT_COUNT:
 360                 parser->global.report_count = item_udata(item);
 361                 if (parser->global.report_count > HID_MAX_USAGES) {
 362                         dbg_hid("invalid report_count %d\n",
 363                                         parser->global.report_count);
 364                         return -1;
 365                 }
 366                 return 0;
 367
 368         case HID_GLOBAL_ITEM_TAG_REPORT_ID:
 369                 parser->global.report_id = item_udata(item);
 370                 if (parser->global.report_id == 0) {
 371                         dbg_hid("report_id 0 is invalid\n");
 372                         return -1;
 373                 }
 374                 return 0;
 375
 376         default:
 377                 dbg_hid("unknown global tag 0x%x\n", item->tag);
 378                 return -1;
 379         }
 380 }
 381
 382 /*
 383  * Process a local item.
 384  */
 385
 386 static int hid_parser_local(struct hid_parser *parser, struct hid_item *item)
 387 {
 388         __u32 data;
 389         unsigned n;
 390
 391         if (item->size == 0) {
 392                 dbg_hid("item data expected for local item\n");
 393                 return -1;
 394         }
 395
 396         data = item_udata(item);
 397
 398         switch (item->tag) {
 399         case HID_LOCAL_ITEM_TAG_DELIMITER:
 400
 401                 if (data) {
 402                         /*
 403                          * We treat items before the first delimiter
 404                          * as global to all usage sets (branch 0).
 405                          * In the moment we process only these global
 406                          * items and the first delimiter set.
 407                          */
 408                         if (parser->local.delimiter_depth != 0) {
 409                                 dbg_hid("nested delimiters\n");
 410                                 return -1;
 411                         }
 412                         parser->local.delimiter_depth++;
 413                         parser->local.delimiter_branch++;
 414                 } else {
 415                         if (parser->local.delimiter_depth < 1) {
 416                                 dbg_hid("bogus close delimiter\n");
 417                                 return -1;
 418                         }
 419                         parser->local.delimiter_depth--;
 420                 }
 421                 return 1;
 422
 423         case HID_LOCAL_ITEM_TAG_USAGE:
 424
 425                 if (parser->local.delimiter_branch > 1) {
 426                         dbg_hid("alternative usage ignored\n");
 427                         return 0;
 428                 }
 429
 430                 if (item->size <= 2)
 431                         data = (parser->global.usage_page << 16) + data;
 432
 433                 return hid_add_usage(parser, data);
 434
 435         case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:
 436
 437                 if (parser->local.delimiter_branch > 1) {
 438                         dbg_hid("alternative usage ignored\n");
 439                         return 0;
 440                 }
 441
 442                 if (item->size <= 2)
 443                         data = (parser->global.usage_page << 16) + data;
 444
 445                 parser->local.usage_minimum = data;
 446                 return 0;
 447
 448         case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:
 449
 450                 if (parser->local.delimiter_branch > 1) {
 451                         dbg_hid("alternative usage ignored\n");
 452                         return 0;
 453                 }
 454
 455                 if (item->size <= 2)
 456                         data = (parser->global.usage_page << 16) + data;
 457
 458                 for (n = parser->local.usage_minimum; n <= data; n++)
 459                         if (hid_add_usage(parser, n)) {
 460                                 dbg_hid("hid_add_usage failed\n");
 461                                 return -1;
 462                         }
 463                 return 0;
 464
 465         default:
 466
 467                 dbg_hid("unknown local item tag 0x%x\n", item->tag);
 468                 return 0;
 469         }
 470         return 0;
 471 }
 472
 473 /*
 474  * Process a main item.
 475  */
 476
 477 static int hid_parser_main(struct hid_parser *parser, struct hid_item *item)
 478 {
 479         __u32 data;
 480         int ret;
 481
 482         data = item_udata(item);
 483
 484         switch (item->tag) {
 485         case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION:
 486                 ret = open_collection(parser, data & 0xff);
 487                 break;
 488         case HID_MAIN_ITEM_TAG_END_COLLECTION:
 489                 ret = close_collection(parser);
 490                 break;
 491         case HID_MAIN_ITEM_TAG_INPUT:
 492                 ret = hid_add_field(parser, HID_INPUT_REPORT, data);
 493                 break;
 494         case HID_MAIN_ITEM_TAG_OUTPUT:
 495                 ret = hid_add_field(parser, HID_OUTPUT_REPORT, data);
 496                 break;
 497         case HID_MAIN_ITEM_TAG_FEATURE:
 498                 ret = hid_add_field(parser, HID_FEATURE_REPORT, data);
 499                 break;
 500         default:
 501                 dbg_hid("unknown main item tag 0x%x\n", item->tag);
 502                 ret = 0;
 503         }
 504
 505         memset(&parser->local, 0, sizeof(parser->local));       /* Reset the local parser environment */
 506
 507         return ret;
 508 }
 509
 510 /*
 511  * Process a reserved item.
 512  */
 513
 514 static int hid_parser_reserved(struct hid_parser *parser, struct hid_item *item)
 515 {
 516         dbg_hid("reserved item type, tag 0x%x\n", item->tag);
 517         return 0;
 518 }
 519
 520 /*
 521  * Free a report and all registered fields. The field->usage and
 522  * field->value table's are allocated behind the field, so we need
 523  * only to free(field) itself.
 524  */
 525
 526 static void hid_free_report(struct hid_report *report)
 527 {
 528         unsigned n;
 529
 530         for (n = 0; n < report->maxfield; n++)
 531                 kfree(report->field[n]);
 532         kfree(report);
 533 }
 534
 535 /*
 536  * Free a device structure, all reports, and all fields.
 537  */
 538
 539 static void hid_device_release(struct device *dev)
 540 {
 541         struct hid_device *device = container_of(dev, struct hid_device, dev);
 542         unsigned i, j;
 543
 544         for (i = 0; i < HID_REPORT_TYPES; i++) {
 545                 struct hid_report_enum *report_enum = device->report_enum + i;
 546
 547                 for (j = 0; j < 256; j++) {
 548                         struct hid_report *report = report_enum->report_id_hash[j];
 549                         if (report)
 550                                 hid_free_report(report);
 551                 }
 552         }
 553
 554         kfree(device->rdesc);
 555         kfree(device->collection);
 556         kfree(device);
 557 }
 558
 559 /*
 560  * Fetch a report description item from the data stream. We support long
 561  * items, though they are not used yet.
 562  */
 563
 564 static u8 *fetch_item(__u8 *start, __u8 *end, struct hid_item *item)
 565 {
 566         u8 b;
 567
 568         if ((end - start) <= 0)
 569                 return NULL;
 570
 571         b = *start++;
 572
 573         item->type = (b >> 2) & 3;
 574         item->tag  = (b >> 4) & 15;
 575
 576         if (item->tag == HID_ITEM_TAG_LONG) {
 577
 578                 item->format = HID_ITEM_FORMAT_LONG;
 579
 580                 if ((end - start) < 2)
 581                         return NULL;
 582
 583                 item->size = *start++;
 584                 item->tag  = *start++;
 585
 586                 if ((end - start) < item->size)
 587                         return NULL;
 588
 589                 item->data.longdata = start;
 590                 start += item->size;
 591                 return start;
 592         }
 593
 594         item->format = HID_ITEM_FORMAT_SHORT;
 595         item->size = b & 3;
 596
 597         switch (item->size) {
 598         case 0:
 599                 return start;
 600
 601         case 1:
 602                 if ((end - start) < 1)
 603                         return NULL;
 604                 item->data.u8 = *start++;
 605                 return start;
 606
 607         case 2:
 608                 if ((end - start) < 2)
 609                         return NULL;
 610                 item->data.u16 = get_unaligned_le16(start);
 611                 start = (__u8 *)((__le16 *)start + 1);
 612                 return start;
 613
 614         case 3:
 615                 item->size++;
 616                 if ((end - start) < 4)
 617                         return NULL;
 618                 item->data.u32 = get_unaligned_le32(start);
 619                 start = (__u8 *)((__le32 *)start + 1);
 620                 return start;
 621         }
 622
 623         return NULL;
 624 }
 625
 626 /**
 627  * hid_parse_report - parse device report
 628  *
 629  * @device: hid device
 630  * @start: report start
 631  * @size: report size
 632  *
 633  * Parse a report description into a hid_device structure. Reports are
 634  * enumerated, fields are attached to these reports.
 635  * 0 returned on success, otherwise nonzero error value.
 636  */
 637 int hid_parse_report(struct hid_device *device, __u8 *start,
 638                 unsigned size)
 639 {
 640         struct hid_parser *parser;
 641         struct hid_item item;
 642         __u8 *end;
 643         int ret;
 644         static int (*dispatch_type[])(struct hid_parser *parser,
 645                                       struct hid_item *item) = {
 646                 hid_parser_main,
 647                 hid_parser_global,
 648                 hid_parser_local,
 649                 hid_parser_reserved
 650         };
 651
 652         if (device->driver->report_fixup)
 653                 device->driver->report_fixup(device, start, size);
 654
 655         device->rdesc = kmalloc(size, GFP_KERNEL);
 656         if (device->rdesc == NULL)
 657                 return -ENOMEM;
 658         memcpy(device->rdesc, start, size);
 659         device->rsize = size;
 660
 661         parser = vmalloc(sizeof(struct hid_parser));
 662         if (!parser) {
 663                 ret = -ENOMEM;
 664                 goto err;
 665         }
 666
 667         memset(parser, 0, sizeof(struct hid_parser));
 668         parser->device = device;
 669
 670         end = start + size;
 671         ret = -EINVAL;
 672         while ((start = fetch_item(start, end, &item)) != NULL) {
 673
 674                 if (item.format != HID_ITEM_FORMAT_SHORT) {
 675                         dbg_hid("unexpected long global item\n");
 676                         goto err;
 677                 }
 678
 679                 if (dispatch_type[item.type](parser, &item)) {
 680                         dbg_hid("item %u %u %u %u parsing failed\n",
 681                                 item.format, (unsigned)item.size, (unsigned)item.type, (unsigned)item.tag);
 682                         goto err;
 683                 }
 684
 685                 if (start == end) {
 686                         if (parser->collection_stack_ptr) {
 687                                 dbg_hid("unbalanced collection at end of report description\n");
 688                                 goto err;
 689                         }
 690                         if (parser->local.delimiter_depth) {
 691                                 dbg_hid("unbalanced delimiter at end of report description\n");
 692                                 goto err;
 693                         }
 694                         vfree(parser);
 695                         return 0;
 696                 }
 697         }
 698
 699         dbg_hid("item fetching failed at offset %d\n", (int)(end - start));
 700 err:
 701         vfree(parser);
 702         return ret;
 703 }
 704 EXPORT_SYMBOL_GPL(hid_parse_report);
 705
 706 /*
 707  * Convert a signed n-bit integer to signed 32-bit integer. Common
 708  * cases are done through the compiler, the screwed things has to be
 709  * done by hand.
 710  */
 711
 712 static s32 snto32(__u32 value, unsigned n)
 713 {
 714         switch (n) {
 715         case 8:  return ((__s8)value);
 716         case 16: return ((__s16)value);
 717         case 32: return ((__s32)value);
 718         }
 719         return value & (1 << (n - 1)) ? value | (-1 << n) : value;
 720 }
 721
 722 /*
 723  * Convert a signed 32-bit integer to a signed n-bit integer.
 724  */
 725
 726 static u32 s32ton(__s32 value, unsigned n)
 727 {
 728         s32 a = value >> (n - 1);
 729         if (a && a != -1)
 730                 return value < 0 ? 1 << (n - 1) : (1 << (n - 1)) - 1;
 731         return value & ((1 << n) - 1);
 732 }
 733
 734 /*
 735  * Extract/implement a data field from/to a little endian report (bit array).
 736  *
 737  * Code sort-of follows HID spec:
 738  *     http://www.usb.org/developers/devclass_docs/HID1_11.pdf
 739  *
 740  * While the USB HID spec allows unlimited length bit fields in "report
 741  * descriptors", most devices never use more than 16 bits.
 742  * One model of UPS is claimed to report "LINEV" as a 32-bit field.
 743  * Search linux-kernel and linux-usb-devel archives for "hid-core extract".
 744  */
 745
 746 static __inline__ __u32 extract(__u8 *report, unsigned offset, unsigned n)
 747 {
 748         u64 x;
 749
 750         if (n > 32)
 751                 printk(KERN_WARNING "HID: extract() called with n (%d) > 32! (%s)\n",
 752                                 n, current->comm);
 753
 754         report += offset >> 3;  /* adjust byte index */
 755         offset &= 7;            /* now only need bit offset into one byte */
 756         x = get_unaligned_le64(report);
 757         x = (x >> offset) & ((1ULL << n) - 1);  /* extract bit field */
 758         return (u32) x;
 759 }
 760
 761 /*
 762  * "implement" : set bits in a little endian bit stream.
 763  * Same concepts as "extract" (see comments above).
 764  * The data mangled in the bit stream remains in little endian
 765  * order the whole time. It make more sense to talk about
 766  * endianness of register values by considering a register
 767  * a "cached" copy of the little endiad bit stream.
 768  */
 769 static __inline__ void implement(__u8 *report, unsigned offset, unsigned n, __u32 value)
 770 {
 771         u64 x;
 772         u64 m = (1ULL << n) - 1;
 773
 774         if (n > 32)
 775                 printk(KERN_WARNING "HID: implement() called with n (%d) > 32! (%s)\n",
 776                                 n, current->comm);
 777
 778         if (value > m)
 779                 printk(KERN_WARNING "HID: implement() called with too large value %d! (%s)\n",
 780                                 value, current->comm);
 781         WARN_ON(value > m);
 782         value &= m;
 783
 784         report += offset >> 3;
 785         offset &= 7;
 786
 787         x = get_unaligned_le64(report);
 788         x &= ~(m << offset);
 789         x |= ((u64)value) << offset;
 790         put_unaligned_le64(x, report);
 791 }
 792
 793 /*
 794  * Search an array for a value.
 795  */
 796
 797 static __inline__ int search(__s32 *array, __s32 value, unsigned n)
 798 {
 799         while (n--) {
 800                 if (*array++ == value)
 801                         return 0;
 802         }
 803         return -1;
 804 }
 805
 806 /**
 807  * hid_match_report - check if driver's raw_event should be called
 808  *
 809  * @hid: hid device
 810  * @report_type: type to match against
 811  *
 812  * compare hid->driver->report_table->report_type to report->type
 813  */
 814 static int hid_match_report(struct hid_device *hid, struct hid_report *report)
 815 {
 816         const struct hid_report_id *id = hid->driver->report_table;
 817
 818         if (!id) /* NULL means all */
 819                 return 1;
 820
 821         for (; id->report_type != HID_TERMINATOR; id++)
 822                 if (id->report_type == HID_ANY_ID ||
 823                                 id->report_type == report->type)
 824                         return 1;
 825         return 0;
 826 }
 827
 828 /**
 829  * hid_match_usage - check if driver's event should be called
 830  *
 831  * @hid: hid device
 832  * @usage: usage to match against
 833  *
 834  * compare hid->driver->usage_table->usage_{type,code} to
 835  * usage->usage_{type,code}
 836  */
 837 static int hid_match_usage(struct hid_device *hid, struct hid_usage *usage)
 838 {
 839         const struct hid_usage_id *id = hid->driver->usage_table;
 840
 841         if (!id) /* NULL means all */
 842                 return 1;
 843
 844         for (; id->usage_type != HID_ANY_ID - 1; id++)
 845                 if ((id->usage_hid == HID_ANY_ID ||
 846                                 id->usage_hid == usage->hid) &&
 847                                 (id->usage_type == HID_ANY_ID ||
 848                                 id->usage_type == usage->type) &&
 849                                 (id->usage_code == HID_ANY_ID ||
 850                                  id->usage_code == usage->code))
 851                         return 1;
 852         return 0;
 853 }
 854
 855 static void hid_process_event(struct hid_device *hid, struct hid_field *field,
 856                 struct hid_usage *usage, __s32 value, int interrupt)
 857 {
 858         struct hid_driver *hdrv = hid->driver;
 859         int ret;
 860
 861         hid_dump_input(hid, usage, value);
 862
 863         if (hdrv && hdrv->event && hid_match_usage(hid, usage)) {
 864                 ret = hdrv->event(hid, field, usage, value);
 865                 if (ret != 0) {
 866                         if (ret < 0)
 867                                 dbg_hid("%s's event failed with %d\n",
 868                                                 hdrv->name, ret);
 869                         return;
 870                 }
 871         }
 872
 873         if (hid->claimed & HID_CLAIMED_INPUT)
 874                 hidinput_hid_event(hid, field, usage, value);
 875         if (hid->claimed & HID_CLAIMED_HIDDEV && interrupt && hid->hiddev_hid_event)
 876                 hid->hiddev_hid_event(hid, field, usage, value);
 877 }
 878
 879 /*
 880  * Analyse a received field, and fetch the data from it. The field
 881  * content is stored for next report processing (we do differential
 882  * reporting to the layer).
 883  */
 884
 885 static void hid_input_field(struct hid_device *hid, struct hid_field *field,
 886                             __u8 *data, int interrupt)
 887 {
 888         unsigned n;
 889         unsigned count = field->report_count;
 890         unsigned offset = field->report_offset;
 891         unsigned size = field->report_size;
 892         __s32 min = field->logical_minimum;
 893         __s32 max = field->logical_maximum;
 894         __s32 *value;
 895
 896         if (!(value = kmalloc(sizeof(__s32) * count, GFP_ATOMIC)))
 897                 return;
 898
 899         for (n = 0; n < count; n++) {
 900
 901                         value[n] = min < 0 ? snto32(extract(data, offset + n * size, size), size) :
 902                                                     extract(data, offset + n * size, size);
 903
 904                         if (!(field->flags & HID_MAIN_ITEM_VARIABLE) /* Ignore report if ErrorRollOver */
 905                             && value[n] >= min && value[n] <= max
 906                             && field->usage[value[n] - min].hid == HID_UP_KEYBOARD + 1)
 907                                 goto exit;
 908         }
 909
 910         for (n = 0; n < count; n++) {
 911
 912                 if (HID_MAIN_ITEM_VARIABLE & field->flags) {
 913                         hid_process_event(hid, field, &field->usage[n], value[n], interrupt);
 914                         continue;
 915                 }
 916
 917                 if (field->value[n] >= min && field->value[n] <= max
 918                         && field->usage[field->value[n] - min].hid
 919                         && search(value, field->value[n], count))
 920                                 hid_process_event(hid, field, &field->usage[field->value[n] - min], 0, interrupt);
 921
 922                 if (value[n] >= min && value[n] <= max
 923                         && field->usage[value[n] - min].hid
 924                         && search(field->value, value[n], count))
 925                                 hid_process_event(hid, field, &field->usage[value[n] - min], 1, interrupt);
 926         }
 927
 928         memcpy(field->value, value, count * sizeof(__s32));
 929 exit:
 930         kfree(value);
 931 }
 932
 933 /*
 934  * Output the field into the report.
 935  */
 936
 937 static void hid_output_field(struct hid_field *field, __u8 *data)
 938 {
 939         unsigned count = field->report_count;
 940         unsigned offset = field->report_offset;
 941         unsigned size = field->report_size;
 942         unsigned bitsused = offset + count * size;
 943         unsigned n;
 944
 945         /* make sure the unused bits in the last byte are zeros */
 946         if (count > 0 && size > 0 && (bitsused % 8) != 0)
 947                 data[(bitsused-1)/8] &= (1 << (bitsused % 8)) - 1;
 948
 949         for (n = 0; n < count; n++) {
 950                 if (field->logical_minimum < 0) /* signed values */
 951                         implement(data, offset + n * size, size, s32ton(field->value[n], size));
 952                 else                            /* unsigned values */
 953                         implement(data, offset + n * size, size, field->value[n]);
 954         }
 955 }
 956
 957 /*
 958  * Create a report.
 959  */
 960
 961 void hid_output_report(struct hid_report *report, __u8 *data)
 962 {
 963         unsigned n;
 964
 965         if (report->id > 0)
 966                 *data++ = report->id;
 967
 968         for (n = 0; n < report->maxfield; n++)
 969                 hid_output_field(report->field[n], data);
 970 }
 971 EXPORT_SYMBOL_GPL(hid_output_report);
 972
 973 /*
 974  * Set a field value. The report this field belongs to has to be
 975  * created and transferred to the device, to set this value in the
 976  * device.
 977  */
 978
 979 int hid_set_field(struct hid_field *field, unsigned offset, __s32 value)
 980 {
 981         unsigned size = field->report_size;
 982
 983         hid_dump_input(field->report->device, field->usage + offset, value);
 984
 985         if (offset >= field->report_count) {
 986                 dbg_hid("offset (%d) exceeds report_count (%d)\n", offset, field->report_count);
 987                 return -1;
 988         }
 989         if (field->logical_minimum < 0) {
 990                 if (value != snto32(s32ton(value, size), size)) {
 991                         dbg_hid("value %d is out of range\n", value);
 992                         return -1;
 993                 }
 994         }
 995         field->value[offset] = value;
 996         return 0;
 997 }
 998 EXPORT_SYMBOL_GPL(hid_set_field);
 999
1000 static struct hid_report *hid_get_report(struct hid_report_enum *report_enum,
1001                 const u8 *data)
1002 {
1003         struct hid_report *report;
1004         unsigned int n = 0;     /* Normally report number is 0 */
1005
1006         /* Device uses numbered reports, data[0] is report number */
1007         if (report_enum->numbered)
1008                 n = *data;
1009
1010         report = report_enum->report_id_hash[n];
1011         if (report == NULL)
1012                 dbg_hid("undefined report_id %u received\n", n);
1013
1014         return report;
1015 }
1016
1017 void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
1018                 int interrupt)
1019 {
1020         struct hid_report_enum *report_enum = hid->report_enum + type;
1021         struct hid_report *report;
1022         unsigned int a;
1023         int rsize, csize = size;
1024         u8 *cdata = data;
1025
1026         report = hid_get_report(report_enum, data);
1027         if (!report)
1028                 return;
1029
1030         if (report_enum->numbered) {
1031                 cdata++;
1032                 csize--;
1033         }
1034
1035         rsize = ((report->size - 1) >> 3) + 1;
1036
1037         if (csize < rsize) {
1038                 dbg_hid("report %d is too short, (%d < %d)\n", report->id,
1039                                 csize, rsize);
1040                 memset(cdata + csize, 0, rsize - csize);
1041         }
1042
1043         if ((hid->claimed & HID_CLAIMED_HIDDEV) && hid->hiddev_report_event)
1044                 hid->hiddev_report_event(hid, report);
1045         if (hid->claimed & HID_CLAIMED_HIDRAW) {
1046                 /* numbered reports need to be passed with the report num */
1047                 if (report_enum->numbered)
1048                         hidraw_report_event(hid, data - 1, size + 1);
1049                 else
1050                         hidraw_report_event(hid, data, size);
1051         }
1052
1053         for (a = 0; a < report->maxfield; a++)
1054                 hid_input_field(hid, report->field[a], cdata, interrupt);
1055
1056         if (hid->claimed & HID_CLAIMED_INPUT)
1057                 hidinput_report_event(hid, report);
1058 }
1059 EXPORT_SYMBOL_GPL(hid_report_raw_event);
1060
1061 /**
1062  * hid_input_report - report data from lower layer (usb, bt...)
1063  *
1064  * @hid: hid device
1065  * @type: HID report type (HID_*_REPORT)
1066  * @data: report contents
1067  * @size: size of data parameter
1068  * @interrupt: distinguish between interrupt and control transfers
1069  *
1070  * This is data entry for lower layers.
1071  */
1072 int hid_input_report(struct hid_device *hid, int type, u8 *data, int size, int interrupt)
1073 {
1074         struct hid_report_enum *report_enum;
1075         struct hid_driver *hdrv;
1076         struct hid_report *report;
1077         char *buf;
1078         unsigned int i;
1079         int ret;
1080
1081         if (!hid || !hid->driver)
1082                 return -ENODEV;
1083         report_enum = hid->report_enum + type;
1084         hdrv = hid->driver;
1085
1086         if (!size) {
1087                 dbg_hid("empty report\n");
1088                 return -1;
1089         }
1090
1091         buf = kmalloc(sizeof(char) * HID_DEBUG_BUFSIZE, GFP_ATOMIC);
1092
1093         if (!buf) {
1094                 report = hid_get_report(report_enum, data);
1095                 goto nomem;
1096         }
1097
1098         snprintf(buf, HID_DEBUG_BUFSIZE - 1,
1099                         "\nreport (size %u) (%snumbered)\n", size, report_enum->numbered ? "" : "un");
1100         hid_debug_event(hid, buf);
1101
1102         report = hid_get_report(report_enum, data);
1103         if (!report) {
1104                 kfree(buf);
1105                 return -1;
1106         }
1107
1108         /* dump the report */
1109         snprintf(buf, HID_DEBUG_BUFSIZE - 1,
1110                         "report %d (size %u) = ", report->id, size);
1111         hid_debug_event(hid, buf);
1112         for (i = 0; i < size; i++) {
1113                 snprintf(buf, HID_DEBUG_BUFSIZE - 1,
1114                                 " %02x", data[i]);
1115                 hid_debug_event(hid, buf);
1116         }
1117         hid_debug_event(hid, "\n");
1118
1119         kfree(buf);
1120
1121 nomem:
1122         if (hdrv && hdrv->raw_event && hid_match_report(hid, report)) {
1123                 ret = hdrv->raw_event(hid, report, data, size);
1124                 if (ret != 0)
1125                         return ret < 0 ? ret : 0;
1126         }
1127
1128         hid_report_raw_event(hid, type, data, size, interrupt);
1129
1130         return 0;
1131 }
1132 EXPORT_SYMBOL_GPL(hid_input_report);
1133
1134 static bool hid_match_one_id(struct hid_device *hdev,
1135                 const struct hid_device_id *id)
1136 {
1137         return id->bus == hdev->bus &&
1138                 (id->vendor == HID_ANY_ID || id->vendor == hdev->vendor) &&
1139                 (id->product == HID_ANY_ID || id->product == hdev->product);
1140 }
1141
1142 static const struct hid_device_id *hid_match_id(struct hid_device *hdev,
1143                 const struct hid_device_id *id)
1144 {
1145         for (; id->bus; id++)
1146                 if (hid_match_one_id(hdev, id))
1147                         return id;
1148
1149         return NULL;
1150 }
1151
1152 static const struct hid_device_id hid_hiddev_list[] = {
1153         { HID_USB_DEVICE(USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS) },
1154         { HID_USB_DEVICE(USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS1) },
1155         { }
1156 };
1157
1158 static bool hid_hiddev(struct hid_device *hdev)
1159 {
1160         return !!hid_match_id(hdev, hid_hiddev_list);
1161 }
1162
1163 int hid_connect(struct hid_device *hdev, unsigned int connect_mask)
1164 {
1165         static const char *types[] = { "Device", "Pointer", "Mouse", "Device",
1166                 "Joystick", "Gamepad", "Keyboard", "Keypad",
1167                 "Multi-Axis Controller"
1168         };
1169         const char *type, *bus;
1170         char buf[64];
1171         unsigned int i;
1172         int len;
1173
1174         if (hdev->bus != BUS_USB)
1175                 connect_mask &= ~HID_CONNECT_HIDDEV;
1176         if (hid_hiddev(hdev))
1177                 connect_mask |= HID_CONNECT_HIDDEV_FORCE;
1178
1179         if ((connect_mask & HID_CONNECT_HIDINPUT) && !hidinput_connect(hdev,
1180                                 connect_mask & HID_CONNECT_HIDINPUT_FORCE))
1181                 hdev->claimed |= HID_CLAIMED_INPUT;
1182         if ((connect_mask & HID_CONNECT_HIDDEV) && hdev->hiddev_connect &&
1183                         !hdev->hiddev_connect(hdev,
1184                                 connect_mask & HID_CONNECT_HIDDEV_FORCE))
1185                 hdev->claimed |= HID_CLAIMED_HIDDEV;
1186         if ((connect_mask & HID_CONNECT_HIDRAW) && !hidraw_connect(hdev))
1187                 hdev->claimed |= HID_CLAIMED_HIDRAW;
1188
1189         if (!hdev->claimed) {
1190                 dev_err(&hdev->dev, "claimed by neither input, hiddev nor "
1191                                 "hidraw\n");
1192                 return -ENODEV;
1193         }
1194
1195         if ((hdev->claimed & HID_CLAIMED_INPUT) &&
1196                         (connect_mask & HID_CONNECT_FF) && hdev->ff_init)
1197                 hdev->ff_init(hdev);
1198
1199         len = 0;
1200         if (hdev->claimed & HID_CLAIMED_INPUT)
1201                 len += sprintf(buf + len, "input");
1202         if (hdev->claimed & HID_CLAIMED_HIDDEV)
1203                 len += sprintf(buf + len, "%shiddev%d", len ? "," : "",
1204                                 hdev->minor);
1205         if (hdev->claimed & HID_CLAIMED_HIDRAW)
1206                 len += sprintf(buf + len, "%shidraw%d", len ? "," : "",
1207                                 ((struct hidraw *)hdev->hidraw)->minor);
1208
1209         type = "Device";
1210         for (i = 0; i < hdev->maxcollection; i++) {
1211                 struct hid_collection *col = &hdev->collection[i];
1212                 if (col->type == HID_COLLECTION_APPLICATION &&
1213                    (col->usage & HID_USAGE_PAGE) == HID_UP_GENDESK &&
1214                    (col->usage & 0xffff) < ARRAY_SIZE(types)) {
1215                         type = types[col->usage & 0xffff];
1216                         break;
1217                 }
1218         }
1219
1220         switch (hdev->bus) {
1221         case BUS_USB:
1222                 bus = "USB";
1223                 break;
1224         case BUS_BLUETOOTH:
1225                 bus = "BLUETOOTH";
1226                 break;
1227         default:
1228                 bus = "<UNKNOWN>";
1229         }
1230
1231         dev_info(&hdev->dev, "%s: %s HID v%x.%02x %s [%s] on %s\n",
1232                         buf, bus, hdev->version >> 8, hdev->version & 0xff,
1233                         type, hdev->name, hdev->phys);
1234
1235         return 0;
1236 }
1237 EXPORT_SYMBOL_GPL(hid_connect);
1238
1239 void hid_disconnect(struct hid_device *hdev)
1240 {
1241         if (hdev->claimed & HID_CLAIMED_INPUT)
1242                 hidinput_disconnect(hdev);
1243         if (hdev->claimed & HID_CLAIMED_HIDDEV)
1244                 hdev->hiddev_disconnect(hdev);
1245         if (hdev->claimed & HID_CLAIMED_HIDRAW)
1246                 hidraw_disconnect(hdev);
1247 }
1248 EXPORT_SYMBOL_GPL(hid_disconnect);
1249
1250 /* a list of devices for which there is a specialized driver on HID bus */
1251 static const struct hid_device_id hid_blacklist[] = {
1252         { HID_USB_DEVICE(USB_VENDOR_ID_A4TECH, USB_DEVICE_ID_A4TECH_WCP32PU) },
1253         { HID_USB_DEVICE(USB_VENDOR_ID_A4TECH, USB_DEVICE_ID_A4TECH_X5_005D) },
1254         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ATV_IRCONTROL) },
1255         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_IRCONTROL4) },
1256         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE) },
1257         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGICMOUSE) },
1258         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ANSI) },
1259         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ISO) },
1260         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ANSI) },
1261         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ISO) },
1262         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_JIS) },
1263         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ANSI) },
1264         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ISO) },
1265         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_JIS) },
1266         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ANSI) },
1267         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ISO) },
1268         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_JIS) },
1269         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ANSI) },
1270         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ISO) },
1271         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_JIS) },
1272         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ANSI) },
1273         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ISO) },
1274         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_JIS) },
1275         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ANSI) },
1276         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ISO) },
1277         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_JIS) },
1278         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI) },
1279         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO) },
1280         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS) },
1281         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ANSI) },
1282         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ISO) },
1283         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_JIS) },
1284         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI) },
1285         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ISO) },
1286         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_JIS) },
1287         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI) },
1288         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ISO) },
1289         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_JIS) },
1290         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI) },
1291         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO) },
1292         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_JIS) },
1293         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_TP_ONLY) },
1294         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY) },
1295         { HID_USB_DEVICE(USB_VENDOR_ID_BELKIN, USB_DEVICE_ID_FLIP_KVM) },
1296         { HID_USB_DEVICE(USB_VENDOR_ID_CHERRY, USB_DEVICE_ID_CHERRY_CYMOTION) },
1297         { HID_USB_DEVICE(USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_TACTICAL_PAD) },
1298         { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_1) },
1299         { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_2) },
1300         { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_3) },
1301         { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_MOUSE) },
1302         { HID_USB_DEVICE(USB_VENDOR_ID_DRAGONRISE, 0x0006) },
1303         { HID_USB_DEVICE(USB_VENDOR_ID_EZKEY, USB_DEVICE_ID_BTC_8193) },
1304         { HID_USB_DEVICE(USB_VENDOR_ID_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PSX_ADAPTOR) },
1305         { HID_USB_DEVICE(USB_VENDOR_ID_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PCS_ADAPTOR) },
1306         { HID_USB_DEVICE(USB_VENDOR_ID_GREENASIA, 0x0003) },
1307         { HID_USB_DEVICE(USB_VENDOR_ID_GREENASIA, 0x0012) },
1308         { HID_USB_DEVICE(USB_VENDOR_ID_GYRATION, USB_DEVICE_ID_GYRATION_REMOTE) },
1309         { HID_USB_DEVICE(USB_VENDOR_ID_GYRATION, USB_DEVICE_ID_GYRATION_REMOTE_2) },
1310         { HID_USB_DEVICE(USB_VENDOR_ID_KENSINGTON, USB_DEVICE_ID_KS_SLIMBLADE) },
1311         { HID_USB_DEVICE(USB_VENDOR_ID_KYE, USB_DEVICE_ID_KYE_ERGO_525V) },
1312         { HID_USB_DEVICE(USB_VENDOR_ID_LABTEC, USB_DEVICE_ID_LABTEC_WIRELESS_KEYBOARD) },
1313         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_MX3000_RECEIVER) },
1314         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_S510_RECEIVER) },
1315         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_S510_RECEIVER_2) },
1316         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RECEIVER) },
1317         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_DINOVO_DESKTOP) },
1318         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_DINOVO_EDGE) },
1319         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_DINOVO_MINI) },
1320         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_ELITE_KBD) },
1321         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_CORDLESS_DESKTOP_LX500) },
1322         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_EXTREME_3D) },
1323         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_WHEEL) },
1324         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RUMBLEPAD) },
1325         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RUMBLEPAD2_2) },
1326         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_WINGMAN_F3D) },
1327         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_WINGMAN_FFG ) },
1328         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_FORCE3D_PRO) },
1329         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_MOMO_WHEEL) },
1330         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_MOMO_WHEEL2) },
1331         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_G25_WHEEL) },
1332         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RUMBLEPAD2) },
1333         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_SPACETRAVELLER) },
1334         { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_SPACENAVIGATOR) },
1335         { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_SIDEWINDER_GV) },
1336         { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_NE4K) },
1337         { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_LK6K) },
1338         { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_PRESENTER_8K_USB) },
1339         { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_WIRELESS_OPTICAL_DESKTOP_3_0) },
1340         { HID_USB_DEVICE(USB_VENDOR_ID_MONTEREY, USB_DEVICE_ID_GENIUS_KB29E) },
1341         { HID_USB_DEVICE(USB_VENDOR_ID_NTRIG, USB_DEVICE_ID_NTRIG_TOUCH_SCREEN) },
1342         { HID_USB_DEVICE(USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE) },
1343         { HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE) },
1344         { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER) },
1345         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER) },
1346         { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_VAIO_VGX_MOUSE) },
1347         { HID_USB_DEVICE(USB_VENDOR_ID_SUNPLUS, USB_DEVICE_ID_SUNPLUS_WDESKTOP) },
1348         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb300) },
1349         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb304) },
1350         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb323) },
1351         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb324) },
1352         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb651) },
1353         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654) },
1354         { HID_USB_DEVICE(USB_VENDOR_ID_TOPSEED, USB_DEVICE_ID_TOPSEED_CYBERLINK) },
1355         { HID_USB_DEVICE(USB_VENDOR_ID_TWINHAN, USB_DEVICE_ID_TWINHAN_IR_REMOTE) },
1356         { HID_USB_DEVICE(USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_SMARTJOY_PLUS) },
1357         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE_BLUETOOTH) },
1358         { HID_USB_DEVICE(USB_VENDOR_ID_ZEROPLUS, 0x0005) },
1359         { HID_USB_DEVICE(USB_VENDOR_ID_ZEROPLUS, 0x0030) },
1360
1361         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_PRESENTER_8K_BT) },
1362         { }
1363 };
1364
1365 struct hid_dynid {
1366         struct list_head list;
1367         struct hid_device_id id;
1368 };
1369
1370 /**
1371  * store_new_id - add a new HID device ID to this driver and re-probe devices
1372  * @driver: target device driver
1373  * @buf: buffer for scanning device ID data
1374  * @count: input size
1375  *
1376  * Adds a new dynamic hid device ID to this driver,
1377  * and causes the driver to probe for all devices again.
1378  */
1379 static ssize_t store_new_id(struct device_driver *drv, const char *buf,
1380                 size_t count)
1381 {
1382         struct hid_driver *hdrv = container_of(drv, struct hid_driver, driver);
1383         struct hid_dynid *dynid;
1384         __u32 bus, vendor, product;
1385         unsigned long driver_data = 0;
1386         int ret;
1387
1388         ret = sscanf(buf, "%x %x %x %lx",
1389                         &bus, &vendor, &product, &driver_data);
1390         if (ret < 3)
1391                 return -EINVAL;
1392
1393         dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
1394         if (!dynid)
1395                 return -ENOMEM;
1396
1397         dynid->id.bus = bus;
1398         dynid->id.vendor = vendor;
1399         dynid->id.product = product;
1400         dynid->id.driver_data = driver_data;
1401
1402         spin_lock(&hdrv->dyn_lock);
1403         list_add_tail(&dynid->list, &hdrv->dyn_list);
1404         spin_unlock(&hdrv->dyn_lock);
1405
1406         ret = 0;
1407         if (get_driver(&hdrv->driver)) {
1408                 ret = driver_attach(&hdrv->driver);
1409                 put_driver(&hdrv->driver);
1410         }
1411
1412         return ret ? : count;
1413 }
1414 static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);
1415
1416 static void hid_free_dynids(struct hid_driver *hdrv)
1417 {
1418         struct hid_dynid *dynid, *n;
1419
1420         spin_lock(&hdrv->dyn_lock);
1421         list_for_each_entry_safe(dynid, n, &hdrv->dyn_list, list) {
1422                 list_del(&dynid->list);
1423                 kfree(dynid);
1424         }
1425         spin_unlock(&hdrv->dyn_lock);
1426 }
1427
1428 static const struct hid_device_id *hid_match_device(struct hid_device *hdev,
1429                 struct hid_driver *hdrv)
1430 {
1431         struct hid_dynid *dynid;
1432
1433         spin_lock(&hdrv->dyn_lock);
1434         list_for_each_entry(dynid, &hdrv->dyn_list, list) {
1435                 if (hid_match_one_id(hdev, &dynid->id)) {
1436                         spin_unlock(&hdrv->dyn_lock);
1437                         return &dynid->id;
1438                 }
1439         }
1440         spin_unlock(&hdrv->dyn_lock);
1441
1442         return hid_match_id(hdev, hdrv->id_table);
1443 }
1444
1445 static int hid_bus_match(struct device *dev, struct device_driver *drv)
1446 {
1447         struct hid_driver *hdrv = container_of(drv, struct hid_driver, driver);
1448         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
1449
1450         if (!hid_match_device(hdev, hdrv))
1451                 return 0;
1452
1453         /* generic wants all non-blacklisted */
1454         if (!strncmp(hdrv->name, "generic-", 8))
1455                 return !hid_match_id(hdev, hid_blacklist);
1456
1457         return 1;
1458 }
1459
1460 static int hid_device_probe(struct device *dev)
1461 {
1462         struct hid_driver *hdrv = container_of(dev->driver,
1463                         struct hid_driver, driver);
1464         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
1465         const struct hid_device_id *id;
1466         int ret = 0;
1467
1468         if (!hdev->driver) {
1469                 id = hid_match_device(hdev, hdrv);
1470                 if (id == NULL)
1471                         return -ENODEV;
1472
1473                 hdev->driver = hdrv;
1474                 if (hdrv->probe) {
1475                         ret = hdrv->probe(hdev, id);
1476                 } else { /* default probe */
1477                         ret = hid_parse(hdev);
1478                         if (!ret)
1479                                 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
1480                 }
1481                 if (ret)
1482                         hdev->driver = NULL;
1483         }
1484         return ret;
1485 }
1486
1487 static int hid_device_remove(struct device *dev)
1488 {
1489         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
1490         struct hid_driver *hdrv = hdev->driver;
1491
1492         if (hdrv) {
1493                 if (hdrv->remove)
1494                         hdrv->remove(hdev);
1495                 else /* default remove */
1496                         hid_hw_stop(hdev);
1497                 hdev->driver = NULL;
1498         }
1499
1500         return 0;
1501 }
1502
1503 static int hid_uevent(struct device *dev, struct kobj_uevent_env *env)
1504 {
1505         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
1506
1507         if (add_uevent_var(env, "HID_ID=%04X:%08X:%08X",
1508                         hdev->bus, hdev->vendor, hdev->product))
1509                 return -ENOMEM;
1510
1511         if (add_uevent_var(env, "HID_NAME=%s", hdev->name))
1512                 return -ENOMEM;
1513
1514         if (add_uevent_var(env, "HID_PHYS=%s", hdev->phys))
1515                 return -ENOMEM;
1516
1517         if (add_uevent_var(env, "HID_UNIQ=%s", hdev->uniq))
1518                 return -ENOMEM;
1519
1520         if (add_uevent_var(env, "MODALIAS=hid:b%04Xv%08Xp%08X",
1521                         hdev->bus, hdev->vendor, hdev->product))
1522                 return -ENOMEM;
1523
1524         return 0;
1525 }
1526
1527 static struct bus_type hid_bus_type = {
1528         .name           = "hid",
1529         .match          = hid_bus_match,
1530         .probe          = hid_device_probe,
1531         .remove         = hid_device_remove,
1532         .uevent         = hid_uevent,
1533 };
1534
1535 /* a list of devices that shouldn't be handled by HID core at all */
1536 static const struct hid_device_id hid_ignore_list[] = {
1537         { HID_USB_DEVICE(USB_VENDOR_ID_ACECAD, USB_DEVICE_ID_ACECAD_FLAIR) },
1538         { HID_USB_DEVICE(USB_VENDOR_ID_ACECAD, USB_DEVICE_ID_ACECAD_302) },
1539         { HID_USB_DEVICE(USB_VENDOR_ID_ADS_TECH, USB_DEVICE_ID_ADS_TECH_RADIO_SI470X) },
1540         { HID_USB_DEVICE(USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_01) },
1541         { HID_USB_DEVICE(USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_10) },
1542         { HID_USB_DEVICE(USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_20) },
1543         { HID_USB_DEVICE(USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_21) },
1544         { HID_USB_DEVICE(USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_22) },
1545         { HID_USB_DEVICE(USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_23) },
1546         { HID_USB_DEVICE(USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_24) },
1547         { HID_USB_DEVICE(USB_VENDOR_ID_AIRCABLE, USB_DEVICE_ID_AIRCABLE1) },
1548         { HID_USB_DEVICE(USB_VENDOR_ID_ALCOR, USB_DEVICE_ID_ALCOR_USBRS232) },
1549         { HID_USB_DEVICE(USB_VENDOR_ID_ASUS, USB_DEVICE_ID_ASUS_LCM)},
1550         { HID_USB_DEVICE(USB_VENDOR_ID_ASUS, USB_DEVICE_ID_ASUS_LCM2)},
1551         { HID_USB_DEVICE(USB_VENDOR_ID_AVERMEDIA, USB_DEVICE_ID_AVER_FM_MR800) },
1552         { HID_USB_DEVICE(USB_VENDOR_ID_BERKSHIRE, USB_DEVICE_ID_BERKSHIRE_PCWD) },
1553         { HID_USB_DEVICE(USB_VENDOR_ID_CIDC, 0x0103) },
1554         { HID_USB_DEVICE(USB_VENDOR_ID_CYGNAL, USB_DEVICE_ID_CYGNAL_RADIO_SI470X) },
1555         { HID_USB_DEVICE(USB_VENDOR_ID_CMEDIA, USB_DEVICE_ID_CM109) },
1556         { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_HIDCOM) },
1557         { HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_ULTRAMOUSE) },
1558         { HID_USB_DEVICE(USB_VENDOR_ID_DEALEXTREAME, USB_DEVICE_ID_DEALEXTREAME_RADIO_SI4701) },
1559         { HID_USB_DEVICE(USB_VENDOR_ID_DELORME, USB_DEVICE_ID_DELORME_EARTHMATE) },
1560         { HID_USB_DEVICE(USB_VENDOR_ID_DELORME, USB_DEVICE_ID_DELORME_EM_LT20) },
1561         { HID_USB_DEVICE(USB_VENDOR_ID_ESSENTIAL_REALITY, USB_DEVICE_ID_ESSENTIAL_REALITY_P5) },
1562         { HID_USB_DEVICE(USB_VENDOR_ID_ETT, USB_DEVICE_ID_TC5UH) },
1563         { HID_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH, 0x0001) },
1564         { HID_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH, 0x0002) },
1565         { HID_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH, 0x0003) },
1566         { HID_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH, 0x0004) },
1567         { HID_USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_4_PHIDGETSERVO_30) },
1568         { HID_USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_1_PHIDGETSERVO_30) },
1569         { HID_USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_0_4_IF_KIT) },
1570         { HID_USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_16_16_IF_KIT) },
1571         { HID_USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_8_8_8_IF_KIT) },
1572         { HID_USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_8_7_IF_KIT) },
1573         { HID_USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_8_8_IF_KIT) },
1574         { HID_USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_PHIDGET_MOTORCONTROL) },
1575         { HID_USB_DEVICE(USB_VENDOR_ID_GOTOP, USB_DEVICE_ID_SUPER_Q2) },
1576         { HID_USB_DEVICE(USB_VENDOR_ID_GOTOP, USB_DEVICE_ID_GOGOPEN) },
1577         { HID_USB_DEVICE(USB_VENDOR_ID_GOTOP, USB_DEVICE_ID_PENPOWER) },
1578         { HID_USB_DEVICE(USB_VENDOR_ID_GRETAGMACBETH, USB_DEVICE_ID_GRETAGMACBETH_HUEY) },
1579         { HID_USB_DEVICE(USB_VENDOR_ID_GRIFFIN, USB_DEVICE_ID_POWERMATE) },
1580         { HID_USB_DEVICE(USB_VENDOR_ID_GRIFFIN, USB_DEVICE_ID_SOUNDKNOB) },
1581         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_90) },
1582         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_100) },
1583         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_101) },
1584         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_103) },
1585         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_104) },
1586         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_105) },
1587         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_106) },
1588         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_107) },
1589         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_108) },
1590         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_200) },
1591         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_201) },
1592         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_202) },
1593         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_203) },
1594         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_204) },
1595         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_205) },
1596         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_206) },
1597         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_207) },
1598         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_300) },
1599         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_301) },
1600         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_302) },
1601         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_303) },
1602         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_304) },
1603         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_305) },
1604         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_306) },
1605         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_307) },
1606         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_308) },
1607         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_309) },
1608         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_400) },
1609         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_401) },
1610         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_402) },
1611         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_403) },
1612         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_404) },
1613         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_405) },
1614         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_500) },
1615         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_501) },
1616         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_502) },
1617         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_503) },
1618         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_504) },
1619         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1000) },
1620         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1001) },
1621         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1002) },
1622         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1003) },
1623         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1004) },
1624         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1005) },
1625         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1006) },
1626         { HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1007) },
1627         { HID_USB_DEVICE(USB_VENDOR_ID_IMATION, USB_DEVICE_ID_DISC_STAKKA) },
1628         { HID_USB_DEVICE(USB_VENDOR_ID_KBGEAR, USB_DEVICE_ID_KBGEAR_JAMSTUDIO) },
1629         { HID_USB_DEVICE(USB_VENDOR_ID_KWORLD, USB_DEVICE_ID_KWORLD_RADIO_FM700) },
1630         { HID_USB_DEVICE(USB_VENDOR_ID_KYE, USB_DEVICE_ID_KYE_GPEN_560) },
1631         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_KYE, 0x0058) },
1632         { HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_CASSY) },
1633         { HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POCKETCASSY) },
1634         { HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MOBILECASSY) },
1635         { HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_JWM) },
1636         { HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_DMMP) },
1637         { HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_UMIP) },
1638         { HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_XRAY1) },
1639         { HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_XRAY2) },
1640         { HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_VIDEOCOM) },
1641         { HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_COM3LAB) },
1642         { HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_TELEPORT) },
1643         { HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_NETWORKANALYSER) },
1644         { HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POWERCONTROL) },
1645         { HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MACHINETEST) },
1646         { HID_USB_DEVICE(USB_VENDOR_ID_MCC, USB_DEVICE_ID_MCC_PMD1024LS) },
1647         { HID_USB_DEVICE(USB_VENDOR_ID_MCC, USB_DEVICE_ID_MCC_PMD1208LS) },
1648         { HID_USB_DEVICE(USB_VENDOR_ID_MICROCHIP, USB_DEVICE_ID_PICKIT1) },
1649         { HID_USB_DEVICE(USB_VENDOR_ID_MICROCHIP, USB_DEVICE_ID_PICKIT2) },
1650         { HID_USB_DEVICE(USB_VENDOR_ID_NATIONAL_SEMICONDUCTOR, USB_DEVICE_ID_N_S_HARMONY) },
1651         { HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100) },
1652         { HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 20) },
1653         { HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 30) },
1654         { HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 100) },
1655         { HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 108) },
1656         { HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 118) },
1657         { HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 200) },
1658         { HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 300) },
1659         { HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 400) },
1660         { HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 500) },
1661         { HID_USB_DEVICE(USB_VENDOR_ID_PANJIT, 0x0001) },
1662         { HID_USB_DEVICE(USB_VENDOR_ID_PANJIT, 0x0002) },
1663         { HID_USB_DEVICE(USB_VENDOR_ID_PANJIT, 0x0003) },
1664         { HID_USB_DEVICE(USB_VENDOR_ID_PANJIT, 0x0004) },
1665         { HID_USB_DEVICE(USB_VENDOR_ID_PHILIPS, USB_DEVICE_ID_PHILIPS_IEEE802154_DONGLE) },
1666         { HID_USB_DEVICE(USB_VENDOR_ID_POWERCOM, USB_DEVICE_ID_POWERCOM_UPS) },
1667         { HID_USB_DEVICE(USB_VENDOR_ID_TENX, USB_DEVICE_ID_TENX_IBUDDY1) },
1668         { HID_USB_DEVICE(USB_VENDOR_ID_TENX, USB_DEVICE_ID_TENX_IBUDDY2) },
1669         { HID_USB_DEVICE(USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_LABPRO) },
1670         { HID_USB_DEVICE(USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_GOTEMP) },
1671         { HID_USB_DEVICE(USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_SKIP) },
1672         { HID_USB_DEVICE(USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_CYCLOPS) },
1673         { HID_USB_DEVICE(USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_LCSPEC) },
1674         { HID_USB_DEVICE(USB_VENDOR_ID_WACOM, HID_ANY_ID) },
1675         { HID_USB_DEVICE(USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_4_PHIDGETSERVO_20) },
1676         { HID_USB_DEVICE(USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_1_PHIDGETSERVO_20) },
1677         { HID_USB_DEVICE(USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_8_8_4_IF_KIT) },
1678         { HID_USB_DEVICE(USB_VENDOR_ID_YEALINK, USB_DEVICE_ID_YEALINK_P1K_P4K_B2K) },
1679         { }
1680 };
1681
1682 /**
1683  * hid_mouse_ignore_list - mouse devices which should not be handled by the hid layer
1684  *
1685  * There are composite devices for which we want to ignore only a certain
1686  * interface. This is a list of devices for which only the mouse interface will
1687  * be ignored. This allows a dedicated driver to take care of the interface.
1688  */
1689 static const struct hid_device_id hid_mouse_ignore_list[] = {
1690         /* appletouch driver */
1691         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ANSI) },
1692         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ISO) },
1693         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ANSI) },
1694         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ISO) },
1695         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_JIS) },
1696         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ANSI) },
1697         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ISO) },
1698         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_JIS) },
1699         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ANSI) },
1700         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ISO) },
1701         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_JIS) },
1702         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ANSI) },
1703         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ISO) },
1704         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_JIS) },
1705         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ANSI) },
1706         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ISO) },
1707         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_JIS) },
1708         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI) },
1709         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ISO) },
1710         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_JIS) },
1711         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI) },
1712         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ISO) },
1713         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_JIS) },
1714         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_TP_ONLY) },
1715         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY) },
1716         { }
1717 };
1718
1719 static bool hid_ignore(struct hid_device *hdev)
1720 {
1721         switch (hdev->vendor) {
1722         case USB_VENDOR_ID_CODEMERCS:
1723                 /* ignore all Code Mercenaries IOWarrior devices */
1724                 if (hdev->product >= USB_DEVICE_ID_CODEMERCS_IOW_FIRST &&
1725                                 hdev->product <= USB_DEVICE_ID_CODEMERCS_IOW_LAST)
1726                         return true;
1727                 break;
1728         case USB_VENDOR_ID_LOGITECH:
1729                 if (hdev->product >= USB_DEVICE_ID_LOGITECH_HARMONY_FIRST &&
1730                                 hdev->product <= USB_DEVICE_ID_LOGITECH_HARMONY_LAST)
1731                         return true;
1732                 break;
1733         case USB_VENDOR_ID_SOUNDGRAPH:
1734                 if (hdev->product >= USB_DEVICE_ID_SOUNDGRAPH_IMON_FIRST &&
1735                     hdev->product <= USB_DEVICE_ID_SOUNDGRAPH_IMON_LAST)
1736                         return true;
1737                 break;
1738         }
1739
1740         if (hdev->type == HID_TYPE_USBMOUSE &&
1741                         hid_match_id(hdev, hid_mouse_ignore_list))
1742                 return true;
1743
1744         return !!hid_match_id(hdev, hid_ignore_list);
1745 }
1746
1747 int hid_add_device(struct hid_device *hdev)
1748 {
1749         static atomic_t id = ATOMIC_INIT(0);
1750         int ret;
1751
1752         if (WARN_ON(hdev->status & HID_STAT_ADDED))
1753                 return -EBUSY;
1754
1755         /* we need to kill them here, otherwise they will stay allocated to
1756          * wait for coming driver */
1757         if (hid_ignore(hdev))
1758                 return -ENODEV;
1759
1760         /* XXX hack, any other cleaner solution after the driver core
1761          * is converted to allow more than 20 bytes as the device name? */
1762         dev_set_name(&hdev->dev, "%04X:%04X:%04X.%04X", hdev->bus,
1763                      hdev->vendor, hdev->product, atomic_inc_return(&id));
1764
1765         ret = device_add(&hdev->dev);
1766         if (!ret)
1767                 hdev->status |= HID_STAT_ADDED;
1768
1769         hid_debug_register(hdev, dev_name(&hdev->dev));
1770
1771         return ret;
1772 }
1773 EXPORT_SYMBOL_GPL(hid_add_device);
1774
1775 /**
1776  * hid_allocate_device - allocate new hid device descriptor
1777  *
1778  * Allocate and initialize hid device, so that hid_destroy_device might be
1779  * used to free it.
1780  *
1781  * New hid_device pointer is returned on success, otherwise ERR_PTR encoded
1782  * error value.
1783  */
1784 struct hid_device *hid_allocate_device(void)
1785 {
1786         struct hid_device *hdev;
1787         unsigned int i;
1788         int ret = -ENOMEM;
1789
1790         hdev = kzalloc(sizeof(*hdev), GFP_KERNEL);
1791         if (hdev == NULL)
1792                 return ERR_PTR(ret);
1793
1794         device_initialize(&hdev->dev);
1795         hdev->dev.release = hid_device_release;
1796         hdev->dev.bus = &hid_bus_type;
1797
1798         hdev->collection = kcalloc(HID_DEFAULT_NUM_COLLECTIONS,
1799                         sizeof(struct hid_collection), GFP_KERNEL);
1800         if (hdev->collection == NULL)
1801                 goto err;
1802         hdev->collection_size = HID_DEFAULT_NUM_COLLECTIONS;
1803
1804         for (i = 0; i < HID_REPORT_TYPES; i++)
1805                 INIT_LIST_HEAD(&hdev->report_enum[i].report_list);
1806
1807         init_waitqueue_head(&hdev->debug_wait);
1808         INIT_LIST_HEAD(&hdev->debug_list);
1809
1810         return hdev;
1811 err:
1812         put_device(&hdev->dev);
1813         return ERR_PTR(ret);
1814 }
1815 EXPORT_SYMBOL_GPL(hid_allocate_device);
1816
1817 static void hid_remove_device(struct hid_device *hdev)
1818 {
1819         if (hdev->status & HID_STAT_ADDED) {
1820                 device_del(&hdev->dev);
1821                 hid_debug_unregister(hdev);
1822                 hdev->status &= ~HID_STAT_ADDED;
1823         }
1824 }
1825
1826 /**
1827  * hid_destroy_device - free previously allocated device
1828  *
1829  * @hdev: hid device
1830  *
1831  * If you allocate hid_device through hid_allocate_device, you should ever
1832  * free by this function.
1833  */
1834 void hid_destroy_device(struct hid_device *hdev)
1835 {
1836         hid_remove_device(hdev);
1837         put_device(&hdev->dev);
1838 }
1839 EXPORT_SYMBOL_GPL(hid_destroy_device);
1840
1841 int __hid_register_driver(struct hid_driver *hdrv, struct module *owner,
1842                 const char *mod_name)
1843 {
1844         int ret;
1845
1846         hdrv->driver.name = hdrv->name;
1847         hdrv->driver.bus = &hid_bus_type;
1848         hdrv->driver.owner = owner;
1849         hdrv->driver.mod_name = mod_name;
1850
1851         INIT_LIST_HEAD(&hdrv->dyn_list);
1852         spin_lock_init(&hdrv->dyn_lock);
1853
1854         ret = driver_register(&hdrv->driver);
1855         if (ret)
1856                 return ret;
1857
1858         ret = driver_create_file(&hdrv->driver, &driver_attr_new_id);
1859         if (ret)
1860                 driver_unregister(&hdrv->driver);
1861
1862         return ret;
1863 }
1864 EXPORT_SYMBOL_GPL(__hid_register_driver);
1865
1866 void hid_unregister_driver(struct hid_driver *hdrv)
1867 {
1868         driver_remove_file(&hdrv->driver, &driver_attr_new_id);
1869         driver_unregister(&hdrv->driver);
1870         hid_free_dynids(hdrv);
1871 }
1872 EXPORT_SYMBOL_GPL(hid_unregister_driver);
1873
1874 int hid_check_keys_pressed(struct hid_device *hid)
1875 {
1876         struct hid_input *hidinput;
1877         int i;
1878
1879         if (!(hid->claimed & HID_CLAIMED_INPUT))
1880                 return 0;
1881
1882         list_for_each_entry(hidinput, &hid->inputs, list) {
1883                 for (i = 0; i < BITS_TO_LONGS(KEY_MAX); i++)
1884                         if (hidinput->input->key[i])
1885                                 return 1;
1886         }
1887
1888         return 0;
1889 }
1890
1891 EXPORT_SYMBOL_GPL(hid_check_keys_pressed);
1892
1893 static int __init hid_init(void)
1894 {
1895         int ret;
1896
1897         if (hid_debug)
1898                 printk(KERN_WARNING "HID: hid_debug is now used solely for parser and driver debugging.\n"
1899                                 "HID: debugfs is now used for inspecting the device (report descriptor, reports)\n");
1900
1901         ret = bus_register(&hid_bus_type);
1902         if (ret) {
1903                 printk(KERN_ERR "HID: can't register hid bus\n");
1904                 goto err;
1905         }
1906
1907         ret = hidraw_init();
1908         if (ret)
1909                 goto err_bus;
1910
1911         hid_debug_init();
1912
1913         return 0;
1914 err_bus:
1915         bus_unregister(&hid_bus_type);
1916 err:
1917         return ret;
1918 }
1919
1920 static void __exit hid_exit(void)
1921 {
1922         hid_debug_exit();
1923         hidraw_exit();
1924         bus_unregister(&hid_bus_type);
1925 }
1926
1927 module_init(hid_init);
1928 module_exit(hid_exit);
1929
1930 MODULE_AUTHOR("Andreas Gal");
1931 MODULE_AUTHOR("Vojtech Pavlik");
1932 MODULE_AUTHOR("Jiri Kosina");
1933 MODULE_LICENSE(DRIVER_LICENSE);
1934