StandaloneMmPkg/Include/Library/StandaloneMmCoreEntryPoint.h

   1 /** @file
   2   Module entry point library for STANDALONE MM core.
   3
   4 Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
   5 Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.<BR>
   6
   7 SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 **/
  10
  11 #ifndef __MODULE_ENTRY_POINT_H__
  12 #define __MODULE_ENTRY_POINT_H__
  13
  14 ///
  15 /// Global variable that contains a pointer to the Hob List passed into the STANDALONE MM Core entry point.
  16 ///
  17 extern VOID  *gHobList;
  18
  19
  20 /**
  21   The entry point of PE/COFF Image for the STANDALONE MM Core.
  22
  23   This function is the entry point for the STANDALONE MM Core. This function is required to call
  24   ProcessModuleEntryPointList() and ProcessModuleEntryPointList() is never expected to return.
  25   The STANDALONE MM Core is responsible for calling ProcessLibraryConstructorList() as soon as the EFI
  26   System Table and the image handle for the STANDALONE MM Core itself have been established.
  27   If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.
  28
  29   @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase.
  30
  31 **/
  32 VOID
  33 EFIAPI
  34 _ModuleEntryPoint (
  35   IN VOID  *HobStart
  36   );
  37
  38
  39 /**
  40   Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().
  41
  42   This function is required to call _ModuleEntryPoint() passing in HobStart.
  43
  44   @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase.
  45
  46 **/
  47 VOID
  48 EFIAPI
  49 EfiMain (
  50   IN VOID  *HobStart
  51   );
  52
  53
  54 /**
  55   Auto generated function that calls the library constructors for all of the module's dependent libraries.
  56
  57   This function must be called by _ModuleEntryPoint().
  58   This function calls the set of library constructors for the set of library instances
  59   that a module depends on.  This includes library instances that a module depends on
  60   directly and library instances that a module depends on indirectly through other
  61   libraries. This function is auto generated by build tools and those build tools are
  62   responsible for collecting the set of library instances, determine which ones have
  63   constructors, and calling the library constructors in the proper order based upon
  64   each of the library instances own dependencies.
  65
  66   @param  ImageHandle  The image handle of the STANDALONE MM Core.
  67   @param  SystemTable  A pointer to the EFI System Table.
  68
  69 **/
  70 VOID
  71 EFIAPI
  72 ProcessLibraryConstructorList (
  73   IN EFI_HANDLE             ImageHandle,
  74   IN EFI_MM_SYSTEM_TABLE    *MmSystemTable
  75   );
  76
  77
  78 /**
  79   Autogenerated function that calls a set of module entry points.
  80
  81   This function must be called by _ModuleEntryPoint().
  82   This function calls the set of module entry points.
  83   This function is auto generated by build tools and those build tools are responsible
  84   for collecting the module entry points and calling them in a specified order.
  85
  86   @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase.
  87
  88 **/
  89 VOID
  90 EFIAPI
  91 ProcessModuleEntryPointList (
  92   IN VOID  *HobStart
  93   );
  94
  95 #endif