2023-10-07 00:28:52

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] ARM: OMAP: timer32K: fix all kernel-doc warnings

Fix kernel-doc warnings reported by the kernel test robot:

timer32k.c:186: warning: cannot understand function prototype: 'struct timespec64 persistent_ts; '
timer32k.c:191: warning: Function parameter or member 'ts' not described in 'omap_read_persistent_clock64'
timer32k.c:216: warning: Function parameter or member 'vbase' not described in 'omap_init_clocksource_32k'
timer32k.c:216: warning: Excess function parameter 'pbase' description in 'omap_init_clocksource_32k'
timer32k.c:216: warning: Excess function parameter 'size' description in 'omap_init_clocksource_32k'
timer32k.c:216: warning: No description found for return value of 'omap_init_clocksource_32k'

Fixes: a451570c008b ("ARM: OMAP: 32k counter: Provide y2038-safe omap_read_persistent_clock() replacement")
Fixes: 1fe97c8f6a1d ("ARM: OMAP: Make OMAP clocksource source selection using kernel param")
Signed-off-by: Randy Dunlap <[email protected]>
Reported-by: kernel test robot <[email protected]>
Closes: https://lore.kernel.org/all/[email protected]/
Cc: Arnd Bergmann <[email protected]>
Cc: Vaibhav Hiremath <[email protected]>
Cc: Felipe Balbi <[email protected]>
Cc: Tony Lindgren <[email protected]>
Cc: Xunlei Pang <[email protected]>
Cc: John Stultz <[email protected]>
Cc: Ingo Molnar <[email protected]>
Cc: Aaro Koskinen <[email protected]>
Cc: Janusz Krzysztofik <[email protected]>
Cc: [email protected]
Cc: [email protected]
---
arch/arm/mach-omap1/timer32k.c | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)

diff -- a/arch/arm/mach-omap1/timer32k.c b/arch/arm/mach-omap1/timer32k.c
--- a/arch/arm/mach-omap1/timer32k.c
+++ b/arch/arm/mach-omap1/timer32k.c
@@ -176,17 +176,18 @@ static u64 notrace omap_32k_read_sched_c
return sync32k_cnt_reg ? readl_relaxed(sync32k_cnt_reg) : 0;
}

+static struct timespec64 persistent_ts;
+static cycles_t cycles;
+static unsigned int persistent_mult, persistent_shift;
+
/**
* omap_read_persistent_clock64 - Return time from a persistent clock.
+ * @ts: &struct timespec64 for the returned time
*
* Reads the time from a source which isn't disabled during PM, the
* 32k sync timer. Convert the cycles elapsed since last read into
* nsecs and adds to a monotonically increasing timespec64.
*/
-static struct timespec64 persistent_ts;
-static cycles_t cycles;
-static unsigned int persistent_mult, persistent_shift;
-
static void omap_read_persistent_clock64(struct timespec64 *ts)
{
unsigned long long nsecs;
@@ -206,10 +207,9 @@ static void omap_read_persistent_clock64
/**
* omap_init_clocksource_32k - setup and register counter 32k as a
* kernel clocksource
- * @pbase: base addr of counter_32k module
- * @size: size of counter_32k to map
+ * @vbase: base addr of counter_32k module
*
- * Returns 0 upon success or negative error code upon failure.
+ * Returns: %0 upon success or negative error code upon failure.
*
*/
static int __init omap_init_clocksource_32k(void __iomem *vbase)


2023-10-07 07:44:20

by Tony Lindgren

[permalink] [raw]
Subject: Re: [PATCH] ARM: OMAP: timer32K: fix all kernel-doc warnings

* Randy Dunlap <[email protected]> [231007 03:16]:
> Fix kernel-doc warnings reported by the kernel test robot:
>
> timer32k.c:186: warning: cannot understand function prototype: 'struct timespec64 persistent_ts; '
> timer32k.c:191: warning: Function parameter or member 'ts' not described in 'omap_read_persistent_clock64'
> timer32k.c:216: warning: Function parameter or member 'vbase' not described in 'omap_init_clocksource_32k'
> timer32k.c:216: warning: Excess function parameter 'pbase' description in 'omap_init_clocksource_32k'
> timer32k.c:216: warning: Excess function parameter 'size' description in 'omap_init_clocksource_32k'
> timer32k.c:216: warning: No description found for return value of 'omap_init_clocksource_32k'

Thanks applying into fixes.

Tony