X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FLibrary%2FPeimEntryPoint%2FPeimEntryPoint.c;h=59503e4b77449c41431a3ad26a8fad6d548df2bf;hb=f6d2bcc6fa8161d20ff2b3601c94c566b5a9bc35;hp=6ea991984e7f31e31025f7c3630c6d451910b5a1;hpb=0308e20dc67c63e48211b140558ae3bd13a1cbf5;p=mirror_edk2.git

diff --git a/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c b/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c
index 6ea991984e..59503e4b77 100644
--- a/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c
+++ b/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c
@@ -20,13 +20,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/DebugLib.h>
 
 /**
-  Image entry point of Peim.
+  The entry point of PE/COFF Image for a PEIM.
 
-  @param  FfsHeader   Pointer to FFS header the loaded driver.
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
+  This function is the entry point for a PEIM.  This function must call ProcessLibraryConstructorList() 
+  and ProcessModuleEntryPointList().  The return value from ProcessModuleEntryPointList() is returned.
+  If _gPeimRevision is not zero and PeiServices->Hdr.Revision is less than _gPeimRevison, then ASSERT().
 
-  @return  Status returned by entry points of Peims.
+  @param  FileHandle  Handle of the file being invoked. 
+  @param  PeiServices Describes the list of possible PEI Services.
 
+  @retval  EFI_SUCCESS   The PEIM executed normally.
+  @retval  !EFI_SUCCESS  The PEIM failed to execute normally.
 **/
 EFI_STATUS
 EFIAPI
@@ -55,19 +59,22 @@ _ModuleEntryPoint (
 
 
 /**
-  Wrapper of Peim image entry point.
+  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().
+  
+  This function is required to call _ModuleEntryPoint() passing in FileHandle and PeiServices.
 
-  @param  FfsHeader   Pointer to FFS header the loaded driver.
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
+  @param  FileHandle  Handle of the file being invoked. 
+  @param  PeiServices Describes the list of possible PEI Services.
 
-  @return  Status returned by entry points of Peims.
+  @retval EFI_SUCCESS  The PEIM executed normally.
+  @retval !EFI_SUCCESS The PEIM failed to execute normally.
 
 **/
 EFI_STATUS
 EFIAPI
 EfiMain (
-  IN EFI_PEI_FILE_HANDLE      FileHandle,
-  IN CONST EFI_PEI_SERVICES   **PeiServices
+  IN EFI_PEI_FILE_HANDLE       FileHandle,
+  IN CONST EFI_PEI_SERVICES    **PeiServices
   )
 {
   return _ModuleEntryPoint (FileHandle, PeiServices);