From: FUJITA Tomonori <fujita.tomonori@gmail.com>
To: dakr@kernel.org, aliceryhl@google.com,
daniel.almeida@collabora.com, a.hindborg@kernel.org,
alex.gaynor@gmail.com, ojeda@kernel.org
Cc: anna-maria@linutronix.de, bjorn3_gh@protonmail.com,
boqun.feng@gmail.com, frederic@kernel.org, gary@garyguo.net,
jstultz@google.com, linux-kernel@vger.kernel.org,
lossin@kernel.org, lyude@redhat.com,
rust-for-linux@vger.kernel.org, sboyd@kernel.org,
tglx@linutronix.de, tmgross@umich.edu
Subject: [PATCH v2 2/2] rust: Add read_poll_count_atomic function
Date: Tue, 21 Oct 2025 16:11:46 +0900 [thread overview]
Message-ID: <20251021071146.2357069-3-fujita.tomonori@gmail.com> (raw)
In-Reply-To: <20251021071146.2357069-1-fujita.tomonori@gmail.com>
Add read_poll_count_atomic function which polls periodically until a
condition is met, an error occurs, or the attempt limit is reached.
The C's read_poll_timeout_atomic() is used for the similar purpose.
In atomic context the timekeeping infrastructure is unavailable, so
reliable time-based timeouts cannot be implemented. So instead, the
helper accepts a maximum number of attempts and busy-waits (udelay +
cpu_relax) between tries.
Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com>
---
rust/kernel/io/poll.rs | 80 +++++++++++++++++++++++++++++++++++++++++-
1 file changed, 79 insertions(+), 1 deletion(-)
diff --git a/rust/kernel/io/poll.rs b/rust/kernel/io/poll.rs
index 613eb25047ef..c7dd0816205f 100644
--- a/rust/kernel/io/poll.rs
+++ b/rust/kernel/io/poll.rs
@@ -8,7 +8,10 @@
error::{code::*, Result},
processor::cpu_relax,
task::might_sleep,
- time::{delay::fsleep, Delta, Instant, Monotonic},
+ time::{
+ delay::{fsleep, udelay},
+ Delta, Instant, Monotonic,
+ },
};
/// Polls periodically until a condition is met, an error occurs,
@@ -102,3 +105,78 @@ pub fn read_poll_timeout<Op, Cond, T>(
cpu_relax();
}
}
+
+/// 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),
+/// }
+/// }
+/// ```
+pub fn read_poll_count_atomic<Op, Cond, T>(
+ mut op: Op,
+ mut cond: Cond,
+ delay_delta: Delta,
+ count: usize,
+) -> Result<T>
+where
+ Op: FnMut() -> Result<T>,
+ Cond: FnMut(&T) -> bool,
+{
+ for _ in 0..count {
+ let val = op()?;
+ if cond(&val) {
+ // Unlike the C version, we immediately return.
+ // We know the condition is met so we don't need to check again.
+ return Ok(val);
+ }
+
+ if !delay_delta.is_zero() {
+ udelay(delay_delta);
+ }
+
+ cpu_relax();
+ }
+
+ Err(ETIMEDOUT)
+}
--
2.43.0
next prev parent reply other threads:[~2025-10-21 9:28 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-21 7:11 [PATCH v2 0/2] Add read_poll_count_atomic support FUJITA Tomonori
2025-10-21 7:11 ` [PATCH v2 1/2] rust: add udelay() function FUJITA Tomonori
2025-10-21 12:08 ` Danilo Krummrich
2025-10-21 14:39 ` Miguel Ojeda
2025-10-21 14:46 ` Danilo Krummrich
2025-10-21 14:58 ` Miguel Ojeda
2025-10-21 15:09 ` Danilo Krummrich
2025-10-21 15:13 ` Miguel Ojeda
2025-10-21 15:20 ` Danilo Krummrich
2025-10-22 10:32 ` FUJITA Tomonori
2025-10-22 14:11 ` Alice Ryhl
2025-10-23 5:19 ` FUJITA Tomonori
2025-10-24 8:23 ` Andreas Hindborg
2025-10-24 8:20 ` Andreas Hindborg
2025-10-24 9:27 ` Alice Ryhl
2025-10-24 19:05 ` Miguel Ojeda
2025-10-26 13:11 ` FUJITA Tomonori
2025-10-26 14:49 ` Miguel Ojeda
2025-10-21 7:11 ` FUJITA Tomonori [this message]
2025-10-21 12:35 ` [PATCH v2 2/2] rust: Add read_poll_count_atomic function Danilo Krummrich
2025-10-21 14:05 ` Alice Ryhl
2025-10-21 16:02 ` Danilo Krummrich
2025-10-22 11:27 ` FUJITA Tomonori
2025-10-24 8:25 ` Andreas Hindborg
2025-10-24 9:19 ` Alice Ryhl
2025-10-23 5:24 ` FUJITA Tomonori
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20251021071146.2357069-3-fujita.tomonori@gmail.com \
--to=fujita.tomonori@gmail.com \
--cc=a.hindborg@kernel.org \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=anna-maria@linutronix.de \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=dakr@kernel.org \
--cc=daniel.almeida@collabora.com \
--cc=frederic@kernel.org \
--cc=gary@garyguo.net \
--cc=jstultz@google.com \
--cc=linux-kernel@vger.kernel.org \
--cc=lossin@kernel.org \
--cc=lyude@redhat.com \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=sboyd@kernel.org \
--cc=tglx@linutronix.de \
--cc=tmgross@umich.edu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).