MdePkg: introduce standalone MM entry point library class

Add the library interface for the standalone MM driver entry point.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Acked-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

diff --git a/MdePkg/Include/Library/StandaloneMmDriverEntryPoint.h b/MdePkg/Include/Library/StandaloneMmDriverEntryPoint.h
new file mode 100644 (file)
index 0000000..d618998
--- /dev/null
+++ b/MdePkg/Include/Library/StandaloneMmDriverEntryPoint.h
@@ -0,0 +1,131 @@
+/** @file\r
+  Module entry point library for Standalone MM Drivers.\r
+\r
+Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.<BR>\r
+Copyright (c) 2018, Linaro, Limited. All rights reserved.<BR>\r
+\r
+This program and the accompanying materials are licensed and made available\r
+under the terms and conditions of the BSD License which accompanies this\r
+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
+#ifndef __MODULE_ENTRY_POINT_H__\r
+#define __MODULE_ENTRY_POINT_H__\r
+\r
+///\r
+/// Declare the PI Specification Revision that this driver requires to execute\r
+/// correctly.\r
+///\r
+extern CONST UINT32                   _gMmRevision;\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 MmSystemTable->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  SystemTable  A pointer to the EFI 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 EFI_MM_SYSTEM_TABLE    *MmSystemTable\r
+  );\r
+\r
+\r
+/**\r
+  Auto generated function that calls the library constructors for all of the\r
+  module's dependent libraries.\r
+\r
+  This function must be called by _ModuleEntryPoint().\r
+  This function calls the set of library constructors for the set of library\r
+  instances that a module depends on.  This includes library instances that a\r
+  module depends on directly and library instances that a module depends on\r
+  indirectly through other libraries. This function is auto generated by build\r
+  tools and those build tools are responsible for collecting the set of library\r
+  instances, determine which ones have constructors, and calling the library\r
+  constructors in the proper order based upon each of the library instances own\r
+  dependencies.\r
+\r
+  @param  ImageHandle  The image handle of the Standalone MM Driver.\r
+  @param  SystemTable  A pointer to the MM System Table.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+ProcessLibraryConstructorList (\r
+  IN EFI_HANDLE             ImageHandle,\r
+  IN EFI_MM_SYSTEM_TABLE    *MmSystemTable\r
+  );\r
+\r
+\r
+/**\r
+  Auto generated function that calls the library descructors for all of the\r
+  module's dependent libraries.\r
+\r
+  This function may be called by _ModuleEntryPoint().\r
+  This function calls the set of library destructors for the set of library\r
+  instances that a module depends on. This includes library instances that a\r
+  module depends on directly and library instances that a module depends on\r
+  indirectly through other libraries.\r
+  This function is auto generated by build tools and those build tools are\r
+  responsible for collecting the set of library instances, determine which ones\r
+  have destructors, and calling the library destructors in the proper order\r
+  based upon each of the library instances own dependencies.\r
+\r
+  @param  ImageHandle  The image handle of the Standalone MM Driver.\r
+  @param  SystemTable  A pointer to the MM System Table.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+ProcessLibraryDestructorList (\r
+  IN EFI_HANDLE             ImageHandle,\r
+  IN EFI_MM_SYSTEM_TABLE    *MmSystemTable\r
+  );\r
+\r
+\r
+/**\r
+  Auto generated function that calls a set of module entry points.\r
+\r
+  This function must be called by _ModuleEntryPoint().\r
+  This function calls the set of module entry points.\r
+  This function is auto generated by build tools and those build tools are\r
+  responsible for collecting the module entry points and calling them in a\r
+  specified order.\r
+\r
+  @param  ImageHandle  The image handle of the Standalone MM Driver.\r
+  @param  SystemTable  A pointer to the EFI System Table.\r
+\r
+  @retval  EFI_SUCCESS   The Standalone MM Driver executed normally.\r
+  @retval  !EFI_SUCCESS  The Standalone MM Driver failed to execute normally.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+  IN EFI_HANDLE             ImageHandle,\r
+  IN EFI_MM_SYSTEM_TABLE    *MmSystemTable\r
+  );\r
+\r
+#endif\r

diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
index a7383b6daafb629e3999990fbd61646a967a1a0f..a4854083105d6797362c97f0ba782fd62528d7eb 100644 (file)
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -247,6 +247,9 @@
   #                Only available to MM_STANDALONE, SMM/DXE Combined and SMM module types.\r
   MmServicesTableLib|Include/Library/MmServicesTableLib.h\r
 \r
+  ##  @libraryclass  Module entry point library for standalone MM drivers.\r
+  StandaloneMmDriverEntryPoint|Include/Library/StandaloneMmDriverEntryPoint.h\r
+\r
 [LibraryClasses.IA32, LibraryClasses.X64]\r
   ##  @libraryclass  Abstracts both S/W SMI generation and detection.\r
   ##\r