2 Help functions used by PCD DXE driver.
4 Copyright (c) 2006 - 2010, 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
) (PcdGet32 (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 of mCallbackFnTable[].
218 ListHead
= &mCallbackFnTable
[TokenNumber
- 1];
219 ListNode
= GetFirstNode (ListHead
);
221 while (ListNode
!= ListHead
) {
222 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE(ListNode
, CALLBACK_FN_ENTRY
, Node
);
224 if (FnTableEntry
->CallbackFn
== CallBackFunction
) {
226 // We only allow a Callback function to be register once
227 // for a TokenNumber. So just return EFI_SUCCESS
231 ListNode
= GetNextNode (ListHead
, ListNode
);
234 FnTableEntry
= AllocatePool (sizeof(CALLBACK_FN_ENTRY
));
235 ASSERT (FnTableEntry
!= NULL
);
237 FnTableEntry
->CallbackFn
= CallBackFunction
;
238 InsertTailList (ListHead
, &FnTableEntry
->Node
);
244 UnRegister the callback function for a PCD entry.
246 This routine will unregister a callback function to a PCD entry by given token number
247 and token space guid.
249 @param TokenNumber PCD token's number, it is autogened by build tools.
250 @param Guid PCD token space's guid.
251 if not NULL, this PCD is dynamicEx type PCD.
252 @param CallBackFunction Callback function pointer
254 @retval EFI_SUCCESS Callback function is success to be unregister.
255 @retval EFI_INVALID_PARAMETER Can not find the PCD entry by given token number.
258 DxeUnRegisterCallBackWorker (
259 IN UINTN TokenNumber
,
260 IN CONST EFI_GUID
*Guid
, OPTIONAL
261 IN PCD_PROTOCOL_CALLBACK CallBackFunction
264 CALLBACK_FN_ENTRY
*FnTableEntry
;
265 LIST_ENTRY
*ListHead
;
266 LIST_ENTRY
*ListNode
;
269 TokenNumber
= GetExPcdTokenNumber (Guid
, (UINT32
) TokenNumber
);
273 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
274 // We have to decrement TokenNumber by 1 to make it usable
275 // as the array index of mCallbackFnTable[].
277 ListHead
= &mCallbackFnTable
[TokenNumber
- 1];
278 ListNode
= GetFirstNode (ListHead
);
280 while (ListNode
!= ListHead
) {
281 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE(ListNode
, CALLBACK_FN_ENTRY
, Node
);
283 if (FnTableEntry
->CallbackFn
== CallBackFunction
) {
285 // We only allow a Callback function to be register once
286 // for a TokenNumber. So we can safely remove the Node from
287 // the Link List and return EFI_SUCCESS.
289 RemoveEntryList (ListNode
);
290 FreePool (FnTableEntry
);
294 ListNode
= GetNextNode (ListHead
, ListNode
);
297 return EFI_INVALID_PARAMETER
;
301 Get next token number in given token space.
303 This routine is used for dynamicEx type PCD. It will firstly scan token space
304 table to get token space according to given token space guid. Then scan given
305 token number in found token space, if found, then return next token number in
308 @param Guid Token space guid. Next token number will be scaned in
310 @param TokenNumber Token number.
311 If PCD_INVALID_TOKEN_NUMBER, return first token number in
313 If not PCD_INVALID_TOKEN_NUMBER, return next token number
314 in token space table.
315 @param GuidTable Token space guid table. It will be used for scan token space
316 by given token space guid.
317 @param SizeOfGuidTable The size of guid table.
318 @param ExMapTable DynamicEx token number mapping table.
319 @param SizeOfExMapTable The size of dynamicEx token number mapping table.
321 @retval EFI_NOT_FOUND Can not given token space or token number.
322 @retval EFI_SUCCESS Success to get next token number.
326 ExGetNextTokeNumber (
327 IN CONST EFI_GUID
*Guid
,
328 IN OUT UINTN
*TokenNumber
,
329 IN EFI_GUID
*GuidTable
,
330 IN UINTN SizeOfGuidTable
,
331 IN DYNAMICEX_MAPPING
*ExMapTable
,
332 IN UINTN SizeOfExMapTable
341 // Scan token space guid
343 MatchGuid
= ScanGuid (GuidTable
, SizeOfGuidTable
, Guid
);
344 if (MatchGuid
== NULL
) {
345 return EFI_NOT_FOUND
;
349 // Find the token space table in dynamicEx mapping table.
352 GuidTableIdx
= MatchGuid
- GuidTable
;
353 for (Index
= 0; Index
< SizeOfExMapTable
; Index
++) {
354 if (ExMapTable
[Index
].ExGuidIndex
== GuidTableIdx
) {
362 // If given token number is PCD_INVALID_TOKEN_NUMBER, then return the first
363 // token number in found token space.
365 if (*TokenNumber
== PCD_INVALID_TOKEN_NUMBER
) {
366 *TokenNumber
= ExMapTable
[Index
].ExTokenNumber
;
370 for ( ; Index
< SizeOfExMapTable
; Index
++) {
371 if (ExMapTable
[Index
].ExTokenNumber
== *TokenNumber
) {
373 if (Index
== SizeOfExMapTable
) {
375 // Exceed the length of ExMap Table
377 *TokenNumber
= PCD_INVALID_TOKEN_NUMBER
;
379 } else if (ExMapTable
[Index
].ExGuidIndex
== GuidTableIdx
) {
381 // Found the next match
383 *TokenNumber
= ExMapTable
[Index
].ExTokenNumber
;
387 // Guid has been changed. It is the next Token Space Guid.
388 // We should flag no more TokenNumber.
390 *TokenNumber
= PCD_INVALID_TOKEN_NUMBER
;
397 return EFI_NOT_FOUND
;
402 Initialize the PCD database in DXE phase.
404 PCD database in DXE phase also contains PCD database in PEI phase which is copied
409 BuildPcdDxeDataBase (
413 PEI_PCD_DATABASE
*PeiDatabase
;
414 EFI_HOB_GUID_TYPE
*GuidHob
;
417 mPcdDatabase
= AllocateZeroPool (sizeof(PCD_DATABASE
));
418 ASSERT (mPcdDatabase
!= NULL
);
420 GuidHob
= GetFirstGuidHob (&gPcdDataBaseHobGuid
);
421 if (GuidHob
!= NULL
) {
424 // We will copy over the PEI phase's PCD Database.
426 // If no PEIMs use dynamic Pcd Entry, the Pcd Service PEIM
427 // should not be included at all. So the GuidHob could
428 // be NULL. If it is NULL, we just copy over the DXE Default
429 // Value to PCD Database.
432 PeiDatabase
= (PEI_PCD_DATABASE
*) GET_GUID_HOB_DATA (GuidHob
);
434 // Copy PCD Entries refereneced in PEI phase to PCD DATABASE
436 CopyMem (&mPcdDatabase
->PeiDb
, PeiDatabase
, sizeof (PEI_PCD_DATABASE
));
440 // Copy PCD Entries with default value to PCD DATABASE
442 CopyMem (&mPcdDatabase
->DxeDb
.Init
, &gDXEPcdDbInit
, sizeof(DXE_PCD_DATABASE_INIT
));
446 // Initialized the Callback Function Table
449 mCallbackFnTable
= AllocateZeroPool (PCD_TOTAL_TOKEN_NUMBER
* sizeof (LIST_ENTRY
));
450 ASSERT(mCallbackFnTable
!= NULL
);
452 // EBC compiler is very choosy. It may report warning about comparison
453 // between UINTN and 0 . So we add 1 in each size of the
455 for (Index
= 0; Index
+ 1 < PCD_TOTAL_TOKEN_NUMBER
+ 1; Index
++) {
456 InitializeListHead (&mCallbackFnTable
[Index
]);
461 Get Variable which contains HII type PCD entry.
463 @param VariableGuid Variable's guid
464 @param VariableName Variable's unicode name string
465 @param VariableData Variable's data pointer,
466 @param VariableSize Variable's size.
468 @return the status of gRT->GetVariable
472 IN EFI_GUID
*VariableGuid
,
473 IN UINT16
*VariableName
,
474 OUT UINT8
**VariableData
,
475 OUT UINTN
*VariableSize
486 // Firstly get the real size of HII variable
488 Status
= gRT
->GetVariable (
489 (UINT16
*)VariableName
,
497 // Allocate buffer to hold whole variable data according to variable size.
499 if (Status
== EFI_BUFFER_TOO_SMALL
) {
500 Buffer
= (UINT8
*) AllocatePool (Size
);
502 ASSERT (Buffer
!= NULL
);
504 Status
= gRT
->GetVariable (
512 ASSERT (Status
== EFI_SUCCESS
);
513 *VariableData
= Buffer
;
514 *VariableSize
= Size
;
521 Find the local token number according to system SKU ID.
523 @param LocalTokenNumber PCD token number
524 @param Size The size of PCD entry.
525 @param IsPeiDb If TRUE, the PCD entry is initialized in PEI phase.
526 If False, the PCD entry is initialized in DXE phase.
528 @return Token number according to system SKU ID.
532 GetSkuEnabledTokenNumber (
533 UINT32 LocalTokenNumber
,
542 SKU_ID
*PhaseSkuIdTable
;
545 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0);
547 PcdDb
= IsPeiDb
? (UINT8
*) &mPcdDatabase
->PeiDb
: (UINT8
*) &mPcdDatabase
->DxeDb
;
549 SkuHead
= (SKU_HEAD
*) (PcdDb
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
550 Value
= (UINT8
*) (PcdDb
+ SkuHead
->SkuDataStartOffset
);
552 PhaseSkuIdTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.SkuIdTable
:
553 mPcdDatabase
->DxeDb
.Init
.SkuIdTable
;
555 SkuIdTable
= &PhaseSkuIdTable
[SkuHead
->SkuIdTableOffset
];
558 // Find the current system's SKU ID entry in SKU ID table.
560 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
561 if (mPcdDatabase
->PeiDb
.Init
.SystemSkuId
== SkuIdTable
[Index
+ 1]) {
565 ASSERT (Index
< SkuIdTable
[0]);
567 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
569 Value
= (UINT8
*) &(((VPD_HEAD
*) Value
)[Index
]);
570 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_VPD
);
573 Value
= (UINT8
*) &(((VARIABLE_HEAD
*) Value
)[Index
]);
574 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_HII
);
576 case PCD_TYPE_STRING
:
577 Value
= (UINT8
*) &(((STRING_HEAD
*) Value
)[Index
]);
578 return (UINT32
) ((Value
- PcdDb
) | PCD_TYPE_STRING
);
581 Value
+= Size
* Index
;
582 return (UINT32
) (Value
- PcdDb
);
595 Invoke the callback function when dynamic PCD entry was set, if this PCD entry
596 has registered callback function.
598 @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx
600 @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type
602 @param TokenNumber PCD token number generated by build tools.
603 @param Data Value want to be set for this PCD entry
604 @param Size The size of value
608 InvokeCallbackOnSet (
609 UINT32 ExTokenNumber
,
610 CONST EFI_GUID
*Guid
, OPTIONAL
616 CALLBACK_FN_ENTRY
*FnTableEntry
;
617 LIST_ENTRY
*ListHead
;
618 LIST_ENTRY
*ListNode
;
621 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
622 // We have to decrement TokenNumber by 1 to make it usable
623 // as the array index of mCallbackFnTable[].
625 ListHead
= &mCallbackFnTable
[TokenNumber
- 1];
626 ListNode
= GetFirstNode (ListHead
);
628 while (ListNode
!= ListHead
) {
629 FnTableEntry
= CR_FNENTRY_FROM_LISTNODE (ListNode
, CALLBACK_FN_ENTRY
, Node
);
631 FnTableEntry
->CallbackFn(Guid
,
632 (Guid
== NULL
) ? TokenNumber
: ExTokenNumber
,
636 ListNode
= GetNextNode (ListHead
, ListNode
);
644 Wrapper function for setting non-pointer type value for a PCD entry.
646 @param TokenNumber Pcd token number autogenerated by build tools.
647 @param Data Value want to be set for PCD entry
648 @param Size Size of value.
650 @return status of SetWorker.
655 IN UINTN TokenNumber
,
660 return SetWorker (TokenNumber
, Data
, &Size
, FALSE
);
665 Set value for an PCD entry
667 @param TokenNumber Pcd token number autogenerated by build tools.
668 @param Data Value want to be set for PCD entry
669 @param Size Size of value.
670 @param PtrType If TRUE, the type of PCD entry's value is Pointer.
671 If False, the type of PCD entry's value is not Pointer.
673 @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.
674 @retval EFI_INVALID_PARAMETER If Size can not be set to size table.
675 @retval EFI_INVALID_PARAMETER If Size of non-Ptr type PCD does not match the size information in PCD database.
676 @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in
677 range of UINT8, UINT16, UINT32, UINT64
678 @retval EFI_NOT_FOUND Can not find the PCD type according to token number.
682 IN UINTN TokenNumber
,
688 UINT32
*LocalTokenNumberTable
;
690 UINT32 LocalTokenNumber
;
695 UINTN VariableOffset
;
697 VARIABLE_HEAD
*VariableHead
;
702 UINTN TmpTokenNumber
;
705 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
706 // We have to decrement TokenNumber by 1 to make it usable
707 // as the array index.
711 TmpTokenNumber
= TokenNumber
;
714 // EBC compiler is very choosy. It may report warning about comparison
715 // between UINTN and 0 . So we add 1 in each size of the
718 ASSERT (TokenNumber
+ 1 < PCD_TOTAL_TOKEN_NUMBER
+ 1);
720 if ((!PtrType
) && (*Size
!= DxePcdGetSize (TokenNumber
+ 1))) {
721 return EFI_INVALID_PARAMETER
;
725 // EBC compiler is very choosy. It may report warning about comparison
726 // between UINTN and 0 . So we add 1 in each size of the
729 if ((TokenNumber
+ 1 < PEI_NEX_TOKEN_NUMBER
+ 1) ||
730 (TokenNumber
+ 1 >= PEI_LOCAL_TOKEN_NUMBER
+ 1 || TokenNumber
+ 1 < (PEI_LOCAL_TOKEN_NUMBER
+ DXE_NEX_TOKEN_NUMBER
+ 1))) {
731 InvokeCallbackOnSet (0, NULL
, TokenNumber
+ 1, Data
, *Size
);
735 // Aquire lock to prevent reentrance from TPL_CALLBACK level
737 EfiAcquireLock (&mPcdDatabaseLock
);
740 // EBC compiler is very choosy. It may report warning about comparison
741 // between UINTN and 0 . So we add 1 in each size of the
744 IsPeiDb
= (BOOLEAN
) ((TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1) ? TRUE
: FALSE
);
746 LocalTokenNumberTable
= IsPeiDb
? mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
:
747 mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
749 TokenNumber
= IsPeiDb
? TokenNumber
750 : TokenNumber
- PEI_LOCAL_TOKEN_NUMBER
;
752 LocalTokenNumber
= LocalTokenNumberTable
[TokenNumber
];
754 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
756 GetPtrTypeSize (TmpTokenNumber
, &MaxSize
);
760 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, MaxSize
, IsPeiDb
);
763 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
765 PcdDb
= IsPeiDb
? ((UINT8
*) &mPcdDatabase
->PeiDb
) : ((UINT8
*) &mPcdDatabase
->DxeDb
);
768 StringTable
= (UINT8
*) (&mPcdDatabase
->PeiDb
.Init
.StringTable
[0]);
770 StringTable
= (UINT8
*) (&mPcdDatabase
->DxeDb
.Init
.StringTable
[0]);
774 InternalData
= PcdDb
+ Offset
;
776 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
779 Status
= EFI_INVALID_PARAMETER
;
782 case PCD_TYPE_STRING
:
783 if (SetPtrTypeSize (TmpTokenNumber
, Size
)) {
784 CopyMem (StringTable
+ *((UINT16
*)InternalData
), Data
, *Size
);
785 Status
= EFI_SUCCESS
;
787 Status
= EFI_INVALID_PARAMETER
;
793 if (!SetPtrTypeSize (TmpTokenNumber
, Size
)) {
794 Status
= EFI_INVALID_PARAMETER
;
800 GuidTable
= (EFI_GUID
*) (&mPcdDatabase
->PeiDb
.Init
.GuidTable
[0]);
802 GuidTable
= (EFI_GUID
*) (&mPcdDatabase
->DxeDb
.Init
.GuidTable
[0]);
805 VariableHead
= (VARIABLE_HEAD
*) (PcdDb
+ Offset
);
807 Guid
= GuidTable
+ VariableHead
->GuidTableIndex
;
808 Name
= (UINT16
*) (StringTable
+ VariableHead
->StringIndex
);
809 VariableOffset
= VariableHead
->Offset
;
811 Status
= SetHiiVariable (Guid
, Name
, Data
, *Size
, VariableOffset
);
813 if (EFI_NOT_FOUND
== Status
) {
814 CopyMem (PcdDb
+ VariableHead
->DefaultValueOffset
, Data
, *Size
);
815 Status
= EFI_SUCCESS
;
821 if (SetPtrTypeSize (TmpTokenNumber
, Size
)) {
822 CopyMem (InternalData
, Data
, *Size
);
823 Status
= EFI_SUCCESS
;
825 Status
= EFI_INVALID_PARAMETER
;
830 Status
= EFI_SUCCESS
;
833 *((UINT8
*) InternalData
) = *((UINT8
*) Data
);
837 *((UINT16
*) InternalData
) = *((UINT16
*) Data
);
841 *((UINT32
*) InternalData
) = *((UINT32
*) Data
);
845 *((UINT64
*) InternalData
) = *((UINT64
*) Data
);
850 Status
= EFI_NOT_FOUND
;
857 Status
= EFI_NOT_FOUND
;
861 EfiReleaseLock (&mPcdDatabaseLock
);
867 Wrapper function for get PCD value for dynamic-ex PCD.
869 @param Guid Token space guid for dynamic-ex PCD.
870 @param ExTokenNumber Token number for dynamic-ex PCD.
871 @param GetSize The size of dynamic-ex PCD value.
873 @return PCD entry in PCD database.
878 IN CONST EFI_GUID
*Guid
,
879 IN UINTN ExTokenNumber
,
883 return GetWorker(GetExPcdTokenNumber (Guid
, (UINT32
) ExTokenNumber
), GetSize
);
887 Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.
889 @param ExTokenNumber Token number for dynamic-ex PCD.
890 @param Guid Token space guid for dynamic-ex PCD.
891 @param Data Value want to be set.
892 @param SetSize The size of value.
894 @return status of ExSetWorker().
899 IN UINTN ExTokenNumber
,
900 IN CONST EFI_GUID
*Guid
,
905 return ExSetWorker (ExTokenNumber
, Guid
, Data
, &SetSize
, FALSE
);
909 Set value for a dynamic PCD entry.
911 This routine find the local token number according to dynamic-ex PCD's token
912 space guid and token number firstly, and invoke callback function if this PCD
913 entry registered callback function. Finally, invoken general SetWorker to set
916 @param ExTokenNumber Dynamic-ex PCD token number.
917 @param Guid Token space guid for dynamic-ex PCD.
918 @param Data PCD value want to be set
919 @param SetSize Size of value.
920 @param PtrType If TRUE, this PCD entry is pointer type.
921 If FALSE, this PCD entry is not pointer type.
923 @return status of SetWorker().
928 IN UINTN ExTokenNumber
,
929 IN CONST EFI_GUID
*Guid
,
931 IN OUT UINTN
*SetSize
,
937 TokenNumber
= GetExPcdTokenNumber (Guid
, (UINT32
) ExTokenNumber
);
939 InvokeCallbackOnSet ((UINT32
) ExTokenNumber
, Guid
, TokenNumber
, Data
, *SetSize
);
941 return SetWorker (TokenNumber
, Data
, SetSize
, PtrType
);
946 Set value for HII-type PCD.
948 A HII-type PCD's value is stored in a variable. Setting/Getting the value of
949 HII-type PCD is to visit this variable.
951 @param VariableGuid Guid of variable which stored value of a HII-type PCD.
952 @param VariableName Unicode name of variable which stored value of a HII-type PCD.
953 @param Data Value want to be set.
954 @param DataSize Size of value
955 @param Offset Value offset of HII-type PCD in variable.
957 @return status of GetVariable()/SetVariable().
962 IN EFI_GUID
*VariableGuid
,
963 IN UINT16
*VariableName
,
979 // Try to get original variable size information.
981 Status
= gRT
->GetVariable (
982 (UINT16
*)VariableName
,
989 if (Status
== EFI_BUFFER_TOO_SMALL
) {
991 // Patch new PCD's value to offset in given HII variable.
993 if (Size
>= (DataSize
+ Offset
)) {
996 SetSize
= DataSize
+ Offset
;
998 Buffer
= AllocatePool (SetSize
);
999 ASSERT (Buffer
!= NULL
);
1001 Status
= gRT
->GetVariable (
1009 ASSERT_EFI_ERROR (Status
);
1011 CopyMem ((UINT8
*)Buffer
+ Offset
, Data
, DataSize
);
1013 Status
= gRT
->SetVariable (
1023 } else if (Status
== EFI_NOT_FOUND
) {
1025 // If variable does not exist, a new variable need to be created.
1028 Size
= Offset
+ DataSize
;
1030 Buffer
= AllocateZeroPool (Size
);
1031 ASSERT (Buffer
!= NULL
);
1033 CopyMem ((UINT8
*)Buffer
+ Offset
, Data
, DataSize
);
1035 Status
= gRT
->SetVariable (
1038 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1048 // If we drop to here, the value is failed to be written in to variable area
1049 // So, we will save the data in the PCD Database's volatile area.
1055 Get local token number according to dynamic-ex PCD's {token space guid:token number}
1057 A dynamic-ex type PCD, developer must provide pair of token space guid: token number
1058 in DEC file. PCD database maintain a mapping table that translate pair of {token
1059 space guid: token number} to local token number.
1061 @param Guid Token space guid for dynamic-ex PCD entry.
1062 @param ExTokenNumber Dynamic-ex PCD token number.
1064 @return local token number for dynamic-ex PCD.
1068 GetExPcdTokenNumber (
1069 IN CONST EFI_GUID
*Guid
,
1070 IN UINT32 ExTokenNumber
1074 DYNAMICEX_MAPPING
*ExMap
;
1075 EFI_GUID
*GuidTable
;
1076 EFI_GUID
*MatchGuid
;
1079 if (!PEI_DATABASE_EMPTY
) {
1080 ExMap
= mPcdDatabase
->PeiDb
.Init
.ExMapTable
;
1081 GuidTable
= mPcdDatabase
->PeiDb
.Init
.GuidTable
;
1083 MatchGuid
= ScanGuid (GuidTable
, sizeof(mPcdDatabase
->PeiDb
.Init
.GuidTable
), Guid
);
1085 if (MatchGuid
!= NULL
) {
1087 MatchGuidIdx
= MatchGuid
- GuidTable
;
1089 for (Index
= 0; Index
< PEI_EXMAPPING_TABLE_SIZE
; Index
++) {
1090 if ((ExTokenNumber
== ExMap
[Index
].ExTokenNumber
) &&
1091 (MatchGuidIdx
== ExMap
[Index
].ExGuidIndex
)) {
1092 return ExMap
[Index
].LocalTokenNumber
;
1098 ExMap
= mPcdDatabase
->DxeDb
.Init
.ExMapTable
;
1099 GuidTable
= mPcdDatabase
->DxeDb
.Init
.GuidTable
;
1101 MatchGuid
= ScanGuid (GuidTable
, sizeof(mPcdDatabase
->DxeDb
.Init
.GuidTable
), Guid
);
1103 // We need to ASSERT here. If GUID can't be found in GuidTable, this is a
1104 // error in the BUILD system.
1106 ASSERT (MatchGuid
!= NULL
);
1108 MatchGuidIdx
= MatchGuid
- GuidTable
;
1110 for (Index
= 0; Index
< DXE_EXMAPPING_TABLE_SIZE
; Index
++) {
1111 if ((ExTokenNumber
== ExMap
[Index
].ExTokenNumber
) &&
1112 (MatchGuidIdx
== ExMap
[Index
].ExGuidIndex
)) {
1113 return ExMap
[Index
].LocalTokenNumber
;
1123 Get SKU ID table from PCD database.
1125 @param LocalTokenNumberTableIdx Index of local token number in token number table.
1126 @param IsPeiPcd If TRUE,
1128 @return Pointer to SKU ID array table
1133 IN UINTN LocalTokenNumberTableIdx
,
1138 UINTN LocalTokenNumber
;
1142 LocalTokenNumber
= mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
1143 Database
= (UINT8
*) &mPcdDatabase
->PeiDb
;
1145 LocalTokenNumber
= mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
[LocalTokenNumberTableIdx
- PEI_LOCAL_TOKEN_NUMBER
];
1146 Database
= (UINT8
*) &mPcdDatabase
->DxeDb
;
1149 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) != 0);
1151 SkuHead
= (SKU_HEAD
*) ((UINT8
*)Database
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
1153 return (SKU_ID
*) (Database
+ SkuHead
->SkuIdTableOffset
);
1158 Wrapper function of getting index of PCD entry in size table.
1160 @param LocalTokenNumberTableIdx Index of this PCD in local token number table.
1161 @param IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
1162 If FALSE, the pcd entry is initialized in DXE phase.
1164 @return index of PCD entry in size table.
1168 IN UINTN LocalTokenNumberTableIdx
,
1172 UINT32
*LocalTokenNumberTable
;
1173 UINTN LocalTokenNumber
;
1179 LocalTokenNumberTable
= mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
;
1181 LocalTokenNumberTable
= mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
1186 for (Index
= 0; Index
< LocalTokenNumberTableIdx
; Index
++) {
1187 LocalTokenNumber
= LocalTokenNumberTable
[Index
];
1189 if ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
) {
1191 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1194 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
1196 // We have only one entry for VPD enabled PCD entry:
1198 // We consider current size is equal to MAX size.
1202 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
1204 // We have only two entry for Non-Sku enabled PCD entry:
1211 // We have these entry for SKU enabled PCD entry
1213 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1215 SkuIdTable
= GetSkuIdArray (Index
, IsPeiDb
);
1216 SizeTableIdx
+= (UINTN
)*SkuIdTable
+ 1;
1223 return SizeTableIdx
;
1227 Get size of POINTER type PCD value.
1229 @param LocalTokenNumberTableIdx Index of local token number in local token number table.
1230 @param MaxSize Maxmium size of POINTER type PCD value.
1232 @return size of POINTER type PCD value.
1237 IN UINTN LocalTokenNumberTableIdx
,
1242 UINTN LocalTokenNumber
;
1244 SIZE_INFO
*SizeTable
;
1247 UINT32
*LocalTokenNumberTable
;
1249 // EBC compiler is very choosy. It may report warning about comparison
1250 // between UINTN and 0 . So we add 1 in each size of the
1252 IsPeiDb
= (BOOLEAN
) (LocalTokenNumberTableIdx
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
1256 LocalTokenNumberTable
= mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
;
1257 SizeTable
= mPcdDatabase
->PeiDb
.Init
.SizeTable
;
1259 LocalTokenNumberTableIdx
-= PEI_LOCAL_TOKEN_NUMBER
;
1260 LocalTokenNumberTable
= mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
1261 SizeTable
= mPcdDatabase
->DxeDb
.Init
.SizeTable
;
1264 LocalTokenNumber
= LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
1266 ASSERT ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
);
1268 SizeTableIdx
= GetSizeTableIndex (LocalTokenNumberTableIdx
, IsPeiDb
);
1270 *MaxSize
= SizeTable
[SizeTableIdx
];
1272 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1275 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
1277 // We have only one entry for VPD enabled PCD entry:
1279 // We consider current size is equal to MAX size.
1283 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
1285 // We have only two entry for Non-Sku enabled PCD entry:
1289 return SizeTable
[SizeTableIdx
+ 1];
1292 // We have these entry for SKU enabled PCD entry
1294 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1296 SkuIdTable
= GetSkuIdArray (LocalTokenNumberTableIdx
, IsPeiDb
);
1297 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
1298 if (SkuIdTable
[1 + Index
] == mPcdDatabase
->PeiDb
.Init
.SystemSkuId
) {
1299 return SizeTable
[SizeTableIdx
+ 1 + Index
];
1302 return SizeTable
[SizeTableIdx
+ 1];
1308 Set size of POINTER type PCD value. The size should not exceed the maximum size
1311 @param LocalTokenNumberTableIdx Index of local token number in local token number table.
1312 @param CurrentSize Size of POINTER type PCD value.
1314 @retval TRUE Success to set size of PCD value.
1315 @retval FALSE Fail to set size of PCD value.
1319 IN UINTN LocalTokenNumberTableIdx
,
1320 IN OUT UINTN
*CurrentSize
1324 UINTN LocalTokenNumber
;
1326 SIZE_INFO
*SizeTable
;
1330 UINT32
*LocalTokenNumberTable
;
1333 // EBC compiler is very choosy. It may report warning about comparison
1334 // between UINTN and 0 . So we add 1 in each size of the
1337 IsPeiDb
= (BOOLEAN
) (LocalTokenNumberTableIdx
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
1340 LocalTokenNumberTable
= mPcdDatabase
->PeiDb
.Init
.LocalTokenNumberTable
;
1341 SizeTable
= mPcdDatabase
->PeiDb
.Init
.SizeTable
;
1343 LocalTokenNumberTableIdx
-= PEI_LOCAL_TOKEN_NUMBER
;
1344 LocalTokenNumberTable
= mPcdDatabase
->DxeDb
.Init
.LocalTokenNumberTable
;
1345 SizeTable
= mPcdDatabase
->DxeDb
.Init
.SizeTable
;
1348 LocalTokenNumber
= LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
1350 ASSERT ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
);
1352 SizeTableIdx
= GetSizeTableIndex (LocalTokenNumberTableIdx
, IsPeiDb
);
1354 MaxSize
= SizeTable
[SizeTableIdx
];
1356 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1359 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
1361 // We shouldn't come here as we don't support SET for VPD
1366 if ((*CurrentSize
> MaxSize
) ||
1367 (*CurrentSize
== MAX_ADDRESS
)) {
1368 *CurrentSize
= MaxSize
;
1372 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
1374 // We have only two entry for Non-Sku enabled PCD entry:
1378 SizeTable
[SizeTableIdx
+ 1] = (SIZE_INFO
) *CurrentSize
;
1382 // We have these entry for SKU enabled PCD entry
1384 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1386 SkuIdTable
= GetSkuIdArray (LocalTokenNumberTableIdx
, IsPeiDb
);
1387 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
1388 if (SkuIdTable
[1 + Index
] == mPcdDatabase
->PeiDb
.Init
.SystemSkuId
) {
1389 SizeTable
[SizeTableIdx
+ 1 + Index
] = (SIZE_INFO
) *CurrentSize
;
1393 SizeTable
[SizeTableIdx
+ 1] = (SIZE_INFO
) *CurrentSize
;