StandaloneMmPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / StandaloneMmPkg / Include / Library / StandaloneMmDriverEntryPoint.h

/** @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
SPDX-License-Identifier: BSD-2-Clause-Patent\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