Update the copyright notice format

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Library / Dxe / Include / SmmRuntimeLib.h

/*++\r
\r
Copyright (c) 2004, Intel Corporation. All rights reserved.<BR>\r
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
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
Module Name:\r
\r
  SmmRuntimeLib.h\r
\r
Abstract:\r
\r
  SMM Related prototypes that can be referenced for Preboot Configuration only.\r
\r
--*/\r
\r
#ifndef _SMM_RUNTIME_LIB_H_\r
#define _SMM_RUNTIME_LIB_H_\r
\r
#include "Tiano.h"\r
#include "EfiRuntimeLib.h"\r
\r
BOOLEAN\r
EfiInSmm (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Test whether in Smm mode currently.\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
\r
  TRUE      - In Smm mode\r
  FALSE     - Not in Smm mode\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
RegisterSmmRuntimeDriver (\r
  IN EFI_HANDLE             ImageHandle,\r
  IN EFI_SYSTEM_TABLE       *SystemTable,\r
  OUT EFI_HANDLE            *SmmImageHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Registers a Driver with the SMM.\r
\r
Arguments:\r
\r
  ImageHandle     - The firmware allocated handle for the EFI image.  \r
  SystemTable     - A pointer to the EFI System Table.\r
  SmmImageHandle  - Image handle returned by the SMM driver.\r
\r
Returns:\r
\r
  Status code\r
\r
--*/\r
;\r
\r
#endif\r