90d1d33d5e506d6c6ac28d60f0aca1740928802b
[mirror_edk2.git] / MdePkg / Include / Library / DxeCoreEntryPoint.h
1 /** @file
2 Module entry point library for DXE core.
3
4 Copyright (c) 2006 - 2008, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #ifndef __MODULE_ENTRY_POINT_H__
16 #define __MODULE_ENTRY_POINT_H__
17
18 ///
19 /// Global variable that contains a pointer to the Hob List passed into the DXE Core entry point.
20 ///
21 extern VOID *gHobList;
22
23
24 /**
25 The entry point of PE/COFF Image for the DXE Core.
26
27 This function is the entry point for the DXE Core. This function is required
28 to call ProcessModuleEntryPointList() and ProcessModuleEntryPoint() is never
29 expected to return. The DXE Core is responsible for calling ProcessLibraryConstructorList()
30 as soon as the EFI System Table and the image handle for the DXE Core itself have
31 been established.
32 If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.
33
34 @param HobStart Pointer to the beginning of the HOB List passed in from the PEI Phase.
35
36 **/
37 VOID
38 EFIAPI
39 _ModuleEntryPoint (
40 IN VOID *HobStart
41 );
42
43
44 /**
45 Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().
46
47 This function is required to call _ModuleEntryPoint() passing in HobStart.
48
49 @param HobStart Pointer to the beginning of the HOB List passed in from the PEI Phase.
50
51 **/
52 VOID
53 EFIAPI
54 EfiMain (
55 IN VOID *HobStart
56 );
57
58
59 /**
60 Autogenerated function that calls the library constructors for all of the module's dependent libraries.
61
62 This function must be called by _ModuleEntryPoint().
63 This function calls the set of library constructors for the set of library instances
64 that a module depends on. This includes library instances that a module depends on
65 directly and library instances that a module depends on indirectly through other
66 libraries. This function is autogenerated by build tools and those build tools are
67 responsible for collecting the set of library instances, determine which ones have
68 constructors, and calling the library constructors in the proper order based upon
69 each of the library instances own dependencies.
70
71 @param ImageHandle The image handle of the DXE Core.
72 @param SystemTable A pointer to the EFI System Table.
73
74 **/
75 VOID
76 EFIAPI
77 ProcessLibraryConstructorList (
78 IN EFI_HANDLE ImageHandle,
79 IN EFI_SYSTEM_TABLE *SystemTable
80 );
81
82
83 /**
84 Autogenerated function that calls a set of module entry points.
85
86 This function must be called by _ModuleEntryPoint().
87 This function calls the set of module entry points.
88 This function is autogenerated by build tools and those build tools are responsible
89 for collecting the module entry points and calling them in a specified order.
90
91 @param HobStart Pointer to the beginning of the HOB List passed in from the PEI Phase.
92
93 **/
94 VOID
95 EFIAPI
96 ProcessModuleEntryPointList (
97 IN VOID *HobStart
98 );
99
100 #endif