Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > linux.kernel > #1609635

[PATCH v5 19/24] Documentation: misc-devices: Add Documentation for pci-endpoint-test driver

From Kishon Vijay Abraham I <kishon@ti.com>
Newsgroups linux.kernel
Subject [PATCH v5 19/24] Documentation: misc-devices: Add Documentation for pci-endpoint-test driver
Date 2017-03-27 11:50 +0200
Message-ID <tpzrJ-62q-53@gated-at.bofh.it> (permalink)
References <tpzrH-62q-5@gated-at.bofh.it>
Organization linux.* mail to news gateway

Show all headers | View raw


Add Documentation for pci-endpoint-test driver.

Signed-off-by: Kishon Vijay Abraham I <kishon@ti.com>
---
 Documentation/misc-devices/pci-endpoint-test.txt | 35 ++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 Documentation/misc-devices/pci-endpoint-test.txt

diff --git a/Documentation/misc-devices/pci-endpoint-test.txt b/Documentation/misc-devices/pci-endpoint-test.txt
new file mode 100644
index 000000000000..438571898d27
--- /dev/null
+++ b/Documentation/misc-devices/pci-endpoint-test.txt
@@ -0,0 +1,35 @@
+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
+	*) 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 that has to be tested
+	      should be passed as argument.
+ PCITEST_LEGACY_IRQ: Tests legacy IRQ
+ PCITEST_MSI: Tests message signalled interrupts. The MSI number that has
+	      to be tested should be passed as argument.
+ 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.11.0

Back to linux.kernel | Previous | NextPrevious in thread | Next in thread | Find similar | Unroll thread


Thread

[GIT PULL] PCI: Support for configurable PCI endpoint  Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 11:50 +0200
  [PATCH v5 22/24] Documentation: PCI: Add userguide for PCI endpoint test function Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 11:50 +0200
  [PATCH v5 11/24] PCI: dwc: dra7xx: Facilitate wrapper and msi interrupts to be enabled independently Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 11:50 +0200
  [PATCH v5 06/24] Documentation: PCI: Add specification for the *pci test* function device Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 11:50 +0200
  [PATCH v5 05/24] PCI: endpoint: Create configfs entry for EPC device and EPF driver Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 11:50 +0200
  [PATCH v5 14/24] dt-bindings: mfd: syscon: Add documentation for #syscon-cells property Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 11:50 +0200
    Re: [PATCH v5 14/24] dt-bindings: mfd: syscon: Add documentation for  #syscon-cells property Rob Herring <robh@kernel.org> - 2017-03-31 21:00 +0200
      Re: [PATCH v5 14/24] dt-bindings: mfd: syscon: Add documentation for  #syscon-cells property Rob Herring <robh@kernel.org> - 2017-03-31 21:10 +0200
        Re: [PATCH v5 14/24] dt-bindings: mfd: syscon: Add documentation for  #syscon-cells property Kishon Vijay Abraham I <kishon@ti.com> - 2017-04-05 10:40 +0200
  [PATCH v5 17/24] PCI: Add device IDs for DRA74x and DRA72x Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 11:50 +0200
  [PATCH v5 24/24] ARM: DRA7: clockdomain: Change the CLKTRCTRL of CM_PCIE_CLKSTCTRL to SW_WKUP Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 11:50 +0200
  [PATCH v5 10/24] dt-bindings: PCI: Add dt bindings for pci designware EP mode Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 11:50 +0200
  [PATCH v5 19/24] Documentation: misc-devices: Add Documentation for pci-endpoint-test driver Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 11:50 +0200
  [PATCH v5 07/24] PCI: endpoint: functions: Add an EP function to test PCI Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 11:50 +0200
  [PATCH v5 21/24] tools: PCI: Add sample test script to invoke pcitest Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 11:50 +0200
  [PATCH v5 20/24] tools: PCI: Add a userspace tool to test PCI endpoint Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 12:00 +0200
  [PATCH v5 15/24] PCI: dwc: dra7xx: Workaround for errata id i870 Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 12:00 +0200
  [PATCH v5 12/24] PCI: dwc: dra7xx: Add EP mode support Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 12:00 +0200
  [PATCH v5 13/24] dt-bindings: PCI: dra7xx: Add dt bindings for pci dra7xx EP mode Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 12:00 +0200
  [PATCH v5 02/24] Documentation: PCI: Guide to use PCI Endpoint Core Layer Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 12:00 +0200
  [PATCH v5 16/24] dt-bindings: PCI: dra7xx: Add dt bindings to enable unaligned access Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 12:00 +0200
    Re: [PATCH v5 16/24] dt-bindings: PCI: dra7xx: Add dt bindings to  enable unaligned access Rob Herring <robh@kernel.org> - 2017-03-31 21:10 +0200
  [PATCH v5 18/24] misc: Add host side pci driver for pci test function device Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 12:00 +0200
  [PATCH v5 08/24] Documentation: PCI: Add binding documentation for pci-test endpoint function Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 12:00 +0200
  [PATCH v5 09/24] PCI: dwc: designware: Add EP mode support Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 12:00 +0200
  [PATCH v5 03/24] PCI: endpoint: Introduce configfs entry for configuring EP functions Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 12:00 +0200
  [PATCH v5 23/24] MAINTAINERS: add PCI EP maintainer Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-27 12:20 +0200
  Re: [GIT PULL] PCI: Support for configurable PCI endpoint Niklas Cassel <niklas.cassel@axis.com> - 2017-03-29 13:50 +0200
    Re: [GIT PULL] PCI: Support for configurable PCI endpoint Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-29 14:20 +0200
      Re: [GIT PULL] PCI: Support for configurable PCI endpoint Kishon Vijay Abraham I <kishon@ti.com> - 2017-03-29 14:40 +0200
        Re: [GIT PULL] PCI: Support for configurable PCI endpoint Niklas Cassel <niklas.cassel@axis.com> - 2017-03-29 15:20 +0200
  Re: [GIT PULL] PCI: Support for configurable PCI endpoint Bjorn Helgaas <helgaas@kernel.org> - 2017-04-04 22:40 +0200
    Re: [GIT PULL] PCI: Support for configurable PCI endpoint Kishon Vijay Abraham I <kishon@ti.com> - 2017-04-05 11:00 +0200

csiph-web