diff options
author | Ruiyu Ni <ruiyu.ni@intel.com> | 2015-06-02 09:03:38 +0000 |
---|---|---|
committer | niruiyu <niruiyu@Edk2> | 2015-06-02 09:03:38 +0000 |
commit | f41c71d26a3ddeaf0f5e1442ab5f5eb87d951892 (patch) | |
tree | 894eb30093f3a8f437de4c0266349dcc66e206f4 /MdeModulePkg/Include | |
parent | 4e5220964b7108bbc9f731b326680e865aa63560 (diff) | |
download | edk2-platforms-f41c71d26a3ddeaf0f5e1442ab5f5eb87d951892.tar.xz |
MdeModulePkg: Provide EfiBootManagerRegisterBootDescriptionHandler
This API can be used for platform to customize the boot description other than using core provided boot description.
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Reviewed-by: Eric Dong <eric.dong@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@17547 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Include')
-rw-r--r-- | MdeModulePkg/Include/Library/UefiBootManagerLib.h | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/MdeModulePkg/Include/Library/UefiBootManagerLib.h b/MdeModulePkg/Include/Library/UefiBootManagerLib.h index 032c437c01..5538d90738 100644 --- a/MdeModulePkg/Include/Library/UefiBootManagerLib.h +++ b/MdeModulePkg/Include/Library/UefiBootManagerLib.h @@ -440,6 +440,36 @@ EfiBootManagerRegisterLegacyBootSupport ( EFI_BOOT_MANAGER_LEGACY_BOOT LegacyBoot
);
+/**
+ Return the platform provided boot option description for the controller.
+
+ @param Handle Controller handle.
+ @param DefaultDescription Default boot description provided by core.
+
+ @return The callee allocated description string
+ or NULL if the handler wants to use DefaultDescription.
+**/
+typedef
+CHAR16 *
+(EFIAPI *EFI_BOOT_MANAGER_BOOT_DESCRIPTION_HANDLER) (
+ IN EFI_HANDLE Handle,
+ IN CONST CHAR16 *DefaultDescription
+ );
+
+/**
+ Register the platform provided boot description handler.
+
+ @param Handler The platform provided boot description handler
+
+ @retval EFI_SUCCESS The handler was registered successfully.
+ @retval EFI_ALREADY_STARTED The handler was already registered.
+ @retval EFI_OUT_OF_RESOURCES There is not enough resource to perform the registration.
+**/
+EFI_STATUS
+EFIAPI
+EfiBootManagerRegisterBootDescriptionHandler (
+ IN EFI_BOOT_MANAGER_BOOT_DESCRIPTION_HANDLER Handler
+ );
//
// Boot Manager connect and disconnect library functions
|