Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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 <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
Message-ID: <20231007001603.24972-1-rdunlap@infradead.org>
Signed-off-by: Tony Lindgren <tony@atomide.com>

authored by

Randy Dunlap and committed by
Tony Lindgren
7eeca8cc 46e61750

+7 -7
+7 -7
arch/arm/mach-omap1/timer32k.c
··· 176 176 return sync32k_cnt_reg ? readl_relaxed(sync32k_cnt_reg) : 0; 177 177 } 178 178 179 + static struct timespec64 persistent_ts; 180 + static cycles_t cycles; 181 + static unsigned int persistent_mult, persistent_shift; 182 + 179 183 /** 180 184 * omap_read_persistent_clock64 - Return time from a persistent clock. 185 + * @ts: &struct timespec64 for the returned time 181 186 * 182 187 * Reads the time from a source which isn't disabled during PM, the 183 188 * 32k sync timer. Convert the cycles elapsed since last read into 184 189 * nsecs and adds to a monotonically increasing timespec64. 185 190 */ 186 - static struct timespec64 persistent_ts; 187 - static cycles_t cycles; 188 - static unsigned int persistent_mult, persistent_shift; 189 - 190 191 static void omap_read_persistent_clock64(struct timespec64 *ts) 191 192 { 192 193 unsigned long long nsecs; ··· 207 206 /** 208 207 * omap_init_clocksource_32k - setup and register counter 32k as a 209 208 * kernel clocksource 210 - * @pbase: base addr of counter_32k module 211 - * @size: size of counter_32k to map 209 + * @vbase: base addr of counter_32k module 212 210 * 213 - * Returns 0 upon success or negative error code upon failure. 211 + * Returns: %0 upon success or negative error code upon failure. 214 212 * 215 213 */ 216 214 static int __init omap_init_clocksource_32k(void __iomem *vbase)