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