StandaloneMmPkg: MM driver entry point library.

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>

1 files changed, 148 insertions, 0 deletions

diff --git a/StandaloneMmPkg/Include/Library/StandaloneMmDriverEntryPoint.h b/StandaloneMmPkg/Include/Library/StandaloneMmDriverEntryPoint.h
new file mode 100644
index 0000000000..4c93c16ef5
--- /dev/null
+++ b/StandaloneMmPkg/Include/Library/StandaloneMmDriverEntryPoint.h
@@ -0,0 +1,148 @@
+/** @file

+  Module entry point library for Standalone MM Drivers.

+

+Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.<BR>

+

+This program and the accompanying materials

+are licensed and made available under the terms and conditions of the BSD License

+which accompanies this distribution.  The full text of the license may be found at

+http://opensource.org/licenses/bsd-license.php

+

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+**/

+

+#ifndef __MODULE_ENTRY_POINT_H__

+#define __MODULE_ENTRY_POINT_H__

+

+///

+///Declare the PI Specification Revision that this driver requires to execute correctly.

+///

+extern CONST UINT32                   _gMmRevision;

+

+/**

+  The entry point of PE/COFF Image for a Standalone MM Driver.

+

+  This function is the entry point for a Standalone MM Driver.

+  This function must call ProcessLibraryConstructorList() and

+  ProcessModuleEntryPointList().

+  If the return status from ProcessModuleEntryPointList()

+  is an error status, then ProcessLibraryDestructorList() must be called.

+  The return value from ProcessModuleEntryPointList() is returned.

+  If _gDriverUnloadImageCount is greater

+  than zero, then an unload handler must be registered for this image and

+  the unload handler must invoke ProcessModuleUnloadList().

+  If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is

+  less than _gUefiDriverRevison, then return EFI_INCOMPATIBLE_VERSION.

+

+  @param  ImageHandle  The image handle of the Standalone MM Driver.

+  @param  SystemTable  A pointer to the EFI System Table.

+

+  @retval  EFI_SUCCESS               The Standalone MM Driver exited normally.

+  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than

+                                     SystemTable->Hdr.Revision.

+  @retval  Other                     Return value from

+                                     ProcessModuleEntryPointList().

+

+**/

+EFI_STATUS

+EFIAPI

+_ModuleEntryPoint (

+  IN EFI_HANDLE             ImageHandle,

+  IN EFI_MM_SYSTEM_TABLE    *MmSystemTable

+  );

+

+

+/**

+  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().

+

+  This function is required to call _ModuleEntryPoint() passing in ImageHandle, and SystemTable.

+

+  @param  ImageHandle  The image handle of the Standalone MM Driver.

+  @param  SystemTable  A pointer to the EFI System Table.

+

+  @retval  EFI_SUCCESS               The Standalone MM Driver exited normally.

+  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than

+                                     SystemTable->Hdr.Revision.

+  @retval  Other                     Return value from ProcessModuleEntryPointList().

+**/

+EFI_STATUS

+EFIAPI

+EfiMain (

+  IN EFI_HANDLE             ImageHandle,

+  IN EFI_MM_SYSTEM_TABLE    *MmSystemTable

+  );

+

+/**

+  Auto generated function that calls the library constructors for all of the module's

+  dependent libraries.

+

+  This function must be called by _ModuleEntryPoint().

+  This function calls the set of library constructors for the set of library instances

+  that a module depends on.  This includes library instances that a module depends on

+  directly and library instances that a module depends on indirectly through other libraries.

+  This function is auto generated by build tools and those build tools are responsible

+  for collecting the set of library instances, determine which ones have constructors,

+  and calling the library constructors in the proper order based upon each of the library

+  instances own dependencies.

+

+  @param  ImageHandle  The image handle of the Standalone MM Driver.

+  @param  SystemTable  A pointer to the EFI System Table.

+

+**/

+VOID

+EFIAPI

+ProcessLibraryConstructorList (

+  IN EFI_HANDLE             ImageHandle,

+  IN EFI_MM_SYSTEM_TABLE    *MmSystemTable

+  );

+

+

+/**

+  Auto generated function that calls the library descructors for all of the module's

+  dependent libraries.

+

+  This function may be called by _ModuleEntryPoint() or ExitDriver().

+  This function calls the set of library destructors for the set of library instances

+  that a module depends on. This includes library instances that a module depends on

+  directly and library instances that a module depends on indirectly through other libraries.

+  This function is auto generated by build tools and those build tools are responsible for

+  collecting the set of library instances, determine which ones have destructors, and calling

+  the library destructors in the proper order based upon each of the library instances own dependencies.

+

+  @param  ImageHandle  The image handle of the Standalone MM Driver.

+  @param  SystemTable  A pointer to the EFI System Table.

+

+**/

+VOID

+EFIAPI

+ProcessLibraryDestructorList (

+  IN EFI_HANDLE             ImageHandle,

+  IN EFI_MM_SYSTEM_TABLE    *MmSystemTable

+  );

+

+

+/**

+  Auto generated function that calls a set of module entry points.

+

+  This function must be called by _ModuleEntryPoint().

+  This function calls the set of module entry points.

+  This function is auto generated by build tools and those build tools are responsible

+  for collecting the module entry points and calling them in a specified order.

+

+  @param  ImageHandle  The image handle of the Standalone MM Driver.

+  @param  SystemTable  A pointer to the EFI System Table.

+

+  @retval  EFI_SUCCESS   The Standalone MMDriver executed normally.

+  @retval  !EFI_SUCCESS  The Standalone MM Driver failed to execute normally.

+**/

+EFI_STATUS

+EFIAPI

+ProcessModuleEntryPointList (

+  IN EFI_HANDLE             ImageHandle,

+  IN EFI_MM_SYSTEM_TABLE    *MmSystemTable

+  );

+

+#endif