Re: [PATCH v2 2/2] rust: Add read_poll_count_atomic function

[Andreas Hindborg <a.hindborg@kernel.org>]

"Alice Ryhl" <aliceryhl@google.com> writes:

> On Tue, Oct 21, 2025 at 02:35:34PM +0200, Danilo Krummrich wrote:
>> On Tue Oct 21, 2025 at 9:11 AM CEST, FUJITA Tomonori wrote:
>> > +/// Polls periodically until a condition is met, an error occurs,
>> > +/// or the attempt limit is reached.
>> > +///
>> > +/// The function repeatedly executes the given operation `op` closure and
>> > +/// checks its result using the condition closure `cond`.
>> > +///
>> > +/// If `cond` returns `true`, the function returns successfully with the result of `op`.
>> > +/// Otherwise, it performs a busy wait for a duration specified by `delay_delta`
>> > +/// before executing `op` again.
>> > +///
>> > +/// This process continues until either `op` returns an error, `cond`
>> > +/// returns `true`, or the attempt limit specified by `count` is reached.
>> > +///
>> > +/// # Errors
>> > +///
>> > +/// If `op` returns an error, then that error is returned directly.
>> > +///
>> > +/// If the attempt limit specified by `count` is reached, then
>> > +/// `Err(ETIMEDOUT)` is returned.
>> > +///
>> > +/// # Examples
>> > +///
>> > +/// ```no_run
>> > +/// use kernel::io::{Io, poll::read_poll_count_atomic};
>> > +/// use kernel::time::Delta;
>> > +///
>> > +/// const HW_READY: u16 = 0x01;
>> > +///
>> > +/// fn wait_for_hardware<const SIZE: usize>(io: &Io<SIZE>) -> Result {
>> > +///     match read_poll_count_atomic(
>> > +///         // The `op` closure reads the value of a specific status register.
>> > +///         || io.try_read16(0x1000),
>> > +///         // The `cond` closure takes a reference to the value returned by `op`
>> > +///         // and checks whether the hardware is ready.
>> > +///         |val: &u16| *val == HW_READY,
>> > +///         Delta::from_micros(50),
>> > +///         1000,
>> > +///     ) {
>> > +///         Ok(_) => {
>> > +///             // The hardware is ready. The returned value of the `op` closure
>> > +///             // isn't used.
>> > +///             Ok(())
>> > +///         }
>> > +///         Err(e) => Err(e),
>> > +///     }
>>
>> Please replace the match statement with map().
>>
>> 	read_poll_count_atomic(
>> 	    ...
>> 	)
>> 	.map(|_| ())
>>
>
> IMO, this should instead be:
>
> 	read_poll_count_atomic(
> 	    ...
> 	)?
> 	Ok(())

It does not really matter to me. Why do you prefer one to the other?


Best regards,
Andreas Hindborg