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

diff --git a/MdePkg/Include/IndustryStandard/Atapi.h b/MdePkg/Include/IndustryStandard/Atapi.h
index 8fe065c5e0e7efa00344fbf198985d9750941b36..ff6cc593bb9a88fa65efbb941f5511eecc4218ab 100644 (file)
--- 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\r
 #define _ATAPI_H\r
 \r
-#pragma pack(push, 1)\r
+#pragma pack(1)\r
 \r
 //\r
 // ATA_IDENTIFY_DATA is defined in ATA-5\r
@@ -369,7 +369,7 @@ typedef union {
   ATAPI_READ_FORMAT_CAP_CMD ReadFormatCapacity;\r
 } ATAPI_PACKET_COMMAND;\r
 \r
-#pragma pack(pop)\r
+#pragma pack()\r
 \r
 \r
 #define ATAPI_MAX_DMA_EXT_CMD_SECTORS 0x10000\r

diff --git a/MdePkg/Include/IndustryStandard/Pci22.h b/MdePkg/Include/IndustryStandard/Pci22.h
index 30070752821f7163a54e2bd237c5692bddf4a845..b1c66e824e2b50ef00390f0ad71a5a955be8e8c8 100644 (file)
--- a/MdePkg/Include/IndustryStandard/Pci22.h
+++ b/MdePkg/Include/IndustryStandard/Pci22.h
@@ -27,7 +27,7 @@
 //\r
 #define PCI_VGA_PALETTE_SNOOP_DISABLED  0x20\r
 \r
