docs: ABI: Add sysfs documentation interface of dw-xdata-pcie driver
authorGustavo Pimentel <Gustavo.Pimentel@synopsys.com>
Mon, 29 Mar 2021 11:17:48 +0000 (13:17 +0200)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Mon, 5 Apr 2021 11:15:52 +0000 (13:15 +0200)
This patch describes the sysfs interface implemented on the dw-xdata-pcie
driver.

Signed-off-by: Gustavo Pimentel <gustavo.pimentel@synopsys.com>
Link: https://lore.kernel.org/r/438c4ca9f6cc9e1cb29a65c0d2cca9a3d3f181b1.1617016509.git.gustavo.pimentel@synopsys.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/ABI/testing/sysfs-driver-xdata [new file with mode: 0644]

diff --git a/Documentation/ABI/testing/sysfs-driver-xdata b/Documentation/ABI/testing/sysfs-driver-xdata
new file mode 100644 (file)
index 0000000..f574e8e
--- /dev/null
@@ -0,0 +1,49 @@
+What:          /sys/class/misc/drivers/dw-xdata-pcie.<device>/write
+Date:          April 2021
+KernelVersion: 5.13
+Contact:       Gustavo Pimentel <gustavo.pimentel@synopsys.com>
+Description:   Allows the user to enable the PCIe traffic generator which
+               will create write TLPs frames - from the Root Complex to the
+               Endpoint direction or to disable the PCIe traffic generator
+               in all directions.
+
+               Write y/1/on to enable, n/0/off to disable
+
+               Usage e.g.
+                echo 1 > /sys/class/misc/dw-xdata-pcie.<device>/write
+               or
+                echo 0 > /sys/class/misc/dw-xdata-pcie.<device>/write
+
+               The user can read the current PCIe link throughput generated
+               through this generator in MB/s.
+
+               Usage e.g.
+                cat /sys/class/misc/dw-xdata-pcie.<device>/write
+                204
+
+               The file is read and write.
+
+What:          /sys/class/misc/dw-xdata-pcie.<device>/read
+Date:          April 2021
+KernelVersion: 5.13
+Contact:       Gustavo Pimentel <gustavo.pimentel@synopsys.com>
+Description:   Allows the user to enable the PCIe traffic generator which
+               will create read TLPs frames - from the Endpoint to the Root
+               Complex direction or to disable the PCIe traffic generator
+                in all directions.
+
+               Write y/1/on to enable, n/0/off to disable
+
+               Usage e.g.
+                echo 1 > /sys/class/misc/dw-xdata-pcie.<device>/read
+               or
+                echo 0 > /sys/class/misc/dw-xdata-pcie.<device>/read
+
+               The user can read the current PCIe link throughput generated
+               through this generator in MB/s.
+
+               Usage e.g.
+                cat /sys/class/misc/dw-xdata-pcie.<device>/read
+                199
+
+               The file is read and write.