leandrof/linux
1
0
Fork 0
forked from Minki/linux
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: misc-devices/pci-endpoint-test.txt: convert to ReST

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

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/d4def59b3e3042208ed44558ddfd96c8753fb88c.1592203650.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2020-06-15 08:50:14 +02:00 committed by Jonathan Corbet
parent 8a05eb89cb
commit 16a60665cf
3 changed files with 57 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/misc-devices/index.rst
View File

@ -22,6 +22,7 @@ fit into other categories.
lis3lv02d
max6875
mic/index
pci-endpoint-test
spear-pcie-gadget
uacce
xilinx_sdfec

56
Documentation/misc-devices/pci-endpoint-test.rst Normal file
View File

@ -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

41
Documentation/misc-devices/pci-endpoint-test.txt
View File

@ -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