git: 03a515e9890b - main - speaker(4): Update outdated comments

The branch main has been updated by imp:

URL: https://cgit.FreeBSD.org/src/commit/?id=03a515e9890b0c6844457254e26dc34333b85127

commit 03a515e9890b0c6844457254e26dc34333b85127
Author:     Raphael Poss <knz@thaumogen.net>
AuthorDate: 2025-12-10 19:53:21 +0000
Commit:     Warner Losh <imp@FreeBSD.org>
CommitDate: 2026-04-24 16:23:06 +0000

    speaker(4): Update outdated comments
    
    The comments in tone() were referring to pre-2000 logic that does not
    exist any more. This patch updates them.
    
    Signed-off-by: Raphael Poss <knz@thaumogen.net>
    Reviewed by: imp
    Pull Request: https://github.com/freebsd/freebsd-src/pull/1922
---
 sys/dev/speaker/spkr.c | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/sys/dev/speaker/spkr.c b/sys/dev/speaker/spkr.c
index c698a4820434..2cdbbd43ff6e 100644
--- a/sys/dev/speaker/spkr.c
+++ b/sys/dev/speaker/spkr.c
@@ -71,23 +71,29 @@ tone(unsigned int thz, unsigned int centisecs)
 	(void) printf("tone: thz=%d centisecs=%d\n", thz, centisecs);
 #endif /* DEBUG */
 
-	/* set timer to generate clicks at given frequency in Hertz */
+	/*
+	 * Acquire the i8254 clock, configure it to drive the speaker
+	 * signal, and turn on the speaker.
+	 */
 	if (timer_spkr_acquire()) {
-		/* enter list of waiting procs ??? */
 		return;
 	}
 	disable_intr();
+	/* Configure the speaker with the tone frequency. */
 	timer_spkr_setfreq(thz);
 	enable_intr();
 
 	/*
-	 * Set timeout to endtone function, then give up the timeslice.
-	 * This is so other processes can execute while the tone is being
+	 * Make the current thread sleep while the tone is being
 	 * emitted.
 	 */
 	timo = centisecs * hz / 100;
 	if (timo > 0)
 		tsleep(&endtone, SPKRPRI | PCATCH, "spkrtn", timo);
+
+	/*
+	 * Turn off the speaker and release the i8254 clock.
+	 */
 	timer_spkr_release();
 }