]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/PCD/Dxe/Service.c
513402cad91f1b591b44926258ead587ee541586
[mirror_edk2.git] / MdeModulePkg / Universal / PCD / Dxe / Service.c
1 /** @file
2 Help functions used by PCD DXE driver.
3
4 Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #include "Service.h"
16 #include <Library/DxeServicesLib.h>
17
18 PCD_DATABASE mPcdDatabase;
19
20 UINT32 mPcdTotalTokenCount;
21 UINT32 mPeiLocalTokenCount;
22 UINT32 mDxeLocalTokenCount;
23 UINT32 mPeiNexTokenCount;
24 UINT32 mDxeNexTokenCount;
25 UINT32 mPeiExMapppingTableSize;
26 UINT32 mDxeExMapppingTableSize;
27 UINT32 mPeiGuidTableSize;
28 UINT32 mDxeGuidTableSize;
29
30 BOOLEAN mPeiExMapTableEmpty;
31 BOOLEAN mDxeExMapTableEmpty;
32 BOOLEAN mPeiDatabaseEmpty;
33
34 LIST_ENTRY *mCallbackFnTable;
35 EFI_GUID **TmpTokenSpaceBuffer;
36 UINTN TmpTokenSpaceBufferCount;
37
38
39 /**
40 Get the PCD entry pointer in PCD database.
41
42 This routine will visit PCD database to find the PCD entry according to given
43 token number. The given token number is autogened by build tools and it will be
44 translated to local token number. Local token number contains PCD's type and
45 offset of PCD entry in PCD database.
46
47 @param TokenNumber Token's number, it is autogened by build tools
48 @param GetSize The size of token's value
49
50 @return PCD entry pointer in PCD database
51
52 **/
53 VOID *
54 GetWorker (
55 IN UINTN TokenNumber,
56 IN UINTN GetSize
57 )
58 {
59 UINT32 *LocalTokenNumberTable;
60 EFI_GUID *GuidTable;
61 UINT8 *StringTable;
62 EFI_GUID *Guid;
63 UINT16 *Name;
64 VARIABLE_HEAD *VariableHead;
65 UINT8 *VaraiableDefaultBuffer;
66 UINT8 *Data;
67 VPD_HEAD *VpdHead;
68 UINT8 *PcdDb;
69 VOID *RetPtr;
70 UINTN MaxSize;
71 UINTN TmpTokenNumber;
72 UINTN DataSize;
73 EFI_STATUS Status;
74 UINT32 LocalTokenNumber;
75 UINT32 Offset;
76 STRING_HEAD StringTableIdx;
77 BOOLEAN IsPeiDb;
78
79 //
80 // Aquire lock to prevent reentrance from TPL_CALLBACK level
81 //
82 EfiAcquireLock (&mPcdDatabaseLock);
83
84 RetPtr = NULL;
85
86 ASSERT (TokenNumber > 0);
87 //
88 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
89 // We have to decrement TokenNumber by 1 to make it usable
90 // as the array index.
91 //
92 TokenNumber--;
93
94 TmpTokenNumber = TokenNumber;
95
96 //
97 // EBC compiler is very choosy. It may report warning about comparison
98 // between UINTN and 0 . So we add 1 in each size of the
99 // comparison.
100 //
101 ASSERT (TokenNumber + 1 < mPcdTotalTokenCount + 1);
102
103 ASSERT ((GetSize == DxePcdGetSize (TokenNumber + 1)) || (GetSize == 0));
104
105 // EBC compiler is very choosy. It may report warning about comparison
106 // between UINTN and 0 . So we add 1 in each size of the
107 // comparison.
108 IsPeiDb = (BOOLEAN) ((TokenNumber + 1 < mPeiLocalTokenCount + 1) ? TRUE : FALSE);
109
110 LocalTokenNumberTable = IsPeiDb ? (UINT32 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->LocalTokenNumberTableOffset) :
111 (UINT32 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->LocalTokenNumberTableOffset);
112
113 TokenNumber = IsPeiDb ? TokenNumber :
114 TokenNumber - mPeiLocalTokenCount;
115
116 LocalTokenNumber = LocalTokenNumberTable[TokenNumber];
117
118 if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == PCD_TYPE_SKU_ENABLED) {
119 if (GetSize == 0) {
120 GetPtrTypeSize (TmpTokenNumber, &MaxSize);
121 } else {
122 MaxSize = GetSize;
123 }
124 LocalTokenNumber = GetSkuEnabledTokenNumber (LocalTokenNumber & ~PCD_TYPE_SKU_ENABLED, MaxSize, IsPeiDb);
125 }
126
127 PcdDb = IsPeiDb ? ((UINT8 *) mPcdDatabase.PeiDb) : ((UINT8 *) mPcdDatabase.DxeDb);
128
129 if (IsPeiDb) {
130 StringTable = (UINT8 *) ((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->StringTableOffset);
131 } else {
132 StringTable = (UINT8 *) ((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->StringTableOffset);
133 }
134
135
136 Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;
137
138 switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {
139 case PCD_TYPE_VPD:
140 VpdHead = (VPD_HEAD *) ((UINT8 *) PcdDb + Offset);
141 RetPtr = (VOID *) (UINTN) (PcdGet32 (PcdVpdBaseAddress) + VpdHead->Offset);
142
143 break;
144
145 case PCD_TYPE_HII|PCD_TYPE_STRING:
146 case PCD_TYPE_HII:
147 if (IsPeiDb) {
148 GuidTable = (EFI_GUID *) ((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->GuidTableOffset);
149 } else {
150 GuidTable = (EFI_GUID *) ((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->GuidTableOffset);
151 }
152
153 VariableHead = (VARIABLE_HEAD *) (PcdDb + Offset);
154 Guid = GuidTable + VariableHead->GuidTableIndex;
155 Name = (UINT16*)(StringTable + VariableHead->StringIndex);
156
157 if ((LocalTokenNumber & PCD_TYPE_ALL_SET) == (PCD_TYPE_HII|PCD_TYPE_STRING)) {
158 //
159 // If a HII type PCD's datum type is VOID*, the DefaultValueOffset is the index of
160 // string array in string table.
161 //
162 StringTableIdx = *(STRING_HEAD*)((UINT8 *) PcdDb + VariableHead->DefaultValueOffset);
163 VaraiableDefaultBuffer = (VOID *) (StringTable + StringTableIdx);
164 } else {
165 VaraiableDefaultBuffer = (UINT8 *) PcdDb + VariableHead->DefaultValueOffset;
166 }
167 Status = GetHiiVariable (Guid, Name, &Data, &DataSize);
168 if (Status == EFI_SUCCESS) {
169 if (GetSize == 0) {
170 //
171 // It is a pointer type. So get the MaxSize reserved for
172 // this PCD entry.
173 //
174 GetPtrTypeSize (TmpTokenNumber, &GetSize);
175 }
176 //
177 // If the operation is successful, we copy the data
178 // to the default value buffer in the PCD Database.
179 // So that we can free the Data allocated in GetHiiVariable.
180 //
181 CopyMem (VaraiableDefaultBuffer, Data + VariableHead->Offset, GetSize);
182 FreePool (Data);
183 }
184 RetPtr = (VOID *) VaraiableDefaultBuffer;
185 break;
186
187 case PCD_TYPE_STRING:
188 StringTableIdx = *(STRING_HEAD*)((UINT8 *) PcdDb + Offset);
189 RetPtr = (VOID *) (StringTable + StringTableIdx);
190 break;
191
192 case PCD_TYPE_DATA:
193 RetPtr = (VOID *) ((UINT8 *) PcdDb + Offset);
194 break;
195
196 default:
197 ASSERT (FALSE);
198 break;
199
200 }
201
202 EfiReleaseLock (&mPcdDatabaseLock);
203
204 return RetPtr;
205
206 }
207
208 /**
209 Register the callback function for a PCD entry.
210
211 This routine will register a callback function to a PCD entry by given token number
212 and token space guid.
213
214 @param TokenNumber PCD token's number, it is autogened by build tools.
215 @param Guid PCD token space's guid,
216 if not NULL, this PCD is dynamicEx type PCD.
217 @param CallBackFunction Callback function pointer
218
219 @return EFI_SUCCESS Always success for registering callback function.
220
221 **/
222 EFI_STATUS
223 DxeRegisterCallBackWorker (
224 IN UINTN TokenNumber,
225 IN CONST EFI_GUID *Guid, OPTIONAL
226 IN PCD_PROTOCOL_CALLBACK CallBackFunction
227 )
228 {
229 CALLBACK_FN_ENTRY *FnTableEntry;
230 LIST_ENTRY *ListHead;
231 LIST_ENTRY *ListNode;
232
233 if (Guid != NULL) {
234 TokenNumber = GetExPcdTokenNumber (Guid, (UINT32) TokenNumber);
235 }
236
237 //
238 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
239 // We have to decrement TokenNumber by 1 to make it usable
240 // as the array index of mCallbackFnTable[].
241 //
242 ListHead = &mCallbackFnTable[TokenNumber - 1];
243 ListNode = GetFirstNode (ListHead);
244
245 while (ListNode != ListHead) {
246 FnTableEntry = CR_FNENTRY_FROM_LISTNODE(ListNode, CALLBACK_FN_ENTRY, Node);
247
248 if (FnTableEntry->CallbackFn == CallBackFunction) {
249 //
250 // We only allow a Callback function to be register once
251 // for a TokenNumber. So just return EFI_SUCCESS
252 //
253 return EFI_SUCCESS;
254 }
255 ListNode = GetNextNode (ListHead, ListNode);
256 }
257
258 FnTableEntry = AllocatePool (sizeof(CALLBACK_FN_ENTRY));
259 ASSERT (FnTableEntry != NULL);
260
261 FnTableEntry->CallbackFn = CallBackFunction;
262 InsertTailList (ListHead, &FnTableEntry->Node);
263
264 return EFI_SUCCESS;
265 }
266
267 /**
268 UnRegister the callback function for a PCD entry.
269
270 This routine will unregister a callback function to a PCD entry by given token number
271 and token space guid.
272
273 @param TokenNumber PCD token's number, it is autogened by build tools.
274 @param Guid PCD token space's guid.
275 if not NULL, this PCD is dynamicEx type PCD.
276 @param CallBackFunction Callback function pointer
277
278 @retval EFI_SUCCESS Callback function is success to be unregister.
279 @retval EFI_INVALID_PARAMETER Can not find the PCD entry by given token number.
280 **/
281 EFI_STATUS
282 DxeUnRegisterCallBackWorker (
283 IN UINTN TokenNumber,
284 IN CONST EFI_GUID *Guid, OPTIONAL
285 IN PCD_PROTOCOL_CALLBACK CallBackFunction
286 )
287 {
288 CALLBACK_FN_ENTRY *FnTableEntry;
289 LIST_ENTRY *ListHead;
290 LIST_ENTRY *ListNode;
291
292 if (Guid != NULL) {
293 TokenNumber = GetExPcdTokenNumber (Guid, (UINT32) TokenNumber);
294 }
295
296 //
297 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
298 // We have to decrement TokenNumber by 1 to make it usable
299 // as the array index of mCallbackFnTable[].
300 //
301 ListHead = &mCallbackFnTable[TokenNumber - 1];
302 ListNode = GetFirstNode (ListHead);
303
304 while (ListNode != ListHead) {
305 FnTableEntry = CR_FNENTRY_FROM_LISTNODE(ListNode, CALLBACK_FN_ENTRY, Node);
306
307 if (FnTableEntry->CallbackFn == CallBackFunction) {
308 //
309 // We only allow a Callback function to be register once
310 // for a TokenNumber. So we can safely remove the Node from
311 // the Link List and return EFI_SUCCESS.
312 //
313 RemoveEntryList (ListNode);
314 FreePool (FnTableEntry);
315
316 return EFI_SUCCESS;
317 }
318 ListNode = GetNextNode (ListHead, ListNode);
319 }
320
321 return EFI_INVALID_PARAMETER;
322 }
323
324 /**
325 Get next token number in given token space.
326
327 This routine is used for dynamicEx type PCD. It will firstly scan token space
328 table to get token space according to given token space guid. Then scan given
329 token number in found token space, if found, then return next token number in
330 this token space.
331
332 @param Guid Token space guid. Next token number will be scaned in
333 this token space.
334 @param TokenNumber Token number.
335 If PCD_INVALID_TOKEN_NUMBER, return first token number in
336 token space table.
337 If not PCD_INVALID_TOKEN_NUMBER, return next token number
338 in token space table.
339 @param GuidTable Token space guid table. It will be used for scan token space
340 by given token space guid.
341 @param SizeOfGuidTable The size of guid table.
342 @param ExMapTable DynamicEx token number mapping table.
343 @param SizeOfExMapTable The size of dynamicEx token number mapping table.
344
345 @retval EFI_NOT_FOUND Can not given token space or token number.
346 @retval EFI_SUCCESS Success to get next token number.
347
348 **/
349 EFI_STATUS
350 ExGetNextTokeNumber (
351 IN CONST EFI_GUID *Guid,
352 IN OUT UINTN *TokenNumber,
353 IN EFI_GUID *GuidTable,
354 IN UINTN SizeOfGuidTable,
355 IN DYNAMICEX_MAPPING *ExMapTable,
356 IN UINTN SizeOfExMapTable
357 )
358 {
359 EFI_GUID *MatchGuid;
360 UINTN Index;
361 UINTN GuidTableIdx;
362 BOOLEAN Found;
363 UINTN ExMapTableCount;
364
365 //
366 // Scan token space guid
367 //
368 MatchGuid = ScanGuid (GuidTable, SizeOfGuidTable, Guid);
369 if (MatchGuid == NULL) {
370 return EFI_NOT_FOUND;
371 }
372
373 //
374 // Find the token space table in dynamicEx mapping table.
375 //
376 Found = FALSE;
377 GuidTableIdx = MatchGuid - GuidTable;
378 ExMapTableCount = SizeOfExMapTable / sizeof(ExMapTable[0]);
379 for (Index = 0; Index < ExMapTableCount; Index++) {
380 if (ExMapTable[Index].ExGuidIndex == GuidTableIdx) {
381 Found = TRUE;
382 break;
383 }
384 }
385
386 if (Found) {
387 //
388 // If given token number is PCD_INVALID_TOKEN_NUMBER, then return the first
389 // token number in found token space.
390 //
391 if (*TokenNumber == PCD_INVALID_TOKEN_NUMBER) {
392 *TokenNumber = ExMapTable[Index].ExTokenNumber;
393 return EFI_SUCCESS;
394 }
395
396 for ( ; Index < ExMapTableCount; Index++) {
397 if (ExMapTable[Index].ExTokenNumber == *TokenNumber) {
398 break;
399 }
400 }
401
402 while (Index < ExMapTableCount) {
403 Index++;
404 if (Index == ExMapTableCount) {
405 //
406 // Exceed the length of ExMap Table
407 //
408 *TokenNumber = PCD_INVALID_TOKEN_NUMBER;
409 return EFI_NOT_FOUND;
410 } else if (ExMapTable[Index].ExGuidIndex == GuidTableIdx) {
411 //
412 // Found the next match
413 //
414 *TokenNumber = ExMapTable[Index].ExTokenNumber;
415 return EFI_SUCCESS;
416 }
417 }
418 }
419
420 return EFI_NOT_FOUND;
421 }
422
423 /**
424 Find the PCD database.
425
426 @retval The base address of external PCD database binary.
427 @retval NULL Return NULL if not find.
428 **/
429 DXE_PCD_DATABASE *
430 LocateExPcdBinary (
431 VOID
432 )
433 {
434 DXE_PCD_DATABASE *DxePcdDbBinary;
435 UINTN DxePcdDbSize;
436 EFI_STATUS Status;
437
438 DxePcdDbBinary = NULL;
439 //
440 // Search the External Pcd database from one section of current FFS,
441 // and read it to memory
442 //
443 Status = GetSectionFromFfs (
444 EFI_SECTION_RAW,
445 0,
446 (VOID **) &DxePcdDbBinary,
447 &DxePcdDbSize
448 );
449 ASSERT_EFI_ERROR (Status);
450
451 //
452 // Check the first bytes (Header Signature Guid) and build version.
453 //
454 if (!CompareGuid ((VOID *)DxePcdDbBinary, &gPcdDataBaseSignatureGuid) ||
455 (DxePcdDbBinary->BuildVersion != PCD_SERVICE_DXE_VERSION)) {
456 ASSERT (FALSE);
457 }
458
459 return DxePcdDbBinary;
460 }
461
462 /**
463 Initialize the PCD database in DXE phase.
464
465 PCD database in DXE phase also contains PCD database in PEI phase which is copied
466 from GUID Hob.
467
468 **/
469 VOID
470 BuildPcdDxeDataBase (
471 VOID
472 )
473 {
474 PEI_PCD_DATABASE *PeiDatabase;
475 EFI_HOB_GUID_TYPE *GuidHob;
476 UINTN Index;
477 UINT32 PcdDxeDbLen;
478 VOID *PcdDxeDb;
479
480 GuidHob = GetFirstGuidHob (&gPcdDataBaseHobGuid);
481 if (GuidHob != NULL) {
482
483 //
484 // If no PEIMs use dynamic Pcd Entry, the Pcd Service PEIM
485 // should not be included at all. So the GuidHob could
486 // be NULL. If it is NULL, we just copy over the DXE Default
487 // Value to PCD Database.
488 //
489
490 PeiDatabase = (PEI_PCD_DATABASE *) GET_GUID_HOB_DATA (GuidHob);
491 //
492 // Assign PCD Entries refereneced in PEI phase to PCD DATABASE
493 //
494 mPcdDatabase.PeiDb = PeiDatabase;
495 }
496
497 //
498 // Assign PCD Entries with default value to PCD DATABASE
499 //
500 mPcdDatabase.DxeDb = LocateExPcdBinary ();
501 ASSERT(mPcdDatabase.DxeDb != NULL);
502 PcdDxeDbLen = mPcdDatabase.DxeDb->Length + mPcdDatabase.DxeDb->UninitDataBaseSize;
503 PcdDxeDb = AllocateZeroPool (PcdDxeDbLen);
504 CopyMem (PcdDxeDb, mPcdDatabase.DxeDb, mPcdDatabase.DxeDb->Length);
505 FreePool (mPcdDatabase.DxeDb);
506 mPcdDatabase.DxeDb = PcdDxeDb;
507
508 //
509 // Initialized the external PCD database local variables
510 //
511 mPeiLocalTokenCount = mPcdDatabase.PeiDb->LocalTokenCount;
512 mDxeLocalTokenCount = mPcdDatabase.DxeDb->LocalTokenCount;
513
514 mPeiExMapppingTableSize = mPcdDatabase.PeiDb->ExTokenCount * sizeof (DYNAMICEX_MAPPING);
515 mDxeExMapppingTableSize = mPcdDatabase.DxeDb->ExTokenCount * sizeof (DYNAMICEX_MAPPING);
516 mPeiGuidTableSize = mPcdDatabase.PeiDb->GuidTableCount * sizeof(GUID);
517 mDxeGuidTableSize = mPcdDatabase.DxeDb->GuidTableCount * sizeof (GUID);
518
519 mPcdTotalTokenCount = mPeiLocalTokenCount + mDxeLocalTokenCount;
520 mPeiNexTokenCount = mPeiLocalTokenCount - mPcdDatabase.PeiDb->ExTokenCount;
521 mDxeNexTokenCount = mDxeLocalTokenCount - mPcdDatabase.DxeDb->ExTokenCount;
522
523 mPeiExMapTableEmpty = (mPcdDatabase.PeiDb->ExTokenCount == 0) ? TRUE : FALSE;
524 mDxeExMapTableEmpty = (mPcdDatabase.DxeDb->ExTokenCount == 0) ? TRUE : FALSE;
525 mPeiDatabaseEmpty = (mPeiLocalTokenCount == 0) ? TRUE : FALSE;
526
527 TmpTokenSpaceBufferCount = mPcdDatabase.PeiDb->ExTokenCount + mPcdDatabase.DxeDb->ExTokenCount;
528 TmpTokenSpaceBuffer = (EFI_GUID **)AllocateZeroPool(TmpTokenSpaceBufferCount * sizeof (EFI_GUID *));
529
530 //
531 // Initialized the Callback Function Table
532 //
533 mCallbackFnTable = AllocateZeroPool (mPcdTotalTokenCount * sizeof (LIST_ENTRY));
534 ASSERT(mCallbackFnTable != NULL);
535
536 //
537 // EBC compiler is very choosy. It may report warning about comparison
538 // between UINTN and 0 . So we add 1 in each size of the
539 // comparison.
540 //
541 for (Index = 0; Index + 1 < mPcdTotalTokenCount + 1; Index++) {
542 InitializeListHead (&mCallbackFnTable[Index]);
543 }
544 }
545
546 /**
547 Get Variable which contains HII type PCD entry.
548
549 @param VariableGuid Variable's guid
550 @param VariableName Variable's unicode name string
551 @param VariableData Variable's data pointer,
552 @param VariableSize Variable's size.
553
554 @return the status of gRT->GetVariable
555 **/
556 EFI_STATUS
557 GetHiiVariable (
558 IN EFI_GUID *VariableGuid,
559 IN UINT16 *VariableName,
560 OUT UINT8 **VariableData,
561 OUT UINTN *VariableSize
562 )
563 {
564 UINTN Size;
565 EFI_STATUS Status;
566 UINT8 *Buffer;
567
568 Size = 0;
569 Buffer = NULL;
570
571 //
572 // Firstly get the real size of HII variable
573 //
574 Status = gRT->GetVariable (
575 (UINT16 *)VariableName,
576 VariableGuid,
577 NULL,
578 &Size,
579 Buffer
580 );
581
582 //
583 // Allocate buffer to hold whole variable data according to variable size.
584 //
585 if (Status == EFI_BUFFER_TOO_SMALL) {
586 Buffer = (UINT8 *) AllocatePool (Size);
587
588 ASSERT (Buffer != NULL);
589
590 Status = gRT->GetVariable (
591 VariableName,
592 VariableGuid,
593 NULL,
594 &Size,
595 Buffer
596 );
597
598 ASSERT (Status == EFI_SUCCESS);
599 *VariableData = Buffer;
600 *VariableSize = Size;
601 } else {
602 //
603 // Use Default Data only when variable is not found.
604 // For other error status, correct data can't be got, and trig ASSERT().
605 //
606 ASSERT (Status == EFI_NOT_FOUND);
607 }
608
609 return Status;
610 }
611
612 /**
613 Find the local token number according to system SKU ID.
614
615 @param LocalTokenNumber PCD token number
616 @param Size The size of PCD entry.
617 @param IsPeiDb If TRUE, the PCD entry is initialized in PEI phase.
618 If False, the PCD entry is initialized in DXE phase.
619
620 @return Token number according to system SKU ID.
621
622 **/
623 UINT32
624 GetSkuEnabledTokenNumber (
625 UINT32 LocalTokenNumber,
626 UINTN Size,
627 BOOLEAN IsPeiDb
628 )
629 {
630 SKU_HEAD *SkuHead;
631 SKU_ID *SkuIdTable;
632 INTN Index;
633 UINT8 *Value;
634 UINT8 *PcdDb;
635 BOOLEAN FoundSku;
636
637 ASSERT ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == 0);
638
639 PcdDb = IsPeiDb ? (UINT8 *) mPcdDatabase.PeiDb : (UINT8 *) mPcdDatabase.DxeDb;
640
641 SkuHead = (SKU_HEAD *) (PcdDb + (LocalTokenNumber & PCD_DATABASE_OFFSET_MASK));
642 Value = (UINT8 *) (PcdDb + SkuHead->SkuDataStartOffset);
643
644 SkuIdTable = (SKU_ID *)(PcdDb + SkuHead->SkuIdTableOffset);
645 //
646 // Find the current system's SKU ID entry in SKU ID table.
647 //
648 FoundSku = FALSE;
649 for (Index = 0; Index < SkuIdTable[0]; Index++) {
650 if (mPcdDatabase.PeiDb->SystemSkuId == SkuIdTable[Index + 1]) {
651 FoundSku = TRUE;
652 break;
653 }
654 }
655
656 //
657 // Find the default SKU ID entry in SKU ID table.
658 //
659
660 if(!FoundSku) {
661 for (Index = 0; Index < SkuIdTable[0]; Index++) {
662 if (0 == SkuIdTable[Index + 1]) {
663 break;
664 }
665 }
666 }
667 ASSERT (Index < SkuIdTable[0]);
668
669 switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {
670 case PCD_TYPE_VPD:
671 Value = (UINT8 *) &(((VPD_HEAD *) Value)[Index]);
672 return (UINT32) ((Value - PcdDb) | PCD_TYPE_VPD);
673
674 case PCD_TYPE_HII:
675 Value = (UINT8 *) &(((VARIABLE_HEAD *) Value)[Index]);
676 return (UINT32) ((Value - PcdDb) | PCD_TYPE_HII);
677
678 case PCD_TYPE_HII|PCD_TYPE_STRING:
679 Value = (UINT8 *) &(((VARIABLE_HEAD *) Value)[Index]);
680 return (UINT32) ((Value - PcdDb) | PCD_TYPE_HII | PCD_TYPE_STRING);
681
682 case PCD_TYPE_STRING:
683 Value = (UINT8 *) &(((STRING_HEAD *) Value)[Index]);
684 return (UINT32) ((Value - PcdDb) | PCD_TYPE_STRING);
685
686 case PCD_TYPE_DATA:
687 Value += Size * Index;
688 return (UINT32) ((Value - PcdDb) | PCD_TYPE_DATA);
689
690 default:
691 ASSERT (FALSE);
692 }
693
694 ASSERT (FALSE);
695
696 return 0;
697
698 }
699
700 /**
701 Invoke the callback function when dynamic PCD entry was set, if this PCD entry
702 has registered callback function.
703
704 @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx
705 type PCD.
706 @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type
707 PCD.
708 @param TokenNumber PCD token number generated by build tools.
709 @param Data Value want to be set for this PCD entry
710 @param Size The size of value
711
712 **/
713 VOID
714 InvokeCallbackOnSet (
715 UINT32 ExTokenNumber,
716 CONST EFI_GUID *Guid, OPTIONAL
717 UINTN TokenNumber,
718 VOID *Data,
719 UINTN Size
720 )
721 {
722 CALLBACK_FN_ENTRY *FnTableEntry;
723 LIST_ENTRY *ListHead;
724 LIST_ENTRY *ListNode;
725
726 //
727 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
728 // We have to decrement TokenNumber by 1 to make it usable
729 // as the array index of mCallbackFnTable[].
730 //
731 ListHead = &mCallbackFnTable[TokenNumber - 1];
732 ListNode = GetFirstNode (ListHead);
733
734 while (ListNode != ListHead) {
735 FnTableEntry = CR_FNENTRY_FROM_LISTNODE (ListNode, CALLBACK_FN_ENTRY, Node);
736
737 FnTableEntry->CallbackFn(Guid,
738 (Guid == NULL) ? TokenNumber : ExTokenNumber,
739 Data,
740 Size);
741
742 ListNode = GetNextNode (ListHead, ListNode);
743 }
744
745 return;
746 }
747
748
749 /**
750 Wrapper function for setting non-pointer type value for a PCD entry.
751
752 @param TokenNumber Pcd token number autogenerated by build tools.
753 @param Data Value want to be set for PCD entry
754 @param Size Size of value.
755
756 @return status of SetWorker.
757
758 **/
759 EFI_STATUS
760 SetValueWorker (
761 IN UINTN TokenNumber,
762 IN VOID *Data,
763 IN UINTN Size
764 )
765 {
766 return SetWorker (TokenNumber, Data, &Size, FALSE);
767 }
768
769
770 /**
771 Set value for an PCD entry
772
773 @param TokenNumber Pcd token number autogenerated by build tools.
774 @param Data Value want to be set for PCD entry
775 @param Size Size of value.
776 @param PtrType If TRUE, the type of PCD entry's value is Pointer.
777 If False, the type of PCD entry's value is not Pointer.
778
779 @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.
780 @retval EFI_INVALID_PARAMETER If Size can not be set to size table.
781 @retval EFI_INVALID_PARAMETER If Size of non-Ptr type PCD does not match the size information in PCD database.
782 @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in
783 range of UINT8, UINT16, UINT32, UINT64
784 @retval EFI_NOT_FOUND Can not find the PCD type according to token number.
785 **/
786 EFI_STATUS
787 SetWorker (
788 IN UINTN TokenNumber,
789 IN VOID *Data,
790 IN OUT UINTN *Size,
791 IN BOOLEAN PtrType
792 )
793 {
794 UINT32 *LocalTokenNumberTable;
795 BOOLEAN IsPeiDb;
796 UINT32 LocalTokenNumber;
797 EFI_GUID *GuidTable;
798 UINT8 *StringTable;
799 EFI_GUID *Guid;
800 UINT16 *Name;
801 UINTN VariableOffset;
802 VOID *InternalData;
803 VARIABLE_HEAD *VariableHead;
804 UINTN Offset;
805 UINT8 *PcdDb;
806 EFI_STATUS Status;
807 UINTN MaxSize;
808 UINTN TmpTokenNumber;
809
810 //
811 // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.
812 // We have to decrement TokenNumber by 1 to make it usable
813 // as the array index.
814 //
815 TokenNumber--;
816
817 TmpTokenNumber = TokenNumber;
818
819 //
820 // EBC compiler is very choosy. It may report warning about comparison
821 // between UINTN and 0 . So we add 1 in each size of the
822 // comparison.
823 //
824 ASSERT (TokenNumber + 1 < mPcdTotalTokenCount + 1);
825
826 if (PtrType) {
827 //
828 // Get MaxSize first, then check new size with max buffer size.
829 //
830 GetPtrTypeSize (TokenNumber, &MaxSize);
831 if (*Size > MaxSize) {
832 *Size = MaxSize;
833 return EFI_INVALID_PARAMETER;
834 }
835 } else {
836 if (*Size != DxePcdGetSize (TokenNumber + 1)) {
837 return EFI_INVALID_PARAMETER;
838 }
839 }
840
841 //
842 // EBC compiler is very choosy. It may report warning about comparison
843 // between UINTN and 0 . So we add 1 in each size of the
844 // comparison.
845 //
846 if ((TokenNumber + 1 < mPeiNexTokenCount + 1) ||
847 (TokenNumber + 1 >= mPeiLocalTokenCount + 1 && TokenNumber + 1 < (mPeiLocalTokenCount + mDxeNexTokenCount + 1))) {
848 InvokeCallbackOnSet (0, NULL, TokenNumber + 1, Data, *Size);
849 }
850
851 //
852 // Aquire lock to prevent reentrance from TPL_CALLBACK level
853 //
854 EfiAcquireLock (&mPcdDatabaseLock);
855
856 //
857 // EBC compiler is very choosy. It may report warning about comparison
858 // between UINTN and 0 . So we add 1 in each size of the
859 // comparison.
860 //
861 IsPeiDb = (BOOLEAN) ((TokenNumber + 1 < mPeiLocalTokenCount + 1) ? TRUE : FALSE);
862
863 LocalTokenNumberTable = IsPeiDb ? (UINT32 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->LocalTokenNumberTableOffset) :
864 (UINT32 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->LocalTokenNumberTableOffset) ;
865
866 TokenNumber = IsPeiDb ? TokenNumber
867 : TokenNumber - mPeiLocalTokenCount;
868
869 LocalTokenNumber = LocalTokenNumberTable[TokenNumber];
870
871 if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == PCD_TYPE_SKU_ENABLED) {
872 if (PtrType) {
873 GetPtrTypeSize (TmpTokenNumber, &MaxSize);
874 } else {
875 MaxSize = *Size;
876 }
877 LocalTokenNumber = GetSkuEnabledTokenNumber (LocalTokenNumber & ~PCD_TYPE_SKU_ENABLED, MaxSize, IsPeiDb);
878 }
879
880 Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;
881
882 PcdDb = IsPeiDb ? ((UINT8 *) mPcdDatabase.PeiDb) : ((UINT8 *) mPcdDatabase.DxeDb);
883
884 if (IsPeiDb) {
885 StringTable = (UINT8 *) ((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->StringTableOffset);
886 } else {
887 StringTable = (UINT8 *) ((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->StringTableOffset);
888 }
889
890
891 InternalData = PcdDb + Offset;
892
893 switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {
894 case PCD_TYPE_VPD:
895 ASSERT (FALSE);
896 Status = EFI_INVALID_PARAMETER;
897 break;
898
899 case PCD_TYPE_STRING:
900 if (SetPtrTypeSize (TmpTokenNumber, Size)) {
901 CopyMem (StringTable + *((STRING_HEAD *)InternalData), Data, *Size);
902 Status = EFI_SUCCESS;
903 } else {
904 Status = EFI_INVALID_PARAMETER;
905 }
906 break;
907
908 case PCD_TYPE_HII|PCD_TYPE_STRING:
909 case PCD_TYPE_HII:
910 if (PtrType) {
911 if (!SetPtrTypeSize (TmpTokenNumber, Size)) {
912 Status = EFI_INVALID_PARAMETER;
913 break;
914 }
915 }
916
917 if (IsPeiDb) {
918 GuidTable = (EFI_GUID *) ((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->GuidTableOffset);
919 } else {
920 GuidTable = (EFI_GUID *) ((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->GuidTableOffset);
921 }
922
923 VariableHead = (VARIABLE_HEAD *) (PcdDb + Offset);
924
925 Guid = GuidTable + VariableHead->GuidTableIndex;
926 Name = (UINT16*) (StringTable + VariableHead->StringIndex);
927 VariableOffset = VariableHead->Offset;
928 Status = SetHiiVariable (Guid, Name, Data, *Size, VariableOffset);
929
930 if (EFI_NOT_FOUND == Status) {
931 if ((LocalTokenNumber & PCD_TYPE_ALL_SET) == (PCD_TYPE_HII|PCD_TYPE_STRING)) {
932 CopyMem (
933 StringTable + *(STRING_HEAD *)(PcdDb + VariableHead->DefaultValueOffset),
934 Data,
935 *Size
936 );
937 } else {
938 CopyMem (PcdDb + VariableHead->DefaultValueOffset, Data, *Size);
939 }
940 Status = EFI_SUCCESS;
941 }
942 break;
943
944 case PCD_TYPE_DATA:
945 if (PtrType) {
946 if (SetPtrTypeSize (TmpTokenNumber, Size)) {
947 CopyMem (InternalData, Data, *Size);
948 Status = EFI_SUCCESS;
949 } else {
950 Status = EFI_INVALID_PARAMETER;
951 }
952 break;
953 }
954
955 Status = EFI_SUCCESS;
956 switch (*Size) {
957 case sizeof(UINT8):
958 *((UINT8 *) InternalData) = *((UINT8 *) Data);
959 break;
960
961 case sizeof(UINT16):
962 *((UINT16 *) InternalData) = *((UINT16 *) Data);
963 break;
964
965 case sizeof(UINT32):
966 *((UINT32 *) InternalData) = *((UINT32 *) Data);
967 break;
968
969 case sizeof(UINT64):
970 *((UINT64 *) InternalData) = *((UINT64 *) Data);
971 break;
972
973 default:
974 ASSERT (FALSE);
975 Status = EFI_NOT_FOUND;
976 break;
977 }
978 break;
979
980 default:
981 ASSERT (FALSE);
982 Status = EFI_NOT_FOUND;
983 break;
984 }
985
986 EfiReleaseLock (&mPcdDatabaseLock);
987
988 return Status;
989 }
990
991 /**
992 Wrapper function for get PCD value for dynamic-ex PCD.
993
994 @param Guid Token space guid for dynamic-ex PCD.
995 @param ExTokenNumber Token number for dynamic-ex PCD.
996 @param GetSize The size of dynamic-ex PCD value.
997
998 @return PCD entry in PCD database.
999
1000 **/
1001 VOID *
1002 ExGetWorker (
1003 IN CONST EFI_GUID *Guid,
1004 IN UINTN ExTokenNumber,
1005 IN UINTN GetSize
1006 )
1007 {
1008 return GetWorker(GetExPcdTokenNumber (Guid, (UINT32) ExTokenNumber), GetSize);
1009 }
1010
1011 /**
1012 Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.
1013
1014 @param ExTokenNumber Token number for dynamic-ex PCD.
1015 @param Guid Token space guid for dynamic-ex PCD.
1016 @param Data Value want to be set.
1017 @param SetSize The size of value.
1018
1019 @return status of ExSetWorker().
1020
1021 **/
1022 EFI_STATUS
1023 ExSetValueWorker (
1024 IN UINTN ExTokenNumber,
1025 IN CONST EFI_GUID *Guid,
1026 IN VOID *Data,
1027 IN UINTN SetSize
1028 )
1029 {
1030 return ExSetWorker (ExTokenNumber, Guid, Data, &SetSize, FALSE);
1031 }
1032
1033 /**
1034 Set value for a dynamic-ex PCD entry.
1035
1036 This routine find the local token number according to dynamic-ex PCD's token
1037 space guid and token number firstly, and invoke callback function if this PCD
1038 entry registered callback function. Finally, invoken general SetWorker to set
1039 PCD value.
1040
1041 @param ExTokenNumber Dynamic-ex PCD token number.
1042 @param Guid Token space guid for dynamic-ex PCD.
1043 @param Data PCD value want to be set
1044 @param SetSize Size of value.
1045 @param PtrType If TRUE, this PCD entry is pointer type.
1046 If FALSE, this PCD entry is not pointer type.
1047
1048 @return status of SetWorker().
1049
1050 **/
1051 EFI_STATUS
1052 ExSetWorker (
1053 IN UINTN ExTokenNumber,
1054 IN CONST EFI_GUID *Guid,
1055 IN VOID *Data,
1056 IN OUT UINTN *SetSize,
1057 IN BOOLEAN PtrType
1058 )
1059 {
1060 UINTN TokenNumber;
1061
1062 TokenNumber = GetExPcdTokenNumber (Guid, (UINT32) ExTokenNumber);
1063
1064 InvokeCallbackOnSet ((UINT32) ExTokenNumber, Guid, TokenNumber, Data, *SetSize);
1065
1066 return SetWorker (TokenNumber, Data, SetSize, PtrType);
1067
1068 }
1069
1070 /**
1071 Set value for HII-type PCD.
1072
1073 A HII-type PCD's value is stored in a variable. Setting/Getting the value of
1074 HII-type PCD is to visit this variable.
1075
1076 @param VariableGuid Guid of variable which stored value of a HII-type PCD.
1077 @param VariableName Unicode name of variable which stored value of a HII-type PCD.
1078 @param Data Value want to be set.
1079 @param DataSize Size of value
1080 @param Offset Value offset of HII-type PCD in variable.
1081
1082 @return status of GetVariable()/SetVariable().
1083
1084 **/
1085 EFI_STATUS
1086 SetHiiVariable (
1087 IN EFI_GUID *VariableGuid,
1088 IN UINT16 *VariableName,
1089 IN CONST VOID *Data,
1090 IN UINTN DataSize,
1091 IN UINTN Offset
1092 )
1093 {
1094 UINTN Size;
1095 VOID *Buffer;
1096 EFI_STATUS Status;
1097 UINT32 Attribute;
1098 UINTN SetSize;
1099
1100 Size = 0;
1101 SetSize = 0;
1102
1103 //
1104 // Try to get original variable size information.
1105 //
1106 Status = gRT->GetVariable (
1107 (UINT16 *)VariableName,
1108 VariableGuid,
1109 NULL,
1110 &Size,
1111 NULL
1112 );
1113
1114 if (Status == EFI_BUFFER_TOO_SMALL) {
1115 //
1116 // Patch new PCD's value to offset in given HII variable.
1117 //
1118 if (Size >= (DataSize + Offset)) {
1119 SetSize = Size;
1120 } else {
1121 SetSize = DataSize + Offset;
1122 }
1123 Buffer = AllocatePool (SetSize);
1124 ASSERT (Buffer != NULL);
1125
1126 Status = gRT->GetVariable (
1127 VariableName,
1128 VariableGuid,
1129 &Attribute,
1130 &Size,
1131 Buffer
1132 );
1133
1134 ASSERT_EFI_ERROR (Status);
1135
1136 CopyMem ((UINT8 *)Buffer + Offset, Data, DataSize);
1137
1138 Status = gRT->SetVariable (
1139 VariableName,
1140 VariableGuid,
1141 Attribute,
1142 SetSize,
1143 Buffer
1144 );
1145
1146 FreePool (Buffer);
1147 return Status;
1148 } else if (Status == EFI_NOT_FOUND) {
1149 //
1150 // If variable does not exist, a new variable need to be created.
1151 //
1152
1153 Size = Offset + DataSize;
1154
1155 Buffer = AllocateZeroPool (Size);
1156 ASSERT (Buffer != NULL);
1157
1158 CopyMem ((UINT8 *)Buffer + Offset, Data, DataSize);
1159
1160 Status = gRT->SetVariable (
1161 VariableName,
1162 VariableGuid,
1163 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,
1164 Size,
1165 Buffer
1166 );
1167
1168 FreePool (Buffer);
1169 return Status;
1170 }
1171
1172 //
1173 // If we drop to here, the value is failed to be written in to variable area
1174 // So, we will save the data in the PCD Database's volatile area.
1175 //
1176 return Status;
1177 }
1178
1179 /**
1180 Get Token Number according to dynamic-ex PCD's {token space guid:token number}
1181
1182 A dynamic-ex type PCD, developer must provide pair of token space guid: token number
1183 in DEC file. PCD database maintain a mapping table that translate pair of {token
1184 space guid: token number} to Token Number.
1185
1186 @param Guid Token space guid for dynamic-ex PCD entry.
1187 @param ExTokenNumber Dynamic-ex PCD token number.
1188
1189 @return Token Number for dynamic-ex PCD.
1190
1191 **/
1192 UINTN
1193 GetExPcdTokenNumber (
1194 IN CONST EFI_GUID *Guid,
1195 IN UINT32 ExTokenNumber
1196 )
1197 {
1198 UINT32 Index;
1199 DYNAMICEX_MAPPING *ExMap;
1200 EFI_GUID *GuidTable;
1201 EFI_GUID *MatchGuid;
1202 UINTN MatchGuidIdx;
1203
1204 if (!mPeiDatabaseEmpty) {
1205 ExMap = (DYNAMICEX_MAPPING *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->ExMapTableOffset);
1206 GuidTable = (EFI_GUID *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->GuidTableOffset);
1207
1208 MatchGuid = ScanGuid (GuidTable, mPeiGuidTableSize, Guid);
1209
1210 if (MatchGuid != NULL) {
1211
1212 MatchGuidIdx = MatchGuid - GuidTable;
1213
1214 for (Index = 0; Index < mPeiExMapppingTableSize; Index++) {
1215 if ((ExTokenNumber == ExMap[Index].ExTokenNumber) &&
1216 (MatchGuidIdx == ExMap[Index].ExGuidIndex)) {
1217 return ExMap[Index].TokenNumber;
1218 }
1219 }
1220 }
1221 }
1222
1223 ExMap = (DYNAMICEX_MAPPING *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->ExMapTableOffset);
1224 GuidTable = (EFI_GUID *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->GuidTableOffset);
1225
1226 MatchGuid = ScanGuid (GuidTable, mDxeGuidTableSize, Guid);
1227 //
1228 // We need to ASSERT here. If GUID can't be found in GuidTable, this is a
1229 // error in the BUILD system.
1230 //
1231 ASSERT (MatchGuid != NULL);
1232
1233 MatchGuidIdx = MatchGuid - GuidTable;
1234
1235 for (Index = 0; Index < mDxeExMapppingTableSize; Index++) {
1236 if ((ExTokenNumber == ExMap[Index].ExTokenNumber) &&
1237 (MatchGuidIdx == ExMap[Index].ExGuidIndex)) {
1238 return ExMap[Index].TokenNumber;
1239 }
1240 }
1241
1242 ASSERT (FALSE);
1243
1244 return 0;
1245 }
1246
1247 /**
1248 Get SKU ID table from PCD database.
1249
1250 @param LocalTokenNumberTableIdx Index of local token number in token number table.
1251 @param IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
1252 If FALSE, the pcd entry is initialized in DXE phase.
1253 @return Pointer to SKU ID array table
1254
1255 **/
1256 SKU_ID *
1257 GetSkuIdArray (
1258 IN UINTN LocalTokenNumberTableIdx,
1259 IN BOOLEAN IsPeiDb
1260 )
1261 {
1262 SKU_HEAD *SkuHead;
1263 UINTN LocalTokenNumber;
1264 UINT8 *Database;
1265
1266 if (IsPeiDb) {
1267 LocalTokenNumber = *((UINT32 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->LocalTokenNumberTableOffset) + LocalTokenNumberTableIdx);
1268 Database = (UINT8 *) mPcdDatabase.PeiDb;
1269 } else {
1270 LocalTokenNumber = *((UINT32 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->LocalTokenNumberTableOffset) + LocalTokenNumberTableIdx);
1271 Database = (UINT8 *) mPcdDatabase.DxeDb;
1272 }
1273
1274 ASSERT ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) != 0);
1275
1276 SkuHead = (SKU_HEAD *) ((UINT8 *)Database + (LocalTokenNumber & PCD_DATABASE_OFFSET_MASK));
1277
1278 return (SKU_ID *) (Database + SkuHead->SkuIdTableOffset);
1279
1280 }
1281
1282 /**
1283 Wrapper function of getting index of PCD entry in size table.
1284
1285 @param LocalTokenNumberTableIdx Index of this PCD in local token number table.
1286 @param IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,
1287 If FALSE, the pcd entry is initialized in DXE phase.
1288
1289 @return index of PCD entry in size table.
1290 **/
1291 UINTN
1292 GetSizeTableIndex (
1293 IN UINTN LocalTokenNumberTableIdx,
1294 IN BOOLEAN IsPeiDb
1295 )
1296 {
1297 UINT32 *LocalTokenNumberTable;
1298 UINTN LocalTokenNumber;
1299 UINTN Index;
1300 UINTN SizeTableIdx;
1301 SKU_ID *SkuIdTable;
1302
1303 if (IsPeiDb) {
1304 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->LocalTokenNumberTableOffset);
1305 } else {
1306 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->LocalTokenNumberTableOffset);
1307 }
1308
1309 SizeTableIdx = 0;
1310
1311 for (Index = 0; Index < LocalTokenNumberTableIdx; Index ++) {
1312 LocalTokenNumber = LocalTokenNumberTable[Index];
1313
1314 if ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER) {
1315 //
1316 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1317 // PCD entry.
1318 //
1319 if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {
1320 //
1321 // We have only two entry for VPD enabled PCD entry:
1322 // 1) MAX Size.
1323 // 2) Current Size
1324 // Current size is equal to MAX size.
1325 //
1326 SizeTableIdx += 2;
1327 } else {
1328 if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == 0) {
1329 //
1330 // We have only two entry for Non-Sku enabled PCD entry:
1331 // 1) MAX SIZE
1332 // 2) Current Size
1333 //
1334 SizeTableIdx += 2;
1335 } else {
1336 //
1337 // We have these entry for SKU enabled PCD entry
1338 // 1) MAX SIZE
1339 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1340 //
1341 SkuIdTable = GetSkuIdArray (Index, IsPeiDb);
1342 SizeTableIdx += (UINTN)*SkuIdTable + 1;
1343 }
1344 }
1345 }
1346
1347 }
1348
1349 return SizeTableIdx;
1350 }
1351
1352 /**
1353 Get size of POINTER type PCD value.
1354
1355 @param LocalTokenNumberTableIdx Index of local token number in local token number table.
1356 @param MaxSize Maxmium size of POINTER type PCD value.
1357
1358 @return size of POINTER type PCD value.
1359
1360 **/
1361 UINTN
1362 GetPtrTypeSize (
1363 IN UINTN LocalTokenNumberTableIdx,
1364 OUT UINTN *MaxSize
1365 )
1366 {
1367 INTN SizeTableIdx;
1368 UINTN LocalTokenNumber;
1369 SKU_ID *SkuIdTable;
1370 SIZE_INFO *SizeTable;
1371 UINTN Index;
1372 BOOLEAN IsPeiDb;
1373 UINT32 *LocalTokenNumberTable;
1374
1375 // EBC compiler is very choosy. It may report warning about comparison
1376 // between UINTN and 0 . So we add 1 in each size of the
1377 // comparison.
1378 IsPeiDb = (BOOLEAN) (LocalTokenNumberTableIdx + 1 < mPeiLocalTokenCount + 1);
1379
1380
1381 if (IsPeiDb) {
1382 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->LocalTokenNumberTableOffset);
1383 SizeTable = (SIZE_INFO *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->SizeTableOffset);
1384 } else {
1385 LocalTokenNumberTableIdx -= mPeiLocalTokenCount;
1386 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->LocalTokenNumberTableOffset);
1387 SizeTable = (SIZE_INFO *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->SizeTableOffset);
1388 }
1389
1390 LocalTokenNumber = LocalTokenNumberTable[LocalTokenNumberTableIdx];
1391
1392 ASSERT ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER);
1393
1394 SizeTableIdx = GetSizeTableIndex (LocalTokenNumberTableIdx, IsPeiDb);
1395
1396 *MaxSize = SizeTable[SizeTableIdx];
1397 //
1398 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1399 // PCD entry.
1400 //
1401 if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {
1402 //
1403 // We have only two entry for VPD enabled PCD entry:
1404 // 1) MAX Size.
1405 // 2) Current Size
1406 // We consider current size is equal to MAX size.
1407 //
1408 return *MaxSize;
1409 } else {
1410 if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == 0) {
1411 //
1412 // We have only two entry for Non-Sku enabled PCD entry:
1413 // 1) MAX SIZE
1414 // 2) Current Size
1415 //
1416 return SizeTable[SizeTableIdx + 1];
1417 } else {
1418 //
1419 // We have these entry for SKU enabled PCD entry
1420 // 1) MAX SIZE
1421 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1422 //
1423 SkuIdTable = GetSkuIdArray (LocalTokenNumberTableIdx, IsPeiDb);
1424 for (Index = 0; Index < SkuIdTable[0]; Index++) {
1425 if (SkuIdTable[1 + Index] == mPcdDatabase.PeiDb->SystemSkuId) {
1426 return SizeTable[SizeTableIdx + 1 + Index];
1427 }
1428 }
1429 return SizeTable[SizeTableIdx + 1];
1430 }
1431 }
1432 }
1433
1434 /**
1435 Set size of POINTER type PCD value. The size should not exceed the maximum size
1436 of this PCD value.
1437
1438 @param LocalTokenNumberTableIdx Index of local token number in local token number table.
1439 @param CurrentSize Size of POINTER type PCD value.
1440
1441 @retval TRUE Success to set size of PCD value.
1442 @retval FALSE Fail to set size of PCD value.
1443 **/
1444 BOOLEAN
1445 SetPtrTypeSize (
1446 IN UINTN LocalTokenNumberTableIdx,
1447 IN OUT UINTN *CurrentSize
1448 )
1449 {
1450 INTN SizeTableIdx;
1451 UINTN LocalTokenNumber;
1452 SKU_ID *SkuIdTable;
1453 SIZE_INFO *SizeTable;
1454 UINTN Index;
1455 UINTN MaxSize;
1456 BOOLEAN IsPeiDb;
1457 UINT32 *LocalTokenNumberTable;
1458
1459 //
1460 // EBC compiler is very choosy. It may report warning about comparison
1461 // between UINTN and 0 . So we add 1 in each size of the
1462 // comparison.
1463 //
1464 IsPeiDb = (BOOLEAN) (LocalTokenNumberTableIdx + 1 < mPeiLocalTokenCount + 1);
1465
1466 if (IsPeiDb) {
1467 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->LocalTokenNumberTableOffset);
1468 SizeTable = (SIZE_INFO *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->SizeTableOffset);
1469 } else {
1470 LocalTokenNumberTableIdx -= mPeiLocalTokenCount;
1471 LocalTokenNumberTable = (UINT32 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->LocalTokenNumberTableOffset);
1472 SizeTable = (SIZE_INFO *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->SizeTableOffset);
1473 }
1474
1475 LocalTokenNumber = LocalTokenNumberTable[LocalTokenNumberTableIdx];
1476
1477 ASSERT ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER);
1478
1479 SizeTableIdx = GetSizeTableIndex (LocalTokenNumberTableIdx, IsPeiDb);
1480
1481 MaxSize = SizeTable[SizeTableIdx];
1482 //
1483 // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type
1484 // PCD entry.
1485 //
1486 if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {
1487 //
1488 // We shouldn't come here as we don't support SET for VPD
1489 //
1490 ASSERT (FALSE);
1491 return FALSE;
1492 } else {
1493 if ((*CurrentSize > MaxSize) ||
1494 (*CurrentSize == MAX_ADDRESS)) {
1495 *CurrentSize = MaxSize;
1496 return FALSE;
1497 }
1498
1499 if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == 0) {
1500 //
1501 // We have only two entry for Non-Sku enabled PCD entry:
1502 // 1) MAX SIZE
1503 // 2) Current Size
1504 //
1505 SizeTable[SizeTableIdx + 1] = (SIZE_INFO) *CurrentSize;
1506 return TRUE;
1507 } else {
1508 //
1509 // We have these entry for SKU enabled PCD entry
1510 // 1) MAX SIZE
1511 // 2) Current Size for each SKU_ID (It is equal to MaxSku).
1512 //
1513 SkuIdTable = GetSkuIdArray (LocalTokenNumberTableIdx, IsPeiDb);
1514 for (Index = 0; Index < SkuIdTable[0]; Index++) {
1515 if (SkuIdTable[1 + Index] == mPcdDatabase.PeiDb->SystemSkuId) {
1516 SizeTable[SizeTableIdx + 1 + Index] = (SIZE_INFO) *CurrentSize;
1517 return TRUE;
1518 }
1519 }
1520 SizeTable[SizeTableIdx + 1] = (SIZE_INFO) *CurrentSize;
1521 return TRUE;
1522 }
1523 }
1524 }