MdeModulePkg/SmmSmiHandlerProfileLib: Add SMM instance.

This instance should be linked by SmmChildDispatcher
if SMI handler profile feature is enabled.

Cc: Feng Tian <feng.tian@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiewen Yao <jiewen.yao@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>

3 files changed, 173 insertions, 0 deletions

diff --git a/MdeModulePkg/Library/SmmSmiHandlerProfileLib/SmmSmiHandlerProfileLib.c b/MdeModulePkg/Library/SmmSmiHandlerProfileLib/SmmSmiHandlerProfileLib.c
new file mode 100644
index 0000000000..0191cdebbf
--- /dev/null
+++ b/MdeModulePkg/Library/SmmSmiHandlerProfileLib/SmmSmiHandlerProfileLib.c
@@ -0,0 +1,106 @@
+/** @file

+  SMM driver instance of SmiHandlerProfile Library.

+

+  Copyright (c) 2017, 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

+  http://opensource.org/licenses/bsd-license.php.

+

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+**/

+

+#include <PiSmm.h>

+#include <Library/SmiHandlerProfileLib.h>

+#include <Library/SmmServicesTableLib.h>

+#include <Guid/SmiHandlerProfile.h>

+

+SMI_HANDLER_PROFILE_PROTOCOL  *mSmiHandlerProfile;

+

+/**

+  This function is called by SmmChildDispatcher module to report

+  a new SMI handler is registered, to SmmCore.

+

+  @param HandlerGuid     The GUID to identify the type of the handler.

+                         For the SmmChildDispatch protocol, the HandlerGuid

+                         must be the GUID of SmmChildDispatch protocol.

+  @param Handler         The SMI handler.

+  @param CallerAddress   The address of the module who registers the SMI handler.

+  @param Context         The context of the SMI handler.

+                         For the SmmChildDispatch protocol, the Context

+                         must match the one defined for SmmChildDispatch protocol.

+  @param ContextSize     The size of the context in bytes.

+                         For the SmmChildDispatch protocol, the Context

+                         must match the one defined for SmmChildDispatch protocol.

+

+  @retval EFI_SUCCESS           The information is recorded.

+  @retval EFI_UNSUPPORTED       The feature is unsupported.

+  @retval EFI_OUT_OF_RESOURCES  There is no enough resource to record the information.

+**/

+EFI_STATUS

+EFIAPI

+SmiHandlerProfileRegisterHandler (

+  IN EFI_GUID                       *HandlerGuid,

+  IN EFI_SMM_HANDLER_ENTRY_POINT2   Handler,

+  IN PHYSICAL_ADDRESS               CallerAddress,

+  IN VOID                           *Context, OPTIONAL

+  IN UINTN                          ContextSize OPTIONAL

+  )

+{

+  if (mSmiHandlerProfile != NULL) {

+    return mSmiHandlerProfile->RegisterHandler (mSmiHandlerProfile, HandlerGuid, Handler, CallerAddress, Context, ContextSize);

+  }

+  return EFI_UNSUPPORTED;

+}

+

+/**

+  This function is called by SmmChildDispatcher module to report

+  an existing SMI handler is unregistered, to SmmCore.

+

+  @param HandlerGuid     The GUID to identify the type of the handler.

+                         For the SmmChildDispatch protocol, the HandlerGuid

+                         must be the GUID of SmmChildDispatch protocol.

+  @param Handler         The SMI handler.

+

+  @retval EFI_SUCCESS           The original record is removed.

+  @retval EFI_UNSUPPORTED       The feature is unsupported.

+  @retval EFI_NOT_FOUND         There is no record for the HandlerGuid and handler.

+**/

+EFI_STATUS

+EFIAPI

+SmiHandlerProfileUnregisterHandler (

+  IN EFI_GUID                       *HandlerGuid,

+  IN EFI_SMM_HANDLER_ENTRY_POINT2   Handler

+  )

