clk: sunxi: usb: fix kernel-doc warnings

Commit Message

Randy Dunlap Jan. 21, 2024, 5:18 a.m. UTC

Move the function description comment to immediately above the
function implementation, the add function parameter descriptions to
prevent kernel-doc warnings:

clk-usb.c:80: warning: expecting prototype for sunxi_usb_clk_setup(). Prototype was for SUNXI_USB_MAX_SIZE() instead
clk-usb.c:91: warning: Function parameter or struct member 'node' not described in 'sunxi_usb_clk_setup'
clk-usb.c:91: warning: Function parameter or struct member 'data' not described in 'sunxi_usb_clk_setup'
clk-usb.c:91: warning: Function parameter or struct member 'lock' not described in 'sunxi_usb_clk_setup'

Signed-off-by: Randy Dunlap <[e-mail]>
Cc: Emilio López <[e-mail]>
Cc: Michael Turquette <[e-mail]>
Cc: Stephen Boyd <[e-mail]>
Cc: [e-mail]
Cc: Chen-Yu Tsai <[e-mail]>
Cc: Jernej Skrabec <[e-mail]>
Cc: Samuel Holland <[e-mail]>
Cc: [e-mail]
Cc: [e-mail]
---
 drivers/clk/sunxi/clk-usb.c |    9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

Comments

Andre Przywara Jan. 22, 2024, 10:45 a.m. UTC | #1

On Sat, 20 Jan 2024 21:18:57 -0800
Randy Dunlap <[e-mail]> wrote:

> Move the function description comment to immediately above the
> function implementation, the add function parameter descriptions to
> prevent kernel-doc warnings:
> 
> clk-usb.c:80: warning: expecting prototype for sunxi_usb_clk_setup(). Prototype was for SUNXI_USB_MAX_SIZE() instead
> clk-usb.c:91: warning: Function parameter or struct member 'node' not described in 'sunxi_usb_clk_setup'
> clk-usb.c:91: warning: Function parameter or struct member 'data' not described in 'sunxi_usb_clk_setup'
> clk-usb.c:91: warning: Function parameter or struct member 'lock' not described in 'sunxi_usb_clk_setup'

Reviewed-by: Andre Przywara <[e-mail]>

Cheers,
Andre

> Signed-off-by: Randy Dunlap <[e-mail]>
> Cc: Emilio López <[e-mail]>
> Cc: Michael Turquette <[e-mail]>
> Cc: Stephen Boyd <[e-mail]>
> Cc: [e-mail]
> Cc: Chen-Yu Tsai <[e-mail]>
> Cc: Jernej Skrabec <[e-mail]>
> Cc: Samuel Holland <[e-mail]>
> Cc: [e-mail]
> Cc: [e-mail]
> ---
>  drivers/clk/sunxi/clk-usb.c |    9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
> 
> diff -- a/drivers/clk/sunxi/clk-usb.c b/drivers/clk/sunxi/clk-usb.c
> --- a/drivers/clk/sunxi/clk-usb.c
> +++ b/drivers/clk/sunxi/clk-usb.c
> @@ -73,9 +73,6 @@ static const struct reset_control_ops su
>  	.deassert	= sunxi_usb_reset_deassert,
>  };
>  
> -/**
> - * sunxi_usb_clk_setup() - Setup function for usb gate clocks
> - */
>  
>  #define SUNXI_USB_MAX_SIZE 32
>  
> @@ -85,6 +82,12 @@ struct usb_clk_data {
>  	bool reset_needs_clk;
>  };
>  
> +/**
> + * sunxi_usb_clk_setup() - Setup function for usb gate clocks
> + * @node: &struct device_node for the clock
> + * @data: &struct usb_clk_data for the clock
> + * @lock: spinlock for the clock
> + */
>  static void __init sunxi_usb_clk_setup(struct device_node *node,
>  				       const struct usb_clk_data *data,
>  				       spinlock_t *lock)
>

