[mirror_edk2.git] / MdePkg / Include / Library / UsbLib.h

/** @file\r
  Common Dxe Libarary  for USB.\r
\r
  Copyright (c) 2006 - 2008, Intel Corporation<BR>\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
\r
#ifndef __USB_DXE_LIB_H__\r
#define __USB_DXE_LIB_H__\r
\r
#include <Protocol/UsbIo.h>\r
\r
///\r
/// define the timeout time as 3ms\r
///\r
#define TIMEOUT_VALUE 3 * 1000\r
\r
/**\r
  Get Hid Descriptor.\r
\r
  @param  UsbIo             A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  InterfaceNum      Hid interface number.\r
  @param  HidDescriptor     Caller allocated buffer to store Usb hid descriptor if\r
                            successfully returned.\r
\r
  @return Status of getting HID descriptor through USB I/O\r
          protocol's UsbControlTransfer().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbGetHidDescriptor (\r
  IN  EFI_USB_IO_PROTOCOL        *UsbIo,\r
  IN  UINT8                      InterfaceNum,\r
  OUT EFI_USB_HID_DESCRIPTOR     *HidDescriptor\r
  );\r
\r
\r
/**\r
  get Report Class descriptor.\r
\r
  @param  UsbIo             A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  InterfaceNum      Report interface number.\r
  @param  DescriptorSize    Length of DescriptorBuffer.\r
  @param  DescriptorBuffer  Caller allocated buffer to store Usb report descriptor\r
                            if successfully returned.\r
\r
  @return Status of getting Report Class descriptor through USB\r
          I/O protocol's UsbControlTransfer().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbGetReportDescriptor (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT8                   InterfaceNum,\r
  IN  UINT16                  DescriptorSize,\r
  OUT UINT8                   *DescriptorBuffer\r
  );\r
\r
/**\r
  Get Hid Protocol Request.\r
\r
  @param  UsbIo             A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  Interface         Which interface the caller wants to get protocol.\r
  @param  Protocol          Protocol value returned.\r
\r
  @return Status of getting Protocol Request through USB I/O\r
          protocol's UsbControlTransfer().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbGetProtocolRequest (\r
  IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN UINT8                   Interface,\r
  IN UINT8                   *Protocol\r
  );\r
\r
/**\r
  Set Hid Protocol Request.\r
\r
  @param  UsbIo             A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  Interface         Which interface the caller wants to set protocol.\r
  @param  Protocol          Protocol value the caller wants to set.\r
\r
  @return Status of setting Protocol Request through USB I/O\r
          protocol's UsbControlTransfer().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbSetProtocolRequest (\r
  IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN UINT8                   Interface,\r
  IN UINT8                   Protocol\r
  );\r
\r
/**\r
  Set Idel request.\r
\r
  @param  UsbIo             A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  Interface         Which interface the caller wants to set.\r
  @param  ReportId          Which report the caller wants to set.\r
  @param  Duration          Idle rate the caller wants to set.\r
\r
  @return Status of setting IDLE Request through USB I/O\r
          protocol's UsbControlTransfer().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbSetIdleRequest (\r
  IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN UINT8                   Interface,\r
  IN UINT8                   ReportId,\r
  IN UINT8                   Duration\r
  );\r
\r
/**\r
  Get Idel request.\r
\r
  @param  UsbIo             A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  Interface         Which interface the caller wants to get.\r
  @param  ReportId          Which report the caller wants to get.\r
  @param  Duration          Idle rate the caller wants to get.\r
\r
  @return Status of getting IDLE Request through USB I/O\r
          protocol's UsbControlTransfer().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbGetIdleRequest (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT8                   Interface,\r
  IN  UINT8                   ReportId,\r
  OUT UINT8                   *Duration\r
  );\r
\r
/**\r
  Hid Set Report request.\r
\r
  @param  UsbIo             A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  Interface         Which interface the caller wants to set.\r
  @param  ReportId          Which report the caller wants to set.\r
  @param  ReportType        Type of report.\r
  @param  ReportLen         Length of report descriptor.\r
  @param  Report            Report Descriptor buffer.\r
\r
  @return Status of setting Report Request through USB I/O\r
          protocol's UsbControlTransfer().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbSetReportRequest (\r
  IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN UINT8                   Interface,\r
  IN UINT8                   ReportId,\r
  IN UINT8                   ReportType,\r
  IN UINT16                  ReportLen,\r
  IN UINT8                   *Report\r
  );\r
\r
/**\r
  Hid Set Report request.\r
\r
  @param  UsbIo             A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  Interface         Which interface the caller wants to set.\r
  @param  ReportId          Which report the caller wants to set.\r
  @param  ReportType        Type of report.\r
  @param  ReportLen         Length of report descriptor.\r
  @param  Report            Caller allocated buffer to store Report Descriptor.\r
\r
  @return Status of getting Report Request through USB I/O\r
          protocol's UsbControlTransfer().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbGetReportRequest (\r
  IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN UINT8                   Interface,\r
  IN UINT8                   ReportId,\r
  IN UINT8                   ReportType,\r
  IN UINT16                  ReportLen,\r
  IN UINT8                   *Report\r
  );\r
\r
/**\r
  Usb Get Descriptor.\r
\r
  @param  UsbIo                  A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  Value                  Device Request Value.\r
  @param  Index                  Device Request Index.\r
  @param  DescriptorLength       Descriptor Length.\r
  @param  Descriptor             Descriptor buffer to contain result.\r
  @param  Status                 Transfer Status.\r
\r
  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
  @retval EFI_SUCCESS            Success.\r
  @retval EFI_TIMEOUT            Device has no response.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbGetDescriptor (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT16                  Value,\r
  IN  UINT16                  Index,\r
  IN  UINT16                  DescriptorLength,\r
  OUT VOID                    *Descriptor,\r
  OUT UINT32                  *Status\r
  );\r
\r
/**\r
  Usb Set Descriptor.\r
\r
  @param  UsbIo                  A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  Value                  Device Request Value.\r
  @param  Index                  Device Request Index.\r
  @param  DescriptorLength       Descriptor Length.\r
  @param  Descriptor             Descriptor buffer to set.\r
  @param  Status                 Transfer Status.\r
\r
  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
  @retval EFI_SUCCESS            Success.\r
  @retval EFI_TIMEOUT            Device has no response.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbSetDescriptor (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT16                  Value,\r
  IN  UINT16                  Index,\r
  IN  UINT16                  DescriptorLength,\r
  IN  VOID                    *Descriptor,\r
  OUT UINT32                  *Status\r
  );\r
\r
/**\r
  Usb Get Device Interface.\r
\r
  @param  UsbIo                  A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  Index                  Interface index value.\r
  @param  AltSetting             Alternate setting.\r
  @param  Status                 Trasnsfer status.\r
\r
  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
  @retval EFI_SUCCESS            Success.\r
  @retval EFI_TIMEOUT            Device has no response.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbGetInterface (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT16                  Index,\r
  OUT UINT8                   *AltSetting,\r
  OUT UINT32                  *Status\r
  );\r
\r
/**\r
  Usb Set Device Interface.\r
\r
  @param  UsbIo                  A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  InterfaceNo            Interface Number.\r
  @param  AltSetting             Alternate setting.\r
  @param  Status                 Trasnsfer status.\r
\r
  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
  @retval EFI_SUCCESS            Success.\r
  @retval EFI_TIMEOUT            Device has no response.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbSetInterface (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT16                  InterfaceNo,\r
  IN  UINT16                  AltSetting,\r
  OUT UINT32                  *Status\r
  );\r
\r
/**\r
  Usb Get Device Configuration.\r
\r
  @param  UsbIo                  A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  ConfigValue            Config Value.\r
  @param  Status                 Transfer Status.\r
\r
  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
  @retval EFI_SUCCESS            Success.\r
  @retval EFI_TIMEOUT            Device has no response.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbGetConfiguration (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  OUT UINT8                   *ConfigValue,\r
  OUT UINT32                  *Status\r
  );\r
\r
/**\r
  Usb Set Device Configuration.\r
\r
  @param  UsbIo                  A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  Value                  Configuration Value to set.\r
  @param  Status                 Transfer status.\r
\r
  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
  @retval EFI_SUCCESS            Success.\r
  @retval EFI_TIMEOUT            Device has no response.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbSetConfiguration (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT16                  Value,\r
  OUT UINT32                  *Status\r
  );\r
\r
/**\r
  Usb Set Device Feature.\r
\r
  @param  UsbIo                  A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  Recipient              Interface/Device/Endpoint.\r
  @param  Value                  Request value.\r
  @param  Target                 Request Index.\r
  @param  Status                 Transfer status.\r
\r
  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
  @retval EFI_SUCCESS            Success.\r
  @retval EFI_TIMEOUT            Device has no response.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbSetFeature (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINTN                   Recipient,\r
  IN  UINT16                  Value,\r
  IN  UINT16                  Target,\r
  OUT UINT32                  *Status\r
  );\r
\r
/**\r
  Usb Clear Device Feature.\r
\r
  @param  UsbIo                  A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  Recipient              Interface/Device/Endpoint.\r
  @param  Value                  Request value.\r
  @param  Target                 Request Index.\r
  @param  Status                 Transfer status.\r
\r
  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
  @retval EFI_SUCCESS            Success.\r
  @retval EFI_TIMEOUT            Device has no response.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbClearFeature (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINTN                   Recipient,\r
  IN  UINT16                  Value,\r
  IN  UINT16                  Target,\r
  OUT UINT32                  *Status\r
  );\r
\r
/**\r
  Usb Get Device Status.\r
\r
  @param  UsbIo                  A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  Recipient              Interface/Device/Endpoint.\r
  @param  Target                 Request index.\r
  @param  DevStatus              Device status.\r
  @param  Status                 Transfer status.\r
\r
  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
  @retval EFI_SUCCESS            Success.\r
  @retval EFI_TIMEOUT            Device has no response.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbGetStatus (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINTN                   Recipient,\r
  IN  UINT16                  Target,\r
  OUT UINT16                  *DevStatus,\r
  OUT UINT32                  *Status\r
  );\r
\r
/**\r
  Clear endpoint stall.\r
\r
  @param  UsbIo                  A pointer to EFI_USB_IO_PROTOCOL.\r
  @param  EndpointNo             Endpoint Number.\r
  @param  Status                 Transfer Status.\r
\r
  @retval EFI_NOT_FOUND          Can't find the Endpoint.\r
  @retval EFI_DEVICE_ERROR       Hardware error.\r
  @retval EFI_SUCCESS            Success.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbClearEndpointHalt (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT8                   EndpointNo,\r
  OUT UINT32                  *Status\r
  );\r
\r
#endif\r
Commit	Line	Data
842f5579	1	/** @file\r
2c8547ab	2	Common Dxe Libarary for USB.\r
fb3df220	3	\r
2c8547ab	4	Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
842f5579 A	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
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	**/\r
fb3df220	14	\r
fb3df220	15	\r
842f5579 A	16	#ifndef __USB_DXE_LIB_H__\r
842f5579 A	17	#define __USB_DXE_LIB_H__\r
fb3df220	18	\r
c7d265a9	19	#include <Protocol/UsbIo.h>\r
ed838d0c	20	\r
fc30687f	21	///\r
	22	/// define the timeout time as 3ms\r
	23	///\r
