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
;
46 EX_PCD_ENTRY_ATTRIBUTE Attr
;
49 TokenNumber
= ExTokenNumber
;
50 ASSERT (TokenNumber
< PEI_NEX_TOKEN_NUMBER
);
51 LocalTokenNumber
= GetPcdDatabase()->Init
.LocalTokenNumberTable
[TokenNumber
];
53 GetExPcdTokenAttributes (Guid
, ExTokenNumber
, &Attr
);
54 TokenNumber
= Attr
.TokenNumber
;
55 LocalTokenNumber
= Attr
.LocalTokenNumberAlias
;
58 ASSERT ((LocalTokenNumber
& PCD_TYPE_HII
) == 0);
59 ASSERT ((LocalTokenNumber
& PCD_TYPE_VPD
) == 0);
61 GuidHob
= GetFirstGuidHob (&gPcdPeiCallbackFnTableHobGuid
);
62 ASSERT (GuidHob
!= NULL
);
64 CallbackTable
= GET_GUID_HOB_DATA (GuidHob
);
65 CallbackTable
= CallbackTable
+ (TokenNumber
* FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
));
67 Compare
= Register
? NULL
: CallBackFunction
;
68 Assign
= Register
? CallBackFunction
: NULL
;
71 for (Idx
= 0; Idx
< FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
); Idx
++) {
72 if (CallbackTable
[Idx
] == Compare
) {
73 CallbackTable
[Idx
] = Assign
;
78 return Register
? EFI_OUT_OF_RESOURCES
: EFI_NOT_FOUND
;
86 The function builds the PCD database based on the
87 PCD_IMAGE on the flash.
89 @param[in] PcdImageOnFlash The PCD image on flash.
98 PEI_PCD_DATABASE
*Database
;
99 VOID
*CallbackFnTable
;
100 UINTN SizeOfCallbackFnTable
;
102 Database
= BuildGuidHob (&gPcdDataBaseHobGuid
, sizeof (PEI_PCD_DATABASE
));
104 ZeroMem (Database
, sizeof (PEI_PCD_DATABASE
));
107 // gPEIPcdDbInit is smaller than PEI_PCD_DATABASE
110 CopyMem (&Database
->Init
, &gPEIPcdDbInit
, sizeof (gPEIPcdDbInit
));
112 SizeOfCallbackFnTable
= PEI_LOCAL_TOKEN_NUMBER
* sizeof (PCD_PPI_CALLBACK
) * FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
);
114 CallbackFnTable
= BuildGuidHob (&gPcdPeiCallbackFnTableHobGuid
, SizeOfCallbackFnTable
);
116 ZeroMem (CallbackFnTable
, SizeOfCallbackFnTable
);
124 The function is provided by PCD PEIM and PCD DXE driver to
125 do the work of reading a HII variable from variable service.
127 @param[in] VariableGuid The Variable GUID.
128 @param[in] VariableName The Variable Name.
129 @param[out] VariableData The output data.
130 @param[out] VariableSize The size of the variable.
132 @retval EFI_SUCCESS Operation successful.
133 @retval EFI_SUCCESS Variablel not found.
137 IN CONST EFI_GUID
*VariableGuid
,
138 IN UINT16
*VariableName
,
139 OUT VOID
**VariableData
,
140 OUT UINTN
*VariableSize
146 EFI_PEI_READ_ONLY_VARIABLE_PPI
*VariablePpi
;
148 Status
= PeiCoreLocatePpi (&gEfiPeiReadOnlyVariablePpiGuid
, 0, NULL
, (VOID
**) &VariablePpi
);
149 ASSERT_EFI_ERROR (Status
);
153 Status
= VariablePpi
->PeiGetVariable (
154 GetPeiServicesTablePointer (),
156 (EFI_GUID
*) VariableGuid
,
161 ASSERT (Status
== EFI_BUFFER_TOO_SMALL
);
163 Status
= PeiCoreAllocatePool (Size
, &Buffer
);
164 ASSERT_EFI_ERROR (Status
);
166 Status
= VariablePpi
->PeiGetVariable (
167 GetPeiServicesTablePointer (),
168 (UINT16
*) VariableName
,
169 (EFI_GUID
*) VariableGuid
,
174 ASSERT_EFI_ERROR (Status
);
176 *VariableSize
= Size
;
177 *VariableData
= Buffer
;
184 GetSkuEnabledTokenNumber (
185 UINT32 LocalTokenNumber
,
189 PEI_PCD_DATABASE
*PeiPcdDb
;
195 PeiPcdDb
= GetPcdDatabase ();
197 ASSERT ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == 0);
199 SkuHead
= (SKU_HEAD
*) ((UINT8
*)PeiPcdDb
+ (LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
));
200 Value
= (UINT8
*) ((UINT8
*)PeiPcdDb
+ (SkuHead
->SkuDataStartOffset
));
201 SkuIdTable
= (SKU_ID
*) ((UINT8
*)PeiPcdDb
+ (SkuHead
->SkuIdTableOffset
));
203 for (i
= 0; i
< SkuIdTable
[0]; i
++) {
204 if (PeiPcdDb
->Init
.SystemSkuId
== SkuIdTable
[i
+ 1]) {
209 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
211 Value
+= sizeof(VPD_HEAD
) * i
;
212 return ((Value
- (UINT8
*) PeiPcdDb
) | PCD_TYPE_VPD
);
215 Value
+= sizeof(VARIABLE_HEAD
) * i
;
216 return ((Value
- (UINT8
*) PeiPcdDb
) | PCD_TYPE_HII
);
220 return (Value
- (UINT8
*) PeiPcdDb
);
236 InvokeCallbackOnSet (
237 UINT32 ExTokenNumber
,
238 CONST EFI_GUID
*Guid
, OPTIONAL
244 EFI_HOB_GUID_TYPE
*GuidHob
;
245 PCD_PPI_CALLBACK
*CallbackTable
;
249 ASSERT (TokenNumber
< PEI_LOCAL_TOKEN_NUMBER
);
251 GuidHob
= GetFirstGuidHob (&gPcdPeiCallbackFnTableHobGuid
);
252 ASSERT (GuidHob
!= NULL
);
254 CallbackTable
= GET_GUID_HOB_DATA (GuidHob
);
256 CallbackTable
+= (TokenNumber
* FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
));
258 for (Idx
= 0; Idx
< FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry
); Idx
++) {
259 if (CallbackTable
[Idx
] != NULL
) {
260 CallbackTable
[Idx
] (Guid
,
261 (Guid
== NULL
)? TokenNumber
: ExTokenNumber
,
278 UINT32 LocalTokenNumber
;
279 PEI_PCD_DATABASE
*PeiPcdDb
;
281 ASSERT (TokenNumber
< PEI_LOCAL_TOKEN_NUMBER
);
283 PeiPcdDb
= GetPcdDatabase ();
285 LocalTokenNumber
= PeiPcdDb
->Init
.LocalTokenNumberTable
[TokenNumber
];
288 ASSERT (PeiPcdDb
->Init
.SizeTable
[TokenNumber
] >= Size
);
290 ASSERT (PeiPcdDb
->Init
.SizeTable
[TokenNumber
] == Size
);
293 InvokeCallbackOnSet (0, NULL
, TokenNumber
, Data
, Size
);
295 return SetWorkerByLocalTokenNumber (LocalTokenNumber
, Data
, Size
, PtrType
);
304 IN UINT32 ExTokenNumber
,
305 IN CONST EFI_GUID
*Guid
,
311 PEI_PCD_DATABASE
*PeiPcdDb
;
312 EX_PCD_ENTRY_ATTRIBUTE Attr
;
315 PeiPcdDb
= GetPcdDatabase ();
317 GetExPcdTokenAttributes (Guid
, ExTokenNumber
, &Attr
);
319 ASSERT (!PtrType
&& Attr
.Size
);
321 ASSERT (PtrType
&& Attr
.Size
>= Size
);
323 InvokeCallbackOnSet (ExTokenNumber
, Guid
, Attr
.TokenNumber
, Data
, Size
);
325 SetWorkerByLocalTokenNumber (Attr
.LocalTokenNumberAlias
, Data
, Size
, PtrType
);
335 SetWorkerByLocalTokenNumber (
336 UINT32 LocalTokenNumber
,
342 PEI_PCD_DATABASE
*PeiPcdDb
;
344 UINT16 StringTableIdx
;
349 PeiPcdDb
= GetPcdDatabase ();
350 PeiPcdDbRaw
= (UINT8
*) PeiPcdDb
;
352 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
353 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, Size
);
356 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
357 InternalData
= (VOID
*) (PeiPcdDbRaw
+ Offset
);
359 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
364 return EFI_INVALID_PARAMETER
;
367 case PCD_TYPE_STRING
:
368 StringTableIdx
= *((UINT16
*)InternalData
);
369 CopyMem (&PeiPcdDb
->Init
.StringTable
[StringTableIdx
], Data
, Size
);
376 CopyMem (InternalData
, Data
, Size
);
382 *((UINT8
*) InternalData
) = *((UINT8
*) Data
);
386 *((UINT16
*) InternalData
) = *((UINT16
*) Data
);
390 *((UINT32
*) InternalData
) = *((UINT32
*) Data
);
394 *((UINT64
*) InternalData
) = *((UINT64
*) Data
);
399 return EFI_NOT_FOUND
;
406 return EFI_NOT_FOUND
;
411 GetWorkerByLocalTokenNumber (
412 PEI_PCD_DATABASE
*PeiPcdDb
,
413 UINT32 LocalTokenNumber
,
420 VARIABLE_HEAD
*VariableHead
;
425 UINT16 StringTableIdx
;
427 PeiPcdDb
= GetPcdDatabase ();
429 if ((LocalTokenNumber
& PCD_TYPE_SKU_ENABLED
) == PCD_TYPE_SKU_ENABLED
) {
430 LocalTokenNumber
= GetSkuEnabledTokenNumber (LocalTokenNumber
& ~PCD_TYPE_SKU_ENABLED
, Size
);
433 Offset
= LocalTokenNumber
& PCD_DATABASE_OFFSET_MASK
;
434 StringTable
= PeiPcdDb
->Init
.StringTable
;
436 switch (LocalTokenNumber
& ~PCD_DATABASE_OFFSET_MASK
) {
440 VpdHead
= (VPD_HEAD
*) ((UINT8
*)PeiPcdDb
+ Offset
);
441 return (VOID
*) (FixedPcdGet32(PcdVpdBaseAddress
) + VpdHead
->Offset
);
446 VariableHead
= (VARIABLE_HEAD
*) ((UINT8
*)PeiPcdDb
+ Offset
);
448 Guid
= &(PeiPcdDb
->Init
.GuidTable
[VariableHead
->GuidTableIndex
]);
449 Name
= &StringTable
[VariableHead
->StringIndex
];
451 Status
= GetHiiVariable (Guid
, Name
, &Data
, &DataSize
);
452 ASSERT_EFI_ERROR (Status
);
453 ASSERT (DataSize
>= (UINTN
) (VariableHead
->Offset
+ Size
));
455 return (VOID
*) ((UINT8
*) Data
+ VariableHead
->Offset
);
459 return (VOID
*) ((UINT8
*)PeiPcdDb
+ Offset
);
462 case PCD_TYPE_STRING
:
463 StringTableIdx
= (UINT16
) *((UINT8
*) PeiPcdDb
+ Offset
);
464 return (VOID
*) (&StringTable
[StringTableIdx
]);
481 IN CONST EFI_GUID
*Guid
,
482 IN UINT32 ExTokenNumber
,
486 EX_PCD_ENTRY_ATTRIBUTE Attr
;
488 GetExPcdTokenAttributes (Guid
, ExTokenNumber
, &Attr
);
490 ASSERT ((GetSize
== Attr
.Size
) || (GetSize
== 0));
492 return GetWorkerByLocalTokenNumber (GetPcdDatabase(),
493 Attr
.LocalTokenNumberAlias
,
504 PEI_PCD_DATABASE
*PeiPcdDb
;
506 ASSERT (TokenNumber
< PEI_LOCAL_TOKEN_NUMBER
);
508 ASSERT (GetSize
== PeiPcdGetSize (TokenNumber
) || GetSize
== 0);
510 PeiPcdDb
= GetPcdDatabase ();
512 return GetWorkerByLocalTokenNumber (PeiPcdDb
, PeiPcdDb
->Init
.LocalTokenNumberTable
[TokenNumber
], GetSize
);
517 GetExPcdTokenAttributes (
518 IN CONST EFI_GUID
*Guid
,
519 IN UINT32 ExTokenNumber
,
520 OUT EX_PCD_ENTRY_ATTRIBUTE
*ExAttr
524 DYNAMICEX_MAPPING
*ExMap
;
526 PEI_PCD_DATABASE
*PeiPcdDb
;
528 PeiPcdDb
= GetPcdDatabase();
530 ExMap
= PeiPcdDb
->Init
.ExMapTable
;
531 GuidTable
= PeiPcdDb
->Init
.GuidTable
;
533 for (i
= 0; i
< PEI_EXMAPPING_TABLE_SIZE
; i
++) {
534 if ((ExTokenNumber
== ExMap
[i
].ExTokenNumber
) &&
535 CompareGuid (Guid
, (CONST EFI_GUID
*) &GuidTable
[ExMap
[i
].ExGuidIndex
])) {
536 ExAttr
->TokenNumber
= i
+ PEI_NEX_TOKEN_NUMBER
;
537 ExAttr
->Size
= PeiPcdDb
->Init
.SizeTable
[i
+ PEI_NEX_TOKEN_NUMBER
];
538 ExAttr
->LocalTokenNumberAlias
= ExMap
[i
].LocalTokenNumber
;
554 EFI_HOB_GUID_TYPE
*GuidHob
;
556 GuidHob
= GetFirstGuidHob (&gPcdDataBaseHobGuid
);
557 ASSERT (GuidHob
!= NULL
);
559 return (PEI_PCD_DATABASE
*) GET_GUID_HOB_DATA (GuidHob
);