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.
7 Copyright (c) 2004 - 2010, 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.
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 #include <Protocol/UserManager.h>
22 extern EFI_HANDLE mBdsImageHandle
;
25 /// Constants which are variable names used to access variables.
27 #define VAR_LEGACY_DEV_ORDER L"LegacyDevOrder"
30 /// Data structures and defines.
32 #define FRONT_PAGE_QUESTION_ID 0x0000
33 #define FRONT_PAGE_DATA_WIDTH 0x01
38 #define CONSOLE_OUT 0x00000001
39 #define STD_ERROR 0x00000002
40 #define CONSOLE_IN 0x00000004
41 #define CONSOLE_ALL (CONSOLE_OUT | CONSOLE_IN | STD_ERROR)
44 /// Load Option Attributes
46 #define LOAD_OPTION_ACTIVE 0x00000001
47 #define LOAD_OPTION_FORCE_RECONNECT 0x00000002
49 #define LOAD_OPTION_HIDDEN 0x00000008
50 #define LOAD_OPTION_CATEGORY 0x00001F00
52 #define LOAD_OPTION_CATEGORY_BOOT 0x00000000
53 #define LOAD_OPTION_CATEGORY_APP 0x00000100
55 #define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001
56 #define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002
58 #define IS_LOAD_OPTION_TYPE(_c, _Mask) (BOOLEAN) (((_c) & (_Mask)) != 0)
61 /// Define the maximum characters that will be accepted.
64 #define MAX_CHAR_SIZE (MAX_CHAR * 2)
67 /// Define maximum characters for boot option variable "BootXXXX".
69 #define BOOT_OPTION_MAX_CHAR 10
72 // This data structure is the part of BDS_CONNECT_ENTRY
74 #define BDS_LOAD_OPTION_SIGNATURE SIGNATURE_32 ('B', 'd', 'C', 'O')
81 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
89 UINT32 LoadOptionsSize
;
95 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
97 } BDS_CONSOLE_CONNECT_ENTRY
;
100 // Bds boot related lib functions
103 Boot from the UEFI spec defined "BootNext" variable.
113 Process the boot option according to the UEFI specification. The legacy boot option device path includes 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
177 current boot options.
179 @retval EFI_SUCCESS Finished all the boot device enumerations and
180 created the boot option based on the boot device.
182 @retval EFI_OUT_OF_RESOURCES Failed to enumerate the boot device and create
183 the boot option list.
187 BdsLibEnumerateAllBootOption (
188 IN OUT LIST_ENTRY
*BdsBootOptionList
192 Build the boot option with the handle parsed in.
194 @param Handle The handle representing the device path for which
195 to create a boot option.
196 @param BdsBootOptionList The header of the link list that indexed all
197 current boot options.
198 @param String The description of the boot option.
203 BdsLibBuildOptionFromHandle (
204 IN EFI_HANDLE Handle
,
205 IN LIST_ENTRY
*BdsBootOptionList
,
211 Build the on flash shell boot option with the handle parsed in.
213 @param Handle The handle which present the device path to create
214 the on flash shell boot option.
215 @param BdsBootOptionList The header of the link list that indexed all
216 current boot options.
221 BdsLibBuildOptionFromShell (
222 IN EFI_HANDLE Handle
,
223 IN OUT LIST_ENTRY
*BdsBootOptionList
227 // Bds misc lib functions
230 Get boot mode by looking up the configuration table and parsing the HOB list.
232 @param BootMode The boot mode from PEI handoff HOB.
234 @retval EFI_SUCCESS Successfully got boot mode.
240 OUT EFI_BOOT_MODE
*BootMode
245 The function will go through the driver option link list, and then load and start
246 every driver to which the driver option device path points.
248 @param BdsDriverLists The header of the current driver option link list.
254 IN LIST_ENTRY
*BdsDriverLists
259 This function processes BootOrder or DriverOrder variables, by calling
261 BdsLibVariableToOption () for each UINT16 in the variables.
263 @param BdsCommonOptionList The header of the option list base on the variable
265 @param VariableName An EFI Variable name indicate the BootOrder or
268 @retval EFI_SUCCESS Successfully created the boot option or driver option
270 @retval EFI_OUT_OF_RESOURCES Failed to get the boot option or the driver option list.
274 BdsLibBuildOptionFromVar (
275 IN LIST_ENTRY
*BdsCommonOptionList
,
276 IN CHAR16
*VariableName
280 This function reads the EFI variable (VendorGuid/Name) and returns a dynamically allocated
281 buffer and the size of the buffer. If it fails, return NULL.
283 @param Name The string part of the EFI variable name.
284 @param VendorGuid The GUID part of the EFI variable name.
285 @param VariableSize Returns the size of the EFI variable that was read.
287 @return Dynamically allocated memory that contains a copy
288 of the EFI variable. The caller is responsible for
290 @retval NULL The variable was not read.
295 BdsLibGetVariableAndSize (
297 IN EFI_GUID
*VendorGuid
,
298 OUT UINTN
*VariableSize
303 This function prints a series of strings.
305 @param ConOut A pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.
306 @param ... A variable argument list containing a series of
307 strings, the last string must be NULL.
309 @retval EFI_SUCCESS Successfully printed out the string using ConOut.
310 @retval EFI_STATUS Return the status of the ConOut->OutputString ().
315 BdsLibOutputStrings (
316 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
,
321 Build the boot#### or driver#### option from the VariableName. The
322 build boot#### or driver#### will also be linked to BdsCommonOptionList.
324 @param BdsCommonOptionList The header of the boot#### or driver#### option
326 @param VariableName EFI Variable name, indicates if it is boot#### or
329 @retval BDS_COMMON_OPTION The option that was created.
330 @retval NULL Failed to get the new option.
335 BdsLibVariableToOption (
336 IN OUT LIST_ENTRY
*BdsCommonOptionList
,
337 IN CHAR16
*VariableName
341 This function registers the new boot#### or driver#### option based on
342 the VariableName. The new registered boot#### or driver#### will be linked
343 to BdsOptionList and also update to the VariableName. After the boot#### or
344 driver#### updated, the BootOrder or DriverOrder will also be updated.
346 @param BdsOptionList The header of the boot#### or driver#### link list.
347 @param DevicePath The device path that the boot#### or driver####
349 @param String The description of the boot#### or driver####.
350 @param VariableName Indicate if the boot#### or driver#### option.
352 @retval EFI_SUCCESS The boot#### or driver#### have been successfully
354 @retval EFI_STATUS Return the status of gRT->SetVariable ().
359 BdsLibRegisterNewOption (
360 IN LIST_ENTRY
*BdsOptionList
,
361 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
363 IN CHAR16
*VariableName
367 // Bds connect and disconnect driver lib funcions
370 This function connects all system drivers with the corresponding controllers.
375 BdsLibConnectAllDriversToAllControllers (
380 This function connects all system drivers to controllers.
390 This function creates all handles associated with the given device
391 path node. If the handle associated with one device path node cannot
392 be created, then it tries to execute the dispatch to load the missing drivers.
394 @param DevicePathToConnect The device path to be connected. Can be
395 a multi-instance device path.
397 @retval EFI_SUCCESS All handles associates with every device path node
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.
405 BdsLibConnectDevicePath (
406 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePathToConnect
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().
414 @retval EFI_SUCCESS All handles and child handles have been
416 @retval EFI_STATUS Return the status of gBS->LocateHandleBuffer().
420 BdsLibConnectAllEfi (
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().
429 @retval EFI_SUCCESS All handles have been disconnected.
430 @retval EFI_STATUS Error status returned by of gBS->LocateHandleBuffer().
435 BdsLibDisconnectAllEfi (
440 // Bds console related lib functions
443 This function will search every simpletxt device in the current system,
444 and make every simpletxt device a potential console device.
449 BdsLibConnectAllConsoles (
455 This function will connect console device based on the console
456 device variable ConIn, ConOut and ErrOut.
458 @retval EFI_SUCCESS At least one of the ConIn and ConOut devices have
460 @retval EFI_STATUS Return the status of BdsLibConnectConsoleVariable ().
465 BdsLibConnectAllDefaultConsoles (
470 This function updates the console variable based on ConVarName. It can
471 add or remove one specific console device path from the variable
473 @param ConVarName The console-related variable name: ConIn, ConOut,
475 @param CustomizedConDevicePath The console device path to be added to
476 the console variable ConVarName. Cannot be multi-instance.
477 @param ExclusiveDevicePath The console device path to be removed
478 from the console variable ConVarName. Cannot be multi-instance.
480 @retval EFI_UNSUPPORTED The added device path is the same as a removed one.
481 @retval EFI_SUCCESS Successfully added or removed the device path from the
487 BdsLibUpdateConsoleVariable (
488 IN CHAR16
*ConVarName
,
489 IN EFI_DEVICE_PATH_PROTOCOL
*CustomizedConDevicePath
,
490 IN EFI_DEVICE_PATH_PROTOCOL
*ExclusiveDevicePath
494 Connect the console device base on the variable ConVarName. If
495 ConVarName is a multi-instance device path, and at least one
496 instance connects successfully, then this function
499 @param ConVarName The console related variable name: ConIn, ConOut,
502 @retval EFI_NOT_FOUND No console devices were connected successfully
503 @retval EFI_SUCCESS Connected at least one instance of the console
504 device path based on the variable ConVarName.
509 BdsLibConnectConsoleVariable (
510 IN CHAR16
*ConVarName
514 // Bds device path related lib functions
517 Delete the instance in Multi that overlaps with Single.
519 @param Multi A pointer to a multi-instance device path data
521 @param Single A pointer to a single-instance device path data
524 @return This function removes the device path instances in Multi that overlap
525 Single, and returns the resulting device path. If there is no
526 remaining device path as a result, this function will return NULL.
529 EFI_DEVICE_PATH_PROTOCOL
*
531 BdsLibDelPartMatchInstance (
532 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
533 IN EFI_DEVICE_PATH_PROTOCOL
*Single
537 This function compares a device path data structure to that of all the nodes of a
538 second device path instance.
540 @param Multi A pointer to a multi-instance device path data
542 @param Single A pointer to a single-instance device path data
545 @retval TRUE If the Single device path is contained within a
547 @retval FALSE The Single device path is not contained within a
553 BdsLibMatchDevicePaths (
554 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
555 IN EFI_DEVICE_PATH_PROTOCOL
*Single
559 This function converts an input device structure to a Unicode string.
561 @param DevPath A pointer to the device path structure.
563 @return A newly allocated Unicode string that represents the device path.
569 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
574 // Internal definitions
584 (*DEV_PATH_FUNCTION
) (
585 IN OUT POOL_PRINT
*Str
,
592 DEV_PATH_FUNCTION Function
;
593 } DEVICE_PATH_STRING_TABLE
;
595 extern EFI_GUID mEfiDevicePathMessagingUartFlowControlGuid
;
598 EFI_DEVICE_PATH_PROTOCOL Header
;
600 UINT8 VendorDefinedData
[1];
601 } VENDOR_DEVICE_PATH_WITH_DATA
;
604 extern EFI_GUID mEfiDevicePathMessagingSASGuid
;
607 EFI_DEVICE_PATH_PROTOCOL Header
;
608 UINT16 NetworkProtocol
;
611 UINT16 TargetPortalGroupTag
;
612 CHAR16 TargetName
[1];
613 } ISCSI_DEVICE_PATH_WITH_NAME
;
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 invalid legacy boot options are deleted.
632 @retval EFI_OUT_OF_RESOURCES Failed to allocate necessary memory.
633 @retval EFI_NOT_FOUND Failed 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 were 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 were added successfully.
662 @retval EFI_NOT_FOUND The legacy boot devices are not found.
663 @retval EFI_OUT_OF_RESOURCES Memory or storage is not enough.
664 @retval EFI_DEVICE_ERROR Failed to add the legacy device boot order into EFI variable
665 because of a 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 a refreshed BBS table.
678 @retval EFI_SUCCESS The boot priority for BBS entries 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 options wanting 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 a 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 a 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 with which to classify the boot option type.
791 /// Different boot option types could have different boot behaviors.
792 /// Use their device path node (Type + SubType) as the type value.
793 /// The boot type here can be added according to requirements.
797 /// ACPI boot type. For ACPI devices, using sub-types to distinguish devices is not allowed, so hardcode their values.
799 #define BDS_EFI_ACPI_FLOPPY_BOOT 0x0201
801 /// Message boot type
802 /// If a device path of boot option only points to a message node, the boot option is a 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 contains 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 contains 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 The 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 The given device path contains MEDIA_DEVICE_PATH type device path node,
929 whose subtype is MEDIA_HARDDRIVE_DP.
930 @retval BDS_EFI_MEDIA_CDROM_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node,
931 whose subtype is MEDIA_CDROM_DP.
932 @retval BDS_EFI_ACPI_FLOPPY_BOOT A given device path contains ACPI_DEVICE_PATH type device path node,
933 whose HID is floppy device.
934 @retval BDS_EFI_MESSAGE_ATAPI_BOOT A given device path contains MESSAGING_DEVICE_PATH type device path node,
935 and its last device path node's subtype is MSG_ATAPI_DP.
936 @retval BDS_EFI_MESSAGE_SCSI_BOOT A given device path contains MESSAGING_DEVICE_PATH type device path node,
937 and its last device path node's subtype is MSG_SCSI_DP.
938 @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT A given device path contains MESSAGING_DEVICE_PATH type device path node,
939 and its last device path node's subtype is MSG_USB_DP.
940 @retval BDS_EFI_MESSAGE_MISC_BOOT The device path does not contain any media device path node, and
941 its last device path node points to a message device path node.
942 @retval BDS_LEGACY_BBS_BOOT A given device path contains BBS_DEVICE_PATH type device path node.
943 @retval BDS_EFI_UNSUPPORT An EFI Removable BlockIO device path does not point to a media and message device.
948 BdsGetBootTypeFromDevicePath (
949 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
954 This routine registers a function to adjust the different types of memory page numbers
955 just before booting, and saves the updated info into the variable for the next boot to use.
960 BdsLibSaveMemoryTypeInformation (
965 Identify a user and, if authenticated, returns the current user profile handle.
967 @param[out] User Points to the user profile handle.
969 @retval EFI_SUCCESS The user is successfully identified, or user identification
971 @retval EFI_ACCESS_DENIED The user was not successfully identified.
977 OUT EFI_USER_PROFILE_HANDLE
*User
981 This function checks if a Fv file device path is valid, according to a file GUID. If it is invalid,
982 it tries to return the valid device path.
983 FV address maybe changes for memory layout adjust from time to time, use this funciton
984 could promise the Fv file device path is right.
986 @param DevicePath On input, the Fv file device path to check. On
987 output, the updated valid Fv file device path
988 @param FileGuid the Fv file GUID.
990 @retval EFI_INVALID_PARAMETER The input DevicePath or FileGuid is invalid.
991 @retval EFI_UNSUPPORTED The input DevicePath does not contain an Fv file
993 @retval EFI_ALREADY_STARTED The input DevicePath has pointed to the Fv file and is
995 @retval EFI_SUCCESS Successfully updated the invalid DevicePath
996 and returned the updated device path in DevicePath.
1001 BdsLibUpdateFvFileDevicePath (
1002 IN OUT EFI_DEVICE_PATH_PROTOCOL
** DevicePath
,
1003 IN EFI_GUID
*FileGuid
1008 Connect the specific USB device that matches the RemainingDevicePath,
1009 and whose bus is determined by Host Controller (Uhci or Ehci).
1011 @param HostControllerPI Uhci (0x00) or Ehci (0x20) or Both uhci and ehci
1013 @param RemainingDevicePath A short-form device path that starts with the first
1014 element being a USB WWID or a USB Class device
1017 @retval EFI_SUCCESS The specific Usb device is connected successfully.
1018 @retval EFI_INVALID_PARAMETER Invalid HostControllerPi (not 0x00, 0x20 or 0xFF)
1019 or RemainingDevicePath is not the USB class device path.
1020 @retval EFI_NOT_FOUND The device specified by device path is not found.
1025 BdsLibConnectUsbDevByShortFormDP(
1026 IN UINT8 HostControllerPI
,
1027 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1032 // The implementation of this function is provided by Platform code.
1035 Convert Vendor device path to a device name.
1037 @param Str The buffer storing device name.
1038 @param DevPath The pointer to vendor device path.
1043 IN OUT POOL_PRINT
*Str
,
1048 Concatenates a formatted unicode string to an allocated pool.
1049 The caller must free the resulting buffer.
1051 @param Str Tracks the allocated pool, size in use, and amount of pool allocated.
1052 @param Fmt The format string.
1053 @param ... The data will be printed.
1055 @return Allocated buffer with the formatted string printed in it.
1056 The caller must free the allocated buffer.
1057 The buffer allocation is not packed.
1063 IN OUT POOL_PRINT
*Str
,
1069 Use SystemTable ConOut to stop video based Simple Text Out consoles from going
1070 to the video device. Put up LogoFile on every video device that is a console.
1072 @param[in] LogoFile The file name of logo to display on the center of the screen.
1074 @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.
1075 @retval EFI_UNSUPPORTED Logo not found.
1081 IN EFI_GUID
*LogoFile
1086 Use SystemTable ConOut to turn on video based Simple Text Out consoles. The
1087 Simple Text Out screens will now be synced up with all non-video output devices.
1089 @retval EFI_SUCCESS UGA devices are back in text mode and synced up.