+{

+  if (mSmiHandlerProfile != NULL) {

+    return mSmiHandlerProfile->UnregisterHandler (mSmiHandlerProfile, HandlerGuid, Handler);

+  }

+  return EFI_UNSUPPORTED;

+}

+

+/**

+  The constructor function for SMI handler profile.

+

+  @param  ImageHandle   The firmware allocated handle for the EFI image.

+  @param  SystemTable   A pointer to the EFI System Table.

+

+  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.

+**/

+EFI_STATUS

+EFIAPI

+SmmSmiHandlerProfileLibConstructor (

+  IN EFI_HANDLE        ImageHandle,

+  IN EFI_SYSTEM_TABLE  *SystemTable

+  )

+{

+  gSmst->SmmLocateProtocol (

+           &gSmiHandlerProfileGuid,

+           NULL,

+           &mSmiHandlerProfile

+           );

+  return EFI_SUCCESS;

+}

+

diff --git a/MdeModulePkg/Library/SmmSmiHandlerProfileLib/SmmSmiHandlerProfileLib.inf b/MdeModulePkg/Library/SmmSmiHandlerProfileLib/SmmSmiHandlerProfileLib.inf
new file mode 100644
index 0000000000..0c1ad7eb06
--- /dev/null
+++ b/MdeModulePkg/Library/SmmSmiHandlerProfileLib/SmmSmiHandlerProfileLib.inf
@@ -0,0 +1,46 @@
+## @file

+# SMM driver instance of SmiHandlerProfile Library.

+#

+# This library instance provides real functionality for SmmChildDispatcher module.

+#

+#  Copyright (c) 2017, 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

+#  http://opensource.org/licenses/bsd-license.php.

+#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+#

+#

+##

+

+[Defines]

+  INF_VERSION                    = 0x00010005

+  BASE_NAME                      = SmmSmiHandlerProfileLib

+  MODULE_UNI_FILE                = SmmSmiHandlerProfileLib.uni

+  FILE_GUID                      = B43D1B52-6251-4E6F-82EC-A599A5EE94C1

+  MODULE_TYPE                    = DXE_SMM_DRIVER

+  VERSION_STRING                 = 1.0

+  LIBRARY_CLASS                  = SmiHandlerProfileLib|DXE_SMM_DRIVER

+  CONSTRUCTOR                    = SmmSmiHandlerProfileLibConstructor

+

+#

+# The following information is for reference only and not required by the build tools.

+#

+#  VALID_ARCHITECTURES           = IA32 X64

+#

+

+[Sources]

+  SmmSmiHandlerProfileLib.c

+

+[Packages]

+  MdePkg/MdePkg.dec

+  MdeModulePkg/MdeModulePkg.dec

+

+[LibraryClasses]

+  SmmServicesTableLib

+

+[Guids]

+  gSmiHandlerProfileGuid  ## CONSUMES   ## GUID # Locate protocol

+

diff --git a/MdeModulePkg/Library/SmmSmiHandlerProfileLib/SmmSmiHandlerProfileLib.uni b/MdeModulePkg/Library/SmmSmiHandlerProfileLib/SmmSmiHandlerProfileLib.uni
new file mode 100644
index 0000000000..f65827dbe2
--- /dev/null
+++ b/MdeModulePkg/Library/SmmSmiHandlerProfileLib/SmmSmiHandlerProfileLib.uni
@@ -0,0 +1,21 @@
+// /** @file

+// SMM driver instance of SmiHandlerProfile Library.

+//

+// This library instance provides real functionality for SmmChildDispatcher module.

+//

+// Copyright (c) 2017, 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

+// http://opensource.org/licenses/bsd-license.php.

+// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+//

+// **/

+

+

+#string STR_MODULE_ABSTRACT             #language en-US "SMM driver instance of SmiHandlerProfile Library"

+

+#string STR_MODULE_DESCRIPTION          #language en-US "This library instance provides real functionality for SmmChildDispatcher module."

+