lkml.org 
[lkml]   [2021]   [Mar]   [29]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v8 2/5] Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver
    Date
    Add Documentation for dw-xdata-pcie driver.

    Signed-off-by: Gustavo Pimentel <gustavo.pimentel@synopsys.com>
    ---
    Documentation/misc-devices/dw-xdata-pcie.rst | 40 ++++++++++++++++++++++++++++
    1 file changed, 40 insertions(+)
    create mode 100644 Documentation/misc-devices/dw-xdata-pcie.rst

    diff --git a/Documentation/misc-devices/dw-xdata-pcie.rst b/Documentation/misc-devices/dw-xdata-pcie.rst
    new file mode 100644
    index 00000000..fd75c93
    --- /dev/null
    +++ b/Documentation/misc-devices/dw-xdata-pcie.rst
    @@ -0,0 +1,40 @@
    +.. 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
    --
    2.7.4
    \
     
     \ /
      Last update: 2021-03-29 11:53    [W:2.961 / U:0.012 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site