MdeModulePkg/Core/DxeIplPeim/DxeIpl.h

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