StandaloneMmPkg: MM driver entry point library.
authorSupreeth Venkatesh <supreeth.venkatesh@arm.com>
Fri, 13 Jul 2018 15:05:26 +0000 (23:05 +0800)
committerJiewen Yao <jiewen.yao@intel.com>
Fri, 20 Jul 2018 02:55:49 +0000 (10:55 +0800)
This patch implements module entry point library for Standalone
management mode (MM) Drivers.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Supreeth Venkatesh <supreeth.venkatesh@arm.com>
Reviewed-by: Achin Gupta <achin.gupta@arm.com>
Reviewed-by: Jiewen Yao <Jiewen.yao@intel.com>
Signed-off-by: Sughosh Ganu <sughosh.ganu@arm.com>
StandaloneMmPkg/Include/Library/StandaloneMmDriverEntryPoint.h [new file with mode: 0644]
StandaloneMmPkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDriverEntryPoint.c [new file with mode: 0644]
StandaloneMmPkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDriverEntryPoint.inf [new file with mode: 0644]

diff --git a/StandaloneMmPkg/Include/Library/StandaloneMmDriverEntryPoint.h b/StandaloneMmPkg/Include/Library/StandaloneMmDriverEntryPoint.h
new file mode 100644 (file)
index 0000000..4c93c16
--- /dev/null
@@ -0,0 +1,148 @@
+/** @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
+\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
+#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 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 _gDriverUnloadImageCount is greater\r
+  than zero, then an unload handler must be registered for this image and\r
+  the unload handler must invoke ProcessModuleUnloadList().\r
+  If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is\r
+  less than _gUefiDriverRevison, 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  _gUefiDriverRevision is greater than\r
+                                     SystemTable->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
+  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().\r
+\r
+  This function is required to call _ModuleEntryPoint() passing in ImageHandle, and SystemTable.\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  _gUefiDriverRevision is greater than\r
+                                     SystemTable->Hdr.Revision.\r
+  @retval  Other                     Return value from ProcessModuleEntryPointList().\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+EfiMain (\r
+  IN EFI_HANDLE             ImageHandle,\r
+  IN EFI_MM_SYSTEM_TABLE    *MmSystemTable\r
+  );\r
+\r
+/**\r
+  Auto generated function that calls the library constructors for all of the module's\r
+  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 instances\r
+  that a module depends on.  This includes library instances that a module depends on\r
+  directly and library instances that a module depends on indirectly through other libraries.\r
+  This function is auto generated by build tools and those build tools are responsible\r
+  for collecting the set of library instances, determine which ones have constructors,\r
+  and calling the library constructors in the proper order based upon each of the library\r
+  instances own dependencies.\r
+\r
+  @param  ImageHandle  The image handle of the Standalone MM Driver.\r
+  @param  SystemTable  A pointer to the EFI 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 module's\r
+  dependent libraries.\r
+\r
+  This function may be called by _ModuleEntryPoint() or ExitDriver().\r
+  This function calls the set of library destructors for the set of library instances\r
+  that a module depends on. This includes library instances that a module depends on\r
+  directly and library instances that a module depends on indirectly through other libraries.\r
+  This function is auto generated by build tools and those build tools are responsible for\r
+  collecting the set of library instances, determine which ones have destructors, and calling\r
+  the library destructors in the proper order 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 EFI 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 responsible\r
+  for collecting the module entry points and calling them in a 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 MMDriver 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/StandaloneMmPkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDriverEntryPoint.c b/StandaloneMmPkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDriverEntryPoint.c
new file mode 100644 (file)
index 0000000..64bffcf
--- /dev/null
@@ -0,0 +1,99 @@
+/** @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
+\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 <PiMm.h>\r
+\r
+#include <Library/BaseLib.h>\r
+#include <Library/DebugLib.h>\r
+\r
+VOID\r
+EFIAPI\r
+ProcessLibraryConstructorList (\r
+  IN EFI_HANDLE               ImageHandle,\r
+  IN IN EFI_MM_SYSTEM_TABLE   *MmSystemTable\r
+  );\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+  IN EFI_HANDLE               ImageHandle,\r
+  IN IN EFI_MM_SYSTEM_TABLE   *MmSystemTable\r
+  );\r
+\r
+VOID\r
+EFIAPI\r
+ProcessLibraryDestructorList (\r
+  IN EFI_HANDLE               ImageHandle,\r
+  IN IN EFI_MM_SYSTEM_TABLE   *MmSystemTable\r
+  );\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 _gDriverUnloadImageCount is greater than zero, then an unload\r
+  handler must be registered for this image\r
+  and the unload handler must invoke ProcessModuleUnloadList().\r
+  If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less\r
+  than _gUefiDriverRevison, then return EFI_INCOMPATIBLE_VERSION.\r
+\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  _gUefiDriverRevision is greater than\r
+                                    SystemTable->Hdr.Revision.\r
+  @retval  Other                     Return value from 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
+  //\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
+\r
diff --git a/StandaloneMmPkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDriverEntryPoint.inf b/StandaloneMmPkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDriverEntryPoint.inf
new file mode 100644 (file)
index 0000000..4d1896d
--- /dev/null
@@ -0,0 +1,41 @@
+## @file\r
+# Module entry point library for 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
+#\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
+#  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
+\r
+[Defines]\r
+  INF_VERSION                    = 0x0001001A\r
+  BASE_NAME                      = StandaloneMmDriverEntryPoint\r
+  FILE_GUID                      = BBC33478-98F8-4B78-B29D-574D681B7E43\r
+  MODULE_TYPE                    = MM_STANDALONE\r
+  VERSION_STRING                 = 1.0\r
+  PI_SPECIFICATION_VERSION       = 0x00010032\r
+  LIBRARY_CLASS                  = StandaloneMmDriverEntryPoint|MM_STANDALONE\r
+\r
+#\r
+# The following information is for reference only and not required by the build tools.\r
+#\r
+#  VALID_ARCHITECTURES           = IA32 X64 IPF EBC\r
+#\r
+\r
+[Sources]\r
+  StandaloneMmDriverEntryPoint.c\r
+\r
+[Packages]\r
+  MdePkg/MdePkg.dec\r
+\r
+[LibraryClasses]\r
+  BaseLib\r
+  DebugLib\r
+\r