X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdeModulePkg%2FUniversal%2FVariable%2FRuntimeDxe%2FVariable.c;h=52419f07967d2e86442bebfba0c838d68c55bc56;hp=ca2270f6eb57f1d247b75657d15953bb7d45ee77;hb=b59ad7519fabe09cd5966a1b873ea6e34aa6c6ce;hpb=92a4f6f3c7898c4d4bc54cdd0fa6734b1a352269 diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c index ca2270f6eb..52419f0796 100644 --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c @@ -1,7 +1,7 @@ /** @file - Implement all four UEFI Runtime Variable services for the nonvolatile - and volatile storage space and install variable architecture protocol. + The common variable operation routines shared by DXE_RINTIME variable + module and DXE_SMM variable module. Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials @@ -17,114 +17,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include "Variable.h" VARIABLE_MODULE_GLOBAL *mVariableModuleGlobal; -EFI_EVENT mVirtualAddressChangeEvent = NULL; -EFI_HANDLE mHandle = NULL; + /// -/// The size of a 3 character ISO639 language code. +/// Define a memory cache that improves the search performance for a variable. /// -#define ISO_639_2_ENTRY_SIZE 3 +VARIABLE_STORE_HEADER *mNvVariableCache = NULL; /// -/// The current Hii implementation accesses this variable many times on every boot. -/// Other common variables are only accessed once. This is why this cache algorithm -/// only targets a single variable. Probably to get an performance improvement out of -/// a Cache you would need a cache that improves the search performance for a variable. +/// The memory entry used for variable statistics data. /// -VARIABLE_CACHE_ENTRY mVariableCache[] = { - { - &gEfiGlobalVariableGuid, - L"Lang", - 0x00000000, - 0x00, - NULL - }, - { - &gEfiGlobalVariableGuid, - L"PlatformLang", - 0x00000000, - 0x00, - NULL - } -}; - -VARIABLE_INFO_ENTRY *gVariableInfo = NULL; -EFI_EVENT mFvbRegistration = NULL; - -/** - Update the variable region with Variable information. These are the same - arguments as the EFI Variable services. - - @param[in] VariableName Name of variable - - @param[in] VendorGuid Guid of variable - - @param[in] Data Variable data - - @param[in] DataSize Size of data. 0 means delete - - @param[in] Attributes Attribues of the variable - - @param[in] Variable The variable information which is used to keep track of variable usage. - - @retval EFI_SUCCESS The update operation is success. - - @retval EFI_OUT_OF_RESOURCES Variable region is full, can not write other data into this region. - -**/ -EFI_STATUS -EFIAPI -UpdateVariable ( - IN CHAR16 *VariableName, - IN EFI_GUID *VendorGuid, - IN VOID *Data, - IN UINTN DataSize, - IN UINT32 Attributes OPTIONAL, - IN VARIABLE_POINTER_TRACK *Variable - ); - -/** - Acquires lock only at boot time. Simply returns at runtime. - - This is a temperary function which will be removed when - EfiAcquireLock() in UefiLib can handle the call in UEFI - Runtimer driver in RT phase. - It calls EfiAcquireLock() at boot time, and simply returns - at runtime. - - @param Lock A pointer to the lock to acquire - -**/ -VOID -AcquireLockOnlyAtBootTime ( - IN EFI_LOCK *Lock - ) -{ - if (!EfiAtRuntime ()) { - EfiAcquireLock (Lock); - } -} - -/** - Releases lock only at boot time. Simply returns at runtime. - - This is a temperary function which will be removed when - EfiReleaseLock() in UefiLib can handle the call in UEFI - Runtimer driver in RT phase. - It calls EfiReleaseLock() at boot time, and simply returns - at runtime. - - @param Lock A pointer to the lock to release - -**/ -VOID -ReleaseLockOnlyAtBootTime ( - IN EFI_LOCK *Lock - ) -{ - if (!EfiAtRuntime ()) { - EfiReleaseLock (Lock); - } -} +VARIABLE_INFO_ENTRY *gVariableInfo = NULL; /** @@ -138,12 +40,12 @@ ReleaseLockOnlyAtBootTime ( the transaction. Data is allocated by this routine, but never freed. - @param[in] VariableName Name of the Variable to track - @param[in] VendorGuid Guid of the Variable to track - @param[in] Volatile TRUE if volatile FALSE if non-volatile - @param[in] Read TRUE if GetVariable() was called - @param[in] Write TRUE if SetVariable() was called - @param[in] Delete TRUE if deleted via SetVariable() + @param[in] VariableName Name of the Variable to track. + @param[in] VendorGuid Guid of the Variable to track. + @param[in] Volatile TRUE if volatile FALSE if non-volatile. + @param[in] Read TRUE if GetVariable() was called. + @param[in] Write TRUE if SetVariable() was called. + @param[in] Delete TRUE if deleted via SetVariable(). @param[in] Cache TRUE for a cache hit. **/ @@ -162,15 +64,15 @@ UpdateVariableInfo ( if (FeaturePcdGet (PcdVariableCollectStatistics)) { - if (EfiAtRuntime ()) { - // Don't collect statistics at runtime + if (AtRuntime ()) { + // Don't collect statistics at runtime. return; } if (gVariableInfo == NULL) { // - // on the first call allocate a entry and place a pointer to it in - // the EFI System Table + // On the first call allocate a entry and place a pointer to it in + // the EFI System Table. // gVariableInfo = AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY)); ASSERT (gVariableInfo != NULL); @@ -180,8 +82,6 @@ UpdateVariableInfo ( ASSERT (gVariableInfo->Name != NULL); StrCpy (gVariableInfo->Name, VariableName); gVariableInfo->Volatile = Volatile; - - gBS->InstallConfigurationTable (&gEfiVariableGuid, gVariableInfo); } @@ -208,7 +108,7 @@ UpdateVariableInfo ( if (Entry->Next == NULL) { // // If the entry is not in the table add it. - // Next iteration of the loop will fill in the data + // Next iteration of the loop will fill in the data. // Entry->Next = AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY)); ASSERT (Entry->Next != NULL); @@ -253,18 +153,18 @@ IsValidVariableHeader ( This function writes data to the FWH at the correct LBA even if the LBAs are fragmented. - @param Global Pointer to VARAIBLE_GLOBAL structure - @param Volatile Point out the Variable is Volatile or Non-Volatile - @param SetByIndex TRUE if target pointer is given as index - FALSE if target pointer is absolute - @param Fvb Pointer to the writable FVB protocol + @param Global Pointer to VARAIBLE_GLOBAL structure. + @param Volatile Point out the Variable is Volatile or Non-Volatile. + @param SetByIndex TRUE if target pointer is given as index. + FALSE if target pointer is absolute. + @param Fvb Pointer to the writable FVB protocol. @param DataPtrIndex Pointer to the Data from the end of VARIABLE_STORE_HEADER - structure - @param DataSize Size of data to be written - @param Buffer Pointer to the buffer from which data is written + structure. + @param DataSize Size of data to be written. + @param Buffer Pointer to the buffer from which data is written. - @retval EFI_INVALID_PARAMETER Parameters not valid - @retval EFI_SUCCESS Variable store successfully updated + @retval EFI_INVALID_PARAMETER Parameters not valid. + @retval EFI_SUCCESS Variable store successfully updated. **/ EFI_STATUS @@ -296,16 +196,17 @@ UpdateVariableStore ( DataPtr = DataPtrIndex; // - // Check if the Data is Volatile + // Check if the Data is Volatile. // if (!Volatile) { + ASSERT (Fvb != NULL); Status = Fvb->GetPhysicalAddress(Fvb, &FvVolHdr); ASSERT_EFI_ERROR (Status); FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) ((UINTN) FvVolHdr); // // Data Pointer should point to the actual Address where data is to be - // written + // written. // if (SetByIndex) { DataPtr += mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase; @@ -317,7 +218,7 @@ UpdateVariableStore ( } else { // // Data Pointer should point to the actual Address where data is to be - // written + // written. // VolatileBase = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase); if (SetByIndex) { @@ -336,7 +237,7 @@ UpdateVariableStore ( } // - // If we are here we are dealing with Non-Volatile Variables + // If we are here we are dealing with Non-Volatile Variables. // LinearOffset = (UINTN) FwVolHeader; CurrWritePtr = (UINTN) DataPtr; @@ -398,9 +299,9 @@ UpdateVariableStore ( @param VarStoreHeader Pointer to the Variable Store Header. - @retval EfiRaw Variable store status is raw - @retval EfiValid Variable store status is valid - @retval EfiInvalid Variable store status is invalid + @retval EfiRaw Variable store status is raw. + @retval EfiValid Variable store status is valid. + @retval EfiInvalid Variable store status is invalid. **/ VARIABLE_STORE_STATUS @@ -434,9 +335,9 @@ GetVariableStoreStatus ( This code gets the size of name of variable. - @param Variable Pointer to the Variable Header + @param Variable Pointer to the Variable Header. - @return UINTN Size of variable in bytes + @return UINTN Size of variable in bytes. **/ UINTN @@ -457,9 +358,9 @@ NameSizeOfVariable ( This code gets the size of variable data. - @param Variable Pointer to the Variable Header + @param Variable Pointer to the Variable Header. - @return Size of variable in bytes + @return Size of variable in bytes. **/ UINTN @@ -480,9 +381,9 @@ DataSizeOfVariable ( This code gets the pointer to the variable name. - @param Variable Pointer to the Variable Header + @param Variable Pointer to the Variable Header. - @return Pointer to Variable Name which is Unicode encoding + @return Pointer to Variable Name which is Unicode encoding. **/ CHAR16 * @@ -498,9 +399,9 @@ GetVariableNamePtr ( This code gets the pointer to the variable data. - @param Variable Pointer to the Variable Header + @param Variable Pointer to the Variable Header. - @return Pointer to Variable Data + @return Pointer to Variable Data. **/ UINT8 * @@ -511,7 +412,7 @@ GetVariableDataPtr ( UINTN Value; // - // Be careful about pad size for alignment + // Be careful about pad size for alignment. // Value = (UINTN) GetVariableNamePtr (Variable); Value += NameSizeOfVariable (Variable); @@ -525,9 +426,9 @@ GetVariableDataPtr ( This code gets the pointer to the next variable header. - @param Variable Pointer to the Variable Header + @param Variable Pointer to the Variable Header. - @return Pointer to next variable header + @return Pointer to next variable header. **/ VARIABLE_HEADER * @@ -546,7 +447,7 @@ GetNextVariablePtr ( Value += GET_PAD_SIZE (DataSizeOfVariable (Variable)); // - // Be careful about pad size for alignment + // Be careful about pad size for alignment. // return (VARIABLE_HEADER *) HEADER_ALIGN (Value); } @@ -557,7 +458,7 @@ GetNextVariablePtr ( @param VarStoreHeader Pointer to the Variable Store Header. - @return Pointer to the first variable header + @return Pointer to the first variable header. **/ VARIABLE_HEADER * @@ -566,7 +467,7 @@ GetStartPointer ( ) { // - // The end of variable store + // The end of variable store. // return (VARIABLE_HEADER *) HEADER_ALIGN (VarStoreHeader + 1); } @@ -578,9 +479,9 @@ GetStartPointer ( This function gets pointer to the end of the variable storage area, according to the input variable store header. - @param VarStoreHeader Pointer to the Variable Store Header + @param VarStoreHeader Pointer to the Variable Store Header. - @return Pointer to the end of the variable storage area + @return Pointer to the end of the variable storage area. **/ VARIABLE_HEADER * @@ -599,11 +500,11 @@ GetEndPointer ( Variable store garbage collection and reclaim operation. - @param VariableBase Base address of variable store - @param LastVariableOffset Offset of last variable - @param IsVolatile The variable store is volatile or not, - if it is non-volatile, need FTW - @param UpdatingVariable Pointer to updateing variable. + @param VariableBase Base address of variable store. + @param LastVariableOffset Offset of last variable. + @param IsVolatile The variable store is volatile or not; + if it is non-volatile, need FTW. + @param UpdatingVariable Pointer to updating variable. @return EFI_OUT_OF_RESOURCES @return EFI_SUCCESS @@ -639,7 +540,7 @@ Reclaim ( VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) VariableBase); // - // recaluate the total size of Common/HwErr type variables in non-volatile area. + // Recalculate the total size of Common/HwErr type variables in non-volatile area. // if (!IsVolatile) { mVariableModuleGlobal->CommonVariableTotalSize = 0; @@ -677,13 +578,13 @@ Reclaim ( SetMem (ValidBuffer, MaximumBufferSize, 0xff); // - // Copy variable store header + // Copy variable store header. // CopyMem (ValidBuffer, VariableStoreHeader, sizeof (VARIABLE_STORE_HEADER)); CurrPtr = (UINT8 *) GetStartPointer ((VARIABLE_STORE_HEADER *) ValidBuffer); // - // Reinstall all ADDED variables as long as they are not identical to Updating Variable + // Reinstall all ADDED variables as long as they are not identical to Updating Variable. // Variable = GetStartPointer (VariableStoreHeader); while (IsValidVariableHeader (Variable)) { @@ -720,7 +621,7 @@ Reclaim ( } // - // Reinstall the variable being updated if it is not NULL + // Reinstall the variable being updated if it is not NULL. // if (UpdatingVariable != NULL) { VariableSize = (UINTN)(GetNextVariablePtr (UpdatingVariable)) - (UINTN)UpdatingVariable; @@ -734,7 +635,7 @@ Reclaim ( } // - // Reinstall all in delete transition variables + // Reinstall all in delete transition variables. // Variable = GetStartPointer (VariableStoreHeader); while (IsValidVariableHeader (Variable)) { @@ -766,7 +667,7 @@ Reclaim ( } if (!FoundAdded) { // - // Promote VAR_IN_DELETED_TRANSITION to VAR_ADDED + // Promote VAR_IN_DELETED_TRANSITION to VAR_ADDED. // VariableSize = (UINTN) NextVariable - (UINTN) Variable; CopyMem (CurrPtr, (UINT8 *) Variable, VariableSize); @@ -785,11 +686,11 @@ Reclaim ( if (IsVolatile) { // - // If volatile variable store, just copy valid buffer + // If volatile variable store, just copy valid buffer. // SetMem ((UINT8 *) (UINTN) VariableBase, VariableStoreHeader->Size, 0xff); CopyMem ((UINT8 *) (UINTN) VariableBase, ValidBuffer, (UINTN) (CurrPtr - (UINT8 *) ValidBuffer)); - Status = EFI_SUCCESS; + Status = EFI_SUCCESS; } else { // // If non-volatile variable store, perform FTW here. @@ -799,6 +700,7 @@ Reclaim ( ValidBuffer, (UINTN) (CurrPtr - (UINT8 *) ValidBuffer) ); + CopyMem (mNvVariableCache, (CHAR8 *)(UINTN)VariableBase, VariableStoreHeader->Size); } if (!EFI_ERROR (Status)) { *LastVariableOffset = (UINTN) (CurrPtr - (UINT8 *) ValidBuffer); @@ -812,126 +714,6 @@ Reclaim ( } -/** - Update the Cache with Variable information. These are the same - arguments as the EFI Variable services. - - @param[in] VariableName Name of variable - @param[in] VendorGuid Guid of variable - @param[in] Attributes Attribues of the variable - @param[in] DataSize Size of data. 0 means delete - @param[in] Data Variable data - -**/ -VOID -UpdateVariableCache ( - IN CHAR16 *VariableName, - IN EFI_GUID *VendorGuid, - IN UINT32 Attributes, - IN UINTN DataSize, - IN VOID *Data - ) -{ - VARIABLE_CACHE_ENTRY *Entry; - UINTN Index; - - if (EfiAtRuntime ()) { - // - // Don't use the cache at runtime - // - return; - } - - for (Index = 0, Entry = mVariableCache; Index < sizeof (mVariableCache)/sizeof (VARIABLE_CACHE_ENTRY); Index++, Entry++) { - if (CompareGuid (VendorGuid, Entry->Guid)) { - if (StrCmp (VariableName, Entry->Name) == 0) { - Entry->Attributes = Attributes; - if (DataSize == 0) { - // - // Delete Case - // - if (Entry->DataSize != 0) { - FreePool (Entry->Data); - } - Entry->DataSize = DataSize; - } else if (DataSize == Entry->DataSize) { - CopyMem (Entry->Data, Data, DataSize); - } else { - Entry->Data = AllocatePool (DataSize); - ASSERT (Entry->Data != NULL); - - Entry->DataSize = DataSize; - CopyMem (Entry->Data, Data, DataSize); - } - } - } - } -} - - -/** - Search the cache to check if the variable is in it. - - This function searches the variable cache. If the variable to find exists, return its data - and attributes. - - @param VariableName A Null-terminated Unicode string that is the name of the vendor's - variable. Each VariableName is unique for each - VendorGuid. - @param VendorGuid A unique identifier for the vendor - @param Attributes Pointer to the attributes bitmask of the variable for output. - @param DataSize On input, size of the buffer of Data. - On output, size of the variable's data. - @param Data Pointer to the data buffer for output. - - @retval EFI_SUCCESS VariableGuid & VariableName data was returned. - @retval EFI_NOT_FOUND No matching variable found in cache. - @retval EFI_BUFFER_TOO_SMALL *DataSize is smaller than size of the variable's data to return. - -**/ -EFI_STATUS -FindVariableInCache ( - IN CHAR16 *VariableName, - IN EFI_GUID *VendorGuid, - OUT UINT32 *Attributes OPTIONAL, - IN OUT UINTN *DataSize, - OUT VOID *Data - ) -{ - VARIABLE_CACHE_ENTRY *Entry; - UINTN Index; - - if (EfiAtRuntime ()) { - // Don't use the cache at runtime - return EFI_NOT_FOUND; - } - - for (Index = 0, Entry = mVariableCache; Index < sizeof (mVariableCache)/sizeof (VARIABLE_CACHE_ENTRY); Index++, Entry++) { - if (CompareGuid (VendorGuid, Entry->Guid)) { - if (StrCmp (VariableName, Entry->Name) == 0) { - if (Entry->DataSize == 0) { - // Variable was deleted so return not found - return EFI_NOT_FOUND; - } else if (Entry->DataSize > *DataSize) { - // If the buffer is too small return correct size - *DataSize = Entry->DataSize; - return EFI_BUFFER_TOO_SMALL; - } else { - *DataSize = Entry->DataSize; - // Return the data - CopyMem (Data, Entry->Data, Entry->DataSize); - if (Attributes != NULL) { - *Attributes = Entry->Attributes; - } - return EFI_SUCCESS; - } - } - } - } - - return EFI_NOT_FOUND; -} - /** Finds variable in storage blocks of volatile and non-volatile storage areas. @@ -940,7 +722,7 @@ FindVariableInCache ( qualified variable without comparing VariableName and VendorGuid. Otherwise, VariableName and VendorGuid are compared. - @param VariableName Name of the variable to be found + @param VariableName Name of the variable to be found. @param VendorGuid Vendor GUID to be found. @param PtrTrack VARIABLE_POINTER_TRACK structure for output, including the range searched and the target position. @@ -949,9 +731,9 @@ FindVariableInCache ( NV variable storage area, and a lock. @retval EFI_INVALID_PARAMETER If VariableName is not an empty string, while - VendorGuid is NULL - @retval EFI_SUCCESS Variable successfully found - @retval EFI_INVALID_PARAMETER Variable not found + VendorGuid is NULL. + @retval EFI_SUCCESS Variable successfully found. + @retval EFI_NOT_FOUND Variable not found **/ EFI_STATUS @@ -970,12 +752,12 @@ FindVariable ( VOID *Point; // - // 0: Volatile, 1: Non-Volatile + // 0: Volatile, 1: Non-Volatile. // The index and attributes mapping must be kept in this order as RuntimeServiceGetNextVariableName - // make use of this mapping to implement search algorithme. + // make use of this mapping to implement search algorithm. // VariableStoreHeader[0] = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase); - VariableStoreHeader[1] = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase); + VariableStoreHeader[1] = mNvVariableCache; // // Start Pointers for the variable. @@ -989,7 +771,7 @@ FindVariable ( } // - // Find the variable by walk through volatile and then non-volatile variable store + // Find the variable by walk through volatile and then non-volatile variable store. // InDeletedVariable = NULL; InDeletedStorageIndex = 0; @@ -998,7 +780,7 @@ FindVariable ( if (Variable[Index]->State == VAR_ADDED || Variable[Index]->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED) ) { - if (!EfiAtRuntime () || ((Variable[Index]->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) != 0)) { + if (!AtRuntime () || ((Variable[Index]->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) != 0)) { if (VariableName[0] == 0) { if (Variable[Index]->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) { InDeletedVariable = Variable[Index]; @@ -1071,11 +853,10 @@ FindVariable ( @param Lang Configured language. @param Iso639Language A bool value to signify if the handler is operated on ISO639 or RFC4646. - @retval the index of language in the language codes. + @retval The index of language in the language codes. **/ UINTN -EFIAPI GetIndexFromSupportedLangCodes( IN CHAR8 *SupportedLang, IN CHAR8 *Lang, @@ -1083,13 +864,11 @@ GetIndexFromSupportedLangCodes( ) { UINTN Index; - UINT32 CompareLength; - CHAR8 *Supported; + UINTN CompareLength; + UINTN LanguageLength; - Index = 0; - Supported = SupportedLang; if (Iso639Language) { - CompareLength = 3; + CompareLength = ISO_639_2_ENTRY_SIZE; for (Index = 0; Index < AsciiStrLen (SupportedLang); Index += CompareLength) { if (AsciiStrnCmp (Lang, SupportedLang + Index, CompareLength) == 0) { // @@ -1105,20 +884,26 @@ GetIndexFromSupportedLangCodes( // // Compare RFC4646 language code // - while (*Supported != '\0') { + Index = 0; + for (LanguageLength = 0; Lang[LanguageLength] != '\0'; LanguageLength++); + + for (Index = 0; *SupportedLang != '\0'; Index++, SupportedLang += CompareLength) { // - // take semicolon as delimitation, sequentially traverse supported language codes. + // Skip ';' characters in SupportedLang // - for (CompareLength = 0; *Supported != ';' && *Supported != '\0'; CompareLength++) { - Supported++; - } - if (AsciiStrnCmp (Lang, Supported - CompareLength, CompareLength) == 0) { + for (; *SupportedLang != '\0' && *SupportedLang == ';'; SupportedLang++); + // + // Determine the length of the next language code in SupportedLang + // + for (CompareLength = 0; SupportedLang[CompareLength] != '\0' && SupportedLang[CompareLength] != ';'; CompareLength++); + + if ((CompareLength == LanguageLength) && + (AsciiStrnCmp (Lang, SupportedLang, CompareLength) == 0)) { // // Successfully find the index of Lang string in SupportedLang string. // return Index; } - Index++; } ASSERT (FALSE); return 0; @@ -1128,7 +913,7 @@ GetIndexFromSupportedLangCodes( /** Get language string from supported language codes according to index. - This code is used to get corresponding language string in supported language codes. It can handle + This code is used to get corresponding language strings in supported language codes. It can handle RFC4646 and ISO639 language tags. In ISO639 language tags, take 3-characters as a delimitation. Find language string according to the index. In RFC4646 language tags, take semicolon as a delimitation. Find language string according to the index. @@ -1145,14 +930,13 @@ GetIndexFromSupportedLangCodes( The return value is "fr". @param SupportedLang Platform supported language codes. - @param Index the index in supported language codes. + @param Index The index in supported language codes. @param Iso639Language A bool value to signify if the handler is operated on ISO639 or RFC4646. - @retval the language string in the language codes. + @retval The language string in the language codes. **/ CHAR8 * -EFIAPI GetLangFromSupportedLangCodes ( IN CHAR8 *SupportedLang, IN UINTN Index, @@ -1160,25 +944,25 @@ GetLangFromSupportedLangCodes ( ) { UINTN SubIndex; - UINT32 CompareLength; + UINTN CompareLength; CHAR8 *Supported; SubIndex = 0; Supported = SupportedLang; if (Iso639Language) { // - // according to the index of Lang string in SupportedLang string to get the language. - // As this code will be invoked in RUNTIME, therefore there is not memory allocate/free operation. + // According to the index of Lang string in SupportedLang string to get the language. + // This code will be invoked in RUNTIME, therefore there is not a memory allocate/free operation. // In driver entry, it pre-allocates a runtime attribute memory to accommodate this string. // - CompareLength = 3; - SetMem (mVariableModuleGlobal->Lang, sizeof(mVariableModuleGlobal->Lang), 0); + CompareLength = ISO_639_2_ENTRY_SIZE; + mVariableModuleGlobal->Lang[CompareLength] = '\0'; return CopyMem (mVariableModuleGlobal->Lang, SupportedLang + Index * CompareLength, CompareLength); } else { while (TRUE) { // - // take semicolon as delimitation, sequentially traverse supported language codes. + // Take semicolon as delimitation, sequentially traverse supported language codes. // for (CompareLength = 0; *Supported != ';' && *Supported != '\0'; CompareLength++) { Supported++; @@ -1193,18 +977,154 @@ GetLangFromSupportedLangCodes ( } if (SubIndex == Index) { // - // according to the index of Lang string in SupportedLang string to get the language. + // According to the index of Lang string in SupportedLang string to get the language. // As this code will be invoked in RUNTIME, therefore there is not memory allocate/free operation. // In driver entry, it pre-allocates a runtime attribute memory to accommodate this string. // - SetMem (mVariableModuleGlobal->PlatformLang, sizeof (mVariableModuleGlobal->PlatformLang), 0); + mVariableModuleGlobal->PlatformLang[CompareLength] = '\0'; return CopyMem (mVariableModuleGlobal->PlatformLang, Supported - CompareLength, CompareLength); } SubIndex++; + + // + // Skip ';' characters in Supported + // + for (; *Supported != '\0' && *Supported == ';'; Supported++); } } } +/** + Returns a pointer to an allocated buffer that contains the best matching language + from a set of supported languages. + + This function supports both ISO 639-2 and RFC 4646 language codes, but language + code types may not be mixed in a single call to this function. This function + supports a variable argument list that allows the caller to pass in a prioritized + list of language codes to test against all the language codes in SupportedLanguages. + + If SupportedLanguages is NULL, then ASSERT(). + + @param[in] SupportedLanguages A pointer to a Null-terminated ASCII string that + contains a set of language codes in the format + specified by Iso639Language. + @param[in] Iso639Language If TRUE, then all language codes are assumed to be + in ISO 639-2 format. If FALSE, then all language + codes are assumed to be in RFC 4646 language format + @param[in] ... A variable argument list that contains pointers to + Null-terminated ASCII strings that contain one or more + language codes in the format specified by Iso639Language. + The first language code from each of these language + code lists is used to determine if it is an exact or + close match to any of the language codes in + SupportedLanguages. Close matches only apply to RFC 4646 + language codes, and the matching algorithm from RFC 4647 + is used to determine if a close match is present. If + an exact or close match is found, then the matching + language code from SupportedLanguages is returned. If + no matches are found, then the next variable argument + parameter is evaluated. The variable argument list + is terminated by a NULL. + + @retval NULL The best matching language could not be found in SupportedLanguages. + @retval NULL There are not enough resources available to return the best matching + language. + @retval Other A pointer to a Null-terminated ASCII string that is the best matching + language in SupportedLanguages. + +**/ +CHAR8 * +EFIAPI +VariableGetBestLanguage ( + IN CONST CHAR8 *SupportedLanguages, + IN BOOLEAN Iso639Language, + ... + ) +{ + VA_LIST Args; + CHAR8 *Language; + UINTN CompareLength; + UINTN LanguageLength; + CONST CHAR8 *Supported; + CHAR8 *Buffer; + + ASSERT (SupportedLanguages != NULL); + + VA_START (Args, Iso639Language); + while ((Language = VA_ARG (Args, CHAR8 *)) != NULL) { + // + // Default to ISO 639-2 mode + // + CompareLength = 3; + LanguageLength = MIN (3, AsciiStrLen (Language)); + + // + // If in RFC 4646 mode, then determine the length of the first RFC 4646 language code in Language + // + if (!Iso639Language) { + for (LanguageLength = 0; Language[LanguageLength] != 0 && Language[LanguageLength] != ';'; LanguageLength++); + } + + // + // Trim back the length of Language used until it is empty + // + while (LanguageLength > 0) { + // + // Loop through all language codes in SupportedLanguages + // + for (Supported = SupportedLanguages; *Supported != '\0'; Supported += CompareLength) { + // + // In RFC 4646 mode, then Loop through all language codes in SupportedLanguages + // + if (!Iso639Language) { + // + // Skip ';' characters in Supported + // + for (; *Supported != '\0' && *Supported == ';'; Supported++); + // + // Determine the length of the next language code in Supported + // + for (CompareLength = 0; Supported[CompareLength] != 0 && Supported[CompareLength] != ';'; CompareLength++); + // + // If Language is longer than the Supported, then skip to the next language + // + if (LanguageLength > CompareLength) { + continue; + } + } + // + // See if the first LanguageLength characters in Supported match Language + // + if (AsciiStrnCmp (Supported, Language, LanguageLength) == 0) { + VA_END (Args); + + Buffer = Iso639Language ? mVariableModuleGlobal->Lang : mVariableModuleGlobal->PlatformLang; + Buffer[CompareLength] = '\0'; + return CopyMem (Buffer, Supported, CompareLength); + } + } + + if (Iso639Language) { + // + // If ISO 639 mode, then each language can only be tested once + // + LanguageLength = 0; + } else { + // + // If RFC 4646 mode, then trim Language from the right to the next '-' character + // + for (LanguageLength--; LanguageLength > 0 && Language[LanguageLength] != '-'; LanguageLength--); + } + } + } + VA_END (Args); + + // + // No matches were found + // + return NULL; +} + /** Hook the operations in PlatformLangCodes, LangCodes, PlatformLang and Lang. @@ -1213,139 +1133,218 @@ GetLangFromSupportedLangCodes ( According to UEFI spec, PlatformLangCodes/LangCodes are only set once in firmware initialization, and are read-only. Therefore, in variable driver, only store the original value for other use. - @param[in] VariableName Name of variable - - @param[in] Data Variable data + @param[in] VariableName Name of variable. - @param[in] DataSize Size of data. 0 means delete + @param[in] Data Variable data. - @retval EFI_SUCCESS auto update operation is successful. + @param[in] DataSize Size of data. 0 means delete. **/ -EFI_STATUS -EFIAPI +VOID AutoUpdateLangVariable( IN CHAR16 *VariableName, IN VOID *Data, IN UINTN DataSize ) { - EFI_STATUS Status; - CHAR8 *BestPlatformLang; - CHAR8 *BestLang; - UINTN Index; - UINT32 Attributes; + EFI_STATUS Status; + CHAR8 *BestPlatformLang; + CHAR8 *BestLang; + UINTN Index; + UINT32 Attributes; VARIABLE_POINTER_TRACK Variable; + BOOLEAN SetLanguageCodes; // - // According to UEFI spec, "Lang" and "PlatformLang" is NV|BS|RT attributions. + // Don't do updates for delete operation // - Attributes = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS; + if (DataSize == 0) { + return; + } + + SetLanguageCodes = FALSE; if (StrCmp (VariableName, L"PlatformLangCodes") == 0) { + // + // PlatformLangCodes is a volatile variable, so it can not be updated at runtime. + // + if (AtRuntime ()) { + return; + } + + SetLanguageCodes = TRUE; + // // According to UEFI spec, PlatformLangCodes is only set once in firmware initialization, and is read-only // Therefore, in variable driver, only store the original value for other use. // - AsciiStrnCpy (mVariableModuleGlobal->PlatformLangCodes, Data, DataSize); - } else if (StrCmp (VariableName, L"LangCodes") == 0) { + if (mVariableModuleGlobal->PlatformLangCodes != NULL) { + FreePool (mVariableModuleGlobal->PlatformLangCodes); + } + mVariableModuleGlobal->PlatformLangCodes = AllocateRuntimeCopyPool (DataSize, Data); + ASSERT (mVariableModuleGlobal->PlatformLangCodes != NULL); + // - // According to UEFI spec, LangCodes is only set once in firmware initialization, and is read-only - // Therefore, in variable driver, only store the original value for other use. + // PlatformLang holds a single language from PlatformLangCodes, + // so the size of PlatformLangCodes is enough for the PlatformLang. // - AsciiStrnCpy (mVariableModuleGlobal->LangCodes, Data, DataSize); - } else if ((StrCmp (VariableName, L"PlatformLang") == 0) && (DataSize != 0)) { - ASSERT (AsciiStrLen (mVariableModuleGlobal->PlatformLangCodes) != 0); + if (mVariableModuleGlobal->PlatformLang != NULL) { + FreePool (mVariableModuleGlobal->PlatformLang); + } + mVariableModuleGlobal->PlatformLang = AllocateRuntimePool (DataSize); + ASSERT (mVariableModuleGlobal->PlatformLang != NULL); + } else if (StrCmp (VariableName, L"LangCodes") == 0) { // - // When setting PlatformLang, firstly get most matched language string from supported language codes. + // LangCodes is a volatile variable, so it can not be updated at runtime. // - BestPlatformLang = GetBestLanguage(mVariableModuleGlobal->PlatformLangCodes, FALSE, Data, NULL); + if (AtRuntime ()) { + return; + } + + SetLanguageCodes = TRUE; // - // Get the corresponding index in language codes. + // According to UEFI spec, LangCodes is only set once in firmware initialization, and is read-only + // Therefore, in variable driver, only store the original value for other use. // - Index = GetIndexFromSupportedLangCodes(mVariableModuleGlobal->PlatformLangCodes, BestPlatformLang, FALSE); + if (mVariableModuleGlobal->LangCodes != NULL) { + FreePool (mVariableModuleGlobal->LangCodes); + } + mVariableModuleGlobal->LangCodes = AllocateRuntimeCopyPool (DataSize, Data); + ASSERT (mVariableModuleGlobal->LangCodes != NULL); + } + if (SetLanguageCodes + && (mVariableModuleGlobal->PlatformLangCodes != NULL) + && (mVariableModuleGlobal->LangCodes != NULL)) { // - // Get the corresponding ISO639 language tag according to RFC4646 language tag. + // Update Lang if PlatformLang is already set + // Update PlatformLang if Lang is already set // - BestLang = GetLangFromSupportedLangCodes(mVariableModuleGlobal->LangCodes, Index, TRUE); + Status = FindVariable (L"PlatformLang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *) mVariableModuleGlobal); + if (!EFI_ERROR (Status)) { + // + // Update Lang + // + VariableName = L"PlatformLang"; + Data = GetVariableDataPtr (Variable.CurrPtr); + DataSize = Variable.CurrPtr->DataSize; + } else { + Status = FindVariable (L"Lang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *) mVariableModuleGlobal); + if (!EFI_ERROR (Status)) { + // + // Update PlatformLang + // + VariableName = L"Lang"; + Data = GetVariableDataPtr (Variable.CurrPtr); + DataSize = Variable.CurrPtr->DataSize; + } else { + // + // Neither PlatformLang nor Lang is set, directly return + // + return; + } + } + } + + // + // According to UEFI spec, "Lang" and "PlatformLang" is NV|BS|RT attributions. + // + Attributes = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS; + if (StrCmp (VariableName, L"PlatformLang") == 0) { // - // Successfully convert PlatformLang to Lang, and set the BestLang value into Lang variable simultaneously. + // Update Lang when PlatformLangCodes/LangCodes were set. // - FindVariable(L"Lang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *)mVariableModuleGlobal); + if ((mVariableModuleGlobal->PlatformLangCodes != NULL) && (mVariableModuleGlobal->LangCodes != NULL)) { + // + // When setting PlatformLang, firstly get most matched language string from supported language codes. + // + BestPlatformLang = VariableGetBestLanguage (mVariableModuleGlobal->PlatformLangCodes, FALSE, Data, NULL); + if (BestPlatformLang != NULL) { + // + // Get the corresponding index in language codes. + // + Index = GetIndexFromSupportedLangCodes (mVariableModuleGlobal->PlatformLangCodes, BestPlatformLang, FALSE); - Status = UpdateVariable(L"Lang", &gEfiGlobalVariableGuid, - BestLang, ISO_639_2_ENTRY_SIZE + 1, Attributes, &Variable); + // + // Get the corresponding ISO639 language tag according to RFC4646 language tag. + // + BestLang = GetLangFromSupportedLangCodes (mVariableModuleGlobal->LangCodes, Index, TRUE); - DEBUG((EFI_D_INFO, "Variable Driver Auto Update PlatformLang, PlatformLang:%a, Lang:%a\n", BestPlatformLang, BestLang)); + // + // Successfully convert PlatformLang to Lang, and set the BestLang value into Lang variable simultaneously. + // + FindVariable (L"Lang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *)mVariableModuleGlobal); - ASSERT_EFI_ERROR(Status); - - } else if ((StrCmp (VariableName, L"Lang") == 0) && (DataSize != 0)) { - ASSERT (AsciiStrLen (mVariableModuleGlobal->LangCodes) != 0); + Status = UpdateVariable (L"Lang", &gEfiGlobalVariableGuid, BestLang, + ISO_639_2_ENTRY_SIZE + 1, Attributes, &Variable); - // - // When setting Lang, firstly get most matched language string from supported language codes. - // - BestLang = GetBestLanguage(mVariableModuleGlobal->LangCodes, TRUE, Data, NULL); + DEBUG ((EFI_D_INFO, "Variable Driver Auto Update PlatformLang, PlatformLang:%a, Lang:%a\n", BestPlatformLang, BestLang)); - // - // Get the corresponding index in language codes. - // - Index = GetIndexFromSupportedLangCodes(mVariableModuleGlobal->LangCodes, BestLang, TRUE); + ASSERT_EFI_ERROR(Status); + } + } + } else if (StrCmp (VariableName, L"Lang") == 0) { // - // Get the corresponding RFC4646 language tag according to ISO639 language tag. + // Update PlatformLang when PlatformLangCodes/LangCodes were set. // - BestPlatformLang = GetLangFromSupportedLangCodes(mVariableModuleGlobal->PlatformLangCodes, Index, FALSE); + if ((mVariableModuleGlobal->PlatformLangCodes != NULL) && (mVariableModuleGlobal->LangCodes != NULL)) { + // + // When setting Lang, firstly get most matched language string from supported language codes. + // + BestLang = VariableGetBestLanguage (mVariableModuleGlobal->LangCodes, TRUE, Data, NULL); + if (BestLang != NULL) { + // + // Get the corresponding index in language codes. + // + Index = GetIndexFromSupportedLangCodes (mVariableModuleGlobal->LangCodes, BestLang, TRUE); - // - // Successfully convert Lang to PlatformLang, and set the BestPlatformLang value into PlatformLang variable simultaneously. - // - FindVariable(L"PlatformLang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *)mVariableModuleGlobal); + // + // Get the corresponding RFC4646 language tag according to ISO639 language tag. + // + BestPlatformLang = GetLangFromSupportedLangCodes (mVariableModuleGlobal->PlatformLangCodes, Index, FALSE); - Status = UpdateVariable(L"PlatformLang", &gEfiGlobalVariableGuid, - BestPlatformLang, AsciiStrSize (BestPlatformLang), Attributes, &Variable); + // + // Successfully convert Lang to PlatformLang, and set the BestPlatformLang value into PlatformLang variable simultaneously. + // + FindVariable (L"PlatformLang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *)mVariableModuleGlobal); - DEBUG((EFI_D_INFO, "Variable Driver Auto Update Lang, Lang:%a, PlatformLang:%a\n", BestLang, BestPlatformLang)); - ASSERT_EFI_ERROR(Status); + Status = UpdateVariable (L"PlatformLang", &gEfiGlobalVariableGuid, BestPlatformLang, + AsciiStrSize (BestPlatformLang), Attributes, &Variable); + + DEBUG ((EFI_D_INFO, "Variable Driver Auto Update Lang, Lang:%a, PlatformLang:%a\n", BestLang, BestPlatformLang)); + ASSERT_EFI_ERROR (Status); + } + } } - return EFI_SUCCESS; } /** Update the variable region with Variable information. These are the same arguments as the EFI Variable services. - @param[in] VariableName Name of variable - - @param[in] VendorGuid Guid of variable - - @param[in] Data Variable data - - @param[in] DataSize Size of data. 0 means delete - - @param[in] Attributes Attribues of the variable - - @param[in] Variable The variable information which is used to keep track of variable usage. - + @param[in] VariableName Name of variable. + @param[in] VendorGuid Guid of variable. + @param[in] Data Variable data. + @param[in] DataSize Size of data. 0 means delete. + @param[in] Attributes Attribues of the variable. + @param[in] CacheVariable The variable information which is used to keep track of variable usage. + @retval EFI_SUCCESS The update operation is success. - @retval EFI_OUT_OF_RESOURCES Variable region is full, can not write other data into this region. **/ EFI_STATUS -EFIAPI UpdateVariable ( - IN CHAR16 *VariableName, - IN EFI_GUID *VendorGuid, - IN VOID *Data, - IN UINTN DataSize, - IN UINT32 Attributes OPTIONAL, - IN VARIABLE_POINTER_TRACK *Variable + IN CHAR16 *VariableName, + IN EFI_GUID *VendorGuid, + IN VOID *Data, + IN UINTN DataSize, + IN UINT32 Attributes OPTIONAL, + IN VARIABLE_POINTER_TRACK *CacheVariable ) { EFI_STATUS Status; @@ -1360,19 +1359,45 @@ UpdateVariable ( EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb; UINT8 State; BOOLEAN Reclaimed; + VARIABLE_POINTER_TRACK *Variable; + VARIABLE_POINTER_TRACK NvVariable; + VARIABLE_STORE_HEADER *VariableStoreHeader; + UINTN CacheOffset; - Fvb = mVariableModuleGlobal->FvbInstance; - Reclaimed = FALSE; + if ((mVariableModuleGlobal->FvbInstance == NULL) && ((Attributes & EFI_VARIABLE_NON_VOLATILE) != 0)) { + // + // The FVB protocol is not ready. Trying to update NV variable prior to the installation + // of EFI_VARIABLE_WRITE_ARCH_PROTOCOL. + // + return EFI_NOT_AVAILABLE_YET; + } + + if ((CacheVariable->CurrPtr == NULL) || CacheVariable->Volatile) { + Variable = CacheVariable; + } else { + // + // Update/Delete existing NV variable. + // CacheVariable points to the variable in the memory copy of Flash area + // Now let Variable points to the same variable in Flash area. + // + VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase); + Variable = &NvVariable; + Variable->StartPtr = GetStartPointer (VariableStoreHeader); + Variable->EndPtr = GetEndPointer (VariableStoreHeader); + Variable->CurrPtr = (VARIABLE_HEADER *)((UINTN)Variable->StartPtr + ((UINTN)CacheVariable->CurrPtr - (UINTN)CacheVariable->StartPtr)); + Variable->Volatile = FALSE; + } + + Fvb = mVariableModuleGlobal->FvbInstance; + Reclaimed = FALSE; if (Variable->CurrPtr != NULL) { // - // Update/Delete existing variable + // Update/Delete existing variable. // - Volatile = Variable->Volatile; - - if (EfiAtRuntime ()) { + if (AtRuntime ()) { // - // If EfiAtRuntime and the variable is Volatile and Runtime Access, + // If AtRuntime and the variable is Volatile and Runtime Access, // the volatile is ReadOnly, and SetVariable should be aborted and // return EFI_WRITE_PROTECTED. // @@ -1381,16 +1406,17 @@ UpdateVariable ( goto Done; } // - // Only variable have NV attribute can be updated/deleted in Runtime + // Only variable that have NV attributes can be updated/deleted in Runtime. // if ((Variable->CurrPtr->Attributes & EFI_VARIABLE_NON_VOLATILE) == 0) { Status = EFI_INVALID_PARAMETER; goto Done; } } + // // Setting a data variable with no access, or zero DataSize attributes - // specified causes it to be deleted. + // causes it to be deleted. // if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) { State = Variable->CurrPtr->State; @@ -1406,26 +1432,28 @@ UpdateVariable ( &State ); if (!EFI_ERROR (Status)) { - UpdateVariableInfo (VariableName, VendorGuid, Volatile, FALSE, FALSE, TRUE, FALSE); - UpdateVariableCache (VariableName, VendorGuid, Attributes, DataSize, Data); + UpdateVariableInfo (VariableName, VendorGuid, Variable->Volatile, FALSE, FALSE, TRUE, FALSE); + if (!Variable->Volatile) { + CacheVariable->CurrPtr->State = State; + } } goto Done; } // - // If the variable is marked valid and the same data has been passed in + // If the variable is marked valid, and the same data has been passed in, // then return to the caller immediately. // if (DataSizeOfVariable (Variable->CurrPtr) == DataSize && (CompareMem (Data, GetVariableDataPtr (Variable->CurrPtr), DataSize) == 0)) { - UpdateVariableInfo (VariableName, VendorGuid, Volatile, FALSE, TRUE, FALSE, FALSE); + UpdateVariableInfo (VariableName, VendorGuid, Variable->Volatile, FALSE, TRUE, FALSE, FALSE); Status = EFI_SUCCESS; goto Done; } else if ((Variable->CurrPtr->State == VAR_ADDED) || (Variable->CurrPtr->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION))) { // - // Mark the old variable as in delete transition + // Mark the old variable as in delete transition. // State = Variable->CurrPtr->State; State &= VAR_IN_DELETED_TRANSITION; @@ -1442,15 +1470,18 @@ UpdateVariable ( if (EFI_ERROR (Status)) { goto Done; } + if (!Variable->Volatile) { + CacheVariable->CurrPtr->State = State; + } } } else { // - // Not found existing variable. Create a new variable + // Not found existing variable. Create a new variable. // // // Make sure we are trying to create a new variable. - // Setting a data variable with no access, or zero DataSize attributes means to delete it. + // Setting a data variable with zero DataSize or no access attributes means to delete it. // if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) { Status = EFI_NOT_FOUND; @@ -1458,9 +1489,9 @@ UpdateVariable ( } // - // Only variable have NV|RT attribute can be created in Runtime + // Only variable have NV|RT attribute can be created in Runtime. // - if (EfiAtRuntime () && + if (AtRuntime () && (((Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0) || ((Attributes & EFI_VARIABLE_NON_VOLATILE) == 0))) { Status = EFI_INVALID_PARAMETER; goto Done; @@ -1470,6 +1501,7 @@ UpdateVariable ( // // Function part - create a new variable and copy the data. // Both update a variable and create a variable will come here. + // // Tricky part: Use scratch data area at the end of volatile variable store // as a temporary storage. @@ -1484,9 +1516,9 @@ UpdateVariable ( // // NextVariable->State = VAR_ADDED; // - NextVariable->Reserved = 0; - VarNameOffset = sizeof (VARIABLE_HEADER); - VarNameSize = StrSize (VariableName); + NextVariable->Reserved = 0; + VarNameOffset = sizeof (VARIABLE_HEADER); + VarNameSize = StrSize (VariableName); CopyMem ( (UINT8 *) ((UINTN) NextVariable + VarNameOffset), VariableName, @@ -1502,7 +1534,7 @@ UpdateVariable ( // // There will be pad bytes after Data, the NextVariable->NameSize and // NextVariable->DataSize should not include pad size so that variable - // service can get actual size in GetVariable + // service can get actual size in GetVariable. // NextVariable->NameSize = (UINT32)VarNameSize; NextVariable->DataSize = (UINT32)DataSize; @@ -1514,7 +1546,7 @@ UpdateVariable ( VarSize = VarDataOffset + DataSize + GET_PAD_SIZE (DataSize); if ((Attributes & EFI_VARIABLE_NON_VOLATILE) != 0) { // - // Create a nonvolatile variable + // Create a nonvolatile variable. // Volatile = FALSE; NonVolatileVarableStoreSize = ((VARIABLE_STORE_HEADER *)(UINTN)(mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase))->Size; @@ -1522,12 +1554,12 @@ UpdateVariable ( && ((VarSize + mVariableModuleGlobal->HwErrVariableTotalSize) > PcdGet32 (PcdHwErrStorageSize))) || (((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == 0) && ((VarSize + mVariableModuleGlobal->CommonVariableTotalSize) > NonVolatileVarableStoreSize - sizeof (VARIABLE_STORE_HEADER) - PcdGet32 (PcdHwErrStorageSize)))) { - if (EfiAtRuntime ()) { + if (AtRuntime ()) { Status = EFI_OUT_OF_RESOURCES; goto Done; } // - // Perform garbage collection & reclaim operation + // Perform garbage collection & reclaim operation. // Status = Reclaim (mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase, &mVariableModuleGlobal->NonVolatileLastVariableOffset, FALSE, Variable->CurrPtr); @@ -1535,7 +1567,7 @@ UpdateVariable ( goto Done; } // - // If still no enough space, return out of resources + // If still no enough space, return out of resources. // if ((((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != 0) && ((VarSize + mVariableModuleGlobal->HwErrVariableTotalSize) > PcdGet32 (PcdHwErrStorageSize))) @@ -1547,7 +1579,7 @@ UpdateVariable ( Reclaimed = TRUE; } // - // Three steps + // Four steps // 1. Write variable header // 2. Set variable state to header valid // 3. Write variable data @@ -1556,6 +1588,7 @@ UpdateVariable ( // // Step 1: // + CacheOffset = mVariableModuleGlobal->NonVolatileLastVariableOffset; Status = UpdateVariableStore ( &mVariableModuleGlobal->VariableGlobal, FALSE, @@ -1579,9 +1612,9 @@ UpdateVariable ( FALSE, TRUE, Fvb, - mVariableModuleGlobal->NonVolatileLastVariableOffset, - sizeof (VARIABLE_HEADER), - (UINT8 *) NextVariable + mVariableModuleGlobal->NonVolatileLastVariableOffset + OFFSET_OF (VARIABLE_HEADER, State), + sizeof (UINT8), + &NextVariable->State ); if (EFI_ERROR (Status)) { @@ -1612,9 +1645,9 @@ UpdateVariable ( FALSE, TRUE, Fvb, - mVariableModuleGlobal->NonVolatileLastVariableOffset, - sizeof (VARIABLE_HEADER), - (UINT8 *) NextVariable + mVariableModuleGlobal->NonVolatileLastVariableOffset + OFFSET_OF (VARIABLE_HEADER, State), + sizeof (UINT8), + &NextVariable->State ); if (EFI_ERROR (Status)) { @@ -1628,16 +1661,20 @@ UpdateVariable ( } else { mVariableModuleGlobal->CommonVariableTotalSize += HEADER_ALIGN (VarSize); } + // + // update the memory copy of Flash region. + // + CopyMem ((UINT8 *)mNvVariableCache + CacheOffset, (UINT8 *)NextVariable, VarSize); } else { // - // Create a volatile variable + // Create a volatile variable. // Volatile = TRUE; if ((UINT32) (VarSize + mVariableModuleGlobal->VolatileLastVariableOffset) > ((VARIABLE_STORE_HEADER *) ((UINTN) (mVariableModuleGlobal->VariableGlobal.VolatileVariableBase)))->Size) { // - // Perform garbage collection & reclaim operation + // Perform garbage collection & reclaim operation. // Status = Reclaim (mVariableModuleGlobal->VariableGlobal.VolatileVariableBase, &mVariableModuleGlobal->VolatileLastVariableOffset, TRUE, Variable->CurrPtr); @@ -1645,7 +1682,7 @@ UpdateVariable ( goto Done; } // - // If still no enough space, return out of resources + // If still no enough space, return out of resources. // if ((UINT32) (VarSize + mVariableModuleGlobal->VolatileLastVariableOffset) > ((VARIABLE_STORE_HEADER *) ((UINTN) (mVariableModuleGlobal->VariableGlobal.VolatileVariableBase)))->Size @@ -1675,7 +1712,7 @@ UpdateVariable ( } // - // Mark the old variable as deleted + // Mark the old variable as deleted. // if (!Reclaimed && !EFI_ERROR (Status) && Variable->CurrPtr != NULL) { State = Variable->CurrPtr->State; @@ -1690,11 +1727,13 @@ UpdateVariable ( sizeof (UINT8), &State ); + if (!EFI_ERROR (Status) && !Variable->Volatile) { + CacheVariable->CurrPtr->State = State; + } } if (!EFI_ERROR (Status)) { UpdateVariableInfo (VariableName, VendorGuid, Volatile, FALSE, TRUE, FALSE, FALSE); - UpdateVariableCache (VariableName, VendorGuid, Attributes, DataSize, Data); } Done: @@ -1712,15 +1751,15 @@ Done: data, this value contains the required size. @param Data Data pointer. - @return EFI_INVALID_PARAMETER Invalid parameter - @return EFI_SUCCESS Find the specified variable - @return EFI_NOT_FOUND Not found - @return EFI_BUFFER_TO_SMALL DataSize is too small for the result + @return EFI_INVALID_PARAMETER Invalid parameter. + @return EFI_SUCCESS Find the specified variable. + @return EFI_NOT_FOUND Not found. + @return EFI_BUFFER_TO_SMALL DataSize is too small for the result. **/ EFI_STATUS EFIAPI -RuntimeServiceGetVariable ( +VariableServiceGetVariable ( IN CHAR16 *VariableName, IN EFI_GUID *VendorGuid, OUT UINT32 *Attributes OPTIONAL, @@ -1737,16 +1776,6 @@ RuntimeServiceGetVariable ( } AcquireLockOnlyAtBootTime(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock); - - // - // Find existing variable - // - Status = FindVariableInCache (VariableName, VendorGuid, Attributes, DataSize, Data); - if ((Status == EFI_BUFFER_TOO_SMALL) || (Status == EFI_SUCCESS)){ - // Hit in the Cache - UpdateVariableInfo (VariableName, VendorGuid, FALSE, TRUE, FALSE, FALSE, TRUE); - goto Done; - } Status = FindVariable (VariableName, VendorGuid, &Variable, &mVariableModuleGlobal->VariableGlobal); if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) { @@ -1772,7 +1801,6 @@ RuntimeServiceGetVariable ( *DataSize = VarDataSize; UpdateVariableInfo (VariableName, VendorGuid, Variable.Volatile, TRUE, FALSE, FALSE, FALSE); - UpdateVariableCache (VariableName, VendorGuid, Variable.CurrPtr->Attributes, VarDataSize, Data); Status = EFI_SUCCESS; goto Done; @@ -1793,19 +1821,19 @@ Done: This code Finds the Next available variable. - @param VariableNameSize Size of the variable name - @param VariableName Pointer to variable name - @param VendorGuid Variable Vendor Guid + @param VariableNameSize Size of the variable name. + @param VariableName Pointer to variable name. + @param VendorGuid Variable Vendor Guid. - @return EFI_INVALID_PARAMETER Invalid parameter - @return EFI_SUCCESS Find the specified variable - @return EFI_NOT_FOUND Not found - @return EFI_BUFFER_TO_SMALL DataSize is too small for the result + @return EFI_INVALID_PARAMETER Invalid parameter. + @return EFI_SUCCESS Find the specified variable. + @return EFI_NOT_FOUND Not found. + @return EFI_BUFFER_TO_SMALL DataSize is too small for the result. **/ EFI_STATUS EFIAPI -RuntimeServiceGetNextVariableName ( +VariableServiceGetNextVariableName ( IN OUT UINTN *VariableNameSize, IN OUT CHAR16 *VariableName, IN OUT EFI_GUID *VendorGuid @@ -1828,7 +1856,7 @@ RuntimeServiceGetNextVariableName ( if (VariableName[0] != 0) { // - // If variable name is not NULL, get next variable + // If variable name is not NULL, get next variable. // Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr); } @@ -1836,7 +1864,7 @@ RuntimeServiceGetNextVariableName ( while (TRUE) { // // If both volatile and non-volatile variable store are parsed, - // return not found + // return not found. // if (Variable.CurrPtr >= Variable.EndPtr || Variable.CurrPtr == NULL) { Variable.Volatile = (BOOLEAN) (Variable.Volatile ^ ((BOOLEAN) 0x1)); @@ -1857,7 +1885,7 @@ RuntimeServiceGetNextVariableName ( // Variable is found // if (IsValidVariableHeader (Variable.CurrPtr) && Variable.CurrPtr->State == VAR_ADDED) { - if ((EfiAtRuntime () && ((Variable.CurrPtr->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0)) == 0) { + if ((AtRuntime () && ((Variable.CurrPtr->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0)) == 0) { VarNameSize = NameSizeOfVariable (Variable.CurrPtr); ASSERT (VarNameSize != 0); @@ -1894,23 +1922,23 @@ Done: This code sets variable in storage blocks (Volatile or Non-Volatile). - @param VariableName Name of Variable to be found - @param VendorGuid Variable vendor GUID + @param VariableName Name of Variable to be found. + @param VendorGuid Variable vendor GUID. @param Attributes Attribute value of the variable found @param DataSize Size of Data found. If size is less than the data, this value contains the required size. - @param Data Data pointer + @param Data Data pointer. - @return EFI_INVALID_PARAMETER Invalid parameter - @return EFI_SUCCESS Set successfully - @return EFI_OUT_OF_RESOURCES Resource not enough to set variable - @return EFI_NOT_FOUND Not found - @return EFI_WRITE_PROTECTED Variable is read-only + @return EFI_INVALID_PARAMETER Invalid parameter. + @return EFI_SUCCESS Set successfully. + @return EFI_OUT_OF_RESOURCES Resource not enough to set variable. + @return EFI_NOT_FOUND Not found. + @return EFI_WRITE_PROTECTED Variable is read-only. **/ EFI_STATUS EFIAPI -RuntimeServiceSetVariable ( +VariableServiceSetVariable ( IN CHAR16 *VariableName, IN EFI_GUID *VendorGuid, IN UINT32 Attributes, @@ -1924,11 +1952,11 @@ RuntimeServiceSetVariable ( EFI_PHYSICAL_ADDRESS Point; // - // Check input parameters + // Check input parameters. // if (VariableName == NULL || VariableName[0] == 0 || VendorGuid == NULL) { return EFI_INVALID_PARAMETER; - } + } if (DataSize != 0 && Data == NULL) { return EFI_INVALID_PARAMETER; @@ -1942,7 +1970,7 @@ RuntimeServiceSetVariable ( } // - // Make sure if runtime bit is set, boot service bit is set also + // Make sure if runtime bit is set, boot service bit is set also. // if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == EFI_VARIABLE_RUNTIME_ACCESS) { return EFI_INVALID_PARAMETER; @@ -1959,7 +1987,7 @@ RuntimeServiceSetVariable ( return EFI_INVALID_PARAMETER; } // - // According to UEFI spec, HARDWARE_ERROR_RECORD variable name convention should be L"HwErrRecXXXX" + // According to UEFI spec, HARDWARE_ERROR_RECORD variable name convention should be L"HwErrRecXXXX". // if (StrnCmp(VariableName, L"HwErrRec", StrLen(L"HwErrRec")) != 0) { return EFI_INVALID_PARAMETER; @@ -1978,12 +2006,12 @@ RuntimeServiceSetVariable ( AcquireLockOnlyAtBootTime(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock); // - // Consider reentrant in MCA/INIT/NMI. It needs be reupdated; + // Consider reentrant in MCA/INIT/NMI. It needs be reupdated. // if (1 < InterlockedIncrement (&mVariableModuleGlobal->VariableGlobal.ReentrantState)) { - Point = mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase;; + Point = mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase; // - // Parse non-volatile variable data and get last variable offset + // Parse non-volatile variable data and get last variable offset. // NextVariable = GetStartPointer ((VARIABLE_STORE_HEADER *) (UINTN) Point); while ((NextVariable < GetEndPointer ((VARIABLE_STORE_HEADER *) (UINTN) Point)) @@ -1994,12 +2022,12 @@ RuntimeServiceSetVariable ( } // - // Check whether the input variable is already existed + // Check whether the input variable is already existed. // FindVariable (VariableName, VendorGuid, &Variable, &mVariableModuleGlobal->VariableGlobal); // - // Hook the operation of setting PlatformLangCodes/PlatformLang and LangCodes/Lang + // Hook the operation of setting PlatformLangCodes/PlatformLang and LangCodes/Lang. // AutoUpdateLangVariable (VariableName, Data, DataSize); @@ -2031,7 +2059,7 @@ RuntimeServiceSetVariable ( **/ EFI_STATUS EFIAPI -RuntimeServiceQueryVariableInfo ( +VariableServiceQueryVariableInfo ( IN UINT32 Attributes, OUT UINT64 *MaximumVariableStorageSize, OUT UINT64 *RemainingVariableStorageSize, @@ -2062,7 +2090,7 @@ RuntimeServiceQueryVariableInfo ( // Make sure if runtime bit is set, boot service bit is set also. // return EFI_INVALID_PARAMETER; - } else if (EfiAtRuntime () && ((Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0)) { + } else if (AtRuntime () && ((Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0)) { // // Make sure RT Attribute is set if we are in Runtime phase. // @@ -2090,7 +2118,7 @@ RuntimeServiceQueryVariableInfo ( // // Query is Non-Volatile related. // - VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase); + VariableStoreHeader = mNvVariableCache; } // @@ -2129,9 +2157,9 @@ RuntimeServiceQueryVariableInfo ( NextVariable = GetNextVariablePtr (Variable); VariableSize = (UINT64) (UINTN) NextVariable - (UINT64) (UINTN) Variable; - if (EfiAtRuntime ()) { + if (AtRuntime ()) { // - // we don't take the state of the variables in mind + // We don't take the state of the variables in mind // when calculating RemainingVariableStorageSize, // since the space occupied by variables not marked with // VAR_ADDED is not allowed to be reclaimed in Runtime. @@ -2143,7 +2171,7 @@ RuntimeServiceQueryVariableInfo ( } } else { // - // Only care about Variables with State VAR_ADDED,because + // Only care about Variables with State VAR_ADDED, because // the space not marked as VAR_ADDED is reclaimable now. // if (Variable->State == VAR_ADDED) { @@ -2156,7 +2184,7 @@ RuntimeServiceQueryVariableInfo ( } // - // Go to the next one + // Go to the next one. // Variable = NextVariable; } @@ -2179,21 +2207,12 @@ RuntimeServiceQueryVariableInfo ( /** - Notification function of EVT_GROUP_READY_TO_BOOT event group. - - This is a notification function registered on EVT_GROUP_READY_TO_BOOT event group. - When the Boot Manager is about to load and execute a boot option, it reclaims variable - storage if free size is below the threshold. - - @param Event Event whose notification function is being invoked - @param Context Pointer to the notification function's context - + This function reclaims variable storage if free size is below the threshold. + **/ VOID -EFIAPI ReclaimForOS( - EFI_EVENT Event, - VOID *Context + VOID ) { EFI_STATUS Status; @@ -2224,10 +2243,58 @@ ReclaimForOS( } } + /** - Initializes variable store area for non-volatile and volatile variable. + Initializes variable write service after FVB was ready. - @param FvbProtocol Pointer to an instance of EFI Firmware Volume Block Protocol. + @retval EFI_SUCCESS Function successfully executed. + @retval Others Fail to initialize the variable service. + +**/ +EFI_STATUS +VariableWriteServiceInitialize ( + VOID + ) +{ + EFI_STATUS Status; + VARIABLE_STORE_HEADER *VariableStoreHeader; + UINTN Index; + UINT8 Data; + EFI_PHYSICAL_ADDRESS VariableStoreBase; + UINT64 VariableStoreLength; + + VariableStoreBase = mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase; + VariableStoreHeader = (VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase; + VariableStoreLength = VariableStoreHeader->Size; + + // + // Check if the free area is really free. + // + for (Index = mVariableModuleGlobal->NonVolatileLastVariableOffset; Index < VariableStoreLength; Index++) { + Data = ((UINT8 *) mNvVariableCache)[Index]; + if (Data != 0xff) { + // + // There must be something wrong in variable store, do reclaim operation. + // + Status = Reclaim ( + mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase, + &mVariableModuleGlobal->NonVolatileLastVariableOffset, + FALSE, + NULL + ); + if (EFI_ERROR (Status)) { + return Status; + } + break; + } + } + + return EFI_SUCCESS; +} + + +/** + Initializes variable store area for non-volatile and volatile variable. @retval EFI_SUCCESS Function successfully executed. @retval EFI_OUT_OF_RESOURCES Fail to allocate enough memory resource. @@ -2235,7 +2302,7 @@ ReclaimForOS( **/ EFI_STATUS VariableCommonInitialize ( - IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvbProtocol + VOID ) { EFI_STATUS Status; @@ -2243,18 +2310,11 @@ VariableCommonInitialize ( VARIABLE_STORE_HEADER *VariableStoreHeader; VARIABLE_HEADER *NextVariable; EFI_PHYSICAL_ADDRESS TempVariableStoreHeader; - EFI_GCD_MEMORY_SPACE_DESCRIPTOR GcdDescriptor; - EFI_PHYSICAL_ADDRESS BaseAddress; - UINT64 Length; - UINTN Index; - UINT8 Data; EFI_PHYSICAL_ADDRESS VariableStoreBase; UINT64 VariableStoreLength; - EFI_EVENT ReadyToBootEvent; UINTN ScratchSize; UINTN VariableSize; - Status = EFI_SUCCESS; // // Allocate runtime memory for variable driver global structure. // @@ -2263,7 +2323,7 @@ VariableCommonInitialize ( return EFI_OUT_OF_RESOURCES; } - EfiInitializeLock(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock, TPL_NOTIFY); + InitializeLock (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock, TPL_NOTIFY); // // Note that in EdkII variable driver implementation, Hardware Error Record type variable @@ -2286,139 +2346,69 @@ VariableCommonInitialize ( SetMem (VolatileVariableStore, PcdGet32 (PcdVariableStoreSize) + ScratchSize, 0xff); // - // Variable Specific Data + // Initialize Variable Specific Data. // mVariableModuleGlobal->VariableGlobal.VolatileVariableBase = (EFI_PHYSICAL_ADDRESS) (UINTN) VolatileVariableStore; mVariableModuleGlobal->VolatileLastVariableOffset = (UINTN) GetStartPointer (VolatileVariableStore) - (UINTN) VolatileVariableStore; - mVariableModuleGlobal->FvbInstance = FvbProtocol; + mVariableModuleGlobal->FvbInstance = NULL; CopyGuid (&VolatileVariableStore->Signature, &gEfiVariableGuid); - VolatileVariableStore->Size = PcdGet32 (PcdVariableStoreSize); - VolatileVariableStore->Format = VARIABLE_STORE_FORMATTED; - VolatileVariableStore->State = VARIABLE_STORE_HEALTHY; - VolatileVariableStore->Reserved = 0; - VolatileVariableStore->Reserved1 = 0; + VolatileVariableStore->Size = PcdGet32 (PcdVariableStoreSize); + VolatileVariableStore->Format = VARIABLE_STORE_FORMATTED; + VolatileVariableStore->State = VARIABLE_STORE_HEALTHY; + VolatileVariableStore->Reserved = 0; + VolatileVariableStore->Reserved1 = 0; // - // Get non volatile varaible store + // Get non-volatile varaible store. // TempVariableStoreHeader = (EFI_PHYSICAL_ADDRESS) PcdGet64 (PcdFlashNvStorageVariableBase64); if (TempVariableStoreHeader == 0) { TempVariableStoreHeader = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageVariableBase); } - - VariableStoreBase = TempVariableStoreHeader + \ + VariableStoreBase = TempVariableStoreHeader + \ + (((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)(TempVariableStoreHeader)) -> HeaderLength); + VariableStoreLength = (UINT64) PcdGet32 (PcdFlashNvStorageVariableSize) - \ (((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)(TempVariableStoreHeader)) -> HeaderLength); - VariableStoreLength = (UINT64) PcdGet32 (PcdFlashNvStorageVariableSize) - \ - (((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)(TempVariableStoreHeader)) -> HeaderLength); - // - // Mark the variable storage region of the FLASH as RUNTIME - // - BaseAddress = VariableStoreBase & (~EFI_PAGE_MASK); - Length = VariableStoreLength + (VariableStoreBase - BaseAddress); - Length = (Length + EFI_PAGE_SIZE - 1) & (~EFI_PAGE_MASK); - - Status = gDS->GetMemorySpaceDescriptor (BaseAddress, &GcdDescriptor); - if (EFI_ERROR (Status)) { - goto Done; - } - Status = gDS->SetMemorySpaceAttributes ( - BaseAddress, - Length, - GcdDescriptor.Attributes | EFI_MEMORY_RUNTIME - ); - if (EFI_ERROR (Status)) { + mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase = VariableStoreBase; + VariableStoreHeader = (VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase; + if (GetVariableStoreStatus (VariableStoreHeader) != EfiValid) { + Status = EFI_VOLUME_CORRUPTED; + DEBUG((EFI_D_INFO, "Variable Store header is corrupted\n")); goto Done; - } + } + ASSERT(VariableStoreHeader->Size == VariableStoreLength); + // - // Get address of non volatile variable store base + // Parse non-volatile variable data and get last variable offset. // - mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase = VariableStoreBase; - VariableStoreHeader = (VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase; - if (GetVariableStoreStatus (VariableStoreHeader) == EfiValid) { - if (~VariableStoreHeader->Size == 0) { - Status = UpdateVariableStore ( - &mVariableModuleGlobal->VariableGlobal, - FALSE, - FALSE, - mVariableModuleGlobal->FvbInstance, - (UINTN) &VariableStoreHeader->Size, - sizeof (UINT32), - (UINT8 *) &VariableStoreLength - ); - // - // As Variables are stored in NV storage, which are slow devices,such as flash. - // Variable operation may skip checking variable program result to improve performance, - // We can assume Variable program is OK through some check point. - // Variable Store Size Setting should be the first Variable write operation, - // We can assume all Read/Write is OK if we can set Variable store size successfully. - // If write fail, we will assert here - // - ASSERT(VariableStoreHeader->Size == VariableStoreLength); - - if (EFI_ERROR (Status)) { - goto Done; - } - } - - // - // Parse non-volatile variable data and get last variable offset - // - NextVariable = GetStartPointer ((VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase); - Status = EFI_SUCCESS; - - while (IsValidVariableHeader (NextVariable)) { - VariableSize = NextVariable->NameSize + NextVariable->DataSize + sizeof (VARIABLE_HEADER); - if ((NextVariable->Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) { - mVariableModuleGlobal->HwErrVariableTotalSize += HEADER_ALIGN (VariableSize); - } else { - mVariableModuleGlobal->CommonVariableTotalSize += HEADER_ALIGN (VariableSize); - } - - NextVariable = GetNextVariablePtr (NextVariable); + NextVariable = GetStartPointer ((VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase); + while (IsValidVariableHeader (NextVariable)) { + VariableSize = NextVariable->NameSize + NextVariable->DataSize + sizeof (VARIABLE_HEADER); + if ((NextVariable->Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) { + mVariableModuleGlobal->HwErrVariableTotalSize += HEADER_ALIGN (VariableSize); + } else { + mVariableModuleGlobal->CommonVariableTotalSize += HEADER_ALIGN (VariableSize); } - mVariableModuleGlobal->NonVolatileLastVariableOffset = (UINTN) NextVariable - (UINTN) VariableStoreBase; - - // - // Check if the free area is really free. - // - for (Index = mVariableModuleGlobal->NonVolatileLastVariableOffset; Index < VariableStoreHeader->Size; Index++) { - Data = ((UINT8 *) (UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase)[Index]; - if (Data != 0xff) { - // - // There must be something wrong in variable store, do reclaim operation. - // - Status = Reclaim ( - mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase, - &mVariableModuleGlobal->NonVolatileLastVariableOffset, - FALSE, - NULL - ); - - if (EFI_ERROR (Status)) { - goto Done; - } - - break; - } - } + NextVariable = GetNextVariablePtr (NextVariable); + } - // - // Register the event handling function to reclaim variable for OS usage. - // - Status = EfiCreateEventReadyToBootEx ( - TPL_NOTIFY, - ReclaimForOS, - NULL, - &ReadyToBootEvent - ); - } else { - Status = EFI_VOLUME_CORRUPTED; - DEBUG((EFI_D_INFO, "Variable Store header is corrupted\n")); + mVariableModuleGlobal->NonVolatileLastVariableOffset = (UINTN) NextVariable - (UINTN) VariableStoreBase; + + // + // Allocate runtime memory used for a memory copy of the FLASH region. + // Keep the memory and the FLASH in sync as updates occur + // + mNvVariableCache = AllocateRuntimeZeroPool ((UINTN)VariableStoreLength); + if (mNvVariableCache == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto Done; } + CopyMem (mNvVariableCache, (CHAR8 *)(UINTN)VariableStoreBase, (UINTN)VariableStoreLength); + Status = EFI_SUCCESS; Done: if (EFI_ERROR (Status)) { @@ -2429,94 +2419,45 @@ Done: return Status; } -/** - Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE - - This is a notification function registered on EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event. - It convers pointer to new virtual address. - - @param Event Event whose notification function is being invoked - @param Context Pointer to the notification function's context - -**/ -VOID -EFIAPI -VariableClassAddressChangeEvent ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->GetBlockSize); - EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->GetPhysicalAddress); - EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->GetAttributes); - EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->SetAttributes); - EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->Read); - EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->Write); - EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->EraseBlocks); - EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance); - EfiConvertPointer ( - 0x0, - (VOID **) &mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase - ); - EfiConvertPointer ( - 0x0, - (VOID **) &mVariableModuleGlobal->VariableGlobal.VolatileVariableBase - ); - EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal); -} /** - Firmware Volume Block Protocol notification event handler. + Get the proper fvb handle and/or fvb protocol by the given Flash address. - Discover NV Variable Store and install Variable Arch Protocol. + @param[in] Address The Flash address. + @param[out] FvbHandle In output, if it is not NULL, it points to the proper FVB handle. + @param[out] FvbProtocol In output, if it is not NULL, it points to the proper FVB protocol. - @param[in] Event Event whose notification function is being invoked. - @param[in] Context Pointer to the notification function's context. **/ -VOID -EFIAPI -FvbNotificationEvent ( - IN EFI_EVENT Event, - IN VOID *Context +EFI_STATUS +GetFvbInfoByAddress ( + IN EFI_PHYSICAL_ADDRESS Address, + OUT EFI_HANDLE *FvbHandle OPTIONAL, + OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL **FvbProtocol OPTIONAL ) { - EFI_STATUS Status; - EFI_HANDLE *HandleBuffer; - UINTN HandleCount; - UINTN Index; - EFI_PHYSICAL_ADDRESS FvbBaseAddress; - EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb; - EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader; - EFI_FVB_ATTRIBUTES_2 Attributes; - EFI_SYSTEM_TABLE *SystemTable; - EFI_PHYSICAL_ADDRESS NvStorageVariableBase; - - SystemTable = (EFI_SYSTEM_TABLE *)Context; - Fvb = NULL; - + EFI_STATUS Status; + EFI_HANDLE *HandleBuffer; + UINTN HandleCount; + UINTN Index; + EFI_PHYSICAL_ADDRESS FvbBaseAddress; + EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb; + EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader; + EFI_FVB_ATTRIBUTES_2 Attributes; + // - // Locate all handles of Fvb protocol + // Get all FVB handles. // - Status = gBS->LocateHandleBuffer ( - ByProtocol, - &gEfiFirmwareVolumeBlockProtocolGuid, - NULL, - &HandleCount, - &HandleBuffer - ); + Status = GetFvbCountAndBuffer (&HandleCount, &HandleBuffer); if (EFI_ERROR (Status)) { - return ; + return EFI_NOT_FOUND; } - + // - // Get the FVB to access variable store + // Get the FVB to access variable store. // + Fvb = NULL; for (Index = 0; Index < HandleCount; Index += 1, Status = EFI_NOT_FOUND, Fvb = NULL) { - Status = gBS->HandleProtocol ( - HandleBuffer[Index], - &gEfiFirmwareVolumeBlockProtocolGuid, - (VOID **) &Fvb - ); + Status = GetFvbByHandle (HandleBuffer[Index], &Fvb); if (EFI_ERROR (Status)) { Status = EFI_NOT_FOUND; break; @@ -2529,8 +2470,9 @@ FvbNotificationEvent ( if (EFI_ERROR (Status) || ((Attributes & EFI_FVB2_WRITE_STATUS) == 0)) { continue; } + // - // Compare the address and select the right one + // Compare the address and select the right one. // Status = Fvb->GetPhysicalAddress (Fvb, &FvbBaseAddress); if (EFI_ERROR (Status)) { @@ -2538,87 +2480,23 @@ FvbNotificationEvent ( } FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) ((UINTN) FvbBaseAddress); - NvStorageVariableBase = (EFI_PHYSICAL_ADDRESS) PcdGet64 (PcdFlashNvStorageVariableBase64); - if (NvStorageVariableBase == 0) { - NvStorageVariableBase = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageVariableBase); - } - - if ((NvStorageVariableBase >= FvbBaseAddress) && (NvStorageVariableBase < (FvbBaseAddress + FwVolHeader->FvLength))) { - Status = EFI_SUCCESS; + if ((Address >= FvbBaseAddress) && (Address < (FvbBaseAddress + FwVolHeader->FvLength))) { + if (FvbHandle != NULL) { + *FvbHandle = HandleBuffer[Index]; + } + if (FvbProtocol != NULL) { + *FvbProtocol = Fvb; + } + Status = EFI_SUCCESS; break; } } - FreePool (HandleBuffer); - if (!EFI_ERROR (Status) && Fvb != NULL) { - // - // Close the notify event to avoid install gEfiVariableArchProtocolGuid & gEfiVariableWriteArchProtocolGuid again. - // - Status = gBS->CloseEvent (Event); - ASSERT_EFI_ERROR (Status); - Status = VariableCommonInitialize (Fvb); - ASSERT_EFI_ERROR (Status); - - SystemTable->RuntimeServices->GetVariable = RuntimeServiceGetVariable; - SystemTable->RuntimeServices->GetNextVariableName = RuntimeServiceGetNextVariableName; - SystemTable->RuntimeServices->SetVariable = RuntimeServiceSetVariable; - SystemTable->RuntimeServices->QueryVariableInfo = RuntimeServiceQueryVariableInfo; - - // - // Now install the Variable Runtime Architectural Protocol on a new handle - // - Status = gBS->InstallMultipleProtocolInterfaces ( - &mHandle, - &gEfiVariableArchProtocolGuid, NULL, - &gEfiVariableWriteArchProtocolGuid, NULL, - NULL - ); - ASSERT_EFI_ERROR (Status); - - Status = gBS->CreateEventEx ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - VariableClassAddressChangeEvent, - NULL, - &gEfiEventVirtualAddressChangeGuid, - &mVirtualAddressChangeEvent - ); - ASSERT_EFI_ERROR (Status); + if (Fvb == NULL) { + Status = EFI_NOT_FOUND; } - -} - -/** - Variable Driver main entry point. The Variable driver places the 4 EFI - runtime services in the EFI System Table and installs arch protocols - for variable read and write services being availible. It also registers - notification function for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event. - - @param[in] ImageHandle The firmware allocated handle for the EFI image. - @param[in] SystemTable A pointer to the EFI System Table. - @retval EFI_SUCCESS Variable service successfully initialized. - -**/ -EFI_STATUS -EFIAPI -VariableServiceInitialize ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ) -{ - // - // Register FvbNotificationEvent () notify function. - // - EfiCreateProtocolNotifyEvent ( - &gEfiFirmwareVolumeBlockProtocolGuid, - TPL_CALLBACK, - FvbNotificationEvent, - (VOID *)SystemTable, - &mFvbRegistration - ); - - return EFI_SUCCESS; + return Status; }