[deliverable/linux.git] / include / linux / hid.h

#ifndef __HID_H
#define __HID_H

/*
 * $Id: hid.h,v 1.24 2001/12/27 10:37:41 vojtech Exp $
 *
 *  Copyright (c) 1999 Andreas Gal
 *  Copyright (c) 2000-2001 Vojtech Pavlik
 *  Copyright (c) 2006 Jiri Kosina
 */

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * Should you need to contact me, the author, you can do so either by
 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
 */

#include <linux/types.h>
#include <linux/slab.h>
#include <linux/list.h>
#include <linux/timer.h>
#include <linux/workqueue.h>
#include <linux/input.h>

/*
 * USB HID (Human Interface Device) interface class code
 */

#define USB_INTERFACE_CLASS_HID		3

/*
 * USB HID interface subclass and protocol codes
 */

#define USB_INTERFACE_SUBCLASS_BOOT	1
#define USB_INTERFACE_PROTOCOL_KEYBOARD	1
#define USB_INTERFACE_PROTOCOL_MOUSE	2

/*
 * HID class requests
 */

#define HID_REQ_GET_REPORT		0x01
#define HID_REQ_GET_IDLE		0x02
#define HID_REQ_GET_PROTOCOL		0x03
#define HID_REQ_SET_REPORT		0x09
#define HID_REQ_SET_IDLE		0x0A
#define HID_REQ_SET_PROTOCOL		0x0B

/*
 * HID class descriptor types
 */

#define HID_DT_HID			(USB_TYPE_CLASS | 0x01)
#define HID_DT_REPORT			(USB_TYPE_CLASS | 0x02)
#define HID_DT_PHYSICAL			(USB_TYPE_CLASS | 0x03)

/*
 * We parse each description item into this structure. Short items data
 * values are expanded to 32-bit signed int, long items contain a pointer
 * into the data area.
 */

struct hid_item {
	unsigned  format;
	__u8      size;
	__u8      type;
	__u8      tag;
	union {
	    __u8   u8;
	    __s8   s8;
	    __u16  u16;
	    __s16  s16;
	    __u32  u32;
	    __s32  s32;
	    __u8  *longdata;
	} data;
};

/*
 * HID report item format
 */

#define HID_ITEM_FORMAT_SHORT	0
#define HID_ITEM_FORMAT_LONG	1

/*
 * Special tag indicating long items
 */

#define HID_ITEM_TAG_LONG	15

/*
 * HID report descriptor item type (prefix bit 2,3)
 */

#define HID_ITEM_TYPE_MAIN		0
#define HID_ITEM_TYPE_GLOBAL		1
#define HID_ITEM_TYPE_LOCAL		2
#define HID_ITEM_TYPE_RESERVED		3

/*
 * HID report descriptor main item tags
 */

#define HID_MAIN_ITEM_TAG_INPUT			8
#define HID_MAIN_ITEM_TAG_OUTPUT		9
#define HID_MAIN_ITEM_TAG_FEATURE		11
#define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION	10
#define HID_MAIN_ITEM_TAG_END_COLLECTION	12

/*
 * HID report descriptor main item contents
 */

#define HID_MAIN_ITEM_CONSTANT		0x001
#define HID_MAIN_ITEM_VARIABLE		0x002
#define HID_MAIN_ITEM_RELATIVE		0x004
#define HID_MAIN_ITEM_WRAP		0x008
#define HID_MAIN_ITEM_NONLINEAR		0x010
#define HID_MAIN_ITEM_NO_PREFERRED	0x020
#define HID_MAIN_ITEM_NULL_STATE	0x040
#define HID_MAIN_ITEM_VOLATILE		0x080
#define HID_MAIN_ITEM_BUFFERED_BYTE	0x100

/*
 * HID report descriptor collection item types
 */

#define HID_COLLECTION_PHYSICAL		0
#define HID_COLLECTION_APPLICATION	1
#define HID_COLLECTION_LOGICAL		2

/*
 * HID report descriptor global item tags
 */

