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
203 EFI_IFR_TYPE_VALUE Value
;
206 #define NAME_VALUE_NODE_SIGNATURE SIGNATURE_32 ('N', 'V', 'S', 'T')
216 #define NAME_VALUE_NODE_FROM_LINK(a) CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)
218 #define FORMSET_STORAGE_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'G')
224 UINT8 Type
; // Storage type
229 CHAR16
*Name
; // For EFI_IFR_VARSTORE
232 UINT8
*EditBuffer
; // Edit copy for Buffer Storage
234 LIST_ENTRY NameValueListHead
; // List of NAME_VALUE_NODE
236 UINT32 Attributes
; // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute
238 CHAR16
*ConfigHdr
; // <ConfigHdr>
239 CHAR16
*ConfigRequest
; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
240 UINTN ElementCount
; // Number of <RequestElement> in the <ConfigRequest>
241 UINTN SpareStrLen
; // Spare length of ConfigRequest string buffer
244 #define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)
247 EFI_STRING_ID VarName
;
251 #define EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')
259 UINT8 Format
; // For EFI_IFR_TO_STRING, EFI_IFR_FIND
260 UINT8 Flags
; // For EFI_IFR_SPAN
261 UINT8 RuleId
; // For EFI_IFR_RULE_REF
263 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
265 EFI_QUESTION_ID QuestionId
; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1
266 EFI_QUESTION_ID QuestionId2
;
268 UINT16 ListLength
; // For EFI_IFR_EQ_ID_VAL_LIST
271 EFI_STRING_ID DevicePath
; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3
274 FORMSET_STORAGE
*VarStorage
; // For EFI_IFR_SET, EFI_IFR_GET
275 VAR_STORE_INFO VarStoreInfo
;// For EFI_IFR_SET, EFI_IFR_GET
276 UINT8 ValueType
; // For EFI_IFR_SET, EFI_IFR_GET
277 UINT8 ValueWidth
; // For EFI_IFR_SET, EFI_IFR_GET
278 CHAR16
*ValueName
; // For EFI_IFR_SET, EFI_IFR_GET
279 LIST_ENTRY MapExpressionList
; // nested expressions inside of Map opcode.
282 #define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)
284 #define FORM_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')
290 UINT8 Type
; // Type for this expression
292 UINT8 RuleId
; // For EFI_IFR_RULE only
293 EFI_STRING_ID Error
; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only
295 EFI_HII_VALUE Result
; // Expression evaluation result
297 LIST_ENTRY OpCodeListHead
; // OpCodes consist of this expression (EXPRESSION_OPCODE)
300 #define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)
302 #define QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')
309 EFI_HII_VALUE Value
; // Default value
311 FORM_EXPRESSION
*ValueExpression
; // Not-NULL indicates default value is provided by EFI_IFR_VALUE
314 #define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)
316 #define QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')
325 EFI_IMAGE_ID ImageId
;
327 FORM_EXPRESSION
*SuppressExpression
; // Non-NULL indicates nested inside of SuppressIf
330 #define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)
332 #define FORM_BROWSER_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')
338 UINT8 Operand
; // The operand (first byte) of this Statement or Question
343 EFI_STRING_ID Prompt
;
345 EFI_STRING_ID TextTwo
; // For EFI_IFR_TEXT
350 EFI_QUESTION_ID QuestionId
; // The value of zero is reserved
351 EFI_VARSTORE_ID VarStoreId
; // A value of zero indicates no variable storage
352 FORMSET_STORAGE
*Storage
;
353 VAR_STORE_INFO VarStoreInfo
;
356 CHAR16
*VariableName
; // Name/Value or EFI Variable name
357 CHAR16
*BlockName
; // Buffer storage block name: "OFFSET=...WIDTH=..."
359 EFI_HII_VALUE HiiValue
; // Edit copy for checkbox, numberic, oneof
360 UINT8
*BufferValue
; // Edit copy for string, password, orderedlist
361 UINT8 ValueType
; // Data type for orderedlist value array
364 // OpCode specific members
366 UINT8 Flags
; // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,
367 // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER
368 UINT8 MaxContainers
; // for EFI_IFR_ORDERED_LIST
370 UINT16 BannerLineNumber
; // for EFI_IFR_BANNER, 1-based line number
371 EFI_STRING_ID QuestionConfig
; // for EFI_IFR_ACTION, if 0 then no configuration string will be processed
373 UINT64 Minimum
; // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value
374 UINT64 Maximum
; // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length
377 EFI_DEFAULT_ID DefaultId
; // for EFI_IFR_RESET_BUTTON
378 EFI_GUID RefreshGuid
; // for EFI_IFR_REFRESH_ID
379 BOOLEAN Locked
; // Whether this statement is locked.
381 // Get from IFR parsing
383 FORM_EXPRESSION
*ValueExpression
; // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly
384 LIST_ENTRY DefaultListHead
; // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values
385 LIST_ENTRY OptionListHead
; // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)
387 EFI_IMAGE_ID ImageId
; // nested EFI_IFR_IMAGE
388 UINT8 RefreshInterval
; // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh
389 BOOLEAN InSubtitle
; // nesting inside of EFI_IFR_SUBTITLE
391 LIST_ENTRY InconsistentListHead
;// nested inconsistent expression list (FORM_EXPRESSION)
392 LIST_ENTRY NoSubmitListHead
; // nested nosubmit expression list (FORM_EXPRESSION)
393 FORM_EXPRESSION
*GrayOutExpression
; // nesting inside of GrayOutIf
394 FORM_EXPRESSION
*SuppressExpression
; // nesting inside of SuppressIf
395 FORM_EXPRESSION
*DisableExpression
; // nesting inside of DisableIf
397 FORM_EXPRESSION
*ReadExpression
; // nested EFI_IFR_READ, provide this question value by read expression.
398 FORM_EXPRESSION
*WriteExpression
; // nested EFI_IFR_WRITE, evaluate write expression after this question value is set.
399 } FORM_BROWSER_STATEMENT
;
401 #define FORM_BROWSER_STATEMENT_FROM_LINK(a) CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)
403 #define FORM_BROWSER_CONFIG_REQUEST_SIGNATURE SIGNATURE_32 ('F', 'C', 'R', 'S')
408 CHAR16
*ConfigRequest
; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
409 UINTN ElementCount
; // Number of <RequestElement> in the <ConfigRequest>
412 FORMSET_STORAGE
*Storage
;
413 } FORM_BROWSER_CONFIG_REQUEST
;
414 #define FORM_BROWSER_CONFIG_REQUEST_FROM_LINK(a) CR (a, FORM_BROWSER_CONFIG_REQUEST, Link, FORM_BROWSER_CONFIG_REQUEST_SIGNATURE)
416 #define FORM_BROWSER_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')
417 #define STANDARD_MAP_FORM_TYPE 0x01
423 UINT16 FormId
; // FormId of normal form or formmap form.
424 EFI_STRING_ID FormTitle
; // FormTile of normal form, or FormMapMethod title of formmap form.
425 UINT16 FormType
; // Specific form type for the different form.
427 EFI_IMAGE_ID ImageId
;
429 BOOLEAN ModalForm
; // Whether this is a modal form.
430 BOOLEAN Locked
; // Whether this form is locked.
432 BOOLEAN NvUpdateRequired
; // Whether this form has NV update request.
434 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
435 LIST_ENTRY StatementListHead
; // List of Statements and Questions (FORM_BROWSER_STATEMENT)
436 LIST_ENTRY ConfigRequestHead
; // List of configreques for all storage.
437 FORM_EXPRESSION
*SuppressExpression
; // nesting inside of SuppressIf
440 #define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)
442 #define FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')
449 EFI_STRING_ID DefaultName
;
450 } FORMSET_DEFAULTSTORE
;
452 #define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)
454 #define FORM_BROWSER_FORMSET_SIGNATURE SIGNATURE_32 ('F', 'B', 'F', 'S')
459 EFI_HII_HANDLE HiiHandle
; // unique id for formset.
460 EFI_HANDLE DriverHandle
;
461 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
462 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
464 UINTN IfrBinaryLength
;
465 UINT8
*IfrBinaryData
;
468 EFI_STRING_ID FormSetTitle
;
470 UINT8 NumberOfClassGuid
;
471 EFI_GUID ClassGuid
[3]; // Up to three ClassGuid
472 UINT16 Class
; // Tiano extended Class code
473 UINT16 SubClass
; // Tiano extended Subclass code
474 EFI_IMAGE_ID ImageId
;
476 FORM_BROWSER_STATEMENT
*StatementBuffer
; // Buffer for all Statements and Questions
477 EXPRESSION_OPCODE
*ExpressionBuffer
; // Buffer for all Expression OpCode
479 LIST_ENTRY StorageListHead
; // Storage list (FORMSET_STORAGE)
480 LIST_ENTRY DefaultStoreListHead
; // DefaultStore list (FORMSET_DEFAULTSTORE)
481 LIST_ENTRY FormListHead
; // Form list (FORM_BROWSER_FORM)
482 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
483 } FORM_BROWSER_FORMSET
;
485 #define FORM_BROWSER_FORMSET_FROM_LINK(a) CR (a, FORM_BROWSER_FORMSET, Link, FORM_BROWSER_FORMSET_SIGNATURE)
487 #define BROWSER_CONTEXT_SIGNATURE SIGNATURE_32 ('B', 'C', 'T', 'X')
494 // Globals defined in Setup.c
496 BANNER_DATA
*BannerData
;
498 UINTN FunctionKeySetting
;
499 BOOLEAN ResetRequired
;
501 EFI_SCREEN_DESCRIPTOR ScreenDimensions
;
503 CHAR16
*EnterCommitString
;
504 CHAR16
*EnterEscapeString
;
505 CHAR16
*EscapeString
;
506 CHAR16
*MoveHighlight
;
507 CHAR16
*MakeSelection
;
508 CHAR16
*DecNumericInput
;
509 CHAR16
*HexNumericInput
;
510 CHAR16
*ToggleCheckBox
;
511 CHAR16
*PromptForData
;
512 CHAR16
*PromptForPassword
;
513 CHAR16
*PromptForNewPassword
;
514 CHAR16
*ConfirmPassword
;
515 CHAR16
*ConfirmError
;
516 CHAR16
*PassowordInvalid
;
525 CHAR16
*AdjustNumber
;
527 CHAR16
*OptionMismatch
;
528 CHAR16
*FormSuppress
;
529 CHAR16 PromptBlockWidth
;
530 CHAR16 OptionBlockWidth
;
531 CHAR16 HelpBlockWidth
;
532 FORM_BROWSER_FORMSET
*OldFormSet
;
535 // Globals defined in Ui.c
537 LIST_ENTRY MenuOption
;
538 VOID
*MenuRefreshHead
;
541 #define BROWSER_CONTEXT_FROM_LINK(a) CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)
543 #define BROWSER_HOT_KEY_SIGNATURE SIGNATURE_32 ('B', 'H', 'K', 'S')
549 EFI_INPUT_KEY
*KeyData
;
552 IN EFI_STRING HelpString
;
555 #define BROWSER_HOT_KEY_FROM_LINK(a) CR (a, BROWSER_HOT_KEY, Link, BROWSER_HOT_KEY_SIGNATURE)
557 extern EFI_HII_DATABASE_PROTOCOL
*mHiiDatabase
;
558 extern EFI_HII_STRING_PROTOCOL
*mHiiString
;
559 extern EFI_HII_CONFIG_ROUTING_PROTOCOL
*mHiiConfigRouting
;
561 extern BANNER_DATA
*gBannerData
;
562 extern EFI_HII_HANDLE gFrontPageHandle
;
563 extern UINTN gClassOfVfr
;
564 extern UINTN gFunctionKeySetting
;
565 extern BOOLEAN gResetRequired
;
566 extern EFI_HII_HANDLE gHiiHandle
;
567 extern UINT16 gDirection
;
568 extern EFI_SCREEN_DESCRIPTOR gScreenDimensions
;
570 extern FORM_BROWSER_FORMSET
*gOldFormSet
;
571 extern LIST_ENTRY gBrowserFormSetList
;
572 extern LIST_ENTRY gBrowserHotKeyList
;
573 extern BROWSER_SETTING_SCOPE gBrowserSettingScope
;
574 extern EXIT_HANDLER ExitHandlerFunction
;
575 extern UINTN gFooterHeight
;
578 // Browser Global Strings
580 extern CHAR16
*gDiscardFailed
;
581 extern CHAR16
*gDefaultFailed
;
582 extern CHAR16
*gEnterString
;
583 extern CHAR16
*gEnterCommitString
;
584 extern CHAR16
*gEnterEscapeString
;
585 extern CHAR16
*gEscapeString
;
586 extern CHAR16
*gSaveFailed
;
587 extern CHAR16
*gMoveHighlight
;
588 extern CHAR16
*gMakeSelection
;
589 extern CHAR16
*gDecNumericInput
;
590 extern CHAR16
*gHexNumericInput
;
591 extern CHAR16
*gToggleCheckBox
;
592 extern CHAR16
*gPromptForData
;
593 extern CHAR16
*gPromptForPassword
;
594 extern CHAR16
*gPromptForNewPassword
;
595 extern CHAR16
*gConfirmPassword
;
596 extern CHAR16
*gConfirmError
;
597 extern CHAR16
*gPassowordInvalid
;
598 extern CHAR16
*gPressEnter
;
599 extern CHAR16
*gEmptyString
;
600 extern CHAR16
*gAreYouSure
;
601 extern CHAR16
*gYesResponse
;
602 extern CHAR16
*gNoResponse
;
603 extern CHAR16
*gMiniString
;
604 extern CHAR16
*gPlusString
;
605 extern CHAR16
*gMinusString
;
606 extern CHAR16
*gAdjustNumber
;
607 extern CHAR16
*gSaveChanges
;
608 extern CHAR16
*gOptionMismatch
;
609 extern CHAR16
*gFormSuppress
;
611 extern CHAR16 gPromptBlockWidth
;
612 extern CHAR16 gOptionBlockWidth
;
613 extern CHAR16 gHelpBlockWidth
;
615 extern EFI_GUID gZeroGuid
;
616 extern EFI_GUID gTianoHiiIfrGuid
;
620 // Global Procedure Defines
624 Initialize the HII String Token to the correct values.
628 InitializeBrowserStrings (
633 Prints a unicode string to the default console,
636 @param String String pointer.
638 @return Length of string printed to the console
647 Prints a chracter to the default console,
650 @param Character Character to print.
652 @return Length of string printed to the console.
661 Prints a formatted unicode string to the default console, at
662 the supplied cursor position.
664 @param Column The cursor position to print the string at.
665 @param Row The cursor position to print the string at
666 @param Fmt Format string
667 @param ... Variable argument list for formating string.
669 @return Length of string printed to the console
682 Prints a unicode string to the default console, at
683 the supplied cursor position, using L"%s" format.
685 @param Column The cursor position to print the string at.
686 @param Row The cursor position to print the string at
687 @param String String pointer.
689 @return Length of string printed to the console
700 Prints a chracter to the default console, at
701 the supplied cursor position, using L"%c" format.
703 @param Column The cursor position to print the string at.
704 @param Row The cursor position to print the string at.
705 @param Character Character to print.
707 @return Length of string printed to the console.
718 Parse opcodes in the formset IFR binary.
720 @param FormSet Pointer of the FormSet data structure.
722 @retval EFI_SUCCESS Opcode parse success.
723 @retval Other Opcode parse fail.
728 IN FORM_BROWSER_FORMSET
*FormSet
732 Free resources allocated for a FormSet.
734 @param FormSet Pointer of the FormSet
739 IN OUT FORM_BROWSER_FORMSET
*FormSet
743 This function displays the page frame.
745 @param Selection Selection contains the information about
746 the Selection, form and formset to be displayed.
747 Selection action may be updated in retrieve callback.
751 IN UI_MENU_SELECTION
*Selection
755 Create a new string in HII Package List.
757 @param String The String to be added
758 @param HiiHandle The package list in the HII database to insert the
761 @return The output string.
767 IN EFI_HII_HANDLE HiiHandle
771 Delete a string from HII Package List.
773 @param StringId Id of the string in HII database.
774 @param HiiHandle The HII package list handle.
776 @retval EFI_SUCCESS The string was deleted successfully.
781 IN EFI_STRING_ID StringId
,
782 IN EFI_HII_HANDLE HiiHandle
786 Get the string based on the StringId and HII Package List Handle.
788 @param Token The String's ID.
789 @param HiiHandle The package list in the HII database to search for
790 the specified string.
792 @return The output string.
797 IN EFI_STRING_ID Token
,
798 IN EFI_HII_HANDLE HiiHandle
802 Draw a pop up windows based on the dimension, number of lines and
805 @param RequestedWidth The width of the pop-up.
806 @param NumberOfLines The number of lines.
807 @param Marker The variable argument list for the list of string to be printed.
812 IN UINTN RequestedWidth
,
813 IN UINTN NumberOfLines
,
818 Routine used to abstract a generic dialog interface and return the selected key or string
820 @param NumberOfLines The number of lines for the dialog box
821 @param HotKey Defines whether a single character is parsed
822 (TRUE) and returned in KeyValue or a string is
823 returned in StringBuffer. Two special characters
824 are considered when entering a string, a SCAN_ESC
825 and an CHAR_CARRIAGE_RETURN. SCAN_ESC terminates
826 string input and returns
827 @param MaximumStringSize The maximum size in bytes of a typed in string
828 (each character is a CHAR16) and the minimum
829 string returned is two bytes
830 @param StringBuffer The passed in pointer to the buffer which will
831 hold the typed in string if HotKey is FALSE
832 @param KeyValue The EFI_KEY value returned if HotKey is TRUE..
833 @param ... A series of (quantity == NumberOfLines) text
834 strings which will be used to construct the dialog
837 @retval EFI_SUCCESS Displayed dialog and received user interaction
838 @retval EFI_INVALID_PARAMETER One of the parameters was invalid (e.g.
839 (StringBuffer == NULL) && (HotKey == FALSE))
840 @retval EFI_DEVICE_ERROR User typed in an ESC character to exit the routine
846 IN UINTN NumberOfLines
,
848 IN UINTN MaximumStringSize
,
849 OUT CHAR16
*StringBuffer
,
850 OUT EFI_INPUT_KEY
*KeyValue
,
855 Get Value for given Name from a NameValue Storage.
857 @param Storage The NameValue Storage.
858 @param Name The Name.
859 @param Value The retured Value.
861 @retval EFI_SUCCESS Value found for given Name.
862 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
867 IN FORMSET_STORAGE
*Storage
,
869 IN OUT CHAR16
**Value
873 Set Value of given Name in a NameValue Storage.
875 @param Storage The NameValue Storage.
876 @param Name The Name.
877 @param Value The Value to set.
878 @param Edit Whether update editValue or Value.
880 @retval EFI_SUCCESS Value found for given Name.
881 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
886 IN FORMSET_STORAGE
*Storage
,
893 Get Question's current Value.
895 @param FormSet FormSet data structure.
896 @param Form Form data structure.
897 @param Question Question to be initialized.
898 @param Cached TRUE: get from Edit copy FALSE: get from original
901 @retval EFI_SUCCESS The function completed successfully.
906 IN FORM_BROWSER_FORMSET
*FormSet
,
907 IN FORM_BROWSER_FORM
*Form
,
908 IN OUT FORM_BROWSER_STATEMENT
*Question
,
913 Save Question Value to edit copy(cached) or Storage(uncached).
915 @param FormSet FormSet data structure.
916 @param Form Form data structure.
917 @param Question Pointer to the Question.
918 @param Cached TRUE: set to Edit copy FALSE: set to original
921 @retval EFI_SUCCESS The function completed successfully.
926 IN FORM_BROWSER_FORMSET
*FormSet
,
927 IN FORM_BROWSER_FORM
*Form
,
928 IN OUT FORM_BROWSER_STATEMENT
*Question
,
933 Perform inconsistent check for a Form.
935 @param FormSet FormSet data structure.
936 @param Form Form data structure.
937 @param Question The Question to be validated.
938 @param Type Validation type: InConsistent or NoSubmit
940 @retval EFI_SUCCESS Form validation pass.
941 @retval other Form validation failed.
946 IN FORM_BROWSER_FORMSET
*FormSet
,
947 IN FORM_BROWSER_FORM
*Form
,
948 IN FORM_BROWSER_STATEMENT
*Question
,
954 Discard data based on the input setting scope (Form, FormSet or System).
956 @param FormSet FormSet data structure.
957 @param Form Form data structure.
958 @param SettingScope Setting Scope for Discard action.
960 @retval EFI_SUCCESS The function completed successfully.
961 @retval EFI_UNSUPPORTED Unsupport SettingScope.
966 IN FORM_BROWSER_FORMSET
*FormSet
,
967 IN FORM_BROWSER_FORM
*Form
,
968 IN BROWSER_SETTING_SCOPE SettingScope
972 Submit data based on the input Setting level (Form, FormSet or System).
974 @param FormSet FormSet data structure.
975 @param Form Form data structure.
976 @param SettingScope Setting Scope for Submit action.
978 @retval EFI_SUCCESS The function completed successfully.
979 @retval EFI_UNSUPPORTED Unsupport SettingScope.
984 IN FORM_BROWSER_FORMSET
*FormSet
,
985 IN FORM_BROWSER_FORM
*Form
,
986 IN BROWSER_SETTING_SCOPE SettingScope
990 Reset Question to its default value.
992 @param FormSet The form set.
993 @param Form The form.
994 @param Question The question.
995 @param DefaultId The Class of the default.
997 @retval EFI_SUCCESS Question is reset to default value.
1001 GetQuestionDefault (
1002 IN FORM_BROWSER_FORMSET
*FormSet
,
1003 IN FORM_BROWSER_FORM
*Form
,
1004 IN FORM_BROWSER_STATEMENT
*Question
,
1009 Get current setting of Questions.
1011 @param FormSet FormSet data structure.
1013 @retval EFI_SUCCESS The function completed successfully.
1017 InitializeCurrentSetting (
1018 IN OUT FORM_BROWSER_FORMSET
*FormSet
1022 Initialize the internal data structure of a FormSet.
1024 @param Handle PackageList Handle
1025 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
1026 GUID), take the first FormSet found in package
1028 @param FormSet FormSet data structure.
1029 @param UpdateGlobalVar Whether need to update the global variable.
1031 @retval EFI_SUCCESS The function completed successfully.
1032 @retval EFI_NOT_FOUND The specified FormSet could not be found.
1037 IN EFI_HII_HANDLE Handle
,
1038 IN OUT EFI_GUID
*FormSetGuid
,
1039 OUT FORM_BROWSER_FORMSET
*FormSet
,
1040 IN BOOLEAN UpdateGlobalVar
1044 Reset Questions to their default value in a Form, Formset or System.
1046 @param FormSet FormSet data structure.
1047 @param Form Form data structure.
1048 @param DefaultId The Class of the default.
1049 @param SettingScope Setting Scope for Default action.
1051 @retval EFI_SUCCESS The function completed successfully.
1052 @retval EFI_UNSUPPORTED Unsupport SettingScope.
1057 IN FORM_BROWSER_FORMSET
*FormSet
,
1058 IN FORM_BROWSER_FORM
*Form
,
1059 IN UINT16 DefaultId
,
1060 IN BROWSER_SETTING_SCOPE SettingScope
1064 Initialize Question's Edit copy from Storage.
1066 @param Selection Selection contains the information about
1067 the Selection, form and formset to be displayed.
1068 Selection action may be updated in retrieve callback.
1069 If Selection is NULL, only initialize Question value.
1070 @param FormSet FormSet data structure.
1071 @param Form Form data structure.
1073 @retval EFI_SUCCESS The function completed successfully.
1078 IN OUT UI_MENU_SELECTION
*Selection
,
1079 IN FORM_BROWSER_FORMSET
*FormSet
,
1080 IN FORM_BROWSER_FORM
*Form
1084 Initialize Question's Edit copy from Storage for the whole Formset.
1086 @param Selection Selection contains the information about
1087 the Selection, form and formset to be displayed.
1088 Selection action may be updated in retrieve callback.
1089 If Selection is NULL, only initialize Question value.
1090 @param FormSet FormSet data structure.
1092 @retval EFI_SUCCESS The function completed successfully.
1097 IN OUT UI_MENU_SELECTION
*Selection
,
1098 IN FORM_BROWSER_FORMSET
*FormSet
1102 Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
1104 @param Buffer The Storage to be conveted.
1105 @param ConfigResp The returned <ConfigResp>.
1106 @param SingleForm Whether update data for single form or formset level.
1108 @retval EFI_SUCCESS Convert success.
1109 @retval EFI_INVALID_PARAMETER Incorrect storage type.
1113 StorageToConfigResp (
1115 IN CHAR16
**ConfigResp
,
1116 IN BOOLEAN SingleForm
1120 Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
1122 @param Storage The Storage to receive the settings.
1123 @param ConfigResp The <ConfigResp> to be converted.
1125 @retval EFI_SUCCESS Convert success.
1126 @retval EFI_INVALID_PARAMETER Incorrect storage type.
1130 ConfigRespToStorage (
1131 IN FORMSET_STORAGE
*Storage
,
1132 IN CHAR16
*ConfigResp
1136 Fill storage's edit copy with settings requested from Configuration Driver.
1138 @param FormSet FormSet data structure.
1139 @param Storage Buffer Storage.
1141 @retval EFI_SUCCESS The function completed successfully.
1146 IN FORM_BROWSER_FORMSET
*FormSet
,
1147 IN FORMSET_STORAGE
*Storage
1151 Fetch the Ifr binary data of a FormSet.
1153 @param Handle PackageList Handle
1154 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
1155 GUID), take the first FormSet found in package
1157 @param BinaryLength The length of the FormSet IFR binary.
1158 @param BinaryData The buffer designed to receive the FormSet.
1160 @retval EFI_SUCCESS Buffer filled with the requested FormSet.
1161 BufferLength was updated.
1162 @retval EFI_INVALID_PARAMETER The handle is unknown.
1163 @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot
1164 be found with the requested FormId.
1169 IN EFI_HII_HANDLE Handle
,
1170 IN OUT EFI_GUID
*FormSetGuid
,
1171 OUT UINTN
*BinaryLength
,
1172 OUT UINT8
**BinaryData
1176 Save globals used by previous call to SendForm(). SendForm() may be called from
1177 HiiConfigAccess.Callback(), this will cause SendForm() be reentried.
1178 So, save globals of previous call to SendForm() and restore them upon exit.
1182 SaveBrowserContext (
1187 Restore globals used by previous call to SendForm().
1191 RestoreBrowserContext (
1196 This is the routine which an external caller uses to direct the browser
1197 where to obtain it's information.
1200 @param This The Form Browser protocol instanse.
1201 @param Handles A pointer to an array of Handles. If HandleCount > 1 we
1202 display a list of the formsets for the handles specified.
1203 @param HandleCount The number of Handles specified in Handle.
1204 @param FormSetGuid This field points to the EFI_GUID which must match the Guid
1205 field in the EFI_IFR_FORM_SET op-code for the specified
1206 forms-based package. If FormSetGuid is NULL, then this
1207 function will display the first found forms package.
1208 @param FormId This field specifies which EFI_IFR_FORM to render as the first
1209 displayable page. If this field has a value of 0x0000, then
1210 the forms browser will render the specified forms in their encoded order.
1211 ScreenDimenions - This allows the browser to be called so that it occupies a
1212 portion of the physical screen instead of dynamically determining the screen dimensions.
1213 ActionRequest - Points to the action recommended by the form.
1214 @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
1216 @param ActionRequest Points to the action recommended by the form.
1218 @retval EFI_SUCCESS The function completed successfully.
1219 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1220 @retval EFI_NOT_FOUND No valid forms could be found to display.
1226 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1227 IN EFI_HII_HANDLE
*Handles
,
1228 IN UINTN HandleCount
,
1229 IN EFI_GUID
*FormSetGuid
, OPTIONAL
1230 IN UINT16 FormId
, OPTIONAL
1231 IN CONST EFI_SCREEN_DESCRIPTOR
*ScreenDimensions
, OPTIONAL
1232 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest OPTIONAL
1236 This function is called by a callback handler to retrieve uncommitted state
1237 data from the browser.
1239 @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL
1241 @param ResultsDataSize A pointer to the size of the buffer associated
1243 @param ResultsData A string returned from an IFR browser or
1244 equivalent. The results string will have no
1245 routing information in them.
1246 @param RetrieveData A BOOLEAN field which allows an agent to retrieve
1247 (if RetrieveData = TRUE) data from the uncommitted
1248 browser state information or set (if RetrieveData
1249 = FALSE) data in the uncommitted browser state
1251 @param VariableGuid An optional field to indicate the target variable
1253 @param VariableName An optional field to indicate the target
1254 human-readable variable name.
1256 @retval EFI_SUCCESS The results have been distributed or are awaiting
1258 @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to
1259 contain the results data.
1265 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1266 IN OUT UINTN
*ResultsDataSize
,
1267 IN OUT EFI_STRING ResultsData
,
1268 IN BOOLEAN RetrieveData
,
1269 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
1270 IN CONST CHAR16
*VariableName OPTIONAL
1274 Find menu which will show next time.
1276 @param Selection On input, Selection tell setup browser the information
1277 about the Selection, form and formset to be displayed.
1278 On output, Selection return the screen item that is selected
1280 @param Repaint Whether need to repaint the menu.
1281 @param NewLine Whether need to show at new line.
1283 @retval TRUE Need return.
1284 @retval FALSE No need to return.
1288 IN OUT UI_MENU_SELECTION
*Selection
,
1289 IN BOOLEAN
*Repaint
,
1294 check whether the formset need to update the NV.
1296 @param FormSet FormSet data structure.
1297 @param SetValue Whether set new value or clear old value.
1301 UpdateNvInfoInForm (
1302 IN FORM_BROWSER_FORMSET
*FormSet
,
1307 check whether the formset need to update the NV.
1309 @param FormSet FormSet data structure.
1311 @retval TRUE Need to update the NV.
1312 @retval FALSE No need to update the NV.
1315 IsNvUpdateRequired (
1316 IN FORM_BROWSER_FORMSET
*FormSet
1320 Call the call back function for the question and process the return action.
1322 @param Selection On input, Selection tell setup browser the information
1323 about the Selection, form and formset to be displayed.
1324 On output, Selection return the screen item that is selected
1326 @param Statement The Question which need to call.
1327 @param Action The action request.
1328 @param SkipSaveOrDiscard Whether skip save or discard action.
1330 @retval EFI_SUCCESS The call back function excutes successfully.
1331 @return Other value if the call back function failed to excute.
1334 ProcessCallBackFunction (
1335 IN OUT UI_MENU_SELECTION
*Selection
,
1336 IN FORM_BROWSER_STATEMENT
*Question
,
1337 IN EFI_BROWSER_ACTION Action
,
1338 IN BOOLEAN SkipSaveOrDiscard
1342 Find the matched FormSet context in the backup maintain list based on HiiHandle.
1344 @param Handle The Hii Handle.
1346 @return the found FormSet context. If no found, NULL will return.
1349 FORM_BROWSER_FORMSET
*
1350 GetFormSetFromHiiHandle (
1351 EFI_HII_HANDLE Handle
1355 Check whether the input HII handle is the FormSet that is being used.
1357 @param Handle The Hii Handle.
1359 @retval TRUE HII handle is being used.
1360 @retval FALSE HII handle is not being used.
1364 IsHiiHandleInBrowserContext (
1365 EFI_HII_HANDLE Handle
1369 Configure what scope the hot key will impact.
1370 All hot keys have the same scope. The mixed hot keys with the different level are not supported.
1371 If no scope is set, the default scope will be FormSet level.
1372 After all registered hot keys are removed, previous Scope can reset to another level.
1374 @param[in] Scope Scope level to be set.
1376 @retval EFI_SUCCESS Scope is set correctly.
1377 @retval EFI_INVALID_PARAMETER Scope is not the valid value specified in BROWSER_SETTING_SCOPE.
1378 @retval EFI_UNSPPORTED Scope level is different from current one that the registered hot keys have.
1384 IN BROWSER_SETTING_SCOPE Scope
1388 Register the hot key with its browser action, or unregistered the hot key.
1389 Only support hot key that is not printable character (control key, function key, etc.).
1390 If the action value is zero, the hot key will be unregistered if it has been registered.
1391 If the same hot key has been registered, the new action and help string will override the previous ones.
1393 @param[in] KeyData A pointer to a buffer that describes the keystroke
1394 information for the hot key. Its type is EFI_INPUT_KEY to
1395 be supported by all ConsoleIn devices.
1396 @param[in] Action Action value that describes what action will be trigged when the hot key is pressed.
1397 @param[in] DefaultId Specifies the type of defaults to retrieve, which is only for DEFAULT action.
1398 @param[in] HelpString Help string that describes the hot key information.
1399 Its value may be NULL for the unregistered hot key.
1401 @retval EFI_SUCCESS Hot key is registered or unregistered.
1402 @retval EFI_INVALID_PARAMETER KeyData is NULL.
1403 @retval EFI_NOT_FOUND KeyData is not found to be unregistered.
1404 @retval EFI_UNSUPPORTED Key represents a printable character. It is conflicted with Browser.
1409 IN EFI_INPUT_KEY
*KeyData
,
1411 IN UINT16 DefaultId
,
1412 IN EFI_STRING HelpString OPTIONAL
1416 Register Exit handler function.
1417 When more than one handler function is registered, the latter one will override the previous one.
1418 When NULL handler is specified, the previous Exit handler will be unregistered.
1420 @param[in] Handler Pointer to handler function.
1425 RegiserExitHandler (
1426 IN EXIT_HANDLER Handler
1430 Create reminder to let user to choose save or discard the changed browser data.
1431 Caller can use it to actively check the changed browser data.
1433 @retval BROWSER_NO_CHANGES No browser data is changed.
1434 @retval BROWSER_SAVE_CHANGES The changed browser data is saved.
1435 @retval BROWSER_DISCARD_CHANGES The changed browser data is discard.
1445 Find the registered HotKey based on KeyData.
1447 @param[in] KeyData A pointer to a buffer that describes the keystroke
1448 information for the hot key.
1450 @return The registered HotKey context. If no found, NULL will return.
1453 GetHotKeyFromRegisterList (
1454 IN EFI_INPUT_KEY
*KeyData