[PATCH] Documentation/ABI: speakup: document bleeps and bleep_time

From: Kirill Petrov

Date: Mon Feb 02 2026 - 05:57:26 EST


Document the accepted bitmask values for
/sys/accessibility/speakup/bleeps and the time unit (milliseconds) for
/sys/accessibility/speakup/bleep_time, as implemented by Speakup edge
notification logic announce_edge() and bleep().

Signed-off-by: Kirill Petrov <kosyanip@xxxxxxxxx>
---
Documentation/ABI/stable/sysfs-driver-speakup | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/Documentation/ABI/stable/sysfs-driver-speakup b/Documentation/ABI/stable/sysfs-driver-speakup
index bcb6831aa114..e9d71851e6b5 100644
--- a/Documentation/ABI/stable/sysfs-driver-speakup
+++ b/Documentation/ABI/stable/sysfs-driver-speakup
@@ -16,15 +16,16 @@ What: /sys/accessibility/speakup/bleeps
KernelVersion: 2.6
Contact: speakup@xxxxxxxxxxxxxxxxx
Description: This controls whether one hears beeps through the PC speaker
- when using speakup's review commands.
- TODO: what values does it accept?
+ when using speakup's review commands. This is a bitmask:
+ 0x1: bleep (PC speaker) when reaching an edge
+ 0x2: speak the corresponding edge message
+ Any combination of the above.

What: /sys/accessibility/speakup/bleep_time
KernelVersion: 2.6
Contact: speakup@xxxxxxxxxxxxxxxxx
Description: This controls the duration of the PC speaker beeps speakup
- produces.
- TODO: What are the units? Jiffies?
+ produces, in milliseconds.

What: /sys/accessibility/speakup/cursor_time
KernelVersion: 2.6
--
2.43.0