1 /*
2  *  Copyright (c) 1999 Andreas Gal
3  *  Copyright (c) 2000-2001 Vojtech Pavlik
4  *  Copyright (c) 2006-2007 Jiri Kosina
5  */
6 /*
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.
11  *
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.
16  *
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
20  *
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
24  */
25 #ifndef __HID_H
26 #define __HID_H
27 
28 
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>
41 
42 /*
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
45  * into the data area.
46  */
47 
48 struct hid_item {
49 	unsigned  format;
50 	__u8      size;
51 	__u8      type;
52 	__u8      tag;
53 	union {
54 	    __u8   u8;
55 	    __s8   s8;
56 	    __u16  u16;
57 	    __s16  s16;
58 	    __u32  u32;
59 	    __s32  s32;
60 	    __u8  *longdata;
61 	} data;
62 };
63 
64 /*
65  * HID report item format
66  */
67 
68 #define HID_ITEM_FORMAT_SHORT	0
69 #define HID_ITEM_FORMAT_LONG	1
70 
71 /*
72  * Special tag indicating long items
73  */
74 
75 #define HID_ITEM_TAG_LONG	15
76 
77 /*
78  * HID report descriptor item type (prefix bit 2,3)
79  */
80 
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
85 
86 /*
87  * HID report descriptor main item tags
88  */
89 
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
95 
96 /*
97  * HID report descriptor main item contents
98  */
99 
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
109 
110 /*
111  * HID report descriptor collection item types
112  */
113 
114 #define HID_COLLECTION_PHYSICAL		0
115 #define HID_COLLECTION_APPLICATION	1
116 #define HID_COLLECTION_LOGICAL		2
117 
118 /*
119  * HID report descriptor global item tags
120  */
121 
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
134 
135 /*
136  * HID report descriptor local item tags
137  */
138 
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
149 
150 /*
151  * HID usage tables
152  */
153 
154 #define HID_USAGE_PAGE		0xffff0000
155 
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
178 
179 #define HID_USAGE		0x0000ffff
180 
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
188 /*
189  * Microsoft Win8 Wireless Radio Controls extensions CA, see:
190  * http://www.usb.org/developers/hidpage/HUTRR40RadioHIDUsagesFinal.pdf
191  */
192 #define HID_GD_WIRELESS_RADIO_CTLS	0x0001000c
193 /*
194  * System Multi-Axis, see:
195  * http://www.usb.org/developers/hidpage/HUTRR62_-_Generic_Desktop_CA_for_System_Multi-Axis_Controllers.txt
196  */
197 #define HID_GD_SYSTEM_MULTIAXIS	0x0001000e
198 
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
231 
232 #define HID_DC_BATTERYSTRENGTH	0x00060020
233 
234 #define HID_CP_CONSUMER_CONTROL	0x000c0001
235 
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
262 
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_PLAYBACKSPEED	0x000c00f1
274 #define HID_CP_PROXIMITY	0x000c0109
275 #define HID_CP_SPEAKERSYSTEM	0x000c0160
276 #define HID_CP_CHANNELLEFT	0x000c0161
277 #define HID_CP_CHANNELRIGHT	0x000c0162
278 #define HID_CP_CHANNELCENTER	0x000c0163
279 #define HID_CP_CHANNELFRONT	0x000c0164
280 #define HID_CP_CHANNELCENTERFRONT	0x000c0165
281 #define HID_CP_CHANNELSIDE	0x000c0166
282 #define HID_CP_CHANNELSURROUND	0x000c0167
283 #define HID_CP_CHANNELLOWFREQUENCYENHANCEMENT	0x000c0168
284 #define HID_CP_CHANNELTOP	0x000c0169
285 #define HID_CP_CHANNELUNKNOWN	0x000c016a
286 #define HID_CP_APPLICATIONLAUNCHBUTTONS	0x000c0180
287 #define HID_CP_GENERICGUIAPPLICATIONCONTROLS	0x000c0200
288 
289 #define HID_DG_DEVICECONFIG	0x000d000e
290 #define HID_DG_DEVICESETTINGS	0x000d0023
291 #define HID_DG_AZIMUTH		0x000d003f
292 #define HID_DG_CONFIDENCE	0x000d0047
293 #define HID_DG_WIDTH		0x000d0048
294 #define HID_DG_HEIGHT		0x000d0049
295 #define HID_DG_CONTACTID	0x000d0051
296 #define HID_DG_INPUTMODE	0x000d0052
297 #define HID_DG_DEVICEINDEX	0x000d0053
298 #define HID_DG_CONTACTCOUNT	0x000d0054
299 #define HID_DG_CONTACTMAX	0x000d0055
300 #define HID_DG_SCANTIME		0x000d0056
301 #define HID_DG_SURFACESWITCH	0x000d0057
302 #define HID_DG_BUTTONSWITCH	0x000d0058
303 #define HID_DG_BUTTONTYPE	0x000d0059
304 #define HID_DG_BARRELSWITCH2	0x000d005a
305 #define HID_DG_TOOLSERIALNUMBER	0x000d005b
306 #define HID_DG_LATENCYMODE	0x000d0060
307 
308 #define HID_VD_ASUS_CUSTOM_MEDIA_KEYS	0xff310076
309 /*
310  * HID report types --- Ouch! HID spec says 1 2 3!
311  */
312 
313 #define HID_INPUT_REPORT	0
314 #define HID_OUTPUT_REPORT	1
315 #define HID_FEATURE_REPORT	2
316 
317 #define HID_REPORT_TYPES	3
318 
319 /*
320  * HID connect requests
321  */
322 
323 #define HID_CONNECT_HIDINPUT		BIT(0)
324 #define HID_CONNECT_HIDINPUT_FORCE	BIT(1)
325 #define HID_CONNECT_HIDRAW		BIT(2)
326 #define HID_CONNECT_HIDDEV		BIT(3)
327 #define HID_CONNECT_HIDDEV_FORCE	BIT(4)
328 #define HID_CONNECT_FF			BIT(5)
329 #define HID_CONNECT_DRIVER		BIT(6)
330 #define HID_CONNECT_DEFAULT	(HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
331 		HID_CONNECT_HIDDEV|HID_CONNECT_FF)
332 
333 /*
334  * HID device quirks.
335  */
336 
337 /*
338  * Increase this if you need to configure more HID quirks at module load time
339  */
340 #define MAX_USBHID_BOOT_QUIRKS 4
341 
342 #define HID_QUIRK_INVERT			BIT(0)
343 #define HID_QUIRK_NOTOUCH			BIT(1)
344 #define HID_QUIRK_IGNORE			BIT(2)
345 #define HID_QUIRK_NOGET				BIT(3)
346 #define HID_QUIRK_HIDDEV_FORCE			BIT(4)
347 #define HID_QUIRK_BADPAD			BIT(5)
348 #define HID_QUIRK_MULTI_INPUT			BIT(6)
349 #define HID_QUIRK_HIDINPUT_FORCE		BIT(7)
350 /* BIT(8) reserved for backward compatibility, was HID_QUIRK_NO_EMPTY_INPUT */
351 /* BIT(9) reserved for backward compatibility, was NO_INIT_INPUT_REPORTS */
352 #define HID_QUIRK_ALWAYS_POLL			BIT(10)
353 #define HID_QUIRK_INPUT_PER_APP			BIT(11)
354 #define HID_QUIRK_SKIP_OUTPUT_REPORTS		BIT(16)
355 #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID		BIT(17)
356 #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP	BIT(18)
357 #define HID_QUIRK_HAVE_SPECIAL_DRIVER		BIT(19)
358 #define HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE	BIT(20)
359 #define HID_QUIRK_FULLSPEED_INTERVAL		BIT(28)
360 #define HID_QUIRK_NO_INIT_REPORTS		BIT(29)
361 #define HID_QUIRK_NO_IGNORE			BIT(30)
362 #define HID_QUIRK_NO_INPUT_SYNC			BIT(31)
363 
364 /*
365  * HID device groups
366  *
367  * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h
368  * and has a value of 0x0000
369  */
370 #define HID_GROUP_GENERIC			0x0001
371 #define HID_GROUP_MULTITOUCH			0x0002
372 #define HID_GROUP_SENSOR_HUB			0x0003
373 #define HID_GROUP_MULTITOUCH_WIN_8		0x0004
374 
375 /*
376  * Vendor specific HID device groups
377  */
378 #define HID_GROUP_RMI				0x0100
379 #define HID_GROUP_WACOM				0x0101
380 #define HID_GROUP_LOGITECH_DJ_DEVICE		0x0102
381 #define HID_GROUP_STEAM				0x0103
382 
383 /*
384  * HID protocol status
385  */
386 #define HID_REPORT_PROTOCOL	1
387 #define HID_BOOT_PROTOCOL	0
388 
389 /*
390  * This is the global environment of the parser. This information is
391  * persistent for main-items. The global environment can be saved and
392  * restored with PUSH/POP statements.
393  */
394 
395 struct hid_global {
396 	unsigned usage_page;
397 	__s32    logical_minimum;
398 	__s32    logical_maximum;
399 	__s32    physical_minimum;
400 	__s32    physical_maximum;
401 	__s32    unit_exponent;
402 	unsigned unit;
403 	unsigned report_id;
404 	unsigned report_size;
405 	unsigned report_count;
406 };
407 
408 /*
409  * This is the local environment. It is persistent up the next main-item.
410  */
411 
412 #define HID_MAX_USAGES			12288
413 #define HID_DEFAULT_NUM_COLLECTIONS	16
414 
415 struct hid_local {
416 	unsigned usage[HID_MAX_USAGES]; /* usage array */
417 	unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
418 	unsigned usage_index;
419 	unsigned usage_minimum;
420 	unsigned delimiter_depth;
421 	unsigned delimiter_branch;
422 };
423 
424 /*
425  * This is the collection stack. We climb up the stack to determine
426  * application and function of each field.
427  */
428 
429 struct hid_collection {
430 	unsigned type;
431 	unsigned usage;
432 	unsigned level;
433 };
434 
435 struct hid_usage {
436 	unsigned  hid;			/* hid usage code */
437 	unsigned  collection_index;	/* index into collection array */
438 	unsigned  usage_index;		/* index into usage array */
439 	/* hidinput data */
440 	__u16     code;			/* input driver code */
441 	__u8      type;			/* input driver type */
442 	__s8	  hat_min;		/* hat switch fun */
443 	__s8	  hat_max;		/* ditto */
444 	__s8	  hat_dir;		/* ditto */
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	4096		/* 4kb */
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 0 on no action performed, 1 when no
726  * further processing should be done and negative on error
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) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006)))
840 
841 /* HID core API */
842 
843 extern int hid_debug;
844 
845 extern bool hid_ignore(struct hid_device *);
846 extern int hid_add_device(struct hid_device *);
847 extern void hid_destroy_device(struct hid_device *);
848 
849 extern struct bus_type hid_bus_type;
850 
851 extern int __must_check __hid_register_driver(struct hid_driver *,
852 		struct module *, const char *mod_name);
853 
854 /* use a define to avoid include chaining to get THIS_MODULE & friends */
855 #define hid_register_driver(driver) \
856 	__hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
857 
858 extern void hid_unregister_driver(struct hid_driver *);
859 
860 /**
861  * module_hid_driver() - Helper macro for registering a HID driver
862  * @__hid_driver: hid_driver struct
863  *
864  * Helper macro for HID drivers which do not do anything special in module
865  * init/exit. This eliminates a lot of boilerplate. Each module may only
866  * use this macro once, and calling it replaces module_init() and module_exit()
867  */
868 #define module_hid_driver(__hid_driver) \
869 	module_driver(__hid_driver, hid_register_driver, \
870 		      hid_unregister_driver)
871 
872 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
873 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
874 extern int hidinput_connect(struct hid_device *hid, unsigned int force);
875 extern void hidinput_disconnect(struct hid_device *);
876 
877 int hid_set_field(struct hid_field *, unsigned, __s32);
878 int hid_input_report(struct hid_device *, int type, u8 *, u32, int);
879 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
880 struct hid_field *hidinput_get_led_field(struct hid_device *hid);
881 unsigned int hidinput_count_leds(struct hid_device *hid);
882 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
883 void hid_output_report(struct hid_report *report, __u8 *data);
884 void __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype);
885 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags);
886 struct hid_device *hid_allocate_device(void);
887 struct hid_report *hid_register_report(struct hid_device *device,
888 				       unsigned int type, unsigned int id,
889 				       unsigned int application);
890 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
891 struct hid_report *hid_validate_values(struct hid_device *hid,
892 				       unsigned int type, unsigned int id,
893 				       unsigned int field_index,
894 				       unsigned int report_counts);
895 int hid_open_report(struct hid_device *device);
896 int hid_check_keys_pressed(struct hid_device *hid);
897 int hid_connect(struct hid_device *hid, unsigned int connect_mask);
898 void hid_disconnect(struct hid_device *hid);
899 bool hid_match_one_id(const struct hid_device *hdev,
900 		      const struct hid_device_id *id);
901 const struct hid_device_id *hid_match_id(const struct hid_device *hdev,
902 					 const struct hid_device_id *id);
903 const struct hid_device_id *hid_match_device(struct hid_device *hdev,
904 					     struct hid_driver *hdrv);
905 bool hid_compare_device_paths(struct hid_device *hdev_a,
906 			      struct hid_device *hdev_b, char separator);
907 s32 hid_snto32(__u32 value, unsigned n);
908 __u32 hid_field_extract(const struct hid_device *hid, __u8 *report,
909 		     unsigned offset, unsigned n);
910 
911 /**
912  * hid_device_io_start - enable HID input during probe, remove
913  *
914  * @hid - the device
915  *
916  * This should only be called during probe or remove and only be
917  * called by the thread calling probe or remove. It will allow
918  * incoming packets to be delivered to the driver.
919  */
hid_device_io_start(struct hid_device * hid)920 static inline void hid_device_io_start(struct hid_device *hid) {
921 	if (hid->io_started) {
922 		dev_warn(&hid->dev, "io already started\n");
923 		return;
924 	}
925 	hid->io_started = true;
926 	up(&hid->driver_input_lock);
927 }
928 
929 /**
930  * hid_device_io_stop - disable HID input during probe, remove
931  *
932  * @hid - the device
933  *
934  * Should only be called after hid_device_io_start. It will prevent
935  * incoming packets from going to the driver for the duration of
936  * probe, remove. If called during probe, packets will still go to the
937  * driver after probe is complete. This function should only be called
938  * by the thread calling probe or remove.
939  */
hid_device_io_stop(struct hid_device * hid)940 static inline void hid_device_io_stop(struct hid_device *hid) {
941 	if (!hid->io_started) {
942 		dev_warn(&hid->dev, "io already stopped\n");
943 		return;
944 	}
945 	hid->io_started = false;
946 	down(&hid->driver_input_lock);
947 }
948 
949 /**
950  * hid_map_usage - map usage input bits
951  *
952  * @hidinput: hidinput which we are interested in
953  * @usage: usage to fill in
954  * @bit: pointer to input->{}bit (out parameter)
955  * @max: maximal valid usage->code to consider later (out parameter)
956  * @type: input event type (EV_KEY, EV_REL, ...)
957  * @c: code which corresponds to this usage and type
958  */
hid_map_usage(struct hid_input * hidinput,struct hid_usage * usage,unsigned long ** bit,int * max,__u8 type,__u16 c)959 static inline void hid_map_usage(struct hid_input *hidinput,
960 		struct hid_usage *usage, unsigned long **bit, int *max,
961 		__u8 type, __u16 c)
962 {
963 	struct input_dev *input = hidinput->input;
964 
965 	usage->type = type;
966 	usage->code = c;
967 
968 	switch (type) {
969 	case EV_ABS:
970 		*bit = input->absbit;
971 		*max = ABS_MAX;
972 		break;
973 	case EV_REL:
974 		*bit = input->relbit;
975 		*max = REL_MAX;
976 		break;
977 	case EV_KEY:
978 		*bit = input->keybit;
979 		*max = KEY_MAX;
980 		break;
981 	case EV_LED:
982 		*bit = input->ledbit;
983 		*max = LED_MAX;
984 		break;
985 	}
986 }
987 
988 /**
989  * hid_map_usage_clear - map usage input bits and clear the input bit
990  *
991  * The same as hid_map_usage, except the @c bit is also cleared in supported
992  * bits (@bit).
993  */
hid_map_usage_clear(struct hid_input * hidinput,struct hid_usage * usage,unsigned long ** bit,int * max,__u8 type,__u16 c)994 static inline void hid_map_usage_clear(struct hid_input *hidinput,
995 		struct hid_usage *usage, unsigned long **bit, int *max,
996 		__u8 type, __u16 c)
997 {
998 	hid_map_usage(hidinput, usage, bit, max, type, c);
999 	clear_bit(c, *bit);
1000 }
1001 
1002 /**
1003  * hid_parse - parse HW reports
1004  *
1005  * @hdev: hid device
1006  *
1007  * Call this from probe after you set up the device (if needed). Your
1008  * report_fixup will be called (if non-NULL) after reading raw report from
1009  * device before passing it to hid layer for real parsing.
1010  */
hid_parse(struct hid_device * hdev)1011 static inline int __must_check hid_parse(struct hid_device *hdev)
1012 {
1013 	return hid_open_report(hdev);
1014 }
1015 
1016 int __must_check hid_hw_start(struct hid_device *hdev,
1017 			      unsigned int connect_mask);
1018 void hid_hw_stop(struct hid_device *hdev);
1019 int __must_check hid_hw_open(struct hid_device *hdev);
1020 void hid_hw_close(struct hid_device *hdev);
1021 
1022 /**
1023  * hid_hw_power - requests underlying HW to go into given power mode
1024  *
1025  * @hdev: hid device
1026  * @level: requested power level (one of %PM_HINT_* defines)
1027  *
1028  * This function requests underlying hardware to enter requested power
1029  * mode.
1030  */
1031 
hid_hw_power(struct hid_device * hdev,int level)1032 static inline int hid_hw_power(struct hid_device *hdev, int level)
1033 {
1034 	return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
1035 }
1036 
1037 
1038 /**
1039  * hid_hw_request - send report request to device
1040  *
1041  * @hdev: hid device
1042  * @report: report to send
1043  * @reqtype: hid request type
1044  */
hid_hw_request(struct hid_device * hdev,struct hid_report * report,int reqtype)1045 static inline void hid_hw_request(struct hid_device *hdev,
1046 				  struct hid_report *report, int reqtype)
1047 {
1048 	if (hdev->ll_driver->request)
1049 		return hdev->ll_driver->request(hdev, report, reqtype);
1050 
1051 	__hid_request(hdev, report, reqtype);
1052 }
1053 
1054 /**
1055  * hid_hw_raw_request - send report request to device
1056  *
1057  * @hdev: hid device
1058  * @reportnum: report ID
1059  * @buf: in/out data to transfer
1060  * @len: length of buf
1061  * @rtype: HID report type
1062  * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
1063  *
1064  * @return: count of data transfered, negative if error
1065  *
1066  * Same behavior as hid_hw_request, but with raw buffers instead.
1067  */
hid_hw_raw_request(struct hid_device * hdev,unsigned char reportnum,__u8 * buf,size_t len,unsigned char rtype,int reqtype)1068 static inline int hid_hw_raw_request(struct hid_device *hdev,
1069 				  unsigned char reportnum, __u8 *buf,
1070 				  size_t len, unsigned char rtype, int reqtype)
1071 {
1072 	if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1073 		return -EINVAL;
1074 
1075 	return hdev->ll_driver->raw_request(hdev, reportnum, buf, len,
1076 						    rtype, reqtype);
1077 }
1078 
1079 /**
1080  * hid_hw_output_report - send output report to device
1081  *
1082  * @hdev: hid device
1083  * @buf: raw data to transfer
1084  * @len: length of buf
1085  *
1086  * @return: count of data transfered, negative if error
1087  */
hid_hw_output_report(struct hid_device * hdev,__u8 * buf,size_t len)1088 static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf,
1089 					size_t len)
1090 {
1091 	if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1092 		return -EINVAL;
1093 
1094 	if (hdev->ll_driver->output_report)
1095 		return hdev->ll_driver->output_report(hdev, buf, len);
1096 
1097 	return -ENOSYS;
1098 }
1099 
1100 /**
1101  * hid_hw_idle - send idle request to device
1102  *
1103  * @hdev: hid device
1104  * @report: report to control
1105  * @idle: idle state
1106  * @reqtype: hid request type
1107  */
hid_hw_idle(struct hid_device * hdev,int report,int idle,int reqtype)1108 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
1109 		int reqtype)
1110 {
1111 	if (hdev->ll_driver->idle)
1112 		return hdev->ll_driver->idle(hdev, report, idle, reqtype);
1113 
1114 	return 0;
1115 }
1116 
1117 /**
1118  * hid_hw_wait - wait for buffered io to complete
1119  *
1120  * @hdev: hid device
1121  */
hid_hw_wait(struct hid_device * hdev)1122 static inline void hid_hw_wait(struct hid_device *hdev)
1123 {
1124 	if (hdev->ll_driver->wait)
1125 		hdev->ll_driver->wait(hdev);
1126 }
1127 
1128 /**
1129  * hid_report_len - calculate the report length
1130  *
1131  * @report: the report we want to know the length
1132  */
hid_report_len(struct hid_report * report)1133 static inline u32 hid_report_len(struct hid_report *report)
1134 {
1135 	/* equivalent to DIV_ROUND_UP(report->size, 8) + !!(report->id > 0) */
1136 	return ((report->size - 1) >> 3) + 1 + (report->id > 0);
1137 }
1138 
1139 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, u32 size,
1140 		int interrupt);
1141 
1142 /* HID quirks API */
1143 unsigned long hid_lookup_quirk(const struct hid_device *hdev);
1144 int hid_quirks_init(char **quirks_param, __u16 bus, int count);
1145 void hid_quirks_exit(__u16 bus);
1146 
1147 #ifdef CONFIG_HID_PID
1148 int hid_pidff_init(struct hid_device *hid);
1149 #else
1150 #define hid_pidff_init NULL
1151 #endif
1152 
1153 #define dbg_hid(format, arg...)						\
1154 do {									\
1155 	if (hid_debug)							\
1156 		printk(KERN_DEBUG "%s: " format, __FILE__, ##arg);	\
1157 } while (0)
1158 
1159 #define hid_printk(level, hid, fmt, arg...)		\
1160 	dev_printk(level, &(hid)->dev, fmt, ##arg)
1161 #define hid_emerg(hid, fmt, arg...)			\
1162 	dev_emerg(&(hid)->dev, fmt, ##arg)
1163 #define hid_crit(hid, fmt, arg...)			\
1164 	dev_crit(&(hid)->dev, fmt, ##arg)
1165 #define hid_alert(hid, fmt, arg...)			\
1166 	dev_alert(&(hid)->dev, fmt, ##arg)
1167 #define hid_err(hid, fmt, arg...)			\
1168 	dev_err(&(hid)->dev, fmt, ##arg)
1169 #define hid_notice(hid, fmt, arg...)			\
1170 	dev_notice(&(hid)->dev, fmt, ##arg)
1171 #define hid_warn(hid, fmt, arg...)			\
1172 	dev_warn(&(hid)->dev, fmt, ##arg)
1173 #define hid_info(hid, fmt, arg...)			\
1174 	dev_info(&(hid)->dev, fmt, ##arg)
1175 #define hid_dbg(hid, fmt, arg...)			\
1176 	dev_dbg(&(hid)->dev, fmt, ##arg)
1177 
1178 #endif
1179