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 according to the UEFI specification. The legacy boot option device path includes BBS_DEVICE_PATH.
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
118 @param ExitDataSize The size of exit data.
119 @param ExitData Data returned when Boot image failed.
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
127 BdsLibBootViaBootOption (
128 IN BDS_COMMON_OPTION
* Option
,
129 IN EFI_DEVICE_PATH_PROTOCOL
* DevicePath
,
130 OUT UINTN
*ExitDataSize
,
131 OUT CHAR16
**ExitData OPTIONAL
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.
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
151 4. Fixed BlockIo - The boot option points to a Fixed blockIo device,
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
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
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
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.
175 @param BdsBootOptionList The header of the linked list that indexed all
178 @retval EFI_SUCCESS Finished all the boot device enumerations and created
179 the boot option based on the boot device
181 @retval EFI_OUT_OF_RESOURCES Failed to enumerate the boot device and create the boot option list
185 BdsLibEnumerateAllBootOption (
186 IN OUT LIST_ENTRY
*BdsBootOptionList
190 Build the boot option with the handle parsed in
192 @param Handle The handle representing the device path for which to create
194 @param BdsBootOptionList The header of the link list which indexed all
196 @param String The description of the boot option.
201 BdsLibBuildOptionFromHandle (
202 IN EFI_HANDLE Handle
,
203 IN LIST_ENTRY
*BdsBootOptionList
,
209 Build the on flash shell boot option with the handle parsed in.
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
219 BdsLibBuildOptionFromShell (
220 IN EFI_HANDLE Handle
,
221 IN OUT LIST_ENTRY
*BdsBootOptionList
225 // Bds misc lib functions
228 Get boot mode by looking up configuration table and parsing HOB list
230 @param BootMode Boot mode from PEI handoff HOB.
232 @retval EFI_SUCCESS Successfully get boot mode
238 OUT EFI_BOOT_MODE
*BootMode
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.
246 @param BdsDriverLists The header of the current driver option link list
252 IN LIST_ENTRY
*BdsDriverLists
257 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
263 @param VariableName EFI Variable name indicate the BootOrder or
266 @retval EFI_SUCCESS Success create the boot option or driver option
268 @retval EFI_OUT_OF_RESOURCES Failed to get the boot option or driver option list
272 BdsLibBuildOptionFromVar (
273 IN LIST_ENTRY
*BdsCommonOptionList
,
274 IN CHAR16
*VariableName
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.
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
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
292 BdsLibGetVariableAndSize (
294 IN EFI_GUID
*VendorGuid
,
295 OUT UINTN
*VariableSize
300 This function prints a series of strings.
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.
306 @retval EFI_SUCCESS Success print out the string using ConOut.
307 @retval EFI_STATUS Return the status of the ConOut->OutputString ().
312 BdsLibOutputStrings (
313 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
,
318 Build the boot#### or driver#### option from the VariableName. The
319 build boot#### or driver#### will also be linked to BdsCommonOptionList.
321 @param BdsCommonOptionList The header of the boot#### or driver#### option
323 @param VariableName EFI Variable name, indicates if it is boot#### or
326 @retval BDS_COMMON_OPTION The option that was created
327 @retval NULL Failed to get the new option
332 BdsLibVariableToOption (
333 IN OUT LIST_ENTRY
*BdsCommonOptionList
,
334 IN CHAR16
*VariableName
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.
343 @param BdsOptionList The header of the boot#### or driver#### link list
344 @param DevicePath The device path which the boot#### or driver####
346 @param String The description of the boot#### or driver####
347 @param VariableName Indicate if the boot#### or driver#### option
349 @retval EFI_SUCCESS The boot#### or driver#### have been success
351 @retval EFI_STATUS Return the status of gRT->SetVariable ().
356 BdsLibRegisterNewOption (
357 IN LIST_ENTRY
*BdsOptionList
,
358 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
360 IN CHAR16
*VariableName
364 // Bds connect and disconnect driver lib funcions
367 This function connects all system drivers with the corresponding controllers.
372 BdsLibConnectAllDriversToAllControllers (
377 This function connects all system drivers to controllers.
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.
391 @param DevicePathToConnect The device path to be connected. Can be
392 a multi-instance device path
394 @retval EFI_SUCCESS All handles associates with every device path node
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
402 BdsLibConnectDevicePath (
403 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePathToConnect
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().
412 BdsLibConnectAllEfi (
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().
424 BdsLibDisconnectAllEfi (
429 // Bds console related lib functions
432 This function will search every simpletxt device in the current system,
433 and make every simpletxt device a potential console device.
438 BdsLibConnectAllConsoles (
444 This function will connect console device based on the console
445 device variable ConIn, ConOut and ErrOut.
447 @retval EFI_SUCCESS At least one of the ConIn and ConOut devices have
449 @retval EFI_STATUS Return the status of BdsLibConnectConsoleVariable ().
454 BdsLibConnectAllDefaultConsoles (
459 This function updates the console variable based on ConVarName. It can
460 add or remove one specific console device path from the variable
462 @param ConVarName Console-related variable name: ConIn, ConOut,
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.
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
476 BdsLibUpdateConsoleVariable (
477 IN CHAR16
*ConVarName
,
478 IN EFI_DEVICE_PATH_PROTOCOL
*CustomizedConDevicePath
,
479 IN EFI_DEVICE_PATH_PROTOCOL
*ExclusiveDevicePath
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
488 @param ConVarName Console related variable name, ConIn, ConOut,
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.
498 BdsLibConnectConsoleVariable (
499 IN CHAR16
*ConVarName
503 // Bds device path related lib functions
506 Delete the instance in Multi that overlaps with Single
508 @param Multi A pointer to a multi-instance device path data
510 @param Single A pointer to a single-instance device path data
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.
518 EFI_DEVICE_PATH_PROTOCOL
*
520 BdsLibDelPartMatchInstance (
521 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
522 IN EFI_DEVICE_PATH_PROTOCOL
*Single
526 Function compares a device path data structure to that of all the nodes of a
527 second device path instance.
529 @param Multi A pointer to a multi-instance device path data
531 @param Single A pointer to a single-instance device path data
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.
540 BdsLibMatchDevicePaths (
541 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
542 IN EFI_DEVICE_PATH_PROTOCOL
*Single
546 This function converts an input device structure to a Unicode string.
548 @param DevPath A pointer to the device path structure.
550 @return A new allocated Unicode string that represents the device path.
556 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
561 // Internal definitions
572 VOID (*Function
) (POOL_PRINT
*, VOID
*);
573 } DEVICE_PATH_STRING_TABLE
;
575 extern EFI_GUID mEfiDevicePathMessagingUartFlowControlGuid
;
578 EFI_DEVICE_PATH_PROTOCOL Header
;
580 UINT8 VendorDefinedData
[1];
581 } VENDOR_DEVICE_PATH_WITH_DATA
;
584 extern EFI_GUID mEfiDevicePathMessagingSASGuid
;
587 EFI_DEVICE_PATH_PROTOCOL Header
;
588 UINT16 NetworkProtocol
;
591 UINT16 TargetPortalGroupTag
;
592 CHAR16 TargetName
[1];
593 } ISCSI_DEVICE_PATH_WITH_NAME
;
597 // Notes: EFI 64 shadow all option rom
599 #if defined (MDE_CPU_IPF)
600 #define EFI64_SHADOW_ALL_LEGACY_ROM() ShadowAllOptionRom ();
602 #define EFI64_SHADOW_ALL_LEGACY_ROM()
606 Shadow all Legacy OptionRom.
616 // BBS support macros and functions
619 #if defined(MDE_CPU_IA32) || defined(MDE_CPU_X64)
620 #define REFRESH_LEGACY_BOOT_OPTIONS \
621 BdsDeleteAllInvalidLegacyBootOptions ();\
622 BdsAddNonExistingLegacyBootOptions (); \
623 BdsUpdateLegacyDevOrder ()
625 #define REFRESH_LEGACY_BOOT_OPTIONS
629 Delete all the invalid legacy boot options.
631 @retval EFI_SUCCESS All invalide legacy boot options are deleted.
632 @retval EFI_OUT_OF_RESOURCES Fail to allocate necessary memory.
633 @retval EFI_NOT_FOUND Fail to retrieve variable of boot order.
638 BdsDeleteAllInvalidLegacyBootOptions (
643 Add the legacy boot options from BBS table if they do not exist.
645 @retval EFI_SUCCESS The boot options are added successfully
646 or they are already in boot options.
647 @retval EFI_NOT_FOUND No legacy boot options is found.
648 @retval EFI_OUT_OF_RESOURCE No enough memory.
649 @return Other value LegacyBoot options are not added.
653 BdsAddNonExistingLegacyBootOptions (
658 Add the legacy boot devices from BBS table into
659 the legacy device boot order.
661 @retval EFI_SUCCESS The boot devices are added successfully.
662 @retval EFI_NOT_FOUND The legacy boot devices are not found.
663 @retval EFI_OUT_OF_RESOURCES Memmory or storage is not enough.
664 @retval EFI_DEVICE_ERROR Fail to add the legacy device boot order into EFI variable
665 because of hardware error.
669 BdsUpdateLegacyDevOrder (
674 Refresh the boot priority for BBS entries based on boot option entry and boot order.
676 @param Entry The boot option is to be checked for refresh BBS table.
678 @retval EFI_SUCCESS The boot priority for BBS entries is refreshed successfully.
679 @retval EFI_NOT_FOUND BBS entries can't be found.
680 @retval EFI_OUT_OF_RESOURCES Failed to get the legacy device boot order.
684 BdsRefreshBbsTableForBoot (
685 IN BDS_COMMON_OPTION
*Entry
689 Delete the Boot Option from EFI Variable. The Boot Order Arrray
692 @param OptionNumber The number of Boot option want to be deleted.
693 @param BootOrder The Boot Order array.
694 @param BootOrderSize The size of the Boot Order Array.
696 @retval EFI_SUCCESS The Boot Option Variable was found and removed
697 @retval EFI_UNSUPPORTED The Boot Option Variable store was inaccessible
698 @retval EFI_NOT_FOUND The Boot Option Variable was not found
702 BdsDeleteBootOption (
703 IN UINTN OptionNumber
,
704 IN OUT UINT16
*BootOrder
,
705 IN OUT UINTN
*BootOrderSize
709 //The interface functions related to the Setup Browser Reset Reminder feature
712 Enable the setup browser reset reminder feature.
713 This routine is used in platform tip. If the platform policy needs the feature, use the routine to enable it.
718 EnableResetReminderFeature (
723 Disable the setup browser reset reminder feature.
724 This routine is used in platform tip. If the platform policy does not want the feature, use the routine to disable it.
729 DisableResetReminderFeature (
734 Record the info that a reset is required.
735 A module boolean variable is used to record whether a reset is required.
740 EnableResetRequired (
746 Record the info that no reset is required.
747 A module boolean variable is used to record whether a reset is required.
752 DisableResetRequired (
757 Check whether platform policy enables the reset reminder feature. The default is enabled.
762 IsResetReminderFeatureEnable (
767 Check if the user changed any option setting that needs a system reset to be effective.
777 Check whether a reset is needed, and finish the reset reminder feature.
778 If a reset is needed, pop up a menu to notice user, and finish the feature
779 according to the user selection.
790 /// Define the boot type which to classify the boot option type
791 /// Different boot option type could have different boot behavior
792 /// Use their device path node (Type + SubType) as type value
793 /// The boot type here can be added according to requirement
797 /// ACPI boot type. For ACPI device, cannot use sub-type to distinguish device, so hardcode their value
799 #define BDS_EFI_ACPI_FLOPPY_BOOT 0x0201
801 /// Message boot type
802 /// If a device path of boot option only point to a message node, the boot option is message boot type
804 #define BDS_EFI_MESSAGE_ATAPI_BOOT 0x0301 // Type 03; Sub-Type 01
805 #define BDS_EFI_MESSAGE_SCSI_BOOT 0x0302 // Type 03; Sub-Type 02
806 #define BDS_EFI_MESSAGE_USB_DEVICE_BOOT 0x0305 // Type 03; Sub-Type 05
807 #define BDS_EFI_MESSAGE_SATA_BOOT 0x0312 // Type 03; Sub-Type 18
808 #define BDS_EFI_MESSAGE_MAC_BOOT 0x030b // Type 03; Sub-Type 11
809 #define BDS_EFI_MESSAGE_MISC_BOOT 0x03FF
813 /// If a device path of boot option contain a media node, the boot option is media boot type
815 #define BDS_EFI_MEDIA_HD_BOOT 0x0401 // Type 04; Sub-Type 01
816 #define BDS_EFI_MEDIA_CDROM_BOOT 0x0402 // Type 04; Sub-Type 02
819 /// If a device path of boot option contain a BBS node, the boot option is BBS boot type
821 #define BDS_LEGACY_BBS_BOOT 0x0501 // Type 05; Sub-Type 01
823 #define BDS_EFI_UNSUPPORT 0xFFFF
826 Check whether an instance in BlockIoDevicePath has the same partition node as the HardDriveDevicePath device path
828 @param BlockIoDevicePath Multi device path instances to check
829 @param HardDriveDevicePath A device path starting with a hard drive media
832 @retval TRUE There is a matched device path instance.
833 @retval FALSE There is no matched device path instance.
838 MatchPartitionDevicePathNode (
839 IN EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
,
840 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
845 Expand a device path that starts with a hard drive media device path node to be a
846 full device path that includes the full hardware path to the device. This function enables the device to boot.
847 To avoid requiring a connect on every boot, the front match is saved in a variable (the part point
848 to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ).
849 All successful history device paths
850 that point to the front part of the partition node will be saved.
852 @param HardDriveDevicePath EFI Device Path to boot, if it starts with a hard
853 drive media device path.
854 @return A Pointer to the full device path or NULL if a valid Hard Drive devic path
858 EFI_DEVICE_PATH_PROTOCOL
*
860 BdsExpandPartitionPartialDevicePathToFull (
861 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
865 Return the bootable media handle.
866 First, check whether the device is connected.
867 Second, check whether the device path points to a device that supports SimpleFileSystemProtocol.
868 Third, detect the the default boot file in the Media, and return the removable Media handle.
870 @param DevicePath Device Path to a bootable device
872 @return The bootable media handle. If the media on the DevicePath is not bootable, NULL will return.
877 BdsLibGetBootableHandle (
878 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
883 Checks whether the Device path in a boot option points to a valid bootable device, and if the device
884 is ready to boot now.
886 @param DevPath the Device path in a boot option
887 @param CheckMedia if true, check whether the device is ready to boot now.
889 @retval TRUE the Device path is valid
890 @retval FALSE the Device path is invalid
895 BdsLibIsValidEFIBootOptDevicePath (
896 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
897 IN BOOLEAN CheckMedia
901 Checks whether the Device path in a boot option points to a valid bootable device, and if the device
902 is ready to boot now.
903 If Description is not NULL and the device path points to a fixed BlockIo
904 device, this function checks whether the description conflicts with other auto-created
907 @param DevPath the Device path in a boot option
908 @param CheckMedia if true, checks if the device is ready to boot now.
909 @param Description the description of a boot option
911 @retval TRUE the Device path is valid
912 @retval FALSE the Device path is invalid
917 BdsLibIsValidEFIBootOptDevicePathExt (
918 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
919 IN BOOLEAN CheckMedia
,
920 IN CHAR16
*Description
924 For a bootable Device path, return its boot type.
926 @param DevicePath The bootable device Path to check
928 @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,
932 BdsGetBootTypeFromDevicePath (
933 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
938 This routine registers a function to adjust the different types of memory page numbers
939 just before booting, and saves the updated info into the variable for the next boot to use.
944 BdsLibSaveMemoryTypeInformation (
950 This function checks if a Fv file device path is valid, according to a file GUID. If it is invalid,
951 it tries to return the valid device path.
952 FV address maybe changes for memory layout adjust from time to time, use this funciton
953 could promise the Fv file device path is right.
955 @param DevicePath on input, the Fv file device path to check. On
956 output, the updated valid Fv file device path
957 @param FileGuid the Fv file GUID
959 @retval EFI_INVALID_PARAMETER the input DevicePath or FileGuid is invalid
960 @retval EFI_UNSUPPORTED the input DevicePath does not contain an Fv file
962 @retval EFI_ALREADY_STARTED the input DevicePath has pointed to the Fv file and is
964 @retval EFI_SUCCESS successfully updated the invalid DevicePath
965 and returned the updated device path in DevicePath
970 BdsLibUpdateFvFileDevicePath (
971 IN OUT EFI_DEVICE_PATH_PROTOCOL
** DevicePath
,
972 IN EFI_GUID
*FileGuid
977 Connect the specific USB device that matches the RemainingDevicePath,
978 and whose bus is determined by Host Controller (Uhci or Ehci)
980 @param HostControllerPI Uhci (0x00) or Ehci (0x20) or Both uhci and ehci
982 @param RemainingDevicePath a short-form device path that starts with the first
983 element being a USB WWID or a USB Class device
986 @retval EFI_SUCCESS The specific Usb device is connected successfully.
987 @retval EFI_INVALID_PARAMETER Invalid HostControllerPi (not 0x00, 0x20 or 0xFF)
988 or RemainingDevicePath is not the USB class device path.
989 @retval EFI_NOT_FOUND The device specified by device path is not found.
994 BdsLibConnectUsbDevByShortFormDP(
995 IN UINT8 HostControllerPI
,
996 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1001 // The implementation of this function is provided by Platform code.
1004 Convert Vendor device path to a device name.
1006 @param Str The buffer storing device name
1007 @param DevPath Pointer to vendor device path
1012 IN OUT POOL_PRINT
*Str
,
1017 Concatenates a formatted unicode string to allocated pool.
1018 The caller must free the resulting buffer.
1020 @param Str Tracks the allocated pool, size in use, and amount of pool allocated.
1021 @param Fmt The format string
1022 @param ... The data will be printed.
1024 @return Allocated buffer with the formatted string printed in it.
1025 The caller must free the allocated buffer.
1026 The buffer allocation is not packed.
1032 IN OUT POOL_PRINT
*Str
,
1038 Use SystemTable ConOut to stop video based Simple Text Out consoles from going
1039 to the video device. Put up LogoFile on every video device that is a console.
1041 @param[in] LogoFile File name of logo to display on the center of the screen.
1043 @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.
1044 @retval EFI_UNSUPPORTED Logo not found
1050 IN EFI_GUID
*LogoFile
1055 Use SystemTable ConOut to turn on video based Simple Text Out consoles. The
1056 Simple Text Out screens will now be synced up with all non video output devices
1058 @retval EFI_SUCCESS UGA devices are back in text mode and synced up.