OvmfPkg: Import XENMEM_memory_map hypercall to Xen/memory.h

[mirror_edk2.git] / OvmfPkg / XenPlatformPei / Xen.c

/**@file\r
  Xen Platform PEI support\r
\r
  Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
  Copyright (c) 2011, Andrei Warkentin <andreiw@motorola.com>\r
  Copyright (c) 2019, Citrix Systems, Inc.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
//\r
// The package level header files this module uses\r
//\r
#include <PiPei.h>\r
\r
//\r
// The Library classes this module consumes\r
//\r
#include <Library/DebugLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/PcdLib.h>\r
#include <Guid/XenInfo.h>\r
#include <IndustryStandard/E820.h>\r
#include <Library/ResourcePublicationLib.h>\r
#include <Library/MtrrLib.h>\r
#include <IndustryStandard/Xen/arch-x86/hvm/start_info.h>\r
#include <Library/XenHypercallLib.h>\r
\r
#include "Platform.h"\r
#include "Xen.h"\r
\r
STATIC UINT32 mXenLeaf = 0;\r
\r
EFI_XEN_INFO mXenInfo;\r
\r
//\r
// Location of the firmware info struct setup by hvmloader.\r
// Only the E820 table is used by OVMF.\r
//\r
EFI_XEN_OVMF_INFO *mXenHvmloaderInfo;\r
\r
/**\r
  Returns E820 map provided by Xen\r
\r
  @param Entries      Pointer to E820 map\r
  @param Count        Number of entries\r
\r
  @return EFI_STATUS\r
**/\r
EFI_STATUS\r
XenGetE820Map (\r
  EFI_E820_ENTRY64 **Entries,\r
  UINT32 *Count\r
  )\r
{\r
  //\r
  // Get E820 produced by hvmloader\r
  //\r
  if (mXenHvmloaderInfo != NULL) {\r
    ASSERT (mXenHvmloaderInfo->E820 < MAX_ADDRESS);\r
    *Entries = (EFI_E820_ENTRY64 *)(UINTN) mXenHvmloaderInfo->E820;\r
    *Count = mXenHvmloaderInfo->E820EntriesCount;\r
\r
    return EFI_SUCCESS;\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
/**\r
  Connects to the Hypervisor.\r
\r
  @return EFI_STATUS\r
\r
**/\r
EFI_STATUS\r
XenConnect (\r
  )\r
{\r
  UINT32 Index;\r
  UINT32 TransferReg;\r
  UINT32 TransferPages;\r
  UINT32 XenVersion;\r
  EFI_XEN_OVMF_INFO *Info;\r
  CHAR8 Sig[sizeof (Info->Signature) + 1];\r
  UINT32 *PVHResetVectorData;\r
  RETURN_STATUS Status;\r
\r
  ASSERT (mXenLeaf != 0);\r
\r
  //\r
  // Prepare HyperPages to be able to make hypercalls\r
  //\r
\r
  AsmCpuid (mXenLeaf + 2, &TransferPages, &TransferReg, NULL, NULL);\r
  mXenInfo.HyperPages = AllocatePages (TransferPages);\r
  if (!mXenInfo.HyperPages) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  for (Index = 0; Index < TransferPages; Index++) {\r
    AsmWriteMsr64 (TransferReg,\r
                   (UINTN) mXenInfo.HyperPages +\r
                   (Index << EFI_PAGE_SHIFT) + Index);\r
  }\r
\r
  //\r
  // Find out the Xen version\r
  //\r
\r
  AsmCpuid (mXenLeaf + 1, &XenVersion, NULL, NULL, NULL);\r
  DEBUG ((DEBUG_ERROR, "Detected Xen version %d.%d\n",\r
          XenVersion >> 16, XenVersion & 0xFFFF));\r
  mXenInfo.VersionMajor = (UINT16)(XenVersion >> 16);\r
  mXenInfo.VersionMinor = (UINT16)(XenVersion & 0xFFFF);\r
\r
  //\r
  // Check if there are information left by hvmloader\r
  //\r
\r
  Info = (EFI_XEN_OVMF_INFO *)(UINTN) OVMF_INFO_PHYSICAL_ADDRESS;\r
  //\r
  // Copy the signature, and make it null-terminated.\r
  //\r
  AsciiStrnCpyS (Sig, sizeof (Sig), (CHAR8 *) &Info->Signature,\r
    sizeof (Info->Signature));\r
  if (AsciiStrCmp (Sig, "XenHVMOVMF") == 0) {\r
    mXenHvmloaderInfo = Info;\r
  } else {\r
    mXenHvmloaderInfo = NULL;\r
  }\r
\r
  mXenInfo.RsdpPvh = NULL;\r
\r
  //\r
  // Locate and use information from the start of day structure if we have\r
  // booted via the PVH entry point.\r
  //\r
\r
  PVHResetVectorData = (VOID *)(UINTN) PcdGet32 (PcdXenPvhStartOfDayStructPtr);\r
  //\r
  // That magic value is written in XenResetVector/Ia32/XenPVHMain.asm\r
  //\r
  if (PVHResetVectorData[1] == SIGNATURE_32 ('X', 'P', 'V', 'H')) {\r
    struct hvm_start_info *HVMStartInfo;\r
\r
    HVMStartInfo = (VOID *)(UINTN) PVHResetVectorData[0];\r
    if (HVMStartInfo->magic == XEN_HVM_START_MAGIC_VALUE) {\r
      ASSERT (HVMStartInfo->rsdp_paddr != 0);\r
      if (HVMStartInfo->rsdp_paddr != 0) {\r
        mXenInfo.RsdpPvh = (VOID *)(UINTN)HVMStartInfo->rsdp_paddr;\r
      }\r
    }\r
  }\r
\r
  BuildGuidDataHob (\r
    &gEfiXenInfoGuid,\r
    &mXenInfo,\r
    sizeof(mXenInfo)\r
    );\r
\r
  //\r
  // Initialize the XenHypercall library, now that the XenInfo HOB is\r
  // available\r
  //\r
  Status = XenHypercallLibInit ();\r
  ASSERT_RETURN_ERROR (Status);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Figures out if we are running inside Xen HVM.\r
\r
  @retval TRUE   Xen was detected\r
  @retval FALSE  Xen was not detected\r
\r
**/\r
BOOLEAN\r
XenDetect (\r
  VOID\r
  )\r
{\r
  UINT8 Signature[13];\r
\r
  if (mXenLeaf != 0) {\r
    return TRUE;\r
  }\r
\r
  Signature[12] = '\0';\r
  for (mXenLeaf = 0x40000000; mXenLeaf < 0x40010000; mXenLeaf += 0x100) {\r
    AsmCpuid (mXenLeaf,\r
              NULL,\r
              (UINT32 *) &Signature[0],\r
              (UINT32 *) &Signature[4],\r
              (UINT32 *) &Signature[8]);\r
\r
    if (!AsciiStrCmp ((CHAR8 *) Signature, "XenVMMXenVMM")) {\r
      return TRUE;\r
    }\r
  }\r
\r
  mXenLeaf = 0;\r
  return FALSE;\r
}\r
\r
BOOLEAN\r
XenHvmloaderDetected (\r
  VOID\r
  )\r
{\r
  return (mXenHvmloaderInfo != NULL);\r
}\r
\r
BOOLEAN\r
XenPvhDetected (\r
  VOID\r
  )\r
{\r
  //\r
  // This function should only be used after XenConnect\r
  //\r
  ASSERT (mXenInfo.HyperPages != NULL);\r
\r
  return mXenHvmloaderInfo == NULL;\r
}\r
\r
VOID\r
XenPublishRamRegions (\r
  VOID\r
  )\r
{\r
  EFI_E820_ENTRY64  *E820Map;\r
  UINT32            E820EntriesCount;\r
  EFI_STATUS        Status;\r
\r
  DEBUG ((DEBUG_INFO, "Using memory map provided by Xen\n"));\r
\r
  //\r
  // Parse RAM in E820 map\r
  //\r
  E820EntriesCount = 0;\r
  Status = XenGetE820Map (&E820Map, &E820EntriesCount);\r
\r
  ASSERT_EFI_ERROR (Status);\r
\r
  if (E820EntriesCount > 0) {\r
    EFI_E820_ENTRY64 *Entry;\r
    UINT32 Loop;\r
\r
    for (Loop = 0; Loop < E820EntriesCount; Loop++) {\r
      Entry = E820Map + Loop;\r
\r
      //\r
      // Only care about RAM\r
      //\r
      if (Entry->Type != EfiAcpiAddressRangeMemory) {\r
        continue;\r
      }\r
\r
      AddMemoryBaseSizeHob (Entry->BaseAddr, Entry->Length);\r
\r
      MtrrSetMemoryAttribute (Entry->BaseAddr, Entry->Length, CacheWriteBack);\r
    }\r
  }\r
}\r
\r
\r
/**\r
  Perform Xen PEI initialization.\r
\r
  @return EFI_SUCCESS     Xen initialized successfully\r
  @return EFI_NOT_FOUND   Not running under Xen\r
\r
**/\r
EFI_STATUS\r
InitializeXen (\r
  VOID\r
  )\r
{\r
  RETURN_STATUS PcdStatus;\r
\r
  //\r
  // Reserve away HVMLOADER reserved memory [0xFC000000,0xFD000000).\r
  // This needs to match HVMLOADER RESERVED_MEMBASE/RESERVED_MEMSIZE.\r
  //\r
  AddReservedMemoryBaseSizeHob (0xFC000000, 0x1000000, FALSE);\r
\r
  PcdStatus = PcdSetBoolS (PcdPciDisableBusEnumeration, TRUE);\r
  ASSERT_RETURN_ERROR (PcdStatus);\r
\r
  return EFI_SUCCESS;\r
}\r