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