#define HID_GLOBAL_ITEM_TAG_USAGE_PAGE		0
#define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM	1
#define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM	2
#define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM	3
#define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM	4
#define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT	5
#define HID_GLOBAL_ITEM_TAG_UNIT		6
#define HID_GLOBAL_ITEM_TAG_REPORT_SIZE		7
#define HID_GLOBAL_ITEM_TAG_REPORT_ID		8
#define HID_GLOBAL_ITEM_TAG_REPORT_COUNT	9
#define HID_GLOBAL_ITEM_TAG_PUSH		10
#define HID_GLOBAL_ITEM_TAG_POP			11

/*
 * HID report descriptor local item tags
 */

#define HID_LOCAL_ITEM_TAG_USAGE		0
#define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM	1
#define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM	2
#define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX	3
#define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM	4
#define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM	5
#define HID_LOCAL_ITEM_TAG_STRING_INDEX		7
#define HID_LOCAL_ITEM_TAG_STRING_MINIMUM	8
#define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM	9
#define HID_LOCAL_ITEM_TAG_DELIMITER		10

/*
 * HID usage tables
 */

#define HID_USAGE_PAGE		0xffff0000

#define HID_UP_UNDEFINED	0x00000000
#define HID_UP_GENDESK		0x00010000
#define HID_UP_SIMULATION	0x00020000
#define HID_UP_KEYBOARD		0x00070000
#define HID_UP_LED		0x00080000
#define HID_UP_BUTTON		0x00090000
#define HID_UP_ORDINAL		0x000a0000
#define HID_UP_CONSUMER		0x000c0000
#define HID_UP_DIGITIZER	0x000d0000
#define HID_UP_PID		0x000f0000
#define HID_UP_HPVENDOR         0xff7f0000
#define HID_UP_MSVENDOR		0xff000000
#define HID_UP_CUSTOM		0x00ff0000
#define HID_UP_LOGIVENDOR	0xffbc0000

#define HID_USAGE		0x0000ffff

#define HID_GD_POINTER		0x00010001
#define HID_GD_MOUSE		0x00010002
#define HID_GD_JOYSTICK		0x00010004
#define HID_GD_GAMEPAD		0x00010005
#define HID_GD_KEYBOARD		0x00010006
#define HID_GD_KEYPAD		0x00010007
#define HID_GD_MULTIAXIS	0x00010008
#define HID_GD_X		0x00010030
#define HID_GD_Y		0x00010031
#define HID_GD_Z		0x00010032
#define HID_GD_RX		0x00010033
#define HID_GD_RY		0x00010034
#define HID_GD_RZ		0x00010035
#define HID_GD_SLIDER		0x00010036
#define HID_GD_DIAL		0x00010037
#define HID_GD_WHEEL		0x00010038
#define HID_GD_HATSWITCH	0x00010039
#define HID_GD_BUFFER		0x0001003a
#define HID_GD_BYTECOUNT	0x0001003b
#define HID_GD_MOTION		0x0001003c
#define HID_GD_START		0x0001003d
#define HID_GD_SELECT		0x0001003e
#define HID_GD_VX		0x00010040
#define HID_GD_VY		0x00010041
#define HID_GD_VZ		0x00010042
#define HID_GD_VBRX		0x00010043
#define HID_GD_VBRY		0x00010044
#define HID_GD_VBRZ		0x00010045
#define HID_GD_VNO		0x00010046
#define HID_GD_FEATURE		0x00010047
#define HID_GD_UP		0x00010090
#define HID_GD_DOWN		0x00010091
#define HID_GD_RIGHT		0x00010092
#define HID_GD_LEFT		0x00010093

/*
 * HID report types --- Ouch! HID spec says 1 2 3!
 */

#define HID_INPUT_REPORT	0
#define HID_OUTPUT_REPORT	1
#define HID_FEATURE_REPORT	2

/*
 * HID device quirks.
 */

