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