UefiPayloadPkg: Get and enter DxeCore for Universal Payload

[mirror_edk2.git] / UefiPayloadPkg / UefiPayloadEntry / UefiPayloadEntry.h

/** @file\r
*\r
* Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>\r
*\r
*  SPDX-License-Identifier: BSD-2-Clause-Patent\r
*\r
**/\r
\r
#ifndef __UEFI_PAYLOAD_ENTRY_H__\r
#define __UEFI_PAYLOAD_ENTRY_H__\r
\r
#include <PiPei.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PeCoffLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/PcdLib.h>\r
#include <Guid/MemoryAllocationHob.h>\r
#include <Library/IoLib.h>\r
#include <Library/PeCoffLib.h>\r
#include <Library/BlParseLib.h>\r
#include <Library/PlatformSupportLib.h>\r
#include <Library/UefiCpuLib.h>\r
#include <IndustryStandard/Acpi.h>\r
#include <IndustryStandard/MemoryMappedConfigurationSpaceAccessTable.h>\r
#include <Guid/SerialPortInfoGuid.h>\r
#include <Guid/SystemTableInfoGuid.h>\r
#include <Guid/MemoryMapInfoGuid.h>\r
#include <Guid/AcpiBoardInfoGuid.h>\r
#include <Guid/GraphicsInfoHob.h>\r
#include <UniversalPayload/SmbiosTable.h>\r
#include <UniversalPayload/AcpiTable.h>\r
#include <UniversalPayload/UniversalPayload.h>\r
#include <UniversalPayload/ExtraData.h>\r
\r
#define LEGACY_8259_MASK_REGISTER_MASTER  0x21\r
#define LEGACY_8259_MASK_REGISTER_SLAVE   0xA1\r
#define GET_OCCUPIED_SIZE(ActualSize, Alignment) \\r
  ((ActualSize) + (((Alignment) - ((ActualSize) & ((Alignment) - 1))) & ((Alignment) - 1)))\r
\r
\r
#define E820_RAM       1\r
#define E820_RESERVED  2\r
#define E820_ACPI      3\r
#define E820_NVS       4\r
#define E820_UNUSABLE  5\r
#define E820_DISABLED  6\r
#define E820_PMEM      7\r
#define E820_UNDEFINED 8\r
\r
/**\r
  Auto-generated function that calls the library constructors for all of the module's\r
  dependent libraries.\r
**/\r
VOID\r
EFIAPI\r
ProcessLibraryConstructorList (\r
  VOID\r
  );\r
\r
/**\r
  Add a new HOB to the HOB List.\r
\r
  @param HobType            Type of the new HOB.\r
  @param HobLength          Length of the new HOB to allocate.\r
\r
  @return  NULL if there is no space to create a hob.\r
  @return  The address point to the new created hob.\r
\r
**/\r
VOID *\r
EFIAPI\r
CreateHob (\r
  IN  UINT16    HobType,\r
  IN  UINT16    HobLength\r
  );\r
\r
/**\r
  Update the Stack Hob if the stack has been moved\r
\r
  @param  BaseAddress   The 64 bit physical address of the Stack.\r
  @param  Length        The length of the stack in bytes.\r
\r
**/\r
VOID\r
EFIAPI\r
UpdateStackHob (\r
  IN EFI_PHYSICAL_ADDRESS        BaseAddress,\r
  IN UINT64                      Length\r
  );\r
\r
/**\r
  Build a Handoff Information Table HOB\r
\r
  This function initialize a HOB region from EfiMemoryBegin to\r
  EfiMemoryTop. And EfiFreeMemoryBottom and EfiFreeMemoryTop should\r
  be inside the HOB region.\r
\r
  @param[in] EfiMemoryBottom       Total memory start address\r
  @param[in] EfiMemoryTop          Total memory end address.\r
  @param[in] EfiFreeMemoryBottom   Free memory start address\r
  @param[in] EfiFreeMemoryTop      Free memory end address.\r
\r
  @return   The pointer to the handoff HOB table.\r
\r
**/\r
EFI_HOB_HANDOFF_INFO_TABLE*\r
EFIAPI\r
HobConstructor (\r
  IN VOID   *EfiMemoryBottom,\r
  IN VOID   *EfiMemoryTop,\r
  IN VOID   *EfiFreeMemoryBottom,\r
  IN VOID   *EfiFreeMemoryTop\r
  );\r
\r
/**\r
  Find DXE core from FV and build DXE core HOBs.\r
\r
  @param[out]  DxeCoreEntryPoint     DXE core entry point\r
\r
  @retval EFI_SUCCESS        If it completed successfully.\r
  @retval EFI_NOT_FOUND      If it failed to load DXE FV.\r
**/\r
EFI_STATUS\r
LoadDxeCore (\r
  OUT PHYSICAL_ADDRESS        *DxeCoreEntryPoint\r
  );\r
\r
/**\r
  Find DXE core from FV and build DXE core HOBs.\r
\r
  @param[in]   DxeFv                 The FV where to find the DXE core.\r
  @param[out]  DxeCoreEntryPoint     DXE core entry point\r
\r
  @retval EFI_SUCCESS        If it completed successfully.\r
  @retval EFI_NOT_FOUND      If it failed to load DXE FV.\r
**/\r
EFI_STATUS\r
UniversalLoadDxeCore (\r
  IN  EFI_FIRMWARE_VOLUME_HEADER *DxeFv,\r
  OUT PHYSICAL_ADDRESS           *DxeCoreEntryPoint\r
  );\r
\r
/**\r
   Transfers control to DxeCore.\r
\r
   This function performs a CPU architecture specific operations to execute\r
   the entry point of DxeCore with the parameters of HobList.\r
\r
   @param DxeCoreEntryPoint         The entry point of DxeCore.\r
   @param HobList                   The start of HobList passed to DxeCore.\r
**/\r
VOID\r
HandOffToDxeCore (\r
  IN EFI_PHYSICAL_ADDRESS   DxeCoreEntryPoint,\r
  IN EFI_PEI_HOB_POINTERS   HobList\r
  );\r
\r
#endif\r