4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This file declares Read-only Variable Service2 PPI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This ppi permits read-only access to the UEFI variable store during the PEI phase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This PPI is introduced in PI Version 1.0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { 0x2ab86ef5, 0xecb5, 0x4134, { 0xb5, 0x56, 0x38, 0x54, 0xca, 0x1f, 0xe1, 0xb4 } }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI EFI_PEI_READ_ONLY_VARIABLE2_PPI;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service retrieves a variable's value using its name and GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Read the specified variable from the UEFI variable store. If the Data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer is too small to hold the contents of the variable,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the error EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync required buffer size to obtain the data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VariableName A pointer to a null-terminated string that is the variable's name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VariableGuid A pointer to an EFI_GUID that is the variable's GUID. The combination of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VariableGuid and VariableName must be unique.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes If non-NULL, on return, points to the variable's attributes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataSize On entry, points to the size in bytes of the Data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On return, points to the size of the data returned in Data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data Points to the buffer which will hold the returned variable value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The variable was read successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The variable could not be found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the resulting data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DataSize is updated with the size required for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the specified variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER VariableName, VariableGuid, DataSize or Data is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The variable could not be retrieved because of a device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return the next variable name and GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is called multiple times to retrieve the VariableName
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and VariableGuid of all variables currently available in the system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On each call, the previous results are passed into the interface,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and, on return, the interface returns the data for the next
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync interface. When the entire variable list has been returned,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_NOT_FOUND is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VariableNameSize On entry, points to the size of the buffer pointed to by VariableName.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On return, the size of the variable name buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VariableName On entry, a pointer to a null-terminated string that is the variable's name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On return, points to the next variable's null-terminated name string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VariableGuid On entry, a pointer to an EFI_GUID that is the variable's GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On return, a pointer to the next variable's GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The variable was read successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The variable could not be found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the resulting
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data. VariableNameSize is updated with the size
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync required for the specified variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER VariableName, VariableGuid or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VariableNameSize is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The variable could not be retrieved because of a device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This PPI provides a lightweight, read-only variant of the full EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// variable services.