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