EmbeddedPkg/PrePiLib: Correct function name
[mirror_edk2.git] / EmbeddedPkg / Include / Library / PrePiLib.h
index 6144513..92fbc24 100644 (file)
@@ -83,7 +83,7 @@ FfsFindSectionData (
 \r
 /**\r
   Find a file in the volume by name\r
-  \r
+\r
   @param FileName       A pointer to the name of the file to\r
                         find within the firmware volume.\r
 \r
@@ -101,7 +101,7 @@ FfsFindSectionData (
 **/\r
 EFI_STATUS\r
 EFIAPI\r
-FfsFindByName (\r
+FfsFindFileByName (\r
   IN CONST  EFI_GUID            *FileName,\r
   IN CONST  EFI_PEI_FV_HANDLE   VolumeHandle,\r
   OUT       EFI_PEI_FILE_HANDLE *FileHandle\r
@@ -117,15 +117,15 @@ FfsFindByName (
                       information.\r
 \r
   @retval EFI_SUCCESS             File information returned.\r
-  \r
+\r
   @retval EFI_INVALID_PARAMETER   If FileHandle does not\r
                                   represent a valid file.\r
-  \r
+\r
   @retval EFI_INVALID_PARAMETER   If FileInfo is NULL.\r
-  \r
+\r
 **/\r
 EFI_STATUS\r
-EFIAPI \r
+EFIAPI\r
 FfsGetFileInfo (\r
   IN CONST  EFI_PEI_FILE_HANDLE   FileHandle,\r
   OUT EFI_FV_FILE_INFO            *FileInfo\r
@@ -141,10 +141,10 @@ FfsGetFileInfo (
                         information.\r
 \r
   @retval EFI_SUCCESS             File information returned.\r
-  \r
+\r
   @retval EFI_INVALID_PARAMETER   If FileHandle does not\r
                                   represent a valid file.\r
-  \r
+\r
   @retval EFI_INVALID_PARAMETER   If FileInfo is NULL.\r
 \r
 **/\r
@@ -160,11 +160,10 @@ FfsGetVolumeInfo (
 /**\r
   Get Fv image from the FV type file, then add FV & FV2 Hob.\r
 \r
-       @param FileHandle               File handle of a Fv type file.\r
-\r
+  @param FileHandle      File handle of a Fv type file.\r
 \r
-  @retval EFI_NOT_FOUND                                FV image can't be found.\r
-  @retval EFI_SUCCESS                                          Successfully to process it.\r
+  @retval EFI_NOT_FOUND  FV image can't be found.\r
+  @retval EFI_SUCCESS    Successfully to process it.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -177,12 +176,12 @@ FfsProcessFvFile (
 /**\r
   Search through every FV until you find a file of type FileType\r
 \r
-       @param FileType             File handle of a Fv type file.\r
-  @param Volumehandle   On succes Volume Handle of the match\r
-  @param FileHandle     On success File Handle of the match\r
-  \r
-  @retval EFI_NOT_FOUND                                FV image can't be found.\r
-  @retval EFI_SUCCESS                                          Successfully found FileType\r
+  @param FileType        File handle of a Fv type file.\r
+  @param Volumehandle    On succes Volume Handle of the match\r
+  @param FileHandle      On success File Handle of the match\r
+\r
+  @retval EFI_NOT_FOUND  FV image can't be found.\r
+  @retval EFI_SUCCESS    Successfully found FileType\r
 \r
 **/\r
 EFI_STATUS\r
@@ -197,11 +196,11 @@ FfsAnyFvFindFirstFile (
 /**\r
   Get Fv image from the FV type file, then add FV & FV2 Hob.\r
 \r
-       @param FileHandle               File handle of a Fv type file.\r
+  @param FileHandle  File handle of a Fv type file.\r
 \r
 \r
-  @retval EFI_NOT_FOUND                                FV image can't be found.\r
-  @retval EFI_SUCCESS                                          Successfully to process it.\r
+  @retval EFI_NOT_FOUND  FV image can't be found.\r
+  @retval EFI_SUCCESS    Successfully to process it.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -212,10 +211,10 @@ FfsProcessFvFile (
 \r
 \r
 /**\r
-  This service enables PEIMs to ascertain the present value of the boot mode.  \r
+  This service enables PEIMs to ascertain the present value of the boot mode.\r
 \r
 \r
-  @retval BootMode           \r
+  @retval BootMode\r
 \r
 **/\r
 EFI_BOOT_MODE\r
@@ -226,7 +225,7 @@ GetBootMode (
 \r
 \r
 /**\r
-  This service enables PEIMs to update the boot mode variable.    \r
+  This service enables PEIMs to update the boot mode variable.\r
 \r
   @param  BootMode              The value of the boot mode to set.\r
 \r
@@ -251,7 +250,7 @@ SetBootMode (
 VOID *\r
 EFIAPI\r
 GetHobList (\r
-  VOID         \r
+  VOID\r
   );\r
 \r
 \r
@@ -259,7 +258,7 @@ GetHobList (
   Updates the pointer to the HOB list.\r
 \r
   @param  HobList       Hob list pointer to store\r
-  \r
+\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -275,24 +274,6 @@ HobConstructor (
   IN VOID   *EfiFreeMemoryTop\r
   );\r
 \r
-/**\r
-  Retrieves the magic value from the PE/COFF header.\r
-\r
-  @param  Hdr             The buffer in which to return the PE32, PE32+, or TE header.\r
-\r
-  @return EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC - Image is PE32\r
-  @return EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC - Image is PE32+\r
-\r
-**/\r
-VOID\r
-CreateHobList (\r
-  IN VOID   *MemoryBegin,\r
-  IN UINTN  MemoryLength,\r
-  IN VOID   *HobBase,\r
-  IN VOID   *StackBase\r
-  );\r
-\r
-\r
 /**\r
   This service enables PEIMs to create various types of HOBs.\r
 \r
@@ -313,7 +294,7 @@ CreateHob (
 /**\r
   Returns the next instance of a HOB type from the starting HOB.\r
 \r
-  This function searches the first instance of a HOB type from the starting HOB pointer. \r
+  This function searches the first instance of a HOB type from the starting HOB pointer.\r
   If there does not exist such HOB type from the starting HOB pointer, it will return NULL.\r
   In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer\r
   unconditionally: it returns HobStart back if HobStart itself meets the requirement;\r
@@ -336,8 +317,8 @@ GetNextHob (
 /**\r
   Returns the first instance of a HOB type among the whole HOB list.\r
 \r
-  This function searches the first instance of a HOB type among the whole HOB list. \r
-  If there does not exist such HOB type in the HOB list, it will return NULL. \r
+  This function searches the first instance of a HOB type among the whole HOB list.\r
+  If there does not exist such HOB type in the HOB list, it will return NULL.\r
 \r
   @param  Type          The HOB type to return.\r
 \r
@@ -351,10 +332,10 @@ GetFirstHob (
   );\r
 \r
 /**\r
-  This function searches the first instance of a HOB from the starting HOB pointer. \r
-  Such HOB should satisfy two conditions: \r
-  its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid. \r
-  If there does not exist such HOB from the starting HOB pointer, it will return NULL. \r
+  This function searches the first instance of a HOB from the starting HOB pointer.\r
+  Such HOB should satisfy two conditions:\r
+  its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.\r
+  If there does not exist such HOB from the starting HOB pointer, it will return NULL.\r
   Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()\r
   to extract the data section and its size info respectively.\r
   In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer\r
@@ -377,7 +358,7 @@ GetNextGuidHob (
   );\r
 \r
 /**\r
-  This function searches the first instance of a HOB among the whole HOB list. \r
+  This function searches the first instance of a HOB among the whole HOB list.\r
   Such HOB should satisfy two conditions:\r
   its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.\r
   If there does not exist such HOB from the starting HOB pointer, it will return NULL.\r
@@ -447,8 +428,8 @@ BuildResourceDescriptorHob (
 /**\r
   Builds a GUID HOB with a certain data length.\r
 \r
-  This function builds a customized HOB tagged with a GUID for identification \r
-  and returns the start address of GUID HOB data so that caller can fill the customized data. \r
+  This function builds a customized HOB tagged with a GUID for identification\r
+  and returns the start address of GUID HOB data so that caller can fill the customized data.\r
   The HOB Header and Name field is already stripped.\r
   It can only be invoked during PEI phase;\r
   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
@@ -517,7 +498,7 @@ BuildFvHob (
   );\r
 \r
 /**\r
-  Builds a Firmware Volume HOB and a resrouce descriptor hob \r
+  Builds a Firmware Volume HOB and a resrouce descriptor hob\r
 \r
   This function builds a Firmware Volume HOB.\r
   It can only be invoked during PEI phase;\r
@@ -530,11 +511,11 @@ BuildFvHob (
 **/\r
 VOID\r
 EFIAPI\r
-BuildFvHobs (  \r
+BuildFvHobs (\r
   IN EFI_PHYSICAL_ADDRESS         PhysicalStart,\r
   IN UINT64                       NumberOfBytes,\r
   IN EFI_RESOURCE_ATTRIBUTE_TYPE  *ResourceAttribute  OPTIONAL\r
-  ); \r
+  );\r
 \r
 \r
 /**\r
@@ -549,7 +530,7 @@ BuildFvHobs (
   @param  Length        The size of the Firmware Volume in bytes.\r
   @param  FvName       The name of the Firmware Volume.\r
   @param  FileName      The name of the file.\r
-  \r
+\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -702,12 +683,12 @@ BuildPeCoffLoaderHob (
   @return A pointer to the allocated buffer or NULL if allocation fails.\r
 \r
 **/\r
-VOID * \r
+VOID *\r
 EFIAPI\r
 AllocatePages (\r
   IN UINTN            Pages\r
   );\r
-  \r
+\r
 /**\r
   Allocates a buffer of type EfiBootServicesData.\r
 \r
@@ -725,8 +706,8 @@ EFIAPI
 AllocatePool (\r
   IN UINTN  AllocationSize\r
   );\r
-  \r
-  \r
+\r
+\r
 /**\r
   Allocates one or more 4KB pages of type EfiBootServicesData at a specified alignment.\r
 \r