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