update comments and add assert for these files.

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

diff --git a/MdePkg/Library/PeiPiLib/PeiPiLib.c b/MdePkg/Library/PeiPiLib/PeiPiLib.c
index d1e861136594fb7ef0d975c1dc4be2896bdc5908..3030b1cd7fb297d47873115badee1127d57aed91 100644 (file)
--- a/MdePkg/Library/PeiPiLib/PeiPiLib.c
+++ b/MdePkg/Library/PeiPiLib/PeiPiLib.c
@@ -32,6 +32,27 @@ CONST EFI_PEI_FIRMWARE_VOLUME_INFO_PPI mFvInfoPpiTemplate = {
   NULL //ParentFileName;\r
 };\r
 \r
+/**\r
+    Install a EFI_PEI_FIRMWARE_VOLUME_INFO PPI to inform PEI core about the existence of 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
+    \r
+    @param  FvFormat             Unique identifier of the format of the memory-mapped firmware volume. If NULL is specified,\r
+                                         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, ParentFileName      If the firmware volume originally came from a firmware file, then these point to the\r
+                                          parent firmware volume name and firmware volume file. If it did not originally come\r
+                                          from a firmware file, these should be NULL\r
+  \r
+    @retval  VOID\r
+  \r
+**/\r
 VOID\r
 EFIAPI\r
 PiLibInstallFvInfoPpi (\r