* [PATCH] clk: imx: pllv1: fix kernel-doc notation for struct clk_pllv1
@ 2021-11-15 3:26 Randy Dunlap
2021-12-03 1:26 ` Stephen Boyd
0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2021-11-15 3:26 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, kernel test robot, Abel Vesa, linux-clk, linux-imx,
Alexander Shiyan, Shawn Guo, Sascha Hauer
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 <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>
---
drivers/clk/imx/clk-pllv1.c | 17 ++++++++---------
1 file changed, 8 insertions(+), 9 deletions(-)
--- linux-next-20211102.orig/drivers/clk/imx/clk-pllv1.c
+++ linux-next-20211102/drivers/clk/imx/clk-pllv1.c
@@ -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;
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [PATCH] clk: imx: pllv1: fix kernel-doc notation for struct clk_pllv1
2021-11-15 3:26 [PATCH] clk: imx: pllv1: fix kernel-doc notation for struct clk_pllv1 Randy Dunlap
@ 2021-12-03 1:26 ` Stephen Boyd
0 siblings, 0 replies; 2+ messages in thread
From: Stephen Boyd @ 2021-12-03 1:26 UTC (permalink / raw)
To: Randy Dunlap, linux-kernel
Cc: Randy Dunlap, kernel test robot, Abel Vesa, linux-clk, linux-imx,
Alexander Shiyan, Shawn Guo, Sascha Hauer
Quoting Randy Dunlap (2021-11-14 19:26:07)
> 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 <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>
> ---
Applied to clk-next
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-12-03 1:27 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-11-15 3:26 [PATCH] clk: imx: pllv1: fix kernel-doc notation for struct clk_pllv1 Randy Dunlap
2021-12-03 1:26 ` Stephen Boyd
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).