fb3df220	24	#define TIMEOUT_VALUE 3 * 1000\r
fb3df220	25	\r
373b5cf9	26	/**\r
2c8547ab	27	Get Hid Descriptor.\r
373b5cf9	28	\r
2c8547ab	29	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
2c8547ab	30	@param InterfaceNum Hid interface number.\r
373b5cf9	31	@param HidDescriptor Caller allocated buffer to store Usb hid descriptor if\r
	32	successfully returned.\r
	33	\r
	34	@return Status of getting HID descriptor through USB I/O\r
	35	protocol's UsbControlTransfer().\r
	36	\r
	37	**/\r
fb3df220	38	EFI_STATUS\r
f1787349	39	EFIAPI\r
fb3df220	40	UsbGetHidDescriptor (\r
	41	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	42	IN UINT8 InterfaceNum,\r
	43	OUT EFI_USB_HID_DESCRIPTOR *HidDescriptor\r
	44	);\r
	45	\r
373b5cf9	46	\r
373b5cf9	47	/**\r
2c8547ab	48	get Report Class descriptor.\r
373b5cf9	49	\r
2c8547ab	50	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
373b5cf9	51	@param InterfaceNum Report interface number.\r
	52	@param DescriptorSize Length of DescriptorBuffer.\r
	53	@param DescriptorBuffer Caller allocated buffer to store Usb report descriptor\r
	54	if successfully returned.\r
	55	\r
	56	@return Status of getting Report Class descriptor through USB\r
	57	I/O protocol's UsbControlTransfer().\r
	58	\r
	59	**/\r
