MdeModulePkg/Include/Library/SmmCorePlatformHookLib.h

   1 /** @file
   2   Smm Core Platform Hook Library.  This library class defines a set of platform
   3   hooks called by the SMM Core.
   4
   5 Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
   6 SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef __SMM_CORE_PLATFORM_HOOK_LIB__
  11 #define __SMM_CORE_PLATFORM_HOOK_LIB__
  12
  13 /**
  14   Performs platform specific tasks before invoking registered SMI handlers.
  15
  16   This function performs platform specific tasks before invoking registered SMI handlers.
  17
  18   @retval EFI_SUCCESS       The platform hook completes successfully.
  19   @retval Other values      The paltform hook cannot complete due to some error.
  20
  21 **/
  22 EFI_STATUS
  23 EFIAPI
  24 PlatformHookBeforeSmmDispatch (
  25   VOID
  26   );
  27
  28
  29 /**
  30   Performs platform specific tasks after invoking registered SMI handlers.
  31
  32   This function performs platform specific tasks after invoking registered SMI handlers.
  33
  34   @retval EFI_SUCCESS       The platform hook completes successfully.
  35   @retval Other values      The paltform hook cannot complete due to some error.
  36
  37 **/
  38 EFI_STATUS
  39 EFIAPI
  40 PlatformHookAfterSmmDispatch (
  41   VOID
  42   );
  43
  44 #endif