]> git.proxmox.com Git - mirror_edk2.git/blob - DuetPkg/FSVariable/FSVariable.c
DuetPkg, MdeModulePkg: Fix variable services hang with GCC44 X64
[mirror_edk2.git] / DuetPkg / FSVariable / FSVariable.c
1 /*++
2
3 Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
4 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 FSVariable.c
15
16 Abstract:
17
18 Provide support functions for variable services.
19
20 --*/
21
22 #include "FSVariable.h"
23
24 VARIABLE_STORE_HEADER mStoreHeaderTemplate = {
25 VARIABLE_STORE_SIGNATURE,
26 VOLATILE_VARIABLE_STORE_SIZE,
27 VARIABLE_STORE_FORMATTED,
28 VARIABLE_STORE_HEALTHY,
29 0,
30 0
31 };
32
33 //
34 // Don't use module globals after the SetVirtualAddress map is signaled
35 //
36 VARIABLE_GLOBAL *mGlobal;
37
38 /**
39 Update the variable region with Variable information. These are the same
40 arguments as the EFI Variable services.
41
42 @param[in] VariableName Name of variable
43
44 @param[in] VendorGuid Guid of variable
45
46 @param[in] Data Variable data
47
48 @param[in] DataSize Size of data. 0 means delete
49
50 @param[in] Attributes Attribues of the variable
51
52 @param[in] Variable The variable information which is used to keep track of variable usage.
53
54 @retval EFI_SUCCESS The update operation is success.
55
56 @retval EFI_OUT_OF_RESOURCES Variable region is full, can not write other data into this region.
57
58 **/
59 EFI_STATUS
60 EFIAPI
61 UpdateVariable (
62 IN CHAR16 *VariableName,
63 IN EFI_GUID *VendorGuid,
64 IN VOID *Data,
65 IN UINTN DataSize,
66 IN UINT32 Attributes OPTIONAL,
67 IN VARIABLE_POINTER_TRACK *Variable
68 );
69
70 VOID
71 EFIAPI
72 OnVirtualAddressChangeFsv (
73 IN EFI_EVENT Event,
74 IN VOID *Context
75 );
76
77 VOID
78 EFIAPI
79 OnSimpleFileSystemInstall (
80 IN EFI_EVENT Event,
81 IN VOID *Context
82 );
83
84 BOOLEAN
85 IsValidVariableHeader (
86 IN VARIABLE_HEADER *Variable
87 )
88 /*++
89
90 Routine Description:
91
92 This code checks if variable header is valid or not.
93
94 Arguments:
95 Variable Pointer to the Variable Header.
96
97 Returns:
98 TRUE Variable header is valid.
99 FALSE Variable header is not valid.
100
101 --*/
102 {
103 if (Variable == NULL || Variable->StartId != VARIABLE_DATA) {
104 return FALSE;
105 }
106
107 return TRUE;
108 }
109
110 VARIABLE_STORE_STATUS
111 GetVariableStoreStatus (
112 IN VARIABLE_STORE_HEADER *VarStoreHeader
113 )
114 /*++
115
116 Routine Description:
117
118 This code gets the current status of Variable Store.
119
120 Arguments:
121
122 VarStoreHeader Pointer to the Variable Store Header.
123
124 Returns:
125
126 EfiRaw Variable store status is raw
127 EfiValid Variable store status is valid
128 EfiInvalid Variable store status is invalid
129
130 --*/
131 {
132 if (CompareGuid (&VarStoreHeader->Signature, &mStoreHeaderTemplate.Signature) &&
133 (VarStoreHeader->Format == mStoreHeaderTemplate.Format) &&
134 (VarStoreHeader->State == mStoreHeaderTemplate.State)
135 ) {
136 return EfiValid;
137 } else if (((UINT32 *)(&VarStoreHeader->Signature))[0] == VAR_DEFAULT_VALUE_32 &&
138 ((UINT32 *)(&VarStoreHeader->Signature))[1] == VAR_DEFAULT_VALUE_32 &&
139 ((UINT32 *)(&VarStoreHeader->Signature))[2] == VAR_DEFAULT_VALUE_32 &&
140 ((UINT32 *)(&VarStoreHeader->Signature))[3] == VAR_DEFAULT_VALUE_32 &&
141 VarStoreHeader->Size == VAR_DEFAULT_VALUE_32 &&
142 VarStoreHeader->Format == VAR_DEFAULT_VALUE &&
143 VarStoreHeader->State == VAR_DEFAULT_VALUE
144 ) {
145
146 return EfiRaw;
147 } else {
148 return EfiInvalid;
149 }
150 }
151
152 UINT8 *
153 GetVariableDataPtr (
154 IN VARIABLE_HEADER *Variable
155 )
156 /*++
157
158 Routine Description:
159
160 This code gets the pointer to the variable data.
161
162 Arguments:
163
164 Variable Pointer to the Variable Header.
165
166 Returns:
167
168 UINT8* Pointer to Variable Data
169
170 --*/
171 {
172 //
173 // Be careful about pad size for alignment
174 //
175 return (UINT8 *) ((UINTN) GET_VARIABLE_NAME_PTR (Variable) + Variable->NameSize + GET_PAD_SIZE (Variable->NameSize));
176 }
177
178 VARIABLE_HEADER *
179 GetNextVariablePtr (
180 IN VARIABLE_HEADER *Variable
181 )
182 /*++
183
184 Routine Description:
185
186 This code gets the pointer to the next variable header.
187
188 Arguments:
189
190 Variable Pointer to the Variable Header.
191
192 Returns:
193
194 VARIABLE_HEADER* Pointer to next variable header.
195
196 --*/
197 {
198 if (!IsValidVariableHeader (Variable)) {
199 return NULL;
200 }
201 //
202 // Be careful about pad size for alignment
203 //
204 return (VARIABLE_HEADER *) ((UINTN) GetVariableDataPtr (Variable) + Variable->DataSize + GET_PAD_SIZE (Variable->DataSize));
205 }
206
207 VARIABLE_HEADER *
208 GetEndPointer (
209 IN VARIABLE_STORE_HEADER *VarStoreHeader
210 )
211 /*++
212
213 Routine Description:
214
215 This code gets the pointer to the last variable memory pointer byte
216
217 Arguments:
218
219 VarStoreHeader Pointer to the Variable Store Header.
220
221 Returns:
222
223 VARIABLE_HEADER* Pointer to last unavailable Variable Header
224
225 --*/
226 {
227 //
228 // The end of variable store
229 //
230 return (VARIABLE_HEADER *) ((UINTN) VarStoreHeader + VarStoreHeader->Size);
231 }
232
233 BOOLEAN
234 ExistNewerVariable (
235 IN VARIABLE_HEADER *Variable
236 )
237 /*++
238
239 Routine Description:
240
241 Check if exist newer variable when doing reclaim
242
243 Arguments:
244
245 Variable Pointer to start position
246
247 Returns:
248
249 TRUE - Exists another variable, which is newer than the current one
250 FALSE - Doesn't exist another vairable which is newer than the current one
251
252 --*/
253 {
254 VARIABLE_HEADER *NextVariable;
255 CHAR16 *VariableName;
256 EFI_GUID *VendorGuid;
257
258 VendorGuid = &Variable->VendorGuid;
259 VariableName = GET_VARIABLE_NAME_PTR(Variable);
260
261 NextVariable = GetNextVariablePtr (Variable);
262 while (IsValidVariableHeader (NextVariable)) {
263 if ((NextVariable->State == VAR_ADDED) || (NextVariable->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION))) {
264 //
265 // If match Guid and Name
266 //
267 if (CompareGuid (VendorGuid, &NextVariable->VendorGuid)) {
268 if (CompareMem (VariableName, GET_VARIABLE_NAME_PTR (NextVariable), StrSize (VariableName)) == 0) {
269 return TRUE;
270 }
271 }
272 }
273 NextVariable = GetNextVariablePtr (NextVariable);
274 }
275 return FALSE;
276 }
277
278 EFI_STATUS
279 Reclaim (
280 IN VARIABLE_STORAGE_TYPE StorageType,
281 IN VARIABLE_HEADER *CurrentVariable OPTIONAL
282 )
283 /*++
284
285 Routine Description:
286
287 Variable store garbage collection and reclaim operation
288
289 Arguments:
290
291 IsVolatile The variable store is volatile or not,
292 if it is non-volatile, need FTW
293 CurrentVairable If it is not NULL, it means not to process
294 current variable for Reclaim.
295
296 Returns:
297
298 EFI STATUS
299
300 --*/
301 {
302 VARIABLE_HEADER *Variable;
303 VARIABLE_HEADER *NextVariable;
304 VARIABLE_STORE_HEADER *VariableStoreHeader;
305 UINT8 *ValidBuffer;
306 UINTN ValidBufferSize;
307 UINTN VariableSize;
308 UINT8 *CurrPtr;
309 EFI_STATUS Status;
310
311 VariableStoreHeader = (VARIABLE_STORE_HEADER *) mGlobal->VariableBase[StorageType];
312
313 //
314 // Start Pointers for the variable.
315 //
316 Variable = (VARIABLE_HEADER *) (VariableStoreHeader + 1);
317
318 //
319 // recaluate the total size of Common/HwErr type variables in non-volatile area.
320 //
321 if (!StorageType) {
322 mGlobal->CommonVariableTotalSize = 0;
323 mGlobal->HwErrVariableTotalSize = 0;
324 }
325 //
326 // To make the reclaim, here we just allocate a memory that equal to the original memory
327 //
328 ValidBufferSize = sizeof (VARIABLE_STORE_HEADER) + VariableStoreHeader->Size;
329
330 Status = gBS->AllocatePool (
331 EfiBootServicesData,
332 ValidBufferSize,
333 (VOID**) &ValidBuffer
334 );
335 if (EFI_ERROR (Status)) {
336 return Status;
337 }
338
339 CurrPtr = ValidBuffer;
340
341 //
342 // Copy variable store header
343 //
344 CopyMem (CurrPtr, VariableStoreHeader, sizeof (VARIABLE_STORE_HEADER));
345 CurrPtr += sizeof (VARIABLE_STORE_HEADER);
346
347 //
348 // Start Pointers for the variable.
349 //
350 Variable = (VARIABLE_HEADER *) (VariableStoreHeader + 1);
351
352
353 ValidBufferSize = sizeof (VARIABLE_STORE_HEADER);
354 while (IsValidVariableHeader (Variable)) {
355 NextVariable = GetNextVariablePtr (Variable);
356 //
357 // State VAR_ADDED or VAR_IN_DELETED_TRANSITION are to kept,
358 // The CurrentVariable, is also saved, as SetVariable may fail due to lack of space
359 //
360 if (Variable->State == VAR_ADDED) {
361 VariableSize = (UINTN) NextVariable - (UINTN) Variable;
362 CopyMem (CurrPtr, (UINT8 *) Variable, VariableSize);
363 ValidBufferSize += VariableSize;
364 CurrPtr += VariableSize;
365 if ((!StorageType) && ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {
366 mGlobal->HwErrVariableTotalSize += VariableSize;
367 } else if ((!StorageType) && ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {
368 mGlobal->CommonVariableTotalSize += VariableSize;
369 }
370 } else if (Variable->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION)) {
371 //
372 // As variables that with the same guid and name may exist in NV due to power failure during SetVariable,
373 // we will only save the latest valid one
374 //
375 if (!ExistNewerVariable(Variable)) {
376 VariableSize = (UINTN) NextVariable - (UINTN) Variable;
377 CopyMem (CurrPtr, (UINT8 *) Variable, VariableSize);
378 //
379 // If CurrentVariable == Variable, mark as VAR_IN_DELETED_TRANSITION
380 //
381 if (Variable != CurrentVariable){
382 ((VARIABLE_HEADER *)CurrPtr)->State = VAR_ADDED;
383 }
384 CurrPtr += VariableSize;
385 ValidBufferSize += VariableSize;
386 if ((!StorageType) && ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {
387 mGlobal->HwErrVariableTotalSize += VariableSize;
388 } else if ((!StorageType) && ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {
389 mGlobal->CommonVariableTotalSize += VariableSize;
390 }
391 }
392 }
393 Variable = NextVariable;
394 }
395
396 mGlobal->LastVariableOffset[StorageType] = ValidBufferSize;
397
398 //
399 // TODO: cannot restore to original state, basic FTW needed
400 //
401 Status = mGlobal->VariableStore[StorageType]->Erase (
402 mGlobal->VariableStore[StorageType]
403 );
404 Status = mGlobal->VariableStore[StorageType]->Write (
405 mGlobal->VariableStore[StorageType],
406 0,
407 ValidBufferSize,
408 ValidBuffer
409 );
410
411 if (EFI_ERROR (Status)) {
412 //
413 // If error, then reset the last variable offset to zero.
414 //
415 mGlobal->LastVariableOffset[StorageType] = 0;
416 };
417
418 gBS->FreePool (ValidBuffer);
419
420 return Status;
421 }
422
423 EFI_STATUS
424 FindVariable (
425 IN CHAR16 *VariableName,
426 IN EFI_GUID *VendorGuid,
427 OUT VARIABLE_POINTER_TRACK *PtrTrack
428 )
429 /*++
430
431 Routine Description:
432
433 This code finds variable in storage blocks (Volatile or Non-Volatile)
434
435 Arguments:
436
437 VariableName Name of the variable to be found
438 VendorGuid Vendor GUID to be found.
439 PtrTrack Variable Track Pointer structure that contains
440 Variable Information.
441 Contains the pointer of Variable header.
442
443 Returns:
444
445 EFI_INVALID_PARAMETER - Invalid parameter
446 EFI_SUCCESS - Find the specified variable
447 EFI_NOT_FOUND - Not found
448
449 --*/
450 {
451 VARIABLE_HEADER *Variable;
452 VARIABLE_STORE_HEADER *VariableStoreHeader;
453 UINTN Index;
454 VARIABLE_HEADER *InDeleteVariable;
455 UINTN InDeleteIndex;
456 VARIABLE_HEADER *InDeleteStartPtr;
457 VARIABLE_HEADER *InDeleteEndPtr;
458
459 if (VariableName[0] != 0 && VendorGuid == NULL) {
460 return EFI_INVALID_PARAMETER;
461 }
462
463 InDeleteVariable = NULL;
464 InDeleteIndex = (UINTN)-1;
465 InDeleteStartPtr = NULL;
466 InDeleteEndPtr = NULL;
467
468 for (Index = 0; Index < MaxType; Index ++) {
469 //
470 // 0: Non-Volatile, 1: Volatile
471 //
472 VariableStoreHeader = (VARIABLE_STORE_HEADER *) mGlobal->VariableBase[Index];
473
474 //
475 // Start Pointers for the variable.
476 // Actual Data Pointer where data can be written.
477 //
478 Variable = (VARIABLE_HEADER *) (VariableStoreHeader + 1);
479
480 //
481 // Find the variable by walk through non-volatile and volatile variable store
482 //
483 PtrTrack->StartPtr = Variable;
484 PtrTrack->EndPtr = GetEndPointer (VariableStoreHeader);
485
486 while ((Variable < PtrTrack->EndPtr) && IsValidVariableHeader (Variable)) {
487 if (Variable->State == VAR_ADDED) {
488 if (!EfiAtRuntime () || (Variable->Attributes & EFI_VARIABLE_RUNTIME_ACCESS)) {
489 if (VariableName[0] == 0) {
490 PtrTrack->CurrPtr = Variable;
491 PtrTrack->Type = (VARIABLE_STORAGE_TYPE) Index;
492 return EFI_SUCCESS;
493 } else {
494 if (CompareGuid (VendorGuid, &Variable->VendorGuid)) {
495 if (!CompareMem (VariableName, GET_VARIABLE_NAME_PTR (Variable), StrSize (VariableName))) {
496 PtrTrack->CurrPtr = Variable;
497 PtrTrack->Type = (VARIABLE_STORAGE_TYPE) Index;
498 return EFI_SUCCESS;
499 }
500 }
501 }
502 }
503 } else if (Variable->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION)) {
504 //
505 // VAR_IN_DELETED_TRANSITION should also be checked.
506 //
507 if (!EfiAtRuntime () || (Variable->Attributes & EFI_VARIABLE_RUNTIME_ACCESS)) {
508 if (VariableName[0] == 0) {
509 InDeleteVariable = Variable;
510 InDeleteIndex = Index;
511 InDeleteStartPtr = PtrTrack->StartPtr;
512 InDeleteEndPtr = PtrTrack->EndPtr;
513 } else {
514 if (CompareGuid (VendorGuid, &Variable->VendorGuid)) {
515 if (!CompareMem (VariableName, GET_VARIABLE_NAME_PTR (Variable), StrSize (VariableName))) {
516 InDeleteVariable = Variable;
517 InDeleteIndex = Index;
518 InDeleteStartPtr = PtrTrack->StartPtr;
519 InDeleteEndPtr = PtrTrack->EndPtr;
520 }
521 }
522 }
523 }
524 }
525
526 Variable = GetNextVariablePtr (Variable);
527 }
528 //
529 // While (...)
530 //
531 }
532 //
533 // for (...)
534 //
535
536 //
537 // if VAR_IN_DELETED_TRANSITION found, and VAR_ADDED not found,
538 // we return it.
539 //
540 if (InDeleteVariable != NULL) {
541 PtrTrack->CurrPtr = InDeleteVariable;
542 PtrTrack->Type = (VARIABLE_STORAGE_TYPE) InDeleteIndex;
543 PtrTrack->StartPtr = InDeleteStartPtr;
544 PtrTrack->EndPtr = InDeleteEndPtr;
545 return EFI_SUCCESS;
546 }
547
548 PtrTrack->CurrPtr = NULL;
549 return EFI_NOT_FOUND;
550 }
551
552 /**
553 Get index from supported language codes according to language string.
554
555 This code is used to get corresponding index in supported language codes. It can handle
556 RFC4646 and ISO639 language tags.
557 In ISO639 language tags, take 3-characters as a delimitation to find matched string and calculate the index.
558 In RFC4646 language tags, take semicolon as a delimitation to find matched string and calculate the index.
559
560 For example:
561 SupportedLang = "engfraengfra"
562 Lang = "eng"
563 Iso639Language = TRUE
564 The return value is "0".
565 Another example:
566 SupportedLang = "en;fr;en-US;fr-FR"
567 Lang = "fr-FR"
568 Iso639Language = FALSE
569 The return value is "3".
570
571 @param SupportedLang Platform supported language codes.
572 @param Lang Configured language.
573 @param Iso639Language A bool value to signify if the handler is operated on ISO639 or RFC4646.
574
575 @retval the index of language in the language codes.
576
577 **/
578 UINTN
579 GetIndexFromSupportedLangCodes(
580 IN CHAR8 *SupportedLang,
581 IN CHAR8 *Lang,
582 IN BOOLEAN Iso639Language
583 )
584 {
585 UINTN Index;
586 UINTN CompareLength;
587 UINTN LanguageLength;
588
589 if (Iso639Language) {
590 CompareLength = ISO_639_2_ENTRY_SIZE;
591 for (Index = 0; Index < AsciiStrLen (SupportedLang); Index += CompareLength) {
592 if (AsciiStrnCmp (Lang, SupportedLang + Index, CompareLength) == 0) {
593 //
594 // Successfully find the index of Lang string in SupportedLang string.
595 //
596 Index = Index / CompareLength;
597 return Index;
598 }
599 }
600 ASSERT (FALSE);
601 return 0;
602 } else {
603 //
604 // Compare RFC4646 language code
605 //
606 Index = 0;
607 for (LanguageLength = 0; Lang[LanguageLength] != '\0'; LanguageLength++);
608
609 for (Index = 0; *SupportedLang != '\0'; Index++, SupportedLang += CompareLength) {
610 //
611 // Skip ';' characters in SupportedLang
612 //
613 for (; *SupportedLang != '\0' && *SupportedLang == ';'; SupportedLang++);
614 //
615 // Determine the length of the next language code in SupportedLang
616 //
617 for (CompareLength = 0; SupportedLang[CompareLength] != '\0' && SupportedLang[CompareLength] != ';'; CompareLength++);
618
619 if ((CompareLength == LanguageLength) &&
620 (AsciiStrnCmp (Lang, SupportedLang, CompareLength) == 0)) {
621 //
622 // Successfully find the index of Lang string in SupportedLang string.
623 //
624 return Index;
625 }
626 }
627 ASSERT (FALSE);
628 return 0;
629 }
630 }
631
632 /**
633 Get language string from supported language codes according to index.
634
635 This code is used to get corresponding language string in supported language codes. It can handle
636 RFC4646 and ISO639 language tags.
637 In ISO639 language tags, take 3-characters as a delimitation. Find language string according to the index.
638 In RFC4646 language tags, take semicolon as a delimitation. Find language string according to the index.
639
640 For example:
641 SupportedLang = "engfraengfra"
642 Index = "1"
643 Iso639Language = TRUE
644 The return value is "fra".
645 Another example:
646 SupportedLang = "en;fr;en-US;fr-FR"
647 Index = "1"
648 Iso639Language = FALSE
649 The return value is "fr".
650
651 @param SupportedLang Platform supported language codes.
652 @param Index the index in supported language codes.
653 @param Iso639Language A bool value to signify if the handler is operated on ISO639 or RFC4646.
654
655 @retval the language string in the language codes.
656
657 **/
658 CHAR8 *
659 GetLangFromSupportedLangCodes (
660 IN CHAR8 *SupportedLang,
661 IN UINTN Index,
662 IN BOOLEAN Iso639Language
663 )
664 {
665 UINTN SubIndex;
666 UINTN CompareLength;
667 CHAR8 *Supported;
668
669 SubIndex = 0;
670 Supported = SupportedLang;
671 if (Iso639Language) {
672 //
673 // according to the index of Lang string in SupportedLang string to get the language.
674 // As this code will be invoked in RUNTIME, therefore there is not memory allocate/free operation.
675 // In driver entry, it pre-allocates a runtime attribute memory to accommodate this string.
676 //
677 CompareLength = ISO_639_2_ENTRY_SIZE;
678 mGlobal->Lang[CompareLength] = '\0';
679 return CopyMem (mGlobal->Lang, SupportedLang + Index * CompareLength, CompareLength);
680
681 } else {
682 while (TRUE) {
683 //
684 // take semicolon as delimitation, sequentially traverse supported language codes.
685 //
686 for (CompareLength = 0; *Supported != ';' && *Supported != '\0'; CompareLength++) {
687 Supported++;
688 }
689 if ((*Supported == '\0') && (SubIndex != Index)) {
690 //
691 // Have completed the traverse, but not find corrsponding string.
692 // This case is not allowed to happen.
693 //
694 ASSERT(FALSE);
695 return NULL;
696 }
697 if (SubIndex == Index) {
698 //
699 // according to the index of Lang string in SupportedLang string to get the language.
700 // As this code will be invoked in RUNTIME, therefore there is not memory allocate/free operation.
701 // In driver entry, it pre-allocates a runtime attribute memory to accommodate this string.
702 //
703 mGlobal->PlatformLang[CompareLength] = '\0';
704 return CopyMem (mGlobal->PlatformLang, Supported - CompareLength, CompareLength);
705 }
706 SubIndex++;
707
708 //
709 // Skip ';' characters in Supported
710 //
711 for (; *Supported != '\0' && *Supported == ';'; Supported++);
712 }
713 }
714 }
715
716 /**
717 Returns a pointer to an allocated buffer that contains the best matching language
718 from a set of supported languages.
719
720 This function supports both ISO 639-2 and RFC 4646 language codes, but language
721 code types may not be mixed in a single call to this function. This function
722 supports a variable argument list that allows the caller to pass in a prioritized
723 list of language codes to test against all the language codes in SupportedLanguages.
724
725 If SupportedLanguages is NULL, then ASSERT().
726
727 @param[in] SupportedLanguages A pointer to a Null-terminated ASCII string that
728 contains a set of language codes in the format
729 specified by Iso639Language.
730 @param[in] Iso639Language If TRUE, then all language codes are assumed to be
731 in ISO 639-2 format. If FALSE, then all language
732 codes are assumed to be in RFC 4646 language format
733 @param[in] ... A variable argument list that contains pointers to
734 Null-terminated ASCII strings that contain one or more
735 language codes in the format specified by Iso639Language.
736 The first language code from each of these language
737 code lists is used to determine if it is an exact or
738 close match to any of the language codes in
739 SupportedLanguages. Close matches only apply to RFC 4646
740 language codes, and the matching algorithm from RFC 4647
741 is used to determine if a close match is present. If
742 an exact or close match is found, then the matching
743 language code from SupportedLanguages is returned. If
744 no matches are found, then the next variable argument
745 parameter is evaluated. The variable argument list
746 is terminated by a NULL.
747
748 @retval NULL The best matching language could not be found in SupportedLanguages.
749 @retval NULL There are not enough resources available to return the best matching
750 language.
751 @retval Other A pointer to a Null-terminated ASCII string that is the best matching
752 language in SupportedLanguages.
753
754 **/
755 CHAR8 *
756 EFIAPI
757 VariableGetBestLanguage (
758 IN CONST CHAR8 *SupportedLanguages,
759 IN BOOLEAN Iso639Language,
760 ...
761 )
762 {
763 VA_LIST Args;
764 CHAR8 *Language;
765 UINTN CompareLength;
766 UINTN LanguageLength;
767 CONST CHAR8 *Supported;
768 CHAR8 *Buffer;
769
770 ASSERT (SupportedLanguages != NULL);
771
772 VA_START (Args, Iso639Language);
773 while ((Language = VA_ARG (Args, CHAR8 *)) != NULL) {
774 //
775 // Default to ISO 639-2 mode
776 //
777 CompareLength = 3;
778 LanguageLength = MIN (3, AsciiStrLen (Language));
779
780 //
781 // If in RFC 4646 mode, then determine the length of the first RFC 4646 language code in Language
782 //
783 if (!Iso639Language) {
784 for (LanguageLength = 0; Language[LanguageLength] != 0 && Language[LanguageLength] != ';'; LanguageLength++);
785 }
786
787 //
788 // Trim back the length of Language used until it is empty
789 //
790 while (LanguageLength > 0) {
791 //
792 // Loop through all language codes in SupportedLanguages
793 //
794 for (Supported = SupportedLanguages; *Supported != '\0'; Supported += CompareLength) {
795 //
796 // In RFC 4646 mode, then Loop through all language codes in SupportedLanguages
797 //
798 if (!Iso639Language) {
799 //
800 // Skip ';' characters in Supported
801 //
802 for (; *Supported != '\0' && *Supported == ';'; Supported++);
803 //
804 // Determine the length of the next language code in Supported
805 //
806 for (CompareLength = 0; Supported[CompareLength] != 0 && Supported[CompareLength] != ';'; CompareLength++);
807 //
808 // If Language is longer than the Supported, then skip to the next language
809 //
810 if (LanguageLength > CompareLength) {
811 continue;
812 }
813 }
814 //
815 // See if the first LanguageLength characters in Supported match Language
816 //
817 if (AsciiStrnCmp (Supported, Language, LanguageLength) == 0) {
818 VA_END (Args);
819
820 Buffer = Iso639Language ? mGlobal->Lang : mGlobal->PlatformLang;
821 Buffer[CompareLength] = '\0';
822 return CopyMem (Buffer, Supported, CompareLength);
823 }
824 }
825
826 if (Iso639Language) {
827 //
828 // If ISO 639 mode, then each language can only be tested once
829 //
830 LanguageLength = 0;
831 } else {
832 //
833 // If RFC 4646 mode, then trim Language from the right to the next '-' character
834 //
835 for (LanguageLength--; LanguageLength > 0 && Language[LanguageLength] != '-'; LanguageLength--);
836 }
837 }
838 }
839 VA_END (Args);
840
841 //
842 // No matches were found
843 //
844 return NULL;
845 }
846
847 /**
848 Hook the operations in PlatformLangCodes, LangCodes, PlatformLang and Lang.
849
850 When setting Lang/LangCodes, simultaneously update PlatformLang/PlatformLangCodes.
851
852 According to UEFI spec, PlatformLangCodes/LangCodes are only set once in firmware initialization,
853 and are read-only. Therefore, in variable driver, only store the original value for other use.
854
855 @param[in] VariableName Name of variable
856
857 @param[in] Data Variable data
858
859 @param[in] DataSize Size of data. 0 means delete
860
861 **/
862 VOID
863 AutoUpdateLangVariable(
864 IN CHAR16 *VariableName,
865 IN VOID *Data,
866 IN UINTN DataSize
867 )
868 {
869 EFI_STATUS Status;
870 CHAR8 *BestPlatformLang;
871 CHAR8 *BestLang;
872 UINTN Index;
873 UINT32 Attributes;
874 VARIABLE_POINTER_TRACK Variable;
875 BOOLEAN SetLanguageCodes;
876
877 //
878 // Don't do updates for delete operation
879 //
880 if (DataSize == 0) {
881 return;
882 }
883
884 SetLanguageCodes = FALSE;
885
886 if (StrCmp (VariableName, L"PlatformLangCodes") == 0) {
887 //
888 // PlatformLangCodes is a volatile variable, so it can not be updated at runtime.
889 //
890 if (EfiAtRuntime ()) {
891 return;
892 }
893
894 SetLanguageCodes = TRUE;
895
896 //
897 // According to UEFI spec, PlatformLangCodes is only set once in firmware initialization, and is read-only
898 // Therefore, in variable driver, only store the original value for other use.
899 //
900 if (mGlobal->PlatformLangCodes != NULL) {
901 FreePool (mGlobal->PlatformLangCodes);
902 }
903 mGlobal->PlatformLangCodes = AllocateRuntimeCopyPool (DataSize, Data);
904 ASSERT (mGlobal->PlatformLangCodes != NULL);
905
906 //
907 // PlatformLang holds a single language from PlatformLangCodes,
908 // so the size of PlatformLangCodes is enough for the PlatformLang.
909 //
910 if (mGlobal->PlatformLang != NULL) {
911 FreePool (mGlobal->PlatformLang);
912 }
913 mGlobal->PlatformLang = AllocateRuntimePool (DataSize);
914 ASSERT (mGlobal->PlatformLang != NULL);
915
916 } else if (StrCmp (VariableName, L"LangCodes") == 0) {
917 //
918 // LangCodes is a volatile variable, so it can not be updated at runtime.
919 //
920 if (EfiAtRuntime ()) {
921 return;
922 }
923
924 SetLanguageCodes = TRUE;
925
926 //
927 // According to UEFI spec, LangCodes is only set once in firmware initialization, and is read-only
928 // Therefore, in variable driver, only store the original value for other use.
929 //
930 if (mGlobal->LangCodes != NULL) {
931 FreePool (mGlobal->LangCodes);
932 }
933 mGlobal->LangCodes = AllocateRuntimeCopyPool (DataSize, Data);
934 ASSERT (mGlobal->LangCodes != NULL);
935 }
936
937 if (SetLanguageCodes
938 && (mGlobal->PlatformLangCodes != NULL)
939 && (mGlobal->LangCodes != NULL)) {
940 //
941 // Update Lang if PlatformLang is already set
942 // Update PlatformLang if Lang is already set
943 //
944 Status = FindVariable (L"PlatformLang", &gEfiGlobalVariableGuid, &Variable);
945 if (!EFI_ERROR (Status)) {
946 //
947 // Update Lang
948 //
949 VariableName = L"PlatformLang";
950 Data = GetVariableDataPtr (Variable.CurrPtr);
951 DataSize = Variable.CurrPtr->DataSize;
952 } else {
953 Status = FindVariable (L"Lang", &gEfiGlobalVariableGuid, &Variable);
954 if (!EFI_ERROR (Status)) {
955 //
956 // Update PlatformLang
957 //
958 VariableName = L"Lang";
959 Data = GetVariableDataPtr (Variable.CurrPtr);
960 DataSize = Variable.CurrPtr->DataSize;
961 } else {
962 //
963 // Neither PlatformLang nor Lang is set, directly return
964 //
965 return;
966 }
967 }
968 }
969
970 //
971 // According to UEFI spec, "Lang" and "PlatformLang" is NV|BS|RT attributions.
972 //
973 Attributes = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS;
974
975 if (StrCmp (VariableName, L"PlatformLang") == 0) {
976 //
977 // Update Lang when PlatformLangCodes/LangCodes were set.
978 //
979 if ((mGlobal->PlatformLangCodes != NULL) && (mGlobal->LangCodes != NULL)) {
980 //
981 // When setting PlatformLang, firstly get most matched language string from supported language codes.
982 //
983 BestPlatformLang = VariableGetBestLanguage (mGlobal->PlatformLangCodes, FALSE, Data, NULL);
984 if (BestPlatformLang != NULL) {
985 //
986 // Get the corresponding index in language codes.
987 //
988 Index = GetIndexFromSupportedLangCodes (mGlobal->PlatformLangCodes, BestPlatformLang, FALSE);
989
990 //
991 // Get the corresponding ISO639 language tag according to RFC4646 language tag.
992 //
993 BestLang = GetLangFromSupportedLangCodes (mGlobal->LangCodes, Index, TRUE);
994
995 //
996 // Successfully convert PlatformLang to Lang, and set the BestLang value into Lang variable simultaneously.
997 //
998 FindVariable(L"Lang", &gEfiGlobalVariableGuid, &Variable);
999
1000 Status = UpdateVariable (L"Lang", &gEfiGlobalVariableGuid, BestLang, ISO_639_2_ENTRY_SIZE + 1, Attributes, &Variable);
1001
1002 DEBUG ((EFI_D_INFO, "Variable Driver Auto Update PlatformLang, PlatformLang:%a, Lang:%a\n", BestPlatformLang, BestLang));
1003
1004 ASSERT_EFI_ERROR(Status);
1005 }
1006 }
1007
1008 } else if (StrCmp (VariableName, L"Lang") == 0) {
1009 //
1010 // Update PlatformLang when PlatformLangCodes/LangCodes were set.
1011 //
1012 if ((mGlobal->PlatformLangCodes != NULL) && (mGlobal->LangCodes != NULL)) {
1013 //
1014 // When setting Lang, firstly get most matched language string from supported language codes.
1015 //
1016 BestLang = VariableGetBestLanguage (mGlobal->LangCodes, TRUE, Data, NULL);
1017 if (BestLang != NULL) {
1018 //
1019 // Get the corresponding index in language codes.
1020 //
1021 Index = GetIndexFromSupportedLangCodes (mGlobal->LangCodes, BestLang, TRUE);
1022
1023 //
1024 // Get the corresponding RFC4646 language tag according to ISO639 language tag.
1025 //
1026 BestPlatformLang = GetLangFromSupportedLangCodes (mGlobal->PlatformLangCodes, Index, FALSE);
1027
1028 //
1029 // Successfully convert Lang to PlatformLang, and set the BestPlatformLang value into PlatformLang variable simultaneously.
1030 //
1031 FindVariable(L"PlatformLang", &gEfiGlobalVariableGuid, &Variable);
1032
1033 Status = UpdateVariable (L"PlatformLang", &gEfiGlobalVariableGuid, BestPlatformLang,
1034 AsciiStrSize (BestPlatformLang), Attributes, &Variable);
1035
1036 DEBUG ((EFI_D_INFO, "Variable Driver Auto Update Lang, Lang:%a, PlatformLang:%a\n", BestLang, BestPlatformLang));
1037 ASSERT_EFI_ERROR (Status);
1038 }
1039 }
1040 }
1041 }
1042
1043 /**
1044 Update the variable region with Variable information. These are the same
1045 arguments as the EFI Variable services.
1046
1047 @param[in] VariableName Name of variable
1048
1049 @param[in] VendorGuid Guid of variable
1050
1051 @param[in] Data Variable data
1052
1053 @param[in] DataSize Size of data. 0 means delete
1054
1055 @param[in] Attributes Attribues of the variable
1056
1057 @param[in] Variable The variable information which is used to keep track of variable usage.
1058
1059 @retval EFI_SUCCESS The update operation is success.
1060
1061 @retval EFI_OUT_OF_RESOURCES Variable region is full, can not write other data into this region.
1062
1063 **/
1064 EFI_STATUS
1065 EFIAPI
1066 UpdateVariable (
1067 IN CHAR16 *VariableName,
1068 IN EFI_GUID *VendorGuid,
1069 IN VOID *Data,
1070 IN UINTN DataSize,
1071 IN UINT32 Attributes OPTIONAL,
1072 IN VARIABLE_POINTER_TRACK *Variable
1073 )
1074 {
1075 EFI_STATUS Status;
1076 VARIABLE_HEADER *NextVariable;
1077 UINTN VarNameOffset;
1078 UINTN VarDataOffset;
1079 UINTN VarNameSize;
1080 UINTN VarSize;
1081 UINT8 State;
1082 BOOLEAN Reclaimed;
1083 VARIABLE_STORAGE_TYPE StorageType;
1084
1085 Reclaimed = FALSE;
1086
1087 if (Variable->CurrPtr != NULL) {
1088 //
1089 // Update/Delete existing variable
1090 //
1091
1092 if (EfiAtRuntime ()) {
1093 //
1094 // If EfiAtRuntime and the variable is Volatile and Runtime Access,
1095 // the volatile is ReadOnly, and SetVariable should be aborted and
1096 // return EFI_WRITE_PROTECTED.
1097 //
1098 if (Variable->Type == Volatile) {
1099 return EFI_WRITE_PROTECTED;
1100 }
1101 //
1102 // Only variable have NV attribute can be updated/deleted in Runtime
1103 //
1104 if (!(Variable->CurrPtr->Attributes & EFI_VARIABLE_NON_VOLATILE)) {
1105 return EFI_INVALID_PARAMETER;
1106 }
1107 }
1108
1109 //
1110 // Setting a data variable with no access, or zero DataSize attributes
1111 // specified causes it to be deleted.
1112 //
1113 if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) {
1114 //
1115 // Found this variable in storage
1116 //
1117 State = Variable->CurrPtr->State;
1118 State &= VAR_DELETED;
1119
1120 Status = mGlobal->VariableStore[Variable->Type]->Write (
1121 mGlobal->VariableStore[Variable->Type],
1122 VARIABLE_MEMBER_OFFSET (State, (UINTN) Variable->CurrPtr - (UINTN) Variable->StartPtr),
1123 sizeof (Variable->CurrPtr->State),
1124 &State
1125 );
1126 //
1127 // NOTE: Write operation at least can write data to memory cache
1128 // Discard file writing failure here.
1129 //
1130 return EFI_SUCCESS;
1131 }
1132
1133 //
1134 // Found this variable in storage
1135 // If the variable is marked valid and the same data has been passed in
1136 // then return to the caller immediately.
1137 //
1138 if ((Variable->CurrPtr->DataSize == DataSize) &&
1139 (CompareMem (Data, GetVariableDataPtr (Variable->CurrPtr), DataSize) == 0)
1140 ) {
1141 return EFI_SUCCESS;
1142 } else if ((Variable->CurrPtr->State == VAR_ADDED) ||
1143 (Variable->CurrPtr->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION))) {
1144 //
1145 // Mark the old variable as in delete transition
1146 //
1147 State = Variable->CurrPtr->State;
1148 State &= VAR_IN_DELETED_TRANSITION;
1149
1150 Status = mGlobal->VariableStore[Variable->Type]->Write (
1151 mGlobal->VariableStore[Variable->Type],
1152 VARIABLE_MEMBER_OFFSET (State, (UINTN) Variable->CurrPtr - (UINTN) Variable->StartPtr),
1153 sizeof (Variable->CurrPtr->State),
1154 &State
1155 );
1156 //
1157 // NOTE: Write operation at least can write data to memory cache
1158 // Discard file writing failure here.
1159 //
1160 }
1161 } else {
1162 //
1163 // Create a new variable
1164 //
1165
1166 //
1167 // Make sure we are trying to create a new variable.
1168 // Setting a data variable with no access, or zero DataSize attributes means to delete it.
1169 //
1170 if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) {
1171 return EFI_NOT_FOUND;
1172 }
1173 //
1174 // Only variable have NV|RT attribute can be created in Runtime
1175 //
1176 if (EfiAtRuntime () &&
1177 (!(Attributes & EFI_VARIABLE_RUNTIME_ACCESS) || !(Attributes & EFI_VARIABLE_NON_VOLATILE))) {
1178 return EFI_INVALID_PARAMETER;
1179 }
1180
1181 }
1182
1183 //
1184 // Function part - create a new variable and copy the data.
1185 // Both update a variable and create a variable will come here.
1186 // We can firstly write all the data in memory, then write them to file
1187 // This can reduce the times of write operation
1188 //
1189
1190 NextVariable = (VARIABLE_HEADER *) mGlobal->Scratch;
1191
1192 NextVariable->StartId = VARIABLE_DATA;
1193 NextVariable->Attributes = Attributes;
1194 NextVariable->State = VAR_ADDED;
1195 NextVariable->Reserved = 0;
1196 VarNameOffset = sizeof (VARIABLE_HEADER);
1197 VarNameSize = StrSize (VariableName);
1198 CopyMem (
1199 (UINT8 *) ((UINTN) NextVariable + VarNameOffset),
1200 VariableName,
1201 VarNameSize
1202 );
1203 VarDataOffset = VarNameOffset + VarNameSize + GET_PAD_SIZE (VarNameSize);
1204 CopyMem (
1205 (UINT8 *) ((UINTN) NextVariable + VarDataOffset),
1206 Data,
1207 DataSize
1208 );
1209 CopyMem (&NextVariable->VendorGuid, VendorGuid, sizeof (EFI_GUID));
1210 //
1211 // There will be pad bytes after Data, the NextVariable->NameSize and
1212 // NextVariable->DataSize should not include pad size so that variable
1213 // service can get actual size in GetVariable
1214 //
1215 NextVariable->NameSize = (UINT32)VarNameSize;
1216 NextVariable->DataSize = (UINT32)DataSize;
1217
1218 //
1219 // The actual size of the variable that stores in storage should
1220 // include pad size.
1221 // VarDataOffset: offset from begin of current variable header
1222 //
1223 VarSize = VarDataOffset + DataSize + GET_PAD_SIZE (DataSize);
1224
1225 StorageType = (Attributes & EFI_VARIABLE_NON_VOLATILE) ? NonVolatile : Volatile;
1226
1227 if ((UINT32) (VarSize + mGlobal->LastVariableOffset[StorageType]) >
1228 ((VARIABLE_STORE_HEADER *) mGlobal->VariableBase[StorageType])->Size
1229 ) {
1230 if ((StorageType == NonVolatile) && EfiAtRuntime ()) {
1231 return EFI_OUT_OF_RESOURCES;
1232 }
1233 //
1234 // Perform garbage collection & reclaim operation
1235 //
1236 Status = Reclaim (StorageType, Variable->CurrPtr);
1237 if (EFI_ERROR (Status)) {
1238 //
1239 // Reclaim error
1240 // we cannot restore to original state, fetal error, report to user
1241 //
1242 DEBUG ((EFI_D_ERROR, "FSVariable: Recalim error (fetal error) - %r\n", Status));
1243 return Status;
1244 }
1245 //
1246 // If still no enough space, return out of resources
1247 //
1248 if ((UINT32) (VarSize + mGlobal->LastVariableOffset[StorageType]) >
1249 ((VARIABLE_STORE_HEADER *) mGlobal->VariableBase[StorageType])->Size
1250 ) {
1251 return EFI_OUT_OF_RESOURCES;
1252 }
1253
1254 Reclaimed = TRUE;
1255 }
1256 Status = mGlobal->VariableStore[StorageType]->Write (
1257 mGlobal->VariableStore[StorageType],
1258 mGlobal->LastVariableOffset[StorageType],
1259 VarSize,
1260 NextVariable
1261 );
1262 //
1263 // NOTE: Write operation at least can write data to memory cache
1264 // Discard file writing failure here.
1265 //
1266 mGlobal->LastVariableOffset[StorageType] += VarSize;
1267
1268 if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != 0) {
1269 mGlobal->HwErrVariableTotalSize += VarSize;
1270 } else {
1271 mGlobal->CommonVariableTotalSize += VarSize;
1272 }
1273
1274 //
1275 // Mark the old variable as deleted
1276 //
1277 if (!Reclaimed && !EFI_ERROR (Status) && Variable->CurrPtr != NULL) {
1278 State = Variable->CurrPtr->State;
1279 State &= VAR_DELETED;
1280
1281 Status = mGlobal->VariableStore[StorageType]->Write (
1282 mGlobal->VariableStore[StorageType],
1283 VARIABLE_MEMBER_OFFSET (State, (UINTN) Variable->CurrPtr - (UINTN) Variable->StartPtr),
1284 sizeof (Variable->CurrPtr->State),
1285 &State
1286 );
1287 //
1288 // NOTE: Write operation at least can write data to memory cache
1289 // Discard file writing failure here.
1290 //
1291 }
1292 return EFI_SUCCESS;
1293 }
1294
1295 EFI_STATUS
1296 EFIAPI
1297 DuetGetVariable (
1298 IN CHAR16 *VariableName,
1299 IN EFI_GUID *VendorGuid,
1300 OUT UINT32 *Attributes OPTIONAL,
1301 IN OUT UINTN *DataSize,
1302 OUT VOID *Data
1303 )
1304 /*++
1305
1306 Routine Description:
1307
1308 This code finds variable in storage blocks (Volatile or Non-Volatile)
1309
1310 Arguments:
1311
1312 VariableName Name of Variable to be found
1313 VendorGuid Variable vendor GUID
1314 Attributes OPTIONAL Attribute value of the variable found
1315 DataSize Size of Data found. If size is less than the
1316 data, this value contains the required size.
1317 Data Data pointer
1318
1319 Returns:
1320
1321 EFI STATUS
1322
1323 --*/
1324 {
1325 VARIABLE_POINTER_TRACK Variable;
1326 UINTN VarDataSize;
1327 EFI_STATUS Status;
1328
1329 if (VariableName == NULL || VendorGuid == NULL || DataSize == NULL) {
1330 return EFI_INVALID_PARAMETER;
1331 }
1332
1333 //
1334 // Find existing variable
1335 //
1336 Status = FindVariable (VariableName, VendorGuid, &Variable);
1337
1338 if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {
1339 return Status;
1340 }
1341 //
1342 // Get data size
1343 //
1344 VarDataSize = Variable.CurrPtr->DataSize;
1345 if (*DataSize >= VarDataSize) {
1346 if (Data == NULL) {
1347 return EFI_INVALID_PARAMETER;
1348 }
1349 CopyMem (Data, GetVariableDataPtr (Variable.CurrPtr), VarDataSize);
1350
1351 if (Attributes != NULL) {
1352 *Attributes = Variable.CurrPtr->Attributes;
1353 }
1354
1355 *DataSize = VarDataSize;
1356
1357 return EFI_SUCCESS;
1358 } else {
1359 *DataSize = VarDataSize;
1360 return EFI_BUFFER_TOO_SMALL;
1361 }
1362 }
1363
1364 EFI_STATUS
1365 EFIAPI
1366 GetNextVariableName (
1367 IN OUT UINTN *VariableNameSize,
1368 IN OUT CHAR16 *VariableName,
1369 IN OUT EFI_GUID *VendorGuid
1370 )
1371 /*++
1372
1373 Routine Description:
1374
1375 This code Finds the Next available variable
1376
1377 Arguments:
1378
1379 VariableNameSize Size of the variable
1380 VariableName Pointer to variable name
1381 VendorGuid Variable Vendor Guid
1382
1383 Returns:
1384
1385 EFI STATUS
1386
1387 --*/
1388 {
1389 VARIABLE_POINTER_TRACK Variable;
1390 UINTN VarNameSize;
1391 EFI_STATUS Status;
1392
1393 if (VariableNameSize == NULL || VariableName == NULL || VendorGuid == NULL) {
1394 return EFI_INVALID_PARAMETER;
1395 }
1396
1397 Status = FindVariable (VariableName, VendorGuid, &Variable);
1398
1399 if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {
1400 return Status;
1401 }
1402
1403 if (VariableName[0] != 0) {
1404 //
1405 // If variable name is not NULL, get next variable
1406 //
1407 Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);
1408 }
1409
1410 while (TRUE) {
1411 //
1412 // The order we find variable is: 1). NonVolatile; 2). Volatile
1413 // If both volatile and non-volatile variable store are parsed,
1414 // return not found
1415 //
1416 if (Variable.CurrPtr >= Variable.EndPtr || Variable.CurrPtr == NULL) {
1417 if (Variable.Type == Volatile) {
1418 //
1419 // Since we met the end of Volatile storage, we have parsed all the stores.
1420 //
1421 return EFI_NOT_FOUND;
1422 }
1423
1424 //
1425 // End of NonVolatile, continue to parse Volatile
1426 //
1427 Variable.Type = Volatile;
1428 Variable.StartPtr = (VARIABLE_HEADER *) ((VARIABLE_STORE_HEADER *) mGlobal->VariableBase[Volatile] + 1);
1429 Variable.EndPtr = (VARIABLE_HEADER *) GetEndPointer ((VARIABLE_STORE_HEADER *) mGlobal->VariableBase[Volatile]);
1430
1431 Variable.CurrPtr = Variable.StartPtr;
1432 if (!IsValidVariableHeader (Variable.CurrPtr)) {
1433 continue;
1434 }
1435 }
1436 //
1437 // Variable is found
1438 //
1439 if (IsValidVariableHeader (Variable.CurrPtr) &&
1440 ((Variable.CurrPtr->State == VAR_ADDED) ||
1441 (Variable.CurrPtr->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION)))) {
1442 if (!EfiAtRuntime () || (Variable.CurrPtr->Attributes & EFI_VARIABLE_RUNTIME_ACCESS)) {
1443 VarNameSize = Variable.CurrPtr->NameSize;
1444 if (VarNameSize <= *VariableNameSize) {
1445 CopyMem (
1446 VariableName,
1447 GET_VARIABLE_NAME_PTR (Variable.CurrPtr),
1448 VarNameSize
1449 );
1450 CopyMem (
1451 VendorGuid,
1452 &Variable.CurrPtr->VendorGuid,
1453 sizeof (EFI_GUID)
1454 );
1455 Status = EFI_SUCCESS;
1456 } else {
1457 Status = EFI_BUFFER_TOO_SMALL;
1458 }
1459
1460 *VariableNameSize = VarNameSize;
1461 return Status;
1462 }
1463 }
1464
1465 Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);
1466 }
1467 }
1468
1469 EFI_STATUS
1470 EFIAPI
1471 SetVariable (
1472 IN CHAR16 *VariableName,
1473 IN EFI_GUID *VendorGuid,
1474 IN UINT32 Attributes,
1475 IN UINTN DataSize,
1476 IN VOID *Data
1477 )
1478 /*++
1479
1480 Routine Description:
1481
1482 This code sets variable in storage blocks (Volatile or Non-Volatile)
1483
1484 Arguments:
1485
1486 VariableName Name of Variable to be found
1487 VendorGuid Variable vendor GUID
1488 Attributes Attribute value of the variable found
1489 DataSize Size of Data found. If size is less than the
1490 data, this value contains the required size.
1491 Data Data pointer
1492
1493 Returns:
1494
1495 EFI_INVALID_PARAMETER - Invalid parameter
1496 EFI_SUCCESS - Set successfully
1497 EFI_OUT_OF_RESOURCES - Resource not enough to set variable
1498 EFI_NOT_FOUND - Not found
1499 EFI_DEVICE_ERROR - Variable can not be saved due to hardware failure
1500 EFI_WRITE_PROTECTED - Variable is read-only
1501
1502 --*/
1503 {
1504 VARIABLE_POINTER_TRACK Variable;
1505 EFI_STATUS Status;
1506
1507 //
1508 // Check input parameters
1509 //
1510 if (VariableName == NULL || VariableName[0] == 0 || VendorGuid == NULL) {
1511 return EFI_INVALID_PARAMETER;
1512 }
1513
1514 if (DataSize != 0 && Data == NULL) {
1515 return EFI_INVALID_PARAMETER;
1516 }
1517
1518 //
1519 // Not support authenticated variable write yet.
1520 //
1521 if ((Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS) != 0) {
1522 return EFI_INVALID_PARAMETER;
1523 }
1524
1525 //
1526 // Make sure if runtime bit is set, boot service bit is set also
1527 //
1528 if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == EFI_VARIABLE_RUNTIME_ACCESS) {
1529 return EFI_INVALID_PARAMETER;
1530 }
1531
1532 //
1533 // The size of the VariableName, including the Unicode Null in bytes plus
1534 // the DataSize is limited to maximum size of PcdGet32 (PcdMaxHardwareErrorVariableSize)
1535 // bytes for HwErrRec, and PcdGet32 (PcdMaxVariableSize) bytes for the others.
1536 //
1537 if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {
1538 if ((DataSize > PcdGet32(PcdMaxHardwareErrorVariableSize)) ||
1539 (sizeof (VARIABLE_HEADER) + StrSize (VariableName) + DataSize > PcdGet32(PcdMaxHardwareErrorVariableSize))) {
1540 return EFI_INVALID_PARAMETER;
1541 }
1542 //
1543 // According to UEFI spec, HARDWARE_ERROR_RECORD variable name convention should be L"HwErrRecXXXX"
1544 //
1545 if (StrnCmp(VariableName, L"HwErrRec", StrLen(L"HwErrRec")) != 0) {
1546 return EFI_INVALID_PARAMETER;
1547 }
1548 } else {
1549 if ((DataSize > PcdGet32(PcdMaxVariableSize)) ||
1550 (sizeof (VARIABLE_HEADER) + StrSize (VariableName) + DataSize > PcdGet32(PcdMaxVariableSize))) {
1551 return EFI_INVALID_PARAMETER;
1552 }
1553 }
1554
1555 //
1556 // Check whether the input variable is already existed
1557 //
1558 Status = FindVariable (VariableName, VendorGuid, &Variable);
1559
1560 //
1561 // Hook the operation of setting PlatformLangCodes/PlatformLang and LangCodes/Lang
1562 //
1563 AutoUpdateLangVariable (VariableName, Data, DataSize);
1564
1565 Status = UpdateVariable (VariableName, VendorGuid, Data, DataSize, Attributes, &Variable);
1566
1567 return Status;
1568 }
1569
1570 EFI_STATUS
1571 EFIAPI
1572 QueryVariableInfo (
1573 IN UINT32 Attributes,
1574 OUT UINT64 *MaximumVariableStorageSize,
1575 OUT UINT64 *RemainingVariableStorageSize,
1576 OUT UINT64 *MaximumVariableSize
1577 )
1578 /*++
1579
1580 Routine Description:
1581
1582 This code returns information about the EFI variables.
1583
1584 Arguments:
1585
1586 Attributes Attributes bitmask to specify the type of variables
1587 on which to return information.
1588 MaximumVariableStorageSize Pointer to the maximum size of the storage space available
1589 for the EFI variables associated with the attributes specified.
1590 RemainingVariableStorageSize Pointer to the remaining size of the storage space available
1591 for the EFI variables associated with the attributes specified.
1592 MaximumVariableSize Pointer to the maximum size of the individual EFI variables
1593 associated with the attributes specified.
1594
1595 Returns:
1596
1597 EFI STATUS
1598 EFI_INVALID_PARAMETER - An invalid combination of attribute bits was supplied.
1599 EFI_SUCCESS - Query successfully.
1600 EFI_UNSUPPORTED - The attribute is not supported on this platform.
1601
1602 --*/
1603 {
1604 VARIABLE_HEADER *Variable;
1605 VARIABLE_HEADER *NextVariable;
1606 UINT64 VariableSize;
1607 VARIABLE_STORE_HEADER *VariableStoreHeader;
1608 UINT64 CommonVariableTotalSize;
1609 UINT64 HwErrVariableTotalSize;
1610
1611 CommonVariableTotalSize = 0;
1612 HwErrVariableTotalSize = 0;
1613
1614 if(MaximumVariableStorageSize == NULL || RemainingVariableStorageSize == NULL || MaximumVariableSize == NULL || Attributes == 0) {
1615 return EFI_INVALID_PARAMETER;
1616 }
1617
1618 if((Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == 0) {
1619 //
1620 // Make sure the Attributes combination is supported by the platform.
1621 //
1622 return EFI_UNSUPPORTED;
1623 } else if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == EFI_VARIABLE_RUNTIME_ACCESS) {
1624 //
1625 // Make sure if runtime bit is set, boot service bit is set also.
1626 //
1627 return EFI_INVALID_PARAMETER;
1628 } else if (EfiAtRuntime () && !(Attributes & EFI_VARIABLE_RUNTIME_ACCESS)) {
1629 //
1630 // Make sure RT Attribute is set if we are in Runtime phase.
1631 //
1632 return EFI_INVALID_PARAMETER;
1633 } else if ((Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {
1634 //
1635 // Make sure Hw Attribute is set with NV.
1636 //
1637 return EFI_INVALID_PARAMETER;
1638 } else if ((Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS) != 0) {
1639 //
1640 // Not support authentiated variable write yet.
1641 //
1642 return EFI_UNSUPPORTED;
1643 }
1644
1645 VariableStoreHeader = (VARIABLE_STORE_HEADER *) mGlobal->VariableBase[
1646 (Attributes & EFI_VARIABLE_NON_VOLATILE) ? NonVolatile : Volatile
1647 ];
1648 //
1649 // Now let's fill *MaximumVariableStorageSize *RemainingVariableStorageSize
1650 // with the storage size (excluding the storage header size).
1651 //
1652 *MaximumVariableStorageSize = VariableStoreHeader->Size - sizeof (VARIABLE_STORE_HEADER);
1653
1654 //
1655 // Harware error record variable needs larger size.
1656 //
1657 if ((Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {
1658 *MaximumVariableStorageSize = PcdGet32(PcdHwErrStorageSize);
1659 *MaximumVariableSize = PcdGet32(PcdMaxHardwareErrorVariableSize) - sizeof (VARIABLE_HEADER);
1660 } else {
1661 if ((Attributes & EFI_VARIABLE_NON_VOLATILE) != 0) {
1662 ASSERT (PcdGet32(PcdHwErrStorageSize) < VariableStoreHeader->Size);
1663 *MaximumVariableStorageSize = VariableStoreHeader->Size - sizeof (VARIABLE_STORE_HEADER) - PcdGet32(PcdHwErrStorageSize);
1664 }
1665
1666 //
1667 // Let *MaximumVariableSize be PcdGet32(PcdMaxVariableSize) with the exception of the variable header size.
1668 //
1669 *MaximumVariableSize = PcdGet32(PcdMaxVariableSize) - sizeof (VARIABLE_HEADER);
1670 }
1671
1672 //
1673 // Point to the starting address of the variables.
1674 //
1675 Variable = (VARIABLE_HEADER *) (VariableStoreHeader + 1);
1676
1677 //
1678 // Now walk through the related variable store.
1679 //
1680 while ((Variable < GetEndPointer (VariableStoreHeader)) && IsValidVariableHeader (Variable)) {
1681 NextVariable = GetNextVariablePtr (Variable);
1682 VariableSize = (UINT64) (UINTN) NextVariable - (UINT64) (UINTN) Variable;
1683
1684 if (EfiAtRuntime ()) {
1685 //
1686 // we don't take the state of the variables in mind
1687 // when calculating RemainingVariableStorageSize,
1688 // since the space occupied by variables not marked with
1689 // VAR_ADDED is not allowed to be reclaimed in Runtime.
1690 //
1691 if ((NextVariable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {
1692 HwErrVariableTotalSize += VariableSize;
1693 } else {
1694 CommonVariableTotalSize += VariableSize;
1695 }
1696 } else {
1697 //
1698 // Only care about Variables with State VAR_ADDED,because
1699 // the space not marked as VAR_ADDED is reclaimable now.
1700 //
1701 if ((Variable->State == VAR_ADDED) || (Variable->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION))) {
1702 if ((NextVariable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {
1703 HwErrVariableTotalSize += VariableSize;
1704 } else {
1705 CommonVariableTotalSize += VariableSize;
1706 }
1707 }
1708 }
1709
1710 //
1711 // Go to the next one
1712 //
1713 Variable = NextVariable;
1714 }
1715
1716 if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD){
1717 *RemainingVariableStorageSize = *MaximumVariableStorageSize - HwErrVariableTotalSize;
1718 } else {
1719 *RemainingVariableStorageSize = *MaximumVariableStorageSize - CommonVariableTotalSize;
1720 }
1721
1722 return EFI_SUCCESS;
1723 }
1724
1725 EFI_STATUS
1726 EFIAPI
1727 VariableServiceInitialize (
1728 IN EFI_HANDLE ImageHandle,
1729 IN EFI_SYSTEM_TABLE *SystemTable
1730 )
1731 /*++
1732
1733 Routine Description:
1734 This function does initialization for variable services
1735
1736 Arguments:
1737
1738 ImageHandle - The firmware allocated handle for the EFI image.
1739 SystemTable - A pointer to the EFI System Table.
1740
1741 Returns:
1742
1743 Status code.
1744
1745 EFI_NOT_FOUND - Variable store area not found.
1746 EFI_SUCCESS - Variable services successfully initialized.
1747
1748 --*/
1749 {
1750 EFI_STATUS Status;
1751 EFI_HANDLE NewHandle;
1752 VS_DEV *Dev;
1753 EFI_PEI_HOB_POINTERS GuidHob;
1754 VARIABLE_HEADER *Variable;
1755 VARIABLE_HEADER *NextVariable;
1756 VARIABLE_STORE_HEADER *VariableStoreHeader;
1757 EFI_FLASH_MAP_FS_ENTRY_DATA *FlashMapEntryData;
1758 EFI_FLASH_SUBAREA_ENTRY VariableStoreEntry;
1759 UINT64 BaseAddress;
1760 UINT64 Length;
1761 EFI_GCD_MEMORY_SPACE_DESCRIPTOR GcdDescriptor;
1762
1763 Status = gBS->AllocatePool (
1764 EfiRuntimeServicesData,
1765 (UINTN) sizeof (VARIABLE_GLOBAL),
1766 (VOID**) &mGlobal
1767 );
1768 if (EFI_ERROR (Status)) {
1769 return Status;
1770 }
1771
1772 ZeroMem (mGlobal, (UINTN) sizeof (VARIABLE_GLOBAL));
1773
1774 GuidHob.Raw = GetHobList ();
1775 FlashMapEntryData = NULL;
1776 while ((GuidHob.Raw = GetNextGuidHob (&gEfiFlashMapHobGuid, GuidHob.Raw)) != NULL) {
1777 FlashMapEntryData = (EFI_FLASH_MAP_FS_ENTRY_DATA *) GET_GUID_HOB_DATA (GuidHob.Guid);
1778 if (FlashMapEntryData->AreaType == EFI_FLASH_AREA_EFI_VARIABLES) {
1779 break;
1780 }
1781 GuidHob.Raw = GET_NEXT_HOB (GuidHob);
1782 }
1783
1784 if (FlashMapEntryData == NULL) {
1785 DEBUG ((EFI_D_ERROR, "FSVariable: Could not find flash area for variable!\n"));
1786 Status = EFI_NOT_FOUND;
1787 return Status;
1788 }
1789
1790 CopyMem(
1791 (VOID*)&VariableStoreEntry,
1792 (VOID*)&FlashMapEntryData->Entries[0],
1793 sizeof(EFI_FLASH_SUBAREA_ENTRY)
1794 );
1795
1796 //
1797 // Mark the variable storage region of the FLASH as RUNTIME
1798 //
1799 BaseAddress = VariableStoreEntry.Base & (~EFI_PAGE_MASK);
1800 Length = VariableStoreEntry.Length + (VariableStoreEntry.Base - BaseAddress);
1801 Length = (Length + EFI_PAGE_SIZE - 1) & (~EFI_PAGE_MASK);
1802 Status = gDS->GetMemorySpaceDescriptor (BaseAddress, &GcdDescriptor);
1803 if (EFI_ERROR (Status)) {
1804 Status = EFI_UNSUPPORTED;
1805 return Status;
1806 }
1807 Status = gDS->SetMemorySpaceAttributes (
1808 BaseAddress,
1809 Length,
1810 GcdDescriptor.Attributes | EFI_MEMORY_RUNTIME
1811 );
1812 if (EFI_ERROR (Status)) {
1813 Status = EFI_UNSUPPORTED;
1814 return Status;
1815 }
1816
1817 Status = FileStorageConstructor (
1818 &mGlobal->VariableStore[NonVolatile],
1819 &mGlobal->GoVirtualChildEvent[NonVolatile],
1820 VariableStoreEntry.Base,
1821 (UINT32) VariableStoreEntry.Length,
1822 FlashMapEntryData->VolumeId,
1823 FlashMapEntryData->FilePath
1824 );
1825 ASSERT_EFI_ERROR (Status);
1826
1827 //
1828 // Volatile Storage
1829 //
1830 Status = MemStorageConstructor (
1831 &mGlobal->VariableStore[Volatile],
1832 &mGlobal->GoVirtualChildEvent[Volatile],
1833 VOLATILE_VARIABLE_STORE_SIZE
1834 );
1835 ASSERT_EFI_ERROR (Status);
1836
1837 //
1838 // Scratch
1839 //
1840 Status = gBS->AllocatePool (
1841 EfiRuntimeServicesData,
1842 VARIABLE_SCRATCH_SIZE,
1843 &mGlobal->Scratch
1844 );
1845 ASSERT_EFI_ERROR (Status);
1846
1847 //
1848 // 1. NV Storage
1849 //
1850 Dev = DEV_FROM_THIS (mGlobal->VariableStore[NonVolatile]);
1851 VariableStoreHeader = (VARIABLE_STORE_HEADER *) VAR_DATA_PTR (Dev);
1852 if (GetVariableStoreStatus (VariableStoreHeader) == EfiValid) {
1853 if (~VariableStoreHeader->Size == 0) {
1854 VariableStoreHeader->Size = (UINT32) VariableStoreEntry.Length;
1855 }
1856 }
1857 //
1858 // Calculate LastVariableOffset
1859 //
1860 Variable = (VARIABLE_HEADER *) (VariableStoreHeader + 1);
1861 while (IsValidVariableHeader (Variable)) {
1862 UINTN VariableSize = 0;
1863 NextVariable = GetNextVariablePtr (Variable);
1864 VariableSize = NextVariable - Variable;
1865 if ((NextVariable->Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {
1866 mGlobal->HwErrVariableTotalSize += HEADER_ALIGN (VariableSize);
1867 } else {
1868 mGlobal->CommonVariableTotalSize += HEADER_ALIGN (VariableSize);
1869 }
1870 Variable = NextVariable;
1871 }
1872
1873 mGlobal->LastVariableOffset[NonVolatile] = (UINTN) Variable - (UINTN) VariableStoreHeader;
1874 mGlobal->VariableBase[NonVolatile] = VariableStoreHeader;
1875
1876 //
1877 // Reclaim if remaining space is too small
1878 //
1879 if ((VariableStoreHeader->Size - mGlobal->LastVariableOffset[NonVolatile]) < VARIABLE_RECLAIM_THRESHOLD) {
1880 Status = Reclaim (NonVolatile, NULL);
1881 if (EFI_ERROR (Status)) {
1882 //
1883 // Reclaim error
1884 // we cannot restore to original state
1885 //
1886 DEBUG ((EFI_D_ERROR, "FSVariable: Reclaim error (fatal error) - %r\n", Status));
1887 ASSERT_EFI_ERROR (Status);
1888 }
1889 }
1890
1891 //
1892 // 2. Volatile Storage
1893 //
1894 Dev = DEV_FROM_THIS (mGlobal->VariableStore[Volatile]);
1895 VariableStoreHeader = (VARIABLE_STORE_HEADER *) VAR_DATA_PTR (Dev);
1896 mGlobal->VariableBase[Volatile] = VAR_DATA_PTR (Dev);
1897 mGlobal->LastVariableOffset[Volatile] = sizeof (VARIABLE_STORE_HEADER);
1898 //
1899 // init store_header & body in memory.
1900 //
1901 mGlobal->VariableStore[Volatile]->Erase (mGlobal->VariableStore[Volatile]);
1902 mGlobal->VariableStore[Volatile]->Write (
1903 mGlobal->VariableStore[Volatile],
1904 0,
1905 sizeof (VARIABLE_STORE_HEADER),
1906 &mStoreHeaderTemplate
1907 );
1908
1909
1910 SystemTable->RuntimeServices->GetVariable = DuetGetVariable;
1911 SystemTable->RuntimeServices->GetNextVariableName = GetNextVariableName;
1912 SystemTable->RuntimeServices->SetVariable = SetVariable;
1913
1914 SystemTable->RuntimeServices->QueryVariableInfo = QueryVariableInfo;
1915
1916 //
1917 // Now install the Variable Runtime Architectural Protocol on a new handle
1918 //
1919 NewHandle = NULL;
1920 Status = gBS->InstallMultipleProtocolInterfaces (
1921 &NewHandle,
1922 &gEfiVariableArchProtocolGuid,
1923 NULL,
1924 &gEfiVariableWriteArchProtocolGuid,
1925 NULL,
1926 NULL
1927 );
1928 ASSERT_EFI_ERROR (Status);
1929
1930 return Status;
1931 }
1932
1933
1934
1935 VOID
1936 EFIAPI
1937 OnVirtualAddressChangeFsv (
1938 IN EFI_EVENT Event,
1939 IN VOID *Context
1940 )
1941 {
1942 UINTN Index;
1943
1944 for (Index = 0; Index < MaxType; Index++) {
1945 mGlobal->GoVirtualChildEvent[Index] (Event, mGlobal->VariableStore[Index]);
1946 EfiConvertPointer (0, (VOID**) &mGlobal->VariableStore[Index]);
1947 EfiConvertPointer (0, &mGlobal->VariableBase[Index]);
1948 }
1949 EfiConvertPointer (0, (VOID **) &mGlobal->PlatformLangCodes);
1950 EfiConvertPointer (0, (VOID **) &mGlobal->LangCodes);
1951 EfiConvertPointer (0, (VOID **) &mGlobal->PlatformLang);
1952 EfiConvertPointer (0, &mGlobal->Scratch);
1953 EfiConvertPointer (0, (VOID**) &mGlobal);
1954 }