[mirror_edk2.git] / MdePkg / Include / IndustryStandard / Usb.h

/** @file\r
  Support for USB 1.1 standard.\r
\r
  Copyright (c) 2006 - 2007, Intel Corporation\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __USB_H__\r
#define __USB_H__\r
\r
\r
//\r
// Definitions defined in UEFI spec\r
//\r
\r
//\r
// USB Transfer Results\r
//\r
#define EFI_USB_NOERROR             0x00\r
#define EFI_USB_ERR_NOTEXECUTE      0x01\r
#define EFI_USB_ERR_STALL           0x02\r
#define EFI_USB_ERR_BUFFER          0x04\r
#define EFI_USB_ERR_BABBLE          0x08\r
#define EFI_USB_ERR_NAK             0x10\r
#define EFI_USB_ERR_CRC             0x20\r
#define EFI_USB_ERR_TIMEOUT         0x40\r
#define EFI_USB_ERR_BITSTUFF        0x80\r
#define EFI_USB_ERR_SYSTEM          0x100\r
\r
//\r
// Constant value for Port Status & Port Change Status\r
//\r
#define USB_PORT_STAT_CONNECTION    0x0001\r
#define USB_PORT_STAT_ENABLE        0x0002\r
#define USB_PORT_STAT_SUSPEND       0x0004\r
#define USB_PORT_STAT_OVERCURRENT   0x0008\r
#define USB_PORT_STAT_RESET         0x0010\r
#define USB_PORT_STAT_POWER         0x0100\r
#define USB_PORT_STAT_LOW_SPEED     0x0200\r
#define USB_PORT_STAT_HIGH_SPEED    0x0400\r
#define USB_PORT_STAT_OWNER         0x0800\r
\r
#define USB_PORT_STAT_C_CONNECTION  0x0001\r
#define USB_PORT_STAT_C_ENABLE      0x0002\r
#define USB_PORT_STAT_C_SUSPEND     0x0004\r
#define USB_PORT_STAT_C_OVERCURRENT 0x0008\r
#define USB_PORT_STAT_C_RESET       0x0010\r
\r
//\r
// USB data transfer direction\r
//\r
typedef enum {\r
  EfiUsbDataIn,\r
  EfiUsbDataOut,\r
  EfiUsbNoData\r
} EFI_USB_DATA_DIRECTION;\r
\r
//\r
// Usb port features\r
//\r
typedef enum {\r
  EfiUsbPortEnable            = 1,\r
  EfiUsbPortSuspend           = 2,\r
  EfiUsbPortReset             = 4,\r
  EfiUsbPortPower             = 8,\r
  EfiUsbPortOwner             = 13,\r
  EfiUsbPortConnectChange     = 16,\r
  EfiUsbPortEnableChange      = 17,\r
  EfiUsbPortSuspendChange     = 18,\r
  EfiUsbPortOverCurrentChange = 19,\r
  EfiUsbPortResetChange       = 20\r
} EFI_USB_PORT_FEATURE;\r
\r
\r
//\r
// USB standard descriptors and reqeust\r
//\r
#pragma pack(1)\r
typedef struct {\r
  UINT8           RequestType;\r
  UINT8           Request;\r
  UINT16          Value;\r
  UINT16          Index;\r
  UINT16          Length;\r
} EFI_USB_DEVICE_REQUEST;\r
\r
typedef struct {\r
  UINT8           Length;\r
  UINT8           DescriptorType;\r
  UINT16          BcdUSB;\r
  UINT8           DeviceClass;\r
  UINT8           DeviceSubClass;\r
  UINT8           DeviceProtocol;\r
  UINT8           MaxPacketSize0;\r
  UINT16          IdVendor;\r
  UINT16          IdProduct;\r
  UINT16          BcdDevice;\r
  UINT8           StrManufacturer;\r
  UINT8           StrProduct;\r
  UINT8           StrSerialNumber;\r
  UINT8           NumConfigurations;\r
} EFI_USB_DEVICE_DESCRIPTOR;\r
\r
typedef struct {\r
  UINT8           Length;\r
  UINT8           DescriptorType;\r
  UINT16          TotalLength;\r
  UINT8           NumInterfaces;\r
  UINT8           ConfigurationValue;\r
  UINT8           Configuration;\r
  UINT8           Attributes;\r
  UINT8           MaxPower;\r
} EFI_USB_CONFIG_DESCRIPTOR;\r
\r
typedef struct {\r
  UINT8           Length;\r
  UINT8           DescriptorType;\r
  UINT8           InterfaceNumber;\r
  UINT8           AlternateSetting;\r
  UINT8           NumEndpoints;\r
  UINT8           InterfaceClass;\r
  UINT8           InterfaceSubClass;\r
  UINT8           InterfaceProtocol;\r
  UINT8           Interface;\r
} EFI_USB_INTERFACE_DESCRIPTOR;\r
\r
typedef struct {\r
  UINT8           Length;\r
  UINT8           DescriptorType;\r
  UINT8           EndpointAddress;\r
  UINT8           Attributes;\r
  UINT16          MaxPacketSize;\r
  UINT8           Interval;\r
} EFI_USB_ENDPOINT_DESCRIPTOR;\r
\r
typedef struct {\r
  UINT8           Length;\r
  UINT8           DescriptorType;\r
  CHAR16          String[1];\r
} EFI_USB_STRING_DESCRIPTOR;\r
\r
#pragma pack()\r
\r
typedef struct {\r
  UINT16          PortStatus;\r
  UINT16          PortChangeStatus;\r
} EFI_USB_PORT_STATUS;\r
\r
\r
//\r
// Following are definitions not specified by UEFI spec.\r
// Add new definitions below this line\r
//\r
enum {\r
  //\r
  // USB request type\r
  //\r
  USB_REQ_TYPE_STANDARD   = (0x00 << 5),\r
  USB_REQ_TYPE_CLASS      = (0x01 << 5),\r
  USB_REQ_TYPE_VENDOR     = (0x02 << 5),\r
\r
  //\r
  // Standard control transfer request type, or the value\r
  // to fill in EFI_USB_DEVICE_REQUEST.Request\r
  //\r
  USB_REQ_GET_STATUS      = 0x00,\r
  USB_REQ_CLEAR_FEATURE   = 0x01,\r
  USB_REQ_SET_FEATURE     = 0x03,\r
  USB_REQ_SET_ADDRESS     = 0x05,\r
  USB_REQ_GET_DESCRIPTOR  = 0x06,\r
  USB_REQ_SET_DESCRIPTOR  = 0x07,\r
  USB_REQ_GET_CONFIG      = 0x08,\r
  USB_REQ_SET_CONFIG      = 0x09,\r
  USB_REQ_GET_INTERFACE   = 0x0A,\r
  USB_REQ_SET_INTERFACE   = 0x0B,\r
  USB_REQ_SYNCH_FRAME     = 0x0C,\r
\r
  //\r
  // Usb control transfer target\r
  //\r
  USB_TARGET_DEVICE       = 0,\r
  USB_TARGET_INTERFACE    = 0x01,\r
  USB_TARGET_ENDPOINT     = 0x02,\r
  USB_TARGET_OTHER        = 0x03,\r
\r
  //\r
  // USB Descriptor types\r
  //\r
  USB_DESC_TYPE_DEVICE    = 0x01,\r
  USB_DESC_TYPE_CONFIG    = 0x02,\r
  USB_DESC_TYPE_STRING    = 0x03,\r
  USB_DESC_TYPE_INTERFACE = 0x04,\r
  USB_DESC_TYPE_ENDPOINT  = 0x05,\r
  USB_DESC_TYPE_HID       = 0x21,\r
\r
  //\r
  // Features to be cleared by CLEAR_FEATURE requests\r
  //\r
  USB_FEATURE_ENDPOINT_HALT = 0,\r
\r
  //\r
  // USB endpoint types: 00: control, 01: isochronous, 10: bulk, 11: interrupt\r
  //\r
  USB_ENDPOINT_CONTROL    = 0x00,\r
  USB_ENDPOINT_ISO        = 0x01,\r
  USB_ENDPOINT_BULK       = 0x02,\r
  USB_ENDPOINT_INTERRUPT  = 0x03,\r
\r
  USB_ENDPOINT_TYPE_MASK  = 0x03,\r
  USB_ENDPOINT_DIR_IN     = 0x80,\r
\r
  //\r
  //Use 200 ms to increase the error handling response time\r
  //\r
  EFI_USB_INTERRUPT_DELAY = 2000000,\r
};\r
#endif\r
Commit	Line	Data
a7ed1e2e	1	/** @file\r
	2	Support for USB 1.1 standard.\r
	3	\r
196d5cd1	4	Copyright (c) 2006 - 2007, Intel Corporation\r
	5	All rights reserved. This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
a7ed1e2e	9	\r
196d5cd1	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
196d5cd1	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
a7ed1e2e	12	\r
a7ed1e2e	13	**/\r
	14	\r
	15	#ifndef __USB_H__\r
	16	#define __USB_H__\r
	17	\r
