docs: pci: endpoint/function/binding/pci-test.txt convert to ReST
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Mon, 15 Jun 2020 06:50:18 +0000 (08:50 +0200)
committerJonathan Corbet <corbet@lwn.net>
Fri, 19 Jun 2020 20:09:28 +0000 (14:09 -0600)
Convert this file to ReST by adding a proper title to it and
use the right markups for a table.

While here, add a SPDX header.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/6254963b85417e44865dab05e4b99cd485074132.1592203650.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/PCI/endpoint/function/binding/pci-test.rst [new file with mode: 0644]
Documentation/PCI/endpoint/function/binding/pci-test.txt [deleted file]
Documentation/PCI/endpoint/index.rst
Documentation/misc-devices/pci-endpoint-test.rst

diff --git a/Documentation/PCI/endpoint/function/binding/pci-test.rst b/Documentation/PCI/endpoint/function/binding/pci-test.rst
new file mode 100644 (file)
index 0000000..57ee866
--- /dev/null
@@ -0,0 +1,26 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==========================
+PCI Test Endpoint Function
+==========================
+
+name: Should be "pci_epf_test" to bind to the pci_epf_test driver.
+
+Configurable Fields:
+
+================   ===========================================================
+vendorid          should be 0x104c
+deviceid          should be 0xb500 for DRA74x and 0xb501 for DRA72x
+revid             don't care
+progif_code       don't care
+subclass_code     don't care
+baseclass_code    should be 0xff
+cache_line_size           don't care
+subsys_vendor_id   don't care
+subsys_id         don't care
+interrupt_pin     Should be 1 - INTA, 2 - INTB, 3 - INTC, 4 -INTD
+msi_interrupts    Should be 1 to 32 depending on the number of MSI interrupts
+                  to test
+msix_interrupts           Should be 1 to 2048 depending on the number of MSI-X
+                  interrupts to test
+================   ===========================================================
diff --git a/Documentation/PCI/endpoint/function/binding/pci-test.txt b/Documentation/PCI/endpoint/function/binding/pci-test.txt
deleted file mode 100644 (file)
index cd76ba4..0000000
+++ /dev/null
@@ -1,19 +0,0 @@
-PCI TEST ENDPOINT FUNCTION
-
-name: Should be "pci_epf_test" to bind to the pci_epf_test driver.
-
-Configurable Fields:
-vendorid        : should be 0x104c
-deviceid        : should be 0xb500 for DRA74x and 0xb501 for DRA72x
-revid           : don't care
-progif_code     : don't care
-subclass_code   : don't care
-baseclass_code  : should be 0xff
-cache_line_size         : don't care
-subsys_vendor_id : don't care
-subsys_id       : don't care
-interrupt_pin   : Should be 1 - INTA, 2 - INTB, 3 - INTC, 4 -INTD
-msi_interrupts  : Should be 1 to 32 depending on the number of MSI interrupts
-                  to test
-msix_interrupts         : Should be 1 to 2048 depending on the number of MSI-X
-                  interrupts to test
index d114ea7..4ca7439 100644 (file)
@@ -11,3 +11,5 @@ PCI Endpoint Framework
    pci-endpoint-cfs
    pci-test-function
    pci-test-howto
+
+   function/binding/pci-test
index 26e5d9b..4cf3f44 100644 (file)
@@ -53,4 +53,4 @@ ioctl
              Perform read tests. The size of the buffer should be passed
              as argument.
 
-.. [1] Documentation/PCI/endpoint/function/binding/pci-test.txt
+.. [1] Documentation/PCI/endpoint/function/binding/pci-test.rst