2 The driver internal functions are implmented here.
3 They build Pei PCD database, and provide access service to PCD database.
5 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
6 SPDX-License-Identifier: BSD-2-Clause-Patent
13 Get Local Token Number by Token Number.
15 @param[in] Database PCD database.
16 @param[in] TokenNumber The PCD token number.
18 @return Local Token Number.
22 IN PEI_PCD_DATABASE
*Database
,
26 UINT32 LocalTokenNumber
;
29 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
30 // We have to decrement TokenNumber by 1 to make it usable
31 // as the array index.
35 LocalTokenNumber
= *((UINT32
*)((UINT8
*)Database
+ Database
->LocalTokenNumberTableOffset
) + TokenNumber
);
37 return LocalTokenNumber
;
41 Get PCD type by Local Token Number.
43 @param[in] LocalTokenNumber The PCD local token number.
49 IN UINT32 LocalTokenNumber
52 switch (LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) {
53 case PCD_DATUM_TYPE_POINTER
:
54 return EFI_PCD_TYPE_PTR
;
55 case PCD_DATUM_TYPE_UINT8
:
56 if ((LocalTokenNumber
& PCD_DATUM_TYPE_UINT8_BOOLEAN
) == PCD_DATUM_TYPE_UINT8_BOOLEAN
) {
57 return EFI_PCD_TYPE_BOOL
;
59 return EFI_PCD_TYPE_8
;
61 case PCD_DATUM_TYPE_UINT16
:
62 return EFI_PCD_TYPE_16
;
63 case PCD_DATUM_TYPE_UINT32
:
64 return EFI_PCD_TYPE_32
;
65 case PCD_DATUM_TYPE_UINT64
:
66 return EFI_PCD_TYPE_64
;
69 return EFI_PCD_TYPE_8
;
76 @param[in] OnlyTokenSpaceName If TRUE, only need to get the TokenSpaceCName.
77 If FALSE, need to get the full PCD name.
78 @param[in] Database PCD database.
79 @param[in] TokenNumber The PCD token number.
81 @return The TokenSpaceCName or full PCD name.
85 IN BOOLEAN OnlyTokenSpaceName
,
86 IN PEI_PCD_DATABASE
*Database
,
92 PCD_NAME_INDEX
*PcdNameIndex
;
93 CHAR8
*TokenSpaceName
;
98 // Return NULL when PCD name table is absent.
100 if (Database
->PcdNameTableOffset
== 0) {
105 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
106 // We have to decrement TokenNumber by 1 to make it usable
107 // as the array index.
111 StringTable
= (UINT8
*) Database
+ Database
->StringTableOffset
;
114 // Get the PCD name index.
116 PcdNameIndex
= (PCD_NAME_INDEX
*)((UINT8
*) Database
+ Database
->PcdNameTableOffset
) + TokenNumber
;
117 TokenSpaceName
= (CHAR8
*)&StringTable
[PcdNameIndex
->TokenSpaceCNameIndex
];
118 PcdName
= (CHAR8
*)&StringTable
[PcdNameIndex
->PcdCNameIndex
];
120 if (OnlyTokenSpaceName
) {
122 // Only need to get the TokenSpaceCName.
124 Name
= AllocateCopyPool (AsciiStrSize (TokenSpaceName
), TokenSpaceName
);
127 // Need to get the full PCD name.
129 NameSize
= AsciiStrSize (TokenSpaceName
) + AsciiStrSize (PcdName
);
130 Name
= AllocateZeroPool (NameSize
);
131 ASSERT (Name
!= NULL
);
133 // Catenate TokenSpaceCName and PcdCName with a '.' to form the full PCD name.
135 AsciiStrCatS (Name
, NameSize
, TokenSpaceName
);
136 Name
[AsciiStrSize (TokenSpaceName
) - sizeof (CHAR8
)] = '.';
137 AsciiStrCatS (Name
, NameSize
, PcdName
);
144 Retrieve additional information associated with a PCD token.
146 This includes information such as the type of value the TokenNumber is associated with as well as possible
147 human readable name that is associated with the token.
149 @param[in] Database PCD database.
150 @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
151 @param[in] TokenNumber The PCD token number.
152 @param[out] PcdInfo The returned information associated with the requested TokenNumber.
153 The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.
155 @retval EFI_SUCCESS The PCD information was returned successfully
156 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
160 IN PEI_PCD_DATABASE
*Database
,
161 IN CONST EFI_GUID
*Guid
,
162 IN UINTN TokenNumber
,
163 OUT EFI_PCD_INFO
*PcdInfo
169 DYNAMICEX_MAPPING
*ExMapTable
;
171 UINT32 LocalTokenNumber
;
173 GuidTable
= (EFI_GUID
*)((UINT8
*)Database
+ Database
->GuidTableOffset
);
174 MatchGuid
= ScanGuid (GuidTable
, Database
->GuidTableCount
* sizeof(EFI_GUID
), Guid
);
176 if (MatchGuid
== NULL
) {
177 return EFI_NOT_FOUND
;
180 GuidTableIdx
= MatchGuid
- GuidTable
;
182 ExMapTable
= (DYNAMICEX_MAPPING
*)((UINT8
*)Database
+ Database
->ExMapTableOffset
);
185 // Find the PCD by GuidTableIdx and ExTokenNumber in ExMapTable.
187 for (Index
= 0; Index
< Database
->ExTokenCount
; Index
++) {
188 if (ExMapTable
[Index
].ExGuidIndex
== GuidTableIdx
) {
189 if (TokenNumber
== PCD_INVALID_TOKEN_NUMBER
) {
191 // TokenNumber is 0, follow spec to set PcdType to EFI_PCD_TYPE_8,
192 // PcdSize to 0 and PcdName to the null-terminated ASCII string
193 // associated with the token's namespace Guid.
195 PcdInfo
->PcdType
= EFI_PCD_TYPE_8
;
196 PcdInfo
->PcdSize
= 0;
198 // Here use one representative in the token space to get the TokenSpaceCName.
200 PcdInfo
->PcdName
= GetPcdName (TRUE
, Database
, ExMapTable
[Index
].TokenNumber
);
202 } else if (ExMapTable
[Index
].ExTokenNumber
== TokenNumber
) {
203 PcdInfo
->PcdSize
= PeiPcdGetSize (ExMapTable
[Index
].TokenNumber
);
204 LocalTokenNumber
= GetLocalTokenNumber (Database
, ExMapTable
[Index
].TokenNumber
);
205 PcdInfo
->PcdType
= GetPcdType (LocalTokenNumber
);
206 PcdInfo
->PcdName
= GetPcdName (FALSE
, Database
, ExMapTable
[Index
].TokenNumber
);
212 return EFI_NOT_FOUND
;
216 Retrieve additional information associated with a PCD token.
218 This includes information such as the type of value the TokenNumber is associated with as well as possible
219 human readable name that is associated with the token.
221 @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
222 @param[in] TokenNumber The PCD token number.
223 @param[out] PcdInfo The returned information associated with the requested TokenNumber.
224 The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.
226 @retval EFI_SUCCESS The PCD information was returned successfully.
227 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
231 IN CONST EFI_GUID
*Guid
,
232 IN UINTN TokenNumber
,
233 OUT EFI_PCD_INFO
*PcdInfo
236 PEI_PCD_DATABASE
*PeiPcdDb
;
237 BOOLEAN PeiExMapTableEmpty
;
238 UINTN PeiNexTokenNumber
;
239 UINT32 LocalTokenNumber
;
241 ASSERT (PcdInfo
!= NULL
);
243 PeiPcdDb
= GetPcdDatabase ();
244 PeiNexTokenNumber
= PeiPcdDb
->LocalTokenCount
- PeiPcdDb
->ExTokenCount
;
246 if (PeiPcdDb
->ExTokenCount
== 0) {
247 PeiExMapTableEmpty
= TRUE
;
249 PeiExMapTableEmpty
= FALSE
;
253 if (TokenNumber
> PeiNexTokenNumber
) {
254 return EFI_NOT_FOUND
;
255 } else if (TokenNumber
== PCD_INVALID_TOKEN_NUMBER
) {
257 // TokenNumber is 0, follow spec to set PcdType to EFI_PCD_TYPE_8,
258 // PcdSize to 0 and PcdName to NULL for default Token Space.
260 PcdInfo
->PcdType
= EFI_PCD_TYPE_8
;
261 PcdInfo
->PcdSize
= 0;
262 PcdInfo
->PcdName
= NULL
;
264 PcdInfo
->PcdSize
= PeiPcdGetSize (TokenNumber
);
265 LocalTokenNumber
= GetLocalTokenNumber (PeiPcdDb
, TokenNumber
);
266 PcdInfo
->PcdType
= GetPcdType (LocalTokenNumber
);
267 PcdInfo
->PcdName
= GetPcdName (FALSE
, PeiPcdDb
, TokenNumber
);
271 if (PeiExMapTableEmpty
) {
272 return EFI_NOT_FOUND
;
274 return ExGetPcdInfo (
284 The function registers the CallBackOnSet fucntion
285 according to TokenNumber and EFI_GUID space.
287 @param ExTokenNumber The token number.
288 @param Guid The GUID space.
289 @param CallBackFunction The Callback function to be registered.
290 @param Register To register or unregister the callback function.
292 @retval EFI_SUCCESS If the Callback function is registered.
293 @retval EFI_NOT_FOUND If the PCD Entry is not found according to Token Number and GUID space.
294 @retval EFI_OUT_OF_RESOURCES If the callback function can't be registered because there is not free
295 slot left in the CallbackFnTable.
296 @retval EFI_INVALID_PARAMETER If the callback function want to be de-registered can not be found.
299 PeiRegisterCallBackWorker (
300 IN UINTN ExTokenNumber
,
301 IN CONST EFI_GUID
*Guid OPTIONAL
,
302 IN PCD_PPI_CALLBACK CallBackFunction
,
306 EFI_HOB_GUID_TYPE
*GuidHob
;
307 PCD_PPI_CALLBACK
*CallbackTable
;
308 PCD_PPI_CALLBACK Compare
;
309 PCD_PPI_CALLBACK Assign
;
310 UINT32 LocalTokenNumber
;
311 UINT32 LocalTokenCount
;
312 UINTN PeiNexTokenNumber
;
315 PEI_PCD_DATABASE
*PeiPcdDb
;
317 PeiPcdDb
= GetPcdDatabase();
318 LocalTokenCount
= PeiPcdDb
->LocalTokenCount
;
319 PeiNexTokenNumber
= PeiPcdDb
->LocalTokenCount
- PeiPcdDb
->ExTokenCount
;
322 TokenNumber
= ExTokenNumber
;
324 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
325 // We have to decrement TokenNumber by 1 to make it usable
326 // as the array index.
329 ASSERT (TokenNumber
+ 1 < (PeiNexTokenNumber
+ 1));
331 TokenNumber
= GetExPcdTokenNumber (Guid
, ExTokenNumber
);
332 if (TokenNumber
== PCD_INVALID_TOKEN_NUMBER
) {
333 return EFI_NOT_FOUND
;
336 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
337 // We have to decrement TokenNumber by 1 to make it usable
338 // as the array index.
341 // EBC compiler is very choosy. It may report warning about comparison
342 // between UINTN and 0 . So we add 1 in each size of the
344 ASSERT ((TokenNumber
+ 1) < (LocalTokenCount
+ 1));
348 LocalTokenNumber
= *((UINT32
*)((UINT8
*)PeiPcdDb
+ PeiPcdDb
->LocalTokenNumberTableOffset
) + TokenNumber
);
351 // We don't support SET for HII and VPD type PCD entry in PEI phase.
352 // So we will assert if any register callback for such PCD entry.
354 ASSERT ((LocalTokenNumber
& PCD_TYPE_HII
) == 0);
355 ASSERT ((LocalTokenNumber
& PCD_TYPE_VPD
) == 0);
357 GuidHob
= GetFirstGuidHob (&gEfiCallerIdGuid
);
358 ASSERT (GuidHob
!= NULL
);
360 CallbackTable
= GET_GUID_HOB_DATA (GuidHob
);
361 CallbackTable
= CallbackTable
+ (TokenNumber
* PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry
));
363 Compare
= Register
? NULL
: CallBackFunction
;
364 Assign
= Register
? CallBackFunction
: NULL
;
367 for (Idx
= 0; Idx
< PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry
); Idx
++) {
368 if (CallbackTable
[Idx
] == Compare
) {
369 CallbackTable
[Idx
] = Assign
;
374 return Register
? EFI_OUT_OF_RESOURCES
: EFI_INVALID_PARAMETER
;
380 Find the Pcd database.
382 @param FileHandle Handle of the file the external PCD database binary located.
384 @retval The base address of external PCD database binary.
385 @retval NULL Return NULL if not find.
389 IN EFI_PEI_FILE_HANDLE FileHandle
397 ASSERT (FileHandle
!= NULL
);
399 Status
= PeiServicesFfsFindSectionData (EFI_SECTION_RAW
, FileHandle
, &PcdDb
);
400 ASSERT_EFI_ERROR (Status
);
403 // Check the first bytes (Header Signature Guid) and build version.
405 if (!CompareGuid (PcdDb
, &gPcdDataBaseSignatureGuid
) ||
406 (((PEI_PCD_DATABASE
*) PcdDb
)->BuildVersion
!= PCD_SERVICE_PEIM_VERSION
)) {
414 The function builds the PCD database.
416 @param FileHandle Handle of the file the external PCD database binary located.
418 @return Pointer to PCD database.
422 IN EFI_PEI_FILE_HANDLE FileHandle
425 PEI_PCD_DATABASE
*Database
;
426 PEI_PCD_DATABASE
*PeiPcdDbBinary
;
427 VOID
*CallbackFnTable
;
428 UINTN SizeOfCallbackFnTable
;
431 // Locate the external PCD database binary for one section of current FFS
433 PeiPcdDbBinary
= LocateExPcdBinary (FileHandle
);
435 ASSERT(PeiPcdDbBinary
!= NULL
);
437 Database
= BuildGuidHob (&gPcdDataBaseHobGuid
, PeiPcdDbBinary
->Length
+ PeiPcdDbBinary
->UninitDataBaseSize
);
439 ZeroMem (Database
, PeiPcdDbBinary
->Length
+ PeiPcdDbBinary
->UninitDataBaseSize
);
442 // PeiPcdDbBinary is smaller than Database
444 CopyMem (Database
, PeiPcdDbBinary
, PeiPcdDbBinary
->Length
);
446 SizeOfCallbackFnTable
= Database
->LocalTokenCount
* sizeof (PCD_PPI_CALLBACK
) * PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry
);
448 CallbackFnTable
= BuildGuidHob (&gEfiCallerIdGuid
, SizeOfCallbackFnTable
);
450 ZeroMem (CallbackFnTable
, SizeOfCallbackFnTable
);
456 The function is provided by PCD PEIM and PCD DXE driver to
457 do the work of reading a HII variable from variable service.
459 @param VariableGuid The Variable GUID.
460 @param VariableName The Variable Name.
461 @param VariableData The output data.
462 @param VariableSize The size of the variable.
464 @retval EFI_SUCCESS Operation successful.
465 @retval EFI_NOT_FOUND Variablel not found.
469 IN CONST EFI_GUID
*VariableGuid
,
470 IN UINT16
*VariableName
,
471 OUT VOID
**VariableData
,
472 OUT UINTN
*VariableSize
478 EFI_PEI_READ_ONLY_VARIABLE2_PPI
*VariablePpi
;
480 Status
= PeiServicesLocatePpi (&gEfiPeiReadOnlyVariable2PpiGuid
, 0, NULL
, (VOID
**) &VariablePpi
);
481 ASSERT_EFI_ERROR (Status
);
484 Status
= VariablePpi
->GetVariable (
487 (EFI_GUID
*) VariableGuid
,
493 if (Status
== EFI_BUFFER_TOO_SMALL
) {
494 Status
= PeiServicesAllocatePool (Size
, &Buffer
);
495 ASSERT_EFI_ERROR (Status
);
497 Status
= VariablePpi
->GetVariable (
499 (UINT16
*) VariableName
,
500 (EFI_GUID
*) VariableGuid
,
505 ASSERT_EFI_ERROR (Status
);
507 *VariableSize
= Size
;
508 *VariableData
= Buffer
;
513 return EFI_NOT_FOUND
;
517 Invoke the callback function when dynamic PCD entry was set, if this PCD entry
518 has registered callback function.
520 @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx
522 @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type
524 @param TokenNumber PCD token number generated by build tools.
525 @param Data Value want to be set for this PCD entry
526 @param Size The size of value
530 InvokeCallbackOnSet (
532 CONST EFI_GUID
*Guid OPTIONAL
,
538 EFI_HOB_GUID_TYPE
*GuidHob
;
539 PCD_PPI_CALLBACK
*CallbackTable
;
541 PEI_PCD_DATABASE
*PeiPcdDb
;
542 UINT32 LocalTokenCount
;
545 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
546 // We have to decrement TokenNumber by 1 to make it usable
547 // as the array index.
551 PeiPcdDb
= GetPcdDatabase ();
552 LocalTokenCount
= PeiPcdDb
->LocalTokenCount
;
555 // EBC compiler is very choosy. It may report warning about comparison
556 // between UINTN and 0 . So we add 1 in each size of the
558 ASSERT (TokenNumber
+ 1 < (LocalTokenCount
+ 1));
561 GuidHob
= GetFirstGuidHob (&gEfiCallerIdGuid
);
562 ASSERT (GuidHob
!= NULL
);
564 CallbackTable
= GET_GUID_HOB_DATA (GuidHob
);
566 CallbackTable
+= (TokenNumber
* PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry
));
568 for (Idx
= 0; Idx
< PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry
); Idx
++) {
569 if (CallbackTable
[Idx
] != NULL
) {
570 CallbackTable
[Idx
] (Guid
,
571 (Guid
== NULL
) ? (TokenNumber
+ 1) : ExTokenNumber
,
580 Wrapper function for setting non-pointer type value for a PCD entry.
582 @param TokenNumber Pcd token number autogenerated by build tools.
583 @param Data Value want to be set for PCD entry
584 @param Size Size of value.
586 @return status of SetWorker.
591 IN UINTN TokenNumber
,
596 return SetWorker (TokenNumber
, Data
, &Size
, FALSE
);
600 Set value for an PCD entry
602 @param TokenNumber Pcd token number autogenerated by build tools.
603 @param Data Value want to be set for PCD entry
604 @param Size Size of value.
605 @param PtrType If TRUE, the type of PCD entry's value is Pointer.
606 If False, the type of PCD entry's value is not Pointer.
608 @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.
609 @retval EFI_INVALID_PARAMETER If Size can not be set to size table.
610 @retval EFI_INVALID_PARAMETER If Size of non-Ptr type PCD does not match the size information in PCD database.
611 @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in
612 range of UINT8, UINT16, UINT32, UINT64
613 @retval EFI_NOT_FOUND Can not find the PCD type according to token number.
617 IN UINTN TokenNumber
,
623 UINT32 LocalTokenNumber
;
624 UINTN PeiNexTokenNumber
;
625 PEI_PCD_DATABASE
*PeiPcdDb
;
626 STRING_HEAD StringTableIdx
;
630 UINT32 LocalTokenCount
;
632 if (!FeaturePcdGet(PcdPeiFullPcdDatabaseEnable
)) {
633 return EFI_UNSUPPORTED
;
637 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
638 // We have to decrement TokenNumber by 1 to make it usable
639 // as the array index.
642 PeiPcdDb
= GetPcdDatabase ();
643 LocalTokenCount
= PeiPcdDb
->LocalTokenCount
;
645 // EBC compiler is very choosy. It may report warning about comparison
646 // between UINTN and 0 . So we add 1 in each size of the
648 ASSERT (TokenNumber
+ 1 < (LocalTokenCount
+ 1));
652 // Get MaxSize first, then check new size with max buffer size.
654 GetPtrTypeSize (TokenNumber
, &MaxSize
, PeiPcdDb
);
655 if (*Size
> MaxSize
) {
657 return EFI_INVALID_PARAMETER
;
660 if (*Size
!= PeiPcdGetSize (TokenNumber
+ 1)) {
661 return EFI_INVALID_PARAMETER
;
666 // We only invoke the callback function for Dynamic Type PCD Entry.
667 // For Dynamic EX PCD entry, we have invoked the callback function for Dynamic EX
668 // type PCD entry in ExSetWorker.
670 PeiNexTokenNumber
= PeiPcdDb
->LocalTokenCount
- PeiPcdDb
->ExTokenCount
;
671 if (TokenNumber
+ 1 < PeiNexTokenNumber
+ 1) {
672 InvokeCallbackOnSet (0, NULL
, TokenNumber
+ 1, Data
, *Size
);
675 LocalTokenNumber
= GetLocalTokenNumber (PeiPcdDb
, TokenNumber
+ 1);
677 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
678 InternalData
= (VOID
*) ((UINT8
*) PeiPcdDb
+ Offset
);
680 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
683 case PCD_TYPE_HII
|PCD_TYPE_STRING
:
686 return EFI_INVALID_PARAMETER
;
689 case PCD_TYPE_STRING
:
690 if (SetPtrTypeSize (TokenNumber
, Size
, PeiPcdDb
)) {
691 StringTableIdx
= *((STRING_HEAD
*)InternalData
);
692 CopyMem ((UINT8
*)PeiPcdDb
+ PeiPcdDb
->StringTableOffset
+ StringTableIdx
, Data
, *Size
);
695 return EFI_INVALID_PARAMETER
;
701 if (SetPtrTypeSize (TokenNumber
, Size
, PeiPcdDb
)) {
702 CopyMem (InternalData
, Data
, *Size
);
705 return EFI_INVALID_PARAMETER
;
711 *((UINT8
*) InternalData
) = *((UINT8
*) Data
);
715 *((UINT16
*) InternalData
) = *((UINT16
*) Data
);
719 *((UINT32
*) InternalData
) = *((UINT32
*) Data
);
723 *((UINT64
*) InternalData
) = *((UINT64
*) Data
);
728 return EFI_NOT_FOUND
;
735 return EFI_NOT_FOUND
;
740 Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.
742 @param ExTokenNumber Token number for dynamic-ex PCD.
743 @param Guid Token space guid for dynamic-ex PCD.
744 @param Data Value want to be set.
745 @param SetSize The size of value.
747 @return status of ExSetWorker().
752 IN UINTN ExTokenNumber
,
753 IN CONST EFI_GUID
*Guid
,
758 return ExSetWorker (ExTokenNumber
, Guid
, Data
, &Size
, FALSE
);
762 Set value for a dynamic-ex PCD entry.
764 This routine find the local token number according to dynamic-ex PCD's token
765 space guid and token number firstly, and invoke callback function if this PCD
766 entry registered callback function. Finally, invoken general SetWorker to set
769 @param ExTokenNumber Dynamic-ex PCD token number.
770 @param Guid Token space guid for dynamic-ex PCD.
771 @param Data PCD value want to be set
772 @param SetSize Size of value.
773 @param PtrType If TRUE, this PCD entry is pointer type.
774 If FALSE, this PCD entry is not pointer type.
776 @return status of SetWorker().
781 IN UINTN ExTokenNumber
,
782 IN CONST EFI_GUID
*Guid
,
790 if (!FeaturePcdGet(PcdPeiFullPcdDatabaseEnable
)) {
791 return EFI_UNSUPPORTED
;
794 TokenNumber
= GetExPcdTokenNumber (Guid
, ExTokenNumber
);
795 if (TokenNumber
== PCD_INVALID_TOKEN_NUMBER
) {
796 return EFI_NOT_FOUND
;
799 InvokeCallbackOnSet (ExTokenNumber
, Guid
, TokenNumber
, Data
, *Size
);
801 return SetWorker (TokenNumber
, Data
, Size
, PtrType
);
806 Wrapper function for get PCD value for dynamic-ex PCD.
808 @param Guid Token space guid for dynamic-ex PCD.
809 @param ExTokenNumber Token number for dyanmic-ex PCD.
810 @param GetSize The size of dynamic-ex PCD value.
812 @return PCD entry in PCD database.
817 IN CONST EFI_GUID
*Guid
,
818 IN UINTN ExTokenNumber
,
822 return GetWorker (GetExPcdTokenNumber (Guid
, ExTokenNumber
), GetSize
);
826 Get the PCD entry pointer in PCD database.
828 This routine will visit PCD database to find the PCD entry according to given
829 token number. The given token number is autogened by build tools and it will be
830 translated to local token number. Local token number contains PCD's type and
831 offset of PCD entry in PCD database.
833 @param TokenNumber Token's number, it is autogened by build tools
834 @param GetSize The size of token's value
836 @return PCD entry pointer in PCD database
841 IN UINTN TokenNumber
,
848 VARIABLE_HEAD
*VariableHead
;
853 STRING_HEAD StringTableIdx
;
854 PEI_PCD_DATABASE
*PeiPcdDb
;
855 UINT32 LocalTokenNumber
;
856 UINT32 LocalTokenCount
;
857 UINT8
*VaraiableDefaultBuffer
;
858 UINTN VpdBaseAddress
;
861 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
862 // We have to decrement TokenNumber by 1 to make it usable
863 // as the array index.
867 PeiPcdDb
= GetPcdDatabase ();
868 LocalTokenCount
= PeiPcdDb
->LocalTokenCount
;
870 // EBC compiler is very choosy. It may report warning about comparison
871 // between UINTN and 0 . So we add 1 in each size of the
873 ASSERT (TokenNumber
+ 1 < (LocalTokenCount
+ 1));
875 ASSERT ((GetSize
== PeiPcdGetSize(TokenNumber
+ 1)) || (GetSize
== 0));
877 LocalTokenNumber
= GetLocalTokenNumber (PeiPcdDb
, TokenNumber
+ 1);
879 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
880 StringTable
= (UINT8
*)PeiPcdDb
+ PeiPcdDb
->StringTableOffset
;
882 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
886 VpdHead
= (VPD_HEAD
*) ((UINT8
*)PeiPcdDb
+ Offset
);
889 // PcdVpdBaseAddress64 is DynamicEx PCD only. So, PeiPcdGet64Ex() is used to get its value.
891 VpdBaseAddress
= (UINTN
) PeiPcdGet64Ex (&gEfiMdeModulePkgTokenSpaceGuid
, PcdToken (PcdVpdBaseAddress64
));
892 if (VpdBaseAddress
== 0) {
894 // PcdVpdBaseAddress64 is not set, get value from PcdVpdBaseAddress.
896 VpdBaseAddress
= (UINTN
) PcdGet32 (PcdVpdBaseAddress
);
898 ASSERT (VpdBaseAddress
!= 0);
899 return (VOID
*)(VpdBaseAddress
+ VpdHead
->Offset
);
902 case PCD_TYPE_HII
|PCD_TYPE_STRING
:
905 VariableHead
= (VARIABLE_HEAD
*) ((UINT8
*)PeiPcdDb
+ Offset
);
907 Guid
= (EFI_GUID
*) ((UINT8
*)PeiPcdDb
+ PeiPcdDb
->GuidTableOffset
) + VariableHead
->GuidTableIndex
;
908 Name
= (UINT16
*)&StringTable
[VariableHead
->StringIndex
];
910 if ((LocalTokenNumber
& PCD_TYPE_ALL_SET
) == (PCD_TYPE_HII
|PCD_TYPE_STRING
)) {
912 // If a HII type PCD's datum type is VOID*, the DefaultValueOffset is the index of
913 // string array in string table.
915 VaraiableDefaultBuffer
= (UINT8
*) &StringTable
[*(STRING_HEAD
*)((UINT8
*) PeiPcdDb
+ VariableHead
->DefaultValueOffset
)];
917 VaraiableDefaultBuffer
= (UINT8
*) PeiPcdDb
+ VariableHead
->DefaultValueOffset
;
919 Status
= GetHiiVariable (Guid
, Name
, &Data
, &DataSize
);
920 if ((Status
== EFI_SUCCESS
) && (DataSize
>= (VariableHead
->Offset
+ GetSize
))) {
923 // It is a pointer type. So get the MaxSize reserved for
926 GetPtrTypeSize (TokenNumber
, &GetSize
, PeiPcdDb
);
927 if (GetSize
> (DataSize
- VariableHead
->Offset
)) {
929 // Use actual valid size.
931 GetSize
= DataSize
- VariableHead
->Offset
;
935 // If the operation is successful, we copy the data
936 // to the default value buffer in the PCD Database.
938 CopyMem (VaraiableDefaultBuffer
, (UINT8
*) Data
+ VariableHead
->Offset
, GetSize
);
940 return (VOID
*) VaraiableDefaultBuffer
;
944 return (VOID
*) ((UINT8
*)PeiPcdDb
+ Offset
);
946 case PCD_TYPE_STRING
:
947 StringTableIdx
= * (STRING_HEAD
*) ((UINT8
*) PeiPcdDb
+ Offset
);
948 return (VOID
*) (&StringTable
[StringTableIdx
]);
963 Get Token Number according to dynamic-ex PCD's {token space guid:token number}
965 A dynamic-ex type PCD, developer must provide pair of token space guid: token number
966 in DEC file. PCD database maintain a mapping table that translate pair of {token
967 space guid: token number} to Token Number.
969 @param Guid Token space guid for dynamic-ex PCD entry.
970 @param ExTokenNumber Dynamic-ex PCD token number.
972 @return Token Number for dynamic-ex PCD.
976 GetExPcdTokenNumber (
977 IN CONST EFI_GUID
*Guid
,
978 IN UINTN ExTokenNumber
982 DYNAMICEX_MAPPING
*ExMap
;
986 PEI_PCD_DATABASE
*PeiPcdDb
;
988 PeiPcdDb
= GetPcdDatabase();
990 ExMap
= (DYNAMICEX_MAPPING
*)((UINT8
*)PeiPcdDb
+ PeiPcdDb
->ExMapTableOffset
);
991 GuidTable
= (EFI_GUID
*)((UINT8
*)PeiPcdDb
+ PeiPcdDb
->GuidTableOffset
);
993 MatchGuid
= ScanGuid (GuidTable
, PeiPcdDb
->GuidTableCount
* sizeof(EFI_GUID
), Guid
);
995 // We need to ASSERT here. If GUID can't be found in GuidTable, this is a
996 // error in the BUILD system.
998 ASSERT (MatchGuid
!= NULL
);
1000 MatchGuidIdx
= MatchGuid
- GuidTable
;
1002 for (Index
= 0; Index
< PeiPcdDb
->ExTokenCount
; Index
++) {
1003 if ((ExTokenNumber
== ExMap
[Index
].ExTokenNumber
) &&
1004 (MatchGuidIdx
== ExMap
[Index
].ExGuidIndex
)) {
1005 return ExMap
[Index
].TokenNumber
;
1009 return PCD_INVALID_TOKEN_NUMBER
;
1013 Get PCD database from GUID HOB in PEI phase.
1015 @return Pointer to PCD database.
1023 EFI_HOB_GUID_TYPE
*GuidHob
;
1025 GuidHob
= GetFirstGuidHob (&gPcdDataBaseHobGuid
);
1026 ASSERT (GuidHob
!= NULL
);
1028 return (PEI_PCD_DATABASE
*) GET_GUID_HOB_DATA (GuidHob
);
1032 Get index of PCD entry in size table.
1034 @param LocalTokenNumberTableIdx Index of this PCD in local token number table.
1035 @param Database Pointer to PCD database in PEI phase.
1037 @return index of PCD entry in size table.
1042 IN UINTN LocalTokenNumberTableIdx
,
1043 IN PEI_PCD_DATABASE
*Database
1048 UINTN LocalTokenNumber
;
1052 for (Index
= 0; Index
< LocalTokenNumberTableIdx
; Index
++) {
1053 LocalTokenNumber
= *((UINT32
*)((UINT8
*)Database
+ Database
->LocalTokenNumberTableOffset
) + Index
);
1055 if ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
) {
1057 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1060 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
1062 // We have only two entry for VPD enabled PCD entry:
1065 // Current size is equal to MAX size.
1070 // We have only two entry for Non-Sku enabled PCD entry:
1080 return SizeTableIdx
;