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