]> git.proxmox.com Git - mirror_edk2.git/blobdiff - OvmfPkg/PlatformPei/MemDetect.c
OvmfPkg: Update PlatformPei to support Tdx guest
[mirror_edk2.git] / OvmfPkg / PlatformPei / MemDetect.c
index 9f6ca1942e294d2ce01d5628b9aa5ecc429f79d1..2e47b132299042024809b1a1db7a5ba29156a616 100644 (file)
@@ -1,14 +1,8 @@
 /**@file\r
   Memory Detection for Virtual Machines.\r
 \r
-  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
-  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
+  Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 Module Name:\r
 \r
@@ -19,128 +13,359 @@ Module Name:
 //\r
 // The package level header files this module uses\r
 //\r
+#include <IndustryStandard/E820.h>\r
+#include <IndustryStandard/I440FxPiix4.h>\r
+#include <IndustryStandard/Q35MchIch9.h>\r
+#include <IndustryStandard/CloudHv.h>\r
+#include <IndustryStandard/Xen/arch-x86/hvm/start_info.h>\r
 #include <PiPei.h>\r
+#include <Register/Intel/SmramSaveStateMap.h>\r
 \r
 //\r
 // The Library classes this module consumes\r
 //\r
+#include <Library/BaseLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
 #include <Library/DebugLib.h>\r
 #include <Library/HobLib.h>\r
 #include <Library/IoLib.h>\r
+#include <Library/MemEncryptSevLib.h>\r
 #include <Library/PcdLib.h>\r
+#include <Library/PciLib.h>\r
 #include <Library/PeimEntryPoint.h>\r
 #include <Library/ResourcePublicationLib.h>\r
-#include <Library/MtrrLib.h>\r
 \r
+#include <Library/QemuFwCfgLib.h>\r
+#include <Library/QemuFwCfgSimpleParserLib.h>\r
 #include "Platform.h"\r
-#include "Cmos.h"\r
 \r
-STATIC\r
-UINTN\r
-GetSystemMemorySizeBelow4gb (\r
+VOID\r
+Q35TsegMbytesInitialization (\r
+  VOID\r
   )\r
 {\r
-  UINT8 Cmos0x34;\r
-  UINT8 Cmos0x35;\r
+  UINT16         ExtendedTsegMbytes;\r
+  RETURN_STATUS  PcdStatus;\r
 \r
+  ASSERT (mPlatformInfoHob.HostBridgeDevId == INTEL_Q35_MCH_DEVICE_ID);\r
+\r
+  //\r
+  // Check if QEMU offers an extended TSEG.\r
   //\r
-  // CMOS 0x34/0x35 specifies the system memory above 16 MB.\r
-  // * CMOS(0x35) is the high byte\r
-  // * CMOS(0x34) is the low byte\r
-  // * The size is specified in 64kb chunks\r
-  // * Since this is memory above 16MB, the 16MB must be added\r
-  //   into the calculation to get the total memory size.\r
+  // This can be seen from writing MCH_EXT_TSEG_MB_QUERY to the MCH_EXT_TSEG_MB\r
+  // register, and reading back the register.\r
   //\r
+  // On a QEMU machine type that does not offer an extended TSEG, the initial\r
+  // write overwrites whatever value a malicious guest OS may have placed in\r
+  // the (unimplemented) register, before entering S3 or rebooting.\r
+  // Subsequently, the read returns MCH_EXT_TSEG_MB_QUERY unchanged.\r
+  //\r
+  // On a QEMU machine type that offers an extended TSEG, the initial write\r
+  // triggers an update to the register. Subsequently, the value read back\r
+  // (which is guaranteed to differ from MCH_EXT_TSEG_MB_QUERY) tells us the\r
+  // number of megabytes.\r
+  //\r
+  PciWrite16 (DRAMC_REGISTER_Q35 (MCH_EXT_TSEG_MB), MCH_EXT_TSEG_MB_QUERY);\r
+  ExtendedTsegMbytes = PciRead16 (DRAMC_REGISTER_Q35 (MCH_EXT_TSEG_MB));\r
+  if (ExtendedTsegMbytes == MCH_EXT_TSEG_MB_QUERY) {\r
+    mPlatformInfoHob.Q35TsegMbytes = PcdGet16 (PcdQ35TsegMbytes);\r
+    return;\r
+  }\r
 \r
-  Cmos0x34 = (UINT8) CmosRead8 (0x34);\r
-  Cmos0x35 = (UINT8) CmosRead8 (0x35);\r
+  DEBUG ((\r
+    DEBUG_INFO,\r
+    "%a: QEMU offers an extended TSEG (%d MB)\n",\r
+    __FUNCTION__,\r
+    ExtendedTsegMbytes\r
+    ));\r
+  PcdStatus = PcdSet16S (PcdQ35TsegMbytes, ExtendedTsegMbytes);\r
+  ASSERT_RETURN_ERROR (PcdStatus);\r
+  mPlatformInfoHob.Q35TsegMbytes = ExtendedTsegMbytes;\r
+}\r
 \r
-  return (((UINTN)((Cmos0x35 << 8) + Cmos0x34) << 16) + SIZE_16MB);\r
+VOID\r
+Q35SmramAtDefaultSmbaseInitialization (\r
+  VOID\r
+  )\r
+{\r
+  RETURN_STATUS  PcdStatus;\r
+\r
+  ASSERT (mPlatformInfoHob.HostBridgeDevId == INTEL_Q35_MCH_DEVICE_ID);\r
+\r
+  mPlatformInfoHob.Q35SmramAtDefaultSmbase = FALSE;\r
+  if (FeaturePcdGet (PcdCsmEnable)) {\r
+    DEBUG ((\r
+      DEBUG_INFO,\r
+      "%a: SMRAM at default SMBASE not checked due to CSM\n",\r
+      __FUNCTION__\r
+      ));\r
+  } else {\r
+    UINTN  CtlReg;\r
+    UINT8  CtlRegVal;\r
+\r
+    CtlReg = DRAMC_REGISTER_Q35 (MCH_DEFAULT_SMBASE_CTL);\r
+    PciWrite8 (CtlReg, MCH_DEFAULT_SMBASE_QUERY);\r
+    CtlRegVal                                = PciRead8 (CtlReg);\r
+    mPlatformInfoHob.Q35SmramAtDefaultSmbase = (BOOLEAN)(CtlRegVal ==\r
+                                                         MCH_DEFAULT_SMBASE_IN_RAM);\r
+    DEBUG ((\r
+      DEBUG_INFO,\r
+      "%a: SMRAM at default SMBASE %a\n",\r
+      __FUNCTION__,\r
+      mPlatformInfoHob.Q35SmramAtDefaultSmbase ? "found" : "not found"\r
+      ));\r
+  }\r
+\r
+  PcdStatus = PcdSetBoolS (\r
+                PcdQ35SmramAtDefaultSmbase,\r
+                mPlatformInfoHob.Q35SmramAtDefaultSmbase\r
+                );\r
+  ASSERT_RETURN_ERROR (PcdStatus);\r
 }\r
 \r
+/**\r
+  Initialize the PhysMemAddressWidth field in PlatformInfoHob based on guest RAM size.\r
+**/\r
+VOID\r
+AddressWidthInitialization (\r
+  IN OUT EFI_HOB_PLATFORM_INFO  *PlatformInfoHob\r
+  )\r
+{\r
+  RETURN_STATUS  PcdStatus;\r
+\r
+  PlatformAddressWidthInitialization (PlatformInfoHob);\r
+\r
+  //\r
+  // If DXE is 32-bit, then we're done; PciBusDxe will degrade 64-bit MMIO\r
+  // resources to 32-bit anyway. See DegradeResource() in\r
+  // "PciResourceSupport.c".\r
+  //\r
+ #ifdef MDE_CPU_IA32\r
+  if (!FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
+    return;\r
+  }\r
+\r
+ #endif\r
+\r
+  if (PlatformInfoHob->PcdPciMmio64Size == 0) {\r
+    if (PlatformInfoHob->BootMode != BOOT_ON_S3_RESUME) {\r
+      DEBUG ((\r
+        DEBUG_INFO,\r
+        "%a: disabling 64-bit PCI host aperture\n",\r
+        __FUNCTION__\r
+        ));\r
+      PcdStatus = PcdSet64S (PcdPciMmio64Size, 0);\r
+      ASSERT_RETURN_ERROR (PcdStatus);\r
+    }\r
+\r
+    return;\r
+  }\r
+\r
+  if (PlatformInfoHob->BootMode != BOOT_ON_S3_RESUME) {\r
+    //\r
+    // The core PciHostBridgeDxe driver will automatically add this range to\r
+    // the GCD memory space map through our PciHostBridgeLib instance; here we\r
+    // only need to set the PCDs.\r
+    //\r
+    PcdStatus = PcdSet64S (PcdPciMmio64Base, PlatformInfoHob->PcdPciMmio64Base);\r
+    ASSERT_RETURN_ERROR (PcdStatus);\r
+    PcdStatus = PcdSet64S (PcdPciMmio64Size, PlatformInfoHob->PcdPciMmio64Size);\r
+    ASSERT_RETURN_ERROR (PcdStatus);\r
+\r
+    DEBUG ((\r
+      DEBUG_INFO,\r
+      "%a: Pci64Base=0x%Lx Pci64Size=0x%Lx\n",\r
+      __FUNCTION__,\r
+      PlatformInfoHob->PcdPciMmio64Base,\r
+      PlatformInfoHob->PcdPciMmio64Size\r
+      ));\r
+  }\r
+}\r
 \r
