2 The driver internal functions are implmented here.
3 They build Pei PCD database, and provide access service to PCD database.
5 Copyright (c) 2006 - 2008, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 The function registers the CallBackOnSet fucntion
20 according to TokenNumber and EFI_GUID space.
22 @param ExTokenNumber The token number.
23 @param Guid The GUID space.
24 @param CallBackFunction The Callback function to be registered.
25 @param Register To register or unregister the callback function.
27 @retval EFI_SUCCESS If the Callback function is registered.
28 @retval EFI_NOT_FOUND If the PCD Entry is not found according to Token Number and GUID space.
29 @retval EFI_OUT_OF_RESOURCES If the callback function can't be registered because there is not free
30 slot left in the CallbackFnTable.
33 PeiRegisterCallBackWorker (
34 IN UINTN ExTokenNumber
,
35 IN CONST EFI_GUID
*Guid
, OPTIONAL
36 IN PCD_PPI_CALLBACK CallBackFunction
,
40 EFI_HOB_GUID_TYPE
*GuidHob
;
41 PCD_PPI_CALLBACK
*CallbackTable
;
42 PCD_PPI_CALLBACK Compare
;
43 PCD_PPI_CALLBACK Assign
;
44 UINT32 LocalTokenNumber
;
49 TokenNumber
= ExTokenNumber
;
52 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
53 // We have to decrement TokenNumber by 1 to make it usable
54 // as the array index.
57 ASSERT (TokenNumber
+ 1 < PEI_NEX_TOKEN_NUMBER
+ 1);
59 TokenNumber
= GetExPcdTokenNumber (Guid
, ExTokenNumber
);
62 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
63 // We have to decrement TokenNumber by 1 to make it usable
64 // as the array index.
67 // EBC compiler is very choosy. It may report warning about comparison
68 // between UINTN and 0 . So we add 1 in each size of the
70 ASSERT (TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
74 LocalTokenNumber
= GetPcdDatabase()->Init
.LocalTokenNumberTable
[TokenNumber
];
77 // We don't support SET for HII and VPD type PCD entry in PEI phase.
78 // So we will assert if any register callback for such PCD entry.
80 ASSERT ((LocalTokenNumber
& PCD_TYPE_HII
) == 0);
81 ASSERT ((LocalTokenNumber
& PCD_TYPE_VPD
) == 0);
83 GuidHob
= GetFirstGuidHob (&gPcdPeiCallbackFnTableHobGuid
);
84 ASSERT (GuidHob
!= NULL
);
86 CallbackTable
= GET_GUID_HOB_DATA (GuidHob
);
87 CallbackTable
= CallbackTable
+ (TokenNumber
* FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
));
89 Compare
= Register
? NULL
: CallBackFunction
;
90 Assign
= Register
? CallBackFunction
: NULL
;
93 for (Idx
= 0; Idx
< FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
); Idx
++) {
94 if (CallbackTable
[Idx
] == Compare
) {
95 CallbackTable
[Idx
] = Assign
;
100 return Register
? EFI_OUT_OF_RESOURCES
: EFI_NOT_FOUND
;
105 The function builds the PCD database.
112 PEI_PCD_DATABASE
*Database
;
113 VOID
*CallbackFnTable
;
114 UINTN SizeOfCallbackFnTable
;
116 Database
= BuildGuidHob (&gPcdDataBaseHobGuid
, sizeof (PEI_PCD_DATABASE
));
118 ZeroMem (Database
, sizeof (PEI_PCD_DATABASE
));
121 // gPEIPcdDbInit is smaller than PEI_PCD_DATABASE
124 CopyMem (&Database
->Init
, &gPEIPcdDbInit
, sizeof (gPEIPcdDbInit
));
126 SizeOfCallbackFnTable
= PEI_LOCAL_TOKEN_NUMBER
* sizeof (PCD_PPI_CALLBACK
) * FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
);
128 CallbackFnTable
= BuildGuidHob (&gPcdPeiCallbackFnTableHobGuid
, SizeOfCallbackFnTable
);
130 ZeroMem (CallbackFnTable
, SizeOfCallbackFnTable
);
134 The function is provided by PCD PEIM and PCD DXE driver to
135 do the work of reading a HII variable from variable service.
137 @param VariableGuid The Variable GUID.
138 @param VariableName The Variable Name.
139 @param VariableData The output data.
140 @param VariableSize The size of the variable.
142 @retval EFI_SUCCESS Operation successful.
143 @retval EFI_NOT_FOUND Variablel not found.
147 IN CONST EFI_GUID
*VariableGuid
,
148 IN UINT16
*VariableName
,
149 OUT VOID
**VariableData
,
150 OUT UINTN
*VariableSize
156 EFI_PEI_READ_ONLY_VARIABLE2_PPI
*VariablePpi
;
158 Status
= PeiServicesLocatePpi (&gEfiPeiReadOnlyVariable2PpiGuid
, 0, NULL
, (VOID
**) &VariablePpi
);
159 ASSERT_EFI_ERROR (Status
);
162 Status
= VariablePpi
->GetVariable (
165 (EFI_GUID
*) VariableGuid
,
170 if (Status
== EFI_BUFFER_TOO_SMALL
) {
173 Status
= PeiServicesAllocatePool (Size
, &Buffer
);
174 ASSERT_EFI_ERROR (Status
);
176 Status
= VariablePpi
->GetVariable (
178 (UINT16
*) VariableName
,
179 (EFI_GUID
*) VariableGuid
,
184 ASSERT_EFI_ERROR (Status
);
186 *VariableSize
= Size
;
187 *VariableData
= Buffer
;
192 return EFI_NOT_FOUND
;
196 Find the local token number according to system SKU ID.
198 @param LocalTokenNumber PCD token number
199 @param Size The size of PCD entry.
201 @return Token number according to system SKU ID.
205 GetSkuEnabledTokenNumber (
206 UINT32 LocalTokenNumber
,
210 PEI_PCD_DATABASE
*PeiPcdDb
;
216 PeiPcdDb
= GetPcdDatabase ();
218 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0);
220 SkuHead
= (SKU_HEAD
*) ((UINT8
*)PeiPcdDb
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
221 Value
= (UINT8
*) ((UINT8
*)PeiPcdDb
+ (SkuHead
->SkuDataStartOffset
));
222 SkuIdTable
= (SKU_ID
*) ((UINT8
*)PeiPcdDb
+ (SkuHead
->SkuIdTableOffset
));
224 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
225 if (PeiPcdDb
->Init
.SystemSkuId
== SkuIdTable
[Index
+ 1]) {
230 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
232 Value
= (UINT8
*) &(((VPD_HEAD
*) Value
)[Index
]);
233 return (UINT32
) ((Value
- (UINT8
*) PeiPcdDb
) | PCD_TYPE_VPD
);
236 Value
= (UINT8
*) &(((VARIABLE_HEAD
*) Value
)[Index
]);
237 return (UINT32
) ((Value
- (UINT8
*) PeiPcdDb
) | PCD_TYPE_HII
);
239 case PCD_TYPE_STRING
:
240 Value
= (UINT8
*) &(((STRING_HEAD
*) Value
)[Index
]);
241 return (UINT32
) ((Value
- (UINT8
*) PeiPcdDb
) | PCD_TYPE_STRING
);
244 Value
+= Size
* Index
;
245 return (UINT32
) (Value
- (UINT8
*) PeiPcdDb
);
257 Invoke the callback function when dynamic PCD entry was set, if this PCD entry
258 has registered callback function.
260 @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx
262 @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type
264 @param TokenNumber PCD token number generated by build tools.
265 @param Data Value want to be set for this PCD entry
266 @param Size The size of value
270 InvokeCallbackOnSet (
272 CONST EFI_GUID
*Guid
, OPTIONAL
278 EFI_HOB_GUID_TYPE
*GuidHob
;
279 PCD_PPI_CALLBACK
*CallbackTable
;
283 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
284 // We have to decrement TokenNumber by 1 to make it usable
285 // as the array index.
290 // EBC compiler is very choosy. It may report warning about comparison
291 // between UINTN and 0 . So we add 1 in each size of the
293 ASSERT (TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
296 GuidHob
= GetFirstGuidHob (&gPcdPeiCallbackFnTableHobGuid
);
297 ASSERT (GuidHob
!= NULL
);
299 CallbackTable
= GET_GUID_HOB_DATA (GuidHob
);
301 CallbackTable
+= (TokenNumber
* FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
));
303 for (Idx
= 0; Idx
< FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
); Idx
++) {
304 if (CallbackTable
[Idx
] != NULL
) {
305 CallbackTable
[Idx
] (Guid
,
306 (Guid
== NULL
)? TokenNumber
: ExTokenNumber
,
315 Wrapper function for setting non-pointer type value for a PCD entry.
317 @param TokenNumber Pcd token number autogenerated by build tools.
318 @param Data Value want to be set for PCD entry
319 @param Size Size of value.
321 @return status of SetWorker.
326 IN UINTN TokenNumber
,
331 return SetWorker (TokenNumber
, Data
, &Size
, FALSE
);
335 Set value for an PCD entry
337 @param TokenNumber Pcd token number autogenerated by build tools.
338 @param Data Value want to be set for PCD entry
339 @param Size Size of value.
340 @param PtrType If TRUE, the type of PCD entry's value is Pointer.
341 If False, the type of PCD entry's value is not Pointer.
343 @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.
344 @retval EFI_INVALID_PARAMETER If Size can not be set to size table.
345 @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in
346 range of UINT8, UINT16, UINT32, UINT64
347 @retval EFI_NOT_FOUND Can not find the PCD type according to token number.
351 IN UINTN TokenNumber
,
357 UINT32 LocalTokenNumber
;
358 PEI_PCD_DATABASE
*PeiPcdDb
;
359 UINT16 StringTableIdx
;
364 if (!FeaturePcdGet(PcdPeiPcdDatabaseSetEnabled
)) {
365 return EFI_UNSUPPORTED
;
369 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
370 // We have to decrement TokenNumber by 1 to make it usable
371 // as the array index.
375 // EBC compiler is very choosy. It may report warning about comparison
376 // between UINTN and 0 . So we add 1 in each size of the
378 ASSERT (TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
380 PeiPcdDb
= GetPcdDatabase ();
382 LocalTokenNumber
= PeiPcdDb
->Init
.LocalTokenNumberTable
[TokenNumber
];
385 ASSERT (PeiPcdGetSize(TokenNumber
+ 1) == *Size
);
389 // We only invoke the callback function for Dynamic Type PCD Entry.
390 // For Dynamic EX PCD entry, we have invoked the callback function for Dynamic EX
391 // type PCD entry in ExSetWorker.
393 if (TokenNumber
+ 1 < PEI_NEX_TOKEN_NUMBER
+ 1) {
394 InvokeCallbackOnSet (0, NULL
, TokenNumber
+ 1, Data
, *Size
);
397 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
399 MaxSize
= GetPtrTypeSize (TokenNumber
, &MaxSize
, PeiPcdDb
);
403 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, MaxSize
);
406 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
407 InternalData
= (VOID
*) ((UINT8
*) PeiPcdDb
+ Offset
);
409 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
414 return EFI_INVALID_PARAMETER
;
417 case PCD_TYPE_STRING
:
418 if (SetPtrTypeSize (TokenNumber
, Size
, PeiPcdDb
)) {
419 StringTableIdx
= *((UINT16
*)InternalData
);
420 CopyMem (&PeiPcdDb
->Init
.StringTable
[StringTableIdx
], Data
, *Size
);
423 return EFI_INVALID_PARAMETER
;
429 if (SetPtrTypeSize (TokenNumber
, Size
, PeiPcdDb
)) {
430 CopyMem (InternalData
, Data
, *Size
);
433 return EFI_INVALID_PARAMETER
;
439 *((UINT8
*) InternalData
) = *((UINT8
*) Data
);
443 *((UINT16
*) InternalData
) = *((UINT16
*) Data
);
447 *((UINT32
*) InternalData
) = *((UINT32
*) Data
);
451 *((UINT64
*) InternalData
) = *((UINT64
*) Data
);
456 return EFI_NOT_FOUND
;
463 return EFI_NOT_FOUND
;
468 Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.
470 @param ExTokenNumber Token number for dynamic-ex PCD.
471 @param Guid Token space guid for dynamic-ex PCD.
472 @param Data Value want to be set.
473 @param SetSize The size of value.
475 @return status of ExSetWorker().
480 IN UINTN ExTokenNumber
,
481 IN CONST EFI_GUID
*Guid
,
486 return ExSetWorker (ExTokenNumber
, Guid
, Data
, &Size
, FALSE
);
490 Set value for a dynamic PCD entry.
492 This routine find the local token number according to dynamic-ex PCD's token
493 space guid and token number firstly, and invoke callback function if this PCD
494 entry registered callback function. Finally, invoken general SetWorker to set
497 @param ExTokenNumber Dynamic-ex PCD token number.
498 @param Guid Token space guid for dynamic-ex PCD.
499 @param Data PCD value want to be set
500 @param SetSize Size of value.
501 @param PtrType If TRUE, this PCD entry is pointer type.
502 If FALSE, this PCD entry is not pointer type.
504 @return status of SetWorker().
509 IN UINTN ExTokenNumber
,
510 IN CONST EFI_GUID
*Guid
,
518 if (!FeaturePcdGet(PcdPeiPcdDatabaseSetEnabled
)) {
519 return EFI_UNSUPPORTED
;
522 TokenNumber
= GetExPcdTokenNumber (Guid
, ExTokenNumber
);
524 InvokeCallbackOnSet (ExTokenNumber
, Guid
, TokenNumber
, Data
, *Size
);
526 return SetWorker (TokenNumber
, Data
, Size
, PtrType
);
531 Wrapper function for get PCD value for dynamic-ex PCD.
533 @param Guid Token space guid for dynamic-ex PCD.
534 @param ExTokenNumber Token number for dyanmic-ex PCD.
535 @param GetSize The size of dynamic-ex PCD value.
537 @return PCD entry in PCD database.
542 IN CONST EFI_GUID
*Guid
,
543 IN UINTN ExTokenNumber
,
547 if (!FeaturePcdGet (PcdPeiPcdDatabaseExEnabled
)) {
552 return GetWorker (GetExPcdTokenNumber (Guid
, ExTokenNumber
), GetSize
);
556 Get the PCD entry pointer in PCD database.
558 This routine will visit PCD database to find the PCD entry according to given
559 token number. The given token number is autogened by build tools and it will be
560 translated to local token number. Local token number contains PCD's type and
561 offset of PCD entry in PCD database.
563 @param TokenNumber Token's number, it is autogened by build tools
564 @param GetSize The size of token's value
566 @return PCD entry pointer in PCD database
571 IN UINTN TokenNumber
,
578 VARIABLE_HEAD
*VariableHead
;
583 UINT16 StringTableIdx
;
584 PEI_PCD_DATABASE
*PeiPcdDb
;
585 UINT32 LocalTokenNumber
;
589 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
590 // We have to decrement TokenNumber by 1 to make it usable
591 // as the array index.
595 // EBC compiler is very choosy. It may report warning about comparison
596 // between UINTN and 0 . So we add 1 in each size of the
598 ASSERT (TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
600 ASSERT ((GetSize
== PeiPcdGetSize(TokenNumber
+ 1)) || (GetSize
== 0));
602 PeiPcdDb
= GetPcdDatabase ();
604 LocalTokenNumber
= PeiPcdDb
->Init
.LocalTokenNumberTable
[TokenNumber
];
606 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
608 MaxSize
= GetPtrTypeSize (TokenNumber
, &MaxSize
, PeiPcdDb
);
612 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, MaxSize
);
615 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
616 StringTable
= PeiPcdDb
->Init
.StringTable
;
618 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
622 VpdHead
= (VPD_HEAD
*) ((UINT8
*)PeiPcdDb
+ Offset
);
623 return (VOID
*) (UINTN
) (FixedPcdGet32(PcdVpdBaseAddress
) + VpdHead
->Offset
);
628 VariableHead
= (VARIABLE_HEAD
*) ((UINT8
*)PeiPcdDb
+ Offset
);
630 Guid
= &(PeiPcdDb
->Init
.GuidTable
[VariableHead
->GuidTableIndex
]);
631 Name
= &StringTable
[VariableHead
->StringIndex
];
633 Status
= GetHiiVariable (Guid
, Name
, &Data
, &DataSize
);
635 if (Status
== EFI_SUCCESS
) {
636 return (VOID
*) ((UINT8
*) Data
+ VariableHead
->Offset
);
639 // Return the default value specified by Platform Integrator
641 return (VOID
*) ((UINT8
*) PeiPcdDb
+ VariableHead
->DefaultValueOffset
);
646 return (VOID
*) ((UINT8
*)PeiPcdDb
+ Offset
);
648 case PCD_TYPE_STRING
:
649 StringTableIdx
= (UINT16
) *((UINT8
*) PeiPcdDb
+ Offset
);
650 return (VOID
*) (&StringTable
[StringTableIdx
]);
665 Get local token number according to dynamic-ex PCD's {token space guid:token number}
667 A dynamic-ex type PCD, developer must provide pair of token space guid: token number
668 in DEC file. PCD database maintain a mapping table that translate pair of {token
669 space guid: token number} to local token number.
671 @param Guid Token space guid for dynamic-ex PCD entry.
672 @param ExTokenNumber EDES_TODO: Add parameter description
674 @return local token number for dynamic-ex PCD.
678 GetExPcdTokenNumber (
679 IN CONST EFI_GUID
*Guid
,
680 IN UINTN ExTokenNumber
684 DYNAMICEX_MAPPING
*ExMap
;
688 PEI_PCD_DATABASE
*PeiPcdDb
;
690 PeiPcdDb
= GetPcdDatabase();
692 ExMap
= PeiPcdDb
->Init
.ExMapTable
;
693 GuidTable
= PeiPcdDb
->Init
.GuidTable
;
695 MatchGuid
= ScanGuid (GuidTable
, sizeof(PeiPcdDb
->Init
.GuidTable
), Guid
);
697 // We need to ASSERT here. If GUID can't be found in GuidTable, this is a
698 // error in the BUILD system.
700 ASSERT (MatchGuid
!= NULL
);
702 MatchGuidIdx
= MatchGuid
- GuidTable
;
704 for (Index
= 0; Index
< PEI_EXMAPPING_TABLE_SIZE
; Index
++) {
705 if ((ExTokenNumber
== ExMap
[Index
].ExTokenNumber
) &&
706 (MatchGuidIdx
== ExMap
[Index
].ExGuidIndex
)) {
707 return ExMap
[Index
].LocalTokenNumber
;
717 Get PCD database from GUID HOB in PEI phase.
719 @return Pointer to PCD database.
727 EFI_HOB_GUID_TYPE
*GuidHob
;
729 GuidHob
= GetFirstGuidHob (&gPcdDataBaseHobGuid
);
730 ASSERT (GuidHob
!= NULL
);
732 return (PEI_PCD_DATABASE
*) GET_GUID_HOB_DATA (GuidHob
);
736 Get SKU ID tabble from PCD database.
738 @param LocalTokenNumberTableIdx Index of local token number in token number table.
739 @param Database PCD database.
741 @return Pointer to SKU ID array table
746 IN UINTN LocalTokenNumberTableIdx
,
747 IN PEI_PCD_DATABASE
*Database
751 UINTN LocalTokenNumber
;
753 LocalTokenNumber
= Database
->Init
.LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
755 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) != 0);
757 SkuHead
= (SKU_HEAD
*) ((UINT8
*)Database
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
759 return (SKU_ID
*) ((UINT8
*)Database
+ SkuHead
->SkuIdTableOffset
);
764 Get index of PCD entry in size table.
766 @param LocalTokenNumberTableIdx Index of this PCD in local token number table.
767 @param Database Pointer to PCD database in PEI phase.
769 @return index of PCD entry in size table.
774 IN UINTN LocalTokenNumberTableIdx
,
775 IN PEI_PCD_DATABASE
*Database
780 UINTN LocalTokenNumber
;
785 for (Index
=0; Index
<LocalTokenNumberTableIdx
; Index
++) {
786 LocalTokenNumber
= Database
->Init
.LocalTokenNumberTable
[Index
];
788 if ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
) {
790 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
793 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
795 // We have only one entry for VPD enabled PCD entry:
797 // We consider current size is equal to MAX size.
801 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
803 // We have only two entry for Non-Sku enabled PCD entry:
810 // We have these entry for SKU enabled PCD entry
812 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
814 SkuIdTable
= GetSkuIdArray (Index
, Database
);
815 SizeTableIdx
+= (UINTN
)*SkuIdTable
+ 1;