]> git.proxmox.com Git - mirror_edk2.git/blame - Nt32Pkg/PlatformBdsDxe/Generic/BootMaint/BootMaint.h
Added UEFI Boot Manager definitions to UEFISpec.h and removed from BDS
[mirror_edk2.git] / Nt32Pkg / PlatformBdsDxe / Generic / BootMaint / BootMaint.h
CommitLineData
bc11b829 1/*++\r
2\r
3Copyright (c) 2006, Intel Corporation \r
4All rights reserved. This program and the accompanying materials \r
5are licensed and made available under the terms and conditions of the BSD License \r
6which accompanies this distribution. The full text of the license may be found at \r
7http://opensource.org/licenses/bsd-license.php \r
8 \r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
11\r
12Module Name:\r
13\r
14 BootMaint.h\r
15\r
16Abstract:\r
17\r
18Revision History\r
19\r
20--*/\r
21\r
22#ifndef _BOOT_MAINT_H\r
23#define _BOOT_MAINT_H\r
24\r
40f18da1 25#include "Generic/Bds.h"\r
bc11b829 26#include "Generic/BootMaint/BBSsupport.h"\r
27\r
28//\r
29// Constants which are variable names used to access variables\r
30//\r
31#define VarLegacyDevOrder L"LegacyDevOrder"\r
32\r
33//\r
34// Guid of a NV Variable which store the information about the\r
35// FD/HD/CD/NET/BEV order\r
36//\r
37#define EFI_LEGACY_DEV_ORDER_VARIABLE_GUID \\r
38 { \\r
39 0xa56074db, 0x65fe, 0x45f7, {0xbd, 0x21, 0x2d, 0x2b, 0xdd, 0x8e, 0x96, 0x52 } \\r
40 }\r
41\r
42//\r
43// String Contant\r
44//\r
45#define StrFloppy L"Floppy Drive #%02x"\r
46#define StrHardDisk L"HardDisk Drive #%02x"\r
47#define StrCDROM L"ATAPI CDROM Drive #%02x"\r
48#define StrNET L"NET Drive #%02x"\r
49#define StrBEV L"BEV Drive #%02x"\r
50#define StrFloppyHelp L"Select Floppy Drive #%02x"\r
51#define StrHardDiskHelp L"Select HardDisk Drive #%02x"\r
52#define StrCDROMHelp L"Select ATAPI CDROM Drive #%02x"\r
53#define StrNETHelp L"NET Drive #%02x"\r
54#define StrBEVHelp L"BEV Drive #%02x"\r
55\r
56//\r
57// Constant will be used in display and file system navigation\r
58//\r
59#define UPDATE_DATA_SIZE 0x100000\r
60#define MAX_BBS_OFFSET 0xE000\r
61#define NET_OPTION_OFFSET 0xD800\r
62#define BEV_OPTION_OFFSET 0xD000\r
63#define FD_OPTION_OFFSET 0xC000\r
64#define HD_OPTION_OFFSET 0xB000\r
65#define CD_OPTION_OFFSET 0xA000\r
66#define FILE_OPTION_OFFSET 0x8000\r
67#define FILE_OPTION_MASK 0x7FFF\r
68#define HANDLE_OPTION_OFFSET 0x7000\r
69#define CONSOLE_OPTION_OFFSET 0x0A00\r
70#define TERMINAL_OPTION_OFFSET 0x0700\r
71#define NORMAL_GOTO_OFFSET 0x0100\r
72#define MAX_STRING_TOKEN_COUNT 0x00FF\r
73//\r
74// Variable created with this flag will be "Efi:...."\r
75//\r
76#define VAR_FLAG EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE\r
77\r
78//\r
79// Define Maxmim characters that will be accepted\r
80//\r
81#define MAX_CHAR 480\r
82#define MAX_CHAR_SIZE (MAX_CHAR * 2)\r
83\r
bc11b829 84\r
85//\r
86// Below are the form ids for display, form id is used as callback key value,\r
87// some key value definitions are also defined here. By defining this enum type,\r
88// We can easy know where we are. The int to UINT16 convertion should be ok because\r
89// there is a MAXIMUM_FORM_ID which in within the range of UINT16.\r
90//\r
91typedef enum {\r
92 IplRelative,\r
93 BcvRelative\r
94} BBS_TYPE;\r
95\r
96typedef enum {\r
97 FORM_RESERVED_ID = 0,\r
98 FORM_MAIN_ID, // 0x0001\r
99 FORM_BOOT_ADD_ID, // 0x0002\r
100 FORM_BOOT_DEL_ID, // 0x0003\r
101 FORM_BOOT_CHG_ID, // 0x0004\r
102 FORM_DRV_ADD_ID, // 0x0005\r
103 FORM_DRV_DEL_ID, // 0x0006\r
104 FORM_DRV_CHG_ID, // 0x0007\r
105 FORM_CON_MAIN_ID, // 0x0008\r
106 FORM_CON_IN_ID, // 0x0009\r
107 FORM_CON_OUT_ID, // 0x000A\r
108 FORM_CON_ERR_ID, // 0x000B\r
109 FORM_FILE_SEEK_ID, // 0x000C\r
110 FORM_FILE_NEW_SEEK_ID, // 0x000D\r
111 FORM_DRV_ADD_FILE_ID, // 0x000E\r
112 FORM_DRV_ADD_HANDLE_ID, // 0x000F\r
113 FORM_DRV_ADD_HANDLE_DESC_ID, // 0x0010\r
114 FORM_BOOT_NEXT_ID, // 0x0011\r
115 FORM_TIME_OUT_ID, // 0x0012\r
116 FORM_RESET, // 0x0013\r
117 FORM_BOOT_SETUP_ID, // 0x0014\r
118 FORM_DRIVER_SETUP_ID, // 0x0015\r
119 FORM_BOOT_LEGACY_DEVICE_ID, // 0x0016\r
120 FORM_CON_COM_ID, // 0x0017\r
121 FORM_CON_COM_SETUP_ID, // 0x0018\r
122 FORM_SET_FD_ORDER_ID, // 0x0019\r
123 FORM_SET_HD_ORDER_ID, // 0x001A\r
124 FORM_SET_CD_ORDER_ID, // 0x001B\r
125 FORM_SET_NET_ORDER_ID, // 0x001C\r
126 FORM_SET_BEV_ORDER_ID, // 0x001D\r
127 FORM_FILE_EXPLORER_ID, // 0x001E\r
128 FORM_BOOT_ADD_DESCRIPTION_ID, // 0x001F\r
129 FORM_DRIVER_ADD_FILE_DESCRIPTION_ID, // 0x0020\r
130} FORM_ID;\r
131\r
132#define MAXIMUM_FORM_ID 0x007F\r
133\r
134#define KEY_VALUE_COM_SET_BAUD_RATE 0x0080\r
135#define KEY_VALUE_COM_SET_DATA_BITS 0x0081\r
136#define KEY_VALUE_COM_SET_STOP_BITS 0x0082\r
137#define KEY_VALUE_COM_SET_PARITY 0x0083\r
138#define KEY_VALUE_COM_SET_TERMI_TYPE 0x0084\r
139#define KEY_VALUE_MAIN_BOOT_NEXT 0x0085\r
140#define KEY_VALUE_BOOT_ADD_DESC_DATA 0x0086\r
141#define KEY_VALUE_BOOT_ADD_OPT_DATA 0x0087\r
142#define KEY_VALUE_DRIVER_ADD_DESC_DATA 0x0088\r
143#define KEY_VALUE_DRIVER_ADD_OPT_DATA 0x0089\r
144#define KEY_VALUE_SAVE_AND_EXIT 0x0090\r
145#define KEY_VALUE_NO_SAVE_AND_EXIT 0x0091\r
146#define KEY_VALUE_BOOT_FROM_FILE 0x0092\r
147\r
148#define MAXIMUM_NORMAL_KEY_VALUE NORMAL_GOTO_OFFSET\r
149//\r
150// Below are the number of options in Baudrate, Databits,\r
151// Parity and Stopbits selection for serial ports.\r
152//\r
153#define BM_COM_ATTR_BUADRATE 19\r
154#define BM_COM_ATTR_DATABITS 4\r
155#define BM_COM_ATTR_PARITY 5\r
156#define BM_COM_ATTR_STOPBITS 3\r
157\r
158//\r
159// Callback function helper\r
160//\r
161#define BMM_CALLBACK_DATA_SIGNATURE EFI_SIGNATURE_32 ('C', 'b', 'c', 'k')\r
162#define BMM_CALLBACK_DATA_FROM_THIS(a) CR (a, BMM_CALLBACK_DATA, BmmDriverCallback, BMM_CALLBACK_DATA_SIGNATURE)\r
163\r
164#define FE_CALLBACK_DATA_FROM_THIS(a) CR (a, BMM_CALLBACK_DATA, FeDriverCallback, BMM_CALLBACK_DATA_SIGNATURE)\r
165\r
166//\r
167// Enumeration type definition\r
168//\r
169typedef enum {\r
170 PC_ANSI = 0,\r
171 VT_100,\r
172 VT_100_PLUS,\r
173 VT_UTF8\r
174} TYPE_OF_TERMINAL;\r
175\r
176typedef enum {\r
177 COM1 = 0,\r
178 COM2,\r
179 UNKNOW_COM\r
180} TYPE_OF_COM;\r
181\r
182typedef enum {\r
183 CONIN = 0,\r
184 CONOUT,\r
185 CONERR,\r
186 UNKNOWN_CON\r
187} TYPE_OF_CON;\r
188\r
189typedef enum {\r
190 BAUDRATE = 0,\r
191 DATABITS,\r
192 PARITY,\r
193 STOPBITS,\r
194 UNKNOW_ATTR\r
195} TYPE_OF_ATTRIBUTE;\r
196\r
197typedef enum {\r
198 MANNER_GOTO = 0,\r
199 MANNER_CHECK,\r
200 MANNER_ONEOF,\r
201 MANNER_USER_DEFINE\r
202} TYPE_OF_UPATE_MANNER;\r
203\r
204typedef enum {\r
205 INACTIVE_STATE = 0,\r
206 BOOT_FROM_FILE_STATE,\r
207 ADD_BOOT_OPTION_STATE,\r
208 ADD_DRIVER_OPTION_STATE,\r
209 UNKNOWN_STATE\r
210} FILE_EXPLORER_STATE;\r
211\r
212typedef enum {\r
213 FILE_SYSTEM,\r
214 DIRECTORY,\r
215 UNKNOWN_CONTEXT\r
216} FILE_EXPLORER_DISPLAY_CONTEXT;\r
217\r
218//\r
219// All of the signatures that will be used in list structure\r
220//\r
221#define BM_MENU_OPTION_SIGNATURE 'menu'\r
222#define BM_LOAD_OPTION_SIGNATURE 'load'\r
223#define BM_CONSOLE_OPTION_SIGNATURE 'cnsl'\r
224#define BM_FILE_OPTION_SIGNATURE 'file'\r
225#define BM_HANDLE_OPTION_SIGNATURE 'hndl'\r
226#define BM_TERMINAL_OPTION_SIGNATURE 'trml'\r
227#define BM_MENU_ENTRY_SIGNATURE 'entr'\r
228\r
229#define BM_LOAD_CONTEXT_SELECT 0x0\r
230#define BM_CONSOLE_CONTEXT_SELECT 0x1\r
231#define BM_FILE_CONTEXT_SELECT 0x2\r
232#define BM_HANDLE_CONTEXT_SELECT 0x3\r
233#define BM_TERMINAL_CONTEXT_SELECT 0x5\r
234\r
235#define BM_CONSOLE_IN_CONTEXT_SELECT 0x6\r
236#define BM_CONSOLE_OUT_CONTEXT_SELECT 0x7\r
237#define BM_CONSOLE_ERR_CONTEXT_SELECT 0x8\r
238#define BM_LEGACY_DEV_CONTEXT_SELECT 0x9\r
239\r
240//\r
241// Question Id that will be used to create question\r
242// all these values are computed from the structure\r
243// defined below\r
244//\r
245#define QUESTION_ID(Field) ((UINTN) &(((BMM_FAKE_NV_DATA *) 0)->Field))\r
246\r
247#define BOOT_TIME_OUT_QUESTION_ID QUESTION_ID (BootTimeOut)\r
248#define BOOT_NEXT_QUESTION_ID QUESTION_ID (BootNext)\r
249#define COM1_BAUD_RATE_QUESTION_ID QUESTION_ID (COM1BaudRate)\r
250#define COM1_DATA_RATE_QUESTION_ID QUESTION_ID (COM1DataRate)\r
251#define COM1_STOP_BITS_QUESTION_ID QUESTION_ID (COM1StopBits)\r
252#define COM1_PARITY_QUESTION_ID QUESTION_ID (COM1Parity)\r
253#define COM1_TERMINAL_QUESTION_ID QUESTION_ID (COM2TerminalType)\r
254#define COM2_BAUD_RATE_QUESTION_ID QUESTION_ID (COM2BaudRate)\r
255#define COM2_DATA_RATE_QUESTION_ID QUESTION_ID (COM2DataRate)\r
256#define COM2_STOP_BITS_QUESTION_ID QUESTION_ID (COM2StopBits)\r
257#define COM2_PARITY_QUESTION_ID QUESTION_ID (COM2Parity)\r
258#define COM2_TERMINAL_QUESTION_ID QUESTION_ID (COM2TerminalType)\r
259#define DRV_ADD_HANDLE_DESC_QUESTION_ID QUESTION_ID (DriverAddHandleDesc)\r
260#define DRV_ADD_ACTIVE_QUESTION_ID QUESTION_ID (DriverAddActive)\r
261#define DRV_ADD_RECON_QUESTION_ID QUESTION_ID (DriverAddForceReconnect)\r
262#define CON_IN_COM1_QUESTION_ID QUESTION_ID (ConsoleInputCOM1)\r
263#define CON_IN_COM2_QUESTION_ID QUESTION_ID (ConsoleInputCOM2)\r
264#define CON_OUT_COM1_QUESTION_ID QUESTION_ID (ConsoleOutputCOM1)\r
265#define CON_OUT_COM2_QUESTION_ID QUESTION_ID (ConsoleOutputCOM2)\r
266#define CON_ERR_COM1_QUESTION_ID QUESTION_ID (ConsoleErrorCOM1)\r
267#define CON_ERR_COM2_QUESTION_ID QUESTION_ID (ConsoleErrorCOM2)\r
268#define CON_DEVICE_QUESTION_ID QUESTION_ID (ConsoleCheck)\r
269#define OPTION_ORDER_QUESTION_ID QUESTION_ID (OptionOrder)\r
270#define DRIVER_OPTION_ORDER_QUESTION_ID QUESTION_ID (DriverOptionToBeDeleted)\r
271#define BOOT_OPTION_DEL_QUESTION_ID QUESTION_ID (BootOptionDel)\r
272#define DRIVER_OPTION_DEL_QUESTION_ID QUESTION_ID (DriverOptionDel)\r
273#define DRIVER_ADD_OPTION_QUESTION_ID QUESTION_ID (DriverAddHandleOptionalData)\r
274#define COM_BAUD_RATE_QUESTION_ID QUESTION_ID (COMBaudRate)\r
275#define COM_DATA_RATE_QUESTION_ID QUESTION_ID (COMDataRate)\r
276#define COM_STOP_BITS_QUESTION_ID QUESTION_ID (COMStopBits)\r
277#define COM_PARITY_QUESTION_ID QUESTION_ID (COMParity)\r
278#define COM_TERMINAL_QUESTION_ID QUESTION_ID (COMTerminalType)\r
279#define LEGACY_FD_QUESTION_ID QUESTION_ID (LegacyFD)\r
280#define LEGACY_HD_QUESTION_ID QUESTION_ID (LegacyHD)\r
281#define LEGACY_CD_QUESTION_ID QUESTION_ID (LegacyCD)\r
282#define LEGACY_NET_QUESTION_ID QUESTION_ID (LegacyNET)\r
283#define LEGACY_BEV_QUESTION_ID QUESTION_ID (LegacyBEV)\r
284\r
285#define STRING_DEPOSITORY_NUMBER 8\r
286\r
287//\r
288// #pragma pack(1)\r
289//\r
290// Serial Ports attributes, first one is the value for\r
291// return from callback function, stringtoken is used to\r
292// display the value properly\r
293//\r
294typedef struct {\r
295 UINTN Value;\r
296 UINT16 StringToken;\r
297} COM_ATTR;\r
298\r
299//\r
300// This is the structure that will be used to store the\r
301// question's current value. Use it at initialize time to\r
302// set default value for each question. When using at run\r
303// time, this map is returned by the callback function,\r
304// so dynamically changing the question's value will be\r
305// possible through this mechanism\r
306//\r
307typedef struct {\r
308 //\r
309 // Three questions displayed at the main page\r
310 // for Timeout, BootNext Variables respectively\r
311 //\r
312 UINT16 BootTimeOut;\r
313 UINT16 BootNext;\r
314\r
315 //\r
316 // This is the COM1 Attributes value storage\r
317 //\r
318 UINT8 COM1BaudRate;\r
319 UINT8 COM1DataRate;\r
320 UINT8 COM1StopBits;\r
321 UINT8 COM1Parity;\r
322 UINT8 COM1TerminalType;\r
323\r
324 //\r
325 // This is the COM2 Attributes value storage\r
326 //\r
327 UINT8 COM2BaudRate;\r
328 UINT8 COM2DataRate;\r
329 UINT8 COM2StopBits;\r
330 UINT8 COM2Parity;\r
331 UINT8 COM2TerminalType;\r
332\r
333 //\r
334 // Driver Option Add Handle page storage\r
335 //\r
336 UINT16 DriverAddHandleDesc[100];\r
337 UINT16 DriverAddHandleOptionalData[100];\r
338 UINT8 DriverAddActive;\r
339 UINT8 DriverAddForceReconnect;\r
340\r
341 //\r
342 // Console Input/Output/Errorout using COM port check storage\r
343 //\r
344 UINT8 ConsoleInputCOM1;\r
345 UINT8 ConsoleInputCOM2;\r
346 UINT8 ConsoleOutputCOM1;\r
347 UINT8 ConsoleOutputCOM2;\r
348 UINT8 ConsoleErrorCOM1;\r
349 UINT8 ConsoleErrorCOM2;\r
350\r
351 //\r
352 // At most 100 input/output/errorout device for console storage\r
353 //\r
354 UINT8 ConsoleCheck[100];\r
355\r
356 //\r
357 // Boot or Driver Option Order storage\r
358 //\r
359 UINT8 OptionOrder[100];\r
360 UINT8 DriverOptionToBeDeleted[100];\r
361\r
362 //\r
363 // Boot Option Delete storage\r
364 //\r
365 UINT8 BootOptionDel[100];\r
366 UINT8 DriverOptionDel[100];\r
367\r
368 //\r
369 // This is the Terminal Attributes value storage\r
370 //\r
371 UINT8 COMBaudRate;\r
372 UINT8 COMDataRate;\r
373 UINT8 COMStopBits;\r
374 UINT8 COMParity;\r
375 UINT8 COMTerminalType;\r
376\r
377 //\r
378 // Legacy Device Order Selection Storage\r
379 //\r
380 UINT8 LegacyFD[100];\r
381 UINT8 LegacyHD[100];\r
382 UINT8 LegacyCD[100];\r
383 UINT8 LegacyNET[100];\r
384 UINT8 LegacyBEV[100];\r
385\r
386 //\r
387 // We use DisableMap array to record the enable/disable state of each boot device\r
388 // It should be taken as a bit array, from left to right there are totally 256 bits\r
389 // the most left one stands for BBS table item 0, and the most right one stands for item 256\r
390 // If the bit is 1, it means the boot device has been disabled.\r
391 //\r
392 UINT8 DisableMap[32];\r
393\r
394 //\r
395 // UINT16 PadArea[10];\r
396 //\r
397} BMM_FAKE_NV_DATA;\r
398\r
399typedef struct {\r
400 UINT16 DescriptionData[75];\r
401 UINT16 OptionalData[127];\r
402 UINT8 Active;\r
403 UINT8 ForceReconnect;\r
404} FILE_EXPLORER_NV_DATA;\r
405\r
406typedef struct {\r
407 BBS_TYPE BbsType;\r
408 //\r
409 // Length = sizeof (UINT16) + SIZEOF (Data)\r
410 //\r
411 UINT16 Length;\r
412 UINT16 *Data;\r
413} BM_LEGACY_DEV_ORDER_CONTEXT;\r
414\r
415typedef struct {\r
416 UINT64 BaudRate;\r
417 UINT8 DataBits;\r
418 UINT8 Parity;\r
419 UINT8 StopBits;\r
420\r
421 UINT8 BaudRateIndex;\r
422 UINT8 DataBitsIndex;\r
423 UINT8 ParityIndex;\r
424 UINT8 StopBitsIndex;\r
425\r
426 UINT8 IsConIn;\r
427 UINT8 IsConOut;\r
428 UINT8 IsStdErr;\r
429 UINT8 TerminalType;\r
430\r
431 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
432} BM_TERMINAL_CONTEXT;\r
433\r
434typedef struct {\r
435 BOOLEAN IsBootNext;\r
436 BOOLEAN LoadOptionModified;\r
437 BOOLEAN Deleted;\r
438\r
439 BOOLEAN IsLegacy;\r
440 BOOLEAN IsActive;\r
441 BOOLEAN ForceReconnect;\r
442 UINTN OptionalDataSize;\r
443\r
444 UINTN LoadOptionSize;\r
445 UINT8 *LoadOption;\r
446\r
447 UINT32 Attributes;\r
448 UINT16 FilePathListLength;\r
449 UINT16 *Description;\r
450 EFI_DEVICE_PATH_PROTOCOL *FilePathList;\r
451 UINT8 *OptionalData;\r
452\r
453 UINT16 BbsIndex;\r
454} BM_LOAD_CONTEXT;\r
455\r
456typedef struct {\r
457 BBS_TABLE *BbsTable;\r
458 UINTN Index;\r
459 UINTN BbsCount;\r
460 UINT16 *Description;\r
461} BM_LEGACY_DEVICE_CONTEXT;\r
462\r
463typedef struct {\r
464\r
465 BOOLEAN IsActive;\r
466\r
467 BOOLEAN IsTerminal;\r
468\r
469 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
470} BM_CONSOLE_CONTEXT;\r
471\r
472typedef struct {\r
473 EFI_HANDLE Handle;\r
474 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
475 EFI_FILE_HANDLE FHandle;\r
476 UINT16 *FileName;\r
477 EFI_FILE_SYSTEM_VOLUME_LABEL_INFO *Info;\r
478\r
479 BOOLEAN IsRoot;\r
480 BOOLEAN IsDir;\r
481 BOOLEAN IsRemovableMedia;\r
482 BOOLEAN IsLoadFile;\r
483 BOOLEAN IsBootLegacy;\r
484} BM_FILE_CONTEXT;\r
485\r
486typedef struct {\r
487 EFI_HANDLE Handle;\r
488 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
489} BM_HANDLE_CONTEXT;\r
490\r
491typedef struct {\r
492 UINTN Signature;\r
493 LIST_ENTRY Head;\r
494 UINTN MenuNumber;\r
495} BM_MENU_OPTION;\r
496\r
497typedef struct {\r
498 UINTN Signature;\r
499 LIST_ENTRY Link;\r
500 UINTN OptionNumber;\r
501 UINT16 *DisplayString;\r
502 UINT16 *HelpString;\r
503 STRING_REF DisplayStringToken;\r
504 STRING_REF HelpStringToken;\r
505 UINTN ContextSelection;\r
506 VOID *VariableContext;\r
507} BM_MENU_ENTRY;\r
508\r
509typedef struct {\r
510 //\r
511 // Shared callback data.\r
512 //\r
513 UINTN Signature;\r
514 EFI_HII_PROTOCOL *Hii;\r
515 BM_MENU_ENTRY *MenuEntry;\r
516 BM_HANDLE_CONTEXT *HandleContext;\r
517 BM_FILE_CONTEXT *FileContext;\r
518 BM_LOAD_CONTEXT *LoadContext;\r
519 BM_TERMINAL_CONTEXT *TerminalContext;\r
520 UINTN CurrentTerminal;\r
521 BBS_TYPE BbsType;\r
522\r
523 //\r
524 // BMM main formset callback data.\r
525 //\r
526 EFI_HII_HANDLE BmmHiiHandle;\r
527 EFI_HANDLE BmmCallbackHandle;\r
528 EFI_FORM_CALLBACK_PROTOCOL BmmDriverCallback;\r
529 FORM_ID BmmCurrentPageId;\r
530 FORM_ID BmmPreviousPageId;\r
531 BOOLEAN BmmAskSaveOrNot;\r
532 BMM_FAKE_NV_DATA *BmmFakeNvData;\r
533 BMM_FAKE_NV_DATA BmmOldFakeNVData;\r
534\r
535 //\r
536 // File explorer formset callback data.\r
537 //\r
538 EFI_HII_HANDLE FeHiiHandle;\r
539 EFI_HANDLE FeCallbackHandle;\r
540 EFI_FORM_CALLBACK_PROTOCOL FeDriverCallback;\r
541 FILE_EXPLORER_STATE FeCurrentState;\r
542 FILE_EXPLORER_DISPLAY_CONTEXT FeDisplayContext;\r
543} BMM_CALLBACK_DATA;\r
544\r
545typedef struct _STRING_LIST_NODE {\r
546 STRING_REF StringToken;\r
547 struct _STRING_LIST_NODE *Next;\r
548} STRING_LIST_NODE;\r
549\r
550typedef struct _STRING_DEPOSITORY {\r
551 UINTN TotalNodeNumber;\r
552 STRING_LIST_NODE *CurrentNode;\r
553 STRING_LIST_NODE *ListHead;\r
554} STRING_DEPOSITORY;\r
555\r
556//\r
557// #pragma pack()\r
558//\r
559// For initializing File System menu\r
560//\r
561EFI_STATUS\r
562BOpt_FindFileSystem (\r
563 IN BMM_CALLBACK_DATA *CallbackData\r
564 )\r
565;\r
566\r
567//\r
568// For cleaning up File System menu\r
569//\r
570VOID\r
571BOpt_FreeFileSystem (\r
572 VOID\r
573 )\r
574;\r
575\r
576//\r
577// For initializing File Navigation menu\r
578//\r
579EFI_STATUS\r
580BOpt_FindFiles (\r
581 IN BMM_CALLBACK_DATA *CallbackData,\r
582 IN BM_MENU_ENTRY *MenuEntry\r
583 )\r
584;\r
585\r
586//\r
587// For cleaning up File Navigation menu\r
588//\r
589VOID\r
590BOpt_FreeFiles (\r
591 VOID\r
592 )\r
593;\r
594\r
595//\r
596// For Initializing handle navigation menu\r
597//\r
598EFI_STATUS\r
599BOpt_FindDrivers (\r
600 VOID\r
601 )\r
602;\r
603\r
604//\r
605// For Cleaning up handle navigation menu\r
606//\r
607VOID\r
608BOpt_FreeDrivers();\r
609\r
610//\r
611// For initializing Boot Option menu\r
612//\r
613EFI_STATUS\r
614BOpt_GetBootOptions (\r
615 IN BMM_CALLBACK_DATA *CallbackData\r
616 );\r
617\r
618//\r
619// For Initializing Driver option menu\r
620//\r
621EFI_STATUS\r
622BOpt_GetDriverOptions (\r
623 IN BMM_CALLBACK_DATA *CallbackData\r
624 );\r
625\r
626//\r
627// For Cleaning up boot option menu\r
628//\r
629VOID\r
630BOpt_FreeBootOptions ();\r
631\r
632//\r
633// For cleaning up driver option menu\r
634//\r
635VOID\r
636BOpt_FreeDriverOptions();\r
637\r
638//\r
639// For Initializing HD/FD/CD/NET/BEV option menu\r
640//\r
641EFI_STATUS\r
642BOpt_GetLegacyOptions();\r
643\r
644//\r
645// For cleaning up driver option menu\r
646//\r
647VOID\r
648BOpt_FreeLegacyOptions();\r
649\r
650//\r
651// this function is used to take place of all other free menu actions\r
652//\r
653VOID\r
654BOpt_FreeMenu (\r
655 BM_MENU_OPTION *FreeMenu\r
656 );\r
657\r
658\r
659//\r
660// Following are the helper functions used\r
661//\r
662CHAR16 *\r
663BOpt_AppendFileName (\r
664 IN CHAR16 *Str1,\r
665 IN CHAR16 *Str2\r
666 );\r
667\r
668BOOLEAN\r
669BOpt_IsEfiImageName (\r
670 IN UINT16 *FileName\r
671 );\r
672\r
673BOOLEAN\r
674BOpt_IsEfiApp (\r
675 IN EFI_FILE_HANDLE Dir,\r
676 IN UINT16 *FileName\r
677 );\r
678\r
679//\r
680// Get current unused boot option number\r
681//\r
682UINT16\r
683BOpt_GetBootOptionNumber ();\r
684\r
685//\r
686// Get current unused driver option number\r
687//\r
688UINT16\r
689BOpt_GetDriverOptionNumber ();\r
690\r
691BM_MENU_ENTRY *\r
692BOpt_CreateMenuEntry (\r
693 UINTN MenuType\r
694 );\r
695\r
696VOID\r
697BOpt_DestroyMenuEntry (\r
698 BM_MENU_ENTRY *MenuEntry\r
699 );\r
700\r
701BM_MENU_ENTRY *\r
702BOpt_GetMenuEntry (\r
703 BM_MENU_OPTION *MenuOption,\r
704 UINTN MenuNumber\r
705 );\r
706\r
707//\r
708// a helper function used to free pool type memory\r
709//\r
710VOID\r
711SafeFreePool (\r
712 IN VOID *Buffer\r
713 );\r
714\r
715//\r
716// Locate all serial io devices for console\r
717//\r
718EFI_STATUS\r
719LocateSerialIo ();\r
720\r
721//\r
722// Initializing Console menu\r
723//\r
724EFI_STATUS\r
725GetAllConsoles();\r
726\r
727//\r
728// Cleaning up console menu\r
729//\r
730EFI_STATUS\r
731FreeAllConsoles();\r
732\r
733VOID\r
734ChangeVariableDevicePath (\r
735 EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
736); \r
737\r
738EFI_STATUS\r
739ChangeTerminalDevicePath (\r
740 EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
741 BOOLEAN ChangeTerminal\r
742);\r
743//\r
744// Variable operation by menu selection\r
745//\r
746EFI_STATUS\r
747Var_UpdateBootOption (\r
748 IN BMM_CALLBACK_DATA *CallbackData,\r
749 IN FILE_EXPLORER_NV_DATA *NvRamMap\r
750 );\r
751\r
752EFI_STATUS\r
753Var_DelBootOption ();\r
754\r
755EFI_STATUS\r
756Var_ChangeBootOrder ();\r
757\r
758EFI_STATUS\r
759Var_UpdateDriverOption (\r
760 IN BMM_CALLBACK_DATA *CallbackData,\r
761 IN EFI_HII_HANDLE HiiHandle,\r
762 IN UINT16 *DescriptionData,\r
763 IN UINT16 *OptionalData,\r
764 IN UINT8 ForceReconnect\r
765 );\r
766\r
767EFI_STATUS\r
768Var_DelDriverOption ();\r
769\r
770EFI_STATUS\r
771Var_ChangeDriverOrder ();\r
772\r
773EFI_STATUS\r
774Var_UpdateConsoleInpOption ();\r
775\r
776EFI_STATUS\r
777Var_UpdateConsoleOutOption ();\r
778\r
779EFI_STATUS\r
780Var_UpdateErrorOutOption ();\r
781\r
782VOID\r
783Var_UpdateAllConsoleOption ();\r
784\r
785EFI_STATUS\r
786Var_UpdateBootNext (\r
787 IN BMM_CALLBACK_DATA *CallbackData\r
788 );\r
789\r
790EFI_STATUS\r
791Var_UpdateBootOrder (\r
792 IN BMM_CALLBACK_DATA *CallbackData\r
793 );\r
794\r
795EFI_STATUS\r
796Var_UpdateDriverOrder (\r
797 IN BMM_CALLBACK_DATA *CallbackData\r
798 );\r
799\r
800EFI_STATUS\r
801Var_UpdateBBSOption (\r
802 IN BMM_CALLBACK_DATA *CallbackData\r
803 );\r
804\r
805//\r
806// Following are page create and refresh functions\r
807//\r
808VOID\r
809RefreshUpdateData (\r
810 IN BOOLEAN FormSetUpdate,\r
811 IN EFI_PHYSICAL_ADDRESS FormCallbackHandle,\r
812 IN BOOLEAN FormUpdate,\r
813 IN STRING_REF FormTitle,\r
814 IN UINT16 DataCount\r
815 );\r
816\r
817VOID\r
818CleanUpPage (\r
819 IN EFI_FORM_LABEL LabelId,\r
820 IN BMM_CALLBACK_DATA *CallbackData\r
821 );\r
822\r
823EFI_STATUS\r
824UpdatePage (\r
825 IN BMM_CALLBACK_DATA *CallbackData,\r
826 IN BM_MENU_OPTION *UpdatingMenu,\r
827 IN UINT16 UpdatingPage,\r
828 IN UINT16 UpdatingManner,\r
829 IN UINT16 QuestionIdStart,\r
830 IN UINT16 GotoForm,\r
831 IN UINT16 GotoAlternateForm,\r
832 IN STRING_REF DisplayTokenStart,\r
833 IN STRING_REF HelpTokenStart,\r
834 IN UINT16 KeyValueStart\r
835 );\r
836\r
837VOID\r
838UpdateBootAddPage (\r
839 IN BMM_CALLBACK_DATA *CallbackData\r
840 );\r
841\r
842VOID\r
843UpdateBootDelPage (\r
844 IN BMM_CALLBACK_DATA *CallbackData\r
845 );\r
846\r
847VOID\r
848UpdateDrvAddFilePage (\r
849 IN BMM_CALLBACK_DATA *CallbackData\r
850 );\r
851\r
852VOID\r
853UpdateDrvAddHandlePage (\r
854 IN BMM_CALLBACK_DATA *CallbackData\r
855 );\r
856\r
857VOID\r
858UpdateDrvDelPage (\r
859 IN BMM_CALLBACK_DATA *CallbackData\r
860 );\r
861\r
862VOID\r
863UpdateDriverAddHandleDescPage (\r
864 IN BMM_CALLBACK_DATA *CallbackData\r
865 );\r
866\r
867VOID\r
868UpdateBootTimeOut (\r
869 IN BMM_CALLBACK_DATA *CallbackData\r
870 );\r
871\r
872VOID\r
873UpdateConInPage (\r
874 IN BMM_CALLBACK_DATA *CallbackData\r
875 );\r
876\r
877VOID\r
878UpdateConOutPage (\r
879 IN BMM_CALLBACK_DATA *CallbackData\r
880 );\r
881\r
882VOID\r
883UpdateStdErrPage (\r
884 IN BMM_CALLBACK_DATA *CallbackData\r
885 );\r
886\r
887VOID\r
888UpdatePageBody (\r
889 IN UINT16 UpdatePageId,\r
890 IN BMM_CALLBACK_DATA *CallbackData\r
891 );\r
892\r
893VOID\r
894UpdateCOM1Page (\r
895 IN BMM_CALLBACK_DATA *CallbackData\r
896 );\r
897\r
898VOID\r
899UpdateCOM2Page (\r
900 IN BMM_CALLBACK_DATA *CallbackData\r
901 );\r
902\r
903VOID\r
904UpdateBootOrderPage (\r
905 IN BMM_CALLBACK_DATA *CallbackData\r
906 );\r
907\r
908VOID\r
909UpdateDriverOrderPage (\r
910 IN BMM_CALLBACK_DATA *CallbackData\r
911 );\r
912\r
913VOID\r
914UpdateBootNextPage (\r
915 IN BMM_CALLBACK_DATA *CallbackData\r
916 );\r
917\r
918VOID\r
919UpdateTimeOutPage (\r
920 IN BMM_CALLBACK_DATA *CallbackData\r
921 );\r
922\r
923VOID\r
924UpdateTerminalPage (\r
925 IN BMM_CALLBACK_DATA *CallbackData\r
926 );\r
927\r
928VOID\r
929UpdateConCOMPage (\r
930 IN BMM_CALLBACK_DATA *CallbackData\r
931 );\r
932\r
933VOID\r
934UpdateSetLegacyDeviceOrderPage (\r
935 IN UINT16 UpdatePageId,\r
936 IN BMM_CALLBACK_DATA *CallbackData\r
937);\r
938\r
939EFI_STATUS\r
940BootLegacy (\r
941 IN UINT16 BbsType,\r
942 IN UINT16 BbsFlag\r
943);\r
944\r
945BM_MENU_ENTRY *\r
946GetCurrentTerminal (\r
947 UINTN TerminalNumber\r
948);\r
949\r
950EFI_FILE_HANDLE\r
951EfiLibOpenRoot (\r
952 IN EFI_HANDLE DeviceHandle\r
953 );\r
954\r
955EFI_FILE_SYSTEM_VOLUME_LABEL_INFO *\r
956EfiLibFileSystemVolumeLabelInfo (\r
957 IN EFI_FILE_HANDLE FHand\r
958 );\r
959\r
960EFI_FILE_INFO *\r
961EfiLibFileInfo (\r
962 IN EFI_FILE_HANDLE FHand\r
963 );\r
964\r
965CHAR16 *\r
966DevicePathToStr (\r
967 EFI_DEVICE_PATH_PROTOCOL *DevPath\r
968 );\r
969\r
970EFI_STATUS\r
971EfiLibLocateProtocol (\r
972 IN EFI_GUID *ProtocolGuid,\r
973 OUT VOID **Interface\r
974 );\r
975\r
976VOID *\r
977EfiReallocatePool (\r
978 IN VOID *OldPool,\r
979 IN UINTN OldSize,\r
980 IN UINTN NewSize\r
981 );\r
982\r
983CHAR16 *\r
984DevicePathToStr (\r
985 EFI_DEVICE_PATH_PROTOCOL *DevPath\r
986 );\r
987\r
988VOID *\r
989BdsLibGetVariableAndSize (\r
990 IN CHAR16 *Name,\r
991 IN EFI_GUID *VendorGuid,\r
992 OUT UINTN *VarSize\r
993 );\r
994\r
995EFI_STATUS\r
996EfiLibDeleteVariable (\r
997 IN CHAR16 *VarName,\r
998 IN EFI_GUID *VarGuid\r
999 );\r
1000\r
1001CHAR16 *\r
1002EfiStrDuplicate (\r
1003 IN CHAR16 *Src\r
1004 );\r
1005\r
1006BOOLEAN\r
1007EfiLibMatchDevicePaths (\r
1008 IN EFI_DEVICE_PATH_PROTOCOL *Multi,\r
1009 IN EFI_DEVICE_PATH_PROTOCOL *Single\r
1010 );\r
1011\r
1012UINTN\r
1013EfiDevicePathInstanceCount (\r
1014 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
1015 );\r
1016\r
1017EFI_STATUS\r
1018CreateMenuStringToken (\r
1019 IN BMM_CALLBACK_DATA *CallbackData,\r
1020 IN EFI_HII_HANDLE HiiHandle,\r
1021 IN BM_MENU_OPTION *MenuOption\r
1022 );\r
1023\r
1024UINT16 *\r
1025EfiLibStrFromDatahub (\r
1026 IN EFI_DEVICE_PATH_PROTOCOL *DevPath\r
1027 );\r
1028\r
1029VOID *\r
1030GetLegacyBootOptionVar (\r
1031 IN UINTN DeviceType,\r
1032 OUT UINTN *OptionIndex,\r
1033 OUT UINTN *OptionSize\r
1034 );\r
1035\r
1036EFI_STATUS\r
1037InitializeBM (\r
1038 VOID\r
1039 );\r
1040\r
1041EFI_STATUS\r
1042BdsStartBootMaint (\r
1043 VOID\r
1044 );\r
1045\r
1046VOID\r
1047InitializeStringDepository ();\r
1048\r
1049STRING_REF\r
1050GetStringTokenFromDepository (\r
1051 IN BMM_CALLBACK_DATA *CallbackData,\r
1052 IN STRING_DEPOSITORY *StringDepository\r
1053 ) ;\r
1054\r
1055VOID\r
1056ReclaimStringDepository (\r
1057 VOID\r
1058 );\r
1059\r
1060VOID\r
1061CleanUpStringDepository (\r
1062 VOID\r
1063 );\r
1064\r
1065EFI_STATUS\r
1066ApplyChangeHandler (\r
1067 IN BMM_CALLBACK_DATA *Private,\r
1068 IN BMM_FAKE_NV_DATA *CurrentFakeNVMap,\r
1069 IN FORM_ID FormId\r
1070 );\r
1071\r
1072VOID\r
1073DiscardChangeHandler (\r
1074 IN BMM_CALLBACK_DATA *Private,\r
1075 IN BMM_FAKE_NV_DATA *CurrentFakeNVMap\r
1076 );\r
1077\r
1078VOID\r
1079UpdatePageId (\r
1080 BMM_CALLBACK_DATA *Private,\r
1081 UINT16 NewPageId\r
1082 );\r
1083\r
1084EFI_STATUS\r
1085BootThisFile (\r
1086 IN BM_FILE_CONTEXT *FileContext\r
1087 );\r
1088\r
1089BOOLEAN\r
1090UpdateFileExplorer (\r
1091 IN BMM_CALLBACK_DATA *CallbackData,\r
1092 IN UINT16 KeyValue\r
1093 );\r
1094\r
1095EFI_STATUS\r
1096EFIAPI\r
1097FileExplorerCallback (\r
1098 IN EFI_FORM_CALLBACK_PROTOCOL *This,\r
1099 IN UINT16 KeyValue,\r
1100 IN EFI_IFR_DATA_ARRAY *Data,\r
1101 OUT EFI_HII_CALLBACK_PACKET **Packet\r
1102 );\r
1103\r
1104EFI_STATUS\r
1105FormSetDispatcher (\r
1106 IN BMM_CALLBACK_DATA *CallbackData\r
1107 );\r
1108\r
1109VOID CreateCallbackPacket (\r
1110 OUT EFI_HII_CALLBACK_PACKET **Packet,\r
1111 IN UINT16 Flags\r
1112 );\r
1113\r
1114//\r
1115// Global variable in this program (defined in data.c)\r
1116//\r
1117extern BM_MENU_OPTION BootOptionMenu;\r
1118extern BM_MENU_OPTION DriverOptionMenu;\r
1119extern BM_MENU_OPTION FsOptionMenu;\r
1120extern BM_MENU_OPTION ConsoleInpMenu;\r
1121extern BM_MENU_OPTION ConsoleOutMenu;\r
1122extern BM_MENU_OPTION ConsoleErrMenu;\r
1123extern BM_MENU_OPTION DirectoryMenu;\r
1124extern BM_MENU_OPTION DriverMenu;\r
1125extern BM_MENU_OPTION TerminalMenu;\r
1126extern BM_MENU_OPTION LegacyFDMenu;\r
1127extern BM_MENU_OPTION LegacyHDMenu;\r
1128extern BM_MENU_OPTION LegacyCDMenu;\r
1129extern BM_MENU_OPTION LegacyNETMenu;\r
1130extern BM_MENU_OPTION LegacyBEVMenu;\r
1131extern UINT16 TerminalType[];\r
1132extern COM_ATTR BaudRateList[19];\r
1133extern COM_ATTR DataBitsList[4];\r
1134extern COM_ATTR ParityList[5];\r
1135extern COM_ATTR StopBitsList[3];\r
1136extern EFI_GUID Guid[4];\r
1137extern EFI_HII_UPDATE_DATA *UpdateData;\r
1138extern STRING_DEPOSITORY *FileOptionStrDepository;\r
1139extern STRING_DEPOSITORY *ConsoleOptionStrDepository;\r
1140extern STRING_DEPOSITORY *BootOptionStrDepository;\r
1141extern STRING_DEPOSITORY *BootOptionHelpStrDepository;\r
1142extern STRING_DEPOSITORY *DriverOptionStrDepository;\r
1143extern STRING_DEPOSITORY *DriverOptionHelpStrDepository;\r
1144extern STRING_DEPOSITORY *TerminalStrDepository;\r
1145extern EFI_DEVICE_PATH_PROTOCOL EndDevicePath[];\r
1146extern EFI_GUID EfiLegacyDevOrderGuid;\r
1147\r
1148#endif\r