Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * HID support for Linux
4 *
5 * Copyright (c) 1999 Andreas Gal
6 * Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
7 * Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
8 * Copyright (c) 2006-2012 Jiri Kosina
9 */
10
11/*
12 */
13
14#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15
16#include <linux/module.h>
17#include <linux/slab.h>
18#include <linux/init.h>
19#include <linux/kernel.h>
20#include <linux/list.h>
21#include <linux/mm.h>
22#include <linux/spinlock.h>
23#include <linux/unaligned.h>
24#include <asm/byteorder.h>
25#include <linux/input.h>
26#include <linux/wait.h>
27#include <linux/vmalloc.h>
28#include <linux/sched.h>
29#include <linux/semaphore.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_DESC "HID core driver"
43
44static int hid_ignore_special_drivers = 0;
45module_param_named(ignore_special_drivers, hid_ignore_special_drivers, int, 0600);
46MODULE_PARM_DESC(ignore_special_drivers, "Ignore any special drivers and handle all devices by generic driver");
47
48/*
49 * Convert a signed n-bit integer to signed 32-bit integer.
50 */
51
52static s32 snto32(__u32 value, unsigned int n)
53{
54 if (!value || !n)
55 return 0;
56
57 if (n > 32)
58 n = 32;
59
60 return sign_extend32(value, n - 1);
61}
62
63/*
64 * Convert a signed 32-bit integer to a signed n-bit integer.
65 */
66
67static u32 s32ton(__s32 value, unsigned int n)
68{
69 s32 a = value >> (n - 1);
70
71 if (a && a != -1)
72 return value < 0 ? 1 << (n - 1) : (1 << (n - 1)) - 1;
73 return value & ((1 << n) - 1);
74}
75
76/*
77 * Register a new report for a device.
78 */
79
80struct hid_report *hid_register_report(struct hid_device *device,
81 enum hid_report_type type, unsigned int id,
82 unsigned int application)
83{
84 struct hid_report_enum *report_enum = device->report_enum + type;
85 struct hid_report *report;
86
87 if (id >= HID_MAX_IDS)
88 return NULL;
89 if (report_enum->report_id_hash[id])
90 return report_enum->report_id_hash[id];
91
92 report = kzalloc(sizeof(struct hid_report), GFP_KERNEL);
93 if (!report)
94 return NULL;
95
96 if (id != 0)
97 report_enum->numbered = 1;
98
99 report->id = id;
100 report->type = type;
101 report->size = 0;
102 report->device = device;
103 report->application = application;
104 report_enum->report_id_hash[id] = report;
105
106 list_add_tail(&report->list, &report_enum->report_list);
107 INIT_LIST_HEAD(&report->field_entry_list);
108
109 return report;
110}
111EXPORT_SYMBOL_GPL(hid_register_report);
112
113/*
114 * Register a new field for this report.
115 */
116
117static struct hid_field *hid_register_field(struct hid_report *report, unsigned usages)
118{
119 struct hid_field *field;
120
121 if (report->maxfield == HID_MAX_FIELDS) {
122 hid_err(report->device, "too many fields in report\n");
123 return NULL;
124 }
125
126 field = kvzalloc((sizeof(struct hid_field) +
127 usages * sizeof(struct hid_usage) +
128 3 * usages * sizeof(unsigned int)), GFP_KERNEL);
129 if (!field)
130 return NULL;
131
132 field->index = report->maxfield++;
133 report->field[field->index] = field;
134 field->usage = (struct hid_usage *)(field + 1);
135 field->value = (s32 *)(field->usage + usages);
136 field->new_value = (s32 *)(field->value + usages);
137 field->usages_priorities = (s32 *)(field->new_value + usages);
138 field->report = report;
139
140 return field;
141}
142
143/*
144 * Open a collection. The type/usage is pushed on the stack.
145 */
146
147static int open_collection(struct hid_parser *parser, unsigned type)
148{
149 struct hid_collection *collection;
150 unsigned usage;
151 int collection_index;
152
153 usage = parser->local.usage[0];
154
155 if (parser->collection_stack_ptr == parser->collection_stack_size) {
156 unsigned int *collection_stack;
157 unsigned int new_size = parser->collection_stack_size +
158 HID_COLLECTION_STACK_SIZE;
159
160 collection_stack = krealloc(parser->collection_stack,
161 new_size * sizeof(unsigned int),
162 GFP_KERNEL);
163 if (!collection_stack)
164 return -ENOMEM;
165
166 parser->collection_stack = collection_stack;
167 parser->collection_stack_size = new_size;
168 }
169
170 if (parser->device->maxcollection == parser->device->collection_size) {
171 collection = kmalloc(
172 array3_size(sizeof(struct hid_collection),
173 parser->device->collection_size,
174 2),
175 GFP_KERNEL);
176 if (collection == NULL) {
177 hid_err(parser->device, "failed to reallocate collection array\n");
178 return -ENOMEM;
179 }
180 memcpy(collection, parser->device->collection,
181 sizeof(struct hid_collection) *
182 parser->device->collection_size);
183 memset(collection + parser->device->collection_size, 0,
184 sizeof(struct hid_collection) *
185 parser->device->collection_size);
186 kfree(parser->device->collection);
187 parser->device->collection = collection;
188 parser->device->collection_size *= 2;
189 }
190
191 parser->collection_stack[parser->collection_stack_ptr++] =
192 parser->device->maxcollection;
193
194 collection_index = parser->device->maxcollection++;
195 collection = parser->device->collection + collection_index;
196 collection->type = type;
197 collection->usage = usage;
198 collection->level = parser->collection_stack_ptr - 1;
199 collection->parent_idx = (collection->level == 0) ? -1 :
200 parser->collection_stack[collection->level - 1];
201
202 if (type == HID_COLLECTION_APPLICATION)
203 parser->device->maxapplication++;
204
205 return 0;
206}
207
208/*
209 * Close a collection.
210 */
211
212static int close_collection(struct hid_parser *parser)
213{
214 if (!parser->collection_stack_ptr) {
215 hid_err(parser->device, "collection stack underflow\n");
216 return -EINVAL;
217 }
218 parser->collection_stack_ptr--;
219 return 0;
220}
221
222/*
223 * Climb up the stack, search for the specified collection type
224 * and return the usage.
225 */
226
227static unsigned hid_lookup_collection(struct hid_parser *parser, unsigned type)
228{
229 struct hid_collection *collection = parser->device->collection;
230 int n;
231
232 for (n = parser->collection_stack_ptr - 1; n >= 0; n--) {
233 unsigned index = parser->collection_stack[n];
234 if (collection[index].type == type)
235 return collection[index].usage;
236 }
237 return 0; /* we know nothing about this usage type */
238}
239
240/*
241 * Concatenate usage which defines 16 bits or less with the
242 * currently defined usage page to form a 32 bit usage
243 */
244
245static void complete_usage(struct hid_parser *parser, unsigned int index)
246{
247 parser->local.usage[index] &= 0xFFFF;
248 parser->local.usage[index] |=
249 (parser->global.usage_page & 0xFFFF) << 16;
250}
251
252/*
253 * Add a usage to the temporary parser table.
254 */
255
256static int hid_add_usage(struct hid_parser *parser, unsigned usage, u8 size)
257{
258 if (parser->local.usage_index >= HID_MAX_USAGES) {
259 hid_err(parser->device, "usage index exceeded\n");
260 return -1;
261 }
262 parser->local.usage[parser->local.usage_index] = usage;
263
264 /*
265 * If Usage item only includes usage id, concatenate it with
266 * currently defined usage page
267 */
268 if (size <= 2)
269 complete_usage(parser, parser->local.usage_index);
270
271 parser->local.usage_size[parser->local.usage_index] = size;
272 parser->local.collection_index[parser->local.usage_index] =
273 parser->collection_stack_ptr ?
274 parser->collection_stack[parser->collection_stack_ptr - 1] : 0;
275 parser->local.usage_index++;
276 return 0;
277}
278
279/*
280 * Register a new field for this report.
281 */
282
283static int hid_add_field(struct hid_parser *parser, unsigned report_type, unsigned flags)
284{
285 struct hid_report *report;
286 struct hid_field *field;
287 unsigned int max_buffer_size = HID_MAX_BUFFER_SIZE;
288 unsigned int usages;
289 unsigned int offset;
290 unsigned int i;
291 unsigned int application;
292
293 application = hid_lookup_collection(parser, HID_COLLECTION_APPLICATION);
294
295 report = hid_register_report(parser->device, report_type,
296 parser->global.report_id, application);
297 if (!report) {
298 hid_err(parser->device, "hid_register_report failed\n");
299 return -1;
300 }
301
302 /* Handle both signed and unsigned cases properly */
303 if ((parser->global.logical_minimum < 0 &&
304 parser->global.logical_maximum <
305 parser->global.logical_minimum) ||
306 (parser->global.logical_minimum >= 0 &&
307 (__u32)parser->global.logical_maximum <
308 (__u32)parser->global.logical_minimum)) {
309 dbg_hid("logical range invalid 0x%x 0x%x\n",
310 parser->global.logical_minimum,
311 parser->global.logical_maximum);
312 return -1;
313 }
314
315 offset = report->size;
316 report->size += parser->global.report_size * parser->global.report_count;
317
318 if (parser->device->ll_driver->max_buffer_size)
319 max_buffer_size = parser->device->ll_driver->max_buffer_size;
320
321 /* Total size check: Allow for possible report index byte */
322 if (report->size > (max_buffer_size - 1) << 3) {
323 hid_err(parser->device, "report is too long\n");
324 return -1;
325 }
326
327 if (!parser->local.usage_index) /* Ignore padding fields */
328 return 0;
329
330 usages = max_t(unsigned, parser->local.usage_index,
331 parser->global.report_count);
332
333 field = hid_register_field(report, usages);
334 if (!field)
335 return 0;
336
337 field->physical = hid_lookup_collection(parser, HID_COLLECTION_PHYSICAL);
338 field->logical = hid_lookup_collection(parser, HID_COLLECTION_LOGICAL);
339 field->application = application;
340
341 for (i = 0; i < usages; i++) {
342 unsigned j = i;
343 /* Duplicate the last usage we parsed if we have excess values */
344 if (i >= parser->local.usage_index)
345 j = parser->local.usage_index - 1;
346 field->usage[i].hid = parser->local.usage[j];
347 field->usage[i].collection_index =
348 parser->local.collection_index[j];
349 field->usage[i].usage_index = i;
350 field->usage[i].resolution_multiplier = 1;
351 }
352
353 field->maxusage = usages;
354 field->flags = flags;
355 field->report_offset = offset;
356 field->report_type = report_type;
357 field->report_size = parser->global.report_size;
358 field->report_count = parser->global.report_count;
359 field->logical_minimum = parser->global.logical_minimum;
360 field->logical_maximum = parser->global.logical_maximum;
361 field->physical_minimum = parser->global.physical_minimum;
362 field->physical_maximum = parser->global.physical_maximum;
363 field->unit_exponent = parser->global.unit_exponent;
364 field->unit = parser->global.unit;
365
366 return 0;
367}
368
369/*
370 * Read data value from item.
371 */
372
373static u32 item_udata(struct hid_item *item)
374{
375 switch (item->size) {
376 case 1: return item->data.u8;
377 case 2: return item->data.u16;
378 case 4: return item->data.u32;
379 }
380 return 0;
381}
382
383static s32 item_sdata(struct hid_item *item)
384{
385 switch (item->size) {
386 case 1: return item->data.s8;
387 case 2: return item->data.s16;
388 case 4: return item->data.s32;
389 }
390 return 0;
391}
392
393/*
394 * Process a global item.
395 */
396
397static int hid_parser_global(struct hid_parser *parser, struct hid_item *item)
398{
399 __s32 raw_value;
400 switch (item->tag) {
401 case HID_GLOBAL_ITEM_TAG_PUSH:
402
403 if (parser->global_stack_ptr == HID_GLOBAL_STACK_SIZE) {
404 hid_err(parser->device, "global environment stack overflow\n");
405 return -1;
406 }
407
408 memcpy(parser->global_stack + parser->global_stack_ptr++,
409 &parser->global, sizeof(struct hid_global));
410 return 0;
411
412 case HID_GLOBAL_ITEM_TAG_POP:
413
414 if (!parser->global_stack_ptr) {
415 hid_err(parser->device, "global environment stack underflow\n");
416 return -1;
417 }
418
419 memcpy(&parser->global, parser->global_stack +
420 --parser->global_stack_ptr, sizeof(struct hid_global));
421 return 0;
422
423 case HID_GLOBAL_ITEM_TAG_USAGE_PAGE:
424 parser->global.usage_page = item_udata(item);
425 return 0;
426
427 case HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM:
428 parser->global.logical_minimum = item_sdata(item);
429 return 0;
430
431 case HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM:
432 if (parser->global.logical_minimum < 0)
433 parser->global.logical_maximum = item_sdata(item);
434 else
435 parser->global.logical_maximum = item_udata(item);
436 return 0;
437
438 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM:
439 parser->global.physical_minimum = item_sdata(item);
440 return 0;
441
442 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM:
443 if (parser->global.physical_minimum < 0)
444 parser->global.physical_maximum = item_sdata(item);
445 else
446 parser->global.physical_maximum = item_udata(item);
447 return 0;
448
449 case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT:
450 /* Many devices provide unit exponent as a two's complement
451 * nibble due to the common misunderstanding of HID
452 * specification 1.11, 6.2.2.7 Global Items. Attempt to handle
453 * both this and the standard encoding. */
454 raw_value = item_sdata(item);
455 if (!(raw_value & 0xfffffff0))
456 parser->global.unit_exponent = snto32(raw_value, 4);
457 else
458 parser->global.unit_exponent = raw_value;
459 return 0;
460
461 case HID_GLOBAL_ITEM_TAG_UNIT:
462 parser->global.unit = item_udata(item);
463 return 0;
464
465 case HID_GLOBAL_ITEM_TAG_REPORT_SIZE:
466 parser->global.report_size = item_udata(item);
467 if (parser->global.report_size > 256) {
468 hid_err(parser->device, "invalid report_size %d\n",
469 parser->global.report_size);
470 return -1;
471 }
472 return 0;
473
474 case HID_GLOBAL_ITEM_TAG_REPORT_COUNT:
475 parser->global.report_count = item_udata(item);
476 if (parser->global.report_count > HID_MAX_USAGES) {
477 hid_err(parser->device, "invalid report_count %d\n",
478 parser->global.report_count);
479 return -1;
480 }
481 return 0;
482
483 case HID_GLOBAL_ITEM_TAG_REPORT_ID:
484 parser->global.report_id = item_udata(item);
485 if (parser->global.report_id == 0 ||
486 parser->global.report_id >= HID_MAX_IDS) {
487 hid_err(parser->device, "report_id %u is invalid\n",
488 parser->global.report_id);
489 return -1;
490 }
491 return 0;
492
493 default:
494 hid_err(parser->device, "unknown global tag 0x%x\n", item->tag);
495 return -1;
496 }
497}
498
499/*
500 * Process a local item.
501 */
502
503static int hid_parser_local(struct hid_parser *parser, struct hid_item *item)
504{
505 __u32 data;
506 unsigned n;
507 __u32 count;
508
509 data = item_udata(item);
510
511 switch (item->tag) {
512 case HID_LOCAL_ITEM_TAG_DELIMITER:
513
514 if (data) {
515 /*
516 * We treat items before the first delimiter
517 * as global to all usage sets (branch 0).
518 * In the moment we process only these global
519 * items and the first delimiter set.
520 */
521 if (parser->local.delimiter_depth != 0) {
522 hid_err(parser->device, "nested delimiters\n");
523 return -1;
524 }
525 parser->local.delimiter_depth++;
526 parser->local.delimiter_branch++;
527 } else {
528 if (parser->local.delimiter_depth < 1) {
529 hid_err(parser->device, "bogus close delimiter\n");
530 return -1;
531 }
532 parser->local.delimiter_depth--;
533 }
534 return 0;
535
536 case HID_LOCAL_ITEM_TAG_USAGE:
537
538 if (parser->local.delimiter_branch > 1) {
539 dbg_hid("alternative usage ignored\n");
540 return 0;
541 }
542
543 return hid_add_usage(parser, data, item->size);
544
545 case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:
546
547 if (parser->local.delimiter_branch > 1) {
548 dbg_hid("alternative usage ignored\n");
549 return 0;
550 }
551
552 parser->local.usage_minimum = data;
553 return 0;
554
555 case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:
556
557 if (parser->local.delimiter_branch > 1) {
558 dbg_hid("alternative usage ignored\n");
559 return 0;
560 }
561
562 count = data - parser->local.usage_minimum;
563 if (count + parser->local.usage_index >= HID_MAX_USAGES) {
564 /*
565 * We do not warn if the name is not set, we are
566 * actually pre-scanning the device.
567 */
568 if (dev_name(&parser->device->dev))
569 hid_warn(parser->device,
570 "ignoring exceeding usage max\n");
571 data = HID_MAX_USAGES - parser->local.usage_index +
572 parser->local.usage_minimum - 1;
573 if (data <= 0) {
574 hid_err(parser->device,
575 "no more usage index available\n");
576 return -1;
577 }
578 }
579
580 for (n = parser->local.usage_minimum; n <= data; n++)
581 if (hid_add_usage(parser, n, item->size)) {
582 dbg_hid("hid_add_usage failed\n");
583 return -1;
584 }
585 return 0;
586
587 default:
588
589 dbg_hid("unknown local item tag 0x%x\n", item->tag);
590 return 0;
591 }
592 return 0;
593}
594
595/*
596 * Concatenate Usage Pages into Usages where relevant:
597 * As per specification, 6.2.2.8: "When the parser encounters a main item it
598 * concatenates the last declared Usage Page with a Usage to form a complete
599 * usage value."
600 */
601
602static void hid_concatenate_last_usage_page(struct hid_parser *parser)
603{
604 int i;
605 unsigned int usage_page;
606 unsigned int current_page;
607
608 if (!parser->local.usage_index)
609 return;
610
611 usage_page = parser->global.usage_page;
612
613 /*
614 * Concatenate usage page again only if last declared Usage Page
615 * has not been already used in previous usages concatenation
616 */
617 for (i = parser->local.usage_index - 1; i >= 0; i--) {
618 if (parser->local.usage_size[i] > 2)
619 /* Ignore extended usages */
620 continue;
621
622 current_page = parser->local.usage[i] >> 16;
623 if (current_page == usage_page)
624 break;
625
626 complete_usage(parser, i);
627 }
628}
629
630/*
631 * Process a main item.
632 */
633
634static int hid_parser_main(struct hid_parser *parser, struct hid_item *item)
635{
636 __u32 data;
637 int ret;
638
639 hid_concatenate_last_usage_page(parser);
640
641 data = item_udata(item);
642
643 switch (item->tag) {
644 case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION:
645 ret = open_collection(parser, data & 0xff);
646 break;
647 case HID_MAIN_ITEM_TAG_END_COLLECTION:
648 ret = close_collection(parser);
649 break;
650 case HID_MAIN_ITEM_TAG_INPUT:
651 ret = hid_add_field(parser, HID_INPUT_REPORT, data);
652 break;
653 case HID_MAIN_ITEM_TAG_OUTPUT:
654 ret = hid_add_field(parser, HID_OUTPUT_REPORT, data);
655 break;
656 case HID_MAIN_ITEM_TAG_FEATURE:
657 ret = hid_add_field(parser, HID_FEATURE_REPORT, data);
658 break;
659 default:
660 hid_warn(parser->device, "unknown main item tag 0x%x\n", item->tag);
661 ret = 0;
662 }
663
664 memset(&parser->local, 0, sizeof(parser->local)); /* Reset the local parser environment */
665
666 return ret;
667}
668
669/*
670 * Process a reserved item.
671 */
672
673static int hid_parser_reserved(struct hid_parser *parser, struct hid_item *item)
674{
675 dbg_hid("reserved item type, tag 0x%x\n", item->tag);
676 return 0;
677}
678
679/*
680 * Free a report and all registered fields. The field->usage and
681 * field->value table's are allocated behind the field, so we need
682 * only to free(field) itself.
683 */
684
685static void hid_free_report(struct hid_report *report)
686{
687 unsigned n;
688
689 kfree(report->field_entries);
690
691 for (n = 0; n < report->maxfield; n++)
692 kvfree(report->field[n]);
693 kfree(report);
694}
695
696/*
697 * Close report. This function returns the device
698 * state to the point prior to hid_open_report().
699 */
700static void hid_close_report(struct hid_device *device)
701{
702 unsigned i, j;
703
704 for (i = 0; i < HID_REPORT_TYPES; i++) {
705 struct hid_report_enum *report_enum = device->report_enum + i;
706
707 for (j = 0; j < HID_MAX_IDS; j++) {
708 struct hid_report *report = report_enum->report_id_hash[j];
709 if (report)
710 hid_free_report(report);
711 }
712 memset(report_enum, 0, sizeof(*report_enum));
713 INIT_LIST_HEAD(&report_enum->report_list);
714 }
715
716 /*
717 * If the HID driver had a rdesc_fixup() callback, dev->rdesc
718 * will be allocated by hid-core and needs to be freed.
719 * Otherwise, it is either equal to dev_rdesc or bpf_rdesc, in
720 * which cases it'll be freed later on device removal or destroy.
721 */
722 if (device->rdesc != device->dev_rdesc && device->rdesc != device->bpf_rdesc)
723 kfree(device->rdesc);
724 device->rdesc = NULL;
725 device->rsize = 0;
726
727 kfree(device->collection);
728 device->collection = NULL;
729 device->collection_size = 0;
730 device->maxcollection = 0;
731 device->maxapplication = 0;
732
733 device->status &= ~HID_STAT_PARSED;
734}
735
736static inline void hid_free_bpf_rdesc(struct hid_device *hdev)
737{
738 /* bpf_rdesc is either equal to dev_rdesc or allocated by call_hid_bpf_rdesc_fixup() */
739 if (hdev->bpf_rdesc != hdev->dev_rdesc)
740 kfree(hdev->bpf_rdesc);
741 hdev->bpf_rdesc = NULL;
742}
743
744/*
745 * Free a device structure, all reports, and all fields.
746 */
747
748void hiddev_free(struct kref *ref)
749{
750 struct hid_device *hid = container_of(ref, struct hid_device, ref);
751
752 hid_close_report(hid);
753 hid_free_bpf_rdesc(hid);
754 kfree(hid->dev_rdesc);
755 kfree(hid);
756}
757
758static void hid_device_release(struct device *dev)
759{
760 struct hid_device *hid = to_hid_device(dev);
761
762 kref_put(&hid->ref, hiddev_free);
763}
764
765/*
766 * Fetch a report description item from the data stream. We support long
767 * items, though they are not used yet.
768 */
769
770static const u8 *fetch_item(const __u8 *start, const __u8 *end, struct hid_item *item)
771{
772 u8 b;
773
774 if ((end - start) <= 0)
775 return NULL;
776
777 b = *start++;
778
779 item->type = (b >> 2) & 3;
780 item->tag = (b >> 4) & 15;
781
782 if (item->tag == HID_ITEM_TAG_LONG) {
783
784 item->format = HID_ITEM_FORMAT_LONG;
785
786 if ((end - start) < 2)
787 return NULL;
788
789 item->size = *start++;
790 item->tag = *start++;
791
792 if ((end - start) < item->size)
793 return NULL;
794
795 item->data.longdata = start;
796 start += item->size;
797 return start;
798 }
799
800 item->format = HID_ITEM_FORMAT_SHORT;
801 item->size = BIT(b & 3) >> 1; /* 0, 1, 2, 3 -> 0, 1, 2, 4 */
802
803 if (end - start < item->size)
804 return NULL;
805
806 switch (item->size) {
807 case 0:
808 break;
809
810 case 1:
811 item->data.u8 = *start;
812 break;
813
814 case 2:
815 item->data.u16 = get_unaligned_le16(start);
816 break;
817
818 case 4:
819 item->data.u32 = get_unaligned_le32(start);
820 break;
821 }
822
823 return start + item->size;
824}
825
826static void hid_scan_input_usage(struct hid_parser *parser, u32 usage)
827{
828 struct hid_device *hid = parser->device;
829
830 if (usage == HID_DG_CONTACTID)
831 hid->group = HID_GROUP_MULTITOUCH;
832}
833
834static void hid_scan_feature_usage(struct hid_parser *parser, u32 usage)
835{
836 if (usage == 0xff0000c5 && parser->global.report_count == 256 &&
837 parser->global.report_size == 8)
838 parser->scan_flags |= HID_SCAN_FLAG_MT_WIN_8;
839
840 if (usage == 0xff0000c6 && parser->global.report_count == 1 &&
841 parser->global.report_size == 8)
842 parser->scan_flags |= HID_SCAN_FLAG_MT_WIN_8;
843}
844
845static void hid_scan_collection(struct hid_parser *parser, unsigned type)
846{
847 struct hid_device *hid = parser->device;
848 int i;
849
850 if (((parser->global.usage_page << 16) == HID_UP_SENSOR) &&
851 (type == HID_COLLECTION_PHYSICAL ||
852 type == HID_COLLECTION_APPLICATION))
853 hid->group = HID_GROUP_SENSOR_HUB;
854
855 if (hid->vendor == USB_VENDOR_ID_MICROSOFT &&
856 hid->product == USB_DEVICE_ID_MS_POWER_COVER &&
857 hid->group == HID_GROUP_MULTITOUCH)
858 hid->group = HID_GROUP_GENERIC;
859
860 if ((parser->global.usage_page << 16) == HID_UP_GENDESK)
861 for (i = 0; i < parser->local.usage_index; i++)
862 if (parser->local.usage[i] == HID_GD_POINTER)
863 parser->scan_flags |= HID_SCAN_FLAG_GD_POINTER;
864
865 if ((parser->global.usage_page << 16) >= HID_UP_MSVENDOR)
866 parser->scan_flags |= HID_SCAN_FLAG_VENDOR_SPECIFIC;
867
868 if ((parser->global.usage_page << 16) == HID_UP_GOOGLEVENDOR)
869 for (i = 0; i < parser->local.usage_index; i++)
870 if (parser->local.usage[i] ==
871 (HID_UP_GOOGLEVENDOR | 0x0001))
872 parser->device->group =
873 HID_GROUP_VIVALDI;
874}
875
876static int hid_scan_main(struct hid_parser *parser, struct hid_item *item)
877{
878 __u32 data;
879 int i;
880
881 hid_concatenate_last_usage_page(parser);
882
883 data = item_udata(item);
884
885 switch (item->tag) {
886 case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION:
887 hid_scan_collection(parser, data & 0xff);
888 break;
889 case HID_MAIN_ITEM_TAG_END_COLLECTION:
890 break;
891 case HID_MAIN_ITEM_TAG_INPUT:
892 /* ignore constant inputs, they will be ignored by hid-input */
893 if (data & HID_MAIN_ITEM_CONSTANT)
894 break;
895 for (i = 0; i < parser->local.usage_index; i++)
896 hid_scan_input_usage(parser, parser->local.usage[i]);
897 break;
898 case HID_MAIN_ITEM_TAG_OUTPUT:
899 break;
900 case HID_MAIN_ITEM_TAG_FEATURE:
901 for (i = 0; i < parser->local.usage_index; i++)
902 hid_scan_feature_usage(parser, parser->local.usage[i]);
903 break;
904 }
905
906 /* Reset the local parser environment */
907 memset(&parser->local, 0, sizeof(parser->local));
908
909 return 0;
910}
911
912/*
913 * Scan a report descriptor before the device is added to the bus.
914 * Sets device groups and other properties that determine what driver
915 * to load.
916 */
917static int hid_scan_report(struct hid_device *hid)
918{
919 struct hid_parser *parser;
920 struct hid_item item;
921 const __u8 *start = hid->dev_rdesc;
922 const __u8 *end = start + hid->dev_rsize;
923 static int (*dispatch_type[])(struct hid_parser *parser,
924 struct hid_item *item) = {
925 hid_scan_main,
926 hid_parser_global,
927 hid_parser_local,
928 hid_parser_reserved
929 };
930
931 parser = vzalloc(sizeof(struct hid_parser));
932 if (!parser)
933 return -ENOMEM;
934
935 parser->device = hid;
936 hid->group = HID_GROUP_GENERIC;
937
938 /*
939 * The parsing is simpler than the one in hid_open_report() as we should
940 * be robust against hid errors. Those errors will be raised by
941 * hid_open_report() anyway.
942 */
943 while ((start = fetch_item(start, end, &item)) != NULL)
944 dispatch_type[item.type](parser, &item);
945
946 /*
947 * Handle special flags set during scanning.
948 */
949 if ((parser->scan_flags & HID_SCAN_FLAG_MT_WIN_8) &&
950 (hid->group == HID_GROUP_MULTITOUCH))
951 hid->group = HID_GROUP_MULTITOUCH_WIN_8;
952
953 /*
954 * Vendor specific handlings
955 */
956 switch (hid->vendor) {
957 case USB_VENDOR_ID_WACOM:
958 hid->group = HID_GROUP_WACOM;
959 break;
960 case USB_VENDOR_ID_SYNAPTICS:
961 if (hid->group == HID_GROUP_GENERIC)
962 if ((parser->scan_flags & HID_SCAN_FLAG_VENDOR_SPECIFIC)
963 && (parser->scan_flags & HID_SCAN_FLAG_GD_POINTER))
964 /*
965 * hid-rmi should take care of them,
966 * not hid-generic
967 */
968 hid->group = HID_GROUP_RMI;
969 break;
970 }
971
972 kfree(parser->collection_stack);
973 vfree(parser);
974 return 0;
975}
976
977/**
978 * hid_parse_report - parse device report
979 *
980 * @hid: hid device
981 * @start: report start
982 * @size: report size
983 *
984 * Allocate the device report as read by the bus driver. This function should
985 * only be called from parse() in ll drivers.
986 */
987int hid_parse_report(struct hid_device *hid, const __u8 *start, unsigned size)
988{
989 hid->dev_rdesc = kmemdup(start, size, GFP_KERNEL);
990 if (!hid->dev_rdesc)
991 return -ENOMEM;
992 hid->dev_rsize = size;
993 return 0;
994}
995EXPORT_SYMBOL_GPL(hid_parse_report);
996
997static const char * const hid_report_names[] = {
998 "HID_INPUT_REPORT",
999 "HID_OUTPUT_REPORT",
1000 "HID_FEATURE_REPORT",
1001};
1002/**
1003 * hid_validate_values - validate existing device report's value indexes
1004 *
1005 * @hid: hid device
1006 * @type: which report type to examine
1007 * @id: which report ID to examine (0 for first)
1008 * @field_index: which report field to examine
1009 * @report_counts: expected number of values
1010 *
1011 * Validate the number of values in a given field of a given report, after
1012 * parsing.
1013 */
1014struct hid_report *hid_validate_values(struct hid_device *hid,
1015 enum hid_report_type type, unsigned int id,
1016 unsigned int field_index,
1017 unsigned int report_counts)
1018{
1019 struct hid_report *report;
1020
1021 if (type > HID_FEATURE_REPORT) {
1022 hid_err(hid, "invalid HID report type %u\n", type);
1023 return NULL;
1024 }
1025
1026 if (id >= HID_MAX_IDS) {
1027 hid_err(hid, "invalid HID report id %u\n", id);
1028 return NULL;
1029 }
1030
1031 /*
1032 * Explicitly not using hid_get_report() here since it depends on
1033 * ->numbered being checked, which may not always be the case when
1034 * drivers go to access report values.
1035 */
1036 if (id == 0) {
1037 /*
1038 * Validating on id 0 means we should examine the first
1039 * report in the list.
1040 */
1041 report = list_first_entry_or_null(
1042 &hid->report_enum[type].report_list,
1043 struct hid_report, list);
1044 } else {
1045 report = hid->report_enum[type].report_id_hash[id];
1046 }
1047 if (!report) {
1048 hid_err(hid, "missing %s %u\n", hid_report_names[type], id);
1049 return NULL;
1050 }
1051 if (report->maxfield <= field_index) {
1052 hid_err(hid, "not enough fields in %s %u\n",
1053 hid_report_names[type], id);
1054 return NULL;
1055 }
1056 if (report->field[field_index]->report_count < report_counts) {
1057 hid_err(hid, "not enough values in %s %u field %u\n",
1058 hid_report_names[type], id, field_index);
1059 return NULL;
1060 }
1061 return report;
1062}
1063EXPORT_SYMBOL_GPL(hid_validate_values);
1064
1065static int hid_calculate_multiplier(struct hid_device *hid,
1066 struct hid_field *multiplier)
1067{
1068 int m;
1069 __s32 v = *multiplier->value;
1070 __s32 lmin = multiplier->logical_minimum;
1071 __s32 lmax = multiplier->logical_maximum;
1072 __s32 pmin = multiplier->physical_minimum;
1073 __s32 pmax = multiplier->physical_maximum;
1074
1075 /*
1076 * "Because OS implementations will generally divide the control's
1077 * reported count by the Effective Resolution Multiplier, designers
1078 * should take care not to establish a potential Effective
1079 * Resolution Multiplier of zero."
1080 * HID Usage Table, v1.12, Section 4.3.1, p31
1081 */
1082 if (lmax - lmin == 0)
1083 return 1;
1084 /*
1085 * Handling the unit exponent is left as an exercise to whoever
1086 * finds a device where that exponent is not 0.
1087 */
1088 m = ((v - lmin)/(lmax - lmin) * (pmax - pmin) + pmin);
1089 if (unlikely(multiplier->unit_exponent != 0)) {
1090 hid_warn(hid,
1091 "unsupported Resolution Multiplier unit exponent %d\n",
1092 multiplier->unit_exponent);
1093 }
1094
1095 /* There are no devices with an effective multiplier > 255 */
1096 if (unlikely(m == 0 || m > 255 || m < -255)) {
1097 hid_warn(hid, "unsupported Resolution Multiplier %d\n", m);
1098 m = 1;
1099 }
1100
1101 return m;
1102}
1103
1104static void hid_apply_multiplier_to_field(struct hid_device *hid,
1105 struct hid_field *field,
1106 struct hid_collection *multiplier_collection,
1107 int effective_multiplier)
1108{
1109 struct hid_collection *collection;
1110 struct hid_usage *usage;
1111 int i;
1112
1113 /*
1114 * If multiplier_collection is NULL, the multiplier applies
1115 * to all fields in the report.
1116 * Otherwise, it is the Logical Collection the multiplier applies to
1117 * but our field may be in a subcollection of that collection.
1118 */
1119 for (i = 0; i < field->maxusage; i++) {
1120 usage = &field->usage[i];
1121
1122 collection = &hid->collection[usage->collection_index];
1123 while (collection->parent_idx != -1 &&
1124 collection != multiplier_collection)
1125 collection = &hid->collection[collection->parent_idx];
1126
1127 if (collection->parent_idx != -1 ||
1128 multiplier_collection == NULL)
1129 usage->resolution_multiplier = effective_multiplier;
1130
1131 }
1132}
1133
1134static void hid_apply_multiplier(struct hid_device *hid,
1135 struct hid_field *multiplier)
1136{
1137 struct hid_report_enum *rep_enum;
1138 struct hid_report *rep;
1139 struct hid_field *field;
1140 struct hid_collection *multiplier_collection;
1141 int effective_multiplier;
1142 int i;
1143
1144 /*
1145 * "The Resolution Multiplier control must be contained in the same
1146 * Logical Collection as the control(s) to which it is to be applied.
1147 * If no Resolution Multiplier is defined, then the Resolution
1148 * Multiplier defaults to 1. If more than one control exists in a
1149 * Logical Collection, the Resolution Multiplier is associated with
1150 * all controls in the collection. If no Logical Collection is
1151 * defined, the Resolution Multiplier is associated with all
1152 * controls in the report."
1153 * HID Usage Table, v1.12, Section 4.3.1, p30
1154 *
1155 * Thus, search from the current collection upwards until we find a
1156 * logical collection. Then search all fields for that same parent
1157 * collection. Those are the fields the multiplier applies to.
1158 *
1159 * If we have more than one multiplier, it will overwrite the
1160 * applicable fields later.
1161 */
1162 multiplier_collection = &hid->collection[multiplier->usage->collection_index];
1163 while (multiplier_collection->parent_idx != -1 &&
1164 multiplier_collection->type != HID_COLLECTION_LOGICAL)
1165 multiplier_collection = &hid->collection[multiplier_collection->parent_idx];
1166 if (multiplier_collection->type != HID_COLLECTION_LOGICAL)
1167 multiplier_collection = NULL;
1168
1169 effective_multiplier = hid_calculate_multiplier(hid, multiplier);
1170
1171 rep_enum = &hid->report_enum[HID_INPUT_REPORT];
1172 list_for_each_entry(rep, &rep_enum->report_list, list) {
1173 for (i = 0; i < rep->maxfield; i++) {
1174 field = rep->field[i];
1175 hid_apply_multiplier_to_field(hid, field,
1176 multiplier_collection,
1177 effective_multiplier);
1178 }
1179 }
1180}
1181
1182/*
1183 * hid_setup_resolution_multiplier - set up all resolution multipliers
1184 *
1185 * @device: hid device
1186 *
1187 * Search for all Resolution Multiplier Feature Reports and apply their
1188 * value to all matching Input items. This only updates the internal struct
1189 * fields.
1190 *
1191 * The Resolution Multiplier is applied by the hardware. If the multiplier
1192 * is anything other than 1, the hardware will send pre-multiplied events
1193 * so that the same physical interaction generates an accumulated
1194 * accumulated_value = value * * multiplier
1195 * This may be achieved by sending
1196 * - "value * multiplier" for each event, or
1197 * - "value" but "multiplier" times as frequently, or
1198 * - a combination of the above
1199 * The only guarantee is that the same physical interaction always generates
1200 * an accumulated 'value * multiplier'.
1201 *
1202 * This function must be called before any event processing and after
1203 * any SetRequest to the Resolution Multiplier.
1204 */
1205void hid_setup_resolution_multiplier(struct hid_device *hid)
1206{
1207 struct hid_report_enum *rep_enum;
1208 struct hid_report *rep;
1209 struct hid_usage *usage;
1210 int i, j;
1211
1212 rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1213 list_for_each_entry(rep, &rep_enum->report_list, list) {
1214 for (i = 0; i < rep->maxfield; i++) {
1215 /* Ignore if report count is out of bounds. */
1216 if (rep->field[i]->report_count < 1)
1217 continue;
1218
1219 for (j = 0; j < rep->field[i]->maxusage; j++) {
1220 usage = &rep->field[i]->usage[j];
1221 if (usage->hid == HID_GD_RESOLUTION_MULTIPLIER)
1222 hid_apply_multiplier(hid,
1223 rep->field[i]);
1224 }
1225 }
1226 }
1227}
1228EXPORT_SYMBOL_GPL(hid_setup_resolution_multiplier);
1229
1230/**
1231 * hid_open_report - open a driver-specific device report
1232 *
1233 * @device: hid device
1234 *
1235 * Parse a report description into a hid_device structure. Reports are
1236 * enumerated, fields are attached to these reports.
1237 * 0 returned on success, otherwise nonzero error value.
1238 *
1239 * This function (or the equivalent hid_parse() macro) should only be
1240 * called from probe() in drivers, before starting the device.
1241 */
1242int hid_open_report(struct hid_device *device)
1243{
1244 struct hid_parser *parser;
1245 struct hid_item item;
1246 unsigned int size;
1247 const __u8 *start;
1248 const __u8 *end;
1249 const __u8 *next;
1250 int ret;
1251 int i;
1252 static int (*dispatch_type[])(struct hid_parser *parser,
1253 struct hid_item *item) = {
1254 hid_parser_main,
1255 hid_parser_global,
1256 hid_parser_local,
1257 hid_parser_reserved
1258 };
1259
1260 if (WARN_ON(device->status & HID_STAT_PARSED))
1261 return -EBUSY;
1262
1263 start = device->bpf_rdesc;
1264 if (WARN_ON(!start))
1265 return -ENODEV;
1266 size = device->bpf_rsize;
1267
1268 if (device->driver->report_fixup) {
1269 /*
1270 * device->driver->report_fixup() needs to work
1271 * on a copy of our report descriptor so it can
1272 * change it.
1273 */
1274 __u8 *buf = kmemdup(start, size, GFP_KERNEL);
1275
1276 if (buf == NULL)
1277 return -ENOMEM;
1278
1279 start = device->driver->report_fixup(device, buf, &size);
1280
1281 /*
1282 * The second kmemdup is required in case report_fixup() returns
1283 * a static read-only memory, but we have no idea if that memory
1284 * needs to be cleaned up or not at the end.
1285 */
1286 start = kmemdup(start, size, GFP_KERNEL);
1287 kfree(buf);
1288 if (start == NULL)
1289 return -ENOMEM;
1290 }
1291
1292 device->rdesc = start;
1293 device->rsize = size;
1294
1295 parser = vzalloc(sizeof(struct hid_parser));
1296 if (!parser) {
1297 ret = -ENOMEM;
1298 goto alloc_err;
1299 }
1300
1301 parser->device = device;
1302
1303 end = start + size;
1304
1305 device->collection = kcalloc(HID_DEFAULT_NUM_COLLECTIONS,
1306 sizeof(struct hid_collection), GFP_KERNEL);
1307 if (!device->collection) {
1308 ret = -ENOMEM;
1309 goto err;
1310 }
1311 device->collection_size = HID_DEFAULT_NUM_COLLECTIONS;
1312 for (i = 0; i < HID_DEFAULT_NUM_COLLECTIONS; i++)
1313 device->collection[i].parent_idx = -1;
1314
1315 ret = -EINVAL;
1316 while ((next = fetch_item(start, end, &item)) != NULL) {
1317 start = next;
1318
1319 if (item.format != HID_ITEM_FORMAT_SHORT) {
1320 hid_err(device, "unexpected long global item\n");
1321 goto err;
1322 }
1323
1324 if (dispatch_type[item.type](parser, &item)) {
1325 hid_err(device, "item %u %u %u %u parsing failed\n",
1326 item.format, (unsigned)item.size,
1327 (unsigned)item.type, (unsigned)item.tag);
1328 goto err;
1329 }
1330
1331 if (start == end) {
1332 if (parser->collection_stack_ptr) {
1333 hid_err(device, "unbalanced collection at end of report description\n");
1334 goto err;
1335 }
1336 if (parser->local.delimiter_depth) {
1337 hid_err(device, "unbalanced delimiter at end of report description\n");
1338 goto err;
1339 }
1340
1341 /*
1342 * fetch initial values in case the device's
1343 * default multiplier isn't the recommended 1
1344 */
1345 hid_setup_resolution_multiplier(device);
1346
1347 kfree(parser->collection_stack);
1348 vfree(parser);
1349 device->status |= HID_STAT_PARSED;
1350
1351 return 0;
1352 }
1353 }
1354
1355 hid_err(device, "item fetching failed at offset %u/%u\n",
1356 size - (unsigned int)(end - start), size);
1357err:
1358 kfree(parser->collection_stack);
1359alloc_err:
1360 vfree(parser);
1361 hid_close_report(device);
1362 return ret;
1363}
1364EXPORT_SYMBOL_GPL(hid_open_report);
1365
1366/*
1367 * Extract/implement a data field from/to a little endian report (bit array).
1368 *
1369 * Code sort-of follows HID spec:
1370 * http://www.usb.org/developers/hidpage/HID1_11.pdf
1371 *
1372 * While the USB HID spec allows unlimited length bit fields in "report
1373 * descriptors", most devices never use more than 16 bits.
1374 * One model of UPS is claimed to report "LINEV" as a 32-bit field.
1375 * Search linux-kernel and linux-usb-devel archives for "hid-core extract".
1376 */
1377
1378static u32 __extract(u8 *report, unsigned offset, int n)
1379{
1380 unsigned int idx = offset / 8;
1381 unsigned int bit_nr = 0;
1382 unsigned int bit_shift = offset % 8;
1383 int bits_to_copy = 8 - bit_shift;
1384 u32 value = 0;
1385 u32 mask = n < 32 ? (1U << n) - 1 : ~0U;
1386
1387 while (n > 0) {
1388 value |= ((u32)report[idx] >> bit_shift) << bit_nr;
1389 n -= bits_to_copy;
1390 bit_nr += bits_to_copy;
1391 bits_to_copy = 8;
1392 bit_shift = 0;
1393 idx++;
1394 }
1395
1396 return value & mask;
1397}
1398
1399u32 hid_field_extract(const struct hid_device *hid, u8 *report,
1400 unsigned offset, unsigned n)
1401{
1402 if (n > 32) {
1403 hid_warn_once(hid, "%s() called with n (%d) > 32! (%s)\n",
1404 __func__, n, current->comm);
1405 n = 32;
1406 }
1407
1408 return __extract(report, offset, n);
1409}
1410EXPORT_SYMBOL_GPL(hid_field_extract);
1411
1412/*
1413 * "implement" : set bits in a little endian bit stream.
1414 * Same concepts as "extract" (see comments above).
1415 * The data mangled in the bit stream remains in little endian
1416 * order the whole time. It make more sense to talk about
1417 * endianness of register values by considering a register
1418 * a "cached" copy of the little endian bit stream.
1419 */
1420
1421static void __implement(u8 *report, unsigned offset, int n, u32 value)
1422{
1423 unsigned int idx = offset / 8;
1424 unsigned int bit_shift = offset % 8;
1425 int bits_to_set = 8 - bit_shift;
1426
1427 while (n - bits_to_set >= 0) {
1428 report[idx] &= ~(0xff << bit_shift);
1429 report[idx] |= value << bit_shift;
1430 value >>= bits_to_set;
1431 n -= bits_to_set;
1432 bits_to_set = 8;
1433 bit_shift = 0;
1434 idx++;
1435 }
1436
1437 /* last nibble */
1438 if (n) {
1439 u8 bit_mask = ((1U << n) - 1);
1440 report[idx] &= ~(bit_mask << bit_shift);
1441 report[idx] |= value << bit_shift;
1442 }
1443}
1444
1445static void implement(const struct hid_device *hid, u8 *report,
1446 unsigned offset, unsigned n, u32 value)
1447{
1448 if (unlikely(n > 32)) {
1449 hid_warn(hid, "%s() called with n (%d) > 32! (%s)\n",
1450 __func__, n, current->comm);
1451 n = 32;
1452 } else if (n < 32) {
1453 u32 m = (1U << n) - 1;
1454
1455 if (unlikely(value > m)) {
1456 hid_warn(hid,
1457 "%s() called with too large value %d (n: %d)! (%s)\n",
1458 __func__, value, n, current->comm);
1459 value &= m;
1460 }
1461 }
1462
1463 __implement(report, offset, n, value);
1464}
1465
1466/*
1467 * Search an array for a value.
1468 */
1469
1470static int search(__s32 *array, __s32 value, unsigned n)
1471{
1472 while (n--) {
1473 if (*array++ == value)
1474 return 0;
1475 }
1476 return -1;
1477}
1478
1479/**
1480 * hid_match_report - check if driver's raw_event should be called
1481 *
1482 * @hid: hid device
1483 * @report: hid report to match against
1484 *
1485 * compare hid->driver->report_table->report_type to report->type
1486 */
1487static int hid_match_report(struct hid_device *hid, struct hid_report *report)
1488{
1489 const struct hid_report_id *id = hid->driver->report_table;
1490
1491 if (!id) /* NULL means all */
1492 return 1;
1493
1494 for (; id->report_type != HID_TERMINATOR; id++)
1495 if (id->report_type == HID_ANY_ID ||
1496 id->report_type == report->type)
1497 return 1;
1498 return 0;
1499}
1500
1501/**
1502 * hid_match_usage - check if driver's event should be called
1503 *
1504 * @hid: hid device
1505 * @usage: usage to match against
1506 *
1507 * compare hid->driver->usage_table->usage_{type,code} to
1508 * usage->usage_{type,code}
1509 */
1510static int hid_match_usage(struct hid_device *hid, struct hid_usage *usage)
1511{
1512 const struct hid_usage_id *id = hid->driver->usage_table;
1513
1514 if (!id) /* NULL means all */
1515 return 1;
1516
1517 for (; id->usage_type != HID_ANY_ID - 1; id++)
1518 if ((id->usage_hid == HID_ANY_ID ||
1519 id->usage_hid == usage->hid) &&
1520 (id->usage_type == HID_ANY_ID ||
1521 id->usage_type == usage->type) &&
1522 (id->usage_code == HID_ANY_ID ||
1523 id->usage_code == usage->code))
1524 return 1;
1525 return 0;
1526}
1527
1528static void hid_process_event(struct hid_device *hid, struct hid_field *field,
1529 struct hid_usage *usage, __s32 value, int interrupt)
1530{
1531 struct hid_driver *hdrv = hid->driver;
1532 int ret;
1533
1534 if (!list_empty(&hid->debug_list))
1535 hid_dump_input(hid, usage, value);
1536
1537 if (hdrv && hdrv->event && hid_match_usage(hid, usage)) {
1538 ret = hdrv->event(hid, field, usage, value);
1539 if (ret != 0) {
1540 if (ret < 0)
1541 hid_err(hid, "%s's event failed with %d\n",
1542 hdrv->name, ret);
1543 return;
1544 }
1545 }
1546
1547 if (hid->claimed & HID_CLAIMED_INPUT)
1548 hidinput_hid_event(hid, field, usage, value);
1549 if (hid->claimed & HID_CLAIMED_HIDDEV && interrupt && hid->hiddev_hid_event)
1550 hid->hiddev_hid_event(hid, field, usage, value);
1551}
1552
1553/*
1554 * Checks if the given value is valid within this field
1555 */
1556static inline int hid_array_value_is_valid(struct hid_field *field,
1557 __s32 value)
1558{
1559 __s32 min = field->logical_minimum;
1560
1561 /*
1562 * Value needs to be between logical min and max, and
1563 * (value - min) is used as an index in the usage array.
1564 * This array is of size field->maxusage
1565 */
1566 return value >= min &&
1567 value <= field->logical_maximum &&
1568 value - min < field->maxusage;
1569}
1570
1571/*
1572 * Fetch the field from the data. The field content is stored for next
1573 * report processing (we do differential reporting to the layer).
1574 */
1575static void hid_input_fetch_field(struct hid_device *hid,
1576 struct hid_field *field,
1577 __u8 *data)
1578{
1579 unsigned n;
1580 unsigned count = field->report_count;
1581 unsigned offset = field->report_offset;
1582 unsigned size = field->report_size;
1583 __s32 min = field->logical_minimum;
1584 __s32 *value;
1585
1586 value = field->new_value;
1587 memset(value, 0, count * sizeof(__s32));
1588 field->ignored = false;
1589
1590 for (n = 0; n < count; n++) {
1591
1592 value[n] = min < 0 ?
1593 snto32(hid_field_extract(hid, data, offset + n * size,
1594 size), size) :
1595 hid_field_extract(hid, data, offset + n * size, size);
1596
1597 /* Ignore report if ErrorRollOver */
1598 if (!(field->flags & HID_MAIN_ITEM_VARIABLE) &&
1599 hid_array_value_is_valid(field, value[n]) &&
1600 field->usage[value[n] - min].hid == HID_UP_KEYBOARD + 1) {
1601 field->ignored = true;
1602 return;
1603 }
1604 }
1605}
1606
1607/*
1608 * Process a received variable field.
1609 */
1610
1611static void hid_input_var_field(struct hid_device *hid,
1612 struct hid_field *field,
1613 int interrupt)
1614{
1615 unsigned int count = field->report_count;
1616 __s32 *value = field->new_value;
1617 unsigned int n;
1618
1619 for (n = 0; n < count; n++)
1620 hid_process_event(hid,
1621 field,
1622 &field->usage[n],
1623 value[n],
1624 interrupt);
1625
1626 memcpy(field->value, value, count * sizeof(__s32));
1627}
1628
1629/*
1630 * Process a received array field. The field content is stored for
1631 * next report processing (we do differential reporting to the layer).
1632 */
1633
1634static void hid_input_array_field(struct hid_device *hid,
1635 struct hid_field *field,
1636 int interrupt)
1637{
1638 unsigned int n;
1639 unsigned int count = field->report_count;
1640 __s32 min = field->logical_minimum;
1641 __s32 *value;
1642
1643 value = field->new_value;
1644
1645 /* ErrorRollOver */
1646 if (field->ignored)
1647 return;
1648
1649 for (n = 0; n < count; n++) {
1650 if (hid_array_value_is_valid(field, field->value[n]) &&
1651 search(value, field->value[n], count))
1652 hid_process_event(hid,
1653 field,
1654 &field->usage[field->value[n] - min],
1655 0,
1656 interrupt);
1657
1658 if (hid_array_value_is_valid(field, value[n]) &&
1659 search(field->value, value[n], count))
1660 hid_process_event(hid,
1661 field,
1662 &field->usage[value[n] - min],
1663 1,
1664 interrupt);
1665 }
1666
1667 memcpy(field->value, value, count * sizeof(__s32));
1668}
1669
1670/*
1671 * Analyse a received report, and fetch the data from it. The field
1672 * content is stored for next report processing (we do differential
1673 * reporting to the layer).
1674 */
1675static void hid_process_report(struct hid_device *hid,
1676 struct hid_report *report,
1677 __u8 *data,
1678 int interrupt)
1679{
1680 unsigned int a;
1681 struct hid_field_entry *entry;
1682 struct hid_field *field;
1683
1684 /* first retrieve all incoming values in data */
1685 for (a = 0; a < report->maxfield; a++)
1686 hid_input_fetch_field(hid, report->field[a], data);
1687
1688 if (!list_empty(&report->field_entry_list)) {
1689 /* INPUT_REPORT, we have a priority list of fields */
1690 list_for_each_entry(entry,
1691 &report->field_entry_list,
1692 list) {
1693 field = entry->field;
1694
1695 if (field->flags & HID_MAIN_ITEM_VARIABLE)
1696 hid_process_event(hid,
1697 field,
1698 &field->usage[entry->index],
1699 field->new_value[entry->index],
1700 interrupt);
1701 else
1702 hid_input_array_field(hid, field, interrupt);
1703 }
1704
1705 /* we need to do the memcpy at the end for var items */
1706 for (a = 0; a < report->maxfield; a++) {
1707 field = report->field[a];
1708
1709 if (field->flags & HID_MAIN_ITEM_VARIABLE)
1710 memcpy(field->value, field->new_value,
1711 field->report_count * sizeof(__s32));
1712 }
1713 } else {
1714 /* FEATURE_REPORT, regular processing */
1715 for (a = 0; a < report->maxfield; a++) {
1716 field = report->field[a];
1717
1718 if (field->flags & HID_MAIN_ITEM_VARIABLE)
1719 hid_input_var_field(hid, field, interrupt);
1720 else
1721 hid_input_array_field(hid, field, interrupt);
1722 }
1723 }
1724}
1725
1726/*
1727 * Insert a given usage_index in a field in the list
1728 * of processed usages in the report.
1729 *
1730 * The elements of lower priority score are processed
1731 * first.
1732 */
1733static void __hid_insert_field_entry(struct hid_device *hid,
1734 struct hid_report *report,
1735 struct hid_field_entry *entry,
1736 struct hid_field *field,
1737 unsigned int usage_index)
1738{
1739 struct hid_field_entry *next;
1740
1741 entry->field = field;
1742 entry->index = usage_index;
1743 entry->priority = field->usages_priorities[usage_index];
1744
1745 /* insert the element at the correct position */
1746 list_for_each_entry(next,
1747 &report->field_entry_list,
1748 list) {
1749 /*
1750 * the priority of our element is strictly higher
1751 * than the next one, insert it before
1752 */
1753 if (entry->priority > next->priority) {
1754 list_add_tail(&entry->list, &next->list);
1755 return;
1756 }
1757 }
1758
1759 /* lowest priority score: insert at the end */
1760 list_add_tail(&entry->list, &report->field_entry_list);
1761}
1762
1763static void hid_report_process_ordering(struct hid_device *hid,
1764 struct hid_report *report)
1765{
1766 struct hid_field *field;
1767 struct hid_field_entry *entries;
1768 unsigned int a, u, usages;
1769 unsigned int count = 0;
1770
1771 /* count the number of individual fields in the report */
1772 for (a = 0; a < report->maxfield; a++) {
1773 field = report->field[a];
1774
1775 if (field->flags & HID_MAIN_ITEM_VARIABLE)
1776 count += field->report_count;
1777 else
1778 count++;
1779 }
1780
1781 /* allocate the memory to process the fields */
1782 entries = kcalloc(count, sizeof(*entries), GFP_KERNEL);
1783 if (!entries)
1784 return;
1785
1786 report->field_entries = entries;
1787
1788 /*
1789 * walk through all fields in the report and
1790 * store them by priority order in report->field_entry_list
1791 *
1792 * - Var elements are individualized (field + usage_index)
1793 * - Arrays are taken as one, we can not chose an order for them
1794 */
1795 usages = 0;
1796 for (a = 0; a < report->maxfield; a++) {
1797 field = report->field[a];
1798
1799 if (field->flags & HID_MAIN_ITEM_VARIABLE) {
1800 for (u = 0; u < field->report_count; u++) {
1801 __hid_insert_field_entry(hid, report,
1802 &entries[usages],
1803 field, u);
1804 usages++;
1805 }
1806 } else {
1807 __hid_insert_field_entry(hid, report, &entries[usages],
1808 field, 0);
1809 usages++;
1810 }
1811 }
1812}
1813
1814static void hid_process_ordering(struct hid_device *hid)
1815{
1816 struct hid_report *report;
1817 struct hid_report_enum *report_enum = &hid->report_enum[HID_INPUT_REPORT];
1818
1819 list_for_each_entry(report, &report_enum->report_list, list)
1820 hid_report_process_ordering(hid, report);
1821}
1822
1823/*
1824 * Output the field into the report.
1825 */
1826
1827static void hid_output_field(const struct hid_device *hid,
1828 struct hid_field *field, __u8 *data)
1829{
1830 unsigned count = field->report_count;
1831 unsigned offset = field->report_offset;
1832 unsigned size = field->report_size;
1833 unsigned n;
1834
1835 for (n = 0; n < count; n++) {
1836 if (field->logical_minimum < 0) /* signed values */
1837 implement(hid, data, offset + n * size, size,
1838 s32ton(field->value[n], size));
1839 else /* unsigned values */
1840 implement(hid, data, offset + n * size, size,
1841 field->value[n]);
1842 }
1843}
1844
1845/*
1846 * Compute the size of a report.
1847 */
1848static size_t hid_compute_report_size(struct hid_report *report)
1849{
1850 if (report->size)
1851 return ((report->size - 1) >> 3) + 1;
1852
1853 return 0;
1854}
1855
1856/*
1857 * Create a report. 'data' has to be allocated using
1858 * hid_alloc_report_buf() so that it has proper size.
1859 */
1860
1861void hid_output_report(struct hid_report *report, __u8 *data)
1862{
1863 unsigned n;
1864
1865 if (report->id > 0)
1866 *data++ = report->id;
1867
1868 memset(data, 0, hid_compute_report_size(report));
1869 for (n = 0; n < report->maxfield; n++)
1870 hid_output_field(report->device, report->field[n], data);
1871}
1872EXPORT_SYMBOL_GPL(hid_output_report);
1873
1874/*
1875 * Allocator for buffer that is going to be passed to hid_output_report()
1876 */
1877u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags)
1878{
1879 /*
1880 * 7 extra bytes are necessary to achieve proper functionality
1881 * of implement() working on 8 byte chunks
1882 */
1883
1884 u32 len = hid_report_len(report) + 7;
1885
1886 return kzalloc(len, flags);
1887}
1888EXPORT_SYMBOL_GPL(hid_alloc_report_buf);
1889
1890/*
1891 * Set a field value. The report this field belongs to has to be
1892 * created and transferred to the device, to set this value in the
1893 * device.
1894 */
1895
1896int hid_set_field(struct hid_field *field, unsigned offset, __s32 value)
1897{
1898 unsigned size;
1899
1900 if (!field)
1901 return -1;
1902
1903 size = field->report_size;
1904
1905 hid_dump_input(field->report->device, field->usage + offset, value);
1906
1907 if (offset >= field->report_count) {
1908 hid_err(field->report->device, "offset (%d) exceeds report_count (%d)\n",
1909 offset, field->report_count);
1910 return -1;
1911 }
1912 if (field->logical_minimum < 0) {
1913 if (value != snto32(s32ton(value, size), size)) {
1914 hid_err(field->report->device, "value %d is out of range\n", value);
1915 return -1;
1916 }
1917 }
1918 field->value[offset] = value;
1919 return 0;
1920}
1921EXPORT_SYMBOL_GPL(hid_set_field);
1922
1923struct hid_field *hid_find_field(struct hid_device *hdev, unsigned int report_type,
1924 unsigned int application, unsigned int usage)
1925{
1926 struct list_head *report_list = &hdev->report_enum[report_type].report_list;
1927 struct hid_report *report;
1928 int i, j;
1929
1930 list_for_each_entry(report, report_list, list) {
1931 if (report->application != application)
1932 continue;
1933
1934 for (i = 0; i < report->maxfield; i++) {
1935 struct hid_field *field = report->field[i];
1936
1937 for (j = 0; j < field->maxusage; j++) {
1938 if (field->usage[j].hid == usage)
1939 return field;
1940 }
1941 }
1942 }
1943
1944 return NULL;
1945}
1946EXPORT_SYMBOL_GPL(hid_find_field);
1947
1948static struct hid_report *hid_get_report(struct hid_report_enum *report_enum,
1949 const u8 *data)
1950{
1951 struct hid_report *report;
1952 unsigned int n = 0; /* Normally report number is 0 */
1953
1954 /* Device uses numbered reports, data[0] is report number */
1955 if (report_enum->numbered)
1956 n = *data;
1957
1958 report = report_enum->report_id_hash[n];
1959 if (report == NULL)
1960 dbg_hid("undefined report_id %u received\n", n);
1961
1962 return report;
1963}
1964
1965/*
1966 * Implement a generic .request() callback, using .raw_request()
1967 * DO NOT USE in hid drivers directly, but through hid_hw_request instead.
1968 */
1969int __hid_request(struct hid_device *hid, struct hid_report *report,
1970 enum hid_class_request reqtype)
1971{
1972 char *buf;
1973 int ret;
1974 u32 len;
1975
1976 buf = hid_alloc_report_buf(report, GFP_KERNEL);
1977 if (!buf)
1978 return -ENOMEM;
1979
1980 len = hid_report_len(report);
1981
1982 if (reqtype == HID_REQ_SET_REPORT)
1983 hid_output_report(report, buf);
1984
1985 ret = hid->ll_driver->raw_request(hid, report->id, buf, len,
1986 report->type, reqtype);
1987 if (ret < 0) {
1988 dbg_hid("unable to complete request: %d\n", ret);
1989 goto out;
1990 }
1991
1992 if (reqtype == HID_REQ_GET_REPORT)
1993 hid_input_report(hid, report->type, buf, ret, 0);
1994
1995 ret = 0;
1996
1997out:
1998 kfree(buf);
1999 return ret;
2000}
2001EXPORT_SYMBOL_GPL(__hid_request);
2002
2003int hid_report_raw_event(struct hid_device *hid, enum hid_report_type type, u8 *data, u32 size,
2004 int interrupt)
2005{
2006 struct hid_report_enum *report_enum = hid->report_enum + type;
2007 struct hid_report *report;
2008 struct hid_driver *hdrv;
2009 int max_buffer_size = HID_MAX_BUFFER_SIZE;
2010 u32 rsize, csize = size;
2011 u8 *cdata = data;
2012 int ret = 0;
2013
2014 report = hid_get_report(report_enum, data);
2015 if (!report)
2016 goto out;
2017
2018 if (report_enum->numbered) {
2019 cdata++;
2020 csize--;
2021 }
2022
2023 rsize = hid_compute_report_size(report);
2024
2025 if (hid->ll_driver->max_buffer_size)
2026 max_buffer_size = hid->ll_driver->max_buffer_size;
2027
2028 if (report_enum->numbered && rsize >= max_buffer_size)
2029 rsize = max_buffer_size - 1;
2030 else if (rsize > max_buffer_size)
2031 rsize = max_buffer_size;
2032
2033 if (csize < rsize) {
2034 dbg_hid("report %d is too short, (%d < %d)\n", report->id,
2035 csize, rsize);
2036 memset(cdata + csize, 0, rsize - csize);
2037 }
2038
2039 if ((hid->claimed & HID_CLAIMED_HIDDEV) && hid->hiddev_report_event)
2040 hid->hiddev_report_event(hid, report);
2041 if (hid->claimed & HID_CLAIMED_HIDRAW) {
2042 ret = hidraw_report_event(hid, data, size);
2043 if (ret)
2044 goto out;
2045 }
2046
2047 if (hid->claimed != HID_CLAIMED_HIDRAW && report->maxfield) {
2048 hid_process_report(hid, report, cdata, interrupt);
2049 hdrv = hid->driver;
2050 if (hdrv && hdrv->report)
2051 hdrv->report(hid, report);
2052 }
2053
2054 if (hid->claimed & HID_CLAIMED_INPUT)
2055 hidinput_report_event(hid, report);
2056out:
2057 return ret;
2058}
2059EXPORT_SYMBOL_GPL(hid_report_raw_event);
2060
2061
2062static int __hid_input_report(struct hid_device *hid, enum hid_report_type type,
2063 u8 *data, u32 size, int interrupt, u64 source, bool from_bpf,
2064 bool lock_already_taken)
2065{
2066 struct hid_report_enum *report_enum;
2067 struct hid_driver *hdrv;
2068 struct hid_report *report;
2069 int ret = 0;
2070
2071 if (!hid)
2072 return -ENODEV;
2073
2074 ret = down_trylock(&hid->driver_input_lock);
2075 if (lock_already_taken && !ret) {
2076 up(&hid->driver_input_lock);
2077 return -EINVAL;
2078 } else if (!lock_already_taken && ret) {
2079 return -EBUSY;
2080 }
2081
2082 if (!hid->driver) {
2083 ret = -ENODEV;
2084 goto unlock;
2085 }
2086 report_enum = hid->report_enum + type;
2087 hdrv = hid->driver;
2088
2089 data = dispatch_hid_bpf_device_event(hid, type, data, &size, interrupt, source, from_bpf);
2090 if (IS_ERR(data)) {
2091 ret = PTR_ERR(data);
2092 goto unlock;
2093 }
2094
2095 if (!size) {
2096 dbg_hid("empty report\n");
2097 ret = -1;
2098 goto unlock;
2099 }
2100
2101 /* Avoid unnecessary overhead if debugfs is disabled */
2102 if (!list_empty(&hid->debug_list))
2103 hid_dump_report(hid, type, data, size);
2104
2105 report = hid_get_report(report_enum, data);
2106
2107 if (!report) {
2108 ret = -1;
2109 goto unlock;
2110 }
2111
2112 if (hdrv && hdrv->raw_event && hid_match_report(hid, report)) {
2113 ret = hdrv->raw_event(hid, report, data, size);
2114 if (ret < 0)
2115 goto unlock;
2116 }
2117
2118 ret = hid_report_raw_event(hid, type, data, size, interrupt);
2119
2120unlock:
2121 if (!lock_already_taken)
2122 up(&hid->driver_input_lock);
2123 return ret;
2124}
2125
2126/**
2127 * hid_input_report - report data from lower layer (usb, bt...)
2128 *
2129 * @hid: hid device
2130 * @type: HID report type (HID_*_REPORT)
2131 * @data: report contents
2132 * @size: size of data parameter
2133 * @interrupt: distinguish between interrupt and control transfers
2134 *
2135 * This is data entry for lower layers.
2136 */
2137int hid_input_report(struct hid_device *hid, enum hid_report_type type, u8 *data, u32 size,
2138 int interrupt)
2139{
2140 return __hid_input_report(hid, type, data, size, interrupt, 0,
2141 false, /* from_bpf */
2142 false /* lock_already_taken */);
2143}
2144EXPORT_SYMBOL_GPL(hid_input_report);
2145
2146bool hid_match_one_id(const struct hid_device *hdev,
2147 const struct hid_device_id *id)
2148{
2149 return (id->bus == HID_BUS_ANY || id->bus == hdev->bus) &&
2150 (id->group == HID_GROUP_ANY || id->group == hdev->group) &&
2151 (id->vendor == HID_ANY_ID || id->vendor == hdev->vendor) &&
2152 (id->product == HID_ANY_ID || id->product == hdev->product);
2153}
2154
2155const struct hid_device_id *hid_match_id(const struct hid_device *hdev,
2156 const struct hid_device_id *id)
2157{
2158 for (; id->bus; id++)
2159 if (hid_match_one_id(hdev, id))
2160 return id;
2161
2162 return NULL;
2163}
2164EXPORT_SYMBOL_GPL(hid_match_id);
2165
2166static const struct hid_device_id hid_hiddev_list[] = {
2167 { HID_USB_DEVICE(USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS) },
2168 { HID_USB_DEVICE(USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS1) },
2169 { }
2170};
2171
2172static bool hid_hiddev(struct hid_device *hdev)
2173{
2174 return !!hid_match_id(hdev, hid_hiddev_list);
2175}
2176
2177
2178static ssize_t
2179read_report_descriptor(struct file *filp, struct kobject *kobj,
2180 struct bin_attribute *attr,
2181 char *buf, loff_t off, size_t count)
2182{
2183 struct device *dev = kobj_to_dev(kobj);
2184 struct hid_device *hdev = to_hid_device(dev);
2185
2186 if (off >= hdev->rsize)
2187 return 0;
2188
2189 if (off + count > hdev->rsize)
2190 count = hdev->rsize - off;
2191
2192 memcpy(buf, hdev->rdesc + off, count);
2193
2194 return count;
2195}
2196
2197static ssize_t
2198show_country(struct device *dev, struct device_attribute *attr,
2199 char *buf)
2200{
2201 struct hid_device *hdev = to_hid_device(dev);
2202
2203 return sprintf(buf, "%02x\n", hdev->country & 0xff);
2204}
2205
2206static struct bin_attribute dev_bin_attr_report_desc = {
2207 .attr = { .name = "report_descriptor", .mode = 0444 },
2208 .read = read_report_descriptor,
2209 .size = HID_MAX_DESCRIPTOR_SIZE,
2210};
2211
2212static const struct device_attribute dev_attr_country = {
2213 .attr = { .name = "country", .mode = 0444 },
2214 .show = show_country,
2215};
2216
2217int hid_connect(struct hid_device *hdev, unsigned int connect_mask)
2218{
2219 static const char *types[] = { "Device", "Pointer", "Mouse", "Device",
2220 "Joystick", "Gamepad", "Keyboard", "Keypad",
2221 "Multi-Axis Controller"
2222 };
2223 const char *type, *bus;
2224 char buf[64] = "";
2225 unsigned int i;
2226 int len;
2227 int ret;
2228
2229 ret = hid_bpf_connect_device(hdev);
2230 if (ret)
2231 return ret;
2232
2233 if (hdev->quirks & HID_QUIRK_HIDDEV_FORCE)
2234 connect_mask |= (HID_CONNECT_HIDDEV_FORCE | HID_CONNECT_HIDDEV);
2235 if (hdev->quirks & HID_QUIRK_HIDINPUT_FORCE)
2236 connect_mask |= HID_CONNECT_HIDINPUT_FORCE;
2237 if (hdev->bus != BUS_USB)
2238 connect_mask &= ~HID_CONNECT_HIDDEV;
2239 if (hid_hiddev(hdev))
2240 connect_mask |= HID_CONNECT_HIDDEV_FORCE;
2241
2242 if ((connect_mask & HID_CONNECT_HIDINPUT) && !hidinput_connect(hdev,
2243 connect_mask & HID_CONNECT_HIDINPUT_FORCE))
2244 hdev->claimed |= HID_CLAIMED_INPUT;
2245
2246 if ((connect_mask & HID_CONNECT_HIDDEV) && hdev->hiddev_connect &&
2247 !hdev->hiddev_connect(hdev,
2248 connect_mask & HID_CONNECT_HIDDEV_FORCE))
2249 hdev->claimed |= HID_CLAIMED_HIDDEV;
2250 if ((connect_mask & HID_CONNECT_HIDRAW) && !hidraw_connect(hdev))
2251 hdev->claimed |= HID_CLAIMED_HIDRAW;
2252
2253 if (connect_mask & HID_CONNECT_DRIVER)
2254 hdev->claimed |= HID_CLAIMED_DRIVER;
2255
2256 /* Drivers with the ->raw_event callback set are not required to connect
2257 * to any other listener. */
2258 if (!hdev->claimed && !hdev->driver->raw_event) {
2259 hid_err(hdev, "device has no listeners, quitting\n");
2260 return -ENODEV;
2261 }
2262
2263 hid_process_ordering(hdev);
2264
2265 if ((hdev->claimed & HID_CLAIMED_INPUT) &&
2266 (connect_mask & HID_CONNECT_FF) && hdev->ff_init)
2267 hdev->ff_init(hdev);
2268
2269 len = 0;
2270 if (hdev->claimed & HID_CLAIMED_INPUT)
2271 len += sprintf(buf + len, "input");
2272 if (hdev->claimed & HID_CLAIMED_HIDDEV)
2273 len += sprintf(buf + len, "%shiddev%d", len ? "," : "",
2274 ((struct hiddev *)hdev->hiddev)->minor);
2275 if (hdev->claimed & HID_CLAIMED_HIDRAW)
2276 len += sprintf(buf + len, "%shidraw%d", len ? "," : "",
2277 ((struct hidraw *)hdev->hidraw)->minor);
2278
2279 type = "Device";
2280 for (i = 0; i < hdev->maxcollection; i++) {
2281 struct hid_collection *col = &hdev->collection[i];
2282 if (col->type == HID_COLLECTION_APPLICATION &&
2283 (col->usage & HID_USAGE_PAGE) == HID_UP_GENDESK &&
2284 (col->usage & 0xffff) < ARRAY_SIZE(types)) {
2285 type = types[col->usage & 0xffff];
2286 break;
2287 }
2288 }
2289
2290 switch (hdev->bus) {
2291 case BUS_USB:
2292 bus = "USB";
2293 break;
2294 case BUS_BLUETOOTH:
2295 bus = "BLUETOOTH";
2296 break;
2297 case BUS_I2C:
2298 bus = "I2C";
2299 break;
2300 case BUS_VIRTUAL:
2301 bus = "VIRTUAL";
2302 break;
2303 case BUS_INTEL_ISHTP:
2304 case BUS_AMD_SFH:
2305 bus = "SENSOR HUB";
2306 break;
2307 default:
2308 bus = "<UNKNOWN>";
2309 }
2310
2311 ret = device_create_file(&hdev->dev, &dev_attr_country);
2312 if (ret)
2313 hid_warn(hdev,
2314 "can't create sysfs country code attribute err: %d\n", ret);
2315
2316 hid_info(hdev, "%s: %s HID v%x.%02x %s [%s] on %s\n",
2317 buf, bus, hdev->version >> 8, hdev->version & 0xff,
2318 type, hdev->name, hdev->phys);
2319
2320 return 0;
2321}
2322EXPORT_SYMBOL_GPL(hid_connect);
2323
2324void hid_disconnect(struct hid_device *hdev)
2325{
2326 device_remove_file(&hdev->dev, &dev_attr_country);
2327 if (hdev->claimed & HID_CLAIMED_INPUT)
2328 hidinput_disconnect(hdev);
2329 if (hdev->claimed & HID_CLAIMED_HIDDEV)
2330 hdev->hiddev_disconnect(hdev);
2331 if (hdev->claimed & HID_CLAIMED_HIDRAW)
2332 hidraw_disconnect(hdev);
2333 hdev->claimed = 0;
2334
2335 hid_bpf_disconnect_device(hdev);
2336}
2337EXPORT_SYMBOL_GPL(hid_disconnect);
2338
2339/**
2340 * hid_hw_start - start underlying HW
2341 * @hdev: hid device
2342 * @connect_mask: which outputs to connect, see HID_CONNECT_*
2343 *
2344 * Call this in probe function *after* hid_parse. This will setup HW
2345 * buffers and start the device (if not defeirred to device open).
2346 * hid_hw_stop must be called if this was successful.
2347 */
2348int hid_hw_start(struct hid_device *hdev, unsigned int connect_mask)
2349{
2350 int error;
2351
2352 error = hdev->ll_driver->start(hdev);
2353 if (error)
2354 return error;
2355
2356 if (connect_mask) {
2357 error = hid_connect(hdev, connect_mask);
2358 if (error) {
2359 hdev->ll_driver->stop(hdev);
2360 return error;
2361 }
2362 }
2363
2364 return 0;
2365}
2366EXPORT_SYMBOL_GPL(hid_hw_start);
2367
2368/**
2369 * hid_hw_stop - stop underlying HW
2370 * @hdev: hid device
2371 *
2372 * This is usually called from remove function or from probe when something
2373 * failed and hid_hw_start was called already.
2374 */
2375void hid_hw_stop(struct hid_device *hdev)
2376{
2377 hid_disconnect(hdev);
2378 hdev->ll_driver->stop(hdev);
2379}
2380EXPORT_SYMBOL_GPL(hid_hw_stop);
2381
2382/**
2383 * hid_hw_open - signal underlying HW to start delivering events
2384 * @hdev: hid device
2385 *
2386 * Tell underlying HW to start delivering events from the device.
2387 * This function should be called sometime after successful call
2388 * to hid_hw_start().
2389 */
2390int hid_hw_open(struct hid_device *hdev)
2391{
2392 int ret;
2393
2394 ret = mutex_lock_killable(&hdev->ll_open_lock);
2395 if (ret)
2396 return ret;
2397
2398 if (!hdev->ll_open_count++) {
2399 ret = hdev->ll_driver->open(hdev);
2400 if (ret)
2401 hdev->ll_open_count--;
2402 }
2403
2404 mutex_unlock(&hdev->ll_open_lock);
2405 return ret;
2406}
2407EXPORT_SYMBOL_GPL(hid_hw_open);
2408
2409/**
2410 * hid_hw_close - signal underlaying HW to stop delivering events
2411 *
2412 * @hdev: hid device
2413 *
2414 * This function indicates that we are not interested in the events
2415 * from this device anymore. Delivery of events may or may not stop,
2416 * depending on the number of users still outstanding.
2417 */
2418void hid_hw_close(struct hid_device *hdev)
2419{
2420 mutex_lock(&hdev->ll_open_lock);
2421 if (!--hdev->ll_open_count)
2422 hdev->ll_driver->close(hdev);
2423 mutex_unlock(&hdev->ll_open_lock);
2424}
2425EXPORT_SYMBOL_GPL(hid_hw_close);
2426
2427/**
2428 * hid_hw_request - send report request to device
2429 *
2430 * @hdev: hid device
2431 * @report: report to send
2432 * @reqtype: hid request type
2433 */
2434void hid_hw_request(struct hid_device *hdev,
2435 struct hid_report *report, enum hid_class_request reqtype)
2436{
2437 if (hdev->ll_driver->request)
2438 return hdev->ll_driver->request(hdev, report, reqtype);
2439
2440 __hid_request(hdev, report, reqtype);
2441}
2442EXPORT_SYMBOL_GPL(hid_hw_request);
2443
2444int __hid_hw_raw_request(struct hid_device *hdev,
2445 unsigned char reportnum, __u8 *buf,
2446 size_t len, enum hid_report_type rtype,
2447 enum hid_class_request reqtype,
2448 u64 source, bool from_bpf)
2449{
2450 unsigned int max_buffer_size = HID_MAX_BUFFER_SIZE;
2451 int ret;
2452
2453 if (hdev->ll_driver->max_buffer_size)
2454 max_buffer_size = hdev->ll_driver->max_buffer_size;
2455
2456 if (len < 1 || len > max_buffer_size || !buf)
2457 return -EINVAL;
2458
2459 ret = dispatch_hid_bpf_raw_requests(hdev, reportnum, buf, len, rtype,
2460 reqtype, source, from_bpf);
2461 if (ret)
2462 return ret;
2463
2464 return hdev->ll_driver->raw_request(hdev, reportnum, buf, len,
2465 rtype, reqtype);
2466}
2467
2468/**
2469 * hid_hw_raw_request - send report request to device
2470 *
2471 * @hdev: hid device
2472 * @reportnum: report ID
2473 * @buf: in/out data to transfer
2474 * @len: length of buf
2475 * @rtype: HID report type
2476 * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
2477 *
2478 * Return: count of data transferred, negative if error
2479 *
2480 * Same behavior as hid_hw_request, but with raw buffers instead.
2481 */
2482int hid_hw_raw_request(struct hid_device *hdev,
2483 unsigned char reportnum, __u8 *buf,
2484 size_t len, enum hid_report_type rtype, enum hid_class_request reqtype)
2485{
2486 return __hid_hw_raw_request(hdev, reportnum, buf, len, rtype, reqtype, 0, false);
2487}
2488EXPORT_SYMBOL_GPL(hid_hw_raw_request);
2489
2490int __hid_hw_output_report(struct hid_device *hdev, __u8 *buf, size_t len, u64 source,
2491 bool from_bpf)
2492{
2493 unsigned int max_buffer_size = HID_MAX_BUFFER_SIZE;
2494 int ret;
2495
2496 if (hdev->ll_driver->max_buffer_size)
2497 max_buffer_size = hdev->ll_driver->max_buffer_size;
2498
2499 if (len < 1 || len > max_buffer_size || !buf)
2500 return -EINVAL;
2501
2502 ret = dispatch_hid_bpf_output_report(hdev, buf, len, source, from_bpf);
2503 if (ret)
2504 return ret;
2505
2506 if (hdev->ll_driver->output_report)
2507 return hdev->ll_driver->output_report(hdev, buf, len);
2508
2509 return -ENOSYS;
2510}
2511
2512/**
2513 * hid_hw_output_report - send output report to device
2514 *
2515 * @hdev: hid device
2516 * @buf: raw data to transfer
2517 * @len: length of buf
2518 *
2519 * Return: count of data transferred, negative if error
2520 */
2521int hid_hw_output_report(struct hid_device *hdev, __u8 *buf, size_t len)
2522{
2523 return __hid_hw_output_report(hdev, buf, len, 0, false);
2524}
2525EXPORT_SYMBOL_GPL(hid_hw_output_report);
2526
2527#ifdef CONFIG_PM
2528int hid_driver_suspend(struct hid_device *hdev, pm_message_t state)
2529{
2530 if (hdev->driver && hdev->driver->suspend)
2531 return hdev->driver->suspend(hdev, state);
2532
2533 return 0;
2534}
2535EXPORT_SYMBOL_GPL(hid_driver_suspend);
2536
2537int hid_driver_reset_resume(struct hid_device *hdev)
2538{
2539 if (hdev->driver && hdev->driver->reset_resume)
2540 return hdev->driver->reset_resume(hdev);
2541
2542 return 0;
2543}
2544EXPORT_SYMBOL_GPL(hid_driver_reset_resume);
2545
2546int hid_driver_resume(struct hid_device *hdev)
2547{
2548 if (hdev->driver && hdev->driver->resume)
2549 return hdev->driver->resume(hdev);
2550
2551 return 0;
2552}
2553EXPORT_SYMBOL_GPL(hid_driver_resume);
2554#endif /* CONFIG_PM */
2555
2556struct hid_dynid {
2557 struct list_head list;
2558 struct hid_device_id id;
2559};
2560
2561/**
2562 * new_id_store - add a new HID device ID to this driver and re-probe devices
2563 * @drv: target device driver
2564 * @buf: buffer for scanning device ID data
2565 * @count: input size
2566 *
2567 * Adds a new dynamic hid device ID to this driver,
2568 * and causes the driver to probe for all devices again.
2569 */
2570static ssize_t new_id_store(struct device_driver *drv, const char *buf,
2571 size_t count)
2572{
2573 struct hid_driver *hdrv = to_hid_driver(drv);
2574 struct hid_dynid *dynid;
2575 __u32 bus, vendor, product;
2576 unsigned long driver_data = 0;
2577 int ret;
2578
2579 ret = sscanf(buf, "%x %x %x %lx",
2580 &bus, &vendor, &product, &driver_data);
2581 if (ret < 3)
2582 return -EINVAL;
2583
2584 dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
2585 if (!dynid)
2586 return -ENOMEM;
2587
2588 dynid->id.bus = bus;
2589 dynid->id.group = HID_GROUP_ANY;
2590 dynid->id.vendor = vendor;
2591 dynid->id.product = product;
2592 dynid->id.driver_data = driver_data;
2593
2594 spin_lock(&hdrv->dyn_lock);
2595 list_add_tail(&dynid->list, &hdrv->dyn_list);
2596 spin_unlock(&hdrv->dyn_lock);
2597
2598 ret = driver_attach(&hdrv->driver);
2599
2600 return ret ? : count;
2601}
2602static DRIVER_ATTR_WO(new_id);
2603
2604static struct attribute *hid_drv_attrs[] = {
2605 &driver_attr_new_id.attr,
2606 NULL,
2607};
2608ATTRIBUTE_GROUPS(hid_drv);
2609
2610static void hid_free_dynids(struct hid_driver *hdrv)
2611{
2612 struct hid_dynid *dynid, *n;
2613
2614 spin_lock(&hdrv->dyn_lock);
2615 list_for_each_entry_safe(dynid, n, &hdrv->dyn_list, list) {
2616 list_del(&dynid->list);
2617 kfree(dynid);
2618 }
2619 spin_unlock(&hdrv->dyn_lock);
2620}
2621
2622const struct hid_device_id *hid_match_device(struct hid_device *hdev,
2623 struct hid_driver *hdrv)
2624{
2625 struct hid_dynid *dynid;
2626
2627 spin_lock(&hdrv->dyn_lock);
2628 list_for_each_entry(dynid, &hdrv->dyn_list, list) {
2629 if (hid_match_one_id(hdev, &dynid->id)) {
2630 spin_unlock(&hdrv->dyn_lock);
2631 return &dynid->id;
2632 }
2633 }
2634 spin_unlock(&hdrv->dyn_lock);
2635
2636 return hid_match_id(hdev, hdrv->id_table);
2637}
2638EXPORT_SYMBOL_GPL(hid_match_device);
2639
2640static int hid_bus_match(struct device *dev, const struct device_driver *drv)
2641{
2642 struct hid_driver *hdrv = to_hid_driver(drv);
2643 struct hid_device *hdev = to_hid_device(dev);
2644
2645 return hid_match_device(hdev, hdrv) != NULL;
2646}
2647
2648/**
2649 * hid_compare_device_paths - check if both devices share the same path
2650 * @hdev_a: hid device
2651 * @hdev_b: hid device
2652 * @separator: char to use as separator
2653 *
2654 * Check if two devices share the same path up to the last occurrence of
2655 * the separator char. Both paths must exist (i.e., zero-length paths
2656 * don't match).
2657 */
2658bool hid_compare_device_paths(struct hid_device *hdev_a,
2659 struct hid_device *hdev_b, char separator)
2660{
2661 int n1 = strrchr(hdev_a->phys, separator) - hdev_a->phys;
2662 int n2 = strrchr(hdev_b->phys, separator) - hdev_b->phys;
2663
2664 if (n1 != n2 || n1 <= 0 || n2 <= 0)
2665 return false;
2666
2667 return !strncmp(hdev_a->phys, hdev_b->phys, n1);
2668}
2669EXPORT_SYMBOL_GPL(hid_compare_device_paths);
2670
2671static bool hid_check_device_match(struct hid_device *hdev,
2672 struct hid_driver *hdrv,
2673 const struct hid_device_id **id)
2674{
2675 *id = hid_match_device(hdev, hdrv);
2676 if (!*id)
2677 return false;
2678
2679 if (hdrv->match)
2680 return hdrv->match(hdev, hid_ignore_special_drivers);
2681
2682 /*
2683 * hid-generic implements .match(), so we must be dealing with a
2684 * different HID driver here, and can simply check if
2685 * hid_ignore_special_drivers or HID_QUIRK_IGNORE_SPECIAL_DRIVER
2686 * are set or not.
2687 */
2688 return !hid_ignore_special_drivers && !(hdev->quirks & HID_QUIRK_IGNORE_SPECIAL_DRIVER);
2689}
2690
2691static int __hid_device_probe(struct hid_device *hdev, struct hid_driver *hdrv)
2692{
2693 const struct hid_device_id *id;
2694 int ret;
2695
2696 if (!hdev->bpf_rsize) {
2697 /* in case a bpf program gets detached, we need to free the old one */
2698 hid_free_bpf_rdesc(hdev);
2699
2700 /* keep this around so we know we called it once */
2701 hdev->bpf_rsize = hdev->dev_rsize;
2702
2703 /* call_hid_bpf_rdesc_fixup will always return a valid pointer */
2704 hdev->bpf_rdesc = call_hid_bpf_rdesc_fixup(hdev, hdev->dev_rdesc,
2705 &hdev->bpf_rsize);
2706 }
2707
2708 if (!hid_check_device_match(hdev, hdrv, &id))
2709 return -ENODEV;
2710
2711 hdev->devres_group_id = devres_open_group(&hdev->dev, NULL, GFP_KERNEL);
2712 if (!hdev->devres_group_id)
2713 return -ENOMEM;
2714
2715 /* reset the quirks that has been previously set */
2716 hdev->quirks = hid_lookup_quirk(hdev);
2717 hdev->driver = hdrv;
2718
2719 if (hdrv->probe) {
2720 ret = hdrv->probe(hdev, id);
2721 } else { /* default probe */
2722 ret = hid_open_report(hdev);
2723 if (!ret)
2724 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
2725 }
2726
2727 /*
2728 * Note that we are not closing the devres group opened above so
2729 * even resources that were attached to the device after probe is
2730 * run are released when hid_device_remove() is executed. This is
2731 * needed as some drivers would allocate additional resources,
2732 * for example when updating firmware.
2733 */
2734
2735 if (ret) {
2736 devres_release_group(&hdev->dev, hdev->devres_group_id);
2737 hid_close_report(hdev);
2738 hdev->driver = NULL;
2739 }
2740
2741 return ret;
2742}
2743
2744static int hid_device_probe(struct device *dev)
2745{
2746 struct hid_device *hdev = to_hid_device(dev);
2747 struct hid_driver *hdrv = to_hid_driver(dev->driver);
2748 int ret = 0;
2749
2750 if (down_interruptible(&hdev->driver_input_lock))
2751 return -EINTR;
2752
2753 hdev->io_started = false;
2754 clear_bit(ffs(HID_STAT_REPROBED), &hdev->status);
2755
2756 if (!hdev->driver)
2757 ret = __hid_device_probe(hdev, hdrv);
2758
2759 if (!hdev->io_started)
2760 up(&hdev->driver_input_lock);
2761
2762 return ret;
2763}
2764
2765static void hid_device_remove(struct device *dev)
2766{
2767 struct hid_device *hdev = to_hid_device(dev);
2768 struct hid_driver *hdrv;
2769
2770 down(&hdev->driver_input_lock);
2771 hdev->io_started = false;
2772
2773 hdrv = hdev->driver;
2774 if (hdrv) {
2775 if (hdrv->remove)
2776 hdrv->remove(hdev);
2777 else /* default remove */
2778 hid_hw_stop(hdev);
2779
2780 /* Release all devres resources allocated by the driver */
2781 devres_release_group(&hdev->dev, hdev->devres_group_id);
2782
2783 hid_close_report(hdev);
2784 hdev->driver = NULL;
2785 }
2786
2787 if (!hdev->io_started)
2788 up(&hdev->driver_input_lock);
2789}
2790
2791static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
2792 char *buf)
2793{
2794 struct hid_device *hdev = container_of(dev, struct hid_device, dev);
2795
2796 return scnprintf(buf, PAGE_SIZE, "hid:b%04Xg%04Xv%08Xp%08X\n",
2797 hdev->bus, hdev->group, hdev->vendor, hdev->product);
2798}
2799static DEVICE_ATTR_RO(modalias);
2800
2801static struct attribute *hid_dev_attrs[] = {
2802 &dev_attr_modalias.attr,
2803 NULL,
2804};
2805static struct bin_attribute *hid_dev_bin_attrs[] = {
2806 &dev_bin_attr_report_desc,
2807 NULL
2808};
2809static const struct attribute_group hid_dev_group = {
2810 .attrs = hid_dev_attrs,
2811 .bin_attrs = hid_dev_bin_attrs,
2812};
2813__ATTRIBUTE_GROUPS(hid_dev);
2814
2815static int hid_uevent(const struct device *dev, struct kobj_uevent_env *env)
2816{
2817 const struct hid_device *hdev = to_hid_device(dev);
2818
2819 if (add_uevent_var(env, "HID_ID=%04X:%08X:%08X",
2820 hdev->bus, hdev->vendor, hdev->product))
2821 return -ENOMEM;
2822
2823 if (add_uevent_var(env, "HID_NAME=%s", hdev->name))
2824 return -ENOMEM;
2825
2826 if (add_uevent_var(env, "HID_PHYS=%s", hdev->phys))
2827 return -ENOMEM;
2828
2829 if (add_uevent_var(env, "HID_UNIQ=%s", hdev->uniq))
2830 return -ENOMEM;
2831
2832 if (add_uevent_var(env, "MODALIAS=hid:b%04Xg%04Xv%08Xp%08X",
2833 hdev->bus, hdev->group, hdev->vendor, hdev->product))
2834 return -ENOMEM;
2835
2836 return 0;
2837}
2838
2839const struct bus_type hid_bus_type = {
2840 .name = "hid",
2841 .dev_groups = hid_dev_groups,
2842 .drv_groups = hid_drv_groups,
2843 .match = hid_bus_match,
2844 .probe = hid_device_probe,
2845 .remove = hid_device_remove,
2846 .uevent = hid_uevent,
2847};
2848EXPORT_SYMBOL(hid_bus_type);
2849
2850int hid_add_device(struct hid_device *hdev)
2851{
2852 static atomic_t id = ATOMIC_INIT(0);
2853 int ret;
2854
2855 if (WARN_ON(hdev->status & HID_STAT_ADDED))
2856 return -EBUSY;
2857
2858 hdev->quirks = hid_lookup_quirk(hdev);
2859
2860 /* we need to kill them here, otherwise they will stay allocated to
2861 * wait for coming driver */
2862 if (hid_ignore(hdev))
2863 return -ENODEV;
2864
2865 /*
2866 * Check for the mandatory transport channel.
2867 */
2868 if (!hdev->ll_driver->raw_request) {
2869 hid_err(hdev, "transport driver missing .raw_request()\n");
2870 return -EINVAL;
2871 }
2872
2873 /*
2874 * Read the device report descriptor once and use as template
2875 * for the driver-specific modifications.
2876 */
2877 ret = hdev->ll_driver->parse(hdev);
2878 if (ret)
2879 return ret;
2880 if (!hdev->dev_rdesc)
2881 return -ENODEV;
2882
2883 /*
2884 * Scan generic devices for group information
2885 */
2886 if (hid_ignore_special_drivers) {
2887 hdev->group = HID_GROUP_GENERIC;
2888 } else if (!hdev->group &&
2889 !(hdev->quirks & HID_QUIRK_HAVE_SPECIAL_DRIVER)) {
2890 ret = hid_scan_report(hdev);
2891 if (ret)
2892 hid_warn(hdev, "bad device descriptor (%d)\n", ret);
2893 }
2894
2895 hdev->id = atomic_inc_return(&id);
2896
2897 /* XXX hack, any other cleaner solution after the driver core
2898 * is converted to allow more than 20 bytes as the device name? */
2899 dev_set_name(&hdev->dev, "%04X:%04X:%04X.%04X", hdev->bus,
2900 hdev->vendor, hdev->product, hdev->id);
2901
2902 hid_debug_register(hdev, dev_name(&hdev->dev));
2903 ret = device_add(&hdev->dev);
2904 if (!ret)
2905 hdev->status |= HID_STAT_ADDED;
2906 else
2907 hid_debug_unregister(hdev);
2908
2909 return ret;
2910}
2911EXPORT_SYMBOL_GPL(hid_add_device);
2912
2913/**
2914 * hid_allocate_device - allocate new hid device descriptor
2915 *
2916 * Allocate and initialize hid device, so that hid_destroy_device might be
2917 * used to free it.
2918 *
2919 * New hid_device pointer is returned on success, otherwise ERR_PTR encoded
2920 * error value.
2921 */
2922struct hid_device *hid_allocate_device(void)
2923{
2924 struct hid_device *hdev;
2925 int ret = -ENOMEM;
2926
2927 hdev = kzalloc(sizeof(*hdev), GFP_KERNEL);
2928 if (hdev == NULL)
2929 return ERR_PTR(ret);
2930
2931 device_initialize(&hdev->dev);
2932 hdev->dev.release = hid_device_release;
2933 hdev->dev.bus = &hid_bus_type;
2934 device_enable_async_suspend(&hdev->dev);
2935
2936 hid_close_report(hdev);
2937
2938 init_waitqueue_head(&hdev->debug_wait);
2939 INIT_LIST_HEAD(&hdev->debug_list);
2940 spin_lock_init(&hdev->debug_list_lock);
2941 sema_init(&hdev->driver_input_lock, 1);
2942 mutex_init(&hdev->ll_open_lock);
2943 kref_init(&hdev->ref);
2944
2945 ret = hid_bpf_device_init(hdev);
2946 if (ret)
2947 goto out_err;
2948
2949 return hdev;
2950
2951out_err:
2952 hid_destroy_device(hdev);
2953 return ERR_PTR(ret);
2954}
2955EXPORT_SYMBOL_GPL(hid_allocate_device);
2956
2957static void hid_remove_device(struct hid_device *hdev)
2958{
2959 if (hdev->status & HID_STAT_ADDED) {
2960 device_del(&hdev->dev);
2961 hid_debug_unregister(hdev);
2962 hdev->status &= ~HID_STAT_ADDED;
2963 }
2964 hid_free_bpf_rdesc(hdev);
2965 kfree(hdev->dev_rdesc);
2966 hdev->dev_rdesc = NULL;
2967 hdev->dev_rsize = 0;
2968 hdev->bpf_rsize = 0;
2969}
2970
2971/**
2972 * hid_destroy_device - free previously allocated device
2973 *
2974 * @hdev: hid device
2975 *
2976 * If you allocate hid_device through hid_allocate_device, you should ever
2977 * free by this function.
2978 */
2979void hid_destroy_device(struct hid_device *hdev)
2980{
2981 hid_bpf_destroy_device(hdev);
2982 hid_remove_device(hdev);
2983 put_device(&hdev->dev);
2984}
2985EXPORT_SYMBOL_GPL(hid_destroy_device);
2986
2987
2988static int __hid_bus_reprobe_drivers(struct device *dev, void *data)
2989{
2990 struct hid_driver *hdrv = data;
2991 struct hid_device *hdev = to_hid_device(dev);
2992
2993 if (hdev->driver == hdrv &&
2994 !hdrv->match(hdev, hid_ignore_special_drivers) &&
2995 !test_and_set_bit(ffs(HID_STAT_REPROBED), &hdev->status))
2996 return device_reprobe(dev);
2997
2998 return 0;
2999}
3000
3001static int __hid_bus_driver_added(struct device_driver *drv, void *data)
3002{
3003 struct hid_driver *hdrv = to_hid_driver(drv);
3004
3005 if (hdrv->match) {
3006 bus_for_each_dev(&hid_bus_type, NULL, hdrv,
3007 __hid_bus_reprobe_drivers);
3008 }
3009
3010 return 0;
3011}
3012
3013static int __bus_removed_driver(struct device_driver *drv, void *data)
3014{
3015 return bus_rescan_devices(&hid_bus_type);
3016}
3017
3018int __hid_register_driver(struct hid_driver *hdrv, struct module *owner,
3019 const char *mod_name)
3020{
3021 int ret;
3022
3023 hdrv->driver.name = hdrv->name;
3024 hdrv->driver.bus = &hid_bus_type;
3025 hdrv->driver.owner = owner;
3026 hdrv->driver.mod_name = mod_name;
3027
3028 INIT_LIST_HEAD(&hdrv->dyn_list);
3029 spin_lock_init(&hdrv->dyn_lock);
3030
3031 ret = driver_register(&hdrv->driver);
3032
3033 if (ret == 0)
3034 bus_for_each_drv(&hid_bus_type, NULL, NULL,
3035 __hid_bus_driver_added);
3036
3037 return ret;
3038}
3039EXPORT_SYMBOL_GPL(__hid_register_driver);
3040
3041void hid_unregister_driver(struct hid_driver *hdrv)
3042{
3043 driver_unregister(&hdrv->driver);
3044 hid_free_dynids(hdrv);
3045
3046 bus_for_each_drv(&hid_bus_type, NULL, hdrv, __bus_removed_driver);
3047}
3048EXPORT_SYMBOL_GPL(hid_unregister_driver);
3049
3050int hid_check_keys_pressed(struct hid_device *hid)
3051{
3052 struct hid_input *hidinput;
3053 int i;
3054
3055 if (!(hid->claimed & HID_CLAIMED_INPUT))
3056 return 0;
3057
3058 list_for_each_entry(hidinput, &hid->inputs, list) {
3059 for (i = 0; i < BITS_TO_LONGS(KEY_MAX); i++)
3060 if (hidinput->input->key[i])
3061 return 1;
3062 }
3063
3064 return 0;
3065}
3066EXPORT_SYMBOL_GPL(hid_check_keys_pressed);
3067
3068#ifdef CONFIG_HID_BPF
3069static const struct hid_ops __hid_ops = {
3070 .hid_get_report = hid_get_report,
3071 .hid_hw_raw_request = __hid_hw_raw_request,
3072 .hid_hw_output_report = __hid_hw_output_report,
3073 .hid_input_report = __hid_input_report,
3074 .owner = THIS_MODULE,
3075 .bus_type = &hid_bus_type,
3076};
3077#endif
3078
3079static int __init hid_init(void)
3080{
3081 int ret;
3082
3083 ret = bus_register(&hid_bus_type);
3084 if (ret) {
3085 pr_err("can't register hid bus\n");
3086 goto err;
3087 }
3088
3089#ifdef CONFIG_HID_BPF
3090 hid_ops = &__hid_ops;
3091#endif
3092
3093 ret = hidraw_init();
3094 if (ret)
3095 goto err_bus;
3096
3097 hid_debug_init();
3098
3099 return 0;
3100err_bus:
3101 bus_unregister(&hid_bus_type);
3102err:
3103 return ret;
3104}
3105
3106static void __exit hid_exit(void)
3107{
3108#ifdef CONFIG_HID_BPF
3109 hid_ops = NULL;
3110#endif
3111 hid_debug_exit();
3112 hidraw_exit();
3113 bus_unregister(&hid_bus_type);
3114 hid_quirks_exit(HID_BUS_ANY);
3115}
3116
3117module_init(hid_init);
3118module_exit(hid_exit);
3119
3120MODULE_AUTHOR("Andreas Gal");
3121MODULE_AUTHOR("Vojtech Pavlik");
3122MODULE_AUTHOR("Jiri Kosina");
3123MODULE_DESCRIPTION("HID support for Linux");
3124MODULE_LICENSE("GPL");
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-2012 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#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
18
19#include <linux/module.h>
20#include <linux/slab.h>
21#include <linux/init.h>
22#include <linux/kernel.h>
23#include <linux/list.h>
24#include <linux/mm.h>
25#include <linux/spinlock.h>
26#include <asm/unaligned.h>
27#include <asm/byteorder.h>
28#include <linux/input.h>
29#include <linux/wait.h>
30#include <linux/vmalloc.h>
31#include <linux/sched.h>
32#include <linux/semaphore.h>
33
34#include <linux/hid.h>
35#include <linux/hiddev.h>
36#include <linux/hid-debug.h>
37#include <linux/hidraw.h>
38
39#include "hid-ids.h"
40
41/*
42 * Version Information
43 */
44
45#define DRIVER_DESC "HID core driver"
46
47int hid_debug = 0;
48module_param_named(debug, hid_debug, int, 0600);
49MODULE_PARM_DESC(debug, "toggle HID debugging messages");
50EXPORT_SYMBOL_GPL(hid_debug);
51
52static int hid_ignore_special_drivers = 0;
53module_param_named(ignore_special_drivers, hid_ignore_special_drivers, int, 0600);
54MODULE_PARM_DESC(ignore_special_drivers, "Ignore any special drivers and handle all devices by generic driver");
55
56/*
57 * Register a new report for a device.
58 */
59
60struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id)
61{
62 struct hid_report_enum *report_enum = device->report_enum + type;
63 struct hid_report *report;
64
65 if (id >= HID_MAX_IDS)
66 return NULL;
67 if (report_enum->report_id_hash[id])
68 return report_enum->report_id_hash[id];
69
70 report = kzalloc(sizeof(struct hid_report), GFP_KERNEL);
71 if (!report)
72 return NULL;
73
74 if (id != 0)
75 report_enum->numbered = 1;
76
77 report->id = id;
78 report->type = type;
79 report->size = 0;
80 report->device = device;
81 report_enum->report_id_hash[id] = report;
82
83 list_add_tail(&report->list, &report_enum->report_list);
84
85 return report;
86}
87EXPORT_SYMBOL_GPL(hid_register_report);
88
89/*
90 * Register a new field for this report.
91 */
92
93static struct hid_field *hid_register_field(struct hid_report *report, unsigned usages, unsigned values)
94{
95 struct hid_field *field;
96
97 if (report->maxfield == HID_MAX_FIELDS) {
98 hid_err(report->device, "too many fields in report\n");
99 return NULL;
100 }
101
102 field = kzalloc((sizeof(struct hid_field) +
103 usages * sizeof(struct hid_usage) +
104 values * sizeof(unsigned)), GFP_KERNEL);
105 if (!field)
106 return NULL;
107
108 field->index = report->maxfield++;
109 report->field[field->index] = field;
110 field->usage = (struct hid_usage *)(field + 1);
111 field->value = (s32 *)(field->usage + usages);
112 field->report = report;
113
114 return field;
115}
116
117/*
118 * Open a collection. The type/usage is pushed on the stack.
119 */
120
121static int open_collection(struct hid_parser *parser, unsigned type)
122{
123 struct hid_collection *collection;
124 unsigned usage;
125
126 usage = parser->local.usage[0];
127
128 if (parser->collection_stack_ptr == HID_COLLECTION_STACK_SIZE) {
129 hid_err(parser->device, "collection stack overflow\n");
130 return -EINVAL;
131 }
132
133 if (parser->device->maxcollection == parser->device->collection_size) {
134 collection = kmalloc(sizeof(struct hid_collection) *
135 parser->device->collection_size * 2, GFP_KERNEL);
136 if (collection == NULL) {
137 hid_err(parser->device, "failed to reallocate collection array\n");
138 return -ENOMEM;
139 }
140 memcpy(collection, parser->device->collection,
141 sizeof(struct hid_collection) *
142 parser->device->collection_size);
143 memset(collection + parser->device->collection_size, 0,
144 sizeof(struct hid_collection) *
145 parser->device->collection_size);
146 kfree(parser->device->collection);
147 parser->device->collection = collection;
148 parser->device->collection_size *= 2;
149 }
150
151 parser->collection_stack[parser->collection_stack_ptr++] =
152 parser->device->maxcollection;
153
154 collection = parser->device->collection +
155 parser->device->maxcollection++;
156 collection->type = type;
157 collection->usage = usage;
158 collection->level = parser->collection_stack_ptr - 1;
159
160 if (type == HID_COLLECTION_APPLICATION)
161 parser->device->maxapplication++;
162
163 return 0;
164}
165
166/*
167 * Close a collection.
168 */
169
170static int close_collection(struct hid_parser *parser)
171{
172 if (!parser->collection_stack_ptr) {
173 hid_err(parser->device, "collection stack underflow\n");
174 return -EINVAL;
175 }
176 parser->collection_stack_ptr--;
177 return 0;
178}
179
180/*
181 * Climb up the stack, search for the specified collection type
182 * and return the usage.
183 */
184
185static unsigned hid_lookup_collection(struct hid_parser *parser, unsigned type)
186{
187 struct hid_collection *collection = parser->device->collection;
188 int n;
189
190 for (n = parser->collection_stack_ptr - 1; n >= 0; n--) {
191 unsigned index = parser->collection_stack[n];
192 if (collection[index].type == type)
193 return collection[index].usage;
194 }
195 return 0; /* we know nothing about this usage type */
196}
197
198/*
199 * Add a usage to the temporary parser table.
200 */
201
202static int hid_add_usage(struct hid_parser *parser, unsigned usage)
203{
204 if (parser->local.usage_index >= HID_MAX_USAGES) {
205 hid_err(parser->device, "usage index exceeded\n");
206 return -1;
207 }
208 parser->local.usage[parser->local.usage_index] = usage;
209 parser->local.collection_index[parser->local.usage_index] =
210 parser->collection_stack_ptr ?
211 parser->collection_stack[parser->collection_stack_ptr - 1] : 0;
212 parser->local.usage_index++;
213 return 0;
214}
215
216/*
217 * Register a new field for this report.
218 */
219
220static int hid_add_field(struct hid_parser *parser, unsigned report_type, unsigned flags)
221{
222 struct hid_report *report;
223 struct hid_field *field;
224 unsigned usages;
225 unsigned offset;
226 unsigned i;
227
228 report = hid_register_report(parser->device, report_type, parser->global.report_id);
229 if (!report) {
230 hid_err(parser->device, "hid_register_report failed\n");
231 return -1;
232 }
233
234 /* Handle both signed and unsigned cases properly */
235 if ((parser->global.logical_minimum < 0 &&
236 parser->global.logical_maximum <
237 parser->global.logical_minimum) ||
238 (parser->global.logical_minimum >= 0 &&
239 (__u32)parser->global.logical_maximum <
240 (__u32)parser->global.logical_minimum)) {
241 dbg_hid("logical range invalid 0x%x 0x%x\n",
242 parser->global.logical_minimum,
243 parser->global.logical_maximum);
244 return -1;
245 }
246
247 offset = report->size;
248 report->size += parser->global.report_size * parser->global.report_count;
249
250 if (!parser->local.usage_index) /* Ignore padding fields */
251 return 0;
252
253 usages = max_t(unsigned, parser->local.usage_index,
254 parser->global.report_count);
255
256 field = hid_register_field(report, usages, parser->global.report_count);
257 if (!field)
258 return 0;
259
260 field->physical = hid_lookup_collection(parser, HID_COLLECTION_PHYSICAL);
261 field->logical = hid_lookup_collection(parser, HID_COLLECTION_LOGICAL);
262 field->application = hid_lookup_collection(parser, HID_COLLECTION_APPLICATION);
263
264 for (i = 0; i < usages; i++) {
265 unsigned j = i;
266 /* Duplicate the last usage we parsed if we have excess values */
267 if (i >= parser->local.usage_index)
268 j = parser->local.usage_index - 1;
269 field->usage[i].hid = parser->local.usage[j];
270 field->usage[i].collection_index =
271 parser->local.collection_index[j];
272 field->usage[i].usage_index = i;
273 }
274
275 field->maxusage = usages;
276 field->flags = flags;
277 field->report_offset = offset;
278 field->report_type = report_type;
279 field->report_size = parser->global.report_size;
280 field->report_count = parser->global.report_count;
281 field->logical_minimum = parser->global.logical_minimum;
282 field->logical_maximum = parser->global.logical_maximum;
283 field->physical_minimum = parser->global.physical_minimum;
284 field->physical_maximum = parser->global.physical_maximum;
285 field->unit_exponent = parser->global.unit_exponent;
286 field->unit = parser->global.unit;
287
288 return 0;
289}
290
291/*
292 * Read data value from item.
293 */
294
295static u32 item_udata(struct hid_item *item)
296{
297 switch (item->size) {
298 case 1: return item->data.u8;
299 case 2: return item->data.u16;
300 case 4: return item->data.u32;
301 }
302 return 0;
303}
304
305static s32 item_sdata(struct hid_item *item)
306{
307 switch (item->size) {
308 case 1: return item->data.s8;
309 case 2: return item->data.s16;
310 case 4: return item->data.s32;
311 }
312 return 0;
313}
314
315/*
316 * Process a global item.
317 */
318
319static int hid_parser_global(struct hid_parser *parser, struct hid_item *item)
320{
321 __s32 raw_value;
322 switch (item->tag) {
323 case HID_GLOBAL_ITEM_TAG_PUSH:
324
325 if (parser->global_stack_ptr == HID_GLOBAL_STACK_SIZE) {
326 hid_err(parser->device, "global environment stack overflow\n");
327 return -1;
328 }
329
330 memcpy(parser->global_stack + parser->global_stack_ptr++,
331 &parser->global, sizeof(struct hid_global));
332 return 0;
333
334 case HID_GLOBAL_ITEM_TAG_POP:
335
336 if (!parser->global_stack_ptr) {
337 hid_err(parser->device, "global environment stack underflow\n");
338 return -1;
339 }
340
341 memcpy(&parser->global, parser->global_stack +
342 --parser->global_stack_ptr, sizeof(struct hid_global));
343 return 0;
344
345 case HID_GLOBAL_ITEM_TAG_USAGE_PAGE:
346 parser->global.usage_page = item_udata(item);
347 return 0;
348
349 case HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM:
350 parser->global.logical_minimum = item_sdata(item);
351 return 0;
352
353 case HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM:
354 if (parser->global.logical_minimum < 0)
355 parser->global.logical_maximum = item_sdata(item);
356 else
357 parser->global.logical_maximum = item_udata(item);
358 return 0;
359
360 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM:
361 parser->global.physical_minimum = item_sdata(item);
362 return 0;
363
364 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM:
365 if (parser->global.physical_minimum < 0)
366 parser->global.physical_maximum = item_sdata(item);
367 else
368 parser->global.physical_maximum = item_udata(item);
369 return 0;
370
371 case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT:
372 /* Many devices provide unit exponent as a two's complement
373 * nibble due to the common misunderstanding of HID
374 * specification 1.11, 6.2.2.7 Global Items. Attempt to handle
375 * both this and the standard encoding. */
376 raw_value = item_sdata(item);
377 if (!(raw_value & 0xfffffff0))
378 parser->global.unit_exponent = hid_snto32(raw_value, 4);
379 else
380 parser->global.unit_exponent = raw_value;
381 return 0;
382
383 case HID_GLOBAL_ITEM_TAG_UNIT:
384 parser->global.unit = item_udata(item);
385 return 0;
386
387 case HID_GLOBAL_ITEM_TAG_REPORT_SIZE:
388 parser->global.report_size = item_udata(item);
389 if (parser->global.report_size > 128) {
390 hid_err(parser->device, "invalid report_size %d\n",
391 parser->global.report_size);
392 return -1;
393 }
394 return 0;
395
396 case HID_GLOBAL_ITEM_TAG_REPORT_COUNT:
397 parser->global.report_count = item_udata(item);
398 if (parser->global.report_count > HID_MAX_USAGES) {
399 hid_err(parser->device, "invalid report_count %d\n",
400 parser->global.report_count);
401 return -1;
402 }
403 return 0;
404
405 case HID_GLOBAL_ITEM_TAG_REPORT_ID:
406 parser->global.report_id = item_udata(item);
407 if (parser->global.report_id == 0 ||
408 parser->global.report_id >= HID_MAX_IDS) {
409 hid_err(parser->device, "report_id %u is invalid\n",
410 parser->global.report_id);
411 return -1;
412 }
413 return 0;
414
415 default:
416 hid_err(parser->device, "unknown global tag 0x%x\n", item->tag);
417 return -1;
418 }
419}
420
421/*
422 * Process a local item.
423 */
424
425static int hid_parser_local(struct hid_parser *parser, struct hid_item *item)
426{
427 __u32 data;
428 unsigned n;
429 __u32 count;
430
431 data = item_udata(item);
432
433 switch (item->tag) {
434 case HID_LOCAL_ITEM_TAG_DELIMITER:
435
436 if (data) {
437 /*
438 * We treat items before the first delimiter
439 * as global to all usage sets (branch 0).
440 * In the moment we process only these global
441 * items and the first delimiter set.
442 */
443 if (parser->local.delimiter_depth != 0) {
444 hid_err(parser->device, "nested delimiters\n");
445 return -1;
446 }
447 parser->local.delimiter_depth++;
448 parser->local.delimiter_branch++;
449 } else {
450 if (parser->local.delimiter_depth < 1) {
451 hid_err(parser->device, "bogus close delimiter\n");
452 return -1;
453 }
454 parser->local.delimiter_depth--;
455 }
456 return 0;
457
458 case HID_LOCAL_ITEM_TAG_USAGE:
459
460 if (parser->local.delimiter_branch > 1) {
461 dbg_hid("alternative usage ignored\n");
462 return 0;
463 }
464
465 if (item->size <= 2)
466 data = (parser->global.usage_page << 16) + data;
467
468 return hid_add_usage(parser, data);
469
470 case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:
471
472 if (parser->local.delimiter_branch > 1) {
473 dbg_hid("alternative usage ignored\n");
474 return 0;
475 }
476
477 if (item->size <= 2)
478 data = (parser->global.usage_page << 16) + data;
479
480 parser->local.usage_minimum = data;
481 return 0;
482
483 case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:
484
485 if (parser->local.delimiter_branch > 1) {
486 dbg_hid("alternative usage ignored\n");
487 return 0;
488 }
489
490 if (item->size <= 2)
491 data = (parser->global.usage_page << 16) + data;
492
493 count = data - parser->local.usage_minimum;
494 if (count + parser->local.usage_index >= HID_MAX_USAGES) {
495 /*
496 * We do not warn if the name is not set, we are
497 * actually pre-scanning the device.
498 */
499 if (dev_name(&parser->device->dev))
500 hid_warn(parser->device,
501 "ignoring exceeding usage max\n");
502 data = HID_MAX_USAGES - parser->local.usage_index +
503 parser->local.usage_minimum - 1;
504 if (data <= 0) {
505 hid_err(parser->device,
506 "no more usage index available\n");
507 return -1;
508 }
509 }
510
511 for (n = parser->local.usage_minimum; n <= data; n++)
512 if (hid_add_usage(parser, n)) {
513 dbg_hid("hid_add_usage failed\n");
514 return -1;
515 }
516 return 0;
517
518 default:
519
520 dbg_hid("unknown local item tag 0x%x\n", item->tag);
521 return 0;
522 }
523 return 0;
524}
525
526/*
527 * Process a main item.
528 */
529
530static int hid_parser_main(struct hid_parser *parser, struct hid_item *item)
531{
532 __u32 data;
533 int ret;
534
535 data = item_udata(item);
536
537 switch (item->tag) {
538 case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION:
539 ret = open_collection(parser, data & 0xff);
540 break;
541 case HID_MAIN_ITEM_TAG_END_COLLECTION:
542 ret = close_collection(parser);
543 break;
544 case HID_MAIN_ITEM_TAG_INPUT:
545 ret = hid_add_field(parser, HID_INPUT_REPORT, data);
546 break;
547 case HID_MAIN_ITEM_TAG_OUTPUT:
548 ret = hid_add_field(parser, HID_OUTPUT_REPORT, data);
549 break;
550 case HID_MAIN_ITEM_TAG_FEATURE:
551 ret = hid_add_field(parser, HID_FEATURE_REPORT, data);
552 break;
553 default:
554 hid_warn(parser->device, "unknown main item tag 0x%x\n", item->tag);
555 ret = 0;
556 }
557
558 memset(&parser->local, 0, sizeof(parser->local)); /* Reset the local parser environment */
559
560 return ret;
561}
562
563/*
564 * Process a reserved item.
565 */
566
567static int hid_parser_reserved(struct hid_parser *parser, struct hid_item *item)
568{
569 dbg_hid("reserved item type, tag 0x%x\n", item->tag);
570 return 0;
571}
572
573/*
574 * Free a report and all registered fields. The field->usage and
575 * field->value table's are allocated behind the field, so we need
576 * only to free(field) itself.
577 */
578
579static void hid_free_report(struct hid_report *report)
580{
581 unsigned n;
582
583 for (n = 0; n < report->maxfield; n++)
584 kfree(report->field[n]);
585 kfree(report);
586}
587
588/*
589 * Close report. This function returns the device
590 * state to the point prior to hid_open_report().
591 */
592static void hid_close_report(struct hid_device *device)
593{
594 unsigned i, j;
595
596 for (i = 0; i < HID_REPORT_TYPES; i++) {
597 struct hid_report_enum *report_enum = device->report_enum + i;
598
599 for (j = 0; j < HID_MAX_IDS; j++) {
600 struct hid_report *report = report_enum->report_id_hash[j];
601 if (report)
602 hid_free_report(report);
603 }
604 memset(report_enum, 0, sizeof(*report_enum));
605 INIT_LIST_HEAD(&report_enum->report_list);
606 }
607
608 kfree(device->rdesc);
609 device->rdesc = NULL;
610 device->rsize = 0;
611
612 kfree(device->collection);
613 device->collection = NULL;
614 device->collection_size = 0;
615 device->maxcollection = 0;
616 device->maxapplication = 0;
617
618 device->status &= ~HID_STAT_PARSED;
619}
620
621/*
622 * Free a device structure, all reports, and all fields.
623 */
624
625static void hid_device_release(struct device *dev)
626{
627 struct hid_device *hid = to_hid_device(dev);
628
629 hid_close_report(hid);
630 kfree(hid->dev_rdesc);
631 kfree(hid);
632}
633
634/*
635 * Fetch a report description item from the data stream. We support long
636 * items, though they are not used yet.
637 */
638
639static u8 *fetch_item(__u8 *start, __u8 *end, struct hid_item *item)
640{
641 u8 b;
642
643 if ((end - start) <= 0)
644 return NULL;
645
646 b = *start++;
647
648 item->type = (b >> 2) & 3;
649 item->tag = (b >> 4) & 15;
650
651 if (item->tag == HID_ITEM_TAG_LONG) {
652
653 item->format = HID_ITEM_FORMAT_LONG;
654
655 if ((end - start) < 2)
656 return NULL;
657
658 item->size = *start++;
659 item->tag = *start++;
660
661 if ((end - start) < item->size)
662 return NULL;
663
664 item->data.longdata = start;
665 start += item->size;
666 return start;
667 }
668
669 item->format = HID_ITEM_FORMAT_SHORT;
670 item->size = b & 3;
671
672 switch (item->size) {
673 case 0:
674 return start;
675
676 case 1:
677 if ((end - start) < 1)
678 return NULL;
679 item->data.u8 = *start++;
680 return start;
681
682 case 2:
683 if ((end - start) < 2)
684 return NULL;
685 item->data.u16 = get_unaligned_le16(start);
686 start = (__u8 *)((__le16 *)start + 1);
687 return start;
688
689 case 3:
690 item->size++;
691 if ((end - start) < 4)
692 return NULL;
693 item->data.u32 = get_unaligned_le32(start);
694 start = (__u8 *)((__le32 *)start + 1);
695 return start;
696 }
697
698 return NULL;
699}
700
701static void hid_scan_input_usage(struct hid_parser *parser, u32 usage)
702{
703 struct hid_device *hid = parser->device;
704
705 if (usage == HID_DG_CONTACTID)
706 hid->group = HID_GROUP_MULTITOUCH;
707}
708
709static void hid_scan_feature_usage(struct hid_parser *parser, u32 usage)
710{
711 if (usage == 0xff0000c5 && parser->global.report_count == 256 &&
712 parser->global.report_size == 8)
713 parser->scan_flags |= HID_SCAN_FLAG_MT_WIN_8;
714}
715
716static void hid_scan_collection(struct hid_parser *parser, unsigned type)
717{
718 struct hid_device *hid = parser->device;
719 int i;
720
721 if (((parser->global.usage_page << 16) == HID_UP_SENSOR) &&
722 type == HID_COLLECTION_PHYSICAL)
723 hid->group = HID_GROUP_SENSOR_HUB;
724
725 if (hid->vendor == USB_VENDOR_ID_MICROSOFT &&
726 hid->product == USB_DEVICE_ID_MS_POWER_COVER &&
727 hid->group == HID_GROUP_MULTITOUCH)
728 hid->group = HID_GROUP_GENERIC;
729
730 if ((parser->global.usage_page << 16) == HID_UP_GENDESK)
731 for (i = 0; i < parser->local.usage_index; i++)
732 if (parser->local.usage[i] == HID_GD_POINTER)
733 parser->scan_flags |= HID_SCAN_FLAG_GD_POINTER;
734
735 if ((parser->global.usage_page << 16) >= HID_UP_MSVENDOR)
736 parser->scan_flags |= HID_SCAN_FLAG_VENDOR_SPECIFIC;
737}
738
739static int hid_scan_main(struct hid_parser *parser, struct hid_item *item)
740{
741 __u32 data;
742 int i;
743
744 data = item_udata(item);
745
746 switch (item->tag) {
747 case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION:
748 hid_scan_collection(parser, data & 0xff);
749 break;
750 case HID_MAIN_ITEM_TAG_END_COLLECTION:
751 break;
752 case HID_MAIN_ITEM_TAG_INPUT:
753 /* ignore constant inputs, they will be ignored by hid-input */
754 if (data & HID_MAIN_ITEM_CONSTANT)
755 break;
756 for (i = 0; i < parser->local.usage_index; i++)
757 hid_scan_input_usage(parser, parser->local.usage[i]);
758 break;
759 case HID_MAIN_ITEM_TAG_OUTPUT:
760 break;
761 case HID_MAIN_ITEM_TAG_FEATURE:
762 for (i = 0; i < parser->local.usage_index; i++)
763 hid_scan_feature_usage(parser, parser->local.usage[i]);
764 break;
765 }
766
767 /* Reset the local parser environment */
768 memset(&parser->local, 0, sizeof(parser->local));
769
770 return 0;
771}
772
773/*
774 * Scan a report descriptor before the device is added to the bus.
775 * Sets device groups and other properties that determine what driver
776 * to load.
777 */
778static int hid_scan_report(struct hid_device *hid)
779{
780 struct hid_parser *parser;
781 struct hid_item item;
782 __u8 *start = hid->dev_rdesc;
783 __u8 *end = start + hid->dev_rsize;
784 static int (*dispatch_type[])(struct hid_parser *parser,
785 struct hid_item *item) = {
786 hid_scan_main,
787 hid_parser_global,
788 hid_parser_local,
789 hid_parser_reserved
790 };
791
792 parser = vzalloc(sizeof(struct hid_parser));
793 if (!parser)
794 return -ENOMEM;
795
796 parser->device = hid;
797 hid->group = HID_GROUP_GENERIC;
798
799 /*
800 * The parsing is simpler than the one in hid_open_report() as we should
801 * be robust against hid errors. Those errors will be raised by
802 * hid_open_report() anyway.
803 */
804 while ((start = fetch_item(start, end, &item)) != NULL)
805 dispatch_type[item.type](parser, &item);
806
807 /*
808 * Handle special flags set during scanning.
809 */
810 if ((parser->scan_flags & HID_SCAN_FLAG_MT_WIN_8) &&
811 (hid->group == HID_GROUP_MULTITOUCH))
812 hid->group = HID_GROUP_MULTITOUCH_WIN_8;
813
814 /*
815 * Vendor specific handlings
816 */
817 switch (hid->vendor) {
818 case USB_VENDOR_ID_WACOM:
819 hid->group = HID_GROUP_WACOM;
820 break;
821 case USB_VENDOR_ID_SYNAPTICS:
822 if (hid->group == HID_GROUP_GENERIC)
823 if ((parser->scan_flags & HID_SCAN_FLAG_VENDOR_SPECIFIC)
824 && (parser->scan_flags & HID_SCAN_FLAG_GD_POINTER))
825 /*
826 * hid-rmi should take care of them,
827 * not hid-generic
828 */
829 hid->group = HID_GROUP_RMI;
830 break;
831 }
832
833 vfree(parser);
834 return 0;
835}
836
837/**
838 * hid_parse_report - parse device report
839 *
840 * @device: hid device
841 * @start: report start
842 * @size: report size
843 *
844 * Allocate the device report as read by the bus driver. This function should
845 * only be called from parse() in ll drivers.
846 */
847int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size)
848{
849 hid->dev_rdesc = kmemdup(start, size, GFP_KERNEL);
850 if (!hid->dev_rdesc)
851 return -ENOMEM;
852 hid->dev_rsize = size;
853 return 0;
854}
855EXPORT_SYMBOL_GPL(hid_parse_report);
856
857static const char * const hid_report_names[] = {
858 "HID_INPUT_REPORT",
859 "HID_OUTPUT_REPORT",
860 "HID_FEATURE_REPORT",
861};
862/**
863 * hid_validate_values - validate existing device report's value indexes
864 *
865 * @device: hid device
866 * @type: which report type to examine
867 * @id: which report ID to examine (0 for first)
868 * @field_index: which report field to examine
869 * @report_counts: expected number of values
870 *
871 * Validate the number of values in a given field of a given report, after
872 * parsing.
873 */
874struct hid_report *hid_validate_values(struct hid_device *hid,
875 unsigned int type, unsigned int id,
876 unsigned int field_index,
877 unsigned int report_counts)
878{
879 struct hid_report *report;
880
881 if (type > HID_FEATURE_REPORT) {
882 hid_err(hid, "invalid HID report type %u\n", type);
883 return NULL;
884 }
885
886 if (id >= HID_MAX_IDS) {
887 hid_err(hid, "invalid HID report id %u\n", id);
888 return NULL;
889 }
890
891 /*
892 * Explicitly not using hid_get_report() here since it depends on
893 * ->numbered being checked, which may not always be the case when
894 * drivers go to access report values.
895 */
896 if (id == 0) {
897 /*
898 * Validating on id 0 means we should examine the first
899 * report in the list.
900 */
901 report = list_entry(
902 hid->report_enum[type].report_list.next,
903 struct hid_report, list);
904 } else {
905 report = hid->report_enum[type].report_id_hash[id];
906 }
907 if (!report) {
908 hid_err(hid, "missing %s %u\n", hid_report_names[type], id);
909 return NULL;
910 }
911 if (report->maxfield <= field_index) {
912 hid_err(hid, "not enough fields in %s %u\n",
913 hid_report_names[type], id);
914 return NULL;
915 }
916 if (report->field[field_index]->report_count < report_counts) {
917 hid_err(hid, "not enough values in %s %u field %u\n",
918 hid_report_names[type], id, field_index);
919 return NULL;
920 }
921 return report;
922}
923EXPORT_SYMBOL_GPL(hid_validate_values);
924
925/**
926 * hid_open_report - open a driver-specific device report
927 *
928 * @device: hid device
929 *
930 * Parse a report description into a hid_device structure. Reports are
931 * enumerated, fields are attached to these reports.
932 * 0 returned on success, otherwise nonzero error value.
933 *
934 * This function (or the equivalent hid_parse() macro) should only be
935 * called from probe() in drivers, before starting the device.
936 */
937int hid_open_report(struct hid_device *device)
938{
939 struct hid_parser *parser;
940 struct hid_item item;
941 unsigned int size;
942 __u8 *start;
943 __u8 *buf;
944 __u8 *end;
945 int ret;
946 static int (*dispatch_type[])(struct hid_parser *parser,
947 struct hid_item *item) = {
948 hid_parser_main,
949 hid_parser_global,
950 hid_parser_local,
951 hid_parser_reserved
952 };
953
954 if (WARN_ON(device->status & HID_STAT_PARSED))
955 return -EBUSY;
956
957 start = device->dev_rdesc;
958 if (WARN_ON(!start))
959 return -ENODEV;
960 size = device->dev_rsize;
961
962 buf = kmemdup(start, size, GFP_KERNEL);
963 if (buf == NULL)
964 return -ENOMEM;
965
966 if (device->driver->report_fixup)
967 start = device->driver->report_fixup(device, buf, &size);
968 else
969 start = buf;
970
971 start = kmemdup(start, size, GFP_KERNEL);
972 kfree(buf);
973 if (start == NULL)
974 return -ENOMEM;
975
976 device->rdesc = start;
977 device->rsize = size;
978
979 parser = vzalloc(sizeof(struct hid_parser));
980 if (!parser) {
981 ret = -ENOMEM;
982 goto err;
983 }
984
985 parser->device = device;
986
987 end = start + size;
988
989 device->collection = kcalloc(HID_DEFAULT_NUM_COLLECTIONS,
990 sizeof(struct hid_collection), GFP_KERNEL);
991 if (!device->collection) {
992 ret = -ENOMEM;
993 goto err;
994 }
995 device->collection_size = HID_DEFAULT_NUM_COLLECTIONS;
996
997 ret = -EINVAL;
998 while ((start = fetch_item(start, end, &item)) != NULL) {
999
1000 if (item.format != HID_ITEM_FORMAT_SHORT) {
1001 hid_err(device, "unexpected long global item\n");
1002 goto err;
1003 }
1004
1005 if (dispatch_type[item.type](parser, &item)) {
1006 hid_err(device, "item %u %u %u %u parsing failed\n",
1007 item.format, (unsigned)item.size,
1008 (unsigned)item.type, (unsigned)item.tag);
1009 goto err;
1010 }
1011
1012 if (start == end) {
1013 if (parser->collection_stack_ptr) {
1014 hid_err(device, "unbalanced collection at end of report description\n");
1015 goto err;
1016 }
1017 if (parser->local.delimiter_depth) {
1018 hid_err(device, "unbalanced delimiter at end of report description\n");
1019 goto err;
1020 }
1021 vfree(parser);
1022 device->status |= HID_STAT_PARSED;
1023 return 0;
1024 }
1025 }
1026
1027 hid_err(device, "item fetching failed at offset %d\n", (int)(end - start));
1028err:
1029 vfree(parser);
1030 hid_close_report(device);
1031 return ret;
1032}
1033EXPORT_SYMBOL_GPL(hid_open_report);
1034
1035/*
1036 * Convert a signed n-bit integer to signed 32-bit integer. Common
1037 * cases are done through the compiler, the screwed things has to be
1038 * done by hand.
1039 */
1040
1041static s32 snto32(__u32 value, unsigned n)
1042{
1043 switch (n) {
1044 case 8: return ((__s8)value);
1045 case 16: return ((__s16)value);
1046 case 32: return ((__s32)value);
1047 }
1048 return value & (1 << (n - 1)) ? value | (~0U << n) : value;
1049}
1050
1051s32 hid_snto32(__u32 value, unsigned n)
1052{
1053 return snto32(value, n);
1054}
1055EXPORT_SYMBOL_GPL(hid_snto32);
1056
1057/*
1058 * Convert a signed 32-bit integer to a signed n-bit integer.
1059 */
1060
1061static u32 s32ton(__s32 value, unsigned n)
1062{
1063 s32 a = value >> (n - 1);
1064 if (a && a != -1)
1065 return value < 0 ? 1 << (n - 1) : (1 << (n - 1)) - 1;
1066 return value & ((1 << n) - 1);
1067}
1068
1069/*
1070 * Extract/implement a data field from/to a little endian report (bit array).
1071 *
1072 * Code sort-of follows HID spec:
1073 * http://www.usb.org/developers/hidpage/HID1_11.pdf
1074 *
1075 * While the USB HID spec allows unlimited length bit fields in "report
1076 * descriptors", most devices never use more than 16 bits.
1077 * One model of UPS is claimed to report "LINEV" as a 32-bit field.
1078 * Search linux-kernel and linux-usb-devel archives for "hid-core extract".
1079 */
1080
1081static u32 __extract(u8 *report, unsigned offset, int n)
1082{
1083 unsigned int idx = offset / 8;
1084 unsigned int bit_nr = 0;
1085 unsigned int bit_shift = offset % 8;
1086 int bits_to_copy = 8 - bit_shift;
1087 u32 value = 0;
1088 u32 mask = n < 32 ? (1U << n) - 1 : ~0U;
1089
1090 while (n > 0) {
1091 value |= ((u32)report[idx] >> bit_shift) << bit_nr;
1092 n -= bits_to_copy;
1093 bit_nr += bits_to_copy;
1094 bits_to_copy = 8;
1095 bit_shift = 0;
1096 idx++;
1097 }
1098
1099 return value & mask;
1100}
1101
1102u32 hid_field_extract(const struct hid_device *hid, u8 *report,
1103 unsigned offset, unsigned n)
1104{
1105 if (n > 32) {
1106 hid_warn(hid, "hid_field_extract() called with n (%d) > 32! (%s)\n",
1107 n, current->comm);
1108 n = 32;
1109 }
1110
1111 return __extract(report, offset, n);
1112}
1113EXPORT_SYMBOL_GPL(hid_field_extract);
1114
1115/*
1116 * "implement" : set bits in a little endian bit stream.
1117 * Same concepts as "extract" (see comments above).
1118 * The data mangled in the bit stream remains in little endian
1119 * order the whole time. It make more sense to talk about
1120 * endianness of register values by considering a register
1121 * a "cached" copy of the little endian bit stream.
1122 */
1123
1124static void __implement(u8 *report, unsigned offset, int n, u32 value)
1125{
1126 unsigned int idx = offset / 8;
1127 unsigned int bit_shift = offset % 8;
1128 int bits_to_set = 8 - bit_shift;
1129
1130 while (n - bits_to_set >= 0) {
1131 report[idx] &= ~(0xff << bit_shift);
1132 report[idx] |= value << bit_shift;
1133 value >>= bits_to_set;
1134 n -= bits_to_set;
1135 bits_to_set = 8;
1136 bit_shift = 0;
1137 idx++;
1138 }
1139
1140 /* last nibble */
1141 if (n) {
1142 u8 bit_mask = ((1U << n) - 1);
1143 report[idx] &= ~(bit_mask << bit_shift);
1144 report[idx] |= value << bit_shift;
1145 }
1146}
1147
1148static void implement(const struct hid_device *hid, u8 *report,
1149 unsigned offset, unsigned n, u32 value)
1150{
1151 if (unlikely(n > 32)) {
1152 hid_warn(hid, "%s() called with n (%d) > 32! (%s)\n",
1153 __func__, n, current->comm);
1154 n = 32;
1155 } else if (n < 32) {
1156 u32 m = (1U << n) - 1;
1157
1158 if (unlikely(value > m)) {
1159 hid_warn(hid,
1160 "%s() called with too large value %d (n: %d)! (%s)\n",
1161 __func__, value, n, current->comm);
1162 WARN_ON(1);
1163 value &= m;
1164 }
1165 }
1166
1167 __implement(report, offset, n, value);
1168}
1169
1170/*
1171 * Search an array for a value.
1172 */
1173
1174static int search(__s32 *array, __s32 value, unsigned n)
1175{
1176 while (n--) {
1177 if (*array++ == value)
1178 return 0;
1179 }
1180 return -1;
1181}
1182
1183/**
1184 * hid_match_report - check if driver's raw_event should be called
1185 *
1186 * @hid: hid device
1187 * @report_type: type to match against
1188 *
1189 * compare hid->driver->report_table->report_type to report->type
1190 */
1191static int hid_match_report(struct hid_device *hid, struct hid_report *report)
1192{
1193 const struct hid_report_id *id = hid->driver->report_table;
1194
1195 if (!id) /* NULL means all */
1196 return 1;
1197
1198 for (; id->report_type != HID_TERMINATOR; id++)
1199 if (id->report_type == HID_ANY_ID ||
1200 id->report_type == report->type)
1201 return 1;
1202 return 0;
1203}
1204
1205/**
1206 * hid_match_usage - check if driver's event should be called
1207 *
1208 * @hid: hid device
1209 * @usage: usage to match against
1210 *
1211 * compare hid->driver->usage_table->usage_{type,code} to
1212 * usage->usage_{type,code}
1213 */
1214static int hid_match_usage(struct hid_device *hid, struct hid_usage *usage)
1215{
1216 const struct hid_usage_id *id = hid->driver->usage_table;
1217
1218 if (!id) /* NULL means all */
1219 return 1;
1220
1221 for (; id->usage_type != HID_ANY_ID - 1; id++)
1222 if ((id->usage_hid == HID_ANY_ID ||
1223 id->usage_hid == usage->hid) &&
1224 (id->usage_type == HID_ANY_ID ||
1225 id->usage_type == usage->type) &&
1226 (id->usage_code == HID_ANY_ID ||
1227 id->usage_code == usage->code))
1228 return 1;
1229 return 0;
1230}
1231
1232static void hid_process_event(struct hid_device *hid, struct hid_field *field,
1233 struct hid_usage *usage, __s32 value, int interrupt)
1234{
1235 struct hid_driver *hdrv = hid->driver;
1236 int ret;
1237
1238 if (!list_empty(&hid->debug_list))
1239 hid_dump_input(hid, usage, value);
1240
1241 if (hdrv && hdrv->event && hid_match_usage(hid, usage)) {
1242 ret = hdrv->event(hid, field, usage, value);
1243 if (ret != 0) {
1244 if (ret < 0)
1245 hid_err(hid, "%s's event failed with %d\n",
1246 hdrv->name, ret);
1247 return;
1248 }
1249 }
1250
1251 if (hid->claimed & HID_CLAIMED_INPUT)
1252 hidinput_hid_event(hid, field, usage, value);
1253 if (hid->claimed & HID_CLAIMED_HIDDEV && interrupt && hid->hiddev_hid_event)
1254 hid->hiddev_hid_event(hid, field, usage, value);
1255}
1256
1257/*
1258 * Analyse a received field, and fetch the data from it. The field
1259 * content is stored for next report processing (we do differential
1260 * reporting to the layer).
1261 */
1262
1263static void hid_input_field(struct hid_device *hid, struct hid_field *field,
1264 __u8 *data, int interrupt)
1265{
1266 unsigned n;
1267 unsigned count = field->report_count;
1268 unsigned offset = field->report_offset;
1269 unsigned size = field->report_size;
1270 __s32 min = field->logical_minimum;
1271 __s32 max = field->logical_maximum;
1272 __s32 *value;
1273
1274 value = kmalloc(sizeof(__s32) * count, GFP_ATOMIC);
1275 if (!value)
1276 return;
1277
1278 for (n = 0; n < count; n++) {
1279
1280 value[n] = min < 0 ?
1281 snto32(hid_field_extract(hid, data, offset + n * size,
1282 size), size) :
1283 hid_field_extract(hid, data, offset + n * size, size);
1284
1285 /* Ignore report if ErrorRollOver */
1286 if (!(field->flags & HID_MAIN_ITEM_VARIABLE) &&
1287 value[n] >= min && value[n] <= max &&
1288 value[n] - min < field->maxusage &&
1289 field->usage[value[n] - min].hid == HID_UP_KEYBOARD + 1)
1290 goto exit;
1291 }
1292
1293 for (n = 0; n < count; n++) {
1294
1295 if (HID_MAIN_ITEM_VARIABLE & field->flags) {
1296 hid_process_event(hid, field, &field->usage[n], value[n], interrupt);
1297 continue;
1298 }
1299
1300 if (field->value[n] >= min && field->value[n] <= max
1301 && field->value[n] - min < field->maxusage
1302 && field->usage[field->value[n] - min].hid
1303 && search(value, field->value[n], count))
1304 hid_process_event(hid, field, &field->usage[field->value[n] - min], 0, interrupt);
1305
1306 if (value[n] >= min && value[n] <= max
1307 && value[n] - min < field->maxusage
1308 && field->usage[value[n] - min].hid
1309 && search(field->value, value[n], count))
1310 hid_process_event(hid, field, &field->usage[value[n] - min], 1, interrupt);
1311 }
1312
1313 memcpy(field->value, value, count * sizeof(__s32));
1314exit:
1315 kfree(value);
1316}
1317
1318/*
1319 * Output the field into the report.
1320 */
1321
1322static void hid_output_field(const struct hid_device *hid,
1323 struct hid_field *field, __u8 *data)
1324{
1325 unsigned count = field->report_count;
1326 unsigned offset = field->report_offset;
1327 unsigned size = field->report_size;
1328 unsigned n;
1329
1330 for (n = 0; n < count; n++) {
1331 if (field->logical_minimum < 0) /* signed values */
1332 implement(hid, data, offset + n * size, size,
1333 s32ton(field->value[n], size));
1334 else /* unsigned values */
1335 implement(hid, data, offset + n * size, size,
1336 field->value[n]);
1337 }
1338}
1339
1340/*
1341 * Create a report. 'data' has to be allocated using
1342 * hid_alloc_report_buf() so that it has proper size.
1343 */
1344
1345void hid_output_report(struct hid_report *report, __u8 *data)
1346{
1347 unsigned n;
1348
1349 if (report->id > 0)
1350 *data++ = report->id;
1351
1352 memset(data, 0, ((report->size - 1) >> 3) + 1);
1353 for (n = 0; n < report->maxfield; n++)
1354 hid_output_field(report->device, report->field[n], data);
1355}
1356EXPORT_SYMBOL_GPL(hid_output_report);
1357
1358/*
1359 * Allocator for buffer that is going to be passed to hid_output_report()
1360 */
1361u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags)
1362{
1363 /*
1364 * 7 extra bytes are necessary to achieve proper functionality
1365 * of implement() working on 8 byte chunks
1366 */
1367
1368 u32 len = hid_report_len(report) + 7;
1369
1370 return kmalloc(len, flags);
1371}
1372EXPORT_SYMBOL_GPL(hid_alloc_report_buf);
1373
1374/*
1375 * Set a field value. The report this field belongs to has to be
1376 * created and transferred to the device, to set this value in the
1377 * device.
1378 */
1379
1380int hid_set_field(struct hid_field *field, unsigned offset, __s32 value)
1381{
1382 unsigned size;
1383
1384 if (!field)
1385 return -1;
1386
1387 size = field->report_size;
1388
1389 hid_dump_input(field->report->device, field->usage + offset, value);
1390
1391 if (offset >= field->report_count) {
1392 hid_err(field->report->device, "offset (%d) exceeds report_count (%d)\n",
1393 offset, field->report_count);
1394 return -1;
1395 }
1396 if (field->logical_minimum < 0) {
1397 if (value != snto32(s32ton(value, size), size)) {
1398 hid_err(field->report->device, "value %d is out of range\n", value);
1399 return -1;
1400 }
1401 }
1402 field->value[offset] = value;
1403 return 0;
1404}
1405EXPORT_SYMBOL_GPL(hid_set_field);
1406
1407static struct hid_report *hid_get_report(struct hid_report_enum *report_enum,
1408 const u8 *data)
1409{
1410 struct hid_report *report;
1411 unsigned int n = 0; /* Normally report number is 0 */
1412
1413 /* Device uses numbered reports, data[0] is report number */
1414 if (report_enum->numbered)
1415 n = *data;
1416
1417 report = report_enum->report_id_hash[n];
1418 if (report == NULL)
1419 dbg_hid("undefined report_id %u received\n", n);
1420
1421 return report;
1422}
1423
1424/*
1425 * Implement a generic .request() callback, using .raw_request()
1426 * DO NOT USE in hid drivers directly, but through hid_hw_request instead.
1427 */
1428void __hid_request(struct hid_device *hid, struct hid_report *report,
1429 int reqtype)
1430{
1431 char *buf;
1432 int ret;
1433 u32 len;
1434
1435 buf = hid_alloc_report_buf(report, GFP_KERNEL);
1436 if (!buf)
1437 return;
1438
1439 len = hid_report_len(report);
1440
1441 if (reqtype == HID_REQ_SET_REPORT)
1442 hid_output_report(report, buf);
1443
1444 ret = hid->ll_driver->raw_request(hid, report->id, buf, len,
1445 report->type, reqtype);
1446 if (ret < 0) {
1447 dbg_hid("unable to complete request: %d\n", ret);
1448 goto out;
1449 }
1450
1451 if (reqtype == HID_REQ_GET_REPORT)
1452 hid_input_report(hid, report->type, buf, ret, 0);
1453
1454out:
1455 kfree(buf);
1456}
1457EXPORT_SYMBOL_GPL(__hid_request);
1458
1459int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, u32 size,
1460 int interrupt)
1461{
1462 struct hid_report_enum *report_enum = hid->report_enum + type;
1463 struct hid_report *report;
1464 struct hid_driver *hdrv;
1465 unsigned int a;
1466 u32 rsize, csize = size;
1467 u8 *cdata = data;
1468 int ret = 0;
1469
1470 report = hid_get_report(report_enum, data);
1471 if (!report)
1472 goto out;
1473
1474 if (report_enum->numbered) {
1475 cdata++;
1476 csize--;
1477 }
1478
1479 rsize = ((report->size - 1) >> 3) + 1;
1480
1481 if (rsize > HID_MAX_BUFFER_SIZE)
1482 rsize = HID_MAX_BUFFER_SIZE;
1483
1484 if (csize < rsize) {
1485 dbg_hid("report %d is too short, (%d < %d)\n", report->id,
1486 csize, rsize);
1487 memset(cdata + csize, 0, rsize - csize);
1488 }
1489
1490 if ((hid->claimed & HID_CLAIMED_HIDDEV) && hid->hiddev_report_event)
1491 hid->hiddev_report_event(hid, report);
1492 if (hid->claimed & HID_CLAIMED_HIDRAW) {
1493 ret = hidraw_report_event(hid, data, size);
1494 if (ret)
1495 goto out;
1496 }
1497
1498 if (hid->claimed != HID_CLAIMED_HIDRAW && report->maxfield) {
1499 for (a = 0; a < report->maxfield; a++)
1500 hid_input_field(hid, report->field[a], cdata, interrupt);
1501 hdrv = hid->driver;
1502 if (hdrv && hdrv->report)
1503 hdrv->report(hid, report);
1504 }
1505
1506 if (hid->claimed & HID_CLAIMED_INPUT)
1507 hidinput_report_event(hid, report);
1508out:
1509 return ret;
1510}
1511EXPORT_SYMBOL_GPL(hid_report_raw_event);
1512
1513/**
1514 * hid_input_report - report data from lower layer (usb, bt...)
1515 *
1516 * @hid: hid device
1517 * @type: HID report type (HID_*_REPORT)
1518 * @data: report contents
1519 * @size: size of data parameter
1520 * @interrupt: distinguish between interrupt and control transfers
1521 *
1522 * This is data entry for lower layers.
1523 */
1524int hid_input_report(struct hid_device *hid, int type, u8 *data, u32 size, int interrupt)
1525{
1526 struct hid_report_enum *report_enum;
1527 struct hid_driver *hdrv;
1528 struct hid_report *report;
1529 int ret = 0;
1530
1531 if (!hid)
1532 return -ENODEV;
1533
1534 if (down_trylock(&hid->driver_input_lock))
1535 return -EBUSY;
1536
1537 if (!hid->driver) {
1538 ret = -ENODEV;
1539 goto unlock;
1540 }
1541 report_enum = hid->report_enum + type;
1542 hdrv = hid->driver;
1543
1544 if (!size) {
1545 dbg_hid("empty report\n");
1546 ret = -1;
1547 goto unlock;
1548 }
1549
1550 /* Avoid unnecessary overhead if debugfs is disabled */
1551 if (!list_empty(&hid->debug_list))
1552 hid_dump_report(hid, type, data, size);
1553
1554 report = hid_get_report(report_enum, data);
1555
1556 if (!report) {
1557 ret = -1;
1558 goto unlock;
1559 }
1560
1561 if (hdrv && hdrv->raw_event && hid_match_report(hid, report)) {
1562 ret = hdrv->raw_event(hid, report, data, size);
1563 if (ret < 0)
1564 goto unlock;
1565 }
1566
1567 ret = hid_report_raw_event(hid, type, data, size, interrupt);
1568
1569unlock:
1570 up(&hid->driver_input_lock);
1571 return ret;
1572}
1573EXPORT_SYMBOL_GPL(hid_input_report);
1574
1575bool hid_match_one_id(const struct hid_device *hdev,
1576 const struct hid_device_id *id)
1577{
1578 return (id->bus == HID_BUS_ANY || id->bus == hdev->bus) &&
1579 (id->group == HID_GROUP_ANY || id->group == hdev->group) &&
1580 (id->vendor == HID_ANY_ID || id->vendor == hdev->vendor) &&
1581 (id->product == HID_ANY_ID || id->product == hdev->product);
1582}
1583
1584const struct hid_device_id *hid_match_id(const struct hid_device *hdev,
1585 const struct hid_device_id *id)
1586{
1587 for (; id->bus; id++)
1588 if (hid_match_one_id(hdev, id))
1589 return id;
1590
1591 return NULL;
1592}
1593
1594static const struct hid_device_id hid_hiddev_list[] = {
1595 { HID_USB_DEVICE(USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS) },
1596 { HID_USB_DEVICE(USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS1) },
1597 { }
1598};
1599
1600static bool hid_hiddev(struct hid_device *hdev)
1601{
1602 return !!hid_match_id(hdev, hid_hiddev_list);
1603}
1604
1605
1606static ssize_t
1607read_report_descriptor(struct file *filp, struct kobject *kobj,
1608 struct bin_attribute *attr,
1609 char *buf, loff_t off, size_t count)
1610{
1611 struct device *dev = kobj_to_dev(kobj);
1612 struct hid_device *hdev = to_hid_device(dev);
1613
1614 if (off >= hdev->rsize)
1615 return 0;
1616
1617 if (off + count > hdev->rsize)
1618 count = hdev->rsize - off;
1619
1620 memcpy(buf, hdev->rdesc + off, count);
1621
1622 return count;
1623}
1624
1625static ssize_t
1626show_country(struct device *dev, struct device_attribute *attr,
1627 char *buf)
1628{
1629 struct hid_device *hdev = to_hid_device(dev);
1630
1631 return sprintf(buf, "%02x\n", hdev->country & 0xff);
1632}
1633
1634static struct bin_attribute dev_bin_attr_report_desc = {
1635 .attr = { .name = "report_descriptor", .mode = 0444 },
1636 .read = read_report_descriptor,
1637 .size = HID_MAX_DESCRIPTOR_SIZE,
1638};
1639
1640static const struct device_attribute dev_attr_country = {
1641 .attr = { .name = "country", .mode = 0444 },
1642 .show = show_country,
1643};
1644
1645int hid_connect(struct hid_device *hdev, unsigned int connect_mask)
1646{
1647 static const char *types[] = { "Device", "Pointer", "Mouse", "Device",
1648 "Joystick", "Gamepad", "Keyboard", "Keypad",
1649 "Multi-Axis Controller"
1650 };
1651 const char *type, *bus;
1652 char buf[64] = "";
1653 unsigned int i;
1654 int len;
1655 int ret;
1656
1657 if (hdev->quirks & HID_QUIRK_HIDDEV_FORCE)
1658 connect_mask |= (HID_CONNECT_HIDDEV_FORCE | HID_CONNECT_HIDDEV);
1659 if (hdev->quirks & HID_QUIRK_HIDINPUT_FORCE)
1660 connect_mask |= HID_CONNECT_HIDINPUT_FORCE;
1661 if (hdev->bus != BUS_USB)
1662 connect_mask &= ~HID_CONNECT_HIDDEV;
1663 if (hid_hiddev(hdev))
1664 connect_mask |= HID_CONNECT_HIDDEV_FORCE;
1665
1666 if ((connect_mask & HID_CONNECT_HIDINPUT) && !hidinput_connect(hdev,
1667 connect_mask & HID_CONNECT_HIDINPUT_FORCE))
1668 hdev->claimed |= HID_CLAIMED_INPUT;
1669
1670 if ((connect_mask & HID_CONNECT_HIDDEV) && hdev->hiddev_connect &&
1671 !hdev->hiddev_connect(hdev,
1672 connect_mask & HID_CONNECT_HIDDEV_FORCE))
1673 hdev->claimed |= HID_CLAIMED_HIDDEV;
1674 if ((connect_mask & HID_CONNECT_HIDRAW) && !hidraw_connect(hdev))
1675 hdev->claimed |= HID_CLAIMED_HIDRAW;
1676
1677 if (connect_mask & HID_CONNECT_DRIVER)
1678 hdev->claimed |= HID_CLAIMED_DRIVER;
1679
1680 /* Drivers with the ->raw_event callback set are not required to connect
1681 * to any other listener. */
1682 if (!hdev->claimed && !hdev->driver->raw_event) {
1683 hid_err(hdev, "device has no listeners, quitting\n");
1684 return -ENODEV;
1685 }
1686
1687 if ((hdev->claimed & HID_CLAIMED_INPUT) &&
1688 (connect_mask & HID_CONNECT_FF) && hdev->ff_init)
1689 hdev->ff_init(hdev);
1690
1691 len = 0;
1692 if (hdev->claimed & HID_CLAIMED_INPUT)
1693 len += sprintf(buf + len, "input");
1694 if (hdev->claimed & HID_CLAIMED_HIDDEV)
1695 len += sprintf(buf + len, "%shiddev%d", len ? "," : "",
1696 ((struct hiddev *)hdev->hiddev)->minor);
1697 if (hdev->claimed & HID_CLAIMED_HIDRAW)
1698 len += sprintf(buf + len, "%shidraw%d", len ? "," : "",
1699 ((struct hidraw *)hdev->hidraw)->minor);
1700
1701 type = "Device";
1702 for (i = 0; i < hdev->maxcollection; i++) {
1703 struct hid_collection *col = &hdev->collection[i];
1704 if (col->type == HID_COLLECTION_APPLICATION &&
1705 (col->usage & HID_USAGE_PAGE) == HID_UP_GENDESK &&
1706 (col->usage & 0xffff) < ARRAY_SIZE(types)) {
1707 type = types[col->usage & 0xffff];
1708 break;
1709 }
1710 }
1711
1712 switch (hdev->bus) {
1713 case BUS_USB:
1714 bus = "USB";
1715 break;
1716 case BUS_BLUETOOTH:
1717 bus = "BLUETOOTH";
1718 break;
1719 case BUS_I2C:
1720 bus = "I2C";
1721 break;
1722 default:
1723 bus = "<UNKNOWN>";
1724 }
1725
1726 ret = device_create_file(&hdev->dev, &dev_attr_country);
1727 if (ret)
1728 hid_warn(hdev,
1729 "can't create sysfs country code attribute err: %d\n", ret);
1730
1731 hid_info(hdev, "%s: %s HID v%x.%02x %s [%s] on %s\n",
1732 buf, bus, hdev->version >> 8, hdev->version & 0xff,
1733 type, hdev->name, hdev->phys);
1734
1735 return 0;
1736}
1737EXPORT_SYMBOL_GPL(hid_connect);
1738
1739void hid_disconnect(struct hid_device *hdev)
1740{
1741 device_remove_file(&hdev->dev, &dev_attr_country);
1742 if (hdev->claimed & HID_CLAIMED_INPUT)
1743 hidinput_disconnect(hdev);
1744 if (hdev->claimed & HID_CLAIMED_HIDDEV)
1745 hdev->hiddev_disconnect(hdev);
1746 if (hdev->claimed & HID_CLAIMED_HIDRAW)
1747 hidraw_disconnect(hdev);
1748 hdev->claimed = 0;
1749}
1750EXPORT_SYMBOL_GPL(hid_disconnect);
1751
1752/**
1753 * hid_hw_start - start underlying HW
1754 * @hdev: hid device
1755 * @connect_mask: which outputs to connect, see HID_CONNECT_*
1756 *
1757 * Call this in probe function *after* hid_parse. This will setup HW
1758 * buffers and start the device (if not defeirred to device open).
1759 * hid_hw_stop must be called if this was successful.
1760 */
1761int hid_hw_start(struct hid_device *hdev, unsigned int connect_mask)
1762{
1763 int error;
1764
1765 error = hdev->ll_driver->start(hdev);
1766 if (error)
1767 return error;
1768
1769 if (connect_mask) {
1770 error = hid_connect(hdev, connect_mask);
1771 if (error) {
1772 hdev->ll_driver->stop(hdev);
1773 return error;
1774 }
1775 }
1776
1777 return 0;
1778}
1779EXPORT_SYMBOL_GPL(hid_hw_start);
1780
1781/**
1782 * hid_hw_stop - stop underlying HW
1783 * @hdev: hid device
1784 *
1785 * This is usually called from remove function or from probe when something
1786 * failed and hid_hw_start was called already.
1787 */
1788void hid_hw_stop(struct hid_device *hdev)
1789{
1790 hid_disconnect(hdev);
1791 hdev->ll_driver->stop(hdev);
1792}
1793EXPORT_SYMBOL_GPL(hid_hw_stop);
1794
1795/**
1796 * hid_hw_open - signal underlying HW to start delivering events
1797 * @hdev: hid device
1798 *
1799 * Tell underlying HW to start delivering events from the device.
1800 * This function should be called sometime after successful call
1801 * to hid_hiw_start().
1802 */
1803int hid_hw_open(struct hid_device *hdev)
1804{
1805 int ret;
1806
1807 ret = mutex_lock_killable(&hdev->ll_open_lock);
1808 if (ret)
1809 return ret;
1810
1811 if (!hdev->ll_open_count++) {
1812 ret = hdev->ll_driver->open(hdev);
1813 if (ret)
1814 hdev->ll_open_count--;
1815 }
1816
1817 mutex_unlock(&hdev->ll_open_lock);
1818 return ret;
1819}
1820EXPORT_SYMBOL_GPL(hid_hw_open);
1821
1822/**
1823 * hid_hw_close - signal underlaying HW to stop delivering events
1824 *
1825 * @hdev: hid device
1826 *
1827 * This function indicates that we are not interested in the events
1828 * from this device anymore. Delivery of events may or may not stop,
1829 * depending on the number of users still outstanding.
1830 */
1831void hid_hw_close(struct hid_device *hdev)
1832{
1833 mutex_lock(&hdev->ll_open_lock);
1834 if (!--hdev->ll_open_count)
1835 hdev->ll_driver->close(hdev);
1836 mutex_unlock(&hdev->ll_open_lock);
1837}
1838EXPORT_SYMBOL_GPL(hid_hw_close);
1839
1840struct hid_dynid {
1841 struct list_head list;
1842 struct hid_device_id id;
1843};
1844
1845/**
1846 * store_new_id - add a new HID device ID to this driver and re-probe devices
1847 * @driver: target device driver
1848 * @buf: buffer for scanning device ID data
1849 * @count: input size
1850 *
1851 * Adds a new dynamic hid device ID to this driver,
1852 * and causes the driver to probe for all devices again.
1853 */
1854static ssize_t new_id_store(struct device_driver *drv, const char *buf,
1855 size_t count)
1856{
1857 struct hid_driver *hdrv = to_hid_driver(drv);
1858 struct hid_dynid *dynid;
1859 __u32 bus, vendor, product;
1860 unsigned long driver_data = 0;
1861 int ret;
1862
1863 ret = sscanf(buf, "%x %x %x %lx",
1864 &bus, &vendor, &product, &driver_data);
1865 if (ret < 3)
1866 return -EINVAL;
1867
1868 dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
1869 if (!dynid)
1870 return -ENOMEM;
1871
1872 dynid->id.bus = bus;
1873 dynid->id.group = HID_GROUP_ANY;
1874 dynid->id.vendor = vendor;
1875 dynid->id.product = product;
1876 dynid->id.driver_data = driver_data;
1877
1878 spin_lock(&hdrv->dyn_lock);
1879 list_add_tail(&dynid->list, &hdrv->dyn_list);
1880 spin_unlock(&hdrv->dyn_lock);
1881
1882 ret = driver_attach(&hdrv->driver);
1883
1884 return ret ? : count;
1885}
1886static DRIVER_ATTR_WO(new_id);
1887
1888static struct attribute *hid_drv_attrs[] = {
1889 &driver_attr_new_id.attr,
1890 NULL,
1891};
1892ATTRIBUTE_GROUPS(hid_drv);
1893
1894static void hid_free_dynids(struct hid_driver *hdrv)
1895{
1896 struct hid_dynid *dynid, *n;
1897
1898 spin_lock(&hdrv->dyn_lock);
1899 list_for_each_entry_safe(dynid, n, &hdrv->dyn_list, list) {
1900 list_del(&dynid->list);
1901 kfree(dynid);
1902 }
1903 spin_unlock(&hdrv->dyn_lock);
1904}
1905
1906const struct hid_device_id *hid_match_device(struct hid_device *hdev,
1907 struct hid_driver *hdrv)
1908{
1909 struct hid_dynid *dynid;
1910
1911 spin_lock(&hdrv->dyn_lock);
1912 list_for_each_entry(dynid, &hdrv->dyn_list, list) {
1913 if (hid_match_one_id(hdev, &dynid->id)) {
1914 spin_unlock(&hdrv->dyn_lock);
1915 return &dynid->id;
1916 }
1917 }
1918 spin_unlock(&hdrv->dyn_lock);
1919
1920 return hid_match_id(hdev, hdrv->id_table);
1921}
1922EXPORT_SYMBOL_GPL(hid_match_device);
1923
1924static int hid_bus_match(struct device *dev, struct device_driver *drv)
1925{
1926 struct hid_driver *hdrv = to_hid_driver(drv);
1927 struct hid_device *hdev = to_hid_device(dev);
1928
1929 return hid_match_device(hdev, hdrv) != NULL;
1930}
1931
1932static int hid_device_probe(struct device *dev)
1933{
1934 struct hid_driver *hdrv = to_hid_driver(dev->driver);
1935 struct hid_device *hdev = to_hid_device(dev);
1936 const struct hid_device_id *id;
1937 int ret = 0;
1938
1939 if (down_interruptible(&hdev->driver_input_lock)) {
1940 ret = -EINTR;
1941 goto end;
1942 }
1943 hdev->io_started = false;
1944
1945 if (!hdev->driver) {
1946 id = hid_match_device(hdev, hdrv);
1947 if (id == NULL) {
1948 ret = -ENODEV;
1949 goto unlock;
1950 }
1951
1952 if (hdrv->match) {
1953 if (!hdrv->match(hdev, hid_ignore_special_drivers)) {
1954 ret = -ENODEV;
1955 goto unlock;
1956 }
1957 } else {
1958 /*
1959 * hid-generic implements .match(), so if
1960 * hid_ignore_special_drivers is set, we can safely
1961 * return.
1962 */
1963 if (hid_ignore_special_drivers) {
1964 ret = -ENODEV;
1965 goto unlock;
1966 }
1967 }
1968
1969 /* reset the quirks that has been previously set */
1970 hdev->quirks = hid_lookup_quirk(hdev);
1971 hdev->driver = hdrv;
1972 if (hdrv->probe) {
1973 ret = hdrv->probe(hdev, id);
1974 } else { /* default probe */
1975 ret = hid_open_report(hdev);
1976 if (!ret)
1977 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
1978 }
1979 if (ret) {
1980 hid_close_report(hdev);
1981 hdev->driver = NULL;
1982 }
1983 }
1984unlock:
1985 if (!hdev->io_started)
1986 up(&hdev->driver_input_lock);
1987end:
1988 return ret;
1989}
1990
1991static int hid_device_remove(struct device *dev)
1992{
1993 struct hid_device *hdev = to_hid_device(dev);
1994 struct hid_driver *hdrv;
1995 int ret = 0;
1996
1997 if (down_interruptible(&hdev->driver_input_lock)) {
1998 ret = -EINTR;
1999 goto end;
2000 }
2001 hdev->io_started = false;
2002
2003 hdrv = hdev->driver;
2004 if (hdrv) {
2005 if (hdrv->remove)
2006 hdrv->remove(hdev);
2007 else /* default remove */
2008 hid_hw_stop(hdev);
2009 hid_close_report(hdev);
2010 hdev->driver = NULL;
2011 }
2012
2013 if (!hdev->io_started)
2014 up(&hdev->driver_input_lock);
2015end:
2016 return ret;
2017}
2018
2019static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
2020 char *buf)
2021{
2022 struct hid_device *hdev = container_of(dev, struct hid_device, dev);
2023
2024 return scnprintf(buf, PAGE_SIZE, "hid:b%04Xg%04Xv%08Xp%08X\n",
2025 hdev->bus, hdev->group, hdev->vendor, hdev->product);
2026}
2027static DEVICE_ATTR_RO(modalias);
2028
2029static struct attribute *hid_dev_attrs[] = {
2030 &dev_attr_modalias.attr,
2031 NULL,
2032};
2033static struct bin_attribute *hid_dev_bin_attrs[] = {
2034 &dev_bin_attr_report_desc,
2035 NULL
2036};
2037static const struct attribute_group hid_dev_group = {
2038 .attrs = hid_dev_attrs,
2039 .bin_attrs = hid_dev_bin_attrs,
2040};
2041__ATTRIBUTE_GROUPS(hid_dev);
2042
2043static int hid_uevent(struct device *dev, struct kobj_uevent_env *env)
2044{
2045 struct hid_device *hdev = to_hid_device(dev);
2046
2047 if (add_uevent_var(env, "HID_ID=%04X:%08X:%08X",
2048 hdev->bus, hdev->vendor, hdev->product))
2049 return -ENOMEM;
2050
2051 if (add_uevent_var(env, "HID_NAME=%s", hdev->name))
2052 return -ENOMEM;
2053
2054 if (add_uevent_var(env, "HID_PHYS=%s", hdev->phys))
2055 return -ENOMEM;
2056
2057 if (add_uevent_var(env, "HID_UNIQ=%s", hdev->uniq))
2058 return -ENOMEM;
2059
2060 if (add_uevent_var(env, "MODALIAS=hid:b%04Xg%04Xv%08Xp%08X",
2061 hdev->bus, hdev->group, hdev->vendor, hdev->product))
2062 return -ENOMEM;
2063
2064 return 0;
2065}
2066
2067struct bus_type hid_bus_type = {
2068 .name = "hid",
2069 .dev_groups = hid_dev_groups,
2070 .drv_groups = hid_drv_groups,
2071 .match = hid_bus_match,
2072 .probe = hid_device_probe,
2073 .remove = hid_device_remove,
2074 .uevent = hid_uevent,
2075};
2076EXPORT_SYMBOL(hid_bus_type);
2077
2078int hid_add_device(struct hid_device *hdev)
2079{
2080 static atomic_t id = ATOMIC_INIT(0);
2081 int ret;
2082
2083 if (WARN_ON(hdev->status & HID_STAT_ADDED))
2084 return -EBUSY;
2085
2086 hdev->quirks = hid_lookup_quirk(hdev);
2087
2088 /* we need to kill them here, otherwise they will stay allocated to
2089 * wait for coming driver */
2090 if (hid_ignore(hdev))
2091 return -ENODEV;
2092
2093 /*
2094 * Check for the mandatory transport channel.
2095 */
2096 if (!hdev->ll_driver->raw_request) {
2097 hid_err(hdev, "transport driver missing .raw_request()\n");
2098 return -EINVAL;
2099 }
2100
2101 /*
2102 * Read the device report descriptor once and use as template
2103 * for the driver-specific modifications.
2104 */
2105 ret = hdev->ll_driver->parse(hdev);
2106 if (ret)
2107 return ret;
2108 if (!hdev->dev_rdesc)
2109 return -ENODEV;
2110
2111 /*
2112 * Scan generic devices for group information
2113 */
2114 if (hid_ignore_special_drivers) {
2115 hdev->group = HID_GROUP_GENERIC;
2116 } else if (!hdev->group &&
2117 !(hdev->quirks & HID_QUIRK_HAVE_SPECIAL_DRIVER)) {
2118 ret = hid_scan_report(hdev);
2119 if (ret)
2120 hid_warn(hdev, "bad device descriptor (%d)\n", ret);
2121 }
2122
2123 /* XXX hack, any other cleaner solution after the driver core
2124 * is converted to allow more than 20 bytes as the device name? */
2125 dev_set_name(&hdev->dev, "%04X:%04X:%04X.%04X", hdev->bus,
2126 hdev->vendor, hdev->product, atomic_inc_return(&id));
2127
2128 hid_debug_register(hdev, dev_name(&hdev->dev));
2129 ret = device_add(&hdev->dev);
2130 if (!ret)
2131 hdev->status |= HID_STAT_ADDED;
2132 else
2133 hid_debug_unregister(hdev);
2134
2135 return ret;
2136}
2137EXPORT_SYMBOL_GPL(hid_add_device);
2138
2139/**
2140 * hid_allocate_device - allocate new hid device descriptor
2141 *
2142 * Allocate and initialize hid device, so that hid_destroy_device might be
2143 * used to free it.
2144 *
2145 * New hid_device pointer is returned on success, otherwise ERR_PTR encoded
2146 * error value.
2147 */
2148struct hid_device *hid_allocate_device(void)
2149{
2150 struct hid_device *hdev;
2151 int ret = -ENOMEM;
2152
2153 hdev = kzalloc(sizeof(*hdev), GFP_KERNEL);
2154 if (hdev == NULL)
2155 return ERR_PTR(ret);
2156
2157 device_initialize(&hdev->dev);
2158 hdev->dev.release = hid_device_release;
2159 hdev->dev.bus = &hid_bus_type;
2160 device_enable_async_suspend(&hdev->dev);
2161
2162 hid_close_report(hdev);
2163
2164 init_waitqueue_head(&hdev->debug_wait);
2165 INIT_LIST_HEAD(&hdev->debug_list);
2166 spin_lock_init(&hdev->debug_list_lock);
2167 sema_init(&hdev->driver_input_lock, 1);
2168 mutex_init(&hdev->ll_open_lock);
2169
2170 return hdev;
2171}
2172EXPORT_SYMBOL_GPL(hid_allocate_device);
2173
2174static void hid_remove_device(struct hid_device *hdev)
2175{
2176 if (hdev->status & HID_STAT_ADDED) {
2177 device_del(&hdev->dev);
2178 hid_debug_unregister(hdev);
2179 hdev->status &= ~HID_STAT_ADDED;
2180 }
2181 kfree(hdev->dev_rdesc);
2182 hdev->dev_rdesc = NULL;
2183 hdev->dev_rsize = 0;
2184}
2185
2186/**
2187 * hid_destroy_device - free previously allocated device
2188 *
2189 * @hdev: hid device
2190 *
2191 * If you allocate hid_device through hid_allocate_device, you should ever
2192 * free by this function.
2193 */
2194void hid_destroy_device(struct hid_device *hdev)
2195{
2196 hid_remove_device(hdev);
2197 put_device(&hdev->dev);
2198}
2199EXPORT_SYMBOL_GPL(hid_destroy_device);
2200
2201
2202static int __hid_bus_reprobe_drivers(struct device *dev, void *data)
2203{
2204 struct hid_driver *hdrv = data;
2205 struct hid_device *hdev = to_hid_device(dev);
2206
2207 if (hdev->driver == hdrv &&
2208 !hdrv->match(hdev, hid_ignore_special_drivers))
2209 return device_reprobe(dev);
2210
2211 return 0;
2212}
2213
2214static int __hid_bus_driver_added(struct device_driver *drv, void *data)
2215{
2216 struct hid_driver *hdrv = to_hid_driver(drv);
2217
2218 if (hdrv->match) {
2219 bus_for_each_dev(&hid_bus_type, NULL, hdrv,
2220 __hid_bus_reprobe_drivers);
2221 }
2222
2223 return 0;
2224}
2225
2226static int __bus_removed_driver(struct device_driver *drv, void *data)
2227{
2228 return bus_rescan_devices(&hid_bus_type);
2229}
2230
2231int __hid_register_driver(struct hid_driver *hdrv, struct module *owner,
2232 const char *mod_name)
2233{
2234 int ret;
2235
2236 hdrv->driver.name = hdrv->name;
2237 hdrv->driver.bus = &hid_bus_type;
2238 hdrv->driver.owner = owner;
2239 hdrv->driver.mod_name = mod_name;
2240
2241 INIT_LIST_HEAD(&hdrv->dyn_list);
2242 spin_lock_init(&hdrv->dyn_lock);
2243
2244 ret = driver_register(&hdrv->driver);
2245
2246 if (ret == 0)
2247 bus_for_each_drv(&hid_bus_type, NULL, NULL,
2248 __hid_bus_driver_added);
2249
2250 return ret;
2251}
2252EXPORT_SYMBOL_GPL(__hid_register_driver);
2253
2254void hid_unregister_driver(struct hid_driver *hdrv)
2255{
2256 driver_unregister(&hdrv->driver);
2257 hid_free_dynids(hdrv);
2258
2259 bus_for_each_drv(&hid_bus_type, NULL, hdrv, __bus_removed_driver);
2260}
2261EXPORT_SYMBOL_GPL(hid_unregister_driver);
2262
2263int hid_check_keys_pressed(struct hid_device *hid)
2264{
2265 struct hid_input *hidinput;
2266 int i;
2267
2268 if (!(hid->claimed & HID_CLAIMED_INPUT))
2269 return 0;
2270
2271 list_for_each_entry(hidinput, &hid->inputs, list) {
2272 for (i = 0; i < BITS_TO_LONGS(KEY_MAX); i++)
2273 if (hidinput->input->key[i])
2274 return 1;
2275 }
2276
2277 return 0;
2278}
2279
2280EXPORT_SYMBOL_GPL(hid_check_keys_pressed);
2281
2282static int __init hid_init(void)
2283{
2284 int ret;
2285
2286 if (hid_debug)
2287 pr_warn("hid_debug is now used solely for parser and driver debugging.\n"
2288 "debugfs is now used for inspecting the device (report descriptor, reports)\n");
2289
2290 ret = bus_register(&hid_bus_type);
2291 if (ret) {
2292 pr_err("can't register hid bus\n");
2293 goto err;
2294 }
2295
2296 ret = hidraw_init();
2297 if (ret)
2298 goto err_bus;
2299
2300 hid_debug_init();
2301
2302 return 0;
2303err_bus:
2304 bus_unregister(&hid_bus_type);
2305err:
2306 return ret;
2307}
2308
2309static void __exit hid_exit(void)
2310{
2311 hid_debug_exit();
2312 hidraw_exit();
2313 bus_unregister(&hid_bus_type);
2314 hid_quirks_exit(HID_BUS_ANY);
2315}
2316
2317module_init(hid_init);
2318module_exit(hid_exit);
2319
2320MODULE_AUTHOR("Andreas Gal");
2321MODULE_AUTHOR("Vojtech Pavlik");
2322MODULE_AUTHOR("Jiri Kosina");
2323MODULE_LICENSE("GPL");