2 FormDiplay protocol to show Form
4 Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
9 #ifndef __DISPLAY_PROTOCOL_H__
10 #define __DISPLAY_PROTOCOL_H__
12 #include <Protocol/FormBrowser2.h>
14 #define EDKII_FORM_DISPLAY_ENGINE_PROTOCOL_GUID \
15 { 0x9bbe29e9, 0xfda1, 0x41ec, { 0xad, 0x52, 0x45, 0x22, 0x13, 0x74, 0x2d, 0x2e } }
20 #define BROWSER_ACTION_NONE BIT16
24 #define BROWSER_ACTION_FORM_EXIT BIT17
26 #define BROWSER_SUCCESS 0x0
27 #define BROWSER_ERROR BIT31
28 #define BROWSER_SUBMIT_FAIL BROWSER_ERROR | 0x01
29 #define BROWSER_NO_SUBMIT_IF BROWSER_ERROR | 0x02
30 #define BROWSER_FORM_NOT_FOUND BROWSER_ERROR | 0x03
31 #define BROWSER_FORM_SUPPRESS BROWSER_ERROR | 0x04
32 #define BROWSER_PROTOCOL_NOT_FOUND BROWSER_ERROR | 0x05
33 #define BROWSER_INCONSISTENT_IF BROWSER_ERROR | 0x06
34 #define BROWSER_WARNING_IF BROWSER_ERROR | 0x07
35 #define BROWSER_SUBMIT_FAIL_NO_SUBMIT_IF BROWSER_ERROR | 0x08
36 #define BROWSER_RECONNECT_REQUIRED BROWSER_ERROR | 0x09
37 #define BROWSER_RECONNECT_FAIL BROWSER_ERROR | 0x0A
38 #define BROWSER_RECONNECT_SAVE_CHANGES BROWSER_ERROR | 0x0B
40 #define FORM_DISPLAY_ENGINE_STATEMENT_VERSION_1 0x10000
41 #define FORM_DISPLAY_ENGINE_VERSION_1 0x10000
49 // Buffer Data and Length if Type is EFI_IFR_TYPE_BUFFER or EFI_IFR_TYPE_STRING
53 EFI_IFR_TYPE_VALUE Value
;
56 #define DISPLAY_QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')
64 EFI_IFR_ONE_OF_OPTION
*OptionOpCode
;
66 // Option ImageId and AnimationId
69 EFI_ANIMATION_ID AnimationId
;
70 } DISPLAY_QUESTION_OPTION
;
72 #define DISPLAY_QUESTION_OPTION_FROM_LINK(a) CR (a, DISPLAY_QUESTION_OPTION, Link, DISPLAY_QUESTION_OPTION_SIGNATURE)
74 typedef struct _FORM_DISPLAY_ENGINE_STATEMENT FORM_DISPLAY_ENGINE_STATEMENT
;
75 typedef struct _FORM_DISPLAY_ENGINE_FORM FORM_DISPLAY_ENGINE_FORM
;
77 #define STATEMENT_VALID 0x0
78 #define STATEMENT_INVALID BIT31
80 #define INCOSISTENT_IF_TRUE STATEMENT_INVALID | 0x01
81 #define WARNING_IF_TRUE STATEMENT_INVALID | 0x02
82 #define STRING_TOO_LONG STATEMENT_INVALID | 0x03
83 // ... to be extended.
87 // StringId for INCONSITENT_IF or WARNING_IF
89 EFI_STRING_ID StringId
;
91 // TimeOut for WARNING_IF
94 } STATEMENT_ERROR_INFO
;
97 Perform value check for a question.
99 @param Form Form where Statement is in.
100 @param Statement Value will check for it.
101 @param Value New value will be checked.
103 @retval Status Value Status
108 (EFIAPI
*VALIDATE_QUESTION
) (
109 IN FORM_DISPLAY_ENGINE_FORM
*Form
,
110 IN FORM_DISPLAY_ENGINE_STATEMENT
*Statement
,
111 IN EFI_HII_VALUE
*Value
,
112 OUT STATEMENT_ERROR_INFO
*ErrorInfo
116 Perform Password check.
117 Passwork may be encrypted by driver that requires the specific check.
119 @param Form Form where Password Statement is in.
120 @param Statement Password statement
121 @param PasswordString Password string to be checked. It may be NULL.
122 NULL means to restore password.
123 "" string can be used to checked whether old password does exist.
125 @return Status Status of Password check.
129 (EFIAPI
*PASSWORD_CHECK
) (
130 IN FORM_DISPLAY_ENGINE_FORM
*Form
,
131 IN FORM_DISPLAY_ENGINE_STATEMENT
*Statement
,
132 IN EFI_STRING PasswordString OPTIONAL
135 #define FORM_DISPLAY_ENGINE_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')
138 // Attribute for Statement and Form
140 #define HII_DISPLAY_NONE 0
141 #define HII_DISPLAY_GRAYOUT BIT0
142 #define HII_DISPLAY_LOCK BIT1
143 #define HII_DISPLAY_READONLY BIT2
144 #define HII_DISPLAY_MODAL BIT3
145 #define HII_DISPLAY_SUPPRESS BIT4
147 struct _FORM_DISPLAY_ENGINE_STATEMENT
{
150 // Version for future structure extension
154 // link to all the statement which will show in the display form.
156 LIST_ENTRY DisplayLink
;
158 // Pointer to statement opcode.
159 // for Guided Opcode. All buffers will be here if GUIDED opcode scope is set.
161 EFI_IFR_OP_HEADER
*OpCode
;
163 // Question CurrentValue
165 EFI_HII_VALUE CurrentValue
;
167 // Flag to describe whether setting is changed or not.
168 // Displayer may depend on it to show it with the different color.
170 BOOLEAN SettingChangedFlag
;
172 // nested Statement list inside of EFI_IFR_SUBTITLE
174 LIST_ENTRY NestStatementList
;
176 // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)
178 LIST_ENTRY OptionListHead
;
180 // Statement attributes: GRAYOUT, LOCK and READONLY
185 // ValidateQuestion to do InconsistIf check
186 // It may be NULL if any value is valid.
188 VALIDATE_QUESTION ValidateQuestion
;
191 // Password additional check. It may be NULL when the additional check is not required.
193 PASSWORD_CHECK PasswordCheck
;
196 // Statement ImageId and AnimationId
198 EFI_IMAGE_ID ImageId
;
199 EFI_ANIMATION_ID AnimationId
;
202 #define FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK(a) CR (a, FORM_DISPLAY_ENGINE_STATEMENT, DisplayLink, FORM_DISPLAY_ENGINE_STATEMENT_SIGNATURE)
204 #define BROWSER_HOT_KEY_SIGNATURE SIGNATURE_32 ('B', 'H', 'K', 'S')
210 EFI_INPUT_KEY
*KeyData
;
212 // Action is Discard, Default, Submit, Reset and Exit.
217 // HotKey Help String
219 EFI_STRING HelpString
;
222 #define BROWSER_HOT_KEY_FROM_LINK(a) CR (a, BROWSER_HOT_KEY, Link, BROWSER_HOT_KEY_SIGNATURE)
224 #define FORM_DISPLAY_ENGINE_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')
226 struct _FORM_DISPLAY_ENGINE_FORM
{
229 // Version for future structure extension
233 // Statement List inside of Form
235 LIST_ENTRY StatementListHead
;
237 // Statement List outside of Form
239 LIST_ENTRY StatementListOSF
;
241 // The input screen dimenstions info.
243 EFI_SCREEN_DESCRIPTOR
*ScreenDimensions
;
245 // FormSet information
247 EFI_GUID FormSetGuid
;
249 // HiiHandle can be used to get String, Image or Animation
251 EFI_HII_HANDLE HiiHandle
;
254 // Form ID and Title.
257 EFI_STRING_ID FormTitle
;
259 // Form Attributes: Lock, Modal.
263 // Flag to describe whether setting is changed or not.
264 // Displayer depends on it to show ChangedFlag.
266 BOOLEAN SettingChangedFlag
;
269 // Statement to be HighLighted
271 FORM_DISPLAY_ENGINE_STATEMENT
*HighLightedStatement
;
273 // Event to notify Displayer that FormData is updated to be refreshed.
275 EFI_EVENT FormRefreshEvent
;
277 // Additional Hotkey registered by BrowserEx protocol.
279 LIST_ENTRY HotKeyListHead
;
282 // Form ImageId and AnimationId
284 EFI_IMAGE_ID ImageId
;
285 EFI_ANIMATION_ID AnimationId
;
288 // If Status is error, display needs to handle it.
290 UINT32 BrowserStatus
;
292 // String for error status. It may be NULL.
294 EFI_STRING ErrorString
;
297 #define FORM_DISPLAY_ENGINE_FORM_FROM_LINK(a) CR (a, FORM_DISPLAY_ENGINE_FORM, Link, FORM_DISPLAY_ENGINE_FORM_SIGNATURE)
300 FORM_DISPLAY_ENGINE_STATEMENT
*SelectedStatement
; // Selected Statement and InputValue
302 EFI_HII_VALUE InputValue
;
304 UINT32 Action
; // If SelectedStatement is NULL, Action will be used.
305 // Trig Action (Discard, Default, Submit, Reset and Exit)
310 Display one form, and return user input.
312 @param FormData Form Data to be shown.
313 @param UserInputData User input data.
315 @retval EFI_SUCCESS Form Data is shown, and user input is got.
319 (EFIAPI
*FORM_DISPLAY
) (
320 IN FORM_DISPLAY_ENGINE_FORM
*FormData
,
321 OUT USER_INPUT
*UserInputData
325 Exit Display and Clear Screen to the original state.
330 (EFIAPI
*EXIT_DISPLAY
) (
335 Confirm how to handle the changed data.
337 @return Action of Submit, Discard and None
341 (EFIAPI
*CONFIRM_DATA_CHANGE
) (
346 FORM_DISPLAY FormDisplay
;
347 EXIT_DISPLAY ExitDisplay
;
348 CONFIRM_DATA_CHANGE ConfirmDataChange
;
349 } EDKII_FORM_DISPLAY_ENGINE_PROTOCOL
;
351 extern EFI_GUID gEdkiiFormDisplayEngineProtocolGuid
;