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