Re: [PATCH v3 1/7] MdeModulePkg/PlatformBootManager: Add PlatformBootManagerUnableToBoot

[Laszlo Ersek <lersek@redhat.com>]

On 07/03/18 08:37, Ruiyu Ni wrote:
> The patch adds a new API PlatformBootManagerUnableToBoot()'

(1) Unbalanced single quote (').

> to PlatformBootManagerLib.
> The new API is provided by platform bds library and is called when
> no boot option could be launched.
> 
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
> Cc: Sean Brogan <sean.brogan@microsoft.com>
> Cc: Michael Turner <Michael.Turner@microsoft.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Cc: Sunny Wang <sunnywang@hpe.com>
> ---
>  MdeModulePkg/Include/Library/PlatformBootManagerLib.h | 13 +++++++++++++
>  .../PlatformBootManagerLibNull/PlatformBootManager.c  | 19 ++++++++++++++++++-
>  2 files changed, 31 insertions(+), 1 deletion(-)
> 
> diff --git a/MdeModulePkg/Include/Library/PlatformBootManagerLib.h b/MdeModulePkg/Include/Library/PlatformBootManagerLib.h
> index 65630ce2bb..6e26329043 100644
> --- a/MdeModulePkg/Include/Library/PlatformBootManagerLib.h
> +++ b/MdeModulePkg/Include/Library/PlatformBootManagerLib.h
> @@ -59,4 +59,17 @@ PlatformBootManagerWaitCallback (
>    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.
> +**/
> +VOID
> +EFIAPI
> +PlatformBootManagerUnableToBoot (
> +  VOID
> +  );
> +
>  #endif
> diff --git a/MdeModulePkg/Library/PlatformBootManagerLibNull/PlatformBootManager.c b/MdeModulePkg/Library/PlatformBootManagerLibNull/PlatformBootManager.c
> index 1390e19097..5a4455ef23 100644
> --- a/MdeModulePkg/Library/PlatformBootManagerLibNull/PlatformBootManager.c
> +++ b/MdeModulePkg/Library/PlatformBootManagerLibNull/PlatformBootManager.c
> @@ -2,7 +2,7 @@
>    This file include all platform action which can be customized
>    by IBV/OEM.
>  
> -Copyright (c) 2012 - 2015, Intel Corporation. All rights reserved.<BR>
> +Copyright (c) 2012 - 2018, Intel Corporation. All rights reserved.<BR>
>  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
> @@ -65,3 +65,20 @@ PlatformBootManagerWaitCallback (
>  {
>    return;
>  }
> +
> +/**
> +  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.
> +**/
> +VOID
> +EFIAPI
> +PlatformBootManagerUnableToBoot (
> +  VOID
> +  )
> +{
> +  return;
> +}
> +
> 

(2) Do we intentionally add such "return" statements? An empty function
body (possibly with a comment) would work as well.

I'm fine either way, I'd just like to highlight that there is a
TianoCore BZ:

https://bugzilla.tianocore.org/show_bug.cgi?id=843

about removing useless "return" statements.

I believe we should decide whether such return statements are a good
thing for edk2. If they are, we should close #843 as NOTEBUG. If they
aren't a good thing, we shouldn't add more of them.

Anyway, whatever the decision for (1) and (2) above, I don't think
reposting would be necessary just because of them; it should be OK to
update the patch before pushing.

Reviewed-by: Laszlo Ersek <lersek@redhat.com>

Thanks!
Laszlo