5 * $Id: hid.h,v 1.24 2001/12/27 10:37:41 vojtech Exp $
7 * Copyright (c) 1999 Andreas Gal
8 * Copyright (c) 2000-2001 Vojtech Pavlik
9 * Copyright (c) 2006-2007 Jiri Kosina
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.
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.
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
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
32 #include <linux/types.h>
33 #include <linux/slab.h>
34 #include <linux/list.h>
35 #include <linux/timer.h>
36 #include <linux/workqueue.h>
37 #include <linux/input.h>
40 * USB HID (Human Interface Device) interface class code
43 #define USB_INTERFACE_CLASS_HID 3
46 * USB HID interface subclass and protocol codes
49 #define USB_INTERFACE_SUBCLASS_BOOT 1
50 #define USB_INTERFACE_PROTOCOL_KEYBOARD 1
51 #define USB_INTERFACE_PROTOCOL_MOUSE 2
57 #define HID_REQ_GET_REPORT 0x01
58 #define HID_REQ_GET_IDLE 0x02
59 #define HID_REQ_GET_PROTOCOL 0x03
60 #define HID_REQ_SET_REPORT 0x09
61 #define HID_REQ_SET_IDLE 0x0A
62 #define HID_REQ_SET_PROTOCOL 0x0B
65 * HID class descriptor types
68 #define HID_DT_HID (USB_TYPE_CLASS | 0x01)
69 #define HID_DT_REPORT (USB_TYPE_CLASS | 0x02)
70 #define HID_DT_PHYSICAL (USB_TYPE_CLASS | 0x03)
73 * We parse each description item into this structure. Short items data
74 * values are expanded to 32-bit signed int, long items contain a pointer
95 * HID report item format
98 #define HID_ITEM_FORMAT_SHORT 0
99 #define HID_ITEM_FORMAT_LONG 1
102 * Special tag indicating long items
105 #define HID_ITEM_TAG_LONG 15
108 * HID report descriptor item type (prefix bit 2,3)
111 #define HID_ITEM_TYPE_MAIN 0
112 #define HID_ITEM_TYPE_GLOBAL 1
113 #define HID_ITEM_TYPE_LOCAL 2
114 #define HID_ITEM_TYPE_RESERVED 3
117 * HID report descriptor main item tags
120 #define HID_MAIN_ITEM_TAG_INPUT 8
121 #define HID_MAIN_ITEM_TAG_OUTPUT 9
122 #define HID_MAIN_ITEM_TAG_FEATURE 11
123 #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10
124 #define HID_MAIN_ITEM_TAG_END_COLLECTION 12
127 * HID report descriptor main item contents
130 #define HID_MAIN_ITEM_CONSTANT 0x001
131 #define HID_MAIN_ITEM_VARIABLE 0x002
132 #define HID_MAIN_ITEM_RELATIVE 0x004
133 #define HID_MAIN_ITEM_WRAP 0x008
134 #define HID_MAIN_ITEM_NONLINEAR 0x010
135 #define HID_MAIN_ITEM_NO_PREFERRED 0x020
136 #define HID_MAIN_ITEM_NULL_STATE 0x040
137 #define HID_MAIN_ITEM_VOLATILE 0x080
138 #define HID_MAIN_ITEM_BUFFERED_BYTE 0x100
141 * HID report descriptor collection item types
144 #define HID_COLLECTION_PHYSICAL 0
145 #define HID_COLLECTION_APPLICATION 1
146 #define HID_COLLECTION_LOGICAL 2
149 * HID report descriptor global item tags
152 #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0
153 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1
154 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2
155 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3
156 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4
157 #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5
158 #define HID_GLOBAL_ITEM_TAG_UNIT 6
159 #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7
160 #define HID_GLOBAL_ITEM_TAG_REPORT_ID 8
161 #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9
162 #define HID_GLOBAL_ITEM_TAG_PUSH 10
163 #define HID_GLOBAL_ITEM_TAG_POP 11
166 * HID report descriptor local item tags
169 #define HID_LOCAL_ITEM_TAG_USAGE 0
170 #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1
171 #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2
172 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3
173 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4
174 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5
175 #define HID_LOCAL_ITEM_TAG_STRING_INDEX 7
176 #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8
177 #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9
178 #define HID_LOCAL_ITEM_TAG_DELIMITER 10
184 #define HID_USAGE_PAGE 0xffff0000
186 #define HID_UP_UNDEFINED 0x00000000
187 #define HID_UP_GENDESK 0x00010000
188 #define HID_UP_SIMULATION 0x00020000
189 #define HID_UP_KEYBOARD 0x00070000
190 #define HID_UP_LED 0x00080000
191 #define HID_UP_BUTTON 0x00090000
192 #define HID_UP_ORDINAL 0x000a0000
193 #define HID_UP_CONSUMER 0x000c0000
194 #define HID_UP_DIGITIZER 0x000d0000
195 #define HID_UP_PID 0x000f0000
196 #define HID_UP_HPVENDOR 0xff7f0000
197 #define HID_UP_MSVENDOR 0xff000000
198 #define HID_UP_CUSTOM 0x00ff0000
199 #define HID_UP_LOGIVENDOR 0xffbc0000
201 #define HID_USAGE 0x0000ffff
203 #define HID_GD_POINTER 0x00010001
204 #define HID_GD_MOUSE 0x00010002
205 #define HID_GD_JOYSTICK 0x00010004
206 #define HID_GD_GAMEPAD 0x00010005
207 #define HID_GD_KEYBOARD 0x00010006
208 #define HID_GD_KEYPAD 0x00010007
209 #define HID_GD_MULTIAXIS 0x00010008
210 #define HID_GD_X 0x00010030
211 #define HID_GD_Y 0x00010031
212 #define HID_GD_Z 0x00010032
213 #define HID_GD_RX 0x00010033
214 #define HID_GD_RY 0x00010034
215 #define HID_GD_RZ 0x00010035
216 #define HID_GD_SLIDER 0x00010036
217 #define HID_GD_DIAL 0x00010037
218 #define HID_GD_WHEEL 0x00010038
219 #define HID_GD_HATSWITCH 0x00010039
220 #define HID_GD_BUFFER 0x0001003a
221 #define HID_GD_BYTECOUNT 0x0001003b
222 #define HID_GD_MOTION 0x0001003c
223 #define HID_GD_START 0x0001003d
224 #define HID_GD_SELECT 0x0001003e
225 #define HID_GD_VX 0x00010040
226 #define HID_GD_VY 0x00010041
227 #define HID_GD_VZ 0x00010042
228 #define HID_GD_VBRX 0x00010043
229 #define HID_GD_VBRY 0x00010044
230 #define HID_GD_VBRZ 0x00010045
231 #define HID_GD_VNO 0x00010046
232 #define HID_GD_FEATURE 0x00010047
233 #define HID_GD_UP 0x00010090
234 #define HID_GD_DOWN 0x00010091
235 #define HID_GD_RIGHT 0x00010092
236 #define HID_GD_LEFT 0x00010093
239 * HID report types --- Ouch! HID spec says 1 2 3!
242 #define HID_INPUT_REPORT 0
243 #define HID_OUTPUT_REPORT 1
244 #define HID_FEATURE_REPORT 2
251 * Increase this if you need to configure more HID quirks at module load time
253 #define MAX_USBHID_BOOT_QUIRKS 4
255 #define HID_QUIRK_INVERT 0x00000001
256 #define HID_QUIRK_NOTOUCH 0x00000002
257 #define HID_QUIRK_IGNORE 0x00000004
258 #define HID_QUIRK_NOGET 0x00000008
259 #define HID_QUIRK_HIDDEV 0x00000010
260 #define HID_QUIRK_BADPAD 0x00000020
261 #define HID_QUIRK_MULTI_INPUT 0x00000040
262 #define HID_QUIRK_2WHEEL_MOUSE_HACK_7 0x00000080
263 #define HID_QUIRK_2WHEEL_MOUSE_HACK_5 0x00000100
264 #define HID_QUIRK_2WHEEL_MOUSE_HACK_ON 0x00000200
265 #define HID_QUIRK_MIGHTYMOUSE 0x00000400
266 #define HID_QUIRK_CYMOTION 0x00000800
267 #define HID_QUIRK_POWERBOOK_HAS_FN 0x00001000
268 #define HID_QUIRK_POWERBOOK_FN_ON 0x00002000
269 #define HID_QUIRK_INVERT_HWHEEL 0x00004000
270 #define HID_QUIRK_POWERBOOK_ISO_KEYBOARD 0x00008000
271 #define HID_QUIRK_BAD_RELATIVE_KEYS 0x00010000
272 #define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00020000
273 #define HID_QUIRK_IGNORE_MOUSE 0x00040000
274 #define HID_QUIRK_SONY_PS3_CONTROLLER 0x00080000
275 #define HID_QUIRK_LOGITECH_DESCRIPTOR 0x00100000
276 #define HID_QUIRK_DUPLICATE_USAGES 0x00200000
277 #define HID_QUIRK_RESET_LEDS 0x00400000
278 #define HID_QUIRK_SWAPPED_MIN_MAX 0x00800000
279 #define HID_QUIRK_HIDINPUT 0x01000000
280 #define HID_QUIRK_PETALYNX_DESCRIPTOR 0x02000000
283 * This is the global environment of the parser. This information is
284 * persistent for main-items. The global environment can be saved and
285 * restored with PUSH/POP statements.
290 __s32 logical_minimum;
291 __s32 logical_maximum;
292 __s32 physical_minimum;
293 __s32 physical_maximum;
297 unsigned report_size;
298 unsigned report_count;
302 * This is the local environment. It is persistent up the next main-item.
305 #define HID_MAX_DESCRIPTOR_SIZE 4096
306 #define HID_MAX_USAGES 8192
307 #define HID_DEFAULT_NUM_COLLECTIONS 16
310 unsigned usage[HID_MAX_USAGES]; /* usage array */
311 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
312 unsigned usage_index;
313 unsigned usage_minimum;
314 unsigned delimiter_depth;
315 unsigned delimiter_branch;
319 * This is the collection stack. We climb up the stack to determine
320 * application and function of each field.
323 struct hid_collection {
330 unsigned hid; /* hid usage code */
331 unsigned collection_index; /* index into collection array */
333 __u16 code; /* input driver code */
334 __u8 type; /* input driver type */
335 __s8 hat_min; /* hat switch fun */
336 __s8 hat_max; /* ditto */
337 __s8 hat_dir; /* ditto */
343 unsigned physical; /* physical usage for this field */
344 unsigned logical; /* logical usage for this field */
345 unsigned application; /* application usage for this field */
346 struct hid_usage *usage; /* usage table for this function */
347 unsigned maxusage; /* maximum usage index */
348 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
349 unsigned report_offset; /* bit offset in the report */
350 unsigned report_size; /* size of this field in the report */
351 unsigned report_count; /* number of this field in the report */
352 unsigned report_type; /* (input,output,feature) */
353 __s32 *value; /* last known value(s) */
354 __s32 logical_minimum;
355 __s32 logical_maximum;
356 __s32 physical_minimum;
357 __s32 physical_maximum;
360 struct hid_report *report; /* associated report */
361 unsigned index; /* index into report->field[] */
363 struct hid_input *hidinput; /* associated input structure */
364 __u16 dpad; /* dpad input code */
367 #define HID_MAX_FIELDS 64
370 struct list_head list;
371 unsigned id; /* id of this report */
372 unsigned type; /* report type */
373 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
374 unsigned maxfield; /* maximum valid field index */
375 unsigned size; /* size of the report (bits) */
376 struct hid_device *device; /* associated device */
379 struct hid_report_enum {
381 struct list_head report_list;
382 struct hid_report *report_id_hash[256];
385 #define HID_REPORT_TYPES 3
387 #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
388 #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
389 #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
390 #define HID_OUTPUT_FIFO_SIZE 64
392 struct hid_control_fifo {
394 struct hid_report *report;
397 #define HID_CLAIMED_INPUT 1
398 #define HID_CLAIMED_HIDDEV 2
400 #define HID_CTRL_RUNNING 1
401 #define HID_OUT_RUNNING 2
402 #define HID_IN_RUNNING 3
403 #define HID_RESET_PENDING 4
404 #define HID_SUSPENDED 5
405 #define HID_CLEAR_HALT 6
408 struct list_head list;
409 struct hid_report *report;
410 struct input_dev *input;
413 struct hid_device { /* device report descriptor */
416 struct hid_collection *collection; /* List of HID collections */
417 unsigned collection_size; /* Number of allocated hid_collections */
418 unsigned maxcollection; /* Number of parsed collections */
419 unsigned maxapplication; /* Number of applications */
420 unsigned short bus; /* BUS ID */
421 unsigned short vendor; /* Vendor ID */
422 unsigned short product; /* Product ID */
423 unsigned version; /* HID version */
424 unsigned country; /* HID country */
425 struct hid_report_enum report_enum[HID_REPORT_TYPES];
427 struct device *dev; /* device */
429 unsigned claimed; /* Claimed by hidinput, hiddev? */
430 unsigned quirks; /* Various quirks the device can pull on us */
432 struct list_head inputs; /* The list of inputs */
433 void *hiddev; /* The hiddev structure */
434 int minor; /* Hiddev minor number */
436 wait_queue_head_t wait; /* For sleeping */
438 int open; /* is the device open by anyone? */
439 char name[128]; /* Device name */
440 char phys[64]; /* Device physical location */
441 char uniq[64]; /* Device unique identifier (serial #) */
445 /* device-specific function pointers */
446 int (*hidinput_input_event) (struct input_dev *, unsigned int, unsigned int, int);
447 int (*hid_open) (struct hid_device *);
448 void (*hid_close) (struct hid_device *);
450 /* hiddev event handler */
451 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
452 struct hid_usage *, __s32);
453 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
454 #ifdef CONFIG_USB_HIDINPUT_POWERBOOK
455 unsigned long pb_pressed_fn[NBITS(KEY_MAX)];
456 unsigned long pb_pressed_numlock[NBITS(KEY_MAX)];
460 #define HID_GLOBAL_STACK_SIZE 4
461 #define HID_COLLECTION_STACK_SIZE 4
464 struct hid_global global;
465 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
466 unsigned global_stack_ptr;
467 struct hid_local local;
468 unsigned collection_stack[HID_COLLECTION_STACK_SIZE];
469 unsigned collection_stack_ptr;
470 struct hid_device *device;
473 struct hid_class_descriptor {
474 __u8 bDescriptorType;
475 __u16 wDescriptorLength;
476 } __attribute__ ((packed));
478 struct hid_descriptor {
480 __u8 bDescriptorType;
483 __u8 bNumDescriptors;
485 struct hid_class_descriptor desc[1];
486 } __attribute__ ((packed));
488 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
489 /* We ignore a few input applications that are not widely used */
490 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001))
493 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
494 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
495 extern int hidinput_connect(struct hid_device *);
496 extern void hidinput_disconnect(struct hid_device *);
498 int hid_set_field(struct hid_field *, unsigned, __s32);
499 int hid_input_report(struct hid_device *, int type, u8 *, int, int);
500 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
501 void hid_input_field(struct hid_device *hid, struct hid_field *field, __u8 *data, int interrupt);
502 void hid_output_report(struct hid_report *report, __u8 *data);
503 void hid_free_device(struct hid_device *device);
504 struct hid_device *hid_parse_report(__u8 *start, unsigned size);
507 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
508 int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct, const u32 quirks);
509 int usbhid_quirks_init(char **quirks_param);
510 void usbhid_quirks_exit(void);
513 int hid_ff_init(struct hid_device *hid);
515 int hid_lgff_init(struct hid_device *hid);
516 int hid_plff_init(struct hid_device *hid);
517 int hid_tmff_init(struct hid_device *hid);
518 int hid_zpff_init(struct hid_device *hid);
519 #ifdef CONFIG_HID_PID
520 int hid_pidff_init(struct hid_device *hid);
522 static inline int hid_pidff_init(struct hid_device *hid) { return -ENODEV; }
526 static inline int hid_ff_init(struct hid_device *hid) { return -1; }
529 #define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
532 #define dbg(format, arg...) do {} while (0)
535 #define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \