Received-SPF: pass (google.com: domain of linux-kernel+bounces-32777-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Date: Mon, 22 Jan 2024 10:44:52 +0000
From: Andre Przywara <andre.przywara@arm.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-kernel@vger.kernel.org, Emilio =?UTF-8?B?TMOzcGV6?=
 <emilio@elopez.com.ar>, Michael Turquette <mturquette@baylibre.com>,
 Stephen Boyd <sboyd@kernel.org>, linux-clk@vger.kernel.org, Chen-Yu Tsai
 <wens@csie.org>, Jernej Skrabec <jernej.skrabec@gmail.com>, Samuel Holland
 <samuel@sholland.org>, linux-arm-kernel@lists.infradead.org,
 linux-sunxi@lists.linux.dev
Subject: Re: [PATCH] clk: sunxi: a20-gmac: fix kernel-doc warnings
Message-ID: <20240122104452.2fc420ac@donnerap.manchester.arm.com>
In-Reply-To: <20240121051837.17564-1-rdunlap@infradead.org>
References: <20240121051837.17564-1-rdunlap@infradead.org>
Organization: ARM
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

On Sat, 20 Jan 2024 21:18:35 -0800
Randy Dunlap <rdunlap@infradead.org> 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:
>=20
> clk-a20-gmac.c:43: warning: expecting prototype for sun7i_a20_gmac_clk_se=
tup(). Prototype was for SUN7I_A20_GMAC_GPIT() instead
> clk-a20-gmac.c:53: warning: Function parameter or struct member 'node' no=
t described in 'sun7i_a20_gmac_clk_setup'

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

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

Cheers,
Andre
=20
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Emilio L=C3=B3pez <emilio@elopez.com.ar>
> Cc: Michael Turquette <mturquette@baylibre.com>
> Cc: Stephen Boyd <sboyd@kernel.org>
> Cc: linux-clk@vger.kernel.org
> Cc: Chen-Yu Tsai <wens@csie.org>
> Cc: Jernej Skrabec <jernej.skrabec@gmail.com>
> Cc: Samuel Holland <samuel@sholland.org>
> Cc: linux-arm-kernel@lists.infradead.org
> Cc: linux-sunxi@lists.linux.dev
> ---
>  drivers/clk/sunxi/clk-a20-gmac.c |   21 +++++++++++----------
>  1 file changed, 11 insertions(+), 10 deletions(-)
>=20
> diff -- a/drivers/clk/sunxi/clk-a20-gmac.c b/drivers/clk/sunxi/clk-a20-gm=
ac.c
> --- a/drivers/clk/sunxi/clk-a20-gmac.c
> +++ b/drivers/clk/sunxi/clk-a20-gmac.c
> @@ -15,8 +15,19 @@
> =20
>  static DEFINE_SPINLOCK(gmac_lock);
> =20
> +
> +#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] =3D {
> +	0x00, /* Select mii_phy_tx_clk */
> +	0x02, /* Select gmac_int_tx_clk */
> +};
> +
>  /**
>   * sun7i_a20_gmac_clk_setup - Setup function for A20/A31 GMAC clock modu=
le
> + * @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] =3D {
> -	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;
>=20