]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/PCD/Pei/Service.c
Add INF extension Information
[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
cebc8d48 5Copyright (c) 2006 - 2008, 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
60\r
61 //\r
62 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r
63 // We have to decrement TokenNumber by 1 to make it usable\r
64 // as the array index.\r
65 //\r
66 TokenNumber--;\r
67 // EBC compiler is very choosy. It may report warning about comparison\r
68 // between UINTN and 0 . So we add 1 in each size of the \r
69 // comparison.\r
70 ASSERT (TokenNumber + 1 < PEI_LOCAL_TOKEN_NUMBER + 1);\r
71 }\r
72\r
73\r
74 LocalTokenNumber = GetPcdDatabase()->Init.LocalTokenNumberTable[TokenNumber];\r
75\r
76 //\r
77 // We don't support SET for HII and VPD type PCD entry in PEI phase.\r
78 // So we will assert if any register callback for such PCD entry.\r
79 //\r
80 ASSERT ((LocalTokenNumber & PCD_TYPE_HII) == 0);\r
81 ASSERT ((LocalTokenNumber & PCD_TYPE_VPD) == 0);\r
82\r
83 GuidHob = GetFirstGuidHob (&gPcdPeiCallbackFnTableHobGuid);\r
84 ASSERT (GuidHob != NULL);\r
85 \r
86 CallbackTable = GET_GUID_HOB_DATA (GuidHob);\r
87 CallbackTable = CallbackTable + (TokenNumber * FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry));\r
88\r
89 Compare = Register? NULL: CallBackFunction;\r
90 Assign = Register? CallBackFunction: NULL;\r
91\r
92\r
93 for (Idx = 0; Idx < FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry); Idx++) {\r
94 if (CallbackTable[Idx] == Compare) {\r
95 CallbackTable[Idx] = Assign;\r
96 return EFI_SUCCESS;\r
97 }\r
98 }\r
99\r
100 return Register? EFI_OUT_OF_RESOURCES : EFI_NOT_FOUND;\r
101\r
102}\r
103\r
80408db0 104/**\r
105 The function builds the PCD database.\r
fc547e08 106**/\r
80408db0 107VOID\r
108BuildPcdDatabase (\r
109 VOID\r
110 )\r
111{\r
112 PEI_PCD_DATABASE *Database;\r
113 VOID *CallbackFnTable;\r
114 UINTN SizeOfCallbackFnTable;\r
115 \r
116 Database = BuildGuidHob (&gPcdDataBaseHobGuid, sizeof (PEI_PCD_DATABASE));\r
117\r
118 ZeroMem (Database, sizeof (PEI_PCD_DATABASE));\r
119\r
120 //\r
121 // gPEIPcdDbInit is smaller than PEI_PCD_DATABASE\r
122 //\r
123 \r
124 CopyMem (&Database->Init, &gPEIPcdDbInit, sizeof (gPEIPcdDbInit));\r
125\r
126 SizeOfCallbackFnTable = PEI_LOCAL_TOKEN_NUMBER * sizeof (PCD_PPI_CALLBACK) * FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry);\r
127\r
128 CallbackFnTable = BuildGuidHob (&gPcdPeiCallbackFnTableHobGuid, SizeOfCallbackFnTable);\r
129 \r
130 ZeroMem (CallbackFnTable, SizeOfCallbackFnTable);\r
80408db0 131}\r
132\r
80408db0 133/**\r
134 The function is provided by PCD PEIM and PCD DXE driver to\r
135 do the work of reading a HII variable from variable service.\r
136\r
137 @param VariableGuid The Variable GUID.\r
138 @param VariableName The Variable Name.\r
139 @param VariableData The output data.\r
140 @param VariableSize The size of the variable.\r
141\r
142 @retval EFI_SUCCESS Operation successful.\r
143 @retval EFI_NOT_FOUND Variablel not found.\r
fc547e08 144**/\r
80408db0 145EFI_STATUS\r
146GetHiiVariable (\r
147 IN CONST EFI_GUID *VariableGuid,\r
148 IN UINT16 *VariableName,\r
149 OUT VOID **VariableData,\r
150 OUT UINTN *VariableSize\r
151 )\r
152{\r
153 UINTN Size;\r
154 EFI_STATUS Status;\r
155 VOID *Buffer;\r
97a079ed 156 EFI_PEI_READ_ONLY_VARIABLE2_PPI *VariablePpi;\r
80408db0 157\r
97a079ed 158 Status = PeiServicesLocatePpi (&gEfiPeiReadOnlyVariable2PpiGuid, 0, NULL, (VOID **) &VariablePpi);\r
80408db0 159 ASSERT_EFI_ERROR (Status);\r
160\r
161 Size = 0;\r
97a079ed
A
162 Status = VariablePpi->GetVariable (\r
163 VariablePpi,\r
80408db0 164 VariableName,\r
165 (EFI_GUID *) VariableGuid,\r
166 NULL,\r
167 &Size,\r
168 NULL\r
97a079ed 169 );\r
80408db0 170\r
e5618791 171 if (Status == EFI_BUFFER_TOO_SMALL) {\r
80408db0 172 Status = PeiServicesAllocatePool (Size, &Buffer);\r
173 ASSERT_EFI_ERROR (Status);\r
174\r
97a079ed
A
175 Status = VariablePpi->GetVariable (\r
176 VariablePpi,\r
80408db0 177 (UINT16 *) VariableName,\r
178 (EFI_GUID *) VariableGuid,\r
179 NULL,\r
180 &Size,\r
181 Buffer\r
182 );\r
183 ASSERT_EFI_ERROR (Status);\r
184\r
185 *VariableSize = Size;\r
186 *VariableData = Buffer;\r
187\r
188 return EFI_SUCCESS;\r
e5618791 189 }\r
80408db0 190\r
fc547e08 191 return EFI_NOT_FOUND;\r
80408db0 192}\r
193\r
fc547e08 194/**\r
195 Find the local token number according to system SKU ID.\r
196\r
197 @param LocalTokenNumber PCD token number\r
198 @param Size The size of PCD entry.\r
199\r
200 @return Token number according to system SKU ID.\r
201\r
202**/\r
80408db0 203UINT32\r
204GetSkuEnabledTokenNumber (\r
205 UINT32 LocalTokenNumber,\r
206 UINTN Size\r
207 ) \r
208{\r
209 PEI_PCD_DATABASE *PeiPcdDb;\r
210 SKU_HEAD *SkuHead;\r
211 SKU_ID *SkuIdTable;\r
fc547e08 212 INTN Index;\r
80408db0 213 UINT8 *Value;\r
214\r
215 PeiPcdDb = GetPcdDatabase ();\r
216\r
217 ASSERT ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == 0);\r
218\r
219 SkuHead = (SKU_HEAD *) ((UINT8 *)PeiPcdDb + (LocalTokenNumber & PCD_DATABASE_OFFSET_MASK));\r
220 Value = (UINT8 *) ((UINT8 *)PeiPcdDb + (SkuHead->SkuDataStartOffset));\r
221 SkuIdTable = (SKU_ID *) ((UINT8 *)PeiPcdDb + (SkuHead->SkuIdTableOffset));\r
222 \r
fc547e08 223 for (Index = 0; Index < SkuIdTable[0]; Index++) {\r
224 if (PeiPcdDb->Init.SystemSkuId == SkuIdTable[Index + 1]) {\r
80408db0 225 break;\r
226 }\r
227 }\r
228\r
229 switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {\r
230 case PCD_TYPE_VPD:\r
fc547e08 231 Value = (UINT8 *) &(((VPD_HEAD *) Value)[Index]);\r
80408db0 232 return (UINT32) ((Value - (UINT8 *) PeiPcdDb) | PCD_TYPE_VPD);\r
233\r
234 case PCD_TYPE_HII:\r
fc547e08 235 Value = (UINT8 *) &(((VARIABLE_HEAD *) Value)[Index]);\r
80408db0 236 return (UINT32) ((Value - (UINT8 *) PeiPcdDb) | PCD_TYPE_HII);\r
237 \r
238 case PCD_TYPE_STRING:\r
fc547e08 239 Value = (UINT8 *) &(((STRING_HEAD *) Value)[Index]);\r
80408db0 240 return (UINT32) ((Value - (UINT8 *) PeiPcdDb) | PCD_TYPE_STRING);\r
241\r
242 case PCD_TYPE_DATA:\r
fc547e08 243 Value += Size * Index;\r
80408db0 244 return (UINT32) (Value - (UINT8 *) PeiPcdDb);\r
245\r
246 default:\r
247 ASSERT (FALSE);\r
248 }\r
249\r
250 ASSERT (FALSE);\r
251\r
252 return 0;\r
80408db0 253}\r
254\r
fc547e08 255/**\r
256 Invoke the callback function when dynamic PCD entry was set, if this PCD entry \r
257 has registered callback function.\r
80408db0 258\r
fc547e08 259 @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx\r
260 type PCD.\r
261 @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type\r
262 PCD.\r
263 @param TokenNumber PCD token number generated by build tools.\r
264 @param Data Value want to be set for this PCD entry\r
265 @param Size The size of value\r
80408db0 266\r
fc547e08 267**/\r
80408db0 268VOID\r
269InvokeCallbackOnSet (\r
270 UINTN ExTokenNumber,\r
271 CONST EFI_GUID *Guid, OPTIONAL\r
272 UINTN TokenNumber,\r
273 VOID *Data,\r
274 UINTN Size\r
275 )\r
276{\r
277 EFI_HOB_GUID_TYPE *GuidHob;\r
278 PCD_PPI_CALLBACK *CallbackTable;\r
279 UINTN Idx;\r
280\r
281 //\r
282 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r
283 // We have to decrement TokenNumber by 1 to make it usable\r
284 // as the array index.\r
285 //\r
286 TokenNumber--;\r
287 \r
288 if (Guid == NULL) {\r
289 // EBC compiler is very choosy. It may report warning about comparison\r
290 // between UINTN and 0 . So we add 1 in each size of the \r
291 // comparison.\r
292 ASSERT (TokenNumber + 1 < PEI_LOCAL_TOKEN_NUMBER + 1);\r
293 }\r
294\r
295 GuidHob = GetFirstGuidHob (&gPcdPeiCallbackFnTableHobGuid);\r
296 ASSERT (GuidHob != NULL);\r
297 \r
298 CallbackTable = GET_GUID_HOB_DATA (GuidHob);\r
299\r
300 CallbackTable += (TokenNumber * FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry));\r
301\r
302 for (Idx = 0; Idx < FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry); Idx++) {\r
303 if (CallbackTable[Idx] != NULL) {\r
304 CallbackTable[Idx] (Guid,\r
305 (Guid == NULL)? TokenNumber: ExTokenNumber,\r
306 Data,\r
307 Size\r
308 );\r
309 }\r
310 }\r
80408db0 311}\r
312\r
fc547e08 313/**\r
314 Wrapper function for setting non-pointer type value for a PCD entry.\r
315\r
316 @param TokenNumber Pcd token number autogenerated by build tools.\r
317 @param Data Value want to be set for PCD entry\r
318 @param Size Size of value.\r
80408db0 319\r
fc547e08 320 @return status of SetWorker.\r
80408db0 321\r
fc547e08 322**/\r
80408db0 323EFI_STATUS\r
324SetValueWorker (\r
325 IN UINTN TokenNumber,\r
326 IN VOID *Data,\r
327 IN UINTN Size\r
328 )\r
329{\r
330 return SetWorker (TokenNumber, Data, &Size, FALSE);\r
331}\r
332\r
fc547e08 333/**\r
334 Set value for an PCD entry\r
335\r
336 @param TokenNumber Pcd token number autogenerated by build tools.\r
337 @param Data Value want to be set for PCD entry\r
338 @param Size Size of value.\r
339 @param PtrType If TRUE, the type of PCD entry's value is Pointer.\r
340 If False, the type of PCD entry's value is not Pointer.\r
341\r
342 @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.\r
343 @retval EFI_INVALID_PARAMETER If Size can not be set to size table.\r
344 @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in\r
345 range of UINT8, UINT16, UINT32, UINT64\r
346 @retval EFI_NOT_FOUND Can not find the PCD type according to token number. \r
347**/\r
80408db0 348EFI_STATUS\r
349SetWorker (\r
350 IN UINTN TokenNumber,\r
fc547e08 351 IN VOID *Data,\r
80408db0 352 IN OUT UINTN *Size,\r
353 IN BOOLEAN PtrType\r
354 )\r
355{\r
356 UINT32 LocalTokenNumber;\r
357 PEI_PCD_DATABASE *PeiPcdDb;\r
358 UINT16 StringTableIdx;\r
359 UINTN Offset;\r
360 VOID *InternalData;\r
361 UINTN MaxSize;\r
362\r
363 if (!FeaturePcdGet(PcdPeiPcdDatabaseSetEnabled)) {\r
364 return EFI_UNSUPPORTED;\r
365 }\r
366 \r
367 //\r
368 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r
369 // We have to decrement TokenNumber by 1 to make it usable\r
370 // as the array index.\r
371 //\r
372 TokenNumber--;\r
373\r
374 // EBC compiler is very choosy. It may report warning about comparison\r
375 // between UINTN and 0 . So we add 1 in each size of the \r
376 // comparison.\r
377 ASSERT (TokenNumber + 1 < PEI_LOCAL_TOKEN_NUMBER + 1);\r
378 \r
379 PeiPcdDb = GetPcdDatabase ();\r
380\r
381 LocalTokenNumber = PeiPcdDb->Init.LocalTokenNumberTable[TokenNumber];\r
382\r
383 if (!PtrType) {\r
384 ASSERT (PeiPcdGetSize(TokenNumber + 1) == *Size);\r
385 }\r
386\r
387 //\r
388 // We only invoke the callback function for Dynamic Type PCD Entry.\r
389 // For Dynamic EX PCD entry, we have invoked the callback function for Dynamic EX\r
390 // type PCD entry in ExSetWorker.\r
391 //\r
392 if (TokenNumber + 1 < PEI_NEX_TOKEN_NUMBER + 1) {\r
393 InvokeCallbackOnSet (0, NULL, TokenNumber + 1, Data, *Size);\r
394 }\r
395\r
396 if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == PCD_TYPE_SKU_ENABLED) {\r
397 if (PtrType) {\r
398 MaxSize = GetPtrTypeSize (TokenNumber, &MaxSize, PeiPcdDb);\r
399 } else {\r
400 MaxSize = *Size;\r
401 }\r
402 LocalTokenNumber = GetSkuEnabledTokenNumber (LocalTokenNumber & ~PCD_TYPE_SKU_ENABLED, MaxSize);\r
403 }\r
404\r
405 Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;\r
406 InternalData = (VOID *) ((UINT8 *) PeiPcdDb + Offset);\r
407 \r
408 switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {\r
409 case PCD_TYPE_VPD:\r
410 case PCD_TYPE_HII:\r
411 {\r
412 ASSERT (FALSE);\r
413 return EFI_INVALID_PARAMETER;\r
414 }\r
415\r
416 case PCD_TYPE_STRING:\r
417 if (SetPtrTypeSize (TokenNumber, Size, PeiPcdDb)) {\r
418 StringTableIdx = *((UINT16 *)InternalData);\r
419 CopyMem (&PeiPcdDb->Init.StringTable[StringTableIdx], Data, *Size);\r
420 return EFI_SUCCESS;\r
421 } else {\r
422 return EFI_INVALID_PARAMETER;\r
423 }\r
424\r
425 case PCD_TYPE_DATA:\r
426 {\r
427 if (PtrType) {\r
428 if (SetPtrTypeSize (TokenNumber, Size, PeiPcdDb)) {\r
429 CopyMem (InternalData, Data, *Size);\r
430 return EFI_SUCCESS;\r
431 } else {\r
432 return EFI_INVALID_PARAMETER;\r
433 }\r
434 }\r
435\r
436 switch (*Size) {\r
437 case sizeof(UINT8):\r
438 *((UINT8 *) InternalData) = *((UINT8 *) Data);\r
439 return EFI_SUCCESS;\r
440\r
441 case sizeof(UINT16):\r
442 *((UINT16 *) InternalData) = *((UINT16 *) Data);\r
443 return EFI_SUCCESS;\r
444\r
445 case sizeof(UINT32):\r
446 *((UINT32 *) InternalData) = *((UINT32 *) Data);\r
447 return EFI_SUCCESS;\r
448\r
449 case sizeof(UINT64):\r
450 *((UINT64 *) InternalData) = *((UINT64 *) Data);\r
451 return EFI_SUCCESS;\r
452\r
453 default:\r
454 ASSERT (FALSE);\r
455 return EFI_NOT_FOUND;\r
456 }\r
457 }\r
458 \r
459 }\r
460\r
461 ASSERT (FALSE);\r
462 return EFI_NOT_FOUND;\r
463\r
464}\r
465\r
fc547e08 466/**\r
467 Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.\r
80408db0 468\r
fc547e08 469 @param ExTokenNumber Token number for dynamic-ex PCD.\r
470 @param Guid Token space guid for dynamic-ex PCD.\r
471 @param Data Value want to be set.\r
472 @param SetSize The size of value.\r
80408db0 473\r
fc547e08 474 @return status of ExSetWorker().\r
475\r
476**/\r
80408db0 477EFI_STATUS\r
478ExSetValueWorker (\r
479 IN UINTN ExTokenNumber,\r
480 IN CONST EFI_GUID *Guid,\r
481 IN VOID *Data,\r
482 IN UINTN Size\r
483 )\r
484{\r
485 return ExSetWorker (ExTokenNumber, Guid, Data, &Size, FALSE);\r
486}\r
487\r
fc547e08 488/**\r
489 Set value for a dynamic PCD entry.\r
490 \r
491 This routine find the local token number according to dynamic-ex PCD's token \r
492 space guid and token number firstly, and invoke callback function if this PCD\r
493 entry registered callback function. Finally, invoken general SetWorker to set\r
494 PCD value.\r
495 \r
496 @param ExTokenNumber Dynamic-ex PCD token number.\r
497 @param Guid Token space guid for dynamic-ex PCD.\r
498 @param Data PCD value want to be set\r
499 @param SetSize Size of value.\r
500 @param PtrType If TRUE, this PCD entry is pointer type.\r
501 If FALSE, this PCD entry is not pointer type.\r
80408db0 502\r
fc547e08 503 @return status of SetWorker().\r
80408db0 504\r
fc547e08 505**/\r
80408db0 506EFI_STATUS\r
507ExSetWorker (\r
508 IN UINTN ExTokenNumber,\r
509 IN CONST EFI_GUID *Guid,\r
510 IN VOID *Data,\r
511 IN OUT UINTN *Size,\r
512 IN BOOLEAN PtrType\r
513 )\r
514{\r
515 UINTN TokenNumber;\r
516\r
517 if (!FeaturePcdGet(PcdPeiPcdDatabaseSetEnabled)) {\r
518 return EFI_UNSUPPORTED;\r
519 }\r
520\r
521 TokenNumber = GetExPcdTokenNumber (Guid, ExTokenNumber);\r
522\r
523 InvokeCallbackOnSet (ExTokenNumber, Guid, TokenNumber, Data, *Size);\r
524\r
525 return SetWorker (TokenNumber, Data, Size, PtrType);\r
526\r
527}\r
528\r
fc547e08 529/**\r
530 Wrapper function for get PCD value for dynamic-ex PCD.\r
80408db0 531\r
fc547e08 532 @param Guid Token space guid for dynamic-ex PCD.\r
533 @param ExTokenNumber Token number for dyanmic-ex PCD.\r
534 @param GetSize The size of dynamic-ex PCD value.\r
80408db0 535\r
fc547e08 536 @return PCD entry in PCD database.\r
80408db0 537\r
fc547e08 538**/\r
80408db0 539VOID *\r
540ExGetWorker (\r
541 IN CONST EFI_GUID *Guid,\r
542 IN UINTN ExTokenNumber,\r
543 IN UINTN GetSize\r
544 )\r
545{\r
546 if (!FeaturePcdGet (PcdPeiPcdDatabaseExEnabled)) {\r
547 ASSERT (FALSE);\r
548 return 0;\r
549 }\r
550 \r
551 return GetWorker (GetExPcdTokenNumber (Guid, ExTokenNumber), GetSize);\r
552}\r
553\r
fc547e08 554/**\r
555 Get the PCD entry pointer in PCD database.\r
556 \r
557 This routine will visit PCD database to find the PCD entry according to given\r
558 token number. The given token number is autogened by build tools and it will be \r
559 translated to local token number. Local token number contains PCD's type and \r
560 offset of PCD entry in PCD database.\r
80408db0 561\r
fc547e08 562 @param TokenNumber Token's number, it is autogened by build tools\r
563 @param GetSize The size of token's value\r
80408db0 564\r
fc547e08 565 @return PCD entry pointer in PCD database\r
80408db0 566\r
fc547e08 567**/\r
80408db0 568VOID *\r
569GetWorker (\r
fc547e08 570 IN UINTN TokenNumber,\r
571 IN UINTN GetSize\r
80408db0 572 )\r
573{\r
574 UINT32 Offset;\r
575 EFI_GUID *Guid;\r
576 UINT16 *Name;\r
577 VARIABLE_HEAD *VariableHead;\r
578 EFI_STATUS Status;\r
579 UINTN DataSize;\r
580 VOID *Data;\r
581 UINT16 *StringTable;\r
582 UINT16 StringTableIdx;\r
583 PEI_PCD_DATABASE *PeiPcdDb;\r
584 UINT32 LocalTokenNumber;\r
585 UINTN MaxSize;\r
586\r
587 //\r
588 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r
589 // We have to decrement TokenNumber by 1 to make it usable\r
590 // as the array index.\r
591 //\r
592 TokenNumber--;\r
593\r
594 // EBC compiler is very choosy. It may report warning about comparison\r
595 // between UINTN and 0 . So we add 1 in each size of the \r
596 // comparison.\r
597 ASSERT (TokenNumber + 1 < PEI_LOCAL_TOKEN_NUMBER + 1);\r
598\r
599 ASSERT ((GetSize == PeiPcdGetSize(TokenNumber + 1)) || (GetSize == 0));\r
600\r
601 PeiPcdDb = GetPcdDatabase ();\r
602\r
603 LocalTokenNumber = PeiPcdDb->Init.LocalTokenNumberTable[TokenNumber];\r
604\r
605 if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == PCD_TYPE_SKU_ENABLED) {\r
606 if (GetSize == 0) {\r
607 MaxSize = GetPtrTypeSize (TokenNumber, &MaxSize, PeiPcdDb);\r
608 } else {\r
609 MaxSize = GetSize;\r
610 }\r
611 LocalTokenNumber = GetSkuEnabledTokenNumber (LocalTokenNumber & ~PCD_TYPE_SKU_ENABLED, MaxSize);\r
612 }\r
613\r
614 Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;\r
615 StringTable = PeiPcdDb->Init.StringTable;\r
616 \r
617 switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {\r
618 case PCD_TYPE_VPD:\r
619 {\r
620 VPD_HEAD *VpdHead;\r
621 VpdHead = (VPD_HEAD *) ((UINT8 *)PeiPcdDb + Offset);\r
622 return (VOID *) (UINTN) (FixedPcdGet32(PcdVpdBaseAddress) + VpdHead->Offset);\r
623 }\r
624 \r
625 case PCD_TYPE_HII:\r
626 {\r
627 VariableHead = (VARIABLE_HEAD *) ((UINT8 *)PeiPcdDb + Offset);\r
628 \r
629 Guid = &(PeiPcdDb->Init.GuidTable[VariableHead->GuidTableIndex]);\r
630 Name = &StringTable[VariableHead->StringIndex];\r
631\r
632 Status = GetHiiVariable (Guid, Name, &Data, &DataSize);\r
633\r
634 if (Status == EFI_SUCCESS) {\r
635 return (VOID *) ((UINT8 *) Data + VariableHead->Offset);\r
636 } else {\r
637 //\r
638 // Return the default value specified by Platform Integrator \r
639 //\r
640 return (VOID *) ((UINT8 *) PeiPcdDb + VariableHead->DefaultValueOffset);\r
641 }\r
642 }\r
643\r
644 case PCD_TYPE_DATA:\r
645 return (VOID *) ((UINT8 *)PeiPcdDb + Offset);\r
646\r
647 case PCD_TYPE_STRING:\r
648 StringTableIdx = (UINT16) *((UINT8 *) PeiPcdDb + Offset);\r
649 return (VOID *) (&StringTable[StringTableIdx]);\r
650\r
651 default:\r
652 ASSERT (FALSE);\r
653 break;\r
654 \r
655 }\r
656\r
657 ASSERT (FALSE);\r
658 \r
659 return NULL;\r
660 \r
661}\r
662\r
fc547e08 663/**\r
664 Get local token number according to dynamic-ex PCD's {token space guid:token number}\r
665\r
666 A dynamic-ex type PCD, developer must provide pair of token space guid: token number\r
667 in DEC file. PCD database maintain a mapping table that translate pair of {token\r
668 space guid: token number} to local token number.\r
669 \r
670 @param Guid Token space guid for dynamic-ex PCD entry.\r
671 @param ExTokenNumber EDES_TODO: Add parameter description\r
80408db0 672\r
fc547e08 673 @return local token number for dynamic-ex PCD.\r
80408db0 674\r
fc547e08 675**/\r
80408db0 676UINTN \r
677GetExPcdTokenNumber (\r
678 IN CONST EFI_GUID *Guid,\r
679 IN UINTN ExTokenNumber\r
680 )\r
681{\r
fc547e08 682 UINT32 Index;\r
80408db0 683 DYNAMICEX_MAPPING *ExMap;\r
684 EFI_GUID *GuidTable;\r
685 EFI_GUID *MatchGuid;\r
686 UINTN MatchGuidIdx;\r
687 PEI_PCD_DATABASE *PeiPcdDb;\r
688\r
689 PeiPcdDb = GetPcdDatabase();\r
690 \r
691 ExMap = PeiPcdDb->Init.ExMapTable;\r
692 GuidTable = PeiPcdDb->Init.GuidTable;\r
693\r
694 MatchGuid = ScanGuid (GuidTable, sizeof(PeiPcdDb->Init.GuidTable), Guid);\r
695 //\r
696 // We need to ASSERT here. If GUID can't be found in GuidTable, this is a\r
697 // error in the BUILD system.\r
698 //\r
699 ASSERT (MatchGuid != NULL);\r
700 \r
701 MatchGuidIdx = MatchGuid - GuidTable;\r
702 \r
fc547e08 703 for (Index = 0; Index < PEI_EXMAPPING_TABLE_SIZE; Index++) {\r
704 if ((ExTokenNumber == ExMap[Index].ExTokenNumber) && \r
705 (MatchGuidIdx == ExMap[Index].ExGuidIndex)) {\r
706 return ExMap[Index].LocalTokenNumber;\r
80408db0 707 }\r
708 }\r
709 \r
710 ASSERT (FALSE);\r
711 \r
712 return 0;\r
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