Skip to contentSkip to conversation

misc: pci_endpoint_test: Give disabled BARs a distinct error code

PATCH Applied Niklas Cassel 2 participants 8 messages Jan 23, 2025 – Feb 14, 2025

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH 1/2 misc: pci_endpoint_test: Give disabled BARs a distinct error code

The current code returns -ENOMEM if test->bar[barno] is NULL.

There can be two reasons why test->bar[barno] is NULL:
1) The pci_ioremap_bar() call in pci_endpoint_test_probe() failed.
2) The BAR was skipped, because it is disabled by the endpoint.

Many PCI endpoint controller drivers will disable all BARs in their init function. A disabled BAR will have a size of 0.

A PCI endpoint function driver will be able to enable any BAR that is not marked as BAR_RESERVED (which means that the BAR should not be touched by the EPF driver).

Thus, perform check if the size is 0, before checking if test->bar[barno] is NULL, such that we can return different errors.

This will allow the selftests to return SKIP instead of FAIL for disabled BARs.

---
Hello PCI maintainers.
This patch might give a trivial conflict with:
https://lore.kernel.org/linux-pci/[email protected]/T/#u
because the context lines (lines that haven't been changed) might be different. If there is a conflict, simply look at this patch by itself, and resolution should be trivial.

 drivers/misc/pci_endpoint_test.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
drivers/misc/pci_endpoint_test.c +4 -2
index d5ac71a49386..b95980b29eb9 100644
@@ -292,11 +292,13 @@ static int pci_endpoint_test_bar(struct pci_endpoint_test *test,
 	void *read_buf __free(kfree) = NULL;
 	struct pci_dev *pdev = test->pdev;
 
+	bar_size = pci_resource_len(pdev, barno);
+	if (!bar_size)
+		return -ENODATA;
+
 	if (!test->bar[barno])
 		return -ENOMEM;
 
-	bar_size = pci_resource_len(pdev, barno);
-
 	if (barno == test->test_reg_bar)
 		bar_size = 0x4;
 
Signature · 1 line
2.48.1
#1 lore raw

PATCH 2/2 selftests: pci_endpoint: Skip disabled BARs

Currently BARs that have been disabled by the endpoint controller driver will result in a test FAIL.

Returning FAIL for a BAR that is disabled seems overly pessimistic.

There are EPC that disables one or more BARs intentionally.

One reason for this is that there are certain EPCs that are hardwired to expose internal PCIe controller registers over a certain BAR, so the EPC driver disables such a BAR, such that the host will not overwrite random registers during testing.

Such a BAR will be disabled by the EPC driver's init function, and the BAR will be marked as BAR_RESERVED, such that it will be unavailable to endpoint function drivers.

Let's return FAIL only for BARs that are actually enabled and failed the test, and let's return skip for BARs that are not even enabled.

---
 tools/testing/selftests/pci_endpoint/pci_endpoint_test.c | 2 ++
 1 file changed, 2 insertions(+)
tools/testing/selftests/pci_endpoint/pci_endpoint_test.c +2 -0
index c267b822c108..576c590b277b 100644
@@ -65,6 +65,8 @@ TEST_F(pci_ep_bar, BAR_TEST)
 	int ret;
 
 	pci_ep_ioctl(PCITEST_BAR, variant->barno);
+	if (ret == -ENODATA)
+		SKIP(return, "BAR is disabled");
 	EXPECT_FALSE(ret) TH_LOG("Test failed for BAR%d", variant->barno);
 }
 
Signature · 1 line
2.48.1
#4 lore raw
In reply to Niklas Cassel
Quoted 7 lines · Niklas Cassel

---
Hello PCI maintainers.
This patch might give a trivial conflict with:
https://lore.kernel.org/linux-pci/[email protected]/T/#u
because the context lines (lines that haven't been changed) might be different. If there is a conflict, simply look at this patch by itself, and resolution should be trivial.

Note to PCI maintainers:

As mentioned in the comment section of this patch, this patch has a trivial conflict with:
https://lore.kernel.org/linux-pci/[email protected]/T/#u

I noticed that git still manages to apply this patch correctly if applying this patch using:

$ git am -3

Kind regards,
Niklas

Reviewed-by on v1 1/2
#5 lore raw
In reply to Niklas Cassel
Quoted 13 lines · Niklas Cassel

The current code returns -ENOMEM if test->bar[barno] is NULL.

There can be two reasons why test->bar[barno] is NULL:
1) The pci_ioremap_bar() call in pci_endpoint_test_probe() failed.
2) The BAR was skipped, because it is disabled by the endpoint.

