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