+/**\r
+  Calculate the cap for the permanent PEI memory.\r
+**/\r
 STATIC\r
-UINT64\r
-GetSystemMemorySizeAbove4gb (\r
+UINT32\r
+GetPeiMemoryCap (\r
+  VOID\r
   )\r
 {\r
-  UINT32 Size;\r
-  UINTN  CmosIndex;\r
+  BOOLEAN  Page1GSupport;\r
+  UINT32   RegEax;\r
+  UINT32   RegEdx;\r
+  UINT32   Pml4Entries;\r
+  UINT32   PdpEntries;\r
+  UINTN    TotalPages;\r
+\r
+  //\r
+  // If DXE is 32-bit, then just return the traditional 64 MB cap.\r
+  //\r
+ #ifdef MDE_CPU_IA32\r
+  if (!FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
+    return SIZE_64MB;\r
+  }\r
+\r
+ #endif\r
 \r
   //\r
-  // CMOS 0x5b-0x5d specifies the system memory above 4GB MB.\r
-  // * CMOS(0x5d) is the most significant size byte\r
-  // * CMOS(0x5c) is the middle size byte\r
-  // * CMOS(0x5b) is the least significant size byte\r
-  // * The size is specified in 64kb chunks\r
+  // Dependent on physical address width, PEI memory allocations can be\r
+  // dominated by the page tables built for 64-bit DXE. So we key the cap off\r
+  // of those. The code below is based on CreateIdentityMappingPageTables() in\r
+  // "MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c".\r
   //\r
+  Page1GSupport = FALSE;\r
+  if (PcdGetBool (PcdUse1GPageTable)) {\r
+    AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
+    if (RegEax >= 0x80000001) {\r
+      AsmCpuid (0x80000001, NULL, NULL, NULL, &RegEdx);\r
+      if ((RegEdx & BIT26) != 0) {\r
+        Page1GSupport = TRUE;\r
+      }\r
+    }\r
+  }\r
 \r
-  Size = 0;\r
-  for (CmosIndex = 0x5d; CmosIndex >= 0x5b; CmosIndex--) {\r
-    Size = (UINT32) (Size << 8) + (UINT32) CmosRead8 (CmosIndex);\r
+  if (mPlatformInfoHob.PhysMemAddressWidth <= 39) {\r
+    Pml4Entries = 1;\r
+    PdpEntries  = 1 << (mPlatformInfoHob.PhysMemAddressWidth - 30);\r
+    ASSERT (PdpEntries <= 0x200);\r
+  } else {\r
+    if (mPlatformInfoHob.PhysMemAddressWidth > 48) {\r
+      Pml4Entries = 0x200;\r
+    } else {\r
+      Pml4Entries = 1 << (mPlatformInfoHob.PhysMemAddressWidth - 39);\r
+    }\r
+\r
+    ASSERT (Pml4Entries <= 0x200);\r
+    PdpEntries = 512;\r
   }\r
 \r
-  return LShiftU64 (Size, 16);\r
-}\r
+  TotalPages = Page1GSupport ? Pml4Entries + 1 :\r
+               (PdpEntries + 1) * Pml4Entries + 1;\r
+  ASSERT (TotalPages <= 0x40201);\r
 \r
+  //\r
+  // Add 64 MB for miscellaneous allocations. Note that for\r
+  // PhysMemAddressWidth values close to 36, the cap will actually be\r
+  // dominated by this increment.\r
+  //\r
+  return (UINT32)(EFI_PAGES_TO_SIZE (TotalPages) + SIZE_64MB);\r
+}\r
 \r
 /**\r
-  Peform Memory Detection\r
+  Publish PEI core memory\r
 \r
   @return EFI_SUCCESS     The PEIM initialized successfully.\r
 \r
 **/\r
-EFI_PHYSICAL_ADDRESS\r
-MemDetect (\r
+EFI_STATUS\r
+PublishPeiMemory (\r
+  VOID\r
   )\r
 {\r
-  EFI_STATUS                  Status;\r
-  EFI_PHYSICAL_ADDRESS        MemoryBase;\r
-  UINT64                      MemorySize;\r
-  UINT64                      LowerMemorySize;\r
-  UINT64                      UpperMemorySize;\r
+  EFI_STATUS            Status;\r
+  EFI_PHYSICAL_ADDRESS  MemoryBase;\r
+  UINT64                MemorySize;\r
+  UINT32                LowerMemorySize;\r
+  UINT32                PeiMemoryCap;\r
+  UINT32                S3AcpiReservedMemoryBase;\r
+  UINT32                S3AcpiReservedMemorySize;\r
+\r
+  LowerMemorySize = PlatformGetSystemMemorySizeBelow4gb (&mPlatformInfoHob);\r
+  if (mPlatformInfoHob.SmmSmramRequire) {\r
+    //\r
+    // TSEG is chipped from the end of low RAM\r
+    //\r
+    LowerMemorySize -= mPlatformInfoHob.Q35TsegMbytes * SIZE_1MB;\r
+  }\r
 \r
-  DEBUG ((EFI_D_ERROR, "MemDetect called\n"));\r
+  S3AcpiReservedMemoryBase = 0;\r
+  S3AcpiReservedMemorySize = 0;\r
 \r
   //\r
-  // Determine total memory size available\r
+  // If S3 is supported, then the S3 permanent PEI memory is placed next,\r
+  // downwards. Its size is primarily dictated by CpuMpPei. The formula below\r
+  // is an approximation.\r
   //\r
-  LowerMemorySize = GetSystemMemorySizeBelow4gb ();\r
-  UpperMemorySize = GetSystemMemorySizeAbove4gb ();\r
+  if (mPlatformInfoHob.S3Supported) {\r
+    S3AcpiReservedMemorySize = SIZE_512KB +\r
+                               mPlatformInfoHob.PcdCpuMaxLogicalProcessorNumber *\r
+                               PcdGet32 (PcdCpuApStackSize);\r
+    S3AcpiReservedMemoryBase = LowerMemorySize - S3AcpiReservedMemorySize;\r
+    LowerMemorySize          = S3AcpiReservedMemoryBase;\r
+  }\r
+\r
+  mPlatformInfoHob.S3AcpiReservedMemoryBase = S3AcpiReservedMemoryBase;\r
+  mPlatformInfoHob.S3AcpiReservedMemorySize = S3AcpiReservedMemorySize;\r
+\r
+  if (mPlatformInfoHob.BootMode == BOOT_ON_S3_RESUME) {\r
+    MemoryBase = S3AcpiReservedMemoryBase;\r
+    MemorySize = S3AcpiReservedMemorySize;\r
+  } else {\r
+    PeiMemoryCap = GetPeiMemoryCap ();\r
+    DEBUG ((\r
+      DEBUG_INFO,\r
+      "%a: PhysMemAddressWidth=%d PeiMemoryCap=%u KB\n",\r
+      __FUNCTION__,\r
+      mPlatformInfoHob.PhysMemAddressWidth,\r
+      PeiMemoryCap >> 10\r
+      ));\r
+\r
+    //\r
+    // Determine the range of memory to use during PEI\r
+    //\r
+    // Technically we could lay the permanent PEI RAM over SEC's temporary\r
+    // decompression and scratch buffer even if "secure S3" is needed, since\r
+    // their lifetimes don't overlap. However, PeiFvInitialization() will cover\r
+    // RAM up to PcdOvmfDecompressionScratchEnd with an EfiACPIMemoryNVS memory\r
+    // allocation HOB, and other allocations served from the permanent PEI RAM\r
+    // shouldn't overlap with that HOB.\r
+    //\r
+    MemoryBase = mPlatformInfoHob.S3Supported && mPlatformInfoHob.SmmSmramRequire ?\r
+                 PcdGet32 (PcdOvmfDecompressionScratchEnd) :\r
+                 PcdGet32 (PcdOvmfDxeMemFvBase) + PcdGet32 (PcdOvmfDxeMemFvSize);\r
+    MemorySize = LowerMemorySize - MemoryBase;\r
+    if (MemorySize > PeiMemoryCap) {\r
+      MemoryBase = LowerMemorySize - PeiMemoryCap;\r
+      MemorySize = PeiMemoryCap;\r
+    }\r
+  }\r
 \r
   //\r
-  // Determine the range of memory to use during PEI\r
+  // MEMFD_BASE_ADDRESS separates the SMRAM at the default SMBASE from the\r
+  // normal boot permanent PEI RAM. Regarding the S3 boot path, the S3\r
+  // permanent PEI RAM is located even higher.\r
   //\r
-  MemoryBase = PcdGet32 (PcdOvmfMemFvBase) + PcdGet32 (PcdOvmfMemFvSize);\r
-  MemorySize = LowerMemorySize - MemoryBase;\r
-  if (MemorySize > SIZE_64MB) {\r
-    MemoryBase = LowerMemorySize - SIZE_64MB;\r
-    MemorySize = SIZE_64MB;\r
+  if (mPlatformInfoHob.SmmSmramRequire && mPlatformInfoHob.Q35SmramAtDefaultSmbase) {\r
+    ASSERT (SMM_DEFAULT_SMBASE + MCH_DEFAULT_SMBASE_SIZE <= MemoryBase);\r
   }\r
 \r
   //\r
   // Publish this memory to the PEI Core\r
   //\r
-  Status = PublishSystemMemory(MemoryBase, MemorySize);\r
+  Status = PublishSystemMemory (MemoryBase, MemorySize);\r
   ASSERT_EFI_ERROR (Status);\r
 \r
-  //\r
-  // Create memory HOBs\r
-  //\r
-  AddMemoryBaseSizeHob (MemoryBase, MemorySize);\r
-  AddMemoryRangeHob (BASE_1MB, MemoryBase);\r
-  AddMemoryRangeHob (0, BASE_512KB + BASE_128KB);\r
+  return Status;\r
+}\r
 \r
-  MtrrSetMemoryAttribute (BASE_1MB, MemoryBase + MemorySize - BASE_1MB, CacheWriteBack);\r
+/**\r
+  Publish system RAM and reserve memory regions\r
 \r
-  MtrrSetMemoryAttribute (0, BASE_512KB + BASE_128KB, CacheWriteBack);\r
+**/\r
+VOID\r
+InitializeRamRegions (\r
+  IN EFI_HOB_PLATFORM_INFO  *PlatformInfoHob\r
+  )\r
+{\r
+  if (TdIsEnabled ()) {\r
+    PlatformTdxPublishRamRegions ();\r
+    return;\r
+  }\r
 \r
-  if (UpperMemorySize != 0) {\r
-    AddUntestedMemoryBaseSizeHob (BASE_4GB, UpperMemorySize);\r
+  PlatformQemuInitializeRam (PlatformInfoHob);\r
 \r
-    MtrrSetMemoryAttribute (BASE_4GB, UpperMemorySize, CacheWriteBack);\r
-  }\r
+  SevInitializeRam ();\r
 \r
-  return MemoryBase + MemorySize;\r
+  PlatformQemuInitializeRamForS3 (PlatformInfoHob);\r
 }\r
-\r