Move SmmLib from IntelFrameworkPkg to MdePkg because this library is useful to both...
[mirror_edk2.git] / IntelFrameworkPkg / Include / Library / SmmLib.h
index 76605fb..32372ed 100644 (file)
@@ -3,7 +3,7 @@
   \r
   SMM Library Services that abstracts both S/W SMI generation and detection. \r
 \r
-  Copyright (c) 2007, Intel Corporation                                                         \r
+  Copyright (c) 2007 - 2010, Intel Corporation                                                         \r
   All rights reserved. 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
@@ -45,13 +45,13 @@ TriggerRuntimeSoftwareSmi (
 \r
 \r
 /**\r
-  Test if a boot time software SMI happens.  \r
+  Test if a boot time software SMI happened.  \r
 \r
-  This function tests if a software SMM interrupt happens. If a software SMM interrupt happens and\r
-  it is triggered at boot time, it returns TRUE. Otherwise, it returns FALSE.\r
+  This function tests if a software SMM interrupt happened. If a software SMM interrupt happened and\r
+  it was triggered at boot time, it returns TRUE. Otherwise, it returns FALSE.\r
 \r
-  @retval TRUE                 A software SMI triggered at boot time happens.\r
-  @retval FLASE                No software SMI happens or the software SMI is triggered at run time.\r
+  @retval TRUE   A software SMI triggered at boot time happened.\r
+  @retval FLASE  No software SMI happened, or the software SMI was triggered at run time.\r
 \r
 **/\r
 BOOLEAN\r
@@ -62,13 +62,13 @@ IsBootServiceSoftwareSmi (
 \r
 \r
 /**\r
-  Test if a run time software SMI happens.  \r
+  Test if a run time software SMI happened.  \r
 \r
-  This function tests if a software SMM interrupt happens. If a software SMM interrupt happens and\r
-  it is triggered at run time, it returns TRUE. Otherwise, it returns FALSE.\r
+  This function tests if a software SMM interrupt happened. If a software SMM interrupt happened and\r
+  it was triggered at run time, it returns TRUE. Otherwise, it returns FALSE.\r
 \r
-  @retval TRUE                 A software SMI triggered at run time happens.\r
-  @retval FLASE                No software SMI happens or the software SMI is triggered at boot time.\r
+  @retval TRUE   A software SMI triggered at run time happened.\r
+  @retval FLASE  No software SMI happened or the software SMI was triggered at boot time.\r
 \r
 **/\r
 BOOLEAN\r
@@ -77,4 +77,13 @@ IsRuntimeSoftwareSmi (
   VOID\r
   );\r
 \r
+/**\r
+  Clear APM SMI Status Bit; Set the EOS bit. \r
+  \r
+**/\r
+VOID\r
+EFIAPI\r
+ClearSmi (\r
+  VOID\r
+  );\r
 #endif\r