2 Private functions used by PCD PEIM.
4 Copyright (c) 2006, 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.
14 Module Name: Service.c
21 The function registers the CallBackOnSet fucntion
22 according to TokenNumber and EFI_GUID space.
24 @param ExTokenNumber The token number.
25 @param Guid The GUID space.
26 @param CallBackFunction The Callback function to be registered.
27 @param Register To register or unregister the callback function.
29 @retval EFI_SUCCESS If the Callback function is registered.
30 @retval EFI_NOT_FOUND If the PCD Entry is not found according to Token Number and GUID space.
31 @retval EFI_OUT_OF_RESOURCES If the callback function can't be registered because there is not free
32 slot left in the CallbackFnTable.
35 PeiRegisterCallBackWorker (
36 IN UINTN ExTokenNumber
,
37 IN CONST EFI_GUID
*Guid
, OPTIONAL
38 IN PCD_PPI_CALLBACK CallBackFunction
,
42 EFI_HOB_GUID_TYPE
*GuidHob
;
43 PCD_PPI_CALLBACK
*CallbackTable
;
44 PCD_PPI_CALLBACK Compare
;
45 PCD_PPI_CALLBACK Assign
;
46 UINT32 LocalTokenNumber
;
51 TokenNumber
= ExTokenNumber
;
54 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
55 // We have to decrement TokenNumber by 1 to make it usable
56 // as the array index.
59 ASSERT (TokenNumber
+ 1 < PEI_NEX_TOKEN_NUMBER
+ 1);
61 TokenNumber
= GetExPcdTokenNumber (Guid
, ExTokenNumber
);
64 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
65 // We have to decrement TokenNumber by 1 to make it usable
66 // as the array index.
69 // EBC compiler is very choosy. It may report warning about comparison
70 // between UINTN and 0 . So we add 1 in each size of the
72 ASSERT (TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
76 LocalTokenNumber
= GetPcdDatabase()->Init
.LocalTokenNumberTable
[TokenNumber
];
79 // We don't support SET for HII and VPD type PCD entry in PEI phase.
80 // So we will assert if any register callback for such PCD entry.
82 ASSERT ((LocalTokenNumber
& PCD_TYPE_HII
) == 0);
83 ASSERT ((LocalTokenNumber
& PCD_TYPE_VPD
) == 0);
85 GuidHob
= GetFirstGuidHob (&gPcdPeiCallbackFnTableHobGuid
);
86 ASSERT (GuidHob
!= NULL
);
88 CallbackTable
= GET_GUID_HOB_DATA (GuidHob
);
89 CallbackTable
= CallbackTable
+ (TokenNumber
* FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
));
91 Compare
= Register
? NULL
: CallBackFunction
;
92 Assign
= Register
? CallBackFunction
: NULL
;
95 for (Idx
= 0; Idx
< FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
); Idx
++) {
96 if (CallbackTable
[Idx
] == Compare
) {
97 CallbackTable
[Idx
] = Assign
;
102 return Register
? EFI_OUT_OF_RESOURCES
: EFI_NOT_FOUND
;
107 The function builds the PCD database.
114 PEI_PCD_DATABASE
*Database
;
115 VOID
*CallbackFnTable
;
116 UINTN SizeOfCallbackFnTable
;
118 Database
= BuildGuidHob (&gPcdDataBaseHobGuid
, sizeof (PEI_PCD_DATABASE
));
120 ZeroMem (Database
, sizeof (PEI_PCD_DATABASE
));
123 // gPEIPcdDbInit is smaller than PEI_PCD_DATABASE
126 CopyMem (&Database
->Init
, &gPEIPcdDbInit
, sizeof (gPEIPcdDbInit
));
128 SizeOfCallbackFnTable
= PEI_LOCAL_TOKEN_NUMBER
* sizeof (PCD_PPI_CALLBACK
) * FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
);
130 CallbackFnTable
= BuildGuidHob (&gPcdPeiCallbackFnTableHobGuid
, SizeOfCallbackFnTable
);
132 ZeroMem (CallbackFnTable
, SizeOfCallbackFnTable
);
136 The function is provided by PCD PEIM and PCD DXE driver to
137 do the work of reading a HII variable from variable service.
139 @param VariableGuid The Variable GUID.
140 @param VariableName The Variable Name.
141 @param VariableData The output data.
142 @param VariableSize The size of the variable.
144 @retval EFI_SUCCESS Operation successful.
145 @retval EFI_NOT_FOUND Variablel not found.
149 IN CONST EFI_GUID
*VariableGuid
,
150 IN UINT16
*VariableName
,
151 OUT VOID
**VariableData
,
152 OUT UINTN
*VariableSize
158 EFI_PEI_READ_ONLY_VARIABLE2_PPI
*VariablePpi
;
160 Status
= PeiServicesLocatePpi (&gEfiPeiReadOnlyVariable2PpiGuid
, 0, NULL
, (VOID
**) &VariablePpi
);
161 ASSERT_EFI_ERROR (Status
);
164 Status
= VariablePpi
->GetVariable (
167 (EFI_GUID
*) VariableGuid
,
172 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 (&gPcdPeiCallbackFnTableHobGuid
);
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_NOT_FOUND If value type of PCD entry is intergrate, but not in
348 range of UINT8, UINT16, UINT32, UINT64
349 @retval EFI_NOT_FOUND Can not find the PCD type according to token number.
353 IN UINTN TokenNumber
,
359 UINT32 LocalTokenNumber
;
360 PEI_PCD_DATABASE
*PeiPcdDb
;
361 UINT16 StringTableIdx
;
366 if (!FeaturePcdGet(PcdPeiPcdDatabaseSetEnabled
)) {
367 return EFI_UNSUPPORTED
;
371 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
372 // We have to decrement TokenNumber by 1 to make it usable
373 // as the array index.
377 // EBC compiler is very choosy. It may report warning about comparison
378 // between UINTN and 0 . So we add 1 in each size of the
380 ASSERT (TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
382 PeiPcdDb
= GetPcdDatabase ();
384 LocalTokenNumber
= PeiPcdDb
->Init
.LocalTokenNumberTable
[TokenNumber
];
387 ASSERT (PeiPcdGetSize(TokenNumber
+ 1) == *Size
);
391 // We only invoke the callback function for Dynamic Type PCD Entry.
392 // For Dynamic EX PCD entry, we have invoked the callback function for Dynamic EX
393 // type PCD entry in ExSetWorker.
395 if (TokenNumber
+ 1 < PEI_NEX_TOKEN_NUMBER
+ 1) {
396 InvokeCallbackOnSet (0, NULL
, TokenNumber
+ 1, Data
, *Size
);
399 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
401 MaxSize
= GetPtrTypeSize (TokenNumber
, &MaxSize
, PeiPcdDb
);
405 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, MaxSize
);
408 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
409 InternalData
= (VOID
*) ((UINT8
*) PeiPcdDb
+ Offset
);
411 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
416 return EFI_INVALID_PARAMETER
;
419 case PCD_TYPE_STRING
:
420 if (SetPtrTypeSize (TokenNumber
, Size
, PeiPcdDb
)) {
421 StringTableIdx
= *((UINT16
*)InternalData
);
422 CopyMem (&PeiPcdDb
->Init
.StringTable
[StringTableIdx
], Data
, *Size
);
425 return EFI_INVALID_PARAMETER
;
431 if (SetPtrTypeSize (TokenNumber
, Size
, PeiPcdDb
)) {
432 CopyMem (InternalData
, Data
, *Size
);
435 return EFI_INVALID_PARAMETER
;
441 *((UINT8
*) InternalData
) = *((UINT8
*) Data
);
445 *((UINT16
*) InternalData
) = *((UINT16
*) Data
);
449 *((UINT32
*) InternalData
) = *((UINT32
*) Data
);
453 *((UINT64
*) InternalData
) = *((UINT64
*) Data
);
458 return EFI_NOT_FOUND
;
465 return EFI_NOT_FOUND
;
470 Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.
472 @param ExTokenNumber Token number for dynamic-ex PCD.
473 @param Guid Token space guid for dynamic-ex PCD.
474 @param Data Value want to be set.
475 @param SetSize The size of value.
477 @return status of ExSetWorker().
482 IN UINTN ExTokenNumber
,
483 IN CONST EFI_GUID
*Guid
,
488 return ExSetWorker (ExTokenNumber
, Guid
, Data
, &Size
, FALSE
);
492 Set value for a dynamic PCD entry.
494 This routine find the local token number according to dynamic-ex PCD's token
495 space guid and token number firstly, and invoke callback function if this PCD
496 entry registered callback function. Finally, invoken general SetWorker to set
499 @param ExTokenNumber Dynamic-ex PCD token number.
500 @param Guid Token space guid for dynamic-ex PCD.
501 @param Data PCD value want to be set
502 @param SetSize Size of value.
503 @param PtrType If TRUE, this PCD entry is pointer type.
504 If FALSE, this PCD entry is not pointer type.
506 @return status of SetWorker().
511 IN UINTN ExTokenNumber
,
512 IN CONST EFI_GUID
*Guid
,
520 if (!FeaturePcdGet(PcdPeiPcdDatabaseSetEnabled
)) {
521 return EFI_UNSUPPORTED
;
524 TokenNumber
= GetExPcdTokenNumber (Guid
, ExTokenNumber
);
526 InvokeCallbackOnSet (ExTokenNumber
, Guid
, TokenNumber
, Data
, *Size
);
528 return SetWorker (TokenNumber
, Data
, Size
, PtrType
);
533 Wrapper function for get PCD value for dynamic-ex PCD.
535 @param Guid Token space guid for dynamic-ex PCD.
536 @param ExTokenNumber Token number for dyanmic-ex PCD.
537 @param GetSize The size of dynamic-ex PCD value.
539 @return PCD entry in PCD database.
544 IN CONST EFI_GUID
*Guid
,
545 IN UINTN ExTokenNumber
,
549 if (!FeaturePcdGet (PcdPeiPcdDatabaseExEnabled
)) {
554 return GetWorker (GetExPcdTokenNumber (Guid
, ExTokenNumber
), GetSize
);
558 Get the PCD entry pointer in PCD database.
560 This routine will visit PCD database to find the PCD entry according to given
561 token number. The given token number is autogened by build tools and it will be
562 translated to local token number. Local token number contains PCD's type and
563 offset of PCD entry in PCD database.
565 @param TokenNumber Token's number, it is autogened by build tools
566 @param GetSize The size of token's value
568 @return PCD entry pointer in PCD database
573 IN UINTN TokenNumber
,
580 VARIABLE_HEAD
*VariableHead
;
585 UINT16 StringTableIdx
;
586 PEI_PCD_DATABASE
*PeiPcdDb
;
587 UINT32 LocalTokenNumber
;
591 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
592 // We have to decrement TokenNumber by 1 to make it usable
593 // as the array index.
597 // EBC compiler is very choosy. It may report warning about comparison
598 // between UINTN and 0 . So we add 1 in each size of the
600 ASSERT (TokenNumber
+ 1 < PEI_LOCAL_TOKEN_NUMBER
+ 1);
602 ASSERT ((GetSize
== PeiPcdGetSize(TokenNumber
+ 1)) || (GetSize
== 0));
604 PeiPcdDb
= GetPcdDatabase ();
606 LocalTokenNumber
= PeiPcdDb
->Init
.LocalTokenNumberTable
[TokenNumber
];
608 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
610 MaxSize
= GetPtrTypeSize (TokenNumber
, &MaxSize
, PeiPcdDb
);
614 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, MaxSize
);
617 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
618 StringTable
= PeiPcdDb
->Init
.StringTable
;
620 switch (LocalTokenNumber
& PCD_TYPE_ALL_SET
) {
624 VpdHead
= (VPD_HEAD
*) ((UINT8
*)PeiPcdDb
+ Offset
);
625 return (VOID
*) (UINTN
) (FixedPcdGet32(PcdVpdBaseAddress
) + VpdHead
->Offset
);
630 VariableHead
= (VARIABLE_HEAD
*) ((UINT8
*)PeiPcdDb
+ Offset
);
632 Guid
= &(PeiPcdDb
->Init
.GuidTable
[VariableHead
->GuidTableIndex
]);
633 Name
= &StringTable
[VariableHead
->StringIndex
];
635 Status
= GetHiiVariable (Guid
, Name
, &Data
, &DataSize
);
637 if (Status
== EFI_SUCCESS
) {
638 return (VOID
*) ((UINT8
*) Data
+ VariableHead
->Offset
);
641 // Return the default value specified by Platform Integrator
643 return (VOID
*) ((UINT8
*) PeiPcdDb
+ VariableHead
->DefaultValueOffset
);
648 return (VOID
*) ((UINT8
*)PeiPcdDb
+ Offset
);
650 case PCD_TYPE_STRING
:
651 StringTableIdx
= (UINT16
) *((UINT8
*) PeiPcdDb
+ Offset
);
652 return (VOID
*) (&StringTable
[StringTableIdx
]);
667 Get local token number according to dynamic-ex PCD's {token space guid:token number}
669 A dynamic-ex type PCD, developer must provide pair of token space guid: token number
670 in DEC file. PCD database maintain a mapping table that translate pair of {token
671 space guid: token number} to local token number.
673 @param Guid Token space guid for dynamic-ex PCD entry.
674 @param ExTokenNumber EDES_TODO: Add parameter description
676 @return local token number for dynamic-ex PCD.
680 GetExPcdTokenNumber (
681 IN CONST EFI_GUID
*Guid
,
682 IN UINTN ExTokenNumber
686 DYNAMICEX_MAPPING
*ExMap
;
690 PEI_PCD_DATABASE
*PeiPcdDb
;
692 PeiPcdDb
= GetPcdDatabase();
694 ExMap
= PeiPcdDb
->Init
.ExMapTable
;
695 GuidTable
= PeiPcdDb
->Init
.GuidTable
;
697 MatchGuid
= ScanGuid (GuidTable
, sizeof(PeiPcdDb
->Init
.GuidTable
), Guid
);
699 // We need to ASSERT here. If GUID can't be found in GuidTable, this is a
700 // error in the BUILD system.
702 ASSERT (MatchGuid
!= NULL
);
704 MatchGuidIdx
= MatchGuid
- GuidTable
;
706 for (Index
= 0; Index
< PEI_EXMAPPING_TABLE_SIZE
; Index
++) {
707 if ((ExTokenNumber
== ExMap
[Index
].ExTokenNumber
) &&
708 (MatchGuidIdx
== ExMap
[Index
].ExGuidIndex
)) {
709 return ExMap
[Index
].LocalTokenNumber
;
719 Get PCD database from GUID HOB in PEI phase.
721 @return Pointer to PCD database.
729 EFI_HOB_GUID_TYPE
*GuidHob
;
731 GuidHob
= GetFirstGuidHob (&gPcdDataBaseHobGuid
);
732 ASSERT (GuidHob
!= NULL
);
734 return (PEI_PCD_DATABASE
*) GET_GUID_HOB_DATA (GuidHob
);
738 Get SKU ID tabble from PCD database.
740 @param LocalTokenNumberTableIdx Index of local token number in token number table.
741 @param Database PCD database.
743 @return Pointer to SKU ID array table
748 IN UINTN LocalTokenNumberTableIdx
,
749 IN PEI_PCD_DATABASE
*Database
753 UINTN LocalTokenNumber
;
755 LocalTokenNumber
= Database
->Init
.LocalTokenNumberTable
[LocalTokenNumberTableIdx
];
757 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) != 0);
759 SkuHead
= (SKU_HEAD
*) ((UINT8
*)Database
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
761 return (SKU_ID
*) ((UINT8
*)Database
+ SkuHead
->SkuIdTableOffset
);
766 Get index of PCD entry in size table.
768 @param LocalTokenNumberTableIdx Index of this PCD in local token number table.
769 @param Database Pointer to PCD database in PEI phase.
771 @return index of PCD entry in size table.
776 IN UINTN LocalTokenNumberTableIdx
,
777 IN PEI_PCD_DATABASE
*Database
782 UINTN LocalTokenNumber
;
787 for (Index
=0; Index
<LocalTokenNumberTableIdx
; Index
++) {
788 LocalTokenNumber
= Database
->Init
.LocalTokenNumberTable
[Index
];
790 if ((LocalTokenNumber
& PCD_DATUM_TYPE_ALL_SET
) == PCD_DATUM_TYPE_POINTER
) {
792 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
795 if ((LocalTokenNumber
& PCD_TYPE_VPD
) != 0) {
797 // We have only one entry for VPD enabled PCD entry:
799 // We consider current size is equal to MAX size.
803 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0) {
805 // We have only two entry for Non-Sku enabled PCD entry:
812 // We have these entry for SKU enabled PCD entry
814 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
816 SkuIdTable
= GetSkuIdArray (Index
, Database
);
817 SizeTableIdx
+= (UINTN
)*SkuIdTable
+ 1;