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 field->index = report->maxfield++;
98 report->field[field->index] = field;
99 field->usage = (struct hid_usage *)(field + 1);
100 field->value = (unsigned *)(field->usage + usages);
101 field->report = report;
107 * Open a collection. The type/usage is pushed on the stack.
110 static int open_collection(struct hid_parser *parser, unsigned type)
112 struct hid_collection *collection;
115 usage = parser->local.usage[0];
117 if (parser->collection_stack_ptr == HID_COLLECTION_STACK_SIZE) {
118 dbg("collection stack overflow");
122 if (parser->device->maxcollection == parser->device->collection_size) {
123 collection = kmalloc(sizeof(struct hid_collection) *
124 parser->device->collection_size * 2,
126 if (collection == NULL) {
127 dbg("failed to reallocate collection array");
130 memcpy(collection, parser->device->collection,
131 sizeof(struct hid_collection) *
132 parser->device->collection_size);
133 memset(collection + parser->device->collection_size, 0,
134 sizeof(struct hid_collection) *
135 parser->device->collection_size);
136 kfree(parser->device->collection);
137 parser->device->collection = collection;
138 parser->device->collection_size *= 2;
141 parser->collection_stack[parser->collection_stack_ptr++] =
142 parser->device->maxcollection;
144 collection = parser->device->collection +
145 parser->device->maxcollection++;
146 collection->type = type;
147 collection->usage = usage;
148 collection->level = parser->collection_stack_ptr - 1;
150 if (type == HID_COLLECTION_APPLICATION)
151 parser->device->maxapplication++;
157 * Close a collection.
160 static int close_collection(struct hid_parser *parser)
162 if (!parser->collection_stack_ptr) {
163 dbg("collection stack underflow");
166 parser->collection_stack_ptr--;
171 * Climb up the stack, search for the specified collection type
172 * and return the usage.
175 static unsigned hid_lookup_collection(struct hid_parser *parser, unsigned type)
178 for (n = parser->collection_stack_ptr - 1; n >= 0; n--)
179 if (parser->device->collection[parser->collection_stack[n]].type == type)
180 return parser->device->collection[parser->collection_stack[n]].usage;
181 return 0; /* we know nothing about this usage type */
185 * Add a usage to the temporary parser table.
188 static int hid_add_usage(struct hid_parser *parser, unsigned usage)
190 if (parser->local.usage_index >= HID_MAX_USAGES) {
191 dbg("usage index exceeded");
194 parser->local.usage[parser->local.usage_index] = usage;
195 parser->local.collection_index[parser->local.usage_index] =
196 parser->collection_stack_ptr ?
197 parser->collection_stack[parser->collection_stack_ptr - 1] : 0;
198 parser->local.usage_index++;
203 * Register a new field for this report.
206 static int hid_add_field(struct hid_parser *parser, unsigned report_type, unsigned flags)
208 struct hid_report *report;
209 struct hid_field *field;
214 if (!(report = hid_register_report(parser->device, report_type, parser->global.report_id))) {
215 dbg("hid_register_report failed");
219 if (parser->global.logical_maximum < parser->global.logical_minimum) {
220 dbg("logical range invalid %d %d", parser->global.logical_minimum, parser->global.logical_maximum);
224 if (!(usages = max_t(int, parser->local.usage_index, parser->global.report_count)))
225 return 0; /* Ignore padding fields */
227 offset = report->size;
228 report->size += parser->global.report_size * parser->global.report_count;
230 if ((field = hid_register_field(report, usages, parser->global.report_count)) == NULL)
233 field->physical = hid_lookup_collection(parser, HID_COLLECTION_PHYSICAL);
234 field->logical = hid_lookup_collection(parser, HID_COLLECTION_LOGICAL);
235 field->application = hid_lookup_collection(parser, HID_COLLECTION_APPLICATION);
237 for (i = 0; i < usages; i++) {
239 /* Duplicate the last usage we parsed if we have excess values */
240 if (i >= parser->local.usage_index)
241 j = parser->local.usage_index - 1;
242 field->usage[i].hid = parser->local.usage[j];
243 field->usage[i].collection_index =
244 parser->local.collection_index[j];
247 field->maxusage = usages;
248 field->flags = flags;
249 field->report_offset = offset;
250 field->report_type = report_type;
251 field->report_size = parser->global.report_size;
252 field->report_count = parser->global.report_count;
253 field->logical_minimum = parser->global.logical_minimum;
254 field->logical_maximum = parser->global.logical_maximum;
255 field->physical_minimum = parser->global.physical_minimum;
256 field->physical_maximum = parser->global.physical_maximum;
257 field->unit_exponent = parser->global.unit_exponent;
258 field->unit = parser->global.unit;
264 * Read data value from item.
267 static __inline__ __u32 item_udata(struct hid_item *item)
269 switch (item->size) {
270 case 1: return item->data.u8;
271 case 2: return item->data.u16;
272 case 4: return item->data.u32;
277 static __inline__ __s32 item_sdata(struct hid_item *item)
279 switch (item->size) {
280 case 1: return item->data.s8;
281 case 2: return item->data.s16;
282 case 4: return item->data.s32;
288 * Process a global item.
291 static int hid_parser_global(struct hid_parser *parser, struct hid_item *item)
295 case HID_GLOBAL_ITEM_TAG_PUSH:
297 if (parser->global_stack_ptr == HID_GLOBAL_STACK_SIZE) {
298 dbg("global enviroment stack overflow");
302 memcpy(parser->global_stack + parser->global_stack_ptr++,
303 &parser->global, sizeof(struct hid_global));
306 case HID_GLOBAL_ITEM_TAG_POP:
308 if (!parser->global_stack_ptr) {
309 dbg("global enviroment stack underflow");
313 memcpy(&parser->global, parser->global_stack + --parser->global_stack_ptr,
314 sizeof(struct hid_global));
317 case HID_GLOBAL_ITEM_TAG_USAGE_PAGE:
318 parser->global.usage_page = item_udata(item);
321 case HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM:
322 parser->global.logical_minimum = item_sdata(item);
325 case HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM:
326 if (parser->global.logical_minimum < 0)
327 parser->global.logical_maximum = item_sdata(item);
329 parser->global.logical_maximum = item_udata(item);
332 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM:
333 parser->global.physical_minimum = item_sdata(item);
336 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM:
337 if (parser->global.physical_minimum < 0)
338 parser->global.physical_maximum = item_sdata(item);
340 parser->global.physical_maximum = item_udata(item);
343 case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT:
344 parser->global.unit_exponent = item_sdata(item);
347 case HID_GLOBAL_ITEM_TAG_UNIT:
348 parser->global.unit = item_udata(item);
351 case HID_GLOBAL_ITEM_TAG_REPORT_SIZE:
352 if ((parser->global.report_size = item_udata(item)) > 32) {
353 dbg("invalid report_size %d", parser->global.report_size);
358 case HID_GLOBAL_ITEM_TAG_REPORT_COUNT:
359 if ((parser->global.report_count = item_udata(item)) > HID_MAX_USAGES) {
360 dbg("invalid report_count %d", parser->global.report_count);
365 case HID_GLOBAL_ITEM_TAG_REPORT_ID:
366 if ((parser->global.report_id = item_udata(item)) == 0) {
367 dbg("report_id 0 is invalid");
373 dbg("unknown global tag 0x%x", item->tag);
379 * Process a local item.
382 static int hid_parser_local(struct hid_parser *parser, struct hid_item *item)
387 if (item->size == 0) {
388 dbg("item data expected for local item");
392 data = item_udata(item);
396 case HID_LOCAL_ITEM_TAG_DELIMITER:
400 * We treat items before the first delimiter
401 * as global to all usage sets (branch 0).
402 * In the moment we process only these global
403 * items and the first delimiter set.
405 if (parser->local.delimiter_depth != 0) {
406 dbg("nested delimiters");
409 parser->local.delimiter_depth++;
410 parser->local.delimiter_branch++;
412 if (parser->local.delimiter_depth < 1) {
413 dbg("bogus close delimiter");
416 parser->local.delimiter_depth--;
420 case HID_LOCAL_ITEM_TAG_USAGE:
422 if (parser->local.delimiter_branch > 1) {
423 dbg("alternative usage ignored");
428 data = (parser->global.usage_page << 16) + data;
430 return hid_add_usage(parser, data);
432 case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:
434 if (parser->local.delimiter_branch > 1) {
435 dbg("alternative usage ignored");
440 data = (parser->global.usage_page << 16) + data;
442 parser->local.usage_minimum = data;
445 case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:
447 if (parser->local.delimiter_branch > 1) {
448 dbg("alternative usage ignored");
453 data = (parser->global.usage_page << 16) + data;
455 for (n = parser->local.usage_minimum; n <= data; n++)
456 if (hid_add_usage(parser, n)) {
457 dbg("hid_add_usage failed\n");
464 dbg("unknown local item tag 0x%x", item->tag);
471 * Process a main item.
474 static int hid_parser_main(struct hid_parser *parser, struct hid_item *item)
479 data = item_udata(item);
482 case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION:
483 ret = open_collection(parser, data & 0xff);
485 case HID_MAIN_ITEM_TAG_END_COLLECTION:
486 ret = close_collection(parser);
488 case HID_MAIN_ITEM_TAG_INPUT:
489 ret = hid_add_field(parser, HID_INPUT_REPORT, data);
491 case HID_MAIN_ITEM_TAG_OUTPUT:
492 ret = hid_add_field(parser, HID_OUTPUT_REPORT, data);
494 case HID_MAIN_ITEM_TAG_FEATURE:
495 ret = hid_add_field(parser, HID_FEATURE_REPORT, data);
498 dbg("unknown main item tag 0x%x", item->tag);
502 memset(&parser->local, 0, sizeof(parser->local)); /* Reset the local parser environment */
508 * Process a reserved item.
511 static int hid_parser_reserved(struct hid_parser *parser, struct hid_item *item)
513 dbg("reserved item type, tag 0x%x", item->tag);
518 * Free a report and all registered fields. The field->usage and
519 * field->value table's are allocated behind the field, so we need
520 * only to free(field) itself.
523 static void hid_free_report(struct hid_report *report)
527 for (n = 0; n < report->maxfield; n++)
528 kfree(report->field[n]);
533 * Free a device structure, all reports, and all fields.
536 static void hid_free_device(struct hid_device *device)
542 for (i = 0; i < HID_REPORT_TYPES; i++) {
543 struct hid_report_enum *report_enum = device->report_enum + i;
545 for (j = 0; j < 256; j++) {
546 struct hid_report *report = report_enum->report_id_hash[j];
548 hid_free_report(report);
553 kfree(device->rdesc);
558 * Fetch a report description item from the data stream. We support long
559 * items, though they are not used yet.
562 static u8 *fetch_item(__u8 *start, __u8 *end, struct hid_item *item)
566 if ((end - start) <= 0)
571 item->type = (b >> 2) & 3;
572 item->tag = (b >> 4) & 15;
574 if (item->tag == HID_ITEM_TAG_LONG) {
576 item->format = HID_ITEM_FORMAT_LONG;
578 if ((end - start) < 2)
581 item->size = *start++;
582 item->tag = *start++;
584 if ((end - start) < item->size)
587 item->data.longdata = start;
592 item->format = HID_ITEM_FORMAT_SHORT;
595 switch (item->size) {
601 if ((end - start) < 1)
603 item->data.u8 = *start++;
607 if ((end - start) < 2)
609 item->data.u16 = le16_to_cpu(get_unaligned((__le16*)start));
610 start = (__u8 *)((__le16 *)start + 1);
615 if ((end - start) < 4)
617 item->data.u32 = le32_to_cpu(get_unaligned((__le32*)start));
618 start = (__u8 *)((__le32 *)start + 1);
626 * Parse a report description into a hid_device structure. Reports are
627 * enumerated, fields are attached to these reports.
630 static struct hid_device *hid_parse_report(__u8 *start, unsigned size)
632 struct hid_device *device;
633 struct hid_parser *parser;
634 struct hid_item item;
637 static int (*dispatch_type[])(struct hid_parser *parser,
638 struct hid_item *item) = {
645 if (!(device = kmalloc(sizeof(struct hid_device), GFP_KERNEL)))
647 memset(device, 0, sizeof(struct hid_device));
649 if (!(device->collection =kmalloc(sizeof(struct hid_collection) *
650 HID_DEFAULT_NUM_COLLECTIONS, GFP_KERNEL))) {
654 memset(device->collection, 0, sizeof(struct hid_collection) *
655 HID_DEFAULT_NUM_COLLECTIONS);
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);
666 memcpy(device->rdesc, start, size);
667 device->rsize = size;
669 if (!(parser = kmalloc(sizeof(struct hid_parser), GFP_KERNEL))) {
670 kfree(device->rdesc);
671 kfree(device->collection);
675 memset(parser, 0, sizeof(struct hid_parser));
676 parser->device = device;
679 while ((start = fetch_item(start, end, &item)) != 0) {
681 if (item.format != HID_ITEM_FORMAT_SHORT) {
682 dbg("unexpected long global item");
683 kfree(device->collection);
684 hid_free_device(device);
689 if (dispatch_type[item.type](parser, &item)) {
690 dbg("item %u %u %u %u parsing failed\n",
691 item.format, (unsigned)item.size, (unsigned)item.type, (unsigned)item.tag);
692 kfree(device->collection);
693 hid_free_device(device);
699 if (parser->collection_stack_ptr) {
700 dbg("unbalanced collection at end of report description");
701 kfree(device->collection);
702 hid_free_device(device);
706 if (parser->local.delimiter_depth) {
707 dbg("unbalanced delimiter at end of report description");
708 kfree(device->collection);
709 hid_free_device(device);
718 dbg("item fetching failed at offset %d\n", (int)(end - start));
719 kfree(device->collection);
720 hid_free_device(device);
726 * Convert a signed n-bit integer to signed 32-bit integer. Common
727 * cases are done through the compiler, the screwed things has to be
731 static __inline__ __s32 snto32(__u32 value, unsigned n)
734 case 8: return ((__s8)value);
735 case 16: return ((__s16)value);
736 case 32: return ((__s32)value);
738 return value & (1 << (n - 1)) ? value | (-1 << n) : value;
742 * Convert a signed 32-bit integer to a signed n-bit integer.
745 static __inline__ __u32 s32ton(__s32 value, unsigned n)
747 __s32 a = value >> (n - 1);
749 return value < 0 ? 1 << (n - 1) : (1 << (n - 1)) - 1;
750 return value & ((1 << n) - 1);
754 * Extract/implement a data field from/to a report.
757 static __inline__ __u32 extract(__u8 *report, unsigned offset, unsigned n)
759 report += (offset >> 5) << 2; offset &= 31;
760 return (le64_to_cpu(get_unaligned((__le64*)report)) >> offset) & ((1 << n) - 1);
763 static __inline__ void implement(__u8 *report, unsigned offset, unsigned n, __u32 value)
765 report += (offset >> 5) << 2; offset &= 31;
766 put_unaligned((get_unaligned((__le64*)report)
767 & cpu_to_le64(~((((__u64) 1 << n) - 1) << offset)))
768 | cpu_to_le64((__u64)value << offset), (__le64*)report);
772 * Search an array for a value.
775 static __inline__ int search(__s32 *array, __s32 value, unsigned n)
778 if (*array++ == value)
784 static void hid_process_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value, struct pt_regs *regs)
786 hid_dump_input(usage, value);
787 if (hid->claimed & HID_CLAIMED_INPUT)
788 hidinput_hid_event(hid, field, usage, value, regs);
789 if (hid->claimed & HID_CLAIMED_HIDDEV)
790 hiddev_hid_event(hid, field, usage, value, regs);
794 * Analyse a received field, and fetch the data from it. The field
795 * content is stored for next report processing (we do differential
796 * reporting to the layer).
799 static void hid_input_field(struct hid_device *hid, struct hid_field *field, __u8 *data, struct pt_regs *regs)
802 unsigned count = field->report_count;
803 unsigned offset = field->report_offset;
804 unsigned size = field->report_size;
805 __s32 min = field->logical_minimum;
806 __s32 max = field->logical_maximum;
809 value = kmalloc(sizeof(__s32)*count, GFP_ATOMIC);
813 for (n = 0; n < count; n++) {
815 value[n] = min < 0 ? snto32(extract(data, offset + n * size, size), size) :
816 extract(data, offset + n * size, size);
818 if (!(field->flags & HID_MAIN_ITEM_VARIABLE) /* Ignore report if ErrorRollOver */
819 && value[n] >= min && value[n] <= max
820 && field->usage[value[n] - min].hid == HID_UP_KEYBOARD + 1)
824 for (n = 0; n < count; n++) {
826 if (HID_MAIN_ITEM_VARIABLE & field->flags) {
828 if (field->flags & HID_MAIN_ITEM_RELATIVE) {
832 if (value[n] == field->value[n])
835 hid_process_event(hid, field, &field->usage[n], value[n], regs);
839 if (field->value[n] >= min && field->value[n] <= max
840 && field->usage[field->value[n] - min].hid
841 && search(value, field->value[n], count))
842 hid_process_event(hid, field, &field->usage[field->value[n] - min], 0, regs);
844 if (value[n] >= min && value[n] <= max
845 && field->usage[value[n] - min].hid
846 && search(field->value, value[n], count))
847 hid_process_event(hid, field, &field->usage[value[n] - min], 1, regs);
850 memcpy(field->value, value, count * sizeof(__s32));
855 static int hid_input_report(int type, struct urb *urb, struct pt_regs *regs)
857 struct hid_device *hid = urb->context;
858 struct hid_report_enum *report_enum = hid->report_enum + type;
859 u8 *data = urb->transfer_buffer;
860 int len = urb->actual_length;
861 struct hid_report *report;
870 printk(KERN_DEBUG __FILE__ ": report (size %u) (%snumbered)\n", len, report_enum->numbered ? "" : "un");
873 n = 0; /* Normally report number is 0 */
874 if (report_enum->numbered) { /* Device uses numbered reports, data[0] is report number */
882 printk(KERN_DEBUG __FILE__ ": report %d (size %u) = ", n, len);
883 for (i = 0; i < len; i++)
884 printk(" %02x", data[i]);
889 if (!(report = report_enum->report_id_hash[n])) {
890 dbg("undefined report_id %d received", n);
894 size = ((report->size - 1) >> 3) + 1;
897 dbg("report %d is too short, (%d < %d)", report->id, len, size);
901 if (hid->claimed & HID_CLAIMED_HIDDEV)
902 hiddev_report_event(hid, report);
904 for (n = 0; n < report->maxfield; n++)
905 hid_input_field(hid, report->field[n], data, regs);
907 if (hid->claimed & HID_CLAIMED_INPUT)
908 hidinput_report_event(hid, report);
914 * Input interrupt completion handler.
917 static void hid_irq_in(struct urb *urb, struct pt_regs *regs)
919 struct hid_device *hid = urb->context;
922 switch (urb->status) {
923 case 0: /* success */
924 hid_input_report(HID_INPUT_REPORT, urb, regs);
926 case -ECONNRESET: /* unlink */
931 case -ETIMEDOUT: /* NAK */
934 warn("input irq status %d received", 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;
1140 switch (urb->status) {
1141 case 0: /* success */
1142 case -ECONNRESET: /* unlink */
1146 default: /* error */
1147 warn("output irq status %d received", urb->status);
1150 spin_lock_irqsave(&hid->outlock, flags);
1152 hid->outtail = (hid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
1154 if (hid->outhead != hid->outtail) {
1155 if (hid_submit_out(hid)) {
1156 clear_bit(HID_OUT_RUNNING, &hid->iofl);;
1157 wake_up(&hid->wait);
1159 spin_unlock_irqrestore(&hid->outlock, flags);
1163 clear_bit(HID_OUT_RUNNING, &hid->iofl);
1164 spin_unlock_irqrestore(&hid->outlock, flags);
1165 wake_up(&hid->wait);
1169 * Control pipe completion handler.
1172 static void hid_ctrl(struct urb *urb, struct pt_regs *regs)
1174 struct hid_device *hid = urb->context;
1175 unsigned long flags;
1177 spin_lock_irqsave(&hid->ctrllock, flags);
1179 switch (urb->status) {
1180 case 0: /* success */
1181 if (hid->ctrl[hid->ctrltail].dir == USB_DIR_IN)
1182 hid_input_report(hid->ctrl[hid->ctrltail].report->type, urb, regs);
1183 case -ECONNRESET: /* unlink */
1186 case -EPIPE: /* report not available */
1188 default: /* error */
1189 warn("ctrl urb status %d received", urb->status);
1192 hid->ctrltail = (hid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
1194 if (hid->ctrlhead != hid->ctrltail) {
1195 if (hid_submit_ctrl(hid)) {
1196 clear_bit(HID_CTRL_RUNNING, &hid->iofl);
1197 wake_up(&hid->wait);
1199 spin_unlock_irqrestore(&hid->ctrllock, flags);
1203 clear_bit(HID_CTRL_RUNNING, &hid->iofl);
1204 spin_unlock_irqrestore(&hid->ctrllock, flags);
1205 wake_up(&hid->wait);
1208 void hid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
1211 unsigned long flags;
1213 if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
1216 if (hid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
1218 spin_lock_irqsave(&hid->outlock, flags);
1220 if ((head = (hid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == hid->outtail) {
1221 spin_unlock_irqrestore(&hid->outlock, flags);
1222 warn("output queue full");
1226 hid->out[hid->outhead] = report;
1227 hid->outhead = head;
1229 if (!test_and_set_bit(HID_OUT_RUNNING, &hid->iofl))
1230 if (hid_submit_out(hid))
1231 clear_bit(HID_OUT_RUNNING, &hid->iofl);
1233 spin_unlock_irqrestore(&hid->outlock, flags);
1237 spin_lock_irqsave(&hid->ctrllock, flags);
1239 if ((head = (hid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == hid->ctrltail) {
1240 spin_unlock_irqrestore(&hid->ctrllock, flags);
1241 warn("control queue full");
1245 hid->ctrl[hid->ctrlhead].report = report;
1246 hid->ctrl[hid->ctrlhead].dir = dir;
1247 hid->ctrlhead = head;
1249 if (!test_and_set_bit(HID_CTRL_RUNNING, &hid->iofl))
1250 if (hid_submit_ctrl(hid))
1251 clear_bit(HID_CTRL_RUNNING, &hid->iofl);
1253 spin_unlock_irqrestore(&hid->ctrllock, flags);
1256 int hid_wait_io(struct hid_device *hid)
1258 DECLARE_WAITQUEUE(wait, current);
1259 int timeout = 10*HZ;
1261 set_current_state(TASK_UNINTERRUPTIBLE);
1262 add_wait_queue(&hid->wait, &wait);
1264 while (timeout && (test_bit(HID_CTRL_RUNNING, &hid->iofl) ||
1265 test_bit(HID_OUT_RUNNING, &hid->iofl))) {
1266 set_current_state(TASK_UNINTERRUPTIBLE);
1267 timeout = schedule_timeout(timeout);
1270 set_current_state(TASK_RUNNING);
1271 remove_wait_queue(&hid->wait, &wait);
1274 dbg("timeout waiting for ctrl or out queue to clear");
1281 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
1282 unsigned char type, void *buf, int size)
1284 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
1285 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
1286 (type << 8), ifnum, buf, size, HZ * USB_CTRL_GET_TIMEOUT);
1289 int hid_open(struct hid_device *hid)
1294 hid->urbin->dev = hid->dev;
1296 if (usb_submit_urb(hid->urbin, GFP_KERNEL))
1302 void hid_close(struct hid_device *hid)
1305 usb_kill_urb(hid->urbin);
1309 * Initialize all reports
1312 void hid_init_reports(struct hid_device *hid)
1314 struct hid_report_enum *report_enum;
1315 struct hid_report *report;
1316 struct list_head *list;
1320 * The Set_Idle request is supposed to affect only the
1321 * "Interrupt In" pipe. Unfortunately, buggy devices such as
1322 * the BTC keyboard (ID 046e:5303) the request also affects
1323 * Get_Report requests on the control pipe. In the worst
1324 * case, if the device was put on idle for an indefinite
1325 * amount of time (as we do below) and there are no input
1326 * events to report, the Get_Report requests will just hang
1327 * until we get a USB timeout. To avoid this, we temporarily
1328 * establish a minimal idle time of 1ms. This shouldn't hurt
1329 * bugfree devices and will cause a worst-case extra delay of
1330 * 1ms for buggy ones.
1332 usb_control_msg(hid->dev, usb_sndctrlpipe(hid->dev, 0),
1333 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (1 << 8),
1334 hid->ifnum, NULL, 0, HZ * USB_CTRL_SET_TIMEOUT);
1336 report_enum = hid->report_enum + HID_INPUT_REPORT;
1337 list = report_enum->report_list.next;
1338 while (list != &report_enum->report_list) {
1339 report = (struct hid_report *) list;
1340 hid_submit_report(hid, report, USB_DIR_IN);
1344 report_enum = hid->report_enum + HID_FEATURE_REPORT;
1345 list = report_enum->report_list.next;
1346 while (list != &report_enum->report_list) {
1347 report = (struct hid_report *) list;
1348 hid_submit_report(hid, report, USB_DIR_IN);
1353 ret = hid_wait_io(hid);
1356 if (test_bit(HID_CTRL_RUNNING, &hid->iofl))
1357 usb_kill_urb(hid->urbctrl);
1358 if (test_bit(HID_OUT_RUNNING, &hid->iofl))
1359 usb_kill_urb(hid->urbout);
1360 ret = hid_wait_io(hid);
1364 warn("timeout initializing reports\n");
1366 report_enum = hid->report_enum + HID_INPUT_REPORT;
1367 list = report_enum->report_list.next;
1368 while (list != &report_enum->report_list) {
1369 report = (struct hid_report *) list;
1370 usb_control_msg(hid->dev, usb_sndctrlpipe(hid->dev, 0),
1371 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, report->id,
1372 hid->ifnum, NULL, 0, HZ * USB_CTRL_SET_TIMEOUT);
1377 #define USB_VENDOR_ID_WACOM 0x056a
1378 #define USB_DEVICE_ID_WACOM_PENPARTNER 0x0000
1379 #define USB_DEVICE_ID_WACOM_GRAPHIRE 0x0010
1380 #define USB_DEVICE_ID_WACOM_INTUOS 0x0020
1381 #define USB_DEVICE_ID_WACOM_PL 0x0030
1382 #define USB_DEVICE_ID_WACOM_INTUOS2 0x0040
1383 #define USB_DEVICE_ID_WACOM_VOLITO 0x0060
1384 #define USB_DEVICE_ID_WACOM_PTU 0x0003
1386 #define USB_VENDOR_ID_KBGEAR 0x084e
1387 #define USB_DEVICE_ID_KBGEAR_JAMSTUDIO 0x1001
1389 #define USB_VENDOR_ID_AIPTEK 0x08ca
1390 #define USB_DEVICE_ID_AIPTEK_01 0x0001
1391 #define USB_DEVICE_ID_AIPTEK_10 0x0010
1392 #define USB_DEVICE_ID_AIPTEK_20 0x0020
1393 #define USB_DEVICE_ID_AIPTEK_21 0x0021
1394 #define USB_DEVICE_ID_AIPTEK_22 0x0022
1395 #define USB_DEVICE_ID_AIPTEK_23 0x0023
1396 #define USB_DEVICE_ID_AIPTEK_24 0x0024
1398 #define USB_VENDOR_ID_GRIFFIN 0x077d
1399 #define USB_DEVICE_ID_POWERMATE 0x0410
1400 #define USB_DEVICE_ID_SOUNDKNOB 0x04AA
1402 #define USB_VENDOR_ID_ATEN 0x0557
1403 #define USB_DEVICE_ID_ATEN_UC100KM 0x2004
1404 #define USB_DEVICE_ID_ATEN_CS124U 0x2202
1405 #define USB_DEVICE_ID_ATEN_2PORTKVM 0x2204
1406 #define USB_DEVICE_ID_ATEN_4PORTKVM 0x2205
1407 #define USB_DEVICE_ID_ATEN_4PORTKVMC 0x2208
1409 #define USB_VENDOR_ID_TOPMAX 0x0663
1410 #define USB_DEVICE_ID_TOPMAX_COBRAPAD 0x0103
1412 #define USB_VENDOR_ID_HAPP 0x078b
1413 #define USB_DEVICE_ID_UGCI_DRIVING 0x0010
1414 #define USB_DEVICE_ID_UGCI_FLYING 0x0020
1415 #define USB_DEVICE_ID_UGCI_FIGHTING 0x0030
1417 #define USB_VENDOR_ID_MGE 0x0463
1418 #define USB_DEVICE_ID_MGE_UPS 0xffff
1419 #define USB_DEVICE_ID_MGE_UPS1 0x0001
1421 #define USB_VENDOR_ID_ONTRAK 0x0a07
1422 #define USB_DEVICE_ID_ONTRAK_ADU100 0x0064
1424 #define USB_VENDOR_ID_TANGTOP 0x0d3d
1425 #define USB_DEVICE_ID_TANGTOP_USBPS2 0x0001
1427 #define USB_VENDOR_ID_ESSENTIAL_REALITY 0x0d7f
1428 #define USB_DEVICE_ID_ESSENTIAL_REALITY_P5 0x0100
1430 #define USB_VENDOR_ID_A4TECH 0x09DA
1431 #define USB_DEVICE_ID_A4TECH_WCP32PU 0x0006
1433 #define USB_VENDOR_ID_CYPRESS 0x04b4
1434 #define USB_DEVICE_ID_CYPRESS_MOUSE 0x0001
1435 #define USB_DEVICE_ID_CYPRESS_HIDCOM 0x5500
1437 #define USB_VENDOR_ID_BERKSHIRE 0x0c98
1438 #define USB_DEVICE_ID_BERKSHIRE_PCWD 0x1140
1440 #define USB_VENDOR_ID_ALPS 0x0433
1441 #define USB_DEVICE_ID_IBM_GAMEPAD 0x1101
1443 #define USB_VENDOR_ID_SAITEK 0x06a3
1444 #define USB_DEVICE_ID_SAITEK_RUMBLEPAD 0xff17
1446 #define USB_VENDOR_ID_NEC 0x073e
1447 #define USB_DEVICE_ID_NEC_USB_GAME_PAD 0x0301
1449 #define USB_VENDOR_ID_CHIC 0x05fe
1450 #define USB_DEVICE_ID_CHIC_GAMEPAD 0x0014
1452 #define USB_VENDOR_ID_GLAB 0x06c2
1453 #define USB_DEVICE_ID_4_PHIDGETSERVO_30 0x0038
1454 #define USB_DEVICE_ID_1_PHIDGETSERVO_30 0x0039
1455 #define USB_DEVICE_ID_8_8_8_IF_KIT 0x0045
1456 #define USB_DEVICE_ID_0_0_4_IF_KIT 0x0040
1457 #define USB_DEVICE_ID_0_8_8_IF_KIT 0x0053
1459 #define USB_VENDOR_ID_WISEGROUP 0x0925
1460 #define USB_DEVICE_ID_1_PHIDGETSERVO_20 0x8101
1461 #define USB_DEVICE_ID_4_PHIDGETSERVO_20 0x8104
1463 #define USB_VENDOR_ID_CODEMERCS 0x07c0
1464 #define USB_DEVICE_ID_CODEMERCS_IOW40 0x1500
1465 #define USB_DEVICE_ID_CODEMERCS_IOW24 0x1501
1466 #define USB_DEVICE_ID_CODEMERCS_IOW48 0x1502
1467 #define USB_DEVICE_ID_CODEMERCS_IOW28 0x1503
1469 #define USB_VENDOR_ID_DELORME 0x1163
1470 #define USB_DEVICE_ID_DELORME_EARTHMATE 0x0100
1472 static struct hid_blacklist {
1476 } hid_blacklist[] = {
1478 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_01, HID_QUIRK_IGNORE },
1479 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_10, HID_QUIRK_IGNORE },
1480 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_20, HID_QUIRK_IGNORE },
1481 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_21, HID_QUIRK_IGNORE },
1482 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_22, HID_QUIRK_IGNORE },
1483 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_23, HID_QUIRK_IGNORE },
1484 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_24, HID_QUIRK_IGNORE },
1485 { USB_VENDOR_ID_BERKSHIRE, USB_DEVICE_ID_BERKSHIRE_PCWD, HID_QUIRK_IGNORE },
1486 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW40, HID_QUIRK_IGNORE },
1487 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW24, HID_QUIRK_IGNORE },
1488 { USB_VENDOR_ID_ESSENTIAL_REALITY, USB_DEVICE_ID_ESSENTIAL_REALITY_P5, HID_QUIRK_IGNORE },
1489 { USB_VENDOR_ID_KBGEAR, USB_DEVICE_ID_KBGEAR_JAMSTUDIO, HID_QUIRK_IGNORE },
1490 { USB_VENDOR_ID_GRIFFIN, USB_DEVICE_ID_POWERMATE, HID_QUIRK_IGNORE },
1491 { USB_VENDOR_ID_GRIFFIN, USB_DEVICE_ID_SOUNDKNOB, HID_QUIRK_IGNORE },
1492 { USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS, HID_QUIRK_IGNORE },
1493 { USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS1, HID_QUIRK_IGNORE },
1494 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100, HID_QUIRK_IGNORE },
1495 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 100, HID_QUIRK_IGNORE },
1496 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 200, HID_QUIRK_IGNORE },
1497 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 300, HID_QUIRK_IGNORE },
1498 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 400, HID_QUIRK_IGNORE },
1499 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 500, HID_QUIRK_IGNORE },
1500 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PENPARTNER, HID_QUIRK_IGNORE },
1501 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE, HID_QUIRK_IGNORE },
1502 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE + 1, HID_QUIRK_IGNORE },
1503 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE + 2, HID_QUIRK_IGNORE },
1504 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE + 3, HID_QUIRK_IGNORE },
1505 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE + 4, HID_QUIRK_IGNORE },
1506 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS, HID_QUIRK_IGNORE },
1507 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS + 1, HID_QUIRK_IGNORE },
1508 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS + 2, HID_QUIRK_IGNORE },
1509 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS + 3, HID_QUIRK_IGNORE },
1510 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS + 4, HID_QUIRK_IGNORE },
1511 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL, HID_QUIRK_IGNORE },
1512 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 1, HID_QUIRK_IGNORE },
1513 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 2, HID_QUIRK_IGNORE },
1514 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 3, HID_QUIRK_IGNORE },
1515 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 4, HID_QUIRK_IGNORE },
1516 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PL + 5, HID_QUIRK_IGNORE },
1517 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 1, HID_QUIRK_IGNORE },
1518 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 2, HID_QUIRK_IGNORE },
1519 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 3, HID_QUIRK_IGNORE },
1520 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 4, HID_QUIRK_IGNORE },
1521 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 5, HID_QUIRK_IGNORE },
1522 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_INTUOS2 + 7, HID_QUIRK_IGNORE },
1523 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_VOLITO, HID_QUIRK_IGNORE },
1524 { USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_PTU, HID_QUIRK_IGNORE },
1526 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_4_PHIDGETSERVO_30, HID_QUIRK_IGNORE },
1527 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_1_PHIDGETSERVO_30, HID_QUIRK_IGNORE },
1528 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_8_8_8_IF_KIT, HID_QUIRK_IGNORE },
1529 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_0_4_IF_KIT, HID_QUIRK_IGNORE },
1530 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_8_8_IF_KIT, HID_QUIRK_IGNORE },
1532 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_4_PHIDGETSERVO_20, HID_QUIRK_IGNORE },
1533 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_1_PHIDGETSERVO_20, HID_QUIRK_IGNORE },
1535 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
1536 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
1537 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
1538 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
1539 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
1540 { USB_VENDOR_ID_TANGTOP, USB_DEVICE_ID_TANGTOP_USBPS2, HID_QUIRK_NOGET },
1542 { USB_VENDOR_ID_A4TECH, USB_DEVICE_ID_A4TECH_WCP32PU, HID_QUIRK_2WHEEL_MOUSE_HACK_BACK },
1543 { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_MOUSE, HID_QUIRK_2WHEEL_MOUSE_HACK_EXTRA },
1544 { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_HIDCOM, HID_QUIRK_IGNORE },
1546 { USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
1547 { USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
1548 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1549 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1550 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1551 { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
1552 { USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
1553 { USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },
1555 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW40, HID_QUIRK_IGNORE },
1556 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW24, HID_QUIRK_IGNORE },
1557 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW48, HID_QUIRK_IGNORE },
1558 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW28, HID_QUIRK_IGNORE },
1560 { USB_VENDOR_ID_DELORME, USB_DEVICE_ID_DELORME_EARTHMATE, HID_QUIRK_IGNORE },
1565 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
1567 if (!(hid->inbuf = usb_buffer_alloc(dev, HID_BUFFER_SIZE, SLAB_ATOMIC, &hid->inbuf_dma)))
1569 if (!(hid->outbuf = usb_buffer_alloc(dev, HID_BUFFER_SIZE, SLAB_ATOMIC, &hid->outbuf_dma)))
1571 if (!(hid->cr = usb_buffer_alloc(dev, sizeof(*(hid->cr)), SLAB_ATOMIC, &hid->cr_dma)))
1573 if (!(hid->ctrlbuf = usb_buffer_alloc(dev, HID_BUFFER_SIZE, SLAB_ATOMIC, &hid->ctrlbuf_dma)))
1579 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
1582 usb_buffer_free(dev, HID_BUFFER_SIZE, hid->inbuf, hid->inbuf_dma);
1584 usb_buffer_free(dev, HID_BUFFER_SIZE, hid->outbuf, hid->outbuf_dma);
1586 usb_buffer_free(dev, sizeof(*(hid->cr)), hid->cr, hid->cr_dma);
1588 usb_buffer_free(dev, HID_BUFFER_SIZE, hid->ctrlbuf, hid->ctrlbuf_dma);
1591 static struct hid_device *usb_hid_configure(struct usb_interface *intf)
1593 struct usb_host_interface *interface = intf->cur_altsetting;
1594 struct usb_device *dev = interface_to_usbdev (intf);
1595 struct hid_descriptor *hdesc;
1596 struct hid_device *hid;
1597 unsigned quirks = 0, rsize = 0;
1601 for (n = 0; hid_blacklist[n].idVendor; n++)
1602 if ((hid_blacklist[n].idVendor == dev->descriptor.idVendor) &&
1603 (hid_blacklist[n].idProduct == dev->descriptor.idProduct))
1604 quirks = hid_blacklist[n].quirks;
1606 if (quirks & HID_QUIRK_IGNORE)
1609 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) && ((!interface->desc.bNumEndpoints) ||
1610 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
1611 dbg("class descriptor not present\n");
1615 for (n = 0; n < hdesc->bNumDescriptors; n++)
1616 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
1617 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
1619 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
1620 dbg("weird size of report descriptor (%u)", rsize);
1624 if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
1625 dbg("couldn't allocate rdesc memory");
1629 if ((n = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber, HID_DT_REPORT, rdesc, rsize)) < 0) {
1630 dbg("reading report descriptor failed");
1636 printk(KERN_DEBUG __FILE__ ": report descriptor (size %u, read %d) = ", rsize, n);
1637 for (n = 0; n < rsize; n++)
1638 printk(" %02x", (unsigned char) rdesc[n]);
1642 if (!(hid = hid_parse_report(rdesc, rsize))) {
1643 dbg("parsing report descriptor failed");
1649 hid->quirks = quirks;
1651 if (hid_alloc_buffers(dev, hid)) {
1652 hid_free_buffers(dev, hid);
1656 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
1658 struct usb_endpoint_descriptor *endpoint;
1662 endpoint = &interface->endpoint[n].desc;
1663 if ((endpoint->bmAttributes & 3) != 3) /* Not an interrupt endpoint */
1666 /* handle potential highspeed HID correctly */
1667 interval = endpoint->bInterval;
1668 if (dev->speed == USB_SPEED_HIGH)
1669 interval = 1 << (interval - 1);
1671 if (endpoint->bEndpointAddress & USB_DIR_IN) {
1676 if (!(hid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
1678 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
1679 len = usb_maxpacket(dev, pipe, 0);
1680 if (len > HID_BUFFER_SIZE)
1681 len = HID_BUFFER_SIZE;
1682 usb_fill_int_urb(hid->urbin, dev, pipe, hid->inbuf, len,
1683 hid_irq_in, hid, interval);
1684 hid->urbin->transfer_dma = hid->inbuf_dma;
1685 hid->urbin->transfer_flags |=(URB_NO_TRANSFER_DMA_MAP | URB_ASYNC_UNLINK);
1689 if (!(hid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
1691 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
1692 usb_fill_int_urb(hid->urbout, dev, pipe, hid->outbuf, 0,
1693 hid_irq_out, hid, interval);
1694 hid->urbout->transfer_dma = hid->outbuf_dma;
1695 hid->urbout->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_ASYNC_UNLINK);
1700 err("couldn't find an input interrupt endpoint");
1704 init_waitqueue_head(&hid->wait);
1706 spin_lock_init(&hid->outlock);
1707 spin_lock_init(&hid->ctrllock);
1709 hid->version = le16_to_cpu(hdesc->bcdHID);
1710 hid->country = hdesc->bCountryCode;
1713 hid->ifnum = interface->desc.bInterfaceNumber;
1717 if (!(buf = kmalloc(64, GFP_KERNEL)))
1720 if (usb_string(dev, dev->descriptor.iManufacturer, buf, 64) > 0) {
1721 strcat(hid->name, buf);
1722 if (usb_string(dev, dev->descriptor.iProduct, buf, 64) > 0)
1723 snprintf(hid->name, 64, "%s %s", hid->name, buf);
1724 } else if (usb_string(dev, dev->descriptor.iProduct, buf, 128) > 0) {
1725 snprintf(hid->name, 128, "%s", buf);
1727 snprintf(hid->name, 128, "%04x:%04x", dev->descriptor.idVendor, dev->descriptor.idProduct);
1729 usb_make_path(dev, buf, 64);
1730 snprintf(hid->phys, 64, "%s/input%d", buf,
1731 intf->altsetting[0].desc.bInterfaceNumber);
1733 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
1738 hid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
1741 usb_fill_control_urb(hid->urbctrl, dev, 0, (void *) hid->cr,
1742 hid->ctrlbuf, 1, hid_ctrl, hid);
1743 hid->urbctrl->setup_dma = hid->cr_dma;
1744 hid->urbctrl->transfer_dma = hid->ctrlbuf_dma;
1745 hid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP | URB_ASYNC_UNLINK);
1752 usb_free_urb(hid->urbin);
1754 usb_free_urb(hid->urbout);
1756 usb_free_urb(hid->urbctrl);
1757 hid_free_buffers(dev, hid);
1758 hid_free_device(hid);
1763 static void hid_disconnect(struct usb_interface *intf)
1765 struct hid_device *hid = usb_get_intfdata (intf);
1770 usb_set_intfdata(intf, NULL);
1771 usb_kill_urb(hid->urbin);
1772 usb_kill_urb(hid->urbout);
1773 usb_kill_urb(hid->urbctrl);
1775 if (hid->claimed & HID_CLAIMED_INPUT)
1776 hidinput_disconnect(hid);
1777 if (hid->claimed & HID_CLAIMED_HIDDEV)
1778 hiddev_disconnect(hid);
1780 usb_free_urb(hid->urbin);
1781 usb_free_urb(hid->urbctrl);
1783 usb_free_urb(hid->urbout);
1785 hid_free_buffers(hid->dev, hid);
1786 hid_free_device(hid);
1789 static int hid_probe (struct usb_interface *intf, const struct usb_device_id *id)
1791 struct hid_device *hid;
1796 dbg("HID probe called for ifnum %d",
1797 intf->altsetting->desc.bInterfaceNumber);
1799 if (!(hid = usb_hid_configure(intf)))
1802 hid_init_reports(hid);
1803 hid_dump_device(hid);
1805 if (!hidinput_connect(hid))
1806 hid->claimed |= HID_CLAIMED_INPUT;
1807 if (!hiddev_connect(hid))
1808 hid->claimed |= HID_CLAIMED_HIDDEV;
1810 usb_set_intfdata(intf, hid);
1812 if (!hid->claimed) {
1813 printk ("HID device not claimed by input or hiddev\n");
1814 hid_disconnect(intf);
1820 if (hid->claimed & HID_CLAIMED_INPUT)
1822 if (hid->claimed == (HID_CLAIMED_INPUT | HID_CLAIMED_HIDDEV))
1824 if (hid->claimed & HID_CLAIMED_HIDDEV)
1825 printk("hiddev%d", hid->minor);
1828 for (i = 0; i < hid->maxcollection; i++) {
1829 if (hid->collection[i].type == HID_COLLECTION_APPLICATION &&
1830 (hid->collection[i].usage & HID_USAGE_PAGE) == HID_UP_GENDESK &&
1831 (hid->collection[i].usage & 0xffff) < ARRAY_SIZE(hid_types)) {
1832 c = hid_types[hid->collection[i].usage & 0xffff];
1837 usb_make_path(interface_to_usbdev(intf), path, 63);
1839 printk(": USB HID v%x.%02x %s [%s] on %s\n",
1840 hid->version >> 8, hid->version & 0xff, c, hid->name, path);
1845 static int hid_suspend(struct usb_interface *intf, u32 state)
1847 struct hid_device *hid = usb_get_intfdata (intf);
1849 usb_kill_urb(hid->urbin);
1850 intf->dev.power.power_state = state;
1851 dev_dbg(&intf->dev, "suspend\n");
1855 static int hid_resume(struct usb_interface *intf)
1857 struct hid_device *hid = usb_get_intfdata (intf);
1860 intf->dev.power.power_state = PM_SUSPEND_ON;
1862 status = usb_submit_urb(hid->urbin, GFP_NOIO);
1865 dev_dbg(&intf->dev, "resume status %d\n", status);
1869 static struct usb_device_id hid_usb_ids [] = {
1870 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1871 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1872 { } /* Terminating entry */
1875 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1877 static struct usb_driver hid_driver = {
1878 .owner = THIS_MODULE,
1881 .disconnect = hid_disconnect,
1882 .suspend = hid_suspend,
1883 .resume = hid_resume,
1884 .id_table = hid_usb_ids,
1887 static int __init hid_init(void)
1890 retval = hiddev_init();
1892 goto hiddev_init_fail;
1893 retval = usb_register(&hid_driver);
1895 goto usb_register_fail;
1896 info(DRIVER_VERSION ":" DRIVER_DESC);
1905 static void __exit hid_exit(void)
1907 usb_deregister(&hid_driver);
1911 module_init(hid_init);
1912 module_exit(hid_exit);
1914 MODULE_AUTHOR(DRIVER_AUTHOR);
1915 MODULE_DESCRIPTION(DRIVER_DESC);
1916 MODULE_LICENSE(DRIVER_LICENSE);