clk: imx: pllv1: fix kernel-doc notation for struct clk_pllv1
Subsystems (3)
PATCH 1/1 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 2af9e6db14db ("ARM i.MX: Add common clock support for pllv1")
Fixes a594790368a8 ("ARM: imx: pllv1: Fix PLL calculation for i.MX27")
Signed-off-by Randy Dunlap <[email protected]>
Reported-by kernel test robot <[email protected]>
Cc Abel Vesa <[email protected]>
Cc Alexander Shiyan <[email protected]>
Cc Shawn Guo <[email protected]>
Cc Sascha Hauer <[email protected]>
--- drivers/clk/imx/clk-pllv1.c | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-)
drivers/clk/imx/clk-pllv1.c +8 -9
@@ -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;
Quoting Randy Dunlap (2021-11-14 19:26:07)
Quoted 18 lines
Convert struct
clk_pllv1comments 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. ReferDocumentation/doc-guide/kernel-doc.rst
* pll v1Fixes 2af9e6db14db ("ARM i.MX: Add common clock support for pllv1")Fixes a594790368a8 ("ARM: imx: pllv1: Fix PLL calculation for i.MX27")Signed-off-by Randy Dunlap <[email protected]>Reported-by kernel test robot <[email protected]>Cc Abel Vesa <[email protected]>Cc Alexander Shiyan <[email protected]>Cc Shawn Guo <[email protected]>Cc Sascha Hauer <[email protected]>
Quoted 1 line
---
Applied to clk-next