Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: Randy 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: Andre Przywara <andre.przywara@arm.com>
Acked-by: Jernej Skrabec <jernej.skrabec@gmail.com>
Link: https://lore.kernel.org/r/20240121051837.17564-1-rdunlap@infradead.org
Signed-off-by: Jernej Skrabec <jernej.skrabec@gmail.com>

authored by

Randy Dunlap and committed by
Jernej Skrabec
233d3311 6613476e

+11 -10
+11 -10
drivers/clk/sunxi/clk-a20-gmac.c
··· 15 15 16 16 static DEFINE_SPINLOCK(gmac_lock); 17 17 18 + 19 + #define SUN7I_A20_GMAC_GPIT 2 20 + #define SUN7I_A20_GMAC_MASK 0x3 21 + #define SUN7I_A20_GMAC_PARENTS 2 22 + 23 + static u32 sun7i_a20_gmac_mux_table[SUN7I_A20_GMAC_PARENTS] = { 24 + 0x00, /* Select mii_phy_tx_clk */ 25 + 0x02, /* Select gmac_int_tx_clk */ 26 + }; 27 + 18 28 /** 19 29 * sun7i_a20_gmac_clk_setup - Setup function for A20/A31 GMAC clock module 30 + * @node: &struct device_node for the clock 20 31 * 21 32 * This clock looks something like this 22 33 * ________________________ ··· 50 39 * enable/disable this clock to configure the required state. The clock 51 40 * driver then responds by auto-reparenting the clock. 52 41 */ 53 - 54 - #define SUN7I_A20_GMAC_GPIT 2 55 - #define SUN7I_A20_GMAC_MASK 0x3 56 - #define SUN7I_A20_GMAC_PARENTS 2 57 - 58 - static u32 sun7i_a20_gmac_mux_table[SUN7I_A20_GMAC_PARENTS] = { 59 - 0x00, /* Select mii_phy_tx_clk */ 60 - 0x02, /* Select gmac_int_tx_clk */ 61 - }; 62 - 63 42 static void __init sun7i_a20_gmac_clk_setup(struct device_node *node) 64 43 { 65 44 struct clk *clk;