2 FormDiplay protocol to show Form
4 Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are licensed and made available under
6 the terms and conditions of the BSD License that accompanies this distribution.
7 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.
15 #ifndef __DISPLAY_PROTOCOL_H__
16 #define __DISPLAY_PROTOCOL_H__
18 #include <Protocol/FormBrowser2.h>
20 #define EDKII_FORM_DISPLAY_ENGINE_PROTOCOL_GUID \
21 { 0x9bbe29e9, 0xfda1, 0x41ec, { 0xad, 0x52, 0x45, 0x22, 0x13, 0x74, 0x2d, 0x2e } }
26 #define BROWSER_ACTION_NONE BIT16
30 #define BROWSER_ACTION_FORM_EXIT BIT17
32 #define BROWSER_SUCCESS 0x0
33 #define BROWSER_ERROR BIT31
34 #define BROWSER_SUBMIT_FAIL BROWSER_ERROR | 0x01
35 #define BROWSER_NO_SUBMIT_IF BROWSER_ERROR | 0x02
36 #define BROWSER_FORM_NOT_FOUND BROWSER_ERROR | 0x03
37 #define BROWSER_FORM_SUPPRESS BROWSER_ERROR | 0x04
38 #define BROWSER_PROTOCOL_NOT_FOUND BROWSER_ERROR | 0x05
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_GRAYOUT BIT0
141 #define HII_DISPLAY_LOCK BIT1
142 #define HII_DISPLAY_READONLY BIT2
143 #define HII_DISPLAY_MODAL BIT3
145 struct _FORM_DISPLAY_ENGINE_STATEMENT
{
148 // Version for future structure extension
152 // link to all the statement which will show in the display form.
154 LIST_ENTRY DisplayLink
;
156 // Pointer to statement opcode.
157 // for Guided Opcode. All buffers will be here if GUIDED opcode scope is set.
159 EFI_IFR_OP_HEADER
*OpCode
;
161 // Question CurrentValue
163 EFI_HII_VALUE CurrentValue
;
165 // Flag to describe whether setting is changed or not.
166 // Displayer may depend on it to show it with the different color.
168 BOOLEAN SettingChangedFlag
;
170 // nested Statement list inside of EFI_IFR_SUBTITLE
172 LIST_ENTRY NestStatementList
;
174 // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)
176 LIST_ENTRY OptionListHead
;
178 // Statement attributes: GRAYOUT, LOCK and READONLY
183 // ValidateQuestion to do InconsistIf check
184 // It may be NULL if any value is valid.
186 VALIDATE_QUESTION ValidateQuestion
;
189 // Password additional check. It may be NULL when the additional check is not required.
191 PASSWORD_CHECK PasswordCheck
;
194 // Statement ImageId and AnimationId
196 EFI_IMAGE_ID ImageId
;
197 EFI_ANIMATION_ID AnimationId
;
200 #define FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK(a) CR (a, FORM_DISPLAY_ENGINE_STATEMENT, DisplayLink, FORM_DISPLAY_ENGINE_STATEMENT_SIGNATURE)
202 #define BROWSER_HOT_KEY_SIGNATURE SIGNATURE_32 ('B', 'H', 'K', 'S')
208 EFI_INPUT_KEY
*KeyData
;
210 // Action is Discard, Default, Submit, Reset and Exit.
215 // HotKey Help String
217 EFI_STRING HelpString
;
220 #define BROWSER_HOT_KEY_FROM_LINK(a) CR (a, BROWSER_HOT_KEY, Link, BROWSER_HOT_KEY_SIGNATURE)
222 #define FORM_DISPLAY_ENGINE_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')
224 struct _FORM_DISPLAY_ENGINE_FORM
{
227 // Version for future structure extension
231 // Statement List inside of Form
233 LIST_ENTRY StatementListHead
;
235 // Statement List outside of Form
237 LIST_ENTRY StatementListOSF
;
239 // The input screen dimenstions info.
241 EFI_SCREEN_DESCRIPTOR
*ScreenDimensions
;
243 // FormSet information
245 EFI_GUID FormSetGuid
;
247 // HiiHandle can be used to get String, Image or Animation
249 EFI_HII_HANDLE HiiHandle
;
252 // Form ID and Title.
255 EFI_STRING_ID FormTitle
;
257 // Form Attributes: Lock, Modal.
261 // Flag to describe whether setting is changed or not.
262 // Displayer depends on it to show ChangedFlag.
264 BOOLEAN SettingChangedFlag
;
267 // Statement to be HighLighted
269 FORM_DISPLAY_ENGINE_STATEMENT
*HighLightedStatement
;
271 // Event to notify Displayer that FormData is updated to be refreshed.
273 EFI_EVENT FormRefreshEvent
;
275 // Additional Hotkey registered by BrowserEx protocol.
277 LIST_ENTRY HotKeyListHead
;
280 // Form ImageId and AnimationId
282 EFI_IMAGE_ID ImageId
;
283 EFI_ANIMATION_ID AnimationId
;
286 // If Status is error, display needs to handle it.
288 UINT32 BrowserStatus
;
290 // String for error status. It may be NULL.
292 EFI_STRING ErrorString
;
295 #define FORM_DISPLAY_ENGINE_FORM_FROM_LINK(a) CR (a, FORM_DISPLAY_ENGINE_FORM, Link, FORM_DISPLAY_ENGINE_FORM_SIGNATURE)
298 FORM_DISPLAY_ENGINE_STATEMENT
*SelectedStatement
; // Selected Statement and InputValue
300 EFI_HII_VALUE InputValue
;
302 UINT32 Action
; // If SelectedStatement is NULL, Action will be used.
303 // Trig Action (Discard, Default, Submit, Reset and Exit)
308 Display one form, and return user input.
310 @param FormData Form Data to be shown.
311 @param UserInputData User input data.
313 @retval EFI_SUCCESS Form Data is shown, and user input is got.
317 (EFIAPI
*FORM_DISPLAY
) (
318 IN FORM_DISPLAY_ENGINE_FORM
*FormData
,
319 OUT USER_INPUT
*UserInputData
323 Exit Display and Clear Screen to the original state.
328 (EFIAPI
*EXIT_DISPLAY
) (
333 Confirm how to handle the changed data.
335 @return Action of Submit, Discard and None
339 (EFIAPI
*CONFIRM_DATA_CHANGE
) (
344 FORM_DISPLAY FormDisplay
;
345 EXIT_DISPLAY ExitDisplay
;
346 CONFIRM_DATA_CHANGE ConfirmDataChange
;
347 } EDKII_FORM_DISPLAY_ENGINE_PROTOCOL
;
349 extern EFI_GUID gEdkiiFormDisplayEngineProtocolGuid
;