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>
---
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ä <ville.syrjala@linux.intel.com>
Cc: Jani Nikula <jani.nikula@intel.com>
Cc: intel-gfx@lists.freedesktop.org
Cc: intel-xe@lists.freedesktop.org
Cc: dri-devel@lists.freedesktop.org

On Fri, 06 Mar 2026, Randy Dunlap <rdunlap@infradead.org> 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 <rdunlap@infradead.org>

Reviewed-by: Jani Nikula <jani.nikula@intel.com>

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ä <ville.syrjala@linux.intel.com>
> Cc: Jani Nikula <jani.nikula@intel.com>
> Cc: intel-gfx@lists.freedesktop.org
> Cc: intel-xe@lists.freedesktop.org
> Cc: dri-devel@lists.freedesktop.org

-- 
Jani Nikula, Intel

On 3/9/26 3:35 AM, Jani Nikula wrote:
> On Fri, 06 Mar 2026, Randy Dunlap <rdunlap@infradead.org> 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 <rdunlap@infradead.org>
> 
> Reviewed-by: Jani Nikula <jani.nikula@intel.com>
> 
> Please let me know how you want this merged. I don't think iopoll.h has
> an active maintainer.

Right, that's why I Cc-ed you :)
And since Fixes: points to you and others.
Please take it, Jani.

>> ---
>> 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ä <ville.syrjala@linux.intel.com>
>> Cc: Jani Nikula <jani.nikula@intel.com>
>> Cc: intel-gfx@lists.freedesktop.org
>> Cc: intel-xe@lists.freedesktop.org
>> Cc: dri-devel@lists.freedesktop.org
> 

-- 
~Randy

On Mon, 09 Mar 2026, Randy Dunlap <rdunlap@infradead.org> wrote:
> On 3/9/26 3:35 AM, Jani Nikula wrote:
>> On Fri, 06 Mar 2026, Randy Dunlap <rdunlap@infradead.org> 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 <rdunlap@infradead.org>
>> 
>> Reviewed-by: Jani Nikula <jani.nikula@intel.com>
>> 
>> Please let me know how you want this merged. I don't think iopoll.h has
>> an active maintainer.
>
> Right, that's why I Cc-ed you :)
> And since Fixes: points to you and others.
> Please take it, Jani.

Thanks for the fix, pushed to drm-intel-next.

BR,
Jani.

-- 
Jani Nikula, Intel