1 /** @file 2 Generic BDS library defines general interfaces for a 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 - 2013, Intel Corporation. All rights reserved.<BR> 8 This program and the accompanying materials are licensed and made available under 9 the terms and conditions of the BSD License that accompanies this distribution. 10 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 #include <Protocol/UserManager.h> 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 the 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 179 created the boot option based on the boot device. 180 181 @retval EFI_OUT_OF_RESOURCES Failed to enumerate the boot device and create 182 the boot option list. 183 **/ 184 EFI_STATUS 185 EFIAPI 186 BdsLibEnumerateAllBootOption ( 187 IN OUT LIST_ENTRY *BdsBootOptionList 188 ); 189 190 /** 191 Build the boot option with the handle parsed in. 192 193 @param Handle The handle representing the device path for which 194 to create a boot option. 195 @param BdsBootOptionList The header of the link list that indexed all 196 current boot options. 197 @param String The description of the boot option. 198 199 **/ 200 VOID 201 EFIAPI 202 BdsLibBuildOptionFromHandle ( 203 IN EFI_HANDLE Handle, 204 IN LIST_ENTRY *BdsBootOptionList, 205 IN CHAR16 *String 206 ); 207 208 209 /** 210 Build the on flash shell boot option with the handle parsed in. 211 212 @param Handle The handle which present the device path to create 213 the on flash shell boot option. 214 @param BdsBootOptionList The header of the link list that indexed all 215 current boot options. 216 217 **/ 218 VOID 219 EFIAPI 220 BdsLibBuildOptionFromShell ( 221 IN EFI_HANDLE Handle, 222 IN OUT LIST_ENTRY *BdsBootOptionList 223 ); 224 225 // 226 // Bds misc lib functions 227 // 228 /** 229 Get boot mode by looking up the configuration table and parsing the HOB list. 230 231 @param BootMode The boot mode from PEI handoff HOB. 232 233 @retval EFI_SUCCESS Successfully got boot mode. 234 235 **/ 236 EFI_STATUS 237 EFIAPI 238 BdsLibGetBootMode ( 239 OUT EFI_BOOT_MODE *BootMode 240 ); 241 242 243 /** 244 The function will go through the driver option link list, and then load and start 245 every driver to which the driver option device path points. 246 247 @param BdsDriverLists The header of the current driver option link list. 248 249 **/ 250 VOID 251 EFIAPI 252 BdsLibLoadDrivers ( 253 IN LIST_ENTRY *BdsDriverLists 254 ); 255 256 257 /** 258 This function processes BootOrder or DriverOrder variables, by calling 259 260 BdsLibVariableToOption () for each UINT16 in the variables. 261 262 @param BdsCommonOptionList The header of the option list base on the variable 263 VariableName. 264 @param VariableName An EFI Variable name indicate the BootOrder or 265 DriverOrder. 266 267 @retval EFI_SUCCESS Successfully created the boot option or driver option 268 list. 269 @retval EFI_OUT_OF_RESOURCES Failed to get the boot option or the driver option list. 270 **/ 271 EFI_STATUS 272 EFIAPI 273 BdsLibBuildOptionFromVar ( 274 IN LIST_ENTRY *BdsCommonOptionList, 275 IN CHAR16 *VariableName 276 ); 277 278 /** 279 This function reads the EFI variable (VendorGuid/Name) and returns a dynamically allocated 280 buffer and the size of the buffer. If it fails, return NULL. 281 282 @param Name The string part of the EFI variable name. 283 @param VendorGuid The GUID part of the EFI variable name. 284 @param VariableSize Returns the size of the EFI variable that was read. 285 286 @return Dynamically allocated memory that contains a copy 287 of the EFI variable. The caller is responsible for 288 freeing the buffer. 289 @retval NULL The variable was not read. 290 291 **/ 292 VOID * 293 EFIAPI 294 BdsLibGetVariableAndSize ( 295 IN CHAR16 *Name, 296 IN EFI_GUID *VendorGuid, 297 OUT UINTN *VariableSize 298 ); 299 300 301 /** 302 This function prints a series of strings. 303 304 @param ConOut A pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL. 305 @param ... A variable argument list containing a series of 306 strings, the last string must be NULL. 307 308 @retval EFI_SUCCESS Successfully printed out the string using ConOut. 309 @retval EFI_STATUS Return the status of the ConOut->OutputString (). 310 311 **/ 312 EFI_STATUS 313 EFIAPI 314 BdsLibOutputStrings ( 315 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *ConOut, 316 ... 317 ); 318 319 /** 320 Build the boot#### or driver#### option from the VariableName. The 321 build boot#### or driver#### will also be linked to BdsCommonOptionList. 322 323 @param BdsCommonOptionList The header of the boot#### or driver#### option 324 link list. 325 @param VariableName EFI Variable name, indicates if it is boot#### or 326 driver####. 327 328 @retval BDS_COMMON_OPTION The option that was created. 329 @retval NULL Failed to get the new option. 330 331 **/ 332 BDS_COMMON_OPTION * 333 EFIAPI 334 BdsLibVariableToOption ( 335 IN OUT LIST_ENTRY *BdsCommonOptionList, 336 IN CHAR16 *VariableName 337 ); 338 339 /** 340 This function registers the new boot#### or driver#### option based on 341 the VariableName. The new registered boot#### or driver#### will be linked 342 to BdsOptionList and also update to the VariableName. After the boot#### or 343 driver#### updated, the BootOrder or DriverOrder will also be updated. 344 345 @param BdsOptionList The header of the boot#### or driver#### link list. 346 @param DevicePath The device path that the boot#### or driver#### 347 option present. 348 @param String The description of the boot#### or driver####. 349 @param VariableName Indicate if the boot#### or driver#### option. 350 351 @retval EFI_SUCCESS The boot#### or driver#### have been successfully 352 registered. 353 @retval EFI_STATUS Return the status of gRT->SetVariable (). 354 355 **/ 356 EFI_STATUS 357 EFIAPI 358 BdsLibRegisterNewOption ( 359 IN LIST_ENTRY *BdsOptionList, 360 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, 361 IN CHAR16 *String, 362 IN CHAR16 *VariableName 363 ); 364 365 // 366 // Bds connect and disconnect driver lib funcions 367 // 368 /** 369 This function connects all system drivers with the corresponding controllers. 370 371 **/ 372 VOID 373 EFIAPI 374 BdsLibConnectAllDriversToAllControllers ( 375 VOID 376 ); 377 378 /** 379 This function connects all system drivers to controllers. 380 381 **/ 382 VOID 383 EFIAPI 384 BdsLibConnectAll ( 385 VOID 386 ); 387 388 /** 389 This function will create all handles associate with every device 390 path node. If the handle associate with one device path node can not 391 be created successfully, then still give chance to do the dispatch, 392 which load the missing drivers if possible. 393 394 @param DevicePathToConnect The device path to be connected. Can be 395 a multi-instance device path. 396 397 @retval EFI_SUCCESS All handles associates with every device path node 398 were created. 399 @retval EFI_OUT_OF_RESOURCES Not enough resources to create new handles. 400 @retval EFI_NOT_FOUND At least one handle could not be created. 401 402 **/ 403 EFI_STATUS 404 EFIAPI 405 BdsLibConnectDevicePath ( 406 IN EFI_DEVICE_PATH_PROTOCOL *DevicePathToConnect 407 ); 408 409 /** 410 This function will connect all current system handles recursively. 411 gBS->ConnectController() service is invoked for each handle exist in system handler buffer. 412 If the handle is bus type handler, all childrens also will be connected recursively by gBS->ConnectController(). 413 414 @retval EFI_SUCCESS All handles and child handles have been 415 connected. 416 @retval EFI_STATUS Return the status of gBS->LocateHandleBuffer(). 417 **/ 418 EFI_STATUS 419 EFIAPI 420 BdsLibConnectAllEfi ( 421 VOID 422 ); 423 424 /** 425 This function will disconnect all current system handles. 426 gBS->DisconnectController() is invoked for each handle exists in system handle buffer. 427 If handle is a bus type handle, all childrens also are disconnected recursively by gBS->DisconnectController(). 428 429 @retval EFI_SUCCESS All handles have been disconnected. 430 @retval EFI_STATUS Error status returned by of gBS->LocateHandleBuffer(). 431 432 **/ 433 EFI_STATUS 434 EFIAPI 435 BdsLibDisconnectAllEfi ( 436 VOID 437 ); 438 439 // 440 // Bds console related lib functions 441 // 442 /** 443 This function will search every simpletxt device in the current system, 444 and make every simpletxt device a potential console device. 445 446 **/ 447 VOID 448 EFIAPI 449 BdsLibConnectAllConsoles ( 450 VOID 451 ); 452 453 454 /** 455 This function will connect console device based on the console 456 device variable ConIn, ConOut and ErrOut. 457 458 @retval EFI_SUCCESS At least one of the ConIn and ConOut devices have 459 been connected. 460 @retval EFI_STATUS Return the status of BdsLibConnectConsoleVariable (). 461 462 **/ 463 EFI_STATUS 464 EFIAPI 465 BdsLibConnectAllDefaultConsoles ( 466 VOID 467 ); 468 469 470 /** 471 This function will connect console device except ConIn base on the console 472 device variable ConOut and ErrOut. 473 474 @retval EFI_SUCCESS At least one of the ConOut device have 475 been connected success. 476 @retval EFI_STATUS Return the status of BdsLibConnectConsoleVariable (). 477 478 **/ 479 EFI_STATUS 480 EFIAPI 481 BdsLibConnectAllDefaultConsolesWithOutConIn ( 482 VOID 483 ); 484 485 486 /** 487 This function updates the console variable based on ConVarName. It can 488 add or remove one specific console device path from the variable 489 490 @param ConVarName The console-related variable name: ConIn, ConOut, 491 ErrOut. 492 @param CustomizedConDevicePath The console device path to be added to 493 the console variable ConVarName. Cannot be multi-instance. 494 @param ExclusiveDevicePath The console device path to be removed 495 from the console variable ConVarName. Cannot be multi-instance. 496 497 @retval EFI_UNSUPPORTED The added device path is the same as a removed one. 498 @retval EFI_SUCCESS Successfully added or removed the device path from the 499 console variable. 500 501 **/ 502 EFI_STATUS 503 EFIAPI 504 BdsLibUpdateConsoleVariable ( 505 IN CHAR16 *ConVarName, 506 IN EFI_DEVICE_PATH_PROTOCOL *CustomizedConDevicePath, 507 IN EFI_DEVICE_PATH_PROTOCOL *ExclusiveDevicePath 508 ); 509 510 /** 511 Connect the console device base on the variable ConVarName, if 512 device path of the ConVarName is multi-instance device path and 513 anyone of the instances is connected success, then this function 514 will return success. 515 If the handle associate with one device path node can not 516 be created successfully, then still give chance to do the dispatch, 517 which load the missing drivers if possible. 518 519 @param ConVarName Console related variable name, ConIn, ConOut, 520 ErrOut. 521 522 @retval EFI_NOT_FOUND There is not any console devices connected 523 success 524 @retval EFI_SUCCESS Success connect any one instance of the console 525 device path base on the variable ConVarName. 526 527 **/ 528 EFI_STATUS 529 EFIAPI 530 BdsLibConnectConsoleVariable ( 531 IN CHAR16 *ConVarName 532 ); 533 534 // 535 // Bds device path related lib functions 536 // 537 /** 538 Delete the instance in Multi that overlaps with Single. 539 540 @param Multi A pointer to a multi-instance device path data 541 structure. 542 @param Single A pointer to a single-instance device path data 543 structure. 544 545 @return This function removes the device path instances in Multi that overlap 546 Single, and returns the resulting device path. If there is no 547 remaining device path as a result, this function will return NULL. 548 549 **/ 550 EFI_DEVICE_PATH_PROTOCOL * 551 EFIAPI 552 BdsLibDelPartMatchInstance ( 553 IN EFI_DEVICE_PATH_PROTOCOL *Multi, 554 IN EFI_DEVICE_PATH_PROTOCOL *Single 555 ); 556 557 /** 558 This function compares a device path data structure to that of all the nodes of a 559 second device path instance. 560 561 @param Multi A pointer to a multi-instance device path data 562 structure. 563 @param Single A pointer to a single-instance device path data 564 structure. 565 566 @retval TRUE If the Single device path is contained within a 567 Multi device path. 568 @retval FALSE The Single device path is not contained within a 569 Multi device path. 570 571 **/ 572 BOOLEAN 573 EFIAPI 574 BdsLibMatchDevicePaths ( 575 IN EFI_DEVICE_PATH_PROTOCOL *Multi, 576 IN EFI_DEVICE_PATH_PROTOCOL *Single 577 ); 578 579 /** 580 This function converts an input device structure to a Unicode string. 581 582 @param DevPath A pointer to the device path structure. 583 584 @return A newly allocated Unicode string that represents the device path. 585 586 **/ 587 CHAR16 * 588 EFIAPI 589 DevicePathToStr ( 590 IN EFI_DEVICE_PATH_PROTOCOL *DevPath 591 ); 592 593 // 594 // Internal definitions 595 // 596 typedef struct { 597 CHAR16 *Str; 598 UINTN Len; 599 UINTN Maxlen; 600 } POOL_PRINT; 601 602 typedef 603 VOID 604 (*DEV_PATH_FUNCTION) ( 605 IN OUT POOL_PRINT *Str, 606 IN VOID *DevPath 607 ); 608 609 typedef struct { 610 UINT8 Type; 611 UINT8 SubType; 612 DEV_PATH_FUNCTION Function; 613 } DEVICE_PATH_STRING_TABLE; 614 615 typedef struct { 616 EFI_DEVICE_PATH_PROTOCOL Header; 617 EFI_GUID Guid; 618 UINT8 VendorDefinedData[1]; 619 } VENDOR_DEVICE_PATH_WITH_DATA; 620 621 typedef struct { 622 EFI_DEVICE_PATH_PROTOCOL Header; 623 UINT16 NetworkProtocol; 624 UINT16 LoginOption; 625 UINT64 Lun; 626 UINT16 TargetPortalGroupTag; 627 CHAR16 TargetName[1]; 628 } ISCSI_DEVICE_PATH_WITH_NAME; 629 630 // 631 // BBS support macros and functions 632 // 633 634 #if defined(MDE_CPU_IA32) || defined(MDE_CPU_X64) 635 #define REFRESH_LEGACY_BOOT_OPTIONS \ 636 BdsDeleteAllInvalidLegacyBootOptions ();\ 637 BdsAddNonExistingLegacyBootOptions (); \ 638 BdsUpdateLegacyDevOrder () 639 #else 640 #define REFRESH_LEGACY_BOOT_OPTIONS 641 #endif 642 643 /** 644 Delete all the invalid legacy boot options. 645 646 @retval EFI_SUCCESS All invalid legacy boot options are deleted. 647 @retval EFI_OUT_OF_RESOURCES Failed to allocate necessary memory. 648 @retval EFI_NOT_FOUND Failed to retrieve variable of boot order. 649 650 **/ 651 EFI_STATUS 652 EFIAPI 653 BdsDeleteAllInvalidLegacyBootOptions ( 654 VOID 655 ); 656 657 /** 658 Add the legacy boot options from BBS table if they do not exist. 659 660 @retval EFI_SUCCESS The boot options were added successfully, 661 or they are already in boot options. 662 @retval EFI_NOT_FOUND No legacy boot options is found. 663 @retval EFI_OUT_OF_RESOURCE No enough memory. 664 @return Other value LegacyBoot options are not added. 665 **/ 666 EFI_STATUS 667 EFIAPI 668 BdsAddNonExistingLegacyBootOptions ( 669 VOID 670 ); 671 672 /** 673 Add the legacy boot devices from BBS table into 674 the legacy device boot order. 675 676 @retval EFI_SUCCESS The boot devices were added successfully. 677 @retval EFI_NOT_FOUND The legacy boot devices are not found. 678 @retval EFI_OUT_OF_RESOURCES Memory or storage is not enough. 679 @retval EFI_DEVICE_ERROR Failed to add the legacy device boot order into EFI variable 680 because of a hardware error. 681 **/ 682 EFI_STATUS 683 EFIAPI 684 BdsUpdateLegacyDevOrder ( 685 VOID 686 ); 687 688 /** 689 Refresh the boot priority for BBS entries based on boot option entry and boot order. 690 691 @param Entry The boot option is to be checked for a refreshed BBS table. 692 693 @retval EFI_SUCCESS The boot priority for BBS entries refreshed successfully. 694 @retval EFI_NOT_FOUND BBS entries can't be found. 695 @retval EFI_OUT_OF_RESOURCES Failed to get the legacy device boot order. 696 **/ 697 EFI_STATUS 698 EFIAPI 699 BdsRefreshBbsTableForBoot ( 700 IN BDS_COMMON_OPTION *Entry 701 ); 702 703 /** 704 Delete the Boot Option from EFI Variable. The Boot Order Arrray 705 is also updated. 706 707 @param OptionNumber The number of Boot options wanting to be deleted. 708 @param BootOrder The Boot Order array. 709 @param BootOrderSize The size of the Boot Order Array. 710 711 @retval EFI_SUCCESS The Boot Option Variable was found and removed. 712 @retval EFI_UNSUPPORTED The Boot Option Variable store was inaccessible. 713 @retval EFI_NOT_FOUND The Boot Option Variable was not found. 714 **/ 715 EFI_STATUS 716 EFIAPI 717 BdsDeleteBootOption ( 718 IN UINTN OptionNumber, 719 IN OUT UINT16 *BootOrder, 720 IN OUT UINTN *BootOrderSize 721 ); 722 723 // 724 //The interface functions related to the Setup Browser Reset Reminder feature 725 // 726 /** 727 Enable the setup browser reset reminder feature. 728 This routine is used in a platform tip. If the platform policy needs the feature, use the routine to enable it. 729 730 **/ 731 VOID 732 EFIAPI 733 EnableResetReminderFeature ( 734 VOID 735 ); 736 737 /** 738 Disable the setup browser reset reminder feature. 739 This routine is used in a platform tip. If the platform policy does not want the feature, use the routine to disable it. 740 741 **/ 742 VOID 743 EFIAPI 744 DisableResetReminderFeature ( 745 VOID 746 ); 747 748 /** 749 Record the info that a reset is required. 750 A module boolean variable is used to record whether a reset is required. 751 752 **/ 753 VOID 754 EFIAPI 755 EnableResetRequired ( 756 VOID 757 ); 758 759 760 /** 761 Record the info that no reset is required. 762 A module boolean variable is used to record whether a reset is required. 763 764 **/ 765 VOID 766 EFIAPI 767 DisableResetRequired ( 768 VOID 769 ); 770 771 /** 772 Check whether platform policy enables the reset reminder feature. The default is enabled. 773 774 **/ 775 BOOLEAN 776 EFIAPI 777 IsResetReminderFeatureEnable ( 778 VOID 779 ); 780 781 /** 782 Check if the user changed any option setting that needs a system reset to be effective. 783 784 **/ 785 BOOLEAN 786 EFIAPI 787 IsResetRequired ( 788 VOID 789 ); 790 791 /** 792 Check whether a reset is needed, and finish the reset reminder feature. 793 If a reset is needed, pop up a menu to notice user, and finish the feature 794 according to the user selection. 795 796 **/ 797 VOID 798 EFIAPI 799 SetupResetReminder ( 800 VOID 801 ); 802 803 804 /// 805 /// Define the boot type with which to classify the boot option type. 806 /// Different boot option types could have different boot behaviors. 807 /// Use their device path node (Type + SubType) as the type value. 808 /// The boot type here can be added according to requirements. 809 /// 810 811 /// 812 /// ACPI boot type. For ACPI devices, using sub-types to distinguish devices is not allowed, so hardcode their values. 813 /// 814 #define BDS_EFI_ACPI_FLOPPY_BOOT 0x0201 815 /// 816 /// Message boot type 817 /// If a device path of boot option only points to a message node, the boot option is a message boot type. 818 /// 819 #define BDS_EFI_MESSAGE_ATAPI_BOOT 0x0301 // Type 03; Sub-Type 01 820 #define BDS_EFI_MESSAGE_SCSI_BOOT 0x0302 // Type 03; Sub-Type 02 821 #define BDS_EFI_MESSAGE_USB_DEVICE_BOOT 0x0305 // Type 03; Sub-Type 05 822 #define BDS_EFI_MESSAGE_SATA_BOOT 0x0312 // Type 03; Sub-Type 18 823 #define BDS_EFI_MESSAGE_MAC_BOOT 0x030b // Type 03; Sub-Type 11 824 #define BDS_EFI_MESSAGE_MISC_BOOT 0x03FF 825 826 /// 827 /// Media boot type 828 /// If a device path of boot option contains a media node, the boot option is media boot type. 829 /// 830 #define BDS_EFI_MEDIA_HD_BOOT 0x0401 // Type 04; Sub-Type 01 831 #define BDS_EFI_MEDIA_CDROM_BOOT 0x0402 // Type 04; Sub-Type 02 832 /// 833 /// BBS boot type 834 /// If a device path of boot option contains a BBS node, the boot option is BBS boot type. 835 /// 836 #define BDS_LEGACY_BBS_BOOT 0x0501 // Type 05; Sub-Type 01 837 838 #define BDS_EFI_UNSUPPORT 0xFFFF 839 840 /** 841 Check whether an instance in BlockIoDevicePath has the same partition node as the HardDriveDevicePath device path. 842 843 @param BlockIoDevicePath Multi device path instances to check. 844 @param HardDriveDevicePath A device path starting with a hard drive media 845 device path. 846 847 @retval TRUE There is a matched device path instance. 848 @retval FALSE There is no matched device path instance. 849 850 **/ 851 BOOLEAN 852 EFIAPI 853 MatchPartitionDevicePathNode ( 854 IN EFI_DEVICE_PATH_PROTOCOL *BlockIoDevicePath, 855 IN HARDDRIVE_DEVICE_PATH *HardDriveDevicePath 856 ); 857 858 859 /** 860 Expand a device path that starts with a hard drive media device path node to be a 861 full device path that includes the full hardware path to the device. This function enables the device to boot. 862 To avoid requiring a connect on every boot, the front match is saved in a variable (the part point 863 to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ). 864 All successful history device paths 865 that point to the front part of the partition node will be saved. 866 867 @param HardDriveDevicePath EFI Device Path to boot, if it starts with a hard 868 drive media device path. 869 @return A Pointer to the full device path, or NULL if a valid Hard Drive devic path 870 cannot be found. 871 872 **/ 873 EFI_DEVICE_PATH_PROTOCOL * 874 EFIAPI 875 BdsExpandPartitionPartialDevicePathToFull ( 876 IN HARDDRIVE_DEVICE_PATH *HardDriveDevicePath 877 ); 878 879 /** 880 Return the bootable media handle. 881 First, check whether the device is connected. 882 Second, check whether the device path points to a device that supports SimpleFileSystemProtocol. 883 Third, detect the the default boot file in the Media, and return the removable Media handle. 884 885 @param DevicePath The Device Path to a bootable device. 886 887 @return The bootable media handle. If the media on the DevicePath is not bootable, NULL will return. 888 889 **/ 890 EFI_HANDLE 891 EFIAPI 892 BdsLibGetBootableHandle ( 893 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath 894 ); 895 896 897 /** 898 Checks whether the Device path in a boot option points to a valid bootable device, and if the device 899 is ready to boot now. 900 901 @param DevPath The Device path in a boot option. 902 @param CheckMedia If true, check whether the device is ready to boot now. 903 904 @retval TRUE The Device path is valid. 905 @retval FALSE The Device path is invalid. 906 907 **/ 908 BOOLEAN 909 EFIAPI 910 BdsLibIsValidEFIBootOptDevicePath ( 911 IN EFI_DEVICE_PATH_PROTOCOL *DevPath, 912 IN BOOLEAN CheckMedia 913 ); 914 915 /** 916 Checks whether the Device path in a boot option points to a valid bootable device, and if the device 917 is ready to boot now. 918 If Description is not NULL and the device path points to a fixed BlockIo 919 device, this function checks whether the description conflicts with other auto-created 920 boot options. 921 922 @param DevPath The Device path in a boot option. 923 @param CheckMedia If true, checks if the device is ready to boot now. 924 @param Description The description of a boot option. 925 926 @retval TRUE The Device path is valid. 927 @retval FALSE The Device path is invalid. 928 929 **/ 930 BOOLEAN 931 EFIAPI 932 BdsLibIsValidEFIBootOptDevicePathExt ( 933 IN EFI_DEVICE_PATH_PROTOCOL *DevPath, 934 IN BOOLEAN CheckMedia, 935 IN CHAR16 *Description 936 ); 937 938 /** 939 For a bootable Device path, return its boot type. 940 941 @param DevicePath The bootable device Path to check. 942 943 @retval BDS_EFI_MEDIA_HD_BOOT The given device path contains MEDIA_DEVICE_PATH type device path node, 944 whose subtype is MEDIA_HARDDRIVE_DP. 945 @retval BDS_EFI_MEDIA_CDROM_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node, 946 whose subtype is MEDIA_CDROM_DP. 947 @retval BDS_EFI_ACPI_FLOPPY_BOOT A given device path contains ACPI_DEVICE_PATH type device path node, 948 whose HID is floppy device. 949 @retval BDS_EFI_MESSAGE_ATAPI_BOOT A given device path contains MESSAGING_DEVICE_PATH type device path node, 950 and its last device path node's subtype is MSG_ATAPI_DP. 951 @retval BDS_EFI_MESSAGE_SCSI_BOOT A given device path contains MESSAGING_DEVICE_PATH type device path node, 952 and its last device path node's subtype is MSG_SCSI_DP. 953 @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT A given device path contains MESSAGING_DEVICE_PATH type device path node, 954 and its last device path node's subtype is MSG_USB_DP. 955 @retval BDS_EFI_MESSAGE_MISC_BOOT The device path does not contain any media device path node, and 956 its last device path node points to a message device path node. 957 @retval BDS_LEGACY_BBS_BOOT A given device path contains BBS_DEVICE_PATH type device path node. 958 @retval BDS_EFI_UNSUPPORT An EFI Removable BlockIO device path does not point to a media and message device. 959 960 **/ 961 UINT32 962 EFIAPI 963 BdsGetBootTypeFromDevicePath ( 964 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath 965 ); 966 967 968 /** 969 This routine registers a function to adjust the different types of memory page numbers 970 just before booting, and saves the updated info into the variable for the next boot to use. 971 972 **/ 973 VOID 974 EFIAPI 975 BdsLibSaveMemoryTypeInformation ( 976 VOID 977 ); 978 979 /** 980 Identify a user and, if authenticated, returns the current user profile handle. 981 982 @param[out] User Points to the user profile handle. 983 984 @retval EFI_SUCCESS The user is successfully identified, or user identification 985 is not supported. 986 @retval EFI_ACCESS_DENIED The user was not successfully identified. 987 988 **/ 989 EFI_STATUS 990 EFIAPI 991 BdsLibUserIdentify ( 992 OUT EFI_USER_PROFILE_HANDLE *User 993 ); 994 995 /** 996 This function checks if a Fv file device path is valid, according to a file GUID. If it is invalid, 997 it tries to return the valid device path. 998 FV address maybe changes for memory layout adjust from time to time, use this funciton 999 could promise the Fv file device path is right. 1000 1001 @param DevicePath On input, the Fv file device path to check. On 1002 output, the updated valid Fv file device path 1003 @param FileGuid the Fv file GUID. 1004 1005 @retval EFI_INVALID_PARAMETER The input DevicePath or FileGuid is invalid. 1006 @retval EFI_UNSUPPORTED The input DevicePath does not contain an Fv file 1007 GUID at all. 1008 @retval EFI_ALREADY_STARTED The input DevicePath has pointed to the Fv file and is 1009 valid. 1010 @retval EFI_SUCCESS Successfully updated the invalid DevicePath 1011 and returned the updated device path in DevicePath. 1012 1013 **/ 1014 EFI_STATUS 1015 EFIAPI 1016 BdsLibUpdateFvFileDevicePath ( 1017 IN OUT EFI_DEVICE_PATH_PROTOCOL ** DevicePath, 1018 IN EFI_GUID *FileGuid 1019 ); 1020 1021 1022 /** 1023 Connect the specific USB device that matches the RemainingDevicePath, 1024 and whose bus is determined by Host Controller (Uhci or Ehci). 1025 1026 @param HostControllerPI Uhci (0x00) or Ehci (0x20) or Both uhci and ehci 1027 (0xFF). 1028 @param RemainingDevicePath A short-form device path that starts with the first 1029 element being a USB WWID or a USB Class device 1030 path. 1031 1032 @retval EFI_SUCCESS The specific Usb device is connected successfully. 1033 @retval EFI_INVALID_PARAMETER Invalid HostControllerPi (not 0x00, 0x20 or 0xFF) 1034 or RemainingDevicePath is not the USB class device path. 1035 @retval EFI_NOT_FOUND The device specified by device path is not found. 1036 1037 **/ 1038 EFI_STATUS 1039 EFIAPI 1040 BdsLibConnectUsbDevByShortFormDP( 1041 IN UINT8 HostControllerPI, 1042 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath 1043 ); 1044 1045 1046 // 1047 // The implementation of this function is provided by Platform code. 1048 // 1049 /** 1050 Convert Vendor device path to a device name. 1051 1052 @param Str The buffer storing device name. 1053 @param DevPath The pointer to vendor device path. 1054 1055 **/ 1056 VOID 1057 DevPathVendor ( 1058 IN OUT POOL_PRINT *Str, 1059 IN VOID *DevPath 1060 ); 1061 1062 /** 1063 Concatenates a formatted unicode string to an allocated pool. 1064 The caller must free the resulting buffer. 1065 1066 @param Str Tracks the allocated pool, size in use, and amount of pool allocated. 1067 @param Fmt The format string. 1068 @param ... The data will be printed. 1069 1070 @return Allocated buffer with the formatted string printed in it. 1071 The caller must free the allocated buffer. 1072 The buffer allocation is not packed. 1073 1074 **/ 1075 CHAR16 * 1076 EFIAPI 1077 CatPrint ( 1078 IN OUT POOL_PRINT *Str, 1079 IN CHAR16 *Fmt, 1080 ... 1081 ); 1082 1083 /** 1084 Use SystemTable ConOut to stop video based Simple Text Out consoles from going 1085 to the video device. Put up LogoFile on every video device that is a console. 1086 1087 @param[in] LogoFile The file name of logo to display on the center of the screen. 1088 1089 @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed. 1090 @retval EFI_UNSUPPORTED Logo not found. 1091 1092 **/ 1093 EFI_STATUS 1094 EFIAPI 1095 EnableQuietBoot ( 1096 IN EFI_GUID *LogoFile 1097 ); 1098 1099 1100 /** 1101 Use SystemTable ConOut to turn on video based Simple Text Out consoles. The 1102 Simple Text Out screens will now be synced up with all non-video output devices. 1103 1104 @retval EFI_SUCCESS UGA devices are back in text mode and synced up. 1105 1106 **/ 1107 EFI_STATUS 1108 EFIAPI 1109 DisableQuietBoot ( 1110 VOID 1111 ); 1112 1113 #endif 1114 1115