[RFC,5/9] pcm: Annotate the _delay functions based on findings from the previous bug

Message ID 20200612095530.3970-5-mark@xwax.org
State New
Headers show
Series
  • [RFC,1/9] control: Fix typos in the namehint example
Related show

Commit Message

Mark Hills June 12, 2020, 9:55 a.m.
---
 src/pcm/pcm_local.h | 6 ++++++
 1 file changed, 6 insertions(+)

Patch

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);