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