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 PCD_TOKEN_NUMBER 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
;
44 PCD_TOKEN_NUMBER TokenNumber
;
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
= PeiCoreLocatePpi (&gEfiPeiReadOnlyVariablePpiGuid
, 0, NULL
, (VOID
**) &VariablePpi
);
148 ASSERT_EFI_ERROR (Status
);
152 Status
= VariablePpi
->PeiGetVariable (
153 GetPeiServicesTablePointer (),
155 (EFI_GUID
*) VariableGuid
,
160 ASSERT (Status
== EFI_BUFFER_TOO_SMALL
);
162 Status
= PeiCoreAllocatePool (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
;
183 GetSkuEnabledTokenNumber (
184 UINT32 LocalTokenNumber
,
188 PEI_PCD_DATABASE
*PeiPcdDb
;
194 PeiPcdDb
= GetPcdDatabase ();
196 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0);
198 SkuHead
= (SKU_HEAD
*) ((UINT8
*)PeiPcdDb
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
199 Value
= (UINT8
*) ((UINT8
*)PeiPcdDb
+ (SkuHead
->SkuDataStartOffset
));
200 SkuIdTable
= (SKU_ID
*) ((UINT8
*)PeiPcdDb
+ (SkuHead
->SkuIdTableOffset
));
202 for (i
= 0; i
< SkuIdTable
[0]; i
++) {
203 if (PeiPcdDb
->Init
.SystemSkuId
== SkuIdTable
[i
+ 1]) {
208 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
210 Value
+= sizeof(VPD_HEAD
) * i
;
211 return ((Value
- (UINT8
*) PeiPcdDb
) | PCD_TYPE_VPD
);
214 Value
+= sizeof(VARIABLE_HEAD
) * i
;
215 return ((Value
- (UINT8
*) PeiPcdDb
) | PCD_TYPE_HII
);
219 return (Value
- (UINT8
*) PeiPcdDb
);
235 InvokeCallbackOnSet (
236 UINT32 ExTokenNumber
,
237 CONST EFI_GUID
*Guid
, OPTIONAL
243 EFI_HOB_GUID_TYPE
*GuidHob
;
244 PCD_PPI_CALLBACK
*CallbackTable
;
248 ASSERT (TokenNumber
< PEI_LOCAL_TOKEN_NUMBER
);
250 GuidHob
= GetFirstGuidHob (&gPcdPeiCallbackFnTableHobGuid
);
251 ASSERT (GuidHob
!= NULL
);
253 CallbackTable
= GET_GUID_HOB_DATA (GuidHob
);
255 CallbackTable
+= (TokenNumber
* FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
));
257 for (Idx
= 0; Idx
< FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
); Idx
++) {
258 if (CallbackTable
[Idx
] != NULL
) {
259 CallbackTable
[Idx
] (Guid
,
260 (Guid
== NULL
)? TokenNumber
: ExTokenNumber
,
274 PCD_TOKEN_NUMBER TokenNumber
,
280 UINT32 LocalTokenNumber
;
281 PEI_PCD_DATABASE
*PeiPcdDb
;
282 UINT16 StringTableIdx
;
286 ASSERT (TokenNumber
< PEI_LOCAL_TOKEN_NUMBER
);
288 PeiPcdDb
= GetPcdDatabase ();
290 LocalTokenNumber
= PeiPcdDb
->Init
.LocalTokenNumberTable
[TokenNumber
];
293 ASSERT (PeiPcdDb
->Init
.SizeTable
[TokenNumber
] >= Size
);
295 ASSERT (PeiPcdDb
->Init
.SizeTable
[TokenNumber
] == Size
);
299 // We only invoke the callback function for Dynamic Type PCD Entry.
300 // For Dynamic EX PCD entry, we have invoked the callback function for Dynamic EX
301 // type PCD entry in ExSetWorker.
303 if (TokenNumber
< PEI_NEX_TOKEN_NUMBER
) {
304 InvokeCallbackOnSet (0, NULL
, TokenNumber
, Data
, Size
);
307 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
308 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, Size
);
311 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
312 InternalData
= (VOID
*) ((UINT8
*) PeiPcdDb
+ Offset
);
314 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
319 return EFI_INVALID_PARAMETER
;
322 case PCD_TYPE_STRING
:
323 StringTableIdx
= *((UINT16
*)InternalData
);
324 CopyMem (&PeiPcdDb
->Init
.StringTable
[StringTableIdx
], Data
, Size
);
331 CopyMem (InternalData
, Data
, Size
);
337 *((UINT8
*) InternalData
) = *((UINT8
*) Data
);
341 *((UINT16
*) InternalData
) = *((UINT16
*) Data
);
345 *((UINT32
*) InternalData
) = *((UINT32
*) Data
);
349 *((UINT64
*) InternalData
) = *((UINT64
*) Data
);
354 return EFI_NOT_FOUND
;
361 return EFI_NOT_FOUND
;
370 IN PCD_TOKEN_NUMBER ExTokenNumber
,
371 IN CONST EFI_GUID
*Guid
,
377 PCD_TOKEN_NUMBER TokenNumber
;
379 TokenNumber
= GetExPcdTokenNumber (Guid
, ExTokenNumber
);
381 InvokeCallbackOnSet (ExTokenNumber
, Guid
, TokenNumber
, Data
, Size
);
383 SetWorker (TokenNumber
, Data
, Size
, PtrType
);
394 IN CONST EFI_GUID
*Guid
,
395 IN PCD_TOKEN_NUMBER ExTokenNumber
,
399 return GetWorker (GetExPcdTokenNumber (Guid
, ExTokenNumber
), GetSize
);
407 PCD_TOKEN_NUMBER TokenNumber
,
414 VARIABLE_HEAD
*VariableHead
;
419 UINT16 StringTableIdx
;
420 PEI_PCD_DATABASE
*PeiPcdDb
;
421 UINT32 LocalTokenNumber
;
424 ASSERT (TokenNumber
< PEI_LOCAL_TOKEN_NUMBER
);
426 Size
= PeiPcdGetSize(TokenNumber
);
428 ASSERT (GetSize
== Size
|| GetSize
== 0);
430 PeiPcdDb
= GetPcdDatabase ();
432 LocalTokenNumber
= PeiPcdDb
->Init
.LocalTokenNumberTable
[TokenNumber
];
434 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
435 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, Size
);
438 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
439 StringTable
= PeiPcdDb
->Init
.StringTable
;
441 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
445 VpdHead
= (VPD_HEAD
*) ((UINT8
*)PeiPcdDb
+ Offset
);
446 return (VOID
*) (FixedPcdGet32(PcdVpdBaseAddress
) + VpdHead
->Offset
);
451 VariableHead
= (VARIABLE_HEAD
*) ((UINT8
*)PeiPcdDb
+ Offset
);
453 Guid
= &(PeiPcdDb
->Init
.GuidTable
[VariableHead
->GuidTableIndex
]);
454 Name
= &StringTable
[VariableHead
->StringIndex
];
456 Status
= GetHiiVariable (Guid
, Name
, &Data
, &DataSize
);
457 ASSERT_EFI_ERROR (Status
);
458 ASSERT (DataSize
>= (UINTN
) (VariableHead
->Offset
+ Size
));
460 return (VOID
*) ((UINT8
*) Data
+ VariableHead
->Offset
);
464 return (VOID
*) ((UINT8
*)PeiPcdDb
+ Offset
);
467 case PCD_TYPE_STRING
:
468 StringTableIdx
= (UINT16
) *((UINT8
*) PeiPcdDb
+ Offset
);
469 return (VOID
*) (&StringTable
[StringTableIdx
]);
485 GetExPcdTokenNumber (
486 IN CONST EFI_GUID
*Guid
,
487 IN UINT32 ExTokenNumber
491 DYNAMICEX_MAPPING
*ExMap
;
495 PEI_PCD_DATABASE
*PeiPcdDb
;
497 PeiPcdDb
= GetPcdDatabase();
499 ExMap
= PeiPcdDb
->Init
.ExMapTable
;
500 GuidTable
= PeiPcdDb
->Init
.GuidTable
;
502 MatchGuid
= ScanGuid (GuidTable
, sizeof(PeiPcdDb
->Init
.GuidTable
), Guid
);
503 ASSERT (MatchGuid
!= NULL
);
505 MatchGuidIdx
= MatchGuid
- GuidTable
;
507 for (i
= 0; i
< PEI_EXMAPPING_TABLE_SIZE
; i
++) {
508 if ((ExTokenNumber
== ExMap
[i
].ExTokenNumber
) &&
509 (MatchGuidIdx
== ExMap
[i
].ExGuidIndex
)) {
510 return ExMap
[i
].LocalTokenNumber
;
526 EFI_HOB_GUID_TYPE
*GuidHob
;
528 GuidHob
= GetFirstGuidHob (&gPcdDataBaseHobGuid
);
529 ASSERT (GuidHob
!= NULL
);
531 return (PEI_PCD_DATABASE
*) GET_GUID_HOB_DATA (GuidHob
);