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