Commit 71e76231 authored Nov 14, 2021 by Randy Dunlap Committed by Stephen Boyd Dec 02, 2021

clk: imx: pllv1: fix kernel-doc notation for struct clk_pllv1



Convert struct clk_pllv1 comments to kernel-doc notation and move them
below the MFN_* macros.

Fixes this kernel-doc warning:

drivers/clk/imx/clk-pllv1.c:12: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * pll v1

Fixes: 2af9e6db ("ARM i.MX: Add common clock support for pllv1")
Fixes: a5947903 ("ARM: imx: pllv1: Fix PLL calculation for i.MX27")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Abel Vesa <abel.vesa@nxp.com>
Cc: linux-clk@vger.kernel.org
Cc: linux-imx@nxp.com
Cc: Alexander Shiyan <shc_work@mail.ru>
Cc: Shawn Guo <shawn.guo@linaro.org>
Cc: Sascha Hauer <s.hauer@pengutronix.de>
Link: https://lore.kernel.org/r/20211115032607.28970-1-rdunlap@infradead.org


Signed-off-by: Stephen Boyd <sboyd@kernel.org>

parent fa55b7dc

drivers/clk/imx/clk-pllv1.c

+8 −9

Original line number	Diff line number	Diff line
		@@ -8,20 +8,19 @@

		#include "clk.h"

		#define MFN_BITS (10)
		#define MFN_SIGN (BIT(MFN_BITS - 1))
		#define MFN_MASK (MFN_SIGN - 1)

		/**
		* pll v1
		* struct clk_pllv1 - IMX PLLv1 clock descriptor
		*
		* @clk_hw clock source
		* @parent the parent clock name
		* @base base address of pll registers
		* @hw: clock source
		* @base: base address of pll registers
		* @type: type of IMX_PLLV1
		*
		* PLL clock version 1, found on i.MX1/21/25/27/31/35
		*/

		#define MFN_BITS (10)
		#define MFN_SIGN (BIT(MFN_BITS - 1))
		#define MFN_MASK (MFN_SIGN - 1)

		struct clk_pllv1 {
		struct clk_hw hw;
		void __iomem *base;