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.
25 // Don't use module globals after the SetVirtualAddress map is signaled
27 ESAL_VARIABLE_GLOBAL
*mVariableModuleGlobal
;
38 Determine the length of null terminated char16 array.
42 String Null-terminated CHAR16 array pointer.
46 UINT32 Number of bytes in the string, including the double NULL at the end;
58 while (0 != String
[Count
]) {
62 return (Count
* 2) + 2;
67 GetVariableStoreStatus (
68 IN VARIABLE_STORE_HEADER
*VarStoreHeader
74 This code gets the pointer to the variable name.
78 VarStoreHeader Pointer to the Variable Store Header.
82 EfiHealthy Variable store is healthy
83 EfiRaw Variable store is raw
84 EfiInvalid Variable store is invalid
88 if (VarStoreHeader
->Signature
== VARIABLE_STORE_SIGNATURE
&&
89 VarStoreHeader
->Format
== VARIABLE_STORE_FORMATTED
&&
90 VarStoreHeader
->State
== VARIABLE_STORE_HEALTHY
94 } else if (VarStoreHeader
->Signature
== 0xffffffff &&
95 VarStoreHeader
->Size
== 0xffffffff &&
96 VarStoreHeader
->Format
== 0xff &&
97 VarStoreHeader
->State
== 0xff
109 IN VARIABLE_HEADER
*Variable
115 This code gets the pointer to the variable data.
119 Variable Pointer to the Variable Header.
123 UINT8* Pointer to Variable Data
127 if (Variable
->StartId
!= VARIABLE_DATA
) {
131 // Be careful about pad size for alignment
133 return (UINT8
*) ((UINTN
) GET_VARIABLE_NAME_PTR (Variable
) + Variable
->NameSize
+ GET_PAD_SIZE (Variable
->NameSize
));
139 IN VARIABLE_HEADER
*Variable
145 This code gets the pointer to the next variable header.
149 Variable Pointer to the Variable Header.
153 VARIABLE_HEADER* Pointer to next variable header.
157 VARIABLE_HEADER
*VarHeader
;
159 if (Variable
->StartId
!= VARIABLE_DATA
) {
163 // Be careful about pad size for alignment
165 VarHeader
= (VARIABLE_HEADER
*) (GetVariableDataPtr (Variable
) + Variable
->DataSize
+ GET_PAD_SIZE (Variable
->DataSize
));
167 if (VarHeader
->StartId
!= VARIABLE_DATA
||
168 (sizeof (VARIABLE_HEADER
) + VarHeader
->DataSize
+ VarHeader
->NameSize
) > MAX_VARIABLE_SIZE
179 IN VARIABLE_STORE_HEADER
*VolHeader
185 This code gets the pointer to the last variable memory pointer byte
189 Variable Pointer to the Variable Header.
193 VARIABLE_HEADER* Pointer to last unavailable Variable Header
198 // The end of variable store
200 return (VARIABLE_HEADER
*) ((UINTN
) VolHeader
+ VolHeader
->Size
);
206 IN CHAR16
*VariableName
,
207 IN EFI_GUID
*VendorGuid
,
208 OUT VARIABLE_POINTER_TRACK
*PtrTrack
,
209 IN VARIABLE_GLOBAL
*Global
215 This code finds variable in storage blocks (Volatile or Non-Volatile)
219 VariableName Name of the variable to be found
220 VendorGuid Vendor GUID to be found.
221 PtrTrack Variable Track Pointer structure that contains
222 Variable Information.
223 Contains the pointer of Variable header.
224 Global VARIABLE_GLOBAL pointer
232 VARIABLE_HEADER
*Variable
[2];
233 VARIABLE_STORE_HEADER
*VariableStoreHeader
[2];
237 // 0: Non-Volatile, 1: Volatile
239 VariableStoreHeader
[0] = (VARIABLE_STORE_HEADER
*) ((UINTN
) Global
->NonVolatileVariableBase
);
240 VariableStoreHeader
[1] = (VARIABLE_STORE_HEADER
*) ((UINTN
) Global
->VolatileVariableBase
);
243 // Start Pointers for the variable.
244 // Actual Data Pointer where data can be written.
246 Variable
[0] = (VARIABLE_HEADER
*) (VariableStoreHeader
[0] + 1);
247 Variable
[1] = (VARIABLE_HEADER
*) (VariableStoreHeader
[1] + 1);
249 if (VariableName
[0] != 0 && VendorGuid
== NULL
) {
250 return EFI_INVALID_PARAMETER
;
253 // Find the variable by walk through non-volatile and volatile variable store
255 for (Index
= 0; Index
< 2; Index
++) {
256 PtrTrack
->StartPtr
= (VARIABLE_HEADER
*) (VariableStoreHeader
[Index
] + 1);
257 PtrTrack
->EndPtr
= GetEndPointer (VariableStoreHeader
[Index
]);
259 while ((Variable
[Index
] != NULL
) && (Variable
[Index
] <= GetEndPointer (VariableStoreHeader
[Index
]))) {
260 if (Variable
[Index
]->StartId
== VARIABLE_DATA
&& Variable
[Index
]->State
== VAR_ADDED
) {
261 if (!(EfiAtRuntime () && !(Variable
[Index
]->Attributes
& EFI_VARIABLE_RUNTIME_ACCESS
))) {
262 if (VariableName
[0] == 0) {
263 PtrTrack
->CurrPtr
= Variable
[Index
];
264 PtrTrack
->Volatile
= (BOOLEAN
) Index
;
267 if (CompareGuid (VendorGuid
, &Variable
[Index
]->VendorGuid
)) {
268 if (!CompareMem (VariableName
, GET_VARIABLE_NAME_PTR (Variable
[Index
]), ArrayLength (VariableName
))) {
269 PtrTrack
->CurrPtr
= Variable
[Index
];
270 PtrTrack
->Volatile
= (BOOLEAN
) Index
;
278 Variable
[Index
] = GetNextVariablePtr (Variable
[Index
]);
281 PtrTrack
->CurrPtr
= NULL
;
282 return EFI_NOT_FOUND
;
288 IN CHAR16
*VariableName
,
289 IN EFI_GUID
* VendorGuid
,
290 OUT UINT32
*Attributes OPTIONAL
,
291 IN OUT UINTN
*DataSize
,
293 IN VARIABLE_GLOBAL
* Global
,
300 This code finds variable in storage blocks (Volatile or Non-Volatile)
304 VariableName Name of Variable to be found
305 VendorGuid Variable vendor GUID
306 Attributes OPTIONAL Attribute value of the variable found
307 DataSize Size of Data found. If size is less than the
308 data, this value contains the required size.
310 Global Pointer to VARIABLE_GLOBAL structure
311 Instance Instance of the Firmware Volume.
319 VARIABLE_POINTER_TRACK Variable
;
323 if (VariableName
== NULL
|| VendorGuid
== NULL
|| DataSize
== NULL
) {
324 return EFI_INVALID_PARAMETER
;
327 // Find existing variable
329 Status
= FindVariable (VariableName
, VendorGuid
, &Variable
, Global
);
331 if (Variable
.CurrPtr
== NULL
|| EFI_ERROR (Status
)) {
337 VarDataSize
= Variable
.CurrPtr
->DataSize
;
338 if (*DataSize
>= VarDataSize
) {
339 CopyMem (Data
, GetVariableDataPtr (Variable
.CurrPtr
), VarDataSize
);
341 *Attributes
= Variable
.CurrPtr
->Attributes
;
344 *DataSize
= VarDataSize
;
347 *DataSize
= VarDataSize
;
348 return EFI_BUFFER_TOO_SMALL
;
354 GetNextVariableName (
355 IN OUT UINTN
*VariableNameSize
,
356 IN OUT CHAR16
*VariableName
,
357 IN OUT EFI_GUID
*VendorGuid
,
358 IN VARIABLE_GLOBAL
*Global
,
365 This code Finds the Next available variable
369 VariableNameSize Size of the variable
370 VariableName Pointer to variable name
371 VendorGuid Variable Vendor Guid
372 Global VARIABLE_GLOBAL structure pointer.
381 VARIABLE_POINTER_TRACK Variable
;
385 if (VariableNameSize
== NULL
|| VendorGuid
== NULL
) {
386 return EFI_INVALID_PARAMETER
;
389 Status
= FindVariable (VariableName
, VendorGuid
, &Variable
, Global
);
391 if (Variable
.CurrPtr
== NULL
|| EFI_ERROR (Status
)) {
396 if (VariableName
[0] != 0) {
398 // If variable name is not NULL, get next variable
400 Variable
.CurrPtr
= GetNextVariablePtr (Variable
.CurrPtr
);
403 // If both volatile and non-volatile variable store are parsed,
406 if (Variable
.CurrPtr
>= Variable
.EndPtr
|| Variable
.CurrPtr
== NULL
) {
407 Variable
.Volatile
= (BOOLEAN
) (Variable
.Volatile
^ ((BOOLEAN
) 0x1));
408 if (Variable
.Volatile
) {
409 Variable
.StartPtr
= (VARIABLE_HEADER
*) ((UINTN
) (Global
->VolatileVariableBase
+ sizeof (VARIABLE_STORE_HEADER
)));
410 Variable
.EndPtr
= (VARIABLE_HEADER
*) GetEndPointer ((VARIABLE_STORE_HEADER
*) ((UINTN
) Global
->VolatileVariableBase
));
412 return EFI_NOT_FOUND
;
415 Variable
.CurrPtr
= Variable
.StartPtr
;
416 if (Variable
.CurrPtr
->StartId
!= VARIABLE_DATA
) {
423 if (Variable
.CurrPtr
->StartId
== VARIABLE_DATA
&& Variable
.CurrPtr
->State
== VAR_ADDED
) {
424 if (!(EfiAtRuntime () && !(Variable
.CurrPtr
->Attributes
& EFI_VARIABLE_RUNTIME_ACCESS
))) {
425 VarNameSize
= Variable
.CurrPtr
->NameSize
;
426 if (VarNameSize
<= *VariableNameSize
) {
429 GET_VARIABLE_NAME_PTR (Variable
.CurrPtr
),
434 &Variable
.CurrPtr
->VendorGuid
,
437 Status
= EFI_SUCCESS
;
439 Status
= EFI_BUFFER_TOO_SMALL
;
442 *VariableNameSize
= VarNameSize
;
448 return EFI_NOT_FOUND
;
454 IN CHAR16
*VariableName
,
455 IN EFI_GUID
*VendorGuid
,
456 IN UINT32 Attributes
,
459 IN VARIABLE_GLOBAL
*Global
,
460 IN UINTN
*VolatileOffset
,
461 IN UINTN
*NonVolatileOffset
,
468 This code sets variable in storage blocks (Volatile or Non-Volatile)
472 VariableName Name of Variable to be found
473 VendorGuid Variable vendor GUID
474 Attributes Attribute value of the variable found
475 DataSize Size of Data found. If size is less than the
476 data, this value contains the required size.
478 Global Pointer to VARIABLE_GLOBAL structure
479 VolatileOffset The offset of last volatile variable
480 NonVolatileOffset The offset of last non-volatile variable
481 Instance Instance of the Firmware Volume.
489 VARIABLE_POINTER_TRACK Variable
;
491 VARIABLE_HEADER
*NextVariable
;
497 if (VariableName
== NULL
|| VariableName
[0] == 0 || VendorGuid
== NULL
) {
498 return EFI_INVALID_PARAMETER
;
501 Status
= FindVariable (VariableName
, VendorGuid
, &Variable
, Global
);
503 if (Status
== EFI_INVALID_PARAMETER
) {
507 // The size of the VariableName, including the Unicode Null in bytes plus
508 // the DataSize is limited to maximum size of MAX_VARIABLE_SIZE (1024) bytes.
510 else if (sizeof (VARIABLE_HEADER
) + (ArrayLength (VariableName
) + DataSize
) > MAX_VARIABLE_SIZE
) {
511 return EFI_INVALID_PARAMETER
;
514 // Make sure if runtime bit is set, boot service bit is set also
516 else if ((Attributes
& (EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
)) == EFI_VARIABLE_RUNTIME_ACCESS
518 return EFI_INVALID_PARAMETER
;
521 // Runtime but Attribute is not Runtime
523 else if (EfiAtRuntime () && Attributes
&& !(Attributes
& EFI_VARIABLE_RUNTIME_ACCESS
)) {
524 return EFI_INVALID_PARAMETER
;
527 // Cannot set volatile variable in Runtime
529 else if (EfiAtRuntime () && Attributes
&& !(Attributes
& EFI_VARIABLE_NON_VOLATILE
)) {
530 return EFI_INVALID_PARAMETER
;
533 // Setting a data variable with no access, or zero DataSize attributes
534 // specified causes it to be deleted.
536 else if (DataSize
== 0 || Attributes
== 0) {
537 if (!EFI_ERROR (Status
)) {
538 Variable
.CurrPtr
->State
&= VAR_DELETED
;
542 return EFI_NOT_FOUND
;
544 if (!EFI_ERROR (Status
)) {
546 // If the variable is marked valid and the same data has been passed in
547 // then return to the caller immediately.
549 if (Variable
.CurrPtr
->DataSize
== DataSize
&&
550 !CompareMem (Data
, GetVariableDataPtr (Variable
.CurrPtr
), DataSize
)
553 } else if (Variable
.CurrPtr
->State
== VAR_ADDED
) {
555 // Mark the old variable as in delete transition
557 Variable
.CurrPtr
->State
&= VAR_IN_DELETED_TRANSITION
;
561 // Create a new variable and copy the data.
563 VarNameOffset
= sizeof (VARIABLE_HEADER
);
564 VarNameSize
= ArrayLength (VariableName
);
565 VarDataOffset
= VarNameOffset
+ VarNameSize
+ GET_PAD_SIZE (VarNameSize
);
566 VarSize
= VarDataOffset
+ DataSize
+ GET_PAD_SIZE (DataSize
);
568 if (Attributes
& EFI_VARIABLE_NON_VOLATILE
) {
569 if ((UINT32
) (VarSize
+*NonVolatileOffset
) >
570 ((VARIABLE_STORE_HEADER
*) ((UINTN
) (Global
->NonVolatileVariableBase
)))->Size
572 return EFI_OUT_OF_RESOURCES
;
575 NextVariable
= (VARIABLE_HEADER
*) (UINT8
*) (*NonVolatileOffset
+ (UINTN
) Global
->NonVolatileVariableBase
);
576 *NonVolatileOffset
= *NonVolatileOffset
+ VarSize
;
578 if (EfiAtRuntime ()) {
579 return EFI_INVALID_PARAMETER
;
582 if ((UINT32
) (VarSize
+*VolatileOffset
) >
583 ((VARIABLE_STORE_HEADER
*) ((UINTN
) (Global
->VolatileVariableBase
)))->Size
585 return EFI_OUT_OF_RESOURCES
;
588 NextVariable
= (VARIABLE_HEADER
*) (UINT8
*) (*VolatileOffset
+ (UINTN
) Global
->VolatileVariableBase
);
589 *VolatileOffset
= *VolatileOffset
+ VarSize
;
592 NextVariable
->StartId
= VARIABLE_DATA
;
593 NextVariable
->Attributes
= Attributes
;
594 NextVariable
->State
= VAR_ADDED
;
595 NextVariable
->Reserved
= 0;
598 // There will be pad bytes after Data, the NextVariable->NameSize and
599 // NextVariable->NameSize should not include pad size so that variable
600 // service can get actual size in GetVariable
602 NextVariable
->NameSize
= (UINT32
)VarNameSize
;
603 NextVariable
->DataSize
= (UINT32
)DataSize
;
605 CopyMem (&NextVariable
->VendorGuid
, VendorGuid
, sizeof (EFI_GUID
));
607 (UINT8
*) ((UINTN
) NextVariable
+ VarNameOffset
),
612 (UINT8
*) ((UINTN
) NextVariable
+ VarDataOffset
),
618 // Mark the old variable as deleted
620 if (!EFI_ERROR (Status
)) {
621 Variable
.CurrPtr
->State
&= VAR_DELETED
;
628 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
632 IN UINT32 Attributes
,
633 OUT UINT64
*MaximumVariableStorageSize
,
634 OUT UINT64
*RemainingVariableStorageSize
,
635 OUT UINT64
*MaximumVariableSize
,
636 IN VARIABLE_GLOBAL
*Global
,
643 This code returns information about the EFI variables.
647 Attributes Attributes bitmask to specify the type of variables
648 on which to return information.
649 MaximumVariableStorageSize Pointer to the maximum size of the storage space available
650 for the EFI variables associated with the attributes specified.
651 RemainingVariableStorageSize Pointer to the remaining size of the storage space available
652 for the EFI variables associated with the attributes specified.
653 MaximumVariableSize Pointer to the maximum size of the individual EFI variables
654 associated with the attributes specified.
655 Global Pointer to VARIABLE_GLOBAL structure.
656 Instance Instance of the Firmware Volume.
661 EFI_INVALID_PARAMETER - An invalid combination of attribute bits was supplied.
662 EFI_SUCCESS - Query successfully.
663 EFI_UNSUPPORTED - The attribute is not supported on this platform.
667 VARIABLE_HEADER
*Variable
;
668 VARIABLE_HEADER
*NextVariable
;
670 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
672 if(MaximumVariableStorageSize
== NULL
|| RemainingVariableStorageSize
== NULL
|| MaximumVariableSize
== NULL
) {
673 return EFI_INVALID_PARAMETER
;
676 if((Attributes
& (EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
)) == 0) {
678 // Make sure the Attributes combination is supported by the platform.
680 return EFI_UNSUPPORTED
;
681 } else if ((Attributes
& (EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
)) == EFI_VARIABLE_RUNTIME_ACCESS
) {
683 // Make sure if runtime bit is set, boot service bit is set also.
685 return EFI_INVALID_PARAMETER
;
686 } else if (EfiAtRuntime () && !(Attributes
& EFI_VARIABLE_RUNTIME_ACCESS
)) {
688 // Make sure RT Attribute is set if we are in Runtime phase.
690 return EFI_INVALID_PARAMETER
;
693 if((Attributes
& EFI_VARIABLE_NON_VOLATILE
) == 0) {
695 // Query is Volatile related.
697 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*) ((UINTN
) Global
->VolatileVariableBase
);
700 // Query is Non-Volatile related.
702 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*) ((UINTN
) Global
->NonVolatileVariableBase
);
706 // Now let's fill *MaximumVariableStorageSize *RemainingVariableStorageSize
707 // with the storage size (excluding the storage header size)
709 *MaximumVariableStorageSize
= VariableStoreHeader
->Size
- sizeof (VARIABLE_STORE_HEADER
);
710 *RemainingVariableStorageSize
= VariableStoreHeader
->Size
- sizeof (VARIABLE_STORE_HEADER
);
713 // Let *MaximumVariableSize be MAX_VARIABLE_SIZE
715 *MaximumVariableSize
= MAX_VARIABLE_SIZE
;
718 // Point to the starting address of the variables.
720 Variable
= (VARIABLE_HEADER
*) (VariableStoreHeader
+ 1);
723 // Now walk through the related variable store.
725 while (Variable
< GetEndPointer (VariableStoreHeader
)) {
726 if (Variable
->StartId
!= VARIABLE_DATA
) {
730 NextVariable
= (VARIABLE_HEADER
*) (GetVariableDataPtr (Variable
) + Variable
->DataSize
+ GET_PAD_SIZE (Variable
->DataSize
));
731 VariableSize
= (UINT64
) (UINTN
) NextVariable
- (UINT64
) (UINTN
) Variable
;
733 if (Variable
->State
== VAR_ADDED
) {
734 *RemainingVariableStorageSize
-= VariableSize
;
738 // Go to the next one.
740 Variable
= NextVariable
;
749 InitializeVariableStore (
750 OUT EFI_PHYSICAL_ADDRESS
*VariableBase
,
751 OUT UINTN
*LastVariableOffset
756 This function initializes variable store
764 VARIABLE_STORE_HEADER
*VariableStore
;
767 // Allocate memory for volatile variable store
769 VariableStore
= (VARIABLE_STORE_HEADER
*) AllocateRuntimePool (
772 if (NULL
== VariableStore
) {
773 return EFI_OUT_OF_RESOURCES
;
776 SetMem (VariableStore
, VARIABLE_STORE_SIZE
, 0xff);
779 // Variable Specific Data
781 *VariableBase
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) VariableStore
;
782 *LastVariableOffset
= sizeof (VARIABLE_STORE_HEADER
);
784 VariableStore
->Signature
= VARIABLE_STORE_SIGNATURE
;
785 VariableStore
->Size
= VARIABLE_STORE_SIZE
;
786 VariableStore
->Format
= VARIABLE_STORE_FORMATTED
;
787 VariableStore
->State
= VARIABLE_STORE_HEALTHY
;
788 VariableStore
->Reserved
= 0;
789 VariableStore
->Reserved1
= 0;
796 VariableCommonInitialize (
797 IN EFI_HANDLE ImageHandle
,
798 IN EFI_SYSTEM_TABLE
*SystemTable
803 This function does common initialization for variable services
814 // Allocate memory for mVariableModuleGlobal
816 mVariableModuleGlobal
= (ESAL_VARIABLE_GLOBAL
*) AllocateRuntimePool (
817 sizeof (ESAL_VARIABLE_GLOBAL
)
819 if (NULL
== mVariableModuleGlobal
) {
820 return EFI_OUT_OF_RESOURCES
;
823 // Intialize volatile variable store
825 Status
= InitializeVariableStore (
826 &mVariableModuleGlobal
->VariableBase
[Physical
].VolatileVariableBase
,
827 &mVariableModuleGlobal
->VolatileLastVariableOffset
830 if (EFI_ERROR (Status
)) {
834 // Intialize non volatile variable store
836 Status
= InitializeVariableStore (
837 &mVariableModuleGlobal
->VariableBase
[Physical
].NonVolatileVariableBase
,
838 &mVariableModuleGlobal
->NonVolatileLastVariableOffset