5 * Copyright (c) 1999 Andreas Gal
6 * Copyright (c) 2000-2001 Vojtech Pavlik
7 * Copyright (c) 2006-2007 Jiri Kosina
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.
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.
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
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
31 * USB HID (Human Interface Device) interface class code
34 #define USB_INTERFACE_CLASS_HID 3
37 * USB HID interface subclass and protocol codes
40 #define USB_INTERFACE_SUBCLASS_BOOT 1
41 #define USB_INTERFACE_PROTOCOL_KEYBOARD 1
42 #define USB_INTERFACE_PROTOCOL_MOUSE 2
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
56 * HID class descriptor types
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)
63 #define HID_MAX_DESCRIPTOR_SIZE 4096
67 #include <linux/types.h>
68 #include <linux/slab.h>
69 #include <linux/list.h>
70 #include <linux/mod_devicetable.h> /* hid_device_id */
71 #include <linux/timer.h>
72 #include <linux/workqueue.h>
73 #include <linux/input.h>
76 * We parse each description item into this structure. Short items data
77 * values are expanded to 32-bit signed int, long items contain a pointer
98 * HID report item format
101 #define HID_ITEM_FORMAT_SHORT 0
102 #define HID_ITEM_FORMAT_LONG 1
105 * Special tag indicating long items
108 #define HID_ITEM_TAG_LONG 15
111 * HID report descriptor item type (prefix bit 2,3)
114 #define HID_ITEM_TYPE_MAIN 0
115 #define HID_ITEM_TYPE_GLOBAL 1
116 #define HID_ITEM_TYPE_LOCAL 2
117 #define HID_ITEM_TYPE_RESERVED 3
120 * HID report descriptor main item tags
123 #define HID_MAIN_ITEM_TAG_INPUT 8
124 #define HID_MAIN_ITEM_TAG_OUTPUT 9
125 #define HID_MAIN_ITEM_TAG_FEATURE 11
126 #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10
127 #define HID_MAIN_ITEM_TAG_END_COLLECTION 12
130 * HID report descriptor main item contents
133 #define HID_MAIN_ITEM_CONSTANT 0x001
134 #define HID_MAIN_ITEM_VARIABLE 0x002
135 #define HID_MAIN_ITEM_RELATIVE 0x004
136 #define HID_MAIN_ITEM_WRAP 0x008
137 #define HID_MAIN_ITEM_NONLINEAR 0x010
138 #define HID_MAIN_ITEM_NO_PREFERRED 0x020
139 #define HID_MAIN_ITEM_NULL_STATE 0x040
140 #define HID_MAIN_ITEM_VOLATILE 0x080
141 #define HID_MAIN_ITEM_BUFFERED_BYTE 0x100
144 * HID report descriptor collection item types
147 #define HID_COLLECTION_PHYSICAL 0
148 #define HID_COLLECTION_APPLICATION 1
149 #define HID_COLLECTION_LOGICAL 2
152 * HID report descriptor global item tags
155 #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0
156 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1
157 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2
158 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3
159 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4
160 #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5
161 #define HID_GLOBAL_ITEM_TAG_UNIT 6
162 #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7
163 #define HID_GLOBAL_ITEM_TAG_REPORT_ID 8
164 #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9
165 #define HID_GLOBAL_ITEM_TAG_PUSH 10
166 #define HID_GLOBAL_ITEM_TAG_POP 11
169 * HID report descriptor local item tags
172 #define HID_LOCAL_ITEM_TAG_USAGE 0
173 #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1
174 #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2
175 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3
176 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4
177 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5
178 #define HID_LOCAL_ITEM_TAG_STRING_INDEX 7
179 #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8
180 #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9
181 #define HID_LOCAL_ITEM_TAG_DELIMITER 10
187 #define HID_USAGE_PAGE 0xffff0000
189 #define HID_UP_UNDEFINED 0x00000000
190 #define HID_UP_GENDESK 0x00010000
191 #define HID_UP_SIMULATION 0x00020000
192 #define HID_UP_KEYBOARD 0x00070000
193 #define HID_UP_LED 0x00080000
194 #define HID_UP_BUTTON 0x00090000
195 #define HID_UP_ORDINAL 0x000a0000
196 #define HID_UP_CONSUMER 0x000c0000
197 #define HID_UP_DIGITIZER 0x000d0000
198 #define HID_UP_PID 0x000f0000
199 #define HID_UP_HPVENDOR 0xff7f0000
200 #define HID_UP_MSVENDOR 0xff000000
201 #define HID_UP_CUSTOM 0x00ff0000
202 #define HID_UP_LOGIVENDOR 0xffbc0000
204 #define HID_USAGE 0x0000ffff
206 #define HID_GD_POINTER 0x00010001
207 #define HID_GD_MOUSE 0x00010002
208 #define HID_GD_JOYSTICK 0x00010004
209 #define HID_GD_GAMEPAD 0x00010005
210 #define HID_GD_KEYBOARD 0x00010006
211 #define HID_GD_KEYPAD 0x00010007
212 #define HID_GD_MULTIAXIS 0x00010008
213 #define HID_GD_X 0x00010030
214 #define HID_GD_Y 0x00010031
215 #define HID_GD_Z 0x00010032
216 #define HID_GD_RX 0x00010033
217 #define HID_GD_RY 0x00010034
218 #define HID_GD_RZ 0x00010035
219 #define HID_GD_SLIDER 0x00010036
220 #define HID_GD_DIAL 0x00010037
221 #define HID_GD_WHEEL 0x00010038
222 #define HID_GD_HATSWITCH 0x00010039
223 #define HID_GD_BUFFER 0x0001003a
224 #define HID_GD_BYTECOUNT 0x0001003b
225 #define HID_GD_MOTION 0x0001003c
226 #define HID_GD_START 0x0001003d
227 #define HID_GD_SELECT 0x0001003e
228 #define HID_GD_VX 0x00010040
229 #define HID_GD_VY 0x00010041
230 #define HID_GD_VZ 0x00010042
231 #define HID_GD_VBRX 0x00010043
232 #define HID_GD_VBRY 0x00010044
233 #define HID_GD_VBRZ 0x00010045
234 #define HID_GD_VNO 0x00010046
235 #define HID_GD_FEATURE 0x00010047
236 #define HID_GD_UP 0x00010090
237 #define HID_GD_DOWN 0x00010091
238 #define HID_GD_RIGHT 0x00010092
239 #define HID_GD_LEFT 0x00010093
242 * HID report types --- Ouch! HID spec says 1 2 3!
245 #define HID_INPUT_REPORT 0
246 #define HID_OUTPUT_REPORT 1
247 #define HID_FEATURE_REPORT 2
254 * Increase this if you need to configure more HID quirks at module load time
256 #define MAX_USBHID_BOOT_QUIRKS 4
258 #define HID_QUIRK_INVERT 0x00000001
259 #define HID_QUIRK_NOTOUCH 0x00000002
260 #define HID_QUIRK_IGNORE 0x00000004
261 #define HID_QUIRK_NOGET 0x00000008
262 #define HID_QUIRK_HIDDEV 0x00000010
263 #define HID_QUIRK_BADPAD 0x00000020
264 #define HID_QUIRK_MULTI_INPUT 0x00000040
265 #define HID_QUIRK_2WHEEL_MOUSE_HACK_7 0x00000080
266 #define HID_QUIRK_2WHEEL_MOUSE_HACK_5 0x00000100
267 #define HID_QUIRK_2WHEEL_MOUSE_HACK_ON 0x00000200
268 #define HID_QUIRK_MIGHTYMOUSE 0x00000400
269 #define HID_QUIRK_APPLE_HAS_FN 0x00000800
270 #define HID_QUIRK_APPLE_FN_ON 0x00001000
271 #define HID_QUIRK_INVERT_HWHEEL 0x00002000
272 #define HID_QUIRK_APPLE_ISO_KEYBOARD 0x00004000
273 #define HID_QUIRK_BAD_RELATIVE_KEYS 0x00008000
274 #define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000
275 #define HID_QUIRK_IGNORE_MOUSE 0x00020000
276 #define HID_QUIRK_SONY_PS3_CONTROLLER 0x00040000
277 #define HID_QUIRK_DUPLICATE_USAGES 0x00080000
278 #define HID_QUIRK_RESET_LEDS 0x00100000
279 #define HID_QUIRK_HIDINPUT 0x00200000
280 #define HID_QUIRK_LOGITECH_IGNORE_DOUBLED_WHEEL 0x00400000
281 #define HID_QUIRK_LOGITECH_EXPANDED_KEYMAP 0x00800000
282 #define HID_QUIRK_IGNORE_HIDINPUT 0x01000000
283 #define HID_QUIRK_2WHEEL_MOUSE_HACK_B8 0x02000000
284 #define HID_QUIRK_HWHEEL_WHEEL_INVERT 0x04000000
285 #define HID_QUIRK_MICROSOFT_KEYS 0x08000000
286 #define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000
287 #define HID_QUIRK_APPLE_NUMLOCK_EMULATION 0x20000000
290 * Separate quirks for runtime report descriptor fixup
293 #define HID_QUIRK_RDESC_CYMOTION 0x00000001
294 #define HID_QUIRK_RDESC_LOGITECH 0x00000002
295 #define HID_QUIRK_RDESC_SWAPPED_MIN_MAX 0x00000004
296 #define HID_QUIRK_RDESC_PETALYNX 0x00000008
297 #define HID_QUIRK_RDESC_MACBOOK_JIS 0x00000010
298 #define HID_QUIRK_RDESC_BUTTON_CONSUMER 0x00000020
299 #define HID_QUIRK_RDESC_SAMSUNG_REMOTE 0x00000040
300 #define HID_QUIRK_RDESC_MICROSOFT_RECV_1028 0x00000080
301 #define HID_QUIRK_RDESC_SUNPLUS_WDESKTOP 0x00000100
304 * This is the global environment of the parser. This information is
305 * persistent for main-items. The global environment can be saved and
306 * restored with PUSH/POP statements.
311 __s32 logical_minimum;
312 __s32 logical_maximum;
313 __s32 physical_minimum;
314 __s32 physical_maximum;
318 unsigned report_size;
319 unsigned report_count;
323 * This is the local environment. It is persistent up the next main-item.
326 #define HID_MAX_USAGES 12288
327 #define HID_DEFAULT_NUM_COLLECTIONS 16
330 unsigned usage[HID_MAX_USAGES]; /* usage array */
331 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
332 unsigned usage_index;
333 unsigned usage_minimum;
334 unsigned delimiter_depth;
335 unsigned delimiter_branch;
339 * This is the collection stack. We climb up the stack to determine
340 * application and function of each field.
343 struct hid_collection {
350 unsigned hid; /* hid usage code */
351 unsigned collection_index; /* index into collection array */
353 __u16 code; /* input driver code */
354 __u8 type; /* input driver type */
355 __s8 hat_min; /* hat switch fun */
356 __s8 hat_max; /* ditto */
357 __s8 hat_dir; /* ditto */
363 unsigned physical; /* physical usage for this field */
364 unsigned logical; /* logical usage for this field */
365 unsigned application; /* application usage for this field */
366 struct hid_usage *usage; /* usage table for this function */
367 unsigned maxusage; /* maximum usage index */
368 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
369 unsigned report_offset; /* bit offset in the report */
370 unsigned report_size; /* size of this field in the report */
371 unsigned report_count; /* number of this field in the report */
372 unsigned report_type; /* (input,output,feature) */
373 __s32 *value; /* last known value(s) */
374 __s32 logical_minimum;
375 __s32 logical_maximum;
376 __s32 physical_minimum;
377 __s32 physical_maximum;
380 struct hid_report *report; /* associated report */
381 unsigned index; /* index into report->field[] */
383 struct hid_input *hidinput; /* associated input structure */
384 __u16 dpad; /* dpad input code */
387 #define HID_MAX_FIELDS 64
390 struct list_head list;
391 unsigned id; /* id of this report */
392 unsigned type; /* report type */
393 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
394 unsigned maxfield; /* maximum valid field index */
395 unsigned size; /* size of the report (bits) */
396 struct hid_device *device; /* associated device */
399 struct hid_report_enum {
401 struct list_head report_list;
402 struct hid_report *report_id_hash[256];
405 #define HID_REPORT_TYPES 3
407 #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
408 #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
409 #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
410 #define HID_OUTPUT_FIFO_SIZE 64
412 struct hid_control_fifo {
414 struct hid_report *report;
417 #define HID_CLAIMED_INPUT 1
418 #define HID_CLAIMED_HIDDEV 2
419 #define HID_CLAIMED_HIDRAW 4
421 #define HID_STAT_ADDED 1
423 #define HID_CTRL_RUNNING 1
424 #define HID_OUT_RUNNING 2
425 #define HID_IN_RUNNING 3
426 #define HID_RESET_PENDING 4
427 #define HID_SUSPENDED 5
428 #define HID_CLEAR_HALT 6
429 #define HID_DISCONNECTED 7
432 struct list_head list;
433 struct hid_report *report;
434 struct input_dev *input;
439 struct hid_device { /* device report descriptor */
442 struct hid_collection *collection; /* List of HID collections */
443 unsigned collection_size; /* Number of allocated hid_collections */
444 unsigned maxcollection; /* Number of parsed collections */
445 unsigned maxapplication; /* Number of applications */
446 __u16 bus; /* BUS ID */
447 __u32 vendor; /* Vendor ID */
448 __u32 product; /* Product ID */
449 __u32 version; /* HID version */
450 unsigned country; /* HID country */
451 struct hid_report_enum report_enum[HID_REPORT_TYPES];
453 struct device dev; /* device */
454 struct hid_driver *driver;
456 unsigned int status; /* see STAT flags above */
457 unsigned claimed; /* Claimed by hidinput, hiddev? */
458 unsigned quirks; /* Various quirks the device can pull on us */
460 struct list_head inputs; /* The list of inputs */
461 void *hiddev; /* The hiddev structure */
463 int minor; /* Hiddev minor number */
465 int open; /* is the device open by anyone? */
466 char name[128]; /* Device name */
467 char phys[64]; /* Device physical location */
468 char uniq[64]; /* Device unique identifier (serial #) */
472 __s32 delayed_value; /* For A4 Tech mice hwheel quirk */
474 /* device-specific function pointers */
475 int (*hidinput_input_event) (struct input_dev *, unsigned int, unsigned int, int);
476 int (*hid_open) (struct hid_device *);
477 void (*hid_close) (struct hid_device *);
479 /* hiddev event handler */
480 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
481 struct hid_usage *, __s32);
482 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
484 /* handler for raw output data, used by hidraw */
485 int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t);
486 #ifdef CONFIG_USB_HIDINPUT_POWERBOOK
487 unsigned long apple_pressed_fn[BITS_TO_LONGS(KEY_CNT)];
488 unsigned long pb_pressed_numlock[BITS_TO_LONGS(KEY_CNT)];
492 static inline void *hid_get_drvdata(struct hid_device *hdev)
494 return dev_get_drvdata(&hdev->dev);
497 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
499 dev_set_drvdata(&hdev->dev, data);
502 #define HID_GLOBAL_STACK_SIZE 4
503 #define HID_COLLECTION_STACK_SIZE 4
506 struct hid_global global;
507 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
508 unsigned global_stack_ptr;
509 struct hid_local local;
510 unsigned collection_stack[HID_COLLECTION_STACK_SIZE];
511 unsigned collection_stack_ptr;
512 struct hid_device *device;
515 struct hid_class_descriptor {
516 __u8 bDescriptorType;
517 __le16 wDescriptorLength;
518 } __attribute__ ((packed));
520 struct hid_descriptor {
522 __u8 bDescriptorType;
525 __u8 bNumDescriptors;
527 struct hid_class_descriptor desc[1];
528 } __attribute__ ((packed));
530 #define HID_DEVICE(b, ven, prod) \
532 .vendor = (ven), .product = (prod)
534 #define HID_USB_DEVICE(ven, prod) HID_DEVICE(BUS_USB, ven, prod)
535 #define HID_BLUETOOTH_DEVICE(ven, prod) HID_DEVICE(BUS_BLUETOOTH, ven, prod)
537 #define HID_REPORT_ID(rep) \
539 #define HID_USAGE_ID(uhid, utype, ucode) \
540 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
541 /* we don't want to catch types and codes equal to 0 */
542 #define HID_TERMINATOR (HID_ANY_ID - 1)
544 struct hid_report_id {
547 struct hid_usage_id {
555 * @name: driver name (e.g. "Footech_bar-wheel")
556 * @id_table: which devices is this driver for (must be non-NULL for probe
558 * @probe: new device inserted
559 * @remove: device removed (NULL if not a hot-plug capable driver)
560 * @report_table: on which reports to call raw_event (NULL means all)
561 * @raw_event: if report in report_table, this hook is called (NULL means nop)
562 * @usage_table: on which events to call event (NULL means all)
563 * @event: if usage in usage_table, this hook is called (NULL means nop)
565 * raw_event and event should return 0 on no action performed, 1 when no
566 * further processing should be done and negative on error
570 const struct hid_device_id *id_table;
572 int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
573 void (*remove)(struct hid_device *dev);
575 const struct hid_report_id *report_table;
576 int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
578 const struct hid_usage_id *usage_table;
579 int (*event)(struct hid_device *hdev, struct hid_field *field,
580 struct hid_usage *usage, __s32 value);
582 struct device_driver driver;
585 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
586 /* We ignore a few input applications that are not widely used */
587 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || (a == 0x000d0002))
591 #ifdef CONFIG_HID_DEBUG
592 extern int hid_debug;
595 extern int hid_add_device(struct hid_device *);
596 extern void hid_destroy_device(struct hid_device *);
598 extern int __must_check __hid_register_driver(struct hid_driver *,
599 struct module *, const char *mod_name);
600 static inline int __must_check hid_register_driver(struct hid_driver *driver)
602 return __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
604 extern void hid_unregister_driver(struct hid_driver *);
606 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
607 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
608 extern int hidinput_connect(struct hid_device *);
609 extern void hidinput_disconnect(struct hid_device *);
611 int hid_set_field(struct hid_field *, unsigned, __s32);
612 int hid_input_report(struct hid_device *, int type, u8 *, int, int);
613 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
614 int hidinput_mapping_quirks(struct hid_usage *, struct input_dev *, unsigned long **, int *);
615 int hidinput_event_quirks(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
616 int hidinput_apple_event(struct hid_device *, struct input_dev *, struct hid_usage *, __s32);
617 void hid_output_report(struct hid_report *report, __u8 *data);
618 struct hid_device *hid_allocate_device(void);
619 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
621 void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
624 extern int hid_generic_init(void);
625 extern void hid_generic_exit(void);
628 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
629 int usbhid_quirks_init(char **quirks_param);
630 void usbhid_quirks_exit(void);
631 void usbhid_fixup_report_descriptor(const u16, const u16, char *, unsigned, char **);
634 int hid_ff_init(struct hid_device *hid);
636 int hid_lgff_init(struct hid_device *hid);
637 int hid_lg2ff_init(struct hid_device *hid);
638 int hid_plff_init(struct hid_device *hid);
639 int hid_tmff_init(struct hid_device *hid);
640 int hid_zpff_init(struct hid_device *hid);
641 #ifdef CONFIG_HID_PID
642 int hid_pidff_init(struct hid_device *hid);
644 static inline int hid_pidff_init(struct hid_device *hid) { return -ENODEV; }
648 static inline int hid_ff_init(struct hid_device *hid) { return -1; }
651 #ifdef CONFIG_HID_DEBUG
652 #define dbg_hid(format, arg...) if (hid_debug) \
653 printk(KERN_DEBUG "%s: " format ,\
655 #define dbg_hid_line(format, arg...) if (hid_debug) \
656 printk(format, ## arg)
658 static inline int __attribute__((format(printf, 1, 2)))
659 dbg_hid(const char *fmt, ...)
663 #define dbg_hid_line dbg_hid
666 #define err_hid(format, arg...) printk(KERN_ERR "%s: " format "\n" , \