[PATCH 4/4] platform/x86: clevo-laptop: register 5-step white keyboard backlight LED device
From: Nick Dowsett via B4 Relay
Date: Sat Nov 21 2026 - 23:36:13 EST
From: Nick Dowsett <nick42d@xxxxxxxxx>
- Add `SetWhiteBrightness` EC command and `Brightness` wrapper.
- Implement `LedOps` (`FixedColorLedOperations`) and register a
`white:kbd_backlight` LED class device during WMI probe.
Signed-off-by: Nick Dowsett <nick42d@xxxxxxxxx>
---
drivers/platform/x86/clevo-laptop.rs | 100 +++++++++++++++++++++++++++++++++--
1 file changed, 95 insertions(+), 5 deletions(-)
diff --git a/drivers/platform/x86/clevo-laptop.rs b/drivers/platform/x86/clevo-laptop.rs
index 6f08bf295c07..0a9cb96e7811 100644
--- a/drivers/platform/x86/clevo-laptop.rs
+++ b/drivers/platform/x86/clevo-laptop.rs
@@ -10,8 +10,14 @@
//! Inspired by Tuxedo Computers' drivers.
use kernel::{
+ self,
device,
dmi,
+ led::{
+ self,
+ LedOps,
+ Normal, //
+ },
prelude::*,
time::{
delay::fsleep,
@@ -31,6 +37,7 @@
const CLEVO_EC_CMD_GET_SPECS: u8 = 0x0D;
const CLEVO_EC_CMD_GET_BIOS_FEATURES_1: u8 = 0x52;
const CLEVO_EC_CMD_GET_BIOS_FEATURES_2: u8 = 0x7A;
+const CLEVO_EC_CMD_SET_KB_WHITE_LEDS: u8 = 0x27;
const CLEVO_BIOS_FEATURE_CODE_WHITE_ONLY_KB: u32 = 0x4000_0000;
const CLEVO_BIOS_FEATURE_CODE_3_ZONE_RGB_KB: u32 = 0x0040_0000;
const CLEVO_BIOS_FEATURE_CODE_WHITE_ONLY_KB_MAX_5: u32 = 0x4000;
@@ -63,7 +70,7 @@ trait EcQuery {
#[pin_data]
struct ClevoLaptopModule {
#[pin]
- _wmi_driver: wmi::Registration<WmiDriver>,
+ _wmi_driver: wmi::Registration<WmiDriver<'static>>,
}
impl kernel::InPlaceModule for ClevoLaptopModule {
@@ -83,12 +90,14 @@ fn init(module: &'static ThisModule) -> impl PinInit<Self, Error> {
/// RAII guard for Clevo WMI driver holding all subsystem devices e.g LED device.
#[pin_data]
-struct WmiDriver {}
+struct WmiDriver<'a> {
+ _led: LedRegistration<'a>,
+}
kernel::wmi_device_table!(WMI_TABLE, [wmi::DeviceId::new(CLEVO_WMI_METHOD_GUID)]);
-impl wmi::Driver for WmiDriver {
- type Data<'bound> = WmiDriver;
+impl wmi::Driver for WmiDriver<'_> {
+ type Data<'bound> = WmiDriver<'bound>;
const ID_TABLE: wmi::IdTable = &WMI_TABLE;
fn probe<'bound>(
dev: &'bound wmi::Device<device::Core<'_>>,
@@ -109,11 +118,64 @@ fn probe<'bound>(
return Err(ENODEV);
}
- Ok(try_pin_init!(WmiDriver {}))
+ if let Err(e) = backend.query(SetWhiteBrightness(Brightness::OFF)) {
+ dev_dbg!(
+ dev,
+ "Error {e:?} setting keyboard brightness on initialization.\n"
+ );
+ }
+
+ let led_dev = KBox::pin_init(
+ led::DeviceBuilder::new()
+ .name(c"white:kbd_backlight")
+ .color(led::Color::White)
+ .build(
+ dev.as_ref(),
+ try_pin_init!(FixedColorLedOperations { backend }),
+ ),
+ GFP_KERNEL,
+ )?;
+
+ Ok(try_pin_init!(WmiDriver {
+ _led: LedRegistration::White5Step { _dev: led_dev },
+ }))
})
}
}
+/// RAII guard for Clevo LED device holding the appropriate sysfs device for the backlight type.
+enum LedRegistration<'a> {
+ White5Step {
+ _dev: Pin<
+ KBox<led::Device<'a, FixedColorLedOperations<'a, { Brightness::MAX_WHITE_5.raw() }>>>,
+ >,
+ },
+}
+
+/// Represents how to perform LED operations for a Clevo single-color LED keyboard, generic over
+/// `MAX_BRIGHTNESS`.
+#[pin_data]
+struct FixedColorLedOperations<'a, const MAX_BRIGHTNESS: u8> {
+ backend: EcInterface<'a>,
+}
+#[vtable]
+impl<'a, const MAX_BRIGHTNESS: u8> LedOps for FixedColorLedOperations<'a, MAX_BRIGHTNESS> {
+ const BLOCKING: bool = true;
+ const MAX_BRIGHTNESS: u32 = MAX_BRIGHTNESS as u32;
+ type Mode = Normal;
+
+ fn brightness_set<'bound>(
+ self: &<Self::Mode as led::Mode>::Device<'bound, Self>,
+ brightness: u32,
+ ) -> Result<()> {
+ let clamped = u8::try_from(brightness)
+ .unwrap_or(MAX_BRIGHTNESS)
+ .min(MAX_BRIGHTNESS);
+ self.backend
+ .query(SetWhiteBrightness(Brightness::new(clamped)))
+ }
+}
+
/// Interface to Clevo Embedded Controller.
enum EcInterface<'a> {
Wmi(&'a wmi::Device<device::Bound>),
@@ -182,6 +244,20 @@ fn detect_backlight_type(&self) -> Result<Option<KbBacklightType>> {
}
}
+/// Keyboard backlight brightness level.
+#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Copy, Clone)]
+struct Brightness(u8);
+impl Brightness {
+ const OFF: Self = Self(0);
+ const MAX_WHITE_5: Self = Self(5);
+ const fn new(val: u8) -> Self {
+ Self(val)
+ }
+ const fn raw(self) -> u8 {
+ self.0
+ }
+}
+
/// Keyboard backlight type - e.g Fixed Color
#[derive(PartialEq)]
#[repr(u8)]
@@ -219,6 +295,8 @@ fn as_bytes(&self) -> &[u8] {
}
}
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+struct SetWhiteBrightness(Brightness);
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
struct GetSpecs;
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
@@ -226,6 +304,18 @@ fn as_bytes(&self) -> &[u8] {
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
struct GetBiosFeatures2;
+impl EcQuery for SetWhiteBrightness {
+ type Output = ();
+ fn cmd(&self) -> u8 {
+ CLEVO_EC_CMD_SET_KB_WHITE_LEDS
+ }
+ fn args(&self) -> EcMethodArgs {
+ EcMethodArgs::Scalar(self.0.raw().into())
+ }
+ fn deserialize_output(_output: &[u8]) -> Result<Self::Output> {
+ Ok(())
+ }
+}
impl EcQuery for GetBiosFeatures1 {
type Output = BiosFeatures1;
fn cmd(&self) -> u8 {
--
2.56.1