2 Help functions used by PCD DXE driver.
4 Copyright (c) 2014, Hewlett-Packard Development Company, L.P.<BR>
5 Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
6 (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #include <Library/DxeServicesLib.h>
20 PCD_DATABASE mPcdDatabase
;
22 UINT32 mPcdTotalTokenCount
;
23 UINT32 mPeiLocalTokenCount
;
24 UINT32 mDxeLocalTokenCount
;
25 UINT32 mPeiNexTokenCount
;
26 UINT32 mDxeNexTokenCount
;
27 UINT32 mPeiExMapppingTableSize
;
28 UINT32 mDxeExMapppingTableSize
;
29 UINT32 mPeiGuidTableSize
;
30 UINT32 mDxeGuidTableSize
;
32 BOOLEAN mPeiExMapTableEmpty
;
33 BOOLEAN mDxeExMapTableEmpty
;
34 BOOLEAN mPeiDatabaseEmpty
;
36 LIST_ENTRY
*mCallbackFnTable
;
37 EFI_GUID
**TmpTokenSpaceBuffer
;
38 UINTN TmpTokenSpaceBufferCount
;
41 Get Local Token Number by Token Number.
43 @param[in] IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
44 If FALSE, the pcd entry is initialized in DXE phase.
45 @param[in] TokenNumber The PCD token number.
47 @return Local Token Number.
56 UINT32
*LocalTokenNumberTable
;
57 UINT32 LocalTokenNumber
;
62 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
63 // We have to decrement TokenNumber by 1 to make it usable
64 // as the array index.
69 // Backup the TokenNumber passed in as GetPtrTypeSize need the original TokenNumber
71 TmpTokenNumber
= TokenNumber
;
73 LocalTokenNumberTable
= IsPeiDb
? (UINT32
*)((UINT8
*)mPcdDatabase
.PeiDb
+ mPcdDatabase
.PeiDb
->LocalTokenNumberTableOffset
) :
74 (UINT32
*)((UINT8
*)mPcdDatabase
.DxeDb
+ mPcdDatabase
.DxeDb
->LocalTokenNumberTableOffset
);
75 TokenNumber
= IsPeiDb
? TokenNumber
: TokenNumber
- mPeiLocalTokenCount
;
77 LocalTokenNumber
= LocalTokenNumberTable
[TokenNumber
];
79 Size
= (LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) >> PCD_DATUM_TYPE_SHIFT
;
81 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
83 GetPtrTypeSize (TmpTokenNumber
, &MaxSize
);
87 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, MaxSize
, IsPeiDb
);
90 return LocalTokenNumber
;
94 Get PCD type by Local Token Number.
96 @param[in] LocalTokenNumber The PCD local token number.
102 IN UINT32 LocalTokenNumber
105 switch (LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) {
106 case PCD_DATUM_TYPE_POINTER
:
107 return EFI_PCD_TYPE_PTR
;
108 case PCD_DATUM_TYPE_UINT8
:
109 if ((LocalTokenNumber
& PCD_DATUM_TYPE_UINT8_BOOLEAN
) == PCD_DATUM_TYPE_UINT8_BOOLEAN
) {
110 return EFI_PCD_TYPE_BOOL
;
112 return EFI_PCD_TYPE_8
;
114 case PCD_DATUM_TYPE_UINT16
:
115 return EFI_PCD_TYPE_16
;
116 case PCD_DATUM_TYPE_UINT32
:
117 return EFI_PCD_TYPE_32
;
118 case PCD_DATUM_TYPE_UINT64
:
119 return EFI_PCD_TYPE_64
;
122 return EFI_PCD_TYPE_8
;
129 @param[in] OnlyTokenSpaceName If TRUE, only need to get the TokenSpaceCName.
130 If FALSE, need to get the full PCD name.
131 @param[in] IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
132 If FALSE, the pcd entry is initialized in DXE phase.
133 @param[in] TokenNumber The PCD token number.
135 @return The TokenSpaceCName or full PCD name.
139 IN BOOLEAN OnlyTokenSpaceName
,
144 PCD_DATABASE_INIT
*Database
;
147 PCD_NAME_INDEX
*PcdNameIndex
;
148 CHAR8
*TokenSpaceName
;
153 // Return NULL when PCD name table is absent.
156 if (mPcdDatabase
.PeiDb
->PcdNameTableOffset
== 0) {
160 if (mPcdDatabase
.DxeDb
->PcdNameTableOffset
== 0) {
166 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
167 // We have to decrement TokenNumber by 1 to make it usable
168 // as the array index.
172 Database
= IsPeiDb
? mPcdDatabase
.PeiDb
: mPcdDatabase
.DxeDb
;
173 TokenNumber
= IsPeiDb
? TokenNumber
: TokenNumber
- mPeiLocalTokenCount
;
175 StringTable
= (UINT8
*) Database
+ Database
->StringTableOffset
;
178 // Get the PCD name index.
180 PcdNameIndex
= (PCD_NAME_INDEX
*)((UINT8
*) Database
+ Database
->PcdNameTableOffset
) + TokenNumber
;
181 TokenSpaceName
= (CHAR8
*)&StringTable
[PcdNameIndex
->TokenSpaceCNameIndex
];
182 PcdName
= (CHAR8
*)&StringTable
[PcdNameIndex
->PcdCNameIndex
];
184 if (OnlyTokenSpaceName
) {
186 // Only need to get the TokenSpaceCName.
188 Name
= AllocateCopyPool (AsciiStrSize (TokenSpaceName
), TokenSpaceName
);
191 // Need to get the full PCD name.
193 NameSize
= AsciiStrSize (TokenSpaceName
) + AsciiStrSize (PcdName
);
194 Name
= AllocateZeroPool (NameSize
);
195 ASSERT (Name
!= NULL
);
197 // Catenate TokenSpaceCName and PcdCName with a '.' to form the full PCD name.
199 AsciiStrCatS (Name
, NameSize
, TokenSpaceName
);
200 Name
[AsciiStrSize (TokenSpaceName
) - sizeof (CHAR8
)] = '.';
201 AsciiStrCatS (Name
, NameSize
, PcdName
);
208 Retrieve additional information associated with a PCD token.
210 This includes information such as the type of value the TokenNumber is associated with as well as possible
211 human readable name that is associated with the token.
213 @param[in] IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
214 If FALSE, the pcd entry is initialized in DXE phase.
215 @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
216 @param[in] TokenNumber The PCD token number.
217 @param[out] PcdInfo The returned information associated with the requested TokenNumber.
218 The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.
220 @retval EFI_SUCCESS The PCD information was returned successfully
221 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
226 IN CONST EFI_GUID
*Guid
,
227 IN UINTN TokenNumber
,
228 OUT EFI_PCD_INFO
*PcdInfo
231 PCD_DATABASE_INIT
*Database
;
235 DYNAMICEX_MAPPING
*ExMapTable
;
237 UINT32 LocalTokenNumber
;
239 Database
= IsPeiDb
? mPcdDatabase
.PeiDb
: mPcdDatabase
.DxeDb
;
241 GuidTable
= (EFI_GUID
*)((UINT8
*)Database
+ Database
->GuidTableOffset
);
242 MatchGuid
= ScanGuid (GuidTable
, Database
->GuidTableCount
* sizeof(EFI_GUID
), Guid
);
244 if (MatchGuid
== NULL
) {
245 return EFI_NOT_FOUND
;
248 GuidTableIdx
= MatchGuid
- GuidTable
;
250 ExMapTable
= (DYNAMICEX_MAPPING
*)((UINT8
*)Database
+ Database
->ExMapTableOffset
);
253 // Find the PCD by GuidTableIdx and ExTokenNumber in ExMapTable.
255 for (Index
= 0; Index
< Database
->ExTokenCount
; Index
++) {
256 if (ExMapTable
[Index
].ExGuidIndex
== GuidTableIdx
) {
257 if (TokenNumber
== PCD_INVALID_TOKEN_NUMBER
) {
259 // TokenNumber is 0, follow spec to set PcdType to EFI_PCD_TYPE_8,
260 // PcdSize to 0 and PcdName to the null-terminated ASCII string
261 // associated with the token's namespace Guid.
263 PcdInfo
->PcdType
= EFI_PCD_TYPE_8
;
264 PcdInfo
->PcdSize
= 0;
266 // Here use one representative in the token space to get the TokenSpaceCName.
268 PcdInfo
->PcdName
= GetPcdName (TRUE
, IsPeiDb
, ExMapTable
[Index
].TokenNumber
);
270 } else if (ExMapTable
[Index
].ExTokenNumber
== TokenNumber
) {
271 PcdInfo
->PcdSize
= DxePcdGetSize (ExMapTable
[Index
].TokenNumber
);
272 LocalTokenNumber
= GetLocalTokenNumber (IsPeiDb
, ExMapTable
[Index
].TokenNumber
);
273 PcdInfo
->PcdType
= GetPcdType (LocalTokenNumber
);
274 PcdInfo
->PcdName
= GetPcdName (FALSE
, IsPeiDb
, ExMapTable
[Index
].TokenNumber
);
280 return EFI_NOT_FOUND
;
284 Retrieve additional information associated with a PCD token.
286 This includes information such as the type of value the TokenNumber is associated with as well as possible
287 human readable name that is associated with the token.
289 @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
290 @param[in] TokenNumber The PCD token number.
291 @param[out] PcdInfo The returned information associated with the requested TokenNumber.
292 The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.
294 @retval EFI_SUCCESS The PCD information was returned successfully.
295 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
299 IN CONST EFI_GUID
*Guid
,
300 IN UINTN TokenNumber
,
301 OUT EFI_PCD_INFO
*PcdInfo
305 BOOLEAN PeiExMapTableEmpty
;
306 BOOLEAN DxeExMapTableEmpty
;
307 UINT32 LocalTokenNumber
;
310 ASSERT (PcdInfo
!= NULL
);
312 Status
= EFI_NOT_FOUND
;
313 PeiExMapTableEmpty
= mPeiExMapTableEmpty
;
314 DxeExMapTableEmpty
= mDxeExMapTableEmpty
;
317 if (((TokenNumber
+ 1 > mPeiNexTokenCount
+ 1) && (TokenNumber
+ 1 <= mPeiLocalTokenCount
+ 1)) ||
318 ((TokenNumber
+ 1 > (mPeiLocalTokenCount
+ mDxeNexTokenCount
+ 1)))) {
319 return EFI_NOT_FOUND
;
320 } else if (TokenNumber
== PCD_INVALID_TOKEN_NUMBER
) {
322 // TokenNumber is 0, follow spec to set PcdType to EFI_PCD_TYPE_8,
323 // PcdSize to 0 and PcdName to NULL for default Token Space.
325 PcdInfo
->PcdType
= EFI_PCD_TYPE_8
;
326 PcdInfo
->PcdSize
= 0;
327 PcdInfo
->PcdName
= NULL
;
329 PcdInfo
->PcdSize
= DxePcdGetSize (TokenNumber
);
331 if ((TokenNumber
+ 1 <= mPeiNexTokenCount
+ 1)) {
334 LocalTokenNumber
= GetLocalTokenNumber (IsPeiDb
, TokenNumber
);
335 PcdInfo
->PcdType
= GetPcdType (LocalTokenNumber
);
336 PcdInfo
->PcdName
= GetPcdName (FALSE
, IsPeiDb
, TokenNumber
);
341 if (PeiExMapTableEmpty
&& DxeExMapTableEmpty
) {
342 return EFI_NOT_FOUND
;
345 if (!PeiExMapTableEmpty
) {
346 Status
= ExGetPcdInfo (
354 if (Status
== EFI_SUCCESS
) {
358 if (!DxeExMapTableEmpty
) {
359 Status
= ExGetPcdInfo (
371 Get the PCD entry pointer in PCD database.
373 This routine will visit PCD database to find the PCD entry according to given
374 token number. The given token number is autogened by build tools and it will be
375 translated to local token number. Local token number contains PCD's type and
376 offset of PCD entry in PCD database.
378 @param TokenNumber Token's number, it is autogened by build tools
379 @param GetSize The size of token's value
381 @return PCD entry pointer in PCD database
386 IN UINTN TokenNumber
,
394 VARIABLE_HEAD
*VariableHead
;
395 UINT8
*VaraiableDefaultBuffer
;
400 UINTN TmpTokenNumber
;
403 UINT32 LocalTokenNumber
;
405 STRING_HEAD StringTableIdx
;
409 // Aquire lock to prevent reentrance from TPL_CALLBACK level
411 EfiAcquireLock (&mPcdDatabaseLock
);
415 ASSERT (TokenNumber
> 0);
417 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
418 // We have to decrement TokenNumber by 1 to make it usable
419 // as the array index.
423 TmpTokenNumber
= TokenNumber
;
426 // EBC compiler is very choosy. It may report warning about comparison
427 // between UINTN and 0 . So we add 1 in each size of the
430 ASSERT (TokenNumber
+ 1 < mPcdTotalTokenCount
+ 1);
432 ASSERT ((GetSize
== DxePcdGetSize (TokenNumber
+ 1)) || (GetSize
== 0));
434 // EBC compiler is very choosy. It may report warning about comparison
435 // between UINTN and 0 . So we add 1 in each size of the
437 IsPeiDb
= (BOOLEAN
) ((TokenNumber
+ 1 < mPeiLocalTokenCount
+ 1) ? TRUE
: FALSE
);
439 LocalTokenNumber
= GetLocalTokenNumber (IsPeiDb
, TokenNumber
+ 1);
441 PcdDb
= IsPeiDb
? ((UINT8
*) mPcdDatabase
.PeiDb
) : ((UINT8
*) mPcdDatabase
.DxeDb
);
444 StringTable
= (UINT8
*) ((UINT8
*)mPcdDatabase
.PeiDb
+ mPcdDatabase
.PeiDb
->StringTableOffset
);
446 StringTable
= (UINT8
*) ((UINT8
*)mPcdDatabase
.DxeDb
+ mPcdDatabase
.DxeDb
->StringTableOffset
);
450 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
452 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
454 VpdHead
= (VPD_HEAD
*) ((UINT8
*) PcdDb
+ Offset
);
455 RetPtr
= (VOID
*) (UINTN
) (PcdGet32 (PcdVpdBaseAddress
) + VpdHead
->Offset
);
459 case PCD_TYPE_HII
|PCD_TYPE_STRING
:
462 GuidTable
= (EFI_GUID
*) ((UINT8
*)mPcdDatabase
.PeiDb
+ mPcdDatabase
.PeiDb
->GuidTableOffset
);
464 GuidTable
= (EFI_GUID
*) ((UINT8
*)mPcdDatabase
.DxeDb
+ mPcdDatabase
.DxeDb
->GuidTableOffset
);
467 VariableHead
= (VARIABLE_HEAD
*) (PcdDb
+ Offset
);
468 Guid
= GuidTable
+ VariableHead
->GuidTableIndex
;
469 Name
= (UINT16
*)(StringTable
+ VariableHead
->StringIndex
);
471 if ((LocalTokenNumber
& PCD_TYPE_ALL_SET
) == (PCD_TYPE_HII
|PCD_TYPE_STRING
)) {
473 // If a HII type PCD's datum type is VOID*, the DefaultValueOffset is the index of
474 // string array in string table.
476 StringTableIdx
= *(STRING_HEAD
*)((UINT8
*) PcdDb
+ VariableHead
->DefaultValueOffset
);
477 VaraiableDefaultBuffer
= (UINT8
*) (StringTable
+ StringTableIdx
);
479 VaraiableDefaultBuffer
= (UINT8
*) PcdDb
+ VariableHead
->DefaultValueOffset
;
481 Status
= GetHiiVariable (Guid
, Name
, &Data
, &DataSize
);
482 if (Status
== EFI_SUCCESS
) {
483 if (DataSize
>= (VariableHead
->Offset
+ GetSize
)) {
486 // It is a pointer type. So get the MaxSize reserved for
489 GetPtrTypeSize (TmpTokenNumber
, &GetSize
);
490 if (GetSize
> (DataSize
- VariableHead
->Offset
)) {
492 // Use actual valid size.
494 GetSize
= DataSize
- VariableHead
->Offset
;
498 // If the operation is successful, we copy the data
499 // to the default value buffer in the PCD Database.
500 // So that we can free the Data allocated in GetHiiVariable.
502 CopyMem (VaraiableDefaultBuffer
, Data
+ VariableHead
->Offset
, GetSize
);
506 RetPtr
= (VOID
*) VaraiableDefaultBuffer
;
509 case PCD_TYPE_STRING
:
510 StringTableIdx
= *(STRING_HEAD
*)((UINT8
*) PcdDb
+ Offset
);
511 RetPtr
= (VOID
*) (StringTable
+ StringTableIdx
);
515 RetPtr
= (VOID
*) ((UINT8
*) PcdDb
+ Offset
);
524 EfiReleaseLock (&mPcdDatabaseLock
);
531 Register the callback function for a PCD entry.
533 This routine will register a callback function to a PCD entry by given token number
534 and token space guid.
536 @param TokenNumber PCD token's number, it is autogened by build tools.
537 @param Guid PCD token space's guid,
538 if not NULL, this PCD is dynamicEx type PCD.
539 @param CallBackFunction Callback function pointer
541 @return EFI_SUCCESS Always success for registering callback function.
545 DxeRegisterCallBackWorker (
546 IN UINTN TokenNumber
,
547 IN CONST EFI_GUID
*Guid
, OPTIONAL
548 IN PCD_PROTOCOL_CALLBACK CallBackFunction
551 CALLBACK_FN_ENTRY
*FnTableEntry
;
552 LIST_ENTRY
*ListHead
;
553 LIST_ENTRY
*ListNode
;
556 TokenNumber
= GetExPcdTokenNumber (Guid
, (UINT32
) TokenNumber
);
560 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
561 // We have to decrement TokenNumber by 1 to make it usable
562 // as the array index of mCallbackFnTable[].
564 ListHead
= &mCallbackFnTable
[TokenNumber
- 1];
565 ListNode
= GetFirstNode (ListHead
);
567 while (ListNode
!= ListHead
) {
568 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE(ListNode
, CALLBACK_FN_ENTRY
, Node
);
570 if (FnTableEntry
->CallbackFn
== CallBackFunction
) {
572 // We only allow a Callback function to be register once
573 // for a TokenNumber. So just return EFI_SUCCESS
577 ListNode
= GetNextNode (ListHead
, ListNode
);
580 FnTableEntry
= AllocatePool (sizeof(CALLBACK_FN_ENTRY
));
581 ASSERT (FnTableEntry
!= NULL
);
583 FnTableEntry
->CallbackFn
= CallBackFunction
;
584 InsertTailList (ListHead
, &FnTableEntry
->Node
);
590 UnRegister the callback function for a PCD entry.
592 This routine will unregister a callback function to a PCD entry by given token number
593 and token space guid.
595 @param TokenNumber PCD token's number, it is autogened by build tools.
596 @param Guid PCD token space's guid.
597 if not NULL, this PCD is dynamicEx type PCD.
598 @param CallBackFunction Callback function pointer
600 @retval EFI_SUCCESS Callback function is success to be unregister.
601 @retval EFI_INVALID_PARAMETER Can not find the PCD entry by given token number.
604 DxeUnRegisterCallBackWorker (
605 IN UINTN TokenNumber
,
606 IN CONST EFI_GUID
*Guid
, OPTIONAL
607 IN PCD_PROTOCOL_CALLBACK CallBackFunction
610 CALLBACK_FN_ENTRY
*FnTableEntry
;
611 LIST_ENTRY
*ListHead
;
612 LIST_ENTRY
*ListNode
;
615 TokenNumber
= GetExPcdTokenNumber (Guid
, (UINT32
) TokenNumber
);
619 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
620 // We have to decrement TokenNumber by 1 to make it usable
621 // as the array index of mCallbackFnTable[].
623 ListHead
= &mCallbackFnTable
[TokenNumber
- 1];
624 ListNode
= GetFirstNode (ListHead
);
626 while (ListNode
!= ListHead
) {
627 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE(ListNode
, CALLBACK_FN_ENTRY
, Node
);
629 if (FnTableEntry
->CallbackFn
== CallBackFunction
) {
631 // We only allow a Callback function to be register once
632 // for a TokenNumber. So we can safely remove the Node from
633 // the Link List and return EFI_SUCCESS.
635 RemoveEntryList (ListNode
);
636 FreePool (FnTableEntry
);
640 ListNode
= GetNextNode (ListHead
, ListNode
);
643 return EFI_INVALID_PARAMETER
;
647 Get next token number in given token space.
649 This routine is used for dynamicEx type PCD. It will firstly scan token space
650 table to get token space according to given token space guid. Then scan given
651 token number in found token space, if found, then return next token number in
654 @param Guid Token space guid. Next token number will be scaned in
656 @param TokenNumber Token number.
657 If PCD_INVALID_TOKEN_NUMBER, return first token number in
659 If not PCD_INVALID_TOKEN_NUMBER, return next token number
660 in token space table.
661 @param GuidTable Token space guid table. It will be used for scan token space
662 by given token space guid.
663 @param SizeOfGuidTable The size of guid table.
664 @param ExMapTable DynamicEx token number mapping table.
665 @param SizeOfExMapTable The size of dynamicEx token number mapping table.
667 @retval EFI_NOT_FOUND Can not given token space or token number.
668 @retval EFI_SUCCESS Success to get next token number.
672 ExGetNextTokeNumber (
673 IN CONST EFI_GUID
*Guid
,
674 IN OUT UINTN
*TokenNumber
,
675 IN EFI_GUID
*GuidTable
,
676 IN UINTN SizeOfGuidTable
,
677 IN DYNAMICEX_MAPPING
*ExMapTable
,
678 IN UINTN SizeOfExMapTable
685 UINTN ExMapTableCount
;
688 // Scan token space guid
690 MatchGuid
= ScanGuid (GuidTable
, SizeOfGuidTable
, Guid
);
691 if (MatchGuid
== NULL
) {
692 return EFI_NOT_FOUND
;
696 // Find the token space table in dynamicEx mapping table.
699 GuidTableIdx
= MatchGuid
- GuidTable
;
700 ExMapTableCount
= SizeOfExMapTable
/ sizeof(ExMapTable
[0]);
701 for (Index
= 0; Index
< ExMapTableCount
; Index
++) {
702 if (ExMapTable
[Index
].ExGuidIndex
== GuidTableIdx
) {
710 // If given token number is PCD_INVALID_TOKEN_NUMBER, then return the first
711 // token number in found token space.
713 if (*TokenNumber
== PCD_INVALID_TOKEN_NUMBER
) {
714 *TokenNumber
= ExMapTable
[Index
].ExTokenNumber
;
718 for ( ; Index
< ExMapTableCount
; Index
++) {
719 if ((ExMapTable
[Index
].ExTokenNumber
== *TokenNumber
) && (ExMapTable
[Index
].ExGuidIndex
== GuidTableIdx
)) {
724 while (Index
< ExMapTableCount
) {
726 if (Index
== ExMapTableCount
) {
728 // Exceed the length of ExMap Table
730 *TokenNumber
= PCD_INVALID_TOKEN_NUMBER
;
731 return EFI_NOT_FOUND
;
732 } else if (ExMapTable
[Index
].ExGuidIndex
== GuidTableIdx
) {
734 // Found the next match
736 *TokenNumber
= ExMapTable
[Index
].ExTokenNumber
;
742 return EFI_NOT_FOUND
;
746 Find the PCD database.
748 @retval The base address of external PCD database binary.
749 @retval NULL Return NULL if not find.
756 DXE_PCD_DATABASE
*DxePcdDbBinary
;
760 DxePcdDbBinary
= NULL
;
762 // Search the External Pcd database from one section of current FFS,
763 // and read it to memory
765 Status
= GetSectionFromFfs (
768 (VOID
**) &DxePcdDbBinary
,
771 ASSERT_EFI_ERROR (Status
);
774 // Check the first bytes (Header Signature Guid) and build version.
776 if (!CompareGuid ((VOID
*)DxePcdDbBinary
, &gPcdDataBaseSignatureGuid
) ||
777 (DxePcdDbBinary
->BuildVersion
!= PCD_SERVICE_DXE_VERSION
)) {
781 return DxePcdDbBinary
;
785 Initialize the PCD database in DXE phase.
787 PCD database in DXE phase also contains PCD database in PEI phase which is copied
792 BuildPcdDxeDataBase (
796 PEI_PCD_DATABASE
*PeiDatabase
;
797 EFI_HOB_GUID_TYPE
*GuidHob
;
803 // Assign PCD Entries with default value to PCD DATABASE
805 mPcdDatabase
.DxeDb
= LocateExPcdBinary ();
806 ASSERT(mPcdDatabase
.DxeDb
!= NULL
);
807 PcdDxeDbLen
= mPcdDatabase
.DxeDb
->Length
+ mPcdDatabase
.DxeDb
->UninitDataBaseSize
;
808 PcdDxeDb
= AllocateZeroPool (PcdDxeDbLen
);
809 ASSERT (PcdDxeDb
!= NULL
);
810 CopyMem (PcdDxeDb
, mPcdDatabase
.DxeDb
, mPcdDatabase
.DxeDb
->Length
);
811 FreePool (mPcdDatabase
.DxeDb
);
812 mPcdDatabase
.DxeDb
= PcdDxeDb
;
814 GuidHob
= GetFirstGuidHob (&gPcdDataBaseHobGuid
);
815 if (GuidHob
!= NULL
) {
818 // If no PEIMs use dynamic Pcd Entry, the Pcd Service PEIM
819 // should not be included at all. So the GuidHob could
820 // be NULL. If it is NULL, we just copy over the DXE Default
821 // Value to PCD Database.
824 PeiDatabase
= (PEI_PCD_DATABASE
*) GET_GUID_HOB_DATA (GuidHob
);
826 // Assign PCD Entries refereneced in PEI phase to PCD DATABASE
828 mPcdDatabase
.PeiDb
= PeiDatabase
;
830 // Inherit the SystemSkuId from PEI phase.
832 mPcdDatabase
.DxeDb
->SystemSkuId
= mPcdDatabase
.PeiDb
->SystemSkuId
;
834 mPcdDatabase
.PeiDb
= AllocateZeroPool (sizeof (PEI_PCD_DATABASE
));
835 ASSERT(mPcdDatabase
.PeiDb
!= NULL
);
839 // Initialized the external PCD database local variables
841 mPeiLocalTokenCount
= mPcdDatabase
.PeiDb
->LocalTokenCount
;
842 mDxeLocalTokenCount
= mPcdDatabase
.DxeDb
->LocalTokenCount
;
844 mPeiExMapppingTableSize
= mPcdDatabase
.PeiDb
->ExTokenCount
* sizeof (DYNAMICEX_MAPPING
);
845 mDxeExMapppingTableSize
= mPcdDatabase
.DxeDb
->ExTokenCount
* sizeof (DYNAMICEX_MAPPING
);
846 mPeiGuidTableSize
= mPcdDatabase
.PeiDb
->GuidTableCount
* sizeof(GUID
);
847 mDxeGuidTableSize
= mPcdDatabase
.DxeDb
->GuidTableCount
* sizeof (GUID
);
849 mPcdTotalTokenCount
= mPeiLocalTokenCount
+ mDxeLocalTokenCount
;
850 mPeiNexTokenCount
= mPeiLocalTokenCount
- mPcdDatabase
.PeiDb
->ExTokenCount
;
851 mDxeNexTokenCount
= mDxeLocalTokenCount
- mPcdDatabase
.DxeDb
->ExTokenCount
;
853 mPeiExMapTableEmpty
= (mPcdDatabase
.PeiDb
->ExTokenCount
== 0) ? TRUE
: FALSE
;
854 mDxeExMapTableEmpty
= (mPcdDatabase
.DxeDb
->ExTokenCount
== 0) ? TRUE
: FALSE
;
855 mPeiDatabaseEmpty
= (mPeiLocalTokenCount
== 0) ? TRUE
: FALSE
;
857 TmpTokenSpaceBufferCount
= mPcdDatabase
.PeiDb
->ExTokenCount
+ mPcdDatabase
.DxeDb
->ExTokenCount
;
858 TmpTokenSpaceBuffer
= (EFI_GUID
**)AllocateZeroPool(TmpTokenSpaceBufferCount
* sizeof (EFI_GUID
*));
861 // Initialized the Callback Function Table
863 mCallbackFnTable
= AllocateZeroPool (mPcdTotalTokenCount
* sizeof (LIST_ENTRY
));
864 ASSERT(mCallbackFnTable
!= NULL
);
867 // EBC compiler is very choosy. It may report warning about comparison
868 // between UINTN and 0 . So we add 1 in each size of the
871 for (Index
= 0; Index
+ 1 < mPcdTotalTokenCount
+ 1; Index
++) {
872 InitializeListHead (&mCallbackFnTable
[Index
]);
877 Get Variable which contains HII type PCD entry.
879 @param VariableGuid Variable's guid
880 @param VariableName Variable's unicode name string
881 @param VariableData Variable's data pointer,
882 @param VariableSize Variable's size.
884 @return the status of gRT->GetVariable
888 IN EFI_GUID
*VariableGuid
,
889 IN UINT16
*VariableName
,
890 OUT UINT8
**VariableData
,
891 OUT UINTN
*VariableSize
902 // Firstly get the real size of HII variable
904 Status
= gRT
->GetVariable (
905 (UINT16
*)VariableName
,
913 // Allocate buffer to hold whole variable data according to variable size.
915 if (Status
== EFI_BUFFER_TOO_SMALL
) {
916 Buffer
= (UINT8
*) AllocatePool (Size
);
918 ASSERT (Buffer
!= NULL
);
920 Status
= gRT
->GetVariable (
928 ASSERT (Status
== EFI_SUCCESS
);
929 *VariableData
= Buffer
;
930 *VariableSize
= Size
;
933 // Use Default Data only when variable is not found.
934 // For other error status, correct data can't be got, and trig ASSERT().
936 ASSERT (Status
== EFI_NOT_FOUND
);
943 Find the local token number according to system SKU ID.
945 @param LocalTokenNumber PCD token number
946 @param Size The size of PCD entry.
947 @param IsPeiDb If TRUE, the PCD entry is initialized in PEI phase.
948 If False, the PCD entry is initialized in DXE phase.
950 @return Token number according to system SKU ID.
954 GetSkuEnabledTokenNumber (
955 UINT32 LocalTokenNumber
,
967 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0);
969 PcdDb
= IsPeiDb
? (UINT8
*) mPcdDatabase
.PeiDb
: (UINT8
*) mPcdDatabase
.DxeDb
;
971 SkuHead
= (SKU_HEAD
*) (PcdDb
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
972 Value
= (UINT8
*) (PcdDb
+ SkuHead
->SkuDataStartOffset
);
974 SkuIdTable
= (SKU_ID
*)(PcdDb
+ SkuHead
->SkuIdTableOffset
);
976 // Find the current system's SKU ID entry in SKU ID table.
979 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
980 if (mPcdDatabase
.DxeDb
->SystemSkuId
== SkuIdTable
[Index
+ 1]) {
987 // Find the default SKU ID entry in SKU ID table.
991 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
992 if (0 == SkuIdTable
[Index
+ 1]) {
997 ASSERT (Index
< SkuIdTable
[0]);
999 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
1001 Value
= (UINT8
*) &(((VPD_HEAD
*) Value
)[Index
]);
1002 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_VPD
);
1005 Value
= (UINT8
*) &(((VARIABLE_HEAD
*) Value
)[Index
]);
1006 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_HII
);
1008 case PCD_TYPE_HII
|PCD_TYPE_STRING
:
1009 Value
= (UINT8
*) &(((VARIABLE_HEAD
*) Value
)[Index
]);
1010 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_HII
| PCD_TYPE_STRING
);
1012 case PCD_TYPE_STRING
:
1013 Value
= (UINT8
*) &(((STRING_HEAD
*) Value
)[Index
]);
1014 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_STRING
);
1017 Value
+= Size
* Index
;
1018 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_DATA
);
1031 Invoke the callback function when dynamic PCD entry was set, if this PCD entry
1032 has registered callback function.
1034 @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx
1036 @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type
1038 @param TokenNumber PCD token number generated by build tools.
1039 @param Data Value want to be set for this PCD entry
1040 @param Size The size of value
1044 InvokeCallbackOnSet (
1045 UINT32 ExTokenNumber
,
1046 CONST EFI_GUID
*Guid
, OPTIONAL
1052 CALLBACK_FN_ENTRY
*FnTableEntry
;
1053 LIST_ENTRY
*ListHead
;
1054 LIST_ENTRY
*ListNode
;
1057 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
1058 // We have to decrement TokenNumber by 1 to make it usable
1059 // as the array index of mCallbackFnTable[].
1061 ListHead
= &mCallbackFnTable
[TokenNumber
- 1];
1062 ListNode
= GetFirstNode (ListHead
);
1064 while (ListNode
!= ListHead
) {
1065 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE (ListNode
, CALLBACK_FN_ENTRY
, Node
);
1067 FnTableEntry
->CallbackFn(Guid
,
1068 (Guid
== NULL
) ? TokenNumber
: ExTokenNumber
,
1072 ListNode
= GetNextNode (ListHead
, ListNode
);
1080 Wrapper function for setting non-pointer type value for a PCD entry.
1082 @param TokenNumber Pcd token number autogenerated by build tools.
1083 @param Data Value want to be set for PCD entry
1084 @param Size Size of value.
1086 @return status of SetWorker.
1091 IN UINTN TokenNumber
,
1096 return SetWorker (TokenNumber
, Data
, &Size
, FALSE
);
1101 Set value for an PCD entry
1103 @param TokenNumber Pcd token number autogenerated by build tools.
1104 @param Data Value want to be set for PCD entry
1105 @param Size Size of value.
1106 @param PtrType If TRUE, the type of PCD entry's value is Pointer.
1107 If False, the type of PCD entry's value is not Pointer.
1109 @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.
1110 @retval EFI_INVALID_PARAMETER If Size can not be set to size table.
1111 @retval EFI_INVALID_PARAMETER If Size of non-Ptr type PCD does not match the size information in PCD database.
1112 @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in
1113 range of UINT8, UINT16, UINT32, UINT64
1114 @retval EFI_NOT_FOUND Can not find the PCD type according to token number.
1118 IN UINTN TokenNumber
,
1125 UINT32 LocalTokenNumber
;
1126 EFI_GUID
*GuidTable
;
1130 UINTN VariableOffset
;
1133 VARIABLE_HEAD
*VariableHead
;
1138 UINTN TmpTokenNumber
;
1141 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
1142 // We have to decrement TokenNumber by 1 to make it usable
1143 // as the array index.
1147 TmpTokenNumber
= TokenNumber
;
1150 // EBC compiler is very choosy. It may report warning about comparison
1151 // between UINTN and 0 . So we add 1 in each size of the
1154 ASSERT (TokenNumber
+ 1 < mPcdTotalTokenCount
+ 1);
1158 // Get MaxSize first, then check new size with max buffer size.
1160 GetPtrTypeSize (TokenNumber
, &MaxSize
);
1161 if (*Size
> MaxSize
) {
1163 return EFI_INVALID_PARAMETER
;
1166 if (*Size
!= DxePcdGetSize (TokenNumber
+ 1)) {
1167 return EFI_INVALID_PARAMETER
;
1172 // EBC compiler is very choosy. It may report warning about comparison
1173 // between UINTN and 0 . So we add 1 in each size of the
1176 if ((TokenNumber
+ 1 < mPeiNexTokenCount
+ 1) ||
1177 (TokenNumber
+ 1 >= mPeiLocalTokenCount
+ 1 && TokenNumber
+ 1 < (mPeiLocalTokenCount
+ mDxeNexTokenCount
+ 1))) {
1178 InvokeCallbackOnSet (0, NULL
, TokenNumber
+ 1, Data
, *Size
);
1182 // Aquire lock to prevent reentrance from TPL_CALLBACK level
1184 EfiAcquireLock (&mPcdDatabaseLock
);
1187 // EBC compiler is very choosy. It may report warning about comparison
1188 // between UINTN and 0 . So we add 1 in each size of the
1191 IsPeiDb
= (BOOLEAN
) ((TokenNumber
+ 1 < mPeiLocalTokenCount
+ 1) ? TRUE
: FALSE
);
1193 LocalTokenNumber
= GetLocalTokenNumber (IsPeiDb
, TokenNumber
+ 1);
1195 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
1197 PcdDb
= IsPeiDb
? ((UINT8
*) mPcdDatabase
.PeiDb
) : ((UINT8
*) mPcdDatabase
.DxeDb
);
1200 StringTable
= (UINT8
*) ((UINT8
*)mPcdDatabase
.PeiDb
+ mPcdDatabase
.PeiDb
->StringTableOffset
);
1202 StringTable
= (UINT8
*) ((UINT8
*)mPcdDatabase
.DxeDb
+ mPcdDatabase
.DxeDb
->StringTableOffset
);
1206 InternalData
= PcdDb
+ Offset
;
1208 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
1211 Status
= EFI_INVALID_PARAMETER
;
1214 case PCD_TYPE_STRING
:
1215 if (SetPtrTypeSize (TmpTokenNumber
, Size
)) {
1216 CopyMem (StringTable
+ *((STRING_HEAD
*)InternalData
), Data
, *Size
);
1217 Status
= EFI_SUCCESS
;
1219 Status
= EFI_INVALID_PARAMETER
;
1223 case PCD_TYPE_HII
|PCD_TYPE_STRING
:
1226 if (!SetPtrTypeSize (TmpTokenNumber
, Size
)) {
1227 Status
= EFI_INVALID_PARAMETER
;
1233 GuidTable
= (EFI_GUID
*) ((UINT8
*)mPcdDatabase
.PeiDb
+ mPcdDatabase
.PeiDb
->GuidTableOffset
);
1235 GuidTable
= (EFI_GUID
*) ((UINT8
*)mPcdDatabase
.DxeDb
+ mPcdDatabase
.DxeDb
->GuidTableOffset
);
1238 VariableHead
= (VARIABLE_HEAD
*) (PcdDb
+ Offset
);
1240 Guid
= GuidTable
+ VariableHead
->GuidTableIndex
;
1241 Name
= (UINT16
*) (StringTable
+ VariableHead
->StringIndex
);
1242 VariableOffset
= VariableHead
->Offset
;
1243 Attributes
= VariableHead
->Attributes
;
1244 Status
= SetHiiVariable (Guid
, Name
, Attributes
, Data
, *Size
, VariableOffset
);
1249 if (SetPtrTypeSize (TmpTokenNumber
, Size
)) {
1250 CopyMem (InternalData
, Data
, *Size
);
1251 Status
= EFI_SUCCESS
;
1253 Status
= EFI_INVALID_PARAMETER
;
1258 Status
= EFI_SUCCESS
;
1261 *((UINT8
*) InternalData
) = *((UINT8
*) Data
);
1264 case sizeof(UINT16
):
1265 *((UINT16
*) InternalData
) = *((UINT16
*) Data
);
1268 case sizeof(UINT32
):
1269 *((UINT32
*) InternalData
) = *((UINT32
*) Data
);
1272 case sizeof(UINT64
):
1273 *((UINT64
*) InternalData
) = *((UINT64
*) Data
);
1278 Status
= EFI_NOT_FOUND
;
1285 Status
= EFI_NOT_FOUND
;
1289 EfiReleaseLock (&mPcdDatabaseLock
);
1295 Wrapper function for get PCD value for dynamic-ex PCD.
1297 @param Guid Token space guid for dynamic-ex PCD.
1298 @param ExTokenNumber Token number for dynamic-ex PCD.
1299 @param GetSize The size of dynamic-ex PCD value.
1301 @return PCD entry in PCD database.
1306 IN CONST EFI_GUID
*Guid
,
1307 IN UINTN ExTokenNumber
,
1311 return GetWorker(GetExPcdTokenNumber (Guid
, (UINT32
) ExTokenNumber
), GetSize
);
1315 Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.
1317 @param ExTokenNumber Token number for dynamic-ex PCD.
1318 @param Guid Token space guid for dynamic-ex PCD.
1319 @param Data Value want to be set.
1320 @param SetSize The size of value.
1322 @return status of ExSetWorker().
1327 IN UINTN ExTokenNumber
,
1328 IN CONST EFI_GUID
*Guid
,
1333 return ExSetWorker (ExTokenNumber
, Guid
, Data
, &SetSize
, FALSE
);
1337 Set value for a dynamic-ex PCD entry.
1339 This routine find the local token number according to dynamic-ex PCD's token
1340 space guid and token number firstly, and invoke callback function if this PCD
1341 entry registered callback function. Finally, invoken general SetWorker to set
1344 @param ExTokenNumber Dynamic-ex PCD token number.
1345 @param Guid Token space guid for dynamic-ex PCD.
1346 @param Data PCD value want to be set
1347 @param SetSize Size of value.
1348 @param PtrType If TRUE, this PCD entry is pointer type.
1349 If FALSE, this PCD entry is not pointer type.
1351 @return status of SetWorker().
1356 IN UINTN ExTokenNumber
,
1357 IN CONST EFI_GUID
*Guid
,
1359 IN OUT UINTN
*SetSize
,
1365 TokenNumber
= GetExPcdTokenNumber (Guid
, (UINT32
) ExTokenNumber
);
1367 InvokeCallbackOnSet ((UINT32
) ExTokenNumber
, Guid
, TokenNumber
, Data
, *SetSize
);
1369 return SetWorker (TokenNumber
, Data
, SetSize
, PtrType
);
1374 Get variable size and data from HII-type PCDs.
1376 @param[in] VariableGuid Guid of variable which stored value of a HII-type PCD.
1377 @param[in] VariableName Unicode name of variable which stored value of a HII-type PCD.
1378 @param[out] VariableSize Pointer to variable size got from HII-type PCDs.
1379 @param[out] VariableData Pointer to variable data got from HII-type PCDs.
1383 GetVariableSizeAndDataFromHiiPcd (
1384 IN EFI_GUID
*VariableGuid
,
1385 IN UINT16
*VariableName
,
1386 OUT UINTN
*VariableSize
,
1387 OUT VOID
*VariableData OPTIONAL
1391 PCD_DATABASE_INIT
*Database
;
1393 UINT32 LocalTokenNumber
;
1395 EFI_GUID
*GuidTable
;
1397 VARIABLE_HEAD
*VariableHead
;
1402 UINT8
*VaraiableDefaultBuffer
;
1403 STRING_HEAD StringTableIdx
;
1408 // Go through PCD database to find out DynamicHii PCDs.
1410 for (TokenNumber
= 1; TokenNumber
<= mPcdTotalTokenCount
; TokenNumber
++) {
1411 IsPeiDb
= (BOOLEAN
) ((TokenNumber
+ 1 < mPeiLocalTokenCount
+ 1) ? TRUE
: FALSE
);
1412 Database
= IsPeiDb
? mPcdDatabase
.PeiDb
: mPcdDatabase
.DxeDb
;
1413 LocalTokenNumber
= GetLocalTokenNumber (IsPeiDb
, TokenNumber
);
1414 if ((LocalTokenNumber
& PCD_TYPE_HII
) != 0) {
1416 // Get the Variable Guid and Name pointer.
1418 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
1419 VariableHead
= (VARIABLE_HEAD
*) ((UINT8
*) Database
+ Offset
);
1420 StringTable
= (UINT8
*) ((UINT8
*) Database
+ Database
->StringTableOffset
);
1421 GuidTable
= (EFI_GUID
*) ((UINT8
*) Database
+ Database
->GuidTableOffset
);
1422 Guid
= GuidTable
+ VariableHead
->GuidTableIndex
;
1423 Name
= (UINT16
*) (StringTable
+ VariableHead
->StringIndex
);
1424 if (CompareGuid (VariableGuid
, Guid
) && (StrCmp (VariableName
, Name
) == 0)) {
1426 // It is the matched DynamicHii PCD.
1428 PcdDataSize
= DxePcdGetSize (TokenNumber
);
1429 Size
= VariableHead
->Offset
+ PcdDataSize
;
1430 if (Size
> *VariableSize
) {
1431 *VariableSize
= Size
;
1433 if (VariableData
!= NULL
) {
1434 if ((LocalTokenNumber
& PCD_TYPE_ALL_SET
) == (PCD_TYPE_HII
|PCD_TYPE_STRING
)) {
1436 // If a HII type PCD's datum type is VOID*, the DefaultValueOffset is the index of
1437 // string array in string table.
1439 StringTableIdx
= *(STRING_HEAD
*) ((UINT8
*) Database
+ VariableHead
->DefaultValueOffset
);
1440 VaraiableDefaultBuffer
= (UINT8
*) (StringTable
+ StringTableIdx
);
1442 VaraiableDefaultBuffer
= (UINT8
*) Database
+ VariableHead
->DefaultValueOffset
;
1444 CopyMem ((UINT8
*) VariableData
+ VariableHead
->Offset
, VaraiableDefaultBuffer
, PcdDataSize
);
1452 Set value for HII-type PCD.
1454 A HII-type PCD's value is stored in a variable. Setting/Getting the value of
1455 HII-type PCD is to visit this variable.
1457 @param VariableGuid Guid of variable which stored value of a HII-type PCD.
1458 @param VariableName Unicode name of variable which stored value of a HII-type PCD.
1459 @param SetAttributes Attributes bitmask to set for the variable.
1460 @param Data Value want to be set.
1461 @param DataSize Size of value
1462 @param Offset Value offset of HII-type PCD in variable.
1464 @return status of GetVariable()/SetVariable().
1469 IN EFI_GUID
*VariableGuid
,
1470 IN UINT16
*VariableName
,
1471 IN UINT32 SetAttributes
,
1472 IN CONST VOID
*Data
,
1487 // Try to get original variable size information.
1489 Status
= gRT
->GetVariable (
1490 (UINT16
*)VariableName
,
1497 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1499 // Patch new PCD's value to offset in given HII variable.
1501 if (Size
>= (DataSize
+ Offset
)) {
1504 SetSize
= DataSize
+ Offset
;
1506 Buffer
= AllocatePool (SetSize
);
1507 ASSERT (Buffer
!= NULL
);
1509 Status
= gRT
->GetVariable (
1517 ASSERT_EFI_ERROR (Status
);
1519 CopyMem ((UINT8
*)Buffer
+ Offset
, Data
, DataSize
);
1521 if (SetAttributes
== 0) {
1522 SetAttributes
= Attribute
;
1525 Status
= gRT
->SetVariable (
1535 } else if (Status
== EFI_NOT_FOUND
) {
1537 // If variable does not exist, a new variable need to be created.
1541 // Get size, allocate buffer and get data.
1543 GetVariableSizeAndDataFromHiiPcd (VariableGuid
, VariableName
, &Size
, NULL
);
1544 Buffer
= AllocateZeroPool (Size
);
1545 ASSERT (Buffer
!= NULL
);
1546 GetVariableSizeAndDataFromHiiPcd (VariableGuid
, VariableName
, &Size
, Buffer
);
1551 CopyMem ((UINT8
*)Buffer
+ Offset
, Data
, DataSize
);
1553 if (SetAttributes
== 0) {
1554 SetAttributes
= EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
;
1557 Status
= gRT
->SetVariable (
1570 // If we drop to here, the value is failed to be written in to variable area.
1576 Get Token Number according to dynamic-ex PCD's {token space guid:token number}
1578 A dynamic-ex type PCD, developer must provide pair of token space guid: token number
1579 in DEC file. PCD database maintain a mapping table that translate pair of {token
1580 space guid: token number} to Token Number.
1582 @param Guid Token space guid for dynamic-ex PCD entry.
1583 @param ExTokenNumber Dynamic-ex PCD token number.
1585 @return Token Number for dynamic-ex PCD.
1589 GetExPcdTokenNumber (
1590 IN CONST EFI_GUID
*Guid
,
1591 IN UINT32 ExTokenNumber
1595 DYNAMICEX_MAPPING
*ExMap
;
1596 EFI_GUID
*GuidTable
;
1597 EFI_GUID
*MatchGuid
;
1600 if (!mPeiDatabaseEmpty
) {
1601 ExMap
= (DYNAMICEX_MAPPING
*)((UINT8
*)mPcdDatabase
.PeiDb
+ mPcdDatabase
.PeiDb
->ExMapTableOffset
);
1602 GuidTable
= (EFI_GUID
*)((UINT8
*)mPcdDatabase
.PeiDb
+ mPcdDatabase
.PeiDb
->GuidTableOffset
);
1604 MatchGuid
= ScanGuid (GuidTable
, mPeiGuidTableSize
, Guid
);
1606 if (MatchGuid
!= NULL
) {
1608 MatchGuidIdx
= MatchGuid
- GuidTable
;
1610 for (Index
= 0; Index
< mPcdDatabase
.PeiDb
->ExTokenCount
; Index
++) {
1611 if ((ExTokenNumber
== ExMap
[Index
].ExTokenNumber
) &&
1612 (MatchGuidIdx
== ExMap
[Index
].ExGuidIndex
)) {
1613 return ExMap
[Index
].TokenNumber
;
1619 ExMap
= (DYNAMICEX_MAPPING
*)((UINT8
*)mPcdDatabase
.DxeDb
+ mPcdDatabase
.DxeDb
->ExMapTableOffset
);
1620 GuidTable
= (EFI_GUID
*)((UINT8
*)mPcdDatabase
.DxeDb
+ mPcdDatabase
.DxeDb
->GuidTableOffset
);
1622 MatchGuid
= ScanGuid (GuidTable
, mDxeGuidTableSize
, Guid
);
1624 // We need to ASSERT here. If GUID can't be found in GuidTable, this is a
1625 // error in the BUILD system.
1627 ASSERT (MatchGuid
!= NULL
);
1629 MatchGuidIdx
= MatchGuid
- GuidTable
;
1631 for (Index
= 0; Index
< mPcdDatabase
.DxeDb
->ExTokenCount
; Index
++) {
1632 if ((ExTokenNumber
== ExMap
[Index
].ExTokenNumber
) &&
1633 (MatchGuidIdx
== ExMap
[Index
].ExGuidIndex
)) {
1634 return ExMap
[Index
].TokenNumber
;
1644 Get SKU ID table from PCD database.
1646 @param LocalTokenNumberTableIdx Index of local token number in token number table.
1647 @param IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
1648 If FALSE, the pcd entry is initialized in DXE phase.
1649 @return Pointer to SKU ID array table
1654 IN UINTN LocalTokenNumberTableIdx
,
1659 UINTN LocalTokenNumber
;
1663 LocalTokenNumber
= *((UINT32
*)((UINT8
*)mPcdDatabase
.PeiDb
+ mPcdDatabase
.PeiDb
->LocalTokenNumberTableOffset
) + LocalTokenNumberTableIdx
);
1664 Database
= (UINT8
*) mPcdDatabase
.PeiDb
;
1666 LocalTokenNumber
= *((UINT32
*)((UINT8
*)mPcdDatabase
.DxeDb
+ mPcdDatabase
.DxeDb
->LocalTokenNumberTableOffset
) + LocalTokenNumberTableIdx
);
1667 Database
= (UINT8
*) mPcdDatabase
.DxeDb
;
1670 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) != 0);
1672 SkuHead
= (SKU_HEAD
*) ((UINT8
*)Database
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
1674 return (SKU_ID
*) (Database
+ SkuHead
->SkuIdTableOffset
);
1679 Wrapper function of getting index of PCD entry in size table.
1681 @param LocalTokenNumberTableIdx Index of this PCD in local token number table.
1682 @param IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
1683 If FALSE, the pcd entry is initialized in DXE phase.
1685 @return index of PCD entry in size table.
1689 IN UINTN LocalTokenNumberTableIdx
,
1693 UINT32
*LocalTokenNumberTable
;
1694 UINTN LocalTokenNumber
;
1700 LocalTokenNumberTable
= (UINT32
*)((UINT8
*)mPcdDatabase
.PeiDb
+ mPcdDatabase
.PeiDb
->LocalTokenNumberTableOffset
);
1702 LocalTokenNumberTable
= (UINT32
*)((UINT8
*)mPcdDatabase
.DxeDb
+ mPcdDatabase
.DxeDb
->LocalTokenNumberTableOffset
);
1707 for (Index
= 0; Index
< LocalTokenNumberTableIdx
; Index
++) {
1708 LocalTokenNumber
= LocalTokenNumberTable
[Index
];
1710 if ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
) {
1712 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1715 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
1717 // We have only two entry for VPD enabled PCD entry:
1720 // Current size is equal to MAX size.
1724 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
1726 // We have only two entry for Non-Sku enabled PCD entry:
1733 // We have these entry for SKU enabled PCD entry
1735 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1737 SkuIdTable
= GetSkuIdArray (Index
, IsPeiDb
);
1738 SizeTableIdx
+= (UINTN
)*SkuIdTable
+ 1;
1745 return SizeTableIdx
;
1749 Get size of POINTER type PCD value.
1751 @param LocalTokenNumberTableIdx Index of local token number in local token number table.
1752 @param MaxSize Maxmium size of POINTER type PCD value.
1754 @return size of POINTER type PCD value.
1759 IN UINTN LocalTokenNumberTableIdx
,
1764 UINTN LocalTokenNumber
;
1766 SIZE_INFO
*SizeTable
;
1769 UINT32
*LocalTokenNumberTable
;
1771 // EBC compiler is very choosy. It may report warning about comparison
1772 // between UINTN and 0 . So we add 1 in each size of the
1774 IsPeiDb
= (BOOLEAN
) (LocalTokenNumberTableIdx
+ 1 < mPeiLocalTokenCount
+ 1);
1778 LocalTokenNumberTable
= (UINT32
*)((UINT8
*)mPcdDatabase
.PeiDb
+ mPcdDatabase
.PeiDb
->LocalTokenNumberTableOffset
);
1779 SizeTable
= (SIZE_INFO
*)((UINT8
*)mPcdDatabase
.PeiDb
+ mPcdDatabase
.PeiDb
->SizeTableOffset
);
1781 LocalTokenNumberTableIdx
-= mPeiLocalTokenCount
;
1782 LocalTokenNumberTable
= (UINT32
*)((UINT8
*)mPcdDatabase
.DxeDb
+ mPcdDatabase
.DxeDb
->LocalTokenNumberTableOffset
);
1783 SizeTable
= (SIZE_INFO
*)((UINT8
*)mPcdDatabase
.DxeDb
+ mPcdDatabase
.DxeDb
->SizeTableOffset
);
1786 LocalTokenNumber
= LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
1788 ASSERT ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
);
1790 SizeTableIdx
= GetSizeTableIndex (LocalTokenNumberTableIdx
, IsPeiDb
);
1792 *MaxSize
= SizeTable
[SizeTableIdx
];
1794 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1797 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
1799 // We have only two entry for VPD enabled PCD entry:
1802 // We consider current size is equal to MAX size.
1806 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
1808 // We have only two entry for Non-Sku enabled PCD entry:
1812 return SizeTable
[SizeTableIdx
+ 1];
1815 // We have these entry for SKU enabled PCD entry
1817 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1819 SkuIdTable
= GetSkuIdArray (LocalTokenNumberTableIdx
, IsPeiDb
);
1820 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
1821 if (SkuIdTable
[1 + Index
] == mPcdDatabase
.DxeDb
->SystemSkuId
) {
1822 return SizeTable
[SizeTableIdx
+ 1 + Index
];
1825 return SizeTable
[SizeTableIdx
+ 1];
1831 Set size of POINTER type PCD value. The size should not exceed the maximum size
1834 @param LocalTokenNumberTableIdx Index of local token number in local token number table.
1835 @param CurrentSize Size of POINTER type PCD value.
1837 @retval TRUE Success to set size of PCD value.
1838 @retval FALSE Fail to set size of PCD value.
1842 IN UINTN LocalTokenNumberTableIdx
,
1843 IN OUT UINTN
*CurrentSize
1847 UINTN LocalTokenNumber
;
1849 SIZE_INFO
*SizeTable
;
1853 UINT32
*LocalTokenNumberTable
;
1856 // EBC compiler is very choosy. It may report warning about comparison
1857 // between UINTN and 0 . So we add 1 in each size of the
1860 IsPeiDb
= (BOOLEAN
) (LocalTokenNumberTableIdx
+ 1 < mPeiLocalTokenCount
+ 1);
1863 LocalTokenNumberTable
= (UINT32
*)((UINT8
*)mPcdDatabase
.PeiDb
+ mPcdDatabase
.PeiDb
->LocalTokenNumberTableOffset
);
1864 SizeTable
= (SIZE_INFO
*)((UINT8
*)mPcdDatabase
.PeiDb
+ mPcdDatabase
.PeiDb
->SizeTableOffset
);
1866 LocalTokenNumberTableIdx
-= mPeiLocalTokenCount
;
1867 LocalTokenNumberTable
= (UINT32
*)((UINT8
*)mPcdDatabase
.DxeDb
+ mPcdDatabase
.DxeDb
->LocalTokenNumberTableOffset
);
1868 SizeTable
= (SIZE_INFO
*)((UINT8
*)mPcdDatabase
.DxeDb
+ mPcdDatabase
.DxeDb
->SizeTableOffset
);
1871 LocalTokenNumber
= LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
1873 ASSERT ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
);
1875 SizeTableIdx
= GetSizeTableIndex (LocalTokenNumberTableIdx
, IsPeiDb
);
1877 MaxSize
= SizeTable
[SizeTableIdx
];
1879 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1882 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
1884 // We shouldn't come here as we don't support SET for VPD
1889 if ((*CurrentSize
> MaxSize
) ||
1890 (*CurrentSize
== MAX_ADDRESS
)) {
1891 *CurrentSize
= MaxSize
;
1895 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
1897 // We have only two entry for Non-Sku enabled PCD entry:
1901 SizeTable
[SizeTableIdx
+ 1] = (SIZE_INFO
) *CurrentSize
;
1905 // We have these entry for SKU enabled PCD entry
1907 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1909 SkuIdTable
= GetSkuIdArray (LocalTokenNumberTableIdx
, IsPeiDb
);
1910 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
1911 if (SkuIdTable
[1 + Index
] == mPcdDatabase
.DxeDb
->SystemSkuId
) {
1912 SizeTable
[SizeTableIdx
+ 1 + Index
] = (SIZE_INFO
) *CurrentSize
;
1916 SizeTable
[SizeTableIdx
+ 1] = (SIZE_INFO
) *CurrentSize
;
1923 VariableLock DynamicHiiPcd.
1925 @param[in] IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
1926 If FALSE, the pcd entry is initialized in DXE phase.
1927 @param[in] VariableLock Pointer to VariableLockProtocol.
1931 VariableLockDynamicHiiPcd (
1933 IN EDKII_VARIABLE_LOCK_PROTOCOL
*VariableLock
1937 PCD_DATABASE_INIT
*Database
;
1938 UINT32 LocalTokenCount
;
1940 UINT32 LocalTokenNumber
;
1942 EFI_GUID
*GuidTable
;
1944 VARIABLE_HEAD
*VariableHead
;
1948 Database
= IsPeiDb
? mPcdDatabase
.PeiDb
: mPcdDatabase
.DxeDb
;
1949 LocalTokenCount
= IsPeiDb
? mPeiLocalTokenCount
: mDxeLocalTokenCount
;
1952 // Go through PCD database to find out DynamicHii PCDs.
1954 for (TokenNumber
= 1; TokenNumber
<= LocalTokenCount
; TokenNumber
++) {
1956 LocalTokenNumber
= GetLocalTokenNumber (TRUE
, TokenNumber
);
1958 LocalTokenNumber
= GetLocalTokenNumber (FALSE
, TokenNumber
+ mPeiLocalTokenCount
);
1960 if ((LocalTokenNumber
& PCD_TYPE_HII
) != 0) {
1961 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
1962 VariableHead
= (VARIABLE_HEAD
*) ((UINT8
*) Database
+ Offset
);
1964 // Why not to set property by VarCheckProtocol with Attributes and Property directly here?
1965 // It is because that set property by VarCheckProtocol will indicate the variable to
1966 // be a system variable, but the unknown max size of the variable is dangerous to
1967 // the system variable region.
1969 if ((VariableHead
->Property
& VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY
) != 0) {
1971 // DynamicHii PCD with RO property set in *.dsc.
1973 StringTable
= (UINT8
*) ((UINT8
*) Database
+ Database
->StringTableOffset
);
1974 GuidTable
= (EFI_GUID
*) ((UINT8
*) Database
+ Database
->GuidTableOffset
);
1975 Guid
= GuidTable
+ VariableHead
->GuidTableIndex
;
1976 Name
= (UINT16
*) (StringTable
+ VariableHead
->StringIndex
);
1977 Status
= VariableLock
->RequestToLock (VariableLock
, Name
, Guid
);
1978 ASSERT_EFI_ERROR (Status
);
1985 VariableLockProtocol callback
1986 to lock the variables referenced by DynamicHii PCDs with RO property set in *.dsc.
1988 @param[in] Event Event whose notification function is being invoked.
1989 @param[in] Context Pointer to the notification function's context.
1994 VariableLockCallBack (
2000 EDKII_VARIABLE_LOCK_PROTOCOL
*VariableLock
;
2002 Status
= gBS
->LocateProtocol (&gEdkiiVariableLockProtocolGuid
, NULL
, (VOID
**) &VariableLock
);
2003 if (!EFI_ERROR (Status
)) {
2004 VariableLockDynamicHiiPcd (TRUE
, VariableLock
);
2005 VariableLockDynamicHiiPcd (FALSE
, VariableLock
);