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 <Protocol/EdkDecompress.h>
  22 #include <Ppi/EndOfPeiPhase.h>
  23 #include <Protocol/CustomizedDecompress.h>
  24 #include <Protocol/Decompress.h>
  25 #include <Ppi/MemoryDiscovered.h>
  26 #include <Ppi/ReadOnlyVariable2.h>
  27 #include <Guid/MemoryTypeInformation.h>
  28 #include <Ppi/Decompress.h>
  29 #include <Ppi/FirmwareVolumeInfo.h>
  30
  31 #include <Guid/MemoryAllocationHob.h>
  32 #include <Guid/FirmwareFileSystem2.h>
  33
  34 #include <Library/DebugLib.h>
  35 #include <Library/PeimEntryPoint.h>
  36 #include <Library/BaseLib.h>
  37 #include <Library/HobLib.h>
  38 #include <Library/PeiServicesLib.h>
  39 #include <Library/ReportStatusCodeLib.h>
  40 #include <Library/CacheMaintenanceLib.h>
  41 #include <Library/UefiDecompressLib.h>
  42 #include <Library/ExtractGuidedSectionLib.h>
  43 #include <Library/PeiServicesTablePointerLib.h>
  44 #include <Library/BaseMemoryLib.h>
  45 #include <Library/MemoryAllocationLib.h>
  46 #include <Library/PcdLib.h>
  47 #include <Library/PeCoffLib.h>
  48 #include <Library/S3Lib.h>
  49 #include <Library/RecoveryLib.h>
  50
  51 #define STACK_SIZE      0x20000
  52 #define BSP_STORE_SIZE  0x4000
  53
  54 #define GET_OCCUPIED_SIZE(ActualSize, Alignment) ((ActualSize + (Alignment - 1)) & ~(Alignment - 1))
  55
  56 extern BOOLEAN gInMemory;
  57
  58
  59
  60
  61 /**
  62    Loads and relocates a PE/COFF image into memory.
  63
  64    @param FileHandle        The image file handle
  65    @param ImageAddress      The base address of the relocated PE/COFF image
  66    @param ImageSize         The size of the relocated PE/COFF image
  67    @param EntryPoint        The entry point of the relocated PE/COFF image
  68
  69    @return EFI_SUCCESS           The file was loaded and relocated
  70    @return EFI_OUT_OF_RESOURCES  There was not enough memory to load and relocate the PE/COFF file
  71
  72 **/
  73 EFI_STATUS
  74 PeiLoadFile (
  75   IN  EFI_PEI_FILE_HANDLE                       FileHandle,
  76   OUT EFI_PHYSICAL_ADDRESS                      *ImageAddress,
  77   OUT UINT64                                    *ImageSize,
  78   OUT EFI_PHYSICAL_ADDRESS                      *EntryPoint
  79   );
  80
  81
  82
  83 /**
  84    Find DxeCore driver from all First Volumes.
  85
  86    @param FileHandle    Pointer to FFS file to search.
  87
  88    @return EFI_SUCESS   Success to find the FFS in specificed FV
  89    @return others       Fail to find the FFS in specificed FV
  90
  91 **/
  92 EFI_STATUS
  93 DxeIplFindDxeCore (
  94   OUT EFI_PEI_FILE_HANDLE   *FileHandle
  95   );
  96
  97
  98
  99 /**
 100    This function simply retrieves the function pointer of ImageRead in
 101    ImageContext structure.
 102
 103    @param ImageContext       A pointer to the structure of
 104                              PE_COFF_LOADER_IMAGE_CONTEXT
 105
 106    @retval EFI_SUCCESS       This function always return EFI_SUCCESS.
 107
 108 **/
 109 EFI_STATUS
 110 GetImageReadFunction (
 111   IN      PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
 112   );
 113
 114
 115
 116 /**
 117    Main entry point to last PEIM
 118
 119    @param This          Entry point for DXE IPL PPI
 120    @param PeiServices   General purpose services available to every PEIM.
 121    @param HobList       Address to the Pei HOB list
 122
 123    @return EFI_SUCCESS              DXE core was successfully loaded.
 124    @return EFI_OUT_OF_RESOURCES     There are not enough resources to load DXE core.
 125
 126 **/
 127 EFI_STATUS
 128 EFIAPI
 129 DxeLoadCore (
 130   IN EFI_DXE_IPL_PPI       *This,
 131   IN EFI_PEI_SERVICES      **PeiServices,
 132   IN EFI_PEI_HOB_POINTERS  HobList
 133   );
 134
 135
 136
 137 /**
 138    Transfers control to DxeCore.
 139
 140    This function performs a CPU architecture specific operations to execute
 141    the entry point of DxeCore with the parameters of HobList.
 142    It also intalls EFI_END_OF_PEI_PPI to signal the end of PEI phase.
 143
 144    @param DxeCoreEntryPoint         The entrypoint of DxeCore.
 145    @param HobList                   The start of HobList passed to DxeCore.
 146    @param EndOfPeiSignal            The PPI descriptor for EFI_END_OF_PEI_PPI.
 147
 148 **/
 149 VOID
 150 HandOffToDxeCore (
 151   IN EFI_PHYSICAL_ADDRESS   DxeCoreEntryPoint,
 152   IN EFI_PEI_HOB_POINTERS   HobList,
 153   IN EFI_PEI_PPI_DESCRIPTOR *EndOfPeiSignal
 154   );
 155
 156
 157
 158 /**
 159    Updates the Stack HOB passed to DXE phase.
 160
 161    This function traverses the whole HOB list and update the stack HOB to
 162    reflect the real stack that is used by DXE core.
 163
 164    @param BaseAddress           The lower address of stack used by DxeCore.
 165    @param Length                The length of stack used by DxeCore.
 166
 167 **/
 168 VOID
 169 UpdateStackHob (
 170   IN EFI_PHYSICAL_ADDRESS        BaseAddress,
 171   IN UINT64                      Length
 172   );
 173
 174
 175
 176 /**
 177   Initializes the Dxe Ipl PPI
 178
 179   @param  FfsHandle   The handle of FFS file.
 180   @param  PeiServices General purpose services available to
 181                       every PEIM.
 182   @return EFI_SUCESS
 183
 184 **/
 185 EFI_STATUS
 186 EFIAPI
 187 PeimInitializeDxeIpl (
 188   IN EFI_PEI_FILE_HANDLE       FfsHandle,
 189   IN EFI_PEI_SERVICES          **PeiServices
 190   );
 191
 192
 193 #endif