Skip to content

Commit 7eeca8c

Browse files
rddunlaptmlind
authored andcommitted
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: a451570 ("ARM: OMAP: 32k counter: Provide y2038-safe omap_read_persistent_clock() replacement") Fixes: 1fe97c8 ("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>
1 parent 46e6175 commit 7eeca8c

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

arch/arm/mach-omap1/timer32k.c

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -176,17 +176,18 @@ static u64 notrace omap_32k_read_sched_clock(void)
176176
return sync32k_cnt_reg ? readl_relaxed(sync32k_cnt_reg) : 0;
177177
}
178178

179+
static struct timespec64 persistent_ts;
180+
static cycles_t cycles;
181+
static unsigned int persistent_mult, persistent_shift;
182+
179183
/**
180184
* omap_read_persistent_clock64 - Return time from a persistent clock.
185+
* @ts: &struct timespec64 for the returned time
181186
*
182187
* Reads the time from a source which isn't disabled during PM, the
183188
* 32k sync timer. Convert the cycles elapsed since last read into
184189
* nsecs and adds to a monotonically increasing timespec64.
185190
*/
186-
static struct timespec64 persistent_ts;
187-
static cycles_t cycles;
188-
static unsigned int persistent_mult, persistent_shift;
189-
190191
static void omap_read_persistent_clock64(struct timespec64 *ts)
191192
{
192193
unsigned long long nsecs;
@@ -206,10 +207,9 @@ static void omap_read_persistent_clock64(struct timespec64 *ts)
206207
/**
207208
* omap_init_clocksource_32k - setup and register counter 32k as a
208209
* kernel clocksource
209-
* @pbase: base addr of counter_32k module
210-
* @size: size of counter_32k to map
210+
* @vbase: base addr of counter_32k module
211211
*
212-
* Returns 0 upon success or negative error code upon failure.
212+
* Returns: %0 upon success or negative error code upon failure.
213213
*
214214
*/
215215
static int __init omap_init_clocksource_32k(void __iomem *vbase)

0 commit comments

Comments
 (0)