From: Bartu Alev <bartualev@gmail.com>
To: platform-driver-x86@vger.kernel.org
Cc: ilpo.jarvinen@linux.intel.com, hansg@kernel.org, luke@ljones.dev,
denis.benato@linux.dev, benato.denis96@gmail.com,
corentin.chary@gmail.com, linux-api@vger.kernel.org,
linux-kernel@vger.kernel.org, Bartu Alev <bartualev@gmail.com>
Subject: [PATCH v3 5/5] Documentation/ABI: asus-wmi: document TUF keyboard RGB attributes
Date: Sat, 10 Oct 2026 13:16:01 +0300 [thread overview]
Message-ID: <20261010101601.888709-6-bartualev@gmail.com> (raw)
In-Reply-To: <20261010101601.888709-1-bartualev@gmail.com>
The kbd_rgb_mode and kbd_rgb_state attributes predate their
documentation: they were introduced as write-only interfaces and never
received ABI entries. The readback support now being added makes the
omission visible, since the read format is part of the interface.
Describe both attributes, their positional write formats, the write
verbs, and the readback form. The attributes are gated on WMI device
presence rather than on the laptop model, and userspace tools route
several non-TUF ASUS lines through the same devices, so the
description says ASUS laptops that expose the WMI zonal RGB devices
instead of claiming TUF models only.
Signed-off-by: Bartu Alev <bartualev@gmail.com>
---
.../ABI/testing/sysfs-platform-asus-wmi | 42 +++++++++++++++++++
1 file changed, 42 insertions(+)
diff --git a/Documentation/ABI/testing/sysfs-platform-asus-wmi b/Documentation/ABI/testing/sysfs-platform-asus-wmi
index f9825c6150b5..c63e7cdaefb0 100644
--- a/Documentation/ABI/testing/sysfs-platform-asus-wmi
+++ b/Documentation/ABI/testing/sysfs-platform-asus-wmi
@@ -238,3 +238,45 @@ Description:
Set if the MCU can go in to low-power mode on system sleep
* 0 - False,
* 1 - True
+
+What: /sys/class/leds/asus::kbd_backlight/kbd_rgb_mode
+Date: Oct 2026
+KernelVersion: 7.4
+Contact: Bartu Alev <bartualev@gmail.com>
+Description:
+ Controls the keyboard RGB lighting on ASUS laptops that
+ expose the WMI zonal RGB devices (the kernel names them
+ "TUF" for historical reasons; TUF models have them and so
+ do some other ASUS lines). Writes take six positional
+ values:
+
+ <cmd> <mode> <red> <green> <blue> <speed>
+
+ cmd is 1 to save the setting to flash or 0 to apply it for
+ the current boot only. mode selects the animation, with 0
+ static; values of 9 and above 12 are sent as 10. red,
+ green and blue are 0 to 255. speed is 0 (slow), 1 (normal)
+ or 2 (fast).
+
+ Reads return the current hardware configuration in the same
+ format, with the command word fixed at 1.
+
+What: /sys/class/leds/asus::kbd_backlight/kbd_rgb_state
+Date: Oct 2026
+KernelVersion: 7.4
+Contact: Bartu Alev <bartualev@gmail.com>
+Description:
+ Controls when the keyboard RGB backlight is lit, on the
+ hardware that exposes kbd_rgb_mode. Writes take five
+ positional values:
+
+ <cmd> <boot> <awake> <sleep> <shutdown>
+
+ cmd is 1 to save the setting to flash or 0 to apply it for
+ the current boot only. Each flag is 1 or 0: boot, awake
+ and sleep enable the backlight during boot, normal
+ operation and suspend, and shutdown keeps the backlight lit
+ while the machine powers off (S5).
+
+ Reads return the current flags in the same format, with the
+ command word fixed at 1.
--
2.56.0
prev parent reply other threads:[~2026-10-10 10:17 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-10-10 10:15 [PATCH v3 0/5] platform/x86: asus-wmi: TUF keyboard shutdown naming and RGB readback Bartu Alev
2026-10-10 10:15 ` [PATCH v3 1/5] platform/x86: asus-wmi: rename TUF RGB state DEVID to _CMD Bartu Alev
2026-10-10 10:15 ` [PATCH v3 2/5] platform/x86: asus-wmi: fix TUF keyboard power state shutdown naming Bartu Alev
2026-10-10 10:15 ` [PATCH v3 3/5] platform/x86: asus-wmi: name the TUF keyboard RGB state and speed codes Bartu Alev
2026-10-10 10:16 ` [PATCH v3 4/5] platform/x86: asus-wmi: add TUF keyboard RGB readback support Bartu Alev
2026-10-10 10:16 ` Bartu Alev [this message]
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=20261010101601.888709-6-bartualev@gmail.com \
--to=bartualev@gmail.com \
--cc=benato.denis96@gmail.com \
--cc=corentin.chary@gmail.com \
--cc=denis.benato@linux.dev \
--cc=hansg@kernel.org \
--cc=ilpo.jarvinen@linux.intel.com \
--cc=linux-api@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=luke@ljones.dev \
--cc=platform-driver-x86@vger.kernel.org \
/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®