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, Intel Corporation
   6 All rights reserved. This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  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_SERVICES_TABLE_LIB_H__
  17 #define __SMM_SERVICES_TABLE_LIB_H__
  18
  19 #include <PiSmm.h>
  20
  21 ///
  22 /// Cache pointer to the SMM Services Table
  23 ///
  24 extern EFI_SMM_SYSTEM_TABLE2   *gSmst;
  25
  26 /**
  27   This function allows the caller to determine if the driver is executing in
  28   System Management Mode(SMM).
  29
  30   This function returns TRUE if the driver is executing in SMM and FALSE if the
  31   driver is not executing in SMM.
  32
  33   @retval  TRUE  The driver is executing in System Management Mode (SMM).
  34   @retval  FALSE The driver is not executing in System Management Mode (SMM).
  35
  36 **/
  37 BOOLEAN
  38 EFIAPI
  39 InSmm (
  40   VOID
  41   );
  42
  43 #endif