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