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