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