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