]> git.proxmox.com Git - mirror_edk2.git/blobdiff - OvmfPkg/PlatformPei/Platform.c
OvmfPkg: PlatformPei: enable PCIEXBAR (aka MMCONFIG / ECAM) on Q35
[mirror_edk2.git] / OvmfPkg / PlatformPei / Platform.c
index 1940e01640fd177aa5646ed7b7ed07e96fd11c73..0fc227803a84366e5f339402173ad0c04b7b0a77 100644 (file)
@@ -22,6 +22,7 @@
 //\r
 // The Library classes this module consumes\r
 //\r
+#include <Library/BaseLib.h>\r
 #include <Library/DebugLib.h>\r
 #include <Library/HobLib.h>\r
 #include <Library/IoLib.h>\r
@@ -61,6 +62,8 @@ EFI_PEI_PPI_DESCRIPTOR   mPpiBootMode[] = {
 };\r
 \r
 \r
+UINT16 mHostBridgeDevId;\r
+\r
 EFI_BOOT_MODE mBootMode = BOOT_WITH_FULL_CONFIGURATION;\r
 \r
 BOOLEAN mS3Supported = FALSE;\r
@@ -86,7 +89,8 @@ AddIoMemoryBaseSizeHob (
 VOID\r
 AddReservedMemoryBaseSizeHob (\r
   EFI_PHYSICAL_ADDRESS        MemoryBase,\r
-  UINT64                      MemorySize\r
+  UINT64                      MemorySize,\r
+  BOOLEAN                     Cacheable\r
   )\r
 {\r
   BuildResourceDescriptorHob (\r
@@ -94,6 +98,12 @@ AddReservedMemoryBaseSizeHob (
       EFI_RESOURCE_ATTRIBUTE_PRESENT     |\r
       EFI_RESOURCE_ATTRIBUTE_INITIALIZED |\r
       EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE |\r
+      (Cacheable ?\r
+       EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE |\r
+       EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE |\r
+       EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE :\r
+       0\r
+       ) |\r
       EFI_RESOURCE_ATTRIBUTE_TESTED,\r
     MemoryBase,\r
     MemorySize\r
@@ -191,8 +201,8 @@ MemMapInitialization (
     EFI_RESOURCE_IO,\r
     EFI_RESOURCE_ATTRIBUTE_PRESENT     |\r
     EFI_RESOURCE_ATTRIBUTE_INITIALIZED,\r
-    0xC000,\r
-    0x4000\r
+    PcdGet64 (PcdPciIoBase),\r
+    PcdGet64 (PcdPciIoSize)\r
     );\r
 \r
   //\r
@@ -202,7 +212,23 @@ MemMapInitialization (
 \r
   if (!mXen) {\r
     UINT32  TopOfLowRam;\r
+    UINT64  PciExBarBase;\r
+    UINT32  PciBase;\r
+    UINT32  PciSize;\r
+\r
     TopOfLowRam = GetSystemMemorySizeBelow4gb ();\r
+    if (mHostBridgeDevId == INTEL_Q35_MCH_DEVICE_ID) {\r
+      //\r
+      // The MMCONFIG area is expected to fall between the top of low RAM and\r
+      // the base of the 32-bit PCI host aperture.\r
+      //\r
+      PciExBarBase = FixedPcdGet64 (PcdPciExpressBaseAddress);\r
+      ASSERT (TopOfLowRam <= PciExBarBase);\r
+      ASSERT (PciExBarBase <= MAX_UINT32 - SIZE_256MB);\r
+      PciBase = (UINT32)(PciExBarBase + SIZE_256MB);\r
+    } else {\r
+      PciBase = (TopOfLowRam < BASE_2GB) ? BASE_2GB : TopOfLowRam;\r
+    }\r
 \r
     //\r
     // address       purpose   size\r
@@ -212,27 +238,161 @@ MemMapInitialization (
     // 0xFEC00000    IO-APIC                        4 KB\r
     // 0xFEC01000    gap                         1020 KB\r
     // 0xFED00000    HPET                           1 KB\r
-    // 0xFED00400    gap                         1023 KB\r
+    // 0xFED00400    gap                          111 KB\r
+    // 0xFED1C000    gap (PIIX4) / RCRB (ICH9)     16 KB\r
+    // 0xFED20000    gap                          896 KB\r
     // 0xFEE00000    LAPIC                          1 MB\r
     //\r
-    AddIoMemoryRangeHob (TopOfLowRam < BASE_2GB ?\r
-                         BASE_2GB : TopOfLowRam, 0xFC000000);\r
+    PciSize = 0xFC000000 - PciBase;\r
+    AddIoMemoryBaseSizeHob (PciBase, PciSize);\r
+    PcdSet64 (PcdPciMmio32Base, PciBase);\r
+    PcdSet64 (PcdPciMmio32Size, PciSize);\r
     AddIoMemoryBaseSizeHob (0xFEC00000, SIZE_4KB);\r
     AddIoMemoryBaseSizeHob (0xFED00000, SIZE_1KB);\r
+    if (mHostBridgeDevId == INTEL_Q35_MCH_DEVICE_ID) {\r
+      AddIoMemoryBaseSizeHob (ICH9_ROOT_COMPLEX_BASE, SIZE_16KB);\r
+      //\r
+      // Note: there should be an\r
+      //\r
+      //   AddIoMemoryBaseSizeHob (PciExBarBase, SIZE_256MB);\r
+      //\r
+      // call below, just like the one above for RCBA. However, Linux insists\r
+      // that the MMCONFIG area be marked in the E820 or UEFI memory map as\r
+      // "reserved memory" -- Linux does not content itself with a simple gap\r
+      // in the memory map wherever the MCFG ACPI table points to.\r
+      //\r
+      // This appears to be a safety measure. The PCI Firmware Specification\r
+      // (rev 3.1) says in 4.1.2. "MCFG Table Description": "The resources can\r
+      // *optionally* be returned in [...] EFIGetMemoryMap as reserved memory\r
+      // [...]". (Emphasis added here.)\r
+      //\r
+      // Normally we add memory resource descriptor HOBs in\r
+      // QemuInitializeRam(), and pre-allocate from those with memory\r
+      // allocation HOBs in InitializeRamRegions(). However, the MMCONFIG area\r
+      // is most definitely not RAM; so, as an exception, cover it with\r
+      // uncacheable reserved memory right here.\r
+      //\r
+      AddReservedMemoryBaseSizeHob (PciExBarBase, SIZE_256MB, FALSE);\r
+      BuildMemoryAllocationHob (PciExBarBase, SIZE_256MB,\r
+        EfiReservedMemoryType);\r
+    }\r
     AddIoMemoryBaseSizeHob (PcdGet32(PcdCpuLocalApicBaseAddress), SIZE_1MB);\r
   }\r
 }\r
 \r
+EFI_STATUS\r
+GetNamedFwCfgBoolean (\r
+  IN  CHAR8   *FwCfgFileName,\r
+  OUT BOOLEAN *Setting\r
+  )\r
+{\r
+  EFI_STATUS           Status;\r
+  FIRMWARE_CONFIG_ITEM FwCfgItem;\r
+  UINTN                FwCfgSize;\r
+  UINT8                Value[3];\r
+\r
+  Status = QemuFwCfgFindFile (FwCfgFileName, &FwCfgItem, &FwCfgSize);\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+  if (FwCfgSize > sizeof Value) {\r
+    return EFI_BAD_BUFFER_SIZE;\r
+  }\r
+  QemuFwCfgSelectItem (FwCfgItem);\r
+  QemuFwCfgReadBytes (FwCfgSize, Value);\r
+\r
+  if ((FwCfgSize == 1) ||\r
+      (FwCfgSize == 2 && Value[1] == '\n') ||\r
+      (FwCfgSize == 3 && Value[1] == '\r' && Value[2] == '\n')) {\r
+    switch (Value[0]) {\r
+      case '0':\r
+      case 'n':\r
+      case 'N':\r
+        *Setting = FALSE;\r
+        return EFI_SUCCESS;\r
+\r
+      case '1':\r
+      case 'y':\r
+      case 'Y':\r
+        *Setting = TRUE;\r
+        return EFI_SUCCESS;\r
+\r
+      default:\r
+        break;\r
+    }\r
+  }\r
+  return EFI_PROTOCOL_ERROR;\r
+}\r
+\r
+#define UPDATE_BOOLEAN_PCD_FROM_FW_CFG(TokenName)                   \\r
+          do {                                                      \\r
+            BOOLEAN Setting;                                        \\r
+                                                                    \\r
+            if (!EFI_ERROR (GetNamedFwCfgBoolean (                  \\r
+                              "opt/ovmf/" #TokenName, &Setting))) { \\r
+              PcdSetBool (TokenName, Setting);                      \\r
+            }                                                       \\r
+          } while (0)\r
+\r
+VOID\r
+NoexecDxeInitialization (\r
+  VOID\r
+  )\r
+{\r
+  UPDATE_BOOLEAN_PCD_FROM_FW_CFG (PcdPropertiesTableEnable);\r
+  UPDATE_BOOLEAN_PCD_FROM_FW_CFG (PcdSetNxForStack);\r
+}\r
+\r
+VOID\r
+PciExBarInitialization (\r
+  VOID\r
+  )\r
+{\r
+  union {\r
+    UINT64 Uint64;\r
+    UINT32 Uint32[2];\r
+  } PciExBarBase;\r
+\r
+  //\r
+  // We only support the 256MB size for the MMCONFIG area:\r
+  // 256 buses * 32 devices * 8 functions * 4096 bytes config space.\r
+  //\r
+  // The masks used below enforce the Q35 requirements that the MMCONFIG area\r
+  // be (a) correctly aligned -- here at 256 MB --, (b) located under 64 GB.\r
+  //\r
+  // Note that (b) also ensures that the minimum address width we have\r
+  // determined in AddressWidthInitialization(), i.e., 36 bits, will suffice\r
+  // for DXE's page tables to cover the MMCONFIG area.\r
+  //\r
+  PciExBarBase.Uint64 = FixedPcdGet64 (PcdPciExpressBaseAddress);\r
+  ASSERT ((PciExBarBase.Uint32[1] & MCH_PCIEXBAR_HIGHMASK) == 0);\r
+  ASSERT ((PciExBarBase.Uint32[0] & MCH_PCIEXBAR_LOWMASK) == 0);\r
+\r
+  //\r
+  // Clear the PCIEXBAREN bit first, before programming the high register.\r
+  //\r
+  PciWrite32 (DRAMC_REGISTER_Q35 (MCH_PCIEXBAR_LOW), 0);\r
+\r
+  //\r
+  // Program the high register. Then program the low register, setting the\r
+  // MMCONFIG area size and enabling decoding at once.\r
+  //\r
+  PciWrite32 (DRAMC_REGISTER_Q35 (MCH_PCIEXBAR_HIGH), PciExBarBase.Uint32[1]);\r
+  PciWrite32 (\r
+    DRAMC_REGISTER_Q35 (MCH_PCIEXBAR_LOW),\r
+    PciExBarBase.Uint32[0] | MCH_PCIEXBAR_BUS_FF | MCH_PCIEXBAR_EN\r
+    );\r
+}\r
 \r
 VOID\r
 MiscInitialization (\r
   VOID\r
   )\r
 {\r
-  UINT16 HostBridgeDevId;\r
   UINTN  PmCmd;\r
   UINTN  Pmba;\r
-  UINTN  PmRegMisc;\r
+  UINTN  AcpiCtlReg;\r
+  UINT8  AcpiEnBit;\r
 \r
   //\r
   // Disable A20 Mask\r
@@ -240,41 +400,44 @@ MiscInitialization (
   IoOr8 (0x92, BIT1);\r
 \r
   //\r
-  // Build the CPU hob with 36-bit addressing and 16-bits of IO space.\r
+  // Build the CPU HOB with guest RAM size dependent address width and 16-bits\r
+  // of IO space. (Side note: unlike other HOBs, the CPU HOB is needed during\r
+  // S3 resume as well, so we build it unconditionally.)\r
   //\r
-  BuildCpuHob (36, 16);\r
+  BuildCpuHob (mPhysMemAddressWidth, 16);\r
 \r
   //\r
-  // Query Host Bridge DID to determine platform type and save to PCD\r
+  // Determine platform type and save Host Bridge DID to PCD\r
   //\r
-  HostBridgeDevId = PciRead16 (OVMF_HOSTBRIDGE_DID);\r
-  switch (HostBridgeDevId) {\r
+  switch (mHostBridgeDevId) {\r
     case INTEL_82441_DEVICE_ID:\r
-      PmCmd     = POWER_MGMT_REGISTER_PIIX4 (PCI_COMMAND_OFFSET);\r
-      Pmba      = POWER_MGMT_REGISTER_PIIX4 (0x40);\r
-      PmRegMisc = POWER_MGMT_REGISTER_PIIX4 (0x80);\r
+      PmCmd      = POWER_MGMT_REGISTER_PIIX4 (PCI_COMMAND_OFFSET);\r
+      Pmba       = POWER_MGMT_REGISTER_PIIX4 (PIIX4_PMBA);\r
+      AcpiCtlReg = POWER_MGMT_REGISTER_PIIX4 (PIIX4_PMREGMISC);\r
+      AcpiEnBit  = PIIX4_PMREGMISC_PMIOSE;\r
       break;\r
     case INTEL_Q35_MCH_DEVICE_ID:\r
-      PmCmd     = POWER_MGMT_REGISTER_Q35 (PCI_COMMAND_OFFSET);\r
-      Pmba      = POWER_MGMT_REGISTER_Q35 (0x40);\r
-      PmRegMisc = POWER_MGMT_REGISTER_Q35 (0x80);\r
+      PmCmd      = POWER_MGMT_REGISTER_Q35 (PCI_COMMAND_OFFSET);\r
+      Pmba       = POWER_MGMT_REGISTER_Q35 (ICH9_PMBASE);\r
+      AcpiCtlReg = POWER_MGMT_REGISTER_Q35 (ICH9_ACPI_CNTL);\r
+      AcpiEnBit  = ICH9_ACPI_CNTL_ACPI_EN;\r
       break;\r
     default:\r
       DEBUG ((EFI_D_ERROR, "%a: Unknown Host Bridge Device ID: 0x%04x\n",\r
-        __FUNCTION__, HostBridgeDevId));\r
+        __FUNCTION__, mHostBridgeDevId));\r
       ASSERT (FALSE);\r
       return;\r
   }\r
-  PcdSet16 (PcdOvmfHostBridgePciDevId, HostBridgeDevId);\r
+  PcdSet16 (PcdOvmfHostBridgePciDevId, mHostBridgeDevId);\r
 \r
   //\r
-  // If PMREGMISC/PMIOSE is set, assume the ACPI PMBA has been configured (for\r
-  // example by Xen) and skip the setup here. This matches the logic in\r
-  // AcpiTimerLibConstructor ().\r
+  // If the appropriate IOspace enable bit is set, assume the ACPI PMBA\r
+  // has been configured (e.g., by Xen) and skip the setup here.\r
+  // This matches the logic in AcpiTimerLibConstructor ().\r
   //\r
-  if ((PciRead8 (PmRegMisc) & 0x01) == 0) {\r
+  if ((PciRead8 (AcpiCtlReg) & AcpiEnBit) == 0) {\r
     //\r
-    // The PEI phase should be exited with fully accessibe PIIX4 IO space:\r
+    // The PEI phase should be exited with fully accessibe ACPI PM IO space:\r
     // 1. set PMBA\r
     //\r
     PciAndThenOr32 (Pmba, (UINT32) ~0xFFC0, PcdGet16 (PcdAcpiPmBaseAddress));\r
@@ -285,9 +448,24 @@ MiscInitialization (
     PciOr8 (PmCmd, EFI_PCI_COMMAND_IO_SPACE);\r
 \r
     //\r
-    // 3. set PMREGMISC/PMIOSE\r
+    // 3. set ACPI PM IO enable bit (PMREGMISC:PMIOSE or ACPI_CNTL:ACPI_EN)\r
     //\r
-    PciOr8 (PmRegMisc, 0x01);\r
+    PciOr8 (AcpiCtlReg, AcpiEnBit);\r
+  }\r
+\r
+  if (mHostBridgeDevId == INTEL_Q35_MCH_DEVICE_ID) {\r
+    //\r
+    // Set Root Complex Register Block BAR\r
+    //\r
+    PciWrite32 (\r
+      POWER_MGMT_REGISTER_Q35 (ICH9_RCBA),\r
+      ICH9_ROOT_COMPLEX_BASE | ICH9_RCBA_EN\r
+      );\r
+\r
+    //\r
+    // Set PCI Express Register Range Base Address\r
+    //\r
+    PciExBarInitialization ();\r
   }\r
 }\r
 \r
@@ -302,6 +480,7 @@ BootModeInitialization (
   if (CmosRead8 (0xF) == 0xFE) {\r
     mBootMode = BOOT_ON_S3_RESUME;\r
   }\r
+  CmosWrite8 (0xF, 0x00);\r
 \r
   Status = PeiServicesSetBootMode (mBootMode);\r
   ASSERT_EFI_ERROR (Status);\r
@@ -343,7 +522,7 @@ DebugDumpCmos (
   VOID\r
   )\r
 {\r
-  UINT Loop;\r
+  UINT32 Loop;\r
 \r
   DEBUG ((EFI_D_INFO, "CMOS:\n"));\r
 \r
@@ -359,6 +538,27 @@ DebugDumpCmos (
 }\r
 \r
 \r
+VOID\r
+S3Verification (\r
+  VOID\r
+  )\r
+{\r
+#if defined (MDE_CPU_X64)\r
+  if (FeaturePcdGet (PcdSmmSmramRequire) && mS3Supported) {\r
+    DEBUG ((EFI_D_ERROR,\r
+      "%a: S3Resume2Pei doesn't support X64 PEI + SMM yet.\n", __FUNCTION__));\r
+    DEBUG ((EFI_D_ERROR,\r
+      "%a: Please disable S3 on the QEMU command line (see the README),\n",\r
+      __FUNCTION__));\r
+    DEBUG ((EFI_D_ERROR,\r
+      "%a: or build OVMF with \"OvmfPkgIa32X64.dsc\".\n", __FUNCTION__));\r
+    ASSERT (FALSE);\r
+    CpuDeadLoop ();\r
+  }\r
+#endif\r
+}\r
+\r
+\r
 /**\r
   Perform Platform PEI initialization.\r
 \r
@@ -386,7 +586,9 @@ InitializePlatform (
     mS3Supported = TRUE;\r
   }\r
 \r
+  S3Verification ();\r
   BootModeInitialization ();\r
+  AddressWidthInitialization ();\r
 \r
   PublishPeiMemory ();\r
 \r
@@ -397,12 +599,16 @@ InitializePlatform (
     InitializeXen ();\r
   }\r
 \r
+  //\r
+  // Query Host Bridge DID\r
+  //\r
+  mHostBridgeDevId = PciRead16 (OVMF_HOSTBRIDGE_DID);\r
+\r
   if (mBootMode != BOOT_ON_S3_RESUME) {\r
     ReserveEmuVariableNvStore ();\r
-\r
     PeiFvInitialization ();\r
-\r
     MemMapInitialization ();\r
+    NoexecDxeInitialization ();\r
   }\r
 \r
   MiscInitialization ();\r