public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Kirill Petrov <kosyanip@gmail.com>
To: speakup@linux-speakup.org
Cc: w.d.hubbs@gmail.com, chris@the-brannons.com, kirk@reisers.ca,
	samuel.thibault@ens-lyon.org, linux-kernel@vger.kernel.org,
	kosyanip@gmail.com
Subject: [PATCH] Documentation/ABI: speakup: document bleeps and bleep_time
Date: Mon,  2 Feb 2026 13:56:47 +0300	[thread overview]
Message-ID: <20260202105650.7871-1-kosyanip@gmail.com> (raw)

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@gmail.com>
---
 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@linux-speakup.org
 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@linux-speakup.org
 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


             reply	other threads:[~2026-02-02 10:56 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-02 10:56 Kirill Petrov [this message]
2026-02-02 11:13 ` [PATCH] Documentation/ABI: speakup: document bleeps and bleep_time Samuel Thibault

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=20260202105650.7871-1-kosyanip@gmail.com \
    --to=kosyanip@gmail.com \
    --cc=chris@the-brannons.com \
    --cc=kirk@reisers.ca \
    --cc=linux-kernel@vger.kernel.org \
    --cc=samuel.thibault@ens-lyon.org \
    --cc=speakup@linux-speakup.org \
    --cc=w.d.hubbs@gmail.com \
    /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