Synchronization of MDE Library Spec., Mde.dec, and corresponding head files in MdePkg...

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

diff --git a/MdePkg/Include/Library/PeiServicesLib.h b/MdePkg/Include/Library/PeiServicesLib.h
index 23eeb6be0037aebe3d5c99835eb12a271b2cfc8e..7cff954c04ec2ed972d0966556537244566cfcf5 100644 (file)
--- a/MdePkg/Include/Library/PeiServicesLib.h
+++ b/MdePkg/Include/Library/PeiServicesLib.h
@@ -1,14 +1,14 @@
 /** @file\r
-  Header file for PEI Services Library.\r
+  Provides library functions for all PEI Services.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
+Copyright (c) 2006 - 2008, Intel Corporation\r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution.  The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
 \r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
 \r
@@ -109,7 +109,7 @@ PeiServicesNotifyPpi (
 EFI_STATUS\r
 EFIAPI\r
 PeiServicesGetBootMode (\r
-  OUT EFI_BOOT_MODE          *BootMode\r
+  IN OUT EFI_BOOT_MODE          *BootMode\r
   );\r
 \r
 /**\r
@@ -397,5 +397,36 @@ PeiServicesRegisterForShadow (
   IN  EFI_PEI_FILE_HANDLE FileHandle\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. \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
+**/\r
+VOID\r
+EFIAPI\r
+PeiServicesInstallFvInfoPpi (\r
+  IN CONST EFI_GUID                *FvFormat, OPTIONAL\r
+  IN CONST VOID                    *FvInfo,\r
+  IN       UINT32                  FvInfoSize,\r
+  IN CONST EFI_GUID                *ParentFvName, OPTIONAL\r
+  IN CONST EFI_GUID                *ParentFileName OPTIONAL\r
+  );\r
 \r
 #endif\r