#define HID_QUIRK_INVERT			0x00000001
#define HID_QUIRK_NOTOUCH			0x00000002
#define HID_QUIRK_IGNORE			0x00000004
#define HID_QUIRK_NOGET				0x00000008
#define HID_QUIRK_HIDDEV			0x00000010
#define HID_QUIRK_BADPAD			0x00000020
#define HID_QUIRK_MULTI_INPUT			0x00000040
#define HID_QUIRK_2WHEEL_MOUSE_HACK_7		0x00000080
#define HID_QUIRK_2WHEEL_MOUSE_HACK_5		0x00000100
#define HID_QUIRK_2WHEEL_MOUSE_HACK_ON		0x00000200
#define HID_QUIRK_MIGHTYMOUSE			0x00000400
#define HID_QUIRK_CYMOTION			0x00000800
#define HID_QUIRK_POWERBOOK_HAS_FN		0x00001000
#define HID_QUIRK_POWERBOOK_FN_ON		0x00002000
#define HID_QUIRK_INVERT_HWHEEL			0x00004000
#define HID_QUIRK_POWERBOOK_ISO_KEYBOARD        0x00008000
#define HID_QUIRK_BAD_RELATIVE_KEYS		0x00010000

/*
 * This is the global environment of the parser. This information is
 * persistent for main-items. The global environment can be saved and
 * restored with PUSH/POP statements.
 */

struct hid_global {
	unsigned usage_page;
	__s32    logical_minimum;
	__s32    logical_maximum;
	__s32    physical_minimum;
	__s32    physical_maximum;
	__s32    unit_exponent;
	unsigned unit;
	unsigned report_id;
	unsigned report_size;
	unsigned report_count;
};

/*
 * This is the local environment. It is persistent up the next main-item.
 */

#define HID_MAX_DESCRIPTOR_SIZE		4096
#define HID_MAX_USAGES			1024
#define HID_DEFAULT_NUM_COLLECTIONS	16

struct hid_local {
	unsigned usage[HID_MAX_USAGES]; /* usage array */
	unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
	unsigned usage_index;
	unsigned usage_minimum;
	unsigned delimiter_depth;
	unsigned delimiter_branch;
};

/*
 * This is the collection stack. We climb up the stack to determine
 * application and function of each field.
 */

struct hid_collection {
	unsigned type;
	unsigned usage;
	unsigned level;
};

struct hid_usage {
	unsigned  hid;			/* hid usage code */
	unsigned  collection_index;	/* index into collection array */
	/* hidinput data */
	__u16     code;			/* input driver code */
	__u8      type;			/* input driver type */
	__s8	  hat_min;		/* hat switch fun */
	__s8	  hat_max;		/* ditto */
	__s8	  hat_dir;		/* ditto */
};

struct hid_input;

struct hid_field {
	unsigned  physical;		/* physical usage for this field */
	unsigned  logical;		/* logical usage for this field */
	unsigned  application;		/* application usage for this field */
	struct hid_usage *usage;	/* usage table for this function */
	unsigned  maxusage;		/* maximum usage index */
	unsigned  flags;		/* main-item flags (i.e. volatile,array,constant) */
	unsigned  report_offset;	/* bit offset in the report */
	unsigned  report_size;		/* size of this field in the report */
	unsigned  report_count;		/* number of this field in the report */
	unsigned  report_type;		/* (input,output,feature) */
	__s32    *value;		/* last known value(s) */
	__s32     logical_minimum;
	__s32     logical_maximum;
	__s32     physical_minimum;
	__s32     physical_maximum;
	__s32     unit_exponent;
	unsigned  unit;
	struct hid_report *report;	/* associated report */
	unsigned index;			/* index into report->field[] */
	/* hidinput data */
	struct hid_input *hidinput;	/* associated input structure */
	__u16 dpad;			/* dpad input code */
};

#define HID_MAX_FIELDS 64

struct hid_report {
	struct list_head list;
	unsigned id;					/* id of this report */
	unsigned type;					/* report type */
	struct hid_field *field[HID_MAX_FIELDS];	/* fields of the report */
	unsigned maxfield;				/* maximum valid field index */
	unsigned size;					/* size of the report (bits) */
	struct hid_device *device;			/* associated device */
};

struct hid_report_enum {
	unsigned numbered;
	struct list_head report_list;
	struct hid_report *report_id_hash[256];
};

#define HID_REPORT_TYPES 3

#define HID_MIN_BUFFER_SIZE	64		/* make sure there is at least a packet size of space */
#define HID_MAX_BUFFER_SIZE	4096		/* 4kb */
#define HID_CONTROL_FIFO_SIZE	256		/* to init devices with >100 reports */
#define HID_OUTPUT_FIFO_SIZE	64

struct hid_control_fifo {
	unsigned char dir;
	struct hid_report *report;
};

