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