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
,
171 if (Status
== EFI_BUFFER_TOO_SMALL
) {
172 Status
= PeiServicesAllocatePool (Size
, &Buffer
);
173 ASSERT_EFI_ERROR (Status
);
175 Status
= VariablePpi
->GetVariable (
177 (UINT16
*) VariableName
,
178 (EFI_GUID
*) VariableGuid
,
183 ASSERT_EFI_ERROR (Status
);
185 *VariableSize
= Size
;
186 *VariableData
= Buffer
;
191 return EFI_NOT_FOUND
;
195 Find the local token number according to system SKU ID.
197 @param LocalTokenNumber PCD token number
198 @param Size The size of PCD entry.
200 @return Token number according to system SKU ID.
204 GetSkuEnabledTokenNumber (
205 UINT32 LocalTokenNumber
,
209 PEI_PCD_DATABASE
*PeiPcdDb
;
215 PeiPcdDb
= GetPcdDatabase ();
217 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0);
219 SkuHead
= (SKU_HEAD
*) ((UINT8
*)PeiPcdDb
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
220 Value
= (UINT8
*) ((UINT8
*)PeiPcdDb
+ (SkuHead
->SkuDataStartOffset
));
221 SkuIdTable
= (SKU_ID
*) ((UINT8
*)PeiPcdDb
+ (SkuHead
->SkuIdTableOffset
));
223 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
224 if (PeiPcdDb
->Init
.SystemSkuId
== SkuIdTable
[Index
+ 1]) {
229 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
231 Value
= (UINT8
*) &(((VPD_HEAD
*) Value
)[Index
]);
232 return (UINT32
) ((Value
- (UINT8
*) PeiPcdDb
) | PCD_TYPE_VPD
);
235 Value
= (UINT8
*) &(((VARIABLE_HEAD
*) Value
)[Index
]);
236 return (UINT32
) ((Value
- (UINT8
*) PeiPcdDb
) | PCD_TYPE_HII
);
238 case PCD_TYPE_STRING
:
239 Value
= (UINT8
*) &(((STRING_HEAD
*) Value
)[Index
]);
240 return (UINT32
) ((Value
- (UINT8
*) PeiPcdDb
) | PCD_TYPE_STRING
);
243 Value
+= Size
* Index
;
244 return (UINT32
) (Value
- (UINT8
*) PeiPcdDb
);
256 Invoke the callback function when dynamic PCD entry was set, if this PCD entry
257 has registered callback function.
259 @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx
261 @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type
263 @param TokenNumber PCD token number generated by build tools.
264 @param Data Value want to be set for this PCD entry
265 @param Size The size of value
269 InvokeCallbackOnSet (
271 CONST EFI_GUID
*Guid
, OPTIONAL
277 EFI_HOB_GUID_TYPE
*GuidHob
;
278 PCD_PPI_CALLBACK
*CallbackTable
;
282 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
283 // We have to decrement TokenNumber by 1 to make it usable
284 // as the array index.
289 // EBC compiler is very choosy. It may report warning about comparison
290 // between UINTN and 0 . So we add 1 in each size of the
292 ASSERT (TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
295 GuidHob
= GetFirstGuidHob (&gPcdPeiCallbackFnTableHobGuid
);
296 ASSERT (GuidHob
!= NULL
);
298 CallbackTable
= GET_GUID_HOB_DATA (GuidHob
);
300 CallbackTable
+= (TokenNumber
* FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
));
302 for (Idx
= 0; Idx
< FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
); Idx
++) {
303 if (CallbackTable
[Idx
] != NULL
) {
304 CallbackTable
[Idx
] (Guid
,
305 (Guid
== NULL
)? TokenNumber
: ExTokenNumber
,
314 Wrapper function for setting non-pointer type value for a PCD entry.
316 @param TokenNumber Pcd token number autogenerated by build tools.
317 @param Data Value want to be set for PCD entry
318 @param Size Size of value.
320 @return status of SetWorker.
325 IN UINTN TokenNumber
,
330 return SetWorker (TokenNumber
, Data
, &Size
, FALSE
);
334 Set value for an PCD entry
336 @param TokenNumber Pcd token number autogenerated by build tools.
337 @param Data Value want to be set for PCD entry
338 @param Size Size of value.
339 @param PtrType If TRUE, the type of PCD entry's value is Pointer.
340 If False, the type of PCD entry's value is not Pointer.
342 @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.
343 @retval EFI_INVALID_PARAMETER If Size can not be set to size table.
344 @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in
345 range of UINT8, UINT16, UINT32, UINT64
346 @retval EFI_NOT_FOUND Can not find the PCD type according to token number.
350 IN UINTN TokenNumber
,
356 UINT32 LocalTokenNumber
;
357 PEI_PCD_DATABASE
*PeiPcdDb
;
358 UINT16 StringTableIdx
;
363 if (!FeaturePcdGet(PcdPeiPcdDatabaseSetEnabled
)) {
364 return EFI_UNSUPPORTED
;
368 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
369 // We have to decrement TokenNumber by 1 to make it usable
370 // as the array index.
374 // EBC compiler is very choosy. It may report warning about comparison
375 // between UINTN and 0 . So we add 1 in each size of the
377 ASSERT (TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
379 PeiPcdDb
= GetPcdDatabase ();
381 LocalTokenNumber
= PeiPcdDb
->Init
.LocalTokenNumberTable
[TokenNumber
];
384 ASSERT (PeiPcdGetSize(TokenNumber
+ 1) == *Size
);
388 // We only invoke the callback function for Dynamic Type PCD Entry.
389 // For Dynamic EX PCD entry, we have invoked the callback function for Dynamic EX
390 // type PCD entry in ExSetWorker.
392 if (TokenNumber
+ 1 < PEI_NEX_TOKEN_NUMBER
+ 1) {
393 InvokeCallbackOnSet (0, NULL
, TokenNumber
+ 1, Data
, *Size
);
396 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
398 MaxSize
= GetPtrTypeSize (TokenNumber
, &MaxSize
, PeiPcdDb
);
402 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, MaxSize
);
405 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
406 InternalData
= (VOID
*) ((UINT8
*) PeiPcdDb
+ Offset
);
408 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
413 return EFI_INVALID_PARAMETER
;
416 case PCD_TYPE_STRING
:
417 if (SetPtrTypeSize (TokenNumber
, Size
, PeiPcdDb
)) {
418 StringTableIdx
= *((UINT16
*)InternalData
);
419 CopyMem (&PeiPcdDb
->Init
.StringTable
[StringTableIdx
], Data
, *Size
);
422 return EFI_INVALID_PARAMETER
;
428 if (SetPtrTypeSize (TokenNumber
, Size
, PeiPcdDb
)) {
429 CopyMem (InternalData
, Data
, *Size
);
432 return EFI_INVALID_PARAMETER
;
438 *((UINT8
*) InternalData
) = *((UINT8
*) Data
);
442 *((UINT16
*) InternalData
) = *((UINT16
*) Data
);
446 *((UINT32
*) InternalData
) = *((UINT32
*) Data
);
450 *((UINT64
*) InternalData
) = *((UINT64
*) Data
);
455 return EFI_NOT_FOUND
;
462 return EFI_NOT_FOUND
;
467 Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.
469 @param ExTokenNumber Token number for dynamic-ex PCD.
470 @param Guid Token space guid for dynamic-ex PCD.
471 @param Data Value want to be set.
472 @param SetSize The size of value.
474 @return status of ExSetWorker().
479 IN UINTN ExTokenNumber
,
480 IN CONST EFI_GUID
*Guid
,
485 return ExSetWorker (ExTokenNumber
, Guid
, Data
, &Size
, FALSE
);
489 Set value for a dynamic PCD entry.
491 This routine find the local token number according to dynamic-ex PCD's token
492 space guid and token number firstly, and invoke callback function if this PCD
493 entry registered callback function. Finally, invoken general SetWorker to set
496 @param ExTokenNumber Dynamic-ex PCD token number.
497 @param Guid Token space guid for dynamic-ex PCD.
498 @param Data PCD value want to be set
499 @param SetSize Size of value.
500 @param PtrType If TRUE, this PCD entry is pointer type.
501 If FALSE, this PCD entry is not pointer type.
503 @return status of SetWorker().
508 IN UINTN ExTokenNumber
,
509 IN CONST EFI_GUID
*Guid
,
517 if (!FeaturePcdGet(PcdPeiPcdDatabaseSetEnabled
)) {
518 return EFI_UNSUPPORTED
;
521 TokenNumber
= GetExPcdTokenNumber (Guid
, ExTokenNumber
);
523 InvokeCallbackOnSet (ExTokenNumber
, Guid
, TokenNumber
, Data
, *Size
);
525 return SetWorker (TokenNumber
, Data
, Size
, PtrType
);
530 Wrapper function for get PCD value for dynamic-ex PCD.
532 @param Guid Token space guid for dynamic-ex PCD.
533 @param ExTokenNumber Token number for dyanmic-ex PCD.
534 @param GetSize The size of dynamic-ex PCD value.
536 @return PCD entry in PCD database.
541 IN CONST EFI_GUID
*Guid
,
542 IN UINTN ExTokenNumber
,
546 if (!FeaturePcdGet (PcdPeiPcdDatabaseExEnabled
)) {
551 return GetWorker (GetExPcdTokenNumber (Guid
, ExTokenNumber
), GetSize
);
555 Get the PCD entry pointer in PCD database.
557 This routine will visit PCD database to find the PCD entry according to given
558 token number. The given token number is autogened by build tools and it will be
559 translated to local token number. Local token number contains PCD's type and
560 offset of PCD entry in PCD database.
562 @param TokenNumber Token's number, it is autogened by build tools
563 @param GetSize The size of token's value
565 @return PCD entry pointer in PCD database
570 IN UINTN TokenNumber
,
577 VARIABLE_HEAD
*VariableHead
;
582 UINT16 StringTableIdx
;
583 PEI_PCD_DATABASE
*PeiPcdDb
;
584 UINT32 LocalTokenNumber
;
588 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
589 // We have to decrement TokenNumber by 1 to make it usable
590 // as the array index.
594 // EBC compiler is very choosy. It may report warning about comparison
595 // between UINTN and 0 . So we add 1 in each size of the
597 ASSERT (TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
599 ASSERT ((GetSize
== PeiPcdGetSize(TokenNumber
+ 1)) || (GetSize
== 0));
601 PeiPcdDb
= GetPcdDatabase ();
603 LocalTokenNumber
= PeiPcdDb
->Init
.LocalTokenNumberTable
[TokenNumber
];
605 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
607 MaxSize
= GetPtrTypeSize (TokenNumber
, &MaxSize
, PeiPcdDb
);
611 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, MaxSize
);
614 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
615 StringTable
= PeiPcdDb
->Init
.StringTable
;
617 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
621 VpdHead
= (VPD_HEAD
*) ((UINT8
*)PeiPcdDb
+ Offset
);
622 return (VOID
*) (UINTN
) (FixedPcdGet32(PcdVpdBaseAddress
) + VpdHead
->Offset
);
627 VariableHead
= (VARIABLE_HEAD
*) ((UINT8
*)PeiPcdDb
+ Offset
);
629 Guid
= &(PeiPcdDb
->Init
.GuidTable
[VariableHead
->GuidTableIndex
]);
630 Name
= &StringTable
[VariableHead
->StringIndex
];
632 Status
= GetHiiVariable (Guid
, Name
, &Data
, &DataSize
);
634 if (Status
== EFI_SUCCESS
) {
635 return (VOID
*) ((UINT8
*) Data
+ VariableHead
->Offset
);
638 // Return the default value specified by Platform Integrator
640 return (VOID
*) ((UINT8
*) PeiPcdDb
+ VariableHead
->DefaultValueOffset
);
645 return (VOID
*) ((UINT8
*)PeiPcdDb
+ Offset
);
647 case PCD_TYPE_STRING
:
648 StringTableIdx
= (UINT16
) *((UINT8
*) PeiPcdDb
+ Offset
);
649 return (VOID
*) (&StringTable
[StringTableIdx
]);
664 Get local token number according to dynamic-ex PCD's {token space guid:token number}
666 A dynamic-ex type PCD, developer must provide pair of token space guid: token number
667 in DEC file. PCD database maintain a mapping table that translate pair of {token
668 space guid: token number} to local token number.
670 @param Guid Token space guid for dynamic-ex PCD entry.
671 @param ExTokenNumber EDES_TODO: Add parameter description
673 @return local token number for dynamic-ex PCD.
677 GetExPcdTokenNumber (
678 IN CONST EFI_GUID
*Guid
,
679 IN UINTN ExTokenNumber
683 DYNAMICEX_MAPPING
*ExMap
;
687 PEI_PCD_DATABASE
*PeiPcdDb
;
689 PeiPcdDb
= GetPcdDatabase();
691 ExMap
= PeiPcdDb
->Init
.ExMapTable
;
692 GuidTable
= PeiPcdDb
->Init
.GuidTable
;
694 MatchGuid
= ScanGuid (GuidTable
, sizeof(PeiPcdDb
->Init
.GuidTable
), Guid
);
696 // We need to ASSERT here. If GUID can't be found in GuidTable, this is a
697 // error in the BUILD system.
699 ASSERT (MatchGuid
!= NULL
);
701 MatchGuidIdx
= MatchGuid
- GuidTable
;
703 for (Index
= 0; Index
< PEI_EXMAPPING_TABLE_SIZE
; Index
++) {
704 if ((ExTokenNumber
== ExMap
[Index
].ExTokenNumber
) &&
705 (MatchGuidIdx
== ExMap
[Index
].ExGuidIndex
)) {
706 return ExMap
[Index
].LocalTokenNumber
;
716 Get PCD database from GUID HOB in PEI phase.
718 @return Pointer to PCD database.
726 EFI_HOB_GUID_TYPE
*GuidHob
;
728 GuidHob
= GetFirstGuidHob (&gPcdDataBaseHobGuid
);
729 ASSERT (GuidHob
!= NULL
);
731 return (PEI_PCD_DATABASE
*) GET_GUID_HOB_DATA (GuidHob
);
735 Get SKU ID tabble from PCD database.
737 @param LocalTokenNumberTableIdx Index of local token number in token number table.
738 @param Database PCD database.
740 @return Pointer to SKU ID array table
745 IN UINTN LocalTokenNumberTableIdx
,
746 IN PEI_PCD_DATABASE
*Database
750 UINTN LocalTokenNumber
;
752 LocalTokenNumber
= Database
->Init
.LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
754 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) != 0);
756 SkuHead
= (SKU_HEAD
*) ((UINT8
*)Database
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
758 return (SKU_ID
*) ((UINT8
*)Database
+ SkuHead
->SkuIdTableOffset
);
763 Get index of PCD entry in size table.
765 @param LocalTokenNumberTableIdx Index of this PCD in local token number table.
766 @param Database Pointer to PCD database in PEI phase.
768 @return index of PCD entry in size table.
773 IN UINTN LocalTokenNumberTableIdx
,
774 IN PEI_PCD_DATABASE
*Database
779 UINTN LocalTokenNumber
;
784 for (Index
=0; Index
<LocalTokenNumberTableIdx
; Index
++) {
785 LocalTokenNumber
= Database
->Init
.LocalTokenNumberTable
[Index
];
787 if ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
) {
789 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
792 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
794 // We have only one entry for VPD enabled PCD entry:
796 // We consider current size is equal to MAX size.
800 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
802 // We have only two entry for Non-Sku enabled PCD entry:
809 // We have these entry for SKU enabled PCD entry
811 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
813 SkuIdTable
= GetSkuIdArray (Index
, Database
);
814 SizeTableIdx
+= (UINTN
)*SkuIdTable
+ 1;