From: Gustavo Pimentel <Gustavo.Pimentel@synopsys.com>
To: Gustavo Pimentel <Gustavo.Pimentel@synopsys.com>,
Jonathan Corbet <corbet@lwn.net>
Cc: Joao Pinto <Joao.Pinto@synopsys.com>,
linux-pci@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: [PATCH 4/5] Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver
Date: Thu, 29 Oct 2020 20:13:39 +0100 [thread overview]
Message-ID: <cfd650d825cb669245e2a63f03db8fd952f28f2a.1603998630.git.gustavo.pimentel@synopsys.com> (raw)
In-Reply-To: <cover.1603998630.git.gustavo.pimentel@synopsys.com>
In-Reply-To: <cover.1603998630.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 | 43 ++++++++++++++++++++++++++++
1 file changed, 43 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..4d4616e
--- /dev/null
+++ b/Documentation/misc-devices/dw-xdata-pcie.rst
@@ -0,0 +1,43 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+===========================================================================w
+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 w > /sys/module/dw_xdata_pcie/parameters/command
+- Output example:
+ dw-xdata-pcie 0000:01.0: xData: requested write transfer
+ dw-xdata-pcie 0000:01.0: xData: started write direction
+
+Request read TLPs traffic generation - Endpoint to Root Complex direction:
+- Command:
+ echo r > /sys/module/dw_xdata_pcie/parameters/command
+- Output example:
+ dw-xdata-pcie 0000:01.0: xData: requested read transfer
+ dw-xdata-pcie 0000:01.0: xData: started read direction
+
+Request to stop any current TLP transfer:
+- Command:
+ echo s > /sys/module/dw_xdata_pcie/parameters/command
+- Output example:
+ dw-xdata-pcie 0000:01.0: xData: requested stop any transfer
+
+Request PCIe link performance analysis:
+- Command:
+ echo p > /sys/module/dw_xdata_pcie/parameters/command
+ - Output example:
+ dw-xdata-pcie 0000:01.0: xData: requested performance analysis
+ dw-xdata-pcie 0000:01.0: xData: time=112000000us, read=0 MB/s, write=0 MB/s
--
2.7.4
next prev parent reply other threads:[~2020-10-29 19:14 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-29 19:13 [PATCH 0/5] misc: Add Add Synopsys DesignWare xData IP driver Gustavo Pimentel
2020-10-29 19:13 ` [PATCH 1/5] misc: " Gustavo Pimentel
2020-11-09 17:31 ` Greg Kroah-Hartman
2020-11-10 15:17 ` Gustavo Pimentel
2020-11-10 17:30 ` Greg Kroah-Hartman
2020-11-10 18:23 ` Gustavo Pimentel
2020-10-29 19:13 ` Gustavo Pimentel [this message]
2020-10-29 19:13 ` [PATCH 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=cfd650d825cb669245e2a63f03db8fd952f28f2a.1603998630.git.gustavo.pimentel@synopsys.com \
--to=gustavo.pimentel@synopsys.com \
--cc=Joao.Pinto@synopsys.com \
--cc=corbet@lwn.net \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).