Skip to contentSkip to conversation

x86: Reenable the AMD IOMMU if it's mysteriously vanished over suspend

PATCH Superseded Matthew Garrett 3 participants 6 messages Oct 1, 2010 – Oct 6, 2010 x86

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 x86: Reenable the AMD IOMMU if it's mysteriously vanished over suspend

AMD's reference BIOS code had a bug that could result in the firmware failing to reenable the iommu on resume. It transpires that this causes certain less than desirable behaviour when it comes to PCI accesses, to whit them ending up somewhere near Bristol when the more desirable outcome was Edinburgh. Sadness ensues, perhaps along with filesystem corruption. Let's make sure that it gets turned back on, and that we restore its configuration so decisions it makes bear some resemblance to those made by reasonable people rather than crack-addled lemurs who spent all your DMA on Thunderbird.

---

Turns out that PCI resume is too late for this, so incorporate it all into the sysdev resume code in the driver

 arch/x86/include/asm/amd_iommu_types.h |   21 ++++--
 arch/x86/kernel/amd_iommu_init.c       |  134 +++++++++++++++++++++++++++++---
 2 files changed, 137 insertions(+), 18 deletions(-)
arch/x86/include/asm/amd_iommu_types.h +15 -6
index 0861618..bdd20c8 100644
@@ -416,13 +416,22 @@ struct amd_iommu {
 	struct dma_ops_domain *default_dom;
 
 	/*
-	 * This array is required to work around a potential BIOS bug.
-	 * The BIOS may miss to restore parts of the PCI configuration
-	 * space when the system resumes from S3. The result is that the
-	 * IOMMU does not execute commands anymore which leads to system
-	 * failure.
+	 * We can't rely on the BIOS to restore all values on reinit, so we
+	 * need to stash them
 	 */
-	u32 cache_cfg[4];
+
+	/* The iommu BAR */
+	u32 stored_addr_lo;
+	u32 stored_addr_hi;
+
+	/*
+	 * Each iommu has 6 l1s, each of which is documented as having 0x12
+	 * registers
+	 */
+	u32 stored_l1[6][0x12];
+
+	/* The l2 indirect registers */
+	u32 stored_l2[0x83];
 };
 
 /*
arch/x86/kernel/amd_iommu_init.c +122 -12

171 lines not on this page · raw message

Signature · 1 line
1.7.3
#1 lore raw

Hi Matthew,

first, thanks a lot for your work on this. I had the plan to do this myself but are busy with other work too. I am very happy that I can remove this from my todo list :-)
I have tested the patch on one of my test machines with the BIOS bug. It worked and the box came out of S3 again. The patch needs certainly more testing on more platforms. I also have a few comments, find them inline in the patch.

Joerg

Quoted 19 lines · Matthew Garrett
arch/x86/kernel/amd_iommu_init.c +2 -6
@@ -619,6 +652,7 @@ static void __init init_iommu_from_pci(struct amd_iommu *iommu)
 {
 	int cap_ptr = iommu->cap_ptr;
 	u32 range, misc;
+	int i, j;
 
 	pci_read_config_dword(iommu->dev, cap_ptr + MMIO_CAP_HDR_OFFSET,
 			      &iommu->cap);
@@ -633,12 +667,27 @@ static void __init init_iommu_from_pci(struct amd_iommu *iommu)
 					MMIO_GET_LD(range));
 	iommu->evt_msi_num = MMIO_MSI_NUM(misc);
 
-	if (is_rd890_iommu(iommu->dev)) {
-		pci_read_config_dword(iommu->dev, 0xf0, &iommu->cache_cfg[0]);
-		pci_read_config_dword(iommu->dev, 0xf4, &iommu->cache_cfg[1]);
-		pci_read_config_dword(iommu->dev, 0xf8, &iommu->cache_cfg[2]);
-		pci_read_config_dword(iommu->dev, 0xfc, &iommu->cache_cfg[3]);
-	}
+	if (!is_rd890_iommu(iommu->dev))

arch/x86/kernel/amd_iommu_init.c static void __init init_iommu_from_pci(struct amd_iommu *iommu) · line 680

Quoted 10 lines
arch/x86/kernel/amd_iommu_init.c +10 -0
+		return;
+
+	/*
+	 * Some rd890 systems may not be fully reconfigured by the BIOS, so
+	 * it's necessary for us to store this information so it can be
+	 * reprogrammed on resume
+	 */
+
+	pci_read_config_dword(iommu->dev, 0x44, &iommu->stored_addr_lo);
+	pci_read_config_dword(iommu->dev, 0x48, &iommu->stored_addr_hi);

Can you use iommu->cap_ptr here? This variant should be safe too but the magic numbers are non-descriptive.

