2 Copyright (c) 2006, Intel Corporation
3 All rights reserved. This program and the accompanying materials
4 are licensed and made available under the terms and conditions of the BSD License
5 which accompanies this distribution. The full text of the license may be found at
6 http://opensource.org/licenses/bsd-license.php
8 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
9 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 Entry and initialization module for the browser
24 FUNCTIION_KEY_SETTING gFunctionKeySettingTable
[] = {
44 NONE_FUNCTION_KEY_SETTING
65 NONE_FUNCTION_KEY_SETTING
86 NONE_FUNCTION_KEY_SETTING
89 // BMM File Explorer Formset.
107 NONE_FUNCTION_KEY_SETTING
112 InitializeBinaryStructures (
113 IN EFI_HII_HANDLE
*Handle
,
114 IN BOOLEAN UseDatabase
,
115 IN EFI_IFR_PACKET
*Packet
,
116 IN UINT8
*NvMapOverride
,
117 IN UINTN NumberOfIfrImages
,
118 EFI_FILE_FORM_TAGS
**FileFormTagsHead
122 InitializeTagStructures (
123 IN EFI_IFR_BINARY
*BinaryData
,
124 OUT EFI_FILE_FORM_TAGS
*FileFormTags
129 IN UINTN NumberOfIfrImages
,
130 IN EFI_FILE_FORM_TAGS
*FileFormTagsHead
,
131 IN UINT8
*CallbackData
136 IN EFI_HII_PROTOCOL
*Hii
,
137 IN EFI_HII_HANDLE HiiHandle
,
138 IN EFI_IFR_PACKET
*Packet
,
139 IN EFI_IFR_BINARY
*BinaryData
150 IN EFI_FORM_BROWSER_PROTOCOL
* This
,
151 IN BOOLEAN UseDatabase
,
152 IN EFI_HII_HANDLE
* Handle
,
153 IN UINTN HandleCount
,
154 IN EFI_IFR_PACKET
* Packet
,
155 IN EFI_HANDLE CallbackHandle
,
156 IN UINT8
*NvMapOverride
,
157 IN EFI_SCREEN_DESCRIPTOR
*ScreenDimensions
, OPTIONAL
158 OUT BOOLEAN
*ResetRequired OPTIONAL
164 This is the routine which an external caller uses to direct the browser
165 where to obtain it's information.
169 UseDatabase - If set to TRUE, then all information is retrieved from the HII database handle specified
170 If set to FALSE, then the passed in Packet and CallbackHandle is used and Handle is ignored
172 Handle - A pointer to an array of Handles. If HandleCount > 1 we display a list of the formsets for the handles specified
174 HandleCount - The number of Handles specified in Handle.
176 Packet - Valid only if UseDatabase is FALSE. Packet defines the pages being passed into
177 the browser. This is composed of IFR data as well as String information.
179 CallbackHandle - The handle which contains the calling driver's EFI_FORM_CALLBACK_PROTOCOL interface.
181 ScreenDimenions - This allows the browser to be called so that it occupies a portion of the physical screen instead of
182 dynamically determining the screen dimensions.
184 NvMapOverride - This buffer is used only when there is no NV variable to define the current settings and the caller
185 needs to provide to the browser the current settings for the "fake" NV variable. If used, no saving
186 of an NV variable will be possible. This parameter is also ignored if HandleCount > 1.
192 EFI_FORM_CONFIGURATION_DATA
*FormData
;
193 EFI_FORM_CALLBACK_PROTOCOL
*FormCallback
;
194 EFI_FILE_FORM_TAGS
*FileFormTagsHead
;
195 UI_MENU_OPTION
*Selection
;
196 UI_MENU_OPTION
*AltSelection
;
200 EFI_HII_HANDLE BackupHandle
;
202 ZeroMem (&gScreenDimensions
, sizeof (EFI_SCREEN_DESCRIPTOR
));
204 gPreviousValue
= AllocatePool (0x1000);
205 CallbackData
= AllocatePool (0x10000);
206 ASSERT (gPreviousValue
!= NULL
);
207 ASSERT (CallbackData
!= NULL
);
211 // Seed the dimensions in the global
213 gST
->ConOut
->QueryMode (
215 gST
->ConOut
->Mode
->Mode
,
216 &gScreenDimensions
.RightColumn
,
217 &gScreenDimensions
.BottomRow
220 if (ScreenDimensions
!= NULL
) {
222 // Check local dimension vs. global dimension.
224 if ((gScreenDimensions
.RightColumn
< ScreenDimensions
->RightColumn
) ||
225 (gScreenDimensions
.BottomRow
< ScreenDimensions
->BottomRow
)
227 return EFI_INVALID_PARAMETER
;
230 // Local dimension validation.
232 if ((ScreenDimensions
->RightColumn
> ScreenDimensions
->LeftColumn
) &&
233 (ScreenDimensions
->BottomRow
> ScreenDimensions
->TopRow
) &&
234 ((ScreenDimensions
->RightColumn
- ScreenDimensions
->LeftColumn
) > 2) &&
236 (ScreenDimensions
->BottomRow
- ScreenDimensions
->TopRow
) > STATUS_BAR_HEIGHT
+
237 SCROLL_ARROW_HEIGHT
*
239 FRONT_PAGE_HEADER_HEIGHT
+
244 CopyMem (&gScreenDimensions
, ScreenDimensions
, sizeof (EFI_SCREEN_DESCRIPTOR
));
246 return EFI_INVALID_PARAMETER
;
251 gOptionBlockWidth
= (CHAR16
) ((gScreenDimensions
.RightColumn
- gScreenDimensions
.LeftColumn
) / 3);
252 gHelpBlockWidth
= gOptionBlockWidth
;
253 gPromptBlockWidth
= gOptionBlockWidth
;
256 // Initialize the strings for the browser, upon exit of the browser, the strings will be freed
258 InitializeBrowserStrings ();
260 gFunctionKeySetting
= DEFAULT_FUNCTION_KEY_SETTING
;
261 gClassOfVfr
= EFI_SETUP_APPLICATION_SUBCLASS
;
262 gResetRequired
= FALSE
;
263 gExitRequired
= FALSE
;
264 gSaveRequired
= FALSE
;
265 gNvUpdateRequired
= FALSE
;
269 BackupHandle
= *Handle
;
270 gMenuRefreshHead
= NULL
;
271 ASSERT (CallbackData
);
272 ZeroMem (CallbackData
, 0x10000);
275 // We can recurse through this and might need to re-allocate this particular buffer
277 if (gPreviousValue
== NULL
) {
278 gPreviousValue
= AllocatePool (0x1000);
279 ASSERT (gPreviousValue
!= NULL
);
282 FormData
= EFI_FORM_DATA_FROM_THIS (This
);
286 if (CallbackHandle
!= NULL
) {
288 // Retrieve the Callback protocol interface
290 Status
= gBS
->HandleProtocol (
292 &gEfiFormCallbackProtocolGuid
,
293 (VOID
**) &FormCallback
296 if (EFI_ERROR (Status
)) {
297 gBS
->FreePool (CallbackData
);
304 // Initializes all the internal state structures for all IFR images in system
306 Status
= InitializeBinaryStructures (Handle
, UseDatabase
, Packet
, NvMapOverride
, HandleCount
, &FileFormTagsHead
);
308 if (EFI_ERROR (Status
)) {
309 gBS
->FreePool (CallbackData
);
313 // Beginning of the Presentation of the Data
315 if (UseDatabase
&& (HandleCount
> 1)) {
316 Selection
= DisplayHomePage (HandleCount
, FileFormTagsHead
, CallbackData
);
319 // If passing something specific, we know there is only one Ifr
321 Selection
= AllocateZeroPool (sizeof (UI_MENU_OPTION
));
322 ASSERT (Selection
!= NULL
);
323 Selection
->IfrNumber
= 0;
324 Selection
->Handle
= Handle
[0];
330 if (UseDatabase
&& (HandleCount
> 1)) {
331 if (Selection
== NULL
) {
332 gBS
->FreePool (CallbackData
);
337 // Launch the setup browser with the user's selection information
339 AltSelection
= SetupBrowser (Selection
, Callback
, FileFormTagsHead
, CallbackData
);
342 // If the caller cares about Reset status, we can return to the caller if something happened that required a reset
344 if (ResetRequired
!= NULL
) {
345 *ResetRequired
= gResetRequired
;
348 if (Callback
&& (AltSelection
!= NULL
)) {
349 if ((FormCallback
!= NULL
) && (FormCallback
->Callback
!= NULL
)) {
350 Status
= FormCallback
->Callback (
352 AltSelection
->ThisTag
->Key
,
354 (EFI_HII_CALLBACK_PACKET
**) &Packet
359 *Handle
= BackupHandle
;
361 if (EFI_ERROR (Status
)) {
362 gBS
->FreePool (CallbackData
);
366 if (Callback
&& (AltSelection
== NULL
)) {
367 gBS
->FreePool (CallbackData
);
371 if (UseDatabase
&& (HandleCount
> 1)) {
374 if (gBinaryDataHead
->UnRegisterOnExit
) {
375 Hii
->RemovePack (Hii
, Handle
[0]);
379 ((AltSelection
->ThisTag
->SubClass
== EFI_FRONT_PAGE_SUBCLASS
) ||
380 (AltSelection
->ThisTag
->SubClass
== EFI_SINGLE_USE_SUBCLASS
))) {
382 // If this is the FrontPage, return after every selection
384 gBS
->FreePool (Selection
);
388 // Clean up the allocated data buffers
390 FreeData (FileFormTagsHead
, NULL
, NULL
);
392 gST
->ConOut
->SetAttribute (gST
->ConOut
, EFI_TEXT_ATTR (EFI_LIGHTGRAY
, EFI_BLACK
));
393 gST
->ConOut
->ClearScreen (gST
->ConOut
);
395 gBS
->FreePool (CallbackData
);
399 gBS
->FreePool (Selection
);
403 // Clean up the allocated data buffers
405 FreeData (FileFormTagsHead
, NULL
, NULL
);
407 gST
->ConOut
->ClearScreen (gST
->ConOut
);
410 gBS
->FreePool (CallbackData
);
415 } while (!EFI_ERROR (Status
));
417 gBS
->FreePool (CallbackData
);
424 IN EFI_HANDLE ImageHandle
,
425 IN EFI_SYSTEM_TABLE
*SystemTable
433 (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)
436 EFI_SUCCESS - Setup loaded.
442 EFI_FORM_CONFIGURATION_DATA
*FormData
;
443 EFI_FORM_BROWSER_PROTOCOL
*FormBrowser
;
445 EFI_HII_PACKAGES
*PackageList
;
448 // There will be only one FormConfig in the system
449 // If there is another out there, someone is trying to install us
450 // again. Fail that scenario.
452 Status
= gBS
->LocateProtocol (
453 &gEfiFormBrowserProtocolGuid
,
455 (VOID
**) &FormBrowser
461 // If there was no error, assume there is an installation and fail to load
463 if (!EFI_ERROR (Status
)) {
464 return EFI_DEVICE_ERROR
;
467 FormData
= AllocatePool (sizeof (EFI_FORM_CONFIGURATION_DATA
));
469 if (FormData
== NULL
) {
470 return EFI_OUT_OF_RESOURCES
;
475 FormData
->Signature
= EFI_FORM_DATA_SIGNATURE
;
476 FormData
->FormConfig
.SendForm
= SendForm
;
477 FormData
->FormConfig
.CreatePopUp
= CreateDialog
;
480 // There should only be one HII image
482 Status
= gBS
->LocateProtocol (
483 &gEfiHiiProtocolGuid
,
485 (VOID
**) &FormData
->Hii
488 ASSERT_EFI_ERROR (Status
);
492 PackageList
= PreparePackages (1, &gEfiFormBrowserProtocolGuid
, SetupBrowserStrings
);
494 Status
= Hii
->NewPack (Hii
, PackageList
, &gHiiHandle
);
496 gBS
->FreePool (PackageList
);
499 // Install protocol interface
502 Status
= gBS
->InstallProtocolInterface (
504 &gEfiFormBrowserProtocolGuid
,
505 EFI_NATIVE_INTERFACE
,
506 &FormData
->FormConfig
509 ASSERT_EFI_ERROR (Status
);
511 BannerData
= AllocateZeroPool (sizeof (BANNER_DATA
));
512 ASSERT (BannerData
!= NULL
);
514 Status
= InstallPrint ();
521 IN UINT8
*RawFormSet
,
523 IN EFI_FILE_FORM_TAGS
*FileFormTags
,
524 IN UINT16 CurrentVariable
529 Initialize question tag's members.
532 Tag - Pointer of the current EFI_TAG structure.
533 RawFormSet - Pointer of the formset raw data.
534 Index - Offset of the current opcode in the Ifr raw data.
535 FileFormTags - Pointer of current EFI_FILE_FORM_TAGS structure.
536 CurrentVariable - Current variable number.
542 EFI_VARIABLE_DEFINITION
*VariableDefinition
;
544 Tag
->NumberOfLines
= 1;
545 Tag
->VariableNumber
= CurrentVariable
;
546 CopyMem (&Tag
->Id
, &((EFI_IFR_ONE_OF
*) &RawFormSet
[Index
])->QuestionId
, sizeof (UINT16
));
547 CopyMem (&Tag
->StorageStart
, &((EFI_IFR_ONE_OF
*) &RawFormSet
[Index
])->QuestionId
, sizeof (UINT16
));
548 CopyMem (&Tag
->StorageWidth
, &((EFI_IFR_ONE_OF
*) &RawFormSet
[Index
])->Width
, sizeof (UINT8
));
549 CopyMem (&Tag
->Text
, &((EFI_IFR_ONE_OF
*) &RawFormSet
[Index
])->Prompt
, sizeof (UINT16
));
550 CopyMem (&Tag
->Help
, &((EFI_IFR_ONE_OF
*) &RawFormSet
[Index
])->Help
, sizeof (UINT16
));
552 VariableDefinition
= FileFormTags
->VariableDefinitions
;
554 for (; VariableDefinition
!= NULL
; VariableDefinition
= VariableDefinition
->Next
) {
556 // Have we found the correct variable for the request?
558 if (CurrentVariable
== VariableDefinition
->VariableId
) {
559 if (VariableDefinition
->VariableSize
< (UINTN
) (Tag
->StorageStart
+ Tag
->StorageWidth
)) {
560 VariableDefinition
->VariableFakeSize
= (UINT16
) (VariableDefinition
->VariableFakeSize
+ Tag
->StorageWidth
);
563 if (VariableDefinition
->NvRamMap
!= NULL
) {
565 // If it is an 8bit or 16bit width, then move it to Tag->Value, otherwise
566 // we will never be looking for the data in Tag->Value (e.g. strings, password, etc)
568 if (Tag
->StorageWidth
== (UINT16
) 1) {
569 CopyMem (&Tag
->Value
, &VariableDefinition
->NvRamMap
[Tag
->StorageStart
], sizeof (UINT16
));
572 if (Tag
->StorageWidth
== (UINT16
) 2) {
575 VariableDefinition
->NvRamMap
[Tag
->StorageStart
] +
576 (VariableDefinition
->NvRamMap
[Tag
->StorageStart
+ 1] * 0x100)
578 CopyMem (&Tag
->Value
, &Index
, sizeof (UINT16
));
582 CopyMem (&Tag
->Value
, &Index
, sizeof (UINT16
));
594 IN UINT8
*RawFormSet
,
596 IN UINT16 NumberOfLines
,
597 IN EFI_FILE_FORM_TAGS
*FileFormTags
,
598 IN UINT16 CurrentVariable
603 Initialize numeric tag's members.
606 Tag - Pointer of the current EFI_TAG structure.
607 RawFormSet - Pointer of the formset raw data.
608 Index - Offset of the current opcode in the Ifr raw data.
609 NumberOfLines - Number of lines this opcode occupied.
610 FileFormTags - Pointer of current EFI_FILE_FORM_TAGS structure.
611 CurrentVariable - Current variable number.
617 EFI_VARIABLE_DEFINITION
*VariableDefinition
;
619 Tag
->NumberOfLines
= NumberOfLines
;
620 Tag
->VariableNumber
= CurrentVariable
;
621 CopyMem (&Tag
->Id
, &((EFI_IFR_ONE_OF
*) &RawFormSet
[Index
])->QuestionId
, sizeof (UINT16
));
622 CopyMem (&Tag
->StorageStart
, &((EFI_IFR_ONE_OF
*) &RawFormSet
[Index
])->QuestionId
, sizeof (UINT16
));
623 CopyMem (&Tag
->StorageWidth
, &((EFI_IFR_ONE_OF
*) &RawFormSet
[Index
])->Width
, sizeof (UINT8
));
624 CopyMem (&Tag
->Text
, &((EFI_IFR_ONE_OF
*) &RawFormSet
[Index
])->Prompt
, sizeof (UINT16
));
625 CopyMem (&Tag
->Help
, &((EFI_IFR_ONE_OF
*) &RawFormSet
[Index
])->Help
, sizeof (UINT16
));
626 CopyMem (&Tag
->Minimum
, &((EFI_IFR_NUMERIC
*) &RawFormSet
[Index
])->Minimum
, sizeof (UINT16
));
627 CopyMem (&Tag
->Maximum
, &((EFI_IFR_NUMERIC
*) &RawFormSet
[Index
])->Maximum
, sizeof (UINT16
));
628 CopyMem (&Tag
->Step
, &((EFI_IFR_NUMERIC
*) &RawFormSet
[Index
])->Step
, sizeof (UINT16
));
629 CopyMem (&Tag
->Default
, &((EFI_IFR_NUMERIC
*) &RawFormSet
[Index
])->Default
, sizeof (UINT16
));
630 Tag
->ResetRequired
= (BOOLEAN
) (((EFI_IFR_NUMERIC
*) &RawFormSet
[Index
])->Flags
& EFI_IFR_FLAG_RESET_REQUIRED
);
632 VariableDefinition
= FileFormTags
->VariableDefinitions
;
634 for (; VariableDefinition
!= NULL
; VariableDefinition
= VariableDefinition
->Next
) {
636 // Have we found the correct variable for the request?
638 if (CurrentVariable
== VariableDefinition
->VariableId
) {
639 if (VariableDefinition
->VariableSize
<= (UINTN
) (Tag
->StorageStart
+ Tag
->StorageWidth
)) {
640 if (Tag
->StorageWidth
== 0) {
641 VariableDefinition
->VariableFakeSize
= (UINT16
) (VariableDefinition
->VariableFakeSize
+ 2);
643 VariableDefinition
->VariableFakeSize
= (UINT16
) (VariableDefinition
->VariableFakeSize
+ Tag
->StorageWidth
);
647 if (VariableDefinition
->NvRamMap
!= NULL
) {
649 // If it is an 8bit or 16bit width, then move it to Tag->Value, otherwise
650 // we will never be looking for the data in Tag->Value (e.g. strings, password, etc)
652 if (Tag
->StorageWidth
== (UINT16
) 1) {
653 CopyMem (&Tag
->Value
, &VariableDefinition
->NvRamMap
[Tag
->StorageStart
], sizeof (UINT16
));
656 if (Tag
->StorageWidth
== (UINT16
) 2) {
659 VariableDefinition
->NvRamMap
[Tag
->StorageStart
] +
660 (VariableDefinition
->NvRamMap
[Tag
->StorageStart
+ 1] * 0x100)
662 CopyMem (&Tag
->Value
, &Index
, sizeof (UINT16
));
665 CopyMem (&Tag
->Value
, &Tag
->Default
, sizeof (UINT16
));
676 IN UINT8
*RawFormSet
,
677 IN OUT UINT16
*NumberOfTags
683 // Assume on entry we are pointing to an OpCode - reasonably this should
684 // be a FormOp since the purpose is to count the tags in a particular Form.
686 for (Index
= 0; RawFormSet
[Index
] != EFI_IFR_END_FORM_OP
;) {
688 // If we encounter the end of a form set, bail out
690 if (RawFormSet
[Index
] == EFI_IFR_END_FORM_SET_OP
) {
694 // We treat date/time internally as three op-codes
696 if (RawFormSet
[Index
] == EFI_IFR_DATE_OP
|| RawFormSet
[Index
] == EFI_IFR_TIME_OP
) {
697 *NumberOfTags
= (UINT16
) (*NumberOfTags
+ 3);
700 // Assume that we could have no more tags than op-codes
705 Index
= (UINT16
) (Index
+ RawFormSet
[Index
+ 1]);
708 // Increase the tag count by one so it is inclusive of the end_form_op
714 AddNextInconsistentTag (
715 IN OUT EFI_INCONSISTENCY_DATA
**InconsistentTagsPtr
720 Initialize the next inconsistent tag data and add it to the inconsistent tag list.
723 InconsistentTagsPtr - Pointer of the inconsistent tag's pointer.
730 EFI_INCONSISTENCY_DATA
*PreviousInconsistentTags
;
731 EFI_INCONSISTENCY_DATA
*InconsistentTags
;
733 InconsistentTags
= *InconsistentTagsPtr
;
735 // We just hit the end of an inconsistent expression. Let's allocate the ->Next structure
737 InconsistentTags
->Next
= AllocatePool (sizeof (EFI_INCONSISTENCY_DATA
));
738 ASSERT (InconsistentTags
->Next
!= NULL
);
741 // Preserve current Tag entry
743 PreviousInconsistentTags
= InconsistentTags
;
745 InconsistentTags
= InconsistentTags
->Next
;
748 // This will zero on the entry including the ->Next so I don't have to do it
750 ZeroMem (InconsistentTags
, sizeof (EFI_INCONSISTENCY_DATA
));
753 // Point our Previous field to the previous entry
755 InconsistentTags
->Previous
= PreviousInconsistentTags
;
757 *InconsistentTagsPtr
= InconsistentTags
;
763 InitializeTagStructures (
764 IN EFI_IFR_BINARY
*BinaryData
,
765 OUT EFI_FILE_FORM_TAGS
*FileFormTags
771 UINT16 QuestionIndex
;
775 EFI_FORM_TAGS
*FormTags
;
776 EFI_FORM_TAGS
*SavedFormTags
;
777 EFI_INCONSISTENCY_DATA
*InconsistentTags
;
778 EFI_VARIABLE_DEFINITION
*VariableDefinitions
;
783 UINT16 CurrentVariable
;
784 UINT16 CurrentVariable2
;
787 // Initialize some Index variable and Status
793 CurrentVariable2
= 0;
796 Status
= EFI_SUCCESS
;
797 FormTags
= &FileFormTags
->FormTags
;
798 FormTags
->Next
= NULL
;
799 if (FileFormTags
->InconsistentTags
== NULL
) {
800 InconsistentTags
= NULL
;
802 InconsistentTags
= FileFormTags
->InconsistentTags
;
805 if (FileFormTags
->VariableDefinitions
== NULL
) {
806 VariableDefinitions
= NULL
;
808 VariableDefinitions
= FileFormTags
->VariableDefinitions
;
811 // RawFormSet now points to the beginning of the forms portion of
812 // the specific IFR Binary.
814 RawFormSet
= (UINT8
*) BinaryData
->FormBinary
;
817 // Determine the number of tags for the first form
819 GetTagCount (&RawFormSet
[0], &NumberOfTags
);
821 SavedFormTags
= FormTags
;
823 if (FormTags
->Tags
!= NULL
) {
826 // Advance FormTags to the last entry
828 for (; FormTags
->Next
!= NULL
; FormTags
= FormTags
->Next
)
832 // Walk through each of the tags and free the IntList allocation
834 for (Index
= 0; Index
< NumberOfTags
; Index
++) {
835 if (FormTags
->Tags
[Index
].IntList
!= NULL
) {
836 gBS
->FreePool (FormTags
->Tags
[Index
].IntList
);
840 gBS
->FreePool (FormTags
->Tags
);
841 gBS
->FreePool (FormTags
->Next
);
842 FormTags
->Next
= NULL
;
843 FormTags
->Tags
= NULL
;
845 FormTags
= SavedFormTags
;
847 } while (FormTags
->Next
!= NULL
);
853 // Test for an allocated buffer. If already allocated this is due to having called this routine
854 // once for sizing of the NV storage. We then loaded the NV variable and can correctly initialize
855 // the tag structure with current values from the NV
857 if (FormTags
->Tags
== NULL
) {
859 // Allocate memory for our tags on the first form
861 FormTags
->Tags
= AllocateZeroPool (NumberOfTags
* sizeof (EFI_TAG
));
862 ASSERT (FormTags
->Tags
);
865 // Test for an allocated buffer. If already allocated this is due to having called this routine
866 // once for sizing of the NV storage. We then loaded the NV variable and can correctly initialize
867 // the tag structure with current values from the NV
869 if (InconsistentTags
== NULL
) {
871 // We just hit the end of an inconsistent expression. Let's allocate the ->Next structure
873 InconsistentTags
= AllocateZeroPool (sizeof (EFI_INCONSISTENCY_DATA
));
874 ASSERT (InconsistentTags
!= NULL
);
876 FileFormTags
->InconsistentTags
= InconsistentTags
;
879 ZeroMem (FormTags
->Tags
, NumberOfTags
* sizeof (EFI_TAG
));
881 for (CurrTag
= 0; RawFormSet
[Index
] != EFI_IFR_END_FORM_SET_OP
; CurrTag
++) {
883 // Operand = IFR OpCode
885 FormTags
->Tags
[CurrTag
].Operand
= RawFormSet
[Index
];
888 // Assume for now 0 lines occupied by this OpCode
890 FormTags
->Tags
[CurrTag
].NumberOfLines
= 0;
892 FormTags
->Tags
[CurrTag
].Class
= Class
;
893 FormTags
->Tags
[CurrTag
].SubClass
= SubClass
;
896 // Determine the length of the Tag so we can later skip to the next tag in the form
898 TagLength
= RawFormSet
[Index
+ 1];
902 // Operate on the Found OpCode
904 switch (RawFormSet
[Index
]) {
906 case EFI_IFR_FORM_OP
:
908 // If there was no variable op-code defined, create a dummy entry for one
910 if (FileFormTags
->VariableDefinitions
== NULL
) {
911 FileFormTags
->VariableDefinitions
= AllocateZeroPool (sizeof (EFI_VARIABLE_DEFINITION
));
912 ASSERT (FileFormTags
->VariableDefinitions
!= NULL
);
915 &FormTags
->Tags
[CurrTag
],
916 (VOID
*) &RawFormSet
[Index
],
917 FileFormTags
->VariableDefinitions
920 IfrToFormTag (RawFormSet
[Index
], &FormTags
->Tags
[CurrTag
], (VOID
*) &RawFormSet
[Index
], NULL
);
924 case EFI_IFR_SUBTITLE_OP
:
925 case EFI_IFR_TEXT_OP
:
927 IfrToFormTag (RawFormSet
[Index
], &FormTags
->Tags
[CurrTag
], (VOID
*) &RawFormSet
[Index
], NULL
);
930 case EFI_IFR_VARSTORE_OP
:
931 if (FileFormTags
->VariableDefinitions
== NULL
) {
932 VariableDefinitions
= AllocateZeroPool (sizeof (EFI_VARIABLE_DEFINITION
));
933 ASSERT (VariableDefinitions
!= NULL
);
934 FileFormTags
->VariableDefinitions
= VariableDefinitions
;
939 &FormTags
->Tags
[CurrTag
],
940 (VOID
*) &RawFormSet
[Index
],
941 FileFormTags
->VariableDefinitions
945 case EFI_IFR_VARSTORE_SELECT_OP
:
946 IfrToFormTag (RawFormSet
[Index
], &FormTags
->Tags
[CurrTag
], (VOID
*) &RawFormSet
[Index
], NULL
);
947 CopyMem (&CurrentVariable
, &((EFI_IFR_VARSTORE_SELECT
*) &RawFormSet
[Index
])->VarId
, sizeof (UINT16
));
948 CurrentVariable2
= CurrentVariable
;
951 case EFI_IFR_VARSTORE_SELECT_PAIR_OP
:
952 IfrToFormTag (RawFormSet
[Index
], &FormTags
->Tags
[CurrTag
], (VOID
*) &RawFormSet
[Index
], NULL
);
953 CopyMem(&CurrentVariable
, &((EFI_IFR_VARSTORE_SELECT_PAIR
*)&RawFormSet
[Index
])->VarId
, sizeof (UINT16
));
956 &((EFI_IFR_VARSTORE_SELECT_PAIR
*) &RawFormSet
[Index
])->SecondaryVarId
,
961 case EFI_IFR_END_FORM_OP
:
963 // Test for an allocated buffer. If already allocated this is due to having called this routine
964 // once for sizing of the NV storage. We then loaded the NV variable and can correctly initialize
965 // the tag structure with current values from the NV
967 if (FormTags
->Next
== NULL
) {
969 // We just hit the end of a form. Let's allocate the ->Next structure
971 FormTags
->Next
= AllocatePool (sizeof (EFI_FORM_TAGS
));
972 ASSERT (FormTags
->Next
);
975 FormTags
= FormTags
->Next
;
976 ZeroMem (FormTags
, sizeof (EFI_FORM_TAGS
));
979 // Reset the tag count to one
984 // Reset the CurrTag value (it will be incremented, after this case statement
985 // so set to a negative one so that we get the desired effect.) Fish can beat me later.
990 // Determine the number of tags after this form. If this is the last
991 // form, then we will count the endformset and preserve that information
992 // in the tag structure.
994 GetTagCount (&RawFormSet
[Index
+ TagLength
], &NumberOfTags
);
997 // Allocate memory for our tags
999 FormTags
->Tags
= AllocateZeroPool (NumberOfTags
* sizeof (EFI_TAG
));
1000 ASSERT (FormTags
->Tags
);
1004 // Two types of tags constitute the One Of question: a one-of header and
1005 // several one-of options.
1007 case EFI_IFR_ONE_OF_OP
:
1008 case EFI_IFR_ORDERED_LIST_OP
:
1009 GetQuestionHeader (&FormTags
->Tags
[CurrTag
], RawFormSet
, Index
, FileFormTags
, CurrentVariable
);
1012 // Store away the CurrTag since what follows will be the answer that we
1013 // need to place into the appropriate location in the tag array
1016 // record for setting default later
1018 QuestionIndex
= (UINT16
) CurrTag
;
1021 case EFI_IFR_ONE_OF_OPTION_OP
:
1022 IfrToFormTag (RawFormSet
[Index
], &FormTags
->Tags
[CurrTag
], (VOID
*) &RawFormSet
[Index
], NULL
);
1023 FormTags
->Tags
[QuestionIndex
].Flags
= ((EFI_IFR_ONE_OF_OPTION
*) &RawFormSet
[Index
])->Flags
;
1025 &FormTags
->Tags
[QuestionIndex
].Key
,
1026 &((EFI_IFR_ONE_OF_OPTION
*) &RawFormSet
[Index
])->Key
,
1029 FormTags
->Tags
[QuestionIndex
].ResetRequired
= (BOOLEAN
) (FormTags
->Tags
[QuestionIndex
].Flags
& EFI_IFR_FLAG_RESET_REQUIRED
);
1032 case EFI_IFR_CHECKBOX_OP
:
1033 GetQuestionHeader (&FormTags
->Tags
[CurrTag
], RawFormSet
, Index
, FileFormTags
, CurrentVariable
);
1034 IfrToFormTag (RawFormSet
[Index
], &FormTags
->Tags
[CurrTag
], (VOID
*) &RawFormSet
[Index
], NULL
);
1037 case EFI_IFR_NUMERIC_OP
:
1038 GetNumericHeader (&FormTags
->Tags
[CurrTag
], RawFormSet
, Index
, (UINT16
) 1, FileFormTags
, CurrentVariable
);
1039 IfrToFormTag (RawFormSet
[Index
], &FormTags
->Tags
[CurrTag
], (VOID
*) &RawFormSet
[Index
], NULL
);
1042 case EFI_IFR_DATE_OP
:
1044 // Date elements come in as a Year, Month, Day. We need to process them as a country-based
1045 // Order. It is much easier to do it here than anywhere else.
1047 // For US standards - we want Month/Day/Year, thus we advance "Index" +1, +2, +0 while CurrTag is +0, +1, +2
1050 &FormTags
->Tags
[CurrTag
],
1052 (UINT16
) (Index
+ TagLength
),
1059 // The current language selected + the Date operand
1061 FormTags
->Tags
[CurrTag
+ 1].Operand
= RawFormSet
[Index
];
1063 &FormTags
->Tags
[CurrTag
+ 1],
1065 (UINT16
) (Index
+ TagLength
+ RawFormSet
[Index
+ TagLength
+ 1]),
1072 // The current language selected + the Date operand
1074 FormTags
->Tags
[CurrTag
+ 2].Operand
= RawFormSet
[Index
];
1075 GetNumericHeader (&FormTags
->Tags
[CurrTag
+ 2], RawFormSet
, Index
, (UINT16
) 1, FileFormTags
, CurrentVariable
);
1077 CurrTag
= (INT16
) (CurrTag
+ 2);
1079 Index
= (UINT16
) (Index
+ TagLength
);
1083 TagLength
= RawFormSet
[Index
+ 1];
1084 Index
= (UINT16
) (Index
+ TagLength
);
1088 TagLength
= RawFormSet
[Index
+ 1];
1091 case EFI_IFR_TIME_OP
:
1092 GetNumericHeader (&FormTags
->Tags
[CurrTag
], RawFormSet
, Index
, (UINT16
) 0, FileFormTags
, CurrentVariable
);
1096 // Override the GetQuestionHeader information - date/time are treated very differently
1098 FormTags
->Tags
[CurrTag
].NumberOfLines
= 1;
1102 // The premise is that every date/time op-code have 3 elements, the first 2 have 0 lines
1103 // associated with them, and the third has 1 line to allow to space beyond the choice.
1109 case EFI_IFR_PASSWORD_OP
:
1110 case EFI_IFR_STRING_OP
:
1111 GetQuestionHeader (&FormTags
->Tags
[CurrTag
], RawFormSet
, Index
, FileFormTags
, CurrentVariable
);
1112 IfrToFormTag (RawFormSet
[Index
], &FormTags
->Tags
[CurrTag
], (VOID
*) &RawFormSet
[Index
], NULL
);
1115 case EFI_IFR_SUPPRESS_IF_OP
:
1116 case EFI_IFR_GRAYOUT_IF_OP
:
1117 InconsistentTags
->Operand
= ((EFI_IFR_INCONSISTENT
*) &RawFormSet
[Index
])->Header
.OpCode
;
1121 // Since this op-code doesn't use the next field(s), initialize them with something invalid.
1122 // Unfortunately 0 is a valid offset value for a QuestionId
1124 InconsistentTags
->QuestionId1
= INVALID_OFFSET_VALUE
;
1125 InconsistentTags
->QuestionId2
= INVALID_OFFSET_VALUE
;
1128 // Test for an allocated buffer. If already allocated this is due to having called this routine
1129 // once for sizing of the NV storage. We then loaded the NV variable and can correctly initialize
1130 // the tag structure with current values from the NV
1132 if (InconsistentTags
->Next
== NULL
) {
1133 AddNextInconsistentTag (&InconsistentTags
);
1137 InconsistentTags
= InconsistentTags
->Next
;
1140 case EFI_IFR_FORM_SET_OP
:
1142 &FormTags
->Tags
[CurrTag
].GuidValue
,
1143 &((EFI_IFR_FORM_SET
*) &RawFormSet
[Index
])->Guid
,
1147 &FormTags
->Tags
[CurrTag
].CallbackHandle
,
1148 &((EFI_IFR_FORM_SET
*) &RawFormSet
[Index
])->CallbackHandle
,
1149 sizeof (EFI_PHYSICAL_ADDRESS
)
1151 CopyMem (&FormTags
->Tags
[CurrTag
].Class
, &((EFI_IFR_FORM_SET
*) &RawFormSet
[Index
])->Class
, sizeof (UINT8
));
1153 &FormTags
->Tags
[CurrTag
].SubClass
,
1154 &((EFI_IFR_FORM_SET
*) &RawFormSet
[Index
])->SubClass
,
1158 &FormTags
->Tags
[CurrTag
].NvDataSize
,
1159 &((EFI_IFR_FORM_SET
*) &RawFormSet
[Index
])->NvDataSize
,
1162 Class
= ((EFI_IFR_FORM_SET
*) &RawFormSet
[Index
])->Class
;
1163 SubClass
= ((EFI_IFR_FORM_SET
*) &RawFormSet
[Index
])->SubClass
;
1165 // If the formset has a size value, that means someone must be using this, so create a variable
1166 // We also shall reserve the formid of 0 for this specific purpose.
1168 if ((FileFormTags
->VariableDefinitions
== NULL
) && (FormTags
->Tags
[CurrTag
].NvDataSize
> 0)) {
1169 FileFormTags
->VariableDefinitions
= AllocateZeroPool (sizeof (EFI_VARIABLE_DEFINITION
));
1170 ASSERT (FileFormTags
->VariableDefinitions
!= NULL
);
1173 &FormTags
->Tags
[CurrTag
],
1174 (VOID
*) &RawFormSet
[Index
],
1175 FileFormTags
->VariableDefinitions
1178 IfrToFormTag (RawFormSet
[Index
], &FormTags
->Tags
[CurrTag
], (VOID
*) &RawFormSet
[Index
], NULL
);
1182 case EFI_IFR_BANNER_OP
:
1183 if (gClassOfVfr
== EFI_FRONT_PAGE_SUBCLASS
) {
1185 CopyMem (&TempValue
, &((EFI_IFR_BANNER
*) &RawFormSet
[Index
])->Alignment
, sizeof (UINT8
));
1187 // If this is the special timeout value, we will dynamically figure out where to put it
1188 // Also the least significant byte refers to the TimeOut desired.
1190 if (TempValue
== EFI_IFR_BANNER_TIMEOUT
) {
1191 CopyMem (&FrontPageTimeOutTitle
, &((EFI_IFR_BANNER
*) &RawFormSet
[Index
])->Title
, sizeof (UINT16
));
1192 if (FrontPageTimeOutValue
!= (INT16
) -1) {
1193 CopyMem (&FrontPageTimeOutValue
, &((EFI_IFR_BANNER
*) &RawFormSet
[Index
])->LineNumber
, sizeof (UINT16
));
1199 &BannerData
->Banner
[((EFI_IFR_BANNER
*) &RawFormSet
[Index
])->LineNumber
][
1200 ((EFI_IFR_BANNER
*) &RawFormSet
[Index
])->Alignment
],
1201 &((EFI_IFR_BANNER
*) &RawFormSet
[Index
])->Title
,
1207 case EFI_IFR_INCONSISTENT_IF_OP
:
1209 &FormTags
->Tags
[CurrTag
].Text
,
1210 &((EFI_IFR_INCONSISTENT
*) &RawFormSet
[Index
])->Popup
,
1215 InconsistentTags
->Operand
= ((EFI_IFR_INCONSISTENT
*) &RawFormSet
[Index
])->Header
.OpCode
;
1216 CopyMem (&InconsistentTags
->Popup
, &((EFI_IFR_INCONSISTENT
*) &RawFormSet
[Index
])->Popup
, sizeof (UINT16
));
1219 // Since this op-code doesn't use the next field(s), initialize them with something invalid.
1220 // Unfortunately 0 is a valid offset value for a QuestionId
1222 InconsistentTags
->QuestionId1
= INVALID_OFFSET_VALUE
;
1223 InconsistentTags
->QuestionId2
= INVALID_OFFSET_VALUE
;
1225 InconsistentTags
->VariableNumber
= CurrentVariable
;
1228 // Test for an allocated buffer. If already allocated this is due to having called this routine
1229 // once for sizing of the NV storage. We then loaded the NV variable and can correctly initialize
1230 // the tag structure with current values from the NV
1232 if (InconsistentTags
->Next
== NULL
) {
1233 AddNextInconsistentTag (&InconsistentTags
);
1237 InconsistentTags
= InconsistentTags
->Next
;
1240 case EFI_IFR_EQ_ID_VAL_OP
:
1241 IfrToFormTag (RawFormSet
[Index
], &FormTags
->Tags
[CurrTag
], (VOID
*) &RawFormSet
[Index
], NULL
);
1243 InconsistentTags
->Operand
= ((EFI_IFR_EQ_ID_VAL
*) &RawFormSet
[Index
])->Header
.OpCode
;
1244 CopyMem (&InconsistentTags
->Value
, &((EFI_IFR_EQ_ID_VAL
*) &RawFormSet
[Index
])->Value
, sizeof (UINT16
));
1246 &InconsistentTags
->QuestionId1
,
1247 &((EFI_IFR_EQ_ID_VAL
*) &RawFormSet
[Index
])->QuestionId
,
1252 // Since this op-code doesn't use the next field(s), initialize them with something invalid.
1253 // Unfortunately 0 is a valid offset value for a QuestionId
1255 InconsistentTags
->Width
= FormTags
->Tags
[CurrTag
].StorageWidth
;
1256 InconsistentTags
->QuestionId2
= INVALID_OFFSET_VALUE
;
1257 InconsistentTags
->ConsistencyId
= gConsistencyId
;
1258 FormTags
->Tags
[CurrTag
].ConsistencyId
= gConsistencyId
;
1260 InconsistentTags
->VariableNumber
= CurrentVariable
;
1263 // Test for an allocated buffer. If already allocated this is due to having called this routine
1264 // once for sizing of the NV storage. We then loaded the NV variable and can correctly initialize
1265 // the tag structure with current values from the NV
1267 if (InconsistentTags
->Next
== NULL
) {
1268 AddNextInconsistentTag (&InconsistentTags
);
1272 InconsistentTags
= InconsistentTags
->Next
;
1275 case EFI_IFR_EQ_VAR_VAL_OP
:
1276 IfrToFormTag (RawFormSet
[Index
], &FormTags
->Tags
[CurrTag
], (VOID
*) &RawFormSet
[Index
], NULL
);
1278 InconsistentTags
->Operand
= ((EFI_IFR_EQ_VAR_VAL
*) &RawFormSet
[Index
])->Header
.OpCode
;
1279 CopyMem (&InconsistentTags
->Value
, &((EFI_IFR_EQ_VAR_VAL
*) &RawFormSet
[Index
])->Value
, sizeof (UINT16
));
1281 &InconsistentTags
->QuestionId1
,
1282 &((EFI_IFR_EQ_VAR_VAL
*) &RawFormSet
[Index
])->VariableId
,
1287 // Since this op-code doesn't use the next field(s), initialize them with something invalid.
1288 // Unfortunately 0 is a valid offset value for a QuestionId
1290 InconsistentTags
->QuestionId2
= INVALID_OFFSET_VALUE
;
1291 InconsistentTags
->ConsistencyId
= gConsistencyId
;
1292 FormTags
->Tags
[CurrTag
].ConsistencyId
= gConsistencyId
;
1294 InconsistentTags
->VariableNumber
= CurrentVariable
;
1297 // Test for an allocated buffer. If already allocated this is due to having called this routine
1298 // once for sizing of the NV storage. We then loaded the NV variable and can correctly initialize
1299 // the tag structure with current values from the NV
1301 if (InconsistentTags
->Next
== NULL
) {
1302 AddNextInconsistentTag (&InconsistentTags
);
1306 InconsistentTags
= InconsistentTags
->Next
;
1309 case EFI_IFR_EQ_ID_ID_OP
:
1310 IfrToFormTag (RawFormSet
[Index
], &FormTags
->Tags
[CurrTag
], (VOID
*) &RawFormSet
[Index
], NULL
);
1312 InconsistentTags
->Operand
= ((EFI_IFR_EQ_ID_ID
*) &RawFormSet
[Index
])->Header
.OpCode
;
1314 &InconsistentTags
->QuestionId1
,
1315 &((EFI_IFR_EQ_ID_ID
*) &RawFormSet
[Index
])->QuestionId1
,
1319 &InconsistentTags
->QuestionId2
,
1320 &((EFI_IFR_EQ_ID_ID
*) &RawFormSet
[Index
])->QuestionId2
,
1324 InconsistentTags
->Width
= FormTags
->Tags
[CurrTag
].StorageWidth
;
1325 InconsistentTags
->ConsistencyId
= gConsistencyId
;
1326 FormTags
->Tags
[CurrTag
].ConsistencyId
= gConsistencyId
;
1328 InconsistentTags
->VariableNumber
= CurrentVariable
;
1329 InconsistentTags
->VariableNumber2
= CurrentVariable2
;
1332 // Test for an allocated buffer. If already allocated this is due to having called this routine
1333 // once for sizing of the NV storage. We then loaded the NV variable and can correctly initialize
1334 // the tag structure with current values from the NV
1336 if (InconsistentTags
->Next
== NULL
) {
1337 AddNextInconsistentTag (&InconsistentTags
);
1341 InconsistentTags
= InconsistentTags
->Next
;
1344 case EFI_IFR_AND_OP
:
1346 case EFI_IFR_NOT_OP
:
1349 case EFI_IFR_TRUE_OP
:
1350 case EFI_IFR_FALSE_OP
:
1351 InconsistentTags
->Operand
= ((EFI_IFR_NOT
*) &RawFormSet
[Index
])->Header
.OpCode
;
1354 // Since this op-code doesn't use the next field(s), initialize them with something invalid.
1355 // Unfortunately 0 is a valid offset value for a QuestionId
1359 // Reserve INVALID_OFFSET_VALUE - 1 for TRUE or FALSE because they are inconsistency tags also, but
1360 // have no coresponding id. The examination of id is needed by evaluating boolean expression.
1362 if (RawFormSet
[Index
] == EFI_IFR_TRUE_OP
||
1363 RawFormSet
[Index
] == EFI_IFR_FALSE_OP
) {
1364 InconsistentTags
->QuestionId1
= INVALID_OFFSET_VALUE
- 1;
1366 InconsistentTags
->QuestionId1
= INVALID_OFFSET_VALUE
;
1368 InconsistentTags
->QuestionId2
= INVALID_OFFSET_VALUE
;
1369 InconsistentTags
->ConsistencyId
= gConsistencyId
;
1370 FormTags
->Tags
[CurrTag
].ConsistencyId
= gConsistencyId
;
1373 // Test for an allocated buffer. If already allocated this is due to having called this routine
1374 // once for sizing of the NV storage. We then loaded the NV variable and can correctly initialize
1375 // the tag structure with current values from the NV
1377 if (InconsistentTags
->Next
== NULL
) {
1378 AddNextInconsistentTag (&InconsistentTags
);
1382 InconsistentTags
= InconsistentTags
->Next
;
1385 case EFI_IFR_EQ_ID_LIST_OP
:
1386 IfrToFormTag (RawFormSet
[Index
], &FormTags
->Tags
[CurrTag
], (VOID
*) &RawFormSet
[Index
], NULL
);
1388 InconsistentTags
->Operand
= ((EFI_IFR_EQ_ID_LIST
*) &RawFormSet
[Index
])->Header
.OpCode
;
1390 &InconsistentTags
->QuestionId1
,
1391 &((EFI_IFR_EQ_ID_LIST
*) &RawFormSet
[Index
])->QuestionId
,
1395 &InconsistentTags
->ListLength
,
1396 &((EFI_IFR_EQ_ID_LIST
*) &RawFormSet
[Index
])->ListLength
,
1399 InconsistentTags
->ValueList
= FormTags
->Tags
[CurrTag
].IntList
;
1402 // Since this op-code doesn't use the next field(s), initialize them with something invalid.
1403 // Unfortunately 0 is a valid offset value for a QuestionId
1405 InconsistentTags
->Width
= FormTags
->Tags
[CurrTag
].StorageWidth
;
1406 InconsistentTags
->QuestionId2
= INVALID_OFFSET_VALUE
;
1407 InconsistentTags
->ConsistencyId
= gConsistencyId
;
1408 FormTags
->Tags
[CurrTag
].ConsistencyId
= gConsistencyId
;
1411 // Test for an allocated buffer. If already allocated this is due to having called this routine
1412 // once for sizing of the NV storage. We then loaded the NV variable and can correctly initialize
1413 // the tag structure with current values from the NV
1415 if (InconsistentTags
->Next
== NULL
) {
1416 AddNextInconsistentTag (&InconsistentTags
);
1420 InconsistentTags
= InconsistentTags
->Next
;
1423 case EFI_IFR_END_IF_OP
:
1424 InconsistentTags
->Operand
= ((EFI_IFR_END_EXPR
*) &RawFormSet
[Index
])->Header
.OpCode
;
1427 // Since this op-code doesn't use the next field(s), initialize them with something invalid.
1428 // Unfortunately 0 is a valid offset value for a QuestionId
1430 InconsistentTags
->QuestionId1
= INVALID_OFFSET_VALUE
;
1431 InconsistentTags
->QuestionId2
= INVALID_OFFSET_VALUE
;
1434 // Test for an allocated buffer. If already allocated this is due to having called this routine
1435 // once for sizing of the NV storage. We then loaded the NV variable and can correctly initialize
1436 // the tag structure with current values from the NV
1438 if (InconsistentTags
->Next
== NULL
) {
1439 AddNextInconsistentTag (&InconsistentTags
);
1443 InconsistentTags
= InconsistentTags
->Next
;
1446 case EFI_IFR_END_ONE_OF_OP
:
1455 // Per spec., we ignore ops that we don't know how to deal with. Skip to next tag
1457 Index
= (UINT16
) (Index
+ TagLength
);
1462 // When we eventually exit, make sure we mark the last tag with an op-code
1464 FormTags
->Tags
[CurrTag
].Operand
= RawFormSet
[Index
];
1466 IfrToFormTag (RawFormSet
[Index
], &FormTags
->Tags
[CurrTag
], (VOID
*) &RawFormSet
[Index
], NULL
);
1469 // Place this as an end of the database marker
1471 InconsistentTags
->Operand
= 0xFF;
1474 // This is the Head of the linked list of pages. Each page is an array of tags
1476 FormTags
= &FileFormTags
->FormTags
;
1477 InconsistentTags
= FileFormTags
->InconsistentTags
;
1479 for (; InconsistentTags
->Operand
!= 0xFF;) {
1480 if (InconsistentTags
->QuestionId1
!= INVALID_OFFSET_VALUE
) {
1482 // Search the tags for the tag which corresponds to this ID
1484 for (CurrTag
= 0; FormTags
->Tags
[0].Operand
!= EFI_IFR_END_FORM_SET_OP
; CurrTag
++) {
1486 // If we hit the end of a form, go to the next set of Tags.
1487 // Remember - EndFormSet op-codes sit on their own page after an end form.
1489 if (FormTags
->Tags
[CurrTag
].Operand
== EFI_IFR_END_FORM_OP
) {
1491 // Reset the CurrTag value (it will be incremented, after this case statement
1492 // so set to a negative one so that we get the desired effect.) Fish can beat me later.
1495 FormTags
= FormTags
->Next
;
1499 if (FormTags
->Tags
[CurrTag
].Id
== InconsistentTags
->QuestionId1
) {
1500 FormTags
->Tags
[CurrTag
].Consistency
++;
1505 FormTags
= &FileFormTags
->FormTags
;
1507 if (InconsistentTags
->QuestionId2
!= INVALID_OFFSET_VALUE
) {
1509 // Search the tags for the tag which corresponds to this ID
1511 for (CurrTag
= 0; FormTags
->Tags
[CurrTag
].Operand
!= EFI_IFR_END_FORM_SET_OP
; CurrTag
++) {
1513 // If we hit the end of a form, go to the next set of Tags.
1514 // Remember - EndFormSet op-codes sit on their own page after an end form.
1516 if (FormTags
->Tags
[CurrTag
].Operand
== EFI_IFR_END_FORM_OP
) {
1518 // Reset the CurrTag value (it will be incremented, after this case statement
1519 // so set to a negative one so that we get the desired effect.) Fish can beat me later.
1522 FormTags
= FormTags
->Next
;
1526 if (FormTags
->Tags
[CurrTag
].Id
== InconsistentTags
->QuestionId2
) {
1527 FormTags
->Tags
[CurrTag
].Consistency
++;
1532 InconsistentTags
= InconsistentTags
->Next
;
1543 CHAR16
*HomePageString
;
1544 CHAR16
*HomeEscapeString
;
1547 // Displays the Header and Footer borders
1549 DisplayPageFrame ();
1551 HomePageString
= GetToken (STRING_TOKEN (HOME_PAGE_TITLE
), gHiiHandle
);
1552 HomeEscapeString
= GetToken (STRING_TOKEN (HOME_ESCAPE_STRING
), gHiiHandle
);
1554 gST
->ConOut
->SetAttribute (gST
->ConOut
, EFI_YELLOW
| EFI_BRIGHT
);
1556 // PrintStringAt ((gScreenDimensions.RightColumn - GetStringWidth(HomePageString)/2)/2, 1, HomePageString);
1559 (gScreenDimensions
.RightColumn
+ gScreenDimensions
.LeftColumn
- GetStringWidth (HomePageString
) / 2) / 2,
1564 gScreenDimensions
.LeftColumn
+ 2,
1565 gScreenDimensions
.BottomRow
- 3,
1566 (CHAR16
*) L
"%c%c%s",
1572 gScreenDimensions
.RightColumn
- (GetStringWidth (HomeEscapeString
) / 2) - 2,
1573 gScreenDimensions
.BottomRow
- 3,
1577 gST
->ConOut
->SetAttribute (gST
->ConOut
, EFI_TEXT_ATTR (EFI_LIGHTGRAY
, EFI_BLACK
));
1578 gBS
->FreePool (HomeEscapeString
);
1579 gBS
->FreePool (HomePageString
);
1586 IN STRING_REF Token
,
1587 IN EFI_HII_HANDLE HiiHandle
1591 Routine Description:
1593 Get the string based on the TokenID and HII Handle.
1597 Token - The Token ID.
1598 HiiHandle - Handle of Ifr to be fetched.
1611 // Set default string size assumption at no more than 256 bytes
1613 BufferLength
= 0x100;
1615 Buffer
= AllocateZeroPool (BufferLength
);
1616 ASSERT (Buffer
!= NULL
);
1618 Status
= Hii
->GetString (Hii
, HiiHandle
, Token
, TRUE
, NULL
, &BufferLength
, Buffer
);
1620 if (EFI_ERROR (Status
)) {
1621 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1623 // Free the old pool
1625 gBS
->FreePool (Buffer
);
1628 // Allocate new pool with correct value
1630 Buffer
= AllocatePool (BufferLength
);
1631 ASSERT (Buffer
!= NULL
);
1633 Status
= Hii
->GetString (Hii
, HiiHandle
, Token
, TRUE
, NULL
, &BufferLength
, Buffer
);
1635 if (!EFI_ERROR (Status
)) {
1640 ASSERT_EFI_ERROR (Status
);
1648 IN UINTN NumberOfIfrImages
,
1649 IN EFI_FILE_FORM_TAGS
*FileFormTagsHead
1654 EFI_IFR_BINARY
*IfrBinary
;
1656 EFI_FILE_FORM_TAGS
*FileFormTags
;
1657 EFI_FORM_TAGS LocalTags
;
1659 FileFormTags
= FileFormTagsHead
;
1663 Status
= EFI_SUCCESS
;
1666 // If there are no images
1668 if (NumberOfIfrImages
== 0) {
1669 Status
= EFI_NO_MEDIA
;
1673 // IfrBinary points to the beginning of the Binary data linked-list
1675 IfrBinary
= gBinaryDataHead
;
1678 // Print the entries which were in the default language.
1680 for (Index
= 0; Index
< NumberOfIfrImages
; Index
++) {
1681 LocalTags
= FileFormTags
->FormTags
;
1684 // Populate the Menu
1686 StringPtr
= GetToken (IfrBinary
->TitleToken
, IfrBinary
->Handle
);
1689 // If the default language doesn't exist, don't add a menu option yet
1691 if (StringPtr
[0] != CHAR_NULL
) {
1693 // We are NOT!! removing this StringPtr buffer via FreePool since it is being used in the menuoptions, we will do
1694 // it in UiFreeMenu.
1696 UiAddMenuOption (StringPtr
, IfrBinary
->Handle
, LocalTags
.Tags
, IfrBinary
->FormBinary
, Index
);
1699 // Advance to the next HII handle
1701 IfrBinary
= IfrBinary
->Next
;
1702 FileFormTags
= FileFormTags
->NextFile
;
1710 IN UINTN NumberOfIfrImages
,
1711 IN EFI_FILE_FORM_TAGS
*FileFormTagsHead
,
1712 IN UINT8
*CallbackData
1716 UI_MENU_OPTION
*Selection
;
1719 // This prints the basic home page template which the user sees
1723 Status
= PopulateHomePage (NumberOfIfrImages
, FileFormTagsHead
);
1725 if (EFI_ERROR (Status
)) {
1730 Selection
= UiDisplayMenu (FALSE
, FileFormTagsHead
, (EFI_IFR_DATA_ARRAY
*) CallbackData
);
1736 InitializeBinaryStructures (
1737 IN EFI_HII_HANDLE
*Handle
,
1738 IN BOOLEAN UseDatabase
,
1739 IN EFI_IFR_PACKET
*Packet
,
1740 IN UINT8
*NvMapOverride
,
1741 IN UINTN NumberOfIfrImages
,
1742 OUT EFI_FILE_FORM_TAGS
**FileFormTagsHead
1747 EFI_IFR_BINARY
*BinaryData
;
1748 EFI_FILE_FORM_TAGS
*FileFormTags
;
1749 UINTN SizeOfNvStore
;
1750 EFI_FORM_CALLBACK_PROTOCOL
*FormCallback
;
1751 EFI_VARIABLE_DEFINITION
*VariableDefinition
;
1752 EFI_VARIABLE_DEFINITION
*OverrideDefinition
;
1755 EFI_HII_VARIABLE_PACK_LIST
*NvMapListHead
;
1756 EFI_HII_VARIABLE_PACK_LIST
*NvMapListNode
;
1759 // Initialize some variables to avoid warnings
1762 *FileFormTagsHead
= NULL
;
1763 FileFormTags
= NULL
;
1764 gBinaryDataHead
= NULL
;
1765 Status
= EFI_SUCCESS
;
1766 FormCallback
= NULL
;
1770 if (NumberOfIfrImages
> 1) {
1771 NvMapOverride
= NULL
;
1774 for (HandleIndex
= 0; HandleIndex
< NumberOfIfrImages
; HandleIndex
+= 1) {
1776 // If the buffers are uninitialized, allocate them, otherwise work on the ->Next members
1778 if ((BinaryData
== NULL
) || (FileFormTags
== NULL
)) {
1780 // Allocate memory for our Binary Data
1782 BinaryData
= AllocateZeroPool (sizeof (EFI_IFR_BINARY
));
1783 ASSERT (BinaryData
);
1786 // Preserve the Head of what will be a linked-list.
1788 gBinaryDataHead
= BinaryData
;
1789 gBinaryDataHead
->Next
= NULL
;
1792 Status
= GetIfrBinaryData (Hii
, Handle
[HandleIndex
], NULL
, BinaryData
);
1794 Status
= GetIfrBinaryData (Hii
, Handle
[HandleIndex
], Packet
, BinaryData
);
1797 // Allocate memory for our File Form Tags
1799 FileFormTags
= AllocateZeroPool (sizeof (EFI_FILE_FORM_TAGS
));
1800 ASSERT (FileFormTags
);
1803 // Preserve the Head of what will be a linked-list.
1805 *FileFormTagsHead
= FileFormTags
;
1806 (*FileFormTagsHead
)->NextFile
= NULL
;
1810 // Allocate memory for our Binary Data linked-list
1811 // Each handle represents a Binary and we will store that data away.
1813 BinaryData
->Next
= AllocateZeroPool (sizeof (EFI_IFR_BINARY
));
1814 ASSERT (BinaryData
->Next
);
1816 BinaryData
= BinaryData
->Next
;
1817 BinaryData
->Next
= NULL
;
1820 Status
= GetIfrBinaryData (Hii
, Handle
[HandleIndex
], NULL
, BinaryData
);
1822 Status
= GetIfrBinaryData (Hii
, Handle
[HandleIndex
], Packet
, BinaryData
);
1825 if (EFI_ERROR (Status
)) {
1826 return EFI_DEVICE_ERROR
;
1829 // Allocate memory for our FileFormTags linked-list
1830 // Each allocation reserves handle represents a Binary and we will store that data away.
1832 FileFormTags
->NextFile
= AllocateZeroPool (sizeof (EFI_FILE_FORM_TAGS
));
1833 ASSERT (FileFormTags
->NextFile
);
1835 FileFormTags
= FileFormTags
->NextFile
;
1840 // Tag Structure Initialization
1842 Status
= InitializeTagStructures (BinaryData
, FileFormTags
);
1844 VariableDefinition
= FileFormTags
->VariableDefinitions
;
1847 // Allocate memory for our NVRAM Maps for all of our variables
1849 for (; VariableDefinition
!= NULL
; VariableDefinition
= VariableDefinition
->Next
) {
1851 // Pad the fake variable size accordingly - this value should reflect the size of information that is not accounted by
1852 // the mainstream NVRAM variable such as DATE/TIME information that the browser needs to track but is saved to an RTC
1854 VariableDefinition
->VariableFakeSize
= (UINT16
) (VariableDefinition
->VariableSize
+ VariableDefinition
->VariableFakeSize
);
1857 // In the case where a file has no "real" NV data, we should pad the buffer accordingly
1859 if (VariableDefinition
->VariableSize
== 0) {
1860 if (VariableDefinition
->VariableFakeSize
!= 0) {
1861 VariableDefinition
->NvRamMap
= AllocateZeroPool (VariableDefinition
->VariableFakeSize
);
1862 ASSERT (VariableDefinition
->NvRamMap
!= NULL
);
1865 VariableDefinition
->NvRamMap
= AllocateZeroPool (VariableDefinition
->VariableSize
);
1866 ASSERT (VariableDefinition
->NvRamMap
!= NULL
);
1869 if (VariableDefinition
->VariableFakeSize
!= 0) {
1870 VariableDefinition
->FakeNvRamMap
= AllocateZeroPool (VariableDefinition
->VariableFakeSize
);
1871 ASSERT (VariableDefinition
->FakeNvRamMap
!= NULL
);
1875 Status
= gBS
->HandleProtocol (
1876 (VOID
*) (UINTN
) FileFormTags
->FormTags
.Tags
[0].CallbackHandle
,
1877 &gEfiFormCallbackProtocolGuid
,
1878 (VOID
**) &FormCallback
1882 // Since we might have multiple variables, if there is an NvMapOverride we need to use the EFI_VARIABLE_DEFINITION
1883 // information as the information that we pass back and forth. NOTE that callbacks that are initiated will only have the
1884 // NVRAM data refreshed based on the op-code that initiated the callback. In other words, we will pass to the caller a single
1885 // NVRAM map for a single variable based on the op-code that the user selected.
1887 if (NvMapOverride
!= NULL
) {
1888 VariableDefinition
= FileFormTags
->VariableDefinitions
;
1889 OverrideDefinition
= ((EFI_VARIABLE_DEFINITION
*) NvMapOverride
);
1892 // Search through the variable definitions. There should be sufficient passed in settings for the variable op-codes specified
1894 for (; VariableDefinition
!= NULL
; VariableDefinition
= VariableDefinition
->Next
) {
1895 if ((!CompareMem (VariableDefinition
->VariableName
, L
"Setup", 10)) && (VariableDefinition
->Next
== NULL
)) {
1896 if (VariableDefinition
->VariableSize
!= 0) {
1897 CopyMem (VariableDefinition
->NvRamMap
, NvMapOverride
, VariableDefinition
->VariableSize
);
1899 CopyMem (VariableDefinition
->NvRamMap
, NvMapOverride
, VariableDefinition
->VariableFakeSize
);
1903 VariableDefinition
->NvRamMap
= OverrideDefinition
->NvRamMap
;
1906 // There should NEVER be a ->Next for VariableDefinition and a NULL ->Next for the OverrideDefinition
1908 ASSERT (OverrideDefinition
->Next
);
1909 OverrideDefinition
= OverrideDefinition
->Next
;
1912 VariableDefinition
= FileFormTags
->VariableDefinitions
;
1915 // Search through the variable definitions. There should be sufficient passed in settings for the variable op-codes specified
1917 for (; VariableDefinition
!= NULL
; VariableDefinition
= VariableDefinition
->Next
) {
1918 SizeOfNvStore
= VariableDefinition
->VariableSize
;
1921 // Getting the NvStore and placing it into our Global Data
1923 if ((FormCallback
!= NULL
) && (FormCallback
->NvRead
!= NULL
)) {
1924 Status
= FormCallback
->NvRead (
1926 VariableDefinition
->VariableName
,
1927 &VariableDefinition
->Guid
,
1930 (VOID
*) VariableDefinition
->NvRamMap
1933 Status
= gRT
->GetVariable (
1934 VariableDefinition
->VariableName
,
1935 &VariableDefinition
->Guid
,
1938 (VOID
*) VariableDefinition
->NvRamMap
1942 if (EFI_ERROR (Status
)) {
1944 // If there is a variable that exists already and it is larger than what we calculated the
1945 // storage needs to be, we must assume the variable size from GetVariable is correct and not
1946 // allow the truncation of the variable. It is very possible that the user who created the IFR
1947 // we are cracking is not referring to a variable that was in a previous map, however we cannot
1948 // allow it's truncation.
1950 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1952 // If the buffer was too small, we should have the expanded size requirement in SizeOfNvStore now.
1954 VariableDefinition
->VariableSize
= (UINT16
) SizeOfNvStore
;
1957 // Free the buffer that was allocated that was too small
1959 gBS
->FreePool (VariableDefinition
->NvRamMap
);
1960 gBS
->FreePool (VariableDefinition
->FakeNvRamMap
);
1962 VariableDefinition
->NvRamMap
= AllocateZeroPool (SizeOfNvStore
);
1963 VariableDefinition
->FakeNvRamMap
= AllocateZeroPool (SizeOfNvStore
+ VariableDefinition
->VariableFakeSize
);
1964 ASSERT (VariableDefinition
->NvRamMap
);
1965 ASSERT (VariableDefinition
->FakeNvRamMap
);
1967 if ((FormCallback
!= NULL
) && (FormCallback
->NvRead
!= NULL
)) {
1968 Status
= FormCallback
->NvRead (
1970 VariableDefinition
->VariableName
,
1971 &VariableDefinition
->Guid
,
1974 (VOID
*) VariableDefinition
->NvRamMap
1977 Status
= gRT
->GetVariable (
1978 VariableDefinition
->VariableName
,
1979 &VariableDefinition
->Guid
,
1982 (VOID
*) VariableDefinition
->NvRamMap
1987 // if the variable was not found, we will retrieve default values
1989 if (Status
== EFI_NOT_FOUND
) {
1991 if (0 == CompareMem (VariableDefinition
->VariableName
, L
"Setup", 10)) {
1993 NvMapListHead
= NULL
;
1995 Status
= Hii
->GetDefaultImage (Hii
, Handle
[HandleIndex
], EFI_IFR_FLAG_DEFAULT
, &NvMapListHead
);
1997 if (!EFI_ERROR (Status
)) {
1998 ASSERT_EFI_ERROR (NULL
!= NvMapListHead
);
2000 NvMapListNode
= NvMapListHead
;
2002 while (NULL
!= NvMapListNode
) {
2003 if (VariableDefinition
->VariableId
== NvMapListNode
->VariablePack
->VariableId
) {
2004 NvMap
= (VOID
*) ((CHAR8
*) NvMapListNode
->VariablePack
+ sizeof (EFI_HII_VARIABLE_PACK
) + NvMapListNode
->VariablePack
->VariableNameLength
);
2005 NvMapSize
= NvMapListNode
->VariablePack
->Header
.Length
- sizeof (EFI_HII_VARIABLE_PACK
) - NvMapListNode
->VariablePack
->VariableNameLength
;
2008 NvMapListNode
= NvMapListNode
->NextVariablePack
;
2012 // Free the buffer that was allocated.
2014 gBS
->FreePool (VariableDefinition
->NvRamMap
);
2015 gBS
->FreePool (VariableDefinition
->FakeNvRamMap
);
2018 // Allocate, copy the NvRamMap.
2020 VariableDefinition
->VariableFakeSize
= (UINT16
) (VariableDefinition
->VariableFakeSize
- VariableDefinition
->VariableSize
);
2021 VariableDefinition
->VariableSize
= (UINT16
) NvMapSize
;
2022 VariableDefinition
->VariableFakeSize
= (UINT16
) (VariableDefinition
->VariableFakeSize
+ VariableDefinition
->VariableSize
);
2024 VariableDefinition
->NvRamMap
= AllocateZeroPool (VariableDefinition
->VariableSize
);
2025 VariableDefinition
->FakeNvRamMap
= AllocateZeroPool (NvMapSize
+ VariableDefinition
->VariableFakeSize
);
2027 CopyMem (VariableDefinition
->NvRamMap
, NvMap
, NvMapSize
);
2028 gBS
->FreePool (NvMapListHead
);
2032 Status
= EFI_SUCCESS
;
2038 InitializeTagStructures (BinaryData
, FileFormTags
);
2048 IN EFI_HII_PROTOCOL
*Hii
,
2049 IN EFI_HII_HANDLE HiiHandle
,
2050 IN EFI_IFR_PACKET
*Packet
,
2051 IN OUT EFI_IFR_BINARY
*BinaryData
2055 Routine Description:
2056 Fetch the Ifr binary data.
2059 Hii - Point to HII protocol.
2060 HiiHandle - Handle of Ifr to be fetched.
2061 Packet - Pointer to IFR packet.
2062 BinaryData - Buffer to copy the string into
2065 Returns the number of CHAR16 characters that were copied into the OutputString buffer.
2071 EFI_HII_PACKAGES
*PackageList
;
2074 UINT8
*RawFormBinary
;
2075 EFI_IFR_FORM_SET
*FormOp
;
2081 // Initialize the TitleToken to 0 just in case not found
2086 // Try for a 32K Buffer
2088 BufferSize
= 0x8000;
2091 // Allocate memory for our Form binary
2093 Buffer
= AllocateZeroPool (BufferSize
);
2096 if (Packet
== NULL
) {
2097 Status
= Hii
->GetForms (Hii
, HiiHandle
, 0, &BufferSize
, Buffer
);
2099 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2101 gBS
->FreePool (Buffer
);
2104 // Allocate memory for our Form binary
2106 Buffer
= AllocatePool (BufferSize
);
2109 Status
= Hii
->GetForms (Hii
, HiiHandle
, 0, &BufferSize
, Buffer
);
2113 // Copies the data to local usable buffer
2115 CopyMem (Buffer
, Packet
->IfrData
, Packet
->IfrData
->Header
.Length
);
2118 // Register the string data with HII
2120 PackageList
= PreparePackages (2, NULL
, Packet
->IfrData
, Packet
->StringData
);
2122 Status
= Hii
->NewPack (Hii
, PackageList
, &HiiHandle
);
2124 gBS
->FreePool (PackageList
);
2127 if (EFI_ERROR (Status
)) {
2131 // We now have the IFR binary in our Buffer
2133 BinaryData
->IfrPackage
= Buffer
;
2134 RawFormBinary
= (UINT8
*) ((CHAR8
*) (Buffer
) + sizeof (EFI_HII_PACK_HEADER
));
2135 BinaryData
->FormBinary
= (UINT8
*) ((CHAR8
*) (Buffer
) + sizeof (EFI_HII_PACK_HEADER
));
2136 BinaryData
->Handle
= HiiHandle
;
2139 // If a packet was passed in, remove the string data when exiting.
2141 if (Packet
!= NULL
) {
2142 BinaryData
->UnRegisterOnExit
= TRUE
;
2144 BinaryData
->UnRegisterOnExit
= FALSE
;
2147 // Walk through the FormSet Opcodes looking for the FormSet opcode
2148 // If we hit EFI_IFR_END_SET_OP we know we hit the end of the FormSet.
2150 for (Index
= 0; RawFormBinary
[Index
] != EFI_IFR_END_FORM_SET_OP
;) {
2151 FormOp
= (EFI_IFR_FORM_SET
*) &RawFormBinary
[Index
];
2152 Index
= (UINT16
) (Index
+ FormOp
->Header
.Length
);
2154 if (FormOp
->Header
.OpCode
== EFI_IFR_FORM_SET_OP
) {
2155 TitleToken
= FormOp
->FormSetTitle
;
2157 // If displaying FrontPage - set the flag signifying it
2159 switch (FormOp
->SubClass
) {
2160 case EFI_FRONT_PAGE_SUBCLASS
:
2161 FrontPageHandle
= HiiHandle
;
2164 gClassOfVfr
= FormOp
->SubClass
;
2167 // Match GUID to find out the function key setting. If match fail, use the default setting.
2169 for (Index2
= 0; Index2
< sizeof (gFunctionKeySettingTable
) / sizeof (FUNCTIION_KEY_SETTING
); Index2
++) {
2170 if (CompareGuid ((EFI_GUID
*)(UINTN
)&FormOp
->Guid
, &(gFunctionKeySettingTable
[Index2
].FormSetGuid
))) {
2172 // Update the function key setting.
2174 gFunctionKeySetting
= gFunctionKeySettingTable
[Index2
].KeySetting
;
2176 // Function key prompt can not be displayed if the function key has been disabled.
2178 if ((gFunctionKeySetting
& FUNCTION_ONE
) != FUNCTION_ONE
) {
2179 gFunctionOneString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
2182 if ((gFunctionKeySetting
& FUNCTION_TWO
) != FUNCTION_TWO
) {
2183 gFunctionTwoString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
2186 if ((gFunctionKeySetting
& FUNCTION_NINE
) != FUNCTION_NINE
) {
2187 gFunctionNineString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
2190 if ((gFunctionKeySetting
& FUNCTION_TEN
) != FUNCTION_TEN
) {
2191 gFunctionTenString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
2198 BinaryData
->TitleToken
= TitleToken
;
2203 EFI_HANDLE PrintHandle
= NULL
;
2204 EFI_PRINT_PROTOCOL mPrintProtocol
= { UnicodeVSPrint
};
2211 return gBS
->InstallProtocolInterface (
2213 &gEfiPrintProtocolGuid
,
2214 EFI_NATIVE_INTERFACE
,