]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/PCD/Pei/Service.c
Update HiiDataBase to make sure that the installed StringPackages contains the same...
[mirror_edk2.git] / MdeModulePkg / Universal / PCD / Pei / Service.c
CommitLineData
80408db0 1/** @file\r
5944a83b
LG
2 The driver internal functions are implmented here.\r
3 They build Pei PCD database, and provide access service to PCD database.\r
80408db0 4\r
149fb6d6 5Copyright (c) 2006 - 2010, Intel Corporation\r
80408db0 6All rights reserved. This program and the accompanying materials\r
7are licensed and made available under the terms and conditions of the BSD License\r
8which accompanies this distribution. The full text of the license may be found at\r
9http://opensource.org/licenses/bsd-license.php\r
10\r
11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
80408db0 14**/\r
80408db0 15\r
16#include "Service.h"\r
17\r
18/**\r
19 The function registers the CallBackOnSet fucntion\r
20 according to TokenNumber and EFI_GUID space.\r
21\r
fc547e08 22 @param ExTokenNumber The token number.\r
80408db0 23 @param Guid The GUID space.\r
24 @param CallBackFunction The Callback function to be registered.\r
25 @param Register To register or unregister the callback function.\r
26\r
27 @retval EFI_SUCCESS If the Callback function is registered.\r
28 @retval EFI_NOT_FOUND If the PCD Entry is not found according to Token Number and GUID space.\r
29 @retval EFI_OUT_OF_RESOURCES If the callback function can't be registered because there is not free\r
30 slot left in the CallbackFnTable.\r
fc547e08 31**/\r
80408db0 32EFI_STATUS\r
33PeiRegisterCallBackWorker (\r
34 IN UINTN ExTokenNumber,\r
35 IN CONST EFI_GUID *Guid, OPTIONAL\r
36 IN PCD_PPI_CALLBACK CallBackFunction,\r
37 IN BOOLEAN Register\r
38)\r
39{\r
40 EFI_HOB_GUID_TYPE *GuidHob;\r
41 PCD_PPI_CALLBACK *CallbackTable;\r
42 PCD_PPI_CALLBACK Compare;\r
43 PCD_PPI_CALLBACK Assign;\r
44 UINT32 LocalTokenNumber;\r
45 UINTN TokenNumber;\r
46 UINTN Idx;\r
47\r
48 if (Guid == NULL) {\r
49 TokenNumber = ExTokenNumber;\r
50\r
51 //\r
52 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r
53 // We have to decrement TokenNumber by 1 to make it usable\r
54 // as the array index.\r
55 //\r
56 TokenNumber--;\r
57 ASSERT (TokenNumber + 1 < PEI_NEX_TOKEN_NUMBER + 1);\r
58 } else {\r
59 TokenNumber = GetExPcdTokenNumber (Guid, ExTokenNumber);\r
86714ccd 60 if (TokenNumber == PCD_INVALID_TOKEN_NUMBER) {\r
61 return EFI_NOT_FOUND;\r
62 }\r
63 \r
80408db0 64 //\r
65 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r
66 // We have to decrement TokenNumber by 1 to make it usable\r
67 // as the array index.\r
68 //\r
69 TokenNumber--;\r
70 // EBC compiler is very choosy. It may report warning about comparison\r
71 // between UINTN and 0 . So we add 1 in each size of the \r
72 // comparison.\r
73 ASSERT (TokenNumber + 1 < PEI_LOCAL_TOKEN_NUMBER + 1);\r
74 }\r
75\r
76\r
77 LocalTokenNumber = GetPcdDatabase()->Init.LocalTokenNumberTable[TokenNumber];\r
78\r
79 //\r
80 // We don't support SET for HII and VPD type PCD entry in PEI phase.\r
81 // So we will assert if any register callback for such PCD entry.\r
82 //\r
83 ASSERT ((LocalTokenNumber & PCD_TYPE_HII) == 0);\r
84 ASSERT ((LocalTokenNumber & PCD_TYPE_VPD) == 0);\r
85\r
96cb78a1 86 GuidHob = GetFirstGuidHob (&gEfiCallerIdGuid);\r
80408db0 87 ASSERT (GuidHob != NULL);\r
88 \r
89 CallbackTable = GET_GUID_HOB_DATA (GuidHob);\r
188e4e84 90 CallbackTable = CallbackTable + (TokenNumber * PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry));\r
80408db0 91\r
92 Compare = Register? NULL: CallBackFunction;\r
93 Assign = Register? CallBackFunction: NULL;\r
94\r
95\r
188e4e84 96 for (Idx = 0; Idx < PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry); Idx++) {\r
80408db0 97 if (CallbackTable[Idx] == Compare) {\r
98 CallbackTable[Idx] = Assign;\r
99 return EFI_SUCCESS;\r
100 }\r
101 }\r
102\r
103 return Register? EFI_OUT_OF_RESOURCES : EFI_NOT_FOUND;\r
104\r
105}\r
106\r
80408db0 107/**\r
108 The function builds the PCD database.\r
fc547e08 109**/\r
80408db0 110VOID\r
111BuildPcdDatabase (\r
112 VOID\r
113 )\r
114{\r
115 PEI_PCD_DATABASE *Database;\r
116 VOID *CallbackFnTable;\r
117 UINTN SizeOfCallbackFnTable;\r
118 \r
119 Database = BuildGuidHob (&gPcdDataBaseHobGuid, sizeof (PEI_PCD_DATABASE));\r
120\r
121 ZeroMem (Database, sizeof (PEI_PCD_DATABASE));\r
122\r
123 //\r
124 // gPEIPcdDbInit is smaller than PEI_PCD_DATABASE\r
125 //\r
126 \r
127 CopyMem (&Database->Init, &gPEIPcdDbInit, sizeof (gPEIPcdDbInit));\r
128\r
188e4e84 129 SizeOfCallbackFnTable = PEI_LOCAL_TOKEN_NUMBER * sizeof (PCD_PPI_CALLBACK) * PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry);\r
80408db0 130\r
96cb78a1 131 CallbackFnTable = BuildGuidHob (&gEfiCallerIdGuid, SizeOfCallbackFnTable);\r
80408db0 132 \r
133 ZeroMem (CallbackFnTable, SizeOfCallbackFnTable);\r
80408db0 134}\r
135\r
80408db0 136/**\r
137 The function is provided by PCD PEIM and PCD DXE driver to\r
138 do the work of reading a HII variable from variable service.\r
139\r
140 @param VariableGuid The Variable GUID.\r
141 @param VariableName The Variable Name.\r
142 @param VariableData The output data.\r
143 @param VariableSize The size of the variable.\r
144\r
145 @retval EFI_SUCCESS Operation successful.\r
146 @retval EFI_NOT_FOUND Variablel not found.\r
fc547e08 147**/\r
80408db0 148EFI_STATUS\r
149GetHiiVariable (\r
150 IN CONST EFI_GUID *VariableGuid,\r
151 IN UINT16 *VariableName,\r
152 OUT VOID **VariableData,\r
153 OUT UINTN *VariableSize\r
154 )\r
155{\r
156 UINTN Size;\r
157 EFI_STATUS Status;\r
158 VOID *Buffer;\r
97a079ed 159 EFI_PEI_READ_ONLY_VARIABLE2_PPI *VariablePpi;\r
80408db0 160\r
97a079ed 161 Status = PeiServicesLocatePpi (&gEfiPeiReadOnlyVariable2PpiGuid, 0, NULL, (VOID **) &VariablePpi);\r
80408db0 162 ASSERT_EFI_ERROR (Status);\r
163\r
164 Size = 0;\r
97a079ed
A
165 Status = VariablePpi->GetVariable (\r
166 VariablePpi,\r
80408db0 167 VariableName,\r
168 (EFI_GUID *) VariableGuid,\r
169 NULL,\r
170 &Size,\r
171 NULL\r
97a079ed 172 );\r
80408db0 173\r
e5618791 174 if (Status == EFI_BUFFER_TOO_SMALL) {\r
80408db0 175 Status = PeiServicesAllocatePool (Size, &Buffer);\r
176 ASSERT_EFI_ERROR (Status);\r
177\r
97a079ed
A
178 Status = VariablePpi->GetVariable (\r
179 VariablePpi,\r
80408db0 180 (UINT16 *) VariableName,\r
181 (EFI_GUID *) VariableGuid,\r
182 NULL,\r
183 &Size,\r
184 Buffer\r
185 );\r
186 ASSERT_EFI_ERROR (Status);\r
187\r
188 *VariableSize = Size;\r
189 *VariableData = Buffer;\r
190\r
191 return EFI_SUCCESS;\r
e5618791 192 }\r
80408db0 193\r
fc547e08 194 return EFI_NOT_FOUND;\r
80408db0 195}\r
196\r
fc547e08 197/**\r
198 Find the local token number according to system SKU ID.\r
199\r
200 @param LocalTokenNumber PCD token number\r
201 @param Size The size of PCD entry.\r
202\r
203 @return Token number according to system SKU ID.\r
204\r
205**/\r
80408db0 206UINT32\r
207GetSkuEnabledTokenNumber (\r
208 UINT32 LocalTokenNumber,\r
209 UINTN Size\r
210 ) \r
211{\r
212 PEI_PCD_DATABASE *PeiPcdDb;\r
213 SKU_HEAD *SkuHead;\r
214 SKU_ID *SkuIdTable;\r
fc547e08 215 INTN Index;\r
80408db0 216 UINT8 *Value;\r
217\r
218 PeiPcdDb = GetPcdDatabase ();\r
219\r
220 ASSERT ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == 0);\r
221\r
222 SkuHead = (SKU_HEAD *) ((UINT8 *)PeiPcdDb + (LocalTokenNumber & PCD_DATABASE_OFFSET_MASK));\r
223 Value = (UINT8 *) ((UINT8 *)PeiPcdDb + (SkuHead->SkuDataStartOffset));\r
224 SkuIdTable = (SKU_ID *) ((UINT8 *)PeiPcdDb + (SkuHead->SkuIdTableOffset));\r
225 \r
fc547e08 226 for (Index = 0; Index < SkuIdTable[0]; Index++) {\r
227 if (PeiPcdDb->Init.SystemSkuId == SkuIdTable[Index + 1]) {\r
80408db0 228 break;\r
229 }\r
230 }\r
231\r
232 switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {\r
233 case PCD_TYPE_VPD:\r
fc547e08 234 Value = (UINT8 *) &(((VPD_HEAD *) Value)[Index]);\r
80408db0 235 return (UINT32) ((Value - (UINT8 *) PeiPcdDb) | PCD_TYPE_VPD);\r
236\r
237 case PCD_TYPE_HII:\r
fc547e08 238 Value = (UINT8 *) &(((VARIABLE_HEAD *) Value)[Index]);\r
80408db0 239 return (UINT32) ((Value - (UINT8 *) PeiPcdDb) | PCD_TYPE_HII);\r
240 \r
241 case PCD_TYPE_STRING:\r
fc547e08 242 Value = (UINT8 *) &(((STRING_HEAD *) Value)[Index]);\r
80408db0 243 return (UINT32) ((Value - (UINT8 *) PeiPcdDb) | PCD_TYPE_STRING);\r
244\r
245 case PCD_TYPE_DATA:\r
fc547e08 246 Value += Size * Index;\r
80408db0 247 return (UINT32) (Value - (UINT8 *) PeiPcdDb);\r
248\r
249 default:\r
250 ASSERT (FALSE);\r
251 }\r
252\r
253 ASSERT (FALSE);\r
254\r
255 return 0;\r
80408db0 256}\r
257\r
fc547e08 258/**\r
259 Invoke the callback function when dynamic PCD entry was set, if this PCD entry \r
260 has registered callback function.\r
80408db0 261\r
fc547e08 262 @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx\r
263 type PCD.\r
264 @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type\r
265 PCD.\r
266 @param TokenNumber PCD token number generated by build tools.\r
267 @param Data Value want to be set for this PCD entry\r
268 @param Size The size of value\r
80408db0 269\r
fc547e08 270**/\r
80408db0 271VOID\r
272InvokeCallbackOnSet (\r
273 UINTN ExTokenNumber,\r
274 CONST EFI_GUID *Guid, OPTIONAL\r
275 UINTN TokenNumber,\r
276 VOID *Data,\r
277 UINTN Size\r
278 )\r
279{\r
280 EFI_HOB_GUID_TYPE *GuidHob;\r
281 PCD_PPI_CALLBACK *CallbackTable;\r
282 UINTN Idx;\r
283\r
284 //\r
285 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r
286 // We have to decrement TokenNumber by 1 to make it usable\r
287 // as the array index.\r
288 //\r
289 TokenNumber--;\r
290 \r
291 if (Guid == NULL) {\r
292 // EBC compiler is very choosy. It may report warning about comparison\r
293 // between UINTN and 0 . So we add 1 in each size of the \r
294 // comparison.\r
295 ASSERT (TokenNumber + 1 < PEI_LOCAL_TOKEN_NUMBER + 1);\r
296 }\r
297\r
96cb78a1 298 GuidHob = GetFirstGuidHob (&gEfiCallerIdGuid);\r
80408db0 299 ASSERT (GuidHob != NULL);\r
300 \r
301 CallbackTable = GET_GUID_HOB_DATA (GuidHob);\r
302\r
188e4e84 303 CallbackTable += (TokenNumber * PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry));\r
80408db0 304\r
188e4e84 305 for (Idx = 0; Idx < PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry); Idx++) {\r
80408db0 306 if (CallbackTable[Idx] != NULL) {\r
307 CallbackTable[Idx] (Guid,\r
736c5dd5 308 (Guid == NULL) ? (TokenNumber + 1) : ExTokenNumber,\r
80408db0 309 Data,\r
310 Size\r
311 );\r
312 }\r
313 }\r
80408db0 314}\r
315\r
fc547e08 316/**\r
317 Wrapper function for setting non-pointer type value for a PCD entry.\r
318\r
319 @param TokenNumber Pcd token number autogenerated by build tools.\r
320 @param Data Value want to be set for PCD entry\r
321 @param Size Size of value.\r
80408db0 322\r
fc547e08 323 @return status of SetWorker.\r
80408db0 324\r
fc547e08 325**/\r
80408db0 326EFI_STATUS\r
327SetValueWorker (\r
328 IN UINTN TokenNumber,\r
329 IN VOID *Data,\r
330 IN UINTN Size\r
331 )\r
332{\r
333 return SetWorker (TokenNumber, Data, &Size, FALSE);\r
334}\r
335\r
fc547e08 336/**\r
337 Set value for an PCD entry\r
338\r
339 @param TokenNumber Pcd token number autogenerated by build tools.\r
340 @param Data Value want to be set for PCD entry\r
341 @param Size Size of value.\r
342 @param PtrType If TRUE, the type of PCD entry's value is Pointer.\r
343 If False, the type of PCD entry's value is not Pointer.\r
344\r
345 @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.\r
346 @retval EFI_INVALID_PARAMETER If Size can not be set to size table.\r
149fb6d6 347 @retval EFI_INVALID_PARAMETER If Size of non-Ptr type PCD does not match the size information in PCD database.\r
fc547e08 348 @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in\r
349 range of UINT8, UINT16, UINT32, UINT64\r
350 @retval EFI_NOT_FOUND Can not find the PCD type according to token number. \r
351**/\r
80408db0 352EFI_STATUS\r
353SetWorker (\r
354 IN UINTN TokenNumber,\r
fc547e08 355 IN VOID *Data,\r
80408db0 356 IN OUT UINTN *Size,\r
357 IN BOOLEAN PtrType\r
358 )\r
359{\r
360 UINT32 LocalTokenNumber;\r
361 PEI_PCD_DATABASE *PeiPcdDb;\r
362 UINT16 StringTableIdx;\r
363 UINTN Offset;\r
364 VOID *InternalData;\r
365 UINTN MaxSize;\r
366\r
f806dd27 367 if (!FeaturePcdGet(PcdPeiFullPcdDatabaseEnable)) {\r
80408db0 368 return EFI_UNSUPPORTED;\r
369 }\r
370 \r
371 //\r
372 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r
373 // We have to decrement TokenNumber by 1 to make it usable\r
374 // as the array index.\r
375 //\r
376 TokenNumber--;\r
377\r
378 // EBC compiler is very choosy. It may report warning about comparison\r
379 // between UINTN and 0 . So we add 1 in each size of the \r
380 // comparison.\r
381 ASSERT (TokenNumber + 1 < PEI_LOCAL_TOKEN_NUMBER + 1);\r
382 \r
383 PeiPcdDb = GetPcdDatabase ();\r
384\r
385 LocalTokenNumber = PeiPcdDb->Init.LocalTokenNumberTable[TokenNumber];\r
386\r
149fb6d6 387 if ((!PtrType) && (PeiPcdGetSize(TokenNumber + 1) != *Size)) {\r
388 return EFI_INVALID_PARAMETER;\r
80408db0 389 }\r
390\r
391 //\r
392 // We only invoke the callback function for Dynamic Type PCD Entry.\r
393 // For Dynamic EX PCD entry, we have invoked the callback function for Dynamic EX\r
394 // type PCD entry in ExSetWorker.\r
395 //\r
396 if (TokenNumber + 1 < PEI_NEX_TOKEN_NUMBER + 1) {\r
397 InvokeCallbackOnSet (0, NULL, TokenNumber + 1, Data, *Size);\r
398 }\r
399\r
400 if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == PCD_TYPE_SKU_ENABLED) {\r
401 if (PtrType) {\r
402 MaxSize = GetPtrTypeSize (TokenNumber, &MaxSize, PeiPcdDb);\r
403 } else {\r
404 MaxSize = *Size;\r
405 }\r
406 LocalTokenNumber = GetSkuEnabledTokenNumber (LocalTokenNumber & ~PCD_TYPE_SKU_ENABLED, MaxSize);\r
407 }\r
408\r
409 Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;\r
410 InternalData = (VOID *) ((UINT8 *) PeiPcdDb + Offset);\r
411 \r
412 switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {\r
413 case PCD_TYPE_VPD:\r
414 case PCD_TYPE_HII:\r
415 {\r
416 ASSERT (FALSE);\r
417 return EFI_INVALID_PARAMETER;\r
418 }\r
419\r
420 case PCD_TYPE_STRING:\r
421 if (SetPtrTypeSize (TokenNumber, Size, PeiPcdDb)) {\r
422 StringTableIdx = *((UINT16 *)InternalData);\r
423 CopyMem (&PeiPcdDb->Init.StringTable[StringTableIdx], Data, *Size);\r
424 return EFI_SUCCESS;\r
425 } else {\r
426 return EFI_INVALID_PARAMETER;\r
427 }\r
428\r
429 case PCD_TYPE_DATA:\r
430 {\r
431 if (PtrType) {\r
432 if (SetPtrTypeSize (TokenNumber, Size, PeiPcdDb)) {\r
433 CopyMem (InternalData, Data, *Size);\r
434 return EFI_SUCCESS;\r
435 } else {\r
436 return EFI_INVALID_PARAMETER;\r
437 }\r
438 }\r
439\r
440 switch (*Size) {\r
441 case sizeof(UINT8):\r
442 *((UINT8 *) InternalData) = *((UINT8 *) Data);\r
443 return EFI_SUCCESS;\r
444\r
445 case sizeof(UINT16):\r
446 *((UINT16 *) InternalData) = *((UINT16 *) Data);\r
447 return EFI_SUCCESS;\r
448\r
449 case sizeof(UINT32):\r
450 *((UINT32 *) InternalData) = *((UINT32 *) Data);\r
451 return EFI_SUCCESS;\r
452\r
453 case sizeof(UINT64):\r
454 *((UINT64 *) InternalData) = *((UINT64 *) Data);\r
455 return EFI_SUCCESS;\r
456\r
457 default:\r
458 ASSERT (FALSE);\r
459 return EFI_NOT_FOUND;\r
460 }\r
461 }\r
462 \r
463 }\r
464\r
465 ASSERT (FALSE);\r
466 return EFI_NOT_FOUND;\r
467\r
468}\r
469\r
fc547e08 470/**\r
471 Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.\r
80408db0 472\r
fc547e08 473 @param ExTokenNumber Token number for dynamic-ex PCD.\r
474 @param Guid Token space guid for dynamic-ex PCD.\r
475 @param Data Value want to be set.\r
476 @param SetSize The size of value.\r
80408db0 477\r
fc547e08 478 @return status of ExSetWorker().\r
479\r
480**/\r
80408db0 481EFI_STATUS\r
482ExSetValueWorker (\r
483 IN UINTN ExTokenNumber,\r
484 IN CONST EFI_GUID *Guid,\r
485 IN VOID *Data,\r
486 IN UINTN Size\r
487 )\r
488{\r
489 return ExSetWorker (ExTokenNumber, Guid, Data, &Size, FALSE);\r
490}\r
491\r
fc547e08 492/**\r
493 Set value for a dynamic PCD entry.\r
494 \r
495 This routine find the local token number according to dynamic-ex PCD's token \r
496 space guid and token number firstly, and invoke callback function if this PCD\r
497 entry registered callback function. Finally, invoken general SetWorker to set\r
498 PCD value.\r
499 \r
500 @param ExTokenNumber Dynamic-ex PCD token number.\r
501 @param Guid Token space guid for dynamic-ex PCD.\r
502 @param Data PCD value want to be set\r
503 @param SetSize Size of value.\r
504 @param PtrType If TRUE, this PCD entry is pointer type.\r
505 If FALSE, this PCD entry is not pointer type.\r
80408db0 506\r
fc547e08 507 @return status of SetWorker().\r
80408db0 508\r
fc547e08 509**/\r
80408db0 510EFI_STATUS\r
511ExSetWorker (\r
512 IN UINTN ExTokenNumber,\r
513 IN CONST EFI_GUID *Guid,\r
514 IN VOID *Data,\r
515 IN OUT UINTN *Size,\r
516 IN BOOLEAN PtrType\r
517 )\r
518{\r
519 UINTN TokenNumber;\r
520\r
f806dd27 521 if (!FeaturePcdGet(PcdPeiFullPcdDatabaseEnable)) {\r
80408db0 522 return EFI_UNSUPPORTED;\r
523 }\r
524\r
525 TokenNumber = GetExPcdTokenNumber (Guid, ExTokenNumber);\r
86714ccd 526 if (TokenNumber == PCD_INVALID_TOKEN_NUMBER) {\r
527 return EFI_NOT_FOUND;\r
528 }\r
529 \r
80408db0 530 InvokeCallbackOnSet (ExTokenNumber, Guid, TokenNumber, Data, *Size);\r
531\r
532 return SetWorker (TokenNumber, Data, Size, PtrType);\r
533\r
534}\r
535\r
fc547e08 536/**\r
537 Wrapper function for get PCD value for dynamic-ex PCD.\r
80408db0 538\r
fc547e08 539 @param Guid Token space guid for dynamic-ex PCD.\r
540 @param ExTokenNumber Token number for dyanmic-ex PCD.\r
541 @param GetSize The size of dynamic-ex PCD value.\r
80408db0 542\r
fc547e08 543 @return PCD entry in PCD database.\r
80408db0 544\r
fc547e08 545**/\r
80408db0 546VOID *\r
547ExGetWorker (\r
548 IN CONST EFI_GUID *Guid,\r
549 IN UINTN ExTokenNumber,\r
550 IN UINTN GetSize\r
551 )\r
f806dd27 552{ \r
80408db0 553 return GetWorker (GetExPcdTokenNumber (Guid, ExTokenNumber), GetSize);\r
554}\r
555\r
fc547e08 556/**\r
557 Get the PCD entry pointer in PCD database.\r
558 \r
559 This routine will visit PCD database to find the PCD entry according to given\r
560 token number. The given token number is autogened by build tools and it will be \r
561 translated to local token number. Local token number contains PCD's type and \r
562 offset of PCD entry in PCD database.\r
80408db0 563\r
fc547e08 564 @param TokenNumber Token's number, it is autogened by build tools\r
565 @param GetSize The size of token's value\r
80408db0 566\r
fc547e08 567 @return PCD entry pointer in PCD database\r
80408db0 568\r
fc547e08 569**/\r
80408db0 570VOID *\r
571GetWorker (\r
fc547e08 572 IN UINTN TokenNumber,\r
573 IN UINTN GetSize\r
80408db0 574 )\r
575{\r
576 UINT32 Offset;\r
577 EFI_GUID *Guid;\r
578 UINT16 *Name;\r
579 VARIABLE_HEAD *VariableHead;\r
580 EFI_STATUS Status;\r
581 UINTN DataSize;\r
582 VOID *Data;\r
d0965169 583 UINT8 *StringTable;\r
80408db0 584 UINT16 StringTableIdx;\r
585 PEI_PCD_DATABASE *PeiPcdDb;\r
586 UINT32 LocalTokenNumber;\r
587 UINTN MaxSize;\r
588\r
589 //\r
590 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r
591 // We have to decrement TokenNumber by 1 to make it usable\r
592 // as the array index.\r
593 //\r
594 TokenNumber--;\r
595\r
596 // EBC compiler is very choosy. It may report warning about comparison\r
597 // between UINTN and 0 . So we add 1 in each size of the \r
598 // comparison.\r
599 ASSERT (TokenNumber + 1 < PEI_LOCAL_TOKEN_NUMBER + 1);\r
600\r
601 ASSERT ((GetSize == PeiPcdGetSize(TokenNumber + 1)) || (GetSize == 0));\r
602\r
603 PeiPcdDb = GetPcdDatabase ();\r
604\r
605 LocalTokenNumber = PeiPcdDb->Init.LocalTokenNumberTable[TokenNumber];\r
606\r
607 if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == PCD_TYPE_SKU_ENABLED) {\r
608 if (GetSize == 0) {\r
609 MaxSize = GetPtrTypeSize (TokenNumber, &MaxSize, PeiPcdDb);\r
610 } else {\r
611 MaxSize = GetSize;\r
612 }\r
613 LocalTokenNumber = GetSkuEnabledTokenNumber (LocalTokenNumber & ~PCD_TYPE_SKU_ENABLED, MaxSize);\r
614 }\r
615\r
616 Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;\r
617 StringTable = PeiPcdDb->Init.StringTable;\r
618 \r
619 switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {\r
620 case PCD_TYPE_VPD:\r
621 {\r
622 VPD_HEAD *VpdHead;\r
623 VpdHead = (VPD_HEAD *) ((UINT8 *)PeiPcdDb + Offset);\r
188e4e84 624 return (VOID *) (UINTN) (PcdGet32 (PcdVpdBaseAddress) + VpdHead->Offset);\r
80408db0 625 }\r
626 \r
627 case PCD_TYPE_HII:\r
628 {\r
629 VariableHead = (VARIABLE_HEAD *) ((UINT8 *)PeiPcdDb + Offset);\r
630 \r
631 Guid = &(PeiPcdDb->Init.GuidTable[VariableHead->GuidTableIndex]);\r
d0965169 632 Name = (UINT16*)&StringTable[VariableHead->StringIndex];\r
80408db0 633\r
634 Status = GetHiiVariable (Guid, Name, &Data, &DataSize);\r
635\r
636 if (Status == EFI_SUCCESS) {\r
637 return (VOID *) ((UINT8 *) Data + VariableHead->Offset);\r
638 } else {\r
639 //\r
640 // Return the default value specified by Platform Integrator \r
641 //\r
642 return (VOID *) ((UINT8 *) PeiPcdDb + VariableHead->DefaultValueOffset);\r
643 }\r
644 }\r
645\r
646 case PCD_TYPE_DATA:\r
647 return (VOID *) ((UINT8 *)PeiPcdDb + Offset);\r
648\r
649 case PCD_TYPE_STRING:\r
2ef9435a 650 StringTableIdx = * (UINT16*) ((UINT8 *) PeiPcdDb + Offset);\r
80408db0 651 return (VOID *) (&StringTable[StringTableIdx]);\r
652\r
653 default:\r
654 ASSERT (FALSE);\r
655 break;\r
656 \r
657 }\r
658\r
659 ASSERT (FALSE);\r
660 \r
661 return NULL;\r
662 \r
663}\r
664\r
fc547e08 665/**\r
666 Get local token number according to dynamic-ex PCD's {token space guid:token number}\r
667\r
668 A dynamic-ex type PCD, developer must provide pair of token space guid: token number\r
669 in DEC file. PCD database maintain a mapping table that translate pair of {token\r
670 space guid: token number} to local token number.\r
671 \r
672 @param Guid Token space guid for dynamic-ex PCD entry.\r
673 @param ExTokenNumber EDES_TODO: Add parameter description\r
80408db0 674\r
fc547e08 675 @return local token number for dynamic-ex PCD.\r
80408db0 676\r
fc547e08 677**/\r
80408db0 678UINTN \r
679GetExPcdTokenNumber (\r
680 IN CONST EFI_GUID *Guid,\r
681 IN UINTN ExTokenNumber\r
682 )\r
683{\r
fc547e08 684 UINT32 Index;\r
80408db0 685 DYNAMICEX_MAPPING *ExMap;\r
686 EFI_GUID *GuidTable;\r
687 EFI_GUID *MatchGuid;\r
688 UINTN MatchGuidIdx;\r
689 PEI_PCD_DATABASE *PeiPcdDb;\r
690\r
691 PeiPcdDb = GetPcdDatabase();\r
692 \r
693 ExMap = PeiPcdDb->Init.ExMapTable;\r
694 GuidTable = PeiPcdDb->Init.GuidTable;\r
695\r
696 MatchGuid = ScanGuid (GuidTable, sizeof(PeiPcdDb->Init.GuidTable), Guid);\r
697 //\r
698 // We need to ASSERT here. If GUID can't be found in GuidTable, this is a\r
699 // error in the BUILD system.\r
700 //\r
701 ASSERT (MatchGuid != NULL);\r
702 \r
703 MatchGuidIdx = MatchGuid - GuidTable;\r
704 \r
fc547e08 705 for (Index = 0; Index < PEI_EXMAPPING_TABLE_SIZE; Index++) {\r
706 if ((ExTokenNumber == ExMap[Index].ExTokenNumber) && \r
707 (MatchGuidIdx == ExMap[Index].ExGuidIndex)) {\r
708 return ExMap[Index].LocalTokenNumber;\r
80408db0 709 }\r
710 }\r
711 \r
86714ccd 712 return PCD_INVALID_TOKEN_NUMBER;\r
80408db0 713}\r
714\r
fc547e08 715/**\r
716 Get PCD database from GUID HOB in PEI phase.\r
80408db0 717\r
fc547e08 718 @return Pointer to PCD database.\r
80408db0 719\r
fc547e08 720**/\r
80408db0 721PEI_PCD_DATABASE *\r
722GetPcdDatabase (\r
723 VOID\r
724 )\r
725{\r
726 EFI_HOB_GUID_TYPE *GuidHob;\r
727\r
728 GuidHob = GetFirstGuidHob (&gPcdDataBaseHobGuid);\r
729 ASSERT (GuidHob != NULL);\r
730 \r
731 return (PEI_PCD_DATABASE *) GET_GUID_HOB_DATA (GuidHob);\r
732}\r
733\r
fc547e08 734/**\r
735 Get SKU ID tabble from PCD database.\r
736\r
737 @param LocalTokenNumberTableIdx Index of local token number in token number table.\r
738 @param Database PCD database.\r
80408db0 739\r
fc547e08 740 @return Pointer to SKU ID array table\r
80408db0 741\r
fc547e08 742**/\r
80408db0 743SKU_ID *\r
744GetSkuIdArray (\r
745 IN UINTN LocalTokenNumberTableIdx,\r
746 IN PEI_PCD_DATABASE *Database\r
747 )\r
748{\r
749 SKU_HEAD *SkuHead;\r
750 UINTN LocalTokenNumber;\r
751\r
752 LocalTokenNumber = Database->Init.LocalTokenNumberTable[LocalTokenNumberTableIdx];\r
753\r
754 ASSERT ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) != 0);\r
755\r
756 SkuHead = (SKU_HEAD *) ((UINT8 *)Database + (LocalTokenNumber & PCD_DATABASE_OFFSET_MASK));\r
757\r
758 return (SKU_ID *) ((UINT8 *)Database + SkuHead->SkuIdTableOffset);\r
759 \r
760}\r
761\r
fc547e08 762/**\r
763 Get index of PCD entry in size table.\r
764\r
765 @param LocalTokenNumberTableIdx Index of this PCD in local token number table.\r
766 @param Database Pointer to PCD database in PEI phase.\r
80408db0 767\r
fc547e08 768 @return index of PCD entry in size table.\r
80408db0 769\r
fc547e08 770**/\r
80408db0 771UINTN\r
772GetSizeTableIndex (\r
773 IN UINTN LocalTokenNumberTableIdx,\r
774 IN PEI_PCD_DATABASE *Database\r
775 )\r
776{\r
fc547e08 777 UINTN Index;\r
80408db0 778 UINTN SizeTableIdx;\r
779 UINTN LocalTokenNumber;\r
780 SKU_ID *SkuIdTable;\r
781 \r
782 SizeTableIdx = 0;\r
783\r
fc547e08 784 for (Index=0; Index<LocalTokenNumberTableIdx; Index++) {\r
785 LocalTokenNumber = Database->Init.LocalTokenNumberTable[Index];\r
80408db0 786\r
787 if ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER) {\r
788 //\r
789 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type \r
790 // PCD entry.\r
791 //\r
fc547e08 792 if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {\r
80408db0 793 //\r
794 // We have only one entry for VPD enabled PCD entry:\r
795 // 1) MAX Size.\r
796 // We consider current size is equal to MAX size.\r
797 //\r
798 SizeTableIdx++;\r
799 } else {\r
800 if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == 0) {\r
801 //\r
802 // We have only two entry for Non-Sku enabled PCD entry:\r
803 // 1) MAX SIZE\r
804 // 2) Current Size\r
805 //\r
806 SizeTableIdx += 2;\r
807 } else {\r
808 //\r
809 // We have these entry for SKU enabled PCD entry\r
810 // 1) MAX SIZE\r
811 // 2) Current Size for each SKU_ID (It is equal to MaxSku).\r
812 //\r
fc547e08 813 SkuIdTable = GetSkuIdArray (Index, Database);\r
80408db0 814 SizeTableIdx += (UINTN)*SkuIdTable + 1;\r
815 }\r
816 }\r
817 }\r
818\r
819 }\r
820\r
821 return SizeTableIdx;\r
822}\r