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