linux-kernel - [PATCH v3 1/2] leds: uleds documentation fixes

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-next>] [day] [month] [year] [list]

Message-ID: <20250317022220.423966-1-craig@mcqueen.au>
Date: Mon, 17 Mar 2025 13:22:19 +1100
From: Craig McQueen <craig@...ueen.au>
To: linux-leds@...r.kernel.org
Cc: linux-kernel@...r.kernel.org,
	Craig McQueen <craig@...ueen.au>
Subject: [PATCH v3 1/2] leds: uleds documentation fixes

* Add max_brightness field to struct for setup.
* Reads are a signed int value, not a single unsigned byte value.

Signed-off-by: Craig McQueen <craig@...ueen.au>
---
 Documentation/leds/uleds.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/leds/uleds.rst b/Documentation/leds/uleds.rst
index 83221098009c..4077745dae00 100644
--- a/Documentation/leds/uleds.rst
+++ b/Documentation/leds/uleds.rst
@@ -17,16 +17,16 @@ structure to it (found in kernel public header file linux/uleds.h)::
 
     struct uleds_user_dev {
 	char name[LED_MAX_NAME_SIZE];
+	int max_brightness;
     };
 
 A new LED class device will be created with the name given. The name can be
 any valid sysfs device node name, but consider using the LED class naming
 convention of "devicename:color:function".
 
-The current brightness is found by reading a single byte from the character
-device. Values are unsigned: 0 to 255. Reading will block until the brightness
-changes. The device node can also be polled to notify when the brightness value
-changes.
+The current brightness is found by reading an int value from the character
+device. Reading will block until the brightness changes. The device node can
+also be polled to notify when the brightness value changes.
 
 The LED class device will be removed when the open file handle to /dev/uleds
 is closed.
-- 
2.48.1