[edk2-devel] [Patch V2] UefiPayloadPkg: Get platform specific logic from protocol for BDS driver
Zhiguang Liu
zhiguang.liu at intel.com
Wed Jun 2 14:28:15 UTC 2021
V1:
Currently, BDS driver will link a PlatformBootManagerLib, which contains platform
sepcific logic. This patch get the platform specific logic from a protocol, so that
platform logic for Boot manager can be in another binary.
V2:
Add function comments in PlatformBootManagerOverride.h
Cc: Maurice Ma <maurice.ma at intel.com>
Cc: Guo Dong <guo.dong at intel.com>
Cc: Benjamin You <benjamin.you at intel.com>
Reviewed-by: Guo Dong <guo.dong at intel.com>
Signed-off-by: Zhiguang Liu <zhiguang.liu at intel.com>
---
UefiPayloadPkg/Include/Protocol/PlatformBootManagerOverride.h | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.c | 25 ++++++++++++++++++++++++-
UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf | 3 ++-
UefiPayloadPkg/UefiPayloadPkg.dec | 4 +++-
4 files changed, 114 insertions(+), 3 deletions(-)
diff --git a/UefiPayloadPkg/Include/Protocol/PlatformBootManagerOverride.h b/UefiPayloadPkg/Include/Protocol/PlatformBootManagerOverride.h
new file mode 100644
index 0000000000..75e0ae41c5
--- /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.<BR>
+ 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 *PLD_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 *PLD_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 *PLD_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 *PLD_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 {
+ PLD_PLATFORM_BOOT_MANAGER_OVERRIDE_BEFORE_CONSOLE BeforeConsole;
+ PLD_PLATFORM_BOOT_MANAGER_OVERRIDE_AFTER_CONSOLE AfterConsole;
+ PLD_PLATFORM_BOOT_MANAGER_OVERRIDE_WAIT_CALLBACK WaitCallback;
+ PLD_PLATFORM_BOOT_MANAGER_OVERRIDE_UNABLE_TO_BOOT UnableToBoot;
+} PLD_PLATFORM_BOOT_MANAGER_OVERRIDE_PROTOCOL;
+
+extern GUID gPldPlatformBootManagerOverrideProtocolGuid;
+
+#endif
diff --git a/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.c b/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.c
index 7fa3a048b7..525977c15e 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.<BR>
+Copyright (c) 2015 - 2021, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include "PlatformBootManager.h"
#include "PlatformConsole.h"
+#include <Protocol/PlatformBootManagerOverride.h>
+
+PLD_PLATFORM_BOOT_MANAGER_OVERRIDE_PROTOCOL *mPldPlatformBootManagerOverrideInstance = 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 (&gPldPlatformBootManagerOverrideProtocolGuid, NULL, (VOID **) &mPldPlatformBootManagerOverrideInstance);
+ if (EFI_ERROR (Status)) {
+ mPldPlatformBootManagerOverrideInstance = NULL;
+ }
+ if (mPldPlatformBootManagerOverrideInstance != NULL){
+ mPldPlatformBootManagerOverrideInstance->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 (mPldPlatformBootManagerOverrideInstance != NULL){
+ mPldPlatformBootManagerOverrideInstance->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 (mPldPlatformBootManagerOverrideInstance != NULL){
+ mPldPlatformBootManagerOverrideInstance->WaitCallback (TimeoutRemain);
+ }
return;
}
@@ -260,6 +280,9 @@ PlatformBootManagerUnableToBoot (
VOID
)
{
+ if (mPldPlatformBootManagerOverrideInstance != NULL){
+ mPldPlatformBootManagerOverrideInstance->UnableToBoot();
+ }
return;
}
diff --git a/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf b/UefiPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf
index 1f5a0bcad0..14997c1183 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.<BR>
+# Copyright (c) 2012 - 2021, Intel Corporation. All rights reserved.<BR>
# SPDX-License-Identifier: BSD-2-Clause-Patent
#
##
@@ -57,6 +57,7 @@
gEfiBootLogoProtocolGuid ## CONSUMES
gEfiDxeSmmReadyToLockProtocolGuid
gEfiSmmAccess2ProtocolGuid
+ gPldPlatformBootManagerOverrideProtocolGuid
[Pcd]
gEfiMdePkgTokenSpaceGuid.PcdPlatformBootTimeOut
diff --git a/UefiPayloadPkg/UefiPayloadPkg.dec b/UefiPayloadPkg/UefiPayloadPkg.dec
index 99cb3311a6..d9c5775e76 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.<BR>
+# Copyright (c) 2014 - 2021, Intel Corporation. All rights reserved.<BR>
# SPDX-License-Identifier: BSD-2-Clause-Patent
#
##
@@ -43,6 +43,8 @@
#
gPlatformGOPPolicyGuid = { 0xec2e931b, 0x3281, 0x48a5, { 0x81, 0x07, 0xdf, 0x8a, 0x8b, 0xed, 0x3c, 0x5d } }
+ gPldPlatformBootManagerOverrideProtocolGuid = { 0xdb3fc2df, 0x7376, 0x4a8d, { 0x82, 0xab, 0x91, 0x54, 0xa1, 0x36, 0xa6, 0x5a } }
+
################################################################################
#
# PCD Declarations section - list of all PCDs Declared by this Package
--
2.30.0.windows.2
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#75968): https://edk2.groups.io/g/devel/message/75968
Mute This Topic: https://groups.io/mt/83259712/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-
More information about the edk2-devel-archive
mailing list