mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Nick Dowsett via B4 Relay <devnull+nick42d.gmail.com@kernel.org>
To: "Hans de Goede" <hansg@kernel.org>,
	"Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>,
	"Miguel Ojeda" <ojeda@kernel.org>,
	"Boqun Feng" <boqun@kernel.org>, "Gary Guo" <gary@garyguo.net>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Benno Lossin" <lossin@kernel.org>,
	"Andreas Hindborg" <a.hindborg@kernel.org>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Trevor Gross" <tmgross@umich.edu>,
	"Danilo Krummrich" <dakr@kernel.org>,
	"Daniel Almeida" <daniel.almeida@collabora.com>,
	"Tamir Duberstein" <tamird@kernel.org>,
	"Alexandre Courbot" <acourbot@nvidia.com>,
	"Onur Özkan" <work@onurozkan.dev>
Cc: Armin Wolf <W_Armin@gmx.de>,
	Werner Sembach <wse@tuxedocomputers.com>,
	 linux-kernel@vger.kernel.org,
	platform-driver-x86@vger.kernel.org,
	 rust-for-linux@vger.kernel.org, Nick Dowsett <nick42d@gmail.com>
Subject: [PATCH 2/4] platform/x86: clevo-laptop: add EC WMI query interface and BIOS feature check
Date: Sun, 22 Nov 2026 12:35:39 +0800	[thread overview]
Message-ID: <20261122-clevo-laptop-v1-2-881debf4d4b0@gmail.com> (raw)
In-Reply-To: <20261122-clevo-laptop-v1-0-881debf4d4b0@gmail.com>

From: Nick Dowsett <nick42d@gmail.com>

- Add `EcQuery` trait and implement `EcInterface` for sending commands to
  the Clevo EC over WMI.
- Add `GetBiosFeatures1` query to verify the EC responds during probe.

Signed-off-by: Nick Dowsett <nick42d@gmail.com>
---
 drivers/platform/x86/clevo-laptop.rs | 104 ++++++++++++++++++++++++++++++++++-
 1 file changed, 102 insertions(+), 2 deletions(-)

diff --git a/drivers/platform/x86/clevo-laptop.rs b/drivers/platform/x86/clevo-laptop.rs
index 1d862c57b3fe..289b30c478ec 100644
--- a/drivers/platform/x86/clevo-laptop.rs
+++ b/drivers/platform/x86/clevo-laptop.rs
@@ -24,6 +24,8 @@
 /// DMI board name allowlist, restricted to tested boards since the WMI GUID is not
 /// unique.
 const SUPPORTED_BOARDS: &[&CStr] = &[c"NLx0AU"];
+const CLEVO_EC_CMD_GET_BIOS_FEATURES_1: u8 = 0x52;
+const CLEVO_EC_WMI_INSTANCE: u8 = 0;
 
 module! {
     type: ClevoLaptopModule,
@@ -33,6 +35,21 @@
     license: "GPL",
 }
 
+/// Represents a query that can run on the Clevo Embedded Controller (EC).
+///
+/// # Endianness note
+/// Clevo EC sends and receives little endian data.
+/// As this is a `platform/x86` driver, no conversion is required.
+trait EcQuery {
+    type Output;
+    /// EC method code.
+    fn cmd(&self) -> u8;
+    /// EC method args.
+    fn args(&self) -> EcMethodArgs;
+    /// Each command must know how to deserialize itself from the raw EC output.
+    fn deserialize_output(output: &[u8]) -> Result<Self::Output>;
+}
+
 /// RAII guard for Clevo Laptop Module holding all subsystem drivers e.g WMI.
 #[pin_data]
 struct ClevoLaptopModule {
@@ -65,8 +82,91 @@ impl wmi::Driver for WmiDriver {
     type Data<'bound> = WmiDriver;
     const ID_TABLE: wmi::IdTable = &WMI_TABLE;
     fn probe<'bound>(
-        _dev: &'bound wmi::Device<device::Core<'_>>,
+        dev: &'bound wmi::Device<device::Core<'_>>,
     ) -> impl PinInit<Self::Data<'bound>, Error> + 'bound {
-        try_pin_init!(WmiDriver {})
+        pin_init::pin_init_scope(move || {
+            let backend = EcInterface::Wmi(dev);
+
+            backend.query(GetBiosFeatures1).map_err(|_| ENODEV)?;
+
+            Ok(try_pin_init!(WmiDriver {}))
+        })
+    }
+}
+
+/// Interface to Clevo Embedded Controller.
+enum EcInterface<'a> {
+    Wmi(&'a wmi::Device<device::Bound>),
+}
+impl<'a> EcInterface<'a> {
+    /// Send a query to the EC, receiving a response.
+    fn query<Q>(&self, query: Q) -> Result<Q::Output>
+    where
+        Q: EcQuery + core::fmt::Debug,
+        Q::Output: core::fmt::Debug,
+    {
+        let cmd = query.cmd();
+        let arg = query.args();
+
+        match self {
+            Self::Wmi(wdev) => {
+                dev_dbg!(
+                    wdev.as_ref(),
+                    "ec cmd {query:?} method_id 0x{cmd:02x} arg {arg:x?}\n"
+                );
+                let buf = wdev.invoke_method(
+                    CLEVO_EC_WMI_INSTANCE,
+                    cmd.into(),
+                    arg.as_bytes(),
+                    core::mem::size_of::<Q::Output>(),
+                )?;
+
+                let res = Q::deserialize_output(&buf)?;
+                dev_dbg!(wdev.as_ref(), "ec cmd {query:?} -> {res:?}\n");
+                Ok(res)
+            }
+        }
     }
 }