#define HID_CLAIMED_INPUT	1
#define HID_CLAIMED_HIDDEV	2

#define HID_CTRL_RUNNING	1
#define HID_OUT_RUNNING		2
#define HID_IN_RUNNING		3
#define HID_RESET_PENDING	4
#define HID_SUSPENDED		5
#define HID_CLEAR_HALT		6

struct hid_input {
	struct list_head list;
	struct hid_report *report;
	struct input_dev *input;
};

struct hid_device {							/* device report descriptor */
	 __u8 *rdesc;
	unsigned rsize;
	struct hid_collection *collection;				/* List of HID collections */
	unsigned collection_size;					/* Number of allocated hid_collections */
	unsigned maxcollection;						/* Number of parsed collections */
	unsigned maxapplication;					/* Number of applications */
	unsigned short bus;                                             /* BUS ID */
	unsigned short vendor;                                          /* Vendor ID */
	unsigned short product;                                         /* Product ID */
	unsigned version;						/* HID version */
	unsigned country;						/* HID country */
	struct hid_report_enum report_enum[HID_REPORT_TYPES];

	struct device *dev;						/* device */

	unsigned claimed;						/* Claimed by hidinput, hiddev? */
	unsigned quirks;						/* Various quirks the device can pull on us */

	struct list_head inputs;					/* The list of inputs */
	void *hiddev;							/* The hiddev structure */
	int minor;							/* Hiddev minor number */

	wait_queue_head_t wait;						/* For sleeping */

	int open;							/* is the device open by anyone? */
	char name[128];							/* Device name */
	char phys[64];							/* Device physical location */
	char uniq[64];							/* Device unique identifier (serial #) */

	void *driver_data;

	/* device-specific function pointers */
	int (*hidinput_input_event) (struct input_dev *, unsigned int, unsigned int, int);
	int (*hidinput_open) (struct input_dev *);
	void (*hidinput_close) (struct input_dev *);

#ifdef CONFIG_USB_HIDINPUT_POWERBOOK
	unsigned long pb_pressed_fn[NBITS(KEY_MAX)];
	unsigned long pb_pressed_numlock[NBITS(KEY_MAX)];
#endif
};

#define HID_GLOBAL_STACK_SIZE 4
#define HID_COLLECTION_STACK_SIZE 4

struct hid_parser {
	struct hid_global     global;
	struct hid_global     global_stack[HID_GLOBAL_STACK_SIZE];
	unsigned              global_stack_ptr;
	struct hid_local      local;
	unsigned              collection_stack[HID_COLLECTION_STACK_SIZE];
	unsigned              collection_stack_ptr;
	struct hid_device    *device;
};

struct hid_class_descriptor {
	__u8  bDescriptorType;
	__u16 wDescriptorLength;
} __attribute__ ((packed));

struct hid_descriptor {
	__u8  bLength;
	__u8  bDescriptorType;
	__u16 bcdHID;
	__u8  bCountryCode;
	__u8  bNumDescriptors;

	struct hid_class_descriptor desc[1];
} __attribute__ ((packed));

#ifdef DEBUG
#include "hid-debug.h"
#else
#define hid_dump_input(a,b)	do { } while (0)
#define hid_dump_device(c)	do { } while (0)
#define hid_dump_field(a,b)	do { } while (0)
#define resolv_usage(a)		do { } while (0)
#define resolv_event(a,b)	do { } while (0)
#endif

#ifdef CONFIG_HID
/* Applications from HID Usage Tables 4/8/99 Version 1.1 */
/* We ignore a few input applications that are not widely used */
#define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001))
#else
#define IS_INPUT_APPLICATION(a) (0)
#endif

/* HID core API */
extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
extern int hidinput_connect(struct hid_device *);
extern void hidinput_disconnect(struct hid_device *);

int hid_set_field(struct hid_field *, unsigned, __s32);
int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
void hid_input_field(struct hid_device *hid, struct hid_field *field, __u8 *data, int interrupt);
void hid_output_report(struct hid_report *report, __u8 *data);
void hid_free_device(struct hid_device *device);
struct hid_device *hid_parse_report(__u8 *start, unsigned size);

#ifdef CONFIG_HID_FF
int hid_ff_init(struct hid_device *hid);

