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