2 * USB HID support for Linux
4 * Copyright (c) 1999 Andreas Gal
5 * Copyright (c) 2000-2001 Vojtech Pavlik <vojtech@suse.cz>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the Free
11 * Software Foundation; either version 2 of the License, or (at your option)
15 #include <linux/module.h>
16 #include <linux/slab.h>
17 #include <linux/init.h>
18 #include <linux/kernel.h>
19 #include <linux/sched.h>
20 #include <linux/list.h>
22 #include <linux/smp_lock.h>
23 #include <linux/spinlock.h>
24 #include <asm/unaligned.h>
25 #include <asm/byteorder.h>
26 #include <linux/input.h>
31 #include <linux/usb.h>
34 #include <linux/hiddev.h>
40 #define DRIVER_VERSION "v2.0"
41 #define DRIVER_AUTHOR "Andreas Gal, Vojtech Pavlik"
42 #define DRIVER_DESC "USB HID core driver"
43 #define DRIVER_LICENSE "GPL"
45 static char *hid_types[] = {"Device", "Pointer", "Mouse", "Device", "Joystick",
46 "Gamepad", "Keyboard", "Keypad", "Multi-Axis Controller"};
49 * Register a new report for a device.
52 static struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id)
54 struct hid_report_enum *report_enum = device->report_enum + type;
55 struct hid_report *report;
57 if (report_enum->report_id_hash[id])
58 return report_enum->report_id_hash[id];
60 if (!(report = kmalloc(sizeof(struct hid_report), GFP_KERNEL)))
62 memset(report, 0, sizeof(struct hid_report));
65 report_enum->numbered = 1;
70 report->device = device;
71 report_enum->report_id_hash[id] = report;
73 list_add_tail(&report->list, &report_enum->report_list);
79 * Register a new field for this report.
82 static struct hid_field *hid_register_field(struct hid_report *report, unsigned usages, unsigned values)
84 struct hid_field *field;
86 if (report->maxfield == HID_MAX_FIELDS) {
87 dbg("too many fields in report");
91 if (!(field = kmalloc(sizeof(struct hid_field) + usages * sizeof(struct hid_usage)
92 + values * sizeof(unsigned), GFP_KERNEL))) return NULL;
94 memset(field, 0, sizeof(struct hid_field) + usages * sizeof(struct hid_usage)
95 + values * sizeof(unsigned));
97 report->field[report->maxfield++] = field;
98 field->usage = (struct hid_usage *)(field + 1);
99 field->value = (unsigned *)(field->usage + usages);
100 field->report = report;
106 * Open a collection. The type/usage is pushed on the stack.
109 static int open_collection(struct hid_parser *parser, unsigned type)
111 struct hid_collection *collection;
114 usage = parser->local.usage[0];
116 if (parser->collection_stack_ptr == HID_COLLECTION_STACK_SIZE) {
117 dbg("collection stack overflow");
121 if (parser->device->maxcollection == parser->device->collection_size) {
122 collection = kmalloc(sizeof(struct hid_collection) *
123 parser->device->collection_size * 2,
125 if (collection == NULL) {
126 dbg("failed to reallocate collection array");
129 memcpy(collection, parser->device->collection,
130 sizeof(struct hid_collection) *
131 parser->device->collection_size);
132 memset(collection + parser->device->collection_size, 0,
133 sizeof(struct hid_collection) *
134 parser->device->collection_size);
135 kfree(parser->device->collection);
136 parser->device->collection = collection;
137 parser->device->collection_size *= 2;
140 parser->collection_stack[parser->collection_stack_ptr++] =
141 parser->device->maxcollection;
143 collection = parser->device->collection +
144 parser->device->maxcollection++;
145 collection->type = type;
146 collection->usage = usage;
147 collection->level = parser->collection_stack_ptr - 1;
149 if (type == HID_COLLECTION_APPLICATION)
150 parser->device->maxapplication++;
156 * Close a collection.
159 static int close_collection(struct hid_parser *parser)
161 if (!parser->collection_stack_ptr) {
162 dbg("collection stack underflow");
165 parser->collection_stack_ptr--;
170 * Climb up the stack, search for the specified collection type
171 * and return the usage.
174 static unsigned hid_lookup_collection(struct hid_parser *parser, unsigned type)
177 for (n = parser->collection_stack_ptr - 1; n >= 0; n--)
178 if (parser->device->collection[parser->collection_stack[n]].type == type)
179 return parser->device->collection[parser->collection_stack[n]].usage;
180 return 0; /* we know nothing about this usage type */
184 * Add a usage to the temporary parser table.
187 static int hid_add_usage(struct hid_parser *parser, unsigned usage)
189 if (parser->local.usage_index >= HID_MAX_USAGES) {
190 dbg("usage index exceeded");
193 parser->local.usage[parser->local.usage_index] = usage;
194 parser->local.collection_index[parser->local.usage_index] =
195 parser->collection_stack_ptr ?
196 parser->collection_stack[parser->collection_stack_ptr - 1] : 0;
197 parser->local.usage_index++;
202 * Register a new field for this report.
205 static int hid_add_field(struct hid_parser *parser, unsigned report_type, unsigned flags)
207 struct hid_report *report;
208 struct hid_field *field;
213 if (!(report = hid_register_report(parser->device, report_type, parser->global.report_id))) {
214 dbg("hid_register_report failed");
218 if (parser->global.logical_maximum < parser->global.logical_minimum) {
219 dbg("logical range invalid %d %d", parser->global.logical_minimum, parser->global.logical_maximum);
222 usages = parser->local.usage_index;
224 offset = report->size;
225 report->size += parser->global.report_size * parser->global.report_count;
227 if (usages < parser->global.report_count)
228 usages = parser->global.report_count;
231 return 0; /* ignore padding fields */
233 if ((field = hid_register_field(report, usages, parser->global.report_count)) == NULL)
236 field->physical = hid_lookup_collection(parser, HID_COLLECTION_PHYSICAL);
237 field->logical = hid_lookup_collection(parser, HID_COLLECTION_LOGICAL);
238 field->application = hid_lookup_collection(parser, HID_COLLECTION_APPLICATION);
240 for (i = 0; i < usages; i++) {
242 /* Duplicate the last usage we parsed if we have excess values */
243 if (i >= parser->local.usage_index)
244 j = parser->local.usage_index - 1;
245 field->usage[i].hid = parser->local.usage[j];
246 field->usage[i].collection_index =
247 parser->local.collection_index[j];
250 field->maxusage = usages;
251 field->flags = flags;
252 field->report_offset = offset;
253 field->report_type = report_type;
254 field->report_size = parser->global.report_size;
255 field->report_count = parser->global.report_count;
256 field->logical_minimum = parser->global.logical_minimum;
257 field->logical_maximum = parser->global.logical_maximum;
258 field->physical_minimum = parser->global.physical_minimum;
259 field->physical_maximum = parser->global.physical_maximum;
260 field->unit_exponent = parser->global.unit_exponent;
261 field->unit = parser->global.unit;
267 * Read data value from item.
270 static __inline__ __u32 item_udata(struct hid_item *item)
272 switch (item->size) {
273 case 1: return item->data.u8;
274 case 2: return item->data.u16;
275 case 4: return item->data.u32;
280 static __inline__ __s32 item_sdata(struct hid_item *item)
282 switch (item->size) {
283 case 1: return item->data.s8;
284 case 2: return item->data.s16;
285 case 4: return item->data.s32;
291 * Process a global item.
294 static int hid_parser_global(struct hid_parser *parser, struct hid_item *item)
298 case HID_GLOBAL_ITEM_TAG_PUSH:
300 if (parser->global_stack_ptr == HID_GLOBAL_STACK_SIZE) {
301 dbg("global enviroment stack overflow");
305 memcpy(parser->global_stack + parser->global_stack_ptr++,
306 &parser->global, sizeof(struct hid_global));
309 case HID_GLOBAL_ITEM_TAG_POP:
311 if (!parser->global_stack_ptr) {
312 dbg("global enviroment stack underflow");
316 memcpy(&parser->global, parser->global_stack + --parser->global_stack_ptr,
317 sizeof(struct hid_global));
320 case HID_GLOBAL_ITEM_TAG_USAGE_PAGE:
321 parser->global.usage_page = item_udata(item);
324 case HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM:
325 parser->global.logical_minimum = item_sdata(item);
328 case HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM:
329 if (parser->global.logical_minimum < 0)
330 parser->global.logical_maximum = item_sdata(item);
332 parser->global.logical_maximum = item_udata(item);
335 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM:
336 parser->global.physical_minimum = item_sdata(item);
339 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM:
340 if (parser->global.physical_minimum < 0)
341 parser->global.physical_maximum = item_sdata(item);
343 parser->global.physical_maximum = item_udata(item);
346 case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT:
347 parser->global.unit_exponent = item_sdata(item);
350 case HID_GLOBAL_ITEM_TAG_UNIT:
351 parser->global.unit = item_udata(item);
354 case HID_GLOBAL_ITEM_TAG_REPORT_SIZE:
355 if ((parser->global.report_size = item_udata(item)) > 32) {
356 dbg("invalid report_size %d", parser->global.report_size);
361 case HID_GLOBAL_ITEM_TAG_REPORT_COUNT:
362 if ((parser->global.report_count = item_udata(item)) > HID_MAX_USAGES) {
363 dbg("invalid report_count %d", parser->global.report_count);
368 case HID_GLOBAL_ITEM_TAG_REPORT_ID:
369 if ((parser->global.report_id = item_udata(item)) == 0) {
370 dbg("report_id 0 is invalid");
376 dbg("unknown global tag 0x%x", item->tag);
382 * Process a local item.
385 static int hid_parser_local(struct hid_parser *parser, struct hid_item *item)
390 if (item->size == 0) {
391 dbg("item data expected for local item");
395 data = item_udata(item);
399 case HID_LOCAL_ITEM_TAG_DELIMITER:
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.
408 if (parser->local.delimiter_depth != 0) {
409 dbg("nested delimiters");
412 parser->local.delimiter_depth++;
413 parser->local.delimiter_branch++;
415 if (parser->local.delimiter_depth < 1) {
416 dbg("bogus close delimiter");
419 parser->local.delimiter_depth--;
423 case HID_LOCAL_ITEM_TAG_USAGE:
425 if (parser->local.delimiter_branch > 1) {
426 dbg("alternative usage ignored");
431 data = (parser->global.usage_page << 16) + data;
433 return hid_add_usage(parser, data);
435 case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:
437 if (parser->local.delimiter_branch > 1) {
438 dbg("alternative usage ignored");
443 data = (parser->global.usage_page << 16) + data;
445 parser->local.usage_minimum = data;
448 case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:
450 if (parser->local.delimiter_branch > 1) {
451 dbg("alternative usage ignored");
456 data = (parser->global.usage_page << 16) + data;
458 for (n = parser->local.usage_minimum; n <= data; n++)
459 if (hid_add_usage(parser, n)) {
460 dbg("hid_add_usage failed\n");
467 dbg("unknown local item tag 0x%x", item->tag);
474 * Process a main item.
477 static int hid_parser_main(struct hid_parser *parser, struct hid_item *item)
482 data = item_udata(item);
485 case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION:
486 ret = open_collection(parser, data & 0xff);
488 case HID_MAIN_ITEM_TAG_END_COLLECTION:
489 ret = close_collection(parser);
491 case HID_MAIN_ITEM_TAG_INPUT:
492 ret = hid_add_field(parser, HID_INPUT_REPORT, data);
494 case HID_MAIN_ITEM_TAG_OUTPUT:
495 ret = hid_add_field(parser, HID_OUTPUT_REPORT, data);
497 case HID_MAIN_ITEM_TAG_FEATURE:
498 ret = hid_add_field(parser, HID_FEATURE_REPORT, data);
501 dbg("unknown main item tag 0x%x", item->tag);
505 memset(&parser->local, 0, sizeof(parser->local)); /* Reset the local parser environment */
511 * Process a reserved item.
514 static int hid_parser_reserved(struct hid_parser *parser, struct hid_item *item)
516 dbg("reserved item type, tag 0x%x", item->tag);
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.
526 static void hid_free_report(struct hid_report *report)
530 for (n = 0; n < report->maxfield; n++)
531 kfree(report->field[n]);
536 * Free a device structure, all reports, and all fields.
539 static void hid_free_device(struct hid_device *device)
545 for (i = 0; i < HID_REPORT_TYPES; i++) {
546 struct hid_report_enum *report_enum = device->report_enum + i;
548 for (j = 0; j < 256; j++) {
549 struct hid_report *report = report_enum->report_id_hash[j];
551 hid_free_report(report);
556 kfree(device->rdesc);
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)
569 if ((end - start) <= 0)
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)
584 item->size = *start++;
585 item->tag = *start++;
587 if ((end - start) < item->size)
590 item->data.longdata = start;
595 item->format = HID_ITEM_FORMAT_SHORT;
598 switch (item->size) {
604 if ((end - start) < 1)
606 item->data.u8 = *start++;
610 if ((end - start) < 2)
612 item->data.u16 = le16_to_cpu(get_unaligned((__u16*)start));
613 start = (__u8 *)((__u16 *)start + 1);
618 if ((end - start) < 4)
620 item->data.u32 = le32_to_cpu(get_unaligned((__u32*)start));
621 start = (__u8 *)((__u32 *)start + 1);
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;
640 static int (*dispatch_type[])(struct hid_parser *parser,
641 struct hid_item *item) = {
648 if (!(device = kmalloc(sizeof(struct hid_device), GFP_KERNEL)))
650 memset(device, 0, sizeof(struct hid_device));
652 if (!(device->collection =kmalloc(sizeof(struct hid_collection) *
653 HID_DEFAULT_NUM_COLLECTIONS, GFP_KERNEL))) {
657 memset(device->collection, 0, sizeof(struct hid_collection) *
658 HID_DEFAULT_NUM_COLLECTIONS);
659 device->collection_size = HID_DEFAULT_NUM_COLLECTIONS;
661 for (i = 0; i < HID_REPORT_TYPES; i++)
662 INIT_LIST_HEAD(&device->report_enum[i].report_list);
664 if (!(device->rdesc = (__u8 *)kmalloc(size, GFP_KERNEL))) {
665 kfree(device->collection);
669 memcpy(device->rdesc, start, size);
670 device->rsize = size;
672 if (!(parser = kmalloc(sizeof(struct hid_parser), GFP_KERNEL))) {
673 kfree(device->rdesc);
674 kfree(device->collection);
678 memset(parser, 0, sizeof(struct hid_parser));
679 parser->device = device;
682 while ((start = fetch_item(start, end, &item)) != 0) {
684 if (item.format != HID_ITEM_FORMAT_SHORT) {
685 dbg("unexpected long global item");
686 kfree(device->collection);
687 hid_free_device(device);
692 if (dispatch_type[item.type](parser, &item)) {
693 dbg("item %u %u %u %u parsing failed\n",
694 item.format, (unsigned)item.size, (unsigned)item.type, (unsigned)item.tag);
695 kfree(device->collection);
696 hid_free_device(device);
702 if (parser->collection_stack_ptr) {
703 dbg("unbalanced collection at end of report description");
704 kfree(device->collection);
705 hid_free_device(device);
709 if (parser->local.delimiter_depth) {
710 dbg("unbalanced delimiter at end of report description");
711 kfree(device->collection);
712 hid_free_device(device);
721 dbg("item fetching failed at offset %d\n", (int)(end - start));
722 kfree(device->collection);
723 hid_free_device(device);
729 * Convert a signed n-bit integer to signed 32-bit integer. Common
730 * cases are done through the compiler, the screwed things has to be
734 static __inline__ __s32 snto32(__u32 value, unsigned n)
737 case 8: return ((__s8)value);
738 case 16: return ((__s16)value);
739 case 32: return ((__s32)value);
741 return value & (1 << (n - 1)) ? value | (-1 << n) : value;
745 * Convert a signed 32-bit integer to a signed n-bit integer.
748 static __inline__ __u32 s32ton(__s32 value, unsigned n)
750 __s32 a = value >> (n - 1);
752 return value < 0 ? 1 << (n - 1) : (1 << (n - 1)) - 1;
753 return value & ((1 << n) - 1);
757 * Extract/implement a data field from/to a report.
760 static __inline__ __u32 extract(__u8 *report, unsigned offset, unsigned n)
762 report += (offset >> 5) << 2; offset &= 31;
763 return (le64_to_cpu(get_unaligned((__u64*)report)) >> offset) & ((1 << n) - 1);
766 static __inline__ void implement(__u8 *report, unsigned offset, unsigned n, __u32 value)
768 report += (offset >> 5) << 2; offset &= 31;
769 put_unaligned((get_unaligned((__u64*)report)
770 & cpu_to_le64(~((((__u64) 1 << n) - 1) << offset)))
771 | cpu_to_le64((__u64)value << offset), (__u64*)report);
775 * Search an array for a value.
778 static __inline__ int search(__s32 *array, __s32 value, unsigned n)
781 if (*array++ == value)
787 static void hid_process_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value, struct pt_regs *regs)
789 hid_dump_input(usage, value);
790 if (hid->claimed & HID_CLAIMED_INPUT)
791 hidinput_hid_event(hid, field, usage, value, regs);
792 if (hid->claimed & HID_CLAIMED_HIDDEV)
793 hiddev_hid_event(hid, field, usage, value, regs);
797 * Analyse a received field, and fetch the data from it. The field
798 * content is stored for next report processing (we do differential
799 * reporting to the layer).
802 static void hid_input_field(struct hid_device *hid, struct hid_field *field, __u8 *data, struct pt_regs *regs)
805 unsigned count = field->report_count;
806 unsigned offset = field->report_offset;
807 unsigned size = field->report_size;
808 __s32 min = field->logical_minimum;
809 __s32 max = field->logical_maximum;
812 value = kmalloc(sizeof(__s32)*count, GFP_ATOMIC);
816 for (n = 0; n < count; n++) {
818 value[n] = min < 0 ? snto32(extract(data, offset + n * size, size), size) :
819 extract(data, offset + n * size, size);
821 if (!(field->flags & HID_MAIN_ITEM_VARIABLE) /* Ignore report if ErrorRollOver */
822 && value[n] >= min && value[n] <= max
823 && field->usage[value[n] - min].hid == HID_UP_KEYBOARD + 1)
827 for (n = 0; n < count; n++) {
829 if (HID_MAIN_ITEM_VARIABLE & field->flags) {
831 if (field->flags & HID_MAIN_ITEM_RELATIVE) {
835 if (value[n] == field->value[n])
838 hid_process_event(hid, field, &field->usage[n], value[n], regs);
842 if (field->value[n] >= min && field->value[n] <= max
843 && field->usage[field->value[n] - min].hid
844 && search(value, field->value[n], count))
845 hid_process_event(hid, field, &field->usage[field->value[n] - min], 0, regs);
847 if (value[n] >= min && value[n] <= max
848 && field->usage[value[n] - min].hid
849 && search(field->value, value[n], count))
850 hid_process_event(hid, field, &field->usage[value[n] - min], 1, regs);
853 memcpy(field->value, value, count * sizeof(__s32));
858 static int hid_input_report(int type, struct urb *urb, struct pt_regs *regs)
860 struct hid_device *hid = urb->context;
861 struct hid_report_enum *report_enum = hid->report_enum + type;
862 u8 *data = urb->transfer_buffer;
863 int len = urb->actual_length;
864 struct hid_report *report;
873 printk(KERN_DEBUG __FILE__ ": report (size %u) (%snumbered)\n", len, report_enum->numbered ? "" : "un");
876 n = 0; /* Normally report number is 0 */
877 if (report_enum->numbered) { /* Device uses numbered reports, data[0] is report number */
885 printk(KERN_DEBUG __FILE__ ": report %d (size %u) = ", n, len);
886 for (i = 0; i < len; i++)
887 printk(" %02x", data[i]);
892 if (!(report = report_enum->report_id_hash[n])) {
893 dbg("undefined report_id %d received", n);
897 size = ((report->size - 1) >> 3) + 1;
900 dbg("report %d is too short, (%d < %d)", report->id, len, size);
904 if (hid->claimed & HID_CLAIMED_HIDDEV)
905 hiddev_report_event(hid, report);
907 for (n = 0; n < report->maxfield; n++)
908 hid_input_field(hid, report->field[n], data, regs);
910 if (hid->claimed & HID_CLAIMED_INPUT)
911 hidinput_report_event(hid, report);
917 * Input interrupt completion handler.
920 static void hid_irq_in(struct urb *urb, struct pt_regs *regs)
922 struct hid_device *hid = urb->context;
925 switch (urb->status) {
926 case 0: /* success */
927 hid_input_report(HID_INPUT_REPORT, urb, regs);
929 case -ECONNRESET: /* unlink */
934 dbg("nonzero status in input irq %d", urb->status);
937 status = usb_submit_urb (urb, SLAB_ATOMIC);
939 err ("can't resubmit intr, %s-%s/input%d, status %d",
940 hid->dev->bus->bus_name, hid->dev->devpath,
945 * Output the field into the report.
948 static void hid_output_field(struct hid_field *field, __u8 *data)
950 unsigned count = field->report_count;
951 unsigned offset = field->report_offset;
952 unsigned size = field->report_size;
955 for (n = 0; n < count; n++) {
956 if (field->logical_minimum < 0) /* signed values */
957 implement(data, offset + n * size, size, s32ton(field->value[n], size));
958 else /* unsigned values */
959 implement(data, offset + n * size, size, field->value[n]);
967 static void hid_output_report(struct hid_report *report, __u8 *data)
972 *data++ = report->id;
974 for (n = 0; n < report->maxfield; n++)
975 hid_output_field(report->field[n], data);
979 * Set a field value. The report this field belongs to has to be
980 * created and transferred to the device, to set this value in the
984 int hid_set_field(struct hid_field *field, unsigned offset, __s32 value)
986 unsigned size = field->report_size;
988 hid_dump_input(field->usage + offset, value);
990 if (offset >= field->report_count) {
991 dbg("offset (%d) exceeds report_count (%d)", offset, field->report_count);
992 hid_dump_field(field, 8);
995 if (field->logical_minimum < 0) {
996 if (value != snto32(s32ton(value, size), size)) {
997 dbg("value %d is out of range", value);
1001 field->value[offset] = value;
1005 int hid_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field)
1007 struct hid_report_enum *report_enum = hid->report_enum + HID_OUTPUT_REPORT;
1008 struct list_head *list = report_enum->report_list.next;
1011 while (list != &report_enum->report_list) {
1012 struct hid_report *report = (struct hid_report *) list;
1014 for (i = 0; i < report->maxfield; i++) {
1015 *field = report->field[i];
1016 for (j = 0; j < (*field)->maxusage; j++)
1017 if ((*field)->usage[j].type == type && (*field)->usage[j].code == code)
1025 * Find a report with a specified HID usage.
1028 int hid_find_report_by_usage(struct hid_device *hid, __u32 wanted_usage, struct hid_report **report, int type)
1030 struct hid_report_enum *report_enum = hid->report_enum + type;
1031 struct list_head *list = report_enum->report_list.next;
1034 while (list != &report_enum->report_list) {
1035 *report = (struct hid_report *) list;
1037 for (i = 0; i < (*report)->maxfield; i++) {
1038 struct hid_field *field = (*report)->field[i];
1039 for (j = 0; j < field->maxusage; j++)
1040 if (field->logical == wanted_usage)
1048 static int hid_find_field_in_report(struct hid_report *report, __u32 wanted_usage, struct hid_field **field)
1052 for (i = 0; i < report->maxfield; i++) {
1053 *field = report->field[i];
1054 for (j = 0; j < (*field)->maxusage; j++)
1055 if ((*field)->usage[j].hid == wanted_usage)
1063 static int hid_submit_out(struct hid_device *hid)
1065 struct hid_report *report;
1067 report = hid->out[hid->outtail];
1069 hid_output_report(report, hid->outbuf);
1070 hid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
1071 hid->urbout->dev = hid->dev;
1073 dbg("submitting out urb");
1075 if (usb_submit_urb(hid->urbout, GFP_ATOMIC)) {
1076 err("usb_submit_urb(out) failed");
1083 static int hid_submit_ctrl(struct hid_device *hid)
1085 struct hid_report *report;
1089 report = hid->ctrl[hid->ctrltail].report;
1090 dir = hid->ctrl[hid->ctrltail].dir;
1092 len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
1093 if (dir == USB_DIR_OUT) {
1094 hid_output_report(report, hid->ctrlbuf);
1095 hid->urbctrl->pipe = usb_sndctrlpipe(hid->dev, 0);
1096 hid->urbctrl->transfer_buffer_length = len;
1098 int maxpacket, padlen;
1100 hid->urbctrl->pipe = usb_rcvctrlpipe(hid->dev, 0);
1101 maxpacket = usb_maxpacket(hid->dev, hid->urbctrl->pipe, 0);
1102 if (maxpacket > 0) {
1103 padlen = (len + maxpacket - 1) / maxpacket;
1104 padlen *= maxpacket;
1105 if (padlen > HID_BUFFER_SIZE)
1106 padlen = HID_BUFFER_SIZE;
1109 hid->urbctrl->transfer_buffer_length = padlen;
1111 hid->urbctrl->dev = hid->dev;
1113 hid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
1114 hid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
1115 hid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
1116 hid->cr->wIndex = cpu_to_le16(hid->ifnum);
1117 hid->cr->wLength = cpu_to_le16(len);
1119 dbg("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u",
1120 hid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
1121 hid->cr->wValue, hid->cr->wIndex, hid->cr->wLength);
1123 if (usb_submit_urb(hid->urbctrl, GFP_ATOMIC)) {
1124 err("usb_submit_urb(ctrl) failed");
1132 * Output interrupt completion handler.
1135 static void hid_irq_out(struct urb *urb, struct pt_regs *regs)
1137 struct hid_device *hid = urb->context;
1138 unsigned long flags;
1141 warn("output irq status %d received", urb->status);
1143 spin_lock_irqsave(&hid->outlock, flags);
1145 hid->outtail = (hid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
1147 if (hid->outhead != hid->outtail) {
1148 hid_submit_out(hid);
1149 spin_unlock_irqrestore(&hid->outlock, flags);
1153 clear_bit(HID_OUT_RUNNING, &hid->iofl);
1155 spin_unlock_irqrestore(&hid->outlock, flags);
1157 wake_up(&hid->wait);
1161 * Control pipe completion handler.
1164 static void hid_ctrl(struct urb *urb, struct pt_regs *regs)
1166 struct hid_device *hid = urb->context;
1167 unsigned long flags;
1170 warn("ctrl urb status %d received", urb->status);
1172 spin_lock_irqsave(&hid->ctrllock, flags);
1174 if (hid->ctrl[hid->ctrltail].dir == USB_DIR_IN)
1175 hid_input_report(hid->ctrl[hid->ctrltail].report->type, urb, regs);
1177 hid->ctrltail = (hid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
1179 if (hid->ctrlhead != hid->ctrltail) {
1180 hid_submit_ctrl(hid);
1181 spin_unlock_irqrestore(&hid->ctrllock, flags);
1185 clear_bit(HID_CTRL_RUNNING, &hid->iofl);
1187 spin_unlock_irqrestore(&hid->ctrllock, flags);
1189 wake_up(&hid->wait);
1192 void hid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
1195 unsigned long flags;
1197 if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
1200 if (hid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
1202 spin_lock_irqsave(&hid->outlock, flags);
1204 if ((head = (hid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == hid->outtail) {
1205 spin_unlock_irqrestore(&hid->outlock, flags);
1206 warn("output queue full");
1210 hid->out[hid->outhead] = report;
1211 hid->outhead = head;
1213 if (!test_and_set_bit(HID_OUT_RUNNING, &hid->iofl))
1214 hid_submit_out(hid);
1216 spin_unlock_irqrestore(&hid->outlock, flags);
1220 spin_lock_irqsave(&hid->ctrllock, flags);
1222 if ((head = (hid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == hid->ctrltail) {
1223 spin_unlock_irqrestore(&hid->ctrllock, flags);
1224 warn("control queue full");
1228 hid->ctrl[hid->ctrlhead].report = report;
1229 hid->ctrl[hid->ctrlhead].dir = dir;
1230 hid->ctrlhead = head;
1232 if (!test_and_set_bit(HID_CTRL_RUNNING, &hid->iofl))
1233 hid_submit_ctrl(hid);
1235 spin_unlock_irqrestore(&hid->ctrllock, flags);
1238 int hid_wait_io(struct hid_device *hid)
1240 DECLARE_WAITQUEUE(wait, current);
1241 int timeout = 10*HZ;
1243 set_current_state(TASK_UNINTERRUPTIBLE);
1244 add_wait_queue(&hid->wait, &wait);
1246 while (timeout && (test_bit(HID_CTRL_RUNNING, &hid->iofl) ||
1247 test_bit(HID_OUT_RUNNING, &hid->iofl)))
1248 timeout = schedule_timeout(timeout);
1250 set_current_state(TASK_RUNNING);
1251 remove_wait_queue(&hid->wait, &wait);
1254 dbg("timeout waiting for ctrl or out queue to clear");
1261 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
1262 unsigned char type, void *buf, int size)
1264 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
1265 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
1266 (type << 8), ifnum, buf, size, HZ * USB_CTRL_GET_TIMEOUT);
1269 int hid_open(struct hid_device *hid)
1274 hid->urbin->dev = hid->dev;
1276 if (usb_submit_urb(hid->urbin, GFP_KERNEL))
1282 void hid_close(struct hid_device *hid)
1285 usb_unlink_urb(hid->urbin);
1289 * Initialize all reports
1292 void hid_init_reports(struct hid_device *hid)
1294 struct hid_report_enum *report_enum;
1295 struct hid_report *report;
1296 struct list_head *list;
1300 * The Set_Idle request is supposed to affect only the
1301 * "Interrupt In" pipe. Unfortunately, buggy devices such as
1302 * the BTC keyboard (ID 046e:5303) the request also affects
1303 * Get_Report requests on the control pipe. In the worst
1304 * case, if the device was put on idle for an indefinite
1305 * amount of time (as we do below) and there are no input
1306 * events to report, the Get_Report requests will just hang
1307 * until we get a USB timeout. To avoid this, we temporarily
1308 * establish a minimal idle time of 1ms. This shouldn't hurt
1309 * bugfree devices and will cause a worst-case extra delay of
1310 * 1ms for buggy ones.
1312 usb_control_msg(hid->dev, usb_sndctrlpipe(hid->dev, 0),
1313 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (1 << 8),
1314 hid->ifnum, NULL, 0, HZ * USB_CTRL_SET_TIMEOUT);
1316 report_enum = hid->report_enum + HID_INPUT_REPORT;
1317 list = report_enum->report_list.next;
1318 while (list != &report_enum->report_list) {
1319 report = (struct hid_report *) list;
1320 hid_submit_report(hid, report, USB_DIR_IN);
1324 report_enum = hid->report_enum + HID_FEATURE_REPORT;
1325 list = report_enum->report_list.next;
1326 while (list != &report_enum->report_list) {
1327 report = (struct hid_report *) list;
1328 hid_submit_report(hid, report, USB_DIR_IN);
1333 ret = hid_wait_io(hid);
1336 if (test_bit(HID_CTRL_RUNNING, &hid->iofl))
1337 usb_unlink_urb(hid->urbctrl);
1338 if (test_bit(HID_OUT_RUNNING, &hid->iofl))
1339 usb_unlink_urb(hid->urbout);
1340 ret = hid_wait_io(hid);
1344 warn("timeout initializing reports\n");
1346 report_enum = hid->report_enum + HID_INPUT_REPORT;
1347 list = report_enum->report_list.next;
1348 while (list != &report_enum->report_list) {
1349 report = (struct hid_report *) list;
1350 usb_control_msg(hid->dev, usb_sndctrlpipe(hid->dev, 0),
1351 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, report->id,
1352 hid->ifnum, NULL, 0, HZ * USB_CTRL_SET_TIMEOUT);
1357 #define USB_VENDOR_ID_WACOM 0x056a
1358 #define USB_DEVICE_ID_WACOM_PENPARTNER 0x0000
1359 #define USB_DEVICE_ID_WACOM_GRAPHIRE 0x0010
1360 #define USB_DEVICE_ID_WACOM_INTUOS 0x0020
1361 #define USB_DEVICE_ID_WACOM_PL 0x0030
1362 #define USB_DEVICE_ID_WACOM_INTUOS2 0x0040
1363 #define USB_DEVICE_ID_WACOM_VOLITO 0x0060
1364 #define USB_DEVICE_ID_WACOM_PTU 0x0003
1366 #define USB_VENDOR_ID_KBGEAR 0x084e
1367 #define USB_DEVICE_ID_KBGEAR_JAMSTUDIO 0x1001
1369 #define USB_VENDOR_ID_AIPTEK 0x08ca
1370 #define USB_DEVICE_ID_AIPTEK_01 0x0001
1371 #define USB_DEVICE_ID_AIPTEK_10 0x0010
1372 #define USB_DEVICE_ID_AIPTEK_20 0x0020
1373 #define USB_DEVICE_ID_AIPTEK_21 0x0021
1374 #define USB_DEVICE_ID_AIPTEK_22 0x0022
1375 #define USB_DEVICE_ID_AIPTEK_23 0x0023
1376 #define USB_DEVICE_ID_AIPTEK_24 0x0024
1378 #define USB_VENDOR_ID_GRIFFIN 0x077d
1379 #define USB_DEVICE_ID_POWERMATE 0x0410
1380 #define USB_DEVICE_ID_SOUNDKNOB 0x04AA
1382 #define USB_VENDOR_ID_ATEN 0x0557
1383 #define USB_DEVICE_ID_ATEN_UC100KM 0x2004
1384 #define USB_DEVICE_ID_ATEN_CS124U 0x2202
1385 #define USB_DEVICE_ID_ATEN_2PORTKVM 0x2204
1386 #define USB_DEVICE_ID_ATEN_4PORTKVM 0x2205
1387 #define USB_DEVICE_ID_ATEN_4PORTKVMC 0x2208
1389 #define USB_VENDOR_ID_TOPMAX 0x0663
1390 #define USB_DEVICE_ID_TOPMAX_COBRAPAD 0x0103
1392 #define USB_VENDOR_ID_HAPP 0x078b
1393 #define USB_DEVICE_ID_UGCI_DRIVING 0x0010
1394 #define USB_DEVICE_ID_UGCI_FLYING 0x0020
1395 #define USB_DEVICE_ID_UGCI_FIGHTING 0x0030
1397 #define USB_VENDOR_ID_MGE 0x0463
1398 #define USB_DEVICE_ID_MGE_UPS 0xffff
1399 #define USB_DEVICE_ID_MGE_UPS1 0x0001
1401 #define USB_VENDOR_ID_ONTRAK 0x0a07
1402 #define USB_DEVICE_ID_ONTRAK_ADU100 0x0064
1404 #define USB_VENDOR_ID_TANGTOP 0x0d3d
1405 #define USB_DEVICE_ID_TANGTOP_USBPS2 0x0001
1407 #define USB_VENDOR_ID_ESSENTIAL_REALITY 0x0d7f
1408 #define USB_DEVICE_ID_ESSENTIAL_REALITY_P5 0x0100
1410 #define USB_VENDOR_ID_A4TECH 0x09DA
1411 #define USB_DEVICE_ID_A4TECH_WCP32PU 0x0006
1413 #define USB_VENDOR_ID_CYPRESS 0x04b4
1414 #define USB_DEVICE_ID_CYPRESS_MOUSE 0x0001
1416 #define USB_VENDOR_ID_BERKSHIRE 0x0c98
1417 #define USB_DEVICE_ID_BERKSHIRE_PCWD 0x1140
1419 #define USB_VENDOR_ID_ALPS 0x0433
1420 #define USB_DEVICE_ID_IBM_GAMEPAD 0x1101
1422 #define USB_VENDOR_ID_SAITEK 0x06a3
1423 #define USB_DEVICE_ID_SAITEK_RUMBLEPAD 0xff17
1425 #define USB_VENDOR_ID_NEC 0x073e
1426 #define USB_DEVICE_ID_NEC_USB_GAME_PAD 0x0301
1428 #define USB_VENDOR_ID_CHIC 0x05fe
1429 #define USB_DEVICE_ID_CHIC_GAMEPAD 0x0014
1431 #define USB_VENDOR_ID_GLAB 0x06c2
1432 #define USB_DEVICE_ID_4_PHIDGETSERVO_30 0x0038
1433 #define USB_DEVICE_ID_1_PHIDGETSERVO_30 0x0039
1434 #define USB_DEVICE_ID_8_8_8_IF_KIT 0x0045
1435 #define USB_DEVICE_ID_0_0_4_IF_KIT 0x0040
1436 #define USB_DEVICE_ID_0_8_8_IF_KIT 0x0053
1438 #define USB_VENDOR_ID_WISEGROUP 0x0925
1439 #define USB_DEVICE_ID_1_PHIDGETSERVO_20 0x8101
1440 #define USB_DEVICE_ID_4_PHIDGETSERVO_20 0x8104
1442 static struct hid_blacklist {
1446 } hid_blacklist[] = {
1448 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_01, HID_QUIRK_IGNORE },
1449 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_10, HID_QUIRK_IGNORE },
1450 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_20, HID_QUIRK_IGNORE },
1451 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_21, HID_QUIRK_IGNORE },
1452 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_22, HID_QUIRK_IGNORE },
1453 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_23, HID_QUIRK_IGNORE },
1454 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_24, HID_QUIRK_IGNORE },
1455 { USB_VENDOR_ID_BERKSHIRE, USB_DEVICE_ID_BERKSHIRE_PCWD, HID_QUIRK_IGNORE },
1456 { USB_VENDOR_ID_ESSENTIAL_REALITY, USB_DEVICE_ID_ESSENTIAL_REALITY_P5, HID_QUIRK_IGNORE },
1457 { USB_VENDOR_ID_KBGEAR, USB_DEVICE_ID_KBGEAR_JAMSTUDIO, HID_QUIRK_IGNORE },
1458 { USB_VENDOR_ID_GRIFFIN, USB_DEVICE_ID_POWERMATE, HID_QUIRK_IGNORE },
1459 { USB_VENDOR_ID_GRIFFIN, USB_DEVICE_ID_SOUNDKNOB, HID_QUIRK_IGNORE },
1460 { USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS, HID_QUIRK_IGNORE },
1461 { USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS1, HID_QUIRK_IGNORE },
1463 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100, HID_QUIRK_IGNORE },
1464 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 100, HID_QUIRK_IGNORE },
1465 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 200, HID_QUIRK_IGNORE },
1466 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 300, HID_QUIRK_IGNORE },
1467 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 400, HID_QUIRK_IGNORE },
1468 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 500, HID_QUIRK_IGNORE },
1470 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PENPARTNER, HID_QUIRK_IGNORE },
1471 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE, HID_QUIRK_IGNORE },
1472 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE + 1, HID_QUIRK_IGNORE },
1473 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE + 2, HID_QUIRK_IGNORE },
1474 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE + 3, HID_QUIRK_IGNORE },
1475 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE + 4, HID_QUIRK_IGNORE },
1476 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS, HID_QUIRK_IGNORE },
1477 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS + 1, HID_QUIRK_IGNORE },
1478 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS + 2, HID_QUIRK_IGNORE },
1479 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS + 3, HID_QUIRK_IGNORE },
1480 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS + 4, HID_QUIRK_IGNORE },
1481 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL, HID_QUIRK_IGNORE },
1482 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 1, HID_QUIRK_IGNORE },
1483 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 2, HID_QUIRK_IGNORE },
1484 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 3, HID_QUIRK_IGNORE },
1485 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 4, HID_QUIRK_IGNORE },
1486 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 5, HID_QUIRK_IGNORE },
1487 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 1, HID_QUIRK_IGNORE },
1488 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 2, HID_QUIRK_IGNORE },
1489 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 3, HID_QUIRK_IGNORE },
1490 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 4, HID_QUIRK_IGNORE },
1491 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 5, HID_QUIRK_IGNORE },
1492 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 7, HID_QUIRK_IGNORE },
1493 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_VOLITO, HID_QUIRK_IGNORE },
1494 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PTU, HID_QUIRK_IGNORE },
1496 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_4_PHIDGETSERVO_30, HID_QUIRK_IGNORE },
1497 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_1_PHIDGETSERVO_30, HID_QUIRK_IGNORE },
1498 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_8_8_8_IF_KIT, HID_QUIRK_IGNORE },
1499 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_0_4_IF_KIT, HID_QUIRK_IGNORE },
1500 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_8_8_IF_KIT, HID_QUIRK_IGNORE },
1502 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_4_PHIDGETSERVO_20, HID_QUIRK_IGNORE },
1503 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_1_PHIDGETSERVO_20, HID_QUIRK_IGNORE },
1505 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
1506 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
1507 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
1508 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
1509 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
1510 { USB_VENDOR_ID_TANGTOP, USB_DEVICE_ID_TANGTOP_USBPS2, HID_QUIRK_NOGET },
1512 { USB_VENDOR_ID_A4TECH, USB_DEVICE_ID_A4TECH_WCP32PU, HID_QUIRK_2WHEEL_MOUSE_HACK_BACK },
1513 { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_MOUSE, HID_QUIRK_2WHEEL_MOUSE_HACK_EXTRA },
1515 { USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
1516 { USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
1517 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1518 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1519 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1520 { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
1521 { USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
1522 { USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },
1527 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
1529 if (!(hid->inbuf = usb_buffer_alloc(dev, HID_BUFFER_SIZE, SLAB_ATOMIC, &hid->inbuf_dma)))
1531 if (!(hid->outbuf = usb_buffer_alloc(dev, HID_BUFFER_SIZE, SLAB_ATOMIC, &hid->outbuf_dma)))
1533 if (!(hid->cr = usb_buffer_alloc(dev, sizeof(*(hid->cr)), SLAB_ATOMIC, &hid->cr_dma)))
1535 if (!(hid->ctrlbuf = usb_buffer_alloc(dev, HID_BUFFER_SIZE, SLAB_ATOMIC, &hid->ctrlbuf_dma)))
1541 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
1544 usb_buffer_free(dev, HID_BUFFER_SIZE, hid->inbuf, hid->inbuf_dma);
1546 usb_buffer_free(dev, HID_BUFFER_SIZE, hid->outbuf, hid->outbuf_dma);
1548 usb_buffer_free(dev, sizeof(*(hid->cr)), hid->cr, hid->cr_dma);
1550 usb_buffer_free(dev, HID_BUFFER_SIZE, hid->ctrlbuf, hid->ctrlbuf_dma);
1553 static struct hid_device *usb_hid_configure(struct usb_interface *intf)
1555 struct usb_host_interface *interface = intf->cur_altsetting;
1556 struct usb_device *dev = interface_to_usbdev (intf);
1557 struct hid_descriptor *hdesc;
1558 struct hid_device *hid;
1559 unsigned quirks = 0, rsize = 0;
1563 for (n = 0; hid_blacklist[n].idVendor; n++)
1564 if ((hid_blacklist[n].idVendor == dev->descriptor.idVendor) &&
1565 (hid_blacklist[n].idProduct == dev->descriptor.idProduct))
1566 quirks = hid_blacklist[n].quirks;
1568 if (quirks & HID_QUIRK_IGNORE)
1571 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) && ((!interface->desc.bNumEndpoints) ||
1572 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
1573 dbg("class descriptor not present\n");
1577 for (n = 0; n < hdesc->bNumDescriptors; n++)
1578 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
1579 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
1581 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
1582 dbg("weird size of report descriptor (%u)", rsize);
1586 if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
1587 dbg("couldn't allocate rdesc memory");
1591 if ((n = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber, HID_DT_REPORT, rdesc, rsize)) < 0) {
1592 dbg("reading report descriptor failed");
1598 printk(KERN_DEBUG __FILE__ ": report descriptor (size %u, read %d) = ", rsize, n);
1599 for (n = 0; n < rsize; n++)
1600 printk(" %02x", (unsigned char) rdesc[n]);
1604 if (!(hid = hid_parse_report(rdesc, rsize))) {
1605 dbg("parsing report descriptor failed");
1611 hid->quirks = quirks;
1613 if (hid_alloc_buffers(dev, hid)) {
1614 hid_free_buffers(dev, hid);
1618 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
1620 struct usb_endpoint_descriptor *endpoint;
1623 endpoint = &interface->endpoint[n].desc;
1624 if ((endpoint->bmAttributes & 3) != 3) /* Not an interrupt endpoint */
1627 if (endpoint->bEndpointAddress & USB_DIR_IN) {
1632 if (!(hid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
1634 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
1635 len = usb_maxpacket(dev, pipe, 0);
1636 if (len > HID_BUFFER_SIZE)
1637 len = HID_BUFFER_SIZE;
1638 usb_fill_int_urb(hid->urbin, dev, pipe, hid->inbuf, len,
1639 hid_irq_in, hid, endpoint->bInterval);
1640 hid->urbin->transfer_dma = hid->inbuf_dma;
1641 hid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1645 if (!(hid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
1647 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
1648 usb_fill_int_urb(hid->urbout, dev, pipe, hid->outbuf, 0,
1649 hid_irq_out, hid, 1);
1650 hid->urbout->transfer_dma = hid->outbuf_dma;
1651 hid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1656 err("couldn't find an input interrupt endpoint");
1660 init_waitqueue_head(&hid->wait);
1662 hid->outlock = SPIN_LOCK_UNLOCKED;
1663 hid->ctrllock = SPIN_LOCK_UNLOCKED;
1665 hid->version = le16_to_cpu(hdesc->bcdHID);
1666 hid->country = hdesc->bCountryCode;
1669 hid->ifnum = interface->desc.bInterfaceNumber;
1673 if (!(buf = kmalloc(64, GFP_KERNEL)))
1676 if (usb_string(dev, dev->descriptor.iManufacturer, buf, 64) > 0) {
1677 strcat(hid->name, buf);
1678 if (usb_string(dev, dev->descriptor.iProduct, buf, 64) > 0)
1679 snprintf(hid->name, 64, "%s %s", hid->name, buf);
1680 } else if (usb_string(dev, dev->descriptor.iProduct, buf, 128) > 0) {
1681 snprintf(hid->name, 128, "%s", buf);
1683 snprintf(hid->name, 128, "%04x:%04x", dev->descriptor.idVendor, dev->descriptor.idProduct);
1685 usb_make_path(dev, buf, 64);
1686 snprintf(hid->phys, 64, "%s/input%d", buf,
1687 intf->altsetting[0].desc.bInterfaceNumber);
1689 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
1694 hid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
1697 usb_fill_control_urb(hid->urbctrl, dev, 0, (void *) hid->cr,
1698 hid->ctrlbuf, 1, hid_ctrl, hid);
1699 hid->urbctrl->setup_dma = hid->cr_dma;
1700 hid->urbctrl->transfer_dma = hid->ctrlbuf_dma;
1701 hid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP
1702 | URB_NO_SETUP_DMA_MAP);
1709 usb_free_urb(hid->urbin);
1711 usb_free_urb(hid->urbout);
1713 usb_free_urb(hid->urbctrl);
1714 hid_free_buffers(dev, hid);
1715 hid_free_device(hid);
1720 static void hid_disconnect(struct usb_interface *intf)
1722 struct hid_device *hid = usb_get_intfdata (intf);
1727 usb_set_intfdata(intf, NULL);
1728 usb_unlink_urb(hid->urbin);
1729 usb_unlink_urb(hid->urbout);
1730 usb_unlink_urb(hid->urbctrl);
1732 if (hid->claimed & HID_CLAIMED_INPUT)
1733 hidinput_disconnect(hid);
1734 if (hid->claimed & HID_CLAIMED_HIDDEV)
1735 hiddev_disconnect(hid);
1737 usb_free_urb(hid->urbin);
1738 usb_free_urb(hid->urbctrl);
1740 usb_free_urb(hid->urbout);
1742 hid_free_buffers(hid->dev, hid);
1743 hid_free_device(hid);
1746 static int hid_probe (struct usb_interface *intf, const struct usb_device_id *id)
1748 struct hid_device *hid;
1753 dbg("HID probe called for ifnum %d",
1754 intf->altsetting->desc.bInterfaceNumber);
1756 if (!(hid = usb_hid_configure(intf)))
1759 hid_init_reports(hid);
1760 hid_dump_device(hid);
1762 if (!hidinput_connect(hid))
1763 hid->claimed |= HID_CLAIMED_INPUT;
1764 if (!hiddev_connect(hid))
1765 hid->claimed |= HID_CLAIMED_HIDDEV;
1767 usb_set_intfdata(intf, hid);
1769 if (!hid->claimed) {
1770 printk ("HID device not claimed by input or hiddev\n");
1771 hid_disconnect(intf);
1777 if (hid->claimed & HID_CLAIMED_INPUT)
1779 if (hid->claimed == (HID_CLAIMED_INPUT | HID_CLAIMED_HIDDEV))
1781 if (hid->claimed & HID_CLAIMED_HIDDEV)
1782 printk("hiddev%d", hid->minor);
1785 for (i = 0; i < hid->maxcollection; i++) {
1786 if (hid->collection[i].type == HID_COLLECTION_APPLICATION &&
1787 (hid->collection[i].usage & HID_USAGE_PAGE) == HID_UP_GENDESK &&
1788 (hid->collection[i].usage & 0xffff) < ARRAY_SIZE(hid_types)) {
1789 c = hid_types[hid->collection[i].usage & 0xffff];
1794 usb_make_path(interface_to_usbdev(intf), path, 63);
1796 printk(": USB HID v%x.%02x %s [%s] on %s\n",
1797 hid->version >> 8, hid->version & 0xff, c, hid->name, path);
1802 static struct usb_device_id hid_usb_ids [] = {
1803 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1804 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1805 { } /* Terminating entry */
1808 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1810 static struct usb_driver hid_driver = {
1811 .owner = THIS_MODULE,
1814 .disconnect = hid_disconnect,
1815 .id_table = hid_usb_ids,
1818 static int __init hid_init(void)
1821 retval = hiddev_init();
1823 goto hiddev_init_fail;
1824 retval = usb_register(&hid_driver);
1826 goto usb_register_fail;
1827 info(DRIVER_VERSION ":" DRIVER_DESC);
1836 static void __exit hid_exit(void)
1839 usb_deregister(&hid_driver);
1842 module_init(hid_init);
1843 module_exit(hid_exit);
1845 MODULE_AUTHOR(DRIVER_AUTHOR);
1846 MODULE_DESCRIPTION(DRIVER_DESC);
1847 MODULE_LICENSE(DRIVER_LICENSE);