2 Private MACRO, structure and function definitions for Setup Browser module.
4 Copyright (c) 2007 - 2009, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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>
32 #include <Guid/MdeModuleHii.h>
33 #include <Guid/HiiPlatformSetupFormset.h>
35 #include <Library/PrintLib.h>
36 #include <Library/DebugLib.h>
37 #include <Library/BaseMemoryLib.h>
38 #include <Library/UefiRuntimeServicesTableLib.h>
39 #include <Library/UefiDriverEntryPoint.h>
40 #include <Library/UefiBootServicesTableLib.h>
41 #include <Library/BaseLib.h>
42 #include <Library/MemoryAllocationLib.h>
43 #include <Library/HiiLib.h>
44 #include <Library/PcdLib.h>
45 #include <Library/DevicePathLib.h>
50 // This is the generated header file which includes whatever needs to be exported (strings + IFR)
53 extern UINT8 SetupBrowserStrings
[];
58 #define BANNER_HEIGHT 6
59 #define BANNER_COLUMNS 3
61 #define FRONT_PAGE_HEADER_HEIGHT 6
62 #define NONE_FRONT_PAGE_HEADER_HEIGHT 3
63 #define LEFT_SKIPPED_COLUMNS 4
64 #define FOOTER_HEIGHT 4
65 #define STATUS_BAR_HEIGHT 1
66 #define SCROLL_ARROW_HEIGHT 1
67 #define POPUP_PAD_SPACE_COUNT 5
68 #define POPUP_FRAME_WIDTH 2
71 // Definition for function key setting
73 #define NONE_FUNCTION_KEY_SETTING 0
74 #define DEFAULT_FUNCTION_KEY_SETTING (FUNCTION_NINE | FUNCTION_TEN)
76 #define FUNCTION_NINE (1 << 2)
77 #define FUNCTION_TEN (1 << 3)
82 } FUNCTIION_KEY_SETTING
;
85 // Character definitions
87 #define CHAR_SPACE 0x0020
88 #define UPPER_LOWER_CASE_OFFSET 0x20
93 #define ONE_SECOND 10000000
96 // Display definitions
98 #define LEFT_HYPER_DELIMITER L'<'
99 #define RIGHT_HYPER_DELIMITER L'>'
101 #define LEFT_ONEOF_DELIMITER L'<'
102 #define RIGHT_ONEOF_DELIMITER L'>'
104 #define LEFT_NUMERIC_DELIMITER L'['
105 #define RIGHT_NUMERIC_DELIMITER L']'
107 #define LEFT_CHECKBOX_DELIMITER L'['
108 #define RIGHT_CHECKBOX_DELIMITER L']'
110 #define CHECK_ON L'X'
111 #define CHECK_OFF L' '
113 #define TIME_SEPARATOR L':'
114 #define DATE_SEPARATOR L'/'
116 #define YES_ANSWER L'Y'
117 #define NO_ANSWER L'N'
120 // This is the Input Error Message
122 #define INPUT_ERROR 1
125 // This is the NV RAM update required Message
127 #define NV_UPDATE_REQUIRED 2
130 // Refresh the Status Bar with flags
132 #define REFRESH_STATUS_BAR 0xff
135 // Incremental string lenght of ConfigRequest
137 #define CONFIG_REQUEST_STRING_INCREMENTAL 1024
140 // HII value compare result
142 #define HII_VALUE_UNDEFINED 0
143 #define HII_VALUE_EQUAL 1
144 #define HII_VALUE_LESS_THAN 2
145 #define HII_VALUE_GREATER_THAN 3
148 // Incremental size of stack for expression
150 #define EXPRESSION_STACK_SIZE_INCREMENT 0x100
153 #define EFI_SPECIFICATION_ERRATA_VERSION 0
155 #define EFI_IFR_SPECIFICATION_VERSION \
156 ((((EFI_SPECIFICATION_VERSION) >> 8) & 0xff00) | \
157 (((EFI_SPECIFICATION_VERSION) & 0xf) << 4) | \
158 ((EFI_SPECIFICATION_ERRATA_VERSION) & 0xf))
160 #define SETUP_DRIVER_SIGNATURE SIGNATURE_32 ('F', 'B', 'D', 'V')
169 EFI_FORM_BROWSER2_PROTOCOL FormBrowser2
;
171 } SETUP_DRIVER_PRIVATE_DATA
;
174 EFI_STRING_ID Banner
[BANNER_HEIGHT
][BANNER_COLUMNS
];
178 // IFR relative definition
180 #define EFI_HII_EXPRESSION_INCONSISTENT_IF 0
181 #define EFI_HII_EXPRESSION_NO_SUBMIT_IF 1
182 #define EFI_HII_EXPRESSION_GRAY_OUT_IF 2
183 #define EFI_HII_EXPRESSION_SUPPRESS_IF 3
184 #define EFI_HII_EXPRESSION_DISABLE_IF 4
185 #define EFI_HII_EXPRESSION_VALUE 5
186 #define EFI_HII_EXPRESSION_RULE 6
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 0
196 #define FORMSET_CLASS_FRONT_PAGE 1
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)
243 #define EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')
251 UINT8 Format
; // For EFI_IFR_TO_STRING, EFI_IFR_FIND
252 UINT8 Flags
; // For EFI_IFR_SPAN
253 UINT8 RuleId
; // For EFI_IFR_RULE_REF
255 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
257 EFI_QUESTION_ID QuestionId
; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1
258 EFI_QUESTION_ID QuestionId2
;
260 UINT16 ListLength
; // For EFI_IFR_EQ_ID_VAL_LIST
263 EFI_STRING_ID DevicePath
; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3
267 #define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)
269 #define FORM_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')
275 UINT8 Type
; // Type for this expression
277 UINT8 RuleId
; // For EFI_IFR_RULE only
278 EFI_STRING_ID Error
; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only
280 EFI_HII_VALUE Result
; // Expression evaluation result
282 LIST_ENTRY OpCodeListHead
; // OpCodes consist of this expression (EXPRESSION_OPCODE)
285 #define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)
287 #define QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')
294 EFI_HII_VALUE Value
; // Default value
296 FORM_EXPRESSION
*ValueExpression
; // Not-NULL indicates default value is provided by EFI_IFR_VALUE
299 #define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)
301 #define QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')
310 EFI_IMAGE_ID ImageId
;
312 FORM_EXPRESSION
*SuppressExpression
; // Non-NULL indicates nested inside of SuppressIf
315 #define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)
317 #define FORM_BROWSER_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')
322 UINT8 Operand
; // The operand (first byte) of this Statement or Question
327 EFI_STRING_ID Prompt
;
329 EFI_STRING_ID TextTwo
; // For EFI_IFR_TEXT
334 EFI_QUESTION_ID QuestionId
; // The value of zero is reserved
335 EFI_VARSTORE_ID VarStoreId
; // A value of zero indicates no variable storage
336 FORMSET_STORAGE
*Storage
;
338 EFI_STRING_ID VarName
;
343 CHAR16
*VariableName
; // Name/Value or EFI Variable name
344 CHAR16
*BlockName
; // Buffer storage block name: "OFFSET=...WIDTH=..."
346 EFI_HII_VALUE HiiValue
; // Edit copy for checkbox, numberic, oneof
347 UINT8
*BufferValue
; // Edit copy for string, password, orderedlist
348 UINT8 ValueType
; // Data type for orderedlist value array
351 // OpCode specific members
353 UINT8 Flags
; // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,
354 // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER
355 UINT8 MaxContainers
; // for EFI_IFR_ORDERED_LIST
357 UINT16 BannerLineNumber
; // for EFI_IFR_BANNER, 1-based line number
358 EFI_STRING_ID QuestionConfig
; // for EFI_IFR_ACTION, if 0 then no configuration string will be processed
360 UINT64 Minimum
; // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value
361 UINT64 Maximum
; // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length
364 EFI_DEFAULT_ID DefaultId
; // for EFI_IFR_RESET_BUTTON
365 EFI_FORM_ID RefFormId
; // for EFI_IFR_REF
366 EFI_QUESTION_ID RefQuestionId
; // for EFI_IFR_REF2
367 EFI_GUID RefFormSetId
; // for EFI_IFR_REF3
368 EFI_STRING_ID RefDevicePath
; // for EFI_IFR_REF4
371 // Get from IFR parsing
373 FORM_EXPRESSION
*ValueExpression
; // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly
374 LIST_ENTRY DefaultListHead
; // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values
375 LIST_ENTRY OptionListHead
; // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)
377 EFI_IMAGE_ID ImageId
; // nested EFI_IFR_IMAGE
378 UINT8 RefreshInterval
; // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh
379 BOOLEAN InSubtitle
; // nesting inside of EFI_IFR_SUBTITLE
381 LIST_ENTRY InconsistentListHead
;// nested inconsistent expression list (FORM_EXPRESSION)
382 LIST_ENTRY NoSubmitListHead
; // nested nosubmit expression list (FORM_EXPRESSION)
383 FORM_EXPRESSION
*GrayOutExpression
; // nesting inside of GrayOutIf
384 FORM_EXPRESSION
*SuppressExpression
; // nesting inside of SuppressIf
385 FORM_EXPRESSION
*DisableExpression
; // nesting inside of DisableIf
387 } FORM_BROWSER_STATEMENT
;
389 #define FORM_BROWSER_STATEMENT_FROM_LINK(a) CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)
391 #define FORM_BROWSER_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')
398 EFI_STRING_ID FormTitle
;
400 EFI_IMAGE_ID ImageId
;
402 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
403 LIST_ENTRY StatementListHead
; // List of Statements and Questions (FORM_BROWSER_STATEMENT)
406 #define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)
408 #define FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')
415 EFI_STRING_ID DefaultName
;
416 } FORMSET_DEFAULTSTORE
;
418 #define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)
421 EFI_HII_HANDLE HiiHandle
;
422 EFI_HANDLE DriverHandle
;
423 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
424 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
426 UINTN IfrBinaryLength
;
427 UINT8
*IfrBinaryData
;
430 EFI_STRING_ID FormSetTitle
;
432 UINT8 NumberOfClassGuid
;
433 EFI_GUID ClassGuid
[3]; // Up to three ClassGuid
434 UINT16 Class
; // Tiano extended Class code
435 UINT16 SubClass
; // Tiano extended Subclass code
436 EFI_IMAGE_ID ImageId
;
438 FORM_BROWSER_STATEMENT
*StatementBuffer
; // Buffer for all Statements and Questions
439 EXPRESSION_OPCODE
*ExpressionBuffer
; // Buffer for all Expression OpCode
441 LIST_ENTRY StorageListHead
; // Storage list (FORMSET_STORAGE)
442 LIST_ENTRY DefaultStoreListHead
; // DefaultStore list (FORMSET_DEFAULTSTORE)
443 LIST_ENTRY FormListHead
; // Form list (FORM_BROWSER_FORM)
444 } FORM_BROWSER_FORMSET
;
447 extern EFI_HII_DATABASE_PROTOCOL
*mHiiDatabase
;
448 extern EFI_HII_STRING_PROTOCOL
*mHiiString
;
449 extern EFI_HII_CONFIG_ROUTING_PROTOCOL
*mHiiConfigRouting
;
451 extern BANNER_DATA
*gBannerData
;
452 extern EFI_HII_HANDLE gFrontPageHandle
;
453 extern UINTN gClassOfVfr
;
454 extern UINTN gFunctionKeySetting
;
455 extern BOOLEAN gResetRequired
;
456 extern BOOLEAN gNvUpdateRequired
;
457 extern EFI_HII_HANDLE gHiiHandle
;
458 extern UINT16 gDirection
;
459 extern EFI_SCREEN_DESCRIPTOR gScreenDimensions
;
460 extern BOOLEAN gUpArrow
;
461 extern BOOLEAN gDownArrow
;
463 extern FORM_BROWSER_FORMSET
*gOldFormSet
;
466 // Browser Global Strings
468 extern CHAR16
*gFunctionNineString
;
469 extern CHAR16
*gFunctionTenString
;
470 extern CHAR16
*gEnterString
;
471 extern CHAR16
*gEnterCommitString
;
472 extern CHAR16
*gEnterEscapeString
;
473 extern CHAR16
*gEscapeString
;
474 extern CHAR16
*gSaveFailed
;
475 extern CHAR16
*gMoveHighlight
;
476 extern CHAR16
*gMakeSelection
;
477 extern CHAR16
*gDecNumericInput
;
478 extern CHAR16
*gHexNumericInput
;
479 extern CHAR16
*gToggleCheckBox
;
480 extern CHAR16
*gPromptForData
;
481 extern CHAR16
*gPromptForPassword
;
482 extern CHAR16
*gPromptForNewPassword
;
483 extern CHAR16
*gConfirmPassword
;
484 extern CHAR16
*gConfirmError
;
485 extern CHAR16
*gPassowordInvalid
;
486 extern CHAR16
*gPressEnter
;
487 extern CHAR16
*gEmptyString
;
488 extern CHAR16
*gAreYouSure
;
489 extern CHAR16
*gYesResponse
;
490 extern CHAR16
*gNoResponse
;
491 extern CHAR16
*gMiniString
;
492 extern CHAR16
*gPlusString
;
493 extern CHAR16
*gMinusString
;
494 extern CHAR16
*gAdjustNumber
;
495 extern CHAR16
*gSaveChanges
;
496 extern CHAR16
*gOptionMismatch
;
498 extern CHAR16 gPromptBlockWidth
;
499 extern CHAR16 gOptionBlockWidth
;
500 extern CHAR16 gHelpBlockWidth
;
502 extern EFI_GUID gZeroGuid
;
503 extern EFI_GUID gTianoHiiIfrGuid
;
506 // Global Procedure Defines
510 Initialize the HII String Token to the correct values.
514 InitializeBrowserStrings (
519 Prints a unicode string to the default console,
522 @param String String pointer.
524 @return Length of string printed to the console
533 Prints a chracter to the default console,
536 @param Character Character to print.
538 @return Length of string printed to the console.
547 Prints a formatted unicode string to the default console, at
548 the supplied cursor position.
550 @param Column The cursor position to print the string at.
551 @param Row The cursor position to print the string at
552 @param Fmt Format string
553 @param ... Variable argument list for formating string.
555 @return Length of string printed to the console
567 Prints a unicode string to the default console, at
568 the supplied cursor position, using L"%s" format.
570 @param Column The cursor position to print the string at.
571 @param Row The cursor position to print the string at
572 @param String String pointer.
574 @return Length of string printed to the console
585 Prints a chracter to the default console, at
586 the supplied cursor position, using L"%c" format.
588 @param Column The cursor position to print the string at.
589 @param Row The cursor position to print the string at.
590 @param Character Character to print.
592 @return Length of string printed to the console.
603 Parse opcodes in the formset IFR binary.
605 @param FormSet Pointer of the FormSet data structure.
607 @retval EFI_SUCCESS Opcode parse success.
608 @retval Other Opcode parse fail.
613 IN FORM_BROWSER_FORMSET
*FormSet
617 Free resources allocated for a FormSet.
619 @param FormSet Pointer of the FormSet
624 IN OUT FORM_BROWSER_FORMSET
*FormSet
628 This function displays the page frame.
637 Create a new string in HII Package List.
639 @param String The String to be added
640 @param HiiHandle The package list in the HII database to insert the
643 @return The output string.
649 IN EFI_HII_HANDLE HiiHandle
653 Delete a string from HII Package List.
655 @param StringId Id of the string in HII database.
656 @param HiiHandle The HII package list handle.
658 @retval EFI_SUCCESS The string was deleted successfully.
663 IN EFI_STRING_ID StringId
,
664 IN EFI_HII_HANDLE HiiHandle
668 Get the string based on the StringId and HII Package List Handle.
670 @param Token The String's ID.
671 @param HiiHandle The package list in the HII database to search for
672 the specified string.
674 @return The output string.
679 IN EFI_STRING_ID Token
,
680 IN EFI_HII_HANDLE HiiHandle
684 Draw a pop up windows based on the dimension, number of lines and
687 @param RequestedWidth The width of the pop-up.
688 @param NumberOfLines The number of lines.
689 @param Marker The variable argument list for the list of string to be printed.
694 IN UINTN RequestedWidth
,
695 IN UINTN NumberOfLines
,
700 Routine used to abstract a generic dialog interface and return the selected key or string
702 @param NumberOfLines The number of lines for the dialog box
703 @param HotKey Defines whether a single character is parsed
704 (TRUE) and returned in KeyValue or a string is
705 returned in StringBuffer. Two special characters
706 are considered when entering a string, a SCAN_ESC
707 and an CHAR_CARRIAGE_RETURN. SCAN_ESC terminates
708 string input and returns
709 @param MaximumStringSize The maximum size in bytes of a typed in string
710 (each character is a CHAR16) and the minimum
711 string returned is two bytes
712 @param StringBuffer The passed in pointer to the buffer which will
713 hold the typed in string if HotKey is FALSE
714 @param KeyValue The EFI_KEY value returned if HotKey is TRUE..
715 @param ... A series of (quantity == NumberOfLines) text
716 strings which will be used to construct the dialog
719 @retval EFI_SUCCESS Displayed dialog and received user interaction
720 @retval EFI_INVALID_PARAMETER One of the parameters was invalid (e.g.
721 (StringBuffer == NULL) && (HotKey == FALSE))
722 @retval EFI_DEVICE_ERROR User typed in an ESC character to exit the routine
727 IN UINTN NumberOfLines
,
729 IN UINTN MaximumStringSize
,
730 OUT CHAR16
*StringBuffer
,
731 OUT EFI_INPUT_KEY
*KeyValue
,
736 Get Question's current Value.
738 @param FormSet FormSet data structure.
739 @param Form Form data structure.
740 @param Question Question to be initialized.
741 @param Cached TRUE: get from Edit copy FALSE: get from original
744 @retval EFI_SUCCESS The function completed successfully.
749 IN FORM_BROWSER_FORMSET
*FormSet
,
750 IN FORM_BROWSER_FORM
*Form
,
751 IN OUT FORM_BROWSER_STATEMENT
*Question
,
756 Save Question Value to edit copy(cached) or Storage(uncached).
758 @param FormSet FormSet data structure.
759 @param Form Form data structure.
760 @param Question Pointer to the Question.
761 @param Cached TRUE: set to Edit copy FALSE: set to original
764 @retval EFI_SUCCESS The function completed successfully.
769 IN FORM_BROWSER_FORMSET
*FormSet
,
770 IN FORM_BROWSER_FORM
*Form
,
771 IN OUT FORM_BROWSER_STATEMENT
*Question
,
776 Perform inconsistent check for a Form.
778 @param FormSet FormSet data structure.
779 @param Form Form data structure.
780 @param Question The Question to be validated.
781 @param Type Validation type: InConsistent or NoSubmit
783 @retval EFI_SUCCESS Form validation pass.
784 @retval other Form validation failed.
789 IN FORM_BROWSER_FORMSET
*FormSet
,
790 IN FORM_BROWSER_FORM
*Form
,
791 IN FORM_BROWSER_STATEMENT
*Question
,
798 @param FormSet FormSet data structure.
799 @param Form Form data structure.
801 @retval EFI_SUCCESS The function completed successfully.
806 IN FORM_BROWSER_FORMSET
*FormSet
,
807 IN FORM_BROWSER_FORM
*Form
811 Reset Question to its default value.
813 @param FormSet The form set.
814 @param Form The form.
815 @param Question The question.
816 @param DefaultId The Class of the default.
818 @retval EFI_SUCCESS Question is reset to default value.
823 IN FORM_BROWSER_FORMSET
*FormSet
,
824 IN FORM_BROWSER_FORM
*Form
,
825 IN FORM_BROWSER_STATEMENT
*Question
,
830 Get current setting of Questions.
832 @param FormSet FormSet data structure.
834 @retval EFI_SUCCESS The function completed successfully.
838 InitializeCurrentSetting (
839 IN OUT FORM_BROWSER_FORMSET
*FormSet
843 Initialize the internal data structure of a FormSet.
845 @param Handle PackageList Handle
846 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
847 GUID), take the first FormSet found in package
849 @param FormSet FormSet data structure.
851 @retval EFI_SUCCESS The function completed successfully.
852 @retval EFI_NOT_FOUND The specified FormSet could not be found.
857 IN EFI_HII_HANDLE Handle
,
858 IN OUT EFI_GUID
*FormSetGuid
,
859 OUT FORM_BROWSER_FORMSET
*FormSet
863 Reset Questions in a Form to their default value.
865 @param FormSet FormSet data structure.
866 @param Form The Form which to be reset.
867 @param DefaultId The Class of the default.
869 @retval EFI_SUCCESS The function completed successfully.
874 IN FORM_BROWSER_FORMSET
*FormSet
,
875 IN FORM_BROWSER_FORM
*Form
,
880 Initialize Question's Edit copy from Storage.
882 @param FormSet FormSet data structure.
883 @param Form Form data structure.
885 @retval EFI_SUCCESS The function completed successfully.
890 IN FORM_BROWSER_FORMSET
*FormSet
,
891 IN FORM_BROWSER_FORM
*Form
895 Initialize Question's Edit copy from Storage for the whole Formset.
897 @param FormSet FormSet data structure.
899 @retval EFI_SUCCESS The function completed successfully.
904 IN FORM_BROWSER_FORMSET
*FormSet
908 Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
910 @param Storage The Storage to be conveted.
911 @param ConfigResp The returned <ConfigResp>.
913 @retval EFI_SUCCESS Convert success.
914 @retval EFI_INVALID_PARAMETER Incorrect storage type.
918 StorageToConfigResp (
919 IN FORMSET_STORAGE
*Storage
,
920 IN CHAR16
**ConfigResp
924 Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
926 @param Storage The Storage to receive the settings.
927 @param ConfigResp The <ConfigResp> to be converted.
929 @retval EFI_SUCCESS Convert success.
930 @retval EFI_INVALID_PARAMETER Incorrect storage type.
934 ConfigRespToStorage (
935 IN FORMSET_STORAGE
*Storage
,
936 IN CHAR16
*ConfigResp
940 Fill storage's edit copy with settings requested from Configuration Driver.
942 @param FormSet FormSet data structure.
943 @param Storage Buffer Storage.
945 @retval EFI_SUCCESS The function completed successfully.
950 IN FORM_BROWSER_FORMSET
*FormSet
,
951 IN FORMSET_STORAGE
*Storage
955 Fetch the Ifr binary data of a FormSet.
957 @param Handle PackageList Handle
958 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
959 GUID), take the first FormSet found in package
961 @param BinaryLength The length of the FormSet IFR binary.
962 @param BinaryData The buffer designed to receive the FormSet.
964 @retval EFI_SUCCESS Buffer filled with the requested FormSet.
965 BufferLength was updated.
966 @retval EFI_INVALID_PARAMETER The handle is unknown.
967 @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot
968 be found with the requested FormId.
973 IN EFI_HII_HANDLE Handle
,
974 IN OUT EFI_GUID
*FormSetGuid
,
975 OUT UINTN
*BinaryLength
,
976 OUT UINT8
**BinaryData
980 This is the routine which an external caller uses to direct the browser
981 where to obtain it's information.
984 @param This The Form Browser protocol instanse.
985 @param Handles A pointer to an array of Handles. If HandleCount > 1 we
986 display a list of the formsets for the handles specified.
987 @param HandleCount The number of Handles specified in Handle.
988 @param FormSetGuid This field points to the EFI_GUID which must match the Guid
989 field in the EFI_IFR_FORM_SET op-code for the specified
990 forms-based package. If FormSetGuid is NULL, then this
991 function will display the first found forms package.
992 @param FormId This field specifies which EFI_IFR_FORM to render as the first
993 displayable page. If this field has a value of 0x0000, then
994 the forms browser will render the specified forms in their encoded order.
995 ScreenDimenions - This allows the browser to be called so that it occupies a
996 portion of the physical screen instead of dynamically determining the screen dimensions.
997 ActionRequest - Points to the action recommended by the form.
998 @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
1000 @param ActionRequest Points to the action recommended by the form.
1002 @retval EFI_SUCCESS The function completed successfully.
1003 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1004 @retval EFI_NOT_FOUND No valid forms could be found to display.
1010 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1011 IN EFI_HII_HANDLE
*Handles
,
1012 IN UINTN HandleCount
,
1013 IN EFI_GUID
*FormSetGuid
, OPTIONAL
1014 IN UINT16 FormId
, OPTIONAL
1015 IN CONST EFI_SCREEN_DESCRIPTOR
*ScreenDimensions
, OPTIONAL
1016 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest OPTIONAL
1020 This function is called by a callback handler to retrieve uncommitted state
1021 data from the browser.
1023 @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL
1025 @param ResultsDataSize A pointer to the size of the buffer associated
1027 @param ResultsData A string returned from an IFR browser or
1028 equivalent. The results string will have no
1029 routing information in them.
1030 @param RetrieveData A BOOLEAN field which allows an agent to retrieve
1031 (if RetrieveData = TRUE) data from the uncommitted
1032 browser state information or set (if RetrieveData
1033 = FALSE) data in the uncommitted browser state
1035 @param VariableGuid An optional field to indicate the target variable
1037 @param VariableName An optional field to indicate the target
1038 human-readable variable name.
1040 @retval EFI_SUCCESS The results have been distributed or are awaiting
1042 @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to
1043 contain the results data.
1049 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1050 IN OUT UINTN
*ResultsDataSize
,
1051 IN OUT EFI_STRING ResultsData
,
1052 IN BOOLEAN RetrieveData
,
1053 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
1054 IN CONST CHAR16
*VariableName OPTIONAL