[PATCH v4 0/3] Make fwnode_property_get_reference_args accept NULL args

[PATCH v4 0/3] Make fwnode_property_get_reference_args accept NULL args

[Sakari Ailus]

Hi all,

The of_parse_phandle_with_args() accepts NULL args but
fwnode_property_get_reference_args() does not currently, in its ACPI or
software node implementations. Fix this.

since v3:

- Return 0 early if args is NULL (1st patch).

since v2:

- Correct fwnode_property_get_reference_args() name (was
  fwnode_property_get_reference()) in commit messages.

since v1:

- Applies to Rafael's devprop branch now (i.e. not on top of DisCo for
  Imaging set).

- Add Fixes: tags.

- Small documentation line wrap change in the first patch.

Sakari Ailus (3):
  acpi: property: Let args be NULL in __acpi_node_get_property_reference
  software node: Let args be NULL in software_node_get_reference_args
  device property: fwnode_property_get_reference_args allows NULL args
    now

 drivers/acpi/property.c | 4 ++++
 drivers/base/property.c | 1 +
 drivers/base/swnode.c   | 3 +++
 3 files changed, 8 insertions(+)

-- 
2.39.2

[PATCH v4 1/3] acpi: property: Let args be NULL in __acpi_node_get_property_reference

[Sakari Ailus]

fwnode_get_property_reference_args() may not be called with args argument
NULL on ACPI, OF already supports this. Add the missing NULL checks and
document this.

The purpose is to be able to count the references.

