* [PATCH v4 0/2] dw-xdata-pcie: Fix documentation build warns
@ 2021-04-10 14:52 Gustavo Pimentel
2021-04-10 14:52 ` [PATCH v4 1/2] " Gustavo Pimentel
2021-04-10 14:52 ` [PATCH v4 2/2] dw-xdata-pcie: Update outdated info and improve text format Gustavo Pimentel
0 siblings, 2 replies; 3+ messages in thread
From: Gustavo Pimentel @ 2021-04-10 14:52 UTC (permalink / raw)
To: linux-doc, linux-pci, linux-kernel, Derek Kiernan, Dragan Cvetic,
Arnd Bergmann, Andrew Morton, Greg Kroah-Hartman,
Jonathan Corbet, Bjorn Helgaas, Krzysztof Wilczyński,
Stephen Rothwell
Cc: Gustavo Pimentel
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=y, Size: 1469 bytes --]
The first patch of this series fixes the documentation build warns, such as:
WARNING: Unexpected indentation.
WARNING: Block quote ends without a blank line; unexpected unindent.
WARNING: document isn't included in any toctree.
The second patch updates outdated and improve documentation information.
Changes:
V2: Added cover-letter
Added Reported-by, Link, and Fixes tags
V3: Reformulated patch's text description and title
V4: Reformulated patch's text description and title
Rearranged the patches in a logical way, so that the first patch
goal is to fix the build warns and the second patch goal is to
update the documentation info.
Cc: linux-doc@vger.kernel.org
Cc: linux-pci@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Cc: Derek Kiernan <derek.kiernan@xilinx.com>
Cc: Dragan Cvetic <dragan.cvetic@xilinx.com>
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Bjorn Helgaas <bhelgaas@google.com>
Cc: Krzysztof Wilczyński <kw@linux.com>
Cc: Stephen Rothwell <sfr@canb.auug.org.au>
Gustavo Pimentel (2):
dw-xdata-pcie: Fix documentation build warns
dw-xdata-pcie: Update outdated info and improve text format
Documentation/misc-devices/dw-xdata-pcie.rst | 76 ++++++++++++++++++----------
Documentation/misc-devices/index.rst | 1 +
2 files changed, 51 insertions(+), 26 deletions(-)
--
2.7.4
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH v4 1/2] dw-xdata-pcie: Fix documentation build warns
2021-04-10 14:52 [PATCH v4 0/2] dw-xdata-pcie: Fix documentation build warns Gustavo Pimentel
@ 2021-04-10 14:52 ` Gustavo Pimentel
2021-04-10 14:52 ` [PATCH v4 2/2] dw-xdata-pcie: Update outdated info and improve text format Gustavo Pimentel
1 sibling, 0 replies; 3+ messages in thread
From: Gustavo Pimentel @ 2021-04-10 14:52 UTC (permalink / raw)
To: linux-doc, linux-pci, linux-kernel, Derek Kiernan, Dragan Cvetic,
Arnd Bergmann, Andrew Morton, Greg Kroah-Hartman,
Jonathan Corbet, Bjorn Helgaas, Krzysztof Wilczyński,
Stephen Rothwell, Gustavo Pimentel
Cc: Gustavo Pimentel
Fixes documentation build warns related to indentation, text formatting,
and missing reference on toc.
This fix solves the following warnings:
WARNING: Unexpected indentation.
WARNING: Block quote ends without a blank line; unexpected unindent.
WARNING: document isn't included in any toctree
Fixes: e1181b5bbc3c ("Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver")
Link: https://lore.kernel.org/linux-next/20210406214615.40cf3493@canb.auug.org.au/
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Gustavo Pimentel <gustavo.pimentel@synopsys.com>
---
Documentation/misc-devices/dw-xdata-pcie.rst | 14 +++++++-------
Documentation/misc-devices/index.rst | 1 +
2 files changed, 8 insertions(+), 7 deletions(-)
diff --git a/Documentation/misc-devices/dw-xdata-pcie.rst b/Documentation/misc-devices/dw-xdata-pcie.rst
index fd75c93..cbc9f69 100644
--- a/Documentation/misc-devices/dw-xdata-pcie.rst
+++ b/Documentation/misc-devices/dw-xdata-pcie.rst
@@ -17,24 +17,24 @@ 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
+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
+cat /sys/class/misc/dw-xdata-pcie/write
- Output example:
- 204
+204
Request read TLPs traffic generation - Endpoint to Root Complex direction:
- Command:
- echo 1 > /sys/class/misc/dw-xdata-pcie/read
+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
+cat /sys/class/misc/dw-xdata-pcie/read
- Output example:
- 199
+199
Request to stop any current TLP transfer:
- Command:
- echo 1 > /sys/class/misc/dw-xdata-pcie/stop
+echo 1 > /sys/class/misc/dw-xdata-pcie/stop
diff --git a/Documentation/misc-devices/index.rst b/Documentation/misc-devices/index.rst
index 64420b331..30ac58f 100644
--- a/Documentation/misc-devices/index.rst
+++ b/Documentation/misc-devices/index.rst
@@ -19,6 +19,7 @@ fit into other categories.
bh1770glc
eeprom
c2port
+ dw-xdata-pcie
ibmvmc
ics932s401
isl29003
--
2.7.4
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [PATCH v4 2/2] dw-xdata-pcie: Update outdated info and improve text format
2021-04-10 14:52 [PATCH v4 0/2] dw-xdata-pcie: Fix documentation build warns Gustavo Pimentel
2021-04-10 14:52 ` [PATCH v4 1/2] " Gustavo Pimentel
@ 2021-04-10 14:52 ` Gustavo Pimentel
1 sibling, 0 replies; 3+ messages in thread
From: Gustavo Pimentel @ 2021-04-10 14:52 UTC (permalink / raw)
To: linux-doc, linux-pci, linux-kernel, Derek Kiernan, Dragan Cvetic,
Arnd Bergmann, Andrew Morton, Greg Kroah-Hartman,
Jonathan Corbet, Bjorn Helgaas, Krzysztof Wilczyński,
Stephen Rothwell, Gustavo Pimentel
Removes old information related to the stop file interface in sysfs left
by mistake during patch revision.
Improves the document text format to be more user-friendly and adds
basic driver related information, such as support, datasheet, and author.
Signed-off-by: Gustavo Pimentel <gustavo.pimentel@synopsys.com>
---
Documentation/misc-devices/dw-xdata-pcie.rst | 76 ++++++++++++++++++----------
1 file changed, 50 insertions(+), 26 deletions(-)
diff --git a/Documentation/misc-devices/dw-xdata-pcie.rst b/Documentation/misc-devices/dw-xdata-pcie.rst
index cbc9f69..781c679 100644
--- a/Documentation/misc-devices/dw-xdata-pcie.rst
+++ b/Documentation/misc-devices/dw-xdata-pcie.rst
@@ -4,37 +4,61 @@
Driver for Synopsys DesignWare PCIe traffic generator (also known as xData)
===========================================================================
+Supported chips:
+Synopsys DesignWare PCIe prototype solution
+
+Datasheet:
+Not freely available
+
+Author:
+Gustavo Pimentel <gustavo.pimentel@synopsys.com>
+
+Description
+-----------
+
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
+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
+information to ``/var/log/kern.log`` or dmesg.
+
+Example
+-------
+
+Write TLPs traffic generation - Root Complex to Endpoint direction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Generate traffic::
+
+ # echo 1 > /sys/class/misc/dw-xdata-pcie.0/write
+
+Get link throughput in MB/s::
+
+ # cat /sys/class/misc/dw-xdata-pcie.0/write
+ 204
+
+Stop traffic in any direction::
+
+ # echo 0 > /sys/class/misc/dw-xdata-pcie.0/write
+
+Read TLPs traffic generation - Endpoint to Root Complex direction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Generate traffic::
+
+ # echo 1 > /sys/class/misc/dw-xdata-pcie.0/read
+
+Get link throughput in MB/s::
+
+ # cat /sys/class/misc/dw-xdata-pcie.0/read
+ 199
+
+Stop traffic in any direction::
+
+ # echo 0 > /sys/class/misc/dw-xdata-pcie.0/read
+
--
2.7.4
^ permalink raw reply related [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-04-10 14:53 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-10 14:52 [PATCH v4 0/2] dw-xdata-pcie: Fix documentation build warns Gustavo Pimentel
2021-04-10 14:52 ` [PATCH v4 1/2] " Gustavo Pimentel
2021-04-10 14:52 ` [PATCH v4 2/2] dw-xdata-pcie: Update outdated info and improve text format Gustavo Pimentel
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).