diff mbox series

ARM: OMAP: timer32K: fix all kernel-doc warnings

Message ID 20231007001603.24972-1-rdunlap@infradead.org
State New
Headers
Series ARM: OMAP: timer32K: fix all kernel-doc warnings |

Commit Message

Randy Dunlap Oct. 7, 2023, 12:16 a.m. UTC 
  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 <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/all/202310070106.8QSyJOm3-lkp@intel.com/
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: Vaibhav Hiremath <hvaibhav@ti.com>
Cc: Felipe Balbi <balbi@ti.com>
Cc: Tony Lindgren <tony@atomide.com>
Cc: Xunlei Pang <pang.xunlei@linaro.org>
Cc: John Stultz <john.stultz@linaro.org>
Cc: Ingo Molnar <mingo@kernel.org>
Cc: Aaro Koskinen <aaro.koskinen@iki.fi>
Cc: Janusz Krzysztofik <jmkrzyszt@gmail.com>
Cc: linux-omap@vger.kernel.org
Cc: linux-arm-kernel@lists.infradead.org
---
 arch/arm/mach-omap1/timer32k.c |   14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

Comments

Tony Lindgren Oct. 7, 2023, 7:44 a.m. UTC | #1 
* Randy Dunlap <rdunlap@infradead.org> [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
diff mbox series

Patch

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)