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