Re: [edk2-devel] [PATCH v2 06/16] MdeModulePkg: SmmReportStatusCodeLib: ReportStatusCodeLib in StandaloneMm

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

> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Kun Qin
> Sent: Wednesday, January 6, 2021 2:59 AM
> To: devel@edk2.groups.io
> Cc: Wang, Jian J <jian.j.wang@intel.com>; Wu, Hao A <hao.a.wu@intel.com>;
> Bi, Dandan <dandan.bi@intel.com>; Liming Gao
> <gaoliming@byosoft.com.cn>; Yao, Jiewen <jiewen.yao@intel.com>
> Subject: [edk2-devel] [PATCH v2 06/16] MdeModulePkg:
> SmmReportStatusCodeLib: ReportStatusCodeLib in StandaloneMm
> 
> This change added support of StandaloneMm for ReportStatusCodeLib. It
> adds a new instance of ReportStatusCodeLib for MM_STANDALONE type,
> and abstracts the references of gMmst and gSmst functionalities into
> separate files in order to link in proper Service Table for SMM core/drivers.


Reviewed-by: Hao A Wu <hao.a.wu@intel.com>

Best Regards,
Hao Wu


> 
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Hao A Wu <hao.a.wu@intel.com>
> Cc: Dandan Bi <dandan.bi@intel.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Jiewen Yao <jiewen.yao@intel.com>
> 
> Signed-off-by: Kun Qin <kun.q@outlook.com>
> ---
> 
> Notes:
>     v2:
>     - Removed "EFIAPI" for internal functions.
>     - Minor new file description update.
> 
>  MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLib.c
> | 16 +++++----
> 
> MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLibSta
> ndaloneMm.c                                   | 38 ++++++++++++++++++++
> 
> MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLibTra
> ditional.c                                    | 38 ++++++++++++++++++++
>  MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLib.h
> | 36 +++++++++++++++++++
> 
> MdeModulePkg/Library/SmmReportStatusCodeLib/SmmReportStatusCodeLi
> b.inf                                          |  4 ++-
> 
> MdeModulePkg/Library/SmmReportStatusCodeLib/{SmmReportStatusCode
> Lib.inf => StandaloneMmReportStatusCodeLib.inf} | 22 ++++++------
>  MdeModulePkg/MdeModulePkg.dsc
> |  1 +
>  7 files changed, 137 insertions(+), 18 deletions(-)
> 
> diff --git
> a/MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLib.c
> b/MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLib.
> c
> index 3a1772538cdf..fb1769db9223 100644
> ---
> a/MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLib.c
> +++
> b/MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLib.
> c
> @@ -1,5 +1,5 @@
>  /** @file
> -  Report Status Code Library for SMM Phase.
> +  Report Status Code Library for MM Phase.
> 
>    Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
>    SPDX-License-Identifier: BSD-2-Clause-Patent @@ -8,7 +8,7 @@
> 
>  #include <Library/ReportStatusCodeLib.h>  #include <Library/DebugLib.h> -
> #include <Library/SmmServicesTableLib.h>
> +#include <Library/MmServicesTableLib.h>
>  #include <Library/BaseLib.h>
>  #include <Library/BaseMemoryLib.h>
>  #include <Library/PcdLib.h>
> @@ -16,10 +16,12 @@
> 
>  #include <Guid/StatusCodeDataTypeId.h>
>  #include <Guid/StatusCodeDataTypeDebug.h> -#include
> <Protocol/SmmStatusCode.h>
> +#include <Protocol/MmStatusCode.h>
> 
> -EFI_SMM_REPORT_STATUS_CODE     mReportStatusCode = NULL;
> -EFI_SMM_STATUS_CODE_PROTOCOL   *mStatusCodeProtocol = NULL;
> +#include "ReportStatusCodeLib.h"
> +
> +EFI_MM_REPORT_STATUS_CODE     mReportStatusCode = NULL;
> +EFI_MM_STATUS_CODE_PROTOCOL   *mStatusCodeProtocol = NULL;
> 
> 
>  /**
> @@ -29,14 +31,14 @@ EFI_SMM_STATUS_CODE_PROTOCOL
> *mStatusCodeProtocol = NULL;
>              NULL is returned if no status code service is available.
> 
>  **/
> -EFI_SMM_REPORT_STATUS_CODE
> +EFI_MM_REPORT_STATUS_CODE
>  InternalGetReportStatusCode (
>    VOID
>    )
>  {
>    EFI_STATUS                    Status;
> 
> -  Status = gSmst->SmmLocateProtocol (&gEfiSmmStatusCodeProtocolGuid,
> NULL, (VOID**)&mStatusCodeProtocol);
> +  Status = InternalLocateProtocol (&gEfiMmStatusCodeProtocolGuid, NULL,
> + (VOID**)&mStatusCodeProtocol);
>    if (!EFI_ERROR (Status) && mStatusCodeProtocol != NULL) {
>      return mStatusCodeProtocol->ReportStatusCode;
>    }
> diff --git
> a/MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLibS
> tandaloneMm.c
> b/MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLibS
> tandaloneMm.c
> new file mode 100644
> index 000000000000..a4c428dc88a9
> --- /dev/null
> +++
> b/MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLibS
> ta
> +++ ndaloneMm.c
> @@ -0,0 +1,38 @@
> +/** @file
> +  Abstraction layer for MM service table used by MM ReportStatusCodeLib.
> +
> +  Copyright (c) Microsoft Corporation.
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +**/
> +
> +#include <PiMm.h>
> +
> +#include <Library/MmServicesTableLib.h>
> +
> +/**
> +  Returns the first protocol instance that matches the given protocol.
> +
> +  @param[in]  Protocol          Provides the protocol to search for.
> +  @param[in]  Registration      Optional registration key returned from
> +                                RegisterProtocolNotify().
> +  @param[out]  Interface        On return, a pointer to the first interface that
> matches Protocol and
> +                                Registration.
> +
> +  @retval EFI_SUCCESS           A protocol instance matching Protocol was
> found and returned in
> +                                Interface.
> +  @retval EFI_NOT_FOUND         No protocol instances were found that
> match Protocol and
> +                                Registration.
> +  @retval EFI_INVALID_PARAMETER Interface is NULL.
> +                                Protocol is NULL.
> +
> +**/
> +EFI_STATUS
> +InternalLocateProtocol (
> +  IN  EFI_GUID  *Protocol,
> +  IN  VOID      *Registration, OPTIONAL
> +  OUT VOID      **Interface
> +  )
> +{
> +  return gMmst->MmLocateProtocol (Protocol, Registration, Interface); }
> diff --git
> a/MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLibT
> raditional.c
> b/MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLibT
> raditional.c
> new file mode 100644
> index 000000000000..603e222f5508
> --- /dev/null
> +++
> b/MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLibT
> ra
> +++ ditional.c
> @@ -0,0 +1,38 @@
> +/** @file
> +  Abstraction layer for SMM service table used by SMM
> ReportStatusCodeLib.
> +
> +  Copyright (c) Microsoft Corporation.
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +**/
> +
> +#include <PiMm.h>
> +
> +#include <Library/SmmServicesTableLib.h>
> +
> +/**
> +  Returns the first protocol instance that matches the given protocol.
> +
> +  @param[in]  Protocol          Provides the protocol to search for.
> +  @param[in]  Registration      Optional registration key returned from
> +                                RegisterProtocolNotify().
> +  @param[out]  Interface        On return, a pointer to the first interface that
> matches Protocol and
> +                                Registration.
> +
> +  @retval EFI_SUCCESS           A protocol instance matching Protocol was
> found and returned in
> +                                Interface.
> +  @retval EFI_NOT_FOUND         No protocol instances were found that
> match Protocol and
> +                                Registration.
> +  @retval EFI_INVALID_PARAMETER Interface is NULL.
> +                                Protocol is NULL.
> +
> +**/
> +EFI_STATUS
> +InternalLocateProtocol (
> +  IN  EFI_GUID  *Protocol,
> +  IN  VOID      *Registration, OPTIONAL
> +  OUT VOID      **Interface
> +  )
> +{
> +  return gSmst->SmmLocateProtocol (Protocol, Registration, Interface);
> +}
> diff --git
> a/MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLib.
> h
> b/MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLib.
> h
> new file mode 100644
> index 000000000000..2820e40dde19
> --- /dev/null
> +++
> b/MdeModulePkg/Library/SmmReportStatusCodeLib/ReportStatusCodeLib.
> h
> @@ -0,0 +1,36 @@
> +/** @file
> +  Report Status Code Library for MM Phase.
> +
> +  Copyright (c) 2009 - 2018, Intel Corporation. All rights
> + reserved.<BR>
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +**/
> +
> +#ifndef _MM_RSC_LIB_H_
> +#define _MM_RSC_LIB_H_
> +
> +/**
> +  Returns the first protocol instance that matches the given protocol.
> +
> +  @param[in]  Protocol          Provides the protocol to search for.
> +  @param[in]  Registration      Optional registration key returned from
> +                                RegisterProtocolNotify().
> +  @param[out]  Interface        On return, a pointer to the first interface that
> matches Protocol and
> +                                Registration.
> +
> +  @retval EFI_SUCCESS           A protocol instance matching Protocol was
> found and returned in
> +                                Interface.
> +  @retval EFI_NOT_FOUND         No protocol instances were found that
> match Protocol and
> +                                Registration.
> +  @retval EFI_INVALID_PARAMETER Interface is NULL.
> +                                Protocol is NULL.
> +
> +**/
> +EFI_STATUS
> +InternalLocateProtocol (
> +  IN  EFI_GUID  *Protocol,
> +  IN  VOID      *Registration, OPTIONAL
> +  OUT VOID      **Interface
> +  );
> +
> +#endif // _MM_RSC_LIB_H_
> diff --git
> a/MdeModulePkg/Library/SmmReportStatusCodeLib/SmmReportStatusCod
> eLib.inf
> b/MdeModulePkg/Library/SmmReportStatusCodeLib/SmmReportStatusCod
> eLib.inf
> index 72496bfababd..02dce09a199d 100644
> ---
> a/MdeModulePkg/Library/SmmReportStatusCodeLib/SmmReportStatusCod
> eLib.inf
> +++
> b/MdeModulePkg/Library/SmmReportStatusCodeLib/SmmReportStatusCod
> eLib
> +++ .inf
> @@ -28,6 +28,8 @@ [Defines]
> 
>  [Sources]
>    ReportStatusCodeLib.c
> +  ReportStatusCodeLib.h
> +  ReportStatusCodeLibTraditional.c
> 
>  [Packages]
>    MdePkg/MdePkg.dec
> @@ -45,7 +47,7 @@ [Guids]
>    gEfiStatusCodeDataTypeDebugGuid               ## SOMETIMES_CONSUMES
> ## UNDEFINED
> 
>  [Protocols]
> -  gEfiSmmStatusCodeProtocolGuid                 ## CONSUMES
> +  gEfiMmStatusCodeProtocolGuid                  ## CONSUMES
> 
>  [Pcd]
>    gEfiMdePkgTokenSpaceGuid.PcdReportStatusCodePropertyMask  ##
> CONSUMES diff --git
> a/MdeModulePkg/Library/SmmReportStatusCodeLib/SmmReportStatusCod
> eLib.inf
> b/MdeModulePkg/Library/SmmReportStatusCodeLib/StandaloneMmReport
> StatusCodeLib.inf
> similarity index 56%
> copy from
> MdeModulePkg/Library/SmmReportStatusCodeLib/SmmReportStatusCodeLi
> b.inf
> copy to
> MdeModulePkg/Library/SmmReportStatusCodeLib/StandaloneMmReportSt
> atusCodeLib.inf
> index 72496bfababd..866e09249a6a 100644
> ---
> a/MdeModulePkg/Library/SmmReportStatusCodeLib/SmmReportStatusCod
> eLib.inf
> +++
> b/MdeModulePkg/Library/SmmReportStatusCodeLib/StandaloneMmReport
> Stat
> +++ usCodeLib.inf
> @@ -1,9 +1,10 @@
>  ## @file
> -#  SMM report status code library.
> +#  Standalone MM report status code library.
>  #
> -#  Retrieve status code and report status code in SMM phase.
> +#  Retrieve status code and report status code in MM phase.
>  #
>  #  Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
> +#  Copyright (c) Microsoft Corporation.
>  #
>  #  SPDX-License-Identifier: BSD-2-Clause-Patent  # @@ -12,13 +13,12 @@
> 
>  [Defines]
>    INF_VERSION                    = 0x00010005
> -  BASE_NAME                      = SmmReportStatusCodeLib
> -  MODULE_UNI_FILE                = SmmReportStatusCodeLib.uni
> -  FILE_GUID                      = 67089D19-B3D6-4d9e-A0EB-FEDC1F83A1EE
> -  MODULE_TYPE                    = DXE_SMM_DRIVER
> +  BASE_NAME                      = StandaloneMmReportStatusCodeLib
> +  FILE_GUID                      = 17C7FC8C-8C5D-497E-9C0E-C21255B30E04
> +  MODULE_TYPE                    = MM_STANDALONE
>    VERSION_STRING                 = 1.0
> -  PI_SPECIFICATION_VERSION       = 0x0001000A
> -  LIBRARY_CLASS                  = ReportStatusCodeLib|DXE_SMM_DRIVER
> SMM_CORE
> +  PI_SPECIFICATION_VERSION       = 0x00010032
> +  LIBRARY_CLASS                  = ReportStatusCodeLib|MM_STANDALONE
> 
>  #
>  # The following information is for reference only and not required by the
> build tools.
> @@ -28,6 +28,8 @@ [Defines]
> 
>  [Sources]
>    ReportStatusCodeLib.c
> +  ReportStatusCodeLib.h
> +  ReportStatusCodeLibStandaloneMm.c
> 
>  [Packages]
>    MdePkg/MdePkg.dec
> @@ -36,7 +38,7 @@ [Packages]
>  [LibraryClasses]
>    PcdLib
>    BaseMemoryLib
> -  SmmServicesTableLib
> +  MmServicesTableLib
>    DebugLib
>    MemoryAllocationLib
> 
> @@ -45,7 +47,7 @@ [Guids]
>    gEfiStatusCodeDataTypeDebugGuid               ## SOMETIMES_CONSUMES
> ## UNDEFINED
> 
>  [Protocols]
> -  gEfiSmmStatusCodeProtocolGuid                 ## CONSUMES
> +  gEfiMmStatusCodeProtocolGuid                  ## CONSUMES
> 
>  [Pcd]
>    gEfiMdePkgTokenSpaceGuid.PcdReportStatusCodePropertyMask  ##
> CONSUMES diff --git a/MdeModulePkg/MdeModulePkg.dsc
> b/MdeModulePkg/MdeModulePkg.dsc index 9afd40eeed46..200fbcc18a18
> 100644
> --- a/MdeModulePkg/MdeModulePkg.dsc
> +++ b/MdeModulePkg/MdeModulePkg.dsc
> @@ -474,6 +474,7 @@ [Components.IA32, Components.X64]
>    }
> 
> MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.i
> nf
> 
> MdeModulePkg/Library/SmmReportStatusCodeLib/SmmReportStatusCodeLi
> b.inf
> +
> +
> MdeModulePkg/Library/SmmReportStatusCodeLib/StandaloneMmReportSt
> atusCo
> + deLib.inf
> 
> MdeModulePkg/Universal/StatusCodeHandler/Smm/StatusCodeHandlerSm
> m.inf
> 
> MdeModulePkg/Universal/ReportStatusCodeRouter/Smm/ReportStatusCod
> eRouterSmm.inf
>    MdeModulePkg/Universal/LockBox/SmmLockBox/SmmLockBox.inf
> --
> 2.30.0.windows.1
> 
> 
> 
> 
>