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 - 2010, 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
);
60 if (TokenNumber
== PCD_INVALID_TOKEN_NUMBER
) {
65 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
66 // We have to decrement TokenNumber by 1 to make it usable
67 // as the array index.
70 // EBC compiler is very choosy. It may report warning about comparison
71 // between UINTN and 0 . So we add 1 in each size of the
73 ASSERT (TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
77 LocalTokenNumber
= GetPcdDatabase()->Init
.LocalTokenNumberTable
[TokenNumber
];
80 // We don't support SET for HII and VPD type PCD entry in PEI phase.
81 // So we will assert if any register callback for such PCD entry.
83 ASSERT ((LocalTokenNumber
& PCD_TYPE_HII
) == 0);
84 ASSERT ((LocalTokenNumber
& PCD_TYPE_VPD
) == 0);
86 GuidHob
= GetFirstGuidHob (&gEfiCallerIdGuid
);
87 ASSERT (GuidHob
!= NULL
);
89 CallbackTable
= GET_GUID_HOB_DATA (GuidHob
);
90 CallbackTable
= CallbackTable
+ (TokenNumber
* FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
));
92 Compare
= Register
? NULL
: CallBackFunction
;
93 Assign
= Register
? CallBackFunction
: NULL
;
96 for (Idx
= 0; Idx
< FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
); Idx
++) {
97 if (CallbackTable
[Idx
] == Compare
) {
98 CallbackTable
[Idx
] = Assign
;
103 return Register
? EFI_OUT_OF_RESOURCES
: EFI_NOT_FOUND
;
108 The function builds the PCD database.
115 PEI_PCD_DATABASE
*Database
;
116 VOID
*CallbackFnTable
;
117 UINTN SizeOfCallbackFnTable
;
119 Database
= BuildGuidHob (&gPcdDataBaseHobGuid
, sizeof (PEI_PCD_DATABASE
));
121 ZeroMem (Database
, sizeof (PEI_PCD_DATABASE
));
124 // gPEIPcdDbInit is smaller than PEI_PCD_DATABASE
127 CopyMem (&Database
->Init
, &gPEIPcdDbInit
, sizeof (gPEIPcdDbInit
));
129 SizeOfCallbackFnTable
= PEI_LOCAL_TOKEN_NUMBER
* sizeof (PCD_PPI_CALLBACK
) * FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
);
131 CallbackFnTable
= BuildGuidHob (&gEfiCallerIdGuid
, SizeOfCallbackFnTable
);
133 ZeroMem (CallbackFnTable
, SizeOfCallbackFnTable
);
137 The function is provided by PCD PEIM and PCD DXE driver to
138 do the work of reading a HII variable from variable service.
140 @param VariableGuid The Variable GUID.
141 @param VariableName The Variable Name.
142 @param VariableData The output data.
143 @param VariableSize The size of the variable.
145 @retval EFI_SUCCESS Operation successful.
146 @retval EFI_NOT_FOUND Variablel not found.
150 IN CONST EFI_GUID
*VariableGuid
,
151 IN UINT16
*VariableName
,
152 OUT VOID
**VariableData
,
153 OUT UINTN
*VariableSize
159 EFI_PEI_READ_ONLY_VARIABLE2_PPI
*VariablePpi
;
161 Status
= PeiServicesLocatePpi (&gEfiPeiReadOnlyVariable2PpiGuid
, 0, NULL
, (VOID
**) &VariablePpi
);
162 ASSERT_EFI_ERROR (Status
);
165 Status
= VariablePpi
->GetVariable (
168 (EFI_GUID
*) VariableGuid
,
174 if (Status
== EFI_BUFFER_TOO_SMALL
) {
175 Status
= PeiServicesAllocatePool (Size
, &Buffer
);
176 ASSERT_EFI_ERROR (Status
);
178 Status
= VariablePpi
->GetVariable (
180 (UINT16
*) VariableName
,
181 (EFI_GUID
*) VariableGuid
,
186 ASSERT_EFI_ERROR (Status
);
188 *VariableSize
= Size
;
189 *VariableData
= Buffer
;
194 return EFI_NOT_FOUND
;
198 Find the local token number according to system SKU ID.
200 @param LocalTokenNumber PCD token number
201 @param Size The size of PCD entry.
203 @return Token number according to system SKU ID.
207 GetSkuEnabledTokenNumber (
208 UINT32 LocalTokenNumber
,
212 PEI_PCD_DATABASE
*PeiPcdDb
;
218 PeiPcdDb
= GetPcdDatabase ();
220 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0);
222 SkuHead
= (SKU_HEAD
*) ((UINT8
*)PeiPcdDb
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
223 Value
= (UINT8
*) ((UINT8
*)PeiPcdDb
+ (SkuHead
->SkuDataStartOffset
));
224 SkuIdTable
= (SKU_ID
*) ((UINT8
*)PeiPcdDb
+ (SkuHead
->SkuIdTableOffset
));
226 for (Index
= 0; Index
< SkuIdTable
[0]; Index
++) {
227 if (PeiPcdDb
->Init
.SystemSkuId
== SkuIdTable
[Index
+ 1]) {
232 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
234 Value
= (UINT8
*) &(((VPD_HEAD
*) Value
)[Index
]);
235 return (UINT32
) ((Value
- (UINT8
*) PeiPcdDb
) | PCD_TYPE_VPD
);
238 Value
= (UINT8
*) &(((VARIABLE_HEAD
*) Value
)[Index
]);
239 return (UINT32
) ((Value
- (UINT8
*) PeiPcdDb
) | PCD_TYPE_HII
);
241 case PCD_TYPE_STRING
:
242 Value
= (UINT8
*) &(((STRING_HEAD
*) Value
)[Index
]);
243 return (UINT32
) ((Value
- (UINT8
*) PeiPcdDb
) | PCD_TYPE_STRING
);
246 Value
+= Size
* Index
;
247 return (UINT32
) (Value
- (UINT8
*) PeiPcdDb
);
259 Invoke the callback function when dynamic PCD entry was set, if this PCD entry
260 has registered callback function.
262 @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx
264 @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type
266 @param TokenNumber PCD token number generated by build tools.
267 @param Data Value want to be set for this PCD entry
268 @param Size The size of value
272 InvokeCallbackOnSet (
274 CONST EFI_GUID
*Guid
, OPTIONAL
280 EFI_HOB_GUID_TYPE
*GuidHob
;
281 PCD_PPI_CALLBACK
*CallbackTable
;
285 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
286 // We have to decrement TokenNumber by 1 to make it usable
287 // as the array index.
292 // EBC compiler is very choosy. It may report warning about comparison
293 // between UINTN and 0 . So we add 1 in each size of the
295 ASSERT (TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
298 GuidHob
= GetFirstGuidHob (&gEfiCallerIdGuid
);
299 ASSERT (GuidHob
!= NULL
);
301 CallbackTable
= GET_GUID_HOB_DATA (GuidHob
);
303 CallbackTable
+= (TokenNumber
* FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
));
305 for (Idx
= 0; Idx
< FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
); Idx
++) {
306 if (CallbackTable
[Idx
] != NULL
) {
307 CallbackTable
[Idx
] (Guid
,
308 (Guid
== NULL
)? TokenNumber
: ExTokenNumber
,
317 Wrapper function for setting non-pointer type value for a PCD entry.
319 @param TokenNumber Pcd token number autogenerated by build tools.
320 @param Data Value want to be set for PCD entry
321 @param Size Size of value.
323 @return status of SetWorker.
328 IN UINTN TokenNumber
,
333 return SetWorker (TokenNumber
, Data
, &Size
, FALSE
);
337 Set value for an PCD entry
339 @param TokenNumber Pcd token number autogenerated by build tools.
340 @param Data Value want to be set for PCD entry
341 @param Size Size of value.
342 @param PtrType If TRUE, the type of PCD entry's value is Pointer.
343 If False, the type of PCD entry's value is not Pointer.
345 @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.
346 @retval EFI_INVALID_PARAMETER If Size can not be set to size table.
347 @retval EFI_INVALID_PARAMETER If Size of non-Ptr type PCD does not match the size information in PCD database.
348 @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in
349 range of UINT8, UINT16, UINT32, UINT64
350 @retval EFI_NOT_FOUND Can not find the PCD type according to token number.
354 IN UINTN TokenNumber
,
360 UINT32 LocalTokenNumber
;
361 PEI_PCD_DATABASE
*PeiPcdDb
;
362 UINT16 StringTableIdx
;
367 if (!FeaturePcdGet(PcdPeiFullPcdDatabaseEnable
)) {
368 return EFI_UNSUPPORTED
;
372 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
373 // We have to decrement TokenNumber by 1 to make it usable
374 // as the array index.
378 // EBC compiler is very choosy. It may report warning about comparison
379 // between UINTN and 0 . So we add 1 in each size of the
381 ASSERT (TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
383 PeiPcdDb
= GetPcdDatabase ();
385 LocalTokenNumber
= PeiPcdDb
->Init
.LocalTokenNumberTable
[TokenNumber
];
387 if ((!PtrType
) && (PeiPcdGetSize(TokenNumber
+ 1) != *Size
)) {
388 return EFI_INVALID_PARAMETER
;
392 // We only invoke the callback function for Dynamic Type PCD Entry.
393 // For Dynamic EX PCD entry, we have invoked the callback function for Dynamic EX
394 // type PCD entry in ExSetWorker.
396 if (TokenNumber
+ 1 < PEI_NEX_TOKEN_NUMBER
+ 1) {
397 InvokeCallbackOnSet (0, NULL
, TokenNumber
+ 1, Data
, *Size
);
400 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
402 MaxSize
= GetPtrTypeSize (TokenNumber
, &MaxSize
, PeiPcdDb
);
406 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, MaxSize
);
409 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
410 InternalData
= (VOID
*) ((UINT8
*) PeiPcdDb
+ Offset
);
412 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
417 return EFI_INVALID_PARAMETER
;
420 case PCD_TYPE_STRING
:
421 if (SetPtrTypeSize (TokenNumber
, Size
, PeiPcdDb
)) {
422 StringTableIdx
= *((UINT16
*)InternalData
);
423 CopyMem (&PeiPcdDb
->Init
.StringTable
[StringTableIdx
], Data
, *Size
);
426 return EFI_INVALID_PARAMETER
;
432 if (SetPtrTypeSize (TokenNumber
, Size
, PeiPcdDb
)) {
433 CopyMem (InternalData
, Data
, *Size
);
436 return EFI_INVALID_PARAMETER
;
442 *((UINT8
*) InternalData
) = *((UINT8
*) Data
);
446 *((UINT16
*) InternalData
) = *((UINT16
*) Data
);
450 *((UINT32
*) InternalData
) = *((UINT32
*) Data
);
454 *((UINT64
*) InternalData
) = *((UINT64
*) Data
);
459 return EFI_NOT_FOUND
;
466 return EFI_NOT_FOUND
;
471 Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.
473 @param ExTokenNumber Token number for dynamic-ex PCD.
474 @param Guid Token space guid for dynamic-ex PCD.
475 @param Data Value want to be set.
476 @param SetSize The size of value.
478 @return status of ExSetWorker().
483 IN UINTN ExTokenNumber
,
484 IN CONST EFI_GUID
*Guid
,
489 return ExSetWorker (ExTokenNumber
, Guid
, Data
, &Size
, FALSE
);
493 Set value for a dynamic PCD entry.
495 This routine find the local token number according to dynamic-ex PCD's token
496 space guid and token number firstly, and invoke callback function if this PCD
497 entry registered callback function. Finally, invoken general SetWorker to set
500 @param ExTokenNumber Dynamic-ex PCD token number.
501 @param Guid Token space guid for dynamic-ex PCD.
502 @param Data PCD value want to be set
503 @param SetSize Size of value.
504 @param PtrType If TRUE, this PCD entry is pointer type.
505 If FALSE, this PCD entry is not pointer type.
507 @return status of SetWorker().
512 IN UINTN ExTokenNumber
,
513 IN CONST EFI_GUID
*Guid
,
521 if (!FeaturePcdGet(PcdPeiFullPcdDatabaseEnable
)) {
522 return EFI_UNSUPPORTED
;
525 TokenNumber
= GetExPcdTokenNumber (Guid
, ExTokenNumber
);
526 if (TokenNumber
== PCD_INVALID_TOKEN_NUMBER
) {
527 return EFI_NOT_FOUND
;
530 InvokeCallbackOnSet (ExTokenNumber
, Guid
, TokenNumber
, Data
, *Size
);
532 return SetWorker (TokenNumber
, Data
, Size
, PtrType
);
537 Wrapper function for get PCD value for dynamic-ex PCD.
539 @param Guid Token space guid for dynamic-ex PCD.
540 @param ExTokenNumber Token number for dyanmic-ex PCD.
541 @param GetSize The size of dynamic-ex PCD value.
543 @return PCD entry in PCD database.
548 IN CONST EFI_GUID
*Guid
,
549 IN UINTN ExTokenNumber
,
553 return GetWorker (GetExPcdTokenNumber (Guid
, ExTokenNumber
), GetSize
);
557 Get the PCD entry pointer in PCD database.
559 This routine will visit PCD database to find the PCD entry according to given
560 token number. The given token number is autogened by build tools and it will be
561 translated to local token number. Local token number contains PCD's type and
562 offset of PCD entry in PCD database.
564 @param TokenNumber Token's number, it is autogened by build tools
565 @param GetSize The size of token's value
567 @return PCD entry pointer in PCD database
572 IN UINTN TokenNumber
,
579 VARIABLE_HEAD
*VariableHead
;
584 UINT16 StringTableIdx
;
585 PEI_PCD_DATABASE
*PeiPcdDb
;
586 UINT32 LocalTokenNumber
;
590 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
591 // We have to decrement TokenNumber by 1 to make it usable
592 // as the array index.
596 // EBC compiler is very choosy. It may report warning about comparison
597 // between UINTN and 0 . So we add 1 in each size of the
599 ASSERT (TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
601 ASSERT ((GetSize
== PeiPcdGetSize(TokenNumber
+ 1)) || (GetSize
== 0));
603 PeiPcdDb
= GetPcdDatabase ();
605 LocalTokenNumber
= PeiPcdDb
->Init
.LocalTokenNumberTable
[TokenNumber
];
607 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
609 MaxSize
= GetPtrTypeSize (TokenNumber
, &MaxSize
, PeiPcdDb
);
613 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, MaxSize
);
616 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
617 StringTable
= PeiPcdDb
->Init
.StringTable
;
619 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
623 VpdHead
= (VPD_HEAD
*) ((UINT8
*)PeiPcdDb
+ Offset
);
624 return (VOID
*) (UINTN
) (FixedPcdGet32(PcdVpdBaseAddress
) + VpdHead
->Offset
);
629 VariableHead
= (VARIABLE_HEAD
*) ((UINT8
*)PeiPcdDb
+ Offset
);
631 Guid
= &(PeiPcdDb
->Init
.GuidTable
[VariableHead
->GuidTableIndex
]);
632 Name
= (UINT16
*)&StringTable
[VariableHead
->StringIndex
];
634 Status
= GetHiiVariable (Guid
, Name
, &Data
, &DataSize
);
636 if (Status
== EFI_SUCCESS
) {
637 return (VOID
*) ((UINT8
*) Data
+ VariableHead
->Offset
);
640 // Return the default value specified by Platform Integrator
642 return (VOID
*) ((UINT8
*) PeiPcdDb
+ VariableHead
->DefaultValueOffset
);
647 return (VOID
*) ((UINT8
*)PeiPcdDb
+ Offset
);
649 case PCD_TYPE_STRING
:
650 StringTableIdx
= * (UINT16
*) ((UINT8
*) PeiPcdDb
+ Offset
);
651 return (VOID
*) (&StringTable
[StringTableIdx
]);
666 Get local token number according to dynamic-ex PCD's {token space guid:token number}
668 A dynamic-ex type PCD, developer must provide pair of token space guid: token number
669 in DEC file. PCD database maintain a mapping table that translate pair of {token
670 space guid: token number} to local token number.
672 @param Guid Token space guid for dynamic-ex PCD entry.
673 @param ExTokenNumber EDES_TODO: Add parameter description
675 @return local token number for dynamic-ex PCD.
679 GetExPcdTokenNumber (
680 IN CONST EFI_GUID
*Guid
,
681 IN UINTN ExTokenNumber
685 DYNAMICEX_MAPPING
*ExMap
;
689 PEI_PCD_DATABASE
*PeiPcdDb
;
691 PeiPcdDb
= GetPcdDatabase();
693 ExMap
= PeiPcdDb
->Init
.ExMapTable
;
694 GuidTable
= PeiPcdDb
->Init
.GuidTable
;
696 MatchGuid
= ScanGuid (GuidTable
, sizeof(PeiPcdDb
->Init
.GuidTable
), Guid
);
698 // We need to ASSERT here. If GUID can't be found in GuidTable, this is a
699 // error in the BUILD system.
701 ASSERT (MatchGuid
!= NULL
);
703 MatchGuidIdx
= MatchGuid
- GuidTable
;
705 for (Index
= 0; Index
< PEI_EXMAPPING_TABLE_SIZE
; Index
++) {
706 if ((ExTokenNumber
== ExMap
[Index
].ExTokenNumber
) &&
707 (MatchGuidIdx
== ExMap
[Index
].ExGuidIndex
)) {
708 return ExMap
[Index
].LocalTokenNumber
;
712 return PCD_INVALID_TOKEN_NUMBER
;
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;