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

clk: sunxi: sun9i-cpus: fix kernel-doc warnings 



Move the function description kernel-doc comment to immediately above
the function implementation, correct the function name in the comment,
then add a function parameter description to prevent these kernel-doc
warnings:

drivers/clk/sunxi/clk-sun9i-cpus.c:25: warning: expecting prototype for sun9i_a80_cpus_clk_setup(). Prototype was for SUN9I_CPUS_MAX_PARENTS() instead
clk-sun9i-cpus.c:184: warning: Function parameter or struct member 'node' not described in 'sun9i_a80_cpus_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/20240121051845.17603-1-rdunlap@infradead.org


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

drivers/clk/sunxi/clk-sun9i-cpus.c

+4 −3
Original line number Diff line number Diff line
@@ -18,9 +18,6 @@ 


static DEFINE_SPINLOCK(sun9i_a80_cpus_lock);



/**

 * sun9i_a80_cpus_clk_setup() - Setup function for a80 cpus composite clk

 */



#define SUN9I_CPUS_MAX_PARENTS		4

#define SUN9I_CPUS_MUX_PARENT_PLL4	3
@@ -180,6 +177,10 @@ static const struct clk_ops sun9i_a80_cpus_clk_ops = { 
	.set_rate	= sun9i_a80_cpus_clk_set_rate,

};



/**

 * sun9i_a80_cpus_setup() - Setup function for a80 cpus composite clk

 * @node: &struct device_node for the clock

 */

static void sun9i_a80_cpus_setup(struct device_node *node)

{

	const char *clk_name = node->name;