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