Remove todo comment in BaseLib.h

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

diff --git a/MdePkg/Library/PeiServicesLib/PeiServicesLib.c b/MdePkg/Library/PeiServicesLib/PeiServicesLib.c
index 599eb2e3e1e8ce3ba9ba34433467da520942ee5f..93495f04b8e9813978faa2df266a6ed51eba8c61 100644 (file)
--- a/MdePkg/Library/PeiServicesLib/PeiServicesLib.c
+++ b/MdePkg/Library/PeiServicesLib/PeiServicesLib.c
@@ -151,7 +151,7 @@ PeiServicesNotifyPpi (
 EFI_STATUS\r
 EFIAPI\r
 PeiServicesGetBootMode (\r
-  IN OUT EFI_BOOT_MODE          *BootMode\r
+  OUT EFI_BOOT_MODE          *BootMode\r
   )\r
 {\r
   CONST EFI_PEI_SERVICES **PeiServices;\r
@@ -282,7 +282,7 @@ PeiServicesFfsFindNextFile (
   This service enables PEIMs to discover sections of a given type within a valid FFS file.\r
 \r
   @param  SectionType           The value of the section type to find.\r
-  @param  FfsFileHeader         A pointer to the file header that contains the set of sections to\r
+  @param  FileHandle            A pointer to the file header that contains the set of sections to\r
                                 be searched.\r
   @param  SectionData           A pointer to the discovered section, if successful.\r
 \r
@@ -294,14 +294,14 @@ EFI_STATUS
 EFIAPI\r
 PeiServicesFfsFindSectionData (\r
   IN EFI_SECTION_TYPE           SectionType,\r
-  IN EFI_PEI_FILE_HANDLE        FfsFileHeader,\r
+  IN EFI_PEI_FILE_HANDLE        FileHandle,\r
   OUT VOID                      **SectionData\r
   )\r
 {\r
   CONST EFI_PEI_SERVICES **PeiServices;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
-  return (*PeiServices)->FfsFindSectionData (PeiServices, SectionType, FfsFileHeader, SectionData);\r
+  return (*PeiServices)->FfsFindSectionData (PeiServices, SectionType, FileHandle, SectionData);\r
 }\r
 \r
 /**\r
@@ -384,8 +384,6 @@ PeiServicesAllocatePool (
 /**\r
   Resets the entire platform.\r
 \r
-  @param  VOID\r
-\r
   @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.\r
 \r
@@ -520,26 +518,28 @@ PeiServicesFfsGetVolumeInfo (
 }\r
 \r
 /**\r
-  Install a EFI_PEI_FIRMWARE_VOLUME_INFO PPI to inform PEI core about the existence of a new Firmware Volume.\r
+  Install a EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance so the PEI Core will be notified about a new firmware volume.\r
   \r
-  The function allocate the EFI_PEI_PPI_DESCRIPTOR structure and update the fields accordingly to parameter passed\r
-  in and install the PPI.\r
+  This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO_PPI using \r
+  the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance.\r
+  If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO_PPI, then ASSERT().\r
+  If the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI can not be installed, then ASSERT().\r
+\r
   \r
-  @param  FvFormat             Unique identifier of the format of the memory-mapped firmware volume. \r
-                               If NULL is specified, EFI_FIRMWARE_FILE_SYSTEM2_GUID is used as the Format GUID.\r
-  @param  FvInfo               Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to\r
-                               process the volume. The format of this buffer is specific to the FvFormat. For\r
-                               memory-mapped firmware volumes, this typically points to the first byte of the\r
-                               firmware volume.\r
-  @param  FvInfoSize           Size of the data provided by FvInfo. For memory-mapped firmware volumes, this is\r
-                               typically the size of the firmware volume.\r
-  @param  ParentFvName         If the firmware volume originally came from a firmware file, then these point to the\r
-                               parent firmware volume name. If it did not originally come from a firmware file, \r
-                               these should be NULL.\r
-  @param  ParentFileName       If the firmware volume originally came from a firmware file, then these point to the\r
-                               firmware volume file. If it did not originally come from a firmware file, \r
-                               these should be NULL.\r
-   \r
+  @param  FvFormat             Unique identifier of the format of the memory-mapped firmware volume.\r
+                               This parameter is optional and may be NULL.  \r
+                               If NULL is specified, the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.\r
+  @param  FvInfo               Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume. \r
+                               The format of this buffer is specific to the FvFormat. For memory-mapped firmware volumes, \r
+                               this typically points to the first byte of the firmware volume.\r
+  @param  FvInfoSize           The size, in bytes, of FvInfo. For memory-mapped firmware volumes, \r
+                               this is typically the size of the firmware volume.\r
+  @param  ParentFvName         If the new firmware volume originated from a file in a different firmware volume, \r
+                               then this parameter specifies the GUID name of the originating firmware volume.\r
+                               Otherwise, this parameter must be NULL.\r
+  @param  ParentFileName       If the new firmware volume originated from a file in a different firmware volume, \r
+                               then this parameter specifies the GUID file name of the originating firmware file.\r
+                               Otherwise, this parameter must be NULL.\r
 **/\r
 VOID\r
 EFIAPI\r