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