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