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