Update for IntelFrameworkModulePkg.
[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / BdsDxe / BootMaint / FormGuid.h
1 /** @file
2 Formset guids, form id and VarStore data structure for Boot Maintenance Manager.
3
4 Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>
5 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
9
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.
12
13 **/
14 #ifndef _FORM_GUID_H_
15 #define _FORM_GUID_H_
16
17 #include <Guid/BdsHii.h>
18
19 #define FORM_MAIN_ID 0x1001
20 #define FORM_BOOT_ADD_ID 0x1002
21 #define FORM_BOOT_DEL_ID 0x1003
22 #define FORM_BOOT_CHG_ID 0x1004
23 #define FORM_DRV_ADD_ID 0x1005
24 #define FORM_DRV_DEL_ID 0x1006
25 #define FORM_DRV_CHG_ID 0x1007
26 #define FORM_CON_MAIN_ID 0x1008
27 #define FORM_CON_IN_ID 0x1009
28 #define FORM_CON_OUT_ID 0x100A
29 #define FORM_CON_ERR_ID 0x100B
30 #define FORM_FILE_SEEK_ID 0x100C
31 #define FORM_FILE_NEW_SEEK_ID 0x100D
32 #define FORM_DRV_ADD_FILE_ID 0x100E
33 #define FORM_DRV_ADD_HANDLE_ID 0x100F
34 #define FORM_DRV_ADD_HANDLE_DESC_ID 0x1010
35 #define FORM_BOOT_NEXT_ID 0x1011
36 #define FORM_TIME_OUT_ID 0x1012
37 #define FORM_RESET 0x1013
38 #define FORM_BOOT_SETUP_ID 0x1014
39 #define FORM_DRIVER_SETUP_ID 0x1015
40 #define FORM_BOOT_LEGACY_DEVICE_ID 0x1016
41 #define FORM_CON_COM_ID 0x1017
42 #define FORM_CON_COM_SETUP_ID 0x1018
43 #define FORM_SET_FD_ORDER_ID 0x1019
44 #define FORM_SET_HD_ORDER_ID 0x101A
45 #define FORM_SET_CD_ORDER_ID 0x101B
46 #define FORM_SET_NET_ORDER_ID 0x101C
47 #define FORM_SET_BEV_ORDER_ID 0x101D
48 #define FORM_FILE_EXPLORER_ID 0x101E
49 #define FORM_BOOT_ADD_DESCRIPTION_ID 0x101F
50 #define FORM_DRIVER_ADD_FILE_DESCRIPTION_ID 0x1020
51 #define FORM_CON_MODE_ID 0x1021
52 #define FORM_BOOT_FROM_FILE_ID 0x1022
53
54 #define MAXIMUM_FORM_ID 0x10FF
55
56 #define KEY_VALUE_COM_SET_BAUD_RATE 0x1101
57 #define KEY_VALUE_COM_SET_DATA_BITS 0x1102
58 #define KEY_VALUE_COM_SET_STOP_BITS 0x1103
59 #define KEY_VALUE_COM_SET_PARITY 0x1104
60 #define KEY_VALUE_COM_SET_TERMI_TYPE 0x1105
61 #define KEY_VALUE_MAIN_BOOT_NEXT 0x1106
62 #define KEY_VALUE_BOOT_ADD_DESC_DATA 0x1107
63 #define KEY_VALUE_BOOT_ADD_OPT_DATA 0x1108
64 #define KEY_VALUE_DRIVER_ADD_DESC_DATA 0x1109
65 #define KEY_VALUE_DRIVER_ADD_OPT_DATA 0x110A
66 #define KEY_VALUE_SAVE_AND_EXIT 0x110B
67 #define KEY_VALUE_NO_SAVE_AND_EXIT 0x110C
68 #define KEY_VALUE_BOOT_FROM_FILE 0x110D
69
70 #define MAXIMUM_NORMAL_KEY_VALUE 0x11FF
71
72 //
73 // Varstore ID defined for Buffer Storage
74 //
75 #define VARSTORE_ID_BOOT_MAINT 0x1000
76 #define VARSTORE_ID_FILE_EXPLORER 0x1001
77
78 //
79 // End Label
80 //
81 #define LABEL_END 0xffff
82 #define MAX_MENU_NUMBER 100
83
84 ///
85 /// This is the structure that will be used to store the
86 /// question's current value. Use it at initialize time to
87 /// set default value for each question. When using at run
88 /// time, this map is returned by the callback function,
89 /// so dynamically changing the question's value will be
90 /// possible through this mechanism
91 ///
92 typedef struct {
93 //
94 // Three questions displayed at the main page
95 // for Timeout, BootNext Variables respectively
96 //
97 UINT16 BootTimeOut;
98 UINT16 BootNext;
99
100 //
101 // This is the COM1 Attributes value storage
102 //
103 UINT8 COM1BaudRate;
104 UINT8 COM1DataRate;
105 UINT8 COM1StopBits;
106 UINT8 COM1Parity;
107 UINT8 COM1TerminalType;
108
109 //
110 // This is the COM2 Attributes value storage
111 //
112 UINT8 COM2BaudRate;
113 UINT8 COM2DataRate;
114 UINT8 COM2StopBits;
115 UINT8 COM2Parity;
116 UINT8 COM2TerminalType;
117
118 //
119 // Driver Option Add Handle page storage
120 //
121 UINT16 DriverAddHandleDesc[MAX_MENU_NUMBER];
122 UINT16 DriverAddHandleOptionalData[MAX_MENU_NUMBER];
123 UINT8 DriverAddActive;
124 UINT8 DriverAddForceReconnect;
125
126 //
127 // Console Input/Output/Errorout using COM port check storage
128 //
129 UINT8 ConsoleInputCOM1;
130 UINT8 ConsoleInputCOM2;
131 UINT8 ConsoleOutputCOM1;
132 UINT8 ConsoleOutputCOM2;
133 UINT8 ConsoleErrorCOM1;
134 UINT8 ConsoleErrorCOM2;
135
136 //
137 // At most 100 input/output/errorout device for console storage
138 //
139 UINT8 ConsoleCheck[MAX_MENU_NUMBER];
140
141 //
142 // Boot or Driver Option Order storage
143 // The value is the OptionNumber+1 because the order list value cannot be 0
144 // Use UINT32 to hold the potential value 0xFFFF+1=0x10000
145 //
146 UINT32 OptionOrder[MAX_MENU_NUMBER];
147
148 //
149 // Boot or Driver Option Delete storage
150 //
151 BOOLEAN OptionDel[MAX_MENU_NUMBER];
152
153 //
154 // This is the Terminal Attributes value storage
155 //
156 UINT8 COMBaudRate;
157 UINT8 COMDataRate;
158 UINT8 COMStopBits;
159 UINT8 COMParity;
160 UINT8 COMTerminalType;
161 UINT8 COMFlowControl;
162
163 //
164 // Legacy Device Order Selection Storage
165 //
166 UINT8 LegacyFD[MAX_MENU_NUMBER];
167 UINT8 LegacyHD[MAX_MENU_NUMBER];
168 UINT8 LegacyCD[MAX_MENU_NUMBER];
169 UINT8 LegacyNET[MAX_MENU_NUMBER];
170 UINT8 LegacyBEV[MAX_MENU_NUMBER];
171
172 //
173 // We use DisableMap array to record the enable/disable state of each boot device
174 // It should be taken as a bit array, from left to right there are totally 256 bits
175 // the most left one stands for BBS table item 0, and the most right one stands for item 256
176 // If the bit is 1, it means the boot device has been disabled.
177 //
178 UINT8 DisableMap[32];
179
180 //
181 // Console Output Text Mode
182 //
183 UINT16 ConsoleOutMode;
184
185 //
186 // UINT16 PadArea[10];
187 //
188 } BMM_FAKE_NV_DATA;
189
190 //
191 // Key used by File Explorer forms
192 //
193 #define KEY_VALUE_SAVE_AND_EXIT_BOOT 0x1000
194 #define KEY_VALUE_NO_SAVE_AND_EXIT_BOOT 0x1001
195 #define KEY_VALUE_SAVE_AND_EXIT_DRIVER 0x1002
196 #define KEY_VALUE_NO_SAVE_AND_EXIT_DRIVER 0x1003
197
198 ///
199 /// This is the data structure used by File Explorer formset
200 ///
201 typedef struct {
202 UINT16 DescriptionData[75];
203 UINT16 OptionalData[127];
204 UINT8 Active;
205 UINT8 ForceReconnect;
206 } FILE_EXPLORER_NV_DATA;
207
208 #endif
209