From nobody Tue Aug 25 04:38:23 2026 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (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 EE3103F23A6; Wed, 5 Aug 2026 19:34:18 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1785958459; cv=none; b=T3GTGvlsLwEB5NGG5FdKb5jSwVvBIKaAKJWpkKDQQ/YNxD6zq17yq0Mm7V0GZ4CjzE2FE5F2R/Y25zwsibh+n9utAJSILzZY5YsxFMffcgO0wvynMmEN2u+lK7f7ypT8ZN4mPEUilTyQLnJMbhLl9eBLk4umkH42Zo5U4y/Wwlc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1785958459; c=relaxed/simple; bh=A4+UWd+S2zuQg+pEOfGKB325ob4AXa2S2dmuOZgAhvw=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=IlIAPM3A+BaZgWdhzXssTKrla+iI/n+0r6vWJQbieMOKV0SKvtjSdekvgqzio5DHC609TtzTfPk/Vncyk1QqbXGvZlxk7Bb795tixB/1anlU5UeigwXwMT/dXc0HoBcqHvTr0FRz2kJrbPrR8hmj0Ht27iJQL6dqV9b7Ar3waXE= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=kApSYA70; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="kApSYA70" Received: by smtp.kernel.org (Postfix) with ESMTPS id 7C7C3C2BCF6; Wed, 5 Aug 2026 19:34:18 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1785958458; bh=A4+UWd+S2zuQg+pEOfGKB325ob4AXa2S2dmuOZgAhvw=; h=From:Date:Subject:References:In-Reply-To:To:Cc:Reply-To:From; b=kApSYA705bNNhIauMR2TsB3VSkw6aJUacp0IbFyu86rLxQNlceqUxM+enuiZf1gMs e0nRwz4dIkkU1GzroQTYMH6gb+Bq0nErTBpHzB/rvbX9cAuXxTGa+KAyltYPDweFfl grQRxtk4bCNnpIw036cdx15Dgn2xQRs/JRPOZZiom7aVaXT3PQGadE4N2y76/LVWel kD42zHtReHL726fuMbLMd1zLadCgEw8BXqgeP2KpTWM10pepOX0SnQ2YjUz4udRRJE 6IBFK+6iRnNgOzg4EVeHydbKEvdwACHH24SDA2oBPzO+xb0NmOqCVZ22VTGqMQypPb sVeCM6Xg4SQAw== Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5BA08C55ABA; Wed, 5 Aug 2026 19:34:18 +0000 (UTC) From: Markus Probst via B4 Relay Date: Wed, 05 Aug 2026 21:34:10 +0200 Subject: [PATCH RESEND v23 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: <20260805-rust_leds-v23-1-b2fea4290ee6@posteo.de> References: <20260805-rust_leds-v23-0-b2fea4290ee6@posteo.de> In-Reply-To: <20260805-rust_leds-v23-0-b2fea4290ee6@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-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=20400; i=markus.probst@posteo.de; h=from:subject:message-id; bh=fdGk/gdmV/cdseByoK3a2f3vDhDE4dxg8Ca14hgbA9Y=; b=owEBiQJ2/ZANAwAIATR2H/jnrUPSAcsmYgBqc5A4tGNAvK7Thj/aAY/7HzfbxDrMmVTkxdktp 5rjtSsCutqJAk8EAAEIADkWIQSCdBjE9KxY53IwxHM0dh/4561D0gUCanOQOBsUgAAAAAAEAA5t YW51MiwyLjUrMS4xMiwyLDIACgkQNHYf+OetQ9J/nRAAtKD4u2SM9C0kzrzF/iEpMqdqGpW43bX ctayrG9iJbDWBvUsTUOWyYkQv/uTNYG1WqEPWfjMXcWn1hAbe4pr4q7wIYixBaPTgGPpIGT2Ttw dECEwgDOJMDNLe5jzofI4qzLZJ0rZV5g4FV/AyM8j7B5D7uudd0XafMyTclscdYfr3YS4LgPjVv YyE2WSL32nP4yirdGPhouE+/ep6o1niR60tDX6pcyMtrbhsk/g+opCMisvnNBYm4ub0pSwATGNv 9kmq4o+vO3+rVed+WC0kSj7M8Ehx8nkfPiH86BgzEsbRMuOw4mM9sqKroEsiBYuy5umcM/QMBgF acPhsMioiPxP2DovoHSLqrcOjeakoVcqCvGckFJ2v0YWbYaXK0+BPmFA9o424Xcz0SCIW7K3tPQ yh5vziRvGUZqPZmzCduKaxob6jWN/ZyyQ2DUuID9QWikGBNek8PcQgCuZNakrAa4DRPjzfgpwmf WiV5T3eRHpwBjoyItIXUV5l9lonQRgb8iRUcY9TwgPXH4XmuMBm6OBWqwYR/+g80alts5l4vEED ZmiTy+cx/FNmRmHtWh6KHc5F4RnTAUFWQjqC+EVjb6G5FljxdBs5oAWMa7v1oAHvHUaQ+pQAMWV b+RkEgKt9F5vfEmxWhxvorqyWEAEbkC3UJZdvdAkoAi9Rug01ivY= X-Developer-Key: i=markus.probst@posteo.de; a=openpgp; fpr=827418C4F4AC58E77230C47334761FF8E7AD43D2 X-Endpoint-Received: by B4 Relay for markus.probst@posteo.de/default with auth_id=680 X-Original-From: Markus Probst Reply-To: markus.probst@posteo.de From: Markus Probst 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 806bd2d80d15..70989c4c693c 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..596975e103b8 --- /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<'init, S> { + fwnode: Option>, + name: Option<&'init CStr>, + devicename: Option<&'init 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<'init> DeviceBuilder<'init, 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: &'init 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<'init, S: DeviceBuilderState> DeviceBuilder<'init, 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<'init> DeviceBuilder<'init, 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: &'init 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..816db7c57689 --- /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<'init, S: DeviceBuilderState> DeviceBuilder<'init, S> { + /// Registers a new [`Device`]. + pub fn build<'bound: 'init, T: LedOps + 'bound>( + self, + parent: &'bound T::Bus, + ops: impl PinInit + 'init, + ) -> impl PinInit, Error> + 'init { + 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.54.0 From nobody Tue Aug 25 04:38:23 2026 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (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 EE2723EDE56; Wed, 5 Aug 2026 19:34:18 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1785958459; cv=none; b=VUfS8u/jqSUK+UurVFIJpnudeNlYR5eSGNkKrGWktHUqOClWFq2Z8z7subRKs3hJ85Fa5/umsiTTfGccfxroJk9p67HZUUroOmJ4BkNDMX24XdhqIqwH9Gc03vizm1DL2BbEQl8EU+rTSVC1IVfsczberu330deVWXgBjlIoVNY= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1785958459; c=relaxed/simple; bh=ZMzlw1PG79i0KTsJh4DFqNxfV30yilRk79JxCdP6q7M=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=jIv3L/UseP0yM9LqNbrXgO/YKhS8n1urPv9BfLde27hUKevkt0PzxzHHBWTcb1Gg/rfx7KAWGdV1V0A8/Mto2Bd/vybMxcbomhBN3PLkj3elQyXUIZEwEXEmAjPonJM+NvWlOvzQdUdwXbrqKIUy9bqojN8/Szw5tKm4px2rgGc= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=siQdtIL9; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="siQdtIL9" Received: by smtp.kernel.org (Postfix) with ESMTPS id 8FF4CC2BCB8; Wed, 5 Aug 2026 19:34:18 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1785958458; bh=ZMzlw1PG79i0KTsJh4DFqNxfV30yilRk79JxCdP6q7M=; h=From:Date:Subject:References:In-Reply-To:To:Cc:Reply-To:From; b=siQdtIL9wckk0ohcthU/5TEfgiV4RQCXN/0Dcuxku7qzksA8y6/lYyPPmSVWZbi25 umTtfDr12Svou+I9JAQcgPxEtXKnJG4q5e8FT7p8l4zYpPg+IYy2balYCRztWvGPMW kiIjl8voTVRk2O5sFrkHKKTPiGWp+kx6LojegrlejQRrqSad5E4jtdfdrPYGPTR4DS bW9KYwM9EIY4eK3Ov7fQlNNfiJPBAnLeKmtepkZ0B9TBRP3O5STqCw3DawLbXftjql T+3/Wo+mu8wrQh6+9Ss0RXrxE0RJQDkBXC9wm8M+O7XjKVw0fIuorU6GHxx70GBzhv PsK0db8NfdL8w== Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6C9F1C55174; Wed, 5 Aug 2026 19:34:18 +0000 (UTC) From: Markus Probst via B4 Relay Date: Wed, 05 Aug 2026 21:34:11 +0200 Subject: [PATCH RESEND v23 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: <20260805-rust_leds-v23-2-b2fea4290ee6@posteo.de> References: <20260805-rust_leds-v23-0-b2fea4290ee6@posteo.de> In-Reply-To: <20260805-rust_leds-v23-0-b2fea4290ee6@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-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=5626; i=markus.probst@posteo.de; h=from:subject:message-id; bh=nc2dY/Fz8fnYk1jCgiVliPMUCfhD5G60Nz9Ipye79EA=; b=owEBiQJ2/ZANAwAIATR2H/jnrUPSAcsmYgBqc5A4iSOWrfMwCyI+YzOs71qNy4nNXmsKFnHDO V9yYA9TAOGJAk8EAAEIADkWIQSCdBjE9KxY53IwxHM0dh/4561D0gUCanOQOBsUgAAAAAAEAA5t YW51MiwyLjUrMS4xMiwyLDIACgkQNHYf+OetQ9I7QBAAk32MFiyt/+aQyB7qGd8KDGE62iV6v7P +X66/1wiamy+cXbBqky5e0MTOkWAc88lsPRwyunYAmE3tQc3/fytnIBwIcjrhXw1jBq/zMbFBvJ Jt6qCRMLIV/r02tgYnQxLIDbCdE1IbUbIXKc9+e7XX3AE2srEDRGWWOXpC2sjiXd8xK3kWk46st N88Ywtf9GbjOv8lNiJwRfwwRIVutbbXnxxw8aLMb4Z+C6Wk7Zb+glPztf4uZjjTj/JcQzH5BjcN MtHhhaisNK0qe0EvW2hF8xyUdPQejkqkWvt9ktDejrqNpl6kbTCS5vhV3vD8rJ/F9A+CbFX7kxv iS8uq2BIWYS9OmVnjnAMKdEmLD8I3VzIWUTWhYgy6KCvkw7XDXZzYDtOcp2zXwNVbHkyJUCAz/k irVsSakXvmOKhnHf4BqQtzHbljrMv06F0Lq28oL52Z4P1pgjjDWYL6pyedb4ADdUpRrPPI9cDXv MbNEroHefHbPjUEZsbLhEcKUDvnsjjc99MdqDvRCQZIwYhBMxeQygMokG+/K0FTSque+i96Yzf4 IwGR3d7dm2g8KuEz47Lvqd6EqXesReOpfJtMB7orvxJtJWBNk4C4RjEmCbeLJxfNvHk6t+fP9tL o31yvzwnaH6d2DXnD7Zdy7euJB+8UUjT3wg8LRtBb/j2X2a0rfuI= X-Developer-Key: i=markus.probst@posteo.de; a=openpgp; fpr=827418C4F4AC58E77230C47334761FF8E7AD43D2 X-Endpoint-Received: by B4 Relay for markus.probst@posteo.de/default with auth_id=680 X-Original-From: Markus Probst Reply-To: markus.probst@posteo.de From: Markus Probst 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 596975e103b8..5d7e6d08ad2a 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: &'init 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 816db7c57689..25190486a62d 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<'init, S: DeviceBuilderState> DeviceBuilder<'init, S> { /// Registers a new [`Device`]. - pub fn build<'bound: 'init, T: LedOps + 'bound>( + pub fn build<'bound: 'init, T: LedOps + 'bound>( self, parent: &'bound T::Bus, ops: impl PinInit + 'init, @@ -87,7 +95,7 @@ pub fn build<'bound: 'init, 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.54.0 From nobody Tue Aug 25 04:38:23 2026 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (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 EEF0A3F4118; Wed, 5 Aug 2026 19:34:18 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1785958459; cv=none; b=nF8lzhxtrBEjaPLcA7pzmxucXXjsVqGu/c8WZuVgWjZxNBggERAjKXYM7oB8FbAiF3IFUru3/CchRJo9VTC1TRNUfr8zNfrO9J2wNuz1we513CrwlR0EWiwfSn+1RwJl1SReVUMusMvgYnagIZzFHacNRPtcCzqxP9IEcdemQCU= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1785958459; c=relaxed/simple; bh=3UxyL+UaBEnBHfv6LcJXc8SdjPNDuzxJgPvK7RC92PM=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=CN+vejExw8qlMYjwMgnuCMtLQUkdXg1CK33M7DClAI5nh0Ew6VB4FTPqlA4nW2uAIsrgL6zeti7MQXGRltihOCO2m0Az6EKGzwYvhazPffe47JrX/7iq6cGW4QE5hgcjUpYg7ycpENrpxdeYFmERMZunu1m1du5Yjs8uXPs0CWo= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=bLCgqOKL; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="bLCgqOKL" Received: by smtp.kernel.org (Postfix) with ESMTPS id 9ED38C4AF0E; Wed, 5 Aug 2026 19:34:18 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1785958458; bh=3UxyL+UaBEnBHfv6LcJXc8SdjPNDuzxJgPvK7RC92PM=; h=From:Date:Subject:References:In-Reply-To:To:Cc:Reply-To:From; b=bLCgqOKLnbnhFugkCMocAV2HbpCLN6nmEYBztmbjWxNoryL+7UxoCbaYo5k19csai YiU4f6o/ilp7FgPn9TC8UMeiZO/6jHAQCUzhTdStUaeNHOycAh+lY8aB/UAGm5oDWg 8QzCuyM6X1wXIdEHu2+HVlZHSwcjb55u53swq+tefczAms80qmujh5biwAXQ3soGVj gfvVQ3zcUQaTBXX7/iCiR8nzwnNnHkDrWxWE1mzEB9r9NfwRQAYOf0KJW7FfpBl3XU QBH8gwPGyy6kBinU84eW21wooPxBj5+sMKf0aBx72AAsd1WMcQyNXMHWVwGgCtHUmu zaDROLDvV36AQ== Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 804A4C56205; Wed, 5 Aug 2026 19:34:18 +0000 (UTC) From: Markus Probst via B4 Relay Date: Wed, 05 Aug 2026 21:34:12 +0200 Subject: [PATCH RESEND v23 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: <20260805-rust_leds-v23-3-b2fea4290ee6@posteo.de> References: <20260805-rust_leds-v23-0-b2fea4290ee6@posteo.de> In-Reply-To: <20260805-rust_leds-v23-0-b2fea4290ee6@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-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=23237; i=markus.probst@posteo.de; h=from:subject:message-id; bh=XEv168yC49AdqEd5gap66tan9pBN9Wx1zGNT2FdAO68=; b=owEBiQJ2/ZANAwAIATR2H/jnrUPSAcsmYgBqc5A41uIT9XLFEb5buP9neOzwqUBqk28ANAQmi WLjcyDktHKJAk8EAAEIADkWIQSCdBjE9KxY53IwxHM0dh/4561D0gUCanOQOBsUgAAAAAAEAA5t YW51MiwyLjUrMS4xMiwyLDIACgkQNHYf+OetQ9IWcA//fVahjqq+6LbL7ajv3BGaYvpHk4OygVu jx5iIvC3/TTmwCX1gBTjBB0Not3aWlvD37X6SRXAhsQAaxkHZA4KCqtGQxQtE8kiG7t+m+RAhzz 3F5ZBYqxbpAFXl+Z8RqbWJRHMiBDv5nG/pIxHyulyJ69HaneDzGVm+7L01Zcf3oaHmQYs4sFbWN UR4ZeXzqHRn23T2QxscrbM/0bnnBGvRF6FluehipgMAToAIwWBCGx1an/jt8575Q6xKZIyBOA+7 ZCRaewt5e16EczV2MgFTDjPiMqBup0ldbpu1RHQVDg9fOQc+rHqalwQblG1Gic+9Gvk1qnDzpEC mWjoxz1X5F5EYZ+iBoNhtgWAlY4p+uN3XUaSrEmXt77xx4vTcnOJQ+1nOoaqvi40XQBQ1ZoXEcg AEHdebA/NY57+BHG0Ujcl5KjbgxIFiI7y/eu1WpD5Tre8NhnV/tiZ32G30Ge+PNgmlzJScRtXnr fIqlpnxOZjpCRfIwQvxAZ7rEr/BRuSehPIb2DJszXEcZlPvsyvvocDEO8tQW1nqLeXYfS8z0Uo4 ZcDQkn9Kec8A+u1MLn7mtAqLlF01WXRv9b0FEF0QAO5WER9xmrzNRuq1Ft4YLUj9Z7zULigSNAa 7YoxBPgtS5uVdg4a9ryojBbkJ10KbmzUxnrvdjR4IVT+5Ucarha8= X-Developer-Key: i=markus.probst@posteo.de; a=openpgp; fpr=827418C4F4AC58E77230C47334761FF8E7AD43D2 X-Endpoint-Received: by B4 Relay for markus.probst@posteo.de/default with auth_id=680 X-Original-From: Markus Probst Reply-To: markus.probst@posteo.de From: Markus Probst 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 5d7e6d08ad2a..3aa7cdde78f4 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..82fe96fd5273 --- /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<'init, S: DeviceBuilderState> DeviceBuilder<'init, S> { + /// Registers a new [`MulticolorDevice`]. + pub fn build_multicolor<'bound: 'init, T: LedOps = + 'bound>( + self, + parent: &'bound T::Bus, + ops: impl PinInit + 'init, + subleds: &'init [MultiColorSubLed], + ) -> impl PinInit, Error> + 'init { + 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.54.0