This patch series fixes the documentation issues reported by doing
*make htmldocs*, such as:
- indentation
- text formatting
- missing entry on the table of content related to dw-xdata-pcie misc
driver index
Besides these warnings also fixes some outdated information related to
stop file interface in sysfs.
Changes:
V2: Added cover-letter
Added Reported-by, Link, and Fixes tags
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: Derek Kiernan <[email protected]>
Cc: Dragan Cvetic <[email protected]>
Cc: Arnd Bergmann <[email protected]>
Cc: Andrew Morton <[email protected]>
Cc: Greg Kroah-Hartman <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Cc: Bjorn Helgaas <[email protected]>
Cc: Krzysztof Wilczyński <[email protected]>
Cc: Stephen Rothwell <[email protected]>
Gustavo Pimentel (2):
Documentation: misc-devices: Fix indentation, formatting, and update
outdated info
Documentation: misc-devices: Add missing entry on the table of content
related to dw-xdata-pcie
Documentation/misc-devices/dw-xdata-pcie.rst | 62 +++++++++++++++++++---------
Documentation/misc-devices/index.rst | 1 +
2 files changed, 44 insertions(+), 19 deletions(-)
--
2.7.4
Fixes indentation issues reported by doing *make htmldocs* as well some
text formatting.
Besides these fixes, there was some outdated information related to stop
file interface in sysfs.
Fixes: e1181b5bbc3c ("Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver")
Link: https://lore.kernel.org/linux-next/[email protected]/
Reported-by: Stephen Rothwell <[email protected]>
Signed-off-by: Gustavo Pimentel <[email protected]>
---
Documentation/misc-devices/dw-xdata-pcie.rst | 62 +++++++++++++++++++---------
1 file changed, 43 insertions(+), 19 deletions(-)
diff --git a/Documentation/misc-devices/dw-xdata-pcie.rst b/Documentation/misc-devices/dw-xdata-pcie.rst
index fd75c93..a956e1a 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
+
+Data sheet:
+Not freely available
+
+Author:
+Gustavo Pimentel <[email protected]>
+
+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.
+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
-Request write TLPs traffic generation - Root Complex to Endpoint direction
-- Command:
- echo 1 > /sys/class/misc/dw-xdata-pcie/write
+Get link throughput in MB/s::
-Get write TLPs traffic link throughput in MB/s
-- Command:
- cat /sys/class/misc/dw-xdata-pcie/write
-- Output example:
+ # cat /sys/class/misc/dw-xdata-pcie.0/write
204
-Request read TLPs traffic generation - Endpoint to Root Complex direction:
-- Command:
- echo 1 > /sys/class/misc/dw-xdata-pcie/read
+Stop traffic in any direction::
-Get read TLPs traffic link throughput in MB/s
-- Command:
- cat /sys/class/misc/dw-xdata-pcie/read
-- Output example:
+ # 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
-Request to stop any current TLP transfer:
-- Command:
- echo 1 > /sys/class/misc/dw-xdata-pcie/stop
+Stop traffic in any direction::
+
+ # echo 0 > /sys/class/misc/dw-xdata-pcie.0/read
+
--
2.7.4
Add missing entry on the table of content related to dw-xdata-pcie misc
driver reported in a warning by doing *make htmldocs*.
Fixes: e1181b5bbc3c ("Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver")
Link: https://lore.kernel.org/linux-next/[email protected]/
Reported-by: Stephen Rothwell <[email protected]>
Signed-off-by: Gustavo Pimentel <[email protected]>
---
Documentation/misc-devices/index.rst | 1 +
1 file changed, 1 insertion(+)
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
On Wed, Apr 7, 2021 at 18:35:16, Greg Kroah-Hartman
<[email protected]> wrote:
> On Wed, Apr 07, 2021 at 03:57:31PM +0000, Gustavo Pimentel wrote:
> > On Wed, Apr 7, 2021 at 7:17:12, Greg Kroah-Hartman
> > <[email protected]> wrote:
> >
> > > On Tue, Apr 06, 2021 at 11:17:48PM +0200, Gustavo Pimentel wrote:
> > > > Fixes indentation issues reported by doing *make htmldocs* as well some
> > > > text formatting.
> > > >
> > > > Besides these fixes, there was some outdated information related to stop
> > > > file interface in sysfs.
> > >
> > > You are not doing this for all "misc-devices", you are doing this only
> > > for one specific driver file.
> > >
> > > Please look at the example I provided for how to name this and fix up.
> >
> > Sorry Greg, I didn't see an example provided. Perhaps you forgot it?
>
> Nope: https://urldefense.com/v3/__https://lore.kernel.org/r/[email protected]__;!!A4F2R9G_pg!P8mbZ8v-lsQ9vFXveIVRhy11GV8pgDdGWP7FW51NwcuaI2WpDfsuBeCFXIzdFzkTHKTv3oU$
That's right, for some reason I was stuck thinking that was some kind of
link. My bad.
-Gustavo