linux-pci.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Leon Romanovsky <leon@kernel.org>
To: Gustavo Pimentel <Gustavo.Pimentel@synopsys.com>
Cc: 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>
Subject: Re: [PATCH v5 6/6] docs: ABI: Add sysfs documentation interface of dw-xdata-pcie driver
Date: Thu, 11 Feb 2021 11:29:14 +0200	[thread overview]
Message-ID: <20210211092914.GD1275163@unreal> (raw)
In-Reply-To: <dce623f03f782fe536765916a9c3be36cee1dfe2.1613034397.git.gustavo.pimentel@synopsys.com>

On Thu, Feb 11, 2021 at 10:08:43AM +0100, Gustavo Pimentel wrote:
> 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

I don't know and maybe this is how modern drivers are developed now, but my
laptop doesn't have anything driver and vendor specific related under plain
/sys/kernel/* directory.

➜  kernel git:(rdma-next) ls -l /sys/kernel
total 0
drwxr-xr-x.   2 root root    0 Feb 11 11:20 boot_params
drwxr-xr-x.   2 root root    0 Feb 11 11:20 btf
drwxr-xr-x.   2 root root    0 Feb 11 11:20 cgroup
drwxr-xr-x.   2 root root    0 Feb  8 07:45 config
drwx------.  51 root root    0 Feb  8 07:45 debug
-r--r--r--.   1 root root 4096 Feb 11 11:20 fscaps
drwxr-xr-x.   2 root root    0 Feb  8 10:16 iommu_groups
drwxr-xr-x.  94 root root    0 Feb 11 11:20 irq
-r--r--r--.   1 root root 4096 Feb 11 11:20 kexec_crash_loaded
-rw-r--r--.   1 root root 4096 Feb 11 11:20 kexec_crash_size
-r--r--r--.   1 root root 4096 Feb 11 11:20 kexec_loaded
drwxr-xr-x.   2 root root    0 Feb 11 11:20 livepatch
drwxr-xr-x.   6 root root    0 Feb  8 07:45 mm
-r--r--r--.   1 root root  512 Feb 11 11:20 notes
-rw-r--r--.   1 root root 4096 Feb 11 11:20 profiling
-rw-r--r--.   1 root root 4096 Feb 11 11:20 rcu_expedited
-rw-r--r--.   1 root root 4096 Feb 11 11:20 rcu_normal
drwxr-xr-x.   4 root root    0 Feb  8 07:45 security
drwxr-xr-x. 163 root root    0 Feb 11 11:20 slab
drwxr-xr-x.   4 root root    0 Feb 11 11:20 software_nodes
drwx------.   8 root root    0 Feb  8 07:45 tracing
-r--r--r--.   1 root root 4096 Feb 11 11:20 uevent_seqnum
-r--r--r--.   1 root root 4096 Feb 11 11:20 vmcoreinfo

Also it is very uncommon in large subsystems to see custom sysfs entries
for the specific driver. I wonder why this dw-xdata-pcie driver is different.

Thanks

>
> diff --git a/Documentation/ABI/testing/sysfs-driver-xdata b/Documentation/ABI/testing/sysfs-driver-xdata
> new file mode 100644
> index 00000000..a7bb44b
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-driver-xdata
> @@ -0,0 +1,46 @@
> +What:		/sys/kernel/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/kernel/dw-xdata-pcie/write
> +
> +		The user can read the current PCIe link throughput generated
> +		through this generator.
> +		Usage e.g.
> +		 cat /sys/kernel/dw-xdata-pcie/write
> +		 204 MB/s
> +
> +		The file is read and write.
> +
> +What:		/sys/kernel/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/kernel/dw-xdata-pcie/read
> +
> +		The user can read the current PCIe link throughput generated
> +		through this generator.
> +		Usage e.g.
> +		 cat /sys/kernel/dw-xdata-pcie/read
> +		 199 MB/s
> +
> +		The file is read and write.
> +
> +What:		/sys/kernel/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/kernel/dw-xdata-pcie/stop
> +
> +		The file is write only.
> --
> 2.7.4
>

  reply	other threads:[~2021-02-11  9:32 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-02-11  9:08 [PATCH v5 0/6] misc: Add Add Synopsys DesignWare xData IP driver Gustavo Pimentel
2021-02-11  9:08 ` [PATCH v5 1/6] misc: " Gustavo Pimentel
2021-02-11  9:30   ` Greg Kroah-Hartman
2021-02-11  9:50     ` Gustavo Pimentel
2021-02-11  9:59       ` Greg Kroah-Hartman
2021-02-11 10:21         ` Gustavo Pimentel
2021-02-11 10:33           ` Greg Kroah-Hartman
2021-02-11 10:51             ` Gustavo Pimentel
2021-02-11 11:42   ` Leon Romanovsky
2021-02-11 12:32     ` Greg Kroah-Hartman
2021-02-11 13:50       ` Leon Romanovsky
2021-02-11 14:02         ` Greg Kroah-Hartman
2021-02-11 14:13           ` Leon Romanovsky
2021-02-11  9:08 ` [PATCH v5 2/6] misc: Add Synopsys DesignWare xData IP driver to Makefile Gustavo Pimentel
2021-02-11  9:28   ` Greg Kroah-Hartman
2021-02-11  9:40     ` Gustavo Pimentel
2021-02-11  9:08 ` [PATCH v5 3/6] misc: Add Synopsys DesignWare xData IP driver to Kconfig Gustavo Pimentel
2021-02-11 11:29   ` Krzysztof Wilczyński
2021-02-11 13:33     ` Gustavo Pimentel
2021-02-11  9:08 ` [PATCH v5 4/6] Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver Gustavo Pimentel
2021-02-11  9:08 ` [PATCH v5 5/6] MAINTAINERS: Add Synopsys xData IP driver maintainer Gustavo Pimentel
2021-02-11  9:08 ` [PATCH v5 6/6] docs: ABI: Add sysfs documentation interface of dw-xdata-pcie driver Gustavo Pimentel
2021-02-11  9:29   ` Leon Romanovsky [this message]
2021-02-11  9:36     ` Greg Kroah-Hartman

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=20210211092914.GD1275163@unreal \
    --to=leon@kernel.org \
    --cc=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 v5 6/6] 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).