MdePkg/Include/Library/SmmServicesTableLib.h

   1 /** @file
   2   Provides a service to retrieve a pointer to the SMM Services Table.
   3   Only available to SMM module types.
   4
   5 Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
   6 SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef __SMM_SERVICES_TABLE_LIB_H__
  11 #define __SMM_SERVICES_TABLE_LIB_H__
  12
  13 #include <PiSmm.h>
  14
  15 ///
  16 /// Cache pointer to the SMM Services Table
  17 ///
  18 extern EFI_SMM_SYSTEM_TABLE2  *gSmst;
  19
  20 /**
  21   This function allows the caller to determine if the driver is executing in
  22   System Management Mode(SMM).
  23
  24   This function returns TRUE if the driver is executing in SMM and FALSE if the
  25   driver is not executing in SMM.
  26
  27   @retval  TRUE  The driver is executing in System Management Mode (SMM).
  28   @retval  FALSE The driver is not executing in System Management Mode (SMM).
  29
  30 **/
  31 BOOLEAN
  32 EFIAPI
  33 InSmm (
  34   VOID
  35   );
  36
  37 #endif