a7ed1e2e	18	\r
a7ed1e2e	19	//\r
196d5cd1	20	// Definitions defined in UEFI spec\r
a7ed1e2e	21	//\r
a7ed1e2e	22	\r
	23	//\r
	24	// USB Transfer Results\r
	25	//\r
196d5cd1	26	#define EFI_USB_NOERROR 0x00\r
	27	#define EFI_USB_ERR_NOTEXECUTE 0x01\r
	28	#define EFI_USB_ERR_STALL 0x02\r
	29	#define EFI_USB_ERR_BUFFER 0x04\r
	30	#define EFI_USB_ERR_BABBLE 0x08\r
	31	#define EFI_USB_ERR_NAK 0x10\r
	32	#define EFI_USB_ERR_CRC 0x20\r
	33	#define EFI_USB_ERR_TIMEOUT 0x40\r
	34	#define EFI_USB_ERR_BITSTUFF 0x80\r
	35	#define EFI_USB_ERR_SYSTEM 0x100\r
a7ed1e2e	36	\r
a7ed1e2e	37	//\r
196d5cd1	38	// Constant value for Port Status & Port Change Status\r
a7ed1e2e	39	//\r
196d5cd1	40	#define USB_PORT_STAT_CONNECTION 0x0001\r
	41	#define USB_PORT_STAT_ENABLE 0x0002\r
	42	#define USB_PORT_STAT_SUSPEND 0x0004\r
	43	#define USB_PORT_STAT_OVERCURRENT 0x0008\r
	44	#define USB_PORT_STAT_RESET 0x0010\r
	45	#define USB_PORT_STAT_POWER 0x0100\r
	46	#define USB_PORT_STAT_LOW_SPEED 0x0200\r
	47	#define USB_PORT_STAT_HIGH_SPEED 0x0400\r
	48	#define USB_PORT_STAT_OWNER 0x0800\r
	49	\r
	50	#define USB_PORT_STAT_C_CONNECTION 0x0001\r
	51	#define USB_PORT_STAT_C_ENABLE 0x0002\r
	52	#define USB_PORT_STAT_C_SUSPEND 0x0004\r
	53	#define USB_PORT_STAT_C_OVERCURRENT 0x0008\r
	54	#define USB_PORT_STAT_C_RESET 0x0010\r
