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