linux-pci.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Gustavo Pimentel <Gustavo.Pimentel@synopsys.com>
To: linux-doc@vger.kernel.org, linux-pci@vger.kernel.org,
	linux-kernel@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>,
	Bjorn Helgaas <bhelgaas@google.com>
Cc: Gustavo Pimentel <Gustavo.Pimentel@synopsys.com>
Subject: [PATCH v6 5/5] docs: ABI: Add sysfs documentation interface of dw-xdata-pcie driver
Date: Fri, 12 Feb 2021 18:28:07 +0100	[thread overview]
Message-ID: <bf25bd2b8977d678adb13fea02d4cebf22f583bf.1613150798.git.gustavo.pimentel@synopsys.com> (raw)
In-Reply-To: <cover.1613150798.git.gustavo.pimentel@synopsys.com>
In-Reply-To: <cover.1613150798.git.gustavo.pimentel@synopsys.com>

This patch describes the sysfs interface implemented on the dw-xdata-pcie
driver.

Signed-off-by: Gustavo Pimentel <gustavo.pimentel@synopsys.com>
---
 Documentation/ABI/testing/sysfs-driver-xdata | 46 ++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-driver-xdata

diff --git a/Documentation/ABI/testing/sysfs-driver-xdata b/Documentation/ABI/testing/sysfs-driver-xdata
new file mode 100644
index 00000000..09d38e1
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-driver-xdata
@@ -0,0 +1,46 @@
+What:		/sys/bus/pci/drivers/dw-xdata-pcie/.../write
+Date:		February 2021
+KernelVersion:	5.12
+Contact:	Gustavo Pimentel <gustavo.pimentel@synopsys.com>
+Description:	Allows the user to enable the PCIe traffic generator which
+		will create write TLPs frames - from the Root Complex to the
+		Endpoint direction.
+		Usage e.g.
+		 echo 1 > /sys/bus/pci/drivers/dw-xdata-pcie/.../write
+
+		The user can read the current PCIe link throughput generated
+		through this generator in MB/s.
+		Usage e.g.
+		 cat /sys/bus/pci/drivers/dw-xdata-pcie/.../write
+		 204
+
+		The file is read and write.
+
+What:		/sys/bus/pci/drivers/dw-xdata-pcie/.../read
+Date:		February 2021
+KernelVersion:	5.12
+Contact:	Gustavo Pimentel <gustavo.pimentel@synopsys.com>
+Description:	Allows the user to enable the PCIe traffic generator which
+		will create read TLPs frames - from the Endpoint to the Root
+		Complex direction.
+		Usage e.g.
+		 echo 1 > /sys/bus/pci/drivers/dw-xdata-pcie/.../read
+
+		The user can read the current PCIe link throughput generated
+		through this generator in MB/s.
+		Usage e.g.
+		 cat /sys/bus/pci/drivers/dw-xdata-pcie/.../read
+		 199
+
+		The file is read and write.
+
+What:		/sys/bus/pci/drivers/dw-xdata-pcie/.../stop
+Date:		February 2021
+KernelVersion:	5.12
+Contact:	Gustavo Pimentel <gustavo.pimentel@synopsys.com>
+Description:	Allows the user to disable the PCIe traffic generator in all
+		directions.
+		Usage e.g.
+		 echo 1 > /sys/bus/pci/drivers/dw-xdata-pcie/.../stop
+
+		The file is write only.
-- 
2.7.4


      parent reply	other threads:[~2021-02-12 17:29 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-02-12 17:28 [PATCH v6 0/5] misc: Add Add Synopsys DesignWare xData IP driver Gustavo Pimentel
2021-02-12 17:28 ` [PATCH v6 1/5] misc: " Gustavo Pimentel
2021-03-23 13:00   ` Greg Kroah-Hartman
2021-03-24  9:15     ` Gustavo Pimentel
2021-03-24  9:25       ` Greg Kroah-Hartman
2021-02-12 17:28 ` [PATCH v6 2/5] misc: Add Synopsys DesignWare xData IP driver to Makefile and Kconfig Gustavo Pimentel
2021-02-12 17:28 ` [PATCH v6 3/5] Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver Gustavo Pimentel
2021-02-12 17:28 ` [PATCH v6 4/5] MAINTAINERS: Add Synopsys xData IP driver maintainer Gustavo Pimentel
2021-02-12 17:28 ` Gustavo Pimentel [this message]

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=bf25bd2b8977d678adb13fea02d4cebf22f583bf.1613150798.git.gustavo.pimentel@synopsys.com \
    --to=gustavo.pimentel@synopsys.com \
    --cc=akpm@linux-foundation.org \
    --cc=arnd@arndb.de \
    --cc=bhelgaas@google.com \
    --cc=corbet@lwn.net \
    --cc=derek.kiernan@xilinx.com \
    --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 \
    --subject='Re: [PATCH v6 5/5] docs: ABI: Add sysfs documentation interface of dw-xdata-pcie driver' \
    /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

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).