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

2021-03-28 Thread Greg Kroah-Hartman
On Sat, Mar 27, 2021 at 04:06:55AM +0100, Gustavo Pimentel wrote:
> This patch describes the sysfs interface implemented on the dw-xdata-pcie
> driver.
> 
> Signed-off-by: Gustavo Pimentel 
> ---
>  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 ..cb3ab7e
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-driver-xdata
> @@ -0,0 +1,46 @@
> +What:/sys/class/misc/drivers/dw-xdata-pcie/write
> +Date:April 2021
> +KernelVersion:   5.12
> +Contact: Gustavo Pimentel 
> +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/class/misc/dw-xdata-pcie/write

That did not look like what the code was looking for at all :(


> +
> + The user can read the current PCIe link throughput generated
> + through this generator in MB/s.
> + Usage e.g.
> +  cat /sys/class/misc/dw-xdata-pcie/write
> +  204
> +
> + The file is read and write.
> +
> +What:/sys/class/misc/dw-xdata-pcie/read
> +Date:April 2021
> +KernelVersion:   5.12
> +Contact: Gustavo Pimentel 
> +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/class/misc/dw-xdata-pcie/read

Again, did not match the code :(


> +
> + The user can read the current PCIe link throughput generated
> + through this generator in MB/s.
> + Usage e.g.
> +  cat /sys/class/misc/dw-xdata-pcie/read
> +  199
> +
> + The file is read and write.
> +
> +What:/sys/class/misc/dw-xdata-pcie/stop
> +Date:April 2021
> +KernelVersion:   5.12
> +Contact: Gustavo Pimentel 
> +Description: Allows the user to disable the PCIe traffic generator in all
> + directions.
> + Usage e.g.
> +  echo 1 > /sys/class/misc/dw-xdata-pcie/stop

Same here :(

Who tested this?


[PATCH v7 5/5] docs: ABI: Add sysfs documentation interface of dw-xdata-pcie driver

2021-03-26 Thread Gustavo Pimentel
This patch describes the sysfs interface implemented on the dw-xdata-pcie
driver.

Signed-off-by: Gustavo Pimentel 
---
 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 ..cb3ab7e
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-driver-xdata
@@ -0,0 +1,46 @@
+What:  /sys/class/misc/drivers/dw-xdata-pcie/write
+Date:  April 2021
+KernelVersion: 5.12
+Contact:   Gustavo Pimentel 
+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/class/misc/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/class/misc/dw-xdata-pcie/write
+204
+
+   The file is read and write.
+
+What:  /sys/class/misc/dw-xdata-pcie/read
+Date:  April 2021
+KernelVersion: 5.12
+Contact:   Gustavo Pimentel 
+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/class/misc/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/class/misc/dw-xdata-pcie/read
+199
+
+   The file is read and write.
+
+What:  /sys/class/misc/dw-xdata-pcie/stop
+Date:  April 2021
+KernelVersion: 5.12
+Contact:   Gustavo Pimentel 
+Description:   Allows the user to disable the PCIe traffic generator in all
+   directions.
+   Usage e.g.
+echo 1 > /sys/class/misc/dw-xdata-pcie/stop
+
+   The file is write only.
-- 
2.7.4