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_ONE | FUNCTION_NINE | FUNCTION_TEN)
76 #define FUNCTION_ONE (1 << 0)
77 #define FUNCTION_NINE (1 << 2)
78 #define FUNCTION_TEN (1 << 3)
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
154 #define EFI_SPECIFICATION_ERRATA_VERSION 0
156 #define EFI_IFR_SPECIFICATION_VERSION \
157 ((((EFI_SPECIFICATION_VERSION) >> 8) & 0xff00) | \
158 (((EFI_SPECIFICATION_VERSION) & 0xf) << 4) | \
159 ((EFI_SPECIFICATION_ERRATA_VERSION) & 0xf))
161 #define SETUP_DRIVER_SIGNATURE SIGNATURE_32 ('F', 'B', 'D', 'V')
170 EFI_FORM_BROWSER2_PROTOCOL FormBrowser2
;
172 } SETUP_DRIVER_PRIVATE_DATA
;
175 EFI_STRING_ID Banner
[BANNER_HEIGHT
][BANNER_COLUMNS
];
179 // IFR relative definition
181 #define EFI_HII_EXPRESSION_INCONSISTENT_IF 0
182 #define EFI_HII_EXPRESSION_NO_SUBMIT_IF 1
183 #define EFI_HII_EXPRESSION_GRAY_OUT_IF 2
184 #define EFI_HII_EXPRESSION_SUPPRESS_IF 3
185 #define EFI_HII_EXPRESSION_DISABLE_IF 4
186 #define EFI_HII_EXPRESSION_VALUE 5
187 #define EFI_HII_EXPRESSION_RULE 6
189 #define EFI_HII_VARSTORE_BUFFER 0
190 #define EFI_HII_VARSTORE_NAME_VALUE 1
191 #define EFI_HII_VARSTORE_EFI_VARIABLE 2
193 #define FORM_INCONSISTENT_VALIDATION 0
194 #define FORM_NO_SUBMIT_VALIDATION 1
196 #define FORMSET_CLASS_PLATFORM_SETUP 0
197 #define FORMSET_CLASS_FRONT_PAGE 1
201 EFI_IFR_TYPE_VALUE Value
;
204 #define NAME_VALUE_NODE_SIGNATURE SIGNATURE_32 ('N', 'V', 'S', 'T')
214 #define NAME_VALUE_NODE_FROM_LINK(a) CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)
216 #define FORMSET_STORAGE_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'G')
222 UINT8 Type
; // Storage type
227 CHAR16
*Name
; // For EFI_IFR_VARSTORE
230 UINT8
*EditBuffer
; // Edit copy for Buffer Storage
232 LIST_ENTRY NameValueListHead
; // List of NAME_VALUE_NODE
234 UINT32 Attributes
; // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute
236 CHAR16
*ConfigHdr
; // <ConfigHdr>
237 CHAR16
*ConfigRequest
; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
238 UINTN ElementCount
; // Number of <RequestElement> in the <ConfigRequest>
239 UINTN SpareStrLen
; // Spare length of ConfigRequest string buffer
242 #define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)
244 #define EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')
252 UINT8 Format
; // For EFI_IFR_TO_STRING, EFI_IFR_FIND
253 UINT8 Flags
; // For EFI_IFR_SPAN
254 UINT8 RuleId
; // For EFI_IFR_RULE_REF
256 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
258 EFI_QUESTION_ID QuestionId
; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1
259 EFI_QUESTION_ID QuestionId2
;
261 UINT16 ListLength
; // For EFI_IFR_EQ_ID_VAL_LIST
264 EFI_STRING_ID DevicePath
; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3
268 #define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)
270 #define FORM_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')
276 UINT8 Type
; // Type for this expression
278 UINT8 RuleId
; // For EFI_IFR_RULE only
279 EFI_STRING_ID Error
; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only
281 EFI_HII_VALUE Result
; // Expression evaluation result
283 LIST_ENTRY OpCodeListHead
; // OpCodes consist of this expression (EXPRESSION_OPCODE)
286 #define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)
288 #define QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')
295 EFI_HII_VALUE Value
; // Default value
297 FORM_EXPRESSION
*ValueExpression
; // Not-NULL indicates default value is provided by EFI_IFR_VALUE
300 #define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)
302 #define QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')
311 EFI_IMAGE_ID ImageId
;
313 FORM_EXPRESSION
*SuppressExpression
; // Non-NULL indicates nested inside of SuppressIf
316 #define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)
318 #define FORM_BROWSER_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')
323 UINT8 Operand
; // The operand (first byte) of this Statement or Question
328 EFI_STRING_ID Prompt
;
330 EFI_STRING_ID TextTwo
; // For EFI_IFR_TEXT
335 EFI_QUESTION_ID QuestionId
; // The value of zero is reserved
336 EFI_VARSTORE_ID VarStoreId
; // A value of zero indicates no variable storage
337 FORMSET_STORAGE
*Storage
;
339 EFI_STRING_ID VarName
;
344 CHAR16
*VariableName
; // Name/Value or EFI Variable name
345 CHAR16
*BlockName
; // Buffer storage block name: "OFFSET=...WIDTH=..."
347 EFI_HII_VALUE HiiValue
; // Edit copy for checkbox, numberic, oneof
348 UINT8
*BufferValue
; // Edit copy for string, password, orderedlist
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
*gFunctionOneString
;
469 extern CHAR16
*gFunctionNineString
;
470 extern CHAR16
*gFunctionTenString
;
471 extern CHAR16
*gEnterString
;
472 extern CHAR16
*gEnterCommitString
;
473 extern CHAR16
*gEnterEscapeString
;
474 extern CHAR16
*gEscapeString
;
475 extern CHAR16
*gSaveFailed
;
476 extern CHAR16
*gMoveHighlight
;
477 extern CHAR16
*gMakeSelection
;
478 extern CHAR16
*gDecNumericInput
;
479 extern CHAR16
*gHexNumericInput
;
480 extern CHAR16
*gToggleCheckBox
;
481 extern CHAR16
*gPromptForData
;
482 extern CHAR16
*gPromptForPassword
;
483 extern CHAR16
*gPromptForNewPassword
;
484 extern CHAR16
*gConfirmPassword
;
485 extern CHAR16
*gConfirmError
;
486 extern CHAR16
*gPassowordInvalid
;
487 extern CHAR16
*gPressEnter
;
488 extern CHAR16
*gEmptyString
;
489 extern CHAR16
*gAreYouSure
;
490 extern CHAR16
*gYesResponse
;
491 extern CHAR16
*gNoResponse
;
492 extern CHAR16
*gMiniString
;
493 extern CHAR16
*gPlusString
;
494 extern CHAR16
*gMinusString
;
495 extern CHAR16
*gAdjustNumber
;
496 extern CHAR16
*gSaveChanges
;
497 extern CHAR16
*gOptionMismatch
;
499 extern CHAR16 gPromptBlockWidth
;
500 extern CHAR16 gOptionBlockWidth
;
501 extern CHAR16 gHelpBlockWidth
;
503 extern EFI_GUID gZeroGuid
;
504 extern EFI_GUID gTianoHiiIfrGuid
;
507 // Global Procedure Defines
511 Initialize the HII String Token to the correct values.
515 InitializeBrowserStrings (
520 Prints a unicode string to the default console,
523 @param String String pointer.
525 @return Length of string printed to the console
534 Prints a chracter to the default console,
537 @param Character Character to print.
539 @return Length of string printed to the console.
548 Prints a formatted unicode string to the default console, at
549 the supplied cursor position.
551 @param Column The cursor position to print the string at.
552 @param Row The cursor position to print the string at
553 @param Fmt Format string
554 @param ... Variable argument list for formating string.
556 @return Length of string printed to the console
568 Prints a unicode string to the default console, at
569 the supplied cursor position, using L"%s" format.
571 @param Column The cursor position to print the string at.
572 @param Row The cursor position to print the string at
573 @param String String pointer.
575 @return Length of string printed to the console
586 Prints a chracter to the default console, at
587 the supplied cursor position, using L"%c" format.
589 @param Column The cursor position to print the string at.
590 @param Row The cursor position to print the string at.
591 @param Character Character to print.
593 @return Length of string printed to the console.
604 Parse opcodes in the formset IFR binary.
606 @param FormSet Pointer of the FormSet data structure.
608 @retval EFI_SUCCESS Opcode parse success.
609 @retval Other Opcode parse fail.
614 IN FORM_BROWSER_FORMSET
*FormSet
618 Free resources allocated for a FormSet.
620 @param FormSet Pointer of the FormSet
625 IN OUT FORM_BROWSER_FORMSET
*FormSet
629 This function displays the page frame.
638 Create a new string in HII Package List.
640 @param String The String to be added
641 @param HiiHandle The package list in the HII database to insert the
644 @return The output string.
650 IN EFI_HII_HANDLE HiiHandle
654 Delete a string from HII Package List.
656 @param StringId Id of the string in HII database.
657 @param HiiHandle The HII package list handle.
659 @retval EFI_SUCCESS The string was deleted successfully.
664 IN EFI_STRING_ID StringId
,
665 IN EFI_HII_HANDLE HiiHandle
669 Get the string based on the StringId and HII Package List Handle.
671 @param Token The String's ID.
672 @param HiiHandle The package list in the HII database to search for
673 the specified string.
675 @return The output string.
680 IN EFI_STRING_ID Token
,
681 IN EFI_HII_HANDLE HiiHandle
685 Draw a pop up windows based on the dimension, number of lines and
688 @param RequestedWidth The width of the pop-up.
689 @param NumberOfLines The number of lines.
690 @param Marker The variable argument list for the list of string to be printed.
695 IN UINTN RequestedWidth
,
696 IN UINTN NumberOfLines
,
701 Routine used to abstract a generic dialog interface and return the selected key or string
703 @param NumberOfLines The number of lines for the dialog box
704 @param HotKey Defines whether a single character is parsed
705 (TRUE) and returned in KeyValue or a string is
706 returned in StringBuffer. Two special characters
707 are considered when entering a string, a SCAN_ESC
708 and an CHAR_CARRIAGE_RETURN. SCAN_ESC terminates
709 string input and returns
710 @param MaximumStringSize The maximum size in bytes of a typed in string
711 (each character is a CHAR16) and the minimum
712 string returned is two bytes
713 @param StringBuffer The passed in pointer to the buffer which will
714 hold the typed in string if HotKey is FALSE
715 @param KeyValue The EFI_KEY value returned if HotKey is TRUE..
716 @param ... A series of (quantity == NumberOfLines) text
717 strings which will be used to construct the dialog
720 @retval EFI_SUCCESS Displayed dialog and received user interaction
721 @retval EFI_INVALID_PARAMETER One of the parameters was invalid (e.g.
722 (StringBuffer == NULL) && (HotKey == FALSE))
723 @retval EFI_DEVICE_ERROR User typed in an ESC character to exit the routine
728 IN UINTN NumberOfLines
,
730 IN UINTN MaximumStringSize
,
731 OUT CHAR16
*StringBuffer
,
732 OUT EFI_INPUT_KEY
*KeyValue
,
737 Get Question's current Value.
739 @param FormSet FormSet data structure.
740 @param Form Form data structure.
741 @param Question Question to be initialized.
742 @param Cached TRUE: get from Edit copy FALSE: get from original
745 @retval EFI_SUCCESS The function completed successfully.
750 IN FORM_BROWSER_FORMSET
*FormSet
,
751 IN FORM_BROWSER_FORM
*Form
,
752 IN OUT FORM_BROWSER_STATEMENT
*Question
,
757 Save Question Value to edit copy(cached) or Storage(uncached).
759 @param FormSet FormSet data structure.
760 @param Form Form data structure.
761 @param Question Pointer to the Question.
762 @param Cached TRUE: set to Edit copy FALSE: set to original
765 @retval EFI_SUCCESS The function completed successfully.
770 IN FORM_BROWSER_FORMSET
*FormSet
,
771 IN FORM_BROWSER_FORM
*Form
,
772 IN OUT FORM_BROWSER_STATEMENT
*Question
,
777 Perform inconsistent check for a Form.
779 @param FormSet FormSet data structure.
780 @param Form Form data structure.
781 @param Question The Question to be validated.
782 @param Type Validation type: InConsistent or NoSubmit
784 @retval EFI_SUCCESS Form validation pass.
785 @retval other Form validation failed.
790 IN FORM_BROWSER_FORMSET
*FormSet
,
791 IN FORM_BROWSER_FORM
*Form
,
792 IN FORM_BROWSER_STATEMENT
*Question
,
799 @param FormSet FormSet data structure.
800 @param Form Form data structure.
802 @retval EFI_SUCCESS The function completed successfully.
807 IN FORM_BROWSER_FORMSET
*FormSet
,
808 IN FORM_BROWSER_FORM
*Form
812 Reset Question to its default value.
814 @param FormSet The form set.
815 @param Form The form.
816 @param Question The question.
817 @param DefaultId The Class of the default.
819 @retval EFI_SUCCESS Question is reset to default value.
824 IN FORM_BROWSER_FORMSET
*FormSet
,
825 IN FORM_BROWSER_FORM
*Form
,
826 IN FORM_BROWSER_STATEMENT
*Question
,
831 Get current setting of Questions.
833 @param FormSet FormSet data structure.
835 @retval EFI_SUCCESS The function completed successfully.
839 InitializeCurrentSetting (
840 IN OUT FORM_BROWSER_FORMSET
*FormSet
844 Initialize the internal data structure of a FormSet.
846 @param Handle PackageList Handle
847 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
848 GUID), take the first FormSet found in package
850 @param FormSet FormSet data structure.
852 @retval EFI_SUCCESS The function completed successfully.
853 @retval EFI_NOT_FOUND The specified FormSet could not be found.
858 IN EFI_HII_HANDLE Handle
,
859 IN OUT EFI_GUID
*FormSetGuid
,
860 OUT FORM_BROWSER_FORMSET
*FormSet
864 Reset Questions in a Form to their default value.
866 @param FormSet FormSet data structure.
867 @param Form The Form which to be reset.
868 @param DefaultId The Class of the default.
870 @retval EFI_SUCCESS The function completed successfully.
875 IN FORM_BROWSER_FORMSET
*FormSet
,
876 IN FORM_BROWSER_FORM
*Form
,
881 Initialize Question's Edit copy from Storage.
883 @param FormSet FormSet data structure.
884 @param Form Form data structure.
886 @retval EFI_SUCCESS The function completed successfully.
891 IN FORM_BROWSER_FORMSET
*FormSet
,
892 IN FORM_BROWSER_FORM
*Form
896 Initialize Question's Edit copy from Storage for the whole Formset.
898 @param FormSet FormSet data structure.
900 @retval EFI_SUCCESS The function completed successfully.
905 IN FORM_BROWSER_FORMSET
*FormSet
909 Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
911 @param Storage The Storage to be conveted.
912 @param ConfigResp The returned <ConfigResp>.
914 @retval EFI_SUCCESS Convert success.
915 @retval EFI_INVALID_PARAMETER Incorrect storage type.
919 StorageToConfigResp (
920 IN FORMSET_STORAGE
*Storage
,
921 IN CHAR16
**ConfigResp
925 Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
927 @param Storage The Storage to receive the settings.
928 @param ConfigResp The <ConfigResp> to be converted.
930 @retval EFI_SUCCESS Convert success.
931 @retval EFI_INVALID_PARAMETER Incorrect storage type.
935 ConfigRespToStorage (
936 IN FORMSET_STORAGE
*Storage
,
937 IN CHAR16
*ConfigResp
941 Fill storage's edit copy with settings requested from Configuration Driver.
943 @param FormSet FormSet data structure.
944 @param Storage Buffer Storage.
946 @retval EFI_SUCCESS The function completed successfully.
951 IN FORM_BROWSER_FORMSET
*FormSet
,
952 IN FORMSET_STORAGE
*Storage
956 Fetch the Ifr binary data of a FormSet.
958 @param Handle PackageList Handle
959 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
960 GUID), take the first FormSet found in package
962 @param BinaryLength The length of the FormSet IFR binary.
963 @param BinaryData The buffer designed to receive the FormSet.
965 @retval EFI_SUCCESS Buffer filled with the requested FormSet.
966 BufferLength was updated.
967 @retval EFI_INVALID_PARAMETER The handle is unknown.
968 @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot
969 be found with the requested FormId.
974 IN EFI_HII_HANDLE Handle
,
975 IN OUT EFI_GUID
*FormSetGuid
,
976 OUT UINTN
*BinaryLength
,
977 OUT UINT8
**BinaryData
981 This is the routine which an external caller uses to direct the browser
982 where to obtain it's information.
985 @param This The Form Browser protocol instanse.
986 @param Handles A pointer to an array of Handles. If HandleCount > 1 we
987 display a list of the formsets for the handles specified.
988 @param HandleCount The number of Handles specified in Handle.
989 @param FormSetGuid This field points to the EFI_GUID which must match the Guid
990 field in the EFI_IFR_FORM_SET op-code for the specified
991 forms-based package. If FormSetGuid is NULL, then this
992 function will display the first found forms package.
993 @param FormId This field specifies which EFI_IFR_FORM to render as the first
994 displayable page. If this field has a value of 0x0000, then
995 the forms browser will render the specified forms in their encoded order.
996 ScreenDimenions - This allows the browser to be called so that it occupies a
997 portion of the physical screen instead of dynamically determining the screen dimensions.
998 ActionRequest - Points to the action recommended by the form.
999 @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
1001 @param ActionRequest Points to the action recommended by the form.
1003 @retval EFI_SUCCESS The function completed successfully.
1004 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1005 @retval EFI_NOT_FOUND No valid forms could be found to display.
1011 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1012 IN EFI_HII_HANDLE
*Handles
,
1013 IN UINTN HandleCount
,
1014 IN EFI_GUID
*FormSetGuid
, OPTIONAL
1015 IN UINT16 FormId
, OPTIONAL
1016 IN CONST EFI_SCREEN_DESCRIPTOR
*ScreenDimensions
, OPTIONAL
1017 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest OPTIONAL
1021 This function is called by a callback handler to retrieve uncommitted state
1022 data from the browser.
1024 @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL
1026 @param ResultsDataSize A pointer to the size of the buffer associated
1028 @param ResultsData A string returned from an IFR browser or
1029 equivalent. The results string will have no
1030 routing information in them.
1031 @param RetrieveData A BOOLEAN field which allows an agent to retrieve
1032 (if RetrieveData = TRUE) data from the uncommitted
1033 browser state information or set (if RetrieveData
1034 = FALSE) data in the uncommitted browser state
1036 @param VariableGuid An optional field to indicate the target variable
1038 @param VariableName An optional field to indicate the target
1039 human-readable variable name.
1041 @retval EFI_SUCCESS The results have been distributed or are awaiting
1043 @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to
1044 contain the results data.
1050 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1051 IN OUT UINTN
*ResultsDataSize
,
1052 IN OUT EFI_STRING ResultsData
,
1053 IN BOOLEAN RetrieveData
,
1054 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
1055 IN CONST CHAR16
*VariableName OPTIONAL