1) Add library classes of S3Lib and RecoveryLib in MdeModulePkg

[mirror_edk2.git] / MdeModulePkg / Core / DxeIplPeim / DxeIpl.h

/*++\r
\r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
Module Name:\r
\r
  DxeIpl.h\r
\r
Abstract:\r
\r
--*/\r
\r
#ifndef __PEI_DXEIPL_H__\r
#define __PEI_DXEIPL_H__\r
\r
#include <PiPei.h>\r
#include <Ppi/DxeIpl.h>\r
#include <Protocol/EdkDecompress.h>\r
#include <Ppi/EndOfPeiPhase.h>\r
#include <Protocol/CustomizedDecompress.h>\r
#include <Protocol/Decompress.h>\r
#include <Ppi/Security.h>\r
#include <Ppi/SectionExtraction.h>\r
#include <Ppi/FvLoadFile.h>\r
#include <Ppi/MemoryDiscovered.h>\r
#include <Ppi/Decompress.h>\r
#include <Ppi/FirmwareVolumeInfo.h>\r
\r
#include <Guid/FirmwareFileSystem2.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/PeimEntryPoint.h>\r
#include <Library/BaseLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/CacheMaintenanceLib.h>\r
#include <Library/PeCoffLoaderLib.h>\r
#include <Library/UefiDecompressLib.h>\r
#include <Library/CustomDecompressLib.h>\r
#include <Library/PeiServicesTablePointerLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/PeCoffLib.h>\r
#include <Library/S3Lib.h>\r
#include <Library/RecoveryLib.h>\r
\r
#define STACK_SIZE      0x20000\r
#define BSP_STORE_SIZE  0x4000\r
\r
#define GET_OCCUPIED_SIZE(ActualSize, Alignment) ((ActualSize + (Alignment - 1)) & ~(Alignment - 1))\r
\r
extern BOOLEAN gInMemory;\r
\r
EFI_STATUS\r
PeiFindFile (\r
  IN  UINT8                  Type,\r
  IN  EFI_SECTION_TYPE       SectionType,\r
  OUT EFI_GUID               *FileName,\r
  OUT VOID                   **Pe32Data\r
  )\r
;\r
\r
EFI_STATUS\r
PeiLoadFile (\r
  IN  EFI_PEI_FILE_HANDLE                       FileHandle,\r
  OUT EFI_PHYSICAL_ADDRESS                      *ImageAddress,\r
  OUT UINT64                                    *ImageSize,\r
  OUT EFI_PHYSICAL_ADDRESS                      *EntryPoint\r
  )\r
;\r
\r
EFI_STATUS\r
DxeIplAddEncapsulatedFirmwareVolumes (\r
  VOID\r
  )\r
;\r
\r
EFI_STATUS\r
DxeIplFindFirmwareVolumeInstance (\r
  IN OUT UINTN              *Instance,\r
  IN  EFI_FV_FILETYPE       SeachType,\r
  OUT EFI_PEI_FV_HANDLE     *VolumeHandle,\r
  OUT EFI_PEI_FILE_HANDLE   *FileHandle\r
  )\r
;\r
\r
EFI_STATUS\r
GetImageReadFunction (\r
  IN      PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext\r
  )\r
;\r
\r
EFI_STATUS\r
PeiImageRead (\r
  IN     VOID    *FileHandle,\r
  IN     UINTN   FileOffset,\r
  IN OUT UINTN   *ReadSize,\r
  OUT    VOID    *Buffer\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
DxeIplLoadFile (\r
  IN EFI_PEI_FV_FILE_LOADER_PPI                 *This,\r
  IN  EFI_FFS_FILE_HEADER                       *FfsHeader,\r
  OUT EFI_PHYSICAL_ADDRESS                      *ImageAddress,\r
  OUT UINT64                                    *ImageSize,\r
  OUT EFI_PHYSICAL_ADDRESS                      *EntryPoint\r
  );\r
\r
EFI_STATUS\r
ShadowDxeIpl (\r
  IN EFI_FFS_FILE_HEADER                       *DxeIpl,\r
  IN EFI_PEI_PE_COFF_LOADER_PROTOCOL           *PeiEfiPeiPeCoffLoader\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
DxeLoadCore (\r
  IN EFI_DXE_IPL_PPI       *This,\r
  IN EFI_PEI_SERVICES      **PeiServices,\r
  IN EFI_PEI_HOB_POINTERS  HobList\r
  );\r
\r
VOID\r
HandOffToDxeCore (\r
  IN EFI_PHYSICAL_ADDRESS   DxeCoreEntryPoint,\r
  IN EFI_PEI_HOB_POINTERS   HobList,\r
  IN EFI_PEI_PPI_DESCRIPTOR *EndOfPeiSignal\r
  );\r
\r
EFI_STATUS\r
PeiProcessFile (\r
  IN      EFI_SECTION_TYPE       SectionType,\r
  IN      EFI_FFS_FILE_HEADER    *FfsFileHeader,\r
  OUT     VOID                   **Pe32Data,\r
  IN      EFI_PEI_HOB_POINTERS   *OrigHob\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
PeimInitializeDxeIpl (\r
  IN EFI_PEI_FILE_HANDLE       FfsHandle,\r
  IN EFI_PEI_SERVICES          **PeiServices\r
  )\r
;\r
\r
\r
#endif\r