]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | Module entry point library for PEI core.\r | |
3 | \r | |
4 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r | |
5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
6 | \r | |
7 | **/\r | |
8 | \r | |
9 | #ifndef __MODULE_ENTRY_POINT_H__\r | |
10 | #define __MODULE_ENTRY_POINT_H__\r | |
11 | \r | |
12 | /**\r | |
13 | The entry point of PE/COFF Image for the PEI Core.\r | |
14 | \r | |
15 | This function is the entry point for the PEI Foundation, which allows the SEC phase\r | |
16 | to pass information about the stack, temporary RAM and the Boot Firmware Volume.\r | |
17 | In addition, it also allows the SEC phase to pass services and data forward for use\r | |
18 | during the PEI phase in the form of one or more PPIs.\r | |
19 | There is no limit to the number of additional PPIs that can be passed from SEC into\r | |
20 | the PEI Foundation. As part of its initialization phase, the PEI Foundation will add\r | |
21 | these SEC-hosted PPIs to its PPI database such that both the PEI Foundation and any\r | |
22 | modules can leverage the associated service calls and/or code in these early PPIs.\r | |
23 | This function is required to call ProcessModuleEntryPointList() with the Context\r | |
24 | parameter set to NULL. ProcessModuleEntryPoint() is never expected to return.\r | |
25 | The PEI Core is responsible for calling ProcessLibraryConstructorList() as soon as\r | |
26 | the PEI Services Table and the file handle for the PEI Core itself have been established.\r | |
27 | If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.\r | |
28 | \r | |
29 | @param SecCoreData Points to a data structure containing information about the PEI\r | |
30 | core's operating environment, such as the size and location of\r | |
31 | temporary RAM, the stack location and the BFV location.\r | |
32 | \r | |
33 | @param PpiList Points to a list of one or more PPI descriptors to be installed\r | |
34 | initially by the PEI core. An empty PPI list consists of a single\r | |
35 | descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.\r | |
36 | As part of its initialization phase, the PEI Foundation will add\r | |
37 | these SEC-hosted PPIs to its PPI database such that both the PEI\r | |
38 | Foundation and any modules can leverage the associated service calls\r | |
39 | and/or code in these early PPIs.\r | |
40 | \r | |
41 | **/\r | |
42 | VOID\r | |
43 | EFIAPI\r | |
44 | _ModuleEntryPoint (\r | |
45 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r | |
46 | IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList\r | |
47 | );\r | |
48 | \r | |
49 | /**\r | |
50 | Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().\r | |
51 | \r | |
52 | This function is required to call _ModuleEntryPoint() passing in SecCoreData and PpiList.\r | |
53 | \r | |
54 | @param SecCoreData Points to a data structure containing information about the PEI core's\r | |
55 | operating environment, such as the size and location of temporary RAM,\r | |
56 | the stack location and the BFV location.\r | |
57 | \r | |
58 | @param PpiList Points to a list of one or more PPI descriptors to be installed\r | |
59 | initially by the PEI core. An empty PPI list consists of a single\r | |
60 | descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.\r | |
61 | As part of its initialization phase, the PEI Foundation will add these\r | |
62 | SEC-hosted PPIs to its PPI database such that both the PEI Foundation\r | |
63 | and any modules can leverage the associated service calls and/or code\r | |
64 | in these early PPIs.\r | |
65 | \r | |
66 | **/\r | |
67 | VOID\r | |
68 | EFIAPI\r | |
69 | EfiMain (\r | |
70 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r | |
71 | IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList\r | |
72 | );\r | |
73 | \r | |
74 | /**\r | |
75 | Autogenerated function that calls the library constructors for all of the module's\r | |
76 | dependent libraries.\r | |
77 | \r | |
78 | This function must be called by the PEI Core once an initial PEI Services Table has been established.\r | |
79 | This function calls the set of library constructors for the set of library instances that a\r | |
80 | module depends on. This include library instances that a module depends on directly and library\r | |
81 | instances that a module depends on indirectly through other libraries.\r | |
82 | This function is autogenerated by build tools and those build tools are responsible for collecting\r | |
83 | the set of library instances, determining which ones have constructors, and calling the library\r | |
84 | constructors in the proper order based upon the dependencies of each of the library instances.\r | |
85 | The PEI Core must call this function with a NULL FileHandle value as soon as the initial PEI\r | |
86 | Services Table has been established.\r | |
87 | \r | |
88 | @param FileHandle Handle of the file being invoked.\r | |
89 | @param PeiServices Describes the list of possible PEI Services.\r | |
90 | \r | |
91 | **/\r | |
92 | VOID\r | |
93 | EFIAPI\r | |
94 | ProcessLibraryConstructorList (\r | |
95 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
96 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
97 | );\r | |
98 | \r | |
99 | /**\r | |
100 | Autogenerated function that calls a set of module entry points.\r | |
101 | \r | |
102 | This function must be called by _ModuleEntryPoint().\r | |
103 | This function calls the set of module entry points.\r | |
104 | This function is autogenerated by build tools and those build tools are responsible\r | |
105 | for collecting the module entry points and calling them in a specified order.\r | |
106 | \r | |
107 | @param SecCoreData Points to a data structure containing information about the PEI\r | |
108 | core's operating environment, such as the size and location of\r | |
109 | temporary RAM, the stack location and the BFV location.\r | |
110 | \r | |
111 | @param PpiList Points to a list of one or more PPI descriptors to be installed\r | |
112 | initially by the PEI core. An empty PPI list consists of a single\r | |
113 | descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.\r | |
114 | As part of its initialization phase, the PEI Foundation will add\r | |
115 | these SEC-hosted PPIs to its PPI database such that both the PEI\r | |
116 | Foundation and any modules can leverage the associated service calls\r | |
117 | and/or code in these early PPIs.\r | |
118 | @param Context A pointer to a private context structure defined by the PEI Core\r | |
119 | implementation. The implementation of _ModuleEntryPoint() must set\r | |
120 | this parameter is NULL to indicate that this is the first PEI phase.\r | |
121 | \r | |
122 | **/\r | |
123 | VOID\r | |
124 | EFIAPI\r | |
125 | ProcessModuleEntryPointList (\r | |
126 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r | |
127 | IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,\r | |
128 | IN VOID *Context\r | |
129 | );\r | |
130 | \r | |
131 | #endif\r |