GenericBdsLib.h revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
Generic BDS library defines general interfaces for BDS driver including:
1) BDS boot policy interface
2) BDS boot device connect interface
3) BDS Misc interfaces for maintaining boot variable, output string.
Copyright (c) 2004 - 2009, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _GENERIC_BDS_LIB_H_
#define _GENERIC_BDS_LIB_H_
extern EFI_HANDLE mBdsImageHandle;
///
/// Constants which are variable names used to access variables
///
#define VAR_LEGACY_DEV_ORDER L"LegacyDevOrder"
///
/// Data structures and defines
///
#define FRONT_PAGE_QUESTION_ID 0x0000
#define FRONT_PAGE_DATA_WIDTH 0x01
///
/// ConnectType
///
#define CONSOLE_OUT 0x00000001
#define STD_ERROR 0x00000002
#define CONSOLE_IN 0x00000004
///
/// Load Option Attributes
///
#define LOAD_OPTION_ACTIVE 0x00000001
#define LOAD_OPTION_FORCE_RECONNECT 0x00000002
#define LOAD_OPTION_HIDDEN 0x00000008
#define LOAD_OPTION_CATEGORY 0x00001F00
#define LOAD_OPTION_CATEGORY_BOOT 0x00000000
#define LOAD_OPTION_CATEGORY_APP 0x00000100
#define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001
#define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002
///
/// Define Maximum characters that will be accepted
///
#define MAX_CHAR 480
///
/// Define maximum characters for boot option variable "BootXXXX"
///
#define BOOT_OPTION_MAX_CHAR 10
//
// This data structure is the part of BDS_CONNECT_ENTRY
//
typedef struct {
typedef struct {
//
// Bds boot related lib functions
//
/**
Boot from the UEFI spec defined "BootNext" variable.
**/
);
/**
Process the boot option according to the UEFI specification. The legacy boot option device path includes BBS_DEVICE_PATH.
@param Option The boot option to be processed
@param DevicePath The device path describing where to load the
boot image or the legacy BBS device path to boot
the legacy OS
@param ExitDataSize The size of exit data.
@param ExitData Data returned when Boot image failed.
@retval EFI_SUCCESS Boot from the input boot option succeeded.
@retval EFI_NOT_FOUND The Device Path is not found in the system
**/
);
/**
This function will enumerate all possible boot devices in the system, and
automatically create boot options for Network, Shell, Removable BlockIo,
and Non-BlockIo Simplefile devices.
BDS separates EFI boot options into six types:
1. Network - The boot option points to the SimpleNetworkProtocol device.
Bds will try to automatically create this type of boot option during enumeration.
2. Shell - The boot option points to internal flash shell.
Bds will try to automatically create this type of boot option during enumeration.
3. Removable BlockIo - The boot option points to a removable media
device, such as a USB flash drive or DVD drive.
These devices should contain a *removable* blockIo
protocol in their device handle.
Bds will try to automatically create this type boot option
when enumerate.
4. Fixed BlockIo - The boot option points to a Fixed blockIo device,
such as a hard disk.
These devices should contain a *fixed* blockIo
protocol in their device handle.
BDS will skip fixed blockIo devices, and not
automatically create boot option for them. But BDS
will help to delete those fixed blockIo boot options,
whose description rules conflict with other auto-created
boot options.
5. Non-BlockIo Simplefile - The boot option points to a device whose handle
has SimpleFileSystem Protocol, but has no blockio
protocol. These devices do not offer blockIo
protocol, but BDS still can get the
\EFI\BOOT\boot{machinename}.EFI by SimpleFileSystem
Protocol.
6. File - The boot option points to a file. These boot options are usually
created by the user, either manually or with an OS loader. BDS will not delete or modify
these boot options.
This function will enumerate all possible boot devices in the system, and
automatically create boot options for Network, Shell, Removable BlockIo,
and Non-BlockIo Simplefile devices.
It will excute once every boot.
@param BdsBootOptionList The header of the linked list that indexed all
current boot options
@retval EFI_SUCCESS Finished all the boot device enumerations and created
the boot option based on the boot device
@retval EFI_OUT_OF_RESOURCES Failed to enumerate the boot device and create the boot option list
**/
);
/**
Build the boot option with the handle parsed in
@param Handle The handle representing the device path for which to create
boot option
@param BdsBootOptionList The header of the link list which indexed all
current boot options
@param String The description of the boot option.
**/
);
/**
Build the on flash shell boot option with the handle parsed in.
@param Handle The handle which present the device path to create
on flash shell boot option
@param BdsBootOptionList The header of the link list which indexed all
current boot options
**/
);
//
// Bds misc lib functions
//
/**
Get boot mode by looking up configuration table and parsing HOB list
@param BootMode Boot mode from PEI handoff HOB.
@retval EFI_SUCCESS Successfully get boot mode
**/
);
/**
The function will go through the driver option link list, and then load and start
every driver to which the driver option device path points.
@param BdsDriverLists The header of the current driver option link list
**/
);
/**
This function processes BootOrder or DriverOrder variables, by calling
BdsLibVariableToOption () for each UINT16 in the variables.
@param BdsCommonOptionList The header of the option list base on variable
VariableName
@param VariableName EFI Variable name indicate the BootOrder or
DriverOrder
@retval EFI_SUCCESS Success create the boot option or driver option
list
@retval EFI_OUT_OF_RESOURCES Failed to get the boot option or driver option list
**/
);
/**
This function reads the EFI variable (VendorGuid/Name) and returns a dynamically allocated
buffer and the size of the buffer. If failure, return NULL.
@param Name String part of EFI variable name
@param VendorGuid GUID part of EFI variable name
@param VariableSize Returns the size of the EFI variable that was read
@return Dynamically allocated memory that contains a copy of the EFI variable
Caller is responsible freeing the buffer.
@retval NULL Variable was not read
**/
VOID *
);
/**
This function prints a series of strings.
@param ConOut Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
@param ... A variable argument list containing series of
strings, the last string must be NULL.
@retval EFI_SUCCESS Success print out the string using ConOut.
@retval EFI_STATUS Return the status of the ConOut->OutputString ().
**/
...
);
/**
Build the boot#### or driver#### option from the VariableName. The
build boot#### or driver#### will also be linked to BdsCommonOptionList.
@param BdsCommonOptionList The header of the boot#### or driver#### option
link list
@param VariableName EFI Variable name, indicates if it is boot#### or
driver####
@retval BDS_COMMON_OPTION The option that was created
@retval NULL Failed to get the new option
**/
);
/**
This function registers the new boot#### or driver#### option based on
the VariableName. The new registered boot#### or driver#### will be linked
to BdsOptionList and also update to the VariableName. After the boot#### or
driver#### updated, the BootOrder or DriverOrder will also be updated.
@param BdsOptionList The header of the boot#### or driver#### link list
@param DevicePath The device path which the boot#### or driver####
option present
@param String The description of the boot#### or driver####
@param VariableName Indicate if the boot#### or driver#### option
@retval EFI_SUCCESS The boot#### or driver#### have been success
registered
@retval EFI_STATUS Return the status of gRT->SetVariable ().
**/
);
//
// Bds connect and disconnect driver lib functions
//
/**
This function connects all system drivers with the corresponding controllers.
**/
);
/**
This function connects all system drivers to controllers.
**/
);
/**
This function creates all handles associated with the given device
path node. If the handle associated with one device path node can not
be created, then it tries to execute the dispatch to load the missing drivers.
@param DevicePathToConnect The device path to be connected. Can be
a multi-instance device path
@retval EFI_SUCCESS All handles associates with every device path node
were created
@retval EFI_OUT_OF_RESOURCES Not enough resources to create new handles
@retval EFI_NOT_FOUND At least one handle could not be created
**/
);
/**
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().
@retval EFI_SUCCESS All handles and child handles have been connected @retval EFI_STATUS Return the status of gBS->LocateHandleBuffer().
**/
);
/**
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().
@retval EFI_SUCCESS All handles have been disconnected
@retval EFI_STATUS Error status returned by of gBS->LocateHandleBuffer().
**/
);
//
// Bds console related lib functions
//
/**
This function will search every simpletxt device in the current system,
and make every simpletxt device a potential console device.
**/
);
/**
This function will connect console device based on the console
device variable ConIn, ConOut and ErrOut.
@retval EFI_SUCCESS At least one of the ConIn and ConOut devices have
been connected.
@retval EFI_STATUS Return the status of BdsLibConnectConsoleVariable ().
**/
);
/**
This function updates the console variable based on ConVarName. It can
add or remove one specific console device path from the variable
@param ConVarName Console-related variable name: ConIn, ConOut,
ErrOut.
@param CustomizedConDevicePath The console device path to be added to
the console variable ConVarName. Can not be multi-instance.
@param ExclusiveDevicePath The console device path to be removed
from the console variable ConVarName. Can not be multi-instance.
@retval EFI_UNSUPPORTED The added device path is the same as a removed one.
@retval EFI_SUCCESS Successfully added or removed the device path from the
console variable.
**/
);
/**
Connect the console device base on the variable ConVarName. If
ConVarName is a multi-instance device path, and at least one
instance connects successfully, then this function
will return success.
@param ConVarName Console related variable name, ConIn, ConOut,
ErrOut.
@retval EFI_NOT_FOUND No console devices were connected successfully
@retval EFI_SUCCESS Connected at least one instance of the console
device path based on the variable ConVarName.
**/
);
//
// Bds device path related lib functions
//
/**
Delete the instance in Multi that overlaps with Single
@param Multi A pointer to a multi-instance device path data
structure.
@param Single A pointer to a single-instance device path data
structure.
@return This function removes the device path instances in Multi that overlap
Single, and returns the resulting device path. If there is no
remaining device path as a result, this function will return NULL.
**/
);
/**
Function compares a device path data structure to that of all the nodes of a
second device path instance.
@param Multi A pointer to a multi-instance device path data
structure.
@param Single A pointer to a single-instance device path data
structure.
@retval TRUE If the Single device path is contained within Multi device path.
@retval FALSE The Single device path is not contained within Multi device path.
**/
);
/**
This function converts an input device structure to a Unicode string.
@param DevPath A pointer to the device path structure.
@return A new allocated Unicode string that represents the device path.
**/
CHAR16 *
);
//
// Internal definitions
//
typedef struct {
} POOL_PRINT;
typedef struct {
typedef struct {
typedef struct {
//
// Notes: EFI 64 shadow all option rom
//
#if defined (MDE_CPU_IPF)
#define EFI64_SHADOW_ALL_LEGACY_ROM() ShadowAllOptionRom ();
#else
#define EFI64_SHADOW_ALL_LEGACY_ROM()
#endif
/**
Shadow all Legacy OptionRom.
**/
);
//
// BBS support macros and functions
//
#if defined(MDE_CPU_IA32) || defined(MDE_CPU_X64)
#define REFRESH_LEGACY_BOOT_OPTIONS \
#else
#define REFRESH_LEGACY_BOOT_OPTIONS
#endif
/**
Delete all the invalid legacy boot options.
@retval EFI_SUCCESS All invalid legacy boot options are deleted.
@retval EFI_OUT_OF_RESOURCES Fail to allocate necessary memory.
@retval EFI_NOT_FOUND Fail to retrieve variable of boot order.
**/
);
/**
Add the legacy boot options from BBS table if they do not exist.
@retval EFI_SUCCESS The boot options are added successfully
or they are already in boot options.
@retval EFI_NOT_FOUND No legacy boot options is found.
@retval EFI_OUT_OF_RESOURCE No enough memory.
@return Other value LegacyBoot options are not added.
**/
);
/**
Add the legacy boot devices from BBS table into
the legacy device boot order.
@retval EFI_SUCCESS The boot devices are added successfully.
@retval EFI_NOT_FOUND The legacy boot devices are not found.
@retval EFI_OUT_OF_RESOURCES Memory or storage is not enough.
@retval EFI_DEVICE_ERROR Fail to add the legacy device boot order into EFI variable
because of hardware error.
**/
);
/**
Refresh the boot priority for BBS entries based on boot option entry and boot order.
@param Entry The boot option is to be checked for refresh BBS table.
@retval EFI_SUCCESS The boot priority for BBS entries is refreshed successfully.
@retval EFI_NOT_FOUND BBS entries can't be found.
@retval EFI_OUT_OF_RESOURCES Failed to get the legacy device boot order.
**/
);
/**
Delete the Boot Option from EFI Variable. The Boot Order Array
is also updated.
@param OptionNumber The number of Boot option want to be deleted.
@param BootOrder The Boot Order array.
@param BootOrderSize The size of the Boot Order Array.
@retval EFI_SUCCESS The Boot Option Variable was found and removed
@retval EFI_UNSUPPORTED The Boot Option Variable store was inaccessible
@retval EFI_NOT_FOUND The Boot Option Variable was not found
**/
);
//
//The interface functions related to the Setup Browser Reset Reminder feature
//
/**
Enable the setup browser reset reminder feature.
This routine is used in platform tip. If the platform policy needs the feature, use the routine to enable it.
**/
);
/**
Disable the setup browser reset reminder feature.
This routine is used in platform tip. If the platform policy does not want the feature, use the routine to disable it.
**/
);
/**
Record the info that a reset is required.
A module boolean variable is used to record whether a reset is required.
**/
);
/**
Record the info that no reset is required.
A module boolean variable is used to record whether a reset is required.
**/
);
/**
Check whether platform policy enables the reset reminder feature. The default is enabled.
**/
);
/**
Check if the user changed any option setting that needs a system reset to be effective.
**/
);
/**
Check whether a reset is needed, and finish the reset reminder feature.
If a reset is needed, pop up a menu to notice user, and finish the feature
according to the user selection.
**/
);
///
/// Define the boot type which to classify the boot option type
/// Different boot option type could have different boot behavior
/// Use their device path node (Type + SubType) as type value
/// The boot type here can be added according to requirement
///
///
/// ACPI boot type. For ACPI device, cannot use sub-type to distinguish device, so hardcode their value
///
#define BDS_EFI_ACPI_FLOPPY_BOOT 0x0201
///
/// Message boot type
/// If a device path of boot option only point to a message node, the boot option is message boot type
///
#define BDS_EFI_MESSAGE_MISC_BOOT 0x03FF
///
/// Media boot type
/// If a device path of boot option contain a media node, the boot option is media boot type
///
///
/// BBS boot type
/// If a device path of boot option contain a BBS node, the boot option is BBS boot type
///
#define BDS_EFI_UNSUPPORT 0xFFFF
/**
Check whether an instance in BlockIoDevicePath has the same partition node as the HardDriveDevicePath device path
@param BlockIoDevicePath Multi device path instances to check
@param HardDriveDevicePath A device path starting with a hard drive media
device path.
@retval TRUE There is a matched device path instance.
@retval FALSE There is no matched device path instance.
**/
);
/**
Expand a device path that starts with a hard drive media device path node to be a
full device path that includes the full hardware path to the device. This function enables the device to boot.
To avoid requiring a connect on every boot, the front match is saved in a variable (the part point
to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ).
All successful history device paths
that point to the front part of the partition node will be saved.
@param HardDriveDevicePath EFI Device Path to boot, if it starts with a hard
drive media device path.
@return A Pointer to the full device path or NULL if a valid Hard Drive device path
cannot be found.
**/
);
/**
Return the bootable media handle.
First, check whether the device is connected.
Second, check whether the device path points to a device that supports SimpleFileSystemProtocol.
Third, detect the default boot file in the Media, and return the removable Media handle.
@param DevicePath Device Path to a bootable device
@return The bootable media handle. If the media on the DevicePath is not bootable, NULL will return.
**/
);
/**
Checks whether the Device path in a boot option points to a valid bootable device, and if the device
is ready to boot now.
@param DevPath the Device path in a boot option
@param CheckMedia if true, check whether the device is ready to boot now.
@retval TRUE the Device path is valid
@retval FALSE the Device path is invalid
**/
);
/**
Checks whether the Device path in a boot option points to a valid bootable device, and if the device
is ready to boot now.
If Description is not NULL and the device path points to a fixed BlockIo
device, this function checks whether the description conflicts with other auto-created
boot options.
@param DevPath the Device path in a boot option
@param CheckMedia if true, checks if the device is ready to boot now.
@param Description the description of a boot option
@retval TRUE the Device path is valid
@retval FALSE the Device path is invalid
**/
);
/**
For a bootable Device path, return its boot type.
@param DevicePath The bootable device Path to check
@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,
**/
);
/**
This routine registers a function to adjust the different types of memory page numbers
just before booting, and saves the updated info into the variable for the next boot to use.
**/
);
/**
This function checks if a Fv file device path is valid, according to a file GUID. If it is invalid,
it tries to return the valid device path.
FV address maybe changes for memory layout adjust from time to time, use this function
could promise the Fv file device path is right.
@param DevicePath on input, the Fv file device path to check. On
output, the updated valid Fv file device path
@param FileGuid the Fv file GUID
@retval EFI_INVALID_PARAMETER the input DevicePath or FileGuid is invalid
@retval EFI_UNSUPPORTED the input DevicePath does not contain an Fv file
GUID at all
@retval EFI_ALREADY_STARTED the input DevicePath has pointed to the Fv file and is
valid
@retval EFI_SUCCESS successfully updated the invalid DevicePath
and returned the updated device path in DevicePath
**/
);
/**
Connect the specific USB device that matches the RemainingDevicePath,
and whose bus is determined by Host Controller (Uhci or Ehci)
@param HostControllerPI Uhci (0x00) or Ehci (0x20) or Both uhci and ehci
(0xFF)
@param RemainingDevicePath a short-form device path that starts with the first
element being a USB WWID or a USB Class device
path
@retval EFI_SUCCESS The specific Usb device is connected successfully.
@retval EFI_INVALID_PARAMETER Invalid HostControllerPi (not 0x00, 0x20 or 0xFF)
or RemainingDevicePath is not the USB class device path.
@retval EFI_NOT_FOUND The device specified by device path is not found.
**/
);
//
// The implementation of this function is provided by Platform code.
//
/**
Convert Vendor device path to a device name.
@param Str The buffer storing device name
@param DevPath Pointer to vendor device path
**/
);
/**
Concatenates a formatted unicode string to allocated pool.
The caller must free the resulting buffer.
@param Str Tracks the allocated pool, size in use, and amount of pool allocated.
@param Fmt The format string
@param ... The data will be printed.
@return Allocated buffer with the formatted string printed in it.
The caller must free the allocated buffer.
The buffer allocation is not packed.
**/
CHAR16 *
CatPrint (
...
);
/**
Use SystemTable ConOut to stop video based Simple Text Out consoles from going
to the video device. Put up LogoFile on every video device that is a console.
@param[in] LogoFile File name of logo to display on the center of the screen.
@retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.
@retval EFI_UNSUPPORTED Logo not found
**/
);
/**
Use SystemTable ConOut to turn on video based Simple Text Out consoles. The
Simple Text Out screens will now be synced up with all non video output devices
@retval EFI_SUCCESS UGA devices are back in text mode and synced up.
**/
);
#endif