From: Peter Maydell <peter.maydell@linaro.org>
Date: Fri, 10 Nov 2023 16:43:18 +0000 (+0000)
Subject: hw/audio/es1370: Clean up comment
X-Git-Tag: qemu-xen-4.20.0~423^2
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=4409a6d85522925df580554d476161a570bb1ed9;p=qemu-xen.git

hw/audio/es1370: Clean up comment

Replace a sweary comment with one that's a bit more helpful to
future readers of the code.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Volker Rümelin <vr_qemu@t-online.de>
Message-ID: <20231110164318.2197569-1-peter.maydell@linaro.org>
Signed-off-by: Thomas Huth <thuth@redhat.com>
---

diff --git a/hw/audio/es1370.c b/hw/audio/es1370.c
index 91c47330ad..fad5541211 100644
--- a/hw/audio/es1370.c
+++ b/hw/audio/es1370.c
@@ -670,8 +670,13 @@ static void es1370_transfer_audio (ES1370State *s, struct chan *d, int loop_sel,
     cnt += (transferred + d->leftover) >> 2;
 
     if (s->sctl & loop_sel) {
-        /* Bah, how stupid is that having a 0 represent true value?
-           i just spent few hours on this shit */
+        /*
+         * loop_sel tells us which bit in the SCTL register to look at
+         * (either P1_LOOP_SEL, P2_LOOP_SEL or R1_LOOP_SEL). The sense
+         * of these bits is 0 for loop mode (set interrupt and keep recording
+         * when the sample count reaches zero) or 1 for stop mode (set
+         * interrupt and stop recording).
+         */
         AUD_log ("es1370: warning", "non looping mode\n");
     } else {
         d->frame_cnt = size;