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