1 /** @file 2 The internal header file includes the common header files, defines 3 internal structure and functions used by PeiVariable module. 4 5 Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR> 6 This program and the accompanying materials 7 are licensed and made available under the terms and conditions of the BSD License 8 which accompanies this distribution. The full text of the license may be found at 9 http://opensource.org/licenses/bsd-license.php 10 11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, 12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 13 14 **/ 15 16 #ifndef _PEI_VARIABLE_H_ 17 #define _PEI_VARIABLE_H_ 18 19 #include <PiPei.h> 20 #include <Ppi/ReadOnlyVariable2.h> 21 22 #include <Library/DebugLib.h> 23 #include <Library/PeimEntryPoint.h> 24 #include <Library/HobLib.h> 25 #include <Library/PcdLib.h> 26 #include <Library/BaseMemoryLib.h> 27 #include <Library/PeiServicesTablePointerLib.h> 28 #include <Library/PeiServicesLib.h> 29 30 #include <Guid/VariableFormat.h> 31 #include <Guid/VariableIndexTable.h> 32 #include <Guid/SystemNvDataGuid.h> 33 #include <Guid/FaultTolerantWrite.h> 34 35 typedef enum { 36 VariableStoreTypeHob, 37 VariableStoreTypeNv, 38 VariableStoreTypeMax 39 } VARIABLE_STORE_TYPE; 40 41 typedef struct { 42 VARIABLE_STORE_HEADER *VariableStoreHeader; 43 VARIABLE_INDEX_TABLE *IndexTable; 44 // 45 // If it is not NULL, it means there may be an inconsecutive variable whose 46 // partial content is still in NV storage, but another partial content is backed up 47 // in spare block. 48 // 49 FAULT_TOLERANT_WRITE_LAST_WRITE_DATA *FtwLastWriteData; 50 BOOLEAN AuthFlag; 51 } VARIABLE_STORE_INFO; 52 53 // 54 // Functions 55 // 56 /** 57 Provide the functionality of the variable services. 58 59 @param FileHandle Handle of the file being invoked. 60 Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile(). 61 @param PeiServices General purpose services available to every PEIM. 62 63 @retval EFI_SUCCESS If the interface could be successfully installed 64 @retval Others Returned from PeiServicesInstallPpi() 65 66 **/ 67 EFI_STATUS 68 EFIAPI 69 PeimInitializeVariableServices ( 70 IN EFI_PEI_FILE_HANDLE FileHandle, 71 IN CONST EFI_PEI_SERVICES **PeiServices 72 ); 73 74 /** 75 This service retrieves a variable's value using its name and GUID. 76 77 Read the specified variable from the UEFI variable store. If the Data 78 buffer is too small to hold the contents of the variable, the error 79 EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the required buffer 80 size to obtain the data. 81 82 @param This A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI. 83 @param VariableName A pointer to a null-terminated string that is the variable's name. 84 @param VariableGuid A pointer to an EFI_GUID that is the variable's GUID. The combination of 85 VariableGuid and VariableName must be unique. 86 @param Attributes If non-NULL, on return, points to the variable's attributes. 87 @param DataSize On entry, points to the size in bytes of the Data buffer. 88 On return, points to the size of the data returned in Data. 89 @param Data Points to the buffer which will hold the returned variable value. 90 91 @retval EFI_SUCCESS The variable was read successfully. 92 @retval EFI_NOT_FOUND The variable could not be found. 93 @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the resulting data. 94 DataSize is updated with the size required for 95 the specified variable. 96 @retval EFI_INVALID_PARAMETER VariableName, VariableGuid, DataSize or Data is NULL. 97 @retval EFI_DEVICE_ERROR The variable could not be retrieved because of a device error. 98 99 **/ 100 EFI_STATUS 101 EFIAPI 102 PeiGetVariable ( 103 IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This, 104 IN CONST CHAR16 *VariableName, 105 IN CONST EFI_GUID *VariableGuid, 106 OUT UINT32 *Attributes, 107 IN OUT UINTN *DataSize, 108 OUT VOID *Data 109 ); 110 111 /** 112 Return the next variable name and GUID. 113 114 This function is called multiple times to retrieve the VariableName 115 and VariableGuid of all variables currently available in the system. 116 On each call, the previous results are passed into the interface, 117 and, on return, the interface returns the data for the next 118 interface. When the entire variable list has been returned, 119 EFI_NOT_FOUND is returned. 120 121 @param This A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI. 122 123 @param VariableNameSize On entry, points to the size of the buffer pointed to by VariableName. 124 @param VariableName On entry, a pointer to a null-terminated string that is the variable's name. 125 On return, points to the next variable's null-terminated name string. 126 127 @param VariableGuid On entry, a pointer to an UEFI _GUID that is the variable's GUID. 128 On return, a pointer to the next variable's GUID. 129 130 @retval EFI_SUCCESS The variable was read successfully. 131 @retval EFI_NOT_FOUND The variable could not be found. 132 @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the resulting 133 data. VariableNameSize is updated with the size 134 required for the specified variable. 135 @retval EFI_INVALID_PARAMETER VariableName, VariableGuid or 136 VariableNameSize is NULL. 137 @retval EFI_DEVICE_ERROR The variable could not be retrieved because of a device error. 138 139 **/ 140 EFI_STATUS 141 EFIAPI 142 PeiGetNextVariableName ( 143 IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This, 144 IN OUT UINTN *VariableNameSize, 145 IN OUT CHAR16 *VariableName, 146 IN OUT EFI_GUID *VariableGuid 147 ); 148 149 #endif 150
