diff options
author | yshang1 <yshang1@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-07-16 06:31:22 +0000 |
---|---|---|
committer | yshang1 <yshang1@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-07-16 06:31:22 +0000 |
commit | 373b5cf97cc650d2e81d4909ff5327b6ce0b6c26 (patch) | |
tree | 450d935834d97058e23e6f9fd524f2d8967f4f9f /MdePkg/Include/Library | |
parent | f824f71e4bf6f81d1ecbe652f3c313222c1e3c01 (diff) | |
download | edk2-platforms-373b5cf97cc650d2e81d4909ff5327b6ce0b6c26.tar.xz |
Code Scrub the common includes in MdePkg.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5493 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Library')
-rw-r--r-- | MdePkg/Include/Library/ScsiLib.h | 6 | ||||
-rw-r--r-- | MdePkg/Include/Library/UsbLib.h | 237 |
2 files changed, 240 insertions, 3 deletions
diff --git a/MdePkg/Include/Library/ScsiLib.h b/MdePkg/Include/Library/ScsiLib.h index 54fb281f1d..c7677fe7d4 100644 --- a/MdePkg/Include/Library/ScsiLib.h +++ b/MdePkg/Include/Library/ScsiLib.h @@ -61,6 +61,7 @@ **/
EFI_STATUS
+EFIAPI
ScsiTestUnitReadyCommand (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout,
@@ -103,6 +104,7 @@ ScsiTestUnitReadyCommand ( **/
EFI_STATUS
+EFIAPI
ScsiInquiryCommand (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout,
@@ -150,6 +152,7 @@ ScsiInquiryCommand ( **/
EFI_STATUS
+EFIAPI
ScsiModeSense10Command (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout,
@@ -202,6 +205,7 @@ ScsiModeSense10Command ( **/
EFI_STATUS
+EFIAPI
ScsiRequestSenseCommand (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout,
@@ -290,6 +294,7 @@ ScsiReadCapacityCommand ( **/
EFI_STATUS
+EFIAPI
ScsiRead10Command (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout,
@@ -337,6 +342,7 @@ ScsiRead10Command ( **/
EFI_STATUS
+EFIAPI
ScsiWrite10Command (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout,
diff --git a/MdePkg/Include/Library/UsbLib.h b/MdePkg/Include/Library/UsbLib.h index f3b56fbb80..6b78322c11 100644 --- a/MdePkg/Include/Library/UsbLib.h +++ b/MdePkg/Include/Library/UsbLib.h @@ -23,6 +23,18 @@ //
#define TIMEOUT_VALUE 3 * 1000
+/**
+ Get Hid Descriptor
+
+ @param UsbIo EFI_USB_IO_PROTOCOL
+ @param InterfaceNum Hid interface number
+ @param HidDescriptor Caller allocated buffer to store Usb hid descriptor if
+ successfully returned.
+
+ @return Status of getting HID descriptor through USB I/O
+ protocol's UsbControlTransfer().
+
+**/
EFI_STATUS
EFIAPI
UsbGetHidDescriptor (
@@ -31,6 +43,20 @@ UsbGetHidDescriptor ( OUT EFI_USB_HID_DESCRIPTOR *HidDescriptor
);
+
+/**
+ get Report Class descriptor
+
+ @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.
+
+ @return Status of getting Report Class descriptor through USB
+ I/O protocol's UsbControlTransfer().
+
+**/
EFI_STATUS
EFIAPI
UsbGetReportDescriptor (
@@ -40,6 +66,17 @@ UsbGetReportDescriptor ( OUT UINT8 *DescriptorBuffer
);
+/**
+ Get Hid Protocol Request
+
+ @param UsbIo EFI_USB_IO_PROTOCOL
+ @param Interface Which interface the caller wants to get protocol
+ @param Protocol Protocol value returned.
+
+ @return Status of getting Protocol Request through USB I/O
+ protocol's UsbControlTransfer().
+
+**/
EFI_STATUS
EFIAPI
UsbGetProtocolRequest (
@@ -48,6 +85,17 @@ UsbGetProtocolRequest ( IN UINT8 *Protocol
);
+/**
+ Set Hid Protocol Request
+
+ @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.
+
+ @return Status of setting Protocol Request through USB I/O
+ protocol's UsbControlTransfer().
+
+**/
EFI_STATUS
EFIAPI
UsbSetProtocolRequest (
@@ -56,6 +104,18 @@ UsbSetProtocolRequest ( IN UINT8 Protocol
);
+/**
+ Set Idel 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 Duration Idle rate the caller wants to set.
+
+ @return Status of setting IDLE Request through USB I/O
+ protocol's UsbControlTransfer().
+
+**/
EFI_STATUS
EFIAPI
UsbSetIdleRequest (
@@ -65,6 +125,18 @@ UsbSetIdleRequest ( IN UINT8 Duration
);
+/**
+ Get Idel request.
+
+ @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.
+
+ @return Status of getting IDLE Request through USB I/O
+ protocol's UsbControlTransfer().
+
+**/
EFI_STATUS
EFIAPI
UsbGetIdleRequest (
@@ -74,6 +146,20 @@ UsbGetIdleRequest ( OUT UINT8 *Duration
);
+/**
+ 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 Report Descriptor buffer.
+
+ @return Status of setting Report Request through USB I/O
+ protocol's UsbControlTransfer().
+
+**/
EFI_STATUS
EFIAPI
UsbSetReportRequest (
@@ -85,6 +171,20 @@ UsbSetReportRequest ( IN UINT8 *Report
);
+/**
+ 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().
+
+**/
EFI_STATUS
EFIAPI
UsbGetReportRequest (
@@ -96,6 +196,21 @@ UsbGetReportRequest ( IN UINT8 *Report
);
+/**
+ 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
+
+**/
EFI_STATUS
UsbGetDescriptor (
IN EFI_USB_IO_PROTOCOL *UsbIo,
@@ -106,6 +221,21 @@ UsbGetDescriptor ( OUT UINT32 *Status
);
+/**
+ 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
+
+**/
EFI_STATUS
EFIAPI
UsbSetDescriptor (
@@ -117,6 +247,19 @@ UsbSetDescriptor ( OUT UINT32 *Status
);
+/**
+ Usb Get Device Interface
+
+ @param UsbIo EFI_USB_IO_PROTOCOL
+ @param Index Interface index value
+ @param AltSetting Alternate setting
+ @param Status Trasnsfer status
+
+ @retval EFI_INVALID_PARAMETER Parameter is error
+ @retval EFI_SUCCESS Success
+ @retval EFI_TIMEOUT Device has no response
+
+**/
EFI_STATUS
EFIAPI
UsbGetInterface (
@@ -126,6 +269,19 @@ UsbGetInterface ( OUT UINT32 *Status
);
+/**
+ Usb Set Device Interface
+
+ @param UsbIo EFI_USB_IO_PROTOCOL
+ @param InterfaceNo Interface Number
+ @param AltSetting Alternate setting
+ @param Status Trasnsfer status
+
+ @retval EFI_INVALID_PARAMETER Parameter is error
+ @retval EFI_SUCCESS Success
+ @retval EFI_TIMEOUT Device has no response
+
+**/
EFI_STATUS
EFIAPI
UsbSetInterface (
@@ -135,6 +291,18 @@ UsbSetInterface ( OUT UINT32 *Status
);
+/**
+ Usb Get Device Configuration
+
+ @param UsbIo EFI_USB_IO_PROTOCOL
+ @param ConfigValue Config Value
+ @param Status Transfer Status
+
+ @retval EFI_INVALID_PARAMETER Parameter is error
+ @retval EFI_SUCCESS Success
+ @retval EFI_TIMEOUT Device has no response
+
+**/
EFI_STATUS
EFIAPI
UsbGetConfiguration (
@@ -143,6 +311,18 @@ UsbGetConfiguration ( OUT UINT32 *Status
);
+/**
+ Usb Set Device Configuration
+
+ @param UsbIo EFI_USB_IO_PROTOCOL
+ @param Value Configuration Value to set
+ @param Status Transfer status
+
+ @retval EFI_INVALID_PARAMETER Parameter is error
+ @retval EFI_SUCCESS Success
+ @retval EFI_TIMEOUT Device has no response
+
+**/
EFI_STATUS
EFIAPI
UsbSetConfiguration (
@@ -151,6 +331,20 @@ UsbSetConfiguration ( OUT UINT32 *Status
);
+/**
+ 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
+
+**/
EFI_STATUS
EFIAPI
UsbSetFeature (
@@ -161,6 +355,20 @@ UsbSetFeature ( OUT UINT32 *Status
);
+/**
+ 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
+
+**/
EFI_STATUS
EFIAPI
UsbClearFeature (
@@ -171,6 +379,20 @@ UsbClearFeature ( OUT UINT32 *Status
);
+/**
+ 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
+
+**/
EFI_STATUS
EFIAPI
UsbGetStatus (
@@ -181,9 +403,18 @@ UsbGetStatus ( OUT UINT32 *Status
);
-//
-// Clear endpoint stall
-//
+/**
+ Clear endpoint stall
+
+ @param UsbIo EFI_USB_IO_PROTOCOL
+ @param EndpointNo Endpoint Number
+ @param Status Transfer Status
+
+ @retval EFI_NOT_FOUND Can't find the Endpoint
+ @retval EFI_DEVICE_ERROR Hardware error
+ @retval EFI_SUCCESS Success
+
+**/
EFI_STATUS
EFIAPI
UsbClearEndpointHalt (
|