]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenanceManager.h
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / MdeModulePkg / Library / BootMaintenanceManagerUiLib / BootMaintenanceManager.h
CommitLineData
4af04335
DB		 1/** @file\r
2Header file for boot maintenance module.\r
3\r
590c9d58 4Copyright (c) 2004 - 2019, 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
1436aea4
MK		 47 VENDOR_DEVICE_PATH VendorDevicePath;\r
48 EFI_DEVICE_PATH_PROTOCOL End;\r
4af04335
DB		 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
1436aea4 56#define VAR_CON_OUT_MODE L"ConOutMode"\r
4af04335
DB		 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
1436aea4
MK		 63extern EFI_GUID mBootMaintGuid;\r
64extern CHAR16 mBootMaintStorageName[];\r
4af04335
DB		 65//\r
66// These are the VFR compiler generated data representing our VFR data.\r
67//\r
1436aea4 68extern UINT8 BootMaintenanceManagerBin[];\r
4af04335
DB		 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
1436aea4 82#define BMM_CALLBACK_DATA_SIGNATURE SIGNATURE_32 ('C', 'b', 'c', 'k')\r
4af04335
DB		 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
1436aea4 91 TerminalTypePcAnsi = 0,\r
4af04335
DB		 92 TerminalTypeVt100,\r
93 TerminalTypeVt100Plus,\r
94 TerminalTypeVtUtf8,\r
590c9d58
ZG		 95 TerminalTypeTtyTerm,\r
96 TerminalTypeLinux,\r
97 TerminalTypeXtermR6,\r
98 TerminalTypeVt400,\r
99 TerminalTypeSCO\r
4af04335
DB		 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
1436aea4
MK		 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
4af04335 118\r
1436aea4
MK		 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
4af04335
DB		 122\r
123//\r
124// Buffer size for update data\r
125//\r
1436aea4 126#define UPDATE_DATA_SIZE 0x100000\r
4af04335
DB		 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
1436aea4 151#define VAR_OFFSET(Field) ((UINT16) ((UINTN) &(((BMM_FAKE_NV_DATA *) 0)->Field)))\r
4af04335
DB		 152\r
153//\r
154// Question Id of Zero is invalid, so add an offset to it\r
155//\r
1436aea4 156#define QUESTION_ID(Field) (VAR_OFFSET (Field) + CONFIG_OPTION_OFFSET)\r
4af04335
DB		 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
1436aea4
MK		 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
236#define NONE_BOOTNEXT_VALUE (0xFFFF + 1)\r
f7986526 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
1436aea4
MK		 244 UINTN Value;\r
245 UINT16 StringToken;\r
4af04335
DB		 246} COM_ATTR;\r
247\r
248typedef struct {\r
1436aea4
MK		 249 UINT64 BaudRate;\r
250 UINT8 DataBits;\r
251 UINT8 Parity;\r
252 UINT8 StopBits;\r
4af04335 253\r
1436aea4
MK		 254 UINT8 BaudRateIndex;\r
255 UINT8 DataBitsIndex;\r
256 UINT8 ParityIndex;\r
257 UINT8 StopBitsIndex;\r
4af04335 258\r
1436aea4 259 UINT8 FlowControl;\r
4af04335 260\r
1436aea4
MK		 261 UINT8 IsConIn;\r
262 UINT8 IsConOut;\r
263 UINT8 IsStdErr;\r
264 UINT8 TerminalType;\r
4af04335 265\r
1436aea4 266 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
4af04335
DB		 267} BM_TERMINAL_CONTEXT;\r
268\r
269typedef struct {\r
1436aea4
MK		 270 BOOLEAN IsBootNext;\r
271 BOOLEAN Deleted;\r
4af04335 272\r
1436aea4 273 BOOLEAN IsLegacy;\r
4af04335 274\r
1436aea4
MK		 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
1436aea4 283 BOOLEAN IsActive;\r
4af04335 284\r
1436aea4 285 BOOLEAN IsTerminal;\r
4af04335 286\r
1436aea4 287 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
4af04335
DB		 288} BM_CONSOLE_CONTEXT;\r
289\r
290typedef struct {\r
1436aea4
MK		 291 UINTN Column;\r
292 UINTN Row;\r
4af04335
DB		 293} CONSOLE_OUT_MODE;\r
294\r
295typedef struct {\r
1436aea4
MK		 296 EFI_HANDLE Handle;\r
297 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
298 EFI_FILE_HANDLE FHandle;\r
299 UINT16 *FileName;\r
300 EFI_FILE_SYSTEM_VOLUME_LABEL *Info;\r
301\r
302 BOOLEAN IsRoot;\r
303 BOOLEAN IsDir;\r
304 BOOLEAN IsRemovableMedia;\r
305 BOOLEAN IsLoadFile;\r
306 BOOLEAN IsBootLegacy;\r
4af04335
DB		 307} BM_FILE_CONTEXT;\r
308\r
309typedef struct {\r
1436aea4
MK		 310 EFI_HANDLE Handle;\r
311 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
4af04335
DB		 312} BM_HANDLE_CONTEXT;\r
313\r
314typedef struct {\r
1436aea4
MK		 315 UINTN Signature;\r
316 LIST_ENTRY Head;\r
317 UINTN MenuNumber;\r
4af04335
DB		 318} BM_MENU_OPTION;\r
319\r
320typedef struct {\r
1436aea4
MK		 321 UINTN Signature;\r
322 LIST_ENTRY Link;\r
323 UINTN OptionNumber;\r
324 UINT16 *DisplayString;\r
325 UINT16 *HelpString;\r
326 EFI_STRING_ID DisplayStringToken;\r
327 EFI_STRING_ID HelpStringToken;\r
328 UINTN ContextSelection;\r
329 VOID *VariableContext;\r
4af04335
DB		 330} BM_MENU_ENTRY;\r
331\r
332typedef struct {\r
1436aea4 333 UINTN Signature;\r
d1102dba 334\r
1436aea4
MK		 335 EFI_HII_HANDLE BmmHiiHandle;\r
336 EFI_HANDLE BmmDriverHandle;\r
4af04335
DB		 337 ///\r
338 /// Boot Maintenance Manager Produced protocols\r
339 ///\r
1436aea4
MK		 340 EFI_HII_CONFIG_ACCESS_PROTOCOL BmmConfigAccess;\r
341 EFI_FORM_BROWSER2_PROTOCOL *FormBrowser2;\r
4af04335 342\r
1436aea4
MK		 343 BM_MENU_ENTRY *MenuEntry;\r
344 BM_HANDLE_CONTEXT *HandleContext;\r
345 BM_FILE_CONTEXT *FileContext;\r
346 BM_LOAD_CONTEXT *LoadContext;\r
347 BM_TERMINAL_CONTEXT *TerminalContext;\r
348 UINTN CurrentTerminal;\r
349 BBS_TYPE BbsType;\r
4af04335
DB		 350\r
351 //\r
352 // BMM main formset callback data.\r
353 //\r
d1102dba 354\r
1436aea4
MK		 355 EFI_FORM_ID BmmCurrentPageId;\r
356 EFI_FORM_ID BmmPreviousPageId;\r
357 BOOLEAN BmmAskSaveOrNot;\r
358 BMM_FAKE_NV_DATA BmmFakeNvData;\r
359 BMM_FAKE_NV_DATA BmmOldFakeNVData;\r
4af04335
DB		 360} BMM_CALLBACK_DATA;\r
361\r
362/**\r
363\r
364 Find drivers that will be added as Driver#### variables from handles\r
365 in current system environment\r
366 All valid handles in the system except those consume SimpleFs, LoadFile\r
367 are stored in DriverMenu for future use.\r
368\r
369 @retval EFI_SUCCESS The function complets successfully.\r
370 @return Other value if failed to build the DriverMenu.\r
371\r
372**/\r
373EFI_STATUS\r
374BOpt_FindDrivers (\r
375 VOID\r
376 );\r
377\r
378/**\r
379\r
380 Build the BootOptionMenu according to BootOrder Variable.\r
381 This Routine will access the Boot#### to get EFI_LOAD_OPTION.\r
382\r
383 @param CallbackData The BMM context data.\r
384\r
385 @return The number of the Var Boot####.\r
386\r
387**/\r
388EFI_STATUS\r
389BOpt_GetBootOptions (\r
1436aea4 390 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 391 );\r
392\r
393/**\r
394\r
395 Build up all DriverOptionMenu\r
396\r
397 @param CallbackData The BMM context data.\r
398\r
399 @return EFI_SUCESS The functin completes successfully.\r
400 @retval EFI_OUT_OF_RESOURCES Not enough memory to compete the operation.\r
d1102dba 401\r
4af04335
DB		 402\r
403**/\r
404EFI_STATUS\r
405BOpt_GetDriverOptions (\r
1436aea4 406 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 407 );\r
408\r
409/**\r
410 Free resources allocated in Allocate Rountine.\r
411\r
412 @param FreeMenu Menu to be freed\r
413\r
414**/\r
415VOID\r
416BOpt_FreeMenu (\r
1436aea4 417 BM_MENU_OPTION *FreeMenu\r
4af04335
DB		 418 );\r
419\r
420/**\r
421\r
422 Get the Option Number that has not been allocated for use.\r
423\r
424 @param Type The type of Option.\r
425\r
426 @return The available Option Number.\r
427\r
428**/\r
429UINT16\r
430BOpt_GetOptionNumber (\r
1436aea4 431 CHAR16 *Type\r
4af04335
DB		 432 );\r
433\r
434/**\r
435\r
436 Get the Option Number for Boot#### that does not used.\r
437\r
438 @return The available Option Number.\r
439\r
440**/\r
441UINT16\r
442BOpt_GetBootOptionNumber (\r
443 VOID\r
444 );\r
445\r
446/**\r
447\r
448Get the Option Number for Driver#### that does not used.\r
449\r
450@return The unused Option Number.\r
451\r
452**/\r
453UINT16\r
454BOpt_GetDriverOptionNumber (\r
455 VOID\r
456 );\r
457\r
458/**\r
459 Create a menu entry give a Menu type.\r
460\r
461 @param MenuType The Menu type to be created.\r
462\r
463\r
464 @retval NULL If failed to create the menu.\r
465 @return The menu.\r
466\r
467**/\r
468BM_MENU_ENTRY *\r
469BOpt_CreateMenuEntry (\r
1436aea4 470 UINTN MenuType\r
4af04335
DB		 471 );\r
472\r
473/**\r
474 Free up all resource allocated for a BM_MENU_ENTRY.\r
475\r
476 @param MenuEntry A pointer to BM_MENU_ENTRY.\r
477\r
478**/\r
479VOID\r
480BOpt_DestroyMenuEntry (\r
1436aea4 481 BM_MENU_ENTRY *MenuEntry\r
4af04335
DB		 482 );\r
483\r
484/**\r
485 Get the Menu Entry from the list in Menu Entry List.\r
486\r
487 If MenuNumber is great or equal to the number of Menu\r
488 Entry in the list, then ASSERT.\r
489\r
490 @param MenuOption The Menu Entry List to read the menu entry.\r
491 @param MenuNumber The index of Menu Entry.\r
492\r
493 @return The Menu Entry.\r
494\r
495**/\r
496BM_MENU_ENTRY *\r
497BOpt_GetMenuEntry (\r
1436aea4
MK		 498 BM_MENU_OPTION *MenuOption,\r
499 UINTN MenuNumber\r
4af04335
DB		 500 );\r
501\r
502/**\r
d1102dba 503 Get option number according to Boot#### and BootOrder variable.\r
4af04335
DB		 504 The value is saved as #### + 1.\r
505\r
506 @param CallbackData The BMM context data.\r
507**/\r
d1102dba 508VOID\r
4af04335 509GetBootOrder (\r
1436aea4 510 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 511 );\r
512\r
513/**\r
514 Get driver option order from globalc DriverOptionMenu.\r
515\r
516 @param CallbackData The BMM context data.\r
d1102dba 517\r
4af04335 518**/\r
d1102dba 519VOID\r
4af04335 520GetDriverOrder (\r
1436aea4 521 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 522 );\r
523\r
524//\r
525// Locate all serial io devices for console\r
526//\r
1436aea4 527\r
4af04335
DB		 528/**\r
529 Build a list containing all serial devices.\r
530\r
531 @retval EFI_SUCCESS The function complete successfully.\r
532 @retval EFI_UNSUPPORTED No serial ports present.\r
533\r
534**/\r
535EFI_STATUS\r
536LocateSerialIo (\r
537 VOID\r
538 );\r
539\r
540//\r
541// Initializing Console menu\r
542//\r
1436aea4 543\r
4af04335
DB		 544/**\r
545 Build up ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu\r
546\r
547 @retval EFI_SUCCESS The function always complete successfully.\r
548\r
549**/\r
550EFI_STATUS\r
1436aea4 551GetAllConsoles (\r
4af04335
DB		 552 VOID\r
553 );\r
554\r
555//\r
556// Get current mode information\r
557//\r
1436aea4 558\r
4af04335
DB		 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
1436aea4 566 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 567 );\r
568\r
569//\r
570// Cleaning up console menu\r
571//\r
1436aea4 572\r
4af04335
DB		 573/**\r
574 Free ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu\r
575\r
576 @retval EFI_SUCCESS The function always complete successfully.\r
577**/\r
578EFI_STATUS\r
579FreeAllConsoles (\r
580 VOID\r
581 );\r
582\r
583/**\r
584 Update the device path that describing a terminal device\r
585 based on the new BaudRate, Data Bits, parity and Stop Bits\r
586 set.\r
587\r
588 @param DevicePath The devicepath protocol instance wanted to be updated.\r
589\r
590**/\r
591VOID\r
592ChangeVariableDevicePath (\r
593 IN OUT EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
594 );\r
595\r
596/**\r
597 Update the multi-instance device path of Terminal Device based on\r
d1102dba 598 the global TerminalMenu. If ChangeTernimal is TRUE, the terminal\r
4af04335
DB		 599 device path in the Terminal Device in TerminalMenu is also updated.\r
600\r
601 @param DevicePath The multi-instance device path.\r
d1102dba 602 @param ChangeTerminal TRUE, then device path in the Terminal Device\r
4af04335
DB		 603 in TerminalMenu is also updated; FALSE, no update.\r
604\r
605 @return EFI_SUCCESS The function completes successfully.\r
606\r
607**/\r
608EFI_STATUS\r
609ChangeTerminalDevicePath (\r
610 IN OUT EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
1436aea4 611 IN BOOLEAN ChangeTerminal\r
4af04335
DB		 612 );\r
613\r
614//\r
615// Variable operation by menu selection\r
616//\r
1436aea4 617\r
4af04335 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
1436aea4 632 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 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
1436aea4
MK		 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
4af04335
DB		 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
1436aea4 730 IN UINT16 MenuIndex\r
4af04335
DB		 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
1436aea4 746 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 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
1436aea4 762 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 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
1436aea4 779 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 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
1436aea4 793 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 794 );\r
795\r
796//\r
797// Following are page create and refresh functions\r
798//\r
1436aea4 799\r
4af04335
DB		 800/**\r
801 Create the global UpdateData structure.\r
802\r
803**/\r
804VOID\r
805CreateUpdateData (\r
806 VOID\r
807 );\r
808\r
809/**\r
810 Refresh the global UpdateData structure.\r
811\r
812**/\r
813VOID\r
814RefreshUpdateData (\r
815 VOID\r
816 );\r
817\r
818/**\r
819 Clean up the dynamic opcode at label and form specified by\r
d1102dba 820 both LabelId.\r
4af04335
DB		 821\r
822 @param LabelId It is both the Form ID and Label ID for\r
823 opcode deletion.\r
824 @param CallbackData The BMM context data.\r
825\r
826**/\r
827VOID\r
828CleanUpPage (\r
1436aea4
MK		 829 IN UINT16 LabelId,\r
830 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 831 );\r
832\r
833/**\r
834 Create a lit of boot option from global BootOptionMenu. It\r
835 allow user to delete the boot option.\r
836\r
837 @param CallbackData The BMM context data.\r
838\r
839**/\r
840VOID\r
841UpdateBootDelPage (\r
1436aea4 842 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 843 );\r
844\r
845/**\r
846 Create a lit of driver option from global DriverMenu.\r
847\r
848 @param CallbackData The BMM context data.\r
849**/\r
850VOID\r
851UpdateDrvAddHandlePage (\r
1436aea4 852 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 853 );\r
854\r
855/**\r
856 Create a lit of driver option from global DriverOptionMenu. It\r
857 allow user to delete the driver option.\r
858\r
859 @param CallbackData The BMM context data.\r
860**/\r
861VOID\r
862UpdateDrvDelPage (\r
1436aea4 863 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 864 );\r
865\r
866/**\r
867 Prepare the page to allow user to add description for a Driver Option.\r
868\r
869 @param CallbackData The BMM context data.\r
870**/\r
871VOID\r
872UpdateDriverAddHandleDescPage (\r
1436aea4 873 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 874 );\r
875\r
876/**\r
877 Dispatch the correct update page function to call based on the UpdatePageId.\r
878\r
879 @param UpdatePageId The form ID.\r
880 @param CallbackData The BMM context data.\r
881**/\r
882VOID\r
883UpdatePageBody (\r
1436aea4
MK		 884 IN UINT16 UpdatePageId,\r
885 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 886 );\r
887\r
4af04335
DB		 888/**\r
889 Create the dynamic page which allows user to set the property such as Baud Rate, Data Bits,\r
890 Parity, Stop Bits, Terminal Type.\r
891\r
892 @param CallbackData The BMM context data.\r
893**/\r
894VOID\r
895UpdateTerminalPage (\r
1436aea4 896 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 897 );\r
898\r
899/**\r
900 Refresh the text mode page\r
901\r
902 @param CallbackData The BMM context data.\r
903**/\r
904VOID\r
905UpdateConModePage (\r
1436aea4 906 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 907 );\r
908\r
909/**\r
910 Create a list of Goto Opcode for all terminal devices logged\r
911 by TerminaMenu. This list will be inserted to form FORM_CON_COM_SETUP_ID.\r
912\r
913 @param CallbackData The BMM context data.\r
914**/\r
915VOID\r
916UpdateConCOMPage (\r
1436aea4 917 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 918 );\r
919\r
920/**\r
921 Update add boot/driver option page.\r
922\r
923 @param CallbackData The BMM context data.\r
924 @param FormId The form ID to be updated.\r
925 @param DevicePath Device path.\r
926\r
927**/\r
928VOID\r
1436aea4
MK		 929UpdateOptionPage (\r
930 IN BMM_CALLBACK_DATA *CallbackData,\r
931 IN EFI_FORM_ID FormId,\r
932 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
4af04335
DB		 933 );\r
934\r
935/**\r
936 Function deletes the variable specified by VarName and VarGuid.\r
937\r
938\r
939 @param VarName A Null-terminated Unicode string that is\r
940 the name of the vendor's variable.\r
d1102dba 941\r
4af04335
DB		 942 @param VarGuid A unique identifier for the vendor.\r
943\r
944 @retval EFI_SUCCESS The variable was found and removed\r
945 @retval EFI_UNSUPPORTED The variable store was inaccessible\r
946 @retval EFI_OUT_OF_RESOURCES The temporary buffer was not available\r
947 @retval EFI_NOT_FOUND The variable was not found\r
948\r
949**/\r
950EFI_STATUS\r
951EfiLibDeleteVariable (\r
1436aea4
MK		 952 IN CHAR16 *VarName,\r
953 IN EFI_GUID *VarGuid\r
4af04335
DB		 954 );\r
955\r
956/**\r
957 Function is used to determine the number of device path instances\r
958 that exist in a device path.\r
959\r
960\r
961 @param DevicePath A pointer to a device path data structure.\r
962\r
963 @return This function counts and returns the number of device path instances\r
964 in DevicePath.\r
965\r
966**/\r
967UINTN\r
968EfiDevicePathInstanceCount (\r
1436aea4 969 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
4af04335
DB		 970 );\r
971\r
972/**\r
d1102dba 973 Get a string from the Data Hub record based on\r
4af04335
DB		 974 a device path.\r
975\r
976 @param DevPath The device Path.\r
977\r
978 @return A string located from the Data Hub records based on\r
979 the device path.\r
980 @retval NULL If failed to get the String from Data Hub.\r
981\r
982**/\r
983UINT16 *\r
984EfiLibStrFromDatahub (\r
1436aea4 985 IN EFI_DEVICE_PATH_PROTOCOL *DevPath\r
4af04335
DB		 986 );\r
987\r
988/**\r
989 Get the index number (#### in Boot####) for the boot option pointed to a BBS legacy device type\r
990 specified by DeviceType.\r
991\r
992 @param DeviceType The legacy device type. It can be floppy, network, harddisk, cdrom,\r
993 etc.\r
994 @param OptionIndex Returns the index number (#### in Boot####).\r
995 @param OptionSize Return the size of the Boot### variable.\r
996\r
997**/\r
998VOID *\r
999GetLegacyBootOptionVar (\r
1436aea4
MK		 1000 IN UINTN DeviceType,\r
1001 OUT UINTN *OptionIndex,\r
1002 OUT UINTN *OptionSize\r
4af04335
DB		 1003 );\r
1004\r
1005/**\r
1006 Discard all changes done to the BMM pages such as Boot Order change,\r
1007 Driver order change.\r
1008\r
1009 @param Private The BMM context data.\r
1010 @param CurrentFakeNVMap The current Fack NV Map.\r
1011\r
1012**/\r
1013VOID\r
1014DiscardChangeHandler (\r
1436aea4
MK		 1015 IN BMM_CALLBACK_DATA *Private,\r
1016 IN BMM_FAKE_NV_DATA *CurrentFakeNVMap\r
4af04335
DB		 1017 );\r
1018\r
85520606
DB		 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
1436aea4 1027 IN BMM_CALLBACK_DATA *Private\r
85520606
DB		 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
1436aea4
MK		 1039 BMM_CALLBACK_DATA *Private,\r
1040 UINT16 NewPageId\r
4af04335
DB		 1041 );\r
1042\r
1043/**\r
1044 Remove the installed BootMaint and FileExplorer HiiPackages.\r
1045\r
1046**/\r
1047VOID\r
1436aea4 1048FreeBMPackage (\r
4af04335
DB		 1049 VOID\r
1050 );\r
1051\r
1052/**\r
1053 Install BootMaint and FileExplorer HiiPackages.\r
1054\r
1055**/\r
1056VOID\r
1436aea4 1057InitBootMaintenance (\r
4af04335
DB		 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 1070GetConsoleInCheck (\r
1436aea4 1071 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 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
1436aea4 1084 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 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
1436aea4 1097 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 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
1436aea4 1110 IN BMM_CALLBACK_DATA *CallbackData\r
4af04335
DB		 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
4af04335
DB		 1128/**\r
1129 This function converts an input device structure to a Unicode string.\r
1130\r
1131 @param DevPath A pointer to the device path structure.\r
1132\r
1133 @return A new allocated Unicode string that represents the device path.\r
1134\r
1135**/\r
1136CHAR16 *\r
1137UiDevicePathToStr (\r
1436aea4 1138 IN EFI_DEVICE_PATH_PROTOCOL *DevPath\r
4af04335
DB		 1139 );\r
1140\r
1141/**\r
1142 Extract filename from device path. The returned buffer is allocated using AllocateCopyPool.\r
1143 The caller is responsible for freeing the allocated buffer using FreePool().\r
1144\r
1145 @param DevicePath Device path.\r
1146\r
1147 @return A new allocated string that represents the file name.\r
1148\r
1149**/\r
1150CHAR16 *\r
1151ExtractFileNameFromDevicePath (\r
1436aea4 1152 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
4af04335
DB		 1153 );\r
1154\r
1155/**\r
1156 This function allows a caller to extract the current configuration for one\r
1157 or more named elements from the target driver.\r
1158\r
1159 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
1160 @param Request A null-terminated Unicode string in <ConfigRequest> format.\r
1161 @param Progress On return, points to a character in the Request string.\r
1162 Points to the string's null terminator if request was successful.\r
1163 Points to the most recent '&' before the first failing name/value\r
1164 pair (or the beginning of the string if the failure is in the\r
1165 first name/value pair) if the request was not successful.\r
1166 @param Results A null-terminated Unicode string in <ConfigAltResp> format which\r
1167 has all values filled in for the names in the Request string.\r
1168 String to be allocated by the called function.\r
1169\r
1170 @retval EFI_SUCCESS The Results is filled with the requested values.\r
1171 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.\r
1172 @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.\r
1173 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.\r
1174\r
1175**/\r
1176EFI_STATUS\r
1177EFIAPI\r
1178BootMaintExtractConfig (\r
1436aea4
MK		 1179 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
1180 IN CONST EFI_STRING Request,\r
1181 OUT EFI_STRING *Progress,\r
1182 OUT EFI_STRING *Results\r
4af04335
DB		 1183 );\r
1184\r
1185/**\r
1186 This function applies changes in a driver's configuration.\r
1187 Input is a Configuration, which has the routing data for this\r
1188 driver followed by name / value configuration pairs. The driver\r
1189 must apply those pairs to its configurable storage. If the\r
1190 driver's configuration is stored in a linear block of data\r
1191 and the driver's name / value pairs are in <BlockConfig>\r
1192 format, it may use the ConfigToBlock helper function (above) to\r
1193 simplify the job. Currently not implemented.\r
1194\r
1195 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
1196 @param[in] Configuration A null-terminated Unicode string in\r
d1102dba 1197 <ConfigString> format.\r
4af04335
DB		 1198 @param[out] Progress A pointer to a string filled in with the\r
1199 offset of the most recent '&' before the\r
1200 first failing name / value pair (or the\r
1201 beginn ing of the string if the failure\r
1202 is in the first name / value pair) or\r
1203 the terminating NULL if all was\r
1204 successful.\r
1205\r
1206 @retval EFI_SUCCESS The results have been distributed or are\r
d1102dba 1207 awaiting distribution.\r
4af04335
DB		 1208 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the\r
1209 parts of the results that must be\r
1210 stored awaiting possible future\r
1211 protocols.\r
1212 @retval EFI_INVALID_PARAMETERS Passing in a NULL for the\r
1213 Results parameter would result\r
1214 in this type of error.\r
1215 @retval EFI_NOT_FOUND Target for the specified routing data\r
1216 was not found.\r
1217**/\r
1218EFI_STATUS\r
1219EFIAPI\r
1220BootMaintRouteConfig (\r
1436aea4
MK		 1221 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
1222 IN CONST EFI_STRING Configuration,\r
1223 OUT EFI_STRING *Progress\r
4af04335
DB		 1224 );\r
1225\r
1226/**\r
1227 This function processes the results of changes in configuration.\r
1228\r
1229\r
1230 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
1231 @param Action Specifies the type of action taken by the browser.\r
1232 @param QuestionId A unique value which is sent to the original exporting driver\r
1233 so that it can identify the type of data to expect.\r
1234 @param Type The type of value for the question.\r
1235 @param Value A pointer to the data being sent to the original exporting driver.\r
1236 @param ActionRequest On return, points to the action requested by the callback function.\r
1237\r
1238 @retval EFI_SUCCESS The callback successfully handled the action.\r
1239 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r
1240 @retval EFI_DEVICE_ERROR The variable could not be saved.\r
1241 @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.\r
1242 @retval EFI_INVALID_PARAMETER The parameter of Value or ActionRequest is invalid.\r
1243**/\r
1244EFI_STATUS\r
1245EFIAPI\r
1246BootMaintCallback (\r
1436aea4
MK		 1247 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
1248 IN EFI_BROWSER_ACTION Action,\r
1249 IN EFI_QUESTION_ID QuestionId,\r
1250 IN UINT8 Type,\r
1251 IN EFI_IFR_TYPE_VALUE *Value,\r
1252 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r
4af04335
DB		 1253 );\r
1254\r
1255/**\r
1256 Create boot option base on the input file path info.\r
1257\r
1258 @param FilePath Point to the file path.\r
1259\r
1260 @retval TRUE Exit caller function.\r
1261 @retval FALSE Not exit caller function.\r
1262\r
1263**/\r
d1102dba 1264BOOLEAN\r
bdf0da37 1265EFIAPI\r
4af04335 1266CreateBootOptionFromFile (\r
1436aea4 1267 IN EFI_DEVICE_PATH_PROTOCOL *FilePath\r
4af04335
DB		 1268 );\r
1269\r
1270/**\r
1271 Create driver option base on the input file path info.\r
1272\r
1273 @param FilePath Point to the file path.\r
1274\r
1275 @retval TRUE Exit caller function.\r
1276 @retval FALSE Not exit caller function.\r
1277**/\r
d1102dba 1278BOOLEAN\r
bdf0da37 1279EFIAPI\r
4af04335 1280CreateDriverOptionFromFile (\r
1436aea4 1281 IN EFI_DEVICE_PATH_PROTOCOL *FilePath\r
4af04335
DB		 1282 );\r
1283\r
1284/**\r
1285 Boot the file specified by the input file path info.\r
1286\r
1287 @param FilePath Point to the file path.\r
1288\r
1289 @retval TRUE Exit caller function.\r
1290 @retval FALSE Not exit caller function.\r
d1102dba 1291\r
4af04335 1292**/\r
d1102dba 1293BOOLEAN\r
bdf0da37 1294EFIAPI\r
4af04335 1295BootFromFile (\r
1436aea4 1296 IN EFI_DEVICE_PATH_PROTOCOL *FilePath\r
4af04335
DB		 1297 );\r
1298\r
1299//\r
1300// Global variable in this program (defined in data.c)\r
1301//\r
1436aea4
MK		 1302extern BM_MENU_OPTION BootOptionMenu;\r
1303extern BM_MENU_OPTION DriverOptionMenu;\r
1304extern BM_MENU_OPTION ConsoleInpMenu;\r
1305extern BM_MENU_OPTION ConsoleOutMenu;\r
1306extern BM_MENU_OPTION ConsoleErrMenu;\r
1307extern BM_MENU_OPTION DriverMenu;\r
1308extern BM_MENU_OPTION TerminalMenu;\r
1309extern UINT16 TerminalType[9];\r
1310extern COM_ATTR BaudRateList[19];\r
1311extern COM_ATTR DataBitsList[4];\r
1312extern COM_ATTR ParityList[5];\r
1313extern COM_ATTR StopBitsList[3];\r
1314extern EFI_GUID TerminalTypeGuid[9];\r
1315extern EFI_DEVICE_PATH_PROTOCOL EndDevicePath[];\r
1316extern UINT16 mFlowControlType[2];\r
1317extern UINT32 mFlowControlValue[2];\r
4af04335
DB		 1318\r
1319//\r
1320// Shared IFR form update data\r
1321//\r
1436aea4
MK		 1322extern VOID *mStartOpCodeHandle;\r
1323extern VOID *mEndOpCodeHandle;\r
1324extern EFI_IFR_GUID_LABEL *mStartLabel;\r
1325extern EFI_IFR_GUID_LABEL *mEndLabel;\r
1326extern BMM_CALLBACK_DATA gBootMaintenancePrivate;\r
1327extern BMM_CALLBACK_DATA *mBmmCallbackInfo;\r
4af04335
DB		 1328\r
1329#endif\r
EFI Development Kit II mirror for PVE