Re: [PATCH] clk: sunxi: a20-gmac: fix kernel-doc warnings

[Andre Przywara]

On Sat, 20 Jan 2024 21:18:35 -0800
Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:

> Move the function kernel-doc comment to be immediately before the
> function implementation, then add a function parameter description
> to prevent kernel-doc warnings:
> 
> clk-a20-gmac.c:43: warning: expecting prototype for sun7i_a20_gmac_clk_setup(). Prototype was for SUN7I_A20_GMAC_GPIT() instead
> clk-a20-gmac.c:53: warning: Function parameter or struct member 'node' not described in 'sun7i_a20_gmac_clk_setup'

Confirmed to be just the move, plus the added parameter description.

Reviewed-by: Andre Przywara <andre.przywara@xxxxxxx>

Cheers,
Andre
 
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Cc: Emilio López <emilio@xxxxxxxxxxxxx>
> Cc: Michael Turquette <mturquette@xxxxxxxxxxxx>
> Cc: Stephen Boyd <sboyd@xxxxxxxxxx>
> Cc: linux-clk@xxxxxxxxxxxxxxx
> Cc: Chen-Yu Tsai <wens@xxxxxxxx>
> Cc: Jernej Skrabec <jernej.skrabec@xxxxxxxxx>
> Cc: Samuel Holland <samuel@xxxxxxxxxxxx>
> Cc: linux-arm-kernel@xxxxxxxxxxxxxxxxxxx
> Cc: linux-sunxi@xxxxxxxxxxxxxxx
> ---
>  drivers/clk/sunxi/clk-a20-gmac.c |   21 +++++++++++----------
>  1 file changed, 11 insertions(+), 10 deletions(-)
> 
> diff -- a/drivers/clk/sunxi/clk-a20-gmac.c b/drivers/clk/sunxi/clk-a20-gmac.c
> --- a/drivers/clk/sunxi/clk-a20-gmac.c
> +++ b/drivers/clk/sunxi/clk-a20-gmac.c
> @@ -15,8 +15,19 @@
>  
>  static DEFINE_SPINLOCK(gmac_lock);
>  
> +
> +#define SUN7I_A20_GMAC_GPIT	2
> +#define SUN7I_A20_GMAC_MASK	0x3
> +#define SUN7I_A20_GMAC_PARENTS	2
> +
> +static u32 sun7i_a20_gmac_mux_table[SUN7I_A20_GMAC_PARENTS] = {
> +	0x00, /* Select mii_phy_tx_clk */
> +	0x02, /* Select gmac_int_tx_clk */
> +};
> +
>  /**
>   * sun7i_a20_gmac_clk_setup - Setup function for A20/A31 GMAC clock module
> + * @node: &struct device_node for the clock
>   *
>   * This clock looks something like this
>   *                               ________________________
> @@ -39,16 +50,6 @@ static DEFINE_SPINLOCK(gmac_lock);
>   * enable/disable this clock to configure the required state. The clock
>   * driver then responds by auto-reparenting the clock.
>   */
> -
> -#define SUN7I_A20_GMAC_GPIT	2
> -#define SUN7I_A20_GMAC_MASK	0x3
> -#define SUN7I_A20_GMAC_PARENTS	2
> -
> -static u32 sun7i_a20_gmac_mux_table[SUN7I_A20_GMAC_PARENTS] = {
> -	0x00, /* Select mii_phy_tx_clk */
> -	0x02, /* Select gmac_int_tx_clk */
> -};
> -
>  static void __init sun7i_a20_gmac_clk_setup(struct device_node *node)
>  {
>  	struct clk *clk;
>