Commit 9f1614aa authored by Markus Pargmann's avatar Markus Pargmann Committed by Mark Brown
Browse files

ASoC: snd_soc_dai_ops trigger function description 



Add a comment to the trigger function in snd_soc_dai_ops struct about
possible command sequences.

Signed-off-by: default avatarMarkus Pargmann <mpa@pengutronix.de>
Signed-off-by: default avatarMark Brown <broonie@linaro.org>
parent 38f2b8cb

include/sound/soc-dai.h

+7 −0
Original line number Diff line number Diff line
@@ -166,6 +166,13 @@ struct snd_soc_dai_ops { 
		struct snd_soc_dai *);

	int (*prepare)(struct snd_pcm_substream *,

		struct snd_soc_dai *);

	/*

	 * NOTE: Commands passed to the trigger function are not necessarily

	 * compatible with the current state of the dai. For example this

	 * sequence of commands is possible: START STOP STOP.

	 * So do not unconditionally use refcounting functions in the trigger

	 * function, e.g. clk_enable/disable.

	 */

	int (*trigger)(struct snd_pcm_substream *, int,

		struct snd_soc_dai *);

	int (*bespoke_trigger)(struct snd_pcm_substream *, int,