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