MdePkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  Entry point to a Standalone MM driver.\r
\r
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
Copyright (c) 2016 - 2018, ARM Ltd. All rights reserved.<BR>\r
Copyright (c) 2018, Linaro, Limited. All rights reserved.<BR>\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiMm.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MmServicesTableLib.h>\r
#include <Library/StandaloneMmDriverEntryPoint.h>\r
\r
/**\r
  The entry point of PE/COFF Image for a Standalone MM Driver.\r
\r
  This function is the entry point for a Standalone MM Driver.\r
  This function must call ProcessLibraryConstructorList() and\r
  ProcessModuleEntryPointList().\r
  If the return status from ProcessModuleEntryPointList()\r
  is an error status, then ProcessLibraryDestructorList() must be called.\r
  The return value from ProcessModuleEntryPointList() is returned.\r
  If _gMmRevision is not zero and SystemTable->Hdr.Revision is\r
  less than _gMmRevision, then return EFI_INCOMPATIBLE_VERSION.\r
\r
  @param  ImageHandle    The image handle of the Standalone MM Driver.\r
  @param  MmSystemTable  A pointer to the MM System Table.\r
\r
  @retval  EFI_SUCCESS               The Standalone MM Driver exited normally.\r
  @retval  EFI_INCOMPATIBLE_VERSION  _gMmRevision is greater than\r
                                     MmSystemTable->Hdr.Revision.\r
  @retval  Other                     Return value from\r
                                     ProcessModuleEntryPointList().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
_ModuleEntryPoint (\r
  IN EFI_HANDLE               ImageHandle,\r
  IN IN EFI_MM_SYSTEM_TABLE   *MmSystemTable\r
  )\r
{\r
  EFI_STATUS                 Status;\r
\r
  if (_gMmRevision != 0) {\r
    //\r
    // Make sure that the MM spec revision of the platform\r
    // is >= MM spec revision of the driver\r
    //\r
    if (MmSystemTable->Hdr.Revision < _gMmRevision) {\r
      return EFI_INCOMPATIBLE_VERSION;\r
    }\r
  }\r
\r
  //\r
  // Call constructor for all libraries\r
  //\r
  ProcessLibraryConstructorList (ImageHandle, MmSystemTable);\r
\r
  //\r
  // Call the driver entry point\r
  //\r
  Status = ProcessModuleEntryPointList (ImageHandle, MmSystemTable);\r
\r
  //\r
  // If all of the drivers returned errors, then invoke all of the library destructors\r
  //\r
  if (EFI_ERROR (Status)) {\r
    ProcessLibraryDestructorList (ImageHandle, MmSystemTable);\r
  }\r
\r
  //\r
  // Return the cumulative return status code from all of the driver entry points\r
  //\r
  return Status;\r
}\r