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_BATTERY 0x00850000
157 #define HID_UP_HPVENDOR 0xff7f0000
158 #define HID_UP_HPVENDOR2 0xff010000
159 #define HID_UP_MSVENDOR 0xff000000
160 #define HID_UP_CUSTOM 0x00ff0000
161 #define HID_UP_LOGIVENDOR 0xffbc0000
162 #define HID_UP_LOGIVENDOR2 0xff090000
163 #define HID_UP_LOGIVENDOR3 0xff430000
164 #define HID_UP_LNVENDOR 0xffa00000
165 #define HID_UP_SENSOR 0x00200000
166 #define HID_UP_ASUSVENDOR 0xff310000
167 #define HID_UP_GOOGLEVENDOR 0xffd10000
169 #define HID_USAGE 0x0000ffff
171 #define HID_GD_POINTER 0x00010001
172 #define HID_GD_MOUSE 0x00010002
173 #define HID_GD_JOYSTICK 0x00010004
174 #define HID_GD_GAMEPAD 0x00010005
175 #define HID_GD_KEYBOARD 0x00010006
176 #define HID_GD_KEYPAD 0x00010007
177 #define HID_GD_MULTIAXIS 0x00010008
179 * Microsoft Win8 Wireless Radio Controls extensions CA, see:
180 * http://www.usb.org/developers/hidpage/HUTRR40RadioHIDUsagesFinal.pdf
182 #define HID_GD_WIRELESS_RADIO_CTLS 0x0001000c
184 * System Multi-Axis, see:
185 * http://www.usb.org/developers/hidpage/HUTRR62_-_Generic_Desktop_CA_for_System_Multi-Axis_Controllers.txt
187 #define HID_GD_SYSTEM_MULTIAXIS 0x0001000e
189 #define HID_GD_X 0x00010030
190 #define HID_GD_Y 0x00010031
191 #define HID_GD_Z 0x00010032
192 #define HID_GD_RX 0x00010033
193 #define HID_GD_RY 0x00010034
194 #define HID_GD_RZ 0x00010035
195 #define HID_GD_SLIDER 0x00010036
196 #define HID_GD_DIAL 0x00010037
197 #define HID_GD_WHEEL 0x00010038
198 #define HID_GD_HATSWITCH 0x00010039
199 #define HID_GD_BUFFER 0x0001003a
200 #define HID_GD_BYTECOUNT 0x0001003b
201 #define HID_GD_MOTION 0x0001003c
202 #define HID_GD_START 0x0001003d
203 #define HID_GD_SELECT 0x0001003e
204 #define HID_GD_VX 0x00010040
205 #define HID_GD_VY 0x00010041
206 #define HID_GD_VZ 0x00010042
207 #define HID_GD_VBRX 0x00010043
208 #define HID_GD_VBRY 0x00010044
209 #define HID_GD_VBRZ 0x00010045
210 #define HID_GD_VNO 0x00010046
211 #define HID_GD_FEATURE 0x00010047
212 #define HID_GD_RESOLUTION_MULTIPLIER 0x00010048
213 #define HID_GD_SYSTEM_CONTROL 0x00010080
214 #define HID_GD_UP 0x00010090
215 #define HID_GD_DOWN 0x00010091
216 #define HID_GD_RIGHT 0x00010092
217 #define HID_GD_LEFT 0x00010093
218 /* Microsoft Win8 Wireless Radio Controls CA usage codes */
219 #define HID_GD_RFKILL_BTN 0x000100c6
220 #define HID_GD_RFKILL_LED 0x000100c7
221 #define HID_GD_RFKILL_SWITCH 0x000100c8
223 #define HID_DC_BATTERYSTRENGTH 0x00060020
225 #define HID_CP_CONSUMER_CONTROL 0x000c0001
226 #define HID_CP_AC_PAN 0x000c0238
228 #define HID_DG_DIGITIZER 0x000d0001
229 #define HID_DG_PEN 0x000d0002
230 #define HID_DG_LIGHTPEN 0x000d0003
231 #define HID_DG_TOUCHSCREEN 0x000d0004
232 #define HID_DG_TOUCHPAD 0x000d0005
233 #define HID_DG_WHITEBOARD 0x000d0006
234 #define HID_DG_STYLUS 0x000d0020
235 #define HID_DG_PUCK 0x000d0021
236 #define HID_DG_FINGER 0x000d0022
237 #define HID_DG_TIPPRESSURE 0x000d0030
238 #define HID_DG_BARRELPRESSURE 0x000d0031
239 #define HID_DG_INRANGE 0x000d0032
240 #define HID_DG_TOUCH 0x000d0033
241 #define HID_DG_UNTOUCH 0x000d0034
242 #define HID_DG_TAP 0x000d0035
243 #define HID_DG_TABLETFUNCTIONKEY 0x000d0039
244 #define HID_DG_PROGRAMCHANGEKEY 0x000d003a
245 #define HID_DG_BATTERYSTRENGTH 0x000d003b
246 #define HID_DG_INVERT 0x000d003c
247 #define HID_DG_TILT_X 0x000d003d
248 #define HID_DG_TILT_Y 0x000d003e
249 #define HID_DG_TWIST 0x000d0041
250 #define HID_DG_TIPSWITCH 0x000d0042
251 #define HID_DG_TIPSWITCH2 0x000d0043
252 #define HID_DG_BARRELSWITCH 0x000d0044
253 #define HID_DG_ERASER 0x000d0045
254 #define HID_DG_TABLETPICK 0x000d0046
256 #define HID_CP_CONSUMERCONTROL 0x000c0001
257 #define HID_CP_NUMERICKEYPAD 0x000c0002
258 #define HID_CP_PROGRAMMABLEBUTTONS 0x000c0003
259 #define HID_CP_MICROPHONE 0x000c0004
260 #define HID_CP_HEADPHONE 0x000c0005
261 #define HID_CP_GRAPHICEQUALIZER 0x000c0006
262 #define HID_CP_FUNCTIONBUTTONS 0x000c0036
263 #define HID_CP_SELECTION 0x000c0080
264 #define HID_CP_MEDIASELECTION 0x000c0087
265 #define HID_CP_SELECTDISC 0x000c00ba
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_BAT_ABSOLUTESTATEOFCHARGE 0x00850065
303 #define HID_VD_ASUS_CUSTOM_MEDIA_KEYS 0xff310076
305 * HID report types --- Ouch! HID spec says 1 2 3!
308 #define HID_INPUT_REPORT 0
309 #define HID_OUTPUT_REPORT 1
310 #define HID_FEATURE_REPORT 2
312 #define HID_REPORT_TYPES 3
315 * HID connect requests
318 #define HID_CONNECT_HIDINPUT BIT(0)
319 #define HID_CONNECT_HIDINPUT_FORCE BIT(1)
320 #define HID_CONNECT_HIDRAW BIT(2)
321 #define HID_CONNECT_HIDDEV BIT(3)
322 #define HID_CONNECT_HIDDEV_FORCE BIT(4)
323 #define HID_CONNECT_FF BIT(5)
324 #define HID_CONNECT_DRIVER BIT(6)
325 #define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
326 HID_CONNECT_HIDDEV|HID_CONNECT_FF)
333 * Increase this if you need to configure more HID quirks at module load time
335 #define MAX_USBHID_BOOT_QUIRKS 4
337 #define HID_QUIRK_INVERT BIT(0)
338 #define HID_QUIRK_NOTOUCH BIT(1)
339 #define HID_QUIRK_IGNORE BIT(2)
340 #define HID_QUIRK_NOGET BIT(3)
341 #define HID_QUIRK_HIDDEV_FORCE BIT(4)
342 #define HID_QUIRK_BADPAD BIT(5)
343 #define HID_QUIRK_MULTI_INPUT BIT(6)
344 #define HID_QUIRK_HIDINPUT_FORCE BIT(7)
345 /* BIT(8) reserved for backward compatibility, was HID_QUIRK_NO_EMPTY_INPUT */
346 /* BIT(9) reserved for backward compatibility, was NO_INIT_INPUT_REPORTS */
347 #define HID_QUIRK_ALWAYS_POLL BIT(10)
348 #define HID_QUIRK_INPUT_PER_APP BIT(11)
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
378 #define HID_GROUP_VIVALDI 0x0105
381 * HID protocol status
383 #define HID_REPORT_PROTOCOL 1
384 #define HID_BOOT_PROTOCOL 0
387 * This is the global environment of the parser. This information is
388 * persistent for main-items. The global environment can be saved and
389 * restored with PUSH/POP statements.
394 __s32 logical_minimum;
395 __s32 logical_maximum;
396 __s32 physical_minimum;
397 __s32 physical_maximum;
401 unsigned report_size;
402 unsigned report_count;
406 * This is the local environment. It is persistent up the next main-item.
409 #define HID_MAX_USAGES 12288
410 #define HID_DEFAULT_NUM_COLLECTIONS 16
413 unsigned usage[HID_MAX_USAGES]; /* usage array */
414 u8 usage_size[HID_MAX_USAGES]; /* usage size array */
415 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
416 unsigned usage_index;
417 unsigned usage_minimum;
418 unsigned delimiter_depth;
419 unsigned delimiter_branch;
423 * This is the collection stack. We climb up the stack to determine
424 * application and function of each field.
427 struct hid_collection {
428 int parent_idx; /* device->collection */
435 unsigned hid; /* hid usage code */
436 unsigned collection_index; /* index into collection array */
437 unsigned usage_index; /* index into usage array */
438 __s8 resolution_multiplier;/* Effective Resolution Multiplier
439 (HUT v1.12, 4.3.1), default: 1 */
441 __s8 wheel_factor; /* 120/resolution_multiplier */
442 __u16 code; /* input driver code */
443 __u8 type; /* input driver type */
444 __s8 hat_min; /* hat switch fun */
445 __s8 hat_max; /* ditto */
446 __s8 hat_dir; /* ditto */
447 __s16 wheel_accumulated; /* hi-res wheel */
453 unsigned physical; /* physical usage for this field */
454 unsigned logical; /* logical usage for this field */
455 unsigned application; /* application usage for this field */
456 struct hid_usage *usage; /* usage table for this function */
457 unsigned maxusage; /* maximum usage index */
458 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
459 unsigned report_offset; /* bit offset in the report */
460 unsigned report_size; /* size of this field in the report */
461 unsigned report_count; /* number of this field in the report */
462 unsigned report_type; /* (input,output,feature) */
463 __s32 *value; /* last known value(s) */
464 __s32 logical_minimum;
465 __s32 logical_maximum;
466 __s32 physical_minimum;
467 __s32 physical_maximum;
470 struct hid_report *report; /* associated report */
471 unsigned index; /* index into report->field[] */
473 struct hid_input *hidinput; /* associated input structure */
474 __u16 dpad; /* dpad input code */
477 #define HID_MAX_FIELDS 256
480 struct list_head list;
481 struct list_head hidinput_list;
482 unsigned int id; /* id of this report */
483 unsigned int type; /* report type */
484 unsigned int application; /* application usage for this report */
485 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
486 unsigned maxfield; /* maximum valid field index */
487 unsigned size; /* size of the report (bits) */
488 struct hid_device *device; /* associated device */
491 #define HID_MAX_IDS 256
493 struct hid_report_enum {
495 struct list_head report_list;
496 struct hid_report *report_id_hash[HID_MAX_IDS];
499 #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
500 #define HID_MAX_BUFFER_SIZE 16384 /* 16kb */
501 #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
502 #define HID_OUTPUT_FIFO_SIZE 64
504 struct hid_control_fifo {
506 struct hid_report *report;
510 struct hid_output_fifo {
511 struct hid_report *report;
515 #define HID_CLAIMED_INPUT BIT(0)
516 #define HID_CLAIMED_HIDDEV BIT(1)
517 #define HID_CLAIMED_HIDRAW BIT(2)
518 #define HID_CLAIMED_DRIVER BIT(3)
520 #define HID_STAT_ADDED BIT(0)
521 #define HID_STAT_PARSED BIT(1)
522 #define HID_STAT_DUP_DETECTED BIT(2)
523 #define HID_STAT_REPROBED BIT(3)
526 struct list_head list;
527 struct hid_report *report;
528 struct input_dev *input;
531 struct list_head reports; /* the list of reports */
532 unsigned int application; /* application usage for this input */
541 enum hid_battery_status {
542 HID_BATTERY_UNKNOWN = 0,
543 HID_BATTERY_QUERIED, /* Kernel explicitly queried battery strength */
544 HID_BATTERY_REPORTED, /* Device sent unsolicited battery strength report */
548 struct hid_ll_driver;
550 struct hid_device { /* device report descriptor */
555 struct hid_collection *collection; /* List of HID collections */
556 unsigned collection_size; /* Number of allocated hid_collections */
557 unsigned maxcollection; /* Number of parsed collections */
558 unsigned maxapplication; /* Number of applications */
559 __u16 bus; /* BUS ID */
560 __u16 group; /* Report group */
561 __u32 vendor; /* Vendor ID */
562 __u32 product; /* Product ID */
563 __u32 version; /* HID version */
564 enum hid_type type; /* device type (mouse, kbd, ...) */
565 unsigned country; /* HID country */
566 struct hid_report_enum report_enum[HID_REPORT_TYPES];
567 struct work_struct led_work; /* delayed LED worker */
569 struct semaphore driver_input_lock; /* protects the current driver */
570 struct device dev; /* device */
571 struct hid_driver *driver;
573 struct hid_ll_driver *ll_driver;
574 struct mutex ll_open_lock;
575 unsigned int ll_open_count;
577 #ifdef CONFIG_HID_BATTERY_STRENGTH
579 * Power supply information for HID devices which report
580 * battery strength. power_supply was successfully registered if
581 * battery is non-NULL.
583 struct power_supply *battery;
584 __s32 battery_capacity;
587 __s32 battery_report_type;
588 __s32 battery_report_id;
589 enum hid_battery_status battery_status;
590 bool battery_avoid_query;
591 ktime_t battery_ratelimit_time;
594 unsigned long status; /* see STAT flags above */
595 unsigned claimed; /* Claimed by hidinput, hiddev? */
596 unsigned quirks; /* Various quirks the device can pull on us */
597 bool io_started; /* If IO has started */
599 struct list_head inputs; /* The list of inputs */
600 void *hiddev; /* The hiddev structure */
603 char name[128]; /* Device name */
604 char phys[64]; /* Device physical location */
605 char uniq[64]; /* Device unique identifier (serial #) */
609 /* temporary hid_ff handling (until moved to the drivers) */
610 int (*ff_init)(struct hid_device *);
612 /* hiddev event handler */
613 int (*hiddev_connect)(struct hid_device *, unsigned int);
614 void (*hiddev_disconnect)(struct hid_device *);
615 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
616 struct hid_usage *, __s32);
617 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
619 /* debugging support via debugfs */
620 unsigned short debug;
621 struct dentry *debug_dir;
622 struct dentry *debug_rdesc;
623 struct dentry *debug_events;
624 struct list_head debug_list;
625 spinlock_t debug_list_lock;
626 wait_queue_head_t debug_wait;
629 #define to_hid_device(pdev) \
630 container_of(pdev, struct hid_device, dev)
632 static inline void *hid_get_drvdata(struct hid_device *hdev)
634 return dev_get_drvdata(&hdev->dev);
637 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
639 dev_set_drvdata(&hdev->dev, data);
642 #define HID_GLOBAL_STACK_SIZE 4
643 #define HID_COLLECTION_STACK_SIZE 4
645 #define HID_SCAN_FLAG_MT_WIN_8 BIT(0)
646 #define HID_SCAN_FLAG_VENDOR_SPECIFIC BIT(1)
647 #define HID_SCAN_FLAG_GD_POINTER BIT(2)
650 struct hid_global global;
651 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
652 unsigned int global_stack_ptr;
653 struct hid_local local;
654 unsigned int *collection_stack;
655 unsigned int collection_stack_ptr;
656 unsigned int collection_stack_size;
657 struct hid_device *device;
658 unsigned int scan_flags;
661 struct hid_class_descriptor {
662 __u8 bDescriptorType;
663 __le16 wDescriptorLength;
664 } __attribute__ ((packed));
666 struct hid_descriptor {
668 __u8 bDescriptorType;
671 __u8 bNumDescriptors;
673 struct hid_class_descriptor desc[1];
674 } __attribute__ ((packed));
676 #define HID_DEVICE(b, g, ven, prod) \
677 .bus = (b), .group = (g), .vendor = (ven), .product = (prod)
678 #define HID_USB_DEVICE(ven, prod) \
679 .bus = BUS_USB, .vendor = (ven), .product = (prod)
680 #define HID_BLUETOOTH_DEVICE(ven, prod) \
681 .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod)
682 #define HID_I2C_DEVICE(ven, prod) \
683 .bus = BUS_I2C, .vendor = (ven), .product = (prod)
685 #define HID_REPORT_ID(rep) \
687 #define HID_USAGE_ID(uhid, utype, ucode) \
688 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
689 /* we don't want to catch types and codes equal to 0 */
690 #define HID_TERMINATOR (HID_ANY_ID - 1)
692 struct hid_report_id {
695 struct hid_usage_id {
703 * @name: driver name (e.g. "Footech_bar-wheel")
704 * @id_table: which devices is this driver for (must be non-NULL for probe
706 * @dyn_list: list of dynamically added device ids
707 * @dyn_lock: lock protecting @dyn_list
708 * @match: check if the given device is handled by this driver
709 * @probe: new device inserted
710 * @remove: device removed (NULL if not a hot-plug capable driver)
711 * @report_table: on which reports to call raw_event (NULL means all)
712 * @raw_event: if report in report_table, this hook is called (NULL means nop)
713 * @usage_table: on which events to call event (NULL means all)
714 * @event: if usage in usage_table, this hook is called (NULL means nop)
715 * @report: this hook is called after parsing a report (NULL means nop)
716 * @report_fixup: called before report descriptor parsing (NULL means nop)
717 * @input_mapping: invoked on input registering before mapping an usage
718 * @input_mapped: invoked on input registering after mapping an usage
719 * @input_configured: invoked just before the device is registered
720 * @feature_mapping: invoked on feature registering
721 * @suspend: invoked on suspend (NULL means nop)
722 * @resume: invoked on resume if device was not reset (NULL means nop)
723 * @reset_resume: invoked on resume if device was reset (NULL means nop)
725 * probe should return -errno on error, or 0 on success. During probe,
726 * input will not be passed to raw_event unless hid_device_io_start is
729 * raw_event and event should return negative on error, any other value will
730 * pass the event on to .event() typically return 0 for success.
732 * input_mapping shall return a negative value to completely ignore this usage
733 * (e.g. doubled or invalid usage), zero to continue with parsing of this
734 * usage by generic code (no special handling needed) or positive to skip
735 * generic parsing (needed special handling which was done in the hook already)
736 * input_mapped shall return negative to inform the layer that this usage
737 * should not be considered for further processing or zero to notify that
738 * no processing was performed and should be done in a generic manner
739 * Both these functions may be NULL which means the same behavior as returning
744 const struct hid_device_id *id_table;
746 struct list_head dyn_list;
749 bool (*match)(struct hid_device *dev, bool ignore_special_driver);
750 int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
751 void (*remove)(struct hid_device *dev);
753 const struct hid_report_id *report_table;
754 int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
756 const struct hid_usage_id *usage_table;
757 int (*event)(struct hid_device *hdev, struct hid_field *field,
758 struct hid_usage *usage, __s32 value);
759 void (*report)(struct hid_device *hdev, struct hid_report *report);
761 __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
764 int (*input_mapping)(struct hid_device *hdev,
765 struct hid_input *hidinput, struct hid_field *field,
766 struct hid_usage *usage, unsigned long **bit, int *max);
767 int (*input_mapped)(struct hid_device *hdev,
768 struct hid_input *hidinput, struct hid_field *field,
769 struct hid_usage *usage, unsigned long **bit, int *max);
770 int (*input_configured)(struct hid_device *hdev,
771 struct hid_input *hidinput);
772 void (*feature_mapping)(struct hid_device *hdev,
773 struct hid_field *field,
774 struct hid_usage *usage);
776 int (*suspend)(struct hid_device *hdev, pm_message_t message);
777 int (*resume)(struct hid_device *hdev);
778 int (*reset_resume)(struct hid_device *hdev);
781 struct device_driver driver;
784 #define to_hid_driver(pdrv) \
785 container_of(pdrv, struct hid_driver, driver)
788 * hid_ll_driver - low level driver callbacks
789 * @start: called on probe to start the device
790 * @stop: called on remove
791 * @open: called by input layer on open
792 * @close: called by input layer on close
793 * @power: request underlying hardware to enter requested power mode
794 * @parse: this method is called only once to parse the device data,
795 * shouldn't allocate anything to not leak memory
796 * @request: send report request to device (e.g. feature report)
797 * @wait: wait for buffered io to complete (send/recv reports)
798 * @raw_request: send raw report request to device (e.g. feature report)
799 * @output_report: send output report to device
800 * @idle: send idle request to device
802 struct hid_ll_driver {
803 int (*start)(struct hid_device *hdev);
804 void (*stop)(struct hid_device *hdev);
806 int (*open)(struct hid_device *hdev);
807 void (*close)(struct hid_device *hdev);
809 int (*power)(struct hid_device *hdev, int level);
811 int (*parse)(struct hid_device *hdev);
813 void (*request)(struct hid_device *hdev,
814 struct hid_report *report, int reqtype);
816 int (*wait)(struct hid_device *hdev);
818 int (*raw_request) (struct hid_device *hdev, unsigned char reportnum,
819 __u8 *buf, size_t len, unsigned char rtype,
822 int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len);
824 int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype);
827 extern struct hid_ll_driver i2c_hid_ll_driver;
828 extern struct hid_ll_driver hidp_hid_driver;
829 extern struct hid_ll_driver uhid_hid_driver;
830 extern struct hid_ll_driver usb_hid_driver;
832 static inline bool hid_is_using_ll_driver(struct hid_device *hdev,
833 struct hid_ll_driver *driver)
835 return hdev->ll_driver == driver;
838 #define PM_HINT_FULLON 1<<5
839 #define PM_HINT_NORMAL 1<<1
841 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
842 /* We ignore a few input applications that are not widely used */
843 #define IS_INPUT_APPLICATION(a) \
844 (((a >= HID_UP_GENDESK) && (a <= HID_GD_MULTIAXIS)) \
845 || ((a >= HID_DG_PEN) && (a <= HID_DG_WHITEBOARD)) \
846 || (a == HID_GD_SYSTEM_CONTROL) || (a == HID_CP_CONSUMER_CONTROL) \
847 || (a == HID_GD_WIRELESS_RADIO_CTLS))
851 extern int hid_debug;
853 extern bool hid_ignore(struct hid_device *);
854 extern int hid_add_device(struct hid_device *);
855 extern void hid_destroy_device(struct hid_device *);
857 extern struct bus_type hid_bus_type;
859 extern int __must_check __hid_register_driver(struct hid_driver *,
860 struct module *, const char *mod_name);
862 /* use a define to avoid include chaining to get THIS_MODULE & friends */
863 #define hid_register_driver(driver) \
864 __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
866 extern void hid_unregister_driver(struct hid_driver *);
869 * module_hid_driver() - Helper macro for registering a HID driver
870 * @__hid_driver: hid_driver struct
872 * Helper macro for HID drivers which do not do anything special in module
873 * init/exit. This eliminates a lot of boilerplate. Each module may only
874 * use this macro once, and calling it replaces module_init() and module_exit()
876 #define module_hid_driver(__hid_driver) \
877 module_driver(__hid_driver, hid_register_driver, \
878 hid_unregister_driver)
880 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
881 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
882 extern int hidinput_connect(struct hid_device *hid, unsigned int force);
883 extern void hidinput_disconnect(struct hid_device *);
885 int hid_set_field(struct hid_field *, unsigned, __s32);
886 int hid_input_report(struct hid_device *, int type, u8 *, u32, int);
887 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
888 struct hid_field *hidinput_get_led_field(struct hid_device *hid);
889 unsigned int hidinput_count_leds(struct hid_device *hid);
890 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
891 void hid_output_report(struct hid_report *report, __u8 *data);
892 int __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype);
893 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags);
894 struct hid_device *hid_allocate_device(void);
895 struct hid_report *hid_register_report(struct hid_device *device,
896 unsigned int type, unsigned int id,
897 unsigned int application);
898 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
899 struct hid_report *hid_validate_values(struct hid_device *hid,
900 unsigned int type, unsigned int id,
901 unsigned int field_index,
902 unsigned int report_counts);
904 void hid_setup_resolution_multiplier(struct hid_device *hid);
905 int hid_open_report(struct hid_device *device);
906 int hid_check_keys_pressed(struct hid_device *hid);
907 int hid_connect(struct hid_device *hid, unsigned int connect_mask);
908 void hid_disconnect(struct hid_device *hid);
909 bool hid_match_one_id(const struct hid_device *hdev,
910 const struct hid_device_id *id);
911 const struct hid_device_id *hid_match_id(const struct hid_device *hdev,
912 const struct hid_device_id *id);
913 const struct hid_device_id *hid_match_device(struct hid_device *hdev,
914 struct hid_driver *hdrv);
915 bool hid_compare_device_paths(struct hid_device *hdev_a,
916 struct hid_device *hdev_b, char separator);
917 s32 hid_snto32(__u32 value, unsigned n);
918 __u32 hid_field_extract(const struct hid_device *hid, __u8 *report,
919 unsigned offset, unsigned n);
922 * hid_device_io_start - enable HID input during probe, remove
926 * This should only be called during probe or remove and only be
927 * called by the thread calling probe or remove. It will allow
928 * incoming packets to be delivered to the driver.
930 static inline void hid_device_io_start(struct hid_device *hid) {
931 if (hid->io_started) {
932 dev_warn(&hid->dev, "io already started\n");
935 hid->io_started = true;
936 up(&hid->driver_input_lock);
940 * hid_device_io_stop - disable HID input during probe, remove
944 * Should only be called after hid_device_io_start. It will prevent
945 * incoming packets from going to the driver for the duration of
946 * probe, remove. If called during probe, packets will still go to the
947 * driver after probe is complete. This function should only be called
948 * by the thread calling probe or remove.
950 static inline void hid_device_io_stop(struct hid_device *hid) {
951 if (!hid->io_started) {
952 dev_warn(&hid->dev, "io already stopped\n");
955 hid->io_started = false;
956 down(&hid->driver_input_lock);
960 * hid_map_usage - map usage input bits
962 * @hidinput: hidinput which we are interested in
963 * @usage: usage to fill in
964 * @bit: pointer to input->{}bit (out parameter)
965 * @max: maximal valid usage->code to consider later (out parameter)
966 * @type: input event type (EV_KEY, EV_REL, ...)
967 * @c: code which corresponds to this usage and type
969 * The value pointed to by @bit will be set to NULL if either @type is
970 * an unhandled event type, or if @c is out of range for @type. This
971 * can be used as an error condition.
973 static inline void hid_map_usage(struct hid_input *hidinput,
974 struct hid_usage *usage, unsigned long **bit, int *max,
975 __u8 type, unsigned int c)
977 struct input_dev *input = hidinput->input;
978 unsigned long *bmap = NULL;
979 unsigned int limit = 0;
983 bmap = input->absbit;
987 bmap = input->relbit;
991 bmap = input->keybit;
995 bmap = input->ledbit;
1000 if (unlikely(c > limit || !bmap)) {
1001 pr_warn_ratelimited("%s: Invalid code %d type %d\n",
1002 input->name, c, type);
1014 * hid_map_usage_clear - map usage input bits and clear the input bit
1016 * @hidinput: hidinput which we are interested in
1017 * @usage: usage to fill in
1018 * @bit: pointer to input->{}bit (out parameter)
1019 * @max: maximal valid usage->code to consider later (out parameter)
1020 * @type: input event type (EV_KEY, EV_REL, ...)
1021 * @c: code which corresponds to this usage and type
1023 * The same as hid_map_usage, except the @c bit is also cleared in supported
1026 static inline void hid_map_usage_clear(struct hid_input *hidinput,
1027 struct hid_usage *usage, unsigned long **bit, int *max,
1030 hid_map_usage(hidinput, usage, bit, max, type, c);
1032 clear_bit(usage->code, *bit);
1036 * hid_parse - parse HW reports
1040 * Call this from probe after you set up the device (if needed). Your
1041 * report_fixup will be called (if non-NULL) after reading raw report from
1042 * device before passing it to hid layer for real parsing.
1044 static inline int __must_check hid_parse(struct hid_device *hdev)
1046 return hid_open_report(hdev);
1049 int __must_check hid_hw_start(struct hid_device *hdev,
1050 unsigned int connect_mask);
1051 void hid_hw_stop(struct hid_device *hdev);
1052 int __must_check hid_hw_open(struct hid_device *hdev);
1053 void hid_hw_close(struct hid_device *hdev);
1056 * hid_hw_power - requests underlying HW to go into given power mode
1059 * @level: requested power level (one of %PM_HINT_* defines)
1061 * This function requests underlying hardware to enter requested power
1065 static inline int hid_hw_power(struct hid_device *hdev, int level)
1067 return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
1072 * hid_hw_request - send report request to device
1075 * @report: report to send
1076 * @reqtype: hid request type
1078 static inline void hid_hw_request(struct hid_device *hdev,
1079 struct hid_report *report, int reqtype)
1081 if (hdev->ll_driver->request)
1082 return hdev->ll_driver->request(hdev, report, reqtype);
1084 __hid_request(hdev, report, reqtype);
1088 * hid_hw_raw_request - send report request to device
1091 * @reportnum: report ID
1092 * @buf: in/out data to transfer
1093 * @len: length of buf
1094 * @rtype: HID report type
1095 * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
1097 * Return: count of data transferred, negative if error
1099 * Same behavior as hid_hw_request, but with raw buffers instead.
1101 static inline int hid_hw_raw_request(struct hid_device *hdev,
1102 unsigned char reportnum, __u8 *buf,
1103 size_t len, unsigned char rtype, int reqtype)
1105 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1108 return hdev->ll_driver->raw_request(hdev, reportnum, buf, len,
1113 * hid_hw_output_report - send output report to device
1116 * @buf: raw data to transfer
1117 * @len: length of buf
1119 * Return: count of data transferred, negative if error
1121 static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf,
1124 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1127 if (hdev->ll_driver->output_report)
1128 return hdev->ll_driver->output_report(hdev, buf, len);
1134 * hid_hw_idle - send idle request to device
1137 * @report: report to control
1139 * @reqtype: hid request type
1141 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
1144 if (hdev->ll_driver->idle)
1145 return hdev->ll_driver->idle(hdev, report, idle, reqtype);
1151 * hid_hw_wait - wait for buffered io to complete
1155 static inline void hid_hw_wait(struct hid_device *hdev)
1157 if (hdev->ll_driver->wait)
1158 hdev->ll_driver->wait(hdev);
1162 * hid_report_len - calculate the report length
1164 * @report: the report we want to know the length
1166 static inline u32 hid_report_len(struct hid_report *report)
1168 /* equivalent to DIV_ROUND_UP(report->size, 8) + !!(report->id > 0) */
1169 return ((report->size - 1) >> 3) + 1 + (report->id > 0);
1172 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, u32 size,
1175 /* HID quirks API */
1176 unsigned long hid_lookup_quirk(const struct hid_device *hdev);
1177 int hid_quirks_init(char **quirks_param, __u16 bus, int count);
1178 void hid_quirks_exit(__u16 bus);
1180 #ifdef CONFIG_HID_PID
1181 int hid_pidff_init(struct hid_device *hid);
1183 #define hid_pidff_init NULL
1186 #define dbg_hid(fmt, ...) \
1189 printk(KERN_DEBUG "%s: " fmt, __FILE__, ##__VA_ARGS__); \
1192 #define hid_err(hid, fmt, ...) \
1193 dev_err(&(hid)->dev, fmt, ##__VA_ARGS__)
1194 #define hid_notice(hid, fmt, ...) \
1195 dev_notice(&(hid)->dev, fmt, ##__VA_ARGS__)
1196 #define hid_warn(hid, fmt, ...) \
1197 dev_warn(&(hid)->dev, fmt, ##__VA_ARGS__)
1198 #define hid_info(hid, fmt, ...) \
1199 dev_info(&(hid)->dev, fmt, ##__VA_ARGS__)
1200 #define hid_dbg(hid, fmt, ...) \
1201 dev_dbg(&(hid)->dev, fmt, ##__VA_ARGS__)
1203 #define hid_err_once(hid, fmt, ...) \
1204 dev_err_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1205 #define hid_notice_once(hid, fmt, ...) \
1206 dev_notice_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1207 #define hid_warn_once(hid, fmt, ...) \
1208 dev_warn_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1209 #define hid_info_once(hid, fmt, ...) \
1210 dev_info_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1211 #define hid_dbg_once(hid, fmt, ...) \
1212 dev_dbg_once(&(hid)->dev, fmt, ##__VA_ARGS__)