linux/Documentation/misc-devices/dw-xdata-pcie.rst
Gustavo Pimentel b21a57636c dw-xdata-pcie: Fix documentation build warns
Fixes documentation build warns related to indentation, text formatting,
and missing reference on toc.

This fix solves the following warnings:

WARNING: Unexpected indentation.
WARNING: Block quote ends without a blank line; unexpected unindent.
WARNING: document isn't included in any toctree

Link: https://lore.kernel.org/linux-next/20210406214615.40cf3493@canb.auug.org.au/
Fixes: e1181b5bbc ("Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Gustavo Pimentel <gustavo.pimentel@synopsys.com>
Link: https://lore.kernel.org/r/42ed2d9d27579291dc7cce89c0164bd9255fe337.1618066164.git.gustavo.pimentel@synopsys.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2021-04-14 19:47:28 +02:00

41 lines
1.3 KiB
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0
===========================================================================
Driver for Synopsys DesignWare PCIe traffic generator (also known as xData)
===========================================================================
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
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.
Request write TLPs traffic generation - Root Complex to Endpoint direction
- Command:
echo 1 > /sys/class/misc/dw-xdata-pcie/write
Get write TLPs traffic link throughput in MB/s
- Command:
cat /sys/class/misc/dw-xdata-pcie/write
- Output example:
204
Request read TLPs traffic generation - Endpoint to Root Complex direction:
- Command:
echo 1 > /sys/class/misc/dw-xdata-pcie/read
Get read TLPs traffic link throughput in MB/s
- Command:
cat /sys/class/misc/dw-xdata-pcie/read
- Output example:
199
Request to stop any current TLP transfer:
- Command:
echo 1 > /sys/class/misc/dw-xdata-pcie/stop