]>
Commit | Line | Data |
---|---|---|
80408db0 | 1 | /** @file\r |
5944a83b LG |
2 | The driver internal functions are implmented here.\r |
3 | They build Pei PCD database, and provide access service to PCD database.\r | |
80408db0 | 4 | \r |
419db80b | 5 | Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r |
e5eed7d3 | 6 | This program and the accompanying materials\r |
80408db0 | 7 | are licensed and made available under the terms and conditions of the BSD License\r |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
80408db0 | 14 | **/\r |
80408db0 | 15 | \r |
16 | #include "Service.h"\r | |
17 | \r | |
96d6d004 SZ |
18 | /**\r |
19 | Get Local Token Number by Token Number.\r | |
20 | \r | |
21 | @param[in] Database PCD database.\r | |
22 | @param[in] TokenNumber The PCD token number.\r | |
23 | \r | |
24 | @return Local Token Number.\r | |
25 | **/\r | |
26 | UINT32\r | |
27 | GetLocalTokenNumber (\r | |
28 | IN PEI_PCD_DATABASE *Database,\r | |
29 | IN UINTN TokenNumber\r | |
30 | )\r | |
31 | {\r | |
32 | UINT32 LocalTokenNumber;\r | |
33 | UINTN Size;\r | |
34 | UINTN MaxSize;\r | |
35 | \r | |
36 | //\r | |
37 | // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r | |
38 | // We have to decrement TokenNumber by 1 to make it usable\r | |
39 | // as the array index.\r | |
40 | //\r | |
41 | TokenNumber--;\r | |
42 | \r | |
43 | LocalTokenNumber = *((UINT32 *)((UINT8 *)Database + Database->LocalTokenNumberTableOffset) + TokenNumber);\r | |
44 | \r | |
45 | Size = (LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) >> PCD_DATUM_TYPE_SHIFT;\r | |
46 | \r | |
47 | if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == PCD_TYPE_SKU_ENABLED) {\r | |
48 | if (Size == 0) {\r | |
49 | GetPtrTypeSize (TokenNumber, &MaxSize, Database);\r | |
50 | } else {\r | |
51 | MaxSize = Size;\r | |
52 | }\r | |
53 | LocalTokenNumber = GetSkuEnabledTokenNumber (LocalTokenNumber & ~PCD_TYPE_SKU_ENABLED, MaxSize);\r | |
54 | }\r | |
55 | \r | |
56 | return LocalTokenNumber;\r | |
57 | }\r | |
58 | \r | |
59 | /**\r | |
60 | Get PCD type by Local Token Number.\r | |
61 | \r | |
62 | @param[in] LocalTokenNumber The PCD local token number.\r | |
63 | \r | |
64 | @return PCD type.\r | |
65 | **/\r | |
66 | EFI_PCD_TYPE\r | |
67 | GetPcdType (\r | |
68 | IN UINT32 LocalTokenNumber\r | |
69 | )\r | |
70 | {\r | |
71 | switch (LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) {\r | |
72 | case PCD_DATUM_TYPE_POINTER:\r | |
73 | return EFI_PCD_TYPE_PTR;\r | |
74 | case PCD_DATUM_TYPE_UINT8:\r | |
75 | if (LocalTokenNumber & PCD_DATUM_TYPE_UINT8_BOOLEAN) {\r | |
76 | return EFI_PCD_TYPE_BOOL;\r | |
77 | } else {\r | |
78 | return EFI_PCD_TYPE_8;\r | |
79 | }\r | |
80 | case PCD_DATUM_TYPE_UINT16:\r | |
81 | return EFI_PCD_TYPE_16;\r | |
82 | case PCD_DATUM_TYPE_UINT32:\r | |
83 | return EFI_PCD_TYPE_32;\r | |
84 | case PCD_DATUM_TYPE_UINT64:\r | |
85 | return EFI_PCD_TYPE_64;\r | |
86 | default:\r | |
87 | ASSERT (FALSE);\r | |
88 | return EFI_PCD_TYPE_8;\r | |
89 | }\r | |
90 | }\r | |
91 | \r | |
92 | /**\r | |
93 | Get PCD name.\r | |
94 | \r | |
95 | @param[in] OnlyTokenSpaceName If TRUE, only need to get the TokenSpaceCName.\r | |
96 | If FALSE, need to get the full PCD name.\r | |
97 | @param[in] Database PCD database.\r | |
98 | @param[in] TokenNumber The PCD token number.\r | |
99 | \r | |
100 | @return The TokenSpaceCName or full PCD name.\r | |
101 | **/\r | |
102 | CHAR8 *\r | |
103 | GetPcdName (\r | |
104 | IN BOOLEAN OnlyTokenSpaceName,\r | |
105 | IN PEI_PCD_DATABASE *Database,\r | |
106 | IN UINTN TokenNumber\r | |
107 | )\r | |
108 | {\r | |
109 | UINT8 *StringTable;\r | |
110 | PCD_NAME_INDEX *PcdNameIndex;\r | |
111 | CHAR8 *TokenSpaceName;\r | |
112 | CHAR8 *PcdName;\r | |
113 | CHAR8 *Name;\r | |
114 | \r | |
115 | //\r | |
116 | // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r | |
117 | // We have to decrement TokenNumber by 1 to make it usable\r | |
118 | // as the array index.\r | |
119 | //\r | |
120 | TokenNumber--;\r | |
121 | \r | |
122 | StringTable = (UINT8 *) Database + Database->StringTableOffset;\r | |
123 | \r | |
124 | //\r | |
125 | // Get the PCD name index.\r | |
126 | //\r | |
127 | PcdNameIndex = (PCD_NAME_INDEX *)((UINT8 *) Database + Database->PcdNameTableOffset) + TokenNumber;\r | |
128 | TokenSpaceName = (CHAR8 *)&StringTable[PcdNameIndex->TokenSpaceCNameIndex];\r | |
129 | PcdName = (CHAR8 *)&StringTable[PcdNameIndex->PcdCNameIndex];\r | |
130 | \r | |
131 | if (OnlyTokenSpaceName) {\r | |
132 | //\r | |
133 | // Only need to get the TokenSpaceCName.\r | |
134 | //\r | |
135 | Name = AllocateCopyPool (AsciiStrSize (TokenSpaceName), TokenSpaceName);\r | |
136 | } else {\r | |
137 | //\r | |
138 | // Need to get the full PCD name.\r | |
139 | //\r | |
140 | Name = AllocateZeroPool (AsciiStrSize (TokenSpaceName) + AsciiStrSize (PcdName));\r | |
141 | //\r | |
142 | // Catenate TokenSpaceCName and PcdCName with a '.' to form the full PCD name.\r | |
143 | //\r | |
144 | AsciiStrCat (Name, TokenSpaceName);\r | |
145 | Name[AsciiStrSize (TokenSpaceName) - sizeof (CHAR8)] = '.';\r | |
146 | AsciiStrCat (Name, PcdName); \r | |
147 | }\r | |
148 | \r | |
149 | return Name;\r | |
150 | }\r | |
151 | \r | |
152 | /**\r | |
153 | Retrieve additional information associated with a PCD token.\r | |
154 | \r | |
155 | This includes information such as the type of value the TokenNumber is associated with as well as possible\r | |
156 | human readable name that is associated with the token.\r | |
157 | \r | |
158 | @param[in] Database PCD database.\r | |
159 | @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r | |
160 | @param[in] TokenNumber The PCD token number.\r | |
161 | @param[out] PcdInfo The returned information associated with the requested TokenNumber.\r | |
162 | The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName. \r | |
163 | \r | |
164 | @retval EFI_SUCCESS The PCD information was returned successfully\r | |
165 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r | |
166 | **/\r | |
167 | EFI_STATUS\r | |
168 | ExGetPcdInfo (\r | |
169 | IN PEI_PCD_DATABASE *Database,\r | |
170 | IN CONST EFI_GUID *Guid,\r | |
171 | IN UINTN TokenNumber,\r | |
172 | OUT EFI_PCD_INFO *PcdInfo\r | |
173 | )\r | |
174 | {\r | |
175 | UINTN GuidTableIdx;\r | |
176 | EFI_GUID *MatchGuid;\r | |
177 | EFI_GUID *GuidTable;\r | |
178 | DYNAMICEX_MAPPING *ExMapTable;\r | |
179 | UINTN Index;\r | |
180 | UINT32 LocalTokenNumber;\r | |
181 | \r | |
182 | GuidTable = (EFI_GUID *)((UINT8 *)Database + Database->GuidTableOffset);\r | |
183 | MatchGuid = ScanGuid (GuidTable, Database->GuidTableCount * sizeof(EFI_GUID), Guid);\r | |
184 | \r | |
185 | if (MatchGuid == NULL) {\r | |
186 | return EFI_NOT_FOUND;\r | |
187 | }\r | |
188 | \r | |
189 | GuidTableIdx = MatchGuid - GuidTable;\r | |
190 | \r | |
191 | ExMapTable = (DYNAMICEX_MAPPING *)((UINT8 *)Database + Database->ExMapTableOffset);\r | |
192 | \r | |
193 | //\r | |
194 | // Find the PCD by GuidTableIdx and ExTokenNumber in ExMapTable.\r | |
195 | //\r | |
196 | for (Index = 0; Index < Database->ExTokenCount; Index++) {\r | |
197 | if (ExMapTable[Index].ExGuidIndex == GuidTableIdx) {\r | |
198 | if (TokenNumber == PCD_INVALID_TOKEN_NUMBER) {\r | |
199 | //\r | |
200 | // TokenNumber is 0, follow spec to set PcdType to EFI_PCD_TYPE_8,\r | |
201 | // PcdSize to 0 and PcdName to the null-terminated ASCII string\r | |
202 | // associated with the token's namespace Guid.\r | |
203 | //\r | |
204 | PcdInfo->PcdType = EFI_PCD_TYPE_8;\r | |
205 | PcdInfo->PcdSize = 0;\r | |
206 | //\r | |
207 | // Here use one representative in the token space to get the TokenSpaceCName.\r | |
208 | // \r | |
209 | PcdInfo->PcdName = GetPcdName (TRUE, Database, ExMapTable[Index].TokenNumber);\r | |
210 | return EFI_SUCCESS;\r | |
211 | } else if (ExMapTable[Index].ExTokenNumber == TokenNumber) {\r | |
212 | PcdInfo->PcdSize = PeiPcdGetSize (ExMapTable[Index].TokenNumber);\r | |
213 | LocalTokenNumber = GetLocalTokenNumber (Database, ExMapTable[Index].TokenNumber);\r | |
214 | PcdInfo->PcdType = GetPcdType (LocalTokenNumber);\r | |
215 | PcdInfo->PcdName = GetPcdName (FALSE, Database, ExMapTable[Index].TokenNumber);\r | |
216 | return EFI_SUCCESS;\r | |
217 | }\r | |
218 | }\r | |
219 | }\r | |
220 | \r | |
221 | return EFI_NOT_FOUND;\r | |
222 | }\r | |
223 | \r | |
224 | /**\r | |
225 | Retrieve additional information associated with a PCD token.\r | |
226 | \r | |
227 | This includes information such as the type of value the TokenNumber is associated with as well as possible\r | |
228 | human readable name that is associated with the token.\r | |
229 | \r | |
230 | @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r | |
231 | @param[in] TokenNumber The PCD token number.\r | |
232 | @param[out] PcdInfo The returned information associated with the requested TokenNumber.\r | |
233 | The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.\r | |
234 | \r | |
235 | @retval EFI_SUCCESS The PCD information was returned successfully.\r | |
236 | @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r | |
237 | **/\r | |
238 | EFI_STATUS\r | |
239 | PeiGetPcdInfo (\r | |
240 | IN CONST EFI_GUID *Guid,\r | |
241 | IN UINTN TokenNumber,\r | |
242 | OUT EFI_PCD_INFO *PcdInfo\r | |
243 | )\r | |
244 | {\r | |
245 | PEI_PCD_DATABASE *PeiPcdDb;\r | |
246 | BOOLEAN PeiExMapTableEmpty;\r | |
247 | UINTN PeiNexTokenNumber;\r | |
248 | UINT32 LocalTokenNumber;\r | |
249 | \r | |
96d6d004 SZ |
250 | ASSERT (PcdInfo != NULL);\r |
251 | \r | |
252 | PeiPcdDb = GetPcdDatabase ();\r | |
253 | PeiNexTokenNumber = PeiPcdDb->LocalTokenCount - PeiPcdDb->ExTokenCount;\r | |
254 | \r | |
255 | if (PeiPcdDb->ExTokenCount == 0) {\r | |
256 | PeiExMapTableEmpty = TRUE;\r | |
257 | } else {\r | |
258 | PeiExMapTableEmpty = FALSE;\r | |
259 | }\r | |
260 | \r | |
261 | if (Guid == NULL) {\r | |
262 | if (TokenNumber > PeiNexTokenNumber) {\r | |
263 | return EFI_NOT_FOUND;\r | |
264 | } else if (TokenNumber == PCD_INVALID_TOKEN_NUMBER) {\r | |
265 | //\r | |
266 | // TokenNumber is 0, follow spec to set PcdType to EFI_PCD_TYPE_8,\r | |
267 | // PcdSize to 0 and PcdName to NULL for default Token Space.\r | |
268 | //\r | |
269 | PcdInfo->PcdType = EFI_PCD_TYPE_8;\r | |
270 | PcdInfo->PcdSize = 0;\r | |
271 | PcdInfo->PcdName = NULL;\r | |
272 | } else {\r | |
273 | PcdInfo->PcdSize = PeiPcdGetSize (TokenNumber);\r | |
274 | LocalTokenNumber = GetLocalTokenNumber (PeiPcdDb, TokenNumber);\r | |
275 | PcdInfo->PcdType = GetPcdType (LocalTokenNumber);\r | |
276 | PcdInfo->PcdName = GetPcdName (FALSE, PeiPcdDb, TokenNumber);\r | |
277 | }\r | |
278 | return EFI_SUCCESS;\r | |
279 | } else {\r | |
280 | if (PeiExMapTableEmpty) {\r | |
281 | return EFI_NOT_FOUND;\r | |
282 | }\r | |
283 | return ExGetPcdInfo (\r | |
284 | PeiPcdDb,\r | |
285 | Guid,\r | |
286 | TokenNumber,\r | |
287 | PcdInfo\r | |
288 | );\r | |
289 | }\r | |
290 | }\r | |
291 | \r | |
80408db0 | 292 | /**\r |
293 | The function registers the CallBackOnSet fucntion\r | |
294 | according to TokenNumber and EFI_GUID space.\r | |
295 | \r | |
fc547e08 | 296 | @param ExTokenNumber The token number.\r |
80408db0 | 297 | @param Guid The GUID space.\r |
298 | @param CallBackFunction The Callback function to be registered.\r | |
299 | @param Register To register or unregister the callback function.\r | |
300 | \r | |
301 | @retval EFI_SUCCESS If the Callback function is registered.\r | |
302 | @retval EFI_NOT_FOUND If the PCD Entry is not found according to Token Number and GUID space.\r | |
303 | @retval EFI_OUT_OF_RESOURCES If the callback function can't be registered because there is not free\r | |
304 | slot left in the CallbackFnTable.\r | |
8ec8bed4 | 305 | @retval EFI_INVALID_PARAMETER If the callback function want to be de-registered can not be found.\r |
fc547e08 | 306 | **/\r |
80408db0 | 307 | EFI_STATUS\r |
308 | PeiRegisterCallBackWorker (\r | |
309 | IN UINTN ExTokenNumber,\r | |
310 | IN CONST EFI_GUID *Guid, OPTIONAL\r | |
311 | IN PCD_PPI_CALLBACK CallBackFunction,\r | |
312 | IN BOOLEAN Register\r | |
313 | )\r | |
314 | {\r | |
315 | EFI_HOB_GUID_TYPE *GuidHob;\r | |
316 | PCD_PPI_CALLBACK *CallbackTable;\r | |
317 | PCD_PPI_CALLBACK Compare;\r | |
318 | PCD_PPI_CALLBACK Assign;\r | |
319 | UINT32 LocalTokenNumber;\r | |
419db80b BF |
320 | UINT32 LocalTokenCount;\r |
321 | UINTN PeiNexTokenNumber;\r | |
80408db0 | 322 | UINTN TokenNumber;\r |
323 | UINTN Idx;\r | |
419db80b BF |
324 | PEI_PCD_DATABASE *PeiPcdDb;\r |
325 | \r | |
326 | PeiPcdDb = GetPcdDatabase();\r | |
327 | LocalTokenCount = PeiPcdDb->LocalTokenCount;\r | |
328 | PeiNexTokenNumber = PeiPcdDb->LocalTokenCount - PeiPcdDb->ExTokenCount;\r | |
80408db0 | 329 | \r |
330 | if (Guid == NULL) {\r | |
331 | TokenNumber = ExTokenNumber;\r | |
80408db0 | 332 | //\r |
333 | // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r | |
334 | // We have to decrement TokenNumber by 1 to make it usable\r | |
335 | // as the array index.\r | |
336 | //\r | |
337 | TokenNumber--;\r | |
419db80b | 338 | ASSERT (TokenNumber + 1 < (PeiNexTokenNumber + 1));\r |
80408db0 | 339 | } else {\r |
340 | TokenNumber = GetExPcdTokenNumber (Guid, ExTokenNumber);\r | |
86714ccd | 341 | if (TokenNumber == PCD_INVALID_TOKEN_NUMBER) {\r |
342 | return EFI_NOT_FOUND;\r | |
343 | }\r | |
80408db0 | 344 | //\r |
345 | // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r | |
346 | // We have to decrement TokenNumber by 1 to make it usable\r | |
347 | // as the array index.\r | |
348 | //\r | |
349 | TokenNumber--;\r | |
350 | // EBC compiler is very choosy. It may report warning about comparison\r | |
351 | // between UINTN and 0 . So we add 1 in each size of the \r | |
352 | // comparison.\r | |
419db80b | 353 | ASSERT ((TokenNumber + 1) < (LocalTokenCount + 1));\r |
80408db0 | 354 | }\r |
355 | \r | |
356 | \r | |
419db80b | 357 | LocalTokenNumber = *((UINT32 *)((UINT8 *)PeiPcdDb + PeiPcdDb->LocalTokenNumberTableOffset) + TokenNumber);\r |
80408db0 | 358 | \r |
359 | //\r | |
360 | // We don't support SET for HII and VPD type PCD entry in PEI phase.\r | |
361 | // So we will assert if any register callback for such PCD entry.\r | |
362 | //\r | |
363 | ASSERT ((LocalTokenNumber & PCD_TYPE_HII) == 0);\r | |
364 | ASSERT ((LocalTokenNumber & PCD_TYPE_VPD) == 0);\r | |
365 | \r | |
96cb78a1 | 366 | GuidHob = GetFirstGuidHob (&gEfiCallerIdGuid);\r |
80408db0 | 367 | ASSERT (GuidHob != NULL);\r |
368 | \r | |
369 | CallbackTable = GET_GUID_HOB_DATA (GuidHob);\r | |
188e4e84 | 370 | CallbackTable = CallbackTable + (TokenNumber * PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry));\r |
80408db0 | 371 | \r |
372 | Compare = Register? NULL: CallBackFunction;\r | |
373 | Assign = Register? CallBackFunction: NULL;\r | |
374 | \r | |
375 | \r | |
188e4e84 | 376 | for (Idx = 0; Idx < PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry); Idx++) {\r |
80408db0 | 377 | if (CallbackTable[Idx] == Compare) {\r |
378 | CallbackTable[Idx] = Assign;\r | |
379 | return EFI_SUCCESS;\r | |
380 | }\r | |
381 | }\r | |
382 | \r | |
8ec8bed4 | 383 | return Register? EFI_OUT_OF_RESOURCES : EFI_INVALID_PARAMETER;\r |
80408db0 | 384 | \r |
385 | }\r | |
386 | \r | |
419db80b BF |
387 | \r |
388 | /**\r | |
389 | Find the Pcd database. \r | |
390 | \r | |
391 | @param FileHandle Handle of the file the external PCD database binary located.\r | |
392 | \r | |
393 | @retval The base address of external PCD database binary.\r | |
394 | @retval NULL Return NULL if not find.\r | |
395 | **/\r | |
396 | VOID *\r | |
397 | LocateExPcdBinary (\r | |
398 | IN EFI_PEI_FILE_HANDLE FileHandle\r | |
399 | )\r | |
400 | {\r | |
401 | EFI_STATUS Status;\r | |
402 | VOID *PcdDb;\r | |
403 | \r | |
404 | PcdDb = NULL;\r | |
405 | \r | |
406 | ASSERT (FileHandle != NULL);\r | |
407 | \r | |
408 | Status = PeiServicesFfsFindSectionData (EFI_SECTION_RAW, FileHandle, &PcdDb);\r | |
409 | ASSERT_EFI_ERROR (Status);\r | |
410 | \r | |
411 | //\r | |
412 | // Check the first bytes (Header Signature Guid) and build version.\r | |
413 | //\r | |
414 | if (!CompareGuid (PcdDb, &gPcdDataBaseSignatureGuid) ||\r | |
415 | (((PEI_PCD_DATABASE *) PcdDb)->BuildVersion != PCD_SERVICE_PEIM_VERSION)) {\r | |
416 | ASSERT (FALSE);\r | |
417 | }\r | |
418 | return PcdDb;\r | |
419 | }\r | |
420 | \r | |
421 | \r | |
80408db0 | 422 | /**\r |
423 | The function builds the PCD database.\r | |
419db80b BF |
424 | \r |
425 | @param FileHandle Handle of the file the external PCD database binary located.\r | |
426 | \r | |
96d6d004 | 427 | @return Pointer to PCD database.\r |
fc547e08 | 428 | **/\r |
96d6d004 | 429 | PEI_PCD_DATABASE *\r |
80408db0 | 430 | BuildPcdDatabase (\r |
419db80b | 431 | IN EFI_PEI_FILE_HANDLE FileHandle\r |
80408db0 | 432 | )\r |
433 | {\r | |
419db80b BF |
434 | PEI_PCD_DATABASE *Database;\r |
435 | PEI_PCD_DATABASE *PeiPcdDbBinary;\r | |
436 | VOID *CallbackFnTable;\r | |
437 | UINTN SizeOfCallbackFnTable;\r | |
438 | \r | |
439 | //\r | |
440 | // Locate the external PCD database binary for one section of current FFS\r | |
441 | //\r | |
442 | PeiPcdDbBinary = LocateExPcdBinary (FileHandle);\r | |
80408db0 | 443 | \r |
419db80b BF |
444 | ASSERT(PeiPcdDbBinary != NULL);\r |
445 | \r | |
446 | Database = BuildGuidHob (&gPcdDataBaseHobGuid, PeiPcdDbBinary->Length + PeiPcdDbBinary->UninitDataBaseSize);\r | |
447 | \r | |
448 | ZeroMem (Database, PeiPcdDbBinary->Length + PeiPcdDbBinary->UninitDataBaseSize);\r | |
80408db0 | 449 | \r |
450 | //\r | |
419db80b | 451 | // PeiPcdDbBinary is smaller than Database\r |
80408db0 | 452 | //\r |
419db80b | 453 | CopyMem (Database, PeiPcdDbBinary, PeiPcdDbBinary->Length);\r |
80408db0 | 454 | \r |
419db80b | 455 | SizeOfCallbackFnTable = Database->LocalTokenCount * sizeof (PCD_PPI_CALLBACK) * PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry);\r |
80408db0 | 456 | \r |
96cb78a1 | 457 | CallbackFnTable = BuildGuidHob (&gEfiCallerIdGuid, SizeOfCallbackFnTable);\r |
80408db0 | 458 | \r |
459 | ZeroMem (CallbackFnTable, SizeOfCallbackFnTable);\r | |
96d6d004 SZ |
460 | \r |
461 | return Database;\r | |
80408db0 | 462 | }\r |
463 | \r | |
80408db0 | 464 | /**\r |
465 | The function is provided by PCD PEIM and PCD DXE driver to\r | |
466 | do the work of reading a HII variable from variable service.\r | |
467 | \r | |
468 | @param VariableGuid The Variable GUID.\r | |
469 | @param VariableName The Variable Name.\r | |
470 | @param VariableData The output data.\r | |
471 | @param VariableSize The size of the variable.\r | |
472 | \r | |
473 | @retval EFI_SUCCESS Operation successful.\r | |
474 | @retval EFI_NOT_FOUND Variablel not found.\r | |
fc547e08 | 475 | **/\r |
80408db0 | 476 | EFI_STATUS\r |
477 | GetHiiVariable (\r | |
478 | IN CONST EFI_GUID *VariableGuid,\r | |
479 | IN UINT16 *VariableName,\r | |
480 | OUT VOID **VariableData,\r | |
481 | OUT UINTN *VariableSize\r | |
482 | )\r | |
483 | {\r | |
484 | UINTN Size;\r | |
485 | EFI_STATUS Status;\r | |
486 | VOID *Buffer;\r | |
97a079ed | 487 | EFI_PEI_READ_ONLY_VARIABLE2_PPI *VariablePpi;\r |
80408db0 | 488 | \r |
97a079ed | 489 | Status = PeiServicesLocatePpi (&gEfiPeiReadOnlyVariable2PpiGuid, 0, NULL, (VOID **) &VariablePpi);\r |
80408db0 | 490 | ASSERT_EFI_ERROR (Status);\r |
491 | \r | |
492 | Size = 0;\r | |
97a079ed A |
493 | Status = VariablePpi->GetVariable (\r |
494 | VariablePpi,\r | |
80408db0 | 495 | VariableName,\r |
496 | (EFI_GUID *) VariableGuid,\r | |
497 | NULL,\r | |
498 | &Size,\r | |
499 | NULL\r | |
97a079ed | 500 | );\r |
80408db0 | 501 | \r |
e5618791 | 502 | if (Status == EFI_BUFFER_TOO_SMALL) {\r |
80408db0 | 503 | Status = PeiServicesAllocatePool (Size, &Buffer);\r |
504 | ASSERT_EFI_ERROR (Status);\r | |
505 | \r | |
97a079ed A |
506 | Status = VariablePpi->GetVariable (\r |
507 | VariablePpi,\r | |
80408db0 | 508 | (UINT16 *) VariableName,\r |
509 | (EFI_GUID *) VariableGuid,\r | |
510 | NULL,\r | |
511 | &Size,\r | |
512 | Buffer\r | |
513 | );\r | |
514 | ASSERT_EFI_ERROR (Status);\r | |
515 | \r | |
516 | *VariableSize = Size;\r | |
517 | *VariableData = Buffer;\r | |
518 | \r | |
519 | return EFI_SUCCESS;\r | |
e5618791 | 520 | }\r |
80408db0 | 521 | \r |
fc547e08 | 522 | return EFI_NOT_FOUND;\r |
80408db0 | 523 | }\r |
524 | \r | |
fc547e08 | 525 | /**\r |
526 | Find the local token number according to system SKU ID.\r | |
527 | \r | |
528 | @param LocalTokenNumber PCD token number\r | |
529 | @param Size The size of PCD entry.\r | |
530 | \r | |
531 | @return Token number according to system SKU ID.\r | |
532 | \r | |
533 | **/\r | |
80408db0 | 534 | UINT32\r |
535 | GetSkuEnabledTokenNumber (\r | |
536 | UINT32 LocalTokenNumber,\r | |
537 | UINTN Size\r | |
538 | ) \r | |
539 | {\r | |
540 | PEI_PCD_DATABASE *PeiPcdDb;\r | |
541 | SKU_HEAD *SkuHead;\r | |
542 | SKU_ID *SkuIdTable;\r | |
fc547e08 | 543 | INTN Index;\r |
80408db0 | 544 | UINT8 *Value;\r |
419db80b | 545 | BOOLEAN FoundSku;\r |
80408db0 | 546 | \r |
547 | PeiPcdDb = GetPcdDatabase ();\r | |
548 | \r | |
549 | ASSERT ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == 0);\r | |
550 | \r | |
551 | SkuHead = (SKU_HEAD *) ((UINT8 *)PeiPcdDb + (LocalTokenNumber & PCD_DATABASE_OFFSET_MASK));\r | |
552 | Value = (UINT8 *) ((UINT8 *)PeiPcdDb + (SkuHead->SkuDataStartOffset));\r | |
553 | SkuIdTable = (SKU_ID *) ((UINT8 *)PeiPcdDb + (SkuHead->SkuIdTableOffset));\r | |
419db80b BF |
554 | \r |
555 | //\r | |
556 | // Find the current system's SKU ID entry in SKU ID table.\r | |
557 | //\r | |
558 | FoundSku = FALSE;\r | |
fc547e08 | 559 | for (Index = 0; Index < SkuIdTable[0]; Index++) {\r |
419db80b BF |
560 | if (PeiPcdDb->SystemSkuId == SkuIdTable[Index + 1]) {\r |
561 | FoundSku = TRUE;\r | |
80408db0 | 562 | break;\r |
563 | }\r | |
564 | }\r | |
565 | \r | |
419db80b BF |
566 | //\r |
567 | // Find the default SKU ID entry in SKU ID table.\r | |
568 | //\r | |
569 | if(!FoundSku) {\r | |
570 | for (Index = 0; Index < SkuIdTable[0]; Index++) {\r | |
571 | if (0 == SkuIdTable[Index + 1]) {\r | |
572 | break;\r | |
573 | }\r | |
574 | }\r | |
575 | }\r | |
576 | ASSERT (Index < SkuIdTable[0]);\r | |
577 | \r | |
80408db0 | 578 | switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {\r |
579 | case PCD_TYPE_VPD:\r | |
fc547e08 | 580 | Value = (UINT8 *) &(((VPD_HEAD *) Value)[Index]);\r |
80408db0 | 581 | return (UINT32) ((Value - (UINT8 *) PeiPcdDb) | PCD_TYPE_VPD);\r |
582 | \r | |
583 | case PCD_TYPE_HII:\r | |
fc547e08 | 584 | Value = (UINT8 *) &(((VARIABLE_HEAD *) Value)[Index]);\r |
80408db0 | 585 | return (UINT32) ((Value - (UINT8 *) PeiPcdDb) | PCD_TYPE_HII);\r |
419db80b BF |
586 | \r |
587 | case PCD_TYPE_HII|PCD_TYPE_STRING:\r | |
588 | Value = (UINT8 *) &(((VARIABLE_HEAD *) Value)[Index]);\r | |
589 | return (UINT32) ((Value - (UINT8 *) PeiPcdDb) | PCD_TYPE_HII | PCD_TYPE_STRING);\r | |
590 | \r | |
80408db0 | 591 | case PCD_TYPE_STRING:\r |
fc547e08 | 592 | Value = (UINT8 *) &(((STRING_HEAD *) Value)[Index]);\r |
80408db0 | 593 | return (UINT32) ((Value - (UINT8 *) PeiPcdDb) | PCD_TYPE_STRING);\r |
594 | \r | |
595 | case PCD_TYPE_DATA:\r | |
fc547e08 | 596 | Value += Size * Index;\r |
419db80b | 597 | return (UINT32) ((Value - (UINT8 *) PeiPcdDb) | PCD_TYPE_DATA);\r |
80408db0 | 598 | \r |
599 | default:\r | |
600 | ASSERT (FALSE);\r | |
601 | }\r | |
602 | \r | |
603 | ASSERT (FALSE);\r | |
604 | \r | |
605 | return 0;\r | |
80408db0 | 606 | }\r |
607 | \r | |
fc547e08 | 608 | /**\r |
609 | Invoke the callback function when dynamic PCD entry was set, if this PCD entry \r | |
610 | has registered callback function.\r | |
80408db0 | 611 | \r |
fc547e08 | 612 | @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx\r |
613 | type PCD.\r | |
614 | @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type\r | |
615 | PCD.\r | |
616 | @param TokenNumber PCD token number generated by build tools.\r | |
617 | @param Data Value want to be set for this PCD entry\r | |
618 | @param Size The size of value\r | |
80408db0 | 619 | \r |
fc547e08 | 620 | **/\r |
80408db0 | 621 | VOID\r |
622 | InvokeCallbackOnSet (\r | |
623 | UINTN ExTokenNumber,\r | |
624 | CONST EFI_GUID *Guid, OPTIONAL\r | |
625 | UINTN TokenNumber,\r | |
626 | VOID *Data,\r | |
627 | UINTN Size\r | |
628 | )\r | |
629 | {\r | |
630 | EFI_HOB_GUID_TYPE *GuidHob;\r | |
631 | PCD_PPI_CALLBACK *CallbackTable;\r | |
632 | UINTN Idx;\r | |
419db80b BF |
633 | PEI_PCD_DATABASE *PeiPcdDb;\r |
634 | UINT32 LocalTokenCount;\r | |
80408db0 | 635 | \r |
636 | //\r | |
637 | // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r | |
638 | // We have to decrement TokenNumber by 1 to make it usable\r | |
639 | // as the array index.\r | |
640 | //\r | |
641 | TokenNumber--;\r | |
419db80b BF |
642 | \r |
643 | PeiPcdDb = GetPcdDatabase ();\r | |
644 | LocalTokenCount = PeiPcdDb->LocalTokenCount;\r | |
645 | \r | |
80408db0 | 646 | if (Guid == NULL) {\r |
647 | // EBC compiler is very choosy. It may report warning about comparison\r | |
648 | // between UINTN and 0 . So we add 1 in each size of the \r | |
649 | // comparison.\r | |
419db80b | 650 | ASSERT (TokenNumber + 1 < (LocalTokenCount + 1));\r |
80408db0 | 651 | }\r |
652 | \r | |
96cb78a1 | 653 | GuidHob = GetFirstGuidHob (&gEfiCallerIdGuid);\r |
80408db0 | 654 | ASSERT (GuidHob != NULL);\r |
655 | \r | |
656 | CallbackTable = GET_GUID_HOB_DATA (GuidHob);\r | |
657 | \r | |
188e4e84 | 658 | CallbackTable += (TokenNumber * PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry));\r |
80408db0 | 659 | \r |
188e4e84 | 660 | for (Idx = 0; Idx < PcdGet32 (PcdMaxPeiPcdCallBackNumberPerPcdEntry); Idx++) {\r |
80408db0 | 661 | if (CallbackTable[Idx] != NULL) {\r |
662 | CallbackTable[Idx] (Guid,\r | |
736c5dd5 | 663 | (Guid == NULL) ? (TokenNumber + 1) : ExTokenNumber,\r |
80408db0 | 664 | Data,\r |
665 | Size\r | |
666 | );\r | |
667 | }\r | |
668 | }\r | |
80408db0 | 669 | }\r |
670 | \r | |
fc547e08 | 671 | /**\r |
672 | Wrapper function for setting non-pointer type value for a PCD entry.\r | |
673 | \r | |
674 | @param TokenNumber Pcd token number autogenerated by build tools.\r | |
675 | @param Data Value want to be set for PCD entry\r | |
676 | @param Size Size of value.\r | |
80408db0 | 677 | \r |
fc547e08 | 678 | @return status of SetWorker.\r |
80408db0 | 679 | \r |
fc547e08 | 680 | **/\r |
80408db0 | 681 | EFI_STATUS\r |
682 | SetValueWorker (\r | |
683 | IN UINTN TokenNumber,\r | |
684 | IN VOID *Data,\r | |
685 | IN UINTN Size\r | |
686 | )\r | |
687 | {\r | |
688 | return SetWorker (TokenNumber, Data, &Size, FALSE);\r | |
689 | }\r | |
690 | \r | |
fc547e08 | 691 | /**\r |
692 | Set value for an PCD entry\r | |
693 | \r | |
694 | @param TokenNumber Pcd token number autogenerated by build tools.\r | |
695 | @param Data Value want to be set for PCD entry\r | |
696 | @param Size Size of value.\r | |
697 | @param PtrType If TRUE, the type of PCD entry's value is Pointer.\r | |
698 | If False, the type of PCD entry's value is not Pointer.\r | |
699 | \r | |
700 | @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.\r | |
701 | @retval EFI_INVALID_PARAMETER If Size can not be set to size table.\r | |
149fb6d6 | 702 | @retval EFI_INVALID_PARAMETER If Size of non-Ptr type PCD does not match the size information in PCD database.\r |
fc547e08 | 703 | @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in\r |
704 | range of UINT8, UINT16, UINT32, UINT64\r | |
705 | @retval EFI_NOT_FOUND Can not find the PCD type according to token number. \r | |
706 | **/\r | |
80408db0 | 707 | EFI_STATUS\r |
708 | SetWorker (\r | |
709 | IN UINTN TokenNumber,\r | |
fc547e08 | 710 | IN VOID *Data,\r |
80408db0 | 711 | IN OUT UINTN *Size,\r |
712 | IN BOOLEAN PtrType\r | |
713 | )\r | |
714 | {\r | |
715 | UINT32 LocalTokenNumber;\r | |
419db80b | 716 | UINTN PeiNexTokenNumber;\r |
80408db0 | 717 | PEI_PCD_DATABASE *PeiPcdDb;\r |
6cfc7292 | 718 | STRING_HEAD StringTableIdx;\r |
80408db0 | 719 | UINTN Offset;\r |
720 | VOID *InternalData;\r | |
721 | UINTN MaxSize;\r | |
419db80b | 722 | UINT32 LocalTokenCount;\r |
80408db0 | 723 | \r |
f806dd27 | 724 | if (!FeaturePcdGet(PcdPeiFullPcdDatabaseEnable)) {\r |
80408db0 | 725 | return EFI_UNSUPPORTED;\r |
726 | }\r | |
727 | \r | |
728 | //\r | |
729 | // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r | |
730 | // We have to decrement TokenNumber by 1 to make it usable\r | |
731 | // as the array index.\r | |
732 | //\r | |
733 | TokenNumber--;\r | |
419db80b BF |
734 | PeiPcdDb = GetPcdDatabase ();\r |
735 | LocalTokenCount = PeiPcdDb->LocalTokenCount;\r | |
80408db0 | 736 | \r |
737 | // EBC compiler is very choosy. It may report warning about comparison\r | |
738 | // between UINTN and 0 . So we add 1 in each size of the \r | |
739 | // comparison.\r | |
419db80b | 740 | ASSERT (TokenNumber + 1 < (LocalTokenCount + 1));\r |
80408db0 | 741 | \r |
8ec8bed4 | 742 | if (PtrType) {\r |
64894410 LG |
743 | //\r |
744 | // Get MaxSize first, then check new size with max buffer size.\r | |
745 | //\r | |
746 | GetPtrTypeSize (TokenNumber, &MaxSize, PeiPcdDb);\r | |
747 | if (*Size > MaxSize) {\r | |
cb40609c | 748 | *Size = MaxSize;\r |
8ec8bed4 | 749 | return EFI_INVALID_PARAMETER;\r |
750 | }\r | |
751 | } else {\r | |
752 | if (*Size != PeiPcdGetSize (TokenNumber + 1)) {\r | |
753 | return EFI_INVALID_PARAMETER;\r | |
754 | }\r | |
80408db0 | 755 | }\r |
756 | \r | |
757 | //\r | |
758 | // We only invoke the callback function for Dynamic Type PCD Entry.\r | |
759 | // For Dynamic EX PCD entry, we have invoked the callback function for Dynamic EX\r | |
760 | // type PCD entry in ExSetWorker.\r | |
761 | //\r | |
419db80b BF |
762 | PeiNexTokenNumber = PeiPcdDb->LocalTokenCount - PeiPcdDb->ExTokenCount;\r |
763 | if (TokenNumber + 1 < PeiNexTokenNumber + 1) {\r | |
80408db0 | 764 | InvokeCallbackOnSet (0, NULL, TokenNumber + 1, Data, *Size);\r |
765 | }\r | |
766 | \r | |
96d6d004 | 767 | LocalTokenNumber = GetLocalTokenNumber (PeiPcdDb, TokenNumber + 1);\r |
80408db0 | 768 | \r |
769 | Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;\r | |
770 | InternalData = (VOID *) ((UINT8 *) PeiPcdDb + Offset);\r | |
771 | \r | |
772 | switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {\r | |
773 | case PCD_TYPE_VPD:\r | |
774 | case PCD_TYPE_HII:\r | |
6ac15f7c | 775 | case PCD_TYPE_HII|PCD_TYPE_STRING:\r |
80408db0 | 776 | {\r |
777 | ASSERT (FALSE);\r | |
778 | return EFI_INVALID_PARAMETER;\r | |
779 | }\r | |
780 | \r | |
781 | case PCD_TYPE_STRING:\r | |
782 | if (SetPtrTypeSize (TokenNumber, Size, PeiPcdDb)) {\r | |
6cfc7292 | 783 | StringTableIdx = *((STRING_HEAD *)InternalData);\r |
419db80b | 784 | CopyMem ((UINT8 *)PeiPcdDb + PeiPcdDb->StringTableOffset + StringTableIdx, Data, *Size);\r |
80408db0 | 785 | return EFI_SUCCESS;\r |
786 | } else {\r | |
787 | return EFI_INVALID_PARAMETER;\r | |
788 | }\r | |
789 | \r | |
790 | case PCD_TYPE_DATA:\r | |
791 | {\r | |
792 | if (PtrType) {\r | |
793 | if (SetPtrTypeSize (TokenNumber, Size, PeiPcdDb)) {\r | |
794 | CopyMem (InternalData, Data, *Size);\r | |
795 | return EFI_SUCCESS;\r | |
796 | } else {\r | |
797 | return EFI_INVALID_PARAMETER;\r | |
798 | }\r | |
799 | }\r | |
800 | \r | |
801 | switch (*Size) {\r | |
802 | case sizeof(UINT8):\r | |
803 | *((UINT8 *) InternalData) = *((UINT8 *) Data);\r | |
804 | return EFI_SUCCESS;\r | |
805 | \r | |
806 | case sizeof(UINT16):\r | |
807 | *((UINT16 *) InternalData) = *((UINT16 *) Data);\r | |
808 | return EFI_SUCCESS;\r | |
809 | \r | |
810 | case sizeof(UINT32):\r | |
811 | *((UINT32 *) InternalData) = *((UINT32 *) Data);\r | |
812 | return EFI_SUCCESS;\r | |
813 | \r | |
814 | case sizeof(UINT64):\r | |
815 | *((UINT64 *) InternalData) = *((UINT64 *) Data);\r | |
816 | return EFI_SUCCESS;\r | |
817 | \r | |
818 | default:\r | |
819 | ASSERT (FALSE);\r | |
820 | return EFI_NOT_FOUND;\r | |
821 | }\r | |
822 | }\r | |
823 | \r | |
824 | }\r | |
825 | \r | |
826 | ASSERT (FALSE);\r | |
827 | return EFI_NOT_FOUND;\r | |
828 | \r | |
829 | }\r | |
830 | \r | |
fc547e08 | 831 | /**\r |
832 | Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.\r | |
80408db0 | 833 | \r |
fc547e08 | 834 | @param ExTokenNumber Token number for dynamic-ex PCD.\r |
835 | @param Guid Token space guid for dynamic-ex PCD.\r | |
836 | @param Data Value want to be set.\r | |
837 | @param SetSize The size of value.\r | |
80408db0 | 838 | \r |
fc547e08 | 839 | @return status of ExSetWorker().\r |
840 | \r | |
841 | **/\r | |
80408db0 | 842 | EFI_STATUS\r |
843 | ExSetValueWorker (\r | |
844 | IN UINTN ExTokenNumber,\r | |
845 | IN CONST EFI_GUID *Guid,\r | |
846 | IN VOID *Data,\r | |
847 | IN UINTN Size\r | |
848 | )\r | |
849 | {\r | |
850 | return ExSetWorker (ExTokenNumber, Guid, Data, &Size, FALSE);\r | |
851 | }\r | |
852 | \r | |
fc547e08 | 853 | /**\r |
419db80b | 854 | Set value for a dynamic-ex PCD entry.\r |
fc547e08 | 855 | \r |
856 | This routine find the local token number according to dynamic-ex PCD's token \r | |
857 | space guid and token number firstly, and invoke callback function if this PCD\r | |
858 | entry registered callback function. Finally, invoken general SetWorker to set\r | |
859 | PCD value.\r | |
860 | \r | |
861 | @param ExTokenNumber Dynamic-ex PCD token number.\r | |
862 | @param Guid Token space guid for dynamic-ex PCD.\r | |
863 | @param Data PCD value want to be set\r | |
864 | @param SetSize Size of value.\r | |
865 | @param PtrType If TRUE, this PCD entry is pointer type.\r | |
866 | If FALSE, this PCD entry is not pointer type.\r | |
80408db0 | 867 | \r |
fc547e08 | 868 | @return status of SetWorker().\r |
80408db0 | 869 | \r |
fc547e08 | 870 | **/\r |
80408db0 | 871 | EFI_STATUS\r |
872 | ExSetWorker (\r | |
873 | IN UINTN ExTokenNumber,\r | |
874 | IN CONST EFI_GUID *Guid,\r | |
875 | IN VOID *Data,\r | |
876 | IN OUT UINTN *Size,\r | |
877 | IN BOOLEAN PtrType\r | |
878 | )\r | |
879 | {\r | |
880 | UINTN TokenNumber;\r | |
881 | \r | |
f806dd27 | 882 | if (!FeaturePcdGet(PcdPeiFullPcdDatabaseEnable)) {\r |
80408db0 | 883 | return EFI_UNSUPPORTED;\r |
884 | }\r | |
885 | \r | |
886 | TokenNumber = GetExPcdTokenNumber (Guid, ExTokenNumber);\r | |
86714ccd | 887 | if (TokenNumber == PCD_INVALID_TOKEN_NUMBER) {\r |
888 | return EFI_NOT_FOUND;\r | |
889 | }\r | |
890 | \r | |
80408db0 | 891 | InvokeCallbackOnSet (ExTokenNumber, Guid, TokenNumber, Data, *Size);\r |
892 | \r | |
893 | return SetWorker (TokenNumber, Data, Size, PtrType);\r | |
894 | \r | |
895 | }\r | |
896 | \r | |
fc547e08 | 897 | /**\r |
898 | Wrapper function for get PCD value for dynamic-ex PCD.\r | |
80408db0 | 899 | \r |
fc547e08 | 900 | @param Guid Token space guid for dynamic-ex PCD.\r |
901 | @param ExTokenNumber Token number for dyanmic-ex PCD.\r | |
902 | @param GetSize The size of dynamic-ex PCD value.\r | |
80408db0 | 903 | \r |
fc547e08 | 904 | @return PCD entry in PCD database.\r |
80408db0 | 905 | \r |
fc547e08 | 906 | **/\r |
80408db0 | 907 | VOID *\r |
908 | ExGetWorker (\r | |
909 | IN CONST EFI_GUID *Guid,\r | |
910 | IN UINTN ExTokenNumber,\r | |
911 | IN UINTN GetSize\r | |
912 | )\r | |
f806dd27 | 913 | { \r |
80408db0 | 914 | return GetWorker (GetExPcdTokenNumber (Guid, ExTokenNumber), GetSize);\r |
915 | }\r | |
916 | \r | |
fc547e08 | 917 | /**\r |
918 | Get the PCD entry pointer in PCD database.\r | |
919 | \r | |
920 | This routine will visit PCD database to find the PCD entry according to given\r | |
921 | token number. The given token number is autogened by build tools and it will be \r | |
922 | translated to local token number. Local token number contains PCD's type and \r | |
923 | offset of PCD entry in PCD database.\r | |
80408db0 | 924 | \r |
fc547e08 | 925 | @param TokenNumber Token's number, it is autogened by build tools\r |
926 | @param GetSize The size of token's value\r | |
80408db0 | 927 | \r |
fc547e08 | 928 | @return PCD entry pointer in PCD database\r |
80408db0 | 929 | \r |
fc547e08 | 930 | **/\r |
80408db0 | 931 | VOID *\r |
932 | GetWorker (\r | |
fc547e08 | 933 | IN UINTN TokenNumber,\r |
934 | IN UINTN GetSize\r | |
80408db0 | 935 | )\r |
936 | {\r | |
937 | UINT32 Offset;\r | |
938 | EFI_GUID *Guid;\r | |
939 | UINT16 *Name;\r | |
940 | VARIABLE_HEAD *VariableHead;\r | |
941 | EFI_STATUS Status;\r | |
942 | UINTN DataSize;\r | |
943 | VOID *Data;\r | |
d0965169 | 944 | UINT8 *StringTable;\r |
6cfc7292 | 945 | STRING_HEAD StringTableIdx;\r |
80408db0 | 946 | PEI_PCD_DATABASE *PeiPcdDb;\r |
947 | UINT32 LocalTokenNumber;\r | |
419db80b | 948 | UINT32 LocalTokenCount;\r |
80408db0 | 949 | \r |
950 | //\r | |
951 | // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r | |
952 | // We have to decrement TokenNumber by 1 to make it usable\r | |
953 | // as the array index.\r | |
954 | //\r | |
955 | TokenNumber--;\r | |
956 | \r | |
419db80b BF |
957 | PeiPcdDb = GetPcdDatabase ();\r |
958 | LocalTokenCount = PeiPcdDb->LocalTokenCount;\r | |
959 | \r | |
80408db0 | 960 | // EBC compiler is very choosy. It may report warning about comparison\r |
961 | // between UINTN and 0 . So we add 1 in each size of the \r | |
962 | // comparison.\r | |
419db80b | 963 | ASSERT (TokenNumber + 1 < (LocalTokenCount + 1));\r |
80408db0 | 964 | \r |
965 | ASSERT ((GetSize == PeiPcdGetSize(TokenNumber + 1)) || (GetSize == 0));\r | |
966 | \r | |
96d6d004 | 967 | LocalTokenNumber = GetLocalTokenNumber (PeiPcdDb, TokenNumber + 1);\r |
80408db0 | 968 | \r |
969 | Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;\r | |
419db80b BF |
970 | StringTable = (UINT8 *)PeiPcdDb + PeiPcdDb->StringTableOffset;\r |
971 | \r | |
80408db0 | 972 | switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {\r |
973 | case PCD_TYPE_VPD:\r | |
974 | {\r | |
975 | VPD_HEAD *VpdHead;\r | |
976 | VpdHead = (VPD_HEAD *) ((UINT8 *)PeiPcdDb + Offset);\r | |
188e4e84 | 977 | return (VOID *) (UINTN) (PcdGet32 (PcdVpdBaseAddress) + VpdHead->Offset);\r |
80408db0 | 978 | }\r |
979 | \r | |
6ac15f7c | 980 | case PCD_TYPE_HII|PCD_TYPE_STRING:\r |
80408db0 | 981 | case PCD_TYPE_HII:\r |
982 | {\r | |
983 | VariableHead = (VARIABLE_HEAD *) ((UINT8 *)PeiPcdDb + Offset);\r | |
984 | \r | |
419db80b | 985 | Guid = (EFI_GUID *) ((UINT8 *)PeiPcdDb + PeiPcdDb->GuidTableOffset) + VariableHead->GuidTableIndex;\r |
d0965169 | 986 | Name = (UINT16*)&StringTable[VariableHead->StringIndex];\r |
80408db0 | 987 | \r |
988 | Status = GetHiiVariable (Guid, Name, &Data, &DataSize);\r | |
989 | \r | |
990 | if (Status == EFI_SUCCESS) {\r | |
991 | return (VOID *) ((UINT8 *) Data + VariableHead->Offset);\r | |
992 | } else {\r | |
993 | //\r | |
994 | // Return the default value specified by Platform Integrator \r | |
995 | //\r | |
6ac15f7c | 996 | if ((LocalTokenNumber & PCD_TYPE_ALL_SET) == (PCD_TYPE_HII|PCD_TYPE_STRING)) {\r |
6cfc7292 | 997 | return (VOID*)&StringTable[*(STRING_HEAD*)((UINT8*)PeiPcdDb + VariableHead->DefaultValueOffset)];\r |
6ac15f7c | 998 | } else {\r |
999 | return (VOID *) ((UINT8 *) PeiPcdDb + VariableHead->DefaultValueOffset);\r | |
1000 | }\r | |
80408db0 | 1001 | }\r |
1002 | }\r | |
1003 | \r | |
1004 | case PCD_TYPE_DATA:\r | |
1005 | return (VOID *) ((UINT8 *)PeiPcdDb + Offset);\r | |
1006 | \r | |
1007 | case PCD_TYPE_STRING:\r | |
6cfc7292 | 1008 | StringTableIdx = * (STRING_HEAD*) ((UINT8 *) PeiPcdDb + Offset);\r |
80408db0 | 1009 | return (VOID *) (&StringTable[StringTableIdx]);\r |
1010 | \r | |
1011 | default:\r | |
1012 | ASSERT (FALSE);\r | |
1013 | break;\r | |
1014 | \r | |
1015 | }\r | |
1016 | \r | |
1017 | ASSERT (FALSE);\r | |
1018 | \r | |
1019 | return NULL;\r | |
1020 | \r | |
1021 | }\r | |
1022 | \r | |
fc547e08 | 1023 | /**\r |
419db80b | 1024 | Get Token Number according to dynamic-ex PCD's {token space guid:token number}\r |
fc547e08 | 1025 | \r |
1026 | A dynamic-ex type PCD, developer must provide pair of token space guid: token number\r | |
1027 | in DEC file. PCD database maintain a mapping table that translate pair of {token\r | |
419db80b | 1028 | space guid: token number} to Token Number.\r |
fc547e08 | 1029 | \r |
1030 | @param Guid Token space guid for dynamic-ex PCD entry.\r | |
419db80b | 1031 | @param ExTokenNumber Dynamic-ex PCD token number.\r |
80408db0 | 1032 | \r |
419db80b | 1033 | @return Token Number for dynamic-ex PCD.\r |
80408db0 | 1034 | \r |
fc547e08 | 1035 | **/\r |
80408db0 | 1036 | UINTN \r |
1037 | GetExPcdTokenNumber (\r | |
1038 | IN CONST EFI_GUID *Guid,\r | |
1039 | IN UINTN ExTokenNumber\r | |
1040 | )\r | |
1041 | {\r | |
fc547e08 | 1042 | UINT32 Index;\r |
80408db0 | 1043 | DYNAMICEX_MAPPING *ExMap;\r |
1044 | EFI_GUID *GuidTable;\r | |
1045 | EFI_GUID *MatchGuid;\r | |
1046 | UINTN MatchGuidIdx;\r | |
1047 | PEI_PCD_DATABASE *PeiPcdDb;\r | |
1048 | \r | |
1049 | PeiPcdDb = GetPcdDatabase();\r | |
80408db0 | 1050 | \r |
419db80b BF |
1051 | ExMap = (DYNAMICEX_MAPPING *)((UINT8 *)PeiPcdDb + PeiPcdDb->ExMapTableOffset);\r |
1052 | GuidTable = (EFI_GUID *)((UINT8 *)PeiPcdDb + PeiPcdDb->GuidTableOffset);\r | |
1053 | \r | |
1054 | MatchGuid = ScanGuid (GuidTable, PeiPcdDb->GuidTableCount * sizeof(EFI_GUID), Guid);\r | |
80408db0 | 1055 | //\r |
1056 | // We need to ASSERT here. If GUID can't be found in GuidTable, this is a\r | |
1057 | // error in the BUILD system.\r | |
1058 | //\r | |
1059 | ASSERT (MatchGuid != NULL);\r | |
1060 | \r | |
1061 | MatchGuidIdx = MatchGuid - GuidTable;\r | |
1062 | \r | |
419db80b | 1063 | for (Index = 0; Index < PeiPcdDb->ExTokenCount; Index++) {\r |
fc547e08 | 1064 | if ((ExTokenNumber == ExMap[Index].ExTokenNumber) && \r |
1065 | (MatchGuidIdx == ExMap[Index].ExGuidIndex)) {\r | |
419db80b | 1066 | return ExMap[Index].TokenNumber;\r |
80408db0 | 1067 | }\r |
1068 | }\r | |
1069 | \r | |
86714ccd | 1070 | return PCD_INVALID_TOKEN_NUMBER;\r |
80408db0 | 1071 | }\r |
1072 | \r | |
fc547e08 | 1073 | /**\r |
1074 | Get PCD database from GUID HOB in PEI phase.\r | |
80408db0 | 1075 | \r |
fc547e08 | 1076 | @return Pointer to PCD database.\r |
80408db0 | 1077 | \r |
fc547e08 | 1078 | **/\r |
80408db0 | 1079 | PEI_PCD_DATABASE *\r |
1080 | GetPcdDatabase (\r | |
1081 | VOID\r | |
1082 | )\r | |
1083 | {\r | |
1084 | EFI_HOB_GUID_TYPE *GuidHob;\r | |
1085 | \r | |
1086 | GuidHob = GetFirstGuidHob (&gPcdDataBaseHobGuid);\r | |
1087 | ASSERT (GuidHob != NULL);\r | |
1088 | \r | |
1089 | return (PEI_PCD_DATABASE *) GET_GUID_HOB_DATA (GuidHob);\r | |
1090 | }\r | |
1091 | \r | |
fc547e08 | 1092 | /**\r |
419db80b | 1093 | Get SKU ID table from PCD database.\r |
fc547e08 | 1094 | \r |
1095 | @param LocalTokenNumberTableIdx Index of local token number in token number table.\r | |
1096 | @param Database PCD database.\r | |
80408db0 | 1097 | \r |
fc547e08 | 1098 | @return Pointer to SKU ID array table\r |
80408db0 | 1099 | \r |
fc547e08 | 1100 | **/\r |
80408db0 | 1101 | SKU_ID *\r |
1102 | GetSkuIdArray (\r | |
1103 | IN UINTN LocalTokenNumberTableIdx,\r | |
1104 | IN PEI_PCD_DATABASE *Database\r | |
1105 | )\r | |
1106 | {\r | |
1107 | SKU_HEAD *SkuHead;\r | |
1108 | UINTN LocalTokenNumber;\r | |
1109 | \r | |
419db80b | 1110 | LocalTokenNumber = *((UINT32 *)((UINT8 *)Database + Database->LocalTokenNumberTableOffset) + LocalTokenNumberTableIdx);\r |
80408db0 | 1111 | \r |
1112 | ASSERT ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) != 0);\r | |
1113 | \r | |
1114 | SkuHead = (SKU_HEAD *) ((UINT8 *)Database + (LocalTokenNumber & PCD_DATABASE_OFFSET_MASK));\r | |
1115 | \r | |
1116 | return (SKU_ID *) ((UINT8 *)Database + SkuHead->SkuIdTableOffset);\r | |
1117 | \r | |
1118 | }\r | |
1119 | \r | |
fc547e08 | 1120 | /**\r |
1121 | Get index of PCD entry in size table.\r | |
1122 | \r | |
1123 | @param LocalTokenNumberTableIdx Index of this PCD in local token number table.\r | |
1124 | @param Database Pointer to PCD database in PEI phase.\r | |
80408db0 | 1125 | \r |
fc547e08 | 1126 | @return index of PCD entry in size table.\r |
80408db0 | 1127 | \r |
fc547e08 | 1128 | **/\r |
80408db0 | 1129 | UINTN\r |
1130 | GetSizeTableIndex (\r | |
1131 | IN UINTN LocalTokenNumberTableIdx,\r | |
1132 | IN PEI_PCD_DATABASE *Database\r | |
1133 | )\r | |
1134 | {\r | |
fc547e08 | 1135 | UINTN Index;\r |
419db80b | 1136 | UINTN SizeTableIdx;\r |
80408db0 | 1137 | UINTN LocalTokenNumber;\r |
1138 | SKU_ID *SkuIdTable;\r | |
1139 | \r | |
1140 | SizeTableIdx = 0;\r | |
1141 | \r | |
419db80b BF |
1142 | for (Index = 0; Index < LocalTokenNumberTableIdx; Index++) {\r |
1143 | LocalTokenNumber = *((UINT32 *)((UINT8 *)Database + Database->LocalTokenNumberTableOffset) + Index);\r | |
80408db0 | 1144 | \r |
1145 | if ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER) {\r | |
1146 | //\r | |
1147 | // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type \r | |
1148 | // PCD entry.\r | |
1149 | //\r | |
fc547e08 | 1150 | if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {\r |
80408db0 | 1151 | //\r |
419db80b | 1152 | // We have only two entry for VPD enabled PCD entry:\r |
80408db0 | 1153 | // 1) MAX Size.\r |
419db80b BF |
1154 | // 2) Current Size\r |
1155 | // Current size is equal to MAX size.\r | |
80408db0 | 1156 | //\r |
419db80b | 1157 | SizeTableIdx += 2;\r |
80408db0 | 1158 | } else {\r |
1159 | if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == 0) {\r | |
1160 | //\r | |
1161 | // We have only two entry for Non-Sku enabled PCD entry:\r | |
1162 | // 1) MAX SIZE\r | |
1163 | // 2) Current Size\r | |
1164 | //\r | |
1165 | SizeTableIdx += 2;\r | |
1166 | } else {\r | |
1167 | //\r | |
1168 | // We have these entry for SKU enabled PCD entry\r | |
1169 | // 1) MAX SIZE\r | |
1170 | // 2) Current Size for each SKU_ID (It is equal to MaxSku).\r | |
1171 | //\r | |
fc547e08 | 1172 | SkuIdTable = GetSkuIdArray (Index, Database);\r |
80408db0 | 1173 | SizeTableIdx += (UINTN)*SkuIdTable + 1;\r |
1174 | }\r | |
1175 | }\r | |
1176 | }\r | |
1177 | \r | |
1178 | }\r | |
1179 | \r | |
1180 | return SizeTableIdx;\r | |
1181 | }\r |