2 The common variable operation routines shared by DXE_RUNTIME variable
3 module and DXE_SMM variable module.
5 Caution: This module requires additional review when modified.
6 This driver will have external input - variable data. They may be input in SMM mode.
7 This external input must be validated carefully to avoid security issue like
8 buffer overflow, integer overflow.
10 VariableServiceGetNextVariableName () and VariableServiceQueryVariableInfo() are external API.
11 They need check input parameter.
13 VariableServiceGetVariable() and VariableServiceSetVariable() are external API
14 to receive datasize and data buffer. The size should be checked carefully.
16 VariableServiceSetVariable() should also check authenticate data to avoid buffer overflow,
17 integer overflow. It should also check attribute to avoid authentication bypass.
19 Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
20 This program and the accompanying materials
21 are licensed and made available under the terms and conditions of the BSD License
22 which accompanies this distribution. The full text of the license may be found at
23 http://opensource.org/licenses/bsd-license.php
25 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
26 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
31 #include "AuthService.h"
33 VARIABLE_MODULE_GLOBAL
*mVariableModuleGlobal
;
36 /// Define a memory cache that improves the search performance for a variable.
38 VARIABLE_STORE_HEADER
*mNvVariableCache
= NULL
;
41 /// The memory entry used for variable statistics data.
43 VARIABLE_INFO_ENTRY
*gVariableInfo
= NULL
;
46 /// The list to store the variables which cannot be set after the EFI_END_OF_DXE_EVENT_GROUP_GUID
47 /// or EVT_GROUP_READY_TO_BOOT event.
49 LIST_ENTRY mLockedVariableList
= INITIALIZE_LIST_HEAD_VARIABLE (mLockedVariableList
);
52 /// The flag to indicate whether the platform has left the DXE phase of execution.
54 BOOLEAN mEndOfDxe
= FALSE
;
57 /// The flag to indicate whether the variable storage locking is enabled.
59 BOOLEAN mEnableLocking
= TRUE
;
62 // To prevent name collisions with possible future globally defined variables,
63 // other internal firmware data variables that are not defined here must be
64 // saved with a unique VendorGuid other than EFI_GLOBAL_VARIABLE or
65 // any other GUID defined by the UEFI Specification. Implementations must
66 // only permit the creation of variables with a UEFI Specification-defined
67 // VendorGuid when these variables are documented in the UEFI Specification.
69 GLOBAL_VARIABLE_ENTRY mGlobalVariableList
[] = {
70 {EFI_LANG_CODES_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
71 {EFI_LANG_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_NV_BS_RT
},
72 {EFI_TIME_OUT_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_NV_BS_RT
},
73 {EFI_PLATFORM_LANG_CODES_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
74 {EFI_PLATFORM_LANG_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_NV_BS_RT
},
75 {EFI_CON_IN_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_NV_BS_RT
},
76 {EFI_CON_OUT_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_NV_BS_RT
},
77 {EFI_ERR_OUT_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_NV_BS_RT
},
78 {EFI_CON_IN_DEV_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
79 {EFI_CON_OUT_DEV_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
80 {EFI_ERR_OUT_DEV_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
81 {EFI_BOOT_ORDER_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_NV_BS_RT
},
82 {EFI_BOOT_NEXT_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_NV_BS_RT
},
83 {EFI_BOOT_CURRENT_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
84 {EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
85 {EFI_DRIVER_ORDER_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_NV_BS_RT
},
86 {EFI_HW_ERR_REC_SUPPORT_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_NV_BS_RT
},
87 {EFI_SETUP_MODE_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
88 {EFI_KEY_EXCHANGE_KEY_NAME
, VARIABLE_ATTRIBUTE_NV_BS_RT_AT
},
89 {EFI_PLATFORM_KEY_NAME
, VARIABLE_ATTRIBUTE_NV_BS_RT_AT
},
90 {EFI_SIGNATURE_SUPPORT_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
91 {EFI_SECURE_BOOT_MODE_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
92 {EFI_KEK_DEFAULT_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
93 {EFI_PK_DEFAULT_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
94 {EFI_DB_DEFAULT_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
95 {EFI_DBX_DEFAULT_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
96 {EFI_DBT_DEFAULT_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
97 {EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
98 {EFI_OS_INDICATIONS_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_NV_BS_RT
},
99 {EFI_VENDOR_KEYS_VARIABLE_NAME
, VARIABLE_ATTRIBUTE_BS_RT
},
101 GLOBAL_VARIABLE_ENTRY mGlobalVariableList2
[] = {
102 {L
"Boot####", VARIABLE_ATTRIBUTE_NV_BS_RT
},
103 {L
"Driver####", VARIABLE_ATTRIBUTE_NV_BS_RT
},
104 {L
"Key####", VARIABLE_ATTRIBUTE_NV_BS_RT
},
109 SecureBoot Hook for auth variable update.
111 @param[in] VariableName Name of Variable to be found.
112 @param[in] VendorGuid Variable vendor GUID.
117 IN CHAR16
*VariableName
,
118 IN EFI_GUID
*VendorGuid
122 Routine used to track statistical information about variable usage.
123 The data is stored in the EFI system table so it can be accessed later.
124 VariableInfo.efi can dump out the table. Only Boot Services variable
125 accesses are tracked by this code. The PcdVariableCollectStatistics
126 build flag controls if this feature is enabled.
128 A read that hits in the cache will have Read and Cache true for
129 the transaction. Data is allocated by this routine, but never
132 @param[in] VariableName Name of the Variable to track.
133 @param[in] VendorGuid Guid of the Variable to track.
134 @param[in] Volatile TRUE if volatile FALSE if non-volatile.
135 @param[in] Read TRUE if GetVariable() was called.
136 @param[in] Write TRUE if SetVariable() was called.
137 @param[in] Delete TRUE if deleted via SetVariable().
138 @param[in] Cache TRUE for a cache hit.
143 IN CHAR16
*VariableName
,
144 IN EFI_GUID
*VendorGuid
,
152 VARIABLE_INFO_ENTRY
*Entry
;
154 if (FeaturePcdGet (PcdVariableCollectStatistics
)) {
157 // Don't collect statistics at runtime.
161 if (gVariableInfo
== NULL
) {
163 // On the first call allocate a entry and place a pointer to it in
164 // the EFI System Table.
166 gVariableInfo
= AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY
));
167 ASSERT (gVariableInfo
!= NULL
);
169 CopyGuid (&gVariableInfo
->VendorGuid
, VendorGuid
);
170 gVariableInfo
->Name
= AllocatePool (StrSize (VariableName
));
171 ASSERT (gVariableInfo
->Name
!= NULL
);
172 StrCpy (gVariableInfo
->Name
, VariableName
);
173 gVariableInfo
->Volatile
= Volatile
;
177 for (Entry
= gVariableInfo
; Entry
!= NULL
; Entry
= Entry
->Next
) {
178 if (CompareGuid (VendorGuid
, &Entry
->VendorGuid
)) {
179 if (StrCmp (VariableName
, Entry
->Name
) == 0) {
187 Entry
->DeleteCount
++;
197 if (Entry
->Next
== NULL
) {
199 // If the entry is not in the table add it.
200 // Next iteration of the loop will fill in the data.
202 Entry
->Next
= AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY
));
203 ASSERT (Entry
->Next
!= NULL
);
205 CopyGuid (&Entry
->Next
->VendorGuid
, VendorGuid
);
206 Entry
->Next
->Name
= AllocatePool (StrSize (VariableName
));
207 ASSERT (Entry
->Next
->Name
!= NULL
);
208 StrCpy (Entry
->Next
->Name
, VariableName
);
209 Entry
->Next
->Volatile
= Volatile
;
219 This code checks if variable header is valid or not.
221 @param Variable Pointer to the Variable Header.
223 @retval TRUE Variable header is valid.
224 @retval FALSE Variable header is not valid.
228 IsValidVariableHeader (
229 IN VARIABLE_HEADER
*Variable
232 if (Variable
== NULL
|| Variable
->StartId
!= VARIABLE_DATA
) {
242 This function writes data to the FWH at the correct LBA even if the LBAs
245 @param Global Pointer to VARAIBLE_GLOBAL structure.
246 @param Volatile Point out the Variable is Volatile or Non-Volatile.
247 @param SetByIndex TRUE if target pointer is given as index.
248 FALSE if target pointer is absolute.
249 @param Fvb Pointer to the writable FVB protocol.
250 @param DataPtrIndex Pointer to the Data from the end of VARIABLE_STORE_HEADER
252 @param DataSize Size of data to be written.
253 @param Buffer Pointer to the buffer from which data is written.
255 @retval EFI_INVALID_PARAMETER Parameters not valid.
256 @retval EFI_SUCCESS Variable store successfully updated.
260 UpdateVariableStore (
261 IN VARIABLE_GLOBAL
*Global
,
263 IN BOOLEAN SetByIndex
,
264 IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*Fvb
,
265 IN UINTN DataPtrIndex
,
270 EFI_FV_BLOCK_MAP_ENTRY
*PtrBlockMapEntry
;
278 EFI_FIRMWARE_VOLUME_HEADER
*FwVolHeader
;
279 VARIABLE_STORE_HEADER
*VolatileBase
;
280 EFI_PHYSICAL_ADDRESS FvVolHdr
;
281 EFI_PHYSICAL_ADDRESS DataPtr
;
285 DataPtr
= DataPtrIndex
;
288 // Check if the Data is Volatile.
292 return EFI_INVALID_PARAMETER
;
294 Status
= Fvb
->GetPhysicalAddress(Fvb
, &FvVolHdr
);
295 ASSERT_EFI_ERROR (Status
);
297 FwVolHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*) ((UINTN
) FvVolHdr
);
299 // Data Pointer should point to the actual Address where data is to be
303 DataPtr
+= mVariableModuleGlobal
->VariableGlobal
.NonVolatileVariableBase
;
306 if ((DataPtr
+ DataSize
) >= ((EFI_PHYSICAL_ADDRESS
) (UINTN
) ((UINT8
*) FwVolHeader
+ FwVolHeader
->FvLength
))) {
307 return EFI_INVALID_PARAMETER
;
311 // Data Pointer should point to the actual Address where data is to be
314 VolatileBase
= (VARIABLE_STORE_HEADER
*) ((UINTN
) mVariableModuleGlobal
->VariableGlobal
.VolatileVariableBase
);
316 DataPtr
+= mVariableModuleGlobal
->VariableGlobal
.VolatileVariableBase
;
319 if ((DataPtr
+ DataSize
) >= ((UINTN
) ((UINT8
*) VolatileBase
+ VolatileBase
->Size
))) {
320 return EFI_INVALID_PARAMETER
;
324 // If Volatile Variable just do a simple mem copy.
326 CopyMem ((UINT8
*)(UINTN
)DataPtr
, Buffer
, DataSize
);
331 // If we are here we are dealing with Non-Volatile Variables.
333 LinearOffset
= (UINTN
) FwVolHeader
;
334 CurrWritePtr
= (UINTN
) DataPtr
;
335 CurrWriteSize
= DataSize
;
339 if (CurrWritePtr
< LinearOffset
) {
340 return EFI_INVALID_PARAMETER
;
343 for (PtrBlockMapEntry
= FwVolHeader
->BlockMap
; PtrBlockMapEntry
->NumBlocks
!= 0; PtrBlockMapEntry
++) {
344 for (BlockIndex2
= 0; BlockIndex2
< PtrBlockMapEntry
->NumBlocks
; BlockIndex2
++) {
346 // Check to see if the Variable Writes are spanning through multiple
349 if ((CurrWritePtr
>= LinearOffset
) && (CurrWritePtr
< LinearOffset
+ PtrBlockMapEntry
->Length
)) {
350 if ((CurrWritePtr
+ CurrWriteSize
) <= (LinearOffset
+ PtrBlockMapEntry
->Length
)) {
351 Status
= Fvb
->Write (
354 (UINTN
) (CurrWritePtr
- LinearOffset
),
360 Size
= (UINT32
) (LinearOffset
+ PtrBlockMapEntry
->Length
- CurrWritePtr
);
361 Status
= Fvb
->Write (
364 (UINTN
) (CurrWritePtr
- LinearOffset
),
368 if (EFI_ERROR (Status
)) {
372 CurrWritePtr
= LinearOffset
+ PtrBlockMapEntry
->Length
;
373 CurrBuffer
= CurrBuffer
+ Size
;
374 CurrWriteSize
= CurrWriteSize
- Size
;
378 LinearOffset
+= PtrBlockMapEntry
->Length
;
389 This code gets the current status of Variable Store.
391 @param VarStoreHeader Pointer to the Variable Store Header.
393 @retval EfiRaw Variable store status is raw.
394 @retval EfiValid Variable store status is valid.
395 @retval EfiInvalid Variable store status is invalid.
398 VARIABLE_STORE_STATUS
399 GetVariableStoreStatus (
400 IN VARIABLE_STORE_HEADER
*VarStoreHeader
403 if (CompareGuid (&VarStoreHeader
->Signature
, &gEfiAuthenticatedVariableGuid
) &&
404 VarStoreHeader
->Format
== VARIABLE_STORE_FORMATTED
&&
405 VarStoreHeader
->State
== VARIABLE_STORE_HEALTHY
409 } else if (((UINT32
*)(&VarStoreHeader
->Signature
))[0] == 0xffffffff &&
410 ((UINT32
*)(&VarStoreHeader
->Signature
))[1] == 0xffffffff &&
411 ((UINT32
*)(&VarStoreHeader
->Signature
))[2] == 0xffffffff &&
412 ((UINT32
*)(&VarStoreHeader
->Signature
))[3] == 0xffffffff &&
413 VarStoreHeader
->Size
== 0xffffffff &&
414 VarStoreHeader
->Format
== 0xff &&
415 VarStoreHeader
->State
== 0xff
427 This code gets the size of name of variable.
429 @param Variable Pointer to the Variable Header.
431 @return UINTN Size of variable in bytes.
436 IN VARIABLE_HEADER
*Variable
439 if (Variable
->State
== (UINT8
) (-1) ||
440 Variable
->DataSize
== (UINT32
) (-1) ||
441 Variable
->NameSize
== (UINT32
) (-1) ||
442 Variable
->Attributes
== (UINT32
) (-1)) {
445 return (UINTN
) Variable
->NameSize
;
450 This code gets the size of variable data.
452 @param Variable Pointer to the Variable Header.
454 @return Size of variable in bytes.
459 IN VARIABLE_HEADER
*Variable
462 if (Variable
->State
== (UINT8
) (-1) ||
463 Variable
->DataSize
== (UINT32
) (-1) ||
464 Variable
->NameSize
== (UINT32
) (-1) ||
465 Variable
->Attributes
== (UINT32
) (-1)) {
468 return (UINTN
) Variable
->DataSize
;
473 This code gets the pointer to the variable name.
475 @param Variable Pointer to the Variable Header.
477 @return Pointer to Variable Name which is Unicode encoding.
482 IN VARIABLE_HEADER
*Variable
486 return (CHAR16
*) (Variable
+ 1);
491 This code gets the pointer to the variable data.
493 @param Variable Pointer to the Variable Header.
495 @return Pointer to Variable Data.
500 IN VARIABLE_HEADER
*Variable
506 // Be careful about pad size for alignment.
508 Value
= (UINTN
) GetVariableNamePtr (Variable
);
509 Value
+= NameSizeOfVariable (Variable
);
510 Value
+= GET_PAD_SIZE (NameSizeOfVariable (Variable
));
512 return (UINT8
*) Value
;
518 This code gets the pointer to the next variable header.
520 @param Variable Pointer to the Variable Header.
522 @return Pointer to next variable header.
527 IN VARIABLE_HEADER
*Variable
532 if (!IsValidVariableHeader (Variable
)) {
536 Value
= (UINTN
) GetVariableDataPtr (Variable
);
537 Value
+= DataSizeOfVariable (Variable
);
538 Value
+= GET_PAD_SIZE (DataSizeOfVariable (Variable
));
541 // Be careful about pad size for alignment.
543 return (VARIABLE_HEADER
*) HEADER_ALIGN (Value
);
548 Gets the pointer to the first variable header in given variable store area.
550 @param VarStoreHeader Pointer to the Variable Store Header.
552 @return Pointer to the first variable header.
557 IN VARIABLE_STORE_HEADER
*VarStoreHeader
561 // The end of variable store.
563 return (VARIABLE_HEADER
*) HEADER_ALIGN (VarStoreHeader
+ 1);
568 Gets the pointer to the end of the variable storage area.
570 This function gets pointer to the end of the variable storage
571 area, according to the input variable store header.
573 @param VarStoreHeader Pointer to the Variable Store Header.
575 @return Pointer to the end of the variable storage area.
580 IN VARIABLE_STORE_HEADER
*VarStoreHeader
584 // The end of variable store
586 return (VARIABLE_HEADER
*) HEADER_ALIGN ((UINTN
) VarStoreHeader
+ VarStoreHeader
->Size
);
591 Check the PubKeyIndex is a valid key or not.
593 This function will iterate the NV storage to see if this PubKeyIndex is still referenced
594 by any valid count-based auth variabe.
596 @param[in] PubKeyIndex Index of the public key in public key store.
598 @retval TRUE The PubKeyIndex is still in use.
599 @retval FALSE The PubKeyIndex is not referenced by any count-based auth variabe.
604 IN UINT32 PubKeyIndex
607 VARIABLE_HEADER
*Variable
;
609 if (PubKeyIndex
> mPubKeyNumber
) {
613 Variable
= GetStartPointer ((VARIABLE_STORE_HEADER
*) (UINTN
) mVariableModuleGlobal
->VariableGlobal
.NonVolatileVariableBase
);
615 while (IsValidVariableHeader (Variable
)) {
616 if ((Variable
->State
== VAR_ADDED
|| Variable
->State
== (VAR_IN_DELETED_TRANSITION
& VAR_ADDED
)) &&
617 Variable
->PubKeyIndex
== PubKeyIndex
) {
620 Variable
= GetNextVariablePtr (Variable
);
628 Get the number of valid public key in PubKeyStore.
630 @param[in] PubKeyNumber Number of the public key in public key store.
632 @return Number of valid public key in PubKeyStore.
636 GetValidPubKeyNumber (
637 IN UINT32 PubKeyNumber
645 for (PubKeyIndex
= 1; PubKeyIndex
<= PubKeyNumber
; PubKeyIndex
++) {
646 if (IsValidPubKeyIndex (PubKeyIndex
)) {
656 Filter the useless key in public key store.
658 This function will find out all valid public keys in public key database, save them in new allocated
659 buffer NewPubKeyStore, and give the new PubKeyIndex. The caller is responsible for freeing buffer
660 NewPubKeyIndex and NewPubKeyStore with FreePool().
662 @param[in] PubKeyStore Point to the public key database.
663 @param[in] PubKeyNumber Number of the public key in PubKeyStore.
664 @param[out] NewPubKeyIndex Point to an array of new PubKeyIndex corresponds to NewPubKeyStore.
665 @param[out] NewPubKeyStore Saved all valid public keys in PubKeyStore.
666 @param[out] NewPubKeySize Buffer size of the NewPubKeyStore.
668 @retval EFI_SUCCESS Trim operation is complete successfully.
669 @retval EFI_OUT_OF_RESOURCES No enough memory resources, or no useless key in PubKeyStore.
674 IN UINT8
*PubKeyStore
,
675 IN UINT32 PubKeyNumber
,
676 OUT UINT32
**NewPubKeyIndex
,
677 OUT UINT8
**NewPubKeyStore
,
678 OUT UINT32
*NewPubKeySize
683 UINT32 NewPubKeyNumber
;
685 NewPubKeyNumber
= GetValidPubKeyNumber (PubKeyNumber
);
686 if (NewPubKeyNumber
== PubKeyNumber
) {
687 return EFI_OUT_OF_RESOURCES
;
690 if (NewPubKeyNumber
!= 0) {
691 *NewPubKeySize
= NewPubKeyNumber
* EFI_CERT_TYPE_RSA2048_SIZE
;
693 *NewPubKeySize
= sizeof (UINT8
);
696 *NewPubKeyStore
= AllocatePool (*NewPubKeySize
);
697 if (*NewPubKeyStore
== NULL
) {
698 return EFI_OUT_OF_RESOURCES
;
701 *NewPubKeyIndex
= AllocateZeroPool ((PubKeyNumber
+ 1) * sizeof (UINT32
));
702 if (*NewPubKeyIndex
== NULL
) {
703 FreePool (*NewPubKeyStore
);
704 *NewPubKeyStore
= NULL
;
705 return EFI_OUT_OF_RESOURCES
;
709 for (PubKeyIndex
= 1; PubKeyIndex
<= PubKeyNumber
; PubKeyIndex
++) {
710 if (IsValidPubKeyIndex (PubKeyIndex
)) {
712 *NewPubKeyStore
+ CopiedKey
* EFI_CERT_TYPE_RSA2048_SIZE
,
713 PubKeyStore
+ (PubKeyIndex
- 1) * EFI_CERT_TYPE_RSA2048_SIZE
,
714 EFI_CERT_TYPE_RSA2048_SIZE
716 (*NewPubKeyIndex
)[PubKeyIndex
] = ++CopiedKey
;
724 Variable store garbage collection and reclaim operation.
726 If ReclaimPubKeyStore is FALSE, reclaim variable space by deleting the obsoleted varaibles.
727 If ReclaimPubKeyStore is TRUE, reclaim invalid key in public key database and update the PubKeyIndex
728 for all the count-based authenticate variable in NV storage.
730 @param[in] VariableBase Base address of variable store.
731 @param[out] LastVariableOffset Offset of last variable.
732 @param[in] IsVolatile The variable store is volatile or not;
733 if it is non-volatile, need FTW.
734 @param[in, out] UpdatingPtrTrack Pointer to updating variable pointer track structure.
735 @param[in] NewVariable Pointer to new variable.
736 @param[in] NewVariableSize New variable size.
737 @param[in] ReclaimPubKeyStore Reclaim for public key database or not.
739 @return EFI_SUCCESS Reclaim operation has finished successfully.
740 @return EFI_OUT_OF_RESOURCES No enough memory resources or variable space.
741 @return EFI_DEVICE_ERROR The public key database doesn't exist.
742 @return Others Unexpect error happened during reclaim operation.
747 IN EFI_PHYSICAL_ADDRESS VariableBase
,
748 OUT UINTN
*LastVariableOffset
,
749 IN BOOLEAN IsVolatile
,
750 IN OUT VARIABLE_POINTER_TRACK
*UpdatingPtrTrack
,
751 IN VARIABLE_HEADER
*NewVariable
,
752 IN UINTN NewVariableSize
,
753 IN BOOLEAN ReclaimPubKeyStore
756 VARIABLE_HEADER
*Variable
;
757 VARIABLE_HEADER
*AddedVariable
;
758 VARIABLE_HEADER
*NextVariable
;
759 VARIABLE_HEADER
*NextAddedVariable
;
760 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
762 UINTN MaximumBufferSize
;
770 UINTN CommonVariableTotalSize
;
771 UINTN HwErrVariableTotalSize
;
772 UINT32
*NewPubKeyIndex
;
773 UINT8
*NewPubKeyStore
;
774 UINT32 NewPubKeySize
;
775 VARIABLE_HEADER
*PubKeyHeader
;
776 VARIABLE_HEADER
*UpdatingVariable
;
777 VARIABLE_HEADER
*UpdatingInDeletedTransition
;
779 UpdatingVariable
= NULL
;
780 UpdatingInDeletedTransition
= NULL
;
781 if (UpdatingPtrTrack
!= NULL
) {
782 UpdatingVariable
= UpdatingPtrTrack
->CurrPtr
;
783 UpdatingInDeletedTransition
= UpdatingPtrTrack
->InDeletedTransitionPtr
;
786 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*) ((UINTN
) VariableBase
);
788 CommonVariableTotalSize
= 0;
789 HwErrVariableTotalSize
= 0;
790 NewPubKeyIndex
= NULL
;
791 NewPubKeyStore
= NULL
;
797 // Start Pointers for the variable.
799 Variable
= GetStartPointer (VariableStoreHeader
);
800 MaximumBufferSize
= sizeof (VARIABLE_STORE_HEADER
);
802 while (IsValidVariableHeader (Variable
)) {
803 NextVariable
= GetNextVariablePtr (Variable
);
804 if ((Variable
->State
== VAR_ADDED
|| Variable
->State
== (VAR_IN_DELETED_TRANSITION
& VAR_ADDED
)) &&
805 Variable
!= UpdatingVariable
&&
806 Variable
!= UpdatingInDeletedTransition
808 VariableSize
= (UINTN
) NextVariable
- (UINTN
) Variable
;
809 MaximumBufferSize
+= VariableSize
;
812 Variable
= NextVariable
;
815 if (NewVariable
!= NULL
) {
817 // Add the new variable size.
819 MaximumBufferSize
+= NewVariableSize
;
823 // Reserve the 1 Bytes with Oxff to identify the
824 // end of the variable buffer.
826 MaximumBufferSize
+= 1;
827 ValidBuffer
= AllocatePool (MaximumBufferSize
);
828 if (ValidBuffer
== NULL
) {
829 return EFI_OUT_OF_RESOURCES
;
833 // For NV variable reclaim, don't allocate pool here and just use mNvVariableCache
834 // as the buffer to reduce SMRAM consumption for SMM variable driver.
836 MaximumBufferSize
= mNvVariableCache
->Size
;
837 ValidBuffer
= (UINT8
*) mNvVariableCache
;
840 SetMem (ValidBuffer
, MaximumBufferSize
, 0xff);
843 // Copy variable store header.
845 CopyMem (ValidBuffer
, VariableStoreHeader
, sizeof (VARIABLE_STORE_HEADER
));
846 CurrPtr
= (UINT8
*) GetStartPointer ((VARIABLE_STORE_HEADER
*) ValidBuffer
);
848 if (ReclaimPubKeyStore
) {
849 ASSERT (IsVolatile
== FALSE
);
851 // Trim the PubKeyStore and get new PubKeyIndex.
853 Status
= PubKeyStoreFilter (
860 if (EFI_ERROR (Status
)) {
863 ASSERT ((NewPubKeyIndex
!= NULL
) && (NewPubKeyStore
!= NULL
));
866 // Refresh the PubKeyIndex for all valid variables (ADDED and IN_DELETED_TRANSITION).
868 Variable
= GetStartPointer (VariableStoreHeader
);
869 while (IsValidVariableHeader (Variable
)) {
870 NextVariable
= GetNextVariablePtr (Variable
);
871 if (Variable
->State
== VAR_ADDED
|| Variable
->State
== (VAR_IN_DELETED_TRANSITION
& VAR_ADDED
)) {
872 if ((StrCmp (GetVariableNamePtr (Variable
), AUTHVAR_KEYDB_NAME
) == 0) &&
873 (CompareGuid (&Variable
->VendorGuid
, &gEfiAuthenticatedVariableGuid
))) {
875 // Skip the public key database, it will be reinstalled later.
877 PubKeyHeader
= Variable
;
878 Variable
= NextVariable
;
882 VariableSize
= (UINTN
) NextVariable
- (UINTN
) Variable
;
883 CopyMem (CurrPtr
, (UINT8
*) Variable
, VariableSize
);
884 ((VARIABLE_HEADER
*) CurrPtr
)->PubKeyIndex
= NewPubKeyIndex
[Variable
->PubKeyIndex
];
885 CurrPtr
+= VariableSize
;
886 if ((Variable
->Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) == EFI_VARIABLE_HARDWARE_ERROR_RECORD
) {
887 HwErrVariableTotalSize
+= VariableSize
;
888 } else if ((Variable
->Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) != EFI_VARIABLE_HARDWARE_ERROR_RECORD
) {
889 CommonVariableTotalSize
+= VariableSize
;
892 Variable
= NextVariable
;
896 // Reinstall the new public key database.
898 ASSERT (PubKeyHeader
!= NULL
);
899 if (PubKeyHeader
== NULL
) {
900 Status
= EFI_DEVICE_ERROR
;
903 CopyMem (CurrPtr
, (UINT8
*) PubKeyHeader
, sizeof (VARIABLE_HEADER
));
904 Variable
= (VARIABLE_HEADER
*) CurrPtr
;
905 Variable
->DataSize
= NewPubKeySize
;
906 StrCpy (GetVariableNamePtr (Variable
), GetVariableNamePtr (PubKeyHeader
));
907 CopyMem (GetVariableDataPtr (Variable
), NewPubKeyStore
, NewPubKeySize
);
908 CurrPtr
= (UINT8
*) GetNextVariablePtr (Variable
);
909 CommonVariableTotalSize
+= (UINTN
) CurrPtr
- (UINTN
) Variable
;
912 // Reinstall all ADDED variables as long as they are not identical to Updating Variable.
914 Variable
= GetStartPointer (VariableStoreHeader
);
915 while (IsValidVariableHeader (Variable
)) {
916 NextVariable
= GetNextVariablePtr (Variable
);
917 if (Variable
!= UpdatingVariable
&& Variable
->State
== VAR_ADDED
) {
918 VariableSize
= (UINTN
) NextVariable
- (UINTN
) Variable
;
919 CopyMem (CurrPtr
, (UINT8
*) Variable
, VariableSize
);
920 CurrPtr
+= VariableSize
;
921 if ((!IsVolatile
) && ((Variable
->Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) == EFI_VARIABLE_HARDWARE_ERROR_RECORD
)) {
922 HwErrVariableTotalSize
+= VariableSize
;
923 } else if ((!IsVolatile
) && ((Variable
->Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) != EFI_VARIABLE_HARDWARE_ERROR_RECORD
)) {
924 CommonVariableTotalSize
+= VariableSize
;
927 Variable
= NextVariable
;
931 // Reinstall all in delete transition variables.
933 Variable
= GetStartPointer (VariableStoreHeader
);
934 while (IsValidVariableHeader (Variable
)) {
935 NextVariable
= GetNextVariablePtr (Variable
);
936 if (Variable
!= UpdatingVariable
&& Variable
!= UpdatingInDeletedTransition
&& Variable
->State
== (VAR_IN_DELETED_TRANSITION
& VAR_ADDED
)) {
939 // Buffer has cached all ADDED variable.
940 // Per IN_DELETED variable, we have to guarantee that
941 // no ADDED one in previous buffer.
945 AddedVariable
= GetStartPointer ((VARIABLE_STORE_HEADER
*) ValidBuffer
);
946 while (IsValidVariableHeader (AddedVariable
)) {
947 NextAddedVariable
= GetNextVariablePtr (AddedVariable
);
948 NameSize
= NameSizeOfVariable (AddedVariable
);
949 if (CompareGuid (&AddedVariable
->VendorGuid
, &Variable
->VendorGuid
) &&
950 NameSize
== NameSizeOfVariable (Variable
)
952 Point0
= (VOID
*) GetVariableNamePtr (AddedVariable
);
953 Point1
= (VOID
*) GetVariableNamePtr (Variable
);
954 if (CompareMem (Point0
, Point1
, NameSize
) == 0) {
959 AddedVariable
= NextAddedVariable
;
963 // Promote VAR_IN_DELETED_TRANSITION to VAR_ADDED.
965 VariableSize
= (UINTN
) NextVariable
- (UINTN
) Variable
;
966 CopyMem (CurrPtr
, (UINT8
*) Variable
, VariableSize
);
967 ((VARIABLE_HEADER
*) CurrPtr
)->State
= VAR_ADDED
;
968 CurrPtr
+= VariableSize
;
969 if ((!IsVolatile
) && ((Variable
->Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) == EFI_VARIABLE_HARDWARE_ERROR_RECORD
)) {
970 HwErrVariableTotalSize
+= VariableSize
;
971 } else if ((!IsVolatile
) && ((Variable
->Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) != EFI_VARIABLE_HARDWARE_ERROR_RECORD
)) {
972 CommonVariableTotalSize
+= VariableSize
;
977 Variable
= NextVariable
;
981 // Install the new variable if it is not NULL.
983 if (NewVariable
!= NULL
) {
984 if ((UINTN
) (CurrPtr
- ValidBuffer
) + NewVariableSize
> VariableStoreHeader
->Size
) {
986 // No enough space to store the new variable.
988 Status
= EFI_OUT_OF_RESOURCES
;
992 if ((NewVariable
->Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) == EFI_VARIABLE_HARDWARE_ERROR_RECORD
) {
993 HwErrVariableTotalSize
+= NewVariableSize
;
994 } else if ((NewVariable
->Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) != EFI_VARIABLE_HARDWARE_ERROR_RECORD
) {
995 CommonVariableTotalSize
+= NewVariableSize
;
997 if ((HwErrVariableTotalSize
> PcdGet32 (PcdHwErrStorageSize
)) ||
998 (CommonVariableTotalSize
> VariableStoreHeader
->Size
- sizeof (VARIABLE_STORE_HEADER
) - PcdGet32 (PcdHwErrStorageSize
))) {
1000 // No enough space to store the new variable by NV or NV+HR attribute.
1002 Status
= EFI_OUT_OF_RESOURCES
;
1007 CopyMem (CurrPtr
, (UINT8
*) NewVariable
, NewVariableSize
);
1008 ((VARIABLE_HEADER
*) CurrPtr
)->State
= VAR_ADDED
;
1009 if (UpdatingVariable
!= NULL
) {
1010 UpdatingPtrTrack
->CurrPtr
= (VARIABLE_HEADER
*)((UINTN
)UpdatingPtrTrack
->StartPtr
+ ((UINTN
)CurrPtr
- (UINTN
)GetStartPointer ((VARIABLE_STORE_HEADER
*) ValidBuffer
)));
1011 UpdatingPtrTrack
->InDeletedTransitionPtr
= NULL
;
1013 CurrPtr
+= NewVariableSize
;
1019 // If volatile variable store, just copy valid buffer.
1021 SetMem ((UINT8
*) (UINTN
) VariableBase
, VariableStoreHeader
->Size
, 0xff);
1022 CopyMem ((UINT8
*) (UINTN
) VariableBase
, ValidBuffer
, (UINTN
) (CurrPtr
- ValidBuffer
));
1023 *LastVariableOffset
= (UINTN
) (CurrPtr
- ValidBuffer
);
1024 Status
= EFI_SUCCESS
;
1027 // If non-volatile variable store, perform FTW here.
1029 Status
= FtwVariableSpace (
1031 (VARIABLE_STORE_HEADER
*) ValidBuffer
1033 if (!EFI_ERROR (Status
)) {
1034 *LastVariableOffset
= (UINTN
) (CurrPtr
- ValidBuffer
);
1035 mVariableModuleGlobal
->HwErrVariableTotalSize
= HwErrVariableTotalSize
;
1036 mVariableModuleGlobal
->CommonVariableTotalSize
= CommonVariableTotalSize
;
1038 NextVariable
= GetStartPointer ((VARIABLE_STORE_HEADER
*)(UINTN
)VariableBase
);
1039 while (IsValidVariableHeader (NextVariable
)) {
1040 VariableSize
= NextVariable
->NameSize
+ NextVariable
->DataSize
+ sizeof (VARIABLE_HEADER
);
1041 if ((Variable
->Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) == EFI_VARIABLE_HARDWARE_ERROR_RECORD
) {
1042 mVariableModuleGlobal
->HwErrVariableTotalSize
+= HEADER_ALIGN (VariableSize
);
1043 } else if ((Variable
->Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) != EFI_VARIABLE_HARDWARE_ERROR_RECORD
) {
1044 mVariableModuleGlobal
->CommonVariableTotalSize
+= HEADER_ALIGN (VariableSize
);
1047 NextVariable
= GetNextVariablePtr (NextVariable
);
1049 *LastVariableOffset
= (UINTN
) NextVariable
- (UINTN
) VariableBase
;
1055 FreePool (ValidBuffer
);
1058 // For NV variable reclaim, we use mNvVariableCache as the buffer, so copy the data back.
1060 CopyMem (mNvVariableCache
, (UINT8
*)(UINTN
)VariableBase
, VariableStoreHeader
->Size
);
1062 if (NewPubKeyStore
!= NULL
) {
1063 FreePool (NewPubKeyStore
);
1066 if (NewPubKeyIndex
!= NULL
) {
1067 FreePool (NewPubKeyIndex
);
1075 Find the variable in the specified variable store.
1077 @param[in] VariableName Name of the variable to be found
1078 @param[in] VendorGuid Vendor GUID to be found.
1079 @param[in] IgnoreRtCheck Ignore EFI_VARIABLE_RUNTIME_ACCESS attribute
1080 check at runtime when searching variable.
1081 @param[in, out] PtrTrack Variable Track Pointer structure that contains Variable Information.
1083 @retval EFI_SUCCESS Variable found successfully
1084 @retval EFI_NOT_FOUND Variable not found
1088 IN CHAR16
*VariableName
,
1089 IN EFI_GUID
*VendorGuid
,
1090 IN BOOLEAN IgnoreRtCheck
,
1091 IN OUT VARIABLE_POINTER_TRACK
*PtrTrack
1094 VARIABLE_HEADER
*InDeletedVariable
;
1097 PtrTrack
->InDeletedTransitionPtr
= NULL
;
1100 // Find the variable by walk through HOB, volatile and non-volatile variable store.
1102 InDeletedVariable
= NULL
;
1104 for ( PtrTrack
->CurrPtr
= PtrTrack
->StartPtr
1105 ; (PtrTrack
->CurrPtr
< PtrTrack
->EndPtr
) && IsValidVariableHeader (PtrTrack
->CurrPtr
)
1106 ; PtrTrack
->CurrPtr
= GetNextVariablePtr (PtrTrack
->CurrPtr
)
1108 if (PtrTrack
->CurrPtr
->State
== VAR_ADDED
||
1109 PtrTrack
->CurrPtr
->State
== (VAR_IN_DELETED_TRANSITION
& VAR_ADDED
)
1111 if (IgnoreRtCheck
|| !AtRuntime () || ((PtrTrack
->CurrPtr
->Attributes
& EFI_VARIABLE_RUNTIME_ACCESS
) != 0)) {
1112 if (VariableName
[0] == 0) {
1113 if (PtrTrack
->CurrPtr
->State
== (VAR_IN_DELETED_TRANSITION
& VAR_ADDED
)) {
1114 InDeletedVariable
= PtrTrack
->CurrPtr
;
1116 PtrTrack
->InDeletedTransitionPtr
= InDeletedVariable
;
1120 if (CompareGuid (VendorGuid
, &PtrTrack
->CurrPtr
->VendorGuid
)) {
1121 Point
= (VOID
*) GetVariableNamePtr (PtrTrack
->CurrPtr
);
1123 ASSERT (NameSizeOfVariable (PtrTrack
->CurrPtr
) != 0);
1124 if (CompareMem (VariableName
, Point
, NameSizeOfVariable (PtrTrack
->CurrPtr
)) == 0) {
1125 if (PtrTrack
->CurrPtr
->State
== (VAR_IN_DELETED_TRANSITION
& VAR_ADDED
)) {
1126 InDeletedVariable
= PtrTrack
->CurrPtr
;
1128 PtrTrack
->InDeletedTransitionPtr
= InDeletedVariable
;
1138 PtrTrack
->CurrPtr
= InDeletedVariable
;
1139 return (PtrTrack
->CurrPtr
== NULL
) ? EFI_NOT_FOUND
: EFI_SUCCESS
;
1144 Finds variable in storage blocks of volatile and non-volatile storage areas.
1146 This code finds variable in storage blocks of volatile and non-volatile storage areas.
1147 If VariableName is an empty string, then we just return the first
1148 qualified variable without comparing VariableName and VendorGuid.
1149 If IgnoreRtCheck is TRUE, then we ignore the EFI_VARIABLE_RUNTIME_ACCESS attribute check
1150 at runtime when searching existing variable, only VariableName and VendorGuid are compared.
1151 Otherwise, variables without EFI_VARIABLE_RUNTIME_ACCESS are not visible at runtime.
1153 @param[in] VariableName Name of the variable to be found.
1154 @param[in] VendorGuid Vendor GUID to be found.
1155 @param[out] PtrTrack VARIABLE_POINTER_TRACK structure for output,
1156 including the range searched and the target position.
1157 @param[in] Global Pointer to VARIABLE_GLOBAL structure, including
1158 base of volatile variable storage area, base of
1159 NV variable storage area, and a lock.
1160 @param[in] IgnoreRtCheck Ignore EFI_VARIABLE_RUNTIME_ACCESS attribute
1161 check at runtime when searching variable.
1163 @retval EFI_INVALID_PARAMETER If VariableName is not an empty string, while
1165 @retval EFI_SUCCESS Variable successfully found.
1166 @retval EFI_NOT_FOUND Variable not found
1171 IN CHAR16
*VariableName
,
1172 IN EFI_GUID
*VendorGuid
,
1173 OUT VARIABLE_POINTER_TRACK
*PtrTrack
,
1174 IN VARIABLE_GLOBAL
*Global
,
1175 IN BOOLEAN IgnoreRtCheck
1179 VARIABLE_STORE_HEADER
*VariableStoreHeader
[VariableStoreTypeMax
];
1180 VARIABLE_STORE_TYPE Type
;
1182 if (VariableName
[0] != 0 && VendorGuid
== NULL
) {
1183 return EFI_INVALID_PARAMETER
;
1187 // 0: Volatile, 1: HOB, 2: Non-Volatile.
1188 // The index and attributes mapping must be kept in this order as RuntimeServiceGetNextVariableName
1189 // make use of this mapping to implement search algorithm.
1191 VariableStoreHeader
[VariableStoreTypeVolatile
] = (VARIABLE_STORE_HEADER
*) (UINTN
) Global
->VolatileVariableBase
;
1192 VariableStoreHeader
[VariableStoreTypeHob
] = (VARIABLE_STORE_HEADER
*) (UINTN
) Global
->HobVariableBase
;
1193 VariableStoreHeader
[VariableStoreTypeNv
] = mNvVariableCache
;
1196 // Find the variable by walk through HOB, volatile and non-volatile variable store.
1198 for (Type
= (VARIABLE_STORE_TYPE
) 0; Type
< VariableStoreTypeMax
; Type
++) {
1199 if (VariableStoreHeader
[Type
] == NULL
) {
1203 PtrTrack
->StartPtr
= GetStartPointer (VariableStoreHeader
[Type
]);
1204 PtrTrack
->EndPtr
= GetEndPointer (VariableStoreHeader
[Type
]);
1205 PtrTrack
->Volatile
= (BOOLEAN
) (Type
== VariableStoreTypeVolatile
);
1207 Status
= FindVariableEx (VariableName
, VendorGuid
, IgnoreRtCheck
, PtrTrack
);
1208 if (!EFI_ERROR (Status
)) {
1212 return EFI_NOT_FOUND
;
1216 Get index from supported language codes according to language string.
1218 This code is used to get corresponding index in supported language codes. It can handle
1219 RFC4646 and ISO639 language tags.
1220 In ISO639 language tags, take 3-characters as a delimitation to find matched string and calculate the index.
1221 In RFC4646 language tags, take semicolon as a delimitation to find matched string and calculate the index.
1224 SupportedLang = "engfraengfra"
1226 Iso639Language = TRUE
1227 The return value is "0".
1229 SupportedLang = "en;fr;en-US;fr-FR"
1231 Iso639Language = FALSE
1232 The return value is "3".
1234 @param SupportedLang Platform supported language codes.
1235 @param Lang Configured language.
1236 @param Iso639Language A bool value to signify if the handler is operated on ISO639 or RFC4646.
1238 @retval The index of language in the language codes.
1242 GetIndexFromSupportedLangCodes(
1243 IN CHAR8
*SupportedLang
,
1245 IN BOOLEAN Iso639Language
1249 UINTN CompareLength
;
1250 UINTN LanguageLength
;
1252 if (Iso639Language
) {
1253 CompareLength
= ISO_639_2_ENTRY_SIZE
;
1254 for (Index
= 0; Index
< AsciiStrLen (SupportedLang
); Index
+= CompareLength
) {
1255 if (AsciiStrnCmp (Lang
, SupportedLang
+ Index
, CompareLength
) == 0) {
1257 // Successfully find the index of Lang string in SupportedLang string.
1259 Index
= Index
/ CompareLength
;
1267 // Compare RFC4646 language code
1270 for (LanguageLength
= 0; Lang
[LanguageLength
] != '\0'; LanguageLength
++);
1272 for (Index
= 0; *SupportedLang
!= '\0'; Index
++, SupportedLang
+= CompareLength
) {
1274 // Skip ';' characters in SupportedLang
1276 for (; *SupportedLang
!= '\0' && *SupportedLang
== ';'; SupportedLang
++);
1278 // Determine the length of the next language code in SupportedLang
1280 for (CompareLength
= 0; SupportedLang
[CompareLength
] != '\0' && SupportedLang
[CompareLength
] != ';'; CompareLength
++);
1282 if ((CompareLength
== LanguageLength
) &&
1283 (AsciiStrnCmp (Lang
, SupportedLang
, CompareLength
) == 0)) {
1285 // Successfully find the index of Lang string in SupportedLang string.
1296 Get language string from supported language codes according to index.
1298 This code is used to get corresponding language strings in supported language codes. It can handle
1299 RFC4646 and ISO639 language tags.
1300 In ISO639 language tags, take 3-characters as a delimitation. Find language string according to the index.
1301 In RFC4646 language tags, take semicolon as a delimitation. Find language string according to the index.
1304 SupportedLang = "engfraengfra"
1306 Iso639Language = TRUE
1307 The return value is "fra".
1309 SupportedLang = "en;fr;en-US;fr-FR"
1311 Iso639Language = FALSE
1312 The return value is "fr".
1314 @param SupportedLang Platform supported language codes.
1315 @param Index The index in supported language codes.
1316 @param Iso639Language A bool value to signify if the handler is operated on ISO639 or RFC4646.
1318 @retval The language string in the language codes.
1322 GetLangFromSupportedLangCodes (
1323 IN CHAR8
*SupportedLang
,
1325 IN BOOLEAN Iso639Language
1329 UINTN CompareLength
;
1333 Supported
= SupportedLang
;
1334 if (Iso639Language
) {
1336 // According to the index of Lang string in SupportedLang string to get the language.
1337 // This code will be invoked in RUNTIME, therefore there is not a memory allocate/free operation.
1338 // In driver entry, it pre-allocates a runtime attribute memory to accommodate this string.
1340 CompareLength
= ISO_639_2_ENTRY_SIZE
;
1341 mVariableModuleGlobal
->Lang
[CompareLength
] = '\0';
1342 return CopyMem (mVariableModuleGlobal
->Lang
, SupportedLang
+ Index
* CompareLength
, CompareLength
);
1347 // Take semicolon as delimitation, sequentially traverse supported language codes.
1349 for (CompareLength
= 0; *Supported
!= ';' && *Supported
!= '\0'; CompareLength
++) {
1352 if ((*Supported
== '\0') && (SubIndex
!= Index
)) {
1354 // Have completed the traverse, but not find corrsponding string.
1355 // This case is not allowed to happen.
1360 if (SubIndex
== Index
) {
1362 // According to the index of Lang string in SupportedLang string to get the language.
1363 // As this code will be invoked in RUNTIME, therefore there is not memory allocate/free operation.
1364 // In driver entry, it pre-allocates a runtime attribute memory to accommodate this string.
1366 mVariableModuleGlobal
->PlatformLang
[CompareLength
] = '\0';
1367 return CopyMem (mVariableModuleGlobal
->PlatformLang
, Supported
- CompareLength
, CompareLength
);
1372 // Skip ';' characters in Supported
1374 for (; *Supported
!= '\0' && *Supported
== ';'; Supported
++);
1380 Returns a pointer to an allocated buffer that contains the best matching language
1381 from a set of supported languages.
1383 This function supports both ISO 639-2 and RFC 4646 language codes, but language
1384 code types may not be mixed in a single call to this function. This function
1385 supports a variable argument list that allows the caller to pass in a prioritized
1386 list of language codes to test against all the language codes in SupportedLanguages.
1388 If SupportedLanguages is NULL, then ASSERT().
1390 @param[in] SupportedLanguages A pointer to a Null-terminated ASCII string that
1391 contains a set of language codes in the format
1392 specified by Iso639Language.
1393 @param[in] Iso639Language If TRUE, then all language codes are assumed to be
1394 in ISO 639-2 format. If FALSE, then all language
1395 codes are assumed to be in RFC 4646 language format
1396 @param[in] ... A variable argument list that contains pointers to
1397 Null-terminated ASCII strings that contain one or more
1398 language codes in the format specified by Iso639Language.
1399 The first language code from each of these language
1400 code lists is used to determine if it is an exact or
1401 close match to any of the language codes in
1402 SupportedLanguages. Close matches only apply to RFC 4646
1403 language codes, and the matching algorithm from RFC 4647
1404 is used to determine if a close match is present. If
1405 an exact or close match is found, then the matching
1406 language code from SupportedLanguages is returned. If
1407 no matches are found, then the next variable argument
1408 parameter is evaluated. The variable argument list
1409 is terminated by a NULL.
1411 @retval NULL The best matching language could not be found in SupportedLanguages.
1412 @retval NULL There are not enough resources available to return the best matching
1414 @retval Other A pointer to a Null-terminated ASCII string that is the best matching
1415 language in SupportedLanguages.
1420 VariableGetBestLanguage (
1421 IN CONST CHAR8
*SupportedLanguages
,
1422 IN BOOLEAN Iso639Language
,
1428 UINTN CompareLength
;
1429 UINTN LanguageLength
;
1430 CONST CHAR8
*Supported
;
1433 if (SupportedLanguages
== NULL
) {
1437 VA_START (Args
, Iso639Language
);
1438 while ((Language
= VA_ARG (Args
, CHAR8
*)) != NULL
) {
1440 // Default to ISO 639-2 mode
1443 LanguageLength
= MIN (3, AsciiStrLen (Language
));
1446 // If in RFC 4646 mode, then determine the length of the first RFC 4646 language code in Language
1448 if (!Iso639Language
) {
1449 for (LanguageLength
= 0; Language
[LanguageLength
] != 0 && Language
[LanguageLength
] != ';'; LanguageLength
++);
1453 // Trim back the length of Language used until it is empty
1455 while (LanguageLength
> 0) {
1457 // Loop through all language codes in SupportedLanguages
1459 for (Supported
= SupportedLanguages
; *Supported
!= '\0'; Supported
+= CompareLength
) {
1461 // In RFC 4646 mode, then Loop through all language codes in SupportedLanguages
1463 if (!Iso639Language
) {
1465 // Skip ';' characters in Supported
1467 for (; *Supported
!= '\0' && *Supported
== ';'; Supported
++);
1469 // Determine the length of the next language code in Supported
1471 for (CompareLength
= 0; Supported
[CompareLength
] != 0 && Supported
[CompareLength
] != ';'; CompareLength
++);
1473 // If Language is longer than the Supported, then skip to the next language
1475 if (LanguageLength
> CompareLength
) {
1480 // See if the first LanguageLength characters in Supported match Language
1482 if (AsciiStrnCmp (Supported
, Language
, LanguageLength
) == 0) {
1485 Buffer
= Iso639Language
? mVariableModuleGlobal
->Lang
: mVariableModuleGlobal
->PlatformLang
;
1486 Buffer
[CompareLength
] = '\0';
1487 return CopyMem (Buffer
, Supported
, CompareLength
);
1491 if (Iso639Language
) {
1493 // If ISO 639 mode, then each language can only be tested once
1498 // If RFC 4646 mode, then trim Language from the right to the next '-' character
1500 for (LanguageLength
--; LanguageLength
> 0 && Language
[LanguageLength
] != '-'; LanguageLength
--);
1507 // No matches were found
1513 This function is to check if the remaining variable space is enough to set
1514 all Variables from argument list successfully. The purpose of the check
1515 is to keep the consistency of the Variables to be in variable storage.
1517 Note: Variables are assumed to be in same storage.
1518 The set sequence of Variables will be same with the sequence of VariableEntry from argument list,
1519 so follow the argument sequence to check the Variables.
1521 @param[in] Attributes Variable attributes for Variable entries.
1522 @param ... The variable argument list with type VARIABLE_ENTRY_CONSISTENCY *.
1523 A NULL terminates the list. The VariableSize of
1524 VARIABLE_ENTRY_CONSISTENCY is the variable data size as input.
1525 It will be changed to variable total size as output.
1527 @retval TRUE Have enough variable space to set the Variables successfully.
1528 @retval FALSE No enough variable space to set the Variables successfully.
1533 CheckRemainingSpaceForConsistency (
1534 IN UINT32 Attributes
,
1540 VARIABLE_ENTRY_CONSISTENCY
*VariableEntry
;
1541 UINT64 MaximumVariableStorageSize
;
1542 UINT64 RemainingVariableStorageSize
;
1543 UINT64 MaximumVariableSize
;
1544 UINTN TotalNeededSize
;
1545 UINTN OriginalVarSize
;
1546 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
1547 VARIABLE_POINTER_TRACK VariablePtrTrack
;
1548 VARIABLE_HEADER
*NextVariable
;
1553 // Non-Volatile related.
1555 VariableStoreHeader
= mNvVariableCache
;
1557 Status
= VariableServiceQueryVariableInfoInternal (
1559 &MaximumVariableStorageSize
,
1560 &RemainingVariableStorageSize
,
1561 &MaximumVariableSize
1563 ASSERT_EFI_ERROR (Status
);
1565 TotalNeededSize
= 0;
1566 VA_START (Args
, Attributes
);
1567 VariableEntry
= VA_ARG (Args
, VARIABLE_ENTRY_CONSISTENCY
*);
1568 while (VariableEntry
!= NULL
) {
1570 // Calculate variable total size.
1572 VarNameSize
= StrSize (VariableEntry
->Name
);
1573 VarNameSize
+= GET_PAD_SIZE (VarNameSize
);
1574 VarDataSize
= VariableEntry
->VariableSize
;
1575 VarDataSize
+= GET_PAD_SIZE (VarDataSize
);
1576 VariableEntry
->VariableSize
= HEADER_ALIGN (sizeof (VARIABLE_HEADER
) + VarNameSize
+ VarDataSize
);
1578 TotalNeededSize
+= VariableEntry
->VariableSize
;
1579 VariableEntry
= VA_ARG (Args
, VARIABLE_ENTRY_CONSISTENCY
*);
1583 if (RemainingVariableStorageSize
>= TotalNeededSize
) {
1585 // Already have enough space.
1588 } else if (AtRuntime ()) {
1590 // At runtime, no reclaim.
1591 // The original variable space of Variables can't be reused.
1596 VA_START (Args
, Attributes
);
1597 VariableEntry
= VA_ARG (Args
, VARIABLE_ENTRY_CONSISTENCY
*);
1598 while (VariableEntry
!= NULL
) {
1600 // Check if Variable[Index] has been present and get its size.
1602 OriginalVarSize
= 0;
1603 VariablePtrTrack
.StartPtr
= GetStartPointer (VariableStoreHeader
);
1604 VariablePtrTrack
.EndPtr
= GetEndPointer (VariableStoreHeader
);
1605 Status
= FindVariableEx (
1606 VariableEntry
->Name
,
1607 VariableEntry
->Guid
,
1611 if (!EFI_ERROR (Status
)) {
1613 // Get size of Variable[Index].
1615 NextVariable
= GetNextVariablePtr (VariablePtrTrack
.CurrPtr
);
1616 OriginalVarSize
= (UINTN
) NextVariable
- (UINTN
) VariablePtrTrack
.CurrPtr
;
1618 // Add the original size of Variable[Index] to remaining variable storage size.
1620 RemainingVariableStorageSize
+= OriginalVarSize
;
1622 if (VariableEntry
->VariableSize
> RemainingVariableStorageSize
) {
1624 // No enough space for Variable[Index].
1630 // Sub the (new) size of Variable[Index] from remaining variable storage size.
1632 RemainingVariableStorageSize
-= VariableEntry
->VariableSize
;
1633 VariableEntry
= VA_ARG (Args
, VARIABLE_ENTRY_CONSISTENCY
*);
1641 Hook the operations in PlatformLangCodes, LangCodes, PlatformLang and Lang.
1643 When setting Lang/LangCodes, simultaneously update PlatformLang/PlatformLangCodes.
1645 According to UEFI spec, PlatformLangCodes/LangCodes are only set once in firmware initialization,
1646 and are read-only. Therefore, in variable driver, only store the original value for other use.
1648 @param[in] VariableName Name of variable.
1650 @param[in] Data Variable data.
1652 @param[in] DataSize Size of data. 0 means delete.
1654 @retval EFI_SUCCESS The update operation is successful or ignored.
1655 @retval EFI_WRITE_PROTECTED Update PlatformLangCodes/LangCodes at runtime.
1656 @retval EFI_OUT_OF_RESOURCES No enough variable space to do the update operation.
1657 @retval Others Other errors happened during the update operation.
1661 AutoUpdateLangVariable (
1662 IN CHAR16
*VariableName
,
1668 CHAR8
*BestPlatformLang
;
1672 VARIABLE_POINTER_TRACK Variable
;
1673 BOOLEAN SetLanguageCodes
;
1674 VARIABLE_ENTRY_CONSISTENCY VariableEntry
[2];
1677 // Don't do updates for delete operation
1679 if (DataSize
== 0) {
1683 SetLanguageCodes
= FALSE
;
1685 if (StrCmp (VariableName
, EFI_PLATFORM_LANG_CODES_VARIABLE_NAME
) == 0) {
1687 // PlatformLangCodes is a volatile variable, so it can not be updated at runtime.
1690 return EFI_WRITE_PROTECTED
;
1693 SetLanguageCodes
= TRUE
;
1696 // According to UEFI spec, PlatformLangCodes is only set once in firmware initialization, and is read-only
1697 // Therefore, in variable driver, only store the original value for other use.
1699 if (mVariableModuleGlobal
->PlatformLangCodes
!= NULL
) {
1700 FreePool (mVariableModuleGlobal
->PlatformLangCodes
);
1702 mVariableModuleGlobal
->PlatformLangCodes
= AllocateRuntimeCopyPool (DataSize
, Data
);
1703 ASSERT (mVariableModuleGlobal
->PlatformLangCodes
!= NULL
);
1706 // PlatformLang holds a single language from PlatformLangCodes,
1707 // so the size of PlatformLangCodes is enough for the PlatformLang.
1709 if (mVariableModuleGlobal
->PlatformLang
!= NULL
) {
1710 FreePool (mVariableModuleGlobal
->PlatformLang
);
1712 mVariableModuleGlobal
->PlatformLang
= AllocateRuntimePool (DataSize
);
1713 ASSERT (mVariableModuleGlobal
->PlatformLang
!= NULL
);
1715 } else if (StrCmp (VariableName
, EFI_LANG_CODES_VARIABLE_NAME
) == 0) {
1717 // LangCodes is a volatile variable, so it can not be updated at runtime.
1720 return EFI_WRITE_PROTECTED
;
1723 SetLanguageCodes
= TRUE
;
1726 // According to UEFI spec, LangCodes is only set once in firmware initialization, and is read-only
1727 // Therefore, in variable driver, only store the original value for other use.
1729 if (mVariableModuleGlobal
->LangCodes
!= NULL
) {
1730 FreePool (mVariableModuleGlobal
->LangCodes
);
1732 mVariableModuleGlobal
->LangCodes
= AllocateRuntimeCopyPool (DataSize
, Data
);
1733 ASSERT (mVariableModuleGlobal
->LangCodes
!= NULL
);
1736 if (SetLanguageCodes
1737 && (mVariableModuleGlobal
->PlatformLangCodes
!= NULL
)
1738 && (mVariableModuleGlobal
->LangCodes
!= NULL
)) {
1740 // Update Lang if PlatformLang is already set
1741 // Update PlatformLang if Lang is already set
1743 Status
= FindVariable (EFI_PLATFORM_LANG_VARIABLE_NAME
, &gEfiGlobalVariableGuid
, &Variable
, &mVariableModuleGlobal
->VariableGlobal
, FALSE
);
1744 if (!EFI_ERROR (Status
)) {
1748 VariableName
= EFI_PLATFORM_LANG_VARIABLE_NAME
;
1749 Data
= GetVariableDataPtr (Variable
.CurrPtr
);
1750 DataSize
= Variable
.CurrPtr
->DataSize
;
1752 Status
= FindVariable (EFI_LANG_VARIABLE_NAME
, &gEfiGlobalVariableGuid
, &Variable
, &mVariableModuleGlobal
->VariableGlobal
, FALSE
);
1753 if (!EFI_ERROR (Status
)) {
1755 // Update PlatformLang
1757 VariableName
= EFI_LANG_VARIABLE_NAME
;
1758 Data
= GetVariableDataPtr (Variable
.CurrPtr
);
1759 DataSize
= Variable
.CurrPtr
->DataSize
;
1762 // Neither PlatformLang nor Lang is set, directly return
1769 Status
= EFI_SUCCESS
;
1772 // According to UEFI spec, "Lang" and "PlatformLang" is NV|BS|RT attributions.
1774 Attributes
= EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
;
1776 if (StrCmp (VariableName
, EFI_PLATFORM_LANG_VARIABLE_NAME
) == 0) {
1778 // Update Lang when PlatformLangCodes/LangCodes were set.
1780 if ((mVariableModuleGlobal
->PlatformLangCodes
!= NULL
) && (mVariableModuleGlobal
->LangCodes
!= NULL
)) {
1782 // When setting PlatformLang, firstly get most matched language string from supported language codes.
1784 BestPlatformLang
= VariableGetBestLanguage (mVariableModuleGlobal
->PlatformLangCodes
, FALSE
, Data
, NULL
);
1785 if (BestPlatformLang
!= NULL
) {
1787 // Get the corresponding index in language codes.
1789 Index
= GetIndexFromSupportedLangCodes (mVariableModuleGlobal
->PlatformLangCodes
, BestPlatformLang
, FALSE
);
1792 // Get the corresponding ISO639 language tag according to RFC4646 language tag.
1794 BestLang
= GetLangFromSupportedLangCodes (mVariableModuleGlobal
->LangCodes
, Index
, TRUE
);
1797 // Check the variable space for both Lang and PlatformLang variable.
1799 VariableEntry
[0].VariableSize
= ISO_639_2_ENTRY_SIZE
+ 1;
1800 VariableEntry
[0].Guid
= &gEfiGlobalVariableGuid
;
1801 VariableEntry
[0].Name
= EFI_LANG_VARIABLE_NAME
;
1803 VariableEntry
[1].VariableSize
= AsciiStrSize (BestPlatformLang
);
1804 VariableEntry
[1].Guid
= &gEfiGlobalVariableGuid
;
1805 VariableEntry
[1].Name
= EFI_PLATFORM_LANG_VARIABLE_NAME
;
1806 if (!CheckRemainingSpaceForConsistency (VARIABLE_ATTRIBUTE_NV_BS_RT
, &VariableEntry
[0], &VariableEntry
[1], NULL
)) {
1808 // No enough variable space to set both Lang and PlatformLang successfully.
1810 Status
= EFI_OUT_OF_RESOURCES
;
1813 // Successfully convert PlatformLang to Lang, and set the BestLang value into Lang variable simultaneously.
1815 FindVariable (EFI_LANG_VARIABLE_NAME
, &gEfiGlobalVariableGuid
, &Variable
, &mVariableModuleGlobal
->VariableGlobal
, FALSE
);
1817 Status
= UpdateVariable (EFI_LANG_VARIABLE_NAME
, &gEfiGlobalVariableGuid
, BestLang
,
1818 ISO_639_2_ENTRY_SIZE
+ 1, Attributes
, 0, 0, &Variable
, NULL
);
1821 DEBUG ((EFI_D_INFO
, "Variable Driver Auto Update PlatformLang, PlatformLang:%a, Lang:%a Status: %r\n", BestPlatformLang
, BestLang
, Status
));
1825 } else if (StrCmp (VariableName
, EFI_LANG_VARIABLE_NAME
) == 0) {
1827 // Update PlatformLang when PlatformLangCodes/LangCodes were set.
1829 if ((mVariableModuleGlobal
->PlatformLangCodes
!= NULL
) && (mVariableModuleGlobal
->LangCodes
!= NULL
)) {
1831 // When setting Lang, firstly get most matched language string from supported language codes.
1833 BestLang
= VariableGetBestLanguage (mVariableModuleGlobal
->LangCodes
, TRUE
, Data
, NULL
);
1834 if (BestLang
!= NULL
) {
1836 // Get the corresponding index in language codes.
1838 Index
= GetIndexFromSupportedLangCodes (mVariableModuleGlobal
->LangCodes
, BestLang
, TRUE
);
1841 // Get the corresponding RFC4646 language tag according to ISO639 language tag.
1843 BestPlatformLang
= GetLangFromSupportedLangCodes (mVariableModuleGlobal
->PlatformLangCodes
, Index
, FALSE
);
1846 // Check the variable space for both PlatformLang and Lang variable.
1848 VariableEntry
[0].VariableSize
= AsciiStrSize (BestPlatformLang
);
1849 VariableEntry
[0].Guid
= &gEfiGlobalVariableGuid
;
1850 VariableEntry
[0].Name
= EFI_PLATFORM_LANG_VARIABLE_NAME
;
1852 VariableEntry
[1].VariableSize
= ISO_639_2_ENTRY_SIZE
+ 1;
1853 VariableEntry
[1].Guid
= &gEfiGlobalVariableGuid
;
1854 VariableEntry
[1].Name
= EFI_LANG_VARIABLE_NAME
;
1855 if (!CheckRemainingSpaceForConsistency (VARIABLE_ATTRIBUTE_NV_BS_RT
, &VariableEntry
[0], &VariableEntry
[1], NULL
)) {
1857 // No enough variable space to set both PlatformLang and Lang successfully.
1859 Status
= EFI_OUT_OF_RESOURCES
;
1862 // Successfully convert Lang to PlatformLang, and set the BestPlatformLang value into PlatformLang variable simultaneously.
1864 FindVariable (EFI_PLATFORM_LANG_VARIABLE_NAME
, &gEfiGlobalVariableGuid
, &Variable
, &mVariableModuleGlobal
->VariableGlobal
, FALSE
);
1866 Status
= UpdateVariable (EFI_PLATFORM_LANG_VARIABLE_NAME
, &gEfiGlobalVariableGuid
, BestPlatformLang
,
1867 AsciiStrSize (BestPlatformLang
), Attributes
, 0, 0, &Variable
, NULL
);
1870 DEBUG ((EFI_D_INFO
, "Variable Driver Auto Update Lang, Lang:%a, PlatformLang:%a Status: %r\n", BestLang
, BestPlatformLang
, Status
));
1875 if (SetLanguageCodes
) {
1877 // Continue to set PlatformLangCodes or LangCodes.
1886 Update the variable region with Variable information. If EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS is set,
1887 index of associated public key is needed.
1889 @param[in] VariableName Name of variable.
1890 @param[in] VendorGuid Guid of variable.
1891 @param[in] Data Variable data.
1892 @param[in] DataSize Size of data. 0 means delete.
1893 @param[in] Attributes Attributes of the variable.
1894 @param[in] KeyIndex Index of associated public key.
1895 @param[in] MonotonicCount Value of associated monotonic count.
1896 @param[in, out] CacheVariable The variable information which is used to keep track of variable usage.
1897 @param[in] TimeStamp Value of associated TimeStamp.
1899 @retval EFI_SUCCESS The update operation is success.
1900 @retval EFI_OUT_OF_RESOURCES Variable region is full, can not write other data into this region.
1905 IN CHAR16
*VariableName
,
1906 IN EFI_GUID
*VendorGuid
,
1909 IN UINT32 Attributes OPTIONAL
,
1910 IN UINT32 KeyIndex OPTIONAL
,
1911 IN UINT64 MonotonicCount OPTIONAL
,
1912 IN OUT VARIABLE_POINTER_TRACK
*CacheVariable
,
1913 IN EFI_TIME
*TimeStamp OPTIONAL
1917 VARIABLE_HEADER
*NextVariable
;
1920 UINTN NonVolatileVarableStoreSize
;
1921 UINTN VarNameOffset
;
1922 UINTN VarDataOffset
;
1926 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*Fvb
;
1928 VARIABLE_POINTER_TRACK
*Variable
;
1929 VARIABLE_POINTER_TRACK NvVariable
;
1930 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
1932 UINT8
*BufferForMerge
;
1933 UINTN MergedBufSize
;
1937 if (mVariableModuleGlobal
->FvbInstance
== NULL
) {
1939 // The FVB protocol is not installed, so the EFI_VARIABLE_WRITE_ARCH_PROTOCOL is not installed.
1941 if ((Attributes
& EFI_VARIABLE_NON_VOLATILE
) != 0) {
1943 // Trying to update NV variable prior to the installation of EFI_VARIABLE_WRITE_ARCH_PROTOCOL
1945 return EFI_NOT_AVAILABLE_YET
;
1946 } else if ((Attributes
& EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
) != 0) {
1948 // Trying to update volatile authenticated variable prior to the installation of EFI_VARIABLE_WRITE_ARCH_PROTOCOL
1949 // The authenticated variable perhaps is not initialized, just return here.
1951 return EFI_NOT_AVAILABLE_YET
;
1955 if ((CacheVariable
->CurrPtr
== NULL
) || CacheVariable
->Volatile
) {
1956 Variable
= CacheVariable
;
1959 // Update/Delete existing NV variable.
1960 // CacheVariable points to the variable in the memory copy of Flash area
1961 // Now let Variable points to the same variable in Flash area.
1963 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*) ((UINTN
) mVariableModuleGlobal
->VariableGlobal
.NonVolatileVariableBase
);
1964 Variable
= &NvVariable
;
1965 Variable
->StartPtr
= GetStartPointer (VariableStoreHeader
);
1966 Variable
->EndPtr
= GetEndPointer (VariableStoreHeader
);
1967 Variable
->CurrPtr
= (VARIABLE_HEADER
*)((UINTN
)Variable
->StartPtr
+ ((UINTN
)CacheVariable
->CurrPtr
- (UINTN
)CacheVariable
->StartPtr
));
1968 if (CacheVariable
->InDeletedTransitionPtr
!= NULL
) {
1969 Variable
->InDeletedTransitionPtr
= (VARIABLE_HEADER
*)((UINTN
)Variable
->StartPtr
+ ((UINTN
)CacheVariable
->InDeletedTransitionPtr
- (UINTN
)CacheVariable
->StartPtr
));
1971 Variable
->InDeletedTransitionPtr
= NULL
;
1973 Variable
->Volatile
= FALSE
;
1976 Fvb
= mVariableModuleGlobal
->FvbInstance
;
1979 // Tricky part: Use scratch data area at the end of volatile variable store
1980 // as a temporary storage.
1982 NextVariable
= GetEndPointer ((VARIABLE_STORE_HEADER
*) ((UINTN
) mVariableModuleGlobal
->VariableGlobal
.VolatileVariableBase
));
1983 ScratchSize
= MAX (PcdGet32 (PcdMaxVariableSize
), PcdGet32 (PcdMaxHardwareErrorVariableSize
));
1984 SetMem (NextVariable
, ScratchSize
, 0xff);
1987 if (Variable
->CurrPtr
!= NULL
) {
1989 // Update/Delete existing variable.
1993 // If AtRuntime and the variable is Volatile and Runtime Access,
1994 // the volatile is ReadOnly, and SetVariable should be aborted and
1995 // return EFI_WRITE_PROTECTED.
1997 if (Variable
->Volatile
) {
1998 Status
= EFI_WRITE_PROTECTED
;
2002 // Only variable that have NV attributes can be updated/deleted in Runtime.
2004 if ((Variable
->CurrPtr
->Attributes
& EFI_VARIABLE_NON_VOLATILE
) == 0) {
2005 Status
= EFI_INVALID_PARAMETER
;
2010 // Only variable that have RT attributes can be updated/deleted in Runtime.
2012 if ((Variable
->CurrPtr
->Attributes
& EFI_VARIABLE_RUNTIME_ACCESS
) == 0) {
2013 Status
= EFI_INVALID_PARAMETER
;
2019 // Setting a data variable with no access, or zero DataSize attributes
2020 // causes it to be deleted.
2021 // When the EFI_VARIABLE_APPEND_WRITE attribute is set, DataSize of zero will
2022 // not delete the variable.
2024 if ((((Attributes
& EFI_VARIABLE_APPEND_WRITE
) == 0) && (DataSize
== 0))|| ((Attributes
& (EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
)) == 0)) {
2025 if (Variable
->InDeletedTransitionPtr
!= NULL
) {
2027 // Both ADDED and IN_DELETED_TRANSITION variable are present,
2028 // set IN_DELETED_TRANSITION one to DELETED state first.
2030 State
= Variable
->InDeletedTransitionPtr
->State
;
2031 State
&= VAR_DELETED
;
2032 Status
= UpdateVariableStore (
2033 &mVariableModuleGlobal
->VariableGlobal
,
2037 (UINTN
) &Variable
->InDeletedTransitionPtr
->State
,
2041 if (!EFI_ERROR (Status
)) {
2042 if (!Variable
->Volatile
) {
2043 ASSERT (CacheVariable
->InDeletedTransitionPtr
!= NULL
);
2044 CacheVariable
->InDeletedTransitionPtr
->State
= State
;
2051 State
= Variable
->CurrPtr
->State
;
2052 State
&= VAR_DELETED
;
2054 Status
= UpdateVariableStore (
2055 &mVariableModuleGlobal
->VariableGlobal
,
2059 (UINTN
) &Variable
->CurrPtr
->State
,
2063 if (!EFI_ERROR (Status
)) {
2064 UpdateVariableInfo (VariableName
, VendorGuid
, Variable
->Volatile
, FALSE
, FALSE
, TRUE
, FALSE
);
2065 if (!Variable
->Volatile
) {
2066 CacheVariable
->CurrPtr
->State
= State
;
2067 FlushHobVariableToFlash (VariableName
, VendorGuid
);
2073 // If the variable is marked valid, and the same data has been passed in,
2074 // then return to the caller immediately.
2076 if (DataSizeOfVariable (Variable
->CurrPtr
) == DataSize
&&
2077 (CompareMem (Data
, GetVariableDataPtr (Variable
->CurrPtr
), DataSize
) == 0) &&
2078 ((Attributes
& EFI_VARIABLE_APPEND_WRITE
) == 0) &&
2079 (TimeStamp
== NULL
)) {
2081 // Variable content unchanged and no need to update timestamp, just return.
2083 UpdateVariableInfo (VariableName
, VendorGuid
, Variable
->Volatile
, FALSE
, TRUE
, FALSE
, FALSE
);
2084 Status
= EFI_SUCCESS
;
2086 } else if ((Variable
->CurrPtr
->State
== VAR_ADDED
) ||
2087 (Variable
->CurrPtr
->State
== (VAR_ADDED
& VAR_IN_DELETED_TRANSITION
))) {
2090 // EFI_VARIABLE_APPEND_WRITE attribute only effects for existing variable
2092 if ((Attributes
& EFI_VARIABLE_APPEND_WRITE
) != 0) {
2094 // NOTE: From 0 to DataOffset of NextVariable is reserved for Variable Header and Name.
2095 // From DataOffset of NextVariable is to save the existing variable data.
2097 DataOffset
= sizeof (VARIABLE_HEADER
) + Variable
->CurrPtr
->NameSize
+ GET_PAD_SIZE (Variable
->CurrPtr
->NameSize
);
2098 BufferForMerge
= (UINT8
*) ((UINTN
) NextVariable
+ DataOffset
);
2099 CopyMem (BufferForMerge
, (UINT8
*) ((UINTN
) Variable
->CurrPtr
+ DataOffset
), Variable
->CurrPtr
->DataSize
);
2102 // Set Max Common Variable Data Size as default MaxDataSize
2104 MaxDataSize
= PcdGet32 (PcdMaxVariableSize
) - DataOffset
;
2106 if ((CompareGuid (VendorGuid
, &gEfiImageSecurityDatabaseGuid
) &&
2107 ((StrCmp (VariableName
, EFI_IMAGE_SECURITY_DATABASE
) == 0) || (StrCmp (VariableName
, EFI_IMAGE_SECURITY_DATABASE1
) == 0))) ||
2108 (CompareGuid (VendorGuid
, &gEfiGlobalVariableGuid
) && (StrCmp (VariableName
, EFI_KEY_EXCHANGE_KEY_NAME
) == 0))) {
2110 // For variables with formatted as EFI_SIGNATURE_LIST, the driver shall not perform an append of
2111 // EFI_SIGNATURE_DATA values that are already part of the existing variable value.
2113 Status
= AppendSignatureList (
2115 Variable
->CurrPtr
->DataSize
,
2116 MaxDataSize
- Variable
->CurrPtr
->DataSize
,
2121 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2123 // Signature List is too long, Failed to Append.
2125 Status
= EFI_INVALID_PARAMETER
;
2129 if (MergedBufSize
== Variable
->CurrPtr
->DataSize
) {
2130 if ((TimeStamp
== NULL
) || CompareTimeStamp (TimeStamp
, &Variable
->CurrPtr
->TimeStamp
)) {
2132 // New EFI_SIGNATURE_DATA is not found and timestamp is not later
2133 // than current timestamp, return EFI_SUCCESS directly.
2135 UpdateVariableInfo (VariableName
, VendorGuid
, Variable
->Volatile
, FALSE
, TRUE
, FALSE
, FALSE
);
2136 Status
= EFI_SUCCESS
;
2142 // For other Variables, append the new data to the end of existing data.
2143 // Max Harware error record variable data size is different from common variable
2145 if ((Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) == EFI_VARIABLE_HARDWARE_ERROR_RECORD
) {
2146 MaxDataSize
= PcdGet32 (PcdMaxHardwareErrorVariableSize
) - DataOffset
;
2149 if (Variable
->CurrPtr
->DataSize
+ DataSize
> MaxDataSize
) {
2151 // Existing data size + new data size exceed maximum variable size limitation.
2153 Status
= EFI_INVALID_PARAMETER
;
2156 CopyMem ((UINT8
*) ((UINTN
) BufferForMerge
+ Variable
->CurrPtr
->DataSize
), Data
, DataSize
);
2157 MergedBufSize
= Variable
->CurrPtr
->DataSize
+ DataSize
;
2161 // BufferForMerge(from DataOffset of NextVariable) has included the merged existing and new data.
2163 Data
= BufferForMerge
;
2164 DataSize
= MergedBufSize
;
2169 // Mark the old variable as in delete transition.
2171 State
= Variable
->CurrPtr
->State
;
2172 State
&= VAR_IN_DELETED_TRANSITION
;
2174 Status
= UpdateVariableStore (
2175 &mVariableModuleGlobal
->VariableGlobal
,
2179 (UINTN
) &Variable
->CurrPtr
->State
,
2183 if (EFI_ERROR (Status
)) {
2186 if (!Variable
->Volatile
) {
2187 CacheVariable
->CurrPtr
->State
= State
;
2192 // Not found existing variable. Create a new variable.
2195 if ((DataSize
== 0) && ((Attributes
& EFI_VARIABLE_APPEND_WRITE
) != 0)) {
2196 Status
= EFI_SUCCESS
;
2201 // Make sure we are trying to create a new variable.
2202 // Setting a data variable with zero DataSize or no access attributes means to delete it.
2204 if (DataSize
== 0 || (Attributes
& (EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
)) == 0) {
2205 Status
= EFI_NOT_FOUND
;
2210 // Only variable have NV|RT attribute can be created in Runtime.
2213 (((Attributes
& EFI_VARIABLE_RUNTIME_ACCESS
) == 0) || ((Attributes
& EFI_VARIABLE_NON_VOLATILE
) == 0))) {
2214 Status
= EFI_INVALID_PARAMETER
;
2220 // Function part - create a new variable and copy the data.
2221 // Both update a variable and create a variable will come here.
2223 NextVariable
->StartId
= VARIABLE_DATA
;
2225 // NextVariable->State = VAR_ADDED;
2227 NextVariable
->Reserved
= 0;
2228 NextVariable
->PubKeyIndex
= KeyIndex
;
2229 NextVariable
->MonotonicCount
= MonotonicCount
;
2230 ZeroMem (&NextVariable
->TimeStamp
, sizeof (EFI_TIME
));
2232 if (((Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) != 0) &&
2233 (TimeStamp
!= NULL
)) {
2234 if ((Attributes
& EFI_VARIABLE_APPEND_WRITE
) == 0) {
2235 CopyMem (&NextVariable
->TimeStamp
, TimeStamp
, sizeof (EFI_TIME
));
2238 // In the case when the EFI_VARIABLE_APPEND_WRITE attribute is set, only
2239 // when the new TimeStamp value is later than the current timestamp associated
2240 // with the variable, we need associate the new timestamp with the updated value.
2242 if (Variable
->CurrPtr
!= NULL
) {
2243 if (CompareTimeStamp (&Variable
->CurrPtr
->TimeStamp
, TimeStamp
)) {
2244 CopyMem (&NextVariable
->TimeStamp
, TimeStamp
, sizeof (EFI_TIME
));
2251 // The EFI_VARIABLE_APPEND_WRITE attribute will never be set in the returned
2252 // Attributes bitmask parameter of a GetVariable() call.
2254 NextVariable
->Attributes
= Attributes
& (~EFI_VARIABLE_APPEND_WRITE
);
2256 VarNameOffset
= sizeof (VARIABLE_HEADER
);
2257 VarNameSize
= StrSize (VariableName
);
2259 (UINT8
*) ((UINTN
) NextVariable
+ VarNameOffset
),
2263 VarDataOffset
= VarNameOffset
+ VarNameSize
+ GET_PAD_SIZE (VarNameSize
);
2266 // If DataReady is TRUE, it means the variable data has been saved into
2267 // NextVariable during EFI_VARIABLE_APPEND_WRITE operation preparation.
2271 (UINT8
*) ((UINTN
) NextVariable
+ VarDataOffset
),
2277 CopyMem (&NextVariable
->VendorGuid
, VendorGuid
, sizeof (EFI_GUID
));
2279 // There will be pad bytes after Data, the NextVariable->NameSize and
2280 // NextVariable->DataSize should not include pad size so that variable
2281 // service can get actual size in GetVariable.
2283 NextVariable
->NameSize
= (UINT32
)VarNameSize
;
2284 NextVariable
->DataSize
= (UINT32
)DataSize
;
2287 // The actual size of the variable that stores in storage should
2288 // include pad size.
2290 VarSize
= VarDataOffset
+ DataSize
+ GET_PAD_SIZE (DataSize
);
2291 if ((Attributes
& EFI_VARIABLE_NON_VOLATILE
) != 0) {
2293 // Create a nonvolatile variable.
2296 NonVolatileVarableStoreSize
= ((VARIABLE_STORE_HEADER
*)(UINTN
)(mVariableModuleGlobal
->VariableGlobal
.NonVolatileVariableBase
))->Size
;
2297 if ((((Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) != 0)
2298 && ((VarSize
+ mVariableModuleGlobal
->HwErrVariableTotalSize
) > PcdGet32 (PcdHwErrStorageSize
)))
2299 || (((Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) == 0)
2300 && ((VarSize
+ mVariableModuleGlobal
->CommonVariableTotalSize
) > NonVolatileVarableStoreSize
- sizeof (VARIABLE_STORE_HEADER
) - PcdGet32 (PcdHwErrStorageSize
)))) {
2302 Status
= EFI_OUT_OF_RESOURCES
;
2306 // Perform garbage collection & reclaim operation, and integrate the new variable at the same time.
2309 mVariableModuleGlobal
->VariableGlobal
.NonVolatileVariableBase
,
2310 &mVariableModuleGlobal
->NonVolatileLastVariableOffset
,
2314 HEADER_ALIGN (VarSize
),
2317 if (!EFI_ERROR (Status
)) {
2319 // The new variable has been integrated successfully during reclaiming.
2321 if (Variable
->CurrPtr
!= NULL
) {
2322 CacheVariable
->CurrPtr
= (VARIABLE_HEADER
*)((UINTN
) CacheVariable
->StartPtr
+ ((UINTN
) Variable
->CurrPtr
- (UINTN
) Variable
->StartPtr
));
2323 CacheVariable
->InDeletedTransitionPtr
= NULL
;
2325 UpdateVariableInfo (VariableName
, VendorGuid
, FALSE
, FALSE
, TRUE
, FALSE
, FALSE
);
2326 FlushHobVariableToFlash (VariableName
, VendorGuid
);
2332 // 1. Write variable header
2333 // 2. Set variable state to header valid
2334 // 3. Write variable data
2335 // 4. Set variable state to valid
2340 CacheOffset
= mVariableModuleGlobal
->NonVolatileLastVariableOffset
;
2341 Status
= UpdateVariableStore (
2342 &mVariableModuleGlobal
->VariableGlobal
,
2346 mVariableModuleGlobal
->NonVolatileLastVariableOffset
,
2347 sizeof (VARIABLE_HEADER
),
2348 (UINT8
*) NextVariable
2351 if (EFI_ERROR (Status
)) {
2358 NextVariable
->State
= VAR_HEADER_VALID_ONLY
;
2359 Status
= UpdateVariableStore (
2360 &mVariableModuleGlobal
->VariableGlobal
,
2364 mVariableModuleGlobal
->NonVolatileLastVariableOffset
+ OFFSET_OF (VARIABLE_HEADER
, State
),
2366 &NextVariable
->State
2369 if (EFI_ERROR (Status
)) {
2375 Status
= UpdateVariableStore (
2376 &mVariableModuleGlobal
->VariableGlobal
,
2380 mVariableModuleGlobal
->NonVolatileLastVariableOffset
+ sizeof (VARIABLE_HEADER
),
2381 (UINT32
) VarSize
- sizeof (VARIABLE_HEADER
),
2382 (UINT8
*) NextVariable
+ sizeof (VARIABLE_HEADER
)
2385 if (EFI_ERROR (Status
)) {
2391 NextVariable
->State
= VAR_ADDED
;
2392 Status
= UpdateVariableStore (
2393 &mVariableModuleGlobal
->VariableGlobal
,
2397 mVariableModuleGlobal
->NonVolatileLastVariableOffset
+ OFFSET_OF (VARIABLE_HEADER
, State
),
2399 &NextVariable
->State
2402 if (EFI_ERROR (Status
)) {
2406 mVariableModuleGlobal
->NonVolatileLastVariableOffset
+= HEADER_ALIGN (VarSize
);
2408 if ((Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) != 0) {
2409 mVariableModuleGlobal
->HwErrVariableTotalSize
+= HEADER_ALIGN (VarSize
);
2411 mVariableModuleGlobal
->CommonVariableTotalSize
+= HEADER_ALIGN (VarSize
);
2414 // update the memory copy of Flash region.
2416 CopyMem ((UINT8
*)mNvVariableCache
+ CacheOffset
, (UINT8
*)NextVariable
, VarSize
);
2419 // Create a volatile variable.
2423 if ((UINT32
) (VarSize
+ mVariableModuleGlobal
->VolatileLastVariableOffset
) >
2424 ((VARIABLE_STORE_HEADER
*) ((UINTN
) (mVariableModuleGlobal
->VariableGlobal
.VolatileVariableBase
)))->Size
) {
2426 // Perform garbage collection & reclaim operation, and integrate the new variable at the same time.
2429 mVariableModuleGlobal
->VariableGlobal
.VolatileVariableBase
,
2430 &mVariableModuleGlobal
->VolatileLastVariableOffset
,
2434 HEADER_ALIGN (VarSize
),
2437 if (!EFI_ERROR (Status
)) {
2439 // The new variable has been integrated successfully during reclaiming.
2441 if (Variable
->CurrPtr
!= NULL
) {
2442 CacheVariable
->CurrPtr
= (VARIABLE_HEADER
*)((UINTN
) CacheVariable
->StartPtr
+ ((UINTN
) Variable
->CurrPtr
- (UINTN
) Variable
->StartPtr
));
2443 CacheVariable
->InDeletedTransitionPtr
= NULL
;
2445 UpdateVariableInfo (VariableName
, VendorGuid
, TRUE
, FALSE
, TRUE
, FALSE
, FALSE
);
2450 NextVariable
->State
= VAR_ADDED
;
2451 Status
= UpdateVariableStore (
2452 &mVariableModuleGlobal
->VariableGlobal
,
2456 mVariableModuleGlobal
->VolatileLastVariableOffset
,
2458 (UINT8
*) NextVariable
2461 if (EFI_ERROR (Status
)) {
2465 mVariableModuleGlobal
->VolatileLastVariableOffset
+= HEADER_ALIGN (VarSize
);
2469 // Mark the old variable as deleted.
2471 if (!EFI_ERROR (Status
) && Variable
->CurrPtr
!= NULL
) {
2472 if (Variable
->InDeletedTransitionPtr
!= NULL
) {
2474 // Both ADDED and IN_DELETED_TRANSITION old variable are present,
2475 // set IN_DELETED_TRANSITION one to DELETED state first.
2477 State
= Variable
->InDeletedTransitionPtr
->State
;
2478 State
&= VAR_DELETED
;
2479 Status
= UpdateVariableStore (
2480 &mVariableModuleGlobal
->VariableGlobal
,
2484 (UINTN
) &Variable
->InDeletedTransitionPtr
->State
,
2488 if (!EFI_ERROR (Status
)) {
2489 if (!Variable
->Volatile
) {
2490 ASSERT (CacheVariable
->InDeletedTransitionPtr
!= NULL
);
2491 CacheVariable
->InDeletedTransitionPtr
->State
= State
;
2498 State
= Variable
->CurrPtr
->State
;
2499 State
&= VAR_DELETED
;
2501 Status
= UpdateVariableStore (
2502 &mVariableModuleGlobal
->VariableGlobal
,
2506 (UINTN
) &Variable
->CurrPtr
->State
,
2510 if (!EFI_ERROR (Status
) && !Variable
->Volatile
) {
2511 CacheVariable
->CurrPtr
->State
= State
;
2515 if (!EFI_ERROR (Status
)) {
2516 UpdateVariableInfo (VariableName
, VendorGuid
, Volatile
, FALSE
, TRUE
, FALSE
, FALSE
);
2518 FlushHobVariableToFlash (VariableName
, VendorGuid
);
2527 Check if a Unicode character is a hexadecimal character.
2529 This function checks if a Unicode character is a
2530 hexadecimal character. The valid hexadecimal character is
2531 L'0' to L'9', L'a' to L'f', or L'A' to L'F'.
2534 @param Char The character to check against.
2536 @retval TRUE If the Char is a hexadecmial character.
2537 @retval FALSE If the Char is not a hexadecmial character.
2542 IsHexaDecimalDigitCharacter (
2546 return (BOOLEAN
) ((Char
>= L
'0' && Char
<= L
'9') || (Char
>= L
'A' && Char
<= L
'F') || (Char
>= L
'a' && Char
<= L
'f'));
2551 This code checks if variable is hardware error record variable or not.
2553 According to UEFI spec, hardware error record variable should use the EFI_HARDWARE_ERROR_VARIABLE VendorGuid
2554 and have the L"HwErrRec####" name convention, #### is a printed hex value and no 0x or h is included in the hex value.
2556 @param VariableName Pointer to variable name.
2557 @param VendorGuid Variable Vendor Guid.
2559 @retval TRUE Variable is hardware error record variable.
2560 @retval FALSE Variable is not hardware error record variable.
2565 IsHwErrRecVariable (
2566 IN CHAR16
*VariableName
,
2567 IN EFI_GUID
*VendorGuid
2570 if (!CompareGuid (VendorGuid
, &gEfiHardwareErrorVariableGuid
) ||
2571 (StrLen (VariableName
) != StrLen (L
"HwErrRec####")) ||
2572 (StrnCmp(VariableName
, L
"HwErrRec", StrLen (L
"HwErrRec")) != 0) ||
2573 !IsHexaDecimalDigitCharacter (VariableName
[0x8]) ||
2574 !IsHexaDecimalDigitCharacter (VariableName
[0x9]) ||
2575 !IsHexaDecimalDigitCharacter (VariableName
[0xA]) ||
2576 !IsHexaDecimalDigitCharacter (VariableName
[0xB])) {
2584 This code checks if variable guid is global variable guid first.
2585 If yes, further check if variable name is in mGlobalVariableList or mGlobalVariableList2 and attributes matched.
2587 @param[in] VariableName Pointer to variable name.
2588 @param[in] VendorGuid Variable Vendor Guid.
2589 @param[in] Attributes Attributes of the variable.
2591 @retval EFI_SUCCESS Variable is not global variable, or Variable is global variable, variable name is in the lists and attributes matched.
2592 @retval EFI_INVALID_PARAMETER Variable is global variable, but variable name is not in the lists or attributes unmatched.
2597 CheckEfiGlobalVariable (
2598 IN CHAR16
*VariableName
,
2599 IN EFI_GUID
*VendorGuid
,
2600 IN UINT32 Attributes
2606 if (CompareGuid (VendorGuid
, &gEfiGlobalVariableGuid
)){
2608 // Try list 1, exactly match.
2610 for (Index
= 0; Index
< sizeof (mGlobalVariableList
)/sizeof (mGlobalVariableList
[0]); Index
++) {
2611 if ((StrCmp (mGlobalVariableList
[Index
].Name
, VariableName
) == 0) &&
2612 (Attributes
== 0 || (Attributes
& (~EFI_VARIABLE_APPEND_WRITE
)) == mGlobalVariableList
[Index
].Attributes
)) {
2620 NameLength
= StrLen (VariableName
) - 4;
2621 for (Index
= 0; Index
< sizeof (mGlobalVariableList2
)/sizeof (mGlobalVariableList2
[0]); Index
++) {
2622 if ((StrLen (VariableName
) == StrLen (mGlobalVariableList2
[Index
].Name
)) &&
2623 (StrnCmp (mGlobalVariableList2
[Index
].Name
, VariableName
, NameLength
) == 0) &&
2624 IsHexaDecimalDigitCharacter (VariableName
[NameLength
]) &&
2625 IsHexaDecimalDigitCharacter (VariableName
[NameLength
+ 1]) &&
2626 IsHexaDecimalDigitCharacter (VariableName
[NameLength
+ 2]) &&
2627 IsHexaDecimalDigitCharacter (VariableName
[NameLength
+ 3]) &&
2628 (Attributes
== 0 || (Attributes
& (~EFI_VARIABLE_APPEND_WRITE
)) == mGlobalVariableList2
[Index
].Attributes
)) {
2633 DEBUG ((EFI_D_INFO
, "[Variable]: set global variable with invalid variable name or attributes - %g:%s:%x\n", VendorGuid
, VariableName
, Attributes
));
2634 return EFI_INVALID_PARAMETER
;
2641 Mark a variable that will become read-only after leaving the DXE phase of execution.
2643 @param[in] This The VARIABLE_LOCK_PROTOCOL instance.
2644 @param[in] VariableName A pointer to the variable name that will be made read-only subsequently.
2645 @param[in] VendorGuid A pointer to the vendor GUID that will be made read-only subsequently.
2647 @retval EFI_SUCCESS The variable specified by the VariableName and the VendorGuid was marked
2648 as pending to be read-only.
2649 @retval EFI_INVALID_PARAMETER VariableName or VendorGuid is NULL.
2650 Or VariableName is an empty string.
2651 @retval EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has
2652 already been signaled.
2653 @retval EFI_OUT_OF_RESOURCES There is not enough resource to hold the lock request.
2657 VariableLockRequestToLock (
2658 IN CONST EDKII_VARIABLE_LOCK_PROTOCOL
*This
,
2659 IN CHAR16
*VariableName
,
2660 IN EFI_GUID
*VendorGuid
2663 VARIABLE_ENTRY
*Entry
;
2665 if (VariableName
== NULL
|| VariableName
[0] == 0 || VendorGuid
== NULL
) {
2666 return EFI_INVALID_PARAMETER
;
2670 return EFI_ACCESS_DENIED
;
2673 Entry
= AllocateRuntimePool (sizeof (*Entry
) + StrSize (VariableName
));
2674 if (Entry
== NULL
) {
2675 return EFI_OUT_OF_RESOURCES
;
2678 DEBUG ((EFI_D_INFO
, "[Variable] Lock: %g:%s\n", VendorGuid
, VariableName
));
2680 AcquireLockOnlyAtBootTime(&mVariableModuleGlobal
->VariableGlobal
.VariableServicesLock
);
2682 Entry
->Name
= (CHAR16
*) (Entry
+ 1);
2683 StrCpy (Entry
->Name
, VariableName
);
2684 CopyGuid (&Entry
->Guid
, VendorGuid
);
2685 InsertTailList (&mLockedVariableList
, &Entry
->Link
);
2687 ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal
->VariableGlobal
.VariableServicesLock
);
2693 This code checks if variable should be treated as read-only variable.
2695 @param[in] VariableName Name of the Variable.
2696 @param[in] VendorGuid GUID of the Variable.
2698 @retval TRUE This variable is read-only variable.
2699 @retval FALSE This variable is NOT read-only variable.
2703 IsReadOnlyVariable (
2704 IN CHAR16
*VariableName
,
2705 IN EFI_GUID
*VendorGuid
2708 if (CompareGuid (VendorGuid
, &gEfiGlobalVariableGuid
)) {
2709 if ((StrCmp (VariableName
, EFI_SETUP_MODE_NAME
) == 0) ||
2710 (StrCmp (VariableName
, EFI_SIGNATURE_SUPPORT_NAME
) == 0) ||
2711 (StrCmp (VariableName
, EFI_SECURE_BOOT_MODE_NAME
) == 0) ||
2712 (StrCmp (VariableName
, EFI_VENDOR_KEYS_VARIABLE_NAME
) == 0) ||
2713 (StrCmp (VariableName
, EFI_KEK_DEFAULT_VARIABLE_NAME
) == 0) ||
2714 (StrCmp (VariableName
, EFI_PK_DEFAULT_VARIABLE_NAME
) == 0) ||
2715 (StrCmp (VariableName
, EFI_DB_DEFAULT_VARIABLE_NAME
) == 0) ||
2716 (StrCmp (VariableName
, EFI_DBX_DEFAULT_VARIABLE_NAME
) == 0) ||
2717 (StrCmp (VariableName
, EFI_DBT_DEFAULT_VARIABLE_NAME
) == 0)) {
2727 This code finds variable in storage blocks (Volatile or Non-Volatile).
2729 Caution: This function may receive untrusted input.
2730 This function may be invoked in SMM mode, and datasize is external input.
2731 This function will do basic validation, before parse the data.
2733 @param VariableName Name of Variable to be found.
2734 @param VendorGuid Variable vendor GUID.
2735 @param Attributes Attribute value of the variable found.
2736 @param DataSize Size of Data found. If size is less than the
2737 data, this value contains the required size.
2738 @param Data Data pointer.
2740 @return EFI_INVALID_PARAMETER Invalid parameter.
2741 @return EFI_SUCCESS Find the specified variable.
2742 @return EFI_NOT_FOUND Not found.
2743 @return EFI_BUFFER_TO_SMALL DataSize is too small for the result.
2748 VariableServiceGetVariable (
2749 IN CHAR16
*VariableName
,
2750 IN EFI_GUID
*VendorGuid
,
2751 OUT UINT32
*Attributes OPTIONAL
,
2752 IN OUT UINTN
*DataSize
,
2757 VARIABLE_POINTER_TRACK Variable
;
2760 if (VariableName
== NULL
|| VendorGuid
== NULL
|| DataSize
== NULL
) {
2761 return EFI_INVALID_PARAMETER
;
2764 AcquireLockOnlyAtBootTime(&mVariableModuleGlobal
->VariableGlobal
.VariableServicesLock
);
2766 Status
= FindVariable (VariableName
, VendorGuid
, &Variable
, &mVariableModuleGlobal
->VariableGlobal
, FALSE
);
2767 if (Variable
.CurrPtr
== NULL
|| EFI_ERROR (Status
)) {
2774 VarDataSize
= DataSizeOfVariable (Variable
.CurrPtr
);
2775 ASSERT (VarDataSize
!= 0);
2777 if (*DataSize
>= VarDataSize
) {
2779 Status
= EFI_INVALID_PARAMETER
;
2783 CopyMem (Data
, GetVariableDataPtr (Variable
.CurrPtr
), VarDataSize
);
2784 if (Attributes
!= NULL
) {
2785 *Attributes
= Variable
.CurrPtr
->Attributes
;
2788 *DataSize
= VarDataSize
;
2789 UpdateVariableInfo (VariableName
, VendorGuid
, Variable
.Volatile
, TRUE
, FALSE
, FALSE
, FALSE
);
2791 Status
= EFI_SUCCESS
;
2794 *DataSize
= VarDataSize
;
2795 Status
= EFI_BUFFER_TOO_SMALL
;
2800 ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal
->VariableGlobal
.VariableServicesLock
);
2808 This code Finds the Next available variable.
2810 Caution: This function may receive untrusted input.
2811 This function may be invoked in SMM mode. This function will do basic validation, before parse the data.
2813 @param VariableNameSize Size of the variable name.
2814 @param VariableName Pointer to variable name.
2815 @param VendorGuid Variable Vendor Guid.
2817 @return EFI_INVALID_PARAMETER Invalid parameter.
2818 @return EFI_SUCCESS Find the specified variable.
2819 @return EFI_NOT_FOUND Not found.
2820 @return EFI_BUFFER_TO_SMALL DataSize is too small for the result.
2825 VariableServiceGetNextVariableName (
2826 IN OUT UINTN
*VariableNameSize
,
2827 IN OUT CHAR16
*VariableName
,
2828 IN OUT EFI_GUID
*VendorGuid
2831 VARIABLE_STORE_TYPE Type
;
2832 VARIABLE_POINTER_TRACK Variable
;
2833 VARIABLE_POINTER_TRACK VariableInHob
;
2834 VARIABLE_POINTER_TRACK VariablePtrTrack
;
2837 VARIABLE_STORE_HEADER
*VariableStoreHeader
[VariableStoreTypeMax
];
2839 if (VariableNameSize
== NULL
|| VariableName
== NULL
|| VendorGuid
== NULL
) {
2840 return EFI_INVALID_PARAMETER
;
2843 AcquireLockOnlyAtBootTime(&mVariableModuleGlobal
->VariableGlobal
.VariableServicesLock
);
2845 Status
= FindVariable (VariableName
, VendorGuid
, &Variable
, &mVariableModuleGlobal
->VariableGlobal
, FALSE
);
2846 if (Variable
.CurrPtr
== NULL
|| EFI_ERROR (Status
)) {
2850 if (VariableName
[0] != 0) {
2852 // If variable name is not NULL, get next variable.
2854 Variable
.CurrPtr
= GetNextVariablePtr (Variable
.CurrPtr
);
2858 // 0: Volatile, 1: HOB, 2: Non-Volatile.
2859 // The index and attributes mapping must be kept in this order as FindVariable
2860 // makes use of this mapping to implement search algorithm.
2862 VariableStoreHeader
[VariableStoreTypeVolatile
] = (VARIABLE_STORE_HEADER
*) (UINTN
) mVariableModuleGlobal
->VariableGlobal
.VolatileVariableBase
;
2863 VariableStoreHeader
[VariableStoreTypeHob
] = (VARIABLE_STORE_HEADER
*) (UINTN
) mVariableModuleGlobal
->VariableGlobal
.HobVariableBase
;
2864 VariableStoreHeader
[VariableStoreTypeNv
] = mNvVariableCache
;
2868 // Switch from Volatile to HOB, to Non-Volatile.
2870 while ((Variable
.CurrPtr
>= Variable
.EndPtr
) ||
2871 (Variable
.CurrPtr
== NULL
) ||
2872 !IsValidVariableHeader (Variable
.CurrPtr
)
2875 // Find current storage index
2877 for (Type
= (VARIABLE_STORE_TYPE
) 0; Type
< VariableStoreTypeMax
; Type
++) {
2878 if ((VariableStoreHeader
[Type
] != NULL
) && (Variable
.StartPtr
== GetStartPointer (VariableStoreHeader
[Type
]))) {
2882 ASSERT (Type
< VariableStoreTypeMax
);
2884 // Switch to next storage
2886 for (Type
++; Type
< VariableStoreTypeMax
; Type
++) {
2887 if (VariableStoreHeader
[Type
] != NULL
) {
2892 // Capture the case that
2893 // 1. current storage is the last one, or
2894 // 2. no further storage
2896 if (Type
== VariableStoreTypeMax
) {
2897 Status
= EFI_NOT_FOUND
;
2900 Variable
.StartPtr
= GetStartPointer (VariableStoreHeader
[Type
]);
2901 Variable
.EndPtr
= GetEndPointer (VariableStoreHeader
[Type
]);
2902 Variable
.CurrPtr
= Variable
.StartPtr
;
2906 // Variable is found
2908 if (Variable
.CurrPtr
->State
== VAR_ADDED
|| Variable
.CurrPtr
->State
== (VAR_IN_DELETED_TRANSITION
& VAR_ADDED
)) {
2909 if (!AtRuntime () || ((Variable
.CurrPtr
->Attributes
& EFI_VARIABLE_RUNTIME_ACCESS
) != 0)) {
2910 if (Variable
.CurrPtr
->State
== (VAR_IN_DELETED_TRANSITION
& VAR_ADDED
)) {
2912 // If it is a IN_DELETED_TRANSITION variable,
2913 // and there is also a same ADDED one at the same time,
2916 VariablePtrTrack
.StartPtr
= Variable
.StartPtr
;
2917 VariablePtrTrack
.EndPtr
= Variable
.EndPtr
;
2918 Status
= FindVariableEx (
2919 GetVariableNamePtr (Variable
.CurrPtr
),
2920 &Variable
.CurrPtr
->VendorGuid
,
2924 if (!EFI_ERROR (Status
) && VariablePtrTrack
.CurrPtr
->State
== VAR_ADDED
) {
2925 Variable
.CurrPtr
= GetNextVariablePtr (Variable
.CurrPtr
);
2931 // Don't return NV variable when HOB overrides it
2933 if ((VariableStoreHeader
[VariableStoreTypeHob
] != NULL
) && (VariableStoreHeader
[VariableStoreTypeNv
] != NULL
) &&
2934 (Variable
.StartPtr
== GetStartPointer (VariableStoreHeader
[VariableStoreTypeNv
]))
2936 VariableInHob
.StartPtr
= GetStartPointer (VariableStoreHeader
[VariableStoreTypeHob
]);
2937 VariableInHob
.EndPtr
= GetEndPointer (VariableStoreHeader
[VariableStoreTypeHob
]);
2938 Status
= FindVariableEx (
2939 GetVariableNamePtr (Variable
.CurrPtr
),
2940 &Variable
.CurrPtr
->VendorGuid
,
2944 if (!EFI_ERROR (Status
)) {
2945 Variable
.CurrPtr
= GetNextVariablePtr (Variable
.CurrPtr
);
2950 VarNameSize
= NameSizeOfVariable (Variable
.CurrPtr
);
2951 ASSERT (VarNameSize
!= 0);
2953 if (VarNameSize
<= *VariableNameSize
) {
2954 CopyMem (VariableName
, GetVariableNamePtr (Variable
.CurrPtr
), VarNameSize
);
2955 CopyMem (VendorGuid
, &Variable
.CurrPtr
->VendorGuid
, sizeof (EFI_GUID
));
2956 Status
= EFI_SUCCESS
;
2958 Status
= EFI_BUFFER_TOO_SMALL
;
2961 *VariableNameSize
= VarNameSize
;
2966 Variable
.CurrPtr
= GetNextVariablePtr (Variable
.CurrPtr
);
2970 ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal
->VariableGlobal
.VariableServicesLock
);
2976 This code sets variable in storage blocks (Volatile or Non-Volatile).
2978 Caution: This function may receive untrusted input.
2979 This function may be invoked in SMM mode, and datasize and data are external input.
2980 This function will do basic validation, before parse the data.
2981 This function will parse the authentication carefully to avoid security issues, like
2982 buffer overflow, integer overflow.
2983 This function will check attribute carefully to avoid authentication bypass.
2985 @param VariableName Name of Variable to be found.
2986 @param VendorGuid Variable vendor GUID.
2987 @param Attributes Attribute value of the variable found
2988 @param DataSize Size of Data found. If size is less than the
2989 data, this value contains the required size.
2990 @param Data Data pointer.
2992 @return EFI_INVALID_PARAMETER Invalid parameter.
2993 @return EFI_SUCCESS Set successfully.
2994 @return EFI_OUT_OF_RESOURCES Resource not enough to set variable.
2995 @return EFI_NOT_FOUND Not found.
2996 @return EFI_WRITE_PROTECTED Variable is read-only.
3001 VariableServiceSetVariable (
3002 IN CHAR16
*VariableName
,
3003 IN EFI_GUID
*VendorGuid
,
3004 IN UINT32 Attributes
,
3009 VARIABLE_POINTER_TRACK Variable
;
3011 VARIABLE_HEADER
*NextVariable
;
3012 EFI_PHYSICAL_ADDRESS Point
;
3015 VARIABLE_ENTRY
*Entry
;
3018 // Check input parameters.
3020 if (VariableName
== NULL
|| VariableName
[0] == 0 || VendorGuid
== NULL
) {
3021 return EFI_INVALID_PARAMETER
;
3024 if (IsReadOnlyVariable (VariableName
, VendorGuid
)) {
3025 return EFI_WRITE_PROTECTED
;
3028 if (DataSize
!= 0 && Data
== NULL
) {
3029 return EFI_INVALID_PARAMETER
;
3033 // Check for reserverd bit in variable attribute.
3035 if ((Attributes
& (~EFI_VARIABLE_ATTRIBUTES_MASK
)) != 0) {
3036 return EFI_INVALID_PARAMETER
;
3040 // Make sure if runtime bit is set, boot service bit is set also.
3042 if ((Attributes
& (EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
)) == EFI_VARIABLE_RUNTIME_ACCESS
) {
3043 return EFI_INVALID_PARAMETER
;
3047 // EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS and EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute
3048 // cannot be set both.
3050 if (((Attributes
& EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
) == EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
)
3051 && ((Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) == EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
)) {
3052 return EFI_INVALID_PARAMETER
;
3055 if ((Attributes
& EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
) == EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
) {
3056 if (DataSize
< AUTHINFO_SIZE
) {
3058 // Try to write Authenticated Variable without AuthInfo.
3060 return EFI_SECURITY_VIOLATION
;
3062 PayloadSize
= DataSize
- AUTHINFO_SIZE
;
3063 } else if ((Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) == EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) {
3065 // Sanity check for EFI_VARIABLE_AUTHENTICATION_2 descriptor.
3067 if (DataSize
< OFFSET_OF_AUTHINFO2_CERT_DATA
||
3068 ((EFI_VARIABLE_AUTHENTICATION_2
*) Data
)->AuthInfo
.Hdr
.dwLength
> DataSize
- (OFFSET_OF (EFI_VARIABLE_AUTHENTICATION_2
, AuthInfo
)) ||
3069 ((EFI_VARIABLE_AUTHENTICATION_2
*) Data
)->AuthInfo
.Hdr
.dwLength
< OFFSET_OF (WIN_CERTIFICATE_UEFI_GUID
, CertData
)) {
3070 return EFI_SECURITY_VIOLATION
;
3072 PayloadSize
= DataSize
- AUTHINFO2_SIZE (Data
);
3074 PayloadSize
= DataSize
;
3077 if ((UINTN
)(~0) - PayloadSize
< StrSize(VariableName
)){
3079 // Prevent whole variable size overflow
3081 return EFI_INVALID_PARAMETER
;
3085 // The size of the VariableName, including the Unicode Null in bytes plus
3086 // the DataSize is limited to maximum size of PcdGet32 (PcdMaxHardwareErrorVariableSize)
3087 // bytes for HwErrRec, and PcdGet32 (PcdMaxVariableSize) bytes for the others.
3089 if ((Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) == EFI_VARIABLE_HARDWARE_ERROR_RECORD
) {
3090 if (StrSize (VariableName
) + PayloadSize
> PcdGet32 (PcdMaxHardwareErrorVariableSize
) - sizeof (VARIABLE_HEADER
)) {
3091 return EFI_INVALID_PARAMETER
;
3093 if (!IsHwErrRecVariable(VariableName
, VendorGuid
)) {
3094 return EFI_INVALID_PARAMETER
;
3098 // The size of the VariableName, including the Unicode Null in bytes plus
3099 // the DataSize is limited to maximum size of PcdGet32 (PcdMaxVariableSize) bytes.
3101 if (StrSize (VariableName
) + PayloadSize
> PcdGet32 (PcdMaxVariableSize
) - sizeof (VARIABLE_HEADER
)) {
3102 return EFI_INVALID_PARAMETER
;
3106 Status
= CheckEfiGlobalVariable (VariableName
, VendorGuid
, Attributes
);
3107 if (EFI_ERROR (Status
)) {
3111 AcquireLockOnlyAtBootTime(&mVariableModuleGlobal
->VariableGlobal
.VariableServicesLock
);
3114 // Consider reentrant in MCA/INIT/NMI. It needs be reupdated.
3116 if (1 < InterlockedIncrement (&mVariableModuleGlobal
->VariableGlobal
.ReentrantState
)) {
3117 Point
= mVariableModuleGlobal
->VariableGlobal
.NonVolatileVariableBase
;
3119 // Parse non-volatile variable data and get last variable offset.
3121 NextVariable
= GetStartPointer ((VARIABLE_STORE_HEADER
*) (UINTN
) Point
);
3122 while ((NextVariable
< GetEndPointer ((VARIABLE_STORE_HEADER
*) (UINTN
) Point
))
3123 && IsValidVariableHeader (NextVariable
)) {
3124 NextVariable
= GetNextVariablePtr (NextVariable
);
3126 mVariableModuleGlobal
->NonVolatileLastVariableOffset
= (UINTN
) NextVariable
- (UINTN
) Point
;
3129 if (mEndOfDxe
&& mEnableLocking
) {
3131 // Treat the variables listed in the forbidden variable list as read-only after leaving DXE phase.
3133 for ( Link
= GetFirstNode (&mLockedVariableList
)
3134 ; !IsNull (&mLockedVariableList
, Link
)
3135 ; Link
= GetNextNode (&mLockedVariableList
, Link
)
3137 Entry
= BASE_CR (Link
, VARIABLE_ENTRY
, Link
);
3138 if (CompareGuid (&Entry
->Guid
, VendorGuid
) && (StrCmp (Entry
->Name
, VariableName
) == 0)) {
3139 Status
= EFI_WRITE_PROTECTED
;
3140 DEBUG ((EFI_D_INFO
, "[Variable]: Changing readonly variable after leaving DXE phase - %g:%s\n", VendorGuid
, VariableName
));
3147 // Check whether the input variable is already existed.
3149 Status
= FindVariable (VariableName
, VendorGuid
, &Variable
, &mVariableModuleGlobal
->VariableGlobal
, TRUE
);
3150 if (!EFI_ERROR (Status
)) {
3151 if (((Variable
.CurrPtr
->Attributes
& EFI_VARIABLE_RUNTIME_ACCESS
) == 0) && AtRuntime ()) {
3152 Status
= EFI_WRITE_PROTECTED
;
3155 if (Attributes
!= 0 && (Attributes
& (~EFI_VARIABLE_APPEND_WRITE
)) != Variable
.CurrPtr
->Attributes
) {
3157 // If a preexisting variable is rewritten with different attributes, SetVariable() shall not
3158 // modify the variable and shall return EFI_INVALID_PARAMETER. Two exceptions to this rule:
3159 // 1. No access attributes specified
3160 // 2. The only attribute differing is EFI_VARIABLE_APPEND_WRITE
3162 Status
= EFI_INVALID_PARAMETER
;
3167 if (!FeaturePcdGet (PcdUefiVariableDefaultLangDeprecate
)) {
3169 // Hook the operation of setting PlatformLangCodes/PlatformLang and LangCodes/Lang.
3171 Status
= AutoUpdateLangVariable (VariableName
, Data
, DataSize
);
3172 if (EFI_ERROR (Status
)) {
3174 // The auto update operation failed, directly return to avoid inconsistency between PlatformLang and Lang.
3181 // Process PK, KEK, Sigdb seperately.
3183 if (CompareGuid (VendorGuid
, &gEfiGlobalVariableGuid
) && (StrCmp (VariableName
, EFI_PLATFORM_KEY_NAME
) == 0)){
3184 Status
= ProcessVarWithPk (VariableName
, VendorGuid
, Data
, DataSize
, &Variable
, Attributes
, TRUE
);
3185 } else if (CompareGuid (VendorGuid
, &gEfiGlobalVariableGuid
) && (StrCmp (VariableName
, EFI_KEY_EXCHANGE_KEY_NAME
) == 0)) {
3186 Status
= ProcessVarWithPk (VariableName
, VendorGuid
, Data
, DataSize
, &Variable
, Attributes
, FALSE
);
3187 } else if (CompareGuid (VendorGuid
, &gEfiImageSecurityDatabaseGuid
) &&
3188 ((StrCmp (VariableName
, EFI_IMAGE_SECURITY_DATABASE
) == 0) || (StrCmp (VariableName
, EFI_IMAGE_SECURITY_DATABASE1
) == 0))) {
3189 Status
= ProcessVarWithPk (VariableName
, VendorGuid
, Data
, DataSize
, &Variable
, Attributes
, FALSE
);
3190 if (EFI_ERROR (Status
)) {
3191 Status
= ProcessVarWithKek (VariableName
, VendorGuid
, Data
, DataSize
, &Variable
, Attributes
);
3194 Status
= ProcessVariable (VariableName
, VendorGuid
, Data
, DataSize
, &Variable
, Attributes
);
3198 InterlockedDecrement (&mVariableModuleGlobal
->VariableGlobal
.ReentrantState
);
3199 ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal
->VariableGlobal
.VariableServicesLock
);
3201 if (!AtRuntime ()) {
3202 if (!EFI_ERROR (Status
)) {
3215 This code returns information about the EFI variables.
3217 Caution: This function may receive untrusted input.
3218 This function may be invoked in SMM mode. This function will do basic validation, before parse the data.
3220 @param Attributes Attributes bitmask to specify the type of variables
3221 on which to return information.
3222 @param MaximumVariableStorageSize Pointer to the maximum size of the storage space available
3223 for the EFI variables associated with the attributes specified.
3224 @param RemainingVariableStorageSize Pointer to the remaining size of the storage space available
3225 for EFI variables associated with the attributes specified.
3226 @param MaximumVariableSize Pointer to the maximum size of an individual EFI variables
3227 associated with the attributes specified.
3229 @return EFI_SUCCESS Query successfully.
3234 VariableServiceQueryVariableInfoInternal (
3235 IN UINT32 Attributes
,
3236 OUT UINT64
*MaximumVariableStorageSize
,
3237 OUT UINT64
*RemainingVariableStorageSize
,
3238 OUT UINT64
*MaximumVariableSize
3241 VARIABLE_HEADER
*Variable
;
3242 VARIABLE_HEADER
*NextVariable
;
3243 UINT64 VariableSize
;
3244 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
3245 UINT64 CommonVariableTotalSize
;
3246 UINT64 HwErrVariableTotalSize
;
3248 VARIABLE_POINTER_TRACK VariablePtrTrack
;
3250 CommonVariableTotalSize
= 0;
3251 HwErrVariableTotalSize
= 0;
3253 if((Attributes
& EFI_VARIABLE_NON_VOLATILE
) == 0) {
3255 // Query is Volatile related.
3257 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*) ((UINTN
) mVariableModuleGlobal
->VariableGlobal
.VolatileVariableBase
);
3260 // Query is Non-Volatile related.
3262 VariableStoreHeader
= mNvVariableCache
;
3266 // Now let's fill *MaximumVariableStorageSize *RemainingVariableStorageSize
3267 // with the storage size (excluding the storage header size).
3269 *MaximumVariableStorageSize
= VariableStoreHeader
->Size
- sizeof (VARIABLE_STORE_HEADER
);
3272 // Harware error record variable needs larger size.
3274 if ((Attributes
& (EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_HARDWARE_ERROR_RECORD
)) == (EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_HARDWARE_ERROR_RECORD
)) {
3275 *MaximumVariableStorageSize
= PcdGet32 (PcdHwErrStorageSize
);
3276 *MaximumVariableSize
= PcdGet32 (PcdMaxHardwareErrorVariableSize
) - sizeof (VARIABLE_HEADER
);
3278 if ((Attributes
& EFI_VARIABLE_NON_VOLATILE
) != 0) {
3279 ASSERT (PcdGet32 (PcdHwErrStorageSize
) < VariableStoreHeader
->Size
);
3280 *MaximumVariableStorageSize
= VariableStoreHeader
->Size
- sizeof (VARIABLE_STORE_HEADER
) - PcdGet32 (PcdHwErrStorageSize
);
3284 // Let *MaximumVariableSize be PcdGet32 (PcdMaxVariableSize) with the exception of the variable header size.
3286 *MaximumVariableSize
= PcdGet32 (PcdMaxVariableSize
) - sizeof (VARIABLE_HEADER
);
3290 // Point to the starting address of the variables.
3292 Variable
= GetStartPointer (VariableStoreHeader
);
3295 // Now walk through the related variable store.
3297 while ((Variable
< GetEndPointer (VariableStoreHeader
)) && IsValidVariableHeader (Variable
)) {
3298 NextVariable
= GetNextVariablePtr (Variable
);
3299 VariableSize
= (UINT64
) (UINTN
) NextVariable
- (UINT64
) (UINTN
) Variable
;
3303 // We don't take the state of the variables in mind
3304 // when calculating RemainingVariableStorageSize,
3305 // since the space occupied by variables not marked with
3306 // VAR_ADDED is not allowed to be reclaimed in Runtime.
3308 if ((Variable
->Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) == EFI_VARIABLE_HARDWARE_ERROR_RECORD
) {
3309 HwErrVariableTotalSize
+= VariableSize
;
3311 CommonVariableTotalSize
+= VariableSize
;
3315 // Only care about Variables with State VAR_ADDED, because
3316 // the space not marked as VAR_ADDED is reclaimable now.
3318 if (Variable
->State
== VAR_ADDED
) {
3319 if ((Variable
->Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) == EFI_VARIABLE_HARDWARE_ERROR_RECORD
) {
3320 HwErrVariableTotalSize
+= VariableSize
;
3322 CommonVariableTotalSize
+= VariableSize
;
3324 } else if (Variable
->State
== (VAR_IN_DELETED_TRANSITION
& VAR_ADDED
)) {
3326 // If it is a IN_DELETED_TRANSITION variable,
3327 // and there is not also a same ADDED one at the same time,
3328 // this IN_DELETED_TRANSITION variable is valid.
3330 VariablePtrTrack
.StartPtr
= GetStartPointer (VariableStoreHeader
);
3331 VariablePtrTrack
.EndPtr
= GetEndPointer (VariableStoreHeader
);
3332 Status
= FindVariableEx (
3333 GetVariableNamePtr (Variable
),
3334 &Variable
->VendorGuid
,
3338 if (!EFI_ERROR (Status
) && VariablePtrTrack
.CurrPtr
->State
!= VAR_ADDED
) {
3339 if ((Variable
->Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) == EFI_VARIABLE_HARDWARE_ERROR_RECORD
) {
3340 HwErrVariableTotalSize
+= VariableSize
;
3342 CommonVariableTotalSize
+= VariableSize
;
3349 // Go to the next one.
3351 Variable
= NextVariable
;
3354 if ((Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
) == EFI_VARIABLE_HARDWARE_ERROR_RECORD
){
3355 *RemainingVariableStorageSize
= *MaximumVariableStorageSize
- HwErrVariableTotalSize
;
3357 *RemainingVariableStorageSize
= *MaximumVariableStorageSize
- CommonVariableTotalSize
;
3360 if (*RemainingVariableStorageSize
< sizeof (VARIABLE_HEADER
)) {
3361 *MaximumVariableSize
= 0;
3362 } else if ((*RemainingVariableStorageSize
- sizeof (VARIABLE_HEADER
)) < *MaximumVariableSize
) {
3363 *MaximumVariableSize
= *RemainingVariableStorageSize
- sizeof (VARIABLE_HEADER
);
3371 This code returns information about the EFI variables.
3373 Caution: This function may receive untrusted input.
3374 This function may be invoked in SMM mode. This function will do basic validation, before parse the data.
3376 @param Attributes Attributes bitmask to specify the type of variables
3377 on which to return information.
3378 @param MaximumVariableStorageSize Pointer to the maximum size of the storage space available
3379 for the EFI variables associated with the attributes specified.
3380 @param RemainingVariableStorageSize Pointer to the remaining size of the storage space available
3381 for EFI variables associated with the attributes specified.
3382 @param MaximumVariableSize Pointer to the maximum size of an individual EFI variables
3383 associated with the attributes specified.
3385 @return EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.
3386 @return EFI_SUCCESS Query successfully.
3387 @return EFI_UNSUPPORTED The attribute is not supported on this platform.
3392 VariableServiceQueryVariableInfo (
3393 IN UINT32 Attributes
,
3394 OUT UINT64
*MaximumVariableStorageSize
,
3395 OUT UINT64
*RemainingVariableStorageSize
,
3396 OUT UINT64
*MaximumVariableSize
3401 if(MaximumVariableStorageSize
== NULL
|| RemainingVariableStorageSize
== NULL
|| MaximumVariableSize
== NULL
|| Attributes
== 0) {
3402 return EFI_INVALID_PARAMETER
;
3405 if((Attributes
& (EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_HARDWARE_ERROR_RECORD
)) == 0) {
3407 // Make sure the Attributes combination is supported by the platform.
3409 return EFI_UNSUPPORTED
;
3410 } else if ((Attributes
& (EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
)) == EFI_VARIABLE_RUNTIME_ACCESS
) {
3412 // Make sure if runtime bit is set, boot service bit is set also.
3414 return EFI_INVALID_PARAMETER
;
3415 } else if (AtRuntime () && ((Attributes
& EFI_VARIABLE_RUNTIME_ACCESS
) == 0)) {
3417 // Make sure RT Attribute is set if we are in Runtime phase.
3419 return EFI_INVALID_PARAMETER
;
3420 } else if ((Attributes
& (EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_HARDWARE_ERROR_RECORD
)) == EFI_VARIABLE_HARDWARE_ERROR_RECORD
) {
3422 // Make sure Hw Attribute is set with NV.
3424 return EFI_INVALID_PARAMETER
;
3427 AcquireLockOnlyAtBootTime(&mVariableModuleGlobal
->VariableGlobal
.VariableServicesLock
);
3429 Status
= VariableServiceQueryVariableInfoInternal (
3431 MaximumVariableStorageSize
,
3432 RemainingVariableStorageSize
,
3436 ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal
->VariableGlobal
.VariableServicesLock
);
3441 This function reclaims variable storage if free size is below the threshold.
3443 Caution: This function may be invoked at SMM mode.
3444 Care must be taken to make sure not security issue.
3453 UINTN CommonVariableSpace
;
3454 UINTN RemainingCommonVariableSpace
;
3455 UINTN RemainingHwErrVariableSpace
;
3457 Status
= EFI_SUCCESS
;
3459 CommonVariableSpace
= ((VARIABLE_STORE_HEADER
*) ((UINTN
) (mVariableModuleGlobal
->VariableGlobal
.NonVolatileVariableBase
)))->Size
- sizeof (VARIABLE_STORE_HEADER
) - PcdGet32(PcdHwErrStorageSize
); //Allowable max size of common variable storage space
3461 RemainingCommonVariableSpace
= CommonVariableSpace
- mVariableModuleGlobal
->CommonVariableTotalSize
;
3463 RemainingHwErrVariableSpace
= PcdGet32 (PcdHwErrStorageSize
) - mVariableModuleGlobal
->HwErrVariableTotalSize
;
3465 // Check if the free area is blow a threshold.
3467 if ((RemainingCommonVariableSpace
< PcdGet32 (PcdMaxVariableSize
))
3468 || ((PcdGet32 (PcdHwErrStorageSize
) != 0) &&
3469 (RemainingHwErrVariableSpace
< PcdGet32 (PcdMaxHardwareErrorVariableSize
)))){
3471 mVariableModuleGlobal
->VariableGlobal
.NonVolatileVariableBase
,
3472 &mVariableModuleGlobal
->NonVolatileLastVariableOffset
,
3479 ASSERT_EFI_ERROR (Status
);
3484 Init non-volatile variable store.
3486 @retval EFI_SUCCESS Function successfully executed.
3487 @retval EFI_OUT_OF_RESOURCES Fail to allocate enough memory resource.
3488 @retval EFI_VOLUME_CORRUPTED Variable Store or Firmware Volume for Variable Store is corrupted.
3492 InitNonVolatileVariableStore (
3496 EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
;
3497 VARIABLE_HEADER
*NextVariable
;
3498 EFI_PHYSICAL_ADDRESS VariableStoreBase
;
3499 UINT64 VariableStoreLength
;
3501 EFI_HOB_GUID_TYPE
*GuidHob
;
3502 EFI_PHYSICAL_ADDRESS NvStorageBase
;
3503 UINT8
*NvStorageData
;
3504 UINT32 NvStorageSize
;
3505 FAULT_TOLERANT_WRITE_LAST_WRITE_DATA
*FtwLastWriteData
;
3506 UINT32 BackUpOffset
;
3509 mVariableModuleGlobal
->FvbInstance
= NULL
;
3512 // Note that in EdkII variable driver implementation, Hardware Error Record type variable
3513 // is stored with common variable in the same NV region. So the platform integrator should
3514 // ensure that the value of PcdHwErrStorageSize is less than or equal to the value of
3515 // PcdFlashNvStorageVariableSize.
3517 ASSERT (PcdGet32 (PcdHwErrStorageSize
) <= PcdGet32 (PcdFlashNvStorageVariableSize
));
3520 // Allocate runtime memory used for a memory copy of the FLASH region.
3521 // Keep the memory and the FLASH in sync as updates occur.
3523 NvStorageSize
= PcdGet32 (PcdFlashNvStorageVariableSize
);
3524 NvStorageData
= AllocateRuntimeZeroPool (NvStorageSize
);
3525 if (NvStorageData
== NULL
) {
3526 return EFI_OUT_OF_RESOURCES
;
3529 NvStorageBase
= (EFI_PHYSICAL_ADDRESS
) PcdGet64 (PcdFlashNvStorageVariableBase64
);
3530 if (NvStorageBase
== 0) {
3531 NvStorageBase
= (EFI_PHYSICAL_ADDRESS
) PcdGet32 (PcdFlashNvStorageVariableBase
);
3534 // Copy NV storage data to the memory buffer.
3536 CopyMem (NvStorageData
, (UINT8
*) (UINTN
) NvStorageBase
, NvStorageSize
);
3539 // Check the FTW last write data hob.
3541 GuidHob
= GetFirstGuidHob (&gEdkiiFaultTolerantWriteGuid
);
3542 if (GuidHob
!= NULL
) {
3543 FtwLastWriteData
= (FAULT_TOLERANT_WRITE_LAST_WRITE_DATA
*) GET_GUID_HOB_DATA (GuidHob
);
3544 if (FtwLastWriteData
->TargetAddress
== NvStorageBase
) {
3545 DEBUG ((EFI_D_INFO
, "Variable: NV storage is backed up in spare block: 0x%x\n", (UINTN
) FtwLastWriteData
->SpareAddress
));
3547 // Copy the backed up NV storage data to the memory buffer from spare block.
3549 CopyMem (NvStorageData
, (UINT8
*) (UINTN
) (FtwLastWriteData
->SpareAddress
), NvStorageSize
);
3550 } else if ((FtwLastWriteData
->TargetAddress
> NvStorageBase
) &&
3551 (FtwLastWriteData
->TargetAddress
< (NvStorageBase
+ NvStorageSize
))) {
3553 // Flash NV storage from the Offset is backed up in spare block.
3555 BackUpOffset
= (UINT32
) (FtwLastWriteData
->TargetAddress
- NvStorageBase
);
3556 BackUpSize
= NvStorageSize
- BackUpOffset
;
3557 DEBUG ((EFI_D_INFO
, "Variable: High partial NV storage from offset: %x is backed up in spare block: 0x%x\n", BackUpOffset
, (UINTN
) FtwLastWriteData
->SpareAddress
));
3559 // Copy the partial backed up NV storage data to the memory buffer from spare block.
3561 CopyMem (NvStorageData
+ BackUpOffset
, (UINT8
*) (UINTN
) FtwLastWriteData
->SpareAddress
, BackUpSize
);
3565 FvHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*) NvStorageData
;
3568 // Check if the Firmware Volume is not corrupted
3570 if ((FvHeader
->Signature
!= EFI_FVH_SIGNATURE
) || (!CompareGuid (&gEfiSystemNvDataFvGuid
, &FvHeader
->FileSystemGuid
))) {
3571 FreePool (NvStorageData
);
3572 DEBUG ((EFI_D_ERROR
, "Firmware Volume for Variable Store is corrupted\n"));
3573 return EFI_VOLUME_CORRUPTED
;
3576 VariableStoreBase
= (EFI_PHYSICAL_ADDRESS
) ((UINTN
) FvHeader
+ FvHeader
->HeaderLength
);
3577 VariableStoreLength
= (UINT64
) (NvStorageSize
- FvHeader
->HeaderLength
);
3579 mVariableModuleGlobal
->VariableGlobal
.NonVolatileVariableBase
= VariableStoreBase
;
3580 mNvVariableCache
= (VARIABLE_STORE_HEADER
*) (UINTN
) VariableStoreBase
;
3581 if (GetVariableStoreStatus (mNvVariableCache
) != EfiValid
) {
3582 FreePool (NvStorageData
);
3583 DEBUG((EFI_D_ERROR
, "Variable Store header is corrupted\n"));
3584 return EFI_VOLUME_CORRUPTED
;
3586 ASSERT(mNvVariableCache
->Size
== VariableStoreLength
);
3589 // The max variable or hardware error variable size should be < variable store size.
3591 ASSERT(MAX (PcdGet32 (PcdMaxVariableSize
), PcdGet32 (PcdMaxHardwareErrorVariableSize
)) < VariableStoreLength
);
3594 // Parse non-volatile variable data and get last variable offset.
3596 NextVariable
= GetStartPointer ((VARIABLE_STORE_HEADER
*)(UINTN
)VariableStoreBase
);
3597 while (IsValidVariableHeader (NextVariable
)) {
3598 VariableSize
= NextVariable
->NameSize
+ NextVariable
->DataSize
+ sizeof (VARIABLE_HEADER
);
3599 if ((NextVariable
->Attributes
& (EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_HARDWARE_ERROR_RECORD
)) == (EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_HARDWARE_ERROR_RECORD
)) {
3600 mVariableModuleGlobal
->HwErrVariableTotalSize
+= HEADER_ALIGN (VariableSize
);
3602 mVariableModuleGlobal
->CommonVariableTotalSize
+= HEADER_ALIGN (VariableSize
);
3605 NextVariable
= GetNextVariablePtr (NextVariable
);
3607 mVariableModuleGlobal
->NonVolatileLastVariableOffset
= (UINTN
) NextVariable
- (UINTN
) VariableStoreBase
;
3613 Flush the HOB variable to flash.
3615 @param[in] VariableName Name of variable has been updated or deleted.
3616 @param[in] VendorGuid Guid of variable has been updated or deleted.
3620 FlushHobVariableToFlash (
3621 IN CHAR16
*VariableName
,
3622 IN EFI_GUID
*VendorGuid
3626 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
3627 VARIABLE_HEADER
*Variable
;
3634 // Flush the HOB variable to flash.
3636 if (mVariableModuleGlobal
->VariableGlobal
.HobVariableBase
!= 0) {
3637 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*) (UINTN
) mVariableModuleGlobal
->VariableGlobal
.HobVariableBase
;
3639 // Set HobVariableBase to 0, it can avoid SetVariable to call back.
3641 mVariableModuleGlobal
->VariableGlobal
.HobVariableBase
= 0;
3642 for ( Variable
= GetStartPointer (VariableStoreHeader
)
3643 ; (Variable
< GetEndPointer (VariableStoreHeader
) && IsValidVariableHeader (Variable
))
3644 ; Variable
= GetNextVariablePtr (Variable
)
3646 if (Variable
->State
!= VAR_ADDED
) {
3648 // The HOB variable has been set to DELETED state in local.
3652 ASSERT ((Variable
->Attributes
& EFI_VARIABLE_NON_VOLATILE
) != 0);
3653 if (VendorGuid
== NULL
|| VariableName
== NULL
||
3654 !CompareGuid (VendorGuid
, &Variable
->VendorGuid
) ||
3655 StrCmp (VariableName
, GetVariableNamePtr (Variable
)) != 0) {
3656 VariableData
= GetVariableDataPtr (Variable
);
3657 Status
= VariableServiceSetVariable (
3658 GetVariableNamePtr (Variable
),
3659 &Variable
->VendorGuid
,
3660 Variable
->Attributes
,
3664 DEBUG ((EFI_D_INFO
, "Variable driver flush the HOB variable to flash: %g %s %r\n", &Variable
->VendorGuid
, GetVariableNamePtr (Variable
), Status
));
3667 // The updated or deleted variable is matched with the HOB variable.
3668 // Don't break here because we will try to set other HOB variables
3669 // since this variable could be set successfully.
3671 Status
= EFI_SUCCESS
;
3673 if (!EFI_ERROR (Status
)) {
3675 // If set variable successful, or the updated or deleted variable is matched with the HOB variable,
3676 // set the HOB variable to DELETED state in local.
3678 DEBUG ((EFI_D_INFO
, "Variable driver set the HOB variable to DELETED state in local: %g %s\n", &Variable
->VendorGuid
, GetVariableNamePtr (Variable
)));
3679 Variable
->State
&= VAR_DELETED
;
3686 // We still have HOB variable(s) not flushed in flash.
3688 mVariableModuleGlobal
->VariableGlobal
.HobVariableBase
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) VariableStoreHeader
;
3691 // All HOB variables have been flushed in flash.
3693 DEBUG ((EFI_D_INFO
, "Variable driver: all HOB variables have been flushed in flash.\n"));
3694 if (!AtRuntime ()) {
3695 FreePool ((VOID
*) VariableStoreHeader
);
3703 Initializes variable write service after FTW was ready.
3705 @retval EFI_SUCCESS Function successfully executed.
3706 @retval Others Fail to initialize the variable service.
3710 VariableWriteServiceInitialize (
3715 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
3718 EFI_PHYSICAL_ADDRESS VariableStoreBase
;
3719 EFI_PHYSICAL_ADDRESS NvStorageBase
;
3721 NvStorageBase
= (EFI_PHYSICAL_ADDRESS
) PcdGet64 (PcdFlashNvStorageVariableBase64
);
3722 if (NvStorageBase
== 0) {
3723 NvStorageBase
= (EFI_PHYSICAL_ADDRESS
) PcdGet32 (PcdFlashNvStorageVariableBase
);
3725 VariableStoreBase
= NvStorageBase
+ (((EFI_FIRMWARE_VOLUME_HEADER
*)(UINTN
)(NvStorageBase
))->HeaderLength
);
3728 // Let NonVolatileVariableBase point to flash variable store base directly after FTW ready.
3730 mVariableModuleGlobal
->VariableGlobal
.NonVolatileVariableBase
= VariableStoreBase
;
3731 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*)(UINTN
)VariableStoreBase
;
3734 // Check if the free area is really free.
3736 for (Index
= mVariableModuleGlobal
->NonVolatileLastVariableOffset
; Index
< VariableStoreHeader
->Size
; Index
++) {
3737 Data
= ((UINT8
*) mNvVariableCache
)[Index
];
3740 // There must be something wrong in variable store, do reclaim operation.
3743 mVariableModuleGlobal
->VariableGlobal
.NonVolatileVariableBase
,
3744 &mVariableModuleGlobal
->NonVolatileLastVariableOffset
,
3751 if (EFI_ERROR (Status
)) {
3758 FlushHobVariableToFlash (NULL
, NULL
);
3761 // Authenticated variable initialize.
3763 Status
= AutenticatedVariableServiceInitialize ();
3770 Initializes variable store area for non-volatile and volatile variable.
3772 @retval EFI_SUCCESS Function successfully executed.
3773 @retval EFI_OUT_OF_RESOURCES Fail to allocate enough memory resource.
3777 VariableCommonInitialize (
3782 VARIABLE_STORE_HEADER
*VolatileVariableStore
;
3783 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
3784 UINT64 VariableStoreLength
;
3786 EFI_HOB_GUID_TYPE
*GuidHob
;
3789 // Allocate runtime memory for variable driver global structure.
3791 mVariableModuleGlobal
= AllocateRuntimeZeroPool (sizeof (VARIABLE_MODULE_GLOBAL
));
3792 if (mVariableModuleGlobal
== NULL
) {
3793 return EFI_OUT_OF_RESOURCES
;
3796 InitializeLock (&mVariableModuleGlobal
->VariableGlobal
.VariableServicesLock
, TPL_NOTIFY
);
3799 // Get HOB variable store.
3801 GuidHob
= GetFirstGuidHob (&gEfiAuthenticatedVariableGuid
);
3802 if (GuidHob
!= NULL
) {
3803 VariableStoreHeader
= GET_GUID_HOB_DATA (GuidHob
);
3804 VariableStoreLength
= (UINT64
) (GuidHob
->Header
.HobLength
- sizeof (EFI_HOB_GUID_TYPE
));
3805 if (GetVariableStoreStatus (VariableStoreHeader
) == EfiValid
) {
3806 mVariableModuleGlobal
->VariableGlobal
.HobVariableBase
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) AllocateRuntimeCopyPool ((UINTN
) VariableStoreLength
, (VOID
*) VariableStoreHeader
);
3807 if (mVariableModuleGlobal
->VariableGlobal
.HobVariableBase
== 0) {
3808 FreePool (mVariableModuleGlobal
);
3809 return EFI_OUT_OF_RESOURCES
;
3812 DEBUG ((EFI_D_ERROR
, "HOB Variable Store header is corrupted!\n"));
3817 // Allocate memory for volatile variable store, note that there is a scratch space to store scratch data.
3819 ScratchSize
= MAX (PcdGet32 (PcdMaxVariableSize
), PcdGet32 (PcdMaxHardwareErrorVariableSize
));
3820 VolatileVariableStore
= AllocateRuntimePool (PcdGet32 (PcdVariableStoreSize
) + ScratchSize
);
3821 if (VolatileVariableStore
== NULL
) {
3822 if (mVariableModuleGlobal
->VariableGlobal
.HobVariableBase
!= 0) {
3823 FreePool ((VOID
*) (UINTN
) mVariableModuleGlobal
->VariableGlobal
.HobVariableBase
);
3825 FreePool (mVariableModuleGlobal
);
3826 return EFI_OUT_OF_RESOURCES
;
3829 SetMem (VolatileVariableStore
, PcdGet32 (PcdVariableStoreSize
) + ScratchSize
, 0xff);
3832 // Initialize Variable Specific Data.
3834 mVariableModuleGlobal
->VariableGlobal
.VolatileVariableBase
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) VolatileVariableStore
;
3835 mVariableModuleGlobal
->VolatileLastVariableOffset
= (UINTN
) GetStartPointer (VolatileVariableStore
) - (UINTN
) VolatileVariableStore
;
3837 CopyGuid (&VolatileVariableStore
->Signature
, &gEfiAuthenticatedVariableGuid
);
3838 VolatileVariableStore
->Size
= PcdGet32 (PcdVariableStoreSize
);
3839 VolatileVariableStore
->Format
= VARIABLE_STORE_FORMATTED
;
3840 VolatileVariableStore
->State
= VARIABLE_STORE_HEALTHY
;
3841 VolatileVariableStore
->Reserved
= 0;
3842 VolatileVariableStore
->Reserved1
= 0;
3845 // Init non-volatile variable store.
3847 Status
= InitNonVolatileVariableStore ();
3848 if (EFI_ERROR (Status
)) {
3849 if (mVariableModuleGlobal
->VariableGlobal
.HobVariableBase
!= 0) {
3850 FreePool ((VOID
*) (UINTN
) mVariableModuleGlobal
->VariableGlobal
.HobVariableBase
);
3852 FreePool (mVariableModuleGlobal
);
3853 FreePool (VolatileVariableStore
);
3861 Get the proper fvb handle and/or fvb protocol by the given Flash address.
3863 @param[in] Address The Flash address.
3864 @param[out] FvbHandle In output, if it is not NULL, it points to the proper FVB handle.
3865 @param[out] FvbProtocol In output, if it is not NULL, it points to the proper FVB protocol.
3869 GetFvbInfoByAddress (
3870 IN EFI_PHYSICAL_ADDRESS Address
,
3871 OUT EFI_HANDLE
*FvbHandle OPTIONAL
,
3872 OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
**FvbProtocol OPTIONAL
3876 EFI_HANDLE
*HandleBuffer
;
3879 EFI_PHYSICAL_ADDRESS FvbBaseAddress
;
3880 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*Fvb
;
3881 EFI_FIRMWARE_VOLUME_HEADER
*FwVolHeader
;
3882 EFI_FVB_ATTRIBUTES_2 Attributes
;
3885 // Get all FVB handles.
3887 Status
= GetFvbCountAndBuffer (&HandleCount
, &HandleBuffer
);
3888 if (EFI_ERROR (Status
)) {
3889 return EFI_NOT_FOUND
;
3893 // Get the FVB to access variable store.
3896 for (Index
= 0; Index
< HandleCount
; Index
+= 1, Status
= EFI_NOT_FOUND
, Fvb
= NULL
) {
3897 Status
= GetFvbByHandle (HandleBuffer
[Index
], &Fvb
);
3898 if (EFI_ERROR (Status
)) {
3899 Status
= EFI_NOT_FOUND
;
3904 // Ensure this FVB protocol supported Write operation.
3906 Status
= Fvb
->GetAttributes (Fvb
, &Attributes
);
3907 if (EFI_ERROR (Status
) || ((Attributes
& EFI_FVB2_WRITE_STATUS
) == 0)) {
3912 // Compare the address and select the right one.
3914 Status
= Fvb
->GetPhysicalAddress (Fvb
, &FvbBaseAddress
);
3915 if (EFI_ERROR (Status
)) {
3919 FwVolHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*) ((UINTN
) FvbBaseAddress
);
3920 if ((Address
>= FvbBaseAddress
) && (Address
< (FvbBaseAddress
+ FwVolHeader
->FvLength
))) {
3921 if (FvbHandle
!= NULL
) {
3922 *FvbHandle
= HandleBuffer
[Index
];
3924 if (FvbProtocol
!= NULL
) {
3927 Status
= EFI_SUCCESS
;
3931 FreePool (HandleBuffer
);
3934 Status
= EFI_NOT_FOUND
;