From mboxrd@z Thu Jan 1 00:00:00 1970 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 7066838BF76 for ; Sat, 11 Apr 2026 15:07:29 +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=1775920054; cv=none; b=GJMEu+ZqLvbNemHjSIFtD5spiNRp4CGN1KkQpsNNtHxIRE5/ujkBb6n+oMv5IXaczi9Ss9EhnSOBxP1eTvXj7vIR8vIySXu0SaKFcvjEkpJk+m50htIFYq5xQ7O2KtiLPaUR20J7+emD2YGFrcSczMGEX0IrTD3VS8waXbz9A1E= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1775920054; c=relaxed/simple; bh=QszL5h+d6vPaxLBAga1TpkkS1WCcrkx/YPuiAjd2t8g=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=kw8TBhjARjIkUb6rlQqOkp9zOTAmXb/Y4TK+ACiaJhP7z6oNDGWuwCixTdk9lX9yp01OpczmywiEoV1UL8/pyIzbam3uF7vjpOkXws6/U38qFJ/7AtIegDupWrriIXplQ0Yb3qTO8i/u41bcSzNu49TBKLnH3f6RGBA6OaIhwCY= 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=ZyZl9qfW; 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="ZyZl9qfW" Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id 5790C240105 for ; Sat, 11 Apr 2026 17:07:22 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=posteo.de; s=2017; t=1775920042; bh=ob5H5TwWOONtZftnmE6ueXsm851pZ2y3oWQVGbRPC0g=; h=From:Date:Subject:MIME-Version:Content-Type: Content-Transfer-Encoding:Message-Id:To:Cc:Autocrypt:OpenPGP:From; b=ZyZl9qfWBlfICt4wRx4kLy+2gEe99hGzp04NPDn1VqSLb8AJLbh7unl1S3X3bkqsP sCcO4JPCKXjB+EIgGjfV7H6dwi3rXvb7MP4NKu7ke7QYuAkGBiW3VOk8GlHB4WvlNi opdfbLNiVioq+NCNOnv2Pom9bMuhj9MdNEoLKJ0ohJK3Y2CUM/QVDP/hkpSKBKVwWx nH01+4SvNRo8ui+zy1l6qN5MlYzB/rOlA7fLd8y1gyj8SGKQ6aCYD+ijJCzhNmrwhn viBC4GHizX1mU7ZKvkDS9cJ++9L4lWEUSDAYyntHW+excaL6BusEBTKWVrq15ieDIo AbQ922uG6wlVg== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4ftH8R4ywFz9rxD; Sat, 11 Apr 2026 17:07:19 +0200 (CEST) From: Markus Probst Date: Sat, 11 Apr 2026 15:07:21 +0000 Subject: [PATCH RESEND v13 1/3] rust: leds: add basic led classdev abstractions Precedence: bulk X-Mailing-List: rust-for-linux@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20260411-rust_leds-v13-1-1208a2821deb@posteo.de> References: <20260411-rust_leds-v13-0-1208a2821deb@posteo.de> In-Reply-To: <20260411-rust_leds-v13-0-1208a2821deb@posteo.de> To: Lee Jones , Pavel Machek , Greg Kroah-Hartman , Dave Ertman , Ira Weiny , 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 , 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=20773; i=markus.probst@posteo.de; h=from:subject:message-id; bh=QszL5h+d6vPaxLBAga1TpkkS1WCcrkx/YPuiAjd2t8g=; b=owEBiQJ2/ZANAwAIATR2H/jnrUPSAcsmYgBp2mOlkQu9b6Ljpn0xh05BWXClw/gSDhuyqhSo3 bre4p2uEimJAk8EAAEIADkWIQSCdBjE9KxY53IwxHM0dh/4561D0gUCadpjpRsUgAAAAAAEAA5t YW51MiwyLjUrMS4xMiwyLDIACgkQNHYf+OetQ9JPIg/7BQ45TVs0lEAPsOx1Vz7hNDiXNatJl9h Ecsu9P7AJ2DJFJzlLtMJuZENmwuueNYfa01Qamws1Aw3PACISgEUJCsE0jR5oVBbd1hCh6khrcV vuQbUK6L7QMm3zYYI0WWw7J8nGLMGYwCnMu0RWN6vfx44WWXlxJ4luMhUwBN5/335mbg3j+s0lL oQt/DYkQWBeZGMHG/33Xk4hmc2eMVQUeGGPVy9znXZpOW70iDhF47f21amnmTeSxaXDCIS8+f+j mCTxGSTTIj8G4tJoyO2A0DvNcejQ/elDXXH4+7eTB5vLEH4JkagwgPfXRd2CY5zGeDvl2vCKvK0 oEkD4RqxqbHsWdqx5eDDNvFu9nvvb1/DJmpe9dk/GNtsgdM8q+N5GFfSXSjBO5ajbs/m9zuBnWn lw00gPnLjOUK/yaXhMWVAKe68QJbIbiou5vo/1SVVcXSYdiebcEmz3TFhoUJwJSq9RZQJqueW3/ uL4NguqYrHLUJ2FvYq4MzN9ng5DGpJdD018aBk1xXQTnqWSFFPOJ+nyhDMCwZ3/+iY/duQNyQS/ nedY6IdsVfO/RyBBP7dDe3j4XllMawaW+WJTkekwx5+tKcJ8h7tWJmeujH6W7/NLDYkIqHZJa/Q KS3eFeALuUaGYOYScMQilVROzmNlFzP0FxnESCaw3FytK2YZQLrU= 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 | 310 ++++++++++++++++++++++++++++++++++++++++++++++ rust/kernel/led/normal.rs | 223 +++++++++++++++++++++++++++++++++ rust/kernel/lib.rs | 1 + 4 files changed, 542 insertions(+) diff --git a/MAINTAINERS b/MAINTAINERS index 7d10988cbc62..83b5a45de729 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -14439,6 +14439,14 @@ F: drivers/leds/ F: include/dt-bindings/leds/ F: include/linux/leds.h +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..1fba512a804c --- /dev/null +++ b/rust/kernel/led.rs @@ -0,0 +1,310 @@ +// 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, // + }, + devres::Devres, + error::{ + from_result, + to_result, + VTABLE_DEFAULT_ERROR, // + }, + macros::vtable, + prelude::*, + str::CStrExt, + types::{ + ARef, + 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, + default_trigger: Option<&'a CStr>, + color: Color, + _p: PhantomData, +} + +impl DeviceBuilder<'static, S> { + /// Creates a new [`DeviceBuilder`]. + #[inline] + #[expect( + clippy::new_without_default, + reason = "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, + default_trigger: None, + 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 ignored. + #[inline] + pub fn initial_brightness(self, brightness: u32) -> Self { + Self { + initial_brightness: brightness, + ..self + } + } + + /// Set the default led trigger. + /// + /// This value can be overwritten by the "linux,default-trigger" fwnode property. + #[inline] + pub fn default_trigger(self, trigger: &'a CStr) -> Self { + Self { + default_trigger: Some(trigger), + ..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 = platform::Device; +/// const BLOCKING: bool = false; +/// const MAX_BRIGHTNESS: u32 = 255; +/// +/// fn brightness_set( +/// &self, +/// _dev: &platform::Device, +/// _classdev: &led::Device, +/// _brightness: u32 +/// ) -> Result<()> { +/// // Set the brightness for the led here +/// Ok(()) +/// } +/// } +/// +/// fn register_my_led( +/// parent: &platform::Device, +/// ) -> Result>>>> { +/// KBox::pin_init(led::DeviceBuilder::new() +/// .name(c"white:test") +/// .build( +/// parent, +/// Ok(MyLedOps), +/// ), GFP_KERNEL) +/// } +/// ``` +/// Led drivers must implement this trait in order to register and handle a [`Device`]. +#[vtable] +pub trait LedOps: Send + 'static + 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( + &self, + dev: &Self::Bus, + classdev: &Device, + brightness: u32, + ) -> Result<()>; + + /// Gets the current brightness level. + fn brightness_get(&self, dev: &Self::Bus, classdev: &Device) -> u32 { + let _ = (dev, classdev); + build_error!(VTABLE_DEFAULT_ERROR) + } + + /// Activates hardware accelerated blinking. + /// + /// delays are in milliseconds. If both are zero, a sensible default should 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 hardware accelerated + /// blinking. + /// + /// See also [`LedOps::BLOCKING`]. + fn blink_set( + &self, + dev: &Self::Bus, + classdev: &Device, + delay_on: &mut usize, + delay_off: &mut usize, + ) -> Result<()> { + let _ = (dev, classdev, delay_on, delay_off); + build_error!(VTABLE_DEFAULT_ERROR) + } +} + +/// Led colors. +#[derive(Copy, Clone, Debug, Default)] +#[repr(u32)] +#[non_exhaustive] +#[expect( + missing_docs, + reason = "it shouldn't be necessary to document each color" +)] +pub enum Color { + #[default] + White = bindings::LED_COLOR_ID_WHITE, + Red = bindings::LED_COLOR_ID_RED, + Green = bindings::LED_COLOR_ID_GREEN, + Blue = bindings::LED_COLOR_ID_BLUE, + Amber = bindings::LED_COLOR_ID_AMBER, + Violet = bindings::LED_COLOR_ID_VIOLET, + Yellow = bindings::LED_COLOR_ID_YELLOW, + Ir = bindings::LED_COLOR_ID_IR, + Multi = bindings::LED_COLOR_ID_MULTI, + Rgb = bindings::LED_COLOR_ID_RGB, + Purple = bindings::LED_COLOR_ID_PURPLE, + Orange = bindings::LED_COLOR_ID_ORANGE, + Pink = bindings::LED_COLOR_ID_PINK, + Cyan = bindings::LED_COLOR_ID_CYAN, + Lime = bindings::LED_COLOR_ID_LIME, +} +static_assert!(bindings::LED_COLOR_ID_MAX == 15); + +impl Color { + /// Name of the color. + 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 = 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 color 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..bd239f186c64 --- /dev/null +++ b/rust/kernel/led/normal.rs @@ -0,0 +1,223 @@ +// 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 { + #[pin] + ops: T, + #[pin] + classdev: Opaque, +} + +impl<'a, S: DeviceBuilderState> DeviceBuilder<'a, S> { + /// Registers a new [`Device`]. + pub fn build( + self, + parent: &'a T::Bus, + ops: impl PinInit + 'a, + ) -> impl PinInit>, Error> + 'a { + Devres::new( + parent.as_ref(), + try_pin_init!(Device { + ops <- ops, + classdev <- Opaque::try_ffi_init(|ptr: *mut bindings::led_classdev| { + // SAFETY: `try_ffi_init` guarantees that `ptr` is valid for 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_callback), + brightness_set_blocking: T::BLOCKING + .then_some(Adapter::::brightness_set_blocking_callback), + brightness_get: T::HAS_BRIGHTNESS_GET + .then_some(Adapter::::brightness_get_callback), + blink_set: T::HAS_BLINK_SET.then_some(Adapter::::blink_set_callback), + max_brightness: T::MAX_BRIGHTNESS, + brightness: self.initial_brightness, + default_trigger: self + .default_trigger + .map_or(core::ptr::null(), CStrExt::as_char_ptr), + 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 = 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 pointer 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 count incremented + + Ok::<_, Error>(()) + }), + }), + ) + } +} + +impl Device { + /// # Safety + /// `led_cdev` must be a valid pointer to a `led_classdev` embedded within a + /// `led::Device`. + unsafe fn from_raw<'a>(led_cdev: *mut bindings::led_classdev) -> &'a Self { + // SAFETY: The function's contract guarantees that `led_cdev` points to a `led_classdev` + // field embedded within a valid `led::Device`. `container_of!` can therefore + // safely calculate the address of the containing struct. + unsafe { &*container_of!(Opaque::cast_from(led_cdev), Self, classdev) } + } + + fn parent(&self) -> &device::Device { + // SAFETY: `self.classdev.get()` is guaranteed to be a valid pointer to `led_classdev`. + unsafe { device::Device::from_raw((*(*self.classdev.get()).dev).parent) } + } +} + +// SAFETY: A `led::Device` can be unregistered from any thread. +unsafe impl Send for Device {} + +// SAFETY: `led::Device` can be shared among threads because all methods of `led::Device` +// are thread safe. +unsafe impl Sync for Device {} + +struct Adapter { + _p: PhantomData, +} + +impl Adapter { + /// # Safety + /// `led_cdev` must be a valid pointer to a `led_classdev` embedded within 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 = unsafe { Device::::from_raw(led_cdev) }; + // SAFETY: `classdev.parent()` is guaranteed to be contained in `T::Bus`. + let parent = unsafe { T::Bus::from_device(classdev.parent()) }; + + let _ = classdev.ops.brightness_set(parent, classdev, brightness); + } + + /// # Safety + /// `led_cdev` must be a valid pointer to a `led_classdev` embedded within a + /// `led::Device`. + /// This function is called on setting the brightness of a led immediately. + 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 = unsafe { Device::::from_raw(led_cdev) }; + // SAFETY: `classdev.parent()` is guaranteed to be contained in `T::Bus`. + let parent = 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 within 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 = unsafe { Device::::from_raw(led_cdev) }; + // SAFETY: `classdev.parent()` is guaranteed to be contained in `T::Bus`. + let parent = unsafe { T::Bus::from_device(classdev.parent()) }; + + classdev.ops.brightness_get(parent, classdev) + } + + /// # Safety + /// `led_cdev` must be a valid pointer to a `led_classdev` embedded within a + /// `led::Device`. + /// `delay_on` and `delay_off` must be valid pointers to `usize` and have + /// 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 = unsafe { Device::::from_raw(led_cdev) }; + // SAFETY: `classdev.parent()` is guaranteed to be contained in `T::Bus`. + let parent = 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 PinnedDrop for Device { + fn drop(self: Pin<&mut Self>) { + let raw = 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 = unsafe { device::Device::from_raw((*raw).dev) }; + + let _fwnode = dev + .fwnode() + // SAFETY: the reference count of `fwnode` has previously been + // incremented in `led::Device::new`. + .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 d93292d47420..d0e30d3733dd 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -115,6 +115,7 @@ pub mod jump_label; #[cfg(CONFIG_KUNIT)] pub mod kunit; +pub mod led; pub mod list; pub mod maple_tree; pub mod miscdevice; -- 2.52.0