diff mbox series

[v9,4/4] docs: ABI: Add sysfs documentation interface of dw-xdata-pcie driver

Message ID 5840637a206dd1287caf142a0dbedf0dac9ccd48.1617011831.git.gustavo.pimentel@synopsys.com
State New
Headers show
Series misc: Add Add Synopsys DesignWare xData IP driver | expand

Commit Message

Gustavo Pimentel March 29, 2021, 9:59 a.m. UTC 
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

Comments

Greg Kroah-Hartman March 29, 2021, 10:08 a.m. UTC | #1 
On Mon, Mar 29, 2021 at 11:59:40AM +0200, 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
> 
> diff --git a/Documentation/ABI/testing/sysfs-driver-xdata b/Documentation/ABI/testing/sysfs-driver-xdata
> new file mode 100644
> index 00000000..66af19a
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-driver-xdata
> @@ -0,0 +1,46 @@
> +What:		/sys/class/misc/drivers/dw-xdata-pcie.<device>/write
> +Date:		April 2021
> +KernelVersion:	5.13
> +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/class/misc/dw-xdata-pcie.<device>/write

Again, this does not match the code.  Either fix the code (which I
recommend), or change this and the other sysfs descriptions of writing
values here.

thanks,

greg k-h
Gustavo Pimentel March 29, 2021, 10:25 a.m. UTC | #2 
On Mon, Mar 29, 2021 at 11:8:11, Greg Kroah-Hartman 
<gregkh@linuxfoundation.org> wrote:

> On Mon, Mar 29, 2021 at 11:59:40AM +0200, 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
> > 
> > diff --git a/Documentation/ABI/testing/sysfs-driver-xdata b/Documentation/ABI/testing/sysfs-driver-xdata
> > new file mode 100644
> > index 00000000..66af19a
> > --- /dev/null
> > +++ b/Documentation/ABI/testing/sysfs-driver-xdata
> > @@ -0,0 +1,46 @@
> > +What:		/sys/class/misc/drivers/dw-xdata-pcie.<device>/write
> > +Date:		April 2021
> > +KernelVersion:	5.13
> > +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/class/misc/dw-xdata-pcie.<device>/write
> 
> Again, this does not match the code.  Either fix the code (which I
> recommend), or change this and the other sysfs descriptions of writing
> values here.

I've commented about this previously, but I didn't get feedback on it, 
therefore I assumed that justification was okay.
I will change the code to accept only the "1" input on the *_store()

-Gustavo

> 
> thanks,
> 
> greg k-h
Greg Kroah-Hartman March 29, 2021, 10:40 a.m. UTC | #3 
On Mon, Mar 29, 2021 at 10:25:25AM +0000, Gustavo Pimentel wrote:
> On Mon, Mar 29, 2021 at 11:8:11, Greg Kroah-Hartman 
> <gregkh@linuxfoundation.org> wrote:
> 
> > On Mon, Mar 29, 2021 at 11:59:40AM +0200, 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
> > > 
> > > diff --git a/Documentation/ABI/testing/sysfs-driver-xdata b/Documentation/ABI/testing/sysfs-driver-xdata
> > > new file mode 100644
> > > index 00000000..66af19a
> > > --- /dev/null
> > > +++ b/Documentation/ABI/testing/sysfs-driver-xdata
> > > @@ -0,0 +1,46 @@
> > > +What:		/sys/class/misc/drivers/dw-xdata-pcie.<device>/write
> > > +Date:		April 2021
> > > +KernelVersion:	5.13
> > > +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/class/misc/dw-xdata-pcie.<device>/write
> > 
> > Again, this does not match the code.  Either fix the code (which I
> > recommend), or change this and the other sysfs descriptions of writing
> > values here.
> 
> I've commented about this previously, but I didn't get feedback on it, 
> therefore I assumed that justification was okay.
> I will change the code to accept only the "1" input on the *_store()

Why not use the built-in function to parse "1/y/Y" that the kernel
provides for this type of thing?

thanks,

greg k-h
Gustavo Pimentel March 29, 2021, 10:53 a.m. UTC | #4 
On Mon, Mar 29, 2021 at 11:40:28, Greg Kroah-Hartman 
<gregkh@linuxfoundation.org> wrote:

