]> git.proxmox.com Git - mirror_edk2.git/blame - StandaloneMmPkg/Include/Library/StandaloneMmCoreEntryPoint.h
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / StandaloneMmPkg / Include / Library / StandaloneMmCoreEntryPoint.h
CommitLineData
6b46d772
SV
1/** @file\r
2 Module entry point library for STANDALONE MM core.\r
3\r
4Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
5Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.<BR>\r
6\r
86094561 7SPDX-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
17extern VOID *gHobList;\r
18\r
6b46d772
SV
19/**\r
20 The entry point of PE/COFF Image for the STANDALONE MM Core.\r
21\r
22 This function is the entry point for the STANDALONE MM Core. This function is required to call\r
23 ProcessModuleEntryPointList() and ProcessModuleEntryPointList() is never expected to return.\r
24 The STANDALONE MM Core is responsible for calling ProcessLibraryConstructorList() as soon as the EFI\r
25 System Table and the image handle for the STANDALONE MM Core itself have been established.\r
26 If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.\r
27\r
28 @param HobStart Pointer to the beginning of the HOB List passed in from the PEI Phase.\r
29\r
30**/\r
31VOID\r
32EFIAPI\r
33_ModuleEntryPoint (\r
34 IN VOID *HobStart\r
35 );\r
36\r
6b46d772
SV
37/**\r
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
41\r
42 @param HobStart Pointer to the beginning of the HOB List passed in from the PEI Phase.\r
43\r
44**/\r
45VOID\r
46EFIAPI\r
47EfiMain (\r
48 IN VOID *HobStart\r
49 );\r
50\r
6b46d772
SV
51/**\r
52 Auto generated function that calls the library constructors for all of the module's dependent libraries.\r
53\r
54 This function must be called by _ModuleEntryPoint().\r
55 This function calls the set of library constructors for the set of library instances\r
56 that a module depends on. This includes library instances that a module depends on\r
57 directly and library instances that a module depends on indirectly through other\r
58 libraries. This function is auto generated by build tools and those build tools are\r
59 responsible for collecting the set of library instances, determine which ones have\r
60 constructors, and calling the library constructors in the proper order based upon\r
61 each of the library instances own dependencies.\r
62\r
63 @param ImageHandle The image handle of the STANDALONE MM Core.\r
64 @param SystemTable A pointer to the EFI System Table.\r
65\r
66**/\r
67VOID\r
68EFIAPI\r
69ProcessLibraryConstructorList (\r
91415a36
MK
70 IN EFI_HANDLE ImageHandle,\r
71 IN EFI_MM_SYSTEM_TABLE *MmSystemTable\r
6b46d772
SV
72 );\r
73\r
6b46d772
SV
74/**\r
75 Autogenerated function that calls a set of module entry points.\r
76\r
77 This function must be called by _ModuleEntryPoint().\r
78 This function calls the set of module entry points.\r
79 This function is auto generated by build tools and those build tools are responsible\r
80 for collecting the module entry points and calling them in a specified order.\r
81\r
82 @param HobStart Pointer to the beginning of the HOB List passed in from the PEI Phase.\r
83\r
84**/\r
85VOID\r
86EFIAPI\r
87ProcessModuleEntryPointList (\r
88 IN VOID *HobStart\r
89 );\r
90\r
91#endif\r