Update EntryPoint library header

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

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