> On Mon, Mar 29, 2021 at 10:25:25AM +0000, Gustavo Pimentel wrote:
> > On Mon, Mar 29, 2021 at 11:8:11, Greg Kroah-Hartman 
> > <gregkh@linuxfoundation.org> wrote:
> > 
> > > On Mon, Mar 29, 2021 at 11:59:40AM +0200, 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
> > > > 
> > > > diff --git a/Documentation/ABI/testing/sysfs-driver-xdata b/Documentation/ABI/testing/sysfs-driver-xdata
> > > > new file mode 100644
> > > > index 00000000..66af19a
> > > > --- /dev/null
> > > > +++ b/Documentation/ABI/testing/sysfs-driver-xdata
> > > > @@ -0,0 +1,46 @@
> > > > +What:		/sys/class/misc/drivers/dw-xdata-pcie.<device>/write
> > > > +Date:		April 2021
> > > > +KernelVersion:	5.13
> > > > +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/class/misc/dw-xdata-pcie.<device>/write
> > > 
> > > Again, this does not match the code.  Either fix the code (which I
> > > recommend), or change this and the other sysfs descriptions of writing
> > > values here.
> > 
> > I've commented about this previously, but I didn't get feedback on it, 
> > therefore I assumed that justification was okay.
> > I will change the code to accept only the "1" input on the *_store()
> 
> Why not use the built-in function to parse "1/y/Y" that the kernel
> provides for this type of thing?

I found kstrtobool() just now. I'm adapting the code as we speak.
After testing I will send the v10 as soon as possible.

-Gustavo

> 
> thanks,
> 
> greg k-h
Greg Kroah-Hartman March 29, 2021, 11:03 a.m. UTC | #5 
On Mon, Mar 29, 2021 at 10:53:38AM +0000, Gustavo Pimentel wrote:
> On Mon, Mar 29, 2021 at 11:40:28, Greg Kroah-Hartman 
> <gregkh@linuxfoundation.org> wrote:
> 
> > On Mon, Mar 29, 2021 at 10:25:25AM +0000, Gustavo Pimentel wrote:
> > > On Mon, Mar 29, 2021 at 11:8:11, Greg Kroah-Hartman 
> > > <gregkh@linuxfoundation.org> wrote:
> > > 
> > > > On Mon, Mar 29, 2021 at 11:59:40AM +0200, 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
> > > > > 
> > > > > diff --git a/Documentation/ABI/testing/sysfs-driver-xdata b/Documentation/ABI/testing/sysfs-driver-xdata
> > > > > new file mode 100644
> > > > > index 00000000..66af19a
> > > > > --- /dev/null
> > > > > +++ b/Documentation/ABI/testing/sysfs-driver-xdata
> > > > > @@ -0,0 +1,46 @@
> > > > > +What:		/sys/class/misc/drivers/dw-xdata-pcie.<device>/write
> > > > > +Date:		April 2021
> > > > > +KernelVersion:	5.13
> > > > > +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/class/misc/dw-xdata-pcie.<device>/write
> > > > 
> > > > Again, this does not match the code.  Either fix the code (which I
> > > > recommend), or change this and the other sysfs descriptions of writing
> > > > values here.
> > > 
> > > I've commented about this previously, but I didn't get feedback on it, 
> > > therefore I assumed that justification was okay.
> > > I will change the code to accept only the "1" input on the *_store()
> > 
> > Why not use the built-in function to parse "1/y/Y" that the kernel
> > provides for this type of thing?
> 
> I found kstrtobool() just now. I'm adapting the code as we speak.
> After testing I will send the v10 as soon as possible.

There is no rush, take your time.

greg k-h
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-driver-xdata b/Documentation/ABI/testing/sysfs-driver-xdata
new file mode 100644
index 00000000..66af19a
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-driver-xdata
@@ -0,0 +1,46 @@ 
+What:		/sys/class/misc/drivers/dw-xdata-pcie.<device>/write
+Date:		April 2021
+KernelVersion:	5.13
+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/class/misc/dw-xdata-pcie.<device>/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.<device>/write
+		 204
+
+		The file is read and write.
+
+What:		/sys/class/misc/dw-xdata-pcie.<device>/read
+Date:		April 2021
+KernelVersion:	5.13
+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/class/misc/dw-xdata-pcie.<device>/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.<device>/read
+		 199
+
+		The file is read and write.
+
+What:		/sys/class/misc/dw-xdata-pcie.<device>/stop
+Date:		April 2021
+KernelVersion:	5.13
+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/class/misc/dw-xdata-pcie.<device>/stop
+
+		The file is write only.