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

source code of linux/include/linux/hid.h

Morty Proxy This is a proxified and sanitized view of the page, visit original site.