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