blob: 344b96c206a39ec886a3cbb983008127266d9b48 [file] [log] [blame]
Richard Purdie808db4a2006-10-06 18:20:14 +02001/*
2 * linux/sound/soc-dapm.h -- ALSA SoC Dynamic Audio Power Management
3 *
4 * Author: Liam Girdwood
5 * Created: Aug 11th 2005
6 * Copyright: Wolfson Microelectronics. PLC.
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#ifndef __LINUX_SND_SOC_DAPM_H
14#define __LINUX_SND_SOC_DAPM_H
15
Richard Purdie808db4a2006-10-06 18:20:14 +020016#include <linux/types.h>
17#include <sound/control.h>
Liam Girdwood8a978232015-05-29 19:06:14 +010018#include <sound/soc-topology.h>
Liam Girdwoodc147c0e2015-05-29 19:06:13 +010019#include <sound/asoc.h>
Richard Purdie808db4a2006-10-06 18:20:14 +020020
Paul Gortmaker313162d2012-01-30 11:46:54 -050021struct device;
22
Richard Purdie808db4a2006-10-06 18:20:14 +020023/* widget has no PM register bit */
24#define SND_SOC_NOPM -1
25
26/*
Joe Perchesb7d2a802007-12-18 13:14:21 +010027 * SoC dynamic audio power management
Richard Purdie808db4a2006-10-06 18:20:14 +020028 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -030029 * We can have up to 4 power domains
Lu Guanqun28683e02011-04-20 16:00:46 +080030 * 1. Codec domain - VREF, VMID
Richard Purdie808db4a2006-10-06 18:20:14 +020031 * Usually controlled at codec probe/remove, although can be set
32 * at stream time if power is not needed for sidetone, etc.
33 * 2. Platform/Machine domain - physically connected inputs and outputs
34 * Is platform/machine and user action specific, is set in the machine
35 * driver and by userspace e.g when HP are inserted
36 * 3. Path domain - Internal codec path mixers
37 * Are automatically set when mixer and mux settings are
38 * changed by the user.
39 * 4. Stream domain - DAC's and ADC's.
40 * Enabled when stream playback/capture is started.
41 */
42
43/* codec domain */
44#define SND_SOC_DAPM_VMID(wname) \
Stephen Warren82cfecd2011-04-28 17:37:58 -060045{ .id = snd_soc_dapm_vmid, .name = wname, .kcontrol_news = NULL, \
Richard Purdie808db4a2006-10-06 18:20:14 +020046 .num_kcontrols = 0}
47
48/* platform domain */
Mark Brown1ab97c82011-11-27 16:21:51 +000049#define SND_SOC_DAPM_SIGGEN(wname) \
50{ .id = snd_soc_dapm_siggen, .name = wname, .kcontrol_news = NULL, \
51 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
Vinod Koul56b44372015-11-23 21:22:30 +053052#define SND_SOC_DAPM_SINK(wname) \
53{ .id = snd_soc_dapm_sink, .name = wname, .kcontrol_news = NULL, \
54 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
Richard Purdie808db4a2006-10-06 18:20:14 +020055#define SND_SOC_DAPM_INPUT(wname) \
Stephen Warren82cfecd2011-04-28 17:37:58 -060056{ .id = snd_soc_dapm_input, .name = wname, .kcontrol_news = NULL, \
Mark Brown0ca03cd2011-03-23 20:45:40 +000057 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
Richard Purdie808db4a2006-10-06 18:20:14 +020058#define SND_SOC_DAPM_OUTPUT(wname) \
Stephen Warren82cfecd2011-04-28 17:37:58 -060059{ .id = snd_soc_dapm_output, .name = wname, .kcontrol_news = NULL, \
Mark Brown0ca03cd2011-03-23 20:45:40 +000060 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
Richard Purdie808db4a2006-10-06 18:20:14 +020061#define SND_SOC_DAPM_MIC(wname, wevent) \
Stephen Warren82cfecd2011-04-28 17:37:58 -060062{ .id = snd_soc_dapm_mic, .name = wname, .kcontrol_news = NULL, \
Mark Brown0ca03cd2011-03-23 20:45:40 +000063 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
Richard Purdie808db4a2006-10-06 18:20:14 +020064 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
65#define SND_SOC_DAPM_HP(wname, wevent) \
Stephen Warren82cfecd2011-04-28 17:37:58 -060066{ .id = snd_soc_dapm_hp, .name = wname, .kcontrol_news = NULL, \
Mark Brown0ca03cd2011-03-23 20:45:40 +000067 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
Richard Purdie808db4a2006-10-06 18:20:14 +020068 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
69#define SND_SOC_DAPM_SPK(wname, wevent) \
Stephen Warren82cfecd2011-04-28 17:37:58 -060070{ .id = snd_soc_dapm_spk, .name = wname, .kcontrol_news = NULL, \
Mark Brown0ca03cd2011-03-23 20:45:40 +000071 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
Richard Purdie808db4a2006-10-06 18:20:14 +020072 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
73#define SND_SOC_DAPM_LINE(wname, wevent) \
Stephen Warren82cfecd2011-04-28 17:37:58 -060074{ .id = snd_soc_dapm_line, .name = wname, .kcontrol_news = NULL, \
Mark Brown0ca03cd2011-03-23 20:45:40 +000075 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
Richard Purdie808db4a2006-10-06 18:20:14 +020076 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
77
Lars-Peter Clausende9ba982013-07-29 17:14:01 +020078#define SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) \
79 .reg = wreg, .mask = 1, .shift = wshift, \
80 .on_val = winvert ? 0 : 1, .off_val = winvert ? 1 : 0
81
Richard Purdie808db4a2006-10-06 18:20:14 +020082/* path domain */
83#define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\
84 wcontrols, wncontrols) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +020085{ .id = snd_soc_dapm_pga, .name = wname, \
86 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
87 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
Olaya, Margaritad88429a2010-12-10 21:11:44 -060088#define SND_SOC_DAPM_OUT_DRV(wname, wreg, wshift, winvert,\
89 wcontrols, wncontrols) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +020090{ .id = snd_soc_dapm_out_drv, .name = wname, \
91 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
92 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
Richard Purdie808db4a2006-10-06 18:20:14 +020093#define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
94 wcontrols, wncontrols)\
Lars-Peter Clausende9ba982013-07-29 17:14:01 +020095{ .id = snd_soc_dapm_mixer, .name = wname, \
96 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
97 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
Ian Moltonca9c1aa2009-01-06 20:11:51 +000098#define SND_SOC_DAPM_MIXER_NAMED_CTL(wname, wreg, wshift, winvert, \
99 wcontrols, wncontrols)\
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200100{ .id = snd_soc_dapm_mixer_named_ctl, .name = wname, \
101 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
102 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
John Keeping32902172016-05-12 13:55:53 +0100103/* DEPRECATED: use SND_SOC_DAPM_SUPPLY */
Richard Purdie808db4a2006-10-06 18:20:14 +0200104#define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200105{ .id = snd_soc_dapm_micbias, .name = wname, \
106 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
107 .kcontrol_news = NULL, .num_kcontrols = 0}
Richard Purdie808db4a2006-10-06 18:20:14 +0200108#define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200109{ .id = snd_soc_dapm_switch, .name = wname, \
110 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
111 .kcontrol_news = wcontrols, .num_kcontrols = 1}
Richard Purdie808db4a2006-10-06 18:20:14 +0200112#define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
Stephen Warrenfaf66152013-11-22 10:29:18 -0700113{ .id = snd_soc_dapm_mux, .name = wname, \
114 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200115 .kcontrol_news = wcontrols, .num_kcontrols = 1}
Lars-Peter Clausend714f972015-05-01 18:02:43 +0200116#define SND_SOC_DAPM_DEMUX(wname, wreg, wshift, winvert, wcontrols) \
117{ .id = snd_soc_dapm_demux, .name = wname, \
118 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
119 .kcontrol_news = wcontrols, .num_kcontrols = 1}
Richard Purdie808db4a2006-10-06 18:20:14 +0200120
Guennadi Liakhovetski8484c632010-01-21 21:10:47 +0100121/* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
122#define SOC_PGA_ARRAY(wname, wreg, wshift, winvert,\
123 wcontrols) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200124{ .id = snd_soc_dapm_pga, .name = wname, \
125 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
126 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
Guennadi Liakhovetski8484c632010-01-21 21:10:47 +0100127#define SOC_MIXER_ARRAY(wname, wreg, wshift, winvert, \
128 wcontrols)\
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200129{ .id = snd_soc_dapm_mixer, .name = wname, \
130 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
131 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
Guennadi Liakhovetski8484c632010-01-21 21:10:47 +0100132#define SOC_MIXER_NAMED_CTL_ARRAY(wname, wreg, wshift, winvert, \
133 wcontrols)\
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200134{ .id = snd_soc_dapm_mixer_named_ctl, .name = wname, \
135 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
136 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
Guennadi Liakhovetski8484c632010-01-21 21:10:47 +0100137
Richard Purdie808db4a2006-10-06 18:20:14 +0200138/* path domain with event - event handler must return 0 for success */
139#define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \
140 wncontrols, wevent, wflags) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200141{ .id = snd_soc_dapm_pga, .name = wname, \
142 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
143 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200144 .event = wevent, .event_flags = wflags}
Olaya, Margaritad88429a2010-12-10 21:11:44 -0600145#define SND_SOC_DAPM_OUT_DRV_E(wname, wreg, wshift, winvert, wcontrols, \
146 wncontrols, wevent, wflags) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200147{ .id = snd_soc_dapm_out_drv, .name = wname, \
148 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
149 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
Olaya, Margaritad88429a2010-12-10 21:11:44 -0600150 .event = wevent, .event_flags = wflags}
Richard Purdie808db4a2006-10-06 18:20:14 +0200151#define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \
152 wncontrols, wevent, wflags) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200153{ .id = snd_soc_dapm_mixer, .name = wname, \
154 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
155 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200156 .event = wevent, .event_flags = wflags}
Ian Moltonca9c1aa2009-01-06 20:11:51 +0000157#define SND_SOC_DAPM_MIXER_NAMED_CTL_E(wname, wreg, wshift, winvert, \
158 wcontrols, wncontrols, wevent, wflags) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200159{ .id = snd_soc_dapm_mixer, .name = wname, \
160 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
161 .kcontrol_news = wcontrols, \
Ian Moltonca9c1aa2009-01-06 20:11:51 +0000162 .num_kcontrols = wncontrols, .event = wevent, .event_flags = wflags}
Richard Purdie808db4a2006-10-06 18:20:14 +0200163#define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
164 wevent, wflags) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200165{ .id = snd_soc_dapm_switch, .name = wname, \
166 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
167 .kcontrol_news = wcontrols, .num_kcontrols = 1, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200168 .event = wevent, .event_flags = wflags}
169#define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
170 wevent, wflags) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200171{ .id = snd_soc_dapm_mux, .name = wname, \
172 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
173 .kcontrol_news = wcontrols, .num_kcontrols = 1, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200174 .event = wevent, .event_flags = wflags}
175
Mark Brown20e48592011-01-15 13:40:50 +0000176/* additional sequencing control within an event type */
Mark Brown3d23c732011-01-24 21:51:25 +0000177#define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \
178 wevent, wflags) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200179{ .id = snd_soc_dapm_pga, .name = wname, \
180 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
181 .event = wevent, .event_flags = wflags, \
Mark Brown3d23c732011-01-24 21:51:25 +0000182 .subseq = wsubseq}
Mark Brown20e48592011-01-15 13:40:50 +0000183#define SND_SOC_DAPM_SUPPLY_S(wname, wsubseq, wreg, wshift, winvert, wevent, \
184 wflags) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200185{ .id = snd_soc_dapm_supply, .name = wname, \
186 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
187 .event = wevent, .event_flags = wflags, .subseq = wsubseq}
Mark Brown20e48592011-01-15 13:40:50 +0000188
Guennadi Liakhovetski8484c632010-01-21 21:10:47 +0100189/* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
190#define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
191 wevent, wflags) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200192{ .id = snd_soc_dapm_pga, .name = wname, \
193 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
194 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
Guennadi Liakhovetski8484c632010-01-21 21:10:47 +0100195 .event = wevent, .event_flags = wflags}
196#define SOC_MIXER_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
197 wevent, wflags) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200198{ .id = snd_soc_dapm_mixer, .name = wname, \
199 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
200 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
Guennadi Liakhovetski8484c632010-01-21 21:10:47 +0100201 .event = wevent, .event_flags = wflags}
202#define SOC_MIXER_NAMED_CTL_E_ARRAY(wname, wreg, wshift, winvert, \
203 wcontrols, wevent, wflags) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200204{ .id = snd_soc_dapm_mixer, .name = wname, \
205 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
206 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
207 .event = wevent, .event_flags = wflags}
Guennadi Liakhovetski8484c632010-01-21 21:10:47 +0100208
Richard Purdie808db4a2006-10-06 18:20:14 +0200209/* events that are pre and post DAPM */
210#define SND_SOC_DAPM_PRE(wname, wevent) \
Stephen Warren82cfecd2011-04-28 17:37:58 -0600211{ .id = snd_soc_dapm_pre, .name = wname, .kcontrol_news = NULL, \
Mark Brown0ca03cd2011-03-23 20:45:40 +0000212 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200213 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
214#define SND_SOC_DAPM_POST(wname, wevent) \
Stephen Warren82cfecd2011-04-28 17:37:58 -0600215{ .id = snd_soc_dapm_post, .name = wname, .kcontrol_news = NULL, \
Mark Brown0ca03cd2011-03-23 20:45:40 +0000216 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200217 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
218
219/* stream domain */
Mark Brown010ff262009-08-17 17:39:22 +0100220#define SND_SOC_DAPM_AIF_IN(wname, stname, wslot, wreg, wshift, winvert) \
221{ .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200222 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
Mark Brownea0d09d2010-09-03 19:36:28 +0100223#define SND_SOC_DAPM_AIF_IN_E(wname, stname, wslot, wreg, wshift, winvert, \
224 wevent, wflags) \
225{ .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200226 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
Mark Brownea0d09d2010-09-03 19:36:28 +0100227 .event = wevent, .event_flags = wflags }
Mark Brown010ff262009-08-17 17:39:22 +0100228#define SND_SOC_DAPM_AIF_OUT(wname, stname, wslot, wreg, wshift, winvert) \
229{ .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200230 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
Mark Brownea0d09d2010-09-03 19:36:28 +0100231#define SND_SOC_DAPM_AIF_OUT_E(wname, stname, wslot, wreg, wshift, winvert, \
232 wevent, wflags) \
233{ .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200234 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
Mark Brownea0d09d2010-09-03 19:36:28 +0100235 .event = wevent, .event_flags = wflags }
Richard Purdie808db4a2006-10-06 18:20:14 +0200236#define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200237{ .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \
238 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) }
Mark Brownf6d655a2009-04-13 11:27:03 +0100239#define SND_SOC_DAPM_DAC_E(wname, stname, wreg, wshift, winvert, \
240 wevent, wflags) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200241{ .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \
242 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
Mark Brownf6d655a2009-04-13 11:27:03 +0100243 .event = wevent, .event_flags = wflags}
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200244
Richard Purdie808db4a2006-10-06 18:20:14 +0200245#define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200246{ .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \
247 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
Mark Brownf6d655a2009-04-13 11:27:03 +0100248#define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \
249 wevent, wflags) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200250{ .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \
251 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
Mark Brownf6d655a2009-04-13 11:27:03 +0100252 .event = wevent, .event_flags = wflags}
Ola Liljad7e7eb92012-05-24 15:26:25 +0200253#define SND_SOC_DAPM_CLOCK_SUPPLY(wname) \
254{ .id = snd_soc_dapm_clock_supply, .name = wname, \
255 .reg = SND_SOC_NOPM, .event = dapm_clock_event, \
256 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD }
Richard Purdie808db4a2006-10-06 18:20:14 +0200257
Mark Brown246d0a12009-04-22 18:24:55 +0100258/* generic widgets */
Jarkko Nikulae2be2cc2008-06-25 14:42:07 +0300259#define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
Stephen Warren82cfecd2011-04-28 17:37:58 -0600260{ .id = wid, .name = wname, .kcontrol_news = NULL, .num_kcontrols = 0, \
Lars-Peter Clausen94986192014-05-11 19:27:47 +0200261 .reg = wreg, .shift = wshift, .mask = wmask, \
262 .on_val = won_val, .off_val = woff_val, }
Mark Brown246d0a12009-04-22 18:24:55 +0100263#define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200264{ .id = snd_soc_dapm_supply, .name = wname, \
265 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
266 .event = wevent, .event_flags = wflags}
Mark Brown822b4b82012-09-07 10:54:32 +0800267#define SND_SOC_DAPM_REGULATOR_SUPPLY(wname, wdelay, wflags) \
Mark Brown62ea8742012-01-21 21:14:48 +0000268{ .id = snd_soc_dapm_regulator_supply, .name = wname, \
269 .reg = SND_SOC_NOPM, .shift = wdelay, .event = dapm_regulator_event, \
Mark Brown822b4b82012-09-07 10:54:32 +0800270 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD, \
Lars-Peter Clausende9ba982013-07-29 17:14:01 +0200271 .on_val = wflags}
Jarkko Nikulae2be2cc2008-06-25 14:42:07 +0300272
Ola Liljad7e7eb92012-05-24 15:26:25 +0200273
Richard Purdie808db4a2006-10-06 18:20:14 +0200274/* dapm kcontrol types */
Chen-Yu Tsai9ee7ef32016-11-02 15:36:00 +0800275#define SOC_DAPM_DOUBLE(xname, reg, lshift, rshift, max, invert) \
276{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
277 .info = snd_soc_info_volsw, \
278 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
279 .private_value = SOC_DOUBLE_VALUE(reg, lshift, rshift, max, invert, 0) }
Chen-Yu Tsai02866ea2016-11-02 15:36:01 +0800280#define SOC_DAPM_DOUBLE_R(xname, lreg, rreg, shift, max, invert) \
281{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
282 .info = snd_soc_info_volsw, \
283 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
284 .private_value = SOC_DOUBLE_R_VALUE(lreg, rreg, shift, max, invert) }
Philipp Zabela7a4ac82008-01-10 14:37:42 +0100285#define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +0200286{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
287 .info = snd_soc_info_volsw, \
288 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200289 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
290#define SOC_DAPM_SINGLE_AUTODISABLE(xname, reg, shift, max, invert) \
291{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
292 .info = snd_soc_info_volsw, \
293 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
294 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 1) }
Lars-Peter Clausen249ce132013-10-06 13:43:49 +0200295#define SOC_DAPM_SINGLE_VIRT(xname, max) \
296 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0)
Philipp Zabela7a4ac82008-01-10 14:37:42 +0100297#define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
298{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
299 .info = snd_soc_info_volsw, \
300 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
301 .tlv.p = (tlv_array), \
302 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200303 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
304#define SOC_DAPM_SINGLE_TLV_AUTODISABLE(xname, reg, shift, max, invert, tlv_array) \
305{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
306 .info = snd_soc_info_volsw, \
307 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
308 .tlv.p = (tlv_array), \
309 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
Charles Keepaxa2d97722015-04-22 13:58:47 +0100310 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 1) }
Lars-Peter Clausen249ce132013-10-06 13:43:49 +0200311#define SOC_DAPM_SINGLE_TLV_VIRT(xname, max, tlv_array) \
312 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0, tlv_array)
Richard Purdie808db4a2006-10-06 18:20:14 +0200313#define SOC_DAPM_ENUM(xname, xenum) \
314{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
315 .info = snd_soc_info_enum_double, \
316 .get = snd_soc_dapm_get_enum_double, \
317 .put = snd_soc_dapm_put_enum_double, \
318 .private_value = (unsigned long)&xenum }
Liam Girdwoodc219c802011-07-20 19:42:20 +0100319#define SOC_DAPM_ENUM_EXT(xname, xenum, xget, xput) \
320{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
321 .info = snd_soc_info_enum_double, \
322 .get = xget, \
323 .put = xput, \
324 .private_value = (unsigned long)&xenum }
Mark Brown8b37dbd2009-02-28 21:14:20 +0000325#define SOC_DAPM_PIN_SWITCH(xname) \
326{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
327 .info = snd_soc_dapm_info_pin_switch, \
328 .get = snd_soc_dapm_get_pin_switch, \
329 .put = snd_soc_dapm_put_pin_switch, \
330 .private_value = (unsigned long)xname }
Richard Purdie808db4a2006-10-06 18:20:14 +0200331
332/* dapm stream operations */
333#define SND_SOC_DAPM_STREAM_NOP 0x0
334#define SND_SOC_DAPM_STREAM_START 0x1
335#define SND_SOC_DAPM_STREAM_STOP 0x2
336#define SND_SOC_DAPM_STREAM_SUSPEND 0x4
337#define SND_SOC_DAPM_STREAM_RESUME 0x8
338#define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10
339#define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20
340
341/* dapm event types */
342#define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */
343#define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */
344#define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */
345#define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */
346#define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */
347#define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */
Mark Brown80114122013-02-25 15:14:19 +0000348#define SND_SOC_DAPM_WILL_PMU 0x40 /* called at start of sequence */
349#define SND_SOC_DAPM_WILL_PMD 0x80 /* called at start of sequence */
apatard@mandriva.comea762b02010-05-27 14:57:40 +0200350#define SND_SOC_DAPM_PRE_POST_PMD \
351 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
Richard Purdie808db4a2006-10-06 18:20:14 +0200352
353/* convenience event type detection */
354#define SND_SOC_DAPM_EVENT_ON(e) \
355 (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
356#define SND_SOC_DAPM_EVENT_OFF(e) \
357 (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
358
Mark Brownc05b84d2012-09-07 12:57:11 +0800359/* regulator widget flags */
360#define SND_SOC_DAPM_REGULATOR_BYPASS 0x1 /* bypass when disabled */
361
Richard Purdie808db4a2006-10-06 18:20:14 +0200362struct snd_soc_dapm_widget;
363enum snd_soc_dapm_type;
364struct snd_soc_dapm_path;
365struct snd_soc_dapm_pin;
Mark Brown105f1c22008-05-13 14:52:19 +0200366struct snd_soc_dapm_route;
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200367struct snd_soc_dapm_context;
Liam Girdwooda3cc0562012-03-09 17:20:16 +0000368struct regulator;
Liam Girdwoodec2e3032012-04-18 11:41:11 +0100369struct snd_soc_dapm_widget_list;
Lars-Peter Clausen6b3fc032013-07-24 15:27:38 +0200370struct snd_soc_dapm_update;
Piotr Stankiewicz67420642016-05-13 17:03:55 +0100371enum snd_soc_dapm_direction;
Richard Purdie808db4a2006-10-06 18:20:14 +0200372
Mark Brown62ea8742012-01-21 21:14:48 +0000373int dapm_regulator_event(struct snd_soc_dapm_widget *w,
374 struct snd_kcontrol *kcontrol, int event);
Ola Liljad7e7eb92012-05-24 15:26:25 +0200375int dapm_clock_event(struct snd_soc_dapm_widget *w,
376 struct snd_kcontrol *kcontrol, int event);
Mark Brown11589412008-07-29 11:42:23 +0100377
Richard Purdie808db4a2006-10-06 18:20:14 +0200378/* dapm controls */
379int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
380 struct snd_ctl_elem_value *ucontrol);
381int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
382 struct snd_ctl_elem_value *ucontrol);
383int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
384 struct snd_ctl_elem_value *ucontrol);
385int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
386 struct snd_ctl_elem_value *ucontrol);
Mark Brown8b37dbd2009-02-28 21:14:20 +0000387int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
388 struct snd_ctl_elem_info *uinfo);
389int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
390 struct snd_ctl_elem_value *uncontrol);
391int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
392 struct snd_ctl_elem_value *uncontrol);
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200393int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
Mark Brown4ba13272008-05-13 14:51:19 +0200394 const struct snd_soc_dapm_widget *widget,
395 int num);
Subhransu S. Prustya5d56392016-06-27 09:18:03 +0530396struct snd_soc_dapm_widget *snd_soc_dapm_new_control(
397 struct snd_soc_dapm_context *dapm,
398 const struct snd_soc_dapm_widget *widget);
Mark Brown888df392012-02-16 19:37:51 -0800399int snd_soc_dapm_new_dai_widgets(struct snd_soc_dapm_context *dapm,
400 struct snd_soc_dai *dai);
401int snd_soc_dapm_link_dai_widgets(struct snd_soc_card *card);
Liam Girdwoodb893ea52014-01-08 10:40:19 +0000402void snd_soc_dapm_connect_dai_link_widgets(struct snd_soc_card *card);
Mark Brownc74184e2012-04-04 22:12:09 +0100403int snd_soc_dapm_new_pcm(struct snd_soc_card *card,
404 const struct snd_soc_pcm_stream *params,
Nikesh Oswalc6615082015-02-02 17:06:44 +0000405 unsigned int num_params,
Mark Brownc74184e2012-04-04 22:12:09 +0100406 struct snd_soc_dapm_widget *source,
407 struct snd_soc_dapm_widget *sink);
Richard Purdie808db4a2006-10-06 18:20:14 +0200408
409/* dapm path setup */
Lars-Peter Clausen824ef822013-08-27 15:51:01 +0200410int snd_soc_dapm_new_widgets(struct snd_soc_card *card);
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200411void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
412int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
Mark Brown105f1c22008-05-13 14:52:19 +0200413 const struct snd_soc_dapm_route *route, int num);
Mark Brownefcc3c62012-07-05 17:24:19 +0100414int snd_soc_dapm_del_routes(struct snd_soc_dapm_context *dapm,
415 const struct snd_soc_dapm_route *route, int num);
Mark Brownbf3a9e12011-06-13 16:42:29 +0100416int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm,
417 const struct snd_soc_dapm_route *route, int num);
Lars-Peter Clausenb97e2692015-07-21 18:11:07 +0200418void snd_soc_dapm_free_widget(struct snd_soc_dapm_widget *w);
Jyri Sarhafd589a12015-11-10 18:12:42 +0200419void snd_soc_dapm_reset_cache(struct snd_soc_dapm_context *dapm);
Richard Purdie808db4a2006-10-06 18:20:14 +0200420
421/* dapm events */
Liam Girdwoodd9b09512012-03-07 16:32:59 +0000422void snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd, int stream,
423 int event);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000424void snd_soc_dapm_shutdown(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +0200425
Liam Girdwood40f02cd2012-02-06 16:05:14 +0000426/* external DAPM widget events */
Lars-Peter Clausence6cfaf2013-07-24 15:27:37 +0200427int snd_soc_dapm_mixer_update_power(struct snd_soc_dapm_context *dapm,
Lars-Peter Clausen6b3fc032013-07-24 15:27:38 +0200428 struct snd_kcontrol *kcontrol, int connect,
429 struct snd_soc_dapm_update *update);
Lars-Peter Clausence6cfaf2013-07-24 15:27:37 +0200430int snd_soc_dapm_mux_update_power(struct snd_soc_dapm_context *dapm,
Lars-Peter Clausen6b3fc032013-07-24 15:27:38 +0200431 struct snd_kcontrol *kcontrol, int mux, struct soc_enum *e,
432 struct snd_soc_dapm_update *update);
Liam Girdwood40f02cd2012-02-06 16:05:14 +0000433
Richard Purdie808db4a2006-10-06 18:20:14 +0200434/* dapm sys fs - used by the core */
Takashi Iwaid29697d2015-01-30 20:16:37 +0100435extern struct attribute *soc_dapm_dev_attrs[];
Lars-Peter Clausen8eecaf62011-04-30 19:45:48 +0200436void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm,
437 struct dentry *parent);
Richard Purdie808db4a2006-10-06 18:20:14 +0200438
Liam Girdwooda5302182008-07-07 13:35:17 +0100439/* dapm audio pin control and status */
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200440int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
441 const char *pin);
Charles Keepax11391102014-02-18 15:22:14 +0000442int snd_soc_dapm_enable_pin_unlocked(struct snd_soc_dapm_context *dapm,
443 const char *pin);
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200444int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
445 const char *pin);
Charles Keepax11391102014-02-18 15:22:14 +0000446int snd_soc_dapm_disable_pin_unlocked(struct snd_soc_dapm_context *dapm,
447 const char *pin);
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200448int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
Charles Keepax11391102014-02-18 15:22:14 +0000449int snd_soc_dapm_nc_pin_unlocked(struct snd_soc_dapm_context *dapm,
450 const char *pin);
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200451int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
452 const char *pin);
453int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
Charles Keepax3eb29df2014-02-18 15:22:15 +0000454int snd_soc_dapm_sync_unlocked(struct snd_soc_dapm_context *dapm);
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200455int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
Mark Brownda341832010-03-15 19:23:37 +0000456 const char *pin);
Charles Keepax11391102014-02-18 15:22:14 +0000457int snd_soc_dapm_force_enable_pin_unlocked(struct snd_soc_dapm_context *dapm,
458 const char *pin);
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200459int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
460 const char *pin);
Subhransu S. Prusty5dc0158a2014-09-19 16:46:05 +0530461unsigned int dapm_kcontrol_get_value(const struct snd_kcontrol *kcontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200462
Mark Brown25c77c52011-10-08 13:36:03 +0100463/* Mostly internal - should not normally be used */
Lars-Peter Clausen8be4da22014-10-25 17:42:01 +0200464void dapm_mark_endpoints_dirty(struct snd_soc_card *card);
Mark Brown25c77c52011-10-08 13:36:03 +0100465
Liam Girdwoodec2e3032012-04-18 11:41:11 +0100466/* dapm path query */
467int snd_soc_dapm_dai_get_connected_widgets(struct snd_soc_dai *dai, int stream,
Piotr Stankiewicz67420642016-05-13 17:03:55 +0100468 struct snd_soc_dapm_widget_list **list,
469 bool (*custom_stop_condition)(struct snd_soc_dapm_widget *,
470 enum snd_soc_dapm_direction));
Liam Girdwoodec2e3032012-04-18 11:41:11 +0100471
Lars-Peter Clausence0fc932014-06-16 18:13:06 +0200472struct snd_soc_dapm_context *snd_soc_dapm_kcontrol_dapm(
473 struct snd_kcontrol *kcontrol);
Lars-Peter Clauseneee5d7f2013-07-29 17:13:57 +0200474
Mythri P K93e39a12015-10-20 22:30:08 +0530475struct snd_soc_dapm_widget *snd_soc_dapm_kcontrol_widget(
476 struct snd_kcontrol *kcontrol);
477
Lars-Peter Clausenfa880772015-04-27 22:13:23 +0200478int snd_soc_dapm_force_bias_level(struct snd_soc_dapm_context *dapm,
479 enum snd_soc_bias_level level);
480
Richard Purdie808db4a2006-10-06 18:20:14 +0200481/* dapm widget types */
482enum snd_soc_dapm_type {
483 snd_soc_dapm_input = 0, /* input pin */
484 snd_soc_dapm_output, /* output pin */
485 snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */
Lars-Peter Clausend714f972015-05-01 18:02:43 +0200486 snd_soc_dapm_demux, /* connects the input to one of multiple outputs */
Richard Purdie808db4a2006-10-06 18:20:14 +0200487 snd_soc_dapm_mixer, /* mixes several analog signals together */
Ian Moltonca9c1aa2009-01-06 20:11:51 +0000488 snd_soc_dapm_mixer_named_ctl, /* mixer with named controls */
Richard Purdie808db4a2006-10-06 18:20:14 +0200489 snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */
Olaya, Margaritad88429a2010-12-10 21:11:44 -0600490 snd_soc_dapm_out_drv, /* output driver */
Richard Purdie808db4a2006-10-06 18:20:14 +0200491 snd_soc_dapm_adc, /* analog to digital converter */
492 snd_soc_dapm_dac, /* digital to analog converter */
John Keeping32902172016-05-12 13:55:53 +0100493 snd_soc_dapm_micbias, /* microphone bias (power) - DEPRECATED: use snd_soc_dapm_supply */
Richard Purdie808db4a2006-10-06 18:20:14 +0200494 snd_soc_dapm_mic, /* microphone */
495 snd_soc_dapm_hp, /* headphones */
496 snd_soc_dapm_spk, /* speaker */
497 snd_soc_dapm_line, /* line input/output */
498 snd_soc_dapm_switch, /* analog switch */
499 snd_soc_dapm_vmid, /* codec bias/vmid - to minimise pops */
500 snd_soc_dapm_pre, /* machine specific pre widget - exec first */
501 snd_soc_dapm_post, /* machine specific post widget - exec last */
Mark Brown246d0a12009-04-22 18:24:55 +0100502 snd_soc_dapm_supply, /* power/clock supply */
Mark Brown62ea8742012-01-21 21:14:48 +0000503 snd_soc_dapm_regulator_supply, /* external regulator */
Ola Liljad7e7eb92012-05-24 15:26:25 +0200504 snd_soc_dapm_clock_supply, /* external clock */
Mark Brown010ff262009-08-17 17:39:22 +0100505 snd_soc_dapm_aif_in, /* audio interface input */
506 snd_soc_dapm_aif_out, /* audio interface output */
Mark Brown1ab97c82011-11-27 16:21:51 +0000507 snd_soc_dapm_siggen, /* signal generator */
Vinod Koul56b44372015-11-23 21:22:30 +0530508 snd_soc_dapm_sink,
Mark Brown46162742013-06-05 19:36:11 +0100509 snd_soc_dapm_dai_in, /* link to DAI structure */
510 snd_soc_dapm_dai_out,
Mark Brownc74184e2012-04-04 22:12:09 +0100511 snd_soc_dapm_dai_link, /* link between two DAI structures */
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200512 snd_soc_dapm_kcontrol, /* Auto-disabled kcontrol */
Liam Girdwood8a70b452017-06-29 14:22:24 +0100513 snd_soc_dapm_buffer, /* DSP/CODEC internal buffer */
514 snd_soc_dapm_scheduler, /* DSP/CODEC internal scheduler */
515 snd_soc_dapm_effect, /* DSP/CODEC effect component */
516 snd_soc_dapm_src, /* DSP/CODEC SRC component */
517 snd_soc_dapm_asrc, /* DSP/CODEC ASRC component */
518 snd_soc_dapm_encoder, /* FW/SW audio encoder component */
519 snd_soc_dapm_decoder, /* FW/SW audio decoder component */
Richard Purdie808db4a2006-10-06 18:20:14 +0200520};
521
Liam Girdwooda73fb2d2012-03-07 10:38:26 +0000522enum snd_soc_dapm_subclass {
Liam Girdwood3cd04342012-03-09 12:02:08 +0000523 SND_SOC_DAPM_CLASS_INIT = 0,
524 SND_SOC_DAPM_CLASS_RUNTIME = 1,
Liam Girdwooda73fb2d2012-03-07 10:38:26 +0000525};
526
Mark Brown105f1c22008-05-13 14:52:19 +0200527/*
528 * DAPM audio route definition.
529 *
530 * Defines an audio route originating at source via control and finishing
531 * at sink.
532 */
533struct snd_soc_dapm_route {
534 const char *sink;
535 const char *control;
536 const char *source;
Mark Brown215edda2009-09-08 18:59:05 +0100537
538 /* Note: currently only supported for links where source is a supply */
539 int (*connected)(struct snd_soc_dapm_widget *source,
540 struct snd_soc_dapm_widget *sink);
Mark Brown105f1c22008-05-13 14:52:19 +0200541};
542
Richard Purdie808db4a2006-10-06 18:20:14 +0200543/* dapm audio path between two widgets */
544struct snd_soc_dapm_path {
Mark Brown30565572012-02-16 17:07:42 -0800545 const char *name;
Richard Purdie808db4a2006-10-06 18:20:14 +0200546
Lars-Peter Clausena3423b02015-08-11 21:38:00 +0200547 /*
548 * source (input) and sink (output) widgets
549 * The union is for convience, since it is a lot nicer to type
550 * p->source, rather than p->node[SND_SOC_DAPM_DIR_IN]
551 */
552 union {
553 struct {
554 struct snd_soc_dapm_widget *source;
555 struct snd_soc_dapm_widget *sink;
556 };
557 struct snd_soc_dapm_widget *node[2];
558 };
Richard Purdie808db4a2006-10-06 18:20:14 +0200559
560 /* status */
561 u32 connect:1; /* source and sink widgets are connected */
Mark Brown8af294b2013-02-22 17:48:15 +0000562 u32 walking:1; /* path is in the process of being walked */
Mark Brown169d5a82011-06-14 09:51:50 +0100563 u32 weak:1; /* path ignored for power management */
Lars-Peter Clausenc1862c82014-10-25 17:42:00 +0200564 u32 is_supply:1; /* At least one of the connected widgets is a supply */
Richard Purdie808db4a2006-10-06 18:20:14 +0200565
Mark Brown215edda2009-09-08 18:59:05 +0100566 int (*connected)(struct snd_soc_dapm_widget *source,
567 struct snd_soc_dapm_widget *sink);
568
Lars-Peter Clausena3423b02015-08-11 21:38:00 +0200569 struct list_head list_node[2];
Lars-Peter Clausen5106b922013-07-29 17:14:00 +0200570 struct list_head list_kcontrol;
Richard Purdie808db4a2006-10-06 18:20:14 +0200571 struct list_head list;
572};
573
574/* dapm widget */
575struct snd_soc_dapm_widget {
576 enum snd_soc_dapm_type id;
Mark Brown30565572012-02-16 17:07:42 -0800577 const char *name; /* widget name */
578 const char *sname; /* stream name */
Richard Purdie808db4a2006-10-06 18:20:14 +0200579 struct list_head list;
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200580 struct snd_soc_dapm_context *dapm;
Richard Purdie808db4a2006-10-06 18:20:14 +0200581
Mark Brown62ea8742012-01-21 21:14:48 +0000582 void *priv; /* widget specific data */
Liam Girdwooda3cc0562012-03-09 17:20:16 +0000583 struct regulator *regulator; /* attached regulator */
Mark Brownc74184e2012-04-04 22:12:09 +0100584 const struct snd_soc_pcm_stream *params; /* params for dai links */
Nikesh Oswalc6615082015-02-02 17:06:44 +0000585 unsigned int num_params; /* number of params for dai links */
586 unsigned int params_select; /* currently selected param for dai link */
Mark Brown62ea8742012-01-21 21:14:48 +0000587
Richard Purdie808db4a2006-10-06 18:20:14 +0200588 /* dapm control */
Mark Brown41b5b3b2012-03-08 15:15:46 +0000589 int reg; /* negative reg = no direct dapm */
Richard Purdie808db4a2006-10-06 18:20:14 +0200590 unsigned char shift; /* bits to shift */
Jarkko Nikulae2be2cc2008-06-25 14:42:07 +0300591 unsigned int mask; /* non-shifted mask */
592 unsigned int on_val; /* on state value */
593 unsigned int off_val; /* off state value */
Richard Purdie808db4a2006-10-06 18:20:14 +0200594 unsigned char power:1; /* block power status */
Richard Purdie808db4a2006-10-06 18:20:14 +0200595 unsigned char active:1; /* active stream on DAC, ADC's */
596 unsigned char connected:1; /* connected codec pin */
597 unsigned char new:1; /* cnew complete */
Mark Brownda341832010-03-15 19:23:37 +0000598 unsigned char force:1; /* force state */
Mark Brown1547aba2010-05-07 21:11:40 +0100599 unsigned char ignore_suspend:1; /* kept enabled over suspend */
Mark Brown9b8a83b2011-10-04 22:15:59 +0100600 unsigned char new_power:1; /* power from this run */
601 unsigned char power_checked:1; /* power checked this run */
Lars-Peter Clausen6dd98b02014-10-25 17:41:59 +0200602 unsigned char is_supply:1; /* Widget is a supply type widget */
Lars-Peter Clausena3423b02015-08-11 21:38:00 +0200603 unsigned char is_ep:2; /* Widget is a endpoint type widget */
Mark Brown20e48592011-01-15 13:40:50 +0000604 int subseq; /* sort within widget type */
Richard Purdie808db4a2006-10-06 18:20:14 +0200605
Mark Brownb75576d2009-04-20 17:56:13 +0100606 int (*power_check)(struct snd_soc_dapm_widget *w);
607
Richard Purdie808db4a2006-10-06 18:20:14 +0200608 /* external events */
609 unsigned short event_flags; /* flags to specify event types */
Laim Girdwood9af6d952008-01-10 14:41:02 +0100610 int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200611
612 /* kcontrols that relate to this widget */
613 int num_kcontrols;
Stephen Warren82cfecd2011-04-28 17:37:58 -0600614 const struct snd_kcontrol_new *kcontrol_news;
Stephen Warrenfad59882011-04-28 17:37:59 -0600615 struct snd_kcontrol **kcontrols;
Liam Girdwood8a978232015-05-29 19:06:14 +0100616 struct snd_soc_dobj dobj;
Richard Purdie808db4a2006-10-06 18:20:14 +0200617
Lars-Peter Clausena3423b02015-08-11 21:38:00 +0200618 /* widget input and output edges */
619 struct list_head edges[2];
Mark Brown6d3ddc82009-05-16 17:47:29 +0100620
621 /* used during DAPM updates */
Lars-Peter Clausen92a99ea2014-10-25 17:42:03 +0200622 struct list_head work_list;
Mark Brown6d3ddc82009-05-16 17:47:29 +0100623 struct list_head power_list;
Mark Browndb432b42011-10-03 21:06:40 +0100624 struct list_head dirty;
Lars-Peter Clausena3423b02015-08-11 21:38:00 +0200625 int endpoints[2];
Ola Liljad7e7eb92012-05-24 15:26:25 +0200626
627 struct clk *clk;
Richard Purdie808db4a2006-10-06 18:20:14 +0200628};
629
Mark Brown97404f22010-12-14 16:13:57 +0000630struct snd_soc_dapm_update {
Mark Brown97404f22010-12-14 16:13:57 +0000631 struct snd_kcontrol *kcontrol;
632 int reg;
633 int mask;
634 int val;
Chen-Yu Tsaie411b0b2016-11-02 15:35:58 +0800635 int reg2;
636 int mask2;
637 int val2;
638 bool has_second_set;
Mark Brown97404f22010-12-14 16:13:57 +0000639};
640
Charles Keepax45a110a2015-05-11 13:50:30 +0100641struct snd_soc_dapm_wcache {
642 struct snd_soc_dapm_widget *widget;
643};
644
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200645/* DAPM context */
646struct snd_soc_dapm_context {
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200647 enum snd_soc_bias_level bias_level;
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200648 unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
Lars-Peter Clausen86dbf2a2014-09-04 19:44:06 +0200649 /* Go to BIAS_OFF in suspend if the DAPM context is idle */
650 unsigned int suspend_bias_off:1;
Mark Brown474b62d2011-01-18 16:14:44 +0000651 void (*seq_notifier)(struct snd_soc_dapm_context *,
Mark Brownf85a9e02011-01-26 21:41:28 +0000652 enum snd_soc_dapm_type, int);
Mark Brown474b62d2011-01-18 16:14:44 +0000653
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200654 struct device *dev; /* from parent - for debug */
Lars-Peter Clausene2c330b2014-04-22 13:23:13 +0200655 struct snd_soc_component *component; /* parent component */
Jarkko Nikula3a45b862010-11-05 20:35:21 +0200656 struct snd_soc_card *card; /* parent card */
Jarkko Nikula7be31be82010-12-14 12:18:32 +0200657
658 /* used during DAPM updates */
Mark Brown56fba412011-06-04 11:25:10 +0100659 enum snd_soc_bias_level target_bias_level;
Jarkko Nikula7be31be82010-12-14 12:18:32 +0200660 struct list_head list;
661
Liam Girdwood64a648c2011-07-25 11:15:15 +0100662 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
Lars-Peter Clausen68f831c2014-06-16 18:13:05 +0200663 int (*set_bias_level)(struct snd_soc_dapm_context *dapm,
664 enum snd_soc_bias_level level);
Liam Girdwood64a648c2011-07-25 11:15:15 +0100665
Charles Keepax45a110a2015-05-11 13:50:30 +0100666 struct snd_soc_dapm_wcache path_sink_cache;
667 struct snd_soc_dapm_wcache path_source_cache;
668
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200669#ifdef CONFIG_DEBUG_FS
670 struct dentry *debugfs_dapm;
671#endif
672};
673
Stephen Warrenfafd2172011-04-28 17:38:00 -0600674/* A list of widgets associated with an object, typically a snd_kcontrol */
675struct snd_soc_dapm_widget_list {
676 int num_widgets;
677 struct snd_soc_dapm_widget *widgets[0];
678};
679
Mark Brownde02d072011-09-20 21:43:24 +0100680struct snd_soc_dapm_stats {
681 int power_checks;
682 int path_checks;
Mark Browne56235e02011-09-21 18:19:14 +0100683 int neighbour_checks;
Mark Brownde02d072011-09-20 21:43:24 +0100684};
685
Lars-Peter Clausenfa880772015-04-27 22:13:23 +0200686/**
687 * snd_soc_dapm_init_bias_level() - Initialize DAPM bias level
688 * @dapm: The DAPM context to initialize
689 * @level: The DAPM level to initialize to
690 *
691 * This function only sets the driver internal state of the DAPM level and will
692 * not modify the state of the device. Hence it should not be used during normal
693 * operation, but only to synchronize the internal state to the device state.
694 * E.g. during driver probe to set the DAPM level to the one corresponding with
695 * the power-on reset state of the device.
696 *
697 * To change the DAPM state of the device use snd_soc_dapm_set_bias_level().
698 */
699static inline void snd_soc_dapm_init_bias_level(
700 struct snd_soc_dapm_context *dapm, enum snd_soc_bias_level level)
701{
702 dapm->bias_level = level;
703}
704
705/**
706 * snd_soc_dapm_get_bias_level() - Get current DAPM bias level
707 * @dapm: The context for which to get the bias level
708 *
709 * Returns: The current bias level of the passed DAPM context.
710 */
711static inline enum snd_soc_bias_level snd_soc_dapm_get_bias_level(
712 struct snd_soc_dapm_context *dapm)
713{
714 return dapm->bias_level;
715}
716
Lars-Peter Clausena3423b02015-08-11 21:38:00 +0200717enum snd_soc_dapm_direction {
718 SND_SOC_DAPM_DIR_IN,
719 SND_SOC_DAPM_DIR_OUT
720};
721
722#define SND_SOC_DAPM_DIR_TO_EP(x) BIT(x)
723
724#define SND_SOC_DAPM_EP_SOURCE SND_SOC_DAPM_DIR_TO_EP(SND_SOC_DAPM_DIR_IN)
725#define SND_SOC_DAPM_EP_SINK SND_SOC_DAPM_DIR_TO_EP(SND_SOC_DAPM_DIR_OUT)
726
727/**
728 * snd_soc_dapm_widget_for_each_sink_path - Iterates over all paths in the
729 * specified direction of a widget
730 * @w: The widget
731 * @dir: Whether to iterate over the paths where the specified widget is the
732 * incoming or outgoing widgets
733 * @p: The path iterator variable
734 */
735#define snd_soc_dapm_widget_for_each_path(w, dir, p) \
736 list_for_each_entry(p, &w->edges[dir], list_node[dir])
737
738/**
739 * snd_soc_dapm_widget_for_each_sink_path_safe - Iterates over all paths in the
740 * specified direction of a widget
741 * @w: The widget
742 * @dir: Whether to iterate over the paths where the specified widget is the
743 * incoming or outgoing widgets
744 * @p: The path iterator variable
745 * @next_p: Temporary storage for the next path
746 *
747 * This function works like snd_soc_dapm_widget_for_each_sink_path, expect that
748 * it is safe to remove the current path from the list while iterating
749 */
750#define snd_soc_dapm_widget_for_each_path_safe(w, dir, p, next_p) \
751 list_for_each_entry_safe(p, next_p, &w->edges[dir], list_node[dir])
752
Lars-Peter Clausene63bfd42015-07-26 19:05:00 +0200753/**
754 * snd_soc_dapm_widget_for_each_sink_path - Iterates over all paths leaving a
755 * widget
756 * @w: The widget
757 * @p: The path iterator variable
758 */
759#define snd_soc_dapm_widget_for_each_sink_path(w, p) \
Lars-Peter Clausena3423b02015-08-11 21:38:00 +0200760 snd_soc_dapm_widget_for_each_path(w, SND_SOC_DAPM_DIR_IN, p)
Lars-Peter Clausene63bfd42015-07-26 19:05:00 +0200761
762/**
763 * snd_soc_dapm_widget_for_each_source_path - Iterates over all paths leading to
764 * a widget
765 * @w: The widget
766 * @p: The path iterator variable
767 */
768#define snd_soc_dapm_widget_for_each_source_path(w, p) \
Lars-Peter Clausena3423b02015-08-11 21:38:00 +0200769 snd_soc_dapm_widget_for_each_path(w, SND_SOC_DAPM_DIR_OUT, p)
Lars-Peter Clausene63bfd42015-07-26 19:05:00 +0200770
Richard Purdie808db4a2006-10-06 18:20:14 +0200771#endif