Skip to content

Commit 3149c4f

Browse files
rddunlapgregkh
authored andcommitted
iopoll: fix function parameter names in read_poll_timeout_atomic()
[ Upstream commit 878004e ] 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: 9df8043 ("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> Signed-off-by: Sasha Levin <sashal@kernel.org>
1 parent b455903 commit 3149c4f

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

include/linux/iopoll.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -159,17 +159,17 @@
159159
*
160160
* This macro does not rely on timekeeping. Hence it is safe to call even when
161161
* 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.
163163
*
164164
* When available, you'll probably want to use one of the specialized
165165
* macros defined below rather than this macro directly.
166166
*
167167
* Returns: 0 on success and -ETIMEDOUT upon a timeout. In either
168168
* case, the last read value at @args is stored in @val.
169169
*/
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)
173173

174174
/**
175175
* readx_poll_timeout - Periodically poll an address until a condition is met or a timeout occurs

0 commit comments

Comments
 (0)