Re: [edk2-platforms/devel-MinPlatform][PATCH 1/5] KabylakeSiliconPkg/BaseResetSystemLib: Add a new API ResetSystem

["Gao, Zhichao" <zhichao.gao@intel.com>]

For now, no driver consumes ResetSystem. But some drivers in edk repo, such as CapsuleRuntimeDxe would use it in the further. If the platform support this driver and do not use the ResetSystemLib instance in MdeModulePkg, a link error would be caused.

Thanks,
Zhichao

> -----Original Message-----
> From: Chiu, Chasel
> Sent: Monday, April 15, 2019 5:03 PM
> To: Gao, Zhichao <zhichao.gao@intel.com>; devel@edk2.groups.io
> Cc: Kubacki, Michael A <michael.a.kubacki@intel.com>
> Subject: RE: [edk2-platforms/devel-MinPlatform][PATCH 1/5]
> KabylakeSiliconPkg/BaseResetSystemLib: Add a new API ResetSystem
> 
> 
> Please see below comments inline.
> 
> > -----Original Message-----
> > From: Gao, Zhichao
> > Sent: Monday, April 15, 2019 11:08 AM
> > To: devel@edk2.groups.io
> > Cc: Chiu, Chasel <chasel.chiu@intel.com>; Kubacki, Michael A
> > <michael.a.kubacki@intel.com>
> > Subject: [edk2-platforms/devel-MinPlatform][PATCH 1/5]
> > KabylakeSiliconPkg/BaseResetSystemLib: Add a new API ResetSystem
> >
> > REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1460
> >
> > Add a new API ResetSystem to this ResetSystemLib instance.
> > It only adds the basic functions from ResetSystemRuntimeDxe.
> > Lacking of this interface may cause link error, if some drivers use
> > this new API and link to this library instance.
> > Make the ResetPlatformSpecific's parameters same with the interface in
> > Edk2 repo.
> > Notes:
> > This library API only provide a basic function of reset. If the
> > consumers want full functions, they should use the instance in the
> > MdeModulePkg and make sure the depex driver is dispatched.
> >
> > Cc: Chasel Chiu <chasel.chiu@intel.com>
> > Cc: Michael A Kubacki <michael.a.kubacki@intel.com>
> > Signed-off-by: Zhichao Gao <zhichao.gao@intel.com>
> > ---
> >  .../BaseResetSystemLib/BaseResetSystemLib.c   | 47
> +++++++++++++++++--
> >  1 file changed, 44 insertions(+), 3 deletions(-)
> >
> > diff --git
> > a/Silicon/Intel/KabylakeSiliconPkg/Pch/Library/BaseResetSystemLib/Base
> > Reset
> > SystemLib.c
> > b/Silicon/Intel/KabylakeSiliconPkg/Pch/Library/BaseResetSystemLib/Base
> > Rese
> > tSystemLib.c
> > index ec1a69e4de..0d5c27401d 100644
> > ---
> > a/Silicon/Intel/KabylakeSiliconPkg/Pch/Library/BaseResetSystemLib/Base
> > Reset
> > SystemLib.c
> > +++ b/Silicon/Intel/KabylakeSiliconPkg/Pch/Library/BaseResetSystemLib/
> > +++ Ba
> > +++ seResetSystemLib.c
> > @@ -1,7 +1,7 @@
> >  /** @file
> >    System reset library services.
> >
> > -Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
> > +Copyright (c) 2017 - 2019, 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 that
> > accompanies this distribution.
> >  The full text of the license may be found at @@ -108,7 +108,6 @@
> > ResetShutdown (
> >  /**
> >    Calling this function causes the system to enter a power state for
> > platform specific.
> >
> > -  @param[in] ResetStatus          The status code for the reset.
> >    @param[in] DataSize             The size of ResetData in bytes.
> >    @param[in] ResetData            Optional element used to introduce a
> > platform specific reset.
> >                                    The exact type of the reset is
> > defined by the EFI_GUID that follows @@ -118,7 +117,6 @@
> ResetShutdown
> > (  VOID  EFIAPI ResetPlatformSpecific (
> > -  IN EFI_STATUS       ResetStatus,
> >    IN UINTN            DataSize,
> >    IN VOID             *ResetData OPTIONAL
> >    )
> > @@ -142,6 +140,49 @@ EnterS3WithImmediateWake (
> >    ASSERT (FALSE);
> >  }
> >
> > +/**
> > +  The ResetSystem function resets the entire platform.
> > +
> > +  @param[in] ResetType      The type of reset to perform.
> > +  @param[in] ResetStatus    The status code for the reset.
> > +  @param[in] DataSize       The size, in bytes, of ResetData.
> > +  @param[in] ResetData      For a ResetType of EfiResetCold, EfiResetWarm,
> > or EfiResetShutdown
> > +                            the data buffer starts with a
> > + Null-terminated string,
> > optionally
> > +                            followed by additional binary data. The
> > + string is a
> > description
> > +                            that the caller may use to further
> > + indicate the reason for
> > the
> > +                            system reset.
> > +**/
> > +VOID
> > +EFIAPI
> > +ResetSystem (
> > +  IN EFI_RESET_TYPE               ResetType,
> > +  IN EFI_STATUS                   ResetStatus,
> > +  IN UINTN                        DataSize,
> > +  IN VOID                         *ResetData OPTIONAL
> > +  )
> > +{
> > +  switch (ResetType) {
> > +  case EfiResetWarm:
> > +    ResetWarm ();
> > +    break;
> > +
> > +  case EfiResetCold:
> > +    ResetCold ();
> > +    break;
> > +
> > +  case EfiResetShutdown:
> > +    ResetShutdown ();
> > +    return ;
> > +
> > +  case EfiResetPlatformSpecific:
> > +    ResetPlatformSpecific (DataSize, ResetData);
> > +    return;
> > +
> > +  default:
> > +    return ;
> > +  }
> > +}
> > +
> 
> Where we consuming this new "ResetSystem ()" in Kabylake MinPlatform?
> Same question for changes in Pei and Dxe library instances.
> 
> Thanks!
> Chasel
> 
> 
> >  /**
> >    The library constructuor.
> >
> > --
> > 2.21.0.windows.1