IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h

   1 /** @file
   2   Header file for boot maintenance module.
   3
   4 Copyright (c) 2004 - 2008, Intel Corporation. <BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _BOOT_MAINT_H_
  16 #define _BOOT_MAINT_H_
  17
  18 #include "Bds.h"
  19 #include "BBSsupport.h"
  20 #include "FormGuid.h"
  21 #include "FrontPage.h"
  22
  23 //
  24 // Constants which are variable names used to access variables
  25 //
  26 #define VAR_LEGACY_DEV_ORDER L"LegacyDevOrder"
  27
  28 #define VAR_CON_OUT_MODE L"ConOutMode"
  29
  30 ///
  31 /// Guid of a NV Variable which store the information about the
  32 /// FD/HD/CD/NET/BEV order
  33 ///
  34 #define EFI_LEGACY_DEV_ORDER_VARIABLE_GUID \
  35   { \
  36   0xa56074db, 0x65fe, 0x45f7, {0xbd, 0x21, 0x2d, 0x2b, 0xdd, 0x8e, 0x96, 0x52} \
  37   }
  38
  39 //
  40 // String Contant
  41 //
  42 #define STR_FLOPPY       L"Floppy Drive #%02x"
  43 #define STR_HARDDISK     L"HardDisk Drive #%02x"
  44 #define STR_CDROM        L"ATAPI CDROM Drive #%02x"
  45 #define STR_NET          L"NET Drive #%02x"
  46 #define STR_BEV          L"BEV Drive #%02x"
  47 #define STR_FLOPPY_HELP   L"Select Floppy Drive #%02x"
  48 #define STR_HARDDISK_HELP L"Select HardDisk Drive #%02x"
  49 #define STR_CDROM_HELP    L"Select ATAPI CDROM Drive #%02x"
  50 #define STR_NET_HELP      L"NET Drive #%02x"
  51 #define STR_BEV_HELP      L"BEV Drive #%02x"
  52
  53 //
  54 // Variable created with this flag will be "Efi:...."
  55 //
  56 #define VAR_FLAG  EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE
  57
  58 //
  59 // Define Maxmim characters that will be accepted
  60 //
  61 #define MAX_CHAR      480
  62 #define MAX_CHAR_SIZE (MAX_CHAR * 2)
  63
  64 extern EFI_GUID mBootMaintGuid;
  65 extern EFI_GUID mFileExplorerGuid;
  66 extern CHAR16   mFileExplorerStorageName[];
  67 extern CHAR16   mBootMaintStorageName[];
  68 //
  69 // These are the VFR compiler generated data representing our VFR data.
  70 //
  71 extern UINT8    BmBin[];
  72 extern UINT8    FEBin[];
  73
  74 //
  75 // Below are the number of options in Baudrate, Databits,
  76 // Parity and Stopbits selection for serial ports.
  77 //
  78 #define BM_COM_ATTR_BUADRATE  19
  79 #define BM_COM_ATTR_DATABITS  4
  80 #define BM_COM_ATTR_PARITY    5
  81 #define BM_COM_ATTR_STOPBITS  3
  82
  83 //
  84 // Callback function helper
  85 //
  86 #define BMM_CALLBACK_DATA_SIGNATURE     SIGNATURE_32 ('C', 'b', 'c', 'k')
  87 #define BMM_CALLBACK_DATA_FROM_THIS(a)  CR (a, BMM_CALLBACK_DATA, BmmConfigAccess, BMM_CALLBACK_DATA_SIGNATURE)
  88
  89 #define FE_CALLBACK_DATA_FROM_THIS(a)   CR (a, BMM_CALLBACK_DATA, FeConfigAccess, BMM_CALLBACK_DATA_SIGNATURE)
  90
  91 //
  92 // Enumeration type definition
  93 //
  94 typedef UINT8 BBS_TYPE;
  95
  96 typedef enum {
  97   PC_ANSI                             = 0,
  98   VT_100,
  99   VT_100_PLUS,
 100   VT_UTF8
 101 } TYPE_OF_TERMINAL;
 102
 103 typedef enum {
 104   COM1                                = 0,
 105   COM2,
 106   UNKNOW_COM
 107 } TYPE_OF_COM;
 108
 109 typedef enum {
 110   CONIN                               = 0,
 111   CONOUT,
 112   CONERR,
 113   UNKNOWN_CON
 114 } TYPE_OF_CON;
 115
 116 typedef enum {
 117   BAUDRATE                            = 0,
 118   DATABITS,
 119   PARITY,
 120   STOPBITS,
 121   UNKNOW_ATTR
 122 } TYPE_OF_ATTRIBUTE;
 123
 124 typedef enum {
 125   MANNER_GOTO                         = 0,
 126   MANNER_CHECK,
 127   MANNER_ONEOF,
 128   MANNER_USER_DEFINE
 129 } TYPE_OF_UPATE_MANNER;
 130
 131 typedef enum {
 132   INACTIVE_STATE                      = 0,
 133   BOOT_FROM_FILE_STATE,
 134   ADD_BOOT_OPTION_STATE,
 135   ADD_DRIVER_OPTION_STATE,
 136   UNKNOWN_STATE
 137 } FILE_EXPLORER_STATE;
 138
 139 typedef enum {
 140   FILE_SYSTEM,
 141   DIRECTORY,
 142   UNKNOWN_CONTEXT
 143 } FILE_EXPLORER_DISPLAY_CONTEXT;
 144
 145 //
 146 // All of the signatures that will be used in list structure
 147 //
 148 #define BM_MENU_OPTION_SIGNATURE      SIGNATURE_32 ('m', 'e', 'n', 'u')
 149 #define BM_LOAD_OPTION_SIGNATURE      SIGNATURE_32 ('l', 'o', 'a', 'd')
 150 #define BM_CONSOLE_OPTION_SIGNATURE   SIGNATURE_32 ('c', 'n', 's', 'l')
 151 #define BM_FILE_OPTION_SIGNATURE      SIGNATURE_32 ('f', 'i', 'l', 'e')
 152 #define BM_HANDLE_OPTION_SIGNATURE    SIGNATURE_32 ('h', 'n', 'd', 'l')
 153 #define BM_TERMINAL_OPTION_SIGNATURE  SIGNATURE_32 ('t', 'r', 'm', 'l')
 154 #define BM_MENU_ENTRY_SIGNATURE       SIGNATURE_32 ('e', 'n', 't', 'r')
 155
 156 #define BM_LOAD_CONTEXT_SELECT        0x0
 157 #define BM_CONSOLE_CONTEXT_SELECT     0x1
 158 #define BM_FILE_CONTEXT_SELECT        0x2
 159 #define BM_HANDLE_CONTEXT_SELECT      0x3
 160 #define BM_TERMINAL_CONTEXT_SELECT    0x5
 161
 162 #define BM_CONSOLE_IN_CONTEXT_SELECT  0x6
 163 #define BM_CONSOLE_OUT_CONTEXT_SELECT 0x7
 164 #define BM_CONSOLE_ERR_CONTEXT_SELECT 0x8
 165 #define BM_LEGACY_DEV_CONTEXT_SELECT  0x9
 166
 167 //
 168 // Buffer size for update data
 169 //
 170 #define UPDATE_DATA_SIZE        0x100000
 171
 172 //
 173 // Namespace of callback keys used in display and file system navigation
 174 //
 175 #define MAX_BBS_OFFSET          0xE000
 176 #define NET_OPTION_OFFSET       0xD800
 177 #define BEV_OPTION_OFFSET       0xD000
 178 #define FD_OPTION_OFFSET        0xC000
 179 #define HD_OPTION_OFFSET        0xB000
 180 #define CD_OPTION_OFFSET        0xA000
 181 #define FILE_OPTION_OFFSET      0x8000
 182 #define FILE_OPTION_MASK        0x7FFF
 183 #define HANDLE_OPTION_OFFSET    0x7000
 184 #define CONSOLE_OPTION_OFFSET   0x6000
 185 #define TERMINAL_OPTION_OFFSET  0x5000
 186 #define CONFIG_OPTION_OFFSET    0x1200
 187 #define KEY_VALUE_OFFSET        0x1100
 188 #define FORM_ID_OFFSET          0x1000
 189
 190 //
 191 // VarOffset that will be used to create question
 192 // all these values are computed from the structure
 193 // defined below
 194 //
 195 #define VAR_OFFSET(Field)              ((UINT16) ((UINTN) &(((BMM_FAKE_NV_DATA *) 0)->Field)))
 196
 197 //
 198 // Question Id of Zero is invalid, so add an offset to it
 199 //
 200 #define QUESTION_ID(Field)             (VAR_OFFSET (Field) + CONFIG_OPTION_OFFSET)
 201
 202 #define BOOT_TIME_OUT_VAR_OFFSET        VAR_OFFSET (BootTimeOut)
 203 #define BOOT_NEXT_VAR_OFFSET            VAR_OFFSET (BootNext)
 204 #define COM1_BAUD_RATE_VAR_OFFSET       VAR_OFFSET (COM1BaudRate)
 205 #define COM1_DATA_RATE_VAR_OFFSET       VAR_OFFSET (COM1DataRate)
 206 #define COM1_STOP_BITS_VAR_OFFSET       VAR_OFFSET (COM1StopBits)
 207 #define COM1_PARITY_VAR_OFFSET          VAR_OFFSET (COM1Parity)
 208 #define COM1_TERMINAL_VAR_OFFSET        VAR_OFFSET (COM2TerminalType)
 209 #define COM2_BAUD_RATE_VAR_OFFSET       VAR_OFFSET (COM2BaudRate)
 210 #define COM2_DATA_RATE_VAR_OFFSET       VAR_OFFSET (COM2DataRate)
 211 #define COM2_STOP_BITS_VAR_OFFSET       VAR_OFFSET (COM2StopBits)
 212 #define COM2_PARITY_VAR_OFFSET          VAR_OFFSET (COM2Parity)
 213 #define COM2_TERMINAL_VAR_OFFSET        VAR_OFFSET (COM2TerminalType)
 214 #define DRV_ADD_HANDLE_DESC_VAR_OFFSET  VAR_OFFSET (DriverAddHandleDesc)
 215 #define DRV_ADD_ACTIVE_VAR_OFFSET       VAR_OFFSET (DriverAddActive)
 216 #define DRV_ADD_RECON_VAR_OFFSET        VAR_OFFSET (DriverAddForceReconnect)
 217 #define CON_IN_COM1_VAR_OFFSET          VAR_OFFSET (ConsoleInputCOM1)
 218 #define CON_IN_COM2_VAR_OFFSET          VAR_OFFSET (ConsoleInputCOM2)
 219 #define CON_OUT_COM1_VAR_OFFSET         VAR_OFFSET (ConsoleOutputCOM1)
 220 #define CON_OUT_COM2_VAR_OFFSET         VAR_OFFSET (ConsoleOutputCOM2)
 221 #define CON_ERR_COM1_VAR_OFFSET         VAR_OFFSET (ConsoleErrorCOM1)
 222 #define CON_ERR_COM2_VAR_OFFSET         VAR_OFFSET (ConsoleErrorCOM2)
 223 #define CON_MODE_VAR_OFFSET             VAR_OFFSET (ConsoleOutMode)
 224 #define CON_DEVICE_VAR_OFFSET           VAR_OFFSET (ConsoleCheck)
 225 #define OPTION_ORDER_VAR_OFFSET         VAR_OFFSET (OptionOrder)
 226 #define DRIVER_OPTION_ORDER_VAR_OFFSET  VAR_OFFSET (DriverOptionToBeDeleted)
 227 #define BOOT_OPTION_DEL_VAR_OFFSET      VAR_OFFSET (BootOptionDel)
 228 #define DRIVER_OPTION_DEL_VAR_OFFSET    VAR_OFFSET (DriverOptionDel)
 229 #define DRIVER_ADD_OPTION_VAR_OFFSET    VAR_OFFSET (DriverAddHandleOptionalData)
 230 #define COM_BAUD_RATE_VAR_OFFSET        VAR_OFFSET (COMBaudRate)
 231 #define COM_DATA_RATE_VAR_OFFSET        VAR_OFFSET (COMDataRate)
 232 #define COM_STOP_BITS_VAR_OFFSET        VAR_OFFSET (COMStopBits)
 233 #define COM_PARITY_VAR_OFFSET           VAR_OFFSET (COMParity)
 234 #define COM_TERMINAL_VAR_OFFSET         VAR_OFFSET (COMTerminalType)
 235 #define LEGACY_FD_VAR_OFFSET            VAR_OFFSET (LegacyFD)
 236 #define LEGACY_HD_VAR_OFFSET            VAR_OFFSET (LegacyHD)
 237 #define LEGACY_CD_VAR_OFFSET            VAR_OFFSET (LegacyCD)
 238 #define LEGACY_NET_VAR_OFFSET           VAR_OFFSET (LegacyNET)
 239 #define LEGACY_BEV_VAR_OFFSET           VAR_OFFSET (LegacyBEV)
 240
 241 #define BOOT_TIME_OUT_QUESTION_ID       QUESTION_ID (BootTimeOut)
 242 #define BOOT_NEXT_QUESTION_ID           QUESTION_ID (BootNext)
 243 #define COM1_BAUD_RATE_QUESTION_ID      QUESTION_ID (COM1BaudRate)
 244 #define COM1_DATA_RATE_QUESTION_ID      QUESTION_ID (COM1DataRate)
 245 #define COM1_STOP_BITS_QUESTION_ID      QUESTION_ID (COM1StopBits)
 246 #define COM1_PARITY_QUESTION_ID         QUESTION_ID (COM1Parity)
 247 #define COM1_TERMINAL_QUESTION_ID       QUESTION_ID (COM2TerminalType)
 248 #define COM2_BAUD_RATE_QUESTION_ID      QUESTION_ID (COM2BaudRate)
 249 #define COM2_DATA_RATE_QUESTION_ID      QUESTION_ID (COM2DataRate)
 250 #define COM2_STOP_BITS_QUESTION_ID      QUESTION_ID (COM2StopBits)
 251 #define COM2_PARITY_QUESTION_ID         QUESTION_ID (COM2Parity)
 252 #define COM2_TERMINAL_QUESTION_ID       QUESTION_ID (COM2TerminalType)
 253 #define DRV_ADD_HANDLE_DESC_QUESTION_ID QUESTION_ID (DriverAddHandleDesc)
 254 #define DRV_ADD_ACTIVE_QUESTION_ID      QUESTION_ID (DriverAddActive)
 255 #define DRV_ADD_RECON_QUESTION_ID       QUESTION_ID (DriverAddForceReconnect)
 256 #define CON_IN_COM1_QUESTION_ID         QUESTION_ID (ConsoleInputCOM1)
 257 #define CON_IN_COM2_QUESTION_ID         QUESTION_ID (ConsoleInputCOM2)
 258 #define CON_OUT_COM1_QUESTION_ID        QUESTION_ID (ConsoleOutputCOM1)
 259 #define CON_OUT_COM2_QUESTION_ID        QUESTION_ID (ConsoleOutputCOM2)
 260 #define CON_ERR_COM1_QUESTION_ID        QUESTION_ID (ConsoleErrorCOM1)
 261 #define CON_ERR_COM2_QUESTION_ID        QUESTION_ID (ConsoleErrorCOM2)
 262 #define CON_MODE_QUESTION_ID            QUESTION_ID (ConsoleOutMode)
 263 #define CON_DEVICE_QUESTION_ID          QUESTION_ID (ConsoleCheck)
 264 #define OPTION_ORDER_QUESTION_ID        QUESTION_ID (OptionOrder)
 265 #define DRIVER_OPTION_ORDER_QUESTION_ID QUESTION_ID (DriverOptionToBeDeleted)
 266 #define BOOT_OPTION_DEL_QUESTION_ID     QUESTION_ID (BootOptionDel)
 267 #define DRIVER_OPTION_DEL_QUESTION_ID   QUESTION_ID (DriverOptionDel)
 268 #define DRIVER_ADD_OPTION_QUESTION_ID   QUESTION_ID (DriverAddHandleOptionalData)
 269 #define COM_BAUD_RATE_QUESTION_ID       QUESTION_ID (COMBaudRate)
 270 #define COM_DATA_RATE_QUESTION_ID       QUESTION_ID (COMDataRate)
 271 #define COM_STOP_BITS_QUESTION_ID       QUESTION_ID (COMStopBits)
 272 #define COM_PARITY_QUESTION_ID          QUESTION_ID (COMParity)
 273 #define COM_TERMINAL_QUESTION_ID        QUESTION_ID (COMTerminalType)
 274 #define LEGACY_FD_QUESTION_ID           QUESTION_ID (LegacyFD)
 275 #define LEGACY_HD_QUESTION_ID           QUESTION_ID (LegacyHD)
 276 #define LEGACY_CD_QUESTION_ID           QUESTION_ID (LegacyCD)
 277 #define LEGACY_NET_QUESTION_ID          QUESTION_ID (LegacyNET)
 278 #define LEGACY_BEV_QUESTION_ID          QUESTION_ID (LegacyBEV)
 279
 280 #define STRING_DEPOSITORY_NUMBER        8
 281
 282 ///
 283 /// Serial Ports attributes, first one is the value for
 284 /// return from callback function, stringtoken is used to
 285 /// display the value properly
 286 ///
 287 typedef struct {
 288   UINTN   Value;
 289   UINT16  StringToken;
 290 } COM_ATTR;
 291
 292 #pragma pack(1)
 293 typedef struct {
 294   BBS_TYPE  BbsType;
 295   ///
 296   /// Length = sizeof (UINT16) + SIZEOF (Data)
 297   ///
 298   UINT16    Length;
 299   UINT16    *Data;
 300 } BM_LEGACY_DEV_ORDER_CONTEXT;
 301 #pragma pack()
 302
 303 typedef struct {
 304   UINT64                    BaudRate;
 305   UINT8                     DataBits;
 306   UINT8                     Parity;
 307   UINT8                     StopBits;
 308
 309   UINT8                     BaudRateIndex;
 310   UINT8                     DataBitsIndex;
 311   UINT8                     ParityIndex;
 312   UINT8                     StopBitsIndex;
 313
 314   UINT8                     IsConIn;
 315   UINT8                     IsConOut;
 316   UINT8                     IsStdErr;
 317   UINT8                     TerminalType;
 318
 319   EFI_DEVICE_PATH_PROTOCOL  *DevicePath;
 320 } BM_TERMINAL_CONTEXT;
 321
 322 typedef struct {
 323   BOOLEAN                   IsBootNext;
 324   BOOLEAN                   LoadOptionModified;
 325   BOOLEAN                   Deleted;
 326
 327   BOOLEAN                   IsLegacy;
 328   BOOLEAN                   IsActive;
 329   BOOLEAN                   ForceReconnect;
 330   UINTN                     OptionalDataSize;
 331
 332   UINTN                     LoadOptionSize;
 333   UINT8                     *LoadOption;
 334
 335   UINT32                    Attributes;
 336   UINT16                    FilePathListLength;
 337   UINT16                    *Description;
 338   EFI_DEVICE_PATH_PROTOCOL  *FilePathList;
 339   UINT8                     *OptionalData;
 340
 341   UINT16                    BbsIndex;
 342 } BM_LOAD_CONTEXT;
 343
 344 typedef struct {
 345   BBS_TABLE *BbsTable;
 346   UINTN     Index;
 347   UINTN     BbsCount;
 348   UINT16    *Description;
 349 } BM_LEGACY_DEVICE_CONTEXT;
 350
 351 typedef struct {
 352
 353   BOOLEAN                   IsActive;
 354
 355   BOOLEAN                   IsTerminal;
 356
 357   EFI_DEVICE_PATH_PROTOCOL  *DevicePath;
 358 } BM_CONSOLE_CONTEXT;
 359
 360 typedef struct {
 361   UINTN   Column;
 362   UINTN   Row;
 363 } CONSOLE_OUT_MODE;
 364
 365 typedef struct {
 366   EFI_HANDLE                        Handle;
 367   EFI_DEVICE_PATH_PROTOCOL          *DevicePath;
 368   EFI_FILE_HANDLE                   FHandle;
 369   UINT16                            *FileName;
 370   EFI_FILE_SYSTEM_VOLUME_LABEL      *Info;
 371
 372   BOOLEAN                           IsRoot;
 373   BOOLEAN                           IsDir;
 374   BOOLEAN                           IsRemovableMedia;
 375   BOOLEAN                           IsLoadFile;
 376   BOOLEAN                           IsBootLegacy;
 377 } BM_FILE_CONTEXT;
 378
 379 typedef struct {
 380   EFI_HANDLE                Handle;
 381   EFI_DEVICE_PATH_PROTOCOL  *DevicePath;
 382 } BM_HANDLE_CONTEXT;
 383
 384 typedef struct {
 385   UINTN           Signature;
 386   LIST_ENTRY      Head;
 387   UINTN           MenuNumber;
 388 } BM_MENU_OPTION;
 389
 390 typedef struct {
 391   UINTN           Signature;
 392   LIST_ENTRY      Link;
 393   UINTN           OptionNumber;
 394   UINT16          *DisplayString;
 395   UINT16          *HelpString;
 396   EFI_STRING_ID   DisplayStringToken;
 397   EFI_STRING_ID   HelpStringToken;
 398   UINTN           ContextSelection;
 399   VOID            *VariableContext;
 400 } BM_MENU_ENTRY;
 401
 402 typedef struct {
 403   //
 404   // Shared callback data.
 405   //
 406   UINTN                          Signature;
 407
 408   BM_MENU_ENTRY                  *MenuEntry;
 409   BM_HANDLE_CONTEXT              *HandleContext;
 410   BM_FILE_CONTEXT                *FileContext;
 411   BM_LOAD_CONTEXT                *LoadContext;
 412   BM_TERMINAL_CONTEXT            *TerminalContext;
 413   UINTN                          CurrentTerminal;
 414   BBS_TYPE                       BbsType;
 415
 416   //
 417   // BMM main formset callback data.
 418   //
 419   EFI_HII_HANDLE                 BmmHiiHandle;
 420   EFI_HANDLE                     BmmDriverHandle;
 421   EFI_HII_CONFIG_ACCESS_PROTOCOL BmmConfigAccess;
 422   EFI_FORM_ID                    BmmCurrentPageId;
 423   EFI_FORM_ID                    BmmPreviousPageId;
 424   BOOLEAN                        BmmAskSaveOrNot;
 425   BMM_FAKE_NV_DATA               BmmFakeNvData;
 426   BMM_FAKE_NV_DATA               BmmOldFakeNVData;
 427
 428   //
 429   // File explorer formset callback data.
 430   //
 431   EFI_HII_HANDLE                 FeHiiHandle;
 432   EFI_HANDLE                     FeDriverHandle;
 433   EFI_HII_CONFIG_ACCESS_PROTOCOL FeConfigAccess;
 434   FILE_EXPLORER_STATE            FeCurrentState;
 435   FILE_EXPLORER_DISPLAY_CONTEXT  FeDisplayContext;
 436   FILE_EXPLORER_NV_DATA          FeFakeNvData;
 437 } BMM_CALLBACK_DATA;
 438
 439 typedef struct _STRING_LIST_NODE {
 440   EFI_STRING_ID             StringToken;
 441   struct _STRING_LIST_NODE  *Next;
 442 } STRING_LIST_NODE;
 443
 444 typedef struct _STRING_DEPOSITORY {
 445   UINTN             TotalNodeNumber;
 446   STRING_LIST_NODE  *CurrentNode;
 447   STRING_LIST_NODE  *ListHead;
 448 } STRING_DEPOSITORY;
 449
 450 //
 451 // #pragma pack()
 452 //
 453 // For initializing File System menu
 454 //
 455
 456 /**
 457   This function build the FsOptionMenu list which records all
 458   available file system in the system. They includes all instances
 459   of EFI_SIMPLE_FILE_SYSTEM_PROTOCOL, all instances of EFI_LOAD_FILE_SYSTEM
 460   and all type of legacy boot device.
 461
 462   @param CallbackData    BMM context data
 463
 464   @retval  EFI_SUCCESS             Success find the file system
 465   @retval  EFI_OUT_OF_RESOURCES    Can not create menu entry
 466
 467 **/
 468 EFI_STATUS
 469 BOpt_FindFileSystem (
 470   IN BMM_CALLBACK_DATA          *CallbackData
 471   );
 472
 473 /**
 474   Find files under current directory
 475   All files and sub-directories in current directory
 476   will be stored in DirectoryMenu for future use.
 477
 478   @param CallbackData  The BMM context data.
 479   @param MenuEntry     The Menu Entry.
 480
 481   @retval EFI_SUCCESS         Get files from current dir successfully.
 482   @return Other value if can't get files from current dir.
 483
 484 **/
 485 EFI_STATUS
 486 BOpt_FindFiles (
 487   IN BMM_CALLBACK_DATA          *CallbackData,
 488   IN BM_MENU_ENTRY              *MenuEntry
 489   );
 490
 491 /**
 492
 493   Find drivers that will be added as Driver#### variables from handles
 494   in current system environment
 495   All valid handles in the system except those consume SimpleFs, LoadFile
 496   are stored in DriverMenu for future use.
 497
 498   @retval EFI_SUCCESS The function complets successfully.
 499   @return Other value if failed to build the DriverMenu.
 500
 501 **/
 502 EFI_STATUS
 503 BOpt_FindDrivers (
 504   VOID
 505   );
 506
 507 /**
 508
 509   Build the BootOptionMenu according to BootOrder Variable.
 510   This Routine will access the Boot#### to get EFI_LOAD_OPTION.
 511
 512   @param CallbackData The BMM context data.
 513
 514   @return The number of the Var Boot####.
 515
 516 **/
 517 EFI_STATUS
 518 BOpt_GetBootOptions (
 519   IN  BMM_CALLBACK_DATA         *CallbackData
 520   );
 521
 522 /**
 523
 524   Build up all DriverOptionMenu
 525
 526   @param CallbackData The BMM context data.
 527
 528   @return EFI_SUCESS The functin completes successfully.
 529   @retval EFI_OUT_OF_RESOURCES Not enough memory to compete the operation.
 530
 531
 532 **/
 533 EFI_STATUS
 534 BOpt_GetDriverOptions (
 535   IN  BMM_CALLBACK_DATA         *CallbackData
 536   );
 537
 538
 539 /**
 540   Build the LegacyFDMenu LegacyHDMenu LegacyCDMenu according to LegacyBios.GetBbsInfo().
 541
 542   @retval EFI_SUCCESS The function complete successfully.
 543   @retval EFI_OUT_OF_RESOURCES No enough memory to complete this function.
 544
 545 **/
 546 EFI_STATUS
 547 BOpt_GetLegacyOptions (
 548   VOID
 549   );
 550
 551 /**
 552   Free out resouce allocated from Legacy Boot Options.
 553
 554 **/
 555 VOID
 556 BOpt_FreeLegacyOptions (
 557   VOID
 558   );
 559
 560 /**
 561   Free resources allocated in Allocate Rountine.
 562
 563   @param FreeMenu        Menu to be freed
 564
 565 **/
 566 VOID
 567 BOpt_FreeMenu (
 568   BM_MENU_OPTION        *FreeMenu
 569   );
 570
 571
 572 /**
 573
 574   Append file name to existing file name.
 575
 576   @param Str1  The existing file name
 577   @param Str2  The file name to be appended
 578
 579   @return Allocate a new string to hold the appended result.
 580           Caller is responsible to free the returned string.
 581
 582 **/
 583 CHAR16*
 584 BOpt_AppendFileName (
 585   IN  CHAR16  *Str1,
 586   IN  CHAR16  *Str2
 587   );
 588
 589 /**
 590
 591   Check whether current FileName point to a valid
 592   Efi Image File.
 593
 594   @param FileName  File need to be checked.
 595
 596   @retval TRUE  Is Efi Image
 597   @retval FALSE Not a valid Efi Image
 598
 599 **/
 600 BOOLEAN
 601 BOpt_IsEfiImageName (
 602   IN UINT16  *FileName
 603   );
 604
 605 /**
 606
 607   Check whether current FileName point to a valid Efi Application
 608
 609   @param Dir       Pointer to current Directory
 610   @param FileName  Pointer to current File name.
 611
 612   @retval TRUE      Is a valid Efi Application
 613   @retval FALSE     not a valid Efi Application
 614
 615 **/
 616 BOOLEAN
 617 BOpt_IsEfiApp (
 618   IN EFI_FILE_HANDLE Dir,
 619   IN UINT16          *FileName
 620   );
 621
 622 /**
 623
 624   Get the Option Number that has not been allocated for use.
 625
 626   @return The available Option Number.
 627
 628 **/
 629 UINT16
 630 BOpt_GetBootOptionNumber (
 631   VOID
 632   );
 633
 634 /**
 635
 636   Get the Option Number that is not in use.
 637
 638   @return The unused Option Number.
 639
 640 **/
 641 UINT16
 642 BOpt_GetDriverOptionNumber (
 643   VOID
 644   );
 645
 646 /**
 647   Create a menu entry give a Menu type.
 648
 649   @param MenuType        The Menu type to be created.
 650
 651
 652   @retval NULL           If failed to create the menu.
 653   @return                The menu.
 654
 655 **/
 656 BM_MENU_ENTRY                     *
 657 BOpt_CreateMenuEntry (
 658   UINTN           MenuType
 659   );
 660
 661 /**
 662   Free up all resource allocated for a BM_MENU_ENTRY.
 663
 664   @param MenuEntry   A pointer to BM_MENU_ENTRY.
 665
 666 **/
 667 VOID
 668 BOpt_DestroyMenuEntry (
 669   BM_MENU_ENTRY         *MenuEntry
 670   );
 671
 672 /**
 673   Get the Menu Entry from the list in Menu Entry List.
 674
 675   If MenuNumber is great or equal to the number of Menu
 676   Entry in the list, then ASSERT.
 677
 678   @param MenuOption      The Menu Entry List to read the menu entry.
 679   @param MenuNumber      The index of Menu Entry.
 680
 681   @return The Menu Entry.
 682
 683 **/
 684 BM_MENU_ENTRY                     *
 685 BOpt_GetMenuEntry (
 686   BM_MENU_OPTION      *MenuOption,
 687   UINTN               MenuNumber
 688   );
 689
 690 //
 691 // Locate all serial io devices for console
 692 //
 693 /**
 694   Build a list containing all serial devices.
 695
 696   @retval EFI_SUCCESS The function complete successfully.
 697   @retval EFI_UNSUPPORTED No serial ports present.
 698
 699 **/
 700 EFI_STATUS
 701 LocateSerialIo (
 702   VOID
 703   );
 704
 705 //
 706 // Initializing Console menu
 707 //
 708 /**
 709   Build up ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu
 710
 711   @retval EFI_SUCCESS    The function always complete successfully.
 712
 713 **/
 714 EFI_STATUS
 715 GetAllConsoles(
 716   VOID
 717   );
 718
 719 //
 720 // Get current mode information
 721 //
 722 /**
 723   Get mode number according to column and row
 724
 725   @param CallbackData    The BMM context data.
 726 **/
 727 VOID
 728 GetConsoleOutMode (
 729   IN  BMM_CALLBACK_DATA    *CallbackData
 730   );
 731
 732 //
 733 // Cleaning up console menu
 734 //
 735 /**
 736   Free ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu
 737
 738   @retval EFI_SUCCESS    The function always complete successfully.
 739 **/
 740 EFI_STATUS
 741 FreeAllConsoles (
 742   VOID
 743   );
 744
 745 /**
 746   Update the device path that describing a terminal device
 747   based on the new BaudRate, Data Bits, parity and Stop Bits
 748   set.
 749
 750   @param DevicePath     The devicepath protocol instance wanted to be updated.
 751
 752 **/
 753 VOID
 754 ChangeVariableDevicePath (
 755   IN OUT EFI_DEVICE_PATH_PROTOCOL  *DevicePath
 756   );
 757
 758 /**
 759   Update the multi-instance device path of Terminal Device based on
 760   the global TerminalMenu. If ChangeTernimal is TRUE, the terminal
 761   device path in the Terminal Device in TerminalMenu is also updated.
 762
 763   @param DevicePath      The multi-instance device path.
 764   @param ChangeTerminal  TRUE, then device path in the Terminal Device
 765                          in TerminalMenu is also updated; FALSE, no update.
 766
 767   @return EFI_SUCCESS    The function completes successfully.
 768
 769 **/
 770 EFI_STATUS
 771 ChangeTerminalDevicePath (
 772   IN OUT EFI_DEVICE_PATH_PROTOCOL  *DevicePath,
 773   IN BOOLEAN                   ChangeTerminal
 774   );
 775
 776 //
 777 // Variable operation by menu selection
 778 //
 779 /**
 780   This function create a currently loaded Boot Option from
 781   the BMM. It then appends this Boot Option to the end of
 782   the "BootOrder" list. It also append this Boot Opotion to the end
 783   of BootOptionMenu.
 784
 785   @param CallbackData           The BMM context data.
 786   @param NvRamMap               The file explorer formset internal state.
 787
 788   @retval EFI_OUT_OF_RESOURCES  If not enought memory to complete the operation.
 789   @retval EFI_SUCCESS           If function completes successfully.
 790
 791 **/
 792 EFI_STATUS
 793 Var_UpdateBootOption (
 794   IN  BMM_CALLBACK_DATA                   *CallbackData,
 795   IN  FILE_EXPLORER_NV_DATA               *NvRamMap
 796   );
 797
 798 /**
 799   Delete Boot Option that represent a Deleted state in BootOptionMenu.
 800   After deleting this boot option, call Var_ChangeBootOrder to
 801   make sure BootOrder is in valid state.
 802
 803   @retval EFI_SUCCESS   If all boot load option EFI Variables corresponding to
 804                         BM_LOAD_CONTEXT marked for deletion is deleted
 805   @return Others        If failed to update the "BootOrder" variable after deletion.
 806
 807 **/
 808 EFI_STATUS
 809 Var_DelBootOption (
 810   VOID
 811   );
 812
 813 /**
 814   After any operation on Boot####, there will be a discrepancy in BootOrder.
 815   Since some are missing but in BootOrder, while some are present but are
 816   not reflected by BootOrder. Then a function rebuild BootOrder from
 817   scratch by content from BootOptionMenu is needed.
 818
 819   @retval  EFI_SUCCESS  The boot order is updated successfully.
 820   @return  other than EFI_SUCCESS if failed to change the "BootOrder" EFI Variable.
 821
 822 **/
 823 EFI_STATUS
 824 Var_ChangeBootOrder (
 825   VOID
 826   );
 827
 828 /**
 829   This function create a currently loaded Drive Option from
 830   the BMM. It then appends this Driver Option to the end of
 831   the "DriverOrder" list. It append this Driver Opotion to the end
 832   of DriverOptionMenu.
 833
 834   @param CallbackData    The BMM context data.
 835   @param HiiHandle       The HII handle associated with the BMM formset.
 836   @param DescriptionData The description of this driver option.
 837   @param OptionalData    The optional load option.
 838   @param ForceReconnect  If to force reconnect.
 839
 840   @retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.
 841   @retval EFI_SUCCESS          If function completes successfully.
 842
 843 **/
 844 EFI_STATUS
 845 Var_UpdateDriverOption (
 846   IN  BMM_CALLBACK_DATA         *CallbackData,
 847   IN  EFI_HII_HANDLE            HiiHandle,
 848   IN  UINT16                    *DescriptionData,
 849   IN  UINT16                    *OptionalData,
 850   IN  UINT8                     ForceReconnect
 851   );
 852
 853 /**
 854   Delete Load Option that represent a Deleted state in BootOptionMenu.
 855   After deleting this Driver option, call Var_ChangeDriverOrder to
 856   make sure DriverOrder is in valid state.
 857
 858   @retval EFI_SUCCESS Load Option is successfully updated.
 859   @return Other value than EFI_SUCCESS if failed to update "Driver Order" EFI
 860           Variable.
 861
 862 **/
 863 EFI_STATUS
 864 Var_DelDriverOption (
 865   VOID
 866   );
 867
 868 /**
 869   After any operation on Driver####, there will be a discrepancy in
 870   DriverOrder. Since some are missing but in DriverOrder, while some
 871   are present but are not reflected by DriverOrder. Then a function
 872   rebuild DriverOrder from scratch by content from DriverOptionMenu is
 873   needed.
 874
 875   @retval  EFI_SUCCESS  The driver order is updated successfully.
 876   @return  other than EFI_SUCCESS if failed to set the "DriverOrder" EFI Variable.
 877
 878 **/
 879 EFI_STATUS
 880 Var_ChangeDriverOrder (
 881   VOID
 882   );
 883
 884 /**
 885   This function delete and build multi-instance device path ConIn
 886   console device.
 887
 888   @retval EFI_SUCCESS    The function complete successfully.
 889   @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
 890 **/
 891 EFI_STATUS
 892 Var_UpdateConsoleInpOption (
 893   VOID
 894   );
 895
 896 /**
 897   This function delete and build multi-instance device path ConOut console device.
 898
 899   @retval EFI_SUCCESS    The function complete successfully.
 900   @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
 901 **/
 902 EFI_STATUS
 903 Var_UpdateConsoleOutOption (
 904   VOID
 905   );
 906
 907 /**
 908   This function delete and build multi-instance device path ErrOut console device.
 909
 910   @retval EFI_SUCCESS    The function complete successfully.
 911   @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
 912 **/
 913 EFI_STATUS
 914 Var_UpdateErrorOutOption (
 915   VOID
 916   );
 917
 918 /**
 919   Update the device path of "ConOut", "ConIn" and "ErrOut" based on the new BaudRate, Data Bits,
 920   parity and stop Bits set.
 921
 922 **/
 923 VOID
 924 Var_UpdateAllConsoleOption (
 925   VOID
 926   );
 927
 928 /**
 929   This function update the "BootNext" EFI Variable. If there is no "BootNex" specified in BMM,
 930   this EFI Variable is deleted.
 931   It also update the BMM context data specified the "BootNext" value.
 932
 933   @param CallbackData    The BMM context data.
 934
 935   @retval EFI_SUCCESS    The function complete successfully.
 936   @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
 937
 938 **/
 939 EFI_STATUS
 940 Var_UpdateBootNext (
 941   IN BMM_CALLBACK_DATA            *CallbackData
 942   );
 943
 944 /**
 945   This function update the "BootOrder" EFI Variable based on BMM Formset's NV map. It then refresh
 946   BootOptionMenu with the new "BootOrder" list.
 947
 948   @param CallbackData           The BMM context data.
 949
 950   @retval EFI_SUCCESS           The function complete successfully.
 951   @retval EFI_OUT_OF_RESOURCES  Not enough memory to complete the function.
 952   @return not The EFI variable can not be saved. See gRT->SetVariable for detail return information.
 953
 954 **/
 955 EFI_STATUS
 956 Var_UpdateBootOrder (
 957   IN BMM_CALLBACK_DATA            *CallbackData
 958   );
 959
 960 /**
 961   This function update the "DriverOrder" EFI Variable based on
 962   BMM Formset's NV map. It then refresh DriverOptionMenu
 963   with the new "DriverOrder" list.
 964
 965   @param CallbackData    The BMM context data.
 966
 967   @retval EFI_SUCCESS           The function complete successfully.
 968   @retval EFI_OUT_OF_RESOURCES  Not enough memory to complete the function.
 969   @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
 970
 971 **/
 972 EFI_STATUS
 973 Var_UpdateDriverOrder (
 974   IN BMM_CALLBACK_DATA            *CallbackData
 975   );
 976
 977 /**
 978   Update the legacy BBS boot option. L"LegacyDevOrder" and EfiLegacyDevOrderGuid EFI Variable
 979   is udpated with the new Legacy Boot order. The EFI Variable of "Boot####" and gEfiGlobalVariableGuid
 980   is also updated.
 981
 982   @param CallbackData    The context data for BMM.
 983
 984   @return EFI_SUCCESS    The function completed successfully.
 985   @retval EFI_NOT_FOUND  If L"LegacyDevOrder" and EfiLegacyDevOrderGuid EFI Variable can not be found.
 986
 987 **/
 988 EFI_STATUS
 989 Var_UpdateBBSOption (
 990   IN BMM_CALLBACK_DATA            *CallbackData
 991   );
 992
 993 /**
 994   Update the Text Mode of Console.
 995
 996   @param CallbackData  The context data for BMM.
 997
 998   @retval EFI_SUCCSS If the Text Mode of Console is updated.
 999   @return Other value if the Text Mode of Console is not updated.
1000
1001 **/
1002 EFI_STATUS
1003 Var_UpdateConMode (
1004   IN BMM_CALLBACK_DATA            *CallbackData
1005   );
1006
1007 //
1008 // Following are page create and refresh functions
1009 //
1010 /**
1011   Refresh the global UpdateData structure.
1012
1013 **/
1014 VOID
1015 RefreshUpdateData (
1016   VOID
1017   );
1018
1019 /**
1020   Clean up the dynamic opcode at label and form specified by
1021   both LabelId.
1022
1023   @param LabelId         It is both the Form ID and Label ID for
1024                          opcode deletion.
1025   @param CallbackData    The BMM context data.
1026
1027 **/
1028 VOID
1029 CleanUpPage (
1030   IN UINT16                           LabelId,
1031   IN BMM_CALLBACK_DATA                *CallbackData
1032   );
1033
1034 /**
1035   Create a lit of boot option from global BootOptionMenu. It
1036   allow user to delete the boot option.
1037
1038   @param CallbackData    The BMM context data.
1039
1040 **/
1041 VOID
1042 UpdateBootDelPage (
1043   IN BMM_CALLBACK_DATA                *CallbackData
1044   );
1045
1046 /**
1047   Create a lit of driver option from global DriverMenu.
1048
1049   @param CallbackData    The BMM context data.
1050 **/
1051 VOID
1052 UpdateDrvAddHandlePage (
1053   IN BMM_CALLBACK_DATA                *CallbackData
1054   );
1055
1056 /**
1057   Create a lit of driver option from global DriverOptionMenu. It
1058   allow user to delete the driver option.
1059
1060   @param CallbackData    The BMM context data.
1061 **/
1062 VOID
1063 UpdateDrvDelPage (
1064   IN BMM_CALLBACK_DATA                *CallbackData
1065   );
1066
1067 /**
1068   Prepare the page to allow user to add description for a Driver Option.
1069
1070   @param CallbackData    The BMM context data.
1071 **/
1072 VOID
1073 UpdateDriverAddHandleDescPage (
1074   IN BMM_CALLBACK_DATA                *CallbackData
1075   );
1076
1077 /**
1078   Dispatch the correct update page function to call based on the UpdatePageId.
1079
1080   @param UpdatePageId    The form ID.
1081   @param CallbackData    The BMM context data.
1082 **/
1083 VOID
1084 UpdatePageBody (
1085   IN UINT16                           UpdatePageId,
1086   IN BMM_CALLBACK_DATA                *CallbackData
1087   );
1088
1089 /**
1090   Create the dynamic page to allow user to set the "BootNext" vaule.
1091
1092   @param CallbackData    The BMM context data.
1093 **/
1094 VOID
1095 UpdateBootNextPage (
1096   IN BMM_CALLBACK_DATA                *CallbackData
1097   );
1098
1099 /**
1100   Create the dynamic page to allow user to set the "TimeOut" vaule.
1101
1102   @param CallbackData    The BMM context data.
1103 **/
1104 VOID
1105 UpdateTimeOutPage (
1106   IN BMM_CALLBACK_DATA                *CallbackData
1107   );
1108
1109 /**
1110   Create the dynamic page which allows user to set the property such as Baud Rate, Data Bits,
1111   Parity, Stop Bits, Terminal Type.
1112
1113   @param CallbackData    The BMM context data.
1114 **/
1115 VOID
1116 UpdateTerminalPage (
1117   IN BMM_CALLBACK_DATA                *CallbackData
1118   );
1119
1120 /**
1121   Refresh the text mode page
1122
1123   @param CallbackData    The BMM context data.
1124 **/
1125 VOID
1126 UpdateConModePage (
1127   IN BMM_CALLBACK_DATA                *CallbackData
1128   );
1129
1130 /**
1131   Create a list of Goto Opcode for all terminal devices logged
1132   by TerminaMenu. This list will be inserted to form FORM_CON_COM_SETUP_ID.
1133
1134   @param CallbackData    The BMM context data.
1135 **/
1136 VOID
1137 UpdateConCOMPage (
1138   IN BMM_CALLBACK_DATA                *CallbackData
1139   );
1140
1141 /**
1142   Create a dynamic page so that Legacy Device boot order
1143   can be set for specified device type.
1144
1145   @param UpdatePageId    The form ID. It also spefies the legacy device type.
1146   @param CallbackData    The BMM context data.
1147 **/
1148 VOID
1149 UpdateSetLegacyDeviceOrderPage (
1150   IN UINT16                           UpdatePageId,
1151   IN BMM_CALLBACK_DATA                *CallbackData
1152   );
1153
1154
1155 /**
1156   Function opens and returns a file handle to the root directory of a volume.
1157
1158   @param DeviceHandle    A handle for a device
1159   @return A valid file handle or NULL is returned
1160 **/
1161 EFI_FILE_HANDLE
1162 EfiLibOpenRoot (
1163   IN EFI_HANDLE       DeviceHandle
1164   );
1165
1166 /**
1167   Function gets the file system information from an open file descriptor,
1168   and stores it in a buffer allocated from pool.
1169
1170   @param FHand           The file handle.
1171
1172   @return                A pointer to a buffer with file information.
1173                          NULL is returned if failed to get Vaolume Label Info.
1174 **/
1175 EFI_FILE_SYSTEM_VOLUME_LABEL *
1176 EfiLibFileSystemVolumeLabelInfo (
1177   IN EFI_FILE_HANDLE      FHand
1178   );
1179
1180 /**
1181
1182   Function gets the file information from an open file descriptor, and stores it
1183   in a buffer allocated from pool.
1184
1185   @param FHand           File Handle.
1186
1187   @return                A pointer to a buffer with file information or NULL is returned
1188
1189 **/
1190 EFI_FILE_INFO *
1191 EfiLibFileInfo (
1192   IN EFI_FILE_HANDLE      FHand
1193   );
1194
1195 /**
1196   Find the first instance of this Protocol in the system and return it's interface.
1197
1198   @param ProtocolGuid    Provides the protocol to search for
1199   @param Interface       On return, a pointer to the first interface
1200                          that matches ProtocolGuid
1201
1202   @retval  EFI_SUCCESS      A protocol instance matching ProtocolGuid was found
1203   @retval  EFI_NOT_FOUND    No protocol instances were found that match ProtocolGuid
1204
1205 **/
1206 EFI_STATUS
1207 EfiLibLocateProtocol (
1208   IN  EFI_GUID        *ProtocolGuid,
1209   OUT VOID            **Interface
1210   );
1211
1212 /**
1213   Adjusts the size of a previously allocated buffer.
1214
1215   @param OldPool         A pointer to the buffer whose size is being adjusted.
1216   @param OldSize         The size of the current buffer.
1217   @param NewSize         The size of the new buffer.
1218
1219   @return   The newly allocated buffer. if NULL, allocation failed.
1220
1221 **/
1222 VOID*
1223 EfiReallocatePool (
1224   IN VOID                 *OldPool,
1225   IN UINTN                OldSize,
1226   IN UINTN                NewSize
1227   );
1228
1229 /**
1230   Function deletes the variable specified by VarName and VarGuid.
1231
1232
1233   @param VarName            A Null-terminated Unicode string that is
1234                             the name of the vendor's variable.
1235
1236   @param VarGuid            A unique identifier for the vendor.
1237
1238   @retval  EFI_SUCCESS           The variable was found and removed
1239   @retval  EFI_UNSUPPORTED       The variable store was inaccessible
1240   @retval  EFI_OUT_OF_RESOURCES  The temporary buffer was not available
1241   @retval  EFI_NOT_FOUND         The variable was not found
1242
1243 **/
1244 EFI_STATUS
1245 EfiLibDeleteVariable (
1246   IN CHAR16   *VarName,
1247   IN EFI_GUID *VarGuid
1248   );
1249
1250 /**
1251   Duplicate a string.
1252
1253   @param Src             The source.
1254
1255   @return A new string which is duplicated copy of the source.
1256   @retval NULL If there is not enough memory.
1257
1258 **/
1259 CHAR16                            *
1260 EfiStrDuplicate (
1261   IN CHAR16   *Src
1262   );
1263
1264 /**
1265   Function is used to determine the number of device path instances
1266   that exist in a device path.
1267
1268
1269   @param DevicePath      A pointer to a device path data structure.
1270
1271   @return This function counts and returns the number of device path instances
1272           in DevicePath.
1273
1274 **/
1275 UINTN
1276 EfiDevicePathInstanceCount (
1277   IN EFI_DEVICE_PATH_PROTOCOL      *DevicePath
1278   );
1279
1280 /**
1281   Create string tokens for a menu from its help strings and display strings
1282
1283
1284   @param CallbackData    The BMM context data.
1285   @param HiiHandle       Hii Handle of the package to be updated.
1286   @param MenuOption      The Menu whose string tokens need to be created
1287
1288   @retval  EFI_SUCCESS      string tokens created successfully
1289   @retval  others           contain some errors
1290
1291 **/
1292 EFI_STATUS
1293 CreateMenuStringToken (
1294   IN BMM_CALLBACK_DATA                *CallbackData,
1295   IN EFI_HII_HANDLE                   HiiHandle,
1296   IN BM_MENU_OPTION                   *MenuOption
1297   );
1298
1299 /**
1300   Get a string from the Data Hub record based on
1301   a device path.
1302
1303   @param DevPath         The device Path.
1304
1305   @return A string located from the Data Hub records based on
1306           the device path.
1307   @retval NULL  If failed to get the String from Data Hub.
1308
1309 **/
1310 UINT16 *
1311 EfiLibStrFromDatahub (
1312   IN EFI_DEVICE_PATH_PROTOCOL                 *DevPath
1313   );
1314
1315 /**
1316   Get the index number (#### in Boot####) for the boot option pointed to a BBS legacy device type
1317   specified by DeviceType.
1318
1319   @param DeviceType      The legacy device type. It can be floppy, network, harddisk, cdrom,
1320                          etc.
1321   @param OptionIndex     Returns the index number (#### in Boot####).
1322   @param OptionSize      Return the size of the Boot### variable.
1323
1324 **/
1325 VOID *
1326 GetLegacyBootOptionVar (
1327   IN  UINTN                            DeviceType,
1328   OUT UINTN                            *OptionIndex,
1329   OUT UINTN                            *OptionSize
1330   );
1331
1332 /**
1333   Initialize the Boot Maintenance Utitliy.
1334
1335   @retval  EFI_SUCCESS      utility ended successfully.
1336   @retval  others           contain some errors.
1337
1338 **/
1339 EFI_STATUS
1340 InitializeBM (
1341   VOID
1342   );
1343
1344 /**
1345   Start boot maintenance manager
1346
1347   @retval EFI_SUCCESS If BMM is invoked successfully.
1348   @return Other value if BMM return unsuccessfully.
1349
1350 **/
1351 EFI_STATUS
1352 BdsStartBootMaint (
1353   VOID
1354   );
1355
1356 /**
1357   Intialize all the string depositories.
1358
1359 **/
1360 VOID
1361 InitializeStringDepository (
1362   VOID
1363   );
1364
1365 /**
1366   Fetch a usable string node from the string depository and return the string token.
1367
1368
1369   @param CallbackData       The BMM context data.
1370   @param StringDepository   Pointer of the string depository.
1371
1372   @retval  EFI_STRING_ID    String token.
1373
1374 **/
1375 EFI_STRING_ID
1376 GetStringTokenFromDepository (
1377   IN   BMM_CALLBACK_DATA     *CallbackData,
1378   IN   STRING_DEPOSITORY     *StringDepository
1379   );
1380
1381 /**
1382   Reclaim string depositories by moving the current node pointer to list head..
1383 **/
1384 VOID
1385 ReclaimStringDepository (
1386   VOID
1387   );
1388
1389 /**
1390   Release resource for all the string depositories.
1391
1392 **/
1393 VOID
1394 CleanUpStringDepository (
1395   VOID
1396   );
1397
1398 /**
1399   Function handling request to apply changes for BMM pages.
1400
1401   @param Private            Pointer to callback data buffer.
1402   @param CurrentFakeNVMap   Pointer to buffer holding data of various values used by BMM
1403   @param FormId             ID of the form which has sent the request to apply change.
1404
1405   @retval  EFI_SUCCESS      Change successfully applied.
1406   @retval  Other            Error occurs while trying to apply changes.
1407
1408 **/
1409 EFI_STATUS
1410 ApplyChangeHandler (
1411   IN  BMM_CALLBACK_DATA               *Private,
1412   IN  BMM_FAKE_NV_DATA                *CurrentFakeNVMap,
1413   IN  EFI_FORM_ID                     FormId
1414   );
1415
1416 /**
1417   Discard all changes done to the BMM pages such as Boot Order change,
1418   Driver order change.
1419
1420   @param Private         The BMM context data.
1421   @param CurrentFakeNVMap The current Fack NV Map.
1422
1423 **/
1424 VOID
1425 DiscardChangeHandler (
1426   IN  BMM_CALLBACK_DATA               *Private,
1427   IN  BMM_FAKE_NV_DATA                *CurrentFakeNVMap
1428   );
1429
1430 /**
1431   Dispatch the display to the next page based on NewPageId.
1432
1433   @param Private         The BMM context data.
1434   @param NewPageId       The original page ID.
1435
1436 **/
1437 VOID
1438 UpdatePageId (
1439   BMM_CALLBACK_DATA              *Private,
1440   UINT16                         NewPageId
1441   );
1442
1443 /**
1444   Boot a file selected by user at File Expoloer of BMM.
1445
1446   @param FileContext     The file context data, which contains the device path
1447                          of the file to be boot from.
1448
1449   @retval EFI_SUCCESS    The function completed successfull.
1450   @return                 Other value if the boot from the file fails.
1451
1452 **/
1453 EFI_STATUS
1454 BootThisFile (
1455   IN BM_FILE_CONTEXT                   *FileContext
1456   );
1457
1458 /**
1459   Update the file explower page with the refershed file system.
1460
1461
1462   @param CallbackData    BMM context data
1463   @param KeyValue        Key value to identify the type of data to expect.
1464
1465   @retval  TRUE           Inform the caller to create a callback packet to exit file explorer.
1466   @retval  FALSE          Indicate that there is no need to exit file explorer.
1467
1468 **/
1469 BOOLEAN
1470 UpdateFileExplorer (
1471   IN BMM_CALLBACK_DATA            *CallbackData,
1472   IN UINT16                       KeyValue
1473   );
1474
1475 /**
1476   This function processes the results of changes in configuration.
1477   When user select a interactive opcode, this callback will be triggered.
1478   Based on the Question(QuestionId) that triggers the callback, the corresponding
1479   actions is performed. It handles:
1480
1481   1) the addition of boot option.
1482   2) the addition of driver option.
1483   3) exit from file browser
1484   4) update of file content if a dir is selected.
1485   5) boot the file if a file is selected in "boot from file"
1486
1487
1488   @param This            Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1489   @param Action          Specifies the type of action taken by the browser.
1490   @param QuestionId      A unique value which is sent to the original exporting driver
1491                          so that it can identify the type of data to expect.
1492   @param Type            The type of value for the question.
1493   @param Value           A pointer to the data being sent to the original exporting driver.
1494   @param ActionRequest   On return, points to the action requested by the callback function.
1495
1496   @retval  EFI_SUCCESS           The callback successfully handled the action.
1497   @retval  EFI_OUT_OF_RESOURCES  Not enough storage is available to hold the variable and its data.
1498   @retval  EFI_DEVICE_ERROR      The variable could not be saved.
1499   @retval  EFI_UNSUPPORTED       The specified Action is not supported by the callback.
1500
1501 **/
1502 EFI_STATUS
1503 EFIAPI
1504 FileExplorerCallback (
1505   IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,
1506   IN  EFI_BROWSER_ACTION                     Action,
1507   IN  EFI_QUESTION_ID                        QuestionId,
1508   IN  UINT8                                  Type,
1509   IN  EFI_IFR_TYPE_VALUE                     *Value,
1510   OUT EFI_BROWSER_ACTION_REQUEST             *ActionRequest
1511   );
1512
1513 /**
1514   Dispatch BMM formset and FileExplorer formset.
1515
1516
1517   @param CallbackData    The BMM context data.
1518
1519   @retval EFI_SUCCESS If function complete successfully.
1520   @return Other value if the Setup Browser process BMM's pages and
1521            return unsuccessfully.
1522
1523 **/
1524 EFI_STATUS
1525 FormSetDispatcher (
1526   IN  BMM_CALLBACK_DATA    *CallbackData
1527   );
1528
1529 /**
1530   Function returns the value of the specified variable.
1531
1532   @param Name            A Null-terminated Unicode string that is
1533                          the name of the vendor's variable.
1534   @param VendorGuid      A unique identifier for the vendor.
1535
1536   @return               The payload of the variable.
1537   @retval NULL          If the variable can't be read.
1538
1539 **/
1540 VOID *
1541 EfiLibGetVariable (
1542   IN CHAR16               *Name,
1543   IN EFI_GUID             *VendorGuid
1544   );
1545
1546 //
1547 // Global variable in this program (defined in data.c)
1548 //
1549 extern BM_MENU_OPTION             BootOptionMenu;
1550 extern BM_MENU_OPTION             DriverOptionMenu;
1551 extern BM_MENU_OPTION             FsOptionMenu;
1552 extern BM_MENU_OPTION             ConsoleInpMenu;
1553 extern BM_MENU_OPTION             ConsoleOutMenu;
1554 extern BM_MENU_OPTION             ConsoleErrMenu;
1555 extern BM_MENU_OPTION             DirectoryMenu;
1556 extern BM_MENU_OPTION             DriverMenu;
1557 extern BM_MENU_OPTION             TerminalMenu;
1558 extern BM_MENU_OPTION             LegacyFDMenu;
1559 extern BM_MENU_OPTION             LegacyHDMenu;
1560 extern BM_MENU_OPTION             LegacyCDMenu;
1561 extern BM_MENU_OPTION             LegacyNETMenu;
1562 extern BM_MENU_OPTION             LegacyBEVMenu;
1563 extern UINT16                     TerminalType[];
1564 extern COM_ATTR                   BaudRateList[19];
1565 extern COM_ATTR                   DataBitsList[4];
1566 extern COM_ATTR                   ParityList[5];
1567 extern COM_ATTR                   StopBitsList[3];
1568 extern EFI_GUID                   TerminalTypeGuid[4];
1569 extern STRING_DEPOSITORY          *FileOptionStrDepository;
1570 extern STRING_DEPOSITORY          *ConsoleOptionStrDepository;
1571 extern STRING_DEPOSITORY          *BootOptionStrDepository;
1572 extern STRING_DEPOSITORY          *BootOptionHelpStrDepository;
1573 extern STRING_DEPOSITORY          *DriverOptionStrDepository;
1574 extern STRING_DEPOSITORY          *DriverOptionHelpStrDepository;
1575 extern STRING_DEPOSITORY          *TerminalStrDepository;
1576 extern EFI_DEVICE_PATH_PROTOCOL   EndDevicePath[];
1577 extern EFI_GUID                   EfiLegacyDevOrderGuid;
1578
1579 //
1580 // Shared IFR form update data
1581 //
1582 extern VOID                        *mStartOpCodeHandle;
1583 extern VOID                        *mEndOpCodeHandle;
1584 extern EFI_IFR_GUID_LABEL          *mStartLabel;
1585 extern EFI_IFR_GUID_LABEL          *mEndLabel;
1586
1587 #endif