fb3df220	60	EFI_STATUS\r
f1787349	61	EFIAPI\r
fb3df220	62	UsbGetReportDescriptor (\r
	63	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	64	IN UINT8 InterfaceNum,\r
	65	IN UINT16 DescriptorSize,\r
	66	OUT UINT8 *DescriptorBuffer\r
	67	);\r
	68	\r
373b5cf9	69	/**\r
2c8547ab	70	Get Hid Protocol Request.\r
373b5cf9	71	\r
2c8547ab	72	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
2c8547ab	73	@param Interface Which interface the caller wants to get protocol.\r
373b5cf9	74	@param Protocol Protocol value returned.\r
	75	\r
	76	@return Status of getting Protocol Request through USB I/O\r
	77	protocol's UsbControlTransfer().\r
	78	\r
	79	**/\r
fb3df220	80	EFI_STATUS\r
f1787349	81	EFIAPI\r
fb3df220	82	UsbGetProtocolRequest (\r
	83	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	84	IN UINT8 Interface,\r
	85	IN UINT8 *Protocol\r
	86	);\r
	87	\r
373b5cf9	88	/**\r
2c8547ab	89	Set Hid Protocol Request.\r
373b5cf9	90	\r
2c8547ab	91	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
2c8547ab	92	@param Interface Which interface the caller wants to set protocol.\r
373b5cf9	93	@param Protocol Protocol value the caller wants to set.\r
	94	\r
	95	@return Status of setting Protocol Request through USB I/O\r
	96	protocol's UsbControlTransfer().\r
	97	\r
	98	**/\r