+
+/// Args for a command sent to the EC.
+#[derive(Debug)]
+enum EcMethodArgs {
+    Scalar(u32),
+}
+impl EcMethodArgs {
+    /// Convert to the type expected by the EC.
+    fn as_bytes(&self) -> &[u8] {
+        match self {
+            // Clevo EC expects little-endian integers; x86 is always little-endian.
+            Self::Scalar(val) => val.as_bytes(),
+        }
+    }
+}
+
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+struct GetBiosFeatures1;
+
+impl EcQuery for GetBiosFeatures1 {
+    type Output = BiosFeatures1;
+    fn cmd(&self) -> u8 {
+        CLEVO_EC_CMD_GET_BIOS_FEATURES_1
+    }
+    fn args(&self) -> EcMethodArgs {
+        EcMethodArgs::Scalar(0)
+    }
+    fn deserialize_output(output: &[u8]) -> Result<Self::Output> {
+        let (feat, _) = BiosFeatures1::read_from_prefix(output).map_err(|_| ENODATA)?;
+        if feat == BiosFeatures1::INVALID {
+            return Err(ENODEV);
+        }
+        Ok(feat)
+    }
+}
+
+#[derive(Debug, Clone, Copy, PartialEq, Eq, FromBytes)]
+struct BiosFeatures1(u32);
+
+impl BiosFeatures1 {
+    const INVALID: Self = Self(0xFFFF_FFFF);
+}

-- 
2.56.1



  parent reply	other threads:[~2026-11-22  4:35 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-22  4:35 [PATCH 0/4] platform/x86: clevo-laptop: add initial Rust driver for keyboard backlight Nick Dowsett via B4 Relay
2026-11-22  4:35 ` [PATCH 1/4] platform/x86: clevo-laptop: add minimal WMI driver skeleton and Kbuild plumbing Nick Dowsett via B4 Relay
2026-11-22  4:35 ` Nick Dowsett via B4 Relay [this message]
2026-11-22  4:35 ` [PATCH 3/4] platform/x86: clevo-laptop: probe keyboard backlight type and detect 5-step white backlight Nick Dowsett via B4 Relay
2026-11-22  4:35 ` [PATCH 4/4] platform/x86: clevo-laptop: register 5-step white keyboard backlight LED device Nick Dowsett via B4 Relay

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20261122-clevo-laptop-v1-2-881debf4d4b0@gmail.com \
    --to=devnull+nick42d.gmail.com@kernel.org \
    --cc=W_Armin@gmx.de \
    --cc=a.hindborg@kernel.org \
    --cc=acourbot@nvidia.com \
    --cc=aliceryhl@google.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun@kernel.org \
    --cc=dakr@kernel.org \
    --cc=daniel.almeida@collabora.com \
    --cc=gary@garyguo.net \
    --cc=hansg@kernel.org \
    --cc=ilpo.jarvinen@linux.intel.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lossin@kernel.org \
    --cc=nick42d@gmail.com \
    --cc=ojeda@kernel.org \
    --cc=platform-driver-x86@vger.kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=tamird@kernel.org \
    --cc=tmgross@umich.edu \
    --cc=work@onurozkan.dev \
    --cc=wse@tuxedocomputers.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®