From 373b5cf97cc650d2e81d4909ff5327b6ce0b6c26 Mon Sep 17 00:00:00 2001 From: yshang1 Date: Wed, 16 Jul 2008 06:31:22 +0000 Subject: [PATCH] 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 --- MdePkg/Include/IndustryStandard/Atapi.h | 4 +- MdePkg/Include/IndustryStandard/Pci22.h | 4 +- MdePkg/Include/IndustryStandard/Pci30.h | 4 +- .../SerialPortConsoleRedirectionTable.h | 4 - MdePkg/Include/IndustryStandard/Tpm12.h | 4 +- .../IndustryStandard/WatchdogActionTable.h | 2 +- MdePkg/Include/Library/ScsiLib.h | 6 + MdePkg/Include/Library/UsbLib.h | 237 +++++++++++++++++- MdePkg/Include/Pi/PiDxeCis.h | 9 +- MdePkg/Include/Pi/PiPeiCis.h | 10 +- MdePkg/Library/PeiPiLib/PeiPiLib.c | 2 - .../PeiServicesTablePointer.c | 8 +- .../PeiServicesTablePointer.c | 2 +- .../ApplicationEntryPoint.c | 2 - .../UefiDriverEntryPoint/DriverEntryPoint.c | 5 +- MdePkg/Library/UefiScsiLib/UefiScsiLib.c | 8 + MdePkg/Library/UefiUsbLib/Hid.c | 57 +++-- 17 files changed, 303 insertions(+), 65 deletions(-) diff --git a/MdePkg/Include/IndustryStandard/Atapi.h b/MdePkg/Include/IndustryStandard/Atapi.h index 8fe065c5e0..ff6cc593bb 100644 --- a/MdePkg/Include/IndustryStandard/Atapi.h +++ b/MdePkg/Include/IndustryStandard/Atapi.h @@ -18,7 +18,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #ifndef _ATAPI_H #define _ATAPI_H -#pragma pack(push, 1) +#pragma pack(1) // // ATA_IDENTIFY_DATA is defined in ATA-5 @@ -369,7 +369,7 @@ typedef union { ATAPI_READ_FORMAT_CAP_CMD ReadFormatCapacity; } ATAPI_PACKET_COMMAND; -#pragma pack(pop) +#pragma pack() #define ATAPI_MAX_DMA_EXT_CMD_SECTORS 0x10000 diff --git a/MdePkg/Include/IndustryStandard/Pci22.h b/MdePkg/Include/IndustryStandard/Pci22.h index 3007075282..b1c66e824e 100644 --- a/MdePkg/Include/IndustryStandard/Pci22.h +++ b/MdePkg/Include/IndustryStandard/Pci22.h @@ -27,7 +27,7 @@ // #define PCI_VGA_PALETTE_SNOOP_DISABLED 0x20 -#pragma pack(push, 1) +#pragma pack(1) typedef struct { UINT16 VendorId; UINT16 DeviceId; @@ -569,6 +569,6 @@ typedef union { EFI_LEGACY_EXPANSION_ROM_HEADER *PcAt; } EFI_PCI_ROM_HEADER; -#pragma pack(pop) +#pragma pack() #endif diff --git a/MdePkg/Include/IndustryStandard/Pci30.h b/MdePkg/Include/IndustryStandard/Pci30.h index c4a1b64ace..0cd37c44bd 100644 --- a/MdePkg/Include/IndustryStandard/Pci30.h +++ b/MdePkg/Include/IndustryStandard/Pci30.h @@ -18,7 +18,7 @@ #define PCI_CLASS_MASS_STORAGE_SATADPA 0x06 #define PCI_CLASS_MASS_STORAGE_AHCI PCI_CLASS_MASS_STORAGE_SATADPA -#pragma pack(push, 1) +#pragma pack(1) typedef struct { UINT32 Signature; // "PCIR" @@ -37,7 +37,7 @@ typedef struct { UINT16 DMTFCLPEntryPointOffset; } PCI_3_0_DATA_STRUCTURE; -#pragma pack(pop) +#pragma pack() #include diff --git a/MdePkg/Include/IndustryStandard/SerialPortConsoleRedirectionTable.h b/MdePkg/Include/IndustryStandard/SerialPortConsoleRedirectionTable.h index 6582a859b4..381bb8f7a6 100644 --- a/MdePkg/Include/IndustryStandard/SerialPortConsoleRedirectionTable.h +++ b/MdePkg/Include/IndustryStandard/SerialPortConsoleRedirectionTable.h @@ -21,9 +21,7 @@ // // Ensure proper structure formats // -#ifdef _MSC_EXTENSIONS #pragma pack(1) -#endif // // SPCR Revision (defined in spec) @@ -57,9 +55,7 @@ typedef struct { UINT32 Reserved2; } EFI_ACPI_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE; -#ifdef _MSC_EXTENSIONS #pragma pack() -#endif // // SPCR Definitions diff --git a/MdePkg/Include/IndustryStandard/Tpm12.h b/MdePkg/Include/IndustryStandard/Tpm12.h index f16a952107..11013e7876 100644 --- a/MdePkg/Include/IndustryStandard/Tpm12.h +++ b/MdePkg/Include/IndustryStandard/Tpm12.h @@ -406,13 +406,13 @@ typedef struct tdTPM_KEY_HANDLE_LIST { // // Part 2, section 5.10: TPM_KEY_FLAGS // -enum tdTPM_KEY_FLAGS { +typedef enum tdTPM_KEY_FLAGS { redirection = 0x00000001, migratable = 0x00000002, isVolatile = 0x00000004, pcrIgnoredOnRead = 0x00000008, migrateAuthority = 0x00000010 -}; +} TPM_KEY_FLAGS; // // Part 2, section 5.11: TPM_CHANGEAUTH_VALIDATE diff --git a/MdePkg/Include/IndustryStandard/WatchdogActionTable.h b/MdePkg/Include/IndustryStandard/WatchdogActionTable.h index c6ee91e778..e429c9a69e 100644 --- a/MdePkg/Include/IndustryStandard/WatchdogActionTable.h +++ b/MdePkg/Include/IndustryStandard/WatchdogActionTable.h @@ -56,7 +56,7 @@ typedef struct { // // WDAT Revision (defined in spec) // -#define EFI_ACPI_WATCHDOG_ACTION_1_0_TABLE_REVISION 0x01 +#define EFI_ACPI_WATCHDOG_ACTION_1_0_TABLE_REVISION 0x01 // // WDAT 1.0 Flags 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 ( diff --git a/MdePkg/Include/Pi/PiDxeCis.h b/MdePkg/Include/Pi/PiDxeCis.h index 6155c74904..cfcefb9857 100644 --- a/MdePkg/Include/Pi/PiDxeCis.h +++ b/MdePkg/Include/Pi/PiDxeCis.h @@ -416,7 +416,7 @@ EFI_STATUS /** Loads and executed DXE drivers from firmware volumes. - @return Status code + @return Status of dispatching and execution DXE drivers. **/ typedef @@ -432,7 +432,7 @@ EFI_STATUS @param FirmwareVolumeHandle The handle of the firmware volume that contains the file specified by FileName. @param DriverName A pointer to the name of the file in a firmware volume. - @return Status code + @return Status of clearing SOR. **/ typedef @@ -449,7 +449,8 @@ EFI_STATUS @param FirmwareVolumeHandle The handle of the firmware volume that contains the file specified by FileName. @param DriverName A pointer to the name of the file in a firmware volume. - @return Status code + @return Status of promoting FFS from untrusted to trusted + state. **/ typedef @@ -467,7 +468,7 @@ EFI_STATUS @param Size The size, in bytes, of the firmware volume. @param FirmwareVolumeHandle On output, a pointer to the created handle. - @return Status code + @return Status of processing FV. **/ typedef diff --git a/MdePkg/Include/Pi/PiPeiCis.h b/MdePkg/Include/Pi/PiPeiCis.h index 50e3b09d0e..89bc24220d 100644 --- a/MdePkg/Include/Pi/PiPeiCis.h +++ b/MdePkg/Include/Pi/PiPeiCis.h @@ -52,7 +52,8 @@ typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR; @param FileHandle Pointer to the FFS file header. @param PeiServices Describes the list of possible PEI Services. - @return Status code + @retval EFI_SUCCESS The PEI completed successfully. + @retval !EFI_SUCCESS There is error in PEIM. **/ typedef @@ -69,7 +70,7 @@ EFI_STATUS @param NotifyDescriptor Address of the notification descriptor data structure. @param Ppi Address of the PPI that was installed. - @return Status code + @return Status of the notification. **/ typedef EFI_STATUS @@ -427,8 +428,6 @@ EFI_STATUS @param Source Pointer to the source buffer of the memory copy @param Length Number of bytes to copy from Source to Destination. - @return None - **/ typedef VOID @@ -445,8 +444,6 @@ VOID @param Size Number of bytes in Buffer to fill. @param Value Value to fill Buffer with - @return None - **/ typedef VOID @@ -528,7 +525,6 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER VolumeHandle or FileHandle or FileName was NULL. - **/ typedef EFI_STATUS diff --git a/MdePkg/Library/PeiPiLib/PeiPiLib.c b/MdePkg/Library/PeiPiLib/PeiPiLib.c index 20b599e507..a76a29bf3a 100644 --- a/MdePkg/Library/PeiPiLib/PeiPiLib.c +++ b/MdePkg/Library/PeiPiLib/PeiPiLib.c @@ -50,8 +50,6 @@ CONST EFI_PEI_FIRMWARE_VOLUME_INFO_PPI mFvInfoPpiTemplate = { parent firmware volume name and firmware volume file. If it did not originally come from a firmware file, these should be NULL - @retval VOID - **/ VOID EFIAPI diff --git a/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c b/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c index 42f4e1b637..97abaa4aeb 100644 --- a/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c +++ b/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c @@ -23,7 +23,8 @@ base addres is used to save the EFI_PEI_SERVICES**. For x64, the eight-bytes field immediately prior to new IDT base addres is used to save the EFI_PEI_SERVICES** - @retval The pointer to PeiServices. + + @return The pointer to PeiServices. **/ EFI_PEI_SERVICES ** @@ -43,14 +44,15 @@ GetPeiServicesTablePointer ( /** - The function returns the pointer to PeiServicee following + The function sets the pointer to PeiServicee following PI1.0. For IA32, the four-bytes field immediately prior to new IDT base addres is used to save the EFI_PEI_SERVICES**. For x64, the eight-bytes field immediately prior to new IDT base addres is used to save the EFI_PEI_SERVICES** - @retval The pointer to PeiServices. + + @param PeiServicesTablePointer The pointer to PeiServices. **/ VOID diff --git a/MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c b/MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c index 3680fbc78a..7c1f7abfa2 100644 --- a/MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c +++ b/MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c @@ -23,7 +23,7 @@ The function returns the pointer to PeiServices. It will ASSERT() if the pointer to PeiServices is NULL. - @retval The pointer to PeiServices. + @return The pointer to PeiServices. **/ EFI_PEI_SERVICES ** diff --git a/MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c b/MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c index 3f45977aeb..c5abc85e70 100644 --- a/MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c +++ b/MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c @@ -72,8 +72,6 @@ _ModuleEntryPoint ( @param Status Status returned by the application that is exiting. - @retval VOID - **/ VOID EFIAPI diff --git a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c index 05f157b5e5..68410ba3c9 100644 --- a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c +++ b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c @@ -28,12 +28,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. protocols produced and deallocates pool used by the driver. Called by the core when unloading the driver. - @param ImageHandle + @param ImageHandle ImageHandle of the loaded driver. - @retval EFI_SUCCESS + @return Status returned by all unload(). **/ -STATIC EFI_STATUS EFIAPI _DriverUnloadHandler ( diff --git a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c index 89bb2f449b..ac032cd4d5 100644 --- a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c +++ b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c @@ -52,6 +52,7 @@ **/ EFI_STATUS +EFIAPI ScsiTestUnitReadyCommand ( IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN UINT64 Timeout, @@ -140,6 +141,7 @@ ScsiTestUnitReadyCommand ( **/ EFI_STATUS +EFIAPI ScsiInquiryCommand ( IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN UINT64 Timeout, @@ -241,6 +243,7 @@ ScsiInquiryCommand ( **/ EFI_STATUS +EFIAPI ScsiModeSense10Command ( IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN UINT64 Timeout, @@ -337,6 +340,7 @@ ScsiModeSense10Command ( **/ EFI_STATUS +EFIAPI ScsiRequestSenseCommand ( IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN UINT64 Timeout, @@ -426,6 +430,7 @@ ScsiRequestSenseCommand ( **/ EFI_STATUS +EFIAPI ScsiReadCapacityCommand ( IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN UINT64 Timeout, @@ -528,6 +533,7 @@ ScsiReadCapacityCommand ( **/ EFI_STATUS +EFIAPI ScsiRead10Command ( IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN UINT64 Timeout, @@ -629,6 +635,7 @@ ScsiRead10Command ( **/ EFI_STATUS +EFIAPI ScsiWrite10Command ( IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN UINT64 Timeout, @@ -694,3 +701,4 @@ ScsiWrite10Command ( return Status; } + diff --git a/MdePkg/Library/UefiUsbLib/Hid.c b/MdePkg/Library/UefiUsbLib/Hid.c index aeab8f11aa..3a62d523f1 100644 --- a/MdePkg/Library/UefiUsbLib/Hid.c +++ b/MdePkg/Library/UefiUsbLib/Hid.c @@ -24,12 +24,12 @@ @param HidDescriptor Caller allocated buffer to store Usb hid descriptor if successfully returned. - @return EFI_SUCCESS - @return EFI_DEVICE_ERROR - @return EFI_TIMEOUT + @return Status of getting HID descriptor through USB I/O + protocol's UsbControlTransfer(). **/ EFI_STATUS +EFIAPI UsbGetHidDescriptor ( IN EFI_USB_IO_PROTOCOL *UsbIo, IN UINT8 InterfaceNum, @@ -73,12 +73,12 @@ UsbGetHidDescriptor ( @param DescriptorBuffer Caller allocated buffer to store Usb report descriptor if successfully returned. - @return EFI_SUCCESS - @return EFI_DEVICE_ERROR - @return EFI_TIMEOUT + @return Status of getting Report Class descriptor through USB + I/O protocol's UsbControlTransfer(). **/ EFI_STATUS +EFIAPI UsbGetReportDescriptor ( IN EFI_USB_IO_PROTOCOL *UsbIo, IN UINT8 InterfaceNum, @@ -117,18 +117,18 @@ UsbGetReportDescriptor ( } /** - Get Hid Protocol Request. + Get Hid Protocol Request @param UsbIo EFI_USB_IO_PROTOCOL. - @param Interface Which interface the caller wants to get protocol. + @param Interface Which interface the caller wants to get protocol @param Protocol Protocol value returned. - @return EFI_SUCCESS - @return EFI_DEVICE_ERROR - @return EFI_TIMEOUT + @return Status of getting Protocol Request through USB I/O + protocol's UsbControlTransfer(). **/ EFI_STATUS +EFIAPI UsbGetProtocolRequest ( IN EFI_USB_IO_PROTOCOL *UsbIo, IN UINT8 Interface, @@ -168,19 +168,21 @@ UsbGetProtocolRequest ( } + /** Set Hid Protocol Request. @param UsbIo EFI_USB_IO_PROTOCOL. - @param Interface Which interface the caller wants to set protocol. + @param Interface Which interface the caller wants to + set protocol. @param Protocol Protocol value the caller wants to set. - @return EFI_SUCCESS - @return EFI_DEVICE_ERROR - @return EFI_TIMEOUT + @return Status of setting Protocol Request through USB I/O + protocol's UsbControlTransfer(). **/ EFI_STATUS +EFIAPI UsbSetProtocolRequest ( IN EFI_USB_IO_PROTOCOL *UsbIo, IN UINT8 Interface, @@ -227,12 +229,12 @@ UsbSetProtocolRequest ( @param ReportId Which report the caller wants to set. @param Duration Idle rate the caller wants to set. - @return EFI_SUCCESS - @return EFI_DEVICE_ERROR - @return EFI_TIMEOUT + @return Status of setting IDLE Request through USB I/O + protocol's UsbControlTransfer(). **/ EFI_STATUS +EFIAPI UsbSetIdleRequest ( IN EFI_USB_IO_PROTOCOL *UsbIo, IN UINT8 Interface, @@ -280,12 +282,12 @@ UsbSetIdleRequest ( @param ReportId Which report the caller wants to get. @param Duration Idle rate the caller wants to get. - @return EFI_SUCCESS - @return EFI_DEVICE_ERROR - @return EFI_TIMEOUT + @return Status of getting IDLE Request through USB I/O + protocol's UsbControlTransfer(). **/ EFI_STATUS +EFIAPI UsbGetIdleRequest ( IN EFI_USB_IO_PROTOCOL *UsbIo, IN UINT8 Interface, @@ -326,6 +328,7 @@ UsbGetIdleRequest ( } + /** Hid Set Report request. @@ -336,12 +339,12 @@ UsbGetIdleRequest ( @param ReportLen Length of report descriptor. @param Report Report Descriptor buffer. - @return EFI_SUCCESS - @return EFI_DEVICE_ERROR - @return EFI_TIMEOUT + @return Status of setting Report Request through USB I/O + protocol's UsbControlTransfer(). **/ EFI_STATUS +EFIAPI UsbSetReportRequest ( IN EFI_USB_IO_PROTOCOL *UsbIo, IN UINT8 Interface, @@ -394,12 +397,12 @@ UsbSetReportRequest ( @param ReportLen Length of report descriptor. @param Report Caller allocated buffer to store Report Descriptor. - @return EFI_SUCCESS - @return EFI_DEVICE_ERROR - @return EFI_TIMEOUT + @return Status of getting Report Request through USB I/O + protocol's UsbControlTransfer(). **/ EFI_STATUS +EFIAPI UsbGetReportRequest ( IN EFI_USB_IO_PROTOCOL *UsbIo, IN UINT8 Interface, -- 2.39.2