Synchronize function comment in MdePkg\Library\BaseLib.h with the instance of this...

[mirror_edk2.git] / MdePkg / Library / PeimEntryPoint / PeimEntryPoint.c

diff --git a/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c b/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c
index a7faf2b5f4dd28c34e8ea0a56fed8149ad3e17ac..286c2df9e8b9e08d03ae16c8ce61ecded6428dfa 100644 (file)
--- a/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c
+++ b/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c
@@ -1,4 +1,3 @@
-\r
 /** @file\r
   Entry point to a PEIM.\r
 \r
@@ -13,24 +12,19 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-//\r
-// The package level header files this module uses\r
-//\r
+\r
 #include <PiPei.h>\r
-//\r
-// The protocols, PPI and GUID defintions for this module\r
-//\r
-//\r
-// The Library classes this module consumes\r
-//\r
+\r
+\r
 #include <Library/PeimEntryPoint.h>\r
 #include <Library/DebugLib.h>\r
 \r
 /**\r
   Image entry point of Peim.\r
 \r
-  @param  FfsHeader   Pointer to FFS header the loaded driver.\r
-  @param  PeiServices Pointer to the PEI services.\r
+  @param  FileHandle  Handle of the file being invoked. \r
+                      Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().\r
+  @param  PeiServices Describes the list of possible PEI Services.\r
 \r
   @return  Status returned by entry points of Peims.\r
 \r
@@ -38,8 +32,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 EFI_STATUS\r
 EFIAPI\r
 _ModuleEntryPoint (\r
-  IN EFI_FFS_FILE_HEADER       *FfsHeader,\r
-  IN EFI_PEI_SERVICES          **PeiServices\r
+  IN EFI_PEI_FILE_HANDLE       FileHandle,\r
+  IN CONST EFI_PEI_SERVICES    **PeiServices\r
   )\r
 {\r
   if (_gPeimRevision != 0) {\r
@@ -52,20 +46,21 @@ _ModuleEntryPoint (
   //\r
   // Call constructor for all libraries\r
   //\r
-  ProcessLibraryConstructorList (FfsHeader, PeiServices);\r
+  ProcessLibraryConstructorList (FileHandle, PeiServices);\r
 \r
   //\r
   // Call the driver entry point\r
   //\r
-  return ProcessModuleEntryPointList (FfsHeader, PeiServices);\r
+  return ProcessModuleEntryPointList (FileHandle, PeiServices);\r
 }\r
 \r
 \r
 /**\r
   Wrapper of Peim image entry point.\r
 \r
-  @param  FfsHeader   Pointer to FFS header the loaded driver.\r
-  @param  PeiServices Pointer to the PEI services.\r
+  @param  FileHandle  Handle of the file being invoked. \r
+                      Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().\r
+  @param  PeiServices Describes the list of possible PEI Services.\r
 \r
   @return  Status returned by entry points of Peims.\r
 \r
@@ -73,9 +68,9 @@ _ModuleEntryPoint (
 EFI_STATUS\r
 EFIAPI\r
 EfiMain (\r
-  IN EFI_FFS_FILE_HEADER  *FfsHeader,\r
-  IN EFI_PEI_SERVICES     **PeiServices\r
+  IN EFI_PEI_FILE_HANDLE      FileHandle,\r
+  IN CONST EFI_PEI_SERVICES   **PeiServices\r
   )\r
 {\r
-  return _ModuleEntryPoint (FfsHeader, PeiServices);\r
+  return _ModuleEntryPoint (FileHandle, PeiServices);\r
 }\r