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_HII_PACKAGE_LIST_HEADER
*PackageList
;
531 // Locate required Hii relative protocols
533 Status
= gBS
->LocateProtocol (
534 &gEfiHiiDatabaseProtocolGuid
,
536 (VOID
**) &mHiiDatabase
538 ASSERT_EFI_ERROR (Status
);
540 Status
= gBS
->LocateProtocol (
541 &gEfiHiiStringProtocolGuid
,
543 (VOID
**) &mHiiString
545 ASSERT_EFI_ERROR (Status
);
547 Status
= gBS
->LocateProtocol (
548 &gEfiHiiConfigRoutingProtocolGuid
,
550 (VOID
**) &mHiiConfigRouting
552 ASSERT_EFI_ERROR (Status
);
555 // Publish our HII data
557 PackageList
= HiiLibPreparePackageList (1, &gSetupBrowserGuid
, SetupBrowserStrings
);
558 ASSERT (PackageList
!= NULL
);
559 Status
= mHiiDatabase
->NewPackageList (
565 ASSERT_EFI_ERROR (Status
);
568 // Initialize Driver private data
570 BannerData
= AllocateZeroPool (sizeof (BANNER_DATA
));
571 ASSERT (BannerData
!= NULL
);
574 // Install FormBrowser2 protocol
576 mPrivateData
.Handle
= NULL
;
577 Status
= gBS
->InstallProtocolInterface (
578 &mPrivateData
.Handle
,
579 &gEfiFormBrowser2ProtocolGuid
,
580 EFI_NATIVE_INTERFACE
,
581 &mPrivateData
.FormBrowser2
583 ASSERT_EFI_ERROR (Status
);
590 Create a new string in HII Package List.
592 @param String The String to be added
593 @param HiiHandle The package list in the HII database to insert the
596 @return The output string.
602 IN EFI_HII_HANDLE HiiHandle
605 EFI_STRING_ID StringId
;
609 Status
= HiiLibNewString (HiiHandle
, &StringId
, String
);
610 ASSERT_EFI_ERROR (Status
);
617 Delete a string from HII Package List.
619 @param StringId Id of the string in HII database.
620 @param HiiHandle The HII package list handle.
622 @retval EFI_SUCCESS The string was deleted successfully.
627 IN EFI_STRING_ID StringId
,
628 IN EFI_HII_HANDLE HiiHandle
633 NullChar
= CHAR_NULL
;
634 return HiiLibSetString (HiiHandle
, StringId
, &NullChar
);
639 Get the string based on the StringId and HII Package List Handle.
641 @param Token The String's ID.
642 @param HiiHandle The package list in the HII database to search for
643 the specified string.
645 @return The output string.
650 IN EFI_STRING_ID Token
,
651 IN EFI_HII_HANDLE HiiHandle
659 // Set default string size assumption at no more than 256 bytes
661 BufferLength
= 0x100;
662 String
= AllocateZeroPool (BufferLength
);
663 ASSERT (String
!= NULL
);
665 Status
= HiiLibGetString (HiiHandle
, Token
, String
, &BufferLength
);
667 if (Status
== EFI_BUFFER_TOO_SMALL
) {
669 String
= AllocateZeroPool (BufferLength
);
670 ASSERT (String
!= NULL
);
672 Status
= HiiLibGetString (HiiHandle
, Token
, String
, &BufferLength
);
674 ASSERT_EFI_ERROR (Status
);
681 Allocate new memory and then copy the Unicode string Source to Destination.
683 @param Dest Location to copy string
684 @param Src String to copy
689 IN OUT CHAR16
**Dest
,
696 *Dest
= AllocateCopyPool (StrSize (Src
), Src
);
697 ASSERT (*Dest
!= NULL
);
702 Allocate new memory and concatinate Source on the end of Destination.
704 @param Dest String to added to the end of.
705 @param Src String to concatinate.
710 IN OUT CHAR16
**Dest
,
718 NewStringCpy (Dest
, Src
);
722 TmpSize
= StrSize (*Dest
);
723 NewString
= AllocateZeroPool (TmpSize
+ StrSize (Src
) - 1);
724 ASSERT (NewString
!= NULL
);
726 StrCpy (NewString
, *Dest
);
727 StrCat (NewString
, Src
);
735 Synchronize Storage's Edit copy to Shadow copy.
737 @param Storage The Storage to be synchronized.
742 IN FORMSET_STORAGE
*Storage
746 NAME_VALUE_NODE
*Node
;
748 switch (Storage
->Type
) {
749 case EFI_HII_VARSTORE_BUFFER
:
750 CopyMem (Storage
->Buffer
, Storage
->EditBuffer
, Storage
->Size
);
753 case EFI_HII_VARSTORE_NAME_VALUE
:
754 Link
= GetFirstNode (&Storage
->NameValueListHead
);
755 while (!IsNull (&Storage
->NameValueListHead
, Link
)) {
756 Node
= NAME_VALUE_NODE_FROM_LINK (Link
);
758 NewStringCpy (&Node
->Value
, Node
->EditValue
);
760 Link
= GetNextNode (&Storage
->NameValueListHead
, Link
);
764 case EFI_HII_VARSTORE_EFI_VARIABLE
:
772 Get Value for given Name from a NameValue Storage.
774 @param Storage The NameValue Storage.
775 @param Name The Name.
776 @param Value The retured Value.
778 @retval EFI_SUCCESS Value found for given Name.
779 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
784 IN FORMSET_STORAGE
*Storage
,
786 IN OUT CHAR16
**Value
790 NAME_VALUE_NODE
*Node
;
794 Link
= GetFirstNode (&Storage
->NameValueListHead
);
795 while (!IsNull (&Storage
->NameValueListHead
, Link
)) {
796 Node
= NAME_VALUE_NODE_FROM_LINK (Link
);
798 if (StrCmp (Name
, Node
->Name
) == 0) {
799 NewStringCpy (Value
, Node
->EditValue
);
803 Link
= GetNextNode (&Storage
->NameValueListHead
, Link
);
806 return EFI_NOT_FOUND
;
811 Set Value of given Name in a NameValue Storage.
813 @param Storage The NameValue Storage.
814 @param Name The Name.
815 @param Value The Value to set.
817 @retval EFI_SUCCESS Value found for given Name.
818 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
823 IN FORMSET_STORAGE
*Storage
,
829 NAME_VALUE_NODE
*Node
;
831 Link
= GetFirstNode (&Storage
->NameValueListHead
);
832 while (!IsNull (&Storage
->NameValueListHead
, Link
)) {
833 Node
= NAME_VALUE_NODE_FROM_LINK (Link
);
835 if (StrCmp (Name
, Node
->Name
) == 0) {
836 if (Node
->EditValue
!= NULL
) {
837 FreePool (Node
->EditValue
);
839 Node
->EditValue
= AllocateCopyPool (StrSize (Value
), Value
);
840 ASSERT (Node
->EditValue
!= NULL
);
844 Link
= GetNextNode (&Storage
->NameValueListHead
, Link
);
847 return EFI_NOT_FOUND
;
852 Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
854 @param Storage The Storage to be conveted.
855 @param ConfigResp The returned <ConfigResp>.
857 @retval EFI_SUCCESS Convert success.
858 @retval EFI_INVALID_PARAMETER Incorrect storage type.
862 StorageToConfigResp (
863 IN FORMSET_STORAGE
*Storage
,
864 IN CHAR16
**ConfigResp
870 NAME_VALUE_NODE
*Node
;
872 Status
= EFI_SUCCESS
;
874 switch (Storage
->Type
) {
875 case EFI_HII_VARSTORE_BUFFER
:
876 Status
= mHiiConfigRouting
->BlockToConfig (
878 Storage
->ConfigRequest
,
886 case EFI_HII_VARSTORE_NAME_VALUE
:
888 NewStringCat (ConfigResp
, Storage
->ConfigHdr
);
890 Link
= GetFirstNode (&Storage
->NameValueListHead
);
891 while (!IsNull (&Storage
->NameValueListHead
, Link
)) {
892 Node
= NAME_VALUE_NODE_FROM_LINK (Link
);
894 NewStringCat (ConfigResp
, L
"&");
895 NewStringCat (ConfigResp
, Node
->Name
);
896 NewStringCat (ConfigResp
, L
"=");
897 NewStringCat (ConfigResp
, Node
->EditValue
);
899 Link
= GetNextNode (&Storage
->NameValueListHead
, Link
);
903 case EFI_HII_VARSTORE_EFI_VARIABLE
:
905 Status
= EFI_INVALID_PARAMETER
;
914 Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
916 @param Storage The Storage to receive the settings.
917 @param ConfigResp The <ConfigResp> to be converted.
919 @retval EFI_SUCCESS Convert success.
920 @retval EFI_INVALID_PARAMETER Incorrect storage type.
924 ConfigRespToStorage (
925 IN FORMSET_STORAGE
*Storage
,
926 IN CHAR16
*ConfigResp
936 Status
= EFI_SUCCESS
;
938 switch (Storage
->Type
) {
939 case EFI_HII_VARSTORE_BUFFER
:
940 BufferSize
= Storage
->Size
;
941 Status
= mHiiConfigRouting
->ConfigToBlock (
950 case EFI_HII_VARSTORE_NAME_VALUE
:
951 StrPtr
= StrStr (ConfigResp
, L
"&");
952 while (StrPtr
!= NULL
) {
958 StrPtr
= StrStr (StrPtr
, L
"=");
959 if (StrPtr
== NULL
) {
969 StrPtr
= StrStr (StrPtr
, L
"&");
970 if (StrPtr
!= NULL
) {
973 SetValueByName (Storage
, Name
, Value
);
977 case EFI_HII_VARSTORE_EFI_VARIABLE
:
979 Status
= EFI_INVALID_PARAMETER
;
988 Get Question's current Value.
990 @param FormSet FormSet data structure.
991 @param Form Form data structure.
992 @param Question Question to be initialized.
993 @param Cached TRUE: get from Edit copy FALSE: get from original
996 @retval EFI_SUCCESS The function completed successfully.
1001 IN FORM_BROWSER_FORMSET
*FormSet
,
1002 IN FORM_BROWSER_FORM
*Form
,
1003 IN OUT FORM_BROWSER_STATEMENT
*Question
,
1013 FORMSET_STORAGE
*Storage
;
1014 EFI_IFR_TYPE_VALUE
*QuestionValue
;
1015 CHAR16
*ConfigRequest
;
1023 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
)) {
1149 LengthStr
= StrLen (Value
);
1150 Status
= EFI_SUCCESS
;
1153 // Convert Config String to Unicode String, e.g "0041004200430044" => "ABCD"
1154 // Add string tail char L'\0' into Length
1156 Length
= StorageWidth
+ sizeof (CHAR16
);
1157 if (Length
< ((LengthStr
/ 4 + 1) * 2)) {
1158 Status
= EFI_BUFFER_TOO_SMALL
;
1160 StringPtr
= (CHAR16
*) Dst
;
1161 ZeroMem (TemStr
, sizeof (TemStr
));
1162 for (Index
= 0; Index
< LengthStr
; Index
+= 4) {
1163 StrnCpy (TemStr
, Value
+ Index
, 4);
1164 StringPtr
[Index
/4] = (CHAR16
) StrHexToUint64 (TemStr
);
1167 // Add tailing L'\0' character
1169 StringPtr
[Index
/4] = L
'\0';
1172 if (StorageWidth
< ((LengthStr
+ 1) / 2)) {
1173 Status
= EFI_BUFFER_TOO_SMALL
;
1175 ZeroMem (TemStr
, sizeof (TemStr
));
1176 for (Index
= 0; Index
< LengthStr
; Index
++) {
1177 TemStr
[0] = Value
[LengthStr
- Index
- 1];
1178 DigitUint8
= (UINT8
) StrHexToUint64 (TemStr
);
1179 if ((Index
& 1) == 0) {
1180 Dst
[Index
/2] = DigitUint8
;
1182 Dst
[Index
/2] = (UINT8
) ((DigitUint8
<< 4) + Dst
[Index
/2]);
1192 // Request current settings from Configuration Driver
1194 if (FormSet
->ConfigAccess
== NULL
) {
1195 return EFI_NOT_FOUND
;
1199 // <ConfigRequest> ::= <ConfigHdr> + <BlockName> ||
1200 // <ConfigHdr> + "&" + <VariableName>
1202 if (IsBufferStorage
) {
1203 Length
= StrLen (Storage
->ConfigHdr
);
1204 Length
+= StrLen (Question
->BlockName
);
1206 Length
= StrLen (Storage
->ConfigHdr
);
1207 Length
+= StrLen (Question
->VariableName
) + 1;
1209 ConfigRequest
= AllocateZeroPool ((Length
+ 1) * sizeof (CHAR16
));
1210 ASSERT (ConfigRequest
!= NULL
);
1212 StrCpy (ConfigRequest
, Storage
->ConfigHdr
);
1213 if (IsBufferStorage
) {
1214 StrCat (ConfigRequest
, Question
->BlockName
);
1216 StrCat (ConfigRequest
, L
"&");
1217 StrCat (ConfigRequest
, Question
->VariableName
);
1220 Status
= FormSet
->ConfigAccess
->ExtractConfig (
1221 FormSet
->ConfigAccess
,
1226 if (EFI_ERROR (Status
)) {
1231 // Skip <ConfigRequest>
1233 Value
= Result
+ Length
;
1234 if (IsBufferStorage
) {
1240 if (*Value
!= '=') {
1242 return EFI_NOT_FOUND
;
1245 // Skip '=', point to value
1250 // Suppress <AltResp> if any
1253 while (*StringPtr
!= L
'\0' && *StringPtr
!= L
'&') {
1258 LengthStr
= StrLen (Value
);
1259 Status
= EFI_SUCCESS
;
1260 if (!IsBufferStorage
&& IsString
) {
1262 // Convert Config String to Unicode String, e.g "0041004200430044" => "ABCD"
1263 // Add string tail char L'\0' into Length
1265 Length
= StorageWidth
+ sizeof (CHAR16
);
1266 if (Length
< ((LengthStr
/ 4 + 1) * 2)) {
1267 Status
= EFI_BUFFER_TOO_SMALL
;
1269 StringPtr
= (CHAR16
*) Dst
;
1270 ZeroMem (TemStr
, sizeof (TemStr
));
1271 for (Index
= 0; Index
< LengthStr
; Index
+= 4) {
1272 StrnCpy (TemStr
, Value
+ Index
, 4);
1273 StringPtr
[Index
/4] = (CHAR16
) StrHexToUint64 (TemStr
);
1276 // Add tailing L'\0' character
1278 StringPtr
[Index
/4] = L
'\0';
1281 if (StorageWidth
< ((LengthStr
+ 1) / 2)) {
1282 Status
= EFI_BUFFER_TOO_SMALL
;
1284 ZeroMem (TemStr
, sizeof (TemStr
));
1285 for (Index
= 0; Index
< LengthStr
; Index
++) {
1286 TemStr
[0] = Value
[LengthStr
- Index
- 1];
1287 DigitUint8
= (UINT8
) StrHexToUint64 (TemStr
);
1288 if ((Index
& 1) == 0) {
1289 Dst
[Index
/2] = DigitUint8
;
1291 Dst
[Index
/2] = (UINT8
) ((DigitUint8
<< 4) + Dst
[Index
/2]);
1297 if (EFI_ERROR (Status
)) {
1303 // Synchronize Edit Buffer
1305 if (IsBufferStorage
) {
1306 CopyMem (Storage
->EditBuffer
+ Question
->VarStoreInfo
.VarOffset
, Dst
, StorageWidth
);
1308 SetValueByName (Storage
, Question
->VariableName
, Value
);
1319 Save Question Value to edit copy(cached) or Storage(uncached).
1321 @param FormSet FormSet data structure.
1322 @param Form Form data structure.
1323 @param Question Pointer to the Question.
1324 @param Cached TRUE: set to Edit copy FALSE: set to original
1327 @retval EFI_SUCCESS The function completed successfully.
1332 IN FORM_BROWSER_FORMSET
*FormSet
,
1333 IN FORM_BROWSER_FORM
*Form
,
1334 IN OUT FORM_BROWSER_STATEMENT
*Question
,
1345 FORMSET_STORAGE
*Storage
;
1346 EFI_IFR_TYPE_VALUE
*QuestionValue
;
1351 BOOLEAN IsBufferStorage
;
1358 Status
= EFI_SUCCESS
;
1361 // Statement don't have storage, skip them
1363 if (Question
->QuestionId
== 0) {
1368 // If Question value is provided by an Expression, then it is read only
1370 if (Question
->ValueExpression
!= NULL
) {
1375 // Question value is provided by RTC
1377 Storage
= Question
->Storage
;
1378 QuestionValue
= &Question
->HiiValue
.Value
;
1379 if (Storage
== NULL
) {
1381 // It's a Question without storage, or RTC date/time
1383 if (Question
->Operand
== EFI_IFR_DATE_OP
|| Question
->Operand
== EFI_IFR_TIME_OP
) {
1385 // Date and time define the same Flags bit
1387 switch (Question
->Flags
& EFI_QF_DATE_STORAGE
) {
1388 case QF_DATE_STORAGE_TIME
:
1389 Status
= gRT
->GetTime (&EfiTime
, NULL
);
1392 case QF_DATE_STORAGE_WAKEUP
:
1393 Status
= gRT
->GetWakeupTime (&Enabled
, &Pending
, &EfiTime
);
1396 case QF_DATE_STORAGE_NORMAL
:
1399 // For date/time without storage
1404 if (EFI_ERROR (Status
)) {
1408 if (Question
->Operand
== EFI_IFR_DATE_OP
) {
1409 EfiTime
.Year
= QuestionValue
->date
.Year
;
1410 EfiTime
.Month
= QuestionValue
->date
.Month
;
1411 EfiTime
.Day
= QuestionValue
->date
.Day
;
1413 EfiTime
.Hour
= QuestionValue
->time
.Hour
;
1414 EfiTime
.Minute
= QuestionValue
->time
.Minute
;
1415 EfiTime
.Second
= QuestionValue
->time
.Second
;
1418 if ((Question
->Flags
& EFI_QF_DATE_STORAGE
) == QF_DATE_STORAGE_TIME
) {
1419 Status
= gRT
->SetTime (&EfiTime
);
1421 Status
= gRT
->SetWakeupTime (TRUE
, &EfiTime
);
1429 // Question value is provided by EFI variable
1431 StorageWidth
= Question
->StorageWidth
;
1432 if (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
1433 if (Question
->BufferValue
!= NULL
) {
1434 Src
= Question
->BufferValue
;
1436 Src
= (UINT8
*) QuestionValue
;
1439 Status
= gRT
->SetVariable (
1440 Question
->VariableName
,
1442 Storage
->Attributes
,
1450 // Question Value is provided by Buffer Storage or NameValue Storage
1452 if (Question
->BufferValue
!= NULL
) {
1453 Src
= Question
->BufferValue
;
1455 Src
= (UINT8
*) &Question
->HiiValue
.Value
;
1458 IsBufferStorage
= (BOOLEAN
) ((Storage
->Type
== EFI_HII_VARSTORE_BUFFER
) ? TRUE
: FALSE
);
1459 IsString
= (BOOLEAN
) ((Question
->HiiValue
.Type
== EFI_IFR_TYPE_STRING
) ? TRUE
: FALSE
);
1460 if (IsBufferStorage
) {
1462 // Copy to storage edit buffer
1464 CopyMem (Storage
->EditBuffer
+ Question
->VarStoreInfo
.VarOffset
, Src
, StorageWidth
);
1468 // Allocate enough string buffer.
1471 BufferLen
= ((StrLen ((CHAR16
*) Src
) * 4) + 1) * sizeof (CHAR16
);
1472 Value
= AllocateZeroPool (BufferLen
);
1473 ASSERT (Value
!= NULL
);
1475 // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"
1477 TemName
= (CHAR16
*) Src
;
1479 for (; *TemName
!= L
'\0'; TemName
++) {
1480 TemString
+= UnicodeValueToString (TemString
, PREFIX_ZERO
| RADIX_HEX
, *TemName
, 4);
1483 BufferLen
= StorageWidth
* 2 + 1;
1484 Value
= AllocateZeroPool (BufferLen
* sizeof (CHAR16
));
1485 ASSERT (Value
!= NULL
);
1487 // Convert Buffer to Hex String
1489 TemBuffer
= Src
+ StorageWidth
- 1;
1491 for (Index
= 0; Index
< StorageWidth
; Index
++, TemBuffer
--) {
1492 TemString
+= UnicodeValueToString (TemString
, PREFIX_ZERO
| RADIX_HEX
, *TemBuffer
, 2);
1496 Status
= SetValueByName (Storage
, Question
->VariableName
, Value
);
1502 // <ConfigResp> ::= <ConfigHdr> + <BlockName> + "&VALUE=" + "<HexCh>StorageWidth * 2" ||
1503 // <ConfigHdr> + "&" + <VariableName> + "=" + "<string>"
1505 if (IsBufferStorage
) {
1506 Length
= StrLen (Question
->BlockName
) + 7;
1508 Length
= StrLen (Question
->VariableName
) + 2;
1510 if (!IsBufferStorage
&& IsString
) {
1511 Length
+= (StrLen ((CHAR16
*) Src
) * 4);
1513 Length
+= (StorageWidth
* 2);
1515 ConfigResp
= AllocateZeroPool ((StrLen (Storage
->ConfigHdr
) + Length
+ 1) * sizeof (CHAR16
));
1516 ASSERT (ConfigResp
!= NULL
);
1518 StrCpy (ConfigResp
, Storage
->ConfigHdr
);
1519 if (IsBufferStorage
) {
1520 StrCat (ConfigResp
, Question
->BlockName
);
1521 StrCat (ConfigResp
, L
"&VALUE=");
1523 StrCat (ConfigResp
, L
"&");
1524 StrCat (ConfigResp
, Question
->VariableName
);
1525 StrCat (ConfigResp
, L
"=");
1528 Value
= ConfigResp
+ StrLen (ConfigResp
);
1530 if (!IsBufferStorage
&& IsString
) {
1532 // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"
1534 TemName
= (CHAR16
*) Src
;
1536 for (; *TemName
!= L
'\0'; TemName
++) {
1537 TemString
+= UnicodeValueToString (TemString
, PREFIX_ZERO
| RADIX_HEX
, *TemName
, 4);
1541 // Convert Buffer to Hex String
1543 TemBuffer
= Src
+ StorageWidth
- 1;
1545 for (Index
= 0; Index
< StorageWidth
; Index
++, TemBuffer
--) {
1546 TemString
+= UnicodeValueToString (TemString
, PREFIX_ZERO
| RADIX_HEX
, *TemBuffer
, 2);
1551 // Convert to lower char.
1553 for (TemString
= Value
; *Value
!= L
'\0'; Value
++) {
1554 if (*Value
>= L
'A' && *Value
<= L
'Z') {
1555 *Value
= (CHAR16
) (*Value
- L
'A' + L
'a');
1560 // Submit Question Value to Configuration Driver
1562 if (FormSet
->ConfigAccess
!= NULL
) {
1563 Status
= FormSet
->ConfigAccess
->RouteConfig (
1564 FormSet
->ConfigAccess
,
1568 if (EFI_ERROR (Status
)) {
1569 FreePool (ConfigResp
);
1573 FreePool (ConfigResp
);
1576 // Synchronize shadow Buffer
1578 SynchronizeStorage (Storage
);
1586 Perform inconsistent check for a Form.
1588 @param FormSet FormSet data structure.
1589 @param Form Form data structure.
1590 @param Question The Question to be validated.
1591 @param Type Validation type: InConsistent or NoSubmit
1593 @retval EFI_SUCCESS Form validation pass.
1594 @retval other Form validation failed.
1599 IN FORM_BROWSER_FORMSET
*FormSet
,
1600 IN FORM_BROWSER_FORM
*Form
,
1601 IN FORM_BROWSER_STATEMENT
*Question
,
1607 LIST_ENTRY
*ListHead
;
1610 FORM_EXPRESSION
*Expression
;
1612 if (Type
== EFI_HII_EXPRESSION_INCONSISTENT_IF
) {
1613 ListHead
= &Question
->InconsistentListHead
;
1614 } else if (Type
== EFI_HII_EXPRESSION_NO_SUBMIT_IF
) {
1615 ListHead
= &Question
->NoSubmitListHead
;
1617 return EFI_UNSUPPORTED
;
1620 Link
= GetFirstNode (ListHead
);
1621 while (!IsNull (ListHead
, Link
)) {
1622 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
1625 // Evaluate the expression
1627 Status
= EvaluateExpression (FormSet
, Form
, Expression
);
1628 if (EFI_ERROR (Status
)) {
1632 if (Expression
->Result
.Value
.b
) {
1634 // Condition meet, show up error message
1636 if (Expression
->Error
!= 0) {
1637 PopUp
= GetToken (Expression
->Error
, FormSet
->HiiHandle
);
1639 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, PopUp
, gPressEnter
, gEmptyString
);
1640 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
1644 return EFI_NOT_READY
;
1647 Link
= GetNextNode (ListHead
, Link
);
1655 Perform NoSubmit check for a Form.
1657 @param FormSet FormSet data structure.
1658 @param Form Form data structure.
1660 @retval EFI_SUCCESS Form validation pass.
1661 @retval other Form validation failed.
1666 IN FORM_BROWSER_FORMSET
*FormSet
,
1667 IN FORM_BROWSER_FORM
*Form
1672 FORM_BROWSER_STATEMENT
*Question
;
1674 Link
= GetFirstNode (&Form
->StatementListHead
);
1675 while (!IsNull (&Form
->StatementListHead
, Link
)) {
1676 Question
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
1678 Status
= ValidateQuestion (FormSet
, Form
, Question
, EFI_HII_EXPRESSION_NO_SUBMIT_IF
);
1679 if (EFI_ERROR (Status
)) {
1683 Link
= GetNextNode (&Form
->StatementListHead
, Link
);
1693 @param FormSet FormSet data structure.
1694 @param Form Form data structure.
1696 @retval EFI_SUCCESS The function completed successfully.
1701 IN FORM_BROWSER_FORMSET
*FormSet
,
1702 IN FORM_BROWSER_FORM
*Form
1707 EFI_STRING ConfigResp
;
1708 EFI_STRING Progress
;
1709 FORMSET_STORAGE
*Storage
;
1712 // Validate the Form by NoSubmit check
1714 Status
= NoSubmitCheck (FormSet
, Form
);
1715 if (EFI_ERROR (Status
)) {
1720 // Submit Buffer storage or Name/Value storage
1722 Link
= GetFirstNode (&FormSet
->StorageListHead
);
1723 while (!IsNull (&FormSet
->StorageListHead
, Link
)) {
1724 Storage
= FORMSET_STORAGE_FROM_LINK (Link
);
1725 Link
= GetNextNode (&FormSet
->StorageListHead
, Link
);
1727 if (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
1732 // Skip if there is no RequestElement
1734 if (Storage
->ElementCount
== 0) {
1739 // Prepare <ConfigResp>
1741 Status
= StorageToConfigResp (Storage
, &ConfigResp
);
1742 if (EFI_ERROR (Status
)) {
1747 // Send <ConfigResp> to Configuration Driver
1749 if (FormSet
->ConfigAccess
!= NULL
) {
1750 Status
= FormSet
->ConfigAccess
->RouteConfig (
1751 FormSet
->ConfigAccess
,
1755 if (EFI_ERROR (Status
)) {
1756 FreePool (ConfigResp
);
1760 FreePool (ConfigResp
);
1763 // Config success, update storage shadow Buffer
1765 SynchronizeStorage (Storage
);
1768 gNvUpdateRequired
= FALSE
;
1775 Reset Question to its default value.
1777 @param FormSet The form set.
1778 @param Form The form.
1779 @param Question The question.
1780 @param DefaultId The Class of the default.
1782 @retval EFI_SUCCESS Question is reset to default value.
1786 GetQuestionDefault (
1787 IN FORM_BROWSER_FORMSET
*FormSet
,
1788 IN FORM_BROWSER_FORM
*Form
,
1789 IN FORM_BROWSER_STATEMENT
*Question
,
1795 QUESTION_DEFAULT
*Default
;
1796 QUESTION_OPTION
*Option
;
1797 EFI_HII_VALUE
*HiiValue
;
1800 Status
= EFI_SUCCESS
;
1803 // Statement don't have storage, skip them
1805 if (Question
->QuestionId
== 0) {
1810 // There are three ways to specify default value for a Question:
1811 // 1, use nested EFI_IFR_DEFAULT (highest priority)
1812 // 2, set flags of EFI_ONE_OF_OPTION (provide Standard and Manufacturing default)
1813 // 3, set flags of EFI_IFR_CHECKBOX (provide Standard and Manufacturing default) (lowest priority)
1815 HiiValue
= &Question
->HiiValue
;
1818 // EFI_IFR_DEFAULT has highest priority
1820 if (!IsListEmpty (&Question
->DefaultListHead
)) {
1821 Link
= GetFirstNode (&Question
->DefaultListHead
);
1822 while (!IsNull (&Question
->DefaultListHead
, Link
)) {
1823 Default
= QUESTION_DEFAULT_FROM_LINK (Link
);
1825 if (Default
->DefaultId
== DefaultId
) {
1826 if (Default
->ValueExpression
!= NULL
) {
1828 // Default is provided by an Expression, evaluate it
1830 Status
= EvaluateExpression (FormSet
, Form
, Default
->ValueExpression
);
1831 if (EFI_ERROR (Status
)) {
1835 CopyMem (HiiValue
, &Default
->ValueExpression
->Result
, sizeof (EFI_HII_VALUE
));
1838 // Default value is embedded in EFI_IFR_DEFAULT
1840 CopyMem (HiiValue
, &Default
->Value
, sizeof (EFI_HII_VALUE
));
1846 Link
= GetNextNode (&Question
->DefaultListHead
, Link
);
1851 // EFI_ONE_OF_OPTION
1853 if ((Question
->Operand
== EFI_IFR_ONE_OF_OP
) && !IsListEmpty (&Question
->OptionListHead
)) {
1854 if (DefaultId
<= EFI_HII_DEFAULT_CLASS_MANUFACTURING
) {
1856 // OneOfOption could only provide Standard and Manufacturing default
1858 Link
= GetFirstNode (&Question
->OptionListHead
);
1859 while (!IsNull (&Question
->OptionListHead
, Link
)) {
1860 Option
= QUESTION_OPTION_FROM_LINK (Link
);
1862 if (((DefaultId
== EFI_HII_DEFAULT_CLASS_STANDARD
) && ((Option
->Flags
& EFI_IFR_OPTION_DEFAULT
) != 0)) ||
1863 ((DefaultId
== EFI_HII_DEFAULT_CLASS_MANUFACTURING
) && ((Option
->Flags
& EFI_IFR_OPTION_DEFAULT_MFG
) != 0))
1865 CopyMem (HiiValue
, &Option
->Value
, sizeof (EFI_HII_VALUE
));
1870 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
1876 // EFI_IFR_CHECKBOX - lowest priority
1878 if (Question
->Operand
== EFI_IFR_CHECKBOX_OP
) {
1879 if (DefaultId
<= EFI_HII_DEFAULT_CLASS_MANUFACTURING
) {
1881 // Checkbox could only provide Standard and Manufacturing default
1883 if (((DefaultId
== EFI_HII_DEFAULT_CLASS_STANDARD
) && ((Question
->Flags
& EFI_IFR_CHECKBOX_DEFAULT
) != 0)) ||
1884 ((DefaultId
== EFI_HII_DEFAULT_CLASS_MANUFACTURING
) && ((Question
->Flags
& EFI_IFR_CHECKBOX_DEFAULT_MFG
) != 0))
1886 HiiValue
->Value
.b
= TRUE
;
1888 HiiValue
->Value
.b
= FALSE
;
1896 // For Questions without default
1898 switch (Question
->Operand
) {
1899 case EFI_IFR_NUMERIC_OP
:
1901 // Take minimal value as numeric's default value
1903 HiiValue
->Value
.u64
= Question
->Minimum
;
1906 case EFI_IFR_ONE_OF_OP
:
1908 // Take first oneof option as oneof's default value
1910 Link
= GetFirstNode (&Question
->OptionListHead
);
1911 if (!IsNull (&Question
->OptionListHead
, Link
)) {
1912 Option
= QUESTION_OPTION_FROM_LINK (Link
);
1913 CopyMem (HiiValue
, &Option
->Value
, sizeof (EFI_HII_VALUE
));
1917 case EFI_IFR_ORDERED_LIST_OP
:
1919 // Take option sequence in IFR as ordered list's default value
1922 Link
= GetFirstNode (&Question
->OptionListHead
);
1923 while (!IsNull (&Question
->OptionListHead
, Link
)) {
1924 Option
= QUESTION_OPTION_FROM_LINK (Link
);
1926 Question
->BufferValue
[Index
] = Option
->Value
.Value
.u8
;
1929 if (Index
>= Question
->MaxContainers
) {
1933 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
1938 Status
= EFI_NOT_FOUND
;
1947 Reset Questions in a Form to their default value.
1949 @param FormSet FormSet data structure.
1950 @param Form The Form which to be reset.
1951 @param DefaultId The Class of the default.
1953 @retval EFI_SUCCESS The function completed successfully.
1957 ExtractFormDefault (
1958 IN FORM_BROWSER_FORMSET
*FormSet
,
1959 IN FORM_BROWSER_FORM
*Form
,
1965 FORM_BROWSER_STATEMENT
*Question
;
1967 Link
= GetFirstNode (&Form
->StatementListHead
);
1968 while (!IsNull (&Form
->StatementListHead
, Link
)) {
1969 Question
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
1970 Link
= GetNextNode (&Form
->StatementListHead
, Link
);
1973 // If Question is suppressed, don't reset it to default
1975 if (Question
->SuppressExpression
!= NULL
) {
1976 Status
= EvaluateExpression (FormSet
, Form
, Question
->SuppressExpression
);
1977 if (!EFI_ERROR (Status
) && Question
->SuppressExpression
->Result
.Value
.b
) {
1983 // Reset Question to its default value
1985 Status
= GetQuestionDefault (FormSet
, Form
, Question
, DefaultId
);
1986 if (EFI_ERROR (Status
)) {
1991 // Synchronize Buffer storage's Edit buffer
1993 if ((Question
->Storage
!= NULL
) &&
1994 (Question
->Storage
->Type
!= EFI_HII_VARSTORE_EFI_VARIABLE
)) {
1995 SetQuestionValue (FormSet
, Form
, Question
, TRUE
);
2004 Initialize Question's Edit copy from Storage.
2006 @param FormSet FormSet data structure.
2007 @param Form Form data structure.
2009 @retval EFI_SUCCESS The function completed successfully.
2014 IN FORM_BROWSER_FORMSET
*FormSet
,
2015 IN FORM_BROWSER_FORM
*Form
2020 FORM_BROWSER_STATEMENT
*Question
;
2022 Link
= GetFirstNode (&Form
->StatementListHead
);
2023 while (!IsNull (&Form
->StatementListHead
, Link
)) {
2024 Question
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
2027 // Initialize local copy of Value for each Question
2029 Status
= GetQuestionValue (FormSet
, Form
, Question
, TRUE
);
2030 if (EFI_ERROR (Status
)) {
2034 Link
= GetNextNode (&Form
->StatementListHead
, Link
);
2042 Fill storage's edit copy with settings requested from Configuration Driver.
2044 @param FormSet FormSet data structure.
2045 @param Storage Buffer Storage.
2047 @retval EFI_SUCCESS The function completed successfully.
2052 IN FORM_BROWSER_FORMSET
*FormSet
,
2053 IN FORMSET_STORAGE
*Storage
2057 EFI_STRING Progress
;
2061 if (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
2065 if (FormSet
->ConfigAccess
== NULL
) {
2066 return EFI_NOT_FOUND
;
2069 if (Storage
->ElementCount
== 0) {
2071 // Skip if there is no RequestElement
2077 // Request current settings from Configuration Driver
2079 Status
= FormSet
->ConfigAccess
->ExtractConfig (
2080 FormSet
->ConfigAccess
,
2081 Storage
->ConfigRequest
,
2085 if (EFI_ERROR (Status
)) {
2090 // Convert Result from <ConfigAltResp> to <ConfigResp>
2092 StrPtr
= StrStr (Result
, L
"ALTCFG");
2093 if (StrPtr
!= NULL
) {
2097 Status
= ConfigRespToStorage (Storage
, Result
);
2104 Get current setting of Questions.
2106 @param FormSet FormSet data structure.
2108 @retval EFI_SUCCESS The function completed successfully.
2112 InitializeCurrentSetting (
2113 IN OUT FORM_BROWSER_FORMSET
*FormSet
2117 FORMSET_STORAGE
*Storage
;
2118 FORM_BROWSER_FORM
*Form
;
2122 // Extract default from IFR binary
2124 Link
= GetFirstNode (&FormSet
->FormListHead
);
2125 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
2126 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
2128 Status
= ExtractFormDefault (FormSet
, Form
, EFI_HII_DEFAULT_CLASS_STANDARD
);
2130 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
2134 // Request current settings from Configuration Driver
2136 Link
= GetFirstNode (&FormSet
->StorageListHead
);
2137 while (!IsNull (&FormSet
->StorageListHead
, Link
)) {
2138 Storage
= FORMSET_STORAGE_FROM_LINK (Link
);
2140 Status
= LoadStorage (FormSet
, Storage
);
2143 // Now Edit Buffer is filled with default values(lower priority) and current
2144 // settings(higher priority), sychronize it to shadow Buffer
2146 if (!EFI_ERROR (Status
)) {
2147 SynchronizeStorage (Storage
);
2150 Link
= GetNextNode (&FormSet
->StorageListHead
, Link
);
2158 Fetch the Ifr binary data of a FormSet.
2160 @param Handle PackageList Handle
2161 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
2162 GUID), take the first FormSet found in package
2164 @param BinaryLength The length of the FormSet IFR binary.
2165 @param BinaryData The buffer designed to receive the FormSet.
2167 @retval EFI_SUCCESS Buffer filled with the requested FormSet.
2168 BufferLength was updated.
2169 @retval EFI_INVALID_PARAMETER The handle is unknown.
2170 @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot
2171 be found with the requested FormId.
2176 IN EFI_HII_HANDLE Handle
,
2177 IN OUT EFI_GUID
*FormSetGuid
,
2178 OUT UINTN
*BinaryLength
,
2179 OUT UINT8
**BinaryData
2183 EFI_HII_PACKAGE_LIST_HEADER
*HiiPackageList
;
2189 BOOLEAN ReturnDefault
;
2190 UINT32 PackageListLength
;
2191 EFI_HII_PACKAGE_HEADER PackageHeader
;
2195 ZeroMem (&PackageHeader
, sizeof (EFI_HII_PACKAGE_HEADER
));;
2198 // if FormSetGuid is NULL or zero GUID, return first FormSet in the package list
2200 if (FormSetGuid
== NULL
|| CompareGuid (FormSetGuid
, &gZeroGuid
)) {
2201 ReturnDefault
= TRUE
;
2203 ReturnDefault
= FALSE
;
2207 // Get HII PackageList
2210 HiiPackageList
= NULL
;
2211 Status
= mHiiDatabase
->ExportPackageLists (mHiiDatabase
, Handle
, &BufferSize
, HiiPackageList
);
2212 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2213 HiiPackageList
= AllocatePool (BufferSize
);
2214 ASSERT (HiiPackageList
!= NULL
);
2216 Status
= mHiiDatabase
->ExportPackageLists (mHiiDatabase
, Handle
, &BufferSize
, HiiPackageList
);
2218 if (EFI_ERROR (Status
)) {
2221 ASSERT (HiiPackageList
!= NULL
);
2224 // Get Form package from this HII package List
2226 Offset
= sizeof (EFI_HII_PACKAGE_LIST_HEADER
);
2228 CopyMem (&PackageListLength
, &HiiPackageList
->PackageLength
, sizeof (UINT32
));
2230 while (Offset
< PackageListLength
) {
2231 Package
= ((UINT8
*) HiiPackageList
) + Offset
;
2232 CopyMem (&PackageHeader
, Package
, sizeof (EFI_HII_PACKAGE_HEADER
));
2234 if (PackageHeader
.Type
== EFI_HII_PACKAGE_FORMS
) {
2236 // Search FormSet in this Form Package
2238 Offset2
= sizeof (EFI_HII_PACKAGE_HEADER
);
2239 while (Offset2
< PackageHeader
.Length
) {
2240 OpCodeData
= Package
+ Offset2
;
2242 if (((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
== EFI_IFR_FORM_SET_OP
) {
2244 // Check whether return default FormSet
2246 if (ReturnDefault
) {
2251 // FormSet GUID is specified, check it
2253 if (CompareGuid (FormSetGuid
, (EFI_GUID
*)(OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
)))) {
2258 Offset2
+= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
2261 if (Offset2
< PackageHeader
.Length
) {
2263 // Target formset found
2269 Offset
+= PackageHeader
.Length
;
2272 if (Offset
>= PackageListLength
) {
2274 // Form package not found in this Package List
2276 FreePool (HiiPackageList
);
2277 return EFI_NOT_FOUND
;
2280 if (ReturnDefault
&& FormSetGuid
!= NULL
) {
2282 // Return the default FormSet GUID
2284 CopyMem (FormSetGuid
, &((EFI_IFR_FORM_SET
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
));
2288 // To determine the length of a whole FormSet IFR binary, one have to parse all the Opcodes
2289 // in this FormSet; So, here just simply copy the data from start of a FormSet to the end
2290 // of the Form Package.
2292 *BinaryLength
= PackageHeader
.Length
- Offset2
;
2293 *BinaryData
= AllocateCopyPool (*BinaryLength
, OpCodeData
);
2295 FreePool (HiiPackageList
);
2297 if (*BinaryData
== NULL
) {
2298 return EFI_OUT_OF_RESOURCES
;
2306 Initialize the internal data structure of a FormSet.
2308 @param Handle PackageList Handle
2309 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
2310 GUID), take the first FormSet found in package
2312 @param FormSet FormSet data structure.
2314 @retval EFI_SUCCESS The function completed successfully.
2315 @retval EFI_NOT_FOUND The specified FormSet could not be found.
2320 IN EFI_HII_HANDLE Handle
,
2321 IN OUT EFI_GUID
*FormSetGuid
,
2322 OUT FORM_BROWSER_FORMSET
*FormSet
2326 EFI_HANDLE DriverHandle
;
2329 Status
= GetIfrBinaryData (Handle
, FormSetGuid
, &FormSet
->IfrBinaryLength
, &FormSet
->IfrBinaryData
);
2330 if (EFI_ERROR (Status
)) {
2334 FormSet
->HiiHandle
= Handle
;
2335 CopyMem (&FormSet
->Guid
, FormSetGuid
, sizeof (EFI_GUID
));
2338 // Retrieve ConfigAccess Protocol associated with this HiiPackageList
2340 Status
= mHiiDatabase
->GetPackageListHandle (mHiiDatabase
, Handle
, &DriverHandle
);
2341 if (EFI_ERROR (Status
)) {
2344 FormSet
->DriverHandle
= DriverHandle
;
2345 Status
= gBS
->HandleProtocol (
2347 &gEfiHiiConfigAccessProtocolGuid
,
2348 (VOID
**) &FormSet
->ConfigAccess
2350 if (EFI_ERROR (Status
)) {
2352 // Configuration Driver don't attach ConfigAccess protocol to its HII package
2353 // list, then there will be no configuration action required
2355 FormSet
->ConfigAccess
= NULL
;
2359 // Parse the IFR binary OpCodes
2361 Status
= ParseOpCodes (FormSet
);
2362 if (EFI_ERROR (Status
)) {
2366 gClassOfVfr
= FormSet
->SubClass
;
2367 if (gClassOfVfr
== EFI_FRONT_PAGE_SUBCLASS
) {
2368 FrontPageHandle
= FormSet
->HiiHandle
;
2372 // Match GUID to find out the function key setting. If match fail, use the default setting.
2374 for (Index
= 0; Index
< sizeof (gFunctionKeySettingTable
) / sizeof (FUNCTIION_KEY_SETTING
); Index
++) {
2375 if (CompareGuid (&FormSet
->Guid
, &(gFunctionKeySettingTable
[Index
].FormSetGuid
))) {
2377 // Update the function key setting.
2379 gFunctionKeySetting
= gFunctionKeySettingTable
[Index
].KeySetting
;
2381 // Function key prompt can not be displayed if the function key has been disabled.
2383 if ((gFunctionKeySetting
& FUNCTION_ONE
) != FUNCTION_ONE
) {
2384 gFunctionOneString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
2387 if ((gFunctionKeySetting
& FUNCTION_TWO
) != FUNCTION_TWO
) {
2388 gFunctionTwoString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
2391 if ((gFunctionKeySetting
& FUNCTION_NINE
) != FUNCTION_NINE
) {
2392 gFunctionNineString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);
2395 if ((gFunctionKeySetting
& FUNCTION_TEN
) != FUNCTION_TEN
) {
2396 gFunctionTenString
= GetToken (STRING_TOKEN (EMPTY_STRING
), gHiiHandle
);