From: "Danilo Krummrich" <dakr@kernel.org>
To: "Daniel Almeida" <daniel.almeida@collabora.com>
Cc: "Liam Girdwood" <lgirdwood@gmail.com>,
"Mark Brown" <broonie@kernel.org>,
"Miguel Ojeda" <ojeda@kernel.org>,
"Alex Gaynor" <alex.gaynor@gmail.com>,
"Boqun Feng" <boqun.feng@gmail.com>,
"Gary Guo" <gary@garyguo.net>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <lossin@kernel.org>,
"Andreas Hindborg" <a.hindborg@kernel.org>,
"Alice Ryhl" <aliceryhl@google.com>,
"Trevor Gross" <tmgross@umich.edu>,
linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org
Subject: Re: [PATCH v2 2/2] rust: regulator: add devm_enable and devm_enable_optional
Date: Tue, 09 Sep 2025 09:15:42 +0200 [thread overview]
Message-ID: <DCO32EPVU4ID.3J103NTRH5IQY@kernel.org> (raw)
In-Reply-To: <20250908-regulator-remove-dynamic-v2-2-e575ae2cde6a@collabora.com>
On Tue Sep 9, 2025 at 1:10 AM CEST, Daniel Almeida wrote:
> +/// Enables a regulator whose lifetime is tied to the lifetime of `dev` through
> +/// [`devres`].
> +///
> +/// This calls `regulator_disable()` and `regulator_put()` automatically on
> +/// driver detach.
> +///
> +/// This API is identical to `devm_regulator_get_enable()`, and should be
> +/// preferred if the caller only cares about the regulator being on.
Preferred over what? :)
I'd link to the alternative Regulator API.
> +///
> +/// [`devres`]: https://docs.kernel.org/driver-api/driver-model/devres.html
> +pub fn devm_enable(dev: &Device<Bound>, name: &CStr) -> Result {
> + // SAFETY: `dev` is a valid and bound device, while `name` is a valid C
> + // string.
> + to_result(unsafe { bindings::devm_regulator_get_enable(dev.as_raw(), name.as_ptr()) })
> +}
> +
> +/// Same as [`devm_enable`], but calls `devm_regulator_get_enable_optional`
> +/// instead.
> +///
> +/// This enables a regulator whose lifetime is tied to the lifetime of `dev`
> +/// through [`devres`], but does not print a message nor provides a dummy if the
> +/// regulator is not found.
> +///
> +/// This calls `regulator_disable()` and `regulator_put()` automatically on
> +/// driver detach.
> +///
> +/// [`devres`]: https://docs.kernel.org/driver-api/driver-model/devres.html
> +pub fn devm_enable_optional(dev: &Device<Bound>, name: &CStr) -> Result {
> + // SAFETY: `dev` is a valid and bound device, while `name` is a valid C
> + // string.
> + to_result(unsafe { bindings::devm_regulator_get_enable_optional(dev.as_raw(), name.as_ptr()) })
> +}
> +
> /// A `struct regulator` abstraction.
> ///
> /// # Examples
> @@ -146,6 +179,29 @@ pub struct Error<State: RegulatorState> {
> /// }
> /// ```
> ///
> +/// If a driver only cares about the regulator being on for as long it is bound
s/on/enabled/
> +/// to a device, then it should use [`devm_enable`] or [`devm_enable_optional`].
> +/// This should be the default use-case unless they need more fine-grained
> +/// control over the regulator's state.
"unless more fine-grained control over the regulator's state is required"
With those nits addressed and the unnecessary helpers removed,
Reviewed-by: Danilo Krummrich <dakr@kernel.org>
next prev parent reply other threads:[~2025-09-09 7:15 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-08 23:10 [PATCH v2 0/2] rust: regulator: improve the ergonomics of Rust regulators Daniel Almeida
2025-09-08 23:10 ` [PATCH v2 1/2] rust: regulator: remove Regulator<Dynamic> Daniel Almeida
2025-09-08 23:10 ` [PATCH v2 2/2] rust: regulator: add devm_enable and devm_enable_optional Daniel Almeida
2025-09-09 2:29 ` Alexandre Courbot
2025-09-09 6:57 ` Boqun Feng
2025-09-09 15:04 ` Daniel Almeida
2025-09-09 15:38 ` Boqun Feng
2025-09-09 15:58 ` Miguel Ojeda
2025-09-09 16:27 ` Boqun Feng
2025-09-09 17:11 ` Mark Brown
2025-09-09 17:15 ` Boqun Feng
2025-09-09 21:10 ` Mark Brown
2025-09-09 17:16 ` Miguel Ojeda
2025-09-09 16:12 ` Daniel Almeida
2025-09-09 16:40 ` Boqun Feng
2025-09-09 17:02 ` Daniel Almeida
2025-09-09 17:03 ` Daniel Almeida
2025-09-09 16:17 ` Mark Brown
2025-09-09 16:29 ` Danilo Krummrich
2025-09-09 17:10 ` Mark Brown
2025-09-09 7:15 ` Danilo Krummrich [this message]
2025-09-10 5:26 ` Boqun Feng
2025-09-11 23:23 ` (subset) [PATCH v2 0/2] rust: regulator: improve the ergonomics of Rust regulators Mark Brown
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=DCO32EPVU4ID.3J103NTRH5IQY@kernel.org \
--to=dakr@kernel.org \
--cc=a.hindborg@kernel.org \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=broonie@kernel.org \
--cc=daniel.almeida@collabora.com \
--cc=gary@garyguo.net \
--cc=lgirdwood@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=lossin@kernel.org \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.