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   The entry point of PE/COFF Image for the STANDALONE MM Core.
  21
  22   This function is the entry point for the STANDALONE MM Core. This function is required to call
  23   ProcessModuleEntryPointList() and ProcessModuleEntryPointList() is never expected to return.
  24   The STANDALONE MM Core is responsible for calling ProcessLibraryConstructorList() as soon as the EFI
  25   System Table and the image handle for the STANDALONE MM Core itself have been established.
  26   If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.
  27
  28   @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase.
  29
  30 **/
  31 VOID
  32 EFIAPI
  33 _ModuleEntryPoint (
  34   IN VOID  *HobStart
  35   );
  36
  37 /**
  38   Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().
  39
  40   This function is required to call _ModuleEntryPoint() passing in HobStart.
  41
  42   @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase.
  43
  44 **/
  45 VOID
  46 EFIAPI
  47 EfiMain (
  48   IN VOID  *HobStart
  49   );
  50
  51 /**
  52   Auto generated function that calls the library constructors for all of the module's dependent libraries.
  53
  54   This function must be called by _ModuleEntryPoint().
  55   This function calls the set of library constructors for the set of library instances
  56   that a module depends on.  This includes library instances that a module depends on
  57   directly and library instances that a module depends on indirectly through other
  58   libraries. This function is auto generated by build tools and those build tools are
  59   responsible for collecting the set of library instances, determine which ones have
  60   constructors, and calling the library constructors in the proper order based upon
  61   each of the library instances own dependencies.
  62
  63   @param  ImageHandle  The image handle of the STANDALONE MM Core.
  64   @param  SystemTable  A pointer to the EFI System Table.
  65
  66 **/
  67 VOID
  68 EFIAPI
  69 ProcessLibraryConstructorList (
  70   IN EFI_HANDLE           ImageHandle,
  71   IN EFI_MM_SYSTEM_TABLE  *MmSystemTable
  72   );
  73
  74 /**
  75   Autogenerated function that calls a set of module entry points.
  76
  77   This function must be called by _ModuleEntryPoint().
  78   This function calls the set of module entry points.
  79   This function is auto generated by build tools and those build tools are responsible
  80   for collecting the module entry points and calling them in a specified order.
  81
  82   @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase.
  83
  84 **/
  85 VOID
  86 EFIAPI
  87 ProcessModuleEntryPointList (
  88   IN VOID  *HobStart
  89   );
  90
  91 #endif