From:   "Fabio M. De Francesco" <fmdefrancesco@gmail.com>
To:     outreachy@lists.linux.dev,
        Khadija Kamran <kamrankhadijadj@gmail.com>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc:     linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v6] staging: axis-fifo: initialize timeouts in init only
Date:   Thu, 16 Mar 2023 20:30:06 +0100
Message-ID: <111937545.nniJfEyVGO@suse>
In-Reply-To: <2552330.Lt9SDvczpP@suse>
References: <ZBNDJwFHE3vIFS3+@khadija-virtual-machine> <2552330.Lt9SDvczpP@suse>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain; charset="iso-8859-1"
Precedence: bulk

On gioved=EC 16 marzo 2023 19:11:09 CET Fabio M. De Francesco wrote:
> On gioved=EC 16 marzo 2023 17:26:15 CET Khadija Kamran wrote:
> > Initialize the module parameters, read_timeout and write_timeout once in
> > init().
> >=20
> > Module parameters can only be set once and cannot be modified later, so=
 we
> > don't need to evaluate them again when passing the parameters to
> > wait_event_interruptible_timeout().
> >=20
> > Convert datatype of {read,write}_timeout from 'int' to 'long int' becau=
se
> > implicit conversion of 'long int' to 'int' in statement
> > '{read,write}_timeout =3D MAX_SCHEDULE_TIMEOUT' results in an overflow.
> >=20
> > Change format specifier for {read,write}_timeout from %i to %li.
>=20
> It's good that you added this line. I had missed it :-)
>=20
> > Suggested-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> > Signed-off-by: Khadija Kamran <kamrankhadijadj@gmail.com>
> > ---
> >=20
> > Changes in v6:
> >  - Initialize module parameters in init instead of probe function.
> >  - Change the subject and description
> >  - Change format specifiers of module parameters to "%li"
> >=20
> > Changes in v5:
> >  - Convert module parameters's datatype from int to long.
>=20
> NIT: "parameters'", not "parameters's".
>=20
> >  - Link to patch:
> >  https://lore.kernel.org/outreachy/ZBMR4s8xyHGqMm72@khadija-virtual-mac=
hine/
> >=20
> > Changes in v4:
> >  - Initialize timeouts once as suggested by Greg; this automatically
> > =20
> >    fixes the indentation problems.
> > =20
> >  - Change the subject and description.
> >  - Link to patch:
> >  https://lore.kernel.org/outreachy/ZA4M3+ZeB1Rl2fbs@khadija-virtual-mac=
hine/
> >=20
> > Changes in v3:
> >  - Correct grammatical mistakes
> >  - Do not change the second argument's indentation in split lines
> >=20
> > Changes in v2:
> >  - Instead of matching alignment to open parenthesis, align second and
> > =20
> >    the last argument.
> > =20
> >  - Change the subject and use imperative language.
> >  - Link to patch:
> >  https://lore.kernel.org/outreachy/ZAxNYw2rFQkrdtKl@khadija-virtual-mac=
hine/
> >=20
> > Link to first patch:
> >  https://lore.kernel.org/outreachy/ZAZSmPpB6fcozGa4@khadija-virtual-mac=
hine/
> >=20
> > drivers/staging/axis-fifo/axis-fifo.c | 28 ++++++++++++++++-----------
> >=20
> >  1 file changed, 17 insertions(+), 11 deletions(-)
> >=20
> > diff --git a/drivers/staging/axis-fifo/axis-fifo.c
> > b/drivers/staging/axis-fifo/axis-fifo.c index dfd2b357f484..0a85ea667a1b
> > 100644
> > --- a/drivers/staging/axis-fifo/axis-fifo.c
> > +++ b/drivers/staging/axis-fifo/axis-fifo.c
> > @@ -103,17 +103,17 @@
> >=20
> >   *           globals
> >   * ----------------------------
> >   */
> >=20
> > -static int read_timeout =3D 1000; /* ms to wait before read() times ou=
t */
> > -static int write_timeout =3D 1000; /* ms to wait before write() times =
out=20
*/
> > +static long read_timeout =3D 1000; /* ms to wait before read() times o=
ut */
> > +static long write_timeout =3D 1000; /* ms to wait before write() times=
 out=20
*/
> >=20
> >  /* ----------------------------
> > =20
> >   * module command-line arguments
> >   * ----------------------------
> >   */
> >=20
> > -module_param(read_timeout, int, 0444);
> > +module_param(read_timeout, long, 0444);
> >=20
> >  MODULE_PARM_DESC(read_timeout, "ms to wait before blocking read() timi=
ng
>=20
> out;
>=20
> > set to -1 for no timeout"); -module_param(write_timeout, int, 0444);
> > +module_param(write_timeout, long, 0444);
> >=20
> >  MODULE_PARM_DESC(write_timeout, "ms to wait before blocking write()=20
timing
> >=20
> > out; set to -1 for no timeout");
> >=20
> >  /* ----------------------------
> >=20
> > @@ -384,9 +384,7 @@ static ssize_t axis_fifo_read(struct file *f, char
>=20
> __user
>=20
> > *buf, mutex_lock(&fifo->read_lock);
> >=20
> >  		ret =3D wait_event_interruptible_timeout(fifo->read_queue,
> >  	=09
> >  			ioread32(fifo->base_addr + XLLF_RDFO_OFFSET),
> >=20
> > -				 (read_timeout >=3D 0) ?
> > -				  msecs_to_jiffies(read_timeout) :
> > -				  MAX_SCHEDULE_TIMEOUT);
> > +			read_timeout);
> >=20
> >  		if (ret <=3D 0) {
> >  	=09
> >  			if (ret =3D=3D 0) {
> >=20
> > @@ -528,9 +526,7 @@ static ssize_t axis_fifo_write(struct file *f, const
>=20
> char
>=20
> > __user *buf, ret =3D wait_event_interruptible_timeout(fifo->write_queue,
> >=20
> >  			ioread32(fifo->base_addr + XLLF_TDFV_OFFSET)
> >  		=09
> >  				 >=3D words_to_write,
>=20
> NIT: I don't really like this split of the second argument into two lines.
> This line may look too long, but I don't think that it should be split. I
> prefer to read
>=20
> "ioread32(fifo->base_addr + XLLF_TDFV_OFFSET) >=3D words_to_write,"
>=20
> However, the final decision is up to Greg.
>=20
> If he takes the code as is, I have nothing against.
> Don't send any other version unless required by Greg or other Mentors with
> more experience than I have.
>=20
> All the rest look good... well done!
>=20
> Reviewed-by: Fabio M. De Francesco

Sorry, I got distracted while copy-pasting my own address...

Reviewed-by: Fabio M. De Francesco <fmdefrancesco@gmail.com>
=20
> Please feel free to forward my tag if you are required to change that lin=
e=20
and
> send a new version.
>=20
> Thanks,
>=20
> Fabio
>=20
> > -				 (write_timeout >=3D 0) ?
> > -				  msecs_to_jiffies(write_timeout) :
> > -				  MAX_SCHEDULE_TIMEOUT);
> > +			write_timeout);
> >=20
> >  		if (ret <=3D 0) {
> >  	=09
> >  			if (ret =3D=3D 0) {
> >=20
> > @@ -948,7 +944,17 @@ static struct platform_driver axis_fifo_driver =3D=
 {
> >=20
> >  static int __init axis_fifo_init(void)
> >  {
> >=20
> > -	pr_info("axis-fifo driver loaded with parameters read_timeout =3D %i,
> > write_timeout =3D %i\n", +	if (read_timeout >=3D 0)
> > +		read_timeout =3D msecs_to_jiffies(read_timeout);
> > +	else
> > +		read_timeout =3D MAX_SCHEDULE_TIMEOUT;
> > +
> > +	if (write_timeout >=3D 0)
> > +		write_timeout =3D msecs_to_jiffies(write_timeout);
> > +	else
> > +		write_timeout =3D MAX_SCHEDULE_TIMEOUT;
> > +
> > +	pr_info("axis-fifo driver loaded with parameters read_timeout =3D %li,
> > write_timeout =3D %li\n", read_timeout, write_timeout);
> >=20
> >  	return platform_driver_register(&axis_fifo_driver);
> > =20
> >  }
> >=20
> > --
> > 2.34.1