[PATCH 1/2] of: property: add missing kerneldoc for of_graph_get_endpoint_count()

[PATCH 1/2] of: property: add missing kerneldoc for of_graph_get_endpoint_count()

[Kuninori Morimoto]

of_graph_get_endpoint_count() doesn't have kerneldoc. Add it.

Signed-off-by: Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
---
 drivers/of/property.c | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/drivers/of/property.c b/drivers/of/property.c
index afdaefbd03f6..4e879faa1710 100644
--- a/drivers/of/property.c
+++ b/drivers/of/property.c
@@ -811,6 +811,12 @@ struct device_node *of_graph_get_remote_port(const struct device_node *node)
 }
 EXPORT_SYMBOL(of_graph_get_remote_port);
 
+/**
+ * of_graph_get_endpoint_count() - get count of endpoint
+ * @np: pointer to the parent device node
+ *
+ * Return: count of endpoint of this device node
+ */
 int of_graph_get_endpoint_count(const struct device_node *np)
 {
 	struct device_node *endpoint;
-- 
2.25.1

Re: [PATCH 1/2] of: property: add missing kerneldoc for of_graph_get_endpoint_count()

[Laurent Pinchart]

Hello Morimoto-san,

Thank you for the patch.

On Fri, Feb 02, 2024 at 06:10:08AM +0000, Kuninori Morimoto wrote:
> of_graph_get_endpoint_count() doesn't have kerneldoc. Add it.
> 
> Signed-off-by: Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
> ---
>  drivers/of/property.c | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/drivers/of/property.c b/drivers/of/property.c
> index afdaefbd03f6..4e879faa1710 100644
> --- a/drivers/of/property.c
> +++ b/drivers/of/property.c
> @@ -811,6 +811,12 @@ struct device_node *of_graph_get_remote_port(const struct device_node *node)
>  }
>  EXPORT_SYMBOL(of_graph_get_remote_port);
>  
> +/**
> + * of_graph_get_endpoint_count() - get count of endpoint

s/endpoint/endpoints/

or, possibly better,

 * of_graph_get_endpoint_count() - get the number of endpoints in a device node

> + * @np: pointer to the parent device node

Let's use the same parameter description as for the
for_each_endpoint_of_node() macro, for consistency:

 * @parent: parent device node containing ports and endpoints

With these small changes,

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

> + *
> + * Return: count of endpoint of this device node
> + */
>  int of_graph_get_endpoint_count(const struct device_node *np)
>  {
>  	struct device_node *endpoint;

-- 
Regards,

Laurent Pinchart

Re: [PATCH 1/2] of: property: add missing kerneldoc for of_graph_get_endpoint_count()

[Kuninori Morimoto]

Hi Laurent

Thank you for your review

> s/endpoint/endpoints/
> 
> or, possibly better,
> 
>  * of_graph_get_endpoint_count() - get the number of endpoints in a device node
> 
> > + * @np: pointer to the parent device node
> 
> Let's use the same parameter description as for the
> for_each_endpoint_of_node() macro, for consistency:
> 
>  * @parent: parent device node containing ports and endpoints

Thanks.
Will update on v2 and it will have your Reviewed-by


Thank you for your help !!

Best regards
---
Renesas Electronics
Ph.D. Kuninori Morimoto