-#pragma pack(push, 1)\r
+#pragma pack(1)\r
 typedef struct {\r
   UINT16  VendorId;\r
   UINT16  DeviceId;\r
@@ -569,6 +569,6 @@ typedef union {
   EFI_LEGACY_EXPANSION_ROM_HEADER *PcAt;\r
 } EFI_PCI_ROM_HEADER;\r
 \r
-#pragma pack(pop)\r
+#pragma pack()\r
 \r
 #endif\r

diff --git a/MdePkg/Include/IndustryStandard/Pci30.h b/MdePkg/Include/IndustryStandard/Pci30.h
index c4a1b64ace7ce5b4aff0d287469399cf5716ecff..0cd37c44bdd7c595237501de570d60e3aa812570 100644 (file)
--- a/MdePkg/Include/IndustryStandard/Pci30.h
+++ b/MdePkg/Include/IndustryStandard/Pci30.h
@@ -18,7 +18,7 @@
 #define PCI_CLASS_MASS_STORAGE_SATADPA   0x06\r
 #define PCI_CLASS_MASS_STORAGE_AHCI      PCI_CLASS_MASS_STORAGE_SATADPA\r
 \r
-#pragma pack(push, 1)\r
+#pragma pack(1)\r
 \r
 typedef struct {\r
   UINT32  Signature;    // "PCIR"\r
@@ -37,7 +37,7 @@ typedef struct {
   UINT16  DMTFCLPEntryPointOffset;\r
 } PCI_3_0_DATA_STRUCTURE;\r
 \r
-#pragma pack(pop)\r
+#pragma pack()\r
 \r
 \r
 #include <IndustryStandard/Pci23.h>\r

diff --git a/MdePkg/Include/IndustryStandard/SerialPortConsoleRedirectionTable.h b/MdePkg/Include/IndustryStandard/SerialPortConsoleRedirectionTable.h
index 6582a859b45fc69449ee6b2610c5ee1a87329114..381bb8f7a6bbf4c12df1a7256e90ec610c67fdfd 100644 (file)
--- a/MdePkg/Include/IndustryStandard/SerialPortConsoleRedirectionTable.h
+++ b/MdePkg/Include/IndustryStandard/SerialPortConsoleRedirectionTable.h
@@ -21,9 +21,7 @@
 //\r
 // Ensure proper structure formats\r
 //\r
-#ifdef _MSC_EXTENSIONS\r
 #pragma pack(1)\r
-#endif\r
 \r
 //\r
 // SPCR Revision (defined in spec)\r
@@ -57,9 +55,7 @@ typedef struct {
   UINT32                                  Reserved2;\r
 } EFI_ACPI_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE;\r
 \r
-#ifdef _MSC_EXTENSIONS\r
 #pragma pack()\r
-#endif\r
 \r
 //\r
 // SPCR Definitions\r

diff --git a/MdePkg/Include/IndustryStandard/Tpm12.h b/MdePkg/Include/IndustryStandard/Tpm12.h
index f16a952107cdf2691f875e4d81150191e1997081..11013e7876b9649114a06bf8166fc28ea149e5de 100644 (file)
--- a/MdePkg/Include/IndustryStandard/Tpm12.h
+++ b/MdePkg/Include/IndustryStandard/Tpm12.h
@@ -406,13 +406,13 @@ typedef struct tdTPM_KEY_HANDLE_LIST {
 //\r
 // Part 2, section 5.10: TPM_KEY_FLAGS\r
 //\r
-enum tdTPM_KEY_FLAGS {\r
+typedef enum tdTPM_KEY_FLAGS {\r
   redirection                       = 0x00000001,\r
   migratable                        = 0x00000002,\r
   isVolatile                        = 0x00000004,\r
   pcrIgnoredOnRead                  = 0x00000008,\r
   migrateAuthority                  = 0x00000010\r
-};\r
+} TPM_KEY_FLAGS;\r
 \r
 //\r
 // Part 2, section 5.11: TPM_CHANGEAUTH_VALIDATE\r

diff --git a/MdePkg/Include/IndustryStandard/WatchdogActionTable.h b/MdePkg/Include/IndustryStandard/WatchdogActionTable.h
index c6ee91e778328c77a7fb4b487ecaa28021f09fef..e429c9a69ee0458f80aa6085a9d58b7a384005cf 100644 (file)
--- a/MdePkg/Include/IndustryStandard/WatchdogActionTable.h
+++ b/MdePkg/Include/IndustryStandard/WatchdogActionTable.h
@@ -56,7 +56,7 @@ typedef struct {
 //\r
 // WDAT Revision (defined in spec)\r
 //\r
-#define EFI_ACPI_WATCHDOG_ACTION_1_0_TABLE_REVISION  0x01\r
+#define EFI_ACPI_WATCHDOG_ACTION_1_0_TABLE_REVISION       0x01\r
 \r
 //\r
 // WDAT 1.0 Flags\r

diff --git a/MdePkg/Include/Library/ScsiLib.h b/MdePkg/Include/Library/ScsiLib.h
index 54fb281f1d4667fca2b169c137a25f6d5dd21a76..c7677fe7d43678624fb8eceb15002cd96616bbe6 100644 (file)
--- a/MdePkg/Include/Library/ScsiLib.h
+++ b/MdePkg/Include/Library/ScsiLib.h
@@ -61,6 +61,7 @@
 
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 ScsiTestUnitReadyCommand (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
   IN  UINT64                Timeout,\r
@@ -103,6 +104,7 @@ ScsiTestUnitReadyCommand (
 
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 ScsiInquiryCommand (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
   IN  UINT64                Timeout,\r
@@ -150,6 +152,7 @@ ScsiInquiryCommand (
 
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 ScsiModeSense10Command (\r
   IN  EFI_SCSI_IO_PROTOCOL    *ScsiIo,\r
   IN  UINT64                  Timeout,\r
@@ -202,6 +205,7 @@ ScsiModeSense10Command (
 
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 ScsiRequestSenseCommand (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
   IN  UINT64                Timeout,\r
@@ -290,6 +294,7 @@ ScsiReadCapacityCommand (
 
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 ScsiRead10Command (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
   IN  UINT64                Timeout,\r
@@ -337,6 +342,7 @@ ScsiRead10Command (
 
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 ScsiWrite10Command (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
   IN  UINT64                Timeout,\r

diff --git a/MdePkg/Include/Library/UsbLib.h b/MdePkg/Include/Library/UsbLib.h
index f3b56fbb80f4ebf551abb44281dbda27028458cc..6b78322c11259c728024b74b7aea5663874da29a 100644 (file)
--- a/MdePkg/Include/Library/UsbLib.h
+++ b/MdePkg/Include/Library/UsbLib.h
@@ -23,6 +23,18 @@
 //\r
 #define TIMEOUT_VALUE 3 * 1000\r
 \r
+/**\r
+  Get Hid Descriptor\r
+\r
+  @param  UsbIo             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
@@ -31,6 +43,20 @@ UsbGetHidDescriptor (
   OUT EFI_USB_HID_DESCRIPTOR     *HidDescriptor\r
   );\r
 \r
+\r
+/**\r
+  get Report Class descriptor\r
+\r
+  @param  UsbIo             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
@@ -40,6 +66,17 @@ UsbGetReportDescriptor (
   OUT UINT8                   *DescriptorBuffer\r
   );\r
 \r
+/**\r
+  Get Hid Protocol Request\r
+\r
+  @param  UsbIo             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
@@ -48,6 +85,17 @@ UsbGetProtocolRequest (
   IN UINT8                   *Protocol\r
   );\r
 \r
+/**\r
+  Set Hid Protocol Request\r
+\r
+  @param  UsbIo             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
@@ -56,6 +104,18 @@ UsbSetProtocolRequest (
   IN UINT8                   Protocol\r
   );\r
 \r
+/**\r
+  Set Idel request.\r
+\r
+  @param  UsbIo             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
@@ -65,6 +125,18 @@ UsbSetIdleRequest (
   IN UINT8                   Duration\r
   );\r
 \r
+/**\r
+  Get Idel request.\r
+\r
+  @param  UsbIo             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
@@ -74,6 +146,20 @@ UsbGetIdleRequest (
   OUT UINT8                   *Duration\r
   );\r
 \r
+/**\r
+  Hid Set Report request.\r
+\r
+  @param  UsbIo             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
@@ -85,6 +171,20 @@ UsbSetReportRequest (
   IN UINT8                   *Report\r
   );\r
 \r
+/**\r
+  Hid Set Report request.\r
+\r
+  @param  UsbIo             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
@@ -96,6 +196,21 @@ UsbGetReportRequest (
   IN UINT8                   *Report\r
   );\r
 \r
+/**\r
+  Usb Get Descriptor\r
+\r
+  @param  UsbIo                  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
 UsbGetDescriptor (\r
   IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
@@ -106,6 +221,21 @@ UsbGetDescriptor (
   OUT UINT32                  *Status\r
   );\r
 \r
+/**\r
+  Usb Set Descriptor\r
+\r
+  @param  UsbIo                  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
@@ -117,6 +247,19 @@ UsbSetDescriptor (
   OUT UINT32                  *Status\r
   );\r
 \r
+/**\r
+  Usb Get Device Interface\r
+\r
+  @param  UsbIo                  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
@@ -126,6 +269,19 @@ UsbGetInterface (
   OUT UINT32                  *Status\r
   );\r
 \r
+/**\r
+  Usb Set Device Interface\r
+\r
+  @param  UsbIo                  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
@@ -135,6 +291,18 @@ UsbSetInterface (
   OUT UINT32                  *Status\r
   );\r
 \r
+/**\r
+  Usb Get Device Configuration\r
+\r
+  @param  UsbIo                  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
@@ -143,6 +311,18 @@ UsbGetConfiguration (
   OUT UINT32                  *Status\r
   );\r
 \r
+/**\r
+  Usb Set Device Configuration\r
+\r
+  @param  UsbIo                  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
@@ -151,6 +331,20 @@ UsbSetConfiguration (
   OUT UINT32                  *Status\r
   );\r
 \r
+/**\r
+  Usb Set Device Feature\r
+\r
+  @param  UsbIo                  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
@@ -161,6 +355,20 @@ UsbSetFeature (
   OUT UINT32                  *Status\r
   );\r
 \r
+/**\r
+  Usb Clear Device Feature\r
+\r
+  @param  UsbIo                  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
@@ -171,6 +379,20 @@ UsbClearFeature (
   OUT UINT32                  *Status\r
   );\r
 \r
+/**\r
+  Usb Get Device Status\r
+\r
+  @param  UsbIo                  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
@@ -181,9 +403,18 @@ UsbGetStatus (
   OUT UINT32                  *Status\r
   );\r
 \r
-//\r
-// Clear endpoint stall\r
-//\r
+/**\r
+  Clear endpoint stall\r
+\r
+  @param  UsbIo                  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

diff --git a/MdePkg/Include/Pi/PiDxeCis.h b/MdePkg/Include/Pi/PiDxeCis.h
index 6155c749041ca769c78271637edf50c18c802d9e..cfcefb9857db106e1646f714458b57d7a3e52453 100644 (file)
--- a/MdePkg/Include/Pi/PiDxeCis.h
+++ b/MdePkg/Include/Pi/PiDxeCis.h
@@ -416,7 +416,7 @@ EFI_STATUS
 /**\r
   Loads and executed DXE drivers from firmware volumes.\r
 \r
-  @return Status code\r
+  @return Status of dispatching and execution DXE drivers.\r
 \r
 **/\r
 typedef\r
@@ -432,7 +432,7 @@ EFI_STATUS
   @param  FirmwareVolumeHandle The handle of the firmware volume that contains the file specified by FileName.\r
   @param  DriverName           A pointer to the name of the file in a firmware volume.\r
 \r
-  @return Status code\r
+  @return Status of clearing SOR.\r
 \r
 **/\r
 typedef\r
@@ -449,7 +449,8 @@ EFI_STATUS
   @param  FirmwareVolumeHandle The handle of the firmware volume that contains the file specified by FileName.\r
   @param  DriverName           A pointer to the name of the file in a firmware volume.\r
 \r
-  @return Status code\r
+  @return Status of promoting FFS from untrusted to trusted\r
+          state.\r
 \r
 **/\r
 typedef\r
@@ -467,7 +468,7 @@ EFI_STATUS
   @param  Size                 The size, in bytes, of the firmware volume.\r
   @param  FirmwareVolumeHandle On output, a pointer to the created handle.\r
 \r
-  @return Status code\r
+  @return Status of processing FV.\r
 \r
 **/\r
 typedef\r

diff --git a/MdePkg/Include/Pi/PiPeiCis.h b/MdePkg/Include/Pi/PiPeiCis.h
index 50e3b09d0ec460657cde5dfe8b5d79e75c3a6d90..89bc24220d4a47f0a38d6d5ce9900d78d89f8d1a 100644 (file)
--- 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.\r
   @param  PeiServices      Describes the list of possible PEI Services.\r
 \r
-  @return Status code\r
+  @retval EFI_SUCCESS      The PEI completed successfully.\r
+  @retval !EFI_SUCCESS     There is error in PEIM.\r
 \r
 **/\r
 typedef\r
@@ -69,7 +70,7 @@ EFI_STATUS
   @param  NotifyDescriptor Address of the notification descriptor data structure.\r
   @param  Ppi              Address of the PPI that was installed.\r
 \r
-  @return Status code\r
+  @return Status of the notification.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -427,8 +428,6 @@ EFI_STATUS
   @param  Source           Pointer to the source buffer of the memory copy\r
   @param  Length           Number of bytes to copy from Source to Destination.\r
 \r
-  @return None\r
-\r
 **/\r
 typedef\r
 VOID\r
@@ -445,8 +444,6 @@ VOID
   @param  Size             Number of bytes in Buffer to fill.\r
   @param  Value            Value to fill Buffer with\r
 \r
-  @return None\r
-\r
 **/\r
 typedef\r
 VOID\r
@@ -528,7 +525,6 @@ EFI_STATUS
   @retval EFI_INVALID_PARAMETER   VolumeHandle or FileHandle or\r
                                   FileName was NULL.\r
 \r
-\r
 **/\r
 typedef\r
 EFI_STATUS\r

diff --git a/MdePkg/Library/PeiPiLib/PeiPiLib.c b/MdePkg/Library/PeiPiLib/PeiPiLib.c
index 20b599e50764c948c6c70f5b9f5d957b841d2df2..a76a29bf3a16ed2eb8f3699265514ee73176e645 100644 (file)
--- 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\r
                                           from a firmware file, these should be NULL\r
   \r
-    @retval  VOID\r
-  \r
 **/\r
 VOID\r
 EFIAPI\r

diff --git a/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c b/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c
index 42f4e1b637503b54eb5614e822f5eb1d6a480b68..97abaa4aeb5889d7b2731a80a2db6cd2566d39b7 100644 (file)
--- 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**.\r
   For x64, the eight-bytes field immediately prior to new IDT\r
   base addres is used to save the EFI_PEI_SERVICES**\r
-  @retval  The pointer to PeiServices.\r
+  \r
+  @return  The pointer to PeiServices.\r
 \r
 **/\r
 EFI_PEI_SERVICES **\r
@@ -43,14 +44,15 @@ GetPeiServicesTablePointer (
 \r
 /**\r
   \r
-  The function returns the pointer to PeiServicee following\r
+  The function sets the pointer to PeiServicee following\r
   PI1.0.\r
   \r
   For IA32, the four-bytes field immediately prior to new IDT\r
   base addres is used to save the EFI_PEI_SERVICES**.\r
   For x64, the eight-bytes field immediately prior to new IDT\r
   base addres is used to save the EFI_PEI_SERVICES**\r
-  @retval  The pointer to PeiServices.\r
+  \r
+  @param PeiServicesTablePointer  The pointer to PeiServices.\r
 \r
 **/\r
 VOID\r

diff --git a/MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c b/MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c
index 3680fbc78aaeaf6da50131e08865970ab5779c45..7c1f7abfa25b7de33a64a2584dcc6aefa337d918 100644 (file)
--- a/MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c
+++ b/MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c
@@ -23,7 +23,7 @@
   The function returns the pointer to PeiServices.\r
   It will ASSERT() if the pointer to PeiServices is NULL.\r
 \r
-  @retval  The pointer to PeiServices.\r
+  @return  The pointer to PeiServices.\r
 \r
 **/\r
 EFI_PEI_SERVICES **\r

diff --git a/MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c b/MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c
index 3f45977aeb6d96f5b33fe2063ca380634f2749f2..c5abc85e7066b14187bc9e3405a462c0695c6528 100644 (file)
--- a/MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c
+++ b/MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c
@@ -72,8 +72,6 @@ _ModuleEntryPoint (
 \r
   @param  Status Status returned by the application that is exiting.\r
   \r
-  @retval VOID\r
-\r
 **/\r
 VOID\r
 EFIAPI\r

diff --git a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c
index 05f157b5e5b564253f9721c3caa4cd736cd420ed..68410ba3c9825c411159465ed35fd12c8d041a87 100644 (file)
--- 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\r
   when unloading the driver.\r
 \r
-  @param  ImageHandle\r
+  @param  ImageHandle ImageHandle of the loaded driver.\r
 \r
-  @retval EFI_SUCCESS\r
+  @return Status returned by all unload().\r
 \r
 **/\r
-STATIC\r
 EFI_STATUS\r
 EFIAPI\r
 _DriverUnloadHandler (\r

diff --git a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c
index 89bb2f449b9fcd441bfec2b6478ecf94ff6103c2..ac032cd4d5bce9964a97ecb2716204291809d812 100644 (file)
--- a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c
+++ b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c
@@ -52,6 +52,7 @@
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 ScsiTestUnitReadyCommand (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
   IN  UINT64                Timeout,\r
@@ -140,6 +141,7 @@ ScsiTestUnitReadyCommand (
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 ScsiInquiryCommand (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
   IN  UINT64                Timeout,\r
@@ -241,6 +243,7 @@ ScsiInquiryCommand (
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 ScsiModeSense10Command (\r
   IN  EFI_SCSI_IO_PROTOCOL    *ScsiIo,\r
   IN  UINT64                  Timeout,\r
@@ -337,6 +340,7 @@ ScsiModeSense10Command (
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 ScsiRequestSenseCommand (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
   IN  UINT64                Timeout,\r
@@ -426,6 +430,7 @@ ScsiRequestSenseCommand (
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 ScsiReadCapacityCommand (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
   IN  UINT64                Timeout,\r
@@ -528,6 +533,7 @@ ScsiReadCapacityCommand (
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 ScsiRead10Command (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
   IN  UINT64                Timeout,\r
@@ -629,6 +635,7 @@ ScsiRead10Command (
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 ScsiWrite10Command (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
   IN  UINT64                Timeout,\r
@@ -694,3 +701,4 @@ ScsiWrite10Command (
 \r
   return Status;\r
 }\r
+\r

diff --git a/MdePkg/Library/UefiUsbLib/Hid.c b/MdePkg/Library/UefiUsbLib/Hid.c
index aeab8f11aa15f723dfa5a9812c87a6a64a4afe2c..3a62d523f1964be51609bf47f0aa5a85d7302e8d 100644 (file)
--- 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\r
                             successfully returned.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_TIMEOUT\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
@@ -73,12 +73,12 @@ UsbGetHidDescriptor (
   @param  DescriptorBuffer  Caller allocated buffer to store Usb report descriptor\r
                             if successfully returned.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_TIMEOUT\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
@@ -117,18 +117,18 @@ UsbGetReportDescriptor (
 }\r
 \r
 /**\r
-  Get Hid Protocol Request.\r
+  Get Hid Protocol Request\r
 \r
   @param  UsbIo             EFI_USB_IO_PROTOCOL.\r
-  @param  Interface         Which interface the caller wants to get protocol.\r
+  @param  Interface         Which interface the caller wants to get protocol\r
   @param  Protocol          Protocol value returned.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_TIMEOUT\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
@@ -168,19 +168,21 @@ UsbGetProtocolRequest (
 }\r
 \r
 \r
+\r
 /**\r
   Set Hid Protocol Request.\r
 \r
   @param  UsbIo             EFI_USB_IO_PROTOCOL.\r
-  @param  Interface         Which interface the caller wants to set protocol.\r
+  @param  Interface         Which interface the caller wants to\r
+                            set protocol.\r
   @param  Protocol          Protocol value the caller wants to set.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_TIMEOUT\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
@@ -227,12 +229,12 @@ UsbSetProtocolRequest (
   @param  ReportId          Which report the caller wants to set.\r
   @param  Duration          Idle rate the caller wants to set.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_TIMEOUT\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
@@ -280,12 +282,12 @@ UsbSetIdleRequest (
   @param  ReportId          Which report the caller wants to get.\r
   @param  Duration          Idle rate the caller wants to get.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_TIMEOUT\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
@@ -326,6 +328,7 @@ UsbGetIdleRequest (
 }\r
 \r
 \r
+\r
 /**\r
   Hid Set Report request.\r
 \r
@@ -336,12 +339,12 @@ UsbGetIdleRequest (
   @param  ReportLen         Length of report descriptor.\r
   @param  Report            Report Descriptor buffer.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_TIMEOUT\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
@@ -394,12 +397,12 @@ UsbSetReportRequest (
   @param  ReportLen         Length of report descriptor.\r
   @param  Report            Caller allocated buffer to store Report Descriptor.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_TIMEOUT\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