int hid_lgff_init(struct hid_device *hid);
int hid_tmff_init(struct hid_device *hid);
int hid_zpff_init(struct hid_device *hid);
#ifdef CONFIG_HID_PID
int hid_pidff_init(struct hid_device *hid);
#else
static inline int hid_pidff_init(struct hid_device *hid) { return -ENODEV; }
#endif

#else
static inline int hid_ff_init(struct hid_device *hid) { return -1; }
#endif
#ifdef DEBUG
#define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
		__FILE__ , ## arg)
#else
#define dbg(format, arg...) do {} while (0)
#endif

#define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
		__FILE__ , ## arg)
#endif
Commit	Line	Data
1da177e4 LT	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
dde5845a	9	* Copyright (c) 2006 Jiri Kosina
1da177e4 LT	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	#include <linux/types.h>
	33	#include <linux/slab.h>
	34	#include <linux/list.h>
aef4e266 AS	35	#include <linux/timer.h>
aef4e266 AS	36	#include <linux/workqueue.h>
dde5845a	37	#include <linux/input.h>
1da177e4 LT	38
	39	/*
	40	* USB HID (Human Interface Device) interface class code
	41	*/
	42
	43	#define USB_INTERFACE_CLASS_HID 3
	44
0f28b55d AS	45	/*
	46	* USB HID interface subclass and protocol codes
	47	*/
	48
	49	#define USB_INTERFACE_SUBCLASS_BOOT 1
	50	#define USB_INTERFACE_PROTOCOL_KEYBOARD 1
	51	#define USB_INTERFACE_PROTOCOL_MOUSE 2
	52
1da177e4 LT	53	/*
	54	* HID class requests
	55	*/
	56
	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
	63
	64	/*
	65	* HID class descriptor types
	66	*/
	67
	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)
	71
	72	/*
	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
	75	* into the data area.
	76	*/
	77
	78	struct hid_item {
	79	unsigned format;
	80	__u8 size;
	81	__u8 type;
	82	__u8 tag;
	83	union {
	84	__u8 u8;
	85	__s8 s8;
	86	__u16 u16;
	87	__s16 s16;
	88	__u32 u32;
	89	__s32 s32;
	90	__u8 *longdata;
	91	} data;
	92	};
	93
	94	/*
	95	* HID report item format
	96	*/
	97
	98	#define HID_ITEM_FORMAT_SHORT 0
	99	#define HID_ITEM_FORMAT_LONG 1
	100
	101	/*
	102	* Special tag indicating long items
	103	*/
	104
	105	#define HID_ITEM_TAG_LONG 15
	106
	107	/*
	108	* HID report descriptor item type (prefix bit 2,3)
	109	*/
	110
	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
	115
	116	/*
117	* HID report descriptor main item tags
118	*/
119
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
125
126	/*
127	* HID report descriptor main item contents
128	*/
129
130	#define HID_MAIN_ITEM_CONSTANT 0x001
131	#define HID_MAIN_ITEM_VARIABLE 0x002
132	#define HID_MAIN_ITEM_RELATIVE 0x004
05f091ab	133	#define HID_MAIN_ITEM_WRAP 0x008
1da177e4 LT	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
	139
	140	/*
	141	* HID report descriptor collection item types
	142	*/
	143
	144	#define HID_COLLECTION_PHYSICAL 0
	145	#define HID_COLLECTION_APPLICATION 1
	146	#define HID_COLLECTION_LOGICAL 2
	147
	148	/*
	149	* HID report descriptor global item tags
	150	*/
	151
	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
	164
	165	/*
	166	* HID report descriptor local item tags
	167	*/
	168
	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
	179
	180	/*
	181	* HID usage tables
	182	*/
	183
	184	#define HID_USAGE_PAGE 0xffff0000
	185
	186	#define HID_UP_UNDEFINED 0x00000000
05f091ab	187	#define HID_UP_GENDESK 0x00010000
0aebfdac	188	#define HID_UP_SIMULATION 0x00020000
05f091ab DT	189	#define HID_UP_KEYBOARD 0x00070000
	190	#define HID_UP_LED 0x00080000
	191	#define HID_UP_BUTTON 0x00090000
	192	#define HID_UP_ORDINAL 0x000a0000
