From: Jaroslav Kysela <perex@perex.cz>
Date: Fri, 5 Jun 2020 09:54:34 +0000 (+0200)
Subject: pcm: clarify -ENODATA description (recovery, event)
X-Git-Tag: v1.2.3~14
X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=f3597737defe495f9c618b12507c9528c0ade1ee;p=alsa-lib.git

pcm: clarify -ENODATA description (recovery, event)

Signed-off-by: Jaroslav Kysela <perex@perex.cz>
---

diff --git a/src/pcm/pcm.c b/src/pcm/pcm.c
index cfa054b5..eb8f686d 100644
--- a/src/pcm/pcm.c
+++ b/src/pcm/pcm.c
@@ -300,6 +300,11 @@ PCM device for echo reference as described by SND_USE_CASE_MOD_ECHO_REF
 UCM token, may return -ENODATA if the linked playback stream has not been
 started.
 
+There is no defined recovery or event mechanism to signal the data / link
+availability at the moment. The PCM must be completely restarted until
+the mechanism is designed. The #snd_pcm_recover() function cannot be
+used for this.
+
 \section pcm_params Managing parameters
 
 The ALSA PCM device uses two groups of PCM related parameters. The hardware