2 This file defines the encoding for the VFR (Visual Form Representation) language.
3 Framework IFR is primarily consumed by the EFI presentation engine, and produced by EFI
4 internal application and drivers as well as all add-in card option-ROM drivers
6 Copyright (c) 2007, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 @par Revision Reference:
16 These definitions are from Framework Specification HII 0.92.
20 #ifndef __FRAMEWORK_INTERNAL_FORMREPRESENTATION_H__
21 #define __FRAMEWORK_INTERNAL_FORMREPRESENTATION_H__
26 #define FRAMEWORK_EFI_IFR_FORM_OP 0x01
27 #define FRAMEWORK_EFI_IFR_SUBTITLE_OP 0x02
28 #define FRAMEWORK_EFI_IFR_TEXT_OP 0x03
29 #define FRAMEWORK_EFI_IFR_GRAPHIC_OP 0x04
30 #define FRAMEWORK_EFI_IFR_ONE_OF_OP 0x05
31 #define FRAMEWORK_EFI_IFR_CHECKBOX_OP 0x06
32 #define FRAMEWORK_EFI_IFR_NUMERIC_OP 0x07
33 #define FRAMEWORK_EFI_IFR_PASSWORD_OP 0x08
34 #define FRAMEWORK_EFI_IFR_ONE_OF_OPTION_OP 0x09 // ONEOF OPTION field
35 #define FRAMEWORK_EFI_IFR_SUPPRESS_IF_OP 0x0A
36 #define FRAMEWORK_EFI_IFR_END_FORM_OP 0x0B
37 #define FRAMEWORK_EFI_IFR_HIDDEN_OP 0x0C
38 #define FRAMEWORK_EFI_IFR_END_FORM_SET_OP 0x0D
39 #define FRAMEWORK_EFI_IFR_FORM_SET_OP 0x0E
40 #define FRAMEWORK_EFI_IFR_REF_OP 0x0F
41 #define FRAMEWORK_EFI_IFR_END_ONE_OF_OP 0x10
42 #define FRAMEWORK_EFI_IFR_END_OP FRAMEWORK_EFI_IFR_END_ONE_OF_OP
43 #define FRAMEWORK_EFI_IFR_INCONSISTENT_IF_OP 0x11
44 #define FRAMEWORK_EFI_IFR_EQ_ID_VAL_OP 0x12
45 #define FRAMEWORK_EFI_IFR_EQ_ID_ID_OP 0x13
46 #define FRAMEWORK_EFI_IFR_EQ_ID_LIST_OP 0x14
47 #define FRAMEWORK_EFI_IFR_AND_OP 0x15
48 #define FRAMEWORK_EFI_IFR_OR_OP 0x16
49 #define FRAMEWORK_EFI_IFR_NOT_OP 0x17
50 #define FRAMEWORK_EFI_IFR_END_IF_OP 0x18 // for endif of inconsistentif, suppressif, grayoutif
51 #define FRAMEWORK_EFI_IFR_GRAYOUT_IF_OP 0x19
52 #define FRAMEWORK_EFI_IFR_DATE_OP 0x1A
53 #define FRAMEWORK_EFI_IFR_TIME_OP 0x1B
54 #define FRAMEWORK_EFI_IFR_STRING_OP 0x1C
55 #define FRAMEWORK_EFI_IFR_LABEL_OP 0x1D
56 #define FRAMEWORK_EFI_IFR_SAVE_DEFAULTS_OP 0x1E
57 #define FRAMEWORK_EFI_IFR_RESTORE_DEFAULTS_OP 0x1F
58 #define FRAMEWORK_EFI_IFR_BANNER_OP 0x20
59 #define FRAMEWORK_EFI_IFR_INVENTORY_OP 0x21
60 #define FRAMEWORK_EFI_IFR_EQ_VAR_VAL_OP 0x22
61 #define FRAMEWORK_EFI_IFR_ORDERED_LIST_OP 0x23
62 #define FRAMEWORK_EFI_IFR_VARSTORE_OP 0x24
63 #define FRAMEWORK_EFI_IFR_VARSTORE_SELECT_OP 0x25
64 #define FRAMEWORK_EFI_IFR_VARSTORE_SELECT_PAIR_OP 0x26
65 #define FRAMEWORK_EFI_IFR_TRUE_OP 0x27
66 #define FRAMEWORK_EFI_IFR_FALSE_OP 0x28
67 #define FRAMEWORK_EFI_IFR_GT_OP 0x29
68 #define FRAMEWORK_EFI_IFR_GE_OP 0x2A
69 #define FRAMEWORK_EFI_IFR_OEM_DEFINED_OP 0x2B
70 #define FRAMEWORK_EFI_IFR_LAST_OPCODE FRAMEWORK_EFI_IFR_OEM_DEFINED_OP
71 #define FRAMEWORK_EFI_IFR_OEM_OP 0xFE
72 #define FRAMEWORK_EFI_IFR_NV_ACCESS_COMMAND 0xFF
75 // Define values for the flags fields in some VFR opcodes. These are
78 #define FRAMEWORK_EFI_IFR_FLAG_DEFAULT 0x01
79 #define FRAMEWORK_EFI_IFR_FLAG_MANUFACTURING 0x02
80 #define FRAMEWORK_EFI_IFR_FLAG_INTERACTIVE 0x04
81 #define FRAMEWORK_EFI_IFR_FLAG_NV_ACCESS 0x08
82 #define FRAMEWORK_EFI_IFR_FLAG_RESET_REQUIRED 0x10
83 #define FRAMEWORK_EFI_IFR_FLAG_LATE_CHECK 0x20
85 #define EFI_NON_DEVICE_CLASS 0x00 // Useful when you do not want something in the Device Manager
86 #define EFI_DISK_DEVICE_CLASS 0x01
87 #define EFI_VIDEO_DEVICE_CLASS 0x02
88 #define EFI_NETWORK_DEVICE_CLASS 0x04
89 #define EFI_INPUT_DEVICE_CLASS 0x08
90 #define EFI_ON_BOARD_DEVICE_CLASS 0x10
91 #define EFI_OTHER_DEVICE_CLASS 0x20
93 #define EFI_SETUP_APPLICATION_SUBCLASS 0x00
94 #define EFI_GENERAL_APPLICATION_SUBCLASS 0x01
95 #define EFI_FRONT_PAGE_SUBCLASS 0x02
96 #define EFI_SINGLE_USE_SUBCLASS 0x03 // Used to display a single entity and then exit
99 // Used to flag dynamically created op-codes. This is meaningful to the IFR Library set
100 // and the browser since we need to distinguish between compiled NV map data and created data.
101 // We do not allow new entries to be created in the NV map dynamically however we still need
102 // to display this information correctly. To dynamically create op-codes and assume that their
103 // data will be saved, ensure that the NV starting location they refer to is pre-defined in the
106 #define FRAMEWORK_EFI_IFR_FLAG_CREATED 128
111 // IFR Structure definitions
116 } FRAMEWORK_EFI_IFR_OP_HEADER
;
119 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
121 STRING_REF FormSetTitle
;
123 EFI_PHYSICAL_ADDRESS CallbackHandle
;
126 UINT16 NvDataSize
; // set once, size of the NV data as defined in the script
127 } FRAMEWORK_EFI_IFR_FORM_SET
;
130 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
132 STRING_REF FormTitle
;
133 } FRAMEWORK_EFI_IFR_FORM
;
136 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
138 } FRAMEWORK_EFI_IFR_LABEL
;
141 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
143 } FRAMEWORK_EFI_IFR_SUBTITLE
;
146 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
150 UINT8 Flags
; // This is included solely for purposes of interactive/dynamic support.
151 UINT16 Key
; // Value to be passed to caller to identify this particular op-code
152 } FRAMEWORK_EFI_IFR_TEXT
;
158 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
161 STRING_REF Help
; // The string Token for the context-help
162 UINT8 Flags
; // This is included solely for purposes of interactive/dynamic support.
163 UINT16 Key
; // Value to be passed to caller to identify this particular op-code
164 } FRAMEWORK_EFI_IFR_REF
;
167 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
168 } FRAMEWORK_EFI_IFR_END_FORM
;
171 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
172 } FRAMEWORK_EFI_IFR_END_FORM_SET
;
175 // Also notice that the IFR_ONE_OF and IFR_CHECK_BOX are identical in structure......
176 // code assumes this to be true, if this ever changes we need to revisit the InitializeTagStructures code
179 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
180 UINT16 QuestionId
; // The ID designating what the question is about...
181 UINT8 Width
; // The Size of the Data being saved
182 STRING_REF Prompt
; // The String Token for the Prompt
183 STRING_REF Help
; // The string Token for the context-help
184 } FRAMEWORK_EFI_IFR_ONE_OF
;
187 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
188 UINT16 QuestionId
; // The offset in NV for storage of the data
189 UINT8 MaxEntries
; // The maximum number of options in the ordered list (=size of NVStore)
190 STRING_REF Prompt
; // The string token for the prompt
191 STRING_REF Help
; // The string token for the context-help
192 } FRAMEWORK_EFI_IFR_ORDERED_LIST
;
195 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
196 UINT16 QuestionId
; // The ID designating what the question is about...
197 UINT8 Width
; // The Size of the Data being saved
198 STRING_REF Prompt
; // The String Token for the Prompt
199 STRING_REF Help
; // The string Token for the context-help
200 UINT8 Flags
; // If non-zero, means that it is the default option
201 UINT16 Key
; // Value to be passed to caller to identify this particular op-code
202 } FRAMEWORK_EFI_IFR_CHECKBOX
, FRAMEWORK_EFI_IFR_CHECK_BOX
;
205 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
206 STRING_REF Option
; // The string token describing the option
207 UINT16 Value
; // The value associated with this option that is stored in the NVRAM
208 UINT8 Flags
; // If non-zero, means that it is the default option
209 UINT16 Key
; // Value to be passed to caller to identify this particular op-code
210 } FRAMEWORK_EFI_IFR_ONE_OF_OPTION
;
213 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
214 UINT16 QuestionId
; // The ID designating what the question is about...
215 UINT8 Width
; // The Size of the Data being saved
216 STRING_REF Prompt
; // The String Token for the Prompt
217 STRING_REF Help
; // The string Token for the context-help
218 UINT8 Flags
; // This is included solely for purposes of interactive/dynamic support.
219 UINT16 Key
; // Value to be passed to caller to identify this particular op-code
222 UINT16 Step
; // Zero means manual input, otherwise, arrow selection is called for
224 } FRAMEWORK_EFI_IFR_NUMERIC
;
227 // There is an interesting twist with regards to Time and Date. This is one of the few items which can accept input
228 // from a user, however may or may not need to use storage in the NVRAM space. The decided method for determining
229 // if NVRAM space will be used (only for a TimeOp or DateOp) is: If .QuestionId == 0 && .Width == 0 (normally an
230 // impossibility) then use system resources to store the data away and not NV resources. In other words, the setup
231 // engine will call gRT->SetTime, and gRT->SetDate for the saving of data, and the values displayed will be from the
232 // gRT->GetXXXX series of calls.
235 FRAMEWORK_EFI_IFR_NUMERIC Hour
;
236 FRAMEWORK_EFI_IFR_NUMERIC Minute
;
237 FRAMEWORK_EFI_IFR_NUMERIC Second
;
238 } FRAMEWORK_EFI_IFR_TIME
;
241 FRAMEWORK_EFI_IFR_NUMERIC Year
;
242 FRAMEWORK_EFI_IFR_NUMERIC Month
;
243 FRAMEWORK_EFI_IFR_NUMERIC Day
;
244 } FRAMEWORK_EFI_IFR_DATE
;
247 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
248 UINT16 QuestionId
;// The ID designating what the question is about...
249 UINT8 Width
; // The Size of the Data being saved
250 STRING_REF Prompt
; // The String Token for the Prompt
251 STRING_REF Help
; // The string Token for the context-help
252 UINT8 Flags
; // This is included solely for purposes of interactive/dynamic support.
253 UINT16 Key
; // Value to be passed to caller to identify this particular op-code
254 UINT8 MinSize
; // Minimum allowable sized password
255 UINT8 MaxSize
; // Maximum allowable sized password
257 } FRAMEWORK_EFI_IFR_PASSWORD
;
260 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
261 UINT16 QuestionId
; // The ID designating what the question is about...
262 UINT8 Width
; // The Size of the Data being saved
263 STRING_REF Prompt
; // The String Token for the Prompt
264 STRING_REF Help
; // The string Token for the context-help
265 UINT8 Flags
; // This is included solely for purposes of interactive/dynamic support.
266 UINT16 Key
; // Value to be passed to caller to identify this particular op-code
267 UINT8 MinSize
; // Minimum allowable sized password
268 UINT8 MaxSize
; // Maximum allowable sized password
269 } FRAMEWORK_EFI_IFR_STRING
;
272 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
273 } FRAMEWORK_EFI_IFR_END_ONE_OF
;
276 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
279 } FRAMEWORK_EFI_IFR_HIDDEN
;
282 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
284 } FRAMEWORK_EFI_IFR_SUPPRESS
;
287 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
289 } FRAMEWORK_EFI_IFR_GRAY_OUT
;
292 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
295 } FRAMEWORK_EFI_IFR_INCONSISTENT
;
298 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
299 UINT16 QuestionId
; // offset into variable storage
300 UINT8 Width
; // size of variable storage
301 UINT16 Value
; // value to compare against
302 } FRAMEWORK_EFI_IFR_EQ_ID_VAL
;
305 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
306 UINT16 QuestionId
; // offset into variable storage
307 UINT8 Width
; // size of variable storage
310 } FRAMEWORK_EFI_IFR_EQ_ID_LIST
;
313 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
314 UINT16 QuestionId1
; // offset into variable storage for first value to compare
315 UINT8 Width
; // size of variable storage (must be same for both)
316 UINT16 QuestionId2
; // offset into variable storage for second value to compare
317 } FRAMEWORK_EFI_IFR_EQ_ID_ID
;
320 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
321 UINT16 VariableId
; // offset into variable storage
322 UINT16 Value
; // value to compare against
323 } FRAMEWORK_EFI_IFR_EQ_VAR_VAL
;
326 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
327 } FRAMEWORK_EFI_IFR_AND
;
330 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
331 } FRAMEWORK_EFI_IFR_OR
;
334 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
335 } FRAMEWORK_EFI_IFR_NOT
;
338 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
339 } FRAMEWORK_EFI_IFR_END_EXPR
, FRAMEWORK_EFI_IFR_END_IF
;
342 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
348 } FRAMEWORK_EFI_IFR_SAVE_DEFAULTS
;
351 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
354 STRING_REF TextTwo
; // optional text
355 } FRAMEWORK_EFI_IFR_INVENTORY
;
358 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
359 EFI_GUID Guid
; // GUID for the variable
360 UINT16 VarId
; // variable store ID, as referenced elsewhere in the form
361 UINT16 Size
; // size of the variable storage
362 } FRAMEWORK_EFI_IFR_VARSTORE
;
365 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
366 UINT16 VarId
; // variable store ID, as referenced elsewhere in the form
367 } FRAMEWORK_EFI_IFR_VARSTORE_SELECT
;
370 // Used for the ideqid VFR statement where two variable stores may be referenced in the
371 // same VFR statement.
372 // A browser should treat this as an FRAMEWORK_EFI_IFR_VARSTORE_SELECT statement and assume that all following
373 // IFR opcodes use the VarId as defined here.
376 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
377 UINT16 VarId
; // variable store ID, as referenced elsewhere in the form
378 UINT16 SecondaryVarId
; // variable store ID, as referenced elsewhere in the form
379 } FRAMEWORK_EFI_IFR_VARSTORE_SELECT_PAIR
;
382 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
383 } FRAMEWORK_EFI_IFR_TRUE
;
386 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
387 } FRAMEWORK_EFI_IFR_FALSE
;
390 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
391 } FRAMEWORK_EFI_IFR_GT
;
394 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
395 } FRAMEWORK_EFI_IFR_GE
;
398 // Save defaults and restore defaults have same structure
400 #define FRAMEWORK_EFI_IFR_RESTORE_DEFAULTS FRAMEWORK_EFI_IFR_SAVE_DEFAULTS
403 FRAMEWORK_EFI_IFR_OP_HEADER Header
;
404 STRING_REF Title
; // The string token for the banner title
405 UINT16 LineNumber
; // 1-based line number
406 UINT8 Alignment
; // left, center, or right-aligned
407 } FRAMEWORK_EFI_IFR_BANNER
;
409 #define FRAMEWORK_EFI_IFR_BANNER_ALIGN_LEFT 0
410 #define FRAMEWORK_EFI_IFR_BANNER_ALIGN_CENTER 1
411 #define FRAMEWORK_EFI_IFR_BANNER_ALIGN_RIGHT 2
412 #define FRAMEWORK_EFI_IFR_BANNER_TIMEOUT 0xFF