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