]> 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
x86/apic/msi: Plug non-maskable MSI affinity race
[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_HAVE_SPECIAL_DRIVER 0x00080000
346 #define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000
347 #define HID_QUIRK_NO_INIT_REPORTS 0x20000000
348 #define HID_QUIRK_NO_IGNORE 0x40000000
349 #define HID_QUIRK_NO_INPUT_SYNC 0x80000000
350
351 /*
352 * HID device groups
353 *
354 * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h
355 * and has a value of 0x0000
356 */
357 #define HID_GROUP_GENERIC 0x0001
358 #define HID_GROUP_MULTITOUCH 0x0002
359 #define HID_GROUP_SENSOR_HUB 0x0003
360 #define HID_GROUP_MULTITOUCH_WIN_8 0x0004
361
362 /*
363 * Vendor specific HID device groups
364 */
365 #define HID_GROUP_RMI 0x0100
366 #define HID_GROUP_WACOM 0x0101
367 #define HID_GROUP_LOGITECH_DJ_DEVICE 0x0102
368
369 /*
370 * HID protocol status
371 */
372 #define HID_REPORT_PROTOCOL 1
373 #define HID_BOOT_PROTOCOL 0
374
375 /*
376 * This is the global environment of the parser. This information is
377 * persistent for main-items. The global environment can be saved and
378 * restored with PUSH/POP statements.
379 */
380
381 struct hid_global {
382 unsigned usage_page;
383 __s32 logical_minimum;
384 __s32 logical_maximum;
385 __s32 physical_minimum;
386 __s32 physical_maximum;
387 __s32 unit_exponent;
388 unsigned unit;
389 unsigned report_id;
390 unsigned report_size;
391 unsigned report_count;
392 };
393
394 /*
395 * This is the local environment. It is persistent up the next main-item.
396 */
397
398 #define HID_MAX_USAGES 12288
399 #define HID_DEFAULT_NUM_COLLECTIONS 16
400
401 struct hid_local {
402 unsigned usage[HID_MAX_USAGES]; /* usage array */
403 u8 usage_size[HID_MAX_USAGES]; /* usage size array */
404 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
405 unsigned usage_index;
406 unsigned usage_minimum;
407 unsigned delimiter_depth;
408 unsigned delimiter_branch;
409 };
410
411 /*
412 * This is the collection stack. We climb up the stack to determine
413 * application and function of each field.
414 */
415
416 struct hid_collection {
417 unsigned type;
418 unsigned usage;
419 unsigned level;
420 };
421
422 struct hid_usage {
423 unsigned hid; /* hid usage code */
424 unsigned collection_index; /* index into collection array */
425 unsigned usage_index; /* index into usage array */
426 /* hidinput data */
427 __u16 code; /* input driver code */
428 __u8 type; /* input driver type */
429 __s8 hat_min; /* hat switch fun */
430 __s8 hat_max; /* ditto */
431 __s8 hat_dir; /* ditto */
432 };
433
434 struct hid_input;
435
436 struct hid_field {
437 unsigned physical; /* physical usage for this field */
438 unsigned logical; /* logical usage for this field */
439 unsigned application; /* application usage for this field */
440 struct hid_usage *usage; /* usage table for this function */
441 unsigned maxusage; /* maximum usage index */
442 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
443 unsigned report_offset; /* bit offset in the report */
444 unsigned report_size; /* size of this field in the report */
445 unsigned report_count; /* number of this field in the report */
446 unsigned report_type; /* (input,output,feature) */
447 __s32 *value; /* last known value(s) */
448 __s32 logical_minimum;
449 __s32 logical_maximum;
450 __s32 physical_minimum;
451 __s32 physical_maximum;
452 __s32 unit_exponent;
453 unsigned unit;
454 struct hid_report *report; /* associated report */
455 unsigned index; /* index into report->field[] */
456 /* hidinput data */
457 struct hid_input *hidinput; /* associated input structure */
458 __u16 dpad; /* dpad input code */
459 };
460
461 #define HID_MAX_FIELDS 256
462
463 struct hid_report {
464 struct list_head list;
465 unsigned id; /* id of this report */
466 unsigned type; /* report type */
467 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
468 unsigned maxfield; /* maximum valid field index */
469 unsigned size; /* size of the report (bits) */
470 struct hid_device *device; /* associated device */
471 };
472
473 #define HID_MAX_IDS 256
474
475 struct hid_report_enum {
476 unsigned numbered;
477 struct list_head report_list;
478 struct hid_report *report_id_hash[HID_MAX_IDS];
479 };
480
481 #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
482 #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
483 #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
484 #define HID_OUTPUT_FIFO_SIZE 64
485
486 struct hid_control_fifo {
487 unsigned char dir;
488 struct hid_report *report;
489 char *raw_report;
490 };
491
492 struct hid_output_fifo {
493 struct hid_report *report;
494 char *raw_report;
495 };
496
497 #define HID_CLAIMED_INPUT 1
498 #define HID_CLAIMED_HIDDEV 2
499 #define HID_CLAIMED_HIDRAW 4
500 #define HID_CLAIMED_DRIVER 8
501
502 #define HID_STAT_ADDED 1
503 #define HID_STAT_PARSED 2
504
505 struct hid_input {
506 struct list_head list;
507 struct hid_report *report;
508 struct input_dev *input;
509 bool registered;
510 };
511
512 enum hid_type {
513 HID_TYPE_OTHER = 0,
514 HID_TYPE_USBMOUSE,
515 HID_TYPE_USBNONE
516 };
517
518 enum hid_battery_status {
519 HID_BATTERY_UNKNOWN = 0,
520 HID_BATTERY_QUERIED, /* Kernel explicitly queried battery strength */
521 HID_BATTERY_REPORTED, /* Device sent unsolicited battery strength report */
522 };
523
524 struct hid_driver;
525 struct hid_ll_driver;
526
527 struct hid_device { /* device report descriptor */
528 __u8 *dev_rdesc;
529 unsigned dev_rsize;
530 __u8 *rdesc;
531 unsigned rsize;
532 struct hid_collection *collection; /* List of HID collections */
533 unsigned collection_size; /* Number of allocated hid_collections */
534 unsigned maxcollection; /* Number of parsed collections */
535 unsigned maxapplication; /* Number of applications */
536 __u16 bus; /* BUS ID */
537 __u16 group; /* Report group */
538 __u32 vendor; /* Vendor ID */
539 __u32 product; /* Product ID */
540 __u32 version; /* HID version */
541 enum hid_type type; /* device type (mouse, kbd, ...) */
542 unsigned country; /* HID country */
543 struct hid_report_enum report_enum[HID_REPORT_TYPES];
544 struct work_struct led_work; /* delayed LED worker */
545
546 struct semaphore driver_input_lock; /* protects the current driver */
547 struct device dev; /* device */
548 struct hid_driver *driver;
549
550 struct hid_ll_driver *ll_driver;
551 struct mutex ll_open_lock;
552 unsigned int ll_open_count;
553
554 #ifdef CONFIG_HID_BATTERY_STRENGTH
555 /*
556 * Power supply information for HID devices which report
557 * battery strength. power_supply was successfully registered if
558 * battery is non-NULL.
559 */
560 struct power_supply *battery;
561 __s32 battery_capacity;
562 __s32 battery_min;
563 __s32 battery_max;
564 __s32 battery_report_type;
565 __s32 battery_report_id;
566 enum hid_battery_status battery_status;
567 bool battery_avoid_query;
568 #endif
569
570 unsigned int status; /* see STAT flags above */
571 unsigned claimed; /* Claimed by hidinput, hiddev? */
572 unsigned quirks; /* Various quirks the device can pull on us */
573 bool io_started; /* If IO has started */
574
575 struct list_head inputs; /* The list of inputs */
576 void *hiddev; /* The hiddev structure */
577 void *hidraw;
578
579 char name[128]; /* Device name */
580 char phys[64]; /* Device physical location */
581 char uniq[64]; /* Device unique identifier (serial #) */
582
583 void *driver_data;
584
585 /* temporary hid_ff handling (until moved to the drivers) */
586 int (*ff_init)(struct hid_device *);
587
588 /* hiddev event handler */
589 int (*hiddev_connect)(struct hid_device *, unsigned int);
590 void (*hiddev_disconnect)(struct hid_device *);
591 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
592 struct hid_usage *, __s32);
593 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
594
595 /* debugging support via debugfs */
596 unsigned short debug;
597 struct dentry *debug_dir;
598 struct dentry *debug_rdesc;
599 struct dentry *debug_events;
600 struct list_head debug_list;
601 spinlock_t debug_list_lock;
602 wait_queue_head_t debug_wait;
603 };
604
605 #define to_hid_device(pdev) \
606 container_of(pdev, struct hid_device, dev)
607
608 static inline void *hid_get_drvdata(struct hid_device *hdev)
609 {
610 return dev_get_drvdata(&hdev->dev);
611 }
612
613 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
614 {
615 dev_set_drvdata(&hdev->dev, data);
616 }
617
618 #define HID_GLOBAL_STACK_SIZE 4
619 #define HID_COLLECTION_STACK_SIZE 4
620
621 #define HID_SCAN_FLAG_MT_WIN_8 BIT(0)
622 #define HID_SCAN_FLAG_VENDOR_SPECIFIC BIT(1)
623 #define HID_SCAN_FLAG_GD_POINTER BIT(2)
624
625 struct hid_parser {
626 struct hid_global global;
627 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
628 unsigned global_stack_ptr;
629 struct hid_local local;
630 unsigned collection_stack[HID_COLLECTION_STACK_SIZE];
631 unsigned collection_stack_ptr;
632 struct hid_device *device;
633 unsigned scan_flags;
634 };
635
636 struct hid_class_descriptor {
637 __u8 bDescriptorType;
638 __le16 wDescriptorLength;
639 } __attribute__ ((packed));
640
641 struct hid_descriptor {
642 __u8 bLength;
643 __u8 bDescriptorType;
644 __le16 bcdHID;
645 __u8 bCountryCode;
646 __u8 bNumDescriptors;
647
648 struct hid_class_descriptor desc[1];
649 } __attribute__ ((packed));
650
651 #define HID_DEVICE(b, g, ven, prod) \
652 .bus = (b), .group = (g), .vendor = (ven), .product = (prod)
653 #define HID_USB_DEVICE(ven, prod) \
654 .bus = BUS_USB, .vendor = (ven), .product = (prod)
655 #define HID_BLUETOOTH_DEVICE(ven, prod) \
656 .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod)
657 #define HID_I2C_DEVICE(ven, prod) \
658 .bus = BUS_I2C, .vendor = (ven), .product = (prod)
659
660 #define HID_REPORT_ID(rep) \
661 .report_type = (rep)
662 #define HID_USAGE_ID(uhid, utype, ucode) \
663 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
664 /* we don't want to catch types and codes equal to 0 */
665 #define HID_TERMINATOR (HID_ANY_ID - 1)
666
667 struct hid_report_id {
668 __u32 report_type;
669 };
670 struct hid_usage_id {
671 __u32 usage_hid;
672 __u32 usage_type;
673 __u32 usage_code;
674 };
675
676 /**
677 * struct hid_driver
678 * @name: driver name (e.g. "Footech_bar-wheel")
679 * @id_table: which devices is this driver for (must be non-NULL for probe
680 * to be called)
681 * @dyn_list: list of dynamically added device ids
682 * @dyn_lock: lock protecting @dyn_list
683 * @match: check if the given device is handled by this driver
684 * @probe: new device inserted
685 * @remove: device removed (NULL if not a hot-plug capable driver)
686 * @report_table: on which reports to call raw_event (NULL means all)
687 * @raw_event: if report in report_table, this hook is called (NULL means nop)
688 * @usage_table: on which events to call event (NULL means all)
689 * @event: if usage in usage_table, this hook is called (NULL means nop)
690 * @report: this hook is called after parsing a report (NULL means nop)
691 * @report_fixup: called before report descriptor parsing (NULL means nop)
692 * @input_mapping: invoked on input registering before mapping an usage
693 * @input_mapped: invoked on input registering after mapping an usage
694 * @input_configured: invoked just before the device is registered
695 * @feature_mapping: invoked on feature registering
696 * @bus_add_driver: invoked when a HID driver is about to be added
697 * @bus_removed_driver: invoked when a HID driver has been removed
698 * @suspend: invoked on suspend (NULL means nop)
699 * @resume: invoked on resume if device was not reset (NULL means nop)
700 * @reset_resume: invoked on resume if device was reset (NULL means nop)
701 *
702 * probe should return -errno on error, or 0 on success. During probe,
703 * input will not be passed to raw_event unless hid_device_io_start is
704 * called.
705 *
706 * raw_event and event should return 0 on no action performed, 1 when no
707 * further processing should be done and negative on error
708 *
709 * input_mapping shall return a negative value to completely ignore this usage
710 * (e.g. doubled or invalid usage), zero to continue with parsing of this
711 * usage by generic code (no special handling needed) or positive to skip
712 * generic parsing (needed special handling which was done in the hook already)
713 * input_mapped shall return negative to inform the layer that this usage
714 * should not be considered for further processing or zero to notify that
715 * no processing was performed and should be done in a generic manner
716 * Both these functions may be NULL which means the same behavior as returning
717 * zero from them.
718 */
719 struct hid_driver {
720 char *name;
721 const struct hid_device_id *id_table;
722
723 struct list_head dyn_list;
724 spinlock_t dyn_lock;
725
726 bool (*match)(struct hid_device *dev, bool ignore_special_driver);
727 int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
728 void (*remove)(struct hid_device *dev);
729
730 const struct hid_report_id *report_table;
731 int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
732 u8 *data, int size);
733 const struct hid_usage_id *usage_table;
734 int (*event)(struct hid_device *hdev, struct hid_field *field,
735 struct hid_usage *usage, __s32 value);
736 void (*report)(struct hid_device *hdev, struct hid_report *report);
737
738 __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
739 unsigned int *size);
740
741 int (*input_mapping)(struct hid_device *hdev,
742 struct hid_input *hidinput, struct hid_field *field,
743 struct hid_usage *usage, unsigned long **bit, int *max);
744 int (*input_mapped)(struct hid_device *hdev,
745 struct hid_input *hidinput, struct hid_field *field,
746 struct hid_usage *usage, unsigned long **bit, int *max);
747 int (*input_configured)(struct hid_device *hdev,
748 struct hid_input *hidinput);
749 void (*feature_mapping)(struct hid_device *hdev,
750 struct hid_field *field,
751 struct hid_usage *usage);
752 void (*bus_add_driver)(struct hid_driver *driver);
753 void (*bus_removed_driver)(struct hid_driver *driver);
754 #ifdef CONFIG_PM
755 int (*suspend)(struct hid_device *hdev, pm_message_t message);
756 int (*resume)(struct hid_device *hdev);
757 int (*reset_resume)(struct hid_device *hdev);
758 #endif
759 /* private: */
760 struct device_driver driver;
761 };
762
763 #define to_hid_driver(pdrv) \
764 container_of(pdrv, struct hid_driver, driver)
765
766 /**
767 * hid_ll_driver - low level driver callbacks
768 * @start: called on probe to start the device
769 * @stop: called on remove
770 * @open: called by input layer on open
771 * @close: called by input layer on close
772 * @power: request underlying hardware to enter requested power mode
773 * @parse: this method is called only once to parse the device data,
774 * shouldn't allocate anything to not leak memory
775 * @request: send report request to device (e.g. feature report)
776 * @wait: wait for buffered io to complete (send/recv reports)
777 * @raw_request: send raw report request to device (e.g. feature report)
778 * @output_report: send output report to device
779 * @idle: send idle request to device
780 */
781 struct hid_ll_driver {
782 int (*start)(struct hid_device *hdev);
783 void (*stop)(struct hid_device *hdev);
784
785 int (*open)(struct hid_device *hdev);
786 void (*close)(struct hid_device *hdev);
787
788 int (*power)(struct hid_device *hdev, int level);
789
790 int (*parse)(struct hid_device *hdev);
791
792 void (*request)(struct hid_device *hdev,
793 struct hid_report *report, int reqtype);
794
795 int (*wait)(struct hid_device *hdev);
796
797 int (*raw_request) (struct hid_device *hdev, unsigned char reportnum,
798 __u8 *buf, size_t len, unsigned char rtype,
799 int reqtype);
800
801 int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len);
802
803 int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype);
804 };
805
806 extern struct hid_ll_driver i2c_hid_ll_driver;
807 extern struct hid_ll_driver hidp_hid_driver;
808 extern struct hid_ll_driver uhid_hid_driver;
809 extern struct hid_ll_driver usb_hid_driver;
810
811 static inline bool hid_is_using_ll_driver(struct hid_device *hdev,
812 struct hid_ll_driver *driver)
813 {
814 return hdev->ll_driver == driver;
815 }
816
817 #define PM_HINT_FULLON 1<<5
818 #define PM_HINT_NORMAL 1<<1
819
820 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
821 /* We ignore a few input applications that are not widely used */
822 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006)))
823
824 /* HID core API */
825
826 extern int hid_debug;
827
828 extern bool hid_ignore(struct hid_device *);
829 extern int hid_add_device(struct hid_device *);
830 extern void hid_destroy_device(struct hid_device *);
831
832 extern struct bus_type hid_bus_type;
833
834 extern int __must_check __hid_register_driver(struct hid_driver *,
835 struct module *, const char *mod_name);
836
837 /* use a define to avoid include chaining to get THIS_MODULE & friends */
838 #define hid_register_driver(driver) \
839 __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
840
841 extern void hid_unregister_driver(struct hid_driver *);
842
843 /**
844 * module_hid_driver() - Helper macro for registering a HID driver
845 * @__hid_driver: hid_driver struct
846 *
847 * Helper macro for HID drivers which do not do anything special in module
848 * init/exit. This eliminates a lot of boilerplate. Each module may only
849 * use this macro once, and calling it replaces module_init() and module_exit()
850 */
851 #define module_hid_driver(__hid_driver) \
852 module_driver(__hid_driver, hid_register_driver, \
853 hid_unregister_driver)
854
855 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
856 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
857 extern int hidinput_connect(struct hid_device *hid, unsigned int force);
858 extern void hidinput_disconnect(struct hid_device *);
859
860 int hid_set_field(struct hid_field *, unsigned, __s32);
861 int hid_input_report(struct hid_device *, int type, u8 *, u32, int);
862 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
863 struct hid_field *hidinput_get_led_field(struct hid_device *hid);
864 unsigned int hidinput_count_leds(struct hid_device *hid);
865 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
866 void hid_output_report(struct hid_report *report, __u8 *data);
867 void __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype);
868 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags);
869 struct hid_device *hid_allocate_device(void);
870 struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id);
871 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
872 struct hid_report *hid_validate_values(struct hid_device *hid,
873 unsigned int type, unsigned int id,
874 unsigned int field_index,
875 unsigned int report_counts);
876 int hid_open_report(struct hid_device *device);
877 int hid_check_keys_pressed(struct hid_device *hid);
878 int hid_connect(struct hid_device *hid, unsigned int connect_mask);
879 void hid_disconnect(struct hid_device *hid);
880 bool hid_match_one_id(const struct hid_device *hdev,
881 const struct hid_device_id *id);
882 const struct hid_device_id *hid_match_id(const struct hid_device *hdev,
883 const struct hid_device_id *id);
884 const struct hid_device_id *hid_match_device(struct hid_device *hdev,
885 struct hid_driver *hdrv);
886 s32 hid_snto32(__u32 value, unsigned n);
887 __u32 hid_field_extract(const struct hid_device *hid, __u8 *report,
888 unsigned offset, unsigned n);
889
890 /**
891 * hid_device_io_start - enable HID input during probe, remove
892 *
893 * @hid - the device
894 *
895 * This should only be called during probe or remove and only be
896 * called by the thread calling probe or remove. It will allow
897 * incoming packets to be delivered to the driver.
898 */
899 static inline void hid_device_io_start(struct hid_device *hid) {
900 if (hid->io_started) {
901 dev_warn(&hid->dev, "io already started\n");
902 return;
903 }
904 hid->io_started = true;
905 up(&hid->driver_input_lock);
906 }
907
908 /**
909 * hid_device_io_stop - disable HID input during probe, remove
910 *
911 * @hid - the device
912 *
913 * Should only be called after hid_device_io_start. It will prevent
914 * incoming packets from going to the driver for the duration of
915 * probe, remove. If called during probe, packets will still go to the
916 * driver after probe is complete. This function should only be called
917 * by the thread calling probe or remove.
918 */
919 static inline void hid_device_io_stop(struct hid_device *hid) {
920 if (!hid->io_started) {
921 dev_warn(&hid->dev, "io already stopped\n");
922 return;
923 }
924 hid->io_started = false;
925 down(&hid->driver_input_lock);
926 }
927
928 /**
929 * hid_map_usage - map usage input bits
930 *
931 * @hidinput: hidinput which we are interested in
932 * @usage: usage to fill in
933 * @bit: pointer to input->{}bit (out parameter)
934 * @max: maximal valid usage->code to consider later (out parameter)
935 * @type: input event type (EV_KEY, EV_REL, ...)
936 * @c: code which corresponds to this usage and type
937 */
938 static inline void hid_map_usage(struct hid_input *hidinput,
939 struct hid_usage *usage, unsigned long **bit, int *max,
940 __u8 type, __u16 c)
941 {
942 struct input_dev *input = hidinput->input;
943
944 usage->type = type;
945 usage->code = c;
946
947 switch (type) {
948 case EV_ABS:
949 *bit = input->absbit;
950 *max = ABS_MAX;
951 break;
952 case EV_REL:
953 *bit = input->relbit;
954 *max = REL_MAX;
955 break;
956 case EV_KEY:
957 *bit = input->keybit;
958 *max = KEY_MAX;
959 break;
960 case EV_LED:
961 *bit = input->ledbit;
962 *max = LED_MAX;
963 break;
964 }
965 }
966
967 /**
968 * hid_map_usage_clear - map usage input bits and clear the input bit
969 *
970 * The same as hid_map_usage, except the @c bit is also cleared in supported
971 * bits (@bit).
972 */
973 static inline void hid_map_usage_clear(struct hid_input *hidinput,
974 struct hid_usage *usage, unsigned long **bit, int *max,
975 __u8 type, __u16 c)
976 {
977 hid_map_usage(hidinput, usage, bit, max, type, c);
978 clear_bit(c, *bit);
979 }
980
981 /**
982 * hid_parse - parse HW reports
983 *
984 * @hdev: hid device
985 *
986 * Call this from probe after you set up the device (if needed). Your
987 * report_fixup will be called (if non-NULL) after reading raw report from
988 * device before passing it to hid layer for real parsing.
989 */
990 static inline int __must_check hid_parse(struct hid_device *hdev)
991 {
992 return hid_open_report(hdev);
993 }
994
995 int __must_check hid_hw_start(struct hid_device *hdev,
996 unsigned int connect_mask);
997 void hid_hw_stop(struct hid_device *hdev);
998 int __must_check hid_hw_open(struct hid_device *hdev);
999 void hid_hw_close(struct hid_device *hdev);
1000
1001 /**
1002 * hid_hw_power - requests underlying HW to go into given power mode
1003 *
1004 * @hdev: hid device
1005 * @level: requested power level (one of %PM_HINT_* defines)
1006 *
1007 * This function requests underlying hardware to enter requested power
1008 * mode.
1009 */
1010
1011 static inline int hid_hw_power(struct hid_device *hdev, int level)
1012 {
1013 return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
1014 }
1015
1016
1017 /**
1018 * hid_hw_request - send report request to device
1019 *
1020 * @hdev: hid device
1021 * @report: report to send
1022 * @reqtype: hid request type
1023 */
1024 static inline void hid_hw_request(struct hid_device *hdev,
1025 struct hid_report *report, int reqtype)
1026 {
1027 if (hdev->ll_driver->request)
1028 return hdev->ll_driver->request(hdev, report, reqtype);
1029
1030 __hid_request(hdev, report, reqtype);
1031 }
1032
1033 /**
1034 * hid_hw_raw_request - send report request to device
1035 *
1036 * @hdev: hid device
1037 * @reportnum: report ID
1038 * @buf: in/out data to transfer
1039 * @len: length of buf
1040 * @rtype: HID report type
1041 * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
1042 *
1043 * @return: count of data transfered, negative if error
1044 *
1045 * Same behavior as hid_hw_request, but with raw buffers instead.
1046 */
1047 static inline int hid_hw_raw_request(struct hid_device *hdev,
1048 unsigned char reportnum, __u8 *buf,
1049 size_t len, unsigned char rtype, int reqtype)
1050 {
1051 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1052 return -EINVAL;
1053
1054 return hdev->ll_driver->raw_request(hdev, reportnum, buf, len,
1055 rtype, reqtype);
1056 }
1057
1058 /**
1059 * hid_hw_output_report - send output report to device
1060 *
1061 * @hdev: hid device
1062 * @buf: raw data to transfer
1063 * @len: length of buf
1064 *
1065 * @return: count of data transfered, negative if error
1066 */
1067 static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf,
1068 size_t len)
1069 {
1070 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1071 return -EINVAL;
1072
1073 if (hdev->ll_driver->output_report)
1074 return hdev->ll_driver->output_report(hdev, buf, len);
1075
1076 return -ENOSYS;
1077 }
1078
1079 /**
1080 * hid_hw_idle - send idle request to device
1081 *
1082 * @hdev: hid device
1083 * @report: report to control
1084 * @idle: idle state
1085 * @reqtype: hid request type
1086 */
1087 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
1088 int reqtype)
1089 {
1090 if (hdev->ll_driver->idle)
1091 return hdev->ll_driver->idle(hdev, report, idle, reqtype);
1092
1093 return 0;
1094 }
1095
1096 /**
1097 * hid_hw_wait - wait for buffered io to complete
1098 *
1099 * @hdev: hid device
1100 */
1101 static inline void hid_hw_wait(struct hid_device *hdev)
1102 {
1103 if (hdev->ll_driver->wait)
1104 hdev->ll_driver->wait(hdev);
1105 }
1106
1107 /**
1108 * hid_report_len - calculate the report length
1109 *
1110 * @report: the report we want to know the length
1111 */
1112 static inline u32 hid_report_len(struct hid_report *report)
1113 {
1114 /* equivalent to DIV_ROUND_UP(report->size, 8) + !!(report->id > 0) */
1115 return ((report->size - 1) >> 3) + 1 + (report->id > 0);
1116 }
1117
1118 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, u32 size,
1119 int interrupt);
1120
1121 /* HID quirks API */
1122 unsigned long hid_lookup_quirk(const struct hid_device *hdev);
1123 int hid_quirks_init(char **quirks_param, __u16 bus, int count);
1124 void hid_quirks_exit(__u16 bus);
1125
1126 #ifdef CONFIG_HID_PID
1127 int hid_pidff_init(struct hid_device *hid);
1128 #else
1129 #define hid_pidff_init NULL
1130 #endif
1131
1132 #define dbg_hid(fmt, ...) \
1133 do { \
1134 if (hid_debug) \
1135 printk(KERN_DEBUG "%s: " fmt, __FILE__, ##__VA_ARGS__); \
1136 } while (0)
1137
1138 #define hid_err(hid, fmt, ...) \
1139 dev_err(&(hid)->dev, fmt, ##__VA_ARGS__)
1140 #define hid_notice(hid, fmt, ...) \
1141 dev_notice(&(hid)->dev, fmt, ##__VA_ARGS__)
1142 #define hid_warn(hid, fmt, ...) \
1143 dev_warn(&(hid)->dev, fmt, ##__VA_ARGS__)
1144 #define hid_info(hid, fmt, ...) \
1145 dev_info(&(hid)->dev, fmt, ##__VA_ARGS__)
1146 #define hid_dbg(hid, fmt, ...) \
1147 dev_dbg(&(hid)->dev, fmt, ##__VA_ARGS__)
1148
1149 #define hid_err_once(hid, fmt, ...) \
1150 dev_err_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1151 #define hid_notice_once(hid, fmt, ...) \
1152 dev_notice_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1153 #define hid_warn_once(hid, fmt, ...) \
1154 dev_warn_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1155 #define hid_info_once(hid, fmt, ...) \
1156 dev_info_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1157 #define hid_dbg_once(hid, fmt, ...) \
1158 dev_dbg_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1159
1160 #endif
ubuntu-bionic-kernel mirror