Quoted 31 lines
arch/x86/kernel/amd_iommu_init.c +23 -5
 static void iommu_apply_quirks(struct amd_iommu *iommu)
 {
-	if (is_rd890_iommu(iommu->dev)) {
-		pci_write_config_dword(iommu->dev, 0xf0, iommu->cache_cfg[0]);
-		pci_write_config_dword(iommu->dev, 0xf4, iommu->cache_cfg[1]);
-		pci_write_config_dword(iommu->dev, 0xf8, iommu->cache_cfg[2]);
-		pci_write_config_dword(iommu->dev, 0xfc, iommu->cache_cfg[3]);
+	int i, j;
+	u32 ioc_feature_control;
+	struct pci_dev *pdev = NULL;
+	int device_id;
+
+	/* RD890 BIOSes may not have completely reconfigured the iommu */
+	if (!is_rd890_iommu(iommu->dev))
+		return;
+
+	/*
+	 * First, we need to ensure that the iommu is enabled. This is
+	 * controlled by a register in the northbridge
+	 */
+	device_id = 0x5a10;
+	pdev = pci_get_device(PCI_VENDOR_ID_ATI, device_id, NULL);
+
+	if (!pdev) {
+		device_id = 0x5a12;
+		pdev = pci_get_device(PCI_VENDOR_ID_ATI, device_id, NULL);
 	}
+
+	if (!pdev) {
+		device_id = 0x5a13;
+		pdev = pci_get_device(PCI_VENDOR_ID_ATI, device_id, NULL);

arch/x86/kernel/amd_iommu_init.c static void iommu_init_flags(struct amd_iommu *iommu) · line 1214

Quoted 10 lines
arch/x86/kernel/amd_iommu_init.c +10 -0
+	}
+
+	if (!pdev)
+		return;
+
+	/* There may be one iommu per bus, so find the appropriate bridge */
+	while (pdev && (pdev->bus->number != iommu->dev->bus->number)) {
+		pci_dev_put(pdev);
+		pdev = pci_get_device(PCI_VENDOR_ID_ATI, device_id, pdev);
+	}

This does not work reliably with more than one IOMMU in the system. I suggest to get the NB device by using the bus/dev/fn of the IOMMU device. The IOMMU in RD890 is always function 2 of the NB device. So just take the bus/dev/fn of the IOMMU device, set fn to zero and get the NB device for re-enabling function two.

arch/x86/kernel/amd_iommu_init.c static void iommu_init_flags(struct amd_iommu *iommu) · line 1231

Quoted 2 lines
arch/x86/kernel/amd_iommu_init.c +2 -0
+	pci_write_config_dword(iommu->dev, 0x44, iommu->stored_addr_lo);
+	pci_write_config_dword(iommu->dev, 0x48, iommu->stored_addr_hi);

iommu->cap_ptr

Quoted 9 lines
arch/x86/kernel/amd_iommu_init.c +0 -1
@@ -1147,7 +1253,6 @@ static void enable_iommus(void)
 
 	for_each_iommu(iommu) {
 		iommu_disable(iommu);
-		iommu_apply_quirks(iommu);
 		iommu_init_flags(iommu);
 		iommu_set_device_table(iommu);
 		iommu_enable_command_buffer(iommu);

arch/x86/kernel/amd_iommu_init.c static void disable_iommus(void) · line 1287

Quoted 10 lines
arch/x86/kernel/amd_iommu_init.c +5 -0
@@ -1173,6 +1278,11 @@ static void disable_iommus(void)
 
 static int amd_iommu_resume(struct sys_device *dev)
 {
+	struct amd_iommu *iommu;
+
+	for_each_iommu(iommu)
+		iommu_apply_quirks(iommu);
+
 	/* re-load the hardware */
 	enable_iommus();

Why have you moved this out of the enable_iommus() loop?

Joerg

Signature · 5 lines
AMD Operating System Research Center

Advanced Micro Devices GmbH Einsteinring 24 85609 Dornach
General Managers: Alberto Bozzo, Andrew Bowd
Registration: Dornach, Landkr. Muenchen; Registerger. Muenchen, HRB Nr. 43632
#2 lore raw
Quoted 5 lines · Joerg

arch/x86/kernel/amd_iommu_init.c static void __init init_iommu_from_pci(struct amd_iommu *iommu) · line 680

Quoted 2 lines
arch/x86/kernel/amd_iommu_init.c +2 -0
+	pci_read_config_dword(iommu->dev, 0x44, &iommu->stored_addr_lo);
+	pci_read_config_dword(iommu->dev, 0x48, &iommu->stored_addr_hi);

Can you use iommu->cap_ptr here? This variant should be safe too but the magic numbers are non-descriptive.

Sure.

Quoted 11 lines

arch/x86/kernel/amd_iommu_init.c static void iommu_init_flags(struct amd_iommu *iommu) · line 1214

Quoted 5 lines
arch/x86/kernel/amd_iommu_init.c +5 -0
+	/* There may be one iommu per bus, so find the appropriate bridge */
+	while (pdev && (pdev->bus->number != iommu->dev->bus->number)) {
+		pci_dev_put(pdev);
+		pdev = pci_get_device(PCI_VENDOR_ID_ATI, device_id, pdev);
+	}

This does not work reliably with more than one IOMMU in the system. I suggest to get the NB device by using the bus/dev/fn of the IOMMU device. The IOMMU in RD890 is always function 2 of the NB device. So just take the bus/dev/fn of the IOMMU device, set fn to zero and get the NB device for re-enabling function two.

The docs imply that the northbridge will always be device 0 on a given bus, so this ought to work? On the other hand, your approach is simpler.

Quoted 8 lines
Quoted 8 lines
arch/x86/kernel/amd_iommu_init.c +0 -1
 	for_each_iommu(iommu) {
 		iommu_disable(iommu);
-		iommu_apply_quirks(iommu);
 		iommu_init_flags(iommu);
 		iommu_set_device_table(iommu);
 		iommu_enable_command_buffer(iommu);
@@ -1173,6 +1278,11 @@ static void disable_iommus(void)
 
Quoted 11 lines

arch/x86/kernel/amd_iommu_init.c static void disable_iommus(void) · line 1287

Quoted 9 lines
arch/x86/kernel/amd_iommu_init.c +5 -0
 static int amd_iommu_resume(struct sys_device *dev)
 {
+	struct amd_iommu *iommu;
+
+	for_each_iommu(iommu)
+		iommu_apply_quirks(iommu);
+
 	/* re-load the hardware */
 	enable_iommus();

Why have you moved this out of the enable_iommus() loop?

enable_iommus() is called on init, whereas this should only be performed on resume.

I'll send out an updated patch later today.

Signature · 1 line
Matthew Garrett | [email protected]
#3 lore raw
Quoted 6 lines · Matthew Garrett
Quoted 2 lines · Joerg

Why have you moved this out of the enable_iommus() loop?

enable_iommus() is called on init, whereas this should only be performed on resume.

Ok, it shouldn't be problematic to do this always, but only on resume is safer. Can you rename iommu_apply_quirks to iommu_apply_resume_quirks then?

Quoted 1 line

I'll send out an updated patch later today.

Great. Looking forward to it.

Joerg

Signature · 5 lines
AMD Operating System Research Center

Advanced Micro Devices GmbH Einsteinring 24 85609 Dornach
General Managers: Alberto Bozzo, Andrew Bowd
Registration: Dornach, Landkr. Muenchen; Registerger. Muenchen, HRB Nr. 43632
#4 lore raw

PATCH v2 1/1 x86: Reenable the AMD IOMMU if it's mysteriously vanished over suspend

In reply to Roedel, Joerg

AMD's reference BIOS code had a bug that could result in the firmware failing to reenable the iommu on resume. It transpires that this causes certain less than desirable behaviour when it comes to PCI accesses, to whit them ending up somewhere near Bristol when the more desirable outcome was Edinburgh. Sadness ensues, perhaps along with filesystem corruption. Let's make sure that it gets turned back on, and that we restore its configuration so decisions it makes bear some resemblance to those made by reasonable people rather than crack-addled lemurs who spent all your DMA on Thunderbird.

---

Cleaned up slightly to match Joerg's comments

 arch/x86/include/asm/amd_iommu_types.h |   21 ++++--
 arch/x86/kernel/amd_iommu_init.c       |  122 ++++++++++++++++++++++++++++----
 2 files changed, 123 insertions(+), 20 deletions(-)
arch/x86/include/asm/amd_iommu_types.h +15 -6
index 0861618..bdd20c8 100644
@@ -416,13 +416,22 @@ struct amd_iommu {
 	struct dma_ops_domain *default_dom;
 
 	/*
-	 * This array is required to work around a potential BIOS bug.
-	 * The BIOS may miss to restore parts of the PCI configuration
-	 * space when the system resumes from S3. The result is that the
-	 * IOMMU does not execute commands anymore which leads to system
-	 * failure.
+	 * We can't rely on the BIOS to restore all values on reinit, so we
+	 * need to stash them
 	 */
-	u32 cache_cfg[4];
+
+	/* The iommu BAR */
+	u32 stored_addr_lo;
+	u32 stored_addr_hi;
+
+	/*
+	 * Each iommu has 6 l1s, each of which is documented as having 0x12
+	 * registers
+	 */
+	u32 stored_l1[6][0x12];
+
+	/* The l2 indirect registers */
+	u32 stored_l2[0x83];
 };
 
 /*
arch/x86/kernel/amd_iommu_init.c +108 -14

159 lines not on this page · raw message

Signature · 1 line
1.7.3.1
#5 lore raw
Quoted 10 lines · Matthew Garrett

AMD's reference BIOS code had a bug that could result in the firmware failing to reenable the iommu on resume. It transpires that this causes certain less than desirable behaviour when it comes to PCI accesses, to whit them ending up somewhere near Bristol when the more desirable outcome was Edinburgh. Sadness ensues, perhaps along with filesystem corruption. Let's make sure that it gets turned back on, and that we restore its configuration so decisions it makes bear some resemblance to those made by reasonable people rather than crack-addled lemurs who spent all your DMA on Thunderbird.

Quoted 2 lines

Applied, thanks a lot.

Signature · 5 lines
AMD Operating System Research Center

Advanced Micro Devices GmbH Einsteinring 24 85609 Dornach
General Managers: Alberto Bozzo, Andrew Bowd
Registration: Dornach, Landkr. Muenchen; Registerger. Muenchen, HRB Nr. 43632