On Fri, 06 Mar 2026, Randy Dunlap <[email protected]> wrote: > 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 <[email protected]>
Reviewed-by: Jani Nikula <[email protected]> Please let me know how you want this merged. I don't think iopoll.h has an active maintainer. > --- > v2: change the function parameter names, not the kernel-doc comments (Jani) > > include/linux/iopoll.h | 8 ++++---- > 1 file changed, 4 insertions(+), 4 deletions(-) > > --- linux-next-20260304.orig/include/linux/iopoll.h > +++ linux-next-20260304/include/linux/iopoll.h > @@ -159,7 +159,7 @@ > * > * This macro does not rely on timekeeping. Hence it is safe to call even > when > * timekeeping is suspended, at the expense of an underestimation of wall > clock > - * time, which is rather minimal with a non-zero delay_us. > + * time, which is rather minimal with a non-zero @delay_us. > * > * When available, you'll probably want to use one of the specialized > * macros defined below rather than this macro directly. > @@ -167,9 +167,9 @@ > * Returns: 0 on success and -ETIMEDOUT upon a timeout. In either > * case, the last read value at @args is stored in @val. > */ > -#define read_poll_timeout_atomic(op, val, cond, sleep_us, timeout_us, \ > - sleep_before_read, args...) \ > - poll_timeout_us_atomic((val) = op(args), cond, sleep_us, timeout_us, > sleep_before_read) > +#define read_poll_timeout_atomic(op, val, cond, delay_us, timeout_us, \ > + delay_before_read, args...) \ > + poll_timeout_us_atomic((val) = op(args), cond, delay_us, timeout_us, > delay_before_read) > > /** > * readx_poll_timeout - Periodically poll an address until a condition is > met or a timeout occurs > > > --- > Cc: Ville Syrjälä <[email protected]> > Cc: Jani Nikula <[email protected]> > Cc: [email protected] > Cc: [email protected] > Cc: [email protected] -- Jani Nikula, Intel
