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