Modified the #defines for BIT32..BIT63 to match the Spec.

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

diff --git a/MdePkg/Include/Library/PeiServicesLib.h b/MdePkg/Include/Library/PeiServicesLib.h
index 7cff954c04ec2ed972d0966556537244566cfcf5..9714bb8ff10590262aa33a9a6bf5ce4755b58ed8 100644 (file)
--- a/MdePkg/Include/Library/PeiServicesLib.h
+++ b/MdePkg/Include/Library/PeiServicesLib.h
@@ -16,7 +16,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __PEI_SERVICES_LIB_H__\r
 \r
 /**\r
-  This service enables a given PEIM to register an interface into the PEI Foundation. \r
+  This service enables a given PEIM to register an interface into the PEI Foundation.\r
 \r
   @param  PpiList               A pointer to the list of interfaces that the caller shall install.\r
 \r
@@ -98,7 +98,7 @@ PeiServicesNotifyPpi (
   );\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
   @param  BootMode              A pointer to contain the value of the boot mode.\r
 \r
@@ -109,11 +109,11 @@ PeiServicesNotifyPpi (
 EFI_STATUS\r
 EFIAPI\r
 PeiServicesGetBootMode (\r
-  IN OUT EFI_BOOT_MODE          *BootMode\r
+  OUT EFI_BOOT_MODE          *BootMode\r
   );\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
@@ -165,7 +165,7 @@ PeiServicesCreateHob (
 \r
   @param  Instance              This instance of the firmware volume to find.  The value 0 is the\r
                                 Boot Firmware Volume (BFV).\r
-  @param  VolumeHandle          Pointer to the firmware volume header of the volume to return.\r
+  @param  VolumeHandle          Handle of the firmware volume header of the volume to return.\r
 \r
   @retval EFI_SUCCESS           The volume was found.\r
   @retval EFI_NOT_FOUND         The volume was not found.\r
@@ -185,7 +185,7 @@ PeiServicesFfsFindNextVolume (
   @param  SearchType            A filter to find files only of this type.\r
   @param  VolumeHandle          Pointer to the firmware volume header of the volume to search.\r
                                 This parameter must point to a valid FFS volume.\r
-  @param  FileHandle            Pointer to the current file from which to begin searching.\r
+  @param  FileHandle            Handle of the current file from which to begin searching.\r
 \r
   @retval EFI_SUCCESS           The file was found.\r
   @retval EFI_NOT_FOUND         The file was not found.\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