Fixes: 977d5ad39f3e ("ACPI: Convert ACPI reference args to generic fwnode reference args")
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 drivers/acpi/property.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/drivers/acpi/property.c b/drivers/acpi/property.c
index 413e4fcadcaf..93608714b652 100644
--- a/drivers/acpi/property.c
+++ b/drivers/acpi/property.c
@@ -851,6 +851,7 @@ static int acpi_get_ref_args(struct fwnode_reference_args *args,
  * @index: Index of the reference to return
  * @num_args: Maximum number of arguments after each reference
  * @args: Location to store the returned reference with optional arguments
+ *	  (may be NULL)
  *
  * Find property with @name, verifify that it is a package containing at least
  * one object reference and if so, store the ACPI device object pointer to the
@@ -907,6 +908,9 @@ int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
 		if (!device)
 			return -EINVAL;
 
+		if (!args)
+			return 0;
+
 		args->fwnode = acpi_fwnode_handle(device);
 		args->nargs = 0;
 		return 0;
-- 
2.39.2

[PATCH v4 2/3] software node: Let args be NULL in software_node_get_reference_args

[Sakari Ailus]

fwnode_get_property_reference_args() may not be called with args argument
NULL and while OF already supports this. Add the missing NULL check.

The purpose is to be able to count the references.

Fixes: b06184acf751 ("software node: Add software_node_get_reference_args()")
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 drivers/base/swnode.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/drivers/base/swnode.c b/drivers/base/swnode.c
index 1886995a0b3a..079bd14bdedc 100644
--- a/drivers/base/swnode.c
+++ b/drivers/base/swnode.c
@@ -541,6 +541,9 @@ software_node_get_reference_args(const struct fwnode_handle *fwnode,
 	if (nargs > NR_FWNODE_REFERENCE_ARGS)
 		return -EINVAL;
 
+	if (!args)
+		return 0;
+
 	args->fwnode = software_node_get(refnode);
 	args->nargs = nargs;
 
-- 
2.39.2

[PATCH v4 3/3] device property: fwnode_property_get_reference_args allows NULL args now

[Sakari Ailus]

All three fwnode_property_get_reference_args() implemantations now allow
args argument to be NULL. Document this.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 drivers/base/property.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/base/property.c b/drivers/base/property.c
index 8c40abed7852..8667b13639d2 100644
--- a/drivers/base/property.c
+++ b/drivers/base/property.c
@@ -508,6 +508,7 @@ EXPORT_SYMBOL_GPL(fwnode_property_match_string);
  * @nargs:	Number of arguments. Ignored if @nargs_prop is non-NULL.
  * @index:	Index of the reference, from zero onwards.
  * @args:	Result structure with reference and integer arguments.
+ *		May be NULL.
  *
  * Obtain a reference based on a named property in an fwnode, with
  * integer arguments.
-- 
2.39.2

Re: [PATCH v4 1/3] acpi: property: Let args be NULL in __acpi_node_get_property_reference

[Heikki Krogerus]

On Fri, Nov 03, 2023 at 10:36:23AM +0200, Sakari Ailus wrote:
> fwnode_get_property_reference_args() may not be called with args argument
> NULL on ACPI, OF already supports this. Add the missing NULL checks and
> document this.
> 
> The purpose is to be able to count the references.
> 
> Fixes: 977d5ad39f3e ("ACPI: Convert ACPI reference args to generic fwnode reference args")
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>

Reviewed-by: Heikki Krogerus <heikki.krogerus@linux.intel.com>

> ---
>  drivers/acpi/property.c | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/drivers/acpi/property.c b/drivers/acpi/property.c
> index 413e4fcadcaf..93608714b652 100644
> --- a/drivers/acpi/property.c
> +++ b/drivers/acpi/property.c
> @@ -851,6 +851,7 @@ static int acpi_get_ref_args(struct fwnode_reference_args *args,
>   * @index: Index of the reference to return
>   * @num_args: Maximum number of arguments after each reference
>   * @args: Location to store the returned reference with optional arguments
> + *	  (may be NULL)
>   *
>   * Find property with @name, verifify that it is a package containing at least
>   * one object reference and if so, store the ACPI device object pointer to the
> @@ -907,6 +908,9 @@ int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
>  		if (!device)
>  			return -EINVAL;
>  
> +		if (!args)
> +			return 0;
> +
>  		args->fwnode = acpi_fwnode_handle(device);
>  		args->nargs = 0;
>  		return 0;
> -- 
> 2.39.2

-- 
heikki

Re: [PATCH v4 2/3] software node: Let args be NULL in software_node_get_reference_args

[Heikki Krogerus]

On Fri, Nov 03, 2023 at 10:36:24AM +0200, Sakari Ailus wrote:
> fwnode_get_property_reference_args() may not be called with args argument
> NULL and while OF already supports this. Add the missing NULL check.
> 
> The purpose is to be able to count the references.
> 
> Fixes: b06184acf751 ("software node: Add software_node_get_reference_args()")
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>

Reviewed-by: Heikki Krogerus <heikki.krogerus@linux.intel.com>

> ---
>  drivers/base/swnode.c | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/drivers/base/swnode.c b/drivers/base/swnode.c
> index 1886995a0b3a..079bd14bdedc 100644
> --- a/drivers/base/swnode.c
> +++ b/drivers/base/swnode.c
> @@ -541,6 +541,9 @@ software_node_get_reference_args(const struct fwnode_handle *fwnode,
>  	if (nargs > NR_FWNODE_REFERENCE_ARGS)
>  		return -EINVAL;
>  
> +	if (!args)
> +		return 0;
> +
>  	args->fwnode = software_node_get(refnode);
>  	args->nargs = nargs;
>  
> -- 
> 2.39.2

-- 
heikki

Re: [PATCH v4 3/3] device property: fwnode_property_get_reference_args allows NULL args now

[Heikki Krogerus]

On Fri, Nov 03, 2023 at 10:36:25AM +0200, Sakari Ailus wrote:
> All three fwnode_property_get_reference_args() implemantations now allow
> args argument to be NULL. Document this.
> 
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>

Reviewed-by: Heikki Krogerus <heikki.krogerus@linux.intel.com>

> ---
>  drivers/base/property.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/base/property.c b/drivers/base/property.c
> index 8c40abed7852..8667b13639d2 100644
> --- a/drivers/base/property.c
> +++ b/drivers/base/property.c
> @@ -508,6 +508,7 @@ EXPORT_SYMBOL_GPL(fwnode_property_match_string);
>   * @nargs:	Number of arguments. Ignored if @nargs_prop is non-NULL.
>   * @index:	Index of the reference, from zero onwards.
>   * @args:	Result structure with reference and integer arguments.
> + *		May be NULL.
>   *
>   * Obtain a reference based on a named property in an fwnode, with
>   * integer arguments.
> -- 
> 2.39.2

-- 
heikki

Re: [PATCH v4 1/3] acpi: property: Let args be NULL in __acpi_node_get_property_reference

[Rafael J. Wysocki]

On Fri, Nov 3, 2023 at 9:36 AM Sakari Ailus
<sakari.ailus@linux.intel.com> wrote:
>
> fwnode_get_property_reference_args() may not be called with args argument
> NULL on ACPI, OF already supports this. Add the missing NULL checks and
> document this.
>
> The purpose is to be able to count the references.
>
> Fixes: 977d5ad39f3e ("ACPI: Convert ACPI reference args to generic fwnode reference args")
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> ---
>  drivers/acpi/property.c | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/drivers/acpi/property.c b/drivers/acpi/property.c
> index 413e4fcadcaf..93608714b652 100644
> --- a/drivers/acpi/property.c
> +++ b/drivers/acpi/property.c
> @@ -851,6 +851,7 @@ static int acpi_get_ref_args(struct fwnode_reference_args *args,
>   * @index: Index of the reference to return
>   * @num_args: Maximum number of arguments after each reference
>   * @args: Location to store the returned reference with optional arguments
> + *       (may be NULL)
>   *
>   * Find property with @name, verifify that it is a package containing at least
>   * one object reference and if so, store the ACPI device object pointer to the
> @@ -907,6 +908,9 @@ int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
>                 if (!device)
>                         return -EINVAL;
>
> +               if (!args)
> +                       return 0;
> +
>                 args->fwnode = acpi_fwnode_handle(device);
>                 args->nargs = 0;
>                 return 0;
> --

Is this series waiting for me to pick it up or am I confused?

Re: [PATCH v4 1/3] acpi: property: Let args be NULL in __acpi_node_get_property_reference

[Sakari Ailus]

On Tue, Nov 21, 2023 at 08:36:08PM +0100, Rafael J. Wysocki wrote:
> On Fri, Nov 3, 2023 at 9:36 AM Sakari Ailus
> <sakari.ailus@linux.intel.com> wrote:
> >
> > fwnode_get_property_reference_args() may not be called with args argument
> > NULL on ACPI, OF already supports this. Add the missing NULL checks and
> > document this.
> >
> > The purpose is to be able to count the references.
> >
> > Fixes: 977d5ad39f3e ("ACPI: Convert ACPI reference args to generic fwnode reference args")
> > Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> > ---
> >  drivers/acpi/property.c | 4 ++++
> >  1 file changed, 4 insertions(+)
> >
> > diff --git a/drivers/acpi/property.c b/drivers/acpi/property.c
> > index 413e4fcadcaf..93608714b652 100644
> > --- a/drivers/acpi/property.c
> > +++ b/drivers/acpi/property.c
> > @@ -851,6 +851,7 @@ static int acpi_get_ref_args(struct fwnode_reference_args *args,
> >   * @index: Index of the reference to return
> >   * @num_args: Maximum number of arguments after each reference
> >   * @args: Location to store the returned reference with optional arguments
> > + *       (may be NULL)
> >   *
> >   * Find property with @name, verifify that it is a package containing at least
> >   * one object reference and if so, store the ACPI device object pointer to the
> > @@ -907,6 +908,9 @@ int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
> >                 if (!device)
> >                         return -EINVAL;
> >
> > +               if (!args)
> > +                       return 0;
> > +
> >                 args->fwnode = acpi_fwnode_handle(device);
> >                 args->nargs = 0;
> >                 return 0;
> > --
> 
> Is this series waiting for me to pick it up or am I confused?

Yes, please!

-- 
Sakari Ailus

Re: [PATCH v4 1/3] acpi: property: Let args be NULL in __acpi_node_get_property_reference

[Rafael J. Wysocki]

On Tue, Nov 21, 2023 at 10:32 PM Sakari Ailus
<sakari.ailus@linux.intel.com> wrote:
>
> On Tue, Nov 21, 2023 at 08:36:08PM +0100, Rafael J. Wysocki wrote:
> > On Fri, Nov 3, 2023 at 9:36 AM Sakari Ailus
> > <sakari.ailus@linux.intel.com> wrote:
> > >
> > > fwnode_get_property_reference_args() may not be called with args argument
> > > NULL on ACPI, OF already supports this. Add the missing NULL checks and
> > > document this.
> > >
> > > The purpose is to be able to count the references.
> > >
> > > Fixes: 977d5ad39f3e ("ACPI: Convert ACPI reference args to generic fwnode reference args")
> > > Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> > > ---
> > >  drivers/acpi/property.c | 4 ++++
> > >  1 file changed, 4 insertions(+)
> > >
> > > diff --git a/drivers/acpi/property.c b/drivers/acpi/property.c
> > > index 413e4fcadcaf..93608714b652 100644
> > > --- a/drivers/acpi/property.c
> > > +++ b/drivers/acpi/property.c
> > > @@ -851,6 +851,7 @@ static int acpi_get_ref_args(struct fwnode_reference_args *args,
> > >   * @index: Index of the reference to return
> > >   * @num_args: Maximum number of arguments after each reference
> > >   * @args: Location to store the returned reference with optional arguments
> > > + *       (may be NULL)
> > >   *
> > >   * Find property with @name, verifify that it is a package containing at least
> > >   * one object reference and if so, store the ACPI device object pointer to the
> > > @@ -907,6 +908,9 @@ int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
> > >                 if (!device)
> > >                         return -EINVAL;
> > >
> > > +               if (!args)
> > > +                       return 0;
> > > +
> > >                 args->fwnode = acpi_fwnode_handle(device);
> > >                 args->nargs = 0;
> > >                 return 0;
> > > --
> >
> > Is this series waiting for me to pick it up or am I confused?
>
> Yes, please!

OK, applied as 6.8 material, thanks!

Re: [PATCH v4 1/3] acpi: property: Let args be NULL in __acpi_node_get_property_reference

[Sakari Ailus]

On Wed, Nov 22, 2023 at 10:15:34PM +0100, Rafael J. Wysocki wrote:
> On Tue, Nov 21, 2023 at 10:32 PM Sakari Ailus
> <sakari.ailus@linux.intel.com> wrote:
> >
> > On Tue, Nov 21, 2023 at 08:36:08PM +0100, Rafael J. Wysocki wrote:
> > > On Fri, Nov 3, 2023 at 9:36 AM Sakari Ailus
> > > <sakari.ailus@linux.intel.com> wrote:
> > > >
> > > > fwnode_get_property_reference_args() may not be called with args argument
> > > > NULL on ACPI, OF already supports this. Add the missing NULL checks and
> > > > document this.
> > > >
> > > > The purpose is to be able to count the references.
> > > >
> > > > Fixes: 977d5ad39f3e ("ACPI: Convert ACPI reference args to generic fwnode reference args")
> > > > Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> > > > ---
> > > >  drivers/acpi/property.c | 4 ++++
> > > >  1 file changed, 4 insertions(+)
> > > >
> > > > diff --git a/drivers/acpi/property.c b/drivers/acpi/property.c
> > > > index 413e4fcadcaf..93608714b652 100644
> > > > --- a/drivers/acpi/property.c
> > > > +++ b/drivers/acpi/property.c
> > > > @@ -851,6 +851,7 @@ static int acpi_get_ref_args(struct fwnode_reference_args *args,
> > > >   * @index: Index of the reference to return
> > > >   * @num_args: Maximum number of arguments after each reference
> > > >   * @args: Location to store the returned reference with optional arguments
> > > > + *       (may be NULL)
> > > >   *
> > > >   * Find property with @name, verifify that it is a package containing at least
> > > >   * one object reference and if so, store the ACPI device object pointer to the
> > > > @@ -907,6 +908,9 @@ int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
> > > >                 if (!device)
> > > >                         return -EINVAL;
> > > >
> > > > +               if (!args)
> > > > +                       return 0;
> > > > +
> > > >                 args->fwnode = acpi_fwnode_handle(device);
> > > >                 args->nargs = 0;
> > > >                 return 0;
> > > > --
> > >
> > > Is this series waiting for me to pick it up or am I confused?
> >
> > Yes, please!
> 
> OK, applied as 6.8 material, thanks!

Thank you, Rafael!

-- 
Sakari Ailus