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/hid_bpf.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 const __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_TRANSDUCER_INDEX 0x000d0038
247 #define HID_DG_TABLETFUNCTIONKEY 0x000d0039
248 #define HID_DG_PROGRAMCHANGEKEY 0x000d003a
249 #define HID_DG_BATTERYSTRENGTH 0x000d003b
250 #define HID_DG_INVERT 0x000d003c
251 #define HID_DG_TILT_X 0x000d003d
252 #define HID_DG_TILT_Y 0x000d003e
253 #define HID_DG_TWIST 0x000d0041
254 #define HID_DG_TIPSWITCH 0x000d0042
255 #define HID_DG_TIPSWITCH2 0x000d0043
256 #define HID_DG_BARRELSWITCH 0x000d0044
257 #define HID_DG_ERASER 0x000d0045
258 #define HID_DG_TABLETPICK 0x000d0046
259 #define HID_DG_PEN_COLOR 0x000d005c
260 #define HID_DG_PEN_LINE_WIDTH 0x000d005e
261 #define HID_DG_PEN_LINE_STYLE 0x000d0070
262 #define HID_DG_PEN_LINE_STYLE_INK 0x000d0072
263 #define HID_DG_PEN_LINE_STYLE_PENCIL 0x000d0073
264 #define HID_DG_PEN_LINE_STYLE_HIGHLIGHTER 0x000d0074
265 #define HID_DG_PEN_LINE_STYLE_CHISEL_MARKER 0x000d0075
266 #define HID_DG_PEN_LINE_STYLE_BRUSH 0x000d0076
267 #define HID_DG_PEN_LINE_STYLE_NO_PREFERENCE 0x000d0077
268
269 #define HID_CP_CONSUMERCONTROL 0x000c0001
270 #define HID_CP_NUMERICKEYPAD 0x000c0002
271 #define HID_CP_PROGRAMMABLEBUTTONS 0x000c0003
272 #define HID_CP_MICROPHONE 0x000c0004
273 #define HID_CP_HEADPHONE 0x000c0005
274 #define HID_CP_GRAPHICEQUALIZER 0x000c0006
275 #define HID_CP_FUNCTIONBUTTONS 0x000c0036
276 #define HID_CP_SELECTION 0x000c0080
277 #define HID_CP_MEDIASELECTION 0x000c0087
278 #define HID_CP_SELECTDISC 0x000c00ba
279 #define HID_CP_VOLUMEUP 0x000c00e9
280 #define HID_CP_VOLUMEDOWN 0x000c00ea
281 #define HID_CP_PLAYBACKSPEED 0x000c00f1
282 #define HID_CP_PROXIMITY 0x000c0109
283 #define HID_CP_SPEAKERSYSTEM 0x000c0160
284 #define HID_CP_CHANNELLEFT 0x000c0161
285 #define HID_CP_CHANNELRIGHT 0x000c0162
286 #define HID_CP_CHANNELCENTER 0x000c0163
287 #define HID_CP_CHANNELFRONT 0x000c0164
288 #define HID_CP_CHANNELCENTERFRONT 0x000c0165
289 #define HID_CP_CHANNELSIDE 0x000c0166
290 #define HID_CP_CHANNELSURROUND 0x000c0167
291 #define HID_CP_CHANNELLOWFREQUENCYENHANCEMENT 0x000c0168
292 #define HID_CP_CHANNELTOP 0x000c0169
293 #define HID_CP_CHANNELUNKNOWN 0x000c016a
294 #define HID_CP_APPLICATIONLAUNCHBUTTONS 0x000c0180
295 #define HID_CP_GENERICGUIAPPLICATIONCONTROLS 0x000c0200
296
297 #define HID_DG_DEVICECONFIG 0x000d000e
298 #define HID_DG_DEVICESETTINGS 0x000d0023
299 #define HID_DG_AZIMUTH 0x000d003f
300 #define HID_DG_CONFIDENCE 0x000d0047
301 #define HID_DG_WIDTH 0x000d0048
302 #define HID_DG_HEIGHT 0x000d0049
303 #define HID_DG_CONTACTID 0x000d0051
304 #define HID_DG_INPUTMODE 0x000d0052
305 #define HID_DG_DEVICEINDEX 0x000d0053
306 #define HID_DG_CONTACTCOUNT 0x000d0054
307 #define HID_DG_CONTACTMAX 0x000d0055
308 #define HID_DG_SCANTIME 0x000d0056
309 #define HID_DG_SURFACESWITCH 0x000d0057
310 #define HID_DG_BUTTONSWITCH 0x000d0058
311 #define HID_DG_BUTTONTYPE 0x000d0059
312 #define HID_DG_BARRELSWITCH2 0x000d005a
313 #define HID_DG_TOOLSERIALNUMBER 0x000d005b
314 #define HID_DG_LATENCYMODE 0x000d0060
315
316 #define HID_BAT_ABSOLUTESTATEOFCHARGE 0x00850065
317 #define HID_BAT_CHARGING 0x00850044
318
319 #define HID_VD_ASUS_CUSTOM_MEDIA_KEYS 0xff310076
320
321 /*
322 * HID connect requests
323 */
324
325 #define HID_CONNECT_HIDINPUT BIT(0)
326 #define HID_CONNECT_HIDINPUT_FORCE BIT(1)
327 #define HID_CONNECT_HIDRAW BIT(2)
328 #define HID_CONNECT_HIDDEV BIT(3)
329 #define HID_CONNECT_HIDDEV_FORCE BIT(4)
330 #define HID_CONNECT_FF BIT(5)
331 #define HID_CONNECT_DRIVER BIT(6)
332 #define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
333 HID_CONNECT_HIDDEV|HID_CONNECT_FF)
334
335 /*
336 * HID device quirks.
337 */
338
339 /*
340 * Increase this if you need to configure more HID quirks at module load time
341 */
342 #define MAX_USBHID_BOOT_QUIRKS 4
343
344 /**
345 * DOC: HID quirks
346 * | @HID_QUIRK_NOTOUCH:
347 * | @HID_QUIRK_IGNORE: ignore this device
348 * | @HID_QUIRK_NOGET:
349 * | @HID_QUIRK_HIDDEV_FORCE:
350 * | @HID_QUIRK_BADPAD:
351 * | @HID_QUIRK_MULTI_INPUT:
352 * | @HID_QUIRK_HIDINPUT_FORCE:
353 * | @HID_QUIRK_ALWAYS_POLL:
354 * | @HID_QUIRK_INPUT_PER_APP:
355 * | @HID_QUIRK_X_INVERT:
356 * | @HID_QUIRK_Y_INVERT:
357 * | @HID_QUIRK_SKIP_OUTPUT_REPORTS:
358 * | @HID_QUIRK_SKIP_OUTPUT_REPORT_ID:
359 * | @HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP:
360 * | @HID_QUIRK_HAVE_SPECIAL_DRIVER:
361 * | @HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE:
362 * | @HID_QUIRK_IGNORE_SPECIAL_DRIVER
363 * | @HID_QUIRK_FULLSPEED_INTERVAL:
364 * | @HID_QUIRK_NO_INIT_REPORTS:
365 * | @HID_QUIRK_NO_IGNORE:
366 * | @HID_QUIRK_NO_INPUT_SYNC:
367 */
368 /* BIT(0) reserved for backward compatibility, was HID_QUIRK_INVERT */
369 #define HID_QUIRK_NOTOUCH BIT(1)
370 #define HID_QUIRK_IGNORE BIT(2)
371 #define HID_QUIRK_NOGET BIT(3)
372 #define HID_QUIRK_HIDDEV_FORCE BIT(4)
373 #define HID_QUIRK_BADPAD BIT(5)
374 #define HID_QUIRK_MULTI_INPUT BIT(6)
375 #define HID_QUIRK_HIDINPUT_FORCE BIT(7)
376 /* BIT(8) reserved for backward compatibility, was HID_QUIRK_NO_EMPTY_INPUT */
377 /* BIT(9) reserved for backward compatibility, was NO_INIT_INPUT_REPORTS */
378 #define HID_QUIRK_ALWAYS_POLL BIT(10)
379 #define HID_QUIRK_INPUT_PER_APP BIT(11)
380 #define HID_QUIRK_X_INVERT BIT(12)
381 #define HID_QUIRK_Y_INVERT BIT(13)
382 #define HID_QUIRK_SKIP_OUTPUT_REPORTS BIT(16)
383 #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID BIT(17)
384 #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP BIT(18)
385 #define HID_QUIRK_HAVE_SPECIAL_DRIVER BIT(19)
386 #define HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE BIT(20)
387 #define HID_QUIRK_NOINVERT BIT(21)
388 #define HID_QUIRK_IGNORE_SPECIAL_DRIVER BIT(22)
389 #define HID_QUIRK_FULLSPEED_INTERVAL BIT(28)
390 #define HID_QUIRK_NO_INIT_REPORTS BIT(29)
391 #define HID_QUIRK_NO_IGNORE BIT(30)
392 #define HID_QUIRK_NO_INPUT_SYNC BIT(31)
393
394 /*
395 * HID device groups
396 *
397 * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h
398 * and has a value of 0x0000
399 */
400 #define HID_GROUP_GENERIC 0x0001
401 #define HID_GROUP_MULTITOUCH 0x0002
402 #define HID_GROUP_SENSOR_HUB 0x0003
403 #define HID_GROUP_MULTITOUCH_WIN_8 0x0004
404
405 /*
406 * Vendor specific HID device groups
407 */
408 #define HID_GROUP_RMI 0x0100
409 #define HID_GROUP_WACOM 0x0101
410 #define HID_GROUP_LOGITECH_DJ_DEVICE 0x0102
411 #define HID_GROUP_STEAM 0x0103
412 #define HID_GROUP_LOGITECH_27MHZ_DEVICE 0x0104
413 #define HID_GROUP_VIVALDI 0x0105
414
415 /*
416 * HID protocol status
417 */
418 #define HID_REPORT_PROTOCOL 1
419 #define HID_BOOT_PROTOCOL 0
420
421 /*
422 * This is the global environment of the parser. This information is
423 * persistent for main-items. The global environment can be saved and
424 * restored with PUSH/POP statements.
425 */
426
427 struct hid_global {
428 unsigned usage_page;
429 __s32 logical_minimum;
430 __s32 logical_maximum;
431 __s32 physical_minimum;
432 __s32 physical_maximum;
433 __s32 unit_exponent;
434 unsigned unit;
435 unsigned report_id;
436 unsigned report_size;
437 unsigned report_count;
438 };
439
440 /*
441 * This is the local environment. It is persistent up the next main-item.
442 */
443
444 #define HID_MAX_USAGES 12288
445 #define HID_DEFAULT_NUM_COLLECTIONS 16
446
447 struct hid_local {
448 unsigned usage[HID_MAX_USAGES]; /* usage array */
449 u8 usage_size[HID_MAX_USAGES]; /* usage size array */
450 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
451 unsigned usage_index;
452 unsigned usage_minimum;
453 unsigned delimiter_depth;
454 unsigned delimiter_branch;
455 };
456
457 /*
458 * This is the collection stack. We climb up the stack to determine
459 * application and function of each field.
460 */
461
462 struct hid_collection {
463 int parent_idx; /* device->collection */
464 unsigned type;
465 unsigned usage;
466 unsigned level;
467 };
468
469 struct hid_usage {
470 unsigned hid; /* hid usage code */
471 unsigned collection_index; /* index into collection array */
472 unsigned usage_index; /* index into usage array */
473 __s8 resolution_multiplier;/* Effective Resolution Multiplier
474 (HUT v1.12, 4.3.1), default: 1 */
475 /* hidinput data */
476 __s8 wheel_factor; /* 120/resolution_multiplier */
477 __u16 code; /* input driver code */
478 __u8 type; /* input driver type */
479 __s16 hat_min; /* hat switch fun */
480 __s16 hat_max; /* ditto */
481 __s16 hat_dir; /* ditto */
482 __s16 wheel_accumulated; /* hi-res wheel */
483 };
484
485 struct hid_input;
486
487 struct hid_field {
488 unsigned physical; /* physical usage for this field */
489 unsigned logical; /* logical usage for this field */
490 unsigned application; /* application usage for this field */
491 struct hid_usage *usage; /* usage table for this function */
492 unsigned maxusage; /* maximum usage index */
493 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
494 unsigned report_offset; /* bit offset in the report */
495 unsigned report_size; /* size of this field in the report */
496 unsigned report_count; /* number of this field in the report */
497 unsigned report_type; /* (input,output,feature) */
498 __s32 *value; /* last known value(s) */
499 __s32 *new_value; /* newly read value(s) */
500 __s32 *usages_priorities; /* priority of each usage when reading the report
501 * bits 8-16 are reserved for hid-input usage
502 */
503 __s32 logical_minimum;
504 __s32 logical_maximum;
505 __s32 physical_minimum;
506 __s32 physical_maximum;
507 __s32 unit_exponent;
508 unsigned unit;
509 bool ignored; /* this field is ignored in this event */
510 struct hid_report *report; /* associated report */
511 unsigned index; /* index into report->field[] */
512 /* hidinput data */
513 struct hid_input *hidinput; /* associated input structure */
514 __u16 dpad; /* dpad input code */
515 unsigned int slot_idx; /* slot index in a report */
516 };
517
518 #define HID_MAX_FIELDS 256
519
520 struct hid_field_entry {
521 struct list_head list;
522 struct hid_field *field;
523 unsigned int index;
524 __s32 priority;
525 };
526
527 struct hid_report {
528 struct list_head list;
529 struct list_head hidinput_list;
530 struct list_head field_entry_list; /* ordered list of input fields */
531 unsigned int id; /* id of this report */
532 enum hid_report_type type; /* report type */
533 unsigned int application; /* application usage for this report */
534 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
535 struct hid_field_entry *field_entries; /* allocated memory of input field_entry */
536 unsigned maxfield; /* maximum valid field index */
537 unsigned size; /* size of the report (bits) */
538 struct hid_device *device; /* associated device */
539
540 /* tool related state */
541 bool tool_active; /* whether the current tool is active */
542 unsigned int tool; /* BTN_TOOL_* */
543 };
544
545 #define HID_MAX_IDS 256
546
547 struct hid_report_enum {
548 unsigned numbered;
549 struct list_head report_list;
550 struct hid_report *report_id_hash[HID_MAX_IDS];
551 };
552
553 #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
554 #define HID_MAX_BUFFER_SIZE 16384 /* 16kb */
555 #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
556 #define HID_OUTPUT_FIFO_SIZE 64
557
558 struct hid_control_fifo {
559 unsigned char dir;
560 struct hid_report *report;
561 char *raw_report;
562 };
563
564 struct hid_output_fifo {
565 struct hid_report *report;
566 char *raw_report;
567 };
568
569 #define HID_CLAIMED_INPUT BIT(0)
570 #define HID_CLAIMED_HIDDEV BIT(1)
571 #define HID_CLAIMED_HIDRAW BIT(2)
572 #define HID_CLAIMED_DRIVER BIT(3)
573
574 #define HID_STAT_ADDED BIT(0)
575 #define HID_STAT_PARSED BIT(1)
576 #define HID_STAT_DUP_DETECTED BIT(2)
577 #define HID_STAT_REPROBED BIT(3)
578
579 struct hid_input {
580 struct list_head list;
581 struct hid_report *report;
582 struct input_dev *input;
583 const char *name;
584 struct list_head reports; /* the list of reports */
585 unsigned int application; /* application usage for this input */
586 bool registered;
587 };
588
589 enum hid_type {
590 HID_TYPE_OTHER = 0,
591 HID_TYPE_USBMOUSE,
592 HID_TYPE_USBNONE
593 };
594
595 enum hid_battery_status {
596 HID_BATTERY_UNKNOWN = 0,
597 HID_BATTERY_QUERIED, /* Kernel explicitly queried battery strength */
598 HID_BATTERY_REPORTED, /* Device sent unsolicited battery strength report */
599 };
600
601 struct hid_driver;
602 struct hid_ll_driver;
603
604 struct hid_device {
605 const __u8 *dev_rdesc; /* device report descriptor */
606 const __u8 *bpf_rdesc; /* bpf modified report descriptor, if any */
607 const __u8 *rdesc; /* currently used report descriptor */
608 unsigned int dev_rsize;
609 unsigned int bpf_rsize;
610 unsigned int rsize;
611 unsigned int collection_size; /* Number of allocated hid_collections */
612 struct hid_collection *collection; /* List of HID collections */
613 unsigned int maxcollection; /* Number of parsed collections */
614 unsigned int maxapplication; /* Number of applications */
615 __u16 bus; /* BUS ID */
616 __u16 group; /* Report group */
617 __u32 vendor; /* Vendor ID */
618 __u32 product; /* Product ID */
619 __u32 version; /* HID version */
620 enum hid_type type; /* device type (mouse, kbd, ...) */
621 unsigned country; /* HID country */
622 struct hid_report_enum report_enum[HID_REPORT_TYPES];
623 struct work_struct led_work; /* delayed LED worker */
624
625 struct semaphore driver_input_lock; /* protects the current driver */
626 struct device dev; /* device */
627 struct hid_driver *driver;
628 void *devres_group_id; /* ID of probe devres group */
629
630 const struct hid_ll_driver *ll_driver;
631 struct mutex ll_open_lock;
632 unsigned int ll_open_count;
633
634 #ifdef CONFIG_HID_BATTERY_STRENGTH
635 /*
636 * Power supply information for HID devices which report
637 * battery strength. power_supply was successfully registered if
638 * battery is non-NULL.
639 */
640 struct power_supply *battery;
641 __s32 battery_capacity;
642 __s32 battery_min;
643 __s32 battery_max;
644 __s32 battery_report_type;
645 __s32 battery_report_id;
646 __s32 battery_charge_status;
647 enum hid_battery_status battery_status;
648 bool battery_avoid_query;
649 ktime_t battery_ratelimit_time;
650 #endif
651
652 unsigned long status; /* see STAT flags above */
653 unsigned claimed; /* Claimed by hidinput, hiddev? */
654 unsigned quirks; /* Various quirks the device can pull on us */
655 unsigned initial_quirks; /* Initial set of quirks supplied when creating device */
656 bool io_started; /* If IO has started */
657
658 struct list_head inputs; /* The list of inputs */
659 void *hiddev; /* The hiddev structure */
660 void *hidraw;
661
662 char name[128]; /* Device name */
663 char phys[64]; /* Device physical location */
664 char uniq[64]; /* Device unique identifier (serial #) */
665
666 void *driver_data;
667
668 /* temporary hid_ff handling (until moved to the drivers) */
669 int (*ff_init)(struct hid_device *);
670
671 /* hiddev event handler */
672 int (*hiddev_connect)(struct hid_device *, unsigned int);
673 void (*hiddev_disconnect)(struct hid_device *);
674 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
675 struct hid_usage *, __s32);
676 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
677
678 /* debugging support via debugfs */
679 unsigned short debug;
680 struct dentry *debug_dir;
681 struct dentry *debug_rdesc;
682 struct dentry *debug_events;
683 struct list_head debug_list;
684 spinlock_t debug_list_lock;
685 wait_queue_head_t debug_wait;
686 struct kref ref;
687
688 unsigned int id; /* system unique id */
689
690 #ifdef CONFIG_HID_BPF
691 struct hid_bpf bpf; /* hid-bpf data */
692 #endif /* CONFIG_HID_BPF */
693 };
694
695 void hiddev_free(struct kref *ref);
696
697 #define to_hid_device(pdev) \
698 container_of(pdev, struct hid_device, dev)
699
hid_get_drvdata(struct hid_device * hdev)700 static inline void *hid_get_drvdata(struct hid_device *hdev)
701 {
702 return dev_get_drvdata(&hdev->dev);
703 }
704
hid_set_drvdata(struct hid_device * hdev,void * data)705 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
706 {
707 dev_set_drvdata(&hdev->dev, data);
708 }
709
710 #define HID_GLOBAL_STACK_SIZE 4
711 #define HID_COLLECTION_STACK_SIZE 4
712
713 #define HID_SCAN_FLAG_MT_WIN_8 BIT(0)
714 #define HID_SCAN_FLAG_VENDOR_SPECIFIC BIT(1)
715 #define HID_SCAN_FLAG_GD_POINTER BIT(2)
716
717 struct hid_parser {
718 struct hid_global global;
719 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
720 unsigned int global_stack_ptr;
721 struct hid_local local;
722 unsigned int *collection_stack;
723 unsigned int collection_stack_ptr;
724 unsigned int collection_stack_size;
725 struct hid_device *device;
726 unsigned int scan_flags;
727 };
728
729 struct hid_class_descriptor {
730 __u8 bDescriptorType;
731 __le16 wDescriptorLength;
732 } __attribute__ ((packed));
733
734 struct hid_descriptor {
735 __u8 bLength;
736 __u8 bDescriptorType;
737 __le16 bcdHID;
738 __u8 bCountryCode;
739 __u8 bNumDescriptors;
740
741 struct hid_class_descriptor desc[1];
742 } __attribute__ ((packed));
743
744 #define HID_DEVICE(b, g, ven, prod) \
745 .bus = (b), .group = (g), .vendor = (ven), .product = (prod)
746 #define HID_USB_DEVICE(ven, prod) \
747 .bus = BUS_USB, .vendor = (ven), .product = (prod)
748 #define HID_BLUETOOTH_DEVICE(ven, prod) \
749 .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod)
750 #define HID_I2C_DEVICE(ven, prod) \
751 .bus = BUS_I2C, .vendor = (ven), .product = (prod)
752
753 #define HID_REPORT_ID(rep) \
754 .report_type = (rep)
755 #define HID_USAGE_ID(uhid, utype, ucode) \
756 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
757 /* we don't want to catch types and codes equal to 0 */
758 #define HID_TERMINATOR (HID_ANY_ID - 1)
759
760 struct hid_report_id {
761 __u32 report_type;
762 };
763 struct hid_usage_id {
764 __u32 usage_hid;
765 __u32 usage_type;
766 __u32 usage_code;
767 };
768
769 /**
770 * struct hid_driver
771 * @name: driver name (e.g. "Footech_bar-wheel")
772 * @id_table: which devices is this driver for (must be non-NULL for probe
773 * to be called)
774 * @dyn_list: list of dynamically added device ids
775 * @dyn_lock: lock protecting @dyn_list
776 * @match: check if the given device is handled by this driver
777 * @probe: new device inserted
778 * @remove: device removed (NULL if not a hot-plug capable driver)
779 * @report_table: on which reports to call raw_event (NULL means all)
780 * @raw_event: if report in report_table, this hook is called (NULL means nop)
781 * @usage_table: on which events to call event (NULL means all)
782 * @event: if usage in usage_table, this hook is called (NULL means nop)
783 * @report: this hook is called after parsing a report (NULL means nop)
784 * @report_fixup: called before report descriptor parsing (NULL means nop)
785 * @input_mapping: invoked on input registering before mapping an usage
786 * @input_mapped: invoked on input registering after mapping an usage
787 * @input_configured: invoked just before the device is registered
788 * @feature_mapping: invoked on feature registering
789 * @suspend: invoked on suspend (NULL means nop)
790 * @resume: invoked on resume if device was not reset (NULL means nop)
791 * @reset_resume: invoked on resume if device was reset (NULL means nop)
792 *
793 * probe should return -errno on error, or 0 on success. During probe,
794 * input will not be passed to raw_event unless hid_device_io_start is
795 * called.
796 *
797 * raw_event and event should return negative on error, any other value will
798 * pass the event on to .event() typically return 0 for success.
799 *
800 * input_mapping shall return a negative value to completely ignore this usage
801 * (e.g. doubled or invalid usage), zero to continue with parsing of this
802 * usage by generic code (no special handling needed) or positive to skip
803 * generic parsing (needed special handling which was done in the hook already)
804 * input_mapped shall return negative to inform the layer that this usage
805 * should not be considered for further processing or zero to notify that
806 * no processing was performed and should be done in a generic manner
807 * Both these functions may be NULL which means the same behavior as returning
808 * zero from them.
809 */
810 struct hid_driver {
811 char *name;
812 const struct hid_device_id *id_table;
813
814 struct list_head dyn_list;
815 spinlock_t dyn_lock;
816
817 bool (*match)(struct hid_device *dev, bool ignore_special_driver);
818 int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
819 void (*remove)(struct hid_device *dev);
820
821 const struct hid_report_id *report_table;
822 int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
823 u8 *data, int size);
824 const struct hid_usage_id *usage_table;
825 int (*event)(struct hid_device *hdev, struct hid_field *field,
826 struct hid_usage *usage, __s32 value);
827 void (*report)(struct hid_device *hdev, struct hid_report *report);
828
829 const __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
830 unsigned int *size);
831
832 int (*input_mapping)(struct hid_device *hdev,
833 struct hid_input *hidinput, struct hid_field *field,
834 struct hid_usage *usage, unsigned long **bit, int *max);
835 int (*input_mapped)(struct hid_device *hdev,
836 struct hid_input *hidinput, struct hid_field *field,
837 struct hid_usage *usage, unsigned long **bit, int *max);
838 int (*input_configured)(struct hid_device *hdev,
839 struct hid_input *hidinput);
840 void (*feature_mapping)(struct hid_device *hdev,
841 struct hid_field *field,
842 struct hid_usage *usage);
843
844 int (*suspend)(struct hid_device *hdev, pm_message_t message);
845 int (*resume)(struct hid_device *hdev);
846 int (*reset_resume)(struct hid_device *hdev);
847
848 /* private: */
849 struct device_driver driver;
850 };
851
852 #define to_hid_driver(pdrv) \
853 container_of(pdrv, struct hid_driver, driver)
854
855 /**
856 * struct hid_ll_driver - low level driver callbacks
857 * @start: called on probe to start the device
858 * @stop: called on remove
859 * @open: called by input layer on open
860 * @close: called by input layer on close
861 * @power: request underlying hardware to enter requested power mode
862 * @parse: this method is called only once to parse the device data,
863 * shouldn't allocate anything to not leak memory
864 * @request: send report request to device (e.g. feature report)
865 * @wait: wait for buffered io to complete (send/recv reports)
866 * @raw_request: send raw report request to device (e.g. feature report)
867 * @output_report: send output report to device
868 * @idle: send idle request to device
869 * @may_wakeup: return if device may act as a wakeup source during system-suspend
870 * @max_buffer_size: over-ride maximum data buffer size (default: HID_MAX_BUFFER_SIZE)
871 */
872 struct hid_ll_driver {
873 int (*start)(struct hid_device *hdev);
874 void (*stop)(struct hid_device *hdev);
875
876 int (*open)(struct hid_device *hdev);
877 void (*close)(struct hid_device *hdev);
878
879 int (*power)(struct hid_device *hdev, int level);
880
881 int (*parse)(struct hid_device *hdev);
882
883 void (*request)(struct hid_device *hdev,
884 struct hid_report *report, int reqtype);
885
886 int (*wait)(struct hid_device *hdev);
887
888 int (*raw_request) (struct hid_device *hdev, unsigned char reportnum,
889 __u8 *buf, size_t len, unsigned char rtype,
890 int reqtype);
891
892 int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len);
893
894 int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype);
895 bool (*may_wakeup)(struct hid_device *hdev);
896
897 unsigned int max_buffer_size;
898 };
899
900 extern bool hid_is_usb(const struct hid_device *hdev);
901
902 #define PM_HINT_FULLON 1<<5
903 #define PM_HINT_NORMAL 1<<1
904
905 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
906 /* We ignore a few input applications that are not widely used */
907 #define IS_INPUT_APPLICATION(a) \
908 (((a >= HID_UP_GENDESK) && (a <= HID_GD_MULTIAXIS)) \
909 || ((a >= HID_DG_DIGITIZER) && (a <= HID_DG_WHITEBOARD)) \
910 || (a == HID_GD_SYSTEM_CONTROL) || (a == HID_CP_CONSUMER_CONTROL) \
911 || (a == HID_GD_WIRELESS_RADIO_CTLS))
912
913 /* HID core API */
914
915 extern bool hid_ignore(struct hid_device *);
916 extern int hid_add_device(struct hid_device *);
917 extern void hid_destroy_device(struct hid_device *);
918
919 extern const struct bus_type hid_bus_type;
920
921 extern int __must_check __hid_register_driver(struct hid_driver *,
922 struct module *, const char *mod_name);
923
924 /* use a define to avoid include chaining to get THIS_MODULE & friends */
925 #define hid_register_driver(driver) \
926 __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
927
928 extern void hid_unregister_driver(struct hid_driver *);
929
930 /**
931 * module_hid_driver() - Helper macro for registering a HID driver
932 * @__hid_driver: hid_driver struct
933 *
934 * Helper macro for HID drivers which do not do anything special in module
935 * init/exit. This eliminates a lot of boilerplate. Each module may only
936 * use this macro once, and calling it replaces module_init() and module_exit()
937 */
938 #define module_hid_driver(__hid_driver) \
939 module_driver(__hid_driver, hid_register_driver, \
940 hid_unregister_driver)
941
942 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
943 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
944 extern int hidinput_connect(struct hid_device *hid, unsigned int force);
945 extern void hidinput_disconnect(struct hid_device *);
946
947 struct hid_field *hid_find_field(struct hid_device *hdev, unsigned int report_type,
948 unsigned int application, unsigned int usage);
949 int hid_set_field(struct hid_field *, unsigned, __s32);
950 int hid_input_report(struct hid_device *hid, enum hid_report_type type, u8 *data, u32 size,
951 int interrupt);
952 struct hid_field *hidinput_get_led_field(struct hid_device *hid);
953 unsigned int hidinput_count_leds(struct hid_device *hid);
954 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
955 void hid_output_report(struct hid_report *report, __u8 *data);
956 int __hid_request(struct hid_device *hid, struct hid_report *rep, enum hid_class_request reqtype);
957 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags);
958 struct hid_device *hid_allocate_device(void);
959 struct hid_report *hid_register_report(struct hid_device *device,
960 enum hid_report_type type, unsigned int id,
961 unsigned int application);
962 int hid_parse_report(struct hid_device *hid, const __u8 *start, unsigned size);
963 struct hid_report *hid_validate_values(struct hid_device *hid,
964 enum hid_report_type type, unsigned int id,
965 unsigned int field_index,
966 unsigned int report_counts);
967
968 void hid_setup_resolution_multiplier(struct hid_device *hid);
969 int hid_open_report(struct hid_device *device);
970 int hid_check_keys_pressed(struct hid_device *hid);
971 int hid_connect(struct hid_device *hid, unsigned int connect_mask);
972 void hid_disconnect(struct hid_device *hid);
973 bool hid_match_one_id(const struct hid_device *hdev,
974 const struct hid_device_id *id);
975 const struct hid_device_id *hid_match_id(const struct hid_device *hdev,
976 const struct hid_device_id *id);
977 const struct hid_device_id *hid_match_device(struct hid_device *hdev,
978 struct hid_driver *hdrv);
979 bool hid_compare_device_paths(struct hid_device *hdev_a,
980 struct hid_device *hdev_b, char separator);
981 __u32 hid_field_extract(const struct hid_device *hid, __u8 *report,
982 unsigned offset, unsigned n);
983
984 #ifdef CONFIG_PM
985 int hid_driver_suspend(struct hid_device *hdev, pm_message_t state);
986 int hid_driver_reset_resume(struct hid_device *hdev);
987 int hid_driver_resume(struct hid_device *hdev);
988 #else
hid_driver_suspend(struct hid_device * hdev,pm_message_t state)989 static inline int hid_driver_suspend(struct hid_device *hdev, pm_message_t state) { return 0; }
hid_driver_reset_resume(struct hid_device * hdev)990 static inline int hid_driver_reset_resume(struct hid_device *hdev) { return 0; }
hid_driver_resume(struct hid_device * hdev)991 static inline int hid_driver_resume(struct hid_device *hdev) { return 0; }
992 #endif
993
994 /**
995 * hid_device_io_start - enable HID input during probe, remove
996 *
997 * @hid: the device
998 *
999 * This should only be called during probe or remove and only be
1000 * called by the thread calling probe or remove. It will allow
1001 * incoming packets to be delivered to the driver.
1002 */
hid_device_io_start(struct hid_device * hid)1003 static inline void hid_device_io_start(struct hid_device *hid) {
1004 if (hid->io_started) {
1005 dev_warn(&hid->dev, "io already started\n");
1006 return;
1007 }
1008 hid->io_started = true;
1009 up(&hid->driver_input_lock);
1010 }
1011
1012 /**
1013 * hid_device_io_stop - disable HID input during probe, remove
1014 *
1015 * @hid: the device
1016 *
1017 * Should only be called after hid_device_io_start. It will prevent
1018 * incoming packets from going to the driver for the duration of
1019 * probe, remove. If called during probe, packets will still go to the
1020 * driver after probe is complete. This function should only be called
1021 * by the thread calling probe or remove.
1022 */
hid_device_io_stop(struct hid_device * hid)1023 static inline void hid_device_io_stop(struct hid_device *hid) {
1024 if (!hid->io_started) {
1025 dev_warn(&hid->dev, "io already stopped\n");
1026 return;
1027 }
1028 hid->io_started = false;
1029 down(&hid->driver_input_lock);
1030 }
1031
1032 /**
1033 * hid_map_usage - map usage input bits
1034 *
1035 * @hidinput: hidinput which we are interested in
1036 * @usage: usage to fill in
1037 * @bit: pointer to input->{}bit (out parameter)
1038 * @max: maximal valid usage->code to consider later (out parameter)
1039 * @type: input event type (EV_KEY, EV_REL, ...)
1040 * @c: code which corresponds to this usage and type
1041 *
1042 * The value pointed to by @bit will be set to NULL if either @type is
1043 * an unhandled event type, or if @c is out of range for @type. This
1044 * can be used as an error condition.
1045 */
hid_map_usage(struct hid_input * hidinput,struct hid_usage * usage,unsigned long ** bit,int * max,__u8 type,unsigned int c)1046 static inline void hid_map_usage(struct hid_input *hidinput,
1047 struct hid_usage *usage, unsigned long **bit, int *max,
1048 __u8 type, unsigned int c)
1049 {
1050 struct input_dev *input = hidinput->input;
1051 unsigned long *bmap = NULL;
1052 unsigned int limit = 0;
1053
1054 switch (type) {
1055 case EV_ABS:
1056 bmap = input->absbit;
1057 limit = ABS_MAX;
1058 break;
1059 case EV_REL:
1060 bmap = input->relbit;
1061 limit = REL_MAX;
1062 break;
1063 case EV_KEY:
1064 bmap = input->keybit;
1065 limit = KEY_MAX;
1066 break;
1067 case EV_LED:
1068 bmap = input->ledbit;
1069 limit = LED_MAX;
1070 break;
1071 case EV_MSC:
1072 bmap = input->mscbit;
1073 limit = MSC_MAX;
1074 break;
1075 }
1076
1077 if (unlikely(c > limit || !bmap)) {
1078 pr_warn_ratelimited("%s: Invalid code %d type %d\n",
1079 input->name, c, type);
1080 *bit = NULL;
1081 return;
1082 }
1083
1084 usage->type = type;
1085 usage->code = c;
1086 *max = limit;
1087 *bit = bmap;
1088 }
1089
1090 /**
1091 * hid_map_usage_clear - map usage input bits and clear the input bit
1092 *
1093 * @hidinput: hidinput which we are interested in
1094 * @usage: usage to fill in
1095 * @bit: pointer to input->{}bit (out parameter)
1096 * @max: maximal valid usage->code to consider later (out parameter)
1097 * @type: input event type (EV_KEY, EV_REL, ...)
1098 * @c: code which corresponds to this usage and type
1099 *
1100 * The same as hid_map_usage, except the @c bit is also cleared in supported
1101 * bits (@bit).
1102 */
hid_map_usage_clear(struct hid_input * hidinput,struct hid_usage * usage,unsigned long ** bit,int * max,__u8 type,__u16 c)1103 static inline void hid_map_usage_clear(struct hid_input *hidinput,
1104 struct hid_usage *usage, unsigned long **bit, int *max,
1105 __u8 type, __u16 c)
1106 {
1107 hid_map_usage(hidinput, usage, bit, max, type, c);
1108 if (*bit)
1109 clear_bit(usage->code, *bit);
1110 }
1111
1112 /**
1113 * hid_parse - parse HW reports
1114 *
1115 * @hdev: hid device
1116 *
1117 * Call this from probe after you set up the device (if needed). Your
1118 * report_fixup will be called (if non-NULL) after reading raw report from
1119 * device before passing it to hid layer for real parsing.
1120 */
hid_parse(struct hid_device * hdev)1121 static inline int __must_check hid_parse(struct hid_device *hdev)
1122 {
1123 return hid_open_report(hdev);
1124 }
1125
1126 int __must_check hid_hw_start(struct hid_device *hdev,
1127 unsigned int connect_mask);
1128 void hid_hw_stop(struct hid_device *hdev);
1129 int __must_check hid_hw_open(struct hid_device *hdev);
1130 void hid_hw_close(struct hid_device *hdev);
1131 void hid_hw_request(struct hid_device *hdev,
1132 struct hid_report *report, enum hid_class_request reqtype);
1133 int __hid_hw_raw_request(struct hid_device *hdev,
1134 unsigned char reportnum, __u8 *buf,
1135 size_t len, enum hid_report_type rtype,
1136 enum hid_class_request reqtype,
1137 __u64 source, bool from_bpf);
1138 int __hid_hw_output_report(struct hid_device *hdev, __u8 *buf, size_t len, __u64 source,
1139 bool from_bpf);
1140 int hid_hw_raw_request(struct hid_device *hdev,
1141 unsigned char reportnum, __u8 *buf,
1142 size_t len, enum hid_report_type rtype,
1143 enum hid_class_request reqtype);
1144 int hid_hw_output_report(struct hid_device *hdev, __u8 *buf, size_t len);
1145
1146 /**
1147 * hid_hw_power - requests underlying HW to go into given power mode
1148 *
1149 * @hdev: hid device
1150 * @level: requested power level (one of %PM_HINT_* defines)
1151 *
1152 * This function requests underlying hardware to enter requested power
1153 * mode.
1154 */
1155
hid_hw_power(struct hid_device * hdev,int level)1156 static inline int hid_hw_power(struct hid_device *hdev, int level)
1157 {
1158 return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
1159 }
1160
1161
1162 /**
1163 * hid_hw_idle - send idle request to device
1164 *
1165 * @hdev: hid device
1166 * @report: report to control
1167 * @idle: idle state
1168 * @reqtype: hid request type
1169 */
hid_hw_idle(struct hid_device * hdev,int report,int idle,enum hid_class_request reqtype)1170 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
1171 enum hid_class_request reqtype)
1172 {
1173 if (hdev->ll_driver->idle)
1174 return hdev->ll_driver->idle(hdev, report, idle, reqtype);
1175
1176 return 0;
1177 }
1178
1179 /**
1180 * hid_hw_may_wakeup - return if the hid device may act as a wakeup source during system-suspend
1181 *
1182 * @hdev: hid device
1183 */
hid_hw_may_wakeup(struct hid_device * hdev)1184 static inline bool hid_hw_may_wakeup(struct hid_device *hdev)
1185 {
1186 if (hdev->ll_driver->may_wakeup)
1187 return hdev->ll_driver->may_wakeup(hdev);
1188
1189 if (hdev->dev.parent)
1190 return device_may_wakeup(hdev->dev.parent);
1191
1192 return false;
1193 }
1194
1195 /**
1196 * hid_hw_wait - wait for buffered io to complete
1197 *
1198 * @hdev: hid device
1199 */
hid_hw_wait(struct hid_device * hdev)1200 static inline void hid_hw_wait(struct hid_device *hdev)
1201 {
1202 if (hdev->ll_driver->wait)
1203 hdev->ll_driver->wait(hdev);
1204 }
1205
1206 /**
1207 * hid_report_len - calculate the report length
1208 *
1209 * @report: the report we want to know the length
1210 */
hid_report_len(struct hid_report * report)1211 static inline u32 hid_report_len(struct hid_report *report)
1212 {
1213 return DIV_ROUND_UP(report->size, 8) + (report->id > 0);
1214 }
1215
1216 int hid_report_raw_event(struct hid_device *hid, enum hid_report_type type, u8 *data, u32 size,
1217 int interrupt);
1218
1219 /* HID quirks API */
1220 unsigned long hid_lookup_quirk(const struct hid_device *hdev);
1221 int hid_quirks_init(char **quirks_param, __u16 bus, int count);
1222 void hid_quirks_exit(__u16 bus);
1223
1224 #ifdef CONFIG_HID_PID
1225 int hid_pidff_init(struct hid_device *hid);
1226 #else
1227 #define hid_pidff_init NULL
1228 #endif
1229
1230 #define dbg_hid(fmt, ...) pr_debug("%s: " fmt, __FILE__, ##__VA_ARGS__)
1231
1232 #define hid_err(hid, fmt, ...) \
1233 dev_err(&(hid)->dev, fmt, ##__VA_ARGS__)
1234 #define hid_notice(hid, fmt, ...) \
1235 dev_notice(&(hid)->dev, fmt, ##__VA_ARGS__)
1236 #define hid_warn(hid, fmt, ...) \
1237 dev_warn(&(hid)->dev, fmt, ##__VA_ARGS__)
1238 #define hid_info(hid, fmt, ...) \
1239 dev_info(&(hid)->dev, fmt, ##__VA_ARGS__)
1240 #define hid_dbg(hid, fmt, ...) \
1241 dev_dbg(&(hid)->dev, fmt, ##__VA_ARGS__)
1242
1243 #define hid_err_once(hid, fmt, ...) \
1244 dev_err_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1245 #define hid_notice_once(hid, fmt, ...) \
1246 dev_notice_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1247 #define hid_warn_once(hid, fmt, ...) \
1248 dev_warn_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1249 #define hid_info_once(hid, fmt, ...) \
1250 dev_info_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1251 #define hid_dbg_once(hid, fmt, ...) \
1252 dev_dbg_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1253
1254 #endif
1255