From: Mark Hills <mark@xwax.org>
Date: Mon, 22 Jun 2020 13:15:11 +0000 (+0100)
Subject: pcm: Annotate the _delay functions based on findings from the previous bug
X-Git-Tag: v1.2.3.2~8
X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=243105769b23d5c2c9462d85ae98ca31a38ce250;p=alsa-lib.git

pcm: Annotate the _delay functions based on findings from the previous bug

Signed-off-by: Mark Hills <mark@xwax.org>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
---

diff --git a/src/pcm/pcm_local.h b/src/pcm/pcm_local.h
index 1fa8e61d..cf018fc0 100644
--- a/src/pcm/pcm_local.h
+++ b/src/pcm/pcm_local.h
@@ -582,11 +582,17 @@ static inline snd_pcm_uframes_t snd_pcm_mmap_hw_offset(snd_pcm_t *pcm)
 	return *pcm->hw.ptr % pcm->buffer_size;
 }
 
+/*
+ * \retval number of frames pending from application to hardware
+ */
 static inline snd_pcm_uframes_t snd_pcm_mmap_playback_delay(snd_pcm_t *pcm)
 {
 	return snd_pcm_mmap_playback_hw_avail(pcm);
 }
 
+/*
+ * \retval number of frames pending from hardware to application
+ */
 static inline snd_pcm_uframes_t snd_pcm_mmap_capture_delay(snd_pcm_t *pcm)
 {
 	return snd_pcm_mmap_capture_avail(pcm);