[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbBusPei / PeiUsbLib.h

/** @file\r
Common Libarary for PEI USB\r
\r
Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved. <BR>\r
  \r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions\r
of the BSD License which accompanies this distribution.  The\r
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 _PEI_USB_LIB_H_\r
#define _PEI_USB_LIB_H_\r
\r
\r
//\r
// Standard device request and request type\r
// By [Spec-USB20/Chapter-9.4]\r
//\r
#define USB_DEV_GET_STATUS                  0x00\r
#define USB_DEV_GET_STATUS_REQ_TYPE_D       0x80 // Receiver : Device\r
#define USB_DEV_GET_STATUS_REQ_TYPE_I       0x81 // Receiver : Interface\r
#define USB_DEV_GET_STATUS_REQ_TYPE_E       0x82 // Receiver : Endpoint\r
\r
#define USB_DEV_CLEAR_FEATURE               0x01\r
#define USB_DEV_CLEAR_FEATURE_REQ_TYPE_D    0x00 // Receiver : Device\r
#define USB_DEV_CLEAR_FEATURE_REQ_TYPE_I    0x01 // Receiver : Interface\r
#define USB_DEV_CLEAR_FEATURE_REQ_TYPE_E    0x02 // Receiver : Endpoint\r
\r
#define USB_DEV_SET_FEATURE                 0x03\r
#define USB_DEV_SET_FEATURE_REQ_TYPE_D      0x00 // Receiver : Device\r
#define USB_DEV_SET_FEATURE_REQ_TYPE_I      0x01 // Receiver : Interface\r
#define USB_DEV_SET_FEATURE_REQ_TYPE_E      0x02 // Receiver : Endpoint\r
\r
#define USB_DEV_SET_ADDRESS                 0x05\r
#define USB_DEV_SET_ADDRESS_REQ_TYPE        0x00\r
\r
#define USB_DEV_GET_DESCRIPTOR              0x06\r
#define USB_DEV_GET_DESCRIPTOR_REQ_TYPE     0x80\r
\r
#define USB_DEV_SET_DESCRIPTOR              0x07\r
#define USB_DEV_SET_DESCRIPTOR_REQ_TYPE     0x00\r
\r
#define USB_DEV_GET_CONFIGURATION           0x08\r
#define USB_DEV_GET_CONFIGURATION_REQ_TYPE  0x80\r
\r
#define USB_DEV_SET_CONFIGURATION           0x09\r
#define USB_DEV_SET_CONFIGURATION_REQ_TYPE  0x00\r
\r
#define USB_DEV_GET_INTERFACE               0x0A\r
#define USB_DEV_GET_INTERFACE_REQ_TYPE      0x81\r
\r
#define USB_DEV_SET_INTERFACE               0x0B\r
#define USB_DEV_SET_INTERFACE_REQ_TYPE      0x01\r
\r
#define USB_DEV_SYNCH_FRAME                 0x0C\r
#define USB_DEV_SYNCH_FRAME_REQ_TYPE        0x82\r
\r
//\r
// USB Descriptor types\r
//\r
#define USB_DT_DEVICE     0x01\r
#define USB_DT_CONFIG     0x02\r
#define USB_DT_STRING     0x03\r
#define USB_DT_INTERFACE  0x04\r
#define USB_DT_ENDPOINT   0x05\r
#define USB_DT_HUB        0x29\r
#define USB_DT_HID        0x21\r
\r
//\r
// USB request type\r
//\r
#define USB_TYPE_STANDARD (0x00 << 5)\r
#define USB_TYPE_CLASS    (0x01 << 5)\r
#define USB_TYPE_VENDOR   (0x02 << 5)\r
#define USB_TYPE_RESERVED (0x03 << 5)\r
\r
//\r
// USB request targer device\r
//\r
#define USB_RECIP_DEVICE    0x00\r
#define USB_RECIP_INTERFACE 0x01\r
#define USB_RECIP_ENDPOINT  0x02\r
#define USB_RECIP_OTHER     0x03\r
\r
typedef enum {\r
  EfiUsbEndpointHalt,\r
  EfiUsbDeviceRemoteWakeup\r
} EFI_USB_STANDARD_FEATURE_SELECTOR;\r
\r
//\r
// Usb Data recipient type\r
//\r
typedef enum {\r
  EfiUsbDevice,\r
  EfiUsbInterface,\r
  EfiUsbEndpoint\r
} EFI_USB_RECIPIENT;\r
\r
/**\r
  Get a given usb descriptor.\r
\r
  @param  PeiServices        General-purpose services that are available to every PEIM.\r
  @param  UsbIoPpi           Indicates the PEI_USB_IO_PPI instance.\r
  @param  Value              Request Value.\r
  @param  Index              Request Index.\r
  @param  DescriptorLength   Request descriptor Length.\r
  @param  Descriptor         Request descriptor.\r
\r
\r
  @retval EFI_SUCCESS       Usb descriptor is obtained successfully.\r
  @retval EFI_DEVICE_ERROR  Cannot get the usb descriptor due to a hardware error.\r
  @retval Others            Other failure occurs.\r
\r
**/\r
EFI_STATUS\r
PeiUsbGetDescriptor (\r
  IN  EFI_PEI_SERVICES         **PeiServices,\r
  IN  PEI_USB_IO_PPI           *UsbIoPpi,\r
  IN  UINT16                   Value,\r
  IN  UINT16                   Index,\r
  IN  UINT16                   DescriptorLength,\r
  OUT VOID                     *Descriptor\r
  );\r
\r
/**\r
  Set a usb device with a specified address.\r
\r
  @param  PeiServices        General-purpose services that are available to every PEIM.\r
  @param  UsbIoPpi           Indicates the PEI_USB_IO_PPI instance.\r
  @param  AddressValue       The address to assign.\r
\r
  @retval EFI_SUCCESS        Usb device address is set successfully.\r
  @retval EFI_DEVICE_ERROR   Cannot set the usb address due to a hardware error.\r
  @retval Others             Other failure occurs.\r
\r
**/\r
EFI_STATUS\r
PeiUsbSetDeviceAddress (\r
  IN EFI_PEI_SERVICES         **PeiServices,\r
  IN PEI_USB_IO_PPI           *UsbIoPpi,\r
  IN UINT16                   AddressValue\r
  );\r
\r
/**\r
  Clear a given usb feature.\r
\r
  @param  PeiServices       General-purpose services that are available to every PEIM.\r
  @param  UsbIoPpi          Indicates the PEI_USB_IO_PPI instance.\r
  @param  Recipient         The recipient of ClearFeature Request, should be one of Device/Interface/Endpoint.\r
  @param  Value             Request Value.\r
  @param  Target            Request Index.\r
\r
  @retval EFI_SUCCESS       Usb feature is cleared successfully.\r
  @retval EFI_DEVICE_ERROR  Cannot clear the usb feature due to a hardware error.\r
  @retval Others            Other failure occurs.\r
\r
**/\r
EFI_STATUS\r
PeiUsbClearDeviceFeature (\r
  IN EFI_PEI_SERVICES         **PeiServices,\r
  IN PEI_USB_IO_PPI           *UsbIoPpi,\r
  IN EFI_USB_RECIPIENT        Recipient,\r
  IN UINT16                   Value,\r
  IN UINT16                   Target\r
  );\r
\r
/**\r
  Configure a usb device to Configuration 1.\r
\r
  @param  PeiServices        General-purpose services that are available to every PEIM.\r
  @param  UsbIoPpi           Indicates the PEI_USB_IO_PPI instance.\r
\r
  @retval EFI_SUCCESS        Usb device is set to use Configuration 1 successfully.\r
  @retval EFI_DEVICE_ERROR   Cannot set the usb device due to a hardware error.\r
  @retval Others             Other failure occurs.\r
\r
**/\r
EFI_STATUS\r
PeiUsbSetConfiguration (\r
  IN EFI_PEI_SERVICES         **PeiServices,\r
  IN PEI_USB_IO_PPI           *UsbIoPpi\r
  );\r
\r
/**\r
  Judge if the port is connected with a usb device or not.\r
\r
  @param  PortStatus  The usb port status gotten.\r
\r
  @retval TRUE        A usb device is connected with the port.\r
  @retval FALSE       No usb device is connected with the port.\r
\r
**/\r
BOOLEAN\r
IsPortConnect (\r
  IN UINT16  PortStatus\r
  );\r
\r
/**\r
  Judge if the port is connected with a low-speed usb device or not.\r
\r
  @param  PortStatus  The usb port status gotten.\r
\r
  @retval TRUE        A low-speed usb device is connected with the port.\r
  @retval FALSE       No low-speed usb device is connected with the port.\r
\r
**/\r
UINTN\r
IsPortLowSpeedDeviceAttached (\r
  IN UINT16  PortStatus\r
  );\r
\r
/**\r
  Judge if the port is in "connection change" status or not.\r
\r
  @param  PortChangeStatus  The usb port change status gotten.\r
\r
  @retval TRUE              The port is in "connection change" status.\r
  @retval FALSE             The port is NOT in "connection change" status.\r
\r
**/\r
BOOLEAN\r
IsPortConnectChange (\r
  IN UINT16  PortChangeStatus\r
  );\r
#endif\r
Commit	Line	Data
4b1bf81c	1	/** @file\r
	2	Common Libarary for PEI USB\r
	3	\r
506560e7	4	Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved. <BR>\r
4b1bf81c	5	\r
	6	This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions\r
	8	of the BSD License which accompanies this distribution. The\r
	9	full text of the license may be found at\r
	10	http://opensource.org/licenses/bsd-license.php\r
	11	\r
	12	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	13	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	14	\r
	15	**/\r
	16	\r
	17	#ifndef _PEI_USB_LIB_H_\r
	18	#define _PEI_USB_LIB_H_\r
	19	\r
	20	\r
	21	//\r
	22	// Standard device request and request type\r
	23	// By [Spec-USB20/Chapter-9.4]\r
	24	//\r
	25	#define USB_DEV_GET_STATUS 0x00\r
	26	#define USB_DEV_GET_STATUS_REQ_TYPE_D 0x80 // Receiver : Device\r
	27	#define USB_DEV_GET_STATUS_REQ_TYPE_I 0x81 // Receiver : Interface\r
	28	#define USB_DEV_GET_STATUS_REQ_TYPE_E 0x82 // Receiver : Endpoint\r
	29	\r
	30	#define USB_DEV_CLEAR_FEATURE 0x01\r
	31	#define USB_DEV_CLEAR_FEATURE_REQ_TYPE_D 0x00 // Receiver : Device\r
	32	#define USB_DEV_CLEAR_FEATURE_REQ_TYPE_I 0x01 // Receiver : Interface\r
	33	#define USB_DEV_CLEAR_FEATURE_REQ_TYPE_E 0x02 // Receiver : Endpoint\r
	34	\r
	35	#define USB_DEV_SET_FEATURE 0x03\r
	36	#define USB_DEV_SET_FEATURE_REQ_TYPE_D 0x00 // Receiver : Device\r
	37	#define USB_DEV_SET_FEATURE_REQ_TYPE_I 0x01 // Receiver : Interface\r
	38	#define USB_DEV_SET_FEATURE_REQ_TYPE_E 0x02 // Receiver : Endpoint\r
	39	\r
	40	#define USB_DEV_SET_ADDRESS 0x05\r
	41	#define USB_DEV_SET_ADDRESS_REQ_TYPE 0x00\r
	42	\r
	43	#define USB_DEV_GET_DESCRIPTOR 0x06\r
	44	#define USB_DEV_GET_DESCRIPTOR_REQ_TYPE 0x80\r
	45	\r
	46	#define USB_DEV_SET_DESCRIPTOR 0x07\r
	47	#define USB_DEV_SET_DESCRIPTOR_REQ_TYPE 0x00\r
	48	\r
	49	#define USB_DEV_GET_CONFIGURATION 0x08\r
	50	#define USB_DEV_GET_CONFIGURATION_REQ_TYPE 0x80\r
	51	\r
	52	#define USB_DEV_SET_CONFIGURATION 0x09\r
	53	#define USB_DEV_SET_CONFIGURATION_REQ_TYPE 0x00\r
	54	\r
	55	#define USB_DEV_GET_INTERFACE 0x0A\r
	56	#define USB_DEV_GET_INTERFACE_REQ_TYPE 0x81\r
	57	\r
	58	#define USB_DEV_SET_INTERFACE 0x0B\r
	59	#define USB_DEV_SET_INTERFACE_REQ_TYPE 0x01\r
	60	\r
	61	#define USB_DEV_SYNCH_FRAME 0x0C\r
	62	#define USB_DEV_SYNCH_FRAME_REQ_TYPE 0x82\r
	63	\r
	64	//\r
	65	// USB Descriptor types\r
	66	//\r
	67	#define USB_DT_DEVICE 0x01\r
	68	#define USB_DT_CONFIG 0x02\r
69	#define USB_DT_STRING 0x03\r
70	#define USB_DT_INTERFACE 0x04\r
71	#define USB_DT_ENDPOINT 0x05\r
72	#define USB_DT_HUB 0x29\r
73	#define USB_DT_HID 0x21\r
74	\r
75	//\r
76	// USB request type\r
77	//\r
78	#define USB_TYPE_STANDARD (0x00 << 5)\r
79	#define USB_TYPE_CLASS (0x01 << 5)\r
80	#define USB_TYPE_VENDOR (0x02 << 5)\r
81	#define USB_TYPE_RESERVED (0x03 << 5)\r
82	\r
83	//\r
84	// USB request targer device\r
85	//\r
86	#define USB_RECIP_DEVICE 0x00\r
87	#define USB_RECIP_INTERFACE 0x01\r
88	#define USB_RECIP_ENDPOINT 0x02\r
89	#define USB_RECIP_OTHER 0x03\r
90	\r
91	typedef enum {\r
92	EfiUsbEndpointHalt,\r
93	EfiUsbDeviceRemoteWakeup\r
94	} EFI_USB_STANDARD_FEATURE_SELECTOR;\r
95	\r
96	//\r
97	// Usb Data recipient type\r
98	//\r
99	typedef enum {\r
100	EfiUsbDevice,\r
101	EfiUsbInterface,\r
102	EfiUsbEndpoint\r
103	} EFI_USB_RECIPIENT;\r
104	\r
105	/**\r
106	Get a given usb descriptor.\r
107	\r
108	@param PeiServices General-purpose services that are available to every PEIM.\r
109	@param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.\r
110	@param Value Request Value.\r
111	@param Index Request Index.\r
112	@param DescriptorLength Request descriptor Length.\r
113	@param Descriptor Request descriptor.\r
114	\r
115	\r
116	@retval EFI_SUCCESS Usb descriptor is obtained successfully.\r
117	@retval EFI_DEVICE_ERROR Cannot get the usb descriptor due to a hardware error.\r
118	@retval Others Other failure occurs.\r
119	\r
120	**/\r
121	EFI_STATUS\r
122	PeiUsbGetDescriptor (\r
123	IN EFI_PEI_SERVICES **PeiServices,\r
124	IN PEI_USB_IO_PPI *UsbIoPpi,\r
125	IN UINT16 Value,\r
126	IN UINT16 Index,\r
127	IN UINT16 DescriptorLength,\r
128	OUT VOID *Descriptor\r
129	);\r
130	\r
131	/**\r
132	Set a usb device with a specified address.\r
133	\r
134	@param PeiServices General-purpose services that are available to every PEIM.\r
135	@param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.\r
136	@param AddressValue The address to assign.\r
137	\r
138	@retval EFI_SUCCESS Usb device address is set successfully.\r
139	@retval EFI_DEVICE_ERROR Cannot set the usb address due to a hardware error.\r
140	@retval Others Other failure occurs.\r
141	\r
142	**/\r
143	EFI_STATUS\r
144	PeiUsbSetDeviceAddress (\r
145	IN EFI_PEI_SERVICES **PeiServices,\r
146	IN PEI_USB_IO_PPI *UsbIoPpi,\r
147	IN UINT16 AddressValue\r
148	);\r
149	\r
150	/**\r
151	Clear a given usb feature.\r
152	\r
153	@param PeiServices General-purpose services that are available to every PEIM.\r
154	@param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.\r
155	@param Recipient The recipient of ClearFeature Request, should be one of Device/Interface/Endpoint.\r
156	@param Value Request Value.\r
157	@param Target Request Index.\r
158	\r
159	@retval EFI_SUCCESS Usb feature is cleared successfully.\r
160	@retval EFI_DEVICE_ERROR Cannot clear the usb feature due to a hardware error.\r
161	@retval Others Other failure occurs.\r
162	\r
163	**/\r
164	EFI_STATUS\r
165	PeiUsbClearDeviceFeature (\r
166	IN EFI_PEI_SERVICES **PeiServices,\r
167	IN PEI_USB_IO_PPI *UsbIoPpi,\r
168	IN EFI_USB_RECIPIENT Recipient,\r
169	IN UINT16 Value,\r
170	IN UINT16 Target\r
171	);\r
172	\r
173	/**\r
174	Configure a usb device to Configuration 1.\r
175	\r
176	@param PeiServices General-purpose services that are available to every PEIM.\r
177	@param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.\r
178	\r
179	@retval EFI_SUCCESS Usb device is set to use Configuration 1 successfully.\r
180	@retval EFI_DEVICE_ERROR Cannot set the usb device due to a hardware error.\r
181	@retval Others Other failure occurs.\r
182	\r
183	**/\r
184	EFI_STATUS\r
185	PeiUsbSetConfiguration (\r
186	IN EFI_PEI_SERVICES **PeiServices,\r
187	IN PEI_USB_IO_PPI *UsbIoPpi\r
188	);\r
189	\r
4b1bf81c	190	/**\r
	191	Judge if the port is connected with a usb device or not.\r
	192	\r
	193	@param PortStatus The usb port status gotten.\r
	194	\r
	195	@retval TRUE A usb device is connected with the port.\r
	196	@retval FALSE No usb device is connected with the port.\r
	197	\r
	198	**/\r
	199	BOOLEAN\r
	200	IsPortConnect (\r
	201	IN UINT16 PortStatus\r
	202	);\r
	203	\r
	204	/**\r
	205	Judge if the port is connected with a low-speed usb device or not.\r
	206	\r
	207	@param PortStatus The usb port status gotten.\r
	208	\r
	209	@retval TRUE A low-speed usb device is connected with the port.\r
	210	@retval FALSE No low-speed usb device is connected with the port.\r
	211	\r
	212	**/\r
	213	UINTN\r
	214	IsPortLowSpeedDeviceAttached (\r
	215	IN UINT16 PortStatus\r
	216	);\r
	217	\r
	218	/**\r
	219	Judge if the port is in "connection change" status or not.\r
	220	\r
	221	@param PortChangeStatus The usb port change status gotten.\r
	222	\r
	223	@retval TRUE The port is in "connection change" status.\r
	224	@retval FALSE The port is NOT in "connection change" status.\r
	225	\r
	226	**/\r
	227	BOOLEAN\r
	228	IsPortConnectChange (\r
	229	IN UINT16 PortChangeStatus\r
	230	);\r
	231	#endif\r