fb3df220	99	EFI_STATUS\r
f1787349	100	EFIAPI\r
fb3df220	101	UsbSetProtocolRequest (\r
	102	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	103	IN UINT8 Interface,\r
	104	IN UINT8 Protocol\r
	105	);\r
	106	\r
373b5cf9	107	/**\r
	108	Set Idel request.\r
	109	\r
2c8547ab	110	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
373b5cf9	111	@param Interface Which interface the caller wants to set.\r
	112	@param ReportId Which report the caller wants to set.\r
	113	@param Duration Idle rate the caller wants to set.\r
	114	\r
	115	@return Status of setting IDLE Request through USB I/O\r
	116	protocol's UsbControlTransfer().\r
	117	\r
	118	**/\r
fb3df220	119	EFI_STATUS\r
f1787349	120	EFIAPI\r
fb3df220	121	UsbSetIdleRequest (\r
	122	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	123	IN UINT8 Interface,\r
	124	IN UINT8 ReportId,\r
	125	IN UINT8 Duration\r
	126	);\r
	127	\r
373b5cf9	128	/**\r
	129	Get Idel request.\r
	130	\r
2c8547ab	131	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
373b5cf9	132	@param Interface Which interface the caller wants to get.\r
	133	@param ReportId Which report the caller wants to get.\r
	134	@param Duration Idle rate the caller wants to get.\r
	135	\r
	136	@return Status of getting IDLE Request through USB I/O\r
	137	protocol's UsbControlTransfer().\r
	138	\r
	139	**/\r
