StandaloneMmPkg/Core: Implementation of Standalone MM Core Module.

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

/** @file\r
  Module entry point library for STANDALONE MM core.\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
/// Global variable that contains a pointer to the Hob List passed into the STANDALONE MM Core entry point.\r
///\r
extern VOID  *gHobList;\r
\r
\r
/**\r
  The entry point of PE/COFF Image for the STANDALONE MM Core.\r
\r
  This function is the entry point for the STANDALONE MM Core. This function is required to call\r
  ProcessModuleEntryPointList() and ProcessModuleEntryPointList() is never expected to return.\r
  The STANDALONE MM Core is responsible for calling ProcessLibraryConstructorList() as soon as the EFI\r
  System Table and the image handle for the STANDALONE MM Core itself have been established.\r
  If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.\r
\r
  @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase.\r
\r
**/\r
VOID\r
EFIAPI\r
_ModuleEntryPoint (\r
  IN VOID  *HobStart\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 HobStart.\r
\r
  @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase.\r
\r
**/\r
VOID\r
EFIAPI\r
EfiMain (\r
  IN VOID  *HobStart\r
  );\r
\r
\r
/**\r
  Auto generated function that calls the library constructors for all of the 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 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\r
  libraries. 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 have\r
  constructors, and calling the library constructors in the proper order based upon\r
  each of the library instances own dependencies.\r
\r
  @param  ImageHandle  The image handle of the STANDALONE MM Core.\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
  Autogenerated 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  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase.\r
\r
**/\r
VOID\r
EFIAPI\r
ProcessModuleEntryPointList (\r
  IN VOID  *HobStart\r
  );\r
\r
#endif\r