a7ed1e2e	55	\r
a7ed1e2e	56	//\r
196d5cd1	57	// USB data transfer direction\r
a7ed1e2e	58	//\r
	59	typedef enum {\r
	60	EfiUsbDataIn,\r
	61	EfiUsbDataOut,\r
	62	EfiUsbNoData\r
	63	} EFI_USB_DATA_DIRECTION;\r
	64	\r
	65	//\r
196d5cd1	66	// Usb port features\r
a7ed1e2e	67	//\r
a7ed1e2e	68	typedef enum {\r
196d5cd1	69	EfiUsbPortEnable = 1,\r
	70	EfiUsbPortSuspend = 2,\r
	71	EfiUsbPortReset = 4,\r
	72	EfiUsbPortPower = 8,\r
	73	EfiUsbPortOwner = 13,\r
	74	EfiUsbPortConnectChange = 16,\r
	75	EfiUsbPortEnableChange = 17,\r
	76	EfiUsbPortSuspendChange = 18,\r
	77	EfiUsbPortOverCurrentChange = 19,\r
	78	EfiUsbPortResetChange = 20\r
	79	} EFI_USB_PORT_FEATURE;\r
a7ed1e2e	80	\r
a7ed1e2e	81	\r
a7ed1e2e	82	//\r
196d5cd1	83	// USB standard descriptors and reqeust\r
a7ed1e2e	84	//\r
196d5cd1	85	#pragma pack(1)\r
a7ed1e2e	86	typedef struct {\r
196d5cd1	87	UINT8 RequestType;\r
	88	UINT8 Request;\r
	89	UINT16 Value;\r
	90	UINT16 Index;\r
	91	UINT16 Length;\r
a7ed1e2e	92	} EFI_USB_DEVICE_REQUEST;\r
a7ed1e2e	93	\r
196d5cd1	94	typedef struct {\r
	95	UINT8 Length;\r
	96	UINT8 DescriptorType;\r
	97	UINT16 BcdUSB;\r
	98	UINT8 DeviceClass;\r
	99	UINT8 DeviceSubClass;\r
	100	UINT8 DeviceProtocol;\r
	101	UINT8 MaxPacketSize0;\r
	102	UINT16 IdVendor;\r
	103	UINT16 IdProduct;\r
	104	UINT16 BcdDevice;\r
	105	UINT8 StrManufacturer;\r
	106	UINT8 StrProduct;\r
	107	UINT8 StrSerialNumber;\r
	108	UINT8 NumConfigurations;\r
a7ed1e2e	109	} EFI_USB_DEVICE_DESCRIPTOR;\r
a7ed1e2e	110	\r
a7ed1e2e	111	typedef struct {\r
196d5cd1	112	UINT8 Length;\r
	113	UINT8 DescriptorType;\r
	114	UINT16 TotalLength;\r
	115	UINT8 NumInterfaces;\r
	116	UINT8 ConfigurationValue;\r
	117	UINT8 Configuration;\r
	118	UINT8 Attributes;\r
	119	UINT8 MaxPower;\r
	120	} EFI_USB_CONFIG_DESCRIPTOR;\r
