From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=134.134.136.20; helo=mga02.intel.com; envelope-from=ruiyu.ni@intel.com; receiver=edk2-devel@lists.01.org Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 5141D202E53DB for ; Thu, 28 Jun 2018 23:03:26 -0700 (PDT) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga007.jf.intel.com ([10.7.209.58]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 28 Jun 2018 23:03:26 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.51,285,1526367600"; d="scan'208";a="52785747" Received: from ray-dev.ccr.corp.intel.com ([10.239.9.4]) by orsmga007.jf.intel.com with ESMTP; 28 Jun 2018 23:03:25 -0700 From: Ruiyu Ni To: edk2-devel@lists.01.org Cc: Sean Brogan , Michael Turner , Laszlo Ersek , Sunny Wang Date: Fri, 29 Jun 2018 14:03:43 +0800 Message-Id: <20180629060344.105716-2-ruiyu.ni@intel.com> X-Mailer: git-send-email 2.16.1.windows.1 In-Reply-To: <20180629060344.105716-1-ruiyu.ni@intel.com> References: <20180629060344.105716-1-ruiyu.ni@intel.com> Subject: [PATCH v2 1/2] MdeModulePkg/UefiBootManagerLib: new APIs for ultimate boot failure X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.26 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 29 Jun 2018 06:03:26 -0000 REF: https://bugzilla.tianocore.org/show_bug.cgi?id=982 When no boot option could be launched including platform recovery options and options pointing to applications built into firmware volumes, a platform callback registered through EfiBootManagerRegisterUnableToBootHandler() is called. Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Ruiyu Ni Cc: Sean Brogan Cc: Michael Turner Cc: Laszlo Ersek Cc: Sunny Wang --- MdeModulePkg/Include/Library/UefiBootManagerLib.h | 48 +++++++++++++++++++++++ MdeModulePkg/Library/UefiBootManagerLib/BmBoot.c | 41 +++++++++++++++++++ 2 files changed, 89 insertions(+) diff --git a/MdeModulePkg/Include/Library/UefiBootManagerLib.h b/MdeModulePkg/Include/Library/UefiBootManagerLib.h index bfc0cb86f8..453893e030 100644 --- a/MdeModulePkg/Include/Library/UefiBootManagerLib.h +++ b/MdeModulePkg/Include/Library/UefiBootManagerLib.h @@ -800,4 +800,52 @@ EFIAPI EfiBootManagerDispatchDeferredImages ( VOID ); + +/** + The function is called when no boot option could be launched, + including platform recovery options and options pointing to applications + built into firmware volumes. + + The platform may register this function to inform the user about the above fact. + If this function returns, BDS core attempts to enter an infinite loop of pulling + up the Boot Manager Menu (if the platform includes the Boot Manager Menu). + If the Boot Manager Menu is unavailable, BDS will hang. +**/ +typedef +VOID +(EFIAPI *EFI_BOOT_MANAGER_UNABLE_TO_BOOT) ( + VOID + ); + +/** + Register the callback function when no boot option could be launched, + including platform recovery options and options pointing to applications + built into firmware volumes. + + @param Handler The callback function. +**/ +VOID +EFIAPI +EfiBootManagerRegisterUnableToBootHandler ( + EFI_BOOT_MANAGER_UNABLE_TO_BOOT Handler + ); + +/** + 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 core attempts to enter an infinite loop of pulling + up the Boot Manager Menu (if the platform includes the Boot Manager Menu). + If the Boot Manager Menu is unavailable, BDS will hang. + + @retval EFI_SUCCESS The unable-to-boot callback is called successfully. + @retval EFI_UNSUPPORTED There is no unable-to-boot callback registered. +**/ +EFI_STATUS +EFIAPI +EfiBootManagerUnableToBoot ( + VOID + ); + #endif diff --git a/MdeModulePkg/Library/UefiBootManagerLib/BmBoot.c b/MdeModulePkg/Library/UefiBootManagerLib/BmBoot.c index 6a23477eb8..e59d790122 100644 --- a/MdeModulePkg/Library/UefiBootManagerLib/BmBoot.c +++ b/MdeModulePkg/Library/UefiBootManagerLib/BmBoot.c @@ -19,6 +19,7 @@ EFI_RAM_DISK_PROTOCOL *mRamDisk = NULL; EFI_BOOT_MANAGER_REFRESH_LEGACY_BOOT_OPTION mBmRefreshLegacyBootOption = NULL; EFI_BOOT_MANAGER_LEGACY_BOOT mBmLegacyBoot = NULL; +EFI_BOOT_MANAGER_UNABLE_TO_BOOT mBmUnableToBoot = NULL; /// /// This GUID is used for an EFI Variable that stores the front device pathes @@ -2461,3 +2462,43 @@ EfiBootManagerGetBootManagerMenu ( } } +/** + Register the callback function when no boot option could be launched, + including platform recovery options and options pointing to applications + built into firmware volumes. + + @param Handler The callback function. +**/ +VOID +EFIAPI +EfiBootManagerRegisterUnableToBootHandler ( + EFI_BOOT_MANAGER_UNABLE_TO_BOOT Handler + ) +{ + mBmUnableToBoot = Handler; +} + +/** + 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 core attempts to enter an infinite loop of pulling + up the Boot Manager Menu (if the platform includes the Boot Manager Menu). + If the Boot Manager Menu is unavailable, BDS will hang. + + @retval EFI_SUCCESS The unable-to-boot callback is called successfully. + @retval EFI_UNSUPPORTED There is no unable-to-boot callback registered. +**/ +EFI_STATUS +EFIAPI +EfiBootManagerUnableToBoot ( + VOID + ) +{ + if (mBmUnableToBoot != NULL) { + mBmUnableToBoot (); + return EFI_SUCCESS; + } + return EFI_UNSUPPORTED; +} -- 2.16.1.windows.1