Coding style fix.
[mirror_edk2.git] / MdePkg / Include / Library / PeiCoreEntryPoint.h
CommitLineData
fb3df220 1/** @file\r
2 Entry point to the PEI Core\r
3\r
4Copyright (c) 2006, Intel Corporation<BR>\r
5All rights reserved. This program and the accompanying materials\r
6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#ifndef __MODULE_ENTRY_POINT_H__\r
16#define __MODULE_ENTRY_POINT_H__\r
17\r
18/**\r
c7d265a9 19\r
fb3df220 20 Enrty point to PEI core.\r
21\r
c7d265a9 22 @param SecCoreData Points to a data structure containing\r
23 information about the PEI core's\r
24 operating environment, such as the size\r
25 and location of temporary RAM, the stack\r
26 location and the BFV location. The type\r
27 EFI_SEC_PEI_HAND_OFF is\r
28\r
29 @param PpiList Points to a list of one or more PPI\r
30 descriptors to be installed initially by\r
31 the PEI core. An empty PPI list consists\r
32 of a single descriptor with the end-tag\r
33 EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.\r
34 As part of its initialization phase, the\r
35 PEI Foundation will add these SEC-hosted\r
36 PPIs to its PPI database such that both\r
37 the PEI Foundation and any modules can\r
38 leverage the associated service calls\r
39 and/or code in these early PPIs.\r
fb3df220 40\r
41**/\r
c7d265a9 42VOID\r
43EFIAPI \r
44_ModuleEntryPoint(\r
fb3df220 45 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r
46 IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList\r
2278f5f3 47 );\r
fb3df220 48\r
49/**\r
50 Wrapper of enrty point to PEI core.\r
51\r
1646bcd5 52 @param SecCoreData Points to a data structure containing\r
53 information about the PEI core's\r
54 operating environment, such as the size\r
55 and location of temporary RAM, the stack\r
56 location and the BFV location. The type\r
57 EFI_SEC_PEI_HAND_OFF is\r
58\r
59 @param PpiList Points to a list of one or more PPI\r
60 descriptors to be installed initially by\r
61 the PEI core. An empty PPI list consists\r
62 of a single descriptor with the end-tag\r
63 EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.\r
64 As part of its initialization phase, the\r
65 PEI Foundation will add these SEC-hosted\r
66 PPIs to its PPI database such that both\r
67 the PEI Foundation and any modules can\r
68 leverage the associated service calls\r
69 and/or code in these early PPIs.\r
fb3df220 70 \r
71 @return Status returned by entry points of core and drivers. \r
72\r
73**/\r
c7d265a9 74VOID\r
fb3df220 75EFIAPI\r
76EfiMain (\r
77 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r
78 IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList\r
79 );\r
80\r
81/**\r
82 Call constructs for all libraries. Automatics Generated by tool.\r
83\r
84 @param FfsHeader Pointer to header of FFS.\r
85 @param PeiServices Pointer to the PEI Services Table.\r
86\r
87**/\r
88VOID\r
89EFIAPI\r
90ProcessLibraryConstructorList (\r
c6f4d4c9 91 IN EFI_PEI_FILE_HANDLE *FfsHeader,\r
fb3df220 92 IN EFI_PEI_SERVICES **PeiServices\r
93 );\r
94\r
95\r
96/**\r
97 Call the list of driver entry points. Automatics Generated by tool.\r
98\r
1646bcd5 99 @param SecCoreData Points to a data structure containing\r
100 information about the PEI core's\r
101 operating environment, such as the size\r
102 and location of temporary RAM, the stack\r
103 location and the BFV location. The type\r
104 EFI_SEC_PEI_HAND_OFF is\r
105\r
106 @param PpiList Points to a list of one or more PPI\r
107 descriptors to be installed initially by\r
108 the PEI core. An empty PPI list consists\r
109 of a single descriptor with the end-tag\r
110 EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.\r
111 As part of its initialization phase, the\r
112 PEI Foundation will add these SEC-hosted\r
113 PPIs to its PPI database such that both\r
114 the PEI Foundation and any modules can\r
115 leverage the associated service calls\r
116 and/or code in these early PPIs.\r
117 @param OldCoreData Pointer to Original startup information.\r
fb3df220 118\r
fb3df220 119**/\r
c7d265a9 120VOID\r
fb3df220 121EFIAPI\r
122ProcessModuleEntryPointList (\r
123 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r
124 IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,\r
125 IN VOID *OldCoreData\r
126 );\r
127\r
128#endif\r