Re: [PATCH v2 08/16] property: Document that fwnode API returns available nodes

Laurent Pinchart
2025-09-24T10:07:30Z

Hi Sakari,

On Wed, Sep 24, 2025 at 10:45:54AM +0300, Sakari Ailus wrote:
> The fwnode API has historically provided two functions to iterate over a
> fwnode's child nodes, fwnode_get_next_child_node() and
> fwnode_get_next_available_child_node() whereas all of the fwnode API has
> always worked on available nodes, apart unavailable ACPI child device
> nodes could have been returned by fwnode_get_next_child_node().
>
> Now that the availability check has been added to ACPI side as well,
> document that the functions in the fwnode API return available nodes.
>
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> ---
> drivers/base/property.c | 12 ++++++------
> 1 file changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/drivers/base/property.c b/drivers/base/property.c
> index 4bd64e729431..ff440456af7b 100644
> --- a/drivers/base/property.c
> +++ b/drivers/base/property.c
> @@ -785,7 +785,7 @@ struct fwnode_handle *fwnode_get_nth_parent(struct fwnode_handle *fwnode,
> EXPORT_SYMBOL_GPL(fwnode_get_nth_parent);
>
> /**
> - * fwnode_get_next_child_node - Return the next child node handle for a node
> + * fwnode_get_next_child_node - Return the next available child node handle
> * @fwnode: Firmware node to find the next child node for.
> * @child: Handle to one of the node's child nodes or a %NULL handle.
> *
> @@ -830,7 +830,7 @@ fwnode_get_next_available_child_node(const struct fwnode_handle *fwnode,
> EXPORT_SYMBOL_GPL(fwnode_get_next_available_child_node);
>
> /**
> - * device_get_next_child_node - Return the next child node handle for a device
> + * device_get_next_child_node - Return the next available child node handle for a device

You may want to drop "for a device" at the end of the line, it seems
you've made that change in 15/16 instead of here.

Reviewed-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>

> * @dev: Device to find the next child node for.
> * @child: Handle to one of the device's child nodes or a %NULL handle.
> *
> @@ -858,7 +858,7 @@ struct fwnode_handle *device_get_next_child_node(const struct device *dev,
> EXPORT_SYMBOL_GPL(device_get_next_child_node);
>
> /**
> - * fwnode_get_named_child_node - Return first matching named child node handle
> + * fwnode_get_named_child_node - Return first available matching named child node handle
> * @fwnode: Firmware node to find the named child node for.
> * @childname: String to match child node name against.
> *
> @@ -874,7 +874,7 @@ fwnode_get_named_child_node(const struct fwnode_handle *fwnode,
> EXPORT_SYMBOL_GPL(fwnode_get_named_child_node);
>
> /**
> - * device_get_named_child_node - Return first matching named child node handle
> + * device_get_named_child_node - Return first available matching named child node handle for a device
> * @dev: Device to find the named child node for.
> * @childname: String to match child node name against.
> *
> @@ -928,7 +928,7 @@ bool fwnode_device_is_available(const struct fwnode_handle *fwnode)
> EXPORT_SYMBOL_GPL(fwnode_device_is_available);
>
> /**
> - * fwnode_get_child_node_count - return the number of child nodes for a given firmware node
> + * fwnode_get_child_node_count - Return the number of available child nodes for a given firmware node
> * @fwnode: Pointer to the parent firmware node
> *
> * Return: the number of child nodes for a given firmware node.
> @@ -946,7 +946,7 @@ unsigned int fwnode_get_child_node_count(const struct fwnode_handle *fwnode)
> EXPORT_SYMBOL_GPL(fwnode_get_child_node_count);
>
> /**
> - * fwnode_get_named_child_node_count - number of child nodes with given name
> + * fwnode_get_named_child_node_count - Return the number of available child nodes with given name
> * @fwnode: Node which child nodes are counted.
> * @name: String to match child node name against.
> *

--
Regards,

Laurent Pinchart