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>
23 #define SND_SOC_NOPM	-1
26  * SoC dynamic audio power management
29  *  1. Codec domain - VREF, VMID
32  *  2. Platform/Machine domain - physically connected inputs and outputs
35  *  3. Path domain - Internal codec path mixers
38  *  4. Stream domain - DAC's and ADC's.
137 /* path domain with event - event handler must return 0 for success */
257 /* generic widgets */
352 #define SND_SOC_DAPM_PRE_REG	0x10	/* before audio path setup */
353 #define SND_SOC_DAPM_POST_REG	0x20	/* after audio path setup */
384  * @ON:      Bias is fully on for audio playback and capture operations.
385  * @PREPARE: Prepare for audio operations. Called before DAPM switching for
468 /* dapm sys fs - used by the core */
473 /* dapm audio pin control and status */
497 /* Mostly internal - should not normally be used */
528 	snd_soc_dapm_micbias,		/* microphone bias (power) - DEPRECATED: use snd_soc_dapm_supply */
534 	snd_soc_dapm_vmid,			/* codec bias/vmid - to minimise pops */
535 	snd_soc_dapm_pre,			/* machine specific pre widget - exec first */
536 	snd_soc_dapm_post,			/* machine specific post widget - exec last */
541 	snd_soc_dapm_aif_in,		/* audio interface input */
542 	snd_soc_dapm_aif_out,		/* audio interface output */
548 	snd_soc_dapm_kcontrol,		/* Auto-disabled kcontrol */
554 	snd_soc_dapm_encoder,		/* FW/SW audio encoder component */
555 	snd_soc_dapm_decoder,		/* FW/SW audio decoder component */
567  * DAPM audio route definition.
569  * Defines an audio route originating at source via control and finishing
584 /* dapm audio path between two widgets */
589 	 * source (input) and sink (output) widgets
591 	 * p->source, rather than p->node[SND_SOC_DAPM_DIR_IN]
602 	u32 connect:1;	/* source and sink widgets are connected */
605 	u32 is_supply:1;	/* At least one of the connected widgets is a supply */
630 	unsigned int mask;			/* non-shifted mask */
693 	struct device *dev; /* from parent - for debug */
709 /* A list of widgets associated with an object, typically a snd_kcontrol */
712 	struct snd_soc_dapm_widget *widgets[];  member
717 	     (i) < list->num_widgets && (widget = list->widgets[i]);	\
732  * snd_soc_dapm_init_bias_level() - Initialize DAPM bias level
740  * the power-on reset state of the device.
747 	dapm->bias_level = level;  in snd_soc_dapm_init_bias_level()
751  * snd_soc_dapm_get_bias_level() - Get current DAPM bias level
759 	return dapm->bias_level;  in snd_soc_dapm_get_bias_level()
773  * snd_soc_dapm_widget_for_each_sink_path - Iterates over all paths in the
777  *       incoming or outgoing widgets
781 	list_for_each_entry(p, &w->edges[dir], list_node[dir])
784  * snd_soc_dapm_widget_for_each_sink_path_safe - Iterates over all paths in the
788  *       incoming or outgoing widgets
796 	list_for_each_entry_safe(p, next_p, &w->edges[dir], list_node[dir])
799  * snd_soc_dapm_widget_for_each_sink_path - Iterates over all paths leaving a
808  * snd_soc_dapm_widget_for_each_source_path - Iterates over all paths leading to