MdeModulePkg/SmiHandlerProfile: Add Context support in Unregister

[mirror_edk2.git] / MdeModulePkg / Library / SmmSmiHandlerProfileLib / SmmSmiHandlerProfileLib.c

/** @file\r
  SMM driver instance of SmiHandlerProfile Library.\r
\r
  Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php.\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include <PiSmm.h>\r
#include <Library/SmiHandlerProfileLib.h>\r
#include <Library/SmmServicesTableLib.h>\r
#include <Guid/SmiHandlerProfile.h>\r
\r
SMI_HANDLER_PROFILE_PROTOCOL  *mSmiHandlerProfile;\r
\r
/**\r
  This function is called by SmmChildDispatcher module to report\r
  a new SMI handler is registered, to SmmCore.\r
\r
  @param HandlerGuid     The GUID to identify the type of the handler.\r
                         For the SmmChildDispatch protocol, the HandlerGuid\r
                         must be the GUID of SmmChildDispatch protocol.\r
  @param Handler         The SMI handler.\r
  @param CallerAddress   The address of the module who registers the SMI handler.\r
  @param Context         The context of the SMI handler.\r
                         For the SmmChildDispatch protocol, the Context\r
                         must match the one defined for SmmChildDispatch protocol.\r
  @param ContextSize     The size of the context in bytes.\r
                         For the SmmChildDispatch protocol, the Context\r
                         must match the one defined for SmmChildDispatch protocol.\r
\r
  @retval EFI_SUCCESS           The information is recorded.\r
  @retval EFI_UNSUPPORTED       The feature is unsupported.\r
  @retval EFI_OUT_OF_RESOURCES  There is no enough resource to record the information.\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmiHandlerProfileRegisterHandler (\r
  IN EFI_GUID                       *HandlerGuid,\r
  IN EFI_SMM_HANDLER_ENTRY_POINT2   Handler,\r
  IN PHYSICAL_ADDRESS               CallerAddress,\r
  IN VOID                           *Context, OPTIONAL\r
  IN UINTN                          ContextSize OPTIONAL\r
  )\r
{\r
  if (mSmiHandlerProfile != NULL) {\r
    return mSmiHandlerProfile->RegisterHandler (mSmiHandlerProfile, HandlerGuid, Handler, CallerAddress, Context, ContextSize);\r
  }\r
  return EFI_UNSUPPORTED;\r
}\r
\r
/**\r
  This function is called by SmmChildDispatcher module to report\r
  an existing SMI handler is unregistered, to SmmCore.\r
\r
  @param HandlerGuid     The GUID to identify the type of the handler.\r
                         For the SmmChildDispatch protocol, the HandlerGuid\r
                         must be the GUID of SmmChildDispatch protocol.\r
  @param Handler         The SMI handler.\r
  @param Context         The context of the SMI handler.\r
                         If it is NOT NULL, it will be used to check what is registered.\r
  @param ContextSize     The size of the context in bytes.\r
                         If Context is NOT NULL, it will be used to check what is registered.\r
\r
  @retval EFI_SUCCESS           The original record is removed.\r
  @retval EFI_UNSUPPORTED       The feature is unsupported.\r
  @retval EFI_NOT_FOUND         There is no record for the HandlerGuid and handler.\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmiHandlerProfileUnregisterHandler (\r
  IN EFI_GUID                       *HandlerGuid,\r
  IN EFI_SMM_HANDLER_ENTRY_POINT2   Handler,\r
  IN VOID                           *Context, OPTIONAL\r
  IN UINTN                          ContextSize OPTIONAL\r
  )\r
{\r
  if (mSmiHandlerProfile != NULL) {\r
    return mSmiHandlerProfile->UnregisterHandler (mSmiHandlerProfile, HandlerGuid, Handler, Context, ContextSize);\r
  }\r
  return EFI_UNSUPPORTED;\r
}\r
\r
/**\r
  The constructor function for SMI handler profile.\r
\r
  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
  @param  SystemTable   A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmSmiHandlerProfileLibConstructor (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  gSmst->SmmLocateProtocol (\r
           &gSmiHandlerProfileGuid,\r
           NULL,\r
           (VOID **) &mSmiHandlerProfile\r
           );\r
  return EFI_SUCCESS;\r
}\r
\r