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