From nobody Tue Jun 30 21:38:33 2026 Received: from mout01.posteo.de (mout01.posteo.de [185.67.36.65]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id E5CF340BCC3 for ; Mon, 29 Jun 2026 13:10:30 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=185.67.36.65 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1782738633; cv=none; b=TQtv9kAwxAKU4QQABxYf38f9RpaKLHrPYPTFOt2K3x9kKmTFbi2/LLSyjO0pX6lsLip7+Tr1fSmcnRRSx4CGQyMlk2mxH7KDKEKUmylTnwtaqyLvXTuKjrWkA7wl1uJOXzea1n01Hamoc2bvV/x8dSJZEpLpHbAizyb+5329UWY= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1782738633; c=relaxed/simple; bh=KtBjvkKMFYfIsDOk59ekqZwBVy/rBkjc8Lj2smWdibA=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=aa1N2eKx6+EWiyW57axsxpixRxn8ZnRjK5Q/nQuBa/zYum/rm5koCn3zRqUF4UAUZjiJTIUO/f6Fjm0Qlv6XtvGPHdHxDBYHG/MRn7oZjDwmhsR1jy8MZ8sK6IR2ji7gO9w5Zm4BUp6P8Ueh54eTwPuRUHVyfnp3Nd1LwCyOT9I= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=posteo.de; spf=pass smtp.mailfrom=posteo.de; dkim=pass (2048-bit key) header.d=posteo.de header.i=@posteo.de header.b=bAu7uc+B; arc=none smtp.client-ip=185.67.36.65 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=posteo.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=posteo.de Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=posteo.de header.i=@posteo.de header.b="bAu7uc+B" Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id 5994D24002A for ; Mon, 29 Jun 2026 15:10:29 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=posteo.de; s=2017; t=1782738629; bh=61g5MKaQ0Lm9UgQ8BlhUQRC7hHxlYIqsJcTg7O1eg/Y=; h=From:Date:Subject:MIME-Version:Content-Type: Content-Transfer-Encoding:Message-Id:To:Cc:Autocrypt:OpenPGP:From; b=bAu7uc+BUr5TZgqtE+FNuc7OxGnk3zimuaO9SjE5i5xSKQWccod1kX0Ry/RmxX1PN QQKkvzX42weCpCFG1Uzp3sLlkB5K7hQ6/pL5vZvOG360NzmffKWGeDryxn4vo8FaTy 6n1qPxXbGwf6ZC4D10Em7+0GVYVEO0HEfkdPatvE6wKPzGZy6PPgzcFAE/RrOHqbIi EXgRgVUP2hkZ1JdFCuly6s1n1ni34mPdI5ID5v9Lm7ekfFCw52iiwn4O2NLzUVAem2 7+xBSg+3a00BnvisYzh/We1Yg1HnvZ4+WqOGqsVcRBLCaOXSxUcHEujegcGpX6j2xU Im2RrU4T5fkJQ== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4gpmq60LJWz6tx0; Mon, 29 Jun 2026 15:10:26 +0200 (CEST) From: Markus Probst Date: Mon, 29 Jun 2026 13:10:28 +0000 Subject: [PATCH v21 1/3] rust: leds: add basic led classdev abstractions Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Message-Id: <20260629-rust_leds-v21-1-4f0f19579db5@posteo.de> References: <20260629-rust_leds-v21-0-4f0f19579db5@posteo.de> In-Reply-To: <20260629-rust_leds-v21-0-4f0f19579db5@posteo.de> To: Lee Jones , Pavel Machek , Greg Kroah-Hartman , Dave Ertman , Leon Romanovsky , Miguel Ojeda , Alex Gaynor , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , Danilo Krummrich , "Rafael J. Wysocki" , Bjorn Helgaas , =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= , Boqun Feng , Daniel Almeida , Tamir Duberstein , Alexandre Courbot , =?utf-8?q?Onur_=C3=96zkan?= , Ira Weiny , Boqun Feng Cc: rust-for-linux@vger.kernel.org, linux-leds@vger.kernel.org, linux-kernel@vger.kernel.org, linux-pci@vger.kernel.org, Markus Probst X-Developer-Signature: v=1; a=openpgp-sha256; l=20352; i=markus.probst@posteo.de; h=from:subject:message-id; bh=KtBjvkKMFYfIsDOk59ekqZwBVy/rBkjc8Lj2smWdibA=; b=owEBiQJ2/ZANAwAIATR2H/jnrUPSAcsmYgBqQm6+7lXH4P30hvYzyG/pixCc06IET4BUcdYsp XU1iqqNPsCJAk8EAAEIADkWIQSCdBjE9KxY53IwxHM0dh/4561D0gUCakJuvhsUgAAAAAAEAA5t YW51MiwyLjUrMS4xMiwyLDIACgkQNHYf+OetQ9IAwQ/9HPiMC9eQZEaWXcfhNmkix9QVBA46WrB CkCsvBUIC/W7dXeUWcZlGM8VsTAM9TGQ8Qtm+7gtO0ko3eWaeGDhhyWpmYsro9LPKKR5CFP9N1B SonoB+zQFyyqFaGq1NlMyVxHB75f5SPaEvakMr1jiBXCXhKF8sxlU4Wplxvs8DcmTQy238xoK59 o/hQnIYiSlTSPfkhH5Loe7e6hb92mJbRmLG3iDJNLqmQvZAAjnDUF0uRk6+kP2OxYj8PbW6Q+xX /cojBJU6Ebbjh+eyULHSwWcNC/6rCIs/Fb++5voaCYKSzL2uq6TV7am5PPOrPgQjVyc0qKTTvni 83qfsy1n4Voi6We/dgeiEcRwlb6Y65o7nQ7lqXpXb3bYvcwssxpusGdmrj2hYhcVZ5MZazPyRJ/ tzlLEw2mJHs5DFHk4DTojBxC8STpTlschkSrm+sJy8KuC6/4PR0rJOvHZ2U7HgxTJIcTdU5qAeB OCywEnWCZ8/NoEQ0cqllAmmADAAmQsRnKo9NC8jabrnqXhDScCXsjfXPl6FD2C83FYOPx30p9M6 u4zym0ZfxCnKk9n4Pl4xhZeXjSZYNS6vYUaafXExiKSObQtSi/kO59nsIwsHVQ15UXgGf3bOHYV uU6hgrED5eOq4f0cQ0FnF/6yKfjyLIF0bUCzD5DEMbuNrVtGGaN0= X-Developer-Key: i=markus.probst@posteo.de; a=openpgp; fpr=827418C4F4AC58E77230C47334761FF8E7AD43D2 Autocrypt: addr=markus.probst@posteo.de; prefer-encrypt=mutual; keydata=xsFNBGiDvXgBEADAXUceKafpl46S35UmDh2wRvvx+UfZbcTjeQOlSwKP7YVJ4JOZrVs93qReNLkO WguIqPBxR9blQ4nyYrqSCV+MMw/3ifyXIm6Pw2YRUDg+WTEOjTixRCoWDgUj1nOsvJ9tVAm76Ww+ /pAnepVRafMID0rqEfD9oGv1YrfpeFJhyE2zUw3SyyNLIKWD6QeLRhKQRbSnsXhGLFBXCqt9k5JA RhgQof9zvztcCVlT5KVvuyfC4H+HzeGmu9201BVyihJwKdcKPq+n/aY5FUVxNTgtI9f8wIbmfAja oT1pjXSp+dszakA98fhONM98pOq723o/1ZGMZukyXFfsDGtA3BB79HoopHKujLGWAGskzClwTjRQ xBqxh/U/lL1pc+0xPWikTNCmtziCOvv0KA0arDOMQlyFvImzX6oGVgE4ksKQYbMZ3Ikw6L1Rv1J+ FvN0aNwOKgL2ztBRYscUGcQvA0Zo1fGCAn/BLEJvQYShWKeKqjyncVGoXFsz2AcuFKe1pwETSsN6 OZncjy32e4ktgs07cWBfx0v62b8md36jau+B6RVnnodaA8++oXl3FRwiEW8XfXWIjy4umIv93tb8 8ekYsfOfWkTSewZYXGoqe4RtK80ulMHb/dh2FZQIFyRdN4HOmB4FYO5sEYFr9YjHLmDkrUgNodJC XCeMe4BO4iaxUQARAQABzRdtYXJrdXMucHJvYnN0QHBvc3Rlby5kZcLBkQQTAQgAOxYhBIJ0GMT0 rFjncjDEczR2H/jnrUPSBQJog714AhsDBQsJCAcCAiICBhUKCQgLAgQWAgMBAh4HAheAAAoJEDR2 H/jnrUPSgdkQAISaTk2D345ehXEkn5z2yUEjaVjHIE7ziqRaOgn/QanCgeTUinIv6L6QXUFvvIfH 1OLPwQ1hfvEg9NnNLyFezWSy6jvoVBTIPqicD/r3FkithnQ1IDkdSjrarPMxJkvuh3l7XZHo49GV HQ8i5zh5w4YISrcEtE99lJisvni2Jqx7we5tey9voQFDyM8jxlSWv3pmoUTCtBkX/eKHJXosgsuS B4TGDCVPOjla/emI5c9MhMG7O4WEEmoSdPbmraPw66YZD6uLyhV4DPHbiDWRzXWnClHSyjB9rky9 lausFxogvu4l9H+KDsXIadNDWdLdu1/enS/wDd9zh5S78rY2jeXaG4mnf4seEKamZ7KQ6FIHrcyP ezdDzssPQcTQcGRMQzCn6wP3tlGk7rsfmyHMlFqdRoNNv+ZER/OkmZFPW655zRfbMi0vtrqK2Awm 9ggobb1oktfd9PPNXMUY+DNVlgR2G7jLnenSoQausLUm0pHoNE8TWFv851Y6SOYnvn488sP1Tki5 F3rKwclawQFHUXTCQw+QSh9ay8xgnNZfH+u9NY7w3gPoeKBOAFcBc2BtzcgekeWS8qgEmm2/oNFV G0ivPQbRx8FjRKbuF7g3YhgNZZ0ac8FneuUtJ2PkSIFTZhaAiC0utvxk0ndmWFiW4acEkMZGrLaM L2zWNjrqwsD2zsFNBGiDvXgBEADCXQy1n7wjRxG12DOVADawjghKcG+5LtEf31WftHKLFbp/HArj BhkT6mj+CCI1ClqY+FYU5CK/s0ScMfLxRGLZ0Ktzawb78vOgBVFT3yB1yWBTewsAXdqNqRooaUNo 8cG/NNJLjhccH/7PO/FWX5qftOVUJ/AIsAhKQJ18Tc8Ik73v427EDxuKb9mTAnYQFA3Ev3hAiVbO 6Rv39amVOfJ8sqwiSUGidj2Fctg2aB5JbeMln0KCUbTD1LhEFepeKypfofAXQbGwaCjAhmkWy/q3 IT1mUrPxOngbxdRoOx1tGUC0HCMUW1sFaJgQPMmDcR0JGPOpgsKnitsSnN7ShcCr1buel7vLnUMD +TAZ5opdoF6HjAvAnBQaijtK6minkrM0seNXnCg0KkV8xhMNa6zCs1rq4GgjNLJue2EmuyHooHA4 7JMoLVHcxVeuNTp6K2+XRx0Pk4e2Lj8IVy9yEYyrywEOC5XRW37KJjsiOAsumi1rkvM7QREWgUDe Xs0+RpxI3QrrANh71fLMRo7LKRF3Gvw13NVCCC9ea20P4PwhgWKStkwO2NO+YJsAoS1QycMi/vKu 0EHhknYXamaSV50oZzHKmX56vEeJHTcngrM8R1SwJCYopCx9gkz90bTVYlitJa5hloWTYeMD7FNj Y6jfVSzgM/K4gMgUNDW/PPGeMwARAQABwsF2BBgBCAAgFiEEgnQYxPSsWOdyMMRzNHYf+OetQ9IF AmiDvXgCGwwACgkQNHYf+OetQ9LHDBAAhk+ab8+WrbS/b1/gYW3q1KDiXU719nCtfkUVXKidW5Ec Idlr5HGt8ilLoxSWT2Zi368iHCXS0WenGgPwlv8ifvB7TOZiiTDZROZkXjEBmU4nYjJ7GymawpWv oQwjMsPuq6ysbzWtOZ7eILx7cI0FjQeJ/Q2baRJub0uAZNwBOxCkAS6lpk5Fntd2u8CWmDQo4SYp xeuQ+pwkp0yEP30RhN2BO2DXiBEGSZSYh+ioGbCHQPIV3iVj0h6lcCPOqopZqyeCfigeacBI0nvN jHWz/spzF3+4OS+3RJvoHtAQmProxyGib8iVsTxgZO3UUi4TSODeEt0i0kHSPY4sCciOyXfAyYoD DFqhRjOEwBBxhr+scU4C1T2AflozvDwq3VSONjrKJUkhd8+WsdXxMdPFgBQuiKKwUy11mz6KQfcR wmDehF3UaUoxa+YIhWPbKmycxuX/D8SvnqavzAeAL1OcRbEI/HsoroVlEFbBRNBZLJUlnTPs8ZcU 4+8rq5YX1GUrJL3jf6SAfSgO7UdkEET3PdcKFYtS+ruV1Cp5V0q4kCfI5jk25iiz8grM2wOzVSsc l1mEkhiEPH87HP0whhb544iioSnumd3HJKL7dzhRegsMizatupp8D65A2JziW0WKopa1iw9fti3A aBeNN4ijKZchBXHPgVx+YtWRHfcm4l8= OpenPGP: url=https://posteo.de/keys/markus.probst@posteo.de.asc; preference=encrypt Implement the core abstractions needed for led class devices, including: * `led::LedOps` - the trait for handling leds, including `brightness_set`, `brightness_get` and `blink_set` * `led::DeviceBuilder` - the builder for the led class device * `led::Device` - a safe wrapper around `led_classdev` Signed-off-by: Markus Probst --- MAINTAINERS | 8 ++ rust/kernel/led.rs | 288 ++++++++++++++++++++++++++++++++++++++++++= ++++ rust/kernel/led/normal.rs | 230 ++++++++++++++++++++++++++++++++++++ rust/kernel/lib.rs | 1 + 4 files changed, 527 insertions(+) diff --git a/MAINTAINERS b/MAINTAINERS index 15011f5752a9..ceb2285366ff 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -14662,6 +14662,14 @@ F: drivers/leds/ F: include/dt-bindings/leds/ F: include/linux/leds.h =20 +LED SUBSYSTEM [RUST] +M: Markus Probst +L: linux-leds@vger.kernel.org +L: rust-for-linux@vger.kernel.org +S: Maintained +F: rust/kernel/led.rs +F: rust/kernel/led/ + LEGO MINDSTORMS EV3 R: David Lechner S: Maintained diff --git a/rust/kernel/led.rs b/rust/kernel/led.rs new file mode 100644 index 000000000000..c92d99d68497 --- /dev/null +++ b/rust/kernel/led.rs @@ -0,0 +1,288 @@ +// SPDX-License-Identifier: GPL-2.0 + +//! Abstractions for the leds driver model. +//! +//! C header: [`include/linux/leds.h`](srctree/include/linux/leds.h) + +use core::{ + marker::PhantomData, + mem::transmute, + ptr::NonNull, // +}; + +use crate::{ + container_of, + device::{ + self, + property::FwNode, + AsBusDevice, + Bound, // + }, + error::{ + from_result, + to_result, + VTABLE_DEFAULT_ERROR, // + }, + macros::vtable, + prelude::*, + str::CStrExt, + sync::aref::ARef, + types::Opaque, // +}; + +mod normal; + +pub use normal::Device; + +/// The name of the led is determined by the driver. +pub enum Named {} +/// The name of the led is determined by its fwnode. +pub enum Unnamed {} + +/// How the name of the led should be determined. +pub trait DeviceBuilderState: private::Sealed {} + +impl DeviceBuilderState for Named {} +impl private::Sealed for Named {} +impl DeviceBuilderState for Unnamed {} +impl private::Sealed for Unnamed {} + +/// The builder to register a led class device. +/// +/// See [`LedOps`]. +pub struct DeviceBuilder<'a, S> { + fwnode: Option>, + name: Option<&'a CStr>, + devicename: Option<&'a CStr>, + devname_mandatory: bool, + initial_brightness: u32, + color: Color, + _p: PhantomData, +} + +impl DeviceBuilder<'static, S> { + /// Creates a new [`DeviceBuilder`]. + #[inline] + #[expect( + clippy::new_without_default, + reason =3D "no need and derive is prevented by S" + )] + pub fn new() -> Self { + Self { + fwnode: None, + name: None, + devicename: None, + devname_mandatory: false, + initial_brightness: 0, + color: Color::default(), + _p: PhantomData, + } + } +} + +impl<'a> DeviceBuilder<'a, Unnamed> { + /// Sets the firmware node. + #[inline] + pub fn fwnode(self, fwnode: Option>) -> Self { + Self { fwnode, ..self } + } + + /// Sets the device name. + #[inline] + pub fn devicename(self, devicename: &'a CStr) -> Self { + Self { + devicename: Some(devicename), + ..self + } + } + + /// Sets if a device name is mandatory. + #[inline] + pub fn devicename_mandatory(self, mandatory: bool) -> Self { + Self { + devname_mandatory: mandatory, + ..self + } + } +} + +impl<'a, S: DeviceBuilderState> DeviceBuilder<'a, S> { + /// Sets the initial brightness value for the led. + /// + /// The default brightness is 0. + /// If [`LedOps::brightness_get`] is implemented, this value will be i= gnored. + #[inline] + pub fn initial_brightness(self, brightness: u32) -> Self { + Self { + initial_brightness: brightness, + ..self + } + } + + /// Sets the color of the led. + /// + /// This value can be overwritten by the "color" fwnode property. + #[inline] + pub fn color(self, color: Color) -> Self { + Self { color, ..self } + } +} + +impl<'a> DeviceBuilder<'a, Named> { + /// Sets the name of the led. + /// + /// Setting this will prevent the fwnode from being used and prevents = automatic name + /// composition. + #[inline] + pub fn name(self, name: &'a CStr) -> Self { + Self { + name: Some(name), + ..self + } + } +} + +/// Trait defining the operations for a LED driver. +/// +/// # Examples +/// ``` +/// use kernel::{ +/// device, +/// devres::Devres, +/// led, +/// macros::vtable, +/// platform, +/// prelude::*, // +/// }; +/// +/// struct MyLedOps; +/// +/// +/// #[vtable] +/// impl led::LedOps for MyLedOps { +/// type Bus =3D platform::Device; +/// const BLOCKING: bool =3D false; +/// const MAX_BRIGHTNESS: u32 =3D 255; +/// +/// fn brightness_set<'bound>( +/// &self, +/// _dev: &'bound platform::Device, +/// _classdev: &led::Device<'bound, Self>, +/// _brightness: u32 +/// ) -> Result<()> { +/// // Set the brightness for the led here +/// Ok(()) +/// } +/// } +/// ``` +/// Led drivers must implement this trait in order to register and handle = a [`Device`]. +#[vtable] +pub trait LedOps: Send + Sync + Sized { + /// The bus device required by the implementation. + #[allow(private_bounds)] + type Bus: AsBusDevice; + + /// If set true, [`LedOps::brightness_set`] and [`LedOps::blink_set`] = must perform the + /// operation immediately. If set false, they must not sleep. + const BLOCKING: bool; + /// The max brightness level. + const MAX_BRIGHTNESS: u32; + + /// Sets the brightness level. + /// + /// See also [`LedOps::BLOCKING`]. + fn brightness_set<'bound>( + &self, + dev: &'bound Self::Bus, + classdev: &Device<'bound, Self>, + brightness: u32, + ) -> Result<()>; + + /// Gets the current brightness level. + fn brightness_get<'bound>( + &self, + dev: &'bound Self::Bus, + classdev: &Device<'bound, Self>, + ) -> Result { + let _ =3D (dev, classdev); + build_error!(VTABLE_DEFAULT_ERROR) + } + + /// Activates hardware accelerated blinking. + /// + /// delays are in milliseconds. If both are zero, a sensible default s= hould be chosen. + /// The caller should adjust the timings in that case and if it can't = match the values + /// specified exactly. Setting the brightness to 0 will disable the ha= rdware accelerated + /// blinking. + /// + /// See also [`LedOps::BLOCKING`]. + fn blink_set<'bound>( + &self, + dev: &'bound Self::Bus, + classdev: &Device<'bound, Self>, + delay_on: &mut usize, + delay_off: &mut usize, + ) -> Result<()> { + let _ =3D (dev, classdev, delay_on, delay_off); + build_error!(VTABLE_DEFAULT_ERROR) + } +} + +/// Led colors. +#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)] +#[repr(u32)] +#[non_exhaustive] +#[expect( + missing_docs, + reason =3D "it shouldn't be necessary to document each color" +)] +pub enum Color { + #[default] + White =3D bindings::LED_COLOR_ID_WHITE, + Red =3D bindings::LED_COLOR_ID_RED, + Green =3D bindings::LED_COLOR_ID_GREEN, + Blue =3D bindings::LED_COLOR_ID_BLUE, + Amber =3D bindings::LED_COLOR_ID_AMBER, + Violet =3D bindings::LED_COLOR_ID_VIOLET, + Yellow =3D bindings::LED_COLOR_ID_YELLOW, + Ir =3D bindings::LED_COLOR_ID_IR, + Multi =3D bindings::LED_COLOR_ID_MULTI, + Rgb =3D bindings::LED_COLOR_ID_RGB, + Purple =3D bindings::LED_COLOR_ID_PURPLE, + Orange =3D bindings::LED_COLOR_ID_ORANGE, + Pink =3D bindings::LED_COLOR_ID_PINK, + Cyan =3D bindings::LED_COLOR_ID_CYAN, + Lime =3D bindings::LED_COLOR_ID_LIME, +} +static_assert!(bindings::LED_COLOR_ID_MAX =3D=3D 15); + +impl Color { + /// Name of the color + #[inline] + pub fn as_c_str(self) -> &'static CStr { + // SAFETY: + // - `self as u8` is a valid led color id. + // - `led_get_color_name` always returns a valid C string pointer. + unsafe { CStr::from_char_ptr(bindings::led_get_color_name(self as = u8)) } + } +} + +impl TryFrom for Color { + type Error =3D Error; + + fn try_from(value: u32) -> core::result::Result { + if value < bindings::LED_COLOR_ID_MAX { + // SAFETY: + // - `Color` is represented as `u32` + // - the static_assert above guarantees that no additional col= or has been added + // - `value` is guaranteed to be in the color id range + Ok(unsafe { transmute::(value) }) + } else { + Err(EINVAL) + } + } +} + +mod private { + pub trait Sealed {} +} diff --git a/rust/kernel/led/normal.rs b/rust/kernel/led/normal.rs new file mode 100644 index 000000000000..2769f690bb24 --- /dev/null +++ b/rust/kernel/led/normal.rs @@ -0,0 +1,230 @@ +// SPDX-License-Identifier: GPL-2.0 + +//! Led mode for the `struct led_classdev`. +//! +//! C header: [`include/linux/leds.h`](srctree/include/linux/leds.h) + +use super::*; + +/// The led class device representation. +/// +/// This structure represents the Rust abstraction for a led class device. +#[pin_data(PinnedDrop)] +pub struct Device<'bound, T: LedOps + 'bound> { + #[pin] + ops: T, + #[pin] + classdev: Opaque, + _p: PhantomData<&'bound ()>, +} + +impl<'a, S: DeviceBuilderState> DeviceBuilder<'a, S> { + /// Registers a new [`Device`]. + pub fn build<'bound: 'a, T: LedOps + 'bound>( + self, + parent: &'bound T::Bus, + ops: impl PinInit + 'a, + ) -> impl PinInit, Error> + 'a { + const_assert!(T::MAX_BRIGHTNESS <=3D i32::MAX.unsigned_abs() || !T= ::HAS_BRIGHTNESS_GET); + + try_pin_init!(Device { + ops <- ops, + classdev <- Opaque::try_ffi_init(|ptr: *mut bindings::led_clas= sdev| { + // SAFETY: `try_ffi_init` guarantees that `ptr` is valid f= or write. + // `led_classdev` gets fully initialized in-place by + // `led_classdev_register_ext` including `mutex` and `list= _head`. + unsafe { + ptr.write(bindings::led_classdev { + brightness_set: (!T::BLOCKING) + .then_some(Adapter::::brightness_set_callba= ck), + brightness_set_blocking: T::BLOCKING + .then_some(Adapter::::brightness_set_blocki= ng_callback), + brightness_get: T::HAS_BRIGHTNESS_GET + .then_some(Adapter::::brightness_get_callba= ck), + blink_set: T::HAS_BLINK_SET.then_some(Adapter::= ::blink_set_callback), + max_brightness: T::MAX_BRIGHTNESS, + brightness: self.initial_brightness, + color: self.color as u32, + name: self.name.map_or(core::ptr::null(), CStrExt:= :as_char_ptr), + ..bindings::led_classdev::default() + }) + }; + + let mut init_data =3D bindings::led_init_data { + fwnode: self + .fwnode + .as_ref() + .map_or(core::ptr::null_mut(), |fwnode| fwnode.as_= raw()), + default_label: core::ptr::null(), + devicename: self + .devicename + .map_or(core::ptr::null(), CStrExt::as_char_ptr), + devname_mandatory: self.devname_mandatory, + }; + + // SAFETY: + // - `parent.as_ref().as_raw()` is guaranteed to be a poin= ter to a valid + // `device`. + // - `ptr` is guaranteed to be a pointer to an initialized= `led_classdev`. + to_result(unsafe { + bindings::led_classdev_register_ext( + parent.as_ref().as_raw(), + ptr, + if self.name.is_none() { + &raw mut init_data + } else { + core::ptr::null_mut() + }, + ) + })?; + + core::mem::forget(self.fwnode); // keep the reference coun= t incremented + + Ok::<_, Error>(()) + }), + _p: PhantomData, + }) + } +} + +impl<'bound, T: LedOps + 'bound> Device<'bound, T> { + /// # Safety + /// `led_cdev` must be a valid pointer to a `led_classdev` embedded wi= thin a + /// `led::Device`. + #[inline] + unsafe fn from_raw<'a>(led_cdev: *mut bindings::led_classdev) -> &'a S= elf { + // SAFETY: The function's contract guarantees that `led_cdev` poin= ts to a `led_classdev` + // field embedded within a valid `led::Device`. `container_of!` ca= n therefore + // safely calculate the address of the containing struct. + unsafe { &*container_of!(Opaque::cast_from(led_cdev), Self, classd= ev) } + } + + #[inline] + fn parent(&self) -> &'bound device::Device { + // SAFETY: `self.classdev.get()` is guaranteed to be a valid point= er to `led_classdev`. + unsafe { device::Device::from_raw((*(*self.classdev.get()).dev).pa= rent) } + } +} + +// SAFETY: A `led::Device` can be unregistered from any thread. +unsafe impl<'bound, T: LedOps + 'bound + Send> Send for Device<'bound, T> = {} + +// SAFETY: `led::Device` can be shared among threads because all methods o= f `led::Device` +// are thread safe. +unsafe impl<'bound, T: LedOps + 'bound + Sync> Sync for Device<'bound, T> = {} + +struct Adapter { + _p: PhantomData, +} + +impl Adapter { + /// # Safety + /// `led_cdev` must be a valid pointer to a `led_classdev` embedded wi= thin a + /// `led::Device`. + /// This function is called on setting the brightness of a led. + unsafe extern "C" fn brightness_set_callback( + led_cdev: *mut bindings::led_classdev, + brightness: u32, + ) { + // SAFETY: The function's contract guarantees that `led_cdev` is a= valid pointer to a + // `led_classdev` embedded within a `led::Device`. + let classdev =3D unsafe { Device::::from_raw(led_cdev) }; + // SAFETY: `classdev.parent()` is guaranteed to be contained in `T= ::Bus`. + let parent =3D unsafe { T::Bus::from_device(classdev.parent()) }; + + let _ =3D classdev.ops.brightness_set(parent, classdev, brightness= ); + } + + /// # Safety + /// `led_cdev` must be a valid pointer to a `led_classdev` embedded wi= thin a + /// `led::Device`. + /// This function is called on setting the brightness of a led immedia= tely. + unsafe extern "C" fn brightness_set_blocking_callback( + led_cdev: *mut bindings::led_classdev, + brightness: u32, + ) -> i32 { + from_result(|| { + // SAFETY: The function's contract guarantees that `led_cdev` = is a valid pointer to a + // `led_classdev` embedded within a `led::Device`. + let classdev =3D unsafe { Device::::from_raw(led_cdev) }; + // SAFETY: `classdev.parent()` is guaranteed to be contained i= n `T::Bus`. + let parent =3D unsafe { T::Bus::from_device(classdev.parent())= }; + + classdev.ops.brightness_set(parent, classdev, brightness)?; + Ok(0) + }) + } + + /// # Safety + /// `led_cdev` must be a valid pointer to a `led_classdev` embedded wi= thin a + /// `led::Device`. + /// This function is called on getting the brightness of a led. + unsafe extern "C" fn brightness_get_callback(led_cdev: *mut bindings::= led_classdev) -> u32 { + // SAFETY: The function's contract guarantees that `led_cdev` is a= valid pointer to a + // `led_classdev` embedded within a `led::Device`. + let classdev =3D unsafe { Device::::from_raw(led_cdev) }; + // SAFETY: `classdev.parent()` is guaranteed to be contained in `T= ::Bus`. + let parent =3D unsafe { T::Bus::from_device(classdev.parent()) }; + + // CAST: Resulting value will be casted back to i32 in the led sub= system. + from_result(|| { + classdev + .ops + .brightness_get(parent, classdev) + .inspect(|val| debug_assert!(*val <=3D T::MAX_BRIGHTNESS)) + .and_then(|val| Ok(i32::try_from(val)?)) + }) as u32 + } + + /// # Safety + /// `led_cdev` must be a valid pointer to a `led_classdev` embedded wi= thin a + /// `led::Device`. + /// `delay_on` and `delay_off` must be valid pointers to `usize` and h= ave + /// exclusive access for the period of this function. + /// This function is called on enabling hardware accelerated blinking. + unsafe extern "C" fn blink_set_callback( + led_cdev: *mut bindings::led_classdev, + delay_on: *mut usize, + delay_off: *mut usize, + ) -> i32 { + from_result(|| { + // SAFETY: The function's contract guarantees that `led_cdev` = is a valid pointer to a + // `led_classdev` embedded within a `led::Device`. + let classdev =3D unsafe { Device::::from_raw(led_cdev) }; + // SAFETY: `classdev.parent()` is guaranteed to be contained i= n `T::Bus`. + let parent =3D unsafe { T::Bus::from_device(classdev.parent())= }; + + classdev.ops.blink_set( + parent, + classdev, + // SAFETY: The function's contract guarantees that `delay_= on` points to a `usize` + // and is exclusive for the period of this function. + unsafe { &mut *delay_on }, + // SAFETY: The function's contract guarantees that `delay_= off` points to a `usize` + // and is exclusive for the period of this function. + unsafe { &mut *delay_off }, + )?; + Ok(0) + }) + } +} + +#[pinned_drop] +impl<'bound, T: LedOps + 'bound> PinnedDrop for Device<'bound, T> { + fn drop(self: Pin<&mut Self>) { + let raw =3D self.classdev.get(); + // SAFETY: The existence of `self` guarantees that `self.classdev.= get()` is a pointer to a + // valid `led_classdev`. + let dev: &device::Device =3D unsafe { device::Device::from_raw((*r= aw).dev) }; + + let _fwnode =3D dev + .fwnode() + // SAFETY: the reference count of `fwnode` has previously been + // incremented in `led::DeviceBuilder::build`. + .map(|fwnode| unsafe { ARef::from_raw(NonNull::from(fwnode)) }= ); + + // SAFETY: The existence of `self` guarantees that `self.classdev`= has previously been + // successfully registered with `led_classdev_register_ext`. + unsafe { bindings::led_classdev_unregister(raw) }; + } +} diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index 9512af7156df..09e4cc7a14db 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -90,6 +90,7 @@ pub mod jump_label; #[cfg(CONFIG_KUNIT)] pub mod kunit; +pub mod led; pub mod list; pub mod maple_tree; pub mod miscdevice; --=20 2.53.0 From nobody Tue Jun 30 21:38:33 2026 Received: from mout02.posteo.de (mout02.posteo.de [185.67.36.66]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 5990740DFAC for ; Mon, 29 Jun 2026 13:10:34 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=185.67.36.66 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1782738636; cv=none; b=jyAP5jBrGCL193cbyTb244Z0EfJodEQnb5kxaVXLOyAEnSrECEjjqENviD/GKy2SPggqRVDegBOl9yaUh0TXZysy8Uf4fq+H9fXavynk0XodJiTtq8jVEOJTM/2hSMGZ2pew7nQtXnlAgVUfBpS8309sEwEJqIU3wF+7hlJAkkA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1782738636; c=relaxed/simple; bh=yTORbnkTY8Sfb1z8F45fJXLmzzLJI3yGlCa9LgVsU7s=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=h9SdiFtFLyu00mQrL6I1zCKepVXRTcM0eEoUggezC0a7u1pOY7xn5kznoxTr3ExcPZ+/U0J6IyZcaFyGxq9MAyOLZR6PlH+30GjpSoz0ZZncOsQTiD+HlCnfLo3DtyR7bfZ5PYYjqgMBdZofLzCSkvvoVwjzD10VoA34wTJLUSs= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=posteo.de; spf=pass smtp.mailfrom=posteo.de; dkim=pass (2048-bit key) header.d=posteo.de header.i=@posteo.de header.b=RgeB5/Np; arc=none smtp.client-ip=185.67.36.66 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=posteo.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=posteo.de Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=posteo.de header.i=@posteo.de header.b="RgeB5/Np" Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id D5EBE240105 for ; Mon, 29 Jun 2026 15:10:31 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=posteo.de; s=2017; t=1782738631; bh=B1W7yOIuRZyKI8IwMMgkYJMNTYI2xvFoTdhYhi5vlmw=; h=From:Date:Subject:MIME-Version:Content-Type: Content-Transfer-Encoding:Message-Id:To:Cc:Autocrypt:OpenPGP:From; b=RgeB5/Npl8NFf8Uq3bg1Btq0BE5b7WlgpXC2zQRaVDzgtqzHF/4sjnDJpmdqsUnPU h7CH8GLca6EYlLpsTEfe1S4G/3dov1P1CQPQm6ayLXfqPMDeRkDo8cm3rM1s6WrgZo WBXEiUPZRvN4de2N2nxPnTPmbAaI6adLNNvawD9Fl4tBGcmBiwt5rJKp7jGo7GbY23 UrBMkZLjULs9XJdEDF1xakFQ/Z5rhalj+3d9NK8hBMCzKLrBK8JiQClzg328MgRtj5 AjxmUErS/51Em2GNVtmRnuTg/LoTA2oSO5N2mNkTOM2eLbAemEzfST2+CEBTAotND+ sLHtpiMWOCzVA== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4gpmq80sgxz6tyW; Mon, 29 Jun 2026 15:10:28 +0200 (CEST) From: Markus Probst Date: Mon, 29 Jun 2026 13:10:30 +0000 Subject: [PATCH v21 2/3] rust: leds: add Mode trait Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Message-Id: <20260629-rust_leds-v21-2-4f0f19579db5@posteo.de> References: <20260629-rust_leds-v21-0-4f0f19579db5@posteo.de> In-Reply-To: <20260629-rust_leds-v21-0-4f0f19579db5@posteo.de> To: Lee Jones , Pavel Machek , Greg Kroah-Hartman , Dave Ertman , Leon Romanovsky , Miguel Ojeda , Alex Gaynor , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , Danilo Krummrich , "Rafael J. Wysocki" , Bjorn Helgaas , =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= , Boqun Feng , Daniel Almeida , Tamir Duberstein , Alexandre Courbot , =?utf-8?q?Onur_=C3=96zkan?= , Ira Weiny , Boqun Feng Cc: rust-for-linux@vger.kernel.org, linux-leds@vger.kernel.org, linux-kernel@vger.kernel.org, linux-pci@vger.kernel.org, Markus Probst X-Developer-Signature: v=1; a=openpgp-sha256; l=5605; i=markus.probst@posteo.de; h=from:subject:message-id; bh=yTORbnkTY8Sfb1z8F45fJXLmzzLJI3yGlCa9LgVsU7s=; b=owEBiQJ2/ZANAwAIATR2H/jnrUPSAcsmYgBqQm6/3dd3ePkf2Pjm0KCCKu4CueRcqicsYBsXF 1MElEr9h5CJAk8EAAEIADkWIQSCdBjE9KxY53IwxHM0dh/4561D0gUCakJuvxsUgAAAAAAEAA5t YW51MiwyLjUrMS4xMiwyLDIACgkQNHYf+OetQ9Ko5RAAsC7jfoaMcnJuK+shXAWtzRiA8qLhVxI v8BWWs39M1qDRNh2Z17QnAwbvuM62j87wqfRfoPpo/zhIkwlFgkSab+ovx2wgFdqvCTZ1ln/E+p Pjo6vrV/GlwNsoFoWajpG4uo0ZlOxUqrzQzm5GFz0FBS4cHW7z9FgONMOogpOcA/ycqkxwBb06A NL1oedwanMqFV0AWnS0pSKLmf5jvF1+jOcGTJeUudpRG+HTBv50qoVkkdIOA9lFY9au+CQ8+1A8 VKF6OZi3NNr5XKSYYzSZRco1wcyb27w6Gq4Lmf9R4yMmm57AUAKto9uDB2TzPWSO9JOHZ0c/nBZ FYUsUeB9EQnt61QtQ7x6lZ5EGPF4CGcioDpVJPLfVQHzV/qgU8svEgqDQP1mPxvaT5u6pHaNa1x ZylKSJI/wz6QSFDnJvIGbzfYuJsU3JbOwRsbhJHbch/3G3r61ZvgDV4b+Vin/XtkA9mIixJr/Ne XjmrIhxAVvbT2nWV1Ie+nzA6b/BhBrC2sCXk/0OdukIbw3Cr0U5rCrVbzFpiVWYa0v1E+xWXhN3 CPEV+EHM4MB71hrR12VIgc3xRQVj7frHTk+Pb1jHxsUV2TCaBLmdKMwOvRC/B6mK4GmBgEV9fdN cLy9VUOo3Zy9CG2Sg7dCA0tD/vNU9XdvqQXo1if4p/prk1QajzuQ= X-Developer-Key: i=markus.probst@posteo.de; a=openpgp; fpr=827418C4F4AC58E77230C47334761FF8E7AD43D2 Autocrypt: addr=markus.probst@posteo.de; prefer-encrypt=mutual; keydata=xsFNBGiDvXgBEADAXUceKafpl46S35UmDh2wRvvx+UfZbcTjeQOlSwKP7YVJ4JOZrVs93qReNLkO WguIqPBxR9blQ4nyYrqSCV+MMw/3ifyXIm6Pw2YRUDg+WTEOjTixRCoWDgUj1nOsvJ9tVAm76Ww+ /pAnepVRafMID0rqEfD9oGv1YrfpeFJhyE2zUw3SyyNLIKWD6QeLRhKQRbSnsXhGLFBXCqt9k5JA RhgQof9zvztcCVlT5KVvuyfC4H+HzeGmu9201BVyihJwKdcKPq+n/aY5FUVxNTgtI9f8wIbmfAja oT1pjXSp+dszakA98fhONM98pOq723o/1ZGMZukyXFfsDGtA3BB79HoopHKujLGWAGskzClwTjRQ xBqxh/U/lL1pc+0xPWikTNCmtziCOvv0KA0arDOMQlyFvImzX6oGVgE4ksKQYbMZ3Ikw6L1Rv1J+ FvN0aNwOKgL2ztBRYscUGcQvA0Zo1fGCAn/BLEJvQYShWKeKqjyncVGoXFsz2AcuFKe1pwETSsN6 OZncjy32e4ktgs07cWBfx0v62b8md36jau+B6RVnnodaA8++oXl3FRwiEW8XfXWIjy4umIv93tb8 8ekYsfOfWkTSewZYXGoqe4RtK80ulMHb/dh2FZQIFyRdN4HOmB4FYO5sEYFr9YjHLmDkrUgNodJC XCeMe4BO4iaxUQARAQABzRdtYXJrdXMucHJvYnN0QHBvc3Rlby5kZcLBkQQTAQgAOxYhBIJ0GMT0 rFjncjDEczR2H/jnrUPSBQJog714AhsDBQsJCAcCAiICBhUKCQgLAgQWAgMBAh4HAheAAAoJEDR2 H/jnrUPSgdkQAISaTk2D345ehXEkn5z2yUEjaVjHIE7ziqRaOgn/QanCgeTUinIv6L6QXUFvvIfH 1OLPwQ1hfvEg9NnNLyFezWSy6jvoVBTIPqicD/r3FkithnQ1IDkdSjrarPMxJkvuh3l7XZHo49GV HQ8i5zh5w4YISrcEtE99lJisvni2Jqx7we5tey9voQFDyM8jxlSWv3pmoUTCtBkX/eKHJXosgsuS B4TGDCVPOjla/emI5c9MhMG7O4WEEmoSdPbmraPw66YZD6uLyhV4DPHbiDWRzXWnClHSyjB9rky9 lausFxogvu4l9H+KDsXIadNDWdLdu1/enS/wDd9zh5S78rY2jeXaG4mnf4seEKamZ7KQ6FIHrcyP ezdDzssPQcTQcGRMQzCn6wP3tlGk7rsfmyHMlFqdRoNNv+ZER/OkmZFPW655zRfbMi0vtrqK2Awm 9ggobb1oktfd9PPNXMUY+DNVlgR2G7jLnenSoQausLUm0pHoNE8TWFv851Y6SOYnvn488sP1Tki5 F3rKwclawQFHUXTCQw+QSh9ay8xgnNZfH+u9NY7w3gPoeKBOAFcBc2BtzcgekeWS8qgEmm2/oNFV G0ivPQbRx8FjRKbuF7g3YhgNZZ0ac8FneuUtJ2PkSIFTZhaAiC0utvxk0ndmWFiW4acEkMZGrLaM L2zWNjrqwsD2zsFNBGiDvXgBEADCXQy1n7wjRxG12DOVADawjghKcG+5LtEf31WftHKLFbp/HArj BhkT6mj+CCI1ClqY+FYU5CK/s0ScMfLxRGLZ0Ktzawb78vOgBVFT3yB1yWBTewsAXdqNqRooaUNo 8cG/NNJLjhccH/7PO/FWX5qftOVUJ/AIsAhKQJ18Tc8Ik73v427EDxuKb9mTAnYQFA3Ev3hAiVbO 6Rv39amVOfJ8sqwiSUGidj2Fctg2aB5JbeMln0KCUbTD1LhEFepeKypfofAXQbGwaCjAhmkWy/q3 IT1mUrPxOngbxdRoOx1tGUC0HCMUW1sFaJgQPMmDcR0JGPOpgsKnitsSnN7ShcCr1buel7vLnUMD +TAZ5opdoF6HjAvAnBQaijtK6minkrM0seNXnCg0KkV8xhMNa6zCs1rq4GgjNLJue2EmuyHooHA4 7JMoLVHcxVeuNTp6K2+XRx0Pk4e2Lj8IVy9yEYyrywEOC5XRW37KJjsiOAsumi1rkvM7QREWgUDe Xs0+RpxI3QrrANh71fLMRo7LKRF3Gvw13NVCCC9ea20P4PwhgWKStkwO2NO+YJsAoS1QycMi/vKu 0EHhknYXamaSV50oZzHKmX56vEeJHTcngrM8R1SwJCYopCx9gkz90bTVYlitJa5hloWTYeMD7FNj Y6jfVSzgM/K4gMgUNDW/PPGeMwARAQABwsF2BBgBCAAgFiEEgnQYxPSsWOdyMMRzNHYf+OetQ9IF AmiDvXgCGwwACgkQNHYf+OetQ9LHDBAAhk+ab8+WrbS/b1/gYW3q1KDiXU719nCtfkUVXKidW5Ec Idlr5HGt8ilLoxSWT2Zi368iHCXS0WenGgPwlv8ifvB7TOZiiTDZROZkXjEBmU4nYjJ7GymawpWv oQwjMsPuq6ysbzWtOZ7eILx7cI0FjQeJ/Q2baRJub0uAZNwBOxCkAS6lpk5Fntd2u8CWmDQo4SYp xeuQ+pwkp0yEP30RhN2BO2DXiBEGSZSYh+ioGbCHQPIV3iVj0h6lcCPOqopZqyeCfigeacBI0nvN jHWz/spzF3+4OS+3RJvoHtAQmProxyGib8iVsTxgZO3UUi4TSODeEt0i0kHSPY4sCciOyXfAyYoD DFqhRjOEwBBxhr+scU4C1T2AflozvDwq3VSONjrKJUkhd8+WsdXxMdPFgBQuiKKwUy11mz6KQfcR wmDehF3UaUoxa+YIhWPbKmycxuX/D8SvnqavzAeAL1OcRbEI/HsoroVlEFbBRNBZLJUlnTPs8ZcU 4+8rq5YX1GUrJL3jf6SAfSgO7UdkEET3PdcKFYtS+ruV1Cp5V0q4kCfI5jk25iiz8grM2wOzVSsc l1mEkhiEPH87HP0whhb544iioSnumd3HJKL7dzhRegsMizatupp8D65A2JziW0WKopa1iw9fti3A aBeNN4ijKZchBXHPgVx+YtWRHfcm4l8= OpenPGP: url=https://posteo.de/keys/markus.probst@posteo.de.asc; preference=encrypt Add the `led::Mode` trait to allow for other types of led class devices in `led::LedOps`. Signed-off-by: Markus Probst --- rust/kernel/led.rs | 27 +++++++++++++++++++++++---- rust/kernel/led/normal.rs | 22 +++++++++++++++------- 2 files changed, 38 insertions(+), 11 deletions(-) diff --git a/rust/kernel/led.rs b/rust/kernel/led.rs index c92d99d68497..6ee337008db7 100644 --- a/rust/kernel/led.rs +++ b/rust/kernel/led.rs @@ -32,7 +32,10 @@ =20 mod normal; =20 -pub use normal::Device; +pub use normal::{ + Device, + Normal, // +}; =20 /// The name of the led is determined by the driver. pub enum Named {} @@ -161,6 +164,7 @@ pub fn name(self, name: &'a CStr) -> Self { /// #[vtable] /// impl led::LedOps for MyLedOps { /// type Bus =3D platform::Device; +/// type Mode =3D led::Normal; /// const BLOCKING: bool =3D false; /// const MAX_BRIGHTNESS: u32 =3D 255; /// @@ -182,6 +186,11 @@ pub trait LedOps: Send + Sync + Sized { #[allow(private_bounds)] type Bus: AsBusDevice; =20 + /// The led mode to use. + /// + /// See [`Mode`]. + type Mode: Mode; + /// If set true, [`LedOps::brightness_set`] and [`LedOps::blink_set`] = must perform the /// operation immediately. If set false, they must not sleep. const BLOCKING: bool; @@ -194,7 +203,7 @@ pub trait LedOps: Send + Sync + Sized { fn brightness_set<'bound>( &self, dev: &'bound Self::Bus, - classdev: &Device<'bound, Self>, + classdev: &::Device<'bound, Self>, brightness: u32, ) -> Result<()>; =20 @@ -202,7 +211,7 @@ fn brightness_set<'bound>( fn brightness_get<'bound>( &self, dev: &'bound Self::Bus, - classdev: &Device<'bound, Self>, + classdev: &::Device<'bound, Self>, ) -> Result { let _ =3D (dev, classdev); build_error!(VTABLE_DEFAULT_ERROR) @@ -219,7 +228,7 @@ fn brightness_get<'bound>( fn blink_set<'bound>( &self, dev: &'bound Self::Bus, - classdev: &Device<'bound, Self>, + classdev: &::Device<'bound, Self>, delay_on: &mut usize, delay_off: &mut usize, ) -> Result<()> { @@ -283,6 +292,16 @@ fn try_from(value: u32) -> core::result::Result { } } =20 +/// The led mode. +/// +/// Each led mode has its own led class device type with different capabil= ities. +/// +/// See [`Normal`]. +pub trait Mode: private::Sealed { + /// The class device for the led mode. + type Device<'bound, T: LedOps + 'bound>; +} + mod private { pub trait Sealed {} } diff --git a/rust/kernel/led/normal.rs b/rust/kernel/led/normal.rs index 2769f690bb24..9fdef9b18918 100644 --- a/rust/kernel/led/normal.rs +++ b/rust/kernel/led/normal.rs @@ -6,11 +6,19 @@ =20 use super::*; =20 +/// The led mode for the `struct led_classdev`. Leds with this mode can on= ly have a fixed color. +pub enum Normal {} + +impl Mode for Normal { + type Device<'bound, T: LedOps + 'bound> =3D Device<'bou= nd, T>; +} +impl private::Sealed for Normal {} + /// The led class device representation. /// /// This structure represents the Rust abstraction for a led class device. #[pin_data(PinnedDrop)] -pub struct Device<'bound, T: LedOps + 'bound> { +pub struct Device<'bound, T: LedOps + 'bound> { #[pin] ops: T, #[pin] @@ -20,7 +28,7 @@ pub struct Device<'bound, T: LedOps + 'bound> { =20 impl<'a, S: DeviceBuilderState> DeviceBuilder<'a, S> { /// Registers a new [`Device`]. - pub fn build<'bound: 'a, T: LedOps + 'bound>( + pub fn build<'bound: 'a, T: LedOps + 'bound>( self, parent: &'bound T::Bus, ops: impl PinInit + 'a, @@ -87,7 +95,7 @@ pub fn build<'bound: 'a, T: LedOps + 'bound>( } } =20 -impl<'bound, T: LedOps + 'bound> Device<'bound, T> { +impl<'bound, T: LedOps + 'bound> Device<'bound, T> { /// # Safety /// `led_cdev` must be a valid pointer to a `led_classdev` embedded wi= thin a /// `led::Device`. @@ -107,17 +115,17 @@ fn parent(&self) -> &'bound device::Device { } =20 // SAFETY: A `led::Device` can be unregistered from any thread. -unsafe impl<'bound, T: LedOps + 'bound + Send> Send for Device<'bound, T> = {} +unsafe impl<'bound, T: LedOps + 'bound + Send> Send for D= evice<'bound, T> {} =20 // SAFETY: `led::Device` can be shared among threads because all methods o= f `led::Device` // are thread safe. -unsafe impl<'bound, T: LedOps + 'bound + Sync> Sync for Device<'bound, T> = {} +unsafe impl<'bound, T: LedOps + 'bound + Sync> Sync for D= evice<'bound, T> {} =20 struct Adapter { _p: PhantomData, } =20 -impl Adapter { +impl> Adapter { /// # Safety /// `led_cdev` must be a valid pointer to a `led_classdev` embedded wi= thin a /// `led::Device`. @@ -210,7 +218,7 @@ impl Adapter { } =20 #[pinned_drop] -impl<'bound, T: LedOps + 'bound> PinnedDrop for Device<'bound, T> { +impl<'bound, T: LedOps + 'bound> PinnedDrop for Device<'b= ound, T> { fn drop(self: Pin<&mut Self>) { let raw =3D self.classdev.get(); // SAFETY: The existence of `self` guarantees that `self.classdev.= get()` is a pointer to a --=20 2.53.0 From nobody Tue Jun 30 21:38:33 2026 Received: from mout01.posteo.de (mout01.posteo.de [185.67.36.65]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3D41C40DFDE for ; Mon, 29 Jun 2026 13:10:35 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=185.67.36.65 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1782738638; cv=none; b=Wl/Ei+UEU9oS806njDnXT25JNSBvXwtroFouf47CRUe+VEnHgGCWBgv1BNICrlry6VcEwB6nklyI2IODj7tXXkAYRts8TpqKRin4UrJFf9Z/VXFZJ8MduxpwuaprBmOYt3EO9/xv/wmGQKvrMZRTswDozjOsq8A8m+tcqCvZgQU= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1782738638; c=relaxed/simple; bh=RSsYvswDNkPUr03lsAvodf/Y/Pvm8t3EpULz4JWrGcQ=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=CcnrYrx+zJvcHCe/wxy8YWPZUAD6grjBEizcxsspC2FOWV+R5yxByQ4yGKja6nsX1QiUhbWlagXDRDbt2YPUmaO8JX/Uiz+eWn7VET9fTUo1f36gzaQTnKjMmEfTkxENp6V6fjODENCEYZqXHm/F4+c/RFktXLMT0mtk6+D7nec= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=posteo.de; spf=pass smtp.mailfrom=posteo.de; dkim=pass (2048-bit key) header.d=posteo.de header.i=@posteo.de header.b=Xxm4w3mZ; arc=none smtp.client-ip=185.67.36.65 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=posteo.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=posteo.de Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=posteo.de header.i=@posteo.de header.b="Xxm4w3mZ" Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id B2F9B24002A for ; Mon, 29 Jun 2026 15:10:33 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=posteo.de; s=2017; t=1782738633; bh=0qaqqNwBFwkzmDECVhiSzVgfW7P9Nk5HDVgYpAqTmKU=; h=From:Date:Subject:MIME-Version:Content-Type: Content-Transfer-Encoding:Message-Id:To:Cc:Autocrypt:OpenPGP:From; b=Xxm4w3mZnnlHydVkOvx6nshh3IAhc0bUqhav8ESCVXYIgG0+9FwOgX1XWxfZLVbyC e9df3Ftz+JrTwUyCETbXHtnVF4RMd2TLRvXllToYLA91frdMhoOW5a1Yrdf3HmzHdV A5erA/XHbWAETDtQWv5Ez7fyYDjmZ06Tw8L77wf7qw7ERtZDLq3qQlzNwgu+uSlWpN ewKzXazzT43AP8NYXMdeB9TfifnrIn7eMvIHZVq6WUVkRANMH9vsPPdr59leiFXDna 1znTBt9amye9B/552HSmEbZl4fjdat6EBk4G5FRinEqYfZA8ZAgv7w1DXY03bPI3NZ 0W9qvWc1EITfQ== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4gpmqB3QSPz6txY; Mon, 29 Jun 2026 15:10:30 +0200 (CEST) From: Markus Probst Date: Mon, 29 Jun 2026 13:10:32 +0000 Subject: [PATCH v21 3/3] rust: leds: add multicolor classdev abstractions Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Message-Id: <20260629-rust_leds-v21-3-4f0f19579db5@posteo.de> References: <20260629-rust_leds-v21-0-4f0f19579db5@posteo.de> In-Reply-To: <20260629-rust_leds-v21-0-4f0f19579db5@posteo.de> To: Lee Jones , Pavel Machek , Greg Kroah-Hartman , Dave Ertman , Leon Romanovsky , Miguel Ojeda , Alex Gaynor , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , Danilo Krummrich , "Rafael J. Wysocki" , Bjorn Helgaas , =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= , Boqun Feng , Daniel Almeida , Tamir Duberstein , Alexandre Courbot , =?utf-8?q?Onur_=C3=96zkan?= , Ira Weiny , Boqun Feng Cc: rust-for-linux@vger.kernel.org, linux-leds@vger.kernel.org, linux-kernel@vger.kernel.org, linux-pci@vger.kernel.org, Markus Probst X-Developer-Signature: v=1; a=openpgp-sha256; l=23219; i=markus.probst@posteo.de; h=from:subject:message-id; bh=RSsYvswDNkPUr03lsAvodf/Y/Pvm8t3EpULz4JWrGcQ=; b=owEBiQJ2/ZANAwAIATR2H/jnrUPSAcsmYgBqQm6/bXNM25T2PKst3kQl++guFi9G/ReSZk2lf XaMVOrhVr2JAk8EAAEIADkWIQSCdBjE9KxY53IwxHM0dh/4561D0gUCakJuvxsUgAAAAAAEAA5t YW51MiwyLjUrMS4xMiwyLDIACgkQNHYf+OetQ9KQfA//QIiwUd3oZ42e1oIcTd0TWlx0A2sU33x D9Em3G6wEerrfSzii6+mHLe8iQu5ZcAfCUy/j71Gb83gCjKB7XgCL6+9xTdFBmVQwcpDDJu+X/J /9hp9kAA7nJFlOzVKb7GPvhwwhH9aF9wLqOS+//qz+bGxzNqt7Ly0etgIJ/47bgkVu4upsp9GB4 1M4b7wfegv9OMLiuhtrQbZzDINfpmnXq1gdjSVkm3BP/UwYemOHk+kuO2tKz2dBXjV1xtzmWGpw Slm8h1ZUP9j2iynFQv2An9GcV8TFsotPNzjowa6CumHOIVJgCEZHbpiCrXZfVvS+5/vsktbxVX5 Zy3dh9Z0CUYelMWzVFy2hVENARC0nhc/L0HnvFAs1LrZsiZk90IrNKgzlT05oSZzHwlwdxRsnNp 7x7ADwc7rW7AXRP5O0EXcD78/PEmCVcnwX1dVRSfuVWxQnCB9w78WWp6M3YsmMXbhNJMteYuEDg tbeCHY4U3w1NBasyskkrs2u5Z+nRM7YTa/JvyPrX2YQLIRdQZJ1jxdkMnakb2XFVKYlzIUS003k rjcPO1RV8jSZn1x4NQ9Zcryzkr6zlIw+JG70k6TKlprfQuo5P4gcixfWoMyYzwMFnpdlZP2FGin w0oJvY3xh1uCApBULOkiGnrfl6hewETFDdih0rwl+n4vt54V9GYI= X-Developer-Key: i=markus.probst@posteo.de; a=openpgp; fpr=827418C4F4AC58E77230C47334761FF8E7AD43D2 Autocrypt: addr=markus.probst@posteo.de; prefer-encrypt=mutual; keydata=xsFNBGiDvXgBEADAXUceKafpl46S35UmDh2wRvvx+UfZbcTjeQOlSwKP7YVJ4JOZrVs93qReNLkO WguIqPBxR9blQ4nyYrqSCV+MMw/3ifyXIm6Pw2YRUDg+WTEOjTixRCoWDgUj1nOsvJ9tVAm76Ww+ /pAnepVRafMID0rqEfD9oGv1YrfpeFJhyE2zUw3SyyNLIKWD6QeLRhKQRbSnsXhGLFBXCqt9k5JA RhgQof9zvztcCVlT5KVvuyfC4H+HzeGmu9201BVyihJwKdcKPq+n/aY5FUVxNTgtI9f8wIbmfAja oT1pjXSp+dszakA98fhONM98pOq723o/1ZGMZukyXFfsDGtA3BB79HoopHKujLGWAGskzClwTjRQ xBqxh/U/lL1pc+0xPWikTNCmtziCOvv0KA0arDOMQlyFvImzX6oGVgE4ksKQYbMZ3Ikw6L1Rv1J+ FvN0aNwOKgL2ztBRYscUGcQvA0Zo1fGCAn/BLEJvQYShWKeKqjyncVGoXFsz2AcuFKe1pwETSsN6 OZncjy32e4ktgs07cWBfx0v62b8md36jau+B6RVnnodaA8++oXl3FRwiEW8XfXWIjy4umIv93tb8 8ekYsfOfWkTSewZYXGoqe4RtK80ulMHb/dh2FZQIFyRdN4HOmB4FYO5sEYFr9YjHLmDkrUgNodJC XCeMe4BO4iaxUQARAQABzRdtYXJrdXMucHJvYnN0QHBvc3Rlby5kZcLBkQQTAQgAOxYhBIJ0GMT0 rFjncjDEczR2H/jnrUPSBQJog714AhsDBQsJCAcCAiICBhUKCQgLAgQWAgMBAh4HAheAAAoJEDR2 H/jnrUPSgdkQAISaTk2D345ehXEkn5z2yUEjaVjHIE7ziqRaOgn/QanCgeTUinIv6L6QXUFvvIfH 1OLPwQ1hfvEg9NnNLyFezWSy6jvoVBTIPqicD/r3FkithnQ1IDkdSjrarPMxJkvuh3l7XZHo49GV HQ8i5zh5w4YISrcEtE99lJisvni2Jqx7we5tey9voQFDyM8jxlSWv3pmoUTCtBkX/eKHJXosgsuS B4TGDCVPOjla/emI5c9MhMG7O4WEEmoSdPbmraPw66YZD6uLyhV4DPHbiDWRzXWnClHSyjB9rky9 lausFxogvu4l9H+KDsXIadNDWdLdu1/enS/wDd9zh5S78rY2jeXaG4mnf4seEKamZ7KQ6FIHrcyP ezdDzssPQcTQcGRMQzCn6wP3tlGk7rsfmyHMlFqdRoNNv+ZER/OkmZFPW655zRfbMi0vtrqK2Awm 9ggobb1oktfd9PPNXMUY+DNVlgR2G7jLnenSoQausLUm0pHoNE8TWFv851Y6SOYnvn488sP1Tki5 F3rKwclawQFHUXTCQw+QSh9ay8xgnNZfH+u9NY7w3gPoeKBOAFcBc2BtzcgekeWS8qgEmm2/oNFV G0ivPQbRx8FjRKbuF7g3YhgNZZ0ac8FneuUtJ2PkSIFTZhaAiC0utvxk0ndmWFiW4acEkMZGrLaM L2zWNjrqwsD2zsFNBGiDvXgBEADCXQy1n7wjRxG12DOVADawjghKcG+5LtEf31WftHKLFbp/HArj BhkT6mj+CCI1ClqY+FYU5CK/s0ScMfLxRGLZ0Ktzawb78vOgBVFT3yB1yWBTewsAXdqNqRooaUNo 8cG/NNJLjhccH/7PO/FWX5qftOVUJ/AIsAhKQJ18Tc8Ik73v427EDxuKb9mTAnYQFA3Ev3hAiVbO 6Rv39amVOfJ8sqwiSUGidj2Fctg2aB5JbeMln0KCUbTD1LhEFepeKypfofAXQbGwaCjAhmkWy/q3 IT1mUrPxOngbxdRoOx1tGUC0HCMUW1sFaJgQPMmDcR0JGPOpgsKnitsSnN7ShcCr1buel7vLnUMD +TAZ5opdoF6HjAvAnBQaijtK6minkrM0seNXnCg0KkV8xhMNa6zCs1rq4GgjNLJue2EmuyHooHA4 7JMoLVHcxVeuNTp6K2+XRx0Pk4e2Lj8IVy9yEYyrywEOC5XRW37KJjsiOAsumi1rkvM7QREWgUDe Xs0+RpxI3QrrANh71fLMRo7LKRF3Gvw13NVCCC9ea20P4PwhgWKStkwO2NO+YJsAoS1QycMi/vKu 0EHhknYXamaSV50oZzHKmX56vEeJHTcngrM8R1SwJCYopCx9gkz90bTVYlitJa5hloWTYeMD7FNj Y6jfVSzgM/K4gMgUNDW/PPGeMwARAQABwsF2BBgBCAAgFiEEgnQYxPSsWOdyMMRzNHYf+OetQ9IF AmiDvXgCGwwACgkQNHYf+OetQ9LHDBAAhk+ab8+WrbS/b1/gYW3q1KDiXU719nCtfkUVXKidW5Ec Idlr5HGt8ilLoxSWT2Zi368iHCXS0WenGgPwlv8ifvB7TOZiiTDZROZkXjEBmU4nYjJ7GymawpWv oQwjMsPuq6ysbzWtOZ7eILx7cI0FjQeJ/Q2baRJub0uAZNwBOxCkAS6lpk5Fntd2u8CWmDQo4SYp xeuQ+pwkp0yEP30RhN2BO2DXiBEGSZSYh+ioGbCHQPIV3iVj0h6lcCPOqopZqyeCfigeacBI0nvN jHWz/spzF3+4OS+3RJvoHtAQmProxyGib8iVsTxgZO3UUi4TSODeEt0i0kHSPY4sCciOyXfAyYoD DFqhRjOEwBBxhr+scU4C1T2AflozvDwq3VSONjrKJUkhd8+WsdXxMdPFgBQuiKKwUy11mz6KQfcR wmDehF3UaUoxa+YIhWPbKmycxuX/D8SvnqavzAeAL1OcRbEI/HsoroVlEFbBRNBZLJUlnTPs8ZcU 4+8rq5YX1GUrJL3jf6SAfSgO7UdkEET3PdcKFYtS+ruV1Cp5V0q4kCfI5jk25iiz8grM2wOzVSsc l1mEkhiEPH87HP0whhb544iioSnumd3HJKL7dzhRegsMizatupp8D65A2JziW0WKopa1iw9fti3A aBeNN4ijKZchBXHPgVx+YtWRHfcm4l8= OpenPGP: url=https://posteo.de/keys/markus.probst@posteo.de.asc; preference=encrypt Implement the abstractions needed for multicolor led class devices, including: * `led::MultiColor` - the led mode implementation * `MultiColorSubLed` - a safe wrapper arround `mc_subled` * `led::MultiColorDevice` - a safe wrapper around `led_classdev_mc` * `led::DeviceBuilder::build_multicolor` - a function to register a new multicolor led class device Signed-off-by: Markus Probst --- rust/bindings/bindings_helper.h | 1 + rust/kernel/led.rs | 34 ++- rust/kernel/led/multicolor.rs | 460 ++++++++++++++++++++++++++++++++++++= ++++ 3 files changed, 494 insertions(+), 1 deletion(-) diff --git a/rust/bindings/bindings_helper.h b/rust/bindings/bindings_helpe= r.h index 1124785e210b..821f539e597e 100644 --- a/rust/bindings/bindings_helper.h +++ b/rust/bindings/bindings_helper.h @@ -68,6 +68,7 @@ #include #include #include +#include #include #include #include diff --git a/rust/kernel/led.rs b/rust/kernel/led.rs index 6ee337008db7..4540c4e5c9d7 100644 --- a/rust/kernel/led.rs +++ b/rust/kernel/led.rs @@ -30,8 +30,16 @@ types::Opaque, // }; =20 +#[cfg(CONFIG_LEDS_CLASS_MULTICOLOR)] +mod multicolor; mod normal; =20 +#[cfg(CONFIG_LEDS_CLASS_MULTICOLOR)] +pub use multicolor::{ + MultiColor, + MultiColorDevice, + MultiColorSubLed, // +}; pub use normal::{ Device, Normal, // @@ -255,7 +263,24 @@ pub enum Color { Violet =3D bindings::LED_COLOR_ID_VIOLET, Yellow =3D bindings::LED_COLOR_ID_YELLOW, Ir =3D bindings::LED_COLOR_ID_IR, + #[cfg_attr( + CONFIG_LEDS_CLASS_MULTICOLOR, + doc =3D "Use this color for a [`MultiColor`] led." + )] + #[cfg_attr( + not(CONFIG_LEDS_CLASS_MULTICOLOR), + doc =3D "Use this color for a `MultiColor` led." + )] + /// If the led supports RGB, use [`Color::Rgb`] instead. Multi =3D bindings::LED_COLOR_ID_MULTI, + #[cfg_attr( + CONFIG_LEDS_CLASS_MULTICOLOR, + doc =3D "Use this color for a [`MultiColor`] led with rgb support." + )] + #[cfg_attr( + not(CONFIG_LEDS_CLASS_MULTICOLOR), + doc =3D "Use this color for a `MultiColor` led with rgb support." + )] Rgb =3D bindings::LED_COLOR_ID_RGB, Purple =3D bindings::LED_COLOR_ID_PURPLE, Orange =3D bindings::LED_COLOR_ID_ORANGE, @@ -296,7 +321,14 @@ fn try_from(value: u32) -> core::result::Result { /// /// Each led mode has its own led class device type with different capabil= ities. /// -/// See [`Normal`]. +#[cfg_attr( + CONFIG_LEDS_CLASS_MULTICOLOR, + doc =3D "See [`Normal`] and [`MultiColor`]." +)] +#[cfg_attr( + not(CONFIG_LEDS_CLASS_MULTICOLOR), + doc =3D "See [`Normal`] and `MultiColor`." +)] pub trait Mode: private::Sealed { /// The class device for the led mode. type Device<'bound, T: LedOps + 'bound>; diff --git a/rust/kernel/led/multicolor.rs b/rust/kernel/led/multicolor.rs new file mode 100644 index 000000000000..2c55140dd37e --- /dev/null +++ b/rust/kernel/led/multicolor.rs @@ -0,0 +1,460 @@ +// SPDX-License-Identifier: GPL-2.0 + +//! Led mode for the `struct led_classdev_mc`. +//! +//! C header: [`include/linux/led-class-multicolor.h`](srctree/include/lin= ux/led-class-multicolor.h) + +use core::{ + cell::UnsafeCell, + num::NonZero, + ptr, // +}; + +use crate::types::ScopeGuard; + +use super::*; + +/// The led mode for the `struct led_classdev_mc`. Leds with this mode can= have multiple colors. +pub enum MultiColor {} +impl Mode for MultiColor { + type Device<'bound, T: LedOps + 'bound> =3D MultiColorD= evice<'bound, T>; +} +impl private::Sealed for MultiColor {} + +/// The multicolor sub led info representation. +/// +/// This structure represents the Rust abstraction for a C `struct mc_subl= ed`. +#[repr(C)] +#[derive(Debug)] +#[non_exhaustive] +pub struct MultiColorSubLed { + /// The color of the sub led + pub color: Color, + brightness: UnsafeCell, + intensity: UnsafeCell, + /// The maximum supported intensity value. + /// + /// If None the maximum intensity equals to [`LedOps::MAX_BRIGHTNESS`]. + pub max_intensity: Option>, + /// Arbitrary data for the driver to store. + pub channel: u32, +} + +// SAFETY: `MultiColorSubLed` can be shared among threads. +unsafe impl Sync for MultiColorSubLed {} + +impl Clone for MultiColorSubLed { + fn clone(&self) -> Self { + Self { + color: self.color, + brightness: self.brightness().into(), + intensity: self.intensity().into(), + max_intensity: self.max_intensity, + channel: self.channel, + } + } +} + +// We directly pass a reference to the `subled_info` field in `led_classde= v_mc` to the driver via +// `Device::subleds()`. +// We need safeguards to ensure `MultiColorSubLed` and `mc_subled` stay id= entical. +const _: () =3D { + use core::mem::offset_of; + + const fn assert_same_type(_: &T, _: &T) {} + + let rust_zeroed =3D MultiColorSubLed { + color: Color::White, + brightness: UnsafeCell::new(0), + intensity: UnsafeCell::new(0), + max_intensity: None, + channel: 0, + }; + let c_zeroed =3D bindings::mc_subled { + color_index: 0, + brightness: 0, + intensity: 0, + max_intensity: 0, + channel: 0, + }; + + assert!(offset_of!(MultiColorSubLed, color) =3D=3D offset_of!(bindings= ::mc_subled, color_index)); + assert!( + offset_of!(MultiColorSubLed, brightness) =3D=3D offset_of!(binding= s::mc_subled, brightness) + ); + assert!(offset_of!(MultiColorSubLed, intensity) =3D=3D offset_of!(bind= ings::mc_subled, intensity)); + assert!( + offset_of!(MultiColorSubLed, max_intensity) + =3D=3D offset_of!(bindings::mc_subled, max_intensity) + ); + assert!(offset_of!(MultiColorSubLed, channel) =3D=3D offset_of!(bindin= gs::mc_subled, channel)); + + assert_same_type(&0u32, &c_zeroed.color_index); + assert_same_type(&rust_zeroed.brightness.into_inner(), &c_zeroed.brigh= tness); + assert_same_type(&rust_zeroed.intensity.into_inner(), &c_zeroed.intens= ity); + assert!(size_of_val(&rust_zeroed.max_intensity) =3D=3D size_of_val(&c_= zeroed.max_intensity)); + assert_same_type(&rust_zeroed.channel, &c_zeroed.channel); + + assert!(size_of::() =3D=3D size_of::()); +}; + +impl MultiColorSubLed { + /// Create a new multicolor sub led info. + #[inline] + pub const fn new(color: Color) -> Self { + Self { + color, + brightness: UnsafeCell::new(0), + intensity: UnsafeCell::new(0), + max_intensity: None, + channel: 0, + } + } + + /// Set arbitrary data for the driver. + #[inline] + pub const fn channel(mut self, channel: u32) -> Self { + self.channel =3D channel; + self + } + + /// Set the initial intensity of the subled. + #[inline] + pub const fn initial_intensity(mut self, intensity: u32) -> Self { + self.intensity =3D UnsafeCell::new(intensity); + self + } + + /// Set the maximum supported intensity of the subled. + #[inline] + pub const fn max_intensity(mut self, max_intensity: NonZero) -> S= elf { + self.max_intensity =3D Some(max_intensity); + self + } + + /// The intensity of the sub led. + #[inline] + pub const fn intensity(&self) -> u32 { + // SAFETY: + // - `self.intensity.get()` is a valid pointer to `u32`. + // - We don't have exclusive or immutable access to `self.intensit= y`, + // but the alignment should prevent "load tearing". + unsafe { *self.intensity.get() } + } + + /// The brightness of the sub led. + #[inline] + pub const fn brightness(&self) -> u32 { + // SAFETY: + // - `self.brightness.get()` is a valid pointer to `u32`. + // - We don't have exclusive or immutable access to `self.brightne= ss`, + // but the alignment should prevent "load tearing". + unsafe { *self.brightness.get() } + } +} + +/// The multicolor led class device representation. +/// +/// This structure represents the Rust abstraction for a multicolor led cl= ass device. +#[pin_data(PinnedDrop)] +pub struct MultiColorDevice<'bound, T: LedOps + 'boun= d> { + #[pin] + ops: T, + #[pin] + classdev: Opaque, + _p: PhantomData<&'bound ()>, +} + +impl<'a, S: DeviceBuilderState> DeviceBuilder<'a, S> { + /// Registers a new [`MulticolorDevice`]. + pub fn build_multicolor<'bound: 'a, T: LedOps + '= bound>( + self, + parent: &'bound T::Bus, + ops: impl PinInit + 'a, + subleds: &'a [MultiColorSubLed], + ) -> impl PinInit, Error> + 'a { + const_assert!(T::MAX_BRIGHTNESS <=3D i32::MAX.unsigned_abs() || !T= ::HAS_BRIGHTNESS_GET); + + try_pin_init!(MultiColorDevice { + ops <- ops, + classdev <- Opaque::try_ffi_init(|ptr: *mut bindings::led_clas= sdev_mc| { + let mut colors =3D [false; bindings::LED_COLOR_ID_MAX as u= size]; + for subled in subleds { + if colors[subled.color as usize] { + dev_err!(parent.as_ref(), "duplicate color in mult= icolor led\n"); + return Err(EINVAL); + } + colors[subled.color as usize] =3D true; + } + let subleds_box =3D KBox::pin_slice( + |index| Ok::<_, Error>(subleds[index].clone()), + subleds.len(), + GFP_KERNEL, + )?; + let subleds_box_raw =3D KBox::into_raw(Pin::into_inner(sub= leds_box)); + + let subled_guard =3D ScopeGuard::new(|| { + // SAFETY: `subleds_box_raw` is guaranteed to be a val= id pointer to + // `[MultiColorSubLed]`. + drop(unsafe { >::from_raw(sub= leds_box_raw) }); + }); + + // SAFETY: `try_ffi_init` guarantees that `ptr` is valid f= or write. + // `led_classdev_mc` gets fully initialized in-place by + // `led_classdev_multicolor_register_ext` including `mutex= ` and `list_head`. + unsafe { + ptr.write(bindings::led_classdev_mc { + led_cdev: bindings::led_classdev { + brightness_set: (!T::BLOCKING) + .then_some(Adapter::::brightness_set_ca= llback), + brightness_set_blocking: T::BLOCKING + .then_some(Adapter::::brightness_set_bl= ocking_callback), + brightness_get: T::HAS_BRIGHTNESS_GET + .then_some(Adapter::::brightness_get_ca= llback), + blink_set: T::HAS_BLINK_SET.then_some(Adapter:= :::blink_set_callback), + max_brightness: T::MAX_BRIGHTNESS, + brightness: self.initial_brightness, + color: self.color as u32, + name: self.name.map_or(core::ptr::null(), CStr= Ext::as_char_ptr), + ..bindings::led_classdev::default() + }, + num_colors: u32::try_from(subleds_box_raw.len())?, + // CAST: The safeguards in the const block ensure = that + // `MultiColorSubLed` has an identical layout to `= mc_subled`. + subled_info: subleds_box_raw.cast::(), + }) + }; + + let mut init_data =3D bindings::led_init_data { + fwnode: self + .fwnode + .as_ref() + .map_or(core::ptr::null_mut(), |fwnode| fwnode.as_= raw()), + default_label: core::ptr::null(), + devicename: self + .devicename + .map_or(core::ptr::null(), CStrExt::as_char_ptr), + devname_mandatory: self.devname_mandatory, + }; + + // SAFETY: + // - `parent.as_ref().as_raw()` is guaranteed to be a poin= ter to a valid + // `device`. + // - `ptr` is guaranteed to be a pointer to an initialized= `led_classdev_mc`. + to_result(unsafe { + bindings::led_classdev_multicolor_register_ext( + parent.as_ref().as_raw(), + ptr, + if self.name.is_none() { + &raw mut init_data + } else { + core::ptr::null_mut() + }, + ) + })?; + + subled_guard.dismiss(); + + core::mem::forget(self.fwnode); // keep the reference coun= t incremented + + Ok::<_, Error>(()) + }), + _p: PhantomData, + }) + } +} + +impl<'bound, T: LedOps + 'bound> MultiColorDevice<'bo= und, T> { + /// # Safety + /// `led_cdev` must be a valid pointer to a `led_classdev` embedded wi= thin a + /// `led::MultiColorDevice`. + #[inline] + unsafe fn from_raw<'a>(led_cdev: *mut bindings::led_classdev) -> &'a S= elf { + // SAFETY: The function's contract guarantees that `led_cdev` poin= ts to a `led_classdev` + // field embedded within a valid `led::MultiColorDevice`. `contain= er_of!` can therefore + // safely calculate the address of the containing struct. + let led_mc_cdev =3D unsafe { container_of!(led_cdev, bindings::led= _classdev_mc, led_cdev) }; + + // SAFETY: It is guaranteed that `led_mc_cdev` points to a `led_cl= assdev_mc` + // field embedded within a valid `led::MultiColorDevice`. `contain= er_of!` can therefore + // safely calculate the address of the containing struct. + unsafe { &*container_of!(Opaque::cast_from(led_mc_cdev), Self, cla= ssdev) } + } + + #[inline] + fn parent(&self) -> &'bound device::Device { + // SAFETY: `self.classdev.get()` is guaranteed to be a valid point= er to `led_classdev_mc`. + unsafe { device::Device::from_raw((*(*self.classdev.get()).led_cde= v.dev).parent) } + } + + /// Returns the subleds passed to [`Device::new_multicolor`]. + #[inline] + pub fn subleds(&self) -> &[MultiColorSubLed] { + // SAFETY: The existence of `self` guarantees that `self.classdev.= get()` is a pointer to a + // valid `led_classdev_mc`. + let raw =3D unsafe { &*self.classdev.get() }; + // SAFETY: `raw.subled_info` is a valid pointer to `mc_subled[num_= colors]`. + // CAST: The safeguards in the const block ensure that `MultiColor= SubLed` has an identical + // layout to `mc_subled`. + unsafe { + core::slice::from_raw_parts( + raw.subled_info.cast::(), + // CAST: It is guaranteed that `num_colors` fits into an `= usize`. + raw.num_colors as usize, + ) + } + } +} + +// SAFETY: A `led::MultiColorDevice` can be unregistered from any thread. +unsafe impl<'bound, T: LedOps + 'bound + Send> Send + for MultiColorDevice<'bound, T> +{ +} + +// SAFETY: `led::MultiColorDevice` can be shared among threads because all= methods of `led::Device` +// are thread safe. +unsafe impl<'bound, T: LedOps + 'bound + Sync> Sync + for MultiColorDevice<'bound, T> +{ +} + +struct Adapter> { + _p: PhantomData, +} + +impl> Adapter { + /// # Safety + /// `led_cdev` must be a valid pointer to a `led_classdev` embedded wi= thin a + /// `led::MultiColorDevice`. + /// This function is called on setting the brightness of a led. + unsafe extern "C" fn brightness_set_callback( + led_cdev: *mut bindings::led_classdev, + brightness: u32, + ) { + // SAFETY: The function's contract guarantees that `led_cdev` is a= valid pointer to a + // `led_classdev` embedded within a `led::MultiColorDevice`. + let classdev =3D unsafe { MultiColorDevice::::from_raw(led_cdev= ) }; + // SAFETY: `classdev.parent()` is guaranteed to be contained in `T= ::Bus`. + let parent =3D unsafe { T::Bus::from_device(classdev.parent()) }; + + // SAFETY: `classdev.classdev.get()` is guaranteed to be a pointer= to a valid + // `led_classdev_mc`. + unsafe { bindings::led_mc_calc_color_components(classdev.classdev.= get(), brightness) }; + + let _ =3D classdev.ops.brightness_set(parent, classdev, brightness= ); + } + + /// # Safety + /// `led_cdev` must be a valid pointer to a `led_classdev` embedded wi= thin a + /// `led::MultiColorDevice`. + /// This function is called on setting the brightness of a led immedia= tely. + unsafe extern "C" fn brightness_set_blocking_callback( + led_cdev: *mut bindings::led_classdev, + brightness: u32, + ) -> i32 { + from_result(|| { + // SAFETY: The function's contract guarantees that `led_cdev` = is a valid pointer to a + // `led_classdev` embedded within a `led::MultiColorDevice`. + let classdev =3D unsafe { MultiColorDevice::::from_raw(led_= cdev) }; + // SAFETY: `classdev.parent()` is guaranteed to be contained i= n `T::Bus`. + let parent =3D unsafe { T::Bus::from_device(classdev.parent())= }; + + // SAFETY: `classdev.classdev.get()` is guaranteed to be a poi= nter to a valid + // `led_classdev_mc`. + unsafe { bindings::led_mc_calc_color_components(classdev.class= dev.get(), brightness) }; + + classdev.ops.brightness_set(parent, classdev, brightness)?; + Ok(0) + }) + } + + /// # Safety + /// `led_cdev` must be a valid pointer to a `led_classdev` embedded wi= thin a + /// `led::MultiColorDevice`. + /// This function is called on getting the brightness of a led. + unsafe extern "C" fn brightness_get_callback(led_cdev: *mut bindings::= led_classdev) -> u32 { + // SAFETY: The function's contract guarantees that `led_cdev` is a= valid pointer to a + // `led_classdev` embedded within a `led::MultiColorDevice`. + let classdev =3D unsafe { MultiColorDevice::::from_raw(led_cdev= ) }; + // SAFETY: `classdev.parent()` is guaranteed to be contained in `T= ::Bus`. + let parent =3D unsafe { T::Bus::from_device(classdev.parent()) }; + + // CAST: Resulting value will be casted back to i32 in the led sub= system. + from_result(|| { + classdev + .ops + .brightness_get(parent, classdev) + .inspect(|val| debug_assert!(*val <=3D T::MAX_BRIGHTNESS)) + .and_then(|val| Ok(i32::try_from(val)?)) + }) as u32 + } + + /// # Safety + /// `led_cdev` must be a valid pointer to a `led_classdev` embedded wi= thin a + /// `led::MultiColorDevice`. + /// `delay_on` and `delay_off` must be valid pointers to `usize` and h= ave + /// exclusive access for the period of this function. + /// This function is called on enabling hardware accelerated blinking. + unsafe extern "C" fn blink_set_callback( + led_cdev: *mut bindings::led_classdev, + delay_on: *mut usize, + delay_off: *mut usize, + ) -> i32 { + from_result(|| { + // SAFETY: The function's contract guarantees that `led_cdev` = is a valid pointer to a + // `led_classdev` embedded within a `led::MultiColorDevice`. + let classdev =3D unsafe { MultiColorDevice::::from_raw(led_= cdev) }; + // SAFETY: `classdev.parent()` is guaranteed to be contained i= n `T::Bus`. + let parent =3D unsafe { T::Bus::from_device(classdev.parent())= }; + + classdev.ops.blink_set( + parent, + classdev, + // SAFETY: The function's contract guarantees that `delay_= on` points to a `usize` + // and is exclusive for the period of this function. + unsafe { &mut *delay_on }, + // SAFETY: The function's contract guarantees that `delay_= off` points to a `usize` + // and is exclusive for the period of this function. + unsafe { &mut *delay_off }, + )?; + Ok(0) + }) + } +} + +#[pinned_drop] +impl<'bound, T: LedOps + 'bound> PinnedDrop for Multi= ColorDevice<'bound, T> { + fn drop(self: Pin<&mut Self>) { + let raw =3D self.classdev.get(); + // SAFETY: The existence of `self` guarantees that `self.classdev.= get()` is a pointer to a + // valid `led_classdev_mc`. + let dev: &device::Device =3D unsafe { device::Device::from_raw((*r= aw).led_cdev.dev) }; + + let _fwnode =3D dev + .fwnode() + // SAFETY: the reference count of `fwnode` has previously been + // incremented in `led::DeviceBuilder::build_multicolor`. + .map(|fwnode| unsafe { ARef::from_raw(NonNull::from(fwnode)) }= ); + + // SAFETY: The existence of `self` guarantees that `self.classdev`= has previously been + // successfully registered with `led_classdev_multicolor_register_= ext`. + unsafe { bindings::led_classdev_multicolor_unregister(raw) }; + + // SAFETY: `raw` is guaranteed to be a valid pointer to `led_class= dev_mc`. + let led_cdev =3D unsafe { &*raw }; + + // SAFETY: `led_cdev.subled_info` is guaranteed to be a valid poin= ter to + // `[MultiColorSubLed]` with length of `led_cdev.num_colors`. + // See `led::DeviceBuilder::build_multicolor`. + drop(unsafe { + KBox::from_raw(ptr::slice_from_raw_parts_mut( + led_cdev.subled_info.cast::(), + // CAST: `num_colors` was originally converted from a `usi= ze` in + // `DeviceBuilder::build_multicolor`. Thus it is guarantee= d that + // `num_colors` fits into an usize. + led_cdev.num_colors as usize, + )) + }); + } +} --=20 2.53.0