Clean up DEC files:
[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
cd5ebaa0
HT
5Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
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
b0d803fe 30\r
b98da1b1 31#include <Guid/MemoryTypeInformation.h>\r
30c8f861 32#include <Guid/MemoryAllocationHob.h>\r
b0d803fe 33#include <Guid/FirmwareFileSystem2.h>\r
34\r
859b72fa
A
35#include <Library/DebugLib.h>\r
36#include <Library/PeimEntryPoint.h>\r
37#include <Library/BaseLib.h>\r
38#include <Library/HobLib.h>\r
39#include <Library/PeiServicesLib.h>\r
40#include <Library/ReportStatusCodeLib.h>\r
859b72fa 41#include <Library/UefiDecompressLib.h>\r
18fd8d65 42#include <Library/ExtractGuidedSectionLib.h>\r
859b72fa
A
43#include <Library/BaseMemoryLib.h>\r
44#include <Library/MemoryAllocationLib.h>\r
45#include <Library/PcdLib.h>\r
4fb31c2c 46#include <Library/S3Lib.h>\r
47#include <Library/RecoveryLib.h>\r
e7af83ae 48#include <Library/DebugAgentLib.h>\r
95276127 49\r
50#define STACK_SIZE 0x20000\r
51#define BSP_STORE_SIZE 0x4000\r
52\r
b98da1b1 53\r
9b937a73 54//\r
e7af83ae 55// This PPI is installed to indicate the end of the PEI usage of memory\r
9b937a73 56//\r
57extern CONST EFI_PEI_PPI_DESCRIPTOR gEndOfPeiSignalPpi;\r
58\r
59\r
91d92e25 60/**\r
b6b98e91 61 Searches DxeCore in all firmware Volumes and loads the first\r
62 instance that contains DxeCore.\r
91d92e25 63\r
9b937a73 64 @return FileHandle of DxeCore to load DxeCore.\r
e7af83ae 65\r
91d92e25 66**/\r
9b937a73 67EFI_PEI_FILE_HANDLE\r
288f9b38 68DxeIplFindDxeCore (\r
b6b98e91 69 VOID\r
f45af90b 70 );\r
95276127 71\r
91d92e25 72\r
91d92e25 73/**\r
e7af83ae 74 Main entry point to last PEIM\r
75\r
91d92e25 76 @param This Entry point for DXE IPL PPI\r
77 @param PeiServices General purpose services available to every PEIM.\r
78 @param HobList Address to the Pei HOB list\r
e7af83ae 79\r
80 @return EFI_SUCCESS DXE core was successfully loaded.\r
91d92e25 81 @return EFI_OUT_OF_RESOURCES There are not enough resources to load DXE core.\r
82\r
83**/\r
95276127 84EFI_STATUS\r
85EFIAPI\r
86DxeLoadCore (\r
1f3a753e 87 IN CONST EFI_DXE_IPL_PPI *This,\r
95276127 88 IN EFI_PEI_SERVICES **PeiServices,\r
89 IN EFI_PEI_HOB_POINTERS HobList\r
90 );\r
91\r
91d92e25 92\r
93\r
94/**\r
95 Transfers control to DxeCore.\r
96\r
97 This function performs a CPU architecture specific operations to execute\r
98 the entry point of DxeCore with the parameters of HobList.\r
48557c65 99 It also installs EFI_END_OF_PEI_PPI to signal the end of PEI phase.\r
91d92e25 100\r
48557c65 101 @param DxeCoreEntryPoint The entry point of DxeCore.\r
91d92e25 102 @param HobList The start of HobList passed to DxeCore.\r
91d92e25 103\r
104**/\r
95276127 105VOID\r
106HandOffToDxeCore (\r
107 IN EFI_PHYSICAL_ADDRESS DxeCoreEntryPoint,\r
9b937a73 108 IN EFI_PEI_HOB_POINTERS HobList\r
95276127 109 );\r
110\r
91d92e25 111\r
112\r
113/**\r
114 Updates the Stack HOB passed to DXE phase.\r
115\r
116 This function traverses the whole HOB list and update the stack HOB to\r
117 reflect the real stack that is used by DXE core.\r
118\r
119 @param BaseAddress The lower address of stack used by DxeCore.\r
120 @param Length The length of stack used by DxeCore.\r
121\r
122**/\r
30c8f861 123VOID\r
124UpdateStackHob (\r
125 IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
126 IN UINT64 Length\r
127 );\r
128\r
b98da1b1 129/**\r
130 The ExtractSection() function processes the input section and\r
131 returns a pointer to the section contents. If the section being\r
132 extracted does not require processing (if the section\r
133 GuidedSectionHeader.Attributes has the\r
134 EFI_GUIDED_SECTION_PROCESSING_REQUIRED field cleared), then\r
135 OutputBuffer is just updated to point to the start of the\r
136 section's contents. Otherwise, *Buffer must be allocated\r
137 from PEI permanent memory.\r
138\r
139 @param This Indicates the\r
140 EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance.\r
141 Buffer containing the input GUIDed section to be\r
142 processed. OutputBuffer OutputBuffer is\r
143 allocated from PEI permanent memory and contains\r
144 the new section stream.\r
145 @param InputSection A pointer to the input buffer, which contains\r
146 the input section to be processed.\r
147 @param OutputBuffer A pointer to a caller-allocated buffer, whose\r
148 size is specified by the contents of OutputSize.\r
149 @param OutputSize A pointer to a caller-allocated\r
150 UINTN in which the size of *OutputBuffer\r
151 allocation is stored. If the function\r
152 returns anything other than EFI_SUCCESS,\r
153 the value of OutputSize is undefined.\r
154 @param AuthenticationStatus A pointer to a caller-allocated\r
155 UINT32 that indicates the\r
156 authentication status of the\r
157 output buffer. If the input\r
158 section's GuidedSectionHeader.\r
159 Attributes field has the\r
e7af83ae 160 EFI_GUIDED_SECTION_AUTH_STATUS_VALID\r
b98da1b1 161 bit as clear,\r
162 AuthenticationStatus must return\r
163 zero. These bits reflect the\r
164 status of the extraction\r
165 operation. If the function\r
166 returns anything other than\r
167 EFI_SUCCESS, the value of\r
168 AuthenticationStatus is\r
169 undefined.\r
e7af83ae 170\r
b98da1b1 171 @retval EFI_SUCCESS The InputSection was\r
172 successfully processed and the\r
173 section contents were returned.\r
e7af83ae 174\r
b98da1b1 175 @retval EFI_OUT_OF_RESOURCES The system has insufficient\r
176 resources to process the request.\r
e7af83ae 177\r
b98da1b1 178 @retval EFI_INVALID_PARAMETER The GUID in InputSection does\r
179 not match this instance of the\r
180 GUIDed Section Extraction PPI.\r
91d92e25 181\r
b98da1b1 182**/\r
183EFI_STATUS\r
6d3ea23f 184EFIAPI\r
b98da1b1 185CustomGuidedSectionExtract (\r
186 IN CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,\r
187 IN CONST VOID *InputSection,\r
188 OUT VOID **OutputBuffer,\r
189 OUT UINTN *OutputSize,\r
190 OUT UINT32 *AuthenticationStatus\r
191 );\r
192\r
193\r
194/**\r
195 Decompresses a section to the output buffer.\r
196\r
48557c65 197 This function looks up the compression type field in the input section and\r
b98da1b1 198 applies the appropriate compression algorithm to compress the section to a\r
199 callee allocated buffer.\r
e7af83ae 200\r
b98da1b1 201 @param This Points to this instance of the\r
202 EFI_PEI_DECOMPRESS_PEI PPI.\r
203 @param CompressionSection Points to the compressed section.\r
204 @param OutputBuffer Holds the returned pointer to the decompressed\r
205 sections.\r
206 @param OutputSize Holds the returned size of the decompress\r
207 section streams.\r
e7af83ae 208\r
b98da1b1 209 @retval EFI_SUCCESS The section was decompressed successfully.\r
210 OutputBuffer contains the resulting data and\r
211 OutputSize contains the resulting size.\r
212\r
213**/\r
214EFI_STATUS\r
e7af83ae 215EFIAPI\r
b98da1b1 216Decompress (\r
217 IN CONST EFI_PEI_DECOMPRESS_PPI *This,\r
218 IN CONST EFI_COMPRESSION_SECTION *CompressionSection,\r
219 OUT VOID **OutputBuffer,\r
220 OUT UINTN *OutputSize\r
221 );\r
91d92e25 222\r
95276127 223#endif\r