fb3df220	140	EFI_STATUS\r
f1787349	141	EFIAPI\r
fb3df220	142	UsbGetIdleRequest (\r
	143	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	144	IN UINT8 Interface,\r
	145	IN UINT8 ReportId,\r
	146	OUT UINT8 *Duration\r
	147	);\r
	148	\r
373b5cf9	149	/**\r
	150	Hid Set Report request.\r
	151	\r
2c8547ab	152	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
373b5cf9	153	@param Interface Which interface the caller wants to set.\r
	154	@param ReportId Which report the caller wants to set.\r
	155	@param ReportType Type of report.\r
	156	@param ReportLen Length of report descriptor.\r
	157	@param Report Report Descriptor buffer.\r
	158	\r
	159	@return Status of setting Report Request through USB I/O\r
	160	protocol's UsbControlTransfer().\r
	161	\r
	162	**/\r
fb3df220	163	EFI_STATUS\r
f1787349	164	EFIAPI\r
fb3df220	165	UsbSetReportRequest (\r
	166	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	167	IN UINT8 Interface,\r
	168	IN UINT8 ReportId,\r
	169	IN UINT8 ReportType,\r
	170	IN UINT16 ReportLen,\r
	171	IN UINT8 *Report\r
	172	);\r
	173	\r
373b5cf9	174	/**\r
	175	Hid Set Report request.\r
	176	\r
2c8547ab	177	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
373b5cf9	178	@param Interface Which interface the caller wants to set.\r
	179	@param ReportId Which report the caller wants to set.\r
	180	@param ReportType Type of report.\r
	181	@param ReportLen Length of report descriptor.\r
	182	@param Report Caller allocated buffer to store Report Descriptor.\r
	183	\r
	184	@return Status of getting Report Request through USB I/O\r
	185	protocol's UsbControlTransfer().\r
	186	\r
	187	**/\r
fb3df220	188	EFI_STATUS\r
f1787349	189	EFIAPI\r
fb3df220	190	UsbGetReportRequest (\r
	191	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	192	IN UINT8 Interface,\r
	193	IN UINT8 ReportId,\r
	194	IN UINT8 ReportType,\r
	195	IN UINT16 ReportLen,\r
	196	IN UINT8 *Report\r
	197	);\r
	198	\r
373b5cf9	199	/**\r
2c8547ab	200	Usb Get Descriptor.\r
373b5cf9	201	\r
2c8547ab	202	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
	203	@param Value Device Request Value.\r
	204	@param Index Device Request Index.\r
	205	@param DescriptorLength Descriptor Length.\r
	206	@param Descriptor Descriptor buffer to contain result.\r
	207	@param Status Transfer Status.\r
373b5cf9	208	\r
2c8547ab	209	@retval EFI_INVALID_PARAMETER Parameter is error.\r
	210	@retval EFI_SUCCESS Success.\r
	211	@retval EFI_TIMEOUT Device has no response.\r
373b5cf9	212	\r
373b5cf9	213	**/\r
fb3df220	214	EFI_STATUS\r
9199040c	215	EFIAPI\r
fb3df220	216	UsbGetDescriptor (\r
	217	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	218	IN UINT16 Value,\r
	219	IN UINT16 Index,\r
	220	IN UINT16 DescriptorLength,\r
	221	OUT VOID *Descriptor,\r
	222	OUT UINT32 *Status\r
	223	);\r
	224	\r
373b5cf9	225	/**\r
2c8547ab	226	Usb Set Descriptor.\r
373b5cf9	227	\r
2c8547ab	228	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
	229	@param Value Device Request Value.\r
	230	@param Index Device Request Index.\r
	231	@param DescriptorLength Descriptor Length.\r
	232	@param Descriptor Descriptor buffer to set.\r
	233	@param Status Transfer Status.\r
373b5cf9	234	\r
2c8547ab	235	@retval EFI_INVALID_PARAMETER Parameter is error.\r
	236	@retval EFI_SUCCESS Success.\r
	237	@retval EFI_TIMEOUT Device has no response.\r
373b5cf9	238	\r
373b5cf9	239	**/\r
fb3df220	240	EFI_STATUS\r
f1787349	241	EFIAPI\r
fb3df220	242	UsbSetDescriptor (\r
	243	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	244	IN UINT16 Value,\r
	245	IN UINT16 Index,\r
	246	IN UINT16 DescriptorLength,\r
	247	IN VOID *Descriptor,\r
	248	OUT UINT32 *Status\r
	249	);\r
	250	\r
