MdePkg/Library/Smm: Fix various typos

[mirror_edk2.git] / MdePkg / Include / Library / SmmLib.h

/** @file\r
  Library class name: SmmLib\r
\r
  SMM Library Services that abstracts both S/W SMI generation and detection.\r
\r
  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __SMM_LIB_H__\r
#define __SMM_LIB_H__\r
\r
\r
/**\r
  Triggers an SMI at boot time.\r
\r
  This function triggers a software SMM interrupt at boot time.\r
\r
**/\r
VOID\r
EFIAPI\r
TriggerBootServiceSoftwareSmi (\r
  VOID\r
  );\r
\r
\r
/**\r
  Triggers an SMI at run time.\r
\r
  This function triggers a software SMM interrupt at run time.\r
\r
**/\r
VOID\r
EFIAPI\r
TriggerRuntimeSoftwareSmi (\r
  VOID\r
  );\r
\r
\r
/**\r
  Test if a boot time software SMI happened.\r
\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 happened.\r
  @retval FALSE  No software SMI happened, or the software SMI was triggered at run time.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
IsBootServiceSoftwareSmi (\r
  VOID\r
  );\r
\r
\r
/**\r
  Test if a run time software SMI happened.\r
\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 happened.\r
  @retval FALSE  No software SMI happened or the software SMI was triggered at boot time.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
IsRuntimeSoftwareSmi (\r
  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