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