Fixes indentation issues reported by doing *make htmldocs* as well some
text formatting.
Besides these fixes, there was some outdated information related to stop
file interface in sysfs.
Fixes: e1181b5bbc3c ("Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver")
Link: https://lore.kernel.org/linux-next/20210406214615.40cf3493@xxxxxxxxxxxxxxxx/
Reported-by: Stephen Rothwell <sfr@xxxxxxxxxxxxxxxx>
Signed-off-by: Gustavo Pimentel <gustavo.pimentel@xxxxxxxxxxxx>
---
Documentation/misc-devices/dw-xdata-pcie.rst | 62 +++++++++++++++++++---------
1 file changed, 43 insertions(+), 19 deletions(-)
diff --git a/Documentation/misc-devices/dw-xdata-pcie.rst b/Documentation/misc-devices/dw-xdata-pcie.rst
index fd75c93..a956e1a 100644
--- a/Documentation/misc-devices/dw-xdata-pcie.rst
+++ b/Documentation/misc-devices/dw-xdata-pcie.rst
@@ -4,37 +4,61 @@
Driver for Synopsys DesignWare PCIe traffic generator (also known as xData)
===========================================================================
+Supported chips:
+Synopsys DesignWare PCIe prototype solution
+
+Data sheet:
+Not freely available
+
+Author:
+Gustavo Pimentel <gustavo.pimentel@xxxxxxxxxxxx>
+
+Description
+-----------
+
This driver should be used as a host-side (Root Complex) driver and Synopsys
DesignWare prototype that includes this IP.
-The "dw-xdata-pcie" driver can be used to enable/disable PCIe traffic
+The dw-xdata-pcie driver can be used to enable/disable PCIe traffic
generator in either direction (mutual exclusion) besides allowing the
PCIe link performance analysis.
The interaction with this driver is done through the module parameter and
can be changed in runtime. The driver outputs the requested command state
-information to /var/log/kern.log or dmesg.
+information to ``/var/log/kern.log`` or dmesg.
+
+Example
+-------
+
+Write TLPs traffic generation - Root Complex to Endpoint direction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Generate traffic::
+
+ # echo 1 > /sys/class/misc/dw-xdata-pcie.0/write
-Request write TLPs traffic generation - Root Complex to Endpoint direction
-- Command:
- echo 1 > /sys/class/misc/dw-xdata-pcie/write
+Get link throughput in MB/s::
-Get write TLPs traffic link throughput in MB/s
-- Command:
- cat /sys/class/misc/dw-xdata-pcie/write
-- Output example:
+ # cat /sys/class/misc/dw-xdata-pcie.0/write
204
-Request read TLPs traffic generation - Endpoint to Root Complex direction:
-- Command:
- echo 1 > /sys/class/misc/dw-xdata-pcie/read
+Stop traffic in any direction::
-Get read TLPs traffic link throughput in MB/s
-- Command:
- cat /sys/class/misc/dw-xdata-pcie/read
-- Output example:
+ # echo 0 > /sys/class/misc/dw-xdata-pcie.0/write
+
+Read TLPs traffic generation - Endpoint to Root Complex direction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Generate traffic::
+
+ # echo 1 > /sys/class/misc/dw-xdata-pcie.0/read
+
+Get link throughput in MB/s::
+
+ # cat /sys/class/misc/dw-xdata-pcie.0/read
199
-Request to stop any current TLP transfer:
-- Command:
- echo 1 > /sys/class/misc/dw-xdata-pcie/stop
+Stop traffic in any direction::
+
+ # echo 0 > /sys/class/misc/dw-xdata-pcie.0/read
+
--
2.7.4
