xref: /linux/Documentation/misc-devices/dw-xdata-pcie.rst (revision c532de5a67a70f8533d495f8f2aaa9a0491c3ad0)
1.. SPDX-License-Identifier: GPL-2.0
2
3===========================================================================
4Driver for Synopsys DesignWare PCIe traffic generator (also known as xData)
5===========================================================================
6
7Supported chips:
8Synopsys DesignWare PCIe prototype solution
9
10Datasheet:
11Not freely available
12
13Author:
14Gustavo Pimentel <gustavo.pimentel@synopsys.com>
15
16Description
17-----------
18
19This driver should be used as a host-side (Root Complex) driver and Synopsys
20DesignWare prototype that includes this IP.
21
22The dw-xdata-pcie driver can be used to enable/disable PCIe traffic
23generator in either direction (mutual exclusion) besides allowing the
24PCIe link performance analysis.
25
26The interaction with this driver is done through the module parameter and
27can be changed in runtime. The driver outputs the requested command state
28information to ``/var/log/kern.log`` or dmesg.
29
30Example
31-------
32
33Write TLPs traffic generation - Root Complex to Endpoint direction
34~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35
36Generate traffic::
37
38 # echo 1 > /sys/class/misc/dw-xdata-pcie.0/write
39
40Get link throughput in MB/s::
41
42 # cat /sys/class/misc/dw-xdata-pcie.0/write
43 204
44
45Stop traffic in any direction::
46
47 # echo 0 > /sys/class/misc/dw-xdata-pcie.0/write
48
49Read TLPs traffic generation - Endpoint to Root Complex direction
50~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51
52Generate traffic::
53
54 # echo 1 > /sys/class/misc/dw-xdata-pcie.0/read
55
56Get link throughput in MB/s::
57
58 # cat /sys/class/misc/dw-xdata-pcie.0/read
59 199
60
61Stop traffic in any direction::
62
63 # echo 0 > /sys/class/misc/dw-xdata-pcie.0/read
64
65