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