Fix some typo.

[mirror_edk2.git] / MdePkg / Include / Library / PeimEntryPoint.h

diff --git a/MdePkg/Include/Library/PeimEntryPoint.h b/MdePkg/Include/Library/PeimEntryPoint.h
index dedf32d67d7d21be7fd0fce7e45ff0cf18a3adad..ae53b2f94d2f18d03d16f29fde1b400955e03533 100644 (file)
--- a/MdePkg/Include/Library/PeimEntryPoint.h
+++ b/MdePkg/Include/Library/PeimEntryPoint.h
@@ -1,7 +1,7 @@
 /** @file\r
-  Entry point to a PEIM\r
+  Module entry point library for PEIM.\r
 \r
-Copyright (c) 2006, Intel Corporation<BR>\r
+Copyright (c) 2006 - 2008 Intel Corporation<BR>\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -18,86 +18,94 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 ///\r
 /// Declare the EFI/UEFI Specification Revision to which this driver is implemented \r
 ///\r
-extern const UINT32                   _gPeimRevision;\r
+extern CONST UINT32       _gPeimRevision;\r
+\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
-\r
-  @return  Status returned by entry points of Peims.\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
+  @retval  EFI_SUCCESS   The PEIM executed normally.\r
+  @retval  !EFI_SUCCESS  The PEIM failed to execute normally.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
 _ModuleEntryPoint (\r
-  IN EFI_PEI_FILE_HANDLE       *FfsHeader,\r
-  IN EFI_PEI_SERVICES          **PeiServices\r
+  IN EFI_PEI_FILE_HANDLE       FileHandle,\r
+  IN CONST EFI_PEI_SERVICES    **PeiServices\r
   );\r
 \r
 \r
 /**\r
-  Wrapper of Peim image entry point.\r
+  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().\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
+  @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       *FfsHeader,\r
-  IN EFI_PEI_SERVICES          **PeiServices\r
+  IN EFI_PEI_FILE_HANDLE       FileHandle,\r
+  IN CONST EFI_PEI_SERVICES    **PeiServices\r
   );\r
 \r
 \r
 /**\r
   Call constructs for all libraries. Automatics Generated by tool.\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
 **/\r
 VOID\r
 EFIAPI\r
 ProcessLibraryConstructorList (\r
-  IN EFI_PEI_FILE_HANDLE       *FfsHeader,\r
-  IN EFI_PEI_SERVICES          **PeiServices\r
+  IN EFI_PEI_FILE_HANDLE       FileHandle,\r
+  IN CONST EFI_PEI_SERVICES    **PeiServices\r
   );\r
 \r
 \r
 /**\r
   Call destructors for all libraries. Automatics Generated by tool.\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
 **/\r
 VOID\r
 EFIAPI\r
 ProcessLibraryDestructorList (\r
-  IN EFI_PEI_FILE_HANDLE       *FfsHeader,\r
-  IN EFI_PEI_SERVICES          **PeiServices\r
+  IN EFI_PEI_FILE_HANDLE       FileHandle,\r
+  IN CONST EFI_PEI_SERVICES    **PeiServices\r
   );\r
 \r
 \r
 /**\r
   Call the list of driver entry points. Automatics Generated by tool.\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 drivers.  \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
 ProcessModuleEntryPointList (\r
-  IN EFI_PEI_FILE_HANDLE       *FfsHeader,\r
-  IN EFI_PEI_SERVICES          **PeiServices\r
+  IN EFI_PEI_FILE_HANDLE       FileHandle,\r
+  IN CONST EFI_PEI_SERVICES    **PeiServices\r
   );\r
 \r
 #endif\r