[PATCH v5 6/6] docs: ABI: Add sysfs documentation interface of dw-xdata-pcie driver

Gustavo Pimentel
2021-02-11T09:17:24Z

This patch describes the sysfs interface implemented on the dw-xdata-pcie
driver.

Signed-off-by: Gustavo Pimentel <gustavo.pimentel@synopsys.com>
---
Documentation/ABI/testing/sysfs-driver-xdata | 46 ++++++++++++++++++++++++++++
1 file changed, 46 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-driver-xdata

diff --git a/Documentation/ABI/testing/sysfs-driver-xdata b/Documentation/ABI/testing/sysfs-driver-xdata
new file mode 100644
index 00000000..a7bb44b
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-driver-xdata
@@ -0,0 +1,46 @@
+What: /sys/kernel/dw-xdata-pcie/write
+Date: February 2021
+KernelVersion: 5.12
+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.
+ Usage e.g.
+ echo 1 > /sys/kernel/dw-xdata-pcie/write
+
+ The user can read the current PCIe link throughput generated
+ through this generator.
+ Usage e.g.
+ cat /sys/kernel/dw-xdata-pcie/write
+ 204 MB/s
+
+ The file is read and write.
+
+What: /sys/kernel/dw-xdata-pcie/read
+Date: February 2021
+KernelVersion: 5.12
+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.
+ Usage e.g.
+ echo 1 > /sys/kernel/dw-xdata-pcie/read
+
+ The user can read the current PCIe link throughput generated
+ through this generator.
+ Usage e.g.
+ cat /sys/kernel/dw-xdata-pcie/read
+ 199 MB/s
+
+ The file is read and write.
+
+What: /sys/kernel/dw-xdata-pcie/stop
+Date: February 2021
+KernelVersion: 5.12
+Contact: Gustavo Pimentel <gustavo.pimentel@synopsys.com>
+Description: Allows the user to disable the PCIe traffic generator in all
+ directions.
+ Usage e.g.
+ echo 1 > /sys/kernel/dw-xdata-pcie/stop
+
+ The file is write only.
--
2.7.4