MdePkg/Include/Library/DxeCoreEntryPoint.h

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