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