MdePkg BaseStackCheckLib: Correct style of file header

[mirror_edk2.git] / MdePkg / Library / SmmServicesTableLib / SmmServicesTableLib.c

/** @file\r
  SMM Services Table Library.\r
\r
  Copyright (c) 2009 - 2015, 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
**/\r
\r
#include <PiSmm.h>\r
#include <Protocol/SmmBase2.h>\r
#include <Library/SmmServicesTableLib.h>\r
#include <Library/DebugLib.h>\r
\r
EFI_SMM_SYSTEM_TABLE2   *gSmst             = NULL;\r
\r
/**\r
  The constructor function caches the pointer of SMM Services Table.\r
\r
  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
  @param  SystemTable   A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmServicesTableLibConstructor (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS              Status;\r
  EFI_SMM_BASE2_PROTOCOL  *InternalSmmBase2;\r
\r
  InternalSmmBase2 = NULL;\r
  //\r
  // Retrieve SMM Base2 Protocol,  Do not use gBS from UefiBootServicesTableLib on purpose\r
  // to prevent inclusion of gBS, gST, and gImageHandle from SMM Drivers unless the \r
  // SMM driver explicity declares that dependency. \r
  //\r
  Status = SystemTable->BootServices->LocateProtocol (\r
                                        &gEfiSmmBase2ProtocolGuid,\r
                                        NULL,\r
                                        (VOID **)&InternalSmmBase2\r
                                        );\r
  ASSERT_EFI_ERROR (Status);\r
  ASSERT (InternalSmmBase2 != NULL);\r
\r
  //\r
  // We are in SMM, retrieve the pointer to SMM System Table\r
  //\r
  InternalSmmBase2->GetSmstLocation (InternalSmmBase2, &gSmst);\r
  ASSERT (gSmst != NULL);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function allows the caller to determine if the driver is executing in \r
  System Management Mode(SMM).\r
\r
  This function returns TRUE if the driver is executing in SMM and FALSE if the \r
  driver is not executing in SMM.\r
\r
  @retval  TRUE  The driver is executing in System Management Mode (SMM).\r
  @retval  FALSE The driver is not executing in System Management Mode (SMM). \r
\r
**/\r
BOOLEAN\r
EFIAPI\r
InSmm (\r
  VOID\r
  )\r
{\r
  //\r
  // We are already in SMM\r
  //\r
  return TRUE;\r
}\r