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