2 * HID support for Linux
4 * Copyright (c) 1999 Andreas Gal
5 * Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
6 * Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
7 * Copyright (c) 2006-2007 Jiri Kosina
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)
17 #include <linux/module.h>
18 #include <linux/slab.h>
19 #include <linux/init.h>
20 #include <linux/kernel.h>
21 #include <linux/list.h>
23 #include <linux/spinlock.h>
24 #include <asm/unaligned.h>
25 #include <asm/byteorder.h>
26 #include <linux/input.h>
27 #include <linux/wait.h>
28 #include <linux/vmalloc.h>
29 #include <linux/sched.h>
31 #include <linux/hid.h>
32 #include <linux/hiddev.h>
33 #include <linux/hid-debug.h>
34 #include <linux/hidraw.h>
40 #define DRIVER_VERSION "v2.6"
41 #define DRIVER_AUTHOR "Andreas Gal, Vojtech Pavlik, Jiri Kosina"
42 #define DRIVER_DESC "HID core driver"
43 #define DRIVER_LICENSE "GPL"
45 #ifdef CONFIG_HID_DEBUG
47 module_param_named(debug, hid_debug, int, 0600);
48 MODULE_PARM_DESC(debug, "HID debugging (0=off, 1=probing info, 2=continuous data dumping)");
49 EXPORT_SYMBOL_GPL(hid_debug);
53 * Register a new report for a device.
56 static struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id)
58 struct hid_report_enum *report_enum = device->report_enum + type;
59 struct hid_report *report;
61 if (report_enum->report_id_hash[id])
62 return report_enum->report_id_hash[id];
64 if (!(report = kzalloc(sizeof(struct hid_report), GFP_KERNEL)))
68 report_enum->numbered = 1;
73 report->device = device;
74 report_enum->report_id_hash[id] = report;
76 list_add_tail(&report->list, &report_enum->report_list);
82 * Register a new field for this report.
85 static struct hid_field *hid_register_field(struct hid_report *report, unsigned usages, unsigned values)
87 struct hid_field *field;
89 if (report->maxfield == HID_MAX_FIELDS) {
90 dbg_hid("too many fields in report\n");
94 if (!(field = kzalloc(sizeof(struct hid_field) + usages * sizeof(struct hid_usage)
95 + values * sizeof(unsigned), GFP_KERNEL))) return NULL;
97 field->index = report->maxfield++;
98 report->field[field->index] = field;
99 field->usage = (struct hid_usage *)(field + 1);
100 field->value = (s32 *)(field->usage + usages);
101 field->report = report;
107 * Open a collection. The type/usage is pushed on the stack.
110 static int open_collection(struct hid_parser *parser, unsigned type)
112 struct hid_collection *collection;
115 usage = parser->local.usage[0];
117 if (parser->collection_stack_ptr == HID_COLLECTION_STACK_SIZE) {
118 dbg_hid("collection stack overflow\n");
122 if (parser->device->maxcollection == parser->device->collection_size) {
123 collection = kmalloc(sizeof(struct hid_collection) *
124 parser->device->collection_size * 2, GFP_KERNEL);
125 if (collection == NULL) {
126 dbg_hid("failed to reallocate collection array\n");
129 memcpy(collection, parser->device->collection,
130 sizeof(struct hid_collection) *
131 parser->device->collection_size);
132 memset(collection + parser->device->collection_size, 0,
133 sizeof(struct hid_collection) *
134 parser->device->collection_size);
135 kfree(parser->device->collection);
136 parser->device->collection = collection;
137 parser->device->collection_size *= 2;
140 parser->collection_stack[parser->collection_stack_ptr++] =
141 parser->device->maxcollection;
143 collection = parser->device->collection +
144 parser->device->maxcollection++;
145 collection->type = type;
146 collection->usage = usage;
147 collection->level = parser->collection_stack_ptr - 1;
149 if (type == HID_COLLECTION_APPLICATION)
150 parser->device->maxapplication++;
156 * Close a collection.
159 static int close_collection(struct hid_parser *parser)
161 if (!parser->collection_stack_ptr) {
162 dbg_hid("collection stack underflow\n");
165 parser->collection_stack_ptr--;
170 * Climb up the stack, search for the specified collection type
171 * and return the usage.
174 static unsigned hid_lookup_collection(struct hid_parser *parser, unsigned type)
177 for (n = parser->collection_stack_ptr - 1; n >= 0; n--)
178 if (parser->device->collection[parser->collection_stack[n]].type == type)
179 return parser->device->collection[parser->collection_stack[n]].usage;
180 return 0; /* we know nothing about this usage type */
184 * Add a usage to the temporary parser table.
187 static int hid_add_usage(struct hid_parser *parser, unsigned usage)
189 if (parser->local.usage_index >= HID_MAX_USAGES) {
190 dbg_hid("usage index exceeded\n");
193 parser->local.usage[parser->local.usage_index] = usage;
194 parser->local.collection_index[parser->local.usage_index] =
195 parser->collection_stack_ptr ?
196 parser->collection_stack[parser->collection_stack_ptr - 1] : 0;
197 parser->local.usage_index++;
202 * Register a new field for this report.
205 static int hid_add_field(struct hid_parser *parser, unsigned report_type, unsigned flags)
207 struct hid_report *report;
208 struct hid_field *field;
213 if (!(report = hid_register_report(parser->device, report_type, parser->global.report_id))) {
214 dbg_hid("hid_register_report failed\n");
218 if (parser->global.logical_maximum < parser->global.logical_minimum) {
219 dbg_hid("logical range invalid %d %d\n", parser->global.logical_minimum, parser->global.logical_maximum);
223 offset = report->size;
224 report->size += parser->global.report_size * parser->global.report_count;
226 if (!parser->local.usage_index) /* Ignore padding fields */
229 usages = max_t(int, parser->local.usage_index, parser->global.report_count);
231 if ((field = hid_register_field(report, usages, parser->global.report_count)) == NULL)
234 field->physical = hid_lookup_collection(parser, HID_COLLECTION_PHYSICAL);
235 field->logical = hid_lookup_collection(parser, HID_COLLECTION_LOGICAL);
236 field->application = hid_lookup_collection(parser, HID_COLLECTION_APPLICATION);
238 for (i = 0; i < usages; i++) {
240 /* Duplicate the last usage we parsed if we have excess values */
241 if (i >= parser->local.usage_index)
242 j = parser->local.usage_index - 1;
243 field->usage[i].hid = parser->local.usage[j];
244 field->usage[i].collection_index =
245 parser->local.collection_index[j];
248 field->maxusage = usages;
249 field->flags = flags;
250 field->report_offset = offset;
251 field->report_type = report_type;
252 field->report_size = parser->global.report_size;
253 field->report_count = parser->global.report_count;
254 field->logical_minimum = parser->global.logical_minimum;
255 field->logical_maximum = parser->global.logical_maximum;
256 field->physical_minimum = parser->global.physical_minimum;
257 field->physical_maximum = parser->global.physical_maximum;
258 field->unit_exponent = parser->global.unit_exponent;
259 field->unit = parser->global.unit;
265 * Read data value from item.
268 static u32 item_udata(struct hid_item *item)
270 switch (item->size) {
271 case 1: return item->data.u8;
272 case 2: return item->data.u16;
273 case 4: return item->data.u32;
278 static s32 item_sdata(struct hid_item *item)
280 switch (item->size) {
281 case 1: return item->data.s8;
282 case 2: return item->data.s16;
283 case 4: return item->data.s32;
289 * Process a global item.
292 static int hid_parser_global(struct hid_parser *parser, struct hid_item *item)
296 case HID_GLOBAL_ITEM_TAG_PUSH:
298 if (parser->global_stack_ptr == HID_GLOBAL_STACK_SIZE) {
299 dbg_hid("global enviroment stack overflow\n");
303 memcpy(parser->global_stack + parser->global_stack_ptr++,
304 &parser->global, sizeof(struct hid_global));
307 case HID_GLOBAL_ITEM_TAG_POP:
309 if (!parser->global_stack_ptr) {
310 dbg_hid("global enviroment stack underflow\n");
314 memcpy(&parser->global, parser->global_stack + --parser->global_stack_ptr,
315 sizeof(struct hid_global));
318 case HID_GLOBAL_ITEM_TAG_USAGE_PAGE:
319 parser->global.usage_page = item_udata(item);
322 case HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM:
323 parser->global.logical_minimum = item_sdata(item);
326 case HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM:
327 if (parser->global.logical_minimum < 0)
328 parser->global.logical_maximum = item_sdata(item);
330 parser->global.logical_maximum = item_udata(item);
333 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM:
334 parser->global.physical_minimum = item_sdata(item);
337 case HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM:
338 if (parser->global.physical_minimum < 0)
339 parser->global.physical_maximum = item_sdata(item);
341 parser->global.physical_maximum = item_udata(item);
344 case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT:
345 parser->global.unit_exponent = item_sdata(item);
348 case HID_GLOBAL_ITEM_TAG_UNIT:
349 parser->global.unit = item_udata(item);
352 case HID_GLOBAL_ITEM_TAG_REPORT_SIZE:
353 if ((parser->global.report_size = item_udata(item)) > 32) {
354 dbg_hid("invalid report_size %d\n", parser->global.report_size);
359 case HID_GLOBAL_ITEM_TAG_REPORT_COUNT:
360 if ((parser->global.report_count = item_udata(item)) > HID_MAX_USAGES) {
361 dbg_hid("invalid report_count %d\n", parser->global.report_count);
366 case HID_GLOBAL_ITEM_TAG_REPORT_ID:
367 if ((parser->global.report_id = item_udata(item)) == 0) {
368 dbg_hid("report_id 0 is invalid\n");
374 dbg_hid("unknown global tag 0x%x\n", item->tag);
380 * Process a local item.
383 static int hid_parser_local(struct hid_parser *parser, struct hid_item *item)
388 if (item->size == 0) {
389 dbg_hid("item data expected for local item\n");
393 data = item_udata(item);
397 case HID_LOCAL_ITEM_TAG_DELIMITER:
401 * We treat items before the first delimiter
402 * as global to all usage sets (branch 0).
403 * In the moment we process only these global
404 * items and the first delimiter set.
406 if (parser->local.delimiter_depth != 0) {
407 dbg_hid("nested delimiters\n");
410 parser->local.delimiter_depth++;
411 parser->local.delimiter_branch++;
413 if (parser->local.delimiter_depth < 1) {
414 dbg_hid("bogus close delimiter\n");
417 parser->local.delimiter_depth--;
421 case HID_LOCAL_ITEM_TAG_USAGE:
423 if (parser->local.delimiter_branch > 1) {
424 dbg_hid("alternative usage ignored\n");
429 data = (parser->global.usage_page << 16) + data;
431 return hid_add_usage(parser, data);
433 case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:
435 if (parser->local.delimiter_branch > 1) {
436 dbg_hid("alternative usage ignored\n");
441 data = (parser->global.usage_page << 16) + data;
443 parser->local.usage_minimum = data;
446 case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:
448 if (parser->local.delimiter_branch > 1) {
449 dbg_hid("alternative usage ignored\n");
454 data = (parser->global.usage_page << 16) + data;
456 for (n = parser->local.usage_minimum; n <= data; n++)
457 if (hid_add_usage(parser, n)) {
458 dbg_hid("hid_add_usage failed\n");
465 dbg_hid("unknown local item tag 0x%x\n", item->tag);
472 * Process a main item.
475 static int hid_parser_main(struct hid_parser *parser, struct hid_item *item)
480 data = item_udata(item);
483 case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION:
484 ret = open_collection(parser, data & 0xff);
486 case HID_MAIN_ITEM_TAG_END_COLLECTION:
487 ret = close_collection(parser);
489 case HID_MAIN_ITEM_TAG_INPUT:
490 ret = hid_add_field(parser, HID_INPUT_REPORT, data);
492 case HID_MAIN_ITEM_TAG_OUTPUT:
493 ret = hid_add_field(parser, HID_OUTPUT_REPORT, data);
495 case HID_MAIN_ITEM_TAG_FEATURE:
496 ret = hid_add_field(parser, HID_FEATURE_REPORT, data);
499 dbg_hid("unknown main item tag 0x%x\n", item->tag);
503 memset(&parser->local, 0, sizeof(parser->local)); /* Reset the local parser environment */
509 * Process a reserved item.
512 static int hid_parser_reserved(struct hid_parser *parser, struct hid_item *item)
514 dbg_hid("reserved item type, tag 0x%x\n", item->tag);
519 * Free a report and all registered fields. The field->usage and
520 * field->value table's are allocated behind the field, so we need
521 * only to free(field) itself.
524 static void hid_free_report(struct hid_report *report)
528 for (n = 0; n < report->maxfield; n++)
529 kfree(report->field[n]);
534 * Free a device structure, all reports, and all fields.
537 static void hid_device_release(struct device *dev)
539 struct hid_device *device = container_of(dev, struct hid_device, dev);
542 for (i = 0; i < HID_REPORT_TYPES; i++) {
543 struct hid_report_enum *report_enum = device->report_enum + i;
545 for (j = 0; j < 256; j++) {
546 struct hid_report *report = report_enum->report_id_hash[j];
548 hid_free_report(report);
552 kfree(device->rdesc);
553 kfree(device->collection);
558 * Fetch a report description item from the data stream. We support long
559 * items, though they are not used yet.
562 static u8 *fetch_item(__u8 *start, __u8 *end, struct hid_item *item)
566 if ((end - start) <= 0)
571 item->type = (b >> 2) & 3;
572 item->tag = (b >> 4) & 15;
574 if (item->tag == HID_ITEM_TAG_LONG) {
576 item->format = HID_ITEM_FORMAT_LONG;
578 if ((end - start) < 2)
581 item->size = *start++;
582 item->tag = *start++;
584 if ((end - start) < item->size)
587 item->data.longdata = start;
592 item->format = HID_ITEM_FORMAT_SHORT;
595 switch (item->size) {
601 if ((end - start) < 1)
603 item->data.u8 = *start++;
607 if ((end - start) < 2)
609 item->data.u16 = get_unaligned_le16(start);
610 start = (__u8 *)((__le16 *)start + 1);
615 if ((end - start) < 4)
617 item->data.u32 = get_unaligned_le32(start);
618 start = (__u8 *)((__le32 *)start + 1);
626 * hid_parse_report - parse device report
628 * @device: hid device
629 * @start: report start
632 * Parse a report description into a hid_device structure. Reports are
633 * enumerated, fields are attached to these reports.
634 * 0 returned on success, otherwise nonzero error value.
636 int hid_parse_report(struct hid_device *device, __u8 *start,
639 struct hid_parser *parser;
640 struct hid_item item;
643 static int (*dispatch_type[])(struct hid_parser *parser,
644 struct hid_item *item) = {
651 if (device->driver->report_fixup)
652 device->driver->report_fixup(device, start, size);
654 device->rdesc = kmalloc(size, GFP_KERNEL);
655 if (device->rdesc == NULL)
657 memcpy(device->rdesc, start, size);
658 device->rsize = size;
660 parser = vmalloc(sizeof(struct hid_parser));
666 memset(parser, 0, sizeof(struct hid_parser));
667 parser->device = device;
671 while ((start = fetch_item(start, end, &item)) != NULL) {
673 if (item.format != HID_ITEM_FORMAT_SHORT) {
674 dbg_hid("unexpected long global item\n");
678 if (dispatch_type[item.type](parser, &item)) {
679 dbg_hid("item %u %u %u %u parsing failed\n",
680 item.format, (unsigned)item.size, (unsigned)item.type, (unsigned)item.tag);
685 if (parser->collection_stack_ptr) {
686 dbg_hid("unbalanced collection at end of report description\n");
689 if (parser->local.delimiter_depth) {
690 dbg_hid("unbalanced delimiter at end of report description\n");
698 dbg_hid("item fetching failed at offset %d\n", (int)(end - start));
703 EXPORT_SYMBOL_GPL(hid_parse_report);
706 * Convert a signed n-bit integer to signed 32-bit integer. Common
707 * cases are done through the compiler, the screwed things has to be
711 static s32 snto32(__u32 value, unsigned n)
714 case 8: return ((__s8)value);
715 case 16: return ((__s16)value);
716 case 32: return ((__s32)value);
718 return value & (1 << (n - 1)) ? value | (-1 << n) : value;
722 * Convert a signed 32-bit integer to a signed n-bit integer.
725 static u32 s32ton(__s32 value, unsigned n)
727 s32 a = value >> (n - 1);
729 return value < 0 ? 1 << (n - 1) : (1 << (n - 1)) - 1;
730 return value & ((1 << n) - 1);
734 * Extract/implement a data field from/to a little endian report (bit array).
736 * Code sort-of follows HID spec:
737 * http://www.usb.org/developers/devclass_docs/HID1_11.pdf
739 * While the USB HID spec allows unlimited length bit fields in "report
740 * descriptors", most devices never use more than 16 bits.
741 * One model of UPS is claimed to report "LINEV" as a 32-bit field.
742 * Search linux-kernel and linux-usb-devel archives for "hid-core extract".
745 static __inline__ __u32 extract(__u8 *report, unsigned offset, unsigned n)
750 printk(KERN_WARNING "HID: extract() called with n (%d) > 32! (%s)\n",
753 report += offset >> 3; /* adjust byte index */
754 offset &= 7; /* now only need bit offset into one byte */
755 x = get_unaligned_le64(report);
756 x = (x >> offset) & ((1ULL << n) - 1); /* extract bit field */
761 * "implement" : set bits in a little endian bit stream.
762 * Same concepts as "extract" (see comments above).
763 * The data mangled in the bit stream remains in little endian
764 * order the whole time. It make more sense to talk about
765 * endianness of register values by considering a register
766 * a "cached" copy of the little endiad bit stream.
768 static __inline__ void implement(__u8 *report, unsigned offset, unsigned n, __u32 value)
771 u64 m = (1ULL << n) - 1;
774 printk(KERN_WARNING "HID: implement() called with n (%d) > 32! (%s)\n",
778 printk(KERN_WARNING "HID: implement() called with too large value %d! (%s)\n",
779 value, current->comm);
783 report += offset >> 3;
786 x = get_unaligned_le64(report);
788 x |= ((u64)value) << offset;
789 put_unaligned_le64(x, report);
793 * Search an array for a value.
796 static __inline__ int search(__s32 *array, __s32 value, unsigned n)
799 if (*array++ == value)
806 * hid_match_report - check if driver's raw_event should be called
809 * @report_type: type to match against
811 * compare hid->driver->report_table->report_type to report->type
813 static int hid_match_report(struct hid_device *hid, struct hid_report *report)
815 const struct hid_report_id *id = hid->driver->report_table;
817 if (!id) /* NULL means all */
820 for (; id->report_type != HID_TERMINATOR; id++)
821 if (id->report_type == HID_ANY_ID ||
822 id->report_type == report->type)
828 * hid_match_usage - check if driver's event should be called
831 * @usage: usage to match against
833 * compare hid->driver->usage_table->usage_{type,code} to
834 * usage->usage_{type,code}
836 static int hid_match_usage(struct hid_device *hid, struct hid_usage *usage)
838 const struct hid_usage_id *id = hid->driver->usage_table;
840 if (!id) /* NULL means all */
843 for (; id->usage_type != HID_ANY_ID - 1; id++)
844 if ((id->usage_hid == HID_ANY_ID ||
845 id->usage_hid == usage->hid) &&
846 (id->usage_type == HID_ANY_ID ||
847 id->usage_type == usage->type) &&
848 (id->usage_code == HID_ANY_ID ||
849 id->usage_code == usage->code))
854 static void hid_process_event(struct hid_device *hid, struct hid_field *field,
855 struct hid_usage *usage, __s32 value, int interrupt)
857 struct hid_driver *hdrv = hid->driver;
860 hid_dump_input(usage, value);
862 if (hdrv && hdrv->event && hid_match_usage(hid, usage)) {
863 ret = hdrv->event(hid, field, usage, value);
866 dbg_hid("%s's event failed with %d\n",
872 if (hid->claimed & HID_CLAIMED_INPUT)
873 hidinput_hid_event(hid, field, usage, value);
874 if (hid->claimed & HID_CLAIMED_HIDDEV && interrupt && hid->hiddev_hid_event)
875 hid->hiddev_hid_event(hid, field, usage, value);
879 * Analyse a received field, and fetch the data from it. The field
880 * content is stored for next report processing (we do differential
881 * reporting to the layer).
884 static void hid_input_field(struct hid_device *hid, struct hid_field *field,
885 __u8 *data, int interrupt)
888 unsigned count = field->report_count;
889 unsigned offset = field->report_offset;
890 unsigned size = field->report_size;
891 __s32 min = field->logical_minimum;
892 __s32 max = field->logical_maximum;
895 if (!(value = kmalloc(sizeof(__s32) * count, GFP_ATOMIC)))
898 for (n = 0; n < count; n++) {
900 value[n] = min < 0 ? snto32(extract(data, offset + n * size, size), size) :
901 extract(data, offset + n * size, size);
903 if (!(field->flags & HID_MAIN_ITEM_VARIABLE) /* Ignore report if ErrorRollOver */
904 && value[n] >= min && value[n] <= max
905 && field->usage[value[n] - min].hid == HID_UP_KEYBOARD + 1)
909 for (n = 0; n < count; n++) {
911 if (HID_MAIN_ITEM_VARIABLE & field->flags) {
912 hid_process_event(hid, field, &field->usage[n], value[n], interrupt);
916 if (field->value[n] >= min && field->value[n] <= max
917 && field->usage[field->value[n] - min].hid
918 && search(value, field->value[n], count))
919 hid_process_event(hid, field, &field->usage[field->value[n] - min], 0, interrupt);
921 if (value[n] >= min && value[n] <= max
922 && field->usage[value[n] - min].hid
923 && search(field->value, value[n], count))
924 hid_process_event(hid, field, &field->usage[value[n] - min], 1, interrupt);
927 memcpy(field->value, value, count * sizeof(__s32));
933 * Output the field into the report.
936 static void hid_output_field(struct hid_field *field, __u8 *data)
938 unsigned count = field->report_count;
939 unsigned offset = field->report_offset;
940 unsigned size = field->report_size;
941 unsigned bitsused = offset + count * size;
944 /* make sure the unused bits in the last byte are zeros */
945 if (count > 0 && size > 0 && (bitsused % 8) != 0)
946 data[(bitsused-1)/8] &= (1 << (bitsused % 8)) - 1;
948 for (n = 0; n < count; n++) {
949 if (field->logical_minimum < 0) /* signed values */
950 implement(data, offset + n * size, size, s32ton(field->value[n], size));
951 else /* unsigned values */
952 implement(data, offset + n * size, size, field->value[n]);
960 void hid_output_report(struct hid_report *report, __u8 *data)
965 *data++ = report->id;
967 for (n = 0; n < report->maxfield; n++)
968 hid_output_field(report->field[n], data);
970 EXPORT_SYMBOL_GPL(hid_output_report);
973 * Set a field value. The report this field belongs to has to be
974 * created and transferred to the device, to set this value in the
978 int hid_set_field(struct hid_field *field, unsigned offset, __s32 value)
980 unsigned size = field->report_size;
982 hid_dump_input(field->usage + offset, value);
984 if (offset >= field->report_count) {
985 dbg_hid("offset (%d) exceeds report_count (%d)\n", offset, field->report_count);
986 hid_dump_field(field, 8);
989 if (field->logical_minimum < 0) {
990 if (value != snto32(s32ton(value, size), size)) {
991 dbg_hid("value %d is out of range\n", value);
995 field->value[offset] = value;
998 EXPORT_SYMBOL_GPL(hid_set_field);
1000 static struct hid_report *hid_get_report(struct hid_report_enum *report_enum,
1003 struct hid_report *report;
1004 unsigned int n = 0; /* Normally report number is 0 */
1006 /* Device uses numbered reports, data[0] is report number */
1007 if (report_enum->numbered)
1010 report = report_enum->report_id_hash[n];
1012 dbg_hid("undefined report_id %u received\n", n);
1017 void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
1020 struct hid_report_enum *report_enum = hid->report_enum + type;
1021 struct hid_report *report;
1023 int rsize, csize = size;
1026 report = hid_get_report(report_enum, data);
1030 if (report_enum->numbered) {
1035 rsize = ((report->size - 1) >> 3) + 1;
1037 if (csize < rsize) {
1038 dbg_hid("report %d is too short, (%d < %d)\n", report->id,
1040 memset(cdata + csize, 0, rsize - csize);
1043 if ((hid->claimed & HID_CLAIMED_HIDDEV) && hid->hiddev_report_event)
1044 hid->hiddev_report_event(hid, report);
1045 if (hid->claimed & HID_CLAIMED_HIDRAW) {
1046 /* numbered reports need to be passed with the report num */
1047 if (report_enum->numbered)
1048 hidraw_report_event(hid, data - 1, size + 1);
1050 hidraw_report_event(hid, data, size);
1053 for (a = 0; a < report->maxfield; a++)
1054 hid_input_field(hid, report->field[a], cdata, interrupt);
1056 if (hid->claimed & HID_CLAIMED_INPUT)
1057 hidinput_report_event(hid, report);
1059 EXPORT_SYMBOL_GPL(hid_report_raw_event);
1062 * hid_input_report - report data from lower layer (usb, bt...)
1065 * @type: HID report type (HID_*_REPORT)
1066 * @data: report contents
1067 * @size: size of data parameter
1068 * @interrupt: called from atomic?
1070 * This is data entry for lower layers.
1072 int hid_input_report(struct hid_device *hid, int type, u8 *data, int size, int interrupt)
1074 struct hid_report_enum *report_enum = hid->report_enum + type;
1075 struct hid_driver *hdrv = hid->driver;
1076 struct hid_report *report;
1080 if (!hid || !hid->driver)
1084 dbg_hid("empty report\n");
1088 dbg_hid("report (size %u) (%snumbered)\n", size, report_enum->numbered ? "" : "un");
1090 report = hid_get_report(report_enum, data);
1094 /* dump the report */
1095 dbg_hid("report %d (size %u) = ", report->id, size);
1096 for (i = 0; i < size; i++)
1097 dbg_hid_line(" %02x", data[i]);
1100 if (hdrv && hdrv->raw_event && hid_match_report(hid, report)) {
1101 ret = hdrv->raw_event(hid, report, data, size);
1103 return ret < 0 ? ret : 0;
1106 hid_report_raw_event(hid, type, data, size, interrupt);
1110 EXPORT_SYMBOL_GPL(hid_input_report);
1112 static bool hid_match_one_id(struct hid_device *hdev,
1113 const struct hid_device_id *id)
1115 return id->bus == hdev->bus &&
1116 (id->vendor == HID_ANY_ID || id->vendor == hdev->vendor) &&
1117 (id->product == HID_ANY_ID || id->product == hdev->product);
1120 static const struct hid_device_id *hid_match_id(struct hid_device *hdev,
1121 const struct hid_device_id *id)
1123 for (; id->bus; id++)
1124 if (hid_match_one_id(hdev, id))
1130 static const struct hid_device_id hid_blacklist[] = {
1134 static int hid_bus_match(struct device *dev, struct device_driver *drv)
1136 struct hid_driver *hdrv = container_of(drv, struct hid_driver, driver);
1137 struct hid_device *hdev = container_of(dev, struct hid_device, dev);
1139 if (!hid_match_id(hdev, hdrv->id_table))
1142 /* generic wants all non-blacklisted */
1143 if (!strncmp(hdrv->name, "generic-", 8))
1144 return !hid_match_id(hdev, hid_blacklist);
1149 static int hid_device_probe(struct device *dev)
1151 struct hid_driver *hdrv = container_of(dev->driver,
1152 struct hid_driver, driver);
1153 struct hid_device *hdev = container_of(dev, struct hid_device, dev);
1154 const struct hid_device_id *id;
1157 if (!hdev->driver) {
1158 id = hid_match_id(hdev, hdrv->id_table);
1162 hdev->driver = hdrv;
1164 ret = hdrv->probe(hdev, id);
1165 } else { /* default probe */
1166 ret = hid_parse(hdev);
1168 ret = hid_hw_start(hdev);
1171 hdev->driver = NULL;
1176 static int hid_device_remove(struct device *dev)
1178 struct hid_device *hdev = container_of(dev, struct hid_device, dev);
1179 struct hid_driver *hdrv = hdev->driver;
1184 else /* default remove */
1186 hdev->driver = NULL;
1192 static int hid_uevent(struct device *dev, struct kobj_uevent_env *env)
1194 struct hid_device *hdev = container_of(dev, struct hid_device, dev);
1196 if (add_uevent_var(env, "HID_ID=%04X:%08X:%08X",
1197 hdev->bus, hdev->vendor, hdev->product))
1200 if (add_uevent_var(env, "HID_NAME=%s", hdev->name))
1203 if (add_uevent_var(env, "HID_PHYS=%s", hdev->phys))
1206 if (add_uevent_var(env, "HID_UNIQ=%s", hdev->uniq))
1209 if (add_uevent_var(env, "MODALIAS=hid:b%04Xv%08Xp%08X",
1210 hdev->bus, hdev->vendor, hdev->product))
1216 static struct bus_type hid_bus_type = {
1218 .match = hid_bus_match,
1219 .probe = hid_device_probe,
1220 .remove = hid_device_remove,
1221 .uevent = hid_uevent,
1224 int hid_add_device(struct hid_device *hdev)
1226 static atomic_t id = ATOMIC_INIT(0);
1229 if (WARN_ON(hdev->status & HID_STAT_ADDED))
1232 /* XXX hack, any other cleaner solution < 20 bus_id bytes? */
1233 sprintf(hdev->dev.bus_id, "%04X:%04X:%04X.%04X", hdev->bus,
1234 hdev->vendor, hdev->product, atomic_inc_return(&id));
1236 ret = device_add(&hdev->dev);
1238 hdev->status |= HID_STAT_ADDED;
1242 EXPORT_SYMBOL_GPL(hid_add_device);
1245 * hid_allocate_device - allocate new hid device descriptor
1247 * Allocate and initialize hid device, so that hid_destroy_device might be
1250 * New hid_device pointer is returned on success, otherwise ERR_PTR encoded
1253 struct hid_device *hid_allocate_device(void)
1255 struct hid_device *hdev;
1259 hdev = kzalloc(sizeof(*hdev), GFP_KERNEL);
1261 return ERR_PTR(ret);
1263 device_initialize(&hdev->dev);
1264 hdev->dev.release = hid_device_release;
1265 hdev->dev.bus = &hid_bus_type;
1267 hdev->collection = kcalloc(HID_DEFAULT_NUM_COLLECTIONS,
1268 sizeof(struct hid_collection), GFP_KERNEL);
1269 if (hdev->collection == NULL)
1271 hdev->collection_size = HID_DEFAULT_NUM_COLLECTIONS;
1273 for (i = 0; i < HID_REPORT_TYPES; i++)
1274 INIT_LIST_HEAD(&hdev->report_enum[i].report_list);
1278 put_device(&hdev->dev);
1279 return ERR_PTR(ret);
1281 EXPORT_SYMBOL_GPL(hid_allocate_device);
1283 static void hid_remove_device(struct hid_device *hdev)
1285 if (hdev->status & HID_STAT_ADDED) {
1286 device_del(&hdev->dev);
1287 hdev->status &= ~HID_STAT_ADDED;
1292 * hid_destroy_device - free previously allocated device
1296 * If you allocate hid_device through hid_allocate_device, you should ever
1297 * free by this function.
1299 void hid_destroy_device(struct hid_device *hdev)
1301 hid_remove_device(hdev);
1302 put_device(&hdev->dev);
1304 EXPORT_SYMBOL_GPL(hid_destroy_device);
1306 int __hid_register_driver(struct hid_driver *hdrv, struct module *owner,
1307 const char *mod_name)
1309 hdrv->driver.name = hdrv->name;
1310 hdrv->driver.bus = &hid_bus_type;
1311 hdrv->driver.owner = owner;
1312 hdrv->driver.mod_name = mod_name;
1314 return driver_register(&hdrv->driver);
1316 EXPORT_SYMBOL_GPL(__hid_register_driver);
1318 void hid_unregister_driver(struct hid_driver *hdrv)
1320 driver_unregister(&hdrv->driver);
1322 EXPORT_SYMBOL_GPL(hid_unregister_driver);
1324 static int __init hid_init(void)
1328 ret = bus_register(&hid_bus_type);
1330 printk(KERN_ERR "HID: can't register hid bus\n");
1334 ret = hidraw_init();
1340 bus_unregister(&hid_bus_type);
1345 static void __exit hid_exit(void)
1348 bus_unregister(&hid_bus_type);
1351 module_init(hid_init);
1352 module_exit(hid_exit);
1354 MODULE_LICENSE(DRIVER_LICENSE);