updated Alias, Map, and Env functions per errata.

[mirror_edk2.git] / MdeModulePkg / Core / Pei / PeiMain.h

diff --git a/MdeModulePkg/Core/Pei/PeiMain.h b/MdeModulePkg/Core/Pei/PeiMain.h
index 1a5201c1d1624609b1ed092d098b14775cd23664..1d96cc43f8e3a4ffb55f1f966e290ee105fb3f44 100644 (file)
--- a/MdeModulePkg/Core/Pei/PeiMain.h
+++ b/MdeModulePkg/Core/Pei/PeiMain.h
@@ -120,7 +120,7 @@ typedef struct {
 } CACHE_SECTION_DATA;\r
 \r
 \r
-#define PEI_CORE_HANDLE_SIGNATURE  EFI_SIGNATURE_32('P','e','i','C')\r
+#define PEI_CORE_HANDLE_SIGNATURE  SIGNATURE_32('P','e','i','C')\r
 \r
 ///\r
 /// Pei Core private data structure instance\r
@@ -166,7 +166,7 @@ typedef struct{
 /**\r
   Function Pointer type for PeiCore function.\r
   @param SecCoreData     Points to a data structure containing SEC to PEI handoff data, such as the size \r
-                                                                                        and location of temporary RAM, the stack location and the BFV location.\r
+                         and location of temporary RAM, the stack location and the BFV location.\r
   @param PpiList         Points to a list of one or more PPI descriptors to be installed initially by the PEI core.\r
                          An empty PPI list consists of a single descriptor with the end-tag\r
                          EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization\r
@@ -214,7 +214,7 @@ typedef struct {
 \r
 \r
   @param SecCoreData     Points to a data structure containing SEC to PEI handoff data, such as the size \r
-                                                                                        and location of temporary RAM, the stack location and the BFV location.\r
+                         and location of temporary RAM, the stack location and the BFV location.\r
   @param PpiList         Points to a list of one or more PPI descriptors to be installed initially by the PEI core.\r
                          An empty PPI list consists of a single descriptor with the end-tag\r
                          EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization\r
@@ -224,8 +224,6 @@ typedef struct {
   @param Data            Pointer to old core data that is used to initialize the\r
                          core's data areas.\r
 \r
-  @retval EFI_NOT_FOUND  Never reach\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -335,7 +333,7 @@ InitializePpiServices (
 \r
 /**\r
 \r
-  Migrate the Hob list from the CAR stack to PEI installed memory.\r
+  Migrate the Hob list from the temporary memory stack to PEI installed memory.\r
 \r
   @param PrivateData         Pointer to PeiCore's private data structure.\r
   @param OldCheckingBottom   Bottom of temporary memory range. All Ppi in this range\r
@@ -706,7 +704,7 @@ PeiFvFindNextVolume (
 \r
   @param PrivateData     PeiCore's private data structure\r
   @param SecCoreData     Points to a data structure containing SEC to PEI handoff data, such as the size \r
-                                                                                        and location of temporary RAM, the stack location and the BFV location.\r
+                         and location of temporary RAM, the stack location and the BFV location.\r
   @param OldCoreData     Pointer to the PEI Core data.\r
                          NULL if being run in non-permament memory mode.\r
 \r
@@ -767,7 +765,7 @@ PeiAllocatePages (
 \r
 /**\r
 \r
-  Memory allocation service on the CAR.\r
+  Memory allocation service on the temporary memory.\r
 \r
 \r
   @param PeiServices        An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
@@ -1008,7 +1006,8 @@ InitializeImageServices (
   Get Fv image from the FV type file, then install FV INFO ppi, Build FV hob.\r
 \r
   @param PeiServices          An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
-  @param FvFileHandle         File handle of a Fv type file.\r
+  @param ParentFvHandle       Fv handle to parent Fv image that contain this Fv file.\r
+  @param ParentFvFileHandle   File handle of a Fv type file that contain this Fv image.\r
   @param AuthenticationState  Pointer to attestation authentication state of image.\r
                               If return 0, means pass security checking.\r
 \r
@@ -1019,19 +1018,20 @@ InitializeImageServices (
 EFI_STATUS\r
 ProcessFvFile (\r
   IN  CONST EFI_PEI_SERVICES **PeiServices,\r
-  IN  EFI_PEI_FILE_HANDLE    FvFileHandle,\r
+  IN  EFI_PEI_FV_HANDLE      ParentFvHandle,\r
+  IN  EFI_PEI_FILE_HANDLE    ParentFvFileHandle,\r
   OUT UINT32                 *AuthenticationState\r
   );\r
 \r
 /**\r
   The wrapper function of PeiLoadImageLoadImage().\r
 \r
-  @param This            - Pointer to EFI_PEI_LOAD_FILE_PPI.\r
-  @param FileHandle      - Pointer to the FFS file header of the image.\r
-  @param ImageAddressArg - Pointer to PE/TE image.\r
-  @param ImageSizeArg    - Size of PE/TE image.\r
-  @param EntryPoint      - Pointer to entry point of specified image file for output.\r
-  @param AuthenticationState - Pointer to attestation authentication state of image.\r
+  @param This                 Pointer to EFI_PEI_LOAD_FILE_PPI.\r
+  @param FileHandle           Pointer to the FFS file header of the image.\r
+  @param ImageAddressArg      Pointer to PE/TE image.\r
+  @param ImageSizeArg         Size of PE/TE image.\r
+  @param EntryPoint           Pointer to entry point of specified image file for output.\r
+  @param AuthenticationState  Pointer to attestation authentication state of image.\r
 \r
   @return Status of PeiLoadImageLoadImage().\r
 \r