Jernej Škrabec Jan. 23, 2024, 5:43 p.m. UTC | #2

Dne nedelja, 21. januar 2024 ob 06:18:57 CET je Randy Dunlap napisal(a):
> Move the function description comment to immediately above the
> function implementation, the add function parameter descriptions to
> prevent kernel-doc warnings:
> 
> clk-usb.c:80: warning: expecting prototype for sunxi_usb_clk_setup(). Prototype was for SUNXI_USB_MAX_SIZE() instead
> clk-usb.c:91: warning: Function parameter or struct member 'node' not described in 'sunxi_usb_clk_setup'
> clk-usb.c:91: warning: Function parameter or struct member 'data' not described in 'sunxi_usb_clk_setup'
> clk-usb.c:91: warning: Function parameter or struct member 'lock' not described in 'sunxi_usb_clk_setup'
> 
> Signed-off-by: Randy Dunlap <[e-mail]>
> Cc: Emilio López <[e-mail]>
> Cc: Michael Turquette <[e-mail]>
> Cc: Stephen Boyd <[e-mail]>
> Cc: [e-mail]
> Cc: Chen-Yu Tsai <[e-mail]>
> Cc: Jernej Skrabec <[e-mail]>
> Cc: Samuel Holland <[e-mail]>
> Cc: [e-mail]
> Cc: [e-mail]

Acked-by: Jernej Skrabec <[e-mail]>

Best regards,
Jernej

Jernej Škrabec Jan. 23, 2024, 8:57 p.m. UTC | #3

Dne nedelja, 21. januar 2024 ob 06:18:57 CET je Randy Dunlap napisal(a):
> Move the function description comment to immediately above the
> function implementation, the add function parameter descriptions to
> prevent kernel-doc warnings:
> 
> clk-usb.c:80: warning: expecting prototype for sunxi_usb_clk_setup(). Prototype was for SUNXI_USB_MAX_SIZE() instead
> clk-usb.c:91: warning: Function parameter or struct member 'node' not described in 'sunxi_usb_clk_setup'
> clk-usb.c:91: warning: Function parameter or struct member 'data' not described in 'sunxi_usb_clk_setup'
> clk-usb.c:91: warning: Function parameter or struct member 'lock' not described in 'sunxi_usb_clk_setup'
> 
> Signed-off-by: Randy Dunlap <[e-mail]>
> Cc: Emilio López <[e-mail]>
> Cc: Michael Turquette <[e-mail]>
> Cc: Stephen Boyd <[e-mail]>
> Cc: [e-mail]
> Cc: Chen-Yu Tsai <[e-mail]>
> Cc: Jernej Skrabec <[e-mail]>
> Cc: Samuel Holland <[e-mail]>
> Cc: [e-mail]
> Cc: [e-mail]

Merged, thanks!

Best regards,
Jernej

Patch

diff -- a/drivers/clk/sunxi/clk-usb.c b/drivers/clk/sunxi/clk-usb.c
--- a/drivers/clk/sunxi/clk-usb.c
+++ b/drivers/clk/sunxi/clk-usb.c
@@ -73,9 +73,6 @@  static const struct reset_control_ops su
 	.deassert	= sunxi_usb_reset_deassert,
 };
 
-/**
- * sunxi_usb_clk_setup() - Setup function for usb gate clocks
- */
 
 #define SUNXI_USB_MAX_SIZE 32
 
@@ -85,6 +82,12 @@  struct usb_clk_data {
 	bool reset_needs_clk;
 };
 
+/**
+ * sunxi_usb_clk_setup() - Setup function for usb gate clocks
+ * @node: &struct device_node for the clock
+ * @data: &struct usb_clk_data for the clock
+ * @lock: spinlock for the clock
+ */
 static void __init sunxi_usb_clk_setup(struct device_node *node,
 				       const struct usb_clk_data *data,
 				       spinlock_t *lock)