]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/PCD/Dxe/Service.c
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / MdeModulePkg / Universal / PCD / Dxe / Service.c
1 /** @file
2 Help functions used by PCD DXE driver.
3
4 Copyright (c) 2014, Hewlett-Packard Development Company, L.P.<BR>
5 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
6 (C) Copyright 2016-2021 Hewlett Packard Enterprise Development LP<BR>
7 SPDX-License-Identifier: BSD-2-Clause-Patent
8
9 **/
10
11 #include "Service.h"
12 #include <Library/DxeServicesLib.h>
13
14 PCD_DATABASE mPcdDatabase;
15
16 UINT32 mPcdTotalTokenCount;
17 UINT32 mPeiLocalTokenCount;
18 UINT32 mDxeLocalTokenCount;
19 UINT32 mPeiNexTokenCount;
20 UINT32 mDxeNexTokenCount;
21 UINT32 mPeiExMapppingTableSize;
22 UINT32 mDxeExMapppingTableSize;
23 UINT32 mPeiGuidTableSize;
24 UINT32 mDxeGuidTableSize;
25
26 BOOLEAN mPeiExMapTableEmpty;
27 BOOLEAN mDxeExMapTableEmpty;
28 BOOLEAN mPeiDatabaseEmpty;
29
30 LIST_ENTRY *mCallbackFnTable;
31 EFI_GUID **TmpTokenSpaceBuffer;
32 UINTN TmpTokenSpaceBufferCount;
33
34 UINTN mPeiPcdDbSize = 0;
35 PEI_PCD_DATABASE *mPeiPcdDbBinary = NULL;
36 UINTN mDxePcdDbSize = 0;
37 DXE_PCD_DATABASE *mDxePcdDbBinary = NULL;
38
39 /**
40 Get Local Token Number by Token Number.
41
42 @param[in] IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
43 If FALSE, the pcd entry is initialized in DXE phase.
44 @param[in] TokenNumber The PCD token number.
45
46 @return Local Token Number.
47 **/
48 UINT32
49 GetLocalTokenNumber (
50 IN BOOLEAN IsPeiDb,
51 IN UINTN TokenNumber
52 )
53 {
54 UINT32 *LocalTokenNumberTable;
55
56 //
57 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
58 // We have to decrement TokenNumber by 1 to make it usable
59 // as the array index.
60 //
61 TokenNumber--;
62
63 LocalTokenNumberTable = IsPeiDb ? (UINT32 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->LocalTokenNumberTableOffset) :
64 (UINT32 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->LocalTokenNumberTableOffset);
65 TokenNumber = IsPeiDb ? TokenNumber : TokenNumber - mPeiLocalTokenCount;
66
67 return LocalTokenNumberTable[TokenNumber];
68 }
69
70 /**
71 Get PCD type by Local Token Number.
72
73 @param[in] LocalTokenNumber The PCD local token number.
74
75 @return PCD type.
76 **/
77 EFI_PCD_TYPE
78 GetPcdType (
79 IN UINT32 LocalTokenNumber
80 )
81 {
82 switch (LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) {
83 case PCD_DATUM_TYPE_POINTER:
84 return EFI_PCD_TYPE_PTR;
85 case PCD_DATUM_TYPE_UINT8:
86 if ((LocalTokenNumber & PCD_DATUM_TYPE_UINT8_BOOLEAN) == PCD_DATUM_TYPE_UINT8_BOOLEAN) {
87 return EFI_PCD_TYPE_BOOL;
88 } else {
89 return EFI_PCD_TYPE_8;
90 }
91
92 case PCD_DATUM_TYPE_UINT16:
93 return EFI_PCD_TYPE_16;
94 case PCD_DATUM_TYPE_UINT32:
95 return EFI_PCD_TYPE_32;
96 case PCD_DATUM_TYPE_UINT64:
97 return EFI_PCD_TYPE_64;
98 default:
99 ASSERT (FALSE);
100 return EFI_PCD_TYPE_8;
101 }
102 }
103
104 /**
105 Get PCD name.
106
107 @param[in] OnlyTokenSpaceName If TRUE, only need to get the TokenSpaceCName.
108 If FALSE, need to get the full PCD name.
109 @param[in] IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
110 If FALSE, the pcd entry is initialized in DXE phase.
111 @param[in] TokenNumber The PCD token number.
112
113 @return The TokenSpaceCName or full PCD name.
114 **/
115 CHAR8 *
116 GetPcdName (
117 IN BOOLEAN OnlyTokenSpaceName,
118 IN BOOLEAN IsPeiDb,
119 IN UINTN TokenNumber
120 )
121 {
122 PCD_DATABASE_INIT *Database;
123 UINT8 *StringTable;
124 UINTN NameSize;
125 PCD_NAME_INDEX *PcdNameIndex;
126 CHAR8 *TokenSpaceName;
127 CHAR8 *PcdName;
128 CHAR8 *Name;
129
130 //
131 // Return NULL when PCD name table is absent.
132 //
133 if (IsPeiDb) {
134 if (mPcdDatabase.PeiDb->PcdNameTableOffset == 0) {
135 return NULL;
136 }
137 } else {
138 if (mPcdDatabase.DxeDb->PcdNameTableOffset == 0) {
139 return NULL;
140 }
141 }
142
143 //
144 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
145 // We have to decrement TokenNumber by 1 to make it usable
146 // as the array index.
147 //
148 TokenNumber--;
149
150 Database = IsPeiDb ? mPcdDatabase.PeiDb : mPcdDatabase.DxeDb;
151 TokenNumber = IsPeiDb ? TokenNumber : TokenNumber - mPeiLocalTokenCount;
152
153 StringTable = (UINT8 *)Database + Database->StringTableOffset;
154
155 //
156 // Get the PCD name index.
157 //
158 PcdNameIndex = (PCD_NAME_INDEX *)((UINT8 *)Database + Database->PcdNameTableOffset) + TokenNumber;
159 TokenSpaceName = (CHAR8 *)&StringTable[PcdNameIndex->TokenSpaceCNameIndex];
160 PcdName = (CHAR8 *)&StringTable[PcdNameIndex->PcdCNameIndex];
161
162 if (OnlyTokenSpaceName) {
163 //
164 // Only need to get the TokenSpaceCName.
165 //
166 Name = AllocateCopyPool (AsciiStrSize (TokenSpaceName), TokenSpaceName);
167 } else {
168 //
169 // Need to get the full PCD name.
170 //
171 NameSize = AsciiStrSize (TokenSpaceName) + AsciiStrSize (PcdName);
172 Name = AllocateZeroPool (NameSize);
173 ASSERT (Name != NULL);
174 //
175 // Catenate TokenSpaceCName and PcdCName with a '.' to form the full PCD name.
176 //
177 AsciiStrCatS (Name, NameSize, TokenSpaceName);
178 Name[AsciiStrSize (TokenSpaceName) - sizeof (CHAR8)] = '.';
179 AsciiStrCatS (Name, NameSize, PcdName);
180 }
181
182 return Name;
183 }
184
185 /**
186 Retrieve additional information associated with a PCD token.
187
188 This includes information such as the type of value the TokenNumber is associated with as well as possible
189 human readable name that is associated with the token.
190
191 @param[in] IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
192 If FALSE, the pcd entry is initialized in DXE phase.
193 @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
194 @param[in] TokenNumber The PCD token number.
195 @param[out] PcdInfo The returned information associated with the requested TokenNumber.
196 The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.
197
198 @retval EFI_SUCCESS The PCD information was returned successfully
199 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
200 **/
201 EFI_STATUS
202 ExGetPcdInfo (
203 IN BOOLEAN IsPeiDb,
204 IN CONST EFI_GUID *Guid,
205 IN UINTN TokenNumber,
206 OUT EFI_PCD_INFO *PcdInfo
207 )
208 {
209 PCD_DATABASE_INIT *Database;
210 UINTN GuidTableIdx;
211 EFI_GUID *MatchGuid;
212 EFI_GUID *GuidTable;
213 DYNAMICEX_MAPPING *ExMapTable;
214 UINTN Index;
215 UINT32 LocalTokenNumber;
216
217 Database = IsPeiDb ? mPcdDatabase.PeiDb : mPcdDatabase.DxeDb;
218
219 GuidTable = (EFI_GUID *)((UINT8 *)Database + Database->GuidTableOffset);
220 MatchGuid = ScanGuid (GuidTable, Database->GuidTableCount * sizeof (EFI_GUID), Guid);
221
222 if (MatchGuid == NULL) {
223 return EFI_NOT_FOUND;
224 }
225
226 GuidTableIdx = MatchGuid - GuidTable;
227
228 ExMapTable = (DYNAMICEX_MAPPING *)((UINT8 *)Database + Database->ExMapTableOffset);
229
230 //
231 // Find the PCD by GuidTableIdx and ExTokenNumber in ExMapTable.
232 //
233 for (Index = 0; Index < Database->ExTokenCount; Index++) {
234 if (ExMapTable[Index].ExGuidIndex == GuidTableIdx) {
235 if (TokenNumber == PCD_INVALID_TOKEN_NUMBER) {
236 //
237 // TokenNumber is 0, follow spec to set PcdType to EFI_PCD_TYPE_8,
238 // PcdSize to 0 and PcdName to the null-terminated ASCII string
239 // associated with the token's namespace Guid.
240 //
241 PcdInfo->PcdType = EFI_PCD_TYPE_8;
242 PcdInfo->PcdSize = 0;
243 //
244 // Here use one representative in the token space to get the TokenSpaceCName.
245 //
246 PcdInfo->PcdName = GetPcdName (TRUE, IsPeiDb, ExMapTable[Index].TokenNumber);
247 return EFI_SUCCESS;
248 } else if (ExMapTable[Index].ExTokenNumber == TokenNumber) {
249 PcdInfo->PcdSize = DxePcdGetSize (ExMapTable[Index].TokenNumber);
250 LocalTokenNumber = GetLocalTokenNumber (IsPeiDb, ExMapTable[Index].TokenNumber);
251 PcdInfo->PcdType = GetPcdType (LocalTokenNumber);
252 PcdInfo->PcdName = GetPcdName (FALSE, IsPeiDb, ExMapTable[Index].TokenNumber);
253 return EFI_SUCCESS;
254 }
255 }
256 }
257
258 return EFI_NOT_FOUND;
259 }
260
261 /**
262 Retrieve additional information associated with a PCD token.
263
264 This includes information such as the type of value the TokenNumber is associated with as well as possible
265 human readable name that is associated with the token.
266
267 @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
268 @param[in] TokenNumber The PCD token number.
269 @param[out] PcdInfo The returned information associated with the requested TokenNumber.
270 The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.
271
272 @retval EFI_SUCCESS The PCD information was returned successfully.
273 @retval EFI_NOT_FOUND The PCD service could not find the requested token number.
274 **/
275 EFI_STATUS
276 DxeGetPcdInfo (
277 IN CONST EFI_GUID *Guid,
278 IN UINTN TokenNumber,
279 OUT EFI_PCD_INFO *PcdInfo
280 )
281 {
282 EFI_STATUS Status;
283 BOOLEAN PeiExMapTableEmpty;
284 BOOLEAN DxeExMapTableEmpty;
285 UINT32 LocalTokenNumber;
286 BOOLEAN IsPeiDb;
287
288 ASSERT (PcdInfo != NULL);
289
290 Status = EFI_NOT_FOUND;
291 PeiExMapTableEmpty = mPeiExMapTableEmpty;
292 DxeExMapTableEmpty = mDxeExMapTableEmpty;
293
294 if (Guid == NULL) {
295 if (((TokenNumber + 1 > mPeiNexTokenCount + 1) && (TokenNumber + 1 <= mPeiLocalTokenCount + 1)) ||
296 ((TokenNumber + 1 > (mPeiLocalTokenCount + mDxeNexTokenCount + 1))))
297 {
298 return EFI_NOT_FOUND;
299 } else if (TokenNumber == PCD_INVALID_TOKEN_NUMBER) {
300 //
301 // TokenNumber is 0, follow spec to set PcdType to EFI_PCD_TYPE_8,
302 // PcdSize to 0 and PcdName to NULL for default Token Space.
303 //
304 PcdInfo->PcdType = EFI_PCD_TYPE_8;
305 PcdInfo->PcdSize = 0;
306 PcdInfo->PcdName = NULL;
307 } else {
308 PcdInfo->PcdSize = DxePcdGetSize (TokenNumber);
309 IsPeiDb = FALSE;
310 if ((TokenNumber + 1 <= mPeiNexTokenCount + 1)) {
311 IsPeiDb = TRUE;
312 }
313
314 LocalTokenNumber = GetLocalTokenNumber (IsPeiDb, TokenNumber);
315 PcdInfo->PcdType = GetPcdType (LocalTokenNumber);
316 PcdInfo->PcdName = GetPcdName (FALSE, IsPeiDb, TokenNumber);
317 }
318
319 return EFI_SUCCESS;
320 }
321
322 if (PeiExMapTableEmpty && DxeExMapTableEmpty) {
323 return EFI_NOT_FOUND;
324 }
325
326 if (!PeiExMapTableEmpty) {
327 Status = ExGetPcdInfo (
328 TRUE,
329 Guid,
330 TokenNumber,
331 PcdInfo
332 );
333 }
334
335 if (Status == EFI_SUCCESS) {
336 return Status;
337 }
338
339 if (!DxeExMapTableEmpty) {
340 Status = ExGetPcdInfo (
341 FALSE,
342 Guid,
343 TokenNumber,
344 PcdInfo
345 );
346 }
347
348 return Status;
349 }
350
351 /**
352 Get the PCD entry pointer in PCD database.
353
354 This routine will visit PCD database to find the PCD entry according to given
355 token number. The given token number is autogened by build tools and it will be
356 translated to local token number. Local token number contains PCD's type and
357 offset of PCD entry in PCD database.
358
359 @param TokenNumber Token's number, it is autogened by build tools
360 @param GetSize The size of token's value
361
362 @return PCD entry pointer in PCD database
363
364 **/
365 VOID *
366 GetWorker (
367 IN UINTN TokenNumber,
368 IN UINTN GetSize
369 )
370 {
371 EFI_GUID *GuidTable;
372 UINT8 *StringTable;
373 EFI_GUID *Guid;
374 UINT16 *Name;
375 VARIABLE_HEAD *VariableHead;
376 UINT8 *VaraiableDefaultBuffer;
377 UINT8 *Data;
378 VPD_HEAD *VpdHead;
379 UINT8 *PcdDb;
380 VOID *RetPtr;
381 UINTN TmpTokenNumber;
382 UINTN DataSize;
383 EFI_STATUS Status;
384 UINT32 LocalTokenNumber;
385 UINT32 Offset;
386 STRING_HEAD StringTableIdx;
387 BOOLEAN IsPeiDb;
388
389 //
390 // Aquire lock to prevent reentrance from TPL_CALLBACK level
391 //
392 EfiAcquireLock (&mPcdDatabaseLock);
393
394 RetPtr = NULL;
395
396 ASSERT (TokenNumber > 0);
397 //
398 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
399 // We have to decrement TokenNumber by 1 to make it usable
400 // as the array index.
401 //
402 TokenNumber--;
403
404 TmpTokenNumber = TokenNumber;
405
406 //
407 // EBC compiler is very choosy. It may report warning about comparison
408 // between UINTN and 0 . So we add 1 in each size of the
409 // comparison.
410 //
411 ASSERT (TokenNumber + 1 < mPcdTotalTokenCount + 1);
412
413 ASSERT ((GetSize == DxePcdGetSize (TokenNumber + 1)) || (GetSize == 0));
414
415 // EBC compiler is very choosy. It may report warning about comparison
416 // between UINTN and 0 . So we add 1 in each size of the
417 // comparison.
418 IsPeiDb = (BOOLEAN)((TokenNumber + 1 < mPeiLocalTokenCount + 1) ? TRUE : FALSE);
419
420 LocalTokenNumber = GetLocalTokenNumber (IsPeiDb, TokenNumber + 1);
421
422 PcdDb = IsPeiDb ? ((UINT8 *)mPcdDatabase.PeiDb) : ((UINT8 *)mPcdDatabase.DxeDb);
423
424 if (IsPeiDb) {
425 StringTable = (UINT8 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->StringTableOffset);
426 } else {
427 StringTable = (UINT8 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->StringTableOffset);
428 }
429
430 Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;
431
432 switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {
433 case PCD_TYPE_VPD:
434 VpdHead = (VPD_HEAD *)((UINT8 *)PcdDb + Offset);
435 ASSERT (mVpdBaseAddress != 0);
436 RetPtr = (VOID *)(mVpdBaseAddress + VpdHead->Offset);
437
438 break;
439
440 case PCD_TYPE_HII|PCD_TYPE_STRING:
441 case PCD_TYPE_HII:
442 if (IsPeiDb) {
443 GuidTable = (EFI_GUID *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->GuidTableOffset);
444 } else {
445 GuidTable = (EFI_GUID *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->GuidTableOffset);
446 }
447
448 VariableHead = (VARIABLE_HEAD *)(PcdDb + Offset);
449 Guid = GuidTable + VariableHead->GuidTableIndex;
450 Name = (UINT16 *)(StringTable + VariableHead->StringIndex);
451
452 if ((LocalTokenNumber & PCD_TYPE_ALL_SET) == (PCD_TYPE_HII|PCD_TYPE_STRING)) {
453 //
454 // If a HII type PCD's datum type is VOID*, the DefaultValueOffset is the index of
455 // string array in string table.
456 //
457 StringTableIdx = *(STRING_HEAD *)((UINT8 *)PcdDb + VariableHead->DefaultValueOffset);
458 VaraiableDefaultBuffer = (UINT8 *)(StringTable + StringTableIdx);
459 } else {
460 VaraiableDefaultBuffer = (UINT8 *)PcdDb + VariableHead->DefaultValueOffset;
461 }
462
463 Status = GetHiiVariable (Guid, Name, &Data, &DataSize);
464 if (Status == EFI_SUCCESS) {
465 if (DataSize >= (VariableHead->Offset + GetSize)) {
466 if (GetSize == 0) {
467 //
468 // It is a pointer type. So get the MaxSize reserved for
469 // this PCD entry.
470 //
471 GetPtrTypeSize (TmpTokenNumber, &GetSize);
472 if (GetSize > (DataSize - VariableHead->Offset)) {
473 //
474 // Use actual valid size.
475 //
476 GetSize = DataSize - VariableHead->Offset;
477 }
478 }
479
480 //
481 // If the operation is successful, we copy the data
482 // to the default value buffer in the PCD Database.
483 // So that we can free the Data allocated in GetHiiVariable.
484 //
485 CopyMem (VaraiableDefaultBuffer, Data + VariableHead->Offset, GetSize);
486 }
487
488 FreePool (Data);
489 }
490
491 RetPtr = (VOID *)VaraiableDefaultBuffer;
492 break;
493
494 case PCD_TYPE_STRING:
495 StringTableIdx = *(STRING_HEAD *)((UINT8 *)PcdDb + Offset);
496 RetPtr = (VOID *)(StringTable + StringTableIdx);
497 break;
498
499 case PCD_TYPE_DATA:
500 RetPtr = (VOID *)((UINT8 *)PcdDb + Offset);
501 break;
502
503 default:
504 ASSERT (FALSE);
505 break;
506 }
507
508 EfiReleaseLock (&mPcdDatabaseLock);
509
510 return RetPtr;
511 }
512
513 /**
514 Register the callback function for a PCD entry.
515
516 This routine will register a callback function to a PCD entry by given token number
517 and token space guid.
518
519 @param TokenNumber PCD token's number, it is autogened by build tools.
520 @param Guid PCD token space's guid,
521 if not NULL, this PCD is dynamicEx type PCD.
522 @param CallBackFunction Callback function pointer
523
524 @return EFI_SUCCESS Always success for registering callback function.
525
526 **/
527 EFI_STATUS
528 DxeRegisterCallBackWorker (
529 IN UINTN TokenNumber,
530 IN CONST EFI_GUID *Guid OPTIONAL,
531 IN PCD_PROTOCOL_CALLBACK CallBackFunction
532 )
533 {
534 CALLBACK_FN_ENTRY *FnTableEntry;
535 LIST_ENTRY *ListHead;
536 LIST_ENTRY *ListNode;
537
538 if (Guid != NULL) {
539 TokenNumber = GetExPcdTokenNumber (Guid, (UINT32)TokenNumber);
540 }
541
542 //
543 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
544 // We have to decrement TokenNumber by 1 to make it usable
545 // as the array index of mCallbackFnTable[].
546 //
547 ListHead = &mCallbackFnTable[TokenNumber - 1];
548 ListNode = GetFirstNode (ListHead);
549
550 while (ListNode != ListHead) {
551 FnTableEntry = CR_FNENTRY_FROM_LISTNODE (ListNode, CALLBACK_FN_ENTRY, Node);
552
553 if (FnTableEntry->CallbackFn == CallBackFunction) {
554 //
555 // We only allow a Callback function to be register once
556 // for a TokenNumber. So just return EFI_SUCCESS
557 //
558 return EFI_SUCCESS;
559 }
560
561 ListNode = GetNextNode (ListHead, ListNode);
562 }
563
564 FnTableEntry = AllocatePool (sizeof (CALLBACK_FN_ENTRY));
565 ASSERT (FnTableEntry != NULL);
566
567 FnTableEntry->CallbackFn = CallBackFunction;
568 InsertTailList (ListHead, &FnTableEntry->Node);
569
570 return EFI_SUCCESS;
571 }
572
573 /**
574 UnRegister the callback function for a PCD entry.
575
576 This routine will unregister a callback function to a PCD entry by given token number
577 and token space guid.
578
579 @param TokenNumber PCD token's number, it is autogened by build tools.
580 @param Guid PCD token space's guid.
581 if not NULL, this PCD is dynamicEx type PCD.
582 @param CallBackFunction Callback function pointer
583
584 @retval EFI_SUCCESS Callback function is success to be unregister.
585 @retval EFI_INVALID_PARAMETER Can not find the PCD entry by given token number.
586 **/
587 EFI_STATUS
588 DxeUnRegisterCallBackWorker (
589 IN UINTN TokenNumber,
590 IN CONST EFI_GUID *Guid OPTIONAL,
591 IN PCD_PROTOCOL_CALLBACK CallBackFunction
592 )
593 {
594 CALLBACK_FN_ENTRY *FnTableEntry;
595 LIST_ENTRY *ListHead;
596 LIST_ENTRY *ListNode;
597
598 if (Guid != NULL) {
599 TokenNumber = GetExPcdTokenNumber (Guid, (UINT32)TokenNumber);
600 }
601
602 //
603 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
604 // We have to decrement TokenNumber by 1 to make it usable
605 // as the array index of mCallbackFnTable[].
606 //
607 ListHead = &mCallbackFnTable[TokenNumber - 1];
608 ListNode = GetFirstNode (ListHead);
609
610 while (ListNode != ListHead) {
611 FnTableEntry = CR_FNENTRY_FROM_LISTNODE (ListNode, CALLBACK_FN_ENTRY, Node);
612
613 if (FnTableEntry->CallbackFn == CallBackFunction) {
614 //
615 // We only allow a Callback function to be register once
616 // for a TokenNumber. So we can safely remove the Node from
617 // the Link List and return EFI_SUCCESS.
618 //
619 RemoveEntryList (ListNode);
620 FreePool (FnTableEntry);
621
622 return EFI_SUCCESS;
623 }
624
625 ListNode = GetNextNode (ListHead, ListNode);
626 }
627
628 return EFI_INVALID_PARAMETER;
629 }
630
631 /**
632 Get next token number in given token space.
633
634 This routine is used for dynamicEx type PCD. It will firstly scan token space
635 table to get token space according to given token space guid. Then scan given
636 token number in found token space, if found, then return next token number in
637 this token space.
638
639 @param Guid Token space guid. Next token number will be scaned in
640 this token space.
641 @param TokenNumber Token number.
642 If PCD_INVALID_TOKEN_NUMBER, return first token number in
643 token space table.
644 If not PCD_INVALID_TOKEN_NUMBER, return next token number
645 in token space table.
646 @param GuidTable Token space guid table. It will be used for scan token space
647 by given token space guid.
648 @param SizeOfGuidTable The size of guid table.
649 @param ExMapTable DynamicEx token number mapping table.
650 @param SizeOfExMapTable The size of dynamicEx token number mapping table.
651
652 @retval EFI_NOT_FOUND Can not given token space or token number.
653 @retval EFI_SUCCESS Success to get next token number.
654
655 **/
656 EFI_STATUS
657 ExGetNextTokeNumber (
658 IN CONST EFI_GUID *Guid,
659 IN OUT UINTN *TokenNumber,
660 IN EFI_GUID *GuidTable,
661 IN UINTN SizeOfGuidTable,
662 IN DYNAMICEX_MAPPING *ExMapTable,
663 IN UINTN SizeOfExMapTable
664 )
665 {
666 EFI_GUID *MatchGuid;
667 UINTN Index;
668 UINTN GuidTableIdx;
669 BOOLEAN Found;
670 UINTN ExMapTableCount;
671
672 //
673 // Scan token space guid
674 //
675 MatchGuid = ScanGuid (GuidTable, SizeOfGuidTable, Guid);
676 if (MatchGuid == NULL) {
677 return EFI_NOT_FOUND;
678 }
679
680 //
681 // Find the token space table in dynamicEx mapping table.
682 //
683 Found = FALSE;
684 GuidTableIdx = MatchGuid - GuidTable;
685 ExMapTableCount = SizeOfExMapTable / sizeof (ExMapTable[0]);
686 for (Index = 0; Index < ExMapTableCount; Index++) {
687 if (ExMapTable[Index].ExGuidIndex == GuidTableIdx) {
688 Found = TRUE;
689 break;
690 }
691 }
692
693 if (Found) {
694 //
695 // If given token number is PCD_INVALID_TOKEN_NUMBER, then return the first
696 // token number in found token space.
697 //
698 if (*TokenNumber == PCD_INVALID_TOKEN_NUMBER) {
699 *TokenNumber = ExMapTable[Index].ExTokenNumber;
700 return EFI_SUCCESS;
701 }
702
703 for ( ; Index < ExMapTableCount; Index++) {
704 if ((ExMapTable[Index].ExTokenNumber == *TokenNumber) && (ExMapTable[Index].ExGuidIndex == GuidTableIdx)) {
705 break;
706 }
707 }
708
709 while (Index < ExMapTableCount) {
710 Index++;
711 if (Index == ExMapTableCount) {
712 //
713 // Exceed the length of ExMap Table
714 //
715 *TokenNumber = PCD_INVALID_TOKEN_NUMBER;
716 return EFI_NOT_FOUND;
717 } else if (ExMapTable[Index].ExGuidIndex == GuidTableIdx) {
718 //
719 // Found the next match
720 //
721 *TokenNumber = ExMapTable[Index].ExTokenNumber;
722 return EFI_SUCCESS;
723 }
724 }
725 }
726
727 return EFI_NOT_FOUND;
728 }
729
730 /**
731 Find the PCD database.
732
733 @retval The base address of external PCD database binary.
734 @retval NULL Return NULL if not find.
735 **/
736 DXE_PCD_DATABASE *
737 LocateExPcdBinary (
738 VOID
739 )
740 {
741 EFI_STATUS Status;
742
743 //
744 // Search the External Pcd database from one section of current FFS,
745 // and read it to memory
746 //
747 Status = GetSectionFromFfs (
748 EFI_SECTION_RAW,
749 0,
750 (VOID **)&mDxePcdDbBinary,
751 &mDxePcdDbSize
752 );
753 ASSERT_EFI_ERROR (Status);
754
755 //
756 // Check the first bytes (Header Signature Guid) and build version.
757 //
758 if (!CompareGuid ((VOID *)mDxePcdDbBinary, &gPcdDataBaseSignatureGuid) ||
759 (mDxePcdDbBinary->BuildVersion != PCD_SERVICE_DXE_VERSION))
760 {
761 ASSERT (FALSE);
762 }
763
764 return mDxePcdDbBinary;
765 }
766
767 /**
768 Update PCD database base on current SkuId
769
770 @param SkuId Current SkuId
771 @param IsPeiDb Whether to update PEI PCD database.
772
773 @retval EFI_SUCCESS Update PCD database successfully.
774 @retval EFI_NOT_FOUND Not found PCD database for current SkuId.
775 **/
776 EFI_STATUS
777 UpdatePcdDatabase (
778 IN SKU_ID SkuId,
779 IN BOOLEAN IsPeiDb
780 )
781 {
782 UINTN Index;
783 PCD_DATABASE_SKU_DELTA *SkuDelta;
784 PCD_DATA_DELTA *SkuDeltaData;
785
786 if (IsPeiDb && (mPeiPcdDbBinary != NULL)) {
787 //
788 // Find the delta data for PEI DB
789 //
790 Index = (mPcdDatabase.PeiDb->Length + 7) & (~7);
791 SkuDelta = NULL;
792 while (Index < mPeiPcdDbSize) {
793 SkuDelta = (PCD_DATABASE_SKU_DELTA *)((UINT8 *)mPeiPcdDbBinary + Index);
794 if ((SkuDelta->SkuId == SkuId) && (SkuDelta->SkuIdCompared == 0)) {
795 break;
796 }
797
798 Index = (Index + SkuDelta->Length + 7) & (~7);
799 }
800
801 //
802 // Patch the delta data into current PCD database
803 //
804 if ((Index < mPeiPcdDbSize) && (SkuDelta != NULL)) {
805 SkuDeltaData = (PCD_DATA_DELTA *)(SkuDelta + 1);
806 while ((UINT8 *)SkuDeltaData < (UINT8 *)SkuDelta + SkuDelta->Length) {
807 *((UINT8 *)mPcdDatabase.PeiDb + SkuDeltaData->Offset) = (UINT8)SkuDeltaData->Value;
808 SkuDeltaData++;
809 }
810 } else {
811 return EFI_NOT_FOUND;
812 }
813 }
814
815 //
816 // Find the delta data for DXE DB
817 //
818 Index = (mPcdDatabase.DxeDb->Length + 7) & (~7);
819 SkuDelta = NULL;
820
821 if (Index == mDxePcdDbSize) {
822 return EFI_SUCCESS;
823 }
824
825 while (Index < mDxePcdDbSize) {
826 SkuDelta = (PCD_DATABASE_SKU_DELTA *)((UINT8 *)mDxePcdDbBinary + Index);
827 if ((SkuDelta->SkuId == SkuId) && (SkuDelta->SkuIdCompared == 0)) {
828 break;
829 }
830
831 Index = (Index + SkuDelta->Length + 7) & (~7);
832 }
833
834 //
835 // Patch the delta data into current PCD database
836 //
837 if ((Index < mDxePcdDbSize) && (SkuDelta != NULL)) {
838 SkuDeltaData = (PCD_DATA_DELTA *)(SkuDelta + 1);
839 while ((UINT8 *)SkuDeltaData < (UINT8 *)SkuDelta + SkuDelta->Length) {
840 *((UINT8 *)mPcdDatabase.DxeDb + SkuDeltaData->Offset) = (UINT8)SkuDeltaData->Value;
841 SkuDeltaData++;
842 }
843
844 return EFI_SUCCESS;
845 }
846
847 return EFI_NOT_FOUND;
848 }
849
850 /**
851 Initialize the PCD database in DXE phase.
852
853 PCD database in DXE phase also contains PCD database in PEI phase which is copied
854 from GUID Hob.
855
856 **/
857 VOID
858 BuildPcdDxeDataBase (
859 VOID
860 )
861 {
862 PEI_PCD_DATABASE *PeiDatabase;
863 EFI_HOB_GUID_TYPE *GuidHob;
864 UINTN Index;
865 UINT32 PcdDxeDbLen;
866 VOID *PcdDxeDb;
867 EFI_STATUS Status;
868
869 //
870 // Assign PCD Entries with default value to PCD DATABASE
871 //
872 mPcdDatabase.DxeDb = LocateExPcdBinary ();
873 ASSERT (mPcdDatabase.DxeDb != NULL);
874 PcdDxeDbLen = mPcdDatabase.DxeDb->Length + mPcdDatabase.DxeDb->UninitDataBaseSize;
875 PcdDxeDb = AllocateZeroPool (PcdDxeDbLen);
876 ASSERT (PcdDxeDb != NULL);
877 CopyMem (PcdDxeDb, mPcdDatabase.DxeDb, mPcdDatabase.DxeDb->Length);
878 mPcdDatabase.DxeDb = PcdDxeDb;
879
880 GuidHob = GetFirstGuidHob (&gPcdDataBaseHobGuid);
881 if (GuidHob != NULL) {
882 //
883 // If no PEIMs use dynamic Pcd Entry, the Pcd Service PEIM
884 // should not be included at all. So the GuidHob could
885 // be NULL. If it is NULL, we just copy over the DXE Default
886 // Value to PCD Database.
887 //
888 PeiDatabase = (PEI_PCD_DATABASE *)GET_GUID_HOB_DATA (GuidHob);
889
890 //
891 // Get next one that stores full PEI data
892 //
893 GuidHob = GetNextGuidHob (&gPcdDataBaseHobGuid, GET_NEXT_HOB (GuidHob));
894 if (GuidHob != NULL) {
895 mPeiPcdDbBinary = (PEI_PCD_DATABASE *)GET_GUID_HOB_DATA (GuidHob);
896 mPeiPcdDbSize = (UINTN)GET_GUID_HOB_DATA_SIZE (GuidHob);
897 }
898
899 //
900 // Assign PCD Entries refereneced in PEI phase to PCD DATABASE
901 //
902 mPcdDatabase.PeiDb = PeiDatabase;
903 //
904 // Inherit the SystemSkuId from PEI phase.
905 //
906 if (mPcdDatabase.PeiDb->SystemSkuId != 0) {
907 Status = UpdatePcdDatabase (mPcdDatabase.PeiDb->SystemSkuId, FALSE);
908 ASSERT_EFI_ERROR (Status);
909 }
910
911 mPcdDatabase.DxeDb->SystemSkuId = mPcdDatabase.PeiDb->SystemSkuId;
912 } else {
913 mPcdDatabase.PeiDb = AllocateZeroPool (sizeof (PEI_PCD_DATABASE));
914 ASSERT (mPcdDatabase.PeiDb != NULL);
915 }
916
917 //
918 // Initialized the external PCD database local variables
919 //
920 mPeiLocalTokenCount = mPcdDatabase.PeiDb->LocalTokenCount;
921 mDxeLocalTokenCount = mPcdDatabase.DxeDb->LocalTokenCount;
922
923 mPeiExMapppingTableSize = mPcdDatabase.PeiDb->ExTokenCount * sizeof (DYNAMICEX_MAPPING);
924 mDxeExMapppingTableSize = mPcdDatabase.DxeDb->ExTokenCount * sizeof (DYNAMICEX_MAPPING);
925 mPeiGuidTableSize = mPcdDatabase.PeiDb->GuidTableCount * sizeof (GUID);
926 mDxeGuidTableSize = mPcdDatabase.DxeDb->GuidTableCount * sizeof (GUID);
927
928 mPcdTotalTokenCount = mPeiLocalTokenCount + mDxeLocalTokenCount;
929 mPeiNexTokenCount = mPeiLocalTokenCount - mPcdDatabase.PeiDb->ExTokenCount;
930 mDxeNexTokenCount = mDxeLocalTokenCount - mPcdDatabase.DxeDb->ExTokenCount;
931
932 mPeiExMapTableEmpty = (mPcdDatabase.PeiDb->ExTokenCount == 0) ? TRUE : FALSE;
933 mDxeExMapTableEmpty = (mPcdDatabase.DxeDb->ExTokenCount == 0) ? TRUE : FALSE;
934 mPeiDatabaseEmpty = (mPeiLocalTokenCount == 0) ? TRUE : FALSE;
935
936 TmpTokenSpaceBufferCount = mPcdDatabase.PeiDb->ExTokenCount + mPcdDatabase.DxeDb->ExTokenCount;
937 TmpTokenSpaceBuffer = (EFI_GUID **)AllocateZeroPool (TmpTokenSpaceBufferCount * sizeof (EFI_GUID *));
938
939 //
940 // Initialized the Callback Function Table
941 //
942 mCallbackFnTable = AllocateZeroPool (mPcdTotalTokenCount * sizeof (LIST_ENTRY));
943 ASSERT (mCallbackFnTable != NULL);
944
945 //
946 // EBC compiler is very choosy. It may report warning about comparison
947 // between UINTN and 0 . So we add 1 in each size of the
948 // comparison.
949 //
950 for (Index = 0; Index + 1 < mPcdTotalTokenCount + 1; Index++) {
951 InitializeListHead (&mCallbackFnTable[Index]);
952 }
953 }
954
955 /**
956 Get Variable which contains HII type PCD entry.
957
958 @param VariableGuid Variable's guid
959 @param VariableName Variable's unicode name string
960 @param VariableData Variable's data pointer,
961 @param VariableSize Variable's size.
962
963 @return the status of gRT->GetVariable
964 **/
965 EFI_STATUS
966 GetHiiVariable (
967 IN EFI_GUID *VariableGuid,
968 IN UINT16 *VariableName,
969 OUT UINT8 **VariableData,
970 OUT UINTN *VariableSize
971 )
972 {
973 UINTN Size;
974 EFI_STATUS Status;
975 UINT8 *Buffer;
976
977 Size = 0;
978 Buffer = NULL;
979
980 //
981 // Firstly get the real size of HII variable
982 //
983 Status = gRT->GetVariable (
984 (UINT16 *)VariableName,
985 VariableGuid,
986 NULL,
987 &Size,
988 Buffer
989 );
990
991 //
992 // Allocate buffer to hold whole variable data according to variable size.
993 //
994 if (Status == EFI_BUFFER_TOO_SMALL) {
995 Buffer = (UINT8 *)AllocatePool (Size);
996
997 ASSERT (Buffer != NULL);
998
999 Status = gRT->GetVariable (
1000 VariableName,
1001 VariableGuid,
1002 NULL,
1003 &Size,
1004 Buffer
1005 );
1006
1007 ASSERT (Status == EFI_SUCCESS);
1008 *VariableData = Buffer;
1009 *VariableSize = Size;
1010 } else {
1011 //
1012 // Use Default Data only when variable is not found.
1013 // For other error status, correct data can't be got, and trig ASSERT().
1014 //
1015 ASSERT (Status == EFI_NOT_FOUND);
1016 }
1017
1018 return Status;
1019 }
1020
1021 /**
1022 Invoke the callback function when dynamic PCD entry was set, if this PCD entry
1023 has registered callback function.
1024
1025 @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx
1026 type PCD.
1027 @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type
1028 PCD.
1029 @param TokenNumber PCD token number generated by build tools.
1030 @param Data Value want to be set for this PCD entry
1031 @param Size The size of value
1032
1033 **/
1034 VOID
1035 InvokeCallbackOnSet (
1036 UINT32 ExTokenNumber,
1037 CONST EFI_GUID *Guid OPTIONAL,
1038 UINTN TokenNumber,
1039 VOID *Data,
1040 UINTN Size
1041 )
1042 {
1043 CALLBACK_FN_ENTRY *FnTableEntry;
1044 LIST_ENTRY *ListHead;
1045 LIST_ENTRY *ListNode;
1046
1047 //
1048 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
1049 // We have to decrement TokenNumber by 1 to make it usable
1050 // as the array index of mCallbackFnTable[].
1051 //
1052 ListHead = &mCallbackFnTable[TokenNumber - 1];
1053 ListNode = GetFirstNode (ListHead);
1054
1055 while (ListNode != ListHead) {
1056 FnTableEntry = CR_FNENTRY_FROM_LISTNODE (ListNode, CALLBACK_FN_ENTRY, Node);
1057
1058 FnTableEntry->CallbackFn (
1059 Guid,
1060 (Guid == NULL) ? TokenNumber : ExTokenNumber,
1061 Data,
1062 Size
1063 );
1064
1065 ListNode = GetNextNode (ListHead, ListNode);
1066 }
1067
1068 return;
1069 }
1070
1071 /**
1072 Wrapper function for setting non-pointer type value for a PCD entry.
1073
1074 @param TokenNumber Pcd token number autogenerated by build tools.
1075 @param Data Value want to be set for PCD entry
1076 @param Size Size of value.
1077
1078 @return status of SetWorker.
1079
1080 **/
1081 EFI_STATUS
1082 SetValueWorker (
1083 IN UINTN TokenNumber,
1084 IN VOID *Data,
1085 IN UINTN Size
1086 )
1087 {
1088 return SetWorker (TokenNumber, Data, &Size, FALSE);
1089 }
1090
1091 /**
1092 Set value for an PCD entry
1093
1094 @param TokenNumber Pcd token number autogenerated by build tools.
1095 @param Data Value want to be set for PCD entry
1096 @param Size Size of value.
1097 @param PtrType If TRUE, the type of PCD entry's value is Pointer.
1098 If False, the type of PCD entry's value is not Pointer.
1099
1100 @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.
1101 @retval EFI_INVALID_PARAMETER If Size can not be set to size table.
1102 @retval EFI_INVALID_PARAMETER If Size of non-Ptr type PCD does not match the size information in PCD database.
1103 @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in
1104 range of UINT8, UINT16, UINT32, UINT64
1105 @retval EFI_NOT_FOUND Can not find the PCD type according to token number.
1106 **/
1107 EFI_STATUS
1108 SetWorker (
1109 IN UINTN TokenNumber,
1110 IN VOID *Data,
1111 IN OUT UINTN *Size,
1112 IN BOOLEAN PtrType
1113 )
1114 {
1115 BOOLEAN IsPeiDb;
1116 UINT32 LocalTokenNumber;
1117 EFI_GUID *GuidTable;
1118 UINT8 *StringTable;
1119 EFI_GUID *Guid;
1120 UINT16 *Name;
1121 UINTN VariableOffset;
1122 UINT32 Attributes;
1123 VOID *InternalData;
1124 VARIABLE_HEAD *VariableHead;
1125 UINTN Offset;
1126 UINT8 *PcdDb;
1127 EFI_STATUS Status;
1128 UINTN MaxSize;
1129 UINTN TmpTokenNumber;
1130
1131 //
1132 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
1133 // We have to decrement TokenNumber by 1 to make it usable
1134 // as the array index.
1135 //
1136 TokenNumber--;
1137
1138 TmpTokenNumber = TokenNumber;
1139
1140 //
1141 // EBC compiler is very choosy. It may report warning about comparison
1142 // between UINTN and 0 . So we add 1 in each size of the
1143 // comparison.
1144 //
1145 ASSERT (TokenNumber + 1 < mPcdTotalTokenCount + 1);
1146
1147 if (PtrType) {
1148 //
1149 // Get MaxSize first, then check new size with max buffer size.
1150 //
1151 GetPtrTypeSize (TokenNumber, &MaxSize);
1152 if (*Size > MaxSize) {
1153 *Size = MaxSize;
1154 return EFI_INVALID_PARAMETER;
1155 }
1156 } else {
1157 if (*Size != DxePcdGetSize (TokenNumber + 1)) {
1158 return EFI_INVALID_PARAMETER;
1159 }
1160 }
1161
1162 //
1163 // EBC compiler is very choosy. It may report warning about comparison
1164 // between UINTN and 0 . So we add 1 in each size of the
1165 // comparison.
1166 //
1167 if ((TokenNumber + 1 < mPeiNexTokenCount + 1) ||
1168 ((TokenNumber + 1 >= mPeiLocalTokenCount + 1) && (TokenNumber + 1 < (mPeiLocalTokenCount + mDxeNexTokenCount + 1))))
1169 {
1170 InvokeCallbackOnSet (0, NULL, TokenNumber + 1, Data, *Size);
1171 }
1172
1173 //
1174 // Aquire lock to prevent reentrance from TPL_CALLBACK level
1175 //
1176 EfiAcquireLock (&mPcdDatabaseLock);
1177
1178 //
1179 // EBC compiler is very choosy. It may report warning about comparison
1180 // between UINTN and 0 . So we add 1 in each size of the
1181 // comparison.
1182 //
1183 IsPeiDb = (BOOLEAN)((TokenNumber + 1 < mPeiLocalTokenCount + 1) ? TRUE : FALSE);
1184
1185 LocalTokenNumber = GetLocalTokenNumber (IsPeiDb, TokenNumber + 1);
1186
1187 Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;
1188
1189 PcdDb = IsPeiDb ? ((UINT8 *)mPcdDatabase.PeiDb) : ((UINT8 *)mPcdDatabase.DxeDb);
1190
1191 if (IsPeiDb) {
1192 StringTable = (UINT8 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->StringTableOffset);
1193 } else {
1194 StringTable = (UINT8 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->StringTableOffset);
1195 }
1196
1197 InternalData = PcdDb + Offset;
1198
1199 switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {
1200 case PCD_TYPE_VPD:
1201 ASSERT (FALSE);
1202 Status = EFI_INVALID_PARAMETER;
1203 break;
1204
1205 case PCD_TYPE_STRING:
1206 if (SetPtrTypeSize (TmpTokenNumber, Size)) {
1207 CopyMem (StringTable + *((STRING_HEAD *)InternalData), Data, *Size);
1208 Status = EFI_SUCCESS;
1209 } else {
1210 Status = EFI_INVALID_PARAMETER;
1211 }
1212
1213 break;
1214
1215 case PCD_TYPE_HII|PCD_TYPE_STRING:
1216 case PCD_TYPE_HII:
1217 if (PtrType) {
1218 if (!SetPtrTypeSize (TmpTokenNumber, Size)) {
1219 Status = EFI_INVALID_PARAMETER;
1220 break;
1221 }
1222 }
1223
1224 if (IsPeiDb) {
1225 GuidTable = (EFI_GUID *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->GuidTableOffset);
1226 } else {
1227 GuidTable = (EFI_GUID *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->GuidTableOffset);
1228 }
1229
1230 VariableHead = (VARIABLE_HEAD *)(PcdDb + Offset);
1231
1232 Guid = GuidTable + VariableHead->GuidTableIndex;
1233 Name = (UINT16 *)(StringTable + VariableHead->StringIndex);
1234 VariableOffset = VariableHead->Offset;
1235 Attributes = VariableHead->Attributes;
1236 Status = SetHiiVariable (Guid, Name, Attributes, Data, *Size, VariableOffset);
1237 break;
1238
1239 case PCD_TYPE_DATA:
1240 if (PtrType) {
1241 if (SetPtrTypeSize (TmpTokenNumber, Size)) {
1242 CopyMem (InternalData, Data, *Size);
1243 Status = EFI_SUCCESS;
1244 } else {
1245 Status = EFI_INVALID_PARAMETER;
1246 }
1247
1248 break;
1249 }
1250
1251 Status = EFI_SUCCESS;
1252 switch (*Size) {
1253 case sizeof (UINT8):
1254 *((UINT8 *)InternalData) = *((UINT8 *)Data);
1255 break;
1256
1257 case sizeof (UINT16):
1258 *((UINT16 *)InternalData) = *((UINT16 *)Data);
1259 break;
1260
1261 case sizeof (UINT32):
1262 *((UINT32 *)InternalData) = *((UINT32 *)Data);
1263 break;
1264
1265 case sizeof (UINT64):
1266 *((UINT64 *)InternalData) = *((UINT64 *)Data);
1267 break;
1268
1269 default:
1270 ASSERT (FALSE);
1271 Status = EFI_NOT_FOUND;
1272 break;
1273 }
1274
1275 break;
1276
1277 default:
1278 ASSERT (FALSE);
1279 Status = EFI_NOT_FOUND;
1280 break;
1281 }
1282
1283 EfiReleaseLock (&mPcdDatabaseLock);
1284
1285 return Status;
1286 }
1287
1288 /**
1289 Wrapper function for get PCD value for dynamic-ex PCD.
1290
1291 @param Guid Token space guid for dynamic-ex PCD.
1292 @param ExTokenNumber Token number for dynamic-ex PCD.
1293 @param GetSize The size of dynamic-ex PCD value.
1294
1295 @return PCD entry in PCD database.
1296
1297 **/
1298 VOID *
1299 ExGetWorker (
1300 IN CONST EFI_GUID *Guid,
1301 IN UINTN ExTokenNumber,
1302 IN UINTN GetSize
1303 )
1304 {
1305 return GetWorker (GetExPcdTokenNumber (Guid, (UINT32)ExTokenNumber), GetSize);
1306 }
1307
1308 /**
1309 Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.
1310
1311 @param ExTokenNumber Token number for dynamic-ex PCD.
1312 @param Guid Token space guid for dynamic-ex PCD.
1313 @param Data Value want to be set.
1314 @param SetSize The size of value.
1315
1316 @return status of ExSetWorker().
1317
1318 **/
1319 EFI_STATUS
1320 ExSetValueWorker (
1321 IN UINTN ExTokenNumber,
1322 IN CONST EFI_GUID *Guid,
1323 IN VOID *Data,
1324 IN UINTN SetSize
1325 )
1326 {
1327 return ExSetWorker (ExTokenNumber, Guid, Data, &SetSize, FALSE);
1328 }
1329
1330 /**
1331 Set value for a dynamic-ex PCD entry.
1332
1333 This routine find the local token number according to dynamic-ex PCD's token
1334 space guid and token number firstly, and invoke callback function if this PCD
1335 entry registered callback function. Finally, invoken general SetWorker to set
1336 PCD value.
1337
1338 @param ExTokenNumber Dynamic-ex PCD token number.
1339 @param Guid Token space guid for dynamic-ex PCD.
1340 @param Data PCD value want to be set
1341 @param SetSize Size of value.
1342 @param PtrType If TRUE, this PCD entry is pointer type.
1343 If FALSE, this PCD entry is not pointer type.
1344
1345 @return status of SetWorker().
1346
1347 **/
1348 EFI_STATUS
1349 ExSetWorker (
1350 IN UINTN ExTokenNumber,
1351 IN CONST EFI_GUID *Guid,
1352 IN VOID *Data,
1353 IN OUT UINTN *SetSize,
1354 IN BOOLEAN PtrType
1355 )
1356 {
1357 UINTN TokenNumber;
1358
1359 TokenNumber = GetExPcdTokenNumber (Guid, (UINT32)ExTokenNumber);
1360
1361 InvokeCallbackOnSet ((UINT32)ExTokenNumber, Guid, TokenNumber, Data, *SetSize);
1362
1363 return SetWorker (TokenNumber, Data, SetSize, PtrType);
1364 }
1365
1366 /**
1367 Get variable size and data from HII-type PCDs.
1368
1369 @param[in] VariableGuid Guid of variable which stored value of a HII-type PCD.
1370 @param[in] VariableName Unicode name of variable which stored value of a HII-type PCD.
1371 @param[out] VariableSize Pointer to variable size got from HII-type PCDs.
1372 @param[out] VariableData Pointer to variable data got from HII-type PCDs.
1373
1374 **/
1375 VOID
1376 GetVariableSizeAndDataFromHiiPcd (
1377 IN EFI_GUID *VariableGuid,
1378 IN UINT16 *VariableName,
1379 OUT UINTN *VariableSize,
1380 OUT VOID *VariableData OPTIONAL
1381 )
1382 {
1383 BOOLEAN IsPeiDb;
1384 PCD_DATABASE_INIT *Database;
1385 UINTN TokenNumber;
1386 UINT32 LocalTokenNumber;
1387 UINTN Offset;
1388 EFI_GUID *GuidTable;
1389 UINT8 *StringTable;
1390 VARIABLE_HEAD *VariableHead;
1391 EFI_GUID *Guid;
1392 UINT16 *Name;
1393 UINTN PcdDataSize;
1394 UINTN Size;
1395 UINT8 *VaraiableDefaultBuffer;
1396 STRING_HEAD StringTableIdx;
1397
1398 *VariableSize = 0;
1399
1400 //
1401 // Go through PCD database to find out DynamicHii PCDs.
1402 //
1403 for (TokenNumber = 1; TokenNumber <= mPcdTotalTokenCount; TokenNumber++) {
1404 IsPeiDb = (BOOLEAN)((TokenNumber + 1 < mPeiLocalTokenCount + 1) ? TRUE : FALSE);
1405 Database = IsPeiDb ? mPcdDatabase.PeiDb : mPcdDatabase.DxeDb;
1406 LocalTokenNumber = GetLocalTokenNumber (IsPeiDb, TokenNumber);
1407 if ((LocalTokenNumber & PCD_TYPE_HII) != 0) {
1408 //
1409 // Get the Variable Guid and Name pointer.
1410 //
1411 Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;
1412 VariableHead = (VARIABLE_HEAD *)((UINT8 *)Database + Offset);
1413 StringTable = (UINT8 *)((UINT8 *)Database + Database->StringTableOffset);
1414 GuidTable = (EFI_GUID *)((UINT8 *)Database + Database->GuidTableOffset);
1415 Guid = GuidTable + VariableHead->GuidTableIndex;
1416 Name = (UINT16 *)(StringTable + VariableHead->StringIndex);
1417 if (CompareGuid (VariableGuid, Guid) && (StrCmp (VariableName, Name) == 0)) {
1418 //
1419 // It is the matched DynamicHii PCD.
1420 //
1421 PcdDataSize = DxePcdGetSize (TokenNumber);
1422 Size = VariableHead->Offset + PcdDataSize;
1423 if (Size > *VariableSize) {
1424 *VariableSize = Size;
1425 }
1426
1427 if (VariableData != NULL) {
1428 if ((LocalTokenNumber & PCD_TYPE_ALL_SET) == (PCD_TYPE_HII|PCD_TYPE_STRING)) {
1429 //
1430 // If a HII type PCD's datum type is VOID*, the DefaultValueOffset is the index of
1431 // string array in string table.
1432 //
1433 StringTableIdx = *(STRING_HEAD *)((UINT8 *)Database + VariableHead->DefaultValueOffset);
1434 VaraiableDefaultBuffer = (UINT8 *)(StringTable + StringTableIdx);
1435 } else {
1436 VaraiableDefaultBuffer = (UINT8 *)Database + VariableHead->DefaultValueOffset;
1437 }
1438
1439 CopyMem ((UINT8 *)VariableData + VariableHead->Offset, VaraiableDefaultBuffer, PcdDataSize);
1440 }
1441 }
1442 }
1443 }
1444 }
1445
1446 /**
1447 Set value for HII-type PCD.
1448
1449 A HII-type PCD's value is stored in a variable. Setting/Getting the value of
1450 HII-type PCD is to visit this variable.
1451
1452 @param VariableGuid Guid of variable which stored value of a HII-type PCD.
1453 @param VariableName Unicode name of variable which stored value of a HII-type PCD.
1454 @param SetAttributes Attributes bitmask to set for the variable.
1455 @param Data Value want to be set.
1456 @param DataSize Size of value
1457 @param Offset Value offset of HII-type PCD in variable.
1458
1459 @return status of GetVariable()/SetVariable().
1460
1461 **/
1462 EFI_STATUS
1463 SetHiiVariable (
1464 IN EFI_GUID *VariableGuid,
1465 IN UINT16 *VariableName,
1466 IN UINT32 SetAttributes,
1467 IN CONST VOID *Data,
1468 IN UINTN DataSize,
1469 IN UINTN Offset
1470 )
1471 {
1472 UINTN Size;
1473 VOID *Buffer;
1474 EFI_STATUS Status;
1475 UINT32 Attribute;
1476 UINTN SetSize;
1477
1478 Size = 0;
1479 SetSize = 0;
1480
1481 //
1482 // Try to get original variable size information.
1483 //
1484 Status = gRT->GetVariable (
1485 (UINT16 *)VariableName,
1486 VariableGuid,
1487 NULL,
1488 &Size,
1489 NULL
1490 );
1491
1492 if (Status == EFI_BUFFER_TOO_SMALL) {
1493 //
1494 // Patch new PCD's value to offset in given HII variable.
1495 //
1496 if (Size >= (DataSize + Offset)) {
1497 SetSize = Size;
1498 } else {
1499 SetSize = DataSize + Offset;
1500 }
1501
1502 Buffer = AllocatePool (SetSize);
1503 ASSERT (Buffer != NULL);
1504
1505 Status = gRT->GetVariable (
1506 VariableName,
1507 VariableGuid,
1508 &Attribute,
1509 &Size,
1510 Buffer
1511 );
1512
1513 ASSERT_EFI_ERROR (Status);
1514
1515 CopyMem ((UINT8 *)Buffer + Offset, Data, DataSize);
1516
1517 if (SetAttributes == 0) {
1518 SetAttributes = Attribute;
1519 }
1520
1521 Status = gRT->SetVariable (
1522 VariableName,
1523 VariableGuid,
1524 SetAttributes,
1525 SetSize,
1526 Buffer
1527 );
1528
1529 FreePool (Buffer);
1530 return Status;
1531 } else if (Status == EFI_NOT_FOUND) {
1532 //
1533 // If variable does not exist, a new variable need to be created.
1534 //
1535
1536 //
1537 // Get size, allocate buffer and get data.
1538 //
1539 GetVariableSizeAndDataFromHiiPcd (VariableGuid, VariableName, &Size, NULL);
1540 Buffer = AllocateZeroPool (Size);
1541 ASSERT (Buffer != NULL);
1542 GetVariableSizeAndDataFromHiiPcd (VariableGuid, VariableName, &Size, Buffer);
1543
1544 //
1545 // Update buffer.
1546 //
1547 CopyMem ((UINT8 *)Buffer + Offset, Data, DataSize);
1548
1549 if (SetAttributes == 0) {
1550 SetAttributes = EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE;
1551 }
1552
1553 Status = gRT->SetVariable (
1554 VariableName,
1555 VariableGuid,
1556 SetAttributes,
1557 Size,
1558 Buffer
1559 );
1560
1561 FreePool (Buffer);
1562 return Status;
1563 }
1564
1565 //
1566 // If we drop to here, the value is failed to be written in to variable area.
1567 //
1568 return Status;
1569 }
1570
1571 /**
1572 Get Token Number according to dynamic-ex PCD's {token space guid:token number}
1573
1574 A dynamic-ex type PCD, developer must provide pair of token space guid: token number
1575 in DEC file. PCD database maintain a mapping table that translate pair of {token
1576 space guid: token number} to Token Number.
1577
1578 @param Guid Token space guid for dynamic-ex PCD entry.
1579 @param ExTokenNumber Dynamic-ex PCD token number.
1580
1581 @return Token Number for dynamic-ex PCD.
1582
1583 **/
1584 UINTN
1585 GetExPcdTokenNumber (
1586 IN CONST EFI_GUID *Guid,
1587 IN UINT32 ExTokenNumber
1588 )
1589 {
1590 UINT32 Index;
1591 DYNAMICEX_MAPPING *ExMap;
1592 EFI_GUID *GuidTable;
1593 EFI_GUID *MatchGuid;
1594 UINTN MatchGuidIdx;
1595
1596 if (!mPeiDatabaseEmpty) {
1597 ExMap = (DYNAMICEX_MAPPING *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->ExMapTableOffset);
1598 GuidTable = (EFI_GUID *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->GuidTableOffset);
1599
1600 MatchGuid = ScanGuid (GuidTable, mPeiGuidTableSize, Guid);
1601
1602 if (MatchGuid != NULL) {
1603 MatchGuidIdx = MatchGuid - GuidTable;
1604
1605 for (Index = 0; Index < mPcdDatabase.PeiDb->ExTokenCount; Index++) {
1606 if ((ExTokenNumber == ExMap[Index].ExTokenNumber) &&
1607 (MatchGuidIdx == ExMap[Index].ExGuidIndex))
1608 {
1609 return ExMap[Index].TokenNumber;
1610 }
1611 }
1612 }
1613 }
1614
1615 ExMap = (DYNAMICEX_MAPPING *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->ExMapTableOffset);
1616 GuidTable = (EFI_GUID *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->GuidTableOffset);
1617
1618 MatchGuid = ScanGuid (GuidTable, mDxeGuidTableSize, Guid);
1619 //
1620 // We need to ASSERT here. If GUID can't be found in GuidTable, this is a
1621 // error in the BUILD system.
1622 //
1623 ASSERT (MatchGuid != NULL);
1624
1625 MatchGuidIdx = MatchGuid - GuidTable;
1626
1627 for (Index = 0; Index < mPcdDatabase.DxeDb->ExTokenCount; Index++) {
1628 if ((ExTokenNumber == ExMap[Index].ExTokenNumber) &&
1629 (MatchGuidIdx == ExMap[Index].ExGuidIndex))
1630 {
1631 return ExMap[Index].TokenNumber;
1632 }
1633 }
1634
1635 DEBUG ((DEBUG_ERROR, "%a: Failed to find PCD with GUID: %g and token number: %d\n", __FUNCTION__, Guid, ExTokenNumber));
1636 ASSERT (FALSE);
1637
1638 return 0;
1639 }
1640
1641 /**
1642 Wrapper function of getting index of PCD entry in size table.
1643
1644 @param LocalTokenNumberTableIdx Index of this PCD in local token number table.
1645 @param IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
1646 If FALSE, the pcd entry is initialized in DXE phase.
1647
1648 @return index of PCD entry in size table.
1649 **/
1650 UINTN
1651 GetSizeTableIndex (
1652 IN UINTN LocalTokenNumberTableIdx,
1653 IN BOOLEAN IsPeiDb
1654 )
1655 {
1656 UINT32 *LocalTokenNumberTable;
1657 UINTN LocalTokenNumber;
1658 UINTN Index;
1659 UINTN SizeTableIdx;
1660
1661 if (IsPeiDb) {
1662 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->LocalTokenNumberTableOffset);
1663 } else {
1664 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->LocalTokenNumberTableOffset);
1665 }
1666
1667 SizeTableIdx = 0;
1668
1669 for (Index = 0; Index < LocalTokenNumberTableIdx; Index++) {
1670 LocalTokenNumber = LocalTokenNumberTable[Index];
1671
1672 if ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER) {
1673 //
1674 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1675 // PCD entry.
1676 //
1677 if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {
1678 //
1679 // We have only two entry for VPD enabled PCD entry:
1680 // 1) MAX Size.
1681 // 2) Current Size
1682 // Current size is equal to MAX size.
1683 //
1684 SizeTableIdx += 2;
1685 } else {
1686 //
1687 // We have only two entry for Non-Sku enabled PCD entry:
1688 // 1) MAX SIZE
1689 // 2) Current Size
1690 //
1691 SizeTableIdx += 2;
1692 }
1693 }
1694 }
1695
1696 return SizeTableIdx;
1697 }
1698
1699 /**
1700 Get size of POINTER type PCD value.
1701
1702 @param LocalTokenNumberTableIdx Index of local token number in local token number table.
1703 @param MaxSize Maxmium size of POINTER type PCD value.
1704
1705 @return size of POINTER type PCD value.
1706
1707 **/
1708 UINTN
1709 GetPtrTypeSize (
1710 IN UINTN LocalTokenNumberTableIdx,
1711 OUT UINTN *MaxSize
1712 )
1713 {
1714 INTN SizeTableIdx;
1715 UINTN LocalTokenNumber;
1716 SIZE_INFO *SizeTable;
1717 BOOLEAN IsPeiDb;
1718 UINT32 *LocalTokenNumberTable;
1719
1720 // EBC compiler is very choosy. It may report warning about comparison
1721 // between UINTN and 0 . So we add 1 in each size of the
1722 // comparison.
1723 IsPeiDb = (BOOLEAN)(LocalTokenNumberTableIdx + 1 < mPeiLocalTokenCount + 1);
1724
1725 if (IsPeiDb) {
1726 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->LocalTokenNumberTableOffset);
1727 SizeTable = (SIZE_INFO *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->SizeTableOffset);
1728 } else {
1729 LocalTokenNumberTableIdx -= mPeiLocalTokenCount;
1730 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->LocalTokenNumberTableOffset);
1731 SizeTable = (SIZE_INFO *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->SizeTableOffset);
1732 }
1733
1734 LocalTokenNumber = LocalTokenNumberTable[LocalTokenNumberTableIdx];
1735
1736 ASSERT ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER);
1737
1738 SizeTableIdx = GetSizeTableIndex (LocalTokenNumberTableIdx, IsPeiDb);
1739
1740 *MaxSize = SizeTable[SizeTableIdx];
1741 //
1742 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1743 // PCD entry.
1744 //
1745 if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {
1746 //
1747 // We have only two entry for VPD enabled PCD entry:
1748 // 1) MAX Size.
1749 // 2) Current Size
1750 // We consider current size is equal to MAX size.
1751 //
1752 return *MaxSize;
1753 } else {
1754 //
1755 // We have only two entry for Non-Sku enabled PCD entry:
1756 // 1) MAX SIZE
1757 // 2) Current Size
1758 //
1759 return SizeTable[SizeTableIdx + 1];
1760 }
1761 }
1762
1763 /**
1764 Set size of POINTER type PCD value. The size should not exceed the maximum size
1765 of this PCD value.
1766
1767 @param LocalTokenNumberTableIdx Index of local token number in local token number table.
1768 @param CurrentSize Size of POINTER type PCD value.
1769
1770 @retval TRUE Success to set size of PCD value.
1771 @retval FALSE Fail to set size of PCD value.
1772 **/
1773 BOOLEAN
1774 SetPtrTypeSize (
1775 IN UINTN LocalTokenNumberTableIdx,
1776 IN OUT UINTN *CurrentSize
1777 )
1778 {
1779 INTN SizeTableIdx;
1780 UINTN LocalTokenNumber;
1781 SIZE_INFO *SizeTable;
1782 UINTN MaxSize;
1783 BOOLEAN IsPeiDb;
1784 UINT32 *LocalTokenNumberTable;
1785
1786 //
1787 // EBC compiler is very choosy. It may report warning about comparison
1788 // between UINTN and 0 . So we add 1 in each size of the
1789 // comparison.
1790 //
1791 IsPeiDb = (BOOLEAN)(LocalTokenNumberTableIdx + 1 < mPeiLocalTokenCount + 1);
1792
1793 if (IsPeiDb) {
1794 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->LocalTokenNumberTableOffset);
1795 SizeTable = (SIZE_INFO *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->SizeTableOffset);
1796 } else {
1797 LocalTokenNumberTableIdx -= mPeiLocalTokenCount;
1798 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->LocalTokenNumberTableOffset);
1799 SizeTable = (SIZE_INFO *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->SizeTableOffset);
1800 }
1801
1802 LocalTokenNumber = LocalTokenNumberTable[LocalTokenNumberTableIdx];
1803
1804 ASSERT ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER);
1805
1806 SizeTableIdx = GetSizeTableIndex (LocalTokenNumberTableIdx, IsPeiDb);
1807
1808 MaxSize = SizeTable[SizeTableIdx];
1809 //
1810 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1811 // PCD entry.
1812 //
1813 if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {
1814 //
1815 // We shouldn't come here as we don't support SET for VPD
1816 //
1817 ASSERT (FALSE);
1818 return FALSE;
1819 } else {
1820 if ((*CurrentSize > MaxSize) ||
1821 (*CurrentSize == MAX_ADDRESS))
1822 {
1823 *CurrentSize = MaxSize;
1824 return FALSE;
1825 }
1826
1827 //
1828 // We have only two entry for Non-Sku enabled PCD entry:
1829 // 1) MAX SIZE
1830 // 2) Current Size
1831 //
1832 SizeTable[SizeTableIdx + 1] = (SIZE_INFO)*CurrentSize;
1833 return TRUE;
1834 }
1835 }
1836
1837 /**
1838 VariableLock DynamicHiiPcd.
1839
1840 @param[in] IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
1841 If FALSE, the pcd entry is initialized in DXE phase.
1842 @param[in] VariableLock Pointer to VariableLockProtocol.
1843
1844 **/
1845 VOID
1846 VariableLockDynamicHiiPcd (
1847 IN BOOLEAN IsPeiDb,
1848 IN EDKII_VARIABLE_LOCK_PROTOCOL *VariableLock
1849 )
1850 {
1851 EFI_STATUS Status;
1852 PCD_DATABASE_INIT *Database;
1853 UINT32 LocalTokenCount;
1854 UINTN TokenNumber;
1855 UINT32 LocalTokenNumber;
1856 UINTN Offset;
1857 EFI_GUID *GuidTable;
1858 UINT8 *StringTable;
1859 VARIABLE_HEAD *VariableHead;
1860 EFI_GUID *Guid;
1861 UINT16 *Name;
1862
1863 Database = IsPeiDb ? mPcdDatabase.PeiDb : mPcdDatabase.DxeDb;
1864 LocalTokenCount = IsPeiDb ? mPeiLocalTokenCount : mDxeLocalTokenCount;
1865
1866 //
1867 // Go through PCD database to find out DynamicHii PCDs.
1868 //
1869 for (TokenNumber = 1; TokenNumber <= LocalTokenCount; TokenNumber++) {
1870 if (IsPeiDb) {
1871 LocalTokenNumber = GetLocalTokenNumber (TRUE, TokenNumber);
1872 } else {
1873 LocalTokenNumber = GetLocalTokenNumber (FALSE, TokenNumber + mPeiLocalTokenCount);
1874 }
1875
1876 if ((LocalTokenNumber & PCD_TYPE_HII) != 0) {
1877 Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;
1878 VariableHead = (VARIABLE_HEAD *)((UINT8 *)Database + Offset);
1879 //
1880 // Why not to set property by VarCheckProtocol with Attributes and Property directly here?
1881 // It is because that set property by VarCheckProtocol will indicate the variable to
1882 // be a system variable, but the unknown max size of the variable is dangerous to
1883 // the system variable region.
1884 //
1885 if ((VariableHead->Property & VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY) != 0) {
1886 //
1887 // DynamicHii PCD with RO property set in *.dsc.
1888 //
1889 StringTable = (UINT8 *)((UINT8 *)Database + Database->StringTableOffset);
1890 GuidTable = (EFI_GUID *)((UINT8 *)Database + Database->GuidTableOffset);
1891 Guid = GuidTable + VariableHead->GuidTableIndex;
1892 Name = (UINT16 *)(StringTable + VariableHead->StringIndex);
1893 Status = VariableLock->RequestToLock (VariableLock, Name, Guid);
1894 ASSERT_EFI_ERROR (Status);
1895 }
1896 }
1897 }
1898 }
1899
1900 /**
1901 VariableLockProtocol callback
1902 to lock the variables referenced by DynamicHii PCDs with RO property set in *.dsc.
1903
1904 @param[in] Event Event whose notification function is being invoked.
1905 @param[in] Context Pointer to the notification function's context.
1906
1907 **/
1908 VOID
1909 EFIAPI
1910 VariableLockCallBack (
1911 IN EFI_EVENT Event,
1912 IN VOID *Context
1913 )
1914 {
1915 EFI_STATUS Status;
1916 EDKII_VARIABLE_LOCK_PROTOCOL *VariableLock;
1917
1918 Status = gBS->LocateProtocol (&gEdkiiVariableLockProtocolGuid, NULL, (VOID **)&VariableLock);
1919 if (!EFI_ERROR (Status)) {
1920 VariableLockDynamicHiiPcd (TRUE, VariableLock);
1921 VariableLockDynamicHiiPcd (FALSE, VariableLock);
1922 }
1923 }