2 * Copyright (c) 1999 Andreas Gal
3 * Copyright (c) 2000-2001 Vojtech Pavlik
4 * Copyright (c) 2006-2007 Jiri Kosina
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 * Should you need to contact me, the author, you can do so either by
22 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
23 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
29 #include <linux/bitops.h>
30 #include <linux/types.h>
31 #include <linux/slab.h>
32 #include <linux/list.h>
33 #include <linux/mod_devicetable.h> /* hid_device_id */
34 #include <linux/timer.h>
35 #include <linux/workqueue.h>
36 #include <linux/input.h>
37 #include <linux/semaphore.h>
38 #include <linux/mutex.h>
39 #include <linux/power_supply.h>
40 #include <uapi/linux/hid.h>
43 * We parse each description item into this structure. Short items data
44 * values are expanded to 32-bit signed int, long items contain a pointer
65 * HID report item format
68 #define HID_ITEM_FORMAT_SHORT 0
69 #define HID_ITEM_FORMAT_LONG 1
72 * Special tag indicating long items
75 #define HID_ITEM_TAG_LONG 15
78 * HID report descriptor item type (prefix bit 2,3)
81 #define HID_ITEM_TYPE_MAIN 0
82 #define HID_ITEM_TYPE_GLOBAL 1
83 #define HID_ITEM_TYPE_LOCAL 2
84 #define HID_ITEM_TYPE_RESERVED 3
87 * HID report descriptor main item tags
90 #define HID_MAIN_ITEM_TAG_INPUT 8
91 #define HID_MAIN_ITEM_TAG_OUTPUT 9
92 #define HID_MAIN_ITEM_TAG_FEATURE 11
93 #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10
94 #define HID_MAIN_ITEM_TAG_END_COLLECTION 12
97 * HID report descriptor main item contents
100 #define HID_MAIN_ITEM_CONSTANT 0x001
101 #define HID_MAIN_ITEM_VARIABLE 0x002
102 #define HID_MAIN_ITEM_RELATIVE 0x004
103 #define HID_MAIN_ITEM_WRAP 0x008
104 #define HID_MAIN_ITEM_NONLINEAR 0x010
105 #define HID_MAIN_ITEM_NO_PREFERRED 0x020
106 #define HID_MAIN_ITEM_NULL_STATE 0x040
107 #define HID_MAIN_ITEM_VOLATILE 0x080
108 #define HID_MAIN_ITEM_BUFFERED_BYTE 0x100
111 * HID report descriptor collection item types
114 #define HID_COLLECTION_PHYSICAL 0
115 #define HID_COLLECTION_APPLICATION 1
116 #define HID_COLLECTION_LOGICAL 2
119 * HID report descriptor global item tags
122 #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0
123 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1
124 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2
125 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3
126 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4
127 #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5
128 #define HID_GLOBAL_ITEM_TAG_UNIT 6
129 #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7
130 #define HID_GLOBAL_ITEM_TAG_REPORT_ID 8
131 #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9
132 #define HID_GLOBAL_ITEM_TAG_PUSH 10
133 #define HID_GLOBAL_ITEM_TAG_POP 11
136 * HID report descriptor local item tags
139 #define HID_LOCAL_ITEM_TAG_USAGE 0
140 #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1
141 #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2
142 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3
143 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4
144 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5
145 #define HID_LOCAL_ITEM_TAG_STRING_INDEX 7
146 #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8
147 #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9
148 #define HID_LOCAL_ITEM_TAG_DELIMITER 10
154 #define HID_USAGE_PAGE 0xffff0000
156 #define HID_UP_UNDEFINED 0x00000000
157 #define HID_UP_GENDESK 0x00010000
158 #define HID_UP_SIMULATION 0x00020000
159 #define HID_UP_GENDEVCTRLS 0x00060000
160 #define HID_UP_KEYBOARD 0x00070000
161 #define HID_UP_LED 0x00080000
162 #define HID_UP_BUTTON 0x00090000
163 #define HID_UP_ORDINAL 0x000a0000
164 #define HID_UP_TELEPHONY 0x000b0000
165 #define HID_UP_CONSUMER 0x000c0000
166 #define HID_UP_DIGITIZER 0x000d0000
167 #define HID_UP_PID 0x000f0000
168 #define HID_UP_HPVENDOR 0xff7f0000
169 #define HID_UP_HPVENDOR2 0xff010000
170 #define HID_UP_MSVENDOR 0xff000000
171 #define HID_UP_CUSTOM 0x00ff0000
172 #define HID_UP_LOGIVENDOR 0xffbc0000
173 #define HID_UP_LOGIVENDOR2 0xff090000
174 #define HID_UP_LOGIVENDOR3 0xff430000
175 #define HID_UP_LNVENDOR 0xffa00000
176 #define HID_UP_SENSOR 0x00200000
177 #define HID_UP_ASUSVENDOR 0xff310000
179 #define HID_USAGE 0x0000ffff
181 #define HID_GD_POINTER 0x00010001
182 #define HID_GD_MOUSE 0x00010002
183 #define HID_GD_JOYSTICK 0x00010004
184 #define HID_GD_GAMEPAD 0x00010005
185 #define HID_GD_KEYBOARD 0x00010006
186 #define HID_GD_KEYPAD 0x00010007
187 #define HID_GD_MULTIAXIS 0x00010008
189 * Microsoft Win8 Wireless Radio Controls extensions CA, see:
190 * http://www.usb.org/developers/hidpage/HUTRR40RadioHIDUsagesFinal.pdf
192 #define HID_GD_WIRELESS_RADIO_CTLS 0x0001000c
194 * System Multi-Axis, see:
195 * http://www.usb.org/developers/hidpage/HUTRR62_-_Generic_Desktop_CA_for_System_Multi-Axis_Controllers.txt
197 #define HID_GD_SYSTEM_MULTIAXIS 0x0001000e
199 #define HID_GD_X 0x00010030
200 #define HID_GD_Y 0x00010031
201 #define HID_GD_Z 0x00010032
202 #define HID_GD_RX 0x00010033
203 #define HID_GD_RY 0x00010034
204 #define HID_GD_RZ 0x00010035
205 #define HID_GD_SLIDER 0x00010036
206 #define HID_GD_DIAL 0x00010037
207 #define HID_GD_WHEEL 0x00010038
208 #define HID_GD_HATSWITCH 0x00010039
209 #define HID_GD_BUFFER 0x0001003a
210 #define HID_GD_BYTECOUNT 0x0001003b
211 #define HID_GD_MOTION 0x0001003c
212 #define HID_GD_START 0x0001003d
213 #define HID_GD_SELECT 0x0001003e
214 #define HID_GD_VX 0x00010040
215 #define HID_GD_VY 0x00010041
216 #define HID_GD_VZ 0x00010042
217 #define HID_GD_VBRX 0x00010043
218 #define HID_GD_VBRY 0x00010044
219 #define HID_GD_VBRZ 0x00010045
220 #define HID_GD_VNO 0x00010046
221 #define HID_GD_FEATURE 0x00010047
222 #define HID_GD_SYSTEM_CONTROL 0x00010080
223 #define HID_GD_UP 0x00010090
224 #define HID_GD_DOWN 0x00010091
225 #define HID_GD_RIGHT 0x00010092
226 #define HID_GD_LEFT 0x00010093
227 /* Microsoft Win8 Wireless Radio Controls CA usage codes */
228 #define HID_GD_RFKILL_BTN 0x000100c6
229 #define HID_GD_RFKILL_LED 0x000100c7
230 #define HID_GD_RFKILL_SWITCH 0x000100c8
232 #define HID_DC_BATTERYSTRENGTH 0x00060020
234 #define HID_CP_CONSUMER_CONTROL 0x000c0001
236 #define HID_DG_DIGITIZER 0x000d0001
237 #define HID_DG_PEN 0x000d0002
238 #define HID_DG_LIGHTPEN 0x000d0003
239 #define HID_DG_TOUCHSCREEN 0x000d0004
240 #define HID_DG_TOUCHPAD 0x000d0005
241 #define HID_DG_STYLUS 0x000d0020
242 #define HID_DG_PUCK 0x000d0021
243 #define HID_DG_FINGER 0x000d0022
244 #define HID_DG_TIPPRESSURE 0x000d0030
245 #define HID_DG_BARRELPRESSURE 0x000d0031
246 #define HID_DG_INRANGE 0x000d0032
247 #define HID_DG_TOUCH 0x000d0033
248 #define HID_DG_UNTOUCH 0x000d0034
249 #define HID_DG_TAP 0x000d0035
250 #define HID_DG_TABLETFUNCTIONKEY 0x000d0039
251 #define HID_DG_PROGRAMCHANGEKEY 0x000d003a
252 #define HID_DG_BATTERYSTRENGTH 0x000d003b
253 #define HID_DG_INVERT 0x000d003c
254 #define HID_DG_TILT_X 0x000d003d
255 #define HID_DG_TILT_Y 0x000d003e
256 #define HID_DG_TWIST 0x000d0041
257 #define HID_DG_TIPSWITCH 0x000d0042
258 #define HID_DG_TIPSWITCH2 0x000d0043
259 #define HID_DG_BARRELSWITCH 0x000d0044
260 #define HID_DG_ERASER 0x000d0045
261 #define HID_DG_TABLETPICK 0x000d0046
263 #define HID_CP_CONSUMERCONTROL 0x000c0001
264 #define HID_CP_NUMERICKEYPAD 0x000c0002
265 #define HID_CP_PROGRAMMABLEBUTTONS 0x000c0003
266 #define HID_CP_MICROPHONE 0x000c0004
267 #define HID_CP_HEADPHONE 0x000c0005
268 #define HID_CP_GRAPHICEQUALIZER 0x000c0006
269 #define HID_CP_FUNCTIONBUTTONS 0x000c0036
270 #define HID_CP_SELECTION 0x000c0080
271 #define HID_CP_MEDIASELECTION 0x000c0087
272 #define HID_CP_SELECTDISC 0x000c00ba
273 #define HID_CP_VOLUMEUP 0x000c00e9
274 #define HID_CP_VOLUMEDOWN 0x000c00ea
275 #define HID_CP_PLAYBACKSPEED 0x000c00f1
276 #define HID_CP_PROXIMITY 0x000c0109
277 #define HID_CP_SPEAKERSYSTEM 0x000c0160
278 #define HID_CP_CHANNELLEFT 0x000c0161
279 #define HID_CP_CHANNELRIGHT 0x000c0162
280 #define HID_CP_CHANNELCENTER 0x000c0163
281 #define HID_CP_CHANNELFRONT 0x000c0164
282 #define HID_CP_CHANNELCENTERFRONT 0x000c0165
283 #define HID_CP_CHANNELSIDE 0x000c0166
284 #define HID_CP_CHANNELSURROUND 0x000c0167
285 #define HID_CP_CHANNELLOWFREQUENCYENHANCEMENT 0x000c0168
286 #define HID_CP_CHANNELTOP 0x000c0169
287 #define HID_CP_CHANNELUNKNOWN 0x000c016a
288 #define HID_CP_APPLICATIONLAUNCHBUTTONS 0x000c0180
289 #define HID_CP_GENERICGUIAPPLICATIONCONTROLS 0x000c0200
291 #define HID_DG_DEVICECONFIG 0x000d000e
292 #define HID_DG_DEVICESETTINGS 0x000d0023
293 #define HID_DG_AZIMUTH 0x000d003f
294 #define HID_DG_CONFIDENCE 0x000d0047
295 #define HID_DG_WIDTH 0x000d0048
296 #define HID_DG_HEIGHT 0x000d0049
297 #define HID_DG_CONTACTID 0x000d0051
298 #define HID_DG_INPUTMODE 0x000d0052
299 #define HID_DG_DEVICEINDEX 0x000d0053
300 #define HID_DG_CONTACTCOUNT 0x000d0054
301 #define HID_DG_CONTACTMAX 0x000d0055
302 #define HID_DG_SCANTIME 0x000d0056
303 #define HID_DG_SURFACESWITCH 0x000d0057
304 #define HID_DG_BUTTONSWITCH 0x000d0058
305 #define HID_DG_BUTTONTYPE 0x000d0059
306 #define HID_DG_BARRELSWITCH2 0x000d005a
307 #define HID_DG_TOOLSERIALNUMBER 0x000d005b
308 #define HID_DG_LATENCYMODE 0x000d0060
310 #define HID_VD_ASUS_CUSTOM_MEDIA_KEYS 0xff310076
312 * HID report types --- Ouch! HID spec says 1 2 3!
315 #define HID_INPUT_REPORT 0
316 #define HID_OUTPUT_REPORT 1
317 #define HID_FEATURE_REPORT 2
319 #define HID_REPORT_TYPES 3
322 * HID connect requests
325 #define HID_CONNECT_HIDINPUT BIT(0)
326 #define HID_CONNECT_HIDINPUT_FORCE BIT(1)
327 #define HID_CONNECT_HIDRAW BIT(2)
328 #define HID_CONNECT_HIDDEV BIT(3)
329 #define HID_CONNECT_HIDDEV_FORCE BIT(4)
330 #define HID_CONNECT_FF BIT(5)
331 #define HID_CONNECT_DRIVER BIT(6)
332 #define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
333 HID_CONNECT_HIDDEV|HID_CONNECT_FF)
340 * Increase this if you need to configure more HID quirks at module load time
342 #define MAX_USBHID_BOOT_QUIRKS 4
344 #define HID_QUIRK_INVERT BIT(0)
345 #define HID_QUIRK_NOTOUCH BIT(1)
346 #define HID_QUIRK_IGNORE BIT(2)
347 #define HID_QUIRK_NOGET BIT(3)
348 #define HID_QUIRK_HIDDEV_FORCE BIT(4)
349 #define HID_QUIRK_BADPAD BIT(5)
350 #define HID_QUIRK_MULTI_INPUT BIT(6)
351 #define HID_QUIRK_HIDINPUT_FORCE BIT(7)
352 /* BIT(8) reserved for backward compatibility, was HID_QUIRK_NO_EMPTY_INPUT */
353 /* BIT(9) reserved for backward compatibility, was NO_INIT_INPUT_REPORTS */
354 #define HID_QUIRK_ALWAYS_POLL BIT(10)
355 #define HID_QUIRK_INPUT_PER_APP BIT(11)
356 #define HID_QUIRK_SKIP_OUTPUT_REPORTS BIT(16)
357 #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID BIT(17)
358 #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP BIT(18)
359 #define HID_QUIRK_HAVE_SPECIAL_DRIVER BIT(19)
360 #define HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE BIT(20)
361 #define HID_QUIRK_FULLSPEED_INTERVAL BIT(28)
362 #define HID_QUIRK_NO_INIT_REPORTS BIT(29)
363 #define HID_QUIRK_NO_IGNORE BIT(30)
364 #define HID_QUIRK_NO_INPUT_SYNC BIT(31)
369 * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h
370 * and has a value of 0x0000
372 #define HID_GROUP_GENERIC 0x0001
373 #define HID_GROUP_MULTITOUCH 0x0002
374 #define HID_GROUP_SENSOR_HUB 0x0003
375 #define HID_GROUP_MULTITOUCH_WIN_8 0x0004
378 * Vendor specific HID device groups
380 #define HID_GROUP_RMI 0x0100
381 #define HID_GROUP_WACOM 0x0101
382 #define HID_GROUP_LOGITECH_DJ_DEVICE 0x0102
383 #define HID_GROUP_STEAM 0x0103
386 * HID protocol status
388 #define HID_REPORT_PROTOCOL 1
389 #define HID_BOOT_PROTOCOL 0
392 * This is the global environment of the parser. This information is
393 * persistent for main-items. The global environment can be saved and
394 * restored with PUSH/POP statements.
399 __s32 logical_minimum;
400 __s32 logical_maximum;
401 __s32 physical_minimum;
402 __s32 physical_maximum;
406 unsigned report_size;
407 unsigned report_count;
411 * This is the local environment. It is persistent up the next main-item.
414 #define HID_MAX_USAGES 12288
415 #define HID_DEFAULT_NUM_COLLECTIONS 16
418 unsigned usage[HID_MAX_USAGES]; /* usage array */
419 u8 usage_size[HID_MAX_USAGES]; /* usage size array */
420 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
421 unsigned usage_index;
422 unsigned usage_minimum;
423 unsigned delimiter_depth;
424 unsigned delimiter_branch;
428 * This is the collection stack. We climb up the stack to determine
429 * application and function of each field.
432 struct hid_collection {
439 unsigned hid; /* hid usage code */
440 unsigned collection_index; /* index into collection array */
441 unsigned usage_index; /* index into usage array */
443 __u16 code; /* input driver code */
444 __u8 type; /* input driver type */
445 __s8 hat_min; /* hat switch fun */
446 __s8 hat_max; /* ditto */
447 __s8 hat_dir; /* ditto */
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 8192 /* 8kb */
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;
593 unsigned long status; /* see STAT flags above */
594 unsigned claimed; /* Claimed by hidinput, hiddev? */
595 unsigned quirks; /* Various quirks the device can pull on us */
596 bool io_started; /* If IO has started */
598 struct list_head inputs; /* The list of inputs */
599 void *hiddev; /* The hiddev structure */
602 char name[128]; /* Device name */
603 char phys[64]; /* Device physical location */
604 char uniq[64]; /* Device unique identifier (serial #) */
608 /* temporary hid_ff handling (until moved to the drivers) */
609 int (*ff_init)(struct hid_device *);
611 /* hiddev event handler */
612 int (*hiddev_connect)(struct hid_device *, unsigned int);
613 void (*hiddev_disconnect)(struct hid_device *);
614 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
615 struct hid_usage *, __s32);
616 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
618 /* debugging support via debugfs */
619 unsigned short debug;
620 struct dentry *debug_dir;
621 struct dentry *debug_rdesc;
622 struct dentry *debug_events;
623 struct list_head debug_list;
624 spinlock_t debug_list_lock;
625 wait_queue_head_t debug_wait;
628 #define to_hid_device(pdev) \
629 container_of(pdev, struct hid_device, dev)
631 static inline void *hid_get_drvdata(struct hid_device *hdev)
633 return dev_get_drvdata(&hdev->dev);
636 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
638 dev_set_drvdata(&hdev->dev, data);
641 #define HID_GLOBAL_STACK_SIZE 4
642 #define HID_COLLECTION_STACK_SIZE 4
644 #define HID_SCAN_FLAG_MT_WIN_8 BIT(0)
645 #define HID_SCAN_FLAG_VENDOR_SPECIFIC BIT(1)
646 #define HID_SCAN_FLAG_GD_POINTER BIT(2)
649 struct hid_global global;
650 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
651 unsigned int global_stack_ptr;
652 struct hid_local local;
653 unsigned int *collection_stack;
654 unsigned int collection_stack_ptr;
655 unsigned int collection_stack_size;
656 struct hid_device *device;
657 unsigned int scan_flags;
660 struct hid_class_descriptor {
661 __u8 bDescriptorType;
662 __le16 wDescriptorLength;
663 } __attribute__ ((packed));
665 struct hid_descriptor {
667 __u8 bDescriptorType;
670 __u8 bNumDescriptors;
672 struct hid_class_descriptor desc[1];
673 } __attribute__ ((packed));
675 #define HID_DEVICE(b, g, ven, prod) \
676 .bus = (b), .group = (g), .vendor = (ven), .product = (prod)
677 #define HID_USB_DEVICE(ven, prod) \
678 .bus = BUS_USB, .vendor = (ven), .product = (prod)
679 #define HID_BLUETOOTH_DEVICE(ven, prod) \
680 .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod)
681 #define HID_I2C_DEVICE(ven, prod) \
682 .bus = BUS_I2C, .vendor = (ven), .product = (prod)
684 #define HID_REPORT_ID(rep) \
686 #define HID_USAGE_ID(uhid, utype, ucode) \
687 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
688 /* we don't want to catch types and codes equal to 0 */
689 #define HID_TERMINATOR (HID_ANY_ID - 1)
691 struct hid_report_id {
694 struct hid_usage_id {
702 * @name: driver name (e.g. "Footech_bar-wheel")
703 * @id_table: which devices is this driver for (must be non-NULL for probe
705 * @dyn_list: list of dynamically added device ids
706 * @dyn_lock: lock protecting @dyn_list
707 * @match: check if the given device is handled by this driver
708 * @probe: new device inserted
709 * @remove: device removed (NULL if not a hot-plug capable driver)
710 * @report_table: on which reports to call raw_event (NULL means all)
711 * @raw_event: if report in report_table, this hook is called (NULL means nop)
712 * @usage_table: on which events to call event (NULL means all)
713 * @event: if usage in usage_table, this hook is called (NULL means nop)
714 * @report: this hook is called after parsing a report (NULL means nop)
715 * @report_fixup: called before report descriptor parsing (NULL means nop)
716 * @input_mapping: invoked on input registering before mapping an usage
717 * @input_mapped: invoked on input registering after mapping an usage
718 * @input_configured: invoked just before the device is registered
719 * @feature_mapping: invoked on feature registering
720 * @suspend: invoked on suspend (NULL means nop)
721 * @resume: invoked on resume if device was not reset (NULL means nop)
722 * @reset_resume: invoked on resume if device was reset (NULL means nop)
724 * probe should return -errno on error, or 0 on success. During probe,
725 * input will not be passed to raw_event unless hid_device_io_start is
728 * raw_event and event should return 0 on no action performed, 1 when no
729 * further processing should be done and negative on error
731 * input_mapping shall return a negative value to completely ignore this usage
732 * (e.g. doubled or invalid usage), zero to continue with parsing of this
733 * usage by generic code (no special handling needed) or positive to skip
734 * generic parsing (needed special handling which was done in the hook already)
735 * input_mapped shall return negative to inform the layer that this usage
736 * should not be considered for further processing or zero to notify that
737 * no processing was performed and should be done in a generic manner
738 * Both these functions may be NULL which means the same behavior as returning
743 const struct hid_device_id *id_table;
745 struct list_head dyn_list;
748 bool (*match)(struct hid_device *dev, bool ignore_special_driver);
749 int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
750 void (*remove)(struct hid_device *dev);
752 const struct hid_report_id *report_table;
753 int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
755 const struct hid_usage_id *usage_table;
756 int (*event)(struct hid_device *hdev, struct hid_field *field,
757 struct hid_usage *usage, __s32 value);
758 void (*report)(struct hid_device *hdev, struct hid_report *report);
760 __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
763 int (*input_mapping)(struct hid_device *hdev,
764 struct hid_input *hidinput, struct hid_field *field,
765 struct hid_usage *usage, unsigned long **bit, int *max);
766 int (*input_mapped)(struct hid_device *hdev,
767 struct hid_input *hidinput, struct hid_field *field,
768 struct hid_usage *usage, unsigned long **bit, int *max);
769 int (*input_configured)(struct hid_device *hdev,
770 struct hid_input *hidinput);
771 void (*feature_mapping)(struct hid_device *hdev,
772 struct hid_field *field,
773 struct hid_usage *usage);
775 int (*suspend)(struct hid_device *hdev, pm_message_t message);
776 int (*resume)(struct hid_device *hdev);
777 int (*reset_resume)(struct hid_device *hdev);
780 struct device_driver driver;
783 #define to_hid_driver(pdrv) \
784 container_of(pdrv, struct hid_driver, driver)
787 * hid_ll_driver - low level driver callbacks
788 * @start: called on probe to start the device
789 * @stop: called on remove
790 * @open: called by input layer on open
791 * @close: called by input layer on close
792 * @power: request underlying hardware to enter requested power mode
793 * @parse: this method is called only once to parse the device data,
794 * shouldn't allocate anything to not leak memory
795 * @request: send report request to device (e.g. feature report)
796 * @wait: wait for buffered io to complete (send/recv reports)
797 * @raw_request: send raw report request to device (e.g. feature report)
798 * @output_report: send output report to device
799 * @idle: send idle request to device
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);
826 extern struct hid_ll_driver i2c_hid_ll_driver;
827 extern struct hid_ll_driver hidp_hid_driver;
828 extern struct hid_ll_driver uhid_hid_driver;
829 extern struct hid_ll_driver usb_hid_driver;
831 static inline bool hid_is_using_ll_driver(struct hid_device *hdev,
832 struct hid_ll_driver *driver)
834 return hdev->ll_driver == driver;
837 #define PM_HINT_FULLON 1<<5
838 #define PM_HINT_NORMAL 1<<1
840 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
841 /* We ignore a few input applications that are not widely used */
842 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006)))
846 extern int hid_debug;
848 extern bool hid_ignore(struct hid_device *);
849 extern int hid_add_device(struct hid_device *);
850 extern void hid_destroy_device(struct hid_device *);
852 extern struct bus_type hid_bus_type;
854 extern int __must_check __hid_register_driver(struct hid_driver *,
855 struct module *, const char *mod_name);
857 /* use a define to avoid include chaining to get THIS_MODULE & friends */
858 #define hid_register_driver(driver) \
859 __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
861 extern void hid_unregister_driver(struct hid_driver *);
864 * module_hid_driver() - Helper macro for registering a HID driver
865 * @__hid_driver: hid_driver struct
867 * Helper macro for HID drivers which do not do anything special in module
868 * init/exit. This eliminates a lot of boilerplate. Each module may only
869 * use this macro once, and calling it replaces module_init() and module_exit()
871 #define module_hid_driver(__hid_driver) \
872 module_driver(__hid_driver, hid_register_driver, \
873 hid_unregister_driver)
875 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
876 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
877 extern int hidinput_connect(struct hid_device *hid, unsigned int force);
878 extern void hidinput_disconnect(struct hid_device *);
880 int hid_set_field(struct hid_field *, unsigned, __s32);
881 int hid_input_report(struct hid_device *, int type, u8 *, u32, int);
882 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
883 struct hid_field *hidinput_get_led_field(struct hid_device *hid);
884 unsigned int hidinput_count_leds(struct hid_device *hid);
885 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
886 void hid_output_report(struct hid_report *report, __u8 *data);
887 void __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype);
888 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags);
889 struct hid_device *hid_allocate_device(void);
890 struct hid_report *hid_register_report(struct hid_device *device,
891 unsigned int type, unsigned int id,
892 unsigned int application);
893 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
894 struct hid_report *hid_validate_values(struct hid_device *hid,
895 unsigned int type, unsigned int id,
896 unsigned int field_index,
897 unsigned int report_counts);
898 int hid_open_report(struct hid_device *device);
899 int hid_check_keys_pressed(struct hid_device *hid);
900 int hid_connect(struct hid_device *hid, unsigned int connect_mask);
901 void hid_disconnect(struct hid_device *hid);
902 bool hid_match_one_id(const struct hid_device *hdev,
903 const struct hid_device_id *id);
904 const struct hid_device_id *hid_match_id(const struct hid_device *hdev,
905 const struct hid_device_id *id);
906 const struct hid_device_id *hid_match_device(struct hid_device *hdev,
907 struct hid_driver *hdrv);
908 bool hid_compare_device_paths(struct hid_device *hdev_a,
909 struct hid_device *hdev_b, char separator);
910 s32 hid_snto32(__u32 value, unsigned n);
911 __u32 hid_field_extract(const struct hid_device *hid, __u8 *report,
912 unsigned offset, unsigned n);
915 * hid_device_io_start - enable HID input during probe, remove
919 * This should only be called during probe or remove and only be
920 * called by the thread calling probe or remove. It will allow
921 * incoming packets to be delivered to the driver.
923 static inline void hid_device_io_start(struct hid_device *hid) {
924 if (hid->io_started) {
925 dev_warn(&hid->dev, "io already started\n");
928 hid->io_started = true;
929 up(&hid->driver_input_lock);
933 * hid_device_io_stop - disable HID input during probe, remove
937 * Should only be called after hid_device_io_start. It will prevent
938 * incoming packets from going to the driver for the duration of
939 * probe, remove. If called during probe, packets will still go to the
940 * driver after probe is complete. This function should only be called
941 * by the thread calling probe or remove.
943 static inline void hid_device_io_stop(struct hid_device *hid) {
944 if (!hid->io_started) {
945 dev_warn(&hid->dev, "io already stopped\n");
948 hid->io_started = false;
949 down(&hid->driver_input_lock);
953 * hid_map_usage - map usage input bits
955 * @hidinput: hidinput which we are interested in
956 * @usage: usage to fill in
957 * @bit: pointer to input->{}bit (out parameter)
958 * @max: maximal valid usage->code to consider later (out parameter)
959 * @type: input event type (EV_KEY, EV_REL, ...)
960 * @c: code which corresponds to this usage and type
962 * The value pointed to by @bit will be set to NULL if either @type is
963 * an unhandled event type, or if @c is out of range for @type. This
964 * can be used as an error condition.
966 static inline void hid_map_usage(struct hid_input *hidinput,
967 struct hid_usage *usage, unsigned long **bit, int *max,
968 __u8 type, unsigned int c)
970 struct input_dev *input = hidinput->input;
971 unsigned long *bmap = NULL;
972 unsigned int limit = 0;
976 bmap = input->absbit;
980 bmap = input->relbit;
984 bmap = input->keybit;
988 bmap = input->ledbit;
993 if (unlikely(c > limit || !bmap)) {
994 pr_warn_ratelimited("%s: Invalid code %d type %d\n",
995 input->name, c, type);
1007 * hid_map_usage_clear - map usage input bits and clear the input bit
1009 * The same as hid_map_usage, except the @c bit is also cleared in supported
1012 static inline void hid_map_usage_clear(struct hid_input *hidinput,
1013 struct hid_usage *usage, unsigned long **bit, int *max,
1016 hid_map_usage(hidinput, usage, bit, max, type, c);
1018 clear_bit(usage->code, *bit);
1022 * hid_parse - parse HW reports
1026 * Call this from probe after you set up the device (if needed). Your
1027 * report_fixup will be called (if non-NULL) after reading raw report from
1028 * device before passing it to hid layer for real parsing.
1030 static inline int __must_check hid_parse(struct hid_device *hdev)
1032 return hid_open_report(hdev);
1035 int __must_check hid_hw_start(struct hid_device *hdev,
1036 unsigned int connect_mask);
1037 void hid_hw_stop(struct hid_device *hdev);
1038 int __must_check hid_hw_open(struct hid_device *hdev);
1039 void hid_hw_close(struct hid_device *hdev);
1042 * hid_hw_power - requests underlying HW to go into given power mode
1045 * @level: requested power level (one of %PM_HINT_* defines)
1047 * This function requests underlying hardware to enter requested power
1051 static inline int hid_hw_power(struct hid_device *hdev, int level)
1053 return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
1058 * hid_hw_request - send report request to device
1061 * @report: report to send
1062 * @reqtype: hid request type
1064 static inline void hid_hw_request(struct hid_device *hdev,
1065 struct hid_report *report, int reqtype)
1067 if (hdev->ll_driver->request)
1068 return hdev->ll_driver->request(hdev, report, reqtype);
1070 __hid_request(hdev, report, reqtype);
1074 * hid_hw_raw_request - send report request to device
1077 * @reportnum: report ID
1078 * @buf: in/out data to transfer
1079 * @len: length of buf
1080 * @rtype: HID report type
1081 * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
1083 * @return: count of data transfered, negative if error
1085 * Same behavior as hid_hw_request, but with raw buffers instead.
1087 static inline int hid_hw_raw_request(struct hid_device *hdev,
1088 unsigned char reportnum, __u8 *buf,
1089 size_t len, unsigned char rtype, int reqtype)
1091 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1094 return hdev->ll_driver->raw_request(hdev, reportnum, buf, len,
1099 * hid_hw_output_report - send output report to device
1102 * @buf: raw data to transfer
1103 * @len: length of buf
1105 * @return: count of data transfered, negative if error
1107 static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf,
1110 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1113 if (hdev->ll_driver->output_report)
1114 return hdev->ll_driver->output_report(hdev, buf, len);
1120 * hid_hw_idle - send idle request to device
1123 * @report: report to control
1125 * @reqtype: hid request type
1127 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
1130 if (hdev->ll_driver->idle)
1131 return hdev->ll_driver->idle(hdev, report, idle, reqtype);
1137 * hid_hw_wait - wait for buffered io to complete
1141 static inline void hid_hw_wait(struct hid_device *hdev)
1143 if (hdev->ll_driver->wait)
1144 hdev->ll_driver->wait(hdev);
1148 * hid_report_len - calculate the report length
1150 * @report: the report we want to know the length
1152 static inline u32 hid_report_len(struct hid_report *report)
1154 return DIV_ROUND_UP(report->size, 8) + (report->id > 0);
1157 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, u32 size,
1160 /* HID quirks API */
1161 unsigned long hid_lookup_quirk(const struct hid_device *hdev);
1162 int hid_quirks_init(char **quirks_param, __u16 bus, int count);
1163 void hid_quirks_exit(__u16 bus);
1165 #ifdef CONFIG_HID_PID
1166 int hid_pidff_init(struct hid_device *hid);
1168 #define hid_pidff_init NULL
1171 #define dbg_hid(format, arg...) \
1174 printk(KERN_DEBUG "%s: " format, __FILE__, ##arg); \
1177 #define hid_printk(level, hid, fmt, arg...) \
1178 dev_printk(level, &(hid)->dev, fmt, ##arg)
1179 #define hid_emerg(hid, fmt, arg...) \
1180 dev_emerg(&(hid)->dev, fmt, ##arg)
1181 #define hid_crit(hid, fmt, arg...) \
1182 dev_crit(&(hid)->dev, fmt, ##arg)
1183 #define hid_alert(hid, fmt, arg...) \
1184 dev_alert(&(hid)->dev, fmt, ##arg)
1185 #define hid_err(hid, fmt, arg...) \
1186 dev_err(&(hid)->dev, fmt, ##arg)
1187 #define hid_notice(hid, fmt, arg...) \
1188 dev_notice(&(hid)->dev, fmt, ##arg)
1189 #define hid_warn(hid, fmt, arg...) \
1190 dev_warn(&(hid)->dev, fmt, ##arg)
1191 #define hid_info(hid, fmt, arg...) \
1192 dev_info(&(hid)->dev, fmt, ##arg)
1193 #define hid_dbg(hid, fmt, arg...) \
1194 dev_dbg(&(hid)->dev, fmt, ##arg)