]>
Commit | Line | Data |
---|---|---|
0c18794e | 1 | /** @file\r |
2 | Implement ReadOnly Variable Services required by PEIM and install PEI\r | |
3 | ReadOnly Varaiable2 PPI. These services operates the non-volatile \r | |
4 | storage space.\r | |
5 | \r | |
932e0f66 | 6 | Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.<BR>\r |
0c18794e | 7 | This program and the accompanying materials \r |
8 | are licensed and made available under the terms and conditions of the BSD License \r | |
9 | which accompanies this distribution. The full text of the license may be found at \r | |
10 | http://opensource.org/licenses/bsd-license.php\r | |
11 | \r | |
12 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
13 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
14 | \r | |
15 | **/\r | |
16 | \r | |
17 | \r | |
18 | #include "Variable.h"\r | |
19 | \r | |
20 | //\r | |
21 | // Module globals\r | |
22 | //\r | |
23 | EFI_PEI_READ_ONLY_VARIABLE2_PPI mVariablePpi = {\r | |
24 | PeiGetVariable,\r | |
25 | PeiGetNextVariableName\r | |
26 | };\r | |
27 | \r | |
28 | EFI_PEI_PPI_DESCRIPTOR mPpiListVariable = {\r | |
29 | (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r | |
30 | &gEfiPeiReadOnlyVariable2PpiGuid,\r | |
31 | &mVariablePpi\r | |
32 | };\r | |
33 | \r | |
0c18794e | 34 | /**\r |
35 | Provide the functionality of the variable services.\r | |
36 | \r | |
37 | @param FileHandle Handle of the file being invoked. \r | |
38 | Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().\r | |
39 | @param PeiServices General purpose services available to every PEIM.\r | |
40 | \r | |
41 | @retval EFI_SUCCESS If the interface could be successfully installed\r | |
42 | @retval Others Returned from PeiServicesInstallPpi()\r | |
0c18794e | 43 | **/\r |
44 | EFI_STATUS\r | |
45 | EFIAPI\r | |
46 | PeimInitializeVariableServices (\r | |
47 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
48 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
49 | )\r | |
50 | {\r | |
0c18794e | 51 | return PeiServicesInstallPpi (&mPpiListVariable);\r |
0c18794e | 52 | }\r |
53 | \r | |
54 | /**\r | |
55 | \r | |
56 | Gets the pointer to the first variable header in given variable store area.\r | |
57 | \r | |
58 | @param VarStoreHeader Pointer to the Variable Store Header.\r | |
59 | \r | |
60 | @return Pointer to the first variable header\r | |
61 | \r | |
62 | **/\r | |
63 | VARIABLE_HEADER *\r | |
64 | GetStartPointer (\r | |
65 | IN VARIABLE_STORE_HEADER *VarStoreHeader\r | |
66 | )\r | |
67 | {\r | |
68 | //\r | |
69 | // The end of variable store\r | |
70 | //\r | |
71 | return (VARIABLE_HEADER *) HEADER_ALIGN (VarStoreHeader + 1);\r | |
72 | }\r | |
73 | \r | |
74 | \r | |
75 | /**\r | |
76 | This code gets the pointer to the last variable memory pointer byte.\r | |
77 | \r | |
78 | @param VarStoreHeader Pointer to the Variable Store Header.\r | |
79 | \r | |
80 | @return VARIABLE_HEADER* pointer to last unavailable Variable Header.\r | |
81 | \r | |
82 | **/\r | |
83 | VARIABLE_HEADER *\r | |
84 | GetEndPointer (\r | |
85 | IN VARIABLE_STORE_HEADER *VarStoreHeader\r | |
86 | )\r | |
87 | {\r | |
88 | //\r | |
89 | // The end of variable store\r | |
90 | //\r | |
91 | return (VARIABLE_HEADER *) HEADER_ALIGN ((UINTN) VarStoreHeader + VarStoreHeader->Size);\r | |
92 | }\r | |
93 | \r | |
94 | \r | |
95 | /**\r | |
96 | This code checks if variable header is valid or not.\r | |
97 | \r | |
98 | @param Variable Pointer to the Variable Header.\r | |
99 | \r | |
100 | @retval TRUE Variable header is valid.\r | |
101 | @retval FALSE Variable header is not valid.\r | |
102 | \r | |
103 | **/\r | |
104 | BOOLEAN\r | |
105 | IsValidVariableHeader (\r | |
106 | IN VARIABLE_HEADER *Variable\r | |
107 | )\r | |
108 | {\r | |
109 | if (Variable == NULL || Variable->StartId != VARIABLE_DATA ) {\r | |
110 | return FALSE;\r | |
111 | }\r | |
112 | \r | |
113 | return TRUE;\r | |
114 | }\r | |
115 | \r | |
116 | \r | |
117 | /**\r | |
118 | This code gets the size of name of variable.\r | |
119 | \r | |
120 | @param Variable Pointer to the Variable Header.\r | |
121 | \r | |
122 | @return Size of variable in bytes in type UINTN.\r | |
123 | \r | |
124 | **/\r | |
125 | UINTN\r | |
126 | NameSizeOfVariable (\r | |
127 | IN VARIABLE_HEADER *Variable\r | |
128 | )\r | |
129 | {\r | |
130 | if (Variable->State == (UINT8) (-1) ||\r | |
131 | Variable->DataSize == (UINT32) (-1) ||\r | |
132 | Variable->NameSize == (UINT32) (-1) ||\r | |
133 | Variable->Attributes == (UINT32) (-1)) {\r | |
134 | return 0;\r | |
135 | }\r | |
136 | return (UINTN) Variable->NameSize;\r | |
137 | }\r | |
138 | \r | |
139 | \r | |
140 | /**\r | |
141 | This code gets the size of data of variable.\r | |
142 | \r | |
143 | @param Variable Pointer to the Variable Header.\r | |
144 | \r | |
145 | @return Size of variable in bytes in type UINTN.\r | |
146 | \r | |
147 | **/\r | |
148 | UINTN\r | |
149 | DataSizeOfVariable (\r | |
150 | IN VARIABLE_HEADER *Variable\r | |
151 | )\r | |
152 | {\r | |
153 | if (Variable->State == (UINT8) (-1) ||\r | |
154 | Variable->DataSize == (UINT32) (-1) ||\r | |
155 | Variable->NameSize == (UINT32) (-1) ||\r | |
156 | Variable->Attributes == (UINT32) (-1)) {\r | |
157 | return 0;\r | |
158 | }\r | |
159 | return (UINTN) Variable->DataSize;\r | |
160 | }\r | |
161 | \r | |
162 | /**\r | |
163 | This code gets the pointer to the variable name.\r | |
164 | \r | |
165 | @param Variable Pointer to the Variable Header.\r | |
166 | \r | |
167 | @return A CHAR16* pointer to Variable Name.\r | |
168 | \r | |
169 | **/\r | |
170 | CHAR16 *\r | |
171 | GetVariableNamePtr (\r | |
172 | IN VARIABLE_HEADER *Variable\r | |
173 | )\r | |
174 | {\r | |
0c18794e | 175 | return (CHAR16 *) (Variable + 1);\r |
176 | }\r | |
177 | \r | |
178 | \r | |
179 | /**\r | |
180 | This code gets the pointer to the variable data.\r | |
181 | \r | |
039a40aa SZ |
182 | @param Variable Pointer to the Variable Header.\r |
183 | @param VariableHeader Pointer to the Variable Header that has consecutive content.\r | |
0c18794e | 184 | \r |
185 | @return A UINT8* pointer to Variable Data.\r | |
186 | \r | |
187 | **/\r | |
188 | UINT8 *\r | |
189 | GetVariableDataPtr (\r | |
039a40aa SZ |
190 | IN VARIABLE_HEADER *Variable,\r |
191 | IN VARIABLE_HEADER *VariableHeader\r | |
0c18794e | 192 | )\r |
193 | {\r | |
194 | UINTN Value;\r | |
195 | \r | |
196 | //\r | |
197 | // Be careful about pad size for alignment\r | |
198 | //\r | |
199 | Value = (UINTN) GetVariableNamePtr (Variable);\r | |
039a40aa SZ |
200 | Value += NameSizeOfVariable (VariableHeader);\r |
201 | Value += GET_PAD_SIZE (NameSizeOfVariable (VariableHeader));\r | |
0c18794e | 202 | \r |
203 | return (UINT8 *) Value;\r | |
204 | }\r | |
205 | \r | |
206 | \r | |
207 | /**\r | |
208 | This code gets the pointer to the next variable header.\r | |
209 | \r | |
039a40aa SZ |
210 | @param StoreInfo Pointer to variable store info structure.\r |
211 | @param Variable Pointer to the Variable Header.\r | |
212 | @param VariableHeader Pointer to the Variable Header that has consecutive content.\r | |
0c18794e | 213 | \r |
214 | @return A VARIABLE_HEADER* pointer to next variable header.\r | |
215 | \r | |
216 | **/\r | |
217 | VARIABLE_HEADER *\r | |
218 | GetNextVariablePtr (\r | |
039a40aa SZ |
219 | IN VARIABLE_STORE_INFO *StoreInfo,\r |
220 | IN VARIABLE_HEADER *Variable,\r | |
221 | IN VARIABLE_HEADER *VariableHeader\r | |
0c18794e | 222 | )\r |
223 | {\r | |
039a40aa SZ |
224 | EFI_PHYSICAL_ADDRESS TargetAddress;\r |
225 | EFI_PHYSICAL_ADDRESS SpareAddress;\r | |
226 | UINTN Value;\r | |
0c18794e | 227 | \r |
039a40aa SZ |
228 | Value = (UINTN) GetVariableDataPtr (Variable, VariableHeader);\r |
229 | Value += DataSizeOfVariable (VariableHeader);\r | |
230 | Value += GET_PAD_SIZE (DataSizeOfVariable (VariableHeader));\r | |
0c18794e | 231 | //\r |
232 | // Be careful about pad size for alignment\r | |
233 | //\r | |
039a40aa SZ |
234 | Value = HEADER_ALIGN (Value);\r |
235 | \r | |
236 | if (StoreInfo->FtwLastWriteData != NULL) {\r | |
237 | TargetAddress = StoreInfo->FtwLastWriteData->TargetAddress;\r | |
238 | SpareAddress = StoreInfo->FtwLastWriteData->SpareAddress;\r | |
239 | if (((UINTN) Variable < (UINTN) TargetAddress) && (Value >= (UINTN) TargetAddress)) {\r | |
240 | //\r | |
241 | // Next variable is in spare block.\r | |
242 | //\r | |
243 | Value = (UINTN) SpareAddress + (Value - (UINTN) TargetAddress);\r | |
244 | }\r | |
245 | }\r | |
246 | \r | |
247 | return (VARIABLE_HEADER *) Value;\r | |
0c18794e | 248 | }\r |
249 | \r | |
250 | /**\r | |
039a40aa | 251 | Get variable store status.\r |
0c18794e | 252 | \r |
253 | @param VarStoreHeader Pointer to the Variable Store Header.\r | |
254 | \r | |
255 | @retval EfiRaw Variable store is raw\r | |
256 | @retval EfiValid Variable store is valid\r | |
257 | @retval EfiInvalid Variable store is invalid\r | |
258 | \r | |
259 | **/\r | |
260 | VARIABLE_STORE_STATUS\r | |
261 | GetVariableStoreStatus (\r | |
262 | IN VARIABLE_STORE_HEADER *VarStoreHeader\r | |
263 | )\r | |
264 | {\r | |
0c18794e | 265 | if (CompareGuid (&VarStoreHeader->Signature, &gEfiAuthenticatedVariableGuid) &&\r |
266 | VarStoreHeader->Format == VARIABLE_STORE_FORMATTED &&\r | |
267 | VarStoreHeader->State == VARIABLE_STORE_HEALTHY\r | |
268 | ) {\r | |
269 | \r | |
270 | return EfiValid;\r | |
271 | }\r | |
272 | \r | |
273 | if (((UINT32 *)(&VarStoreHeader->Signature))[0] == 0xffffffff &&\r | |
274 | ((UINT32 *)(&VarStoreHeader->Signature))[1] == 0xffffffff &&\r | |
275 | ((UINT32 *)(&VarStoreHeader->Signature))[2] == 0xffffffff &&\r | |
276 | ((UINT32 *)(&VarStoreHeader->Signature))[3] == 0xffffffff &&\r | |
277 | VarStoreHeader->Size == 0xffffffff &&\r | |
278 | VarStoreHeader->Format == 0xff &&\r | |
279 | VarStoreHeader->State == 0xff\r | |
280 | ) {\r | |
281 | \r | |
282 | return EfiRaw;\r | |
283 | } else {\r | |
284 | return EfiInvalid;\r | |
285 | }\r | |
286 | }\r | |
287 | \r | |
039a40aa SZ |
288 | /**\r |
289 | Compare two variable names, one of them may be inconsecutive.\r | |
290 | \r | |
291 | @param StoreInfo Pointer to variable store info structure.\r | |
292 | @param Name1 Pointer to one variable name.\r | |
293 | @param Name2 Pointer to another variable name.\r | |
294 | @param NameSize Variable name size.\r | |
295 | \r | |
296 | @retval TRUE Name1 and Name2 are identical.\r | |
297 | @retval FALSE Name1 and Name2 are not identical.\r | |
298 | \r | |
299 | **/\r | |
300 | BOOLEAN\r | |
301 | CompareVariableName (\r | |
302 | IN VARIABLE_STORE_INFO *StoreInfo,\r | |
303 | IN CONST CHAR16 *Name1,\r | |
304 | IN CONST CHAR16 *Name2,\r | |
305 | IN UINTN NameSize\r | |
306 | )\r | |
307 | {\r | |
308 | EFI_PHYSICAL_ADDRESS TargetAddress;\r | |
309 | EFI_PHYSICAL_ADDRESS SpareAddress;\r | |
310 | UINTN PartialNameSize;\r | |
311 | \r | |
312 | if (StoreInfo->FtwLastWriteData != NULL) {\r | |
313 | TargetAddress = StoreInfo->FtwLastWriteData->TargetAddress;\r | |
314 | SpareAddress = StoreInfo->FtwLastWriteData->SpareAddress;\r | |
315 | if (((UINTN) Name1 < (UINTN) TargetAddress) && (((UINTN) Name1 + NameSize) > (UINTN) TargetAddress)) {\r | |
316 | //\r | |
317 | // Name1 is inconsecutive.\r | |
318 | //\r | |
319 | PartialNameSize = (UINTN) TargetAddress - (UINTN) Name1;\r | |
320 | //\r | |
321 | // Partial content is in NV storage.\r | |
322 | //\r | |
323 | if (CompareMem ((UINT8 *) Name1, (UINT8 *) Name2, PartialNameSize) == 0) {\r | |
324 | //\r | |
325 | // Another partial content is in spare block.\r | |
326 | //\r | |
327 | if (CompareMem ((UINT8 *) (UINTN) SpareAddress, (UINT8 *) Name2 + PartialNameSize, NameSize - PartialNameSize) == 0) {\r | |
328 | return TRUE;\r | |
329 | }\r | |
330 | }\r | |
331 | return FALSE;\r | |
332 | } else if (((UINTN) Name2 < (UINTN) TargetAddress) && (((UINTN) Name2 + NameSize) > (UINTN) TargetAddress)) {\r | |
333 | //\r | |
334 | // Name2 is inconsecutive.\r | |
335 | //\r | |
336 | PartialNameSize = (UINTN) TargetAddress - (UINTN) Name2;\r | |
337 | //\r | |
338 | // Partial content is in NV storage.\r | |
339 | //\r | |
340 | if (CompareMem ((UINT8 *) Name2, (UINT8 *) Name1, PartialNameSize) == 0) {\r | |
341 | //\r | |
342 | // Another partial content is in spare block.\r | |
343 | //\r | |
344 | if (CompareMem ((UINT8 *) (UINTN) SpareAddress, (UINT8 *) Name1 + PartialNameSize, NameSize - PartialNameSize) == 0) {\r | |
345 | return TRUE;\r | |
346 | }\r | |
347 | }\r | |
348 | return FALSE;\r | |
349 | }\r | |
350 | }\r | |
351 | \r | |
352 | //\r | |
353 | // Both Name1 and Name2 are consecutive.\r | |
354 | //\r | |
355 | if (CompareMem ((UINT8 *) Name1, (UINT8 *) Name2, NameSize) == 0) {\r | |
356 | return TRUE;\r | |
357 | }\r | |
358 | return FALSE;\r | |
359 | }\r | |
0c18794e | 360 | \r |
361 | /**\r | |
362 | This function compares a variable with variable entries in database.\r | |
363 | \r | |
039a40aa | 364 | @param StoreInfo Pointer to variable store info structure.\r |
0c18794e | 365 | @param Variable Pointer to the variable in our database\r |
039a40aa | 366 | @param VariableHeader Pointer to the Variable Header that has consecutive content.\r |
0c18794e | 367 | @param VariableName Name of the variable to compare to 'Variable'\r |
368 | @param VendorGuid GUID of the variable to compare to 'Variable'\r | |
369 | @param PtrTrack Variable Track Pointer structure that contains Variable Information.\r | |
370 | \r | |
371 | @retval EFI_SUCCESS Found match variable\r | |
372 | @retval EFI_NOT_FOUND Variable not found\r | |
373 | \r | |
374 | **/\r | |
375 | EFI_STATUS\r | |
376 | CompareWithValidVariable (\r | |
039a40aa | 377 | IN VARIABLE_STORE_INFO *StoreInfo,\r |
0c18794e | 378 | IN VARIABLE_HEADER *Variable,\r |
039a40aa | 379 | IN VARIABLE_HEADER *VariableHeader,\r |
0c18794e | 380 | IN CONST CHAR16 *VariableName,\r |
381 | IN CONST EFI_GUID *VendorGuid,\r | |
382 | OUT VARIABLE_POINTER_TRACK *PtrTrack\r | |
383 | )\r | |
384 | {\r | |
385 | VOID *Point;\r | |
386 | \r | |
387 | if (VariableName[0] == 0) {\r | |
388 | PtrTrack->CurrPtr = Variable;\r | |
389 | return EFI_SUCCESS;\r | |
390 | } else {\r | |
391 | //\r | |
392 | // Don't use CompareGuid function here for performance reasons.\r | |
393 | // Instead we compare the GUID a UINT32 at a time and branch\r | |
394 | // on the first failed comparison.\r | |
395 | //\r | |
039a40aa SZ |
396 | if ((((INT32 *) VendorGuid)[0] == ((INT32 *) &VariableHeader->VendorGuid)[0]) &&\r |
397 | (((INT32 *) VendorGuid)[1] == ((INT32 *) &VariableHeader->VendorGuid)[1]) &&\r | |
398 | (((INT32 *) VendorGuid)[2] == ((INT32 *) &VariableHeader->VendorGuid)[2]) &&\r | |
399 | (((INT32 *) VendorGuid)[3] == ((INT32 *) &VariableHeader->VendorGuid)[3])\r | |
0c18794e | 400 | ) {\r |
039a40aa | 401 | ASSERT (NameSizeOfVariable (VariableHeader) != 0);\r |
0c18794e | 402 | Point = (VOID *) GetVariableNamePtr (Variable);\r |
039a40aa | 403 | if (CompareVariableName (StoreInfo, VariableName, Point, NameSizeOfVariable (VariableHeader))) {\r |
0c18794e | 404 | PtrTrack->CurrPtr = Variable;\r |
405 | return EFI_SUCCESS;\r | |
406 | }\r | |
407 | }\r | |
408 | }\r | |
409 | \r | |
410 | return EFI_NOT_FOUND;\r | |
411 | }\r | |
412 | \r | |
9a000b46 | 413 | /**\r |
039a40aa | 414 | Return the variable store header and the store info based on the Index.\r |
9a000b46 | 415 | \r |
039a40aa SZ |
416 | @param Type The type of the variable store.\r |
417 | @param StoreInfo Return the store info.\r | |
9a000b46 RN |
418 | \r |
419 | @return Pointer to the variable store header.\r | |
420 | **/\r | |
421 | VARIABLE_STORE_HEADER *\r | |
422 | GetVariableStore (\r | |
423 | IN VARIABLE_STORE_TYPE Type,\r | |
039a40aa | 424 | OUT VARIABLE_STORE_INFO *StoreInfo\r |
9a000b46 RN |
425 | )\r |
426 | {\r | |
039a40aa SZ |
427 | EFI_HOB_GUID_TYPE *GuidHob;\r |
428 | EFI_FIRMWARE_VOLUME_HEADER *FvHeader;\r | |
429 | VARIABLE_STORE_HEADER *VariableStoreHeader;\r | |
430 | EFI_PHYSICAL_ADDRESS NvStorageBase;\r | |
431 | UINT32 NvStorageSize;\r | |
432 | FAULT_TOLERANT_WRITE_LAST_WRITE_DATA *FtwLastWriteData;\r | |
433 | UINT32 BackUpOffset;\r | |
434 | \r | |
435 | StoreInfo->IndexTable = NULL;\r | |
436 | StoreInfo->FtwLastWriteData = NULL;\r | |
9a000b46 RN |
437 | VariableStoreHeader = NULL;\r |
438 | switch (Type) {\r | |
439 | case VariableStoreTypeHob:\r | |
440 | GuidHob = GetFirstGuidHob (&gEfiAuthenticatedVariableGuid);\r | |
441 | if (GuidHob != NULL) {\r | |
442 | VariableStoreHeader = (VARIABLE_STORE_HEADER *) GET_GUID_HOB_DATA (GuidHob);\r | |
443 | }\r | |
444 | break;\r | |
445 | \r | |
446 | case VariableStoreTypeNv:\r | |
447 | if (GetBootModeHob () != BOOT_IN_RECOVERY_MODE) {\r | |
448 | //\r | |
449 | // The content of NV storage for variable is not reliable in recovery boot mode.\r | |
450 | //\r | |
039a40aa SZ |
451 | \r |
452 | NvStorageSize = PcdGet32 (PcdFlashNvStorageVariableSize);\r | |
453 | NvStorageBase = (EFI_PHYSICAL_ADDRESS) (PcdGet64 (PcdFlashNvStorageVariableBase64) != 0 ? \r | |
454 | PcdGet64 (PcdFlashNvStorageVariableBase64) : \r | |
455 | PcdGet32 (PcdFlashNvStorageVariableBase)\r | |
456 | );\r | |
457 | //\r | |
458 | // First let FvHeader point to NV storage base.\r | |
459 | //\r | |
460 | FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) (UINTN) NvStorageBase;\r | |
461 | \r | |
462 | //\r | |
463 | // Check the FTW last write data hob.\r | |
464 | //\r | |
465 | BackUpOffset = 0;\r | |
466 | GuidHob = GetFirstGuidHob (&gEdkiiFaultTolerantWriteGuid);\r | |
467 | if (GuidHob != NULL) {\r | |
468 | FtwLastWriteData = (FAULT_TOLERANT_WRITE_LAST_WRITE_DATA *) GET_GUID_HOB_DATA (GuidHob);\r | |
469 | if (FtwLastWriteData->TargetAddress == NvStorageBase) {\r | |
470 | //\r | |
471 | // Let FvHeader point to spare block.\r | |
472 | //\r | |
473 | FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) (UINTN) FtwLastWriteData->SpareAddress;\r | |
474 | DEBUG ((EFI_D_INFO, "PeiVariable: NV storage is backed up in spare block: 0x%x\n", (UINTN) FtwLastWriteData->SpareAddress));\r | |
475 | } else if ((FtwLastWriteData->TargetAddress > NvStorageBase) && (FtwLastWriteData->TargetAddress < (NvStorageBase + NvStorageSize))) {\r | |
476 | StoreInfo->FtwLastWriteData = FtwLastWriteData;\r | |
477 | //\r | |
478 | // Flash NV storage from the offset is backed up in spare block.\r | |
479 | //\r | |
480 | BackUpOffset = (UINT32) (FtwLastWriteData->TargetAddress - NvStorageBase);\r | |
481 | DEBUG ((EFI_D_INFO, "PeiVariable: High partial NV storage from offset: %x is backed up in spare block: 0x%x\n", BackUpOffset, (UINTN) FtwLastWriteData->SpareAddress));\r | |
482 | //\r | |
483 | // At least one block data in flash NV storage is still valid, so still leave FvHeader point to NV storage base.\r | |
484 | //\r | |
485 | }\r | |
486 | }\r | |
4d832aab | 487 | \r |
488 | //\r | |
489 | // Check if the Firmware Volume is not corrupted\r | |
490 | //\r | |
491 | if ((FvHeader->Signature != EFI_FVH_SIGNATURE) || (!CompareGuid (&gEfiSystemNvDataFvGuid, &FvHeader->FileSystemGuid))) {\r | |
492 | DEBUG ((EFI_D_ERROR, "Firmware Volume for Variable Store is corrupted\n"));\r | |
493 | break;\r | |
494 | }\r | |
495 | \r | |
9a000b46 RN |
496 | VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINT8 *) FvHeader + FvHeader->HeaderLength);\r |
497 | \r | |
039a40aa SZ |
498 | GuidHob = GetFirstGuidHob (&gEfiVariableIndexTableGuid);\r |
499 | if (GuidHob != NULL) {\r | |
500 | StoreInfo->IndexTable = GET_GUID_HOB_DATA (GuidHob);\r | |
501 | } else {\r | |
502 | //\r | |
503 | // If it's the first time to access variable region in flash, create a guid hob to record\r | |
504 | // VAR_ADDED type variable info.\r | |
505 | // Note that as the resource of PEI phase is limited, only store the limited number of \r | |
506 | // VAR_ADDED type variables to reduce access time.\r | |
507 | //\r | |
508 | StoreInfo->IndexTable = (VARIABLE_INDEX_TABLE *) BuildGuidHob (&gEfiVariableIndexTableGuid, sizeof (VARIABLE_INDEX_TABLE));\r | |
509 | StoreInfo->IndexTable->Length = 0;\r | |
510 | StoreInfo->IndexTable->StartPtr = GetStartPointer (VariableStoreHeader);\r | |
511 | StoreInfo->IndexTable->EndPtr = GetEndPointer (VariableStoreHeader);\r | |
512 | StoreInfo->IndexTable->GoneThrough = 0;\r | |
9a000b46 RN |
513 | }\r |
514 | }\r | |
515 | break;\r | |
516 | \r | |
517 | default:\r | |
518 | ASSERT (FALSE);\r | |
519 | break;\r | |
520 | }\r | |
521 | \r | |
039a40aa | 522 | StoreInfo->VariableStoreHeader = VariableStoreHeader;\r |
9a000b46 RN |
523 | return VariableStoreHeader;\r |
524 | }\r | |
0c18794e | 525 | \r |
039a40aa SZ |
526 | /**\r |
527 | Get variable header that has consecutive content.\r | |
528 | \r | |
529 | @param StoreInfo Pointer to variable store info structure.\r | |
530 | @param Variable Pointer to the Variable Header.\r | |
531 | @param VariableHeader Pointer to Pointer to the Variable Header that has consecutive content.\r | |
532 | \r | |
533 | @retval TRUE Variable header is valid.\r | |
534 | @retval FALSE Variable header is not valid.\r | |
535 | \r | |
536 | **/\r | |
537 | BOOLEAN\r | |
538 | GetVariableHeader (\r | |
539 | IN VARIABLE_STORE_INFO *StoreInfo,\r | |
540 | IN VARIABLE_HEADER *Variable,\r | |
541 | OUT VARIABLE_HEADER **VariableHeader\r | |
542 | )\r | |
543 | {\r | |
544 | EFI_PHYSICAL_ADDRESS TargetAddress;\r | |
545 | EFI_PHYSICAL_ADDRESS SpareAddress;\r | |
546 | EFI_HOB_GUID_TYPE *GuidHob;\r | |
547 | UINTN PartialHeaderSize;\r | |
548 | \r | |
549 | //\r | |
550 | // First assume variable header pointed by Variable is consecutive.\r | |
551 | //\r | |
552 | *VariableHeader = Variable;\r | |
553 | \r | |
554 | if ((Variable != NULL) && (StoreInfo->FtwLastWriteData != NULL)) {\r | |
555 | TargetAddress = StoreInfo->FtwLastWriteData->TargetAddress;\r | |
556 | SpareAddress = StoreInfo->FtwLastWriteData->SpareAddress;\r | |
557 | if (((UINTN) Variable < (UINTN) TargetAddress) && (((UINTN) Variable + sizeof (VARIABLE_HEADER)) > (UINTN) TargetAddress)) {\r | |
558 | //\r | |
559 | // Variable header pointed by Variable is inconsecutive,\r | |
560 | // create a guid hob to combine the two partial variable header content together.\r | |
561 | //\r | |
562 | GuidHob = GetFirstGuidHob (&gEfiCallerIdGuid);\r | |
563 | if (GuidHob != NULL) {\r | |
564 | *VariableHeader = (VARIABLE_HEADER *) GET_GUID_HOB_DATA (GuidHob);\r | |
565 | } else {\r | |
566 | *VariableHeader = (VARIABLE_HEADER *) BuildGuidHob (&gEfiCallerIdGuid, sizeof (VARIABLE_HEADER));\r | |
567 | PartialHeaderSize = (UINTN) TargetAddress - (UINTN) Variable;\r | |
568 | //\r | |
569 | // Partial content is in NV storage.\r | |
570 | //\r | |
571 | CopyMem ((UINT8 *) *VariableHeader, (UINT8 *) Variable, PartialHeaderSize);\r | |
572 | //\r | |
573 | // Another partial content is in spare block.\r | |
574 | //\r | |
575 | CopyMem ((UINT8 *) *VariableHeader + PartialHeaderSize, (UINT8 *) (UINTN) SpareAddress, sizeof (VARIABLE_HEADER) - PartialHeaderSize);\r | |
576 | }\r | |
577 | }\r | |
578 | }\r | |
579 | \r | |
580 | return IsValidVariableHeader (*VariableHeader);\r | |
581 | }\r | |
582 | \r | |
583 | /**\r | |
584 | Get variable name or data to output buffer.\r | |
585 | \r | |
586 | @param StoreInfo Pointer to variable store info structure.\r | |
587 | @param NameOrData Pointer to the variable name/data that may be inconsecutive.\r | |
588 | @param Size Variable name/data size.\r | |
589 | @param Buffer Pointer to output buffer to hold the variable name/data.\r | |
590 | \r | |
591 | **/\r | |
592 | VOID\r | |
593 | GetVariableNameOrData (\r | |
594 | IN VARIABLE_STORE_INFO *StoreInfo,\r | |
595 | IN UINT8 *NameOrData,\r | |
596 | IN UINTN Size,\r | |
597 | OUT UINT8 *Buffer\r | |
598 | )\r | |
599 | {\r | |
600 | EFI_PHYSICAL_ADDRESS TargetAddress;\r | |
601 | EFI_PHYSICAL_ADDRESS SpareAddress;\r | |
602 | UINTN PartialSize;\r | |
603 | \r | |
604 | if (StoreInfo->FtwLastWriteData != NULL) {\r | |
605 | TargetAddress = StoreInfo->FtwLastWriteData->TargetAddress;\r | |
606 | SpareAddress = StoreInfo->FtwLastWriteData->SpareAddress;\r | |
607 | if (((UINTN) NameOrData < (UINTN) TargetAddress) && (((UINTN) NameOrData + Size) > (UINTN) TargetAddress)) {\r | |
608 | //\r | |
609 | // Variable name/data is inconsecutive.\r | |
610 | //\r | |
611 | PartialSize = (UINTN) TargetAddress - (UINTN) NameOrData;\r | |
612 | //\r | |
613 | // Partial content is in NV storage.\r | |
614 | //\r | |
615 | CopyMem (Buffer, NameOrData, PartialSize);\r | |
616 | //\r | |
617 | // Another partial content is in spare block.\r | |
618 | //\r | |
619 | CopyMem (Buffer + PartialSize, (UINT8 *) (UINTN) SpareAddress, Size - PartialSize);\r | |
620 | return;\r | |
621 | }\r | |
622 | }\r | |
623 | \r | |
624 | //\r | |
625 | // Variable name/data is consecutive.\r | |
626 | //\r | |
627 | CopyMem (Buffer, NameOrData, Size);\r | |
628 | }\r | |
629 | \r | |
0c18794e | 630 | /**\r |
9a000b46 | 631 | Find the variable in the specified variable store.\r |
0c18794e | 632 | \r |
039a40aa | 633 | @param StoreInfo Pointer to the store info structure.\r |
9a000b46 RN |
634 | @param VariableName Name of the variable to be found\r |
635 | @param VendorGuid Vendor GUID to be found.\r | |
636 | @param PtrTrack Variable Track Pointer structure that contains Variable Information.\r | |
0c18794e | 637 | \r |
638 | @retval EFI_SUCCESS Variable found successfully\r | |
639 | @retval EFI_NOT_FOUND Variable not found\r | |
640 | @retval EFI_INVALID_PARAMETER Invalid variable name\r | |
641 | \r | |
642 | **/\r | |
643 | EFI_STATUS\r | |
9a000b46 | 644 | FindVariableEx (\r |
039a40aa | 645 | IN VARIABLE_STORE_INFO *StoreInfo,\r |
9a000b46 RN |
646 | IN CONST CHAR16 *VariableName,\r |
647 | IN CONST EFI_GUID *VendorGuid,\r | |
648 | OUT VARIABLE_POINTER_TRACK *PtrTrack\r | |
0c18794e | 649 | )\r |
650 | {\r | |
0c18794e | 651 | VARIABLE_HEADER *Variable;\r |
652 | VARIABLE_HEADER *LastVariable;\r | |
653 | VARIABLE_HEADER *MaxIndex;\r | |
9a000b46 RN |
654 | UINTN Index;\r |
655 | UINTN Offset;\r | |
0c18794e | 656 | BOOLEAN StopRecord;\r |
932e0f66 | 657 | VARIABLE_HEADER *InDeletedVariable;\r |
039a40aa SZ |
658 | VARIABLE_STORE_HEADER *VariableStoreHeader;\r |
659 | VARIABLE_INDEX_TABLE *IndexTable;\r | |
660 | VARIABLE_HEADER *VariableHeader;\r | |
661 | \r | |
662 | VariableStoreHeader = StoreInfo->VariableStoreHeader;\r | |
0c18794e | 663 | \r |
9a000b46 | 664 | if (VariableStoreHeader == NULL) {\r |
0c18794e | 665 | return EFI_INVALID_PARAMETER;\r |
666 | }\r | |
9a000b46 RN |
667 | \r |
668 | if (GetVariableStoreStatus (VariableStoreHeader) != EfiValid) {\r | |
669 | return EFI_UNSUPPORTED;\r | |
670 | }\r | |
671 | \r | |
672 | if (~VariableStoreHeader->Size == 0) {\r | |
673 | return EFI_NOT_FOUND;\r | |
674 | }\r | |
675 | \r | |
039a40aa | 676 | IndexTable = StoreInfo->IndexTable;\r |
9a000b46 RN |
677 | PtrTrack->StartPtr = GetStartPointer (VariableStoreHeader);\r |
678 | PtrTrack->EndPtr = GetEndPointer (VariableStoreHeader);\r | |
679 | \r | |
932e0f66 SZ |
680 | InDeletedVariable = NULL;\r |
681 | \r | |
0c18794e | 682 | //\r |
683 | // No Variable Address equals zero, so 0 as initial value is safe.\r | |
684 | //\r | |
9a000b46 | 685 | MaxIndex = NULL;\r |
039a40aa | 686 | VariableHeader = NULL;\r |
0c18794e | 687 | \r |
9a000b46 | 688 | if (IndexTable != NULL) {\r |
0c18794e | 689 | //\r |
9a000b46 RN |
690 | // traverse the variable index table to look for varible.\r |
691 | // The IndexTable->Index[Index] records the distance of two neighbouring VAR_ADDED type variables.\r | |
0c18794e | 692 | //\r |
9a000b46 RN |
693 | for (Offset = 0, Index = 0; Index < IndexTable->Length; Index++) {\r |
694 | ASSERT (Index < sizeof (IndexTable->Index) / sizeof (IndexTable->Index[0]));\r | |
695 | Offset += IndexTable->Index[Index];\r | |
696 | MaxIndex = (VARIABLE_HEADER *) ((UINT8 *) IndexTable->StartPtr + Offset);\r | |
039a40aa SZ |
697 | GetVariableHeader (StoreInfo, MaxIndex, &VariableHeader);\r |
698 | if (CompareWithValidVariable (StoreInfo, MaxIndex, VariableHeader, VariableName, VendorGuid, PtrTrack) == EFI_SUCCESS) {\r | |
699 | if (VariableHeader->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r | |
932e0f66 SZ |
700 | InDeletedVariable = PtrTrack->CurrPtr;\r |
701 | } else {\r | |
702 | return EFI_SUCCESS;\r | |
703 | }\r | |
0c18794e | 704 | }\r |
705 | }\r | |
706 | \r | |
707 | if (IndexTable->GoneThrough != 0) {\r | |
9a000b46 | 708 | //\r |
932e0f66 | 709 | // If the table has all the existing variables indexed, return.\r |
9a000b46 | 710 | //\r |
932e0f66 SZ |
711 | PtrTrack->CurrPtr = InDeletedVariable;\r |
712 | return (PtrTrack->CurrPtr == NULL) ? EFI_NOT_FOUND : EFI_SUCCESS;\r | |
0c18794e | 713 | }\r |
714 | }\r | |
9a000b46 | 715 | \r |
0c18794e | 716 | if (MaxIndex != NULL) {\r |
9a000b46 RN |
717 | //\r |
718 | // HOB exists but the variable cannot be found in HOB\r | |
719 | // If not found in HOB, then let's start from the MaxIndex we've found.\r | |
720 | //\r | |
039a40aa | 721 | Variable = GetNextVariablePtr (StoreInfo, MaxIndex, VariableHeader);\r |
0c18794e | 722 | LastVariable = MaxIndex;\r |
723 | } else {\r | |
9a000b46 RN |
724 | //\r |
725 | // Start Pointers for the variable.\r | |
726 | // Actual Data Pointer where data can be written.\r | |
727 | //\r | |
728 | Variable = PtrTrack->StartPtr;\r | |
729 | LastVariable = PtrTrack->StartPtr;\r | |
0c18794e | 730 | }\r |
9a000b46 | 731 | \r |
0c18794e | 732 | //\r |
932e0f66 | 733 | // Find the variable by walk through variable store\r |
0c18794e | 734 | //\r |
9a000b46 | 735 | StopRecord = FALSE;\r |
039a40aa SZ |
736 | while (GetVariableHeader (StoreInfo, Variable, &VariableHeader)) {\r |
737 | if (VariableHeader->State == VAR_ADDED || VariableHeader->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r | |
0c18794e | 738 | //\r |
739 | // Record Variable in VariableIndex HOB\r | |
740 | //\r | |
9a000b46 RN |
741 | if ((IndexTable != NULL) && !StopRecord) {\r |
742 | Offset = (UINTN) Variable - (UINTN) LastVariable;\r | |
743 | if ((Offset > 0x0FFFF) || (IndexTable->Length == sizeof (IndexTable->Index) / sizeof (IndexTable->Index[0]))) {\r | |
744 | //\r | |
745 | // Stop to record if the distance of two neighbouring VAR_ADDED variable is larger than the allowable scope(UINT16),\r | |
746 | // or the record buffer is full.\r | |
747 | //\r | |
0c18794e | 748 | StopRecord = TRUE;\r |
9a000b46 | 749 | } else {\r |
0c18794e | 750 | IndexTable->Index[IndexTable->Length++] = (UINT16) Offset;\r |
9a000b46 | 751 | LastVariable = Variable;\r |
0c18794e | 752 | }\r |
0c18794e | 753 | }\r |
754 | \r | |
039a40aa SZ |
755 | if (CompareWithValidVariable (StoreInfo, Variable, VariableHeader, VariableName, VendorGuid, PtrTrack) == EFI_SUCCESS) {\r |
756 | if (VariableHeader->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r | |
932e0f66 SZ |
757 | InDeletedVariable = PtrTrack->CurrPtr;\r |
758 | } else {\r | |
759 | return EFI_SUCCESS;\r | |
760 | }\r | |
0c18794e | 761 | }\r |
762 | }\r | |
763 | \r | |
039a40aa | 764 | Variable = GetNextVariablePtr (StoreInfo, Variable, VariableHeader);\r |
0c18794e | 765 | }\r |
766 | //\r | |
767 | // If gone through the VariableStore, that means we never find in Firmware any more.\r | |
768 | //\r | |
9a000b46 | 769 | if ((IndexTable != NULL) && !StopRecord) {\r |
0c18794e | 770 | IndexTable->GoneThrough = 1;\r |
771 | }\r | |
772 | \r | |
932e0f66 | 773 | PtrTrack->CurrPtr = InDeletedVariable;\r |
0c18794e | 774 | \r |
932e0f66 | 775 | return (PtrTrack->CurrPtr == NULL) ? EFI_NOT_FOUND : EFI_SUCCESS;\r |
0c18794e | 776 | }\r |
777 | \r | |
9a000b46 RN |
778 | /**\r |
779 | Find the variable in HOB and Non-Volatile variable storages.\r | |
780 | \r | |
781 | @param VariableName Name of the variable to be found\r | |
782 | @param VendorGuid Vendor GUID to be found.\r | |
783 | @param PtrTrack Variable Track Pointer structure that contains Variable Information.\r | |
039a40aa | 784 | @param StoreInfo Return the store info.\r |
9a000b46 RN |
785 | \r |
786 | @retval EFI_SUCCESS Variable found successfully\r | |
787 | @retval EFI_NOT_FOUND Variable not found\r | |
788 | @retval EFI_INVALID_PARAMETER Invalid variable name\r | |
789 | **/\r | |
790 | EFI_STATUS\r | |
791 | FindVariable (\r | |
792 | IN CONST CHAR16 *VariableName,\r | |
793 | IN CONST EFI_GUID *VendorGuid,\r | |
039a40aa SZ |
794 | OUT VARIABLE_POINTER_TRACK *PtrTrack,\r |
795 | OUT VARIABLE_STORE_INFO *StoreInfo\r | |
9a000b46 RN |
796 | )\r |
797 | {\r | |
798 | EFI_STATUS Status;\r | |
9a000b46 RN |
799 | VARIABLE_STORE_TYPE Type;\r |
800 | \r | |
801 | if (VariableName[0] != 0 && VendorGuid == NULL) {\r | |
802 | return EFI_INVALID_PARAMETER;\r | |
803 | }\r | |
804 | \r | |
805 | for (Type = (VARIABLE_STORE_TYPE) 0; Type < VariableStoreTypeMax; Type++) {\r | |
039a40aa | 806 | GetVariableStore (Type, StoreInfo);\r |
9a000b46 | 807 | Status = FindVariableEx (\r |
039a40aa | 808 | StoreInfo,\r |
9a000b46 RN |
809 | VariableName,\r |
810 | VendorGuid, \r | |
811 | PtrTrack\r | |
812 | );\r | |
813 | if (!EFI_ERROR (Status)) {\r | |
814 | return Status;\r | |
815 | }\r | |
816 | }\r | |
817 | \r | |
818 | return EFI_NOT_FOUND;\r | |
819 | }\r | |
820 | \r | |
0c18794e | 821 | /**\r |
822 | This service retrieves a variable's value using its name and GUID.\r | |
823 | \r | |
824 | Read the specified variable from the UEFI variable store. If the Data \r | |
825 | buffer is too small to hold the contents of the variable, the error\r | |
826 | EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the required buffer\r | |
827 | size to obtain the data.\r | |
828 | \r | |
829 | @param This A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.\r | |
830 | @param VariableName A pointer to a null-terminated string that is the variable's name.\r | |
831 | @param VariableGuid A pointer to an EFI_GUID that is the variable's GUID. The combination of\r | |
832 | VariableGuid and VariableName must be unique.\r | |
833 | @param Attributes If non-NULL, on return, points to the variable's attributes.\r | |
834 | @param DataSize On entry, points to the size in bytes of the Data buffer.\r | |
835 | On return, points to the size of the data returned in Data.\r | |
836 | @param Data Points to the buffer which will hold the returned variable value.\r | |
837 | \r | |
838 | @retval EFI_SUCCESS The variable was read successfully.\r | |
839 | @retval EFI_NOT_FOUND The variable could not be found.\r | |
840 | @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the resulting data. \r | |
841 | DataSize is updated with the size required for \r | |
842 | the specified variable.\r | |
843 | @retval EFI_INVALID_PARAMETER VariableName, VariableGuid, DataSize or Data is NULL.\r | |
844 | @retval EFI_DEVICE_ERROR The variable could not be retrieved because of a device error.\r | |
845 | \r | |
846 | **/\r | |
847 | EFI_STATUS\r | |
848 | EFIAPI\r | |
849 | PeiGetVariable (\r | |
850 | IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r | |
851 | IN CONST CHAR16 *VariableName,\r | |
852 | IN CONST EFI_GUID *VariableGuid,\r | |
853 | OUT UINT32 *Attributes,\r | |
854 | IN OUT UINTN *DataSize,\r | |
855 | OUT VOID *Data\r | |
856 | )\r | |
857 | {\r | |
858 | VARIABLE_POINTER_TRACK Variable;\r | |
859 | UINTN VarDataSize;\r | |
860 | EFI_STATUS Status;\r | |
039a40aa SZ |
861 | VARIABLE_STORE_INFO StoreInfo;\r |
862 | VARIABLE_HEADER *VariableHeader;\r | |
0c18794e | 863 | \r |
0c18794e | 864 | if (VariableName == NULL || VariableGuid == NULL || DataSize == NULL) {\r |
865 | return EFI_INVALID_PARAMETER;\r | |
866 | }\r | |
1f58a5dc | 867 | \r |
0c18794e | 868 | //\r |
869 | // Find existing variable\r | |
870 | //\r | |
039a40aa | 871 | Status = FindVariable (VariableName, VariableGuid, &Variable, &StoreInfo);\r |
9a000b46 | 872 | if (EFI_ERROR (Status)) {\r |
0c18794e | 873 | return Status;\r |
874 | }\r | |
039a40aa SZ |
875 | GetVariableHeader (&StoreInfo, Variable.CurrPtr, &VariableHeader);\r |
876 | \r | |
0c18794e | 877 | //\r |
878 | // Get data size\r | |
879 | //\r | |
039a40aa | 880 | VarDataSize = DataSizeOfVariable (VariableHeader);\r |
0c18794e | 881 | if (*DataSize >= VarDataSize) {\r |
882 | if (Data == NULL) {\r | |
883 | return EFI_INVALID_PARAMETER;\r | |
884 | }\r | |
885 | \r | |
039a40aa | 886 | GetVariableNameOrData (&StoreInfo, GetVariableDataPtr (Variable.CurrPtr, VariableHeader), VarDataSize, Data);\r |
0c18794e | 887 | \r |
888 | if (Attributes != NULL) {\r | |
039a40aa | 889 | *Attributes = VariableHeader->Attributes;\r |
0c18794e | 890 | }\r |
891 | \r | |
892 | *DataSize = VarDataSize;\r | |
893 | return EFI_SUCCESS;\r | |
894 | } else {\r | |
895 | *DataSize = VarDataSize;\r | |
896 | return EFI_BUFFER_TOO_SMALL;\r | |
897 | }\r | |
898 | }\r | |
899 | \r | |
900 | /**\r | |
901 | Return the next variable name and GUID.\r | |
902 | \r | |
903 | This function is called multiple times to retrieve the VariableName \r | |
904 | and VariableGuid of all variables currently available in the system. \r | |
905 | On each call, the previous results are passed into the interface, \r | |
906 | and, on return, the interface returns the data for the next \r | |
907 | interface. When the entire variable list has been returned, \r | |
908 | EFI_NOT_FOUND is returned.\r | |
909 | \r | |
910 | @param This A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.\r | |
911 | \r | |
912 | @param VariableNameSize On entry, points to the size of the buffer pointed to by VariableName.\r | |
913 | On return, the size of the variable name buffer.\r | |
914 | @param VariableName On entry, a pointer to a null-terminated string that is the variable's name.\r | |
915 | On return, points to the next variable's null-terminated name string.\r | |
916 | @param VariableGuid On entry, a pointer to an EFI_GUID that is the variable's GUID. \r | |
917 | On return, a pointer to the next variable's GUID.\r | |
918 | \r | |
919 | @retval EFI_SUCCESS The variable was read successfully.\r | |
920 | @retval EFI_NOT_FOUND The variable could not be found.\r | |
921 | @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the resulting\r | |
922 | data. VariableNameSize is updated with the size\r | |
923 | required for the specified variable.\r | |
924 | @retval EFI_INVALID_PARAMETER VariableName, VariableGuid or\r | |
925 | VariableNameSize is NULL.\r | |
926 | @retval EFI_DEVICE_ERROR The variable could not be retrieved because of a device error.\r | |
927 | \r | |
928 | **/\r | |
929 | EFI_STATUS\r | |
930 | EFIAPI\r | |
931 | PeiGetNextVariableName (\r | |
932 | IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r | |
933 | IN OUT UINTN *VariableNameSize,\r | |
934 | IN OUT CHAR16 *VariableName,\r | |
935 | IN OUT EFI_GUID *VariableGuid\r | |
936 | )\r | |
937 | {\r | |
9a000b46 | 938 | VARIABLE_STORE_TYPE Type;\r |
0c18794e | 939 | VARIABLE_POINTER_TRACK Variable;\r |
9a000b46 | 940 | VARIABLE_POINTER_TRACK VariableInHob;\r |
932e0f66 | 941 | VARIABLE_POINTER_TRACK VariablePtrTrack;\r |
0c18794e | 942 | UINTN VarNameSize;\r |
943 | EFI_STATUS Status;\r | |
9a000b46 | 944 | VARIABLE_STORE_HEADER *VariableStoreHeader[VariableStoreTypeMax];\r |
039a40aa SZ |
945 | VARIABLE_HEADER *VariableHeader;\r |
946 | VARIABLE_STORE_INFO StoreInfo;\r | |
947 | VARIABLE_STORE_INFO StoreInfoForNv;\r | |
948 | VARIABLE_STORE_INFO StoreInfoForHob;\r | |
0c18794e | 949 | \r |
0c18794e | 950 | if (VariableName == NULL || VariableGuid == NULL || VariableNameSize == NULL) {\r |
951 | return EFI_INVALID_PARAMETER;\r | |
952 | }\r | |
953 | \r | |
039a40aa | 954 | Status = FindVariable (VariableName, VariableGuid, &Variable, &StoreInfo);\r |
0c18794e | 955 | if (Variable.CurrPtr == NULL || Status != EFI_SUCCESS) {\r |
956 | return Status;\r | |
957 | }\r | |
958 | \r | |
959 | if (VariableName[0] != 0) {\r | |
960 | //\r | |
961 | // If variable name is not NULL, get next variable\r | |
962 | //\r | |
039a40aa SZ |
963 | GetVariableHeader (&StoreInfo, Variable.CurrPtr, &VariableHeader);\r |
964 | Variable.CurrPtr = GetNextVariablePtr (&StoreInfo, Variable.CurrPtr, VariableHeader);\r | |
0c18794e | 965 | }\r |
966 | \r | |
039a40aa SZ |
967 | VariableStoreHeader[VariableStoreTypeHob] = GetVariableStore (VariableStoreTypeHob, &StoreInfoForHob);\r |
968 | VariableStoreHeader[VariableStoreTypeNv] = GetVariableStore (VariableStoreTypeNv, &StoreInfoForNv);\r | |
0c18794e | 969 | \r |
9a000b46 RN |
970 | while (TRUE) {\r |
971 | //\r | |
972 | // Switch from HOB to Non-Volatile.\r | |
973 | //\r | |
039a40aa | 974 | while (!GetVariableHeader (&StoreInfo, Variable.CurrPtr, &VariableHeader)) {\r |
9a000b46 RN |
975 | //\r |
976 | // Find current storage index\r | |
977 | //\r | |
978 | for (Type = (VARIABLE_STORE_TYPE) 0; Type < VariableStoreTypeMax; Type++) {\r | |
979 | if ((VariableStoreHeader[Type] != NULL) && (Variable.StartPtr == GetStartPointer (VariableStoreHeader[Type]))) {\r | |
980 | break;\r | |
981 | }\r | |
982 | }\r | |
983 | ASSERT (Type < VariableStoreTypeMax);\r | |
984 | //\r | |
985 | // Switch to next storage\r | |
986 | //\r | |
987 | for (Type++; Type < VariableStoreTypeMax; Type++) {\r | |
988 | if (VariableStoreHeader[Type] != NULL) {\r | |
989 | break;\r | |
990 | }\r | |
991 | }\r | |
992 | //\r | |
993 | // Capture the case that \r | |
994 | // 1. current storage is the last one, or\r | |
995 | // 2. no further storage\r | |
996 | //\r | |
997 | if (Type == VariableStoreTypeMax) {\r | |
998 | return EFI_NOT_FOUND;\r | |
999 | }\r | |
1000 | Variable.StartPtr = GetStartPointer (VariableStoreHeader[Type]);\r | |
1001 | Variable.EndPtr = GetEndPointer (VariableStoreHeader[Type]);\r | |
1002 | Variable.CurrPtr = Variable.StartPtr;\r | |
039a40aa | 1003 | GetVariableStore (Type, &StoreInfo);\r |
9a000b46 | 1004 | }\r |
0c18794e | 1005 | \r |
039a40aa SZ |
1006 | if (VariableHeader->State == VAR_ADDED || VariableHeader->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r |
1007 | if (VariableHeader->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r | |
932e0f66 SZ |
1008 | //\r |
1009 | // If it is a IN_DELETED_TRANSITION variable,\r | |
1010 | // and there is also a same ADDED one at the same time,\r | |
1011 | // don't return it.\r | |
1012 | //\r | |
932e0f66 | 1013 | Status = FindVariableEx (\r |
039a40aa | 1014 | &StoreInfo,\r |
932e0f66 | 1015 | GetVariableNamePtr (Variable.CurrPtr),\r |
039a40aa | 1016 | &VariableHeader->VendorGuid,\r |
932e0f66 SZ |
1017 | &VariablePtrTrack\r |
1018 | );\r | |
039a40aa SZ |
1019 | if (!EFI_ERROR (Status) && VariablePtrTrack.CurrPtr != Variable.CurrPtr) {\r |
1020 | Variable.CurrPtr = GetNextVariablePtr (&StoreInfo, Variable.CurrPtr, VariableHeader);\r | |
932e0f66 SZ |
1021 | continue;\r |
1022 | }\r | |
1023 | }\r | |
0c18794e | 1024 | \r |
9a000b46 RN |
1025 | //\r |
1026 | // Don't return NV variable when HOB overrides it\r | |
1027 | //\r | |
1028 | if ((VariableStoreHeader[VariableStoreTypeHob] != NULL) && (VariableStoreHeader[VariableStoreTypeNv] != NULL) &&\r | |
1029 | (Variable.StartPtr == GetStartPointer (VariableStoreHeader[VariableStoreTypeNv]))\r | |
1030 | ) {\r | |
1031 | Status = FindVariableEx (\r | |
039a40aa | 1032 | &StoreInfoForHob,\r |
9a000b46 | 1033 | GetVariableNamePtr (Variable.CurrPtr),\r |
039a40aa | 1034 | &VariableHeader->VendorGuid, \r |
9a000b46 RN |
1035 | &VariableInHob\r |
1036 | );\r | |
1037 | if (!EFI_ERROR (Status)) {\r | |
039a40aa | 1038 | Variable.CurrPtr = GetNextVariablePtr (&StoreInfo, Variable.CurrPtr, VariableHeader);\r |
9a000b46 | 1039 | continue;\r |
0c18794e | 1040 | }\r |
9a000b46 | 1041 | }\r |
0c18794e | 1042 | \r |
039a40aa | 1043 | VarNameSize = NameSizeOfVariable (VariableHeader);\r |
9a000b46 RN |
1044 | ASSERT (VarNameSize != 0);\r |
1045 | \r | |
1046 | if (VarNameSize <= *VariableNameSize) {\r | |
039a40aa | 1047 | GetVariableNameOrData (&StoreInfo, (UINT8 *) GetVariableNamePtr (Variable.CurrPtr), VarNameSize, (UINT8 *) VariableName);\r |
9a000b46 | 1048 | \r |
039a40aa | 1049 | CopyMem (VariableGuid, &VariableHeader->VendorGuid, sizeof (EFI_GUID));\r |
9a000b46 RN |
1050 | \r |
1051 | Status = EFI_SUCCESS;\r | |
0c18794e | 1052 | } else {\r |
9a000b46 | 1053 | Status = EFI_BUFFER_TOO_SMALL;\r |
0c18794e | 1054 | }\r |
9a000b46 RN |
1055 | \r |
1056 | *VariableNameSize = VarNameSize;\r | |
1057 | //\r | |
1058 | // Variable is found\r | |
1059 | //\r | |
1060 | return Status;\r | |
0c18794e | 1061 | } else {\r |
039a40aa | 1062 | Variable.CurrPtr = GetNextVariablePtr (&StoreInfo, Variable.CurrPtr, VariableHeader);\r |
0c18794e | 1063 | }\r |
1064 | }\r | |
0c18794e | 1065 | }\r |