3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
26 // Don't use module globals after the SetVirtualAddress map is signaled
28 ESAL_VARIABLE_GLOBAL
*mVariableModuleGlobal
;
39 Determine the length of null terminated char16 array.
43 String Null-terminated CHAR16 array pointer.
47 UINT32 Number of bytes in the string, including the double NULL at the end;
59 while (0 != String
[Count
]) {
63 return (Count
* 2) + 2;
68 IsValidVariableHeader (
69 IN VARIABLE_HEADER
*Variable
75 This code checks if variable header is valid or not.
78 Variable Pointer to the Variable Header.
81 TRUE Variable header is valid.
82 FALSE Variable header is not valid.
86 if (Variable
== NULL
||
87 Variable
->StartId
!= VARIABLE_DATA
||
88 (sizeof (VARIABLE_HEADER
) + Variable
->NameSize
+ Variable
->DataSize
) > MAX_VARIABLE_SIZE
99 IN VARIABLE_GLOBAL
*Global
,
101 IN BOOLEAN SetByIndex
,
103 IN UINTN DataPtrIndex
,
111 This function writes data to the FWH at the correct LBA even if the LBAs
116 Global Pointer to VARAIBLE_GLOBAL structure
117 Volatile If the Variable is Volatile or Non-Volatile
118 SetByIndex TRUE: Target pointer is given as index
119 FALSE: Target pointer is absolute
120 Instance Instance of FV Block services
121 DataPtrIndex Pointer to the Data from the end of VARIABLE_STORE_HEADER
123 DataSize Size of data to be written.
124 Buffer Pointer to the buffer from which data is written
132 EFI_FV_BLOCK_MAP_ENTRY
*PtrBlockMapEntry
;
140 EFI_FIRMWARE_VOLUME_HEADER
*FwVolHeader
;
141 VARIABLE_STORE_HEADER
*VolatileBase
;
142 EFI_PHYSICAL_ADDRESS FvVolHdr
;
143 EFI_PHYSICAL_ADDRESS DataPtr
;
147 DataPtr
= DataPtrIndex
;
150 // Check if the Data is Volatile
153 EfiFvbGetPhysicalAddress (Instance
, &FvVolHdr
);
154 FwVolHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*) ((UINTN
) FvVolHdr
);
156 // Data Pointer should point to the actual Address where data is to be
160 DataPtr
+= Global
->NonVolatileVariableBase
;
163 if ((DataPtr
+ DataSize
) >= ((EFI_PHYSICAL_ADDRESS
) (UINTN
) ((UINT8
*) FwVolHeader
+ FwVolHeader
->FvLength
))) {
164 return EFI_INVALID_PARAMETER
;
168 // Data Pointer should point to the actual Address where data is to be
171 VolatileBase
= (VARIABLE_STORE_HEADER
*) ((UINTN
) Global
->VolatileVariableBase
);
173 DataPtr
+= Global
->VolatileVariableBase
;
176 if ((DataPtr
+ DataSize
) >= ((UINTN
) ((UINT8
*) VolatileBase
+ VolatileBase
->Size
))) {
177 return EFI_INVALID_PARAMETER
;
181 // If Volatile Variable just do a simple mem copy.
184 CopyMem ((UINT8
*) ((UINTN
) DataPtr
), Buffer
, DataSize
);
188 // If we are here we are dealing with Non-Volatile Variables
190 LinearOffset
= (UINTN
) FwVolHeader
;
191 CurrWritePtr
= (UINTN
) DataPtr
;
192 CurrWriteSize
= DataSize
;
196 if (CurrWritePtr
< LinearOffset
) {
197 return EFI_INVALID_PARAMETER
;
200 for (PtrBlockMapEntry
= FwVolHeader
->FvBlockMap
; PtrBlockMapEntry
->NumBlocks
!= 0; PtrBlockMapEntry
++) {
201 for (BlockIndex2
= 0; BlockIndex2
< PtrBlockMapEntry
->NumBlocks
; BlockIndex2
++) {
203 // Check to see if the Variable Writes are spanning through multiple
206 if ((CurrWritePtr
>= LinearOffset
) && (CurrWritePtr
< LinearOffset
+ PtrBlockMapEntry
->BlockLength
)) {
207 if ((CurrWritePtr
+ CurrWriteSize
) <= (LinearOffset
+ PtrBlockMapEntry
->BlockLength
)) {
208 Status
= EfiFvbWriteBlock (
211 (UINTN
) (CurrWritePtr
- LinearOffset
),
215 if (EFI_ERROR (Status
)) {
219 Size
= (UINT32
) (LinearOffset
+ PtrBlockMapEntry
->BlockLength
- CurrWritePtr
);
220 Status
= EfiFvbWriteBlock (
223 (UINTN
) (CurrWritePtr
- LinearOffset
),
227 if (EFI_ERROR (Status
)) {
231 CurrWritePtr
= LinearOffset
+ PtrBlockMapEntry
->BlockLength
;
232 CurrBuffer
= CurrBuffer
+ Size
;
233 CurrWriteSize
= CurrWriteSize
- Size
;
237 LinearOffset
+= PtrBlockMapEntry
->BlockLength
;
245 VARIABLE_STORE_STATUS
247 GetVariableStoreStatus (
248 IN VARIABLE_STORE_HEADER
*VarStoreHeader
254 This code gets the current status of Variable Store.
258 VarStoreHeader Pointer to the Variable Store Header.
262 EfiRaw Variable store status is raw
263 EfiValid Variable store status is valid
264 EfiInvalid Variable store status is invalid
268 if (VarStoreHeader
->Signature
== VARIABLE_STORE_SIGNATURE
&&
269 VarStoreHeader
->Format
== VARIABLE_STORE_FORMATTED
&&
270 VarStoreHeader
->State
== VARIABLE_STORE_HEALTHY
274 } else if (VarStoreHeader
->Signature
== 0xffffffff &&
275 VarStoreHeader
->Size
== 0xffffffff &&
276 VarStoreHeader
->Format
== 0xff &&
277 VarStoreHeader
->State
== 0xff
289 IN VARIABLE_HEADER
*Variable
295 This code gets the pointer to the variable data.
299 Variable Pointer to the Variable Header.
303 UINT8* Pointer to Variable Data
308 // Be careful about pad size for alignment
310 return (UINT8
*) ((UINTN
) GET_VARIABLE_NAME_PTR (Variable
) + Variable
->NameSize
+ GET_PAD_SIZE (Variable
->NameSize
));
316 IN VARIABLE_HEADER
*Variable
322 This code gets the pointer to the next variable header.
326 Variable Pointer to the Variable Header.
330 VARIABLE_HEADER* Pointer to next variable header.
334 if (!IsValidVariableHeader (Variable
)) {
338 // Be careful about pad size for alignment
340 return (VARIABLE_HEADER
*) ((UINTN
) GetVariableDataPtr (Variable
) + Variable
->DataSize
+ GET_PAD_SIZE (Variable
->DataSize
));
346 IN VARIABLE_STORE_HEADER
*VarStoreHeader
352 This code gets the pointer to the last variable memory pointer byte
356 VarStoreHeader Pointer to the Variable Store Header.
360 VARIABLE_HEADER* Pointer to last unavailable Variable Header
365 // The end of variable store
367 return (VARIABLE_HEADER
*) ((UINTN
) VarStoreHeader
+ VarStoreHeader
->Size
);
373 IN EFI_PHYSICAL_ADDRESS VariableBase
,
374 OUT UINTN
*LastVariableOffset
,
375 IN BOOLEAN IsVolatile
381 Variable store garbage collection and reclaim operation
385 VariableBase Base address of variable store
386 LastVariableOffset Offset of last variable
387 IsVolatile The variable store is volatile or not,
388 if it is non-volatile, need FTW
396 VARIABLE_HEADER
*Variable
;
397 VARIABLE_HEADER
*NextVariable
;
398 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
400 UINTN ValidBufferSize
;
405 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*) ((UINTN
) VariableBase
);
408 // Start Pointers for the variable.
410 Variable
= (VARIABLE_HEADER
*) (VariableStoreHeader
+ 1);
412 ValidBufferSize
= sizeof (VARIABLE_STORE_HEADER
);
414 while (IsValidVariableHeader (Variable
)) {
415 NextVariable
= GetNextVariablePtr (Variable
);
416 if (Variable
->State
== VAR_ADDED
) {
417 VariableSize
= (UINTN
) NextVariable
- (UINTN
) Variable
;
418 ValidBufferSize
+= VariableSize
;
421 Variable
= NextVariable
;
424 Status
= gBS
->AllocatePool (
427 (VOID
**) &ValidBuffer
429 if (EFI_ERROR (Status
)) {
433 SetMem (ValidBuffer
, ValidBufferSize
, 0xff);
435 CurrPtr
= ValidBuffer
;
438 // Copy variable store header
440 CopyMem (CurrPtr
, VariableStoreHeader
, sizeof (VARIABLE_STORE_HEADER
));
441 CurrPtr
+= sizeof (VARIABLE_STORE_HEADER
);
444 // Start Pointers for the variable.
446 Variable
= (VARIABLE_HEADER
*) (VariableStoreHeader
+ 1);
448 while (IsValidVariableHeader (Variable
)) {
449 NextVariable
= GetNextVariablePtr (Variable
);
450 if (Variable
->State
== VAR_ADDED
) {
451 VariableSize
= (UINTN
) NextVariable
- (UINTN
) Variable
;
452 CopyMem (CurrPtr
, (UINT8
*) Variable
, VariableSize
);
453 CurrPtr
+= VariableSize
;
456 Variable
= NextVariable
;
461 // If volatile variable store, just copy valid buffer
463 SetMem ((UINT8
*) (UINTN
) VariableBase
, VariableStoreHeader
->Size
, 0xff);
464 CopyMem ((UINT8
*) (UINTN
) VariableBase
, ValidBuffer
, ValidBufferSize
);
465 *LastVariableOffset
= ValidBufferSize
;
466 Status
= EFI_SUCCESS
;
469 // If non-volatile variable store, perform FTW here.
471 Status
= FtwVariableSpace (
476 if (!EFI_ERROR (Status
)) {
477 *LastVariableOffset
= ValidBufferSize
;
481 gBS
->FreePool (ValidBuffer
);
483 if (EFI_ERROR (Status
)) {
484 *LastVariableOffset
= 0;
493 IN CHAR16
*VariableName
,
494 IN EFI_GUID
*VendorGuid
,
495 OUT VARIABLE_POINTER_TRACK
*PtrTrack
,
496 IN VARIABLE_GLOBAL
*Global
502 This code finds variable in storage blocks (Volatile or Non-Volatile)
506 VariableName Name of the variable to be found
507 VendorGuid Vendor GUID to be found.
508 PtrTrack Variable Track Pointer structure that contains
509 Variable Information.
510 Contains the pointer of Variable header.
511 Global VARIABLE_GLOBAL pointer
519 VARIABLE_HEADER
*Variable
[2];
520 VARIABLE_STORE_HEADER
*VariableStoreHeader
[2];
524 // 0: Non-Volatile, 1: Volatile
526 VariableStoreHeader
[0] = (VARIABLE_STORE_HEADER
*) ((UINTN
) Global
->NonVolatileVariableBase
);
527 VariableStoreHeader
[1] = (VARIABLE_STORE_HEADER
*) ((UINTN
) Global
->VolatileVariableBase
);
530 // Start Pointers for the variable.
531 // Actual Data Pointer where data can be written.
533 Variable
[0] = (VARIABLE_HEADER
*) (VariableStoreHeader
[0] + 1);
534 Variable
[1] = (VARIABLE_HEADER
*) (VariableStoreHeader
[1] + 1);
536 if (VariableName
[0] != 0 && VendorGuid
== NULL
) {
537 return EFI_INVALID_PARAMETER
;
540 // Find the variable by walk through non-volatile and volatile variable store
542 for (Index
= 0; Index
< 2; Index
++) {
543 PtrTrack
->StartPtr
= (VARIABLE_HEADER
*) (VariableStoreHeader
[Index
] + 1);
544 PtrTrack
->EndPtr
= GetEndPointer (VariableStoreHeader
[Index
]);
546 while (IsValidVariableHeader (Variable
[Index
]) && (Variable
[Index
] <= GetEndPointer (VariableStoreHeader
[Index
]))) {
547 if (Variable
[Index
]->State
== VAR_ADDED
) {
548 if (!(EfiAtRuntime () && !(Variable
[Index
]->Attributes
& EFI_VARIABLE_RUNTIME_ACCESS
))) {
549 if (VariableName
[0] == 0) {
550 PtrTrack
->CurrPtr
= Variable
[Index
];
551 PtrTrack
->Volatile
= (BOOLEAN
) Index
;
554 if (CompareGuid (VendorGuid
, &Variable
[Index
]->VendorGuid
)) {
555 if (!CompareMem (VariableName
, GET_VARIABLE_NAME_PTR (Variable
[Index
]), ArrayLength (VariableName
))) {
556 PtrTrack
->CurrPtr
= Variable
[Index
];
557 PtrTrack
->Volatile
= (BOOLEAN
) Index
;
565 Variable
[Index
] = GetNextVariablePtr (Variable
[Index
]);
574 PtrTrack
->CurrPtr
= NULL
;
575 return EFI_NOT_FOUND
;
581 IN CHAR16
*VariableName
,
582 IN EFI_GUID
* VendorGuid
,
583 OUT UINT32
*Attributes OPTIONAL
,
584 IN OUT UINTN
*DataSize
,
586 IN VARIABLE_GLOBAL
* Global
,
593 This code finds variable in storage blocks (Volatile or Non-Volatile)
597 VariableName Name of Variable to be found
598 VendorGuid Variable vendor GUID
599 Attributes OPTIONAL Attribute value of the variable found
600 DataSize Size of Data found. If size is less than the
601 data, this value contains the required size.
603 Global Pointer to VARIABLE_GLOBAL structure
604 Instance Instance of the Firmware Volume.
612 VARIABLE_POINTER_TRACK Variable
;
616 if (VariableName
== NULL
|| VendorGuid
== NULL
|| DataSize
== NULL
) {
617 return EFI_INVALID_PARAMETER
;
620 // Find existing variable
622 Status
= FindVariable (VariableName
, VendorGuid
, &Variable
, Global
);
624 if (Variable
.CurrPtr
== NULL
|| EFI_ERROR (Status
)) {
630 VarDataSize
= Variable
.CurrPtr
->DataSize
;
631 if (*DataSize
>= VarDataSize
) {
633 return EFI_INVALID_PARAMETER
;
636 CopyMem (Data
, GetVariableDataPtr (Variable
.CurrPtr
), VarDataSize
);
637 if (Attributes
!= NULL
) {
638 *Attributes
= Variable
.CurrPtr
->Attributes
;
641 *DataSize
= VarDataSize
;
644 *DataSize
= VarDataSize
;
645 return EFI_BUFFER_TOO_SMALL
;
651 GetNextVariableName (
652 IN OUT UINTN
*VariableNameSize
,
653 IN OUT CHAR16
*VariableName
,
654 IN OUT EFI_GUID
*VendorGuid
,
655 IN VARIABLE_GLOBAL
*Global
,
662 This code Finds the Next available variable
666 VariableNameSize Size of the variable
667 VariableName Pointer to variable name
668 VendorGuid Variable Vendor Guid
669 Global VARIABLE_GLOBAL structure pointer.
678 VARIABLE_POINTER_TRACK Variable
;
682 if (VariableNameSize
== NULL
|| VariableName
== NULL
|| VendorGuid
== NULL
) {
683 return EFI_INVALID_PARAMETER
;
686 Status
= FindVariable (VariableName
, VendorGuid
, &Variable
, Global
);
688 if (Variable
.CurrPtr
== NULL
|| EFI_ERROR (Status
)) {
692 if (VariableName
[0] != 0) {
694 // If variable name is not NULL, get next variable
696 Variable
.CurrPtr
= GetNextVariablePtr (Variable
.CurrPtr
);
701 // If both volatile and non-volatile variable store are parsed,
704 if (Variable
.CurrPtr
>= Variable
.EndPtr
|| Variable
.CurrPtr
== NULL
) {
705 Variable
.Volatile
= (BOOLEAN
) (Variable
.Volatile
^ ((BOOLEAN
) 0x1));
706 if (Variable
.Volatile
) {
707 Variable
.StartPtr
= (VARIABLE_HEADER
*) ((UINTN
) (Global
->VolatileVariableBase
+ sizeof (VARIABLE_STORE_HEADER
)));
708 Variable
.EndPtr
= (VARIABLE_HEADER
*) GetEndPointer ((VARIABLE_STORE_HEADER
*) ((UINTN
) Global
->VolatileVariableBase
));
710 return EFI_NOT_FOUND
;
713 Variable
.CurrPtr
= Variable
.StartPtr
;
714 if (!IsValidVariableHeader (Variable
.CurrPtr
)) {
721 if (IsValidVariableHeader (Variable
.CurrPtr
) && Variable
.CurrPtr
->State
== VAR_ADDED
) {
722 if (!(EfiAtRuntime () && !(Variable
.CurrPtr
->Attributes
& EFI_VARIABLE_RUNTIME_ACCESS
))) {
723 VarNameSize
= Variable
.CurrPtr
->NameSize
;
724 if (VarNameSize
<= *VariableNameSize
) {
727 GET_VARIABLE_NAME_PTR (Variable
.CurrPtr
),
732 &Variable
.CurrPtr
->VendorGuid
,
735 Status
= EFI_SUCCESS
;
737 Status
= EFI_BUFFER_TOO_SMALL
;
740 *VariableNameSize
= VarNameSize
;
745 Variable
.CurrPtr
= GetNextVariablePtr (Variable
.CurrPtr
);
748 return EFI_NOT_FOUND
;
754 IN CHAR16
*VariableName
,
755 IN EFI_GUID
*VendorGuid
,
756 IN UINT32 Attributes
,
759 IN VARIABLE_GLOBAL
*Global
,
760 IN UINTN
*VolatileOffset
,
761 IN UINTN
*NonVolatileOffset
,
768 This code sets variable in storage blocks (Volatile or Non-Volatile)
772 VariableName Name of Variable to be found
773 VendorGuid Variable vendor GUID
774 Attributes Attribute value of the variable found
775 DataSize Size of Data found. If size is less than the
776 data, this value contains the required size.
778 Global Pointer to VARIABLE_GLOBAL structure
779 VolatileOffset The offset of last volatile variable
780 NonVolatileOffset The offset of last non-volatile variable
781 Instance Instance of the Firmware Volume.
786 EFI_INVALID_PARAMETER - Invalid parameter
787 EFI_SUCCESS - Set successfully
788 EFI_OUT_OF_RESOURCES - Resource not enough to set variable
789 EFI_NOT_FOUND - Not found
793 VARIABLE_POINTER_TRACK Variable
;
795 VARIABLE_HEADER
*NextVariable
;
805 if (VariableName
== NULL
|| VariableName
[0] == 0 || VendorGuid
== NULL
) {
806 return EFI_INVALID_PARAMETER
;
809 Status
= FindVariable (VariableName
, VendorGuid
, &Variable
, Global
);
811 if (Status
== EFI_INVALID_PARAMETER
) {
813 } else if (!EFI_ERROR (Status
) && Variable
.Volatile
&& EfiAtRuntime()) {
815 // If EfiAtRuntime and the variable is Volatile and Runtime Access,
816 // the volatile is ReadOnly, and SetVariable should be aborted and
817 // return EFI_WRITE_PROTECTED.
819 return EFI_WRITE_PROTECTED
;
820 } else if (sizeof (VARIABLE_HEADER
) + ArrayLength (VariableName
) + DataSize
> MAX_VARIABLE_SIZE
) {
822 // The size of the VariableName, including the Unicode Null in bytes plus
823 // the DataSize is limited to maximum size of MAX_VARIABLE_SIZE (1024) bytes.
825 return EFI_INVALID_PARAMETER
;
826 } else if (Attributes
== EFI_VARIABLE_NON_VOLATILE
) {
828 // Make sure not only EFI_VARIABLE_NON_VOLATILE is set
830 return EFI_INVALID_PARAMETER
;
831 } else if ((Attributes
& (EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
)) ==
832 EFI_VARIABLE_RUNTIME_ACCESS
) {
834 // Make sure if runtime bit is set, boot service bit is set also
836 return EFI_INVALID_PARAMETER
;
837 } else if (EfiAtRuntime () && Attributes
&& !(Attributes
& EFI_VARIABLE_RUNTIME_ACCESS
)) {
839 // Runtime but Attribute is not Runtime
841 return EFI_INVALID_PARAMETER
;
842 } else if (EfiAtRuntime () && Attributes
&& !(Attributes
& EFI_VARIABLE_NON_VOLATILE
)) {
844 // Cannot set volatile variable in Runtime
846 return EFI_INVALID_PARAMETER
;
847 } else if (DataSize
== 0 || (Attributes
& (EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
)) == 0) {
849 // Setting a data variable with no access, or zero DataSize attributes
850 // specified causes it to be deleted.
852 if (!EFI_ERROR (Status
)) {
853 State
= Variable
.CurrPtr
->State
;
854 State
&= VAR_DELETED
;
856 Status
= UpdateVariableStore (
861 (UINTN
) &Variable
.CurrPtr
->State
,
865 if (EFI_ERROR (Status
)) {
872 return EFI_NOT_FOUND
;
874 if (!EFI_ERROR (Status
)) {
876 // If the variable is marked valid and the same data has been passed in
877 // then return to the caller immediately.
879 if (Variable
.CurrPtr
->DataSize
== DataSize
&&
880 !CompareMem (Data
, GetVariableDataPtr (Variable
.CurrPtr
), DataSize
)
883 } else if (Variable
.CurrPtr
->State
== VAR_ADDED
) {
885 // Mark the old variable as in delete transition
887 State
= Variable
.CurrPtr
->State
;
888 State
&= VAR_IN_DELETED_TRANSITION
;
890 Status
= UpdateVariableStore (
895 (UINTN
) &Variable
.CurrPtr
->State
,
899 if (EFI_ERROR (Status
)) {
905 // Create a new variable and copy the data.
907 // Tricky part: Use scratch data area at the end of volatile variable store
908 // as a temporary storage.
910 NextVariable
= GetEndPointer ((VARIABLE_STORE_HEADER
*) ((UINTN
) Global
->VolatileVariableBase
));
912 SetMem (NextVariable
, SCRATCH_SIZE
, 0xff);
914 NextVariable
->StartId
= VARIABLE_DATA
;
915 NextVariable
->Attributes
= Attributes
;
917 // NextVariable->State = VAR_ADDED;
919 NextVariable
->Reserved
= 0;
920 VarNameOffset
= sizeof (VARIABLE_HEADER
);
921 VarNameSize
= ArrayLength (VariableName
);
923 (UINT8
*) ((UINTN
) NextVariable
+ VarNameOffset
),
927 VarDataOffset
= VarNameOffset
+ VarNameSize
+ GET_PAD_SIZE (VarNameSize
);
929 (UINT8
*) ((UINTN
) NextVariable
+ VarDataOffset
),
933 CopyMem (&NextVariable
->VendorGuid
, VendorGuid
, sizeof (EFI_GUID
));
935 // There will be pad bytes after Data, the NextVariable->NameSize and
936 // NextVariable->DataSize should not include pad size so that variable
937 // service can get actual size in GetVariable
939 NextVariable
->NameSize
= (UINT32
)VarNameSize
;
940 NextVariable
->DataSize
= (UINT32
)DataSize
;
943 // The actual size of the variable that stores in storage should
946 VarSize
= VarDataOffset
+ DataSize
+ GET_PAD_SIZE (DataSize
);
947 if (Attributes
& EFI_VARIABLE_NON_VOLATILE
) {
948 if ((UINT32
) (VarSize
+*NonVolatileOffset
) >
949 ((VARIABLE_STORE_HEADER
*) ((UINTN
) (Global
->NonVolatileVariableBase
)))->Size
951 if (EfiAtRuntime ()) {
952 return EFI_OUT_OF_RESOURCES
;
955 // Perform garbage collection & reclaim operation
957 Status
= Reclaim (Global
->NonVolatileVariableBase
, NonVolatileOffset
, FALSE
);
958 if (EFI_ERROR (Status
)) {
962 // If still no enough space, return out of resources
964 if ((UINT32
) (VarSize
+*NonVolatileOffset
) >
965 ((VARIABLE_STORE_HEADER
*) ((UINTN
) (Global
->NonVolatileVariableBase
)))->Size
967 return EFI_OUT_OF_RESOURCES
;
974 // 1. Write variable header
975 // 2. Write variable data
976 // 3. Set variable state to valid
981 Status
= UpdateVariableStore (
987 sizeof (VARIABLE_HEADER
),
988 (UINT8
*) NextVariable
991 if (EFI_ERROR (Status
)) {
997 Status
= UpdateVariableStore (
1002 *NonVolatileOffset
+ sizeof (VARIABLE_HEADER
),
1003 (UINT32
) VarSize
- sizeof (VARIABLE_HEADER
),
1004 (UINT8
*) NextVariable
+ sizeof (VARIABLE_HEADER
)
1007 if (EFI_ERROR (Status
)) {
1013 NextVariable
->State
= VAR_ADDED
;
1014 Status
= UpdateVariableStore (
1020 sizeof (VARIABLE_HEADER
),
1021 (UINT8
*) NextVariable
1024 if (EFI_ERROR (Status
)) {
1028 *NonVolatileOffset
= *NonVolatileOffset
+ VarSize
;
1031 if (EfiAtRuntime ()) {
1032 return EFI_INVALID_PARAMETER
;
1035 if ((UINT32
) (VarSize
+*VolatileOffset
) >
1036 ((VARIABLE_STORE_HEADER
*) ((UINTN
) (Global
->VolatileVariableBase
)))->Size
1039 // Perform garbage collection & reclaim operation
1041 Status
= Reclaim (Global
->VolatileVariableBase
, VolatileOffset
, TRUE
);
1042 if (EFI_ERROR (Status
)) {
1046 // If still no enough space, return out of resources
1048 if ((UINT32
) (VarSize
+*VolatileOffset
) >
1049 ((VARIABLE_STORE_HEADER
*) ((UINTN
) (Global
->VolatileVariableBase
)))->Size
1051 return EFI_OUT_OF_RESOURCES
;
1057 NextVariable
->State
= VAR_ADDED
;
1058 Status
= UpdateVariableStore (
1065 (UINT8
*) NextVariable
1068 if (EFI_ERROR (Status
)) {
1072 *VolatileOffset
= *VolatileOffset
+ VarSize
;
1075 // Mark the old variable as deleted
1077 if (!Reclaimed
&& !EFI_ERROR (Status
) && Variable
.CurrPtr
!= NULL
) {
1078 State
= Variable
.CurrPtr
->State
;
1079 State
&= VAR_DELETED
;
1081 Status
= UpdateVariableStore (
1086 (UINTN
) &Variable
.CurrPtr
->State
,
1091 if (EFI_ERROR (Status
)) {
1100 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
1104 IN UINT32 Attributes
,
1105 OUT UINT64
*MaximumVariableStorageSize
,
1106 OUT UINT64
*RemainingVariableStorageSize
,
1107 OUT UINT64
*MaximumVariableSize
,
1108 IN VARIABLE_GLOBAL
*Global
,
1113 Routine Description:
1115 This code returns information about the EFI variables.
1119 Attributes Attributes bitmask to specify the type of variables
1120 on which to return information.
1121 MaximumVariableStorageSize Pointer to the maximum size of the storage space available
1122 for the EFI variables associated with the attributes specified.
1123 RemainingVariableStorageSize Pointer to the remaining size of the storage space available
1124 for the EFI variables associated with the attributes specified.
1125 MaximumVariableSize Pointer to the maximum size of the individual EFI variables
1126 associated with the attributes specified.
1127 Global Pointer to VARIABLE_GLOBAL structure.
1128 Instance Instance of the Firmware Volume.
1133 EFI_INVALID_PARAMETER - An invalid combination of attribute bits was supplied.
1134 EFI_SUCCESS - Query successfully.
1135 EFI_UNSUPPORTED - The attribute is not supported on this platform.
1139 VARIABLE_HEADER
*Variable
;
1140 VARIABLE_HEADER
*NextVariable
;
1141 UINT64 VariableSize
;
1142 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
1144 if(MaximumVariableStorageSize
== NULL
|| RemainingVariableStorageSize
== NULL
|| MaximumVariableSize
== NULL
) {
1145 return EFI_INVALID_PARAMETER
;
1148 if((Attributes
& (EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
)) == 0) {
1150 // Make sure the Attributes combination is supported by the platform.
1152 return EFI_UNSUPPORTED
;
1153 } else if ((Attributes
& (EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
)) == EFI_VARIABLE_RUNTIME_ACCESS
) {
1155 // Make sure if runtime bit is set, boot service bit is set also.
1157 return EFI_INVALID_PARAMETER
;
1158 } else if (EfiAtRuntime () && !(Attributes
& EFI_VARIABLE_RUNTIME_ACCESS
)) {
1160 // Make sure RT Attribute is set if we are in Runtime phase.
1162 return EFI_INVALID_PARAMETER
;
1165 if((Attributes
& EFI_VARIABLE_NON_VOLATILE
) == 0) {
1167 // Query is Volatile related.
1169 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*) ((UINTN
) Global
->VolatileVariableBase
);
1172 // Query is Non-Volatile related.
1174 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*) ((UINTN
) Global
->NonVolatileVariableBase
);
1178 // Now let's fill *MaximumVariableStorageSize *RemainingVariableStorageSize
1179 // with the storage size (excluding the storage header size).
1181 *MaximumVariableStorageSize
= VariableStoreHeader
->Size
- sizeof (VARIABLE_STORE_HEADER
);
1182 *RemainingVariableStorageSize
= VariableStoreHeader
->Size
- sizeof (VARIABLE_STORE_HEADER
);
1185 // Let *MaximumVariableSize be MAX_VARIABLE_SIZE.
1187 *MaximumVariableSize
= MAX_VARIABLE_SIZE
;
1190 // Point to the starting address of the variables.
1192 Variable
= (VARIABLE_HEADER
*) (VariableStoreHeader
+ 1);
1195 // Now walk through the related variable store.
1197 while (IsValidVariableHeader (Variable
) && (Variable
< GetEndPointer (VariableStoreHeader
))) {
1198 NextVariable
= GetNextVariablePtr (Variable
);
1199 VariableSize
= (UINT64
) (UINTN
) NextVariable
- (UINT64
) (UINTN
) Variable
;
1201 if (EfiAtRuntime ()) {
1203 // we don't take the state of the variables in mind
1204 // when calculating RemainingVariableStorageSize,
1205 // since the space occupied by variables not marked with
1206 // VAR_ADDED is not allowed to be reclaimed in Runtime.
1208 *RemainingVariableStorageSize
-= VariableSize
;
1211 // Only care about Variables with State VAR_ADDED,because
1212 // the space not marked as VAR_ADDED is reclaimable now.
1214 if (Variable
->State
== VAR_ADDED
) {
1215 *RemainingVariableStorageSize
-= VariableSize
;
1220 // Go to the next one
1222 Variable
= NextVariable
;
1231 VariableCommonInitialize (
1232 IN EFI_HANDLE ImageHandle
,
1233 IN EFI_SYSTEM_TABLE
*SystemTable
1237 Routine Description:
1238 This function does common initialization for variable services
1242 ImageHandle - The firmware allocated handle for the EFI image.
1243 SystemTable - A pointer to the EFI System Table.
1249 EFI_NOT_FOUND - Variable store area not found.
1250 EFI_UNSUPPORTED - Currently only one non-volatile variable store is supported.
1251 EFI_SUCCESS - Variable services successfully initialized.
1256 EFI_FIRMWARE_VOLUME_HEADER
*FwVolHeader
;
1258 VARIABLE_STORE_HEADER
*VolatileVariableStore
;
1259 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
1260 VARIABLE_HEADER
*NextVariable
;
1262 EFI_PHYSICAL_ADDRESS FvVolHdr
;
1264 UINT64 TempVariableStoreHeader
;
1266 EFI_GCD_MEMORY_SPACE_DESCRIPTOR GcdDescriptor
;
1267 EFI_FLASH_SUBAREA_ENTRY VariableStoreEntry
;
1273 Status
= gBS
->AllocatePool (
1274 EfiRuntimeServicesData
,
1275 sizeof (ESAL_VARIABLE_GLOBAL
),
1276 (VOID
**) &mVariableModuleGlobal
1279 if (EFI_ERROR (Status
)) {
1283 // Allocate memory for volatile variable store
1285 Status
= gBS
->AllocatePool (
1286 EfiRuntimeServicesData
,
1287 VARIABLE_STORE_SIZE
+ SCRATCH_SIZE
,
1288 (VOID
**) &VolatileVariableStore
1291 if (EFI_ERROR (Status
)) {
1292 gBS
->FreePool (mVariableModuleGlobal
);
1296 SetMem (VolatileVariableStore
, VARIABLE_STORE_SIZE
+ SCRATCH_SIZE
, 0xff);
1299 // Variable Specific Data
1301 mVariableModuleGlobal
->VariableBase
[Physical
].VolatileVariableBase
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) VolatileVariableStore
;
1302 mVariableModuleGlobal
->VolatileLastVariableOffset
= sizeof (VARIABLE_STORE_HEADER
);
1304 VolatileVariableStore
->Signature
= VARIABLE_STORE_SIGNATURE
;
1305 VolatileVariableStore
->Size
= VARIABLE_STORE_SIZE
;
1306 VolatileVariableStore
->Format
= VARIABLE_STORE_FORMATTED
;
1307 VolatileVariableStore
->State
= VARIABLE_STORE_HEALTHY
;
1308 VolatileVariableStore
->Reserved
= 0;
1309 VolatileVariableStore
->Reserved1
= 0;
1312 // Get non volatile varaible store
1315 TempVariableStoreHeader
= (UINT64
) PcdGet32 (PcdFlashNvStorageVariableBase
);
1316 VariableStoreEntry
.Base
= TempVariableStoreHeader
+ \
1317 (((EFI_FIRMWARE_VOLUME_HEADER
*) (UINTN
) (TempVariableStoreHeader
)) -> HeaderLength
);
1318 VariableStoreEntry
.Length
= (UINT64
) PcdGet32 (PcdFlashNvStorageVariableSize
) - \
1319 (((EFI_FIRMWARE_VOLUME_HEADER
*) (UINTN
) (TempVariableStoreHeader
)) -> HeaderLength
);
1321 // Mark the variable storage region of the FLASH as RUNTIME
1323 BaseAddress
= VariableStoreEntry
.Base
& (~EFI_PAGE_MASK
);
1324 Length
= VariableStoreEntry
.Length
+ (VariableStoreEntry
.Base
- BaseAddress
);
1325 Length
= (Length
+ EFI_PAGE_SIZE
- 1) & (~EFI_PAGE_MASK
);
1327 Status
= gDS
->GetMemorySpaceDescriptor (BaseAddress
, &GcdDescriptor
);
1328 if (EFI_ERROR (Status
)) {
1329 gBS
->FreePool (mVariableModuleGlobal
);
1330 gBS
->FreePool (VolatileVariableStore
);
1331 return EFI_UNSUPPORTED
;
1334 Status
= gDS
->SetMemorySpaceAttributes (
1337 GcdDescriptor
.Attributes
| EFI_MEMORY_RUNTIME
1339 if (EFI_ERROR (Status
)) {
1340 gBS
->FreePool (mVariableModuleGlobal
);
1341 gBS
->FreePool (VolatileVariableStore
);
1342 return EFI_UNSUPPORTED
;
1345 // Get address of non volatile variable store base
1347 mVariableModuleGlobal
->VariableBase
[Physical
].NonVolatileVariableBase
= VariableStoreEntry
.Base
;
1353 // Find the Correct Instance of the FV Block Service.
1356 CurrPtr
= (CHAR8
*) ((UINTN
) mVariableModuleGlobal
->VariableBase
[Physical
].NonVolatileVariableBase
);
1357 while (EfiFvbGetPhysicalAddress (Instance
, &FvVolHdr
) == EFI_SUCCESS
) {
1358 FwVolHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*) ((UINTN
) FvVolHdr
);
1359 if (CurrPtr
>= (CHAR8
*) FwVolHeader
&& CurrPtr
< (((CHAR8
*) FwVolHeader
) + FwVolHeader
->FvLength
)) {
1360 mVariableModuleGlobal
->FvbInstance
= Instance
;
1367 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*) CurrPtr
;
1368 if (GetVariableStoreStatus (VariableStoreHeader
) == EfiValid
) {
1369 if (~VariableStoreHeader
->Size
== 0) {
1370 Status
= UpdateVariableStore (
1371 &mVariableModuleGlobal
->VariableBase
[Physical
],
1374 mVariableModuleGlobal
->FvbInstance
,
1375 (UINTN
) &VariableStoreHeader
->Size
,
1377 (UINT8
*) &VariableStoreEntry
.Length
1380 if (EFI_ERROR (Status
)) {
1385 mVariableModuleGlobal
->VariableBase
[Physical
].NonVolatileVariableBase
= (EFI_PHYSICAL_ADDRESS
) ((UINTN
) CurrPtr
);
1387 // Parse non-volatile variable data and get last variable offset
1389 NextVariable
= (VARIABLE_HEADER
*) (CurrPtr
+ sizeof (VARIABLE_STORE_HEADER
));
1390 Status
= EFI_SUCCESS
;
1392 while (IsValidVariableHeader (NextVariable
)) {
1393 NextVariable
= GetNextVariablePtr (NextVariable
);
1396 mVariableModuleGlobal
->NonVolatileLastVariableOffset
= (UINTN
) NextVariable
- (UINTN
) CurrPtr
;
1399 // Check if the free area is blow a threshold
1401 if ((((VARIABLE_STORE_HEADER
*)((UINTN
) CurrPtr
))->Size
- mVariableModuleGlobal
->NonVolatileLastVariableOffset
) < VARIABLE_RECLAIM_THRESHOLD
) {
1403 mVariableModuleGlobal
->VariableBase
[Physical
].NonVolatileVariableBase
,
1404 &mVariableModuleGlobal
->NonVolatileLastVariableOffset
,
1409 if (EFI_ERROR (Status
)) {
1410 gBS
->FreePool (mVariableModuleGlobal
);
1411 gBS
->FreePool (VolatileVariableStore
);
1416 // Check if the free area is really free.
1418 for (Index
= mVariableModuleGlobal
->NonVolatileLastVariableOffset
; Index
< VariableStoreHeader
->Size
; Index
++) {
1419 Data
= ((UINT8
*) (UINTN
) mVariableModuleGlobal
->VariableBase
[Physical
].NonVolatileVariableBase
)[Index
];
1422 // There must be something wrong in variable store, do reclaim operation.
1425 mVariableModuleGlobal
->VariableBase
[Physical
].NonVolatileVariableBase
,
1426 &mVariableModuleGlobal
->NonVolatileLastVariableOffset
,
1434 if (EFI_ERROR (Status
)) {
1435 gBS
->FreePool (mVariableModuleGlobal
);
1436 gBS
->FreePool (VolatileVariableStore
);