a7ed1e2e	121	\r
a7ed1e2e	122	typedef struct {\r
196d5cd1	123	UINT8 Length;\r
	124	UINT8 DescriptorType;\r
	125	UINT8 InterfaceNumber;\r
	126	UINT8 AlternateSetting;\r
	127	UINT8 NumEndpoints;\r
	128	UINT8 InterfaceClass;\r
	129	UINT8 InterfaceSubClass;\r
	130	UINT8 InterfaceProtocol;\r
	131	UINT8 Interface;\r
a7ed1e2e	132	} EFI_USB_INTERFACE_DESCRIPTOR;\r
a7ed1e2e	133	\r
a7ed1e2e	134	typedef struct {\r
196d5cd1	135	UINT8 Length;\r
	136	UINT8 DescriptorType;\r
	137	UINT8 EndpointAddress;\r
	138	UINT8 Attributes;\r
	139	UINT16 MaxPacketSize;\r
	140	UINT8 Interval;\r
	141	} EFI_USB_ENDPOINT_DESCRIPTOR;\r
a7ed1e2e	142	\r
a7ed1e2e	143	typedef struct {\r
196d5cd1	144	UINT8 Length;\r
	145	UINT8 DescriptorType;\r
	146	CHAR16 String[1];\r
a7ed1e2e	147	} EFI_USB_STRING_DESCRIPTOR;\r
a7ed1e2e	148	\r
196d5cd1	149	#pragma pack()\r
a7ed1e2e	150	\r
a7ed1e2e	151	typedef struct {\r
196d5cd1	152	UINT16 PortStatus;\r
196d5cd1	153	UINT16 PortChangeStatus;\r
a7ed1e2e	154	} EFI_USB_PORT_STATUS;\r
a7ed1e2e	155	\r
a7ed1e2e	156	\r
a7ed1e2e	157	//\r
196d5cd1	158	// Following are definitions not specified by UEFI spec.\r
	159	// Add new definitions below this line\r
	160	//\r
	161	enum {\r
	162	//\r
	163	// USB request type\r
	164	//\r
	165	USB_REQ_TYPE_STANDARD = (0x00 << 5),\r
	166	USB_REQ_TYPE_CLASS = (0x01 << 5),\r
	167	USB_REQ_TYPE_VENDOR = (0x02 << 5),\r
	168	\r
	169	//\r
	170	// Standard control transfer request type, or the value\r
	171	// to fill in EFI_USB_DEVICE_REQUEST.Request\r
	172	//\r
	173	USB_REQ_GET_STATUS = 0x00,\r
	174	USB_REQ_CLEAR_FEATURE = 0x01,\r
	175	USB_REQ_SET_FEATURE = 0x03,\r
	176	USB_REQ_SET_ADDRESS = 0x05,\r
	177	USB_REQ_GET_DESCRIPTOR = 0x06,\r
	178	USB_REQ_SET_DESCRIPTOR = 0x07,\r
	179	USB_REQ_GET_CONFIG = 0x08,\r
	180	USB_REQ_SET_CONFIG = 0x09,\r
	181	USB_REQ_GET_INTERFACE = 0x0A,\r
	182	USB_REQ_SET_INTERFACE = 0x0B,\r
	183	USB_REQ_SYNCH_FRAME = 0x0C,\r
	184	\r
	185	//\r
	186	// Usb control transfer target\r
	187	//\r
	188	USB_TARGET_DEVICE = 0,\r
	189	USB_TARGET_INTERFACE = 0x01,\r
	190	USB_TARGET_ENDPOINT = 0x02,\r
	191	USB_TARGET_OTHER = 0x03,\r
	192	\r
	193	//\r
	194	// USB Descriptor types\r
	195	//\r
	196	USB_DESC_TYPE_DEVICE = 0x01,\r
	197	USB_DESC_TYPE_CONFIG = 0x02,\r
	198	USB_DESC_TYPE_STRING = 0x03,\r
	199	USB_DESC_TYPE_INTERFACE = 0x04,\r
	200	USB_DESC_TYPE_ENDPOINT = 0x05,\r
	201	USB_DESC_TYPE_HID = 0x21,\r
	202	\r
	203	//\r
	204	// Features to be cleared by CLEAR_FEATURE requests\r
	205	//\r
	206	USB_FEATURE_ENDPOINT_HALT = 0,\r
	207	\r
	208	//\r
	209	// USB endpoint types: 00: control, 01: isochronous, 10: bulk, 11: interrupt\r
	210	//\r
	211	USB_ENDPOINT_CONTROL = 0x00,\r
	212	USB_ENDPOINT_ISO = 0x01,\r
	213	USB_ENDPOINT_BULK = 0x02,\r
	214	USB_ENDPOINT_INTERRUPT = 0x03,\r
	215	\r
	216	USB_ENDPOINT_TYPE_MASK = 0x03,\r
	217	USB_ENDPOINT_DIR_IN = 0x80,\r
	218	\r
	219	//\r
	220	//Use 200 ms to increase the error handling response time\r
	221	//\r
222	EFI_USB_INTERRUPT_DELAY = 2000000,\r
223	};\r
a7ed1e2e	224	#endif\r