Following 3 updates are for spec update published in PI 1.2.

1. Rename EFI_PEI_NEXT_VARIABLE_NAME2 to EFI_PEI_GET_NEXT_VARIABLE_NAME2, as PI 1.2 specifies.
2. Add return status description for PEI Service FfsGetVolumeInfo.
3. Update parameter description for EFI_PEI_READ_ONLY_VARIABLE2_PPI.NextVariableName().

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9438 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdeModulePkg/Core/Pei/FwVol/FwVol.c b/MdeModulePkg/Core/Pei/FwVol/FwVol.c
index 06c08f9bc4373e747f68a673a47d7ef7290166ec..7b74edb69ac92778e1c942d7b91d8f444df4cdf1 100644 (file)
--- a/MdeModulePkg/Core/Pei/FwVol/FwVol.c
+++ b/MdeModulePkg/Core/Pei/FwVol/FwVol.c
@@ -730,12 +730,19 @@ PeiFfsGetFileInfo (
 /**\r
   Returns information about the specified volume.\r
 \r
-  @param VolumeHandle    Handle of the volume.\r
-  @param VolumeInfo      Upon exit, points to the volume’s information.\r
+  This function returns information about a specific firmware\r
+  volume, including its name, type, attributes, starting address\r
+  and size.\r
+\r
+  @param VolumeHandle   Handle of the volume.\r
+  @param VolumeInfo     Upon exit, points to the volume's information.\r
+\r
+  @retval EFI_SUCCESS             Volume information returned.\r
+  @retval EFI_INVALID_PARAMETER   If VolumeHandle does not represent a valid volume.\r
+  @retval EFI_INVALID_PARAMETER   If VolumeHandle is NULL.\r
+  @retval EFI_SUCCESS             Information successfully returned.\r
+  @retval EFI_INVALID_PARAMETER   The volume designated by the VolumeHandle is not available.\r
 \r
-  @retval EFI_INVALID_PARAMETER If VolumeHandle does not represent a valid volume.\r
-  @retval EFI_INVALID_PARAMETER If VolumeInfo is NULL.\r
-  @retval EFI_SUCCESS           Volume information returned.\r
 **/\r
 EFI_STATUS\r
 EFIAPI \r

diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.c b/MdeModulePkg/Universal/Variable/Pei/Variable.c
index 8ceebedd15bcde99af2a82e2ec452b6e506876f4..8e4a5cbea7215332b784b88312d9c813a29196bf 100644 (file)
--- a/MdeModulePkg/Universal/Variable/Pei/Variable.c
+++ b/MdeModulePkg/Universal/Variable/Pei/Variable.c
@@ -3,7 +3,7 @@
   Implement ReadOnly Variable Services required by PEIM and install\r
   PEI ReadOnly Varaiable2 PPI. These services operates the non volatile storage space.\r
 \r
-Copyright (c) 2006 - 2008 Intel Corporation. <BR>\r
+Copyright (c) 2006 - 2009 Intel Corporation. <BR>\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
@@ -592,7 +592,7 @@ PeiGetVariable (
   @param  VariableNameSize  On entry, points to the size of the buffer pointed to by VariableName.\r
   @param  VariableName      On entry, a pointer to a null-terminated string that is the variable's name.\r
                             On return, points to the next variable's null-terminated name string.\r
-  @param  VariableGuid      On entry, a pointer to an UEFI _GUID that is the variable's GUID. \r
+  @param  VendorGuid        On entry, a pointer to an EFI_GUID that is the variable's GUID. \r
                             On return, a pointer to the next variable's GUID.\r
 \r
   @retval EFI_SUCCESS           The variable was read successfully.\r

diff --git a/MdePkg/Include/Pi/PiPeiCis.h b/MdePkg/Include/Pi/PiPeiCis.h
index c93179a82845195417ac42424570d689a643a143..96bd78dec01c5e71640ca9dd22ca2981acee6eb1 100644 (file)
--- a/MdePkg/Include/Pi/PiPeiCis.h
+++ b/MdePkg/Include/Pi/PiPeiCis.h
@@ -649,14 +649,13 @@ typedef struct {
   and size.\r
 \r
   @param VolumeHandle   Handle of the volume.\r
+  @param VolumeInfo     Upon exit, points to the volume's information.\r
 \r
-  @param VolumeInfo     Upon exit, points to the volume's\r
-                        information.\r
-\r
-  @retval EFI_SUCCESS             File information returned.\r
-  @retval EFI_INVALID_PARAMETER   If FileHandle does not\r
-                                  represent a valid file.\r
-  @retval EFI_INVALID_PARAMETER   If FileInfo is NULL.\r
+  @retval EFI_SUCCESS             Volume information returned.\r
+  @retval EFI_INVALID_PARAMETER   If VolumeHandle does not represent a valid volume.\r
+  @retval EFI_INVALID_PARAMETER   If VolumeHandle is NULL.\r
+  @retval EFI_SUCCESS             Information successfully returned.\r
+  @retval EFI_INVALID_PARAMETER   The volume designated by the VolumeHandle is not available.\r
 \r
 **/\r
 typedef\r

diff --git a/MdePkg/Include/Ppi/ReadOnlyVariable2.h b/MdePkg/Include/Ppi/ReadOnlyVariable2.h
index ceede7452d3dd20327cf162102460e7fc62d4061..23de911989b8aa712b892d8234500bb0e652d02f 100644 (file)
--- a/MdePkg/Include/Ppi/ReadOnlyVariable2.h
+++ b/MdePkg/Include/Ppi/ReadOnlyVariable2.h
@@ -2,7 +2,7 @@
   This file declares Read-only Variable Service2 PPI.\r
   This ppi permits read-only access to the UEFI variable store during the PEI phase.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2009, 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
@@ -79,7 +79,7 @@ EFI_STATUS
   @param  VariableName      On entry, a pointer to a null-terminated string that is the variable's name.\r
                             On return, points to the next variable's null-terminated name string.\r
 \r
-  @param  VendorGuid        On entry, a pointer to an UEFI _GUID that is the variable's GUID. \r
+  @param  VendorGuid        On entry, a pointer to an EFI_GUID that is the variable's GUID. \r
                             On return, a pointer to the next variable's GUID.\r
 \r
   @retval EFI_SUCCESS           The variable was read successfully.\r
@@ -94,7 +94,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_NEXT_VARIABLE_NAME2)(\r
+(EFIAPI *EFI_PEI_GET_NEXT_VARIABLE_NAME2)(\r
   IN CONST  EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
   IN OUT    UINTN                           *VariableNameSize,\r
   IN OUT    CHAR16                          *VariableName,\r
@@ -106,8 +106,8 @@ EFI_STATUS
 /// variable services. \r
 ///\r
 struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI {\r
-  EFI_PEI_GET_VARIABLE2       GetVariable;\r
-  EFI_PEI_NEXT_VARIABLE_NAME2 NextVariableName;\r
+  EFI_PEI_GET_VARIABLE2           GetVariable;\r
+  EFI_PEI_GET_NEXT_VARIABLE_NAME2 NextVariableName;\r
 };\r
 \r
 extern EFI_GUID gEfiPeiReadOnlyVariable2PpiGuid;\r