2 EDK II specific HII relative definition.
4 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials are licensed and made available
7 under the terms and conditions of the BSD License which accompanies this
8 distribution. The full text of the license may be found at:
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14 File Name: MdeModuleHii.h
18 #ifndef _MDEMODULE_HII_H
19 #define _MDEMODULE_HII_H
21 #define NARROW_CHAR 0xFFF0
22 #define WIDE_CHAR 0xFFF1
23 #define NON_BREAKING_CHAR 0xFFF2
26 /// State defined for password statemachine .
28 #define BROWSER_STATE_VALIDATE_PASSWORD 0
29 #define BROWSER_STATE_SET_PASSWORD 1
32 /// GUIDed opcodes defined for EDKII implementation.
34 #define EFI_IFR_TIANO_GUID \
35 { 0xf0b1735, 0x87a0, 0x4193, {0xb2, 0x66, 0x53, 0x8c, 0x38, 0xaf, 0x48, 0xce} }
40 /// EDKII implementation extension opcodes, new extension can be added here later.
42 #define EFI_IFR_EXTEND_OP_LABEL 0x0
43 #define EFI_IFR_EXTEND_OP_BANNER 0x1
44 #define EFI_IFR_EXTEND_OP_TIMEOUT 0x2
45 #define EFI_IFR_EXTEND_OP_CLASS 0x3
46 #define EFI_IFR_EXTEND_OP_SUBCLASS 0x4
51 typedef struct _EFI_IFR_GUID_LABEL
{
52 EFI_IFR_OP_HEADER Header
;
54 /// EFI_IFR_TIANO_GUID.
58 /// EFI_IFR_EXTEND_OP_LABEL.
67 #define EFI_IFR_BANNER_ALIGN_LEFT 0
68 #define EFI_IFR_BANNER_ALIGN_CENTER 1
69 #define EFI_IFR_BANNER_ALIGN_RIGHT 2
74 typedef struct _EFI_IFR_GUID_BANNER
{
75 EFI_IFR_OP_HEADER Header
;
77 /// EFI_IFR_TIANO_GUID.
81 /// EFI_IFR_EXTEND_OP_BANNER
84 EFI_STRING_ID Title
; ///< The string token for the banner title.
85 UINT16 LineNumber
; ///< 1-based line number.
86 UINT8 Alignment
; ///< left, center, or right-aligned.
87 } EFI_IFR_GUID_BANNER
;
92 typedef struct _EFI_IFR_GUID_TIMEOUT
{
93 EFI_IFR_OP_HEADER Header
;
95 /// EFI_IFR_TIANO_GUID.
99 /// EFI_IFR_EXTEND_OP_TIMEOUT.
102 UINT16 TimeOut
; ///< TimeOut Value.
103 } EFI_IFR_GUID_TIMEOUT
;
105 #define EFI_NON_DEVICE_CLASS 0x00
106 #define EFI_DISK_DEVICE_CLASS 0x01
107 #define EFI_VIDEO_DEVICE_CLASS 0x02
108 #define EFI_NETWORK_DEVICE_CLASS 0x04
109 #define EFI_INPUT_DEVICE_CLASS 0x08
110 #define EFI_ON_BOARD_DEVICE_CLASS 0x10
111 #define EFI_OTHER_DEVICE_CLASS 0x20
114 /// Device Class opcode.
116 typedef struct _EFI_IFR_GUID_CLASS
{
117 EFI_IFR_OP_HEADER Header
;
119 /// EFI_IFR_TIANO_GUID.
123 /// EFI_IFR_EXTEND_OP_CLASS.
126 UINT16 Class
; ///< Device Class from the above.
127 } EFI_IFR_GUID_CLASS
;
129 #define EFI_SETUP_APPLICATION_SUBCLASS 0x00
130 #define EFI_GENERAL_APPLICATION_SUBCLASS 0x01
131 #define EFI_FRONT_PAGE_SUBCLASS 0x02
132 #define EFI_SINGLE_USE_SUBCLASS 0x03
137 typedef struct _EFI_IFR_GUID_SUBCLASS
{
138 EFI_IFR_OP_HEADER Header
;
140 /// EFI_IFR_TIANO_GUID.
144 /// EFI_IFR_EXTEND_OP_SUBCLASS.
147 UINT16 SubClass
; ///< Sub Class type from the above.
148 } EFI_IFR_GUID_SUBCLASS
;
151 /// GUIDed opcodes support for framework vfr.
153 #define EFI_IFR_FRAMEWORK_GUID \
154 { 0x31ca5d1a, 0xd511, 0x4931, { 0xb7, 0x82, 0xae, 0x6b, 0x2b, 0x17, 0x8c, 0xd7 } }
157 /// Two extended opcodes are added, and new extensions can be added here later.
158 /// One is for framework OneOf question Option Key value;
159 /// another is for framework vareqval.
161 #define EFI_IFR_EXTEND_OP_OPTIONKEY 0x0
162 #define EFI_IFR_EXTEND_OP_VAREQNAME 0x1
165 /// Store the framework vfr option key value.
167 typedef struct _EFI_IFR_GUID_OPTIONKEY
{
168 EFI_IFR_OP_HEADER Header
;
170 /// EFI_IFR_FRAMEWORK_GUID.
174 /// EFI_IFR_EXTEND_OP_OPTIONKEY.
178 /// OneOf Questiond ID binded by OneOf Option.
180 EFI_QUESTION_ID QuestionId
;
182 /// The OneOf Option Value.
184 EFI_IFR_TYPE_VALUE OptionValue
;
186 /// The Framework OneOf Option Key Value.
189 } EFI_IFR_GUID_OPTIONKEY
;
192 /// Store the framework vfr vareqval name number.
194 typedef struct _EFI_IFR_GUID_VAREQNAME
{
195 EFI_IFR_OP_HEADER Header
;
197 /// EFI_IFR_FRAMEWORK_GUID.
201 /// EFI_IFR_EXTEND_OP_VAREQNAME.
205 /// Question ID of the Numeric Opcode created.
207 EFI_QUESTION_ID QuestionId
;
209 /// For vareqval (0x100), NameId is 0x100.
210 /// This value will convert to a Unicode String following this rule;
211 /// sprintf(StringBuffer, "%d", NameId) .
212 /// The the Unicode String will be used as a EFI Variable Name.
215 } EFI_IFR_GUID_VAREQNAME
;
219 extern EFI_GUID gEfiIfrTianoGuid
;
220 extern EFI_GUID gEfiIfrFrameworkGuid
;