]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenanceManager.h
MdeModulePkg/BMMUiLib: Replace same logic with API in UefiBootManagerLib
[mirror_edk2.git] / MdeModulePkg / Library / BootMaintenanceManagerUiLib / BootMaintenanceManager.h
CommitLineData
4af04335
DB
1/** @file\r
2Header file for boot maintenance module.\r
3\r
85520606 4Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>\r
4af04335
DB
5This program and the accompanying materials\r
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 "FormGuid.h"\r
19\r
20#include <Guid/TtyTerm.h>\r
21#include <Guid/MdeModuleHii.h>\r
22#include <Guid/FileSystemVolumeLabelInfo.h>\r
23#include <Guid/GlobalVariable.h>\r
24#include <Guid/HiiBootMaintenanceFormset.h>\r
25\r
26#include <Protocol/LoadFile.h>\r
27#include <Protocol/HiiConfigAccess.h>\r
28#include <Protocol/SimpleFileSystem.h>\r
29#include <Protocol/SerialIo.h>\r
30#include <Protocol/DevicePathToText.h>\r
31\r
32#include <Library/PrintLib.h>\r
33#include <Library/DebugLib.h>\r
34#include <Library/BaseMemoryLib.h>\r
35#include <Library/UefiBootServicesTableLib.h>\r
36#include <Library/UefiLib.h>\r
37#include <Library/MemoryAllocationLib.h>\r
38#include <Library/UefiRuntimeServicesTableLib.h>\r
39#include <Library/DevicePathLib.h>\r
40#include <Library/HiiLib.h>\r
41#include <Library/UefiHiiServicesLib.h>\r
42#include <Library/UefiBootManagerLib.h>\r
43#include <Library/FileExplorerLib.h>\r
a85be3ae 44#include "BootMaintenanceManagerCustomizedUi.h"\r
4af04335
DB
45\r
46#pragma pack(1)\r
47\r
48///\r
49/// HII specific Vendor Device Path definition.\r
50///\r
51typedef struct {\r
52 VENDOR_DEVICE_PATH VendorDevicePath;\r
53 EFI_DEVICE_PATH_PROTOCOL End;\r
54} HII_VENDOR_DEVICE_PATH;\r
55#pragma pack()\r
56\r
57//\r
58// Constants which are variable names used to access variables\r
59//\r
60\r
61#define VAR_CON_OUT_MODE L"ConOutMode"\r
62\r
63//\r
64// Variable created with this flag will be "Efi:...."\r
65//\r
66#define VAR_FLAG EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE\r
67\r
68extern EFI_GUID mBootMaintGuid;\r
69extern CHAR16 mBootMaintStorageName[];\r
70//\r
71// These are the VFR compiler generated data representing our VFR data.\r
72//\r
73extern UINT8 BootMaintenanceManagerBin[];\r
74\r
75//\r
76// Below are the number of options in Baudrate, Databits,\r
77// Parity and Stopbits selection for serial ports.\r
78//\r
79#define BM_COM_ATTR_BUADRATE 19\r
80#define BM_COM_ATTR_DATABITS 4\r
81#define BM_COM_ATTR_PARITY 5\r
82#define BM_COM_ATTR_STOPBITS 3\r
83\r
84//\r
85// Callback function helper\r
86//\r
87#define BMM_CALLBACK_DATA_SIGNATURE SIGNATURE_32 ('C', 'b', 'c', 'k')\r
88#define BMM_CALLBACK_DATA_FROM_THIS(a) CR (a, BMM_CALLBACK_DATA, BmmConfigAccess, BMM_CALLBACK_DATA_SIGNATURE)\r
89\r
90//\r
91// Enumeration type definition\r
92//\r
93typedef UINT8 BBS_TYPE;\r
94\r
95typedef enum _TYPE_OF_TERMINAL {\r
96 TerminalTypePcAnsi = 0,\r
97 TerminalTypeVt100,\r
98 TerminalTypeVt100Plus,\r
99 TerminalTypeVtUtf8,\r
100 TerminalTypeTtyTerm\r
101} TYPE_OF_TERMINAL;\r
102\r
103//\r
104// All of the signatures that will be used in list structure\r
105//\r
106#define BM_MENU_OPTION_SIGNATURE SIGNATURE_32 ('m', 'e', 'n', 'u')\r
107#define BM_LOAD_OPTION_SIGNATURE SIGNATURE_32 ('l', 'o', 'a', 'd')\r
108#define BM_CONSOLE_OPTION_SIGNATURE SIGNATURE_32 ('c', 'n', 's', 'l')\r
109#define BM_FILE_OPTION_SIGNATURE SIGNATURE_32 ('f', 'i', 'l', 'e')\r
110#define BM_HANDLE_OPTION_SIGNATURE SIGNATURE_32 ('h', 'n', 'd', 'l')\r
111#define BM_TERMINAL_OPTION_SIGNATURE SIGNATURE_32 ('t', 'r', 'm', 'l')\r
112#define BM_MENU_ENTRY_SIGNATURE SIGNATURE_32 ('e', 'n', 't', 'r')\r
113\r
114#define BM_LOAD_CONTEXT_SELECT 0x0\r
115#define BM_CONSOLE_CONTEXT_SELECT 0x1\r
116#define BM_FILE_CONTEXT_SELECT 0x2\r
117#define BM_HANDLE_CONTEXT_SELECT 0x3\r
118#define BM_TERMINAL_CONTEXT_SELECT 0x5\r
119\r
120#define BM_CONSOLE_IN_CONTEXT_SELECT 0x6\r
121#define BM_CONSOLE_OUT_CONTEXT_SELECT 0x7\r
122#define BM_CONSOLE_ERR_CONTEXT_SELECT 0x8\r
123\r
124//\r
125// Buffer size for update data\r
126//\r
127#define UPDATE_DATA_SIZE 0x100000\r
128\r
129//\r
130// Namespace of callback keys used in display and file system navigation\r
131//\r
132#define MAX_BBS_OFFSET 0xE000\r
133#define NET_OPTION_OFFSET 0xD800\r
134#define BEV_OPTION_OFFSET 0xD000\r
135#define FD_OPTION_OFFSET 0xC000\r
136#define HD_OPTION_OFFSET 0xB000\r
137#define CD_OPTION_OFFSET 0xA000\r
138#define FILE_OPTION_OFFSET 0x8000\r
139#define FILE_OPTION_MASK 0x7FFF\r
140#define HANDLE_OPTION_OFFSET 0x7000\r
141#define CONSOLE_OPTION_OFFSET 0x6000\r
142#define TERMINAL_OPTION_OFFSET 0x5000\r
143#define CONFIG_OPTION_OFFSET 0x1200\r
144#define KEY_VALUE_OFFSET 0x1100\r
145#define FORM_ID_OFFSET 0x1000\r
146\r
147//\r
148// VarOffset that will be used to create question\r
149// all these values are computed from the structure\r
150// defined below\r
151//\r
152#define VAR_OFFSET(Field) ((UINT16) ((UINTN) &(((BMM_FAKE_NV_DATA *) 0)->Field)))\r
153\r
154//\r
155// Question Id of Zero is invalid, so add an offset to it\r
156//\r
157#define QUESTION_ID(Field) (VAR_OFFSET (Field) + CONFIG_OPTION_OFFSET)\r
158\r
159#define BOOT_TIME_OUT_VAR_OFFSET VAR_OFFSET (BootTimeOut)\r
160#define BOOT_NEXT_VAR_OFFSET VAR_OFFSET (BootNext)\r
161#define COM1_BAUD_RATE_VAR_OFFSET VAR_OFFSET (COM1BaudRate)\r
162#define COM1_DATA_RATE_VAR_OFFSET VAR_OFFSET (COM1DataRate)\r
163#define COM1_STOP_BITS_VAR_OFFSET VAR_OFFSET (COM1StopBits)\r
164#define COM1_PARITY_VAR_OFFSET VAR_OFFSET (COM1Parity)\r
165#define COM1_TERMINAL_VAR_OFFSET VAR_OFFSET (COM2TerminalType)\r
166#define COM2_BAUD_RATE_VAR_OFFSET VAR_OFFSET (COM2BaudRate)\r
167#define COM2_DATA_RATE_VAR_OFFSET VAR_OFFSET (COM2DataRate)\r
168#define COM2_STOP_BITS_VAR_OFFSET VAR_OFFSET (COM2StopBits)\r
169#define COM2_PARITY_VAR_OFFSET VAR_OFFSET (COM2Parity)\r
170#define COM2_TERMINAL_VAR_OFFSET VAR_OFFSET (COM2TerminalType)\r
171#define DRV_ADD_HANDLE_DESC_VAR_OFFSET VAR_OFFSET (DriverAddHandleDesc)\r
172#define DRV_ADD_ACTIVE_VAR_OFFSET VAR_OFFSET (DriverAddActive)\r
173#define DRV_ADD_RECON_VAR_OFFSET VAR_OFFSET (DriverAddForceReconnect)\r
174#define CON_IN_COM1_VAR_OFFSET VAR_OFFSET (ConsoleInputCOM1)\r
175#define CON_IN_COM2_VAR_OFFSET VAR_OFFSET (ConsoleInputCOM2)\r
176#define CON_OUT_COM1_VAR_OFFSET VAR_OFFSET (ConsoleOutputCOM1)\r
177#define CON_OUT_COM2_VAR_OFFSET VAR_OFFSET (ConsoleOutputCOM2)\r
178#define CON_ERR_COM1_VAR_OFFSET VAR_OFFSET (ConsoleErrorCOM1)\r
179#define CON_ERR_COM2_VAR_OFFSET VAR_OFFSET (ConsoleErrorCOM2)\r
180#define CON_MODE_VAR_OFFSET VAR_OFFSET (ConsoleOutMode)\r
181#define CON_DEVICE_VAR_OFFSET VAR_OFFSET (ConsoleCheck)\r
182#define CON_IN_DEVICE_VAR_OFFSET VAR_OFFSET (ConsoleInCheck)\r
183#define CON_OUT_DEVICE_VAR_OFFSET VAR_OFFSET (ConsoleOutCheck)\r
184#define CON_ERR_DEVICE_VAR_OFFSET VAR_OFFSET (ConsoleErrCheck)\r
185#define BOOT_OPTION_ORDER_VAR_OFFSET VAR_OFFSET (BootOptionOrder)\r
186#define DRIVER_OPTION_ORDER_VAR_OFFSET VAR_OFFSET (DriverOptionOrder)\r
187#define BOOT_OPTION_DEL_VAR_OFFSET VAR_OFFSET (BootOptionDel)\r
188#define DRIVER_OPTION_DEL_VAR_OFFSET VAR_OFFSET (DriverOptionDel)\r
189#define DRIVER_ADD_OPTION_VAR_OFFSET VAR_OFFSET (DriverAddHandleOptionalData)\r
190#define COM_BAUD_RATE_VAR_OFFSET VAR_OFFSET (COMBaudRate)\r
191#define COM_DATA_RATE_VAR_OFFSET VAR_OFFSET (COMDataRate)\r
192#define COM_STOP_BITS_VAR_OFFSET VAR_OFFSET (COMStopBits)\r
193#define COM_PARITY_VAR_OFFSET VAR_OFFSET (COMParity)\r
194#define COM_TERMINAL_VAR_OFFSET VAR_OFFSET (COMTerminalType)\r
195#define COM_FLOWCONTROL_VAR_OFFSET VAR_OFFSET (COMFlowControl)\r
196\r
197#define BOOT_TIME_OUT_QUESTION_ID QUESTION_ID (BootTimeOut)\r
198#define BOOT_NEXT_QUESTION_ID QUESTION_ID (BootNext)\r
199#define COM1_BAUD_RATE_QUESTION_ID QUESTION_ID (COM1BaudRate)\r
200#define COM1_DATA_RATE_QUESTION_ID QUESTION_ID (COM1DataRate)\r
201#define COM1_STOP_BITS_QUESTION_ID QUESTION_ID (COM1StopBits)\r
202#define COM1_PARITY_QUESTION_ID QUESTION_ID (COM1Parity)\r
203#define COM1_TERMINAL_QUESTION_ID QUESTION_ID (COM2TerminalType)\r
204#define COM2_BAUD_RATE_QUESTION_ID QUESTION_ID (COM2BaudRate)\r
205#define COM2_DATA_RATE_QUESTION_ID QUESTION_ID (COM2DataRate)\r
206#define COM2_STOP_BITS_QUESTION_ID QUESTION_ID (COM2StopBits)\r
207#define COM2_PARITY_QUESTION_ID QUESTION_ID (COM2Parity)\r
208#define COM2_TERMINAL_QUESTION_ID QUESTION_ID (COM2TerminalType)\r
209#define DRV_ADD_HANDLE_DESC_QUESTION_ID QUESTION_ID (DriverAddHandleDesc)\r
210#define DRV_ADD_ACTIVE_QUESTION_ID QUESTION_ID (DriverAddActive)\r
211#define DRV_ADD_RECON_QUESTION_ID QUESTION_ID (DriverAddForceReconnect)\r
212#define CON_IN_COM1_QUESTION_ID QUESTION_ID (ConsoleInputCOM1)\r
213#define CON_IN_COM2_QUESTION_ID QUESTION_ID (ConsoleInputCOM2)\r
214#define CON_OUT_COM1_QUESTION_ID QUESTION_ID (ConsoleOutputCOM1)\r
215#define CON_OUT_COM2_QUESTION_ID QUESTION_ID (ConsoleOutputCOM2)\r
216#define CON_ERR_COM1_QUESTION_ID QUESTION_ID (ConsoleErrorCOM1)\r
217#define CON_ERR_COM2_QUESTION_ID QUESTION_ID (ConsoleErrorCOM2)\r
218#define CON_MODE_QUESTION_ID QUESTION_ID (ConsoleOutMode)\r
219#define CON_DEVICE_QUESTION_ID QUESTION_ID (ConsoleCheck)\r
220#define CON_IN_DEVICE_QUESTION_ID QUESTION_ID (ConsoleInCheck)\r
221#define CON_OUT_DEVICE_QUESTION_ID QUESTION_ID (ConsoleOutCheck)\r
222#define CON_ERR_DEVICE_QUESTION_ID QUESTION_ID (ConsoleErrCheck)\r
223#define BOOT_OPTION_ORDER_QUESTION_ID QUESTION_ID (BootOptionOrder)\r
224#define DRIVER_OPTION_ORDER_QUESTION_ID QUESTION_ID (DriverOptionOrder)\r
225#define BOOT_OPTION_DEL_QUESTION_ID QUESTION_ID (BootOptionDel)\r
226#define DRIVER_OPTION_DEL_QUESTION_ID QUESTION_ID (DriverOptionDel)\r
227#define DRIVER_ADD_OPTION_QUESTION_ID QUESTION_ID (DriverAddHandleOptionalData)\r
228#define COM_BAUD_RATE_QUESTION_ID QUESTION_ID (COMBaudRate)\r
229#define COM_DATA_RATE_QUESTION_ID QUESTION_ID (COMDataRate)\r
230#define COM_STOP_BITS_QUESTION_ID QUESTION_ID (COMStopBits)\r
231#define COM_PARITY_QUESTION_ID QUESTION_ID (COMParity)\r
232#define COM_TERMINAL_QUESTION_ID QUESTION_ID (COMTerminalType)\r
233#define COM_FLOWCONTROL_QUESTION_ID QUESTION_ID (COMFlowControl)\r
234\r
235#define STRING_DEPOSITORY_NUMBER 8\r
236\r
f7986526
DB
237#define NONE_BOOTNEXT_VALUE (0xFFFF + 1)\r
238\r
4af04335
DB
239///\r
240/// Serial Ports attributes, first one is the value for\r
241/// return from callback function, stringtoken is used to\r
242/// display the value properly\r
243///\r
244typedef struct {\r
245 UINTN Value;\r
246 UINT16 StringToken;\r
247} COM_ATTR;\r
248\r
249typedef struct {\r
250 UINT64 BaudRate;\r
251 UINT8 DataBits;\r
252 UINT8 Parity;\r
253 UINT8 StopBits;\r
254\r
255 UINT8 BaudRateIndex;\r
256 UINT8 DataBitsIndex;\r
257 UINT8 ParityIndex;\r
258 UINT8 StopBitsIndex;\r
259\r
260 UINT8 FlowControl;\r
261\r
262 UINT8 IsConIn;\r
263 UINT8 IsConOut;\r
264 UINT8 IsStdErr;\r
265 UINT8 TerminalType;\r
266\r
267 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
268} BM_TERMINAL_CONTEXT;\r
269\r
270typedef struct {\r
271 BOOLEAN IsBootNext;\r
4af04335
DB
272 BOOLEAN Deleted;\r
273\r
274 BOOLEAN IsLegacy;\r
4af04335
DB
275\r
276 UINT32 Attributes;\r
277 UINT16 FilePathListLength;\r
278 UINT16 *Description;\r
279 EFI_DEVICE_PATH_PROTOCOL *FilePathList;\r
280 UINT8 *OptionalData;\r
4af04335
DB
281} BM_LOAD_CONTEXT;\r
282\r
283typedef struct {\r
284\r
285 BOOLEAN IsActive;\r
286\r
287 BOOLEAN IsTerminal;\r
288\r
289 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
290} BM_CONSOLE_CONTEXT;\r
291\r
292typedef struct {\r
293 UINTN Column;\r
294 UINTN Row;\r
295} CONSOLE_OUT_MODE;\r
296\r
297typedef struct {\r
298 EFI_HANDLE Handle;\r
299 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
300 EFI_FILE_HANDLE FHandle;\r
301 UINT16 *FileName;\r
302 EFI_FILE_SYSTEM_VOLUME_LABEL *Info;\r
303\r
304 BOOLEAN IsRoot;\r
305 BOOLEAN IsDir;\r
306 BOOLEAN IsRemovableMedia;\r
307 BOOLEAN IsLoadFile;\r
308 BOOLEAN IsBootLegacy;\r
309} BM_FILE_CONTEXT;\r
310\r
311typedef struct {\r
312 EFI_HANDLE Handle;\r
313 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
314} BM_HANDLE_CONTEXT;\r
315\r
316typedef struct {\r
317 UINTN Signature;\r
318 LIST_ENTRY Head;\r
319 UINTN MenuNumber;\r
320} BM_MENU_OPTION;\r
321\r
322typedef struct {\r
323 UINTN Signature;\r
324 LIST_ENTRY Link;\r
325 UINTN OptionNumber;\r
326 UINT16 *DisplayString;\r
327 UINT16 *HelpString;\r
328 EFI_STRING_ID DisplayStringToken;\r
329 EFI_STRING_ID HelpStringToken;\r
330 UINTN ContextSelection;\r
331 VOID *VariableContext;\r
332} BM_MENU_ENTRY;\r
333\r
334typedef struct {\r
335 \r
336 UINTN Signature;\r
337\r
338 EFI_HII_HANDLE BmmHiiHandle;\r
339 EFI_HANDLE BmmDriverHandle;\r
340 ///\r
341 /// Boot Maintenance Manager Produced protocols\r
342 ///\r
343 EFI_HII_CONFIG_ACCESS_PROTOCOL BmmConfigAccess;\r
344 EFI_FORM_BROWSER2_PROTOCOL *FormBrowser2;\r
345\r
346 BM_MENU_ENTRY *MenuEntry;\r
347 BM_HANDLE_CONTEXT *HandleContext;\r
348 BM_FILE_CONTEXT *FileContext;\r
349 BM_LOAD_CONTEXT *LoadContext;\r
350 BM_TERMINAL_CONTEXT *TerminalContext;\r
351 UINTN CurrentTerminal;\r
352 BBS_TYPE BbsType;\r
353\r
354 //\r
355 // BMM main formset callback data.\r
356 //\r
357 \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} BMM_CALLBACK_DATA;\r
365\r
366/**\r
367\r
368 Find drivers that will be added as Driver#### variables from handles\r
369 in current system environment\r
370 All valid handles in the system except those consume SimpleFs, LoadFile\r
371 are stored in DriverMenu for future use.\r
372\r
373 @retval EFI_SUCCESS The function complets successfully.\r
374 @return Other value if failed to build the DriverMenu.\r
375\r
376**/\r
377EFI_STATUS\r
378BOpt_FindDrivers (\r
379 VOID\r
380 );\r
381\r
382/**\r
383\r
384 Build the BootOptionMenu according to BootOrder Variable.\r
385 This Routine will access the Boot#### to get EFI_LOAD_OPTION.\r
386\r
387 @param CallbackData The BMM context data.\r
388\r
389 @return The number of the Var Boot####.\r
390\r
391**/\r
392EFI_STATUS\r
393BOpt_GetBootOptions (\r
394 IN BMM_CALLBACK_DATA *CallbackData\r
395 );\r
396\r
397/**\r
398\r
399 Build up all DriverOptionMenu\r
400\r
401 @param CallbackData The BMM context data.\r
402\r
403 @return EFI_SUCESS The functin completes successfully.\r
404 @retval EFI_OUT_OF_RESOURCES Not enough memory to compete the operation.\r
405 \r
406\r
407**/\r
408EFI_STATUS\r
409BOpt_GetDriverOptions (\r
410 IN BMM_CALLBACK_DATA *CallbackData\r
411 );\r
412\r
413/**\r
414 Free resources allocated in Allocate Rountine.\r
415\r
416 @param FreeMenu Menu to be freed\r
417\r
418**/\r
419VOID\r
420BOpt_FreeMenu (\r
421 BM_MENU_OPTION *FreeMenu\r
422 );\r
423\r
424/**\r
425\r
426 Get the Option Number that has not been allocated for use.\r
427\r
428 @param Type The type of Option.\r
429\r
430 @return The available Option Number.\r
431\r
432**/\r
433UINT16\r
434BOpt_GetOptionNumber (\r
435 CHAR16 *Type\r
436 );\r
437\r
438/**\r
439\r
440 Get the Option Number for Boot#### that does not used.\r
441\r
442 @return The available Option Number.\r
443\r
444**/\r
445UINT16\r
446BOpt_GetBootOptionNumber (\r
447 VOID\r
448 );\r
449\r
450/**\r
451\r
452Get the Option Number for Driver#### that does not used.\r
453\r
454@return The unused Option Number.\r
455\r
456**/\r
457UINT16\r
458BOpt_GetDriverOptionNumber (\r
459 VOID\r
460 );\r
461\r
462/**\r
463 Create a menu entry give a Menu type.\r
464\r
465 @param MenuType The Menu type to be created.\r
466\r
467\r
468 @retval NULL If failed to create the menu.\r
469 @return The menu.\r
470\r
471**/\r
472BM_MENU_ENTRY *\r
473BOpt_CreateMenuEntry (\r
474 UINTN MenuType\r
475 );\r
476\r
477/**\r
478 Free up all resource allocated for a BM_MENU_ENTRY.\r
479\r
480 @param MenuEntry A pointer to BM_MENU_ENTRY.\r
481\r
482**/\r
483VOID\r
484BOpt_DestroyMenuEntry (\r
485 BM_MENU_ENTRY *MenuEntry\r
486 );\r
487\r
488/**\r
489 Get the Menu Entry from the list in Menu Entry List.\r
490\r
491 If MenuNumber is great or equal to the number of Menu\r
492 Entry in the list, then ASSERT.\r
493\r
494 @param MenuOption The Menu Entry List to read the menu entry.\r
495 @param MenuNumber The index of Menu Entry.\r
496\r
497 @return The Menu Entry.\r
498\r
499**/\r
500BM_MENU_ENTRY *\r
501BOpt_GetMenuEntry (\r
502 BM_MENU_OPTION *MenuOption,\r
503 UINTN MenuNumber\r
504 );\r
505\r
506/**\r
507 Get option number according to Boot#### and BootOrder variable. \r
508 The value is saved as #### + 1.\r
509\r
510 @param CallbackData The BMM context data.\r
511**/\r
512VOID \r
513GetBootOrder (\r
514 IN BMM_CALLBACK_DATA *CallbackData\r
515 );\r
516\r
517/**\r
518 Get driver option order from globalc DriverOptionMenu.\r
519\r
520 @param CallbackData The BMM context data.\r
521 \r
522**/\r
523VOID \r
524GetDriverOrder (\r
525 IN BMM_CALLBACK_DATA *CallbackData\r
526 );\r
527\r
528//\r
529// Locate all serial io devices for console\r
530//\r
531/**\r
532 Build a list containing all serial devices.\r
533\r
534 @retval EFI_SUCCESS The function complete successfully.\r
535 @retval EFI_UNSUPPORTED No serial ports present.\r
536\r
537**/\r
538EFI_STATUS\r
539LocateSerialIo (\r
540 VOID\r
541 );\r
542\r
543//\r
544// Initializing Console menu\r
545//\r
546/**\r
547 Build up ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu\r
548\r
549 @retval EFI_SUCCESS The function always complete successfully.\r
550\r
551**/\r
552EFI_STATUS\r
553GetAllConsoles(\r
554 VOID\r
555 );\r
556\r
557//\r
558// Get current mode information\r
559//\r
560/**\r
561 Get mode number according to column and row\r
562\r
563 @param CallbackData The BMM context data.\r
564**/\r
565VOID\r
566GetConsoleOutMode (\r
567 IN BMM_CALLBACK_DATA *CallbackData\r
568 );\r
569\r
570//\r
571// Cleaning up console menu\r
572//\r
573/**\r
574 Free ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu\r
575\r
576 @retval EFI_SUCCESS The function always complete successfully.\r
577**/\r
578EFI_STATUS\r
579FreeAllConsoles (\r
580 VOID\r
581 );\r
582\r
583/**\r
584 Update the device path that describing a terminal device\r
585 based on the new BaudRate, Data Bits, parity and Stop Bits\r
586 set.\r
587\r
588 @param DevicePath The devicepath protocol instance wanted to be updated.\r
589\r
590**/\r
591VOID\r
592ChangeVariableDevicePath (\r
593 IN OUT EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
594 );\r
595\r
596/**\r
597 Update the multi-instance device path of Terminal Device based on\r
598 the global TerminalMenu. If ChangeTernimal is TRUE, the terminal \r
599 device path in the Terminal Device in TerminalMenu is also updated.\r
600\r
601 @param DevicePath The multi-instance device path.\r
602 @param ChangeTerminal TRUE, then device path in the Terminal Device \r
603 in TerminalMenu is also updated; FALSE, no update.\r
604\r
605 @return EFI_SUCCESS The function completes successfully.\r
606\r
607**/\r
608EFI_STATUS\r
609ChangeTerminalDevicePath (\r
610 IN OUT EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
611 IN BOOLEAN ChangeTerminal\r
612 );\r
613\r
614//\r
615// Variable operation by menu selection\r
616//\r
617/**\r
618 This function create a currently loaded Boot Option from \r
619 the BMM. It then appends this Boot Option to the end of \r
620 the "BootOrder" list. It also append this Boot Opotion to the end\r
621 of BootOptionMenu.\r
622\r
623 @param CallbackData The BMM context data.\r
624\r
625 @retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.\r
626 @retval EFI_SUCCESS If function completes successfully.\r
627\r
628**/\r
629EFI_STATUS\r
630Var_UpdateBootOption (\r
631 IN BMM_CALLBACK_DATA *CallbackData\r
632 );\r
633\r
634/**\r
635 Delete Boot Option that represent a Deleted state in BootOptionMenu.\r
4af04335
DB
636\r
637 @retval EFI_SUCCESS If all boot load option EFI Variables corresponding to \r
638 BM_LOAD_CONTEXT marked for deletion is deleted\r
639 @return Others If failed to update the "BootOrder" variable after deletion. \r
640\r
641**/\r
642EFI_STATUS\r
643Var_DelBootOption (\r
644 VOID\r
645 );\r
646\r
4af04335
DB
647/**\r
648 This function create a currently loaded Drive Option from \r
649 the BMM. It then appends this Driver Option to the end of \r
650 the "DriverOrder" list. It append this Driver Opotion to the end\r
651 of DriverOptionMenu.\r
652\r
653 @param CallbackData The BMM context data.\r
654 @param HiiHandle The HII handle associated with the BMM formset.\r
655 @param DescriptionData The description of this driver option.\r
656 @param OptionalData The optional load option.\r
657 @param ForceReconnect If to force reconnect.\r
658\r
659 @retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.\r
660 @retval EFI_SUCCESS If function completes successfully.\r
661\r
662**/\r
663EFI_STATUS\r
664Var_UpdateDriverOption (\r
665 IN BMM_CALLBACK_DATA *CallbackData,\r
666 IN EFI_HII_HANDLE HiiHandle,\r
667 IN UINT16 *DescriptionData,\r
668 IN UINT16 *OptionalData,\r
669 IN UINT8 ForceReconnect\r
670 );\r
671\r
672/**\r
bdc8cb0d 673 Delete Load Option that represent a Deleted state in DriverOptionMenu.\r
4af04335
DB
674\r
675 @retval EFI_SUCCESS Load Option is successfully updated.\r
676 @return Other value than EFI_SUCCESS if failed to update "Driver Order" EFI\r
677 Variable.\r
678\r
679**/\r
680EFI_STATUS\r
681Var_DelDriverOption (\r
682 VOID\r
683 );\r
684\r
4af04335
DB
685/**\r
686 This function delete and build multi-instance device path ConIn\r
687 console device.\r
688\r
689 @retval EFI_SUCCESS The function complete successfully.\r
690 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.\r
691**/\r
692EFI_STATUS\r
693Var_UpdateConsoleInpOption (\r
694 VOID\r
695 );\r
696\r
697/**\r
698 This function delete and build multi-instance device path ConOut console device.\r
699\r
700 @retval EFI_SUCCESS The function complete successfully.\r
701 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.\r
702**/\r
703EFI_STATUS\r
704Var_UpdateConsoleOutOption (\r
705 VOID\r
706 );\r
707\r
708/**\r
709 This function delete and build multi-instance device path ErrOut console device.\r
710\r
711 @retval EFI_SUCCESS The function complete successfully.\r
712 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.\r
713**/\r
714EFI_STATUS\r
715Var_UpdateErrorOutOption (\r
716 VOID\r
717 );\r
718\r
719/**\r
720 This function delete and build Out of Band console device.\r
721 \r
722 @param MenuIndex Menu index which user select in the terminal menu list.\r
723 \r
724 @retval EFI_SUCCESS The function complete successfully.\r
725 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information. \r
726**/\r
727EFI_STATUS\r
728Var_UpdateOutOfBandOption (\r
729 IN UINT16 MenuIndex\r
730 );\r
731\r
4af04335
DB
732/**\r
733 This function update the "BootNext" EFI Variable. If there is no "BootNex" specified in BMM, \r
734 this EFI Variable is deleted.\r
735 It also update the BMM context data specified the "BootNext" value.\r
736\r
737 @param CallbackData The BMM context data.\r
738\r
739 @retval EFI_SUCCESS The function complete successfully.\r
740 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.\r
741\r
742**/\r
743EFI_STATUS\r
744Var_UpdateBootNext (\r
745 IN BMM_CALLBACK_DATA *CallbackData\r
746 );\r
747\r
748/**\r
749 This function update the "BootOrder" EFI Variable based on BMM Formset's NV map. It then refresh \r
750 BootOptionMenu with the new "BootOrder" list.\r
751\r
752 @param CallbackData The BMM context data.\r
753\r
754 @retval EFI_SUCCESS The function complete successfully.\r
755 @retval EFI_OUT_OF_RESOURCES Not enough memory to complete the function.\r
756 @return not The EFI variable can not be saved. See gRT->SetVariable for detail return information.\r
757\r
758**/\r
759EFI_STATUS\r
760Var_UpdateBootOrder (\r
761 IN BMM_CALLBACK_DATA *CallbackData\r
762 );\r
763\r
764/**\r
765 This function update the "DriverOrder" EFI Variable based on\r
766 BMM Formset's NV map. It then refresh DriverOptionMenu\r
767 with the new "DriverOrder" list.\r
768\r
769 @param CallbackData The BMM context data.\r
770\r
771 @retval EFI_SUCCESS The function complete successfully.\r
772 @retval EFI_OUT_OF_RESOURCES Not enough memory to complete the function.\r
773 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.\r
774\r
775**/\r
776EFI_STATUS\r
777Var_UpdateDriverOrder (\r
778 IN BMM_CALLBACK_DATA *CallbackData\r
779 );\r
780\r
781/**\r
782 Update the Text Mode of Console.\r
783\r
784 @param CallbackData The context data for BMM.\r
785\r
786 @retval EFI_SUCCSS If the Text Mode of Console is updated.\r
787 @return Other value if the Text Mode of Console is not updated.\r
788\r
789**/\r
790EFI_STATUS\r
791Var_UpdateConMode (\r
792 IN BMM_CALLBACK_DATA *CallbackData\r
793 );\r
794\r
795//\r
796// Following are page create and refresh functions\r
797//\r
798/**\r
799 Create the global UpdateData structure.\r
800\r
801**/\r
802VOID\r
803CreateUpdateData (\r
804 VOID\r
805 );\r
806\r
807/**\r
808 Refresh the global UpdateData structure.\r
809\r
810**/\r
811VOID\r
812RefreshUpdateData (\r
813 VOID\r
814 );\r
815\r
816/**\r
817 Clean up the dynamic opcode at label and form specified by\r
818 both LabelId. \r
819\r
820 @param LabelId It is both the Form ID and Label ID for\r
821 opcode deletion.\r
822 @param CallbackData The BMM context data.\r
823\r
824**/\r
825VOID\r
826CleanUpPage (\r
827 IN UINT16 LabelId,\r
828 IN BMM_CALLBACK_DATA *CallbackData\r
829 );\r
830\r
831/**\r
832 Create a lit of boot option from global BootOptionMenu. It\r
833 allow user to delete the boot option.\r
834\r
835 @param CallbackData The BMM context data.\r
836\r
837**/\r
838VOID\r
839UpdateBootDelPage (\r
840 IN BMM_CALLBACK_DATA *CallbackData\r
841 );\r
842\r
843/**\r
844 Create a lit of driver option from global DriverMenu.\r
845\r
846 @param CallbackData The BMM context data.\r
847**/\r
848VOID\r
849UpdateDrvAddHandlePage (\r
850 IN BMM_CALLBACK_DATA *CallbackData\r
851 );\r
852\r
853/**\r
854 Create a lit of driver option from global DriverOptionMenu. It\r
855 allow user to delete the driver option.\r
856\r
857 @param CallbackData The BMM context data.\r
858**/\r
859VOID\r
860UpdateDrvDelPage (\r
861 IN BMM_CALLBACK_DATA *CallbackData\r
862 );\r
863\r
864/**\r
865 Prepare the page to allow user to add description for a Driver Option.\r
866\r
867 @param CallbackData The BMM context data.\r
868**/\r
869VOID\r
870UpdateDriverAddHandleDescPage (\r
871 IN BMM_CALLBACK_DATA *CallbackData\r
872 );\r
873\r
874/**\r
875 Dispatch the correct update page function to call based on the UpdatePageId.\r
876\r
877 @param UpdatePageId The form ID.\r
878 @param CallbackData The BMM context data.\r
879**/\r
880VOID\r
881UpdatePageBody (\r
882 IN UINT16 UpdatePageId,\r
883 IN BMM_CALLBACK_DATA *CallbackData\r
884 );\r
885\r
4af04335
DB
886/**\r
887 Create the dynamic page which allows user to set the property such as Baud Rate, Data Bits,\r
888 Parity, Stop Bits, Terminal Type.\r
889\r
890 @param CallbackData The BMM context data.\r
891**/\r
892VOID\r
893UpdateTerminalPage (\r
894 IN BMM_CALLBACK_DATA *CallbackData\r
895 );\r
896\r
897/**\r
898 Refresh the text mode page\r
899\r
900 @param CallbackData The BMM context data.\r
901**/\r
902VOID\r
903UpdateConModePage (\r
904 IN BMM_CALLBACK_DATA *CallbackData\r
905 );\r
906\r
907/**\r
908 Create a list of Goto Opcode for all terminal devices logged\r
909 by TerminaMenu. This list will be inserted to form FORM_CON_COM_SETUP_ID.\r
910\r
911 @param CallbackData The BMM context data.\r
912**/\r
913VOID\r
914UpdateConCOMPage (\r
915 IN BMM_CALLBACK_DATA *CallbackData\r
916 );\r
917\r
918/**\r
919 Update add boot/driver option page.\r
920\r
921 @param CallbackData The BMM context data.\r
922 @param FormId The form ID to be updated.\r
923 @param DevicePath Device path.\r
924\r
925**/\r
926VOID\r
927UpdateOptionPage(\r
928 IN BMM_CALLBACK_DATA *CallbackData,\r
929 IN EFI_FORM_ID FormId,\r
930 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
931 );\r
932\r
933/**\r
934 Function deletes the variable specified by VarName and VarGuid.\r
935\r
936\r
937 @param VarName A Null-terminated Unicode string that is\r
938 the name of the vendor's variable.\r
939 \r
940 @param VarGuid A unique identifier for the vendor.\r
941\r
942 @retval EFI_SUCCESS The variable was found and removed\r
943 @retval EFI_UNSUPPORTED The variable store was inaccessible\r
944 @retval EFI_OUT_OF_RESOURCES The temporary buffer was not available\r
945 @retval EFI_NOT_FOUND The variable was not found\r
946\r
947**/\r
948EFI_STATUS\r
949EfiLibDeleteVariable (\r
950 IN CHAR16 *VarName,\r
951 IN EFI_GUID *VarGuid\r
952 );\r
953\r
954/**\r
955 Function is used to determine the number of device path instances\r
956 that exist in a device path.\r
957\r
958\r
959 @param DevicePath A pointer to a device path data structure.\r
960\r
961 @return This function counts and returns the number of device path instances\r
962 in DevicePath.\r
963\r
964**/\r
965UINTN\r
966EfiDevicePathInstanceCount (\r
967 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
968 );\r
969\r
970/**\r
971 Get a string from the Data Hub record based on \r
972 a device path.\r
973\r
974 @param DevPath The device Path.\r
975\r
976 @return A string located from the Data Hub records based on\r
977 the device path.\r
978 @retval NULL If failed to get the String from Data Hub.\r
979\r
980**/\r
981UINT16 *\r
982EfiLibStrFromDatahub (\r
983 IN EFI_DEVICE_PATH_PROTOCOL *DevPath\r
984 );\r
985\r
986/**\r
987 Get the index number (#### in Boot####) for the boot option pointed to a BBS legacy device type\r
988 specified by DeviceType.\r
989\r
990 @param DeviceType The legacy device type. It can be floppy, network, harddisk, cdrom,\r
991 etc.\r
992 @param OptionIndex Returns the index number (#### in Boot####).\r
993 @param OptionSize Return the size of the Boot### variable.\r
994\r
995**/\r
996VOID *\r
997GetLegacyBootOptionVar (\r
998 IN UINTN DeviceType,\r
999 OUT UINTN *OptionIndex,\r
1000 OUT UINTN *OptionSize\r
1001 );\r
1002\r
1003/**\r
1004 Discard all changes done to the BMM pages such as Boot Order change,\r
1005 Driver order change.\r
1006\r
1007 @param Private The BMM context data.\r
1008 @param CurrentFakeNVMap The current Fack NV Map.\r
1009\r
1010**/\r
1011VOID\r
1012DiscardChangeHandler (\r
1013 IN BMM_CALLBACK_DATA *Private,\r
1014 IN BMM_FAKE_NV_DATA *CurrentFakeNVMap\r
1015 );\r
1016\r
85520606
DB
1017\r
1018/**\r
1019 This function is to clean some useless data before submit changes.\r
1020\r
1021 @param Private The BMM context data.\r
1022\r
1023**/\r
1024VOID\r
1025CleanUselessBeforeSubmit (\r
1026 IN BMM_CALLBACK_DATA *Private\r
1027 );\r
1028\r
4af04335
DB
1029/**\r
1030 Dispatch the display to the next page based on NewPageId.\r
1031\r
1032 @param Private The BMM context data.\r
1033 @param NewPageId The original page ID.\r
1034\r
1035**/\r
1036VOID\r
1037UpdatePageId (\r
1038 BMM_CALLBACK_DATA *Private,\r
1039 UINT16 NewPageId\r
1040 );\r
1041\r
1042/**\r
1043 Remove the installed BootMaint and FileExplorer HiiPackages.\r
1044\r
1045**/\r
1046VOID\r
1047FreeBMPackage(\r
1048 VOID\r
1049 );\r
1050\r
1051/**\r
1052 Install BootMaint and FileExplorer HiiPackages.\r
1053\r
1054**/\r
1055VOID\r
1056InitBootMaintenance(\r
1057 VOID\r
1058 );\r
1059\r
1060/**\r
1061\r
1062 Initialize console input device check box to ConsoleInCheck[MAX_MENU_NUMBER]\r
1063 in BMM_FAKE_NV_DATA structure.\r
1064\r
1065 @param CallbackData The BMM context data.\r
1066\r
1067**/ \r
1068VOID \r
1069GetConsoleInCheck (\r
1070 IN BMM_CALLBACK_DATA *CallbackData\r
1071 );\r
1072\r
1073/**\r
1074\r
1075 Initialize console output device check box to ConsoleOutCheck[MAX_MENU_NUMBER]\r
1076 in BMM_FAKE_NV_DATA structure.\r
1077\r
1078 @param CallbackData The BMM context data.\r
1079\r
1080**/\r
1081VOID\r
1082GetConsoleOutCheck (\r
1083 IN BMM_CALLBACK_DATA *CallbackData\r
1084 );\r
1085\r
1086/**\r
1087\r
1088 Initialize standard error output device check box to ConsoleErrCheck[MAX_MENU_NUMBER]\r
1089 in BMM_FAKE_NV_DATA structure.\r
1090\r
1091 @param CallbackData The BMM context data.\r
1092\r
1093**/ \r
1094VOID\r
1095GetConsoleErrCheck (\r
1096 IN BMM_CALLBACK_DATA *CallbackData\r
1097 );\r
1098\r
1099/**\r
1100\r
1101 Initialize terminal attributes (baudrate, data rate, stop bits, parity and terminal type)\r
1102 to BMM_FAKE_NV_DATA structure.\r
1103\r
1104 @param CallbackData The BMM context data.\r
1105\r
1106**/\r
1107VOID\r
1108GetTerminalAttribute (\r
1109 IN BMM_CALLBACK_DATA *CallbackData\r
1110 );\r
1111\r
1112/**\r
1113 This function will change video resolution and text mode\r
1114 according to defined setup mode or defined boot mode \r
1115\r
1116 @param IsSetupMode Indicate mode is changed to setup mode or boot mode. \r
1117\r
1118 @retval EFI_SUCCESS Mode is changed successfully.\r
1119 @retval Others Mode failed to be changed.\r
1120\r
1121**/\r
1122EFI_STATUS\r
80b14f9a 1123BmmSetConsoleMode (\r
4af04335
DB
1124 BOOLEAN IsSetupMode\r
1125 );\r
1126\r
1127\r
1128/**\r
1129 This function converts an input device structure to a Unicode string.\r
1130\r
1131 @param DevPath A pointer to the device path structure.\r
1132\r
1133 @return A new allocated Unicode string that represents the device path.\r
1134\r
1135**/\r
1136CHAR16 *\r
1137UiDevicePathToStr (\r
1138 IN EFI_DEVICE_PATH_PROTOCOL *DevPath\r
1139 );\r
1140\r
1141/**\r
1142 Extract filename from device path. The returned buffer is allocated using AllocateCopyPool.\r
1143 The caller is responsible for freeing the allocated buffer using FreePool().\r
1144\r
1145 @param DevicePath Device path.\r
1146\r
1147 @return A new allocated string that represents the file name.\r
1148\r
1149**/\r
1150CHAR16 *\r
1151ExtractFileNameFromDevicePath (\r
1152 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
1153 );\r
1154\r
1155/**\r
1156 This function allows a caller to extract the current configuration for one\r
1157 or more named elements from the target driver.\r
1158\r
1159 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
1160 @param Request A null-terminated Unicode string in <ConfigRequest> format.\r
1161 @param Progress On return, points to a character in the Request string.\r
1162 Points to the string's null terminator if request was successful.\r
1163 Points to the most recent '&' before the first failing name/value\r
1164 pair (or the beginning of the string if the failure is in the\r
1165 first name/value pair) if the request was not successful.\r
1166 @param Results A null-terminated Unicode string in <ConfigAltResp> format which\r
1167 has all values filled in for the names in the Request string.\r
1168 String to be allocated by the called function.\r
1169\r
1170 @retval EFI_SUCCESS The Results is filled with the requested values.\r
1171 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.\r
1172 @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.\r
1173 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.\r
1174\r
1175**/\r
1176EFI_STATUS\r
1177EFIAPI\r
1178BootMaintExtractConfig (\r
1179 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
1180 IN CONST EFI_STRING Request,\r
1181 OUT EFI_STRING *Progress,\r
1182 OUT EFI_STRING *Results\r
1183 );\r
1184\r
1185/**\r
1186 This function applies changes in a driver's configuration.\r
1187 Input is a Configuration, which has the routing data for this\r
1188 driver followed by name / value configuration pairs. The driver\r
1189 must apply those pairs to its configurable storage. If the\r
1190 driver's configuration is stored in a linear block of data\r
1191 and the driver's name / value pairs are in <BlockConfig>\r
1192 format, it may use the ConfigToBlock helper function (above) to\r
1193 simplify the job. Currently not implemented.\r
1194\r
1195 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
1196 @param[in] Configuration A null-terminated Unicode string in\r
1197 <ConfigString> format. \r
1198 @param[out] Progress A pointer to a string filled in with the\r
1199 offset of the most recent '&' before the\r
1200 first failing name / value pair (or the\r
1201 beginn ing of the string if the failure\r
1202 is in the first name / value pair) or\r
1203 the terminating NULL if all was\r
1204 successful.\r
1205\r
1206 @retval EFI_SUCCESS The results have been distributed or are\r
1207 awaiting distribution. \r
1208 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the\r
1209 parts of the results that must be\r
1210 stored awaiting possible future\r
1211 protocols.\r
1212 @retval EFI_INVALID_PARAMETERS Passing in a NULL for the\r
1213 Results parameter would result\r
1214 in this type of error.\r
1215 @retval EFI_NOT_FOUND Target for the specified routing data\r
1216 was not found.\r
1217**/\r
1218EFI_STATUS\r
1219EFIAPI\r
1220BootMaintRouteConfig (\r
1221 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
1222 IN CONST EFI_STRING Configuration,\r
1223 OUT EFI_STRING *Progress\r
1224 );\r
1225\r
1226/**\r
1227 This function processes the results of changes in configuration.\r
1228\r
1229\r
1230 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
1231 @param Action Specifies the type of action taken by the browser.\r
1232 @param QuestionId A unique value which is sent to the original exporting driver\r
1233 so that it can identify the type of data to expect.\r
1234 @param Type The type of value for the question.\r
1235 @param Value A pointer to the data being sent to the original exporting driver.\r
1236 @param ActionRequest On return, points to the action requested by the callback function.\r
1237\r
1238 @retval EFI_SUCCESS The callback successfully handled the action.\r
1239 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r
1240 @retval EFI_DEVICE_ERROR The variable could not be saved.\r
1241 @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.\r
1242 @retval EFI_INVALID_PARAMETER The parameter of Value or ActionRequest is invalid.\r
1243**/\r
1244EFI_STATUS\r
1245EFIAPI\r
1246BootMaintCallback (\r
1247 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
1248 IN EFI_BROWSER_ACTION Action,\r
1249 IN EFI_QUESTION_ID QuestionId,\r
1250 IN UINT8 Type,\r
1251 IN EFI_IFR_TYPE_VALUE *Value,\r
1252 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r
1253 );\r
1254\r
1255/**\r
1256 Create boot option base on the input file path info.\r
1257\r
1258 @param FilePath Point to the file path.\r
1259\r
1260 @retval TRUE Exit caller function.\r
1261 @retval FALSE Not exit caller function.\r
1262\r
1263**/\r
1264BOOLEAN \r
bdf0da37 1265EFIAPI\r
4af04335
DB
1266CreateBootOptionFromFile (\r
1267 IN EFI_DEVICE_PATH_PROTOCOL *FilePath\r
1268 );\r
1269\r
1270/**\r
1271 Create driver option base on the input file path info.\r
1272\r
1273 @param FilePath Point to the file path.\r
1274\r
1275 @retval TRUE Exit caller function.\r
1276 @retval FALSE Not exit caller function.\r
1277**/\r
1278BOOLEAN \r
bdf0da37 1279EFIAPI\r
4af04335
DB
1280CreateDriverOptionFromFile (\r
1281 IN EFI_DEVICE_PATH_PROTOCOL *FilePath\r
1282 );\r
1283\r
1284/**\r
1285 Boot the file specified by the input file path info.\r
1286\r
1287 @param FilePath Point to the file path.\r
1288\r
1289 @retval TRUE Exit caller function.\r
1290 @retval FALSE Not exit caller function.\r
1291 \r
1292**/\r
1293BOOLEAN \r
bdf0da37 1294EFIAPI\r
4af04335
DB
1295BootFromFile (\r
1296 IN EFI_DEVICE_PATH_PROTOCOL *FilePath\r
1297 );\r
1298\r
1299//\r
1300// Global variable in this program (defined in data.c)\r
1301//\r
1302extern BM_MENU_OPTION BootOptionMenu;\r
1303extern BM_MENU_OPTION DriverOptionMenu;\r
1304extern BM_MENU_OPTION ConsoleInpMenu;\r
1305extern BM_MENU_OPTION ConsoleOutMenu;\r
1306extern BM_MENU_OPTION ConsoleErrMenu;\r
1307extern BM_MENU_OPTION DriverMenu;\r
1308extern BM_MENU_OPTION TerminalMenu;\r
1309extern UINT16 TerminalType[5];\r
1310extern COM_ATTR BaudRateList[19];\r
1311extern COM_ATTR DataBitsList[4];\r
1312extern COM_ATTR ParityList[5];\r
1313extern COM_ATTR StopBitsList[3];\r
1314extern EFI_GUID TerminalTypeGuid[5];\r
1315extern EFI_DEVICE_PATH_PROTOCOL EndDevicePath[];\r
1316extern UINT16 mFlowControlType[2];\r
1317extern UINT32 mFlowControlValue[2];\r
1318\r
1319//\r
1320// Shared IFR form update data\r
1321//\r
1322extern VOID *mStartOpCodeHandle;\r
1323extern VOID *mEndOpCodeHandle;\r
1324extern EFI_IFR_GUID_LABEL *mStartLabel;\r
1325extern EFI_IFR_GUID_LABEL *mEndLabel;\r
1326extern BMM_CALLBACK_DATA gBootMaintenancePrivate;\r
1327extern BMM_CALLBACK_DATA *mBmmCallbackInfo;\r
1328\r
1329#endif\r