2 Generic BDS library definition, include the data structure and function.
4 Copyright (c) 2004 - 2008, Intel Corporation. <BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _GENERIC_BDS_LIB_H_
16 #define _GENERIC_BDS_LIB_H_
18 #include <Protocol/HiiDatabase.h>
19 #include <IndustryStandard/PeImage.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 defined in EFI Specification
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 Maxmim characters that will be accepted
64 #define MAX_CHAR_SIZE (MAX_CHAR * 2)
66 #define MIN_ALIGNMENT_SIZE 4
67 #define ALIGN_SIZE(a) ((a % MIN_ALIGNMENT_SIZE) ? MIN_ALIGNMENT_SIZE - (a % MIN_ALIGNMENT_SIZE) : 0)
70 // Define maximum characters for boot option variable "BootXXXX"
72 #define BOOT_OPTION_MAX_CHAR 10
75 // This data structure is the part of BDS_CONNECT_ENTRY that we can hard code.
77 #define BDS_LOAD_OPTION_SIGNATURE SIGNATURE_32 ('B', 'd', 'C', 'O')
84 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
92 UINT32 LoadOptionsSize
;
98 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
100 } BDS_CONSOLE_CONNECT_ENTRY
;
107 // Bds boot related lib functions
110 Boot from the UEFI spec defined "BootNext" variable.
120 Process the boot option follow the UEFI specification and
121 special treat the legacy boot option with BBS_DEVICE_PATH.
123 @param Option The boot option need to be processed
124 @param DevicePath The device path which describe where to load the
125 boot image or the legcy BBS device path to boot
127 @param ExitDataSize The size of exit data.
128 @param ExitData Data returned when Boot image failed.
130 @retval EFI_SUCCESS Boot from the input boot option successfully.
131 @retval EFI_NOT_FOUND If the Device Path is not found in the system
136 BdsLibBootViaBootOption (
137 IN BDS_COMMON_OPTION
* Option
,
138 IN EFI_DEVICE_PATH_PROTOCOL
* DevicePath
,
139 OUT UINTN
*ExitDataSize
,
140 OUT CHAR16
**ExitData OPTIONAL
145 This function will enumerate all possible boot device in the system,
146 it will only excute once of every boot.
148 @param BdsBootOptionList The header of the link list which indexed all
151 @retval EFI_SUCCESS Finished all the boot device enumerate and create
152 the boot option base on that boot device
157 BdsLibEnumerateAllBootOption (
158 IN OUT LIST_ENTRY
*BdsBootOptionList
162 Build the boot option with the handle parsed in
164 @param Handle The handle which present the device path to create
166 @param BdsBootOptionList The header of the link list which indexed all
168 @param String The description of the boot option.
173 BdsLibBuildOptionFromHandle (
174 IN EFI_HANDLE Handle
,
175 IN LIST_ENTRY
*BdsBootOptionList
,
181 Build the on flash shell boot option with the handle parsed in.
183 @param Handle The handle which present the device path to create
184 on flash shell boot option
185 @param BdsBootOptionList The header of the link list which indexed all
191 BdsLibBuildOptionFromShell (
192 IN EFI_HANDLE Handle
,
193 IN OUT LIST_ENTRY
*BdsBootOptionList
197 // Bds misc lib functions
200 Return the default value for system Timeout variable.
202 @return Timeout value.
212 Get boot mode by looking up configuration table and parsing HOB list
214 @param BootMode Boot mode from PEI handoff HOB.
216 @retval EFI_SUCCESS Successfully get boot mode
222 OUT EFI_BOOT_MODE
*BootMode
227 The function will go through the driver optoin link list, load and start
228 every driver the driver optoin device path point to.
230 @param BdsDriverLists The header of the current driver option link list
236 IN LIST_ENTRY
*BdsDriverLists
241 Process BootOrder, or DriverOrder variables, by calling
242 BdsLibVariableToOption () for each UINT16 in the variables.
244 @param BdsCommonOptionList The header of the option list base on variable
246 @param VariableName EFI Variable name indicate the BootOrder or
249 @retval EFI_SUCCESS Success create the boot option or driver option
251 @retval EFI_OUT_OF_RESOURCES Failed to get the boot option or driver option list
256 BdsLibBuildOptionFromVar (
257 IN LIST_ENTRY
*BdsCommonOptionList
,
258 IN CHAR16
*VariableName
262 Read the EFI variable (VendorGuid/Name) and return a dynamically allocated
263 buffer, and the size of the buffer. If failure return NULL.
265 @param Name String part of EFI variable name
266 @param VendorGuid GUID part of EFI variable name
267 @param VariableSize Returns the size of the EFI variable that was read
269 @return Dynamically allocated memory that contains a copy of the EFI variable
270 Caller is responsible freeing the buffer.
271 @retval NULL Variable was not read
276 BdsLibGetVariableAndSize (
278 IN EFI_GUID
*VendorGuid
,
279 OUT UINTN
*VariableSize
284 This function prints a series of strings.
286 @param ConOut Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
287 @param ... A variable argument list containing series of
288 strings, the last string must be NULL.
290 @retval EFI_SUCCESS Success print out the string using ConOut.
291 @retval EFI_STATUS Return the status of the ConOut->OutputString ().
296 BdsLibOutputStrings (
297 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
,
302 Build the boot#### or driver#### option from the VariableName, the
303 build boot#### or driver#### will also be linked to BdsCommonOptionList.
305 @param BdsCommonOptionList The header of the boot#### or driver#### option
307 @param VariableName EFI Variable name indicate if it is boot#### or
310 @retval BDS_COMMON_OPTION Get the option just been created
311 @retval NULL Failed to get the new option
316 BdsLibVariableToOption (
317 IN OUT LIST_ENTRY
*BdsCommonOptionList
,
318 IN CHAR16
*VariableName
322 This function will register the new boot#### or driver#### option base on
323 the VariableName. The new registered boot#### or driver#### will be linked
324 to BdsOptionList and also update to the VariableName. After the boot#### or
325 driver#### updated, the BootOrder or DriverOrder will also be updated.
327 @param BdsOptionList The header of the boot#### or driver#### link list
328 @param DevicePath The device path which the boot#### or driver####
330 @param String The description of the boot#### or driver####
331 @param VariableName Indicate if the boot#### or driver#### option
333 @retval EFI_SUCCESS The boot#### or driver#### have been success
335 @retval EFI_STATUS Return the status of gRT->SetVariable ().
340 BdsLibRegisterNewOption (
341 IN LIST_ENTRY
*BdsOptionList
,
342 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
344 IN CHAR16
*VariableName
348 // Bds connect or disconnect driver lib funcion
351 Connects all drivers to all controllers.
352 This function make sure all the current system driver will manage
353 the correspoinding controllers if have. And at the same time, make
354 sure all the system controllers have driver to manage it if have.
359 BdsLibConnectAllDriversToAllControllers (
364 This function will connect all the system driver to controller
365 first, and then special connect the default console, this make
366 sure all the system controller available and the platform default
377 This function will create all handles associate with every device
378 path node. If the handle associate with one device path node can not
379 be created success, then still give one chance to do the dispatch,
380 which load the missing drivers if possible.
382 @param DevicePathToConnect The device path which will be connected, it can be
383 a multi-instance device path
385 @retval EFI_SUCCESS All handles associate with every device path node
387 @retval EFI_OUT_OF_RESOURCES There is no resource to create new handles
388 @retval EFI_NOT_FOUND Create the handle associate with one device path
394 BdsLibConnectDevicePath (
395 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePathToConnect
399 This function will connect all current system handles recursively. The
400 connection will finish until every handle's child handle created if it have.
402 @retval EFI_SUCCESS All handles and it's child handle have been
404 @retval EFI_STATUS Return the status of gBS->LocateHandleBuffer().
409 BdsLibConnectAllEfi (
415 This function will disconnect all current system handles. The disconnection
416 will finish until every handle have been disconnected.
418 @retval EFI_SUCCESS All handles have been disconnected
419 @retval EFI_STATUS Return the status of gBS->LocateHandleBuffer().
424 BdsLibDisconnectAllEfi (
429 // Bds console related lib functions
432 This function will search every simpletxt devive in current system,
433 and make every simpletxt device as pertantial console device.
438 BdsLibConnectAllConsoles (
444 This function will connect console device base on the console
445 device variable ConIn, ConOut and ErrOut.
447 @retval EFI_SUCCESS At least one of the ConIn and ConOut device have
448 been connected success.
449 @retval EFI_STATUS Return the status of BdsLibConnectConsoleVariable ().
454 BdsLibConnectAllDefaultConsoles (
459 This function update 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 which will be added to
465 the console variable ConVarName, this parameter
466 can not be multi-instance.
467 @param ExclusiveDevicePath The console device path which will be removed
468 from the console variable ConVarName, this
469 parameter can not be multi-instance.
471 @retval EFI_UNSUPPORTED The added device path is same to the removed one.
472 @retval EFI_SUCCESS Success add or remove the device path from the
478 BdsLibUpdateConsoleVariable (
479 IN CHAR16
*ConVarName
,
480 IN EFI_DEVICE_PATH_PROTOCOL
*CustomizedConDevicePath
,
481 IN EFI_DEVICE_PATH_PROTOCOL
*ExclusiveDevicePath
485 Connect the console device base on the variable ConVarName, if
486 device path of the ConVarName is multi-instance device path, if
487 anyone of the instances is connected success, then this function
490 @param ConVarName Console related variable name, ConIn, ConOut,
493 @retval EFI_NOT_FOUND There is not any console devices connected
495 @retval EFI_SUCCESS Success connect any one instance of the console
496 device path base on the variable ConVarName.
501 BdsLibConnectConsoleVariable (
502 IN CHAR16
*ConVarName
506 // Bds device path related lib functions
509 Delete the instance in Multi which matches partly with Single instance
511 @param Multi A pointer to a multi-instance device path data
513 @param Single A pointer to a single-instance device path data
516 @return This function will remove the device path instances in Multi which partly
517 match with the Single, and return the result device path. If there is no
518 remaining device path as a result, this function will return NULL.
521 EFI_DEVICE_PATH_PROTOCOL
*
523 BdsLibDelPartMatchInstance (
524 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
525 IN EFI_DEVICE_PATH_PROTOCOL
*Single
529 Function compares a device path data structure to that of all the nodes of a
530 second device path instance.
532 @param Multi A pointer to a multi-instance device path data
534 @param Single A pointer to a single-instance device path data
537 @retval TRUE If the Single device path is contained within Multi device path.
538 @retval FALSE The Single device path is not match within Multi device path.
543 BdsLibMatchDevicePaths (
544 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
545 IN EFI_DEVICE_PATH_PROTOCOL
*Single
549 This function converts an input device structure to a Unicode string.
551 @param DevPath A pointer to the device path structure.
553 @return A new allocated Unicode string that represents the device path.
559 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
564 // Internal definitions
575 VOID (*Function
) (POOL_PRINT
*, VOID
*);
576 } DEVICE_PATH_STRING_TABLE
;
578 extern EFI_GUID mEfiDevicePathMessagingUartFlowControlGuid
;
581 EFI_DEVICE_PATH_PROTOCOL Header
;
583 UINT8 VendorDefinedData
[1];
584 } VENDOR_DEVICE_PATH_WITH_DATA
;
587 extern EFI_GUID mEfiDevicePathMessagingSASGuid
;
590 EFI_DEVICE_PATH_PROTOCOL Header
;
591 UINT16 NetworkProtocol
;
594 UINT16 TargetPortalGroupTag
;
595 CHAR16 iSCSITargetName
[1];
596 } ISCSI_DEVICE_PATH_WITH_NAME
;
600 // Notes: EFI 64 shadow all option rom
602 #if defined (MDE_CPU_IPF)
603 #define EFI64_SHADOW_ALL_LEGACY_ROM() ShadowAllOptionRom ();
605 #define EFI64_SHADOW_ALL_LEGACY_ROM()
609 Shadow all Legacy OptionRom.
619 // BBS support macros and functions
622 #if defined(MDE_CPU_IA32) || defined(MDE_CPU_X64)
623 #define REFRESH_LEGACY_BOOT_OPTIONS \
624 BdsDeleteAllInvalidLegacyBootOptions ();\
625 BdsAddNonExistingLegacyBootOptions (); \
626 BdsUpdateLegacyDevOrder ()
628 #define REFRESH_LEGACY_BOOT_OPTIONS
632 Delete all the invalid legacy boot options.
634 @retval EFI_SUCCESS All invalide legacy boot options are deleted.
635 @retval EFI_OUT_OF_RESOURCES Fail to allocate necessary memory.
636 @retval EFI_NOT_FOUND Fail to retrive variable of boot order.
641 BdsDeleteAllInvalidLegacyBootOptions (
647 Add the legacy boot options from BBS table if they do not exist.
649 @retval EFI_SUCCESS The boot options are added successfully
650 or they are already in boot options.
655 BdsAddNonExistingLegacyBootOptions (
661 Add the legacy boot devices from BBS table into
662 the legacy device boot order.
664 @retval EFI_SUCCESS The boot devices are added successfully.
669 BdsUpdateLegacyDevOrder (
675 Set the boot priority for BBS entries based on boot option entry and boot order.
677 @param Entry The boot option is to be checked for refresh BBS table.
679 @retval EFI_SUCCESS The boot priority for BBS entries is refreshed successfully.
684 BdsRefreshBbsTableForBoot (
685 IN BDS_COMMON_OPTION
*Entry
690 Delete boot option specified by OptionNumber and adjust the boot order.
692 @param OptionNumber The boot option to be deleted.
693 @param BootOrder Boot order list to be adjusted by remove this boot option.
694 @param BootOrderSize The size of Boot order list will be modified.
696 @retval EFI_SUCCESS The boot option is deleted successfully.
701 BdsDeleteBootOption (
702 IN UINTN OptionNumber
,
703 IN OUT UINT16
*BootOrder
,
704 IN OUT UINTN
*BootOrderSize
708 //The interface functions relate with Setup Browser Reset Reminder feature
711 Enable the setup browser reset reminder feature.
712 This routine is used in platform tip. If the platform policy need the feature, use the routine to enable it.
717 EnableResetReminderFeature (
722 Disable the setup browser reset reminder feature.
723 This routine is used in platform tip. If the platform policy do not want the feature, use the routine to disable it.
728 DisableResetReminderFeature (
733 Record the info that a reset is required.
734 A module boolean variable is used to record whether a reset is required.
739 EnableResetRequired (
745 Record the info that no reset is required.
746 A module boolean variable is used to record whether a reset is required.
751 DisableResetRequired (
756 Check whether platform policy enable the reset reminder feature. The default is enabled.
761 IsResetReminderFeatureEnable (
766 Check if user changed any option setting which needs a system reset to be effective.
776 Check whether a reset is needed, and finish the reset reminder feature.
777 If a reset is needed, Popup a menu to notice user, and finish the feature
778 according to the user selection.
789 Get the headers (dos, image, optional header) from an image
791 @param Device SimpleFileSystem device handle
792 @param FileName File name for the image
793 @param DosHeader Pointer to dos header
794 @param Hdr The buffer in which to return the PE32, PE32+, or TE header.
796 @retval EFI_SUCCESS Successfully get the machine type.
797 @retval EFI_NOT_FOUND The file is not found.
798 @retval EFI_LOAD_ERROR File is not a valid image file.
803 BdsLibGetImageHeader (
804 IN EFI_HANDLE Device
,
806 OUT EFI_IMAGE_DOS_HEADER
*DosHeader
,
807 OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
811 // Define the boot type which to classify the boot option type
812 // Different boot option type could have different boot behavior
813 // Use their device path node (Type + SubType) as type value
814 // The boot type here can be added according to requirement
817 // ACPI boot type. For ACPI device, cannot use sub-type to distinguish device, so hardcode their value
819 #define BDS_EFI_ACPI_FLOPPY_BOOT 0x0201
822 // If a device path of boot option only point to a message node, the boot option is message boot type
824 #define BDS_EFI_MESSAGE_ATAPI_BOOT 0x0301 // Type 03; Sub-Type 01
825 #define BDS_EFI_MESSAGE_SCSI_BOOT 0x0302 // Type 03; Sub-Type 02
826 #define BDS_EFI_MESSAGE_USB_DEVICE_BOOT 0x0305 // Type 03; Sub-Type 05
827 #define BDS_EFI_MESSAGE_MISC_BOOT 0x03FF
830 // If a device path of boot option contain a media node, the boot option is media boot type
832 #define BDS_EFI_MEDIA_HD_BOOT 0x0401 // Type 04; Sub-Type 01
833 #define BDS_EFI_MEDIA_CDROM_BOOT 0x0402 // Type 04; Sub-Type 02
836 // If a device path of boot option contain a BBS node, the boot option is BBS boot type
838 #define BDS_LEGACY_BBS_BOOT 0x0501 // Type 05; Sub-Type 01
840 #define BDS_EFI_UNSUPPORT 0xFFFF
843 // USB host controller Programming Interface.
845 #define PCI_CLASSC_PI_UHCI 0x00
846 #define PCI_CLASSC_PI_EHCI 0x20
849 Check whether there is a instance in BlockIoDevicePath, which contain multi device path
850 instances, has the same partition node with HardDriveDevicePath device path
852 @param BlockIoDevicePath Multi device path instances which need to check
853 @param HardDriveDevicePath A device path which starts with a hard drive media
856 @retval TRUE There is a matched device path instance.
857 @retval FALSE There is no matched device path instance.
862 MatchPartitionDevicePathNode (
863 IN EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
,
864 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
869 Expand a device path that starts with a hard drive media device path node to be a
870 full device path that includes the full hardware path to the device. We need
871 to do this so it can be booted. As an optimizaiton the front match (the part point
872 to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ) is saved in a variable
873 so a connect all is not required on every boot. All successful history device path
874 which point to partition node (the front part) will be saved.
876 @param HardDriveDevicePath EFI Device Path to boot, if it starts with a hard
877 drive media device path.
878 @return A Pointer to the full device path or NULL if a valid Hard Drive devic path
882 EFI_DEVICE_PATH_PROTOCOL
*
884 BdsExpandPartitionPartialDevicePathToFull (
885 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
889 Return the bootable media handle.
890 First, check the device is connected
891 Second, check whether the device path point to a device which support SimpleFileSystemProtocol,
892 Third, detect the the default boot file in the Media, and return the removable Media handle.
894 @param DevicePath Device Path to a bootable device
896 @retval NULL The media on the DevicePath is not bootable
901 BdsLibGetBootableHandle (
902 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
907 Check whether the Device path in a boot option point to a valide bootable device,
908 And if CheckMedia is true, check the device is ready to boot now.
910 @param DevPath the Device path in a boot option
911 @param CheckMedia if true, check the device is ready to boot now.
913 @retval TRUE the Device path is valide
914 @retval FALSE the Device path is invalide .
919 BdsLibIsValidEFIBootOptDevicePath (
920 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
921 IN BOOLEAN CheckMedia
925 For a bootable Device path, return its boot type.
927 @param DevicePath The bootable device Path to check
929 @retval BDS_EFI_MEDIA_HD_BOOT If the device path contains any media deviec path node, it is media boot type
930 For the floppy node, handle it as media node
931 @retval BDS_EFI_MEDIA_CDROM_BOOT If the device path contains any media deviec path node, it is media boot type
932 For the floppy node, handle it as media node
933 @retval BDS_EFI_ACPI_FLOPPY_BOOT If the device path contains any media deviec path node, it is media boot type
934 For the floppy node, handle it as media node
935 @retval BDS_EFI_MESSAGE_ATAPI_BOOT If the device path not contains any media deviec path node, and
936 its last device path node point to a message device path node, it is
938 @retval BDS_EFI_MESSAGE_SCSI_BOOT If the device path not contains any media deviec path node, and
939 its last device path node point to a message device path node, it is
940 @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If the device path not contains any media deviec path node, and
941 its last device path node point to a message device path node, it is
942 @retval BDS_EFI_MESSAGE_MISC_BOOT If the device path not contains any media deviec path node, and
943 its last device path node point to a message device path node, it is
944 @retval BDS_LEGACY_BBS_BOOT Legacy boot type
945 @retval BDS_EFI_UNSUPPORT An EFI Removable BlockIO device path not point to a media and message devie,
950 BdsGetBootTypeFromDevicePath (
951 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
956 This routine register a function to adjust the different type memory page number
957 just before booting and save the updated info into the variable for next boot to use.
962 BdsLibSaveMemoryTypeInformation (
968 According to a file guild, check a Fv file device path is valid. If it is invalid,
969 try to return the valid device path.
970 FV address maybe changes for memory layout adjust from time to time, use this funciton
971 could promise the Fv file device path is right.
973 @param DevicePath on input, the Fv file device path need to check on
974 output, the updated valid Fv file device path
975 @param FileGuid the Fv file guild
977 @retval EFI_INVALID_PARAMETER the input DevicePath or FileGuid is invalid
979 @retval EFI_UNSUPPORTED the input DevicePath does not contain Fv file
981 @retval EFI_ALREADY_STARTED the input DevicePath has pointed to Fv file, it is
983 @retval EFI_SUCCESS has successfully updated the invalid DevicePath,
984 and return the updated device path in DevicePath
989 BdsLibUpdateFvFileDevicePath (
990 IN OUT EFI_DEVICE_PATH_PROTOCOL
** DevicePath
,
991 IN EFI_GUID
*FileGuid
996 Connect the specific Usb device which match the short form device path,
997 and whose bus is determined by Host Controller (Uhci or Ehci)
999 @param HostControllerPI Uhci (0x00) or Ehci (0x20) or Both uhci and ehci
1001 @param RemainingDevicePath a short-form device path that starts with the first
1002 element being a USB WWID or a USB Class device
1005 @retval EFI_SUCCESS The specific Usb device is connected successfully.
1006 @retval EFI_INVALID_PARAMETER Invalid HostControllerPi (not 0x00, 0x20 or 0xFF)
1007 or RemainingDevicePath is not the USB class device path.
1008 @retval EFI_NOT_FOUND The device specified by device path is not found.
1013 BdsLibConnectUsbDevByShortFormDP(
1014 IN UINT8 HostControllerPI
,
1015 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1020 // The implementation of this function is provided by Platform code.
1023 Convert Vendor device path to device name.
1025 @param Str The buffer store device name
1026 @param DevPath Pointer to vendor device path
1032 IN OUT POOL_PRINT
*Str
,
1037 Concatenates a formatted unicode string to allocated pool.
1038 The caller must free the resulting buffer.
1040 @param Str Tracks the allocated pool, size in use, and amount of pool allocated.
1041 @param fmt The format string
1042 @param ... The data will be printed.
1044 @return Allocated buffer with the formatted string printed in it.
1045 The caller must free the allocated buffer.
1046 The buffer allocation is not packed.
1052 IN OUT POOL_PRINT
*Str
,
1058 Use Console Control to turn off UGA based Simple Text Out consoles from going
1059 to the UGA device. Put up LogoFile on every UGA device that is a console
1061 @param[in] LogoFile File name of logo to display on the center of the screen.
1063 @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.
1064 @retval EFI_UNSUPPORTED Logo not found
1070 IN EFI_GUID
*LogoFile
1075 Use Console Control to turn on UGA based Simple Text Out consoles. The UGA
1076 Simple Text Out screens will now be synced up with all non UGA output devices
1078 @retval EFI_SUCCESS UGA devices are back in text mode and synced up.
1088 Use Console Control Protocol to lock the Console In Spliter virtual handle.
1089 This is the ConInHandle and ConIn handle in the EFI system table. All key
1090 presses will be ignored until the Password is typed in. The only way to
1091 disable the password is to type it in to a ConIn device.
1093 @param Password Password used to lock ConIn device.
1095 @retval EFI_SUCCESS lock the Console In Spliter virtual handle successfully.
1096 @retval EFI_UNSUPPORTED Password not found