hid-core: big-endian fix fix
[linux-2.6.22.y-op.git] / drivers / usb / input / hid-core.c
blob6d42036c906ceb1a45cacb0692607edd4e105e49
1 /*
2 * USB HID support for Linux
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 */
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.
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>
30 #undef DEBUG
31 #undef DEBUG_DATA
33 #include <linux/usb.h>
35 #include "hid.h"
36 #include <linux/hiddev.h>
39 * Version Information
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"
47 static char *hid_types[] = {"Device", "Pointer", "Mouse", "Device", "Joystick",
48 "Gamepad", "Keyboard", "Keypad", "Multi-Axis Controller"};
50 * Module parameters.
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");
58 * Register a new report for a device.
61 static struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id)
63 struct hid_report_enum *report_enum = device->report_enum + type;
64 struct hid_report *report;
66 if (report_enum->report_id_hash[id])
67 return report_enum->report_id_hash[id];
69 if (!(report = kzalloc(sizeof(struct hid_report), GFP_KERNEL)))
70 return NULL;
72 if (id != 0)
73 report_enum->numbered = 1;
75 report->id = id;
76 report->type = type;
77 report->size = 0;
78 report->device = device;
79 report_enum->report_id_hash[id] = report;
81 list_add_tail(&report->list, &report_enum->report_list);
83 return report;
87 * Register a new field for this report.
90 static struct hid_field *hid_register_field(struct hid_report *report, unsigned usages, unsigned values)
92 struct hid_field *field;
94 if (report->maxfield == HID_MAX_FIELDS) {
95 dbg("too many fields in report");
96 return NULL;
99 if (!(field = kzalloc(sizeof(struct hid_field) + usages * sizeof(struct hid_usage)
100 + values * sizeof(unsigned), GFP_KERNEL))) return NULL;
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;
108 return field;
112 * Open a collection. The type/usage is pushed on the stack.
115 static int open_collection(struct hid_parser *parser, unsigned type)
117 struct hid_collection *collection;
118 unsigned usage;
120 usage = parser->local.usage[0];
122 if (parser->collection_stack_ptr == HID_COLLECTION_STACK_SIZE) {
123 dbg("collection stack overflow");
124 return -1;
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;
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;
145 parser->collection_stack[parser->collection_stack_ptr++] =
146 parser->device->maxcollection;
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;
154 if (type == HID_COLLECTION_APPLICATION)
155 parser->device->maxapplication++;
157 return 0;
161 * Close a collection.
164 static int close_collection(struct hid_parser *parser)
166 if (!parser->collection_stack_ptr) {
167 dbg("collection stack underflow");
168 return -1;
170 parser->collection_stack_ptr--;
171 return 0;
175 * Climb up the stack, search for the specified collection type
176 * and return the usage.
179 static unsigned hid_lookup_collection(struct hid_parser *parser, unsigned type)
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 */
189 * Add a usage to the temporary parser table.
192 static int hid_add_usage(struct hid_parser *parser, unsigned usage)
194 if (parser->local.usage_index >= HID_MAX_USAGES) {
195 dbg("usage index exceeded");
196 return -1;
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;
207 * Register a new field for this report.
210 static int hid_add_field(struct hid_parser *parser, unsigned report_type, unsigned flags)
212 struct hid_report *report;
213 struct hid_field *field;
214 int usages;
215 unsigned offset;
216 int i;
218 if (!(report = hid_register_report(parser->device, report_type, parser->global.report_id))) {
219 dbg("hid_register_report failed");
220 return -1;
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;
228 offset = report->size;
229 report->size += parser->global.report_size * parser->global.report_count;
231 if (!parser->local.usage_index) /* Ignore padding fields */
232 return 0;
234 usages = max_t(int, parser->local.usage_index, parser->global.report_count);
236 if ((field = hid_register_field(report, usages, parser->global.report_count)) == NULL)
237 return 0;
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);
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];
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;
266 return 0;
270 * Read data value from item.
273 static u32 item_udata(struct hid_item *item)
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;
280 return 0;
283 static s32 item_sdata(struct hid_item *item)
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;
290 return 0;
294 * Process a global item.
297 static int hid_parser_global(struct hid_parser *parser, struct hid_item *item)
299 switch (item->tag) {
301 case HID_GLOBAL_ITEM_TAG_PUSH:
303 if (parser->global_stack_ptr == HID_GLOBAL_STACK_SIZE) {
304 dbg("global enviroment stack overflow");
305 return -1;
308 memcpy(parser->global_stack + parser->global_stack_ptr++,
309 &parser->global, sizeof(struct hid_global));
310 return 0;
312 case HID_GLOBAL_ITEM_TAG_POP:
314 if (!parser->global_stack_ptr) {
315 dbg("global enviroment stack underflow");
316 return -1;
319 memcpy(&parser->global, parser->global_stack + --parser->global_stack_ptr,
320 sizeof(struct hid_global));
321 return 0;
323 case HID_GLOBAL_ITEM_TAG_USAGE_PAGE:
324 parser->global.usage_page = item_udata(item);
325 return 0;
327 case HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM:
328 parser->global.logical_minimum = item_sdata(item);
329 return 0;
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;
338 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM:
339 parser->global.physical_minimum = item_sdata(item);
340 return 0;
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;
349 case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT:
350 parser->global.unit_exponent = item_sdata(item);
351 return 0;
353 case HID_GLOBAL_ITEM_TAG_UNIT:
354 parser->global.unit = item_udata(item);
355 return 0;
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;
362 return 0;
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;
369 return 0;
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;
376 return 0;
378 default:
379 dbg("unknown global tag 0x%x", item->tag);
380 return -1;
385 * Process a local item.
388 static int hid_parser_local(struct hid_parser *parser, struct hid_item *item)
390 __u32 data;
391 unsigned n;
393 if (item->size == 0) {
394 dbg("item data expected for local item");
395 return -1;
398 data = item_udata(item);
400 switch (item->tag) {
402 case HID_LOCAL_ITEM_TAG_DELIMITER:
404 if (data) {
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.
411 if (parser->local.delimiter_depth != 0) {
412 dbg("nested delimiters");
413 return -1;
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;
422 parser->local.delimiter_depth--;
424 return 1;
426 case HID_LOCAL_ITEM_TAG_USAGE:
428 if (parser->local.delimiter_branch > 1) {
429 dbg("alternative usage ignored");
430 return 0;
433 if (item->size <= 2)
434 data = (parser->global.usage_page << 16) + data;
436 return hid_add_usage(parser, data);
438 case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:
440 if (parser->local.delimiter_branch > 1) {
441 dbg("alternative usage ignored");
442 return 0;
445 if (item->size <= 2)
446 data = (parser->global.usage_page << 16) + data;
448 parser->local.usage_minimum = data;
449 return 0;
451 case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:
453 if (parser->local.delimiter_branch > 1) {
454 dbg("alternative usage ignored");
455 return 0;
458 if (item->size <= 2)
459 data = (parser->global.usage_page << 16) + data;
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;
466 return 0;
468 default:
470 dbg("unknown local item tag 0x%x", item->tag);
471 return 0;
473 return 0;
477 * Process a main item.
480 static int hid_parser_main(struct hid_parser *parser, struct hid_item *item)
482 __u32 data;
483 int ret;
485 data = item_udata(item);
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;
508 memset(&parser->local, 0, sizeof(parser->local)); /* Reset the local parser environment */
510 return ret;
514 * Process a reserved item.
517 static int hid_parser_reserved(struct hid_parser *parser, struct hid_item *item)
519 dbg("reserved item type, tag 0x%x", item->tag);
520 return 0;
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.
529 static void hid_free_report(struct hid_report *report)
531 unsigned n;
533 for (n = 0; n < report->maxfield; n++)
534 kfree(report->field[n]);
535 kfree(report);
539 * Free a device structure, all reports, and all fields.
542 static void hid_free_device(struct hid_device *device)
544 unsigned i,j;
546 for (i = 0; i < HID_REPORT_TYPES; i++) {
547 struct hid_report_enum *report_enum = device->report_enum + i;
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);
556 kfree(device->rdesc);
557 kfree(device);
561 * Fetch a report description item from the data stream. We support long
562 * items, though they are not used yet.
565 static u8 *fetch_item(__u8 *start, __u8 *end, struct hid_item *item)
567 u8 b;
569 if ((end - start) <= 0)
570 return NULL;
572 b = *start++;
574 item->type = (b >> 2) & 3;
575 item->tag = (b >> 4) & 15;
577 if (item->tag == HID_ITEM_TAG_LONG) {
579 item->format = HID_ITEM_FORMAT_LONG;
581 if ((end - start) < 2)
582 return NULL;
584 item->size = *start++;
585 item->tag = *start++;
587 if ((end - start) < item->size)
588 return NULL;
590 item->data.longdata = start;
591 start += item->size;
592 return start;
595 item->format = HID_ITEM_FORMAT_SHORT;
596 item->size = b & 3;
598 switch (item->size) {
600 case 0:
601 return start;
603 case 1:
604 if ((end - start) < 1)
605 return NULL;
606 item->data.u8 = *start++;
607 return start;
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;
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;
625 return NULL;
629 * Parse a report description into a hid_device structure. Reports are
630 * enumerated, fields are attached to these reports.
633 static struct hid_device *hid_parse_report(__u8 *start, unsigned size)
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
648 if (!(device = kzalloc(sizeof(struct hid_device), GFP_KERNEL)))
649 return NULL;
651 if (!(device->collection = kzalloc(sizeof(struct hid_collection) *
652 HID_DEFAULT_NUM_COLLECTIONS, GFP_KERNEL))) {
653 kfree(device);
654 return NULL;
656 device->collection_size = HID_DEFAULT_NUM_COLLECTIONS;
658 for (i = 0; i < HID_REPORT_TYPES; i++)
659 INIT_LIST_HEAD(&device->report_enum[i].report_list);
661 if (!(device->rdesc = (__u8 *)kmalloc(size, GFP_KERNEL))) {
662 kfree(device->collection);
663 kfree(device);
664 return NULL;
666 memcpy(device->rdesc, start, size);
667 device->rsize = size;
669 if (!(parser = kzalloc(sizeof(struct hid_parser), GFP_KERNEL))) {
670 kfree(device->rdesc);
671 kfree(device->collection);
672 kfree(device);
673 return NULL;
675 parser->device = device;
677 end = start + size;
678 while ((start = fetch_item(start, end, &item)) != NULL) {
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;
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;
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;
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;
712 kfree(parser);
713 return device;
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;
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.
730 static s32 snto32(__u32 value, unsigned n)
732 switch (n) {
733 case 8: return ((__s8)value);
734 case 16: return ((__s16)value);
735 case 32: return ((__s32)value);
737 return value & (1 << (n - 1)) ? value | (-1 << n) : value;
741 * Convert a signed 32-bit integer to a signed n-bit integer.
744 static u32 s32ton(__s32 value, unsigned n)
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);
753 * Extract/implement a data field from/to a little endian report (bit array).
755 * Code sort-of follows HID spec:
756 * http://www.usb.org/developers/devclass_docs/HID1_11.pdf
758 * While the USB HID spec allows unlimited length bit fields in "report
759 * descriptors", most devices never use more than 16 bits.
760 * One model of UPS is claimed to report "LINEV" as a 32-bit field.
761 * Search linux-kernel and linux-usb-devel archives for "hid-core extract".
764 static __inline__ __u32 extract(__u8 *report, unsigned offset, unsigned n)
766 u64 x;
768 WARN_ON(n > 32);
770 report += offset >> 3; /* adjust byte index */
771 offset &= 7; /* now only need bit offset into one byte */
772 x = get_unaligned((u64 *) report);
773 x = le64_to_cpu(x);
774 x = (x >> offset) & ((1ULL << n) - 1); /* extract bit field */
775 return (u32) x;
779 * "implement" : set bits in a little endian bit stream.
780 * Same concepts as "extract" (see comments above).
781 * The data mangled in the bit stream remains in little endian
782 * order the whole time. It make more sense to talk about
783 * endianness of register values by considering a register
784 * a "cached" copy of the little endiad bit stream.
786 static __inline__ void implement(__u8 *report, unsigned offset, unsigned n, __u32 value)
788 u64 x;
789 u64 m = (1ULL << n) - 1;
791 WARN_ON(n > 32);
793 WARN_ON(value > m);
794 value &= m;
796 report += offset >> 3;
797 offset &= 7;
799 x = get_unaligned((u64 *)report);
800 x &= cpu_to_le64(~(m << offset));
801 x |= cpu_to_le64(((u64) value) << offset);
802 put_unaligned(x, (u64 *) report);
806 * Search an array for a value.
809 static __inline__ int search(__s32 *array, __s32 value, unsigned n)
811 while (n--) {
812 if (*array++ == value)
813 return 0;
815 return -1;
818 static void hid_process_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value, int interrupt)
820 hid_dump_input(usage, value);
821 if (hid->claimed & HID_CLAIMED_INPUT)
822 hidinput_hid_event(hid, field, usage, value);
823 if (hid->claimed & HID_CLAIMED_HIDDEV && interrupt)
824 hiddev_hid_event(hid, field, usage, value);
828 * Analyse a received field, and fetch the data from it. The field
829 * content is stored for next report processing (we do differential
830 * reporting to the layer).
833 static void hid_input_field(struct hid_device *hid, struct hid_field *field, __u8 *data, int interrupt)
835 unsigned n;
836 unsigned count = field->report_count;
837 unsigned offset = field->report_offset;
838 unsigned size = field->report_size;
839 __s32 min = field->logical_minimum;
840 __s32 max = field->logical_maximum;
841 __s32 *value;
843 if (!(value = kmalloc(sizeof(__s32) * count, GFP_ATOMIC)))
844 return;
846 for (n = 0; n < count; n++) {
848 value[n] = min < 0 ? snto32(extract(data, offset + n * size, size), size) :
849 extract(data, offset + n * size, size);
851 if (!(field->flags & HID_MAIN_ITEM_VARIABLE) /* Ignore report if ErrorRollOver */
852 && value[n] >= min && value[n] <= max
853 && field->usage[value[n] - min].hid == HID_UP_KEYBOARD + 1)
854 goto exit;
857 for (n = 0; n < count; n++) {
859 if (HID_MAIN_ITEM_VARIABLE & field->flags) {
860 hid_process_event(hid, field, &field->usage[n], value[n], interrupt);
861 continue;
864 if (field->value[n] >= min && field->value[n] <= max
865 && field->usage[field->value[n] - min].hid
866 && search(value, field->value[n], count))
867 hid_process_event(hid, field, &field->usage[field->value[n] - min], 0, interrupt);
869 if (value[n] >= min && value[n] <= max
870 && field->usage[value[n] - min].hid
871 && search(field->value, value[n], count))
872 hid_process_event(hid, field, &field->usage[value[n] - min], 1, interrupt);
875 memcpy(field->value, value, count * sizeof(__s32));
876 exit:
877 kfree(value);
880 static int hid_input_report(int type, struct urb *urb, int interrupt)
882 struct hid_device *hid = urb->context;
883 struct hid_report_enum *report_enum = hid->report_enum + type;
884 u8 *data = urb->transfer_buffer;
885 int len = urb->actual_length;
886 struct hid_report *report;
887 int n, size;
889 if (!len) {
890 dbg("empty report");
891 return -1;
894 #ifdef DEBUG_DATA
895 printk(KERN_DEBUG __FILE__ ": report (size %u) (%snumbered)\n", len, report_enum->numbered ? "" : "un");
896 #endif
898 n = 0; /* Normally report number is 0 */
899 if (report_enum->numbered) { /* Device uses numbered reports, data[0] is report number */
900 n = *data++;
901 len--;
904 #ifdef DEBUG_DATA
906 int i;
907 printk(KERN_DEBUG __FILE__ ": report %d (size %u) = ", n, len);
908 for (i = 0; i < len; i++)
909 printk(" %02x", data[i]);
910 printk("\n");
912 #endif
914 if (!(report = report_enum->report_id_hash[n])) {
915 dbg("undefined report_id %d received", n);
916 return -1;
919 size = ((report->size - 1) >> 3) + 1;
921 if (len < size) {
922 dbg("report %d is too short, (%d < %d)", report->id, len, size);
923 memset(data + len, 0, size - len);
926 if (hid->claimed & HID_CLAIMED_HIDDEV)
927 hiddev_report_event(hid, report);
929 for (n = 0; n < report->maxfield; n++)
930 hid_input_field(hid, report->field[n], data, interrupt);
932 if (hid->claimed & HID_CLAIMED_INPUT)
933 hidinput_report_event(hid, report);
935 return 0;
939 * Input submission and I/O error handler.
942 static void hid_io_error(struct hid_device *hid);
944 /* Start up the input URB */
945 static int hid_start_in(struct hid_device *hid)
947 unsigned long flags;
948 int rc = 0;
950 spin_lock_irqsave(&hid->inlock, flags);
951 if (hid->open > 0 && !test_bit(HID_SUSPENDED, &hid->iofl) &&
952 !test_and_set_bit(HID_IN_RUNNING, &hid->iofl)) {
953 rc = usb_submit_urb(hid->urbin, GFP_ATOMIC);
954 if (rc != 0)
955 clear_bit(HID_IN_RUNNING, &hid->iofl);
957 spin_unlock_irqrestore(&hid->inlock, flags);
958 return rc;
961 /* I/O retry timer routine */
962 static void hid_retry_timeout(unsigned long _hid)
964 struct hid_device *hid = (struct hid_device *) _hid;
966 dev_dbg(&hid->intf->dev, "retrying intr urb\n");
967 if (hid_start_in(hid))
968 hid_io_error(hid);
971 /* Workqueue routine to reset the device */
972 static void hid_reset(void *_hid)
974 struct hid_device *hid = (struct hid_device *) _hid;
975 int rc_lock, rc;
977 dev_dbg(&hid->intf->dev, "resetting device\n");
978 rc = rc_lock = usb_lock_device_for_reset(hid->dev, hid->intf);
979 if (rc_lock >= 0) {
980 rc = usb_reset_composite_device(hid->dev, hid->intf);
981 if (rc_lock)
982 usb_unlock_device(hid->dev);
984 clear_bit(HID_RESET_PENDING, &hid->iofl);
986 switch (rc) {
987 case 0:
988 if (!test_bit(HID_IN_RUNNING, &hid->iofl))
989 hid_io_error(hid);
990 break;
991 default:
992 err("can't reset device, %s-%s/input%d, status %d",
993 hid->dev->bus->bus_name,
994 hid->dev->devpath,
995 hid->ifnum, rc);
996 /* FALLTHROUGH */
997 case -EHOSTUNREACH:
998 case -ENODEV:
999 case -EINTR:
1000 break;
1004 /* Main I/O error handler */
1005 static void hid_io_error(struct hid_device *hid)
1007 unsigned long flags;
1009 spin_lock_irqsave(&hid->inlock, flags);
1011 /* Stop when disconnected */
1012 if (usb_get_intfdata(hid->intf) == NULL)
1013 goto done;
1015 /* When an error occurs, retry at increasing intervals */
1016 if (hid->retry_delay == 0) {
1017 hid->retry_delay = 13; /* Then 26, 52, 104, 104, ... */
1018 hid->stop_retry = jiffies + msecs_to_jiffies(1000);
1019 } else if (hid->retry_delay < 100)
1020 hid->retry_delay *= 2;
1022 if (time_after(jiffies, hid->stop_retry)) {
1024 /* Retries failed, so do a port reset */
1025 if (!test_and_set_bit(HID_RESET_PENDING, &hid->iofl)) {
1026 if (schedule_work(&hid->reset_work))
1027 goto done;
1028 clear_bit(HID_RESET_PENDING, &hid->iofl);
1032 mod_timer(&hid->io_retry,
1033 jiffies + msecs_to_jiffies(hid->retry_delay));
1034 done:
1035 spin_unlock_irqrestore(&hid->inlock, flags);
1039 * Input interrupt completion handler.
1042 static void hid_irq_in(struct urb *urb)
1044 struct hid_device *hid = urb->context;
1045 int status;
1047 switch (urb->status) {
1048 case 0: /* success */
1049 hid->retry_delay = 0;
1050 hid_input_report(HID_INPUT_REPORT, urb, 1);
1051 break;
1052 case -ECONNRESET: /* unlink */
1053 case -ENOENT:
1054 case -ESHUTDOWN: /* unplug */
1055 clear_bit(HID_IN_RUNNING, &hid->iofl);
1056 return;
1057 case -EILSEQ: /* protocol error or unplug */
1058 case -EPROTO: /* protocol error or unplug */
1059 case -ETIME: /* protocol error or unplug */
1060 case -ETIMEDOUT: /* Should never happen, but... */
1061 clear_bit(HID_IN_RUNNING, &hid->iofl);
1062 hid_io_error(hid);
1063 return;
1064 default: /* error */
1065 warn("input irq status %d received", urb->status);
1068 status = usb_submit_urb(urb, SLAB_ATOMIC);
1069 if (status) {
1070 clear_bit(HID_IN_RUNNING, &hid->iofl);
1071 if (status != -EPERM) {
1072 err("can't resubmit intr, %s-%s/input%d, status %d",
1073 hid->dev->bus->bus_name,
1074 hid->dev->devpath,
1075 hid->ifnum, status);
1076 hid_io_error(hid);
1082 * Output the field into the report.
1085 static void hid_output_field(struct hid_field *field, __u8 *data)
1087 unsigned count = field->report_count;
1088 unsigned offset = field->report_offset;
1089 unsigned size = field->report_size;
1090 unsigned n;
1092 for (n = 0; n < count; n++) {
1093 if (field->logical_minimum < 0) /* signed values */
1094 implement(data, offset + n * size, size, s32ton(field->value[n], size));
1095 else /* unsigned values */
1096 implement(data, offset + n * size, size, field->value[n]);
1101 * Create a report.
1104 static void hid_output_report(struct hid_report *report, __u8 *data)
1106 unsigned n;
1108 if (report->id > 0)
1109 *data++ = report->id;
1111 for (n = 0; n < report->maxfield; n++)
1112 hid_output_field(report->field[n], data);
1116 * Set a field value. The report this field belongs to has to be
1117 * created and transferred to the device, to set this value in the
1118 * device.
1121 int hid_set_field(struct hid_field *field, unsigned offset, __s32 value)
1123 unsigned size = field->report_size;
1125 hid_dump_input(field->usage + offset, value);
1127 if (offset >= field->report_count) {
1128 dbg("offset (%d) exceeds report_count (%d)", offset, field->report_count);
1129 hid_dump_field(field, 8);
1130 return -1;
1132 if (field->logical_minimum < 0) {
1133 if (value != snto32(s32ton(value, size), size)) {
1134 dbg("value %d is out of range", value);
1135 return -1;
1138 field->value[offset] = value;
1139 return 0;
1143 * Find a report field with a specified HID usage.
1145 #if 0
1146 struct hid_field *hid_find_field_by_usage(struct hid_device *hid, __u32 wanted_usage, int type)
1148 struct hid_report *report;
1149 int i;
1151 list_for_each_entry(report, &hid->report_enum[type].report_list, list)
1152 for (i = 0; i < report->maxfield; i++)
1153 if (report->field[i]->logical == wanted_usage)
1154 return report->field[i];
1155 return NULL;
1157 #endif /* 0 */
1159 static int hid_submit_out(struct hid_device *hid)
1161 struct hid_report *report;
1163 report = hid->out[hid->outtail];
1165 hid_output_report(report, hid->outbuf);
1166 hid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
1167 hid->urbout->dev = hid->dev;
1169 dbg("submitting out urb");
1171 if (usb_submit_urb(hid->urbout, GFP_ATOMIC)) {
1172 err("usb_submit_urb(out) failed");
1173 return -1;
1176 return 0;
1179 static int hid_submit_ctrl(struct hid_device *hid)
1181 struct hid_report *report;
1182 unsigned char dir;
1183 int len;
1185 report = hid->ctrl[hid->ctrltail].report;
1186 dir = hid->ctrl[hid->ctrltail].dir;
1188 len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
1189 if (dir == USB_DIR_OUT) {
1190 hid_output_report(report, hid->ctrlbuf);
1191 hid->urbctrl->pipe = usb_sndctrlpipe(hid->dev, 0);
1192 hid->urbctrl->transfer_buffer_length = len;
1193 } else {
1194 int maxpacket, padlen;
1196 hid->urbctrl->pipe = usb_rcvctrlpipe(hid->dev, 0);
1197 maxpacket = usb_maxpacket(hid->dev, hid->urbctrl->pipe, 0);
1198 if (maxpacket > 0) {
1199 padlen = (len + maxpacket - 1) / maxpacket;
1200 padlen *= maxpacket;
1201 if (padlen > hid->bufsize)
1202 padlen = hid->bufsize;
1203 } else
1204 padlen = 0;
1205 hid->urbctrl->transfer_buffer_length = padlen;
1207 hid->urbctrl->dev = hid->dev;
1209 hid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
1210 hid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
1211 hid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
1212 hid->cr->wIndex = cpu_to_le16(hid->ifnum);
1213 hid->cr->wLength = cpu_to_le16(len);
1215 dbg("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u",
1216 hid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
1217 hid->cr->wValue, hid->cr->wIndex, hid->cr->wLength);
1219 if (usb_submit_urb(hid->urbctrl, GFP_ATOMIC)) {
1220 err("usb_submit_urb(ctrl) failed");
1221 return -1;
1224 return 0;
1228 * Output interrupt completion handler.
1231 static void hid_irq_out(struct urb *urb)
1233 struct hid_device *hid = urb->context;
1234 unsigned long flags;
1235 int unplug = 0;
1237 switch (urb->status) {
1238 case 0: /* success */
1239 break;
1240 case -ESHUTDOWN: /* unplug */
1241 unplug = 1;
1242 case -EILSEQ: /* protocol error or unplug */
1243 case -EPROTO: /* protocol error or unplug */
1244 case -ECONNRESET: /* unlink */
1245 case -ENOENT:
1246 break;
1247 default: /* error */
1248 warn("output irq status %d received", urb->status);
1251 spin_lock_irqsave(&hid->outlock, flags);
1253 if (unplug)
1254 hid->outtail = hid->outhead;
1255 else
1256 hid->outtail = (hid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
1258 if (hid->outhead != hid->outtail) {
1259 if (hid_submit_out(hid)) {
1260 clear_bit(HID_OUT_RUNNING, &hid->iofl);
1261 wake_up(&hid->wait);
1263 spin_unlock_irqrestore(&hid->outlock, flags);
1264 return;
1267 clear_bit(HID_OUT_RUNNING, &hid->iofl);
1268 spin_unlock_irqrestore(&hid->outlock, flags);
1269 wake_up(&hid->wait);
1273 * Control pipe completion handler.
1276 static void hid_ctrl(struct urb *urb)
1278 struct hid_device *hid = urb->context;
1279 unsigned long flags;
1280 int unplug = 0;
1282 spin_lock_irqsave(&hid->ctrllock, flags);
1284 switch (urb->status) {
1285 case 0: /* success */
1286 if (hid->ctrl[hid->ctrltail].dir == USB_DIR_IN)
1287 hid_input_report(hid->ctrl[hid->ctrltail].report->type, urb, 0);
1288 break;
1289 case -ESHUTDOWN: /* unplug */
1290 unplug = 1;
1291 case -EILSEQ: /* protocol error or unplug */
1292 case -EPROTO: /* protocol error or unplug */
1293 case -ECONNRESET: /* unlink */
1294 case -ENOENT:
1295 case -EPIPE: /* report not available */
1296 break;
1297 default: /* error */
1298 warn("ctrl urb status %d received", urb->status);
1301 if (unplug)
1302 hid->ctrltail = hid->ctrlhead;
1303 else
1304 hid->ctrltail = (hid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
1306 if (hid->ctrlhead != hid->ctrltail) {
1307 if (hid_submit_ctrl(hid)) {
1308 clear_bit(HID_CTRL_RUNNING, &hid->iofl);
1309 wake_up(&hid->wait);
1311 spin_unlock_irqrestore(&hid->ctrllock, flags);
1312 return;
1315 clear_bit(HID_CTRL_RUNNING, &hid->iofl);
1316 spin_unlock_irqrestore(&hid->ctrllock, flags);
1317 wake_up(&hid->wait);
1320 void hid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
1322 int head;
1323 unsigned long flags;
1325 if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
1326 return;
1328 if (hid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
1330 spin_lock_irqsave(&hid->outlock, flags);
1332 if ((head = (hid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == hid->outtail) {
1333 spin_unlock_irqrestore(&hid->outlock, flags);
1334 warn("output queue full");
1335 return;
1338 hid->out[hid->outhead] = report;
1339 hid->outhead = head;
1341 if (!test_and_set_bit(HID_OUT_RUNNING, &hid->iofl))
1342 if (hid_submit_out(hid))
1343 clear_bit(HID_OUT_RUNNING, &hid->iofl);
1345 spin_unlock_irqrestore(&hid->outlock, flags);
1346 return;
1349 spin_lock_irqsave(&hid->ctrllock, flags);
1351 if ((head = (hid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == hid->ctrltail) {
1352 spin_unlock_irqrestore(&hid->ctrllock, flags);
1353 warn("control queue full");
1354 return;
1357 hid->ctrl[hid->ctrlhead].report = report;
1358 hid->ctrl[hid->ctrlhead].dir = dir;
1359 hid->ctrlhead = head;
1361 if (!test_and_set_bit(HID_CTRL_RUNNING, &hid->iofl))
1362 if (hid_submit_ctrl(hid))
1363 clear_bit(HID_CTRL_RUNNING, &hid->iofl);
1365 spin_unlock_irqrestore(&hid->ctrllock, flags);
1368 int hid_wait_io(struct hid_device *hid)
1370 if (!wait_event_timeout(hid->wait, (!test_bit(HID_CTRL_RUNNING, &hid->iofl) &&
1371 !test_bit(HID_OUT_RUNNING, &hid->iofl)),
1372 10*HZ)) {
1373 dbg("timeout waiting for ctrl or out queue to clear");
1374 return -1;
1377 return 0;
1380 static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
1382 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1383 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
1384 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
1387 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
1388 unsigned char type, void *buf, int size)
1390 int result, retries = 4;
1392 memset(buf,0,size); // Make sure we parse really received data
1394 do {
1395 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
1396 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
1397 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
1398 retries--;
1399 } while (result < size && retries);
1400 return result;
1403 int hid_open(struct hid_device *hid)
1405 ++hid->open;
1406 if (hid_start_in(hid))
1407 hid_io_error(hid);
1408 return 0;
1411 void hid_close(struct hid_device *hid)
1413 if (!--hid->open)
1414 usb_kill_urb(hid->urbin);
1417 #define USB_VENDOR_ID_PANJIT 0x134c
1419 #define USB_VENDOR_ID_TURBOX 0x062a
1420 #define USB_DEVICE_ID_TURBOX_KEYBOARD 0x0201
1423 * Initialize all reports
1426 void hid_init_reports(struct hid_device *hid)
1428 struct hid_report *report;
1429 int err, ret;
1431 list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
1432 hid_submit_report(hid, report, USB_DIR_IN);
1434 list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
1435 hid_submit_report(hid, report, USB_DIR_IN);
1437 err = 0;
1438 ret = hid_wait_io(hid);
1439 while (ret) {
1440 err |= ret;
1441 if (test_bit(HID_CTRL_RUNNING, &hid->iofl))
1442 usb_kill_urb(hid->urbctrl);
1443 if (test_bit(HID_OUT_RUNNING, &hid->iofl))
1444 usb_kill_urb(hid->urbout);
1445 ret = hid_wait_io(hid);
1448 if (err)
1449 warn("timeout initializing reports");
1452 #define USB_VENDOR_ID_GTCO 0x078c
1453 #define USB_DEVICE_ID_GTCO_90 0x0090
1454 #define USB_DEVICE_ID_GTCO_100 0x0100
1455 #define USB_DEVICE_ID_GTCO_101 0x0101
1456 #define USB_DEVICE_ID_GTCO_103 0x0103
1457 #define USB_DEVICE_ID_GTCO_104 0x0104
1458 #define USB_DEVICE_ID_GTCO_105 0x0105
1459 #define USB_DEVICE_ID_GTCO_106 0x0106
1460 #define USB_DEVICE_ID_GTCO_107 0x0107
1461 #define USB_DEVICE_ID_GTCO_108 0x0108
1462 #define USB_DEVICE_ID_GTCO_200 0x0200
1463 #define USB_DEVICE_ID_GTCO_201 0x0201
1464 #define USB_DEVICE_ID_GTCO_202 0x0202
1465 #define USB_DEVICE_ID_GTCO_203 0x0203
1466 #define USB_DEVICE_ID_GTCO_204 0x0204
1467 #define USB_DEVICE_ID_GTCO_205 0x0205
1468 #define USB_DEVICE_ID_GTCO_206 0x0206
1469 #define USB_DEVICE_ID_GTCO_207 0x0207
1470 #define USB_DEVICE_ID_GTCO_300 0x0300
1471 #define USB_DEVICE_ID_GTCO_301 0x0301
1472 #define USB_DEVICE_ID_GTCO_302 0x0302
1473 #define USB_DEVICE_ID_GTCO_303 0x0303
1474 #define USB_DEVICE_ID_GTCO_304 0x0304
1475 #define USB_DEVICE_ID_GTCO_305 0x0305
1476 #define USB_DEVICE_ID_GTCO_306 0x0306
1477 #define USB_DEVICE_ID_GTCO_307 0x0307
1478 #define USB_DEVICE_ID_GTCO_308 0x0308
1479 #define USB_DEVICE_ID_GTCO_309 0x0309
1480 #define USB_DEVICE_ID_GTCO_400 0x0400
1481 #define USB_DEVICE_ID_GTCO_401 0x0401
1482 #define USB_DEVICE_ID_GTCO_402 0x0402
1483 #define USB_DEVICE_ID_GTCO_403 0x0403
1484 #define USB_DEVICE_ID_GTCO_404 0x0404
1485 #define USB_DEVICE_ID_GTCO_405 0x0405
1486 #define USB_DEVICE_ID_GTCO_500 0x0500
1487 #define USB_DEVICE_ID_GTCO_501 0x0501
1488 #define USB_DEVICE_ID_GTCO_502 0x0502
1489 #define USB_DEVICE_ID_GTCO_503 0x0503
1490 #define USB_DEVICE_ID_GTCO_504 0x0504
1491 #define USB_DEVICE_ID_GTCO_1000 0x1000
1492 #define USB_DEVICE_ID_GTCO_1001 0x1001
1493 #define USB_DEVICE_ID_GTCO_1002 0x1002
1494 #define USB_DEVICE_ID_GTCO_1003 0x1003
1495 #define USB_DEVICE_ID_GTCO_1004 0x1004
1496 #define USB_DEVICE_ID_GTCO_1005 0x1005
1497 #define USB_DEVICE_ID_GTCO_1006 0x1006
1499 #define USB_VENDOR_ID_WACOM 0x056a
1501 #define USB_VENDOR_ID_ACECAD 0x0460
1502 #define USB_DEVICE_ID_ACECAD_FLAIR 0x0004
1503 #define USB_DEVICE_ID_ACECAD_302 0x0008
1505 #define USB_VENDOR_ID_KBGEAR 0x084e
1506 #define USB_DEVICE_ID_KBGEAR_JAMSTUDIO 0x1001
1508 #define USB_VENDOR_ID_AIPTEK 0x08ca
1509 #define USB_DEVICE_ID_AIPTEK_01 0x0001
1510 #define USB_DEVICE_ID_AIPTEK_10 0x0010
1511 #define USB_DEVICE_ID_AIPTEK_20 0x0020
1512 #define USB_DEVICE_ID_AIPTEK_21 0x0021
1513 #define USB_DEVICE_ID_AIPTEK_22 0x0022
1514 #define USB_DEVICE_ID_AIPTEK_23 0x0023
1515 #define USB_DEVICE_ID_AIPTEK_24 0x0024
1517 #define USB_VENDOR_ID_GRIFFIN 0x077d
1518 #define USB_DEVICE_ID_POWERMATE 0x0410
1519 #define USB_DEVICE_ID_SOUNDKNOB 0x04AA
1521 #define USB_VENDOR_ID_ATEN 0x0557
1522 #define USB_DEVICE_ID_ATEN_UC100KM 0x2004
1523 #define USB_DEVICE_ID_ATEN_CS124U 0x2202
1524 #define USB_DEVICE_ID_ATEN_2PORTKVM 0x2204
1525 #define USB_DEVICE_ID_ATEN_4PORTKVM 0x2205
1526 #define USB_DEVICE_ID_ATEN_4PORTKVMC 0x2208
1528 #define USB_VENDOR_ID_TOPMAX 0x0663
1529 #define USB_DEVICE_ID_TOPMAX_COBRAPAD 0x0103
1531 #define USB_VENDOR_ID_HAPP 0x078b
1532 #define USB_DEVICE_ID_UGCI_DRIVING 0x0010
1533 #define USB_DEVICE_ID_UGCI_FLYING 0x0020
1534 #define USB_DEVICE_ID_UGCI_FIGHTING 0x0030
1536 #define USB_VENDOR_ID_MGE 0x0463
1537 #define USB_DEVICE_ID_MGE_UPS 0xffff
1538 #define USB_DEVICE_ID_MGE_UPS1 0x0001
1540 #define USB_VENDOR_ID_ONTRAK 0x0a07
1541 #define USB_DEVICE_ID_ONTRAK_ADU100 0x0064
1543 #define USB_VENDOR_ID_ESSENTIAL_REALITY 0x0d7f
1544 #define USB_DEVICE_ID_ESSENTIAL_REALITY_P5 0x0100
1546 #define USB_VENDOR_ID_A4TECH 0x09da
1547 #define USB_DEVICE_ID_A4TECH_WCP32PU 0x0006
1549 #define USB_VENDOR_ID_AASHIMA 0x06d6
1550 #define USB_DEVICE_ID_AASHIMA_GAMEPAD 0x0025
1551 #define USB_DEVICE_ID_AASHIMA_PREDATOR 0x0026
1553 #define USB_VENDOR_ID_CYPRESS 0x04b4
1554 #define USB_DEVICE_ID_CYPRESS_MOUSE 0x0001
1555 #define USB_DEVICE_ID_CYPRESS_HIDCOM 0x5500
1556 #define USB_DEVICE_ID_CYPRESS_ULTRAMOUSE 0x7417
1558 #define USB_VENDOR_ID_BERKSHIRE 0x0c98
1559 #define USB_DEVICE_ID_BERKSHIRE_PCWD 0x1140
1561 #define USB_VENDOR_ID_ALPS 0x0433
1562 #define USB_DEVICE_ID_IBM_GAMEPAD 0x1101
1564 #define USB_VENDOR_ID_SAITEK 0x06a3
1565 #define USB_DEVICE_ID_SAITEK_RUMBLEPAD 0xff17
1567 #define USB_VENDOR_ID_NEC 0x073e
1568 #define USB_DEVICE_ID_NEC_USB_GAME_PAD 0x0301
1570 #define USB_VENDOR_ID_CHIC 0x05fe
1571 #define USB_DEVICE_ID_CHIC_GAMEPAD 0x0014
1573 #define USB_VENDOR_ID_GLAB 0x06c2
1574 #define USB_DEVICE_ID_4_PHIDGETSERVO_30 0x0038
1575 #define USB_DEVICE_ID_1_PHIDGETSERVO_30 0x0039
1576 #define USB_DEVICE_ID_0_0_4_IF_KIT 0x0040
1577 #define USB_DEVICE_ID_0_16_16_IF_KIT 0x0044
1578 #define USB_DEVICE_ID_8_8_8_IF_KIT 0x0045
1579 #define USB_DEVICE_ID_0_8_7_IF_KIT 0x0051
1580 #define USB_DEVICE_ID_0_8_8_IF_KIT 0x0053
1581 #define USB_DEVICE_ID_PHIDGET_MOTORCONTROL 0x0058
1583 #define USB_VENDOR_ID_WISEGROUP 0x0925
1584 #define USB_DEVICE_ID_1_PHIDGETSERVO_20 0x8101
1585 #define USB_DEVICE_ID_4_PHIDGETSERVO_20 0x8104
1586 #define USB_DEVICE_ID_8_8_4_IF_KIT 0x8201
1587 #define USB_DEVICE_ID_DUAL_USB_JOYPAD 0x8866
1589 #define USB_VENDOR_ID_WISEGROUP_LTD 0x6677
1590 #define USB_DEVICE_ID_SMARTJOY_DUAL_PLUS 0x8802
1592 #define USB_VENDOR_ID_CODEMERCS 0x07c0
1593 #define USB_DEVICE_ID_CODEMERCS_IOW40 0x1500
1594 #define USB_DEVICE_ID_CODEMERCS_IOW24 0x1501
1595 #define USB_DEVICE_ID_CODEMERCS_IOW48 0x1502
1596 #define USB_DEVICE_ID_CODEMERCS_IOW28 0x1503
1598 #define USB_VENDOR_ID_DELORME 0x1163
1599 #define USB_DEVICE_ID_DELORME_EARTHMATE 0x0100
1600 #define USB_DEVICE_ID_DELORME_EM_LT20 0x0200
1602 #define USB_VENDOR_ID_MCC 0x09db
1603 #define USB_DEVICE_ID_MCC_PMD1024LS 0x0076
1604 #define USB_DEVICE_ID_MCC_PMD1208LS 0x007a
1606 #define USB_VENDOR_ID_VERNIER 0x08f7
1607 #define USB_DEVICE_ID_VERNIER_LABPRO 0x0001
1608 #define USB_DEVICE_ID_VERNIER_GOTEMP 0x0002
1609 #define USB_DEVICE_ID_VERNIER_SKIP 0x0003
1610 #define USB_DEVICE_ID_VERNIER_CYCLOPS 0x0004
1612 #define USB_VENDOR_ID_LD 0x0f11
1613 #define USB_DEVICE_ID_LD_CASSY 0x1000
1614 #define USB_DEVICE_ID_LD_POCKETCASSY 0x1010
1615 #define USB_DEVICE_ID_LD_MOBILECASSY 0x1020
1616 #define USB_DEVICE_ID_LD_JWM 0x1080
1617 #define USB_DEVICE_ID_LD_DMMP 0x1081
1618 #define USB_DEVICE_ID_LD_UMIP 0x1090
1619 #define USB_DEVICE_ID_LD_XRAY1 0x1100
1620 #define USB_DEVICE_ID_LD_XRAY2 0x1101
1621 #define USB_DEVICE_ID_LD_VIDEOCOM 0x1200
1622 #define USB_DEVICE_ID_LD_COM3LAB 0x2000
1623 #define USB_DEVICE_ID_LD_TELEPORT 0x2010
1624 #define USB_DEVICE_ID_LD_NETWORKANALYSER 0x2020
1625 #define USB_DEVICE_ID_LD_POWERCONTROL 0x2030
1626 #define USB_DEVICE_ID_LD_MACHINETEST 0x2040
1628 #define USB_VENDOR_ID_APPLE 0x05ac
1629 #define USB_DEVICE_ID_APPLE_MIGHTYMOUSE 0x0304
1631 #define USB_VENDOR_ID_CHERRY 0x046a
1632 #define USB_DEVICE_ID_CHERRY_CYMOTION 0x0023
1634 #define USB_VENDOR_ID_YEALINK 0x6993
1635 #define USB_DEVICE_ID_YEALINK_P1K_P4K_B2K 0xb001
1637 #define USB_VENDOR_ID_ALCOR 0x058f
1638 #define USB_DEVICE_ID_ALCOR_USBRS232 0x9720
1640 #define USB_VENDOR_ID_SUN 0x0430
1641 #define USB_DEVICE_ID_RARITAN_KVM_DONGLE 0xcdab
1644 * Alphabetically sorted blacklist by quirk type.
1647 static const struct hid_blacklist {
1648 __u16 idVendor;
1649 __u16 idProduct;
1650 unsigned quirks;
1651 } hid_blacklist[] = {
1653 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_01, HID_QUIRK_IGNORE },
1654 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_10, HID_QUIRK_IGNORE },
1655 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_20, HID_QUIRK_IGNORE },
1656 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_21, HID_QUIRK_IGNORE },
1657 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_22, HID_QUIRK_IGNORE },
1658 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_23, HID_QUIRK_IGNORE },
1659 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_24, HID_QUIRK_IGNORE },
1660 { USB_VENDOR_ID_ALCOR, USB_DEVICE_ID_ALCOR_USBRS232, HID_QUIRK_IGNORE },
1661 { USB_VENDOR_ID_BERKSHIRE, USB_DEVICE_ID_BERKSHIRE_PCWD, HID_QUIRK_IGNORE },
1662 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW40, HID_QUIRK_IGNORE },
1663 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW24, HID_QUIRK_IGNORE },
1664 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW48, HID_QUIRK_IGNORE },
1665 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW28, HID_QUIRK_IGNORE },
1666 { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_HIDCOM, HID_QUIRK_IGNORE },
1667 { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_ULTRAMOUSE, HID_QUIRK_IGNORE },
1668 { USB_VENDOR_ID_DELORME, USB_DEVICE_ID_DELORME_EARTHMATE, HID_QUIRK_IGNORE },
1669 { USB_VENDOR_ID_DELORME, USB_DEVICE_ID_DELORME_EM_LT20, HID_QUIRK_IGNORE },
1670 { USB_VENDOR_ID_ESSENTIAL_REALITY, USB_DEVICE_ID_ESSENTIAL_REALITY_P5, HID_QUIRK_IGNORE },
1671 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_4_PHIDGETSERVO_30, HID_QUIRK_IGNORE },
1672 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_1_PHIDGETSERVO_30, HID_QUIRK_IGNORE },
1673 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_0_4_IF_KIT, HID_QUIRK_IGNORE },
1674 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_16_16_IF_KIT, HID_QUIRK_IGNORE },
1675 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_8_8_8_IF_KIT, HID_QUIRK_IGNORE },
1676 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_8_7_IF_KIT, HID_QUIRK_IGNORE },
1677 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_8_8_IF_KIT, HID_QUIRK_IGNORE },
1678 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_PHIDGET_MOTORCONTROL, HID_QUIRK_IGNORE },
1679 { USB_VENDOR_ID_GRIFFIN, USB_DEVICE_ID_POWERMATE, HID_QUIRK_IGNORE },
1680 { USB_VENDOR_ID_GRIFFIN, USB_DEVICE_ID_SOUNDKNOB, HID_QUIRK_IGNORE },
1681 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_90, HID_QUIRK_IGNORE },
1682 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_100, HID_QUIRK_IGNORE },
1683 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_101, HID_QUIRK_IGNORE },
1684 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_103, HID_QUIRK_IGNORE },
1685 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_104, HID_QUIRK_IGNORE },
1686 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_105, HID_QUIRK_IGNORE },
1687 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_106, HID_QUIRK_IGNORE },
1688 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_107, HID_QUIRK_IGNORE },
1689 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_108, HID_QUIRK_IGNORE },
1690 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_200, HID_QUIRK_IGNORE },
1691 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_201, HID_QUIRK_IGNORE },
1692 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_202, HID_QUIRK_IGNORE },
1693 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_203, HID_QUIRK_IGNORE },
1694 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_204, HID_QUIRK_IGNORE },
1695 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_205, HID_QUIRK_IGNORE },
1696 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_206, HID_QUIRK_IGNORE },
1697 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_207, HID_QUIRK_IGNORE },
1698 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_300, HID_QUIRK_IGNORE },
1699 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_301, HID_QUIRK_IGNORE },
1700 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_302, HID_QUIRK_IGNORE },
1701 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_303, HID_QUIRK_IGNORE },
1702 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_304, HID_QUIRK_IGNORE },
1703 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_305, HID_QUIRK_IGNORE },
1704 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_306, HID_QUIRK_IGNORE },
1705 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_307, HID_QUIRK_IGNORE },
1706 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_308, HID_QUIRK_IGNORE },
1707 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_309, HID_QUIRK_IGNORE },
1708 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_400, HID_QUIRK_IGNORE },
1709 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_401, HID_QUIRK_IGNORE },
1710 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_402, HID_QUIRK_IGNORE },
1711 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_403, HID_QUIRK_IGNORE },
1712 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_404, HID_QUIRK_IGNORE },
1713 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_405, HID_QUIRK_IGNORE },
1714 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_500, HID_QUIRK_IGNORE },
1715 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_501, HID_QUIRK_IGNORE },
1716 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_502, HID_QUIRK_IGNORE },
1717 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_503, HID_QUIRK_IGNORE },
1718 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_504, HID_QUIRK_IGNORE },
1719 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1000, HID_QUIRK_IGNORE },
1720 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1001, HID_QUIRK_IGNORE },
1721 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1002, HID_QUIRK_IGNORE },
1722 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1003, HID_QUIRK_IGNORE },
1723 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1004, HID_QUIRK_IGNORE },
1724 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1005, HID_QUIRK_IGNORE },
1725 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1006, HID_QUIRK_IGNORE },
1726 { USB_VENDOR_ID_KBGEAR, USB_DEVICE_ID_KBGEAR_JAMSTUDIO, HID_QUIRK_IGNORE },
1727 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_CASSY, HID_QUIRK_IGNORE },
1728 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POCKETCASSY, HID_QUIRK_IGNORE },
1729 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MOBILECASSY, HID_QUIRK_IGNORE },
1730 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_JWM, HID_QUIRK_IGNORE },
1731 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_DMMP, HID_QUIRK_IGNORE },
1732 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_UMIP, HID_QUIRK_IGNORE },
1733 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_XRAY1, HID_QUIRK_IGNORE },
1734 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_XRAY2, HID_QUIRK_IGNORE },
1735 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_VIDEOCOM, HID_QUIRK_IGNORE },
1736 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_COM3LAB, HID_QUIRK_IGNORE },
1737 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_TELEPORT, HID_QUIRK_IGNORE },
1738 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_NETWORKANALYSER, HID_QUIRK_IGNORE },
1739 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POWERCONTROL, HID_QUIRK_IGNORE },
1740 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MACHINETEST, HID_QUIRK_IGNORE },
1741 { USB_VENDOR_ID_MCC, USB_DEVICE_ID_MCC_PMD1024LS, HID_QUIRK_IGNORE },
1742 { USB_VENDOR_ID_MCC, USB_DEVICE_ID_MCC_PMD1208LS, HID_QUIRK_IGNORE },
1743 { USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS, HID_QUIRK_IGNORE },
1744 { USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS1, HID_QUIRK_IGNORE },
1745 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100, HID_QUIRK_IGNORE },
1746 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 20, HID_QUIRK_IGNORE },
1747 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 30, HID_QUIRK_IGNORE },
1748 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 100, HID_QUIRK_IGNORE },
1749 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 108, HID_QUIRK_IGNORE },
1750 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 118, HID_QUIRK_IGNORE },
1751 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 200, HID_QUIRK_IGNORE },
1752 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 300, HID_QUIRK_IGNORE },
1753 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 400, HID_QUIRK_IGNORE },
1754 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 500, HID_QUIRK_IGNORE },
1755 { USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_LABPRO, HID_QUIRK_IGNORE },
1756 { USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_GOTEMP, HID_QUIRK_IGNORE },
1757 { USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_SKIP, HID_QUIRK_IGNORE },
1758 { USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_CYCLOPS, HID_QUIRK_IGNORE },
1759 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_4_PHIDGETSERVO_20, HID_QUIRK_IGNORE },
1760 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_1_PHIDGETSERVO_20, HID_QUIRK_IGNORE },
1761 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_8_8_4_IF_KIT, HID_QUIRK_IGNORE },
1762 { USB_VENDOR_ID_YEALINK, USB_DEVICE_ID_YEALINK_P1K_P4K_B2K, HID_QUIRK_IGNORE },
1764 { USB_VENDOR_ID_ACECAD, USB_DEVICE_ID_ACECAD_FLAIR, HID_QUIRK_IGNORE },
1765 { USB_VENDOR_ID_ACECAD, USB_DEVICE_ID_ACECAD_302, HID_QUIRK_IGNORE },
1767 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
1768 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
1769 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
1770 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
1771 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
1772 { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
1773 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
1774 { USB_VENDOR_ID_WISEGROUP_LTD, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
1776 { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE, HID_QUIRK_MIGHTYMOUSE | HID_QUIRK_INVERT_HWHEEL },
1777 { USB_VENDOR_ID_A4TECH, USB_DEVICE_ID_A4TECH_WCP32PU, HID_QUIRK_2WHEEL_MOUSE_HACK_7 },
1778 { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_MOUSE, HID_QUIRK_2WHEEL_MOUSE_HACK_5 },
1780 { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_GAMEPAD, HID_QUIRK_BADPAD },
1781 { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_PREDATOR, HID_QUIRK_BADPAD },
1782 { USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
1783 { USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
1784 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1785 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1786 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1787 { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
1788 { USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
1789 { USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },
1791 { USB_VENDOR_ID_CHERRY, USB_DEVICE_ID_CHERRY_CYMOTION, HID_QUIRK_CYMOTION },
1793 { USB_VENDOR_ID_APPLE, 0x020E, HID_QUIRK_POWERBOOK_HAS_FN },
1794 { USB_VENDOR_ID_APPLE, 0x020F, HID_QUIRK_POWERBOOK_HAS_FN },
1795 { USB_VENDOR_ID_APPLE, 0x0214, HID_QUIRK_POWERBOOK_HAS_FN },
1796 { USB_VENDOR_ID_APPLE, 0x0215, HID_QUIRK_POWERBOOK_HAS_FN },
1797 { USB_VENDOR_ID_APPLE, 0x0216, HID_QUIRK_POWERBOOK_HAS_FN },
1798 { USB_VENDOR_ID_APPLE, 0x0217, HID_QUIRK_POWERBOOK_HAS_FN },
1799 { USB_VENDOR_ID_APPLE, 0x0218, HID_QUIRK_POWERBOOK_HAS_FN },
1800 { USB_VENDOR_ID_APPLE, 0x0219, HID_QUIRK_POWERBOOK_HAS_FN },
1801 { USB_VENDOR_ID_APPLE, 0x030A, HID_QUIRK_POWERBOOK_HAS_FN },
1802 { USB_VENDOR_ID_APPLE, 0x030B, HID_QUIRK_POWERBOOK_HAS_FN },
1804 { USB_VENDOR_ID_PANJIT, 0x0001, HID_QUIRK_IGNORE },
1805 { USB_VENDOR_ID_PANJIT, 0x0002, HID_QUIRK_IGNORE },
1806 { USB_VENDOR_ID_PANJIT, 0x0003, HID_QUIRK_IGNORE },
1807 { USB_VENDOR_ID_PANJIT, 0x0004, HID_QUIRK_IGNORE },
1809 { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
1811 { 0, 0 }
1815 * Traverse the supplied list of reports and find the longest
1817 static void hid_find_max_report(struct hid_device *hid, unsigned int type, int *max)
1819 struct hid_report *report;
1820 int size;
1822 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
1823 size = ((report->size - 1) >> 3) + 1;
1824 if (type == HID_INPUT_REPORT && hid->report_enum[type].numbered)
1825 size++;
1826 if (*max < size)
1827 *max = size;
1831 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
1833 if (!(hid->inbuf = usb_buffer_alloc(dev, hid->bufsize, SLAB_ATOMIC, &hid->inbuf_dma)))
1834 return -1;
1835 if (!(hid->outbuf = usb_buffer_alloc(dev, hid->bufsize, SLAB_ATOMIC, &hid->outbuf_dma)))
1836 return -1;
1837 if (!(hid->cr = usb_buffer_alloc(dev, sizeof(*(hid->cr)), SLAB_ATOMIC, &hid->cr_dma)))
1838 return -1;
1839 if (!(hid->ctrlbuf = usb_buffer_alloc(dev, hid->bufsize, SLAB_ATOMIC, &hid->ctrlbuf_dma)))
1840 return -1;
1842 return 0;
1845 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
1847 if (hid->inbuf)
1848 usb_buffer_free(dev, hid->bufsize, hid->inbuf, hid->inbuf_dma);
1849 if (hid->outbuf)
1850 usb_buffer_free(dev, hid->bufsize, hid->outbuf, hid->outbuf_dma);
1851 if (hid->cr)
1852 usb_buffer_free(dev, sizeof(*(hid->cr)), hid->cr, hid->cr_dma);
1853 if (hid->ctrlbuf)
1854 usb_buffer_free(dev, hid->bufsize, hid->ctrlbuf, hid->ctrlbuf_dma);
1858 * Cherry Cymotion keyboard have an invalid HID report descriptor,
1859 * that needs fixing before we can parse it.
1862 static void hid_fixup_cymotion_descriptor(char *rdesc, int rsize)
1864 if (rsize >= 17 && rdesc[11] == 0x3c && rdesc[12] == 0x02) {
1865 info("Fixing up Cherry Cymotion report descriptor");
1866 rdesc[11] = rdesc[16] = 0xff;
1867 rdesc[12] = rdesc[17] = 0x03;
1871 static struct hid_device *usb_hid_configure(struct usb_interface *intf)
1873 struct usb_host_interface *interface = intf->cur_altsetting;
1874 struct usb_device *dev = interface_to_usbdev (intf);
1875 struct hid_descriptor *hdesc;
1876 struct hid_device *hid;
1877 unsigned quirks = 0, rsize = 0;
1878 char *rdesc;
1879 int n, len, insize = 0;
1881 /* Ignore all Wacom devices */
1882 if (le16_to_cpu(dev->descriptor.idVendor) == USB_VENDOR_ID_WACOM)
1883 return NULL;
1885 for (n = 0; hid_blacklist[n].idVendor; n++)
1886 if ((hid_blacklist[n].idVendor == le16_to_cpu(dev->descriptor.idVendor)) &&
1887 (hid_blacklist[n].idProduct == le16_to_cpu(dev->descriptor.idProduct)))
1888 quirks = hid_blacklist[n].quirks;
1890 /* Many keyboards and mice don't like to be polled for reports,
1891 * so we will always set the HID_QUIRK_NOGET flag for them. */
1892 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
1893 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
1894 interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
1895 quirks |= HID_QUIRK_NOGET;
1898 if (quirks & HID_QUIRK_IGNORE)
1899 return NULL;
1901 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
1902 (!interface->desc.bNumEndpoints ||
1903 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
1904 dbg("class descriptor not present\n");
1905 return NULL;
1908 for (n = 0; n < hdesc->bNumDescriptors; n++)
1909 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
1910 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
1912 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
1913 dbg("weird size of report descriptor (%u)", rsize);
1914 return NULL;
1917 if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
1918 dbg("couldn't allocate rdesc memory");
1919 return NULL;
1922 hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
1924 if ((n = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber, HID_DT_REPORT, rdesc, rsize)) < 0) {
1925 dbg("reading report descriptor failed");
1926 kfree(rdesc);
1927 return NULL;
1930 if ((quirks & HID_QUIRK_CYMOTION))
1931 hid_fixup_cymotion_descriptor(rdesc, rsize);
1933 #ifdef DEBUG_DATA
1934 printk(KERN_DEBUG __FILE__ ": report descriptor (size %u, read %d) = ", rsize, n);
1935 for (n = 0; n < rsize; n++)
1936 printk(" %02x", (unsigned char) rdesc[n]);
1937 printk("\n");
1938 #endif
1940 if (!(hid = hid_parse_report(rdesc, n))) {
1941 dbg("parsing report descriptor failed");
1942 kfree(rdesc);
1943 return NULL;
1946 kfree(rdesc);
1947 hid->quirks = quirks;
1949 hid->bufsize = HID_MIN_BUFFER_SIZE;
1950 hid_find_max_report(hid, HID_INPUT_REPORT, &hid->bufsize);
1951 hid_find_max_report(hid, HID_OUTPUT_REPORT, &hid->bufsize);
1952 hid_find_max_report(hid, HID_FEATURE_REPORT, &hid->bufsize);
1954 if (hid->bufsize > HID_MAX_BUFFER_SIZE)
1955 hid->bufsize = HID_MAX_BUFFER_SIZE;
1957 hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
1959 if (insize > HID_MAX_BUFFER_SIZE)
1960 insize = HID_MAX_BUFFER_SIZE;
1962 if (hid_alloc_buffers(dev, hid)) {
1963 hid_free_buffers(dev, hid);
1964 goto fail;
1967 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
1969 struct usb_endpoint_descriptor *endpoint;
1970 int pipe;
1971 int interval;
1973 endpoint = &interface->endpoint[n].desc;
1974 if ((endpoint->bmAttributes & 3) != 3) /* Not an interrupt endpoint */
1975 continue;
1977 interval = endpoint->bInterval;
1979 /* Change the polling interval of mice. */
1980 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
1981 interval = hid_mousepoll_interval;
1983 if (endpoint->bEndpointAddress & USB_DIR_IN) {
1984 if (hid->urbin)
1985 continue;
1986 if (!(hid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
1987 goto fail;
1988 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
1989 usb_fill_int_urb(hid->urbin, dev, pipe, hid->inbuf, insize,
1990 hid_irq_in, hid, interval);
1991 hid->urbin->transfer_dma = hid->inbuf_dma;
1992 hid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1993 } else {
1994 if (hid->urbout)
1995 continue;
1996 if (!(hid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
1997 goto fail;
1998 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
1999 usb_fill_int_urb(hid->urbout, dev, pipe, hid->outbuf, 0,
2000 hid_irq_out, hid, interval);
2001 hid->urbout->transfer_dma = hid->outbuf_dma;
2002 hid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
2006 if (!hid->urbin) {
2007 err("couldn't find an input interrupt endpoint");
2008 goto fail;
2011 init_waitqueue_head(&hid->wait);
2013 INIT_WORK(&hid->reset_work, hid_reset, hid);
2014 setup_timer(&hid->io_retry, hid_retry_timeout, (unsigned long) hid);
2016 spin_lock_init(&hid->inlock);
2017 spin_lock_init(&hid->outlock);
2018 spin_lock_init(&hid->ctrllock);
2020 hid->version = le16_to_cpu(hdesc->bcdHID);
2021 hid->country = hdesc->bCountryCode;
2022 hid->dev = dev;
2023 hid->intf = intf;
2024 hid->ifnum = interface->desc.bInterfaceNumber;
2026 hid->name[0] = 0;
2028 if (dev->manufacturer)
2029 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
2031 if (dev->product) {
2032 if (dev->manufacturer)
2033 strlcat(hid->name, " ", sizeof(hid->name));
2034 strlcat(hid->name, dev->product, sizeof(hid->name));
2037 if (!strlen(hid->name))
2038 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
2039 le16_to_cpu(dev->descriptor.idVendor),
2040 le16_to_cpu(dev->descriptor.idProduct));
2042 usb_make_path(dev, hid->phys, sizeof(hid->phys));
2043 strlcat(hid->phys, "/input", sizeof(hid->phys));
2044 len = strlen(hid->phys);
2045 if (len < sizeof(hid->phys) - 1)
2046 snprintf(hid->phys + len, sizeof(hid->phys) - len,
2047 "%d", intf->altsetting[0].desc.bInterfaceNumber);
2049 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
2050 hid->uniq[0] = 0;
2052 hid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
2053 if (!hid->urbctrl)
2054 goto fail;
2056 usb_fill_control_urb(hid->urbctrl, dev, 0, (void *) hid->cr,
2057 hid->ctrlbuf, 1, hid_ctrl, hid);
2058 hid->urbctrl->setup_dma = hid->cr_dma;
2059 hid->urbctrl->transfer_dma = hid->ctrlbuf_dma;
2060 hid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP);
2062 return hid;
2064 fail:
2066 if (hid->urbin)
2067 usb_free_urb(hid->urbin);
2068 if (hid->urbout)
2069 usb_free_urb(hid->urbout);
2070 if (hid->urbctrl)
2071 usb_free_urb(hid->urbctrl);
2072 hid_free_buffers(dev, hid);
2073 hid_free_device(hid);
2075 return NULL;
2078 static void hid_disconnect(struct usb_interface *intf)
2080 struct hid_device *hid = usb_get_intfdata (intf);
2082 if (!hid)
2083 return;
2085 spin_lock_irq(&hid->inlock); /* Sync with error handler */
2086 usb_set_intfdata(intf, NULL);
2087 spin_unlock_irq(&hid->inlock);
2088 usb_kill_urb(hid->urbin);
2089 usb_kill_urb(hid->urbout);
2090 usb_kill_urb(hid->urbctrl);
2092 del_timer_sync(&hid->io_retry);
2093 flush_scheduled_work();
2095 if (hid->claimed & HID_CLAIMED_INPUT)
2096 hidinput_disconnect(hid);
2097 if (hid->claimed & HID_CLAIMED_HIDDEV)
2098 hiddev_disconnect(hid);
2100 usb_free_urb(hid->urbin);
2101 usb_free_urb(hid->urbctrl);
2102 if (hid->urbout)
2103 usb_free_urb(hid->urbout);
2105 hid_free_buffers(hid->dev, hid);
2106 hid_free_device(hid);
2109 static int hid_probe(struct usb_interface *intf, const struct usb_device_id *id)
2111 struct hid_device *hid;
2112 char path[64];
2113 int i;
2114 char *c;
2116 dbg("HID probe called for ifnum %d",
2117 intf->altsetting->desc.bInterfaceNumber);
2119 if (!(hid = usb_hid_configure(intf)))
2120 return -ENODEV;
2122 hid_init_reports(hid);
2123 hid_dump_device(hid);
2125 if (!hidinput_connect(hid))
2126 hid->claimed |= HID_CLAIMED_INPUT;
2127 if (!hiddev_connect(hid))
2128 hid->claimed |= HID_CLAIMED_HIDDEV;
2130 usb_set_intfdata(intf, hid);
2132 if (!hid->claimed) {
2133 printk ("HID device not claimed by input or hiddev\n");
2134 hid_disconnect(intf);
2135 return -ENODEV;
2138 printk(KERN_INFO);
2140 if (hid->claimed & HID_CLAIMED_INPUT)
2141 printk("input");
2142 if (hid->claimed == (HID_CLAIMED_INPUT | HID_CLAIMED_HIDDEV))
2143 printk(",");
2144 if (hid->claimed & HID_CLAIMED_HIDDEV)
2145 printk("hiddev%d", hid->minor);
2147 c = "Device";
2148 for (i = 0; i < hid->maxcollection; i++) {
2149 if (hid->collection[i].type == HID_COLLECTION_APPLICATION &&
2150 (hid->collection[i].usage & HID_USAGE_PAGE) == HID_UP_GENDESK &&
2151 (hid->collection[i].usage & 0xffff) < ARRAY_SIZE(hid_types)) {
2152 c = hid_types[hid->collection[i].usage & 0xffff];
2153 break;
2157 usb_make_path(interface_to_usbdev(intf), path, 63);
2159 printk(": USB HID v%x.%02x %s [%s] on %s\n",
2160 hid->version >> 8, hid->version & 0xff, c, hid->name, path);
2162 return 0;
2165 static int hid_suspend(struct usb_interface *intf, pm_message_t message)
2167 struct hid_device *hid = usb_get_intfdata (intf);
2169 spin_lock_irq(&hid->inlock); /* Sync with error handler */
2170 set_bit(HID_SUSPENDED, &hid->iofl);
2171 spin_unlock_irq(&hid->inlock);
2172 del_timer(&hid->io_retry);
2173 usb_kill_urb(hid->urbin);
2174 dev_dbg(&intf->dev, "suspend\n");
2175 return 0;
2178 static int hid_resume(struct usb_interface *intf)
2180 struct hid_device *hid = usb_get_intfdata (intf);
2181 int status;
2183 clear_bit(HID_SUSPENDED, &hid->iofl);
2184 hid->retry_delay = 0;
2185 status = hid_start_in(hid);
2186 dev_dbg(&intf->dev, "resume status %d\n", status);
2187 return status;
2190 /* Treat USB reset pretty much the same as suspend/resume */
2191 static void hid_pre_reset(struct usb_interface *intf)
2193 /* FIXME: What if the interface is already suspended? */
2194 hid_suspend(intf, PMSG_ON);
2197 static void hid_post_reset(struct usb_interface *intf)
2199 struct usb_device *dev = interface_to_usbdev (intf);
2201 hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
2202 /* FIXME: Any more reinitialization needed? */
2204 hid_resume(intf);
2207 static struct usb_device_id hid_usb_ids [] = {
2208 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2209 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
2210 { } /* Terminating entry */
2213 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
2215 static struct usb_driver hid_driver = {
2216 .name = "usbhid",
2217 .probe = hid_probe,
2218 .disconnect = hid_disconnect,
2219 .suspend = hid_suspend,
2220 .resume = hid_resume,
2221 .pre_reset = hid_pre_reset,
2222 .post_reset = hid_post_reset,
2223 .id_table = hid_usb_ids,
2226 static int __init hid_init(void)
2228 int retval;
2229 retval = hiddev_init();
2230 if (retval)
2231 goto hiddev_init_fail;
2232 retval = usb_register(&hid_driver);
2233 if (retval)
2234 goto usb_register_fail;
2235 info(DRIVER_VERSION ":" DRIVER_DESC);
2237 return 0;
2238 usb_register_fail:
2239 hiddev_exit();
2240 hiddev_init_fail:
2241 return retval;
2244 static void __exit hid_exit(void)
2246 usb_deregister(&hid_driver);
2247 hiddev_exit();
2250 module_init(hid_init);
2251 module_exit(hid_exit);
2253 MODULE_AUTHOR(DRIVER_AUTHOR);
2254 MODULE_DESCRIPTION(DRIVER_DESC);
2255 MODULE_LICENSE(DRIVER_LICENSE);