MdeModulePkg/DxeLoadFunc: Add use case for new Perf macro
[mirror_edk2.git] / MdeModulePkg / Core / DxeIplPeim / DxeIpl.h
CommitLineData
96226baa 1/** @file\r
fbc81c1e 2 Master header file for DxeIpl PEIM. All source files in this module should\r
48557c65 3 include this file for common definitions.\r
95276127 4\r
98d20e44 5Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
cd5ebaa0 6This program and the accompanying materials\r
95276127 7are licensed and made available under the terms and conditions of the BSD License\r
8which accompanies this distribution. The full text of the license may be found at\r
9http://opensource.org/licenses/bsd-license.php\r
10\r
11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
797a9d67 14**/\r
95276127 15\r
16#ifndef __PEI_DXEIPL_H__\r
17#define __PEI_DXEIPL_H__\r
18\r
859b72fa
A
19#include <PiPei.h>\r
20#include <Ppi/DxeIpl.h>\r
859b72fa 21#include <Ppi/EndOfPeiPhase.h>\r
859b72fa 22#include <Ppi/MemoryDiscovered.h>\r
b74350e9 23#include <Ppi/ReadOnlyVariable2.h>\r
b0d803fe 24#include <Ppi/Decompress.h>\r
25#include <Ppi/FirmwareVolumeInfo.h>\r
b98da1b1 26#include <Ppi/GuidedSectionExtraction.h>\r
28efc722 27#include <Ppi/LoadFile.h>\r
77215d10 28#include <Ppi/S3Resume2.h>\r
28efc722 29#include <Ppi/RecoveryModule.h>\r
57f360f2 30#include <Ppi/VectorHandoffInfo.h>\r
b0d803fe 31\r
b98da1b1 32#include <Guid/MemoryTypeInformation.h>\r
30c8f861 33#include <Guid/MemoryAllocationHob.h>\r
b0d803fe 34#include <Guid/FirmwareFileSystem2.h>\r
35\r
859b72fa
A
36#include <Library/DebugLib.h>\r
37#include <Library/PeimEntryPoint.h>\r
38#include <Library/BaseLib.h>\r
39#include <Library/HobLib.h>\r
40#include <Library/PeiServicesLib.h>\r
41#include <Library/ReportStatusCodeLib.h>\r
859b72fa 42#include <Library/UefiDecompressLib.h>\r
18fd8d65 43#include <Library/ExtractGuidedSectionLib.h>\r
859b72fa
A
44#include <Library/BaseMemoryLib.h>\r
45#include <Library/MemoryAllocationLib.h>\r
46#include <Library/PcdLib.h>\r
4fb31c2c 47#include <Library/S3Lib.h>\r
48#include <Library/RecoveryLib.h>\r
e7af83ae 49#include <Library/DebugAgentLib.h>\r
bdfbe63e 50#include <Library/PeiServicesTablePointerLib.h>\r
98d20e44 51#include <Library/PerformanceLib.h>\r
95276127 52\r
53#define STACK_SIZE 0x20000\r
54#define BSP_STORE_SIZE 0x4000\r
55\r
b98da1b1 56\r
9b937a73 57//\r
e7af83ae 58// This PPI is installed to indicate the end of the PEI usage of memory\r
9b937a73 59//\r
60extern CONST EFI_PEI_PPI_DESCRIPTOR gEndOfPeiSignalPpi;\r
61\r
ebaafbe6
EC
62/**\r
63 This function installs the PPIs that require permanent memory.\r
64\r
65 @param PeiServices Indirect reference to the PEI Services Table.\r
66 @param NotifyDescriptor Address of the notification descriptor data structure.\r
67 @param Ppi Address of the PPI that was installed.\r
68\r
69 @return EFI_SUCCESS The PPIs were installed successfully.\r
70 @return Others Some error occurs during the execution of this function.\r
71\r
72**/\r
73EFI_STATUS\r
74EFIAPI\r
75InstallIplPermanentMemoryPpis (\r
76 IN EFI_PEI_SERVICES **PeiServices,\r
77 IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r
78 IN VOID *Ppi\r
79 );\r
9b937a73 80\r
91d92e25 81/**\r
b6b98e91 82 Searches DxeCore in all firmware Volumes and loads the first\r
83 instance that contains DxeCore.\r
91d92e25 84\r
9b937a73 85 @return FileHandle of DxeCore to load DxeCore.\r
e7af83ae 86\r
91d92e25 87**/\r
9b937a73 88EFI_PEI_FILE_HANDLE\r
288f9b38 89DxeIplFindDxeCore (\r
b6b98e91 90 VOID\r
f45af90b 91 );\r
95276127 92\r
91d92e25 93\r
91d92e25 94/**\r
e7af83ae 95 Main entry point to last PEIM\r
96\r
91d92e25 97 @param This Entry point for DXE IPL PPI\r
98 @param PeiServices General purpose services available to every PEIM.\r
99 @param HobList Address to the Pei HOB list\r
e7af83ae 100\r
101 @return EFI_SUCCESS DXE core was successfully loaded.\r
91d92e25 102 @return EFI_OUT_OF_RESOURCES There are not enough resources to load DXE core.\r
103\r
104**/\r
95276127 105EFI_STATUS\r
106EFIAPI\r
107DxeLoadCore (\r
1f3a753e 108 IN CONST EFI_DXE_IPL_PPI *This,\r
95276127 109 IN EFI_PEI_SERVICES **PeiServices,\r
110 IN EFI_PEI_HOB_POINTERS HobList\r
111 );\r
112\r
91d92e25 113\r
114\r
115/**\r
116 Transfers control to DxeCore.\r
117\r
118 This function performs a CPU architecture specific operations to execute\r
119 the entry point of DxeCore with the parameters of HobList.\r
48557c65 120 It also installs EFI_END_OF_PEI_PPI to signal the end of PEI phase.\r
91d92e25 121\r
48557c65 122 @param DxeCoreEntryPoint The entry point of DxeCore.\r
91d92e25 123 @param HobList The start of HobList passed to DxeCore.\r
91d92e25 124\r
125**/\r
95276127 126VOID\r
127HandOffToDxeCore (\r
128 IN EFI_PHYSICAL_ADDRESS DxeCoreEntryPoint,\r
9b937a73 129 IN EFI_PEI_HOB_POINTERS HobList\r
95276127 130 );\r
131\r
91d92e25 132\r
133\r
134/**\r
135 Updates the Stack HOB passed to DXE phase.\r
136\r
137 This function traverses the whole HOB list and update the stack HOB to\r
138 reflect the real stack that is used by DXE core.\r
139\r
140 @param BaseAddress The lower address of stack used by DxeCore.\r
141 @param Length The length of stack used by DxeCore.\r
142\r
143**/\r
30c8f861 144VOID\r
145UpdateStackHob (\r
146 IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
147 IN UINT64 Length\r
148 );\r
149\r
b98da1b1 150/**\r
151 The ExtractSection() function processes the input section and\r
152 returns a pointer to the section contents. If the section being\r
153 extracted does not require processing (if the section\r
154 GuidedSectionHeader.Attributes has the\r
155 EFI_GUIDED_SECTION_PROCESSING_REQUIRED field cleared), then\r
156 OutputBuffer is just updated to point to the start of the\r
157 section's contents. Otherwise, *Buffer must be allocated\r
158 from PEI permanent memory.\r
159\r
160 @param This Indicates the\r
161 EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance.\r
162 Buffer containing the input GUIDed section to be\r
163 processed. OutputBuffer OutputBuffer is\r
164 allocated from PEI permanent memory and contains\r
165 the new section stream.\r
166 @param InputSection A pointer to the input buffer, which contains\r
167 the input section to be processed.\r
168 @param OutputBuffer A pointer to a caller-allocated buffer, whose\r
169 size is specified by the contents of OutputSize.\r
170 @param OutputSize A pointer to a caller-allocated\r
171 UINTN in which the size of *OutputBuffer\r
172 allocation is stored. If the function\r
173 returns anything other than EFI_SUCCESS,\r
174 the value of OutputSize is undefined.\r
175 @param AuthenticationStatus A pointer to a caller-allocated\r
176 UINT32 that indicates the\r
177 authentication status of the\r
178 output buffer. If the input\r
179 section's GuidedSectionHeader.\r
180 Attributes field has the\r
e7af83ae 181 EFI_GUIDED_SECTION_AUTH_STATUS_VALID\r
b98da1b1 182 bit as clear,\r
183 AuthenticationStatus must return\r
184 zero. These bits reflect the\r
185 status of the extraction\r
186 operation. If the function\r
187 returns anything other than\r
188 EFI_SUCCESS, the value of\r
189 AuthenticationStatus is\r
190 undefined.\r
e7af83ae 191\r
b98da1b1 192 @retval EFI_SUCCESS The InputSection was\r
193 successfully processed and the\r
194 section contents were returned.\r
e7af83ae 195\r
b98da1b1 196 @retval EFI_OUT_OF_RESOURCES The system has insufficient\r
197 resources to process the request.\r
e7af83ae 198\r
b98da1b1 199 @retval EFI_INVALID_PARAMETER The GUID in InputSection does\r
200 not match this instance of the\r
201 GUIDed Section Extraction PPI.\r
91d92e25 202\r
b98da1b1 203**/\r
204EFI_STATUS\r
6d3ea23f 205EFIAPI\r
b98da1b1 206CustomGuidedSectionExtract (\r
207 IN CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,\r
208 IN CONST VOID *InputSection,\r
209 OUT VOID **OutputBuffer,\r
210 OUT UINTN *OutputSize,\r
211 OUT UINT32 *AuthenticationStatus\r
212 );\r
213\r
214\r
215/**\r
216 Decompresses a section to the output buffer.\r
217\r
48557c65 218 This function looks up the compression type field in the input section and\r
b98da1b1 219 applies the appropriate compression algorithm to compress the section to a\r
220 callee allocated buffer.\r
e7af83ae 221\r
b98da1b1 222 @param This Points to this instance of the\r
223 EFI_PEI_DECOMPRESS_PEI PPI.\r
224 @param CompressionSection Points to the compressed section.\r
225 @param OutputBuffer Holds the returned pointer to the decompressed\r
226 sections.\r
227 @param OutputSize Holds the returned size of the decompress\r
228 section streams.\r
e7af83ae 229\r
b98da1b1 230 @retval EFI_SUCCESS The section was decompressed successfully.\r
231 OutputBuffer contains the resulting data and\r
232 OutputSize contains the resulting size.\r
233\r
234**/\r
235EFI_STATUS\r
e7af83ae 236EFIAPI\r
b98da1b1 237Decompress (\r
238 IN CONST EFI_PEI_DECOMPRESS_PPI *This,\r
239 IN CONST EFI_COMPRESSION_SECTION *CompressionSection,\r
240 OUT VOID **OutputBuffer,\r
241 OUT UINTN *OutputSize\r
242 );\r
91d92e25 243\r
95276127 244#endif\r