include/sound/soc-dapm.h

1 /* SPDX-License-Identifier: GPL-2.0
3  * linux/sound/soc-dapm.h -- ALSA SoC Dynamic Audio Power Management
15 #include <sound/soc-topology.h>
24 #define SND_SOC_NOPM	-1
30  *  1. Codec domain - VREF, VMID
33  *  2. Platform/Machine domain - physically connected inputs and outputs
36  *  3. Path domain - Internal codec path mixers
39  *  4. Stream domain - DAC's and ADC's.
158 /* path domain with event - event handler must return 0 for success */
410 /* regulator widget flags */
419 struct regulator;
430  * @STANDBY: Low power standby state when no playback/capture operations are
431  *           in progress. NOTE: The transition time between STANDBY and ON
499 /* dapm sys fs - used by the core */
518 /* Mostly internal - should not normally be used */
544 	snd_soc_dapm_micbias,		/* microphone bias (power) - DEPRECATED: use snd_soc_dapm_supply */
550 	snd_soc_dapm_vmid,		/* codec bias/vmid - to minimise pops */
551 	snd_soc_dapm_pre,		/* machine specific pre widget - exec first */
552 	snd_soc_dapm_post,		/* machine specific post widget - exec last */
555 	snd_soc_dapm_regulator_supply,	/* external regulator */
564 	snd_soc_dapm_kcontrol,		/* Auto-disabled kcontrol */
602 	 * p->source, rather than p->node[SND_SOC_DAPM_DIR_IN]
635 	struct regulator *regulator;		/* attached regulator */  member
641 	unsigned int mask;			/* non-shifted mask */
642 	unsigned int on_val;			/* on state value */
643 	unsigned int off_val;			/* off state value */
648 	unsigned char force:1;			/* force state */
699 	unsigned int idle_bias_off:1;		/* Use BIAS_OFF instead of STANDBY */
702 	struct device *dev;			/* from parent - for debug */
726 	     (i) < list->num_widgets && (widget = list->widgets[i]);	\
741  * snd_soc_dapm_init_bias_level() - Initialize DAPM bias level
745  * This function only sets the driver internal state of the DAPM level and will
746  * not modify the state of the device. Hence it should not be used during normal
747  * operation, but only to synchronize the internal state to the device state.
749  * the power-on reset state of the device.
751  * To change the DAPM state of the device use snd_soc_dapm_set_bias_level().
756 	dapm->bias_level = level;  in snd_soc_dapm_init_bias_level()
760  * snd_soc_dapm_get_bias_level() - Get current DAPM bias level
768 	return dapm->bias_level;  in snd_soc_dapm_get_bias_level()
782  * snd_soc_dapm_widget_for_each_path - Iterates over all paths in the
790 	list_for_each_entry(p, &w->edges[dir], list_node[dir])
793  * snd_soc_dapm_widget_for_each_path_safe - Iterates over all paths in the
805 	list_for_each_entry_safe(p, next_p, &w->edges[dir], list_node[dir])
808  * snd_soc_dapm_widget_for_each_sink_path - Iterates over all paths leaving a
817  * snd_soc_dapm_widget_for_each_source_path - Iterates over all paths leading to