X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FPpi%2FReadOnlyVariable.h;h=0cdd61266b0794f43759e055074b76f50196c24d;hp=87d2dc35e665d17b7b04cf76ad5102f8cd87dcb7;hb=f22f941ed273753a0426d1234869857f19c28664;hpb=a89fa50ccf7a29405e3d24c49625dbd70cdba9fa

diff --git a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
index 87d2dc35e6..0cdd61266b 100644
--- a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
+++ b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
@@ -4,17 +4,17 @@
   These services provide a lightweight, read-only variant of the full EFI variable services. The
   reason that these services are read-only is to reduce the complexity of flash management. Also,
   some implementation of the PEI may use the same physical flash part for variable and PEIM
-  storage; as such, a write command to certain technologies would alter the contents of the entire part,
-  thus making the in situ PEIM execution not follow the required flow.
-
-  Copyright (c) 2006 - 2009, Intel Corporation
-  All rights reserved. This program and the accompanying materials
-  are licensed and made available under the terms and conditions of the BSD License
-  which accompanies this distribution.  The full text of the license may be found at
-  http://opensource.org/licenses/bsd-license.php
-
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+  storage. As such, a write command to certain technologies would alter the contents of the entire part,
+  making the PEIM execution in the original position not follow the required flow.
+
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>
+This program and the accompanying materials are licensed and made available under 
+the terms and conditions of the BSD License that accompanies this distribution.  
+The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.                                          
+    
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   @par Revision Reference:
   This PPI is defined in PEI CIS
@@ -32,7 +32,7 @@
 typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI  EFI_PEI_READ_ONLY_VARIABLE_PPI;
 
 ///
-/// Variable attributes
+/// Variable attributes.
 ///@{
 #define EFI_VARIABLE_NON_VOLATILE       0x00000001
 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
@@ -46,9 +46,10 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI  EFI_PEI_READ_ONLY_VARIABLE_PPI;
 ///@}
 
 /**
-  Get Variable value by Name and GUID pair
+  Get Variable value by Name and GUID pair.
 
-  @param[in]  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.
+  @param[in]  PeiServices    An indirect pointer to the PEI Services Table published 
+                             by the PEI Foundation.
   @param[in]  VariableName   A NULL-terminated Unicode string that is the name of the vendor's variable.
   @param[in]  VendorGuid     A unique identifier for the vendor.
   @param[out] Attributes     This OPTIONAL parameter may be either NULL or
@@ -83,20 +84,23 @@ EFI_STATUS
   and on output the interface returns the next variable name data.  When the
   entire variable list has been returned, the error EFI_NOT_FOUND is returned.
 
-  @param[in]  PeiServices       An indirect pointer to the PEI Services Table published by the PEI Foundation.
+  @param[in]  PeiServices       An indirect pointer to the PEI Services Table 
+                                published by the PEI Foundation.
   @param[in]  VariableNameSize  The size of the VariableName buffer.
   @param[in]  VariableName      On input, supplies the last VariableName that was
-                                returned by GetNextVariableName(). On output, returns the Null-terminated
-                                Unicode string of the current variable.
+                                returned by GetNextVariableName(). On output, 
+                                returns the Null-terminated Unicode string of the 
+                                current variable.
   @param[in]  VendorGuid        On input, supplies the last VendorGuid that was
-                                returned by GetNextVariableName(). On output, returns the VendorGuid
-                                of the current variable.
+                                returned by GetNextVariableName(). On output, 
+                                returns the VendorGuid of the current variable.
 
   @retval EFI_SUCCESS           The function completed successfully.
   @retval EFI_NOT_FOUND         The next variable was not found.
   @retval EFI_BUFFER_TOO_SMALL  The VariableNameSize is too small for the result.
   @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
-  @retval EFI_DEVICE_ERROR      The variable name could not be retrieved due to a hardware error.
+  @retval EFI_DEVICE_ERROR      The variable name could not be retrieved due to 
+                                a hardware error.
 
 **/
 typedef
@@ -116,7 +120,7 @@ struct _EFI_PEI_READ_ONLY_VARIABLE_PPI {
 	///
   /// Inconsistent with specification here: 
   /// In Framework Spec, PeiCis0.91, the field is named as GetVariable and GetNextVariableName.
-  /// Keeping this inconsistance is for backward compatibility.
+  /// Keeping this inconsistancy for backward compatibility.
 	/// 
   EFI_PEI_GET_VARIABLE            PeiGetVariable;         ///< A service to ascertain a given variable name.
   EFI_PEI_GET_NEXT_VARIABLE_NAME  PeiGetNextVariableName; ///< A service to ascertain a variable based upon a given, known variable