1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3 * Copyright (c) 1999 Andreas Gal
4 * Copyright (c) 2000-2001 Vojtech Pavlik
5 * Copyright (c) 2006-2007 Jiri Kosina
6 */
7 /*
8 *
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
12 */
13 #ifndef __HID_H
14 #define __HID_H
15
16
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>
29
30 /*
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
33 * into the data area.
34 */
35
36 struct hid_item {
37 unsigned format;
38 __u8 size;
39 __u8 type;
40 __u8 tag;
41 union {
42 __u8 u8;
43 __s8 s8;
44 __u16 u16;
45 __s16 s16;
46 __u32 u32;
47 __s32 s32;
48 __u8 *longdata;
49 } data;
50 };
51
52 /*
53 * HID report item format
54 */
55
56 #define HID_ITEM_FORMAT_SHORT 0
57 #define HID_ITEM_FORMAT_LONG 1
58
59 /*
60 * Special tag indicating long items
61 */
62
63 #define HID_ITEM_TAG_LONG 15
64
65 /*
66 * HID report descriptor item type (prefix bit 2,3)
67 */
68
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
73
74 /*
75 * HID report descriptor main item tags
76 */
77
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
83
84 /*
85 * HID report descriptor main item contents
86 */
87
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
97
98 /*
99 * HID report descriptor collection item types
100 */
101
102 #define HID_COLLECTION_PHYSICAL 0
103 #define HID_COLLECTION_APPLICATION 1
104 #define HID_COLLECTION_LOGICAL 2
105
106 /*
107 * HID report descriptor global item tags
108 */
109
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
122
123 /*
124 * HID report descriptor local item tags
125 */
126
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
137
138 /*
139 * HID usage tables
140 */
141
142 #define HID_USAGE_PAGE 0xffff0000
143
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
166 #define HID_UP_GOOGLEVENDOR 0xffd10000
167
168 #define HID_USAGE 0x0000ffff
169
170 #define HID_GD_POINTER 0x00010001
171 #define HID_GD_MOUSE 0x00010002
172 #define HID_GD_JOYSTICK 0x00010004
173 #define HID_GD_GAMEPAD 0x00010005
174 #define HID_GD_KEYBOARD 0x00010006
175 #define HID_GD_KEYPAD 0x00010007
176 #define HID_GD_MULTIAXIS 0x00010008
177 /*
178 * Microsoft Win8 Wireless Radio Controls extensions CA, see:
179 * http://www.usb.org/developers/hidpage/HUTRR40RadioHIDUsagesFinal.pdf
180 */
181 #define HID_GD_WIRELESS_RADIO_CTLS 0x0001000c
182 /*
183 * System Multi-Axis, see:
184 * http://www.usb.org/developers/hidpage/HUTRR62_-_Generic_Desktop_CA_for_System_Multi-Axis_Controllers.txt
185 */
186 #define HID_GD_SYSTEM_MULTIAXIS 0x0001000e
187
188 #define HID_GD_X 0x00010030
189 #define HID_GD_Y 0x00010031
190 #define HID_GD_Z 0x00010032
191 #define HID_GD_RX 0x00010033
192 #define HID_GD_RY 0x00010034
193 #define HID_GD_RZ 0x00010035
194 #define HID_GD_SLIDER 0x00010036
195 #define HID_GD_DIAL 0x00010037
196 #define HID_GD_WHEEL 0x00010038
197 #define HID_GD_HATSWITCH 0x00010039
198 #define HID_GD_BUFFER 0x0001003a
199 #define HID_GD_BYTECOUNT 0x0001003b
200 #define HID_GD_MOTION 0x0001003c
201 #define HID_GD_START 0x0001003d
202 #define HID_GD_SELECT 0x0001003e
203 #define HID_GD_VX 0x00010040
204 #define HID_GD_VY 0x00010041
205 #define HID_GD_VZ 0x00010042
206 #define HID_GD_VBRX 0x00010043
207 #define HID_GD_VBRY 0x00010044
208 #define HID_GD_VBRZ 0x00010045
209 #define HID_GD_VNO 0x00010046
210 #define HID_GD_FEATURE 0x00010047
211 #define HID_GD_RESOLUTION_MULTIPLIER 0x00010048
212 #define HID_GD_SYSTEM_CONTROL 0x00010080
213 #define HID_GD_UP 0x00010090
214 #define HID_GD_DOWN 0x00010091
215 #define HID_GD_RIGHT 0x00010092
216 #define HID_GD_LEFT 0x00010093
217 /* Microsoft Win8 Wireless Radio Controls CA usage codes */
218 #define HID_GD_RFKILL_BTN 0x000100c6
219 #define HID_GD_RFKILL_LED 0x000100c7
220 #define HID_GD_RFKILL_SWITCH 0x000100c8
221
222 #define HID_DC_BATTERYSTRENGTH 0x00060020
223
224 #define HID_CP_CONSUMER_CONTROL 0x000c0001
225 #define HID_CP_AC_PAN 0x000c0238
226
227 #define HID_DG_DIGITIZER 0x000d0001
228 #define HID_DG_PEN 0x000d0002
229 #define HID_DG_LIGHTPEN 0x000d0003
230 #define HID_DG_TOUCHSCREEN 0x000d0004
231 #define HID_DG_TOUCHPAD 0x000d0005
232 #define HID_DG_WHITEBOARD 0x000d0006
233 #define HID_DG_STYLUS 0x000d0020
234 #define HID_DG_PUCK 0x000d0021
235 #define HID_DG_FINGER 0x000d0022
236 #define HID_DG_TIPPRESSURE 0x000d0030
237 #define HID_DG_BARRELPRESSURE 0x000d0031
238 #define HID_DG_INRANGE 0x000d0032
239 #define HID_DG_TOUCH 0x000d0033
240 #define HID_DG_UNTOUCH 0x000d0034
241 #define HID_DG_TAP 0x000d0035
242 #define HID_DG_TABLETFUNCTIONKEY 0x000d0039
243 #define HID_DG_PROGRAMCHANGEKEY 0x000d003a
244 #define HID_DG_BATTERYSTRENGTH 0x000d003b
245 #define HID_DG_INVERT 0x000d003c
246 #define HID_DG_TILT_X 0x000d003d
247 #define HID_DG_TILT_Y 0x000d003e
248 #define HID_DG_TWIST 0x000d0041
249 #define HID_DG_TIPSWITCH 0x000d0042
250 #define HID_DG_TIPSWITCH2 0x000d0043
251 #define HID_DG_BARRELSWITCH 0x000d0044
252 #define HID_DG_ERASER 0x000d0045
253 #define HID_DG_TABLETPICK 0x000d0046
254
255 #define HID_CP_CONSUMERCONTROL 0x000c0001
256 #define HID_CP_NUMERICKEYPAD 0x000c0002
257 #define HID_CP_PROGRAMMABLEBUTTONS 0x000c0003
258 #define HID_CP_MICROPHONE 0x000c0004
259 #define HID_CP_HEADPHONE 0x000c0005
260 #define HID_CP_GRAPHICEQUALIZER 0x000c0006
261 #define HID_CP_FUNCTIONBUTTONS 0x000c0036
262 #define HID_CP_SELECTION 0x000c0080
263 #define HID_CP_MEDIASELECTION 0x000c0087
264 #define HID_CP_SELECTDISC 0x000c00ba
265 #define HID_CP_PLAYBACKSPEED 0x000c00f1
266 #define HID_CP_PROXIMITY 0x000c0109
267 #define HID_CP_SPEAKERSYSTEM 0x000c0160
268 #define HID_CP_CHANNELLEFT 0x000c0161
269 #define HID_CP_CHANNELRIGHT 0x000c0162
270 #define HID_CP_CHANNELCENTER 0x000c0163
271 #define HID_CP_CHANNELFRONT 0x000c0164
272 #define HID_CP_CHANNELCENTERFRONT 0x000c0165
273 #define HID_CP_CHANNELSIDE 0x000c0166
274 #define HID_CP_CHANNELSURROUND 0x000c0167
275 #define HID_CP_CHANNELLOWFREQUENCYENHANCEMENT 0x000c0168
276 #define HID_CP_CHANNELTOP 0x000c0169
277 #define HID_CP_CHANNELUNKNOWN 0x000c016a
278 #define HID_CP_APPLICATIONLAUNCHBUTTONS 0x000c0180
279 #define HID_CP_GENERICGUIAPPLICATIONCONTROLS 0x000c0200
280
281 #define HID_DG_DEVICECONFIG 0x000d000e
282 #define HID_DG_DEVICESETTINGS 0x000d0023
283 #define HID_DG_AZIMUTH 0x000d003f
284 #define HID_DG_CONFIDENCE 0x000d0047
285 #define HID_DG_WIDTH 0x000d0048
286 #define HID_DG_HEIGHT 0x000d0049
287 #define HID_DG_CONTACTID 0x000d0051
288 #define HID_DG_INPUTMODE 0x000d0052
289 #define HID_DG_DEVICEINDEX 0x000d0053
290 #define HID_DG_CONTACTCOUNT 0x000d0054
291 #define HID_DG_CONTACTMAX 0x000d0055
292 #define HID_DG_SCANTIME 0x000d0056
293 #define HID_DG_SURFACESWITCH 0x000d0057
294 #define HID_DG_BUTTONSWITCH 0x000d0058
295 #define HID_DG_BUTTONTYPE 0x000d0059
296 #define HID_DG_BARRELSWITCH2 0x000d005a
297 #define HID_DG_TOOLSERIALNUMBER 0x000d005b
298 #define HID_DG_LATENCYMODE 0x000d0060
299
300 #define HID_VD_ASUS_CUSTOM_MEDIA_KEYS 0xff310076
301 /*
302 * HID report types --- Ouch! HID spec says 1 2 3!
303 */
304
305 #define HID_INPUT_REPORT 0
306 #define HID_OUTPUT_REPORT 1
307 #define HID_FEATURE_REPORT 2
308
309 #define HID_REPORT_TYPES 3
310
311 /*
312 * HID connect requests
313 */
314
315 #define HID_CONNECT_HIDINPUT BIT(0)
316 #define HID_CONNECT_HIDINPUT_FORCE BIT(1)
317 #define HID_CONNECT_HIDRAW BIT(2)
318 #define HID_CONNECT_HIDDEV BIT(3)
319 #define HID_CONNECT_HIDDEV_FORCE BIT(4)
320 #define HID_CONNECT_FF BIT(5)
321 #define HID_CONNECT_DRIVER BIT(6)
322 #define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
323 HID_CONNECT_HIDDEV|HID_CONNECT_FF)
324
325 /*
326 * HID device quirks.
327 */
328
329 /*
330 * Increase this if you need to configure more HID quirks at module load time
331 */
332 #define MAX_USBHID_BOOT_QUIRKS 4
333
334 #define HID_QUIRK_INVERT BIT(0)
335 #define HID_QUIRK_NOTOUCH BIT(1)
336 #define HID_QUIRK_IGNORE BIT(2)
337 #define HID_QUIRK_NOGET BIT(3)
338 #define HID_QUIRK_HIDDEV_FORCE BIT(4)
339 #define HID_QUIRK_BADPAD BIT(5)
340 #define HID_QUIRK_MULTI_INPUT BIT(6)
341 #define HID_QUIRK_HIDINPUT_FORCE BIT(7)
342 /* BIT(8) reserved for backward compatibility, was HID_QUIRK_NO_EMPTY_INPUT */
343 /* BIT(9) reserved for backward compatibility, was NO_INIT_INPUT_REPORTS */
344 #define HID_QUIRK_ALWAYS_POLL BIT(10)
345 #define HID_QUIRK_INPUT_PER_APP BIT(11)
346 #define HID_QUIRK_SKIP_OUTPUT_REPORTS BIT(16)
347 #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID BIT(17)
348 #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP BIT(18)
349 #define HID_QUIRK_HAVE_SPECIAL_DRIVER BIT(19)
350 #define HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE BIT(20)
351 #define HID_QUIRK_FULLSPEED_INTERVAL BIT(28)
352 #define HID_QUIRK_NO_INIT_REPORTS BIT(29)
353 #define HID_QUIRK_NO_IGNORE BIT(30)
354 #define HID_QUIRK_NO_INPUT_SYNC BIT(31)
355
356 /*
357 * HID device groups
358 *
359 * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h
360 * and has a value of 0x0000
361 */
362 #define HID_GROUP_GENERIC 0x0001
363 #define HID_GROUP_MULTITOUCH 0x0002
364 #define HID_GROUP_SENSOR_HUB 0x0003
365 #define HID_GROUP_MULTITOUCH_WIN_8 0x0004
366
367 /*
368 * Vendor specific HID device groups
369 */
370 #define HID_GROUP_RMI 0x0100
371 #define HID_GROUP_WACOM 0x0101
372 #define HID_GROUP_LOGITECH_DJ_DEVICE 0x0102
373 #define HID_GROUP_STEAM 0x0103
374 #define HID_GROUP_LOGITECH_27MHZ_DEVICE 0x0104
375 #define HID_GROUP_VIVALDI 0x0105
376
377 /*
378 * HID protocol status
379 */
380 #define HID_REPORT_PROTOCOL 1
381 #define HID_BOOT_PROTOCOL 0
382
383 /*
384 * This is the global environment of the parser. This information is
385 * persistent for main-items. The global environment can be saved and
386 * restored with PUSH/POP statements.
387 */
388
389 struct hid_global {
390 unsigned usage_page;
391 __s32 logical_minimum;
392 __s32 logical_maximum;
393 __s32 physical_minimum;
394 __s32 physical_maximum;
395 __s32 unit_exponent;
396 unsigned unit;
397 unsigned report_id;
398 unsigned report_size;
399 unsigned report_count;
400 };
401
402 /*
403 * This is the local environment. It is persistent up the next main-item.
404 */
405
406 #define HID_MAX_USAGES 12288
407 #define HID_DEFAULT_NUM_COLLECTIONS 16
408
409 struct hid_local {
410 unsigned usage[HID_MAX_USAGES]; /* usage array */
411 u8 usage_size[HID_MAX_USAGES]; /* usage size array */
412 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
413 unsigned usage_index;
414 unsigned usage_minimum;
415 unsigned delimiter_depth;
416 unsigned delimiter_branch;
417 };
418
419 /*
420 * This is the collection stack. We climb up the stack to determine
421 * application and function of each field.
422 */
423
424 struct hid_collection {
425 int parent_idx; /* device->collection */
426 unsigned type;
427 unsigned usage;
428 unsigned level;
429 };
430
431 struct hid_usage {
432 unsigned hid; /* hid usage code */
433 unsigned collection_index; /* index into collection array */
434 unsigned usage_index; /* index into usage array */
435 __s8 resolution_multiplier;/* Effective Resolution Multiplier
436 (HUT v1.12, 4.3.1), default: 1 */
437 /* hidinput data */
438 __s8 wheel_factor; /* 120/resolution_multiplier */
439 __u16 code; /* input driver code */
440 __u8 type; /* input driver type */
441 __s8 hat_min; /* hat switch fun */
442 __s8 hat_max; /* ditto */
443 __s8 hat_dir; /* ditto */
444 __s16 wheel_accumulated; /* hi-res wheel */
445 };
446
447 struct hid_input;
448
449 struct hid_field {
450 unsigned physical; /* physical usage for this field */
451 unsigned logical; /* logical usage for this field */
452 unsigned application; /* application usage for this field */
453 struct hid_usage *usage; /* usage table for this function */
454 unsigned maxusage; /* maximum usage index */
455 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
456 unsigned report_offset; /* bit offset in the report */
457 unsigned report_size; /* size of this field in the report */
458 unsigned report_count; /* number of this field in the report */
459 unsigned report_type; /* (input,output,feature) */
460 __s32 *value; /* last known value(s) */
461 __s32 logical_minimum;
462 __s32 logical_maximum;
463 __s32 physical_minimum;
464 __s32 physical_maximum;
465 __s32 unit_exponent;
466 unsigned unit;
467 struct hid_report *report; /* associated report */
468 unsigned index; /* index into report->field[] */
469 /* hidinput data */
470 struct hid_input *hidinput; /* associated input structure */
471 __u16 dpad; /* dpad input code */
472 };
473
474 #define HID_MAX_FIELDS 256
475
476 struct hid_report {
477 struct list_head list;
478 struct list_head hidinput_list;
479 unsigned int id; /* id of this report */
480 unsigned int type; /* report type */
481 unsigned int application; /* application usage for this report */
482 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
483 unsigned maxfield; /* maximum valid field index */
484 unsigned size; /* size of the report (bits) */
485 struct hid_device *device; /* associated device */
486 };
487
488 #define HID_MAX_IDS 256
489
490 struct hid_report_enum {
491 unsigned numbered;
492 struct list_head report_list;
493 struct hid_report *report_id_hash[HID_MAX_IDS];
494 };
495
496 #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
497 #define HID_MAX_BUFFER_SIZE 8192 /* 8kb */
498 #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
499 #define HID_OUTPUT_FIFO_SIZE 64
500
501 struct hid_control_fifo {
502 unsigned char dir;
503 struct hid_report *report;
504 char *raw_report;
505 };
506
507 struct hid_output_fifo {
508 struct hid_report *report;
509 char *raw_report;
510 };
511
512 #define HID_CLAIMED_INPUT BIT(0)
513 #define HID_CLAIMED_HIDDEV BIT(1)
514 #define HID_CLAIMED_HIDRAW BIT(2)
515 #define HID_CLAIMED_DRIVER BIT(3)
516
517 #define HID_STAT_ADDED BIT(0)
518 #define HID_STAT_PARSED BIT(1)
519 #define HID_STAT_DUP_DETECTED BIT(2)
520 #define HID_STAT_REPROBED BIT(3)
521
522 struct hid_input {
523 struct list_head list;
524 struct hid_report *report;
525 struct input_dev *input;
526 const char *name;
527 bool registered;
528 struct list_head reports; /* the list of reports */
529 unsigned int application; /* application usage for this input */
530 };
531
532 enum hid_type {
533 HID_TYPE_OTHER = 0,
534 HID_TYPE_USBMOUSE,
535 HID_TYPE_USBNONE
536 };
537
538 enum hid_battery_status {
539 HID_BATTERY_UNKNOWN = 0,
540 HID_BATTERY_QUERIED, /* Kernel explicitly queried battery strength */
541 HID_BATTERY_REPORTED, /* Device sent unsolicited battery strength report */
542 };
543
544 struct hid_driver;
545 struct hid_ll_driver;
546
547 struct hid_device { /* device report descriptor */
548 __u8 *dev_rdesc;
549 unsigned dev_rsize;
550 __u8 *rdesc;
551 unsigned rsize;
552 struct hid_collection *collection; /* List of HID collections */
553 unsigned collection_size; /* Number of allocated hid_collections */
554 unsigned maxcollection; /* Number of parsed collections */
555 unsigned maxapplication; /* Number of applications */
556 __u16 bus; /* BUS ID */
557 __u16 group; /* Report group */
558 __u32 vendor; /* Vendor ID */
559 __u32 product; /* Product ID */
560 __u32 version; /* HID version */
561 enum hid_type type; /* device type (mouse, kbd, ...) */
562 unsigned country; /* HID country */
563 struct hid_report_enum report_enum[HID_REPORT_TYPES];
564 struct work_struct led_work; /* delayed LED worker */
565
566 struct semaphore driver_input_lock; /* protects the current driver */
567 struct device dev; /* device */
568 struct hid_driver *driver;
569
570 struct hid_ll_driver *ll_driver;
571 struct mutex ll_open_lock;
572 unsigned int ll_open_count;
573
574 #ifdef CONFIG_HID_BATTERY_STRENGTH
575 /*
576 * Power supply information for HID devices which report
577 * battery strength. power_supply was successfully registered if
578 * battery is non-NULL.
579 */
580 struct power_supply *battery;
581 __s32 battery_capacity;
582 __s32 battery_min;
583 __s32 battery_max;
584 __s32 battery_report_type;
585 __s32 battery_report_id;
586 enum hid_battery_status battery_status;
587 bool battery_avoid_query;
588 #endif
589
590 unsigned long status; /* see STAT flags above */
591 unsigned claimed; /* Claimed by hidinput, hiddev? */
592 unsigned quirks; /* Various quirks the device can pull on us */
593 bool io_started; /* If IO has started */
594
595 struct list_head inputs; /* The list of inputs */
596 void *hiddev; /* The hiddev structure */
597 void *hidraw;
598
599 char name[128]; /* Device name */
600 char phys[64]; /* Device physical location */
601 char uniq[64]; /* Device unique identifier (serial #) */
602
603 void *driver_data;
604
605 /* temporary hid_ff handling (until moved to the drivers) */
606 int (*ff_init)(struct hid_device *);
607
608 /* hiddev event handler */
609 int (*hiddev_connect)(struct hid_device *, unsigned int);
610 void (*hiddev_disconnect)(struct hid_device *);
611 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
612 struct hid_usage *, __s32);
613 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
614
615 /* debugging support via debugfs */
616 unsigned short debug;
617 struct dentry *debug_dir;
618 struct dentry *debug_rdesc;
619 struct dentry *debug_events;
620 struct list_head debug_list;
621 spinlock_t debug_list_lock;
622 wait_queue_head_t debug_wait;
623 };
624
625 #define to_hid_device(pdev) \
626 container_of(pdev, struct hid_device, dev)
627
hid_get_drvdata(struct hid_device * hdev)628 static inline void *hid_get_drvdata(struct hid_device *hdev)
629 {
630 return dev_get_drvdata(&hdev->dev);
631 }
632
hid_set_drvdata(struct hid_device * hdev,void * data)633 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
634 {
635 dev_set_drvdata(&hdev->dev, data);
636 }
637
638 #define HID_GLOBAL_STACK_SIZE 4
639 #define HID_COLLECTION_STACK_SIZE 4
640
641 #define HID_SCAN_FLAG_MT_WIN_8 BIT(0)
642 #define HID_SCAN_FLAG_VENDOR_SPECIFIC BIT(1)
643 #define HID_SCAN_FLAG_GD_POINTER BIT(2)
644
645 struct hid_parser {
646 struct hid_global global;
647 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
648 unsigned int global_stack_ptr;
649 struct hid_local local;
650 unsigned int *collection_stack;
651 unsigned int collection_stack_ptr;
652 unsigned int collection_stack_size;
653 struct hid_device *device;
654 unsigned int scan_flags;
655 };
656
657 struct hid_class_descriptor {
658 __u8 bDescriptorType;
659 __le16 wDescriptorLength;
660 } __attribute__ ((packed));
661
662 struct hid_descriptor {
663 __u8 bLength;
664 __u8 bDescriptorType;
665 __le16 bcdHID;
666 __u8 bCountryCode;
667 __u8 bNumDescriptors;
668
669 struct hid_class_descriptor desc[1];
670 } __attribute__ ((packed));
671
672 #define HID_DEVICE(b, g, ven, prod) \
673 .bus = (b), .group = (g), .vendor = (ven), .product = (prod)
674 #define HID_USB_DEVICE(ven, prod) \
675 .bus = BUS_USB, .vendor = (ven), .product = (prod)
676 #define HID_BLUETOOTH_DEVICE(ven, prod) \
677 .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod)
678 #define HID_I2C_DEVICE(ven, prod) \
679 .bus = BUS_I2C, .vendor = (ven), .product = (prod)
680
681 #define HID_REPORT_ID(rep) \
682 .report_type = (rep)
683 #define HID_USAGE_ID(uhid, utype, ucode) \
684 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
685 /* we don't want to catch types and codes equal to 0 */
686 #define HID_TERMINATOR (HID_ANY_ID - 1)
687
688 struct hid_report_id {
689 __u32 report_type;
690 };
691 struct hid_usage_id {
692 __u32 usage_hid;
693 __u32 usage_type;
694 __u32 usage_code;
695 };
696
697 /**
698 * struct hid_driver
699 * @name: driver name (e.g. "Footech_bar-wheel")
700 * @id_table: which devices is this driver for (must be non-NULL for probe
701 * to be called)
702 * @dyn_list: list of dynamically added device ids
703 * @dyn_lock: lock protecting @dyn_list
704 * @match: check if the given device is handled by this driver
705 * @probe: new device inserted
706 * @remove: device removed (NULL if not a hot-plug capable driver)
707 * @report_table: on which reports to call raw_event (NULL means all)
708 * @raw_event: if report in report_table, this hook is called (NULL means nop)
709 * @usage_table: on which events to call event (NULL means all)
710 * @event: if usage in usage_table, this hook is called (NULL means nop)
711 * @report: this hook is called after parsing a report (NULL means nop)
712 * @report_fixup: called before report descriptor parsing (NULL means nop)
713 * @input_mapping: invoked on input registering before mapping an usage
714 * @input_mapped: invoked on input registering after mapping an usage
715 * @input_configured: invoked just before the device is registered
716 * @feature_mapping: invoked on feature registering
717 * @suspend: invoked on suspend (NULL means nop)
718 * @resume: invoked on resume if device was not reset (NULL means nop)
719 * @reset_resume: invoked on resume if device was reset (NULL means nop)
720 *
721 * probe should return -errno on error, or 0 on success. During probe,
722 * input will not be passed to raw_event unless hid_device_io_start is
723 * called.
724 *
725 * raw_event and event should return negative on error, any other value will
726 * pass the event on to .event() typically return 0 for success.
727 *
728 * input_mapping shall return a negative value to completely ignore this usage
729 * (e.g. doubled or invalid usage), zero to continue with parsing of this
730 * usage by generic code (no special handling needed) or positive to skip
731 * generic parsing (needed special handling which was done in the hook already)
732 * input_mapped shall return negative to inform the layer that this usage
733 * should not be considered for further processing or zero to notify that
734 * no processing was performed and should be done in a generic manner
735 * Both these functions may be NULL which means the same behavior as returning
736 * zero from them.
737 */
738 struct hid_driver {
739 char *name;
740 const struct hid_device_id *id_table;
741
742 struct list_head dyn_list;
743 spinlock_t dyn_lock;
744
745 bool (*match)(struct hid_device *dev, bool ignore_special_driver);
746 int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
747 void (*remove)(struct hid_device *dev);
748
749 const struct hid_report_id *report_table;
750 int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
751 u8 *data, int size);
752 const struct hid_usage_id *usage_table;
753 int (*event)(struct hid_device *hdev, struct hid_field *field,
754 struct hid_usage *usage, __s32 value);
755 void (*report)(struct hid_device *hdev, struct hid_report *report);
756
757 __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
758 unsigned int *size);
759
760 int (*input_mapping)(struct hid_device *hdev,
761 struct hid_input *hidinput, struct hid_field *field,
762 struct hid_usage *usage, unsigned long **bit, int *max);
763 int (*input_mapped)(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_configured)(struct hid_device *hdev,
767 struct hid_input *hidinput);
768 void (*feature_mapping)(struct hid_device *hdev,
769 struct hid_field *field,
770 struct hid_usage *usage);
771 #ifdef CONFIG_PM
772 int (*suspend)(struct hid_device *hdev, pm_message_t message);
773 int (*resume)(struct hid_device *hdev);
774 int (*reset_resume)(struct hid_device *hdev);
775 #endif
776 /* private: */
777 struct device_driver driver;
778 };
779
780 #define to_hid_driver(pdrv) \
781 container_of(pdrv, struct hid_driver, driver)
782
783 /**
784 * hid_ll_driver - low level driver callbacks
785 * @start: called on probe to start the device
786 * @stop: called on remove
787 * @open: called by input layer on open
788 * @close: called by input layer on close
789 * @power: request underlying hardware to enter requested power mode
790 * @parse: this method is called only once to parse the device data,
791 * shouldn't allocate anything to not leak memory
792 * @request: send report request to device (e.g. feature report)
793 * @wait: wait for buffered io to complete (send/recv reports)
794 * @raw_request: send raw report request to device (e.g. feature report)
795 * @output_report: send output report to device
796 * @idle: send idle request to device
797 */
798 struct hid_ll_driver {
799 int (*start)(struct hid_device *hdev);
800 void (*stop)(struct hid_device *hdev);
801
802 int (*open)(struct hid_device *hdev);
803 void (*close)(struct hid_device *hdev);
804
805 int (*power)(struct hid_device *hdev, int level);
806
807 int (*parse)(struct hid_device *hdev);
808
809 void (*request)(struct hid_device *hdev,
810 struct hid_report *report, int reqtype);
811
812 int (*wait)(struct hid_device *hdev);
813
814 int (*raw_request) (struct hid_device *hdev, unsigned char reportnum,
815 __u8 *buf, size_t len, unsigned char rtype,
816 int reqtype);
817
818 int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len);
819
820 int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype);
821 };
822
823 extern struct hid_ll_driver i2c_hid_ll_driver;
824 extern struct hid_ll_driver hidp_hid_driver;
825 extern struct hid_ll_driver uhid_hid_driver;
826 extern struct hid_ll_driver usb_hid_driver;
827
hid_is_using_ll_driver(struct hid_device * hdev,struct hid_ll_driver * driver)828 static inline bool hid_is_using_ll_driver(struct hid_device *hdev,
829 struct hid_ll_driver *driver)
830 {
831 return hdev->ll_driver == driver;
832 }
833
834 #define PM_HINT_FULLON 1<<5
835 #define PM_HINT_NORMAL 1<<1
836
837 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
838 /* We ignore a few input applications that are not widely used */
839 #define IS_INPUT_APPLICATION(a) \
840 (((a >= HID_UP_GENDESK) && (a <= HID_GD_MULTIAXIS)) \
841 || ((a >= HID_DG_PEN) && (a <= HID_DG_WHITEBOARD)) \
842 || (a == HID_GD_SYSTEM_CONTROL) || (a == HID_CP_CONSUMER_CONTROL) \
843 || (a == HID_GD_WIRELESS_RADIO_CTLS))
844
845 /* HID core API */
846
847 extern int hid_debug;
848
849 extern bool hid_ignore(struct hid_device *);
850 extern int hid_add_device(struct hid_device *);
851 extern void hid_destroy_device(struct hid_device *);
852
853 extern struct bus_type hid_bus_type;
854
855 extern int __must_check __hid_register_driver(struct hid_driver *,
856 struct module *, const char *mod_name);
857
858 /* use a define to avoid include chaining to get THIS_MODULE & friends */
859 #define hid_register_driver(driver) \
860 __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
861
862 extern void hid_unregister_driver(struct hid_driver *);
863
864 /**
865 * module_hid_driver() - Helper macro for registering a HID driver
866 * @__hid_driver: hid_driver struct
867 *
868 * Helper macro for HID drivers which do not do anything special in module
869 * init/exit. This eliminates a lot of boilerplate. Each module may only
870 * use this macro once, and calling it replaces module_init() and module_exit()
871 */
872 #define module_hid_driver(__hid_driver) \
873 module_driver(__hid_driver, hid_register_driver, \
874 hid_unregister_driver)
875
876 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
877 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
878 extern int hidinput_connect(struct hid_device *hid, unsigned int force);
879 extern void hidinput_disconnect(struct hid_device *);
880
881 int hid_set_field(struct hid_field *, unsigned, __s32);
882 int hid_input_report(struct hid_device *, int type, u8 *, u32, int);
883 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
884 struct hid_field *hidinput_get_led_field(struct hid_device *hid);
885 unsigned int hidinput_count_leds(struct hid_device *hid);
886 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
887 void hid_output_report(struct hid_report *report, __u8 *data);
888 int __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype);
889 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags);
890 struct hid_device *hid_allocate_device(void);
891 struct hid_report *hid_register_report(struct hid_device *device,
892 unsigned int type, unsigned int id,
893 unsigned int application);
894 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
895 struct hid_report *hid_validate_values(struct hid_device *hid,
896 unsigned int type, unsigned int id,
897 unsigned int field_index,
898 unsigned int report_counts);
899
900 void hid_setup_resolution_multiplier(struct hid_device *hid);
901 int hid_open_report(struct hid_device *device);
902 int hid_check_keys_pressed(struct hid_device *hid);
903 int hid_connect(struct hid_device *hid, unsigned int connect_mask);
904 void hid_disconnect(struct hid_device *hid);
905 bool hid_match_one_id(const struct hid_device *hdev,
906 const struct hid_device_id *id);
907 const struct hid_device_id *hid_match_id(const struct hid_device *hdev,
908 const struct hid_device_id *id);
909 const struct hid_device_id *hid_match_device(struct hid_device *hdev,
910 struct hid_driver *hdrv);
911 bool hid_compare_device_paths(struct hid_device *hdev_a,
912 struct hid_device *hdev_b, char separator);
913 s32 hid_snto32(__u32 value, unsigned n);
914 __u32 hid_field_extract(const struct hid_device *hid, __u8 *report,
915 unsigned offset, unsigned n);
916
917 /**
918 * hid_device_io_start - enable HID input during probe, remove
919 *
920 * @hid - the device
921 *
922 * This should only be called during probe or remove and only be
923 * called by the thread calling probe or remove. It will allow
924 * incoming packets to be delivered to the driver.
925 */
hid_device_io_start(struct hid_device * hid)926 static inline void hid_device_io_start(struct hid_device *hid) {
927 if (hid->io_started) {
928 dev_warn(&hid->dev, "io already started\n");
929 return;
930 }
931 hid->io_started = true;
932 up(&hid->driver_input_lock);
933 }
934
935 /**
936 * hid_device_io_stop - disable HID input during probe, remove
937 *
938 * @hid - the device
939 *
940 * Should only be called after hid_device_io_start. It will prevent
941 * incoming packets from going to the driver for the duration of
942 * probe, remove. If called during probe, packets will still go to the
943 * driver after probe is complete. This function should only be called
944 * by the thread calling probe or remove.
945 */
hid_device_io_stop(struct hid_device * hid)946 static inline void hid_device_io_stop(struct hid_device *hid) {
947 if (!hid->io_started) {
948 dev_warn(&hid->dev, "io already stopped\n");
949 return;
950 }
951 hid->io_started = false;
952 down(&hid->driver_input_lock);
953 }
954
955 /**
956 * hid_map_usage - map usage input bits
957 *
958 * @hidinput: hidinput which we are interested in
959 * @usage: usage to fill in
960 * @bit: pointer to input->{}bit (out parameter)
961 * @max: maximal valid usage->code to consider later (out parameter)
962 * @type: input event type (EV_KEY, EV_REL, ...)
963 * @c: code which corresponds to this usage and type
964 *
965 * The value pointed to by @bit will be set to NULL if either @type is
966 * an unhandled event type, or if @c is out of range for @type. This
967 * can be used as an error condition.
968 */
hid_map_usage(struct hid_input * hidinput,struct hid_usage * usage,unsigned long ** bit,int * max,__u8 type,unsigned int c)969 static inline void hid_map_usage(struct hid_input *hidinput,
970 struct hid_usage *usage, unsigned long **bit, int *max,
971 __u8 type, unsigned int c)
972 {
973 struct input_dev *input = hidinput->input;
974 unsigned long *bmap = NULL;
975 unsigned int limit = 0;
976
977 switch (type) {
978 case EV_ABS:
979 bmap = input->absbit;
980 limit = ABS_MAX;
981 break;
982 case EV_REL:
983 bmap = input->relbit;
984 limit = REL_MAX;
985 break;
986 case EV_KEY:
987 bmap = input->keybit;
988 limit = KEY_MAX;
989 break;
990 case EV_LED:
991 bmap = input->ledbit;
992 limit = LED_MAX;
993 break;
994 }
995
996 if (unlikely(c > limit || !bmap)) {
997 pr_warn_ratelimited("%s: Invalid code %d type %d\n",
998 input->name, c, type);
999 *bit = NULL;
1000 return;
1001 }
1002
1003 usage->type = type;
1004 usage->code = c;
1005 *max = limit;
1006 *bit = bmap;
1007 }
1008
1009 /**
1010 * hid_map_usage_clear - map usage input bits and clear the input bit
1011 *
1012 * The same as hid_map_usage, except the @c bit is also cleared in supported
1013 * bits (@bit).
1014 */
hid_map_usage_clear(struct hid_input * hidinput,struct hid_usage * usage,unsigned long ** bit,int * max,__u8 type,__u16 c)1015 static inline void hid_map_usage_clear(struct hid_input *hidinput,
1016 struct hid_usage *usage, unsigned long **bit, int *max,
1017 __u8 type, __u16 c)
1018 {
1019 hid_map_usage(hidinput, usage, bit, max, type, c);
1020 if (*bit)
1021 clear_bit(usage->code, *bit);
1022 }
1023
1024 /**
1025 * hid_parse - parse HW reports
1026 *
1027 * @hdev: hid device
1028 *
1029 * Call this from probe after you set up the device (if needed). Your
1030 * report_fixup will be called (if non-NULL) after reading raw report from
1031 * device before passing it to hid layer for real parsing.
1032 */
hid_parse(struct hid_device * hdev)1033 static inline int __must_check hid_parse(struct hid_device *hdev)
1034 {
1035 return hid_open_report(hdev);
1036 }
1037
1038 int __must_check hid_hw_start(struct hid_device *hdev,
1039 unsigned int connect_mask);
1040 void hid_hw_stop(struct hid_device *hdev);
1041 int __must_check hid_hw_open(struct hid_device *hdev);
1042 void hid_hw_close(struct hid_device *hdev);
1043
1044 /**
1045 * hid_hw_power - requests underlying HW to go into given power mode
1046 *
1047 * @hdev: hid device
1048 * @level: requested power level (one of %PM_HINT_* defines)
1049 *
1050 * This function requests underlying hardware to enter requested power
1051 * mode.
1052 */
1053
hid_hw_power(struct hid_device * hdev,int level)1054 static inline int hid_hw_power(struct hid_device *hdev, int level)
1055 {
1056 return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
1057 }
1058
1059
1060 /**
1061 * hid_hw_request - send report request to device
1062 *
1063 * @hdev: hid device
1064 * @report: report to send
1065 * @reqtype: hid request type
1066 */
hid_hw_request(struct hid_device * hdev,struct hid_report * report,int reqtype)1067 static inline void hid_hw_request(struct hid_device *hdev,
1068 struct hid_report *report, int reqtype)
1069 {
1070 if (hdev->ll_driver->request)
1071 return hdev->ll_driver->request(hdev, report, reqtype);
1072
1073 __hid_request(hdev, report, reqtype);
1074 }
1075
1076 /**
1077 * hid_hw_raw_request - send report request to device
1078 *
1079 * @hdev: hid device
1080 * @reportnum: report ID
1081 * @buf: in/out data to transfer
1082 * @len: length of buf
1083 * @rtype: HID report type
1084 * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
1085 *
1086 * @return: count of data transfered, negative if error
1087 *
1088 * Same behavior as hid_hw_request, but with raw buffers instead.
1089 */
hid_hw_raw_request(struct hid_device * hdev,unsigned char reportnum,__u8 * buf,size_t len,unsigned char rtype,int reqtype)1090 static inline int hid_hw_raw_request(struct hid_device *hdev,
1091 unsigned char reportnum, __u8 *buf,
1092 size_t len, unsigned char rtype, int reqtype)
1093 {
1094 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1095 return -EINVAL;
1096
1097 return hdev->ll_driver->raw_request(hdev, reportnum, buf, len,
1098 rtype, reqtype);
1099 }
1100
1101 /**
1102 * hid_hw_output_report - send output report to device
1103 *
1104 * @hdev: hid device
1105 * @buf: raw data to transfer
1106 * @len: length of buf
1107 *
1108 * @return: count of data transfered, negative if error
1109 */
hid_hw_output_report(struct hid_device * hdev,__u8 * buf,size_t len)1110 static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf,
1111 size_t len)
1112 {
1113 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1114 return -EINVAL;
1115
1116 if (hdev->ll_driver->output_report)
1117 return hdev->ll_driver->output_report(hdev, buf, len);
1118
1119 return -ENOSYS;
1120 }
1121
1122 /**
1123 * hid_hw_idle - send idle request to device
1124 *
1125 * @hdev: hid device
1126 * @report: report to control
1127 * @idle: idle state
1128 * @reqtype: hid request type
1129 */
hid_hw_idle(struct hid_device * hdev,int report,int idle,int reqtype)1130 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
1131 int reqtype)
1132 {
1133 if (hdev->ll_driver->idle)
1134 return hdev->ll_driver->idle(hdev, report, idle, reqtype);
1135
1136 return 0;
1137 }
1138
1139 /**
1140 * hid_hw_wait - wait for buffered io to complete
1141 *
1142 * @hdev: hid device
1143 */
hid_hw_wait(struct hid_device * hdev)1144 static inline void hid_hw_wait(struct hid_device *hdev)
1145 {
1146 if (hdev->ll_driver->wait)
1147 hdev->ll_driver->wait(hdev);
1148 }
1149
1150 /**
1151 * hid_report_len - calculate the report length
1152 *
1153 * @report: the report we want to know the length
1154 */
hid_report_len(struct hid_report * report)1155 static inline u32 hid_report_len(struct hid_report *report)
1156 {
1157 /* equivalent to DIV_ROUND_UP(report->size, 8) + !!(report->id > 0) */
1158 return ((report->size - 1) >> 3) + 1 + (report->id > 0);
1159 }
1160
1161 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, u32 size,
1162 int interrupt);
1163
1164 /* HID quirks API */
1165 unsigned long hid_lookup_quirk(const struct hid_device *hdev);
1166 int hid_quirks_init(char **quirks_param, __u16 bus, int count);
1167 void hid_quirks_exit(__u16 bus);
1168
1169 #ifdef CONFIG_HID_PID
1170 int hid_pidff_init(struct hid_device *hid);
1171 #else
1172 #define hid_pidff_init NULL
1173 #endif
1174
1175 #define dbg_hid(fmt, ...) \
1176 do { \
1177 if (hid_debug) \
1178 printk(KERN_DEBUG "%s: " fmt, __FILE__, ##__VA_ARGS__); \
1179 } while (0)
1180
1181 #define hid_err(hid, fmt, ...) \
1182 dev_err(&(hid)->dev, fmt, ##__VA_ARGS__)
1183 #define hid_notice(hid, fmt, ...) \
1184 dev_notice(&(hid)->dev, fmt, ##__VA_ARGS__)
1185 #define hid_warn(hid, fmt, ...) \
1186 dev_warn(&(hid)->dev, fmt, ##__VA_ARGS__)
1187 #define hid_info(hid, fmt, ...) \
1188 dev_info(&(hid)->dev, fmt, ##__VA_ARGS__)
1189 #define hid_dbg(hid, fmt, ...) \
1190 dev_dbg(&(hid)->dev, fmt, ##__VA_ARGS__)
1191
1192 #define hid_err_once(hid, fmt, ...) \
1193 dev_err_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1194 #define hid_notice_once(hid, fmt, ...) \
1195 dev_notice_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1196 #define hid_warn_once(hid, fmt, ...) \
1197 dev_warn_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1198 #define hid_info_once(hid, fmt, ...) \
1199 dev_info_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1200 #define hid_dbg_once(hid, fmt, ...) \
1201 dev_dbg_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1202
1203 #endif
1204
