2 Implement ReadOnly Variable Services required by PEIM and install
3 PEI ReadOnly Varaiable2 PPI. These services operates the non volatile storage space.
5 Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
6 Copyright (c) Microsoft Corporation.<BR>
7 SPDX-License-Identifier: BSD-2-Clause-Patent
17 EFI_PEI_READ_ONLY_VARIABLE2_PPI mVariablePpi
= {
19 PeiGetNextVariableName
22 EFI_PEI_PPI_DESCRIPTOR mPpiListVariable
= {
23 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
24 &gEfiPeiReadOnlyVariable2PpiGuid
,
30 Provide the functionality of the variable services.
32 @param FileHandle Handle of the file being invoked.
33 Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().
34 @param PeiServices General purpose services available to every PEIM.
36 @retval EFI_SUCCESS If the interface could be successfully installed
37 @retval Others Returned from PeiServicesInstallPpi()
41 PeimInitializeVariableServices (
42 IN EFI_PEI_FILE_HANDLE FileHandle
,
43 IN CONST EFI_PEI_SERVICES
**PeiServices
46 return PeiServicesInstallPpi (&mPpiListVariable
);
51 Gets the pointer to the first variable header in given variable store area.
53 @param VarStoreHeader Pointer to the Variable Store Header.
55 @return Pointer to the first variable header.
60 IN VARIABLE_STORE_HEADER
*VarStoreHeader
64 // The start of variable store
66 return (VARIABLE_HEADER
*) HEADER_ALIGN (VarStoreHeader
+ 1);
72 Gets the pointer to the end of the variable storage area.
74 This function gets pointer to the end of the variable storage
75 area, according to the input variable store header.
77 @param VarStoreHeader Pointer to the Variable Store Header.
79 @return Pointer to the end of the variable storage area.
84 IN VARIABLE_STORE_HEADER
*VarStoreHeader
88 // The end of variable store
90 return (VARIABLE_HEADER
*) HEADER_ALIGN ((UINTN
) VarStoreHeader
+ VarStoreHeader
->Size
);
95 This code checks if variable header is valid or not.
97 @param Variable Pointer to the Variable Header.
99 @retval TRUE Variable header is valid.
100 @retval FALSE Variable header is not valid.
104 IsValidVariableHeader (
105 IN VARIABLE_HEADER
*Variable
108 if (Variable
== NULL
|| Variable
->StartId
!= VARIABLE_DATA
) {
116 This code gets the size of variable header.
118 @param AuthFlag Authenticated variable flag.
120 @return Size of variable header in bytes in type UINTN.
124 GetVariableHeaderSize (
131 Value
= sizeof (AUTHENTICATED_VARIABLE_HEADER
);
133 Value
= sizeof (VARIABLE_HEADER
);
140 This code gets the size of name of variable.
142 @param Variable Pointer to the Variable Header.
143 @param AuthFlag Authenticated variable flag.
145 @return Size of variable in bytes in type UINTN.
150 IN VARIABLE_HEADER
*Variable
,
154 AUTHENTICATED_VARIABLE_HEADER
*AuthVariable
;
156 AuthVariable
= (AUTHENTICATED_VARIABLE_HEADER
*) Variable
;
158 if (AuthVariable
->State
== (UINT8
) (-1) ||
159 AuthVariable
->DataSize
== (UINT32
) (-1) ||
160 AuthVariable
->NameSize
== (UINT32
) (-1) ||
161 AuthVariable
->Attributes
== (UINT32
) (-1)) {
164 return (UINTN
) AuthVariable
->NameSize
;
166 if (Variable
->State
== (UINT8
) (-1) ||
167 Variable
->DataSize
== (UINT32
) (-1) ||
168 Variable
->NameSize
== (UINT32
) (-1) ||
169 Variable
->Attributes
== (UINT32
) (-1)) {
172 return (UINTN
) Variable
->NameSize
;
178 This code gets the size of data of variable.
180 @param Variable Pointer to the Variable Header.
181 @param AuthFlag Authenticated variable flag.
183 @return Size of variable in bytes in type UINTN.
188 IN VARIABLE_HEADER
*Variable
,
192 AUTHENTICATED_VARIABLE_HEADER
*AuthVariable
;
194 AuthVariable
= (AUTHENTICATED_VARIABLE_HEADER
*) Variable
;
196 if (AuthVariable
->State
== (UINT8
) (-1) ||
197 AuthVariable
->DataSize
== (UINT32
) (-1) ||
198 AuthVariable
->NameSize
== (UINT32
) (-1) ||
199 AuthVariable
->Attributes
== (UINT32
) (-1)) {
202 return (UINTN
) AuthVariable
->DataSize
;
204 if (Variable
->State
== (UINT8
) (-1) ||
205 Variable
->DataSize
== (UINT32
) (-1) ||
206 Variable
->NameSize
== (UINT32
) (-1) ||
207 Variable
->Attributes
== (UINT32
) (-1)) {
210 return (UINTN
) Variable
->DataSize
;
215 This code gets the pointer to the variable name.
217 @param Variable Pointer to the Variable Header.
218 @param AuthFlag Authenticated variable flag.
220 @return A CHAR16* pointer to Variable Name.
225 IN VARIABLE_HEADER
*Variable
,
229 return (CHAR16
*) ((UINTN
) Variable
+ GetVariableHeaderSize (AuthFlag
));
233 This code gets the pointer to the variable guid.
235 @param Variable Pointer to the Variable Header.
236 @param AuthFlag Authenticated variable flag.
238 @return A EFI_GUID* pointer to Vendor Guid.
243 IN VARIABLE_HEADER
*Variable
,
247 AUTHENTICATED_VARIABLE_HEADER
*AuthVariable
;
249 AuthVariable
= (AUTHENTICATED_VARIABLE_HEADER
*) Variable
;
251 return &AuthVariable
->VendorGuid
;
253 return &Variable
->VendorGuid
;
258 This code gets the pointer to the variable data.
260 @param Variable Pointer to the Variable Header.
261 @param VariableHeader Pointer to the Variable Header that has consecutive content.
262 @param AuthFlag Authenticated variable flag.
264 @return A UINT8* pointer to Variable Data.
269 IN VARIABLE_HEADER
*Variable
,
270 IN VARIABLE_HEADER
*VariableHeader
,
277 // Be careful about pad size for alignment
279 Value
= (UINTN
) GetVariableNamePtr (Variable
, AuthFlag
);
280 Value
+= NameSizeOfVariable (VariableHeader
, AuthFlag
);
281 Value
+= GET_PAD_SIZE (NameSizeOfVariable (VariableHeader
, AuthFlag
));
283 return (UINT8
*) Value
;
288 This code gets the pointer to the next variable header.
290 @param StoreInfo Pointer to variable store info structure.
291 @param Variable Pointer to the Variable Header.
292 @param VariableHeader Pointer to the Variable Header that has consecutive content.
294 @return A VARIABLE_HEADER* pointer to next variable header.
299 IN VARIABLE_STORE_INFO
*StoreInfo
,
300 IN VARIABLE_HEADER
*Variable
,
301 IN VARIABLE_HEADER
*VariableHeader
304 EFI_PHYSICAL_ADDRESS TargetAddress
;
305 EFI_PHYSICAL_ADDRESS SpareAddress
;
308 Value
= (UINTN
) GetVariableDataPtr (Variable
, VariableHeader
, StoreInfo
->AuthFlag
);
309 Value
+= DataSizeOfVariable (VariableHeader
, StoreInfo
->AuthFlag
);
310 Value
+= GET_PAD_SIZE (DataSizeOfVariable (VariableHeader
, StoreInfo
->AuthFlag
));
312 // Be careful about pad size for alignment
314 Value
= HEADER_ALIGN (Value
);
316 if (StoreInfo
->FtwLastWriteData
!= NULL
) {
317 TargetAddress
= StoreInfo
->FtwLastWriteData
->TargetAddress
;
318 SpareAddress
= StoreInfo
->FtwLastWriteData
->SpareAddress
;
319 if (((UINTN
) Variable
< (UINTN
) TargetAddress
) && (Value
>= (UINTN
) TargetAddress
)) {
321 // Next variable is in spare block.
323 Value
= (UINTN
) SpareAddress
+ (Value
- (UINTN
) TargetAddress
);
327 return (VARIABLE_HEADER
*) Value
;
331 Get variable store status.
333 @param VarStoreHeader Pointer to the Variable Store Header.
335 @retval EfiRaw Variable store is raw
336 @retval EfiValid Variable store is valid
337 @retval EfiInvalid Variable store is invalid
340 VARIABLE_STORE_STATUS
341 GetVariableStoreStatus (
342 IN VARIABLE_STORE_HEADER
*VarStoreHeader
345 if ((CompareGuid (&VarStoreHeader
->Signature
, &gEfiAuthenticatedVariableGuid
) ||
346 CompareGuid (&VarStoreHeader
->Signature
, &gEfiVariableGuid
)) &&
347 VarStoreHeader
->Format
== VARIABLE_STORE_FORMATTED
&&
348 VarStoreHeader
->State
== VARIABLE_STORE_HEALTHY
354 if (((UINT32
*)(&VarStoreHeader
->Signature
))[0] == 0xffffffff &&
355 ((UINT32
*)(&VarStoreHeader
->Signature
))[1] == 0xffffffff &&
356 ((UINT32
*)(&VarStoreHeader
->Signature
))[2] == 0xffffffff &&
357 ((UINT32
*)(&VarStoreHeader
->Signature
))[3] == 0xffffffff &&
358 VarStoreHeader
->Size
== 0xffffffff &&
359 VarStoreHeader
->Format
== 0xff &&
360 VarStoreHeader
->State
== 0xff
370 Compare two variable names, one of them may be inconsecutive.
372 @param StoreInfo Pointer to variable store info structure.
373 @param Name1 Pointer to one variable name.
374 @param Name2 Pointer to another variable name.
375 @param NameSize Variable name size.
377 @retval TRUE Name1 and Name2 are identical.
378 @retval FALSE Name1 and Name2 are not identical.
382 CompareVariableName (
383 IN VARIABLE_STORE_INFO
*StoreInfo
,
384 IN CONST CHAR16
*Name1
,
385 IN CONST CHAR16
*Name2
,
389 EFI_PHYSICAL_ADDRESS TargetAddress
;
390 EFI_PHYSICAL_ADDRESS SpareAddress
;
391 UINTN PartialNameSize
;
393 if (StoreInfo
->FtwLastWriteData
!= NULL
) {
394 TargetAddress
= StoreInfo
->FtwLastWriteData
->TargetAddress
;
395 SpareAddress
= StoreInfo
->FtwLastWriteData
->SpareAddress
;
396 if (((UINTN
) Name1
< (UINTN
) TargetAddress
) && (((UINTN
) Name1
+ NameSize
) > (UINTN
) TargetAddress
)) {
398 // Name1 is inconsecutive.
400 PartialNameSize
= (UINTN
) TargetAddress
- (UINTN
) Name1
;
402 // Partial content is in NV storage.
404 if (CompareMem ((UINT8
*) Name1
, (UINT8
*) Name2
, PartialNameSize
) == 0) {
406 // Another partial content is in spare block.
408 if (CompareMem ((UINT8
*) (UINTN
) SpareAddress
, (UINT8
*) Name2
+ PartialNameSize
, NameSize
- PartialNameSize
) == 0) {
413 } else if (((UINTN
) Name2
< (UINTN
) TargetAddress
) && (((UINTN
) Name2
+ NameSize
) > (UINTN
) TargetAddress
)) {
415 // Name2 is inconsecutive.
417 PartialNameSize
= (UINTN
) TargetAddress
- (UINTN
) Name2
;
419 // Partial content is in NV storage.
421 if (CompareMem ((UINT8
*) Name2
, (UINT8
*) Name1
, PartialNameSize
) == 0) {
423 // Another partial content is in spare block.
425 if (CompareMem ((UINT8
*) (UINTN
) SpareAddress
, (UINT8
*) Name1
+ PartialNameSize
, NameSize
- PartialNameSize
) == 0) {
434 // Both Name1 and Name2 are consecutive.
436 if (CompareMem ((UINT8
*) Name1
, (UINT8
*) Name2
, NameSize
) == 0) {
443 This function compares a variable with variable entries in database.
445 @param StoreInfo Pointer to variable store info structure.
446 @param Variable Pointer to the variable in our database
447 @param VariableHeader Pointer to the Variable Header that has consecutive content.
448 @param VariableName Name of the variable to compare to 'Variable'
449 @param VendorGuid GUID of the variable to compare to 'Variable'
450 @param PtrTrack Variable Track Pointer structure that contains Variable Information.
452 @retval EFI_SUCCESS Found match variable
453 @retval EFI_NOT_FOUND Variable not found
457 CompareWithValidVariable (
458 IN VARIABLE_STORE_INFO
*StoreInfo
,
459 IN VARIABLE_HEADER
*Variable
,
460 IN VARIABLE_HEADER
*VariableHeader
,
461 IN CONST CHAR16
*VariableName
,
462 IN CONST EFI_GUID
*VendorGuid
,
463 OUT VARIABLE_POINTER_TRACK
*PtrTrack
467 EFI_GUID
*TempVendorGuid
;
469 TempVendorGuid
= GetVendorGuidPtr (VariableHeader
, StoreInfo
->AuthFlag
);
471 if (VariableName
[0] == 0) {
472 PtrTrack
->CurrPtr
= Variable
;
476 // Don't use CompareGuid function here for performance reasons.
477 // Instead we compare the GUID a UINT32 at a time and branch
478 // on the first failed comparison.
480 if ((((INT32
*) VendorGuid
)[0] == ((INT32
*) TempVendorGuid
)[0]) &&
481 (((INT32
*) VendorGuid
)[1] == ((INT32
*) TempVendorGuid
)[1]) &&
482 (((INT32
*) VendorGuid
)[2] == ((INT32
*) TempVendorGuid
)[2]) &&
483 (((INT32
*) VendorGuid
)[3] == ((INT32
*) TempVendorGuid
)[3])
485 ASSERT (NameSizeOfVariable (VariableHeader
, StoreInfo
->AuthFlag
) != 0);
486 Point
= (VOID
*) GetVariableNamePtr (Variable
, StoreInfo
->AuthFlag
);
487 if (CompareVariableName (StoreInfo
, VariableName
, Point
, NameSizeOfVariable (VariableHeader
, StoreInfo
->AuthFlag
))) {
488 PtrTrack
->CurrPtr
= Variable
;
494 return EFI_NOT_FOUND
;
498 Get HOB variable store.
500 @param[out] StoreInfo Return the store info.
501 @param[out] VariableStoreHeader Return variable store header.
505 GetHobVariableStore (
506 OUT VARIABLE_STORE_INFO
*StoreInfo
,
507 OUT VARIABLE_STORE_HEADER
**VariableStoreHeader
510 EFI_HOB_GUID_TYPE
*GuidHob
;
513 // Make sure there is no more than one Variable HOB.
516 GuidHob
= GetFirstGuidHob (&gEfiAuthenticatedVariableGuid
);
517 if (GuidHob
!= NULL
) {
518 if ((GetNextGuidHob (&gEfiAuthenticatedVariableGuid
, GET_NEXT_HOB (GuidHob
)) != NULL
)) {
519 DEBUG ((DEBUG_ERROR
, "ERROR: Found two Auth Variable HOBs\n"));
521 } else if (GetFirstGuidHob (&gEfiVariableGuid
) != NULL
) {
522 DEBUG ((DEBUG_ERROR
, "ERROR: Found one Auth + one Normal Variable HOBs\n"));
526 GuidHob
= GetFirstGuidHob (&gEfiVariableGuid
);
527 if (GuidHob
!= NULL
) {
528 if ((GetNextGuidHob (&gEfiVariableGuid
, GET_NEXT_HOB (GuidHob
)) != NULL
)) {
529 DEBUG ((DEBUG_ERROR
, "ERROR: Found two Normal Variable HOBs\n"));
536 GuidHob
= GetFirstGuidHob (&gEfiAuthenticatedVariableGuid
);
537 if (GuidHob
!= NULL
) {
538 *VariableStoreHeader
= (VARIABLE_STORE_HEADER
*) GET_GUID_HOB_DATA (GuidHob
);
539 StoreInfo
->AuthFlag
= TRUE
;
541 GuidHob
= GetFirstGuidHob (&gEfiVariableGuid
);
542 if (GuidHob
!= NULL
) {
543 *VariableStoreHeader
= (VARIABLE_STORE_HEADER
*) GET_GUID_HOB_DATA (GuidHob
);
544 StoreInfo
->AuthFlag
= FALSE
;
550 Return the variable store header and the store info based on the Index.
552 @param Type The type of the variable store.
553 @param StoreInfo Return the store info.
555 @return Pointer to the variable store header.
557 VARIABLE_STORE_HEADER
*
559 IN VARIABLE_STORE_TYPE Type
,
560 OUT VARIABLE_STORE_INFO
*StoreInfo
563 EFI_HOB_GUID_TYPE
*GuidHob
;
564 EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
;
565 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
566 EFI_PHYSICAL_ADDRESS NvStorageBase
;
567 UINT32 NvStorageSize
;
568 FAULT_TOLERANT_WRITE_LAST_WRITE_DATA
*FtwLastWriteData
;
571 StoreInfo
->IndexTable
= NULL
;
572 StoreInfo
->FtwLastWriteData
= NULL
;
573 StoreInfo
->AuthFlag
= FALSE
;
574 VariableStoreHeader
= NULL
;
576 case VariableStoreTypeHob
:
577 GetHobVariableStore (StoreInfo
, &VariableStoreHeader
);
581 case VariableStoreTypeNv
:
582 if (!PcdGetBool (PcdEmuVariableNvModeEnable
)) {
584 // Emulated non-volatile variable mode is not enabled.
587 NvStorageSize
= PcdGet32 (PcdFlashNvStorageVariableSize
);
588 NvStorageBase
= (EFI_PHYSICAL_ADDRESS
) (PcdGet64 (PcdFlashNvStorageVariableBase64
) != 0 ?
589 PcdGet64 (PcdFlashNvStorageVariableBase64
) :
590 PcdGet32 (PcdFlashNvStorageVariableBase
)
592 ASSERT (NvStorageBase
!= 0);
595 // First let FvHeader point to NV storage base.
597 FvHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*) (UINTN
) NvStorageBase
;
600 // Check the FTW last write data hob.
603 GuidHob
= GetFirstGuidHob (&gEdkiiFaultTolerantWriteGuid
);
604 if (GuidHob
!= NULL
) {
605 FtwLastWriteData
= (FAULT_TOLERANT_WRITE_LAST_WRITE_DATA
*) GET_GUID_HOB_DATA (GuidHob
);
606 if (FtwLastWriteData
->TargetAddress
== NvStorageBase
) {
608 // Let FvHeader point to spare block.
610 FvHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*) (UINTN
) FtwLastWriteData
->SpareAddress
;
611 DEBUG ((EFI_D_INFO
, "PeiVariable: NV storage is backed up in spare block: 0x%x\n", (UINTN
) FtwLastWriteData
->SpareAddress
));
612 } else if ((FtwLastWriteData
->TargetAddress
> NvStorageBase
) && (FtwLastWriteData
->TargetAddress
< (NvStorageBase
+ NvStorageSize
))) {
613 StoreInfo
->FtwLastWriteData
= FtwLastWriteData
;
615 // Flash NV storage from the offset is backed up in spare block.
617 BackUpOffset
= (UINT32
) (FtwLastWriteData
->TargetAddress
- NvStorageBase
);
618 DEBUG ((EFI_D_INFO
, "PeiVariable: High partial NV storage from offset: %x is backed up in spare block: 0x%x\n", BackUpOffset
, (UINTN
) FtwLastWriteData
->SpareAddress
));
620 // At least one block data in flash NV storage is still valid, so still leave FvHeader point to NV storage base.
626 // Check if the Firmware Volume is not corrupted
628 if ((FvHeader
->Signature
!= EFI_FVH_SIGNATURE
) || (!CompareGuid (&gEfiSystemNvDataFvGuid
, &FvHeader
->FileSystemGuid
))) {
629 DEBUG ((EFI_D_ERROR
, "Firmware Volume for Variable Store is corrupted\n"));
633 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*) ((UINT8
*) FvHeader
+ FvHeader
->HeaderLength
);
635 StoreInfo
->AuthFlag
= (BOOLEAN
) (CompareGuid (&VariableStoreHeader
->Signature
, &gEfiAuthenticatedVariableGuid
));
637 GuidHob
= GetFirstGuidHob (&gEfiVariableIndexTableGuid
);
638 if (GuidHob
!= NULL
) {
639 StoreInfo
->IndexTable
= GET_GUID_HOB_DATA (GuidHob
);
642 // If it's the first time to access variable region in flash, create a guid hob to record
643 // VAR_ADDED type variable info.
644 // Note that as the resource of PEI phase is limited, only store the limited number of
645 // VAR_ADDED type variables to reduce access time.
647 StoreInfo
->IndexTable
= (VARIABLE_INDEX_TABLE
*) BuildGuidHob (&gEfiVariableIndexTableGuid
, sizeof (VARIABLE_INDEX_TABLE
));
648 StoreInfo
->IndexTable
->Length
= 0;
649 StoreInfo
->IndexTable
->StartPtr
= GetStartPointer (VariableStoreHeader
);
650 StoreInfo
->IndexTable
->EndPtr
= GetEndPointer (VariableStoreHeader
);
651 StoreInfo
->IndexTable
->GoneThrough
= 0;
661 StoreInfo
->VariableStoreHeader
= VariableStoreHeader
;
662 return VariableStoreHeader
;
666 Get variable header that has consecutive content.
668 @param StoreInfo Pointer to variable store info structure.
669 @param Variable Pointer to the Variable Header.
670 @param VariableHeader Pointer to Pointer to the Variable Header that has consecutive content.
672 @retval TRUE Variable header is valid.
673 @retval FALSE Variable header is not valid.
678 IN VARIABLE_STORE_INFO
*StoreInfo
,
679 IN VARIABLE_HEADER
*Variable
,
680 OUT VARIABLE_HEADER
**VariableHeader
683 EFI_PHYSICAL_ADDRESS TargetAddress
;
684 EFI_PHYSICAL_ADDRESS SpareAddress
;
685 EFI_HOB_GUID_TYPE
*GuidHob
;
686 UINTN PartialHeaderSize
;
688 if (Variable
== NULL
) {
693 // First assume variable header pointed by Variable is consecutive.
695 *VariableHeader
= Variable
;
697 if (StoreInfo
->FtwLastWriteData
!= NULL
) {
698 TargetAddress
= StoreInfo
->FtwLastWriteData
->TargetAddress
;
699 SpareAddress
= StoreInfo
->FtwLastWriteData
->SpareAddress
;
700 if (((UINTN
) Variable
> (UINTN
) SpareAddress
) &&
701 (((UINTN
) Variable
- (UINTN
) SpareAddress
+ (UINTN
) TargetAddress
) >= (UINTN
) GetEndPointer (StoreInfo
->VariableStoreHeader
))) {
703 // Reach the end of variable store.
707 if (((UINTN
) Variable
< (UINTN
) TargetAddress
) && (((UINTN
) Variable
+ GetVariableHeaderSize (StoreInfo
->AuthFlag
)) > (UINTN
) TargetAddress
)) {
709 // Variable header pointed by Variable is inconsecutive,
710 // create a guid hob to combine the two partial variable header content together.
712 GuidHob
= GetFirstGuidHob (&gEfiCallerIdGuid
);
713 if (GuidHob
!= NULL
) {
714 *VariableHeader
= (VARIABLE_HEADER
*) GET_GUID_HOB_DATA (GuidHob
);
716 *VariableHeader
= (VARIABLE_HEADER
*) BuildGuidHob (&gEfiCallerIdGuid
, GetVariableHeaderSize (StoreInfo
->AuthFlag
));
717 PartialHeaderSize
= (UINTN
) TargetAddress
- (UINTN
) Variable
;
719 // Partial content is in NV storage.
721 CopyMem ((UINT8
*) *VariableHeader
, (UINT8
*) Variable
, PartialHeaderSize
);
723 // Another partial content is in spare block.
725 CopyMem ((UINT8
*) *VariableHeader
+ PartialHeaderSize
, (UINT8
*) (UINTN
) SpareAddress
, GetVariableHeaderSize (StoreInfo
->AuthFlag
) - PartialHeaderSize
);
729 if (Variable
>= GetEndPointer (StoreInfo
->VariableStoreHeader
)) {
731 // Reach the end of variable store.
737 return IsValidVariableHeader (*VariableHeader
);
741 Get variable name or data to output buffer.
743 @param StoreInfo Pointer to variable store info structure.
744 @param NameOrData Pointer to the variable name/data that may be inconsecutive.
745 @param Size Variable name/data size.
746 @param Buffer Pointer to output buffer to hold the variable name/data.
750 GetVariableNameOrData (
751 IN VARIABLE_STORE_INFO
*StoreInfo
,
752 IN UINT8
*NameOrData
,
757 EFI_PHYSICAL_ADDRESS TargetAddress
;
758 EFI_PHYSICAL_ADDRESS SpareAddress
;
761 if (StoreInfo
->FtwLastWriteData
!= NULL
) {
762 TargetAddress
= StoreInfo
->FtwLastWriteData
->TargetAddress
;
763 SpareAddress
= StoreInfo
->FtwLastWriteData
->SpareAddress
;
764 if (((UINTN
) NameOrData
< (UINTN
) TargetAddress
) && (((UINTN
) NameOrData
+ Size
) > (UINTN
) TargetAddress
)) {
766 // Variable name/data is inconsecutive.
768 PartialSize
= (UINTN
) TargetAddress
- (UINTN
) NameOrData
;
770 // Partial content is in NV storage.
772 CopyMem (Buffer
, NameOrData
, PartialSize
);
774 // Another partial content is in spare block.
776 CopyMem (Buffer
+ PartialSize
, (UINT8
*) (UINTN
) SpareAddress
, Size
- PartialSize
);
782 // Variable name/data is consecutive.
784 CopyMem (Buffer
, NameOrData
, Size
);
788 Find the variable in the specified variable store.
790 @param StoreInfo Pointer to the store info structure.
791 @param VariableName Name of the variable to be found
792 @param VendorGuid Vendor GUID to be found.
793 @param PtrTrack Variable Track Pointer structure that contains Variable Information.
795 @retval EFI_SUCCESS Variable found successfully
796 @retval EFI_NOT_FOUND Variable not found
797 @retval EFI_INVALID_PARAMETER Invalid variable name
802 IN VARIABLE_STORE_INFO
*StoreInfo
,
803 IN CONST CHAR16
*VariableName
,
804 IN CONST EFI_GUID
*VendorGuid
,
805 OUT VARIABLE_POINTER_TRACK
*PtrTrack
808 VARIABLE_HEADER
*Variable
;
809 VARIABLE_HEADER
*LastVariable
;
810 VARIABLE_HEADER
*MaxIndex
;
814 VARIABLE_HEADER
*InDeletedVariable
;
815 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
816 VARIABLE_INDEX_TABLE
*IndexTable
;
817 VARIABLE_HEADER
*VariableHeader
;
819 VariableStoreHeader
= StoreInfo
->VariableStoreHeader
;
821 if (VariableStoreHeader
== NULL
) {
822 return EFI_INVALID_PARAMETER
;
825 if (GetVariableStoreStatus (VariableStoreHeader
) != EfiValid
) {
826 return EFI_UNSUPPORTED
;
829 if (~VariableStoreHeader
->Size
== 0) {
830 return EFI_NOT_FOUND
;
833 IndexTable
= StoreInfo
->IndexTable
;
834 PtrTrack
->StartPtr
= GetStartPointer (VariableStoreHeader
);
835 PtrTrack
->EndPtr
= GetEndPointer (VariableStoreHeader
);
837 InDeletedVariable
= NULL
;
840 // No Variable Address equals zero, so 0 as initial value is safe.
843 VariableHeader
= NULL
;
845 if (IndexTable
!= NULL
) {
847 // traverse the variable index table to look for varible.
848 // The IndexTable->Index[Index] records the distance of two neighbouring VAR_ADDED type variables.
850 for (Offset
= 0, Index
= 0; Index
< IndexTable
->Length
; Index
++) {
851 ASSERT (Index
< sizeof (IndexTable
->Index
) / sizeof (IndexTable
->Index
[0]));
852 Offset
+= IndexTable
->Index
[Index
];
853 MaxIndex
= (VARIABLE_HEADER
*) ((UINT8
*) IndexTable
->StartPtr
+ Offset
);
854 GetVariableHeader (StoreInfo
, MaxIndex
, &VariableHeader
);
855 if (CompareWithValidVariable (StoreInfo
, MaxIndex
, VariableHeader
, VariableName
, VendorGuid
, PtrTrack
) == EFI_SUCCESS
) {
856 if (VariableHeader
->State
== (VAR_IN_DELETED_TRANSITION
& VAR_ADDED
)) {
857 InDeletedVariable
= PtrTrack
->CurrPtr
;
864 if (IndexTable
->GoneThrough
!= 0) {
866 // If the table has all the existing variables indexed, return.
868 PtrTrack
->CurrPtr
= InDeletedVariable
;
869 return (PtrTrack
->CurrPtr
== NULL
) ? EFI_NOT_FOUND
: EFI_SUCCESS
;
873 if (MaxIndex
!= NULL
) {
875 // HOB exists but the variable cannot be found in HOB
876 // If not found in HOB, then let's start from the MaxIndex we've found.
878 Variable
= GetNextVariablePtr (StoreInfo
, MaxIndex
, VariableHeader
);
879 LastVariable
= MaxIndex
;
882 // Start Pointers for the variable.
883 // Actual Data Pointer where data can be written.
885 Variable
= PtrTrack
->StartPtr
;
886 LastVariable
= PtrTrack
->StartPtr
;
890 // Find the variable by walk through variable store
893 while (GetVariableHeader (StoreInfo
, Variable
, &VariableHeader
)) {
894 if (VariableHeader
->State
== VAR_ADDED
|| VariableHeader
->State
== (VAR_IN_DELETED_TRANSITION
& VAR_ADDED
)) {
896 // Record Variable in VariableIndex HOB
898 if ((IndexTable
!= NULL
) && !StopRecord
) {
899 Offset
= (UINTN
) Variable
- (UINTN
) LastVariable
;
900 if ((Offset
> 0x0FFFF) || (IndexTable
->Length
>= sizeof (IndexTable
->Index
) / sizeof (IndexTable
->Index
[0]))) {
902 // Stop to record if the distance of two neighbouring VAR_ADDED variable is larger than the allowable scope(UINT16),
903 // or the record buffer is full.
907 IndexTable
->Index
[IndexTable
->Length
++] = (UINT16
) Offset
;
908 LastVariable
= Variable
;
912 if (CompareWithValidVariable (StoreInfo
, Variable
, VariableHeader
, VariableName
, VendorGuid
, PtrTrack
) == EFI_SUCCESS
) {
913 if (VariableHeader
->State
== (VAR_IN_DELETED_TRANSITION
& VAR_ADDED
)) {
914 InDeletedVariable
= PtrTrack
->CurrPtr
;
921 Variable
= GetNextVariablePtr (StoreInfo
, Variable
, VariableHeader
);
924 // If gone through the VariableStore, that means we never find in Firmware any more.
926 if ((IndexTable
!= NULL
) && !StopRecord
) {
927 IndexTable
->GoneThrough
= 1;
930 PtrTrack
->CurrPtr
= InDeletedVariable
;
932 return (PtrTrack
->CurrPtr
== NULL
) ? EFI_NOT_FOUND
: EFI_SUCCESS
;
936 Find the variable in HOB and Non-Volatile variable storages.
938 @param VariableName Name of the variable to be found
939 @param VendorGuid Vendor GUID to be found.
940 @param PtrTrack Variable Track Pointer structure that contains Variable Information.
941 @param StoreInfo Return the store info.
943 @retval EFI_SUCCESS Variable found successfully
944 @retval EFI_NOT_FOUND Variable not found
945 @retval EFI_INVALID_PARAMETER Invalid variable name
949 IN CONST CHAR16
*VariableName
,
950 IN CONST EFI_GUID
*VendorGuid
,
951 OUT VARIABLE_POINTER_TRACK
*PtrTrack
,
952 OUT VARIABLE_STORE_INFO
*StoreInfo
956 VARIABLE_STORE_TYPE Type
;
958 if (VariableName
[0] != 0 && VendorGuid
== NULL
) {
959 return EFI_INVALID_PARAMETER
;
962 for (Type
= (VARIABLE_STORE_TYPE
) 0; Type
< VariableStoreTypeMax
; Type
++) {
963 GetVariableStore (Type
, StoreInfo
);
964 Status
= FindVariableEx (
970 if (!EFI_ERROR (Status
)) {
975 return EFI_NOT_FOUND
;
979 This service retrieves a variable's value using its name and GUID.
981 Read the specified variable from the UEFI variable store. If the Data
982 buffer is too small to hold the contents of the variable, the error
983 EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the required buffer
984 size to obtain the data.
986 @param This A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.
987 @param VariableName A pointer to a null-terminated string that is the variable's name.
988 @param VariableGuid A pointer to an EFI_GUID that is the variable's GUID. The combination of
989 VariableGuid and VariableName must be unique.
990 @param Attributes If non-NULL, on return, points to the variable's attributes.
991 @param DataSize On entry, points to the size in bytes of the Data buffer.
992 On return, points to the size of the data returned in Data.
993 @param Data Points to the buffer which will hold the returned variable value.
994 May be NULL with a zero DataSize in order to determine the size of the buffer needed.
996 @retval EFI_SUCCESS The variable was read successfully.
997 @retval EFI_NOT_FOUND The variable was be found.
998 @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the resulting data.
999 DataSize is updated with the size required for
1000 the specified variable.
1001 @retval EFI_INVALID_PARAMETER VariableName, VariableGuid, DataSize or Data is NULL.
1002 @retval EFI_DEVICE_ERROR The variable could not be retrieved because of a device error.
1008 IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI
*This
,
1009 IN CONST CHAR16
*VariableName
,
1010 IN CONST EFI_GUID
*VariableGuid
,
1011 OUT UINT32
*Attributes
,
1012 IN OUT UINTN
*DataSize
,
1013 OUT VOID
*Data OPTIONAL
1016 VARIABLE_POINTER_TRACK Variable
;
1019 VARIABLE_STORE_INFO StoreInfo
;
1020 VARIABLE_HEADER
*VariableHeader
;
1022 if (VariableName
== NULL
|| VariableGuid
== NULL
|| DataSize
== NULL
) {
1023 return EFI_INVALID_PARAMETER
;
1026 if (VariableName
[0] == 0) {
1027 return EFI_NOT_FOUND
;
1030 VariableHeader
= NULL
;
1033 // Find existing variable
1035 Status
= FindVariable (VariableName
, VariableGuid
, &Variable
, &StoreInfo
);
1036 if (EFI_ERROR (Status
)) {
1039 GetVariableHeader (&StoreInfo
, Variable
.CurrPtr
, &VariableHeader
);
1044 VarDataSize
= DataSizeOfVariable (VariableHeader
, StoreInfo
.AuthFlag
);
1045 if (*DataSize
>= VarDataSize
) {
1047 return EFI_INVALID_PARAMETER
;
1050 GetVariableNameOrData (&StoreInfo
, GetVariableDataPtr (Variable
.CurrPtr
, VariableHeader
, StoreInfo
.AuthFlag
), VarDataSize
, Data
);
1051 Status
= EFI_SUCCESS
;
1053 Status
= EFI_BUFFER_TOO_SMALL
;
1056 if (Attributes
!= NULL
) {
1057 *Attributes
= VariableHeader
->Attributes
;
1059 *DataSize
= VarDataSize
;
1065 Return the next variable name and GUID.
1067 This function is called multiple times to retrieve the VariableName
1068 and VariableGuid of all variables currently available in the system.
1069 On each call, the previous results are passed into the interface,
1070 and, on return, the interface returns the data for the next
1071 interface. When the entire variable list has been returned,
1072 EFI_NOT_FOUND is returned.
1074 @param This A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.
1076 @param VariableNameSize On entry, points to the size of the buffer pointed to by VariableName.
1077 On return, the size of the variable name buffer.
1078 @param VariableName On entry, a pointer to a null-terminated string that is the variable's name.
1079 On return, points to the next variable's null-terminated name string.
1080 @param VariableGuid On entry, a pointer to an EFI_GUID that is the variable's GUID.
1081 On return, a pointer to the next variable's GUID.
1083 @retval EFI_SUCCESS The variable was read successfully.
1084 @retval EFI_NOT_FOUND The variable could not be found.
1085 @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the resulting
1086 data. VariableNameSize is updated with the size
1087 required for the specified variable.
1088 @retval EFI_INVALID_PARAMETER VariableName, VariableGuid or
1089 VariableNameSize is NULL.
1090 @retval EFI_DEVICE_ERROR The variable could not be retrieved because of a device error.
1095 PeiGetNextVariableName (
1096 IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI
*This
,
1097 IN OUT UINTN
*VariableNameSize
,
1098 IN OUT CHAR16
*VariableName
,
1099 IN OUT EFI_GUID
*VariableGuid
1102 VARIABLE_STORE_TYPE Type
;
1103 VARIABLE_POINTER_TRACK Variable
;
1104 VARIABLE_POINTER_TRACK VariableInHob
;
1105 VARIABLE_POINTER_TRACK VariablePtrTrack
;
1108 VARIABLE_STORE_HEADER
*VariableStoreHeader
[VariableStoreTypeMax
];
1109 VARIABLE_HEADER
*VariableHeader
;
1110 VARIABLE_STORE_INFO StoreInfo
;
1111 VARIABLE_STORE_INFO StoreInfoForNv
;
1112 VARIABLE_STORE_INFO StoreInfoForHob
;
1114 if (VariableName
== NULL
|| VariableGuid
== NULL
|| VariableNameSize
== NULL
) {
1115 return EFI_INVALID_PARAMETER
;
1118 VariableHeader
= NULL
;
1120 Status
= FindVariable (VariableName
, VariableGuid
, &Variable
, &StoreInfo
);
1121 if (Variable
.CurrPtr
== NULL
|| Status
!= EFI_SUCCESS
) {
1125 if (VariableName
[0] != 0) {
1127 // If variable name is not NULL, get next variable
1129 GetVariableHeader (&StoreInfo
, Variable
.CurrPtr
, &VariableHeader
);
1130 Variable
.CurrPtr
= GetNextVariablePtr (&StoreInfo
, Variable
.CurrPtr
, VariableHeader
);
1133 VariableStoreHeader
[VariableStoreTypeHob
] = GetVariableStore (VariableStoreTypeHob
, &StoreInfoForHob
);
1134 VariableStoreHeader
[VariableStoreTypeNv
] = GetVariableStore (VariableStoreTypeNv
, &StoreInfoForNv
);
1138 // Switch from HOB to Non-Volatile.
1140 while (!GetVariableHeader (&StoreInfo
, Variable
.CurrPtr
, &VariableHeader
)) {
1142 // Find current storage index
1144 for (Type
= (VARIABLE_STORE_TYPE
) 0; Type
< VariableStoreTypeMax
; Type
++) {
1145 if ((VariableStoreHeader
[Type
] != NULL
) && (Variable
.StartPtr
== GetStartPointer (VariableStoreHeader
[Type
]))) {
1149 ASSERT (Type
< VariableStoreTypeMax
);
1151 // Switch to next storage
1153 for (Type
++; Type
< VariableStoreTypeMax
; Type
++) {
1154 if (VariableStoreHeader
[Type
] != NULL
) {
1159 // Capture the case that
1160 // 1. current storage is the last one, or
1161 // 2. no further storage
1163 if (Type
== VariableStoreTypeMax
) {
1164 return EFI_NOT_FOUND
;
1166 Variable
.StartPtr
= GetStartPointer (VariableStoreHeader
[Type
]);
1167 Variable
.EndPtr
= GetEndPointer (VariableStoreHeader
[Type
]);
1168 Variable
.CurrPtr
= Variable
.StartPtr
;
1169 GetVariableStore (Type
, &StoreInfo
);
1172 if (VariableHeader
->State
== VAR_ADDED
|| VariableHeader
->State
== (VAR_IN_DELETED_TRANSITION
& VAR_ADDED
)) {
1173 if (VariableHeader
->State
== (VAR_IN_DELETED_TRANSITION
& VAR_ADDED
)) {
1175 // If it is a IN_DELETED_TRANSITION variable,
1176 // and there is also a same ADDED one at the same time,
1179 Status
= FindVariableEx (
1181 GetVariableNamePtr (Variable
.CurrPtr
, StoreInfo
.AuthFlag
),
1182 GetVendorGuidPtr (VariableHeader
, StoreInfo
.AuthFlag
),
1185 if (!EFI_ERROR (Status
) && VariablePtrTrack
.CurrPtr
!= Variable
.CurrPtr
) {
1186 Variable
.CurrPtr
= GetNextVariablePtr (&StoreInfo
, Variable
.CurrPtr
, VariableHeader
);
1192 // Don't return NV variable when HOB overrides it
1194 if ((VariableStoreHeader
[VariableStoreTypeHob
] != NULL
) && (VariableStoreHeader
[VariableStoreTypeNv
] != NULL
) &&
1195 (Variable
.StartPtr
== GetStartPointer (VariableStoreHeader
[VariableStoreTypeNv
]))
1197 Status
= FindVariableEx (
1199 GetVariableNamePtr (Variable
.CurrPtr
, StoreInfo
.AuthFlag
),
1200 GetVendorGuidPtr (VariableHeader
, StoreInfo
.AuthFlag
),
1203 if (!EFI_ERROR (Status
)) {
1204 Variable
.CurrPtr
= GetNextVariablePtr (&StoreInfo
, Variable
.CurrPtr
, VariableHeader
);
1209 VarNameSize
= NameSizeOfVariable (VariableHeader
, StoreInfo
.AuthFlag
);
1210 ASSERT (VarNameSize
!= 0);
1212 if (VarNameSize
<= *VariableNameSize
) {
1213 GetVariableNameOrData (&StoreInfo
, (UINT8
*) GetVariableNamePtr (Variable
.CurrPtr
, StoreInfo
.AuthFlag
), VarNameSize
, (UINT8
*) VariableName
);
1215 CopyMem (VariableGuid
, GetVendorGuidPtr (VariableHeader
, StoreInfo
.AuthFlag
), sizeof (EFI_GUID
));
1217 Status
= EFI_SUCCESS
;
1219 Status
= EFI_BUFFER_TOO_SMALL
;
1222 *VariableNameSize
= VarNameSize
;
1224 // Variable is found
1228 Variable
.CurrPtr
= GetNextVariablePtr (&StoreInfo
, Variable
.CurrPtr
, VariableHeader
);