Re: [PATCH v5 6/6] docs: ABI: Add sysfs documentation interface of dw-xdata-pcie driver

[Leon Romanovsky]

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@xxxxxxxxxxxx>
> ---
>  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@xxxxxxxxxxxx>
> +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@xxxxxxxxxxxx>
> +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@xxxxxxxxxxxx>
> +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
>