]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/PCD/Dxe/Service.c
MdeModulePkg: Apply uncrustify changes
[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 while (Index < mDxePcdDbSize) {
821 SkuDelta = (PCD_DATABASE_SKU_DELTA *)((UINT8 *)mDxePcdDbBinary + Index);
822 if ((SkuDelta->SkuId == SkuId) && (SkuDelta->SkuIdCompared == 0)) {
823 break;
824 }
825
826 Index = (Index + SkuDelta->Length + 7) & (~7);
827 }
828
829 //
830 // Patch the delta data into current PCD database
831 //
832 if ((Index < mDxePcdDbSize) && (SkuDelta != NULL)) {
833 SkuDeltaData = (PCD_DATA_DELTA *)(SkuDelta + 1);
834 while ((UINT8 *)SkuDeltaData < (UINT8 *)SkuDelta + SkuDelta->Length) {
835 *((UINT8 *)mPcdDatabase.DxeDb + SkuDeltaData->Offset) = (UINT8)SkuDeltaData->Value;
836 SkuDeltaData++;
837 }
838
839 return EFI_SUCCESS;
840 }
841
842 return EFI_NOT_FOUND;
843 }
844
845 /**
846 Initialize the PCD database in DXE phase.
847
848 PCD database in DXE phase also contains PCD database in PEI phase which is copied
849 from GUID Hob.
850
851 **/
852 VOID
853 BuildPcdDxeDataBase (
854 VOID
855 )
856 {
857 PEI_PCD_DATABASE *PeiDatabase;
858 EFI_HOB_GUID_TYPE *GuidHob;
859 UINTN Index;
860 UINT32 PcdDxeDbLen;
861 VOID *PcdDxeDb;
862 EFI_STATUS Status;
863
864 //
865 // Assign PCD Entries with default value to PCD DATABASE
866 //
867 mPcdDatabase.DxeDb = LocateExPcdBinary ();
868 ASSERT (mPcdDatabase.DxeDb != NULL);
869 PcdDxeDbLen = mPcdDatabase.DxeDb->Length + mPcdDatabase.DxeDb->UninitDataBaseSize;
870 PcdDxeDb = AllocateZeroPool (PcdDxeDbLen);
871 ASSERT (PcdDxeDb != NULL);
872 CopyMem (PcdDxeDb, mPcdDatabase.DxeDb, mPcdDatabase.DxeDb->Length);
873 mPcdDatabase.DxeDb = PcdDxeDb;
874
875 GuidHob = GetFirstGuidHob (&gPcdDataBaseHobGuid);
876 if (GuidHob != NULL) {
877 //
878 // If no PEIMs use dynamic Pcd Entry, the Pcd Service PEIM
879 // should not be included at all. So the GuidHob could
880 // be NULL. If it is NULL, we just copy over the DXE Default
881 // Value to PCD Database.
882 //
883 PeiDatabase = (PEI_PCD_DATABASE *)GET_GUID_HOB_DATA (GuidHob);
884
885 //
886 // Get next one that stores full PEI data
887 //
888 GuidHob = GetNextGuidHob (&gPcdDataBaseHobGuid, GET_NEXT_HOB (GuidHob));
889 if (GuidHob != NULL) {
890 mPeiPcdDbBinary = (PEI_PCD_DATABASE *)GET_GUID_HOB_DATA (GuidHob);
891 mPeiPcdDbSize = (UINTN)GET_GUID_HOB_DATA_SIZE (GuidHob);
892 }
893
894 //
895 // Assign PCD Entries refereneced in PEI phase to PCD DATABASE
896 //
897 mPcdDatabase.PeiDb = PeiDatabase;
898 //
899 // Inherit the SystemSkuId from PEI phase.
900 //
901 if (mPcdDatabase.PeiDb->SystemSkuId != 0) {
902 Status = UpdatePcdDatabase (mPcdDatabase.PeiDb->SystemSkuId, FALSE);
903 ASSERT_EFI_ERROR (Status);
904 }
905
906 mPcdDatabase.DxeDb->SystemSkuId = mPcdDatabase.PeiDb->SystemSkuId;
907 } else {
908 mPcdDatabase.PeiDb = AllocateZeroPool (sizeof (PEI_PCD_DATABASE));
909 ASSERT (mPcdDatabase.PeiDb != NULL);
910 }
911
912 //
913 // Initialized the external PCD database local variables
914 //
915 mPeiLocalTokenCount = mPcdDatabase.PeiDb->LocalTokenCount;
916 mDxeLocalTokenCount = mPcdDatabase.DxeDb->LocalTokenCount;
917
918 mPeiExMapppingTableSize = mPcdDatabase.PeiDb->ExTokenCount * sizeof (DYNAMICEX_MAPPING);
919 mDxeExMapppingTableSize = mPcdDatabase.DxeDb->ExTokenCount * sizeof (DYNAMICEX_MAPPING);
920 mPeiGuidTableSize = mPcdDatabase.PeiDb->GuidTableCount * sizeof (GUID);
921 mDxeGuidTableSize = mPcdDatabase.DxeDb->GuidTableCount * sizeof (GUID);
922
923 mPcdTotalTokenCount = mPeiLocalTokenCount + mDxeLocalTokenCount;
924 mPeiNexTokenCount = mPeiLocalTokenCount - mPcdDatabase.PeiDb->ExTokenCount;
925 mDxeNexTokenCount = mDxeLocalTokenCount - mPcdDatabase.DxeDb->ExTokenCount;
926
927 mPeiExMapTableEmpty = (mPcdDatabase.PeiDb->ExTokenCount == 0) ? TRUE : FALSE;
928 mDxeExMapTableEmpty = (mPcdDatabase.DxeDb->ExTokenCount == 0) ? TRUE : FALSE;
929 mPeiDatabaseEmpty = (mPeiLocalTokenCount == 0) ? TRUE : FALSE;
930
931 TmpTokenSpaceBufferCount = mPcdDatabase.PeiDb->ExTokenCount + mPcdDatabase.DxeDb->ExTokenCount;
932 TmpTokenSpaceBuffer = (EFI_GUID **)AllocateZeroPool (TmpTokenSpaceBufferCount * sizeof (EFI_GUID *));
933
934 //
935 // Initialized the Callback Function Table
936 //
937 mCallbackFnTable = AllocateZeroPool (mPcdTotalTokenCount * sizeof (LIST_ENTRY));
938 ASSERT (mCallbackFnTable != NULL);
939
940 //
941 // EBC compiler is very choosy. It may report warning about comparison
942 // between UINTN and 0 . So we add 1 in each size of the
943 // comparison.
944 //
945 for (Index = 0; Index + 1 < mPcdTotalTokenCount + 1; Index++) {
946 InitializeListHead (&mCallbackFnTable[Index]);
947 }
948 }
949
950 /**
951 Get Variable which contains HII type PCD entry.
952
953 @param VariableGuid Variable's guid
954 @param VariableName Variable's unicode name string
955 @param VariableData Variable's data pointer,
956 @param VariableSize Variable's size.
957
958 @return the status of gRT->GetVariable
959 **/
960 EFI_STATUS
961 GetHiiVariable (
962 IN EFI_GUID *VariableGuid,
963 IN UINT16 *VariableName,
964 OUT UINT8 **VariableData,
965 OUT UINTN *VariableSize
966 )
967 {
968 UINTN Size;
969 EFI_STATUS Status;
970 UINT8 *Buffer;
971
972 Size = 0;
973 Buffer = NULL;
974
975 //
976 // Firstly get the real size of HII variable
977 //
978 Status = gRT->GetVariable (
979 (UINT16 *)VariableName,
980 VariableGuid,
981 NULL,
982 &Size,
983 Buffer
984 );
985
986 //
987 // Allocate buffer to hold whole variable data according to variable size.
988 //
989 if (Status == EFI_BUFFER_TOO_SMALL) {
990 Buffer = (UINT8 *)AllocatePool (Size);
991
992 ASSERT (Buffer != NULL);
993
994 Status = gRT->GetVariable (
995 VariableName,
996 VariableGuid,
997 NULL,
998 &Size,
999 Buffer
1000 );
1001
1002 ASSERT (Status == EFI_SUCCESS);
1003 *VariableData = Buffer;
1004 *VariableSize = Size;
1005 } else {
1006 //
1007 // Use Default Data only when variable is not found.
1008 // For other error status, correct data can't be got, and trig ASSERT().
1009 //
1010 ASSERT (Status == EFI_NOT_FOUND);
1011 }
1012
1013 return Status;
1014 }
1015
1016 /**
1017 Invoke the callback function when dynamic PCD entry was set, if this PCD entry
1018 has registered callback function.
1019
1020 @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx
1021 type PCD.
1022 @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type
1023 PCD.
1024 @param TokenNumber PCD token number generated by build tools.
1025 @param Data Value want to be set for this PCD entry
1026 @param Size The size of value
1027
1028 **/
1029 VOID
1030 InvokeCallbackOnSet (
1031 UINT32 ExTokenNumber,
1032 CONST EFI_GUID *Guid OPTIONAL,
1033 UINTN TokenNumber,
1034 VOID *Data,
1035 UINTN Size
1036 )
1037 {
1038 CALLBACK_FN_ENTRY *FnTableEntry;
1039 LIST_ENTRY *ListHead;
1040 LIST_ENTRY *ListNode;
1041
1042 //
1043 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
1044 // We have to decrement TokenNumber by 1 to make it usable
1045 // as the array index of mCallbackFnTable[].
1046 //
1047 ListHead = &mCallbackFnTable[TokenNumber - 1];
1048 ListNode = GetFirstNode (ListHead);
1049
1050 while (ListNode != ListHead) {
1051 FnTableEntry = CR_FNENTRY_FROM_LISTNODE (ListNode, CALLBACK_FN_ENTRY, Node);
1052
1053 FnTableEntry->CallbackFn (
1054 Guid,
1055 (Guid == NULL) ? TokenNumber : ExTokenNumber,
1056 Data,
1057 Size
1058 );
1059
1060 ListNode = GetNextNode (ListHead, ListNode);
1061 }
1062
1063 return;
1064 }
1065
1066 /**
1067 Wrapper function for setting non-pointer type value for a PCD entry.
1068
1069 @param TokenNumber Pcd token number autogenerated by build tools.
1070 @param Data Value want to be set for PCD entry
1071 @param Size Size of value.
1072
1073 @return status of SetWorker.
1074
1075 **/
1076 EFI_STATUS
1077 SetValueWorker (
1078 IN UINTN TokenNumber,
1079 IN VOID *Data,
1080 IN UINTN Size
1081 )
1082 {
1083 return SetWorker (TokenNumber, Data, &Size, FALSE);
1084 }
1085
1086 /**
1087 Set value for an PCD entry
1088
1089 @param TokenNumber Pcd token number autogenerated by build tools.
1090 @param Data Value want to be set for PCD entry
1091 @param Size Size of value.
1092 @param PtrType If TRUE, the type of PCD entry's value is Pointer.
1093 If False, the type of PCD entry's value is not Pointer.
1094
1095 @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.
1096 @retval EFI_INVALID_PARAMETER If Size can not be set to size table.
1097 @retval EFI_INVALID_PARAMETER If Size of non-Ptr type PCD does not match the size information in PCD database.
1098 @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in
1099 range of UINT8, UINT16, UINT32, UINT64
1100 @retval EFI_NOT_FOUND Can not find the PCD type according to token number.
1101 **/
1102 EFI_STATUS
1103 SetWorker (
1104 IN UINTN TokenNumber,
1105 IN VOID *Data,
1106 IN OUT UINTN *Size,
1107 IN BOOLEAN PtrType
1108 )
1109 {
1110 BOOLEAN IsPeiDb;
1111 UINT32 LocalTokenNumber;
1112 EFI_GUID *GuidTable;
1113 UINT8 *StringTable;
1114 EFI_GUID *Guid;
1115 UINT16 *Name;
1116 UINTN VariableOffset;
1117 UINT32 Attributes;
1118 VOID *InternalData;
1119 VARIABLE_HEAD *VariableHead;
1120 UINTN Offset;
1121 UINT8 *PcdDb;
1122 EFI_STATUS Status;
1123 UINTN MaxSize;
1124 UINTN TmpTokenNumber;
1125
1126 //
1127 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
1128 // We have to decrement TokenNumber by 1 to make it usable
1129 // as the array index.
1130 //
1131 TokenNumber--;
1132
1133 TmpTokenNumber = TokenNumber;
1134
1135 //
1136 // EBC compiler is very choosy. It may report warning about comparison
1137 // between UINTN and 0 . So we add 1 in each size of the
1138 // comparison.
1139 //
1140 ASSERT (TokenNumber + 1 < mPcdTotalTokenCount + 1);
1141
1142 if (PtrType) {
1143 //
1144 // Get MaxSize first, then check new size with max buffer size.
1145 //
1146 GetPtrTypeSize (TokenNumber, &MaxSize);
1147 if (*Size > MaxSize) {
1148 *Size = MaxSize;
1149 return EFI_INVALID_PARAMETER;
1150 }
1151 } else {
1152 if (*Size != DxePcdGetSize (TokenNumber + 1)) {
1153 return EFI_INVALID_PARAMETER;
1154 }
1155 }
1156
1157 //
1158 // EBC compiler is very choosy. It may report warning about comparison
1159 // between UINTN and 0 . So we add 1 in each size of the
1160 // comparison.
1161 //
1162 if ((TokenNumber + 1 < mPeiNexTokenCount + 1) ||
1163 ((TokenNumber + 1 >= mPeiLocalTokenCount + 1) && (TokenNumber + 1 < (mPeiLocalTokenCount + mDxeNexTokenCount + 1))))
1164 {
1165 InvokeCallbackOnSet (0, NULL, TokenNumber + 1, Data, *Size);
1166 }
1167
1168 //
1169 // Aquire lock to prevent reentrance from TPL_CALLBACK level
1170 //
1171 EfiAcquireLock (&mPcdDatabaseLock);
1172
1173 //
1174 // EBC compiler is very choosy. It may report warning about comparison
1175 // between UINTN and 0 . So we add 1 in each size of the
1176 // comparison.
1177 //
1178 IsPeiDb = (BOOLEAN)((TokenNumber + 1 < mPeiLocalTokenCount + 1) ? TRUE : FALSE);
1179
1180 LocalTokenNumber = GetLocalTokenNumber (IsPeiDb, TokenNumber + 1);
1181
1182 Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;
1183
1184 PcdDb = IsPeiDb ? ((UINT8 *)mPcdDatabase.PeiDb) : ((UINT8 *)mPcdDatabase.DxeDb);
1185
1186 if (IsPeiDb) {
1187 StringTable = (UINT8 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->StringTableOffset);
1188 } else {
1189 StringTable = (UINT8 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->StringTableOffset);
1190 }
1191
1192 InternalData = PcdDb + Offset;
1193
1194 switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {
1195 case PCD_TYPE_VPD:
1196 ASSERT (FALSE);
1197 Status = EFI_INVALID_PARAMETER;
1198 break;
1199
1200 case PCD_TYPE_STRING:
1201 if (SetPtrTypeSize (TmpTokenNumber, Size)) {
1202 CopyMem (StringTable + *((STRING_HEAD *)InternalData), Data, *Size);
1203 Status = EFI_SUCCESS;
1204 } else {
1205 Status = EFI_INVALID_PARAMETER;
1206 }
1207
1208 break;
1209
1210 case PCD_TYPE_HII|PCD_TYPE_STRING:
1211 case PCD_TYPE_HII:
1212 if (PtrType) {
1213 if (!SetPtrTypeSize (TmpTokenNumber, Size)) {
1214 Status = EFI_INVALID_PARAMETER;
1215 break;
1216 }
1217 }
1218
1219 if (IsPeiDb) {
1220 GuidTable = (EFI_GUID *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->GuidTableOffset);
1221 } else {
1222 GuidTable = (EFI_GUID *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->GuidTableOffset);
1223 }
1224
1225 VariableHead = (VARIABLE_HEAD *)(PcdDb + Offset);
1226
1227 Guid = GuidTable + VariableHead->GuidTableIndex;
1228 Name = (UINT16 *)(StringTable + VariableHead->StringIndex);
1229 VariableOffset = VariableHead->Offset;
1230 Attributes = VariableHead->Attributes;
1231 Status = SetHiiVariable (Guid, Name, Attributes, Data, *Size, VariableOffset);
1232 break;
1233
1234 case PCD_TYPE_DATA:
1235 if (PtrType) {
1236 if (SetPtrTypeSize (TmpTokenNumber, Size)) {
1237 CopyMem (InternalData, Data, *Size);
1238 Status = EFI_SUCCESS;
1239 } else {
1240 Status = EFI_INVALID_PARAMETER;
1241 }
1242
1243 break;
1244 }
1245
1246 Status = EFI_SUCCESS;
1247 switch (*Size) {
1248 case sizeof (UINT8):
1249 *((UINT8 *)InternalData) = *((UINT8 *)Data);
1250 break;
1251
1252 case sizeof (UINT16):
1253 *((UINT16 *)InternalData) = *((UINT16 *)Data);
1254 break;
1255
1256 case sizeof (UINT32):
1257 *((UINT32 *)InternalData) = *((UINT32 *)Data);
1258 break;
1259
1260 case sizeof (UINT64):
1261 *((UINT64 *)InternalData) = *((UINT64 *)Data);
1262 break;
1263
1264 default:
1265 ASSERT (FALSE);
1266 Status = EFI_NOT_FOUND;
1267 break;
1268 }
1269
1270 break;
1271
1272 default:
1273 ASSERT (FALSE);
1274 Status = EFI_NOT_FOUND;
1275 break;
1276 }
1277
1278 EfiReleaseLock (&mPcdDatabaseLock);
1279
1280 return Status;
1281 }
1282
1283 /**
1284 Wrapper function for get PCD value for dynamic-ex PCD.
1285
1286 @param Guid Token space guid for dynamic-ex PCD.
1287 @param ExTokenNumber Token number for dynamic-ex PCD.
1288 @param GetSize The size of dynamic-ex PCD value.
1289
1290 @return PCD entry in PCD database.
1291
1292 **/
1293 VOID *
1294 ExGetWorker (
1295 IN CONST EFI_GUID *Guid,
1296 IN UINTN ExTokenNumber,
1297 IN UINTN GetSize
1298 )
1299 {
1300 return GetWorker (GetExPcdTokenNumber (Guid, (UINT32)ExTokenNumber), GetSize);
1301 }
1302
1303 /**
1304 Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.
1305
1306 @param ExTokenNumber Token number for dynamic-ex PCD.
1307 @param Guid Token space guid for dynamic-ex PCD.
1308 @param Data Value want to be set.
1309 @param SetSize The size of value.
1310
1311 @return status of ExSetWorker().
1312
1313 **/
1314 EFI_STATUS
1315 ExSetValueWorker (
1316 IN UINTN ExTokenNumber,
1317 IN CONST EFI_GUID *Guid,
1318 IN VOID *Data,
1319 IN UINTN SetSize
1320 )
1321 {
1322 return ExSetWorker (ExTokenNumber, Guid, Data, &SetSize, FALSE);
1323 }
1324
1325 /**
1326 Set value for a dynamic-ex PCD entry.
1327
1328 This routine find the local token number according to dynamic-ex PCD's token
1329 space guid and token number firstly, and invoke callback function if this PCD
1330 entry registered callback function. Finally, invoken general SetWorker to set
1331 PCD value.
1332
1333 @param ExTokenNumber Dynamic-ex PCD token number.
1334 @param Guid Token space guid for dynamic-ex PCD.
1335 @param Data PCD value want to be set
1336 @param SetSize Size of value.
1337 @param PtrType If TRUE, this PCD entry is pointer type.
1338 If FALSE, this PCD entry is not pointer type.
1339
1340 @return status of SetWorker().
1341
1342 **/
1343 EFI_STATUS
1344 ExSetWorker (
1345 IN UINTN ExTokenNumber,
1346 IN CONST EFI_GUID *Guid,
1347 IN VOID *Data,
1348 IN OUT UINTN *SetSize,
1349 IN BOOLEAN PtrType
1350 )
1351 {
1352 UINTN TokenNumber;
1353
1354 TokenNumber = GetExPcdTokenNumber (Guid, (UINT32)ExTokenNumber);
1355
1356 InvokeCallbackOnSet ((UINT32)ExTokenNumber, Guid, TokenNumber, Data, *SetSize);
1357
1358 return SetWorker (TokenNumber, Data, SetSize, PtrType);
1359 }
1360
1361 /**
1362 Get variable size and data from HII-type PCDs.
1363
1364 @param[in] VariableGuid Guid of variable which stored value of a HII-type PCD.
1365 @param[in] VariableName Unicode name of variable which stored value of a HII-type PCD.
1366 @param[out] VariableSize Pointer to variable size got from HII-type PCDs.
1367 @param[out] VariableData Pointer to variable data got from HII-type PCDs.
1368
1369 **/
1370 VOID
1371 GetVariableSizeAndDataFromHiiPcd (
1372 IN EFI_GUID *VariableGuid,
1373 IN UINT16 *VariableName,
1374 OUT UINTN *VariableSize,
1375 OUT VOID *VariableData OPTIONAL
1376 )
1377 {
1378 BOOLEAN IsPeiDb;
1379 PCD_DATABASE_INIT *Database;
1380 UINTN TokenNumber;
1381 UINT32 LocalTokenNumber;
1382 UINTN Offset;
1383 EFI_GUID *GuidTable;
1384 UINT8 *StringTable;
1385 VARIABLE_HEAD *VariableHead;
1386 EFI_GUID *Guid;
1387 UINT16 *Name;
1388 UINTN PcdDataSize;
1389 UINTN Size;
1390 UINT8 *VaraiableDefaultBuffer;
1391 STRING_HEAD StringTableIdx;
1392
1393 *VariableSize = 0;
1394
1395 //
1396 // Go through PCD database to find out DynamicHii PCDs.
1397 //
1398 for (TokenNumber = 1; TokenNumber <= mPcdTotalTokenCount; TokenNumber++) {
1399 IsPeiDb = (BOOLEAN)((TokenNumber + 1 < mPeiLocalTokenCount + 1) ? TRUE : FALSE);
1400 Database = IsPeiDb ? mPcdDatabase.PeiDb : mPcdDatabase.DxeDb;
1401 LocalTokenNumber = GetLocalTokenNumber (IsPeiDb, TokenNumber);
1402 if ((LocalTokenNumber & PCD_TYPE_HII) != 0) {
1403 //
1404 // Get the Variable Guid and Name pointer.
1405 //
1406 Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;
1407 VariableHead = (VARIABLE_HEAD *)((UINT8 *)Database + Offset);
1408 StringTable = (UINT8 *)((UINT8 *)Database + Database->StringTableOffset);
1409 GuidTable = (EFI_GUID *)((UINT8 *)Database + Database->GuidTableOffset);
1410 Guid = GuidTable + VariableHead->GuidTableIndex;
1411 Name = (UINT16 *)(StringTable + VariableHead->StringIndex);
1412 if (CompareGuid (VariableGuid, Guid) && (StrCmp (VariableName, Name) == 0)) {
1413 //
1414 // It is the matched DynamicHii PCD.
1415 //
1416 PcdDataSize = DxePcdGetSize (TokenNumber);
1417 Size = VariableHead->Offset + PcdDataSize;
1418 if (Size > *VariableSize) {
1419 *VariableSize = Size;
1420 }
1421
1422 if (VariableData != NULL) {
1423 if ((LocalTokenNumber & PCD_TYPE_ALL_SET) == (PCD_TYPE_HII|PCD_TYPE_STRING)) {
1424 //
1425 // If a HII type PCD's datum type is VOID*, the DefaultValueOffset is the index of
1426 // string array in string table.
1427 //
1428 StringTableIdx = *(STRING_HEAD *)((UINT8 *)Database + VariableHead->DefaultValueOffset);
1429 VaraiableDefaultBuffer = (UINT8 *)(StringTable + StringTableIdx);
1430 } else {
1431 VaraiableDefaultBuffer = (UINT8 *)Database + VariableHead->DefaultValueOffset;
1432 }
1433
1434 CopyMem ((UINT8 *)VariableData + VariableHead->Offset, VaraiableDefaultBuffer, PcdDataSize);
1435 }
1436 }
1437 }
1438 }
1439 }
1440
1441 /**
1442 Set value for HII-type PCD.
1443
1444 A HII-type PCD's value is stored in a variable. Setting/Getting the value of
1445 HII-type PCD is to visit this variable.
1446
1447 @param VariableGuid Guid of variable which stored value of a HII-type PCD.
1448 @param VariableName Unicode name of variable which stored value of a HII-type PCD.
1449 @param SetAttributes Attributes bitmask to set for the variable.
1450 @param Data Value want to be set.
1451 @param DataSize Size of value
1452 @param Offset Value offset of HII-type PCD in variable.
1453
1454 @return status of GetVariable()/SetVariable().
1455
1456 **/
1457 EFI_STATUS
1458 SetHiiVariable (
1459 IN EFI_GUID *VariableGuid,
1460 IN UINT16 *VariableName,
1461 IN UINT32 SetAttributes,
1462 IN CONST VOID *Data,
1463 IN UINTN DataSize,
1464 IN UINTN Offset
1465 )
1466 {
1467 UINTN Size;
1468 VOID *Buffer;
1469 EFI_STATUS Status;
1470 UINT32 Attribute;
1471 UINTN SetSize;
1472
1473 Size = 0;
1474 SetSize = 0;
1475
1476 //
1477 // Try to get original variable size information.
1478 //
1479 Status = gRT->GetVariable (
1480 (UINT16 *)VariableName,
1481 VariableGuid,
1482 NULL,
1483 &Size,
1484 NULL
1485 );
1486
1487 if (Status == EFI_BUFFER_TOO_SMALL) {
1488 //
1489 // Patch new PCD's value to offset in given HII variable.
1490 //
1491 if (Size >= (DataSize + Offset)) {
1492 SetSize = Size;
1493 } else {
1494 SetSize = DataSize + Offset;
1495 }
1496
1497 Buffer = AllocatePool (SetSize);
1498 ASSERT (Buffer != NULL);
1499
1500 Status = gRT->GetVariable (
1501 VariableName,
1502 VariableGuid,
1503 &Attribute,
1504 &Size,
1505 Buffer
1506 );
1507
1508 ASSERT_EFI_ERROR (Status);
1509
1510 CopyMem ((UINT8 *)Buffer + Offset, Data, DataSize);
1511
1512 if (SetAttributes == 0) {
1513 SetAttributes = Attribute;
1514 }
1515
1516 Status = gRT->SetVariable (
1517 VariableName,
1518 VariableGuid,
1519 SetAttributes,
1520 SetSize,
1521 Buffer
1522 );
1523
1524 FreePool (Buffer);
1525 return Status;
1526 } else if (Status == EFI_NOT_FOUND) {
1527 //
1528 // If variable does not exist, a new variable need to be created.
1529 //
1530
1531 //
1532 // Get size, allocate buffer and get data.
1533 //
1534 GetVariableSizeAndDataFromHiiPcd (VariableGuid, VariableName, &Size, NULL);
1535 Buffer = AllocateZeroPool (Size);
1536 ASSERT (Buffer != NULL);
1537 GetVariableSizeAndDataFromHiiPcd (VariableGuid, VariableName, &Size, Buffer);
1538
1539 //
1540 // Update buffer.
1541 //
1542 CopyMem ((UINT8 *)Buffer + Offset, Data, DataSize);
1543
1544 if (SetAttributes == 0) {
1545 SetAttributes = EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE;
1546 }
1547
1548 Status = gRT->SetVariable (
1549 VariableName,
1550 VariableGuid,
1551 SetAttributes,
1552 Size,
1553 Buffer
1554 );
1555
1556 FreePool (Buffer);
1557 return Status;
1558 }
1559
1560 //
1561 // If we drop to here, the value is failed to be written in to variable area.
1562 //
1563 return Status;
1564 }
1565
1566 /**
1567 Get Token Number according to dynamic-ex PCD's {token space guid:token number}
1568
1569 A dynamic-ex type PCD, developer must provide pair of token space guid: token number
1570 in DEC file. PCD database maintain a mapping table that translate pair of {token
1571 space guid: token number} to Token Number.
1572
1573 @param Guid Token space guid for dynamic-ex PCD entry.
1574 @param ExTokenNumber Dynamic-ex PCD token number.
1575
1576 @return Token Number for dynamic-ex PCD.
1577
1578 **/
1579 UINTN
1580 GetExPcdTokenNumber (
1581 IN CONST EFI_GUID *Guid,
1582 IN UINT32 ExTokenNumber
1583 )
1584 {
1585 UINT32 Index;
1586 DYNAMICEX_MAPPING *ExMap;
1587 EFI_GUID *GuidTable;
1588 EFI_GUID *MatchGuid;
1589 UINTN MatchGuidIdx;
1590
1591 if (!mPeiDatabaseEmpty) {
1592 ExMap = (DYNAMICEX_MAPPING *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->ExMapTableOffset);
1593 GuidTable = (EFI_GUID *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->GuidTableOffset);
1594
1595 MatchGuid = ScanGuid (GuidTable, mPeiGuidTableSize, Guid);
1596
1597 if (MatchGuid != NULL) {
1598 MatchGuidIdx = MatchGuid - GuidTable;
1599
1600 for (Index = 0; Index < mPcdDatabase.PeiDb->ExTokenCount; Index++) {
1601 if ((ExTokenNumber == ExMap[Index].ExTokenNumber) &&
1602 (MatchGuidIdx == ExMap[Index].ExGuidIndex))
1603 {
1604 return ExMap[Index].TokenNumber;
1605 }
1606 }
1607 }
1608 }
1609
1610 ExMap = (DYNAMICEX_MAPPING *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->ExMapTableOffset);
1611 GuidTable = (EFI_GUID *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->GuidTableOffset);
1612
1613 MatchGuid = ScanGuid (GuidTable, mDxeGuidTableSize, Guid);
1614 //
1615 // We need to ASSERT here. If GUID can't be found in GuidTable, this is a
1616 // error in the BUILD system.
1617 //
1618 ASSERT (MatchGuid != NULL);
1619
1620 MatchGuidIdx = MatchGuid - GuidTable;
1621
1622 for (Index = 0; Index < mPcdDatabase.DxeDb->ExTokenCount; Index++) {
1623 if ((ExTokenNumber == ExMap[Index].ExTokenNumber) &&
1624 (MatchGuidIdx == ExMap[Index].ExGuidIndex))
1625 {
1626 return ExMap[Index].TokenNumber;
1627 }
1628 }
1629
1630 DEBUG ((DEBUG_ERROR, "%a: Failed to find PCD with GUID: %g and token number: %d\n", __FUNCTION__, Guid, ExTokenNumber));
1631 ASSERT (FALSE);
1632
1633 return 0;
1634 }
1635
1636 /**
1637 Wrapper function of getting index of PCD entry in size table.
1638
1639 @param LocalTokenNumberTableIdx Index of this PCD in local token number table.
1640 @param IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
1641 If FALSE, the pcd entry is initialized in DXE phase.
1642
1643 @return index of PCD entry in size table.
1644 **/
1645 UINTN
1646 GetSizeTableIndex (
1647 IN UINTN LocalTokenNumberTableIdx,
1648 IN BOOLEAN IsPeiDb
1649 )
1650 {
1651 UINT32 *LocalTokenNumberTable;
1652 UINTN LocalTokenNumber;
1653 UINTN Index;
1654 UINTN SizeTableIdx;
1655
1656 if (IsPeiDb) {
1657 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->LocalTokenNumberTableOffset);
1658 } else {
1659 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->LocalTokenNumberTableOffset);
1660 }
1661
1662 SizeTableIdx = 0;
1663
1664 for (Index = 0; Index < LocalTokenNumberTableIdx; Index++) {
1665 LocalTokenNumber = LocalTokenNumberTable[Index];
1666
1667 if ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER) {
1668 //
1669 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1670 // PCD entry.
1671 //
1672 if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {
1673 //
1674 // We have only two entry for VPD enabled PCD entry:
1675 // 1) MAX Size.
1676 // 2) Current Size
1677 // Current size is equal to MAX size.
1678 //
1679 SizeTableIdx += 2;
1680 } else {
1681 //
1682 // We have only two entry for Non-Sku enabled PCD entry:
1683 // 1) MAX SIZE
1684 // 2) Current Size
1685 //
1686 SizeTableIdx += 2;
1687 }
1688 }
1689 }
1690
1691 return SizeTableIdx;
1692 }
1693
1694 /**
1695 Get size of POINTER type PCD value.
1696
1697 @param LocalTokenNumberTableIdx Index of local token number in local token number table.
1698 @param MaxSize Maxmium size of POINTER type PCD value.
1699
1700 @return size of POINTER type PCD value.
1701
1702 **/
1703 UINTN
1704 GetPtrTypeSize (
1705 IN UINTN LocalTokenNumberTableIdx,
1706 OUT UINTN *MaxSize
1707 )
1708 {
1709 INTN SizeTableIdx;
1710 UINTN LocalTokenNumber;
1711 SIZE_INFO *SizeTable;
1712 BOOLEAN IsPeiDb;
1713 UINT32 *LocalTokenNumberTable;
1714
1715 // EBC compiler is very choosy. It may report warning about comparison
1716 // between UINTN and 0 . So we add 1 in each size of the
1717 // comparison.
1718 IsPeiDb = (BOOLEAN)(LocalTokenNumberTableIdx + 1 < mPeiLocalTokenCount + 1);
1719
1720 if (IsPeiDb) {
1721 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->LocalTokenNumberTableOffset);
1722 SizeTable = (SIZE_INFO *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->SizeTableOffset);
1723 } else {
1724 LocalTokenNumberTableIdx -= mPeiLocalTokenCount;
1725 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->LocalTokenNumberTableOffset);
1726 SizeTable = (SIZE_INFO *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->SizeTableOffset);
1727 }
1728
1729 LocalTokenNumber = LocalTokenNumberTable[LocalTokenNumberTableIdx];
1730
1731 ASSERT ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER);
1732
1733 SizeTableIdx = GetSizeTableIndex (LocalTokenNumberTableIdx, IsPeiDb);
1734
1735 *MaxSize = SizeTable[SizeTableIdx];
1736 //
1737 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1738 // PCD entry.
1739 //
1740 if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {
1741 //
1742 // We have only two entry for VPD enabled PCD entry:
1743 // 1) MAX Size.
1744 // 2) Current Size
1745 // We consider current size is equal to MAX size.
1746 //
1747 return *MaxSize;
1748 } else {
1749 //
1750 // We have only two entry for Non-Sku enabled PCD entry:
1751 // 1) MAX SIZE
1752 // 2) Current Size
1753 //
1754 return SizeTable[SizeTableIdx + 1];
1755 }
1756 }
1757
1758 /**
1759 Set size of POINTER type PCD value. The size should not exceed the maximum size
1760 of this PCD value.
1761
1762 @param LocalTokenNumberTableIdx Index of local token number in local token number table.
1763 @param CurrentSize Size of POINTER type PCD value.
1764
1765 @retval TRUE Success to set size of PCD value.
1766 @retval FALSE Fail to set size of PCD value.
1767 **/
1768 BOOLEAN
1769 SetPtrTypeSize (
1770 IN UINTN LocalTokenNumberTableIdx,
1771 IN OUT UINTN *CurrentSize
1772 )
1773 {
1774 INTN SizeTableIdx;
1775 UINTN LocalTokenNumber;
1776 SIZE_INFO *SizeTable;
1777 UINTN MaxSize;
1778 BOOLEAN IsPeiDb;
1779 UINT32 *LocalTokenNumberTable;
1780
1781 //
1782 // EBC compiler is very choosy. It may report warning about comparison
1783 // between UINTN and 0 . So we add 1 in each size of the
1784 // comparison.
1785 //
1786 IsPeiDb = (BOOLEAN)(LocalTokenNumberTableIdx + 1 < mPeiLocalTokenCount + 1);
1787
1788 if (IsPeiDb) {
1789 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->LocalTokenNumberTableOffset);
1790 SizeTable = (SIZE_INFO *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->SizeTableOffset);
1791 } else {
1792 LocalTokenNumberTableIdx -= mPeiLocalTokenCount;
1793 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->LocalTokenNumberTableOffset);
1794 SizeTable = (SIZE_INFO *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->SizeTableOffset);
1795 }
1796
1797 LocalTokenNumber = LocalTokenNumberTable[LocalTokenNumberTableIdx];
1798
1799 ASSERT ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER);
1800
1801 SizeTableIdx = GetSizeTableIndex (LocalTokenNumberTableIdx, IsPeiDb);
1802
1803 MaxSize = SizeTable[SizeTableIdx];
1804 //
1805 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1806 // PCD entry.
1807 //
1808 if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {
1809 //
1810 // We shouldn't come here as we don't support SET for VPD
1811 //
1812 ASSERT (FALSE);
1813 return FALSE;
1814 } else {
1815 if ((*CurrentSize > MaxSize) ||
1816 (*CurrentSize == MAX_ADDRESS))
1817 {
1818 *CurrentSize = MaxSize;
1819 return FALSE;
1820 }
1821
1822 //
1823 // We have only two entry for Non-Sku enabled PCD entry:
1824 // 1) MAX SIZE
1825 // 2) Current Size
1826 //
1827 SizeTable[SizeTableIdx + 1] = (SIZE_INFO)*CurrentSize;
1828 return TRUE;
1829 }
1830 }
1831
1832 /**
1833 VariableLock DynamicHiiPcd.
1834
1835 @param[in] IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
1836 If FALSE, the pcd entry is initialized in DXE phase.
1837 @param[in] VariableLock Pointer to VariableLockProtocol.
1838
1839 **/
1840 VOID
1841 VariableLockDynamicHiiPcd (
1842 IN BOOLEAN IsPeiDb,
1843 IN EDKII_VARIABLE_LOCK_PROTOCOL *VariableLock
1844 )
1845 {
1846 EFI_STATUS Status;
1847 PCD_DATABASE_INIT *Database;
1848 UINT32 LocalTokenCount;
1849 UINTN TokenNumber;
1850 UINT32 LocalTokenNumber;
1851 UINTN Offset;
1852 EFI_GUID *GuidTable;
1853 UINT8 *StringTable;
1854 VARIABLE_HEAD *VariableHead;
1855 EFI_GUID *Guid;
1856 UINT16 *Name;
1857
1858 Database = IsPeiDb ? mPcdDatabase.PeiDb : mPcdDatabase.DxeDb;
1859 LocalTokenCount = IsPeiDb ? mPeiLocalTokenCount : mDxeLocalTokenCount;
1860
1861 //
1862 // Go through PCD database to find out DynamicHii PCDs.
1863 //
1864 for (TokenNumber = 1; TokenNumber <= LocalTokenCount; TokenNumber++) {
1865 if (IsPeiDb) {
1866 LocalTokenNumber = GetLocalTokenNumber (TRUE, TokenNumber);
1867 } else {
1868 LocalTokenNumber = GetLocalTokenNumber (FALSE, TokenNumber + mPeiLocalTokenCount);
1869 }
1870
1871 if ((LocalTokenNumber & PCD_TYPE_HII) != 0) {
1872 Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;
1873 VariableHead = (VARIABLE_HEAD *)((UINT8 *)Database + Offset);
1874 //
1875 // Why not to set property by VarCheckProtocol with Attributes and Property directly here?
1876 // It is because that set property by VarCheckProtocol will indicate the variable to
1877 // be a system variable, but the unknown max size of the variable is dangerous to
1878 // the system variable region.
1879 //
1880 if ((VariableHead->Property & VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY) != 0) {
1881 //
1882 // DynamicHii PCD with RO property set in *.dsc.
1883 //
1884 StringTable = (UINT8 *)((UINT8 *)Database + Database->StringTableOffset);
1885 GuidTable = (EFI_GUID *)((UINT8 *)Database + Database->GuidTableOffset);
1886 Guid = GuidTable + VariableHead->GuidTableIndex;
1887 Name = (UINT16 *)(StringTable + VariableHead->StringIndex);
1888 Status = VariableLock->RequestToLock (VariableLock, Name, Guid);
1889 ASSERT_EFI_ERROR (Status);
1890 }
1891 }
1892 }
1893 }
1894
1895 /**
1896 VariableLockProtocol callback
1897 to lock the variables referenced by DynamicHii PCDs with RO property set in *.dsc.
1898
1899 @param[in] Event Event whose notification function is being invoked.
1900 @param[in] Context Pointer to the notification function's context.
1901
1902 **/
1903 VOID
1904 EFIAPI
1905 VariableLockCallBack (
1906 IN EFI_EVENT Event,
1907 IN VOID *Context
1908 )
1909 {
1910 EFI_STATUS Status;
1911 EDKII_VARIABLE_LOCK_PROTOCOL *VariableLock;
1912
1913 Status = gBS->LocateProtocol (&gEdkiiVariableLockProtocolGuid, NULL, (VOID **)&VariableLock);
1914 if (!EFI_ERROR (Status)) {
1915 VariableLockDynamicHiiPcd (TRUE, VariableLock);
1916 VariableLockDynamicHiiPcd (FALSE, VariableLock);
1917 }
1918 }