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