From d58016b768cf82cebbf579e1e5658ef89641d944 Mon Sep 17 00:00:00 2001 From: Zhiguang Liu Date: Thu, 10 Jun 2021 09:49:17 +0800 Subject: UefiPayloadPkg: Get platform specific logic via protocol for BDS Currently, BDS driver will link a PlatformBootManagerLib, which contains platform specific logic. This patch get the platform specific logic from a protocol, so that platform logic for Boot manager can be in another binary. Cc: Maurice Ma Cc: Guo Dong Cc: Benjamin You Reviewed-by: Guo Dong Signed-off-by: Zhiguang Liu --- .../Include/Protocol/PlatformBootManagerOverride.h | 85 ++++++++++++++++++++++ .../PlatformBootManagerLib/PlatformBootManager.c | 25 ++++++- .../PlatformBootManagerLib.inf | 3 +- UefiPayloadPkg/UefiPayloadPkg.dec | 4 +- 4 files changed, 114 insertions(+), 3 deletions(-) create mode 100644 UefiPayloadPkg/Include/Protocol/PlatformBootManagerOverride.h diff --git a/UefiPayloadPkg/Include/Protocol/PlatformBootManagerOverride.h b/UefiPayloadPkg/Include/Protocol/PlatformBootManagerOverride.h new file mode 100644 index 0000000000..59544e417c --- /dev/null +++ b/UefiPayloadPkg/Include/Protocol/PlatformBootManagerOverride.h @@ -0,0 +1,85 @@ +/** @file + This file defines the Univeral Payload Platform BootManager Protocol. + + Copyright (c) 2021, Intel Corporation. All rights reserved.
+ SPDX-License-Identifier: BSD-2-Clause-Patent +**/ + +#ifndef __PLATFORM_BOOT_MANAGER_OVERRIDE_H__ +#define __PLATFORM_BOOT_MANAGER_OVERRIDE_H__ + + +/** + Do the platform specific action before the console is connected. + + Such as: + Update console variable; + Register new Driver#### or Boot####; + Signal ReadyToLock event. + + This function will override the default behavior in PlatformBootManagerLib +**/ +typedef +VOID +(EFIAPI *UNIVERSAL_PAYLOAD_PLATFORM_BOOT_MANAGER_OVERRIDE_BEFORE_CONSOLE) ( + VOID + ); + +/** + Do the platform specific action after the console is connected. + + Such as: + Dynamically switch output mode; + Signal console ready platform customized event; + Run diagnostics like memory testing; + Connect certain devices; + Dispatch aditional option roms. + + This function will override the default behavior in PlatformBootManagerLib +**/ +typedef +VOID +(EFIAPI *UNIVERSAL_PAYLOAD_PLATFORM_BOOT_MANAGER_OVERRIDE_AFTER_CONSOLE) ( + VOID + ); + +/** + This function is called each second during the boot manager waits the timeout. + This function will override the default behavior in PlatformBootManagerLib + + @param TimeoutRemain The remaining timeout. +**/ +typedef +VOID +(EFIAPI *UNIVERSAL_PAYLOAD_PLATFORM_BOOT_MANAGER_OVERRIDE_WAIT_CALLBACK) ( + UINT16 TimeoutRemain + ); + +/** + The function is called when no boot option could be launched, + including platform recovery options and options pointing to applications + built into firmware volumes. + + If this function returns, BDS attempts to enter an infinite loop. + This function will override the default behavior in PlatformBootManagerLib +**/ +typedef +VOID +(EFIAPI *UNIVERSAL_PAYLOAD_PLATFORM_BOOT_MANAGER_OVERRIDE_UNABLE_TO_BOOT) ( + VOID + ); + +/// +/// Provides an interface to override the default behavior in PlatformBootManagerLib, +/// so platform can provide its own platform specific logic through this protocol +/// +typedef struct { + UNIVERSAL_PAYLOAD_PLATFORM_BOOT_MANAGER_OVERRIDE_BEFORE_CONSOLE BeforeConsole; + UNIVERSAL_PAYLOAD_PLATFORM_BOOT_MANAGER_OVERRIDE_AFTER_CONSOLE AfterConsole; + UNIVERSAL_PAYLOAD_PLATFORM_BOOT_MANAGER_OVERRIDE_WAIT_CALLBACK WaitCallback; + UNIVERSAL_PAYLOAD_PLATFORM_BOOT_MANAGER_OVERRIDE_UNABLE_TO_BOOT UnableToBoot; +} UNIVERSAL_PAYLOAD_PLATFORM_BOOT_MANAGER_OVERRIDE_PROTOCOL; + +extern GUID gUniversalPayloadPlatformBootManagerOverrideProtocolGuid; + +#endif diff --git a/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.c b/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.c index 7fa3a048b7..fce48d26a1 100644 --- a/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.c +++ b/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.c @@ -2,13 +2,16 @@ This file include all platform action which can be customized by IBV/OEM. -Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
+Copyright (c) 2015 - 2021, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent **/ #include "PlatformBootManager.h" #include "PlatformConsole.h" +#include + +UNIVERSAL_PAYLOAD_PLATFORM_BOOT_MANAGER_OVERRIDE_PROTOCOL *mUniversalPayloadPlatformBootManagerOverrideInstance = NULL; VOID InstallReadyToLock ( @@ -156,6 +159,16 @@ PlatformBootManagerBeforeConsole ( EFI_INPUT_KEY F2; EFI_INPUT_KEY Down; EFI_BOOT_MANAGER_LOAD_OPTION BootOption; + EFI_STATUS Status; + + Status = gBS->LocateProtocol (&gUniversalPayloadPlatformBootManagerOverrideProtocolGuid, NULL, (VOID **) &mUniversalPayloadPlatformBootManagerOverrideInstance); + if (EFI_ERROR (Status)) { + mUniversalPayloadPlatformBootManagerOverrideInstance = NULL; + } + if (mUniversalPayloadPlatformBootManagerOverrideInstance != NULL){ + mUniversalPayloadPlatformBootManagerOverrideInstance->BeforeConsole(); + return; + } // // Register ENTER as CONTINUE key @@ -213,6 +226,10 @@ PlatformBootManagerAfterConsole ( EFI_GRAPHICS_OUTPUT_BLT_PIXEL Black; EFI_GRAPHICS_OUTPUT_BLT_PIXEL White; + if (mUniversalPayloadPlatformBootManagerOverrideInstance != NULL){ + mUniversalPayloadPlatformBootManagerOverrideInstance->AfterConsole(); + return; + } Black.Blue = Black.Green = Black.Red = Black.Reserved = 0; White.Blue = White.Green = White.Red = White.Reserved = 0xFF; @@ -244,6 +261,9 @@ PlatformBootManagerWaitCallback ( UINT16 TimeoutRemain ) { + if (mUniversalPayloadPlatformBootManagerOverrideInstance != NULL){ + mUniversalPayloadPlatformBootManagerOverrideInstance->WaitCallback (TimeoutRemain); + } return; } @@ -260,6 +280,9 @@ PlatformBootManagerUnableToBoot ( VOID ) { + if (mUniversalPayloadPlatformBootManagerOverrideInstance != NULL){ + mUniversalPayloadPlatformBootManagerOverrideInstance->UnableToBoot(); + } return; } diff --git a/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf b/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf index 1f5a0bcad0..600a535282 100644 --- a/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf +++ b/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf @@ -1,7 +1,7 @@ ## @file # Include all platform action which can be customized by IBV/OEM. # -# Copyright (c) 2012 - 2016, Intel Corporation. All rights reserved.
+# Copyright (c) 2012 - 2021, Intel Corporation. All rights reserved.
# SPDX-License-Identifier: BSD-2-Clause-Patent # ## @@ -57,6 +57,7 @@ gEfiBootLogoProtocolGuid ## CONSUMES gEfiDxeSmmReadyToLockProtocolGuid gEfiSmmAccess2ProtocolGuid + gUniversalPayloadPlatformBootManagerOverrideProtocolGuid [Pcd] gEfiMdePkgTokenSpaceGuid.PcdPlatformBootTimeOut diff --git a/UefiPayloadPkg/UefiPayloadPkg.dec b/UefiPayloadPkg/UefiPayloadPkg.dec index 99cb3311a6..105e1f5a1c 100644 --- a/UefiPayloadPkg/UefiPayloadPkg.dec +++ b/UefiPayloadPkg/UefiPayloadPkg.dec @@ -3,7 +3,7 @@ # # Provides drivers and definitions to create uefi payload for bootloaders. # -# Copyright (c) 2014 - 2020, Intel Corporation. All rights reserved.
+# Copyright (c) 2014 - 2021, Intel Corporation. All rights reserved.
# SPDX-License-Identifier: BSD-2-Clause-Patent # ## @@ -43,6 +43,8 @@ # gPlatformGOPPolicyGuid = { 0xec2e931b, 0x3281, 0x48a5, { 0x81, 0x07, 0xdf, 0x8a, 0x8b, 0xed, 0x3c, 0x5d } } + gUniversalPayloadPlatformBootManagerOverrideProtocolGuid = { 0xdb3fc2df, 0x7376, 0x4a8d, { 0x82, 0xab, 0x91, 0x54, 0xa1, 0x36, 0xa6, 0x5a } } + ################################################################################ # # PCD Declarations section - list of all PCDs Declared by this Package -- cgit v1.2.3