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