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[in] TokenNumber The token number.
25 @param[in] Guid The GUID space.
26 @param[in] CallBackFunction The Callback function to be registered.
28 @retval EFI_SUCCESS If the Callback function is registered.
29 @retval EFI_NOT_FOUND If the PCD Entry is not found according to Token Number and GUID space.
32 PeiRegisterCallBackWorker (
33 IN UINTN ExTokenNumber
,
34 IN CONST EFI_GUID
*Guid
, OPTIONAL
35 IN PCD_PPI_CALLBACK CallBackFunction
,
39 EFI_HOB_GUID_TYPE
*GuidHob
;
40 PCD_PPI_CALLBACK
*CallbackTable
;
41 PCD_PPI_CALLBACK Compare
;
42 PCD_PPI_CALLBACK Assign
;
43 UINT32 LocalTokenNumber
;
48 TokenNumber
= ExTokenNumber
;
49 ASSERT (TokenNumber
< PEI_NEX_TOKEN_NUMBER
);
51 TokenNumber
= GetExPcdTokenNumber (Guid
, ExTokenNumber
);
52 ASSERT (TokenNumber
< PEI_LOCAL_TOKEN_NUMBER
);
55 LocalTokenNumber
= GetPcdDatabase()->Init
.LocalTokenNumberTable
[TokenNumber
];
57 ASSERT ((LocalTokenNumber
& PCD_TYPE_HII
) == 0);
58 ASSERT ((LocalTokenNumber
& PCD_TYPE_VPD
) == 0);
60 GuidHob
= GetFirstGuidHob (&gPcdPeiCallbackFnTableHobGuid
);
61 ASSERT (GuidHob
!= NULL
);
63 CallbackTable
= GET_GUID_HOB_DATA (GuidHob
);
64 CallbackTable
= CallbackTable
+ (TokenNumber
* FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
));
66 Compare
= Register
? NULL
: CallBackFunction
;
67 Assign
= Register
? CallBackFunction
: NULL
;
70 for (Idx
= 0; Idx
< FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
); Idx
++) {
71 if (CallbackTable
[Idx
] == Compare
) {
72 CallbackTable
[Idx
] = Assign
;
77 return Register
? EFI_OUT_OF_RESOURCES
: EFI_NOT_FOUND
;
85 The function builds the PCD database based on the
86 PCD_IMAGE on the flash.
88 @param[in] PcdImageOnFlash The PCD image on flash.
97 PEI_PCD_DATABASE
*Database
;
98 VOID
*CallbackFnTable
;
99 UINTN SizeOfCallbackFnTable
;
101 Database
= BuildGuidHob (&gPcdDataBaseHobGuid
, sizeof (PEI_PCD_DATABASE
));
103 ZeroMem (Database
, sizeof (PEI_PCD_DATABASE
));
106 // gPEIPcdDbInit is smaller than PEI_PCD_DATABASE
109 CopyMem (&Database
->Init
, &gPEIPcdDbInit
, sizeof (gPEIPcdDbInit
));
111 SizeOfCallbackFnTable
= PEI_LOCAL_TOKEN_NUMBER
* sizeof (PCD_PPI_CALLBACK
) * FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
);
113 CallbackFnTable
= BuildGuidHob (&gPcdPeiCallbackFnTableHobGuid
, SizeOfCallbackFnTable
);
115 ZeroMem (CallbackFnTable
, SizeOfCallbackFnTable
);
123 The function is provided by PCD PEIM and PCD DXE driver to
124 do the work of reading a HII variable from variable service.
126 @param[in] VariableGuid The Variable GUID.
127 @param[in] VariableName The Variable Name.
128 @param[out] VariableData The output data.
129 @param[out] VariableSize The size of the variable.
131 @retval EFI_SUCCESS Operation successful.
132 @retval EFI_SUCCESS Variablel not found.
136 IN CONST EFI_GUID
*VariableGuid
,
137 IN UINT16
*VariableName
,
138 OUT VOID
**VariableData
,
139 OUT UINTN
*VariableSize
145 EFI_PEI_READ_ONLY_VARIABLE_PPI
*VariablePpi
;
147 Status
= PeiServicesLocatePpi (&gEfiPeiReadOnlyVariablePpiGuid
, 0, NULL
, (VOID
**) &VariablePpi
);
148 ASSERT_EFI_ERROR (Status
);
151 Status
= VariablePpi
->PeiGetVariable (
152 GetPeiServicesTablePointer (),
154 (EFI_GUID
*) VariableGuid
,
159 if (Status
== EFI_BUFFER_TOO_SMALL
) {
162 Status
= PeiServicesAllocatePool (Size
, &Buffer
);
163 ASSERT_EFI_ERROR (Status
);
165 Status
= VariablePpi
->PeiGetVariable (
166 GetPeiServicesTablePointer (),
167 (UINT16
*) VariableName
,
168 (EFI_GUID
*) VariableGuid
,
173 ASSERT_EFI_ERROR (Status
);
175 *VariableSize
= Size
;
176 *VariableData
= Buffer
;
180 return EFI_NOT_FOUND
;
187 GetSkuEnabledTokenNumber (
188 UINT32 LocalTokenNumber
,
192 PEI_PCD_DATABASE
*PeiPcdDb
;
198 PeiPcdDb
= GetPcdDatabase ();
200 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0);
202 SkuHead
= (SKU_HEAD
*) ((UINT8
*)PeiPcdDb
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
203 Value
= (UINT8
*) ((UINT8
*)PeiPcdDb
+ (SkuHead
->SkuDataStartOffset
));
204 SkuIdTable
= (SKU_ID
*) ((UINT8
*)PeiPcdDb
+ (SkuHead
->SkuIdTableOffset
));
206 for (i
= 0; i
< SkuIdTable
[0]; i
++) {
207 if (PeiPcdDb
->Init
.SystemSkuId
== SkuIdTable
[i
+ 1]) {
212 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
214 Value
+= sizeof(VPD_HEAD
) * i
;
215 return ((Value
- (UINT8
*) PeiPcdDb
) | PCD_TYPE_VPD
);
218 Value
+= sizeof(VARIABLE_HEAD
) * i
;
219 return ((Value
- (UINT8
*) PeiPcdDb
) | PCD_TYPE_HII
);
223 return (Value
- (UINT8
*) PeiPcdDb
);
239 InvokeCallbackOnSet (
240 UINT32 ExTokenNumber
,
241 CONST EFI_GUID
*Guid
, OPTIONAL
247 EFI_HOB_GUID_TYPE
*GuidHob
;
248 PCD_PPI_CALLBACK
*CallbackTable
;
252 ASSERT (TokenNumber
< PEI_LOCAL_TOKEN_NUMBER
);
254 GuidHob
= GetFirstGuidHob (&gPcdPeiCallbackFnTableHobGuid
);
255 ASSERT (GuidHob
!= NULL
);
257 CallbackTable
= GET_GUID_HOB_DATA (GuidHob
);
259 CallbackTable
+= (TokenNumber
* FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
));
261 for (Idx
= 0; Idx
< FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
); Idx
++) {
262 if (CallbackTable
[Idx
] != NULL
) {
263 CallbackTable
[Idx
] (Guid
,
264 (Guid
== NULL
)? TokenNumber
: ExTokenNumber
,
284 UINT32 LocalTokenNumber
;
285 PEI_PCD_DATABASE
*PeiPcdDb
;
286 UINT16 StringTableIdx
;
290 ASSERT (TokenNumber
< PEI_LOCAL_TOKEN_NUMBER
);
292 PeiPcdDb
= GetPcdDatabase ();
294 LocalTokenNumber
= PeiPcdDb
->Init
.LocalTokenNumberTable
[TokenNumber
];
297 ASSERT (PeiPcdDb
->Init
.SizeTable
[TokenNumber
] >= Size
);
299 ASSERT (PeiPcdDb
->Init
.SizeTable
[TokenNumber
] == Size
);
303 // We only invoke the callback function for Dynamic Type PCD Entry.
304 // For Dynamic EX PCD entry, we have invoked the callback function for Dynamic EX
305 // type PCD entry in ExSetWorker.
307 if (TokenNumber
< PEI_NEX_TOKEN_NUMBER
) {
308 InvokeCallbackOnSet (0, NULL
, TokenNumber
, Data
, Size
);
311 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
312 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, Size
);
315 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
316 InternalData
= (VOID
*) ((UINT8
*) PeiPcdDb
+ Offset
);
318 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
323 return EFI_INVALID_PARAMETER
;
326 case PCD_TYPE_STRING
:
327 StringTableIdx
= *((UINT16
*)InternalData
);
328 CopyMem (&PeiPcdDb
->Init
.StringTable
[StringTableIdx
], Data
, Size
);
335 CopyMem (InternalData
, Data
, Size
);
341 *((UINT8
*) InternalData
) = *((UINT8
*) Data
);
345 *((UINT16
*) InternalData
) = *((UINT16
*) Data
);
349 *((UINT32
*) InternalData
) = *((UINT32
*) Data
);
353 *((UINT64
*) InternalData
) = *((UINT64
*) Data
);
358 return EFI_NOT_FOUND
;
365 return EFI_NOT_FOUND
;
374 IN UINTN ExTokenNumber
,
375 IN CONST EFI_GUID
*Guid
,
383 TokenNumber
= GetExPcdTokenNumber (Guid
, ExTokenNumber
);
385 InvokeCallbackOnSet (ExTokenNumber
, Guid
, TokenNumber
, Data
, Size
);
387 SetWorker (TokenNumber
, Data
, Size
, PtrType
);
398 IN CONST EFI_GUID
*Guid
,
399 IN UINTN ExTokenNumber
,
403 return GetWorker (GetExPcdTokenNumber (Guid
, ExTokenNumber
), GetSize
);
418 VARIABLE_HEAD
*VariableHead
;
423 UINT16 StringTableIdx
;
424 PEI_PCD_DATABASE
*PeiPcdDb
;
425 UINT32 LocalTokenNumber
;
428 ASSERT (TokenNumber
< PEI_LOCAL_TOKEN_NUMBER
);
430 Size
= PeiPcdGetSize(TokenNumber
);
432 ASSERT (GetSize
== Size
|| GetSize
== 0);
434 PeiPcdDb
= GetPcdDatabase ();
436 LocalTokenNumber
= PeiPcdDb
->Init
.LocalTokenNumberTable
[TokenNumber
];
438 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
439 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, Size
);
442 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
443 StringTable
= PeiPcdDb
->Init
.StringTable
;
445 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
449 VpdHead
= (VPD_HEAD
*) ((UINT8
*)PeiPcdDb
+ Offset
);
450 return (VOID
*) (FixedPcdGet32(PcdVpdBaseAddress
) + VpdHead
->Offset
);
455 VariableHead
= (VARIABLE_HEAD
*) ((UINT8
*)PeiPcdDb
+ Offset
);
457 Guid
= &(PeiPcdDb
->Init
.GuidTable
[VariableHead
->GuidTableIndex
]);
458 Name
= &StringTable
[VariableHead
->StringIndex
];
460 Status
= GetHiiVariable (Guid
, Name
, &Data
, &DataSize
);
462 if (Status
== EFI_SUCCESS
) {
463 ASSERT (DataSize
>= (UINTN
) (VariableHead
->Offset
+ Size
));
464 return (VOID
*) ((UINT8
*) Data
+ VariableHead
->Offset
);
467 // BugBug: Need to support default value. The current implementation
468 // will return a memory buffer with ALL ZERO.
470 return AllocateZeroPool (Size
);
475 return (VOID
*) ((UINT8
*)PeiPcdDb
+ Offset
);
478 case PCD_TYPE_STRING
:
479 StringTableIdx
= (UINT16
) *((UINT8
*) PeiPcdDb
+ Offset
);
480 return (VOID
*) (&StringTable
[StringTableIdx
]);
496 GetExPcdTokenNumber (
497 IN CONST EFI_GUID
*Guid
,
498 IN UINT32 ExTokenNumber
502 DYNAMICEX_MAPPING
*ExMap
;
506 PEI_PCD_DATABASE
*PeiPcdDb
;
508 PeiPcdDb
= GetPcdDatabase();
510 ExMap
= PeiPcdDb
->Init
.ExMapTable
;
511 GuidTable
= PeiPcdDb
->Init
.GuidTable
;
513 MatchGuid
= ScanGuid (GuidTable
, sizeof(PeiPcdDb
->Init
.GuidTable
), Guid
);
514 ASSERT (MatchGuid
!= NULL
);
516 MatchGuidIdx
= MatchGuid
- GuidTable
;
518 for (i
= 0; i
< PEI_EXMAPPING_TABLE_SIZE
; i
++) {
519 if ((ExTokenNumber
== ExMap
[i
].ExTokenNumber
) &&
520 (MatchGuidIdx
== ExMap
[i
].ExGuidIndex
)) {
521 return ExMap
[i
].LocalTokenNumber
;
537 EFI_HOB_GUID_TYPE
*GuidHob
;
539 GuidHob
= GetFirstGuidHob (&gPcdDataBaseHobGuid
);
540 ASSERT (GuidHob
!= NULL
);
542 return (PEI_PCD_DATABASE
*) GET_GUID_HOB_DATA (GuidHob
);