2 Entry and initialization module for the browser.
4 Copyright (c) 2007 - 2008, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 SETUP_DRIVER_PRIVATE_DATA mPrivateData
= {
20 SETUP_DRIVER_SIGNATURE
,
28 EFI_HII_DATABASE_PROTOCOL
*mHiiDatabase
;
29 EFI_HII_STRING_PROTOCOL
*mHiiString
;
30 EFI_HII_CONFIG_ROUTING_PROTOCOL
*mHiiConfigRouting
;
32 BANNER_DATA
*BannerData
;
33 EFI_HII_HANDLE FrontPageHandle
;
35 UINTN gFunctionKeySetting
;
36 BOOLEAN gResetRequired
;
37 BOOLEAN gNvUpdateRequired
;
38 EFI_HII_HANDLE gHiiHandle
;
40 EFI_SCREEN_DESCRIPTOR gScreenDimensions
;
45 // Browser Global Strings
47 CHAR16
*gFunctionOneString
;
48 CHAR16
*gFunctionTwoString
;
49 CHAR16
*gFunctionNineString
;
50 CHAR16
*gFunctionTenString
;
52 CHAR16
*gEnterCommitString
;
53 CHAR16
*gEnterEscapeString
;
54 CHAR16
*gEscapeString
;
56 CHAR16
*gMoveHighlight
;
57 CHAR16
*gMakeSelection
;
58 CHAR16
*gDecNumericInput
;
59 CHAR16
*gHexNumericInput
;
60 CHAR16
*gToggleCheckBox
;
61 CHAR16
*gPromptForData
;
62 CHAR16
*gPromptForPassword
;
63 CHAR16
*gPromptForNewPassword
;
64 CHAR16
*gConfirmPassword
;
65 CHAR16
*gConfirmError
;
66 CHAR16
*gPassowordInvalid
;
75 CHAR16
*gAdjustNumber
;
77 CHAR16
*gOptionMismatch
;
79 CHAR16 gPromptBlockWidth
;
80 CHAR16 gOptionBlockWidth
;
81 CHAR16 gHelpBlockWidth
;
83 EFI_GUID gZeroGuid
= {0, 0, 0, {0, 0, 0, 0, 0, 0, 0, 0}};
84 EFI_GUID gSetupBrowserGuid
= {
85 0xab368524, 0xb60c, 0x495b, {0xa0, 0x9, 0x12, 0xe8, 0x5b, 0x1a, 0xea, 0x32}
88 FUNCTIION_KEY_SETTING gFunctionKeySettingTable
[] = {
108 NONE_FUNCTION_KEY_SETTING
129 NONE_FUNCTION_KEY_SETTING
150 NONE_FUNCTION_KEY_SETTING
153 // BMM File Explorer FormSet.
171 NONE_FUNCTION_KEY_SETTING
176 This is the routine which an external caller uses to direct the browser
177 where to obtain it's information.
180 @param This The Form Browser protocol instanse.
181 @param Handles A pointer to an array of Handles. If HandleCount > 1 we
182 display a list of the formsets for the handles specified.
183 @param HandleCount The number of Handles specified in Handle.
184 @param FormSetGuid This field points to the EFI_GUID which must match the Guid
185 field in the EFI_IFR_FORM_SET op-code for the specified
186 forms-based package. If FormSetGuid is NULL, then this
187 function will display the first found forms package.
188 @param FormId This field specifies which EFI_IFR_FORM to render as the first
189 displayable page. If this field has a value of 0x0000, then
190 the forms browser will render the specified forms in their encoded order.
191 @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
193 @param ActionRequest Points to the action recommended by the form.
195 @retval EFI_SUCCESS The function completed successfully.
196 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
197 @retval EFI_NOT_FOUND No valid forms could be found to display.
203 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
204 IN EFI_HII_HANDLE
*Handles
,
205 IN UINTN HandleCount
,
206 IN EFI_GUID
*FormSetGuid
, OPTIONAL
207 IN UINT16 FormId
, OPTIONAL
208 IN CONST EFI_SCREEN_DESCRIPTOR
*ScreenDimensions
, OPTIONAL
209 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest OPTIONAL
213 UI_MENU_SELECTION
*Selection
;
215 FORM_BROWSER_FORMSET
*FormSet
;
217 Status
= EFI_SUCCESS
;
218 ZeroMem (&gScreenDimensions
, sizeof (EFI_SCREEN_DESCRIPTOR
));
221 // Seed the dimensions in the global
223 gST
->ConOut
->QueryMode (
225 gST
->ConOut
->Mode
->Mode
,
226 &gScreenDimensions
.RightColumn
,
227 &gScreenDimensions
.BottomRow
230 if (ScreenDimensions
!= NULL
) {
232 // Check local dimension vs. global dimension.
234 if ((gScreenDimensions
.RightColumn
< ScreenDimensions
->RightColumn
) ||
235 (gScreenDimensions
.BottomRow
< ScreenDimensions
->BottomRow
)
237 return EFI_INVALID_PARAMETER
;
240 // Local dimension validation.
242 if ((ScreenDimensions
->RightColumn
> ScreenDimensions
->LeftColumn
) &&
243 (ScreenDimensions
->BottomRow
> ScreenDimensions
->TopRow
) &&
244 ((ScreenDimensions
->RightColumn
- ScreenDimensions
->LeftColumn
) > 2) &&
246 (ScreenDimensions
->BottomRow
- ScreenDimensions
->TopRow
) > STATUS_BAR_HEIGHT
+
247 SCROLL_ARROW_HEIGHT
*
249 FRONT_PAGE_HEADER_HEIGHT
+
254 CopyMem (&gScreenDimensions
, (VOID
*) ScreenDimensions
, sizeof (EFI_SCREEN_DESCRIPTOR
));
256 return EFI_INVALID_PARAMETER
;
261 gOptionBlockWidth
= (CHAR16
) ((gScreenDimensions
.RightColumn
- gScreenDimensions
.LeftColumn
) / 3);
262 gHelpBlockWidth
= gOptionBlockWidth
;
263 gPromptBlockWidth
= gOptionBlockWidth
;
266 // Initialize the strings for the browser, upon exit of the browser, the strings will be freed
268 InitializeBrowserStrings ();
270 gFunctionKeySetting
= DEFAULT_FUNCTION_KEY_SETTING
;
271 gClassOfVfr
= EFI_SETUP_APPLICATION_SUBCLASS
;
274 // Ensure we are in Text mode
276 gST
->ConOut
->SetAttribute (gST
->ConOut
, EFI_TEXT_ATTR (EFI_LIGHTGRAY
, EFI_BLACK
));
278 for (Index
= 0; Index
< HandleCount
; Index
++) {
279 Selection
= AllocateZeroPool (sizeof (UI_MENU_SELECTION
));
280 ASSERT (Selection
!= NULL
);
282 Selection
->Handle
= Handles
[Index
];
283 if (FormSetGuid
!= NULL
) {
284 CopyMem (&Selection
->FormSetGuid
, FormSetGuid
, sizeof (EFI_GUID
));
285 Selection
->FormId
= FormId
;
289 FormSet
= AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET
));
290 ASSERT (FormSet
!= NULL
);
293 // Initialize internal data structures of FormSet
295 Status
= InitializeFormSet (Selection
->Handle
, &Selection
->FormSetGuid
, FormSet
);
296 if (EFI_ERROR (Status
) || IsListEmpty (&FormSet
->FormListHead
)) {
297 DestroyFormSet (FormSet
);
300 Selection
->FormSet
= FormSet
;
303 // Initialize current settings of Questions in this FormSet
305 Status
= InitializeCurrentSetting (FormSet
);
306 if (EFI_ERROR (Status
)) {
307 DestroyFormSet (FormSet
);
312 // Display this formset
314 gCurrentSelection
= Selection
;
316 Status
= SetupBrowser (Selection
);
318 gCurrentSelection
= NULL
;
319 DestroyFormSet (FormSet
);
321 if (EFI_ERROR (Status
)) {
325 } while (Selection
->Action
== UI_ACTION_REFRESH_FORMSET
);
327 FreePool (Selection
);
330 if (ActionRequest
!= NULL
) {
331 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
332 if (gResetRequired
) {
333 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_RESET
;
337 FreeBrowserStrings ();
339 gST
->ConOut
->SetAttribute (gST
->ConOut
, EFI_TEXT_ATTR (EFI_LIGHTGRAY
, EFI_BLACK
));
340 gST
->ConOut
->ClearScreen (gST
->ConOut
);
347 This function is called by a callback handler to retrieve uncommitted state
348 data from the browser.
350 @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL
352 @param ResultsDataSize A pointer to the size of the buffer associated
354 @param ResultsData A string returned from an IFR browser or
355 equivalent. The results string will have no
356 routing information in them.
357 @param RetrieveData A BOOLEAN field which allows an agent to retrieve
358 (if RetrieveData = TRUE) data from the uncommitted
359 browser state information or set (if RetrieveData
360 = FALSE) data in the uncommitted browser state
362 @param VariableGuid An optional field to indicate the target variable
364 @param VariableName An optional field to indicate the target
365 human-readable variable name.
367 @retval EFI_SUCCESS The results have been distributed or are awaiting
369 @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to
370 contain the results data.
376 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
377 IN OUT UINTN
*ResultsDataSize
,
378 IN OUT EFI_STRING ResultsData
,
379 IN BOOLEAN RetrieveData
,
380 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
381 IN CONST CHAR16
*VariableName OPTIONAL
386 FORMSET_STORAGE
*Storage
;
387 FORM_BROWSER_FORMSET
*FormSet
;
394 if (ResultsDataSize
== NULL
|| ResultsData
== NULL
) {
395 return EFI_INVALID_PARAMETER
;
398 if (gCurrentSelection
== NULL
) {
399 return EFI_NOT_READY
;
404 FormSet
= gCurrentSelection
->FormSet
;
407 // Find target storage
409 Link
= GetFirstNode (&FormSet
->StorageListHead
);
410 if (IsNull (&FormSet
->StorageListHead
, Link
)) {
411 return EFI_UNSUPPORTED
;
414 if (VariableGuid
!= NULL
) {
416 // Try to find target storage
419 while (!IsNull (&FormSet
->StorageListHead
, Link
)) {
420 Storage
= FORMSET_STORAGE_FROM_LINK (Link
);
421 Link
= GetNextNode (&FormSet
->StorageListHead
, Link
);
423 if (CompareGuid (&Storage
->Guid
, (EFI_GUID
*) VariableGuid
)) {
424 if (Storage
->Type
== EFI_HII_VARSTORE_BUFFER
) {
426 // Buffer storage require both GUID and Name
428 if (VariableName
== NULL
) {
429 return EFI_NOT_FOUND
;
432 if (StrCmp (Storage
->Name
, (CHAR16
*) VariableName
) != 0) {
442 return EFI_NOT_FOUND
;
446 // GUID/Name is not specified, take the first storage in FormSet
448 Storage
= FORMSET_STORAGE_FROM_LINK (Link
);
453 // Skip if there is no RequestElement
455 if (Storage
->ElementCount
== 0) {
460 // Generate <ConfigResp>
462 Status
= StorageToConfigResp (Storage
, &ConfigResp
);
463 if (EFI_ERROR (Status
)) {
468 // Skip <ConfigHdr> and '&' to point to <ConfigBody>
470 StrPtr
= ConfigResp
+ StrLen (Storage
->ConfigHdr
) + 1;
472 BufferSize
= StrSize (StrPtr
);
473 if (*ResultsDataSize
< BufferSize
) {
474 *ResultsDataSize
= BufferSize
;
476 FreePool (ConfigResp
);
477 return EFI_BUFFER_TOO_SMALL
;
480 *ResultsDataSize
= BufferSize
;
481 CopyMem (ResultsData
, StrPtr
, BufferSize
);
483 FreePool (ConfigResp
);
486 // Prepare <ConfigResp>
488 TmpSize
= StrLen (ResultsData
);
489 BufferSize
= (TmpSize
+ StrLen (Storage
->ConfigHdr
) + 2) * sizeof (CHAR16
);
490 ConfigResp
= AllocateZeroPool (BufferSize
);
491 ASSERT (ConfigResp
!= NULL
);
493 StrCpy (ConfigResp
, Storage
->ConfigHdr
);
494 StrCat (ConfigResp
, L
"&");
495 StrCat (ConfigResp
, ResultsData
);
498 // Update Browser uncommited data
500 Status
= ConfigRespToStorage (Storage
, ConfigResp
);
501 if (EFI_ERROR (Status
)) {
511 Initialize Setup Browser driver.
513 @param ImageHandle The image handle.
514 @param SystemTable The system table.
516 @retval EFI_SUCCESS The Setup Browser module is initialized correctly..
517 @return Other value if failed to initialize the Setup Browser module.
523 IN EFI_HANDLE ImageHandle
,
524 IN EFI_SYSTEM_TABLE
*SystemTable
528 EFI_HANDLE HiiDriverHandle
;
529 EFI_HII_PACKAGE_LIST_HEADER
*PackageList
;
532 // Locate required Hii relative protocols
534 Status
= gBS
->LocateProtocol (
535 &gEfiHiiDatabaseProtocolGuid
,
537 (VOID
**) &mHiiDatabase
539 ASSERT_EFI_ERROR (Status
);
541 Status
= gBS
->LocateProtocol (
542 &gEfiHiiStringProtocolGuid
,
544 (VOID
**) &mHiiString
546 ASSERT_EFI_ERROR (Status
);
548 Status
= gBS
->LocateProtocol (
549 &gEfiHiiConfigRoutingProtocolGuid
,
551 (VOID
**) &mHiiConfigRouting
553 ASSERT_EFI_ERROR (Status
);
556 // Publish our HII data
558 Status
= HiiLibCreateHiiDriverHandle (&HiiDriverHandle
);
559 ASSERT_EFI_ERROR (Status
);
561 PackageList
= HiiLibPreparePackageList (1, &gSetupBrowserGuid
, SetupBrowserStrings
);
562 ASSERT (PackageList
!= NULL
);
563 Status
= mHiiDatabase
->NewPackageList (
569 ASSERT_EFI_ERROR (Status
);
572 // Initialize Driver private data
574 BannerData
= AllocateZeroPool (sizeof (BANNER_DATA
));
575 ASSERT (BannerData
!= NULL
);
578 // Install FormBrowser2 protocol
580 mPrivateData
.Handle
= NULL
;
581 Status
= gBS
->InstallProtocolInterface (
582 &mPrivateData
.Handle
,
583 &gEfiFormBrowser2ProtocolGuid
,
584 EFI_NATIVE_INTERFACE
,
585 &mPrivateData
.FormBrowser2
587 ASSERT_EFI_ERROR (Status
);
594 Create a new string in HII Package List.
596 @param String The String to be added
597 @param HiiHandle The package list in the HII database to insert the
600 @return The output string.
606 IN EFI_HII_HANDLE HiiHandle
609 EFI_STRING_ID StringId
;
613 Status
= HiiLibNewString (HiiHandle
, &StringId
, String
);
614 ASSERT_EFI_ERROR (Status
);
621 Delete a string from HII Package List.
623 @param StringId Id of the string in HII database.
624 @param HiiHandle The HII package list handle.
626 @retval EFI_SUCCESS The string was deleted successfully.
631 IN EFI_STRING_ID StringId
,
632 IN EFI_HII_HANDLE HiiHandle
637 NullChar
= CHAR_NULL
;
638 return HiiLibSetString (HiiHandle
, StringId
, &NullChar
);
643 Get the string based on the StringId and HII Package List Handle.
645 @param Token The String's ID.
646 @param HiiHandle The package list in the HII database to search for
647 the specified string.
649 @return The output string.
654 IN EFI_STRING_ID Token
,
655 IN EFI_HII_HANDLE HiiHandle
663 // Set default string size assumption at no more than 256 bytes
665 BufferLength
= 0x100;
666 String
= AllocateZeroPool (BufferLength
);
667 ASSERT (String
!= NULL
);
669 Status
= HiiLibGetString (HiiHandle
, Token
, String
, &BufferLength
);
671 if (Status
== EFI_BUFFER_TOO_SMALL
) {
673 String
= AllocateZeroPool (BufferLength
);
674 ASSERT (String
!= NULL
);
676 Status
= HiiLibGetString (HiiHandle
, Token
, String
, &BufferLength
);
678 ASSERT_EFI_ERROR (Status
);
685 Allocate new memory and then copy the Unicode string Source to Destination.
687 @param Dest Location to copy string
688 @param Src String to copy
693 IN OUT CHAR16
**Dest
,
700 *Dest
= AllocateCopyPool (StrSize (Src
), Src
);
701 ASSERT (*Dest
!= NULL
);
706 Allocate new memory and concatinate Source on the end of Destination.
708 @param Dest String to added to the end of.
709 @param Src String to concatinate.
714 IN OUT CHAR16
**Dest
,
722 NewStringCpy (Dest
, Src
);
726 TmpSize
= StrSize (*Dest
);
727 NewString
= AllocateZeroPool (TmpSize
+ StrSize (Src
) - 1);
728 ASSERT (NewString
!= NULL
);
730 StrCpy (NewString
, *Dest
);
731 StrCat (NewString
, Src
);
739 Synchronize Storage's Edit copy to Shadow copy.
741 @param Storage The Storage to be synchronized.
746 IN FORMSET_STORAGE
*Storage
750 NAME_VALUE_NODE
*Node
;
752 switch (Storage
->Type
) {
753 case EFI_HII_VARSTORE_BUFFER
:
754 CopyMem (Storage
->Buffer
, Storage
->EditBuffer
, Storage
->Size
);
757 case EFI_HII_VARSTORE_NAME_VALUE
:
758 Link
= GetFirstNode (&Storage
->NameValueListHead
);
759 while (!IsNull (&Storage
->NameValueListHead
, Link
)) {
760 Node
= NAME_VALUE_NODE_FROM_LINK (Link
);
762 NewStringCpy (&Node
->Value
, Node
->EditValue
);
764 Link
= GetNextNode (&Storage
->NameValueListHead
, Link
);
768 case EFI_HII_VARSTORE_EFI_VARIABLE
:
776 Get Value for given Name from a NameValue Storage.
778 @param Storage The NameValue Storage.
779 @param Name The Name.
780 @param Value The retured Value.
782 @retval EFI_SUCCESS Value found for given Name.
783 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
788 IN FORMSET_STORAGE
*Storage
,
790 IN OUT CHAR16
**Value
794 NAME_VALUE_NODE
*Node
;
798 Link
= GetFirstNode (&Storage
->NameValueListHead
);
799 while (!IsNull (&Storage
->NameValueListHead
, Link
)) {
800 Node
= NAME_VALUE_NODE_FROM_LINK (Link
);
802 if (StrCmp (Name
, Node
->Name
) == 0) {
803 NewStringCpy (Value
, Node
->EditValue
);
807 Link
= GetNextNode (&Storage
->NameValueListHead
, Link
);
810 return EFI_NOT_FOUND
;
815 Set Value of given Name in a NameValue Storage.
817 @param Storage The NameValue Storage.
818 @param Name The Name.
819 @param Value The Value to set.
821 @retval EFI_SUCCESS Value found for given Name.
822 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
827 IN FORMSET_STORAGE
*Storage
,
833 NAME_VALUE_NODE
*Node
;
835 Link
= GetFirstNode (&Storage
->NameValueListHead
);
836 while (!IsNull (&Storage
->NameValueListHead
, Link
)) {
837 Node
= NAME_VALUE_NODE_FROM_LINK (Link
);
839 if (StrCmp (Name
, Node
->Name
) == 0) {
840 if (Node
->EditValue
!= NULL
) {
841 FreePool (Node
->EditValue
);
843 Node
->EditValue
= AllocateCopyPool (StrSize (Value
), Value
);
844 ASSERT (Node
->EditValue
!= NULL
);
848 Link
= GetNextNode (&Storage
->NameValueListHead
, Link
);
851 return EFI_NOT_FOUND
;
856 Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
858 @param Storage The Storage to be conveted.
859 @param ConfigResp The returned <ConfigResp>.
861 @retval EFI_SUCCESS Convert success.
862 @retval EFI_INVALID_PARAMETER Incorrect storage type.
866 StorageToConfigResp (
867 IN FORMSET_STORAGE
*Storage
,
868 IN CHAR16
**ConfigResp
874 NAME_VALUE_NODE
*Node
;
876 Status
= EFI_SUCCESS
;
878 switch (Storage
->Type
) {
879 case EFI_HII_VARSTORE_BUFFER
:
880 Status
= mHiiConfigRouting
->BlockToConfig (
882 Storage
->ConfigRequest
,
890 case EFI_HII_VARSTORE_NAME_VALUE
:
892 NewStringCat (ConfigResp
, Storage
->ConfigHdr
);
894 Link
= GetFirstNode (&Storage
->NameValueListHead
);
895 while (!IsNull (&Storage
->NameValueListHead
, Link
)) {
896 Node
= NAME_VALUE_NODE_FROM_LINK (Link
);
898 NewStringCat (ConfigResp
, L
"&");
899 NewStringCat (ConfigResp
, Node
->Name
);
900 NewStringCat (ConfigResp
, L
"=");
901 NewStringCat (ConfigResp
, Node
->EditValue
);
903 Link
= GetNextNode (&Storage
->NameValueListHead
, Link
);
907 case EFI_HII_VARSTORE_EFI_VARIABLE
:
909 Status
= EFI_INVALID_PARAMETER
;
918 Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
920 @param Storage The Storage to receive the settings.
921 @param ConfigResp The <ConfigResp> to be converted.
923 @retval EFI_SUCCESS Convert success.
924 @retval EFI_INVALID_PARAMETER Incorrect storage type.
928 ConfigRespToStorage (
929 IN FORMSET_STORAGE
*Storage
,
930 IN CHAR16
*ConfigResp
940 Status
= EFI_SUCCESS
;
942 switch (Storage
->Type
) {
943 case EFI_HII_VARSTORE_BUFFER
:
944 BufferSize
= Storage
->Size
;
945 Status
= mHiiConfigRouting
->ConfigToBlock (
954 case EFI_HII_VARSTORE_NAME_VALUE
:
955 StrPtr
= StrStr (ConfigResp
, L
"&");
956 while (StrPtr
!= NULL
) {
962 StrPtr
= StrStr (StrPtr
, L
"=");
963 if (StrPtr
== NULL
) {
973 StrPtr
= StrStr (StrPtr
, L
"&");
974 if (StrPtr
!= NULL
) {
977 SetValueByName (Storage
, Name
, Value
);
981 case EFI_HII_VARSTORE_EFI_VARIABLE
:
983 Status
= EFI_INVALID_PARAMETER
;
992 Get Question's current Value.
994 @param FormSet FormSet data structure.
995 @param Form Form data structure.
996 @param Question Question to be initialized.
997 @param Cached TRUE: get from Edit copy FALSE: get from original
1000 @retval EFI_SUCCESS The function completed successfully.
1005 IN FORM_BROWSER_FORMSET
*FormSet
,
1006 IN FORM_BROWSER_FORM
*Form
,
1007 IN OUT FORM_BROWSER_STATEMENT
*Question
,
1017 FORMSET_STORAGE
*Storage
;
1018 EFI_IFR_TYPE_VALUE
*QuestionValue
;
1019 CHAR16
*ConfigRequest
;
1025 BOOLEAN IsBufferStorage
;
1028 Status
= EFI_SUCCESS
;
1031 // Statement don't have storage, skip them
1033 if (Question
->QuestionId
== 0) {
1038 // Question value is provided by an Expression, evaluate it
1040 if (Question
->ValueExpression
!= NULL
) {
1041 Status
= EvaluateExpression (FormSet
, Form
, Question
->ValueExpression
);
1042 if (!EFI_ERROR (Status
)) {
1043 CopyMem (&Question
->HiiValue
, &Question
->ValueExpression
->Result
, sizeof (EFI_HII_VALUE
));
1049 // Question value is provided by RTC
1051 Storage
= Question
->Storage
;
1052 QuestionValue
= &Question
->HiiValue
.Value
;
1053 if (Storage
== NULL
) {
1055 // It's a Question without storage, or RTC date/time
1057 if (Question
->Operand
== EFI_IFR_DATE_OP
|| Question
->Operand
== EFI_IFR_TIME_OP
) {
1059 // Date and time define the same Flags bit
1061 switch (Question
->Flags
& EFI_QF_DATE_STORAGE
) {
1062 case QF_DATE_STORAGE_TIME
:
1063 Status
= gRT
->GetTime (&EfiTime
, NULL
);
1066 case QF_DATE_STORAGE_WAKEUP
:
1067 Status
= gRT
->GetWakeupTime (&Enabled
, &Pending
, &EfiTime
);
1070 case QF_DATE_STORAGE_NORMAL
:
1073 // For date/time without storage
1078 if (EFI_ERROR (Status
)) {
1082 if (Question
->Operand
== EFI_IFR_DATE_OP
) {
1083 QuestionValue
->date
.Year
= EfiTime
.Year
;
1084 QuestionValue
->date
.Month
= EfiTime
.Month
;
1085 QuestionValue
->date
.Day
= EfiTime
.Day
;
1087 QuestionValue
->time
.Hour
= EfiTime
.Hour
;
1088 QuestionValue
->time
.Minute
= EfiTime
.Minute
;
1089 QuestionValue
->time
.Second
= EfiTime
.Second
;
1097 // Question value is provided by EFI variable
1099 StorageWidth
= Question
->StorageWidth
;
1100 if (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
1101 if (Question
->BufferValue
!= NULL
) {
1102 Dst
= Question
->BufferValue
;
1104 Dst
= (UINT8
*) QuestionValue
;
1107 Status
= gRT
->GetVariable (
1108 Question
->VariableName
,
1115 // Always return success, even this EFI variable doesn't exist
1121 // Question Value is provided by Buffer Storage or NameValue Storage
1123 if (Question
->BufferValue
!= NULL
) {
1125 // This Question is password or orderedlist
1127 Dst
= Question
->BufferValue
;
1130 // Other type of Questions
1132 Dst
= (UINT8
*) &Question
->HiiValue
.Value
;
1135 IsBufferStorage
= (BOOLEAN
) ((Storage
->Type
== EFI_HII_VARSTORE_BUFFER
) ? TRUE
: FALSE
);
1136 IsString
= (BOOLEAN
) ((Question
->HiiValue
.Type
== EFI_IFR_TYPE_STRING
) ? TRUE
: FALSE
);
1138 if (IsBufferStorage
) {
1140 // Copy from storage Edit buffer
1142 CopyMem (Dst
, Storage
->EditBuffer
+ Question
->VarStoreInfo
.VarOffset
, StorageWidth
);
1144 Status
= GetValueByName (Storage
, Question
->VariableName
, &Value
);
1145 if (EFI_ERROR (Status
)) {
1151 // Convert Config String to Unicode String, e.g "0041004200430044" => "ABCD"
1153 Length
= StorageWidth
+ sizeof (CHAR16
);
1154 Status
= ConfigStringToUnicode ((CHAR16
*) Dst
, &Length
, Value
);
1156 Status
= HexStringToBuf (Dst
, &StorageWidth
, Value
, NULL
);
1163 // Request current settings from Configuration Driver
1165 if (FormSet
->ConfigAccess
== NULL
) {
1166 return EFI_NOT_FOUND
;
1170 // <ConfigRequest> ::= <ConfigHdr> + <BlockName> ||
1171 // <ConfigHdr> + "&" + <VariableName>
1173 if (IsBufferStorage
) {
1174 Length
= StrLen (Storage
->ConfigHdr
);
1175 Length
+= StrLen (Question
->BlockName
);
1177 Length
= StrLen (Storage
->ConfigHdr
);
1178 Length
+= StrLen (Question
->VariableName
) + 1;
1180 ConfigRequest
= AllocateZeroPool ((Length
+ 1) * sizeof (CHAR16
));
1181 ASSERT (ConfigRequest
!= NULL
);
1183 StrCpy (ConfigRequest
, Storage
->ConfigHdr
);
1184 if (IsBufferStorage
) {
1185 StrCat (ConfigRequest
, Question
->BlockName
);
1187 StrCat (ConfigRequest
, L
"&");
1188 StrCat (ConfigRequest
, Question
->VariableName
);
1191 Status
= FormSet
->ConfigAccess
->ExtractConfig (
1192 FormSet
->ConfigAccess
,
1197 if (EFI_ERROR (Status
)) {
1202 // Skip <ConfigRequest>
1204 Value
= Result
+ Length
;
1205 if (IsBufferStorage
) {
1211 if (*Value
!= '=') {
1213 return EFI_NOT_FOUND
;
1216 // Skip '=', point to value
1221 // Suppress <AltResp> if any
1224 while (*StringPtr
!= L
'\0' && *StringPtr
!= L
'&') {
1229 if (!IsBufferStorage
&& IsString
) {
1231 // Convert Config String to Unicode String, e.g "0041004200430044" => "ABCD"
1233 Length
= StorageWidth
+ sizeof (CHAR16
);
1234 Status
= ConfigStringToUnicode ((CHAR16
*) Dst
, &Length
, Value
);
1236 Status
= HexStringToBuf (Dst
, &StorageWidth
, Value
, NULL
);
1237 if (EFI_ERROR (Status
)) {
1244 // Synchronize Edit Buffer
1246 if (IsBufferStorage
) {
1247 CopyMem (Storage
->EditBuffer
+ Question
->VarStoreInfo
.VarOffset
, Dst
, StorageWidth
);
1249 SetValueByName (Storage
, Question
->VariableName
, Value
);
1259 Save Question Value to edit copy(cached) or Storage(uncached).
1261 @param FormSet FormSet data structure.
1262 @param Form Form data structure.
1263 @param Question Pointer to the Question.
1264 @param Cached TRUE: set to Edit copy FALSE: set to original
1267 @retval EFI_SUCCESS The function completed successfully.
1272 IN FORM_BROWSER_FORMSET
*FormSet
,
1273 IN FORM_BROWSER_FORM
*Form
,
1274 IN OUT FORM_BROWSER_STATEMENT
*Question
,
1285 FORMSET_STORAGE
*Storage
;
1286 EFI_IFR_TYPE_VALUE
*QuestionValue
;
1291 BOOLEAN IsBufferStorage
;
1294 Status
= EFI_SUCCESS
;
1297 // Statement don't have storage, skip them
1299 if (Question
->QuestionId
== 0) {
1304 // If Question value is provided by an Expression, then it is read only
1306 if (Question
->ValueExpression
!= NULL
) {
1311 // Question value is provided by RTC
1313 Storage
= Question
->Storage
;
1314 QuestionValue
= &Question
->HiiValue
.Value
;
1315 if (Storage
== NULL
) {
1317 // It's a Question without storage, or RTC date/time
1319 if (Question
->Operand
== EFI_IFR_DATE_OP
|| Question
->Operand
== EFI_IFR_TIME_OP
) {
1321 // Date and time define the same Flags bit
1323 switch (Question
->Flags
& EFI_QF_DATE_STORAGE
) {
1324 case QF_DATE_STORAGE_TIME
:
1325 Status
= gRT
->GetTime (&EfiTime
, NULL
);
1328 case QF_DATE_STORAGE_WAKEUP
:
1329 Status
= gRT
->GetWakeupTime (&Enabled
, &Pending
, &EfiTime
);
1332 case QF_DATE_STORAGE_NORMAL
:
1335 // For date/time without storage
1340 if (EFI_ERROR (Status
)) {
1344 if (Question
->Operand
== EFI_IFR_DATE_OP
) {
1345 EfiTime
.Year
= QuestionValue
->date
.Year
;
1346 EfiTime
.Month
= QuestionValue
->date
.Month
;
1347 EfiTime
.Day
= QuestionValue
->date
.Day
;
1349 EfiTime
.Hour
= QuestionValue
->time
.Hour
;
1350 EfiTime
.Minute
= QuestionValue
->time
.Minute
;
1351 EfiTime
.Second
= QuestionValue
->time
.Second
;
1354 if ((Question
->Flags
& EFI_QF_DATE_STORAGE
) == QF_DATE_STORAGE_TIME
) {
1355 Status
= gRT
->SetTime (&EfiTime
);
1357 Status
= gRT
->SetWakeupTime (TRUE
, &EfiTime
);
1365 // Question value is provided by EFI variable
1367 StorageWidth
= Question
->StorageWidth
;
1368 if (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
1369 if (Question
->BufferValue
!= NULL
) {
1370 Src
= Question
->BufferValue
;
1372 Src
= (UINT8
*) QuestionValue
;
1375 Status
= gRT
->SetVariable (
1376 Question
->VariableName
,
1378 Storage
->Attributes
,
1386 // Question Value is provided by Buffer Storage or NameValue Storage
1388 if (Question
->BufferValue
!= NULL
) {
1389 Src
= Question
->BufferValue
;
1391 Src
= (UINT8
*) &Question
->HiiValue
.Value
;
1394 IsBufferStorage
= (BOOLEAN
) ((Storage
->Type
== EFI_HII_VARSTORE_BUFFER
) ? TRUE
: FALSE
);
1395 IsString
= (BOOLEAN
) ((Question
->HiiValue
.Type
== EFI_IFR_TYPE_STRING
) ? TRUE
: FALSE
);
1396 if (IsBufferStorage
) {
1398 // Copy to storage edit buffer
1400 CopyMem (Storage
->EditBuffer
+ Question
->VarStoreInfo
.VarOffset
, Src
, StorageWidth
);
1404 // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"
1407 BufferLen
= ((StrLen ((CHAR16
*) Src
) * 4) + 1) * sizeof (CHAR16
);
1408 Value
= AllocateZeroPool (BufferLen
);
1409 ASSERT (Value
!= NULL
);
1410 Status
= UnicodeToConfigString (Value
, &BufferLen
, (CHAR16
*) Src
);
1411 ASSERT_EFI_ERROR (Status
);
1413 BufferLen
= StorageWidth
* 2 + 1;
1414 Value
= AllocateZeroPool (BufferLen
* sizeof (CHAR16
));
1415 ASSERT (Value
!= NULL
);
1416 BufToHexString (Value
, &BufferLen
, Src
, StorageWidth
);
1420 Status
= SetValueByName (Storage
, Question
->VariableName
, Value
);
1426 // <ConfigResp> ::= <ConfigHdr> + <BlockName> + "&VALUE=" + "<HexCh>StorageWidth * 2" ||
1427 // <ConfigHdr> + "&" + <VariableName> + "=" + "<string>"
1429 if (IsBufferStorage
) {
1430 Length
= StrLen (Question
->BlockName
) + 7;
1432 Length
= StrLen (Question
->VariableName
) + 2;
1434 if (!IsBufferStorage
&& IsString
) {
1435 Length
+= (StrLen ((CHAR16
*) Src
) * 4);
1437 Length
+= (StorageWidth
* 2);
1439 ConfigResp
= AllocateZeroPool ((StrLen (Storage
->ConfigHdr
) + Length
+ 1) * sizeof (CHAR16
));
1440 ASSERT (ConfigResp
!= NULL
);
1442 StrCpy (ConfigResp
, Storage
->ConfigHdr
);
1443 if (IsBufferStorage
) {
1444 StrCat (ConfigResp
, Question
->BlockName
);
1445 StrCat (ConfigResp
, L
"&VALUE=");
1447 StrCat (ConfigResp
, L
"&");
1448 StrCat (ConfigResp
, Question
->VariableName
);
1449 StrCat (ConfigResp
, L
"=");
1452 Value
= ConfigResp
+ StrLen (ConfigResp
);
1453 if (!IsBufferStorage
&& IsString
) {
1455 // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"
1457 BufferLen
= ((StrLen ((CHAR16
*) Src
) * 4) + 1) * sizeof (CHAR16
);
1458 Status
= UnicodeToConfigString (Value
, &BufferLen
, (CHAR16
*) Src
);
1459 ASSERT_EFI_ERROR (Status
);
1461 BufferLen
= StorageWidth
* 2 + 1;
1462 BufToHexString (Value
, &BufferLen
, Src
, StorageWidth
);
1467 // Submit Question Value to Configuration Driver
1469 if (FormSet
->ConfigAccess
!= NULL
) {
1470 Status
= FormSet
->ConfigAccess
->RouteConfig (
1471 FormSet
->ConfigAccess
,
1475 if (EFI_ERROR (Status
)) {
1476 FreePool (ConfigResp
);
1480 FreePool (ConfigResp
);
1483 // Synchronize shadow Buffer
1485 SynchronizeStorage (Storage
);
1493 Perform inconsistent check for a Form.
1495 @param FormSet FormSet data structure.
1496 @param Form Form data structure.
1497 @param Question The Question to be validated.
1498 @param Type Validation type: InConsistent or NoSubmit
1500 @retval EFI_SUCCESS Form validation pass.
1501 @retval other Form validation failed.
1506 IN FORM_BROWSER_FORMSET
*FormSet
,
1507 IN FORM_BROWSER_FORM
*Form
,
1508 IN FORM_BROWSER_STATEMENT
*Question
,
1514 LIST_ENTRY
*ListHead
;
1517 FORM_EXPRESSION
*Expression
;
1519 if (Type
== EFI_HII_EXPRESSION_INCONSISTENT_IF
) {
1520 ListHead
= &Question
->InconsistentListHead
;
1521 } else if (Type
== EFI_HII_EXPRESSION_NO_SUBMIT_IF
) {
1522 ListHead
= &Question
->NoSubmitListHead
;
1524 return EFI_UNSUPPORTED
;
1527 Link
= GetFirstNode (ListHead
);
1528 while (!IsNull (ListHead
, Link
)) {
1529 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
1532 // Evaluate the expression
1534 Status
= EvaluateExpression (FormSet
, Form
, Expression
);
1535 if (EFI_ERROR (Status
)) {
1539 if (Expression
->Result
.Value
.b
) {
1541 // Condition meet, show up error message
1543 if (Expression
->Error
!= 0) {
1544 PopUp
= GetToken (Expression
->Error
, FormSet
->HiiHandle
);
1546 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, PopUp
, gPressEnter
, gEmptyString
);
1547 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
1551 return EFI_NOT_READY
;
1554 Link
= GetNextNode (ListHead
, Link
);
1562 Perform NoSubmit check for a Form.
1564 @param FormSet FormSet data structure.
1565 @param Form Form data structure.
1567 @retval EFI_SUCCESS Form validation pass.
1568 @retval other Form validation failed.
1573 IN FORM_BROWSER_FORMSET
*FormSet
,
1574 IN FORM_BROWSER_FORM
*Form
1579 FORM_BROWSER_STATEMENT
*Question
;
1581 Link
= GetFirstNode (&Form
->StatementListHead
);
1582 while (!IsNull (&Form
->StatementListHead
, Link
)) {
1583 Question
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
1585 Status
= ValidateQuestion (FormSet
, Form
, Question
, EFI_HII_EXPRESSION_NO_SUBMIT_IF
);
1586 if (EFI_ERROR (Status
)) {
1590 Link
= GetNextNode (&Form
->StatementListHead
, Link
);
1600 @param FormSet FormSet data structure.
1601 @param Form Form data structure.
1603 @retval EFI_SUCCESS The function completed successfully.
1608 IN FORM_BROWSER_FORMSET
*FormSet
,
1609 IN FORM_BROWSER_FORM
*Form
1614 EFI_STRING ConfigResp
;
1615 EFI_STRING Progress
;
1616 FORMSET_STORAGE
*Storage
;
1619 // Validate the Form by NoSubmit check
1621 Status
= NoSubmitCheck (FormSet
, Form
);
1622 if (EFI_ERROR (Status
)) {
1627 // Submit Buffer storage or Name/Value storage
1629 Link
= GetFirstNode (&FormSet
->StorageListHead
);
1630 while (!IsNull (&FormSet
->StorageListHead
, Link
)) {
1631 Storage
= FORMSET_STORAGE_FROM_LINK (Link
);
1632 Link
= GetNextNode (&FormSet
->StorageListHead
, Link
);
1634 if (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
1639 // Skip if there is no RequestElement
1641 if (Storage
->ElementCount
== 0) {
1646 // Prepare <ConfigResp>
1648 Status
= StorageToConfigResp (Storage
, &ConfigResp
);
1649 if (EFI_ERROR (Status
)) {
1654 // Send <ConfigResp> to Configuration Driver
1656 if (FormSet
->ConfigAccess
!= NULL
) {
1657 Status
= FormSet
->ConfigAccess
->RouteConfig (
1658 FormSet
->ConfigAccess
,
1662 if (EFI_ERROR (Status
)) {
1663 FreePool (ConfigResp
);
1667 FreePool (ConfigResp
);
1670 // Config success, update storage shadow Buffer
1672 SynchronizeStorage (Storage
);
1675 gNvUpdateRequired
= FALSE
;
1682 Reset Question to its default value.
1684 @param FormSet The form set.
1685 @param Form The form.
1686 @param Question The question.
1687 @param DefaultId The Class of the default.
1689 @retval EFI_SUCCESS Question is reset to default value.
1693 GetQuestionDefault (
1694 IN FORM_BROWSER_FORMSET
*FormSet
,
1695 IN FORM_BROWSER_FORM
*Form
,
1696 IN FORM_BROWSER_STATEMENT
*Question
,
1702 QUESTION_DEFAULT
*Default
;
1703 QUESTION_OPTION
*Option
;
1704 EFI_HII_VALUE
*HiiValue
;
1707 Status
= EFI_SUCCESS
;
1710 // Statement don't have storage, skip them
1712 if (Question
->QuestionId
== 0) {
1717 // There are three ways to specify default value for a Question:
1718 // 1, use nested EFI_IFR_DEFAULT (highest priority)
1719 // 2, set flags of EFI_ONE_OF_OPTION (provide Standard and Manufacturing default)
1720 // 3, set flags of EFI_IFR_CHECKBOX (provide Standard and Manufacturing default) (lowest priority)
1722 HiiValue
= &Question
->HiiValue
;
1725 // EFI_IFR_DEFAULT has highest priority
1727 if (!IsListEmpty (&Question
->DefaultListHead
)) {
1728 Link
= GetFirstNode (&Question
->DefaultListHead
);
1729 while (!IsNull (&Question
->DefaultListHead
, Link
)) {
1730 Default
= QUESTION_DEFAULT_FROM_LINK (Link
);
1732 if (Default
->DefaultId
== DefaultId
) {
1733 if (Default
->ValueExpression
!= NULL
) {
1735 // Default is provided by an Expression, evaluate it
1737 Status
= EvaluateExpression (FormSet
, Form
, Default
->ValueExpression
);
1738 if (EFI_ERROR (Status
)) {
1742 CopyMem (HiiValue
, &Default
->ValueExpression
->Result
, sizeof (EFI_HII_VALUE
));
1745 // Default value is embedded in EFI_IFR_DEFAULT
1747 CopyMem (HiiValue
, &Default
->Value
, sizeof (EFI_HII_VALUE
));
1753 Link
= GetNextNode (&Question
->DefaultListHead
, Link
);
1758 // EFI_ONE_OF_OPTION
1760 if ((Question
->Operand
== EFI_IFR_ONE_OF_OP
) && !IsListEmpty (&Question
->OptionListHead
)) {
1761 if (DefaultId
<= EFI_HII_DEFAULT_CLASS_MANUFACTURING
) {
1763 // OneOfOption could only provide Standard and Manufacturing default
1765 Link
= GetFirstNode (&Question
->OptionListHead
);
1766 while (!IsNull (&Question
->OptionListHead
, Link
)) {
1767 Option
= QUESTION_OPTION_FROM_LINK (Link
);
1769 if (((DefaultId
== EFI_HII_DEFAULT_CLASS_STANDARD
) && ((Option
->Flags
& EFI_IFR_OPTION_DEFAULT
) != 0)) ||
1770 ((DefaultId
== EFI_HII_DEFAULT_CLASS_MANUFACTURING
) && ((Option
->Flags
& EFI_IFR_OPTION_DEFAULT_MFG
) != 0))
1772 CopyMem (HiiValue
, &Option
->Value
, sizeof (EFI_HII_VALUE
));
1777 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
1783 // EFI_IFR_CHECKBOX - lowest priority
1785 if (Question
->Operand
== EFI_IFR_CHECKBOX_OP
) {
1786 if (DefaultId
<= EFI_HII_DEFAULT_CLASS_MANUFACTURING
) {
1788 // Checkbox could only provide Standard and Manufacturing default
1790 if (((DefaultId
== EFI_HII_DEFAULT_CLASS_STANDARD
) && ((Question
->Flags
& EFI_IFR_CHECKBOX_DEFAULT
) != 0)) ||
1791 ((DefaultId
== EFI_HII_DEFAULT_CLASS_MANUFACTURING
) && ((Question
->Flags
& EFI_IFR_CHECKBOX_DEFAULT_MFG
) != 0))
1793 HiiValue
->Value
.b
= TRUE
;
1795 HiiValue
->Value
.b
= FALSE
;
1803 // For Questions without default
1805 switch (Question
->Operand
) {
1806 case EFI_IFR_NUMERIC_OP
:
1808 // Take minimal value as numeric's default value
1810 HiiValue
->Value
.u64
= Question
->Minimum
;
1813 case EFI_IFR_ONE_OF_OP
:
1815 // Take first oneof option as oneof's default value
1817 Link
= GetFirstNode (&Question
->OptionListHead
);
1818 if (!IsNull (&Question
->OptionListHead
, Link
)) {
1819 Option
= QUESTION_OPTION_FROM_LINK (Link
);
1820 CopyMem (HiiValue
, &Option
->Value
, sizeof (EFI_HII_VALUE
));
1824 case EFI_IFR_ORDERED_LIST_OP
:
1826 // Take option sequence in IFR as ordered list's default value
1829 Link
= GetFirstNode (&Question
->OptionListHead
);
1830 while (!IsNull (&Question
->OptionListHead
, Link
)) {
1831 Option
= QUESTION_OPTION_FROM_LINK (Link
);
1833 Question
->BufferValue
[Index
] = Option
->Value
.Value
.u8
;
1836 if (Index
>= Question
->MaxContainers
) {
1840 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
1845 Status
= EFI_NOT_FOUND
;
1854 Reset Questions in a Form to their default value.
1856 @param FormSet FormSet data structure.
1857 @param Form The Form which to be reset.
1858 @param DefaultId The Class of the default.
1860 @retval EFI_SUCCESS The function completed successfully.
1864 ExtractFormDefault (
1865 IN FORM_BROWSER_FORMSET
*FormSet
,
1866 IN FORM_BROWSER_FORM
*Form
,
1872 FORM_BROWSER_STATEMENT
*Question
;
1874 Link
= GetFirstNode (&Form
->StatementListHead
);
1875 while (!IsNull (&Form
->StatementListHead
, Link
)) {
1876 Question
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
1877 Link
= GetNextNode (&Form
->StatementListHead
, Link
);
1880 // If Question is suppressed, don't reset it to default
1882 if (Question
->SuppressExpression
!= NULL
) {
1883 Status
= EvaluateExpression (FormSet
, Form
, Question
->SuppressExpression
);
1884 if (!EFI_ERROR (Status
) && Question
->SuppressExpression
->Result
.Value
.b
) {
1890 // Reset Question to its default value
1892 Status
= GetQuestionDefault (FormSet
, Form
, Question
, DefaultId
);
1893 if (EFI_ERROR (Status
)) {
1898 // Synchronize Buffer storage's Edit buffer
1900 if ((Question
->Storage
!= NULL
) &&
1901 (Question
->Storage
->Type
!= EFI_HII_VARSTORE_EFI_VARIABLE
)) {
1902 SetQuestionValue (FormSet
, Form
, Question
, TRUE
);
1911 Initialize Question's Edit copy from Storage.
1913 @param FormSet FormSet data structure.
1914 @param Form Form data structure.
1916 @retval EFI_SUCCESS The function completed successfully.
1921 IN FORM_BROWSER_FORMSET
*FormSet
,
1922 IN FORM_BROWSER_FORM
*Form
1927 FORM_BROWSER_STATEMENT
*Question
;
1929 Link
= GetFirstNode (&Form
->StatementListHead
);
1930 while (!IsNull (&Form
->StatementListHead
, Link
)) {
1931 Question
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
1934 // Initialize local copy of Value for each Question
1936 Status
= GetQuestionValue (FormSet
, Form
, Question
, TRUE
);
1937 if (EFI_ERROR (Status
)) {
1941 Link
= GetNextNode (&Form
->StatementListHead
, Link
);
1949 Fill storage's edit copy with settings requested from Configuration Driver.
1951 @param FormSet FormSet data structure.
1952 @param Storage Buffer Storage.
1954 @retval EFI_SUCCESS The function completed successfully.
1959 IN FORM_BROWSER_FORMSET
*FormSet
,
1960 IN FORMSET_STORAGE
*Storage
1964 EFI_STRING Progress
;
1968 if (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
1972 if (FormSet
->ConfigAccess
== NULL
) {
1973 return EFI_NOT_FOUND
;
1976 if (Storage
->ElementCount
== 0) {
1978 // Skip if there is no RequestElement
1984 // Request current settings from Configuration Driver
1986 Status
= FormSet
->ConfigAccess
->ExtractConfig (
1987 FormSet
->ConfigAccess
,
1988 Storage
->ConfigRequest
,
1992 if (EFI_ERROR (Status
)) {
1997 // Convert Result from <ConfigAltResp> to <ConfigResp>
1999 StrPtr
= StrStr (Result
, L
"ALTCFG");
2000 if (StrPtr
!= NULL
) {
2004 Status
= ConfigRespToStorage (Storage
, Result
);
2011 Get current setting of Questions.
2013 @param FormSet FormSet data structure.
2015 @retval EFI_SUCCESS The function completed successfully.
2019 InitializeCurrentSetting (
2020 IN OUT FORM_BROWSER_FORMSET
*FormSet
2024 FORMSET_STORAGE
*Storage
;
2025 FORM_BROWSER_FORM
*Form
;
2029 // Extract default from IFR binary
2031 Link
= GetFirstNode (&FormSet
->FormListHead
);
2032 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
2033 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
2035 Status
= ExtractFormDefault (FormSet
, Form
, EFI_HII_DEFAULT_CLASS_STANDARD
);
2037 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
2041 // Request current settings from Configuration Driver
2043 Link
= GetFirstNode (&FormSet
->StorageListHead
);
2044 while (!IsNull (&FormSet
->StorageListHead
, Link
)) {
2045 Storage
= FORMSET_STORAGE_FROM_LINK (Link
);
2047 Status
= LoadStorage (FormSet
, Storage
);
2050 // Now Edit Buffer is filled with default values(lower priority) and current
2051 // settings(higher priority), sychronize it to shadow Buffer
2053 if (!EFI_ERROR (Status
)) {
2054 SynchronizeStorage (Storage
);
2057 Link
= GetNextNode (&FormSet
->StorageListHead
, Link
);
2065 Fetch the Ifr binary data of a FormSet.
2067 @param Handle PackageList Handle
2068 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
2069 GUID), take the first FormSet found in package
2071 @param BinaryLength The length of the FormSet IFR binary.
2072 @param BinaryData The buffer designed to receive the FormSet.
2074 @retval EFI_SUCCESS Buffer filled with the requested FormSet.
2075 BufferLength was updated.
2076 @retval EFI_INVALID_PARAMETER The handle is unknown.
2077 @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot
2078 be found with the requested FormId.
2083 IN EFI_HII_HANDLE Handle
,
2084 IN OUT EFI_GUID
*FormSetGuid
,
2085 OUT UINTN
*BinaryLength
,
2086 OUT UINT8
**BinaryData
2090 EFI_HII_PACKAGE_LIST_HEADER
*HiiPackageList
;
2096 BOOLEAN ReturnDefault
;
2097 UINT32 PackageListLength
;
2098 EFI_HII_PACKAGE_HEADER PackageHeader
;
2102 ZeroMem (&PackageHeader
, sizeof (EFI_HII_PACKAGE_HEADER
));;
2105 // if FormSetGuid is NULL or zero GUID, return first FormSet in the package list
2107 if (FormSetGuid
== NULL
|| CompareGuid (FormSetGuid
, &gZeroGuid
)) {
2108 ReturnDefault
= TRUE
;
2110 ReturnDefault
= FALSE
;
2114 // Get HII PackageList
2117 HiiPackageList
= NULL
;
2118 Status
= mHiiDatabase
->ExportPackageLists (mHiiDatabase
, Handle
, &BufferSize
, HiiPackageList
);
2119 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2120 HiiPackageList
= AllocatePool (BufferSize
);
2121 ASSERT (HiiPackageList
!= NULL
);
2123 Status
= mHiiDatabase
->ExportPackageLists (mHiiDatabase
, Handle
, &BufferSize
, HiiPackageList
);
2125 if (EFI_ERROR (Status
)) {
2128 ASSERT (HiiPackageList
!= NULL
);
2131 // Get Form package from this HII package List
2133 Offset
= sizeof (EFI_HII_PACKAGE_LIST_HEADER
);
2135 CopyMem (&PackageListLength
, &HiiPackageList
->PackageLength
, sizeof (UINT32
));
2137 while (Offset
< PackageListLength
) {
2138 Package
= ((UINT8
*) HiiPackageList
) + Offset
;
2139 CopyMem (&PackageHeader
, Package
, sizeof (EFI_HII_PACKAGE_HEADER
));
2141 if (PackageHeader
.Type
== EFI_HII_PACKAGE_FORMS
) {
2143 // Search FormSet in this Form Package
2145 Offset2
= sizeof (EFI_HII_PACKAGE_HEADER
);
2146 while (Offset2
< PackageHeader
.Length
) {
2147 OpCodeData
= Package
+ Offset2
;
2149 if (((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
== EFI_IFR_FORM_SET_OP
) {
2151 // Check whether return default FormSet
2153 if (ReturnDefault
) {
2158 // FormSet GUID is specified, check it
2160 if (CompareGuid (FormSetGuid
, (EFI_GUID
*)(OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
)))) {
2165 Offset2
+= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
2168 if (Offset2
< PackageHeader
.Length
) {
2170 // Target formset found
2176 Offset
+= PackageHeader
.Length
;
2179 if (Offset
>= PackageListLength
) {
2181 // Form package not found in this Package List
2183 FreePool (HiiPackageList
);
2184 return EFI_NOT_FOUND
;
2187 if (ReturnDefault
&& FormSetGuid
!= NULL
) {
2189 // Return the default FormSet GUID
2191 CopyMem (FormSetGuid
, &((EFI_IFR_FORM_SET
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
));
2195 // To determine the length of a whole FormSet IFR binary, one have to parse all the Opcodes
2196 // in this FormSet; So, here just simply copy the data from start of a FormSet to the end
2197 // of the Form Package.
2199 *BinaryLength
= PackageHeader
.Length
- Offset2
;
2200 *BinaryData
= AllocateCopyPool (*BinaryLength
, OpCodeData
);
2202 FreePool (HiiPackageList
);
2204 if (*BinaryData
== NULL
) {
2205 return EFI_OUT_OF_RESOURCES
;
2213 Initialize the internal data structure of a FormSet.
2215 @param Handle PackageList Handle
2216 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
2217 GUID), take the first FormSet found in package
2219 @param FormSet FormSet data structure.
2221 @retval EFI_SUCCESS The function completed successfully.
2222 @retval EFI_NOT_FOUND The specified FormSet could not be found.
2227 IN EFI_HII_HANDLE Handle
,
2228 IN OUT EFI_GUID
*FormSetGuid
,
2229 OUT FORM_BROWSER_FORMSET
*FormSet
2233 EFI_HANDLE DriverHandle
;
2236 Status
= GetIfrBinaryData (Handle
, FormSetGuid
, &FormSet
->IfrBinaryLength
, &FormSet
->IfrBinaryData
);
2237 if (EFI_ERROR (Status
)) {
2241 FormSet
->HiiHandle
= Handle
;
2242 CopyMem (&FormSet
->Guid
, FormSetGuid
, sizeof (EFI_GUID
));
2245 // Retrieve ConfigAccess Protocol associated with this HiiPackageList
2247 Status
= mHiiDatabase
->GetPackageListHandle (mHiiDatabase
, Handle
, &DriverHandle
);
2248 if (EFI_ERROR (Status
)) {
2251 FormSet
->DriverHandle
= DriverHandle
;
2252 Status
= gBS
->HandleProtocol (
2254 &gEfiHiiConfigAccessProtocolGuid
,
2255 (VOID
**) &FormSet
->ConfigAccess
2257 if (EFI_ERROR (Status
)) {
2259 // Configuration Driver don't attach ConfigAccess protocol to its HII package
2260 // list, then there will be no configuration action required
2262 FormSet
->ConfigAccess
= NULL
;
2266 // Parse the IFR binary OpCodes
2268 Status
= ParseOpCodes (FormSet
);
2269 if (EFI_ERROR (Status
)) {
2273 gClassOfVfr
= FormSet
->SubClass
;
2274 if (gClassOfVfr
== EFI_FRONT_PAGE_SUBCLASS
) {
2275 FrontPageHandle
= FormSet
->HiiHandle
;
2279 // Match GUID to find out the function key setting. If match fail, use the default setting.
2281 for (Index
= 0; Index
< sizeof (gFunctionKeySettingTable
) / sizeof (FUNCTIION_KEY_SETTING
); Index
++) {
2282 if (CompareGuid (&FormSet
->Guid
, &(gFunctionKeySettingTable
[Index
].FormSetGuid
))) {
2284 // Update the function key setting.
2286 gFunctionKeySetting
= gFunctionKeySettingTable
[Index
].KeySetting
;
2288 // Function key prompt can not be displayed if the function key has been disabled.
2290 if ((gFunctionKeySetting
& FUNCTION_ONE
) != FUNCTION_ONE
) {
2291 gFunctionOneString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
2294 if ((gFunctionKeySetting
& FUNCTION_TWO
) != FUNCTION_TWO
) {
2295 gFunctionTwoString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
2298 if ((gFunctionKeySetting
& FUNCTION_NINE
) != FUNCTION_NINE
) {
2299 gFunctionNineString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
2302 if ((gFunctionKeySetting
& FUNCTION_TEN
) != FUNCTION_TEN
) {
2303 gFunctionTenString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);