2 Help functions used by PCD DXE driver.
4 Copyright (c) 2006 - 2007, Intel Corporation
5 All rights reserved. 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 UINT16 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
) (FixedPcdGet32(PcdVpdBaseAddress
) + VpdHead
->Offset
);
127 GuidTable
= (EFI_GUID
*) (&mPcdDatabase
->PeiDb
.Init
.GuidTable
[0]);
129 GuidTable
= (EFI_GUID
*) (&mPcdDatabase
->DxeDb
.Init
.GuidTable
[0]);
132 VariableHead
= (VARIABLE_HEAD
*) (PcdDb
+ Offset
);
134 Guid
= GuidTable
+ VariableHead
->GuidTableIndex
;
135 Name
= (UINT16
*)(StringTable
+ VariableHead
->StringIndex
);
136 VaraiableDefaultBuffer
= (UINT8
*) PcdDb
+ VariableHead
->DefaultValueOffset
;
138 Status
= GetHiiVariable (Guid
, Name
, &Data
, &DataSize
);
139 if (Status
== EFI_SUCCESS
) {
142 // It is a pointer type. So get the MaxSize reserved for
145 GetPtrTypeSize (TmpTokenNumber
, &GetSize
);
147 CopyMem (VaraiableDefaultBuffer
, Data
+ VariableHead
->Offset
, GetSize
);
151 // If the operation is successful, we copy the data
152 // to the default value buffer in the PCD Database.
153 // So that we can free the Data allocated in GetHiiVariable.
156 // If the operation is not successful,
157 // Return 1) either the default value specified by Platform Integrator
158 // 2) Or the value Set by a PCD set operation.
160 RetPtr
= (VOID
*) VaraiableDefaultBuffer
;
163 case PCD_TYPE_STRING
:
164 StringTableIdx
= *(UINT16
*)((UINT8
*) PcdDb
+ Offset
);
165 RetPtr
= (VOID
*) (StringTable
+ StringTableIdx
);
169 RetPtr
= (VOID
*) ((UINT8
*) PcdDb
+ Offset
);
178 EfiReleaseLock (&mPcdDatabaseLock
);
185 Register the callback function for a PCD entry.
187 This routine will register a callback function to a PCD entry by given token number
188 and token space guid.
190 @param TokenNumber PCD token's number, it is autogened by build tools.
191 @param Guid PCD token space's guid,
192 if not NULL, this PCD is dynamicEx type PCD.
193 @param CallBackFunction Callback function pointer
195 @return EFI_SUCCESS Always success for registering callback function.
199 DxeRegisterCallBackWorker (
200 IN UINTN TokenNumber
,
201 IN CONST EFI_GUID
*Guid
, OPTIONAL
202 IN PCD_PROTOCOL_CALLBACK CallBackFunction
205 CALLBACK_FN_ENTRY
*FnTableEntry
;
206 LIST_ENTRY
*ListHead
;
207 LIST_ENTRY
*ListNode
;
210 TokenNumber
= GetExPcdTokenNumber (Guid
, (UINT32
) TokenNumber
);
214 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
215 // We have to decrement TokenNumber by 1 to make it usable
216 // as the array index.
220 ListHead
= &mCallbackFnTable
[TokenNumber
];
221 ListNode
= GetFirstNode (ListHead
);
223 while (ListNode
!= ListHead
) {
224 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE(ListNode
, CALLBACK_FN_ENTRY
, Node
);
226 if (FnTableEntry
->CallbackFn
== CallBackFunction
) {
228 // We only allow a Callback function to be register once
229 // for a TokenNumber. So just return EFI_SUCCESS
233 ListNode
= GetNextNode (ListHead
, ListNode
);
236 FnTableEntry
= AllocatePool (sizeof(CALLBACK_FN_ENTRY
));
237 ASSERT (FnTableEntry
!= NULL
);
239 FnTableEntry
->CallbackFn
= CallBackFunction
;
240 InsertTailList (ListHead
, &FnTableEntry
->Node
);
246 UnRegister the callback function for a PCD entry.
248 This routine will unregister a callback function to a PCD entry by given token number
249 and token space guid.
251 @param TokenNumber PCD token's number, it is autogened by build tools.
252 @param Guid PCD token space's guid.
253 if not NULL, this PCD is dynamicEx type PCD.
254 @param CallBackFunction Callback function pointer
256 @retval EFI_SUCCESS Callback function is success to be unregister.
257 @retval EFI_INVALID_PARAMETER Can not find the PCD entry by given token number.
260 DxeUnRegisterCallBackWorker (
261 IN UINTN TokenNumber
,
262 IN CONST EFI_GUID
*Guid
, OPTIONAL
263 IN PCD_PROTOCOL_CALLBACK CallBackFunction
266 CALLBACK_FN_ENTRY
*FnTableEntry
;
267 LIST_ENTRY
*ListHead
;
268 LIST_ENTRY
*ListNode
;
271 TokenNumber
= GetExPcdTokenNumber (Guid
, (UINT32
) TokenNumber
);
275 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
276 // We have to decrement TokenNumber by 1 to make it usable
277 // as the array index.
281 ListHead
= &mCallbackFnTable
[TokenNumber
];
282 ListNode
= GetFirstNode (ListHead
);
284 while (ListNode
!= ListHead
) {
285 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE(ListNode
, CALLBACK_FN_ENTRY
, Node
);
287 if (FnTableEntry
->CallbackFn
== CallBackFunction
) {
289 // We only allow a Callback function to be register once
290 // for a TokenNumber. So we can safely remove the Node from
291 // the Link List and return EFI_SUCCESS.
293 RemoveEntryList (ListNode
);
294 FreePool (FnTableEntry
);
298 ListNode
= GetNextNode (ListHead
, ListNode
);
301 return EFI_INVALID_PARAMETER
;
305 Get next token number in given token space.
307 This routine is used for dynamicEx type PCD. It will firstly scan token space
308 table to get token space according to given token space guid. Then scan given
309 token number in found token space, if found, then return next token number in
312 @param Guid Token space guid. Next token number will be scaned in
314 @param TokenNumber Token number.
315 If PCD_INVALID_TOKEN_NUMBER, return first token number in
317 If not PCD_INVALID_TOKEN_NUMBER, return next token number
318 in token space table.
319 @param GuidTable Token space guid table. It will be used for scan token space
320 by given token space guid.
321 @param SizeOfGuidTable The size of guid table.
322 @param ExMapTable DynamicEx token number mapping table.
323 @param SizeOfExMapTable The size of dynamicEx token number mapping table.
325 @retval EFI_NOT_FOUND Can not given token space or token number.
326 @retval EFI_SUCCESS Success to get next token number.
330 ExGetNextTokeNumber (
331 IN CONST EFI_GUID
*Guid
,
332 IN OUT UINTN
*TokenNumber
,
333 IN EFI_GUID
*GuidTable
,
334 IN UINTN SizeOfGuidTable
,
335 IN DYNAMICEX_MAPPING
*ExMapTable
,
336 IN UINTN SizeOfExMapTable
345 // Scan token space guid
347 MatchGuid
= ScanGuid (GuidTable
, SizeOfGuidTable
, Guid
);
348 if (MatchGuid
== NULL
) {
349 return EFI_NOT_FOUND
;
353 // Find the token space table in dynamicEx mapping table.
356 GuidTableIdx
= MatchGuid
- GuidTable
;
357 for (Index
= 0; Index
< SizeOfExMapTable
; Index
++) {
358 if (ExMapTable
[Index
].ExGuidIndex
== GuidTableIdx
) {
366 // If given token number is PCD_INVALID_TOKEN_NUMBER, then return the first
367 // token number in found token space.
369 if (*TokenNumber
== PCD_INVALID_TOKEN_NUMBER
) {
370 *TokenNumber
= ExMapTable
[Index
].ExTokenNumber
;
374 for ( ; Index
< SizeOfExMapTable
; Index
++) {
375 if (ExMapTable
[Index
].ExTokenNumber
== *TokenNumber
) {
377 if (Index
== SizeOfExMapTable
) {
379 // Exceed the length of ExMap Table
381 *TokenNumber
= PCD_INVALID_TOKEN_NUMBER
;
383 } else if (ExMapTable
[Index
].ExGuidIndex
== GuidTableIdx
) {
385 // Found the next match
387 *TokenNumber
= ExMapTable
[Index
].ExTokenNumber
;
391 // Guid has been changed. It is the next Token Space Guid.
392 // We should flag no more TokenNumber.
394 *TokenNumber
= PCD_INVALID_TOKEN_NUMBER
;
401 return EFI_NOT_FOUND
;
406 Initialize the PCD database in DXE phase.
408 PCD database in DXE phase also contains PCD database in PEI phase which is copied
413 BuildPcdDxeDataBase (
417 PEI_PCD_DATABASE
*PeiDatabase
;
418 EFI_HOB_GUID_TYPE
*GuidHob
;
421 mPcdDatabase
= AllocateZeroPool (sizeof(PCD_DATABASE
));
422 ASSERT (mPcdDatabase
!= NULL
);
424 GuidHob
= GetFirstGuidHob (&gPcdDataBaseHobGuid
);
425 if (GuidHob
!= NULL
) {
428 // We will copy over the PEI phase's PCD Database.
430 // If no PEIMs use dynamic Pcd Entry, the Pcd Service PEIM
431 // should not be included at all. So the GuidHob could
432 // be NULL. If it is NULL, we just copy over the DXE Default
433 // Value to PCD Database.
436 PeiDatabase
= (PEI_PCD_DATABASE
*) GET_GUID_HOB_DATA (GuidHob
);
438 // Copy PCD Entries refereneced in PEI phase to PCD DATABASE
440 CopyMem (&mPcdDatabase
->PeiDb
, PeiDatabase
, sizeof (PEI_PCD_DATABASE
));
444 // Copy PCD Entries with default value to PCD DATABASE
446 CopyMem (&mPcdDatabase
->DxeDb
.Init
, &gDXEPcdDbInit
, sizeof(DXE_PCD_DATABASE_INIT
));
450 // Initialized the Callback Function Table
453 mCallbackFnTable
= AllocateZeroPool (PCD_TOTAL_TOKEN_NUMBER
* sizeof (LIST_ENTRY
));
454 ASSERT(mCallbackFnTable
!= NULL
);
456 // EBC compiler is very choosy. It may report warning about comparison
457 // between UINTN and 0 . So we add 1 in each size of the
459 for (Index
= 0; Index
+ 1 < PCD_TOTAL_TOKEN_NUMBER
+ 1; Index
++) {
460 InitializeListHead (&mCallbackFnTable
[Index
]);
465 Get Variable which contains HII type PCD entry.
467 @param VariableGuid Variable's guid
468 @param VariableName Variable's unicode name string
469 @param VariableData Variable's data pointer,
470 @param VariableSize Variable's size.
472 @return the status of gRT->GetVariable
476 IN EFI_GUID
*VariableGuid
,
477 IN UINT16
*VariableName
,
478 OUT UINT8
**VariableData
,
479 OUT UINTN
*VariableSize
490 // Firstly get the real size of HII variable
492 Status
= gRT
->GetVariable (
493 (UINT16
*)VariableName
,
501 // Allocate buffer to hold whole variable data according to variable size.
503 if (Status
== EFI_BUFFER_TOO_SMALL
) {
504 Buffer
= (UINT8
*) AllocatePool (Size
);
506 ASSERT (Buffer
!= NULL
);
508 Status
= gRT
->GetVariable (
516 ASSERT (Status
== EFI_SUCCESS
);
517 *VariableData
= Buffer
;
518 *VariableSize
= Size
;
525 Find the local token number according to system SKU ID.
527 @param LocalTokenNumber PCD token number
528 @param Size The size of PCD entry.
529 @param IsPeiDb If TRUE, the PCD entry is initialized in PEI phase.
530 If False, the PCD entry is initialized in DXE phase.
532 @return Token number according to system SKU ID.
536 GetSkuEnabledTokenNumber (
537 UINT32 LocalTokenNumber
,
546 SKU_ID
*PhaseSkuIdTable
;
549 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0);
551 PcdDb
= IsPeiDb
? (UINT8
*) &mPcdDatabase
->PeiDb
: (UINT8
*) &mPcdDatabase
->DxeDb
;
553 SkuHead
= (SKU_HEAD
*) (PcdDb
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
554 Value
= (UINT8
*) (PcdDb
+ SkuHead
->SkuDataStartOffset
);
556 PhaseSkuIdTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.SkuIdTable
:
557 mPcdDatabase
->DxeDb
.Init
.SkuIdTable
;
559 SkuIdTable
= &PhaseSkuIdTable
[SkuHead
->SkuIdTableOffset
];
562 // Find the current system's SKU ID entry in SKU ID table.
564 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
565 if (mPcdDatabase
->PeiDb
.Init
.SystemSkuId
== SkuIdTable
[Index
+ 1]) {
569 ASSERT (Index
< SkuIdTable
[0]);
571 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
573 Value
= (UINT8
*) &(((VPD_HEAD
*) Value
)[Index
]);
574 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_VPD
);
577 Value
= (UINT8
*) &(((VARIABLE_HEAD
*) Value
)[Index
]);
578 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_HII
);
580 case PCD_TYPE_STRING
:
581 Value
= (UINT8
*) &(((STRING_HEAD
*) Value
)[Index
]);
582 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_STRING
);
585 Value
+= Size
* Index
;
586 return (UINT32
) (Value
- PcdDb
);
599 Invoke the callback function when dynamic PCD entry was set, if this PCD entry
600 has registered callback function.
602 @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx
604 @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type
606 @param TokenNumber PCD token number generated by build tools.
607 @param Data Value want to be set for this PCD entry
608 @param Size The size of value
612 InvokeCallbackOnSet (
613 UINT32 ExTokenNumber
,
614 CONST EFI_GUID
*Guid
, OPTIONAL
620 CALLBACK_FN_ENTRY
*FnTableEntry
;
621 LIST_ENTRY
*ListHead
;
622 LIST_ENTRY
*ListNode
;
625 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
626 // We have to decrement TokenNumber by 1 to make it usable
627 // as the array index.
631 ListHead
= &mCallbackFnTable
[TokenNumber
];
632 ListNode
= GetFirstNode (ListHead
);
634 while (ListNode
!= ListHead
) {
635 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE(ListNode
, CALLBACK_FN_ENTRY
, Node
);
637 FnTableEntry
->CallbackFn(Guid
,
638 (Guid
== NULL
) ? TokenNumber
: ExTokenNumber
,
642 ListNode
= GetNextNode (ListHead
, ListNode
);
650 Wrapper function for setting non-pointer type value for a PCD entry.
652 @param TokenNumber Pcd token number autogenerated by build tools.
653 @param Data Value want to be set for PCD entry
654 @param Size Size of value.
656 @return status of SetWorker.
661 IN UINTN TokenNumber
,
666 return SetWorker (TokenNumber
, Data
, &Size
, FALSE
);
671 Set value for an PCD entry
673 @param TokenNumber Pcd token number autogenerated by build tools.
674 @param Data Value want to be set for PCD entry
675 @param Size Size of value.
676 @param PtrType If TRUE, the type of PCD entry's value is Pointer.
677 If False, the type of PCD entry's value is not Pointer.
679 @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.
680 @retval EFI_INVALID_PARAMETER If Size can not be set to size table.
681 @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in
682 range of UINT8, UINT16, UINT32, UINT64
683 @retval EFI_NOT_FOUND Can not find the PCD type according to token number.
687 IN UINTN TokenNumber
,
693 UINT32
*LocalTokenNumberTable
;
695 UINT32 LocalTokenNumber
;
700 UINTN VariableOffset
;
702 VARIABLE_HEAD
*VariableHead
;
707 UINTN TmpTokenNumber
;
710 // Aquire lock to prevent reentrance from TPL_CALLBACK level
712 EfiAcquireLock (&mPcdDatabaseLock
);
715 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
716 // We have to decrement TokenNumber by 1 to make it usable
717 // as the array index.
721 TmpTokenNumber
= TokenNumber
;
724 // EBC compiler is very choosy. It may report warning about comparison
725 // between UINTN and 0 . So we add 1 in each size of the
728 ASSERT (TokenNumber
+ 1 < PCD_TOTAL_TOKEN_NUMBER
+ 1);
731 ASSERT (*Size
== DxePcdGetSize (TokenNumber
+ 1));
735 // EBC compiler is very choosy. It may report warning about comparison
736 // between UINTN and 0 . So we add 1 in each size of the
739 IsPeiDb
= (BOOLEAN
) ((TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1) ? TRUE
: FALSE
);
741 LocalTokenNumberTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
:
742 mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
745 // EBC compiler is very choosy. It may report warning about comparison
746 // between UINTN and 0 . So we add 1 in each size of the
749 if ((TokenNumber
+ 1 < PEI_NEX_TOKEN_NUMBER
+ 1) ||
750 (TokenNumber
+ 1 >= PEI_LOCAL_TOKEN_NUMBER
+ 1 || TokenNumber
+ 1 < (PEI_LOCAL_TOKEN_NUMBER
+ DXE_NEX_TOKEN_NUMBER
+ 1))) {
751 InvokeCallbackOnSet (0, NULL
, TokenNumber
+ 1, Data
, *Size
);
754 TokenNumber
= IsPeiDb
? TokenNumber
755 : TokenNumber
- PEI_LOCAL_TOKEN_NUMBER
;
757 LocalTokenNumber
= LocalTokenNumberTable
[TokenNumber
];
759 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
761 GetPtrTypeSize (TmpTokenNumber
, &MaxSize
);
765 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, MaxSize
, IsPeiDb
);
768 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
770 PcdDb
= IsPeiDb
? ((UINT8
*) &mPcdDatabase
->PeiDb
) : ((UINT8
*) &mPcdDatabase
->DxeDb
);
773 StringTable
= (UINT8
*) (&mPcdDatabase
->PeiDb
.Init
.StringTable
[0]);
775 StringTable
= (UINT8
*) (&mPcdDatabase
->DxeDb
.Init
.StringTable
[0]);
779 InternalData
= PcdDb
+ Offset
;
781 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
784 Status
= EFI_INVALID_PARAMETER
;
787 case PCD_TYPE_STRING
:
788 if (SetPtrTypeSize (TmpTokenNumber
, Size
)) {
789 CopyMem (StringTable
+ *((UINT16
*)InternalData
), Data
, *Size
);
790 Status
= EFI_SUCCESS
;
792 Status
= EFI_INVALID_PARAMETER
;
798 if (!SetPtrTypeSize (TmpTokenNumber
, Size
)) {
799 Status
= EFI_INVALID_PARAMETER
;
805 GuidTable
= (EFI_GUID
*) (&mPcdDatabase
->PeiDb
.Init
.GuidTable
[0]);
807 GuidTable
= (EFI_GUID
*) (&mPcdDatabase
->DxeDb
.Init
.GuidTable
[0]);
810 VariableHead
= (VARIABLE_HEAD
*) (PcdDb
+ Offset
);
812 Guid
= GuidTable
+ VariableHead
->GuidTableIndex
;
813 Name
= (UINT16
*) (StringTable
+ VariableHead
->StringIndex
);
814 VariableOffset
= VariableHead
->Offset
;
816 Status
= SetHiiVariable (Guid
, Name
, Data
, *Size
, VariableOffset
);
818 if (EFI_NOT_FOUND
== Status
) {
819 CopyMem (PcdDb
+ VariableHead
->DefaultValueOffset
, Data
, *Size
);
820 Status
= EFI_SUCCESS
;
826 if (SetPtrTypeSize (TmpTokenNumber
, Size
)) {
827 CopyMem (InternalData
, Data
, *Size
);
828 Status
= EFI_SUCCESS
;
830 Status
= EFI_INVALID_PARAMETER
;
835 Status
= EFI_SUCCESS
;
838 *((UINT8
*) InternalData
) = *((UINT8
*) Data
);
842 *((UINT16
*) InternalData
) = *((UINT16
*) Data
);
846 *((UINT32
*) InternalData
) = *((UINT32
*) Data
);
850 *((UINT64
*) InternalData
) = *((UINT64
*) Data
);
855 Status
= EFI_NOT_FOUND
;
862 Status
= EFI_NOT_FOUND
;
866 EfiReleaseLock (&mPcdDatabaseLock
);
872 Wrapper function for get PCD value for dynamic-ex PCD.
874 @param Guid Token space guid for dynamic-ex PCD.
875 @param ExTokenNumber Token number for dynamic-ex PCD.
876 @param GetSize The size of dynamic-ex PCD value.
878 @return PCD entry in PCD database.
883 IN CONST EFI_GUID
*Guid
,
884 IN UINTN ExTokenNumber
,
888 return GetWorker(GetExPcdTokenNumber (Guid
, (UINT32
) ExTokenNumber
), GetSize
);
892 Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.
894 @param ExTokenNumber Token number for dynamic-ex PCD.
895 @param Guid Token space guid for dynamic-ex PCD.
896 @param Data Value want to be set.
897 @param SetSize The size of value.
899 @return status of ExSetWorker().
904 IN UINTN ExTokenNumber
,
905 IN CONST EFI_GUID
*Guid
,
910 return ExSetWorker (ExTokenNumber
, Guid
, Data
, &SetSize
, FALSE
);
914 Set value for a dynamic PCD entry.
916 This routine find the local token number according to dynamic-ex PCD's token
917 space guid and token number firstly, and invoke callback function if this PCD
918 entry registered callback function. Finally, invoken general SetWorker to set
921 @param ExTokenNumber Dynamic-ex PCD token number.
922 @param Guid Token space guid for dynamic-ex PCD.
923 @param Data PCD value want to be set
924 @param SetSize Size of value.
925 @param PtrType If TRUE, this PCD entry is pointer type.
926 If FALSE, this PCD entry is not pointer type.
928 @return status of SetWorker().
933 IN UINTN ExTokenNumber
,
934 IN CONST EFI_GUID
*Guid
,
936 IN OUT UINTN
*SetSize
,
942 TokenNumber
= GetExPcdTokenNumber (Guid
, (UINT32
) ExTokenNumber
);
944 InvokeCallbackOnSet ((UINT32
) ExTokenNumber
, Guid
, TokenNumber
, Data
, *SetSize
);
946 return SetWorker (TokenNumber
, Data
, SetSize
, PtrType
);
951 Set value for HII-type PCD.
953 A HII-type PCD's value is stored in a variable. Setting/Getting the value of
954 HII-type PCD is to visit this variable.
956 @param VariableGuid Guid of variable which stored value of a HII-type PCD.
957 @param VariableName Unicode name of variable which stored value of a HII-type PCD.
958 @param Data Value want to be set.
959 @param DataSize Size of value
960 @param Offset Value offset of HII-type PCD in variable.
962 @return status of GetVariable()/SetVariable().
967 IN EFI_GUID
*VariableGuid
,
968 IN UINT16
*VariableName
,
984 // Try to get original variable size information.
986 Status
= gRT
->GetVariable (
987 (UINT16
*)VariableName
,
994 if (Status
== EFI_BUFFER_TOO_SMALL
) {
996 // Patch new PCD's value to offset in given HII variable.
998 if (Size
>= (DataSize
+ Offset
)) {
1001 SetSize
= DataSize
+ Offset
;
1003 Buffer
= AllocatePool (SetSize
);
1004 ASSERT (Buffer
!= NULL
);
1006 Status
= gRT
->GetVariable (
1014 ASSERT_EFI_ERROR (Status
);
1016 CopyMem ((UINT8
*)Buffer
+ Offset
, Data
, DataSize
);
1018 Status
= gRT
->SetVariable (
1028 } else if (Status
== EFI_NOT_FOUND
) {
1030 // If variable does not exist, a new variable need to be created.
1033 Size
= Offset
+ DataSize
;
1035 Buffer
= AllocateZeroPool (Size
);
1036 ASSERT (Buffer
!= NULL
);
1038 CopyMem ((UINT8
*)Buffer
+ Offset
, Data
, DataSize
);
1040 Status
= gRT
->SetVariable (
1043 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1053 // If we drop to here, the value is failed to be written in to variable area
1054 // So, we will save the data in the PCD Database's volatile area.
1060 Get local token number according to dynamic-ex PCD's {token space guid:token number}
1062 A dynamic-ex type PCD, developer must provide pair of token space guid: token number
1063 in DEC file. PCD database maintain a mapping table that translate pair of {token
1064 space guid: token number} to local token number.
1066 @param Guid Token space guid for dynamic-ex PCD entry.
1067 @param ExTokenNumber Dynamic-ex PCD token number.
1069 @return local token number for dynamic-ex PCD.
1073 GetExPcdTokenNumber (
1074 IN CONST EFI_GUID
*Guid
,
1075 IN UINT32 ExTokenNumber
1079 DYNAMICEX_MAPPING
*ExMap
;
1080 EFI_GUID
*GuidTable
;
1081 EFI_GUID
*MatchGuid
;
1084 if (!PEI_DATABASE_EMPTY
) {
1085 ExMap
= mPcdDatabase
->PeiDb
.Init
.ExMapTable
;
1086 GuidTable
= mPcdDatabase
->PeiDb
.Init
.GuidTable
;
1088 MatchGuid
= ScanGuid (GuidTable
, sizeof(mPcdDatabase
->PeiDb
.Init
.GuidTable
), Guid
);
1090 if (MatchGuid
!= NULL
) {
1092 MatchGuidIdx
= MatchGuid
- GuidTable
;
1094 for (Index
= 0; Index
< PEI_EXMAPPING_TABLE_SIZE
; Index
++) {
1095 if ((ExTokenNumber
== ExMap
[Index
].ExTokenNumber
) &&
1096 (MatchGuidIdx
== ExMap
[Index
].ExGuidIndex
)) {
1097 return ExMap
[Index
].LocalTokenNumber
;
1103 ExMap
= mPcdDatabase
->DxeDb
.Init
.ExMapTable
;
1104 GuidTable
= mPcdDatabase
->DxeDb
.Init
.GuidTable
;
1106 MatchGuid
= ScanGuid (GuidTable
, sizeof(mPcdDatabase
->DxeDb
.Init
.GuidTable
), Guid
);
1108 // We need to ASSERT here. If GUID can't be found in GuidTable, this is a
1109 // error in the BUILD system.
1111 ASSERT (MatchGuid
!= NULL
);
1113 MatchGuidIdx
= MatchGuid
- GuidTable
;
1115 for (Index
= 0; Index
< DXE_EXMAPPING_TABLE_SIZE
; Index
++) {
1116 if ((ExTokenNumber
== ExMap
[Index
].ExTokenNumber
) &&
1117 (MatchGuidIdx
== ExMap
[Index
].ExGuidIndex
)) {
1118 return ExMap
[Index
].LocalTokenNumber
;
1128 Get SKU ID table from PCD database.
1130 @param LocalTokenNumberTableIdx Index of local token number in token number table.
1131 @param IsPeiPcd If TRUE,
1133 @return Pointer to SKU ID array table
1138 IN UINTN LocalTokenNumberTableIdx
,
1143 UINTN LocalTokenNumber
;
1147 LocalTokenNumber
= mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
1148 Database
= (UINT8
*) &mPcdDatabase
->PeiDb
;
1150 LocalTokenNumber
= mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
[LocalTokenNumberTableIdx
- PEI_LOCAL_TOKEN_NUMBER
];
1151 Database
= (UINT8
*) &mPcdDatabase
->DxeDb
;
1154 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) != 0);
1156 SkuHead
= (SKU_HEAD
*) ((UINT8
*)Database
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
1158 return (SKU_ID
*) (Database
+ SkuHead
->SkuIdTableOffset
);
1163 Wrapper function of getting index of PCD entry in size table.
1165 @param LocalTokenNumberTableIdx Index of this PCD in local token number table.
1166 @param IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
1167 If FALSE, the pcd entry is initialized in DXE phase.
1169 @return index of PCD entry in size table.
1173 IN UINTN LocalTokenNumberTableIdx
,
1177 UINT32
*LocalTokenNumberTable
;
1178 UINTN LocalTokenNumber
;
1184 LocalTokenNumberTable
= mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
;
1186 LocalTokenNumberTable
= mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
1191 for (Index
= 0; Index
< LocalTokenNumberTableIdx
; Index
++) {
1192 LocalTokenNumber
= LocalTokenNumberTable
[Index
];
1194 if ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
) {
1196 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1199 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
1201 // We have only one entry for VPD enabled PCD entry:
1203 // We consider current size is equal to MAX size.
1207 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
1209 // We have only two entry for Non-Sku enabled PCD entry:
1216 // We have these entry for SKU enabled PCD entry
1218 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1220 SkuIdTable
= GetSkuIdArray (Index
, IsPeiDb
);
1221 SizeTableIdx
+= (UINTN
)*SkuIdTable
+ 1;
1228 return SizeTableIdx
;
1232 Get size of POINTER type PCD value.
1234 @param LocalTokenNumberTableIdx Index of local token number in local token number table.
1235 @param MaxSize Maxmium size of POINTER type PCD value.
1237 @return size of POINTER type PCD value.
1242 IN UINTN LocalTokenNumberTableIdx
,
1247 UINTN LocalTokenNumber
;
1249 SIZE_INFO
*SizeTable
;
1252 UINT32
*LocalTokenNumberTable
;
1254 // EBC compiler is very choosy. It may report warning about comparison
1255 // between UINTN and 0 . So we add 1 in each size of the
1257 IsPeiDb
= (BOOLEAN
) (LocalTokenNumberTableIdx
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
1261 LocalTokenNumberTable
= mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
;
1262 SizeTable
= mPcdDatabase
->PeiDb
.Init
.SizeTable
;
1264 LocalTokenNumberTableIdx
-= PEI_LOCAL_TOKEN_NUMBER
;
1265 LocalTokenNumberTable
= mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
1266 SizeTable
= mPcdDatabase
->DxeDb
.Init
.SizeTable
;
1269 LocalTokenNumber
= LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
1271 ASSERT ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
);
1273 SizeTableIdx
= GetSizeTableIndex (LocalTokenNumberTableIdx
, IsPeiDb
);
1275 *MaxSize
= SizeTable
[SizeTableIdx
];
1277 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1280 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
1282 // We have only one entry for VPD enabled PCD entry:
1284 // We consider current size is equal to MAX size.
1288 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
1290 // We have only two entry for Non-Sku enabled PCD entry:
1294 return SizeTable
[SizeTableIdx
+ 1];
1297 // We have these entry for SKU enabled PCD entry
1299 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1301 SkuIdTable
= GetSkuIdArray (LocalTokenNumberTableIdx
, IsPeiDb
);
1302 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
1303 if (SkuIdTable
[1 + Index
] == mPcdDatabase
->PeiDb
.Init
.SystemSkuId
) {
1304 return SizeTable
[SizeTableIdx
+ 1 + Index
];
1307 return SizeTable
[SizeTableIdx
+ 1];
1313 Set size of POINTER type PCD value. The size should not exceed the maximum size
1316 @param LocalTokenNumberTableIdx Index of local token number in local token number table.
1317 @param CurrentSize Size of POINTER type PCD value.
1319 @retval TRUE Success to set size of PCD value.
1320 @retval FALSE Fail to set size of PCD value.
1324 IN UINTN LocalTokenNumberTableIdx
,
1325 IN OUT UINTN
*CurrentSize
1329 UINTN LocalTokenNumber
;
1331 SIZE_INFO
*SizeTable
;
1335 UINT32
*LocalTokenNumberTable
;
1338 // EBC compiler is very choosy. It may report warning about comparison
1339 // between UINTN and 0 . So we add 1 in each size of the
1342 IsPeiDb
= (BOOLEAN
) (LocalTokenNumberTableIdx
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
1345 LocalTokenNumberTable
= mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
;
1346 SizeTable
= mPcdDatabase
->PeiDb
.Init
.SizeTable
;
1348 LocalTokenNumberTableIdx
-= PEI_LOCAL_TOKEN_NUMBER
;
1349 LocalTokenNumberTable
= mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
1350 SizeTable
= mPcdDatabase
->DxeDb
.Init
.SizeTable
;
1353 LocalTokenNumber
= LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
1355 ASSERT ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
);
1357 SizeTableIdx
= GetSizeTableIndex (LocalTokenNumberTableIdx
, IsPeiDb
);
1359 MaxSize
= SizeTable
[SizeTableIdx
];
1361 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1364 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
1366 // We shouldn't come here as we don't support SET for VPD
1371 if ((*CurrentSize
> MaxSize
) ||
1372 (*CurrentSize
== MAX_ADDRESS
)) {
1373 *CurrentSize
= MaxSize
;
1377 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
1379 // We have only two entry for Non-Sku enabled PCD entry:
1383 SizeTable
[SizeTableIdx
+ 1] = (SIZE_INFO
) *CurrentSize
;
1387 // We have these entry for SKU enabled PCD entry
1389 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1391 SkuIdTable
= GetSkuIdArray (LocalTokenNumberTableIdx
, IsPeiDb
);
1392 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
1393 if (SkuIdTable
[1 + Index
] == mPcdDatabase
->PeiDb
.Init
.SystemSkuId
) {
1394 SizeTable
[SizeTableIdx
+ 1 + Index
] = (SIZE_INFO
) *CurrentSize
;
1398 SizeTable
[SizeTableIdx
+ 1] = (SIZE_INFO
) *CurrentSize
;