]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/PCD/Pei/Service.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
MdeModulePkg: Replace BSD License with BSD+Patent License
[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 - 2018, Intel Corporation. All rights reserved.<BR>
6 SPDX-License-Identifier: BSD-2-Clause-Patent
7
8 **/
9
10 #include "Service.h"
11
12 /**
13 Get Local Token Number by Token Number.
14
15 @param[in] Database PCD database.
16 @param[in] TokenNumber The PCD token number.
17
18 @return Local Token Number.
19 **/
20 UINT32
21 GetLocalTokenNumber (
22 IN PEI_PCD_DATABASE *Database,
23 IN UINTN TokenNumber
24 )
25 {
26 UINT32 LocalTokenNumber;
27
28 //
29 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
30 // We have to decrement TokenNumber by 1 to make it usable
31 // as the array index.
32 //
33 TokenNumber--;
34
35 LocalTokenNumber = *((UINT32 *)((UINT8 *)Database + Database->LocalTokenNumberTableOffset) + TokenNumber);
36
37 return LocalTokenNumber;
38 }
39
40 /**
41 Get PCD type by Local Token Number.
42
43 @param[in] LocalTokenNumber The PCD local token number.
44
45 @return PCD type.
46 **/
47 EFI_PCD_TYPE
48 GetPcdType (
49 IN UINT32 LocalTokenNumber
50 )
51 {
52 switch (LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) {
53 case PCD_DATUM_TYPE_POINTER:
54 return EFI_PCD_TYPE_PTR;
55 case PCD_DATUM_TYPE_UINT8:
56 if ((LocalTokenNumber & PCD_DATUM_TYPE_UINT8_BOOLEAN) == PCD_DATUM_TYPE_UINT8_BOOLEAN) {
57 return EFI_PCD_TYPE_BOOL;
58 } else {
59 return EFI_PCD_TYPE_8;
60 }
61 case PCD_DATUM_TYPE_UINT16:
62 return EFI_PCD_TYPE_16;
63 case PCD_DATUM_TYPE_UINT32:
64 return EFI_PCD_TYPE_32;
65 case PCD_DATUM_TYPE_UINT64:
66 return EFI_PCD_TYPE_64;
67 default:
68 ASSERT (FALSE);
69 return EFI_PCD_TYPE_8;
70 }
71 }
72
73 /**
74 Get PCD name.
75
76 @param[in] OnlyTokenSpaceName If TRUE, only need to get the TokenSpaceCName.
77 If FALSE, need to get the full PCD name.
78 @param[in] Database PCD database.
79 @param[in] TokenNumber The PCD token number.
80
81 @return The TokenSpaceCName or full PCD name.
82 **/
83 CHAR8 *
84 GetPcdName (
85 IN BOOLEAN OnlyTokenSpaceName,
86 IN PEI_PCD_DATABASE *Database,
87 IN UINTN TokenNumber
88 )
89 {
90 UINT8 *StringTable;
91 UINTN NameSize;
92 PCD_NAME_INDEX *PcdNameIndex;
93 CHAR8 *TokenSpaceName;
94 CHAR8 *PcdName;
95 CHAR8 *Name;
96
97 //
98 // Return NULL when PCD name table is absent.
99 //
100 if (Database->PcdNameTableOffset == 0) {
101 return NULL;
102 }
103
104 //
105 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
106 // We have to decrement TokenNumber by 1 to make it usable
107 // as the array index.
108 //
109 TokenNumber--;
110
111 StringTable = (UINT8 *) Database + Database->StringTableOffset;
112
113 //
114 // Get the PCD name index.
115 //
116 PcdNameIndex = (PCD_NAME_INDEX *)((UINT8 *) Database + Database->PcdNameTableOffset) + TokenNumber;
117 TokenSpaceName = (CHAR8 *)&StringTable[PcdNameIndex->TokenSpaceCNameIndex];
118 PcdName = (CHAR8 *)&StringTable[PcdNameIndex->PcdCNameIndex];
119
120 if (OnlyTokenSpaceName) {
121 //
122 // Only need to get the TokenSpaceCName.
123 //
124 Name = AllocateCopyPool (AsciiStrSize (TokenSpaceName), TokenSpaceName);
125 } else {
126 //
127 // Need to get the full PCD name.
128 //
129 NameSize = AsciiStrSize (TokenSpaceName) + AsciiStrSize (PcdName);
130 Name = AllocateZeroPool (NameSize);
131 ASSERT (Name != NULL);
132 //
133 // Catenate TokenSpaceCName and PcdCName with a '.' to form the full PCD name.
134 //
135 AsciiStrCatS (Name, NameSize, TokenSpaceName);
136 Name[AsciiStrSize (TokenSpaceName) - sizeof (CHAR8)] = '.';
137 AsciiStrCatS (Name, NameSize, PcdName);
138 }
139
140 return Name;
141 }
142
143 /**
144 Retrieve additional information associated with a PCD token.
145
146 This includes information such as the type of value the TokenNumber is associated with as well as possible
147 human readable name that is associated with the token.
148
149 @param[in] Database PCD database.
150 @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
151 @param[in] TokenNumber The PCD token number.
152 @param[out] PcdInfo The returned information associated with the requested TokenNumber.
153 The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.
154
155 @retval EFI_SUCCESS The PCD information was returned successfully
156 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
157 **/
158 EFI_STATUS
159 ExGetPcdInfo (
160 IN PEI_PCD_DATABASE *Database,
161 IN CONST EFI_GUID *Guid,
162 IN UINTN TokenNumber,
163 OUT EFI_PCD_INFO *PcdInfo
164 )
165 {
166 UINTN GuidTableIdx;
167 EFI_GUID *MatchGuid;
168 EFI_GUID *GuidTable;
169 DYNAMICEX_MAPPING *ExMapTable;
170 UINTN Index;
171 UINT32 LocalTokenNumber;
172
173 GuidTable = (EFI_GUID *)((UINT8 *)Database + Database->GuidTableOffset);
174 MatchGuid = ScanGuid (GuidTable, Database->GuidTableCount * sizeof(EFI_GUID), Guid);
175
176 if (MatchGuid == NULL) {
177 return EFI_NOT_FOUND;
178 }
179
180 GuidTableIdx = MatchGuid - GuidTable;
181
182 ExMapTable = (DYNAMICEX_MAPPING *)((UINT8 *)Database + Database->ExMapTableOffset);
183
184 //
185 // Find the PCD by GuidTableIdx and ExTokenNumber in ExMapTable.
186 //
187 for (Index = 0; Index < Database->ExTokenCount; Index++) {
188 if (ExMapTable[Index].ExGuidIndex == GuidTableIdx) {
189 if (TokenNumber == PCD_INVALID_TOKEN_NUMBER) {
190 //
191 // TokenNumber is 0, follow spec to set PcdType to EFI_PCD_TYPE_8,
192 // PcdSize to 0 and PcdName to the null-terminated ASCII string
193 // associated with the token's namespace Guid.
194 //
195 PcdInfo->PcdType = EFI_PCD_TYPE_8;
196 PcdInfo->PcdSize = 0;
197 //
198 // Here use one representative in the token space to get the TokenSpaceCName.
199 //
200 PcdInfo->PcdName = GetPcdName (TRUE, Database, ExMapTable[Index].TokenNumber);
201 return EFI_SUCCESS;
202 } else if (ExMapTable[Index].ExTokenNumber == TokenNumber) {
203 PcdInfo->PcdSize = PeiPcdGetSize (ExMapTable[Index].TokenNumber);
204 LocalTokenNumber = GetLocalTokenNumber (Database, ExMapTable[Index].TokenNumber);
205 PcdInfo->PcdType = GetPcdType (LocalTokenNumber);
206 PcdInfo->PcdName = GetPcdName (FALSE, Database, ExMapTable[Index].TokenNumber);
207 return EFI_SUCCESS;
208 }
209 }
210 }
211
212 return EFI_NOT_FOUND;
213 }
214
215 /**
216 Retrieve additional information associated with a PCD token.
217
218 This includes information such as the type of value the TokenNumber is associated with as well as possible
219 human readable name that is associated with the token.
220
221 @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
222 @param[in] TokenNumber The PCD token number.
223 @param[out] PcdInfo The returned information associated with the requested TokenNumber.
224 The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.
225
226 @retval EFI_SUCCESS The PCD information was returned successfully.
227 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
228 **/
229 EFI_STATUS
230 PeiGetPcdInfo (
231 IN CONST EFI_GUID *Guid,
232 IN UINTN TokenNumber,
233 OUT EFI_PCD_INFO *PcdInfo
234 )
235 {
236 PEI_PCD_DATABASE *PeiPcdDb;
237 BOOLEAN PeiExMapTableEmpty;
238 UINTN PeiNexTokenNumber;
239 UINT32 LocalTokenNumber;
240
241 ASSERT (PcdInfo != NULL);
242
243 PeiPcdDb = GetPcdDatabase ();
244 PeiNexTokenNumber = PeiPcdDb->LocalTokenCount - PeiPcdDb->ExTokenCount;
245
246 if (PeiPcdDb->ExTokenCount == 0) {
247 PeiExMapTableEmpty = TRUE;
248 } else {
249 PeiExMapTableEmpty = FALSE;
250 }
251
252 if (Guid == NULL) {
253 if (TokenNumber > PeiNexTokenNumber) {
254 return EFI_NOT_FOUND;
255 } else if (TokenNumber == PCD_INVALID_TOKEN_NUMBER) {
256 //
257 // TokenNumber is 0, follow spec to set PcdType to EFI_PCD_TYPE_8,
258 // PcdSize to 0 and PcdName to NULL for default Token Space.
259 //
260 PcdInfo->PcdType = EFI_PCD_TYPE_8;
261 PcdInfo->PcdSize = 0;
262 PcdInfo->PcdName = NULL;
263 } else {
264 PcdInfo->PcdSize = PeiPcdGetSize (TokenNumber);
265 LocalTokenNumber = GetLocalTokenNumber (PeiPcdDb, TokenNumber);
266 PcdInfo->PcdType = GetPcdType (LocalTokenNumber);
267 PcdInfo->PcdName = GetPcdName (FALSE, PeiPcdDb, TokenNumber);
268 }
269 return EFI_SUCCESS;
270 } else {
271 if (PeiExMapTableEmpty) {
272 return EFI_NOT_FOUND;
273 }
274 return ExGetPcdInfo (
275 PeiPcdDb,
276 Guid,
277 TokenNumber,
278 PcdInfo
279 );
280 }
281 }
282
283 /**
284 The function registers the CallBackOnSet fucntion
285 according to TokenNumber and EFI_GUID space.
286
287 @param ExTokenNumber The token number.
288 @param Guid The GUID space.
289 @param CallBackFunction The Callback function to be registered.
290 @param Register To register or unregister the callback function.
291
292 @retval EFI_SUCCESS If the Callback function is registered.
293 @retval EFI_NOT_FOUND If the PCD Entry is not found according to Token Number and GUID space.
294 @retval EFI_OUT_OF_RESOURCES If the callback function can't be registered because there is not free
295 slot left in the CallbackFnTable.
296 @retval EFI_INVALID_PARAMETER If the callback function want to be de-registered can not be found.
297 **/
298 EFI_STATUS
299 PeiRegisterCallBackWorker (
300 IN UINTN ExTokenNumber,
301 IN CONST EFI_GUID *Guid, OPTIONAL
302 IN PCD_PPI_CALLBACK CallBackFunction,
303 IN BOOLEAN Register
304 )
305 {
306 EFI_HOB_GUID_TYPE *GuidHob;
307 PCD_PPI_CALLBACK *CallbackTable;
308 PCD_PPI_CALLBACK Compare;
309 PCD_PPI_CALLBACK Assign;
310 UINT32 LocalTokenNumber;
311 UINT32 LocalTokenCount;
312 UINTN PeiNexTokenNumber;
313 UINTN TokenNumber;
314 UINTN Idx;
315 PEI_PCD_DATABASE *PeiPcdDb;
316
317 PeiPcdDb = GetPcdDatabase();
318 LocalTokenCount = PeiPcdDb->LocalTokenCount;
319 PeiNexTokenNumber = PeiPcdDb->LocalTokenCount - PeiPcdDb->ExTokenCount;
320
321 if (Guid == NULL) {
322 TokenNumber = ExTokenNumber;
323 //
324 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
325 // We have to decrement TokenNumber by 1 to make it usable
326 // as the array index.
327 //
328 TokenNumber--;
329 ASSERT (TokenNumber + 1 < (PeiNexTokenNumber + 1));
330 } else {
331 TokenNumber = GetExPcdTokenNumber (Guid, ExTokenNumber);
332 if (TokenNumber == PCD_INVALID_TOKEN_NUMBER) {
333 return EFI_NOT_FOUND;
334 }
335 //
336 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
337 // We have to decrement TokenNumber by 1 to make it usable
338 // as the array index.
339 //
340 TokenNumber--;
341 // EBC compiler is very choosy. It may report warning about comparison
342 // between UINTN and 0 . So we add 1 in each size of the
343 // comparison.
344 ASSERT ((TokenNumber + 1) < (LocalTokenCount + 1));
345 }
346
347
348 LocalTokenNumber = *((UINT32 *)((UINT8 *)PeiPcdDb + PeiPcdDb->LocalTokenNumberTableOffset) + TokenNumber);
349
350 //
351 // We don't support SET for HII and VPD type PCD entry in PEI phase.
352 // So we will assert if any register callback for such PCD entry.
353 //
354 ASSERT ((LocalTokenNumber & PCD_TYPE_HII) == 0);
355 ASSERT ((LocalTokenNumber & PCD_TYPE_VPD) == 0);
356
357 GuidHob = GetFirstGuidHob (&gEfiCallerIdGuid);
358 ASSERT (GuidHob != NULL);
359
360 CallbackTable = GET_GUID_HOB_DATA (GuidHob);
361 CallbackTable = CallbackTable + (TokenNumber * PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry));
362
363 Compare = Register? NULL: CallBackFunction;
364 Assign = Register? CallBackFunction: NULL;
365
366
367 for (Idx = 0; Idx < PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry); Idx++) {
368 if (CallbackTable[Idx] == Compare) {
369 CallbackTable[Idx] = Assign;
370 return EFI_SUCCESS;
371 }
372 }
373
374 return Register? EFI_OUT_OF_RESOURCES : EFI_INVALID_PARAMETER;
375
376 }
377
378
379 /**
380 Find the Pcd database.
381
382 @param FileHandle Handle of the file the external PCD database binary located.
383
384 @retval The base address of external PCD database binary.
385 @retval NULL Return NULL if not find.
386 **/
387 VOID *
388 LocateExPcdBinary (
389 IN EFI_PEI_FILE_HANDLE FileHandle
390 )
391 {
392 EFI_STATUS Status;
393 VOID *PcdDb;
394
395 PcdDb = NULL;
396
397 ASSERT (FileHandle != NULL);
398
399 Status = PeiServicesFfsFindSectionData (EFI_SECTION_RAW, FileHandle, &PcdDb);
400 ASSERT_EFI_ERROR (Status);
401
402 //
403 // Check the first bytes (Header Signature Guid) and build version.
404 //
405 if (!CompareGuid (PcdDb, &gPcdDataBaseSignatureGuid) ||
406 (((PEI_PCD_DATABASE *) PcdDb)->BuildVersion != PCD_SERVICE_PEIM_VERSION)) {
407 ASSERT (FALSE);
408 }
409 return PcdDb;
410 }
411
412
413 /**
414 The function builds the PCD database.
415
416 @param FileHandle Handle of the file the external PCD database binary located.
417
418 @return Pointer to PCD database.
419 **/
420 PEI_PCD_DATABASE *
421 BuildPcdDatabase (
422 IN EFI_PEI_FILE_HANDLE FileHandle
423 )
424 {
425 PEI_PCD_DATABASE *Database;
426 PEI_PCD_DATABASE *PeiPcdDbBinary;
427 VOID *CallbackFnTable;
428 UINTN SizeOfCallbackFnTable;
429
430 //
431 // Locate the external PCD database binary for one section of current FFS
432 //
433 PeiPcdDbBinary = LocateExPcdBinary (FileHandle);
434
435 ASSERT(PeiPcdDbBinary != NULL);
436
437 Database = BuildGuidHob (&gPcdDataBaseHobGuid, PeiPcdDbBinary->Length + PeiPcdDbBinary->UninitDataBaseSize);
438
439 ZeroMem (Database, PeiPcdDbBinary->Length + PeiPcdDbBinary->UninitDataBaseSize);
440
441 //
442 // PeiPcdDbBinary is smaller than Database
443 //
444 CopyMem (Database, PeiPcdDbBinary, PeiPcdDbBinary->Length);
445
446 SizeOfCallbackFnTable = Database->LocalTokenCount * sizeof (PCD_PPI_CALLBACK) * PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry);
447
448 CallbackFnTable = BuildGuidHob (&gEfiCallerIdGuid, SizeOfCallbackFnTable);
449
450 ZeroMem (CallbackFnTable, SizeOfCallbackFnTable);
451
452 return Database;
453 }
454
455 /**
456 The function is provided by PCD PEIM and PCD DXE driver to
457 do the work of reading a HII variable from variable service.
458
459 @param VariableGuid The Variable GUID.
460 @param VariableName The Variable Name.
461 @param VariableData The output data.
462 @param VariableSize The size of the variable.
463
464 @retval EFI_SUCCESS Operation successful.
465 @retval EFI_NOT_FOUND Variablel not found.
466 **/
467 EFI_STATUS
468 GetHiiVariable (
469 IN CONST EFI_GUID *VariableGuid,
470 IN UINT16 *VariableName,
471 OUT VOID **VariableData,
472 OUT UINTN *VariableSize
473 )
474 {
475 UINTN Size;
476 EFI_STATUS Status;
477 VOID *Buffer;
478 EFI_PEI_READ_ONLY_VARIABLE2_PPI *VariablePpi;
479
480 Status = PeiServicesLocatePpi (&gEfiPeiReadOnlyVariable2PpiGuid, 0, NULL, (VOID **) &VariablePpi);
481 ASSERT_EFI_ERROR (Status);
482
483 Size = 0;
484 Status = VariablePpi->GetVariable (
485 VariablePpi,
486 VariableName,
487 (EFI_GUID *) VariableGuid,
488 NULL,
489 &Size,
490 NULL
491 );
492
493 if (Status == EFI_BUFFER_TOO_SMALL) {
494 Status = PeiServicesAllocatePool (Size, &Buffer);
495 ASSERT_EFI_ERROR (Status);
496
497 Status = VariablePpi->GetVariable (
498 VariablePpi,
499 (UINT16 *) VariableName,
500 (EFI_GUID *) VariableGuid,
501 NULL,
502 &Size,
503 Buffer
504 );
505 ASSERT_EFI_ERROR (Status);
506
507 *VariableSize = Size;
508 *VariableData = Buffer;
509
510 return EFI_SUCCESS;
511 }
512
513 return EFI_NOT_FOUND;
514 }
515
516 /**
517 Invoke the callback function when dynamic PCD entry was set, if this PCD entry
518 has registered callback function.
519
520 @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx
521 type PCD.
522 @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type
523 PCD.
524 @param TokenNumber PCD token number generated by build tools.
525 @param Data Value want to be set for this PCD entry
526 @param Size The size of value
527
528 **/
529 VOID
530 InvokeCallbackOnSet (
531 UINTN ExTokenNumber,
532 CONST EFI_GUID *Guid, OPTIONAL
533 UINTN TokenNumber,
534 VOID *Data,
535 UINTN Size
536 )
537 {
538 EFI_HOB_GUID_TYPE *GuidHob;
539 PCD_PPI_CALLBACK *CallbackTable;
540 UINTN Idx;
541 PEI_PCD_DATABASE *PeiPcdDb;
542 UINT32 LocalTokenCount;
543
544 //
545 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
546 // We have to decrement TokenNumber by 1 to make it usable
547 // as the array index.
548 //
549 TokenNumber--;
550
551 PeiPcdDb = GetPcdDatabase ();
552 LocalTokenCount = PeiPcdDb->LocalTokenCount;
553
554 if (Guid == NULL) {
555 // EBC compiler is very choosy. It may report warning about comparison
556 // between UINTN and 0 . So we add 1 in each size of the
557 // comparison.
558 ASSERT (TokenNumber + 1 < (LocalTokenCount + 1));
559 }
560
561 GuidHob = GetFirstGuidHob (&gEfiCallerIdGuid);
562 ASSERT (GuidHob != NULL);
563
564 CallbackTable = GET_GUID_HOB_DATA (GuidHob);
565
566 CallbackTable += (TokenNumber * PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry));
567
568 for (Idx = 0; Idx < PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry); Idx++) {
569 if (CallbackTable[Idx] != NULL) {
570 CallbackTable[Idx] (Guid,
571 (Guid == NULL) ? (TokenNumber + 1) : ExTokenNumber,
572 Data,
573 Size
574 );
575 }
576 }
577 }
578
579 /**
580 Wrapper function for setting non-pointer type value for a PCD entry.
581
582 @param TokenNumber Pcd token number autogenerated by build tools.
583 @param Data Value want to be set for PCD entry
584 @param Size Size of value.
585
586 @return status of SetWorker.
587
588 **/
589 EFI_STATUS
590 SetValueWorker (
591 IN UINTN TokenNumber,
592 IN VOID *Data,
593 IN UINTN Size
594 )
595 {
596 return SetWorker (TokenNumber, Data, &Size, FALSE);
597 }
598
599 /**
600 Set value for an PCD entry
601
602 @param TokenNumber Pcd token number autogenerated by build tools.
603 @param Data Value want to be set for PCD entry
604 @param Size Size of value.
605 @param PtrType If TRUE, the type of PCD entry's value is Pointer.
606 If False, the type of PCD entry's value is not Pointer.
607
608 @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.
609 @retval EFI_INVALID_PARAMETER If Size can not be set to size table.
610 @retval EFI_INVALID_PARAMETER If Size of non-Ptr type PCD does not match the size information in PCD database.
611 @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in
612 range of UINT8, UINT16, UINT32, UINT64
613 @retval EFI_NOT_FOUND Can not find the PCD type according to token number.
614 **/
615 EFI_STATUS
616 SetWorker (
617 IN UINTN TokenNumber,
618 IN VOID *Data,
619 IN OUT UINTN *Size,
620 IN BOOLEAN PtrType
621 )
622 {
623 UINT32 LocalTokenNumber;
624 UINTN PeiNexTokenNumber;
625 PEI_PCD_DATABASE *PeiPcdDb;
626 STRING_HEAD StringTableIdx;
627 UINTN Offset;
628 VOID *InternalData;
629 UINTN MaxSize;
630 UINT32 LocalTokenCount;
631
632 if (!FeaturePcdGet(PcdPeiFullPcdDatabaseEnable)) {
633 return EFI_UNSUPPORTED;
634 }
635
636 //
637 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
638 // We have to decrement TokenNumber by 1 to make it usable
639 // as the array index.
640 //
641 TokenNumber--;
642 PeiPcdDb = GetPcdDatabase ();
643 LocalTokenCount = PeiPcdDb->LocalTokenCount;
644
645 // EBC compiler is very choosy. It may report warning about comparison
646 // between UINTN and 0 . So we add 1 in each size of the
647 // comparison.
648 ASSERT (TokenNumber + 1 < (LocalTokenCount + 1));
649
650 if (PtrType) {
651 //
652 // Get MaxSize first, then check new size with max buffer size.
653 //
654 GetPtrTypeSize (TokenNumber, &MaxSize, PeiPcdDb);
655 if (*Size > MaxSize) {
656 *Size = MaxSize;
657 return EFI_INVALID_PARAMETER;
658 }
659 } else {
660 if (*Size != PeiPcdGetSize (TokenNumber + 1)) {
661 return EFI_INVALID_PARAMETER;
662 }
663 }
664
665 //
666 // We only invoke the callback function for Dynamic Type PCD Entry.
667 // For Dynamic EX PCD entry, we have invoked the callback function for Dynamic EX
668 // type PCD entry in ExSetWorker.
669 //
670 PeiNexTokenNumber = PeiPcdDb->LocalTokenCount - PeiPcdDb->ExTokenCount;
671 if (TokenNumber + 1 < PeiNexTokenNumber + 1) {
672 InvokeCallbackOnSet (0, NULL, TokenNumber + 1, Data, *Size);
673 }
674
675 LocalTokenNumber = GetLocalTokenNumber (PeiPcdDb, TokenNumber + 1);
676
677 Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;
678 InternalData = (VOID *) ((UINT8 *) PeiPcdDb + Offset);
679
680 switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {
681 case PCD_TYPE_VPD:
682 case PCD_TYPE_HII:
683 case PCD_TYPE_HII|PCD_TYPE_STRING:
684 {
685 ASSERT (FALSE);
686 return EFI_INVALID_PARAMETER;
687 }
688
689 case PCD_TYPE_STRING:
690 if (SetPtrTypeSize (TokenNumber, Size, PeiPcdDb)) {
691 StringTableIdx = *((STRING_HEAD *)InternalData);
692 CopyMem ((UINT8 *)PeiPcdDb + PeiPcdDb->StringTableOffset + StringTableIdx, Data, *Size);
693 return EFI_SUCCESS;
694 } else {
695 return EFI_INVALID_PARAMETER;
696 }
697
698 case PCD_TYPE_DATA:
699 {
700 if (PtrType) {
701 if (SetPtrTypeSize (TokenNumber, Size, PeiPcdDb)) {
702 CopyMem (InternalData, Data, *Size);
703 return EFI_SUCCESS;
704 } else {
705 return EFI_INVALID_PARAMETER;
706 }
707 }
708
709 switch (*Size) {
710 case sizeof(UINT8):
711 *((UINT8 *) InternalData) = *((UINT8 *) Data);
712 return EFI_SUCCESS;
713
714 case sizeof(UINT16):
715 *((UINT16 *) InternalData) = *((UINT16 *) Data);
716 return EFI_SUCCESS;
717
718 case sizeof(UINT32):
719 *((UINT32 *) InternalData) = *((UINT32 *) Data);
720 return EFI_SUCCESS;
721
722 case sizeof(UINT64):
723 *((UINT64 *) InternalData) = *((UINT64 *) Data);
724 return EFI_SUCCESS;
725
726 default:
727 ASSERT (FALSE);
728 return EFI_NOT_FOUND;
729 }
730 }
731
732 }
733
734 ASSERT (FALSE);
735 return EFI_NOT_FOUND;
736
737 }
738
739 /**
740 Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.
741
742 @param ExTokenNumber Token number for dynamic-ex PCD.
743 @param Guid Token space guid for dynamic-ex PCD.
744 @param Data Value want to be set.
745 @param SetSize The size of value.
746
747 @return status of ExSetWorker().
748
749 **/
750 EFI_STATUS
751 ExSetValueWorker (
752 IN UINTN ExTokenNumber,
753 IN CONST EFI_GUID *Guid,
754 IN VOID *Data,
755 IN UINTN Size
756 )
757 {
758 return ExSetWorker (ExTokenNumber, Guid, Data, &Size, FALSE);
759 }
760
761 /**
762 Set value for a dynamic-ex PCD entry.
763
764 This routine find the local token number according to dynamic-ex PCD's token
765 space guid and token number firstly, and invoke callback function if this PCD
766 entry registered callback function. Finally, invoken general SetWorker to set
767 PCD value.
768
769 @param ExTokenNumber Dynamic-ex PCD token number.
770 @param Guid Token space guid for dynamic-ex PCD.
771 @param Data PCD value want to be set
772 @param SetSize Size of value.
773 @param PtrType If TRUE, this PCD entry is pointer type.
774 If FALSE, this PCD entry is not pointer type.
775
776 @return status of SetWorker().
777
778 **/
779 EFI_STATUS
780 ExSetWorker (
781 IN UINTN ExTokenNumber,
782 IN CONST EFI_GUID *Guid,
783 IN VOID *Data,
784 IN OUT UINTN *Size,
785 IN BOOLEAN PtrType
786 )
787 {
788 UINTN TokenNumber;
789
790 if (!FeaturePcdGet(PcdPeiFullPcdDatabaseEnable)) {
791 return EFI_UNSUPPORTED;
792 }
793
794 TokenNumber = GetExPcdTokenNumber (Guid, ExTokenNumber);
795 if (TokenNumber == PCD_INVALID_TOKEN_NUMBER) {
796 return EFI_NOT_FOUND;
797 }
798
799 InvokeCallbackOnSet (ExTokenNumber, Guid, TokenNumber, Data, *Size);
800
801 return SetWorker (TokenNumber, Data, Size, PtrType);
802
803 }
804
805 /**
806 Wrapper function for get PCD value for dynamic-ex PCD.
807
808 @param Guid Token space guid for dynamic-ex PCD.
809 @param ExTokenNumber Token number for dyanmic-ex PCD.
810 @param GetSize The size of dynamic-ex PCD value.
811
812 @return PCD entry in PCD database.
813
814 **/
815 VOID *
816 ExGetWorker (
817 IN CONST EFI_GUID *Guid,
818 IN UINTN ExTokenNumber,
819 IN UINTN GetSize
820 )
821 {
822 return GetWorker (GetExPcdTokenNumber (Guid, ExTokenNumber), GetSize);
823 }
824
825 /**
826 Get the PCD entry pointer in PCD database.
827
828 This routine will visit PCD database to find the PCD entry according to given
829 token number. The given token number is autogened by build tools and it will be
830 translated to local token number. Local token number contains PCD's type and
831 offset of PCD entry in PCD database.
832
833 @param TokenNumber Token's number, it is autogened by build tools
834 @param GetSize The size of token's value
835
836 @return PCD entry pointer in PCD database
837
838 **/
839 VOID *
840 GetWorker (
841 IN UINTN TokenNumber,
842 IN UINTN GetSize
843 )
844 {
845 UINT32 Offset;
846 EFI_GUID *Guid;
847 UINT16 *Name;
848 VARIABLE_HEAD *VariableHead;
849 EFI_STATUS Status;
850 UINTN DataSize;
851 VOID *Data;
852 UINT8 *StringTable;
853 STRING_HEAD StringTableIdx;
854 PEI_PCD_DATABASE *PeiPcdDb;
855 UINT32 LocalTokenNumber;
856 UINT32 LocalTokenCount;
857 UINT8 *VaraiableDefaultBuffer;
858 UINTN VpdBaseAddress;
859
860 //
861 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
862 // We have to decrement TokenNumber by 1 to make it usable
863 // as the array index.
864 //
865 TokenNumber--;
866
867 PeiPcdDb = GetPcdDatabase ();
868 LocalTokenCount = PeiPcdDb->LocalTokenCount;
869
870 // EBC compiler is very choosy. It may report warning about comparison
871 // between UINTN and 0 . So we add 1 in each size of the
872 // comparison.
873 ASSERT (TokenNumber + 1 < (LocalTokenCount + 1));
874
875 ASSERT ((GetSize == PeiPcdGetSize(TokenNumber + 1)) || (GetSize == 0));
876
877 LocalTokenNumber = GetLocalTokenNumber (PeiPcdDb, TokenNumber + 1);
878
879 Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;
880 StringTable = (UINT8 *)PeiPcdDb + PeiPcdDb->StringTableOffset;
881
882 switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {
883 case PCD_TYPE_VPD:
884 {
885 VPD_HEAD *VpdHead;
886 VpdHead = (VPD_HEAD *) ((UINT8 *)PeiPcdDb + Offset);
887
888 //
889 // PcdVpdBaseAddress64 is DynamicEx PCD only. So, PeiPcdGet64Ex() is used to get its value.
890 //
891 VpdBaseAddress = (UINTN) PeiPcdGet64Ex (&gEfiMdeModulePkgTokenSpaceGuid, PcdToken (PcdVpdBaseAddress64));
892 if (VpdBaseAddress == 0) {
893 //
894 // PcdVpdBaseAddress64 is not set, get value from PcdVpdBaseAddress.
895 //
896 VpdBaseAddress = (UINTN) PcdGet32 (PcdVpdBaseAddress);
897 }
898 ASSERT (VpdBaseAddress != 0);
899 return (VOID *)(VpdBaseAddress + VpdHead->Offset);
900 }
901
902 case PCD_TYPE_HII|PCD_TYPE_STRING:
903 case PCD_TYPE_HII:
904 {
905 VariableHead = (VARIABLE_HEAD *) ((UINT8 *)PeiPcdDb + Offset);
906
907 Guid = (EFI_GUID *) ((UINT8 *)PeiPcdDb + PeiPcdDb->GuidTableOffset) + VariableHead->GuidTableIndex;
908 Name = (UINT16*)&StringTable[VariableHead->StringIndex];
909
910 if ((LocalTokenNumber & PCD_TYPE_ALL_SET) == (PCD_TYPE_HII|PCD_TYPE_STRING)) {
911 //
912 // If a HII type PCD's datum type is VOID*, the DefaultValueOffset is the index of
913 // string array in string table.
914 //
915 VaraiableDefaultBuffer = (UINT8 *) &StringTable[*(STRING_HEAD*)((UINT8*) PeiPcdDb + VariableHead->DefaultValueOffset)];
916 } else {
917 VaraiableDefaultBuffer = (UINT8 *) PeiPcdDb + VariableHead->DefaultValueOffset;
918 }
919 Status = GetHiiVariable (Guid, Name, &Data, &DataSize);
920 if ((Status == EFI_SUCCESS) && (DataSize >= (VariableHead->Offset + GetSize))) {
921 if (GetSize == 0) {
922 //
923 // It is a pointer type. So get the MaxSize reserved for
924 // this PCD entry.
925 //
926 GetPtrTypeSize (TokenNumber, &GetSize, PeiPcdDb);
927 if (GetSize > (DataSize - VariableHead->Offset)) {
928 //
929 // Use actual valid size.
930 //
931 GetSize = DataSize - VariableHead->Offset;
932 }
933 }
934 //
935 // If the operation is successful, we copy the data
936 // to the default value buffer in the PCD Database.
937 //
938 CopyMem (VaraiableDefaultBuffer, (UINT8 *) Data + VariableHead->Offset, GetSize);
939 }
940 return (VOID *) VaraiableDefaultBuffer;
941 }
942
943 case PCD_TYPE_DATA:
944 return (VOID *) ((UINT8 *)PeiPcdDb + Offset);
945
946 case PCD_TYPE_STRING:
947 StringTableIdx = * (STRING_HEAD*) ((UINT8 *) PeiPcdDb + Offset);
948 return (VOID *) (&StringTable[StringTableIdx]);
949
950 default:
951 ASSERT (FALSE);
952 break;
953
954 }
955
956 ASSERT (FALSE);
957
958 return NULL;
959
960 }
961
962 /**
963 Get Token Number according to dynamic-ex PCD's {token space guid:token number}
964
965 A dynamic-ex type PCD, developer must provide pair of token space guid: token number
966 in DEC file. PCD database maintain a mapping table that translate pair of {token
967 space guid: token number} to Token Number.
968
969 @param Guid Token space guid for dynamic-ex PCD entry.
970 @param ExTokenNumber Dynamic-ex PCD token number.
971
972 @return Token Number for dynamic-ex PCD.
973
974 **/
975 UINTN
976 GetExPcdTokenNumber (
977 IN CONST EFI_GUID *Guid,
978 IN UINTN ExTokenNumber
979 )
980 {
981 UINT32 Index;
982 DYNAMICEX_MAPPING *ExMap;
983 EFI_GUID *GuidTable;
984 EFI_GUID *MatchGuid;
985 UINTN MatchGuidIdx;
986 PEI_PCD_DATABASE *PeiPcdDb;
987
988 PeiPcdDb = GetPcdDatabase();
989
990 ExMap = (DYNAMICEX_MAPPING *)((UINT8 *)PeiPcdDb + PeiPcdDb->ExMapTableOffset);
991 GuidTable = (EFI_GUID *)((UINT8 *)PeiPcdDb + PeiPcdDb->GuidTableOffset);
992
993 MatchGuid = ScanGuid (GuidTable, PeiPcdDb->GuidTableCount * sizeof(EFI_GUID), Guid);
994 //
995 // We need to ASSERT here. If GUID can't be found in GuidTable, this is a
996 // error in the BUILD system.
997 //
998 ASSERT (MatchGuid != NULL);
999
1000 MatchGuidIdx = MatchGuid - GuidTable;
1001
1002 for (Index = 0; Index < PeiPcdDb->ExTokenCount; Index++) {
1003 if ((ExTokenNumber == ExMap[Index].ExTokenNumber) &&
1004 (MatchGuidIdx == ExMap[Index].ExGuidIndex)) {
1005 return ExMap[Index].TokenNumber;
1006 }
1007 }
1008
1009 return PCD_INVALID_TOKEN_NUMBER;
1010 }
1011
1012 /**
1013 Get PCD database from GUID HOB in PEI phase.
1014
1015 @return Pointer to PCD database.
1016
1017 **/
1018 PEI_PCD_DATABASE *
1019 GetPcdDatabase (
1020 VOID
1021 )
1022 {
1023 EFI_HOB_GUID_TYPE *GuidHob;
1024
1025 GuidHob = GetFirstGuidHob (&gPcdDataBaseHobGuid);
1026 ASSERT (GuidHob != NULL);
1027
1028 return (PEI_PCD_DATABASE *) GET_GUID_HOB_DATA (GuidHob);
1029 }
1030
1031 /**
1032 Get index of PCD entry in size table.
1033
1034 @param LocalTokenNumberTableIdx Index of this PCD in local token number table.
1035 @param Database Pointer to PCD database in PEI phase.
1036
1037 @return index of PCD entry in size table.
1038
1039 **/
1040 UINTN
1041 GetSizeTableIndex (
1042 IN UINTN LocalTokenNumberTableIdx,
1043 IN PEI_PCD_DATABASE *Database
1044 )
1045 {
1046 UINTN Index;
1047 UINTN SizeTableIdx;
1048 UINTN LocalTokenNumber;
1049
1050 SizeTableIdx = 0;
1051
1052 for (Index = 0; Index < LocalTokenNumberTableIdx; Index++) {
1053 LocalTokenNumber = *((UINT32 *)((UINT8 *)Database + Database->LocalTokenNumberTableOffset) + Index);
1054
1055 if ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER) {
1056 //
1057 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1058 // PCD entry.
1059 //
1060 if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {
1061 //
1062 // We have only two entry for VPD enabled PCD entry:
1063 // 1) MAX Size.
1064 // 2) Current Size
1065 // Current size is equal to MAX size.
1066 //
1067 SizeTableIdx += 2;
1068 } else {
1069 //
1070 // We have only two entry for Non-Sku enabled PCD entry:
1071 // 1) MAX SIZE
1072 // 2) Current Size
1073 //
1074 SizeTableIdx += 2;
1075 }
1076 }
1077
1078 }
1079
1080 return SizeTableIdx;
1081 }
EFI Development Kit II mirror for PVE