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/DevicePath.h>
26 #include <Protocol/UnicodeCollation.h>
27 #include <Protocol/HiiConfigAccess.h>
28 #include <Protocol/HiiConfigRouting.h>
29 #include <Protocol/HiiDatabase.h>
30 #include <Protocol/HiiString.h>
31 #include <Protocol/UserManager.h>
33 #include <Guid/MdeModuleHii.h>
34 #include <Guid/HiiPlatformSetupFormset.h>
35 #include <Guid/HiiFormMapMethodGuid.h>
37 #include <Library/PrintLib.h>
38 #include <Library/DebugLib.h>
39 #include <Library/BaseMemoryLib.h>
40 #include <Library/UefiRuntimeServicesTableLib.h>
41 #include <Library/UefiDriverEntryPoint.h>
42 #include <Library/UefiBootServicesTableLib.h>
43 #include <Library/BaseLib.h>
44 #include <Library/MemoryAllocationLib.h>
45 #include <Library/HiiLib.h>
46 #include <Library/PcdLib.h>
47 #include <Library/DevicePathLib.h>
52 // This is the generated header file which includes whatever needs to be exported (strings + IFR)
55 extern UINT8 SetupBrowserStrings
[];
60 #define BANNER_HEIGHT 6
61 #define BANNER_COLUMNS 3
62 #define BANNER_LEFT_COLUMN_INDENT 1
64 #define FRONT_PAGE_HEADER_HEIGHT 6
65 #define NONE_FRONT_PAGE_HEADER_HEIGHT 3
66 #define LEFT_SKIPPED_COLUMNS 3
67 #define FOOTER_HEIGHT 4
68 #define STATUS_BAR_HEIGHT 1
69 #define SCROLL_ARROW_HEIGHT 1
70 #define POPUP_PAD_SPACE_COUNT 5
71 #define POPUP_FRAME_WIDTH 2
74 // Definition for function key setting
76 #define NONE_FUNCTION_KEY_SETTING 0
77 #define DEFAULT_FUNCTION_KEY_SETTING (FUNCTION_NINE | FUNCTION_TEN)
79 #define FUNCTION_NINE (1 << 2)
80 #define FUNCTION_TEN (1 << 3)
85 } FUNCTIION_KEY_SETTING
;
88 // Character definitions
90 #define CHAR_SPACE 0x0020
91 #define UPPER_LOWER_CASE_OFFSET 0x20
96 #define ONE_SECOND 10000000
99 // Display definitions
101 #define LEFT_HYPER_DELIMITER L'<'
102 #define RIGHT_HYPER_DELIMITER L'>'
104 #define LEFT_ONEOF_DELIMITER L'<'
105 #define RIGHT_ONEOF_DELIMITER L'>'
107 #define LEFT_NUMERIC_DELIMITER L'['
108 #define RIGHT_NUMERIC_DELIMITER L']'
110 #define LEFT_CHECKBOX_DELIMITER L'['
111 #define RIGHT_CHECKBOX_DELIMITER L']'
113 #define CHECK_ON L'X'
114 #define CHECK_OFF L' '
116 #define TIME_SEPARATOR L':'
117 #define DATE_SEPARATOR L'/'
119 #define YES_ANSWER L'Y'
120 #define NO_ANSWER L'N'
123 // This is the Input Error Message
125 #define INPUT_ERROR 1
128 // This is the NV RAM update required Message
130 #define NV_UPDATE_REQUIRED 2
133 // Refresh the Status Bar with flags
135 #define REFRESH_STATUS_BAR 0xff
138 // Incremental string lenght of ConfigRequest
140 #define CONFIG_REQUEST_STRING_INCREMENTAL 1024
143 // HII value compare result
145 #define HII_VALUE_UNDEFINED 0
146 #define HII_VALUE_EQUAL 1
147 #define HII_VALUE_LESS_THAN 2
148 #define HII_VALUE_GREATER_THAN 3
151 // Incremental size of stack for expression
153 #define EXPRESSION_STACK_SIZE_INCREMENT 0x100
155 #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))
158 #define SETUP_DRIVER_SIGNATURE SIGNATURE_32 ('F', 'B', 'D', 'V')
167 EFI_FORM_BROWSER2_PROTOCOL FormBrowser2
;
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
192 #define FORM_INCONSISTENT_VALIDATION 0
193 #define FORM_NO_SUBMIT_VALIDATION 1
195 #define FORMSET_CLASS_PLATFORM_SETUP 0x0001
196 #define FORMSET_CLASS_FRONT_PAGE 0x0002
200 EFI_IFR_TYPE_VALUE Value
;
203 #define NAME_VALUE_NODE_SIGNATURE SIGNATURE_32 ('N', 'V', 'S', 'T')
213 #define NAME_VALUE_NODE_FROM_LINK(a) CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)
215 #define FORMSET_STORAGE_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'G')
221 UINT8 Type
; // Storage type
226 CHAR16
*Name
; // For EFI_IFR_VARSTORE
229 UINT8
*EditBuffer
; // Edit copy for Buffer Storage
231 LIST_ENTRY NameValueListHead
; // List of NAME_VALUE_NODE
233 UINT32 Attributes
; // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute
235 CHAR16
*ConfigHdr
; // <ConfigHdr>
236 CHAR16
*ConfigRequest
; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
237 UINTN ElementCount
; // Number of <RequestElement> in the <ConfigRequest>
238 UINTN SpareStrLen
; // Spare length of ConfigRequest string buffer
241 #define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)
244 EFI_STRING_ID VarName
;
248 #define EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')
256 UINT8 Format
; // For EFI_IFR_TO_STRING, EFI_IFR_FIND
257 UINT8 Flags
; // For EFI_IFR_SPAN
258 UINT8 RuleId
; // For EFI_IFR_RULE_REF
260 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
262 EFI_QUESTION_ID QuestionId
; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1
263 EFI_QUESTION_ID QuestionId2
;
265 UINT16 ListLength
; // For EFI_IFR_EQ_ID_VAL_LIST
268 EFI_STRING_ID DevicePath
; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3
271 FORMSET_STORAGE
*VarStorage
; // For EFI_IFR_SET, EFI_IFR_GET
272 VAR_STORE_INFO VarStoreInfo
;// For EFI_IFR_SET, EFI_IFR_GET
273 UINT8 ValueType
; // For EFI_IFR_SET, EFI_IFR_GET
274 UINT8 ValueWidth
; // For EFI_IFR_SET, EFI_IFR_GET
275 CHAR16
*ValueName
; // For EFI_IFR_SET, EFI_IFR_GET
276 LIST_ENTRY MapExpressionList
; // nested expressions inside of Map opcode.
279 #define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)
281 #define FORM_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')
287 UINT8 Type
; // Type for this expression
289 UINT8 RuleId
; // For EFI_IFR_RULE only
290 EFI_STRING_ID Error
; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only
292 EFI_HII_VALUE Result
; // Expression evaluation result
294 LIST_ENTRY OpCodeListHead
; // OpCodes consist of this expression (EXPRESSION_OPCODE)
297 #define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)
299 #define QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')
306 EFI_HII_VALUE Value
; // Default value
308 FORM_EXPRESSION
*ValueExpression
; // Not-NULL indicates default value is provided by EFI_IFR_VALUE
311 #define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)
313 #define QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')
322 EFI_IMAGE_ID ImageId
;
324 FORM_EXPRESSION
*SuppressExpression
; // Non-NULL indicates nested inside of SuppressIf
327 #define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)
329 #define FORM_BROWSER_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')
335 UINT8 Operand
; // The operand (first byte) of this Statement or Question
340 EFI_STRING_ID Prompt
;
342 EFI_STRING_ID TextTwo
; // For EFI_IFR_TEXT
347 EFI_QUESTION_ID QuestionId
; // The value of zero is reserved
348 EFI_VARSTORE_ID VarStoreId
; // A value of zero indicates no variable storage
349 FORMSET_STORAGE
*Storage
;
350 VAR_STORE_INFO VarStoreInfo
;
353 CHAR16
*VariableName
; // Name/Value or EFI Variable name
354 CHAR16
*BlockName
; // Buffer storage block name: "OFFSET=...WIDTH=..."
356 EFI_HII_VALUE HiiValue
; // Edit copy for checkbox, numberic, oneof
357 UINT8
*BufferValue
; // Edit copy for string, password, orderedlist
358 UINT8 ValueType
; // Data type for orderedlist value array
361 // OpCode specific members
363 UINT8 Flags
; // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,
364 // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER
365 UINT8 MaxContainers
; // for EFI_IFR_ORDERED_LIST
367 UINT16 BannerLineNumber
; // for EFI_IFR_BANNER, 1-based line number
368 EFI_STRING_ID QuestionConfig
; // for EFI_IFR_ACTION, if 0 then no configuration string will be processed
370 UINT64 Minimum
; // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value
371 UINT64 Maximum
; // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length
374 EFI_DEFAULT_ID DefaultId
; // for EFI_IFR_RESET_BUTTON
375 EFI_GUID RefreshGuid
; // for EFI_IFR_REFRESH_ID
378 // Get from IFR parsing
380 FORM_EXPRESSION
*ValueExpression
; // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly
381 LIST_ENTRY DefaultListHead
; // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values
382 LIST_ENTRY OptionListHead
; // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)
384 EFI_IMAGE_ID ImageId
; // nested EFI_IFR_IMAGE
385 UINT8 RefreshInterval
; // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh
386 BOOLEAN InSubtitle
; // nesting inside of EFI_IFR_SUBTITLE
388 LIST_ENTRY InconsistentListHead
;// nested inconsistent expression list (FORM_EXPRESSION)
389 LIST_ENTRY NoSubmitListHead
; // nested nosubmit expression list (FORM_EXPRESSION)
390 FORM_EXPRESSION
*GrayOutExpression
; // nesting inside of GrayOutIf
391 FORM_EXPRESSION
*SuppressExpression
; // nesting inside of SuppressIf
392 FORM_EXPRESSION
*DisableExpression
; // nesting inside of DisableIf
394 FORM_EXPRESSION
*ReadExpression
; // nested EFI_IFR_READ, provide this question value by read expression.
395 FORM_EXPRESSION
*WriteExpression
; // nested EFI_IFR_WRITE, evaluate write expression after this question value is set.
396 } FORM_BROWSER_STATEMENT
;
398 #define FORM_BROWSER_STATEMENT_FROM_LINK(a) CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)
400 #define FORM_BROWSER_CONFIG_REQUEST_SIGNATURE SIGNATURE_32 ('F', 'C', 'R', 'S')
405 CHAR16
*ConfigRequest
; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
406 UINTN ElementCount
; // Number of <RequestElement> in the <ConfigRequest>
409 FORMSET_STORAGE
*Storage
;
410 } FORM_BROWSER_CONFIG_REQUEST
;
411 #define FORM_BROWSER_CONFIG_REQUEST_FROM_LINK(a) CR (a, FORM_BROWSER_CONFIG_REQUEST, Link, FORM_BROWSER_CONFIG_REQUEST_SIGNATURE)
413 #define FORM_BROWSER_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')
414 #define STANDARD_MAP_FORM_TYPE 0x01
420 UINT16 FormId
; // FormId of normal form or formmap form.
421 EFI_STRING_ID FormTitle
; // FormTile of normal form, or FormMapMethod title of formmap form.
422 UINT16 FormType
; // Specific form type for the different form.
424 EFI_IMAGE_ID ImageId
;
426 BOOLEAN ModalForm
; // Whether this is a modal form.
428 BOOLEAN NvUpdateRequired
; // Whether this form has NV update request.
430 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
431 LIST_ENTRY StatementListHead
; // List of Statements and Questions (FORM_BROWSER_STATEMENT)
432 LIST_ENTRY ConfigRequestHead
; // List of configreques for all storage.
433 FORM_EXPRESSION
*SuppressExpression
; // nesting inside of SuppressIf
436 #define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)
438 #define FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')
445 EFI_STRING_ID DefaultName
;
446 } FORMSET_DEFAULTSTORE
;
448 #define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)
451 EFI_HII_HANDLE HiiHandle
;
452 EFI_HANDLE DriverHandle
;
453 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
454 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
456 UINTN IfrBinaryLength
;
457 UINT8
*IfrBinaryData
;
460 EFI_STRING_ID FormSetTitle
;
462 UINT8 NumberOfClassGuid
;
463 EFI_GUID ClassGuid
[3]; // Up to three ClassGuid
464 UINT16 Class
; // Tiano extended Class code
465 UINT16 SubClass
; // Tiano extended Subclass code
466 EFI_IMAGE_ID ImageId
;
468 FORM_BROWSER_STATEMENT
*StatementBuffer
; // Buffer for all Statements and Questions
469 EXPRESSION_OPCODE
*ExpressionBuffer
; // Buffer for all Expression OpCode
471 LIST_ENTRY StorageListHead
; // Storage list (FORMSET_STORAGE)
472 LIST_ENTRY DefaultStoreListHead
; // DefaultStore list (FORMSET_DEFAULTSTORE)
473 LIST_ENTRY FormListHead
; // Form list (FORM_BROWSER_FORM)
474 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
475 } FORM_BROWSER_FORMSET
;
477 #define BROWSER_CONTEXT_SIGNATURE SIGNATURE_32 ('B', 'C', 'T', 'X')
484 // Globals defined in Setup.c
486 BANNER_DATA
*BannerData
;
488 UINTN FunctionKeySetting
;
489 BOOLEAN ResetRequired
;
491 EFI_SCREEN_DESCRIPTOR ScreenDimensions
;
492 CHAR16
*FunctionNineString
;
493 CHAR16
*FunctionTenString
;
495 CHAR16
*EnterCommitString
;
496 CHAR16
*EnterEscapeString
;
497 CHAR16
*EscapeString
;
499 CHAR16
*MoveHighlight
;
500 CHAR16
*MakeSelection
;
501 CHAR16
*DecNumericInput
;
502 CHAR16
*HexNumericInput
;
503 CHAR16
*ToggleCheckBox
;
504 CHAR16
*PromptForData
;
505 CHAR16
*PromptForPassword
;
506 CHAR16
*PromptForNewPassword
;
507 CHAR16
*ConfirmPassword
;
508 CHAR16
*ConfirmError
;
509 CHAR16
*PassowordInvalid
;
518 CHAR16
*AdjustNumber
;
520 CHAR16
*OptionMismatch
;
521 CHAR16
*FormSuppress
;
522 CHAR16 PromptBlockWidth
;
523 CHAR16 OptionBlockWidth
;
524 CHAR16 HelpBlockWidth
;
525 FORM_BROWSER_FORMSET
*OldFormSet
;
528 // Globals defined in Ui.c
530 LIST_ENTRY MenuOption
;
531 VOID
*MenuRefreshHead
;
534 #define BROWSER_CONTEXT_FROM_LINK(a) CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)
536 extern EFI_HII_DATABASE_PROTOCOL
*mHiiDatabase
;
537 extern EFI_HII_STRING_PROTOCOL
*mHiiString
;
538 extern EFI_HII_CONFIG_ROUTING_PROTOCOL
*mHiiConfigRouting
;
540 extern BANNER_DATA
*gBannerData
;
541 extern EFI_HII_HANDLE gFrontPageHandle
;
542 extern UINTN gClassOfVfr
;
543 extern UINTN gFunctionKeySetting
;
544 extern BOOLEAN gResetRequired
;
545 extern EFI_HII_HANDLE gHiiHandle
;
546 extern UINT16 gDirection
;
547 extern EFI_SCREEN_DESCRIPTOR gScreenDimensions
;
549 extern FORM_BROWSER_FORMSET
*gOldFormSet
;
552 // Browser Global Strings
554 extern CHAR16
*gFunctionNineString
;
555 extern CHAR16
*gFunctionTenString
;
556 extern CHAR16
*gEnterString
;
557 extern CHAR16
*gEnterCommitString
;
558 extern CHAR16
*gEnterEscapeString
;
559 extern CHAR16
*gEscapeString
;
560 extern CHAR16
*gSaveFailed
;
561 extern CHAR16
*gMoveHighlight
;
562 extern CHAR16
*gMakeSelection
;
563 extern CHAR16
*gDecNumericInput
;
564 extern CHAR16
*gHexNumericInput
;
565 extern CHAR16
*gToggleCheckBox
;
566 extern CHAR16
*gPromptForData
;
567 extern CHAR16
*gPromptForPassword
;
568 extern CHAR16
*gPromptForNewPassword
;
569 extern CHAR16
*gConfirmPassword
;
570 extern CHAR16
*gConfirmError
;
571 extern CHAR16
*gPassowordInvalid
;
572 extern CHAR16
*gPressEnter
;
573 extern CHAR16
*gEmptyString
;
574 extern CHAR16
*gAreYouSure
;
575 extern CHAR16
*gYesResponse
;
576 extern CHAR16
*gNoResponse
;
577 extern CHAR16
*gMiniString
;
578 extern CHAR16
*gPlusString
;
579 extern CHAR16
*gMinusString
;
580 extern CHAR16
*gAdjustNumber
;
581 extern CHAR16
*gSaveChanges
;
582 extern CHAR16
*gOptionMismatch
;
583 extern CHAR16
*gFormSuppress
;
585 extern CHAR16 gPromptBlockWidth
;
586 extern CHAR16 gOptionBlockWidth
;
587 extern CHAR16 gHelpBlockWidth
;
589 extern EFI_GUID gZeroGuid
;
590 extern EFI_GUID gTianoHiiIfrGuid
;
594 // Global Procedure Defines
598 Initialize the HII String Token to the correct values.
602 InitializeBrowserStrings (
607 Prints a unicode string to the default console,
610 @param String String pointer.
612 @return Length of string printed to the console
621 Prints a chracter to the default console,
624 @param Character Character to print.
626 @return Length of string printed to the console.
635 Prints a formatted unicode string to the default console, at
636 the supplied cursor position.
638 @param Column The cursor position to print the string at.
639 @param Row The cursor position to print the string at
640 @param Fmt Format string
641 @param ... Variable argument list for formating string.
643 @return Length of string printed to the console
656 Prints a unicode string to the default console, at
657 the supplied cursor position, using L"%s" format.
659 @param Column The cursor position to print the string at.
660 @param Row The cursor position to print the string at
661 @param String String pointer.
663 @return Length of string printed to the console
674 Prints a chracter to the default console, at
675 the supplied cursor position, using L"%c" format.
677 @param Column The cursor position to print the string at.
678 @param Row The cursor position to print the string at.
679 @param Character Character to print.
681 @return Length of string printed to the console.
692 Parse opcodes in the formset IFR binary.
694 @param FormSet Pointer of the FormSet data structure.
696 @retval EFI_SUCCESS Opcode parse success.
697 @retval Other Opcode parse fail.
702 IN FORM_BROWSER_FORMSET
*FormSet
706 Free resources allocated for a FormSet.
708 @param FormSet Pointer of the FormSet
713 IN OUT FORM_BROWSER_FORMSET
*FormSet
717 This function displays the page frame.
719 @param Selection Selection contains the information about
720 the Selection, form and formset to be displayed.
721 Selection action may be updated in retrieve callback.
725 IN UI_MENU_SELECTION
*Selection
729 Create a new string in HII Package List.
731 @param String The String to be added
732 @param HiiHandle The package list in the HII database to insert the
735 @return The output string.
741 IN EFI_HII_HANDLE HiiHandle
745 Delete a string from HII Package List.
747 @param StringId Id of the string in HII database.
748 @param HiiHandle The HII package list handle.
750 @retval EFI_SUCCESS The string was deleted successfully.
755 IN EFI_STRING_ID StringId
,
756 IN EFI_HII_HANDLE HiiHandle
760 Get the string based on the StringId and HII Package List Handle.
762 @param Token The String's ID.
763 @param HiiHandle The package list in the HII database to search for
764 the specified string.
766 @return The output string.
771 IN EFI_STRING_ID Token
,
772 IN EFI_HII_HANDLE HiiHandle
776 Draw a pop up windows based on the dimension, number of lines and
779 @param RequestedWidth The width of the pop-up.
780 @param NumberOfLines The number of lines.
781 @param Marker The variable argument list for the list of string to be printed.
786 IN UINTN RequestedWidth
,
787 IN UINTN NumberOfLines
,
792 Routine used to abstract a generic dialog interface and return the selected key or string
794 @param NumberOfLines The number of lines for the dialog box
795 @param HotKey Defines whether a single character is parsed
796 (TRUE) and returned in KeyValue or a string is
797 returned in StringBuffer. Two special characters
798 are considered when entering a string, a SCAN_ESC
799 and an CHAR_CARRIAGE_RETURN. SCAN_ESC terminates
800 string input and returns
801 @param MaximumStringSize The maximum size in bytes of a typed in string
802 (each character is a CHAR16) and the minimum
803 string returned is two bytes
804 @param StringBuffer The passed in pointer to the buffer which will
805 hold the typed in string if HotKey is FALSE
806 @param KeyValue The EFI_KEY value returned if HotKey is TRUE..
807 @param ... A series of (quantity == NumberOfLines) text
808 strings which will be used to construct the dialog
811 @retval EFI_SUCCESS Displayed dialog and received user interaction
812 @retval EFI_INVALID_PARAMETER One of the parameters was invalid (e.g.
813 (StringBuffer == NULL) && (HotKey == FALSE))
814 @retval EFI_DEVICE_ERROR User typed in an ESC character to exit the routine
820 IN UINTN NumberOfLines
,
822 IN UINTN MaximumStringSize
,
823 OUT CHAR16
*StringBuffer
,
824 OUT EFI_INPUT_KEY
*KeyValue
,
829 Get Value for given Name from a NameValue Storage.
831 @param Storage The NameValue Storage.
832 @param Name The Name.
833 @param Value The retured Value.
835 @retval EFI_SUCCESS Value found for given Name.
836 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
841 IN FORMSET_STORAGE
*Storage
,
843 IN OUT CHAR16
**Value
847 Set Value of given Name in a NameValue Storage.
849 @param Storage The NameValue Storage.
850 @param Name The Name.
851 @param Value The Value to set.
852 @param Edit Whether update editValue or Value.
854 @retval EFI_SUCCESS Value found for given Name.
855 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
860 IN FORMSET_STORAGE
*Storage
,
867 Get Question's current Value.
869 @param FormSet FormSet data structure.
870 @param Form Form data structure.
871 @param Question Question to be initialized.
872 @param Cached TRUE: get from Edit copy FALSE: get from original
875 @retval EFI_SUCCESS The function completed successfully.
880 IN FORM_BROWSER_FORMSET
*FormSet
,
881 IN FORM_BROWSER_FORM
*Form
,
882 IN OUT FORM_BROWSER_STATEMENT
*Question
,
887 Save Question Value to edit copy(cached) or Storage(uncached).
889 @param FormSet FormSet data structure.
890 @param Form Form data structure.
891 @param Question Pointer to the Question.
892 @param Cached TRUE: set to Edit copy FALSE: set to original
895 @retval EFI_SUCCESS The function completed successfully.
900 IN FORM_BROWSER_FORMSET
*FormSet
,
901 IN FORM_BROWSER_FORM
*Form
,
902 IN OUT FORM_BROWSER_STATEMENT
*Question
,
907 Perform inconsistent check for a Form.
909 @param FormSet FormSet data structure.
910 @param Form Form data structure.
911 @param Question The Question to be validated.
912 @param Type Validation type: InConsistent or NoSubmit
914 @retval EFI_SUCCESS Form validation pass.
915 @retval other Form validation failed.
920 IN FORM_BROWSER_FORMSET
*FormSet
,
921 IN FORM_BROWSER_FORM
*Form
,
922 IN FORM_BROWSER_STATEMENT
*Question
,
927 Discard data for form level or formset level.
929 @param FormSet FormSet data structure.
930 @param Form Form data structure.
931 @param SingleForm whether submit single form or formset.
933 @retval EFI_SUCCESS The function completed successfully.
938 IN FORM_BROWSER_FORMSET
*FormSet
,
939 IN FORM_BROWSER_FORM
*Form
,
940 IN BOOLEAN SingleForm
944 Submit data for form level or formset level.
946 @param FormSet FormSet data structure.
947 @param Form Form data structure.
948 @param SingleForm whether submit single form or formset.
950 @retval EFI_SUCCESS The function completed successfully.
955 IN FORM_BROWSER_FORMSET
*FormSet
,
956 IN FORM_BROWSER_FORM
*Form
,
957 IN BOOLEAN SingleForm
961 Reset Question to its default value.
963 @param FormSet The form set.
964 @param Form The form.
965 @param Question The question.
966 @param DefaultId The Class of the default.
968 @retval EFI_SUCCESS Question is reset to default value.
973 IN FORM_BROWSER_FORMSET
*FormSet
,
974 IN FORM_BROWSER_FORM
*Form
,
975 IN FORM_BROWSER_STATEMENT
*Question
,
980 Get current setting of Questions.
982 @param FormSet FormSet data structure.
984 @retval EFI_SUCCESS The function completed successfully.
988 InitializeCurrentSetting (
989 IN OUT FORM_BROWSER_FORMSET
*FormSet
993 Initialize the internal data structure of a FormSet.
995 @param Handle PackageList Handle
996 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
997 GUID), take the first FormSet found in package
999 @param FormSet FormSet data structure.
1001 @retval EFI_SUCCESS The function completed successfully.
1002 @retval EFI_NOT_FOUND The specified FormSet could not be found.
1007 IN EFI_HII_HANDLE Handle
,
1008 IN OUT EFI_GUID
*FormSetGuid
,
1009 OUT FORM_BROWSER_FORMSET
*FormSet
1013 Reset Questions in a Formset to their default value.
1015 @param FormSet FormSet data structure.
1016 @param DefaultId The Class of the default.
1018 @retval EFI_SUCCESS The function completed successfully.
1022 ExtractFormSetDefault (
1023 IN FORM_BROWSER_FORMSET
*FormSet
,
1028 Initialize Question's Edit copy from Storage.
1030 @param Selection Selection contains the information about
1031 the Selection, form and formset to be displayed.
1032 Selection action may be updated in retrieve callback.
1033 @param FormSet FormSet data structure.
1034 @param Form Form data structure.
1036 @retval EFI_SUCCESS The function completed successfully.
1041 IN OUT UI_MENU_SELECTION
*Selection
,
1042 IN FORM_BROWSER_FORMSET
*FormSet
,
1043 IN FORM_BROWSER_FORM
*Form
1047 Initialize Question's Edit copy from Storage for the whole Formset.
1049 @param Selection Selection contains the information about
1050 the Selection, form and formset to be displayed.
1051 Selection action may be updated in retrieve callback.
1052 @param FormSet FormSet data structure.
1054 @retval EFI_SUCCESS The function completed successfully.
1059 IN OUT UI_MENU_SELECTION
*Selection
,
1060 IN FORM_BROWSER_FORMSET
*FormSet
1064 Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
1066 @param Buffer The Storage to be conveted.
1067 @param ConfigResp The returned <ConfigResp>.
1068 @param SingleForm Whether update data for single form or formset level.
1070 @retval EFI_SUCCESS Convert success.
1071 @retval EFI_INVALID_PARAMETER Incorrect storage type.
1075 StorageToConfigResp (
1077 IN CHAR16
**ConfigResp
,
1078 IN BOOLEAN SingleForm
1082 Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
1084 @param Storage The Storage to receive the settings.
1085 @param ConfigResp The <ConfigResp> to be converted.
1087 @retval EFI_SUCCESS Convert success.
1088 @retval EFI_INVALID_PARAMETER Incorrect storage type.
1092 ConfigRespToStorage (
1093 IN FORMSET_STORAGE
*Storage
,
1094 IN CHAR16
*ConfigResp
1098 Fill storage's edit copy with settings requested from Configuration Driver.
1100 @param FormSet FormSet data structure.
1101 @param Storage Buffer Storage.
1103 @retval EFI_SUCCESS The function completed successfully.
1108 IN FORM_BROWSER_FORMSET
*FormSet
,
1109 IN FORMSET_STORAGE
*Storage
1113 Fetch the Ifr binary data of a FormSet.
1115 @param Handle PackageList Handle
1116 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
1117 GUID), take the first FormSet found in package
1119 @param BinaryLength The length of the FormSet IFR binary.
1120 @param BinaryData The buffer designed to receive the FormSet.
1122 @retval EFI_SUCCESS Buffer filled with the requested FormSet.
1123 BufferLength was updated.
1124 @retval EFI_INVALID_PARAMETER The handle is unknown.
1125 @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot
1126 be found with the requested FormId.
1131 IN EFI_HII_HANDLE Handle
,
1132 IN OUT EFI_GUID
*FormSetGuid
,
1133 OUT UINTN
*BinaryLength
,
1134 OUT UINT8
**BinaryData
1138 Save globals used by previous call to SendForm(). SendForm() may be called from
1139 HiiConfigAccess.Callback(), this will cause SendForm() be reentried.
1140 So, save globals of previous call to SendForm() and restore them upon exit.
1144 SaveBrowserContext (
1149 Restore globals used by previous call to SendForm().
1153 RestoreBrowserContext (
1158 This is the routine which an external caller uses to direct the browser
1159 where to obtain it's information.
1162 @param This The Form Browser protocol instanse.
1163 @param Handles A pointer to an array of Handles. If HandleCount > 1 we
1164 display a list of the formsets for the handles specified.
1165 @param HandleCount The number of Handles specified in Handle.
1166 @param FormSetGuid This field points to the EFI_GUID which must match the Guid
1167 field in the EFI_IFR_FORM_SET op-code for the specified
1168 forms-based package. If FormSetGuid is NULL, then this
1169 function will display the first found forms package.
1170 @param FormId This field specifies which EFI_IFR_FORM to render as the first
1171 displayable page. If this field has a value of 0x0000, then
1172 the forms browser will render the specified forms in their encoded order.
1173 ScreenDimenions - This allows the browser to be called so that it occupies a
1174 portion of the physical screen instead of dynamically determining the screen dimensions.
1175 ActionRequest - Points to the action recommended by the form.
1176 @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
1178 @param ActionRequest Points to the action recommended by the form.
1180 @retval EFI_SUCCESS The function completed successfully.
1181 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1182 @retval EFI_NOT_FOUND No valid forms could be found to display.
1188 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1189 IN EFI_HII_HANDLE
*Handles
,
1190 IN UINTN HandleCount
,
1191 IN EFI_GUID
*FormSetGuid
, OPTIONAL
1192 IN UINT16 FormId
, OPTIONAL
1193 IN CONST EFI_SCREEN_DESCRIPTOR
*ScreenDimensions
, OPTIONAL
1194 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest OPTIONAL
1198 This function is called by a callback handler to retrieve uncommitted state
1199 data from the browser.
1201 @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL
1203 @param ResultsDataSize A pointer to the size of the buffer associated
1205 @param ResultsData A string returned from an IFR browser or
1206 equivalent. The results string will have no
1207 routing information in them.
1208 @param RetrieveData A BOOLEAN field which allows an agent to retrieve
1209 (if RetrieveData = TRUE) data from the uncommitted
1210 browser state information or set (if RetrieveData
1211 = FALSE) data in the uncommitted browser state
1213 @param VariableGuid An optional field to indicate the target variable
1215 @param VariableName An optional field to indicate the target
1216 human-readable variable name.
1218 @retval EFI_SUCCESS The results have been distributed or are awaiting
1220 @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to
1221 contain the results data.
1227 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1228 IN OUT UINTN
*ResultsDataSize
,
1229 IN OUT EFI_STRING ResultsData
,
1230 IN BOOLEAN RetrieveData
,
1231 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
1232 IN CONST CHAR16
*VariableName OPTIONAL
1236 Find menu which will show next time.
1238 @param Selection On input, Selection tell setup browser the information
1239 about the Selection, form and formset to be displayed.
1240 On output, Selection return the screen item that is selected
1242 @param Repaint Whether need to repaint the menu.
1243 @param NewLine Whether need to show at new line.
1245 @retval TRUE Need return.
1246 @retval FALSE No need to return.
1250 IN OUT UI_MENU_SELECTION
*Selection
,
1251 IN BOOLEAN
*Repaint
,
1256 check whether the formset need to update the NV.
1258 @param FormSet FormSet data structure.
1259 @param SetValue Whether set new value or clear old value.
1263 UpdateNvInfoInForm (
1264 IN FORM_BROWSER_FORMSET
*FormSet
,
1269 check whether the formset need to update the NV.
1271 @param FormSet FormSet data structure.
1273 @retval TRUE Need to update the NV.
1274 @retval FALSE No need to update the NV.
1277 IsNvUpdateRequired (
1278 IN FORM_BROWSER_FORMSET
*FormSet
1282 Call the call back function for the question and process the return action.
1284 @param Selection On input, Selection tell setup browser the information
1285 about the Selection, form and formset to be displayed.
1286 On output, Selection return the screen item that is selected
1288 @param Statement The Question which need to call.
1289 @param Action The action request.
1290 @param SkipSaveOrDiscard Whether skip save or discard action.
1292 @retval EFI_SUCCESS The call back function excutes successfully.
1293 @return Other value if the call back function failed to excute.
1296 ProcessCallBackFunction (
1297 IN OUT UI_MENU_SELECTION
*Selection
,
1298 IN FORM_BROWSER_STATEMENT
*Question
,
1299 IN EFI_BROWSER_ACTION Action
,
1300 IN BOOLEAN SkipSaveOrDiscard