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