]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | Header file for boot maintenance module.\r | |
3 | \r | |
4 | Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r | |
5 | This program and the accompanying materials\r | |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _BOOT_MAINT_H_\r | |
16 | #define _BOOT_MAINT_H_\r | |
17 | \r | |
18 | #include "Ui.h"\r | |
19 | #include "FormGuid.h"\r | |
20 | #include "FrontPage.h"\r | |
21 | \r | |
22 | //\r | |
23 | // Constants which are variable names used to access variables\r | |
24 | //\r | |
25 | \r | |
26 | #define VAR_CON_OUT_MODE L"ConOutMode"\r | |
27 | \r | |
28 | \r | |
29 | //\r | |
30 | // String Contant\r | |
31 | //\r | |
32 | #define STR_FLOPPY L"Floppy Drive #%02x"\r | |
33 | #define STR_HARDDISK L"HardDisk Drive #%02x"\r | |
34 | #define STR_CDROM L"ATAPI CDROM Drive #%02x"\r | |
35 | #define STR_NET L"NET Drive #%02x"\r | |
36 | #define STR_BEV L"BEV Drive #%02x"\r | |
37 | #define STR_FLOPPY_HELP L"Select Floppy Drive #%02x"\r | |
38 | #define STR_HARDDISK_HELP L"Select HardDisk Drive #%02x"\r | |
39 | #define STR_CDROM_HELP L"Select ATAPI CDROM Drive #%02x"\r | |
40 | #define STR_NET_HELP L"NET Drive #%02x"\r | |
41 | #define STR_BEV_HELP L"BEV Drive #%02x"\r | |
42 | \r | |
43 | //\r | |
44 | // Variable created with this flag will be "Efi:...."\r | |
45 | //\r | |
46 | #define VAR_FLAG EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE\r | |
47 | \r | |
48 | extern EFI_GUID mBootMaintGuid;\r | |
49 | extern EFI_GUID mFileExplorerGuid;\r | |
50 | extern CHAR16 mFileExplorerStorageName[];\r | |
51 | extern CHAR16 mBootMaintStorageName[];\r | |
52 | //\r | |
53 | // These are the VFR compiler generated data representing our VFR data.\r | |
54 | //\r | |
55 | extern UINT8 BmBin[];\r | |
56 | extern UINT8 FEBin[];\r | |
57 | \r | |
58 | //\r | |
59 | // Below are the number of options in Baudrate, Databits,\r | |
60 | // Parity and Stopbits selection for serial ports.\r | |
61 | //\r | |
62 | #define BM_COM_ATTR_BUADRATE 19\r | |
63 | #define BM_COM_ATTR_DATABITS 4\r | |
64 | #define BM_COM_ATTR_PARITY 5\r | |
65 | #define BM_COM_ATTR_STOPBITS 3\r | |
66 | \r | |
67 | //\r | |
68 | // Callback function helper\r | |
69 | //\r | |
70 | #define BMM_CALLBACK_DATA_SIGNATURE SIGNATURE_32 ('C', 'b', 'c', 'k')\r | |
71 | #define BMM_CALLBACK_DATA_FROM_THIS(a) CR (a, BMM_CALLBACK_DATA, BmmConfigAccess, BMM_CALLBACK_DATA_SIGNATURE)\r | |
72 | \r | |
73 | #define FE_CALLBACK_DATA_FROM_THIS(a) CR (a, BMM_CALLBACK_DATA, FeConfigAccess, BMM_CALLBACK_DATA_SIGNATURE)\r | |
74 | \r | |
75 | //\r | |
76 | // Enumeration type definition\r | |
77 | //\r | |
78 | typedef UINT8 BBS_TYPE;\r | |
79 | \r | |
80 | typedef enum _TYPE_OF_TERMINAL {\r | |
81 | TerminalTypePcAnsi = 0,\r | |
82 | TerminalTypeVt100,\r | |
83 | TerminalTypeVt100Plus,\r | |
84 | TerminalTypeVtUtf8\r | |
85 | } TYPE_OF_TERMINAL;\r | |
86 | \r | |
87 | typedef enum _FILE_EXPLORER_STATE {\r | |
88 | FileExplorerStateInActive = 0,\r | |
89 | FileExplorerStateBootFromFile,\r | |
90 | FileExplorerStateAddBootOption,\r | |
91 | FileExplorerStateAddDriverOptionState,\r | |
92 | FileExplorerStateUnknown\r | |
93 | } FILE_EXPLORER_STATE;\r | |
94 | \r | |
95 | typedef enum _FILE_EXPLORER_DISPLAY_CONTEXT {\r | |
96 | FileExplorerDisplayFileSystem,\r | |
97 | FileExplorerDisplayDirectory,\r | |
98 | FileExplorerDisplayUnknown\r | |
99 | } FILE_EXPLORER_DISPLAY_CONTEXT;\r | |
100 | \r | |
101 | //\r | |
102 | // All of the signatures that will be used in list structure\r | |
103 | //\r | |
104 | #define BM_MENU_OPTION_SIGNATURE SIGNATURE_32 ('m', 'e', 'n', 'u')\r | |
105 | #define BM_LOAD_OPTION_SIGNATURE SIGNATURE_32 ('l', 'o', 'a', 'd')\r | |
106 | #define BM_CONSOLE_OPTION_SIGNATURE SIGNATURE_32 ('c', 'n', 's', 'l')\r | |
107 | #define BM_FILE_OPTION_SIGNATURE SIGNATURE_32 ('f', 'i', 'l', 'e')\r | |
108 | #define BM_HANDLE_OPTION_SIGNATURE SIGNATURE_32 ('h', 'n', 'd', 'l')\r | |
109 | #define BM_TERMINAL_OPTION_SIGNATURE SIGNATURE_32 ('t', 'r', 'm', 'l')\r | |
110 | #define BM_MENU_ENTRY_SIGNATURE SIGNATURE_32 ('e', 'n', 't', 'r')\r | |
111 | \r | |
112 | #define BM_LOAD_CONTEXT_SELECT 0x0\r | |
113 | #define BM_CONSOLE_CONTEXT_SELECT 0x1\r | |
114 | #define BM_FILE_CONTEXT_SELECT 0x2\r | |
115 | #define BM_HANDLE_CONTEXT_SELECT 0x3\r | |
116 | #define BM_TERMINAL_CONTEXT_SELECT 0x5\r | |
117 | \r | |
118 | #define BM_CONSOLE_IN_CONTEXT_SELECT 0x6\r | |
119 | #define BM_CONSOLE_OUT_CONTEXT_SELECT 0x7\r | |
120 | #define BM_CONSOLE_ERR_CONTEXT_SELECT 0x8\r | |
121 | \r | |
122 | //\r | |
123 | // Buffer size for update data\r | |
124 | //\r | |
125 | #define UPDATE_DATA_SIZE 0x100000\r | |
126 | \r | |
127 | //\r | |
128 | // Namespace of callback keys used in display and file system navigation\r | |
129 | //\r | |
130 | #define MAX_BBS_OFFSET 0xE000\r | |
131 | #define NET_OPTION_OFFSET 0xD800\r | |
132 | #define BEV_OPTION_OFFSET 0xD000\r | |
133 | #define FD_OPTION_OFFSET 0xC000\r | |
134 | #define HD_OPTION_OFFSET 0xB000\r | |
135 | #define CD_OPTION_OFFSET 0xA000\r | |
136 | #define FILE_OPTION_OFFSET 0x8000\r | |
137 | #define FILE_OPTION_MASK 0x7FFF\r | |
138 | #define HANDLE_OPTION_OFFSET 0x7000\r | |
139 | #define CONSOLE_OPTION_OFFSET 0x6000\r | |
140 | #define TERMINAL_OPTION_OFFSET 0x5000\r | |
141 | #define CONFIG_OPTION_OFFSET 0x1200\r | |
142 | #define KEY_VALUE_OFFSET 0x1100\r | |
143 | #define FORM_ID_OFFSET 0x1000\r | |
144 | \r | |
145 | //\r | |
146 | // VarOffset that will be used to create question\r | |
147 | // all these values are computed from the structure\r | |
148 | // defined below\r | |
149 | //\r | |
150 | #define VAR_OFFSET(Field) ((UINT16) ((UINTN) &(((BMM_FAKE_NV_DATA *) 0)->Field)))\r | |
151 | \r | |
152 | //\r | |
153 | // Question Id of Zero is invalid, so add an offset to it\r | |
154 | //\r | |
155 | #define QUESTION_ID(Field) (VAR_OFFSET (Field) + CONFIG_OPTION_OFFSET)\r | |
156 | \r | |
157 | #define BOOT_TIME_OUT_VAR_OFFSET VAR_OFFSET (BootTimeOut)\r | |
158 | #define BOOT_NEXT_VAR_OFFSET VAR_OFFSET (BootNext)\r | |
159 | #define COM1_BAUD_RATE_VAR_OFFSET VAR_OFFSET (COM1BaudRate)\r | |
160 | #define COM1_DATA_RATE_VAR_OFFSET VAR_OFFSET (COM1DataRate)\r | |
161 | #define COM1_STOP_BITS_VAR_OFFSET VAR_OFFSET (COM1StopBits)\r | |
162 | #define COM1_PARITY_VAR_OFFSET VAR_OFFSET (COM1Parity)\r | |
163 | #define COM1_TERMINAL_VAR_OFFSET VAR_OFFSET (COM2TerminalType)\r | |
164 | #define COM2_BAUD_RATE_VAR_OFFSET VAR_OFFSET (COM2BaudRate)\r | |
165 | #define COM2_DATA_RATE_VAR_OFFSET VAR_OFFSET (COM2DataRate)\r | |
166 | #define COM2_STOP_BITS_VAR_OFFSET VAR_OFFSET (COM2StopBits)\r | |
167 | #define COM2_PARITY_VAR_OFFSET VAR_OFFSET (COM2Parity)\r | |
168 | #define COM2_TERMINAL_VAR_OFFSET VAR_OFFSET (COM2TerminalType)\r | |
169 | #define DRV_ADD_HANDLE_DESC_VAR_OFFSET VAR_OFFSET (DriverAddHandleDesc)\r | |
170 | #define DRV_ADD_ACTIVE_VAR_OFFSET VAR_OFFSET (DriverAddActive)\r | |
171 | #define DRV_ADD_RECON_VAR_OFFSET VAR_OFFSET (DriverAddForceReconnect)\r | |
172 | #define CON_IN_COM1_VAR_OFFSET VAR_OFFSET (ConsoleInputCOM1)\r | |
173 | #define CON_IN_COM2_VAR_OFFSET VAR_OFFSET (ConsoleInputCOM2)\r | |
174 | #define CON_OUT_COM1_VAR_OFFSET VAR_OFFSET (ConsoleOutputCOM1)\r | |
175 | #define CON_OUT_COM2_VAR_OFFSET VAR_OFFSET (ConsoleOutputCOM2)\r | |
176 | #define CON_ERR_COM1_VAR_OFFSET VAR_OFFSET (ConsoleErrorCOM1)\r | |
177 | #define CON_ERR_COM2_VAR_OFFSET VAR_OFFSET (ConsoleErrorCOM2)\r | |
178 | #define CON_MODE_VAR_OFFSET VAR_OFFSET (ConsoleOutMode)\r | |
179 | #define CON_DEVICE_VAR_OFFSET VAR_OFFSET (ConsoleCheck)\r | |
180 | #define BOOT_OPTION_ORDER_VAR_OFFSET VAR_OFFSET (BootOptionOrder)\r | |
181 | #define DRIVER_OPTION_ORDER_VAR_OFFSET VAR_OFFSET (DriverOptionOrder)\r | |
182 | #define BOOT_OPTION_DEL_VAR_OFFSET VAR_OFFSET (BootOptionDel)\r | |
183 | #define DRIVER_OPTION_DEL_VAR_OFFSET VAR_OFFSET (DriverOptionDel)\r | |
184 | #define DRIVER_ADD_OPTION_VAR_OFFSET VAR_OFFSET (DriverAddHandleOptionalData)\r | |
185 | #define COM_BAUD_RATE_VAR_OFFSET VAR_OFFSET (COMBaudRate)\r | |
186 | #define COM_DATA_RATE_VAR_OFFSET VAR_OFFSET (COMDataRate)\r | |
187 | #define COM_STOP_BITS_VAR_OFFSET VAR_OFFSET (COMStopBits)\r | |
188 | #define COM_PARITY_VAR_OFFSET VAR_OFFSET (COMParity)\r | |
189 | #define COM_TERMINAL_VAR_OFFSET VAR_OFFSET (COMTerminalType)\r | |
190 | \r | |
191 | #define BOOT_TIME_OUT_QUESTION_ID QUESTION_ID (BootTimeOut)\r | |
192 | #define BOOT_NEXT_QUESTION_ID QUESTION_ID (BootNext)\r | |
193 | #define COM1_BAUD_RATE_QUESTION_ID QUESTION_ID (COM1BaudRate)\r | |
194 | #define COM1_DATA_RATE_QUESTION_ID QUESTION_ID (COM1DataRate)\r | |
195 | #define COM1_STOP_BITS_QUESTION_ID QUESTION_ID (COM1StopBits)\r | |
196 | #define COM1_PARITY_QUESTION_ID QUESTION_ID (COM1Parity)\r | |
197 | #define COM1_TERMINAL_QUESTION_ID QUESTION_ID (COM2TerminalType)\r | |
198 | #define COM2_BAUD_RATE_QUESTION_ID QUESTION_ID (COM2BaudRate)\r | |
199 | #define COM2_DATA_RATE_QUESTION_ID QUESTION_ID (COM2DataRate)\r | |
200 | #define COM2_STOP_BITS_QUESTION_ID QUESTION_ID (COM2StopBits)\r | |
201 | #define COM2_PARITY_QUESTION_ID QUESTION_ID (COM2Parity)\r | |
202 | #define COM2_TERMINAL_QUESTION_ID QUESTION_ID (COM2TerminalType)\r | |
203 | #define DRV_ADD_HANDLE_DESC_QUESTION_ID QUESTION_ID (DriverAddHandleDesc)\r | |
204 | #define DRV_ADD_ACTIVE_QUESTION_ID QUESTION_ID (DriverAddActive)\r | |
205 | #define DRV_ADD_RECON_QUESTION_ID QUESTION_ID (DriverAddForceReconnect)\r | |
206 | #define CON_IN_COM1_QUESTION_ID QUESTION_ID (ConsoleInputCOM1)\r | |
207 | #define CON_IN_COM2_QUESTION_ID QUESTION_ID (ConsoleInputCOM2)\r | |
208 | #define CON_OUT_COM1_QUESTION_ID QUESTION_ID (ConsoleOutputCOM1)\r | |
209 | #define CON_OUT_COM2_QUESTION_ID QUESTION_ID (ConsoleOutputCOM2)\r | |
210 | #define CON_ERR_COM1_QUESTION_ID QUESTION_ID (ConsoleErrorCOM1)\r | |
211 | #define CON_ERR_COM2_QUESTION_ID QUESTION_ID (ConsoleErrorCOM2)\r | |
212 | #define CON_MODE_QUESTION_ID QUESTION_ID (ConsoleOutMode)\r | |
213 | #define CON_DEVICE_QUESTION_ID QUESTION_ID (ConsoleCheck)\r | |
214 | #define BOOT_OPTION_ORDER_QUESTION_ID QUESTION_ID (BootOptionOrder)\r | |
215 | #define DRIVER_OPTION_ORDER_QUESTION_ID QUESTION_ID (DriverOptionOrder)\r | |
216 | #define BOOT_OPTION_DEL_QUESTION_ID QUESTION_ID (BootOptionDel)\r | |
217 | #define DRIVER_OPTION_DEL_QUESTION_ID QUESTION_ID (DriverOptionDel)\r | |
218 | #define DRIVER_ADD_OPTION_QUESTION_ID QUESTION_ID (DriverAddHandleOptionalData)\r | |
219 | #define COM_BAUD_RATE_QUESTION_ID QUESTION_ID (COMBaudRate)\r | |
220 | #define COM_DATA_RATE_QUESTION_ID QUESTION_ID (COMDataRate)\r | |
221 | #define COM_STOP_BITS_QUESTION_ID QUESTION_ID (COMStopBits)\r | |
222 | #define COM_PARITY_QUESTION_ID QUESTION_ID (COMParity)\r | |
223 | #define COM_TERMINAL_QUESTION_ID QUESTION_ID (COMTerminalType)\r | |
224 | \r | |
225 | #define STRING_DEPOSITORY_NUMBER 8\r | |
226 | \r | |
227 | ///\r | |
228 | /// Serial Ports attributes, first one is the value for\r | |
229 | /// return from callback function, stringtoken is used to\r | |
230 | /// display the value properly\r | |
231 | ///\r | |
232 | typedef struct {\r | |
233 | UINTN Value;\r | |
234 | UINT16 StringToken;\r | |
235 | } COM_ATTR;\r | |
236 | \r | |
237 | typedef struct {\r | |
238 | UINT64 BaudRate;\r | |
239 | UINT8 DataBits;\r | |
240 | UINT8 Parity;\r | |
241 | UINT8 StopBits;\r | |
242 | \r | |
243 | UINT8 BaudRateIndex;\r | |
244 | UINT8 DataBitsIndex;\r | |
245 | UINT8 ParityIndex;\r | |
246 | UINT8 StopBitsIndex;\r | |
247 | \r | |
248 | UINT8 IsConIn;\r | |
249 | UINT8 IsConOut;\r | |
250 | UINT8 IsStdErr;\r | |
251 | UINT8 TerminalType;\r | |
252 | \r | |
253 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
254 | } BM_TERMINAL_CONTEXT;\r | |
255 | \r | |
256 | typedef struct {\r | |
257 | BOOLEAN IsBootNext;\r | |
258 | BOOLEAN LoadOptionModified;\r | |
259 | BOOLEAN Deleted;\r | |
260 | \r | |
261 | BOOLEAN IsLegacy;\r | |
262 | BOOLEAN IsActive;\r | |
263 | BOOLEAN ForceReconnect;\r | |
264 | UINTN OptionalDataSize;\r | |
265 | \r | |
266 | UINTN LoadOptionSize;\r | |
267 | UINT8 *LoadOption;\r | |
268 | \r | |
269 | UINT32 Attributes;\r | |
270 | UINT16 FilePathListLength;\r | |
271 | UINT16 *Description;\r | |
272 | EFI_DEVICE_PATH_PROTOCOL *FilePathList;\r | |
273 | UINT8 *OptionalData;\r | |
274 | \r | |
275 | UINT16 BbsIndex;\r | |
276 | } BM_LOAD_CONTEXT;\r | |
277 | \r | |
278 | typedef struct {\r | |
279 | \r | |
280 | BOOLEAN IsActive;\r | |
281 | \r | |
282 | BOOLEAN IsTerminal;\r | |
283 | \r | |
284 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
285 | } BM_CONSOLE_CONTEXT;\r | |
286 | \r | |
287 | typedef struct {\r | |
288 | UINTN Column;\r | |
289 | UINTN Row;\r | |
290 | } CONSOLE_OUT_MODE;\r | |
291 | \r | |
292 | typedef struct {\r | |
293 | EFI_HANDLE Handle;\r | |
294 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
295 | EFI_FILE_HANDLE FHandle;\r | |
296 | UINT16 *FileName;\r | |
297 | EFI_FILE_SYSTEM_VOLUME_LABEL *Info;\r | |
298 | \r | |
299 | BOOLEAN IsRoot;\r | |
300 | BOOLEAN IsDir;\r | |
301 | BOOLEAN IsRemovableMedia;\r | |
302 | BOOLEAN IsLoadFile;\r | |
303 | BOOLEAN IsBootLegacy;\r | |
304 | } BM_FILE_CONTEXT;\r | |
305 | \r | |
306 | typedef struct {\r | |
307 | EFI_HANDLE Handle;\r | |
308 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
309 | } BM_HANDLE_CONTEXT;\r | |
310 | \r | |
311 | typedef struct {\r | |
312 | UINTN Signature;\r | |
313 | LIST_ENTRY Head;\r | |
314 | UINTN MenuNumber;\r | |
315 | } BM_MENU_OPTION;\r | |
316 | \r | |
317 | typedef struct {\r | |
318 | UINTN Signature;\r | |
319 | LIST_ENTRY Link;\r | |
320 | UINTN OptionNumber;\r | |
321 | UINT16 *DisplayString;\r | |
322 | UINT16 *HelpString;\r | |
323 | EFI_STRING_ID DisplayStringToken;\r | |
324 | EFI_STRING_ID HelpStringToken;\r | |
325 | UINTN ContextSelection;\r | |
326 | VOID *VariableContext;\r | |
327 | } BM_MENU_ENTRY;\r | |
328 | \r | |
329 | typedef struct {\r | |
330 | //\r | |
331 | // Shared callback data.\r | |
332 | //\r | |
333 | UINTN Signature;\r | |
334 | \r | |
335 | BM_MENU_ENTRY *MenuEntry;\r | |
336 | BM_HANDLE_CONTEXT *HandleContext;\r | |
337 | BM_FILE_CONTEXT *FileContext;\r | |
338 | BM_LOAD_CONTEXT *LoadContext;\r | |
339 | BM_TERMINAL_CONTEXT *TerminalContext;\r | |
340 | UINTN CurrentTerminal;\r | |
341 | BBS_TYPE BbsType;\r | |
342 | \r | |
343 | //\r | |
344 | // BMM main formset callback data.\r | |
345 | //\r | |
346 | EFI_HII_HANDLE BmmHiiHandle;\r | |
347 | EFI_HANDLE BmmDriverHandle;\r | |
348 | EFI_HII_CONFIG_ACCESS_PROTOCOL BmmConfigAccess;\r | |
349 | EFI_FORM_ID BmmCurrentPageId;\r | |
350 | EFI_FORM_ID BmmPreviousPageId;\r | |
351 | BOOLEAN BmmAskSaveOrNot;\r | |
352 | BMM_FAKE_NV_DATA BmmFakeNvData;\r | |
353 | BMM_FAKE_NV_DATA BmmOldFakeNVData;\r | |
354 | \r | |
355 | //\r | |
356 | // File explorer formset callback data.\r | |
357 | //\r | |
358 | EFI_HII_HANDLE FeHiiHandle;\r | |
359 | EFI_HANDLE FeDriverHandle;\r | |
360 | EFI_HII_CONFIG_ACCESS_PROTOCOL FeConfigAccess;\r | |
361 | FILE_EXPLORER_STATE FeCurrentState;\r | |
362 | FILE_EXPLORER_DISPLAY_CONTEXT FeDisplayContext;\r | |
363 | FILE_EXPLORER_NV_DATA FeFakeNvData;\r | |
364 | } BMM_CALLBACK_DATA;\r | |
365 | \r | |
366 | typedef struct _STRING_LIST_NODE STRING_LIST_NODE;\r | |
367 | \r | |
368 | struct _STRING_LIST_NODE {\r | |
369 | EFI_STRING_ID StringToken;\r | |
370 | STRING_LIST_NODE *Next;\r | |
371 | };\r | |
372 | \r | |
373 | typedef struct _STRING_DEPOSITORY {\r | |
374 | UINTN TotalNodeNumber;\r | |
375 | STRING_LIST_NODE *CurrentNode;\r | |
376 | STRING_LIST_NODE *ListHead;\r | |
377 | } STRING_DEPOSITORY;\r | |
378 | \r | |
379 | //\r | |
380 | // #pragma pack()\r | |
381 | //\r | |
382 | // For initializing File System menu\r | |
383 | //\r | |
384 | \r | |
385 | /**\r | |
386 | This function build the FsOptionMenu list which records all\r | |
387 | available file system in the system. They includes all instances\r | |
388 | of EFI_SIMPLE_FILE_SYSTEM_PROTOCOL, all instances of EFI_LOAD_FILE_SYSTEM\r | |
389 | and all type of legacy boot device.\r | |
390 | \r | |
391 | @param CallbackData BMM context data\r | |
392 | \r | |
393 | @retval EFI_SUCCESS Success find the file system\r | |
394 | @retval EFI_OUT_OF_RESOURCES Can not create menu entry\r | |
395 | \r | |
396 | **/\r | |
397 | EFI_STATUS\r | |
398 | BOpt_FindFileSystem (\r | |
399 | IN BMM_CALLBACK_DATA *CallbackData\r | |
400 | );\r | |
401 | \r | |
402 | /**\r | |
403 | Find files under current directory\r | |
404 | All files and sub-directories in current directory\r | |
405 | will be stored in DirectoryMenu for future use.\r | |
406 | \r | |
407 | @param CallbackData The BMM context data.\r | |
408 | @param MenuEntry The Menu Entry.\r | |
409 | \r | |
410 | @retval EFI_SUCCESS Get files from current dir successfully.\r | |
411 | @return Other value if can't get files from current dir.\r | |
412 | \r | |
413 | **/\r | |
414 | EFI_STATUS\r | |
415 | BOpt_FindFiles (\r | |
416 | IN BMM_CALLBACK_DATA *CallbackData,\r | |
417 | IN BM_MENU_ENTRY *MenuEntry\r | |
418 | );\r | |
419 | \r | |
420 | /**\r | |
421 | \r | |
422 | Find drivers that will be added as Driver#### variables from handles\r | |
423 | in current system environment\r | |
424 | All valid handles in the system except those consume SimpleFs, LoadFile\r | |
425 | are stored in DriverMenu for future use.\r | |
426 | \r | |
427 | @retval EFI_SUCCESS The function complets successfully.\r | |
428 | @return Other value if failed to build the DriverMenu.\r | |
429 | \r | |
430 | **/\r | |
431 | EFI_STATUS\r | |
432 | BOpt_FindDrivers (\r | |
433 | VOID\r | |
434 | );\r | |
435 | \r | |
436 | /**\r | |
437 | \r | |
438 | Build the BootOptionMenu according to BootOrder Variable.\r | |
439 | This Routine will access the Boot#### to get EFI_LOAD_OPTION.\r | |
440 | \r | |
441 | @param CallbackData The BMM context data.\r | |
442 | \r | |
443 | @return The number of the Var Boot####.\r | |
444 | \r | |
445 | **/\r | |
446 | EFI_STATUS\r | |
447 | BOpt_GetBootOptions (\r | |
448 | IN BMM_CALLBACK_DATA *CallbackData\r | |
449 | );\r | |
450 | \r | |
451 | /**\r | |
452 | \r | |
453 | Build up all DriverOptionMenu\r | |
454 | \r | |
455 | @param CallbackData The BMM context data.\r | |
456 | \r | |
457 | @return EFI_SUCESS The functin completes successfully.\r | |
458 | @retval EFI_OUT_OF_RESOURCES Not enough memory to compete the operation.\r | |
459 | \r | |
460 | \r | |
461 | **/\r | |
462 | EFI_STATUS\r | |
463 | BOpt_GetDriverOptions (\r | |
464 | IN BMM_CALLBACK_DATA *CallbackData\r | |
465 | );\r | |
466 | \r | |
467 | /**\r | |
468 | Free resources allocated in Allocate Rountine.\r | |
469 | \r | |
470 | @param FreeMenu Menu to be freed\r | |
471 | \r | |
472 | **/\r | |
473 | VOID\r | |
474 | BOpt_FreeMenu (\r | |
475 | BM_MENU_OPTION *FreeMenu\r | |
476 | );\r | |
477 | \r | |
478 | \r | |
479 | /**\r | |
480 | \r | |
481 | Append file name to existing file name.\r | |
482 | \r | |
483 | @param Str1 The existing file name\r | |
484 | @param Str2 The file name to be appended\r | |
485 | \r | |
486 | @return Allocate a new string to hold the appended result.\r | |
487 | Caller is responsible to free the returned string.\r | |
488 | \r | |
489 | **/\r | |
490 | CHAR16*\r | |
491 | BOpt_AppendFileName (\r | |
492 | IN CHAR16 *Str1,\r | |
493 | IN CHAR16 *Str2\r | |
494 | );\r | |
495 | \r | |
496 | /**\r | |
497 | \r | |
498 | Check whether current FileName point to a valid\r | |
499 | Efi Image File.\r | |
500 | \r | |
501 | @param FileName File need to be checked.\r | |
502 | \r | |
503 | @retval TRUE Is Efi Image\r | |
504 | @retval FALSE Not a valid Efi Image\r | |
505 | \r | |
506 | **/\r | |
507 | BOOLEAN\r | |
508 | BOpt_IsEfiImageName (\r | |
509 | IN UINT16 *FileName\r | |
510 | );\r | |
511 | \r | |
512 | /**\r | |
513 | \r | |
514 | Check whether current FileName point to a valid Efi Application\r | |
515 | \r | |
516 | @param Dir Pointer to current Directory\r | |
517 | @param FileName Pointer to current File name.\r | |
518 | \r | |
519 | @retval TRUE Is a valid Efi Application\r | |
520 | @retval FALSE not a valid Efi Application\r | |
521 | \r | |
522 | **/\r | |
523 | BOOLEAN\r | |
524 | BOpt_IsEfiApp (\r | |
525 | IN EFI_FILE_HANDLE Dir,\r | |
526 | IN UINT16 *FileName\r | |
527 | );\r | |
528 | \r | |
529 | /**\r | |
530 | \r | |
531 | Get the Option Number that has not been allocated for use.\r | |
532 | \r | |
533 | @param Type The type of Option.\r | |
534 | \r | |
535 | @return The available Option Number.\r | |
536 | \r | |
537 | **/\r | |
538 | UINT16\r | |
539 | BOpt_GetOptionNumber (\r | |
540 | CHAR16 *Type\r | |
541 | );\r | |
542 | \r | |
543 | /**\r | |
544 | \r | |
545 | Get the Option Number for Boot#### that does not used.\r | |
546 | \r | |
547 | @return The available Option Number.\r | |
548 | \r | |
549 | **/\r | |
550 | UINT16\r | |
551 | BOpt_GetBootOptionNumber (\r | |
552 | VOID\r | |
553 | );\r | |
554 | \r | |
555 | /**\r | |
556 | \r | |
557 | Get the Option Number for Driver#### that does not used.\r | |
558 | \r | |
559 | @return The unused Option Number.\r | |
560 | \r | |
561 | **/\r | |
562 | UINT16\r | |
563 | BOpt_GetDriverOptionNumber (\r | |
564 | VOID\r | |
565 | );\r | |
566 | \r | |
567 | /**\r | |
568 | Create a menu entry give a Menu type.\r | |
569 | \r | |
570 | @param MenuType The Menu type to be created.\r | |
571 | \r | |
572 | \r | |
573 | @retval NULL If failed to create the menu.\r | |
574 | @return The menu.\r | |
575 | \r | |
576 | **/\r | |
577 | BM_MENU_ENTRY *\r | |
578 | BOpt_CreateMenuEntry (\r | |
579 | UINTN MenuType\r | |
580 | );\r | |
581 | \r | |
582 | /**\r | |
583 | Free up all resource allocated for a BM_MENU_ENTRY.\r | |
584 | \r | |
585 | @param MenuEntry A pointer to BM_MENU_ENTRY.\r | |
586 | \r | |
587 | **/\r | |
588 | VOID\r | |
589 | BOpt_DestroyMenuEntry (\r | |
590 | BM_MENU_ENTRY *MenuEntry\r | |
591 | );\r | |
592 | \r | |
593 | /**\r | |
594 | Get the Menu Entry from the list in Menu Entry List.\r | |
595 | \r | |
596 | If MenuNumber is great or equal to the number of Menu\r | |
597 | Entry in the list, then ASSERT.\r | |
598 | \r | |
599 | @param MenuOption The Menu Entry List to read the menu entry.\r | |
600 | @param MenuNumber The index of Menu Entry.\r | |
601 | \r | |
602 | @return The Menu Entry.\r | |
603 | \r | |
604 | **/\r | |
605 | BM_MENU_ENTRY *\r | |
606 | BOpt_GetMenuEntry (\r | |
607 | BM_MENU_OPTION *MenuOption,\r | |
608 | UINTN MenuNumber\r | |
609 | );\r | |
610 | \r | |
611 | /**\r | |
612 | Get option number according to Boot#### and BootOrder variable. \r | |
613 | The value is saved as #### + 1.\r | |
614 | \r | |
615 | @param CallbackData The BMM context data.\r | |
616 | **/\r | |
617 | VOID \r | |
618 | GetBootOrder (\r | |
619 | IN BMM_CALLBACK_DATA *CallbackData\r | |
620 | );\r | |
621 | \r | |
622 | /**\r | |
623 | Get driver option order from globalc DriverOptionMenu.\r | |
624 | \r | |
625 | @param CallbackData The BMM context data.\r | |
626 | \r | |
627 | **/\r | |
628 | VOID \r | |
629 | GetDriverOrder (\r | |
630 | IN BMM_CALLBACK_DATA *CallbackData\r | |
631 | );\r | |
632 | \r | |
633 | //\r | |
634 | // Locate all serial io devices for console\r | |
635 | //\r | |
636 | /**\r | |
637 | Build a list containing all serial devices.\r | |
638 | \r | |
639 | @retval EFI_SUCCESS The function complete successfully.\r | |
640 | @retval EFI_UNSUPPORTED No serial ports present.\r | |
641 | \r | |
642 | **/\r | |
643 | EFI_STATUS\r | |
644 | LocateSerialIo (\r | |
645 | VOID\r | |
646 | );\r | |
647 | \r | |
648 | //\r | |
649 | // Initializing Console menu\r | |
650 | //\r | |
651 | /**\r | |
652 | Build up ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu\r | |
653 | \r | |
654 | @retval EFI_SUCCESS The function always complete successfully.\r | |
655 | \r | |
656 | **/\r | |
657 | EFI_STATUS\r | |
658 | GetAllConsoles(\r | |
659 | VOID\r | |
660 | );\r | |
661 | \r | |
662 | //\r | |
663 | // Get current mode information\r | |
664 | //\r | |
665 | /**\r | |
666 | Get mode number according to column and row\r | |
667 | \r | |
668 | @param CallbackData The BMM context data.\r | |
669 | **/\r | |
670 | VOID\r | |
671 | GetConsoleOutMode (\r | |
672 | IN BMM_CALLBACK_DATA *CallbackData\r | |
673 | );\r | |
674 | \r | |
675 | //\r | |
676 | // Cleaning up console menu\r | |
677 | //\r | |
678 | /**\r | |
679 | Free ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu\r | |
680 | \r | |
681 | @retval EFI_SUCCESS The function always complete successfully.\r | |
682 | **/\r | |
683 | EFI_STATUS\r | |
684 | FreeAllConsoles (\r | |
685 | VOID\r | |
686 | );\r | |
687 | \r | |
688 | /**\r | |
689 | Update the device path that describing a terminal device\r | |
690 | based on the new BaudRate, Data Bits, parity and Stop Bits\r | |
691 | set.\r | |
692 | \r | |
693 | @param DevicePath The devicepath protocol instance wanted to be updated.\r | |
694 | \r | |
695 | **/\r | |
696 | VOID\r | |
697 | ChangeVariableDevicePath (\r | |
698 | IN OUT EFI_DEVICE_PATH_PROTOCOL *DevicePath\r | |
699 | );\r | |
700 | \r | |
701 | /**\r | |
702 | Update the multi-instance device path of Terminal Device based on\r | |
703 | the global TerminalMenu. If ChangeTernimal is TRUE, the terminal \r | |
704 | device path in the Terminal Device in TerminalMenu is also updated.\r | |
705 | \r | |
706 | @param DevicePath The multi-instance device path.\r | |
707 | @param ChangeTerminal TRUE, then device path in the Terminal Device \r | |
708 | in TerminalMenu is also updated; FALSE, no update.\r | |
709 | \r | |
710 | @return EFI_SUCCESS The function completes successfully.\r | |
711 | \r | |
712 | **/\r | |
713 | EFI_STATUS\r | |
714 | ChangeTerminalDevicePath (\r | |
715 | IN OUT EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
716 | IN BOOLEAN ChangeTerminal\r | |
717 | );\r | |
718 | \r | |
719 | //\r | |
720 | // Variable operation by menu selection\r | |
721 | //\r | |
722 | /**\r | |
723 | This function create a currently loaded Boot Option from \r | |
724 | the BMM. It then appends this Boot Option to the end of \r | |
725 | the "BootOrder" list. It also append this Boot Opotion to the end\r | |
726 | of BootOptionMenu.\r | |
727 | \r | |
728 | @param CallbackData The BMM context data.\r | |
729 | @param NvRamMap The file explorer formset internal state.\r | |
730 | \r | |
731 | @retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.\r | |
732 | @retval EFI_SUCCESS If function completes successfully.\r | |
733 | \r | |
734 | **/\r | |
735 | EFI_STATUS\r | |
736 | Var_UpdateBootOption (\r | |
737 | IN BMM_CALLBACK_DATA *CallbackData,\r | |
738 | IN FILE_EXPLORER_NV_DATA *NvRamMap\r | |
739 | );\r | |
740 | \r | |
741 | /**\r | |
742 | Delete Boot Option that represent a Deleted state in BootOptionMenu.\r | |
743 | After deleting this boot option, call Var_ChangeBootOrder to\r | |
744 | make sure BootOrder is in valid state.\r | |
745 | \r | |
746 | @retval EFI_SUCCESS If all boot load option EFI Variables corresponding to \r | |
747 | BM_LOAD_CONTEXT marked for deletion is deleted\r | |
748 | @return Others If failed to update the "BootOrder" variable after deletion. \r | |
749 | \r | |
750 | **/\r | |
751 | EFI_STATUS\r | |
752 | Var_DelBootOption (\r | |
753 | VOID\r | |
754 | );\r | |
755 | \r | |
756 | /**\r | |
757 | After any operation on Boot####, there will be a discrepancy in BootOrder.\r | |
758 | Since some are missing but in BootOrder, while some are present but are\r | |
759 | not reflected by BootOrder. Then a function rebuild BootOrder from\r | |
760 | scratch by content from BootOptionMenu is needed.\r | |
761 | \r | |
762 | @retval EFI_SUCCESS The boot order is updated successfully.\r | |
763 | @return other than EFI_SUCCESS if failed to change the "BootOrder" EFI Variable.\r | |
764 | \r | |
765 | **/\r | |
766 | EFI_STATUS\r | |
767 | Var_ChangeBootOrder (\r | |
768 | VOID\r | |
769 | );\r | |
770 | \r | |
771 | /**\r | |
772 | This function create a currently loaded Drive Option from \r | |
773 | the BMM. It then appends this Driver Option to the end of \r | |
774 | the "DriverOrder" list. It append this Driver Opotion to the end\r | |
775 | of DriverOptionMenu.\r | |
776 | \r | |
777 | @param CallbackData The BMM context data.\r | |
778 | @param HiiHandle The HII handle associated with the BMM formset.\r | |
779 | @param DescriptionData The description of this driver option.\r | |
780 | @param OptionalData The optional load option.\r | |
781 | @param ForceReconnect If to force reconnect.\r | |
782 | \r | |
783 | @retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.\r | |
784 | @retval EFI_SUCCESS If function completes successfully.\r | |
785 | \r | |
786 | **/\r | |
787 | EFI_STATUS\r | |
788 | Var_UpdateDriverOption (\r | |
789 | IN BMM_CALLBACK_DATA *CallbackData,\r | |
790 | IN EFI_HII_HANDLE HiiHandle,\r | |
791 | IN UINT16 *DescriptionData,\r | |
792 | IN UINT16 *OptionalData,\r | |
793 | IN UINT8 ForceReconnect\r | |
794 | );\r | |
795 | \r | |
796 | /**\r | |
797 | Delete Load Option that represent a Deleted state in BootOptionMenu.\r | |
798 | After deleting this Driver option, call Var_ChangeDriverOrder to\r | |
799 | make sure DriverOrder is in valid state.\r | |
800 | \r | |
801 | @retval EFI_SUCCESS Load Option is successfully updated.\r | |
802 | @return Other value than EFI_SUCCESS if failed to update "Driver Order" EFI\r | |
803 | Variable.\r | |
804 | \r | |
805 | **/\r | |
806 | EFI_STATUS\r | |
807 | Var_DelDriverOption (\r | |
808 | VOID\r | |
809 | );\r | |
810 | \r | |
811 | /**\r | |
812 | After any operation on Driver####, there will be a discrepancy in\r | |
813 | DriverOrder. Since some are missing but in DriverOrder, while some\r | |
814 | are present but are not reflected by DriverOrder. Then a function\r | |
815 | rebuild DriverOrder from scratch by content from DriverOptionMenu is\r | |
816 | needed.\r | |
817 | \r | |
818 | @retval EFI_SUCCESS The driver order is updated successfully.\r | |
819 | @return other than EFI_SUCCESS if failed to set the "DriverOrder" EFI Variable.\r | |
820 | \r | |
821 | **/\r | |
822 | EFI_STATUS\r | |
823 | Var_ChangeDriverOrder (\r | |
824 | VOID\r | |
825 | );\r | |
826 | \r | |
827 | /**\r | |
828 | This function delete and build multi-instance device path ConIn\r | |
829 | console device.\r | |
830 | \r | |
831 | @retval EFI_SUCCESS The function complete successfully.\r | |
832 | @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.\r | |
833 | **/\r | |
834 | EFI_STATUS\r | |
835 | Var_UpdateConsoleInpOption (\r | |
836 | VOID\r | |
837 | );\r | |
838 | \r | |
839 | /**\r | |
840 | This function delete and build multi-instance device path ConOut console device.\r | |
841 | \r | |
842 | @retval EFI_SUCCESS The function complete successfully.\r | |
843 | @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.\r | |
844 | **/\r | |
845 | EFI_STATUS\r | |
846 | Var_UpdateConsoleOutOption (\r | |
847 | VOID\r | |
848 | );\r | |
849 | \r | |
850 | /**\r | |
851 | This function delete and build multi-instance device path ErrOut console device.\r | |
852 | \r | |
853 | @retval EFI_SUCCESS The function complete successfully.\r | |
854 | @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.\r | |
855 | **/\r | |
856 | EFI_STATUS\r | |
857 | Var_UpdateErrorOutOption (\r | |
858 | VOID\r | |
859 | );\r | |
860 | \r | |
861 | /**\r | |
862 | This function delete and build Out of Band console device.\r | |
863 | \r | |
864 | @param MenuIndex Menu index which user select in the terminal menu list.\r | |
865 | \r | |
866 | @retval EFI_SUCCESS The function complete successfully.\r | |
867 | @return The EFI variable can not be saved. See gRT->SetVariable for detail return information. \r | |
868 | **/\r | |
869 | EFI_STATUS\r | |
870 | Var_UpdateOutOfBandOption (\r | |
871 | IN UINT16 MenuIndex\r | |
872 | );\r | |
873 | \r | |
874 | /**\r | |
875 | Update the device path of "ConOut", "ConIn" and "ErrOut" based on the new BaudRate, Data Bits, \r | |
876 | parity and stop Bits set.\r | |
877 | \r | |
878 | **/\r | |
879 | VOID\r | |
880 | Var_UpdateAllConsoleOption (\r | |
881 | VOID\r | |
882 | );\r | |
883 | \r | |
884 | /**\r | |
885 | This function update the "BootNext" EFI Variable. If there is no "BootNex" specified in BMM, \r | |
886 | this EFI Variable is deleted.\r | |
887 | It also update the BMM context data specified the "BootNext" value.\r | |
888 | \r | |
889 | @param CallbackData The BMM context data.\r | |
890 | \r | |
891 | @retval EFI_SUCCESS The function complete successfully.\r | |
892 | @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.\r | |
893 | \r | |
894 | **/\r | |
895 | EFI_STATUS\r | |
896 | Var_UpdateBootNext (\r | |
897 | IN BMM_CALLBACK_DATA *CallbackData\r | |
898 | );\r | |
899 | \r | |
900 | /**\r | |
901 | This function update the "BootOrder" EFI Variable based on BMM Formset's NV map. It then refresh \r | |
902 | BootOptionMenu with the new "BootOrder" list.\r | |
903 | \r | |
904 | @param CallbackData The BMM context data.\r | |
905 | \r | |
906 | @retval EFI_SUCCESS The function complete successfully.\r | |
907 | @retval EFI_OUT_OF_RESOURCES Not enough memory to complete the function.\r | |
908 | @return not The EFI variable can not be saved. See gRT->SetVariable for detail return information.\r | |
909 | \r | |
910 | **/\r | |
911 | EFI_STATUS\r | |
912 | Var_UpdateBootOrder (\r | |
913 | IN BMM_CALLBACK_DATA *CallbackData\r | |
914 | );\r | |
915 | \r | |
916 | /**\r | |
917 | This function update the "DriverOrder" EFI Variable based on\r | |
918 | BMM Formset's NV map. It then refresh DriverOptionMenu\r | |
919 | with the new "DriverOrder" list.\r | |
920 | \r | |
921 | @param CallbackData The BMM context data.\r | |
922 | \r | |
923 | @retval EFI_SUCCESS The function complete successfully.\r | |
924 | @retval EFI_OUT_OF_RESOURCES Not enough memory to complete the function.\r | |
925 | @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.\r | |
926 | \r | |
927 | **/\r | |
928 | EFI_STATUS\r | |
929 | Var_UpdateDriverOrder (\r | |
930 | IN BMM_CALLBACK_DATA *CallbackData\r | |
931 | );\r | |
932 | \r | |
933 | /**\r | |
934 | Update the Text Mode of Console.\r | |
935 | \r | |
936 | @param CallbackData The context data for BMM.\r | |
937 | \r | |
938 | @retval EFI_SUCCSS If the Text Mode of Console is updated.\r | |
939 | @return Other value if the Text Mode of Console is not updated.\r | |
940 | \r | |
941 | **/\r | |
942 | EFI_STATUS\r | |
943 | Var_UpdateConMode (\r | |
944 | IN BMM_CALLBACK_DATA *CallbackData\r | |
945 | );\r | |
946 | \r | |
947 | //\r | |
948 | // Following are page create and refresh functions\r | |
949 | //\r | |
950 | /**\r | |
951 | Refresh the global UpdateData structure.\r | |
952 | \r | |
953 | **/\r | |
954 | VOID\r | |
955 | RefreshUpdateData (\r | |
956 | VOID\r | |
957 | );\r | |
958 | \r | |
959 | /**\r | |
960 | Clean up the dynamic opcode at label and form specified by\r | |
961 | both LabelId. \r | |
962 | \r | |
963 | @param LabelId It is both the Form ID and Label ID for\r | |
964 | opcode deletion.\r | |
965 | @param CallbackData The BMM context data.\r | |
966 | \r | |
967 | **/\r | |
968 | VOID\r | |
969 | CleanUpPage (\r | |
970 | IN UINT16 LabelId,\r | |
971 | IN BMM_CALLBACK_DATA *CallbackData\r | |
972 | );\r | |
973 | \r | |
974 | /**\r | |
975 | Create a lit of boot option from global BootOptionMenu. It\r | |
976 | allow user to delete the boot option.\r | |
977 | \r | |
978 | @param CallbackData The BMM context data.\r | |
979 | \r | |
980 | **/\r | |
981 | VOID\r | |
982 | UpdateBootDelPage (\r | |
983 | IN BMM_CALLBACK_DATA *CallbackData\r | |
984 | );\r | |
985 | \r | |
986 | /**\r | |
987 | Create a lit of driver option from global DriverMenu.\r | |
988 | \r | |
989 | @param CallbackData The BMM context data.\r | |
990 | **/\r | |
991 | VOID\r | |
992 | UpdateDrvAddHandlePage (\r | |
993 | IN BMM_CALLBACK_DATA *CallbackData\r | |
994 | );\r | |
995 | \r | |
996 | /**\r | |
997 | Create a lit of driver option from global DriverOptionMenu. It\r | |
998 | allow user to delete the driver option.\r | |
999 | \r | |
1000 | @param CallbackData The BMM context data.\r | |
1001 | **/\r | |
1002 | VOID\r | |
1003 | UpdateDrvDelPage (\r | |
1004 | IN BMM_CALLBACK_DATA *CallbackData\r | |
1005 | );\r | |
1006 | \r | |
1007 | /**\r | |
1008 | Prepare the page to allow user to add description for a Driver Option.\r | |
1009 | \r | |
1010 | @param CallbackData The BMM context data.\r | |
1011 | **/\r | |
1012 | VOID\r | |
1013 | UpdateDriverAddHandleDescPage (\r | |
1014 | IN BMM_CALLBACK_DATA *CallbackData\r | |
1015 | );\r | |
1016 | \r | |
1017 | /**\r | |
1018 | Dispatch the correct update page function to call based on the UpdatePageId.\r | |
1019 | \r | |
1020 | @param UpdatePageId The form ID.\r | |
1021 | @param CallbackData The BMM context data.\r | |
1022 | **/\r | |
1023 | VOID\r | |
1024 | UpdatePageBody (\r | |
1025 | IN UINT16 UpdatePageId,\r | |
1026 | IN BMM_CALLBACK_DATA *CallbackData\r | |
1027 | );\r | |
1028 | \r | |
1029 | /**\r | |
1030 | Create the dynamic page to allow user to set the "BootNext" vaule.\r | |
1031 | \r | |
1032 | @param CallbackData The BMM context data.\r | |
1033 | **/\r | |
1034 | VOID\r | |
1035 | UpdateBootNextPage (\r | |
1036 | IN BMM_CALLBACK_DATA *CallbackData\r | |
1037 | );\r | |
1038 | \r | |
1039 | /**\r | |
1040 | Create the dynamic page to allow user to set the "TimeOut" vaule.\r | |
1041 | \r | |
1042 | @param CallbackData The BMM context data.\r | |
1043 | **/\r | |
1044 | VOID\r | |
1045 | UpdateTimeOutPage (\r | |
1046 | IN BMM_CALLBACK_DATA *CallbackData\r | |
1047 | );\r | |
1048 | \r | |
1049 | /**\r | |
1050 | Create the dynamic page which allows user to set the property such as Baud Rate, Data Bits,\r | |
1051 | Parity, Stop Bits, Terminal Type.\r | |
1052 | \r | |
1053 | @param CallbackData The BMM context data.\r | |
1054 | **/\r | |
1055 | VOID\r | |
1056 | UpdateTerminalPage (\r | |
1057 | IN BMM_CALLBACK_DATA *CallbackData\r | |
1058 | );\r | |
1059 | \r | |
1060 | /**\r | |
1061 | Refresh the text mode page\r | |
1062 | \r | |
1063 | @param CallbackData The BMM context data.\r | |
1064 | **/\r | |
1065 | VOID\r | |
1066 | UpdateConModePage (\r | |
1067 | IN BMM_CALLBACK_DATA *CallbackData\r | |
1068 | );\r | |
1069 | \r | |
1070 | /**\r | |
1071 | Create a list of Goto Opcode for all terminal devices logged\r | |
1072 | by TerminaMenu. This list will be inserted to form FORM_CON_COM_SETUP_ID.\r | |
1073 | \r | |
1074 | @param CallbackData The BMM context data.\r | |
1075 | **/\r | |
1076 | VOID\r | |
1077 | UpdateConCOMPage (\r | |
1078 | IN BMM_CALLBACK_DATA *CallbackData\r | |
1079 | );\r | |
1080 | \r | |
1081 | /**\r | |
1082 | Function opens and returns a file handle to the root directory of a volume.\r | |
1083 | \r | |
1084 | @param DeviceHandle A handle for a device\r | |
1085 | @return A valid file handle or NULL is returned\r | |
1086 | **/\r | |
1087 | EFI_FILE_HANDLE\r | |
1088 | EfiLibOpenRoot (\r | |
1089 | IN EFI_HANDLE DeviceHandle\r | |
1090 | );\r | |
1091 | \r | |
1092 | /**\r | |
1093 | Function gets the file system information from an open file descriptor,\r | |
1094 | and stores it in a buffer allocated from pool.\r | |
1095 | \r | |
1096 | @param FHand The file handle.\r | |
1097 | \r | |
1098 | @return A pointer to a buffer with file information.\r | |
1099 | NULL is returned if failed to get Vaolume Label Info.\r | |
1100 | **/\r | |
1101 | EFI_FILE_SYSTEM_VOLUME_LABEL *\r | |
1102 | EfiLibFileSystemVolumeLabelInfo (\r | |
1103 | IN EFI_FILE_HANDLE FHand\r | |
1104 | );\r | |
1105 | \r | |
1106 | /**\r | |
1107 | \r | |
1108 | Function gets the file information from an open file descriptor, and stores it\r | |
1109 | in a buffer allocated from pool.\r | |
1110 | \r | |
1111 | @param FHand File Handle.\r | |
1112 | \r | |
1113 | @return A pointer to a buffer with file information or NULL is returned\r | |
1114 | \r | |
1115 | **/\r | |
1116 | EFI_FILE_INFO *\r | |
1117 | EfiLibFileInfo (\r | |
1118 | IN EFI_FILE_HANDLE FHand\r | |
1119 | );\r | |
1120 | \r | |
1121 | /**\r | |
1122 | Find the first instance of this Protocol in the system and return it's interface.\r | |
1123 | \r | |
1124 | @param ProtocolGuid Provides the protocol to search for\r | |
1125 | @param Interface On return, a pointer to the first interface\r | |
1126 | that matches ProtocolGuid\r | |
1127 | \r | |
1128 | @retval EFI_SUCCESS A protocol instance matching ProtocolGuid was found\r | |
1129 | @retval EFI_NOT_FOUND No protocol instances were found that match ProtocolGuid\r | |
1130 | \r | |
1131 | **/\r | |
1132 | EFI_STATUS\r | |
1133 | EfiLibLocateProtocol (\r | |
1134 | IN EFI_GUID *ProtocolGuid,\r | |
1135 | OUT VOID **Interface\r | |
1136 | );\r | |
1137 | \r | |
1138 | /**\r | |
1139 | Adjusts the size of a previously allocated buffer.\r | |
1140 | \r | |
1141 | @param OldPool A pointer to the buffer whose size is being adjusted.\r | |
1142 | @param OldSize The size of the current buffer.\r | |
1143 | @param NewSize The size of the new buffer.\r | |
1144 | \r | |
1145 | @return The newly allocated buffer. if NULL, allocation failed.\r | |
1146 | \r | |
1147 | **/\r | |
1148 | VOID*\r | |
1149 | EfiReallocatePool (\r | |
1150 | IN VOID *OldPool,\r | |
1151 | IN UINTN OldSize,\r | |
1152 | IN UINTN NewSize\r | |
1153 | );\r | |
1154 | \r | |
1155 | /**\r | |
1156 | Function deletes the variable specified by VarName and VarGuid.\r | |
1157 | \r | |
1158 | \r | |
1159 | @param VarName A Null-terminated Unicode string that is\r | |
1160 | the name of the vendor's variable.\r | |
1161 | \r | |
1162 | @param VarGuid A unique identifier for the vendor.\r | |
1163 | \r | |
1164 | @retval EFI_SUCCESS The variable was found and removed\r | |
1165 | @retval EFI_UNSUPPORTED The variable store was inaccessible\r | |
1166 | @retval EFI_OUT_OF_RESOURCES The temporary buffer was not available\r | |
1167 | @retval EFI_NOT_FOUND The variable was not found\r | |
1168 | \r | |
1169 | **/\r | |
1170 | EFI_STATUS\r | |
1171 | EfiLibDeleteVariable (\r | |
1172 | IN CHAR16 *VarName,\r | |
1173 | IN EFI_GUID *VarGuid\r | |
1174 | );\r | |
1175 | \r | |
1176 | /**\r | |
1177 | Duplicate a string.\r | |
1178 | \r | |
1179 | @param Src The source.\r | |
1180 | \r | |
1181 | @return A new string which is duplicated copy of the source.\r | |
1182 | @retval NULL If there is not enough memory.\r | |
1183 | \r | |
1184 | **/\r | |
1185 | CHAR16 *\r | |
1186 | EfiStrDuplicate (\r | |
1187 | IN CHAR16 *Src\r | |
1188 | );\r | |
1189 | \r | |
1190 | /**\r | |
1191 | Function is used to determine the number of device path instances\r | |
1192 | that exist in a device path.\r | |
1193 | \r | |
1194 | \r | |
1195 | @param DevicePath A pointer to a device path data structure.\r | |
1196 | \r | |
1197 | @return This function counts and returns the number of device path instances\r | |
1198 | in DevicePath.\r | |
1199 | \r | |
1200 | **/\r | |
1201 | UINTN\r | |
1202 | EfiDevicePathInstanceCount (\r | |
1203 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r | |
1204 | );\r | |
1205 | \r | |
1206 | /**\r | |
1207 | Create string tokens for a menu from its help strings and display strings\r | |
1208 | \r | |
1209 | \r | |
1210 | @param CallbackData The BMM context data.\r | |
1211 | @param HiiHandle Hii Handle of the package to be updated.\r | |
1212 | @param MenuOption The Menu whose string tokens need to be created\r | |
1213 | \r | |
1214 | @retval EFI_SUCCESS string tokens created successfully\r | |
1215 | @retval others contain some errors\r | |
1216 | \r | |
1217 | **/\r | |
1218 | EFI_STATUS\r | |
1219 | CreateMenuStringToken (\r | |
1220 | IN BMM_CALLBACK_DATA *CallbackData,\r | |
1221 | IN EFI_HII_HANDLE HiiHandle,\r | |
1222 | IN BM_MENU_OPTION *MenuOption\r | |
1223 | );\r | |
1224 | \r | |
1225 | /**\r | |
1226 | Get a string from the Data Hub record based on \r | |
1227 | a device path.\r | |
1228 | \r | |
1229 | @param DevPath The device Path.\r | |
1230 | \r | |
1231 | @return A string located from the Data Hub records based on\r | |
1232 | the device path.\r | |
1233 | @retval NULL If failed to get the String from Data Hub.\r | |
1234 | \r | |
1235 | **/\r | |
1236 | UINT16 *\r | |
1237 | EfiLibStrFromDatahub (\r | |
1238 | IN EFI_DEVICE_PATH_PROTOCOL *DevPath\r | |
1239 | );\r | |
1240 | \r | |
1241 | /**\r | |
1242 | Get the index number (#### in Boot####) for the boot option pointed to a BBS legacy device type\r | |
1243 | specified by DeviceType.\r | |
1244 | \r | |
1245 | @param DeviceType The legacy device type. It can be floppy, network, harddisk, cdrom,\r | |
1246 | etc.\r | |
1247 | @param OptionIndex Returns the index number (#### in Boot####).\r | |
1248 | @param OptionSize Return the size of the Boot### variable.\r | |
1249 | \r | |
1250 | **/\r | |
1251 | VOID *\r | |
1252 | GetLegacyBootOptionVar (\r | |
1253 | IN UINTN DeviceType,\r | |
1254 | OUT UINTN *OptionIndex,\r | |
1255 | OUT UINTN *OptionSize\r | |
1256 | );\r | |
1257 | \r | |
1258 | /**\r | |
1259 | Initialize the Boot Maintenance Utitliy.\r | |
1260 | \r | |
1261 | **/\r | |
1262 | VOID\r | |
1263 | InitializeBM (\r | |
1264 | VOID\r | |
1265 | );\r | |
1266 | \r | |
1267 | \r | |
1268 | /**\r | |
1269 | Intialize all the string depositories.\r | |
1270 | \r | |
1271 | **/\r | |
1272 | VOID\r | |
1273 | InitializeStringDepository (\r | |
1274 | VOID\r | |
1275 | );\r | |
1276 | \r | |
1277 | /**\r | |
1278 | Fetch a usable string node from the string depository and return the string token.\r | |
1279 | \r | |
1280 | \r | |
1281 | @param CallbackData The BMM context data.\r | |
1282 | @param StringDepository Pointer of the string depository.\r | |
1283 | \r | |
1284 | @retval EFI_STRING_ID String token.\r | |
1285 | \r | |
1286 | **/\r | |
1287 | EFI_STRING_ID\r | |
1288 | GetStringTokenFromDepository (\r | |
1289 | IN BMM_CALLBACK_DATA *CallbackData,\r | |
1290 | IN STRING_DEPOSITORY *StringDepository\r | |
1291 | );\r | |
1292 | \r | |
1293 | /**\r | |
1294 | Reclaim string depositories by moving the current node pointer to list head..\r | |
1295 | **/\r | |
1296 | VOID\r | |
1297 | ReclaimStringDepository (\r | |
1298 | VOID\r | |
1299 | );\r | |
1300 | \r | |
1301 | /**\r | |
1302 | Release resource for all the string depositories.\r | |
1303 | \r | |
1304 | **/\r | |
1305 | VOID\r | |
1306 | CleanUpStringDepository (\r | |
1307 | VOID\r | |
1308 | );\r | |
1309 | \r | |
1310 | /**\r | |
1311 | Function handling request to apply changes for BMM pages.\r | |
1312 | \r | |
1313 | @param Private Pointer to callback data buffer.\r | |
1314 | @param CurrentFakeNVMap Pointer to buffer holding data of various values used by BMM\r | |
1315 | @param FormId ID of the form which has sent the request to apply change.\r | |
1316 | \r | |
1317 | @retval EFI_SUCCESS Change successfully applied.\r | |
1318 | @retval Other Error occurs while trying to apply changes.\r | |
1319 | \r | |
1320 | **/\r | |
1321 | EFI_STATUS\r | |
1322 | ApplyChangeHandler (\r | |
1323 | IN BMM_CALLBACK_DATA *Private,\r | |
1324 | IN BMM_FAKE_NV_DATA *CurrentFakeNVMap,\r | |
1325 | IN EFI_FORM_ID FormId\r | |
1326 | );\r | |
1327 | \r | |
1328 | /**\r | |
1329 | Discard all changes done to the BMM pages such as Boot Order change,\r | |
1330 | Driver order change.\r | |
1331 | \r | |
1332 | @param Private The BMM context data.\r | |
1333 | @param CurrentFakeNVMap The current Fack NV Map.\r | |
1334 | \r | |
1335 | **/\r | |
1336 | VOID\r | |
1337 | DiscardChangeHandler (\r | |
1338 | IN BMM_CALLBACK_DATA *Private,\r | |
1339 | IN BMM_FAKE_NV_DATA *CurrentFakeNVMap\r | |
1340 | );\r | |
1341 | \r | |
1342 | /**\r | |
1343 | Dispatch the display to the next page based on NewPageId.\r | |
1344 | \r | |
1345 | @param Private The BMM context data.\r | |
1346 | @param NewPageId The original page ID.\r | |
1347 | \r | |
1348 | **/\r | |
1349 | VOID\r | |
1350 | UpdatePageId (\r | |
1351 | BMM_CALLBACK_DATA *Private,\r | |
1352 | UINT16 NewPageId\r | |
1353 | );\r | |
1354 | \r | |
1355 | /**\r | |
1356 | Boot a file selected by user at File Expoloer of BMM.\r | |
1357 | \r | |
1358 | @param FileContext The file context data, which contains the device path\r | |
1359 | of the file to be boot from.\r | |
1360 | \r | |
1361 | @retval EFI_SUCCESS The function completed successfull.\r | |
1362 | @return Other value if the boot from the file fails.\r | |
1363 | \r | |
1364 | **/\r | |
1365 | EFI_STATUS\r | |
1366 | BootThisFile (\r | |
1367 | IN BM_FILE_CONTEXT *FileContext\r | |
1368 | );\r | |
1369 | \r | |
1370 | /**\r | |
1371 | Update the file explower page with the refershed file system.\r | |
1372 | \r | |
1373 | \r | |
1374 | @param CallbackData BMM context data\r | |
1375 | @param KeyValue Key value to identify the type of data to expect.\r | |
1376 | \r | |
1377 | @retval TRUE Inform the caller to create a callback packet to exit file explorer.\r | |
1378 | @retval FALSE Indicate that there is no need to exit file explorer.\r | |
1379 | \r | |
1380 | **/\r | |
1381 | BOOLEAN\r | |
1382 | UpdateFileExplorer (\r | |
1383 | IN BMM_CALLBACK_DATA *CallbackData,\r | |
1384 | IN UINT16 KeyValue\r | |
1385 | );\r | |
1386 | \r | |
1387 | /**\r | |
1388 | This function processes the results of changes in configuration.\r | |
1389 | When user select a interactive opcode, this callback will be triggered.\r | |
1390 | Based on the Question(QuestionId) that triggers the callback, the corresponding\r | |
1391 | actions is performed. It handles:\r | |
1392 | \r | |
1393 | 1) the addition of boot option.\r | |
1394 | 2) the addition of driver option.\r | |
1395 | 3) exit from file browser\r | |
1396 | 4) update of file content if a dir is selected.\r | |
1397 | 5) boot the file if a file is selected in "boot from file"\r | |
1398 | \r | |
1399 | \r | |
1400 | @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r | |
1401 | @param Action Specifies the type of action taken by the browser.\r | |
1402 | @param QuestionId A unique value which is sent to the original exporting driver\r | |
1403 | so that it can identify the type of data to expect.\r | |
1404 | @param Type The type of value for the question.\r | |
1405 | @param Value A pointer to the data being sent to the original exporting driver.\r | |
1406 | @param ActionRequest On return, points to the action requested by the callback function.\r | |
1407 | \r | |
1408 | @retval EFI_SUCCESS The callback successfully handled the action.\r | |
1409 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r | |
1410 | @retval EFI_DEVICE_ERROR The variable could not be saved.\r | |
1411 | @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.\r | |
1412 | \r | |
1413 | **/\r | |
1414 | EFI_STATUS\r | |
1415 | EFIAPI\r | |
1416 | FileExplorerCallback (\r | |
1417 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r | |
1418 | IN EFI_BROWSER_ACTION Action,\r | |
1419 | IN EFI_QUESTION_ID QuestionId,\r | |
1420 | IN UINT8 Type,\r | |
1421 | IN EFI_IFR_TYPE_VALUE *Value,\r | |
1422 | OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r | |
1423 | );\r | |
1424 | \r | |
1425 | /**\r | |
1426 | Remove the installed BootMaint and FileExplorer HiiPackages.\r | |
1427 | \r | |
1428 | **/\r | |
1429 | VOID\r | |
1430 | FreeBMPackage(\r | |
1431 | VOID\r | |
1432 | );\r | |
1433 | \r | |
1434 | /**\r | |
1435 | Install BootMaint and FileExplorer HiiPackages.\r | |
1436 | \r | |
1437 | **/\r | |
1438 | VOID\r | |
1439 | InitBootMaintenance(\r | |
1440 | VOID\r | |
1441 | );\r | |
1442 | \r | |
1443 | //\r | |
1444 | // Global variable in this program (defined in data.c)\r | |
1445 | //\r | |
1446 | extern BM_MENU_OPTION BootOptionMenu;\r | |
1447 | extern BM_MENU_OPTION DriverOptionMenu;\r | |
1448 | extern BM_MENU_OPTION FsOptionMenu;\r | |
1449 | extern BM_MENU_OPTION ConsoleInpMenu;\r | |
1450 | extern BM_MENU_OPTION ConsoleOutMenu;\r | |
1451 | extern BM_MENU_OPTION ConsoleErrMenu;\r | |
1452 | extern BM_MENU_OPTION DirectoryMenu;\r | |
1453 | extern BM_MENU_OPTION DriverMenu;\r | |
1454 | extern BM_MENU_OPTION TerminalMenu;\r | |
1455 | extern UINT16 TerminalType[];\r | |
1456 | extern COM_ATTR BaudRateList[19];\r | |
1457 | extern COM_ATTR DataBitsList[4];\r | |
1458 | extern COM_ATTR ParityList[5];\r | |
1459 | extern COM_ATTR StopBitsList[3];\r | |
1460 | extern EFI_GUID TerminalTypeGuid[4];\r | |
1461 | extern STRING_DEPOSITORY *FileOptionStrDepository;\r | |
1462 | extern STRING_DEPOSITORY *ConsoleOptionStrDepository;\r | |
1463 | extern STRING_DEPOSITORY *BootOptionStrDepository;\r | |
1464 | extern STRING_DEPOSITORY *BootOptionHelpStrDepository;\r | |
1465 | extern STRING_DEPOSITORY *DriverOptionStrDepository;\r | |
1466 | extern STRING_DEPOSITORY *DriverOptionHelpStrDepository;\r | |
1467 | extern STRING_DEPOSITORY *TerminalStrDepository;\r | |
1468 | extern EFI_DEVICE_PATH_PROTOCOL EndDevicePath[];\r | |
1469 | \r | |
1470 | //\r | |
1471 | // Shared IFR form update data\r | |
1472 | //\r | |
1473 | extern VOID *mStartOpCodeHandle;\r | |
1474 | extern VOID *mEndOpCodeHandle;\r | |
1475 | extern EFI_IFR_GUID_LABEL *mStartLabel;\r | |
1476 | extern EFI_IFR_GUID_LABEL *mEndLabel;\r | |
1477 | \r | |
1478 | #endif\r |