2 Help functions used by PCD DXE driver.
4 Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 PCD_DATABASE
*mPcdDatabase
;
19 LIST_ENTRY
*mCallbackFnTable
;
22 Get the PCD entry pointer in PCD database.
24 This routine will visit PCD database to find the PCD entry according to given
25 token number. The given token number is autogened by build tools and it will be
26 translated to local token number. Local token number contains PCD's type and
27 offset of PCD entry in PCD database.
29 @param TokenNumber Token's number, it is autogened by build tools
30 @param GetSize The size of token's value
32 @return PCD entry pointer in PCD database
41 UINT32
*LocalTokenNumberTable
;
46 VARIABLE_HEAD
*VariableHead
;
47 UINT8
*VaraiableDefaultBuffer
;
56 UINT32 LocalTokenNumber
;
58 STRING_HEAD StringTableIdx
;
62 // Aquire lock to prevent reentrance from TPL_CALLBACK level
64 EfiAcquireLock (&mPcdDatabaseLock
);
68 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
69 // We have to decrement TokenNumber by 1 to make it usable
70 // as the array index.
74 TmpTokenNumber
= TokenNumber
;
77 // PCD_TOTAL_TOKEN_NUMBER is a auto-generated constant.
78 // It could be zero. EBC compiler is very choosy. It may
79 // report warning. So we add 1 in each size of the
82 ASSERT (TokenNumber
+ 1 < PCD_TOTAL_TOKEN_NUMBER
+ 1);
84 ASSERT ((GetSize
== DxePcdGetSize (TokenNumber
+ 1)) || (GetSize
== 0));
86 // EBC compiler is very choosy. It may report warning about comparison
87 // between UINTN and 0 . So we add 1 in each size of the
89 IsPeiDb
= (BOOLEAN
) ((TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1) ? TRUE
: FALSE
);
91 LocalTokenNumberTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
:
92 mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
94 TokenNumber
= IsPeiDb
? TokenNumber
:
95 TokenNumber
- PEI_LOCAL_TOKEN_NUMBER
;
97 LocalTokenNumber
= LocalTokenNumberTable
[TokenNumber
];
99 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
101 GetPtrTypeSize (TmpTokenNumber
, &MaxSize
);
105 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, MaxSize
, IsPeiDb
);
108 PcdDb
= IsPeiDb
? ((UINT8
*) &mPcdDatabase
->PeiDb
) : ((UINT8
*) &mPcdDatabase
->DxeDb
);
111 StringTable
= (UINT8
*) (&mPcdDatabase
->PeiDb
.Init
.StringTable
[0]);
113 StringTable
= (UINT8
*) (&mPcdDatabase
->DxeDb
.Init
.StringTable
[0]);
117 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
119 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
121 VpdHead
= (VPD_HEAD
*) ((UINT8
*) PcdDb
+ Offset
);
122 RetPtr
= (VOID
*) (UINTN
) (PcdGet32 (PcdVpdBaseAddress
) + VpdHead
->Offset
);
125 case PCD_TYPE_HII
|PCD_TYPE_STRING
:
128 GuidTable
= (EFI_GUID
*) (&mPcdDatabase
->PeiDb
.Init
.GuidTable
[0]);
130 GuidTable
= (EFI_GUID
*) (&mPcdDatabase
->DxeDb
.Init
.GuidTable
[0]);
133 VariableHead
= (VARIABLE_HEAD
*) (PcdDb
+ Offset
);
134 Guid
= GuidTable
+ VariableHead
->GuidTableIndex
;
135 Name
= (UINT16
*)(StringTable
+ VariableHead
->StringIndex
);
137 if ((LocalTokenNumber
& PCD_TYPE_ALL_SET
) == (PCD_TYPE_HII
|PCD_TYPE_STRING
)) {
139 // If a HII type PCD's datum type is VOID*, the DefaultValueOffset is the index of
140 // string array in string table.
142 StringTableIdx
= *(STRING_HEAD
*)((UINT8
*) PcdDb
+ VariableHead
->DefaultValueOffset
);
143 VaraiableDefaultBuffer
= (VOID
*) (StringTable
+ StringTableIdx
);
144 Status
= GetHiiVariable (Guid
, Name
, &Data
, &DataSize
);
145 if (Status
== EFI_SUCCESS
) {
148 // It is a pointer type. So get the MaxSize reserved for
151 GetPtrTypeSize (TmpTokenNumber
, &GetSize
);
154 // If the operation is successful, we copy the data
155 // to the default value buffer in the PCD Database.
156 // So that we can free the Data allocated in GetHiiVariable.
158 CopyMem (VaraiableDefaultBuffer
, Data
+ VariableHead
->Offset
, GetSize
);
161 RetPtr
= (VOID
*) VaraiableDefaultBuffer
;
163 VaraiableDefaultBuffer
= (UINT8
*) PcdDb
+ VariableHead
->DefaultValueOffset
;
165 Status
= GetHiiVariable (Guid
, Name
, &Data
, &DataSize
);
166 if (Status
== EFI_SUCCESS
) {
169 // It is a pointer type. So get the MaxSize reserved for
172 GetPtrTypeSize (TmpTokenNumber
, &GetSize
);
175 // If the operation is successful, we copy the data
176 // to the default value buffer in the PCD Database.
177 // So that we can free the Data allocated in GetHiiVariable.
179 CopyMem (VaraiableDefaultBuffer
, Data
+ VariableHead
->Offset
, GetSize
);
182 RetPtr
= (VOID
*) VaraiableDefaultBuffer
;
186 case PCD_TYPE_STRING
:
187 StringTableIdx
= *(STRING_HEAD
*)((UINT8
*) PcdDb
+ Offset
);
188 RetPtr
= (VOID
*) (StringTable
+ StringTableIdx
);
192 RetPtr
= (VOID
*) ((UINT8
*) PcdDb
+ Offset
);
201 EfiReleaseLock (&mPcdDatabaseLock
);
208 Register the callback function for a PCD entry.
210 This routine will register a callback function to a PCD entry by given token number
211 and token space guid.
213 @param TokenNumber PCD token's number, it is autogened by build tools.
214 @param Guid PCD token space's guid,
215 if not NULL, this PCD is dynamicEx type PCD.
216 @param CallBackFunction Callback function pointer
218 @return EFI_SUCCESS Always success for registering callback function.
222 DxeRegisterCallBackWorker (
223 IN UINTN TokenNumber
,
224 IN CONST EFI_GUID
*Guid
, OPTIONAL
225 IN PCD_PROTOCOL_CALLBACK CallBackFunction
228 CALLBACK_FN_ENTRY
*FnTableEntry
;
229 LIST_ENTRY
*ListHead
;
230 LIST_ENTRY
*ListNode
;
233 TokenNumber
= GetExPcdTokenNumber (Guid
, (UINT32
) TokenNumber
);
237 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
238 // We have to decrement TokenNumber by 1 to make it usable
239 // as the array index of mCallbackFnTable[].
241 ListHead
= &mCallbackFnTable
[TokenNumber
- 1];
242 ListNode
= GetFirstNode (ListHead
);
244 while (ListNode
!= ListHead
) {
245 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE(ListNode
, CALLBACK_FN_ENTRY
, Node
);
247 if (FnTableEntry
->CallbackFn
== CallBackFunction
) {
249 // We only allow a Callback function to be register once
250 // for a TokenNumber. So just return EFI_SUCCESS
254 ListNode
= GetNextNode (ListHead
, ListNode
);
257 FnTableEntry
= AllocatePool (sizeof(CALLBACK_FN_ENTRY
));
258 ASSERT (FnTableEntry
!= NULL
);
260 FnTableEntry
->CallbackFn
= CallBackFunction
;
261 InsertTailList (ListHead
, &FnTableEntry
->Node
);
267 UnRegister the callback function for a PCD entry.
269 This routine will unregister a callback function to a PCD entry by given token number
270 and token space guid.
272 @param TokenNumber PCD token's number, it is autogened by build tools.
273 @param Guid PCD token space's guid.
274 if not NULL, this PCD is dynamicEx type PCD.
275 @param CallBackFunction Callback function pointer
277 @retval EFI_SUCCESS Callback function is success to be unregister.
278 @retval EFI_INVALID_PARAMETER Can not find the PCD entry by given token number.
281 DxeUnRegisterCallBackWorker (
282 IN UINTN TokenNumber
,
283 IN CONST EFI_GUID
*Guid
, OPTIONAL
284 IN PCD_PROTOCOL_CALLBACK CallBackFunction
287 CALLBACK_FN_ENTRY
*FnTableEntry
;
288 LIST_ENTRY
*ListHead
;
289 LIST_ENTRY
*ListNode
;
292 TokenNumber
= GetExPcdTokenNumber (Guid
, (UINT32
) TokenNumber
);
296 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
297 // We have to decrement TokenNumber by 1 to make it usable
298 // as the array index of mCallbackFnTable[].
300 ListHead
= &mCallbackFnTable
[TokenNumber
- 1];
301 ListNode
= GetFirstNode (ListHead
);
303 while (ListNode
!= ListHead
) {
304 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE(ListNode
, CALLBACK_FN_ENTRY
, Node
);
306 if (FnTableEntry
->CallbackFn
== CallBackFunction
) {
308 // We only allow a Callback function to be register once
309 // for a TokenNumber. So we can safely remove the Node from
310 // the Link List and return EFI_SUCCESS.
312 RemoveEntryList (ListNode
);
313 FreePool (FnTableEntry
);
317 ListNode
= GetNextNode (ListHead
, ListNode
);
320 return EFI_INVALID_PARAMETER
;
324 Get next token number in given token space.
326 This routine is used for dynamicEx type PCD. It will firstly scan token space
327 table to get token space according to given token space guid. Then scan given
328 token number in found token space, if found, then return next token number in
331 @param Guid Token space guid. Next token number will be scaned in
333 @param TokenNumber Token number.
334 If PCD_INVALID_TOKEN_NUMBER, return first token number in
336 If not PCD_INVALID_TOKEN_NUMBER, return next token number
337 in token space table.
338 @param GuidTable Token space guid table. It will be used for scan token space
339 by given token space guid.
340 @param SizeOfGuidTable The size of guid table.
341 @param ExMapTable DynamicEx token number mapping table.
342 @param SizeOfExMapTable The size of dynamicEx token number mapping table.
344 @retval EFI_NOT_FOUND Can not given token space or token number.
345 @retval EFI_SUCCESS Success to get next token number.
349 ExGetNextTokeNumber (
350 IN CONST EFI_GUID
*Guid
,
351 IN OUT UINTN
*TokenNumber
,
352 IN EFI_GUID
*GuidTable
,
353 IN UINTN SizeOfGuidTable
,
354 IN DYNAMICEX_MAPPING
*ExMapTable
,
355 IN UINTN SizeOfExMapTable
364 // Scan token space guid
366 MatchGuid
= ScanGuid (GuidTable
, SizeOfGuidTable
, Guid
);
367 if (MatchGuid
== NULL
) {
368 return EFI_NOT_FOUND
;
372 // Find the token space table in dynamicEx mapping table.
375 GuidTableIdx
= MatchGuid
- GuidTable
;
376 for (Index
= 0; Index
< SizeOfExMapTable
; Index
++) {
377 if (ExMapTable
[Index
].ExGuidIndex
== GuidTableIdx
) {
385 // If given token number is PCD_INVALID_TOKEN_NUMBER, then return the first
386 // token number in found token space.
388 if (*TokenNumber
== PCD_INVALID_TOKEN_NUMBER
) {
389 *TokenNumber
= ExMapTable
[Index
].ExTokenNumber
;
393 for ( ; Index
< SizeOfExMapTable
; Index
++) {
394 if (ExMapTable
[Index
].ExTokenNumber
== *TokenNumber
) {
396 if (Index
== SizeOfExMapTable
) {
398 // Exceed the length of ExMap Table
400 *TokenNumber
= PCD_INVALID_TOKEN_NUMBER
;
402 } else if (ExMapTable
[Index
].ExGuidIndex
== GuidTableIdx
) {
404 // Found the next match
406 *TokenNumber
= ExMapTable
[Index
].ExTokenNumber
;
410 // Guid has been changed. It is the next Token Space Guid.
411 // We should flag no more TokenNumber.
413 *TokenNumber
= PCD_INVALID_TOKEN_NUMBER
;
420 return EFI_NOT_FOUND
;
425 Initialize the PCD database in DXE phase.
427 PCD database in DXE phase also contains PCD database in PEI phase which is copied
432 BuildPcdDxeDataBase (
436 PEI_PCD_DATABASE
*PeiDatabase
;
437 EFI_HOB_GUID_TYPE
*GuidHob
;
440 mPcdDatabase
= AllocateZeroPool (sizeof(PCD_DATABASE
));
441 ASSERT (mPcdDatabase
!= NULL
);
443 GuidHob
= GetFirstGuidHob (&gPcdDataBaseHobGuid
);
444 if (GuidHob
!= NULL
) {
447 // We will copy over the PEI phase's PCD Database.
449 // If no PEIMs use dynamic Pcd Entry, the Pcd Service PEIM
450 // should not be included at all. So the GuidHob could
451 // be NULL. If it is NULL, we just copy over the DXE Default
452 // Value to PCD Database.
455 PeiDatabase
= (PEI_PCD_DATABASE
*) GET_GUID_HOB_DATA (GuidHob
);
457 // Copy PCD Entries refereneced in PEI phase to PCD DATABASE
459 CopyMem (&mPcdDatabase
->PeiDb
, PeiDatabase
, sizeof (PEI_PCD_DATABASE
));
463 // Copy PCD Entries with default value to PCD DATABASE
465 CopyMem (&mPcdDatabase
->DxeDb
.Init
, &gDXEPcdDbInit
, sizeof(DXE_PCD_DATABASE_INIT
));
469 // Initialized the Callback Function Table
472 mCallbackFnTable
= AllocateZeroPool (PCD_TOTAL_TOKEN_NUMBER
* sizeof (LIST_ENTRY
));
473 ASSERT(mCallbackFnTable
!= NULL
);
475 // EBC compiler is very choosy. It may report warning about comparison
476 // between UINTN and 0 . So we add 1 in each size of the
478 for (Index
= 0; Index
+ 1 < PCD_TOTAL_TOKEN_NUMBER
+ 1; Index
++) {
479 InitializeListHead (&mCallbackFnTable
[Index
]);
484 Get Variable which contains HII type PCD entry.
486 @param VariableGuid Variable's guid
487 @param VariableName Variable's unicode name string
488 @param VariableData Variable's data pointer,
489 @param VariableSize Variable's size.
491 @return the status of gRT->GetVariable
495 IN EFI_GUID
*VariableGuid
,
496 IN UINT16
*VariableName
,
497 OUT UINT8
**VariableData
,
498 OUT UINTN
*VariableSize
509 // Firstly get the real size of HII variable
511 Status
= gRT
->GetVariable (
512 (UINT16
*)VariableName
,
520 // Allocate buffer to hold whole variable data according to variable size.
522 if (Status
== EFI_BUFFER_TOO_SMALL
) {
523 Buffer
= (UINT8
*) AllocatePool (Size
);
525 ASSERT (Buffer
!= NULL
);
527 Status
= gRT
->GetVariable (
535 ASSERT (Status
== EFI_SUCCESS
);
536 *VariableData
= Buffer
;
537 *VariableSize
= Size
;
540 // Use Default Data only when variable is not found.
541 // For other error status, correct data can't be got, and trig ASSERT().
543 ASSERT (Status
== EFI_NOT_FOUND
);
550 Find the local token number according to system SKU ID.
552 @param LocalTokenNumber PCD token number
553 @param Size The size of PCD entry.
554 @param IsPeiDb If TRUE, the PCD entry is initialized in PEI phase.
555 If False, the PCD entry is initialized in DXE phase.
557 @return Token number according to system SKU ID.
561 GetSkuEnabledTokenNumber (
562 UINT32 LocalTokenNumber
,
571 SKU_ID
*PhaseSkuIdTable
;
574 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0);
576 PcdDb
= IsPeiDb
? (UINT8
*) &mPcdDatabase
->PeiDb
: (UINT8
*) &mPcdDatabase
->DxeDb
;
578 SkuHead
= (SKU_HEAD
*) (PcdDb
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
579 Value
= (UINT8
*) (PcdDb
+ SkuHead
->SkuDataStartOffset
);
581 PhaseSkuIdTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.SkuIdTable
:
582 mPcdDatabase
->DxeDb
.Init
.SkuIdTable
;
584 SkuIdTable
= &PhaseSkuIdTable
[SkuHead
->SkuIdTableOffset
];
587 // Find the current system's SKU ID entry in SKU ID table.
589 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
590 if (mPcdDatabase
->PeiDb
.Init
.SystemSkuId
== SkuIdTable
[Index
+ 1]) {
594 ASSERT (Index
< SkuIdTable
[0]);
596 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
598 Value
= (UINT8
*) &(((VPD_HEAD
*) Value
)[Index
]);
599 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_VPD
);
602 Value
= (UINT8
*) &(((VARIABLE_HEAD
*) Value
)[Index
]);
603 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_HII
);
605 case PCD_TYPE_STRING
:
606 Value
= (UINT8
*) &(((STRING_HEAD
*) Value
)[Index
]);
607 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_STRING
);
610 Value
+= Size
* Index
;
611 return (UINT32
) (Value
- PcdDb
);
624 Invoke the callback function when dynamic PCD entry was set, if this PCD entry
625 has registered callback function.
627 @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx
629 @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type
631 @param TokenNumber PCD token number generated by build tools.
632 @param Data Value want to be set for this PCD entry
633 @param Size The size of value
637 InvokeCallbackOnSet (
638 UINT32 ExTokenNumber
,
639 CONST EFI_GUID
*Guid
, OPTIONAL
645 CALLBACK_FN_ENTRY
*FnTableEntry
;
646 LIST_ENTRY
*ListHead
;
647 LIST_ENTRY
*ListNode
;
650 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
651 // We have to decrement TokenNumber by 1 to make it usable
652 // as the array index of mCallbackFnTable[].
654 ListHead
= &mCallbackFnTable
[TokenNumber
- 1];
655 ListNode
= GetFirstNode (ListHead
);
657 while (ListNode
!= ListHead
) {
658 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE (ListNode
, CALLBACK_FN_ENTRY
, Node
);
660 FnTableEntry
->CallbackFn(Guid
,
661 (Guid
== NULL
) ? TokenNumber
: ExTokenNumber
,
665 ListNode
= GetNextNode (ListHead
, ListNode
);
673 Wrapper function for setting non-pointer type value for a PCD entry.
675 @param TokenNumber Pcd token number autogenerated by build tools.
676 @param Data Value want to be set for PCD entry
677 @param Size Size of value.
679 @return status of SetWorker.
684 IN UINTN TokenNumber
,
689 return SetWorker (TokenNumber
, Data
, &Size
, FALSE
);
694 Set value for an PCD entry
696 @param TokenNumber Pcd token number autogenerated by build tools.
697 @param Data Value want to be set for PCD entry
698 @param Size Size of value.
699 @param PtrType If TRUE, the type of PCD entry's value is Pointer.
700 If False, the type of PCD entry's value is not Pointer.
702 @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.
703 @retval EFI_INVALID_PARAMETER If Size can not be set to size table.
704 @retval EFI_INVALID_PARAMETER If Size of non-Ptr type PCD does not match the size information in PCD database.
705 @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in
706 range of UINT8, UINT16, UINT32, UINT64
707 @retval EFI_NOT_FOUND Can not find the PCD type according to token number.
711 IN UINTN TokenNumber
,
717 UINT32
*LocalTokenNumberTable
;
719 UINT32 LocalTokenNumber
;
724 UINTN VariableOffset
;
726 VARIABLE_HEAD
*VariableHead
;
731 UINTN TmpTokenNumber
;
734 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
735 // We have to decrement TokenNumber by 1 to make it usable
736 // as the array index.
740 TmpTokenNumber
= TokenNumber
;
743 // EBC compiler is very choosy. It may report warning about comparison
744 // between UINTN and 0 . So we add 1 in each size of the
747 ASSERT (TokenNumber
+ 1 < PCD_TOTAL_TOKEN_NUMBER
+ 1);
751 // Get MaxSize first, then check new size with max buffer size.
753 GetPtrTypeSize (TokenNumber
, &MaxSize
);
754 if (*Size
> MaxSize
) {
756 return EFI_INVALID_PARAMETER
;
759 if (*Size
!= DxePcdGetSize (TokenNumber
+ 1)) {
760 return EFI_INVALID_PARAMETER
;
765 // EBC compiler is very choosy. It may report warning about comparison
766 // between UINTN and 0 . So we add 1 in each size of the
769 if ((TokenNumber
+ 1 < PEI_NEX_TOKEN_NUMBER
+ 1) ||
770 (TokenNumber
+ 1 >= PEI_LOCAL_TOKEN_NUMBER
+ 1 || TokenNumber
+ 1 < (PEI_LOCAL_TOKEN_NUMBER
+ DXE_NEX_TOKEN_NUMBER
+ 1))) {
771 InvokeCallbackOnSet (0, NULL
, TokenNumber
+ 1, Data
, *Size
);
775 // Aquire lock to prevent reentrance from TPL_CALLBACK level
777 EfiAcquireLock (&mPcdDatabaseLock
);
780 // EBC compiler is very choosy. It may report warning about comparison
781 // between UINTN and 0 . So we add 1 in each size of the
784 IsPeiDb
= (BOOLEAN
) ((TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1) ? TRUE
: FALSE
);
786 LocalTokenNumberTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
:
787 mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
789 TokenNumber
= IsPeiDb
? TokenNumber
790 : TokenNumber
- PEI_LOCAL_TOKEN_NUMBER
;
792 LocalTokenNumber
= LocalTokenNumberTable
[TokenNumber
];
794 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
796 GetPtrTypeSize (TmpTokenNumber
, &MaxSize
);
800 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, MaxSize
, IsPeiDb
);
803 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
805 PcdDb
= IsPeiDb
? ((UINT8
*) &mPcdDatabase
->PeiDb
) : ((UINT8
*) &mPcdDatabase
->DxeDb
);
808 StringTable
= (UINT8
*) (&mPcdDatabase
->PeiDb
.Init
.StringTable
[0]);
810 StringTable
= (UINT8
*) (&mPcdDatabase
->DxeDb
.Init
.StringTable
[0]);
814 InternalData
= PcdDb
+ Offset
;
816 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
819 Status
= EFI_INVALID_PARAMETER
;
822 case PCD_TYPE_STRING
:
823 if (SetPtrTypeSize (TmpTokenNumber
, Size
)) {
824 CopyMem (StringTable
+ *((STRING_HEAD
*)InternalData
), Data
, *Size
);
825 Status
= EFI_SUCCESS
;
827 Status
= EFI_INVALID_PARAMETER
;
831 case PCD_TYPE_HII
|PCD_TYPE_STRING
:
834 if (!SetPtrTypeSize (TmpTokenNumber
, Size
)) {
835 Status
= EFI_INVALID_PARAMETER
;
841 GuidTable
= (EFI_GUID
*) (&mPcdDatabase
->PeiDb
.Init
.GuidTable
[0]);
843 GuidTable
= (EFI_GUID
*) (&mPcdDatabase
->DxeDb
.Init
.GuidTable
[0]);
846 VariableHead
= (VARIABLE_HEAD
*) (PcdDb
+ Offset
);
848 Guid
= GuidTable
+ VariableHead
->GuidTableIndex
;
849 Name
= (UINT16
*) (StringTable
+ VariableHead
->StringIndex
);
850 VariableOffset
= VariableHead
->Offset
;
851 Status
= SetHiiVariable (Guid
, Name
, Data
, *Size
, VariableOffset
);
853 if (EFI_NOT_FOUND
== Status
) {
854 if ((LocalTokenNumber
& PCD_TYPE_ALL_SET
) == (PCD_TYPE_HII
|PCD_TYPE_STRING
)) {
856 StringTable
+ *(STRING_HEAD
*)(PcdDb
+ VariableHead
->DefaultValueOffset
),
861 CopyMem (PcdDb
+ VariableHead
->DefaultValueOffset
, Data
, *Size
);
863 Status
= EFI_SUCCESS
;
869 if (SetPtrTypeSize (TmpTokenNumber
, Size
)) {
870 CopyMem (InternalData
, Data
, *Size
);
871 Status
= EFI_SUCCESS
;
873 Status
= EFI_INVALID_PARAMETER
;
878 Status
= EFI_SUCCESS
;
881 *((UINT8
*) InternalData
) = *((UINT8
*) Data
);
885 *((UINT16
*) InternalData
) = *((UINT16
*) Data
);
889 *((UINT32
*) InternalData
) = *((UINT32
*) Data
);
893 *((UINT64
*) InternalData
) = *((UINT64
*) Data
);
898 Status
= EFI_NOT_FOUND
;
905 Status
= EFI_NOT_FOUND
;
909 EfiReleaseLock (&mPcdDatabaseLock
);
915 Wrapper function for get PCD value for dynamic-ex PCD.
917 @param Guid Token space guid for dynamic-ex PCD.
918 @param ExTokenNumber Token number for dynamic-ex PCD.
919 @param GetSize The size of dynamic-ex PCD value.
921 @return PCD entry in PCD database.
926 IN CONST EFI_GUID
*Guid
,
927 IN UINTN ExTokenNumber
,
931 return GetWorker(GetExPcdTokenNumber (Guid
, (UINT32
) ExTokenNumber
), GetSize
);
935 Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.
937 @param ExTokenNumber Token number for dynamic-ex PCD.
938 @param Guid Token space guid for dynamic-ex PCD.
939 @param Data Value want to be set.
940 @param SetSize The size of value.
942 @return status of ExSetWorker().
947 IN UINTN ExTokenNumber
,
948 IN CONST EFI_GUID
*Guid
,
953 return ExSetWorker (ExTokenNumber
, Guid
, Data
, &SetSize
, FALSE
);
957 Set value for a dynamic PCD entry.
959 This routine find the local token number according to dynamic-ex PCD's token
960 space guid and token number firstly, and invoke callback function if this PCD
961 entry registered callback function. Finally, invoken general SetWorker to set
964 @param ExTokenNumber Dynamic-ex PCD token number.
965 @param Guid Token space guid for dynamic-ex PCD.
966 @param Data PCD value want to be set
967 @param SetSize Size of value.
968 @param PtrType If TRUE, this PCD entry is pointer type.
969 If FALSE, this PCD entry is not pointer type.
971 @return status of SetWorker().
976 IN UINTN ExTokenNumber
,
977 IN CONST EFI_GUID
*Guid
,
979 IN OUT UINTN
*SetSize
,
985 TokenNumber
= GetExPcdTokenNumber (Guid
, (UINT32
) ExTokenNumber
);
987 InvokeCallbackOnSet ((UINT32
) ExTokenNumber
, Guid
, TokenNumber
, Data
, *SetSize
);
989 return SetWorker (TokenNumber
, Data
, SetSize
, PtrType
);
994 Set value for HII-type PCD.
996 A HII-type PCD's value is stored in a variable. Setting/Getting the value of
997 HII-type PCD is to visit this variable.
999 @param VariableGuid Guid of variable which stored value of a HII-type PCD.
1000 @param VariableName Unicode name of variable which stored value of a HII-type PCD.
1001 @param Data Value want to be set.
1002 @param DataSize Size of value
1003 @param Offset Value offset of HII-type PCD in variable.
1005 @return status of GetVariable()/SetVariable().
1010 IN EFI_GUID
*VariableGuid
,
1011 IN UINT16
*VariableName
,
1012 IN CONST VOID
*Data
,
1027 // Try to get original variable size information.
1029 Status
= gRT
->GetVariable (
1030 (UINT16
*)VariableName
,
1037 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1039 // Patch new PCD's value to offset in given HII variable.
1041 if (Size
>= (DataSize
+ Offset
)) {
1044 SetSize
= DataSize
+ Offset
;
1046 Buffer
= AllocatePool (SetSize
);
1047 ASSERT (Buffer
!= NULL
);
1049 Status
= gRT
->GetVariable (
1057 ASSERT_EFI_ERROR (Status
);
1059 CopyMem ((UINT8
*)Buffer
+ Offset
, Data
, DataSize
);
1061 Status
= gRT
->SetVariable (
1071 } else if (Status
== EFI_NOT_FOUND
) {
1073 // If variable does not exist, a new variable need to be created.
1076 Size
= Offset
+ DataSize
;
1078 Buffer
= AllocateZeroPool (Size
);
1079 ASSERT (Buffer
!= NULL
);
1081 CopyMem ((UINT8
*)Buffer
+ Offset
, Data
, DataSize
);
1083 Status
= gRT
->SetVariable (
1086 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1096 // If we drop to here, the value is failed to be written in to variable area
1097 // So, we will save the data in the PCD Database's volatile area.
1103 Get local token number according to dynamic-ex PCD's {token space guid:token number}
1105 A dynamic-ex type PCD, developer must provide pair of token space guid: token number
1106 in DEC file. PCD database maintain a mapping table that translate pair of {token
1107 space guid: token number} to local token number.
1109 @param Guid Token space guid for dynamic-ex PCD entry.
1110 @param ExTokenNumber Dynamic-ex PCD token number.
1112 @return local token number for dynamic-ex PCD.
1116 GetExPcdTokenNumber (
1117 IN CONST EFI_GUID
*Guid
,
1118 IN UINT32 ExTokenNumber
1122 DYNAMICEX_MAPPING
*ExMap
;
1123 EFI_GUID
*GuidTable
;
1124 EFI_GUID
*MatchGuid
;
1127 if (!PEI_DATABASE_EMPTY
) {
1128 ExMap
= mPcdDatabase
->PeiDb
.Init
.ExMapTable
;
1129 GuidTable
= mPcdDatabase
->PeiDb
.Init
.GuidTable
;
1131 MatchGuid
= ScanGuid (GuidTable
, sizeof(mPcdDatabase
->PeiDb
.Init
.GuidTable
), Guid
);
1133 if (MatchGuid
!= NULL
) {
1135 MatchGuidIdx
= MatchGuid
- GuidTable
;
1137 for (Index
= 0; Index
< PEI_EXMAPPING_TABLE_SIZE
; Index
++) {
1138 if ((ExTokenNumber
== ExMap
[Index
].ExTokenNumber
) &&
1139 (MatchGuidIdx
== ExMap
[Index
].ExGuidIndex
)) {
1140 return ExMap
[Index
].LocalTokenNumber
;
1146 ExMap
= mPcdDatabase
->DxeDb
.Init
.ExMapTable
;
1147 GuidTable
= mPcdDatabase
->DxeDb
.Init
.GuidTable
;
1149 MatchGuid
= ScanGuid (GuidTable
, sizeof(mPcdDatabase
->DxeDb
.Init
.GuidTable
), Guid
);
1151 // We need to ASSERT here. If GUID can't be found in GuidTable, this is a
1152 // error in the BUILD system.
1154 ASSERT (MatchGuid
!= NULL
);
1156 MatchGuidIdx
= MatchGuid
- GuidTable
;
1158 for (Index
= 0; Index
< DXE_EXMAPPING_TABLE_SIZE
; Index
++) {
1159 if ((ExTokenNumber
== ExMap
[Index
].ExTokenNumber
) &&
1160 (MatchGuidIdx
== ExMap
[Index
].ExGuidIndex
)) {
1161 return ExMap
[Index
].LocalTokenNumber
;
1171 Get SKU ID table from PCD database.
1173 @param LocalTokenNumberTableIdx Index of local token number in token number table.
1174 @param IsPeiPcd If TRUE,
1176 @return Pointer to SKU ID array table
1181 IN UINTN LocalTokenNumberTableIdx
,
1186 UINTN LocalTokenNumber
;
1190 LocalTokenNumber
= mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
1191 Database
= (UINT8
*) &mPcdDatabase
->PeiDb
;
1193 LocalTokenNumber
= mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
[LocalTokenNumberTableIdx
- PEI_LOCAL_TOKEN_NUMBER
];
1194 Database
= (UINT8
*) &mPcdDatabase
->DxeDb
;
1197 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) != 0);
1199 SkuHead
= (SKU_HEAD
*) ((UINT8
*)Database
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
1201 return (SKU_ID
*) (Database
+ SkuHead
->SkuIdTableOffset
);
1206 Wrapper function of getting index of PCD entry in size table.
1208 @param LocalTokenNumberTableIdx Index of this PCD in local token number table.
1209 @param IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
1210 If FALSE, the pcd entry is initialized in DXE phase.
1212 @return index of PCD entry in size table.
1216 IN UINTN LocalTokenNumberTableIdx
,
1220 UINT32
*LocalTokenNumberTable
;
1221 UINTN LocalTokenNumber
;
1227 LocalTokenNumberTable
= mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
;
1229 LocalTokenNumberTable
= mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
1234 for (Index
= 0; Index
< LocalTokenNumberTableIdx
; Index
++) {
1235 LocalTokenNumber
= LocalTokenNumberTable
[Index
];
1237 if ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
) {
1239 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1242 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
1244 // We have only one entry for VPD enabled PCD entry:
1246 // We consider current size is equal to MAX size.
1250 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
1252 // We have only two entry for Non-Sku enabled PCD entry:
1259 // We have these entry for SKU enabled PCD entry
1261 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1263 SkuIdTable
= GetSkuIdArray (Index
, IsPeiDb
);
1264 SizeTableIdx
+= (UINTN
)*SkuIdTable
+ 1;
1271 return SizeTableIdx
;
1275 Get size of POINTER type PCD value.
1277 @param LocalTokenNumberTableIdx Index of local token number in local token number table.
1278 @param MaxSize Maxmium size of POINTER type PCD value.
1280 @return size of POINTER type PCD value.
1285 IN UINTN LocalTokenNumberTableIdx
,
1290 UINTN LocalTokenNumber
;
1292 SIZE_INFO
*SizeTable
;
1295 UINT32
*LocalTokenNumberTable
;
1297 // EBC compiler is very choosy. It may report warning about comparison
1298 // between UINTN and 0 . So we add 1 in each size of the
1300 IsPeiDb
= (BOOLEAN
) (LocalTokenNumberTableIdx
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
1304 LocalTokenNumberTable
= mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
;
1305 SizeTable
= mPcdDatabase
->PeiDb
.Init
.SizeTable
;
1307 LocalTokenNumberTableIdx
-= PEI_LOCAL_TOKEN_NUMBER
;
1308 LocalTokenNumberTable
= mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
1309 SizeTable
= mPcdDatabase
->DxeDb
.Init
.SizeTable
;
1312 LocalTokenNumber
= LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
1314 ASSERT ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
);
1316 SizeTableIdx
= GetSizeTableIndex (LocalTokenNumberTableIdx
, IsPeiDb
);
1318 *MaxSize
= SizeTable
[SizeTableIdx
];
1320 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1323 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
1325 // We have only one entry for VPD enabled PCD entry:
1327 // We consider current size is equal to MAX size.
1331 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
1333 // We have only two entry for Non-Sku enabled PCD entry:
1337 return SizeTable
[SizeTableIdx
+ 1];
1340 // We have these entry for SKU enabled PCD entry
1342 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1344 SkuIdTable
= GetSkuIdArray (LocalTokenNumberTableIdx
, IsPeiDb
);
1345 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
1346 if (SkuIdTable
[1 + Index
] == mPcdDatabase
->PeiDb
.Init
.SystemSkuId
) {
1347 return SizeTable
[SizeTableIdx
+ 1 + Index
];
1350 return SizeTable
[SizeTableIdx
+ 1];
1356 Set size of POINTER type PCD value. The size should not exceed the maximum size
1359 @param LocalTokenNumberTableIdx Index of local token number in local token number table.
1360 @param CurrentSize Size of POINTER type PCD value.
1362 @retval TRUE Success to set size of PCD value.
1363 @retval FALSE Fail to set size of PCD value.
1367 IN UINTN LocalTokenNumberTableIdx
,
1368 IN OUT UINTN
*CurrentSize
1372 UINTN LocalTokenNumber
;
1374 SIZE_INFO
*SizeTable
;
1378 UINT32
*LocalTokenNumberTable
;
1381 // EBC compiler is very choosy. It may report warning about comparison
1382 // between UINTN and 0 . So we add 1 in each size of the
1385 IsPeiDb
= (BOOLEAN
) (LocalTokenNumberTableIdx
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
1388 LocalTokenNumberTable
= mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
;
1389 SizeTable
= mPcdDatabase
->PeiDb
.Init
.SizeTable
;
1391 LocalTokenNumberTableIdx
-= PEI_LOCAL_TOKEN_NUMBER
;
1392 LocalTokenNumberTable
= mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
1393 SizeTable
= mPcdDatabase
->DxeDb
.Init
.SizeTable
;
1396 LocalTokenNumber
= LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
1398 ASSERT ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
);
1400 SizeTableIdx
= GetSizeTableIndex (LocalTokenNumberTableIdx
, IsPeiDb
);
1402 MaxSize
= SizeTable
[SizeTableIdx
];
1404 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1407 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
1409 // We shouldn't come here as we don't support SET for VPD
1414 if ((*CurrentSize
> MaxSize
) ||
1415 (*CurrentSize
== MAX_ADDRESS
)) {
1416 *CurrentSize
= MaxSize
;
1420 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
1422 // We have only two entry for Non-Sku enabled PCD entry:
1426 SizeTable
[SizeTableIdx
+ 1] = (SIZE_INFO
) *CurrentSize
;
1430 // We have these entry for SKU enabled PCD entry
1432 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1434 SkuIdTable
= GetSkuIdArray (LocalTokenNumberTableIdx
, IsPeiDb
);
1435 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
1436 if (SkuIdTable
[1 + Index
] == mPcdDatabase
->PeiDb
.Init
.SystemSkuId
) {
1437 SizeTable
[SizeTableIdx
+ 1 + Index
] = (SIZE_INFO
) *CurrentSize
;
1441 SizeTable
[SizeTableIdx
+ 1] = (SIZE_INFO
) *CurrentSize
;