From: Gustavo Pimentel <Gustavo.Pimentel@synopsys.com>
To: linux-pci@vger.kernel.org, linux-kernel@vger.kernel.org,
dmaengine@vger.kernel.org,
Derek Kiernan <derek.kiernan@xilinx.com>,
Dragan Cvetic <dragan.cvetic@xilinx.com>,
Arnd Bergmann <arnd@arndb.de>,
Andrew Morton <akpm@linux-foundation.org>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Jonathan Corbet <corbet@lwn.net>,
Gustavo Pimentel <Gustavo.Pimentel@synopsys.com>
Cc: linux-doc@vger.kernel.org
Subject: [RESEND PATCH v3 4/5] Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver
Date: Tue, 2 Feb 2021 17:56:37 +0100 [thread overview]
Message-ID: <1461be78c771e63dc38721b775c38caee4a77bc0.1612284945.git.gustavo.pimentel@synopsys.com> (raw)
In-Reply-To: <cover.1612284945.git.gustavo.pimentel@synopsys.com>
In-Reply-To: <cover.1612284945.git.gustavo.pimentel@synopsys.com>
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..3af9fad
--- /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/kernel/dw-xdata-pcie/write
+
+Get write TLPs traffic link throughput
+- Command:
+ cat /sys/kernel/dw-xdata-pcie/write
+- Output example:
+ 204 MB/s
+
+Request read TLPs traffic generation - Endpoint to Root Complex direction:
+- Command:
+ echo 1 > /sys/kernel/dw-xdata-pcie/read
+
+Get read TLPs traffic link throughput
+- Command:
+ cat /sys/kernel/dw-xdata-pcie/read
+- Output example:
+ 199 MB/s
+
+Request to stop any current TLP transfer:
+- Command:
+ echo 1 > /sys/kernel/dw-xdata-pcie/stop
--
2.7.4
next prev parent reply other threads:[~2021-02-02 17:05 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-02 16:56 [RESEND PATCH v3 0/5] misc: Add Add Synopsys DesignWare xData IP driver Gustavo Pimentel
2021-02-02 16:56 ` [RESEND PATCH v3 1/5] misc: " Gustavo Pimentel
2021-02-02 17:07 ` Greg Kroah-Hartman
2021-02-02 16:56 ` [RESEND PATCH v3 2/5] misc: Add Synopsys DesignWare xData IP driver to Makefile Gustavo Pimentel
2021-02-02 16:56 ` [RESEND PATCH v3 3/5] misc: Add Synopsys DesignWare xData IP driver to Kconfig Gustavo Pimentel
2021-02-08 7:34 ` Leon Romanovsky
2021-02-08 9:02 ` Gustavo Pimentel
2021-02-02 16:56 ` Gustavo Pimentel [this message]
2021-02-02 16:56 ` [RESEND PATCH v3 5/5] MAINTAINERS: Add Synopsys xData IP driver maintainer Gustavo Pimentel
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1461be78c771e63dc38721b775c38caee4a77bc0.1612284945.git.gustavo.pimentel@synopsys.com \
--to=gustavo.pimentel@synopsys.com \
--cc=akpm@linux-foundation.org \
--cc=arnd@arndb.de \
--cc=corbet@lwn.net \
--cc=derek.kiernan@xilinx.com \
--cc=dmaengine@vger.kernel.org \
--cc=dragan.cvetic@xilinx.com \
--cc=gregkh@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pci@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.