2 Private MACRO, structure and function definitions for Setup Browser module.
4 Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>
5 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.
22 #include <Protocol/SimpleTextOut.h>
23 #include <Protocol/SimpleTextIn.h>
24 #include <Protocol/FormBrowser2.h>
25 #include <Protocol/FormBrowserEx.h>
26 #include <Protocol/DevicePath.h>
27 #include <Protocol/UnicodeCollation.h>
28 #include <Protocol/HiiConfigAccess.h>
29 #include <Protocol/HiiConfigRouting.h>
30 #include <Protocol/HiiDatabase.h>
31 #include <Protocol/HiiString.h>
32 #include <Protocol/UserManager.h>
34 #include <Guid/MdeModuleHii.h>
35 #include <Guid/HiiPlatformSetupFormset.h>
36 #include <Guid/HiiFormMapMethodGuid.h>
38 #include <Library/PrintLib.h>
39 #include <Library/DebugLib.h>
40 #include <Library/BaseMemoryLib.h>
41 #include <Library/UefiRuntimeServicesTableLib.h>
42 #include <Library/UefiDriverEntryPoint.h>
43 #include <Library/UefiBootServicesTableLib.h>
44 #include <Library/BaseLib.h>
45 #include <Library/MemoryAllocationLib.h>
46 #include <Library/HiiLib.h>
47 #include <Library/PcdLib.h>
48 #include <Library/DevicePathLib.h>
53 // This is the generated header file which includes whatever needs to be exported (strings + IFR)
56 extern UINT8 SetupBrowserStrings
[];
61 #define BANNER_HEIGHT 6
62 #define BANNER_COLUMNS 3
63 #define BANNER_LEFT_COLUMN_INDENT 1
65 #define FRONT_PAGE_HEADER_HEIGHT 6
66 #define NONE_FRONT_PAGE_HEADER_HEIGHT 3
67 #define LEFT_SKIPPED_COLUMNS 3
68 #define FOOTER_HEIGHT 4
69 #define STATUS_BAR_HEIGHT 1
70 #define SCROLL_ARROW_HEIGHT 1
71 #define POPUP_PAD_SPACE_COUNT 5
72 #define POPUP_FRAME_WIDTH 2
75 // Definition for function key setting
77 #define NONE_FUNCTION_KEY_SETTING 0
78 #define ENABLE_FUNCTION_KEY_SETTING 1
83 } FUNCTIION_KEY_SETTING
;
86 // Character definitions
88 #define CHAR_SPACE 0x0020
89 #define UPPER_LOWER_CASE_OFFSET 0x20
94 #define ONE_SECOND 10000000
97 // Display definitions
99 #define LEFT_HYPER_DELIMITER L'<'
100 #define RIGHT_HYPER_DELIMITER L'>'
102 #define LEFT_ONEOF_DELIMITER L'<'
103 #define RIGHT_ONEOF_DELIMITER L'>'
105 #define LEFT_NUMERIC_DELIMITER L'['
106 #define RIGHT_NUMERIC_DELIMITER L']'
108 #define LEFT_CHECKBOX_DELIMITER L'['
109 #define RIGHT_CHECKBOX_DELIMITER L']'
111 #define CHECK_ON L'X'
112 #define CHECK_OFF L' '
114 #define TIME_SEPARATOR L':'
115 #define DATE_SEPARATOR L'/'
117 #define YES_ANSWER L'Y'
118 #define NO_ANSWER L'N'
121 // This is the Input Error Message
123 #define INPUT_ERROR 1
126 // This is the NV RAM update required Message
128 #define NV_UPDATE_REQUIRED 2
131 // Refresh the Status Bar with flags
133 #define REFRESH_STATUS_BAR 0xff
136 // Incremental string lenght of ConfigRequest
138 #define CONFIG_REQUEST_STRING_INCREMENTAL 1024
141 // HII value compare result
143 #define HII_VALUE_UNDEFINED 0
144 #define HII_VALUE_EQUAL 1
145 #define HII_VALUE_LESS_THAN 2
146 #define HII_VALUE_GREATER_THAN 3
149 // Incremental size of stack for expression
151 #define EXPRESSION_STACK_SIZE_INCREMENT 0x100
153 #define EFI_IFR_SPECIFICATION_VERSION (UINT16) (((EFI_SYSTEM_TABLE_REVISION >> 16) << 8) | (((EFI_SYSTEM_TABLE_REVISION & 0xFFFF) / 10) << 4) | ((EFI_SYSTEM_TABLE_REVISION & 0xFFFF) % 10))
156 #define SETUP_DRIVER_SIGNATURE SIGNATURE_32 ('F', 'B', 'D', 'V')
165 EFI_FORM_BROWSER2_PROTOCOL FormBrowser2
;
167 EFI_FORM_BROWSER_EXTENSION_PROTOCOL FormBrowserEx
;
169 } SETUP_DRIVER_PRIVATE_DATA
;
172 EFI_STRING_ID Banner
[BANNER_HEIGHT
][BANNER_COLUMNS
];
176 // IFR relative definition
178 #define EFI_HII_EXPRESSION_INCONSISTENT_IF 0
179 #define EFI_HII_EXPRESSION_NO_SUBMIT_IF 1
180 #define EFI_HII_EXPRESSION_GRAY_OUT_IF 2
181 #define EFI_HII_EXPRESSION_SUPPRESS_IF 3
182 #define EFI_HII_EXPRESSION_DISABLE_IF 4
183 #define EFI_HII_EXPRESSION_VALUE 5
184 #define EFI_HII_EXPRESSION_RULE 6
185 #define EFI_HII_EXPRESSION_READ 7
186 #define EFI_HII_EXPRESSION_WRITE 8
188 #define EFI_HII_VARSTORE_BUFFER 0
189 #define EFI_HII_VARSTORE_NAME_VALUE 1
190 #define EFI_HII_VARSTORE_EFI_VARIABLE 2
191 #define EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER 3
193 #define FORM_INCONSISTENT_VALIDATION 0
194 #define FORM_NO_SUBMIT_VALIDATION 1
196 #define FORMSET_CLASS_PLATFORM_SETUP 0x0001
197 #define FORMSET_CLASS_FRONT_PAGE 0x0002
201 EFI_IFR_TYPE_VALUE Value
;
204 #define NAME_VALUE_NODE_SIGNATURE SIGNATURE_32 ('N', 'V', 'S', 'T')
214 #define NAME_VALUE_NODE_FROM_LINK(a) CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)
216 #define FORMSET_STORAGE_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'G')
222 UINT8 Type
; // Storage type
227 CHAR16
*Name
; // For EFI_IFR_VARSTORE
230 UINT8
*EditBuffer
; // Edit copy for Buffer Storage
232 LIST_ENTRY NameValueListHead
; // List of NAME_VALUE_NODE
234 UINT32 Attributes
; // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute
236 CHAR16
*ConfigHdr
; // <ConfigHdr>
237 CHAR16
*ConfigRequest
; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
238 UINTN ElementCount
; // Number of <RequestElement> in the <ConfigRequest>
239 UINTN SpareStrLen
; // Spare length of ConfigRequest string buffer
242 #define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)
245 EFI_STRING_ID VarName
;
249 #define EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')
257 UINT8 Format
; // For EFI_IFR_TO_STRING, EFI_IFR_FIND
258 UINT8 Flags
; // For EFI_IFR_SPAN
259 UINT8 RuleId
; // For EFI_IFR_RULE_REF
261 EFI_HII_VALUE Value
; // For EFI_IFR_EQ_ID_VAL, EFI_IFR_UINT64, EFI_IFR_UINT32, EFI_IFR_UINT16, EFI_IFR_UINT8, EFI_IFR_STRING_REF1
263 EFI_QUESTION_ID QuestionId
; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1
264 EFI_QUESTION_ID QuestionId2
;
266 UINT16 ListLength
; // For EFI_IFR_EQ_ID_VAL_LIST
269 EFI_STRING_ID DevicePath
; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3
272 FORMSET_STORAGE
*VarStorage
; // For EFI_IFR_SET, EFI_IFR_GET
273 VAR_STORE_INFO VarStoreInfo
;// For EFI_IFR_SET, EFI_IFR_GET
274 UINT8 ValueType
; // For EFI_IFR_SET, EFI_IFR_GET
275 UINT8 ValueWidth
; // For EFI_IFR_SET, EFI_IFR_GET
276 CHAR16
*ValueName
; // For EFI_IFR_SET, EFI_IFR_GET
277 LIST_ENTRY MapExpressionList
; // nested expressions inside of Map opcode.
280 #define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)
282 #define FORM_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')
288 UINT8 Type
; // Type for this expression
290 UINT8 RuleId
; // For EFI_IFR_RULE only
291 EFI_STRING_ID Error
; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only
293 EFI_HII_VALUE Result
; // Expression evaluation result
295 LIST_ENTRY OpCodeListHead
; // OpCodes consist of this expression (EXPRESSION_OPCODE)
298 #define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)
300 #define QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')
307 EFI_HII_VALUE Value
; // Default value
309 FORM_EXPRESSION
*ValueExpression
; // Not-NULL indicates default value is provided by EFI_IFR_VALUE
312 #define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)
314 #define QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')
323 EFI_IMAGE_ID ImageId
;
325 FORM_EXPRESSION
*SuppressExpression
; // Non-NULL indicates nested inside of SuppressIf
328 #define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)
330 #define FORM_BROWSER_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')
336 UINT8 Operand
; // The operand (first byte) of this Statement or Question
341 EFI_STRING_ID Prompt
;
343 EFI_STRING_ID TextTwo
; // For EFI_IFR_TEXT
348 EFI_QUESTION_ID QuestionId
; // The value of zero is reserved
349 EFI_VARSTORE_ID VarStoreId
; // A value of zero indicates no variable storage
350 FORMSET_STORAGE
*Storage
;
351 VAR_STORE_INFO VarStoreInfo
;
354 CHAR16
*VariableName
; // Name/Value or EFI Variable name
355 CHAR16
*BlockName
; // Buffer storage block name: "OFFSET=...WIDTH=..."
357 EFI_HII_VALUE HiiValue
; // Edit copy for checkbox, numberic, oneof
358 UINT8
*BufferValue
; // Edit copy for string, password, orderedlist
359 UINT8 ValueType
; // Data type for orderedlist value array
362 // OpCode specific members
364 UINT8 Flags
; // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,
365 // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER
366 UINT8 MaxContainers
; // for EFI_IFR_ORDERED_LIST
368 UINT16 BannerLineNumber
; // for EFI_IFR_BANNER, 1-based line number
369 EFI_STRING_ID QuestionConfig
; // for EFI_IFR_ACTION, if 0 then no configuration string will be processed
371 UINT64 Minimum
; // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value
372 UINT64 Maximum
; // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length
375 EFI_DEFAULT_ID DefaultId
; // for EFI_IFR_RESET_BUTTON
376 EFI_GUID RefreshGuid
; // for EFI_IFR_REFRESH_ID
379 // Get from IFR parsing
381 FORM_EXPRESSION
*ValueExpression
; // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly
382 LIST_ENTRY DefaultListHead
; // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values
383 LIST_ENTRY OptionListHead
; // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)
385 EFI_IMAGE_ID ImageId
; // nested EFI_IFR_IMAGE
386 UINT8 RefreshInterval
; // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh
387 BOOLEAN InSubtitle
; // nesting inside of EFI_IFR_SUBTITLE
389 LIST_ENTRY InconsistentListHead
;// nested inconsistent expression list (FORM_EXPRESSION)
390 LIST_ENTRY NoSubmitListHead
; // nested nosubmit expression list (FORM_EXPRESSION)
391 FORM_EXPRESSION
*GrayOutExpression
; // nesting inside of GrayOutIf
392 FORM_EXPRESSION
*SuppressExpression
; // nesting inside of SuppressIf
393 FORM_EXPRESSION
*DisableExpression
; // nesting inside of DisableIf
395 FORM_EXPRESSION
*ReadExpression
; // nested EFI_IFR_READ, provide this question value by read expression.
396 FORM_EXPRESSION
*WriteExpression
; // nested EFI_IFR_WRITE, evaluate write expression after this question value is set.
397 } FORM_BROWSER_STATEMENT
;
399 #define FORM_BROWSER_STATEMENT_FROM_LINK(a) CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)
401 #define FORM_BROWSER_CONFIG_REQUEST_SIGNATURE SIGNATURE_32 ('F', 'C', 'R', 'S')
406 CHAR16
*ConfigRequest
; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
407 UINTN ElementCount
; // Number of <RequestElement> in the <ConfigRequest>
410 FORMSET_STORAGE
*Storage
;
411 } FORM_BROWSER_CONFIG_REQUEST
;
412 #define FORM_BROWSER_CONFIG_REQUEST_FROM_LINK(a) CR (a, FORM_BROWSER_CONFIG_REQUEST, Link, FORM_BROWSER_CONFIG_REQUEST_SIGNATURE)
414 #define FORM_BROWSER_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')
415 #define STANDARD_MAP_FORM_TYPE 0x01
421 UINT16 FormId
; // FormId of normal form or formmap form.
422 EFI_STRING_ID FormTitle
; // FormTile of normal form, or FormMapMethod title of formmap form.
423 UINT16 FormType
; // Specific form type for the different form.
425 EFI_IMAGE_ID ImageId
;
427 BOOLEAN ModalForm
; // Whether this is a modal form.
429 BOOLEAN NvUpdateRequired
; // Whether this form has NV update request.
431 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
432 LIST_ENTRY StatementListHead
; // List of Statements and Questions (FORM_BROWSER_STATEMENT)
433 LIST_ENTRY ConfigRequestHead
; // List of configreques for all storage.
434 FORM_EXPRESSION
*SuppressExpression
; // nesting inside of SuppressIf
437 #define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)
439 #define FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')
446 EFI_STRING_ID DefaultName
;
447 } FORMSET_DEFAULTSTORE
;
449 #define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)
451 #define FORM_BROWSER_FORMSET_SIGNATURE SIGNATURE_32 ('F', 'B', 'F', 'S')
456 EFI_HII_HANDLE HiiHandle
; // unique id for formset.
457 EFI_HANDLE DriverHandle
;
458 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
459 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
461 UINTN IfrBinaryLength
;
462 UINT8
*IfrBinaryData
;
465 EFI_STRING_ID FormSetTitle
;
467 UINT8 NumberOfClassGuid
;
468 EFI_GUID ClassGuid
[3]; // Up to three ClassGuid
469 UINT16 Class
; // Tiano extended Class code
470 UINT16 SubClass
; // Tiano extended Subclass code
471 EFI_IMAGE_ID ImageId
;
473 FORM_BROWSER_STATEMENT
*StatementBuffer
; // Buffer for all Statements and Questions
474 EXPRESSION_OPCODE
*ExpressionBuffer
; // Buffer for all Expression OpCode
476 LIST_ENTRY StorageListHead
; // Storage list (FORMSET_STORAGE)
477 LIST_ENTRY DefaultStoreListHead
; // DefaultStore list (FORMSET_DEFAULTSTORE)
478 LIST_ENTRY FormListHead
; // Form list (FORM_BROWSER_FORM)
479 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
480 } FORM_BROWSER_FORMSET
;
482 #define FORM_BROWSER_FORMSET_FROM_LINK(a) CR (a, FORM_BROWSER_FORMSET, Link, FORM_BROWSER_FORMSET_SIGNATURE)
484 #define BROWSER_CONTEXT_SIGNATURE SIGNATURE_32 ('B', 'C', 'T', 'X')
491 // Globals defined in Setup.c
493 BANNER_DATA
*BannerData
;
495 UINTN FunctionKeySetting
;
496 BOOLEAN ResetRequired
;
498 EFI_SCREEN_DESCRIPTOR ScreenDimensions
;
500 CHAR16
*EnterCommitString
;
501 CHAR16
*EnterEscapeString
;
502 CHAR16
*EscapeString
;
503 CHAR16
*MoveHighlight
;
504 CHAR16
*MakeSelection
;
505 CHAR16
*DecNumericInput
;
506 CHAR16
*HexNumericInput
;
507 CHAR16
*ToggleCheckBox
;
508 CHAR16
*PromptForData
;
509 CHAR16
*PromptForPassword
;
510 CHAR16
*PromptForNewPassword
;
511 CHAR16
*ConfirmPassword
;
512 CHAR16
*ConfirmError
;
513 CHAR16
*PassowordInvalid
;
522 CHAR16
*AdjustNumber
;
524 CHAR16
*OptionMismatch
;
525 CHAR16
*FormSuppress
;
526 CHAR16 PromptBlockWidth
;
527 CHAR16 OptionBlockWidth
;
528 CHAR16 HelpBlockWidth
;
529 FORM_BROWSER_FORMSET
*OldFormSet
;
532 // Globals defined in Ui.c
534 LIST_ENTRY MenuOption
;
535 VOID
*MenuRefreshHead
;
538 #define BROWSER_CONTEXT_FROM_LINK(a) CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)
540 #define BROWSER_HOT_KEY_SIGNATURE SIGNATURE_32 ('B', 'H', 'K', 'S')
546 EFI_INPUT_KEY
*KeyData
;
549 IN EFI_STRING HelpString
;
552 #define BROWSER_HOT_KEY_FROM_LINK(a) CR (a, BROWSER_HOT_KEY, Link, BROWSER_HOT_KEY_SIGNATURE)
554 extern EFI_HII_DATABASE_PROTOCOL
*mHiiDatabase
;
555 extern EFI_HII_STRING_PROTOCOL
*mHiiString
;
556 extern EFI_HII_CONFIG_ROUTING_PROTOCOL
*mHiiConfigRouting
;
558 extern BANNER_DATA
*gBannerData
;
559 extern EFI_HII_HANDLE gFrontPageHandle
;
560 extern UINTN gClassOfVfr
;
561 extern UINTN gFunctionKeySetting
;
562 extern BOOLEAN gResetRequired
;
563 extern EFI_HII_HANDLE gHiiHandle
;
564 extern UINT16 gDirection
;
565 extern EFI_SCREEN_DESCRIPTOR gScreenDimensions
;
567 extern FORM_BROWSER_FORMSET
*gOldFormSet
;
568 extern LIST_ENTRY gBrowserFormSetList
;
569 extern LIST_ENTRY gBrowserHotKeyList
;
570 extern BROWSER_SETTING_SCOPE gBrowserSettingScope
;
571 extern EXIT_HANDLER ExitHandlerFunction
;
572 extern UINTN gFooterHeight
;
575 // Browser Global Strings
577 extern CHAR16
*gDiscardFailed
;
578 extern CHAR16
*gDefaultFailed
;
579 extern CHAR16
*gEnterString
;
580 extern CHAR16
*gEnterCommitString
;
581 extern CHAR16
*gEnterEscapeString
;
582 extern CHAR16
*gEscapeString
;
583 extern CHAR16
*gSaveFailed
;
584 extern CHAR16
*gMoveHighlight
;
585 extern CHAR16
*gMakeSelection
;
586 extern CHAR16
*gDecNumericInput
;
587 extern CHAR16
*gHexNumericInput
;
588 extern CHAR16
*gToggleCheckBox
;
589 extern CHAR16
*gPromptForData
;
590 extern CHAR16
*gPromptForPassword
;
591 extern CHAR16
*gPromptForNewPassword
;
592 extern CHAR16
*gConfirmPassword
;
593 extern CHAR16
*gConfirmError
;
594 extern CHAR16
*gPassowordInvalid
;
595 extern CHAR16
*gPressEnter
;
596 extern CHAR16
*gEmptyString
;
597 extern CHAR16
*gAreYouSure
;
598 extern CHAR16
*gYesResponse
;
599 extern CHAR16
*gNoResponse
;
600 extern CHAR16
*gMiniString
;
601 extern CHAR16
*gPlusString
;
602 extern CHAR16
*gMinusString
;
603 extern CHAR16
*gAdjustNumber
;
604 extern CHAR16
*gSaveChanges
;
605 extern CHAR16
*gOptionMismatch
;
606 extern CHAR16
*gFormSuppress
;
608 extern CHAR16 gPromptBlockWidth
;
609 extern CHAR16 gOptionBlockWidth
;
610 extern CHAR16 gHelpBlockWidth
;
612 extern EFI_GUID gZeroGuid
;
613 extern EFI_GUID gTianoHiiIfrGuid
;
617 // Global Procedure Defines
621 Initialize the HII String Token to the correct values.
625 InitializeBrowserStrings (
630 Prints a unicode string to the default console,
633 @param String String pointer.
635 @return Length of string printed to the console
644 Prints a chracter to the default console,
647 @param Character Character to print.
649 @return Length of string printed to the console.
658 Prints a formatted unicode string to the default console, at
659 the supplied cursor position.
661 @param Column The cursor position to print the string at.
662 @param Row The cursor position to print the string at
663 @param Fmt Format string
664 @param ... Variable argument list for formating string.
666 @return Length of string printed to the console
679 Prints a unicode string to the default console, at
680 the supplied cursor position, using L"%s" format.
682 @param Column The cursor position to print the string at.
683 @param Row The cursor position to print the string at
684 @param String String pointer.
686 @return Length of string printed to the console
697 Prints a chracter to the default console, at
698 the supplied cursor position, using L"%c" format.
700 @param Column The cursor position to print the string at.
701 @param Row The cursor position to print the string at.
702 @param Character Character to print.
704 @return Length of string printed to the console.
715 Parse opcodes in the formset IFR binary.
717 @param FormSet Pointer of the FormSet data structure.
719 @retval EFI_SUCCESS Opcode parse success.
720 @retval Other Opcode parse fail.
725 IN FORM_BROWSER_FORMSET
*FormSet
729 Free resources allocated for a FormSet.
731 @param FormSet Pointer of the FormSet
736 IN OUT FORM_BROWSER_FORMSET
*FormSet
740 This function displays the page frame.
742 @param Selection Selection contains the information about
743 the Selection, form and formset to be displayed.
744 Selection action may be updated in retrieve callback.
748 IN UI_MENU_SELECTION
*Selection
752 Create a new string in HII Package List.
754 @param String The String to be added
755 @param HiiHandle The package list in the HII database to insert the
758 @return The output string.
764 IN EFI_HII_HANDLE HiiHandle
768 Delete a string from HII Package List.
770 @param StringId Id of the string in HII database.
771 @param HiiHandle The HII package list handle.
773 @retval EFI_SUCCESS The string was deleted successfully.
778 IN EFI_STRING_ID StringId
,
779 IN EFI_HII_HANDLE HiiHandle
783 Get the string based on the StringId and HII Package List Handle.
785 @param Token The String's ID.
786 @param HiiHandle The package list in the HII database to search for
787 the specified string.
789 @return The output string.
794 IN EFI_STRING_ID Token
,
795 IN EFI_HII_HANDLE HiiHandle
799 Draw a pop up windows based on the dimension, number of lines and
802 @param RequestedWidth The width of the pop-up.
803 @param NumberOfLines The number of lines.
804 @param Marker The variable argument list for the list of string to be printed.
809 IN UINTN RequestedWidth
,
810 IN UINTN NumberOfLines
,
815 Routine used to abstract a generic dialog interface and return the selected key or string
817 @param NumberOfLines The number of lines for the dialog box
818 @param HotKey Defines whether a single character is parsed
819 (TRUE) and returned in KeyValue or a string is
820 returned in StringBuffer. Two special characters
821 are considered when entering a string, a SCAN_ESC
822 and an CHAR_CARRIAGE_RETURN. SCAN_ESC terminates
823 string input and returns
824 @param MaximumStringSize The maximum size in bytes of a typed in string
825 (each character is a CHAR16) and the minimum
826 string returned is two bytes
827 @param StringBuffer The passed in pointer to the buffer which will
828 hold the typed in string if HotKey is FALSE
829 @param KeyValue The EFI_KEY value returned if HotKey is TRUE..
830 @param ... A series of (quantity == NumberOfLines) text
831 strings which will be used to construct the dialog
834 @retval EFI_SUCCESS Displayed dialog and received user interaction
835 @retval EFI_INVALID_PARAMETER One of the parameters was invalid (e.g.
836 (StringBuffer == NULL) && (HotKey == FALSE))
837 @retval EFI_DEVICE_ERROR User typed in an ESC character to exit the routine
843 IN UINTN NumberOfLines
,
845 IN UINTN MaximumStringSize
,
846 OUT CHAR16
*StringBuffer
,
847 OUT EFI_INPUT_KEY
*KeyValue
,
852 Get Value for given Name from a NameValue Storage.
854 @param Storage The NameValue Storage.
855 @param Name The Name.
856 @param Value The retured Value.
858 @retval EFI_SUCCESS Value found for given Name.
859 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
864 IN FORMSET_STORAGE
*Storage
,
866 IN OUT CHAR16
**Value
870 Set Value of given Name in a NameValue Storage.
872 @param Storage The NameValue Storage.
873 @param Name The Name.
874 @param Value The Value to set.
875 @param Edit Whether update editValue or Value.
877 @retval EFI_SUCCESS Value found for given Name.
878 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
883 IN FORMSET_STORAGE
*Storage
,
890 Get Question's current Value.
892 @param FormSet FormSet data structure.
893 @param Form Form data structure.
894 @param Question Question to be initialized.
895 @param Cached TRUE: get from Edit copy FALSE: get from original
898 @retval EFI_SUCCESS The function completed successfully.
903 IN FORM_BROWSER_FORMSET
*FormSet
,
904 IN FORM_BROWSER_FORM
*Form
,
905 IN OUT FORM_BROWSER_STATEMENT
*Question
,
910 Save Question Value to edit copy(cached) or Storage(uncached).
912 @param FormSet FormSet data structure.
913 @param Form Form data structure.
914 @param Question Pointer to the Question.
915 @param Cached TRUE: set to Edit copy FALSE: set to original
918 @retval EFI_SUCCESS The function completed successfully.
923 IN FORM_BROWSER_FORMSET
*FormSet
,
924 IN FORM_BROWSER_FORM
*Form
,
925 IN OUT FORM_BROWSER_STATEMENT
*Question
,
930 Perform inconsistent check for a Form.
932 @param FormSet FormSet data structure.
933 @param Form Form data structure.
934 @param Question The Question to be validated.
935 @param Type Validation type: InConsistent or NoSubmit
937 @retval EFI_SUCCESS Form validation pass.
938 @retval other Form validation failed.
943 IN FORM_BROWSER_FORMSET
*FormSet
,
944 IN FORM_BROWSER_FORM
*Form
,
945 IN FORM_BROWSER_STATEMENT
*Question
,
951 Discard data based on the input setting scope (Form, FormSet or System).
953 @param FormSet FormSet data structure.
954 @param Form Form data structure.
955 @param SettingScope Setting Scope for Discard action.
957 @retval EFI_SUCCESS The function completed successfully.
958 @retval EFI_UNSUPPORTED Unsupport SettingScope.
963 IN FORM_BROWSER_FORMSET
*FormSet
,
964 IN FORM_BROWSER_FORM
*Form
,
965 IN BROWSER_SETTING_SCOPE SettingScope
969 Submit data based on the input Setting level (Form, FormSet or System).
971 @param FormSet FormSet data structure.
972 @param Form Form data structure.
973 @param SettingScope Setting Scope for Submit action.
975 @retval EFI_SUCCESS The function completed successfully.
976 @retval EFI_UNSUPPORTED Unsupport SettingScope.
981 IN FORM_BROWSER_FORMSET
*FormSet
,
982 IN FORM_BROWSER_FORM
*Form
,
983 IN BROWSER_SETTING_SCOPE SettingScope
987 Reset Question to its default value.
989 @param FormSet The form set.
990 @param Form The form.
991 @param Question The question.
992 @param DefaultId The Class of the default.
994 @retval EFI_SUCCESS Question is reset to default value.
999 IN FORM_BROWSER_FORMSET
*FormSet
,
1000 IN FORM_BROWSER_FORM
*Form
,
1001 IN FORM_BROWSER_STATEMENT
*Question
,
1006 Get current setting of Questions.
1008 @param FormSet FormSet data structure.
1010 @retval EFI_SUCCESS The function completed successfully.
1014 InitializeCurrentSetting (
1015 IN OUT FORM_BROWSER_FORMSET
*FormSet
1019 Initialize the internal data structure of a FormSet.
1021 @param Handle PackageList Handle
1022 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
1023 GUID), take the first FormSet found in package
1025 @param FormSet FormSet data structure.
1027 @retval EFI_SUCCESS The function completed successfully.
1028 @retval EFI_NOT_FOUND The specified FormSet could not be found.
1033 IN EFI_HII_HANDLE Handle
,
1034 IN OUT EFI_GUID
*FormSetGuid
,
1035 OUT FORM_BROWSER_FORMSET
*FormSet
1039 Reset Questions to their default value in a Form, Formset or System.
1041 @param FormSet FormSet data structure.
1042 @param Form Form data structure.
1043 @param DefaultId The Class of the default.
1044 @param SettingScope Setting Scope for Default action.
1046 @retval EFI_SUCCESS The function completed successfully.
1047 @retval EFI_UNSUPPORTED Unsupport SettingScope.
1052 IN FORM_BROWSER_FORMSET
*FormSet
,
1053 IN FORM_BROWSER_FORM
*Form
,
1054 IN UINT16 DefaultId
,
1055 IN BROWSER_SETTING_SCOPE SettingScope
1059 Initialize Question's Edit copy from Storage.
1061 @param Selection Selection contains the information about
1062 the Selection, form and formset to be displayed.
1063 Selection action may be updated in retrieve callback.
1064 @param FormSet FormSet data structure.
1065 @param Form Form data structure.
1067 @retval EFI_SUCCESS The function completed successfully.
1072 IN OUT UI_MENU_SELECTION
*Selection
,
1073 IN FORM_BROWSER_FORMSET
*FormSet
,
1074 IN FORM_BROWSER_FORM
*Form
1078 Initialize Question's Edit copy from Storage for the whole Formset.
1080 @param Selection Selection contains the information about
1081 the Selection, form and formset to be displayed.
1082 Selection action may be updated in retrieve callback.
1083 @param FormSet FormSet data structure.
1085 @retval EFI_SUCCESS The function completed successfully.
1090 IN OUT UI_MENU_SELECTION
*Selection
,
1091 IN FORM_BROWSER_FORMSET
*FormSet
1095 Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
1097 @param Buffer The Storage to be conveted.
1098 @param ConfigResp The returned <ConfigResp>.
1099 @param SingleForm Whether update data for single form or formset level.
1101 @retval EFI_SUCCESS Convert success.
1102 @retval EFI_INVALID_PARAMETER Incorrect storage type.
1106 StorageToConfigResp (
1108 IN CHAR16
**ConfigResp
,
1109 IN BOOLEAN SingleForm
1113 Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
1115 @param Storage The Storage to receive the settings.
1116 @param ConfigResp The <ConfigResp> to be converted.
1118 @retval EFI_SUCCESS Convert success.
1119 @retval EFI_INVALID_PARAMETER Incorrect storage type.
1123 ConfigRespToStorage (
1124 IN FORMSET_STORAGE
*Storage
,
1125 IN CHAR16
*ConfigResp
1129 Fill storage's edit copy with settings requested from Configuration Driver.
1131 @param FormSet FormSet data structure.
1132 @param Storage Buffer Storage.
1134 @retval EFI_SUCCESS The function completed successfully.
1139 IN FORM_BROWSER_FORMSET
*FormSet
,
1140 IN FORMSET_STORAGE
*Storage
1144 Fetch the Ifr binary data of a FormSet.
1146 @param Handle PackageList Handle
1147 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
1148 GUID), take the first FormSet found in package
1150 @param BinaryLength The length of the FormSet IFR binary.
1151 @param BinaryData The buffer designed to receive the FormSet.
1153 @retval EFI_SUCCESS Buffer filled with the requested FormSet.
1154 BufferLength was updated.
1155 @retval EFI_INVALID_PARAMETER The handle is unknown.
1156 @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot
1157 be found with the requested FormId.
1162 IN EFI_HII_HANDLE Handle
,
1163 IN OUT EFI_GUID
*FormSetGuid
,
1164 OUT UINTN
*BinaryLength
,
1165 OUT UINT8
**BinaryData
1169 Save globals used by previous call to SendForm(). SendForm() may be called from
1170 HiiConfigAccess.Callback(), this will cause SendForm() be reentried.
1171 So, save globals of previous call to SendForm() and restore them upon exit.
1175 SaveBrowserContext (
1180 Restore globals used by previous call to SendForm().
1184 RestoreBrowserContext (
1189 This is the routine which an external caller uses to direct the browser
1190 where to obtain it's information.
1193 @param This The Form Browser protocol instanse.
1194 @param Handles A pointer to an array of Handles. If HandleCount > 1 we
1195 display a list of the formsets for the handles specified.
1196 @param HandleCount The number of Handles specified in Handle.
1197 @param FormSetGuid This field points to the EFI_GUID which must match the Guid
1198 field in the EFI_IFR_FORM_SET op-code for the specified
1199 forms-based package. If FormSetGuid is NULL, then this
1200 function will display the first found forms package.
1201 @param FormId This field specifies which EFI_IFR_FORM to render as the first
1202 displayable page. If this field has a value of 0x0000, then
1203 the forms browser will render the specified forms in their encoded order.
1204 ScreenDimenions - This allows the browser to be called so that it occupies a
1205 portion of the physical screen instead of dynamically determining the screen dimensions.
1206 ActionRequest - Points to the action recommended by the form.
1207 @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
1209 @param ActionRequest Points to the action recommended by the form.
1211 @retval EFI_SUCCESS The function completed successfully.
1212 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1213 @retval EFI_NOT_FOUND No valid forms could be found to display.
1219 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1220 IN EFI_HII_HANDLE
*Handles
,
1221 IN UINTN HandleCount
,
1222 IN EFI_GUID
*FormSetGuid
, OPTIONAL
1223 IN UINT16 FormId
, OPTIONAL
1224 IN CONST EFI_SCREEN_DESCRIPTOR
*ScreenDimensions
, OPTIONAL
1225 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest OPTIONAL
1229 This function is called by a callback handler to retrieve uncommitted state
1230 data from the browser.
1232 @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL
1234 @param ResultsDataSize A pointer to the size of the buffer associated
1236 @param ResultsData A string returned from an IFR browser or
1237 equivalent. The results string will have no
1238 routing information in them.
1239 @param RetrieveData A BOOLEAN field which allows an agent to retrieve
1240 (if RetrieveData = TRUE) data from the uncommitted
1241 browser state information or set (if RetrieveData
1242 = FALSE) data in the uncommitted browser state
1244 @param VariableGuid An optional field to indicate the target variable
1246 @param VariableName An optional field to indicate the target
1247 human-readable variable name.
1249 @retval EFI_SUCCESS The results have been distributed or are awaiting
1251 @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to
1252 contain the results data.
1258 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1259 IN OUT UINTN
*ResultsDataSize
,
1260 IN OUT EFI_STRING ResultsData
,
1261 IN BOOLEAN RetrieveData
,
1262 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
1263 IN CONST CHAR16
*VariableName OPTIONAL
1267 Find menu which will show next time.
1269 @param Selection On input, Selection tell setup browser the information
1270 about the Selection, form and formset to be displayed.
1271 On output, Selection return the screen item that is selected
1273 @param Repaint Whether need to repaint the menu.
1274 @param NewLine Whether need to show at new line.
1276 @retval TRUE Need return.
1277 @retval FALSE No need to return.
1281 IN OUT UI_MENU_SELECTION
*Selection
,
1282 IN BOOLEAN
*Repaint
,
1287 check whether the formset need to update the NV.
1289 @param FormSet FormSet data structure.
1290 @param SetValue Whether set new value or clear old value.
1294 UpdateNvInfoInForm (
1295 IN FORM_BROWSER_FORMSET
*FormSet
,
1300 check whether the formset need to update the NV.
1302 @param FormSet FormSet data structure.
1304 @retval TRUE Need to update the NV.
1305 @retval FALSE No need to update the NV.
1308 IsNvUpdateRequired (
1309 IN FORM_BROWSER_FORMSET
*FormSet
1313 Call the call back function for the question and process the return action.
1315 @param Selection On input, Selection tell setup browser the information
1316 about the Selection, form and formset to be displayed.
1317 On output, Selection return the screen item that is selected
1319 @param Statement The Question which need to call.
1320 @param Action The action request.
1321 @param SkipSaveOrDiscard Whether skip save or discard action.
1323 @retval EFI_SUCCESS The call back function excutes successfully.
1324 @return Other value if the call back function failed to excute.
1327 ProcessCallBackFunction (
1328 IN OUT UI_MENU_SELECTION
*Selection
,
1329 IN FORM_BROWSER_STATEMENT
*Question
,
1330 IN EFI_BROWSER_ACTION Action
,
1331 IN BOOLEAN SkipSaveOrDiscard
1335 Find the matched FormSet context in the backup maintain list based on HiiHandle.
1337 @param Handle The Hii Handle.
1339 @return the found FormSet context. If no found, NULL will return.
1342 FORM_BROWSER_FORMSET
*
1343 GetFormSetFromHiiHandle (
1344 EFI_HII_HANDLE Handle
1348 Check whether the input HII handle is the FormSet that is being used.
1350 @param Handle The Hii Handle.
1352 @retval TRUE HII handle is being used.
1353 @retval FALSE HII handle is not being used.
1357 IsHiiHandleInBrowserContext (
1358 EFI_HII_HANDLE Handle
1362 Configure what scope the hot key will impact.
1363 All hot keys have the same scope. The mixed hot keys with the different level are not supported.
1364 If no scope is set, the default scope will be FormSet level.
1365 After all registered hot keys are removed, previous Scope can reset to another level.
1367 @param[in] Scope Scope level to be set.
1369 @retval EFI_SUCCESS Scope is set correctly.
1370 @retval EFI_INVALID_PARAMETER Scope is not the valid value specified in BROWSER_SETTING_SCOPE.
1371 @retval EFI_UNSPPORTED Scope level is different from current one that the registered hot keys have.
1377 IN BROWSER_SETTING_SCOPE Scope
1381 Register the hot key with its browser action, or unregistered the hot key.
1382 Only support hot key that is not printable character (control key, function key, etc.).
1383 If the action value is zero, the hot key will be unregistered if it has been registered.
1384 If the same hot key has been registered, the new action and help string will override the previous ones.
1386 @param[in] KeyData A pointer to a buffer that describes the keystroke
1387 information for the hot key. Its type is EFI_INPUT_KEY to
1388 be supported by all ConsoleIn devices.
1389 @param[in] Action Action value that describes what action will be trigged when the hot key is pressed.
1390 @param[in] DefaultId Specifies the type of defaults to retrieve, which is only for DEFAULT action.
1391 @param[in] HelpString Help string that describes the hot key information.
1392 Its value may be NULL for the unregistered hot key.
1394 @retval EFI_SUCCESS Hot key is registered or unregistered.
1395 @retval EFI_INVALID_PARAMETER KeyData is NULL.
1396 @retval EFI_NOT_FOUND KeyData is not found to be unregistered.
1397 @retval EFI_UNSUPPORTED Key represents a printable character. It is conflicted with Browser.
1402 IN EFI_INPUT_KEY
*KeyData
,
1404 IN UINT16 DefaultId
,
1405 IN EFI_STRING HelpString OPTIONAL
1409 Register Exit handler function.
1410 When more than one handler function is registered, the latter one will override the previous one.
1411 When NULL handler is specified, the previous Exit handler will be unregistered.
1413 @param[in] Handler Pointer to handler function.
1418 RegiserExitHandler (
1419 IN EXIT_HANDLER Handler
1423 Create reminder to let user to choose save or discard the changed browser data.
1424 Caller can use it to actively check the changed browser data.
1426 @retval BROWSER_NO_CHANGES No browser data is changed.
1427 @retval BROWSER_SAVE_CHANGES The changed browser data is saved.
1428 @retval BROWSER_DISCARD_CHANGES The changed browser data is discard.
1438 Find the registered HotKey based on KeyData.
1440 @param[in] KeyData A pointer to a buffer that describes the keystroke
1441 information for the hot key.
1443 @return The registered HotKey context. If no found, NULL will return.
1446 GetHotKeyFromRegisterList (
1447 IN EFI_INPUT_KEY
*KeyData