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