1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * HID support for Linux
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
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
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>
22 #include <linux/spinlock.h>
23 #include <asm/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>
31 #include <linux/hid.h>
32 #include <linux/hiddev.h>
33 #include <linux/hid-debug.h>
34 #include <linux/hidraw.h>
42 #define DRIVER_DESC "HID core driver"
44 static int hid_ignore_special_drivers = 0;
45 module_param_named(ignore_special_drivers, hid_ignore_special_drivers, int, 0600);
46 MODULE_PARM_DESC(ignore_special_drivers, "Ignore any special drivers and handle all devices by generic driver");
49 * Register a new report for a device.
52 struct hid_report *hid_register_report(struct hid_device *device,
53 enum hid_report_type type, unsigned int id,
54 unsigned int application)
56 struct hid_report_enum *report_enum = device->report_enum + type;
57 struct hid_report *report;
59 if (id >= HID_MAX_IDS)
61 if (report_enum->report_id_hash[id])
62 return report_enum->report_id_hash[id];
64 report = kzalloc(sizeof(struct hid_report), GFP_KERNEL);
69 report_enum->numbered = 1;
74 report->device = device;
75 report->application = application;
76 report_enum->report_id_hash[id] = report;
78 list_add_tail(&report->list, &report_enum->report_list);
79 INIT_LIST_HEAD(&report->field_entry_list);
83 EXPORT_SYMBOL_GPL(hid_register_report);
86 * Register a new field for this report.
89 static struct hid_field *hid_register_field(struct hid_report *report, unsigned usages)
91 struct hid_field *field;
93 if (report->maxfield == HID_MAX_FIELDS) {
94 hid_err(report->device, "too many fields in report\n");
98 field = kzalloc((sizeof(struct hid_field) +
99 usages * sizeof(struct hid_usage) +
100 3 * usages * sizeof(unsigned int)), GFP_KERNEL);
104 field->index = report->maxfield++;
105 report->field[field->index] = field;
106 field->usage = (struct hid_usage *)(field + 1);
107 field->value = (s32 *)(field->usage + usages);
108 field->new_value = (s32 *)(field->value + usages);
109 field->usages_priorities = (s32 *)(field->new_value + usages);
110 field->report = report;
116 * Open a collection. The type/usage is pushed on the stack.
119 static int open_collection(struct hid_parser *parser, unsigned type)
121 struct hid_collection *collection;
123 int collection_index;
125 usage = parser->local.usage[0];
127 if (parser->collection_stack_ptr == parser->collection_stack_size) {
128 unsigned int *collection_stack;
129 unsigned int new_size = parser->collection_stack_size +
130 HID_COLLECTION_STACK_SIZE;
132 collection_stack = krealloc(parser->collection_stack,
133 new_size * sizeof(unsigned int),
135 if (!collection_stack)
138 parser->collection_stack = collection_stack;
139 parser->collection_stack_size = new_size;
142 if (parser->device->maxcollection == parser->device->collection_size) {
143 collection = kmalloc(
144 array3_size(sizeof(struct hid_collection),
145 parser->device->collection_size,
148 if (collection == NULL) {
149 hid_err(parser->device, "failed to reallocate collection array\n");
152 memcpy(collection, parser->device->collection,
153 sizeof(struct hid_collection) *
154 parser->device->collection_size);
155 memset(collection + parser->device->collection_size, 0,
156 sizeof(struct hid_collection) *
157 parser->device->collection_size);
158 kfree(parser->device->collection);
159 parser->device->collection = collection;
160 parser->device->collection_size *= 2;
163 parser->collection_stack[parser->collection_stack_ptr++] =
164 parser->device->maxcollection;
166 collection_index = parser->device->maxcollection++;
167 collection = parser->device->collection + collection_index;
168 collection->type = type;
169 collection->usage = usage;
170 collection->level = parser->collection_stack_ptr - 1;
171 collection->parent_idx = (collection->level == 0) ? -1 :
172 parser->collection_stack[collection->level - 1];
174 if (type == HID_COLLECTION_APPLICATION)
175 parser->device->maxapplication++;
181 * Close a collection.
184 static int close_collection(struct hid_parser *parser)
186 if (!parser->collection_stack_ptr) {
187 hid_err(parser->device, "collection stack underflow\n");
190 parser->collection_stack_ptr--;
195 * Climb up the stack, search for the specified collection type
196 * and return the usage.
199 static unsigned hid_lookup_collection(struct hid_parser *parser, unsigned type)
201 struct hid_collection *collection = parser->device->collection;
204 for (n = parser->collection_stack_ptr - 1; n >= 0; n--) {
205 unsigned index = parser->collection_stack[n];
206 if (collection[index].type == type)
207 return collection[index].usage;
209 return 0; /* we know nothing about this usage type */
213 * Concatenate usage which defines 16 bits or less with the
214 * currently defined usage page to form a 32 bit usage
217 static void complete_usage(struct hid_parser *parser, unsigned int index)
219 parser->local.usage[index] &= 0xFFFF;
220 parser->local.usage[index] |=
221 (parser->global.usage_page & 0xFFFF) << 16;
225 * Add a usage to the temporary parser table.
228 static int hid_add_usage(struct hid_parser *parser, unsigned usage, u8 size)
230 if (parser->local.usage_index >= HID_MAX_USAGES) {
231 hid_err(parser->device, "usage index exceeded\n");
234 parser->local.usage[parser->local.usage_index] = usage;
237 * If Usage item only includes usage id, concatenate it with
238 * currently defined usage page
241 complete_usage(parser, parser->local.usage_index);
243 parser->local.usage_size[parser->local.usage_index] = size;
244 parser->local.collection_index[parser->local.usage_index] =
245 parser->collection_stack_ptr ?
246 parser->collection_stack[parser->collection_stack_ptr - 1] : 0;
247 parser->local.usage_index++;
252 * Register a new field for this report.
255 static int hid_add_field(struct hid_parser *parser, unsigned report_type, unsigned flags)
257 struct hid_report *report;
258 struct hid_field *field;
262 unsigned int application;
264 application = hid_lookup_collection(parser, HID_COLLECTION_APPLICATION);
266 report = hid_register_report(parser->device, report_type,
267 parser->global.report_id, application);
269 hid_err(parser->device, "hid_register_report failed\n");
273 /* Handle both signed and unsigned cases properly */
274 if ((parser->global.logical_minimum < 0 &&
275 parser->global.logical_maximum <
276 parser->global.logical_minimum) ||
277 (parser->global.logical_minimum >= 0 &&
278 (__u32)parser->global.logical_maximum <
279 (__u32)parser->global.logical_minimum)) {
280 dbg_hid("logical range invalid 0x%x 0x%x\n",
281 parser->global.logical_minimum,
282 parser->global.logical_maximum);
286 offset = report->size;
287 report->size += parser->global.report_size * parser->global.report_count;
289 /* Total size check: Allow for possible report index byte */
290 if (report->size > (HID_MAX_BUFFER_SIZE - 1) << 3) {
291 hid_err(parser->device, "report is too long\n");
295 if (!parser->local.usage_index) /* Ignore padding fields */
298 usages = max_t(unsigned, parser->local.usage_index,
299 parser->global.report_count);
301 field = hid_register_field(report, usages);
305 field->physical = hid_lookup_collection(parser, HID_COLLECTION_PHYSICAL);
306 field->logical = hid_lookup_collection(parser, HID_COLLECTION_LOGICAL);
307 field->application = application;
309 for (i = 0; i < usages; i++) {
311 /* Duplicate the last usage we parsed if we have excess values */
312 if (i >= parser->local.usage_index)
313 j = parser->local.usage_index - 1;
314 field->usage[i].hid = parser->local.usage[j];
315 field->usage[i].collection_index =
316 parser->local.collection_index[j];
317 field->usage[i].usage_index = i;
318 field->usage[i].resolution_multiplier = 1;
321 field->maxusage = usages;
322 field->flags = flags;
323 field->report_offset = offset;
324 field->report_type = report_type;
325 field->report_size = parser->global.report_size;
326 field->report_count = parser->global.report_count;
327 field->logical_minimum = parser->global.logical_minimum;
328 field->logical_maximum = parser->global.logical_maximum;
329 field->physical_minimum = parser->global.physical_minimum;
330 field->physical_maximum = parser->global.physical_maximum;
331 field->unit_exponent = parser->global.unit_exponent;
332 field->unit = parser->global.unit;
338 * Read data value from item.
341 static u32 item_udata(struct hid_item *item)
343 switch (item->size) {
344 case 1: return item->data.u8;
345 case 2: return item->data.u16;
346 case 4: return item->data.u32;
351 static s32 item_sdata(struct hid_item *item)
353 switch (item->size) {
354 case 1: return item->data.s8;
355 case 2: return item->data.s16;
356 case 4: return item->data.s32;
362 * Process a global item.
365 static int hid_parser_global(struct hid_parser *parser, struct hid_item *item)
369 case HID_GLOBAL_ITEM_TAG_PUSH:
371 if (parser->global_stack_ptr == HID_GLOBAL_STACK_SIZE) {
372 hid_err(parser->device, "global environment stack overflow\n");
376 memcpy(parser->global_stack + parser->global_stack_ptr++,
377 &parser->global, sizeof(struct hid_global));
380 case HID_GLOBAL_ITEM_TAG_POP:
382 if (!parser->global_stack_ptr) {
383 hid_err(parser->device, "global environment stack underflow\n");
387 memcpy(&parser->global, parser->global_stack +
388 --parser->global_stack_ptr, sizeof(struct hid_global));
391 case HID_GLOBAL_ITEM_TAG_USAGE_PAGE:
392 parser->global.usage_page = item_udata(item);
395 case HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM:
396 parser->global.logical_minimum = item_sdata(item);
399 case HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM:
400 if (parser->global.logical_minimum < 0)
401 parser->global.logical_maximum = item_sdata(item);
403 parser->global.logical_maximum = item_udata(item);
406 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM:
407 parser->global.physical_minimum = item_sdata(item);
410 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM:
411 if (parser->global.physical_minimum < 0)
412 parser->global.physical_maximum = item_sdata(item);
414 parser->global.physical_maximum = item_udata(item);
417 case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT:
418 /* Many devices provide unit exponent as a two's complement
419 * nibble due to the common misunderstanding of HID
420 * specification 1.11, 6.2.2.7 Global Items. Attempt to handle
421 * both this and the standard encoding. */
422 raw_value = item_sdata(item);
423 if (!(raw_value & 0xfffffff0))
424 parser->global.unit_exponent = hid_snto32(raw_value, 4);
426 parser->global.unit_exponent = raw_value;
429 case HID_GLOBAL_ITEM_TAG_UNIT:
430 parser->global.unit = item_udata(item);
433 case HID_GLOBAL_ITEM_TAG_REPORT_SIZE:
434 parser->global.report_size = item_udata(item);
435 if (parser->global.report_size > 256) {
436 hid_err(parser->device, "invalid report_size %d\n",
437 parser->global.report_size);
442 case HID_GLOBAL_ITEM_TAG_REPORT_COUNT:
443 parser->global.report_count = item_udata(item);
444 if (parser->global.report_count > HID_MAX_USAGES) {
445 hid_err(parser->device, "invalid report_count %d\n",
446 parser->global.report_count);
451 case HID_GLOBAL_ITEM_TAG_REPORT_ID:
452 parser->global.report_id = item_udata(item);
453 if (parser->global.report_id == 0 ||
454 parser->global.report_id >= HID_MAX_IDS) {
455 hid_err(parser->device, "report_id %u is invalid\n",
456 parser->global.report_id);
462 hid_err(parser->device, "unknown global tag 0x%x\n", item->tag);
468 * Process a local item.
471 static int hid_parser_local(struct hid_parser *parser, struct hid_item *item)
477 data = item_udata(item);
480 case HID_LOCAL_ITEM_TAG_DELIMITER:
484 * We treat items before the first delimiter
485 * as global to all usage sets (branch 0).
486 * In the moment we process only these global
487 * items and the first delimiter set.
489 if (parser->local.delimiter_depth != 0) {
490 hid_err(parser->device, "nested delimiters\n");
493 parser->local.delimiter_depth++;
494 parser->local.delimiter_branch++;
496 if (parser->local.delimiter_depth < 1) {
497 hid_err(parser->device, "bogus close delimiter\n");
500 parser->local.delimiter_depth--;
504 case HID_LOCAL_ITEM_TAG_USAGE:
506 if (parser->local.delimiter_branch > 1) {
507 dbg_hid("alternative usage ignored\n");
511 return hid_add_usage(parser, data, item->size);
513 case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:
515 if (parser->local.delimiter_branch > 1) {
516 dbg_hid("alternative usage ignored\n");
520 parser->local.usage_minimum = data;
523 case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:
525 if (parser->local.delimiter_branch > 1) {
526 dbg_hid("alternative usage ignored\n");
530 count = data - parser->local.usage_minimum;
531 if (count + parser->local.usage_index >= HID_MAX_USAGES) {
533 * We do not warn if the name is not set, we are
534 * actually pre-scanning the device.
536 if (dev_name(&parser->device->dev))
537 hid_warn(parser->device,
538 "ignoring exceeding usage max\n");
539 data = HID_MAX_USAGES - parser->local.usage_index +
540 parser->local.usage_minimum - 1;
542 hid_err(parser->device,
543 "no more usage index available\n");
548 for (n = parser->local.usage_minimum; n <= data; n++)
549 if (hid_add_usage(parser, n, item->size)) {
550 dbg_hid("hid_add_usage failed\n");
557 dbg_hid("unknown local item tag 0x%x\n", item->tag);
564 * Concatenate Usage Pages into Usages where relevant:
565 * As per specification, 6.2.2.8: "When the parser encounters a main item it
566 * concatenates the last declared Usage Page with a Usage to form a complete
570 static void hid_concatenate_last_usage_page(struct hid_parser *parser)
573 unsigned int usage_page;
574 unsigned int current_page;
576 if (!parser->local.usage_index)
579 usage_page = parser->global.usage_page;
582 * Concatenate usage page again only if last declared Usage Page
583 * has not been already used in previous usages concatenation
585 for (i = parser->local.usage_index - 1; i >= 0; i--) {
586 if (parser->local.usage_size[i] > 2)
587 /* Ignore extended usages */
590 current_page = parser->local.usage[i] >> 16;
591 if (current_page == usage_page)
594 complete_usage(parser, i);
599 * Process a main item.
602 static int hid_parser_main(struct hid_parser *parser, struct hid_item *item)
607 hid_concatenate_last_usage_page(parser);
609 data = item_udata(item);
612 case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION:
613 ret = open_collection(parser, data & 0xff);
615 case HID_MAIN_ITEM_TAG_END_COLLECTION:
616 ret = close_collection(parser);
618 case HID_MAIN_ITEM_TAG_INPUT:
619 ret = hid_add_field(parser, HID_INPUT_REPORT, data);
621 case HID_MAIN_ITEM_TAG_OUTPUT:
622 ret = hid_add_field(parser, HID_OUTPUT_REPORT, data);
624 case HID_MAIN_ITEM_TAG_FEATURE:
625 ret = hid_add_field(parser, HID_FEATURE_REPORT, data);
628 hid_warn(parser->device, "unknown main item tag 0x%x\n", item->tag);
632 memset(&parser->local, 0, sizeof(parser->local)); /* Reset the local parser environment */
638 * Process a reserved item.
641 static int hid_parser_reserved(struct hid_parser *parser, struct hid_item *item)
643 dbg_hid("reserved item type, tag 0x%x\n", item->tag);
648 * Free a report and all registered fields. The field->usage and
649 * field->value table's are allocated behind the field, so we need
650 * only to free(field) itself.
653 static void hid_free_report(struct hid_report *report)
657 kfree(report->field_entries);
659 for (n = 0; n < report->maxfield; n++)
660 kfree(report->field[n]);
665 * Close report. This function returns the device
666 * state to the point prior to hid_open_report().
668 static void hid_close_report(struct hid_device *device)
672 for (i = 0; i < HID_REPORT_TYPES; i++) {
673 struct hid_report_enum *report_enum = device->report_enum + i;
675 for (j = 0; j < HID_MAX_IDS; j++) {
676 struct hid_report *report = report_enum->report_id_hash[j];
678 hid_free_report(report);
680 memset(report_enum, 0, sizeof(*report_enum));
681 INIT_LIST_HEAD(&report_enum->report_list);
684 kfree(device->rdesc);
685 device->rdesc = NULL;
688 kfree(device->collection);
689 device->collection = NULL;
690 device->collection_size = 0;
691 device->maxcollection = 0;
692 device->maxapplication = 0;
694 device->status &= ~HID_STAT_PARSED;
698 * Free a device structure, all reports, and all fields.
701 static void hid_device_release(struct device *dev)
703 struct hid_device *hid = to_hid_device(dev);
705 hid_close_report(hid);
706 kfree(hid->dev_rdesc);
711 * Fetch a report description item from the data stream. We support long
712 * items, though they are not used yet.
715 static u8 *fetch_item(__u8 *start, __u8 *end, struct hid_item *item)
719 if ((end - start) <= 0)
724 item->type = (b >> 2) & 3;
725 item->tag = (b >> 4) & 15;
727 if (item->tag == HID_ITEM_TAG_LONG) {
729 item->format = HID_ITEM_FORMAT_LONG;
731 if ((end - start) < 2)
734 item->size = *start++;
735 item->tag = *start++;
737 if ((end - start) < item->size)
740 item->data.longdata = start;
745 item->format = HID_ITEM_FORMAT_SHORT;
748 switch (item->size) {
753 if ((end - start) < 1)
755 item->data.u8 = *start++;
759 if ((end - start) < 2)
761 item->data.u16 = get_unaligned_le16(start);
762 start = (__u8 *)((__le16 *)start + 1);
767 if ((end - start) < 4)
769 item->data.u32 = get_unaligned_le32(start);
770 start = (__u8 *)((__le32 *)start + 1);
777 static void hid_scan_input_usage(struct hid_parser *parser, u32 usage)
779 struct hid_device *hid = parser->device;
781 if (usage == HID_DG_CONTACTID)
782 hid->group = HID_GROUP_MULTITOUCH;
785 static void hid_scan_feature_usage(struct hid_parser *parser, u32 usage)
787 if (usage == 0xff0000c5 && parser->global.report_count == 256 &&
788 parser->global.report_size == 8)
789 parser->scan_flags |= HID_SCAN_FLAG_MT_WIN_8;
791 if (usage == 0xff0000c6 && parser->global.report_count == 1 &&
792 parser->global.report_size == 8)
793 parser->scan_flags |= HID_SCAN_FLAG_MT_WIN_8;
796 static void hid_scan_collection(struct hid_parser *parser, unsigned type)
798 struct hid_device *hid = parser->device;
801 if (((parser->global.usage_page << 16) == HID_UP_SENSOR) &&
802 (type == HID_COLLECTION_PHYSICAL ||
803 type == HID_COLLECTION_APPLICATION))
804 hid->group = HID_GROUP_SENSOR_HUB;
806 if (hid->vendor == USB_VENDOR_ID_MICROSOFT &&
807 hid->product == USB_DEVICE_ID_MS_POWER_COVER &&
808 hid->group == HID_GROUP_MULTITOUCH)
809 hid->group = HID_GROUP_GENERIC;
811 if ((parser->global.usage_page << 16) == HID_UP_GENDESK)
812 for (i = 0; i < parser->local.usage_index; i++)
813 if (parser->local.usage[i] == HID_GD_POINTER)
814 parser->scan_flags |= HID_SCAN_FLAG_GD_POINTER;
816 if ((parser->global.usage_page << 16) >= HID_UP_MSVENDOR)
817 parser->scan_flags |= HID_SCAN_FLAG_VENDOR_SPECIFIC;
819 if ((parser->global.usage_page << 16) == HID_UP_GOOGLEVENDOR)
820 for (i = 0; i < parser->local.usage_index; i++)
821 if (parser->local.usage[i] ==
822 (HID_UP_GOOGLEVENDOR | 0x0001))
823 parser->device->group =
827 static int hid_scan_main(struct hid_parser *parser, struct hid_item *item)
832 hid_concatenate_last_usage_page(parser);
834 data = item_udata(item);
837 case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION:
838 hid_scan_collection(parser, data & 0xff);
840 case HID_MAIN_ITEM_TAG_END_COLLECTION:
842 case HID_MAIN_ITEM_TAG_INPUT:
843 /* ignore constant inputs, they will be ignored by hid-input */
844 if (data & HID_MAIN_ITEM_CONSTANT)
846 for (i = 0; i < parser->local.usage_index; i++)
847 hid_scan_input_usage(parser, parser->local.usage[i]);
849 case HID_MAIN_ITEM_TAG_OUTPUT:
851 case HID_MAIN_ITEM_TAG_FEATURE:
852 for (i = 0; i < parser->local.usage_index; i++)
853 hid_scan_feature_usage(parser, parser->local.usage[i]);
857 /* Reset the local parser environment */
858 memset(&parser->local, 0, sizeof(parser->local));
864 * Scan a report descriptor before the device is added to the bus.
865 * Sets device groups and other properties that determine what driver
868 static int hid_scan_report(struct hid_device *hid)
870 struct hid_parser *parser;
871 struct hid_item item;
872 __u8 *start = hid->dev_rdesc;
873 __u8 *end = start + hid->dev_rsize;
874 static int (*dispatch_type[])(struct hid_parser *parser,
875 struct hid_item *item) = {
882 parser = vzalloc(sizeof(struct hid_parser));
886 parser->device = hid;
887 hid->group = HID_GROUP_GENERIC;
890 * The parsing is simpler than the one in hid_open_report() as we should
891 * be robust against hid errors. Those errors will be raised by
892 * hid_open_report() anyway.
894 while ((start = fetch_item(start, end, &item)) != NULL)
895 dispatch_type[item.type](parser, &item);
898 * Handle special flags set during scanning.
900 if ((parser->scan_flags & HID_SCAN_FLAG_MT_WIN_8) &&
901 (hid->group == HID_GROUP_MULTITOUCH))
902 hid->group = HID_GROUP_MULTITOUCH_WIN_8;
905 * Vendor specific handlings
907 switch (hid->vendor) {
908 case USB_VENDOR_ID_WACOM:
909 hid->group = HID_GROUP_WACOM;
911 case USB_VENDOR_ID_SYNAPTICS:
912 if (hid->group == HID_GROUP_GENERIC)
913 if ((parser->scan_flags & HID_SCAN_FLAG_VENDOR_SPECIFIC)
914 && (parser->scan_flags & HID_SCAN_FLAG_GD_POINTER))
916 * hid-rmi should take care of them,
919 hid->group = HID_GROUP_RMI;
923 kfree(parser->collection_stack);
929 * hid_parse_report - parse device report
932 * @start: report start
935 * Allocate the device report as read by the bus driver. This function should
936 * only be called from parse() in ll drivers.
938 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size)
940 hid->dev_rdesc = kmemdup(start, size, GFP_KERNEL);
943 hid->dev_rsize = size;
946 EXPORT_SYMBOL_GPL(hid_parse_report);
948 static const char * const hid_report_names[] = {
951 "HID_FEATURE_REPORT",
954 * hid_validate_values - validate existing device report's value indexes
957 * @type: which report type to examine
958 * @id: which report ID to examine (0 for first)
959 * @field_index: which report field to examine
960 * @report_counts: expected number of values
962 * Validate the number of values in a given field of a given report, after
965 struct hid_report *hid_validate_values(struct hid_device *hid,
966 enum hid_report_type type, unsigned int id,
967 unsigned int field_index,
968 unsigned int report_counts)
970 struct hid_report *report;
972 if (type > HID_FEATURE_REPORT) {
973 hid_err(hid, "invalid HID report type %u\n", type);
977 if (id >= HID_MAX_IDS) {
978 hid_err(hid, "invalid HID report id %u\n", id);
983 * Explicitly not using hid_get_report() here since it depends on
984 * ->numbered being checked, which may not always be the case when
985 * drivers go to access report values.
989 * Validating on id 0 means we should examine the first
990 * report in the list.
992 report = list_first_entry_or_null(
993 &hid->report_enum[type].report_list,
994 struct hid_report, list);
996 report = hid->report_enum[type].report_id_hash[id];
999 hid_err(hid, "missing %s %u\n", hid_report_names[type], id);
1002 if (report->maxfield <= field_index) {
1003 hid_err(hid, "not enough fields in %s %u\n",
1004 hid_report_names[type], id);
1007 if (report->field[field_index]->report_count < report_counts) {
1008 hid_err(hid, "not enough values in %s %u field %u\n",
1009 hid_report_names[type], id, field_index);
1014 EXPORT_SYMBOL_GPL(hid_validate_values);
1016 static int hid_calculate_multiplier(struct hid_device *hid,
1017 struct hid_field *multiplier)
1020 __s32 v = *multiplier->value;
1021 __s32 lmin = multiplier->logical_minimum;
1022 __s32 lmax = multiplier->logical_maximum;
1023 __s32 pmin = multiplier->physical_minimum;
1024 __s32 pmax = multiplier->physical_maximum;
1027 * "Because OS implementations will generally divide the control's
1028 * reported count by the Effective Resolution Multiplier, designers
1029 * should take care not to establish a potential Effective
1030 * Resolution Multiplier of zero."
1031 * HID Usage Table, v1.12, Section 4.3.1, p31
1033 if (lmax - lmin == 0)
1036 * Handling the unit exponent is left as an exercise to whoever
1037 * finds a device where that exponent is not 0.
1039 m = ((v - lmin)/(lmax - lmin) * (pmax - pmin) + pmin);
1040 if (unlikely(multiplier->unit_exponent != 0)) {
1042 "unsupported Resolution Multiplier unit exponent %d\n",
1043 multiplier->unit_exponent);
1046 /* There are no devices with an effective multiplier > 255 */
1047 if (unlikely(m == 0 || m > 255 || m < -255)) {
1048 hid_warn(hid, "unsupported Resolution Multiplier %d\n", m);
1055 static void hid_apply_multiplier_to_field(struct hid_device *hid,
1056 struct hid_field *field,
1057 struct hid_collection *multiplier_collection,
1058 int effective_multiplier)
1060 struct hid_collection *collection;
1061 struct hid_usage *usage;
1065 * If multiplier_collection is NULL, the multiplier applies
1066 * to all fields in the report.
1067 * Otherwise, it is the Logical Collection the multiplier applies to
1068 * but our field may be in a subcollection of that collection.
1070 for (i = 0; i < field->maxusage; i++) {
1071 usage = &field->usage[i];
1073 collection = &hid->collection[usage->collection_index];
1074 while (collection->parent_idx != -1 &&
1075 collection != multiplier_collection)
1076 collection = &hid->collection[collection->parent_idx];
1078 if (collection->parent_idx != -1 ||
1079 multiplier_collection == NULL)
1080 usage->resolution_multiplier = effective_multiplier;
1085 static void hid_apply_multiplier(struct hid_device *hid,
1086 struct hid_field *multiplier)
1088 struct hid_report_enum *rep_enum;
1089 struct hid_report *rep;
1090 struct hid_field *field;
1091 struct hid_collection *multiplier_collection;
1092 int effective_multiplier;
1096 * "The Resolution Multiplier control must be contained in the same
1097 * Logical Collection as the control(s) to which it is to be applied.
1098 * If no Resolution Multiplier is defined, then the Resolution
1099 * Multiplier defaults to 1. If more than one control exists in a
1100 * Logical Collection, the Resolution Multiplier is associated with
1101 * all controls in the collection. If no Logical Collection is
1102 * defined, the Resolution Multiplier is associated with all
1103 * controls in the report."
1104 * HID Usage Table, v1.12, Section 4.3.1, p30
1106 * Thus, search from the current collection upwards until we find a
1107 * logical collection. Then search all fields for that same parent
1108 * collection. Those are the fields the multiplier applies to.
1110 * If we have more than one multiplier, it will overwrite the
1111 * applicable fields later.
1113 multiplier_collection = &hid->collection[multiplier->usage->collection_index];
1114 while (multiplier_collection->parent_idx != -1 &&
1115 multiplier_collection->type != HID_COLLECTION_LOGICAL)
1116 multiplier_collection = &hid->collection[multiplier_collection->parent_idx];
1118 effective_multiplier = hid_calculate_multiplier(hid, multiplier);
1120 rep_enum = &hid->report_enum[HID_INPUT_REPORT];
1121 list_for_each_entry(rep, &rep_enum->report_list, list) {
1122 for (i = 0; i < rep->maxfield; i++) {
1123 field = rep->field[i];
1124 hid_apply_multiplier_to_field(hid, field,
1125 multiplier_collection,
1126 effective_multiplier);
1132 * hid_setup_resolution_multiplier - set up all resolution multipliers
1134 * @device: hid device
1136 * Search for all Resolution Multiplier Feature Reports and apply their
1137 * value to all matching Input items. This only updates the internal struct
1140 * The Resolution Multiplier is applied by the hardware. If the multiplier
1141 * is anything other than 1, the hardware will send pre-multiplied events
1142 * so that the same physical interaction generates an accumulated
1143 * accumulated_value = value * * multiplier
1144 * This may be achieved by sending
1145 * - "value * multiplier" for each event, or
1146 * - "value" but "multiplier" times as frequently, or
1147 * - a combination of the above
1148 * The only guarantee is that the same physical interaction always generates
1149 * an accumulated 'value * multiplier'.
1151 * This function must be called before any event processing and after
1152 * any SetRequest to the Resolution Multiplier.
1154 void hid_setup_resolution_multiplier(struct hid_device *hid)
1156 struct hid_report_enum *rep_enum;
1157 struct hid_report *rep;
1158 struct hid_usage *usage;
1161 rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1162 list_for_each_entry(rep, &rep_enum->report_list, list) {
1163 for (i = 0; i < rep->maxfield; i++) {
1164 /* Ignore if report count is out of bounds. */
1165 if (rep->field[i]->report_count < 1)
1168 for (j = 0; j < rep->field[i]->maxusage; j++) {
1169 usage = &rep->field[i]->usage[j];
1170 if (usage->hid == HID_GD_RESOLUTION_MULTIPLIER)
1171 hid_apply_multiplier(hid,
1177 EXPORT_SYMBOL_GPL(hid_setup_resolution_multiplier);
1180 * hid_open_report - open a driver-specific device report
1182 * @device: hid device
1184 * Parse a report description into a hid_device structure. Reports are
1185 * enumerated, fields are attached to these reports.
1186 * 0 returned on success, otherwise nonzero error value.
1188 * This function (or the equivalent hid_parse() macro) should only be
1189 * called from probe() in drivers, before starting the device.
1191 int hid_open_report(struct hid_device *device)
1193 struct hid_parser *parser;
1194 struct hid_item item;
1202 static int (*dispatch_type[])(struct hid_parser *parser,
1203 struct hid_item *item) = {
1210 if (WARN_ON(device->status & HID_STAT_PARSED))
1213 start = device->dev_rdesc;
1214 if (WARN_ON(!start))
1216 size = device->dev_rsize;
1218 /* call_hid_bpf_rdesc_fixup() ensures we work on a copy of rdesc */
1219 buf = call_hid_bpf_rdesc_fixup(device, start, &size);
1223 if (device->driver->report_fixup)
1224 start = device->driver->report_fixup(device, buf, &size);
1228 start = kmemdup(start, size, GFP_KERNEL);
1233 device->rdesc = start;
1234 device->rsize = size;
1236 parser = vzalloc(sizeof(struct hid_parser));
1242 parser->device = device;
1246 device->collection = kcalloc(HID_DEFAULT_NUM_COLLECTIONS,
1247 sizeof(struct hid_collection), GFP_KERNEL);
1248 if (!device->collection) {
1252 device->collection_size = HID_DEFAULT_NUM_COLLECTIONS;
1253 for (i = 0; i < HID_DEFAULT_NUM_COLLECTIONS; i++)
1254 device->collection[i].parent_idx = -1;
1257 while ((next = fetch_item(start, end, &item)) != NULL) {
1260 if (item.format != HID_ITEM_FORMAT_SHORT) {
1261 hid_err(device, "unexpected long global item\n");
1265 if (dispatch_type[item.type](parser, &item)) {
1266 hid_err(device, "item %u %u %u %u parsing failed\n",
1267 item.format, (unsigned)item.size,
1268 (unsigned)item.type, (unsigned)item.tag);
1273 if (parser->collection_stack_ptr) {
1274 hid_err(device, "unbalanced collection at end of report description\n");
1277 if (parser->local.delimiter_depth) {
1278 hid_err(device, "unbalanced delimiter at end of report description\n");
1283 * fetch initial values in case the device's
1284 * default multiplier isn't the recommended 1
1286 hid_setup_resolution_multiplier(device);
1288 kfree(parser->collection_stack);
1290 device->status |= HID_STAT_PARSED;
1296 hid_err(device, "item fetching failed at offset %u/%u\n",
1297 size - (unsigned int)(end - start), size);
1299 kfree(parser->collection_stack);
1302 hid_close_report(device);
1305 EXPORT_SYMBOL_GPL(hid_open_report);
1308 * Convert a signed n-bit integer to signed 32-bit integer. Common
1309 * cases are done through the compiler, the screwed things has to be
1313 static s32 snto32(__u32 value, unsigned n)
1322 case 8: return ((__s8)value);
1323 case 16: return ((__s16)value);
1324 case 32: return ((__s32)value);
1326 return value & (1 << (n - 1)) ? value | (~0U << n) : value;
1329 s32 hid_snto32(__u32 value, unsigned n)
1331 return snto32(value, n);
1333 EXPORT_SYMBOL_GPL(hid_snto32);
1336 * Convert a signed 32-bit integer to a signed n-bit integer.
1339 static u32 s32ton(__s32 value, unsigned n)
1341 s32 a = value >> (n - 1);
1343 return value < 0 ? 1 << (n - 1) : (1 << (n - 1)) - 1;
1344 return value & ((1 << n) - 1);
1348 * Extract/implement a data field from/to a little endian report (bit array).
1350 * Code sort-of follows HID spec:
1351 * http://www.usb.org/developers/hidpage/HID1_11.pdf
1353 * While the USB HID spec allows unlimited length bit fields in "report
1354 * descriptors", most devices never use more than 16 bits.
1355 * One model of UPS is claimed to report "LINEV" as a 32-bit field.
1356 * Search linux-kernel and linux-usb-devel archives for "hid-core extract".
1359 static u32 __extract(u8 *report, unsigned offset, int n)
1361 unsigned int idx = offset / 8;
1362 unsigned int bit_nr = 0;
1363 unsigned int bit_shift = offset % 8;
1364 int bits_to_copy = 8 - bit_shift;
1366 u32 mask = n < 32 ? (1U << n) - 1 : ~0U;
1369 value |= ((u32)report[idx] >> bit_shift) << bit_nr;
1371 bit_nr += bits_to_copy;
1377 return value & mask;
1380 u32 hid_field_extract(const struct hid_device *hid, u8 *report,
1381 unsigned offset, unsigned n)
1384 hid_warn_once(hid, "%s() called with n (%d) > 32! (%s)\n",
1385 __func__, n, current->comm);
1389 return __extract(report, offset, n);
1391 EXPORT_SYMBOL_GPL(hid_field_extract);
1394 * "implement" : set bits in a little endian bit stream.
1395 * Same concepts as "extract" (see comments above).
1396 * The data mangled in the bit stream remains in little endian
1397 * order the whole time. It make more sense to talk about
1398 * endianness of register values by considering a register
1399 * a "cached" copy of the little endian bit stream.
1402 static void __implement(u8 *report, unsigned offset, int n, u32 value)
1404 unsigned int idx = offset / 8;
1405 unsigned int bit_shift = offset % 8;
1406 int bits_to_set = 8 - bit_shift;
1408 while (n - bits_to_set >= 0) {
1409 report[idx] &= ~(0xff << bit_shift);
1410 report[idx] |= value << bit_shift;
1411 value >>= bits_to_set;
1420 u8 bit_mask = ((1U << n) - 1);
1421 report[idx] &= ~(bit_mask << bit_shift);
1422 report[idx] |= value << bit_shift;
1426 static void implement(const struct hid_device *hid, u8 *report,
1427 unsigned offset, unsigned n, u32 value)
1429 if (unlikely(n > 32)) {
1430 hid_warn(hid, "%s() called with n (%d) > 32! (%s)\n",
1431 __func__, n, current->comm);
1433 } else if (n < 32) {
1434 u32 m = (1U << n) - 1;
1436 if (unlikely(value > m)) {
1438 "%s() called with too large value %d (n: %d)! (%s)\n",
1439 __func__, value, n, current->comm);
1445 __implement(report, offset, n, value);
1449 * Search an array for a value.
1452 static int search(__s32 *array, __s32 value, unsigned n)
1455 if (*array++ == value)
1462 * hid_match_report - check if driver's raw_event should be called
1465 * @report: hid report to match against
1467 * compare hid->driver->report_table->report_type to report->type
1469 static int hid_match_report(struct hid_device *hid, struct hid_report *report)
1471 const struct hid_report_id *id = hid->driver->report_table;
1473 if (!id) /* NULL means all */
1476 for (; id->report_type != HID_TERMINATOR; id++)
1477 if (id->report_type == HID_ANY_ID ||
1478 id->report_type == report->type)
1484 * hid_match_usage - check if driver's event should be called
1487 * @usage: usage to match against
1489 * compare hid->driver->usage_table->usage_{type,code} to
1490 * usage->usage_{type,code}
1492 static int hid_match_usage(struct hid_device *hid, struct hid_usage *usage)
1494 const struct hid_usage_id *id = hid->driver->usage_table;
1496 if (!id) /* NULL means all */
1499 for (; id->usage_type != HID_ANY_ID - 1; id++)
1500 if ((id->usage_hid == HID_ANY_ID ||
1501 id->usage_hid == usage->hid) &&
1502 (id->usage_type == HID_ANY_ID ||
1503 id->usage_type == usage->type) &&
1504 (id->usage_code == HID_ANY_ID ||
1505 id->usage_code == usage->code))
1510 static void hid_process_event(struct hid_device *hid, struct hid_field *field,
1511 struct hid_usage *usage, __s32 value, int interrupt)
1513 struct hid_driver *hdrv = hid->driver;
1516 if (!list_empty(&hid->debug_list))
1517 hid_dump_input(hid, usage, value);
1519 if (hdrv && hdrv->event && hid_match_usage(hid, usage)) {
1520 ret = hdrv->event(hid, field, usage, value);
1523 hid_err(hid, "%s's event failed with %d\n",
1529 if (hid->claimed & HID_CLAIMED_INPUT)
1530 hidinput_hid_event(hid, field, usage, value);
1531 if (hid->claimed & HID_CLAIMED_HIDDEV && interrupt && hid->hiddev_hid_event)
1532 hid->hiddev_hid_event(hid, field, usage, value);
1536 * Checks if the given value is valid within this field
1538 static inline int hid_array_value_is_valid(struct hid_field *field,
1541 __s32 min = field->logical_minimum;
1544 * Value needs to be between logical min and max, and
1545 * (value - min) is used as an index in the usage array.
1546 * This array is of size field->maxusage
1548 return value >= min &&
1549 value <= field->logical_maximum &&
1550 value - min < field->maxusage;
1554 * Fetch the field from the data. The field content is stored for next
1555 * report processing (we do differential reporting to the layer).
1557 static void hid_input_fetch_field(struct hid_device *hid,
1558 struct hid_field *field,
1562 unsigned count = field->report_count;
1563 unsigned offset = field->report_offset;
1564 unsigned size = field->report_size;
1565 __s32 min = field->logical_minimum;
1568 value = field->new_value;
1569 memset(value, 0, count * sizeof(__s32));
1570 field->ignored = false;
1572 for (n = 0; n < count; n++) {
1574 value[n] = min < 0 ?
1575 snto32(hid_field_extract(hid, data, offset + n * size,
1577 hid_field_extract(hid, data, offset + n * size, size);
1579 /* Ignore report if ErrorRollOver */
1580 if (!(field->flags & HID_MAIN_ITEM_VARIABLE) &&
1581 hid_array_value_is_valid(field, value[n]) &&
1582 field->usage[value[n] - min].hid == HID_UP_KEYBOARD + 1) {
1583 field->ignored = true;
1590 * Process a received variable field.
1593 static void hid_input_var_field(struct hid_device *hid,
1594 struct hid_field *field,
1597 unsigned int count = field->report_count;
1598 __s32 *value = field->new_value;
1601 for (n = 0; n < count; n++)
1602 hid_process_event(hid,
1608 memcpy(field->value, value, count * sizeof(__s32));
1612 * Process a received array field. The field content is stored for
1613 * next report processing (we do differential reporting to the layer).
1616 static void hid_input_array_field(struct hid_device *hid,
1617 struct hid_field *field,
1621 unsigned int count = field->report_count;
1622 __s32 min = field->logical_minimum;
1625 value = field->new_value;
1631 for (n = 0; n < count; n++) {
1632 if (hid_array_value_is_valid(field, field->value[n]) &&
1633 search(value, field->value[n], count))
1634 hid_process_event(hid,
1636 &field->usage[field->value[n] - min],
1640 if (hid_array_value_is_valid(field, value[n]) &&
1641 search(field->value, value[n], count))
1642 hid_process_event(hid,
1644 &field->usage[value[n] - min],
1649 memcpy(field->value, value, count * sizeof(__s32));
1653 * Analyse a received report, and fetch the data from it. The field
1654 * content is stored for next report processing (we do differential
1655 * reporting to the layer).
1657 static void hid_process_report(struct hid_device *hid,
1658 struct hid_report *report,
1663 struct hid_field_entry *entry;
1664 struct hid_field *field;
1666 /* first retrieve all incoming values in data */
1667 for (a = 0; a < report->maxfield; a++)
1668 hid_input_fetch_field(hid, report->field[a], data);
1670 if (!list_empty(&report->field_entry_list)) {
1671 /* INPUT_REPORT, we have a priority list of fields */
1672 list_for_each_entry(entry,
1673 &report->field_entry_list,
1675 field = entry->field;
1677 if (field->flags & HID_MAIN_ITEM_VARIABLE)
1678 hid_process_event(hid,
1680 &field->usage[entry->index],
1681 field->new_value[entry->index],
1684 hid_input_array_field(hid, field, interrupt);
1687 /* we need to do the memcpy at the end for var items */
1688 for (a = 0; a < report->maxfield; a++) {
1689 field = report->field[a];
1691 if (field->flags & HID_MAIN_ITEM_VARIABLE)
1692 memcpy(field->value, field->new_value,
1693 field->report_count * sizeof(__s32));
1696 /* FEATURE_REPORT, regular processing */
1697 for (a = 0; a < report->maxfield; a++) {
1698 field = report->field[a];
1700 if (field->flags & HID_MAIN_ITEM_VARIABLE)
1701 hid_input_var_field(hid, field, interrupt);
1703 hid_input_array_field(hid, field, interrupt);
1709 * Insert a given usage_index in a field in the list
1710 * of processed usages in the report.
1712 * The elements of lower priority score are processed
1715 static void __hid_insert_field_entry(struct hid_device *hid,
1716 struct hid_report *report,
1717 struct hid_field_entry *entry,
1718 struct hid_field *field,
1719 unsigned int usage_index)
1721 struct hid_field_entry *next;
1723 entry->field = field;
1724 entry->index = usage_index;
1725 entry->priority = field->usages_priorities[usage_index];
1727 /* insert the element at the correct position */
1728 list_for_each_entry(next,
1729 &report->field_entry_list,
1732 * the priority of our element is strictly higher
1733 * than the next one, insert it before
1735 if (entry->priority > next->priority) {
1736 list_add_tail(&entry->list, &next->list);
1741 /* lowest priority score: insert at the end */
1742 list_add_tail(&entry->list, &report->field_entry_list);
1745 static void hid_report_process_ordering(struct hid_device *hid,
1746 struct hid_report *report)
1748 struct hid_field *field;
1749 struct hid_field_entry *entries;
1750 unsigned int a, u, usages;
1751 unsigned int count = 0;
1753 /* count the number of individual fields in the report */
1754 for (a = 0; a < report->maxfield; a++) {
1755 field = report->field[a];
1757 if (field->flags & HID_MAIN_ITEM_VARIABLE)
1758 count += field->report_count;
1763 /* allocate the memory to process the fields */
1764 entries = kcalloc(count, sizeof(*entries), GFP_KERNEL);
1768 report->field_entries = entries;
1771 * walk through all fields in the report and
1772 * store them by priority order in report->field_entry_list
1774 * - Var elements are individualized (field + usage_index)
1775 * - Arrays are taken as one, we can not chose an order for them
1778 for (a = 0; a < report->maxfield; a++) {
1779 field = report->field[a];
1781 if (field->flags & HID_MAIN_ITEM_VARIABLE) {
1782 for (u = 0; u < field->report_count; u++) {
1783 __hid_insert_field_entry(hid, report,
1789 __hid_insert_field_entry(hid, report, &entries[usages],
1796 static void hid_process_ordering(struct hid_device *hid)
1798 struct hid_report *report;
1799 struct hid_report_enum *report_enum = &hid->report_enum[HID_INPUT_REPORT];
1801 list_for_each_entry(report, &report_enum->report_list, list)
1802 hid_report_process_ordering(hid, report);
1806 * Output the field into the report.
1809 static void hid_output_field(const struct hid_device *hid,
1810 struct hid_field *field, __u8 *data)
1812 unsigned count = field->report_count;
1813 unsigned offset = field->report_offset;
1814 unsigned size = field->report_size;
1817 for (n = 0; n < count; n++) {
1818 if (field->logical_minimum < 0) /* signed values */
1819 implement(hid, data, offset + n * size, size,
1820 s32ton(field->value[n], size));
1821 else /* unsigned values */
1822 implement(hid, data, offset + n * size, size,
1828 * Compute the size of a report.
1830 static size_t hid_compute_report_size(struct hid_report *report)
1833 return ((report->size - 1) >> 3) + 1;
1839 * Create a report. 'data' has to be allocated using
1840 * hid_alloc_report_buf() so that it has proper size.
1843 void hid_output_report(struct hid_report *report, __u8 *data)
1848 *data++ = report->id;
1850 memset(data, 0, hid_compute_report_size(report));
1851 for (n = 0; n < report->maxfield; n++)
1852 hid_output_field(report->device, report->field[n], data);
1854 EXPORT_SYMBOL_GPL(hid_output_report);
1857 * Allocator for buffer that is going to be passed to hid_output_report()
1859 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags)
1862 * 7 extra bytes are necessary to achieve proper functionality
1863 * of implement() working on 8 byte chunks
1866 u32 len = hid_report_len(report) + 7;
1868 return kmalloc(len, flags);
1870 EXPORT_SYMBOL_GPL(hid_alloc_report_buf);
1873 * Set a field value. The report this field belongs to has to be
1874 * created and transferred to the device, to set this value in the
1878 int hid_set_field(struct hid_field *field, unsigned offset, __s32 value)
1885 size = field->report_size;
1887 hid_dump_input(field->report->device, field->usage + offset, value);
1889 if (offset >= field->report_count) {
1890 hid_err(field->report->device, "offset (%d) exceeds report_count (%d)\n",
1891 offset, field->report_count);
1894 if (field->logical_minimum < 0) {
1895 if (value != snto32(s32ton(value, size), size)) {
1896 hid_err(field->report->device, "value %d is out of range\n", value);
1900 field->value[offset] = value;
1903 EXPORT_SYMBOL_GPL(hid_set_field);
1905 static struct hid_report *hid_get_report(struct hid_report_enum *report_enum,
1908 struct hid_report *report;
1909 unsigned int n = 0; /* Normally report number is 0 */
1911 /* Device uses numbered reports, data[0] is report number */
1912 if (report_enum->numbered)
1915 report = report_enum->report_id_hash[n];
1917 dbg_hid("undefined report_id %u received\n", n);
1923 * Implement a generic .request() callback, using .raw_request()
1924 * DO NOT USE in hid drivers directly, but through hid_hw_request instead.
1926 int __hid_request(struct hid_device *hid, struct hid_report *report,
1927 enum hid_class_request reqtype)
1933 buf = hid_alloc_report_buf(report, GFP_KERNEL);
1937 len = hid_report_len(report);
1939 if (reqtype == HID_REQ_SET_REPORT)
1940 hid_output_report(report, buf);
1942 ret = hid->ll_driver->raw_request(hid, report->id, buf, len,
1943 report->type, reqtype);
1945 dbg_hid("unable to complete request: %d\n", ret);
1949 if (reqtype == HID_REQ_GET_REPORT)
1950 hid_input_report(hid, report->type, buf, ret, 0);
1958 EXPORT_SYMBOL_GPL(__hid_request);
1960 int hid_report_raw_event(struct hid_device *hid, enum hid_report_type type, u8 *data, u32 size,
1963 struct hid_report_enum *report_enum = hid->report_enum + type;
1964 struct hid_report *report;
1965 struct hid_driver *hdrv;
1966 u32 rsize, csize = size;
1970 report = hid_get_report(report_enum, data);
1974 if (report_enum->numbered) {
1979 rsize = hid_compute_report_size(report);
1981 if (report_enum->numbered && rsize >= HID_MAX_BUFFER_SIZE)
1982 rsize = HID_MAX_BUFFER_SIZE - 1;
1983 else if (rsize > HID_MAX_BUFFER_SIZE)
1984 rsize = HID_MAX_BUFFER_SIZE;
1986 if (csize < rsize) {
1987 dbg_hid("report %d is too short, (%d < %d)\n", report->id,
1989 memset(cdata + csize, 0, rsize - csize);
1992 if ((hid->claimed & HID_CLAIMED_HIDDEV) && hid->hiddev_report_event)
1993 hid->hiddev_report_event(hid, report);
1994 if (hid->claimed & HID_CLAIMED_HIDRAW) {
1995 ret = hidraw_report_event(hid, data, size);
2000 if (hid->claimed != HID_CLAIMED_HIDRAW && report->maxfield) {
2001 hid_process_report(hid, report, cdata, interrupt);
2003 if (hdrv && hdrv->report)
2004 hdrv->report(hid, report);
2007 if (hid->claimed & HID_CLAIMED_INPUT)
2008 hidinput_report_event(hid, report);
2012 EXPORT_SYMBOL_GPL(hid_report_raw_event);
2015 * hid_input_report - report data from lower layer (usb, bt...)
2018 * @type: HID report type (HID_*_REPORT)
2019 * @data: report contents
2020 * @size: size of data parameter
2021 * @interrupt: distinguish between interrupt and control transfers
2023 * This is data entry for lower layers.
2025 int hid_input_report(struct hid_device *hid, enum hid_report_type type, u8 *data, u32 size,
2028 struct hid_report_enum *report_enum;
2029 struct hid_driver *hdrv;
2030 struct hid_report *report;
2036 if (down_trylock(&hid->driver_input_lock))
2043 report_enum = hid->report_enum + type;
2046 data = dispatch_hid_bpf_device_event(hid, type, data, &size, interrupt);
2048 ret = PTR_ERR(data);
2053 dbg_hid("empty report\n");
2058 /* Avoid unnecessary overhead if debugfs is disabled */
2059 if (!list_empty(&hid->debug_list))
2060 hid_dump_report(hid, type, data, size);
2062 report = hid_get_report(report_enum, data);
2069 if (hdrv && hdrv->raw_event && hid_match_report(hid, report)) {
2070 ret = hdrv->raw_event(hid, report, data, size);
2075 ret = hid_report_raw_event(hid, type, data, size, interrupt);
2078 up(&hid->driver_input_lock);
2081 EXPORT_SYMBOL_GPL(hid_input_report);
2083 bool hid_match_one_id(const struct hid_device *hdev,
2084 const struct hid_device_id *id)
2086 return (id->bus == HID_BUS_ANY || id->bus == hdev->bus) &&
2087 (id->group == HID_GROUP_ANY || id->group == hdev->group) &&
2088 (id->vendor == HID_ANY_ID || id->vendor == hdev->vendor) &&
2089 (id->product == HID_ANY_ID || id->product == hdev->product);
2092 const struct hid_device_id *hid_match_id(const struct hid_device *hdev,
2093 const struct hid_device_id *id)
2095 for (; id->bus; id++)
2096 if (hid_match_one_id(hdev, id))
2101 EXPORT_SYMBOL_GPL(hid_match_id);
2103 static const struct hid_device_id hid_hiddev_list[] = {
2104 { HID_USB_DEVICE(USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS) },
2105 { HID_USB_DEVICE(USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS1) },
2109 static bool hid_hiddev(struct hid_device *hdev)
2111 return !!hid_match_id(hdev, hid_hiddev_list);
2116 read_report_descriptor(struct file *filp, struct kobject *kobj,
2117 struct bin_attribute *attr,
2118 char *buf, loff_t off, size_t count)
2120 struct device *dev = kobj_to_dev(kobj);
2121 struct hid_device *hdev = to_hid_device(dev);
2123 if (off >= hdev->rsize)
2126 if (off + count > hdev->rsize)
2127 count = hdev->rsize - off;
2129 memcpy(buf, hdev->rdesc + off, count);
2135 show_country(struct device *dev, struct device_attribute *attr,
2138 struct hid_device *hdev = to_hid_device(dev);
2140 return sprintf(buf, "%02x\n", hdev->country & 0xff);
2143 static struct bin_attribute dev_bin_attr_report_desc = {
2144 .attr = { .name = "report_descriptor", .mode = 0444 },
2145 .read = read_report_descriptor,
2146 .size = HID_MAX_DESCRIPTOR_SIZE,
2149 static const struct device_attribute dev_attr_country = {
2150 .attr = { .name = "country", .mode = 0444 },
2151 .show = show_country,
2154 int hid_connect(struct hid_device *hdev, unsigned int connect_mask)
2156 static const char *types[] = { "Device", "Pointer", "Mouse", "Device",
2157 "Joystick", "Gamepad", "Keyboard", "Keypad",
2158 "Multi-Axis Controller"
2160 const char *type, *bus;
2166 ret = hid_bpf_connect_device(hdev);
2170 if (hdev->quirks & HID_QUIRK_HIDDEV_FORCE)
2171 connect_mask |= (HID_CONNECT_HIDDEV_FORCE | HID_CONNECT_HIDDEV);
2172 if (hdev->quirks & HID_QUIRK_HIDINPUT_FORCE)
2173 connect_mask |= HID_CONNECT_HIDINPUT_FORCE;
2174 if (hdev->bus != BUS_USB)
2175 connect_mask &= ~HID_CONNECT_HIDDEV;
2176 if (hid_hiddev(hdev))
2177 connect_mask |= HID_CONNECT_HIDDEV_FORCE;
2179 if ((connect_mask & HID_CONNECT_HIDINPUT) && !hidinput_connect(hdev,
2180 connect_mask & HID_CONNECT_HIDINPUT_FORCE))
2181 hdev->claimed |= HID_CLAIMED_INPUT;
2183 if ((connect_mask & HID_CONNECT_HIDDEV) && hdev->hiddev_connect &&
2184 !hdev->hiddev_connect(hdev,
2185 connect_mask & HID_CONNECT_HIDDEV_FORCE))
2186 hdev->claimed |= HID_CLAIMED_HIDDEV;
2187 if ((connect_mask & HID_CONNECT_HIDRAW) && !hidraw_connect(hdev))
2188 hdev->claimed |= HID_CLAIMED_HIDRAW;
2190 if (connect_mask & HID_CONNECT_DRIVER)
2191 hdev->claimed |= HID_CLAIMED_DRIVER;
2193 /* Drivers with the ->raw_event callback set are not required to connect
2194 * to any other listener. */
2195 if (!hdev->claimed && !hdev->driver->raw_event) {
2196 hid_err(hdev, "device has no listeners, quitting\n");
2200 hid_process_ordering(hdev);
2202 if ((hdev->claimed & HID_CLAIMED_INPUT) &&
2203 (connect_mask & HID_CONNECT_FF) && hdev->ff_init)
2204 hdev->ff_init(hdev);
2207 if (hdev->claimed & HID_CLAIMED_INPUT)
2208 len += sprintf(buf + len, "input");
2209 if (hdev->claimed & HID_CLAIMED_HIDDEV)
2210 len += sprintf(buf + len, "%shiddev%d", len ? "," : "",
2211 ((struct hiddev *)hdev->hiddev)->minor);
2212 if (hdev->claimed & HID_CLAIMED_HIDRAW)
2213 len += sprintf(buf + len, "%shidraw%d", len ? "," : "",
2214 ((struct hidraw *)hdev->hidraw)->minor);
2217 for (i = 0; i < hdev->maxcollection; i++) {
2218 struct hid_collection *col = &hdev->collection[i];
2219 if (col->type == HID_COLLECTION_APPLICATION &&
2220 (col->usage & HID_USAGE_PAGE) == HID_UP_GENDESK &&
2221 (col->usage & 0xffff) < ARRAY_SIZE(types)) {
2222 type = types[col->usage & 0xffff];
2227 switch (hdev->bus) {
2240 case BUS_INTEL_ISHTP:
2248 ret = device_create_file(&hdev->dev, &dev_attr_country);
2251 "can't create sysfs country code attribute err: %d\n", ret);
2253 hid_info(hdev, "%s: %s HID v%x.%02x %s [%s] on %s\n",
2254 buf, bus, hdev->version >> 8, hdev->version & 0xff,
2255 type, hdev->name, hdev->phys);
2259 EXPORT_SYMBOL_GPL(hid_connect);
2261 void hid_disconnect(struct hid_device *hdev)
2263 device_remove_file(&hdev->dev, &dev_attr_country);
2264 if (hdev->claimed & HID_CLAIMED_INPUT)
2265 hidinput_disconnect(hdev);
2266 if (hdev->claimed & HID_CLAIMED_HIDDEV)
2267 hdev->hiddev_disconnect(hdev);
2268 if (hdev->claimed & HID_CLAIMED_HIDRAW)
2269 hidraw_disconnect(hdev);
2272 hid_bpf_disconnect_device(hdev);
2274 EXPORT_SYMBOL_GPL(hid_disconnect);
2277 * hid_hw_start - start underlying HW
2279 * @connect_mask: which outputs to connect, see HID_CONNECT_*
2281 * Call this in probe function *after* hid_parse. This will setup HW
2282 * buffers and start the device (if not defeirred to device open).
2283 * hid_hw_stop must be called if this was successful.
2285 int hid_hw_start(struct hid_device *hdev, unsigned int connect_mask)
2289 error = hdev->ll_driver->start(hdev);
2294 error = hid_connect(hdev, connect_mask);
2296 hdev->ll_driver->stop(hdev);
2303 EXPORT_SYMBOL_GPL(hid_hw_start);
2306 * hid_hw_stop - stop underlying HW
2309 * This is usually called from remove function or from probe when something
2310 * failed and hid_hw_start was called already.
2312 void hid_hw_stop(struct hid_device *hdev)
2314 hid_disconnect(hdev);
2315 hdev->ll_driver->stop(hdev);
2317 EXPORT_SYMBOL_GPL(hid_hw_stop);
2320 * hid_hw_open - signal underlying HW to start delivering events
2323 * Tell underlying HW to start delivering events from the device.
2324 * This function should be called sometime after successful call
2325 * to hid_hw_start().
2327 int hid_hw_open(struct hid_device *hdev)
2331 ret = mutex_lock_killable(&hdev->ll_open_lock);
2335 if (!hdev->ll_open_count++) {
2336 ret = hdev->ll_driver->open(hdev);
2338 hdev->ll_open_count--;
2341 mutex_unlock(&hdev->ll_open_lock);
2344 EXPORT_SYMBOL_GPL(hid_hw_open);
2347 * hid_hw_close - signal underlaying HW to stop delivering events
2351 * This function indicates that we are not interested in the events
2352 * from this device anymore. Delivery of events may or may not stop,
2353 * depending on the number of users still outstanding.
2355 void hid_hw_close(struct hid_device *hdev)
2357 mutex_lock(&hdev->ll_open_lock);
2358 if (!--hdev->ll_open_count)
2359 hdev->ll_driver->close(hdev);
2360 mutex_unlock(&hdev->ll_open_lock);
2362 EXPORT_SYMBOL_GPL(hid_hw_close);
2365 * hid_hw_request - send report request to device
2368 * @report: report to send
2369 * @reqtype: hid request type
2371 void hid_hw_request(struct hid_device *hdev,
2372 struct hid_report *report, enum hid_class_request reqtype)
2374 if (hdev->ll_driver->request)
2375 return hdev->ll_driver->request(hdev, report, reqtype);
2377 __hid_request(hdev, report, reqtype);
2379 EXPORT_SYMBOL_GPL(hid_hw_request);
2382 * hid_hw_raw_request - send report request to device
2385 * @reportnum: report ID
2386 * @buf: in/out data to transfer
2387 * @len: length of buf
2388 * @rtype: HID report type
2389 * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
2391 * Return: count of data transferred, negative if error
2393 * Same behavior as hid_hw_request, but with raw buffers instead.
2395 int hid_hw_raw_request(struct hid_device *hdev,
2396 unsigned char reportnum, __u8 *buf,
2397 size_t len, enum hid_report_type rtype, enum hid_class_request reqtype)
2399 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
2402 return hdev->ll_driver->raw_request(hdev, reportnum, buf, len,
2405 EXPORT_SYMBOL_GPL(hid_hw_raw_request);
2408 * hid_hw_output_report - send output report to device
2411 * @buf: raw data to transfer
2412 * @len: length of buf
2414 * Return: count of data transferred, negative if error
2416 int hid_hw_output_report(struct hid_device *hdev, __u8 *buf, size_t len)
2418 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
2421 if (hdev->ll_driver->output_report)
2422 return hdev->ll_driver->output_report(hdev, buf, len);
2426 EXPORT_SYMBOL_GPL(hid_hw_output_report);
2429 int hid_driver_suspend(struct hid_device *hdev, pm_message_t state)
2431 if (hdev->driver && hdev->driver->suspend)
2432 return hdev->driver->suspend(hdev, state);
2436 EXPORT_SYMBOL_GPL(hid_driver_suspend);
2438 int hid_driver_reset_resume(struct hid_device *hdev)
2440 if (hdev->driver && hdev->driver->reset_resume)
2441 return hdev->driver->reset_resume(hdev);
2445 EXPORT_SYMBOL_GPL(hid_driver_reset_resume);
2447 int hid_driver_resume(struct hid_device *hdev)
2449 if (hdev->driver && hdev->driver->resume)
2450 return hdev->driver->resume(hdev);
2454 EXPORT_SYMBOL_GPL(hid_driver_resume);
2455 #endif /* CONFIG_PM */
2458 struct list_head list;
2459 struct hid_device_id id;
2463 * new_id_store - add a new HID device ID to this driver and re-probe devices
2464 * @drv: target device driver
2465 * @buf: buffer for scanning device ID data
2466 * @count: input size
2468 * Adds a new dynamic hid device ID to this driver,
2469 * and causes the driver to probe for all devices again.
2471 static ssize_t new_id_store(struct device_driver *drv, const char *buf,
2474 struct hid_driver *hdrv = to_hid_driver(drv);
2475 struct hid_dynid *dynid;
2476 __u32 bus, vendor, product;
2477 unsigned long driver_data = 0;
2480 ret = sscanf(buf, "%x %x %x %lx",
2481 &bus, &vendor, &product, &driver_data);
2485 dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
2489 dynid->id.bus = bus;
2490 dynid->id.group = HID_GROUP_ANY;
2491 dynid->id.vendor = vendor;
2492 dynid->id.product = product;
2493 dynid->id.driver_data = driver_data;
2495 spin_lock(&hdrv->dyn_lock);
2496 list_add_tail(&dynid->list, &hdrv->dyn_list);
2497 spin_unlock(&hdrv->dyn_lock);
2499 ret = driver_attach(&hdrv->driver);
2501 return ret ? : count;
2503 static DRIVER_ATTR_WO(new_id);
2505 static struct attribute *hid_drv_attrs[] = {
2506 &driver_attr_new_id.attr,
2509 ATTRIBUTE_GROUPS(hid_drv);
2511 static void hid_free_dynids(struct hid_driver *hdrv)
2513 struct hid_dynid *dynid, *n;
2515 spin_lock(&hdrv->dyn_lock);
2516 list_for_each_entry_safe(dynid, n, &hdrv->dyn_list, list) {
2517 list_del(&dynid->list);
2520 spin_unlock(&hdrv->dyn_lock);
2523 const struct hid_device_id *hid_match_device(struct hid_device *hdev,
2524 struct hid_driver *hdrv)
2526 struct hid_dynid *dynid;
2528 spin_lock(&hdrv->dyn_lock);
2529 list_for_each_entry(dynid, &hdrv->dyn_list, list) {
2530 if (hid_match_one_id(hdev, &dynid->id)) {
2531 spin_unlock(&hdrv->dyn_lock);
2535 spin_unlock(&hdrv->dyn_lock);
2537 return hid_match_id(hdev, hdrv->id_table);
2539 EXPORT_SYMBOL_GPL(hid_match_device);
2541 static int hid_bus_match(struct device *dev, struct device_driver *drv)
2543 struct hid_driver *hdrv = to_hid_driver(drv);
2544 struct hid_device *hdev = to_hid_device(dev);
2546 return hid_match_device(hdev, hdrv) != NULL;
2550 * hid_compare_device_paths - check if both devices share the same path
2551 * @hdev_a: hid device
2552 * @hdev_b: hid device
2553 * @separator: char to use as separator
2555 * Check if two devices share the same path up to the last occurrence of
2556 * the separator char. Both paths must exist (i.e., zero-length paths
2559 bool hid_compare_device_paths(struct hid_device *hdev_a,
2560 struct hid_device *hdev_b, char separator)
2562 int n1 = strrchr(hdev_a->phys, separator) - hdev_a->phys;
2563 int n2 = strrchr(hdev_b->phys, separator) - hdev_b->phys;
2565 if (n1 != n2 || n1 <= 0 || n2 <= 0)
2568 return !strncmp(hdev_a->phys, hdev_b->phys, n1);
2570 EXPORT_SYMBOL_GPL(hid_compare_device_paths);
2572 static int hid_device_probe(struct device *dev)
2574 struct hid_driver *hdrv = to_hid_driver(dev->driver);
2575 struct hid_device *hdev = to_hid_device(dev);
2576 const struct hid_device_id *id;
2579 if (down_interruptible(&hdev->driver_input_lock)) {
2583 hdev->io_started = false;
2585 clear_bit(ffs(HID_STAT_REPROBED), &hdev->status);
2587 if (!hdev->driver) {
2588 id = hid_match_device(hdev, hdrv);
2595 if (!hdrv->match(hdev, hid_ignore_special_drivers)) {
2601 * hid-generic implements .match(), so if
2602 * hid_ignore_special_drivers is set, we can safely
2605 if (hid_ignore_special_drivers) {
2611 /* reset the quirks that has been previously set */
2612 hdev->quirks = hid_lookup_quirk(hdev);
2613 hdev->driver = hdrv;
2615 ret = hdrv->probe(hdev, id);
2616 } else { /* default probe */
2617 ret = hid_open_report(hdev);
2619 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
2622 hid_close_report(hdev);
2623 hdev->driver = NULL;
2627 if (!hdev->io_started)
2628 up(&hdev->driver_input_lock);
2633 static void hid_device_remove(struct device *dev)
2635 struct hid_device *hdev = to_hid_device(dev);
2636 struct hid_driver *hdrv;
2638 down(&hdev->driver_input_lock);
2639 hdev->io_started = false;
2641 hdrv = hdev->driver;
2645 else /* default remove */
2647 hid_close_report(hdev);
2648 hdev->driver = NULL;
2651 if (!hdev->io_started)
2652 up(&hdev->driver_input_lock);
2655 static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
2658 struct hid_device *hdev = container_of(dev, struct hid_device, dev);
2660 return scnprintf(buf, PAGE_SIZE, "hid:b%04Xg%04Xv%08Xp%08X\n",
2661 hdev->bus, hdev->group, hdev->vendor, hdev->product);
2663 static DEVICE_ATTR_RO(modalias);
2665 static struct attribute *hid_dev_attrs[] = {
2666 &dev_attr_modalias.attr,
2669 static struct bin_attribute *hid_dev_bin_attrs[] = {
2670 &dev_bin_attr_report_desc,
2673 static const struct attribute_group hid_dev_group = {
2674 .attrs = hid_dev_attrs,
2675 .bin_attrs = hid_dev_bin_attrs,
2677 __ATTRIBUTE_GROUPS(hid_dev);
2679 static int hid_uevent(struct device *dev, struct kobj_uevent_env *env)
2681 struct hid_device *hdev = to_hid_device(dev);
2683 if (add_uevent_var(env, "HID_ID=%04X:%08X:%08X",
2684 hdev->bus, hdev->vendor, hdev->product))
2687 if (add_uevent_var(env, "HID_NAME=%s", hdev->name))
2690 if (add_uevent_var(env, "HID_PHYS=%s", hdev->phys))
2693 if (add_uevent_var(env, "HID_UNIQ=%s", hdev->uniq))
2696 if (add_uevent_var(env, "MODALIAS=hid:b%04Xg%04Xv%08Xp%08X",
2697 hdev->bus, hdev->group, hdev->vendor, hdev->product))
2703 struct bus_type hid_bus_type = {
2705 .dev_groups = hid_dev_groups,
2706 .drv_groups = hid_drv_groups,
2707 .match = hid_bus_match,
2708 .probe = hid_device_probe,
2709 .remove = hid_device_remove,
2710 .uevent = hid_uevent,
2712 EXPORT_SYMBOL(hid_bus_type);
2714 int hid_add_device(struct hid_device *hdev)
2716 static atomic_t id = ATOMIC_INIT(0);
2719 if (WARN_ON(hdev->status & HID_STAT_ADDED))
2722 hdev->quirks = hid_lookup_quirk(hdev);
2724 /* we need to kill them here, otherwise they will stay allocated to
2725 * wait for coming driver */
2726 if (hid_ignore(hdev))
2730 * Check for the mandatory transport channel.
2732 if (!hdev->ll_driver->raw_request) {
2733 hid_err(hdev, "transport driver missing .raw_request()\n");
2738 * Read the device report descriptor once and use as template
2739 * for the driver-specific modifications.
2741 ret = hdev->ll_driver->parse(hdev);
2744 if (!hdev->dev_rdesc)
2748 * Scan generic devices for group information
2750 if (hid_ignore_special_drivers) {
2751 hdev->group = HID_GROUP_GENERIC;
2752 } else if (!hdev->group &&
2753 !(hdev->quirks & HID_QUIRK_HAVE_SPECIAL_DRIVER)) {
2754 ret = hid_scan_report(hdev);
2756 hid_warn(hdev, "bad device descriptor (%d)\n", ret);
2759 hdev->id = atomic_inc_return(&id);
2761 /* XXX hack, any other cleaner solution after the driver core
2762 * is converted to allow more than 20 bytes as the device name? */
2763 dev_set_name(&hdev->dev, "%04X:%04X:%04X.%04X", hdev->bus,
2764 hdev->vendor, hdev->product, hdev->id);
2766 hid_debug_register(hdev, dev_name(&hdev->dev));
2767 ret = device_add(&hdev->dev);
2769 hdev->status |= HID_STAT_ADDED;
2771 hid_debug_unregister(hdev);
2775 EXPORT_SYMBOL_GPL(hid_add_device);
2778 * hid_allocate_device - allocate new hid device descriptor
2780 * Allocate and initialize hid device, so that hid_destroy_device might be
2783 * New hid_device pointer is returned on success, otherwise ERR_PTR encoded
2786 struct hid_device *hid_allocate_device(void)
2788 struct hid_device *hdev;
2791 hdev = kzalloc(sizeof(*hdev), GFP_KERNEL);
2793 return ERR_PTR(ret);
2795 device_initialize(&hdev->dev);
2796 hdev->dev.release = hid_device_release;
2797 hdev->dev.bus = &hid_bus_type;
2798 device_enable_async_suspend(&hdev->dev);
2800 hid_close_report(hdev);
2802 init_waitqueue_head(&hdev->debug_wait);
2803 INIT_LIST_HEAD(&hdev->debug_list);
2804 spin_lock_init(&hdev->debug_list_lock);
2805 sema_init(&hdev->driver_input_lock, 1);
2806 mutex_init(&hdev->ll_open_lock);
2808 hid_bpf_device_init(hdev);
2812 EXPORT_SYMBOL_GPL(hid_allocate_device);
2814 static void hid_remove_device(struct hid_device *hdev)
2816 if (hdev->status & HID_STAT_ADDED) {
2817 device_del(&hdev->dev);
2818 hid_debug_unregister(hdev);
2819 hdev->status &= ~HID_STAT_ADDED;
2821 kfree(hdev->dev_rdesc);
2822 hdev->dev_rdesc = NULL;
2823 hdev->dev_rsize = 0;
2827 * hid_destroy_device - free previously allocated device
2831 * If you allocate hid_device through hid_allocate_device, you should ever
2832 * free by this function.
2834 void hid_destroy_device(struct hid_device *hdev)
2836 hid_bpf_destroy_device(hdev);
2837 hid_remove_device(hdev);
2838 put_device(&hdev->dev);
2840 EXPORT_SYMBOL_GPL(hid_destroy_device);
2843 static int __hid_bus_reprobe_drivers(struct device *dev, void *data)
2845 struct hid_driver *hdrv = data;
2846 struct hid_device *hdev = to_hid_device(dev);
2848 if (hdev->driver == hdrv &&
2849 !hdrv->match(hdev, hid_ignore_special_drivers) &&
2850 !test_and_set_bit(ffs(HID_STAT_REPROBED), &hdev->status))
2851 return device_reprobe(dev);
2856 static int __hid_bus_driver_added(struct device_driver *drv, void *data)
2858 struct hid_driver *hdrv = to_hid_driver(drv);
2861 bus_for_each_dev(&hid_bus_type, NULL, hdrv,
2862 __hid_bus_reprobe_drivers);
2868 static int __bus_removed_driver(struct device_driver *drv, void *data)
2870 return bus_rescan_devices(&hid_bus_type);
2873 int __hid_register_driver(struct hid_driver *hdrv, struct module *owner,
2874 const char *mod_name)
2878 hdrv->driver.name = hdrv->name;
2879 hdrv->driver.bus = &hid_bus_type;
2880 hdrv->driver.owner = owner;
2881 hdrv->driver.mod_name = mod_name;
2883 INIT_LIST_HEAD(&hdrv->dyn_list);
2884 spin_lock_init(&hdrv->dyn_lock);
2886 ret = driver_register(&hdrv->driver);
2889 bus_for_each_drv(&hid_bus_type, NULL, NULL,
2890 __hid_bus_driver_added);
2894 EXPORT_SYMBOL_GPL(__hid_register_driver);
2896 void hid_unregister_driver(struct hid_driver *hdrv)
2898 driver_unregister(&hdrv->driver);
2899 hid_free_dynids(hdrv);
2901 bus_for_each_drv(&hid_bus_type, NULL, hdrv, __bus_removed_driver);
2903 EXPORT_SYMBOL_GPL(hid_unregister_driver);
2905 int hid_check_keys_pressed(struct hid_device *hid)
2907 struct hid_input *hidinput;
2910 if (!(hid->claimed & HID_CLAIMED_INPUT))
2913 list_for_each_entry(hidinput, &hid->inputs, list) {
2914 for (i = 0; i < BITS_TO_LONGS(KEY_MAX); i++)
2915 if (hidinput->input->key[i])
2921 EXPORT_SYMBOL_GPL(hid_check_keys_pressed);
2923 #ifdef CONFIG_HID_BPF
2924 static struct hid_bpf_ops hid_ops = {
2925 .hid_get_report = hid_get_report,
2926 .hid_hw_raw_request = hid_hw_raw_request,
2927 .owner = THIS_MODULE,
2928 .bus_type = &hid_bus_type,
2932 static int __init hid_init(void)
2936 ret = bus_register(&hid_bus_type);
2938 pr_err("can't register hid bus\n");
2942 #ifdef CONFIG_HID_BPF
2943 hid_bpf_ops = &hid_ops;
2946 ret = hidraw_init();
2954 bus_unregister(&hid_bus_type);
2959 static void __exit hid_exit(void)
2961 #ifdef CONFIG_HID_BPF
2966 bus_unregister(&hid_bus_type);
2967 hid_quirks_exit(HID_BUS_ANY);
2970 module_init(hid_init);
2971 module_exit(hid_exit);
2973 MODULE_AUTHOR("Andreas Gal");
2974 MODULE_AUTHOR("Vojtech Pavlik");
2975 MODULE_AUTHOR("Jiri Kosina");
2976 MODULE_LICENSE("GPL");