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, Intel Corporation. All rights reserved.<BR>
   6 This program and the accompanying materials are licensed and made available under
   7 the terms and conditions of the BSD License that accompanies this distribution.
   8 The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php.
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __SMM_CORE_PLATFORM_HOOK_LIB__
  17 #define __SMM_CORE_PLATFORM_HOOK_LIB__
  18
  19 /**
  20   Performs platform specific tasks before invoking registered SMI handlers.
  21
  22   This function performs platform specific tasks before invoking registered SMI handlers.
  23
  24   @retval EFI_SUCCESS       The platform hook completes successfully.
  25   @retval Other values      The paltform hook cannot complete due to some error.
  26
  27 **/
  28 EFI_STATUS
  29 EFIAPI
  30 PlatformHookBeforeSmmDispatch (
  31   VOID
  32   );
  33
  34
  35 /**
  36   Performs platform specific tasks after invoking registered SMI handlers.
  37
  38   This function performs platform specific tasks after invoking registered SMI handlers.
  39
  40   @retval EFI_SUCCESS       The platform hook completes successfully.
  41   @retval Other values      The paltform hook cannot complete due to some error.
  42
  43 **/
  44 EFI_STATUS
  45 EFIAPI
  46 PlatformHookAfterSmmDispatch (
  47   VOID
  48   );
  49
  50 #endif