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