1da177e4	193	#define HID_UP_CONSUMER 0x000c0000
05f091ab DT	194	#define HID_UP_DIGITIZER 0x000d0000
05f091ab DT	195	#define HID_UP_PID 0x000f0000
1da177e4 LT	196	#define HID_UP_HPVENDOR 0xff7f0000
1da177e4 LT	197	#define HID_UP_MSVENDOR 0xff000000
e875ce37 SP	198	#define HID_UP_CUSTOM 0x00ff0000
e875ce37 SP	199	#define HID_UP_LOGIVENDOR 0xffbc0000
1da177e4 LT	200
	201	#define HID_USAGE 0x0000ffff
	202
	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
	237
	238	/*
	239	* HID report types --- Ouch! HID spec says 1 2 3!
	240	*/
	241
	242	#define HID_INPUT_REPORT 0
	243	#define HID_OUTPUT_REPORT 1
	244	#define HID_FEATURE_REPORT 2
	245
	246	/*
	247	* HID device quirks.
	248	*/
	249
eab9edd2 MH	250	#define HID_QUIRK_INVERT 0x00000001
	251	#define HID_QUIRK_NOTOUCH 0x00000002
	252	#define HID_QUIRK_IGNORE 0x00000004
	253	#define HID_QUIRK_NOGET 0x00000008
	254	#define HID_QUIRK_HIDDEV 0x00000010
	255	#define HID_QUIRK_BADPAD 0x00000020
	256	#define HID_QUIRK_MULTI_INPUT 0x00000040
	257	#define HID_QUIRK_2WHEEL_MOUSE_HACK_7 0x00000080
	258	#define HID_QUIRK_2WHEEL_MOUSE_HACK_5 0x00000100
	259	#define HID_QUIRK_2WHEEL_MOUSE_HACK_ON 0x00000200
a82e49b8	260	#define HID_QUIRK_MIGHTYMOUSE 0x00000400
eab9edd2 MH	261	#define HID_QUIRK_CYMOTION 0x00000800
	262	#define HID_QUIRK_POWERBOOK_HAS_FN 0x00001000
	263	#define HID_QUIRK_POWERBOOK_FN_ON 0x00002000
