All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH v2 08/24] docs: misc-devices/pci-endpoint-test.txt: convert to ReST
Date: Mon, 17 Feb 2020 17:20:26 +0100	[thread overview]
Message-ID: <09653768d9004106745ee1d2defaa1a43d2b5ba6.1581956285.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1581956285.git.mchehab+huawei@kernel.org>

- Use titles markups;
- Adjust identation;
- use literal markup;
- Use the proper notation for footnotes.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/misc-devices/index.rst          |  1 +
 .../misc-devices/pci-endpoint-test.rst        | 56 +++++++++++++++++++
 .../misc-devices/pci-endpoint-test.txt        | 41 --------------
 3 files changed, 57 insertions(+), 41 deletions(-)
 create mode 100644 Documentation/misc-devices/pci-endpoint-test.rst
 delete mode 100644 Documentation/misc-devices/pci-endpoint-test.txt

diff --git a/Documentation/misc-devices/index.rst b/Documentation/misc-devices/index.rst
index 005547c1ad5d..04f5dab2384c 100644
--- a/Documentation/misc-devices/index.rst
+++ b/Documentation/misc-devices/index.rst
@@ -21,5 +21,6 @@ fit into other categories.
    isl29003
    lis3lv02d
    max6875
+   pci-endpoint-test
    spear-pcie-gadget
    xilinx_sdfec