373b5cf9	251	/**\r
2c8547ab	252	Usb Get Device Interface.\r
373b5cf9	253	\r
2c8547ab	254	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
	255	@param Index Interface index value.\r
	256	@param AltSetting Alternate setting.\r
	257	@param Status Trasnsfer status.\r
373b5cf9	258	\r
2c8547ab	259	@retval EFI_INVALID_PARAMETER Parameter is error.\r
	260	@retval EFI_SUCCESS Success.\r
	261	@retval EFI_TIMEOUT Device has no response.\r
373b5cf9	262	\r
373b5cf9	263	**/\r
fb3df220	264	EFI_STATUS\r
f1787349	265	EFIAPI\r
ed838d0c	266	UsbGetInterface (\r
fb3df220	267	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	268	IN UINT16 Index,\r
	269	OUT UINT8 *AltSetting,\r
	270	OUT UINT32 *Status\r
	271	);\r
	272	\r
373b5cf9	273	/**\r
2c8547ab	274	Usb Set Device Interface.\r
373b5cf9	275	\r
2c8547ab	276	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
	277	@param InterfaceNo Interface Number.\r
	278	@param AltSetting Alternate setting.\r
	279	@param Status Trasnsfer status.\r
373b5cf9	280	\r
2c8547ab	281	@retval EFI_INVALID_PARAMETER Parameter is error.\r
	282	@retval EFI_SUCCESS Success.\r
	283	@retval EFI_TIMEOUT Device has no response.\r
373b5cf9	284	\r
373b5cf9	285	**/\r
fb3df220	286	EFI_STATUS\r
f1787349	287	EFIAPI\r
ed838d0c	288	UsbSetInterface (\r
fb3df220	289	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	290	IN UINT16 InterfaceNo,\r
	291	IN UINT16 AltSetting,\r
	292	OUT UINT32 *Status\r
	293	);\r
	294	\r
373b5cf9	295	/**\r
2c8547ab	296	Usb Get Device Configuration.\r
373b5cf9	297	\r
2c8547ab	298	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
	299	@param ConfigValue Config Value.\r
	300	@param Status Transfer Status.\r
373b5cf9	301	\r
2c8547ab	302	@retval EFI_INVALID_PARAMETER Parameter is error.\r
	303	@retval EFI_SUCCESS Success.\r
	304	@retval EFI_TIMEOUT Device has no response.\r
373b5cf9	305	\r
373b5cf9	306	**/\r
fb3df220	307	EFI_STATUS\r
f1787349	308	EFIAPI\r
ed838d0c	309	UsbGetConfiguration (\r
fb3df220	310	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	311	OUT UINT8 *ConfigValue,\r
	312	OUT UINT32 *Status\r
	313	);\r
	314	\r
373b5cf9	315	/**\r
2c8547ab	316	Usb Set Device Configuration.\r
373b5cf9	317	\r
2c8547ab	318	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
	319	@param Value Configuration Value to set.\r
	320	@param Status Transfer status.\r
373b5cf9	321	\r
2c8547ab	322	@retval EFI_INVALID_PARAMETER Parameter is error.\r
	323	@retval EFI_SUCCESS Success.\r
	324	@retval EFI_TIMEOUT Device has no response.\r
373b5cf9	325	\r
373b5cf9	326	**/\r
fb3df220	327	EFI_STATUS\r
f1787349	328	EFIAPI\r
ed838d0c	329	UsbSetConfiguration (\r
fb3df220	330	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	331	IN UINT16 Value,\r
	332	OUT UINT32 *Status\r
	333	);\r
	334	\r
