]> git.proxmox.com Git - mirror_edk2.git/commitdiff
Fix missing include header file and fix typo in comment.
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Tue, 22 Apr 2008 06:12:08 +0000 (06:12 +0000)
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Tue, 22 Apr 2008 06:12:08 +0000 (06:12 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5110 6f19259b-4bc3-4df7-8a09-765794883524

13 files changed:
MdePkg/Include/Library/BaseLib.h
MdePkg/Include/Library/HiiLib.h
MdePkg/Include/Library/PeiServicesLib.h
MdePkg/Include/Library/PeiServicesTablePointerLib.h
MdePkg/Include/Library/UefiLib.h
MdePkg/Include/Ppi/Smbus2.h
MdePkg/Include/Protocol/ComponentName.h
MdePkg/Include/Protocol/ComponentName2.h
MdePkg/Include/Protocol/DriverBinding.h
MdePkg/Include/Protocol/DriverConfiguration.h
MdePkg/Include/Protocol/DriverConfiguration2.h
MdePkg/Include/Protocol/DriverDiagnostics.h
MdePkg/Include/Protocol/PciRootBridgeIo.h

index ae14cc72eab365c55126849d387666074ceb93b9..cf337b71900beeea5d2b4ab27126c9a5d04e4196 100644 (file)
@@ -2064,7 +2064,7 @@ DivS64x64Remainder (
 
   If the Buffer is NULL, then ASSERT().
 
-  @param  Buffer  Pointer to a 16-bit value that may be unaligned.
+  @param  Uint16  Pointer to a 16-bit value that may be unaligned.
 
   @return *Uint16
 
@@ -2085,7 +2085,7 @@ ReadUnaligned16 (
 
   If the Buffer is NULL, then ASSERT().
 
-  @param  Buffer  Pointer to a 16-bit value that may be unaligned.
+  @param  Uint16  Pointer to a 16-bit value that may be unaligned.
   @param  Value   16-bit value to write to Buffer.
 
   @return Value
@@ -2150,7 +2150,7 @@ WriteUnaligned24 (
 
   If the Buffer is NULL, then ASSERT().
 
-  @param  Buffer  Pointer to a 32-bit value that may be unaligned.
+  @param  Uint32  Pointer to a 32-bit value that may be unaligned.
 
   @return *Uint32
 
@@ -2171,7 +2171,7 @@ ReadUnaligned32 (
 
   If the Buffer is NULL, then ASSERT().
 
-  @param  Buffer  Pointer to a 32-bit value that may be unaligned.
+  @param  Uint32  Pointer to a 32-bit value that may be unaligned.
   @param  Value   32-bit value to write to Buffer.
 
   @return Value
@@ -2193,7 +2193,7 @@ WriteUnaligned32 (
 
   If the Buffer is NULL, then ASSERT().
 
-  @param  Buffer  Pointer to a 64-bit value that may be unaligned.
+  @param  Uint64  Pointer to a 64-bit value that may be unaligned.
 
   @return *Uint64
 
@@ -2214,7 +2214,7 @@ ReadUnaligned64 (
 
   If the Buffer is NULL, then ASSERT().
 
-  @param  Buffer  Pointer to a 64-bit value that may be unaligned.
+  @param  Uint64  Pointer to a 64-bit value that may be unaligned.
   @param  Value   64-bit value to write to Buffer.
 
   @return Value
index 38e1e50f7e46079b90de64987cf0687e63043e78..199a5ec1828777d9712ffb132af231d08b469235 100644 (file)
@@ -57,14 +57,14 @@ HiiLibPreparePackageList (
 \r
   If HiiHandle is NULL, then ASSERT.\r
 \r
-  @param  NumberOfPackages  The number of HII packages to register.\r
-  @param  GuidId                    Package List GUID ID.\r
-  @param  EFI_HANDLE            Optional. If not NULL, the DriverHandle on which an instance of DEVICE_PATH_PROTOCOL is installed.\r
-                                             This DriverHandle uniquely defines the device that the added packages are associated with.\r
-  @param  HiiHandle                On output, the HiiHandle is update with the handle which can be used to retrieve the Package \r
-                                             List later. If the functions failed to add the package to the default HII database, this value will\r
-                                             be set to NULL.\r
-  @param  ...                          The variable argument list describing all HII Package.\r
+  @param  NumberOfPackages    The number of HII packages to register.\r
+  @param  GuidId              Package List GUID ID.\r
+  @param  DriverHandle        Optional. If not NULL, the DriverHandle on which an instance of DEVICE_PATH_PROTOCOL is installed.\r
+                              This DriverHandle uniquely defines the device that the added packages are associated with.\r
+  @param  HiiHandle           On output, the HiiHandle is update with the handle which can be used to retrieve the Package \r
+                              List later. If the functions failed to add the package to the default HII database, this value will\r
+                              be set to NULL.\r
+  @param  ...                 The variable argument list describing all HII Package.\r
 \r
   @return  EFI_SUCCESS         If the packages are successfully added to the default HII database.\r
   @return  EFI_OUT_OF_RESOURCE Not enough resource to complete the operation.\r
@@ -248,8 +248,6 @@ HiiLibGetStringFromToken (
   If HandleBufferLength is NULL, then ASSERT.\r
   If HiiHandleBuffer is NULL, then ASSERT.\r
 \r
-  @param  HiiDatabase            A pointer to the EFI_HII_DATABASE_PROTOCOL\r
-                                 instance.\r
   @param  HandleBufferLength     On input, a pointer to the length of the handle\r
                                  buffer. On output, the length of the handle buffer\r
                                  that is required for the handles found.\r
@@ -272,8 +270,8 @@ HiiLibGetHiiHandles (
   If HiiHandle could not be found in the default HII database, then ASSERT.\r
   If Guid is NULL, then ASSERT.\r
 \r
-  @param  HiiHandle              Hii handle\r
-  @param  Guid                   Package list GUID\r
+  @param  Handle              Hii handle\r
+  @param  Guid                Package list GUID\r
 \r
   @retval EFI_SUCCESS            Successfully extract GUID from Hii database.\r
 \r
@@ -376,7 +374,8 @@ HiiLibGetSupportedLanguages (
   If not enough resource to complete the operation, then ASSERT.\r
 \r
   @param  HiiHandle              The HII package list handle.\r
-\r
+  @param  FirstLanguage          Pointer to language name buffer.\r
+  \r
   @return The supported languages.\r
 \r
 **/\r
index bed110584cbdea4a94246ce5762a075913bf3338..23eeb6be0037aebe3d5c99835eb12a271b2cfc8e 100644 (file)
@@ -165,7 +165,7 @@ PeiServicesCreateHob (
 \r
   @param  Instance              This instance of the firmware volume to find.  The value 0 is the\r
                                 Boot Firmware Volume (BFV).\r
-  @param  FwVolHeader           Pointer to the firmware volume header of the volume to return.\r
+  @param  VolumeHandle          Pointer to the firmware volume header of the volume to return.\r
 \r
   @retval EFI_SUCCESS           The volume was found.\r
   @retval EFI_NOT_FOUND         The volume was not found.\r
@@ -183,9 +183,9 @@ PeiServicesFfsFindNextVolume (
   This service enables PEIMs to discover additional firmware files.\r
 \r
   @param  SearchType            A filter to find files only of this type.\r
-  @param  FwVolHeader           Pointer to the firmware volume header of the volume to search.\r
+  @param  VolumeHandle          Pointer to the firmware volume header of the volume to search.\r
                                 This parameter must point to a valid FFS volume.\r
-  @param  FileHeader            Pointer to the current file from which to begin searching.\r
+  @param  FileHandle            Pointer to the current file from which to begin searching.\r
 \r
   @retval EFI_SUCCESS           The file was found.\r
   @retval EFI_NOT_FOUND         The file was not found.\r
@@ -203,8 +203,8 @@ PeiServicesFfsFindNextFile (
 /**\r
   This service enables PEIMs to discover sections of a given type within a valid FFS file.\r
 \r
-  @param  SearchType            The value of the section type to find.\r
-  @param  FfsFileHeader         A pointer to the file header that contains the set of sections to\r
+  @param  SectionType           The value of the section type to find.\r
+  @param  FileHandle            A pointer to the file header that contains the set of sections to\r
                                 be searched.\r
   @param  SectionData           A pointer to the discovered section, if successful.\r
 \r
@@ -282,8 +282,6 @@ PeiServicesAllocatePool (
 /**\r
   Resets the entire platform.\r
 \r
-  @param  VOID\r
-\r
   @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.\r
 \r
@@ -306,6 +304,7 @@ PeiServicesResetSystem (
   @param VolumeHandle   The firmware volume to search FileHandle\r
                         Upon exit, points to the found file's\r
                         handle or NULL if it could not be found.\r
+  @param FileHandle     Pointer to found file handle \r
 \r
   @retval EFI_SUCCESS             File was found.\r
 \r
index 8c133dd1084c3059c9ca8b75ab8c42dbc6275c10..a5b32a565ba9f82976e0b97e48bc7a8a624e5991 100644 (file)
@@ -34,7 +34,7 @@ GetPeiServicesTablePointer (
   The function set the pointer of PEI services immediately preceding the IDT table\r
   according to PI specification.\r
   \r
-  @param    PeiServices   The address of PeiServices pointer.\r
+  @param    PeiServicesTablePointer   The address of PeiServices pointer.\r
 **/\r
 VOID\r
 EFIAPI\r
index bbc4acab3395034d621024c16a1ed5cd0ba745f5..7daa23be48512e6aa75b809eb7f593d58572970c 100644 (file)
@@ -144,9 +144,7 @@ EfiNamedEventSignal (
   can then immediately be restored back to the current TPL level with a call \r
   to RestoreTPL().\r
 \r
-  @param  VOID\r
-\r
-  @retvale EFI_TPL              The current TPL.\r
+  @return The current TPL.\r
 \r
 **/\r
 EFI_TPL\r
@@ -180,7 +178,6 @@ EfiInitializeLock (
   priority level.  Since there is no preemption or multiprocessor support in EFI,\r
   acquiring the lock only consists of raising to the locks TPL.\r
 \r
-  @param  Lock      A pointer to the lock data structure to initialize.\r
   @param  Priority  The task priority level of the lock.\r
 \r
   @return The lock.\r
@@ -220,7 +217,7 @@ EfiInitializeLock (
   priority level of the mutual exclusion lock.  Then, it places the lock in the \r
   acquired state.\r
 \r
-  @param  Priority  The task priority level of the lock.\r
+  @param  Lock              A pointer to the lock to acquire.\r
 \r
 **/\r
 VOID\r
@@ -302,7 +299,7 @@ EfiTestManagedDevice (
 \r
   @param  ControllerHandle     A handle for a (parent) controller to test. \r
   @param  ChildHandle          A child handle to test.\r
-  @param  ConsumsedGuid        Supplies the protocol that the child controller\r
+  @param  ProtocolGuid         Supplies the protocol that the child controller\r
                                opens on its parent controller. \r
 \r
   @retval EFI_SUCCESS          ChildHandle is a child of the ControllerHandle.\r
@@ -676,7 +673,7 @@ EfiCreateEventLegacyBootEx (
   the EDK/EFI 1.10 form and EDKII/UEFI 2.0 form and allows common code to \r
   work both ways.\r
 \r
-  @param  LegacyBootEvent   Returns the EFI event returned from gBS->CreateEvent(Ex).\r
+  @param  ReadyToBootEvent   Returns the EFI event returned from gBS->CreateEvent(Ex).\r
 \r
   @retval EFI_SUCCESS       Event was created.\r
   @retval Other             Event was not created.\r
@@ -701,7 +698,7 @@ EfiCreateEventReadyToBoot (
   @param  NotifyTpl         The task priority level of the event.\r
   @param  NotifyFunction    The notification function to call when the event is signaled.\r
   @param  NotifyContext     The content to pass to NotifyFunction when the event is signaled.\r
-  @param  LegacyBootEvent   Returns the EFI event returned from gBS->CreateEvent(Ex).\r
+  @param  ReadyToBootEvent  Returns the EFI event returned from gBS->CreateEvent(Ex).\r
 \r
   @retval EFI_SUCCESS       Event was created.\r
   @retval Other             Event was not created.\r
index 29cec3149647a5271f4057dcbe3e047598cd7118..7c4bd70edeb3b7400dd780c3fd6bbace098124db 100644 (file)
@@ -18,7 +18,7 @@
 \r
 #ifndef _PEI_SMBUS2_PPI_H\r
 #define _PEI_SMBUS2_PPI_H\r
-\r
+#include <PiPei.h>\r
 #include <IndustryStandard/SmBus.h>\r
 \r
 #define EFI_PEI_SMBUS2_PPI_GUID \\r
@@ -172,7 +172,6 @@ EFI_STATUS
   The Notify() function registers all the callback functions to allow the \r
   bus driver to call these functions when the SlaveAddress/Data pair happens.\r
 \r
-  @param  PeiServices    A pointer to the system PEI Services Table.\r
   @param  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
   @param  SlaveAddress   Address that the host controller detects as\r
                          sending a message and calls all the registered functions.\r
index 79a714ae6ebcdc9166c99bddeae68d8d91ea97d7..34dd5bd9fb267c98a134afb17583cd336b09e4c4 100644 (file)
@@ -15,6 +15,8 @@
 #ifndef __EFI_COMPONENT_NAME_H__\r
 #define __EFI_COMPONENT_NAME_H__\r
 \r
+#include <PiDxe.h>\r
+\r
 //\r
 // Global ID for the Component Name Protocol\r
 //\r
index 2a907f52d1c720f78561a5f026e09bd3c5e040ea..d9fc6e18e32f594beba4a82fafebc4f8be5de464 100644 (file)
@@ -15,6 +15,8 @@
 #ifndef __EFI_COMPONENT_NAME2_H__\r
 #define __EFI_COMPONENT_NAME2_H__\r
 \r
+#include <PiDxe.h>\r
+\r
 //\r
 // Global ID for the Component Name Protocol\r
 //\r
index 96b0b1bdefe8eef985badf9a72217e697a4905cb..9499e11f3f6f203564aeec3d6324426fc3ce8a9e 100644 (file)
@@ -15,6 +15,7 @@
 #ifndef __EFI_DRIVER_BINDING_H__\r
 #define __EFI_DRIVER_BINDING_H__\r
 \r
+#include <PiDxe.h>\r
 #include <Protocol/DevicePath.h>\r
 //\r
 // Global ID for the ControllerHandle Driver Protocol\r
index 7f10318f9db310aeb8ca0660f73c08d75bb07583..c9d025a9a7ba6a5fce7b499310dc272717aa0f55 100644 (file)
@@ -15,6 +15,7 @@
 #ifndef __EFI_DRIVER_CONFIGURATION_H__\r
 #define __EFI_DRIVER_CONFIGURATION_H__\r
 \r
+#include <PiDxe.h>\r
 #include <Protocol/DriverConfiguration2.h>\r
 \r
 //\r
index c1011ba86bd20258b79c7e601fb9f5fe18b4761e..e4417e1d952a8098a3cc7165f1e83bc85523a803 100644 (file)
@@ -15,6 +15,8 @@
 #ifndef __EFI_DRIVER_CONFIGURATION2_H__\r
 #define __EFI_DRIVER_CONFIGURATION2_H__\r
 \r
+#include <PiDxe.h>\r
+\r
 //\r
 // Global ID for the Driver Configuration Protocol defined in UEFI 2.0\r
 //\r
index d04bf4917a7ecf76de7618e48b1f8c9e8559f547..13670ae93e24c441859a74fe8209fac9c7bbfd44 100644 (file)
@@ -15,6 +15,8 @@
 #ifndef __EFI_DRIVER_DIAGNOSTICS_H__\r
 #define __EFI_DRIVER_DIAGNOSTICS_H__\r
 \r
+#include <PiDxe.h>\r
+\r
 //\r
 // Global ID for the Driver Diagnostics Protocol as defined in UEFI 2.0.\r
 //\r
index 8b39f661b37e808242966e9638d0495c5ffe060c..c55fb1592231ec9b4715c43d1b3d0284d2f8dc53 100644 (file)
@@ -19,6 +19,8 @@
 #ifndef __PCI_ROOT_BRIDGE_IO_H__\r
 #define __PCI_ROOT_BRIDGE_IO_H__\r
 \r
+#include <PiDxe.h>\r
+\r
 #define EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GUID \\r
   { \\r
     0x2f707ebb, 0x4a1a, 0x11d4, {0x9a, 0x38, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r