IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h

   1 /** @file
   2   Generic BDS library defines general interfaces for BDS driver including:
   3     1) BDS boot policy interface
   4     2) BDS boot device connect interface
   5     3) BDS Misc interfaces for mainting boot variable, ouput string.
   6
   7 Copyright (c) 2004 - 2010, Intel Corporation. <BR>
   8 All rights reserved. This program and the accompanying materials
   9 are licensed and made available under the terms and conditions of the BSD License
  10 which accompanies this distribution.  The full text of the license may be found at
  11 http://opensource.org/licenses/bsd-license.php
  12
  13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16 **/
  17
  18 #ifndef _GENERIC_BDS_LIB_H_
  19 #define _GENERIC_BDS_LIB_H_
  20
  21 extern EFI_HANDLE mBdsImageHandle;
  22
  23 ///
  24 /// Constants which are variable names used to access variables
  25 ///
  26 #define VAR_LEGACY_DEV_ORDER L"LegacyDevOrder"
  27
  28 ///
  29 /// Data structures and defines
  30 ///
  31 #define FRONT_PAGE_QUESTION_ID  0x0000
  32 #define FRONT_PAGE_DATA_WIDTH   0x01
  33
  34 ///
  35 /// ConnectType
  36 ///
  37 #define CONSOLE_OUT 0x00000001
  38 #define STD_ERROR   0x00000002
  39 #define CONSOLE_IN  0x00000004
  40 #define CONSOLE_ALL (CONSOLE_OUT | CONSOLE_IN | STD_ERROR)
  41
  42 ///
  43 /// Load Option Attributes
  44 ///
  45 #define LOAD_OPTION_ACTIVE              0x00000001
  46 #define LOAD_OPTION_FORCE_RECONNECT     0x00000002
  47
  48 #define LOAD_OPTION_HIDDEN              0x00000008
  49 #define LOAD_OPTION_CATEGORY            0x00001F00
  50
  51 #define LOAD_OPTION_CATEGORY_BOOT       0x00000000
  52 #define LOAD_OPTION_CATEGORY_APP        0x00000100
  53
  54 #define EFI_BOOT_OPTION_SUPPORT_KEY     0x00000001
  55 #define EFI_BOOT_OPTION_SUPPORT_APP     0x00000002
  56
  57 #define IS_LOAD_OPTION_TYPE(_c, _Mask)  (BOOLEAN) (((_c) & (_Mask)) != 0)
  58
  59 ///
  60 /// Define Maximum characters that will be accepted
  61 ///
  62 #define MAX_CHAR            480
  63 #define MAX_CHAR_SIZE       (MAX_CHAR * 2)
  64
  65 ///
  66 /// Define maximum characters for boot option variable "BootXXXX"
  67 ///
  68 #define BOOT_OPTION_MAX_CHAR 10
  69
  70 //
  71 // This data structure is the part of BDS_CONNECT_ENTRY
  72 //
  73 #define BDS_LOAD_OPTION_SIGNATURE SIGNATURE_32 ('B', 'd', 'C', 'O')
  74
  75 typedef struct {
  76
  77   UINTN                     Signature;
  78   LIST_ENTRY                Link;
  79
  80   EFI_DEVICE_PATH_PROTOCOL  *DevicePath;
  81
  82   CHAR16                    *OptionName;
  83   UINTN                     OptionNumber;
  84   UINT16                    BootCurrent;
  85   UINT32                    Attribute;
  86   CHAR16                    *Description;
  87   VOID                      *LoadOptions;
  88   UINT32                    LoadOptionsSize;
  89   CHAR16                    *StatusString;
  90
  91 } BDS_COMMON_OPTION;
  92
  93 typedef struct {
  94   EFI_DEVICE_PATH_PROTOCOL  *DevicePath;
  95   UINTN                     ConnectType;
  96 } BDS_CONSOLE_CONNECT_ENTRY;
  97
  98 //
  99 // Bds boot related lib functions
 100 //
 101 /**
 102   Boot from the UEFI spec defined "BootNext" variable.
 103
 104 **/
 105 VOID
 106 EFIAPI
 107 BdsLibBootNext (
 108   VOID
 109   );
 110
 111 /**
 112   Process the boot option according to the UEFI specification. The legacy boot option device path includes BBS_DEVICE_PATH.
 113
 114   @param  Option                 The boot option to be processed
 115   @param  DevicePath             The device path describing where to load the
 116                                  boot image or the legcy BBS device path to boot
 117                                  the legacy OS
 118   @param  ExitDataSize           The size of exit data.
 119   @param  ExitData               Data returned when Boot image failed.
 120
 121   @retval EFI_SUCCESS            Boot from the input boot option succeeded.
 122   @retval EFI_NOT_FOUND          The Device Path is not found in the system
 123
 124 **/
 125 EFI_STATUS
 126 EFIAPI
 127 BdsLibBootViaBootOption (
 128   IN  BDS_COMMON_OPTION             * Option,
 129   IN  EFI_DEVICE_PATH_PROTOCOL      * DevicePath,
 130   OUT UINTN                         *ExitDataSize,
 131   OUT CHAR16                        **ExitData OPTIONAL
 132   );
 133
 134
 135 /**
 136   This function will enumerate all possible boot devices in the system, and
 137   automatically create boot options for Network, Shell, Removable BlockIo,
 138   and Non-BlockIo Simplefile devices.
 139
 140   BDS separates EFI boot options into six types:
 141   1. Network - The boot option points to the SimpleNetworkProtocol device.
 142                Bds will try to automatically create this type of boot option during enumeration.
 143   2. Shell   - The boot option points to internal flash shell.
 144                Bds will try to automatically create this type of boot option during enumeration.
 145   3. Removable BlockIo      - The boot option points to a removable media
 146                               device, such as a USB flash drive or DVD drive.
 147                               These devices should contain a *removable* blockIo
 148                               protocol in their device handle.
 149                               Bds will try to automatically create this type boot option
 150                               when enumerate.
 151   4. Fixed BlockIo          - The boot option points to a Fixed blockIo device,
 152                               such as a hard disk.
 153                               These devices should contain a *fixed* blockIo
 154                               protocol in their device handle.
 155                               BDS will skip fixed blockIo devices, and not
 156                               automatically create boot option for them. But BDS
 157                               will help to delete those fixed blockIo boot options,
 158                               whose description rules conflict with other auto-created
 159                               boot options.
 160   5. Non-BlockIo Simplefile - The boot option points to a device whose handle
 161                               has SimpleFileSystem Protocol, but has no blockio
 162                               protocol. These devices do not offer blockIo
 163                               protocol, but BDS still can get the
 164                               \EFI\BOOT\boot{machinename}.EFI by SimpleFileSystem
 165                               Protocol.
 166   6. File    - The boot option points to a file. These boot options are usually
 167                created by the user, either manually or with an OS loader. BDS will not delete or modify
 168                these boot options.
 169
 170   This function will enumerate all possible boot devices in the system, and
 171   automatically create boot options for Network, Shell, Removable BlockIo,
 172   and Non-BlockIo Simplefile devices.
 173   It will excute once every boot.
 174
 175   @param  BdsBootOptionList      The header of the linked list that indexed all
 176                                  current boot options
 177
 178   @retval EFI_SUCCESS            Finished all the boot device enumerations and created
 179                                  the boot option based on the boot device
 180
 181   @retval EFI_OUT_OF_RESOURCES   Failed to enumerate the boot device and create the boot option list
 182 **/
 183 EFI_STATUS
 184 EFIAPI
 185 BdsLibEnumerateAllBootOption (
 186   IN OUT LIST_ENTRY          *BdsBootOptionList
 187   );
 188
 189 /**
 190   Build the boot option with the handle parsed in
 191
 192   @param  Handle                 The handle representing the device path for which to create
 193                                  boot option
 194   @param  BdsBootOptionList      The header of the link list which indexed all
 195                                  current boot options
 196   @param  String                 The description of the boot option.
 197
 198 **/
 199 VOID
 200 EFIAPI
 201 BdsLibBuildOptionFromHandle (
 202   IN  EFI_HANDLE                 Handle,
 203   IN  LIST_ENTRY                 *BdsBootOptionList,
 204   IN  CHAR16                     *String
 205   );
 206
 207
 208 /**
 209   Build the on flash shell boot option with the handle parsed in.
 210
 211   @param  Handle                 The handle which present the device path to create
 212                                  on flash shell boot option
 213   @param  BdsBootOptionList      The header of the link list which indexed all
 214                                  current boot options
 215
 216 **/
 217 VOID
 218 EFIAPI
 219 BdsLibBuildOptionFromShell (
 220   IN EFI_HANDLE                  Handle,
 221   IN OUT LIST_ENTRY              *BdsBootOptionList
 222   );
 223
 224 //
 225 // Bds misc lib functions
 226 //
 227 /**
 228   Get boot mode by looking up configuration table and parsing HOB list
 229
 230   @param  BootMode              Boot mode from PEI handoff HOB.
 231
 232   @retval EFI_SUCCESS           Successfully get boot mode
 233
 234 **/
 235 EFI_STATUS
 236 EFIAPI
 237 BdsLibGetBootMode (
 238   OUT EFI_BOOT_MODE       *BootMode
 239   );
 240
 241
 242 /**
 243   The function will go through the driver option link list, and then load and start
 244   every driver to which the driver option device path points.
 245
 246   @param  BdsDriverLists        The header of the current driver option link list
 247
 248 **/
 249 VOID
 250 EFIAPI
 251 BdsLibLoadDrivers (
 252   IN LIST_ENTRY                   *BdsDriverLists
 253   );
 254
 255
 256 /**
 257   This function processes BootOrder or DriverOrder variables, by calling
 258
 259   BdsLibVariableToOption () for each UINT16 in the variables.
 260
 261   @param  BdsCommonOptionList   The header of the option list base on variable
 262                                 VariableName
 263   @param  VariableName          EFI Variable name indicate the BootOrder or
 264                                 DriverOrder
 265
 266   @retval EFI_SUCCESS           Success create the boot option or driver option
 267                                 list
 268   @retval EFI_OUT_OF_RESOURCES  Failed to get the boot option or driver option list
 269 **/
 270 EFI_STATUS
 271 EFIAPI
 272 BdsLibBuildOptionFromVar (
 273   IN  LIST_ENTRY                      *BdsCommonOptionList,
 274   IN  CHAR16                          *VariableName
 275   );
 276
 277 /**
 278   This function reads the EFI variable (VendorGuid/Name) and returns a dynamically allocated
 279   buffer and the size of the buffer. If failure, return NULL.
 280
 281   @param  Name                  String part of EFI variable name
 282   @param  VendorGuid            GUID part of EFI variable name
 283   @param  VariableSize          Returns the size of the EFI variable that was read
 284
 285   @return                       Dynamically allocated memory that contains a copy of the EFI variable
 286                                 Caller is responsible freeing the buffer.
 287   @retval NULL                  Variable was not read
 288
 289 **/
 290 VOID *
 291 EFIAPI
 292 BdsLibGetVariableAndSize (
 293   IN  CHAR16              *Name,
 294   IN  EFI_GUID            *VendorGuid,
 295   OUT UINTN               *VariableSize
 296   );
 297
 298
 299 /**
 300   This function prints a series of strings.
 301
 302   @param  ConOut                Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
 303   @param  ...                   A variable argument list containing series of
 304                                 strings, the last string must be NULL.
 305
 306   @retval EFI_SUCCESS           Success print out the string using ConOut.
 307   @retval EFI_STATUS            Return the status of the ConOut->OutputString ().
 308
 309 **/
 310 EFI_STATUS
 311 EFIAPI
 312 BdsLibOutputStrings (
 313   IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   *ConOut,
 314   ...
 315   );
 316
 317 /**
 318   Build the boot#### or driver#### option from the VariableName. The
 319   build boot#### or driver#### will also be linked to BdsCommonOptionList.
 320
 321   @param  BdsCommonOptionList   The header of the boot#### or driver#### option
 322                                 link list
 323   @param  VariableName          EFI Variable name, indicates if it is boot#### or
 324                                 driver####
 325
 326   @retval BDS_COMMON_OPTION     The option that was created
 327   @retval NULL                  Failed to get the new option
 328
 329 **/
 330 BDS_COMMON_OPTION *
 331 EFIAPI
 332 BdsLibVariableToOption (
 333   IN OUT LIST_ENTRY                   *BdsCommonOptionList,
 334   IN  CHAR16                          *VariableName
 335   );
 336
 337 /**
 338   This function registers the new boot#### or driver#### option based on
 339   the VariableName. The new registered boot#### or driver#### will be linked
 340   to BdsOptionList and also update to the VariableName. After the boot#### or
 341   driver#### updated, the BootOrder or DriverOrder will also be updated.
 342
 343   @param  BdsOptionList         The header of the boot#### or driver#### link list
 344   @param  DevicePath            The device path which the boot#### or driver####
 345                                 option present
 346   @param  String                The description of the boot#### or driver####
 347   @param  VariableName          Indicate if the boot#### or driver#### option
 348
 349   @retval EFI_SUCCESS           The boot#### or driver#### have been success
 350                                 registered
 351   @retval EFI_STATUS            Return the status of gRT->SetVariable ().
 352
 353 **/
 354 EFI_STATUS
 355 EFIAPI
 356 BdsLibRegisterNewOption (
 357   IN  LIST_ENTRY                     *BdsOptionList,
 358   IN  EFI_DEVICE_PATH_PROTOCOL       *DevicePath,
 359   IN  CHAR16                         *String,
 360   IN  CHAR16                         *VariableName
 361   );
 362
 363 //
 364 // Bds connect and disconnect driver lib funcions
 365 //
 366 /**
 367   This function connects all system drivers with the corresponding controllers.
 368
 369 **/
 370 VOID
 371 EFIAPI
 372 BdsLibConnectAllDriversToAllControllers (
 373   VOID
 374   );
 375
 376 /**
 377   This function connects all system drivers to controllers.
 378
 379 **/
 380 VOID
 381 EFIAPI
 382 BdsLibConnectAll (
 383   VOID
 384   );
 385
 386 /**
 387   This function creates all handles associated with the given device
 388   path node. If the handle associated with one device path node can not
 389   be created, then it tries to execute the dispatch to load the missing drivers.
 390
 391   @param  DevicePathToConnect   The device path to be connected. Can be
 392                                 a multi-instance device path
 393
 394   @retval EFI_SUCCESS           All handles associates with every device path node
 395                                 were created
 396   @retval EFI_OUT_OF_RESOURCES  Not enough resources to create new handles
 397   @retval EFI_NOT_FOUND         At least one handle could not be created
 398
 399 **/
 400 EFI_STATUS
 401 EFIAPI
 402 BdsLibConnectDevicePath (
 403   IN EFI_DEVICE_PATH_PROTOCOL  *DevicePathToConnect
 404   );
 405
 406 /**
 407   This function will connect all current system handles recursively.     gBS->ConnectController() service is invoked for each handle exist in system handler buffer.  If the handle is bus type handler, all childrens also will be connected recursively  by gBS->ConnectController().
 408   @retval EFI_SUCCESS           All handles and child handles have been                                connected  @retval EFI_STATUS            Return the status of gBS->LocateHandleBuffer().
 409 **/
 410 EFI_STATUS
 411 EFIAPI
 412 BdsLibConnectAllEfi (
 413   VOID
 414   );
 415
 416 /**
 417   This function will disconnect all current system handles.     gBS->DisconnectController() is invoked for each handle exists in system handle buffer.  If handle is a bus type handle, all childrens also are disconnected recursively by  gBS->DisconnectController().
 418   @retval EFI_SUCCESS           All handles have been disconnected
 419   @retval EFI_STATUS            Error status returned by of gBS->LocateHandleBuffer().
 420
 421 **/
 422 EFI_STATUS
 423 EFIAPI
 424 BdsLibDisconnectAllEfi (
 425   VOID
 426   );
 427
 428 //
 429 // Bds console related lib functions
 430 //
 431 /**
 432   This function will search every simpletxt device in the current system,
 433   and make every simpletxt device a potential console device.
 434
 435 **/
 436 VOID
 437 EFIAPI
 438 BdsLibConnectAllConsoles (
 439   VOID
 440   );
 441
 442
 443 /**
 444   This function will connect console device based on the console
 445   device variable ConIn, ConOut and ErrOut.
 446
 447   @retval EFI_SUCCESS              At least one of the ConIn and ConOut devices have
 448                                    been connected.
 449   @retval EFI_STATUS               Return the status of BdsLibConnectConsoleVariable ().
 450
 451 **/
 452 EFI_STATUS
 453 EFIAPI
 454 BdsLibConnectAllDefaultConsoles (
 455   VOID
 456   );
 457
 458 /**
 459   This function updates the console variable based on ConVarName. It can
 460   add or remove one specific console device path from the variable
 461
 462   @param  ConVarName               Console-related variable name: ConIn, ConOut,
 463                                    ErrOut.
 464   @param  CustomizedConDevicePath  The console device path to be added to
 465                                    the console variable ConVarName. Can not be multi-instance.
 466   @param  ExclusiveDevicePath      The console device path to be removed
 467                                    from the console variable ConVarName. Can not be multi-instance.
 468
 469   @retval EFI_UNSUPPORTED          The added device path is the same as a removed one.
 470   @retval EFI_SUCCESS              Successfully added or removed the device path from the
 471                                    console variable.
 472
 473 **/
 474 EFI_STATUS
 475 EFIAPI
 476 BdsLibUpdateConsoleVariable (
 477   IN  CHAR16                    *ConVarName,
 478   IN  EFI_DEVICE_PATH_PROTOCOL  *CustomizedConDevicePath,
 479   IN  EFI_DEVICE_PATH_PROTOCOL  *ExclusiveDevicePath
 480   );
 481
 482 /**
 483   Connect the console device base on the variable ConVarName. If
 484   ConVarName is a multi-instance device path, and at least one
 485   instance connects successfully, then this function
 486   will return success.
 487
 488   @param  ConVarName               Console related variable name, ConIn, ConOut,
 489                                    ErrOut.
 490
 491   @retval EFI_NOT_FOUND            No console devices were connected successfully
 492   @retval EFI_SUCCESS              Connected at least one instance of the console
 493                                    device path based on the variable ConVarName.
 494
 495 **/
 496 EFI_STATUS
 497 EFIAPI
 498 BdsLibConnectConsoleVariable (
 499   IN  CHAR16                 *ConVarName
 500   );
 501
 502 //
 503 // Bds device path related lib functions
 504 //
 505 /**
 506   Delete the instance in Multi that overlaps with Single
 507
 508   @param  Multi                 A pointer to a multi-instance device path data
 509                                 structure.
 510   @param  Single                A pointer to a single-instance device path data
 511                                 structure.
 512
 513   @return This function removes the device path instances in Multi that overlap
 514    Single, and returns the resulting device path. If there is no
 515           remaining device path as a result, this function will return NULL.
 516
 517 **/
 518 EFI_DEVICE_PATH_PROTOCOL *
 519 EFIAPI
 520 BdsLibDelPartMatchInstance (
 521   IN     EFI_DEVICE_PATH_PROTOCOL  *Multi,
 522   IN     EFI_DEVICE_PATH_PROTOCOL  *Single
 523   );
 524
 525 /**
 526   Function compares a device path data structure to that of all the nodes of a
 527   second device path instance.
 528
 529   @param  Multi                 A pointer to a multi-instance device path data
 530                                 structure.
 531   @param  Single                A pointer to a single-instance device path data
 532                                 structure.
 533
 534   @retval TRUE                  If the Single device path is contained within Multi device path.
 535   @retval FALSE                 The Single device path is not contained within Multi device path.
 536
 537 **/
 538 BOOLEAN
 539 EFIAPI
 540 BdsLibMatchDevicePaths (
 541   IN  EFI_DEVICE_PATH_PROTOCOL  *Multi,
 542   IN  EFI_DEVICE_PATH_PROTOCOL  *Single
 543   );
 544
 545 /**
 546   This function converts an input device structure to a Unicode string.
 547
 548   @param DevPath                  A pointer to the device path structure.
 549
 550   @return A new allocated Unicode string that represents the device path.
 551
 552 **/
 553 CHAR16 *
 554 EFIAPI
 555 DevicePathToStr (
 556   IN EFI_DEVICE_PATH_PROTOCOL     *DevPath
 557   );
 558
 559
 560 //
 561 // Internal definitions
 562 //
 563 typedef struct {
 564   CHAR16  *Str;
 565   UINTN   Len;
 566   UINTN   Maxlen;
 567 } POOL_PRINT;
 568
 569 typedef
 570 VOID
 571 (*DEV_PATH_FUNCTION) (
 572   IN OUT POOL_PRINT       *Str,
 573   IN VOID                 *DevPath
 574   );
 575
 576 typedef struct {
 577   UINT8             Type;
 578   UINT8             SubType;
 579   DEV_PATH_FUNCTION Function;
 580 } DEVICE_PATH_STRING_TABLE;
 581
 582 extern EFI_GUID mEfiDevicePathMessagingUartFlowControlGuid;
 583
 584 typedef struct {
 585   EFI_DEVICE_PATH_PROTOCOL  Header;
 586   EFI_GUID                  Guid;
 587   UINT8                     VendorDefinedData[1];
 588 } VENDOR_DEVICE_PATH_WITH_DATA;
 589
 590
 591 extern EFI_GUID mEfiDevicePathMessagingSASGuid;
 592
 593 typedef struct {
 594   EFI_DEVICE_PATH_PROTOCOL  Header;
 595   UINT16                    NetworkProtocol;
 596   UINT16                    LoginOption;
 597   UINT64                    Lun;
 598   UINT16                    TargetPortalGroupTag;
 599   CHAR16                    TargetName[1];
 600 } ISCSI_DEVICE_PATH_WITH_NAME;
 601
 602
 603 //
 604 // Notes: EFI 64 shadow all option rom
 605 //
 606 #if defined (MDE_CPU_IPF)
 607 #define EFI64_SHADOW_ALL_LEGACY_ROM() ShadowAllOptionRom ();
 608 #else
 609 #define EFI64_SHADOW_ALL_LEGACY_ROM()
 610 #endif
 611
 612 /**
 613   Shadow all Legacy OptionRom.
 614
 615 **/
 616 VOID
 617 EFIAPI
 618 ShadowAllOptionRom (
 619   VOID
 620   );
 621
 622 //
 623 // BBS support macros and functions
 624 //
 625
 626 #if defined(MDE_CPU_IA32) || defined(MDE_CPU_X64)
 627 #define REFRESH_LEGACY_BOOT_OPTIONS \
 628         BdsDeleteAllInvalidLegacyBootOptions ();\
 629         BdsAddNonExistingLegacyBootOptions (); \
 630         BdsUpdateLegacyDevOrder ()
 631 #else
 632 #define REFRESH_LEGACY_BOOT_OPTIONS
 633 #endif
 634
 635 /**
 636   Delete all the invalid legacy boot options.
 637
 638   @retval EFI_SUCCESS             All invalide legacy boot options are deleted.
 639   @retval EFI_OUT_OF_RESOURCES    Fail to allocate necessary memory.
 640   @retval EFI_NOT_FOUND           Fail to retrieve variable of boot order.
 641
 642 **/
 643 EFI_STATUS
 644 EFIAPI
 645 BdsDeleteAllInvalidLegacyBootOptions (
 646   VOID
 647   );
 648
 649 /**
 650   Add the legacy boot options from BBS table if they do not exist.
 651
 652   @retval EFI_SUCCESS          The boot options are added successfully
 653                                or they are already in boot options.
 654   @retval EFI_NOT_FOUND        No legacy boot options is found.
 655   @retval EFI_OUT_OF_RESOURCE  No enough memory.
 656   @return Other value          LegacyBoot options are not added.
 657 **/
 658 EFI_STATUS
 659 EFIAPI
 660 BdsAddNonExistingLegacyBootOptions (
 661   VOID
 662   );
 663
 664 /**
 665   Add the legacy boot devices from BBS table into
 666   the legacy device boot order.
 667
 668   @retval EFI_SUCCESS           The boot devices are added successfully.
 669   @retval EFI_NOT_FOUND         The legacy boot devices are not found.
 670   @retval EFI_OUT_OF_RESOURCES  Memmory or storage is not enough.
 671   @retval EFI_DEVICE_ERROR      Fail to add the legacy device boot order into EFI variable
 672                                 because of hardware error.
 673 **/
 674 EFI_STATUS
 675 EFIAPI
 676 BdsUpdateLegacyDevOrder (
 677   VOID
 678   );
 679
 680 /**
 681   Refresh the boot priority for BBS entries based on boot option entry and boot order.
 682
 683   @param  Entry             The boot option is to be checked for refresh BBS table.
 684
 685   @retval EFI_SUCCESS           The boot priority for BBS entries is refreshed successfully.
 686   @retval EFI_NOT_FOUND         BBS entries can't be found.
 687   @retval EFI_OUT_OF_RESOURCES  Failed to get the legacy device boot order.
 688 **/
 689 EFI_STATUS
 690 EFIAPI
 691 BdsRefreshBbsTableForBoot (
 692   IN BDS_COMMON_OPTION        *Entry
 693   );
 694
 695 /**
 696   Delete the Boot Option from EFI Variable. The Boot Order Arrray
 697   is also updated.
 698
 699   @param OptionNumber    The number of Boot option want to be deleted.
 700   @param BootOrder       The Boot Order array.
 701   @param BootOrderSize   The size of the Boot Order Array.
 702
 703   @retval  EFI_SUCCESS           The Boot Option Variable was found and removed
 704   @retval  EFI_UNSUPPORTED       The Boot Option Variable store was inaccessible
 705   @retval  EFI_NOT_FOUND         The Boot Option Variable was not found
 706 **/
 707 EFI_STATUS
 708 EFIAPI
 709 BdsDeleteBootOption (
 710   IN UINTN                       OptionNumber,
 711   IN OUT UINT16                  *BootOrder,
 712   IN OUT UINTN                   *BootOrderSize
 713   );
 714
 715 //
 716 //The interface functions related to the Setup Browser Reset Reminder feature
 717 //
 718 /**
 719   Enable the setup browser reset reminder feature.
 720   This routine is used in platform tip. If the platform policy needs the feature, use the routine to enable it.
 721
 722 **/
 723 VOID
 724 EFIAPI
 725 EnableResetReminderFeature (
 726   VOID
 727   );
 728
 729 /**
 730   Disable the setup browser reset reminder feature.
 731   This routine is used in platform tip. If the platform policy does not want the feature, use the routine to disable it.
 732
 733 **/
 734 VOID
 735 EFIAPI
 736 DisableResetReminderFeature (
 737   VOID
 738   );
 739
 740 /**
 741   Record the info that a reset is required.
 742   A module boolean variable is used to record whether a reset is required.
 743
 744 **/
 745 VOID
 746 EFIAPI
 747 EnableResetRequired (
 748   VOID
 749   );
 750
 751
 752 /**
 753   Record the info that no reset is required.
 754   A module boolean variable is used to record whether a reset is required.
 755
 756 **/
 757 VOID
 758 EFIAPI
 759 DisableResetRequired (
 760   VOID
 761   );
 762
 763 /**
 764   Check whether platform policy enables the reset reminder feature. The default is enabled.
 765
 766 **/
 767 BOOLEAN
 768 EFIAPI
 769 IsResetReminderFeatureEnable (
 770   VOID
 771   );
 772
 773 /**
 774   Check if the user changed any option setting that needs a system reset to be effective.
 775
 776 **/
 777 BOOLEAN
 778 EFIAPI
 779 IsResetRequired (
 780   VOID
 781   );
 782
 783 /**
 784   Check whether a reset is needed, and finish the reset reminder feature.
 785   If a reset is needed, pop up a menu to notice user, and finish the feature
 786   according to the user selection.
 787
 788 **/
 789 VOID
 790 EFIAPI
 791 SetupResetReminder (
 792   VOID
 793   );
 794
 795
 796 ///
 797 /// Define the boot type which to classify the boot option type
 798 /// Different boot option type could have different boot behavior
 799 /// Use their device path node (Type + SubType) as type value
 800 /// The boot type here can be added according to requirement
 801 ///
 802
 803 ///
 804 /// ACPI boot type. For ACPI device, cannot use sub-type to distinguish device, so hardcode their value
 805 ///
 806 #define  BDS_EFI_ACPI_FLOPPY_BOOT         0x0201
 807 ///
 808 /// Message boot type
 809 /// If a device path of boot option only point to a message node, the boot option is message boot type
 810 ///
 811 #define  BDS_EFI_MESSAGE_ATAPI_BOOT       0x0301 // Type 03; Sub-Type 01
 812 #define  BDS_EFI_MESSAGE_SCSI_BOOT        0x0302 // Type 03; Sub-Type 02
 813 #define  BDS_EFI_MESSAGE_USB_DEVICE_BOOT  0x0305 // Type 03; Sub-Type 05
 814 #define  BDS_EFI_MESSAGE_SATA_BOOT        0x0312 // Type 03; Sub-Type 18
 815 #define  BDS_EFI_MESSAGE_MAC_BOOT         0x030b // Type 03; Sub-Type 11
 816 #define  BDS_EFI_MESSAGE_MISC_BOOT        0x03FF
 817
 818 ///
 819 /// Media boot type
 820 /// If a device path of boot option contain a media node, the boot option is media boot type
 821 ///
 822 #define  BDS_EFI_MEDIA_HD_BOOT            0x0401 // Type 04; Sub-Type 01
 823 #define  BDS_EFI_MEDIA_CDROM_BOOT         0x0402 // Type 04; Sub-Type 02
 824 ///
 825 /// BBS boot type
 826 /// If a device path of boot option contain a BBS node, the boot option is BBS boot type
 827 ///
 828 #define  BDS_LEGACY_BBS_BOOT              0x0501 //  Type 05; Sub-Type 01
 829
 830 #define  BDS_EFI_UNSUPPORT                0xFFFF
 831
 832 /**
 833   Check whether an instance in BlockIoDevicePath has the same partition node as the HardDriveDevicePath device path
 834
 835   @param  BlockIoDevicePath      Multi device path instances to check
 836   @param  HardDriveDevicePath    A device path starting with a hard drive media
 837                                  device path.
 838
 839   @retval TRUE                   There is a matched device path instance.
 840   @retval FALSE                  There is no matched device path instance.
 841
 842 **/
 843 BOOLEAN
 844 EFIAPI
 845 MatchPartitionDevicePathNode (
 846   IN  EFI_DEVICE_PATH_PROTOCOL   *BlockIoDevicePath,
 847   IN  HARDDRIVE_DEVICE_PATH      *HardDriveDevicePath
 848   );
 849
 850
 851 /**
 852   Expand a device path that starts with a hard drive media device path node to be a
 853   full device path that includes the full hardware path to the device. This function enables the device to boot.
 854   To avoid requiring a connect on every boot, the front match is saved in a variable (the part point
 855   to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ).
 856   All successful history device paths
 857   that point to the front part of the partition node will be saved.
 858
 859   @param  HardDriveDevicePath    EFI Device Path to boot, if it starts with a hard
 860                                  drive media device path.
 861   @return A Pointer to the full device path or NULL if a valid Hard Drive devic path
 862           cannot be found.
 863
 864 **/
 865 EFI_DEVICE_PATH_PROTOCOL *
 866 EFIAPI
 867 BdsExpandPartitionPartialDevicePathToFull (
 868   IN  HARDDRIVE_DEVICE_PATH      *HardDriveDevicePath
 869   );
 870
 871 /**
 872   Return the bootable media handle.
 873   First, check whether the device is connected.
 874   Second, check whether the device path points to a device that supports SimpleFileSystemProtocol.
 875   Third, detect the the default boot file in the Media, and return the removable Media handle.
 876
 877   @param  DevicePath             Device Path to a  bootable device
 878
 879   @return  The bootable media handle. If the media on the DevicePath is not bootable, NULL will return.
 880
 881 **/
 882 EFI_HANDLE
 883 EFIAPI
 884 BdsLibGetBootableHandle (
 885   IN  EFI_DEVICE_PATH_PROTOCOL      *DevicePath
 886   );
 887
 888
 889 /**
 890   Checks whether the Device path in a boot option points to a valid bootable device, and if the device
 891   is ready to boot now.
 892
 893   @param  DevPath     the Device path in a boot option
 894   @param  CheckMedia  if true, check whether the device is ready to boot now.
 895
 896   @retval TRUE        the Device path is valid
 897   @retval FALSE       the Device path is invalid
 898
 899 **/
 900 BOOLEAN
 901 EFIAPI
 902 BdsLibIsValidEFIBootOptDevicePath (
 903   IN EFI_DEVICE_PATH_PROTOCOL     *DevPath,
 904   IN BOOLEAN                      CheckMedia
 905   );
 906
 907 /**
 908   Checks whether the Device path in a boot option points to a valid bootable device, and if the device
 909   is ready to boot now.
 910   If Description is not NULL and the device path points to a fixed BlockIo
 911   device, this function checks whether the description conflicts with other auto-created
 912   boot options.
 913
 914   @param  DevPath     the Device path in a boot option
 915   @param  CheckMedia  if true, checks if the device is ready to boot now.
 916   @param  Description the description of a boot option
 917
 918   @retval TRUE        the Device path is valid
 919   @retval FALSE       the Device path is invalid
 920
 921 **/
 922 BOOLEAN
 923 EFIAPI
 924 BdsLibIsValidEFIBootOptDevicePathExt (
 925   IN EFI_DEVICE_PATH_PROTOCOL     *DevPath,
 926   IN BOOLEAN                      CheckMedia,
 927   IN CHAR16                       *Description
 928   );
 929
 930 /**
 931   For a bootable Device path, return its boot type.
 932
 933   @param  DevicePath                      The bootable device Path to check
 934
 935   @retval BDS_EFI_MEDIA_HD_BOOT           If given device path contains MEDIA_DEVICE_PATH type device path node                                           which subtype is MEDIA_HARDDRIVE_DP  @retval BDS_EFI_MEDIA_CDROM_BOOT        If given device path contains MEDIA_DEVICE_PATH type device path node                                          which subtype is MEDIA_CDROM_DP  @retval BDS_EFI_ACPI_FLOPPY_BOOT        If given device path contains ACPI_DEVICE_PATH type device path node                                          which HID is floppy device.  @retval BDS_EFI_MESSAGE_ATAPI_BOOT      If given device path contains MESSAGING_DEVICE_PATH type device path node                                          and its last device path node's subtype is MSG_ATAPI_DP.  @retval BDS_EFI_MESSAGE_SCSI_BOOT       If given device path contains MESSAGING_DEVICE_PATH type device path node                                          and its last device path node's subtype is MSG_SCSI_DP.  @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node                                          and its last device path node's subtype is MSG_USB_DP.  @retval BDS_EFI_MESSAGE_MISC_BOOT       If the device path not contains any media device path node,  and                                          its last device path node point to a message device path node.  @retval BDS_LEGACY_BBS_BOOT             If given device path contains BBS_DEVICE_PATH type device path node.  @retval BDS_EFI_UNSUPPORT               An EFI Removable BlockIO device path not point to a media and message device,
 936 **/
 937 UINT32
 938 EFIAPI
 939 BdsGetBootTypeFromDevicePath (
 940   IN  EFI_DEVICE_PATH_PROTOCOL     *DevicePath
 941   );
 942
 943
 944 /**
 945   This routine registers a function to adjust the different types of memory page numbers
 946   just before booting, and saves the updated info into the variable for the next boot to use.
 947
 948 **/
 949 VOID
 950 EFIAPI
 951 BdsLibSaveMemoryTypeInformation (
 952   VOID
 953   );
 954
 955
 956 /**
 957   This function checks if a Fv file device path is valid, according to a file GUID. If it is invalid,
 958   it tries to return the valid device path.
 959   FV address maybe changes for memory layout adjust from time to time, use this funciton
 960   could promise the Fv file device path is right.
 961
 962   @param  DevicePath             on input, the Fv file device path to check. On
 963                                  output, the updated valid Fv file device path
 964   @param  FileGuid               the Fv file GUID
 965
 966   @retval EFI_INVALID_PARAMETER  the input DevicePath or FileGuid is invalid
 967   @retval EFI_UNSUPPORTED        the input DevicePath does not contain an Fv file
 968                                  GUID at all
 969   @retval EFI_ALREADY_STARTED    the input DevicePath has pointed to the Fv file and is
 970                                  valid
 971   @retval EFI_SUCCESS            successfully updated the invalid DevicePath
 972                                  and returned the updated device path in DevicePath
 973
 974 **/
 975 EFI_STATUS
 976 EFIAPI
 977 BdsLibUpdateFvFileDevicePath (
 978   IN  OUT EFI_DEVICE_PATH_PROTOCOL      ** DevicePath,
 979   IN  EFI_GUID                          *FileGuid
 980   );
 981
 982
 983 /**
 984   Connect the specific USB device that matches the RemainingDevicePath,
 985   and whose bus is determined by Host Controller (Uhci or Ehci)
 986
 987   @param  HostControllerPI      Uhci (0x00) or Ehci (0x20) or Both uhci and ehci
 988                                 (0xFF)
 989   @param  RemainingDevicePath   a short-form device path that starts with the first
 990                                 element being a USB WWID or a USB Class device
 991                                 path
 992
 993   @retval EFI_SUCCESS           The specific Usb device is connected successfully.
 994   @retval EFI_INVALID_PARAMETER Invalid HostControllerPi (not 0x00, 0x20 or 0xFF)
 995                                 or RemainingDevicePath is not the USB class device path.
 996   @retval EFI_NOT_FOUND         The device specified by device path is not found.
 997
 998 **/
 999 EFI_STATUS
