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

Configure Feed

Select the types of activity you want to include in your feed.

iopoll: fix function parameter names in read_poll_timeout_atomic()

Correct the function parameter names to avoid kernel-doc warnings
and to emphasize this function is atomic (non-sleeping).

Warning: include/linux/iopoll.h:169 function parameter 'sleep_us' not
described in 'read_poll_timeout_atomic'
Warning: ../include/linux/iopoll.h:169 function parameter
'sleep_before_read' not described in 'read_poll_timeout_atomic'

Fixes: 9df8043a546d ("iopoll: Generalize read_poll_timeout() into poll_timeout_us()")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Jani Nikula <jani.nikula@intel.com>
Link: https://patch.msgid.link/20260306221033.2357305-1-rdunlap@infradead.org
Signed-off-by: Jani Nikula <jani.nikula@intel.com>

authored by

Randy Dunlap and committed by
Jani Nikula 878004e2 340db7c4

+4 -4
+4 -4
include/linux/iopoll.h
··· 159 159 * 160 160 * This macro does not rely on timekeeping. Hence it is safe to call even when 161 161 * timekeeping is suspended, at the expense of an underestimation of wall clock 162 - * time, which is rather minimal with a non-zero delay_us. 162 + * time, which is rather minimal with a non-zero @delay_us. 163 163 * 164 164 * When available, you'll probably want to use one of the specialized 165 165 * macros defined below rather than this macro directly. ··· 167 167 * Returns: 0 on success and -ETIMEDOUT upon a timeout. In either 168 168 * case, the last read value at @args is stored in @val. 169 169 */ 170 - #define read_poll_timeout_atomic(op, val, cond, sleep_us, timeout_us, \ 171 - sleep_before_read, args...) \ 172 - poll_timeout_us_atomic((val) = op(args), cond, sleep_us, timeout_us, sleep_before_read) 170 + #define read_poll_timeout_atomic(op, val, cond, delay_us, timeout_us, \ 171 + delay_before_read, args...) \ 172 + poll_timeout_us_atomic((val) = op(args), cond, delay_us, timeout_us, delay_before_read) 173 173 174 174 /** 175 175 * readx_poll_timeout - Periodically poll an address until a condition is met or a timeout occurs