linux-kernel - [PATCH v4 2/2] HP: wmi: Add documentation for the LED API naming scheme

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20240719100011.16656-3-carlosmiguelferreira.2003@gmail.com>
Date: Fri, 19 Jul 2024 10:59:46 +0100
From: Carlos Ferreira <carlosmiguelferreira.2003@...il.com>
To: hdegoede@...hat.com,
	ilpo.jarvinen@...ux.intel.com
Cc: mustafa.eskieksi@...il.com,
	platform-driver-x86@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	Carlos Ferreira <carlosmiguelferreira.2003@...il.com>
Subject: [PATCH v4 2/2] HP: wmi: Add documentation for the LED API naming scheme

This patch adds documentation for the LED API class-device naming
scheme practice.

Signed-off-by: Carlos Ferreira <carlosmiguelferreira.2003@...il.com>
---
 Documentation/leds/leds-class.rst | 40 +++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/Documentation/leds/leds-class.rst b/Documentation/leds/leds-class.rst
index 5db620ed27aa..8e74a436ca9b 100644
--- a/Documentation/leds/leds-class.rst
+++ b/Documentation/leds/leds-class.rst
@@ -116,6 +116,46 @@ above leaves scope for further attributes should they be needed. If sections
 of the name don't apply, just leave that section blank.
 
 
+Keyboard backlight control
+==========================
+
+For backlit keyboards with a single brightness / color settings a
+single (multicolor) LED device should be used to allow userspace
+to change the backlight brightness (and if possible the color).
+This LED device must have a name ending in ':kbd_backlight'.
+
+For RGB backlit keyboards with multiple control zones, one multicolor
+LED device should be used per zone. These LED devices' name
+must follow the following form:
+
+	"<devicename>:rgb:kbd_zoned_backlight-<zone_name>"
+
+and <devicename> must be the same for all zones of the same keyboard.
+
+Where possible <zone_name> should be a value already used by other
+zoned keyboards with a similar or identical zone layout, e.g.:
+
+<devicename>:rgb:kbd_zoned_backlight-right
+<devicename>:rgb:kbd_zoned_backlight-middle
+<devicename>:rgb:kbd_zoned_backlight-left
+<devicename>:rgb:kbd_zoned_backlight-corners
+<devicename>:rgb:kbd_zoned_backlight-wasd
+
+or:
+
+<devicename>:rgb:kbd_zoned_backlight-main
+<devicename>:rgb:kbd_zoned_backlight-cursor
+<devicename>:rgb:kbd_zoned_backlight-numpad
+<devicename>:rgb:kbd_zoned_backlight-corners
+<devicename>:rgb:kbd_zoned_backlight-wasd
+
+Note that this is intended for keyboards with a limited number of zones,
+keyboards with per key addressable backlighting must not use LED
+class devices since the sysfs API is not suitable for rapidly change
+multiple LEDs in one "commit" as is necessary to do animations /
+special effects on such keyboards.
+
+
 Brightness setting API
 ======================
 
-- 
2.45.2