Many PCI endpoint controller drivers will disable all BARs in their init function. A disabled BAR will have a size of 0.

A PCI endpoint function driver will be able to enable any BAR that is not marked as BAR_RESERVED (which means that the BAR should not be touched by the EPF driver).

Quoted 7 lines

Thus, perform check if the size is 0, before checking if test->bar[barno] is NULL, such that we can return different errors.

This will allow the selftests to return SKIP instead of FAIL for disabled BARs.

- Mani

Quoted 34 lines

---
Hello PCI maintainers.
This patch might give a trivial conflict with:
https://lore.kernel.org/linux-pci/[email protected]/T/#u
because the context lines (lines that haven't been changed) might be different. If there is a conflict, simply look at this patch by itself, and resolution should be trivial.

 drivers/misc/pci_endpoint_test.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
drivers/misc/pci_endpoint_test.c +4 -2
index d5ac71a49386..b95980b29eb9 100644
@@ -292,11 +292,13 @@ static int pci_endpoint_test_bar(struct pci_endpoint_test *test,
 	void *read_buf __free(kfree) = NULL;
 	struct pci_dev *pdev = test->pdev;
 
+	bar_size = pci_resource_len(pdev, barno);
+	if (!bar_size)
+		return -ENODATA;
+
 	if (!test->bar[barno])
 		return -ENOMEM;
 
-	bar_size = pci_resource_len(pdev, barno);
-
 	if (barno == test->test_reg_bar)
 		bar_size = 0x4;
 
Signature · 1 line
2.48.1
Signature · 1 line
மணிவண்ணன் சதாசிவம்
Reviewed-by on v1 2/2
#2 lore raw

Re: [PATCH 2/2] selftests: pci_endpoint: Skip disabled BARs

In reply to Niklas Cassel
Quoted 12 lines · Niklas Cassel

Currently BARs that have been disabled by the endpoint controller driver will result in a test FAIL.

Returning FAIL for a BAR that is disabled seems overly pessimistic.

There are EPC that disables one or more BARs intentionally.

One reason for this is that there are certain EPCs that are hardwired to expose internal PCIe controller registers over a certain BAR, so the EPC driver disables such a BAR, such that the host will not overwrite random registers during testing.

Quoted 8 lines

Such a BAR will be disabled by the EPC driver's init function, and the BAR will be marked as BAR_RESERVED, such that it will be unavailable to endpoint function drivers.

Let's return FAIL only for BARs that are actually enabled and failed the test, and let's return skip for BARs that are not even enabled.

I was thinking about doing something similar since some of the BAR tests are failing on my Qcom setup. And you beat me to it :)

- Mani

Quoted 20 lines
---
 tools/testing/selftests/pci_endpoint/pci_endpoint_test.c | 2 ++
 1 file changed, 2 insertions(+)
tools/testing/selftests/pci_endpoint/pci_endpoint_test.c +2 -0
index c267b822c108..576c590b277b 100644
@@ -65,6 +65,8 @@ TEST_F(pci_ep_bar, BAR_TEST)
 	int ret;
 
 	pci_ep_ioctl(PCITEST_BAR, variant->barno);
+	if (ret == -ENODATA)
+		SKIP(return, "BAR is disabled");
 	EXPECT_FALSE(ret) TH_LOG("Test failed for BAR%d", variant->barno);
 }
 
Signature · 1 line
2.48.1
Signature · 1 line
மணிவண்ணன் சதாசிவம்
#6 lore raw
In reply to Niklas Cassel
Quoted 54 lines · Niklas Cassel

The current code returns -ENOMEM if test->bar[barno] is NULL.

There can be two reasons why test->bar[barno] is NULL:
1) The pci_ioremap_bar() call in pci_endpoint_test_probe() failed.
2) The BAR was skipped, because it is disabled by the endpoint.

Many PCI endpoint controller drivers will disable all BARs in their init function. A disabled BAR will have a size of 0.

A PCI endpoint function driver will be able to enable any BAR that is not marked as BAR_RESERVED (which means that the BAR should not be touched by the EPF driver).

Thus, perform check if the size is 0, before checking if test->bar[barno] is NULL, such that we can return different errors.

This will allow the selftests to return SKIP instead of FAIL for disabled BARs.

