blob: acb24c6219d962b0961d4ce450a7dae20be55911 [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 Torokhov05f091ab2005-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
273static __inline__ __u32 item_udata(struct hid_item *item)
274{
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
283static __inline__ __s32 item_sdata(struct hid_item *item)
284{
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
546 hid_ff_exit(device);
547
548 for (i = 0; i < HID_REPORT_TYPES; i++) {
549 struct hid_report_enum *report_enum = device->report_enum + i;
550
551 for (j = 0; j < 256; j++) {
552 struct hid_report *report = report_enum->report_id_hash[j];
553 if (report)
554 hid_free_report(report);
555 }
556 }
557
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700558 kfree(device->rdesc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 kfree(device);
560}
561
562/*
563 * Fetch a report description item from the data stream. We support long
564 * items, though they are not used yet.
565 */
566
567static u8 *fetch_item(__u8 *start, __u8 *end, struct hid_item *item)
568{
569 u8 b;
570
571 if ((end - start) <= 0)
572 return NULL;
573
574 b = *start++;
575
576 item->type = (b >> 2) & 3;
577 item->tag = (b >> 4) & 15;
578
579 if (item->tag == HID_ITEM_TAG_LONG) {
580
581 item->format = HID_ITEM_FORMAT_LONG;
582
583 if ((end - start) < 2)
584 return NULL;
585
586 item->size = *start++;
587 item->tag = *start++;
588
589 if ((end - start) < item->size)
590 return NULL;
591
592 item->data.longdata = start;
593 start += item->size;
594 return start;
595 }
596
597 item->format = HID_ITEM_FORMAT_SHORT;
598 item->size = b & 3;
599
600 switch (item->size) {
601
602 case 0:
603 return start;
604
605 case 1:
606 if ((end - start) < 1)
607 return NULL;
608 item->data.u8 = *start++;
609 return start;
610
611 case 2:
612 if ((end - start) < 2)
613 return NULL;
614 item->data.u16 = le16_to_cpu(get_unaligned((__le16*)start));
615 start = (__u8 *)((__le16 *)start + 1);
616 return start;
617
618 case 3:
619 item->size++;
620 if ((end - start) < 4)
621 return NULL;
622 item->data.u32 = le32_to_cpu(get_unaligned((__le32*)start));
623 start = (__u8 *)((__le32 *)start + 1);
624 return start;
625 }
626
627 return NULL;
628}
629
630/*
631 * Parse a report description into a hid_device structure. Reports are
632 * enumerated, fields are attached to these reports.
633 */
634
635static struct hid_device *hid_parse_report(__u8 *start, unsigned size)
636{
637 struct hid_device *device;
638 struct hid_parser *parser;
639 struct hid_item item;
640 __u8 *end;
641 unsigned i;
642 static int (*dispatch_type[])(struct hid_parser *parser,
643 struct hid_item *item) = {
644 hid_parser_main,
645 hid_parser_global,
646 hid_parser_local,
647 hid_parser_reserved
648 };
649
Oliver Neukumbbdb7da2006-01-06 20:54:29 +0100650 if (!(device = kzalloc(sizeof(struct hid_device), GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Oliver Neukumbbdb7da2006-01-06 20:54:29 +0100653 if (!(device->collection = kzalloc(sizeof(struct hid_collection) *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 HID_DEFAULT_NUM_COLLECTIONS, GFP_KERNEL))) {
655 kfree(device);
656 return NULL;
657 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 device->collection_size = HID_DEFAULT_NUM_COLLECTIONS;
659
660 for (i = 0; i < HID_REPORT_TYPES; i++)
661 INIT_LIST_HEAD(&device->report_enum[i].report_list);
662
663 if (!(device->rdesc = (__u8 *)kmalloc(size, GFP_KERNEL))) {
664 kfree(device->collection);
665 kfree(device);
666 return NULL;
667 }
668 memcpy(device->rdesc, start, size);
669 device->rsize = size;
670
Oliver Neukumbbdb7da2006-01-06 20:54:29 +0100671 if (!(parser = kzalloc(sizeof(struct hid_parser), GFP_KERNEL))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 kfree(device->rdesc);
673 kfree(device->collection);
674 kfree(device);
675 return NULL;
676 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 parser->device = device;
678
679 end = start + size;
680 while ((start = fetch_item(start, end, &item)) != NULL) {
681
682 if (item.format != HID_ITEM_FORMAT_SHORT) {
683 dbg("unexpected long global item");
684 kfree(device->collection);
685 hid_free_device(device);
686 kfree(parser);
687 return NULL;
688 }
689
690 if (dispatch_type[item.type](parser, &item)) {
691 dbg("item %u %u %u %u parsing failed\n",
692 item.format, (unsigned)item.size, (unsigned)item.type, (unsigned)item.tag);
693 kfree(device->collection);
694 hid_free_device(device);
695 kfree(parser);
696 return NULL;
697 }
698
699 if (start == end) {
700 if (parser->collection_stack_ptr) {
701 dbg("unbalanced collection at end of report description");
702 kfree(device->collection);
703 hid_free_device(device);
704 kfree(parser);
705 return NULL;
706 }
707 if (parser->local.delimiter_depth) {
708 dbg("unbalanced delimiter at end of report description");
709 kfree(device->collection);
710 hid_free_device(device);
711 kfree(parser);
712 return NULL;
713 }
714 kfree(parser);
715 return device;
716 }
717 }
718
719 dbg("item fetching failed at offset %d\n", (int)(end - start));
720 kfree(device->collection);
721 hid_free_device(device);
722 kfree(parser);
723 return NULL;
724}
725
726/*
727 * Convert a signed n-bit integer to signed 32-bit integer. Common
728 * cases are done through the compiler, the screwed things has to be
729 * done by hand.
730 */
731
732static __inline__ __s32 snto32(__u32 value, unsigned n)
733{
734 switch (n) {
735 case 8: return ((__s8)value);
736 case 16: return ((__s16)value);
737 case 32: return ((__s32)value);
738 }
739 return value & (1 << (n - 1)) ? value | (-1 << n) : value;
740}
741
742/*
743 * Convert a signed 32-bit integer to a signed n-bit integer.
744 */
745
746static __inline__ __u32 s32ton(__s32 value, unsigned n)
747{
748 __s32 a = value >> (n - 1);
749 if (a && a != -1)
750 return value < 0 ? 1 << (n - 1) : (1 << (n - 1)) - 1;
751 return value & ((1 << n) - 1);
752}
753
754/*
755 * Extract/implement a data field from/to a report.
756 */
757
758static __inline__ __u32 extract(__u8 *report, unsigned offset, unsigned n)
759{
760 report += (offset >> 5) << 2; offset &= 31;
Adam Kropelinbef37682005-05-29 02:30:08 -0500761 return (le64_to_cpu(get_unaligned((__le64*)report)) >> offset) & ((1ULL << n) - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762}
763
764static __inline__ void implement(__u8 *report, unsigned offset, unsigned n, __u32 value)
765{
766 report += (offset >> 5) << 2; offset &= 31;
767 put_unaligned((get_unaligned((__le64*)report)
768 & cpu_to_le64(~((((__u64) 1 << n) - 1) << offset)))
769 | cpu_to_le64((__u64)value << offset), (__le64*)report);
770}
771
772/*
773 * Search an array for a value.
774 */
775
776static __inline__ int search(__s32 *array, __s32 value, unsigned n)
777{
778 while (n--) {
779 if (*array++ == value)
780 return 0;
781 }
782 return -1;
783}
784
Adam Kropelinbc5d0482005-07-11 01:09:32 -0500785static void hid_process_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value, int interrupt, struct pt_regs *regs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786{
787 hid_dump_input(usage, value);
788 if (hid->claimed & HID_CLAIMED_INPUT)
789 hidinput_hid_event(hid, field, usage, value, regs);
Adam Kropelinbc5d0482005-07-11 01:09:32 -0500790 if (hid->claimed & HID_CLAIMED_HIDDEV && interrupt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 hiddev_hid_event(hid, field, usage, value, regs);
792}
793
794/*
795 * Analyse a received field, and fetch the data from it. The field
796 * content is stored for next report processing (we do differential
797 * reporting to the layer).
798 */
799
Adam Kropelinbc5d0482005-07-11 01:09:32 -0500800static void hid_input_field(struct hid_device *hid, struct hid_field *field, __u8 *data, int interrupt, struct pt_regs *regs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801{
802 unsigned n;
803 unsigned count = field->report_count;
804 unsigned offset = field->report_offset;
805 unsigned size = field->report_size;
806 __s32 min = field->logical_minimum;
807 __s32 max = field->logical_maximum;
808 __s32 *value;
809
810 if (!(value = kmalloc(sizeof(__s32) * count, GFP_ATOMIC)))
811 return;
812
813 for (n = 0; n < count; n++) {
814
815 value[n] = min < 0 ? snto32(extract(data, offset + n * size, size), size) :
816 extract(data, offset + n * size, size);
817
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)
821 goto exit;
822 }
823
824 for (n = 0; n < count; n++) {
825
826 if (HID_MAIN_ITEM_VARIABLE & field->flags) {
Adam Kropelinbc5d0482005-07-11 01:09:32 -0500827 hid_process_event(hid, field, &field->usage[n], value[n], interrupt, regs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 continue;
829 }
830
831 if (field->value[n] >= min && field->value[n] <= max
832 && field->usage[field->value[n] - min].hid
833 && search(value, field->value[n], count))
Adam Kropelinbc5d0482005-07-11 01:09:32 -0500834 hid_process_event(hid, field, &field->usage[field->value[n] - min], 0, interrupt, regs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
836 if (value[n] >= min && value[n] <= max
837 && field->usage[value[n] - min].hid
838 && search(field->value, value[n], count))
Adam Kropelinbc5d0482005-07-11 01:09:32 -0500839 hid_process_event(hid, field, &field->usage[value[n] - min], 1, interrupt, regs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 }
841
842 memcpy(field->value, value, count * sizeof(__s32));
843exit:
844 kfree(value);
845}
846
Adam Kropelinbc5d0482005-07-11 01:09:32 -0500847static int hid_input_report(int type, struct urb *urb, int interrupt, struct pt_regs *regs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848{
849 struct hid_device *hid = urb->context;
850 struct hid_report_enum *report_enum = hid->report_enum + type;
851 u8 *data = urb->transfer_buffer;
852 int len = urb->actual_length;
853 struct hid_report *report;
854 int n, size;
855
856 if (!len) {
857 dbg("empty report");
858 return -1;
859 }
860
861#ifdef DEBUG_DATA
862 printk(KERN_DEBUG __FILE__ ": report (size %u) (%snumbered)\n", len, report_enum->numbered ? "" : "un");
863#endif
864
865 n = 0; /* Normally report number is 0 */
866 if (report_enum->numbered) { /* Device uses numbered reports, data[0] is report number */
867 n = *data++;
868 len--;
869 }
870
871#ifdef DEBUG_DATA
872 {
873 int i;
874 printk(KERN_DEBUG __FILE__ ": report %d (size %u) = ", n, len);
875 for (i = 0; i < len; i++)
876 printk(" %02x", data[i]);
877 printk("\n");
878 }
879#endif
880
881 if (!(report = report_enum->report_id_hash[n])) {
882 dbg("undefined report_id %d received", n);
883 return -1;
884 }
885
886 size = ((report->size - 1) >> 3) + 1;
887
Adam Kropelincd610452005-12-13 17:03:39 -0800888 if (len < size) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 dbg("report %d is too short, (%d < %d)", report->id, len, size);
Adam Kropelincd610452005-12-13 17:03:39 -0800890 memset(data + len, 0, size - len);
891 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892
893 if (hid->claimed & HID_CLAIMED_HIDDEV)
894 hiddev_report_event(hid, report);
895
896 for (n = 0; n < report->maxfield; n++)
Adam Kropelinbc5d0482005-07-11 01:09:32 -0500897 hid_input_field(hid, report->field[n], data, interrupt, regs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898
899 if (hid->claimed & HID_CLAIMED_INPUT)
900 hidinput_report_event(hid, report);
901
902 return 0;
903}
904
905/*
Alan Sternaef4e262006-01-31 12:58:38 -0500906 * Input submission and I/O error handler.
907 */
908
909static void hid_io_error(struct hid_device *hid);
910
911/* Start up the input URB */
912static int hid_start_in(struct hid_device *hid)
913{
914 unsigned long flags;
915 int rc = 0;
916
917 spin_lock_irqsave(&hid->inlock, flags);
918 if (hid->open > 0 && !test_bit(HID_SUSPENDED, &hid->iofl) &&
919 !test_and_set_bit(HID_IN_RUNNING, &hid->iofl)) {
920 rc = usb_submit_urb(hid->urbin, GFP_ATOMIC);
921 if (rc != 0)
922 clear_bit(HID_IN_RUNNING, &hid->iofl);
923 }
924 spin_unlock_irqrestore(&hid->inlock, flags);
925 return rc;
926}
927
928/* I/O retry timer routine */
929static void hid_retry_timeout(unsigned long _hid)
930{
931 struct hid_device *hid = (struct hid_device *) _hid;
932
933 dev_dbg(&hid->intf->dev, "retrying intr urb\n");
934 if (hid_start_in(hid))
935 hid_io_error(hid);
936}
937
938/* Workqueue routine to reset the device */
939static void hid_reset(void *_hid)
940{
941 struct hid_device *hid = (struct hid_device *) _hid;
942 int rc_lock, rc;
943
944 dev_dbg(&hid->intf->dev, "resetting device\n");
945 rc = rc_lock = usb_lock_device_for_reset(hid->dev, hid->intf);
946 if (rc_lock >= 0) {
Alan Sterndf9a1f42006-06-01 13:55:28 -0400947 rc = usb_reset_composite_device(hid->dev, hid->intf);
Alan Sternaef4e262006-01-31 12:58:38 -0500948 if (rc_lock)
949 usb_unlock_device(hid->dev);
950 }
951 clear_bit(HID_RESET_PENDING, &hid->iofl);
952
Alan Sterndf9a1f42006-06-01 13:55:28 -0400953 switch (rc) {
954 case 0:
955 if (!test_bit(HID_IN_RUNNING, &hid->iofl))
Alan Sternaef4e262006-01-31 12:58:38 -0500956 hid_io_error(hid);
Alan Sterndf9a1f42006-06-01 13:55:28 -0400957 break;
958 default:
Alan Sternaef4e262006-01-31 12:58:38 -0500959 err("can't reset device, %s-%s/input%d, status %d",
960 hid->dev->bus->bus_name,
961 hid->dev->devpath,
962 hid->ifnum, rc);
Alan Sterndf9a1f42006-06-01 13:55:28 -0400963 /* FALLTHROUGH */
964 case -EHOSTUNREACH:
965 case -ENODEV:
966 case -EINTR:
967 break;
968 }
Alan Sternaef4e262006-01-31 12:58:38 -0500969}
970
971/* Main I/O error handler */
972static void hid_io_error(struct hid_device *hid)
973{
974 unsigned long flags;
975
976 spin_lock_irqsave(&hid->inlock, flags);
977
978 /* Stop when disconnected */
979 if (usb_get_intfdata(hid->intf) == NULL)
980 goto done;
981
982 /* When an error occurs, retry at increasing intervals */
983 if (hid->retry_delay == 0) {
984 hid->retry_delay = 13; /* Then 26, 52, 104, 104, ... */
985 hid->stop_retry = jiffies + msecs_to_jiffies(1000);
986 } else if (hid->retry_delay < 100)
987 hid->retry_delay *= 2;
988
989 if (time_after(jiffies, hid->stop_retry)) {
990
991 /* Retries failed, so do a port reset */
992 if (!test_and_set_bit(HID_RESET_PENDING, &hid->iofl)) {
993 if (schedule_work(&hid->reset_work))
994 goto done;
995 clear_bit(HID_RESET_PENDING, &hid->iofl);
996 }
997 }
998
999 mod_timer(&hid->io_retry,
1000 jiffies + msecs_to_jiffies(hid->retry_delay));
1001done:
1002 spin_unlock_irqrestore(&hid->inlock, flags);
1003}
1004
1005/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 * Input interrupt completion handler.
1007 */
1008
1009static void hid_irq_in(struct urb *urb, struct pt_regs *regs)
1010{
1011 struct hid_device *hid = urb->context;
1012 int status;
1013
1014 switch (urb->status) {
1015 case 0: /* success */
Alan Sternaef4e262006-01-31 12:58:38 -05001016 hid->retry_delay = 0;
Adam Kropelinbc5d0482005-07-11 01:09:32 -05001017 hid_input_report(HID_INPUT_REPORT, urb, 1, regs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 break;
1019 case -ECONNRESET: /* unlink */
1020 case -ENOENT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 case -ESHUTDOWN: /* unplug */
Alan Sternaef4e262006-01-31 12:58:38 -05001022 clear_bit(HID_IN_RUNNING, &hid->iofl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 return;
Alan Sternaef4e262006-01-31 12:58:38 -05001024 case -EILSEQ: /* protocol error or unplug */
1025 case -EPROTO: /* protocol error or unplug */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 case -ETIMEDOUT: /* NAK */
Alan Sternaef4e262006-01-31 12:58:38 -05001027 clear_bit(HID_IN_RUNNING, &hid->iofl);
1028 hid_io_error(hid);
1029 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 default: /* error */
1031 warn("input irq status %d received", urb->status);
1032 }
1033
1034 status = usb_submit_urb(urb, SLAB_ATOMIC);
Alan Sternaef4e262006-01-31 12:58:38 -05001035 if (status) {
1036 clear_bit(HID_IN_RUNNING, &hid->iofl);
1037 if (status != -EPERM) {
1038 err("can't resubmit intr, %s-%s/input%d, status %d",
1039 hid->dev->bus->bus_name,
1040 hid->dev->devpath,
1041 hid->ifnum, status);
1042 hid_io_error(hid);
1043 }
1044 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045}
1046
1047/*
1048 * Output the field into the report.
1049 */
1050
1051static void hid_output_field(struct hid_field *field, __u8 *data)
1052{
1053 unsigned count = field->report_count;
1054 unsigned offset = field->report_offset;
1055 unsigned size = field->report_size;
1056 unsigned n;
1057
1058 for (n = 0; n < count; n++) {
1059 if (field->logical_minimum < 0) /* signed values */
1060 implement(data, offset + n * size, size, s32ton(field->value[n], size));
1061 else /* unsigned values */
1062 implement(data, offset + n * size, size, field->value[n]);
1063 }
1064}
1065
1066/*
1067 * Create a report.
1068 */
1069
1070static void hid_output_report(struct hid_report *report, __u8 *data)
1071{
1072 unsigned n;
1073
1074 if (report->id > 0)
1075 *data++ = report->id;
1076
1077 for (n = 0; n < report->maxfield; n++)
1078 hid_output_field(report->field[n], data);
1079}
1080
1081/*
1082 * Set a field value. The report this field belongs to has to be
1083 * created and transferred to the device, to set this value in the
1084 * device.
1085 */
1086
1087int hid_set_field(struct hid_field *field, unsigned offset, __s32 value)
1088{
1089 unsigned size = field->report_size;
1090
1091 hid_dump_input(field->usage + offset, value);
1092
1093 if (offset >= field->report_count) {
1094 dbg("offset (%d) exceeds report_count (%d)", offset, field->report_count);
1095 hid_dump_field(field, 8);
1096 return -1;
1097 }
1098 if (field->logical_minimum < 0) {
1099 if (value != snto32(s32ton(value, size), size)) {
1100 dbg("value %d is out of range", value);
1101 return -1;
1102 }
1103 }
1104 field->value[offset] = value;
1105 return 0;
1106}
1107
1108/*
1109 * Find a report field with a specified HID usage.
1110 */
1111
1112struct hid_field *hid_find_field_by_usage(struct hid_device *hid, __u32 wanted_usage, int type)
1113{
1114 struct hid_report *report;
1115 int i;
1116
1117 list_for_each_entry(report, &hid->report_enum[type].report_list, list)
1118 for (i = 0; i < report->maxfield; i++)
1119 if (report->field[i]->logical == wanted_usage)
1120 return report->field[i];
1121 return NULL;
1122}
1123
1124static int hid_submit_out(struct hid_device *hid)
1125{
1126 struct hid_report *report;
1127
1128 report = hid->out[hid->outtail];
1129
1130 hid_output_report(report, hid->outbuf);
1131 hid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
1132 hid->urbout->dev = hid->dev;
1133
1134 dbg("submitting out urb");
1135
1136 if (usb_submit_urb(hid->urbout, GFP_ATOMIC)) {
1137 err("usb_submit_urb(out) failed");
1138 return -1;
1139 }
1140
1141 return 0;
1142}
1143
1144static int hid_submit_ctrl(struct hid_device *hid)
1145{
1146 struct hid_report *report;
1147 unsigned char dir;
1148 int len;
1149
1150 report = hid->ctrl[hid->ctrltail].report;
1151 dir = hid->ctrl[hid->ctrltail].dir;
1152
1153 len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
1154 if (dir == USB_DIR_OUT) {
1155 hid_output_report(report, hid->ctrlbuf);
1156 hid->urbctrl->pipe = usb_sndctrlpipe(hid->dev, 0);
1157 hid->urbctrl->transfer_buffer_length = len;
1158 } else {
1159 int maxpacket, padlen;
1160
1161 hid->urbctrl->pipe = usb_rcvctrlpipe(hid->dev, 0);
1162 maxpacket = usb_maxpacket(hid->dev, hid->urbctrl->pipe, 0);
1163 if (maxpacket > 0) {
1164 padlen = (len + maxpacket - 1) / maxpacket;
1165 padlen *= maxpacket;
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001166 if (padlen > hid->bufsize)
1167 padlen = hid->bufsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 } else
1169 padlen = 0;
1170 hid->urbctrl->transfer_buffer_length = padlen;
1171 }
1172 hid->urbctrl->dev = hid->dev;
1173
1174 hid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
1175 hid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
1176 hid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
1177 hid->cr->wIndex = cpu_to_le16(hid->ifnum);
1178 hid->cr->wLength = cpu_to_le16(len);
1179
1180 dbg("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u",
1181 hid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
1182 hid->cr->wValue, hid->cr->wIndex, hid->cr->wLength);
1183
1184 if (usb_submit_urb(hid->urbctrl, GFP_ATOMIC)) {
1185 err("usb_submit_urb(ctrl) failed");
1186 return -1;
1187 }
1188
1189 return 0;
1190}
1191
1192/*
1193 * Output interrupt completion handler.
1194 */
1195
1196static void hid_irq_out(struct urb *urb, struct pt_regs *regs)
1197{
1198 struct hid_device *hid = urb->context;
1199 unsigned long flags;
1200 int unplug = 0;
1201
1202 switch (urb->status) {
1203 case 0: /* success */
Vojtech Pavlikc4786ca2005-09-05 00:13:03 -05001204 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 case -ESHUTDOWN: /* unplug */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 unplug = 1;
Alan Sternaef4e262006-01-31 12:58:38 -05001207 case -EILSEQ: /* protocol error or unplug */
1208 case -EPROTO: /* protocol error or unplug */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 case -ECONNRESET: /* unlink */
1210 case -ENOENT:
1211 break;
1212 default: /* error */
1213 warn("output irq status %d received", urb->status);
1214 }
1215
1216 spin_lock_irqsave(&hid->outlock, flags);
1217
1218 if (unplug)
1219 hid->outtail = hid->outhead;
1220 else
1221 hid->outtail = (hid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
1222
1223 if (hid->outhead != hid->outtail) {
1224 if (hid_submit_out(hid)) {
Alexey Dobriyan53b35312006-03-24 03:16:13 -08001225 clear_bit(HID_OUT_RUNNING, &hid->iofl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 wake_up(&hid->wait);
1227 }
1228 spin_unlock_irqrestore(&hid->outlock, flags);
1229 return;
1230 }
1231
1232 clear_bit(HID_OUT_RUNNING, &hid->iofl);
1233 spin_unlock_irqrestore(&hid->outlock, flags);
1234 wake_up(&hid->wait);
1235}
1236
1237/*
1238 * Control pipe completion handler.
1239 */
1240
1241static void hid_ctrl(struct urb *urb, struct pt_regs *regs)
1242{
1243 struct hid_device *hid = urb->context;
1244 unsigned long flags;
1245 int unplug = 0;
1246
1247 spin_lock_irqsave(&hid->ctrllock, flags);
1248
1249 switch (urb->status) {
1250 case 0: /* success */
1251 if (hid->ctrl[hid->ctrltail].dir == USB_DIR_IN)
Adam Kropelinbc5d0482005-07-11 01:09:32 -05001252 hid_input_report(hid->ctrl[hid->ctrltail].report->type, urb, 0, regs);
Vojtech Pavlikc4786ca2005-09-05 00:13:03 -05001253 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 case -ESHUTDOWN: /* unplug */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 unplug = 1;
Alan Sternaef4e262006-01-31 12:58:38 -05001256 case -EILSEQ: /* protocol error or unplug */
1257 case -EPROTO: /* protocol error or unplug */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258 case -ECONNRESET: /* unlink */
1259 case -ENOENT:
1260 case -EPIPE: /* report not available */
1261 break;
1262 default: /* error */
1263 warn("ctrl urb status %d received", urb->status);
1264 }
1265
1266 if (unplug)
1267 hid->ctrltail = hid->ctrlhead;
1268 else
1269 hid->ctrltail = (hid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
1270
1271 if (hid->ctrlhead != hid->ctrltail) {
1272 if (hid_submit_ctrl(hid)) {
1273 clear_bit(HID_CTRL_RUNNING, &hid->iofl);
1274 wake_up(&hid->wait);
1275 }
1276 spin_unlock_irqrestore(&hid->ctrllock, flags);
1277 return;
1278 }
1279
1280 clear_bit(HID_CTRL_RUNNING, &hid->iofl);
1281 spin_unlock_irqrestore(&hid->ctrllock, flags);
1282 wake_up(&hid->wait);
1283}
1284
1285void hid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
1286{
1287 int head;
1288 unsigned long flags;
1289
1290 if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
1291 return;
1292
1293 if (hid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
1294
1295 spin_lock_irqsave(&hid->outlock, flags);
1296
1297 if ((head = (hid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == hid->outtail) {
1298 spin_unlock_irqrestore(&hid->outlock, flags);
1299 warn("output queue full");
1300 return;
1301 }
1302
1303 hid->out[hid->outhead] = report;
1304 hid->outhead = head;
1305
1306 if (!test_and_set_bit(HID_OUT_RUNNING, &hid->iofl))
1307 if (hid_submit_out(hid))
1308 clear_bit(HID_OUT_RUNNING, &hid->iofl);
1309
1310 spin_unlock_irqrestore(&hid->outlock, flags);
1311 return;
1312 }
1313
1314 spin_lock_irqsave(&hid->ctrllock, flags);
1315
1316 if ((head = (hid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == hid->ctrltail) {
1317 spin_unlock_irqrestore(&hid->ctrllock, flags);
1318 warn("control queue full");
1319 return;
1320 }
1321
1322 hid->ctrl[hid->ctrlhead].report = report;
1323 hid->ctrl[hid->ctrlhead].dir = dir;
1324 hid->ctrlhead = head;
1325
1326 if (!test_and_set_bit(HID_CTRL_RUNNING, &hid->iofl))
1327 if (hid_submit_ctrl(hid))
1328 clear_bit(HID_CTRL_RUNNING, &hid->iofl);
1329
1330 spin_unlock_irqrestore(&hid->ctrllock, flags);
1331}
1332
1333int hid_wait_io(struct hid_device *hid)
1334{
1335 if (!wait_event_timeout(hid->wait, (!test_bit(HID_CTRL_RUNNING, &hid->iofl) &&
1336 !test_bit(HID_OUT_RUNNING, &hid->iofl)),
1337 10*HZ)) {
1338 dbg("timeout waiting for ctrl or out queue to clear");
1339 return -1;
1340 }
1341
1342 return 0;
1343}
1344
Vojtech Pavlik854561b2005-05-29 02:28:00 -05001345static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
1346{
Vojtech Pavlik71387bd72005-05-29 02:28:14 -05001347 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
Vojtech Pavlik854561b2005-05-29 02:28:00 -05001348 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
1349 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
1350}
1351
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
1353 unsigned char type, void *buf, int size)
1354{
1355 int result, retries = 4;
1356
1357 memset(buf,0,size); // Make sure we parse really received data
1358
1359 do {
1360 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
1361 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
1362 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
1363 retries--;
1364 } while (result < size && retries);
1365 return result;
1366}
1367
1368int hid_open(struct hid_device *hid)
1369{
Alan Sternaef4e262006-01-31 12:58:38 -05001370 ++hid->open;
1371 if (hid_start_in(hid))
1372 hid_io_error(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 return 0;
1374}
1375
1376void hid_close(struct hid_device *hid)
1377{
1378 if (!--hid->open)
1379 usb_kill_urb(hid->urbin);
1380}
1381
Daniel Ritz1d3e2022006-03-29 22:41:07 +02001382#define USB_VENDOR_ID_PANJIT 0x134c
1383
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384/*
1385 * Initialize all reports
1386 */
1387
1388void hid_init_reports(struct hid_device *hid)
1389{
1390 struct hid_report *report;
1391 int err, ret;
1392
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001393 list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 hid_submit_report(hid, report, USB_DIR_IN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395
1396 list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
1397 hid_submit_report(hid, report, USB_DIR_IN);
1398
1399 err = 0;
1400 ret = hid_wait_io(hid);
1401 while (ret) {
1402 err |= ret;
1403 if (test_bit(HID_CTRL_RUNNING, &hid->iofl))
1404 usb_kill_urb(hid->urbctrl);
1405 if (test_bit(HID_OUT_RUNNING, &hid->iofl))
1406 usb_kill_urb(hid->urbout);
1407 ret = hid_wait_io(hid);
1408 }
1409
1410 if (err)
Olaf Heringde289fd2006-01-06 12:45:28 +01001411 warn("timeout initializing reports");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412}
1413
Jeremy Roberson6f8d9e22006-08-28 19:58:28 -07001414#define USB_VENDOR_ID_GTCO 0x078c
1415#define USB_DEVICE_ID_GTCO_90 0x0090
1416#define USB_DEVICE_ID_GTCO_100 0x0100
1417#define USB_DEVICE_ID_GTCO_101 0x0101
1418#define USB_DEVICE_ID_GTCO_103 0x0103
1419#define USB_DEVICE_ID_GTCO_104 0x0104
1420#define USB_DEVICE_ID_GTCO_105 0x0105
1421#define USB_DEVICE_ID_GTCO_106 0x0106
1422#define USB_DEVICE_ID_GTCO_107 0x0107
1423#define USB_DEVICE_ID_GTCO_108 0x0108
1424#define USB_DEVICE_ID_GTCO_200 0x0200
1425#define USB_DEVICE_ID_GTCO_201 0x0201
1426#define USB_DEVICE_ID_GTCO_202 0x0202
1427#define USB_DEVICE_ID_GTCO_203 0x0203
1428#define USB_DEVICE_ID_GTCO_204 0x0204
1429#define USB_DEVICE_ID_GTCO_205 0x0205
1430#define USB_DEVICE_ID_GTCO_206 0x0206
1431#define USB_DEVICE_ID_GTCO_207 0x0207
1432#define USB_DEVICE_ID_GTCO_300 0x0300
1433#define USB_DEVICE_ID_GTCO_301 0x0301
1434#define USB_DEVICE_ID_GTCO_302 0x0302
1435#define USB_DEVICE_ID_GTCO_303 0x0303
1436#define USB_DEVICE_ID_GTCO_304 0x0304
1437#define USB_DEVICE_ID_GTCO_305 0x0305
1438#define USB_DEVICE_ID_GTCO_306 0x0306
1439#define USB_DEVICE_ID_GTCO_307 0x0307
1440#define USB_DEVICE_ID_GTCO_308 0x0308
1441#define USB_DEVICE_ID_GTCO_309 0x0309
1442#define USB_DEVICE_ID_GTCO_400 0x0400
1443#define USB_DEVICE_ID_GTCO_401 0x0401
1444#define USB_DEVICE_ID_GTCO_402 0x0402
1445#define USB_DEVICE_ID_GTCO_403 0x0403
1446#define USB_DEVICE_ID_GTCO_404 0x0404
1447#define USB_DEVICE_ID_GTCO_404 0x0405
1448#define USB_DEVICE_ID_GTCO_500 0x0500
1449#define USB_DEVICE_ID_GTCO_501 0x0501
1450#define USB_DEVICE_ID_GTCO_502 0x0502
1451#define USB_DEVICE_ID_GTCO_503 0x0503
1452#define USB_DEVICE_ID_GTCO_504 0x0504
1453#define USB_DEVICE_ID_GTCO_1000 0x1000
1454#define USB_DEVICE_ID_GTCO_1001 0x1001
1455#define USB_DEVICE_ID_GTCO_1002 0x1002
1456#define USB_DEVICE_ID_GTCO_1003 0x1003
1457#define USB_DEVICE_ID_GTCO_1004 0x1004
1458#define USB_DEVICE_ID_GTCO_1005 0x1005
1459#define USB_DEVICE_ID_GTCO_1006 0x1006
1460
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461#define USB_VENDOR_ID_WACOM 0x056a
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462
Stephane VOLTZ53880542005-06-06 02:22:37 -05001463#define USB_VENDOR_ID_ACECAD 0x0460
1464#define USB_DEVICE_ID_ACECAD_FLAIR 0x0004
1465#define USB_DEVICE_ID_ACECAD_302 0x0008
1466
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467#define USB_VENDOR_ID_KBGEAR 0x084e
1468#define USB_DEVICE_ID_KBGEAR_JAMSTUDIO 0x1001
1469
1470#define USB_VENDOR_ID_AIPTEK 0x08ca
1471#define USB_DEVICE_ID_AIPTEK_01 0x0001
1472#define USB_DEVICE_ID_AIPTEK_10 0x0010
1473#define USB_DEVICE_ID_AIPTEK_20 0x0020
1474#define USB_DEVICE_ID_AIPTEK_21 0x0021
1475#define USB_DEVICE_ID_AIPTEK_22 0x0022
1476#define USB_DEVICE_ID_AIPTEK_23 0x0023
1477#define USB_DEVICE_ID_AIPTEK_24 0x0024
1478
1479#define USB_VENDOR_ID_GRIFFIN 0x077d
1480#define USB_DEVICE_ID_POWERMATE 0x0410
1481#define USB_DEVICE_ID_SOUNDKNOB 0x04AA
1482
1483#define USB_VENDOR_ID_ATEN 0x0557
1484#define USB_DEVICE_ID_ATEN_UC100KM 0x2004
1485#define USB_DEVICE_ID_ATEN_CS124U 0x2202
1486#define USB_DEVICE_ID_ATEN_2PORTKVM 0x2204
1487#define USB_DEVICE_ID_ATEN_4PORTKVM 0x2205
1488#define USB_DEVICE_ID_ATEN_4PORTKVMC 0x2208
1489
1490#define USB_VENDOR_ID_TOPMAX 0x0663
1491#define USB_DEVICE_ID_TOPMAX_COBRAPAD 0x0103
1492
1493#define USB_VENDOR_ID_HAPP 0x078b
1494#define USB_DEVICE_ID_UGCI_DRIVING 0x0010
1495#define USB_DEVICE_ID_UGCI_FLYING 0x0020
1496#define USB_DEVICE_ID_UGCI_FIGHTING 0x0030
1497
1498#define USB_VENDOR_ID_MGE 0x0463
1499#define USB_DEVICE_ID_MGE_UPS 0xffff
1500#define USB_DEVICE_ID_MGE_UPS1 0x0001
1501
1502#define USB_VENDOR_ID_ONTRAK 0x0a07
1503#define USB_DEVICE_ID_ONTRAK_ADU100 0x0064
1504
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505#define USB_VENDOR_ID_ESSENTIAL_REALITY 0x0d7f
1506#define USB_DEVICE_ID_ESSENTIAL_REALITY_P5 0x0100
1507
1508#define USB_VENDOR_ID_A4TECH 0x09da
1509#define USB_DEVICE_ID_A4TECH_WCP32PU 0x0006
1510
Vojtech Pavlik61cdecd2005-09-05 00:13:32 -05001511#define USB_VENDOR_ID_AASHIMA 0x06d6
Luca T6345fdf2005-07-11 01:08:40 -05001512#define USB_DEVICE_ID_AASHIMA_GAMEPAD 0x0025
Vojtech Pavlik61cdecd2005-09-05 00:13:32 -05001513#define USB_DEVICE_ID_AASHIMA_PREDATOR 0x0026
Luca T6345fdf2005-07-11 01:08:40 -05001514
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515#define USB_VENDOR_ID_CYPRESS 0x04b4
1516#define USB_DEVICE_ID_CYPRESS_MOUSE 0x0001
1517#define USB_DEVICE_ID_CYPRESS_HIDCOM 0x5500
Brian Schau7d252582005-09-05 01:57:41 -05001518#define USB_DEVICE_ID_CYPRESS_ULTRAMOUSE 0x7417
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519
1520#define USB_VENDOR_ID_BERKSHIRE 0x0c98
1521#define USB_DEVICE_ID_BERKSHIRE_PCWD 0x1140
1522
1523#define USB_VENDOR_ID_ALPS 0x0433
1524#define USB_DEVICE_ID_IBM_GAMEPAD 0x1101
1525
1526#define USB_VENDOR_ID_SAITEK 0x06a3
1527#define USB_DEVICE_ID_SAITEK_RUMBLEPAD 0xff17
1528
1529#define USB_VENDOR_ID_NEC 0x073e
1530#define USB_DEVICE_ID_NEC_USB_GAME_PAD 0x0301
1531
1532#define USB_VENDOR_ID_CHIC 0x05fe
1533#define USB_DEVICE_ID_CHIC_GAMEPAD 0x0014
1534
1535#define USB_VENDOR_ID_GLAB 0x06c2
1536#define USB_DEVICE_ID_4_PHIDGETSERVO_30 0x0038
1537#define USB_DEVICE_ID_1_PHIDGETSERVO_30 0x0039
1538#define USB_DEVICE_ID_8_8_8_IF_KIT 0x0045
1539#define USB_DEVICE_ID_0_0_4_IF_KIT 0x0040
1540#define USB_DEVICE_ID_0_8_8_IF_KIT 0x0053
1541
1542#define USB_VENDOR_ID_WISEGROUP 0x0925
1543#define USB_DEVICE_ID_1_PHIDGETSERVO_20 0x8101
1544#define USB_DEVICE_ID_4_PHIDGETSERVO_20 0x8104
Andrew Fullere65335e2006-02-25 09:52:27 -05001545#define USB_DEVICE_ID_DUAL_USB_JOYPAD 0x8866
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546
Navaho Gunlegb857c652006-06-30 09:44:03 +02001547#define USB_VENDOR_ID_WISEGROUP_LTD 0x6677
1548#define USB_DEVICE_ID_SMARTJOY_DUAL_PLUS 0x8802
1549
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550#define USB_VENDOR_ID_CODEMERCS 0x07c0
1551#define USB_DEVICE_ID_CODEMERCS_IOW40 0x1500
1552#define USB_DEVICE_ID_CODEMERCS_IOW24 0x1501
1553#define USB_DEVICE_ID_CODEMERCS_IOW48 0x1502
1554#define USB_DEVICE_ID_CODEMERCS_IOW28 0x1503
1555
1556#define USB_VENDOR_ID_DELORME 0x1163
1557#define USB_DEVICE_ID_DELORME_EARTHMATE 0x0100
Lonnie Mendezdc1d1002005-05-10 00:17:17 -05001558#define USB_DEVICE_ID_DELORME_EM_LT20 0x0200
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
1560#define USB_VENDOR_ID_MCC 0x09db
1561#define USB_DEVICE_ID_MCC_PMD1024LS 0x0076
1562#define USB_DEVICE_ID_MCC_PMD1208LS 0x007a
1563
Greg Kroah-Hartman4871d3b2005-06-02 22:18:12 -07001564#define USB_VENDOR_ID_VERNIER 0x08f7
1565#define USB_DEVICE_ID_VERNIER_LABPRO 0x0001
1566#define USB_DEVICE_ID_VERNIER_GOTEMP 0x0002
1567#define USB_DEVICE_ID_VERNIER_SKIP 0x0003
1568#define USB_DEVICE_ID_VERNIER_CYCLOPS 0x0004
1569
Michael Hund8fd6db42005-06-27 22:44:22 +02001570#define USB_VENDOR_ID_LD 0x0f11
Michael Hundba3e66e2006-02-02 09:36:43 +01001571#define USB_DEVICE_ID_LD_CASSY 0x1000
1572#define USB_DEVICE_ID_LD_POCKETCASSY 0x1010
1573#define USB_DEVICE_ID_LD_MOBILECASSY 0x1020
1574#define USB_DEVICE_ID_LD_JWM 0x1080
1575#define USB_DEVICE_ID_LD_DMMP 0x1081
1576#define USB_DEVICE_ID_LD_UMIP 0x1090
1577#define USB_DEVICE_ID_LD_XRAY1 0x1100
1578#define USB_DEVICE_ID_LD_XRAY2 0x1101
1579#define USB_DEVICE_ID_LD_VIDEOCOM 0x1200
1580#define USB_DEVICE_ID_LD_COM3LAB 0x2000
1581#define USB_DEVICE_ID_LD_TELEPORT 0x2010
1582#define USB_DEVICE_ID_LD_NETWORKANALYSER 0x2020
1583#define USB_DEVICE_ID_LD_POWERCONTROL 0x2030
1584#define USB_DEVICE_ID_LD_MACHINETEST 0x2040
Michael Hund8fd6db42005-06-27 22:44:22 +02001585
Vojtech Pavlikc58de6d2005-09-05 00:13:15 -05001586#define USB_VENDOR_ID_APPLE 0x05ac
Bart Masseya82e49b2006-05-08 14:40:13 -07001587#define USB_DEVICE_ID_APPLE_MIGHTYMOUSE 0x0304
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588
Vojtech Pavlik940824b2006-01-14 00:25:39 -05001589#define USB_VENDOR_ID_CHERRY 0x046a
1590#define USB_DEVICE_ID_CHERRY_CYMOTION 0x0023
1591
Henk Vergonet5cd330f2006-05-15 12:34:43 +02001592#define USB_VENDOR_ID_YEALINK 0x6993
1593#define USB_DEVICE_ID_YEALINK_P1K_P4K_B2K 0xb001
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594/*
1595 * Alphabetically sorted blacklist by quirk type.
1596 */
1597
Arjan van de Ven4c4c9432005-11-29 09:43:42 +01001598static const struct hid_blacklist {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 __u16 idVendor;
1600 __u16 idProduct;
1601 unsigned quirks;
1602} hid_blacklist[] = {
1603
1604 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_01, HID_QUIRK_IGNORE },
1605 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_10, HID_QUIRK_IGNORE },
1606 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_20, HID_QUIRK_IGNORE },
1607 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_21, HID_QUIRK_IGNORE },
1608 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_22, HID_QUIRK_IGNORE },
1609 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_23, HID_QUIRK_IGNORE },
1610 { USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_24, HID_QUIRK_IGNORE },
1611 { USB_VENDOR_ID_BERKSHIRE, USB_DEVICE_ID_BERKSHIRE_PCWD, HID_QUIRK_IGNORE },
1612 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW40, HID_QUIRK_IGNORE },
1613 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW24, HID_QUIRK_IGNORE },
1614 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW48, HID_QUIRK_IGNORE },
1615 { USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW28, HID_QUIRK_IGNORE },
1616 { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_HIDCOM, HID_QUIRK_IGNORE },
Brian Schau7d252582005-09-05 01:57:41 -05001617 { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_ULTRAMOUSE, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 { USB_VENDOR_ID_DELORME, USB_DEVICE_ID_DELORME_EARTHMATE, HID_QUIRK_IGNORE },
Lonnie Mendezdc1d1002005-05-10 00:17:17 -05001619 { USB_VENDOR_ID_DELORME, USB_DEVICE_ID_DELORME_EM_LT20, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 { USB_VENDOR_ID_ESSENTIAL_REALITY, USB_DEVICE_ID_ESSENTIAL_REALITY_P5, HID_QUIRK_IGNORE },
1621 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_4_PHIDGETSERVO_30, HID_QUIRK_IGNORE },
1622 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_1_PHIDGETSERVO_30, HID_QUIRK_IGNORE },
1623 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_8_8_8_IF_KIT, HID_QUIRK_IGNORE },
1624 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_0_4_IF_KIT, HID_QUIRK_IGNORE },
1625 { USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_8_8_IF_KIT, HID_QUIRK_IGNORE },
1626 { USB_VENDOR_ID_GRIFFIN, USB_DEVICE_ID_POWERMATE, HID_QUIRK_IGNORE },
1627 { USB_VENDOR_ID_GRIFFIN, USB_DEVICE_ID_SOUNDKNOB, HID_QUIRK_IGNORE },
Jeremy Roberson6f8d9e22006-08-28 19:58:28 -07001628 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_90, HID_QUIRK_IGNORE },
1629 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_100, HID_QUIRK_IGNORE },
1630 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_101, HID_QUIRK_IGNORE },
1631 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_103, HID_QUIRK_IGNORE },
1632 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_104, HID_QUIRK_IGNORE },
1633 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_105, HID_QUIRK_IGNORE },
1634 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_106, HID_QUIRK_IGNORE },
1635 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_107, HID_QUIRK_IGNORE },
1636 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_108, HID_QUIRK_IGNORE },
1637 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_200, HID_QUIRK_IGNORE },
1638 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_201, HID_QUIRK_IGNORE },
1639 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_202, HID_QUIRK_IGNORE },
1640 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_203, HID_QUIRK_IGNORE },
1641 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_204, HID_QUIRK_IGNORE },
1642 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_205, HID_QUIRK_IGNORE },
1643 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_206, HID_QUIRK_IGNORE },
1644 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_207, HID_QUIRK_IGNORE },
1645 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_300, HID_QUIRK_IGNORE },
1646 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_301, HID_QUIRK_IGNORE },
1647 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_302, HID_QUIRK_IGNORE },
1648 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_303, HID_QUIRK_IGNORE },
1649 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_304, HID_QUIRK_IGNORE },
1650 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_305, HID_QUIRK_IGNORE },
1651 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_306, HID_QUIRK_IGNORE },
1652 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_307, HID_QUIRK_IGNORE },
1653 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_308, HID_QUIRK_IGNORE },
1654 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_309, HID_QUIRK_IGNORE },
1655 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_400, HID_QUIRK_IGNORE },
1656 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_401, HID_QUIRK_IGNORE },
1657 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_402, HID_QUIRK_IGNORE },
1658 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_403, HID_QUIRK_IGNORE },
1659 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_404, HID_QUIRK_IGNORE },
1660 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_404, HID_QUIRK_IGNORE },
1661 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_500, HID_QUIRK_IGNORE },
1662 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_501, HID_QUIRK_IGNORE },
1663 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_502, HID_QUIRK_IGNORE },
1664 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_503, HID_QUIRK_IGNORE },
1665 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_504, HID_QUIRK_IGNORE },
1666 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1000, HID_QUIRK_IGNORE },
1667 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1001, HID_QUIRK_IGNORE },
1668 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1002, HID_QUIRK_IGNORE },
1669 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1003, HID_QUIRK_IGNORE },
1670 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1004, HID_QUIRK_IGNORE },
1671 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1005, HID_QUIRK_IGNORE },
1672 { USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1006, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 { USB_VENDOR_ID_KBGEAR, USB_DEVICE_ID_KBGEAR_JAMSTUDIO, HID_QUIRK_IGNORE },
Michael Hundba3e66e2006-02-02 09:36:43 +01001674 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_CASSY, HID_QUIRK_IGNORE },
1675 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POCKETCASSY, HID_QUIRK_IGNORE },
1676 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MOBILECASSY, HID_QUIRK_IGNORE },
1677 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_JWM, HID_QUIRK_IGNORE },
1678 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_DMMP, HID_QUIRK_IGNORE },
1679 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_UMIP, HID_QUIRK_IGNORE },
1680 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_XRAY1, HID_QUIRK_IGNORE },
1681 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_XRAY2, HID_QUIRK_IGNORE },
1682 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_VIDEOCOM, HID_QUIRK_IGNORE },
1683 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_COM3LAB, HID_QUIRK_IGNORE },
1684 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_TELEPORT, HID_QUIRK_IGNORE },
1685 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_NETWORKANALYSER, HID_QUIRK_IGNORE },
1686 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POWERCONTROL, HID_QUIRK_IGNORE },
1687 { USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MACHINETEST, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 { USB_VENDOR_ID_MCC, USB_DEVICE_ID_MCC_PMD1024LS, HID_QUIRK_IGNORE },
1689 { USB_VENDOR_ID_MCC, USB_DEVICE_ID_MCC_PMD1208LS, HID_QUIRK_IGNORE },
1690 { USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS, HID_QUIRK_IGNORE },
1691 { USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS1, HID_QUIRK_IGNORE },
1692 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100, HID_QUIRK_IGNORE },
1693 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 100, HID_QUIRK_IGNORE },
1694 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 200, HID_QUIRK_IGNORE },
1695 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 300, HID_QUIRK_IGNORE },
1696 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 400, HID_QUIRK_IGNORE },
1697 { USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 500, HID_QUIRK_IGNORE },
Greg Kroah-Hartman4871d3b2005-06-02 22:18:12 -07001698 { USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_LABPRO, HID_QUIRK_IGNORE },
1699 { USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_GOTEMP, HID_QUIRK_IGNORE },
1700 { USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_SKIP, HID_QUIRK_IGNORE },
1701 { USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_CYCLOPS, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_4_PHIDGETSERVO_20, HID_QUIRK_IGNORE },
1703 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_1_PHIDGETSERVO_20, HID_QUIRK_IGNORE },
Henk Vergonet5cd330f2006-05-15 12:34:43 +02001704 { USB_VENDOR_ID_YEALINK, USB_DEVICE_ID_YEALINK_P1K_P4K_B2K, HID_QUIRK_IGNORE },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705
Stephane VOLTZ53880542005-06-06 02:22:37 -05001706 { USB_VENDOR_ID_ACECAD, USB_DEVICE_ID_ACECAD_FLAIR, HID_QUIRK_IGNORE },
1707 { USB_VENDOR_ID_ACECAD, USB_DEVICE_ID_ACECAD_302, HID_QUIRK_IGNORE },
1708
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
1710 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
1711 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
1712 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
1713 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
Andrew Fullere65335e2006-02-25 09:52:27 -05001714 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
Navaho Gunlegb857c652006-06-30 09:44:03 +02001715 { 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 -07001716
Bart Masseya82e49b2006-05-08 14:40:13 -07001717 { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE, HID_QUIRK_MIGHTYMOUSE | HID_QUIRK_INVERT_HWHEEL },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718 { USB_VENDOR_ID_A4TECH, USB_DEVICE_ID_A4TECH_WCP32PU, HID_QUIRK_2WHEEL_MOUSE_HACK_7 },
1719 { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_MOUSE, HID_QUIRK_2WHEEL_MOUSE_HACK_5 },
1720
Luca T6345fdf2005-07-11 01:08:40 -05001721 { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_GAMEPAD, HID_QUIRK_BADPAD },
Vojtech Pavlik61cdecd2005-09-05 00:13:32 -05001722 { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_PREDATOR, HID_QUIRK_BADPAD },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 { USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
1724 { USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
1725 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1726 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1727 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
1728 { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
1729 { USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
1730 { USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },
1731
Vojtech Pavlik940824b2006-01-14 00:25:39 -05001732 { USB_VENDOR_ID_CHERRY, USB_DEVICE_ID_CHERRY_CYMOTION, HID_QUIRK_CYMOTION },
1733
Michael Hanselmanneab9edd2006-01-14 10:08:06 -05001734 { USB_VENDOR_ID_APPLE, 0x020E, HID_QUIRK_POWERBOOK_HAS_FN },
1735 { USB_VENDOR_ID_APPLE, 0x020F, HID_QUIRK_POWERBOOK_HAS_FN },
1736 { USB_VENDOR_ID_APPLE, 0x0214, HID_QUIRK_POWERBOOK_HAS_FN },
1737 { USB_VENDOR_ID_APPLE, 0x0215, HID_QUIRK_POWERBOOK_HAS_FN },
1738 { USB_VENDOR_ID_APPLE, 0x0216, HID_QUIRK_POWERBOOK_HAS_FN },
Rene Rebe5c218e32006-06-04 11:39:09 +02001739 { USB_VENDOR_ID_APPLE, 0x0217, HID_QUIRK_POWERBOOK_HAS_FN },
1740 { USB_VENDOR_ID_APPLE, 0x0218, HID_QUIRK_POWERBOOK_HAS_FN },
1741 { USB_VENDOR_ID_APPLE, 0x0219, HID_QUIRK_POWERBOOK_HAS_FN },
Michael Hanselmanneab9edd2006-01-14 10:08:06 -05001742 { USB_VENDOR_ID_APPLE, 0x030A, HID_QUIRK_POWERBOOK_HAS_FN },
1743 { USB_VENDOR_ID_APPLE, 0x030B, HID_QUIRK_POWERBOOK_HAS_FN },
1744
Daniel Ritz1d3e2022006-03-29 22:41:07 +02001745 { USB_VENDOR_ID_PANJIT, 0x0001, HID_QUIRK_IGNORE },
1746 { USB_VENDOR_ID_PANJIT, 0x0002, HID_QUIRK_IGNORE },
1747 { USB_VENDOR_ID_PANJIT, 0x0003, HID_QUIRK_IGNORE },
1748 { USB_VENDOR_ID_PANJIT, 0x0004, HID_QUIRK_IGNORE },
1749
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 { 0, 0 }
1751};
1752
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001753/*
1754 * Traverse the supplied list of reports and find the longest
1755 */
1756static void hid_find_max_report(struct hid_device *hid, unsigned int type, int *max)
1757{
1758 struct hid_report *report;
1759 int size;
1760
1761 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
1762 size = ((report->size - 1) >> 3) + 1;
1763 if (type == HID_INPUT_REPORT && hid->report_enum[type].numbered)
1764 size++;
1765 if (*max < size)
1766 *max = size;
1767 }
1768}
1769
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
1771{
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001772 if (!(hid->inbuf = usb_buffer_alloc(dev, hid->bufsize, SLAB_ATOMIC, &hid->inbuf_dma)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773 return -1;
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001774 if (!(hid->outbuf = usb_buffer_alloc(dev, hid->bufsize, SLAB_ATOMIC, &hid->outbuf_dma)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775 return -1;
1776 if (!(hid->cr = usb_buffer_alloc(dev, sizeof(*(hid->cr)), SLAB_ATOMIC, &hid->cr_dma)))
1777 return -1;
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001778 if (!(hid->ctrlbuf = usb_buffer_alloc(dev, hid->bufsize, SLAB_ATOMIC, &hid->ctrlbuf_dma)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 return -1;
1780
1781 return 0;
1782}
1783
1784static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
1785{
1786 if (hid->inbuf)
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001787 usb_buffer_free(dev, hid->bufsize, hid->inbuf, hid->inbuf_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788 if (hid->outbuf)
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001789 usb_buffer_free(dev, hid->bufsize, hid->outbuf, hid->outbuf_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 if (hid->cr)
1791 usb_buffer_free(dev, sizeof(*(hid->cr)), hid->cr, hid->cr_dma);
1792 if (hid->ctrlbuf)
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001793 usb_buffer_free(dev, hid->bufsize, hid->ctrlbuf, hid->ctrlbuf_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794}
1795
Vojtech Pavlik940824b2006-01-14 00:25:39 -05001796/*
1797 * Cherry Cymotion keyboard have an invalid HID report descriptor,
1798 * that needs fixing before we can parse it.
1799 */
1800
1801static void hid_fixup_cymotion_descriptor(char *rdesc, int rsize)
1802{
1803 if (rsize >= 17 && rdesc[11] == 0x3c && rdesc[12] == 0x02) {
1804 info("Fixing up Cherry Cymotion report descriptor");
1805 rdesc[11] = rdesc[16] = 0xff;
1806 rdesc[12] = rdesc[17] = 0x03;
1807 }
1808}
1809
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810static struct hid_device *usb_hid_configure(struct usb_interface *intf)
1811{
1812 struct usb_host_interface *interface = intf->cur_altsetting;
1813 struct usb_device *dev = interface_to_usbdev (intf);
1814 struct hid_descriptor *hdesc;
1815 struct hid_device *hid;
1816 unsigned quirks = 0, rsize = 0;
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001817 char *rdesc;
1818 int n, len, insize = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819
Ping Chengea186652006-07-14 16:50:04 -07001820 /* Ignore all Wacom devices */
1821 if (dev->descriptor.idVendor == USB_VENDOR_ID_WACOM)
1822 return NULL;
1823
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 for (n = 0; hid_blacklist[n].idVendor; n++)
1825 if ((hid_blacklist[n].idVendor == le16_to_cpu(dev->descriptor.idVendor)) &&
1826 (hid_blacklist[n].idProduct == le16_to_cpu(dev->descriptor.idProduct)))
1827 quirks = hid_blacklist[n].quirks;
1828
Alan Stern0f28b552006-05-15 14:49:04 -04001829 /* Many keyboards and mice don't like to be polled for reports,
1830 * so we will always set the HID_QUIRK_NOGET flag for them. */
1831 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
1832 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
1833 interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
1834 quirks |= HID_QUIRK_NOGET;
1835 }
1836
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 if (quirks & HID_QUIRK_IGNORE)
1838 return NULL;
1839
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001840 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
1841 (!interface->desc.bNumEndpoints ||
1842 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
1843 dbg("class descriptor not present\n");
1844 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845 }
1846
1847 for (n = 0; n < hdesc->bNumDescriptors; n++)
1848 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
1849 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
1850
1851 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
1852 dbg("weird size of report descriptor (%u)", rsize);
1853 return NULL;
1854 }
1855
1856 if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
1857 dbg("couldn't allocate rdesc memory");
1858 return NULL;
1859 }
1860
Vojtech Pavlik854561b2005-05-29 02:28:00 -05001861 hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
1862
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 if ((n = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber, HID_DT_REPORT, rdesc, rsize)) < 0) {
1864 dbg("reading report descriptor failed");
1865 kfree(rdesc);
1866 return NULL;
1867 }
1868
Vojtech Pavlik940824b2006-01-14 00:25:39 -05001869 if ((quirks & HID_QUIRK_CYMOTION))
1870 hid_fixup_cymotion_descriptor(rdesc, rsize);
1871
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872#ifdef DEBUG_DATA
1873 printk(KERN_DEBUG __FILE__ ": report descriptor (size %u, read %d) = ", rsize, n);
1874 for (n = 0; n < rsize; n++)
1875 printk(" %02x", (unsigned char) rdesc[n]);
1876 printk("\n");
1877#endif
1878
1879 if (!(hid = hid_parse_report(rdesc, n))) {
1880 dbg("parsing report descriptor failed");
1881 kfree(rdesc);
1882 return NULL;
1883 }
1884
1885 kfree(rdesc);
1886 hid->quirks = quirks;
1887
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001888 hid->bufsize = HID_MIN_BUFFER_SIZE;
1889 hid_find_max_report(hid, HID_INPUT_REPORT, &hid->bufsize);
1890 hid_find_max_report(hid, HID_OUTPUT_REPORT, &hid->bufsize);
1891 hid_find_max_report(hid, HID_FEATURE_REPORT, &hid->bufsize);
1892
1893 if (hid->bufsize > HID_MAX_BUFFER_SIZE)
1894 hid->bufsize = HID_MAX_BUFFER_SIZE;
1895
1896 hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
1897
1898 if (insize > HID_MAX_BUFFER_SIZE)
1899 insize = HID_MAX_BUFFER_SIZE;
1900
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901 if (hid_alloc_buffers(dev, hid)) {
1902 hid_free_buffers(dev, hid);
1903 goto fail;
1904 }
1905
1906 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
1907
1908 struct usb_endpoint_descriptor *endpoint;
1909 int pipe;
1910 int interval;
1911
1912 endpoint = &interface->endpoint[n].desc;
1913 if ((endpoint->bmAttributes & 3) != 3) /* Not an interrupt endpoint */
1914 continue;
1915
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916 interval = endpoint->bInterval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917
1918 /* Change the polling interval of mice. */
1919 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
1920 interval = hid_mousepoll_interval;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -05001921
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922 if (endpoint->bEndpointAddress & USB_DIR_IN) {
1923 if (hid->urbin)
1924 continue;
1925 if (!(hid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
1926 goto fail;
1927 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001928 usb_fill_int_urb(hid->urbin, dev, pipe, hid->inbuf, insize,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 hid_irq_in, hid, interval);
1930 hid->urbin->transfer_dma = hid->inbuf_dma;
Alan Sternb375a042005-07-29 16:11:07 -04001931 hid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932 } else {
1933 if (hid->urbout)
1934 continue;
1935 if (!(hid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
1936 goto fail;
1937 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
1938 usb_fill_int_urb(hid->urbout, dev, pipe, hid->outbuf, 0,
1939 hid_irq_out, hid, interval);
1940 hid->urbout->transfer_dma = hid->outbuf_dma;
Alan Sternb375a042005-07-29 16:11:07 -04001941 hid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942 }
1943 }
1944
1945 if (!hid->urbin) {
1946 err("couldn't find an input interrupt endpoint");
1947 goto fail;
1948 }
1949
1950 init_waitqueue_head(&hid->wait);
1951
Alan Sternaef4e262006-01-31 12:58:38 -05001952 INIT_WORK(&hid->reset_work, hid_reset, hid);
1953 setup_timer(&hid->io_retry, hid_retry_timeout, (unsigned long) hid);
1954
1955 spin_lock_init(&hid->inlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 spin_lock_init(&hid->outlock);
1957 spin_lock_init(&hid->ctrllock);
1958
1959 hid->version = le16_to_cpu(hdesc->bcdHID);
1960 hid->country = hdesc->bCountryCode;
1961 hid->dev = dev;
1962 hid->intf = intf;
1963 hid->ifnum = interface->desc.bInterfaceNumber;
1964
1965 hid->name[0] = 0;
1966
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001967 if (dev->manufacturer)
1968 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001970 if (dev->product) {
1971 if (dev->manufacturer)
1972 strlcat(hid->name, " ", sizeof(hid->name));
1973 strlcat(hid->name, dev->product, sizeof(hid->name));
1974 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001976 if (!strlen(hid->name))
1977 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
1978 le16_to_cpu(dev->descriptor.idVendor),
1979 le16_to_cpu(dev->descriptor.idProduct));
1980
1981 usb_make_path(dev, hid->phys, sizeof(hid->phys));
1982 strlcat(hid->phys, "/input", sizeof(hid->phys));
1983 len = strlen(hid->phys);
1984 if (len < sizeof(hid->phys) - 1)
1985 snprintf(hid->phys + len, sizeof(hid->phys) - len,
1986 "%d", intf->altsetting[0].desc.bInterfaceNumber);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987
1988 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
1989 hid->uniq[0] = 0;
1990
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 hid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
1992 if (!hid->urbctrl)
1993 goto fail;
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001994
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995 usb_fill_control_urb(hid->urbctrl, dev, 0, (void *) hid->cr,
1996 hid->ctrlbuf, 1, hid_ctrl, hid);
1997 hid->urbctrl->setup_dma = hid->cr_dma;
1998 hid->urbctrl->transfer_dma = hid->ctrlbuf_dma;
Alan Sternb375a042005-07-29 16:11:07 -04001999 hid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000
2001 return hid;
2002
2003fail:
2004
2005 if (hid->urbin)
2006 usb_free_urb(hid->urbin);
2007 if (hid->urbout)
2008 usb_free_urb(hid->urbout);
2009 if (hid->urbctrl)
2010 usb_free_urb(hid->urbctrl);
2011 hid_free_buffers(dev, hid);
2012 hid_free_device(hid);
2013
2014 return NULL;
2015}
2016
2017static void hid_disconnect(struct usb_interface *intf)
2018{
2019 struct hid_device *hid = usb_get_intfdata (intf);
2020
2021 if (!hid)
2022 return;
2023
Alan Sternaef4e262006-01-31 12:58:38 -05002024 spin_lock_irq(&hid->inlock); /* Sync with error handler */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 usb_set_intfdata(intf, NULL);
Alan Sternaef4e262006-01-31 12:58:38 -05002026 spin_unlock_irq(&hid->inlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027 usb_kill_urb(hid->urbin);
2028 usb_kill_urb(hid->urbout);
2029 usb_kill_urb(hid->urbctrl);
2030
Alan Sternaef4e262006-01-31 12:58:38 -05002031 del_timer_sync(&hid->io_retry);
2032 flush_scheduled_work();
2033
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 if (hid->claimed & HID_CLAIMED_INPUT)
2035 hidinput_disconnect(hid);
2036 if (hid->claimed & HID_CLAIMED_HIDDEV)
2037 hiddev_disconnect(hid);
2038
2039 usb_free_urb(hid->urbin);
2040 usb_free_urb(hid->urbctrl);
2041 if (hid->urbout)
2042 usb_free_urb(hid->urbout);
2043
2044 hid_free_buffers(hid->dev, hid);
2045 hid_free_device(hid);
2046}
2047
2048static int hid_probe(struct usb_interface *intf, const struct usb_device_id *id)
2049{
2050 struct hid_device *hid;
2051 char path[64];
2052 int i;
2053 char *c;
2054
2055 dbg("HID probe called for ifnum %d",
2056 intf->altsetting->desc.bInterfaceNumber);
2057
2058 if (!(hid = usb_hid_configure(intf)))
Stelian Pop479f6ea2005-06-22 17:53:28 +02002059 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060
2061 hid_init_reports(hid);
2062 hid_dump_device(hid);
2063
2064 if (!hidinput_connect(hid))
2065 hid->claimed |= HID_CLAIMED_INPUT;
2066 if (!hiddev_connect(hid))
2067 hid->claimed |= HID_CLAIMED_HIDDEV;
2068
2069 usb_set_intfdata(intf, hid);
2070
2071 if (!hid->claimed) {
2072 printk ("HID device not claimed by input or hiddev\n");
2073 hid_disconnect(intf);
Stelian Pop479f6ea2005-06-22 17:53:28 +02002074 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 }
2076
2077 printk(KERN_INFO);
2078
2079 if (hid->claimed & HID_CLAIMED_INPUT)
2080 printk("input");
2081 if (hid->claimed == (HID_CLAIMED_INPUT | HID_CLAIMED_HIDDEV))
2082 printk(",");
2083 if (hid->claimed & HID_CLAIMED_HIDDEV)
2084 printk("hiddev%d", hid->minor);
2085
2086 c = "Device";
2087 for (i = 0; i < hid->maxcollection; i++) {
2088 if (hid->collection[i].type == HID_COLLECTION_APPLICATION &&
2089 (hid->collection[i].usage & HID_USAGE_PAGE) == HID_UP_GENDESK &&
2090 (hid->collection[i].usage & 0xffff) < ARRAY_SIZE(hid_types)) {
2091 c = hid_types[hid->collection[i].usage & 0xffff];
2092 break;
2093 }
2094 }
2095
2096 usb_make_path(interface_to_usbdev(intf), path, 63);
2097
2098 printk(": USB HID v%x.%02x %s [%s] on %s\n",
2099 hid->version >> 8, hid->version & 0xff, c, hid->name, path);
2100
2101 return 0;
2102}
2103
David Brownell27d72e82005-04-18 17:39:22 -07002104static int hid_suspend(struct usb_interface *intf, pm_message_t message)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105{
2106 struct hid_device *hid = usb_get_intfdata (intf);
2107
Alan Sternaef4e262006-01-31 12:58:38 -05002108 spin_lock_irq(&hid->inlock); /* Sync with error handler */
2109 set_bit(HID_SUSPENDED, &hid->iofl);
2110 spin_unlock_irq(&hid->inlock);
2111 del_timer(&hid->io_retry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112 usb_kill_urb(hid->urbin);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113 dev_dbg(&intf->dev, "suspend\n");
2114 return 0;
2115}
2116
2117static int hid_resume(struct usb_interface *intf)
2118{
2119 struct hid_device *hid = usb_get_intfdata (intf);
2120 int status;
2121
Alan Sternaef4e262006-01-31 12:58:38 -05002122 clear_bit(HID_SUSPENDED, &hid->iofl);
Alan Sterndf9a1f42006-06-01 13:55:28 -04002123 hid->retry_delay = 0;
Alan Sternaef4e262006-01-31 12:58:38 -05002124 status = hid_start_in(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 dev_dbg(&intf->dev, "resume status %d\n", status);
2126 return status;
2127}
2128
Alan Sterndf9a1f42006-06-01 13:55:28 -04002129/* Treat USB reset pretty much the same as suspend/resume */
2130static void hid_pre_reset(struct usb_interface *intf)
2131{
2132 /* FIXME: What if the interface is already suspended? */
2133 hid_suspend(intf, PMSG_ON);
2134}
2135
2136static void hid_post_reset(struct usb_interface *intf)
2137{
2138 struct usb_device *dev = interface_to_usbdev (intf);
2139
2140 hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
2141 /* FIXME: Any more reinitialization needed? */
2142
2143 hid_resume(intf);
2144}
2145
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146static struct usb_device_id hid_usb_ids [] = {
2147 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2148 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
2149 { } /* Terminating entry */
2150};
2151
2152MODULE_DEVICE_TABLE (usb, hid_usb_ids);
2153
2154static struct usb_driver hid_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155 .name = "usbhid",
2156 .probe = hid_probe,
2157 .disconnect = hid_disconnect,
2158 .suspend = hid_suspend,
2159 .resume = hid_resume,
Alan Sterndf9a1f42006-06-01 13:55:28 -04002160 .pre_reset = hid_pre_reset,
2161 .post_reset = hid_post_reset,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 .id_table = hid_usb_ids,
2163};
2164
2165static int __init hid_init(void)
2166{
2167 int retval;
2168 retval = hiddev_init();
2169 if (retval)
2170 goto hiddev_init_fail;
2171 retval = usb_register(&hid_driver);
2172 if (retval)
2173 goto usb_register_fail;
2174 info(DRIVER_VERSION ":" DRIVER_DESC);
2175
2176 return 0;
2177usb_register_fail:
2178 hiddev_exit();
2179hiddev_init_fail:
2180 return retval;
2181}
2182
2183static void __exit hid_exit(void)
2184{
2185 usb_deregister(&hid_driver);
2186 hiddev_exit();
2187}
2188
2189module_init(hid_init);
2190module_exit(hid_exit);
2191
2192MODULE_AUTHOR(DRIVER_AUTHOR);
2193MODULE_DESCRIPTION(DRIVER_DESC);
2194MODULE_LICENSE(DRIVER_LICENSE);