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