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.
7 Copyright (c) 2004 - 2009, 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
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.
18 #ifndef _GENERIC_BDS_LIB_H_
19 #define _GENERIC_BDS_LIB_H_
21 extern EFI_HANDLE mBdsImageHandle
;
24 /// Constants which are variable names used to access variables
26 #define VAR_LEGACY_DEV_ORDER L"LegacyDevOrder"
29 /// Data structures and defines
31 #define FRONT_PAGE_QUESTION_ID 0x0000
32 #define FRONT_PAGE_DATA_WIDTH 0x01
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)
43 /// Load Option Attributes
45 #define LOAD_OPTION_ACTIVE 0x00000001
46 #define LOAD_OPTION_FORCE_RECONNECT 0x00000002
48 #define LOAD_OPTION_HIDDEN 0x00000008
49 #define LOAD_OPTION_CATEGORY 0x00001F00
51 #define LOAD_OPTION_CATEGORY_BOOT 0x00000000
52 #define LOAD_OPTION_CATEGORY_APP 0x00000100
54 #define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001
55 #define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002
57 #define IS_LOAD_OPTION_TYPE(_c, _Mask) (BOOLEAN) (((_c) & (_Mask)) != 0)
60 /// Define Maximum characters that will be accepted
63 #define MAX_CHAR_SIZE (MAX_CHAR * 2)
66 /// Define maximum characters for boot option variable "BootXXXX"
68 #define BOOT_OPTION_MAX_CHAR 10
71 // This data structure is the part of BDS_CONNECT_ENTRY
73 #define BDS_LOAD_OPTION_SIGNATURE SIGNATURE_32 ('B', 'd', 'C', 'O')
80 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
88 UINT32 LoadOptionsSize
;
94 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
96 } BDS_CONSOLE_CONNECT_ENTRY
;
99 // Bds boot related lib functions
102 Boot from the UEFI spec defined "BootNext" variable.
112 Process the boot option follow the UEFI specification and
113 special treat the legacy boot option with BBS_DEVICE_PATH.
115 @param Option The boot option to be processed
116 @param DevicePath The device path describing where to load the
117 boot image or the legcy BBS device path to boot
119 @param ExitDataSize The size of exit data.
120 @param ExitData Data returned when Boot image failed.
122 @retval EFI_SUCCESS Boot from the input boot option succeeded.
123 @retval EFI_NOT_FOUND The Device Path is not found in the system
128 BdsLibBootViaBootOption (
129 IN BDS_COMMON_OPTION
* Option
,
130 IN EFI_DEVICE_PATH_PROTOCOL
* DevicePath
,
131 OUT UINTN
*ExitDataSize
,
132 OUT CHAR16
**ExitData OPTIONAL
137 This function will enumerate all possible boot devices in the system, and
138 automatically create boot options for Network, Shell, Removable BlockIo,
139 and Non-BlockIo Simplefile devices.
141 BDS separates EFI boot options into six types:
142 1. Network - The boot option points to the SimpleNetworkProtocol device.
143 Bds will try to automatically create this type of boot option during enumeration.
144 2. Shell - The boot option points to internal flash shell.
145 Bds will try to automatically create this type of boot option during enumeration.
146 3. Removable BlockIo - The boot option points to a removable media
147 device, such as a USB flash drive or DVD drive.
148 These devices should contain a *removable* blockIo
149 protocol in their device handle.
150 Bds will try to automatically create this type boot option
152 4. Fixed BlockIo - The boot option points to a Fixed blockIo device,
154 These devices should contain a *fixed* blockIo
155 protocol in their device handle.
156 BDS will skip fixed blockIo devices, and not
157 automatically create boot option for them. But BDS
158 will help to delete those fixed blockIo boot options,
159 whose description rules conflict with other auto-created
161 5. Non-BlockIo Simplefile - The boot option points to a device whose handle
162 has SimpleFileSystem Protocol, but has no blockio
163 protocol. These devices do not offer blockIo
164 protocol, but BDS still can get the
165 \EFI\BOOT\boot{machinename}.EFI by SimpleFileSystem
167 6. File - The boot option points to a file. These boot options are usually
168 created by the user, either manually or with an OS loader. BDS will not delete or modify
171 This function will enumerate all possible boot devices in the system, and
172 automatically create boot options for Network, Shell, Removable BlockIo,
173 and Non-BlockIo Simplefile devices.
174 It will excute once every boot.
176 @param BdsBootOptionList The header of the linked list that indexed all
179 @retval EFI_SUCCESS Finished all the boot device enumerations and created
180 the boot option based on the boot device
182 @retval EFI_OUT_OF_RESOURCES Failed to enumerate the boot device and create the boot option list
186 BdsLibEnumerateAllBootOption (
187 IN OUT LIST_ENTRY
*BdsBootOptionList
191 Build the boot option with the handle parsed in
193 @param Handle The handle representing the device path for which to create
195 @param BdsBootOptionList The header of the link list which indexed all
197 @param String The description of the boot option.
202 BdsLibBuildOptionFromHandle (
203 IN EFI_HANDLE Handle
,
204 IN LIST_ENTRY
*BdsBootOptionList
,
210 Build the on flash shell boot option with the handle parsed in.
212 @param Handle The handle which present the device path to create
213 on flash shell boot option
214 @param BdsBootOptionList The header of the link list which indexed all
220 BdsLibBuildOptionFromShell (
221 IN EFI_HANDLE Handle
,
222 IN OUT LIST_ENTRY
*BdsBootOptionList
226 // Bds misc lib functions
229 Get boot mode by looking up configuration table and parsing HOB list
231 @param BootMode Boot mode from PEI handoff HOB.
233 @retval EFI_SUCCESS Successfully get boot mode
239 OUT EFI_BOOT_MODE
*BootMode
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.
247 @param BdsDriverLists The header of the current driver option link list
253 IN LIST_ENTRY
*BdsDriverLists
258 This function processes BootOrder or DriverOrder variables, by calling
259 BdsLibVariableToOption () for each UINT16 in the variables.
261 @param BdsCommonOptionList The header of the option list base on variable VariableName. @param VariableName EFI Variable name indicate the BootOrder or DriverOrder.
262 @retval EFI_SUCCESS Successfully created the boot option or driver option list @retval EFI_OUT_OF_RESOURCES Failed to get the boot option or driver option list**/
265 BdsLibBuildOptionFromVar (
266 IN LIST_ENTRY
*BdsCommonOptionList
,
267 IN CHAR16
*VariableName
271 This function reads the EFI variable (VendorGuid/Name) and returns a dynamically allocated
272 buffer and the size of the buffer. If failure, return NULL.
274 @param Name String part of EFI variable name
275 @param VendorGuid GUID part of EFI variable name
276 @param VariableSize Returns the size of the EFI variable that was read
278 @return Dynamically allocated memory that contains a copy of the EFI variable
279 Caller is responsible freeing the buffer.
280 @retval NULL Variable was not read
285 BdsLibGetVariableAndSize (
287 IN EFI_GUID
*VendorGuid
,
288 OUT UINTN
*VariableSize
293 This function prints a series of strings.
295 @param ConOut Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
296 @param ... A variable argument list containing series of
297 strings, the last string must be NULL.
299 @retval EFI_SUCCESS Success print out the string using ConOut.
300 @retval EFI_STATUS Return the status of the ConOut->OutputString ().
305 BdsLibOutputStrings (
306 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
,
311 Build the boot#### or driver#### option from the VariableName. The
312 build boot#### or driver#### will also be linked to BdsCommonOptionList.
314 @param BdsCommonOptionList The header of the boot#### or driver#### option
316 @param VariableName EFI Variable name, indicates if it is boot#### or
319 @retval BDS_COMMON_OPTION The option that was created
320 @retval NULL Failed to get the new option
325 BdsLibVariableToOption (
326 IN OUT LIST_ENTRY
*BdsCommonOptionList
,
327 IN CHAR16
*VariableName
331 This function registers the new boot#### or driver#### option based on
332 the VariableName. The new registered boot#### or driver#### will be linked
333 to BdsOptionList and also update to the VariableName. After the boot#### or
334 driver#### updated, the BootOrder or DriverOrder will also be updated.
336 @param BdsOptionList The header of the boot#### or driver#### link list
337 @param DevicePath The device path which the boot#### or driver####
339 @param String The description of the boot#### or driver####
340 @param VariableName Indicate if the boot#### or driver#### option
342 @retval EFI_SUCCESS The boot#### or driver#### have been success
344 @retval EFI_STATUS Return the status of gRT->SetVariable ().
349 BdsLibRegisterNewOption (
350 IN LIST_ENTRY
*BdsOptionList
,
351 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
353 IN CHAR16
*VariableName
357 // Bds connect and disconnect driver lib funcions
360 This function connects all system drivers with the corresponding controllers.
365 BdsLibConnectAllDriversToAllControllers (
370 This function connects all system drivers to controllers.
380 This function creates all handles associated with every device
381 path node. If the handle associated with one device path node can not
382 be created, then it tries to execute the dispatch to load the missing drivers.
384 @param DevicePathToConnect The device path to be connected. Can be
385 a multi-instance device path
387 @retval EFI_SUCCESS All handles associates with every device path node
389 @retval EFI_OUT_OF_RESOURCES Not enough resources to create new handles
390 @retval EFI_NOT_FOUND At least one handle could not be created
395 BdsLibConnectDevicePath (
396 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePathToConnect
400 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().
401 @retval EFI_SUCCESS All handles and child handles have been connected @retval EFI_STATUS Return the status of gBS->LocateHandleBuffer().
405 BdsLibConnectAllEfi (
410 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().
411 @retval EFI_SUCCESS All handles have been disconnected
412 @retval EFI_STATUS Error status returned by of gBS->LocateHandleBuffer().
417 BdsLibDisconnectAllEfi (
422 // Bds console related lib functions
425 This function will search every simpletxt device in the current system,
426 and make every simpletxt device as pertantial console device.
431 BdsLibConnectAllConsoles (
437 This function will connect console device based on the console
438 device variable ConIn, ConOut and ErrOut.
440 @retval EFI_SUCCESS At least one of the ConIn and ConOut devices have
442 @retval EFI_STATUS Return the status of BdsLibConnectConsoleVariable ().
447 BdsLibConnectAllDefaultConsoles (
452 This function updates the console variable based on ConVarName. It can
453 add or remove one specific console device path from the variable
455 @param ConVarName Console-related variable name: ConIn, ConOut,
457 @param CustomizedConDevicePath The console device path to be added to
458 the console variable ConVarName. Can not be multi-instance.
459 @param ExclusiveDevicePath The console device path to be removed
460 from the console variable ConVarName. Can not be multi-instance.
462 @retval EFI_UNSUPPORTED The added device path is the same as a removed one.
463 @retval EFI_SUCCESS Successfully added or removed the device path from the
469 BdsLibUpdateConsoleVariable (
470 IN CHAR16
*ConVarName
,
471 IN EFI_DEVICE_PATH_PROTOCOL
*CustomizedConDevicePath
,
472 IN EFI_DEVICE_PATH_PROTOCOL
*ExclusiveDevicePath
476 Connect the console device base on the variable ConVarName. If
477 ConVarName is a multi-instance device path, and at least one
478 instance connects successfully, then this function
481 @param ConVarName Console related variable name, ConIn, ConOut,
484 @retval EFI_NOT_FOUND No console devices were connected successfully
485 @retval EFI_SUCCESS Connected at least one instance of the console
486 device path based on the variable ConVarName.
491 BdsLibConnectConsoleVariable (
492 IN CHAR16
*ConVarName
496 // Bds device path related lib functions
499 Delete the instance in Multi that overlaps with Single
501 @param Multi A pointer to a multi-instance device path data
503 @param Single A pointer to a single-instance device path data
506 @return This function removes the device path instances in Multi that overlap
507 Single, and returns the resulting device path. If there is no
508 remaining device path as a result, this function will return NULL.
511 EFI_DEVICE_PATH_PROTOCOL
*
513 BdsLibDelPartMatchInstance (
514 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
515 IN EFI_DEVICE_PATH_PROTOCOL
*Single
519 Function compares a device path data structure to that of all the nodes of a
520 second device path instance.
522 @param Multi A pointer to a multi-instance device path data
524 @param Single A pointer to a single-instance device path data
527 @retval TRUE If the Single device path is contained within Multi device path.
528 @retval FALSE The Single device path is not contained within Multi device path.
533 BdsLibMatchDevicePaths (
534 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
535 IN EFI_DEVICE_PATH_PROTOCOL
*Single
539 This function converts an input device structure to a Unicode string.
541 @param DevPath A pointer to the device path structure.
543 @return A new allocated Unicode string that represents the device path.
549 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
554 // Internal definitions
565 VOID (*Function
) (POOL_PRINT
*, VOID
*);
566 } DEVICE_PATH_STRING_TABLE
;
568 extern EFI_GUID mEfiDevicePathMessagingUartFlowControlGuid
;
571 EFI_DEVICE_PATH_PROTOCOL Header
;
573 UINT8 VendorDefinedData
[1];
574 } VENDOR_DEVICE_PATH_WITH_DATA
;
577 extern EFI_GUID mEfiDevicePathMessagingSASGuid
;
580 EFI_DEVICE_PATH_PROTOCOL Header
;
581 UINT16 NetworkProtocol
;
584 UINT16 TargetPortalGroupTag
;
585 CHAR16 TargetName
[1];
586 } ISCSI_DEVICE_PATH_WITH_NAME
;
590 // Notes: EFI 64 shadow all option rom
592 #if defined (MDE_CPU_IPF)
593 #define EFI64_SHADOW_ALL_LEGACY_ROM() ShadowAllOptionRom ();
595 #define EFI64_SHADOW_ALL_LEGACY_ROM()
599 Shadow all Legacy OptionRom.
609 // BBS support macros and functions
612 #if defined(MDE_CPU_IA32) || defined(MDE_CPU_X64)
613 #define REFRESH_LEGACY_BOOT_OPTIONS \
614 BdsDeleteAllInvalidLegacyBootOptions ();\
615 BdsAddNonExistingLegacyBootOptions (); \
616 BdsUpdateLegacyDevOrder ()
618 #define REFRESH_LEGACY_BOOT_OPTIONS
622 Delete all the invalid legacy boot options.
624 @retval EFI_SUCCESS All invalide legacy boot options are deleted.
625 @retval EFI_OUT_OF_RESOURCES Fail to allocate necessary memory.
626 @retval EFI_NOT_FOUND Fail to retrieve variable of boot order.
631 BdsDeleteAllInvalidLegacyBootOptions (
636 Add the legacy boot options from BBS table if they do not exist.
638 @retval EFI_SUCCESS The boot options are added successfully
639 or they are already in boot options.
640 @retval EFI_NOT_FOUND No legacy boot options is found.
641 @retval EFI_OUT_OF_RESOURCE No enough memory.
642 @return Other value LegacyBoot options are not added.
646 BdsAddNonExistingLegacyBootOptions (
651 Add the legacy boot devices from BBS table into
652 the legacy device boot order.
654 @retval EFI_SUCCESS The boot devices are added successfully.
655 @retval EFI_NOT_FOUND The legacy boot devices are not found.
656 @retval EFI_OUT_OF_RESOURCES Memmory or storage is not enough.
657 @retval EFI_DEVICE_ERROR Fail to add the legacy device boot order into EFI variable
658 because of hardware error.
662 BdsUpdateLegacyDevOrder (
667 Set the boot priority for BBS entries based on boot option entry and boot order.
669 @param Entry The boot option is to be checked for refresh BBS table.
671 @retval EFI_SUCCESS The boot priority for BBS entries is refreshed successfully.
672 @retval EFI_NOT_FOUND BBS entries can't be found.
673 @retval EFI_OUT_OF_RESOURCES Failed to get the legacy device boot order.
677 BdsRefreshBbsTableForBoot (
678 IN BDS_COMMON_OPTION
*Entry
682 Deletete the Boot Option from EFI Variable. The Boot Order Arrray
685 @param OptionNumber The number of Boot option want to be deleted.
686 @param BootOrder The Boot Order array.
687 @param BootOrderSize The size of the Boot Order Array.
689 @retval EFI_SUCCESS The Boot Option Variable was found and removed
690 @retval EFI_UNSUPPORTED The Boot Option Variable store was inaccessible
691 @retval EFI_NOT_FOUND The Boot Option Variable was not found
695 BdsDeleteBootOption (
696 IN UINTN OptionNumber
,
697 IN OUT UINT16
*BootOrder
,
698 IN OUT UINTN
*BootOrderSize
702 //The interface functions related to the Setup Browser Reset Reminder feature
705 Enable the setup browser reset reminder feature.
706 This routine is used in platform tip. If the platform policy needs the feature, use the routine to enable it.
711 EnableResetReminderFeature (
716 Disable the setup browser reset reminder feature.
717 This routine is used in platform tip. If the platform policy does not want the feature, use the routine to disable it.
722 DisableResetReminderFeature (
727 Record the info that a reset is required.
728 A module boolean variable is used to record whether a reset is required.
733 EnableResetRequired (
739 Record the info that no reset is required.
740 A module boolean variable is used to record whether a reset is required.
745 DisableResetRequired (
750 Check whether platform policy enables the reset reminder feature. The default is enabled.
755 IsResetReminderFeatureEnable (
760 Check if the user changed any option setting that needs a system reset to be effective.
770 Check whether a reset is needed, and finish the reset reminder feature.
771 If a reset is needed, pop up a menu to notice user, and finish the feature
772 according to the user selection.
783 /// Define the boot option default description
785 #define DESCRIPTION_FLOPPY L"EFI Floppy"
786 #define DESCRIPTION_FLOPPY_NUM L"EFI Floppy %d"
787 #define DESCRIPTION_DVD L"EFI DVD/CDROM"
788 #define DESCRIPTION_DVD_NUM L"EFI DVD/CDROM %d"
789 #define DESCRIPTION_USB L"EFI USB Device"
790 #define DESCRIPTION_USB_NUM L"EFI USB Device %d"
791 #define DESCRIPTION_SCSI L"EFI SCSI Device"
792 #define DESCRIPTION_SCSI_NUM L"EFI SCSI Device %d"
793 #define DESCRIPTION_MISC L"EFI Misc Device"
794 #define DESCRIPTION_MISC_NUM L"EFI Misc Device %d"
795 #define DESCRIPTION_NETWORK L"EFI Network"
796 #define DESCRIPTION_NETWORK_NUM L"EFI Network %d"
797 #define DESCRIPTION_NON_BLOCK L"EFI Non-Block Boot Device"
798 #define DESCRIPTION_NON_BLOCK_NUM L"EFI Non-Block Boot Device %d"
801 /// Define the boot type which to classify the boot option type
802 /// Different boot option type could have different boot behavior
803 /// Use their device path node (Type + SubType) as type value
804 /// The boot type here can be added according to requirement
808 /// ACPI boot type. For ACPI device, cannot use sub-type to distinguish device, so hardcode their value
810 #define BDS_EFI_ACPI_FLOPPY_BOOT 0x0201
812 /// Message boot type
813 /// If a device path of boot option only point to a message node, the boot option is message boot type
815 #define BDS_EFI_MESSAGE_ATAPI_BOOT 0x0301 // Type 03; Sub-Type 01
816 #define BDS_EFI_MESSAGE_SCSI_BOOT 0x0302 // Type 03; Sub-Type 02
817 #define BDS_EFI_MESSAGE_USB_DEVICE_BOOT 0x0305 // Type 03; Sub-Type 05
818 #define BDS_EFI_MESSAGE_SATA_BOOT 0x0318 // Type 03; Sub-Type 18
819 #define BDS_EFI_MESSAGE_MISC_BOOT 0x03FF
822 /// If a device path of boot option contain a media node, the boot option is media boot type
824 #define BDS_EFI_MEDIA_HD_BOOT 0x0401 // Type 04; Sub-Type 01
825 #define BDS_EFI_MEDIA_CDROM_BOOT 0x0402 // Type 04; Sub-Type 02
828 /// If a device path of boot option contain a BBS node, the boot option is BBS boot type
830 #define BDS_LEGACY_BBS_BOOT 0x0501 // Type 05; Sub-Type 01
832 #define BDS_EFI_UNSUPPORT 0xFFFF
835 /// USB host controller Programming Interface.
837 #define PCI_CLASSC_PI_UHCI 0x00
838 #define PCI_CLASSC_PI_EHCI 0x20
841 Check whether an instance in BlockIoDevicePath has the same partition node as the HardDriveDevicePath device path
843 @param BlockIoDevicePath Multi device path instances to check
844 @param HardDriveDevicePath A device path starting with a hard drive media
847 @retval TRUE There is a matched device path instance.
848 @retval FALSE There is no matched device path instance.
853 MatchPartitionDevicePathNode (
854 IN EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
,
855 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
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. We need
862 to do this so it can be booted. As an optimizaiton the front match (the part point
863 to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ) is saved in a variable
864 so a connect all is not required on every boot. All successful history device path
865 which point to partition node (the front part) will be saved.
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
873 EFI_DEVICE_PATH_PROTOCOL
*
875 BdsExpandPartitionPartialDevicePathToFull (
876 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
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.
885 @param DevicePath Device Path to a bootable device
887 @return The bootable media handle. If the media on the DevicePath is not bootable, NULL will return.
892 BdsLibGetBootableHandle (
893 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
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.
901 @param DevPath the Device path in a boot option
902 @param CheckMedia if true, check whether the device is ready to boot now.
904 @retval TRUE the Device path is valid
905 @retval FALSE the Device path is invalid
910 BdsLibIsValidEFIBootOptDevicePath (
911 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
912 IN BOOLEAN CheckMedia
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
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
926 @retval TRUE the Device path is valid
927 @retval FALSE the Device path is invalid
932 BdsLibIsValidEFIBootOptDevicePathExt (
933 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
934 IN BOOLEAN CheckMedia
,
935 IN CHAR16
*Description
939 For a bootable Device path, return its boot type.
941 @param DevicePath The bootable device Path to check
943 @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,
947 BdsGetBootTypeFromDevicePath (
948 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
953 This routine registers a function to adjust the different types of memory page numbers
954 just before booting, and saves the updated info into the variable for the next boot to use.
959 BdsLibSaveMemoryTypeInformation (
965 This function checks if a Fv file device path is valid, according to a file GUID. If it is invalid,
966 it tries to return the valid device path.
967 FV address maybe changes for memory layout adjust from time to time, use this funciton
968 could promise the Fv file device path is right.
970 @param DevicePath on input, the Fv file device path to check. On
971 output, the updated valid Fv file device path
972 @param FileGuid the Fv file GUID
974 @retval EFI_INVALID_PARAMETER the input DevicePath or FileGuid is invalid
975 @retval EFI_UNSUPPORTED the input DevicePath does not contain an Fv file
977 @retval EFI_ALREADY_STARTED the input DevicePath has pointed to the Fv file and is
979 @retval EFI_SUCCESS successfully updated the invalid DevicePath
980 and returned the updated device path in DevicePath
985 BdsLibUpdateFvFileDevicePath (
986 IN OUT EFI_DEVICE_PATH_PROTOCOL
** DevicePath
,
987 IN EFI_GUID
*FileGuid
992 Connect the specific USB device that matches the RemainingDevicePath,
993 and whose bus is determined by Host Controller (Uhci or Ehci)
995 @param HostControllerPI Uhci (0x00) or Ehci (0x20) or Both uhci and ehci
997 @param RemainingDevicePath a short-form device path that starts with the first
998 element being a USB WWID or a USB Class device
1001 @retval EFI_SUCCESS The specific Usb device is connected successfully.
1002 @retval EFI_INVALID_PARAMETER Invalid HostControllerPi (not 0x00, 0x20 or 0xFF)
1003 or RemainingDevicePath is not the USB class device path.
1004 @retval EFI_NOT_FOUND The device specified by device path is not found.
1009 BdsLibConnectUsbDevByShortFormDP(
1010 IN UINT8 HostControllerPI
,
1011 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1016 // The implementation of this function is provided by Platform code.
1019 Convert Vendor device path to a device name.
1021 @param Str The buffer storing device name
1022 @param DevPath Pointer to vendor device path
1027 IN OUT POOL_PRINT
*Str
,
1032 Concatenates a formatted unicode string to allocated pool.
1033 The caller must free the resulting buffer.
1035 @param Str Tracks the allocated pool, size in use, and amount of pool allocated.
1036 @param Fmt The format string
1037 @param ... The data will be printed.
1039 @return Allocated buffer with the formatted string printed in it.
1040 The caller must free the allocated buffer.
1041 The buffer allocation is not packed.
1047 IN OUT POOL_PRINT
*Str
,
1053 Use Console Control to stop UGA-based Simple Text Out consoles from going
1054 to the UGA device. Put up LogoFile on every UGA device that is a console.
1056 @param[in] LogoFile File name of logo to display on the center of the screen.
1058 @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.
1059 @retval EFI_UNSUPPORTED Logo not found
1065 IN EFI_GUID
*LogoFile
1070 Use Console Control to turn on UGA based Simple Text Out consoles. The UGA
1071 Simple Text Out screens will now be synced up with all non UGA output devices
1073 @retval EFI_SUCCESS UGA devices are back in text mode and synced up.
1083 Use Console Control Protocol to lock the Console In Spliter virtual handle.
1084 This is the ConInHandle and ConIn handle in the EFI system table. All key
1085 presses will be ignored until the Password is typed in. The only way to
1086 disable the password is to type it in to a ConIn device.
1088 @param Password Password used to lock ConIn device.
1090 @retval EFI_SUCCESS lock the Console In Spliter virtual handle successfully.
1091 @retval EFI_UNSUPPORTED Password not found