1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * Copyright (c) 1999 Andreas Gal
4 * Copyright (c) 2000-2001 Vojtech Pavlik
5 * Copyright (c) 2006-2007 Jiri Kosina
9 * Should you need to contact me, the author, you can do so either by
10 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
11 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
17 #include <linux/bitops.h>
18 #include <linux/types.h>
19 #include <linux/slab.h>
20 #include <linux/list.h>
21 #include <linux/mod_devicetable.h> /* hid_device_id */
22 #include <linux/timer.h>
23 #include <linux/workqueue.h>
24 #include <linux/input.h>
25 #include <linux/semaphore.h>
26 #include <linux/mutex.h>
27 #include <linux/power_supply.h>
28 #include <uapi/linux/hid.h>
31 * We parse each description item into this structure. Short items data
32 * values are expanded to 32-bit signed int, long items contain a pointer
53 * HID report item format
56 #define HID_ITEM_FORMAT_SHORT 0
57 #define HID_ITEM_FORMAT_LONG 1
60 * Special tag indicating long items
63 #define HID_ITEM_TAG_LONG 15
66 * HID report descriptor item type (prefix bit 2,3)
69 #define HID_ITEM_TYPE_MAIN 0
70 #define HID_ITEM_TYPE_GLOBAL 1
71 #define HID_ITEM_TYPE_LOCAL 2
72 #define HID_ITEM_TYPE_RESERVED 3
75 * HID report descriptor main item tags
78 #define HID_MAIN_ITEM_TAG_INPUT 8
79 #define HID_MAIN_ITEM_TAG_OUTPUT 9
80 #define HID_MAIN_ITEM_TAG_FEATURE 11
81 #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10
82 #define HID_MAIN_ITEM_TAG_END_COLLECTION 12
85 * HID report descriptor main item contents
88 #define HID_MAIN_ITEM_CONSTANT 0x001
89 #define HID_MAIN_ITEM_VARIABLE 0x002
90 #define HID_MAIN_ITEM_RELATIVE 0x004
91 #define HID_MAIN_ITEM_WRAP 0x008
92 #define HID_MAIN_ITEM_NONLINEAR 0x010
93 #define HID_MAIN_ITEM_NO_PREFERRED 0x020
94 #define HID_MAIN_ITEM_NULL_STATE 0x040
95 #define HID_MAIN_ITEM_VOLATILE 0x080
96 #define HID_MAIN_ITEM_BUFFERED_BYTE 0x100
99 * HID report descriptor collection item types
102 #define HID_COLLECTION_PHYSICAL 0
103 #define HID_COLLECTION_APPLICATION 1
104 #define HID_COLLECTION_LOGICAL 2
107 * HID report descriptor global item tags
110 #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0
111 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1
112 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2
113 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3
114 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4
115 #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5
116 #define HID_GLOBAL_ITEM_TAG_UNIT 6
117 #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7
118 #define HID_GLOBAL_ITEM_TAG_REPORT_ID 8
119 #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9
120 #define HID_GLOBAL_ITEM_TAG_PUSH 10
121 #define HID_GLOBAL_ITEM_TAG_POP 11
124 * HID report descriptor local item tags
127 #define HID_LOCAL_ITEM_TAG_USAGE 0
128 #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1
129 #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2
130 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3
131 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4
132 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5
133 #define HID_LOCAL_ITEM_TAG_STRING_INDEX 7
134 #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8
135 #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9
136 #define HID_LOCAL_ITEM_TAG_DELIMITER 10
142 #define HID_USAGE_PAGE 0xffff0000
144 #define HID_UP_UNDEFINED 0x00000000
145 #define HID_UP_GENDESK 0x00010000
146 #define HID_UP_SIMULATION 0x00020000
147 #define HID_UP_GENDEVCTRLS 0x00060000
148 #define HID_UP_KEYBOARD 0x00070000
149 #define HID_UP_LED 0x00080000
150 #define HID_UP_BUTTON 0x00090000
151 #define HID_UP_ORDINAL 0x000a0000
152 #define HID_UP_TELEPHONY 0x000b0000
153 #define HID_UP_CONSUMER 0x000c0000
154 #define HID_UP_DIGITIZER 0x000d0000
155 #define HID_UP_PID 0x000f0000
156 #define HID_UP_HPVENDOR 0xff7f0000
157 #define HID_UP_HPVENDOR2 0xff010000
158 #define HID_UP_MSVENDOR 0xff000000
159 #define HID_UP_CUSTOM 0x00ff0000
160 #define HID_UP_LOGIVENDOR 0xffbc0000
161 #define HID_UP_LOGIVENDOR2 0xff090000
162 #define HID_UP_LOGIVENDOR3 0xff430000
163 #define HID_UP_LNVENDOR 0xffa00000
164 #define HID_UP_SENSOR 0x00200000
165 #define HID_UP_ASUSVENDOR 0xff310000
167 #define HID_USAGE 0x0000ffff
169 #define HID_GD_POINTER 0x00010001
170 #define HID_GD_MOUSE 0x00010002
171 #define HID_GD_JOYSTICK 0x00010004
172 #define HID_GD_GAMEPAD 0x00010005
173 #define HID_GD_KEYBOARD 0x00010006
174 #define HID_GD_KEYPAD 0x00010007
175 #define HID_GD_MULTIAXIS 0x00010008
177 * Microsoft Win8 Wireless Radio Controls extensions CA, see:
178 * http://www.usb.org/developers/hidpage/HUTRR40RadioHIDUsagesFinal.pdf
180 #define HID_GD_WIRELESS_RADIO_CTLS 0x0001000c
182 * System Multi-Axis, see:
183 * http://www.usb.org/developers/hidpage/HUTRR62_-_Generic_Desktop_CA_for_System_Multi-Axis_Controllers.txt
185 #define HID_GD_SYSTEM_MULTIAXIS 0x0001000e
187 #define HID_GD_X 0x00010030
188 #define HID_GD_Y 0x00010031
189 #define HID_GD_Z 0x00010032
190 #define HID_GD_RX 0x00010033
191 #define HID_GD_RY 0x00010034
192 #define HID_GD_RZ 0x00010035
193 #define HID_GD_SLIDER 0x00010036
194 #define HID_GD_DIAL 0x00010037
195 #define HID_GD_WHEEL 0x00010038
196 #define HID_GD_HATSWITCH 0x00010039
197 #define HID_GD_BUFFER 0x0001003a
198 #define HID_GD_BYTECOUNT 0x0001003b
199 #define HID_GD_MOTION 0x0001003c
200 #define HID_GD_START 0x0001003d
201 #define HID_GD_SELECT 0x0001003e
202 #define HID_GD_VX 0x00010040
203 #define HID_GD_VY 0x00010041
204 #define HID_GD_VZ 0x00010042
205 #define HID_GD_VBRX 0x00010043
206 #define HID_GD_VBRY 0x00010044
207 #define HID_GD_VBRZ 0x00010045
208 #define HID_GD_VNO 0x00010046
209 #define HID_GD_FEATURE 0x00010047
210 #define HID_GD_RESOLUTION_MULTIPLIER 0x00010048
211 #define HID_GD_SYSTEM_CONTROL 0x00010080
212 #define HID_GD_UP 0x00010090
213 #define HID_GD_DOWN 0x00010091
214 #define HID_GD_RIGHT 0x00010092
215 #define HID_GD_LEFT 0x00010093
216 /* Microsoft Win8 Wireless Radio Controls CA usage codes */
217 #define HID_GD_RFKILL_BTN 0x000100c6
218 #define HID_GD_RFKILL_LED 0x000100c7
219 #define HID_GD_RFKILL_SWITCH 0x000100c8
221 #define HID_DC_BATTERYSTRENGTH 0x00060020
223 #define HID_CP_CONSUMER_CONTROL 0x000c0001
224 #define HID_CP_AC_PAN 0x000c0238
226 #define HID_DG_DIGITIZER 0x000d0001
227 #define HID_DG_PEN 0x000d0002
228 #define HID_DG_LIGHTPEN 0x000d0003
229 #define HID_DG_TOUCHSCREEN 0x000d0004
230 #define HID_DG_TOUCHPAD 0x000d0005
231 #define HID_DG_WHITEBOARD 0x000d0006
232 #define HID_DG_STYLUS 0x000d0020
233 #define HID_DG_PUCK 0x000d0021
234 #define HID_DG_FINGER 0x000d0022
235 #define HID_DG_TIPPRESSURE 0x000d0030
236 #define HID_DG_BARRELPRESSURE 0x000d0031
237 #define HID_DG_INRANGE 0x000d0032
238 #define HID_DG_TOUCH 0x000d0033
239 #define HID_DG_UNTOUCH 0x000d0034
240 #define HID_DG_TAP 0x000d0035
241 #define HID_DG_TABLETFUNCTIONKEY 0x000d0039
242 #define HID_DG_PROGRAMCHANGEKEY 0x000d003a
243 #define HID_DG_BATTERYSTRENGTH 0x000d003b
244 #define HID_DG_INVERT 0x000d003c
245 #define HID_DG_TILT_X 0x000d003d
246 #define HID_DG_TILT_Y 0x000d003e
247 #define HID_DG_TWIST 0x000d0041
248 #define HID_DG_TIPSWITCH 0x000d0042
249 #define HID_DG_TIPSWITCH2 0x000d0043
250 #define HID_DG_BARRELSWITCH 0x000d0044
251 #define HID_DG_ERASER 0x000d0045
252 #define HID_DG_TABLETPICK 0x000d0046
254 #define HID_CP_CONSUMERCONTROL 0x000c0001
255 #define HID_CP_NUMERICKEYPAD 0x000c0002
256 #define HID_CP_PROGRAMMABLEBUTTONS 0x000c0003
257 #define HID_CP_MICROPHONE 0x000c0004
258 #define HID_CP_HEADPHONE 0x000c0005
259 #define HID_CP_GRAPHICEQUALIZER 0x000c0006
260 #define HID_CP_FUNCTIONBUTTONS 0x000c0036
261 #define HID_CP_SELECTION 0x000c0080
262 #define HID_CP_MEDIASELECTION 0x000c0087
263 #define HID_CP_SELECTDISC 0x000c00ba
264 #define HID_CP_VOLUMEUP 0x000c00e9
265 #define HID_CP_VOLUMEDOWN 0x000c00ea
266 #define HID_CP_PLAYBACKSPEED 0x000c00f1
267 #define HID_CP_PROXIMITY 0x000c0109
268 #define HID_CP_SPEAKERSYSTEM 0x000c0160
269 #define HID_CP_CHANNELLEFT 0x000c0161
270 #define HID_CP_CHANNELRIGHT 0x000c0162
271 #define HID_CP_CHANNELCENTER 0x000c0163
272 #define HID_CP_CHANNELFRONT 0x000c0164
273 #define HID_CP_CHANNELCENTERFRONT 0x000c0165
274 #define HID_CP_CHANNELSIDE 0x000c0166
275 #define HID_CP_CHANNELSURROUND 0x000c0167
276 #define HID_CP_CHANNELLOWFREQUENCYENHANCEMENT 0x000c0168
277 #define HID_CP_CHANNELTOP 0x000c0169
278 #define HID_CP_CHANNELUNKNOWN 0x000c016a
279 #define HID_CP_APPLICATIONLAUNCHBUTTONS 0x000c0180
280 #define HID_CP_GENERICGUIAPPLICATIONCONTROLS 0x000c0200
282 #define HID_DG_DEVICECONFIG 0x000d000e
283 #define HID_DG_DEVICESETTINGS 0x000d0023
284 #define HID_DG_AZIMUTH 0x000d003f
285 #define HID_DG_CONFIDENCE 0x000d0047
286 #define HID_DG_WIDTH 0x000d0048
287 #define HID_DG_HEIGHT 0x000d0049
288 #define HID_DG_CONTACTID 0x000d0051
289 #define HID_DG_INPUTMODE 0x000d0052
290 #define HID_DG_DEVICEINDEX 0x000d0053
291 #define HID_DG_CONTACTCOUNT 0x000d0054
292 #define HID_DG_CONTACTMAX 0x000d0055
293 #define HID_DG_SCANTIME 0x000d0056
294 #define HID_DG_SURFACESWITCH 0x000d0057
295 #define HID_DG_BUTTONSWITCH 0x000d0058
296 #define HID_DG_BUTTONTYPE 0x000d0059
297 #define HID_DG_BARRELSWITCH2 0x000d005a
298 #define HID_DG_TOOLSERIALNUMBER 0x000d005b
299 #define HID_DG_LATENCYMODE 0x000d0060
301 #define HID_VD_ASUS_CUSTOM_MEDIA_KEYS 0xff310076
303 * HID report types --- Ouch! HID spec says 1 2 3!
306 #define HID_INPUT_REPORT 0
307 #define HID_OUTPUT_REPORT 1
308 #define HID_FEATURE_REPORT 2
310 #define HID_REPORT_TYPES 3
313 * HID connect requests
316 #define HID_CONNECT_HIDINPUT BIT(0)
317 #define HID_CONNECT_HIDINPUT_FORCE BIT(1)
318 #define HID_CONNECT_HIDRAW BIT(2)
319 #define HID_CONNECT_HIDDEV BIT(3)
320 #define HID_CONNECT_HIDDEV_FORCE BIT(4)
321 #define HID_CONNECT_FF BIT(5)
322 #define HID_CONNECT_DRIVER BIT(6)
323 #define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
324 HID_CONNECT_HIDDEV|HID_CONNECT_FF)
331 * Increase this if you need to configure more HID quirks at module load time
333 #define MAX_USBHID_BOOT_QUIRKS 4
335 #define HID_QUIRK_INVERT BIT(0)
336 #define HID_QUIRK_NOTOUCH BIT(1)
337 #define HID_QUIRK_IGNORE BIT(2)
338 #define HID_QUIRK_NOGET BIT(3)
339 #define HID_QUIRK_HIDDEV_FORCE BIT(4)
340 #define HID_QUIRK_BADPAD BIT(5)
341 #define HID_QUIRK_MULTI_INPUT BIT(6)
342 #define HID_QUIRK_HIDINPUT_FORCE BIT(7)
343 /* BIT(8) reserved for backward compatibility, was HID_QUIRK_NO_EMPTY_INPUT */
344 /* BIT(9) reserved for backward compatibility, was NO_INIT_INPUT_REPORTS */
345 #define HID_QUIRK_ALWAYS_POLL BIT(10)
346 #define HID_QUIRK_INPUT_PER_APP BIT(11)
347 #define HID_QUIRK_X_INVERT BIT(12)
348 #define HID_QUIRK_Y_INVERT BIT(13)
349 #define HID_QUIRK_SKIP_OUTPUT_REPORTS BIT(16)
350 #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID BIT(17)
351 #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP BIT(18)
352 #define HID_QUIRK_HAVE_SPECIAL_DRIVER BIT(19)
353 #define HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE BIT(20)
354 #define HID_QUIRK_FULLSPEED_INTERVAL BIT(28)
355 #define HID_QUIRK_NO_INIT_REPORTS BIT(29)
356 #define HID_QUIRK_NO_IGNORE BIT(30)
357 #define HID_QUIRK_NO_INPUT_SYNC BIT(31)
362 * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h
363 * and has a value of 0x0000
365 #define HID_GROUP_GENERIC 0x0001
366 #define HID_GROUP_MULTITOUCH 0x0002
367 #define HID_GROUP_SENSOR_HUB 0x0003
368 #define HID_GROUP_MULTITOUCH_WIN_8 0x0004
371 * Vendor specific HID device groups
373 #define HID_GROUP_RMI 0x0100
374 #define HID_GROUP_WACOM 0x0101
375 #define HID_GROUP_LOGITECH_DJ_DEVICE 0x0102
376 #define HID_GROUP_STEAM 0x0103
377 #define HID_GROUP_LOGITECH_27MHZ_DEVICE 0x0104
380 * HID protocol status
382 #define HID_REPORT_PROTOCOL 1
383 #define HID_BOOT_PROTOCOL 0
386 * This is the global environment of the parser. This information is
387 * persistent for main-items. The global environment can be saved and
388 * restored with PUSH/POP statements.
393 __s32 logical_minimum;
394 __s32 logical_maximum;
395 __s32 physical_minimum;
396 __s32 physical_maximum;
400 unsigned report_size;
401 unsigned report_count;
405 * This is the local environment. It is persistent up the next main-item.
408 #define HID_MAX_USAGES 12288
409 #define HID_DEFAULT_NUM_COLLECTIONS 16
412 unsigned usage[HID_MAX_USAGES]; /* usage array */
413 u8 usage_size[HID_MAX_USAGES]; /* usage size array */
414 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
415 unsigned usage_index;
416 unsigned usage_minimum;
417 unsigned delimiter_depth;
418 unsigned delimiter_branch;
422 * This is the collection stack. We climb up the stack to determine
423 * application and function of each field.
426 struct hid_collection {
427 int parent_idx; /* device->collection */
434 unsigned hid; /* hid usage code */
435 unsigned collection_index; /* index into collection array */
436 unsigned usage_index; /* index into usage array */
437 __s8 resolution_multiplier;/* Effective Resolution Multiplier
438 (HUT v1.12, 4.3.1), default: 1 */
440 __s8 wheel_factor; /* 120/resolution_multiplier */
441 __u16 code; /* input driver code */
442 __u8 type; /* input driver type */
443 __s8 hat_min; /* hat switch fun */
444 __s8 hat_max; /* ditto */
445 __s8 hat_dir; /* ditto */
446 __s16 wheel_accumulated; /* hi-res wheel */
452 unsigned physical; /* physical usage for this field */
453 unsigned logical; /* logical usage for this field */
454 unsigned application; /* application usage for this field */
455 struct hid_usage *usage; /* usage table for this function */
456 unsigned maxusage; /* maximum usage index */
457 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
458 unsigned report_offset; /* bit offset in the report */
459 unsigned report_size; /* size of this field in the report */
460 unsigned report_count; /* number of this field in the report */
461 unsigned report_type; /* (input,output,feature) */
462 __s32 *value; /* last known value(s) */
463 __s32 logical_minimum;
464 __s32 logical_maximum;
465 __s32 physical_minimum;
466 __s32 physical_maximum;
469 struct hid_report *report; /* associated report */
470 unsigned index; /* index into report->field[] */
472 struct hid_input *hidinput; /* associated input structure */
473 __u16 dpad; /* dpad input code */
476 #define HID_MAX_FIELDS 256
479 struct list_head list;
480 struct list_head hidinput_list;
481 unsigned int id; /* id of this report */
482 unsigned int type; /* report type */
483 unsigned int application; /* application usage for this report */
484 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
485 unsigned maxfield; /* maximum valid field index */
486 unsigned size; /* size of the report (bits) */
487 struct hid_device *device; /* associated device */
490 #define HID_MAX_IDS 256
492 struct hid_report_enum {
494 struct list_head report_list;
495 struct hid_report *report_id_hash[HID_MAX_IDS];
498 #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
499 #define HID_MAX_BUFFER_SIZE 8192 /* 8kb */
500 #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
501 #define HID_OUTPUT_FIFO_SIZE 64
503 struct hid_control_fifo {
505 struct hid_report *report;
509 struct hid_output_fifo {
510 struct hid_report *report;
514 #define HID_CLAIMED_INPUT BIT(0)
515 #define HID_CLAIMED_HIDDEV BIT(1)
516 #define HID_CLAIMED_HIDRAW BIT(2)
517 #define HID_CLAIMED_DRIVER BIT(3)
519 #define HID_STAT_ADDED BIT(0)
520 #define HID_STAT_PARSED BIT(1)
521 #define HID_STAT_DUP_DETECTED BIT(2)
522 #define HID_STAT_REPROBED BIT(3)
525 struct list_head list;
526 struct hid_report *report;
527 struct input_dev *input;
530 struct list_head reports; /* the list of reports */
531 unsigned int application; /* application usage for this input */
540 enum hid_battery_status {
541 HID_BATTERY_UNKNOWN = 0,
542 HID_BATTERY_QUERIED, /* Kernel explicitly queried battery strength */
543 HID_BATTERY_REPORTED, /* Device sent unsolicited battery strength report */
547 struct hid_ll_driver;
549 struct hid_device { /* device report descriptor */
554 struct hid_collection *collection; /* List of HID collections */
555 unsigned collection_size; /* Number of allocated hid_collections */
556 unsigned maxcollection; /* Number of parsed collections */
557 unsigned maxapplication; /* Number of applications */
558 __u16 bus; /* BUS ID */
559 __u16 group; /* Report group */
560 __u32 vendor; /* Vendor ID */
561 __u32 product; /* Product ID */
562 __u32 version; /* HID version */
563 enum hid_type type; /* device type (mouse, kbd, ...) */
564 unsigned country; /* HID country */
565 struct hid_report_enum report_enum[HID_REPORT_TYPES];
566 struct work_struct led_work; /* delayed LED worker */
568 struct semaphore driver_input_lock; /* protects the current driver */
569 struct device dev; /* device */
570 struct hid_driver *driver;
572 struct hid_ll_driver *ll_driver;
573 struct mutex ll_open_lock;
574 unsigned int ll_open_count;
576 #ifdef CONFIG_HID_BATTERY_STRENGTH
578 * Power supply information for HID devices which report
579 * battery strength. power_supply was successfully registered if
580 * battery is non-NULL.
582 struct power_supply *battery;
583 __s32 battery_capacity;
586 __s32 battery_report_type;
587 __s32 battery_report_id;
588 enum hid_battery_status battery_status;
589 bool battery_avoid_query;
592 unsigned long status; /* see STAT flags above */
593 unsigned claimed; /* Claimed by hidinput, hiddev? */
594 unsigned quirks; /* Various quirks the device can pull on us */
595 bool io_started; /* If IO has started */
597 struct list_head inputs; /* The list of inputs */
598 void *hiddev; /* The hiddev structure */
601 char name[128]; /* Device name */
602 char phys[64]; /* Device physical location */
603 char uniq[64]; /* Device unique identifier (serial #) */
607 /* temporary hid_ff handling (until moved to the drivers) */
608 int (*ff_init)(struct hid_device *);
610 /* hiddev event handler */
611 int (*hiddev_connect)(struct hid_device *, unsigned int);
612 void (*hiddev_disconnect)(struct hid_device *);
613 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
614 struct hid_usage *, __s32);
615 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
617 /* debugging support via debugfs */
618 unsigned short debug;
619 struct dentry *debug_dir;
620 struct dentry *debug_rdesc;
621 struct dentry *debug_events;
622 struct list_head debug_list;
623 spinlock_t debug_list_lock;
624 wait_queue_head_t debug_wait;
627 #define to_hid_device(pdev) \
628 container_of(pdev, struct hid_device, dev)
630 static inline void *hid_get_drvdata(struct hid_device *hdev)
632 return dev_get_drvdata(&hdev->dev);
635 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
637 dev_set_drvdata(&hdev->dev, data);
640 #define HID_GLOBAL_STACK_SIZE 4
641 #define HID_COLLECTION_STACK_SIZE 4
643 #define HID_SCAN_FLAG_MT_WIN_8 BIT(0)
644 #define HID_SCAN_FLAG_VENDOR_SPECIFIC BIT(1)
645 #define HID_SCAN_FLAG_GD_POINTER BIT(2)
648 struct hid_global global;
649 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
650 unsigned int global_stack_ptr;
651 struct hid_local local;
652 unsigned int *collection_stack;
653 unsigned int collection_stack_ptr;
654 unsigned int collection_stack_size;
655 struct hid_device *device;
656 unsigned int scan_flags;
659 struct hid_class_descriptor {
660 __u8 bDescriptorType;
661 __le16 wDescriptorLength;
662 } __attribute__ ((packed));
664 struct hid_descriptor {
666 __u8 bDescriptorType;
669 __u8 bNumDescriptors;
671 struct hid_class_descriptor desc[1];
672 } __attribute__ ((packed));
674 #define HID_DEVICE(b, g, ven, prod) \
675 .bus = (b), .group = (g), .vendor = (ven), .product = (prod)
676 #define HID_USB_DEVICE(ven, prod) \
677 .bus = BUS_USB, .vendor = (ven), .product = (prod)
678 #define HID_BLUETOOTH_DEVICE(ven, prod) \
679 .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod)
680 #define HID_I2C_DEVICE(ven, prod) \
681 .bus = BUS_I2C, .vendor = (ven), .product = (prod)
683 #define HID_REPORT_ID(rep) \
685 #define HID_USAGE_ID(uhid, utype, ucode) \
686 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
687 /* we don't want to catch types and codes equal to 0 */
688 #define HID_TERMINATOR (HID_ANY_ID - 1)
690 struct hid_report_id {
693 struct hid_usage_id {
701 * @name: driver name (e.g. "Footech_bar-wheel")
702 * @id_table: which devices is this driver for (must be non-NULL for probe
704 * @dyn_list: list of dynamically added device ids
705 * @dyn_lock: lock protecting @dyn_list
706 * @match: check if the given device is handled by this driver
707 * @probe: new device inserted
708 * @remove: device removed (NULL if not a hot-plug capable driver)
709 * @report_table: on which reports to call raw_event (NULL means all)
710 * @raw_event: if report in report_table, this hook is called (NULL means nop)
711 * @usage_table: on which events to call event (NULL means all)
712 * @event: if usage in usage_table, this hook is called (NULL means nop)
713 * @report: this hook is called after parsing a report (NULL means nop)
714 * @report_fixup: called before report descriptor parsing (NULL means nop)
715 * @input_mapping: invoked on input registering before mapping an usage
716 * @input_mapped: invoked on input registering after mapping an usage
717 * @input_configured: invoked just before the device is registered
718 * @feature_mapping: invoked on feature registering
719 * @suspend: invoked on suspend (NULL means nop)
720 * @resume: invoked on resume if device was not reset (NULL means nop)
721 * @reset_resume: invoked on resume if device was reset (NULL means nop)
723 * probe should return -errno on error, or 0 on success. During probe,
724 * input will not be passed to raw_event unless hid_device_io_start is
727 * raw_event and event should return negative on error, any other value will
728 * pass the event on to .event() typically return 0 for success.
730 * input_mapping shall return a negative value to completely ignore this usage
731 * (e.g. doubled or invalid usage), zero to continue with parsing of this
732 * usage by generic code (no special handling needed) or positive to skip
733 * generic parsing (needed special handling which was done in the hook already)
734 * input_mapped shall return negative to inform the layer that this usage
735 * should not be considered for further processing or zero to notify that
736 * no processing was performed and should be done in a generic manner
737 * Both these functions may be NULL which means the same behavior as returning
742 const struct hid_device_id *id_table;
744 struct list_head dyn_list;
747 bool (*match)(struct hid_device *dev, bool ignore_special_driver);
748 int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
749 void (*remove)(struct hid_device *dev);
751 const struct hid_report_id *report_table;
752 int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
754 const struct hid_usage_id *usage_table;
755 int (*event)(struct hid_device *hdev, struct hid_field *field,
756 struct hid_usage *usage, __s32 value);
757 void (*report)(struct hid_device *hdev, struct hid_report *report);
759 __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
762 int (*input_mapping)(struct hid_device *hdev,
763 struct hid_input *hidinput, struct hid_field *field,
764 struct hid_usage *usage, unsigned long **bit, int *max);
765 int (*input_mapped)(struct hid_device *hdev,
766 struct hid_input *hidinput, struct hid_field *field,
767 struct hid_usage *usage, unsigned long **bit, int *max);
768 int (*input_configured)(struct hid_device *hdev,
769 struct hid_input *hidinput);
770 void (*feature_mapping)(struct hid_device *hdev,
771 struct hid_field *field,
772 struct hid_usage *usage);
774 int (*suspend)(struct hid_device *hdev, pm_message_t message);
775 int (*resume)(struct hid_device *hdev);
776 int (*reset_resume)(struct hid_device *hdev);
779 struct device_driver driver;
782 #define to_hid_driver(pdrv) \
783 container_of(pdrv, struct hid_driver, driver)
786 * hid_ll_driver - low level driver callbacks
787 * @start: called on probe to start the device
788 * @stop: called on remove
789 * @open: called by input layer on open
790 * @close: called by input layer on close
791 * @power: request underlying hardware to enter requested power mode
792 * @parse: this method is called only once to parse the device data,
793 * shouldn't allocate anything to not leak memory
794 * @request: send report request to device (e.g. feature report)
795 * @wait: wait for buffered io to complete (send/recv reports)
796 * @raw_request: send raw report request to device (e.g. feature report)
797 * @output_report: send output report to device
798 * @idle: send idle request to device
799 * @max_buffer_size: over-ride maximum data buffer size (default: HID_MAX_BUFFER_SIZE)
801 struct hid_ll_driver {
802 int (*start)(struct hid_device *hdev);
803 void (*stop)(struct hid_device *hdev);
805 int (*open)(struct hid_device *hdev);
806 void (*close)(struct hid_device *hdev);
808 int (*power)(struct hid_device *hdev, int level);
810 int (*parse)(struct hid_device *hdev);
812 void (*request)(struct hid_device *hdev,
813 struct hid_report *report, int reqtype);
815 int (*wait)(struct hid_device *hdev);
817 int (*raw_request) (struct hid_device *hdev, unsigned char reportnum,
818 __u8 *buf, size_t len, unsigned char rtype,
821 int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len);
823 int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype);
825 unsigned int max_buffer_size;
828 extern struct hid_ll_driver i2c_hid_ll_driver;
829 extern struct hid_ll_driver hidp_hid_driver;
830 extern struct hid_ll_driver uhid_hid_driver;
831 extern struct hid_ll_driver usb_hid_driver;
833 static inline bool hid_is_using_ll_driver(struct hid_device *hdev,
834 struct hid_ll_driver *driver)
836 return hdev->ll_driver == driver;
839 static inline bool hid_is_usb(struct hid_device *hdev)
841 return hid_is_using_ll_driver(hdev, &usb_hid_driver);
844 #define PM_HINT_FULLON 1<<5
845 #define PM_HINT_NORMAL 1<<1
847 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
848 /* We ignore a few input applications that are not widely used */
849 #define IS_INPUT_APPLICATION(a) \
850 (((a >= HID_UP_GENDESK) && (a <= HID_GD_MULTIAXIS)) \
851 || ((a >= HID_DG_PEN) && (a <= HID_DG_WHITEBOARD)) \
852 || (a == HID_GD_SYSTEM_CONTROL) || (a == HID_CP_CONSUMER_CONTROL) \
853 || (a == HID_GD_WIRELESS_RADIO_CTLS))
857 extern int hid_debug;
859 extern bool hid_ignore(struct hid_device *);
860 extern int hid_add_device(struct hid_device *);
861 extern void hid_destroy_device(struct hid_device *);
863 extern struct bus_type hid_bus_type;
865 extern int __must_check __hid_register_driver(struct hid_driver *,
866 struct module *, const char *mod_name);
868 /* use a define to avoid include chaining to get THIS_MODULE & friends */
869 #define hid_register_driver(driver) \
870 __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
872 extern void hid_unregister_driver(struct hid_driver *);
875 * module_hid_driver() - Helper macro for registering a HID driver
876 * @__hid_driver: hid_driver struct
878 * Helper macro for HID drivers which do not do anything special in module
879 * init/exit. This eliminates a lot of boilerplate. Each module may only
880 * use this macro once, and calling it replaces module_init() and module_exit()
882 #define module_hid_driver(__hid_driver) \
883 module_driver(__hid_driver, hid_register_driver, \
884 hid_unregister_driver)
886 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
887 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
888 extern int hidinput_connect(struct hid_device *hid, unsigned int force);
889 extern void hidinput_disconnect(struct hid_device *);
891 int hid_set_field(struct hid_field *, unsigned, __s32);
892 int hid_input_report(struct hid_device *, int type, u8 *, u32, int);
893 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
894 struct hid_field *hidinput_get_led_field(struct hid_device *hid);
895 unsigned int hidinput_count_leds(struct hid_device *hid);
896 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
897 void hid_output_report(struct hid_report *report, __u8 *data);
898 int __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype);
899 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags);
900 struct hid_device *hid_allocate_device(void);
901 struct hid_report *hid_register_report(struct hid_device *device,
902 unsigned int type, unsigned int id,
903 unsigned int application);
904 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
905 struct hid_report *hid_validate_values(struct hid_device *hid,
906 unsigned int type, unsigned int id,
907 unsigned int field_index,
908 unsigned int report_counts);
910 void hid_setup_resolution_multiplier(struct hid_device *hid);
911 int hid_open_report(struct hid_device *device);
912 int hid_check_keys_pressed(struct hid_device *hid);
913 int hid_connect(struct hid_device *hid, unsigned int connect_mask);
914 void hid_disconnect(struct hid_device *hid);
915 bool hid_match_one_id(const struct hid_device *hdev,
916 const struct hid_device_id *id);
917 const struct hid_device_id *hid_match_id(const struct hid_device *hdev,
918 const struct hid_device_id *id);
919 const struct hid_device_id *hid_match_device(struct hid_device *hdev,
920 struct hid_driver *hdrv);
921 bool hid_compare_device_paths(struct hid_device *hdev_a,
922 struct hid_device *hdev_b, char separator);
923 s32 hid_snto32(__u32 value, unsigned n);
924 __u32 hid_field_extract(const struct hid_device *hid, __u8 *report,
925 unsigned offset, unsigned n);
928 * hid_device_io_start - enable HID input during probe, remove
932 * This should only be called during probe or remove and only be
933 * called by the thread calling probe or remove. It will allow
934 * incoming packets to be delivered to the driver.
936 static inline void hid_device_io_start(struct hid_device *hid) {
937 if (hid->io_started) {
938 dev_warn(&hid->dev, "io already started\n");
941 hid->io_started = true;
942 up(&hid->driver_input_lock);
946 * hid_device_io_stop - disable HID input during probe, remove
950 * Should only be called after hid_device_io_start. It will prevent
951 * incoming packets from going to the driver for the duration of
952 * probe, remove. If called during probe, packets will still go to the
953 * driver after probe is complete. This function should only be called
954 * by the thread calling probe or remove.
956 static inline void hid_device_io_stop(struct hid_device *hid) {
957 if (!hid->io_started) {
958 dev_warn(&hid->dev, "io already stopped\n");
961 hid->io_started = false;
962 down(&hid->driver_input_lock);
966 * hid_map_usage - map usage input bits
968 * @hidinput: hidinput which we are interested in
969 * @usage: usage to fill in
970 * @bit: pointer to input->{}bit (out parameter)
971 * @max: maximal valid usage->code to consider later (out parameter)
972 * @type: input event type (EV_KEY, EV_REL, ...)
973 * @c: code which corresponds to this usage and type
975 * The value pointed to by @bit will be set to NULL if either @type is
976 * an unhandled event type, or if @c is out of range for @type. This
977 * can be used as an error condition.
979 static inline void hid_map_usage(struct hid_input *hidinput,
980 struct hid_usage *usage, unsigned long **bit, int *max,
981 __u8 type, unsigned int c)
983 struct input_dev *input = hidinput->input;
984 unsigned long *bmap = NULL;
985 unsigned int limit = 0;
989 bmap = input->absbit;
993 bmap = input->relbit;
997 bmap = input->keybit;
1001 bmap = input->ledbit;
1006 if (unlikely(c > limit || !bmap)) {
1007 pr_warn_ratelimited("%s: Invalid code %d type %d\n",
1008 input->name, c, type);
1020 * hid_map_usage_clear - map usage input bits and clear the input bit
1022 * The same as hid_map_usage, except the @c bit is also cleared in supported
1025 static inline void hid_map_usage_clear(struct hid_input *hidinput,
1026 struct hid_usage *usage, unsigned long **bit, int *max,
1029 hid_map_usage(hidinput, usage, bit, max, type, c);
1031 clear_bit(usage->code, *bit);
1035 * hid_parse - parse HW reports
1039 * Call this from probe after you set up the device (if needed). Your
1040 * report_fixup will be called (if non-NULL) after reading raw report from
1041 * device before passing it to hid layer for real parsing.
1043 static inline int __must_check hid_parse(struct hid_device *hdev)
1045 return hid_open_report(hdev);
1048 int __must_check hid_hw_start(struct hid_device *hdev,
1049 unsigned int connect_mask);
1050 void hid_hw_stop(struct hid_device *hdev);
1051 int __must_check hid_hw_open(struct hid_device *hdev);
1052 void hid_hw_close(struct hid_device *hdev);
1055 * hid_hw_power - requests underlying HW to go into given power mode
1058 * @level: requested power level (one of %PM_HINT_* defines)
1060 * This function requests underlying hardware to enter requested power
1064 static inline int hid_hw_power(struct hid_device *hdev, int level)
1066 return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
1071 * hid_hw_request - send report request to device
1074 * @report: report to send
1075 * @reqtype: hid request type
1077 static inline void hid_hw_request(struct hid_device *hdev,
1078 struct hid_report *report, int reqtype)
1080 if (hdev->ll_driver->request)
1081 return hdev->ll_driver->request(hdev, report, reqtype);
1083 __hid_request(hdev, report, reqtype);
1087 * hid_hw_raw_request - send report request to device
1090 * @reportnum: report ID
1091 * @buf: in/out data to transfer
1092 * @len: length of buf
1093 * @rtype: HID report type
1094 * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
1096 * @return: count of data transfered, negative if error
1098 * Same behavior as hid_hw_request, but with raw buffers instead.
1100 static inline int hid_hw_raw_request(struct hid_device *hdev,
1101 unsigned char reportnum, __u8 *buf,
1102 size_t len, unsigned char rtype, int reqtype)
1104 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1107 return hdev->ll_driver->raw_request(hdev, reportnum, buf, len,
1112 * hid_hw_output_report - send output report to device
1115 * @buf: raw data to transfer
1116 * @len: length of buf
1118 * @return: count of data transfered, negative if error
1120 static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf,
1123 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1126 if (hdev->ll_driver->output_report)
1127 return hdev->ll_driver->output_report(hdev, buf, len);
1133 * hid_hw_idle - send idle request to device
1136 * @report: report to control
1138 * @reqtype: hid request type
1140 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
1143 if (hdev->ll_driver->idle)
1144 return hdev->ll_driver->idle(hdev, report, idle, reqtype);
1150 * hid_hw_wait - wait for buffered io to complete
1154 static inline void hid_hw_wait(struct hid_device *hdev)
1156 if (hdev->ll_driver->wait)
1157 hdev->ll_driver->wait(hdev);
1161 * hid_report_len - calculate the report length
1163 * @report: the report we want to know the length
1165 static inline u32 hid_report_len(struct hid_report *report)
1167 return DIV_ROUND_UP(report->size, 8) + (report->id > 0);
1170 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, u32 size,
1173 /* HID quirks API */
1174 unsigned long hid_lookup_quirk(const struct hid_device *hdev);
1175 int hid_quirks_init(char **quirks_param, __u16 bus, int count);
1176 void hid_quirks_exit(__u16 bus);
1178 #ifdef CONFIG_HID_PID
1179 int hid_pidff_init(struct hid_device *hid);
1181 #define hid_pidff_init NULL
1184 #define dbg_hid(fmt, ...) \
1187 printk(KERN_DEBUG "%s: " fmt, __FILE__, ##__VA_ARGS__); \
1190 #define hid_err(hid, fmt, ...) \
1191 dev_err(&(hid)->dev, fmt, ##__VA_ARGS__)
1192 #define hid_notice(hid, fmt, ...) \
1193 dev_notice(&(hid)->dev, fmt, ##__VA_ARGS__)
1194 #define hid_warn(hid, fmt, ...) \
1195 dev_warn(&(hid)->dev, fmt, ##__VA_ARGS__)
1196 #define hid_info(hid, fmt, ...) \
1197 dev_info(&(hid)->dev, fmt, ##__VA_ARGS__)
1198 #define hid_dbg(hid, fmt, ...) \
1199 dev_dbg(&(hid)->dev, fmt, ##__VA_ARGS__)
1201 #define hid_err_once(hid, fmt, ...) \
1202 dev_err_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1203 #define hid_notice_once(hid, fmt, ...) \
1204 dev_notice_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1205 #define hid_warn_once(hid, fmt, ...) \
1206 dev_warn_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1207 #define hid_info_once(hid, fmt, ...) \
1208 dev_info_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1209 #define hid_dbg_once(hid, fmt, ...) \
1210 dev_dbg_once(&(hid)->dev, fmt, ##__VA_ARGS__)