1000 EFIAPI
1001 BdsLibConnectUsbDevByShortFormDP(
1002   IN UINT8                      HostControllerPI,
1003   IN EFI_DEVICE_PATH_PROTOCOL   *RemainingDevicePath
1004   );
1005
1006
1007 //
1008 // The implementation of this function is provided by Platform code.
1009 //
1010 /**
1011   Convert Vendor device path to a device name.
1012
1013   @param  Str      The buffer storing device name
1014   @param  DevPath  Pointer to vendor device path
1015
1016 **/
1017 VOID
1018 DevPathVendor (
1019   IN OUT POOL_PRINT       *Str,
1020   IN VOID                 *DevPath
1021   );
1022
1023 /**
1024   Concatenates a formatted unicode string to allocated pool.
1025   The caller must free the resulting buffer.
1026
1027   @param  Str      Tracks the allocated pool, size in use, and amount of pool allocated.
1028   @param  Fmt      The format string
1029   @param  ...      The data will be printed.
1030
1031   @return Allocated buffer with the formatted string printed in it.
1032           The caller must free the allocated buffer.
1033           The buffer allocation is not packed.
1034
1035 **/
1036 CHAR16 *
1037 EFIAPI
1038 CatPrint (
1039   IN OUT POOL_PRINT   *Str,
1040   IN CHAR16           *Fmt,
1041   ...
1042   );
1043
1044 /**
1045   Use SystemTable ConOut to stop video based Simple Text Out consoles from going
1046   to the video device. Put up LogoFile on every video device that is a console.
1047
1048   @param[in]  LogoFile   File name of logo to display on the center of the screen.
1049
1050   @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.
1051   @retval EFI_UNSUPPORTED Logo not found
1052
1053 **/
1054 EFI_STATUS
1055 EFIAPI
1056 EnableQuietBoot (
1057   IN  EFI_GUID  *LogoFile
1058   );
1059
1060
1061 /**
1062   Use SystemTable ConOut to turn on video based Simple Text Out consoles. The
1063   Simple Text Out screens will now be synced up with all non video output devices
1064
1065   @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.
1066
1067 **/
1068 EFI_STATUS
1069 EFIAPI
1070 DisableQuietBoot (
1071   VOID
1072   );
1073
1074 #endif
1075