Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1#ifndef __HID_H
2#define __HID_H
3
4/*
5 * Copyright (c) 1999 Andreas Gal
6 * Copyright (c) 2000-2001 Vojtech Pavlik
7 * Copyright (c) 2006-2007 Jiri Kosina
8 */
9
10/*
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 *
25 * Should you need to contact me, the author, you can do so either by
26 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
27 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
28 */
29
30/*
31 * USB HID (Human Interface Device) interface class code
32 */
33
34#define USB_INTERFACE_CLASS_HID 3
35
36/*
37 * USB HID interface subclass and protocol codes
38 */
39
40#define USB_INTERFACE_SUBCLASS_BOOT 1
41#define USB_INTERFACE_PROTOCOL_KEYBOARD 1
42#define USB_INTERFACE_PROTOCOL_MOUSE 2
43
44/*
45 * HID class requests
46 */
47
48#define HID_REQ_GET_REPORT 0x01
49#define HID_REQ_GET_IDLE 0x02
50#define HID_REQ_GET_PROTOCOL 0x03
51#define HID_REQ_SET_REPORT 0x09
52#define HID_REQ_SET_IDLE 0x0A
53#define HID_REQ_SET_PROTOCOL 0x0B
54
55/*
56 * HID class descriptor types
57 */
58
59#define HID_DT_HID (USB_TYPE_CLASS | 0x01)
60#define HID_DT_REPORT (USB_TYPE_CLASS | 0x02)
61#define HID_DT_PHYSICAL (USB_TYPE_CLASS | 0x03)
62
63#define HID_MAX_DESCRIPTOR_SIZE 4096
64
65#ifdef __KERNEL__
66
67#include <linux/types.h>
68#include <linux/slab.h>
69#include <linux/list.h>
70#include <linux/timer.h>
71#include <linux/workqueue.h>
72#include <linux/input.h>
73
74/*
75 * We parse each description item into this structure. Short items data
76 * values are expanded to 32-bit signed int, long items contain a pointer
77 * into the data area.
78 */
79
80struct hid_item {
81 unsigned format;
82 __u8 size;
83 __u8 type;
84 __u8 tag;
85 union {
86 __u8 u8;
87 __s8 s8;
88 __u16 u16;
89 __s16 s16;
90 __u32 u32;
91 __s32 s32;
92 __u8 *longdata;
93 } data;
94};
95
96/*
97 * HID report item format
98 */
99
100#define HID_ITEM_FORMAT_SHORT 0
101#define HID_ITEM_FORMAT_LONG 1
102
103/*
104 * Special tag indicating long items
105 */
106
107#define HID_ITEM_TAG_LONG 15
108
109/*
110 * HID report descriptor item type (prefix bit 2,3)
111 */
112
113#define HID_ITEM_TYPE_MAIN 0
114#define HID_ITEM_TYPE_GLOBAL 1
115#define HID_ITEM_TYPE_LOCAL 2
116#define HID_ITEM_TYPE_RESERVED 3
117
118/*
119 * HID report descriptor main item tags
120 */
121
122#define HID_MAIN_ITEM_TAG_INPUT 8
123#define HID_MAIN_ITEM_TAG_OUTPUT 9
124#define HID_MAIN_ITEM_TAG_FEATURE 11
125#define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10
126#define HID_MAIN_ITEM_TAG_END_COLLECTION 12
127
128/*
129 * HID report descriptor main item contents
130 */
131
132#define HID_MAIN_ITEM_CONSTANT 0x001
133#define HID_MAIN_ITEM_VARIABLE 0x002
134#define HID_MAIN_ITEM_RELATIVE 0x004
135#define HID_MAIN_ITEM_WRAP 0x008
136#define HID_MAIN_ITEM_NONLINEAR 0x010
137#define HID_MAIN_ITEM_NO_PREFERRED 0x020
138#define HID_MAIN_ITEM_NULL_STATE 0x040
139#define HID_MAIN_ITEM_VOLATILE 0x080
140#define HID_MAIN_ITEM_BUFFERED_BYTE 0x100
141
142/*
143 * HID report descriptor collection item types
144 */
145
146#define HID_COLLECTION_PHYSICAL 0
147#define HID_COLLECTION_APPLICATION 1
148#define HID_COLLECTION_LOGICAL 2
149
150/*
151 * HID report descriptor global item tags
152 */
153
154#define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0
155#define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1
156#define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2
157#define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3
158#define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4
159#define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5
160#define HID_GLOBAL_ITEM_TAG_UNIT 6
161#define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7
162#define HID_GLOBAL_ITEM_TAG_REPORT_ID 8
163#define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9
164#define HID_GLOBAL_ITEM_TAG_PUSH 10
165#define HID_GLOBAL_ITEM_TAG_POP 11
166
167/*
168 * HID report descriptor local item tags
169 */
170
171#define HID_LOCAL_ITEM_TAG_USAGE 0
172#define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1
173#define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2
174#define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3
175#define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4
176#define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5
177#define HID_LOCAL_ITEM_TAG_STRING_INDEX 7
178#define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8
179#define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9
180#define HID_LOCAL_ITEM_TAG_DELIMITER 10
181
182/*
183 * HID usage tables
184 */
185
186#define HID_USAGE_PAGE 0xffff0000
187
188#define HID_UP_UNDEFINED 0x00000000
189#define HID_UP_GENDESK 0x00010000
190#define HID_UP_SIMULATION 0x00020000
191#define HID_UP_KEYBOARD 0x00070000
192#define HID_UP_LED 0x00080000
193#define HID_UP_BUTTON 0x00090000
194#define HID_UP_ORDINAL 0x000a0000
195#define HID_UP_CONSUMER 0x000c0000
196#define HID_UP_DIGITIZER 0x000d0000
197#define HID_UP_PID 0x000f0000
198#define HID_UP_HPVENDOR 0xff7f0000
199#define HID_UP_MSVENDOR 0xff000000
200#define HID_UP_CUSTOM 0x00ff0000
201#define HID_UP_LOGIVENDOR 0xffbc0000
202
203#define HID_USAGE 0x0000ffff
204
205#define HID_GD_POINTER 0x00010001
206#define HID_GD_MOUSE 0x00010002
207#define HID_GD_JOYSTICK 0x00010004
208#define HID_GD_GAMEPAD 0x00010005
209#define HID_GD_KEYBOARD 0x00010006
210#define HID_GD_KEYPAD 0x00010007
211#define HID_GD_MULTIAXIS 0x00010008
212#define HID_GD_X 0x00010030
213#define HID_GD_Y 0x00010031
214#define HID_GD_Z 0x00010032
215#define HID_GD_RX 0x00010033
216#define HID_GD_RY 0x00010034
217#define HID_GD_RZ 0x00010035
218#define HID_GD_SLIDER 0x00010036
219#define HID_GD_DIAL 0x00010037
220#define HID_GD_WHEEL 0x00010038
221#define HID_GD_HATSWITCH 0x00010039
222#define HID_GD_BUFFER 0x0001003a
223#define HID_GD_BYTECOUNT 0x0001003b
224#define HID_GD_MOTION 0x0001003c
225#define HID_GD_START 0x0001003d
226#define HID_GD_SELECT 0x0001003e
227#define HID_GD_VX 0x00010040
228#define HID_GD_VY 0x00010041
229#define HID_GD_VZ 0x00010042
230#define HID_GD_VBRX 0x00010043
231#define HID_GD_VBRY 0x00010044
232#define HID_GD_VBRZ 0x00010045
233#define HID_GD_VNO 0x00010046
234#define HID_GD_FEATURE 0x00010047
235#define HID_GD_UP 0x00010090
236#define HID_GD_DOWN 0x00010091
237#define HID_GD_RIGHT 0x00010092
238#define HID_GD_LEFT 0x00010093
239
240/*
241 * HID report types --- Ouch! HID spec says 1 2 3!
242 */
243
244#define HID_INPUT_REPORT 0
245#define HID_OUTPUT_REPORT 1
246#define HID_FEATURE_REPORT 2
247
248/*
249 * HID device quirks.
250 */
251
252/*
253 * Increase this if you need to configure more HID quirks at module load time
254 */
255#define MAX_USBHID_BOOT_QUIRKS 4
256
257#define HID_QUIRK_INVERT 0x00000001
258#define HID_QUIRK_NOTOUCH 0x00000002
259#define HID_QUIRK_IGNORE 0x00000004
260#define HID_QUIRK_NOGET 0x00000008
261#define HID_QUIRK_HIDDEV 0x00000010
262#define HID_QUIRK_BADPAD 0x00000020
263#define HID_QUIRK_MULTI_INPUT 0x00000040
264#define HID_QUIRK_2WHEEL_MOUSE_HACK_7 0x00000080
265#define HID_QUIRK_2WHEEL_MOUSE_HACK_5 0x00000100
266#define HID_QUIRK_2WHEEL_MOUSE_HACK_ON 0x00000200
267#define HID_QUIRK_MIGHTYMOUSE 0x00000400
268#define HID_QUIRK_APPLE_HAS_FN 0x00000800
269#define HID_QUIRK_APPLE_FN_ON 0x00001000
270#define HID_QUIRK_INVERT_HWHEEL 0x00002000
271#define HID_QUIRK_APPLE_ISO_KEYBOARD 0x00004000
272#define HID_QUIRK_BAD_RELATIVE_KEYS 0x00008000
273#define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000
274#define HID_QUIRK_IGNORE_MOUSE 0x00020000
275#define HID_QUIRK_SONY_PS3_CONTROLLER 0x00040000
276#define HID_QUIRK_DUPLICATE_USAGES 0x00080000
277#define HID_QUIRK_RESET_LEDS 0x00100000
278#define HID_QUIRK_HIDINPUT 0x00200000
279#define HID_QUIRK_LOGITECH_IGNORE_DOUBLED_WHEEL 0x00400000
280#define HID_QUIRK_LOGITECH_EXPANDED_KEYMAP 0x00800000
281#define HID_QUIRK_IGNORE_HIDINPUT 0x01000000
282#define HID_QUIRK_2WHEEL_MOUSE_HACK_B8 0x02000000
283#define HID_QUIRK_HWHEEL_WHEEL_INVERT 0x04000000
284#define HID_QUIRK_MICROSOFT_KEYS 0x08000000
285#define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000
286#define HID_QUIRK_APPLE_NUMLOCK_EMULATION 0x20000000
287
288/*
289 * Separate quirks for runtime report descriptor fixup
290 */
291
292#define HID_QUIRK_RDESC_CYMOTION 0x00000001
293#define HID_QUIRK_RDESC_LOGITECH 0x00000002
294#define HID_QUIRK_RDESC_SWAPPED_MIN_MAX 0x00000004
295#define HID_QUIRK_RDESC_PETALYNX 0x00000008
296#define HID_QUIRK_RDESC_MACBOOK_JIS 0x00000010
297#define HID_QUIRK_RDESC_BUTTON_CONSUMER 0x00000020
298#define HID_QUIRK_RDESC_SAMSUNG_REMOTE 0x00000040
299#define HID_QUIRK_RDESC_MICROSOFT_RECV_1028 0x00000080
300#define HID_QUIRK_RDESC_SUNPLUS_WDESKTOP 0x00000100
301
302/*
303 * This is the global environment of the parser. This information is
304 * persistent for main-items. The global environment can be saved and
305 * restored with PUSH/POP statements.
306 */
307
308struct hid_global {
309 unsigned usage_page;
310 __s32 logical_minimum;
311 __s32 logical_maximum;
312 __s32 physical_minimum;
313 __s32 physical_maximum;
314 __s32 unit_exponent;
315 unsigned unit;
316 unsigned report_id;
317 unsigned report_size;
318 unsigned report_count;
319};
320
321/*
322 * This is the local environment. It is persistent up the next main-item.
323 */
324
325#define HID_MAX_USAGES 12288
326#define HID_DEFAULT_NUM_COLLECTIONS 16
327
328struct hid_local {
329 unsigned usage[HID_MAX_USAGES]; /* usage array */
330 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
331 unsigned usage_index;
332 unsigned usage_minimum;
333 unsigned delimiter_depth;
334 unsigned delimiter_branch;
335};
336
337/*
338 * This is the collection stack. We climb up the stack to determine
339 * application and function of each field.
340 */
341
342struct hid_collection {
343 unsigned type;
344 unsigned usage;
345 unsigned level;
346};
347
348struct hid_usage {
349 unsigned hid; /* hid usage code */
350 unsigned collection_index; /* index into collection array */
351 /* hidinput data */
352 __u16 code; /* input driver code */
353 __u8 type; /* input driver type */
354 __s8 hat_min; /* hat switch fun */
355 __s8 hat_max; /* ditto */
356 __s8 hat_dir; /* ditto */
357};
358
359struct hid_input;
360
361struct hid_field {
362 unsigned physical; /* physical usage for this field */
363 unsigned logical; /* logical usage for this field */
364 unsigned application; /* application usage for this field */
365 struct hid_usage *usage; /* usage table for this function */
366 unsigned maxusage; /* maximum usage index */
367 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
368 unsigned report_offset; /* bit offset in the report */
369 unsigned report_size; /* size of this field in the report */
370 unsigned report_count; /* number of this field in the report */
371 unsigned report_type; /* (input,output,feature) */
372 __s32 *value; /* last known value(s) */
373 __s32 logical_minimum;
374 __s32 logical_maximum;
375 __s32 physical_minimum;
376 __s32 physical_maximum;
377 __s32 unit_exponent;
378 unsigned unit;
379 struct hid_report *report; /* associated report */
380 unsigned index; /* index into report->field[] */
381 /* hidinput data */
382 struct hid_input *hidinput; /* associated input structure */
383 __u16 dpad; /* dpad input code */
384};
385
386#define HID_MAX_FIELDS 64
387
388struct hid_report {
389 struct list_head list;
390 unsigned id; /* id of this report */
391 unsigned type; /* report type */
392 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
393 unsigned maxfield; /* maximum valid field index */
394 unsigned size; /* size of the report (bits) */
395 struct hid_device *device; /* associated device */
396};
397
398struct hid_report_enum {
399 unsigned numbered;
400 struct list_head report_list;
401 struct hid_report *report_id_hash[256];
402};
403
404#define HID_REPORT_TYPES 3
405
406#define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
407#define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
408#define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
409#define HID_OUTPUT_FIFO_SIZE 64
410
411struct hid_control_fifo {
412 unsigned char dir;
413 struct hid_report *report;
414};
415
416#define HID_CLAIMED_INPUT 1
417#define HID_CLAIMED_HIDDEV 2
418#define HID_CLAIMED_HIDRAW 4
419
420#define HID_CTRL_RUNNING 1
421#define HID_OUT_RUNNING 2
422#define HID_IN_RUNNING 3
423#define HID_RESET_PENDING 4
424#define HID_SUSPENDED 5
425#define HID_CLEAR_HALT 6
426#define HID_DISCONNECTED 7
427
428struct hid_input {
429 struct list_head list;
430 struct hid_report *report;
431 struct input_dev *input;
432};
433
434struct hid_device { /* device report descriptor */
435 __u8 *rdesc;
436 unsigned rsize;
437 struct hid_collection *collection; /* List of HID collections */
438 unsigned collection_size; /* Number of allocated hid_collections */
439 unsigned maxcollection; /* Number of parsed collections */
440 unsigned maxapplication; /* Number of applications */
441 unsigned short bus; /* BUS ID */
442 unsigned short vendor; /* Vendor ID */
443 unsigned short product; /* Product ID */
444 unsigned version; /* HID version */
445 unsigned country; /* HID country */
446 struct hid_report_enum report_enum[HID_REPORT_TYPES];
447
448 struct device *dev; /* device */
449
450 unsigned claimed; /* Claimed by hidinput, hiddev? */
451 unsigned quirks; /* Various quirks the device can pull on us */
452
453 struct list_head inputs; /* The list of inputs */
454 void *hiddev; /* The hiddev structure */
455 void *hidraw;
456 int minor; /* Hiddev minor number */
457
458 int open; /* is the device open by anyone? */
459 char name[128]; /* Device name */
460 char phys[64]; /* Device physical location */
461 char uniq[64]; /* Device unique identifier (serial #) */
462
463 void *driver_data;
464
465 __s32 delayed_value; /* For A4 Tech mice hwheel quirk */
466
467 /* device-specific function pointers */
468 int (*hidinput_input_event) (struct input_dev *, unsigned int, unsigned int, int);
469 int (*hid_open) (struct hid_device *);
470 void (*hid_close) (struct hid_device *);
471
472 /* hiddev event handler */
473 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
474 struct hid_usage *, __s32);
475 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
476
477 /* handler for raw output data, used by hidraw */
478 int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t);
479#ifdef CONFIG_USB_HIDINPUT_POWERBOOK
480 unsigned long apple_pressed_fn[BITS_TO_LONGS(KEY_CNT)];
481 unsigned long pb_pressed_numlock[BITS_TO_LONGS(KEY_CNT)];
482#endif
483};
484
485#define HID_GLOBAL_STACK_SIZE 4
486#define HID_COLLECTION_STACK_SIZE 4
487
488struct hid_parser {
489 struct hid_global global;
490 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
491 unsigned global_stack_ptr;
492 struct hid_local local;
493 unsigned collection_stack[HID_COLLECTION_STACK_SIZE];
494 unsigned collection_stack_ptr;
495 struct hid_device *device;
496};
497
498struct hid_class_descriptor {
499 __u8 bDescriptorType;
500 __le16 wDescriptorLength;
501} __attribute__ ((packed));
502
503struct hid_descriptor {
504 __u8 bLength;
505 __u8 bDescriptorType;
506 __le16 bcdHID;
507 __u8 bCountryCode;
508 __u8 bNumDescriptors;
509
510 struct hid_class_descriptor desc[1];
511} __attribute__ ((packed));
512
513/* Applications from HID Usage Tables 4/8/99 Version 1.1 */
514/* We ignore a few input applications that are not widely used */
515#define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001))
516
517/* HID core API */
518
519#ifdef CONFIG_HID_DEBUG
520extern int hid_debug;
521#endif
522
523extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
524extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
525extern int hidinput_connect(struct hid_device *);
526extern void hidinput_disconnect(struct hid_device *);
527
528int hid_set_field(struct hid_field *, unsigned, __s32);
529int hid_input_report(struct hid_device *, int type, u8 *, int, int);
530int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
531int hidinput_mapping_quirks(struct hid_usage *, struct input_dev *, unsigned long **, int *);
532int hidinput_event_quirks(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
533int hidinput_apple_event(struct hid_device *, struct input_dev *, struct hid_usage *, __s32);
534void hid_output_report(struct hid_report *report, __u8 *data);
535void hid_free_device(struct hid_device *device);
536struct hid_device *hid_parse_report(__u8 *start, unsigned size);
537
538/* HID quirks API */
539u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
540int usbhid_quirks_init(char **quirks_param);
541void usbhid_quirks_exit(void);
542void usbhid_fixup_report_descriptor(const u16, const u16, char *, unsigned, char **);
543
544#ifdef CONFIG_HID_FF
545int hid_ff_init(struct hid_device *hid);
546
547int hid_lgff_init(struct hid_device *hid);
548int hid_lg2ff_init(struct hid_device *hid);
549int hid_plff_init(struct hid_device *hid);
550int hid_tmff_init(struct hid_device *hid);
551int hid_zpff_init(struct hid_device *hid);
552#ifdef CONFIG_HID_PID
553int hid_pidff_init(struct hid_device *hid);
554#else
555static inline int hid_pidff_init(struct hid_device *hid) { return -ENODEV; }
556#endif
557
558#else
559static inline int hid_ff_init(struct hid_device *hid) { return -1; }
560#endif
561
562#ifdef CONFIG_HID_DEBUG
563#define dbg_hid(format, arg...) if (hid_debug) \
564 printk(KERN_DEBUG "%s: " format ,\
565 __FILE__ , ## arg)
566#define dbg_hid_line(format, arg...) if (hid_debug) \
567 printk(format, ## arg)
568#else
569static inline int __attribute__((format(printf, 1, 2)))
570dbg_hid(const char *fmt, ...)
571{
572 return 0;
573}
574#define dbg_hid_line dbg_hid
575#endif
576
577#define err_hid(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
578 __FILE__ , ## arg)
579#endif
580#endif
581