diff mbox series

[v6,5/5] docs: ABI: Add sysfs documentation interface of dw-xdata-pcie driver

Message ID bf25bd2b8977d678adb13fea02d4cebf22f583bf.1613150798.git.gustavo.pimentel@synopsys.com (mailing list archive)
State Superseded
Headers show
Series misc: Add Add Synopsys DesignWare xData IP driver | expand

Commit Message

Gustavo Pimentel Feb. 12, 2021, 5:28 p.m. UTC 
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 mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-driver-xdata b/Documentation/ABI/testing/sysfs-driver-xdata
new file mode 100644
index 00000000..09d38e1
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-driver-xdata
@@ -0,0 +1,46 @@ 
+What:		/sys/bus/pci/drivers/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/bus/pci/drivers/dw-xdata-pcie/.../write
+
+		The user can read the current PCIe link throughput generated
+		through this generator in MB/s.
+		Usage e.g.
+		 cat /sys/bus/pci/drivers/dw-xdata-pcie/.../write
+		 204
+
+		The file is read and write.
+
+What:		/sys/bus/pci/drivers/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/bus/pci/drivers/dw-xdata-pcie/.../read
+
+		The user can read the current PCIe link throughput generated
+		through this generator in MB/s.
+		Usage e.g.
+		 cat /sys/bus/pci/drivers/dw-xdata-pcie/.../read
+		 199
+
+		The file is read and write.
+
+What:		/sys/bus/pci/drivers/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/bus/pci/drivers/dw-xdata-pcie/.../stop
+
+		The file is write only.