if it's in recovery mode, variable region is unreliable, so the ReadOnlyVariable2Ppi...

[mirror_edk2.git] / MdeModulePkg / Universal / Variable / Pei / Variable.h

diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.h b/MdeModulePkg/Universal/Variable/Pei/Variable.h
index 963a50b961175cabd03b0726e7daa74e7e93ba5d..ea217dbdf0c3258205af7622baa1b432b6d2142f 100644 (file)
--- a/MdeModulePkg/Universal/Variable/Pei/Variable.h
+++ b/MdeModulePkg/Universal/Variable/Pei/Variable.h
@@ -3,7 +3,7 @@
   The internal header file includes the common header files, defines\r
   internal structure and functions used by PeiVariable module.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
 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
@@ -153,4 +153,80 @@ PeiGetNextVariableName (
   IN OUT EFI_GUID                           *VariableGuid\r
   );\r
 \r
+\r
+/**\r
+  This service retrieves a variable's value using its name and GUID.\r
+\r
+  Read the specified variable from the UEFI variable store. If the Data \r
+  buffer is too small to hold the contents of the variable, the error\r
+  EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the required buffer\r
+  size to obtain the data.\r
+\r
+  @param  This                  A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.\r
+  @param  VariableName          A pointer to a null-terminated string that is the variable's name.\r
+  @param  VariableGuid          A pointer to an EFI_GUID that is the variable's GUID. The combination of\r
+                                VariableGuid and VariableName must be unique.\r
+  @param  Attributes            If non-NULL, on return, points to the variable's attributes.\r
+  @param  DataSize              On entry, points to the size in bytes of the Data buffer.\r
+                                On return, points to the size of the data returned in Data.\r
+  @param  Data                  Points to the buffer which will hold the returned variable value.\r
+\r
+  @retval EFI_SUCCESS           The variable was read successfully.\r
+  @retval EFI_NOT_FOUND         The variable could not be found.\r
+  @retval EFI_BUFFER_TOO_SMALL  The DataSize is too small for the resulting data. \r
+                                DataSize is updated with the size required for \r
+                                the specified variable.\r
+  @retval EFI_INVALID_PARAMETER VariableName, VariableGuid, DataSize or Data is NULL.\r
+  @retval EFI_DEVICE_ERROR      The variable could not be retrieved because of a device error.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PeiGetVariableRecovery (\r
+  IN CONST  EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
+  IN CONST  CHAR16                          *VariableName,\r
+  IN CONST  EFI_GUID                        *VariableGuid,\r
+  OUT       UINT32                          *Attributes,\r
+  IN OUT    UINTN                           *DataSize,\r
+  OUT       VOID                            *Data\r
+  );\r
+\r
+/**\r
+  Return the next variable name and GUID.\r
+\r
+  This function is called multiple times to retrieve the VariableName \r
+  and VariableGuid of all variables currently available in the system. \r
+  On each call, the previous results are passed into the interface, \r
+  and, on return, the interface returns the data for the next \r
+  interface. When the entire variable list has been returned, \r
+  EFI_NOT_FOUND is returned.\r
+\r
+  @param  This              A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.\r
+\r
+  @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
+\r
+  @param  VariableGuid      On entry, a pointer to an UEFI _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
+  @retval EFI_NOT_FOUND         The variable could not be found.\r
+  @retval EFI_BUFFER_TOO_SMALL  The VariableNameSize is too small for the resulting\r
+                                data. VariableNameSize is updated with the size\r
+                                required for the specified variable.\r
+  @retval EFI_INVALID_PARAMETER VariableName, VariableGuid or\r
+                                VariableNameSize is NULL.\r
+  @retval EFI_DEVICE_ERROR      The variable could not be retrieved because of a device error.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PeiGetNextVariableNameRecovery (\r
+  IN CONST  EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
+  IN OUT UINTN                              *VariableNameSize,\r
+  IN OUT CHAR16                             *VariableName,\r
+  IN OUT EFI_GUID                           *VariableGuid\r
+  );\r
+\r
 #endif\r