diff --git a/Documentation/misc-devices/pci-endpoint-test.rst b/Documentation/misc-devices/pci-endpoint-test.rst
new file mode 100644
index 000000000000..26e5d9ba146b
--- /dev/null
+++ b/Documentation/misc-devices/pci-endpoint-test.rst
@@ -0,0 +1,56 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=====================================
+Driver for PCI Endpoint Test Function
+=====================================
+
+This driver should be used as a host side driver if the root complex is
+connected to a configurable PCI endpoint running ``pci_epf_test`` function
+driver configured according to [1]_.
+
+The "pci_endpoint_test" driver can be used to perform the following tests.
+
+The PCI driver for the test device performs the following tests:
+
+	#) verifying addresses programmed in BAR
+	#) raise legacy IRQ
+	#) raise MSI IRQ
+	#) raise MSI-X IRQ
+	#) read data
+	#) write data
+	#) copy data
+
+This misc driver creates /dev/pci-endpoint-test.<num> for every
+``pci_epf_test`` function connected to the root complex and "ioctls"
+should be used to perform the above tests.
+
+ioctl
+-----
+
+ PCITEST_BAR:
+	      Tests the BAR. The number of the BAR to be tested
+	      should be passed as argument.
+ PCITEST_LEGACY_IRQ:
+	      Tests legacy IRQ
+ PCITEST_MSI:
+	      Tests message signalled interrupts. The MSI number
+	      to be tested should be passed as argument.
+ PCITEST_MSIX:
+	      Tests message signalled interrupts. The MSI-X number
+	      to be tested should be passed as argument.
+ PCITEST_SET_IRQTYPE:
+	      Changes driver IRQ type configuration. The IRQ type
+	      should be passed as argument (0: Legacy, 1:MSI, 2:MSI-X).
+ PCITEST_GET_IRQTYPE:
+	      Gets driver IRQ type configuration.
+ PCITEST_WRITE:
+	      Perform write tests. The size of the buffer should be passed
+	      as argument.
+ PCITEST_READ:
+	      Perform read tests. The size of the buffer should be passed
+	      as argument.
+ PCITEST_COPY:
+	      Perform read tests. The size of the buffer should be passed
+	      as argument.
+
+.. [1] Documentation/PCI/endpoint/function/binding/pci-test.txt
diff --git a/Documentation/misc-devices/pci-endpoint-test.txt b/Documentation/misc-devices/pci-endpoint-test.txt
deleted file mode 100644
index 58ccca4416b1..000000000000
--- a/Documentation/misc-devices/pci-endpoint-test.txt
+++ /dev/null
@@ -1,41 +0,0 @@
-Driver for PCI Endpoint Test Function
-
-This driver should be used as a host side driver if the root complex is
-connected to a configurable PCI endpoint running *pci_epf_test* function
-driver configured according to [1].
-
-The "pci_endpoint_test" driver can be used to perform the following tests.
-
-The PCI driver for the test device performs the following tests
-	*) verifying addresses programmed in BAR
-	*) raise legacy IRQ
-	*) raise MSI IRQ
-	*) raise MSI-X IRQ
-	*) read data
-	*) write data
-	*) copy data
-
-This misc driver creates /dev/pci-endpoint-test.<num> for every
-*pci_epf_test* function connected to the root complex and "ioctls"
-should be used to perform the above tests.
-
-ioctl
------
- PCITEST_BAR: Tests the BAR. The number of the BAR to be tested
-	      should be passed as argument.
- PCITEST_LEGACY_IRQ: Tests legacy IRQ
- PCITEST_MSI: Tests message signalled interrupts. The MSI number
-	      to be tested should be passed as argument.
- PCITEST_MSIX: Tests message signalled interrupts. The MSI-X number
-	      to be tested should be passed as argument.
- PCITEST_SET_IRQTYPE: Changes driver IRQ type configuration. The IRQ type
-	      should be passed as argument (0: Legacy, 1:MSI, 2:MSI-X).
- PCITEST_GET_IRQTYPE: Gets driver IRQ type configuration.
- PCITEST_WRITE: Perform write tests. The size of the buffer should be passed
-		as argument.
- PCITEST_READ: Perform read tests. The size of the buffer should be passed
-	       as argument.
- PCITEST_COPY: Perform read tests. The size of the buffer should be passed
-	       as argument.
-
-[1] -> Documentation/PCI/endpoint/function/binding/pci-test.txt
-- 
2.24.1


  parent reply	other threads:[~2020-02-17 16:20 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-17 16:20 [PATCH v2 00/24] Manually convert thermal, crypto and misc devices to ReST Mauro Carvalho Chehab
2020-02-17 16:20 ` Mauro Carvalho Chehab
2020-02-17 16:20 ` Mauro Carvalho Chehab
2020-02-17 16:20 ` Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 01/24] docs: thermal: convert cpu-idle-cooling.rst " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 02/24] docs: crypto: convert asymmetric-keys.txt " Mauro Carvalho Chehab
2020-02-17 16:20   ` Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 03/24] docs: crypto: convert api-intro.txt to ReST format Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 04/24] docs: crypto: convert async-tx-api.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 05/24] docs: crypto: descore-readme.txt: convert " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 06/24] docs: misc-devices/spear-pcie-gadget.txt: convert to ReST Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 07/24] docs: misc-devices/pci-endpoint-test.txt: " Mauro Carvalho Chehab
2020-02-17 16:20 ` Mauro Carvalho Chehab [this message]
2020-02-17 16:20 ` [PATCH v2 09/24] docs: misc-devices/c2port.txt: convert to ReST format Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 10/24] docs: misc-devices/bh1770glc.txt: convert to ReST Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 11/24] docs: misc-devices/apds990x.txt: convert to ReST format Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 12/24] docs: pci: endpoint/function/binding/pci-test.txt convert to ReST Mauro Carvalho Chehab
2020-02-27 23:03   ` Bjorn Helgaas
2020-02-17 16:20 ` [PATCH v2 13/24] docs: arm64: convert perf.txt to ReST format Mauro Carvalho Chehab
2020-02-17 16:20   ` Mauro Carvalho Chehab
2020-06-02 21:01   ` Rob Herring
2020-06-02 21:01     ` Rob Herring
2020-02-17 16:20 ` [PATCH v2 14/24] docs: cpu-freq: convert index.txt to ReST Mauro Carvalho Chehab
2020-02-17 20:06   ` Rafael J. Wysocki
2020-02-28  9:14     ` Mauro Carvalho Chehab
2020-02-28  9:33       ` Rafael J. Wysocki
2020-03-02 21:19   ` Jonathan Corbet
2020-03-02 22:16     ` Rafael J. Wysocki
2020-03-03 13:54       ` Mauro Carvalho Chehab
2020-03-03 14:01     ` Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 15/24] docs: cpu-freq: convert amd-powernow.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 16/24] docs: cpu-freq: convert core.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 17/24] docs: cpu-freq: convert cpu-drivers.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 18/24] docs: cpu-freq: convert cpufreq-nforce2.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 19/24] docs: cpu-freq: convert cpufreq-stats.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 20/24] docs: cpu-freq: convert pcc-cpufreq.txt " Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 21/24] docs: powerpc: convert vcpudispatch_stats.txt " Mauro Carvalho Chehab
2020-02-17 16:20   ` Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 22/24] docs: sh: convert new-machine.txt " Mauro Carvalho Chehab
2020-02-17 16:20   ` Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 23/24] docs: sh: convert register-banks.txt " Mauro Carvalho Chehab
2020-02-17 16:20   ` Mauro Carvalho Chehab
2020-02-17 16:20 ` [PATCH v2 24/24] docs: trace: ring-buffer-design.txt: convert to ReST format Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=09653768d9004106745ee1d2defaa1a43d2b5ba6.1581956285.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.