All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Jonathan Neuschäfer" <j.neuschaefer@gmx.net>
To: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Cc: "Jonathan Neuschäfer" <j.neuschaefer@gmx.net>,
	"Linus Walleij" <linus.walleij@linaro.org>,
	openbmc@lists.ozlabs.org, linux-gpio@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH v1 1/1] pinctrl: wpcm450: Correct the fwnode_irq_get() return value check
Date: Fri, 9 Sep 2022 23:00:19 +0200	[thread overview]
Message-ID: <YxupY5MGWddiY2mq@probook> (raw)
In-Reply-To: <Yxm9fB/5IJS3MXGu@smile.fi.intel.com>

[-- Attachment #1: Type: text/plain, Size: 2795 bytes --]

Hello,


On Thu, Sep 08, 2022 at 01:01:32PM +0300, Andy Shevchenko wrote:
> On Wed, Sep 07, 2022 at 11:04:40PM +0200, Jonathan Neuschäfer wrote:
> > On Mon, Sep 05, 2022 at 10:14:08PM +0300, Andy Shevchenko wrote:
> > > fwnode_irq_get() may return all possible signed values, such as Linux
> > > error code. Fix the code to handle this properly.
> > 
> > It would be good to note explicitly here what a return value of zero
> > means, i.e., as the documentation of of_irq_get says, "IRQ mapping
> > failure", and why it should result in skipping this IRQ.
> 
> Not that I'm fun of duplicating documentation in the commit message,
> but it won't take much in this case.

My problem with the description is that handling "all possible signed
values" is fairly meaningless: The code arguably did that already, it
did *something* for every possible value. The significant change of
your patch is that the value zero is handled differently.

IOW, what I miss is something along the lines of: "fwnode_irq_get can
return zero to indicate some errors. Handle this case like other errors."

> ...
> 
> > >  		for (i = 0; i < WPCM450_NUM_GPIO_IRQS; i++) {
> > > -			int irq = fwnode_irq_get(child, i);
> > > +			int irq;
> > >  
> > > +			irq = fwnode_irq_get(child, i);
> 
> > (Unneccesary churn, but I'll allow it)
> 
> The point here is to see that we actually check something that we just got
> from somewhere else. It's slightly better for reading and maintaining the
> code as I explained in [1].
> 
> And there is a difference to the cases like
> 
> static int foo(struct platform_device *pdev, ...)
> {
> 	struct device *dev = &pdev->dev;
> 	...
> }
> 
> when we know ahead that if pdev is NULL, something is _so_ wrong that
> it's not even our issue.
> 
> [1]: https://lore.kernel.org/lkml/CAHp75Vda5KX5pVrNeueQEODoEy405eTb9SYJtts-Lm9jMNocHQ@mail.gmail.com/

Ok, fair enough.


> 
> > >  			if (irq < 0)
> > >  				break;
> > > +			if (!irq)
> > > +				continue;
> > 
> > Since irq == 0 seems to be an error condition, the following seems fine
> > to me, and simpler:
> > 
> > -			if (irq < 0)
> > +			if (irq <= 0)
> >  				break;
> 
> Not sure it's the same by two reasons:
>  1) break != continue;

Right, hence why I asked for reasoning why zero should be handled
the way you propose to handle it.

>  2) we might need to convert 0 to error if we ever go to report this

Good point.

> 
> So, to me mapping error shouldn't be fatal to continue, but I would
> like to hear your interpretation since you know this case much better
> than me.

However: In wpcm450_gpio_register, there is currently no reporting for
mapping errors in this loop.

I'm fine with either break or continue.


Thanks,
Jonathan

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

WARNING: multiple messages have this Message-ID (diff)
From: "Jonathan Neuschäfer" <j.neuschaefer@gmx.net>
To: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Cc: linux-gpio@vger.kernel.org,
	"Linus Walleij" <linus.walleij@linaro.org>,
	"Jonathan Neuschäfer" <j.neuschaefer@gmx.net>,
	linux-kernel@vger.kernel.org, openbmc@lists.ozlabs.org
Subject: Re: [PATCH v1 1/1] pinctrl: wpcm450: Correct the fwnode_irq_get() return value check
Date: Fri, 9 Sep 2022 23:00:19 +0200	[thread overview]
Message-ID: <YxupY5MGWddiY2mq@probook> (raw)
In-Reply-To: <Yxm9fB/5IJS3MXGu@smile.fi.intel.com>

[-- Attachment #1: Type: text/plain, Size: 2795 bytes --]

Hello,


On Thu, Sep 08, 2022 at 01:01:32PM +0300, Andy Shevchenko wrote:
> On Wed, Sep 07, 2022 at 11:04:40PM +0200, Jonathan Neuschäfer wrote:
> > On Mon, Sep 05, 2022 at 10:14:08PM +0300, Andy Shevchenko wrote:
> > > fwnode_irq_get() may return all possible signed values, such as Linux
> > > error code. Fix the code to handle this properly.
> > 
> > It would be good to note explicitly here what a return value of zero
> > means, i.e., as the documentation of of_irq_get says, "IRQ mapping
> > failure", and why it should result in skipping this IRQ.
> 
> Not that I'm fun of duplicating documentation in the commit message,
> but it won't take much in this case.

My problem with the description is that handling "all possible signed
values" is fairly meaningless: The code arguably did that already, it
did *something* for every possible value. The significant change of
your patch is that the value zero is handled differently.

IOW, what I miss is something along the lines of: "fwnode_irq_get can
return zero to indicate some errors. Handle this case like other errors."

> ...
> 
> > >  		for (i = 0; i < WPCM450_NUM_GPIO_IRQS; i++) {
> > > -			int irq = fwnode_irq_get(child, i);
> > > +			int irq;
> > >  
> > > +			irq = fwnode_irq_get(child, i);
> 
> > (Unneccesary churn, but I'll allow it)
> 
> The point here is to see that we actually check something that we just got
> from somewhere else. It's slightly better for reading and maintaining the
> code as I explained in [1].
> 
> And there is a difference to the cases like
> 
> static int foo(struct platform_device *pdev, ...)
> {
> 	struct device *dev = &pdev->dev;
> 	...
> }
> 
> when we know ahead that if pdev is NULL, something is _so_ wrong that
> it's not even our issue.
> 
> [1]: https://lore.kernel.org/lkml/CAHp75Vda5KX5pVrNeueQEODoEy405eTb9SYJtts-Lm9jMNocHQ@mail.gmail.com/

Ok, fair enough.


> 
> > >  			if (irq < 0)
> > >  				break;
> > > +			if (!irq)
> > > +				continue;
> > 
> > Since irq == 0 seems to be an error condition, the following seems fine
> > to me, and simpler:
> > 
> > -			if (irq < 0)
> > +			if (irq <= 0)
> >  				break;
> 
> Not sure it's the same by two reasons:
>  1) break != continue;

Right, hence why I asked for reasoning why zero should be handled
the way you propose to handle it.

>  2) we might need to convert 0 to error if we ever go to report this

Good point.

> 
> So, to me mapping error shouldn't be fatal to continue, but I would
> like to hear your interpretation since you know this case much better
> than me.

However: In wpcm450_gpio_register, there is currently no reporting for
mapping errors in this loop.

I'm fine with either break or continue.


Thanks,
Jonathan

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

  reply	other threads:[~2022-09-09 21:00 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-05 19:14 [PATCH v1 1/1] pinctrl: wpcm450: Correct the fwnode_irq_get() return value check Andy Shevchenko
2022-09-07 21:04 ` Jonathan Neuschäfer
2022-09-07 21:04   ` Jonathan Neuschäfer
2022-09-08 10:01   ` Andy Shevchenko
2022-09-08 10:01     ` Andy Shevchenko
2022-09-09 21:00     ` Jonathan Neuschäfer [this message]
2022-09-09 21:00       ` Jonathan Neuschäfer

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=YxupY5MGWddiY2mq@probook \
    --to=j.neuschaefer@gmx.net \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=linus.walleij@linaro.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=openbmc@lists.ozlabs.org \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.