Update build options format from "ABC", "XYZ" to ABC XYZ.

[mirror_edk2.git] / EdkModulePkg / 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
#define STACK_SIZE      0x20000\r
#define BSP_STORE_SIZE  0x4000\r
\r
extern BOOLEAN gInMemory;\r
\r
/**\r
  Transfers control to a function starting with a new stack.\r
\r
  Transfers control to the function specified by EntryPoint using the new stack\r
  specified by NewStack and passing in the parameters specified by Context1 and\r
  Context2. Context1 and Context2 are optional and may be NULL. The function\r
  EntryPoint must never return.\r
\r
  If EntryPoint is NULL, then ASSERT().\r
  If NewStack is NULL, then ASSERT().\r
\r
  @param  EntryPoint  A pointer to function to call with the new stack.\r
  @param  Context1    A pointer to the context to pass into the EntryPoint\r
                      function.\r
  @param  Context2    A pointer to the context to pass into the EntryPoint\r
                      function.\r
  @param  NewStack    A pointer to the new stack to use for the EntryPoint\r
                      function.\r
  @param  NewBsp      A pointer to the new BSP for the EntryPoint on IPF. It's\r
                      Reserved on other architectures.\r
\r
**/\r
VOID\r
EFIAPI\r
SwitchIplStacks (\r
  IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,\r
  IN      VOID                      *Context1,  OPTIONAL\r
  IN      VOID                      *Context2,  OPTIONAL\r
  IN      VOID                      *NewStack,\r
  IN      VOID                      *NewBsp\r
  );\r
\r
EFI_STATUS\r
PeiFindFile (\r
  IN  UINT8                  Type,\r
  IN  UINT16                 SectionType,\r
  OUT EFI_GUID               *FileName,\r
  OUT VOID                   **Pe32Data\r
  )\r
;\r
\r
EFI_STATUS\r
PeiLoadFile (\r
  IN  EFI_PEI_PE_COFF_LOADER_PROTOCOL           *PeiEfiPeiPeCoffLoader,\r
  IN  VOID                                      *Pe32Data,\r
  OUT EFI_PHYSICAL_ADDRESS                      *ImageAddress,\r
  OUT UINT64                                    *ImageSize,\r
  OUT EFI_PHYSICAL_ADDRESS                      *EntryPoint\r
  )\r
;\r
\r
\r
EFI_STATUS\r
CreateArchSpecificHobs (\r
  OUT EFI_PHYSICAL_ADDRESS                      *BspStore\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
EFI_STATUS\r
PeiProcessFile (\r
  IN      UINT16                 SectionType,\r
  IN OUT  EFI_FFS_FILE_HEADER    **RealFfsFileHeader,\r
  OUT     VOID                   **Pe32Data\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
PeimInitializeDxeIpl (\r
  IN EFI_FFS_FILE_HEADER       *FfsHeader,\r
  IN EFI_PEI_SERVICES          **PeiServices\r
  );\r
\r
EFI_STATUS\r
PeiLoadx64File (\r
  IN  EFI_PEI_PE_COFF_LOADER_PROTOCOL           *PeiEfiPeiPeCoffLoader,\r
  IN  VOID                                      *Pe32Data,\r
  IN  EFI_MEMORY_TYPE                           MemoryType,\r
  OUT EFI_PHYSICAL_ADDRESS                      *ImageAddress,\r
  OUT UINT64                                    *ImageSize,\r
  OUT EFI_PHYSICAL_ADDRESS                      *EntryPoint\r
  )\r
;\r
\r
EFI_PHYSICAL_ADDRESS\r
CreateIdentityMappingPageTables (\r
  IN UINT32                NumberOfProcessorPhysicalAddressBits\r
  )\r
;\r
\r
VOID\r
ActivateLongMode (\r
  IN  EFI_PHYSICAL_ADDRESS  PageTables,\r
  IN  EFI_PHYSICAL_ADDRESS  HobStart,\r
  IN  EFI_PHYSICAL_ADDRESS  Stack,\r
  IN  EFI_PHYSICAL_ADDRESS  CodeEntryPoint1,\r
  IN  EFI_PHYSICAL_ADDRESS  CodeEntryPoint2\r
  );\r
\r
VOID\r
LoadGo64Gdt();\r
\r
#endif\r