-/*++\r
+/** @file\r
+ 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 - 2007 Intel Corporation. <BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2018, 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
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-Module Name:\r
\r
- Variable.c\r
-\r
-Abstract:\r
-\r
- Framework PEIM to provide the Variable functionality\r
-\r
---*/\r
+**/\r
\r
\r
#include "Variable.h"\r
//\r
// Module globals\r
//\r
-static EFI_PEI_READ_ONLY_VARIABLE2_PPI mVariablePpi = {\r
+EFI_PEI_READ_ONLY_VARIABLE2_PPI mVariablePpi = {\r
PeiGetVariable,\r
PeiGetNextVariableName\r
};\r
\r
-static EFI_PEI_PPI_DESCRIPTOR mPpiListVariable = {\r
+EFI_PEI_PPI_DESCRIPTOR mPpiListVariable = {\r
(EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
&gEfiPeiReadOnlyVariable2PpiGuid,\r
&mVariablePpi\r
};\r
\r
-EFI_GUID mEfiVariableIndexTableGuid = EFI_VARIABLE_INDEX_TABLE_GUID;\r
\r
+/**\r
+ Provide the functionality of the variable services.\r
+\r
+ @param FileHandle Handle of the file being invoked.\r
+ Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().\r
+ @param PeiServices General purpose services available to every PEIM.\r
+\r
+ @retval EFI_SUCCESS If the interface could be successfully installed\r
+ @retval Others Returned from PeiServicesInstallPpi()\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeimInitializeVariableServices (\r
- IN EFI_FFS_FILE_HEADER *FfsHeader,\r
- IN EFI_PEI_SERVICES **PeiServices\r
+ IN EFI_PEI_FILE_HANDLE FileHandle,\r
+ IN CONST EFI_PEI_SERVICES **PeiServices\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Provide the functionality of the variable services.\r
+{\r
+ return PeiServicesInstallPpi (&mPpiListVariable);\r
+}\r
\r
-Arguments:\r
+/**\r
\r
- FfsHeadher - The FFS file header\r
- PeiServices - General purpose services available to every PEIM.\r
+ Gets the pointer to the first variable header in given variable store area.\r
\r
-Returns:\r
+ @param VarStoreHeader Pointer to the Variable Store Header.\r
\r
- Status - EFI_SUCCESS if the interface could be successfully\r
- installed\r
+ @return Pointer to the first variable header\r
\r
---*/\r
+**/\r
+VARIABLE_HEADER *\r
+GetStartPointer (\r
+ IN VARIABLE_STORE_HEADER *VarStoreHeader\r
+ )\r
{\r
//\r
- // Publish the variable capability to other modules\r
+ // The end of variable store\r
//\r
- return (**PeiServices).InstallPpi ((CONST EFI_PEI_SERVICES **)PeiServices, &mPpiListVariable);\r
-\r
+ return (VARIABLE_HEADER *) HEADER_ALIGN (VarStoreHeader + 1);\r
}\r
\r
-STATIC\r
+\r
+/**\r
+ This code gets the pointer to the last variable memory pointer byte.\r
+\r
+ @param VarStoreHeader Pointer to the Variable Store Header.\r
+\r
+ @return VARIABLE_HEADER* pointer to last unavailable Variable Header.\r
+\r
+**/\r
VARIABLE_HEADER *\r
-GetNextVariablePtr (\r
- IN VARIABLE_HEADER *Variable\r
+GetEndPointer (\r
+ IN VARIABLE_STORE_HEADER *VarStoreHeader\r
)\r
-/*++\r
+{\r
+ //\r
+ // The end of variable store\r
+ //\r
+ return (VARIABLE_HEADER *) HEADER_ALIGN ((UINTN) VarStoreHeader + VarStoreHeader->Size);\r
+}\r
\r
-Routine Description:\r
\r
+/**\r
This code checks if variable header is valid or not.\r
\r
-Arguments:\r
- Variable Pointer to the Variable Header.\r
+ @param Variable Pointer to the Variable Header.\r
\r
-Returns:\r
- TRUE Variable header is valid.\r
- FALSE Variable header is not valid.\r
+ @retval TRUE Variable header is valid.\r
+ @retval FALSE Variable header is not valid.\r
\r
---*/\r
-{\r
- return (VARIABLE_HEADER *) ((UINTN) GET_VARIABLE_DATA_PTR (Variable) + Variable->DataSize + GET_PAD_SIZE (Variable->DataSize));\r
-}\r
-\r
-STATIC\r
+**/\r
BOOLEAN\r
-EFIAPI\r
IsValidVariableHeader (\r
IN VARIABLE_HEADER *Variable\r
)\r
-/*++\r
+{\r
+ if (Variable == NULL || Variable->StartId != VARIABLE_DATA ) {\r
+ return FALSE;\r
+ }\r
\r
-Routine Description:\r
+ return TRUE;\r
+}\r
\r
- This code checks if variable header is valid or not.\r
+/**\r
+ This code gets the size of variable header.\r
\r
-Arguments:\r
- Variable Pointer to the Variable Header.\r
+ @param AuthFlag Authenticated variable flag.\r
\r
-Returns:\r
- TRUE Variable header is valid.\r
- FALSE Variable header is not valid.\r
+ @return Size of variable header in bytes in type UINTN.\r
\r
---*/\r
+**/\r
+UINTN\r
+GetVariableHeaderSize (\r
+ IN BOOLEAN AuthFlag\r
+ )\r
{\r
- if (Variable == NULL ||\r
- Variable->StartId != VARIABLE_DATA ||\r
- (sizeof (VARIABLE_HEADER) + Variable->DataSize + Variable->NameSize) > MAX_VARIABLE_SIZE\r
- ) {\r
- return FALSE;\r
+ UINTN Value;\r
+\r
+ if (AuthFlag) {\r
+ Value = sizeof (AUTHENTICATED_VARIABLE_HEADER);\r
+ } else {\r
+ Value = sizeof (VARIABLE_HEADER);\r
}\r
\r
- return TRUE;\r
+ return Value;\r
}\r
\r
-STATIC\r
-VARIABLE_STORE_STATUS\r
-EFIAPI\r
-GetVariableStoreStatus (\r
- IN VARIABLE_STORE_HEADER *VarStoreHeader\r
+/**\r
+ This code gets the size of name of variable.\r
+\r
+ @param Variable Pointer to the Variable Header.\r
+ @param AuthFlag Authenticated variable flag.\r
+\r
+ @return Size of variable in bytes in type UINTN.\r
+\r
+**/\r
+UINTN\r
+NameSizeOfVariable (\r
+ IN VARIABLE_HEADER *Variable,\r
+ IN BOOLEAN AuthFlag\r
)\r
-/*++\r
+{\r
+ AUTHENTICATED_VARIABLE_HEADER *AuthVariable;\r
+\r
+ AuthVariable = (AUTHENTICATED_VARIABLE_HEADER *) Variable;\r
+ if (AuthFlag) {\r
+ if (AuthVariable->State == (UINT8) (-1) ||\r
+ AuthVariable->DataSize == (UINT32) (-1) ||\r
+ AuthVariable->NameSize == (UINT32) (-1) ||\r
+ AuthVariable->Attributes == (UINT32) (-1)) {\r
+ return 0;\r
+ }\r
+ return (UINTN) AuthVariable->NameSize;\r
+ } else {\r
+ if (Variable->State == (UINT8) (-1) ||\r
+ Variable->DataSize == (UINT32) (-1) ||\r
+ Variable->NameSize == (UINT32) (-1) ||\r
+ Variable->Attributes == (UINT32) (-1)) {\r
+ return 0;\r
+ }\r
+ return (UINTN) Variable->NameSize;\r
+ }\r
+}\r
+\r
\r
-Routine Description:\r
+/**\r
+ This code gets the size of data of variable.\r
\r
+ @param Variable Pointer to the Variable Header.\r
+ @param AuthFlag Authenticated variable flag.\r
+\r
+ @return Size of variable in bytes in type UINTN.\r
+\r
+**/\r
+UINTN\r
+DataSizeOfVariable (\r
+ IN VARIABLE_HEADER *Variable,\r
+ IN BOOLEAN AuthFlag\r
+ )\r
+{\r
+ AUTHENTICATED_VARIABLE_HEADER *AuthVariable;\r
+\r
+ AuthVariable = (AUTHENTICATED_VARIABLE_HEADER *) Variable;\r
+ if (AuthFlag) {\r
+ if (AuthVariable->State == (UINT8) (-1) ||\r
+ AuthVariable->DataSize == (UINT32) (-1) ||\r
+ AuthVariable->NameSize == (UINT32) (-1) ||\r
+ AuthVariable->Attributes == (UINT32) (-1)) {\r
+ return 0;\r
+ }\r
+ return (UINTN) AuthVariable->DataSize;\r
+ } else {\r
+ if (Variable->State == (UINT8) (-1) ||\r
+ Variable->DataSize == (UINT32) (-1) ||\r
+ Variable->NameSize == (UINT32) (-1) ||\r
+ Variable->Attributes == (UINT32) (-1)) {\r
+ return 0;\r
+ }\r
+ return (UINTN) Variable->DataSize;\r
+ }\r
+}\r
+\r
+/**\r
This code gets the pointer to the variable name.\r
\r
-Arguments:\r
+ @param Variable Pointer to the Variable Header.\r
+ @param AuthFlag Authenticated variable flag.\r
+\r
+ @return A CHAR16* pointer to Variable Name.\r
+\r
+**/\r
+CHAR16 *\r
+GetVariableNamePtr (\r
+ IN VARIABLE_HEADER *Variable,\r
+ IN BOOLEAN AuthFlag\r
+ )\r
+{\r
+ return (CHAR16 *) ((UINTN) Variable + GetVariableHeaderSize (AuthFlag));\r
+}\r
+\r
+/**\r
+ This code gets the pointer to the variable guid.\r
+\r
+ @param Variable Pointer to the Variable Header.\r
+ @param AuthFlag Authenticated variable flag.\r
\r
- VarStoreHeader Pointer to the Variable Store Header.\r
+ @return A EFI_GUID* pointer to Vendor Guid.\r
\r
-Returns:\r
+**/\r
+EFI_GUID *\r
+GetVendorGuidPtr (\r
+ IN VARIABLE_HEADER *Variable,\r
+ IN BOOLEAN AuthFlag\r
+ )\r
+{\r
+ AUTHENTICATED_VARIABLE_HEADER *AuthVariable;\r
+\r
+ AuthVariable = (AUTHENTICATED_VARIABLE_HEADER *) Variable;\r
+ if (AuthFlag) {\r
+ return &AuthVariable->VendorGuid;\r
+ } else {\r
+ return &Variable->VendorGuid;\r
+ }\r
+}\r
\r
- EfiRaw Variable store is raw\r
- EfiValid Variable store is valid\r
- EfiInvalid Variable store is invalid\r
+/**\r
+ This code gets the pointer to the variable data.\r
\r
---*/\r
+ @param Variable Pointer to the Variable Header.\r
+ @param VariableHeader Pointer to the Variable Header that has consecutive content.\r
+ @param AuthFlag Authenticated variable flag.\r
+\r
+ @return A UINT8* pointer to Variable Data.\r
+\r
+**/\r
+UINT8 *\r
+GetVariableDataPtr (\r
+ IN VARIABLE_HEADER *Variable,\r
+ IN VARIABLE_HEADER *VariableHeader,\r
+ IN BOOLEAN AuthFlag\r
+ )\r
+{\r
+ UINTN Value;\r
+\r
+ //\r
+ // Be careful about pad size for alignment\r
+ //\r
+ Value = (UINTN) GetVariableNamePtr (Variable, AuthFlag);\r
+ Value += NameSizeOfVariable (VariableHeader, AuthFlag);\r
+ Value += GET_PAD_SIZE (NameSizeOfVariable (VariableHeader, AuthFlag));\r
+\r
+ return (UINT8 *) Value;\r
+}\r
+\r
+\r
+/**\r
+ This code gets the pointer to the next variable header.\r
+\r
+ @param StoreInfo Pointer to variable store info structure.\r
+ @param Variable Pointer to the Variable Header.\r
+ @param VariableHeader Pointer to the Variable Header that has consecutive content.\r
+\r
+ @return A VARIABLE_HEADER* pointer to next variable header.\r
+\r
+**/\r
+VARIABLE_HEADER *\r
+GetNextVariablePtr (\r
+ IN VARIABLE_STORE_INFO *StoreInfo,\r
+ IN VARIABLE_HEADER *Variable,\r
+ IN VARIABLE_HEADER *VariableHeader\r
+ )\r
{\r
- if (VarStoreHeader->Signature == VARIABLE_STORE_SIGNATURE &&\r
+ EFI_PHYSICAL_ADDRESS TargetAddress;\r
+ EFI_PHYSICAL_ADDRESS SpareAddress;\r
+ UINTN Value;\r
+\r
+ Value = (UINTN) GetVariableDataPtr (Variable, VariableHeader, StoreInfo->AuthFlag);\r
+ Value += DataSizeOfVariable (VariableHeader, StoreInfo->AuthFlag);\r
+ Value += GET_PAD_SIZE (DataSizeOfVariable (VariableHeader, StoreInfo->AuthFlag));\r
+ //\r
+ // Be careful about pad size for alignment\r
+ //\r
+ Value = HEADER_ALIGN (Value);\r
+\r
+ if (StoreInfo->FtwLastWriteData != NULL) {\r
+ TargetAddress = StoreInfo->FtwLastWriteData->TargetAddress;\r
+ SpareAddress = StoreInfo->FtwLastWriteData->SpareAddress;\r
+ if (((UINTN) Variable < (UINTN) TargetAddress) && (Value >= (UINTN) TargetAddress)) {\r
+ //\r
+ // Next variable is in spare block.\r
+ //\r
+ Value = (UINTN) SpareAddress + (Value - (UINTN) TargetAddress);\r
+ }\r
+ }\r
+\r
+ return (VARIABLE_HEADER *) Value;\r
+}\r
+\r
+/**\r
+ Get variable store status.\r
+\r
+ @param VarStoreHeader Pointer to the Variable Store Header.\r
+\r
+ @retval EfiRaw Variable store is raw\r
+ @retval EfiValid Variable store is valid\r
+ @retval EfiInvalid Variable store is invalid\r
+\r
+**/\r
+VARIABLE_STORE_STATUS\r
+GetVariableStoreStatus (\r
+ IN VARIABLE_STORE_HEADER *VarStoreHeader\r
+ )\r
+{\r
+ if ((CompareGuid (&VarStoreHeader->Signature, &gEfiAuthenticatedVariableGuid) ||\r
+ CompareGuid (&VarStoreHeader->Signature, &gEfiVariableGuid)) &&\r
VarStoreHeader->Format == VARIABLE_STORE_FORMATTED &&\r
VarStoreHeader->State == VARIABLE_STORE_HEALTHY\r
) {\r
return EfiValid;\r
}\r
\r
- if (VarStoreHeader->Signature == 0xffffffff &&\r
+ if (((UINT32 *)(&VarStoreHeader->Signature))[0] == 0xffffffff &&\r
+ ((UINT32 *)(&VarStoreHeader->Signature))[1] == 0xffffffff &&\r
+ ((UINT32 *)(&VarStoreHeader->Signature))[2] == 0xffffffff &&\r
+ ((UINT32 *)(&VarStoreHeader->Signature))[3] == 0xffffffff &&\r
VarStoreHeader->Size == 0xffffffff &&\r
VarStoreHeader->Format == 0xff &&\r
VarStoreHeader->State == 0xff\r
}\r
}\r
\r
-STATIC\r
+/**\r
+ Compare two variable names, one of them may be inconsecutive.\r
+\r
+ @param StoreInfo Pointer to variable store info structure.\r
+ @param Name1 Pointer to one variable name.\r
+ @param Name2 Pointer to another variable name.\r
+ @param NameSize Variable name size.\r
+\r
+ @retval TRUE Name1 and Name2 are identical.\r
+ @retval FALSE Name1 and Name2 are not identical.\r
+\r
+**/\r
+BOOLEAN\r
+CompareVariableName (\r
+ IN VARIABLE_STORE_INFO *StoreInfo,\r
+ IN CONST CHAR16 *Name1,\r
+ IN CONST CHAR16 *Name2,\r
+ IN UINTN NameSize\r
+ )\r
+{\r
+ EFI_PHYSICAL_ADDRESS TargetAddress;\r
+ EFI_PHYSICAL_ADDRESS SpareAddress;\r
+ UINTN PartialNameSize;\r
+\r
+ if (StoreInfo->FtwLastWriteData != NULL) {\r
+ TargetAddress = StoreInfo->FtwLastWriteData->TargetAddress;\r
+ SpareAddress = StoreInfo->FtwLastWriteData->SpareAddress;\r
+ if (((UINTN) Name1 < (UINTN) TargetAddress) && (((UINTN) Name1 + NameSize) > (UINTN) TargetAddress)) {\r
+ //\r
+ // Name1 is inconsecutive.\r
+ //\r
+ PartialNameSize = (UINTN) TargetAddress - (UINTN) Name1;\r
+ //\r
+ // Partial content is in NV storage.\r
+ //\r
+ if (CompareMem ((UINT8 *) Name1, (UINT8 *) Name2, PartialNameSize) == 0) {\r
+ //\r
+ // Another partial content is in spare block.\r
+ //\r
+ if (CompareMem ((UINT8 *) (UINTN) SpareAddress, (UINT8 *) Name2 + PartialNameSize, NameSize - PartialNameSize) == 0) {\r
+ return TRUE;\r
+ }\r
+ }\r
+ return FALSE;\r
+ } else if (((UINTN) Name2 < (UINTN) TargetAddress) && (((UINTN) Name2 + NameSize) > (UINTN) TargetAddress)) {\r
+ //\r
+ // Name2 is inconsecutive.\r
+ //\r
+ PartialNameSize = (UINTN) TargetAddress - (UINTN) Name2;\r
+ //\r
+ // Partial content is in NV storage.\r
+ //\r
+ if (CompareMem ((UINT8 *) Name2, (UINT8 *) Name1, PartialNameSize) == 0) {\r
+ //\r
+ // Another partial content is in spare block.\r
+ //\r
+ if (CompareMem ((UINT8 *) (UINTN) SpareAddress, (UINT8 *) Name1 + PartialNameSize, NameSize - PartialNameSize) == 0) {\r
+ return TRUE;\r
+ }\r
+ }\r
+ return FALSE;\r
+ }\r
+ }\r
+\r
+ //\r
+ // Both Name1 and Name2 are consecutive.\r
+ //\r
+ if (CompareMem ((UINT8 *) Name1, (UINT8 *) Name2, NameSize) == 0) {\r
+ return TRUE;\r
+ }\r
+ return FALSE;\r
+}\r
+\r
+/**\r
+ This function compares a variable with variable entries in database.\r
+\r
+ @param StoreInfo Pointer to variable store info structure.\r
+ @param Variable Pointer to the variable in our database\r
+ @param VariableHeader Pointer to the Variable Header that has consecutive content.\r
+ @param VariableName Name of the variable to compare to 'Variable'\r
+ @param VendorGuid GUID of the variable to compare to 'Variable'\r
+ @param PtrTrack Variable Track Pointer structure that contains Variable Information.\r
+\r
+ @retval EFI_SUCCESS Found match variable\r
+ @retval EFI_NOT_FOUND Variable not found\r
+\r
+**/\r
EFI_STATUS\r
CompareWithValidVariable (\r
+ IN VARIABLE_STORE_INFO *StoreInfo,\r
IN VARIABLE_HEADER *Variable,\r
+ IN VARIABLE_HEADER *VariableHeader,\r
IN CONST CHAR16 *VariableName,\r
IN CONST EFI_GUID *VendorGuid,\r
OUT VARIABLE_POINTER_TRACK *PtrTrack\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- This function compares a variable with variable entries in database\r
-\r
-Arguments:\r
-\r
- Variable - Pointer to the variable in our database\r
- VariableName - Name of the variable to compare to 'Variable'\r
- VendorGuid - GUID of the variable to compare to 'Variable'\r
- PtrTrack - Variable Track Pointer structure that contains\r
- Variable Information.\r
-\r
-Returns:\r
+{\r
+ VOID *Point;\r
+ EFI_GUID *TempVendorGuid;\r
\r
- EFI_SUCCESS - Found match variable\r
- EFI_NOT_FOUND - Variable not found\r
+ TempVendorGuid = GetVendorGuidPtr (VariableHeader, StoreInfo->AuthFlag);\r
\r
---*/\r
-{\r
if (VariableName[0] == 0) {\r
PtrTrack->CurrPtr = Variable;\r
return EFI_SUCCESS;\r
// Instead we compare the GUID a UINT32 at a time and branch\r
// on the first failed comparison.\r
//\r
- if ((((INT32 *) VendorGuid)[0] == ((INT32 *) &Variable->VendorGuid)[0]) &&\r
- (((INT32 *) VendorGuid)[1] == ((INT32 *) &Variable->VendorGuid)[1]) &&\r
- (((INT32 *) VendorGuid)[2] == ((INT32 *) &Variable->VendorGuid)[2]) &&\r
- (((INT32 *) VendorGuid)[3] == ((INT32 *) &Variable->VendorGuid)[3])\r
+ if ((((INT32 *) VendorGuid)[0] == ((INT32 *) TempVendorGuid)[0]) &&\r
+ (((INT32 *) VendorGuid)[1] == ((INT32 *) TempVendorGuid)[1]) &&\r
+ (((INT32 *) VendorGuid)[2] == ((INT32 *) TempVendorGuid)[2]) &&\r
+ (((INT32 *) VendorGuid)[3] == ((INT32 *) TempVendorGuid)[3])\r
) {\r
- if (!CompareMem (VariableName, GET_VARIABLE_NAME_PTR (Variable), Variable->NameSize)) {\r
+ ASSERT (NameSizeOfVariable (VariableHeader, StoreInfo->AuthFlag) != 0);\r
+ Point = (VOID *) GetVariableNamePtr (Variable, StoreInfo->AuthFlag);\r
+ if (CompareVariableName (StoreInfo, VariableName, Point, NameSizeOfVariable (VariableHeader, StoreInfo->AuthFlag))) {\r
PtrTrack->CurrPtr = Variable;\r
return EFI_SUCCESS;\r
}\r
return EFI_NOT_FOUND;\r
}\r
\r
-STATIC\r
-EFI_STATUS\r
-EFIAPI\r
-FindVariable (\r
- IN EFI_PEI_SERVICES **PeiServices,\r
- IN CONST CHAR16 *VariableName,\r
- IN CONST EFI_GUID *VendorGuid,\r
- OUT VARIABLE_POINTER_TRACK *PtrTrack\r
+/**\r
+ Get HOB variable store.\r
+\r
+**/\r
+VOID\r
+GetHobVariableStore (\r
+ OUT VARIABLE_STORE_INFO *StoreInfo,\r
+ OUT VARIABLE_STORE_HEADER **VariableStoreHeader\r
+ )\r
+{\r
+ EFI_HOB_GUID_TYPE *GuidHob;\r
+\r
+ GuidHob = GetFirstGuidHob (&gEfiAuthenticatedVariableGuid);\r
+ if (GuidHob != NULL) {\r
+ *VariableStoreHeader = (VARIABLE_STORE_HEADER *) GET_GUID_HOB_DATA (GuidHob);\r
+ StoreInfo->AuthFlag = TRUE;\r
+ } else {\r
+ GuidHob = GetFirstGuidHob (&gEfiVariableGuid);\r
+ if (GuidHob != NULL) {\r
+ *VariableStoreHeader = (VARIABLE_STORE_HEADER *) GET_GUID_HOB_DATA (GuidHob);\r
+ StoreInfo->AuthFlag = FALSE;\r
+ }\r
+ }\r
+}\r
+\r
+/**\r
+ Return the variable store header and the store info based on the Index.\r
+\r
+ @param Type The type of the variable store.\r
+ @param StoreInfo Return the store info.\r
+\r
+ @return Pointer to the variable store header.\r
+**/\r
+VARIABLE_STORE_HEADER *\r
+GetVariableStore (\r
+ IN VARIABLE_STORE_TYPE Type,\r
+ OUT VARIABLE_STORE_INFO *StoreInfo\r
)\r
-/*++\r
+{\r
+ EFI_HOB_GUID_TYPE *GuidHob;\r
+ EFI_FIRMWARE_VOLUME_HEADER *FvHeader;\r
+ VARIABLE_STORE_HEADER *VariableStoreHeader;\r
+ EFI_PHYSICAL_ADDRESS NvStorageBase;\r
+ UINT32 NvStorageSize;\r
+ FAULT_TOLERANT_WRITE_LAST_WRITE_DATA *FtwLastWriteData;\r
+ UINT32 BackUpOffset;\r
+\r
+ StoreInfo->IndexTable = NULL;\r
+ StoreInfo->FtwLastWriteData = NULL;\r
+ StoreInfo->AuthFlag = FALSE;\r
+ VariableStoreHeader = NULL;\r
+ switch (Type) {\r
+ case VariableStoreTypeHob:\r
+ GetHobVariableStore (StoreInfo, &VariableStoreHeader);\r
+\r
+ break;\r
+\r
+ case VariableStoreTypeNv:\r
+ if (GetBootModeHob () != BOOT_IN_RECOVERY_MODE) {\r
+ //\r
+ // The content of NV storage for variable is not reliable in recovery boot mode.\r
+ //\r
+\r
+ NvStorageSize = PcdGet32 (PcdFlashNvStorageVariableSize);\r
+ NvStorageBase = (EFI_PHYSICAL_ADDRESS) (PcdGet64 (PcdFlashNvStorageVariableBase64) != 0 ?\r
+ PcdGet64 (PcdFlashNvStorageVariableBase64) :\r
+ PcdGet32 (PcdFlashNvStorageVariableBase)\r
+ );\r
+ //\r
+ // First let FvHeader point to NV storage base.\r
+ //\r
+ FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) (UINTN) NvStorageBase;\r
+\r
+ //\r
+ // Check the FTW last write data hob.\r
+ //\r
+ BackUpOffset = 0;\r
+ GuidHob = GetFirstGuidHob (&gEdkiiFaultTolerantWriteGuid);\r
+ if (GuidHob != NULL) {\r
+ FtwLastWriteData = (FAULT_TOLERANT_WRITE_LAST_WRITE_DATA *) GET_GUID_HOB_DATA (GuidHob);\r
+ if (FtwLastWriteData->TargetAddress == NvStorageBase) {\r
+ //\r
+ // Let FvHeader point to spare block.\r
+ //\r
+ FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) (UINTN) FtwLastWriteData->SpareAddress;\r
+ DEBUG ((EFI_D_INFO, "PeiVariable: NV storage is backed up in spare block: 0x%x\n", (UINTN) FtwLastWriteData->SpareAddress));\r
+ } else if ((FtwLastWriteData->TargetAddress > NvStorageBase) && (FtwLastWriteData->TargetAddress < (NvStorageBase + NvStorageSize))) {\r
+ StoreInfo->FtwLastWriteData = FtwLastWriteData;\r
+ //\r
+ // Flash NV storage from the offset is backed up in spare block.\r
+ //\r
+ BackUpOffset = (UINT32) (FtwLastWriteData->TargetAddress - NvStorageBase);\r
+ DEBUG ((EFI_D_INFO, "PeiVariable: High partial NV storage from offset: %x is backed up in spare block: 0x%x\n", BackUpOffset, (UINTN) FtwLastWriteData->SpareAddress));\r
+ //\r
+ // At least one block data in flash NV storage is still valid, so still leave FvHeader point to NV storage base.\r
+ //\r
+ }\r
+ }\r
+\r
+ //\r
+ // Check if the Firmware Volume is not corrupted\r
+ //\r
+ if ((FvHeader->Signature != EFI_FVH_SIGNATURE) || (!CompareGuid (&gEfiSystemNvDataFvGuid, &FvHeader->FileSystemGuid))) {\r
+ DEBUG ((EFI_D_ERROR, "Firmware Volume for Variable Store is corrupted\n"));\r
+ break;\r
+ }\r
\r
-Routine Description:\r
+ VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINT8 *) FvHeader + FvHeader->HeaderLength);\r
\r
- This code finds variable in storage blocks (Non-Volatile)\r
+ StoreInfo->AuthFlag = (BOOLEAN) (CompareGuid (&VariableStoreHeader->Signature, &gEfiAuthenticatedVariableGuid));\r
\r
-Arguments:\r
+ GuidHob = GetFirstGuidHob (&gEfiVariableIndexTableGuid);\r
+ if (GuidHob != NULL) {\r
+ StoreInfo->IndexTable = GET_GUID_HOB_DATA (GuidHob);\r
+ } else {\r
+ //\r
+ // If it's the first time to access variable region in flash, create a guid hob to record\r
+ // VAR_ADDED type variable info.\r
+ // Note that as the resource of PEI phase is limited, only store the limited number of\r
+ // VAR_ADDED type variables to reduce access time.\r
+ //\r
+ StoreInfo->IndexTable = (VARIABLE_INDEX_TABLE *) BuildGuidHob (&gEfiVariableIndexTableGuid, sizeof (VARIABLE_INDEX_TABLE));\r
+ StoreInfo->IndexTable->Length = 0;\r
+ StoreInfo->IndexTable->StartPtr = GetStartPointer (VariableStoreHeader);\r
+ StoreInfo->IndexTable->EndPtr = GetEndPointer (VariableStoreHeader);\r
+ StoreInfo->IndexTable->GoneThrough = 0;\r
+ }\r
+ }\r
+ break;\r
+\r
+ default:\r
+ ASSERT (FALSE);\r
+ break;\r
+ }\r
+\r
+ StoreInfo->VariableStoreHeader = VariableStoreHeader;\r
+ return VariableStoreHeader;\r
+}\r
\r
- PeiServices - General purpose services available to every PEIM.\r
- VariableName - Name of the variable to be found\r
- VendorGuid - Vendor GUID to be found.\r
- PtrTrack - Variable Track Pointer structure that contains\r
- Variable Information.\r
+/**\r
+ Get variable header that has consecutive content.\r
\r
-Returns:\r
+ @param StoreInfo Pointer to variable store info structure.\r
+ @param Variable Pointer to the Variable Header.\r
+ @param VariableHeader Pointer to Pointer to the Variable Header that has consecutive content.\r
\r
- EFI_SUCCESS - Variable found successfully\r
- EFI_NOT_FOUND - Variable not found\r
- EFI_INVALID_PARAMETER - Invalid variable name\r
+ @retval TRUE Variable header is valid.\r
+ @retval FALSE Variable header is not valid.\r
\r
---*/\r
+**/\r
+BOOLEAN\r
+GetVariableHeader (\r
+ IN VARIABLE_STORE_INFO *StoreInfo,\r
+ IN VARIABLE_HEADER *Variable,\r
+ OUT VARIABLE_HEADER **VariableHeader\r
+ )\r
{\r
- EFI_HOB_GUID_TYPE *GuidHob;\r
- VARIABLE_STORE_HEADER *VariableStoreHeader;\r
- VARIABLE_HEADER *Variable;\r
- VARIABLE_HEADER *MaxIndex;\r
- VARIABLE_INDEX_TABLE *IndexTable;\r
- UINT32 Count;\r
- UINT8 *VariableBase;\r
+ EFI_PHYSICAL_ADDRESS TargetAddress;\r
+ EFI_PHYSICAL_ADDRESS SpareAddress;\r
+ EFI_HOB_GUID_TYPE *GuidHob;\r
+ UINTN PartialHeaderSize;\r
\r
- if (VariableName != 0 && VendorGuid == NULL) {\r
- return EFI_INVALID_PARAMETER;\r
+ if (Variable == NULL) {\r
+ return FALSE;\r
}\r
+\r
//\r
- // No Variable Address equals zero, so 0 as initial value is safe.\r
+ // First assume variable header pointed by Variable is consecutive.\r
//\r
- MaxIndex = 0;\r
-\r
- GuidHob = GetFirstGuidHob (&mEfiVariableIndexTableGuid);\r
- if (GuidHob == NULL) {\r
- IndexTable = BuildGuidHob (&mEfiVariableIndexTableGuid, sizeof (VARIABLE_INDEX_TABLE));\r
- IndexTable->Length = 0;\r
- IndexTable->StartPtr = NULL;\r
- IndexTable->EndPtr = NULL;\r
- IndexTable->GoneThrough = 0;\r
- } else {\r
- IndexTable = GET_GUID_HOB_DATA (GuidHob);\r
- for (Count = 0; Count < IndexTable->Length; Count++)\r
- {\r
- MaxIndex = GetVariableByIndex (IndexTable, Count);\r
-\r
- if (CompareWithValidVariable (MaxIndex, VariableName, VendorGuid, PtrTrack) == EFI_SUCCESS) {\r
- PtrTrack->StartPtr = IndexTable->StartPtr;\r
- PtrTrack->EndPtr = IndexTable->EndPtr;\r
+ *VariableHeader = Variable;\r
\r
- return EFI_SUCCESS;\r
+ if (StoreInfo->FtwLastWriteData != NULL) {\r
+ TargetAddress = StoreInfo->FtwLastWriteData->TargetAddress;\r
+ SpareAddress = StoreInfo->FtwLastWriteData->SpareAddress;\r
+ if (((UINTN) Variable > (UINTN) SpareAddress) &&\r
+ (((UINTN) Variable - (UINTN) SpareAddress + (UINTN) TargetAddress) >= (UINTN) GetEndPointer (StoreInfo->VariableStoreHeader))) {\r
+ //\r
+ // Reach the end of variable store.\r
+ //\r
+ return FALSE;\r
+ }\r
+ if (((UINTN) Variable < (UINTN) TargetAddress) && (((UINTN) Variable + GetVariableHeaderSize (StoreInfo->AuthFlag)) > (UINTN) TargetAddress)) {\r
+ //\r
+ // Variable header pointed by Variable is inconsecutive,\r
+ // create a guid hob to combine the two partial variable header content together.\r
+ //\r
+ GuidHob = GetFirstGuidHob (&gEfiCallerIdGuid);\r
+ if (GuidHob != NULL) {\r
+ *VariableHeader = (VARIABLE_HEADER *) GET_GUID_HOB_DATA (GuidHob);\r
+ } else {\r
+ *VariableHeader = (VARIABLE_HEADER *) BuildGuidHob (&gEfiCallerIdGuid, GetVariableHeaderSize (StoreInfo->AuthFlag));\r
+ PartialHeaderSize = (UINTN) TargetAddress - (UINTN) Variable;\r
+ //\r
+ // Partial content is in NV storage.\r
+ //\r
+ CopyMem ((UINT8 *) *VariableHeader, (UINT8 *) Variable, PartialHeaderSize);\r
+ //\r
+ // Another partial content is in spare block.\r
+ //\r
+ CopyMem ((UINT8 *) *VariableHeader + PartialHeaderSize, (UINT8 *) (UINTN) SpareAddress, GetVariableHeaderSize (StoreInfo->AuthFlag) - PartialHeaderSize);\r
}\r
}\r
+ } else {\r
+ if (Variable >= GetEndPointer (StoreInfo->VariableStoreHeader)) {\r
+ //\r
+ // Reach the end of variable store.\r
+ //\r
+ return FALSE;\r
+ }\r
+ }\r
+\r
+ return IsValidVariableHeader (*VariableHeader);\r
+}\r
\r
- if (IndexTable->GoneThrough) {\r
- return EFI_NOT_FOUND;\r
+/**\r
+ Get variable name or data to output buffer.\r
+\r
+ @param StoreInfo Pointer to variable store info structure.\r
+ @param NameOrData Pointer to the variable name/data that may be inconsecutive.\r
+ @param Size Variable name/data size.\r
+ @param Buffer Pointer to output buffer to hold the variable name/data.\r
+\r
+**/\r
+VOID\r
+GetVariableNameOrData (\r
+ IN VARIABLE_STORE_INFO *StoreInfo,\r
+ IN UINT8 *NameOrData,\r
+ IN UINTN Size,\r
+ OUT UINT8 *Buffer\r
+ )\r
+{\r
+ EFI_PHYSICAL_ADDRESS TargetAddress;\r
+ EFI_PHYSICAL_ADDRESS SpareAddress;\r
+ UINTN PartialSize;\r
+\r
+ if (StoreInfo->FtwLastWriteData != NULL) {\r
+ TargetAddress = StoreInfo->FtwLastWriteData->TargetAddress;\r
+ SpareAddress = StoreInfo->FtwLastWriteData->SpareAddress;\r
+ if (((UINTN) NameOrData < (UINTN) TargetAddress) && (((UINTN) NameOrData + Size) > (UINTN) TargetAddress)) {\r
+ //\r
+ // Variable name/data is inconsecutive.\r
+ //\r
+ PartialSize = (UINTN) TargetAddress - (UINTN) NameOrData;\r
+ //\r
+ // Partial content is in NV storage.\r
+ //\r
+ CopyMem (Buffer, NameOrData, PartialSize);\r
+ //\r
+ // Another partial content is in spare block.\r
+ //\r
+ CopyMem (Buffer + PartialSize, (UINT8 *) (UINTN) SpareAddress, Size - PartialSize);\r
+ return;\r
}\r
}\r
+\r
//\r
- // If not found in HOB, then let's start from the MaxIndex we've found.\r
+ // Variable name/data is consecutive.\r
//\r
- if (MaxIndex != NULL) {\r
- Variable = GetNextVariablePtr (MaxIndex);\r
- } else {\r
- if (IndexTable->StartPtr || IndexTable->EndPtr) {\r
- Variable = IndexTable->StartPtr;\r
- } else {\r
- VariableBase = (UINT8 *) (UINTN) PcdGet32 (PcdFlashNvStorageVariableBase);\r
- VariableStoreHeader = (VARIABLE_STORE_HEADER *) (VariableBase + \\r
- ((EFI_FIRMWARE_VOLUME_HEADER *) (VariableBase)) -> HeaderLength);\r
+ CopyMem (Buffer, NameOrData, Size);\r
+}\r
\r
- if (GetVariableStoreStatus (VariableStoreHeader) != EfiValid) {\r
- return EFI_UNSUPPORTED;\r
- }\r
+/**\r
+ Find the variable in the specified variable store.\r
\r
- if (~VariableStoreHeader->Size == 0) {\r
- return EFI_NOT_FOUND;\r
+ @param StoreInfo Pointer to the store info structure.\r
+ @param VariableName Name of the variable to be found\r
+ @param VendorGuid Vendor GUID to be found.\r
+ @param PtrTrack Variable Track Pointer structure that contains Variable Information.\r
+\r
+ @retval EFI_SUCCESS Variable found successfully\r
+ @retval EFI_NOT_FOUND Variable not found\r
+ @retval EFI_INVALID_PARAMETER Invalid variable name\r
+\r
+**/\r
+EFI_STATUS\r
+FindVariableEx (\r
+ IN VARIABLE_STORE_INFO *StoreInfo,\r
+ IN CONST CHAR16 *VariableName,\r
+ IN CONST EFI_GUID *VendorGuid,\r
+ OUT VARIABLE_POINTER_TRACK *PtrTrack\r
+ )\r
+{\r
+ VARIABLE_HEADER *Variable;\r
+ VARIABLE_HEADER *LastVariable;\r
+ VARIABLE_HEADER *MaxIndex;\r
+ UINTN Index;\r
+ UINTN Offset;\r
+ BOOLEAN StopRecord;\r
+ VARIABLE_HEADER *InDeletedVariable;\r
+ VARIABLE_STORE_HEADER *VariableStoreHeader;\r
+ VARIABLE_INDEX_TABLE *IndexTable;\r
+ VARIABLE_HEADER *VariableHeader;\r
+\r
+ VariableStoreHeader = StoreInfo->VariableStoreHeader;\r
+\r
+ if (VariableStoreHeader == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ if (GetVariableStoreStatus (VariableStoreHeader) != EfiValid) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
+ if (~VariableStoreHeader->Size == 0) {\r
+ return EFI_NOT_FOUND;\r
+ }\r
+\r
+ IndexTable = StoreInfo->IndexTable;\r
+ PtrTrack->StartPtr = GetStartPointer (VariableStoreHeader);\r
+ PtrTrack->EndPtr = GetEndPointer (VariableStoreHeader);\r
+\r
+ InDeletedVariable = NULL;\r
+\r
+ //\r
+ // No Variable Address equals zero, so 0 as initial value is safe.\r
+ //\r
+ MaxIndex = NULL;\r
+ VariableHeader = NULL;\r
+\r
+ if (IndexTable != NULL) {\r
+ //\r
+ // traverse the variable index table to look for varible.\r
+ // The IndexTable->Index[Index] records the distance of two neighbouring VAR_ADDED type variables.\r
+ //\r
+ for (Offset = 0, Index = 0; Index < IndexTable->Length; Index++) {\r
+ ASSERT (Index < sizeof (IndexTable->Index) / sizeof (IndexTable->Index[0]));\r
+ Offset += IndexTable->Index[Index];\r
+ MaxIndex = (VARIABLE_HEADER *) ((UINT8 *) IndexTable->StartPtr + Offset);\r
+ GetVariableHeader (StoreInfo, MaxIndex, &VariableHeader);\r
+ if (CompareWithValidVariable (StoreInfo, MaxIndex, VariableHeader, VariableName, VendorGuid, PtrTrack) == EFI_SUCCESS) {\r
+ if (VariableHeader->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
+ InDeletedVariable = PtrTrack->CurrPtr;\r
+ } else {\r
+ return EFI_SUCCESS;\r
+ }\r
}\r
- //\r
- // Find the variable by walk through non-volatile variable store\r
- //\r
- IndexTable->StartPtr = (VARIABLE_HEADER *) (VariableStoreHeader + 1);\r
- IndexTable->EndPtr = (VARIABLE_HEADER *) ((UINTN) VariableStoreHeader + VariableStoreHeader->Size);\r
+ }\r
\r
+ if (IndexTable->GoneThrough != 0) {\r
//\r
- // Start Pointers for the variable.\r
- // Actual Data Pointer where data can be written.\r
+ // If the table has all the existing variables indexed, return.\r
//\r
- Variable = IndexTable->StartPtr;\r
+ PtrTrack->CurrPtr = InDeletedVariable;\r
+ return (PtrTrack->CurrPtr == NULL) ? EFI_NOT_FOUND : EFI_SUCCESS;\r
}\r
}\r
+\r
+ if (MaxIndex != NULL) {\r
+ //\r
+ // HOB exists but the variable cannot be found in HOB\r
+ // If not found in HOB, then let's start from the MaxIndex we've found.\r
+ //\r
+ Variable = GetNextVariablePtr (StoreInfo, MaxIndex, VariableHeader);\r
+ LastVariable = MaxIndex;\r
+ } else {\r
+ //\r
+ // Start Pointers for the variable.\r
+ // Actual Data Pointer where data can be written.\r
+ //\r
+ Variable = PtrTrack->StartPtr;\r
+ LastVariable = PtrTrack->StartPtr;\r
+ }\r
+\r
//\r
- // Find the variable by walk through non-volatile variable store\r
+ // Find the variable by walk through variable store\r
//\r
- PtrTrack->StartPtr = IndexTable->StartPtr;\r
- PtrTrack->EndPtr = IndexTable->EndPtr;\r
-\r
- while (IsValidVariableHeader (Variable) && (Variable <= IndexTable->EndPtr)) {\r
- if (Variable->State == VAR_ADDED) {\r
+ StopRecord = FALSE;\r
+ while (GetVariableHeader (StoreInfo, Variable, &VariableHeader)) {\r
+ if (VariableHeader->State == VAR_ADDED || VariableHeader->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
//\r
// Record Variable in VariableIndex HOB\r
//\r
- if (IndexTable->Length < VARIABLE_INDEX_TABLE_VOLUME)\r
- {\r
- VariableIndexTableUpdate (IndexTable, Variable);\r
+ if ((IndexTable != NULL) && !StopRecord) {\r
+ Offset = (UINTN) Variable - (UINTN) LastVariable;\r
+ if ((Offset > 0x0FFFF) || (IndexTable->Length == sizeof (IndexTable->Index) / sizeof (IndexTable->Index[0]))) {\r
+ //\r
+ // Stop to record if the distance of two neighbouring VAR_ADDED variable is larger than the allowable scope(UINT16),\r
+ // or the record buffer is full.\r
+ //\r
+ StopRecord = TRUE;\r
+ } else {\r
+ IndexTable->Index[IndexTable->Length++] = (UINT16) Offset;\r
+ LastVariable = Variable;\r
+ }\r
}\r
\r
- if (CompareWithValidVariable (Variable, VariableName, VendorGuid, PtrTrack) == EFI_SUCCESS) {\r
- return EFI_SUCCESS;\r
+ if (CompareWithValidVariable (StoreInfo, Variable, VariableHeader, VariableName, VendorGuid, PtrTrack) == EFI_SUCCESS) {\r
+ if (VariableHeader->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
+ InDeletedVariable = PtrTrack->CurrPtr;\r
+ } else {\r
+ return EFI_SUCCESS;\r
+ }\r
}\r
}\r
\r
- Variable = GetNextVariablePtr (Variable);\r
+ Variable = GetNextVariablePtr (StoreInfo, Variable, VariableHeader);\r
}\r
//\r
// If gone through the VariableStore, that means we never find in Firmware any more.\r
//\r
- if (IndexTable->Length < VARIABLE_INDEX_TABLE_VOLUME) {\r
+ if ((IndexTable != NULL) && !StopRecord) {\r
IndexTable->GoneThrough = 1;\r
}\r
\r
- PtrTrack->CurrPtr = NULL;\r
+ PtrTrack->CurrPtr = InDeletedVariable;\r
+\r
+ return (PtrTrack->CurrPtr == NULL) ? EFI_NOT_FOUND : EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Find the variable in HOB and Non-Volatile variable storages.\r
+\r
+ @param VariableName Name of the variable to be found\r
+ @param VendorGuid Vendor GUID to be found.\r
+ @param PtrTrack Variable Track Pointer structure that contains Variable Information.\r
+ @param StoreInfo Return the store info.\r
+\r
+ @retval EFI_SUCCESS Variable found successfully\r
+ @retval EFI_NOT_FOUND Variable not found\r
+ @retval EFI_INVALID_PARAMETER Invalid variable name\r
+**/\r
+EFI_STATUS\r
+FindVariable (\r
+ IN CONST CHAR16 *VariableName,\r
+ IN CONST EFI_GUID *VendorGuid,\r
+ OUT VARIABLE_POINTER_TRACK *PtrTrack,\r
+ OUT VARIABLE_STORE_INFO *StoreInfo\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ VARIABLE_STORE_TYPE Type;\r
+\r
+ if (VariableName[0] != 0 && VendorGuid == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ for (Type = (VARIABLE_STORE_TYPE) 0; Type < VariableStoreTypeMax; Type++) {\r
+ GetVariableStore (Type, StoreInfo);\r
+ Status = FindVariableEx (\r
+ StoreInfo,\r
+ VariableName,\r
+ VendorGuid,\r
+ PtrTrack\r
+ );\r
+ if (!EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ }\r
\r
return EFI_NOT_FOUND;\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
+ May be NULL with a zero DataSize in order to determine the size of the buffer needed.\r
+\r
+ @retval EFI_SUCCESS The variable was read successfully.\r
+ @retval EFI_NOT_FOUND The variable was 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
PeiGetVariable (\r
IN CONST EFI_GUID *VariableGuid,\r
OUT UINT32 *Attributes,\r
IN OUT UINTN *DataSize,\r
- OUT VOID *Data\r
+ OUT VOID *Data OPTIONAL\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Provide the read variable functionality of the variable services.\r
-\r
-Arguments:\r
-\r
- PeiServices - General purpose services available to every PEIM.\r
-\r
- VariableName - The variable name\r
-\r
- VendorGuid - The vendor's GUID\r
-\r
- Attributes - Pointer to the attribute\r
-\r
- DataSize - Size of data\r
-\r
- Data - Pointer to data\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The interface could be successfully installed\r
-\r
- EFI_NOT_FOUND - The variable could not be discovered\r
-\r
- EFI_BUFFER_TOO_SMALL - The caller buffer is not large enough\r
-\r
---*/\r
{\r
VARIABLE_POINTER_TRACK Variable;\r
UINTN VarDataSize;\r
EFI_STATUS Status;\r
- EFI_PEI_SERVICES **PeiServices;\r
+ VARIABLE_STORE_INFO StoreInfo;\r
+ VARIABLE_HEADER *VariableHeader;\r
\r
- PeiServices = GetPeiServicesTablePointer ();\r
- if (VariableName == NULL || VariableGuid == NULL) {\r
+ if (VariableName == NULL || VariableGuid == NULL || DataSize == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
+\r
+ if (VariableName[0] == 0) {\r
+ return EFI_NOT_FOUND;\r
+ }\r
+\r
+ VariableHeader = NULL;\r
+\r
//\r
// Find existing variable\r
//\r
- Status = FindVariable (PeiServices, VariableName, VariableGuid, &Variable);\r
- if (Variable.CurrPtr == NULL || Status != EFI_SUCCESS) {\r
+ Status = FindVariable (VariableName, VariableGuid, &Variable, &StoreInfo);\r
+ if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
+ GetVariableHeader (&StoreInfo, Variable.CurrPtr, &VariableHeader);\r
+\r
//\r
// Get data size\r
//\r
- VarDataSize = Variable.CurrPtr->DataSize;\r
+ VarDataSize = DataSizeOfVariable (VariableHeader, StoreInfo.AuthFlag);\r
if (*DataSize >= VarDataSize) {\r
- (*PeiServices)->CopyMem (Data, GET_VARIABLE_DATA_PTR (Variable.CurrPtr), VarDataSize);\r
+ if (Data == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ GetVariableNameOrData (&StoreInfo, GetVariableDataPtr (Variable.CurrPtr, VariableHeader, StoreInfo.AuthFlag), VarDataSize, Data);\r
\r
if (Attributes != NULL) {\r
- *Attributes = Variable.CurrPtr->Attributes;\r
+ *Attributes = VariableHeader->Attributes;\r
}\r
\r
*DataSize = VarDataSize;\r
}\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
+ On return, the size of the variable name buffer.\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 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
+ @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
PeiGetNextVariableName (\r
IN OUT CHAR16 *VariableName,\r
IN OUT EFI_GUID *VariableGuid\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Provide the get next variable functionality of the variable services.\r
-\r
-Arguments:\r
-\r
- PeiServices - General purpose services available to every PEIM.\r
- VariabvleNameSize - The variable name's size.\r
- VariableName - A pointer to the variable's name.\r
- VariableGuid - A pointer to the EFI_GUID structure.\r
-\r
- VariableNameSize - Size of the variable name\r
-\r
- VariableName - The variable name\r
-\r
- VendorGuid - The vendor's GUID\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The interface could be successfully installed\r
-\r
- EFI_NOT_FOUND - The variable could not be discovered\r
-\r
---*/\r
{\r
+ VARIABLE_STORE_TYPE Type;\r
VARIABLE_POINTER_TRACK Variable;\r
+ VARIABLE_POINTER_TRACK VariableInHob;\r
+ VARIABLE_POINTER_TRACK VariablePtrTrack;\r
UINTN VarNameSize;\r
EFI_STATUS Status;\r
- EFI_PEI_SERVICES **PeiServices;\r
+ VARIABLE_STORE_HEADER *VariableStoreHeader[VariableStoreTypeMax];\r
+ VARIABLE_HEADER *VariableHeader;\r
+ VARIABLE_STORE_INFO StoreInfo;\r
+ VARIABLE_STORE_INFO StoreInfoForNv;\r
+ VARIABLE_STORE_INFO StoreInfoForHob;\r
\r
- PeiServices = GetPeiServicesTablePointer ();\r
- if (VariableName == NULL) {\r
+ if (VariableName == NULL || VariableGuid == NULL || VariableNameSize == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
- Status = FindVariable (PeiServices, VariableName, VariableGuid, &Variable);\r
+ VariableHeader = NULL;\r
+\r
+ Status = FindVariable (VariableName, VariableGuid, &Variable, &StoreInfo);\r
if (Variable.CurrPtr == NULL || Status != EFI_SUCCESS) {\r
return Status;\r
}\r
//\r
// If variable name is not NULL, get next variable\r
//\r
- Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);\r
+ GetVariableHeader (&StoreInfo, Variable.CurrPtr, &VariableHeader);\r
+ Variable.CurrPtr = GetNextVariablePtr (&StoreInfo, Variable.CurrPtr, VariableHeader);\r
}\r
\r
- while (!(Variable.CurrPtr >= Variable.EndPtr || Variable.CurrPtr == NULL)) {\r
- if (IsValidVariableHeader (Variable.CurrPtr)) {\r
- if (Variable.CurrPtr->State == VAR_ADDED) {\r
- VarNameSize = (UINTN) Variable.CurrPtr->NameSize;\r
- if (VarNameSize <= *VariableNameSize) {\r
- (*PeiServices)->CopyMem (VariableName, GET_VARIABLE_NAME_PTR (Variable.CurrPtr), VarNameSize);\r
-\r
- (*PeiServices)->CopyMem (VariableGuid, &Variable.CurrPtr->VendorGuid, sizeof (EFI_GUID));\r
+ VariableStoreHeader[VariableStoreTypeHob] = GetVariableStore (VariableStoreTypeHob, &StoreInfoForHob);\r
+ VariableStoreHeader[VariableStoreTypeNv] = GetVariableStore (VariableStoreTypeNv, &StoreInfoForNv);\r
\r
- Status = EFI_SUCCESS;\r
- } else {\r
- Status = EFI_BUFFER_TOO_SMALL;\r
+ while (TRUE) {\r
+ //\r
+ // Switch from HOB to Non-Volatile.\r
+ //\r
+ while (!GetVariableHeader (&StoreInfo, Variable.CurrPtr, &VariableHeader)) {\r
+ //\r
+ // Find current storage index\r
+ //\r
+ for (Type = (VARIABLE_STORE_TYPE) 0; Type < VariableStoreTypeMax; Type++) {\r
+ if ((VariableStoreHeader[Type] != NULL) && (Variable.StartPtr == GetStartPointer (VariableStoreHeader[Type]))) {\r
+ break;\r
+ }\r
+ }\r
+ ASSERT (Type < VariableStoreTypeMax);\r
+ //\r
+ // Switch to next storage\r
+ //\r
+ for (Type++; Type < VariableStoreTypeMax; Type++) {\r
+ if (VariableStoreHeader[Type] != NULL) {\r
+ break;\r
}\r
+ }\r
+ //\r
+ // Capture the case that\r
+ // 1. current storage is the last one, or\r
+ // 2. no further storage\r
+ //\r
+ if (Type == VariableStoreTypeMax) {\r
+ return EFI_NOT_FOUND;\r
+ }\r
+ Variable.StartPtr = GetStartPointer (VariableStoreHeader[Type]);\r
+ Variable.EndPtr = GetEndPointer (VariableStoreHeader[Type]);\r
+ Variable.CurrPtr = Variable.StartPtr;\r
+ GetVariableStore (Type, &StoreInfo);\r
+ }\r
\r
- *VariableNameSize = VarNameSize;\r
- return Status;\r
+ if (VariableHeader->State == VAR_ADDED || VariableHeader->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
+ if (VariableHeader->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
//\r
- // Variable is found\r
+ // If it is a IN_DELETED_TRANSITION variable,\r
+ // and there is also a same ADDED one at the same time,\r
+ // don't return it.\r
//\r
+ Status = FindVariableEx (\r
+ &StoreInfo,\r
+ GetVariableNamePtr (Variable.CurrPtr, StoreInfo.AuthFlag),\r
+ GetVendorGuidPtr (VariableHeader, StoreInfo.AuthFlag),\r
+ &VariablePtrTrack\r
+ );\r
+ if (!EFI_ERROR (Status) && VariablePtrTrack.CurrPtr != Variable.CurrPtr) {\r
+ Variable.CurrPtr = GetNextVariablePtr (&StoreInfo, Variable.CurrPtr, VariableHeader);\r
+ continue;\r
+ }\r
+ }\r
+\r
+ //\r
+ // Don't return NV variable when HOB overrides it\r
+ //\r
+ if ((VariableStoreHeader[VariableStoreTypeHob] != NULL) && (VariableStoreHeader[VariableStoreTypeNv] != NULL) &&\r
+ (Variable.StartPtr == GetStartPointer (VariableStoreHeader[VariableStoreTypeNv]))\r
+ ) {\r
+ Status = FindVariableEx (\r
+ &StoreInfoForHob,\r
+ GetVariableNamePtr (Variable.CurrPtr, StoreInfo.AuthFlag),\r
+ GetVendorGuidPtr (VariableHeader, StoreInfo.AuthFlag),\r
+ &VariableInHob\r
+ );\r
+ if (!EFI_ERROR (Status)) {\r
+ Variable.CurrPtr = GetNextVariablePtr (&StoreInfo, Variable.CurrPtr, VariableHeader);\r
+ continue;\r
+ }\r
+ }\r
+\r
+ VarNameSize = NameSizeOfVariable (VariableHeader, StoreInfo.AuthFlag);\r
+ ASSERT (VarNameSize != 0);\r
+\r
+ if (VarNameSize <= *VariableNameSize) {\r
+ GetVariableNameOrData (&StoreInfo, (UINT8 *) GetVariableNamePtr (Variable.CurrPtr, StoreInfo.AuthFlag), VarNameSize, (UINT8 *) VariableName);\r
+\r
+ CopyMem (VariableGuid, GetVendorGuidPtr (VariableHeader, StoreInfo.AuthFlag), sizeof (EFI_GUID));\r
+\r
+ Status = EFI_SUCCESS;\r
} else {\r
- Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);\r
+ Status = EFI_BUFFER_TOO_SMALL;\r
}\r
+\r
+ *VariableNameSize = VarNameSize;\r
+ //\r
+ // Variable is found\r
+ //\r
+ return Status;\r
} else {\r
- break;\r
+ Variable.CurrPtr = GetNextVariablePtr (&StoreInfo, Variable.CurrPtr, VariableHeader);\r
}\r
}\r
-\r
- return EFI_NOT_FOUND;\r
}\r
projects / mirror_edk2.git / blobdiff