]>
Commit | Line | Data |
---|---|---|
052ad7e1 | 1 | /** @file\r |
504214c4 LG |
2 | \r |
3 | Implement all four UEFI Runtime Variable services for the nonvolatile\r | |
4 | and volatile storage space and install variable architecture protocol.\r | |
052ad7e1 | 5 | \r |
504214c4 LG |
6 | Copyright (c) 2006 - 2008, Intel Corporation \r |
7 | All rights reserved. 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 | |
8d3a5c82 | 14 | \r |
052ad7e1 | 15 | **/\r |
8d3a5c82 | 16 | \r |
17 | \r | |
18 | #include "Variable.h"\r | |
33a5a666 | 19 | \r |
7800593d | 20 | VARIABLE_MODULE_GLOBAL *mVariableModuleGlobal;\r |
052ad7e1 A |
21 | EFI_EVENT mVirtualAddressChangeEvent = NULL;\r |
22 | EFI_HANDLE mHandle = NULL;\r | |
8d3a5c82 | 23 | \r |
33a5a666 | 24 | \r |
8d3a5c82 | 25 | //\r |
26 | // This is a temperary function which will be removed\r | |
27 | // when EfiAcquireLock in UefiLib can handle the\r | |
28 | // the call in UEFI Runtimer driver in RT phase.\r | |
29 | //\r | |
8d3a5c82 | 30 | VOID\r |
31 | AcquireLockOnlyAtBootTime (\r | |
32 | IN EFI_LOCK *Lock\r | |
33 | )\r | |
34 | {\r | |
35 | if (!EfiAtRuntime ()) {\r | |
36 | EfiAcquireLock (Lock);\r | |
37 | }\r | |
38 | }\r | |
39 | \r | |
40 | //\r | |
41 | // This is a temperary function which will be removed\r | |
42 | // when EfiAcquireLock in UefiLib can handle the\r | |
43 | // the call in UEFI Runtimer driver in RT phase.\r | |
44 | //\r | |
8d3a5c82 | 45 | VOID\r |
46 | ReleaseLockOnlyAtBootTime (\r | |
47 | IN EFI_LOCK *Lock\r | |
48 | )\r | |
49 | {\r | |
50 | if (!EfiAtRuntime ()) {\r | |
51 | EfiReleaseLock (Lock);\r | |
52 | }\r | |
53 | }\r | |
54 | \r | |
33a5a666 A |
55 | \r |
56 | GLOBAL_REMOVE_IF_UNREFERENCED VARIABLE_INFO_ENTRY *gVariableInfo = NULL;\r | |
57 | \r | |
58 | \r | |
052ad7e1 A |
59 | /**\r |
60 | Routine used to track statistical information about variable usage. \r | |
61 | The data is stored in the EFI system table so it can be accessed later.\r | |
62 | VariableInfo.efi can dump out the table. Only Boot Services variable \r | |
63 | accesses are tracked by this code. The PcdVariableCollectStatistics\r | |
64 | build flag controls if this feature is enabled. \r | |
65 | \r | |
66 | A read that hits in the cache will have Read and Cache true for \r | |
67 | the transaction. Data is allocated by this routine, but never\r | |
68 | freed.\r | |
69 | \r | |
70 | @param[in] VariableName Name of the Variable to track\r | |
71 | @param[in] VendorGuid Guid of the Variable to track\r | |
72 | @param[in] Volatile TRUE if volatile FALSE if non-volatile\r | |
73 | @param[in] Read TRUE if GetVariable() was called\r | |
74 | @param[in] Write TRUE if SetVariable() was called\r | |
75 | @param[in] Delete TRUE if deleted via SetVariable()\r | |
76 | @param[in] Cache TRUE for a cache hit.\r | |
77 | \r | |
78 | **/\r | |
33a5a666 A |
79 | VOID\r |
80 | UpdateVariableInfo (\r | |
81 | IN CHAR16 *VariableName,\r | |
82 | IN EFI_GUID *VendorGuid,\r | |
83 | IN BOOLEAN Volatile,\r | |
84 | IN BOOLEAN Read,\r | |
85 | IN BOOLEAN Write,\r | |
86 | IN BOOLEAN Delete,\r | |
87 | IN BOOLEAN Cache\r | |
88 | )\r | |
89 | {\r | |
90 | VARIABLE_INFO_ENTRY *Entry;\r | |
91 | \r | |
92 | if (FeaturePcdGet (PcdVariableCollectStatistics)) {\r | |
93 | \r | |
94 | if (EfiAtRuntime ()) {\r | |
95 | // Don't collect statistics at runtime\r | |
96 | return;\r | |
97 | }\r | |
98 | \r | |
99 | if (gVariableInfo == NULL) {\r | |
052ad7e1 A |
100 | //\r |
101 | // on the first call allocate a entry and place a pointer to it in\r | |
102 | // the EFI System Table\r | |
103 | //\r | |
33a5a666 | 104 | gVariableInfo = AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY));\r |
052ad7e1 A |
105 | ASSERT (gVariableInfo != NULL);\r |
106 | \r | |
33a5a666 A |
107 | CopyGuid (&gVariableInfo->VendorGuid, VendorGuid);\r |
108 | gVariableInfo->Name = AllocatePool (StrLen (VariableName));\r | |
109 | StrCpy (gVariableInfo->Name, VariableName);\r | |
110 | gVariableInfo->Volatile = Volatile;\r | |
111 | \r | |
112 | gBS->InstallConfigurationTable (&gEfiVariableInfoGuid, gVariableInfo);\r | |
113 | }\r | |
114 | \r | |
115 | \r | |
116 | for (Entry = gVariableInfo; Entry != NULL; Entry = Entry->Next) {\r | |
117 | if (CompareGuid (VendorGuid, &Entry->VendorGuid)) {\r | |
118 | if (StrCmp (VariableName, Entry->Name) == 0) {\r | |
119 | if (Read) {\r | |
120 | Entry->ReadCount++;\r | |
121 | }\r | |
122 | if (Write) {\r | |
123 | Entry->WriteCount++;\r | |
124 | }\r | |
125 | if (Delete) {\r | |
126 | Entry->DeleteCount++;\r | |
127 | }\r | |
128 | if (Cache) {\r | |
129 | Entry->CacheCount++;\r | |
130 | }\r | |
131 | \r | |
132 | return;\r | |
133 | }\r | |
134 | }\r | |
135 | \r | |
136 | if (Entry->Next == NULL) {\r | |
052ad7e1 A |
137 | //\r |
138 | // If the entry is not in the table add it.\r | |
139 | // Next iteration of the loop will fill in the data\r | |
140 | //\r | |
33a5a666 | 141 | Entry->Next = AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY));\r |
052ad7e1 | 142 | ASSERT (Entry->Next != NULL);\r |
33a5a666 A |
143 | \r |
144 | CopyGuid (&Entry->Next->VendorGuid, VendorGuid);\r | |
145 | Entry->Next->Name = AllocatePool (StrLen (VariableName));\r | |
146 | StrCpy (Entry->Next->Name, VariableName);\r | |
147 | Entry->Next->Volatile = Volatile;\r | |
148 | }\r | |
149 | \r | |
150 | }\r | |
151 | }\r | |
152 | }\r | |
153 | \r | |
154 | \r | |
8d3a5c82 | 155 | BOOLEAN\r |
8d3a5c82 | 156 | IsValidVariableHeader (\r |
157 | IN VARIABLE_HEADER *Variable\r | |
158 | )\r | |
159 | /*++\r | |
160 | \r | |
161 | Routine Description:\r | |
162 | \r | |
163 | This code checks if variable header is valid or not.\r | |
164 | \r | |
165 | Arguments:\r | |
166 | Variable Pointer to the Variable Header.\r | |
167 | \r | |
168 | Returns:\r | |
169 | TRUE Variable header is valid.\r | |
170 | FALSE Variable header is not valid.\r | |
171 | \r | |
172 | --*/\r | |
173 | {\r | |
fdb7765f | 174 | if (Variable == NULL || Variable->StartId != VARIABLE_DATA) {\r |
8d3a5c82 | 175 | return FALSE;\r |
176 | }\r | |
177 | \r | |
178 | return TRUE;\r | |
179 | }\r | |
180 | \r | |
052ad7e1 | 181 | \r |
8d3a5c82 | 182 | EFI_STATUS\r |
8d3a5c82 | 183 | UpdateVariableStore (\r |
184 | IN VARIABLE_GLOBAL *Global,\r | |
185 | IN BOOLEAN Volatile,\r | |
186 | IN BOOLEAN SetByIndex,\r | |
187 | IN UINTN Instance,\r | |
188 | IN UINTN DataPtrIndex,\r | |
189 | IN UINT32 DataSize,\r | |
190 | IN UINT8 *Buffer\r | |
191 | )\r | |
192 | /*++\r | |
193 | \r | |
194 | Routine Description:\r | |
195 | \r | |
196 | This function writes data to the FWH at the correct LBA even if the LBAs\r | |
197 | are fragmented.\r | |
198 | \r | |
199 | Arguments:\r | |
200 | \r | |
c6492839 | 201 | Global - Pointer to VARAIBLE_GLOBAL structure\r |
202 | Volatile - If the Variable is Volatile or Non-Volatile\r | |
203 | SetByIndex - TRUE: Target pointer is given as index\r | |
204 | FALSE: Target pointer is absolute\r | |
205 | Instance - Instance of FV Block services\r | |
206 | DataPtrIndex - Pointer to the Data from the end of VARIABLE_STORE_HEADER\r | |
207 | structure\r | |
208 | DataSize - Size of data to be written.\r | |
209 | Buffer - Pointer to the buffer from which data is written\r | |
8d3a5c82 | 210 | \r |
211 | Returns:\r | |
212 | \r | |
c6492839 | 213 | EFI_INVALID_PARAMETER - Parameters not valid\r |
214 | EFI_SUCCESS - Variable store successfully updated\r | |
8d3a5c82 | 215 | \r |
216 | --*/\r | |
217 | {\r | |
218 | EFI_FV_BLOCK_MAP_ENTRY *PtrBlockMapEntry;\r | |
219 | UINTN BlockIndex2;\r | |
220 | UINTN LinearOffset;\r | |
221 | UINTN CurrWriteSize;\r | |
222 | UINTN CurrWritePtr;\r | |
223 | UINT8 *CurrBuffer;\r | |
224 | EFI_LBA LbaNumber;\r | |
225 | UINTN Size;\r | |
226 | EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r | |
227 | VARIABLE_STORE_HEADER *VolatileBase;\r | |
228 | EFI_PHYSICAL_ADDRESS FvVolHdr;\r | |
229 | EFI_PHYSICAL_ADDRESS DataPtr;\r | |
230 | EFI_STATUS Status;\r | |
231 | \r | |
232 | FwVolHeader = NULL;\r | |
233 | DataPtr = DataPtrIndex;\r | |
234 | \r | |
235 | //\r | |
236 | // Check if the Data is Volatile\r | |
237 | //\r | |
238 | if (!Volatile) {\r | |
239 | EfiFvbGetPhysicalAddress (Instance, &FvVolHdr);\r | |
240 | FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) ((UINTN) FvVolHdr);\r | |
241 | //\r | |
242 | // Data Pointer should point to the actual Address where data is to be\r | |
243 | // written\r | |
244 | //\r | |
245 | if (SetByIndex) {\r | |
052ad7e1 | 246 | DataPtr += mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase;\r |
8d3a5c82 | 247 | }\r |
248 | \r | |
249 | if ((DataPtr + DataSize) >= ((EFI_PHYSICAL_ADDRESS) (UINTN) ((UINT8 *) FwVolHeader + FwVolHeader->FvLength))) {\r | |
250 | return EFI_INVALID_PARAMETER;\r | |
251 | }\r | |
252 | } else {\r | |
253 | //\r | |
254 | // Data Pointer should point to the actual Address where data is to be\r | |
255 | // written\r | |
256 | //\r | |
052ad7e1 | 257 | VolatileBase = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase);\r |
8d3a5c82 | 258 | if (SetByIndex) {\r |
052ad7e1 | 259 | DataPtr += mVariableModuleGlobal->VariableGlobal.VolatileVariableBase;\r |
8d3a5c82 | 260 | }\r |
261 | \r | |
262 | if ((DataPtr + DataSize) >= ((UINTN) ((UINT8 *) VolatileBase + VolatileBase->Size))) {\r | |
263 | return EFI_INVALID_PARAMETER;\r | |
264 | }\r | |
c6492839 | 265 | \r |
266 | //\r | |
267 | // If Volatile Variable just do a simple mem copy.\r | |
268 | // \r | |
269 | CopyMem ((UINT8 *)(UINTN)DataPtr, Buffer, DataSize);\r | |
8d3a5c82 | 270 | return EFI_SUCCESS;\r |
271 | }\r | |
c6492839 | 272 | \r |
8d3a5c82 | 273 | //\r |
274 | // If we are here we are dealing with Non-Volatile Variables\r | |
275 | //\r | |
276 | LinearOffset = (UINTN) FwVolHeader;\r | |
277 | CurrWritePtr = (UINTN) DataPtr;\r | |
278 | CurrWriteSize = DataSize;\r | |
279 | CurrBuffer = Buffer;\r | |
280 | LbaNumber = 0;\r | |
281 | \r | |
282 | if (CurrWritePtr < LinearOffset) {\r | |
283 | return EFI_INVALID_PARAMETER;\r | |
284 | }\r | |
285 | \r | |
286 | for (PtrBlockMapEntry = FwVolHeader->BlockMap; PtrBlockMapEntry->NumBlocks != 0; PtrBlockMapEntry++) {\r | |
287 | for (BlockIndex2 = 0; BlockIndex2 < PtrBlockMapEntry->NumBlocks; BlockIndex2++) {\r | |
288 | //\r | |
289 | // Check to see if the Variable Writes are spanning through multiple\r | |
290 | // blocks.\r | |
291 | //\r | |
292 | if ((CurrWritePtr >= LinearOffset) && (CurrWritePtr < LinearOffset + PtrBlockMapEntry->Length)) {\r | |
293 | if ((CurrWritePtr + CurrWriteSize) <= (LinearOffset + PtrBlockMapEntry->Length)) {\r | |
294 | Status = EfiFvbWriteBlock (\r | |
295 | Instance,\r | |
296 | LbaNumber,\r | |
297 | (UINTN) (CurrWritePtr - LinearOffset),\r | |
298 | &CurrWriteSize,\r | |
299 | CurrBuffer\r | |
300 | );\r | |
8d3a5c82 | 301 | return Status;\r |
8d3a5c82 | 302 | } else {\r |
303 | Size = (UINT32) (LinearOffset + PtrBlockMapEntry->Length - CurrWritePtr);\r | |
304 | Status = EfiFvbWriteBlock (\r | |
305 | Instance,\r | |
306 | LbaNumber,\r | |
307 | (UINTN) (CurrWritePtr - LinearOffset),\r | |
308 | &Size,\r | |
309 | CurrBuffer\r | |
310 | );\r | |
311 | if (EFI_ERROR (Status)) {\r | |
312 | return Status;\r | |
313 | }\r | |
314 | \r | |
315 | CurrWritePtr = LinearOffset + PtrBlockMapEntry->Length;\r | |
316 | CurrBuffer = CurrBuffer + Size;\r | |
317 | CurrWriteSize = CurrWriteSize - Size;\r | |
318 | }\r | |
319 | }\r | |
320 | \r | |
321 | LinearOffset += PtrBlockMapEntry->Length;\r | |
322 | LbaNumber++;\r | |
323 | }\r | |
324 | }\r | |
325 | \r | |
326 | return EFI_SUCCESS;\r | |
327 | }\r | |
328 | \r | |
052ad7e1 | 329 | \r |
8d3a5c82 | 330 | VARIABLE_STORE_STATUS\r |
8d3a5c82 | 331 | GetVariableStoreStatus (\r |
332 | IN VARIABLE_STORE_HEADER *VarStoreHeader\r | |
333 | )\r | |
334 | /*++\r | |
335 | \r | |
336 | Routine Description:\r | |
337 | \r | |
338 | This code gets the current status of Variable Store.\r | |
339 | \r | |
340 | Arguments:\r | |
341 | \r | |
342 | VarStoreHeader Pointer to the Variable Store Header.\r | |
343 | \r | |
344 | Returns:\r | |
345 | \r | |
346 | EfiRaw Variable store status is raw\r | |
347 | EfiValid Variable store status is valid\r | |
348 | EfiInvalid Variable store status is invalid\r | |
349 | \r | |
350 | --*/\r | |
351 | {\r | |
352 | if (VarStoreHeader->Signature == VARIABLE_STORE_SIGNATURE &&\r | |
353 | VarStoreHeader->Format == VARIABLE_STORE_FORMATTED &&\r | |
354 | VarStoreHeader->State == VARIABLE_STORE_HEALTHY\r | |
355 | ) {\r | |
356 | \r | |
357 | return EfiValid;\r | |
358 | } else if (VarStoreHeader->Signature == 0xffffffff &&\r | |
359 | VarStoreHeader->Size == 0xffffffff &&\r | |
360 | VarStoreHeader->Format == 0xff &&\r | |
361 | VarStoreHeader->State == 0xff\r | |
362 | ) {\r | |
363 | \r | |
364 | return EfiRaw;\r | |
365 | } else {\r | |
366 | return EfiInvalid;\r | |
367 | }\r | |
368 | }\r | |
369 | \r | |
130e2569 | 370 | \r |
371 | UINTN\r | |
372 | NameSizeOfVariable (\r | |
373 | IN VARIABLE_HEADER *Variable\r | |
374 | )\r | |
375 | /*++\r | |
376 | \r | |
377 | Routine Description:\r | |
378 | \r | |
379 | This code gets the size of name of variable.\r | |
380 | \r | |
381 | Arguments:\r | |
382 | \r | |
383 | Variable Pointer to the Variable Header.\r | |
384 | \r | |
385 | Returns:\r | |
386 | \r | |
387 | UINTN Size of variable in bytes\r | |
388 | \r | |
389 | --*/\r | |
390 | {\r | |
391 | if (Variable->State == (UINT8) (-1) ||\r | |
392 | Variable->DataSize == (UINT32) -1 ||\r | |
393 | Variable->NameSize == (UINT32) -1 ||\r | |
394 | Variable->Attributes == (UINT32) -1) {\r | |
395 | return 0;\r | |
396 | }\r | |
397 | return (UINTN) Variable->NameSize;\r | |
398 | }\r | |
399 | \r | |
400 | UINTN\r | |
401 | DataSizeOfVariable (\r | |
402 | IN VARIABLE_HEADER *Variable\r | |
403 | )\r | |
404 | /*++\r | |
405 | \r | |
406 | Routine Description:\r | |
407 | \r | |
408 | This code gets the size of name of variable.\r | |
409 | \r | |
410 | Arguments:\r | |
411 | \r | |
412 | Variable Pointer to the Variable Header.\r | |
413 | \r | |
414 | Returns:\r | |
415 | \r | |
416 | UINTN Size of variable in bytes\r | |
417 | \r | |
418 | --*/\r | |
419 | {\r | |
420 | if (Variable->State == (UINT8) -1 ||\r | |
421 | Variable->DataSize == (UINT32) -1 ||\r | |
422 | Variable->NameSize == (UINT32) -1 ||\r | |
423 | Variable->Attributes == (UINT32) -1) {\r | |
424 | return 0;\r | |
425 | }\r | |
426 | return (UINTN) Variable->DataSize;\r | |
427 | }\r | |
428 | \r | |
429 | CHAR16 *\r | |
430 | GetVariableNamePtr (\r | |
431 | IN VARIABLE_HEADER *Variable\r | |
432 | )\r | |
433 | /*++\r | |
434 | \r | |
435 | Routine Description:\r | |
436 | \r | |
437 | This code gets the pointer to the variable name.\r | |
438 | \r | |
439 | Arguments:\r | |
440 | \r | |
441 | Variable Pointer to the Variable Header.\r | |
442 | \r | |
443 | Returns:\r | |
444 | \r | |
445 | CHAR16* Pointer to Variable Name\r | |
446 | \r | |
447 | --*/\r | |
448 | {\r | |
449 | \r | |
450 | return (CHAR16 *) (Variable + 1);\r | |
451 | }\r | |
452 | \r | |
8d3a5c82 | 453 | UINT8 *\r |
8d3a5c82 | 454 | GetVariableDataPtr (\r |
455 | IN VARIABLE_HEADER *Variable\r | |
456 | )\r | |
457 | /*++\r | |
458 | \r | |
459 | Routine Description:\r | |
460 | \r | |
461 | This code gets the pointer to the variable data.\r | |
462 | \r | |
463 | Arguments:\r | |
464 | \r | |
465 | Variable Pointer to the Variable Header.\r | |
466 | \r | |
467 | Returns:\r | |
468 | \r | |
469 | UINT8* Pointer to Variable Data\r | |
470 | \r | |
471 | --*/\r | |
472 | {\r | |
130e2569 | 473 | UINTN Value;\r |
474 | \r | |
8d3a5c82 | 475 | //\r |
476 | // Be careful about pad size for alignment\r | |
477 | //\r | |
130e2569 | 478 | Value = (UINTN) GetVariableNamePtr (Variable);\r |
479 | Value += NameSizeOfVariable (Variable);\r | |
480 | Value += GET_PAD_SIZE (NameSizeOfVariable (Variable));\r | |
481 | \r | |
482 | return (UINT8 *) Value;\r | |
8d3a5c82 | 483 | }\r |
484 | \r | |
052ad7e1 | 485 | \r |
8d3a5c82 | 486 | VARIABLE_HEADER *\r |
8d3a5c82 | 487 | GetNextVariablePtr (\r |
488 | IN VARIABLE_HEADER *Variable\r | |
489 | )\r | |
490 | /*++\r | |
491 | \r | |
492 | Routine Description:\r | |
493 | \r | |
494 | This code gets the pointer to the next variable header.\r | |
495 | \r | |
496 | Arguments:\r | |
497 | \r | |
498 | Variable Pointer to the Variable Header.\r | |
499 | \r | |
500 | Returns:\r | |
501 | \r | |
502 | VARIABLE_HEADER* Pointer to next variable header.\r | |
503 | \r | |
504 | --*/\r | |
505 | {\r | |
130e2569 | 506 | UINTN Value;\r |
507 | \r | |
8d3a5c82 | 508 | if (!IsValidVariableHeader (Variable)) {\r |
509 | return NULL;\r | |
510 | }\r | |
130e2569 | 511 | \r |
512 | Value = (UINTN) GetVariableDataPtr (Variable);\r | |
513 | Value += DataSizeOfVariable (Variable);\r | |
514 | Value += GET_PAD_SIZE (DataSizeOfVariable (Variable));\r | |
515 | \r | |
8d3a5c82 | 516 | //\r |
517 | // Be careful about pad size for alignment\r | |
518 | //\r | |
130e2569 | 519 | return (VARIABLE_HEADER *) HEADER_ALIGN (Value);\r |
8d3a5c82 | 520 | }\r |
521 | \r | |
9cad030b | 522 | VARIABLE_HEADER *\r |
523 | GetStartPointer (\r | |
524 | IN VARIABLE_STORE_HEADER *VarStoreHeader\r | |
525 | )\r | |
526 | /*++\r | |
527 | \r | |
528 | Routine Description:\r | |
529 | \r | |
530 | This code gets the pointer to the first variable memory pointer byte\r | |
531 | \r | |
532 | Arguments:\r | |
533 | \r | |
534 | VarStoreHeader Pointer to the Variable Store Header.\r | |
535 | \r | |
536 | Returns:\r | |
537 | \r | |
538 | VARIABLE_HEADER* Pointer to last unavailable Variable Header\r | |
539 | \r | |
540 | --*/\r | |
541 | {\r | |
542 | //\r | |
543 | // The end of variable store\r | |
544 | //\r | |
545 | return (VARIABLE_HEADER *) HEADER_ALIGN (VarStoreHeader + 1);\r | |
546 | }\r | |
052ad7e1 | 547 | \r |
8d3a5c82 | 548 | VARIABLE_HEADER *\r |
8d3a5c82 | 549 | GetEndPointer (\r |
550 | IN VARIABLE_STORE_HEADER *VarStoreHeader\r | |
551 | )\r | |
552 | /*++\r | |
553 | \r | |
554 | Routine Description:\r | |
555 | \r | |
556 | This code gets the pointer to the last variable memory pointer byte\r | |
557 | \r | |
558 | Arguments:\r | |
559 | \r | |
560 | VarStoreHeader Pointer to the Variable Store Header.\r | |
561 | \r | |
562 | Returns:\r | |
563 | \r | |
564 | VARIABLE_HEADER* Pointer to last unavailable Variable Header\r | |
565 | \r | |
566 | --*/\r | |
567 | {\r | |
568 | //\r | |
569 | // The end of variable store\r | |
570 | //\r | |
9cad030b | 571 | return (VARIABLE_HEADER *) HEADER_ALIGN ((UINTN) VarStoreHeader + VarStoreHeader->Size);\r |
8d3a5c82 | 572 | }\r |
573 | \r | |
052ad7e1 | 574 | \r |
8d3a5c82 | 575 | EFI_STATUS\r |
8d3a5c82 | 576 | Reclaim (\r |
577 | IN EFI_PHYSICAL_ADDRESS VariableBase,\r | |
578 | OUT UINTN *LastVariableOffset,\r | |
814bae52 | 579 | IN BOOLEAN IsVolatile,\r |
580 | IN VARIABLE_HEADER *UpdatingVariable\r | |
8d3a5c82 | 581 | )\r |
582 | /*++\r | |
583 | \r | |
584 | Routine Description:\r | |
585 | \r | |
586 | Variable store garbage collection and reclaim operation\r | |
587 | \r | |
588 | Arguments:\r | |
589 | \r | |
590 | VariableBase Base address of variable store\r | |
591 | LastVariableOffset Offset of last variable\r | |
592 | IsVolatile The variable store is volatile or not,\r | |
593 | if it is non-volatile, need FTW\r | |
594 | \r | |
595 | Returns:\r | |
596 | \r | |
597 | EFI STATUS\r | |
598 | \r | |
599 | --*/\r | |
600 | {\r | |
601 | VARIABLE_HEADER *Variable;\r | |
814bae52 | 602 | VARIABLE_HEADER *AddedVariable;\r |
8d3a5c82 | 603 | VARIABLE_HEADER *NextVariable;\r |
814bae52 | 604 | VARIABLE_HEADER *NextAddedVariable;\r |
8d3a5c82 | 605 | VARIABLE_STORE_HEADER *VariableStoreHeader;\r |
606 | UINT8 *ValidBuffer;\r | |
814bae52 | 607 | UINTN MaximumBufferSize;\r |
8d3a5c82 | 608 | UINTN VariableSize;\r |
814bae52 | 609 | UINTN NameSize;\r |
8d3a5c82 | 610 | UINT8 *CurrPtr;\r |
814bae52 | 611 | VOID *Point0;\r |
612 | VOID *Point1;\r | |
613 | BOOLEAN FoundAdded;\r | |
8d3a5c82 | 614 | EFI_STATUS Status;\r |
615 | \r | |
616 | VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) VariableBase);\r | |
617 | \r | |
618 | //\r | |
619 | // Start Pointers for the variable.\r | |
620 | //\r | |
814bae52 | 621 | Variable = GetStartPointer (VariableStoreHeader);\r |
622 | MaximumBufferSize = sizeof (VARIABLE_STORE_HEADER);\r | |
8d3a5c82 | 623 | \r |
624 | while (IsValidVariableHeader (Variable)) {\r | |
625 | NextVariable = GetNextVariablePtr (Variable);\r | |
814bae52 | 626 | if (Variable->State == VAR_ADDED || \r |
627 | Variable->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)\r | |
628 | ) {\r | |
8d3a5c82 | 629 | VariableSize = (UINTN) NextVariable - (UINTN) Variable;\r |
814bae52 | 630 | MaximumBufferSize += VariableSize;\r |
8d3a5c82 | 631 | }\r |
632 | \r | |
633 | Variable = NextVariable;\r | |
634 | }\r | |
635 | \r | |
814bae52 | 636 | //\r |
637 | // Reserve the 1 Bytes with Oxff to identify the \r | |
638 | // end of the variable buffer. \r | |
639 | // \r | |
640 | MaximumBufferSize += 1;\r | |
641 | ValidBuffer = AllocatePool (MaximumBufferSize);\r | |
8d3a5c82 | 642 | if (ValidBuffer == NULL) {\r |
643 | return EFI_OUT_OF_RESOURCES;\r | |
644 | }\r | |
645 | \r | |
814bae52 | 646 | SetMem (ValidBuffer, MaximumBufferSize, 0xff);\r |
8d3a5c82 | 647 | \r |
648 | //\r | |
649 | // Copy variable store header\r | |
650 | //\r | |
814bae52 | 651 | CopyMem (ValidBuffer, VariableStoreHeader, sizeof (VARIABLE_STORE_HEADER));\r |
652 | CurrPtr = (UINT8 *) GetStartPointer ((VARIABLE_STORE_HEADER *) ValidBuffer);\r | |
8d3a5c82 | 653 | \r |
654 | //\r | |
655 | // Start Pointers for the variable.\r | |
656 | //\r | |
8d3a5c82 | 657 | \r |
814bae52 | 658 | //\r |
5ead4a07 | 659 | // Reinstall all ADDED variables as long as they are not identical to Updating Variable\r |
814bae52 | 660 | // \r |
661 | Variable = GetStartPointer (VariableStoreHeader);\r | |
8d3a5c82 | 662 | while (IsValidVariableHeader (Variable)) {\r |
663 | NextVariable = GetNextVariablePtr (Variable);\r | |
664 | if (Variable->State == VAR_ADDED) {\r | |
5ead4a07 | 665 | if (UpdatingVariable != NULL) {\r |
666 | if (UpdatingVariable == Variable) {\r | |
667 | Variable = NextVariable;\r | |
668 | continue;\r | |
669 | }\r | |
670 | if (CompareGuid (&Variable->VendorGuid, &UpdatingVariable->VendorGuid) &&\r | |
671 | NameSizeOfVariable(Variable) == NameSizeOfVariable (UpdatingVariable) &&\r | |
672 | CompareMem (GetVariableNamePtr (Variable), GetVariableNamePtr (UpdatingVariable), NameSizeOfVariable (Variable)) == 0 ) {\r | |
673 | Variable = NextVariable;\r | |
674 | continue;\r | |
675 | }\r | |
676 | }\r | |
8d3a5c82 | 677 | VariableSize = (UINTN) NextVariable - (UINTN) Variable;\r |
678 | CopyMem (CurrPtr, (UINT8 *) Variable, VariableSize);\r | |
679 | CurrPtr += VariableSize;\r | |
680 | }\r | |
8d3a5c82 | 681 | Variable = NextVariable;\r |
682 | }\r | |
5ead4a07 | 683 | \r |
684 | //\r | |
685 | // Reinstall the variable being updated if it is not NULL\r | |
686 | //\r | |
687 | if (UpdatingVariable != NULL) {\r | |
688 | VariableSize = (UINTN)(GetNextVariablePtr (UpdatingVariable)) - (UINTN)UpdatingVariable;\r | |
689 | CopyMem (CurrPtr, (UINT8 *) UpdatingVariable, VariableSize);\r | |
690 | CurrPtr += VariableSize;\r | |
691 | }\r | |
692 | \r | |
814bae52 | 693 | //\r |
694 | // Reinstall all in delete transition variables\r | |
695 | // \r | |
696 | Variable = GetStartPointer (VariableStoreHeader);\r | |
697 | while (IsValidVariableHeader (Variable)) {\r | |
698 | NextVariable = GetNextVariablePtr (Variable);\r | |
5ead4a07 | 699 | if (Variable != UpdatingVariable && Variable->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r |
814bae52 | 700 | \r |
701 | //\r | |
702 | // Buffer has cached all ADDED variable. \r | |
703 | // Per IN_DELETED variable, we have to guarantee that\r | |
704 | // no ADDED one in previous buffer. \r | |
705 | // \r | |
706 | \r | |
707 | FoundAdded = FALSE;\r | |
708 | AddedVariable = GetStartPointer ((VARIABLE_STORE_HEADER *) ValidBuffer);\r | |
709 | while (IsValidVariableHeader (AddedVariable)) {\r | |
710 | NextAddedVariable = GetNextVariablePtr (AddedVariable);\r | |
711 | NameSize = NameSizeOfVariable (AddedVariable);\r | |
712 | if (CompareGuid (&AddedVariable->VendorGuid, &Variable->VendorGuid) &&\r | |
713 | NameSize == NameSizeOfVariable (Variable)\r | |
714 | ) {\r | |
715 | Point0 = (VOID *) GetVariableNamePtr (AddedVariable);\r | |
716 | Point1 = (VOID *) GetVariableNamePtr (Variable);\r | |
5ead4a07 | 717 | if (CompareMem (Point0, Point1, NameSizeOfVariable (AddedVariable)) == 0) {\r |
814bae52 | 718 | FoundAdded = TRUE;\r |
719 | break;\r | |
720 | }\r | |
721 | }\r | |
722 | AddedVariable = NextAddedVariable;\r | |
723 | }\r | |
724 | if (!FoundAdded) {\r | |
5ead4a07 | 725 | //\r |
726 | // Promote VAR_IN_DELETED_TRANSITION to VAR_ADDED\r | |
727 | //\r | |
814bae52 | 728 | VariableSize = (UINTN) NextVariable - (UINTN) Variable;\r |
729 | CopyMem (CurrPtr, (UINT8 *) Variable, VariableSize);\r | |
5ead4a07 | 730 | ((VARIABLE_HEADER *) CurrPtr)->State = VAR_ADDED;\r |
814bae52 | 731 | CurrPtr += VariableSize;\r |
732 | }\r | |
733 | }\r | |
734 | \r | |
735 | Variable = NextVariable;\r | |
736 | }\r | |
8d3a5c82 | 737 | \r |
738 | if (IsVolatile) {\r | |
739 | //\r | |
740 | // If volatile variable store, just copy valid buffer\r | |
741 | //\r | |
742 | SetMem ((UINT8 *) (UINTN) VariableBase, VariableStoreHeader->Size, 0xff);\r | |
814bae52 | 743 | CopyMem ((UINT8 *) (UINTN) VariableBase, ValidBuffer, (UINTN) (CurrPtr - (UINT8 *) ValidBuffer));\r |
8d3a5c82 | 744 | Status = EFI_SUCCESS;\r |
745 | } else {\r | |
746 | //\r | |
747 | // If non-volatile variable store, perform FTW here.\r | |
748 | //\r | |
749 | Status = FtwVariableSpace (\r | |
750 | VariableBase,\r | |
751 | ValidBuffer,\r | |
814bae52 | 752 | (UINTN) (CurrPtr - (UINT8 *) ValidBuffer)\r |
8d3a5c82 | 753 | );\r |
8d3a5c82 | 754 | }\r |
814bae52 | 755 | if (!EFI_ERROR (Status)) {\r |
756 | *LastVariableOffset = (UINTN) (CurrPtr - (UINT8 *) ValidBuffer);\r | |
757 | } else {\r | |
8d3a5c82 | 758 | *LastVariableOffset = 0;\r |
759 | }\r | |
760 | \r | |
814bae52 | 761 | FreePool (ValidBuffer);\r |
762 | \r | |
8d3a5c82 | 763 | return Status;\r |
764 | }\r | |
765 | \r | |
33a5a666 A |
766 | \r |
767 | //\r | |
768 | // The current Hii implementation accesses this variable a larg # of times on every boot.\r | |
769 | // Other common variables are only accessed a single time. This is why this cache algorithm\r | |
770 | // only targets a single variable. Probably to get an performance improvement out of\r | |
771 | // a Cache you would need a cache that improves the search performance for a variable.\r | |
772 | //\r | |
773 | VARIABLE_CACHE_ENTRY mVariableCache[] = {\r | |
774 | {\r | |
775 | &gEfiGlobalVariableGuid,\r | |
776 | L"Lang",\r | |
777 | 0x00000000,\r | |
778 | 0x00,\r | |
779 | NULL\r | |
780 | }\r | |
781 | };\r | |
782 | \r | |
052ad7e1 A |
783 | \r |
784 | /**\r | |
785 | Update the Cache with Variable information. These are the same \r | |
786 | arguments as the EFI Variable services.\r | |
787 | \r | |
788 | @param[in] VariableName Name of variable\r | |
789 | @param[in] VendorGuid Guid of variable\r | |
790 | @param[in] Attribute Attribue of the variable\r | |
791 | @param[in] DataSize Size of data. 0 means delete\r | |
792 | @param[in] Data Variable data\r | |
793 | \r | |
794 | **/\r | |
33a5a666 A |
795 | VOID\r |
796 | UpdateVariableCache (\r | |
797 | IN CHAR16 *VariableName,\r | |
798 | IN EFI_GUID *VendorGuid,\r | |
052ad7e1 A |
799 | IN UINT32 Attributes,\r |
800 | IN UINTN DataSize,\r | |
801 | IN VOID *Data\r | |
33a5a666 A |
802 | )\r |
803 | {\r | |
804 | VARIABLE_CACHE_ENTRY *Entry;\r | |
805 | UINTN Index;\r | |
806 | \r | |
807 | if (EfiAtRuntime ()) {\r | |
808 | // Don't use the cache at runtime\r | |
809 | return;\r | |
810 | }\r | |
811 | \r | |
812 | for (Index = 0, Entry = mVariableCache; Index < sizeof (mVariableCache)/sizeof (VARIABLE_CACHE_ENTRY); Index++, Entry++) {\r | |
813 | if (CompareGuid (VendorGuid, Entry->Guid)) {\r | |
814 | if (StrCmp (VariableName, Entry->Name) == 0) { \r | |
815 | Entry->Attributes = Attributes;\r | |
816 | if (DataSize == 0) {\r | |
817 | // Delete Case\r | |
818 | if (Entry->DataSize != 0) {\r | |
819 | FreePool (Entry->Data);\r | |
820 | }\r | |
821 | Entry->DataSize = DataSize;\r | |
822 | } else if (DataSize == Entry->DataSize) {\r | |
823 | CopyMem (Entry->Data, Data, DataSize);\r | |
824 | } else {\r | |
825 | Entry->Data = AllocatePool (DataSize);\r | |
826 | Entry->DataSize = DataSize;\r | |
827 | CopyMem (Entry->Data, Data, DataSize);\r | |
828 | }\r | |
829 | }\r | |
830 | }\r | |
831 | }\r | |
832 | }\r | |
833 | \r | |
834 | \r | |
052ad7e1 A |
835 | /**\r |
836 | Search the cache to see if the variable is in the cache.\r | |
837 | \r | |
838 | @param[in] VariableName Name of variable\r | |
839 | @param[in] VendorGuid Guid of variable\r | |
840 | @param[in] Attribute Attribue returned \r | |
841 | @param[in] DataSize Size of data returned\r | |
842 | @param[in] Data Variable data returned\r | |
843 | \r | |
844 | @retval EFI_SUCCESS VariableGuid & VariableName data was returned.\r | |
845 | @retval other Not found.\r | |
846 | \r | |
847 | **/\r | |
33a5a666 A |
848 | EFI_STATUS\r |
849 | FindVariableInCache (\r | |
850 | IN CHAR16 *VariableName,\r | |
851 | IN EFI_GUID *VendorGuid,\r | |
852 | OUT UINT32 *Attributes OPTIONAL,\r | |
853 | IN OUT UINTN *DataSize,\r | |
854 | OUT VOID *Data\r | |
855 | )\r | |
856 | {\r | |
857 | VARIABLE_CACHE_ENTRY *Entry;\r | |
858 | UINTN Index;\r | |
859 | \r | |
860 | if (EfiAtRuntime ()) {\r | |
861 | // Don't use the cache at runtime\r | |
862 | return EFI_NOT_FOUND;\r | |
863 | }\r | |
864 | \r | |
865 | for (Index = 0, Entry = mVariableCache; Index < sizeof (mVariableCache)/sizeof (VARIABLE_CACHE_ENTRY); Index++, Entry++) {\r | |
866 | if (CompareGuid (VendorGuid, Entry->Guid)) {\r | |
867 | if (StrCmp (VariableName, Entry->Name) == 0) {\r | |
868 | if (Entry->DataSize == 0) {\r | |
052ad7e1 | 869 | // Variable was deleted so return not found\r |
33a5a666 | 870 | return EFI_NOT_FOUND;\r |
aa09397b | 871 | } else if (Entry->DataSize > *DataSize) {\r |
052ad7e1 | 872 | // If the buffer is too small return correct size\r |
33a5a666 A |
873 | *DataSize = Entry->DataSize;\r |
874 | return EFI_BUFFER_TOO_SMALL;\r | |
875 | } else {\r | |
aa09397b | 876 | *DataSize = Entry->DataSize;\r |
052ad7e1 | 877 | // Return the data\r |
33a5a666 A |
878 | CopyMem (Data, Entry->Data, Entry->DataSize);\r |
879 | if (Attributes != NULL) {\r | |
880 | *Attributes = Entry->Attributes;\r | |
881 | }\r | |
882 | return EFI_SUCCESS;\r | |
883 | }\r | |
884 | }\r | |
885 | }\r | |
886 | }\r | |
887 | \r | |
888 | return EFI_NOT_FOUND;\r | |
889 | }\r | |
890 | \r | |
891 | \r | |
8d3a5c82 | 892 | EFI_STATUS\r |
8d3a5c82 | 893 | FindVariable (\r |
894 | IN CHAR16 *VariableName,\r | |
895 | IN EFI_GUID *VendorGuid,\r | |
896 | OUT VARIABLE_POINTER_TRACK *PtrTrack,\r | |
897 | IN VARIABLE_GLOBAL *Global\r | |
898 | )\r | |
899 | /*++\r | |
900 | \r | |
901 | Routine Description:\r | |
902 | \r | |
903 | This code finds variable in storage blocks (Volatile or Non-Volatile)\r | |
904 | \r | |
905 | Arguments:\r | |
906 | \r | |
907 | VariableName Name of the variable to be found\r | |
908 | VendorGuid Vendor GUID to be found.\r | |
909 | PtrTrack Variable Track Pointer structure that contains\r | |
910 | Variable Information.\r | |
911 | Contains the pointer of Variable header.\r | |
912 | Global VARIABLE_GLOBAL pointer\r | |
913 | \r | |
914 | Returns:\r | |
915 | \r | |
916 | EFI STATUS\r | |
917 | \r | |
918 | --*/\r | |
919 | {\r | |
814bae52 | 920 | VARIABLE_HEADER *Variable[2];\r |
921 | VARIABLE_HEADER *InDeletedVariable;\r | |
922 | VARIABLE_STORE_HEADER *VariableStoreHeader[2];\r | |
923 | UINTN InDeletedStorageIndex;\r | |
924 | UINTN Index;\r | |
925 | VOID *Point;\r | |
8d3a5c82 | 926 | \r |
8d3a5c82 | 927 | //\r |
33a5a666 | 928 | // 0: Volatile, 1: Non-Volatile\r |
36873a61 | 929 | // The index and attributes mapping must be kept in this order as RuntimeServiceGetNextVariableName\r |
930 | // make use of this mapping to implement search algorithme.\r | |
8d3a5c82 | 931 | //\r |
052ad7e1 A |
932 | VariableStoreHeader[0] = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase);\r |
933 | VariableStoreHeader[1] = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase);\r | |
8d3a5c82 | 934 | \r |
935 | //\r | |
936 | // Start Pointers for the variable.\r | |
937 | // Actual Data Pointer where data can be written.\r | |
938 | //\r | |
9cad030b | 939 | Variable[0] = GetStartPointer (VariableStoreHeader[0]);\r |
940 | Variable[1] = GetStartPointer (VariableStoreHeader[1]);\r | |
8d3a5c82 | 941 | \r |
942 | if (VariableName[0] != 0 && VendorGuid == NULL) {\r | |
943 | return EFI_INVALID_PARAMETER;\r | |
944 | }\r | |
814bae52 | 945 | \r |
8d3a5c82 | 946 | //\r |
33a5a666 | 947 | // Find the variable by walk through volatile and then non-volatile variable store\r |
8d3a5c82 | 948 | //\r |
814bae52 | 949 | InDeletedVariable = NULL;\r |
950 | InDeletedStorageIndex = 0;\r | |
8d3a5c82 | 951 | for (Index = 0; Index < 2; Index++) {\r |
8d3a5c82 | 952 | while (IsValidVariableHeader (Variable[Index]) && (Variable[Index] <= GetEndPointer (VariableStoreHeader[Index]))) {\r |
814bae52 | 953 | if (Variable[Index]->State == VAR_ADDED || \r |
954 | Variable[Index]->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)\r | |
955 | ) {\r | |
c6492839 | 956 | if (!EfiAtRuntime () || (Variable[Index]->Attributes & EFI_VARIABLE_RUNTIME_ACCESS)) {\r |
8d3a5c82 | 957 | if (VariableName[0] == 0) {\r |
814bae52 | 958 | if (Variable[Index]->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r |
959 | InDeletedVariable = Variable[Index];\r | |
960 | InDeletedStorageIndex = Index;\r | |
961 | } else {\r | |
962 | PtrTrack->StartPtr = GetStartPointer (VariableStoreHeader[Index]);\r | |
963 | PtrTrack->EndPtr = GetEndPointer (VariableStoreHeader[Index]);\r | |
964 | PtrTrack->CurrPtr = Variable[Index];\r | |
965 | PtrTrack->Volatile = (BOOLEAN)(Index == 0);\r | |
966 | \r | |
967 | return EFI_SUCCESS;\r | |
968 | }\r | |
8d3a5c82 | 969 | } else {\r |
970 | if (CompareGuid (VendorGuid, &Variable[Index]->VendorGuid)) {\r | |
130e2569 | 971 | Point = (VOID *) GetVariableNamePtr (Variable[Index]);\r |
972 | \r | |
973 | ASSERT (NameSizeOfVariable (Variable[Index]) != 0);\r | |
974 | if (!CompareMem (VariableName, Point, NameSizeOfVariable (Variable[Index]))) {\r | |
814bae52 | 975 | if (Variable[Index]->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r |
976 | InDeletedVariable = Variable[Index];\r | |
977 | InDeletedStorageIndex = Index;\r | |
978 | } else {\r | |
979 | PtrTrack->StartPtr = GetStartPointer (VariableStoreHeader[Index]);\r | |
980 | PtrTrack->EndPtr = GetEndPointer (VariableStoreHeader[Index]);\r | |
981 | PtrTrack->CurrPtr = Variable[Index];\r | |
982 | PtrTrack->Volatile = (BOOLEAN)(Index == 0);\r | |
983 | \r | |
984 | return EFI_SUCCESS;\r | |
985 | }\r | |
8d3a5c82 | 986 | }\r |
987 | }\r | |
988 | }\r | |
989 | }\r | |
990 | }\r | |
991 | \r | |
992 | Variable[Index] = GetNextVariablePtr (Variable[Index]);\r | |
993 | }\r | |
814bae52 | 994 | if (InDeletedVariable != NULL) {\r |
995 | PtrTrack->StartPtr = GetStartPointer (VariableStoreHeader[InDeletedStorageIndex]);\r | |
996 | PtrTrack->EndPtr = GetEndPointer (VariableStoreHeader[InDeletedStorageIndex]);\r | |
997 | PtrTrack->CurrPtr = InDeletedVariable;\r | |
998 | PtrTrack->Volatile = (BOOLEAN)(InDeletedStorageIndex == 0);\r | |
999 | return EFI_SUCCESS;\r | |
1000 | }\r | |
8d3a5c82 | 1001 | }\r |
8d3a5c82 | 1002 | PtrTrack->CurrPtr = NULL;\r |
1003 | return EFI_NOT_FOUND;\r | |
1004 | }\r | |
1005 | \r | |
33a5a666 | 1006 | \r |
052ad7e1 | 1007 | \r |
8d3a5c82 | 1008 | /*++\r |
1009 | \r | |
1010 | Routine Description:\r | |
1011 | \r | |
1012 | This code finds variable in storage blocks (Volatile or Non-Volatile)\r | |
1013 | \r | |
1014 | Arguments:\r | |
1015 | \r | |
c6492839 | 1016 | VariableName Name of Variable to be found\r |
1017 | VendorGuid Variable vendor GUID\r | |
1018 | Attributes OPTIONAL Attribute value of the variable found\r | |
1019 | DataSize Size of Data found. If size is less than the\r | |
1020 | data, this value contains the required size.\r | |
1021 | Data Data pointer\r | |
1022 | Global Pointer to VARIABLE_GLOBAL structure\r | |
1023 | Instance Instance of the Firmware Volume.\r | |
8d3a5c82 | 1024 | \r |
1025 | Returns:\r | |
1026 | \r | |
c6492839 | 1027 | EFI_INVALID_PARAMETER - Invalid parameter\r |
1028 | EFI_SUCCESS - Find the specified variable\r | |
1029 | EFI_NOT_FOUND - Not found\r | |
1030 | EFI_BUFFER_TO_SMALL - DataSize is too small for the result\r | |
1031 | \r | |
8d3a5c82 | 1032 | \r |
1033 | --*/\r | |
052ad7e1 A |
1034 | EFI_STATUS\r |
1035 | EFIAPI\r | |
1036 | RuntimeServiceGetVariable (\r | |
1037 | IN CHAR16 *VariableName,\r | |
1038 | IN EFI_GUID *VendorGuid,\r | |
1039 | OUT UINT32 *Attributes OPTIONAL,\r | |
1040 | IN OUT UINTN *DataSize,\r | |
1041 | OUT VOID *Data\r | |
1042 | )\r | |
8d3a5c82 | 1043 | {\r |
052ad7e1 | 1044 | EFI_STATUS Status;\r |
8d3a5c82 | 1045 | VARIABLE_POINTER_TRACK Variable;\r |
1046 | UINTN VarDataSize;\r | |
8d3a5c82 | 1047 | \r |
1048 | if (VariableName == NULL || VendorGuid == NULL || DataSize == NULL) {\r | |
1049 | return EFI_INVALID_PARAMETER;\r | |
1050 | }\r | |
33a5a666 | 1051 | \r |
fdb7765f | 1052 | AcquireLockOnlyAtBootTime(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r |
1053 | \r | |
8d3a5c82 | 1054 | //\r |
1055 | // Find existing variable\r | |
1056 | //\r | |
33a5a666 A |
1057 | Status = FindVariableInCache (VariableName, VendorGuid, Attributes, DataSize, Data);\r |
1058 | if ((Status == EFI_BUFFER_TOO_SMALL) || (Status == EFI_SUCCESS)){\r | |
1059 | // Hit in the Cache\r | |
1060 | UpdateVariableInfo (VariableName, VendorGuid, FALSE, TRUE, FALSE, FALSE, TRUE);\r | |
fdb7765f | 1061 | goto Done;\r |
33a5a666 A |
1062 | }\r |
1063 | \r | |
052ad7e1 | 1064 | Status = FindVariable (VariableName, VendorGuid, &Variable, &mVariableModuleGlobal->VariableGlobal);\r |
8d3a5c82 | 1065 | if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {\r |
1066 | goto Done;\r | |
1067 | }\r | |
33a5a666 | 1068 | \r |
8d3a5c82 | 1069 | //\r |
1070 | // Get data size\r | |
1071 | //\r | |
130e2569 | 1072 | VarDataSize = DataSizeOfVariable (Variable.CurrPtr);\r |
fdb7765f | 1073 | ASSERT (VarDataSize != 0);\r |
1074 | \r | |
8d3a5c82 | 1075 | if (*DataSize >= VarDataSize) {\r |
1076 | if (Data == NULL) {\r | |
1077 | Status = EFI_INVALID_PARAMETER;\r | |
1078 | goto Done;\r | |
1079 | }\r | |
1080 | \r | |
1081 | CopyMem (Data, GetVariableDataPtr (Variable.CurrPtr), VarDataSize);\r | |
1082 | if (Attributes != NULL) {\r | |
1083 | *Attributes = Variable.CurrPtr->Attributes;\r | |
1084 | }\r | |
1085 | \r | |
1086 | *DataSize = VarDataSize;\r | |
33a5a666 A |
1087 | UpdateVariableInfo (VariableName, VendorGuid, Variable.Volatile, TRUE, FALSE, FALSE, FALSE);\r |
1088 | UpdateVariableCache (VariableName, VendorGuid, Variable.CurrPtr->Attributes, VarDataSize, Data);\r | |
1089 | \r | |
8d3a5c82 | 1090 | Status = EFI_SUCCESS;\r |
1091 | goto Done;\r | |
1092 | } else {\r | |
1093 | *DataSize = VarDataSize;\r | |
1094 | Status = EFI_BUFFER_TOO_SMALL;\r | |
1095 | goto Done;\r | |
1096 | }\r | |
1097 | \r | |
1098 | Done:\r | |
052ad7e1 | 1099 | ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r |
8d3a5c82 | 1100 | return Status;\r |
1101 | }\r | |
1102 | \r | |
052ad7e1 A |
1103 | \r |
1104 | \r | |
8d3a5c82 | 1105 | /*++\r |
1106 | \r | |
1107 | Routine Description:\r | |
1108 | \r | |
1109 | This code Finds the Next available variable\r | |
1110 | \r | |
1111 | Arguments:\r | |
1112 | \r | |
1113 | VariableNameSize Size of the variable\r | |
1114 | VariableName Pointer to variable name\r | |
1115 | VendorGuid Variable Vendor Guid\r | |
1116 | Global VARIABLE_GLOBAL structure pointer.\r | |
1117 | Instance FV instance\r | |
1118 | \r | |
1119 | Returns:\r | |
1120 | \r | |
1121 | EFI STATUS\r | |
1122 | \r | |
1123 | --*/\r | |
052ad7e1 A |
1124 | EFI_STATUS\r |
1125 | EFIAPI\r | |
1126 | RuntimeServiceGetNextVariableName (\r | |
1127 | IN OUT UINTN *VariableNameSize,\r | |
1128 | IN OUT CHAR16 *VariableName,\r | |
1129 | IN OUT EFI_GUID *VendorGuid\r | |
1130 | )\r | |
8d3a5c82 | 1131 | {\r |
1132 | VARIABLE_POINTER_TRACK Variable;\r | |
1133 | UINTN VarNameSize;\r | |
1134 | EFI_STATUS Status;\r | |
1135 | \r | |
1136 | if (VariableNameSize == NULL || VariableName == NULL || VendorGuid == NULL) {\r | |
1137 | return EFI_INVALID_PARAMETER;\r | |
1138 | }\r | |
1139 | \r | |
fdb7765f | 1140 | AcquireLockOnlyAtBootTime(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r |
1141 | \r | |
052ad7e1 | 1142 | Status = FindVariable (VariableName, VendorGuid, &Variable, &mVariableModuleGlobal->VariableGlobal);\r |
8d3a5c82 | 1143 | if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {\r |
1144 | goto Done;\r | |
1145 | }\r | |
1146 | \r | |
1147 | if (VariableName[0] != 0) {\r | |
1148 | //\r | |
1149 | // If variable name is not NULL, get next variable\r | |
1150 | //\r | |
1151 | Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);\r | |
1152 | }\r | |
1153 | \r | |
1154 | while (TRUE) {\r | |
1155 | //\r | |
1156 | // If both volatile and non-volatile variable store are parsed,\r | |
1157 | // return not found\r | |
1158 | //\r | |
1159 | if (Variable.CurrPtr >= Variable.EndPtr || Variable.CurrPtr == NULL) {\r | |
1160 | Variable.Volatile = (BOOLEAN) (Variable.Volatile ^ ((BOOLEAN) 0x1));\r | |
36873a61 | 1161 | if (!Variable.Volatile) {\r |
9cad030b | 1162 | Variable.StartPtr = GetStartPointer ((VARIABLE_STORE_HEADER *) (UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase);\r |
1163 | Variable.EndPtr = GetEndPointer ((VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase));\r | |
8d3a5c82 | 1164 | } else {\r |
1165 | Status = EFI_NOT_FOUND;\r | |
1166 | goto Done;\r | |
1167 | }\r | |
1168 | \r | |
1169 | Variable.CurrPtr = Variable.StartPtr;\r | |
1170 | if (!IsValidVariableHeader (Variable.CurrPtr)) {\r | |
1171 | continue;\r | |
1172 | }\r | |
1173 | }\r | |
1174 | //\r | |
1175 | // Variable is found\r | |
1176 | //\r | |
1177 | if (IsValidVariableHeader (Variable.CurrPtr) && Variable.CurrPtr->State == VAR_ADDED) {\r | |
1178 | if (!(EfiAtRuntime () && !(Variable.CurrPtr->Attributes & EFI_VARIABLE_RUNTIME_ACCESS))) {\r | |
130e2569 | 1179 | VarNameSize = NameSizeOfVariable (Variable.CurrPtr);\r |
fdb7765f | 1180 | ASSERT (VarNameSize != 0);\r |
1181 | \r | |
8d3a5c82 | 1182 | if (VarNameSize <= *VariableNameSize) {\r |
1183 | CopyMem (\r | |
1184 | VariableName,\r | |
130e2569 | 1185 | GetVariableNamePtr (Variable.CurrPtr),\r |
8d3a5c82 | 1186 | VarNameSize\r |
1187 | );\r | |
1188 | CopyMem (\r | |
1189 | VendorGuid,\r | |
1190 | &Variable.CurrPtr->VendorGuid,\r | |
1191 | sizeof (EFI_GUID)\r | |
1192 | );\r | |
1193 | Status = EFI_SUCCESS;\r | |
1194 | } else {\r | |
1195 | Status = EFI_BUFFER_TOO_SMALL;\r | |
1196 | }\r | |
1197 | \r | |
1198 | *VariableNameSize = VarNameSize;\r | |
1199 | goto Done;\r | |
1200 | }\r | |
1201 | }\r | |
1202 | \r | |
1203 | Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);\r | |
1204 | }\r | |
1205 | \r | |
1206 | Done:\r | |
052ad7e1 | 1207 | ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r |
8d3a5c82 | 1208 | return Status;\r |
1209 | }\r | |
1210 | \r | |
052ad7e1 | 1211 | \r |
8d3a5c82 | 1212 | /*++\r |
1213 | \r | |
1214 | Routine Description:\r | |
1215 | \r | |
1216 | This code sets variable in storage blocks (Volatile or Non-Volatile)\r | |
1217 | \r | |
1218 | Arguments:\r | |
1219 | \r | |
1220 | VariableName Name of Variable to be found\r | |
1221 | VendorGuid Variable vendor GUID\r | |
1222 | Attributes Attribute value of the variable found\r | |
1223 | DataSize Size of Data found. If size is less than the\r | |
1224 | data, this value contains the required size.\r | |
1225 | Data Data pointer\r | |
1226 | Global Pointer to VARIABLE_GLOBAL structure\r | |
1227 | VolatileOffset The offset of last volatile variable\r | |
1228 | NonVolatileOffset The offset of last non-volatile variable\r | |
1229 | Instance Instance of the Firmware Volume.\r | |
1230 | \r | |
1231 | Returns:\r | |
1232 | \r | |
8d3a5c82 | 1233 | EFI_INVALID_PARAMETER - Invalid parameter\r |
1234 | EFI_SUCCESS - Set successfully\r | |
1235 | EFI_OUT_OF_RESOURCES - Resource not enough to set variable\r | |
1236 | EFI_NOT_FOUND - Not found\r | |
c6492839 | 1237 | EFI_DEVICE_ERROR - Variable can not be saved due to hardware failure\r |
1238 | EFI_WRITE_PROTECTED - Variable is read-only\r | |
8d3a5c82 | 1239 | \r |
1240 | --*/\r | |
052ad7e1 A |
1241 | EFI_STATUS\r |
1242 | EFIAPI\r | |
1243 | RuntimeServiceSetVariable (\r | |
1244 | IN CHAR16 *VariableName,\r | |
1245 | IN EFI_GUID *VendorGuid,\r | |
1246 | IN UINT32 Attributes,\r | |
1247 | IN UINTN DataSize,\r | |
1248 | IN VOID *Data\r | |
1249 | )\r | |
8d3a5c82 | 1250 | {\r |
1251 | VARIABLE_POINTER_TRACK Variable;\r | |
1252 | EFI_STATUS Status;\r | |
1253 | VARIABLE_HEADER *NextVariable;\r | |
1254 | UINTN VarNameSize;\r | |
1255 | UINTN VarNameOffset;\r | |
1256 | UINTN VarDataOffset;\r | |
1257 | UINTN VarSize;\r | |
1258 | UINT8 State;\r | |
1259 | BOOLEAN Reclaimed;\r | |
052ad7e1 A |
1260 | UINTN *VolatileOffset;\r |
1261 | UINTN *NonVolatileOffset;\r | |
1262 | UINT32 Instance;\r | |
fd51bf70 | 1263 | BOOLEAN Volatile;\r |
fdb7765f | 1264 | EFI_PHYSICAL_ADDRESS Point;\r |
8d3a5c82 | 1265 | \r |
c6492839 | 1266 | //\r |
1267 | // Check input parameters\r | |
1268 | //\r | |
8d3a5c82 | 1269 | if (VariableName == NULL || VariableName[0] == 0 || VendorGuid == NULL) {\r |
1270 | return EFI_INVALID_PARAMETER;\r | |
c6492839 | 1271 | } \r |
1272 | //\r | |
1273 | // Make sure if runtime bit is set, boot service bit is set also\r | |
1274 | //\r | |
1275 | if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == EFI_VARIABLE_RUNTIME_ACCESS) {\r | |
1276 | return EFI_INVALID_PARAMETER;\r | |
8d3a5c82 | 1277 | }\r |
fdb7765f | 1278 | \r |
c6492839 | 1279 | //\r |
1280 | // The size of the VariableName, including the Unicode Null in bytes plus\r | |
1281 | // the DataSize is limited to maximum size of MAX_HARDWARE_ERROR_VARIABLE_SIZE (32K)\r | |
1282 | // bytes for HwErrRec, and MAX_VARIABLE_SIZE (1024) bytes for the others.\r | |
1283 | //\r | |
1284 | if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r | |
1285 | if ((DataSize > MAX_HARDWARE_ERROR_VARIABLE_SIZE) || \r | |
1286 | (sizeof (VARIABLE_HEADER) + StrSize (VariableName) + DataSize > MAX_HARDWARE_ERROR_VARIABLE_SIZE)) {\r | |
1287 | return EFI_INVALID_PARAMETER;\r | |
1288 | } \r | |
1289 | } else {\r | |
1290 | //\r | |
1291 | // The size of the VariableName, including the Unicode Null in bytes plus\r | |
1292 | // the DataSize is limited to maximum size of MAX_VARIABLE_SIZE (1024) bytes.\r | |
1293 | //\r | |
1294 | if ((DataSize > MAX_VARIABLE_SIZE) ||\r | |
1295 | (sizeof (VARIABLE_HEADER) + StrSize (VariableName) + DataSize > MAX_VARIABLE_SIZE)) {\r | |
1296 | return EFI_INVALID_PARAMETER;\r | |
1297 | } \r | |
1298 | } \r | |
fdb7765f | 1299 | \r |
1300 | AcquireLockOnlyAtBootTime(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r | |
1301 | \r | |
1302 | Reclaimed = FALSE;\r | |
1303 | Instance = mVariableModuleGlobal->FvbInstance;\r | |
1304 | VolatileOffset = &mVariableModuleGlobal->VolatileLastVariableOffset;\r | |
1305 | \r | |
1306 | //\r | |
1307 | // Consider reentrant in MCA/INIT/NMI. It needs be reupdated;\r | |
1308 | //\r | |
1309 | if (1 < InterlockedIncrement (&mVariableModuleGlobal->VariableGlobal.ReentrantState)) {\r | |
fdb7765f | 1310 | Point = mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase;;\r |
1311 | //\r | |
1312 | // Parse non-volatile variable data and get last variable offset\r | |
1313 | //\r | |
9cad030b | 1314 | NextVariable = GetStartPointer ((VARIABLE_STORE_HEADER *) (UINTN) Point);\r |
fdb7765f | 1315 | while (IsValidVariableHeader (NextVariable)) {\r |
1316 | NextVariable = GetNextVariablePtr (NextVariable);\r | |
1317 | }\r | |
1318 | mVariableModuleGlobal->NonVolatileLastVariableOffset = (UINTN) NextVariable - (UINTN) Point;\r | |
1319 | }\r | |
1320 | \r | |
1321 | NonVolatileOffset = &mVariableModuleGlobal->NonVolatileLastVariableOffset;\r | |
1322 | \r | |
1323 | \r | |
c6492839 | 1324 | //\r |
1325 | // Check whether the input variable is already existed\r | |
1326 | //\r | |
1327 | \r | |
052ad7e1 | 1328 | Status = FindVariable (VariableName, VendorGuid, &Variable, &mVariableModuleGlobal->VariableGlobal);\r |
c6492839 | 1329 | if (Status == EFI_SUCCESS && Variable.CurrPtr != NULL) {\r |
8d3a5c82 | 1330 | //\r |
c6492839 | 1331 | // Update/Delete existing variable\r |
8d3a5c82 | 1332 | //\r |
fd51bf70 | 1333 | Volatile = Variable.Volatile;\r |
c6492839 | 1334 | \r |
1335 | if (EfiAtRuntime ()) { \r | |
1336 | //\r | |
1337 | // If EfiAtRuntime and the variable is Volatile and Runtime Access, \r | |
1338 | // the volatile is ReadOnly, and SetVariable should be aborted and \r | |
1339 | // return EFI_WRITE_PROTECTED.\r | |
1340 | //\r | |
1341 | if (Variable.Volatile) {\r | |
1342 | Status = EFI_WRITE_PROTECTED;\r | |
1343 | goto Done;\r | |
1344 | }\r | |
1345 | //\r | |
1346 | // Only variable have NV attribute can be updated/deleted in Runtime\r | |
1347 | //\r | |
1348 | if (!(Variable.CurrPtr->Attributes & EFI_VARIABLE_NON_VOLATILE)) {\r | |
1349 | Status = EFI_INVALID_PARAMETER;\r | |
1350 | goto Done; \r | |
1351 | }\r | |
1352 | }\r | |
8d3a5c82 | 1353 | //\r |
c6492839 | 1354 | // Setting a data variable with no access, or zero DataSize attributes\r |
1355 | // specified causes it to be deleted.\r | |
8d3a5c82 | 1356 | //\r |
c6492839 | 1357 | if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) { \r |
1358 | State = Variable.CurrPtr->State;\r | |
1359 | State &= VAR_DELETED;\r | |
1360 | \r | |
1361 | Status = UpdateVariableStore (\r | |
052ad7e1 | 1362 | &mVariableModuleGlobal->VariableGlobal,\r |
c6492839 | 1363 | Variable.Volatile,\r |
1364 | FALSE,\r | |
1365 | Instance,\r | |
1366 | (UINTN) &Variable.CurrPtr->State,\r | |
1367 | sizeof (UINT8),\r | |
1368 | &State\r | |
1369 | ); \r | |
33a5a666 | 1370 | if (!EFI_ERROR (Status)) {\r |
fd51bf70 | 1371 | UpdateVariableInfo (VariableName, VendorGuid, Volatile, FALSE, FALSE, TRUE, FALSE);\r |
33a5a666 A |
1372 | UpdateVariableCache (VariableName, VendorGuid, Attributes, DataSize, Data);\r |
1373 | }\r | |
c6492839 | 1374 | goto Done; \r |
1375 | }\r | |
8d3a5c82 | 1376 | //\r |
c6492839 | 1377 | // If the variable is marked valid and the same data has been passed in\r |
1378 | // then return to the caller immediately.\r | |
8d3a5c82 | 1379 | //\r |
130e2569 | 1380 | if (DataSizeOfVariable (Variable.CurrPtr) == DataSize &&\r |
c6492839 | 1381 | (CompareMem (Data, GetVariableDataPtr (Variable.CurrPtr), DataSize) == 0)) {\r |
33a5a666 | 1382 | \r |
fd51bf70 | 1383 | UpdateVariableInfo (VariableName, VendorGuid, Volatile, FALSE, TRUE, FALSE, FALSE);\r |
c6492839 | 1384 | Status = EFI_SUCCESS;\r |
1385 | goto Done;\r | |
1386 | } else if ((Variable.CurrPtr->State == VAR_ADDED) ||\r | |
1387 | (Variable.CurrPtr->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION))) {\r | |
814bae52 | 1388 | \r |
c6492839 | 1389 | //\r |
1390 | // Mark the old variable as in delete transition\r | |
1391 | //\r | |
1392 | State = Variable.CurrPtr->State;\r | |
1393 | State &= VAR_IN_DELETED_TRANSITION;\r | |
1394 | \r | |
1395 | Status = UpdateVariableStore (\r | |
052ad7e1 | 1396 | &mVariableModuleGlobal->VariableGlobal,\r |
c6492839 | 1397 | Variable.Volatile,\r |
1398 | FALSE,\r | |
1399 | Instance,\r | |
1400 | (UINTN) &Variable.CurrPtr->State,\r | |
1401 | sizeof (UINT8),\r | |
1402 | &State\r | |
1403 | ); \r | |
1404 | if (EFI_ERROR (Status)) {\r | |
1405 | goto Done; \r | |
33a5a666 | 1406 | } \r |
c6492839 | 1407 | } \r |
1408 | } else if (Status == EFI_NOT_FOUND) {\r | |
8d3a5c82 | 1409 | //\r |
c6492839 | 1410 | // Create a new variable\r |
1411 | // \r | |
1412 | \r | |
8d3a5c82 | 1413 | //\r |
c6492839 | 1414 | // Make sure we are trying to create a new variable.\r |
1415 | // Setting a data variable with no access, or zero DataSize attributes means to delete it. \r | |
8d3a5c82 | 1416 | //\r |
c6492839 | 1417 | if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) {\r |
1418 | Status = EFI_NOT_FOUND;\r | |
1419 | goto Done;\r | |
1420 | }\r | |
1421 | \r | |
8d3a5c82 | 1422 | //\r |
c6492839 | 1423 | // Only variable have NV|RT attribute can be created in Runtime\r |
1424 | //\r | |
1425 | if (EfiAtRuntime () &&\r | |
1426 | (!(Attributes & EFI_VARIABLE_RUNTIME_ACCESS) || !(Attributes & EFI_VARIABLE_NON_VOLATILE))) {\r | |
1427 | Status = EFI_INVALID_PARAMETER;\r | |
1428 | goto Done;\r | |
1429 | } \r | |
1430 | } else {\r | |
8d3a5c82 | 1431 | //\r |
c6492839 | 1432 | // Status should be EFI_INVALID_PARAMETER here according to return status of FindVariable().\r |
8d3a5c82 | 1433 | //\r |
c6492839 | 1434 | ASSERT (Status == EFI_INVALID_PARAMETER);\r |
8d3a5c82 | 1435 | goto Done;\r |
c6492839 | 1436 | }\r |
1437 | \r | |
1438 | //\r | |
1439 | // Function part - create a new variable and copy the data.\r | |
1440 | // Both update a variable and create a variable will come here.\r | |
1441 | //\r | |
1442 | // Tricky part: Use scratch data area at the end of volatile variable store\r | |
1443 | // as a temporary storage.\r | |
1444 | //\r | |
052ad7e1 | 1445 | NextVariable = GetEndPointer ((VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase));\r |
c6492839 | 1446 | \r |
1447 | SetMem (NextVariable, SCRATCH_SIZE, 0xff);\r | |
1448 | \r | |
1449 | NextVariable->StartId = VARIABLE_DATA;\r | |
1450 | NextVariable->Attributes = Attributes;\r | |
1451 | //\r | |
1452 | // NextVariable->State = VAR_ADDED;\r | |
1453 | //\r | |
1454 | NextVariable->Reserved = 0;\r | |
1455 | VarNameOffset = sizeof (VARIABLE_HEADER);\r | |
1456 | VarNameSize = StrSize (VariableName);\r | |
1457 | CopyMem (\r | |
1458 | (UINT8 *) ((UINTN) NextVariable + VarNameOffset),\r | |
1459 | VariableName,\r | |
1460 | VarNameSize\r | |
1461 | );\r | |
1462 | VarDataOffset = VarNameOffset + VarNameSize + GET_PAD_SIZE (VarNameSize);\r | |
1463 | CopyMem (\r | |
1464 | (UINT8 *) ((UINTN) NextVariable + VarDataOffset),\r | |
1465 | Data,\r | |
1466 | DataSize\r | |
1467 | );\r | |
1468 | CopyMem (&NextVariable->VendorGuid, VendorGuid, sizeof (EFI_GUID));\r | |
1469 | //\r | |
1470 | // There will be pad bytes after Data, the NextVariable->NameSize and\r | |
1471 | // NextVariable->DataSize should not include pad size so that variable\r | |
1472 | // service can get actual size in GetVariable\r | |
1473 | //\r | |
1474 | NextVariable->NameSize = (UINT32)VarNameSize;\r | |
1475 | NextVariable->DataSize = (UINT32)DataSize;\r | |
1476 | \r | |
1477 | //\r | |
1478 | // The actual size of the variable that stores in storage should\r | |
1479 | // include pad size.\r | |
1480 | //\r | |
1481 | VarSize = VarDataOffset + DataSize + GET_PAD_SIZE (DataSize);\r | |
1482 | if (Attributes & EFI_VARIABLE_NON_VOLATILE) {\r | |
8d3a5c82 | 1483 | //\r |
c6492839 | 1484 | // Create a nonvolatile variable\r |
8d3a5c82 | 1485 | //\r |
fd51bf70 | 1486 | Volatile = FALSE;\r |
c6492839 | 1487 | \r |
1488 | if ((UINT32) (VarSize +*NonVolatileOffset) >\r | |
052ad7e1 | 1489 | ((VARIABLE_STORE_HEADER *) ((UINTN) (mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase)))->Size\r |
c6492839 | 1490 | ) {\r |
1491 | if (EfiAtRuntime ()) {\r | |
1492 | Status = EFI_OUT_OF_RESOURCES;\r | |
1493 | goto Done;\r | |
1494 | }\r | |
1495 | //\r | |
1496 | // Perform garbage collection & reclaim operation\r | |
1497 | //\r | |
814bae52 | 1498 | Status = Reclaim (mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase, NonVolatileOffset, FALSE, Variable.CurrPtr);\r |
8d3a5c82 | 1499 | if (EFI_ERROR (Status)) {\r |
1500 | goto Done;\r | |
1501 | }\r | |
8d3a5c82 | 1502 | //\r |
c6492839 | 1503 | // If still no enough space, return out of resources\r |
8d3a5c82 | 1504 | //\r |
c6492839 | 1505 | if ((UINT32) (VarSize +*NonVolatileOffset) >\r |
052ad7e1 | 1506 | ((VARIABLE_STORE_HEADER *) ((UINTN) (mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase)))->Size\r |
8d3a5c82 | 1507 | ) {\r |
c6492839 | 1508 | Status = EFI_OUT_OF_RESOURCES;\r |
8d3a5c82 | 1509 | goto Done;\r |
8d3a5c82 | 1510 | }\r |
c6492839 | 1511 | \r |
1512 | Reclaimed = TRUE;\r | |
8d3a5c82 | 1513 | }\r |
1514 | //\r | |
c6492839 | 1515 | // Three steps\r |
1516 | // 1. Write variable header\r | |
130e2569 | 1517 | // 2. Set variable state to header valid \r |
1518 | // 3. Write variable data\r | |
1519 | // 4. Set variable state to valid\r | |
8d3a5c82 | 1520 | //\r |
8d3a5c82 | 1521 | //\r |
c6492839 | 1522 | // Step 1:\r |
8d3a5c82 | 1523 | //\r |
c6492839 | 1524 | Status = UpdateVariableStore (\r |
052ad7e1 | 1525 | &mVariableModuleGlobal->VariableGlobal,\r |
c6492839 | 1526 | FALSE,\r |
1527 | TRUE,\r | |
1528 | Instance,\r | |
1529 | *NonVolatileOffset,\r | |
1530 | sizeof (VARIABLE_HEADER),\r | |
1531 | (UINT8 *) NextVariable\r | |
1532 | );\r | |
1533 | \r | |
1534 | if (EFI_ERROR (Status)) {\r | |
1535 | goto Done;\r | |
1536 | }\r | |
130e2569 | 1537 | \r |
8d3a5c82 | 1538 | //\r |
c6492839 | 1539 | // Step 2:\r |
8d3a5c82 | 1540 | //\r |
130e2569 | 1541 | NextVariable->State = VAR_HEADER_VALID_ONLY;\r |
1542 | Status = UpdateVariableStore (\r | |
1543 | &mVariableModuleGlobal->VariableGlobal,\r | |
1544 | FALSE,\r | |
1545 | TRUE,\r | |
1546 | Instance,\r | |
1547 | *NonVolatileOffset,\r | |
1548 | sizeof (VARIABLE_HEADER),\r | |
1549 | (UINT8 *) NextVariable\r | |
1550 | );\r | |
1551 | \r | |
1552 | if (EFI_ERROR (Status)) {\r | |
1553 | goto Done;\r | |
1554 | }\r | |
1555 | //\r | |
1556 | // Step 3:\r | |
1557 | //\r | |
c6492839 | 1558 | Status = UpdateVariableStore (\r |
052ad7e1 | 1559 | &mVariableModuleGlobal->VariableGlobal,\r |
c6492839 | 1560 | FALSE,\r |
1561 | TRUE,\r | |
1562 | Instance,\r | |
1563 | *NonVolatileOffset + sizeof (VARIABLE_HEADER),\r | |
1564 | (UINT32) VarSize - sizeof (VARIABLE_HEADER),\r | |
1565 | (UINT8 *) NextVariable + sizeof (VARIABLE_HEADER)\r | |
1566 | );\r | |
1567 | \r | |
1568 | if (EFI_ERROR (Status)) {\r | |
1569 | goto Done;\r | |
1570 | }\r | |
8d3a5c82 | 1571 | //\r |
130e2569 | 1572 | // Step 4:\r |
8d3a5c82 | 1573 | //\r |
c6492839 | 1574 | NextVariable->State = VAR_ADDED;\r |
1575 | Status = UpdateVariableStore (\r | |
052ad7e1 | 1576 | &mVariableModuleGlobal->VariableGlobal,\r |
c6492839 | 1577 | FALSE,\r |
1578 | TRUE,\r | |
1579 | Instance,\r | |
1580 | *NonVolatileOffset,\r | |
1581 | sizeof (VARIABLE_HEADER),\r | |
1582 | (UINT8 *) NextVariable\r | |
1583 | );\r | |
1584 | \r | |
1585 | if (EFI_ERROR (Status)) {\r | |
1586 | goto Done;\r | |
1587 | }\r | |
8d3a5c82 | 1588 | \r |
9cad030b | 1589 | *NonVolatileOffset = HEADER_ALIGN (*NonVolatileOffset + VarSize);\r |
8d3a5c82 | 1590 | \r |
c6492839 | 1591 | } else {\r |
1592 | //\r | |
1593 | // Create a volatile variable\r | |
1594 | // \r | |
fd51bf70 | 1595 | Volatile = TRUE;\r |
c6492839 | 1596 | \r |
1597 | if ((UINT32) (VarSize +*VolatileOffset) >\r | |
052ad7e1 | 1598 | ((VARIABLE_STORE_HEADER *) ((UINTN) (mVariableModuleGlobal->VariableGlobal.VolatileVariableBase)))->Size) {\r |
8d3a5c82 | 1599 | //\r |
c6492839 | 1600 | // Perform garbage collection & reclaim operation\r |
8d3a5c82 | 1601 | //\r |
814bae52 | 1602 | Status = Reclaim (mVariableModuleGlobal->VariableGlobal.VolatileVariableBase, VolatileOffset, TRUE, Variable.CurrPtr);\r |
8d3a5c82 | 1603 | if (EFI_ERROR (Status)) {\r |
1604 | goto Done;\r | |
1605 | }\r | |
1606 | //\r | |
c6492839 | 1607 | // If still no enough space, return out of resources\r |
8d3a5c82 | 1608 | //\r |
8d3a5c82 | 1609 | if ((UINT32) (VarSize +*VolatileOffset) >\r |
052ad7e1 | 1610 | ((VARIABLE_STORE_HEADER *) ((UINTN) (mVariableModuleGlobal->VariableGlobal.VolatileVariableBase)))->Size\r |
8d3a5c82 | 1611 | ) {\r |
c6492839 | 1612 | Status = EFI_OUT_OF_RESOURCES;\r |
8d3a5c82 | 1613 | goto Done;\r |
1614 | }\r | |
c6492839 | 1615 | \r |
1616 | Reclaimed = TRUE;\r | |
8d3a5c82 | 1617 | }\r |
8d3a5c82 | 1618 | \r |
c6492839 | 1619 | NextVariable->State = VAR_ADDED;\r |
1620 | Status = UpdateVariableStore (\r | |
052ad7e1 | 1621 | &mVariableModuleGlobal->VariableGlobal,\r |
c6492839 | 1622 | TRUE,\r |
1623 | TRUE,\r | |
1624 | Instance,\r | |
1625 | *VolatileOffset,\r | |
1626 | (UINT32) VarSize,\r | |
1627 | (UINT8 *) NextVariable\r | |
1628 | );\r | |
1629 | \r | |
1630 | if (EFI_ERROR (Status)) {\r | |
1631 | goto Done;\r | |
8d3a5c82 | 1632 | }\r |
c6492839 | 1633 | \r |
9cad030b | 1634 | *VolatileOffset = HEADER_ALIGN (*VolatileOffset + VarSize);\r |
c6492839 | 1635 | }\r |
1636 | //\r | |
1637 | // Mark the old variable as deleted\r | |
1638 | //\r | |
1639 | if (!Reclaimed && !EFI_ERROR (Status) && Variable.CurrPtr != NULL) {\r | |
1640 | State = Variable.CurrPtr->State;\r | |
1641 | State &= VAR_DELETED;\r | |
1642 | \r | |
1643 | Status = UpdateVariableStore (\r | |
052ad7e1 | 1644 | &mVariableModuleGlobal->VariableGlobal,\r |
c6492839 | 1645 | Variable.Volatile,\r |
1646 | FALSE,\r | |
1647 | Instance,\r | |
1648 | (UINTN) &Variable.CurrPtr->State,\r | |
1649 | sizeof (UINT8),\r | |
1650 | &State\r | |
1651 | );\r | |
33a5a666 A |
1652 | \r |
1653 | if (!EFI_ERROR (Status)) {\r | |
fd51bf70 | 1654 | UpdateVariableInfo (VariableName, VendorGuid, Volatile, FALSE, TRUE, FALSE, FALSE);\r |
33a5a666 A |
1655 | UpdateVariableCache (VariableName, VendorGuid, Attributes, DataSize, Data);\r |
1656 | }\r | |
c6492839 | 1657 | goto Done; \r |
8d3a5c82 | 1658 | }\r |
1659 | \r | |
1660 | Status = EFI_SUCCESS;\r | |
fd51bf70 | 1661 | UpdateVariableInfo (VariableName, VendorGuid, Volatile, FALSE, TRUE, FALSE, FALSE);\r |
33a5a666 A |
1662 | UpdateVariableCache (VariableName, VendorGuid, Attributes, DataSize, Data);\r |
1663 | \r | |
8d3a5c82 | 1664 | Done:\r |
fdb7765f | 1665 | InterlockedDecrement (&mVariableModuleGlobal->VariableGlobal.ReentrantState);\r |
052ad7e1 | 1666 | ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r |
fdb7765f | 1667 | \r |
8d3a5c82 | 1668 | return Status;\r |
1669 | }\r | |
1670 | \r | |
052ad7e1 | 1671 | \r |
8d3a5c82 | 1672 | /*++\r |
1673 | \r | |
1674 | Routine Description:\r | |
1675 | \r | |
1676 | This code returns information about the EFI variables.\r | |
1677 | \r | |
1678 | Arguments:\r | |
1679 | \r | |
1680 | Attributes Attributes bitmask to specify the type of variables\r | |
1681 | on which to return information.\r | |
1682 | MaximumVariableStorageSize Pointer to the maximum size of the storage space available\r | |
1683 | for the EFI variables associated with the attributes specified.\r | |
1684 | RemainingVariableStorageSize Pointer to the remaining size of the storage space available\r | |
c6492839 | 1685 | for EFI variables associated with the attributes specified.\r |
1686 | MaximumVariableSize Pointer to the maximum size of an individual EFI variables\r | |
8d3a5c82 | 1687 | associated with the attributes specified.\r |
1688 | Global Pointer to VARIABLE_GLOBAL structure.\r | |
1689 | Instance Instance of the Firmware Volume.\r | |
1690 | \r | |
1691 | Returns:\r | |
1692 | \r | |
1693 | EFI STATUS\r | |
1694 | EFI_INVALID_PARAMETER - An invalid combination of attribute bits was supplied.\r | |
1695 | EFI_SUCCESS - Query successfully.\r | |
1696 | EFI_UNSUPPORTED - The attribute is not supported on this platform.\r | |
1697 | \r | |
1698 | --*/\r | |
052ad7e1 A |
1699 | EFI_STATUS\r |
1700 | EFIAPI\r | |
1701 | RuntimeServiceQueryVariableInfo (\r | |
1702 | IN UINT32 Attributes,\r | |
1703 | OUT UINT64 *MaximumVariableStorageSize,\r | |
1704 | OUT UINT64 *RemainingVariableStorageSize,\r | |
1705 | OUT UINT64 *MaximumVariableSize\r | |
1706 | )\r | |
8d3a5c82 | 1707 | {\r |
1708 | VARIABLE_HEADER *Variable;\r | |
1709 | VARIABLE_HEADER *NextVariable;\r | |
1710 | UINT64 VariableSize;\r | |
1711 | VARIABLE_STORE_HEADER *VariableStoreHeader;\r | |
1712 | \r | |
c6492839 | 1713 | if(MaximumVariableStorageSize == NULL || RemainingVariableStorageSize == NULL || MaximumVariableSize == NULL || Attributes == 0) {\r |
8d3a5c82 | 1714 | return EFI_INVALID_PARAMETER;\r |
1715 | }\r | |
c6492839 | 1716 | \r |
1717 | if((Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == 0) {\r | |
8d3a5c82 | 1718 | //\r |
1719 | // Make sure the Attributes combination is supported by the platform.\r | |
1720 | //\r | |
c6492839 | 1721 | return EFI_UNSUPPORTED; \r |
8d3a5c82 | 1722 | } else if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == EFI_VARIABLE_RUNTIME_ACCESS) {\r |
1723 | //\r | |
1724 | // Make sure if runtime bit is set, boot service bit is set also.\r | |
1725 | //\r | |
1726 | return EFI_INVALID_PARAMETER;\r | |
1727 | } else if (EfiAtRuntime () && !(Attributes & EFI_VARIABLE_RUNTIME_ACCESS)) {\r | |
1728 | //\r | |
1729 | // Make sure RT Attribute is set if we are in Runtime phase.\r | |
1730 | //\r | |
1731 | return EFI_INVALID_PARAMETER;\r | |
1732 | }\r | |
1733 | \r | |
052ad7e1 | 1734 | AcquireLockOnlyAtBootTime(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r |
8d3a5c82 | 1735 | \r |
1736 | if((Attributes & EFI_VARIABLE_NON_VOLATILE) == 0) {\r | |
1737 | //\r | |
1738 | // Query is Volatile related.\r | |
1739 | //\r | |
052ad7e1 | 1740 | VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase);\r |
8d3a5c82 | 1741 | } else {\r |
1742 | //\r | |
1743 | // Query is Non-Volatile related.\r | |
1744 | //\r | |
052ad7e1 | 1745 | VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase);\r |
8d3a5c82 | 1746 | }\r |
1747 | \r | |
1748 | //\r | |
1749 | // Now let's fill *MaximumVariableStorageSize *RemainingVariableStorageSize\r | |
1750 | // with the storage size (excluding the storage header size).\r | |
1751 | //\r | |
1752 | *MaximumVariableStorageSize = VariableStoreHeader->Size - sizeof (VARIABLE_STORE_HEADER);\r | |
1753 | *RemainingVariableStorageSize = VariableStoreHeader->Size - sizeof (VARIABLE_STORE_HEADER);\r | |
1754 | \r | |
1755 | //\r | |
c6492839 | 1756 | // Let *MaximumVariableSize be MAX_VARIABLE_SIZE with the exception of the variable header size.\r |
8d3a5c82 | 1757 | //\r |
c6492839 | 1758 | *MaximumVariableSize = MAX_VARIABLE_SIZE - sizeof (VARIABLE_HEADER);\r |
1759 | \r | |
1760 | //\r | |
1761 | // Harware error record variable needs larger size.\r | |
1762 | //\r | |
1763 | if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r | |
1764 | *MaximumVariableSize = MAX_HARDWARE_ERROR_VARIABLE_SIZE - sizeof (VARIABLE_HEADER);\r | |
1765 | }\r | |
8d3a5c82 | 1766 | \r |
1767 | //\r | |
1768 | // Point to the starting address of the variables.\r | |
1769 | //\r | |
9cad030b | 1770 | Variable = GetStartPointer (VariableStoreHeader);\r |
8d3a5c82 | 1771 | \r |
1772 | //\r | |
1773 | // Now walk through the related variable store.\r | |
1774 | //\r | |
1775 | while (IsValidVariableHeader (Variable) && (Variable < GetEndPointer (VariableStoreHeader))) {\r | |
1776 | NextVariable = GetNextVariablePtr (Variable);\r | |
1777 | VariableSize = (UINT64) (UINTN) NextVariable - (UINT64) (UINTN) Variable;\r | |
1778 | \r | |
1779 | if (EfiAtRuntime ()) {\r | |
1780 | //\r | |
1781 | // we don't take the state of the variables in mind\r | |
1782 | // when calculating RemainingVariableStorageSize,\r | |
1783 | // since the space occupied by variables not marked with\r | |
1784 | // VAR_ADDED is not allowed to be reclaimed in Runtime.\r | |
1785 | //\r | |
1786 | *RemainingVariableStorageSize -= VariableSize;\r | |
1787 | } else {\r | |
1788 | //\r | |
1789 | // Only care about Variables with State VAR_ADDED,because\r | |
1790 | // the space not marked as VAR_ADDED is reclaimable now.\r | |
1791 | //\r | |
1792 | if (Variable->State == VAR_ADDED) {\r | |
1793 | *RemainingVariableStorageSize -= VariableSize;\r | |
1794 | }\r | |
1795 | }\r | |
1796 | \r | |
1797 | //\r | |
1798 | // Go to the next one\r | |
1799 | //\r | |
1800 | Variable = NextVariable;\r | |
1801 | }\r | |
1802 | \r | |
c6492839 | 1803 | if (*RemainingVariableStorageSize < sizeof (VARIABLE_HEADER)) {\r |
1804 | *MaximumVariableSize = 0;\r | |
1805 | } else if ((*RemainingVariableStorageSize - sizeof (VARIABLE_HEADER)) < *MaximumVariableSize) {\r | |
1806 | *MaximumVariableSize = *RemainingVariableStorageSize - sizeof (VARIABLE_HEADER);\r | |
1807 | }\r | |
1808 | \r | |
052ad7e1 | 1809 | ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r |
8d3a5c82 | 1810 | return EFI_SUCCESS;\r |
1811 | }\r | |
1812 | \r | |
7800593d LG |
1813 | VOID\r |
1814 | EFIAPI\r | |
1815 | ReclaimForOS(\r | |
1816 | EFI_EVENT Event,\r | |
1817 | VOID *Context\r | |
1818 | )\r | |
1819 | {\r | |
1820 | UINT32 VarSize;\r | |
1821 | EFI_STATUS Status;\r | |
1822 | \r | |
1823 | VarSize = ((VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase))->Size;\r | |
1824 | Status = EFI_SUCCESS; \r | |
1825 | \r | |
1826 | //\r | |
1827 | // Check if the free area is blow a threshold\r | |
1828 | //\r | |
1829 | if ((VarSize - mVariableModuleGlobal->NonVolatileLastVariableOffset) < VARIABLE_RECLAIM_THRESHOLD) {\r | |
1830 | Status = Reclaim (\r | |
1831 | mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase,\r | |
1832 | &mVariableModuleGlobal->NonVolatileLastVariableOffset,\r | |
814bae52 | 1833 | FALSE,\r |
1834 | NULL\r | |
7800593d LG |
1835 | );\r |
1836 | ASSERT_EFI_ERROR (Status);\r | |
1837 | }\r | |
1838 | }\r | |
1839 | \r | |
8d3a5c82 | 1840 | EFI_STATUS\r |
8d3a5c82 | 1841 | VariableCommonInitialize (\r |
1842 | IN EFI_HANDLE ImageHandle,\r | |
1843 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
1844 | )\r | |
1845 | /*++\r | |
1846 | \r | |
1847 | Routine Description:\r | |
1848 | This function does common initialization for variable services\r | |
1849 | \r | |
1850 | Arguments:\r | |
1851 | \r | |
1852 | ImageHandle - The firmware allocated handle for the EFI image.\r | |
1853 | SystemTable - A pointer to the EFI System Table.\r | |
1854 | \r | |
1855 | Returns:\r | |
1856 | \r | |
1857 | Status code.\r | |
1858 | \r | |
1859 | EFI_NOT_FOUND - Variable store area not found.\r | |
1860 | EFI_UNSUPPORTED - Currently only one non-volatile variable store is supported.\r | |
1861 | EFI_SUCCESS - Variable services successfully initialized.\r | |
1862 | \r | |
1863 | --*/\r | |
1864 | {\r | |
1865 | EFI_STATUS Status;\r | |
1866 | EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r | |
1867 | CHAR8 *CurrPtr;\r | |
1868 | VARIABLE_STORE_HEADER *VolatileVariableStore;\r | |
1869 | VARIABLE_STORE_HEADER *VariableStoreHeader;\r | |
1870 | VARIABLE_HEADER *NextVariable;\r | |
1871 | UINT32 Instance;\r | |
1872 | EFI_PHYSICAL_ADDRESS FvVolHdr;\r | |
8d3a5c82 | 1873 | UINT64 TempVariableStoreHeader;\r |
8d3a5c82 | 1874 | EFI_GCD_MEMORY_SPACE_DESCRIPTOR GcdDescriptor;\r |
8d3a5c82 | 1875 | UINT64 BaseAddress;\r |
1876 | UINT64 Length;\r | |
1877 | UINTN Index;\r | |
1878 | UINT8 Data;\r | |
052ad7e1 A |
1879 | UINT64 VariableStoreBase;\r |
1880 | UINT64 VariableStoreLength;\r | |
7800593d | 1881 | EFI_EVENT ReadyToBootEvent;\r |
8d3a5c82 | 1882 | \r |
7800593d LG |
1883 | Status = EFI_SUCCESS;\r |
1884 | //\r | |
1885 | // Allocate runtime memory for variable driver global structure.\r | |
1886 | //\r | |
1887 | mVariableModuleGlobal = AllocateRuntimePool (sizeof (VARIABLE_MODULE_GLOBAL));\r | |
1888 | if (mVariableModuleGlobal == NULL) {\r | |
1889 | return EFI_OUT_OF_RESOURCES;\r | |
1890 | }\r | |
8d3a5c82 | 1891 | \r |
052ad7e1 | 1892 | EfiInitializeLock(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock, TPL_NOTIFY);\r |
fdb7765f | 1893 | mVariableModuleGlobal->VariableGlobal.ReentrantState = 0;\r |
8d3a5c82 | 1894 | \r |
1895 | //\r | |
1896 | // Allocate memory for volatile variable store\r | |
1897 | //\r | |
1898 | VolatileVariableStore = AllocateRuntimePool (VARIABLE_STORE_SIZE + SCRATCH_SIZE);\r | |
1899 | if (VolatileVariableStore == NULL) {\r | |
1900 | FreePool (mVariableModuleGlobal);\r | |
1901 | return EFI_OUT_OF_RESOURCES;\r | |
1902 | }\r | |
1903 | \r | |
1904 | SetMem (VolatileVariableStore, VARIABLE_STORE_SIZE + SCRATCH_SIZE, 0xff);\r | |
1905 | \r | |
1906 | //\r | |
1907 | // Variable Specific Data\r | |
1908 | //\r | |
052ad7e1 | 1909 | mVariableModuleGlobal->VariableGlobal.VolatileVariableBase = (EFI_PHYSICAL_ADDRESS) (UINTN) VolatileVariableStore;\r |
9cad030b | 1910 | mVariableModuleGlobal->VolatileLastVariableOffset = (UINTN) GetStartPointer (VolatileVariableStore) - (UINTN) VolatileVariableStore;\r |
8d3a5c82 | 1911 | \r |
1912 | VolatileVariableStore->Signature = VARIABLE_STORE_SIGNATURE;\r | |
1913 | VolatileVariableStore->Size = VARIABLE_STORE_SIZE;\r | |
1914 | VolatileVariableStore->Format = VARIABLE_STORE_FORMATTED;\r | |
1915 | VolatileVariableStore->State = VARIABLE_STORE_HEALTHY;\r | |
1916 | VolatileVariableStore->Reserved = 0;\r | |
1917 | VolatileVariableStore->Reserved1 = 0;\r | |
1918 | \r | |
1919 | //\r | |
1920 | // Get non volatile varaible store\r | |
1921 | //\r | |
1922 | \r | |
1923 | TempVariableStoreHeader = (UINT64) PcdGet32 (PcdFlashNvStorageVariableBase);\r | |
052ad7e1 | 1924 | VariableStoreBase = TempVariableStoreHeader + \\r |
8d3a5c82 | 1925 | (((EFI_FIRMWARE_VOLUME_HEADER *) (UINTN) (TempVariableStoreHeader)) -> HeaderLength);\r |
052ad7e1 | 1926 | VariableStoreLength = (UINT64) PcdGet32 (PcdFlashNvStorageVariableSize) - \\r |
8d3a5c82 | 1927 | (((EFI_FIRMWARE_VOLUME_HEADER *) (UINTN) (TempVariableStoreHeader)) -> HeaderLength);\r |
1928 | //\r | |
1929 | // Mark the variable storage region of the FLASH as RUNTIME\r | |
1930 | //\r | |
052ad7e1 A |
1931 | BaseAddress = VariableStoreBase & (~EFI_PAGE_MASK);\r |
1932 | Length = VariableStoreLength + (VariableStoreBase - BaseAddress);\r | |
8d3a5c82 | 1933 | Length = (Length + EFI_PAGE_SIZE - 1) & (~EFI_PAGE_MASK);\r |
1934 | \r | |
1935 | Status = gDS->GetMemorySpaceDescriptor (BaseAddress, &GcdDescriptor);\r | |
1936 | if (EFI_ERROR (Status)) {\r | |
7800593d | 1937 | goto Done;\r |
8d3a5c82 | 1938 | }\r |
1939 | \r | |
1940 | Status = gDS->SetMemorySpaceAttributes (\r | |
1941 | BaseAddress,\r | |
1942 | Length,\r | |
1943 | GcdDescriptor.Attributes | EFI_MEMORY_RUNTIME\r | |
1944 | );\r | |
1945 | if (EFI_ERROR (Status)) {\r | |
7800593d | 1946 | goto Done;\r |
8d3a5c82 | 1947 | }\r |
1948 | //\r | |
1949 | // Get address of non volatile variable store base\r | |
1950 | //\r | |
052ad7e1 | 1951 | mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase = VariableStoreBase;\r |
8d3a5c82 | 1952 | \r |
1953 | //\r | |
1954 | // Check Integrity\r | |
1955 | //\r | |
1956 | //\r | |
1957 | // Find the Correct Instance of the FV Block Service.\r | |
1958 | //\r | |
1959 | Instance = 0;\r | |
052ad7e1 | 1960 | CurrPtr = (CHAR8 *) ((UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase);\r |
8d3a5c82 | 1961 | while (EfiFvbGetPhysicalAddress (Instance, &FvVolHdr) == EFI_SUCCESS) {\r |
1962 | FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) ((UINTN) FvVolHdr);\r | |
1963 | if (CurrPtr >= (CHAR8 *) FwVolHeader && CurrPtr < (((CHAR8 *) FwVolHeader) + FwVolHeader->FvLength)) {\r | |
1964 | mVariableModuleGlobal->FvbInstance = Instance;\r | |
1965 | break;\r | |
1966 | }\r | |
1967 | \r | |
1968 | Instance++;\r | |
1969 | }\r | |
1970 | \r | |
1971 | VariableStoreHeader = (VARIABLE_STORE_HEADER *) CurrPtr;\r | |
1972 | if (GetVariableStoreStatus (VariableStoreHeader) == EfiValid) {\r | |
1973 | if (~VariableStoreHeader->Size == 0) {\r | |
1974 | Status = UpdateVariableStore (\r | |
052ad7e1 | 1975 | &mVariableModuleGlobal->VariableGlobal,\r |
8d3a5c82 | 1976 | FALSE,\r |
1977 | FALSE,\r | |
1978 | mVariableModuleGlobal->FvbInstance,\r | |
1979 | (UINTN) &VariableStoreHeader->Size,\r | |
1980 | sizeof (UINT32),\r | |
052ad7e1 | 1981 | (UINT8 *) &VariableStoreLength\r |
8d3a5c82 | 1982 | );\r |
1983 | //\r | |
1984 | // As Variables are stored in NV storage, which are slow devices,such as flash.\r | |
1985 | // Variable operation may skip checking variable program result to improve performance,\r | |
1986 | // We can assume Variable program is OK through some check point.\r | |
1987 | // Variable Store Size Setting should be the first Variable write operation,\r | |
1988 | // We can assume all Read/Write is OK if we can set Variable store size successfully.\r | |
1989 | // If write fail, we will assert here\r | |
1990 | //\r | |
052ad7e1 | 1991 | ASSERT(VariableStoreHeader->Size == VariableStoreLength);\r |
8d3a5c82 | 1992 | \r |
1993 | if (EFI_ERROR (Status)) {\r | |
7800593d | 1994 | goto Done;\r |
8d3a5c82 | 1995 | }\r |
1996 | }\r | |
1997 | \r | |
052ad7e1 | 1998 | mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase = (EFI_PHYSICAL_ADDRESS) ((UINTN) CurrPtr);\r |
8d3a5c82 | 1999 | //\r |
2000 | // Parse non-volatile variable data and get last variable offset\r | |
2001 | //\r | |
9cad030b | 2002 | NextVariable = GetStartPointer ((VARIABLE_STORE_HEADER *) CurrPtr);\r |
8d3a5c82 | 2003 | Status = EFI_SUCCESS;\r |
2004 | \r | |
2005 | while (IsValidVariableHeader (NextVariable)) {\r | |
2006 | NextVariable = GetNextVariablePtr (NextVariable);\r | |
2007 | }\r | |
2008 | \r | |
2009 | mVariableModuleGlobal->NonVolatileLastVariableOffset = (UINTN) NextVariable - (UINTN) CurrPtr;\r | |
2010 | \r | |
8d3a5c82 | 2011 | //\r |
2012 | // Check if the free area is really free.\r | |
2013 | //\r | |
2014 | for (Index = mVariableModuleGlobal->NonVolatileLastVariableOffset; Index < VariableStoreHeader->Size; Index++) {\r | |
052ad7e1 | 2015 | Data = ((UINT8 *) (UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase)[Index];\r |
8d3a5c82 | 2016 | if (Data != 0xff) {\r |
2017 | //\r | |
2018 | // There must be something wrong in variable store, do reclaim operation.\r | |
2019 | //\r | |
2020 | Status = Reclaim (\r | |
052ad7e1 | 2021 | mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase,\r |
8d3a5c82 | 2022 | &mVariableModuleGlobal->NonVolatileLastVariableOffset,\r |
814bae52 | 2023 | FALSE,\r |
2024 | NULL\r | |
8d3a5c82 | 2025 | );\r |
7800593d LG |
2026 | \r |
2027 | if (EFI_ERROR (Status)) {\r | |
2028 | goto Done;\r | |
2029 | }\r | |
2030 | \r | |
8d3a5c82 | 2031 | break;\r |
2032 | }\r | |
2033 | }\r | |
7800593d LG |
2034 | \r |
2035 | //\r | |
2036 | // Register the event handling function to reclaim variable for OS usage.\r | |
2037 | //\r | |
2038 | Status = EfiCreateEventReadyToBootEx (\r | |
2039 | TPL_NOTIFY, \r | |
2040 | ReclaimForOS, \r | |
2041 | NULL, \r | |
2042 | &ReadyToBootEvent\r | |
2043 | );\r | |
8d3a5c82 | 2044 | }\r |
2045 | \r | |
7800593d | 2046 | Done:\r |
8d3a5c82 | 2047 | if (EFI_ERROR (Status)) {\r |
2048 | FreePool (mVariableModuleGlobal);\r | |
2049 | FreePool (VolatileVariableStore);\r | |
2050 | }\r | |
2051 | \r | |
2052 | return Status;\r | |
2053 | }\r | |
052ad7e1 | 2054 | \r |
052ad7e1 A |
2055 | VOID\r |
2056 | EFIAPI\r | |
2057 | VariableClassAddressChangeEvent (\r | |
2058 | IN EFI_EVENT Event,\r | |
2059 | IN VOID *Context\r | |
2060 | )\r | |
2061 | {\r | |
2062 | EfiConvertPointer (\r | |
2063 | 0x0,\r | |
2064 | (VOID **) &mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase\r | |
2065 | );\r | |
2066 | EfiConvertPointer (\r | |
2067 | 0x0,\r | |
2068 | (VOID **) &mVariableModuleGlobal->VariableGlobal.VolatileVariableBase\r | |
2069 | );\r | |
2070 | EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal);\r | |
2071 | }\r | |
2072 | \r | |
2073 | \r | |
2074 | /**\r | |
2075 | Variable Driver main entry point. The Variable driver places the 4 EFI\r | |
2076 | runtime services in the EFI System Table and installs arch protocols \r | |
2077 | for variable read and write services being availible. \r | |
2078 | \r | |
2079 | @param[in] ImageHandle The firmware allocated handle for the EFI image. \r | |
2080 | @param[in] SystemTable A pointer to the EFI System Table.\r | |
2081 | \r | |
2082 | @retval EFI_SUCCESS The entry point is executed successfully.\r | |
2083 | @retval other Some error occurs when executing this entry point.\r | |
2084 | \r | |
2085 | **/\r | |
2086 | EFI_STATUS\r | |
2087 | EFIAPI\r | |
2088 | VariableServiceInitialize (\r | |
2089 | IN EFI_HANDLE ImageHandle,\r | |
2090 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
2091 | )\r | |
2092 | {\r | |
2093 | EFI_STATUS Status;\r | |
2094 | \r | |
2095 | Status = VariableCommonInitialize (ImageHandle, SystemTable);\r | |
2096 | ASSERT_EFI_ERROR (Status);\r | |
2097 | \r | |
2098 | SystemTable->RuntimeServices->GetVariable = RuntimeServiceGetVariable;\r | |
2099 | SystemTable->RuntimeServices->GetNextVariableName = RuntimeServiceGetNextVariableName;\r | |
2100 | SystemTable->RuntimeServices->SetVariable = RuntimeServiceSetVariable;\r | |
2101 | SystemTable->RuntimeServices->QueryVariableInfo = RuntimeServiceQueryVariableInfo;\r | |
2102 | \r | |
2103 | //\r | |
2104 | // Now install the Variable Runtime Architectural Protocol on a new handle\r | |
2105 | //\r | |
2106 | Status = gBS->InstallMultipleProtocolInterfaces (\r | |
2107 | &mHandle,\r | |
2108 | &gEfiVariableArchProtocolGuid, NULL,\r | |
2109 | &gEfiVariableWriteArchProtocolGuid, NULL,\r | |
2110 | NULL\r | |
2111 | );\r | |
2112 | ASSERT_EFI_ERROR (Status);\r | |
2113 | \r | |
2114 | Status = gBS->CreateEvent (\r | |
2115 | EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE,\r | |
2116 | TPL_NOTIFY,\r | |
2117 | VariableClassAddressChangeEvent,\r | |
2118 | NULL,\r | |
2119 | &mVirtualAddressChangeEvent\r | |
2120 | );\r | |
2121 | ASSERT_EFI_ERROR (Status);\r | |
2122 | \r | |
2123 | return EFI_SUCCESS;\r | |
2124 | }\r | |
2125 | \r |