diff options
author | jji4 <jji4@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-11-17 11:24:14 +0000 |
---|---|---|
committer | jji4 <jji4@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-11-17 11:24:14 +0000 |
commit | d5954c618f10c9f75a4d125985550e694c7a3f22 (patch) | |
tree | 7e214f4bdcbac1a2ce030189f783339f5c42294b /MdePkg/Library/UefiUsbLib | |
parent | 17f695ed2b6749fa09e9c86b9784c99d3c08e547 (diff) | |
download | edk2-platforms-d5954c618f10c9f75a4d125985550e694c7a3f22.tar.xz |
Code Scrub:
The code of MdePkg\Library\UefiScsiLib\ and MdePkg\Library\UefiUsbLib has been checked and modified according to MDE_Library_Spec_0.61h-4.doc.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6561 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Library/UefiUsbLib')
-rw-r--r-- | MdePkg/Library/UefiUsbLib/Hid.c | 242 | ||||
-rw-r--r-- | MdePkg/Library/UefiUsbLib/UefiUsbLib.inf | 1 | ||||
-rw-r--r-- | MdePkg/Library/UefiUsbLib/UefiUsbLibInternal.h | 9 | ||||
-rw-r--r-- | MdePkg/Library/UefiUsbLib/UsbDxeLib.c | 369 |
4 files changed, 378 insertions, 243 deletions
diff --git a/MdePkg/Library/UefiUsbLib/Hid.c b/MdePkg/Library/UefiUsbLib/Hid.c index 0e9be35206..d2a4b577ff 100644 --- a/MdePkg/Library/UefiUsbLib/Hid.c +++ b/MdePkg/Library/UefiUsbLib/Hid.c @@ -30,37 +30,43 @@ //
/**
- Get Hid Descriptor.
+ Get the descriptor of the specified USB HID interface.
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param InterfaceNum Hid interface number.
- @param HidDescriptor Caller allocated buffer to store Usb hid descriptor if
- successfully returned.
+ Submit a USB get HID descriptor request for the USB device specified by UsbIo
+ and Interface and return the HID descriptor in HidDescriptor.
+ If UsbIo is NULL, then ASSERT().
+ If HidDescriptor is NULL, then ASSERT().
- @return Status of getting HID descriptor through USB I/O
- protocol's UsbControlTransfer().
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param Interface The index of the HID interface on the USB target.
+ @param HidDescriptor Pointer to the USB HID descriptor that was retrieved from
+ the specified USB target and interface. Type EFI_USB_HID_DESCRIPTOR
+ is defined in the MDE Package Industry Standard include file Usb.h.
+
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error.
**/
EFI_STATUS
EFIAPI
UsbGetHidDescriptor (
IN EFI_USB_IO_PROTOCOL *UsbIo,
- IN UINT8 InterfaceNum,
+ IN UINT8 Interface,
OUT EFI_USB_HID_DESCRIPTOR *HidDescriptor
)
{
UINT32 Status;
EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request;
-
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+
+ ASSERT(UsbIo != NULL);
+ ASSERT(HidDescriptor != NULL);
Request.RequestType = USB_HID_GET_DESCRIPTOR_REQ_TYPE;
Request.Request = USB_REQ_GET_DESCRIPTOR;
Request.Value = (UINT16) (USB_DESC_TYPE_HID << 8);
- Request.Index = InterfaceNum;
+ Request.Index = Interface;
Request.Length = sizeof (EFI_USB_HID_DESCRIPTOR);
Result = UsbIo->UsbControlTransfer (
@@ -78,24 +84,32 @@ UsbGetHidDescriptor ( }
/**
- Get Report Class descriptor.
+ Get the report descriptor of the specified USB HID interface.
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param InterfaceNum Report interface number.
- @param DescriptorSize Length of DescriptorBuffer.
- @param DescriptorBuffer Caller allocated buffer to store Usb report descriptor
- if successfully returned.
+ Submit a USB get HID report descriptor request for the USB device specified by
+ UsbIo and Interface and return the report descriptor in DescriptorBuffer.
+ If UsbIo is NULL, then ASSERT().
+ If DescriptorBuffer is NULL, then ASSERT().
- @return Status of getting Report Class descriptor through USB
- I/O protocol's UsbControlTransfer().
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param Interface The index of the report interface on the USB target.
+ @param DescriptorLength The size, in bytes, of DescriptorBuffer.
+ @param DescriptorBuffer A pointer to the buffer to store the report class descriptor.
+
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed because the
+ buffer specifed by DescriptorLength and DescriptorBuffer
+ is not large enough to hold the result of the request.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error.
**/
EFI_STATUS
EFIAPI
UsbGetReportDescriptor (
IN EFI_USB_IO_PROTOCOL *UsbIo,
- IN UINT8 InterfaceNum,
- IN UINT16 DescriptorSize,
+ IN UINT8 Interface,
+ IN UINT16 DescriptorLength,
OUT UINT8 *DescriptorBuffer
)
{
@@ -103,17 +117,17 @@ UsbGetReportDescriptor ( EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
+ ASSERT (DescriptorBuffer != NULL);
+
//
// Fill Device request packet
//
Request.RequestType = USB_HID_GET_DESCRIPTOR_REQ_TYPE;
Request.Request = USB_REQ_GET_DESCRIPTOR;
Request.Value = (UINT16) (USB_DESC_TYPE_REPORT << 8);
- Request.Index = InterfaceNum;
- Request.Length = DescriptorSize;
+ Request.Index = Interface;
+ Request.Length = DescriptorLength;
Result = UsbIo->UsbControlTransfer (
UsbIo,
@@ -121,7 +135,7 @@ UsbGetReportDescriptor ( EfiUsbDataIn,
TIMEOUT_VALUE,
DescriptorBuffer,
- DescriptorSize,
+ DescriptorLength,
&Status
);
@@ -130,14 +144,20 @@ UsbGetReportDescriptor ( }
/**
- Get Hid Protocol Request
+ Get the HID protocol of the specified USB HID interface.
+
+ Submit a USB get HID protocol request for the USB device specified by UsbIo
+ and Interface and return the protocol retrieved in Protocol.
+ If UsbIo is NULL, then ASSERT().
+ If Protocol is NULL, then ASSERT().
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param Interface Which interface the caller wants to get protocol
- @param Protocol Protocol value returned.
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param Interface The index of the report interface on the USB target.
+ @param Protocol A pointer to the protocol for the specified USB target.
- @return Status of getting Protocol Request through USB I/O
- protocol's UsbControlTransfer().
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error.
**/
EFI_STATUS
@@ -152,9 +172,9 @@ UsbGetProtocolRequest ( EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
+ ASSERT (Protocol != NULL);
+
//
// Fill Device request packet
//
@@ -180,15 +200,19 @@ UsbGetProtocolRequest ( /**
- Set Hid Protocol Request.
+ Set the HID protocol of the specified USB HID interface.
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param Interface Which interface the caller wants to
- set protocol.
- @param Protocol Protocol value the caller wants to set.
+ Submit a USB set HID protocol request for the USB device specified by UsbIo
+ and Interface and set the protocol to the value specified by Protocol.
+ If UsbIo is NULL, then ASSERT().
- @return Status of setting Protocol Request through USB I/O
- protocol's UsbControlTransfer().
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param Interface The index of the report interface on the USB target.
+ @param Protocol The protocol value to set for the specified USB target.
+
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error.
**/
EFI_STATUS
@@ -203,9 +227,8 @@ UsbSetProtocolRequest ( EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
+
//
// Fill Device request packet
//
@@ -229,15 +252,20 @@ UsbSetProtocolRequest ( /**
- Set Idel request.
+ Set the idle rate of the specified USB HID report.
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param Interface Which interface the caller wants to set.
- @param ReportId Which report the caller wants to set.
- @param Duration Idle rate the caller wants to set.
+ Submit a USB set HID report idle request for the USB device specified by UsbIo,
+ Interface, and ReportId, and set the idle rate to the value specified by Duration.
+ If UsbIo is NULL, then ASSERT().
- @return Status of setting IDLE Request through USB I/O
- protocol's UsbControlTransfer().
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param Interface The index of the report interface on the USB target.
+ @param ReportId The identifier of the report to retrieve.
+ @param Duration The idle rate to set for the specified USB target.
+
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error.
**/
EFI_STATUS
@@ -253,9 +281,7 @@ UsbSetIdleRequest ( EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
//
// Fill Device request packet
//
@@ -279,15 +305,21 @@ UsbSetIdleRequest ( /**
- Get Idel request.
+ Get the idle rate of the specified USB HID report.
+
+ Submit a USB get HID report idle request for the USB device specified by UsbIo,
+ Interface, and ReportId, and return the ide rate in Duration.
+ If UsbIo is NULL, then ASSERT().
+ If Duration is NULL, then ASSERT().
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param Interface Which interface the caller wants to get.
- @param ReportId Which report the caller wants to get.
- @param Duration Idle rate the caller wants to get.
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param Interface The index of the report interface on the USB target.
+ @param ReportId The identifier of the report to retrieve.
+ @param Duration A pointer to the idle rate retrieved from the specified USB target.
- @return Status of getting IDLE Request through USB I/O
- protocol's UsbControlTransfer().
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error.
**/
EFI_STATUS
@@ -303,9 +335,8 @@ UsbGetIdleRequest ( EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
+ ASSERT (Duration != NULL);
//
// Fill Device request packet
//
@@ -331,17 +362,24 @@ UsbGetIdleRequest ( /**
- Hid Set Report request.
+ Set the report descriptor of the specified USB HID interface.
+
+ Submit a USB set HID report request for the USB device specified by UsbIo,
+ Interface, ReportId, and ReportType, and set the report descriptor using the
+ buffer specified by ReportLength and Report.
+ If UsbIo is NULL, then ASSERT().
+ If Report is NULL, then ASSERT().
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param Interface Which interface the caller wants to set.
- @param ReportId Which report the caller wants to set.
- @param ReportType Type of report.
- @param ReportLen Length of report descriptor.
- @param Report Report Descriptor buffer.
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param Interface The index of the report interface on the USB target.
+ @param ReportId The identifier of the report to retrieve.
+ @param ReportType The type of report to retrieve.
+ @param ReportLength The size, in bytes, of Report.
+ @param Report A pointer to the report descriptor buffer to set.
- @return Status of setting Report Request through USB I/O
- protocol's UsbControlTransfer().
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error.
**/
EFI_STATUS
@@ -351,7 +389,7 @@ UsbSetReportRequest ( IN UINT8 Interface,
IN UINT8 ReportId,
IN UINT8 ReportType,
- IN UINT16 ReportLen,
+ IN UINT16 ReportLength,
IN UINT8 *Report
)
{
@@ -359,9 +397,9 @@ UsbSetReportRequest ( EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
+ ASSERT (Report != NULL);
+
//
// Fill Device request packet
//
@@ -369,7 +407,7 @@ UsbSetReportRequest ( Request.Request = EFI_USB_SET_REPORT_REQUEST;
Request.Value = (UINT16) ((ReportType << 8) | ReportId);
Request.Index = Interface;
- Request.Length = ReportLen;
+ Request.Length = ReportLength;
Result = UsbIo->UsbControlTransfer (
UsbIo,
@@ -377,7 +415,7 @@ UsbSetReportRequest ( EfiUsbDataOut,
TIMEOUT_VALUE,
Report,
- ReportLen,
+ ReportLength,
&Status
);
@@ -386,17 +424,27 @@ UsbSetReportRequest ( /**
- Hid Set Report request.
-
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param Interface Which interface the caller wants to set.
- @param ReportId Which report the caller wants to set.
- @param ReportType Type of report.
- @param ReportLen Length of report descriptor.
- @param Report Caller allocated buffer to store Report Descriptor.
-
- @return Status of getting Report Request through USB I/O
- protocol's UsbControlTransfer().
+ Get the report descriptor of the specified USB HID interface.
+
+ Submit a USB get HID report request for the USB device specified by UsbIo,
+ Interface, ReportId, and ReportType, and return the report in the buffer
+ specified by Report.
+ If UsbIo is NULL, then ASSERT().
+ If Report is NULL, then ASSERT().
+
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param Interface The index of the report interface on the USB target.
+ @param ReportId The identifier of the report to retrieve.
+ @param ReportType The type of report to retrieve.
+ @param ReportLength The size, in bytes, of Report.
+ @param Report A pointer to the buffer to store the report descriptor.
+
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed because the
+ buffer specifed by ReportLength and Report is not
+ large enough to hold the result of the request.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error.
**/
EFI_STATUS
@@ -414,9 +462,9 @@ UsbGetReportRequest ( EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
+ ASSERT (Report != NULL);
+
//
// Fill Device request packet
//
diff --git a/MdePkg/Library/UefiUsbLib/UefiUsbLib.inf b/MdePkg/Library/UefiUsbLib/UefiUsbLib.inf index 12290dc571..6ebd81a426 100644 --- a/MdePkg/Library/UefiUsbLib/UefiUsbLib.inf +++ b/MdePkg/Library/UefiUsbLib/UefiUsbLib.inf @@ -38,5 +38,6 @@ MdePkg/MdePkg.dec
[LibraryClasses]
+ DebugLib
BaseMemoryLib
diff --git a/MdePkg/Library/UefiUsbLib/UefiUsbLibInternal.h b/MdePkg/Library/UefiUsbLib/UefiUsbLibInternal.h index e8c817ae1d..329606d565 100644 --- a/MdePkg/Library/UefiUsbLib/UefiUsbLibInternal.h +++ b/MdePkg/Library/UefiUsbLib/UefiUsbLibInternal.h @@ -13,11 +13,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
-#ifndef __UEFI_USB_LIB_INTERNAL_H_
-#define __UEFI_USB_LIB_INTERNAL_H_
+#ifndef _UEFI_USB_LIB_INTERNAL_H_
+#define _UEFI_USB_LIB_INTERNAL_H_
#include <Uefi.h>
+
#include <Library/UefiUsbLib.h>
#include <Library/BaseMemoryLib.h>
+#include <Library/DebugLib.h>
+
+#include <IndustryStandard/Usb.h>
+
#endif
diff --git a/MdePkg/Library/UefiUsbLib/UsbDxeLib.c b/MdePkg/Library/UefiUsbLib/UsbDxeLib.c index 18fe37c381..a15ef6ebef 100644 --- a/MdePkg/Library/UefiUsbLib/UsbDxeLib.c +++ b/MdePkg/Library/UefiUsbLib/UsbDxeLib.c @@ -19,18 +19,29 @@ /**
- Usb Get Descriptor.
-
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param Value Device Request Value.
- @param Index Device Request Index.
- @param DescriptorLength Descriptor Length.
- @param Descriptor Descriptor buffer to contain result.
- @param Status Transfer Status.
-
- @retval EFI_INVALID_PARAMETER Parameter is error.
- @retval EFI_SUCCESS Success.
- @retval EFI_TIMEOUT Device has no response.
+ Get the descriptor of the specified USB device.
+
+ Submit a USB get descriptor request for the USB device specified by UsbIo, Value,
+ and Index, and return the descriptor in the buffer specified by Descriptor.
+ The status of the transfer is returned in Status.
+ If UsbIo is NULL, then ASSERT().
+ If Descriptor is NULL, then ASSERT().
+ If Status is NULL, then ASSERT().
+
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param Value The device request value.
+ @param Index The device request index.
+ @param DescriptorLength The size, in bytes, of Descriptor.
+ @param Descriptor A pointer to the descriptor buffer to get.
+ @param Status A pointer to the status of the transfer.
+
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed because the
+ buffer specifed by DescriptorLength and Descriptor
+ is not large enough to hold the result of the request.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error. The transfer
+ status is returned in Status.
**/
EFI_STATUS
@@ -46,9 +57,9 @@ UsbGetDescriptor ( {
EFI_USB_DEVICE_REQUEST DevReq;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
+ ASSERT (Descriptor != NULL);
+ ASSERT (Status != NULL);
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
@@ -71,18 +82,26 @@ UsbGetDescriptor ( /**
- Usb Set Descriptor.
-
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param Value Device Request Value.
- @param Index Device Request Index.
- @param DescriptorLength Descriptor Length.
- @param Descriptor Descriptor buffer to set.
- @param Status Transfer Status.
-
- @retval EFI_INVALID_PARAMETER Parameter is error.
- @retval EFI_SUCCESS Success.
- @retval EFI_TIMEOUT Device has no response.
+ Set the descriptor of the specified USB device.
+
+ Submit a USB set descriptor request for the USB device specified by UsbIo,
+ Value, and Index, and set the descriptor using the buffer specified by DesriptorLength
+ and Descriptor. The status of the transfer is returned in Status.
+ If UsbIo is NULL, then ASSERT().
+ If Descriptor is NULL, then ASSERT().
+ If Status is NULL, then ASSERT().
+
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param Value The device request value.
+ @param Index The device request index.
+ @param DescriptorLength The size, in bytes, of Descriptor.
+ @param Descriptor A pointer to the descriptor buffer to set.
+ @param Status A pointer to the status of the transfer.
+
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error.
+ The transfer status is returned in Status.
**/
EFI_STATUS
@@ -98,9 +117,9 @@ UsbSetDescriptor ( {
EFI_USB_DEVICE_REQUEST DevReq;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
+ ASSERT (Descriptor != NULL);
+ ASSERT (Status != NULL);
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
@@ -123,38 +142,46 @@ UsbSetDescriptor ( /**
- Usb Get Device Interface.
+ Get the interface setting of the specified USB device.
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param Index Interface index value.
- @param AltSetting Alternate setting.
- @param Status Trasnsfer status.
+ Submit a USB get interface request for the USB device specified by UsbIo,
+ and Interface, and place the result in the buffer specified by AlternateSetting.
+ The status of the transfer is returned in Status.
+ If UsbIo is NULL, then ASSERT().
+ If AlternateSetting is NULL, then ASSERT().
+ If Status is NULL, then ASSERT().
- @retval EFI_INVALID_PARAMETER Parameter is error.
- @retval EFI_SUCCESS Success.
- @retval EFI_TIMEOUT Device has no response.
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param Interface The interface index value.
+ @param AlternateSetting A pointer to the alternate setting to be retrieved.
+ @param Status A pointer to the status of the transfer.
+
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error.
+ The transfer status is returned in Status.
**/
EFI_STATUS
EFIAPI
UsbGetInterface (
IN EFI_USB_IO_PROTOCOL *UsbIo,
- IN UINT16 Index,
- OUT UINT8 *AltSetting,
+ IN UINT16 Interface,
+ OUT UINT8 *AlternateSetting,
OUT UINT32 *Status
)
{
EFI_USB_DEVICE_REQUEST DevReq;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
+ ASSERT (AlternateSetting != NULL);
+ ASSERT (Status != NULL);
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
DevReq.RequestType = USB_DEV_GET_INTERFACE_REQ_TYPE;
DevReq.Request = USB_REQ_GET_INTERFACE;
- DevReq.Index = Index;
+ DevReq.Index = Interface;
DevReq.Length = 1;
return UsbIo->UsbControlTransfer (
@@ -162,7 +189,7 @@ UsbGetInterface ( &DevReq,
EfiUsbDataIn,
TIMEOUT_VALUE,
- AltSetting,
+ AlternateSetting,
1,
Status
);
@@ -170,40 +197,45 @@ UsbGetInterface ( /**
- Usb Set Device Interface.
+ Set the interface setting of the specified USB device.
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param InterfaceNo Interface Number.
- @param AltSetting Alternate setting.
- @param Status Trasnsfer status.
+ Submit a USB set interface request for the USB device specified by UsbIo, and
+ Interface, and set the alternate setting to the value specified by AlternateSetting.
+ The status of the transfer is returned in Status.
+ If UsbIo is NULL, then ASSERT().
+ If Status is NULL, then ASSERT().
- @retval EFI_INVALID_PARAMETER Parameter is error.
- @retval EFI_SUCCESS Success.
- @retval EFI_TIMEOUT Device has no response.
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param Interface The interface index value.
+ @param AlternateSetting The alternate setting to be set.
+ @param Status A pointer to the status of the transfer.
+
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_SUCCESS The request failed due to a device error.
+ The transfer status is returned in Status.
**/
EFI_STATUS
EFIAPI
UsbSetInterface (
IN EFI_USB_IO_PROTOCOL *UsbIo,
- IN UINT16 InterfaceNo,
- IN UINT16 AltSetting,
+ IN UINT16 Interface,
+ IN UINT16 AlternateSetting,
OUT UINT32 *Status
)
{
EFI_USB_DEVICE_REQUEST DevReq;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
+ ASSERT (Status != NULL);
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
DevReq.RequestType = USB_DEV_SET_INTERFACE_REQ_TYPE;
DevReq.Request = USB_REQ_SET_INTERFACE;
- DevReq.Value = AltSetting;
- DevReq.Index = InterfaceNo;
-
+ DevReq.Value = AlternateSetting;
+ DevReq.Index = Interface;
return UsbIo->UsbControlTransfer (
UsbIo,
@@ -218,30 +250,38 @@ UsbSetInterface ( /**
- Usb Get Device Configuration.
+ Get the device configuration.
+
+ Submit a USB get configuration request for the USB device specified by UsbIo
+ and place the result in the buffer specified by ConfigurationValue. The status
+ of the transfer is returned in Status.
+ If UsbIo is NULL, then ASSERT().
+ If ConfigurationValue is NULL, then ASSERT().
+ If Status is NULL, then ASSERT().
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param ConfigValue Config Value.
- @param Status Transfer Status.
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param ConfigurationValue A pointer to the device configuration to be retrieved.
+ @param Status A pointer to the status of the transfer.
- @retval EFI_INVALID_PARAMETER Parameter is error.
- @retval EFI_SUCCESS Success.
- @retval EFI_TIMEOUT Device has no response.
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error.
+ The transfer status is returned in Status.
**/
EFI_STATUS
EFIAPI
UsbGetConfiguration (
IN EFI_USB_IO_PROTOCOL *UsbIo,
- OUT UINT8 *ConfigValue,
+ OUT UINT8 *ConfigurationValue,
OUT UINT32 *Status
)
{
EFI_USB_DEVICE_REQUEST DevReq;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
+ ASSERT (ConfigurationValue != NULL);
+ ASSERT (Status != NULL);
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
@@ -254,7 +294,7 @@ UsbGetConfiguration ( &DevReq,
EfiUsbDataIn,
TIMEOUT_VALUE,
- ConfigValue,
+ ConfigurationValue,
1,
Status
);
@@ -262,36 +302,42 @@ UsbGetConfiguration ( /**
- Usb Set Device Configuration.
+ Set the device configuration.
+
+ Submit a USB set configuration request for the USB device specified by UsbIo
+ and set the device configuration to the value specified by ConfigurationValue.
+ The status of the transfer is returned in Status.
+ If UsbIo is NULL, then ASSERT().
+ If Status is NULL, then ASSERT().
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param Value Configuration Value to set.
- @param Status Transfer status.
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param ConfigurationValue The device configuration value to be set.
+ @param Status A pointer to the status of the transfer.
- @retval EFI_INVALID_PARAMETER Parameter is error.
- @retval EFI_SUCCESS Success.
- @retval EFI_TIMEOUT Device has no response.
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error.
+ The transfer status is returned in Status.
**/
EFI_STATUS
EFIAPI
UsbSetConfiguration (
IN EFI_USB_IO_PROTOCOL *UsbIo,
- IN UINT16 Value,
+ IN UINT16 ConfigurationValue,
OUT UINT32 *Status
)
{
EFI_USB_DEVICE_REQUEST DevReq;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
+ ASSERT (Status != NULL);
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
DevReq.RequestType = USB_DEV_SET_CONFIGURATION_REQ_TYPE;
DevReq.Request = USB_REQ_SET_CONFIG;
- DevReq.Value = Value;
+ DevReq.Value = ConfigurationValue;
return UsbIo->UsbControlTransfer (
UsbIo,
@@ -306,24 +352,33 @@ UsbSetConfiguration ( /**
- Usb Set Device Feature.
-
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param Recipient Interface/Device/Endpoint.
- @param Value Request value.
- @param Target Request Index.
- @param Status Transfer status.
-
- @retval EFI_INVALID_PARAMETER Parameter is error.
- @retval EFI_SUCCESS Success.
- @retval EFI_TIMEOUT Device has no response.
+ Set the specified feature of the specified device.
+
+ Submit a USB set device feature request for the USB device specified by UsbIo,
+ Recipient, and Target to the value specified by Value. The status of the
+ transfer is returned in Status.
+ If UsbIo is NULL, then ASSERT().
+ If Status is NULL, then ASSERT().
+
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param Recipient The USB data recipient type (i.e. Device, Interface, Endpoint).
+ Type USB_TYPES_DEFINITION is defined in the MDE Package Industry
+ Standard include file Usb.h.
+ @param Value The value of the feature to be set.
+ @param Target The index of the device to be set.
+ @param Status A pointer to the status of the transfer.
+
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error.
+ The transfer status is returned in Status.
**/
EFI_STATUS
EFIAPI
UsbSetFeature (
IN EFI_USB_IO_PROTOCOL *UsbIo,
- IN UINTN Recipient,
+ IN USB_TYPES_DEFINITION Recipient,
IN UINT16 Value,
IN UINT16 Target,
OUT UINT32 *Status
@@ -331,9 +386,8 @@ UsbSetFeature ( {
EFI_USB_DEVICE_REQUEST DevReq;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
+ ASSERT (Status != NULL);
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
@@ -372,24 +426,33 @@ UsbSetFeature ( /**
- Usb Clear Device Feature.
-
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param Recipient Interface/Device/Endpoint.
- @param Value Request value.
- @param Target Request Index.
- @param Status Transfer status.
-
- @retval EFI_INVALID_PARAMETER Parameter is error.
- @retval EFI_SUCCESS Success.
- @retval EFI_TIMEOUT Device has no response.
+ Clear the specified feature of the specified device.
+
+ Submit a USB clear device feature request for the USB device specified by UsbIo,
+ Recipient, and Target to the value specified by Value. The status of the transfer
+ is returned in Status.
+ If UsbIo is NULL, then ASSERT().
+ If Status is NULL, then ASSERT().
+
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param Recipient The USB data recipient type (i.e. Device, Interface, Endpoint).
+ Type USB_TYPES_DEFINITION is defined in the MDE Package Industry Standard
+ include file Usb.h.
+ @param Value The value of the feature to be cleared.
+ @param Target The index of the device to be cleared.
+ @param Status A pointer to the status of the transfer.
+
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error.
+ The transfer status is returned in Status.
**/
EFI_STATUS
EFIAPI
UsbClearFeature (
IN EFI_USB_IO_PROTOCOL *UsbIo,
- IN UINTN Recipient,
+ IN USB_TYPES_DEFINITION Recipient,
IN UINT16 Value,
IN UINT16 Target,
OUT UINT32 *Status
@@ -397,9 +460,9 @@ UsbClearFeature ( {
EFI_USB_DEVICE_REQUEST DevReq;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
+ ASSERT (Status != NULL);
+
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
@@ -438,34 +501,44 @@ UsbClearFeature ( /**
- Usb Get Device Status.
-
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param Recipient Interface/Device/Endpoint.
- @param Target Request index.
- @param DevStatus Device status.
- @param Status Transfer status.
-
- @retval EFI_INVALID_PARAMETER Parameter is error.
- @retval EFI_SUCCESS Success.
- @retval EFI_TIMEOUT Device has no response.
+ Get the status of the specified device.
+
+ Submit a USB device get status request for the USB device specified by UsbIo,
+ Recipient, and Target and place the result in the buffer specified by DeviceStatus.
+ The status of the transfer is returned in Status.
+ If UsbIo is NULL, then ASSERT().
+ If DeviceStatus is NULL, then ASSERT().
+ If Status is NULL, then ASSERT().
+
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param Recipient The USB data recipient type (i.e. Device, Interface, Endpoint).
+ Type USB_TYPES_DEFINITION is defined in the MDE Package Industry Standard
+ include file Usb.h.
+ @param Target The index of the device to be get the status of.
+ @param DeviceStatus A pointer to the device status to be retrieved.
+ @param Status A pointer to the status of the transfer.
+
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error.
+ The transfer status is returned in Status.
**/
EFI_STATUS
EFIAPI
UsbGetStatus (
IN EFI_USB_IO_PROTOCOL *UsbIo,
- IN UINTN Recipient,
+ IN USB_TYPES_DEFINITION Recipient,
IN UINT16 Target,
- OUT UINT16 *DevStatus,
+ OUT UINT16 *DeviceStatus,
OUT UINT32 *Status
)
{
EFI_USB_DEVICE_REQUEST DevReq;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
+ ASSERT (DeviceStatus != NULL);
+ ASSERT (Status != NULL);
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
@@ -496,7 +569,7 @@ UsbGetStatus ( &DevReq,
EfiUsbDataIn,
TIMEOUT_VALUE,
- DevStatus,
+ DeviceStatus,
2,
Status
);
@@ -504,22 +577,31 @@ UsbGetStatus ( /**
- Clear endpoint stall.
+ Clear halt feature of the specified usb endpoint.
+
+ Retrieve the USB endpoint descriptor specified by UsbIo and EndPoint.
+ If the USB endpoint descriptor can not be retrieved, then return EFI_NOT_FOUND.
+ If the endpoint descriptor is found, then clear the halt fature of this USB endpoint.
+ The status of the transfer is returned in Status.
+ If UsbIo is NULL, then ASSERT().
+ If Status is NULL, then ASSERT().
- @param UsbIo EFI_USB_IO_PROTOCOL.
- @param EndpointNo Endpoint Number.
- @param Status Transfer Status.
+ @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
+ @param Endpoint The endpoint address.
+ @param Status A pointer to the status of the transfer.
- @retval EFI_NOT_FOUND Can't find the Endpoint.
- @retval EFI_DEVICE_ERROR Hardware error.
- @retval EFI_SUCCESS Success.
+ @retval EFI_SUCCESS The request executed successfully.
+ @retval EFI_TIMEOUT A timeout occurred executing the request.
+ @retval EFI_DEVICE_ERROR The request failed due to a device error.
+ The transfer status is returned in Status.
+ @retval EFI_NOT_FOUND The specified USB endpoint descriptor can not be found
**/
EFI_STATUS
EFIAPI
UsbClearEndpointHalt (
IN EFI_USB_IO_PROTOCOL *UsbIo,
- IN UINT8 EndpointNo,
+ IN UINT8 Endpoint,
OUT UINT32 *Status
)
{
@@ -528,9 +610,8 @@ UsbClearEndpointHalt ( EFI_USB_INTERFACE_DESCRIPTOR InterfaceDescriptor;
UINT8 Index;
- if (UsbIo == NULL) {
- return EFI_INVALID_PARAMETER;
- }
+ ASSERT (UsbIo != NULL);
+ ASSERT (Status != NULL);
ZeroMem (&EndpointDescriptor, sizeof (EFI_USB_ENDPOINT_DESCRIPTOR));
//
@@ -554,7 +635,7 @@ UsbClearEndpointHalt ( continue;
}
- if (EndpointDescriptor.EndpointAddress == EndpointNo) {
+ if (EndpointDescriptor.EndpointAddress == Endpoint) {
break;
}
}
|