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 #include <linux/android_kabi.h>
30
31 /*
32 * We parse each description item into this structure. Short items data
33 * values are expanded to 32-bit signed int, long items contain a pointer
34 * into the data area.
35 */
36
37 struct hid_item {
38 unsigned format;
39 __u8 size;
40 __u8 type;
41 __u8 tag;
42 union {
43 __u8 u8;
44 __s8 s8;
45 __u16 u16;
46 __s16 s16;
47 __u32 u32;
48 __s32 s32;
49 __u8 *longdata;
50 } data;
51 };
52
53 /*
54 * HID report item format
55 */
56
57 #define HID_ITEM_FORMAT_SHORT 0
58 #define HID_ITEM_FORMAT_LONG 1
59
60 /*
61 * Special tag indicating long items
62 */
63
64 #define HID_ITEM_TAG_LONG 15
65
66 /*
67 * HID report descriptor item type (prefix bit 2,3)
68 */
69
70 #define HID_ITEM_TYPE_MAIN 0
71 #define HID_ITEM_TYPE_GLOBAL 1
72 #define HID_ITEM_TYPE_LOCAL 2
73 #define HID_ITEM_TYPE_RESERVED 3
74
75 /*
76 * HID report descriptor main item tags
77 */
78
79 #define HID_MAIN_ITEM_TAG_INPUT 8
80 #define HID_MAIN_ITEM_TAG_OUTPUT 9
81 #define HID_MAIN_ITEM_TAG_FEATURE 11
82 #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10
83 #define HID_MAIN_ITEM_TAG_END_COLLECTION 12
84
85 /*
86 * HID report descriptor main item contents
87 */
88
89 #define HID_MAIN_ITEM_CONSTANT 0x001
90 #define HID_MAIN_ITEM_VARIABLE 0x002
91 #define HID_MAIN_ITEM_RELATIVE 0x004
92 #define HID_MAIN_ITEM_WRAP 0x008
93 #define HID_MAIN_ITEM_NONLINEAR 0x010
94 #define HID_MAIN_ITEM_NO_PREFERRED 0x020
95 #define HID_MAIN_ITEM_NULL_STATE 0x040
96 #define HID_MAIN_ITEM_VOLATILE 0x080
97 #define HID_MAIN_ITEM_BUFFERED_BYTE 0x100
98
99 /*
100 * HID report descriptor collection item types
101 */
102
103 #define HID_COLLECTION_PHYSICAL 0
104 #define HID_COLLECTION_APPLICATION 1
105 #define HID_COLLECTION_LOGICAL 2
106
107 /*
108 * HID report descriptor global item tags
109 */
110
111 #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0
112 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1
113 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2
114 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3
115 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4
116 #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5
117 #define HID_GLOBAL_ITEM_TAG_UNIT 6
118 #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7
119 #define HID_GLOBAL_ITEM_TAG_REPORT_ID 8
120 #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9
121 #define HID_GLOBAL_ITEM_TAG_PUSH 10
122 #define HID_GLOBAL_ITEM_TAG_POP 11
123
124 /*
125 * HID report descriptor local item tags
126 */
127
128 #define HID_LOCAL_ITEM_TAG_USAGE 0
129 #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1
130 #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2
131 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3
132 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4
133 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5
134 #define HID_LOCAL_ITEM_TAG_STRING_INDEX 7
135 #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8
136 #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9
137 #define HID_LOCAL_ITEM_TAG_DELIMITER 10
138
139 /*
140 * HID usage tables
141 */
142
143 #define HID_USAGE_PAGE 0xffff0000
144
145 #define HID_UP_UNDEFINED 0x00000000
146 #define HID_UP_GENDESK 0x00010000
147 #define HID_UP_SIMULATION 0x00020000
148 #define HID_UP_GENDEVCTRLS 0x00060000
149 #define HID_UP_KEYBOARD 0x00070000
150 #define HID_UP_LED 0x00080000
151 #define HID_UP_BUTTON 0x00090000
152 #define HID_UP_ORDINAL 0x000a0000
153 #define HID_UP_TELEPHONY 0x000b0000
154 #define HID_UP_CONSUMER 0x000c0000
155 #define HID_UP_DIGITIZER 0x000d0000
156 #define HID_UP_PID 0x000f0000
157 #define HID_UP_HPVENDOR 0xff7f0000
158 #define HID_UP_HPVENDOR2 0xff010000
159 #define HID_UP_MSVENDOR 0xff000000
160 #define HID_UP_CUSTOM 0x00ff0000
161 #define HID_UP_LOGIVENDOR 0xffbc0000
162 #define HID_UP_LOGIVENDOR2 0xff090000
163 #define HID_UP_LOGIVENDOR3 0xff430000
164 #define HID_UP_LNVENDOR 0xffa00000
165 #define HID_UP_SENSOR 0x00200000
166 #define HID_UP_ASUSVENDOR 0xff310000
167
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_VOLUMEUP 0x000c00e9
266 #define HID_CP_VOLUMEDOWN 0x000c00ea
267 #define HID_CP_PLAYBACKSPEED 0x000c00f1
268 #define HID_CP_PROXIMITY 0x000c0109
269 #define HID_CP_SPEAKERSYSTEM 0x000c0160
270 #define HID_CP_CHANNELLEFT 0x000c0161
271 #define HID_CP_CHANNELRIGHT 0x000c0162
272 #define HID_CP_CHANNELCENTER 0x000c0163
273 #define HID_CP_CHANNELFRONT 0x000c0164
274 #define HID_CP_CHANNELCENTERFRONT 0x000c0165
275 #define HID_CP_CHANNELSIDE 0x000c0166
276 #define HID_CP_CHANNELSURROUND 0x000c0167
277 #define HID_CP_CHANNELLOWFREQUENCYENHANCEMENT 0x000c0168
278 #define HID_CP_CHANNELTOP 0x000c0169
279 #define HID_CP_CHANNELUNKNOWN 0x000c016a
280 #define HID_CP_APPLICATIONLAUNCHBUTTONS 0x000c0180
281 #define HID_CP_GENERICGUIAPPLICATIONCONTROLS 0x000c0200
282
283 #define HID_DG_DEVICECONFIG 0x000d000e
284 #define HID_DG_DEVICESETTINGS 0x000d0023
285 #define HID_DG_AZIMUTH 0x000d003f
286 #define HID_DG_CONFIDENCE 0x000d0047
287 #define HID_DG_WIDTH 0x000d0048
288 #define HID_DG_HEIGHT 0x000d0049
289 #define HID_DG_CONTACTID 0x000d0051
290 #define HID_DG_INPUTMODE 0x000d0052
291 #define HID_DG_DEVICEINDEX 0x000d0053
292 #define HID_DG_CONTACTCOUNT 0x000d0054
293 #define HID_DG_CONTACTMAX 0x000d0055
294 #define HID_DG_SCANTIME 0x000d0056
295 #define HID_DG_SURFACESWITCH 0x000d0057
296 #define HID_DG_BUTTONSWITCH 0x000d0058
297 #define HID_DG_BUTTONTYPE 0x000d0059
298 #define HID_DG_BARRELSWITCH2 0x000d005a
299 #define HID_DG_TOOLSERIALNUMBER 0x000d005b
300 #define HID_DG_LATENCYMODE 0x000d0060
301
302 #define HID_VD_ASUS_CUSTOM_MEDIA_KEYS 0xff310076
303 /*
304 * HID report types --- Ouch! HID spec says 1 2 3!
305 */
306
307 #define HID_INPUT_REPORT 0
308 #define HID_OUTPUT_REPORT 1
309 #define HID_FEATURE_REPORT 2
310
311 #define HID_REPORT_TYPES 3
312
313 /*
314 * HID connect requests
315 */
316
317 #define HID_CONNECT_HIDINPUT BIT(0)
318 #define HID_CONNECT_HIDINPUT_FORCE BIT(1)
319 #define HID_CONNECT_HIDRAW BIT(2)
320 #define HID_CONNECT_HIDDEV BIT(3)
321 #define HID_CONNECT_HIDDEV_FORCE BIT(4)
322 #define HID_CONNECT_FF BIT(5)
323 #define HID_CONNECT_DRIVER BIT(6)
324 #define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
325 HID_CONNECT_HIDDEV|HID_CONNECT_FF)
326
327 /*
328 * HID device quirks.
329 */
330
331 /*
332 * Increase this if you need to configure more HID quirks at module load time
333 */
334 #define MAX_USBHID_BOOT_QUIRKS 4
335
336 #define HID_QUIRK_INVERT BIT(0)
337 #define HID_QUIRK_NOTOUCH BIT(1)
338 #define HID_QUIRK_IGNORE BIT(2)
339 #define HID_QUIRK_NOGET BIT(3)
340 #define HID_QUIRK_HIDDEV_FORCE BIT(4)
341 #define HID_QUIRK_BADPAD BIT(5)
342 #define HID_QUIRK_MULTI_INPUT BIT(6)
343 #define HID_QUIRK_HIDINPUT_FORCE BIT(7)
344 /* BIT(8) reserved for backward compatibility, was HID_QUIRK_NO_EMPTY_INPUT */
345 /* BIT(9) reserved for backward compatibility, was NO_INIT_INPUT_REPORTS */
346 #define HID_QUIRK_ALWAYS_POLL BIT(10)
347 #define HID_QUIRK_INPUT_PER_APP BIT(11)
348 #define HID_QUIRK_X_INVERT BIT(12)
349 #define HID_QUIRK_Y_INVERT BIT(13)
350 #define HID_QUIRK_SKIP_OUTPUT_REPORTS BIT(16)
351 #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID BIT(17)
352 #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP BIT(18)
353 #define HID_QUIRK_HAVE_SPECIAL_DRIVER BIT(19)
354 #define HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE BIT(20)
355 #define HID_QUIRK_FULLSPEED_INTERVAL BIT(28)
356 #define HID_QUIRK_NO_INIT_REPORTS BIT(29)
357 #define HID_QUIRK_NO_IGNORE BIT(30)
358 #define HID_QUIRK_NO_INPUT_SYNC BIT(31)
359
360 /*
361 * HID device groups
362 *
363 * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h
364 * and has a value of 0x0000
365 */
366 #define HID_GROUP_GENERIC 0x0001
367 #define HID_GROUP_MULTITOUCH 0x0002
368 #define HID_GROUP_SENSOR_HUB 0x0003
369 #define HID_GROUP_MULTITOUCH_WIN_8 0x0004
370
371 /*
372 * Vendor specific HID device groups
373 */
374 #define HID_GROUP_RMI 0x0100
375 #define HID_GROUP_WACOM 0x0101
376 #define HID_GROUP_LOGITECH_DJ_DEVICE 0x0102
377 #define HID_GROUP_STEAM 0x0103
378 #define HID_GROUP_LOGITECH_27MHZ_DEVICE 0x0104
379
380 /*
381 * HID protocol status
382 */
383 #define HID_REPORT_PROTOCOL 1
384 #define HID_BOOT_PROTOCOL 0
385
386 /*
387 * This is the global environment of the parser. This information is
388 * persistent for main-items. The global environment can be saved and
389 * restored with PUSH/POP statements.
390 */
391
392 struct hid_global {
393 unsigned usage_page;
394 __s32 logical_minimum;
395 __s32 logical_maximum;
396 __s32 physical_minimum;
397 __s32 physical_maximum;
398 __s32 unit_exponent;
399 unsigned unit;
400 unsigned report_id;
401 unsigned report_size;
402 unsigned report_count;
403 };
404
405 /*
406 * This is the local environment. It is persistent up the next main-item.
407 */
408
409 #define HID_MAX_USAGES 12288
410 #define HID_DEFAULT_NUM_COLLECTIONS 16
411
412 struct hid_local {
413 unsigned usage[HID_MAX_USAGES]; /* usage array */
414 u8 usage_size[HID_MAX_USAGES]; /* usage size array */
415 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
416 unsigned usage_index;
417 unsigned usage_minimum;
418 unsigned delimiter_depth;
419 unsigned delimiter_branch;
420 };
421
422 /*
423 * This is the collection stack. We climb up the stack to determine
424 * application and function of each field.
425 */
426
427 struct hid_collection {
428 int parent_idx; /* device->collection */
429 unsigned type;
430 unsigned usage;
431 unsigned level;
432 };
433
434 struct hid_usage {
435 unsigned hid; /* hid usage code */
436 unsigned collection_index; /* index into collection array */
437 unsigned usage_index; /* index into usage array */
438 __s8 resolution_multiplier;/* Effective Resolution Multiplier
439 (HUT v1.12, 4.3.1), default: 1 */
440 /* hidinput data */
441 __s8 wheel_factor; /* 120/resolution_multiplier */
442 __u16 code; /* input driver code */
443 __u8 type; /* input driver type */
444 __s8 hat_min; /* hat switch fun */
445 __s8 hat_max; /* ditto */
446 __s8 hat_dir; /* ditto */
447 __s16 wheel_accumulated; /* hi-res wheel */
448 };
449
450 struct hid_input;
451
452 struct hid_field {
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;
468 __s32 unit_exponent;
469 unsigned unit;
470 struct hid_report *report; /* associated report */
471 unsigned index; /* index into report->field[] */
472 /* hidinput data */
473 struct hid_input *hidinput; /* associated input structure */
474 __u16 dpad; /* dpad input code */
475 };
476
477 #define HID_MAX_FIELDS 256
478
479 struct hid_report {
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 */
489 };
490
491 #define HID_MAX_IDS 256
492
493 struct hid_report_enum {
494 unsigned numbered;
495 struct list_head report_list;
496 struct hid_report *report_id_hash[HID_MAX_IDS];
497 };
498
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
503
504 struct hid_control_fifo {
505 unsigned char dir;
506 struct hid_report *report;
507 char *raw_report;
508 };
509
510 struct hid_output_fifo {
511 struct hid_report *report;
512 char *raw_report;
513 };
514
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)
519
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)
524
525 struct hid_input {
526 struct list_head list;
527 struct hid_report *report;
528 struct input_dev *input;
529 const char *name;
530 bool registered;
531 struct list_head reports; /* the list of reports */
532 unsigned int application; /* application usage for this input */
533 };
534
535 enum hid_type {
536 HID_TYPE_OTHER = 0,
537 HID_TYPE_USBMOUSE,
538 HID_TYPE_USBNONE
539 };
540
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 */
545 };
546
547 struct hid_driver;
548 struct hid_ll_driver;
549
550 struct hid_device { /* device report descriptor */
551 __u8 *dev_rdesc;
552 unsigned dev_rsize;
553 __u8 *rdesc;
554 unsigned rsize;
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 */
568
569 struct semaphore driver_input_lock; /* protects the current driver */
570 struct device dev; /* device */
571 struct hid_driver *driver;
572
573 struct hid_ll_driver *ll_driver;
574 struct mutex ll_open_lock;
575 unsigned int ll_open_count;
576
577 #ifdef CONFIG_HID_BATTERY_STRENGTH
578 /*
579 * Power supply information for HID devices which report
580 * battery strength. power_supply was successfully registered if
581 * battery is non-NULL.
582 */
583 struct power_supply *battery;
584 __s32 battery_capacity;
585 __s32 battery_min;
586 __s32 battery_max;
587 __s32 battery_report_type;
588 __s32 battery_report_id;
589 enum hid_battery_status battery_status;
590 bool battery_avoid_query;
591 #endif
592
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 */
597
598 struct list_head inputs; /* The list of inputs */
599 void *hiddev; /* The hiddev structure */
600 void *hidraw;
601
602 char name[128]; /* Device name */
603 char phys[64]; /* Device physical location */
604 char uniq[64]; /* Device unique identifier (serial #) */
605
606 void *driver_data;
607
608 /* temporary hid_ff handling (until moved to the drivers) */
609 int (*ff_init)(struct hid_device *);
610
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 *);
617
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;
626
627 ANDROID_KABI_RESERVE(1);
628 ANDROID_KABI_RESERVE(2);
629 };
630
631 #define to_hid_device(pdev) \
632 container_of(pdev, struct hid_device, dev)
633
hid_get_drvdata(struct hid_device * hdev)634 static inline void *hid_get_drvdata(struct hid_device *hdev)
635 {
636 return dev_get_drvdata(&hdev->dev);
637 }
638
hid_set_drvdata(struct hid_device * hdev,void * data)639 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
640 {
641 dev_set_drvdata(&hdev->dev, data);
642 }
643
644 #define HID_GLOBAL_STACK_SIZE 4
645 #define HID_COLLECTION_STACK_SIZE 4
646
647 #define HID_SCAN_FLAG_MT_WIN_8 BIT(0)
648 #define HID_SCAN_FLAG_VENDOR_SPECIFIC BIT(1)
649 #define HID_SCAN_FLAG_GD_POINTER BIT(2)
650
651 struct hid_parser {
652 struct hid_global global;
653 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
654 unsigned int global_stack_ptr;
655 struct hid_local local;
656 unsigned int *collection_stack;
657 unsigned int collection_stack_ptr;
658 unsigned int collection_stack_size;
659 struct hid_device *device;
660 unsigned int scan_flags;
661 };
662
663 struct hid_class_descriptor {
664 __u8 bDescriptorType;
665 __le16 wDescriptorLength;
666 } __attribute__ ((packed));
667
668 struct hid_descriptor {
669 __u8 bLength;
670 __u8 bDescriptorType;
671 __le16 bcdHID;
672 __u8 bCountryCode;
673 __u8 bNumDescriptors;
674
675 struct hid_class_descriptor desc[1];
676 } __attribute__ ((packed));
677
678 #define HID_DEVICE(b, g, ven, prod) \
679 .bus = (b), .group = (g), .vendor = (ven), .product = (prod)
680 #define HID_USB_DEVICE(ven, prod) \
681 .bus = BUS_USB, .vendor = (ven), .product = (prod)
682 #define HID_BLUETOOTH_DEVICE(ven, prod) \
683 .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod)
684 #define HID_I2C_DEVICE(ven, prod) \
685 .bus = BUS_I2C, .vendor = (ven), .product = (prod)
686 #define HID_SPI_DEVICE(ven, prod) \
687 .bus = BUS_SPI, .vendor = (ven), .product = (prod)
688
689 #define HID_REPORT_ID(rep) \
690 .report_type = (rep)
691 #define HID_USAGE_ID(uhid, utype, ucode) \
692 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
693 /* we don't want to catch types and codes equal to 0 */
694 #define HID_TERMINATOR (HID_ANY_ID - 1)
695
696 struct hid_report_id {
697 __u32 report_type;
698 };
699 struct hid_usage_id {
700 __u32 usage_hid;
701 __u32 usage_type;
702 __u32 usage_code;
703 };
704
705 /**
706 * struct hid_driver
707 * @name: driver name (e.g. "Footech_bar-wheel")
708 * @id_table: which devices is this driver for (must be non-NULL for probe
709 * to be called)
710 * @dyn_list: list of dynamically added device ids
711 * @dyn_lock: lock protecting @dyn_list
712 * @match: check if the given device is handled by this driver
713 * @probe: new device inserted
714 * @remove: device removed (NULL if not a hot-plug capable driver)
715 * @report_table: on which reports to call raw_event (NULL means all)
716 * @raw_event: if report in report_table, this hook is called (NULL means nop)
717 * @usage_table: on which events to call event (NULL means all)
718 * @event: if usage in usage_table, this hook is called (NULL means nop)
719 * @report: this hook is called after parsing a report (NULL means nop)
720 * @report_fixup: called before report descriptor parsing (NULL means nop)
721 * @input_mapping: invoked on input registering before mapping an usage
722 * @input_mapped: invoked on input registering after mapping an usage
723 * @input_configured: invoked just before the device is registered
724 * @feature_mapping: invoked on feature registering
725 * @suspend: invoked on suspend (NULL means nop)
726 * @resume: invoked on resume if device was not reset (NULL means nop)
727 * @reset_resume: invoked on resume if device was reset (NULL means nop)
728 *
729 * probe should return -errno on error, or 0 on success. During probe,
730 * input will not be passed to raw_event unless hid_device_io_start is
731 * called.
732 *
733 * raw_event and event should return negative on error, any other value will
734 * pass the event on to .event() typically return 0 for success.
735 *
736 * input_mapping shall return a negative value to completely ignore this usage
737 * (e.g. doubled or invalid usage), zero to continue with parsing of this
738 * usage by generic code (no special handling needed) or positive to skip
739 * generic parsing (needed special handling which was done in the hook already)
740 * input_mapped shall return negative to inform the layer that this usage
741 * should not be considered for further processing or zero to notify that
742 * no processing was performed and should be done in a generic manner
743 * Both these functions may be NULL which means the same behavior as returning
744 * zero from them.
745 */
746 struct hid_driver {
747 char *name;
748 const struct hid_device_id *id_table;
749
750 struct list_head dyn_list;
751 spinlock_t dyn_lock;
752
753 bool (*match)(struct hid_device *dev, bool ignore_special_driver);
754 int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
755 void (*remove)(struct hid_device *dev);
756
757 const struct hid_report_id *report_table;
758 int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
759 u8 *data, int size);
760 const struct hid_usage_id *usage_table;
761 int (*event)(struct hid_device *hdev, struct hid_field *field,
762 struct hid_usage *usage, __s32 value);
763 void (*report)(struct hid_device *hdev, struct hid_report *report);
764
765 __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
766 unsigned int *size);
767
768 int (*input_mapping)(struct hid_device *hdev,
769 struct hid_input *hidinput, struct hid_field *field,
770 struct hid_usage *usage, unsigned long **bit, int *max);
771 int (*input_mapped)(struct hid_device *hdev,
772 struct hid_input *hidinput, struct hid_field *field,
773 struct hid_usage *usage, unsigned long **bit, int *max);
774 int (*input_configured)(struct hid_device *hdev,
775 struct hid_input *hidinput);
776 void (*feature_mapping)(struct hid_device *hdev,
777 struct hid_field *field,
778 struct hid_usage *usage);
779 #ifdef CONFIG_PM
780 int (*suspend)(struct hid_device *hdev, pm_message_t message);
781 int (*resume)(struct hid_device *hdev);
782 int (*reset_resume)(struct hid_device *hdev);
783 #endif
784 /* private: */
785 struct device_driver driver;
786 };
787
788 #define to_hid_driver(pdrv) \
789 container_of(pdrv, struct hid_driver, driver)
790
791 /**
792 * hid_ll_driver - low level driver callbacks
793 * @start: called on probe to start the device
794 * @stop: called on remove
795 * @open: called by input layer on open
796 * @close: called by input layer on close
797 * @power: request underlying hardware to enter requested power mode
798 * @parse: this method is called only once to parse the device data,
799 * shouldn't allocate anything to not leak memory
800 * @request: send report request to device (e.g. feature report)
801 * @wait: wait for buffered io to complete (send/recv reports)
802 * @raw_request: send raw report request to device (e.g. feature report)
803 * @output_report: send output report to device
804 * @idle: send idle request to device
805 */
806 struct hid_ll_driver {
807 int (*start)(struct hid_device *hdev);
808 void (*stop)(struct hid_device *hdev);
809
810 int (*open)(struct hid_device *hdev);
811 void (*close)(struct hid_device *hdev);
812
813 int (*power)(struct hid_device *hdev, int level);
814
815 int (*parse)(struct hid_device *hdev);
816
817 void (*request)(struct hid_device *hdev,
818 struct hid_report *report, int reqtype);
819
820 int (*wait)(struct hid_device *hdev);
821
822 int (*raw_request) (struct hid_device *hdev, unsigned char reportnum,
823 __u8 *buf, size_t len, unsigned char rtype,
824 int reqtype);
825
826 int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len);
827
828 int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype);
829 };
830
831 extern struct hid_ll_driver i2c_hid_ll_driver;
832 extern struct hid_ll_driver hidp_hid_driver;
833 extern struct hid_ll_driver uhid_hid_driver;
834 extern struct hid_ll_driver usb_hid_driver;
835
hid_is_using_ll_driver(struct hid_device * hdev,struct hid_ll_driver * driver)836 static inline bool hid_is_using_ll_driver(struct hid_device *hdev,
837 struct hid_ll_driver *driver)
838 {
839 return hdev->ll_driver == driver;
840 }
841
hid_is_usb(struct hid_device * hdev)842 static inline bool hid_is_usb(struct hid_device *hdev)
843 {
844 return hid_is_using_ll_driver(hdev, &usb_hid_driver);
845 }
846
847 #define PM_HINT_FULLON 1<<5
848 #define PM_HINT_NORMAL 1<<1
849
850 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
851 /* We ignore a few input applications that are not widely used */
852 #define IS_INPUT_APPLICATION(a) \
853 (((a >= HID_UP_GENDESK) && (a <= HID_GD_MULTIAXIS)) \
854 || ((a >= HID_DG_PEN) && (a <= HID_DG_WHITEBOARD)) \
855 || (a == HID_GD_SYSTEM_CONTROL) || (a == HID_CP_CONSUMER_CONTROL) \
856 || (a == HID_GD_WIRELESS_RADIO_CTLS))
857
858 /* HID core API */
859
860 extern int hid_debug;
861
862 extern bool hid_ignore(struct hid_device *);
863 extern int hid_add_device(struct hid_device *);
864 extern void hid_destroy_device(struct hid_device *);
865
866 extern struct bus_type hid_bus_type;
867
868 extern int __must_check __hid_register_driver(struct hid_driver *,
869 struct module *, const char *mod_name);
870
871 /* use a define to avoid include chaining to get THIS_MODULE & friends */
872 #define hid_register_driver(driver) \
873 __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
874
875 extern void hid_unregister_driver(struct hid_driver *);
876
877 /**
878 * module_hid_driver() - Helper macro for registering a HID driver
879 * @__hid_driver: hid_driver struct
880 *
881 * Helper macro for HID drivers which do not do anything special in module
882 * init/exit. This eliminates a lot of boilerplate. Each module may only
883 * use this macro once, and calling it replaces module_init() and module_exit()
884 */
885 #define module_hid_driver(__hid_driver) \
886 module_driver(__hid_driver, hid_register_driver, \
887 hid_unregister_driver)
888
889 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
890 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
891 extern int hidinput_connect(struct hid_device *hid, unsigned int force);
892 extern void hidinput_disconnect(struct hid_device *);
893
894 int hid_set_field(struct hid_field *, unsigned, __s32);
895 int hid_input_report(struct hid_device *, int type, u8 *, u32, int);
896 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
897 struct hid_field *hidinput_get_led_field(struct hid_device *hid);
898 unsigned int hidinput_count_leds(struct hid_device *hid);
899 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
900 void hid_output_report(struct hid_report *report, __u8 *data);
901 int __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype);
902 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags);
903 struct hid_device *hid_allocate_device(void);
904 struct hid_report *hid_register_report(struct hid_device *device,
905 unsigned int type, unsigned int id,
906 unsigned int application);
907 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
908 struct hid_report *hid_validate_values(struct hid_device *hid,
909 unsigned int type, unsigned int id,
910 unsigned int field_index,
911 unsigned int report_counts);
912
913 void hid_setup_resolution_multiplier(struct hid_device *hid);
914 int hid_open_report(struct hid_device *device);
915 int hid_check_keys_pressed(struct hid_device *hid);
916 int hid_connect(struct hid_device *hid, unsigned int connect_mask);
917 void hid_disconnect(struct hid_device *hid);
918 bool hid_match_one_id(const struct hid_device *hdev,
919 const struct hid_device_id *id);
920 const struct hid_device_id *hid_match_id(const struct hid_device *hdev,
921 const struct hid_device_id *id);
922 const struct hid_device_id *hid_match_device(struct hid_device *hdev,
923 struct hid_driver *hdrv);
924 bool hid_compare_device_paths(struct hid_device *hdev_a,
925 struct hid_device *hdev_b, char separator);
926 s32 hid_snto32(__u32 value, unsigned n);
927 __u32 hid_field_extract(const struct hid_device *hid, __u8 *report,
928 unsigned offset, unsigned n);
929
930 /**
931 * hid_device_io_start - enable HID input during probe, remove
932 *
933 * @hid - the device
934 *
935 * This should only be called during probe or remove and only be
936 * called by the thread calling probe or remove. It will allow
937 * incoming packets to be delivered to the driver.
938 */
hid_device_io_start(struct hid_device * hid)939 static inline void hid_device_io_start(struct hid_device *hid) {
940 if (hid->io_started) {
941 dev_warn(&hid->dev, "io already started\n");
942 return;
943 }
944 hid->io_started = true;
945 up(&hid->driver_input_lock);
946 }
947
948 /**
949 * hid_device_io_stop - disable HID input during probe, remove
950 *
951 * @hid - the device
952 *
953 * Should only be called after hid_device_io_start. It will prevent
954 * incoming packets from going to the driver for the duration of
955 * probe, remove. If called during probe, packets will still go to the
956 * driver after probe is complete. This function should only be called
957 * by the thread calling probe or remove.
958 */
hid_device_io_stop(struct hid_device * hid)959 static inline void hid_device_io_stop(struct hid_device *hid) {
960 if (!hid->io_started) {
961 dev_warn(&hid->dev, "io already stopped\n");
962 return;
963 }
964 hid->io_started = false;
965 down(&hid->driver_input_lock);
966 }
967
968 /**
969 * hid_map_usage - map usage input bits
970 *
971 * @hidinput: hidinput which we are interested in
972 * @usage: usage to fill in
973 * @bit: pointer to input->{}bit (out parameter)
974 * @max: maximal valid usage->code to consider later (out parameter)
975 * @type: input event type (EV_KEY, EV_REL, ...)
976 * @c: code which corresponds to this usage and type
977 *
978 * The value pointed to by @bit will be set to NULL if either @type is
979 * an unhandled event type, or if @c is out of range for @type. This
980 * can be used as an error condition.
981 */
hid_map_usage(struct hid_input * hidinput,struct hid_usage * usage,unsigned long ** bit,int * max,__u8 type,unsigned int c)982 static inline void hid_map_usage(struct hid_input *hidinput,
983 struct hid_usage *usage, unsigned long **bit, int *max,
984 __u8 type, unsigned int c)
985 {
986 struct input_dev *input = hidinput->input;
987 unsigned long *bmap = NULL;
988 unsigned int limit = 0;
989
990 switch (type) {
991 case EV_ABS:
992 bmap = input->absbit;
993 limit = ABS_MAX;
994 break;
995 case EV_REL:
996 bmap = input->relbit;
997 limit = REL_MAX;
998 break;
999 case EV_KEY:
1000 bmap = input->keybit;
1001 limit = KEY_MAX;
1002 break;
1003 case EV_LED:
1004 bmap = input->ledbit;
1005 limit = LED_MAX;
1006 break;
1007 }
1008
1009 if (unlikely(c > limit || !bmap)) {
1010 pr_warn_ratelimited("%s: Invalid code %d type %d\n",
1011 input->name, c, type);
1012 *bit = NULL;
1013 return;
1014 }
1015
1016 usage->type = type;
1017 usage->code = c;
1018 *max = limit;
1019 *bit = bmap;
1020 }
1021
1022 /**
1023 * hid_map_usage_clear - map usage input bits and clear the input bit
1024 *
1025 * The same as hid_map_usage, except the @c bit is also cleared in supported
1026 * bits (@bit).
1027 */
hid_map_usage_clear(struct hid_input * hidinput,struct hid_usage * usage,unsigned long ** bit,int * max,__u8 type,__u16 c)1028 static inline void hid_map_usage_clear(struct hid_input *hidinput,
1029 struct hid_usage *usage, unsigned long **bit, int *max,
1030 __u8 type, __u16 c)
1031 {
1032 hid_map_usage(hidinput, usage, bit, max, type, c);
1033 if (*bit)
1034 clear_bit(usage->code, *bit);
1035 }
1036
1037 /**
1038 * hid_parse - parse HW reports
1039 *
1040 * @hdev: hid device
1041 *
1042 * Call this from probe after you set up the device (if needed). Your
1043 * report_fixup will be called (if non-NULL) after reading raw report from
1044 * device before passing it to hid layer for real parsing.
1045 */
hid_parse(struct hid_device * hdev)1046 static inline int __must_check hid_parse(struct hid_device *hdev)
1047 {
1048 return hid_open_report(hdev);
1049 }
1050
1051 int __must_check hid_hw_start(struct hid_device *hdev,
1052 unsigned int connect_mask);
1053 void hid_hw_stop(struct hid_device *hdev);
1054 int __must_check hid_hw_open(struct hid_device *hdev);
1055 void hid_hw_close(struct hid_device *hdev);
1056
1057 /**
1058 * hid_hw_power - requests underlying HW to go into given power mode
1059 *
1060 * @hdev: hid device
1061 * @level: requested power level (one of %PM_HINT_* defines)
1062 *
1063 * This function requests underlying hardware to enter requested power
1064 * mode.
1065 */
1066
hid_hw_power(struct hid_device * hdev,int level)1067 static inline int hid_hw_power(struct hid_device *hdev, int level)
1068 {
1069 return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
1070 }
1071
1072
1073 /**
1074 * hid_hw_request - send report request to device
1075 *
1076 * @hdev: hid device
1077 * @report: report to send
1078 * @reqtype: hid request type
1079 */
hid_hw_request(struct hid_device * hdev,struct hid_report * report,int reqtype)1080 static inline void hid_hw_request(struct hid_device *hdev,
1081 struct hid_report *report, int reqtype)
1082 {
1083 if (hdev->ll_driver->request)
1084 return hdev->ll_driver->request(hdev, report, reqtype);
1085
1086 __hid_request(hdev, report, reqtype);
1087 }
1088
1089 /**
1090 * hid_hw_raw_request - send report request to device
1091 *
1092 * @hdev: hid device
1093 * @reportnum: report ID
1094 * @buf: in/out data to transfer
1095 * @len: length of buf
1096 * @rtype: HID report type
1097 * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
1098 *
1099 * @return: count of data transfered, negative if error
1100 *
1101 * Same behavior as hid_hw_request, but with raw buffers instead.
1102 */
hid_hw_raw_request(struct hid_device * hdev,unsigned char reportnum,__u8 * buf,size_t len,unsigned char rtype,int reqtype)1103 static inline int hid_hw_raw_request(struct hid_device *hdev,
1104 unsigned char reportnum, __u8 *buf,
1105 size_t len, unsigned char rtype, int reqtype)
1106 {
1107 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1108 return -EINVAL;
1109
1110 return hdev->ll_driver->raw_request(hdev, reportnum, buf, len,
1111 rtype, reqtype);
1112 }
1113
1114 /**
1115 * hid_hw_output_report - send output report to device
1116 *
1117 * @hdev: hid device
1118 * @buf: raw data to transfer
1119 * @len: length of buf
1120 *
1121 * @return: count of data transfered, negative if error
1122 */
hid_hw_output_report(struct hid_device * hdev,__u8 * buf,size_t len)1123 static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf,
1124 size_t len)
1125 {
1126 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1127 return -EINVAL;
1128
1129 if (hdev->ll_driver->output_report)
1130 return hdev->ll_driver->output_report(hdev, buf, len);
1131
1132 return -ENOSYS;
1133 }
1134
1135 /**
1136 * hid_hw_idle - send idle request to device
1137 *
1138 * @hdev: hid device
1139 * @report: report to control
1140 * @idle: idle state
1141 * @reqtype: hid request type
1142 */
hid_hw_idle(struct hid_device * hdev,int report,int idle,int reqtype)1143 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
1144 int reqtype)
1145 {
1146 if (hdev->ll_driver->idle)
1147 return hdev->ll_driver->idle(hdev, report, idle, reqtype);
1148
1149 return 0;
1150 }
1151
1152 /**
1153 * hid_hw_wait - wait for buffered io to complete
1154 *
1155 * @hdev: hid device
1156 */
hid_hw_wait(struct hid_device * hdev)1157 static inline void hid_hw_wait(struct hid_device *hdev)
1158 {
1159 if (hdev->ll_driver->wait)
1160 hdev->ll_driver->wait(hdev);
1161 }
1162
1163 /**
1164 * hid_report_len - calculate the report length
1165 *
1166 * @report: the report we want to know the length
1167 */
hid_report_len(struct hid_report * report)1168 static inline u32 hid_report_len(struct hid_report *report)
1169 {
1170 return DIV_ROUND_UP(report->size, 8) + (report->id > 0);
1171 }
1172
1173 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, u32 size,
1174 int interrupt);
1175
1176 /* HID quirks API */
1177 unsigned long hid_lookup_quirk(const struct hid_device *hdev);
1178 int hid_quirks_init(char **quirks_param, __u16 bus, int count);
1179 void hid_quirks_exit(__u16 bus);
1180
1181 #ifdef CONFIG_HID_PID
1182 int hid_pidff_init(struct hid_device *hid);
1183 #else
1184 #define hid_pidff_init NULL
1185 #endif
1186
1187 #define dbg_hid(fmt, ...) \
1188 do { \
1189 if (hid_debug) \
1190 printk(KERN_DEBUG "%s: " fmt, __FILE__, ##__VA_ARGS__); \
1191 } while (0)
1192
1193 #define hid_err(hid, fmt, ...) \
1194 dev_err(&(hid)->dev, fmt, ##__VA_ARGS__)
1195 #define hid_notice(hid, fmt, ...) \
1196 dev_notice(&(hid)->dev, fmt, ##__VA_ARGS__)
1197 #define hid_warn(hid, fmt, ...) \
1198 dev_warn(&(hid)->dev, fmt, ##__VA_ARGS__)
1199 #define hid_info(hid, fmt, ...) \
1200 dev_info(&(hid)->dev, fmt, ##__VA_ARGS__)
1201 #define hid_dbg(hid, fmt, ...) \
1202 dev_dbg(&(hid)->dev, fmt, ##__VA_ARGS__)
1203
1204 #define hid_err_once(hid, fmt, ...) \
1205 dev_err_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1206 #define hid_notice_once(hid, fmt, ...) \
1207 dev_notice_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1208 #define hid_warn_once(hid, fmt, ...) \
1209 dev_warn_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1210 #define hid_info_once(hid, fmt, ...) \
1211 dev_info_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1212 #define hid_dbg_once(hid, fmt, ...) \
1213 dev_dbg_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1214
1215 #endif
1216