---
Hello PCI maintainers.
This patch might give a trivial conflict with:
https://lore.kernel.org/linux-pci/[email protected]/T/#u
because the context lines (lines that haven't been changed) might be different. If there is a conflict, simply look at this patch by itself, and resolution should be trivial.

 drivers/misc/pci_endpoint_test.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
drivers/misc/pci_endpoint_test.c +4 -2
index d5ac71a49386..b95980b29eb9 100644
@@ -292,11 +292,13 @@ static int pci_endpoint_test_bar(struct pci_endpoint_test *test,
 	void *read_buf __free(kfree) = NULL;
 	struct pci_dev *pdev = test->pdev;
 
+	bar_size = pci_resource_len(pdev, barno);
+	if (!bar_size)
+		return -ENODATA;
+
 	if (!test->bar[barno])
 		return -ENOMEM;
 
-	bar_size = pci_resource_len(pdev, barno);
-
 	if (barno == test->test_reg_bar)
 		bar_size = 0x4;
 
Signature · 1 line
2.48.1

Gentle ping on this series.

Kind regards,
Niklas

#7 lore raw
In reply to Niklas Cassel
Quoted 13 lines · Niklas Cassel

The current code returns -ENOMEM if test->bar[barno] is NULL.

There can be two reasons why test->bar[barno] is NULL:
1) The pci_ioremap_bar() call in pci_endpoint_test_probe() failed.
2) The BAR was skipped, because it is disabled by the endpoint.

Many PCI endpoint controller drivers will disable all BARs in their init function. A disabled BAR will have a size of 0.

A PCI endpoint function driver will be able to enable any BAR that is not marked as BAR_RESERVED (which means that the BAR should not be touched by the EPF driver).

Quoted 7 lines

Thus, perform check if the size is 0, before checking if test->bar[barno] is NULL, such that we can return different errors.

This will allow the selftests to return SKIP instead of FAIL for disabled BARs.

Applied to pci/endpoint!

- Mani

Quoted 34 lines

---
Hello PCI maintainers.
This patch might give a trivial conflict with:
https://lore.kernel.org/linux-pci/[email protected]/T/#u
because the context lines (lines that haven't been changed) might be different. If there is a conflict, simply look at this patch by itself, and resolution should be trivial.

 drivers/misc/pci_endpoint_test.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
drivers/misc/pci_endpoint_test.c +4 -2
index d5ac71a49386..b95980b29eb9 100644
@@ -292,11 +292,13 @@ static int pci_endpoint_test_bar(struct pci_endpoint_test *test,
 	void *read_buf __free(kfree) = NULL;
 	struct pci_dev *pdev = test->pdev;
 
+	bar_size = pci_resource_len(pdev, barno);
+	if (!bar_size)
+		return -ENODATA;
+
 	if (!test->bar[barno])
 		return -ENOMEM;
 
-	bar_size = pci_resource_len(pdev, barno);
-
 	if (barno == test->test_reg_bar)
 		bar_size = 0x4;
 
Signature · 1 line
2.48.1
Signature · 1 line
மணிவண்ணன் சதாசிவம்
#3 lore raw

Re: [PATCH 2/2] selftests: pci_endpoint: Skip disabled BARs

In reply to Niklas Cassel
Quoted 12 lines · Niklas Cassel

Currently BARs that have been disabled by the endpoint controller driver will result in a test FAIL.

Returning FAIL for a BAR that is disabled seems overly pessimistic.

There are EPC that disables one or more BARs intentionally.

One reason for this is that there are certain EPCs that are hardwired to expose internal PCIe controller registers over a certain BAR, so the EPC driver disables such a BAR, such that the host will not overwrite random registers during testing.

Quoted 8 lines

Such a BAR will be disabled by the EPC driver's init function, and the BAR will be marked as BAR_RESERVED, such that it will be unavailable to endpoint function drivers.

Let's return FAIL only for BARs that are actually enabled and failed the test, and let's return skip for BARs that are not even enabled.

Applied to pci/endpoint!

- Mani

Quoted 20 lines
---
 tools/testing/selftests/pci_endpoint/pci_endpoint_test.c | 2 ++
 1 file changed, 2 insertions(+)
tools/testing/selftests/pci_endpoint/pci_endpoint_test.c +2 -0
index c267b822c108..576c590b277b 100644
@@ -65,6 +65,8 @@ TEST_F(pci_ep_bar, BAR_TEST)
 	int ret;
 
 	pci_ep_ioctl(PCITEST_BAR, variant->barno);
+	if (ret == -ENODATA)
+		SKIP(return, "BAR is disabled");
 	EXPECT_FALSE(ret) TH_LOG("Test failed for BAR%d", variant->barno);
 }
 
Signature · 1 line
2.48.1
Signature · 1 line
மணிவண்ணன் சதாசிவம்