[PATCH v5 3/3] Documentation/ABI: asus-wmi: document TUF keyboard RGB attributes
From: Bartu Alev
Date: Tue Nov 17 2026 - 05:31:56 EST
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.
Reviewed-by: Daniel Pereira <danielmaraboo@xxxxxxxxx>
Signed-off-by: Bartu Alev <bartualev@xxxxxxxxx>
---
Documentation/ABI/testing/sysfs-platform-asus-wmi | 46 +++++++++++++++++++++++
1 file changed, 46 insertions(+)
diff --git a/Documentation/ABI/testing/sysfs-platform-asus-wmi b/Documentation/ABI/testing/sysfs-platform-asus-wmi
index f9825c6150b5c..6aacfc6a42cf1 100644
--- a/Documentation/ABI/testing/sysfs-platform-asus-wmi
+++ b/Documentation/ABI/testing/sysfs-platform-asus-wmi
@@ -238,3 +238,49 @@ 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: Nov 2026
+KernelVersion: 7.5
+Contact: Bartu Alev <bartualev@xxxxxxxxx>
+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, 0 is
+ static; mode 9 and modes 12 and above 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
+ positional format, except the command word, which reads as
+ n/a because it only applies to writes. Reads fail with
+ -ENODEV on hardware without readback support.
+
+What: /sys/class/leds/asus::kbd_backlight/kbd_rgb_state
+Date: Nov 2026
+KernelVersion: 7.5
+Contact: Bartu Alev <bartualev@xxxxxxxxx>
+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 positional format,
+ except the command word, which reads as n/a because it only
+ applies to writes. Reads fail with -ENODEV on hardware
+ without readback support.
--
2.56.0