xref: /openbmc/linux/drivers/hid/hid-core.c (revision fd589a8f)
1 /*
2  *  HID support for Linux
3  *
4  *  Copyright (c) 1999 Andreas Gal
5  *  Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
6  *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
7  *  Copyright (c) 2006-2007 Jiri Kosina
8  */
9 
10 /*
11  * This program is free software; you can redistribute it and/or modify it
12  * under the terms of the GNU General Public License as published by the Free
13  * Software Foundation; either version 2 of the License, or (at your option)
14  * any later version.
15  */
16 
17 #include <linux/module.h>
18 #include <linux/slab.h>
19 #include <linux/init.h>
20 #include <linux/kernel.h>
21 #include <linux/list.h>
22 #include <linux/mm.h>
23 #include <linux/spinlock.h>
24 #include <asm/unaligned.h>
25 #include <asm/byteorder.h>
26 #include <linux/input.h>
27 #include <linux/wait.h>
28 #include <linux/vmalloc.h>
29 #include <linux/sched.h>
30 
31 #include <linux/hid.h>
32 #include <linux/hiddev.h>
33 #include <linux/hid-debug.h>
34 #include <linux/hidraw.h>
35 
36 #include "hid-ids.h"
37 
38 /*
39  * Version Information
40  */
41 
42 #define DRIVER_VERSION "v2.6"
43 #define DRIVER_AUTHOR "Andreas Gal, Vojtech Pavlik, Jiri Kosina"
44 #define DRIVER_DESC "HID core driver"
45 #define DRIVER_LICENSE "GPL"
46 
47 int hid_debug = 0;
48 module_param_named(debug, hid_debug, int, 0600);
49 MODULE_PARM_DESC(debug, "toggle HID debugging messages");
50 EXPORT_SYMBOL_GPL(hid_debug);
51 
52 /*
53  * Register a new report for a device.
54  */
55 
56 static struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id)
57 {
58 	struct hid_report_enum *report_enum = device->report_enum + type;
59 	struct hid_report *report;
60 
61 	if (report_enum->report_id_hash[id])
62 		return report_enum->report_id_hash[id];
63 
64 	if (!(report = kzalloc(sizeof(struct hid_report), GFP_KERNEL)))
65 		return NULL;
66 
67 	if (id != 0)
68 		report_enum->numbered = 1;
69 
70 	report->id = id;
71 	report->type = type;
72 	report->size = 0;
73 	report->device = device;
74 	report_enum->report_id_hash[id] = report;
75 
76 	list_add_tail(&report->list, &report_enum->report_list);
77 
78 	return report;
79 }
80 
81 /*
82  * Register a new field for this report.
83  */
84 
85 static struct hid_field *hid_register_field(struct hid_report *report, unsigned usages, unsigned values)
86 {
87 	struct hid_field *field;
88 
89 	if (report->maxfield == HID_MAX_FIELDS) {
90 		dbg_hid("too many fields in report\n");
91 		return NULL;
92 	}
93 
94 	if (!(field = kzalloc(sizeof(struct hid_field) + usages * sizeof(struct hid_usage)
95 		+ values * sizeof(unsigned), GFP_KERNEL))) return NULL;
96 
97 	field->index = report->maxfield++;
98 	report->field[field->index] = field;
99 	field->usage = (struct hid_usage *)(field + 1);
100 	field->value = (s32 *)(field->usage + usages);
101 	field->report = report;
102 
103 	return field;
104 }
105 
106 /*
107  * Open a collection. The type/usage is pushed on the stack.
108  */
109 
110 static int open_collection(struct hid_parser *parser, unsigned type)
111 {
112 	struct hid_collection *collection;
113 	unsigned usage;
114 
115 	usage = parser->local.usage[0];
116 
117 	if (parser->collection_stack_ptr == HID_COLLECTION_STACK_SIZE) {
118 		dbg_hid("collection stack overflow\n");
119 		return -1;
120 	}
121 
122 	if (parser->device->maxcollection == parser->device->collection_size) {
123 		collection = kmalloc(sizeof(struct hid_collection) *
124 				parser->device->collection_size * 2, GFP_KERNEL);
125 		if (collection == NULL) {
126 			dbg_hid("failed to reallocate collection array\n");
127 			return -1;
128 		}
129 		memcpy(collection, parser->device->collection,
130 			sizeof(struct hid_collection) *
131 			parser->device->collection_size);
132 		memset(collection + parser->device->collection_size, 0,
133 			sizeof(struct hid_collection) *
134 			parser->device->collection_size);
135 		kfree(parser->device->collection);
136 		parser->device->collection = collection;
137 		parser->device->collection_size *= 2;
138 	}
139 
140 	parser->collection_stack[parser->collection_stack_ptr++] =
141 		parser->device->maxcollection;
142 
143 	collection = parser->device->collection +
144 		parser->device->maxcollection++;
145 	collection->type = type;
146 	collection->usage = usage;
147 	collection->level = parser->collection_stack_ptr - 1;
148 
149 	if (type == HID_COLLECTION_APPLICATION)
150 		parser->device->maxapplication++;
151 
152 	return 0;
153 }
154 
155 /*
156  * Close a collection.
157  */
158 
159 static int close_collection(struct hid_parser *parser)
160 {
161 	if (!parser->collection_stack_ptr) {
162 		dbg_hid("collection stack underflow\n");
163 		return -1;
164 	}
165 	parser->collection_stack_ptr--;
166 	return 0;
167 }
168 
169 /*
170  * Climb up the stack, search for the specified collection type
171  * and return the usage.
172  */
173 
174 static unsigned hid_lookup_collection(struct hid_parser *parser, unsigned type)
175 {
176 	int n;
177 	for (n = parser->collection_stack_ptr - 1; n >= 0; n--)
178 		if (parser->device->collection[parser->collection_stack[n]].type == type)
179 			return parser->device->collection[parser->collection_stack[n]].usage;
180 	return 0; /* we know nothing about this usage type */
181 }
182 
183 /*
184  * Add a usage to the temporary parser table.
185  */
186 
187 static int hid_add_usage(struct hid_parser *parser, unsigned usage)
188 {
189 	if (parser->local.usage_index >= HID_MAX_USAGES) {
190 		dbg_hid("usage index exceeded\n");
191 		return -1;
192 	}
193 	parser->local.usage[parser->local.usage_index] = usage;
194 	parser->local.collection_index[parser->local.usage_index] =
195 		parser->collection_stack_ptr ?
196 		parser->collection_stack[parser->collection_stack_ptr - 1] : 0;
197 	parser->local.usage_index++;
198 	return 0;
199 }
200 
201 /*
202  * Register a new field for this report.
203  */
204 
205 static int hid_add_field(struct hid_parser *parser, unsigned report_type, unsigned flags)
206 {
207 	struct hid_report *report;
208 	struct hid_field *field;
209 	int usages;
210 	unsigned offset;
211 	int i;
212 
213 	if (!(report = hid_register_report(parser->device, report_type, parser->global.report_id))) {
214 		dbg_hid("hid_register_report failed\n");
215 		return -1;
216 	}
217 
218 	if (parser->global.logical_maximum < parser->global.logical_minimum) {
219 		dbg_hid("logical range invalid %d %d\n", parser->global.logical_minimum, parser->global.logical_maximum);
220 		return -1;
221 	}
222 
223 	offset = report->size;
224 	report->size += parser->global.report_size * parser->global.report_count;
225 
226 	if (!parser->local.usage_index) /* Ignore padding fields */
227 		return 0;
228 
229 	usages = max_t(int, parser->local.usage_index, parser->global.report_count);
230 
231 	if ((field = hid_register_field(report, usages, parser->global.report_count)) == NULL)
232 		return 0;
233 
234 	field->physical = hid_lookup_collection(parser, HID_COLLECTION_PHYSICAL);
235 	field->logical = hid_lookup_collection(parser, HID_COLLECTION_LOGICAL);
236 	field->application = hid_lookup_collection(parser, HID_COLLECTION_APPLICATION);
237 
238 	for (i = 0; i < usages; i++) {
239 		int j = i;
240 		/* Duplicate the last usage we parsed if we have excess values */
241 		if (i >= parser->local.usage_index)
242 			j = parser->local.usage_index - 1;
243 		field->usage[i].hid = parser->local.usage[j];
244 		field->usage[i].collection_index =
245 			parser->local.collection_index[j];
246 	}
247 
248 	field->maxusage = usages;
249 	field->flags = flags;
250 	field->report_offset = offset;
251 	field->report_type = report_type;
252 	field->report_size = parser->global.report_size;
253 	field->report_count = parser->global.report_count;
254 	field->logical_minimum = parser->global.logical_minimum;
255 	field->logical_maximum = parser->global.logical_maximum;
256 	field->physical_minimum = parser->global.physical_minimum;
257 	field->physical_maximum = parser->global.physical_maximum;
258 	field->unit_exponent = parser->global.unit_exponent;
259 	field->unit = parser->global.unit;
260 
261 	return 0;
262 }
263 
264 /*
265  * Read data value from item.
266  */
267 
268 static u32 item_udata(struct hid_item *item)
269 {
270 	switch (item->size) {
271 	case 1: return item->data.u8;
272 	case 2: return item->data.u16;
273 	case 4: return item->data.u32;
274 	}
275 	return 0;
276 }
277 
278 static s32 item_sdata(struct hid_item *item)
279 {
280 	switch (item->size) {
281 	case 1: return item->data.s8;
282 	case 2: return item->data.s16;
283 	case 4: return item->data.s32;
284 	}
285 	return 0;
286 }
287 
288 /*
289  * Process a global item.
290  */
291 
292 static int hid_parser_global(struct hid_parser *parser, struct hid_item *item)
293 {
294 	switch (item->tag) {
295 	case HID_GLOBAL_ITEM_TAG_PUSH:
296 
297 		if (parser->global_stack_ptr == HID_GLOBAL_STACK_SIZE) {
298 			dbg_hid("global enviroment stack overflow\n");
299 			return -1;
300 		}
301 
302 		memcpy(parser->global_stack + parser->global_stack_ptr++,
303 			&parser->global, sizeof(struct hid_global));
304 		return 0;
305 
306 	case HID_GLOBAL_ITEM_TAG_POP:
307 
308 		if (!parser->global_stack_ptr) {
309 			dbg_hid("global enviroment stack underflow\n");
310 			return -1;
311 		}
312 
313 		memcpy(&parser->global, parser->global_stack +
314 			--parser->global_stack_ptr, sizeof(struct hid_global));
315 		return 0;
316 
317 	case HID_GLOBAL_ITEM_TAG_USAGE_PAGE:
318 		parser->global.usage_page = item_udata(item);
319 		return 0;
320 
321 	case HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM:
322 		parser->global.logical_minimum = item_sdata(item);
323 		return 0;
324 
325 	case HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM:
326 		if (parser->global.logical_minimum < 0)
327 			parser->global.logical_maximum = item_sdata(item);
328 		else
329 			parser->global.logical_maximum = item_udata(item);
330 		return 0;
331 
332 	case HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM:
333 		parser->global.physical_minimum = item_sdata(item);
334 		return 0;
335 
336 	case HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM:
337 		if (parser->global.physical_minimum < 0)
338 			parser->global.physical_maximum = item_sdata(item);
339 		else
340 			parser->global.physical_maximum = item_udata(item);
341 		return 0;
342 
343 	case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT:
344 		parser->global.unit_exponent = item_sdata(item);
345 		return 0;
346 
347 	case HID_GLOBAL_ITEM_TAG_UNIT:
348 		parser->global.unit = item_udata(item);
349 		return 0;
350 
351 	case HID_GLOBAL_ITEM_TAG_REPORT_SIZE:
352 		parser->global.report_size = item_udata(item);
353 		if (parser->global.report_size > 32) {
354 			dbg_hid("invalid report_size %d\n",
355 					parser->global.report_size);
356 			return -1;
357 		}
358 		return 0;
359 
360 	case HID_GLOBAL_ITEM_TAG_REPORT_COUNT:
361 		parser->global.report_count = item_udata(item);
362 		if (parser->global.report_count > HID_MAX_USAGES) {
363 			dbg_hid("invalid report_count %d\n",
364 					parser->global.report_count);
365 			return -1;
366 		}
367 		return 0;
368 
369 	case HID_GLOBAL_ITEM_TAG_REPORT_ID:
370 		parser->global.report_id = item_udata(item);
371 		if (parser->global.report_id == 0) {
372 			dbg_hid("report_id 0 is invalid\n");
373 			return -1;
374 		}
375 		return 0;
376 
377 	default:
378 		dbg_hid("unknown global tag 0x%x\n", item->tag);
379 		return -1;
380 	}
381 }
382 
383 /*
384  * Process a local item.
385  */
386 
387 static int hid_parser_local(struct hid_parser *parser, struct hid_item *item)
388 {
389 	__u32 data;
390 	unsigned n;
391 
392 	if (item->size == 0) {
393 		dbg_hid("item data expected for local item\n");
394 		return -1;
395 	}
396 
397 	data = item_udata(item);
398 
399 	switch (item->tag) {
400 	case HID_LOCAL_ITEM_TAG_DELIMITER:
401 
402 		if (data) {
403 			/*
404 			 * We treat items before the first delimiter
405 			 * as global to all usage sets (branch 0).
406 			 * In the moment we process only these global
407 			 * items and the first delimiter set.
408 			 */
409 			if (parser->local.delimiter_depth != 0) {
410 				dbg_hid("nested delimiters\n");
411 				return -1;
412 			}
413 			parser->local.delimiter_depth++;
414 			parser->local.delimiter_branch++;
415 		} else {
416 			if (parser->local.delimiter_depth < 1) {
417 				dbg_hid("bogus close delimiter\n");
418 				return -1;
419 			}
420 			parser->local.delimiter_depth--;
421 		}
422 		return 1;
423 
424 	case HID_LOCAL_ITEM_TAG_USAGE:
425 
426 		if (parser->local.delimiter_branch > 1) {
427 			dbg_hid("alternative usage ignored\n");
428 			return 0;
429 		}
430 
431 		if (item->size <= 2)
432 			data = (parser->global.usage_page << 16) + data;
433 
434 		return hid_add_usage(parser, data);
435 
436 	case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:
437 
438 		if (parser->local.delimiter_branch > 1) {
439 			dbg_hid("alternative usage ignored\n");
440 			return 0;
441 		}
442 
443 		if (item->size <= 2)
444 			data = (parser->global.usage_page << 16) + data;
445 
446 		parser->local.usage_minimum = data;
447 		return 0;
448 
449 	case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:
450 
451 		if (parser->local.delimiter_branch > 1) {
452 			dbg_hid("alternative usage ignored\n");
453 			return 0;
454 		}
455 
456 		if (item->size <= 2)
457 			data = (parser->global.usage_page << 16) + data;
458 
459 		for (n = parser->local.usage_minimum; n <= data; n++)
460 			if (hid_add_usage(parser, n)) {
461 				dbg_hid("hid_add_usage failed\n");
462 				return -1;
463 			}
464 		return 0;
465 
466 	default:
467 
468 		dbg_hid("unknown local item tag 0x%x\n", item->tag);
469 		return 0;
470 	}
471 	return 0;
472 }
473 
474 /*
475  * Process a main item.
476  */
477 
478 static int hid_parser_main(struct hid_parser *parser, struct hid_item *item)
479 {
480 	__u32 data;
481 	int ret;
482 
483 	data = item_udata(item);
484 
485 	switch (item->tag) {
486 	case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION:
487 		ret = open_collection(parser, data & 0xff);
488 		break;
489 	case HID_MAIN_ITEM_TAG_END_COLLECTION:
490 		ret = close_collection(parser);
491 		break;
492 	case HID_MAIN_ITEM_TAG_INPUT:
493 		ret = hid_add_field(parser, HID_INPUT_REPORT, data);
494 		break;
495 	case HID_MAIN_ITEM_TAG_OUTPUT:
496 		ret = hid_add_field(parser, HID_OUTPUT_REPORT, data);
497 		break;
498 	case HID_MAIN_ITEM_TAG_FEATURE:
499 		ret = hid_add_field(parser, HID_FEATURE_REPORT, data);
500 		break;
501 	default:
502 		dbg_hid("unknown main item tag 0x%x\n", item->tag);
503 		ret = 0;
504 	}
505 
506 	memset(&parser->local, 0, sizeof(parser->local));	/* Reset the local parser environment */
507 
508 	return ret;
509 }
510 
511 /*
512  * Process a reserved item.
513  */
514 
515 static int hid_parser_reserved(struct hid_parser *parser, struct hid_item *item)
516 {
517 	dbg_hid("reserved item type, tag 0x%x\n", item->tag);
518 	return 0;
519 }
520 
521 /*
522  * Free a report and all registered fields. The field->usage and
523  * field->value table's are allocated behind the field, so we need
524  * only to free(field) itself.
525  */
526 
527 static void hid_free_report(struct hid_report *report)
528 {
529 	unsigned n;
530 
531 	for (n = 0; n < report->maxfield; n++)
532 		kfree(report->field[n]);
533 	kfree(report);
534 }
535 
536 /*
537  * Free a device structure, all reports, and all fields.
538  */
539 
540 static void hid_device_release(struct device *dev)
541 {
542 	struct hid_device *device = container_of(dev, struct hid_device, dev);
543 	unsigned i, j;
544 
545 	for (i = 0; i < HID_REPORT_TYPES; i++) {
546 		struct hid_report_enum *report_enum = device->report_enum + i;
547 
548 		for (j = 0; j < 256; j++) {
549 			struct hid_report *report = report_enum->report_id_hash[j];
550 			if (report)
551 				hid_free_report(report);
552 		}
553 	}
554 
555 	kfree(device->rdesc);
556 	kfree(device->collection);
557 	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 
565 static 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 	case 0:
600 		return start;
601 
602 	case 1:
603 		if ((end - start) < 1)
604 			return NULL;
605 		item->data.u8 = *start++;
606 		return start;
607 
608 	case 2:
609 		if ((end - start) < 2)
610 			return NULL;
611 		item->data.u16 = get_unaligned_le16(start);
612 		start = (__u8 *)((__le16 *)start + 1);
613 		return start;
614 
615 	case 3:
616 		item->size++;
617 		if ((end - start) < 4)
618 			return NULL;
619 		item->data.u32 = get_unaligned_le32(start);
620 		start = (__u8 *)((__le32 *)start + 1);
621 		return start;
622 	}
623 
624 	return NULL;
625 }
626 
627 /**
628  * hid_parse_report - parse device report
629  *
630  * @device: hid device
631  * @start: report start
632  * @size: report size
633  *
634  * Parse a report description into a hid_device structure. Reports are
635  * enumerated, fields are attached to these reports.
636  * 0 returned on success, otherwise nonzero error value.
637  */
638 int hid_parse_report(struct hid_device *device, __u8 *start,
639 		unsigned size)
640 {
641 	struct hid_parser *parser;
642 	struct hid_item item;
643 	__u8 *end;
644 	int ret;
645 	static int (*dispatch_type[])(struct hid_parser *parser,
646 				      struct hid_item *item) = {
647 		hid_parser_main,
648 		hid_parser_global,
649 		hid_parser_local,
650 		hid_parser_reserved
651 	};
652 
653 	if (device->driver->report_fixup)
654 		device->driver->report_fixup(device, start, size);
655 
656 	device->rdesc = kmalloc(size, GFP_KERNEL);
657 	if (device->rdesc == NULL)
658 		return -ENOMEM;
659 	memcpy(device->rdesc, start, size);
660 	device->rsize = size;
661 
662 	parser = vmalloc(sizeof(struct hid_parser));
663 	if (!parser) {
664 		ret = -ENOMEM;
665 		goto err;
666 	}
667 
668 	memset(parser, 0, sizeof(struct hid_parser));
669 	parser->device = device;
670 
671 	end = start + size;
672 	ret = -EINVAL;
673 	while ((start = fetch_item(start, end, &item)) != NULL) {
674 
675 		if (item.format != HID_ITEM_FORMAT_SHORT) {
676 			dbg_hid("unexpected long global item\n");
677 			goto err;
678 		}
679 
680 		if (dispatch_type[item.type](parser, &item)) {
681 			dbg_hid("item %u %u %u %u parsing failed\n",
682 				item.format, (unsigned)item.size, (unsigned)item.type, (unsigned)item.tag);
683 			goto err;
684 		}
685 
686 		if (start == end) {
687 			if (parser->collection_stack_ptr) {
688 				dbg_hid("unbalanced collection at end of report description\n");
689 				goto err;
690 			}
691 			if (parser->local.delimiter_depth) {
692 				dbg_hid("unbalanced delimiter at end of report description\n");
693 				goto err;
694 			}
695 			vfree(parser);
696 			return 0;
697 		}
698 	}
699 
700 	dbg_hid("item fetching failed at offset %d\n", (int)(end - start));
701 err:
702 	vfree(parser);
703 	return ret;
704 }
705 EXPORT_SYMBOL_GPL(hid_parse_report);
706 
707 /*
708  * Convert a signed n-bit integer to signed 32-bit integer. Common
709  * cases are done through the compiler, the screwed things has to be
710  * done by hand.
711  */
712 
713 static s32 snto32(__u32 value, unsigned n)
714 {
715 	switch (n) {
716 	case 8:  return ((__s8)value);
717 	case 16: return ((__s16)value);
718 	case 32: return ((__s32)value);
719 	}
720 	return value & (1 << (n - 1)) ? value | (-1 << n) : value;
721 }
722 
723 /*
724  * Convert a signed 32-bit integer to a signed n-bit integer.
725  */
726 
727 static u32 s32ton(__s32 value, unsigned n)
728 {
729 	s32 a = value >> (n - 1);
730 	if (a && a != -1)
731 		return value < 0 ? 1 << (n - 1) : (1 << (n - 1)) - 1;
732 	return value & ((1 << n) - 1);
733 }
734 
735 /*
736  * Extract/implement a data field from/to a little endian report (bit array).
737  *
738  * Code sort-of follows HID spec:
739  *     http://www.usb.org/developers/devclass_docs/HID1_11.pdf
740  *
741  * While the USB HID spec allows unlimited length bit fields in "report
742  * descriptors", most devices never use more than 16 bits.
743  * One model of UPS is claimed to report "LINEV" as a 32-bit field.
744  * Search linux-kernel and linux-usb-devel archives for "hid-core extract".
745  */
746 
747 static __inline__ __u32 extract(__u8 *report, unsigned offset, unsigned n)
748 {
749 	u64 x;
750 
751 	if (n > 32)
752 		printk(KERN_WARNING "HID: extract() called with n (%d) > 32! (%s)\n",
753 				n, current->comm);
754 
755 	report += offset >> 3;  /* adjust byte index */
756 	offset &= 7;            /* now only need bit offset into one byte */
757 	x = get_unaligned_le64(report);
758 	x = (x >> offset) & ((1ULL << n) - 1);  /* extract bit field */
759 	return (u32) x;
760 }
761 
762 /*
763  * "implement" : set bits in a little endian bit stream.
764  * Same concepts as "extract" (see comments above).
765  * The data mangled in the bit stream remains in little endian
766  * order the whole time. It make more sense to talk about
767  * endianness of register values by considering a register
768  * a "cached" copy of the little endiad bit stream.
769  */
770 static __inline__ void implement(__u8 *report, unsigned offset, unsigned n, __u32 value)
771 {
772 	u64 x;
773 	u64 m = (1ULL << n) - 1;
774 
775 	if (n > 32)
776 		printk(KERN_WARNING "HID: implement() called with n (%d) > 32! (%s)\n",
777 				n, current->comm);
778 
779 	if (value > m)
780 		printk(KERN_WARNING "HID: implement() called with too large value %d! (%s)\n",
781 				value, current->comm);
782 	WARN_ON(value > m);
783 	value &= m;
784 
785 	report += offset >> 3;
786 	offset &= 7;
787 
788 	x = get_unaligned_le64(report);
789 	x &= ~(m << offset);
790 	x |= ((u64)value) << offset;
791 	put_unaligned_le64(x, report);
792 }
793 
794 /*
795  * Search an array for a value.
796  */
797 
798 static __inline__ int search(__s32 *array, __s32 value, unsigned n)
799 {
800 	while (n--) {
801 		if (*array++ == value)
802 			return 0;
803 	}
804 	return -1;
805 }
806 
807 /**
808  * hid_match_report - check if driver's raw_event should be called
809  *
810  * @hid: hid device
811  * @report_type: type to match against
812  *
813  * compare hid->driver->report_table->report_type to report->type
814  */
815 static int hid_match_report(struct hid_device *hid, struct hid_report *report)
816 {
817 	const struct hid_report_id *id = hid->driver->report_table;
818 
819 	if (!id) /* NULL means all */
820 		return 1;
821 
822 	for (; id->report_type != HID_TERMINATOR; id++)
823 		if (id->report_type == HID_ANY_ID ||
824 				id->report_type == report->type)
825 			return 1;
826 	return 0;
827 }
828 
829 /**
830  * hid_match_usage - check if driver's event should be called
831  *
832  * @hid: hid device
833  * @usage: usage to match against
834  *
835  * compare hid->driver->usage_table->usage_{type,code} to
836  * usage->usage_{type,code}
837  */
838 static int hid_match_usage(struct hid_device *hid, struct hid_usage *usage)
839 {
840 	const struct hid_usage_id *id = hid->driver->usage_table;
841 
842 	if (!id) /* NULL means all */
843 		return 1;
844 
845 	for (; id->usage_type != HID_ANY_ID - 1; id++)
846 		if ((id->usage_hid == HID_ANY_ID ||
847 				id->usage_hid == usage->hid) &&
848 				(id->usage_type == HID_ANY_ID ||
849 				id->usage_type == usage->type) &&
850 				(id->usage_code == HID_ANY_ID ||
851 				 id->usage_code == usage->code))
852 			return 1;
853 	return 0;
854 }
855 
856 static void hid_process_event(struct hid_device *hid, struct hid_field *field,
857 		struct hid_usage *usage, __s32 value, int interrupt)
858 {
859 	struct hid_driver *hdrv = hid->driver;
860 	int ret;
861 
862 	hid_dump_input(hid, usage, value);
863 
864 	if (hdrv && hdrv->event && hid_match_usage(hid, usage)) {
865 		ret = hdrv->event(hid, field, usage, value);
866 		if (ret != 0) {
867 			if (ret < 0)
868 				dbg_hid("%s's event failed with %d\n",
869 						hdrv->name, ret);
870 			return;
871 		}
872 	}
873 
874 	if (hid->claimed & HID_CLAIMED_INPUT)
875 		hidinput_hid_event(hid, field, usage, value);
876 	if (hid->claimed & HID_CLAIMED_HIDDEV && interrupt && hid->hiddev_hid_event)
877 		hid->hiddev_hid_event(hid, field, usage, value);
878 }
879 
880 /*
881  * Analyse a received field, and fetch the data from it. The field
882  * content is stored for next report processing (we do differential
883  * reporting to the layer).
884  */
885 
886 static void hid_input_field(struct hid_device *hid, struct hid_field *field,
887 			    __u8 *data, int interrupt)
888 {
889 	unsigned n;
890 	unsigned count = field->report_count;
891 	unsigned offset = field->report_offset;
892 	unsigned size = field->report_size;
893 	__s32 min = field->logical_minimum;
894 	__s32 max = field->logical_maximum;
895 	__s32 *value;
896 
897 	if (!(value = kmalloc(sizeof(__s32) * count, GFP_ATOMIC)))
898 		return;
899 
900 	for (n = 0; n < count; n++) {
901 
902 			value[n] = min < 0 ? snto32(extract(data, offset + n * size, size), size) :
903 						    extract(data, offset + n * size, size);
904 
905 			if (!(field->flags & HID_MAIN_ITEM_VARIABLE) /* Ignore report if ErrorRollOver */
906 			    && value[n] >= min && value[n] <= max
907 			    && field->usage[value[n] - min].hid == HID_UP_KEYBOARD + 1)
908 				goto exit;
909 	}
910 
911 	for (n = 0; n < count; n++) {
912 
913 		if (HID_MAIN_ITEM_VARIABLE & field->flags) {
914 			hid_process_event(hid, field, &field->usage[n], value[n], interrupt);
915 			continue;
916 		}
917 
918 		if (field->value[n] >= min && field->value[n] <= max
919 			&& field->usage[field->value[n] - min].hid
920 			&& search(value, field->value[n], count))
921 				hid_process_event(hid, field, &field->usage[field->value[n] - min], 0, interrupt);
922 
923 		if (value[n] >= min && value[n] <= max
924 			&& field->usage[value[n] - min].hid
925 			&& search(field->value, value[n], count))
926 				hid_process_event(hid, field, &field->usage[value[n] - min], 1, interrupt);
927 	}
928 
929 	memcpy(field->value, value, count * sizeof(__s32));
930 exit:
931 	kfree(value);
932 }
933 
934 /*
935  * Output the field into the report.
936  */
937 
938 static void hid_output_field(struct hid_field *field, __u8 *data)
939 {
940 	unsigned count = field->report_count;
941 	unsigned offset = field->report_offset;
942 	unsigned size = field->report_size;
943 	unsigned bitsused = offset + count * size;
944 	unsigned n;
945 
946 	/* make sure the unused bits in the last byte are zeros */
947 	if (count > 0 && size > 0 && (bitsused % 8) != 0)
948 		data[(bitsused-1)/8] &= (1 << (bitsused % 8)) - 1;
949 
950 	for (n = 0; n < count; n++) {
951 		if (field->logical_minimum < 0)	/* signed values */
952 			implement(data, offset + n * size, size, s32ton(field->value[n], size));
953 		else				/* unsigned values */
954 			implement(data, offset + n * size, size, field->value[n]);
955 	}
956 }
957 
958 /*
959  * Create a report.
960  */
961 
962 void hid_output_report(struct hid_report *report, __u8 *data)
963 {
964 	unsigned n;
965 
966 	if (report->id > 0)
967 		*data++ = report->id;
968 
969 	for (n = 0; n < report->maxfield; n++)
970 		hid_output_field(report->field[n], data);
971 }
972 EXPORT_SYMBOL_GPL(hid_output_report);
973 
974 /*
975  * Set a field value. The report this field belongs to has to be
976  * created and transferred to the device, to set this value in the
977  * device.
978  */
979 
980 int hid_set_field(struct hid_field *field, unsigned offset, __s32 value)
981 {
982 	unsigned size = field->report_size;
983 
984 	hid_dump_input(field->report->device, field->usage + offset, value);
985 
986 	if (offset >= field->report_count) {
987 		dbg_hid("offset (%d) exceeds report_count (%d)\n", offset, field->report_count);
988 		return -1;
989 	}
990 	if (field->logical_minimum < 0) {
991 		if (value != snto32(s32ton(value, size), size)) {
992 			dbg_hid("value %d is out of range\n", value);
993 			return -1;
994 		}
995 	}
996 	field->value[offset] = value;
997 	return 0;
998 }
999 EXPORT_SYMBOL_GPL(hid_set_field);
1000 
1001 static struct hid_report *hid_get_report(struct hid_report_enum *report_enum,
1002 		const u8 *data)
1003 {
1004 	struct hid_report *report;
1005 	unsigned int n = 0;	/* Normally report number is 0 */
1006 
1007 	/* Device uses numbered reports, data[0] is report number */
1008 	if (report_enum->numbered)
1009 		n = *data;
1010 
1011 	report = report_enum->report_id_hash[n];
1012 	if (report == NULL)
1013 		dbg_hid("undefined report_id %u received\n", n);
1014 
1015 	return report;
1016 }
1017 
1018 void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
1019 		int interrupt)
1020 {
1021 	struct hid_report_enum *report_enum = hid->report_enum + type;
1022 	struct hid_report *report;
1023 	unsigned int a;
1024 	int rsize, csize = size;
1025 	u8 *cdata = data;
1026 
1027 	report = hid_get_report(report_enum, data);
1028 	if (!report)
1029 		return;
1030 
1031 	if (report_enum->numbered) {
1032 		cdata++;
1033 		csize--;
1034 	}
1035 
1036 	rsize = ((report->size - 1) >> 3) + 1;
1037 
1038 	if (csize < rsize) {
1039 		dbg_hid("report %d is too short, (%d < %d)\n", report->id,
1040 				csize, rsize);
1041 		memset(cdata + csize, 0, rsize - csize);
1042 	}
1043 
1044 	if ((hid->claimed & HID_CLAIMED_HIDDEV) && hid->hiddev_report_event)
1045 		hid->hiddev_report_event(hid, report);
1046 	if (hid->claimed & HID_CLAIMED_HIDRAW) {
1047 		/* numbered reports need to be passed with the report num */
1048 		if (report_enum->numbered)
1049 			hidraw_report_event(hid, data - 1, size + 1);
1050 		else
1051 			hidraw_report_event(hid, data, size);
1052 	}
1053 
1054 	for (a = 0; a < report->maxfield; a++)
1055 		hid_input_field(hid, report->field[a], cdata, interrupt);
1056 
1057 	if (hid->claimed & HID_CLAIMED_INPUT)
1058 		hidinput_report_event(hid, report);
1059 }
1060 EXPORT_SYMBOL_GPL(hid_report_raw_event);
1061 
1062 /**
1063  * hid_input_report - report data from lower layer (usb, bt...)
1064  *
1065  * @hid: hid device
1066  * @type: HID report type (HID_*_REPORT)
1067  * @data: report contents
1068  * @size: size of data parameter
1069  * @interrupt: called from atomic?
1070  *
1071  * This is data entry for lower layers.
1072  */
1073 int hid_input_report(struct hid_device *hid, int type, u8 *data, int size, int interrupt)
1074 {
1075 	struct hid_report_enum *report_enum;
1076 	struct hid_driver *hdrv;
1077 	struct hid_report *report;
1078 	char *buf;
1079 	unsigned int i;
1080 	int ret;
1081 
1082 	if (!hid || !hid->driver)
1083 		return -ENODEV;
1084 	report_enum = hid->report_enum + type;
1085 	hdrv = hid->driver;
1086 
1087 	if (!size) {
1088 		dbg_hid("empty report\n");
1089 		return -1;
1090 	}
1091 
1092 	buf = kmalloc(sizeof(char) * HID_DEBUG_BUFSIZE,
1093 			interrupt ? GFP_ATOMIC : GFP_KERNEL);
1094 
1095 	if (!buf) {
1096 		report = hid_get_report(report_enum, data);
1097 		goto nomem;
1098 	}
1099 
1100 	snprintf(buf, HID_DEBUG_BUFSIZE - 1,
1101 			"\nreport (size %u) (%snumbered)\n", size, report_enum->numbered ? "" : "un");
1102 	hid_debug_event(hid, buf);
1103 
1104 	report = hid_get_report(report_enum, data);
1105 	if (!report) {
1106 		kfree(buf);
1107 		return -1;
1108 	}
1109 
1110 	/* dump the report */
1111 	snprintf(buf, HID_DEBUG_BUFSIZE - 1,
1112 			"report %d (size %u) = ", report->id, size);
1113 	hid_debug_event(hid, buf);
1114 	for (i = 0; i < size; i++) {
1115 		snprintf(buf, HID_DEBUG_BUFSIZE - 1,
1116 				" %02x", data[i]);
1117 		hid_debug_event(hid, buf);
1118 	}
1119 	hid_debug_event(hid, "\n");
1120 
1121 	kfree(buf);
1122 
1123 nomem:
1124 	if (hdrv && hdrv->raw_event && hid_match_report(hid, report)) {
1125 		ret = hdrv->raw_event(hid, report, data, size);
1126 		if (ret != 0)
1127 			return ret < 0 ? ret : 0;
1128 	}
1129 
1130 	hid_report_raw_event(hid, type, data, size, interrupt);
1131 
1132 	return 0;
1133 }
1134 EXPORT_SYMBOL_GPL(hid_input_report);
1135 
1136 static bool hid_match_one_id(struct hid_device *hdev,
1137 		const struct hid_device_id *id)
1138 {
1139 	return id->bus == hdev->bus &&
1140 		(id->vendor == HID_ANY_ID || id->vendor == hdev->vendor) &&
1141 		(id->product == HID_ANY_ID || id->product == hdev->product);
1142 }
1143 
1144 static const struct hid_device_id *hid_match_id(struct hid_device *hdev,
1145 		const struct hid_device_id *id)
1146 {
1147 	for (; id->bus; id++)
1148 		if (hid_match_one_id(hdev, id))
1149 			return id;
1150 
1151 	return NULL;
1152 }
1153 
1154 static const struct hid_device_id hid_hiddev_list[] = {
1155 	{ HID_USB_DEVICE(USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS) },
1156 	{ HID_USB_DEVICE(USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS1) },
1157 	{ }
1158 };
1159 
1160 static bool hid_hiddev(struct hid_device *hdev)
1161 {
1162 	return !!hid_match_id(hdev, hid_hiddev_list);
1163 }
1164 
1165 int hid_connect(struct hid_device *hdev, unsigned int connect_mask)
1166 {
1167 	static const char *types[] = { "Device", "Pointer", "Mouse", "Device",
1168 		"Joystick", "Gamepad", "Keyboard", "Keypad",
1169 		"Multi-Axis Controller"
1170 	};
1171 	const char *type, *bus;
1172 	char buf[64];
1173 	unsigned int i;
1174 	int len;
1175 
1176 	if (hdev->bus != BUS_USB)
1177 		connect_mask &= ~HID_CONNECT_HIDDEV;
1178 	if (hid_hiddev(hdev))
1179 		connect_mask |= HID_CONNECT_HIDDEV_FORCE;
1180 
1181 	if ((connect_mask & HID_CONNECT_HIDINPUT) && !hidinput_connect(hdev,
1182 				connect_mask & HID_CONNECT_HIDINPUT_FORCE))
1183 		hdev->claimed |= HID_CLAIMED_INPUT;
1184 	if ((connect_mask & HID_CONNECT_HIDDEV) && hdev->hiddev_connect &&
1185 			!hdev->hiddev_connect(hdev,
1186 				connect_mask & HID_CONNECT_HIDDEV_FORCE))
1187 		hdev->claimed |= HID_CLAIMED_HIDDEV;
1188 	if ((connect_mask & HID_CONNECT_HIDRAW) && !hidraw_connect(hdev))
1189 		hdev->claimed |= HID_CLAIMED_HIDRAW;
1190 
1191 	if (!hdev->claimed) {
1192 		dev_err(&hdev->dev, "claimed by neither input, hiddev nor "
1193 				"hidraw\n");
1194 		return -ENODEV;
1195 	}
1196 
1197 	if ((hdev->claimed & HID_CLAIMED_INPUT) &&
1198 			(connect_mask & HID_CONNECT_FF) && hdev->ff_init)
1199 		hdev->ff_init(hdev);
1200 
1201 	len = 0;
1202 	if (hdev->claimed & HID_CLAIMED_INPUT)
1203 		len += sprintf(buf + len, "input");
1204 	if (hdev->claimed & HID_CLAIMED_HIDDEV)
1205 		len += sprintf(buf + len, "%shiddev%d", len ? "," : "",
1206 				hdev->minor);
1207 	if (hdev->claimed & HID_CLAIMED_HIDRAW)
1208 		len += sprintf(buf + len, "%shidraw%d", len ? "," : "",
1209 				((struct hidraw *)hdev->hidraw)->minor);
1210 
1211 	type = "Device";
1212 	for (i = 0; i < hdev->maxcollection; i++) {
1213 		struct hid_collection *col = &hdev->collection[i];
1214 		if (col->type == HID_COLLECTION_APPLICATION &&
1215 		   (col->usage & HID_USAGE_PAGE) == HID_UP_GENDESK &&
1216 		   (col->usage & 0xffff) < ARRAY_SIZE(types)) {
1217 			type = types[col->usage & 0xffff];
1218 			break;
1219 		}
1220 	}
1221 
1222 	switch (hdev->bus) {
1223 	case BUS_USB:
1224 		bus = "USB";
1225 		break;
1226 	case BUS_BLUETOOTH:
1227 		bus = "BLUETOOTH";
1228 		break;
1229 	default:
1230 		bus = "<UNKNOWN>";
1231 	}
1232 
1233 	dev_info(&hdev->dev, "%s: %s HID v%x.%02x %s [%s] on %s\n",
1234 			buf, bus, hdev->version >> 8, hdev->version & 0xff,
1235 			type, hdev->name, hdev->phys);
1236 
1237 	return 0;
1238 }
1239 EXPORT_SYMBOL_GPL(hid_connect);
1240 
1241 /* a list of devices for which there is a specialized driver on HID bus */
1242 static const struct hid_device_id hid_blacklist[] = {
1243 	{ HID_USB_DEVICE(USB_VENDOR_ID_A4TECH, USB_DEVICE_ID_A4TECH_WCP32PU) },
1244 	{ HID_USB_DEVICE(USB_VENDOR_ID_A4TECH, USB_DEVICE_ID_A4TECH_X5_005D) },
1245 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ATV_IRCONTROL) },
1246 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_IRCONTROL4) },
1247 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE) },
1248 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ANSI) },
1249 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ISO) },
1250 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ANSI) },
1251 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ISO) },
1252 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_JIS) },
1253 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ANSI) },
1254 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ISO) },
1255 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_JIS) },
1256 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ANSI) },
1257 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ISO) },
1258 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_JIS) },
1259 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ANSI) },
1260 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ISO) },
1261 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_JIS) },
1262 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ANSI) },
1263 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ISO) },
1264 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_JIS) },
1265 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ANSI) },
1266 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ISO) },
1267 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_JIS) },
1268 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI) },
1269 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO) },
1270 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS) },
1271 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ANSI) },
1272 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ISO) },
1273 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_JIS) },
1274 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI) },
1275 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ISO) },
1276 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_JIS) },
1277 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI) },
1278 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ISO) },
1279 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_JIS) },
1280 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_TP_ONLY) },
1281 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY) },
1282 	{ HID_USB_DEVICE(USB_VENDOR_ID_BELKIN, USB_DEVICE_ID_FLIP_KVM) },
1283 	{ HID_USB_DEVICE(USB_VENDOR_ID_CHERRY, USB_DEVICE_ID_CHERRY_CYMOTION) },
1284 	{ HID_USB_DEVICE(USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_TACTICAL_PAD) },
1285 	{ HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_1) },
1286 	{ HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_2) },
1287 	{ HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_MOUSE) },
1288 	{ HID_USB_DEVICE(USB_VENDOR_ID_DRAGONRISE, 0x0006) },
1289 	{ HID_USB_DEVICE(USB_VENDOR_ID_EZKEY, USB_DEVICE_ID_BTC_8193) },
1290 	{ HID_USB_DEVICE(USB_VENDOR_ID_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PSX_ADAPTOR) },
1291 	{ HID_USB_DEVICE(USB_VENDOR_ID_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PCS_ADAPTOR) },
1292 	{ HID_USB_DEVICE(USB_VENDOR_ID_GREENASIA, 0x0003) },
1293 	{ HID_USB_DEVICE(USB_VENDOR_ID_GREENASIA, 0x0012) },
1294 	{ HID_USB_DEVICE(USB_VENDOR_ID_GYRATION, USB_DEVICE_ID_GYRATION_REMOTE) },
1295 	{ HID_USB_DEVICE(USB_VENDOR_ID_GYRATION, USB_DEVICE_ID_GYRATION_REMOTE_2) },
1296 	{ HID_USB_DEVICE(USB_VENDOR_ID_KENSINGTON, USB_DEVICE_ID_KS_SLIMBLADE) },
1297 	{ HID_USB_DEVICE(USB_VENDOR_ID_KYE, USB_DEVICE_ID_KYE_ERGO_525V) },
1298 	{ HID_USB_DEVICE(USB_VENDOR_ID_LABTEC, USB_DEVICE_ID_LABTEC_WIRELESS_KEYBOARD) },
1299 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_MX3000_RECEIVER) },
1300 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_S510_RECEIVER) },
1301 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_S510_RECEIVER_2) },
1302 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RECEIVER) },
1303 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_DINOVO_DESKTOP) },
1304 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_DINOVO_EDGE) },
1305 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_DINOVO_MINI) },
1306 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_ELITE_KBD) },
1307 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_CORDLESS_DESKTOP_LX500) },
1308 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_EXTREME_3D) },
1309 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_WHEEL) },
1310 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RUMBLEPAD) },
1311 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RUMBLEPAD2_2) },
1312 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_WINGMAN_F3D) },
1313 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_WINGMAN_FFG ) },
1314 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_FORCE3D_PRO) },
1315 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_MOMO_WHEEL) },
1316 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_MOMO_WHEEL2) },
1317 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_G25_WHEEL) },
1318 	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RUMBLEPAD2) },
1319 	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_SIDEWINDER_GV) },
1320 	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_NE4K) },
1321 	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_LK6K) },
1322 	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_PRESENTER_8K_USB) },
1323 	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_WIRELESS_OPTICAL_DESKTOP_3_0) },
1324 	{ HID_USB_DEVICE(USB_VENDOR_ID_MONTEREY, USB_DEVICE_ID_GENIUS_KB29E) },
1325 	{ HID_USB_DEVICE(USB_VENDOR_ID_NTRIG, USB_DEVICE_ID_NTRIG_TOUCH_SCREEN) },
1326 	{ HID_USB_DEVICE(USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE) },
1327 	{ HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE) },
1328 	{ HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER) },
1329 	{ HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_VAIO_VGX_MOUSE) },
1330 	{ HID_USB_DEVICE(USB_VENDOR_ID_SUNPLUS, USB_DEVICE_ID_SUNPLUS_WDESKTOP) },
1331 	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb300) },
1332 	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb304) },
1333 	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb323) },
1334 	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb324) },
1335 	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb651) },
1336 	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654) },
1337 	{ HID_USB_DEVICE(USB_VENDOR_ID_TOPSEED, USB_DEVICE_ID_TOPSEED_CYBERLINK) },
1338 	{ HID_USB_DEVICE(USB_VENDOR_ID_TWINHAN, USB_DEVICE_ID_TWINHAN_IR_REMOTE) },
1339 	{ HID_USB_DEVICE(USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_SMARTJOY_PLUS) },
1340 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_WACOM, USB_DEVICE_ID_WACOM_GRAPHIRE_BLUETOOTH) },
1341 	{ HID_USB_DEVICE(USB_VENDOR_ID_ZEROPLUS, 0x0005) },
1342 	{ HID_USB_DEVICE(USB_VENDOR_ID_ZEROPLUS, 0x0030) },
1343 
1344 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_PRESENTER_8K_BT) },
1345 	{ }
1346 };
1347 
1348 struct hid_dynid {
1349 	struct list_head list;
1350 	struct hid_device_id id;
1351 };
1352 
1353 /**
1354  * store_new_id - add a new HID device ID to this driver and re-probe devices
1355  * @driver: target device driver
1356  * @buf: buffer for scanning device ID data
1357  * @count: input size
1358  *
1359  * Adds a new dynamic hid device ID to this driver,
1360  * and causes the driver to probe for all devices again.
1361  */
1362 static ssize_t store_new_id(struct device_driver *drv, const char *buf,
1363 		size_t count)
1364 {
1365 	struct hid_driver *hdrv = container_of(drv, struct hid_driver, driver);
1366 	struct hid_dynid *dynid;
1367 	__u32 bus, vendor, product;
1368 	unsigned long driver_data = 0;
1369 	int ret;
1370 
1371 	ret = sscanf(buf, "%x %x %x %lx",
1372 			&bus, &vendor, &product, &driver_data);
1373 	if (ret < 3)
1374 		return -EINVAL;
1375 
1376 	dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
1377 	if (!dynid)
1378 		return -ENOMEM;
1379 
1380 	dynid->id.bus = bus;
1381 	dynid->id.vendor = vendor;
1382 	dynid->id.product = product;
1383 	dynid->id.driver_data = driver_data;
1384 
1385 	spin_lock(&hdrv->dyn_lock);
1386 	list_add_tail(&dynid->list, &hdrv->dyn_list);
1387 	spin_unlock(&hdrv->dyn_lock);
1388 
1389 	ret = 0;
1390 	if (get_driver(&hdrv->driver)) {
1391 		ret = driver_attach(&hdrv->driver);
1392 		put_driver(&hdrv->driver);
1393 	}
1394 
1395 	return ret ? : count;
1396 }
1397 static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);
1398 
1399 static void hid_free_dynids(struct hid_driver *hdrv)
1400 {
1401 	struct hid_dynid *dynid, *n;
1402 
1403 	spin_lock(&hdrv->dyn_lock);
1404 	list_for_each_entry_safe(dynid, n, &hdrv->dyn_list, list) {
1405 		list_del(&dynid->list);
1406 		kfree(dynid);
1407 	}
1408 	spin_unlock(&hdrv->dyn_lock);
1409 }
1410 
1411 static const struct hid_device_id *hid_match_device(struct hid_device *hdev,
1412 		struct hid_driver *hdrv)
1413 {
1414 	struct hid_dynid *dynid;
1415 
1416 	spin_lock(&hdrv->dyn_lock);
1417 	list_for_each_entry(dynid, &hdrv->dyn_list, list) {
1418 		if (hid_match_one_id(hdev, &dynid->id)) {
1419 			spin_unlock(&hdrv->dyn_lock);
1420 			return &dynid->id;
1421 		}
1422 	}
1423 	spin_unlock(&hdrv->dyn_lock);
1424 
1425 	return hid_match_id(hdev, hdrv->id_table);
1426 }
1427 
1428 static int hid_bus_match(struct device *dev, struct device_driver *drv)
1429 {
1430 	struct hid_driver *hdrv = container_of(drv, struct hid_driver, driver);
1431 	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
1432 
1433 	if (!hid_match_device(hdev, hdrv))
1434 		return 0;
1435 
1436 	/* generic wants all non-blacklisted */
1437 	if (!strncmp(hdrv->name, "generic-", 8))
1438 		return !hid_match_id(hdev, hid_blacklist);
1439 
1440 	return 1;
1441 }
1442 
1443 static int hid_device_probe(struct device *dev)
1444 {
1445 	struct hid_driver *hdrv = container_of(dev->driver,
1446 			struct hid_driver, driver);
1447 	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
1448 	const struct hid_device_id *id;
1449 	int ret = 0;
1450 
1451 	if (!hdev->driver) {
1452 		id = hid_match_device(hdev, hdrv);
1453 		if (id == NULL)
1454 			return -ENODEV;
1455 
1456 		hdev->driver = hdrv;
1457 		if (hdrv->probe) {
1458 			ret = hdrv->probe(hdev, id);
1459 		} else { /* default probe */
1460 			ret = hid_parse(hdev);
1461 			if (!ret)
1462 				ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
1463 		}
1464 		if (ret)
1465 			hdev->driver = NULL;
1466 	}
1467 	return ret;
1468 }
1469 
1470 static int hid_device_remove(struct device *dev)
1471 {
1472 	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
1473 	struct hid_driver *hdrv = hdev->driver;
1474 
1475 	if (hdrv) {
1476 		if (hdrv->remove)
1477 			hdrv->remove(hdev);
1478 		else /* default remove */
1479 			hid_hw_stop(hdev);
1480 		hdev->driver = NULL;
1481 	}
1482 
1483 	return 0;
1484 }
1485 
1486 static int hid_uevent(struct device *dev, struct kobj_uevent_env *env)
1487 {
1488 	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
1489 
1490 	if (add_uevent_var(env, "HID_ID=%04X:%08X:%08X",
1491 			hdev->bus, hdev->vendor, hdev->product))
1492 		return -ENOMEM;
1493 
1494 	if (add_uevent_var(env, "HID_NAME=%s", hdev->name))
1495 		return -ENOMEM;
1496 
1497 	if (add_uevent_var(env, "HID_PHYS=%s", hdev->phys))
1498 		return -ENOMEM;
1499 
1500 	if (add_uevent_var(env, "HID_UNIQ=%s", hdev->uniq))
1501 		return -ENOMEM;
1502 
1503 	if (add_uevent_var(env, "MODALIAS=hid:b%04Xv%08Xp%08X",
1504 			hdev->bus, hdev->vendor, hdev->product))
1505 		return -ENOMEM;
1506 
1507 	return 0;
1508 }
1509 
1510 static struct bus_type hid_bus_type = {
1511 	.name		= "hid",
1512 	.match		= hid_bus_match,
1513 	.probe		= hid_device_probe,
1514 	.remove		= hid_device_remove,
1515 	.uevent		= hid_uevent,
1516 };
1517 
1518 /* a list of devices that shouldn't be handled by HID core at all */
1519 static const struct hid_device_id hid_ignore_list[] = {
1520 	{ HID_USB_DEVICE(USB_VENDOR_ID_ACECAD, USB_DEVICE_ID_ACECAD_FLAIR) },
1521 	{ HID_USB_DEVICE(USB_VENDOR_ID_ACECAD, USB_DEVICE_ID_ACECAD_302) },
1522 	{ HID_USB_DEVICE(USB_VENDOR_ID_ADS_TECH, USB_DEVICE_ID_ADS_TECH_RADIO_SI470X) },
1523 	{ HID_USB_DEVICE(USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_01) },
1524 	{ HID_USB_DEVICE(USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_10) },
1525 	{ HID_USB_DEVICE(USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_20) },
1526 	{ HID_USB_DEVICE(USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_21) },
1527 	{ HID_USB_DEVICE(USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_22) },
1528 	{ HID_USB_DEVICE(USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_23) },
1529 	{ HID_USB_DEVICE(USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_24) },
1530 	{ HID_USB_DEVICE(USB_VENDOR_ID_AIRCABLE, USB_DEVICE_ID_AIRCABLE1) },
1531 	{ HID_USB_DEVICE(USB_VENDOR_ID_ALCOR, USB_DEVICE_ID_ALCOR_USBRS232) },
1532 	{ HID_USB_DEVICE(USB_VENDOR_ID_ASUS, USB_DEVICE_ID_ASUS_LCM)},
1533 	{ HID_USB_DEVICE(USB_VENDOR_ID_ASUS, USB_DEVICE_ID_ASUS_LCM2)},
1534 	{ HID_USB_DEVICE(USB_VENDOR_ID_AVERMEDIA, USB_DEVICE_ID_AVER_FM_MR800) },
1535 	{ HID_USB_DEVICE(USB_VENDOR_ID_BERKSHIRE, USB_DEVICE_ID_BERKSHIRE_PCWD) },
1536 	{ HID_USB_DEVICE(USB_VENDOR_ID_CIDC, 0x0103) },
1537 	{ HID_USB_DEVICE(USB_VENDOR_ID_CYGNAL, USB_DEVICE_ID_CYGNAL_RADIO_SI470X) },
1538 	{ HID_USB_DEVICE(USB_VENDOR_ID_CMEDIA, USB_DEVICE_ID_CM109) },
1539 	{ HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_HIDCOM) },
1540 	{ HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_ULTRAMOUSE) },
1541 	{ HID_USB_DEVICE(USB_VENDOR_ID_DEALEXTREAME, USB_DEVICE_ID_DEALEXTREAME_RADIO_SI4701) },
1542 	{ HID_USB_DEVICE(USB_VENDOR_ID_DELORME, USB_DEVICE_ID_DELORME_EARTHMATE) },
1543 	{ HID_USB_DEVICE(USB_VENDOR_ID_DELORME, USB_DEVICE_ID_DELORME_EM_LT20) },
1544 	{ HID_USB_DEVICE(USB_VENDOR_ID_ESSENTIAL_REALITY, USB_DEVICE_ID_ESSENTIAL_REALITY_P5) },
1545 	{ HID_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH, 0x0001) },
1546 	{ HID_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH, 0x0002) },
1547 	{ HID_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH, 0x0003) },
1548 	{ HID_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH, 0x0004) },
1549 	{ HID_USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_4_PHIDGETSERVO_30) },
1550 	{ HID_USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_1_PHIDGETSERVO_30) },
1551 	{ HID_USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_0_4_IF_KIT) },
1552 	{ HID_USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_16_16_IF_KIT) },
1553 	{ HID_USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_8_8_8_IF_KIT) },
1554 	{ HID_USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_8_7_IF_KIT) },
1555 	{ HID_USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_0_8_8_IF_KIT) },
1556 	{ HID_USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_PHIDGET_MOTORCONTROL) },
1557 	{ HID_USB_DEVICE(USB_VENDOR_ID_GOTOP, USB_DEVICE_ID_SUPER_Q2) },
1558 	{ HID_USB_DEVICE(USB_VENDOR_ID_GOTOP, USB_DEVICE_ID_GOGOPEN) },
1559 	{ HID_USB_DEVICE(USB_VENDOR_ID_GOTOP, USB_DEVICE_ID_PENPOWER) },
1560 	{ HID_USB_DEVICE(USB_VENDOR_ID_GRETAGMACBETH, USB_DEVICE_ID_GRETAGMACBETH_HUEY) },
1561 	{ HID_USB_DEVICE(USB_VENDOR_ID_GRIFFIN, USB_DEVICE_ID_POWERMATE) },
1562 	{ HID_USB_DEVICE(USB_VENDOR_ID_GRIFFIN, USB_DEVICE_ID_SOUNDKNOB) },
1563 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_90) },
1564 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_100) },
1565 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_101) },
1566 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_103) },
1567 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_104) },
1568 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_105) },
1569 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_106) },
1570 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_107) },
1571 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_108) },
1572 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_200) },
1573 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_201) },
1574 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_202) },
1575 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_203) },
1576 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_204) },
1577 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_205) },
1578 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_206) },
1579 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_207) },
1580 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_300) },
1581 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_301) },
1582 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_302) },
1583 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_303) },
1584 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_304) },
1585 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_305) },
1586 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_306) },
1587 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_307) },
1588 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_308) },
1589 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_309) },
1590 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_400) },
1591 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_401) },
1592 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_402) },
1593 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_403) },
1594 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_404) },
1595 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_405) },
1596 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_500) },
1597 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_501) },
1598 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_502) },
1599 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_503) },
1600 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_504) },
1601 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1000) },
1602 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1001) },
1603 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1002) },
1604 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1003) },
1605 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1004) },
1606 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1005) },
1607 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1006) },
1608 	{ HID_USB_DEVICE(USB_VENDOR_ID_GTCO, USB_DEVICE_ID_GTCO_1007) },
1609 	{ HID_USB_DEVICE(USB_VENDOR_ID_IMATION, USB_DEVICE_ID_DISC_STAKKA) },
1610 	{ HID_USB_DEVICE(USB_VENDOR_ID_KBGEAR, USB_DEVICE_ID_KBGEAR_JAMSTUDIO) },
1611 	{ HID_USB_DEVICE(USB_VENDOR_ID_KWORLD, USB_DEVICE_ID_KWORLD_RADIO_FM700) },
1612 	{ HID_USB_DEVICE(USB_VENDOR_ID_KYE, USB_DEVICE_ID_KYE_GPEN_560) },
1613 	{ HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_CASSY) },
1614 	{ HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POCKETCASSY) },
1615 	{ HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MOBILECASSY) },
1616 	{ HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_JWM) },
1617 	{ HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_DMMP) },
1618 	{ HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_UMIP) },
1619 	{ HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_XRAY1) },
1620 	{ HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_XRAY2) },
1621 	{ HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_VIDEOCOM) },
1622 	{ HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_COM3LAB) },
1623 	{ HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_TELEPORT) },
1624 	{ HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_NETWORKANALYSER) },
1625 	{ HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POWERCONTROL) },
1626 	{ HID_USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MACHINETEST) },
1627 	{ HID_USB_DEVICE(USB_VENDOR_ID_MCC, USB_DEVICE_ID_MCC_PMD1024LS) },
1628 	{ HID_USB_DEVICE(USB_VENDOR_ID_MCC, USB_DEVICE_ID_MCC_PMD1208LS) },
1629 	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROCHIP, USB_DEVICE_ID_PICKIT1) },
1630 	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROCHIP, USB_DEVICE_ID_PICKIT2) },
1631 	{ HID_USB_DEVICE(USB_VENDOR_ID_NATIONAL_SEMICONDUCTOR, USB_DEVICE_ID_N_S_HARMONY) },
1632 	{ HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100) },
1633 	{ HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 20) },
1634 	{ HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 30) },
1635 	{ HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 100) },
1636 	{ HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 108) },
1637 	{ HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 118) },
1638 	{ HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 200) },
1639 	{ HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 300) },
1640 	{ HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 400) },
1641 	{ HID_USB_DEVICE(USB_VENDOR_ID_ONTRAK, USB_DEVICE_ID_ONTRAK_ADU100 + 500) },
1642 	{ HID_USB_DEVICE(USB_VENDOR_ID_PANJIT, 0x0001) },
1643 	{ HID_USB_DEVICE(USB_VENDOR_ID_PANJIT, 0x0002) },
1644 	{ HID_USB_DEVICE(USB_VENDOR_ID_PANJIT, 0x0003) },
1645 	{ HID_USB_DEVICE(USB_VENDOR_ID_PANJIT, 0x0004) },
1646 	{ HID_USB_DEVICE(USB_VENDOR_ID_PHILIPS, USB_DEVICE_ID_PHILIPS_IEEE802154_DONGLE) },
1647 	{ HID_USB_DEVICE(USB_VENDOR_ID_POWERCOM, USB_DEVICE_ID_POWERCOM_UPS) },
1648 	{ HID_USB_DEVICE(USB_VENDOR_ID_TENX, USB_DEVICE_ID_TENX_IBUDDY1) },
1649 	{ HID_USB_DEVICE(USB_VENDOR_ID_TENX, USB_DEVICE_ID_TENX_IBUDDY2) },
1650 	{ HID_USB_DEVICE(USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_LABPRO) },
1651 	{ HID_USB_DEVICE(USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_GOTEMP) },
1652 	{ HID_USB_DEVICE(USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_SKIP) },
1653 	{ HID_USB_DEVICE(USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_CYCLOPS) },
1654 	{ HID_USB_DEVICE(USB_VENDOR_ID_VERNIER, USB_DEVICE_ID_VERNIER_LCSPEC) },
1655 	{ HID_USB_DEVICE(USB_VENDOR_ID_WACOM, HID_ANY_ID) },
1656 	{ HID_USB_DEVICE(USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_4_PHIDGETSERVO_20) },
1657 	{ HID_USB_DEVICE(USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_1_PHIDGETSERVO_20) },
1658 	{ HID_USB_DEVICE(USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_8_8_4_IF_KIT) },
1659 	{ HID_USB_DEVICE(USB_VENDOR_ID_YEALINK, USB_DEVICE_ID_YEALINK_P1K_P4K_B2K) },
1660 	{ }
1661 };
1662 
1663 /**
1664  * hid_mouse_ignore_list - mouse devices which should not be handled by the hid layer
1665  *
1666  * There are composite devices for which we want to ignore only a certain
1667  * interface. This is a list of devices for which only the mouse interface will
1668  * be ignored. This allows a dedicated driver to take care of the interface.
1669  */
1670 static const struct hid_device_id hid_mouse_ignore_list[] = {
1671 	/* appletouch driver */
1672 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ANSI) },
1673 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ISO) },
1674 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ANSI) },
1675 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ISO) },
1676 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_JIS) },
1677 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ANSI) },
1678 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ISO) },
1679 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_JIS) },
1680 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ANSI) },
1681 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ISO) },
1682 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_JIS) },
1683 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ANSI) },
1684 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ISO) },
1685 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_JIS) },
1686 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ANSI) },
1687 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ISO) },
1688 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_JIS) },
1689 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI) },
1690 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ISO) },
1691 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_JIS) },
1692 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI) },
1693 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ISO) },
1694 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_JIS) },
1695 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_TP_ONLY) },
1696 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY) },
1697 	{ }
1698 };
1699 
1700 static bool hid_ignore(struct hid_device *hdev)
1701 {
1702 	switch (hdev->vendor) {
1703 	case USB_VENDOR_ID_CODEMERCS:
1704 		/* ignore all Code Mercenaries IOWarrior devices */
1705 		if (hdev->product >= USB_DEVICE_ID_CODEMERCS_IOW_FIRST &&
1706 				hdev->product <= USB_DEVICE_ID_CODEMERCS_IOW_LAST)
1707 			return true;
1708 		break;
1709 	case USB_VENDOR_ID_LOGITECH:
1710 		if (hdev->product >= USB_DEVICE_ID_LOGITECH_HARMONY_FIRST &&
1711 				hdev->product <= USB_DEVICE_ID_LOGITECH_HARMONY_LAST)
1712 			return true;
1713 		break;
1714 	case USB_VENDOR_ID_SOUNDGRAPH:
1715 		if (hdev->product >= USB_DEVICE_ID_SOUNDGRAPH_IMON_FIRST &&
1716 		    hdev->product <= USB_DEVICE_ID_SOUNDGRAPH_IMON_LAST)
1717 			return true;
1718 		break;
1719 	}
1720 
1721 	if (hdev->type == HID_TYPE_USBMOUSE &&
1722 			hid_match_id(hdev, hid_mouse_ignore_list))
1723 		return true;
1724 
1725 	return !!hid_match_id(hdev, hid_ignore_list);
1726 }
1727 
1728 int hid_add_device(struct hid_device *hdev)
1729 {
1730 	static atomic_t id = ATOMIC_INIT(0);
1731 	int ret;
1732 
1733 	if (WARN_ON(hdev->status & HID_STAT_ADDED))
1734 		return -EBUSY;
1735 
1736 	/* we need to kill them here, otherwise they will stay allocated to
1737 	 * wait for coming driver */
1738 	if (hid_ignore(hdev))
1739 		return -ENODEV;
1740 
1741 	/* XXX hack, any other cleaner solution after the driver core
1742 	 * is converted to allow more than 20 bytes as the device name? */
1743 	dev_set_name(&hdev->dev, "%04X:%04X:%04X.%04X", hdev->bus,
1744 		     hdev->vendor, hdev->product, atomic_inc_return(&id));
1745 
1746 	ret = device_add(&hdev->dev);
1747 	if (!ret)
1748 		hdev->status |= HID_STAT_ADDED;
1749 
1750 	hid_debug_register(hdev, dev_name(&hdev->dev));
1751 
1752 	return ret;
1753 }
1754 EXPORT_SYMBOL_GPL(hid_add_device);
1755 
1756 /**
1757  * hid_allocate_device - allocate new hid device descriptor
1758  *
1759  * Allocate and initialize hid device, so that hid_destroy_device might be
1760  * used to free it.
1761  *
1762  * New hid_device pointer is returned on success, otherwise ERR_PTR encoded
1763  * error value.
1764  */
1765 struct hid_device *hid_allocate_device(void)
1766 {
1767 	struct hid_device *hdev;
1768 	unsigned int i;
1769 	int ret = -ENOMEM;
1770 
1771 	hdev = kzalloc(sizeof(*hdev), GFP_KERNEL);
1772 	if (hdev == NULL)
1773 		return ERR_PTR(ret);
1774 
1775 	device_initialize(&hdev->dev);
1776 	hdev->dev.release = hid_device_release;
1777 	hdev->dev.bus = &hid_bus_type;
1778 
1779 	hdev->collection = kcalloc(HID_DEFAULT_NUM_COLLECTIONS,
1780 			sizeof(struct hid_collection), GFP_KERNEL);
1781 	if (hdev->collection == NULL)
1782 		goto err;
1783 	hdev->collection_size = HID_DEFAULT_NUM_COLLECTIONS;
1784 
1785 	for (i = 0; i < HID_REPORT_TYPES; i++)
1786 		INIT_LIST_HEAD(&hdev->report_enum[i].report_list);
1787 
1788 	init_waitqueue_head(&hdev->debug_wait);
1789 	INIT_LIST_HEAD(&hdev->debug_list);
1790 
1791 	return hdev;
1792 err:
1793 	put_device(&hdev->dev);
1794 	return ERR_PTR(ret);
1795 }
1796 EXPORT_SYMBOL_GPL(hid_allocate_device);
1797 
1798 static void hid_remove_device(struct hid_device *hdev)
1799 {
1800 	if (hdev->status & HID_STAT_ADDED) {
1801 		device_del(&hdev->dev);
1802 		hid_debug_unregister(hdev);
1803 		hdev->status &= ~HID_STAT_ADDED;
1804 	}
1805 }
1806 
1807 /**
1808  * hid_destroy_device - free previously allocated device
1809  *
1810  * @hdev: hid device
1811  *
1812  * If you allocate hid_device through hid_allocate_device, you should ever
1813  * free by this function.
1814  */
1815 void hid_destroy_device(struct hid_device *hdev)
1816 {
1817 	hid_remove_device(hdev);
1818 	put_device(&hdev->dev);
1819 }
1820 EXPORT_SYMBOL_GPL(hid_destroy_device);
1821 
1822 int __hid_register_driver(struct hid_driver *hdrv, struct module *owner,
1823 		const char *mod_name)
1824 {
1825 	int ret;
1826 
1827 	hdrv->driver.name = hdrv->name;
1828 	hdrv->driver.bus = &hid_bus_type;
1829 	hdrv->driver.owner = owner;
1830 	hdrv->driver.mod_name = mod_name;
1831 
1832 	INIT_LIST_HEAD(&hdrv->dyn_list);
1833 	spin_lock_init(&hdrv->dyn_lock);
1834 
1835 	ret = driver_register(&hdrv->driver);
1836 	if (ret)
1837 		return ret;
1838 
1839 	ret = driver_create_file(&hdrv->driver, &driver_attr_new_id);
1840 	if (ret)
1841 		driver_unregister(&hdrv->driver);
1842 
1843 	return ret;
1844 }
1845 EXPORT_SYMBOL_GPL(__hid_register_driver);
1846 
1847 void hid_unregister_driver(struct hid_driver *hdrv)
1848 {
1849 	driver_remove_file(&hdrv->driver, &driver_attr_new_id);
1850 	driver_unregister(&hdrv->driver);
1851 	hid_free_dynids(hdrv);
1852 }
1853 EXPORT_SYMBOL_GPL(hid_unregister_driver);
1854 
1855 int hid_check_keys_pressed(struct hid_device *hid)
1856 {
1857 	struct hid_input *hidinput;
1858 	int i;
1859 
1860 	if (!(hid->claimed & HID_CLAIMED_INPUT))
1861 		return 0;
1862 
1863 	list_for_each_entry(hidinput, &hid->inputs, list) {
1864 		for (i = 0; i < BITS_TO_LONGS(KEY_MAX); i++)
1865 			if (hidinput->input->key[i])
1866 				return 1;
1867 	}
1868 
1869 	return 0;
1870 }
1871 
1872 EXPORT_SYMBOL_GPL(hid_check_keys_pressed);
1873 
1874 static int __init hid_init(void)
1875 {
1876 	int ret;
1877 
1878 	if (hid_debug)
1879 		printk(KERN_WARNING "HID: hid_debug is now used solely for parser and driver debugging.\n"
1880 				"HID: debugfs is now used for inspecting the device (report descriptor, reports)\n");
1881 
1882 	ret = bus_register(&hid_bus_type);
1883 	if (ret) {
1884 		printk(KERN_ERR "HID: can't register hid bus\n");
1885 		goto err;
1886 	}
1887 
1888 	ret = hidraw_init();
1889 	if (ret)
1890 		goto err_bus;
1891 
1892 	hid_debug_init();
1893 
1894 	return 0;
1895 err_bus:
1896 	bus_unregister(&hid_bus_type);
1897 err:
1898 	return ret;
1899 }
1900 
1901 static void __exit hid_exit(void)
1902 {
1903 	hid_debug_exit();
1904 	hidraw_exit();
1905 	bus_unregister(&hid_bus_type);
1906 }
1907 
1908 module_init(hid_init);
1909 module_exit(hid_exit);
1910 
1911 MODULE_LICENSE(DRIVER_LICENSE);
1912 
1913