xref: /linux/Documentation/misc-devices/dw-xdata-pcie.rst (revision e1181b5bbc3c3b6a16a0a80a870279ad1dccfeea)
1.. SPDX-License-Identifier: GPL-2.0
2
3===========================================================================
4Driver for Synopsys DesignWare PCIe traffic generator (also known as xData)
5===========================================================================
6
7This driver should be used as a host-side (Root Complex) driver and Synopsys
8DesignWare prototype that includes this IP.
9
10The "dw-xdata-pcie" driver can be used to enable/disable PCIe traffic
11generator in either direction (mutual exclusion) besides allowing the
12PCIe link performance analysis.
13
14The interaction with this driver is done through the module parameter and
15can be changed in runtime. The driver outputs the requested command state
16information to /var/log/kern.log or dmesg.
17
18Request write TLPs traffic generation - Root Complex to Endpoint direction
19- Command:
20	echo 1 > /sys/class/misc/dw-xdata-pcie/write
21
22Get write TLPs traffic link throughput in MB/s
23- Command:
24        cat /sys/class/misc/dw-xdata-pcie/write
25- Output example:
26	204
27
28Request read TLPs traffic generation - Endpoint to Root Complex direction:
29- Command:
30	echo 1 > /sys/class/misc/dw-xdata-pcie/read
31
32Get read TLPs traffic link throughput in MB/s
33- Command:
34        cat /sys/class/misc/dw-xdata-pcie/read
35- Output example:
36	199
37
38Request to stop any current TLP transfer:
39- Command:
40	echo 1 > /sys/class/misc/dw-xdata-pcie/stop
41