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