Remove checking for overflow in several Multiple functions in BaseLib, for it is...

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

diff --git a/MdePkg/Include/Library/PeiServicesLib.h b/MdePkg/Include/Library/PeiServicesLib.h
index 2bfe7106f42bd1493b1449b71d0aa433b9ff28a8..e417870cdbe679537dcd7d1c0503ce578a6dfb86 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
-  IN OUT EFI_BOOT_MODE          *BootMode\r
+  OUT EFI_BOOT_MODE          *BootMode\r
   );\r
 \r
 /**\r
@@ -398,26 +398,28 @@ PeiServicesRegisterForShadow (
   );\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