Coding style fix.

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

diff --git a/MdePkg/Include/Library/PeiCoreEntryPoint.h b/MdePkg/Include/Library/PeiCoreEntryPoint.h
index 76afc594cb8dcab147a573c054c50ec9c2e7528e..84542e40862713de77e472a6e1ed8ab2acf56747 100644 (file)
--- a/MdePkg/Include/Library/PeiCoreEntryPoint.h
+++ b/MdePkg/Include/Library/PeiCoreEntryPoint.h
@@ -16,16 +16,32 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __MODULE_ENTRY_POINT_H__\r
 \r
 /**\r
+\r
   Enrty point to PEI core.\r
 \r
-  @param  PeiStartupDescriptor Pointer of start up information.\r
- \r
-  @return Status returned by entry points of core and drivers. \r
+  @param SecCoreData    Points to a data structure containing\r
+                        information about the PEI core's\r
+                        operating environment, such as the size\r
+                        and location of temporary RAM, the stack\r
+                        location and the BFV location. The type\r
+                        EFI_SEC_PEI_HAND_OFF is\r
+\r
+  @param PpiList        Points to a list of one or more PPI\r
+                        descriptors to be installed initially by\r
+                        the PEI core. An empty PPI list consists\r
+                        of a single descriptor with the end-tag\r
+                        EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.\r
+                        As part of its initialization phase, the\r
+                        PEI Foundation will add these SEC-hosted\r
+                        PPIs to its PPI database such that both\r
+                        the PEI Foundation and any modules can\r
+                        leverage the associated service calls\r
+                        and/or code in these early PPIs.\r
 \r
 **/\r
-EFI_STATUS\r
-EFIAPI\r
-_ModuleEntryPoint (\r
+VOID\r
+EFIAPI \r
+_ModuleEntryPoint(\r
   IN CONST  EFI_SEC_PEI_HAND_OFF    *SecCoreData,\r
   IN CONST  EFI_PEI_PPI_DESCRIPTOR  *PpiList\r
   );\r
@@ -33,12 +49,29 @@ _ModuleEntryPoint (
 /**\r
   Wrapper of enrty point to PEI core.\r
 \r
-  @param  PeiStartupDescriptor Pointer of start up information.\r
+  @param SecCoreData    Points to a data structure containing\r
+                        information about the PEI core's\r
+                        operating environment, such as the size\r
+                        and location of temporary RAM, the stack\r
+                        location and the BFV location. The type\r
+                        EFI_SEC_PEI_HAND_OFF is\r
+\r
+  @param PpiList        Points to a list of one or more PPI\r
+                        descriptors to be installed initially by\r
+                        the PEI core. An empty PPI list consists\r
+                        of a single descriptor with the end-tag\r
+                        EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.\r
+                        As part of its initialization phase, the\r
+                        PEI Foundation will add these SEC-hosted\r
+                        PPIs to its PPI database such that both\r
+                        the PEI Foundation and any modules can\r
+                        leverage the associated service calls\r
+                        and/or code in these early PPIs.\r
  \r
   @return Status returned by entry points of core and drivers. \r
 \r
 **/\r
-EFI_STATUS\r
+VOID\r
 EFIAPI\r
 EfiMain (\r
   IN CONST  EFI_SEC_PEI_HAND_OFF    *SecCoreData,\r
@@ -55,7 +88,7 @@ EfiMain (
 VOID\r
 EFIAPI\r
 ProcessLibraryConstructorList (\r
-  IN EFI_FFS_FILE_HEADER  *FfsHeader,\r
+  IN EFI_PEI_FILE_HANDLE  *FfsHeader,\r
   IN EFI_PEI_SERVICES     **PeiServices\r
   );\r
 \r
@@ -63,13 +96,28 @@ ProcessLibraryConstructorList (
 /**\r
   Call the list of driver entry points. Automatics Generated by tool.\r
 \r
-  @param  PeiStartupDescriptor  Pointer to startup information .\r
-  @param  OldCoreData           Pointer to Original startup information.\r
+  @param SecCoreData    Points to a data structure containing\r
+                        information about the PEI core's\r
+                        operating environment, such as the size\r
+                        and location of temporary RAM, the stack\r
+                        location and the BFV location. The type\r
+                        EFI_SEC_PEI_HAND_OFF is\r
+\r
+  @param PpiList        Points to a list of one or more PPI\r
+                        descriptors to be installed initially by\r
+                        the PEI core. An empty PPI list consists\r
+                        of a single descriptor with the end-tag\r
+                        EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.\r
+                        As part of its initialization phase, the\r
+                        PEI Foundation will add these SEC-hosted\r
+                        PPIs to its PPI database such that both\r
+                        the PEI Foundation and any modules can\r
+                        leverage the associated service calls\r
+                        and/or code in these early PPIs.\r
+  @param  OldCoreData   Pointer to Original startup information.\r
 \r
-  @return Status returned by entry points of drivers.  \r
- \r
 **/\r
-EFI_STATUS\r
+VOID\r
 EFIAPI\r
 ProcessModuleEntryPointList (\r
   IN CONST  EFI_SEC_PEI_HAND_OFF    *SecCoreData,\r