blob: 5de931cf4cfbe12df26d8f7f0b91ed7c39bcbb7b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * USB HID support for Linux
3 *
4 * Copyright (c) 1999 Andreas Gal
Michael Haboustakbf0964d2005-09-05 00:12:01 -05005 * Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
6 * Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 */
8
9/*
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the Free
12 * Software Foundation; either version 2 of the License, or (at your option)
13 * any later version.
14 */
15
16#include <linux/module.h>
17#include <linux/slab.h>
18#include <linux/init.h>
19#include <linux/kernel.h>
20#include <linux/sched.h>
21#include <linux/list.h>
22#include <linux/mm.h>
23#include <linux/smp_lock.h>
24#include <linux/spinlock.h>
25#include <asm/unaligned.h>
26#include <asm/byteorder.h>
27#include <linux/input.h>
28#include <linux/wait.h>
29
30#undef DEBUG
31#undef DEBUG_DATA
32
33#include <linux/usb.h>
34
35#include "hid.h"
36#include <linux/hiddev.h>
37
38/*
39 * Version Information
40 */
41
Michael Haboustakbf0964d2005-09-05 00:12:01 -050042#define DRIVER_VERSION "v2.6"
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#define DRIVER_AUTHOR "Andreas Gal, Vojtech Pavlik"
44#define DRIVER_DESC "USB HID core driver"
45#define DRIVER_LICENSE "GPL"
46
47static char *hid_types[] = {"Device", "Pointer", "Mouse", "Device", "Joystick",
48 "Gamepad", "Keyboard", "Keypad", "Multi-Axis Controller"};
49/*
50 * Module parameters.
51 */
52
53static unsigned int hid_mousepoll_interval;
54module_param_named(mousepoll, hid_mousepoll_interval, uint, 0644);
55MODULE_PARM_DESC(mousepoll, "Polling interval of mice");
56
57/*
58 * Register a new report for a device.
59 */
60
61static struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id)
62{
63 struct hid_report_enum *report_enum = device->report_enum + type;
64 struct hid_report *report;
65
66 if (report_enum->report_id_hash[id])
67 return report_enum->report_id_hash[id];
68
Oliver Neukumbbdb7da2006-01-06 20:54:29 +010069 if (!(report = kzalloc(sizeof(struct hid_report), GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
72 if (id != 0)
73 report_enum->numbered = 1;
74
75 report->id = id;
76 report->type = type;
77 report->size = 0;
78 report->device = device;
79 report_enum->report_id_hash[id] = report;
80
81 list_add_tail(&report->list, &report_enum->report_list);
82
83 return report;
84}
85
86/*
87 * Register a new field for this report.
88 */
89
90static struct hid_field *hid_register_field(struct hid_report *report, unsigned usages, unsigned values)
91{
92 struct hid_field *field;
93
94 if (report->maxfield == HID_MAX_FIELDS) {
95 dbg("too many fields in report");
96 return NULL;
97 }
98
Oliver Neukumbbdb7da2006-01-06 20:54:29 +010099 if (!(field = kzalloc(sizeof(struct hid_field) + usages * sizeof(struct hid_usage)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 + values * sizeof(unsigned), GFP_KERNEL))) return NULL;
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 field->index = report->maxfield++;
103 report->field[field->index] = field;
104 field->usage = (struct hid_usage *)(field + 1);
105 field->value = (unsigned *)(field->usage + usages);
106 field->report = report;
107
108 return field;
109}
110
111/*
112 * Open a collection. The type/usage is pushed on the stack.
113 */
114
115static int open_collection(struct hid_parser *parser, unsigned type)
116{
117 struct hid_collection *collection;
118 unsigned usage;
119
120 usage = parser->local.usage[0];
121
122 if (parser->collection_stack_ptr == HID_COLLECTION_STACK_SIZE) {
123 dbg("collection stack overflow");
124 return -1;
125 }
126
127 if (parser->device->maxcollection == parser->device->collection_size) {
128 collection = kmalloc(sizeof(struct hid_collection) *
129 parser->device->collection_size * 2, GFP_KERNEL);
130 if (collection == NULL) {
131 dbg("failed to reallocate collection array");
132 return -1;
133 }
134 memcpy(collection, parser->device->collection,
135 sizeof(struct hid_collection) *
136 parser->device->collection_size);
137 memset(collection + parser->device->collection_size, 0,
138 sizeof(struct hid_collection) *
139 parser->device->collection_size);
140 kfree(parser->device->collection);
141 parser->device->collection = collection;
142 parser->device->collection_size *= 2;
143 }
144
145 parser->collection_stack[parser->collection_stack_ptr++] =
146 parser->device->maxcollection;
147
148 collection = parser->device->collection +
149 parser->device->maxcollection++;
150 collection->type = type;
151 collection->usage = usage;
152 collection->level = parser->collection_stack_ptr - 1;
153
154 if (type == HID_COLLECTION_APPLICATION)
155 parser->device->maxapplication++;
156
157 return 0;
158}
159
160/*
161 * Close a collection.
162 */
163
164static int close_collection(struct hid_parser *parser)
165{
166 if (!parser->collection_stack_ptr) {
167 dbg("collection stack underflow");
168 return -1;
169 }
170 parser->collection_stack_ptr--;
171 return 0;
172}
173
174/*
175 * Climb up the stack, search for the specified collection type
176 * and return the usage.
177 */
178
179static unsigned hid_lookup_collection(struct hid_parser *parser, unsigned type)
180{
181 int n;
182 for (n = parser->collection_stack_ptr - 1; n >= 0; n--)
183 if (parser->device->collection[parser->collection_stack[n]].type == type)
184 return parser->device->collection[parser->collection_stack[n]].usage;
185 return 0; /* we know nothing about this usage type */
186}
187
188/*
189 * Add a usage to the temporary parser table.
190 */
191
192static int hid_add_usage(struct hid_parser *parser, unsigned usage)
193{
194 if (parser->local.usage_index >= HID_MAX_USAGES) {
195 dbg("usage index exceeded");
196 return -1;
197 }
198 parser->local.usage[parser->local.usage_index] = usage;
199 parser->local.collection_index[parser->local.usage_index] =
200 parser->collection_stack_ptr ?
201 parser->collection_stack[parser->collection_stack_ptr - 1] : 0;
202 parser->local.usage_index++;
203 return 0;
204}
205
206/*
207 * Register a new field for this report.
208 */
209
210static int hid_add_field(struct hid_parser *parser, unsigned report_type, unsigned flags)
211{
212 struct hid_report *report;
213 struct hid_field *field;
214 int usages;
215 unsigned offset;
216 int i;
217
218 if (!(report = hid_register_report(parser->device, report_type, parser->global.report_id))) {
219 dbg("hid_register_report failed");
220 return -1;
221 }
222
223 if (parser->global.logical_maximum < parser->global.logical_minimum) {
224 dbg("logical range invalid %d %d", parser->global.logical_minimum, parser->global.logical_maximum);
225 return -1;
226 }
227
228 offset = report->size;
229 report->size += parser->global.report_size * parser->global.report_count;
230
231 if (!parser->local.usage_index) /* Ignore padding fields */
Dmitry Torokhov05f091a2005-05-29 02:29:01 -0500232 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
234 usages = max_t(int, parser->local.usage_index, parser->global.report_count);
235
236 if ((field = hid_register_field(report, usages, parser->global.report_count)) == NULL)
237 return 0;
238
239 field->physical = hid_lookup_collection(parser, HID_COLLECTION_PHYSICAL);
240 field->logical = hid_lookup_collection(parser, HID_COLLECTION_LOGICAL);
241 field->application = hid_lookup_collection(parser, HID_COLLECTION_APPLICATION);
242
243 for (i = 0; i < usages; i++) {
244 int j = i;
245 /* Duplicate the last usage we parsed if we have excess values */
246 if (i >= parser->local.usage_index)
247 j = parser->local.usage_index - 1;
248 field->usage[i].hid = parser->local.usage[j];
249 field->usage[i].collection_index =
250 parser->local.collection_index[j];
251 }
252
253 field->maxusage = usages;
254 field->flags = flags;
255 field->report_offset = offset;
256 field->report_type = report_type;
257 field->report_size = parser->global.report_size;
258 field->report_count = parser->global.report_count;
259 field->logical_minimum = parser->global.logical_minimum;
260 field->logical_maximum = parser->global.logical_maximum;
261 field->physical_minimum = parser->global.physical_minimum;
262 field->physical_maximum = parser->global.physical_maximum;
263 field->unit_exponent = parser->global.unit_exponent;
264 field->unit = parser->global.unit;
265
266 return 0;
267}
268
269/*
270 * Read data value from item.
271 */
272
Grant Grundler68717952006-10-19 15:09:51 -0700273static u32 item_udata(struct hid_item *item)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274{
275 switch (item->size) {
276 case 1: return item->data.u8;
277 case 2: return item->data.u16;
278 case 4: return item->data.u32;
279 }
280 return 0;
281}
282
Grant Grundler68717952006-10-19 15:09:51 -0700283static s32 item_sdata(struct hid_item *item)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284{
285 switch (item->size) {
286 case 1: return item->data.s8;
287 case 2: return item->data.s16;
288 case 4: return item->data.s32;
289 }
290 return 0;
291}
292
293/*
294 * Process a global item.
295 */
296
297static int hid_parser_global(struct hid_parser *parser, struct hid_item *item)
298{
299 switch (item->tag) {
300
301 case HID_GLOBAL_ITEM_TAG_PUSH:
302
303 if (parser->global_stack_ptr == HID_GLOBAL_STACK_SIZE) {
304 dbg("global enviroment stack overflow");
305 return -1;
306 }
307
308 memcpy(parser->global_stack + parser->global_stack_ptr++,
309 &parser->global, sizeof(struct hid_global));
310 return 0;
311
312 case HID_GLOBAL_ITEM_TAG_POP:
313
314 if (!parser->global_stack_ptr) {
315 dbg("global enviroment stack underflow");
316 return -1;
317 }
318
319 memcpy(&parser->global, parser->global_stack + --parser->global_stack_ptr,
320 sizeof(struct hid_global));
321 return 0;
322
323 case HID_GLOBAL_ITEM_TAG_USAGE_PAGE:
324 parser->global.usage_page = item_udata(item);
325 return 0;
326
327 case HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM:
328 parser->global.logical_minimum = item_sdata(item);
329 return 0;
330
331 case HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM:
332 if (parser->global.logical_minimum < 0)
333 parser->global.logical_maximum = item_sdata(item);
334 else
335 parser->global.logical_maximum = item_udata(item);
336 return 0;
337
338 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM:
339 parser->global.physical_minimum = item_sdata(item);
340 return 0;
341
342 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM:
343 if (parser->global.physical_minimum < 0)
344 parser->global.physical_maximum = item_sdata(item);
345 else
346 parser->global.physical_maximum = item_udata(item);
347 return 0;
348
349 case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT:
350 parser->global.unit_exponent = item_sdata(item);
351 return 0;
352
353 case HID_GLOBAL_ITEM_TAG_UNIT:
354 parser->global.unit = item_udata(item);
355 return 0;
356
357 case HID_GLOBAL_ITEM_TAG_REPORT_SIZE:
358 if ((parser->global.report_size = item_udata(item)) > 32) {
359 dbg("invalid report_size %d", parser->global.report_size);
360 return -1;
361 }
362 return 0;
363
364 case HID_GLOBAL_ITEM_TAG_REPORT_COUNT:
365 if ((parser->global.report_count = item_udata(item)) > HID_MAX_USAGES) {
366 dbg("invalid report_count %d", parser->global.report_count);
367 return -1;
368 }
369 return 0;
370
371 case HID_GLOBAL_ITEM_TAG_REPORT_ID:
372 if ((parser->global.report_id = item_udata(item)) == 0) {
373 dbg("report_id 0 is invalid");
374 return -1;
375 }
376 return 0;
377
378 default:
379 dbg("unknown global tag 0x%x", item->tag);
380 return -1;
381 }
382}
383
384/*
385 * Process a local item.
386 */
387
388static int hid_parser_local(struct hid_parser *parser, struct hid_item *item)
389{
390 __u32 data;
391 unsigned n;
392
393 if (item->size == 0) {
394 dbg("item data expected for local item");
395 return -1;
396 }
397
398 data = item_udata(item);
399
400 switch (item->tag) {
401
402 case HID_LOCAL_ITEM_TAG_DELIMITER:
403
404 if (data) {
405 /*
406 * We treat items before the first delimiter
407 * as global to all usage sets (branch 0).
408 * In the moment we process only these global
409 * items and the first delimiter set.
410 */
411 if (parser->local.delimiter_depth != 0) {
412 dbg("nested delimiters");
413 return -1;
414 }
415 parser->local.delimiter_depth++;
416 parser->local.delimiter_branch++;
417 } else {
418 if (parser->local.delimiter_depth < 1) {
419 dbg("bogus close delimiter");
420 return -1;
421 }
422 parser->local.delimiter_depth--;
423 }
424 return 1;
425
426 case HID_LOCAL_ITEM_TAG_USAGE:
427
428 if (parser->local.delimiter_branch > 1) {
429 dbg("alternative usage ignored");
430 return 0;
431 }
432
433 if (item->size <= 2)
434 data = (parser->global.usage_page << 16) + data;
435
436 return hid_add_usage(parser, data);
437
438 case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:
439
440 if (parser->local.delimiter_branch > 1) {
441 dbg("alternative usage ignored");
442 return 0;
443 }
444
445 if (item->size <= 2)
446 data = (parser->global.usage_page << 16) + data;
447
448 parser->local.usage_minimum = data;
449 return 0;
450
451 case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:
452
453 if (parser->local.delimiter_branch > 1) {
454 dbg("alternative usage ignored");
455 return 0;
456 }
457
458 if (item->size <= 2)
459 data = (parser->global.usage_page << 16) + data;
460
461 for (n = parser->local.usage_minimum; n <= data; n++)
462 if (hid_add_usage(parser, n)) {
463 dbg("hid_add_usage failed\n");
464 return -1;
465 }
466 return 0;
467
468 default:
469
470 dbg("unknown local item tag 0x%x", item->tag);
471 return 0;
472 }
473 return 0;
474}
475
476/*
477 * Process a main item.
478 */
479
480static int hid_parser_main(struct hid_parser *parser, struct hid_item *item)
481{
482 __u32 data;
483 int ret;
484
485 data = item_udata(item);
486
487 switch (item->tag) {
488 case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION:
489 ret = open_collection(parser, data & 0xff);
490 break;
491 case HID_MAIN_ITEM_TAG_END_COLLECTION:
492 ret = close_collection(parser);
493 break;
494 case HID_MAIN_ITEM_TAG_INPUT:
495 ret = hid_add_field(parser, HID_INPUT_REPORT, data);
496 break;
497 case HID_MAIN_ITEM_TAG_OUTPUT:
498 ret = hid_add_field(parser, HID_OUTPUT_REPORT, data);
499 break;
500 case HID_MAIN_ITEM_TAG_FEATURE:
501 ret = hid_add_field(parser, HID_FEATURE_REPORT, data);
502 break;
503 default:
504 dbg("unknown main item tag 0x%x", item->tag);
505 ret = 0;
506 }
507
508 memset(&parser->local, 0, sizeof(parser->local)); /* Reset the local parser environment */
509
510 return ret;
511}
512
513/*
514 * Process a reserved item.
515 */
516
517static int hid_parser_reserved(struct hid_parser *parser, struct hid_item *item)
518{
519 dbg("reserved item type, tag 0x%x", item->tag);
520 return 0;
521}
522
523/*
524 * Free a report and all registered fields. The field->usage and
525 * field->value table's are allocated behind the field, so we need
526 * only to free(field) itself.
527 */
528
529static void hid_free_report(struct hid_report *report)
530{
531 unsigned n;
532
533 for (n = 0; n < report->maxfield; n++)
534 kfree(report->field[n]);
535 kfree(report);
536}
537
538/*
539 * Free a device structure, all reports, and all fields.
540 */
541
542static void hid_free_device(struct hid_device *device)
543{
544 unsigned i,j;
545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 for (i = 0; i < HID_REPORT_TYPES; i++) {
547 struct hid_report_enum *report_enum = device->report_enum + i;
548
549 for (j = 0; j < 256; j++) {
550 struct hid_report *report = report_enum->report_id_hash[j];
551 if (report)
552 hid_free_report(report);
553 }
554 }
555
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700556 kfree(device->rdesc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 kfree(device);
558}
559
560/*
561 * Fetch a report description item from the data stream. We support long
562 * items, though they are not used yet.
563 */
564
565static u8 *fetch_item(__u8 *start, __u8 *end, struct hid_item *item)
566{
567 u8 b;
568
569 if ((end - start) <= 0)
570 return NULL;
571
572 b = *start++;
573
574 item->type = (b >> 2) & 3;
575 item->tag = (b >> 4) & 15;
576
577 if (item->tag == HID_ITEM_TAG_LONG) {
578
579 item->format = HID_ITEM_FORMAT_LONG;
580
581 if ((end - start) < 2)
582 return NULL;
583
584 item->size = *start++;
585 item->tag = *start++;
586
587 if ((end - start) < item->size)
588 return NULL;
589
590 item->data.longdata = start;
591 start += item->size;
592 return start;
593 }
594
595 item->format = HID_ITEM_FORMAT_SHORT;
596 item->size = b & 3;
597
598 switch (item->size) {
599
600 case 0:
601 return start;
602
603 case 1:
604 if ((end - start) < 1)
605 return NULL;
606 item->data.u8 = *start++;
607 return start;
608
609 case 2:
610 if ((end - start) < 2)
611 return NULL;
612 item->data.u16 = le16_to_cpu(get_unaligned((__le16*)start));
613 start = (__u8 *)((__le16 *)start + 1);
614 return start;
615
616 case 3:
617 item->size++;
618 if ((end - start) < 4)
619 return NULL;
620 item->data.u32 = le32_to_cpu(get_unaligned((__le32*)start));
621 start = (__u8 *)((__le32 *)start + 1);
622 return start;
623 }
624
625 return NULL;
626}
627
628/*
629 * Parse a report description into a hid_device structure. Reports are
630 * enumerated, fields are attached to these reports.
631 */
632
633static struct hid_device *hid_parse_report(__u8 *start, unsigned size)
634{
635 struct hid_device *device;
636 struct hid_parser *parser;
637 struct hid_item item;
638 __u8 *end;
639 unsigned i;
640 static int (*dispatch_type[])(struct hid_parser *parser,
641 struct hid_item *item) = {
642 hid_parser_main,
643 hid_parser_global,
644 hid_parser_local,
645 hid_parser_reserved
646 };
647
Oliver Neukumbbdb7da2006-01-06 20:54:29 +0100648 if (!(device = kzalloc(sizeof(struct hid_device), GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
Oliver Neukumbbdb7da2006-01-06 20:54:29 +0100651 if (!(device->collection = kzalloc(sizeof(struct hid_collection) *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 HID_DEFAULT_NUM_COLLECTIONS, GFP_KERNEL))) {
653 kfree(device);
654 return NULL;
655 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 device->collection_size = HID_DEFAULT_NUM_COLLECTIONS;
657
658 for (i = 0; i < HID_REPORT_TYPES; i++)
659 INIT_LIST_HEAD(&device->report_enum[i].report_list);
660
661 if (!(device->rdesc = (__u8 *)kmalloc(size, GFP_KERNEL))) {
662 kfree(device->collection);
663 kfree(device);
664 return NULL;
665 }
666 memcpy(device->rdesc, start, size);
667 device->rsize = size;
668
Oliver Neukumbbdb7da2006-01-06 20:54:29 +0100669 if (!(parser = kzalloc(sizeof(struct hid_parser), GFP_KERNEL))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 kfree(device->rdesc);
671 kfree(device->collection);
672 kfree(device);
673 return NULL;
674 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 parser->device = device;
676
677 end = start + size;
678 while ((start = fetch_item(start, end, &item)) != NULL) {
679
680 if (item.format != HID_ITEM_FORMAT_SHORT) {
681 dbg("unexpected long global item");
682 kfree(device->collection);
683 hid_free_device(device);
684 kfree(parser);
685 return NULL;
686 }
687
688 if (dispatch_type[item.type](parser, &item)) {
689 dbg("item %u %u %u %u parsing failed\n",
690 item.format, (unsigned)item.size, (unsigned)item.type, (unsigned)item.tag);
691 kfree(device->collection);
692 hid_free_device(device);
693 kfree(parser);
694 return NULL;
695 }
696
697 if (start == end) {
698 if (parser->collection_stack_ptr) {
699 dbg("unbalanced collection at end of report description");
700 kfree(device->collection);
701 hid_free_device(device);
702 kfree(parser);
703 return NULL;
704 }
705 if (parser->local.delimiter_depth) {
706 dbg("unbalanced delimiter at end of report description");
707 kfree(device->collection);
708 hid_free_device(device);
709 kfree(parser);
710 return NULL;
711 }
712 kfree(parser);
713 return device;
714 }
715 }
716
717 dbg("item fetching failed at offset %d\n", (int)(end - start));
718 kfree(device->collection);
719 hid_free_device(device);
720 kfree(parser);
721 return NULL;
722}
723
724/*
725 * Convert a signed n-bit integer to signed 32-bit integer. Common
726 * cases are done through the compiler, the screwed things has to be
727 * done by hand.
728 */
729
Grant Grundler68717952006-10-19 15:09:51 -0700730static s32 snto32(__u32 value, unsigned n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731{
732 switch (n) {
733 case 8: return ((__s8)value);
734 case 16: return ((__s16)value);
735 case 32: return ((__s32)value);
736 }
737 return value & (1 << (n - 1)) ? value | (-1 << n) : value;
738}
739
740/*
741 * Convert a signed 32-bit integer to a signed n-bit integer.
742 */
743
Grant Grundler68717952006-10-19 15:09:51 -0700744static u32 s32ton(__s32 value, unsigned n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745{
Grant Grundler68717952006-10-19 15:09:51 -0700746 s32 a = value >> (n - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 if (a && a != -1)
748 return value < 0 ? 1 << (n - 1) : (1 << (n - 1)) - 1;
749 return value & ((1 << n) - 1);
750}
751
752/*
Grant Grundler45507182006-10-10 14:42:51 -0700753 * Extract/implement a data field from/to a little endian report (bit array).
Grant Grundler68717952006-10-19 15:09:51 -0700754 *
755 * Code sort-of follows HID spec:
756 * http://www.usb.org/developers/devclass_docs/HID1_11.pdf
757 *
758 * While the USB HID spec allows unlimited length bit fields in "report
759 * descriptors", most devices never use more than 16 bits.
760 * One model of UPS is claimed to report "LINEV" as a 32-bit field.
761 * Search linux-kernel and linux-usb-devel archives for "hid-core extract".
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 */
763
764static __inline__ __u32 extract(__u8 *report, unsigned offset, unsigned n)
765{
Grant Grundler68717952006-10-19 15:09:51 -0700766 u64 x;
767
768 WARN_ON(n > 32);
Grant Grundler45507182006-10-10 14:42:51 -0700769
770 report += offset >> 3; /* adjust byte index */
Grant Grundler68717952006-10-19 15:09:51 -0700771 offset &= 7; /* now only need bit offset into one byte */
772 x = get_unaligned((u64 *) report);
773 x = le64_to_cpu(x);
774 x = (x >> offset) & ((1ULL << n) - 1); /* extract bit field */
775 return (u32) x;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776}
777
Grant Grundler68717952006-10-19 15:09:51 -0700778/*
779 * "implement" : set bits in a little endian bit stream.
780 * Same concepts as "extract" (see comments above).
781 * The data mangled in the bit stream remains in little endian
782 * order the whole time. It make more sense to talk about
783 * endianness of register values by considering a register
784 * a "cached" copy of the little endiad bit stream.
785 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786static __inline__ void implement(__u8 *report, unsigned offset, unsigned n, __u32 value)
787{
Grant Grundler68717952006-10-19 15:09:51 -0700788 u64 x;
789 u64 m = (1ULL << n) - 1;
790
791 WARN_ON(n > 32);
792
793 WARN_ON(value > m);
794 value &= m;
Grant Grundler45507182006-10-10 14:42:51 -0700795
796 report += offset >> 3;
Grant Grundler68717952006-10-19 15:09:51 -0700797 offset &= 7;
798
799 x = get_unaligned((u64 *)report);
800 x &= cpu_to_le64(~(m << offset));
801 x |= cpu_to_le64(((u64) value) << offset);
802 put_unaligned(x, (u64 *) report);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803}
804
805/*
806 * Search an array for a value.
807 */
808
809static __inline__ int search(__s32 *array, __s32 value, unsigned n)
810{
811 while (n--) {
812 if (*array++ == value)
813 return 0;
814 }
815 return -1;
816}
817
David Howells7d12e782006-10-05 14:55:46 +0100818static void hid_process_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value, int interrupt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819{
820 hid_dump_input(usage, value);
821 if (hid->claimed & HID_CLAIMED_INPUT)
David Howells7d12e782006-10-05 14:55:46 +0100822 hidinput_hid_event(hid, field, usage, value);
Adam Kropelinbc5d0482005-07-11 01:09:32 -0500823 if (hid->claimed & HID_CLAIMED_HIDDEV && interrupt)
David Howells7d12e782006-10-05 14:55:46 +0100824 hiddev_hid_event(hid, field, usage, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825}
826
827/*
828 * Analyse a received field, and fetch the data from it. The field
829 * content is stored for next report processing (we do differential
830 * reporting to the layer).
831 */
832
David Howells7d12e782006-10-05 14:55:46 +0100833static void hid_input_field(struct hid_device *hid, struct hid_field *field, __u8 *data, int interrupt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834{
835 unsigned n;
836 unsigned count = field->report_count;
837 unsigned offset = field->report_offset;
838 unsigned size = field->report_size;
839 __s32 min = field->logical_minimum;
840 __s32 max = field->logical_maximum;
841 __s32 *value;
842
843 if (!(value = kmalloc(sizeof(__s32) * count, GFP_ATOMIC)))
844 return;
845
846 for (n = 0; n < count; n++) {
847
848 value[n] = min < 0 ? snto32(extract(data, offset + n * size, size), size) :
849 extract(data, offset + n * size, size);
850
851 if (!(field->flags & HID_MAIN_ITEM_VARIABLE) /* Ignore report if ErrorRollOver */
852 && value[n] >= min && value[n] <= max
853 && field->usage[value[n] - min].hid == HID_UP_KEYBOARD + 1)
854 goto exit;
855 }
856
857 for (n = 0; n < count; n++) {
858
859 if (HID_MAIN_ITEM_VARIABLE & field->flags) {
David Howells7d12e782006-10-05 14:55:46 +0100860 hid_process_event(hid, field, &field->usage[n], value[n], interrupt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 continue;
862 }
863
864 if (field->value[n] >= min && field->value[n] <= max
865 && field->usage[field->value[n] - min].hid
866 && search(value, field->value[n], count))
David Howells7d12e782006-10-05 14:55:46 +0100867 hid_process_event(hid, field, &field->usage[field->value[n] - min], 0, interrupt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868
869 if (value[n] >= min && value[n] <= max
870 && field->usage[value[n] - min].hid
871 && search(field->value, value[n], count))
David Howells7d12e782006-10-05 14:55:46 +0100872 hid_process_event(hid, field, &field->usage[value[n] - min], 1, interrupt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 }
874
875 memcpy(field->value, value, count * sizeof(__s32));
876exit:
877 kfree(value);
878}
879
David Howells7d12e782006-10-05 14:55:46 +0100880static int hid_input_report(int type, struct urb *urb, int interrupt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881{
882 struct hid_device *hid = urb->context;
883 struct hid_report_enum *report_enum = hid->report_enum + type;
884 u8 *data = urb->transfer_buffer;
885 int len = urb->actual_length;
886 struct hid_report *report;
887 int n, size;
888
889 if (!len) {
890 dbg("empty report");
891 return -1;
892 }
893
894#ifdef DEBUG_DATA
895 printk(KERN_DEBUG __FILE__ ": report (size %u) (%snumbered)\n", len, report_enum->numbered ? "" : "un");
896#endif
897
898 n = 0; /* Normally report number is 0 */
899 if (report_enum->numbered) { /* Device uses numbered reports, data[0] is report number */
900 n = *data++;
901 len--;
902 }
903
904#ifdef DEBUG_DATA
905 {
906 int i;
907 printk(KERN_DEBUG __FILE__ ": report %d (size %u) = ", n, len);
908 for (i = 0; i < len; i++)
909 printk(" %02x", data[i]);
910 printk("\n");
911 }
912#endif
913
914 if (!(report = report_enum->report_id_hash[n])) {
915 dbg("undefined report_id %d received", n);
916 return -1;
917 }
918
919 size = ((report->size - 1) >> 3) + 1;
920
Adam Kropelincd610452005-12-13 17:03:39 -0800921 if (len < size) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 dbg("report %d is too short, (%d < %d)", report->id, len, size);
Adam Kropelincd610452005-12-13 17:03:39 -0800923 memset(data + len, 0, size - len);
924 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925
926 if (hid->claimed & HID_CLAIMED_HIDDEV)
927 hiddev_report_event(hid, report);
928
929 for (n = 0; n < report->maxfield; n++)
David Howells7d12e782006-10-05 14:55:46 +0100930 hid_input_field(hid, report->field[n], data, interrupt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931
932 if (hid->claimed & HID_CLAIMED_INPUT)
933 hidinput_report_event(hid, report);
934
935 return 0;
936}
937
938/*
Alan Sternaef4e262006-01-31 12:58:38 -0500939 * Input submission and I/O error handler.
940 */
941
942static void hid_io_error(struct hid_device *hid);
943
944/* Start up the input URB */
945static int hid_start_in(struct hid_device *hid)
946{
947 unsigned long flags;
948 int rc = 0;
949
950 spin_lock_irqsave(&hid->inlock, flags);
951 if (hid->open > 0 && !test_bit(HID_SUSPENDED, &hid->iofl) &&
952 !test_and_set_bit(HID_IN_RUNNING, &hid->iofl)) {
953 rc = usb_submit_urb(hid->urbin, GFP_ATOMIC);
954 if (rc != 0)
955 clear_bit(HID_IN_RUNNING, &hid->iofl);
956 }
957 spin_unlock_irqrestore(&hid->inlock, flags);
958 return rc;
959}
960
961/* I/O retry timer routine */
962static void hid_retry_timeout(unsigned long _hid)
963{
964 struct hid_device *hid = (struct hid_device *) _hid;
965
966 dev_dbg(&hid->intf->dev, "retrying intr urb\n");
967 if (hid_start_in(hid))
968 hid_io_error(hid);
969}
970
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400971/* Workqueue routine to reset the device or clear a halt */
Alan Sternaef4e262006-01-31 12:58:38 -0500972static void hid_reset(void *_hid)
973{
974 struct hid_device *hid = (struct hid_device *) _hid;
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400975 int rc_lock, rc = 0;
Alan Sternaef4e262006-01-31 12:58:38 -0500976
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400977 if (test_bit(HID_CLEAR_HALT, &hid->iofl)) {
978 dev_dbg(&hid->intf->dev, "clear halt\n");
979 rc = usb_clear_halt(hid->dev, hid->urbin->pipe);
980 clear_bit(HID_CLEAR_HALT, &hid->iofl);
981 hid_start_in(hid);
Alan Sternaef4e262006-01-31 12:58:38 -0500982 }
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400983
984 else if (test_bit(HID_RESET_PENDING, &hid->iofl)) {
985 dev_dbg(&hid->intf->dev, "resetting device\n");
986 rc = rc_lock = usb_lock_device_for_reset(hid->dev, hid->intf);
987 if (rc_lock >= 0) {
988 rc = usb_reset_composite_device(hid->dev, hid->intf);
989 if (rc_lock)
990 usb_unlock_device(hid->dev);
991 }
992 clear_bit(HID_RESET_PENDING, &hid->iofl);
993 }
Alan Sternaef4e262006-01-31 12:58:38 -0500994
Alan Sterndf9a1f42006-06-01 13:55:28 -0400995 switch (rc) {
996 case 0:
997 if (!test_bit(HID_IN_RUNNING, &hid->iofl))
Alan Sternaef4e262006-01-31 12:58:38 -0500998 hid_io_error(hid);
Alan Sterndf9a1f42006-06-01 13:55:28 -0400999 break;
1000 default:
Alan Sternaef4e262006-01-31 12:58:38 -05001001 err("can't reset device, %s-%s/input%d, status %d",
1002 hid->dev->bus->bus_name,
1003 hid->dev->devpath,
1004 hid->ifnum, rc);
Alan Sterndf9a1f42006-06-01 13:55:28 -04001005 /* FALLTHROUGH */
1006 case -EHOSTUNREACH:
1007 case -ENODEV:
1008 case -EINTR:
1009 break;
1010 }
Alan Sternaef4e262006-01-31 12:58:38 -05001011}
1012
1013/* Main I/O error handler */
1014static void hid_io_error(struct hid_device *hid)
1015{
1016 unsigned long flags;
1017
1018 spin_lock_irqsave(&hid->inlock, flags);
1019
1020 /* Stop when disconnected */
1021 if (usb_get_intfdata(hid->intf) == NULL)
1022 goto done;
1023
1024 /* When an error occurs, retry at increasing intervals */
1025 if (hid->retry_delay == 0) {
1026 hid->retry_delay = 13; /* Then 26, 52, 104, 104, ... */
1027 hid->stop_retry = jiffies + msecs_to_jiffies(1000);
1028 } else if (hid->retry_delay < 100)
1029 hid->retry_delay *= 2;
1030
1031 if (time_after(jiffies, hid->stop_retry)) {
1032
1033 /* Retries failed, so do a port reset */
1034 if (!test_and_set_bit(HID_RESET_PENDING, &hid->iofl)) {
Alan Stern6d8fc4d2006-10-18 12:35:24 -04001035 schedule_work(&hid->reset_work);
1036 goto done;
Alan Sternaef4e262006-01-31 12:58:38 -05001037 }
1038 }
1039
1040 mod_timer(&hid->io_retry,
1041 jiffies + msecs_to_jiffies(hid->retry_delay));
1042done:
1043 spin_unlock_irqrestore(&hid->inlock, flags);
1044}
1045
1046/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 * Input interrupt completion handler.
1048 */
1049
David Howells7d12e782006-10-05 14:55:46 +01001050static void hid_irq_in(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051{
1052 struct hid_device *hid = urb->context;
1053 int status;
1054
1055 switch (urb->status) {
1056 case 0: /* success */
Alan Sternaef4e262006-01-31 12:58:38 -05001057 hid->retry_delay = 0;
David Howells7d12e782006-10-05 14:55:46 +01001058 hid_input_report(HID_INPUT_REPORT, urb, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 break;
Alan Stern6d8fc4d2006-10-18 12:35:24 -04001060 case -EPIPE: /* stall */
1061 clear_bit(HID_IN_RUNNING, &hid->iofl);
1062 set_bit(HID_CLEAR_HALT, &hid->iofl);
1063 schedule_work(&hid->reset_work);
1064 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 case -ECONNRESET: /* unlink */
1066 case -ENOENT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 case -ESHUTDOWN: /* unplug */
Alan Sternaef4e262006-01-31 12:58:38 -05001068 clear_bit(HID_IN_RUNNING, &hid->iofl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 return;
Alan Sternaef4e262006-01-31 12:58:38 -05001070 case -EILSEQ: /* protocol error or unplug */
1071 case -EPROTO: /* protocol error or unplug */
Pete Zaitcev38e2bfc2006-09-18 22:49:02 -07001072 case -ETIME: /* protocol error or unplug */
1073 case -ETIMEDOUT: /* Should never happen, but... */
Alan Sternaef4e262006-01-31 12:58:38 -05001074 clear_bit(HID_IN_RUNNING, &hid->iofl);
1075 hid_io_error(hid);
1076 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 default: /* error */
1078 warn("input irq status %d received", urb->status);
1079 }
1080
1081 status = usb_submit_urb(urb, SLAB_ATOMIC);
Alan Sternaef4e262006-01-31 12:58:38 -05001082 if (status) {
1083 clear_bit(HID_IN_RUNNING, &hid->iofl);
1084 if (status != -EPERM) {
1085 err("can't resubmit intr, %s-%s/input%d, status %d",
1086 hid->dev->bus->bus_name,
1087 hid->dev->devpath,
1088 hid->ifnum, status);
1089 hid_io_error(hid);
1090 }
1091 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092}
1093
1094/*
1095 * Output the field into the report.
1096 */
1097
1098static void hid_output_field(struct hid_field *field, __u8 *data)
1099{
1100 unsigned count = field->report_count;
1101 unsigned offset = field->report_offset;
1102 unsigned size = field->report_size;
1103 unsigned n;
1104
1105 for (n = 0; n < count; n++) {
1106 if (field->logical_minimum < 0) /* signed values */
1107 implement(data, offset + n * size, size, s32ton(field->value[n], size));
1108 else /* unsigned values */
1109 implement(data, offset + n * size, size, field->value[n]);
1110 }
1111}
1112
1113/*
1114 * Create a report.
1115 */
1116
1117static void hid_output_report(struct hid_report *report, __u8 *data)
1118{
1119 unsigned n;
1120
1121 if (report->id > 0)
1122 *data++ = report->id;
1123
1124 for (n = 0; n < report->maxfield; n++)
1125 hid_output_field(report->field[n], data);
1126}
1127
1128/*
1129 * Set a field value. The report this field belongs to has to be
1130 * created and transferred to the device, to set this value in the
1131 * device.
1132 */
1133
1134int hid_set_field(struct hid_field *field, unsigned offset, __s32 value)
1135{
1136 unsigned size = field->report_size;
1137
1138 hid_dump_input(field->usage + offset, value);
1139
1140 if (offset >= field->report_count) {
1141 dbg("offset (%d) exceeds report_count (%d)", offset, field->report_count);
1142 hid_dump_field(field, 8);
1143 return -1;
1144 }
1145 if (field->logical_minimum < 0) {
1146 if (value != snto32(s32ton(value, size), size)) {
1147 dbg("value %d is out of range", value);
1148 return -1;
1149 }
1150 }
1151 field->value[offset] = value;
1152 return 0;
1153}
1154
1155/*
1156 * Find a report field with a specified HID usage.
1157 */
Adrian Bunkf287cae2006-08-04 23:00:02 -04001158#if 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159struct hid_field *hid_find_field_by_usage(struct hid_device *hid, __u32 wanted_usage, int type)
1160{
1161 struct hid_report *report;
1162 int i;
1163
1164 list_for_each_entry(report, &hid->report_enum[type].report_list, list)
1165 for (i = 0; i < report->maxfield; i++)
1166 if (report->field[i]->logical == wanted_usage)
1167 return report->field[i];
1168 return NULL;
1169}
Adrian Bunkf287cae2006-08-04 23:00:02 -04001170#endif /* 0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171
1172static int hid_submit_out(struct hid_device *hid)
1173{
1174 struct hid_report *report;
1175
1176 report = hid->out[hid->outtail];
1177
1178 hid_output_report(report, hid->outbuf);
1179 hid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
1180 hid->urbout->dev = hid->dev;
1181
1182 dbg("submitting out urb");
1183
1184 if (usb_submit_urb(hid->urbout, GFP_ATOMIC)) {
1185 err("usb_submit_urb(out) failed");
1186 return -1;
1187 }
1188
1189 return 0;
1190}
1191
1192static int hid_submit_ctrl(struct hid_device *hid)
1193{
1194 struct hid_report *report;
1195 unsigned char dir;
1196 int len;
1197
1198 report = hid->ctrl[hid->ctrltail].report;
1199 dir = hid->ctrl[hid->ctrltail].dir;
1200
1201 len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
1202 if (dir == USB_DIR_OUT) {
1203 hid_output_report(report, hid->ctrlbuf);
1204 hid->urbctrl->pipe = usb_sndctrlpipe(hid->dev, 0);
1205 hid->urbctrl->transfer_buffer_length = len;
1206 } else {
1207 int maxpacket, padlen;
1208
1209 hid->urbctrl->pipe = usb_rcvctrlpipe(hid->dev, 0);
1210 maxpacket = usb_maxpacket(hid->dev, hid->urbctrl->pipe, 0);
1211 if (maxpacket > 0) {
1212 padlen = (len + maxpacket - 1) / maxpacket;
1213 padlen *= maxpacket;
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001214 if (padlen > hid->bufsize)
1215 padlen = hid->bufsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 } else
1217 padlen = 0;
1218 hid->urbctrl->transfer_buffer_length = padlen;
1219 }
1220 hid->urbctrl->dev = hid->dev;
1221
1222 hid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
1223 hid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
1224 hid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
1225 hid->cr->wIndex = cpu_to_le16(hid->ifnum);
1226 hid->cr->wLength = cpu_to_le16(len);
1227
1228 dbg("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u",
1229 hid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
1230 hid->cr->wValue, hid->cr->wIndex, hid->cr->wLength);
1231
1232 if (usb_submit_urb(hid->urbctrl, GFP_ATOMIC)) {
1233 err("usb_submit_urb(ctrl) failed");
1234 return -1;
1235 }
1236
1237 return 0;
1238}
1239
1240/*
1241 * Output interrupt completion handler.
1242 */
1243
David Howells7d12e782006-10-05 14:55:46 +01001244static void hid_irq_out(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245{
1246 struct hid_device *hid = urb->context;
1247 unsigned long flags;
1248 int unplug = 0;
1249
1250 switch (urb->status) {
1251 case 0: /* success */
Vojtech Pavlikc4786ca2005-09-05 00:13:03 -05001252 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 case -ESHUTDOWN: /* unplug */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 unplug = 1;
Alan Sternaef4e262006-01-31 12:58:38 -05001255 case -EILSEQ: /* protocol error or unplug */
1256 case -EPROTO: /* protocol error or unplug */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 case -ECONNRESET: /* unlink */
1258 case -ENOENT:
1259 break;
1260 default: /* error */
1261 warn("output irq status %d received", urb->status);
1262 }
1263
1264 spin_lock_irqsave(&hid->outlock, flags);
1265
1266 if (unplug)
1267 hid->outtail = hid->outhead;
1268 else
1269 hid->outtail = (hid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
1270
1271 if (hid->outhead != hid->outtail) {
1272 if (hid_submit_out(hid)) {
Alexey Dobriyan53b35312006-03-24 03:16:13 -08001273 clear_bit(HID_OUT_RUNNING, &hid->iofl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 wake_up(&hid->wait);
1275 }
1276 spin_unlock_irqrestore(&hid->outlock, flags);
1277 return;
1278 }
1279
1280 clear_bit(HID_OUT_RUNNING, &hid->iofl);
1281 spin_unlock_irqrestore(&hid->outlock, flags);
1282 wake_up(&hid->wait);
1283}
1284
1285/*
1286 * Control pipe completion handler.
1287 */
1288
David Howells7d12e782006-10-05 14:55:46 +01001289static void hid_ctrl(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290{
1291 struct hid_device *hid = urb->context;
1292 unsigned long flags;
1293 int unplug = 0;
1294
1295 spin_lock_irqsave(&hid->ctrllock, flags);
1296
1297 switch (urb->status) {
1298 case 0: /* success */
1299 if (hid->ctrl[hid->ctrltail].dir == USB_DIR_IN)
David Howells7d12e782006-10-05 14:55:46 +01001300 hid_input_report(hid->ctrl[hid->ctrltail].report->type, urb, 0);
Vojtech Pavlikc4786ca2005-09-05 00:13:03 -05001301 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302 case -ESHUTDOWN: /* unplug */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 unplug = 1;
Alan Sternaef4e262006-01-31 12:58:38 -05001304 case -EILSEQ: /* protocol error or unplug */
1305 case -EPROTO: /* protocol error or unplug */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 case -ECONNRESET: /* unlink */
1307 case -ENOENT:
1308 case -EPIPE: /* report not available */
1309 break;
1310 default: /* error */
1311 warn("ctrl urb status %d received", urb->status);
1312 }
1313
1314 if (unplug)
1315 hid->ctrltail = hid->ctrlhead;
1316 else
1317 hid->ctrltail = (hid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
1318
1319 if (hid->ctrlhead != hid->ctrltail) {
1320 if (hid_submit_ctrl(hid)) {
1321 clear_bit(HID_CTRL_RUNNING, &hid->iofl);
1322 wake_up(&hid->wait);
1323 }
1324 spin_unlock_irqrestore(&hid->ctrllock, flags);
1325 return;
1326 }
1327
1328 clear_bit(HID_CTRL_RUNNING, &hid->iofl);
1329 spin_unlock_irqrestore(&hid->ctrllock, flags);
1330 wake_up(&hid->wait);
1331}
1332
1333void hid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
1334{
1335 int head;
1336 unsigned long flags;
1337
1338 if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
1339 return;
1340
1341 if (hid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
1342
1343 spin_lock_irqsave(&hid->outlock, flags);
1344
1345 if ((head = (hid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == hid->outtail) {
1346 spin_unlock_irqrestore(&hid->outlock, flags);
1347 warn("output queue full");
1348 return;
1349 }
1350
1351 hid->out[hid->outhead] = report;
1352 hid->outhead = head;
1353
1354 if (!test_and_set_bit(HID_OUT_RUNNING, &hid->iofl))
1355 if (hid_submit_out(hid))
1356 clear_bit(HID_OUT_RUNNING, &hid->iofl);
1357
1358 spin_unlock_irqrestore(&hid->outlock, flags);
1359 return;
1360 }
1361
1362 spin_lock_irqsave(&hid->ctrllock, flags);
1363
1364 if ((head = (hid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == hid->ctrltail) {
1365 spin_unlock_irqrestore(&hid->ctrllock, flags);
1366 warn("control queue full");
1367 return;
1368 }
1369
1370 hid->ctrl[hid->ctrlhead].report = report;
1371 hid->ctrl[hid->ctrlhead].dir = dir;
1372 hid->ctrlhead = head;
1373
1374 if (!test_and_set_bit(HID_CTRL_RUNNING, &hid->iofl))
1375 if (hid_submit_ctrl(hid))
1376 clear_bit(HID_CTRL_RUNNING, &hid->iofl);
1377
1378 spin_unlock_irqrestore(&hid->ctrllock, flags);
1379}
1380
1381int hid_wait_io(struct hid_device *hid)
1382{
1383 if (!wait_event_timeout(hid->wait, (!test_bit(HID_CTRL_RUNNING, &hid->iofl) &&
1384 !test_bit(HID_OUT_RUNNING, &hid->iofl)),
1385 10*HZ)) {
1386 dbg("timeout waiting for ctrl or out queue to clear");
1387 return -1;
1388 }
1389
1390 return 0;
1391}
1392
Vojtech Pavlik854561b2005-05-29 02:28:00 -05001393static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
1394{
Vojtech Pavlik71387bd2005-05-29 02:28:14 -05001395 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
Vojtech Pavlik854561b2005-05-29 02:28:00 -05001396 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
1397 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
1398}
1399
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
1401 unsigned char type, void *buf, int size)
1402{
1403 int result, retries = 4;
1404
1405 memset(buf,0,size); // Make sure we parse really received data
1406
1407 do {
1408 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
1409 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
1410 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
1411 retries--;
1412 } while (result < size && retries);
1413 return result;
1414}
1415
1416int hid_open(struct hid_device *hid)
1417{
Alan Sternaef4e262006-01-31 12:58:38 -05001418 ++hid->open;
1419 if (hid_start_in(hid))
1420 hid_io_error(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 return 0;
1422}
1423
1424void hid_close(struct hid_device *hid)
1425{
1426 if (!--hid->open)
1427 usb_kill_urb(hid->urbin);
1428}
1429
Daniel Ritz1d3e2022006-03-29 22:41:07 +02001430#define USB_VENDOR_ID_PANJIT 0x134c
1431
Ben Collinsd57cdcf2006-10-18 08:47:37 -04001432#define USB_VENDOR_ID_TURBOX 0x062a
1433#define USB_DEVICE_ID_TURBOX_KEYBOARD 0x0201
1434
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435/*
1436 * Initialize all reports
1437 */
1438
1439void hid_init_reports(struct hid_device *hid)
1440{
1441 struct hid_report *report;
1442 int err, ret;
1443
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001444 list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 hid_submit_report(hid, report, USB_DIR_IN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446
1447 list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
1448 hid_submit_report(hid, report, USB_DIR_IN);
1449
1450 err = 0;
1451 ret = hid_wait_io(hid);
1452 while (ret) {
1453 err |= ret;
1454 if (test_bit(HID_CTRL_RUNNING, &hid->iofl))
1455 usb_kill_urb(hid->urbctrl);
1456 if (test_bit(HID_OUT_RUNNING, &hid->iofl))
1457 usb_kill_urb(hid->urbout);
1458 ret = hid_wait_io(hid);
1459 }
1460
1461 if (err)
Olaf Heringde289fd2006-01-06 12:45:28 +01001462 warn("timeout initializing reports");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463}
1464
Jeremy Roberson6f8d9e22006-08-28 19:58:28 -07001465#define USB_VENDOR_ID_GTCO 0x078c
1466#define USB_DEVICE_ID_GTCO_90 0x0090
1467#define USB_DEVICE_ID_GTCO_100 0x0100
1468#define USB_DEVICE_ID_GTCO_101 0x0101
1469#define USB_DEVICE_ID_GTCO_103 0x0103
1470#define USB_DEVICE_ID_GTCO_104 0x0104
1471#define USB_DEVICE_ID_GTCO_105 0x0105
1472#define USB_DEVICE_ID_GTCO_106 0x0106
1473#define USB_DEVICE_ID_GTCO_107 0x0107
1474#define USB_DEVICE_ID_GTCO_108 0x0108
1475#define USB_DEVICE_ID_GTCO_200 0x0200
1476#define USB_DEVICE_ID_GTCO_201 0x0201
1477#define USB_DEVICE_ID_GTCO_202 0x0202
1478#define USB_DEVICE_ID_GTCO_203 0x0203
1479#define USB_DEVICE_ID_GTCO_204 0x0204
1480#define USB_DEVICE_ID_GTCO_205 0x0205
1481#define USB_DEVICE_ID_GTCO_206 0x0206
1482#define USB_DEVICE_ID_GTCO_207 0x0207
1483#define USB_DEVICE_ID_GTCO_300 0x0300
1484#define USB_DEVICE_ID_GTCO_301 0x0301
1485#define USB_DEVICE_ID_GTCO_302 0x0302
1486#define USB_DEVICE_ID_GTCO_303 0x0303
1487#define USB_DEVICE_ID_GTCO_304 0x0304
1488#define USB_DEVICE_ID_GTCO_305 0x0305
1489#define USB_DEVICE_ID_GTCO_306 0x0306
1490#define USB_DEVICE_ID_GTCO_307 0x0307
1491#define USB_DEVICE_ID_GTCO_308 0x0308
1492#define USB_DEVICE_ID_GTCO_309 0x0309
1493#define USB_DEVICE_ID_GTCO_400 0x0400
1494#define USB_DEVICE_ID_GTCO_401 0x0401
1495#define USB_DEVICE_ID_GTCO_402 0x0402
1496#define USB_DEVICE_ID_GTCO_403 0x0403
1497#define USB_DEVICE_ID_GTCO_404 0x0404
Adrian Bunkf0649022006-09-04 13:41:10 +02001498#define USB_DEVICE_ID_GTCO_405 0x0405
Jeremy Roberson6f8d9e22006-08-28 19:58:28 -07001499#define USB_DEVICE_ID_GTCO_500 0x0500
1500#define USB_DEVICE_ID_GTCO_501 0x0501
1501#define USB_DEVICE_ID_GTCO_502 0x0502
1502#define USB_DEVICE_ID_GTCO_503 0x0503
1503#define USB_DEVICE_ID_GTCO_504 0x0504
1504#define USB_DEVICE_ID_GTCO_1000 0x1000
1505#define USB_DEVICE_ID_GTCO_1001 0x1001
1506#define USB_DEVICE_ID_GTCO_1002 0x1002
1507#define USB_DEVICE_ID_GTCO_1003 0x1003
1508#define USB_DEVICE_ID_GTCO_1004 0x1004
1509#define USB_DEVICE_ID_GTCO_1005 0x1005
1510#define USB_DEVICE_ID_GTCO_1006 0x1006
1511
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512#define USB_VENDOR_ID_WACOM 0x056a
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513
Stephane VOLTZ53880542005-06-06 02:22:37 -05001514#define USB_VENDOR_ID_ACECAD 0x0460
1515#define USB_DEVICE_ID_ACECAD_FLAIR 0x0004
1516#define USB_DEVICE_ID_ACECAD_302 0x0008
1517
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518#define USB_VENDOR_ID_KBGEAR 0x084e
1519#define USB_DEVICE_ID_KBGEAR_JAMSTUDIO 0x1001
1520
1521#define USB_VENDOR_ID_AIPTEK 0x08ca
1522#define USB_DEVICE_ID_AIPTEK_01 0x0001
1523#define USB_DEVICE_ID_AIPTEK_10 0x0010
1524#define USB_DEVICE_ID_AIPTEK_20 0x0020
1525#define USB_DEVICE_ID_AIPTEK_21 0x0021
1526#define USB_DEVICE_ID_AIPTEK_22 0x0022
1527#define USB_DEVICE_ID_AIPTEK_23 0x0023
1528#define USB_DEVICE_ID_AIPTEK_24 0x0024
1529
1530#define USB_VENDOR_ID_GRIFFIN 0x077d
1531#define USB_DEVICE_ID_POWERMATE 0x0410
1532#define USB_DEVICE_ID_SOUNDKNOB 0x04AA
1533
1534#define USB_VENDOR_ID_ATEN 0x0557
1535#define USB_DEVICE_ID_ATEN_UC100KM 0x2004
1536#define USB_DEVICE_ID_ATEN_CS124U 0x2202
1537#define USB_DEVICE_ID_ATEN_2PORTKVM 0x2204
1538#define USB_DEVICE_ID_ATEN_4PORTKVM 0x2205
1539#define USB_DEVICE_ID_ATEN_4PORTKVMC 0x2208
1540
1541#define USB_VENDOR_ID_TOPMAX 0x0663
1542#define USB_DEVICE_ID_TOPMAX_COBRAPAD 0x0103
1543
1544#define USB_VENDOR_ID_HAPP 0x078b
1545#define USB_DEVICE_ID_UGCI_DRIVING 0x0010
1546#define USB_DEVICE_ID_UGCI_FLYING 0x0020
1547#define USB_DEVICE_ID_UGCI_FIGHTING 0x0030
1548
1549#define USB_VENDOR_ID_MGE 0x0463
1550#define USB_DEVICE_ID_MGE_UPS 0xffff
1551#define USB_DEVICE_ID_MGE_UPS1 0x0001
1552
1553#define USB_VENDOR_ID_ONTRAK 0x0a07
1554#define USB_DEVICE_ID_ONTRAK_ADU100 0x0064
1555
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556#define USB_VENDOR_ID_ESSENTIAL_REALITY 0x0d7f
1557#define USB_DEVICE_ID_ESSENTIAL_REALITY_P5 0x0100
1558
1559#define USB_VENDOR_ID_A4TECH 0x09da
1560#define USB_DEVICE_ID_A4TECH_WCP32PU 0x0006
1561
Vojtech Pavlik61cdecd2005-09-05 00:13:32 -05001562#define USB_VENDOR_ID_AASHIMA 0x06d6
Luca T6345fdf2005-07-11 01:08:40 -05001563#define USB_DEVICE_ID_AASHIMA_GAMEPAD 0x0025
Vojtech Pavlik61cdecd2005-09-05 00:13:32 -05001564#define USB_DEVICE_ID_AASHIMA_PREDATOR 0x0026
Luca T6345fdf2005-07-11 01:08:40 -05001565
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566#define USB_VENDOR_ID_CYPRESS 0x04b4
1567#define USB_DEVICE_ID_CYPRESS_MOUSE 0x0001
1568#define USB_DEVICE_ID_CYPRESS_HIDCOM 0x5500
Brian Schau7d252582005-09-05 01:57:41 -05001569#define USB_DEVICE_ID_CYPRESS_ULTRAMOUSE 0x7417
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570
1571#define USB_VENDOR_ID_BERKSHIRE 0x0c98
1572#define USB_DEVICE_ID_BERKSHIRE_PCWD 0x1140
1573
1574#define USB_VENDOR_ID_ALPS 0x0433
1575#define USB_DEVICE_ID_IBM_GAMEPAD 0x1101
1576
1577#define USB_VENDOR_ID_SAITEK 0x06a3
1578#define USB_DEVICE_ID_SAITEK_RUMBLEPAD 0xff17
1579
1580#define USB_VENDOR_ID_NEC 0x073e
1581#define USB_DEVICE_ID_NEC_USB_GAME_PAD 0x0301
1582
1583#define USB_VENDOR_ID_CHIC 0x05fe
1584#define USB_DEVICE_ID_CHIC_GAMEPAD 0x0014
1585
1586#define USB_VENDOR_ID_GLAB 0x06c2
1587#define USB_DEVICE_ID_4_PHIDGETSERVO_30 0x0038
1588#define USB_DEVICE_ID_1_PHIDGETSERVO_30 0x0039
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589#define USB_DEVICE_ID_0_0_4_IF_KIT 0x0040
Sean Youngd5176b42006-07-09 13:01:02 +00001590#define USB_DEVICE_ID_0_16_16_IF_KIT 0x0044
1591#define USB_DEVICE_ID_8_8_8_IF_KIT 0x0045
1592#define USB_DEVICE_ID_0_8_7_IF_KIT 0x0051
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593#define USB_DEVICE_ID_0_8_8_IF_KIT 0x0053
Sean Youngd5176b42006-07-09 13:01:02 +00001594#define USB_DEVICE_ID_PHIDGET_MOTORCONTROL 0x0058
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595
1596#define USB_VENDOR_ID_WISEGROUP 0x0925
1597#define USB_DEVICE_ID_1_PHIDGETSERVO_20 0x8101
1598#define USB_DEVICE_ID_4_PHIDGETSERVO_20 0x8104
Sean Youngd5176b42006-07-09 13:01:02 +00001599#define USB_DEVICE_ID_8_8_4_IF_KIT 0x8201
Andrew Fullere65335e2006-02-25 09:52:27 -05001600#define USB_DEVICE_ID_DUAL_USB_JOYPAD 0x8866
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601
Navaho Gunlegb857c652006-06-30 09:44:03 +02001602#define USB_VENDOR_ID_WISEGROUP_LTD 0x6677
1603#define USB_DEVICE_ID_SMARTJOY_DUAL_PLUS 0x8802
1604
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605#define USB_VENDOR_ID_CODEMERCS 0x07c0
1606#define USB_DEVICE_ID_CODEMERCS_IOW40 0x1500
1607#define USB_DEVICE_ID_CODEMERCS_IOW24 0x1501
1608#define USB_DEVICE_ID_CODEMERCS_IOW48 0x1502
1609#define USB_DEVICE_ID_CODEMERCS_IOW28 0x1503
1610
1611#define USB_VENDOR_ID_DELORME 0x1163
1612#define USB_DEVICE_ID_DELORME_EARTHMATE 0x0100
Lonnie Mendezdc1d1002005-05-10 00:17:17 -05001613#define USB_DEVICE_ID_DELORME_EM_LT20 0x0200
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614
1615#define USB_VENDOR_ID_MCC 0x09db
1616#define USB_DEVICE_ID_MCC_PMD1024LS 0x0076
1617#define USB_DEVICE_ID_MCC_PMD1208LS 0x007a
1618
Greg Kroah-Hartman4871d3b2005-06-02 22:18:12 -07001619#define USB_VENDOR_ID_VERNIER 0x08f7
1620#define USB_DEVICE_ID_VERNIER_LABPRO 0x0001
1621#define USB_DEVICE_ID_VERNIER_GOTEMP 0x0002
1622#define USB_DEVICE_ID_VERNIER_SKIP 0x0003
1623#define USB_DEVICE_ID_VERNIER_CYCLOPS 0x0004
1624
Michael Hund8fd6db42005-06-27 22:44:22 +02001625#define USB_VENDOR_ID_LD 0x0f11
Michael Hundba3e66e2006-02-02 09:36:43 +01001626#define USB_DEVICE_ID_LD_CASSY 0x1000
1627#define USB_DEVICE_ID_LD_POCKETCASSY 0x1010
1628#define USB_DEVICE_ID_LD_MOBILECASSY 0x1020
1629#define USB_DEVICE_ID_LD_JWM 0x1080
1630#define USB_DEVICE_ID_LD_DMMP 0x1081
1631#define USB_DEVICE_ID_LD_UMIP 0x1090
1632#define USB_DEVICE_ID_LD_XRAY1 0x1100
1633#define USB_DEVICE_ID_LD_XRAY2 0x1101
1634#define USB_DEVICE_ID_LD_VIDEOCOM 0x1200
1635#define USB_DEVICE_ID_LD_COM3LAB 0x2000
1636#define USB_DEVICE_ID_LD_TELEPORT 0x2010
1637#define USB_DEVICE_ID_LD_NETWORKANALYSER 0x2020
1638#define USB_DEVICE_ID_LD_POWERCONTROL 0x2030
1639#define USB_DEVICE_ID_LD_MACHINETEST 0x2040
Michael Hund8fd6db42005-06-27 22:44:22 +02001640
Vojtech Pavlikc58de6d2005-09-05 00:13:15 -05001641#define USB_VENDOR_ID_APPLE 0x05ac
Bart Masseya82e49b2006-05-08 14:40:13 -07001642#define USB_DEVICE_ID_APPLE_MIGHTYMOUSE 0x0304
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
Vojtech Pavlik940824b2006-01-14 00:25:39 -05001644#define USB_VENDOR_ID_CHERRY 0x046a
1645#define USB_DEVICE_ID_CHERRY_CYMOTION 0x0023
1646
Henk Vergonet5cd330f2006-05-15 12:34:43 +02001647#define USB_VENDOR_ID_YEALINK 0x6993
1648#define USB_DEVICE_ID_YEALINK_P1K_P4K_B2K 0xb001
Johannes Steingraeber8fd80132006-09-16 16:17:34 +02001649
1650#define USB_VENDOR_ID_ALCOR 0x058f
1651#define USB_DEVICE_ID_ALCOR_USBRS232 0x9720
1652
Raghavendra Biligiri931e24b2006-09-15 19:53:35 +05301653#define USB_VENDOR_ID_SUN 0x0430
1654#define USB_DEVICE_ID_RARITAN_KVM_DONGLE 0xcdab
1655
Naranjo Manuel Francisco23b0d962006-10-27 16:08:54 -03001656#define USB_VENDOR_ID_AIRCABLE 0x16CA
1657#define USB_DEVICE_ID_AIRCABLE1 0x1502
1658
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659/*
1660 * Alphabetically sorted blacklist by quirk type.
1661 */
1662
Arjan van de Ven4c4c9432005-11-29 09:43:42 +01001663static const struct hid_blacklist {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 __u16 idVendor;
1665 __u16 idProduct;
1666 unsigned quirks;
1667} hid_blacklist[] = {
1668
1669 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_01, HID_QUIRK_IGNORE },
1670 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_10, HID_QUIRK_IGNORE },
1671 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_20, HID_QUIRK_IGNORE },
1672 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_21, HID_QUIRK_IGNORE },
1673 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_22, HID_QUIRK_IGNORE },
1674 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_23, HID_QUIRK_IGNORE },
1675 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_24, HID_QUIRK_IGNORE },
Naranjo Manuel Francisco23b0d962006-10-27 16:08:54 -03001676 { USB_VENDOR_ID_AIRCABLE, USB_DEVICE_ID_AIRCABLE1, HID_QUIRK_IGNORE },
Johannes Steingraeber8fd80132006-09-16 16:17:34 +02001677 { USB_VENDOR_ID_ALCOR, USB_DEVICE_ID_ALCOR_USBRS232, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 { USB_VENDOR_ID_BERKSHIRE, USB_DEVICE_ID_BERKSHIRE_PCWD, HID_QUIRK_IGNORE },
1679 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW40, HID_QUIRK_IGNORE },
1680 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW24, HID_QUIRK_IGNORE },
1681 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW48, HID_QUIRK_IGNORE },
1682 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW28, HID_QUIRK_IGNORE },
1683 { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_HIDCOM, HID_QUIRK_IGNORE },
Brian Schau7d252582005-09-05 01:57:41 -05001684 { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_ULTRAMOUSE, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 { USB_VENDOR_ID_DELORME, USB_DEVICE_ID_DELORME_EARTHMATE, HID_QUIRK_IGNORE },
Lonnie Mendezdc1d1002005-05-10 00:17:17 -05001686 { USB_VENDOR_ID_DELORME, USB_DEVICE_ID_DELORME_EM_LT20, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687 { USB_VENDOR_ID_ESSENTIAL_REALITY, USB_DEVICE_ID_ESSENTIAL_REALITY_P5, HID_QUIRK_IGNORE },
1688 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_4_PHIDGETSERVO_30, HID_QUIRK_IGNORE },
1689 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_1_PHIDGETSERVO_30, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_0_4_IF_KIT, HID_QUIRK_IGNORE },
Sean Youngd5176b42006-07-09 13:01:02 +00001691 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_16_16_IF_KIT, HID_QUIRK_IGNORE },
1692 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_8_8_8_IF_KIT, HID_QUIRK_IGNORE },
1693 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_8_7_IF_KIT, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_8_8_IF_KIT, HID_QUIRK_IGNORE },
Sean Youngd5176b42006-07-09 13:01:02 +00001695 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_PHIDGET_MOTORCONTROL, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 { USB_VENDOR_ID_GRIFFIN, USB_DEVICE_ID_POWERMATE, HID_QUIRK_IGNORE },
1697 { USB_VENDOR_ID_GRIFFIN, USB_DEVICE_ID_SOUNDKNOB, HID_QUIRK_IGNORE },
Jeremy Roberson6f8d9e22006-08-28 19:58:28 -07001698 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_90, HID_QUIRK_IGNORE },
1699 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_100, HID_QUIRK_IGNORE },
1700 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_101, HID_QUIRK_IGNORE },
1701 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_103, HID_QUIRK_IGNORE },
1702 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_104, HID_QUIRK_IGNORE },
1703 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_105, HID_QUIRK_IGNORE },
1704 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_106, HID_QUIRK_IGNORE },
1705 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_107, HID_QUIRK_IGNORE },
1706 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_108, HID_QUIRK_IGNORE },
1707 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_200, HID_QUIRK_IGNORE },
1708 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_201, HID_QUIRK_IGNORE },
1709 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_202, HID_QUIRK_IGNORE },
1710 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_203, HID_QUIRK_IGNORE },
1711 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_204, HID_QUIRK_IGNORE },
1712 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_205, HID_QUIRK_IGNORE },
1713 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_206, HID_QUIRK_IGNORE },
1714 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_207, HID_QUIRK_IGNORE },
1715 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_300, HID_QUIRK_IGNORE },
1716 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_301, HID_QUIRK_IGNORE },
1717 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_302, HID_QUIRK_IGNORE },
1718 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_303, HID_QUIRK_IGNORE },
1719 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_304, HID_QUIRK_IGNORE },
1720 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_305, HID_QUIRK_IGNORE },
1721 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_306, HID_QUIRK_IGNORE },
1722 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_307, HID_QUIRK_IGNORE },
1723 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_308, HID_QUIRK_IGNORE },
1724 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_309, HID_QUIRK_IGNORE },
1725 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_400, HID_QUIRK_IGNORE },
1726 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_401, HID_QUIRK_IGNORE },
1727 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_402, HID_QUIRK_IGNORE },
1728 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_403, HID_QUIRK_IGNORE },
1729 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_404, HID_QUIRK_IGNORE },
Adrian Bunkf0649022006-09-04 13:41:10 +02001730 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_405, HID_QUIRK_IGNORE },
Jeremy Roberson6f8d9e22006-08-28 19:58:28 -07001731 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_500, HID_QUIRK_IGNORE },
1732 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_501, HID_QUIRK_IGNORE },
1733 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_502, HID_QUIRK_IGNORE },
1734 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_503, HID_QUIRK_IGNORE },
1735 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_504, HID_QUIRK_IGNORE },
1736 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1000, HID_QUIRK_IGNORE },
1737 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1001, HID_QUIRK_IGNORE },
1738 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1002, HID_QUIRK_IGNORE },
1739 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1003, HID_QUIRK_IGNORE },
1740 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1004, HID_QUIRK_IGNORE },
1741 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1005, HID_QUIRK_IGNORE },
1742 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1006, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 { USB_VENDOR_ID_KBGEAR, USB_DEVICE_ID_KBGEAR_JAMSTUDIO, HID_QUIRK_IGNORE },
Michael Hundba3e66e2006-02-02 09:36:43 +01001744 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_CASSY, HID_QUIRK_IGNORE },
1745 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POCKETCASSY, HID_QUIRK_IGNORE },
1746 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MOBILECASSY, HID_QUIRK_IGNORE },
1747 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_JWM, HID_QUIRK_IGNORE },
1748 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_DMMP, HID_QUIRK_IGNORE },
1749 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_UMIP, HID_QUIRK_IGNORE },
1750 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_XRAY1, HID_QUIRK_IGNORE },
1751 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_XRAY2, HID_QUIRK_IGNORE },
1752 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_VIDEOCOM, HID_QUIRK_IGNORE },
1753 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_COM3LAB, HID_QUIRK_IGNORE },
1754 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_TELEPORT, HID_QUIRK_IGNORE },
1755 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_NETWORKANALYSER, HID_QUIRK_IGNORE },
1756 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POWERCONTROL, HID_QUIRK_IGNORE },
1757 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MACHINETEST, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 { USB_VENDOR_ID_MCC, USB_DEVICE_ID_MCC_PMD1024LS, HID_QUIRK_IGNORE },
1759 { USB_VENDOR_ID_MCC, USB_DEVICE_ID_MCC_PMD1208LS, HID_QUIRK_IGNORE },
1760 { USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS, HID_QUIRK_IGNORE },
1761 { USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS1, HID_QUIRK_IGNORE },
1762 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100, HID_QUIRK_IGNORE },
Steven Haigh03270632006-08-09 07:42:06 +10001763 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 20, HID_QUIRK_IGNORE },
1764 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 30, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 100, HID_QUIRK_IGNORE },
Steven Haigh03270632006-08-09 07:42:06 +10001766 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 108, HID_QUIRK_IGNORE },
1767 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 118, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 200, HID_QUIRK_IGNORE },
1769 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 300, HID_QUIRK_IGNORE },
1770 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 400, HID_QUIRK_IGNORE },
1771 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 500, HID_QUIRK_IGNORE },
Greg Kroah-Hartman4871d3b2005-06-02 22:18:12 -07001772 { USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_LABPRO, HID_QUIRK_IGNORE },
1773 { USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_GOTEMP, HID_QUIRK_IGNORE },
1774 { USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_SKIP, HID_QUIRK_IGNORE },
1775 { USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_CYCLOPS, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_4_PHIDGETSERVO_20, HID_QUIRK_IGNORE },
1777 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_1_PHIDGETSERVO_20, HID_QUIRK_IGNORE },
Sean Youngd5176b42006-07-09 13:01:02 +00001778 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_8_8_4_IF_KIT, HID_QUIRK_IGNORE },
Henk Vergonet5cd330f2006-05-15 12:34:43 +02001779 { USB_VENDOR_ID_YEALINK, USB_DEVICE_ID_YEALINK_P1K_P4K_B2K, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780
Stephane VOLTZ53880542005-06-06 02:22:37 -05001781 { USB_VENDOR_ID_ACECAD, USB_DEVICE_ID_ACECAD_FLAIR, HID_QUIRK_IGNORE },
1782 { USB_VENDOR_ID_ACECAD, USB_DEVICE_ID_ACECAD_302, HID_QUIRK_IGNORE },
1783
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
1785 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
1786 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
1787 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
1788 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
Raghavendra Biligiri931e24b2006-09-15 19:53:35 +05301789 { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
Andrew Fullere65335e2006-02-25 09:52:27 -05001790 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
Navaho Gunlegb857c652006-06-30 09:44:03 +02001791 { USB_VENDOR_ID_WISEGROUP_LTD, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792
Bart Masseya82e49b2006-05-08 14:40:13 -07001793 { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE, HID_QUIRK_MIGHTYMOUSE | HID_QUIRK_INVERT_HWHEEL },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 { USB_VENDOR_ID_A4TECH, USB_DEVICE_ID_A4TECH_WCP32PU, HID_QUIRK_2WHEEL_MOUSE_HACK_7 },
1795 { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_MOUSE, HID_QUIRK_2WHEEL_MOUSE_HACK_5 },
1796
Luca T6345fdf2005-07-11 01:08:40 -05001797 { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_GAMEPAD, HID_QUIRK_BADPAD },
Vojtech Pavlik61cdecd2005-09-05 00:13:32 -05001798 { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_PREDATOR, HID_QUIRK_BADPAD },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 { USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
1800 { USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
1801 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1802 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1803 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1804 { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
1805 { USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
1806 { USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },
1807
Vojtech Pavlik940824b2006-01-14 00:25:39 -05001808 { USB_VENDOR_ID_CHERRY, USB_DEVICE_ID_CHERRY_CYMOTION, HID_QUIRK_CYMOTION },
1809
Michael Hanselmanneab9edd2006-01-14 10:08:06 -05001810 { USB_VENDOR_ID_APPLE, 0x020E, HID_QUIRK_POWERBOOK_HAS_FN },
1811 { USB_VENDOR_ID_APPLE, 0x020F, HID_QUIRK_POWERBOOK_HAS_FN },
1812 { USB_VENDOR_ID_APPLE, 0x0214, HID_QUIRK_POWERBOOK_HAS_FN },
Olaf Heringbb7eef62006-11-08 19:58:07 -08001813 { USB_VENDOR_ID_APPLE, 0x0215, HID_QUIRK_POWERBOOK_HAS_FN | HID_QUIRK_POWERBOOK_ISO_KEYBOARD},
Michael Hanselmanneab9edd2006-01-14 10:08:06 -05001814 { USB_VENDOR_ID_APPLE, 0x0216, HID_QUIRK_POWERBOOK_HAS_FN },
Rene Rebe5c218e32006-06-04 11:39:09 +02001815 { USB_VENDOR_ID_APPLE, 0x0217, HID_QUIRK_POWERBOOK_HAS_FN },
Olaf Heringbb7eef62006-11-08 19:58:07 -08001816 { USB_VENDOR_ID_APPLE, 0x0218, HID_QUIRK_POWERBOOK_HAS_FN | HID_QUIRK_POWERBOOK_ISO_KEYBOARD},
Rene Rebe5c218e32006-06-04 11:39:09 +02001817 { USB_VENDOR_ID_APPLE, 0x0219, HID_QUIRK_POWERBOOK_HAS_FN },
Julien BLACHEa7dc4ee2006-11-12 11:22:42 +01001818 { USB_VENDOR_ID_APPLE, 0x021B, HID_QUIRK_POWERBOOK_HAS_FN },
Michael Hanselmanneab9edd2006-01-14 10:08:06 -05001819 { USB_VENDOR_ID_APPLE, 0x030A, HID_QUIRK_POWERBOOK_HAS_FN },
1820 { USB_VENDOR_ID_APPLE, 0x030B, HID_QUIRK_POWERBOOK_HAS_FN },
1821
Daniel Ritz1d3e2022006-03-29 22:41:07 +02001822 { USB_VENDOR_ID_PANJIT, 0x0001, HID_QUIRK_IGNORE },
1823 { USB_VENDOR_ID_PANJIT, 0x0002, HID_QUIRK_IGNORE },
1824 { USB_VENDOR_ID_PANJIT, 0x0003, HID_QUIRK_IGNORE },
1825 { USB_VENDOR_ID_PANJIT, 0x0004, HID_QUIRK_IGNORE },
1826
Ben Collinsd57cdcf2006-10-18 08:47:37 -04001827 { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
1828
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 { 0, 0 }
1830};
1831
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001832/*
1833 * Traverse the supplied list of reports and find the longest
1834 */
1835static void hid_find_max_report(struct hid_device *hid, unsigned int type, int *max)
1836{
1837 struct hid_report *report;
1838 int size;
1839
1840 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
1841 size = ((report->size - 1) >> 3) + 1;
1842 if (type == HID_INPUT_REPORT && hid->report_enum[type].numbered)
1843 size++;
1844 if (*max < size)
1845 *max = size;
1846 }
1847}
1848
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
1850{
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001851 if (!(hid->inbuf = usb_buffer_alloc(dev, hid->bufsize, SLAB_ATOMIC, &hid->inbuf_dma)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852 return -1;
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001853 if (!(hid->outbuf = usb_buffer_alloc(dev, hid->bufsize, SLAB_ATOMIC, &hid->outbuf_dma)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854 return -1;
1855 if (!(hid->cr = usb_buffer_alloc(dev, sizeof(*(hid->cr)), SLAB_ATOMIC, &hid->cr_dma)))
1856 return -1;
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001857 if (!(hid->ctrlbuf = usb_buffer_alloc(dev, hid->bufsize, SLAB_ATOMIC, &hid->ctrlbuf_dma)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 return -1;
1859
1860 return 0;
1861}
1862
1863static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
1864{
1865 if (hid->inbuf)
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001866 usb_buffer_free(dev, hid->bufsize, hid->inbuf, hid->inbuf_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 if (hid->outbuf)
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001868 usb_buffer_free(dev, hid->bufsize, hid->outbuf, hid->outbuf_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869 if (hid->cr)
1870 usb_buffer_free(dev, sizeof(*(hid->cr)), hid->cr, hid->cr_dma);
1871 if (hid->ctrlbuf)
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001872 usb_buffer_free(dev, hid->bufsize, hid->ctrlbuf, hid->ctrlbuf_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873}
1874
Vojtech Pavlik940824b2006-01-14 00:25:39 -05001875/*
1876 * Cherry Cymotion keyboard have an invalid HID report descriptor,
1877 * that needs fixing before we can parse it.
1878 */
1879
1880static void hid_fixup_cymotion_descriptor(char *rdesc, int rsize)
1881{
1882 if (rsize >= 17 && rdesc[11] == 0x3c && rdesc[12] == 0x02) {
1883 info("Fixing up Cherry Cymotion report descriptor");
1884 rdesc[11] = rdesc[16] = 0xff;
1885 rdesc[12] = rdesc[17] = 0x03;
1886 }
1887}
1888
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889static struct hid_device *usb_hid_configure(struct usb_interface *intf)
1890{
1891 struct usb_host_interface *interface = intf->cur_altsetting;
1892 struct usb_device *dev = interface_to_usbdev (intf);
1893 struct hid_descriptor *hdesc;
1894 struct hid_device *hid;
1895 unsigned quirks = 0, rsize = 0;
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001896 char *rdesc;
1897 int n, len, insize = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898
Ping Chengea186652006-07-14 16:50:04 -07001899 /* Ignore all Wacom devices */
Al Viroc03efdb2006-09-23 01:29:34 +01001900 if (le16_to_cpu(dev->descriptor.idVendor) == USB_VENDOR_ID_WACOM)
Ping Chengea186652006-07-14 16:50:04 -07001901 return NULL;
1902
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903 for (n = 0; hid_blacklist[n].idVendor; n++)
1904 if ((hid_blacklist[n].idVendor == le16_to_cpu(dev->descriptor.idVendor)) &&
1905 (hid_blacklist[n].idProduct == le16_to_cpu(dev->descriptor.idProduct)))
1906 quirks = hid_blacklist[n].quirks;
1907
Alan Stern0f28b552006-05-15 14:49:04 -04001908 /* Many keyboards and mice don't like to be polled for reports,
1909 * so we will always set the HID_QUIRK_NOGET flag for them. */
1910 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
1911 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
1912 interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
1913 quirks |= HID_QUIRK_NOGET;
1914 }
1915
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916 if (quirks & HID_QUIRK_IGNORE)
1917 return NULL;
1918
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001919 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
1920 (!interface->desc.bNumEndpoints ||
1921 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
1922 dbg("class descriptor not present\n");
1923 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924 }
1925
1926 for (n = 0; n < hdesc->bNumDescriptors; n++)
1927 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
1928 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
1929
1930 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
1931 dbg("weird size of report descriptor (%u)", rsize);
1932 return NULL;
1933 }
1934
1935 if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
1936 dbg("couldn't allocate rdesc memory");
1937 return NULL;
1938 }
1939
Vojtech Pavlik854561b2005-05-29 02:28:00 -05001940 hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
1941
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942 if ((n = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber, HID_DT_REPORT, rdesc, rsize)) < 0) {
1943 dbg("reading report descriptor failed");
1944 kfree(rdesc);
1945 return NULL;
1946 }
1947
Vojtech Pavlik940824b2006-01-14 00:25:39 -05001948 if ((quirks & HID_QUIRK_CYMOTION))
1949 hid_fixup_cymotion_descriptor(rdesc, rsize);
1950
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951#ifdef DEBUG_DATA
1952 printk(KERN_DEBUG __FILE__ ": report descriptor (size %u, read %d) = ", rsize, n);
1953 for (n = 0; n < rsize; n++)
1954 printk(" %02x", (unsigned char) rdesc[n]);
1955 printk("\n");
1956#endif
1957
1958 if (!(hid = hid_parse_report(rdesc, n))) {
1959 dbg("parsing report descriptor failed");
1960 kfree(rdesc);
1961 return NULL;
1962 }
1963
1964 kfree(rdesc);
1965 hid->quirks = quirks;
1966
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001967 hid->bufsize = HID_MIN_BUFFER_SIZE;
1968 hid_find_max_report(hid, HID_INPUT_REPORT, &hid->bufsize);
1969 hid_find_max_report(hid, HID_OUTPUT_REPORT, &hid->bufsize);
1970 hid_find_max_report(hid, HID_FEATURE_REPORT, &hid->bufsize);
1971
1972 if (hid->bufsize > HID_MAX_BUFFER_SIZE)
1973 hid->bufsize = HID_MAX_BUFFER_SIZE;
1974
1975 hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
1976
1977 if (insize > HID_MAX_BUFFER_SIZE)
1978 insize = HID_MAX_BUFFER_SIZE;
1979
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980 if (hid_alloc_buffers(dev, hid)) {
1981 hid_free_buffers(dev, hid);
1982 goto fail;
1983 }
1984
1985 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
1986
1987 struct usb_endpoint_descriptor *endpoint;
1988 int pipe;
1989 int interval;
1990
1991 endpoint = &interface->endpoint[n].desc;
1992 if ((endpoint->bmAttributes & 3) != 3) /* Not an interrupt endpoint */
1993 continue;
1994
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995 interval = endpoint->bInterval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996
1997 /* Change the polling interval of mice. */
1998 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
1999 interval = hid_mousepoll_interval;
Dmitry Torokhov05f091a2005-05-29 02:29:01 -05002000
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001 if (endpoint->bEndpointAddress & USB_DIR_IN) {
2002 if (hid->urbin)
2003 continue;
2004 if (!(hid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
2005 goto fail;
2006 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
Michael Haboustakbf0964d2005-09-05 00:12:01 -05002007 usb_fill_int_urb(hid->urbin, dev, pipe, hid->inbuf, insize,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 hid_irq_in, hid, interval);
2009 hid->urbin->transfer_dma = hid->inbuf_dma;
Alan Sternb375a042005-07-29 16:11:07 -04002010 hid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011 } else {
2012 if (hid->urbout)
2013 continue;
2014 if (!(hid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
2015 goto fail;
2016 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
2017 usb_fill_int_urb(hid->urbout, dev, pipe, hid->outbuf, 0,
2018 hid_irq_out, hid, interval);
2019 hid->urbout->transfer_dma = hid->outbuf_dma;
Alan Sternb375a042005-07-29 16:11:07 -04002020 hid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 }
2022 }
2023
2024 if (!hid->urbin) {
2025 err("couldn't find an input interrupt endpoint");
2026 goto fail;
2027 }
2028
2029 init_waitqueue_head(&hid->wait);
2030
Alan Sternaef4e262006-01-31 12:58:38 -05002031 INIT_WORK(&hid->reset_work, hid_reset, hid);
2032 setup_timer(&hid->io_retry, hid_retry_timeout, (unsigned long) hid);
2033
2034 spin_lock_init(&hid->inlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035 spin_lock_init(&hid->outlock);
2036 spin_lock_init(&hid->ctrllock);
2037
2038 hid->version = le16_to_cpu(hdesc->bcdHID);
2039 hid->country = hdesc->bCountryCode;
2040 hid->dev = dev;
2041 hid->intf = intf;
2042 hid->ifnum = interface->desc.bInterfaceNumber;
2043
2044 hid->name[0] = 0;
2045
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05002046 if (dev->manufacturer)
2047 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05002049 if (dev->product) {
2050 if (dev->manufacturer)
2051 strlcat(hid->name, " ", sizeof(hid->name));
2052 strlcat(hid->name, dev->product, sizeof(hid->name));
2053 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05002055 if (!strlen(hid->name))
2056 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
2057 le16_to_cpu(dev->descriptor.idVendor),
2058 le16_to_cpu(dev->descriptor.idProduct));
2059
2060 usb_make_path(dev, hid->phys, sizeof(hid->phys));
2061 strlcat(hid->phys, "/input", sizeof(hid->phys));
2062 len = strlen(hid->phys);
2063 if (len < sizeof(hid->phys) - 1)
2064 snprintf(hid->phys + len, sizeof(hid->phys) - len,
2065 "%d", intf->altsetting[0].desc.bInterfaceNumber);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066
2067 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
2068 hid->uniq[0] = 0;
2069
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070 hid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
2071 if (!hid->urbctrl)
2072 goto fail;
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05002073
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074 usb_fill_control_urb(hid->urbctrl, dev, 0, (void *) hid->cr,
2075 hid->ctrlbuf, 1, hid_ctrl, hid);
2076 hid->urbctrl->setup_dma = hid->cr_dma;
2077 hid->urbctrl->transfer_dma = hid->ctrlbuf_dma;
Alan Sternb375a042005-07-29 16:11:07 -04002078 hid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079
2080 return hid;
2081
2082fail:
2083
2084 if (hid->urbin)
2085 usb_free_urb(hid->urbin);
2086 if (hid->urbout)
2087 usb_free_urb(hid->urbout);
2088 if (hid->urbctrl)
2089 usb_free_urb(hid->urbctrl);
2090 hid_free_buffers(dev, hid);
2091 hid_free_device(hid);
2092
2093 return NULL;
2094}
2095
2096static void hid_disconnect(struct usb_interface *intf)
2097{
2098 struct hid_device *hid = usb_get_intfdata (intf);
2099
2100 if (!hid)
2101 return;
2102
Alan Sternaef4e262006-01-31 12:58:38 -05002103 spin_lock_irq(&hid->inlock); /* Sync with error handler */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 usb_set_intfdata(intf, NULL);
Alan Sternaef4e262006-01-31 12:58:38 -05002105 spin_unlock_irq(&hid->inlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 usb_kill_urb(hid->urbin);
2107 usb_kill_urb(hid->urbout);
2108 usb_kill_urb(hid->urbctrl);
2109
Alan Sternaef4e262006-01-31 12:58:38 -05002110 del_timer_sync(&hid->io_retry);
2111 flush_scheduled_work();
2112
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113 if (hid->claimed & HID_CLAIMED_INPUT)
2114 hidinput_disconnect(hid);
2115 if (hid->claimed & HID_CLAIMED_HIDDEV)
2116 hiddev_disconnect(hid);
2117
2118 usb_free_urb(hid->urbin);
2119 usb_free_urb(hid->urbctrl);
2120 if (hid->urbout)
2121 usb_free_urb(hid->urbout);
2122
2123 hid_free_buffers(hid->dev, hid);
2124 hid_free_device(hid);
2125}
2126
2127static int hid_probe(struct usb_interface *intf, const struct usb_device_id *id)
2128{
2129 struct hid_device *hid;
2130 char path[64];
2131 int i;
2132 char *c;
2133
2134 dbg("HID probe called for ifnum %d",
2135 intf->altsetting->desc.bInterfaceNumber);
2136
2137 if (!(hid = usb_hid_configure(intf)))
Stelian Pop479f6ea2005-06-22 17:53:28 +02002138 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139
2140 hid_init_reports(hid);
2141 hid_dump_device(hid);
2142
2143 if (!hidinput_connect(hid))
2144 hid->claimed |= HID_CLAIMED_INPUT;
2145 if (!hiddev_connect(hid))
2146 hid->claimed |= HID_CLAIMED_HIDDEV;
2147
2148 usb_set_intfdata(intf, hid);
2149
2150 if (!hid->claimed) {
2151 printk ("HID device not claimed by input or hiddev\n");
2152 hid_disconnect(intf);
Stelian Pop479f6ea2005-06-22 17:53:28 +02002153 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 }
2155
2156 printk(KERN_INFO);
2157
2158 if (hid->claimed & HID_CLAIMED_INPUT)
2159 printk("input");
2160 if (hid->claimed == (HID_CLAIMED_INPUT | HID_CLAIMED_HIDDEV))
2161 printk(",");
2162 if (hid->claimed & HID_CLAIMED_HIDDEV)
2163 printk("hiddev%d", hid->minor);
2164
2165 c = "Device";
2166 for (i = 0; i < hid->maxcollection; i++) {
2167 if (hid->collection[i].type == HID_COLLECTION_APPLICATION &&
2168 (hid->collection[i].usage & HID_USAGE_PAGE) == HID_UP_GENDESK &&
2169 (hid->collection[i].usage & 0xffff) < ARRAY_SIZE(hid_types)) {
2170 c = hid_types[hid->collection[i].usage & 0xffff];
2171 break;
2172 }
2173 }
2174
2175 usb_make_path(interface_to_usbdev(intf), path, 63);
2176
2177 printk(": USB HID v%x.%02x %s [%s] on %s\n",
2178 hid->version >> 8, hid->version & 0xff, c, hid->name, path);
2179
2180 return 0;
2181}
2182
David Brownell27d72e82005-04-18 17:39:22 -07002183static int hid_suspend(struct usb_interface *intf, pm_message_t message)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184{
2185 struct hid_device *hid = usb_get_intfdata (intf);
2186
Alan Sternaef4e262006-01-31 12:58:38 -05002187 spin_lock_irq(&hid->inlock); /* Sync with error handler */
2188 set_bit(HID_SUSPENDED, &hid->iofl);
2189 spin_unlock_irq(&hid->inlock);
2190 del_timer(&hid->io_retry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 usb_kill_urb(hid->urbin);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192 dev_dbg(&intf->dev, "suspend\n");
2193 return 0;
2194}
2195
2196static int hid_resume(struct usb_interface *intf)
2197{
2198 struct hid_device *hid = usb_get_intfdata (intf);
2199 int status;
2200
Alan Sternaef4e262006-01-31 12:58:38 -05002201 clear_bit(HID_SUSPENDED, &hid->iofl);
Alan Sterndf9a1f42006-06-01 13:55:28 -04002202 hid->retry_delay = 0;
Alan Sternaef4e262006-01-31 12:58:38 -05002203 status = hid_start_in(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 dev_dbg(&intf->dev, "resume status %d\n", status);
2205 return status;
2206}
2207
Alan Sterndf9a1f42006-06-01 13:55:28 -04002208/* Treat USB reset pretty much the same as suspend/resume */
2209static void hid_pre_reset(struct usb_interface *intf)
2210{
2211 /* FIXME: What if the interface is already suspended? */
2212 hid_suspend(intf, PMSG_ON);
2213}
2214
2215static void hid_post_reset(struct usb_interface *intf)
2216{
2217 struct usb_device *dev = interface_to_usbdev (intf);
2218
2219 hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
2220 /* FIXME: Any more reinitialization needed? */
2221
2222 hid_resume(intf);
2223}
2224
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225static struct usb_device_id hid_usb_ids [] = {
2226 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2227 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
2228 { } /* Terminating entry */
2229};
2230
2231MODULE_DEVICE_TABLE (usb, hid_usb_ids);
2232
2233static struct usb_driver hid_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234 .name = "usbhid",
2235 .probe = hid_probe,
2236 .disconnect = hid_disconnect,
2237 .suspend = hid_suspend,
2238 .resume = hid_resume,
Alan Sterndf9a1f42006-06-01 13:55:28 -04002239 .pre_reset = hid_pre_reset,
2240 .post_reset = hid_post_reset,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241 .id_table = hid_usb_ids,
2242};
2243
2244static int __init hid_init(void)
2245{
2246 int retval;
2247 retval = hiddev_init();
2248 if (retval)
2249 goto hiddev_init_fail;
2250 retval = usb_register(&hid_driver);
2251 if (retval)
2252 goto usb_register_fail;
2253 info(DRIVER_VERSION ":" DRIVER_DESC);
2254
2255 return 0;
2256usb_register_fail:
2257 hiddev_exit();
2258hiddev_init_fail:
2259 return retval;
2260}
2261
2262static void __exit hid_exit(void)
2263{
2264 usb_deregister(&hid_driver);
2265 hiddev_exit();
2266}
2267
2268module_init(hid_init);
2269module_exit(hid_exit);
2270
2271MODULE_AUTHOR(DRIVER_AUTHOR);
2272MODULE_DESCRIPTION(DRIVER_DESC);
2273MODULE_LICENSE(DRIVER_LICENSE);