sound/soc/dapm.rst

11 management frameworks and, as such, can easily co-exist with them.
21  * a **widget** is every part of the audio hardware that can be enabled by
32 The graph for the STM32MP1-DK1 sound card is shown in picture:
34 .. kernel-figure:: dapm-graph.svg
47       can be set at stream time if power is not needed for sidetone, etc.
129 ASRC
139 (Widgets are defined in include/sound/soc-dapm.h)
141 Widgets can be added to the sound card by any of the component driver types.
142 There are convenience macros defined in soc-dapm.h that can be used to quickly
150 ---------------------
165 e.g. stream widgets for HiFi playback and capture
168   SND_SOC_DAPM_DAC("HiFi DAC", "HiFi Playback", REG, 3, 1),
169   SND_SOC_DAPM_ADC("HiFi ADC", "HiFi Capture", REG, 2, 1),
179 -------------------
187 Any widget kcontrols can be set using the controls and num_controls members.
196   SOC_DAPM_SINGLE("HiFi Playback Switch", WM8731_APANA, 4, 1, 0),
208 ----------------------
212 machine audio component (non codec or DSP) that can be independently
234 -------------------
242 ---------------
246 a virtual widget - a widget with no control bits e.g.
251 This can be used to merge two signal paths together in software.
290 In more complex cases the list of DAPM widgets and/or routes can be only
293 separate widgets and routes arrays implementing the case-specific features
294 can be registered programmatically by calling snd_soc_dapm_new_controls()
302 audio paths (called interconnections). Each interconnection must be defined in
312 2. DAC (HiFi playback)
322 	{"Output Mixer", "HiFi Playback Switch", "DAC"},
329 * ``Output Mixer`` is connected to the ``DAC`` via the ``HiFi Playback Switch``.
338 Finally, snd_soc_dapm_new_widgets() must be called after all widgets and
345 -------------------------------
371 Endpoints are added to the DAPM graph so that their usage can be determined in
372 order to save power. e.g. NC codecs pins will be switched OFF, unconnected
373 jacks can also be switched OFF.
401 See soc-dapm.h for all other widgets that support events.
405 -----------