Commit 233d3311 authored by Randy Dunlap's avatar Randy Dunlap Committed by Jernej Skrabec
Browse files

clk: sunxi: a20-gmac: fix kernel-doc warnings 



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'

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Cc: Emilio López <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>
Reviewed-by: default avatarAndre Przywara <andre.przywara@arm.com>
Acked-by: default avatarJernej Skrabec <jernej.skrabec@gmail.com>
Link: https://lore.kernel.org/r/20240121051837.17564-1-rdunlap@infradead.org


Signed-off-by: default avatarJernej Skrabec <jernej.skrabec@gmail.com>
parent 6613476e

drivers/clk/sunxi/clk-a20-gmac.c

+11 −10
Original line number Diff line number Diff line
@@ -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;