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 defininitions.
   4
   5 Copyright (c) 2006 - 2008, 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
  28 #include <Guid/MemoryTypeInformation.h>
  29 #include <Guid/MemoryAllocationHob.h>
  30 #include <Guid/FirmwareFileSystem2.h>
  31
  32 #include <Library/DebugLib.h>
  33 #include <Library/PeimEntryPoint.h>
  34 #include <Library/BaseLib.h>
  35 #include <Library/HobLib.h>
  36 #include <Library/PeiServicesLib.h>
  37 #include <Library/ReportStatusCodeLib.h>
  38 #include <Library/CacheMaintenanceLib.h>
  39 #include <Library/UefiDecompressLib.h>
  40 #include <Library/ExtractGuidedSectionLib.h>
  41 #include <Library/PeiServicesTablePointerLib.h>
  42 #include <Library/BaseMemoryLib.h>
  43 #include <Library/MemoryAllocationLib.h>
  44 #include <Library/PcdLib.h>
  45 #include <Library/PeCoffLib.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 macro aligns the ActualSize with a given alignment and is used to
  55 // calculate the size an image occupies.
  56 //
  57 #define GET_OCCUPIED_SIZE(ActualSize, Alignment) ((ActualSize + (Alignment - 1)) & ~(Alignment - 1))
  58
  59 //
  60 // Indicate whether DxeIpl has been shadowed to memory.
  61 //
  62 extern BOOLEAN gInMemory;
  63
  64 //
  65 // This PPI is installed to indicate the end of the PEI usage of memory
  66 //
  67 extern CONST EFI_PEI_PPI_DESCRIPTOR gEndOfPeiSignalPpi;
  68
  69
  70
  71 /**
  72    Loads and relocates a PE/COFF image into memory.
  73
  74    @param FileHandle        The image file handle
  75    @param ImageAddress      The base address of the relocated PE/COFF image
  76    @param ImageSize         The size of the relocated PE/COFF image
  77    @param EntryPoint        The entry point of the relocated PE/COFF image
  78
  79    @return EFI_SUCCESS           The file was loaded and relocated
  80    @return EFI_OUT_OF_RESOURCES  There was not enough memory to load and relocate the PE/COFF file
  81
  82 **/
  83 EFI_STATUS
  84 PeiLoadFile (
  85   IN  EFI_PEI_FILE_HANDLE                       FileHandle,
  86   OUT EFI_PHYSICAL_ADDRESS                      *ImageAddress,
  87   OUT UINT64                                    *ImageSize,
  88   OUT EFI_PHYSICAL_ADDRESS                      *EntryPoint
  89   );
  90
  91
  92
  93 /**
  94    Searches DxeCore in all firmware Volumes and loads the first
  95    instance that contains DxeCore.
  96
  97    @return FileHandle of DxeCore to load DxeCore.
  98
  99 **/
 100 EFI_PEI_FILE_HANDLE
 101 DxeIplFindDxeCore (
 102   VOID
 103   );
 104
 105
 106 /**
 107    This function simply retrieves the function pointer of ImageRead in
 108    ImageContext structure.
 109
 110    @param ImageContext       A pointer to the structure of
 111                              PE_COFF_LOADER_IMAGE_CONTEXT
 112
 113    @retval EFI_SUCCESS       This function always return EFI_SUCCESS.
 114
 115 **/
 116 EFI_STATUS
 117 GetImageReadFunction (
 118   IN      PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
 119   );
 120
 121
 122 /**
 123    Main entry point to last PEIM
 124
 125    @param This          Entry point for DXE IPL PPI
 126    @param PeiServices   General purpose services available to every PEIM.
 127    @param HobList       Address to the Pei HOB list
 128
 129    @return EFI_SUCCESS              DXE core was successfully loaded.
 130    @return EFI_OUT_OF_RESOURCES     There are not enough resources to load DXE core.
 131
 132 **/
 133 EFI_STATUS
 134 EFIAPI
 135 DxeLoadCore (
 136   IN EFI_DXE_IPL_PPI       *This,
 137   IN EFI_PEI_SERVICES      **PeiServices,
 138   IN EFI_PEI_HOB_POINTERS  HobList
 139   );
 140
 141
 142
 143 /**
 144    Transfers control to DxeCore.
 145
 146    This function performs a CPU architecture specific operations to execute
 147    the entry point of DxeCore with the parameters of HobList.
 148    It also intalls EFI_END_OF_PEI_PPI to signal the end of PEI phase.
 149
 150    @param DxeCoreEntryPoint         The entrypoint of DxeCore.
 151    @param HobList                   The start of HobList passed to DxeCore.
 152
 153 **/
 154 VOID
 155 HandOffToDxeCore (
 156   IN EFI_PHYSICAL_ADDRESS   DxeCoreEntryPoint,
 157   IN EFI_PEI_HOB_POINTERS   HobList
 158   );
 159
 160
 161
 162 /**
 163    Updates the Stack HOB passed to DXE phase.
 164
 165    This function traverses the whole HOB list and update the stack HOB to
 166    reflect the real stack that is used by DXE core.
 167
 168    @param BaseAddress           The lower address of stack used by DxeCore.
 169    @param Length                The length of stack used by DxeCore.
 170
 171 **/
 172 VOID
 173 UpdateStackHob (
 174   IN EFI_PHYSICAL_ADDRESS        BaseAddress,
 175   IN UINT64                      Length
 176   );
 177
 178 /**
 179   The ExtractSection() function processes the input section and
 180   returns a pointer to the section contents. If the section being
 181   extracted does not require processing (if the section
 182   GuidedSectionHeader.Attributes has the
 183   EFI_GUIDED_SECTION_PROCESSING_REQUIRED field cleared), then
 184   OutputBuffer is just updated to point to the start of the
 185   section's contents. Otherwise, *Buffer must be allocated
 186   from PEI permanent memory.
 187
 188   @param This                   Indicates the
 189                                 EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance.
 190                                 Buffer containing the input GUIDed section to be
 191                                 processed. OutputBuffer OutputBuffer is
 192                                 allocated from PEI permanent memory and contains
 193                                 the new section stream.
 194   @param InputSection           A pointer to the input buffer, which contains
 195                                 the input section to be processed.
 196   @param OutputBuffer           A pointer to a caller-allocated buffer, whose
 197                                 size is specified by the contents of OutputSize.
 198   @param OutputSize             A pointer to a caller-allocated
 199                                 UINTN in which the size of *OutputBuffer
 200                                 allocation is stored. If the function
 201                                 returns anything other than EFI_SUCCESS,
 202                                 the value of OutputSize is undefined.
 203   @param AuthenticationStatus   A pointer to a caller-allocated
 204                                 UINT32 that indicates the
 205                                 authentication status of the
 206                                 output buffer. If the input
 207                                 section's GuidedSectionHeader.
 208                                 Attributes field has the
 209                                 EFI_GUIDED_SECTION_AUTH_STATUS_VALID
 210                                 bit as clear,
 211                                 AuthenticationStatus must return
 212                                 zero. These bits reflect the
 213                                 status of the extraction
 214                                 operation. If the function
 215                                 returns anything other than
 216                                 EFI_SUCCESS, the value of
 217                                 AuthenticationStatus is
 218                                 undefined.
 219
 220   @retval EFI_SUCCESS           The InputSection was
 221                                 successfully processed and the
 222                                 section contents were returned.
 223
 224   @retval EFI_OUT_OF_RESOURCES  The system has insufficient
 225                                 resources to process the request.
 226
 227   @retval EFI_INVALID_PARAMETER The GUID in InputSection does
 228                                 not match this instance of the
 229                                 GUIDed Section Extraction PPI.
 230
 231 **/
 232 EFI_STATUS
 233 CustomGuidedSectionExtract (
 234   IN CONST  EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,
 235   IN CONST  VOID                                  *InputSection,
 236   OUT       VOID                                  **OutputBuffer,
 237   OUT       UINTN                                 *OutputSize,
 238   OUT       UINT32                                *AuthenticationStatus
 239   );
 240
 241
 242 /**
 243    Decompresses a section to the output buffer.
 244
 245    This function lookes up the compression type field in the input section and
 246    applies the appropriate compression algorithm to compress the section to a
 247    callee allocated buffer.
 248
 249    @param  This                  Points to this instance of the
 250                                  EFI_PEI_DECOMPRESS_PEI PPI.
 251    @param  CompressionSection    Points to the compressed section.
 252    @param  OutputBuffer          Holds the returned pointer to the decompressed
 253                                  sections.
 254    @param  OutputSize            Holds the returned size of the decompress
 255                                  section streams.
 256
 257    @retval EFI_SUCCESS           The section was decompressed successfully.
 258                                  OutputBuffer contains the resulting data and
 259                                  OutputSize contains the resulting size.
 260
 261 **/
 262 EFI_STATUS
 263 EFIAPI
 264 Decompress (
 265   IN CONST  EFI_PEI_DECOMPRESS_PPI  *This,
 266   IN CONST  EFI_COMPRESSION_SECTION *CompressionSection,
 267   OUT       VOID                    **OutputBuffer,
 268   OUT       UINTN                   *OutputSize
 269   );
 270
 271 /**
 272   Initializes the Dxe Ipl PPI
 273
 274   @param  FfsHandle   The handle of FFS file.
 275   @param  PeiServices General purpose services available to
 276                       every PEIM.
 277   @return EFI_SUCESS
 278
 279 **/
 280 EFI_STATUS
 281 EFIAPI
 282 PeimInitializeDxeIpl (
 283   IN EFI_PEI_FILE_HANDLE       FfsHandle,
 284   IN EFI_PEI_SERVICES          **PeiServices
 285   );
 286
 287
 288 #endif