diff options
| author | Jiewen Yao <jiewen.yao@intel.com> | 2017-01-30 06:40:41 -0800 |
|---|---|---|
| committer | Jiewen Yao <jiewen.yao@intel.com> | 2017-02-22 15:28:09 +0800 |
| commit | 074583572668d320884b1d51605592a917558259 (patch) | |
| tree | 40ae91a5974fc7a32f0f5f96551dc0f8dfbea1a4 /MdePkg | |
| parent | 7537f8c09a63961c5ffb6f584a6bf8210bb2c339 (diff) | |
| download | edk2-074583572668d320884b1d51605592a917558259.tar.gz edk2-074583572668d320884b1d51605592a917558259.tar.bz2 edk2-074583572668d320884b1d51605592a917558259.zip | |
MdePkg/Include: Add SmiHandlerProfileLib.h
This library should be linked by SmmChildDispatch to
report the hardware SMI handler maintained by SmmChildDispatch.
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@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: Liming Gao <liming.gao@intel.com>
Diffstat (limited to 'MdePkg')
| -rw-r--r-- | MdePkg/Include/Library/SmiHandlerProfileLib.h | 81 | ||||
| -rw-r--r-- | MdePkg/MdePkg.dec | 5 |
2 files changed, 85 insertions, 1 deletions
diff --git a/MdePkg/Include/Library/SmiHandlerProfileLib.h b/MdePkg/Include/Library/SmiHandlerProfileLib.h new file mode 100644 index 0000000000..10b7323e03 --- /dev/null +++ b/MdePkg/Include/Library/SmiHandlerProfileLib.h @@ -0,0 +1,81 @@ +/** @file
+ Provides services to log the SMI handler registration.
+
+ This API provides services for the SMM Child Dispatch Protocols provider,
+ to register SMI handler information to SmmCore.
+
+ NOTE:
+ There is no need to update the consumers of SMST->SmiHandlerRegister() or
+ the consumers of SMM Child Dispatch Protocols.
+ The SmmCore (who produces SMST) should have ability to register such
+ information directly.
+ The SmmChildDispatcher (who produces SMM Child Dispatch Protocols) should
+ be responsible to call the services to register information to SMM Core.
+
+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.
+
+**/
+
+#ifndef __SMI_HANDLER_PROFILE_LIB_H__
+#define __SMI_HANDLER_PROFILE_LIB_H__
+
+#include <PiSmm.h>
+
+/**
+ 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
+ );
+
+/**
+ 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
+ );
+
+#endif
diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec index f2bdb307af..3310029f5f 100644 --- a/MdePkg/MdePkg.dec +++ b/MdePkg/MdePkg.dec @@ -4,7 +4,7 @@ # It also provides the definitions(including PPIs/PROTOCOLs/GUIDs) of
# EFI1.10/UEFI2.6/PI1.4 and some Industry Standards.
#
-# Copyright (c) 2007 - 2016, Intel Corporation. All rights reserved.<BR>
+# Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.<BR>
# Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
# (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
#
@@ -254,6 +254,9 @@ #
RngLib|Include/Library/RngLib.h
+ ## @libraryclass Provides services to log the SMI handler registration.
+ SmiHandlerProfileLib|Include/Library/SmiHandlerProfileLib.h
+
[LibraryClasses.IPF]
## @libraryclass The SAL Library provides a service to make a SAL CALL.
SalLib|Include/Library/SalLib.h
|