a82e49b8	264	#define HID_QUIRK_INVERT_HWHEEL 0x00004000
dde5845a	265	#define HID_QUIRK_POWERBOOK_ISO_KEYBOARD 0x00008000
bef98650	266	#define HID_QUIRK_BAD_RELATIVE_KEYS 0x00010000
1da177e4 LT	267
	268	/*
	269	* This is the global environment of the parser. This information is
	270	* persistent for main-items. The global environment can be saved and
	271	* restored with PUSH/POP statements.
	272	*/
	273
	274	struct hid_global {
	275	unsigned usage_page;
	276	__s32 logical_minimum;
	277	__s32 logical_maximum;
	278	__s32 physical_minimum;
	279	__s32 physical_maximum;
	280	__s32 unit_exponent;
	281	unsigned unit;
	282	unsigned report_id;
	283	unsigned report_size;
	284	unsigned report_count;
	285	};
	286
	287	/*
	288	* This is the local environment. It is persistent up the next main-item.
	289	*/
	290
	291	#define HID_MAX_DESCRIPTOR_SIZE 4096
	292	#define HID_MAX_USAGES 1024
	293	#define HID_DEFAULT_NUM_COLLECTIONS 16
	294
	295	struct hid_local {
	296	unsigned usage[HID_MAX_USAGES]; /* usage array */
	297	unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
	298	unsigned usage_index;
	299	unsigned usage_minimum;
	300	unsigned delimiter_depth;
	301	unsigned delimiter_branch;
	302	};
	303
	304	/*
	305	* This is the collection stack. We climb up the stack to determine
	306	* application and function of each field.
	307	*/
	308
	309	struct hid_collection {
	310	unsigned type;
	311	unsigned usage;
	312	unsigned level;
	313	};
	314
	315	struct hid_usage {
	316	unsigned hid; /* hid usage code */
	317	unsigned collection_index; /* index into collection array */
	318	/* hidinput data */
	319	__u16 code; /* input driver code */
	320	__u8 type; /* input driver type */
	321	__s8 hat_min; /* hat switch fun */
	322	__s8 hat_max; /* ditto */
	323	__s8 hat_dir; /* ditto */
	324	};
	325
	326	struct hid_input;
	327
	328	struct hid_field {
	329	unsigned physical; /* physical usage for this field */
	330	unsigned logical; /* logical usage for this field */
331	unsigned application; /* application usage for this field */
332	struct hid_usage usage; / usage table for this function */
333	unsigned maxusage; /* maximum usage index */
334	unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
335	unsigned report_offset; /* bit offset in the report */
336	unsigned report_size; /* size of this field in the report */
337	unsigned report_count; /* number of this field in the report */
338	unsigned report_type; /* (input,output,feature) */
339	__s32 value; / last known value(s) */
340	__s32 logical_minimum;
341	__s32 logical_maximum;
342	__s32 physical_minimum;
343	__s32 physical_maximum;
344	__s32 unit_exponent;
345	unsigned unit;
346	struct hid_report report; / associated report */
347	unsigned index; /* index into report->field[] */
348	/* hidinput data */
349	struct hid_input hidinput; / associated input structure */
350	__u16 dpad; /* dpad input code */
351	};
352
353	#define HID_MAX_FIELDS 64
354
355	struct hid_report {
356	struct list_head list;
357	unsigned id; /* id of this report */
358	unsigned type; /* report type */
359	struct hid_field field[HID_MAX_FIELDS]; / fields of the report */
360	unsigned maxfield; /* maximum valid field index */
361	unsigned size; /* size of the report (bits) */
362	struct hid_device device; / associated device */
363	};
364
365	struct hid_report_enum {
366	unsigned numbered;
367	struct list_head report_list;
368	struct hid_report *report_id_hash[256];
369	};
370
371	#define HID_REPORT_TYPES 3
372
bf0964dc MH	373	#define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
bf0964dc MH	374	#define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
1da177e4 LT	375	#define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
	376	#define HID_OUTPUT_FIFO_SIZE 64
	377
	378	struct hid_control_fifo {
	379	unsigned char dir;
	380	struct hid_report *report;
	381	};
	382
	383	#define HID_CLAIMED_INPUT 1
	384	#define HID_CLAIMED_HIDDEV 2
	385
	386	#define HID_CTRL_RUNNING 1
	387	#define HID_OUT_RUNNING 2
aef4e266 AS	388	#define HID_IN_RUNNING 3
	389	#define HID_RESET_PENDING 4
	390	#define HID_SUSPENDED 5
6d8fc4d2	391	#define HID_CLEAR_HALT 6
1da177e4 LT	392
	393	struct hid_input {
	394	struct list_head list;
	395	struct hid_report *report;
c5b7c7c3	396	struct input_dev *input;
1da177e4 LT	397	};
	398
	399	struct hid_device { /* device report descriptor */
	400	__u8 *rdesc;
	401	unsigned rsize;
	402	struct hid_collection collection; / List of HID collections */
	403	unsigned collection_size; /* Number of allocated hid_collections */
	404	unsigned maxcollection; /* Number of parsed collections */
	405	unsigned maxapplication; /* Number of applications */
229695e5 JK	406	unsigned short bus; /* BUS ID */
	407	unsigned short vendor; /* Vendor ID */
	408	unsigned short product; /* Product ID */
1da177e4 LT	409	unsigned version; /* HID version */
	410	unsigned country; /* HID country */
	411	struct hid_report_enum report_enum[HID_REPORT_TYPES];
	412
4916b3a5	413	struct device dev; / device */
1da177e4	414
05f091ab	415	unsigned claimed; /* Claimed by hidinput, hiddev? */
1da177e4 LT	416	unsigned quirks; /* Various quirks the device can pull on us */
	417
	418	struct list_head inputs; /* The list of inputs */
	419	void hiddev; / The hiddev structure */
	420	int minor; /* Hiddev minor number */
	421
	422	wait_queue_head_t wait; /* For sleeping */
	423
	424	int open; /* is the device open by anyone? */
	425	char name[128]; /* Device name */
	426	char phys[64]; /* Device physical location */
	427	char uniq[64]; /* Device unique identifier (serial #) */
	428
229695e5 JK	429	void *driver_data;
	430
	431	/* device-specific function pointers */
	432	int (hidinput_input_event) (struct input_dev , unsigned int, unsigned int, int);
	433	int (hidinput_open) (struct input_dev );
	434	void (hidinput_close) (struct input_dev );
	435
eab9edd2 MH	436	#ifdef CONFIG_USB_HIDINPUT_POWERBOOK
	437	unsigned long pb_pressed_fn[NBITS(KEY_MAX)];
	438	unsigned long pb_pressed_numlock[NBITS(KEY_MAX)];
	439	#endif
1da177e4 LT	440	};
	441
	442	#define HID_GLOBAL_STACK_SIZE 4
	443	#define HID_COLLECTION_STACK_SIZE 4
	444
	445	struct hid_parser {
	446	struct hid_global global;
	447	struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
	448	unsigned global_stack_ptr;
	449	struct hid_local local;
	450	unsigned collection_stack[HID_COLLECTION_STACK_SIZE];
	451	unsigned collection_stack_ptr;
	452	struct hid_device *device;
	453	};
	454
	455	struct hid_class_descriptor {
	456	__u8 bDescriptorType;
	457	__u16 wDescriptorLength;
	458	} __attribute__ ((packed));
	459
	460	struct hid_descriptor {
	461	__u8 bLength;
	462	__u8 bDescriptorType;
	463	__u16 bcdHID;
	464	__u8 bCountryCode;
	465	__u8 bNumDescriptors;
	466
	467	struct hid_class_descriptor desc[1];
	468	} __attribute__ ((packed));
	469
	470	#ifdef DEBUG
	471	#include "hid-debug.h"
	472	#else
	473	#define hid_dump_input(a,b) do { } while (0)
	474	#define hid_dump_device(c) do { } while (0)
	475	#define hid_dump_field(a,b) do { } while (0)
	476	#define resolv_usage(a) do { } while (0)
	477	#define resolv_event(a,b) do { } while (0)
	478	#endif
	479
