&mVariablePpi\r
};\r
\r
-\r
-/**\r
- Check if it runs in Recovery mode.\r
- \r
- @param PeiServices General purpose services available to every PEIM.\r
-\r
- @retval TRUE It's in Recovery mode.\r
- @retval FALSE It's not in Recovery mode.\r
-\r
-**/\r
-BOOLEAN\r
-IsInRecoveryMode (\r
- IN CONST EFI_PEI_SERVICES **PeiServices\r
- )\r
-{\r
- EFI_STATUS Status;\r
- EFI_BOOT_MODE BootMode;\r
-\r
- Status = (*PeiServices)->GetBootMode (PeiServices, &BootMode);\r
- ASSERT_EFI_ERROR (Status);\r
- \r
- if (BootMode == BOOT_IN_RECOVERY_MODE) {\r
- return TRUE;\r
- }\r
- return FALSE;\r
-}\r
-\r
/**\r
Provide the functionality of the variable services.\r
\r
\r
@retval EFI_SUCCESS If the interface could be successfully installed\r
@retval Others Returned from PeiServicesInstallPpi()\r
-\r
**/\r
EFI_STATUS\r
EFIAPI\r
return EFI_NOT_FOUND;\r
}\r
\r
+/**\r
+ Return the variable store header and the index table based on the Index.\r
+\r
+ @param Index The index of the variable store.\r
+ @param IndexTable Return the index table.\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_INDEX_TABLE **IndexTable OPTIONAL\r
+ )\r
+{\r
+ EFI_HOB_GUID_TYPE *GuidHob;\r
+ EFI_FIRMWARE_VOLUME_HEADER *FvHeader;\r
+ VARIABLE_STORE_HEADER *VariableStoreHeader;\r
+\r
+ if (IndexTable != NULL) {\r
+ *IndexTable = NULL;\r
+ }\r
+ VariableStoreHeader = NULL;\r
+ switch (Type) {\r
+ case VariableStoreTypeHob:\r
+ GuidHob = GetFirstGuidHob (&gEfiAuthenticatedVariableGuid);\r
+ if (GuidHob != NULL) {\r
+ VariableStoreHeader = (VARIABLE_STORE_HEADER *) GET_GUID_HOB_DATA (GuidHob);\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
+ FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) (UINTN) (PcdGet64 (PcdFlashNvStorageVariableBase64) != 0 ? \r
+ PcdGet64 (PcdFlashNvStorageVariableBase64) : \r
+ PcdGet32 (PcdFlashNvStorageVariableBase)\r
+ );\r
+ VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINT8 *) FvHeader + FvHeader->HeaderLength);\r
+\r
+ if (IndexTable != NULL) {\r
+ GuidHob = GetFirstGuidHob (&gEfiVariableIndexTableGuid);\r
+ if (GuidHob != NULL) {\r
+ *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
+ *IndexTable = BuildGuidHob (&gEfiVariableIndexTableGuid, sizeof (VARIABLE_INDEX_TABLE));\r
+ (*IndexTable)->Length = 0;\r
+ (*IndexTable)->StartPtr = GetStartPointer (VariableStoreHeader);\r
+ (*IndexTable)->EndPtr = GetEndPointer (VariableStoreHeader);\r
+ (*IndexTable)->GoneThrough = 0;\r
+ }\r
+ }\r
+ }\r
+ break;\r
+\r
+ default:\r
+ ASSERT (FALSE);\r
+ break;\r
+ }\r
+\r
+ return VariableStoreHeader;\r
+}\r
\r
/**\r
- This code finds variable in storage blocks (Non-Volatile).\r
+ Find the variable in the specified variable store.\r
\r
- @param PeiServices General purpose services available to every PEIM.\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 VariableStoreHeader Pointer to the variable store header.\r
+ @param IndexTable Pointer to the index table.\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
\r
**/\r
EFI_STATUS\r
-FindVariable (\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN CONST CHAR16 *VariableName,\r
- IN CONST EFI_GUID *VendorGuid,\r
- OUT VARIABLE_POINTER_TRACK *PtrTrack\r
+FindVariableEx (\r
+ IN VARIABLE_STORE_HEADER *VariableStoreHeader,\r
+ IN VARIABLE_INDEX_TABLE *IndexTable,\r
+ IN CONST CHAR16 *VariableName,\r
+ IN CONST EFI_GUID *VendorGuid,\r
+ OUT VARIABLE_POINTER_TRACK *PtrTrack\r
)\r
{\r
- EFI_HOB_GUID_TYPE *GuidHob;\r
- VARIABLE_STORE_HEADER *VariableStoreHeader;\r
VARIABLE_HEADER *Variable;\r
VARIABLE_HEADER *LastVariable;\r
VARIABLE_HEADER *MaxIndex;\r
- VARIABLE_INDEX_TABLE *IndexTable;\r
- UINT32 Count;\r
- UINT32 Offset;\r
- UINT8 *VariableBase;\r
+ UINTN Index;\r
+ UINTN Offset;\r
BOOLEAN StopRecord;\r
\r
- if (VariableName[0] != 0 && VendorGuid == NULL) {\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
+ PtrTrack->StartPtr = GetStartPointer (VariableStoreHeader);\r
+ PtrTrack->EndPtr = GetEndPointer (VariableStoreHeader);\r
+\r
//\r
// No Variable Address equals zero, so 0 as initial value is safe.\r
//\r
- MaxIndex = 0;\r
- StopRecord = FALSE;\r
+ MaxIndex = NULL;\r
\r
- GuidHob = GetFirstGuidHob (&gEfiVariableIndexTableGuid);\r
- if (GuidHob == NULL) {\r
+ if (IndexTable != NULL) {\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 number of \r
- // VARIABLE_INDEX_TABLE_VOLUME of VAR_ADDED type variables to reduce access time.\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
- IndexTable = BuildGuidHob (&gEfiVariableIndexTableGuid, 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 (Offset = 0, Count = 0; Count < IndexTable->Length; Count++) {\r
- //\r
- // traverse the variable info list to look for varible.\r
- // The IndexTable->Index[Count] records the distance of two neighbouring VAR_ADDED type variables.\r
- //\r
- ASSERT (Count < VARIABLE_INDEX_TABLE_VOLUME);\r
- Offset += IndexTable->Index[Count];\r
- MaxIndex = (VARIABLE_HEADER *)((CHAR8 *)(IndexTable->StartPtr) + Offset);\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
if (CompareWithValidVariable (MaxIndex, VariableName, VendorGuid, PtrTrack) == EFI_SUCCESS) {\r
- PtrTrack->StartPtr = IndexTable->StartPtr;\r
- PtrTrack->EndPtr = IndexTable->EndPtr;\r
-\r
return EFI_SUCCESS;\r
}\r
}\r
\r
if (IndexTable->GoneThrough != 0) {\r
+ //\r
+ // If the table has all the existing variables indexed and we still cannot find it.\r
+ //\r
return EFI_NOT_FOUND;\r
}\r
}\r
- //\r
- // If not found in HOB, then let's start from the MaxIndex we've found.\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 (MaxIndex);\r
LastVariable = MaxIndex;\r
} else {\r
- if ((IndexTable->StartPtr != NULL) || (IndexTable->EndPtr != NULL)) {\r
- Variable = IndexTable->StartPtr;\r
- } else {\r
- VariableBase = (UINT8 *) (UINTN) PcdGet64 (PcdFlashNvStorageVariableBase64);\r
- if (VariableBase == NULL) {\r
- VariableBase = (UINT8 *) (UINTN) PcdGet32 (PcdFlashNvStorageVariableBase);\r
- }\r
- \r
- VariableStoreHeader = (VARIABLE_STORE_HEADER *) (VariableBase + \\r
- ((EFI_FIRMWARE_VOLUME_HEADER *) (VariableBase)) -> HeaderLength);\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
- // Find the variable by walk through non-volatile variable store\r
- //\r
- IndexTable->StartPtr = GetStartPointer (VariableStoreHeader);\r
- IndexTable->EndPtr = GetEndPointer (VariableStoreHeader);\r
-\r
- //\r
- // Start Pointers for the variable.\r
- // Actual Data Pointer where data can be written.\r
- //\r
- Variable = IndexTable->StartPtr;\r
- }\r
-\r
- LastVariable = IndexTable->StartPtr;\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
//\r
- PtrTrack->StartPtr = IndexTable->StartPtr;\r
- PtrTrack->EndPtr = IndexTable->EndPtr;\r
-\r
- while ((Variable < IndexTable->EndPtr) && IsValidVariableHeader (Variable)) {\r
+ StopRecord = FALSE;\r
+ while ((Variable < PtrTrack->EndPtr) && IsValidVariableHeader (Variable)) {\r
if (Variable->State == VAR_ADDED) {\r
//\r
// Record Variable in VariableIndex HOB\r
//\r
- if (IndexTable->Length < VARIABLE_INDEX_TABLE_VOLUME && !StopRecord) {\r
- Offset = (UINT32)((UINTN)Variable - (UINTN)LastVariable);\r
- //\r
- // The distance of two neighbouring VAR_ADDED variable is larger than 2^16, \r
- // which is beyond the allowable scope(UINT16) of record. In such case, need not to\r
- // record the subsequent VAR_ADDED type variables again.\r
- //\r
- if ((Offset & 0xFFFF0000UL) != 0) {\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
- }\r
-\r
- if (!StopRecord) {\r
+ } else {\r
IndexTable->Index[IndexTable->Length++] = (UINT16) Offset;\r
+ LastVariable = Variable;\r
}\r
- LastVariable = Variable;\r
}\r
\r
if (CompareWithValidVariable (Variable, VariableName, VendorGuid, PtrTrack) == EFI_SUCCESS) {\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) && (!StopRecord)) {\r
+ if ((IndexTable != NULL) && !StopRecord) {\r
IndexTable->GoneThrough = 1;\r
}\r
\r
return EFI_NOT_FOUND;\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
+\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
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ VARIABLE_STORE_HEADER *VariableStoreHeader;\r
+ VARIABLE_INDEX_TABLE *IndexTable;\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
+ VariableStoreHeader = GetVariableStore (Type, &IndexTable);\r
+ Status = FindVariableEx (\r
+ VariableStoreHeader,\r
+ IndexTable,\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
VARIABLE_POINTER_TRACK Variable;\r
UINTN VarDataSize;\r
EFI_STATUS Status;\r
- CONST EFI_PEI_SERVICES **PeiServices;\r
\r
- PeiServices = GetPeiServicesTablePointer ();\r
if (VariableName == NULL || VariableGuid == NULL || DataSize == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
- //\r
- // Check if this is recovery boot path.\r
- // If yes, the content of variable area is not reliable. Therefore we directly\r
- // return EFI_NOT_FOUND. \r
- // \r
- if (IsInRecoveryMode(PeiServices)) {\r
- return EFI_NOT_FOUND;\r
- }\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);\r
+ if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
//\r
IN OUT EFI_GUID *VariableGuid\r
)\r
{\r
+ VARIABLE_STORE_TYPE Type;\r
VARIABLE_POINTER_TRACK Variable;\r
+ VARIABLE_POINTER_TRACK VariableInHob;\r
UINTN VarNameSize;\r
EFI_STATUS Status;\r
- CONST EFI_PEI_SERVICES **PeiServices;\r
+ VARIABLE_STORE_HEADER *VariableStoreHeader[VariableStoreTypeMax];\r
\r
- PeiServices = GetPeiServicesTablePointer ();\r
if (VariableName == NULL || VariableGuid == NULL || VariableNameSize == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
- //\r
- // Check if this is recovery boot path.\r
- // If yes, the content of variable area is not reliable. Therefore we directly\r
- // return EFI_NOT_FOUND. \r
- // \r
- if (IsInRecoveryMode(PeiServices)) {\r
- return EFI_NOT_FOUND;\r
- }\r
-\r
- Status = FindVariable (PeiServices, VariableName, VariableGuid, &Variable);\r
+ Status = FindVariable (VariableName, VariableGuid, &Variable);\r
if (Variable.CurrPtr == NULL || Status != EFI_SUCCESS) {\r
return Status;\r
}\r
Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);\r
}\r
\r
- while (!(Variable.CurrPtr >= Variable.EndPtr || Variable.CurrPtr == NULL)) {\r
- if (IsValidVariableHeader (Variable.CurrPtr)) {\r
- if (Variable.CurrPtr->State == VAR_ADDED) {\r
- ASSERT (NameSizeOfVariable (Variable.CurrPtr) != 0);\r
+ VariableStoreHeader[VariableStoreTypeHob] = GetVariableStore (VariableStoreTypeHob, NULL);\r
+ VariableStoreHeader[VariableStoreTypeNv] = GetVariableStore (VariableStoreTypeNv, NULL);\r
\r
- VarNameSize = (UINTN) NameSizeOfVariable (Variable.CurrPtr);\r
- if (VarNameSize <= *VariableNameSize) {\r
- CopyMem (VariableName, GetVariableNamePtr (Variable.CurrPtr), VarNameSize);\r
+ while (TRUE) {\r
+ //\r
+ // Switch from HOB to Non-Volatile.\r
+ //\r
+ while ((Variable.CurrPtr >= Variable.EndPtr) ||\r
+ (Variable.CurrPtr == NULL) ||\r
+ !IsValidVariableHeader (Variable.CurrPtr)\r
+ ) {\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
+ }\r
\r
- CopyMem (VariableGuid, &Variable.CurrPtr->VendorGuid, sizeof (EFI_GUID));\r
+ if (Variable.CurrPtr->State == VAR_ADDED) {\r
\r
- Status = EFI_SUCCESS;\r
- } else {\r
- Status = EFI_BUFFER_TOO_SMALL;\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
+ VariableStoreHeader[VariableStoreTypeHob],\r
+ NULL,\r
+ GetVariableNamePtr (Variable.CurrPtr),\r
+ &Variable.CurrPtr->VendorGuid, \r
+ &VariableInHob\r
+ );\r
+ if (!EFI_ERROR (Status)) {\r
+ Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);\r
+ continue;\r
}\r
+ }\r
\r
- *VariableNameSize = VarNameSize;\r
- return Status;\r
- //\r
- // Variable is found\r
- //\r
+ VarNameSize = NameSizeOfVariable (Variable.CurrPtr);\r
+ ASSERT (VarNameSize != 0);\r
+\r
+ if (VarNameSize <= *VariableNameSize) {\r
+ CopyMem (VariableName, GetVariableNamePtr (Variable.CurrPtr), VarNameSize);\r
+\r
+ CopyMem (VariableGuid, &Variable.CurrPtr->VendorGuid, 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 (Variable.CurrPtr);\r
}\r
}\r
-\r
- return EFI_NOT_FOUND;\r
}\r
projects / mirror_edk2.git / blobdiff