Commit | Line | Data |
---|---|---|
1a59d1b8 | 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
1da177e4 | 2 | /* |
1da177e4 LT |
3 | * Copyright (c) 1999 Andreas Gal |
4 | * Copyright (c) 2000-2001 Vojtech Pavlik | |
b55fd23c | 5 | * Copyright (c) 2006-2007 Jiri Kosina |
1da177e4 | 6 | */ |
1da177e4 | 7 | /* |
1da177e4 LT |
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 | */ | |
607ca46e DH |
13 | #ifndef __HID_H |
14 | #define __HID_H | |
1da177e4 | 15 | |
57d292bd | 16 | |
1c6ef16d | 17 | #include <linux/bitops.h> |
57d292bd JK |
18 | #include <linux/types.h> |
19 | #include <linux/slab.h> | |
20 | #include <linux/list.h> | |
e8c84f9a | 21 | #include <linux/mod_devicetable.h> /* hid_device_id */ |
57d292bd JK |
22 | #include <linux/timer.h> |
23 | #include <linux/workqueue.h> | |
24 | #include <linux/input.h> | |
4ea54542 | 25 | #include <linux/semaphore.h> |
aaac082d | 26 | #include <linux/mutex.h> |
4f5ca836 | 27 | #include <linux/power_supply.h> |
607ca46e | 28 | #include <uapi/linux/hid.h> |
f5c27da4 | 29 | #include <linux/hid_bpf.h> |
57d292bd | 30 | |
1da177e4 LT |
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 | __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 | |
05f091ab | 92 | #define HID_MAIN_ITEM_WRAP 0x008 |
1da177e4 LT |
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 | |
bcfa8d14 | 106 | #define HID_COLLECTION_NAMED_ARRAY 4 |
1da177e4 LT |
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 | |
05f091ab | 147 | #define HID_UP_GENDESK 0x00010000 |
0aebfdac | 148 | #define HID_UP_SIMULATION 0x00020000 |
4f5ca836 | 149 | #define HID_UP_GENDEVCTRLS 0x00060000 |
05f091ab DT |
150 | #define HID_UP_KEYBOARD 0x00070000 |
151 | #define HID_UP_LED 0x00080000 | |
152 | #define HID_UP_BUTTON 0x00090000 | |
153 | #define HID_UP_ORDINAL 0x000a0000 | |
f3dddf24 | 154 | #define HID_UP_TELEPHONY 0x000b0000 |
1da177e4 | 155 | #define HID_UP_CONSUMER 0x000c0000 |
05f091ab DT |
156 | #define HID_UP_DIGITIZER 0x000d0000 |
157 | #define HID_UP_PID 0x000f0000 | |
9de07a4e | 158 | #define HID_UP_BATTERY 0x00850000 |
740b2f03 | 159 | #define HID_UP_CAMERA 0x00900000 |
1da177e4 | 160 | #define HID_UP_HPVENDOR 0xff7f0000 |
929578ab | 161 | #define HID_UP_HPVENDOR2 0xff010000 |
1da177e4 | 162 | #define HID_UP_MSVENDOR 0xff000000 |
e875ce37 SP |
163 | #define HID_UP_CUSTOM 0x00ff0000 |
164 | #define HID_UP_LOGIVENDOR 0xffbc0000 | |
b466c1dd SW |
165 | #define HID_UP_LOGIVENDOR2 0xff090000 |
166 | #define HID_UP_LOGIVENDOR3 0xff430000 | |
f3d4ff0e | 167 | #define HID_UP_LNVENDOR 0xffa00000 |
83499b52 | 168 | #define HID_UP_SENSOR 0x00200000 |
957b8dff | 169 | #define HID_UP_ASUSVENDOR 0xff310000 |
14c9c014 | 170 | #define HID_UP_GOOGLEVENDOR 0xffd10000 |
1da177e4 LT |
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 | |
61df56be | 181 | /* |
6e7edabf HG |
182 | * Microsoft Win8 Wireless Radio Controls extensions CA, see: |
183 | * http://www.usb.org/developers/hidpage/HUTRR40RadioHIDUsagesFinal.pdf | |
61df56be HG |
184 | */ |
185 | #define HID_GD_WIRELESS_RADIO_CTLS 0x0001000c | |
ba6b055e BT |
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 | ||
1da177e4 LT |
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 | |
5a4abb36 | 215 | #define HID_GD_RESOLUTION_MULTIPLIER 0x00010048 |
6aef704e | 216 | #define HID_GD_SYSTEM_CONTROL 0x00010080 |
1da177e4 LT |
217 | #define HID_GD_UP 0x00010090 |
218 | #define HID_GD_DOWN 0x00010091 | |
219 | #define HID_GD_RIGHT 0x00010092 | |
220 | #define HID_GD_LEFT 0x00010093 | |
61df56be HG |
221 | /* Microsoft Win8 Wireless Radio Controls CA usage codes */ |
222 | #define HID_GD_RFKILL_BTN 0x000100c6 | |
223 | #define HID_GD_RFKILL_LED 0x000100c7 | |
224 | #define HID_GD_RFKILL_SWITCH 0x000100c8 | |
1da177e4 | 225 | |
4f5ca836 JF |
226 | #define HID_DC_BATTERYSTRENGTH 0x00060020 |
227 | ||
6aef704e | 228 | #define HID_CP_CONSUMER_CONTROL 0x000c0001 |
2dc702c9 | 229 | #define HID_CP_AC_PAN 0x000c0238 |
6aef704e | 230 | |
89f536cc SC |
231 | #define HID_DG_DIGITIZER 0x000d0001 |
232 | #define HID_DG_PEN 0x000d0002 | |
233 | #define HID_DG_LIGHTPEN 0x000d0003 | |
234 | #define HID_DG_TOUCHSCREEN 0x000d0004 | |
235 | #define HID_DG_TOUCHPAD 0x000d0005 | |
2fc00c1e | 236 | #define HID_DG_WHITEBOARD 0x000d0006 |
89f536cc SC |
237 | #define HID_DG_STYLUS 0x000d0020 |
238 | #define HID_DG_PUCK 0x000d0021 | |
239 | #define HID_DG_FINGER 0x000d0022 | |
240 | #define HID_DG_TIPPRESSURE 0x000d0030 | |
241 | #define HID_DG_BARRELPRESSURE 0x000d0031 | |
242 | #define HID_DG_INRANGE 0x000d0032 | |
243 | #define HID_DG_TOUCH 0x000d0033 | |
244 | #define HID_DG_UNTOUCH 0x000d0034 | |
245 | #define HID_DG_TAP 0x000d0035 | |
ae7fafa6 | 246 | #define HID_DG_TRANSDUCER_INDEX 0x000d0038 |
89f536cc SC |
247 | #define HID_DG_TABLETFUNCTIONKEY 0x000d0039 |
248 | #define HID_DG_PROGRAMCHANGEKEY 0x000d003a | |
93aab7fa | 249 | #define HID_DG_BATTERYSTRENGTH 0x000d003b |
89f536cc | 250 | #define HID_DG_INVERT 0x000d003c |
50066a04 JG |
251 | #define HID_DG_TILT_X 0x000d003d |
252 | #define HID_DG_TILT_Y 0x000d003e | |
253 | #define HID_DG_TWIST 0x000d0041 | |
89f536cc SC |
254 | #define HID_DG_TIPSWITCH 0x000d0042 |
255 | #define HID_DG_TIPSWITCH2 0x000d0043 | |
256 | #define HID_DG_BARRELSWITCH 0x000d0044 | |
257 | #define HID_DG_ERASER 0x000d0045 | |
258 | #define HID_DG_TABLETPICK 0x000d0046 | |
ae7fafa6 TK |
259 | #define HID_DG_PEN_COLOR 0x000d005c |
260 | #define HID_DG_PEN_LINE_WIDTH 0x000d005e | |
261 | #define HID_DG_PEN_LINE_STYLE 0x000d0070 | |
262 | #define HID_DG_PEN_LINE_STYLE_INK 0x000d0072 | |
263 | #define HID_DG_PEN_LINE_STYLE_PENCIL 0x000d0073 | |
264 | #define HID_DG_PEN_LINE_STYLE_HIGHLIGHTER 0x000d0074 | |
265 | #define HID_DG_PEN_LINE_STYLE_CHISEL_MARKER 0x000d0075 | |
266 | #define HID_DG_PEN_LINE_STYLE_BRUSH 0x000d0076 | |
267 | #define HID_DG_PEN_LINE_STYLE_NO_PREFERENCE 0x000d0077 | |
1a3f83f6 JC |
268 | |
269 | #define HID_CP_CONSUMERCONTROL 0x000c0001 | |
a45c30ec JC |
270 | #define HID_CP_NUMERICKEYPAD 0x000c0002 |
271 | #define HID_CP_PROGRAMMABLEBUTTONS 0x000c0003 | |
272 | #define HID_CP_MICROPHONE 0x000c0004 | |
273 | #define HID_CP_HEADPHONE 0x000c0005 | |
274 | #define HID_CP_GRAPHICEQUALIZER 0x000c0006 | |
275 | #define HID_CP_FUNCTIONBUTTONS 0x000c0036 | |
276 | #define HID_CP_SELECTION 0x000c0080 | |
277 | #define HID_CP_MEDIASELECTION 0x000c0087 | |
278 | #define HID_CP_SELECTDISC 0x000c00ba | |
f567d6ef MM |
279 | #define HID_CP_VOLUMEUP 0x000c00e9 |
280 | #define HID_CP_VOLUMEDOWN 0x000c00ea | |
a45c30ec JC |
281 | #define HID_CP_PLAYBACKSPEED 0x000c00f1 |
282 | #define HID_CP_PROXIMITY 0x000c0109 | |
283 | #define HID_CP_SPEAKERSYSTEM 0x000c0160 | |
284 | #define HID_CP_CHANNELLEFT 0x000c0161 | |
285 | #define HID_CP_CHANNELRIGHT 0x000c0162 | |
286 | #define HID_CP_CHANNELCENTER 0x000c0163 | |
287 | #define HID_CP_CHANNELFRONT 0x000c0164 | |
288 | #define HID_CP_CHANNELCENTERFRONT 0x000c0165 | |
289 | #define HID_CP_CHANNELSIDE 0x000c0166 | |
290 | #define HID_CP_CHANNELSURROUND 0x000c0167 | |
291 | #define HID_CP_CHANNELLOWFREQUENCYENHANCEMENT 0x000c0168 | |
292 | #define HID_CP_CHANNELTOP 0x000c0169 | |
293 | #define HID_CP_CHANNELUNKNOWN 0x000c016a | |
294 | #define HID_CP_APPLICATIONLAUNCHBUTTONS 0x000c0180 | |
295 | #define HID_CP_GENERICGUIAPPLICATIONCONTROLS 0x000c0200 | |
1a3f83f6 | 296 | |
959d973e XY |
297 | #define HID_DG_DEVICECONFIG 0x000d000e |
298 | #define HID_DG_DEVICESETTINGS 0x000d0023 | |
00720277 | 299 | #define HID_DG_AZIMUTH 0x000d003f |
89f536cc SC |
300 | #define HID_DG_CONFIDENCE 0x000d0047 |
301 | #define HID_DG_WIDTH 0x000d0048 | |
302 | #define HID_DG_HEIGHT 0x000d0049 | |
303 | #define HID_DG_CONTACTID 0x000d0051 | |
304 | #define HID_DG_INPUTMODE 0x000d0052 | |
305 | #define HID_DG_DEVICEINDEX 0x000d0053 | |
306 | #define HID_DG_CONTACTCOUNT 0x000d0054 | |
307 | #define HID_DG_CONTACTMAX 0x000d0055 | |
29cc309d | 308 | #define HID_DG_SCANTIME 0x000d0056 |
02946f4b BT |
309 | #define HID_DG_SURFACESWITCH 0x000d0057 |
310 | #define HID_DG_BUTTONSWITCH 0x000d0058 | |
2c6e0277 | 311 | #define HID_DG_BUTTONTYPE 0x000d0059 |
368c9664 PC |
312 | #define HID_DG_BARRELSWITCH2 0x000d005a |
313 | #define HID_DG_TOOLSERIALNUMBER 0x000d005b | |
02946f4b | 314 | #define HID_DG_LATENCYMODE 0x000d0060 |
89f536cc | 315 | |
9de07a4e | 316 | #define HID_BAT_ABSOLUTESTATEOFCHARGE 0x00850065 |
a608dc1c | 317 | #define HID_BAT_CHARGING 0x00850044 |
9de07a4e | 318 | |
957b8dff | 319 | #define HID_VD_ASUS_CUSTOM_MEDIA_KEYS 0xff310076 |
39054a5a | 320 | |
93c10132 JS |
321 | /* |
322 | * HID connect requests | |
323 | */ | |
324 | ||
c30e5989 BT |
325 | #define HID_CONNECT_HIDINPUT BIT(0) |
326 | #define HID_CONNECT_HIDINPUT_FORCE BIT(1) | |
327 | #define HID_CONNECT_HIDRAW BIT(2) | |
328 | #define HID_CONNECT_HIDDEV BIT(3) | |
329 | #define HID_CONNECT_HIDDEV_FORCE BIT(4) | |
330 | #define HID_CONNECT_FF BIT(5) | |
331 | #define HID_CONNECT_DRIVER BIT(6) | |
93c10132 JS |
332 | #define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \ |
333 | HID_CONNECT_HIDDEV|HID_CONNECT_FF) | |
334 | ||
1da177e4 LT |
335 | /* |
336 | * HID device quirks. | |
337 | */ | |
338 | ||
b79c1aba | 339 | /* |
876b9276 PW |
340 | * Increase this if you need to configure more HID quirks at module load time |
341 | */ | |
342 | #define MAX_USBHID_BOOT_QUIRKS 4 | |
343 | ||
87562fcd | 344 | /* BIT(0) reserved for backward compatibility, was HID_QUIRK_INVERT */ |
c30e5989 BT |
345 | #define HID_QUIRK_NOTOUCH BIT(1) |
346 | #define HID_QUIRK_IGNORE BIT(2) | |
347 | #define HID_QUIRK_NOGET BIT(3) | |
348 | #define HID_QUIRK_HIDDEV_FORCE BIT(4) | |
349 | #define HID_QUIRK_BADPAD BIT(5) | |
350 | #define HID_QUIRK_MULTI_INPUT BIT(6) | |
351 | #define HID_QUIRK_HIDINPUT_FORCE BIT(7) | |
39335d1c | 352 | /* BIT(8) reserved for backward compatibility, was HID_QUIRK_NO_EMPTY_INPUT */ |
c30e5989 BT |
353 | /* BIT(9) reserved for backward compatibility, was NO_INIT_INPUT_REPORTS */ |
354 | #define HID_QUIRK_ALWAYS_POLL BIT(10) | |
f07b3c1d | 355 | #define HID_QUIRK_INPUT_PER_APP BIT(11) |
fd8d135b AF |
356 | #define HID_QUIRK_X_INVERT BIT(12) |
357 | #define HID_QUIRK_Y_INVERT BIT(13) | |
c30e5989 BT |
358 | #define HID_QUIRK_SKIP_OUTPUT_REPORTS BIT(16) |
359 | #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID BIT(17) | |
360 | #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP BIT(18) | |
361 | #define HID_QUIRK_HAVE_SPECIAL_DRIVER BIT(19) | |
190d7f02 | 362 | #define HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE BIT(20) |
c30e5989 BT |
363 | #define HID_QUIRK_FULLSPEED_INTERVAL BIT(28) |
364 | #define HID_QUIRK_NO_INIT_REPORTS BIT(29) | |
365 | #define HID_QUIRK_NO_IGNORE BIT(30) | |
366 | #define HID_QUIRK_NO_INPUT_SYNC BIT(31) | |
ea9a4a8b | 367 | |
734c6609 HR |
368 | /* |
369 | * HID device groups | |
ba391e5a BT |
370 | * |
371 | * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h | |
372 | * and has a value of 0x0000 | |
734c6609 HR |
373 | */ |
374 | #define HID_GROUP_GENERIC 0x0001 | |
4fa3a583 | 375 | #define HID_GROUP_MULTITOUCH 0x0002 |
83499b52 | 376 | #define HID_GROUP_SENSOR_HUB 0x0003 |
f961bd35 | 377 | #define HID_GROUP_MULTITOUCH_WIN_8 0x0004 |
734c6609 | 378 | |
ba391e5a BT |
379 | /* |
380 | * Vendor specific HID device groups | |
381 | */ | |
382 | #define HID_GROUP_RMI 0x0100 | |
29b47391 | 383 | #define HID_GROUP_WACOM 0x0101 |
d610274b | 384 | #define HID_GROUP_LOGITECH_DJ_DEVICE 0x0102 |
c164d6ab | 385 | #define HID_GROUP_STEAM 0x0103 |
c9121cf6 | 386 | #define HID_GROUP_LOGITECH_27MHZ_DEVICE 0x0104 |
14c9c014 | 387 | #define HID_GROUP_VIVALDI 0x0105 |
29b47391 | 388 | |
b3c4ec71 AM |
389 | /* |
390 | * HID protocol status | |
391 | */ | |
392 | #define HID_REPORT_PROTOCOL 1 | |
393 | #define HID_BOOT_PROTOCOL 0 | |
394 | ||
1da177e4 LT |
395 | /* |
396 | * This is the global environment of the parser. This information is | |
397 | * persistent for main-items. The global environment can be saved and | |
398 | * restored with PUSH/POP statements. | |
399 | */ | |
400 | ||
401 | struct hid_global { | |
402 | unsigned usage_page; | |
403 | __s32 logical_minimum; | |
404 | __s32 logical_maximum; | |
405 | __s32 physical_minimum; | |
406 | __s32 physical_maximum; | |
407 | __s32 unit_exponent; | |
408 | unsigned unit; | |
409 | unsigned report_id; | |
410 | unsigned report_size; | |
411 | unsigned report_count; | |
412 | }; | |
413 | ||
414 | /* | |
415 | * This is the local environment. It is persistent up the next main-item. | |
416 | */ | |
417 | ||
5f1ab74f | 418 | #define HID_MAX_USAGES 12288 |
1da177e4 LT |
419 | #define HID_DEFAULT_NUM_COLLECTIONS 16 |
420 | ||
421 | struct hid_local { | |
422 | unsigned usage[HID_MAX_USAGES]; /* usage array */ | |
58e75155 | 423 | u8 usage_size[HID_MAX_USAGES]; /* usage size array */ |
1da177e4 LT |
424 | unsigned collection_index[HID_MAX_USAGES]; /* collection index array */ |
425 | unsigned usage_index; | |
426 | unsigned usage_minimum; | |
427 | unsigned delimiter_depth; | |
428 | unsigned delimiter_branch; | |
429 | }; | |
430 | ||
431 | /* | |
432 | * This is the collection stack. We climb up the stack to determine | |
433 | * application and function of each field. | |
434 | */ | |
435 | ||
436 | struct hid_collection { | |
ee46967f | 437 | int parent_idx; /* device->collection */ |
1da177e4 LT |
438 | unsigned type; |
439 | unsigned usage; | |
440 | unsigned level; | |
441 | }; | |
442 | ||
443 | struct hid_usage { | |
444 | unsigned hid; /* hid usage code */ | |
445 | unsigned collection_index; /* index into collection array */ | |
f262d1fa | 446 | unsigned usage_index; /* index into usage array */ |
5a4abb36 PH |
447 | __s8 resolution_multiplier;/* Effective Resolution Multiplier |
448 | (HUT v1.12, 4.3.1), default: 1 */ | |
1da177e4 | 449 | /* hidinput data */ |
2dc702c9 | 450 | __s8 wheel_factor; /* 120/resolution_multiplier */ |
1da177e4 LT |
451 | __u16 code; /* input driver code */ |
452 | __u8 type; /* input driver type */ | |
453 | __s8 hat_min; /* hat switch fun */ | |
454 | __s8 hat_max; /* ditto */ | |
455 | __s8 hat_dir; /* ditto */ | |
2dc702c9 | 456 | __s16 wheel_accumulated; /* hi-res wheel */ |
1da177e4 LT |
457 | }; |
458 | ||
459 | struct hid_input; | |
460 | ||
461 | struct hid_field { | |
462 | unsigned physical; /* physical usage for this field */ | |
463 | unsigned logical; /* logical usage for this field */ | |
464 | unsigned application; /* application usage for this field */ | |
465 | struct hid_usage *usage; /* usage table for this function */ | |
466 | unsigned maxusage; /* maximum usage index */ | |
467 | unsigned flags; /* main-item flags (i.e. volatile,array,constant) */ | |
468 | unsigned report_offset; /* bit offset in the report */ | |
469 | unsigned report_size; /* size of this field in the report */ | |
470 | unsigned report_count; /* number of this field in the report */ | |
471 | unsigned report_type; /* (input,output,feature) */ | |
472 | __s32 *value; /* last known value(s) */ | |
1c1813a7 | 473 | __s32 *new_value; /* newly read value(s) */ |
048cddfd BT |
474 | __s32 *usages_priorities; /* priority of each usage when reading the report |
475 | * bits 8-16 are reserved for hid-input usage | |
476 | */ | |
1da177e4 LT |
477 | __s32 logical_minimum; |
478 | __s32 logical_maximum; | |
479 | __s32 physical_minimum; | |
480 | __s32 physical_maximum; | |
481 | __s32 unit_exponent; | |
482 | unsigned unit; | |
b79c1aba | 483 | bool ignored; /* this field is ignored in this event */ |
1da177e4 LT |
484 | struct hid_report *report; /* associated report */ |
485 | unsigned index; /* index into report->field[] */ | |
486 | /* hidinput data */ | |
487 | struct hid_input *hidinput; /* associated input structure */ | |
488 | __u16 dpad; /* dpad input code */ | |
5c20000a | 489 | unsigned int slot_idx; /* slot index in a report */ |
1da177e4 LT |
490 | }; |
491 | ||
7e55bded | 492 | #define HID_MAX_FIELDS 256 |
1da177e4 | 493 | |
22f4b026 BT |
494 | struct hid_field_entry { |
495 | struct list_head list; | |
496 | struct hid_field *field; | |
497 | unsigned int index; | |
498 | __s32 priority; | |
499 | }; | |
500 | ||
1da177e4 LT |
501 | struct hid_report { |
502 | struct list_head list; | |
e1b63c01 | 503 | struct list_head hidinput_list; |
22f4b026 | 504 | struct list_head field_entry_list; /* ordered list of input fields */ |
f07b3c1d | 505 | unsigned int id; /* id of this report */ |
ead77b65 | 506 | enum hid_report_type type; /* report type */ |
f07b3c1d | 507 | unsigned int application; /* application usage for this report */ |
1da177e4 | 508 | struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */ |
22f4b026 | 509 | struct hid_field_entry *field_entries; /* allocated memory of input field_entry */ |
1da177e4 LT |
510 | unsigned maxfield; /* maximum valid field index */ |
511 | unsigned size; /* size of the report (bits) */ | |
512 | struct hid_device *device; /* associated device */ | |
87562fcd BT |
513 | |
514 | /* tool related state */ | |
515 | bool tool_active; /* whether the current tool is active */ | |
516 | unsigned int tool; /* BTN_TOOL_* */ | |
1da177e4 LT |
517 | }; |
518 | ||
43622021 KC |
519 | #define HID_MAX_IDS 256 |
520 | ||
1da177e4 LT |
521 | struct hid_report_enum { |
522 | unsigned numbered; | |
523 | struct list_head report_list; | |
43622021 | 524 | struct hid_report *report_id_hash[HID_MAX_IDS]; |
1da177e4 LT |
525 | }; |
526 | ||
bf0964dc | 527 | #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */ |
6a0eaf51 | 528 | #define HID_MAX_BUFFER_SIZE 16384 /* 16kb */ |
1da177e4 LT |
529 | #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */ |
530 | #define HID_OUTPUT_FIFO_SIZE 64 | |
531 | ||
532 | struct hid_control_fifo { | |
533 | unsigned char dir; | |
534 | struct hid_report *report; | |
f129ea6d AH |
535 | char *raw_report; |
536 | }; | |
537 | ||
538 | struct hid_output_fifo { | |
539 | struct hid_report *report; | |
540 | char *raw_report; | |
1da177e4 LT |
541 | }; |
542 | ||
1c6ef16d BT |
543 | #define HID_CLAIMED_INPUT BIT(0) |
544 | #define HID_CLAIMED_HIDDEV BIT(1) | |
545 | #define HID_CLAIMED_HIDRAW BIT(2) | |
546 | #define HID_CLAIMED_DRIVER BIT(3) | |
1da177e4 | 547 | |
1c6ef16d BT |
548 | #define HID_STAT_ADDED BIT(0) |
549 | #define HID_STAT_PARSED BIT(1) | |
190d7f02 | 550 | #define HID_STAT_DUP_DETECTED BIT(2) |
8f732850 | 551 | #define HID_STAT_REPROBED BIT(3) |
85cdaf52 | 552 | |
1da177e4 LT |
553 | struct hid_input { |
554 | struct list_head list; | |
555 | struct hid_report *report; | |
c5b7c7c3 | 556 | struct input_dev *input; |
c554bb04 | 557 | const char *name; |
72d19459 | 558 | bool registered; |
e1b63c01 | 559 | struct list_head reports; /* the list of reports */ |
0d6c3011 | 560 | unsigned int application; /* application usage for this input */ |
1da177e4 LT |
561 | }; |
562 | ||
a73a6370 JS |
563 | enum hid_type { |
564 | HID_TYPE_OTHER = 0, | |
6dc1418e TS |
565 | HID_TYPE_USBMOUSE, |
566 | HID_TYPE_USBNONE | |
a73a6370 JS |
567 | }; |
568 | ||
2e210bbb DT |
569 | enum hid_battery_status { |
570 | HID_BATTERY_UNKNOWN = 0, | |
571 | HID_BATTERY_QUERIED, /* Kernel explicitly queried battery strength */ | |
572 | HID_BATTERY_REPORTED, /* Device sent unsolicited battery strength report */ | |
573 | }; | |
574 | ||
85cdaf52 | 575 | struct hid_driver; |
c500c971 | 576 | struct hid_ll_driver; |
85cdaf52 | 577 | |
1da177e4 | 578 | struct hid_device { /* device report descriptor */ |
a7197c2e HR |
579 | __u8 *dev_rdesc; |
580 | unsigned dev_rsize; | |
85cdaf52 | 581 | __u8 *rdesc; |
1da177e4 LT |
582 | unsigned rsize; |
583 | struct hid_collection *collection; /* List of HID collections */ | |
584 | unsigned collection_size; /* Number of allocated hid_collections */ | |
585 | unsigned maxcollection; /* Number of parsed collections */ | |
586 | unsigned maxapplication; /* Number of applications */ | |
85cdaf52 | 587 | __u16 bus; /* BUS ID */ |
4d53b801 | 588 | __u16 group; /* Report group */ |
85cdaf52 JS |
589 | __u32 vendor; /* Vendor ID */ |
590 | __u32 product; /* Product ID */ | |
591 | __u32 version; /* HID version */ | |
a73a6370 | 592 | enum hid_type type; /* device type (mouse, kbd, ...) */ |
1da177e4 LT |
593 | unsigned country; /* HID country */ |
594 | struct hid_report_enum report_enum[HID_REPORT_TYPES]; | |
50c9d75b | 595 | struct work_struct led_work; /* delayed LED worker */ |
1da177e4 | 596 | |
c849a614 | 597 | struct semaphore driver_input_lock; /* protects the current driver */ |
85cdaf52 JS |
598 | struct device dev; /* device */ |
599 | struct hid_driver *driver; | |
aaac082d | 600 | |
52d22534 | 601 | const struct hid_ll_driver *ll_driver; |
aaac082d DT |
602 | struct mutex ll_open_lock; |
603 | unsigned int ll_open_count; | |
1da177e4 | 604 | |
4f5ca836 JF |
605 | #ifdef CONFIG_HID_BATTERY_STRENGTH |
606 | /* | |
607 | * Power supply information for HID devices which report | |
297d716f KK |
608 | * battery strength. power_supply was successfully registered if |
609 | * battery is non-NULL. | |
4f5ca836 | 610 | */ |
297d716f | 611 | struct power_supply *battery; |
581c4484 | 612 | __s32 battery_capacity; |
4f5ca836 JF |
613 | __s32 battery_min; |
614 | __s32 battery_max; | |
fb8ac91b | 615 | __s32 battery_report_type; |
c5a92aa3 | 616 | __s32 battery_report_id; |
a608dc1c | 617 | __s32 battery_charge_status; |
2e210bbb DT |
618 | enum hid_battery_status battery_status; |
619 | bool battery_avoid_query; | |
c6838eee | 620 | ktime_t battery_ratelimit_time; |
4f5ca836 JF |
621 | #endif |
622 | ||
8f732850 | 623 | unsigned long status; /* see STAT flags above */ |
05f091ab | 624 | unsigned claimed; /* Claimed by hidinput, hiddev? */ |
1da177e4 | 625 | unsigned quirks; /* Various quirks the device can pull on us */ |
03a86105 | 626 | unsigned initial_quirks; /* Initial set of quirks supplied when creating device */ |
6f68f0ac | 627 | bool io_started; /* If IO has started */ |
1da177e4 LT |
628 | |
629 | struct list_head inputs; /* The list of inputs */ | |
630 | void *hiddev; /* The hiddev structure */ | |
86166b7b | 631 | void *hidraw; |
1da177e4 | 632 | |
1da177e4 LT |
633 | char name[128]; /* Device name */ |
634 | char phys[64]; /* Device physical location */ | |
635 | char uniq[64]; /* Device unique identifier (serial #) */ | |
636 | ||
229695e5 JK |
637 | void *driver_data; |
638 | ||
93c10132 JS |
639 | /* temporary hid_ff handling (until moved to the drivers) */ |
640 | int (*ff_init)(struct hid_device *); | |
641 | ||
aa938f79 | 642 | /* hiddev event handler */ |
93c10132 | 643 | int (*hiddev_connect)(struct hid_device *, unsigned int); |
c4c259bc | 644 | void (*hiddev_disconnect)(struct hid_device *); |
aa938f79 JK |
645 | void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field, |
646 | struct hid_usage *, __s32); | |
aa8de2f0 | 647 | void (*hiddev_report_event) (struct hid_device *, struct hid_report *); |
86166b7b | 648 | |
cd667ce2 JK |
649 | /* debugging support via debugfs */ |
650 | unsigned short debug; | |
651 | struct dentry *debug_dir; | |
652 | struct dentry *debug_rdesc; | |
653 | struct dentry *debug_events; | |
654 | struct list_head debug_list; | |
1deb9d34 | 655 | spinlock_t debug_list_lock; |
cd667ce2 | 656 | wait_queue_head_t debug_wait; |
1e839143 BT |
657 | |
658 | unsigned int id; /* system unique id */ | |
f5c27da4 BT |
659 | |
660 | #ifdef CONFIG_BPF | |
661 | struct hid_bpf bpf; /* hid-bpf data */ | |
662 | #endif /* CONFIG_BPF */ | |
1da177e4 LT |
663 | }; |
664 | ||
d8ce9bf5 GT |
665 | #define to_hid_device(pdev) \ |
666 | container_of(pdev, struct hid_device, dev) | |
667 | ||
85cdaf52 JS |
668 | static inline void *hid_get_drvdata(struct hid_device *hdev) |
669 | { | |
670 | return dev_get_drvdata(&hdev->dev); | |
671 | } | |
672 | ||
673 | static inline void hid_set_drvdata(struct hid_device *hdev, void *data) | |
674 | { | |
675 | dev_set_drvdata(&hdev->dev, data); | |
676 | } | |
677 | ||
1da177e4 LT |
678 | #define HID_GLOBAL_STACK_SIZE 4 |
679 | #define HID_COLLECTION_STACK_SIZE 4 | |
680 | ||
e39f2d59 AD |
681 | #define HID_SCAN_FLAG_MT_WIN_8 BIT(0) |
682 | #define HID_SCAN_FLAG_VENDOR_SPECIFIC BIT(1) | |
683 | #define HID_SCAN_FLAG_GD_POINTER BIT(2) | |
f961bd35 | 684 | |
1da177e4 LT |
685 | struct hid_parser { |
686 | struct hid_global global; | |
687 | struct hid_global global_stack[HID_GLOBAL_STACK_SIZE]; | |
08a8a7cf | 688 | unsigned int global_stack_ptr; |
1da177e4 | 689 | struct hid_local local; |
08a8a7cf BT |
690 | unsigned int *collection_stack; |
691 | unsigned int collection_stack_ptr; | |
692 | unsigned int collection_stack_size; | |
1da177e4 | 693 | struct hid_device *device; |
08a8a7cf | 694 | unsigned int scan_flags; |
1da177e4 LT |
695 | }; |
696 | ||
697 | struct hid_class_descriptor { | |
698 | __u8 bDescriptorType; | |
01d7b369 | 699 | __le16 wDescriptorLength; |
1da177e4 LT |
700 | } __attribute__ ((packed)); |
701 | ||
702 | struct hid_descriptor { | |
703 | __u8 bLength; | |
704 | __u8 bDescriptorType; | |
01d7b369 | 705 | __le16 bcdHID; |
1da177e4 LT |
706 | __u8 bCountryCode; |
707 | __u8 bNumDescriptors; | |
708 | ||
709 | struct hid_class_descriptor desc[1]; | |
710 | } __attribute__ ((packed)); | |
711 | ||
070748ed HR |
712 | #define HID_DEVICE(b, g, ven, prod) \ |
713 | .bus = (b), .group = (g), .vendor = (ven), .product = (prod) | |
714 | #define HID_USB_DEVICE(ven, prod) \ | |
715 | .bus = BUS_USB, .vendor = (ven), .product = (prod) | |
716 | #define HID_BLUETOOTH_DEVICE(ven, prod) \ | |
717 | .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod) | |
9fb6bf02 BT |
718 | #define HID_I2C_DEVICE(ven, prod) \ |
719 | .bus = BUS_I2C, .vendor = (ven), .product = (prod) | |
85cdaf52 JS |
720 | |
721 | #define HID_REPORT_ID(rep) \ | |
722 | .report_type = (rep) | |
723 | #define HID_USAGE_ID(uhid, utype, ucode) \ | |
724 | .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode) | |
725 | /* we don't want to catch types and codes equal to 0 */ | |
726 | #define HID_TERMINATOR (HID_ANY_ID - 1) | |
727 | ||
728 | struct hid_report_id { | |
729 | __u32 report_type; | |
730 | }; | |
731 | struct hid_usage_id { | |
732 | __u32 usage_hid; | |
733 | __u32 usage_type; | |
734 | __u32 usage_code; | |
735 | }; | |
736 | ||
737 | /** | |
738 | * struct hid_driver | |
739 | * @name: driver name (e.g. "Footech_bar-wheel") | |
740 | * @id_table: which devices is this driver for (must be non-NULL for probe | |
741 | * to be called) | |
3a6f82f7 JS |
742 | * @dyn_list: list of dynamically added device ids |
743 | * @dyn_lock: lock protecting @dyn_list | |
e04a0442 | 744 | * @match: check if the given device is handled by this driver |
85cdaf52 JS |
745 | * @probe: new device inserted |
746 | * @remove: device removed (NULL if not a hot-plug capable driver) | |
747 | * @report_table: on which reports to call raw_event (NULL means all) | |
748 | * @raw_event: if report in report_table, this hook is called (NULL means nop) | |
749 | * @usage_table: on which events to call event (NULL means all) | |
750 | * @event: if usage in usage_table, this hook is called (NULL means nop) | |
6d85d037 | 751 | * @report: this hook is called after parsing a report (NULL means nop) |
c500c971 JS |
752 | * @report_fixup: called before report descriptor parsing (NULL means nop) |
753 | * @input_mapping: invoked on input registering before mapping an usage | |
754 | * @input_mapped: invoked on input registering after mapping an usage | |
9ebf3d76 | 755 | * @input_configured: invoked just before the device is registered |
0d2689c0 | 756 | * @feature_mapping: invoked on feature registering |
6a740aa4 BP |
757 | * @suspend: invoked on suspend (NULL means nop) |
758 | * @resume: invoked on resume if device was not reset (NULL means nop) | |
759 | * @reset_resume: invoked on resume if device was reset (NULL means nop) | |
85cdaf52 | 760 | * |
c849a614 AR |
761 | * probe should return -errno on error, or 0 on success. During probe, |
762 | * input will not be passed to raw_event unless hid_device_io_start is | |
763 | * called. | |
764 | * | |
aa9b760c LW |
765 | * raw_event and event should return negative on error, any other value will |
766 | * pass the event on to .event() typically return 0 for success. | |
c500c971 JS |
767 | * |
768 | * input_mapping shall return a negative value to completely ignore this usage | |
769 | * (e.g. doubled or invalid usage), zero to continue with parsing of this | |
770 | * usage by generic code (no special handling needed) or positive to skip | |
771 | * generic parsing (needed special handling which was done in the hook already) | |
772 | * input_mapped shall return negative to inform the layer that this usage | |
773 | * should not be considered for further processing or zero to notify that | |
774 | * no processing was performed and should be done in a generic manner | |
775 | * Both these functions may be NULL which means the same behavior as returning | |
776 | * zero from them. | |
85cdaf52 JS |
777 | */ |
778 | struct hid_driver { | |
779 | char *name; | |
780 | const struct hid_device_id *id_table; | |
781 | ||
3a6f82f7 JS |
782 | struct list_head dyn_list; |
783 | spinlock_t dyn_lock; | |
784 | ||
e04a0442 | 785 | bool (*match)(struct hid_device *dev, bool ignore_special_driver); |
85cdaf52 JS |
786 | int (*probe)(struct hid_device *dev, const struct hid_device_id *id); |
787 | void (*remove)(struct hid_device *dev); | |
788 | ||
789 | const struct hid_report_id *report_table; | |
790 | int (*raw_event)(struct hid_device *hdev, struct hid_report *report, | |
791 | u8 *data, int size); | |
792 | const struct hid_usage_id *usage_table; | |
793 | int (*event)(struct hid_device *hdev, struct hid_field *field, | |
794 | struct hid_usage *usage, __s32 value); | |
6d85d037 | 795 | void (*report)(struct hid_device *hdev, struct hid_report *report); |
c500c971 | 796 | |
73e4008d NK |
797 | __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf, |
798 | unsigned int *size); | |
c500c971 JS |
799 | |
800 | int (*input_mapping)(struct hid_device *hdev, | |
801 | struct hid_input *hidinput, struct hid_field *field, | |
802 | struct hid_usage *usage, unsigned long **bit, int *max); | |
803 | int (*input_mapped)(struct hid_device *hdev, | |
804 | struct hid_input *hidinput, struct hid_field *field, | |
805 | struct hid_usage *usage, unsigned long **bit, int *max); | |
9154301a DT |
806 | int (*input_configured)(struct hid_device *hdev, |
807 | struct hid_input *hidinput); | |
0d2689c0 | 808 | void (*feature_mapping)(struct hid_device *hdev, |
f635bd11 | 809 | struct hid_field *field, |
0d2689c0 | 810 | struct hid_usage *usage); |
6a740aa4 BP |
811 | #ifdef CONFIG_PM |
812 | int (*suspend)(struct hid_device *hdev, pm_message_t message); | |
813 | int (*resume)(struct hid_device *hdev); | |
814 | int (*reset_resume)(struct hid_device *hdev); | |
815 | #endif | |
85cdaf52 JS |
816 | /* private: */ |
817 | struct device_driver driver; | |
818 | }; | |
819 | ||
ba91a967 GT |
820 | #define to_hid_driver(pdrv) \ |
821 | container_of(pdrv, struct hid_driver, driver) | |
822 | ||
c500c971 | 823 | /** |
3809fe47 | 824 | * struct hid_ll_driver - low level driver callbacks |
c500c971 JS |
825 | * @start: called on probe to start the device |
826 | * @stop: called on remove | |
827 | * @open: called by input layer on open | |
828 | * @close: called by input layer on close | |
4f210c29 | 829 | * @power: request underlying hardware to enter requested power mode |
c500c971 JS |
830 | * @parse: this method is called only once to parse the device data, |
831 | * shouldn't allocate anything to not leak memory | |
e90a6df8 | 832 | * @request: send report request to device (e.g. feature report) |
3373443b | 833 | * @wait: wait for buffered io to complete (send/recv reports) |
b69d6536 BT |
834 | * @raw_request: send raw report request to device (e.g. feature report) |
835 | * @output_report: send output report to device | |
9684819b | 836 | * @idle: send idle request to device |
24e166f4 | 837 | * @may_wakeup: return if device may act as a wakeup source during system-suspend |
b1a37ed0 | 838 | * @max_buffer_size: over-ride maximum data buffer size (default: HID_MAX_BUFFER_SIZE) |
c500c971 JS |
839 | */ |
840 | struct hid_ll_driver { | |
841 | int (*start)(struct hid_device *hdev); | |
842 | void (*stop)(struct hid_device *hdev); | |
843 | ||
844 | int (*open)(struct hid_device *hdev); | |
845 | void (*close)(struct hid_device *hdev); | |
846 | ||
0361a28d ON |
847 | int (*power)(struct hid_device *hdev, int level); |
848 | ||
c500c971 | 849 | int (*parse)(struct hid_device *hdev); |
e90a6df8 HR |
850 | |
851 | void (*request)(struct hid_device *hdev, | |
852 | struct hid_report *report, int reqtype); | |
853 | ||
3373443b HR |
854 | int (*wait)(struct hid_device *hdev); |
855 | ||
cd4dc082 FP |
856 | int (*raw_request) (struct hid_device *hdev, unsigned char reportnum, |
857 | __u8 *buf, size_t len, unsigned char rtype, | |
858 | int reqtype); | |
859 | ||
860 | int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len); | |
861 | ||
862 | int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype); | |
24e166f4 | 863 | bool (*may_wakeup)(struct hid_device *hdev); |
b1a37ed0 LJ |
864 | |
865 | unsigned int max_buffer_size; | |
c500c971 JS |
866 | }; |
867 | ||
8c3e2406 | 868 | extern bool hid_is_usb(const struct hid_device *hdev); |
f83baa0c | 869 | |
0361a28d ON |
870 | #define PM_HINT_FULLON 1<<5 |
871 | #define PM_HINT_NORMAL 1<<1 | |
872 | ||
1da177e4 LT |
873 | /* Applications from HID Usage Tables 4/8/99 Version 1.1 */ |
874 | /* We ignore a few input applications that are not widely used */ | |
2fc00c1e CC |
875 | #define IS_INPUT_APPLICATION(a) \ |
876 | (((a >= HID_UP_GENDESK) && (a <= HID_GD_MULTIAXIS)) \ | |
a0f52767 | 877 | || ((a >= HID_DG_DIGITIZER) && (a <= HID_DG_WHITEBOARD)) \ |
7f559274 CC |
878 | || (a == HID_GD_SYSTEM_CONTROL) || (a == HID_CP_CONSUMER_CONTROL) \ |
879 | || (a == HID_GD_WIRELESS_RADIO_CTLS)) | |
229695e5 JK |
880 | |
881 | /* HID core API */ | |
58037eb9 | 882 | |
4529eefa | 883 | extern bool hid_ignore(struct hid_device *); |
85cdaf52 JS |
884 | extern int hid_add_device(struct hid_device *); |
885 | extern void hid_destroy_device(struct hid_device *); | |
886 | ||
e04a0442 BT |
887 | extern struct bus_type hid_bus_type; |
888 | ||
85cdaf52 JS |
889 | extern int __must_check __hid_register_driver(struct hid_driver *, |
890 | struct module *, const char *mod_name); | |
eb5589a8 PG |
891 | |
892 | /* use a define to avoid include chaining to get THIS_MODULE & friends */ | |
893 | #define hid_register_driver(driver) \ | |
894 | __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME) | |
895 | ||
85cdaf52 JS |
896 | extern void hid_unregister_driver(struct hid_driver *); |
897 | ||
4d02c58e HS |
898 | /** |
899 | * module_hid_driver() - Helper macro for registering a HID driver | |
900 | * @__hid_driver: hid_driver struct | |
901 | * | |
902 | * Helper macro for HID drivers which do not do anything special in module | |
903 | * init/exit. This eliminates a lot of boilerplate. Each module may only | |
904 | * use this macro once, and calling it replaces module_init() and module_exit() | |
905 | */ | |
906 | #define module_hid_driver(__hid_driver) \ | |
907 | module_driver(__hid_driver, hid_register_driver, \ | |
908 | hid_unregister_driver) | |
909 | ||
7d12e780 | 910 | extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32); |
1da177e4 | 911 | extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report); |
93c10132 | 912 | extern int hidinput_connect(struct hid_device *hid, unsigned int force); |
1da177e4 | 913 | extern void hidinput_disconnect(struct hid_device *); |
1da177e4 | 914 | |
1da177e4 | 915 | int hid_set_field(struct hid_field *, unsigned, __s32); |
ead77b65 BT |
916 | int hid_input_report(struct hid_device *hid, enum hid_report_type type, u8 *data, u32 size, |
917 | int interrupt); | |
4371ea82 DK |
918 | struct hid_field *hidinput_get_led_field(struct hid_device *hid); |
919 | unsigned int hidinput_count_leds(struct hid_device *hid); | |
37cf6e6f | 920 | __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code); |
dde5845a | 921 | void hid_output_report(struct hid_report *report, __u8 *data); |
735e1bb1 | 922 | int __hid_request(struct hid_device *hid, struct hid_report *rep, enum hid_class_request reqtype); |
27ce4050 | 923 | u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags); |
85cdaf52 | 924 | struct hid_device *hid_allocate_device(void); |
f07b3c1d | 925 | struct hid_report *hid_register_report(struct hid_device *device, |
ead77b65 | 926 | enum hid_report_type type, unsigned int id, |
f07b3c1d | 927 | unsigned int application); |
85cdaf52 | 928 | int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size); |
331415ff | 929 | struct hid_report *hid_validate_values(struct hid_device *hid, |
ead77b65 | 930 | enum hid_report_type type, unsigned int id, |
331415ff KC |
931 | unsigned int field_index, |
932 | unsigned int report_counts); | |
5a4abb36 PH |
933 | |
934 | void hid_setup_resolution_multiplier(struct hid_device *hid); | |
a7197c2e | 935 | int hid_open_report(struct hid_device *device); |
0361a28d | 936 | int hid_check_keys_pressed(struct hid_device *hid); |
93c10132 | 937 | int hid_connect(struct hid_device *hid, unsigned int connect_mask); |
c4c259bc | 938 | void hid_disconnect(struct hid_device *hid); |
d5d3e202 BT |
939 | bool hid_match_one_id(const struct hid_device *hdev, |
940 | const struct hid_device_id *id); | |
941 | const struct hid_device_id *hid_match_id(const struct hid_device *hdev, | |
bbc21cfd | 942 | const struct hid_device_id *id); |
e04a0442 BT |
943 | const struct hid_device_id *hid_match_device(struct hid_device *hdev, |
944 | struct hid_driver *hdrv); | |
1a8861f1 DL |
945 | bool hid_compare_device_paths(struct hid_device *hdev_a, |
946 | struct hid_device *hdev_b, char separator); | |
77463838 | 947 | s32 hid_snto32(__u32 value, unsigned n); |
04fba786 GB |
948 | __u32 hid_field_extract(const struct hid_device *hid, __u8 *report, |
949 | unsigned offset, unsigned n); | |
85cdaf52 | 950 | |
9e356208 BT |
951 | #ifdef CONFIG_PM |
952 | int hid_driver_suspend(struct hid_device *hdev, pm_message_t state); | |
953 | int hid_driver_reset_resume(struct hid_device *hdev); | |
954 | int hid_driver_resume(struct hid_device *hdev); | |
955 | #else | |
956 | static inline int hid_driver_suspend(struct hid_device *hdev, pm_message_t state) { return 0; } | |
957 | static inline int hid_driver_reset_resume(struct hid_device *hdev) { return 0; } | |
958 | static inline int hid_driver_resume(struct hid_device *hdev) { return 0; } | |
959 | #endif | |
960 | ||
c849a614 AR |
961 | /** |
962 | * hid_device_io_start - enable HID input during probe, remove | |
963 | * | |
ceecd1bf | 964 | * @hid: the device |
c849a614 AR |
965 | * |
966 | * This should only be called during probe or remove and only be | |
967 | * called by the thread calling probe or remove. It will allow | |
968 | * incoming packets to be delivered to the driver. | |
969 | */ | |
970 | static inline void hid_device_io_start(struct hid_device *hid) { | |
971 | if (hid->io_started) { | |
6c3f70ac | 972 | dev_warn(&hid->dev, "io already started\n"); |
c849a614 AR |
973 | return; |
974 | } | |
975 | hid->io_started = true; | |
976 | up(&hid->driver_input_lock); | |
977 | } | |
978 | ||
979 | /** | |
980 | * hid_device_io_stop - disable HID input during probe, remove | |
981 | * | |
ceecd1bf | 982 | * @hid: the device |
c849a614 AR |
983 | * |
984 | * Should only be called after hid_device_io_start. It will prevent | |
985 | * incoming packets from going to the driver for the duration of | |
986 | * probe, remove. If called during probe, packets will still go to the | |
987 | * driver after probe is complete. This function should only be called | |
988 | * by the thread calling probe or remove. | |
989 | */ | |
990 | static inline void hid_device_io_stop(struct hid_device *hid) { | |
991 | if (!hid->io_started) { | |
6c3f70ac | 992 | dev_warn(&hid->dev, "io already stopped\n"); |
c849a614 AR |
993 | return; |
994 | } | |
995 | hid->io_started = false; | |
996 | down(&hid->driver_input_lock); | |
997 | } | |
998 | ||
022e8c4d JS |
999 | /** |
1000 | * hid_map_usage - map usage input bits | |
1001 | * | |
1002 | * @hidinput: hidinput which we are interested in | |
1003 | * @usage: usage to fill in | |
1004 | * @bit: pointer to input->{}bit (out parameter) | |
1005 | * @max: maximal valid usage->code to consider later (out parameter) | |
1006 | * @type: input event type (EV_KEY, EV_REL, ...) | |
1007 | * @c: code which corresponds to this usage and type | |
35556bed MZ |
1008 | * |
1009 | * The value pointed to by @bit will be set to NULL if either @type is | |
1010 | * an unhandled event type, or if @c is out of range for @type. This | |
1011 | * can be used as an error condition. | |
022e8c4d JS |
1012 | */ |
1013 | static inline void hid_map_usage(struct hid_input *hidinput, | |
1014 | struct hid_usage *usage, unsigned long **bit, int *max, | |
35556bed | 1015 | __u8 type, unsigned int c) |
022e8c4d JS |
1016 | { |
1017 | struct input_dev *input = hidinput->input; | |
35556bed MZ |
1018 | unsigned long *bmap = NULL; |
1019 | unsigned int limit = 0; | |
022e8c4d JS |
1020 | |
1021 | switch (type) { | |
1022 | case EV_ABS: | |
35556bed MZ |
1023 | bmap = input->absbit; |
1024 | limit = ABS_MAX; | |
022e8c4d JS |
1025 | break; |
1026 | case EV_REL: | |
35556bed MZ |
1027 | bmap = input->relbit; |
1028 | limit = REL_MAX; | |
022e8c4d JS |
1029 | break; |
1030 | case EV_KEY: | |
35556bed MZ |
1031 | bmap = input->keybit; |
1032 | limit = KEY_MAX; | |
022e8c4d JS |
1033 | break; |
1034 | case EV_LED: | |
35556bed MZ |
1035 | bmap = input->ledbit; |
1036 | limit = LED_MAX; | |
022e8c4d | 1037 | break; |
8aa45b54 MW |
1038 | case EV_MSC: |
1039 | bmap = input->mscbit; | |
1040 | limit = MSC_MAX; | |
1041 | break; | |
022e8c4d | 1042 | } |
35556bed MZ |
1043 | |
1044 | if (unlikely(c > limit || !bmap)) { | |
1045 | pr_warn_ratelimited("%s: Invalid code %d type %d\n", | |
1046 | input->name, c, type); | |
1047 | *bit = NULL; | |
1048 | return; | |
1049 | } | |
1050 | ||
1051 | usage->type = type; | |
1052 | usage->code = c; | |
1053 | *max = limit; | |
1054 | *bit = bmap; | |
022e8c4d JS |
1055 | } |
1056 | ||
1057 | /** | |
1058 | * hid_map_usage_clear - map usage input bits and clear the input bit | |
1059 | * | |
ceecd1bf RD |
1060 | * @hidinput: hidinput which we are interested in |
1061 | * @usage: usage to fill in | |
1062 | * @bit: pointer to input->{}bit (out parameter) | |
1063 | * @max: maximal valid usage->code to consider later (out parameter) | |
1064 | * @type: input event type (EV_KEY, EV_REL, ...) | |
1065 | * @c: code which corresponds to this usage and type | |
1066 | * | |
022e8c4d JS |
1067 | * The same as hid_map_usage, except the @c bit is also cleared in supported |
1068 | * bits (@bit). | |
1069 | */ | |
1070 | static inline void hid_map_usage_clear(struct hid_input *hidinput, | |
1071 | struct hid_usage *usage, unsigned long **bit, int *max, | |
1072 | __u8 type, __u16 c) | |
1073 | { | |
1074 | hid_map_usage(hidinput, usage, bit, max, type, c); | |
35556bed MZ |
1075 | if (*bit) |
1076 | clear_bit(usage->code, *bit); | |
022e8c4d JS |
1077 | } |
1078 | ||
c500c971 JS |
1079 | /** |
1080 | * hid_parse - parse HW reports | |
1081 | * | |
1082 | * @hdev: hid device | |
1083 | * | |
1084 | * Call this from probe after you set up the device (if needed). Your | |
1085 | * report_fixup will be called (if non-NULL) after reading raw report from | |
1086 | * device before passing it to hid layer for real parsing. | |
1087 | */ | |
1088 | static inline int __must_check hid_parse(struct hid_device *hdev) | |
1089 | { | |
a7197c2e | 1090 | return hid_open_report(hdev); |
c500c971 JS |
1091 | } |
1092 | ||
aaac082d DT |
1093 | int __must_check hid_hw_start(struct hid_device *hdev, |
1094 | unsigned int connect_mask); | |
1095 | void hid_hw_stop(struct hid_device *hdev); | |
1096 | int __must_check hid_hw_open(struct hid_device *hdev); | |
1097 | void hid_hw_close(struct hid_device *hdev); | |
f65a0b1f | 1098 | void hid_hw_request(struct hid_device *hdev, |
735e1bb1 | 1099 | struct hid_report *report, enum hid_class_request reqtype); |
f65a0b1f BT |
1100 | int hid_hw_raw_request(struct hid_device *hdev, |
1101 | unsigned char reportnum, __u8 *buf, | |
735e1bb1 BT |
1102 | size_t len, enum hid_report_type rtype, |
1103 | enum hid_class_request reqtype); | |
f65a0b1f | 1104 | int hid_hw_output_report(struct hid_device *hdev, __u8 *buf, size_t len); |
5bea7660 DT |
1105 | |
1106 | /** | |
1107 | * hid_hw_power - requests underlying HW to go into given power mode | |
1108 | * | |
1109 | * @hdev: hid device | |
1110 | * @level: requested power level (one of %PM_HINT_* defines) | |
1111 | * | |
1112 | * This function requests underlying hardware to enter requested power | |
1113 | * mode. | |
1114 | */ | |
1115 | ||
1116 | static inline int hid_hw_power(struct hid_device *hdev, int level) | |
1117 | { | |
1118 | return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0; | |
1119 | } | |
1120 | ||
e90a6df8 | 1121 | |
9684819b BT |
1122 | /** |
1123 | * hid_hw_idle - send idle request to device | |
1124 | * | |
1125 | * @hdev: hid device | |
1126 | * @report: report to control | |
1127 | * @idle: idle state | |
1128 | * @reqtype: hid request type | |
1129 | */ | |
1130 | static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle, | |
735e1bb1 | 1131 | enum hid_class_request reqtype) |
9684819b BT |
1132 | { |
1133 | if (hdev->ll_driver->idle) | |
1134 | return hdev->ll_driver->idle(hdev, report, idle, reqtype); | |
1135 | ||
1136 | return 0; | |
1137 | } | |
1138 | ||
24e166f4 | 1139 | /** |
3809fe47 | 1140 | * hid_hw_may_wakeup - return if the hid device may act as a wakeup source during system-suspend |
24e166f4 HG |
1141 | * |
1142 | * @hdev: hid device | |
1143 | */ | |
1144 | static inline bool hid_hw_may_wakeup(struct hid_device *hdev) | |
1145 | { | |
1146 | if (hdev->ll_driver->may_wakeup) | |
1147 | return hdev->ll_driver->may_wakeup(hdev); | |
1148 | ||
1149 | if (hdev->dev.parent) | |
1150 | return device_may_wakeup(hdev->dev.parent); | |
1151 | ||
1152 | return false; | |
1153 | } | |
1154 | ||
3373443b HR |
1155 | /** |
1156 | * hid_hw_wait - wait for buffered io to complete | |
1157 | * | |
1158 | * @hdev: hid device | |
1159 | */ | |
1160 | static inline void hid_hw_wait(struct hid_device *hdev) | |
1161 | { | |
1162 | if (hdev->ll_driver->wait) | |
1163 | hdev->ll_driver->wait(hdev); | |
1164 | } | |
1165 | ||
dabb05c6 MM |
1166 | /** |
1167 | * hid_report_len - calculate the report length | |
1168 | * | |
1169 | * @report: the report we want to know the length | |
1170 | */ | |
6de0b13c | 1171 | static inline u32 hid_report_len(struct hid_report *report) |
dabb05c6 | 1172 | { |
6be388f4 | 1173 | return DIV_ROUND_UP(report->size, 8) + (report->id > 0); |
dabb05c6 MM |
1174 | } |
1175 | ||
ead77b65 BT |
1176 | int hid_report_raw_event(struct hid_device *hid, enum hid_report_type type, u8 *data, u32 size, |
1177 | int interrupt); | |
85cdaf52 | 1178 | |
876b9276 | 1179 | /* HID quirks API */ |
d5d3e202 BT |
1180 | unsigned long hid_lookup_quirk(const struct hid_device *hdev); |
1181 | int hid_quirks_init(char **quirks_param, __u16 bus, int count); | |
1182 | void hid_quirks_exit(__u16 bus); | |
2eb5dc30 | 1183 | |
224ee88f AH |
1184 | #ifdef CONFIG_HID_PID |
1185 | int hid_pidff_init(struct hid_device *hid); | |
1186 | #else | |
76483cf4 | 1187 | #define hid_pidff_init NULL |
1da177e4 | 1188 | #endif |
58037eb9 | 1189 | |
3f16ba1c | 1190 | #define dbg_hid(fmt, ...) pr_debug("%s: " fmt, __FILE__, ##__VA_ARGS__) |
4291ee30 | 1191 | |
337c22ab JC |
1192 | #define hid_err(hid, fmt, ...) \ |
1193 | dev_err(&(hid)->dev, fmt, ##__VA_ARGS__) | |
1194 | #define hid_notice(hid, fmt, ...) \ | |
1195 | dev_notice(&(hid)->dev, fmt, ##__VA_ARGS__) | |
1196 | #define hid_warn(hid, fmt, ...) \ | |
1197 | dev_warn(&(hid)->dev, fmt, ##__VA_ARGS__) | |
1198 | #define hid_info(hid, fmt, ...) \ | |
1199 | dev_info(&(hid)->dev, fmt, ##__VA_ARGS__) | |
1200 | #define hid_dbg(hid, fmt, ...) \ | |
1201 | dev_dbg(&(hid)->dev, fmt, ##__VA_ARGS__) | |
4291ee30 | 1202 | |
aaeabb12 JC |
1203 | #define hid_err_once(hid, fmt, ...) \ |
1204 | dev_err_once(&(hid)->dev, fmt, ##__VA_ARGS__) | |
1205 | #define hid_notice_once(hid, fmt, ...) \ | |
1206 | dev_notice_once(&(hid)->dev, fmt, ##__VA_ARGS__) | |
1207 | #define hid_warn_once(hid, fmt, ...) \ | |
1208 | dev_warn_once(&(hid)->dev, fmt, ##__VA_ARGS__) | |
1209 | #define hid_info_once(hid, fmt, ...) \ | |
1210 | dev_info_once(&(hid)->dev, fmt, ##__VA_ARGS__) | |
1211 | #define hid_dbg_once(hid, fmt, ...) \ | |
1212 | dev_dbg_once(&(hid)->dev, fmt, ##__VA_ARGS__) | |
1213 | ||
57d292bd | 1214 | #endif |