]> git.proxmox.com Git - mirror_edk2.git/blob - EdkModulePkg/Universal/Variable/RuntimeDxe/Variable.c
projects / mirror_edk2.git / blob
? search:


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