SIM card related Projects » SIMtrace

#ifndef _USB_HID_H

#define _USB_HID_H

/*

 *

 * Portions of <linux/hid.h>:

 *  Copyright (c) 1999 Andreas Gal

 *  Copyright (c) 2000-2001 Vojtech Pavlik

 *  Copyright (c) 2006-2007 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

 *

 */

/*

 * 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)

#define HID_MAX_DESCRIPTOR_SIZE		4096

/*

 * 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

struct usb_hid_class_descriptor {

	uint8_t  bDescriptorType;

	uint16_t wDescriptorLength;

} __attribute__ ((packed));

struct usb_hid_descriptor {

	uint8_t  bLength;

	uint8_t  bDescriptorType;

	uint16_t bcdHID;

	uint8_t  bCountryCode;

	uint8_t  bNumDescriptors;

	struct hid_class_descriptor desc[1];

} __attribute__ ((packed));

/* 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))

#endif