Re: [PATCH 24/25] MdeModulePkg/ResetUtilityLib: Add a new API ResetSystemWithSubtype

["Wu, Hao A" <hao.a.wu@intel.com>]

> -----Original Message-----
> From: Gao, Zhichao
> Sent: Monday, April 15, 2019 11:06 AM
> To: devel@edk2.groups.io
> Cc: Bret Barkelew; Wang, Jian J; Wu, Hao A; Ni, Ray; Zeng, Star; Gao, Liming;
> Sean Brogan; Michael Turner
> Subject: [PATCH 24/25] MdeModulePkg/ResetUtilityLib: Add a new API
> ResetSystemWithSubtype
> 
> From: Bret Barkelew <Bret.Barkelew@microsoft.com>
> 
> BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=1458
> 
> Add a new API ResetSystemWithSubtype's prototype declaration in
> header file. Also add the required data type header file.
> 
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Hao Wu <hao.a.wu@intel.com>
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Star Zeng <star.zeng@intel.com>
> Cc: Liming Gao <liming.gao@intel.com>
> Cc: Sean Brogan <sean.brogan@microsoft.com>
> Cc: Michael Turner <Michael.Turner@microsoft.com>
> Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
> Signed-off-by: Zhichao Gao <zhichao.gao@intel.com>
> ---
>  .../Include/Library/ResetUtilityLib.h         | 22 +++++++++++++++++++
>  1 file changed, 22 insertions(+)
> 
> diff --git a/MdeModulePkg/Include/Library/ResetUtilityLib.h
> b/MdeModulePkg/Include/Library/ResetUtilityLib.h
> index ca310cdb01..9bb4adc1ad 100644
> --- a/MdeModulePkg/Include/Library/ResetUtilityLib.h
> +++ b/MdeModulePkg/Include/Library/ResetUtilityLib.h
> @@ -10,6 +10,28 @@
>  #ifndef _RESET_UTILITY_LIB_H_
>  #define _RESET_UTILITY_LIB_H_
> 
> +#include <Uefi/UefiMultiPhase.h>
> +
> +/**
> +  This is a shorthand helper function to reset with a subtype so that
> +  the caller doesn't have to bother with a function that has half a dozen
> +  parameters.
> +
> +  This will generate a reset with status EFI_SUCCESS, a NULL string, and
> +  no custom data. The subtype will be formatted in such a way that it can be
> +  picked up by notification registrations and custom handlers.

I found that the function description is almost the same  with the
existing API 'ResetPlatformSpecificGuid' (except lacking the 3rd paragraph
starting with 'NOTE:', which I think should be applied to
'ResetSystemWithSubtype' as well).

Seems to me that 'ResetSystemWithSubtype' is more generic. Could you help
to refine one of their descriptions to reflect their difference?

Best Regards,
Hao Wu

> +
> +  @param[in]  ResetType     The default EFI_RESET_TYPE of the reset.
> +  @param[in]  ResetSubtype  GUID pointer for the reset subtype to be used.
> +
> +**/
> +VOID
> +EFIAPI
> +ResetSystemWithSubtype (
> +  IN EFI_RESET_TYPE     ResetType,
> +  IN CONST  GUID        *ResetSubtype
> +  );
> +
>  /**
>    This is a shorthand helper function to reset with a subtype so that
>    the caller doesn't have to bother with a function that has half a dozen
> --
> 2.21.0.windows.1