]>
Commit | Line | Data |
---|---|---|
9071550e | 1 | /*++\r |
2 | \r | |
3 | Copyright (c) 2006 - 2007, Intel Corporation\r | |
4 | All rights reserved. This program and the accompanying materials\r | |
5 | are licensed and made available under the terms and conditions of the BSD License\r | |
6 | which accompanies this distribution. The full text of the license may be found at\r | |
7 | http://opensource.org/licenses/bsd-license.php\r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
11 | \r | |
12 | Module Name:\r | |
13 | \r | |
14 | FSVariable.c\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | Provide support functions for variable services.\r | |
19 | \r | |
20 | --*/\r | |
21 | \r | |
22 | #include "FSVariable.h"\r | |
23 | \r | |
24 | VARIABLE_STORE_HEADER mStoreHeaderTemplate = {\r | |
439c34f3 | 25 | VARIABLE_STORE_SIGNATURE,\r |
9071550e | 26 | VOLATILE_VARIABLE_STORE_SIZE,\r |
27 | VARIABLE_STORE_FORMATTED,\r | |
28 | VARIABLE_STORE_HEALTHY,\r | |
29 | 0,\r | |
30 | 0\r | |
31 | };\r | |
32 | \r | |
33 | //\r | |
34 | // Don't use module globals after the SetVirtualAddress map is signaled\r | |
35 | //\r | |
36 | VARIABLE_GLOBAL *mGlobal;\r | |
37 | \r | |
9071550e | 38 | VOID\r |
39 | EFIAPI\r | |
e56dd2ce | 40 | OnVirtualAddressChangeFsv (\r |
9071550e | 41 | IN EFI_EVENT Event,\r |
42 | IN VOID *Context\r | |
43 | );\r | |
44 | \r | |
9071550e | 45 | VOID\r |
46 | EFIAPI\r | |
47 | OnSimpleFileSystemInstall (\r | |
48 | IN EFI_EVENT Event,\r | |
49 | IN VOID *Context\r | |
50 | );\r | |
51 | \r | |
9071550e | 52 | BOOLEAN\r |
53 | IsValidVariableHeader (\r | |
54 | IN VARIABLE_HEADER *Variable\r | |
55 | )\r | |
56 | /*++\r | |
57 | \r | |
58 | Routine Description:\r | |
59 | \r | |
60 | This code checks if variable header is valid or not.\r | |
61 | \r | |
62 | Arguments:\r | |
63 | Variable Pointer to the Variable Header.\r | |
64 | \r | |
65 | Returns:\r | |
66 | TRUE Variable header is valid.\r | |
67 | FALSE Variable header is not valid.\r | |
68 | \r | |
69 | --*/\r | |
70 | {\r | |
71 | if (Variable == NULL ||\r | |
72 | Variable->StartId != VARIABLE_DATA ||\r | |
8e3fdb95 | 73 | (sizeof (VARIABLE_HEADER) + Variable->NameSize + Variable->DataSize) > FixedPcdGet32(PcdMaxVariableSize)\r |
9071550e | 74 | ) {\r |
75 | return FALSE;\r | |
76 | }\r | |
77 | \r | |
78 | return TRUE;\r | |
79 | }\r | |
80 | \r | |
9071550e | 81 | VARIABLE_STORE_STATUS\r |
82 | GetVariableStoreStatus (\r | |
83 | IN VARIABLE_STORE_HEADER *VarStoreHeader\r | |
84 | )\r | |
85 | /*++\r | |
86 | \r | |
87 | Routine Description:\r | |
88 | \r | |
89 | This code gets the current status of Variable Store.\r | |
90 | \r | |
91 | Arguments:\r | |
92 | \r | |
93 | VarStoreHeader Pointer to the Variable Store Header.\r | |
94 | \r | |
95 | Returns:\r | |
96 | \r | |
97 | EfiRaw Variable store status is raw\r | |
98 | EfiValid Variable store status is valid\r | |
99 | EfiInvalid Variable store status is invalid\r | |
100 | \r | |
101 | --*/\r | |
102 | {\r | |
3709c4cd | 103 | if (CompareGuid (&VarStoreHeader->Signature, &mStoreHeaderTemplate.Signature) &&\r |
9071550e | 104 | (VarStoreHeader->Format == mStoreHeaderTemplate.Format) &&\r |
105 | (VarStoreHeader->State == mStoreHeaderTemplate.State)\r | |
106 | ) {\r | |
107 | return EfiValid;\r | |
3709c4cd | 108 | } else if (((UINT32 *)(&VarStoreHeader->Signature))[0] == VAR_DEFAULT_VALUE_32 &&\r |
109 | ((UINT32 *)(&VarStoreHeader->Signature))[1] == VAR_DEFAULT_VALUE_32 &&\r | |
110 | ((UINT32 *)(&VarStoreHeader->Signature))[2] == VAR_DEFAULT_VALUE_32 &&\r | |
111 | ((UINT32 *)(&VarStoreHeader->Signature))[3] == VAR_DEFAULT_VALUE_32 &&\r | |
112 | VarStoreHeader->Size == VAR_DEFAULT_VALUE_32 &&\r | |
113 | VarStoreHeader->Format == VAR_DEFAULT_VALUE &&\r | |
114 | VarStoreHeader->State == VAR_DEFAULT_VALUE\r | |
9071550e | 115 | ) {\r |
116 | \r | |
117 | return EfiRaw;\r | |
118 | } else {\r | |
119 | return EfiInvalid;\r | |
120 | }\r | |
121 | }\r | |
122 | \r | |
9071550e | 123 | UINT8 *\r |
124 | GetVariableDataPtr (\r | |
125 | IN VARIABLE_HEADER *Variable\r | |
126 | )\r | |
127 | /*++\r | |
128 | \r | |
129 | Routine Description:\r | |
130 | \r | |
131 | This code gets the pointer to the variable data.\r | |
132 | \r | |
133 | Arguments:\r | |
134 | \r | |
135 | Variable Pointer to the Variable Header.\r | |
136 | \r | |
137 | Returns:\r | |
138 | \r | |
139 | UINT8* Pointer to Variable Data\r | |
140 | \r | |
141 | --*/\r | |
142 | {\r | |
143 | //\r | |
144 | // Be careful about pad size for alignment\r | |
145 | //\r | |
146 | return (UINT8 *) ((UINTN) GET_VARIABLE_NAME_PTR (Variable) + Variable->NameSize + GET_PAD_SIZE (Variable->NameSize));\r | |
147 | }\r | |
148 | \r | |
9071550e | 149 | VARIABLE_HEADER *\r |
150 | GetNextVariablePtr (\r | |
151 | IN VARIABLE_HEADER *Variable\r | |
152 | )\r | |
153 | /*++\r | |
154 | \r | |
155 | Routine Description:\r | |
156 | \r | |
157 | This code gets the pointer to the next variable header.\r | |
158 | \r | |
159 | Arguments:\r | |
160 | \r | |
161 | Variable Pointer to the Variable Header.\r | |
162 | \r | |
163 | Returns:\r | |
164 | \r | |
165 | VARIABLE_HEADER* Pointer to next variable header.\r | |
166 | \r | |
167 | --*/\r | |
168 | {\r | |
169 | if (!IsValidVariableHeader (Variable)) {\r | |
170 | return NULL;\r | |
171 | }\r | |
172 | //\r | |
173 | // Be careful about pad size for alignment\r | |
174 | //\r | |
175 | return (VARIABLE_HEADER *) ((UINTN) GetVariableDataPtr (Variable) + Variable->DataSize + GET_PAD_SIZE (Variable->DataSize));\r | |
176 | }\r | |
177 | \r | |
9071550e | 178 | VARIABLE_HEADER *\r |
179 | GetEndPointer (\r | |
180 | IN VARIABLE_STORE_HEADER *VarStoreHeader\r | |
181 | )\r | |
182 | /*++\r | |
183 | \r | |
184 | Routine Description:\r | |
185 | \r | |
186 | This code gets the pointer to the last variable memory pointer byte\r | |
187 | \r | |
188 | Arguments:\r | |
189 | \r | |
190 | VarStoreHeader Pointer to the Variable Store Header.\r | |
191 | \r | |
192 | Returns:\r | |
193 | \r | |
194 | VARIABLE_HEADER* Pointer to last unavailable Variable Header\r | |
195 | \r | |
196 | --*/\r | |
197 | {\r | |
198 | //\r | |
199 | // The end of variable store\r | |
200 | //\r | |
201 | return (VARIABLE_HEADER *) ((UINTN) VarStoreHeader + VarStoreHeader->Size);\r | |
202 | }\r | |
203 | \r | |
204 | BOOLEAN\r | |
205 | ExistNewerVariable (\r | |
206 | IN VARIABLE_HEADER *Variable\r | |
207 | )\r | |
208 | /*++\r | |
209 | \r | |
210 | Routine Description:\r | |
211 | \r | |
212 | Check if exist newer variable when doing reclaim\r | |
213 | \r | |
214 | Arguments:\r | |
215 | \r | |
216 | Variable Pointer to start position\r | |
217 | \r | |
218 | Returns:\r | |
219 | \r | |
220 | TRUE - Exists another variable, which is newer than the current one\r | |
221 | FALSE - Doesn't exist another vairable which is newer than the current one\r | |
222 | \r | |
223 | --*/\r | |
224 | {\r | |
225 | VARIABLE_HEADER *NextVariable;\r | |
226 | CHAR16 *VariableName;\r | |
227 | EFI_GUID *VendorGuid;\r | |
228 | \r | |
229 | VendorGuid = &Variable->VendorGuid;\r | |
230 | VariableName = GET_VARIABLE_NAME_PTR(Variable);\r | |
231 | \r | |
232 | NextVariable = GetNextVariablePtr (Variable);\r | |
233 | while (IsValidVariableHeader (NextVariable)) {\r | |
234 | if ((NextVariable->State == VAR_ADDED) || (NextVariable->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION))) {\r | |
235 | //\r | |
236 | // If match Guid and Name\r | |
237 | //\r | |
238 | if (CompareGuid (VendorGuid, &NextVariable->VendorGuid)) {\r | |
239 | if (CompareMem (VariableName, GET_VARIABLE_NAME_PTR (NextVariable), StrSize (VariableName)) == 0) {\r | |
240 | return TRUE;\r | |
241 | }\r | |
242 | }\r | |
243 | }\r | |
244 | NextVariable = GetNextVariablePtr (NextVariable);\r | |
245 | }\r | |
246 | return FALSE;\r | |
247 | }\r | |
248 | \r | |
9071550e | 249 | EFI_STATUS\r |
250 | Reclaim (\r | |
251 | IN VARIABLE_STORAGE_TYPE StorageType,\r | |
252 | IN VARIABLE_HEADER *CurrentVariable OPTIONAL\r | |
253 | )\r | |
254 | /*++\r | |
255 | \r | |
256 | Routine Description:\r | |
257 | \r | |
258 | Variable store garbage collection and reclaim operation\r | |
259 | \r | |
260 | Arguments:\r | |
261 | \r | |
262 | IsVolatile The variable store is volatile or not,\r | |
263 | if it is non-volatile, need FTW\r | |
264 | CurrentVairable If it is not NULL, it means not to process\r | |
265 | current variable for Reclaim.\r | |
266 | \r | |
267 | Returns:\r | |
268 | \r | |
269 | EFI STATUS\r | |
270 | \r | |
271 | --*/\r | |
272 | {\r | |
273 | VARIABLE_HEADER *Variable;\r | |
274 | VARIABLE_HEADER *NextVariable;\r | |
275 | VARIABLE_STORE_HEADER *VariableStoreHeader;\r | |
276 | UINT8 *ValidBuffer;\r | |
277 | UINTN ValidBufferSize;\r | |
278 | UINTN VariableSize;\r | |
279 | UINT8 *CurrPtr;\r | |
280 | EFI_STATUS Status;\r | |
281 | \r | |
282 | VariableStoreHeader = (VARIABLE_STORE_HEADER *) mGlobal->VariableBase[StorageType];\r | |
283 | \r | |
284 | //\r | |
285 | // Start Pointers for the variable.\r | |
286 | //\r | |
287 | Variable = (VARIABLE_HEADER *) (VariableStoreHeader + 1);\r | |
288 | \r | |
289 | \r | |
290 | //\r | |
291 | // To make the reclaim, here we just allocate a memory that equal to the original memory\r | |
292 | //\r | |
293 | ValidBufferSize = sizeof (VARIABLE_STORE_HEADER) + VariableStoreHeader->Size;\r | |
294 | \r | |
295 | Status = gBS->AllocatePool (\r | |
296 | EfiBootServicesData,\r | |
297 | ValidBufferSize,\r | |
7c04a679 | 298 | (VOID**) &ValidBuffer\r |
9071550e | 299 | );\r |
300 | if (EFI_ERROR (Status)) {\r | |
301 | return Status;\r | |
302 | }\r | |
303 | \r | |
304 | CurrPtr = ValidBuffer;\r | |
305 | \r | |
306 | //\r | |
307 | // Copy variable store header\r | |
308 | //\r | |
309 | CopyMem (CurrPtr, VariableStoreHeader, sizeof (VARIABLE_STORE_HEADER));\r | |
310 | CurrPtr += sizeof (VARIABLE_STORE_HEADER);\r | |
311 | \r | |
312 | //\r | |
313 | // Start Pointers for the variable.\r | |
314 | //\r | |
315 | Variable = (VARIABLE_HEADER *) (VariableStoreHeader + 1);\r | |
316 | \r | |
317 | \r | |
318 | ValidBufferSize = sizeof (VARIABLE_STORE_HEADER);\r | |
319 | while (IsValidVariableHeader (Variable)) {\r | |
320 | NextVariable = GetNextVariablePtr (Variable);\r | |
321 | //\r | |
322 | // State VAR_ADDED or VAR_IN_DELETED_TRANSITION are to kept,\r | |
323 | // The CurrentVariable, is also saved, as SetVariable may fail due to lack of space\r | |
324 | //\r | |
325 | if (Variable->State == VAR_ADDED) {\r | |
326 | VariableSize = (UINTN) NextVariable - (UINTN) Variable;\r | |
327 | CopyMem (CurrPtr, (UINT8 *) Variable, VariableSize);\r | |
328 | ValidBufferSize += VariableSize;\r | |
329 | CurrPtr += VariableSize;\r | |
330 | } else if (Variable->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION)) {\r | |
331 | //\r | |
332 | // As variables that with the same guid and name may exist in NV due to power failure during SetVariable,\r | |
333 | // we will only save the latest valid one\r | |
334 | //\r | |
335 | if (!ExistNewerVariable(Variable)) {\r | |
336 | VariableSize = (UINTN) NextVariable - (UINTN) Variable;\r | |
337 | CopyMem (CurrPtr, (UINT8 *) Variable, VariableSize);\r | |
338 | //\r | |
339 | // If CurrentVariable == Variable, mark as VAR_IN_DELETED_TRANSITION\r | |
340 | //\r | |
341 | if (Variable != CurrentVariable){\r | |
342 | ((VARIABLE_HEADER *)CurrPtr)->State = VAR_ADDED;\r | |
343 | }\r | |
344 | CurrPtr += VariableSize;\r | |
345 | ValidBufferSize += VariableSize;\r | |
346 | }\r | |
347 | }\r | |
348 | Variable = NextVariable;\r | |
349 | }\r | |
350 | \r | |
351 | //\r | |
352 | // TODO: cannot restore to original state, basic FTW needed\r | |
353 | //\r | |
354 | Status = mGlobal->VariableStore[StorageType]->Erase (\r | |
355 | mGlobal->VariableStore[StorageType]\r | |
356 | );\r | |
357 | Status = mGlobal->VariableStore[StorageType]->Write (\r | |
358 | mGlobal->VariableStore[StorageType],\r | |
359 | 0,\r | |
360 | ValidBufferSize,\r | |
361 | ValidBuffer\r | |
362 | );\r | |
363 | \r | |
364 | // ASSERT_EFI_ERROR (Status);\r | |
365 | \r | |
366 | mGlobal->LastVariableOffset[StorageType] = ValidBufferSize;\r | |
367 | gBS->FreePool (ValidBuffer);\r | |
368 | \r | |
369 | return Status;\r | |
370 | }\r | |
371 | \r | |
9071550e | 372 | EFI_STATUS\r |
373 | FindVariable (\r | |
374 | IN CHAR16 *VariableName,\r | |
375 | IN EFI_GUID *VendorGuid,\r | |
376 | OUT VARIABLE_POINTER_TRACK *PtrTrack\r | |
377 | )\r | |
378 | /*++\r | |
379 | \r | |
380 | Routine Description:\r | |
381 | \r | |
382 | This code finds variable in storage blocks (Volatile or Non-Volatile)\r | |
383 | \r | |
384 | Arguments:\r | |
385 | \r | |
386 | VariableName Name of the variable to be found\r | |
387 | VendorGuid Vendor GUID to be found.\r | |
388 | PtrTrack Variable Track Pointer structure that contains\r | |
389 | Variable Information.\r | |
390 | Contains the pointer of Variable header.\r | |
391 | \r | |
392 | Returns:\r | |
393 | \r | |
394 | EFI_INVALID_PARAMETER - Invalid parameter\r | |
395 | EFI_SUCCESS - Find the specified variable\r | |
396 | EFI_NOT_FOUND - Not found\r | |
397 | \r | |
398 | --*/\r | |
399 | {\r | |
400 | VARIABLE_HEADER *Variable;\r | |
401 | VARIABLE_STORE_HEADER *VariableStoreHeader;\r | |
402 | UINTN Index;\r | |
403 | VARIABLE_HEADER *InDeleteVariable;\r | |
404 | UINTN InDeleteIndex;\r | |
405 | VARIABLE_HEADER *InDeleteStartPtr;\r | |
406 | VARIABLE_HEADER *InDeleteEndPtr;\r | |
407 | \r | |
408 | if (VariableName[0] != 0 && VendorGuid == NULL) {\r | |
409 | return EFI_INVALID_PARAMETER;\r | |
410 | }\r | |
411 | \r | |
412 | InDeleteVariable = NULL;\r | |
413 | InDeleteIndex = (UINTN)-1;\r | |
414 | InDeleteStartPtr = NULL;\r | |
415 | InDeleteEndPtr = NULL;\r | |
416 | \r | |
417 | for (Index = 0; Index < MaxType; Index ++) {\r | |
418 | //\r | |
419 | // 0: Non-Volatile, 1: Volatile\r | |
420 | //\r | |
421 | VariableStoreHeader = (VARIABLE_STORE_HEADER *) mGlobal->VariableBase[Index];\r | |
422 | \r | |
423 | //\r | |
424 | // Start Pointers for the variable.\r | |
425 | // Actual Data Pointer where data can be written.\r | |
426 | //\r | |
427 | Variable = (VARIABLE_HEADER *) (VariableStoreHeader + 1);\r | |
428 | \r | |
429 | //\r | |
430 | // Find the variable by walk through non-volatile and volatile variable store\r | |
431 | //\r | |
432 | PtrTrack->StartPtr = Variable;\r | |
433 | PtrTrack->EndPtr = GetEndPointer (VariableStoreHeader);\r | |
434 | \r | |
435 | while (IsValidVariableHeader (Variable) && (Variable < PtrTrack->EndPtr)) {\r | |
436 | if (Variable->State == VAR_ADDED) {\r | |
437 | if (!EfiAtRuntime () || (Variable->Attributes & EFI_VARIABLE_RUNTIME_ACCESS)) {\r | |
438 | if (VariableName[0] == 0) {\r | |
439 | PtrTrack->CurrPtr = Variable;\r | |
440 | PtrTrack->Type = (VARIABLE_STORAGE_TYPE) Index;\r | |
441 | return EFI_SUCCESS;\r | |
442 | } else {\r | |
443 | if (CompareGuid (VendorGuid, &Variable->VendorGuid)) {\r | |
444 | if (!CompareMem (VariableName, GET_VARIABLE_NAME_PTR (Variable), StrSize (VariableName))) {\r | |
445 | PtrTrack->CurrPtr = Variable;\r | |
446 | PtrTrack->Type = (VARIABLE_STORAGE_TYPE) Index;\r | |
447 | return EFI_SUCCESS;\r | |
448 | }\r | |
449 | }\r | |
450 | }\r | |
451 | }\r | |
452 | } else if (Variable->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION)) {\r | |
453 | //\r | |
454 | // VAR_IN_DELETED_TRANSITION should also be checked.\r | |
455 | //\r | |
456 | if (!EfiAtRuntime () || (Variable->Attributes & EFI_VARIABLE_RUNTIME_ACCESS)) {\r | |
457 | if (VariableName[0] == 0) {\r | |
458 | InDeleteVariable = Variable;\r | |
459 | InDeleteIndex = Index;\r | |
460 | InDeleteStartPtr = PtrTrack->StartPtr;\r | |
461 | InDeleteEndPtr = PtrTrack->EndPtr;\r | |
462 | } else {\r | |
463 | if (CompareGuid (VendorGuid, &Variable->VendorGuid)) {\r | |
464 | if (!CompareMem (VariableName, GET_VARIABLE_NAME_PTR (Variable), StrSize (VariableName))) {\r | |
465 | InDeleteVariable = Variable;\r | |
466 | InDeleteIndex = Index;\r | |
467 | InDeleteStartPtr = PtrTrack->StartPtr;\r | |
468 | InDeleteEndPtr = PtrTrack->EndPtr;\r | |
469 | }\r | |
470 | }\r | |
471 | }\r | |
472 | }\r | |
473 | }\r | |
474 | \r | |
475 | Variable = GetNextVariablePtr (Variable);\r | |
476 | }\r | |
477 | //\r | |
478 | // While (...)\r | |
479 | //\r | |
480 | }\r | |
481 | //\r | |
482 | // for (...)\r | |
483 | //\r | |
484 | \r | |
485 | //\r | |
486 | // if VAR_IN_DELETED_TRANSITION found, and VAR_ADDED not found,\r | |
487 | // we return it.\r | |
488 | //\r | |
489 | if (InDeleteVariable != NULL) {\r | |
490 | PtrTrack->CurrPtr = InDeleteVariable;\r | |
491 | PtrTrack->Type = (VARIABLE_STORAGE_TYPE) InDeleteIndex;\r | |
492 | PtrTrack->StartPtr = InDeleteStartPtr;\r | |
493 | PtrTrack->EndPtr = InDeleteEndPtr;\r | |
494 | return EFI_SUCCESS;\r | |
495 | }\r | |
496 | \r | |
497 | PtrTrack->CurrPtr = NULL;\r | |
498 | return EFI_NOT_FOUND;\r | |
499 | }\r | |
500 | \r | |
501 | EFI_STATUS\r | |
502 | EFIAPI\r | |
503 | GetVariable (\r | |
504 | IN CHAR16 *VariableName,\r | |
505 | IN EFI_GUID *VendorGuid,\r | |
506 | OUT UINT32 *Attributes OPTIONAL,\r | |
507 | IN OUT UINTN *DataSize,\r | |
508 | OUT VOID *Data\r | |
509 | )\r | |
510 | /*++\r | |
511 | \r | |
512 | Routine Description:\r | |
513 | \r | |
514 | This code finds variable in storage blocks (Volatile or Non-Volatile)\r | |
515 | \r | |
516 | Arguments:\r | |
517 | \r | |
518 | VariableName Name of Variable to be found\r | |
519 | VendorGuid Variable vendor GUID\r | |
520 | Attributes OPTIONAL Attribute value of the variable found\r | |
521 | DataSize Size of Data found. If size is less than the\r | |
522 | data, this value contains the required size.\r | |
523 | Data Data pointer\r | |
524 | \r | |
525 | Returns:\r | |
526 | \r | |
527 | EFI STATUS\r | |
528 | \r | |
529 | --*/\r | |
530 | {\r | |
531 | VARIABLE_POINTER_TRACK Variable;\r | |
532 | UINTN VarDataSize;\r | |
533 | EFI_STATUS Status;\r | |
534 | \r | |
535 | if (VariableName == NULL || VendorGuid == NULL || DataSize == NULL) {\r | |
536 | return EFI_INVALID_PARAMETER;\r | |
537 | }\r | |
538 | \r | |
539 | //\r | |
540 | // Find existing variable\r | |
541 | //\r | |
542 | Status = FindVariable (VariableName, VendorGuid, &Variable);\r | |
543 | \r | |
544 | if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {\r | |
545 | return Status;\r | |
546 | }\r | |
547 | //\r | |
548 | // Get data size\r | |
549 | //\r | |
550 | VarDataSize = Variable.CurrPtr->DataSize;\r | |
551 | if (*DataSize >= VarDataSize) {\r | |
552 | if (Data == NULL) {\r | |
553 | return EFI_INVALID_PARAMETER;\r | |
554 | }\r | |
555 | CopyMem (Data, GetVariableDataPtr (Variable.CurrPtr), VarDataSize);\r | |
556 | \r | |
557 | if (Attributes != NULL) {\r | |
558 | *Attributes = Variable.CurrPtr->Attributes;\r | |
559 | }\r | |
560 | \r | |
561 | *DataSize = VarDataSize;\r | |
562 | \r | |
563 | return EFI_SUCCESS;\r | |
564 | } else {\r | |
565 | *DataSize = VarDataSize;\r | |
566 | return EFI_BUFFER_TOO_SMALL;\r | |
567 | }\r | |
568 | }\r | |
569 | \r | |
570 | EFI_STATUS\r | |
571 | EFIAPI\r | |
572 | GetNextVariableName (\r | |
573 | IN OUT UINTN *VariableNameSize,\r | |
574 | IN OUT CHAR16 *VariableName,\r | |
575 | IN OUT EFI_GUID *VendorGuid\r | |
576 | )\r | |
577 | /*++\r | |
578 | \r | |
579 | Routine Description:\r | |
580 | \r | |
581 | This code Finds the Next available variable\r | |
582 | \r | |
583 | Arguments:\r | |
584 | \r | |
585 | VariableNameSize Size of the variable\r | |
586 | VariableName Pointer to variable name\r | |
587 | VendorGuid Variable Vendor Guid\r | |
588 | \r | |
589 | Returns:\r | |
590 | \r | |
591 | EFI STATUS\r | |
592 | \r | |
593 | --*/\r | |
594 | {\r | |
595 | VARIABLE_POINTER_TRACK Variable;\r | |
596 | UINTN VarNameSize;\r | |
597 | EFI_STATUS Status;\r | |
598 | \r | |
599 | if (VariableNameSize == NULL || VariableName == NULL || VendorGuid == NULL) {\r | |
600 | return EFI_INVALID_PARAMETER;\r | |
601 | }\r | |
602 | \r | |
603 | Status = FindVariable (VariableName, VendorGuid, &Variable);\r | |
604 | \r | |
605 | if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {\r | |
606 | return Status;\r | |
607 | }\r | |
608 | \r | |
609 | if (VariableName[0] != 0) {\r | |
610 | //\r | |
611 | // If variable name is not NULL, get next variable\r | |
612 | //\r | |
613 | Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);\r | |
614 | }\r | |
615 | \r | |
616 | while (TRUE) {\r | |
617 | //\r | |
618 | // The order we find variable is: 1). NonVolatile; 2). Volatile\r | |
619 | // If both volatile and non-volatile variable store are parsed,\r | |
620 | // return not found\r | |
621 | //\r | |
622 | if (Variable.CurrPtr >= Variable.EndPtr || Variable.CurrPtr == NULL) {\r | |
623 | if (Variable.Type == Volatile) {\r | |
624 | //\r | |
625 | // Since we met the end of Volatile storage, we have parsed all the stores.\r | |
626 | //\r | |
627 | return EFI_NOT_FOUND;\r | |
628 | }\r | |
629 | \r | |
630 | //\r | |
631 | // End of NonVolatile, continue to parse Volatile\r | |
632 | //\r | |
633 | Variable.Type = Volatile;\r | |
634 | Variable.StartPtr = (VARIABLE_HEADER *) ((VARIABLE_STORE_HEADER *) mGlobal->VariableBase[Volatile] + 1);\r | |
635 | Variable.EndPtr = (VARIABLE_HEADER *) GetEndPointer ((VARIABLE_STORE_HEADER *) mGlobal->VariableBase[Volatile]);\r | |
636 | \r | |
637 | Variable.CurrPtr = Variable.StartPtr;\r | |
638 | if (!IsValidVariableHeader (Variable.CurrPtr)) {\r | |
639 | continue;\r | |
640 | }\r | |
641 | }\r | |
642 | //\r | |
643 | // Variable is found\r | |
644 | //\r | |
645 | if (IsValidVariableHeader (Variable.CurrPtr) &&\r | |
646 | ((Variable.CurrPtr->State == VAR_ADDED) ||\r | |
647 | (Variable.CurrPtr->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION)))) {\r | |
648 | if (!EfiAtRuntime () || (Variable.CurrPtr->Attributes & EFI_VARIABLE_RUNTIME_ACCESS)) {\r | |
649 | VarNameSize = Variable.CurrPtr->NameSize;\r | |
650 | if (VarNameSize <= *VariableNameSize) {\r | |
651 | CopyMem (\r | |
652 | VariableName,\r | |
653 | GET_VARIABLE_NAME_PTR (Variable.CurrPtr),\r | |
654 | VarNameSize\r | |
655 | );\r | |
656 | CopyMem (\r | |
657 | VendorGuid,\r | |
658 | &Variable.CurrPtr->VendorGuid,\r | |
659 | sizeof (EFI_GUID)\r | |
660 | );\r | |
661 | Status = EFI_SUCCESS;\r | |
662 | } else {\r | |
663 | Status = EFI_BUFFER_TOO_SMALL;\r | |
664 | }\r | |
665 | \r | |
666 | *VariableNameSize = VarNameSize;\r | |
667 | return Status;\r | |
668 | }\r | |
669 | }\r | |
670 | \r | |
671 | Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);\r | |
672 | }\r | |
9071550e | 673 | }\r |
674 | \r | |
675 | EFI_STATUS\r | |
676 | EFIAPI\r | |
677 | SetVariable (\r | |
678 | IN CHAR16 *VariableName,\r | |
679 | IN EFI_GUID *VendorGuid,\r | |
680 | IN UINT32 Attributes,\r | |
681 | IN UINTN DataSize,\r | |
682 | IN VOID *Data\r | |
683 | )\r | |
684 | /*++\r | |
685 | \r | |
686 | Routine Description:\r | |
687 | \r | |
688 | This code sets variable in storage blocks (Volatile or Non-Volatile)\r | |
689 | \r | |
690 | Arguments:\r | |
691 | \r | |
692 | VariableName Name of Variable to be found\r | |
693 | VendorGuid Variable vendor GUID\r | |
694 | Attributes Attribute value of the variable found\r | |
695 | DataSize Size of Data found. If size is less than the\r | |
696 | data, this value contains the required size.\r | |
697 | Data Data pointer\r | |
698 | \r | |
699 | Returns:\r | |
700 | \r | |
701 | EFI_INVALID_PARAMETER - Invalid parameter\r | |
702 | EFI_SUCCESS - Set successfully\r | |
703 | EFI_OUT_OF_RESOURCES - Resource not enough to set variable\r | |
704 | EFI_NOT_FOUND - Not found\r | |
705 | EFI_DEVICE_ERROR - Variable can not be saved due to hardware failure\r | |
706 | EFI_WRITE_PROTECTED - Variable is read-only\r | |
707 | \r | |
708 | --*/\r | |
709 | {\r | |
710 | VARIABLE_POINTER_TRACK Variable;\r | |
711 | EFI_STATUS Status;\r | |
712 | VARIABLE_HEADER *NextVariable;\r | |
713 | UINTN VarNameSize;\r | |
714 | UINTN VarNameOffset;\r | |
715 | UINTN VarDataOffset;\r | |
716 | UINTN VarSize;\r | |
717 | UINT8 State;\r | |
718 | BOOLEAN Reclaimed;\r | |
719 | VARIABLE_STORAGE_TYPE StorageType;\r | |
720 | \r | |
721 | Reclaimed = FALSE;\r | |
722 | \r | |
723 | //\r | |
724 | // Check input parameters\r | |
725 | // \r | |
726 | \r | |
727 | if (VariableName == NULL || VariableName[0] == 0 || VendorGuid == NULL) {\r | |
728 | return EFI_INVALID_PARAMETER;\r | |
729 | }\r | |
730 | \r | |
731 | //\r | |
732 | // Make sure if runtime bit is set, boot service bit is set also\r | |
733 | //\r | |
734 | if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == EFI_VARIABLE_RUNTIME_ACCESS) {\r | |
735 | return EFI_INVALID_PARAMETER;\r | |
736 | }\r | |
737 | \r | |
9071550e | 738 | //\r |
739 | // The size of the VariableName, including the Unicode Null in bytes plus\r | |
8e3fdb95 LG |
740 | // the DataSize is limited to maximum size of FixedPcdGet32(PcdMaxHardwareErrorVariableSize)\r |
741 | // bytes for HwErrRec, and FixedPcdGet32(PcdMaxVariableSize) bytes for the others.\r | |
9071550e | 742 | //\r |
743 | if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r | |
8e3fdb95 LG |
744 | if ((DataSize > FixedPcdGet32(PcdMaxHardwareErrorVariableSize)) || \r |
745 | (sizeof (VARIABLE_HEADER) + StrSize (VariableName) + DataSize > FixedPcdGet32(PcdMaxHardwareErrorVariableSize))) {\r | |
9071550e | 746 | return EFI_INVALID_PARAMETER;\r |
747 | } \r | |
748 | } else {\r | |
8e3fdb95 LG |
749 | if ((DataSize > FixedPcdGet32(PcdMaxVariableSize)) ||\r |
750 | (sizeof (VARIABLE_HEADER) + StrSize (VariableName) + DataSize > FixedPcdGet32(PcdMaxVariableSize))) {\r | |
9071550e | 751 | return EFI_INVALID_PARAMETER;\r |
752 | } \r | |
753 | } \r | |
e5653d94 | 754 | \r |
9071550e | 755 | //\r |
756 | // Check whether the input variable is already existed\r | |
757 | //\r | |
758 | \r | |
759 | Status = FindVariable (VariableName, VendorGuid, &Variable);\r | |
760 | \r | |
761 | if (Status == EFI_SUCCESS && Variable.CurrPtr != NULL) { \r | |
762 | //\r | |
763 | // Update/Delete existing variable\r | |
764 | //\r | |
765 | \r | |
766 | if (EfiAtRuntime ()) { \r | |
767 | //\r | |
768 | // If EfiAtRuntime and the variable is Volatile and Runtime Access, \r | |
769 | // the volatile is ReadOnly, and SetVariable should be aborted and \r | |
770 | // return EFI_WRITE_PROTECTED.\r | |
771 | //\r | |
772 | if (Variable.Type == Volatile) {\r | |
773 | return EFI_WRITE_PROTECTED;\r | |
774 | }\r | |
775 | //\r | |
776 | // Only variable have NV attribute can be updated/deleted in Runtime\r | |
777 | //\r | |
778 | if (!(Variable.CurrPtr->Attributes & EFI_VARIABLE_NON_VOLATILE)) {\r | |
779 | return EFI_INVALID_PARAMETER; \r | |
780 | }\r | |
781 | }\r | |
782 | \r | |
783 | //\r | |
784 | // Setting a data variable with no access, or zero DataSize attributes\r | |
785 | // specified causes it to be deleted.\r | |
786 | //\r | |
787 | if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) {\r | |
788 | //\r | |
789 | // Found this variable in storage\r | |
790 | //\r | |
791 | State = Variable.CurrPtr->State;\r | |
792 | State &= VAR_DELETED;\r | |
793 | \r | |
794 | Status = mGlobal->VariableStore[Variable.Type]->Write (\r | |
795 | mGlobal->VariableStore[Variable.Type],\r | |
796 | VARIABLE_MEMBER_OFFSET (State, (UINTN) Variable.CurrPtr - (UINTN) Variable.StartPtr),\r | |
797 | sizeof (Variable.CurrPtr->State),\r | |
798 | &State\r | |
799 | );\r | |
800 | //\r | |
801 | // NOTE: Write operation at least can write data to memory cache\r | |
802 | // Discard file writing failure here.\r | |
803 | //\r | |
804 | return EFI_SUCCESS;\r | |
805 | }\r | |
806 | \r | |
807 | //\r | |
808 | // Found this variable in storage\r | |
809 | // If the variable is marked valid and the same data has been passed in\r | |
810 | // then return to the caller immediately.\r | |
811 | //\r | |
812 | if ((Variable.CurrPtr->DataSize == DataSize) &&\r | |
813 | (CompareMem (Data, GetVariableDataPtr (Variable.CurrPtr), DataSize) == 0)\r | |
814 | ) {\r | |
815 | return EFI_SUCCESS;\r | |
816 | } else if ((Variable.CurrPtr->State == VAR_ADDED) ||\r | |
817 | (Variable.CurrPtr->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION))) {\r | |
818 | //\r | |
819 | // Mark the old variable as in delete transition\r | |
820 | //\r | |
821 | State = Variable.CurrPtr->State;\r | |
822 | State &= VAR_IN_DELETED_TRANSITION;\r | |
823 | \r | |
824 | Status = mGlobal->VariableStore[Variable.Type]->Write (\r | |
825 | mGlobal->VariableStore[Variable.Type],\r | |
826 | VARIABLE_MEMBER_OFFSET (State, (UINTN) Variable.CurrPtr - (UINTN) Variable.StartPtr),\r | |
827 | sizeof (Variable.CurrPtr->State),\r | |
828 | &State\r | |
829 | );\r | |
830 | //\r | |
831 | // NOTE: Write operation at least can write data to memory cache\r | |
832 | // Discard file writing failure here.\r | |
833 | //\r | |
834 | }\r | |
835 | } else if (Status == EFI_NOT_FOUND) {\r | |
836 | //\r | |
837 | // Create a new variable\r | |
838 | // \r | |
839 | \r | |
840 | //\r | |
841 | // Make sure we are trying to create a new variable.\r | |
842 | // Setting a data variable with no access, or zero DataSize attributes means to delete it. \r | |
843 | //\r | |
844 | if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) {\r | |
845 | return EFI_NOT_FOUND;\r | |
846 | } \r | |
847 | //\r | |
848 | // Only variable have NV|RT attribute can be created in Runtime\r | |
849 | //\r | |
850 | if (EfiAtRuntime () &&\r | |
851 | (!(Attributes & EFI_VARIABLE_RUNTIME_ACCESS) || !(Attributes & EFI_VARIABLE_NON_VOLATILE))) {\r | |
852 | return EFI_INVALID_PARAMETER;\r | |
853 | } \r | |
854 | \r | |
855 | } else {\r | |
856 | //\r | |
857 | // Status should be EFI_INVALID_PARAMETER here according to return status of FindVariable().\r | |
858 | //\r | |
859 | return Status;\r | |
860 | } \r | |
861 | \r | |
862 | //\r | |
863 | // Function part - create a new variable and copy the data.\r | |
864 | // Both update a variable and create a variable will come here. \r | |
865 | // We can firstly write all the data in memory, then write them to file\r | |
866 | // This can reduce the times of write operation\r | |
867 | //\r | |
868 | \r | |
869 | NextVariable = (VARIABLE_HEADER *) mGlobal->Scratch;\r | |
870 | \r | |
871 | NextVariable->StartId = VARIABLE_DATA;\r | |
872 | NextVariable->Attributes = Attributes;\r | |
873 | NextVariable->State = VAR_ADDED;\r | |
874 | NextVariable->Reserved = 0;\r | |
875 | VarNameOffset = sizeof (VARIABLE_HEADER);\r | |
876 | VarNameSize = StrSize (VariableName);\r | |
877 | CopyMem (\r | |
878 | (UINT8 *) ((UINTN) NextVariable + VarNameOffset),\r | |
879 | VariableName,\r | |
880 | VarNameSize\r | |
881 | );\r | |
882 | VarDataOffset = VarNameOffset + VarNameSize + GET_PAD_SIZE (VarNameSize);\r | |
883 | CopyMem (\r | |
884 | (UINT8 *) ((UINTN) NextVariable + VarDataOffset),\r | |
885 | Data,\r | |
886 | DataSize\r | |
887 | );\r | |
888 | CopyMem (&NextVariable->VendorGuid, VendorGuid, sizeof (EFI_GUID));\r | |
889 | //\r | |
890 | // There will be pad bytes after Data, the NextVariable->NameSize and\r | |
891 | // NextVariable->DataSize should not include pad size so that variable\r | |
892 | // service can get actual size in GetVariable\r | |
893 | //\r | |
894 | NextVariable->NameSize = (UINT32)VarNameSize;\r | |
895 | NextVariable->DataSize = (UINT32)DataSize;\r | |
896 | \r | |
897 | //\r | |
898 | // The actual size of the variable that stores in storage should\r | |
899 | // include pad size.\r | |
900 | // VarDataOffset: offset from begin of current variable header\r | |
901 | //\r | |
902 | VarSize = VarDataOffset + DataSize + GET_PAD_SIZE (DataSize);\r | |
903 | \r | |
904 | StorageType = (Attributes & EFI_VARIABLE_NON_VOLATILE) ? NonVolatile : Volatile;\r | |
905 | \r | |
906 | if ((UINT32) (VarSize + mGlobal->LastVariableOffset[StorageType]) >\r | |
907 | ((VARIABLE_STORE_HEADER *) mGlobal->VariableBase[StorageType])->Size\r | |
908 | ) {\r | |
909 | if ((StorageType == NonVolatile) && EfiAtRuntime ()) {\r | |
910 | return EFI_OUT_OF_RESOURCES;\r | |
911 | }\r | |
912 | //\r | |
913 | // Perform garbage collection & reclaim operation\r | |
914 | //\r | |
915 | Status = Reclaim (StorageType, Variable.CurrPtr);\r | |
916 | if (EFI_ERROR (Status)) {\r | |
917 | //\r | |
918 | // Reclaim error\r | |
919 | // we cannot restore to original state, fetal error, report to user\r | |
920 | //\r | |
921 | DEBUG ((EFI_D_ERROR, "FSVariable: Recalim error (fetal error) - %r\n", Status));\r | |
922 | return Status;\r | |
923 | }\r | |
924 | //\r | |
925 | // If still no enough space, return out of resources\r | |
926 | //\r | |
927 | if ((UINT32) (VarSize + mGlobal->LastVariableOffset[StorageType]) >\r | |
928 | ((VARIABLE_STORE_HEADER *) mGlobal->VariableBase[StorageType])->Size\r | |
929 | ) {\r | |
930 | return EFI_OUT_OF_RESOURCES;\r | |
931 | }\r | |
932 | \r | |
933 | Reclaimed = TRUE;\r | |
934 | }\r | |
935 | Status = mGlobal->VariableStore[StorageType]->Write (\r | |
936 | mGlobal->VariableStore[StorageType],\r | |
937 | mGlobal->LastVariableOffset[StorageType],\r | |
938 | VarSize,\r | |
939 | NextVariable\r | |
940 | );\r | |
941 | //\r | |
942 | // NOTE: Write operation at least can write data to memory cache\r | |
943 | // Discard file writing failure here.\r | |
944 | //\r | |
945 | mGlobal->LastVariableOffset[StorageType] += VarSize;\r | |
946 | \r | |
947 | //\r | |
948 | // Mark the old variable as deleted\r | |
949 | //\r | |
950 | if (!Reclaimed && !EFI_ERROR (Status) && Variable.CurrPtr != NULL) {\r | |
951 | State = Variable.CurrPtr->State;\r | |
952 | State &= VAR_DELETED;\r | |
953 | \r | |
954 | Status = mGlobal->VariableStore[StorageType]->Write (\r | |
955 | mGlobal->VariableStore[StorageType],\r | |
956 | VARIABLE_MEMBER_OFFSET (State, (UINTN) Variable.CurrPtr - (UINTN) Variable.StartPtr),\r | |
957 | sizeof (Variable.CurrPtr->State),\r | |
958 | &State\r | |
959 | );\r | |
960 | //\r | |
961 | // NOTE: Write operation at least can write data to memory cache\r | |
962 | // Discard file writing failure here.\r | |
963 | //\r | |
964 | }\r | |
965 | \r | |
966 | return EFI_SUCCESS;\r | |
967 | }\r | |
968 | \r | |
9071550e | 969 | EFI_STATUS\r |
970 | EFIAPI\r | |
971 | QueryVariableInfo (\r | |
972 | IN UINT32 Attributes,\r | |
973 | OUT UINT64 *MaximumVariableStorageSize,\r | |
974 | OUT UINT64 *RemainingVariableStorageSize,\r | |
975 | OUT UINT64 *MaximumVariableSize\r | |
976 | )\r | |
977 | /*++\r | |
978 | \r | |
979 | Routine Description:\r | |
980 | \r | |
981 | This code returns information about the EFI variables.\r | |
982 | \r | |
983 | Arguments:\r | |
984 | \r | |
985 | Attributes Attributes bitmask to specify the type of variables\r | |
986 | on which to return information.\r | |
987 | MaximumVariableStorageSize Pointer to the maximum size of the storage space available\r | |
988 | for the EFI variables associated with the attributes specified.\r | |
989 | RemainingVariableStorageSize Pointer to the remaining size of the storage space available\r | |
990 | for the EFI variables associated with the attributes specified.\r | |
991 | MaximumVariableSize Pointer to the maximum size of the individual EFI variables\r | |
992 | associated with the attributes specified.\r | |
993 | \r | |
994 | Returns:\r | |
995 | \r | |
996 | EFI STATUS\r | |
997 | EFI_INVALID_PARAMETER - An invalid combination of attribute bits was supplied.\r | |
998 | EFI_SUCCESS - Query successfully.\r | |
999 | EFI_UNSUPPORTED - The attribute is not supported on this platform.\r | |
1000 | \r | |
1001 | --*/\r | |
1002 | {\r | |
1003 | VARIABLE_HEADER *Variable;\r | |
1004 | VARIABLE_HEADER *NextVariable;\r | |
1005 | UINT64 VariableSize;\r | |
1006 | VARIABLE_STORE_HEADER *VariableStoreHeader;\r | |
1007 | \r | |
1008 | if(MaximumVariableStorageSize == NULL || RemainingVariableStorageSize == NULL || MaximumVariableSize == NULL || Attributes == 0) {\r | |
1009 | return EFI_INVALID_PARAMETER;\r | |
1010 | }\r | |
1011 | \r | |
9071550e | 1012 | if((Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == 0) {\r |
1013 | //\r | |
1014 | // Make sure the Attributes combination is supported by the platform.\r | |
1015 | //\r | |
1016 | return EFI_UNSUPPORTED; \r | |
1017 | } \r | |
9071550e | 1018 | else if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == EFI_VARIABLE_RUNTIME_ACCESS) {\r |
1019 | //\r | |
1020 | // Make sure if runtime bit is set, boot service bit is set also.\r | |
1021 | //\r | |
1022 | return EFI_INVALID_PARAMETER;\r | |
1023 | } else if (EfiAtRuntime () && !(Attributes & EFI_VARIABLE_RUNTIME_ACCESS)) {\r | |
1024 | //\r | |
1025 | // Make sure RT Attribute is set if we are in Runtime phase.\r | |
1026 | //\r | |
1027 | return EFI_INVALID_PARAMETER;\r | |
1028 | } \r | |
1029 | \r | |
1030 | VariableStoreHeader = (VARIABLE_STORE_HEADER *) mGlobal->VariableBase[\r | |
1031 | (Attributes & EFI_VARIABLE_NON_VOLATILE) ? NonVolatile : Volatile\r | |
1032 | ];\r | |
1033 | //\r | |
1034 | // Now let's fill *MaximumVariableStorageSize *RemainingVariableStorageSize\r | |
1035 | // with the storage size (excluding the storage header size).\r | |
1036 | //\r | |
1037 | *MaximumVariableStorageSize = VariableStoreHeader->Size - sizeof (VARIABLE_STORE_HEADER);\r | |
1038 | *RemainingVariableStorageSize = VariableStoreHeader->Size - sizeof (VARIABLE_STORE_HEADER);\r | |
1039 | \r | |
1040 | //\r | |
8e3fdb95 | 1041 | // Let *MaximumVariableSize be FixedPcdGet32(PcdMaxVariableSize) with the exception of the variable header size.\r |
9071550e | 1042 | //\r |
8e3fdb95 | 1043 | *MaximumVariableSize = FixedPcdGet32(PcdMaxVariableSize) - sizeof (VARIABLE_HEADER);\r |
9071550e | 1044 | \r |
9071550e | 1045 | //\r |
1046 | // Harware error record variable needs larger size.\r | |
1047 | //\r | |
1048 | if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r | |
8e3fdb95 | 1049 | *MaximumVariableSize = FixedPcdGet32(PcdMaxHardwareErrorVariableSize) - sizeof (VARIABLE_HEADER);\r |
9071550e | 1050 | }\r |
9071550e | 1051 | \r |
1052 | //\r | |
1053 | // Point to the starting address of the variables.\r | |
1054 | //\r | |
1055 | Variable = (VARIABLE_HEADER *) (VariableStoreHeader + 1);\r | |
1056 | \r | |
1057 | //\r | |
1058 | // Now walk through the related variable store.\r | |
1059 | //\r | |
1060 | while (IsValidVariableHeader (Variable) && (Variable < GetEndPointer (VariableStoreHeader))) {\r | |
1061 | NextVariable = GetNextVariablePtr (Variable);\r | |
1062 | VariableSize = (UINT64) (UINTN) NextVariable - (UINT64) (UINTN) Variable;\r | |
1063 | \r | |
1064 | if (EfiAtRuntime ()) {\r | |
1065 | //\r | |
1066 | // we don't take the state of the variables in mind\r | |
1067 | // when calculating RemainingVariableStorageSize,\r | |
1068 | // since the space occupied by variables not marked with\r | |
1069 | // VAR_ADDED is not allowed to be reclaimed in Runtime.\r | |
1070 | //\r | |
1071 | *RemainingVariableStorageSize -= VariableSize;\r | |
1072 | } else {\r | |
1073 | //\r | |
1074 | // Only care about Variables with State VAR_ADDED,because\r | |
1075 | // the space not marked as VAR_ADDED is reclaimable now.\r | |
1076 | //\r | |
1077 | if ((Variable->State == VAR_ADDED) ||\r | |
1078 | (Variable->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION))) {\r | |
1079 | *RemainingVariableStorageSize -= VariableSize;\r | |
1080 | }\r | |
1081 | }\r | |
1082 | \r | |
1083 | //\r | |
1084 | // Go to the next one\r | |
1085 | //\r | |
1086 | Variable = NextVariable;\r | |
1087 | }\r | |
1088 | \r | |
1089 | if (*RemainingVariableStorageSize < sizeof (VARIABLE_HEADER)) {\r | |
1090 | *MaximumVariableSize = 0;\r | |
1091 | } else if ((*RemainingVariableStorageSize - sizeof (VARIABLE_HEADER)) < *MaximumVariableSize) {\r | |
1092 | *MaximumVariableSize = *RemainingVariableStorageSize - sizeof (VARIABLE_HEADER);\r | |
1093 | }\r | |
1094 | \r | |
1095 | return EFI_SUCCESS;\r | |
1096 | }\r | |
9071550e | 1097 | \r |
1098 | EFI_STATUS\r | |
1099 | EFIAPI\r | |
1100 | VariableServiceInitialize (\r | |
1101 | IN EFI_HANDLE ImageHandle,\r | |
1102 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
1103 | )\r | |
1104 | /*++\r | |
1105 | \r | |
1106 | Routine Description:\r | |
1107 | This function does initialization for variable services\r | |
1108 | \r | |
1109 | Arguments:\r | |
1110 | \r | |
1111 | ImageHandle - The firmware allocated handle for the EFI image.\r | |
1112 | SystemTable - A pointer to the EFI System Table.\r | |
1113 | \r | |
1114 | Returns:\r | |
1115 | \r | |
1116 | Status code.\r | |
1117 | \r | |
1118 | EFI_NOT_FOUND - Variable store area not found.\r | |
1119 | EFI_SUCCESS - Variable services successfully initialized.\r | |
1120 | \r | |
1121 | --*/\r | |
1122 | {\r | |
1123 | EFI_STATUS Status;\r | |
1124 | EFI_HANDLE NewHandle;\r | |
1125 | VS_DEV *Dev;\r | |
eb16e240 | 1126 | EFI_PEI_HOB_POINTERS GuidHob;\r |
9071550e | 1127 | VARIABLE_HEADER *NextVariable;\r |
1128 | VARIABLE_STORE_HEADER *VariableStoreHeader;\r | |
1129 | EFI_FLASH_MAP_FS_ENTRY_DATA *FlashMapEntryData;\r | |
1130 | EFI_FLASH_SUBAREA_ENTRY VariableStoreEntry;\r | |
9071550e | 1131 | UINT64 BaseAddress;\r |
1132 | UINT64 Length;\r | |
1133 | EFI_GCD_MEMORY_SPACE_DESCRIPTOR GcdDescriptor;\r | |
1134 | \r | |
1135 | Status = gBS->AllocatePool (\r | |
1136 | EfiRuntimeServicesData,\r | |
1137 | (UINTN) sizeof (VARIABLE_GLOBAL),\r | |
7c04a679 | 1138 | (VOID**) &mGlobal\r |
9071550e | 1139 | );\r |
1140 | if (EFI_ERROR (Status)) {\r | |
1141 | return Status;\r | |
1142 | }\r | |
1143 | \r | |
eb16e240 | 1144 | GuidHob.Raw = GetHobList ();\r |
1145 | FlashMapEntryData = NULL;\r | |
1146 | while ((GuidHob.Raw = GetNextGuidHob (&gEfiFlashMapHobGuid, GuidHob.Raw)) != NULL) {\r | |
1147 | FlashMapEntryData = (EFI_FLASH_MAP_FS_ENTRY_DATA *) GET_GUID_HOB_DATA (GuidHob.Guid);\r | |
9071550e | 1148 | if (FlashMapEntryData->AreaType == EFI_FLASH_AREA_EFI_VARIABLES) {\r |
1149 | break;\r | |
1150 | }\r | |
eb16e240 | 1151 | GuidHob.Raw = GET_NEXT_HOB (GuidHob); \r |
9071550e | 1152 | }\r |
1153 | \r | |
eb16e240 | 1154 | if (FlashMapEntryData == NULL) {\r |
1155 | DEBUG ((EFI_D_ERROR, "FSVariable: Could not find flash area for variable!\n"));\r | |
9071550e | 1156 | Status = EFI_NOT_FOUND;\r |
1157 | return Status;\r | |
1158 | }\r | |
be768885 | 1159 | \r |
394bbc59 | 1160 | CopyMem(\r |
1161 | (VOID*)&VariableStoreEntry,\r | |
1162 | (VOID*)&FlashMapEntryData->Entries[0],\r | |
1163 | sizeof(EFI_FLASH_SUBAREA_ENTRY)\r | |
1164 | );\r | |
9071550e | 1165 | \r |
1166 | //\r | |
1167 | // Mark the variable storage region of the FLASH as RUNTIME\r | |
1168 | //\r | |
1169 | BaseAddress = VariableStoreEntry.Base & (~EFI_PAGE_MASK);\r | |
1170 | Length = VariableStoreEntry.Length + (VariableStoreEntry.Base - BaseAddress);\r | |
1171 | Length = (Length + EFI_PAGE_SIZE - 1) & (~EFI_PAGE_MASK);\r | |
1172 | Status = gDS->GetMemorySpaceDescriptor (BaseAddress, &GcdDescriptor);\r | |
1173 | if (EFI_ERROR (Status)) {\r | |
1174 | Status = EFI_UNSUPPORTED;\r | |
1175 | return Status;\r | |
1176 | }\r | |
1177 | Status = gDS->SetMemorySpaceAttributes (\r | |
1178 | BaseAddress,\r | |
1179 | Length,\r | |
1180 | GcdDescriptor.Attributes | EFI_MEMORY_RUNTIME\r | |
1181 | );\r | |
1182 | if (EFI_ERROR (Status)) {\r | |
1183 | Status = EFI_UNSUPPORTED;\r | |
1184 | return Status;\r | |
1185 | }\r | |
7c04a679 | 1186 | \r |
9071550e | 1187 | Status = FileStorageConstructor (\r |
1188 | &mGlobal->VariableStore[NonVolatile], \r | |
1189 | &mGlobal->GoVirtualChildEvent[NonVolatile],\r | |
1190 | VariableStoreEntry.Base,\r | |
1191 | (UINT32) VariableStoreEntry.Length,\r | |
1192 | FlashMapEntryData->VolumeId,\r | |
1193 | FlashMapEntryData->FilePath\r | |
1194 | );\r | |
1195 | ASSERT_EFI_ERROR (Status);\r | |
1196 | \r | |
1197 | //\r | |
1198 | // Volatile Storage\r | |
1199 | //\r | |
1200 | Status = MemStorageConstructor (\r | |
1201 | &mGlobal->VariableStore[Volatile],\r | |
1202 | &mGlobal->GoVirtualChildEvent[Volatile],\r | |
1203 | VOLATILE_VARIABLE_STORE_SIZE\r | |
1204 | );\r | |
1205 | ASSERT_EFI_ERROR (Status);\r | |
1206 | \r | |
1207 | //\r | |
1208 | // Scratch\r | |
1209 | //\r | |
1210 | Status = gBS->AllocatePool (\r | |
1211 | EfiRuntimeServicesData,\r | |
1212 | VARIABLE_SCRATCH_SIZE,\r | |
1213 | &mGlobal->Scratch\r | |
1214 | );\r | |
1215 | ASSERT_EFI_ERROR (Status);\r | |
1216 | \r | |
1217 | //\r | |
1218 | // 1. NV Storage\r | |
1219 | //\r | |
1220 | Dev = DEV_FROM_THIS (mGlobal->VariableStore[NonVolatile]);\r | |
1221 | VariableStoreHeader = (VARIABLE_STORE_HEADER *) VAR_DATA_PTR (Dev);\r | |
1222 | if (GetVariableStoreStatus (VariableStoreHeader) == EfiValid) {\r | |
1223 | if (~VariableStoreHeader->Size == 0) {\r | |
1224 | VariableStoreHeader->Size = (UINT32) VariableStoreEntry.Length;\r | |
1225 | }\r | |
1226 | }\r | |
1227 | //\r | |
1228 | // Calculate LastVariableOffset\r | |
1229 | //\r | |
1230 | NextVariable = (VARIABLE_HEADER *) (VariableStoreHeader + 1);\r | |
1231 | while (IsValidVariableHeader (NextVariable)) {\r | |
1232 | NextVariable = GetNextVariablePtr (NextVariable);\r | |
1233 | }\r | |
1234 | mGlobal->LastVariableOffset[NonVolatile] = (UINTN) NextVariable - (UINTN) VariableStoreHeader;\r | |
1235 | mGlobal->VariableBase[NonVolatile] = VariableStoreHeader;\r | |
1236 | \r | |
1237 | //\r | |
1238 | // Reclaim if remaining space is too small\r | |
1239 | //\r | |
1240 | if ((VariableStoreHeader->Size - mGlobal->LastVariableOffset[NonVolatile]) < VARIABLE_RECLAIM_THRESHOLD) {\r | |
1241 | Status = Reclaim (NonVolatile, NULL);\r | |
1242 | if (EFI_ERROR (Status)) {\r | |
1243 | //\r | |
1244 | // Reclaim error\r | |
1245 | // we cannot restore to original state\r | |
1246 | //\r | |
1247 | DEBUG ((EFI_D_ERROR, "FSVariable: Recalim error (fetal error) - %r\n", Status));\r | |
1248 | ASSERT_EFI_ERROR (Status);\r | |
1249 | }\r | |
1250 | }\r | |
1251 | \r | |
1252 | //\r | |
1253 | // 2. Volatile Storage\r | |
1254 | //\r | |
1255 | Dev = DEV_FROM_THIS (mGlobal->VariableStore[Volatile]);\r | |
1256 | VariableStoreHeader = (VARIABLE_STORE_HEADER *) VAR_DATA_PTR (Dev);\r | |
1257 | mGlobal->VariableBase[Volatile] = VAR_DATA_PTR (Dev); \r | |
1258 | mGlobal->LastVariableOffset[Volatile] = sizeof (VARIABLE_STORE_HEADER);\r | |
1259 | //\r | |
1260 | // init store_header & body in memory.\r | |
1261 | //\r | |
1262 | mGlobal->VariableStore[Volatile]->Erase (mGlobal->VariableStore[Volatile]);\r | |
1263 | mGlobal->VariableStore[Volatile]->Write (\r | |
1264 | mGlobal->VariableStore[Volatile],\r | |
1265 | 0,\r | |
1266 | sizeof (VARIABLE_STORE_HEADER),\r | |
1267 | &mStoreHeaderTemplate\r | |
1268 | );\r | |
1269 | \r | |
1270 | \r | |
1271 | SystemTable->RuntimeServices->GetVariable = GetVariable;\r | |
1272 | SystemTable->RuntimeServices->GetNextVariableName = GetNextVariableName;\r | |
1273 | SystemTable->RuntimeServices->SetVariable = SetVariable;\r | |
1274 | \r | |
9071550e | 1275 | SystemTable->RuntimeServices->QueryVariableInfo = QueryVariableInfo;\r |
9071550e | 1276 | \r |
1277 | //\r | |
1278 | // Now install the Variable Runtime Architectural Protocol on a new handle\r | |
1279 | //\r | |
1280 | NewHandle = NULL;\r | |
1281 | Status = gBS->InstallMultipleProtocolInterfaces (\r | |
1282 | &NewHandle,\r | |
1283 | &gEfiVariableArchProtocolGuid,\r | |
1284 | NULL,\r | |
1285 | &gEfiVariableWriteArchProtocolGuid,\r | |
1286 | NULL,\r | |
1287 | NULL\r | |
1288 | );\r | |
1289 | ASSERT_EFI_ERROR (Status);\r | |
1290 | \r | |
1291 | return Status;\r | |
1292 | \r | |
1293 | //Shutdown:\r | |
1294 | // EfiShutdownRuntimeDriverLib ();\r | |
1295 | // return Status;\r | |
1296 | }\r | |
1297 | \r | |
1298 | \r | |
1299 | \r | |
9071550e | 1300 | VOID\r |
1301 | EFIAPI\r | |
e56dd2ce | 1302 | OnVirtualAddressChangeFsv (\r |
9071550e | 1303 | IN EFI_EVENT Event,\r |
1304 | IN VOID *Context\r | |
1305 | )\r | |
1306 | {\r | |
1307 | UINTN Index;\r | |
1308 | \r | |
1309 | for (Index = 0; Index < MaxType; Index++) {\r | |
1310 | mGlobal->GoVirtualChildEvent[Index] (Event, mGlobal->VariableStore[Index]);\r | |
7c04a679 | 1311 | EfiConvertPointer (0, (VOID**) &mGlobal->VariableStore[Index]);\r |
9071550e | 1312 | EfiConvertPointer (0, &mGlobal->VariableBase[Index]);\r |
1313 | }\r | |
1314 | EfiConvertPointer (0, &mGlobal->Scratch);\r | |
7c04a679 | 1315 | EfiConvertPointer (0, (VOID**) &mGlobal);\r |
9071550e | 1316 | }\r |