[PATCH v2] iio: ad5770r: make devicetree property reading consistent

[PATCH v2] iio: ad5770r: make devicetree property reading consistent

[Nuno Sá]

The bindings file for this driver is defining the property as 'reg' but
the driver was reading it with the 'num' name. The bindings actually had
the 'num' property when added in
commit ea52c21268e6 ("dt-bindings: iio: dac: Add docs for AD5770R DAC")
and then changed it to 'reg' in
commit 2cf3818f18b2 ("dt-bindings: iio: dac: AD5570R fix bindings errors").
However, both these commits landed in v5.7 so the assumption is
that either 'num' is not being used or if it is, the validations were not
done.

Anyways, if someone comes back yelling about this, we might just support
both of the properties in the future. Not ideal, but that's life...

Fixes: 2cf3818f18b2 ("dt-bindings: iio: dac: AD5570R fix bindings errors")
Signed-off-by: Nuno Sá <nuno.sa@analog.com>
---
v2:
 * Updated the commit description and added a fixes tag.

 drivers/iio/dac/ad5770r.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/iio/dac/ad5770r.c b/drivers/iio/dac/ad5770r.c
index 8107f7bbbe3c..7e2fd32e993a 100644
--- a/drivers/iio/dac/ad5770r.c
+++ b/drivers/iio/dac/ad5770r.c
@@ -522,7 +522,7 @@ static int ad5770r_channel_config(struct ad5770r_state *st)
 		return -EINVAL;
 
 	device_for_each_child_node(&st->spi->dev, child) {
-		ret = fwnode_property_read_u32(child, "num", &num);
+		ret = fwnode_property_read_u32(child, "reg", &num);
 		if (ret)
 			goto err_child_out;
 		if (num >= AD5770R_MAX_CHANNELS) {
-- 
2.32.0

Re: [PATCH v2] iio: ad5770r: make devicetree property reading consistent

[Andy Shevchenko]

On Wed, Aug 18, 2021 at 11:05 AM Nuno Sá <nuno.sa@analog.com> wrote:
>
> The bindings file for this driver is defining the property as 'reg' but
> the driver was reading it with the 'num' name. The bindings actually had
> the 'num' property when added in
> commit ea52c21268e6 ("dt-bindings: iio: dac: Add docs for AD5770R DAC")
> and then changed it to 'reg' in
> commit 2cf3818f18b2 ("dt-bindings: iio: dac: AD5570R fix bindings errors").
> However, both these commits landed in v5.7 so the assumption is
> that either 'num' is not being used or if it is, the validations were not
> done.
>
> Anyways, if someone comes back yelling about this, we might just support
> both of the properties in the future. Not ideal, but that's life...

Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>

> Fixes: 2cf3818f18b2 ("dt-bindings: iio: dac: AD5570R fix bindings errors")
> Signed-off-by: Nuno Sá <nuno.sa@analog.com>
> ---
> v2:
>  * Updated the commit description and added a fixes tag.
>
>  drivers/iio/dac/ad5770r.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/iio/dac/ad5770r.c b/drivers/iio/dac/ad5770r.c
> index 8107f7bbbe3c..7e2fd32e993a 100644
> --- a/drivers/iio/dac/ad5770r.c
> +++ b/drivers/iio/dac/ad5770r.c
> @@ -522,7 +522,7 @@ static int ad5770r_channel_config(struct ad5770r_state *st)
>                 return -EINVAL;
>
>         device_for_each_child_node(&st->spi->dev, child) {
> -               ret = fwnode_property_read_u32(child, "num", &num);
> +               ret = fwnode_property_read_u32(child, "reg", &num);
>                 if (ret)
>                         goto err_child_out;
>                 if (num >= AD5770R_MAX_CHANNELS) {
> --
> 2.32.0
>


-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH v2] iio: ad5770r: make devicetree property reading consistent

[Jonathan Cameron]

On Wed, 18 Aug 2021 12:54:09 +0300
Andy Shevchenko <andy.shevchenko@gmail.com> wrote:

> On Wed, Aug 18, 2021 at 11:05 AM Nuno Sá <nuno.sa@analog.com> wrote:
> >
> > The bindings file for this driver is defining the property as 'reg' but
> > the driver was reading it with the 'num' name. The bindings actually had
> > the 'num' property when added in
> > commit ea52c21268e6 ("dt-bindings: iio: dac: Add docs for AD5770R DAC")
> > and then changed it to 'reg' in
> > commit 2cf3818f18b2 ("dt-bindings: iio: dac: AD5570R fix bindings errors").
> > However, both these commits landed in v5.7 so the assumption is
> > that either 'num' is not being used or if it is, the validations were not
> > done.
> >
> > Anyways, if someone comes back yelling about this, we might just support
> > both of the properties in the future. Not ideal, but that's life...  
> 
> Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>

Given the potential issues on this I want it to sit in next for a while. As such
I'm applying it via the slow path rather than the quick one.  It'll sit in next
for most of a cycle before the merge window in 3 months time.

Hopefully anyone who has fallen in the gap is doing tests! (seems unlikely but
they can't claim we didn't give them time to notice ;)

Applied to the togreg branch of iio.git and marked for stable.

Thanks,

Jonathan

> 
> > Fixes: 2cf3818f18b2 ("dt-bindings: iio: dac: AD5570R fix bindings errors")
> > Signed-off-by: Nuno Sá <nuno.sa@analog.com>
> > ---
> > v2:
> >  * Updated the commit description and added a fixes tag.
> >
> >  drivers/iio/dac/ad5770r.c | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/drivers/iio/dac/ad5770r.c b/drivers/iio/dac/ad5770r.c
> > index 8107f7bbbe3c..7e2fd32e993a 100644
> > --- a/drivers/iio/dac/ad5770r.c
> > +++ b/drivers/iio/dac/ad5770r.c
> > @@ -522,7 +522,7 @@ static int ad5770r_channel_config(struct ad5770r_state *st)
> >                 return -EINVAL;
> >
> >         device_for_each_child_node(&st->spi->dev, child) {
> > -               ret = fwnode_property_read_u32(child, "num", &num);
> > +               ret = fwnode_property_read_u32(child, "reg", &num);
> >                 if (ret)
> >                         goto err_child_out;
> >                 if (num >= AD5770R_MAX_CHANNELS) {
> > --
> > 2.32.0
> >  
> 
>