2 Help functions used by PCD DXE driver.
4 Copyright (c) 2006 - 2010, 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 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
) (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
= *(UINT16
*)((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
);
153 CopyMem (VaraiableDefaultBuffer
, Data
+ VariableHead
->Offset
, GetSize
);
156 RetPtr
= (VOID
*) VaraiableDefaultBuffer
;
158 VaraiableDefaultBuffer
= (UINT8
*) PcdDb
+ VariableHead
->DefaultValueOffset
;
160 Status
= GetHiiVariable (Guid
, Name
, &Data
, &DataSize
);
161 if (Status
== EFI_SUCCESS
) {
164 // It is a pointer type. So get the MaxSize reserved for
167 GetPtrTypeSize (TmpTokenNumber
, &GetSize
);
169 CopyMem (VaraiableDefaultBuffer
, Data
+ VariableHead
->Offset
, GetSize
);
173 // If the operation is successful, we copy the data
174 // to the default value buffer in the PCD Database.
175 // So that we can free the Data allocated in GetHiiVariable.
178 // If the operation is not successful,
179 // Return 1) either the default value specified by Platform Integrator
180 // 2) Or the value Set by a PCD set operation.
182 RetPtr
= (VOID
*) VaraiableDefaultBuffer
;
186 case PCD_TYPE_STRING
:
187 StringTableIdx
= *(UINT16
*)((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
;
544 Find the local token number according to system SKU ID.
546 @param LocalTokenNumber PCD token number
547 @param Size The size of PCD entry.
548 @param IsPeiDb If TRUE, the PCD entry is initialized in PEI phase.
549 If False, the PCD entry is initialized in DXE phase.
551 @return Token number according to system SKU ID.
555 GetSkuEnabledTokenNumber (
556 UINT32 LocalTokenNumber
,
565 SKU_ID
*PhaseSkuIdTable
;
568 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0);
570 PcdDb
= IsPeiDb
? (UINT8
*) &mPcdDatabase
->PeiDb
: (UINT8
*) &mPcdDatabase
->DxeDb
;
572 SkuHead
= (SKU_HEAD
*) (PcdDb
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
573 Value
= (UINT8
*) (PcdDb
+ SkuHead
->SkuDataStartOffset
);
575 PhaseSkuIdTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.SkuIdTable
:
576 mPcdDatabase
->DxeDb
.Init
.SkuIdTable
;
578 SkuIdTable
= &PhaseSkuIdTable
[SkuHead
->SkuIdTableOffset
];
581 // Find the current system's SKU ID entry in SKU ID table.
583 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
584 if (mPcdDatabase
->PeiDb
.Init
.SystemSkuId
== SkuIdTable
[Index
+ 1]) {
588 ASSERT (Index
< SkuIdTable
[0]);
590 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
592 Value
= (UINT8
*) &(((VPD_HEAD
*) Value
)[Index
]);
593 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_VPD
);
596 Value
= (UINT8
*) &(((VARIABLE_HEAD
*) Value
)[Index
]);
597 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_HII
);
599 case PCD_TYPE_STRING
:
600 Value
= (UINT8
*) &(((STRING_HEAD
*) Value
)[Index
]);
601 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_STRING
);
604 Value
+= Size
* Index
;
605 return (UINT32
) (Value
- PcdDb
);
618 Invoke the callback function when dynamic PCD entry was set, if this PCD entry
619 has registered callback function.
621 @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx
623 @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type
625 @param TokenNumber PCD token number generated by build tools.
626 @param Data Value want to be set for this PCD entry
627 @param Size The size of value
631 InvokeCallbackOnSet (
632 UINT32 ExTokenNumber
,
633 CONST EFI_GUID
*Guid
, OPTIONAL
639 CALLBACK_FN_ENTRY
*FnTableEntry
;
640 LIST_ENTRY
*ListHead
;
641 LIST_ENTRY
*ListNode
;
644 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
645 // We have to decrement TokenNumber by 1 to make it usable
646 // as the array index of mCallbackFnTable[].
648 ListHead
= &mCallbackFnTable
[TokenNumber
- 1];
649 ListNode
= GetFirstNode (ListHead
);
651 while (ListNode
!= ListHead
) {
652 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE (ListNode
, CALLBACK_FN_ENTRY
, Node
);
654 FnTableEntry
->CallbackFn(Guid
,
655 (Guid
== NULL
) ? TokenNumber
: ExTokenNumber
,
659 ListNode
= GetNextNode (ListHead
, ListNode
);
667 Wrapper function for setting non-pointer type value for a PCD entry.
669 @param TokenNumber Pcd token number autogenerated by build tools.
670 @param Data Value want to be set for PCD entry
671 @param Size Size of value.
673 @return status of SetWorker.
678 IN UINTN TokenNumber
,
683 return SetWorker (TokenNumber
, Data
, &Size
, FALSE
);
688 Set value for an PCD entry
690 @param TokenNumber Pcd token number autogenerated by build tools.
691 @param Data Value want to be set for PCD entry
692 @param Size Size of value.
693 @param PtrType If TRUE, the type of PCD entry's value is Pointer.
694 If False, the type of PCD entry's value is not Pointer.
696 @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.
697 @retval EFI_INVALID_PARAMETER If Size can not be set to size table.
698 @retval EFI_INVALID_PARAMETER If Size of non-Ptr type PCD does not match the size information in PCD database.
699 @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in
700 range of UINT8, UINT16, UINT32, UINT64
701 @retval EFI_NOT_FOUND Can not find the PCD type according to token number.
705 IN UINTN TokenNumber
,
711 UINT32
*LocalTokenNumberTable
;
713 UINT32 LocalTokenNumber
;
718 UINTN VariableOffset
;
720 VARIABLE_HEAD
*VariableHead
;
725 UINTN TmpTokenNumber
;
728 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
729 // We have to decrement TokenNumber by 1 to make it usable
730 // as the array index.
734 TmpTokenNumber
= TokenNumber
;
737 // EBC compiler is very choosy. It may report warning about comparison
738 // between UINTN and 0 . So we add 1 in each size of the
741 ASSERT (TokenNumber
+ 1 < PCD_TOTAL_TOKEN_NUMBER
+ 1);
744 if (*Size
> DxePcdGetSize (TokenNumber
+ 1)) {
745 return EFI_INVALID_PARAMETER
;
748 if (*Size
!= DxePcdGetSize (TokenNumber
+ 1)) {
749 return EFI_INVALID_PARAMETER
;
754 // EBC compiler is very choosy. It may report warning about comparison
755 // between UINTN and 0 . So we add 1 in each size of the
758 if ((TokenNumber
+ 1 < PEI_NEX_TOKEN_NUMBER
+ 1) ||
759 (TokenNumber
+ 1 >= PEI_LOCAL_TOKEN_NUMBER
+ 1 || TokenNumber
+ 1 < (PEI_LOCAL_TOKEN_NUMBER
+ DXE_NEX_TOKEN_NUMBER
+ 1))) {
760 InvokeCallbackOnSet (0, NULL
, TokenNumber
+ 1, Data
, *Size
);
764 // Aquire lock to prevent reentrance from TPL_CALLBACK level
766 EfiAcquireLock (&mPcdDatabaseLock
);
769 // EBC compiler is very choosy. It may report warning about comparison
770 // between UINTN and 0 . So we add 1 in each size of the
773 IsPeiDb
= (BOOLEAN
) ((TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1) ? TRUE
: FALSE
);
775 LocalTokenNumberTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
:
776 mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
778 TokenNumber
= IsPeiDb
? TokenNumber
779 : TokenNumber
- PEI_LOCAL_TOKEN_NUMBER
;
781 LocalTokenNumber
= LocalTokenNumberTable
[TokenNumber
];
783 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
785 GetPtrTypeSize (TmpTokenNumber
, &MaxSize
);
789 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, MaxSize
, IsPeiDb
);
792 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
794 PcdDb
= IsPeiDb
? ((UINT8
*) &mPcdDatabase
->PeiDb
) : ((UINT8
*) &mPcdDatabase
->DxeDb
);
797 StringTable
= (UINT8
*) (&mPcdDatabase
->PeiDb
.Init
.StringTable
[0]);
799 StringTable
= (UINT8
*) (&mPcdDatabase
->DxeDb
.Init
.StringTable
[0]);
803 InternalData
= PcdDb
+ Offset
;
805 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
808 Status
= EFI_INVALID_PARAMETER
;
811 case PCD_TYPE_STRING
:
812 if (SetPtrTypeSize (TmpTokenNumber
, Size
)) {
813 CopyMem (StringTable
+ *((UINT16
*)InternalData
), Data
, *Size
);
814 Status
= EFI_SUCCESS
;
816 Status
= EFI_INVALID_PARAMETER
;
820 case PCD_TYPE_HII
|PCD_TYPE_STRING
:
823 if (!SetPtrTypeSize (TmpTokenNumber
, Size
)) {
824 Status
= EFI_INVALID_PARAMETER
;
830 GuidTable
= (EFI_GUID
*) (&mPcdDatabase
->PeiDb
.Init
.GuidTable
[0]);
832 GuidTable
= (EFI_GUID
*) (&mPcdDatabase
->DxeDb
.Init
.GuidTable
[0]);
835 VariableHead
= (VARIABLE_HEAD
*) (PcdDb
+ Offset
);
837 Guid
= GuidTable
+ VariableHead
->GuidTableIndex
;
838 Name
= (UINT16
*) (StringTable
+ VariableHead
->StringIndex
);
839 VariableOffset
= VariableHead
->Offset
;
840 Status
= SetHiiVariable (Guid
, Name
, Data
, *Size
, VariableOffset
);
842 if (EFI_NOT_FOUND
== Status
) {
843 if ((LocalTokenNumber
& PCD_TYPE_ALL_SET
) == (PCD_TYPE_HII
|PCD_TYPE_STRING
)) {
845 StringTable
+ *(UINT16
*)(PcdDb
+ VariableHead
->DefaultValueOffset
),
850 CopyMem (PcdDb
+ VariableHead
->DefaultValueOffset
, Data
, *Size
);
852 Status
= EFI_SUCCESS
;
858 if (SetPtrTypeSize (TmpTokenNumber
, Size
)) {
859 CopyMem (InternalData
, Data
, *Size
);
860 Status
= EFI_SUCCESS
;
862 Status
= EFI_INVALID_PARAMETER
;
867 Status
= EFI_SUCCESS
;
870 *((UINT8
*) InternalData
) = *((UINT8
*) Data
);
874 *((UINT16
*) InternalData
) = *((UINT16
*) Data
);
878 *((UINT32
*) InternalData
) = *((UINT32
*) Data
);
882 *((UINT64
*) InternalData
) = *((UINT64
*) Data
);
887 Status
= EFI_NOT_FOUND
;
894 Status
= EFI_NOT_FOUND
;
898 EfiReleaseLock (&mPcdDatabaseLock
);
904 Wrapper function for get PCD value for dynamic-ex PCD.
906 @param Guid Token space guid for dynamic-ex PCD.
907 @param ExTokenNumber Token number for dynamic-ex PCD.
908 @param GetSize The size of dynamic-ex PCD value.
910 @return PCD entry in PCD database.
915 IN CONST EFI_GUID
*Guid
,
916 IN UINTN ExTokenNumber
,
920 return GetWorker(GetExPcdTokenNumber (Guid
, (UINT32
) ExTokenNumber
), GetSize
);
924 Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.
926 @param ExTokenNumber Token number for dynamic-ex PCD.
927 @param Guid Token space guid for dynamic-ex PCD.
928 @param Data Value want to be set.
929 @param SetSize The size of value.
931 @return status of ExSetWorker().
936 IN UINTN ExTokenNumber
,
937 IN CONST EFI_GUID
*Guid
,
942 return ExSetWorker (ExTokenNumber
, Guid
, Data
, &SetSize
, FALSE
);
946 Set value for a dynamic PCD entry.
948 This routine find the local token number according to dynamic-ex PCD's token
949 space guid and token number firstly, and invoke callback function if this PCD
950 entry registered callback function. Finally, invoken general SetWorker to set
953 @param ExTokenNumber Dynamic-ex PCD token number.
954 @param Guid Token space guid for dynamic-ex PCD.
955 @param Data PCD value want to be set
956 @param SetSize Size of value.
957 @param PtrType If TRUE, this PCD entry is pointer type.
958 If FALSE, this PCD entry is not pointer type.
960 @return status of SetWorker().
965 IN UINTN ExTokenNumber
,
966 IN CONST EFI_GUID
*Guid
,
968 IN OUT UINTN
*SetSize
,
974 TokenNumber
= GetExPcdTokenNumber (Guid
, (UINT32
) ExTokenNumber
);
976 InvokeCallbackOnSet ((UINT32
) ExTokenNumber
, Guid
, TokenNumber
, Data
, *SetSize
);
978 return SetWorker (TokenNumber
, Data
, SetSize
, PtrType
);
983 Set value for HII-type PCD.
985 A HII-type PCD's value is stored in a variable. Setting/Getting the value of
986 HII-type PCD is to visit this variable.
988 @param VariableGuid Guid of variable which stored value of a HII-type PCD.
989 @param VariableName Unicode name of variable which stored value of a HII-type PCD.
990 @param Data Value want to be set.
991 @param DataSize Size of value
992 @param Offset Value offset of HII-type PCD in variable.
994 @return status of GetVariable()/SetVariable().
999 IN EFI_GUID
*VariableGuid
,
1000 IN UINT16
*VariableName
,
1001 IN CONST VOID
*Data
,
1016 // Try to get original variable size information.
1018 Status
= gRT
->GetVariable (
1019 (UINT16
*)VariableName
,
1026 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1028 // Patch new PCD's value to offset in given HII variable.
1030 if (Size
>= (DataSize
+ Offset
)) {
1033 SetSize
= DataSize
+ Offset
;
1035 Buffer
= AllocatePool (SetSize
);
1036 ASSERT (Buffer
!= NULL
);
1038 Status
= gRT
->GetVariable (
1046 ASSERT_EFI_ERROR (Status
);
1048 CopyMem ((UINT8
*)Buffer
+ Offset
, Data
, DataSize
);
1050 Status
= gRT
->SetVariable (
1060 } else if (Status
== EFI_NOT_FOUND
) {
1062 // If variable does not exist, a new variable need to be created.
1065 Size
= Offset
+ DataSize
;
1067 Buffer
= AllocateZeroPool (Size
);
1068 ASSERT (Buffer
!= NULL
);
1070 CopyMem ((UINT8
*)Buffer
+ Offset
, Data
, DataSize
);
1072 Status
= gRT
->SetVariable (
1075 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1085 // If we drop to here, the value is failed to be written in to variable area
1086 // So, we will save the data in the PCD Database's volatile area.
1092 Get local token number according to dynamic-ex PCD's {token space guid:token number}
1094 A dynamic-ex type PCD, developer must provide pair of token space guid: token number
1095 in DEC file. PCD database maintain a mapping table that translate pair of {token
1096 space guid: token number} to local token number.
1098 @param Guid Token space guid for dynamic-ex PCD entry.
1099 @param ExTokenNumber Dynamic-ex PCD token number.
1101 @return local token number for dynamic-ex PCD.
1105 GetExPcdTokenNumber (
1106 IN CONST EFI_GUID
*Guid
,
1107 IN UINT32 ExTokenNumber
1111 DYNAMICEX_MAPPING
*ExMap
;
1112 EFI_GUID
*GuidTable
;
1113 EFI_GUID
*MatchGuid
;
1116 if (!PEI_DATABASE_EMPTY
) {
1117 ExMap
= mPcdDatabase
->PeiDb
.Init
.ExMapTable
;
1118 GuidTable
= mPcdDatabase
->PeiDb
.Init
.GuidTable
;
1120 MatchGuid
= ScanGuid (GuidTable
, sizeof(mPcdDatabase
->PeiDb
.Init
.GuidTable
), Guid
);
1122 if (MatchGuid
!= NULL
) {
1124 MatchGuidIdx
= MatchGuid
- GuidTable
;
1126 for (Index
= 0; Index
< PEI_EXMAPPING_TABLE_SIZE
; Index
++) {
1127 if ((ExTokenNumber
== ExMap
[Index
].ExTokenNumber
) &&
1128 (MatchGuidIdx
== ExMap
[Index
].ExGuidIndex
)) {
1129 return ExMap
[Index
].LocalTokenNumber
;
1135 ExMap
= mPcdDatabase
->DxeDb
.Init
.ExMapTable
;
1136 GuidTable
= mPcdDatabase
->DxeDb
.Init
.GuidTable
;
1138 MatchGuid
= ScanGuid (GuidTable
, sizeof(mPcdDatabase
->DxeDb
.Init
.GuidTable
), Guid
);
1140 // We need to ASSERT here. If GUID can't be found in GuidTable, this is a
1141 // error in the BUILD system.
1143 ASSERT (MatchGuid
!= NULL
);
1145 MatchGuidIdx
= MatchGuid
- GuidTable
;
1147 for (Index
= 0; Index
< DXE_EXMAPPING_TABLE_SIZE
; Index
++) {
1148 if ((ExTokenNumber
== ExMap
[Index
].ExTokenNumber
) &&
1149 (MatchGuidIdx
== ExMap
[Index
].ExGuidIndex
)) {
1150 return ExMap
[Index
].LocalTokenNumber
;
1160 Get SKU ID table from PCD database.
1162 @param LocalTokenNumberTableIdx Index of local token number in token number table.
1163 @param IsPeiPcd If TRUE,
1165 @return Pointer to SKU ID array table
1170 IN UINTN LocalTokenNumberTableIdx
,
1175 UINTN LocalTokenNumber
;
1179 LocalTokenNumber
= mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
1180 Database
= (UINT8
*) &mPcdDatabase
->PeiDb
;
1182 LocalTokenNumber
= mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
[LocalTokenNumberTableIdx
- PEI_LOCAL_TOKEN_NUMBER
];
1183 Database
= (UINT8
*) &mPcdDatabase
->DxeDb
;
1186 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) != 0);
1188 SkuHead
= (SKU_HEAD
*) ((UINT8
*)Database
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
1190 return (SKU_ID
*) (Database
+ SkuHead
->SkuIdTableOffset
);
1195 Wrapper function of getting index of PCD entry in size table.
1197 @param LocalTokenNumberTableIdx Index of this PCD in local token number table.
1198 @param IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
1199 If FALSE, the pcd entry is initialized in DXE phase.
1201 @return index of PCD entry in size table.
1205 IN UINTN LocalTokenNumberTableIdx
,
1209 UINT32
*LocalTokenNumberTable
;
1210 UINTN LocalTokenNumber
;
1216 LocalTokenNumberTable
= mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
;
1218 LocalTokenNumberTable
= mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
1223 for (Index
= 0; Index
< LocalTokenNumberTableIdx
; Index
++) {
1224 LocalTokenNumber
= LocalTokenNumberTable
[Index
];
1226 if ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
) {
1228 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1231 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
1233 // We have only one entry for VPD enabled PCD entry:
1235 // We consider current size is equal to MAX size.
1239 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
1241 // We have only two entry for Non-Sku enabled PCD entry:
1248 // We have these entry for SKU enabled PCD entry
1250 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1252 SkuIdTable
= GetSkuIdArray (Index
, IsPeiDb
);
1253 SizeTableIdx
+= (UINTN
)*SkuIdTable
+ 1;
1260 return SizeTableIdx
;
1264 Get size of POINTER type PCD value.
1266 @param LocalTokenNumberTableIdx Index of local token number in local token number table.
1267 @param MaxSize Maxmium size of POINTER type PCD value.
1269 @return size of POINTER type PCD value.
1274 IN UINTN LocalTokenNumberTableIdx
,
1279 UINTN LocalTokenNumber
;
1281 SIZE_INFO
*SizeTable
;
1284 UINT32
*LocalTokenNumberTable
;
1286 // EBC compiler is very choosy. It may report warning about comparison
1287 // between UINTN and 0 . So we add 1 in each size of the
1289 IsPeiDb
= (BOOLEAN
) (LocalTokenNumberTableIdx
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
1293 LocalTokenNumberTable
= mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
;
1294 SizeTable
= mPcdDatabase
->PeiDb
.Init
.SizeTable
;
1296 LocalTokenNumberTableIdx
-= PEI_LOCAL_TOKEN_NUMBER
;
1297 LocalTokenNumberTable
= mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
1298 SizeTable
= mPcdDatabase
->DxeDb
.Init
.SizeTable
;
1301 LocalTokenNumber
= LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
1303 ASSERT ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
);
1305 SizeTableIdx
= GetSizeTableIndex (LocalTokenNumberTableIdx
, IsPeiDb
);
1307 *MaxSize
= SizeTable
[SizeTableIdx
];
1309 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1312 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
1314 // We have only one entry for VPD enabled PCD entry:
1316 // We consider current size is equal to MAX size.
1320 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
1322 // We have only two entry for Non-Sku enabled PCD entry:
1326 return SizeTable
[SizeTableIdx
+ 1];
1329 // We have these entry for SKU enabled PCD entry
1331 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1333 SkuIdTable
= GetSkuIdArray (LocalTokenNumberTableIdx
, IsPeiDb
);
1334 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
1335 if (SkuIdTable
[1 + Index
] == mPcdDatabase
->PeiDb
.Init
.SystemSkuId
) {
1336 return SizeTable
[SizeTableIdx
+ 1 + Index
];
1339 return SizeTable
[SizeTableIdx
+ 1];
1345 Set size of POINTER type PCD value. The size should not exceed the maximum size
1348 @param LocalTokenNumberTableIdx Index of local token number in local token number table.
1349 @param CurrentSize Size of POINTER type PCD value.
1351 @retval TRUE Success to set size of PCD value.
1352 @retval FALSE Fail to set size of PCD value.
1356 IN UINTN LocalTokenNumberTableIdx
,
1357 IN OUT UINTN
*CurrentSize
1361 UINTN LocalTokenNumber
;
1363 SIZE_INFO
*SizeTable
;
1367 UINT32
*LocalTokenNumberTable
;
1370 // EBC compiler is very choosy. It may report warning about comparison
1371 // between UINTN and 0 . So we add 1 in each size of the
1374 IsPeiDb
= (BOOLEAN
) (LocalTokenNumberTableIdx
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
1377 LocalTokenNumberTable
= mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
;
1378 SizeTable
= mPcdDatabase
->PeiDb
.Init
.SizeTable
;
1380 LocalTokenNumberTableIdx
-= PEI_LOCAL_TOKEN_NUMBER
;
1381 LocalTokenNumberTable
= mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
1382 SizeTable
= mPcdDatabase
->DxeDb
.Init
.SizeTable
;
1385 LocalTokenNumber
= LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
1387 ASSERT ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
);
1389 SizeTableIdx
= GetSizeTableIndex (LocalTokenNumberTableIdx
, IsPeiDb
);
1391 MaxSize
= SizeTable
[SizeTableIdx
];
1393 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1396 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
1398 // We shouldn't come here as we don't support SET for VPD
1403 if ((*CurrentSize
> MaxSize
) ||
1404 (*CurrentSize
== MAX_ADDRESS
)) {
1405 *CurrentSize
= MaxSize
;
1409 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
1411 // We have only two entry for Non-Sku enabled PCD entry:
1415 SizeTable
[SizeTableIdx
+ 1] = (SIZE_INFO
) *CurrentSize
;
1419 // We have these entry for SKU enabled PCD entry
1421 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1423 SkuIdTable
= GetSkuIdArray (LocalTokenNumberTableIdx
, IsPeiDb
);
1424 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
1425 if (SkuIdTable
[1 + Index
] == mPcdDatabase
->PeiDb
.Init
.SystemSkuId
) {
1426 SizeTable
[SizeTableIdx
+ 1 + Index
] = (SIZE_INFO
) *CurrentSize
;
1430 SizeTable
[SizeTableIdx
+ 1] = (SIZE_INFO
) *CurrentSize
;