dde5845a	480	#ifdef CONFIG_HID
1da177e4 LT	481	/* Applications from HID Usage Tables 4/8/99 Version 1.1 */
	482	/* We ignore a few input applications that are not widely used */
	483	#define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) \|\| (a == 0x00010080) \|\| (a == 0x000c0001))
229695e5 JK	484	#else
	485	#define IS_INPUT_APPLICATION(a) (0)
	486	#endif
	487
	488	/* HID core API */
7d12e780	489	extern void hidinput_hid_event(struct hid_device , struct hid_field , struct hid_usage *, __s32);
1da177e4 LT	490	extern void hidinput_report_event(struct hid_device hid, struct hid_report report);
	491	extern int hidinput_connect(struct hid_device *);
	492	extern void hidinput_disconnect(struct hid_device *);
1da177e4	493
1da177e4	494	int hid_set_field(struct hid_field *, unsigned, __s32);
dde5845a JK	495	int hidinput_find_field(struct hid_device hid, unsigned int type, unsigned int code, struct hid_field *field);
	496	void hid_input_field(struct hid_device hid, struct hid_field field, __u8 *data, int interrupt);
	497	void hid_output_report(struct hid_report report, __u8 data);
	498	void hid_free_device(struct hid_device *device);
	499	struct hid_device hid_parse_report(__u8 start, unsigned size);
1da177e4 LT	500
	501	#ifdef CONFIG_HID_FF
	502	int hid_ff_init(struct hid_device *hid);
224ee88f AH	503
	504	int hid_lgff_init(struct hid_device *hid);
	505	int hid_tmff_init(struct hid_device *hid);
bb3caf7f	506	int hid_zpff_init(struct hid_device *hid);
224ee88f AH	507	#ifdef CONFIG_HID_PID
	508	int hid_pidff_init(struct hid_device *hid);
	509	#else
	510	static inline int hid_pidff_init(struct hid_device *hid) { return -ENODEV; }
	511	#endif
	512
1da177e4 LT	513	#else
	514	static inline int hid_ff_init(struct hid_device *hid) { return -1; }
	515	#endif
229695e5 JK	516	#ifdef DEBUG
	517	#define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
	518	__FILE__ , ## arg)
	519	#else
	520	#define dbg(format, arg...) do {} while (0)
	521	#endif
	522
	523	#define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
	524	__FILE__ , ## arg)
dde5845a	525	#endif
224ee88f	526