MdePkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  MM Services Table Library.\r
\r
  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
  Copyright (c) 2018, Linaro, Ltd. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiMm.h>\r
#include <Protocol/MmBase.h>\r
#include <Library/MmServicesTableLib.h>\r
#include <Library/DebugLib.h>\r
\r
EFI_MM_SYSTEM_TABLE   *gMmst             = NULL;\r
\r
/**\r
  The constructor function caches the pointer of the MM 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
MmServicesTableLibConstructor (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS              Status;\r
  EFI_MM_BASE_PROTOCOL    *InternalMmBase;\r
\r
  InternalMmBase = NULL;\r
  //\r
  // Retrieve MM Base Protocol,  Do not use gBS from UefiBootServicesTableLib on purpose\r
  // to prevent inclusion of gBS, gST, and gImageHandle from SMM Drivers unless the\r
  // MM driver explicity declares that dependency.\r
  //\r
  Status = SystemTable->BootServices->LocateProtocol (\r
                                        &gEfiMmBaseProtocolGuid,\r
                                        NULL,\r
                                        (VOID **)&InternalMmBase\r
                                        );\r
  ASSERT_EFI_ERROR (Status);\r
  ASSERT (InternalMmBase != NULL);\r
\r
  //\r
  // We are in MM, retrieve the pointer to MM System Table\r
  //\r
  InternalMmBase->GetMmstLocation (InternalMmBase, &gMmst);\r
  ASSERT (gMmst != NULL);\r
\r
  return EFI_SUCCESS;\r
}\r