373b5cf9	335	/**\r
2c8547ab	336	Usb Set Device Feature.\r
373b5cf9	337	\r
2c8547ab	338	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
	339	@param Recipient Interface/Device/Endpoint.\r
	340	@param Value Request value.\r
	341	@param Target Request Index.\r
	342	@param Status Transfer status.\r
373b5cf9	343	\r
2c8547ab	344	@retval EFI_INVALID_PARAMETER Parameter is error.\r
	345	@retval EFI_SUCCESS Success.\r
	346	@retval EFI_TIMEOUT Device has no response.\r
373b5cf9	347	\r
373b5cf9	348	**/\r
fb3df220	349	EFI_STATUS\r
f1787349	350	EFIAPI\r
ed838d0c	351	UsbSetFeature (\r
fb3df220	352	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
ed838d0c	353	IN UINTN Recipient,\r
fb3df220	354	IN UINT16 Value,\r
	355	IN UINT16 Target,\r
	356	OUT UINT32 *Status\r
	357	);\r
	358	\r
373b5cf9	359	/**\r
2c8547ab	360	Usb Clear Device Feature.\r
373b5cf9	361	\r
2c8547ab	362	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
	363	@param Recipient Interface/Device/Endpoint.\r
	364	@param Value Request value.\r
	365	@param Target Request Index.\r
	366	@param Status Transfer status.\r
373b5cf9	367	\r
2c8547ab	368	@retval EFI_INVALID_PARAMETER Parameter is error.\r
	369	@retval EFI_SUCCESS Success.\r
	370	@retval EFI_TIMEOUT Device has no response.\r
373b5cf9	371	\r
373b5cf9	372	**/\r
fb3df220	373	EFI_STATUS\r
f1787349	374	EFIAPI\r
ed838d0c	375	UsbClearFeature (\r
fb3df220	376	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
ed838d0c	377	IN UINTN Recipient,\r
fb3df220	378	IN UINT16 Value,\r
	379	IN UINT16 Target,\r
	380	OUT UINT32 *Status\r
	381	);\r
	382	\r
373b5cf9	383	/**\r
2c8547ab	384	Usb Get Device Status.\r
373b5cf9	385	\r
2c8547ab	386	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
	387	@param Recipient Interface/Device/Endpoint.\r
	388	@param Target Request index.\r
	389	@param DevStatus Device status.\r
	390	@param Status Transfer status.\r
373b5cf9	391	\r
2c8547ab	392	@retval EFI_INVALID_PARAMETER Parameter is error.\r
	393	@retval EFI_SUCCESS Success.\r
	394	@retval EFI_TIMEOUT Device has no response.\r
373b5cf9	395	\r
373b5cf9	396	**/\r
fb3df220	397	EFI_STATUS\r
f1787349	398	EFIAPI\r
ed838d0c	399	UsbGetStatus (\r
fb3df220	400	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
ed838d0c	401	IN UINTN Recipient,\r
fb3df220	402	IN UINT16 Target,\r
	403	OUT UINT16 *DevStatus,\r
	404	OUT UINT32 *Status\r
	405	);\r
	406	\r
373b5cf9	407	/**\r
2c8547ab	408	Clear endpoint stall.\r
373b5cf9	409	\r
2c8547ab	410	@param UsbIo A pointer to EFI_USB_IO_PROTOCOL.\r
	411	@param EndpointNo Endpoint Number.\r
	412	@param Status Transfer Status.\r
373b5cf9	413	\r
2c8547ab	414	@retval EFI_NOT_FOUND Can't find the Endpoint.\r
	415	@retval EFI_DEVICE_ERROR Hardware error.\r
	416	@retval EFI_SUCCESS Success.\r
373b5cf9	417	\r
373b5cf9	418	**/\r
fb3df220	419	EFI_STATUS\r
f1787349	420	EFIAPI\r
fb3df220	421	UsbClearEndpointHalt (\r
	422	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	423	IN UINT8 EndpointNo,\r
	424	OUT UINT32 *Status\r
	425	);\r
	426	\r
	427	#endif\r