1 /* SPDX-License-Identifier: GPL-2.0
2 *
3 * linux/sound/soc-dapm.h -- ALSA SoC Dynamic Audio Power Management
4 *
5 * Author: Liam Girdwood
6 * Created: Aug 11th 2005
7 * Copyright: Wolfson Microelectronics. PLC.
8 */
9
10 #ifndef __LINUX_SND_SOC_DAPM_H
11 #define __LINUX_SND_SOC_DAPM_H
12
13 #include <linux/types.h>
14 #include <sound/control.h>
15 #include <sound/soc-topology.h>
16 #include <sound/asoc.h>
17
18 struct device;
19 struct snd_pcm_substream;
20 struct snd_soc_pcm_runtime;
21 struct soc_enum;
22
23 /* widget has no PM register bit */
24 #define SND_SOC_NOPM -1
25
26 /*
27 * SoC dynamic audio power management
28 *
29 * We can have up to 4 power domains
30 * 1. Codec domain - VREF, VMID
31 * 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) \
45 (struct snd_soc_dapm_widget) { \
46 .id = snd_soc_dapm_vmid, .name = wname, .kcontrol_news = NULL, \
47 .num_kcontrols = 0}
48
49 /* platform domain */
50 #define SND_SOC_DAPM_SIGGEN(wname) \
51 (struct snd_soc_dapm_widget) { \
52 .id = snd_soc_dapm_siggen, .name = wname, .kcontrol_news = NULL, \
53 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
54 #define SND_SOC_DAPM_SINK(wname) \
55 (struct snd_soc_dapm_widget) { \
56 .id = snd_soc_dapm_sink, .name = wname, .kcontrol_news = NULL, \
57 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
58 #define SND_SOC_DAPM_INPUT(wname) \
59 (struct snd_soc_dapm_widget) { \
60 .id = snd_soc_dapm_input, .name = wname, .kcontrol_news = NULL, \
61 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
62 #define SND_SOC_DAPM_OUTPUT(wname) \
63 (struct snd_soc_dapm_widget) { \
64 .id = snd_soc_dapm_output, .name = wname, .kcontrol_news = NULL, \
65 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
66 #define SND_SOC_DAPM_MIC(wname, wevent) \
67 (struct snd_soc_dapm_widget) { \
68 .id = snd_soc_dapm_mic, .name = wname, .kcontrol_news = NULL, \
69 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
70 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
71 #define SND_SOC_DAPM_HP(wname, wevent) \
72 (struct snd_soc_dapm_widget) { \
73 .id = snd_soc_dapm_hp, .name = wname, .kcontrol_news = NULL, \
74 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
75 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
76 #define SND_SOC_DAPM_SPK(wname, wevent) \
77 (struct snd_soc_dapm_widget) { \
78 .id = snd_soc_dapm_spk, .name = wname, .kcontrol_news = NULL, \
79 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
80 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
81 #define SND_SOC_DAPM_LINE(wname, wevent) \
82 (struct snd_soc_dapm_widget) { \
83 .id = snd_soc_dapm_line, .name = wname, .kcontrol_news = NULL, \
84 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
85 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
86
87 #define SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) \
88 .reg = wreg, .mask = 1, .shift = wshift, \
89 .on_val = winvert ? 0 : 1, .off_val = winvert ? 1 : 0
90
91 /* path domain */
92 #define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\
93 wcontrols, wncontrols) \
94 (struct snd_soc_dapm_widget) { \
95 .id = snd_soc_dapm_pga, .name = wname, \
96 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
97 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
98 #define SND_SOC_DAPM_OUT_DRV(wname, wreg, wshift, winvert,\
99 wcontrols, wncontrols) \
100 (struct snd_soc_dapm_widget) { \
101 .id = snd_soc_dapm_out_drv, .name = wname, \
102 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
103 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
104 #define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
105 wcontrols, wncontrols)\
106 (struct snd_soc_dapm_widget) { \
107 .id = snd_soc_dapm_mixer, .name = wname, \
108 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
109 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
110 #define SND_SOC_DAPM_MIXER_NAMED_CTL(wname, wreg, wshift, winvert, \
111 wcontrols, wncontrols)\
112 (struct snd_soc_dapm_widget) { \
113 .id = snd_soc_dapm_mixer_named_ctl, .name = wname, \
114 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
115 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
116 /* DEPRECATED: use SND_SOC_DAPM_SUPPLY */
117 #define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
118 (struct snd_soc_dapm_widget) { \
119 .id = snd_soc_dapm_micbias, .name = wname, \
120 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
121 .kcontrol_news = NULL, .num_kcontrols = 0}
122 #define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
123 (struct snd_soc_dapm_widget) { \
124 .id = snd_soc_dapm_switch, .name = wname, \
125 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
126 .kcontrol_news = wcontrols, .num_kcontrols = 1}
127 #define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
128 (struct snd_soc_dapm_widget) { \
129 .id = snd_soc_dapm_mux, .name = wname, \
130 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
131 .kcontrol_news = wcontrols, .num_kcontrols = 1}
132 #define SND_SOC_DAPM_DEMUX(wname, wreg, wshift, winvert, wcontrols) \
133 (struct snd_soc_dapm_widget) { \
134 .id = snd_soc_dapm_demux, .name = wname, \
135 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
136 .kcontrol_news = wcontrols, .num_kcontrols = 1}
137
138 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
139 #define SOC_PGA_ARRAY(wname, wreg, wshift, winvert,\
140 wcontrols) \
141 (struct snd_soc_dapm_widget) { \
142 .id = snd_soc_dapm_pga, .name = wname, \
143 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
144 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
145 #define SOC_MIXER_ARRAY(wname, wreg, wshift, winvert, \
146 wcontrols)\
147 (struct snd_soc_dapm_widget) { \
148 .id = snd_soc_dapm_mixer, .name = wname, \
149 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
150 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
151 #define SOC_MIXER_NAMED_CTL_ARRAY(wname, wreg, wshift, winvert, \
152 wcontrols)\
153 (struct snd_soc_dapm_widget) { \
154 .id = snd_soc_dapm_mixer_named_ctl, .name = wname, \
155 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
156 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
157
158 /* path domain with event - event handler must return 0 for success */
159 #define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \
160 wncontrols, wevent, wflags) \
161 (struct snd_soc_dapm_widget) { \
162 .id = snd_soc_dapm_pga, .name = wname, \
163 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
164 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
165 .event = wevent, .event_flags = wflags}
166 #define SND_SOC_DAPM_OUT_DRV_E(wname, wreg, wshift, winvert, wcontrols, \
167 wncontrols, wevent, wflags) \
168 (struct snd_soc_dapm_widget) { \
169 .id = snd_soc_dapm_out_drv, .name = wname, \
170 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
171 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
172 .event = wevent, .event_flags = wflags}
173 #define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \
174 wncontrols, wevent, wflags) \
175 (struct snd_soc_dapm_widget) { \
176 .id = snd_soc_dapm_mixer, .name = wname, \
177 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
178 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
179 .event = wevent, .event_flags = wflags}
180 #define SND_SOC_DAPM_MIXER_NAMED_CTL_E(wname, wreg, wshift, winvert, \
181 wcontrols, wncontrols, wevent, wflags) \
182 (struct snd_soc_dapm_widget) { \
183 .id = snd_soc_dapm_mixer, .name = wname, \
184 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
185 .kcontrol_news = wcontrols, \
186 .num_kcontrols = wncontrols, .event = wevent, .event_flags = wflags}
187 #define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
188 wevent, wflags) \
189 (struct snd_soc_dapm_widget) { \
190 .id = snd_soc_dapm_switch, .name = wname, \
191 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
192 .kcontrol_news = wcontrols, .num_kcontrols = 1, \
193 .event = wevent, .event_flags = wflags}
194 #define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
195 wevent, wflags) \
196 (struct snd_soc_dapm_widget) { \
197 .id = snd_soc_dapm_mux, .name = wname, \
198 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
199 .kcontrol_news = wcontrols, .num_kcontrols = 1, \
200 .event = wevent, .event_flags = wflags}
201
202 /* additional sequencing control within an event type */
203 #define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \
204 wevent, wflags) \
205 (struct snd_soc_dapm_widget) { \
206 .id = snd_soc_dapm_pga, .name = wname, \
207 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
208 .event = wevent, .event_flags = wflags, \
209 .subseq = wsubseq}
210 #define SND_SOC_DAPM_SUPPLY_S(wname, wsubseq, wreg, wshift, winvert, wevent, \
211 wflags) \
212 (struct snd_soc_dapm_widget) { \
213 .id = snd_soc_dapm_supply, .name = wname, \
214 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
215 .event = wevent, .event_flags = wflags, .subseq = wsubseq}
216
217 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
218 #define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
219 wevent, wflags) \
220 (struct snd_soc_dapm_widget) { \
221 .id = snd_soc_dapm_pga, .name = wname, \
222 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
223 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
224 .event = wevent, .event_flags = wflags}
225 #define SOC_MIXER_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
226 wevent, wflags) \
227 (struct snd_soc_dapm_widget) { \
228 .id = snd_soc_dapm_mixer, .name = wname, \
229 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
230 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
231 .event = wevent, .event_flags = wflags}
232 #define SOC_MIXER_NAMED_CTL_E_ARRAY(wname, wreg, wshift, winvert, \
233 wcontrols, wevent, wflags) \
234 (struct snd_soc_dapm_widget) { \
235 .id = snd_soc_dapm_mixer, .name = wname, \
236 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
237 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
238 .event = wevent, .event_flags = wflags}
239
240 /* events that are pre and post DAPM */
241 #define SND_SOC_DAPM_PRE(wname, wevent) \
242 (struct snd_soc_dapm_widget) { \
243 .id = snd_soc_dapm_pre, .name = wname, .kcontrol_news = NULL, \
244 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
245 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
246 #define SND_SOC_DAPM_POST(wname, wevent) \
247 (struct snd_soc_dapm_widget) { \
248 .id = snd_soc_dapm_post, .name = wname, .kcontrol_news = NULL, \
249 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
250 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
251
252 /* stream domain */
253 #define SND_SOC_DAPM_AIF_IN(wname, stname, wchan, wreg, wshift, winvert) \
254 (struct snd_soc_dapm_widget) { \
255 .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
256 .channel = wchan, SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
257 #define SND_SOC_DAPM_AIF_IN_E(wname, stname, wchan, wreg, wshift, winvert, \
258 wevent, wflags) \
259 (struct snd_soc_dapm_widget) { \
260 .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
261 .channel = wchan, SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
262 .event = wevent, .event_flags = wflags }
263 #define SND_SOC_DAPM_AIF_OUT(wname, stname, wchan, wreg, wshift, winvert) \
264 (struct snd_soc_dapm_widget) { \
265 .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
266 .channel = wchan, SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
267 #define SND_SOC_DAPM_AIF_OUT_E(wname, stname, wchan, wreg, wshift, winvert, \
268 wevent, wflags) \
269 (struct snd_soc_dapm_widget) { \
270 .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
271 .channel = wchan, SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
272 .event = wevent, .event_flags = wflags }
273 #define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
274 (struct snd_soc_dapm_widget) { \
275 .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \
276 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) }
277 #define SND_SOC_DAPM_DAC_E(wname, stname, wreg, wshift, winvert, \
278 wevent, wflags) \
279 (struct snd_soc_dapm_widget) { \
280 .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \
281 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
282 .event = wevent, .event_flags = wflags}
283
284 #define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
285 (struct snd_soc_dapm_widget) { \
286 .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \
287 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
288 #define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \
289 wevent, wflags) \
290 (struct snd_soc_dapm_widget) { \
291 .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \
292 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
293 .event = wevent, .event_flags = wflags}
294 #define SND_SOC_DAPM_CLOCK_SUPPLY(wname) \
295 (struct snd_soc_dapm_widget) { \
296 .id = snd_soc_dapm_clock_supply, .name = wname, \
297 .reg = SND_SOC_NOPM, .event = dapm_clock_event, \
298 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD }
299
300 /* generic widgets */
301 #define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
302 (struct snd_soc_dapm_widget) { \
303 .id = wid, .name = wname, .kcontrol_news = NULL, .num_kcontrols = 0, \
304 .reg = wreg, .shift = wshift, .mask = wmask, \
305 .on_val = won_val, .off_val = woff_val, }
306 #define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \
307 (struct snd_soc_dapm_widget) { \
308 .id = snd_soc_dapm_supply, .name = wname, \
309 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
310 .event = wevent, .event_flags = wflags}
311 #define SND_SOC_DAPM_REGULATOR_SUPPLY(wname, wdelay, wflags) \
312 (struct snd_soc_dapm_widget) { \
313 .id = snd_soc_dapm_regulator_supply, .name = wname, \
314 .reg = SND_SOC_NOPM, .shift = wdelay, .event = dapm_regulator_event, \
315 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD, \
316 .on_val = wflags}
317 #define SND_SOC_DAPM_PINCTRL(wname, active, sleep) \
318 (struct snd_soc_dapm_widget) { \
319 .id = snd_soc_dapm_pinctrl, .name = wname, \
320 .priv = (&(struct snd_soc_dapm_pinctrl_priv) \
321 { .active_state = active, .sleep_state = sleep,}), \
322 .reg = SND_SOC_NOPM, .event = dapm_pinctrl_event, \
323 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD }
324
325
326
327 /* dapm kcontrol types */
328 #define SOC_DAPM_DOUBLE(xname, reg, lshift, rshift, max, invert) \
329 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
330 .info = snd_soc_info_volsw, \
331 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
332 .private_value = SOC_DOUBLE_VALUE(reg, lshift, rshift, max, invert, 0) }
333 #define SOC_DAPM_DOUBLE_R(xname, lreg, rreg, shift, max, invert) \
334 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
335 .info = snd_soc_info_volsw, \
336 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
337 .private_value = SOC_DOUBLE_R_VALUE(lreg, rreg, shift, max, invert) }
338 #define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
339 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
340 .info = snd_soc_info_volsw, \
341 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
342 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
343 #define SOC_DAPM_SINGLE_AUTODISABLE(xname, reg, shift, max, invert) \
344 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
345 .info = snd_soc_info_volsw, \
346 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
347 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 1) }
348 #define SOC_DAPM_SINGLE_VIRT(xname, max) \
349 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0)
350 #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
351 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
352 .info = snd_soc_info_volsw, \
353 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
354 .tlv.p = (tlv_array), \
355 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
356 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
357 #define SOC_DAPM_SINGLE_TLV_AUTODISABLE(xname, reg, shift, max, invert, tlv_array) \
358 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
359 .info = snd_soc_info_volsw, \
360 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
361 .tlv.p = (tlv_array), \
362 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
363 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 1) }
364 #define SOC_DAPM_SINGLE_TLV_VIRT(xname, max, tlv_array) \
365 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0, tlv_array)
366 #define SOC_DAPM_ENUM(xname, xenum) \
367 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
368 .info = snd_soc_info_enum_double, \
369 .get = snd_soc_dapm_get_enum_double, \
370 .put = snd_soc_dapm_put_enum_double, \
371 .private_value = (unsigned long)&xenum }
372 #define SOC_DAPM_ENUM_EXT(xname, xenum, xget, xput) \
373 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
374 .info = snd_soc_info_enum_double, \
375 .get = xget, \
376 .put = xput, \
377 .private_value = (unsigned long)&xenum }
378 #define SOC_DAPM_PIN_SWITCH(xname) \
379 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
380 .info = snd_soc_dapm_info_pin_switch, \
381 .get = snd_soc_dapm_get_pin_switch, \
382 .put = snd_soc_dapm_put_pin_switch, \
383 .private_value = (unsigned long)xname }
384
385 /* dapm stream operations */
386 #define SND_SOC_DAPM_STREAM_NOP 0x0
387 #define SND_SOC_DAPM_STREAM_START 0x1
388 #define SND_SOC_DAPM_STREAM_STOP 0x2
389 #define SND_SOC_DAPM_STREAM_SUSPEND 0x4
390 #define SND_SOC_DAPM_STREAM_RESUME 0x8
391 #define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10
392 #define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20
393
394 /* dapm event types */
395 #define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */
396 #define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */
397 #define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */
398 #define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */
399 #define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */
400 #define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */
401 #define SND_SOC_DAPM_WILL_PMU 0x40 /* called at start of sequence */
402 #define SND_SOC_DAPM_WILL_PMD 0x80 /* called at start of sequence */
403 #define SND_SOC_DAPM_PRE_POST_PMD (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
404 #define SND_SOC_DAPM_PRE_POST_PMU (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU)
405
406 /* convenience event type detection */
407 #define SND_SOC_DAPM_EVENT_ON(e) (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
408 #define SND_SOC_DAPM_EVENT_OFF(e) (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
409
410 /* regulator widget flags */
411 #define SND_SOC_DAPM_REGULATOR_BYPASS 0x1 /* bypass when disabled */
412
413 struct snd_soc_dapm_widget;
414 enum snd_soc_dapm_type;
415 struct snd_soc_dapm_path;
416 struct snd_soc_dapm_pin;
417 struct snd_soc_dapm_route;
418 struct snd_soc_dapm_context;
419 struct regulator;
420 struct snd_soc_dapm_widget_list;
421 struct snd_soc_dapm_update;
422 enum snd_soc_dapm_direction;
423
424 /*
425 * Bias levels
426 *
427 * @ON: Bias is fully on for audio playback and capture operations.
428 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
429 * stream start and stop operations.
430 * @STANDBY: Low power standby state when no playback/capture operations are
431 * in progress. NOTE: The transition time between STANDBY and ON
432 * should be as fast as possible and no longer than 10ms.
433 * @OFF: Power Off. No restrictions on transition times.
434 */
435 enum snd_soc_bias_level {
436 SND_SOC_BIAS_OFF = 0,
437 SND_SOC_BIAS_STANDBY = 1,
438 SND_SOC_BIAS_PREPARE = 2,
439 SND_SOC_BIAS_ON = 3,
440 };
441
442 int dapm_regulator_event(struct snd_soc_dapm_widget *w, struct snd_kcontrol *kcontrol, int event);
443 int dapm_clock_event(struct snd_soc_dapm_widget *w, struct snd_kcontrol *kcontrol, int event);
444 int dapm_pinctrl_event(struct snd_soc_dapm_widget *w, struct snd_kcontrol *kcontrol, int event);
445
446 /* dapm controls */
447 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
448 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
449 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
450 struct snd_ctl_elem_value *ucontrol);
451 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
452 struct snd_ctl_elem_value *ucontrol);
453 int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
454 struct snd_ctl_elem_info *uinfo);
455 int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
456 struct snd_ctl_elem_value *uncontrol);
457 int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
458 struct snd_ctl_elem_value *uncontrol);
459 int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
460 const struct snd_soc_dapm_widget *widget, unsigned int num);
461 struct snd_soc_dapm_widget *snd_soc_dapm_new_control(struct snd_soc_dapm_context *dapm,
462 const struct snd_soc_dapm_widget *widget);
463 struct snd_soc_dapm_widget *snd_soc_dapm_new_control_unlocked(struct snd_soc_dapm_context *dapm,
464 const struct snd_soc_dapm_widget *widget);
465 int snd_soc_dapm_new_dai_widgets(struct snd_soc_dapm_context *dapm, struct snd_soc_dai *dai);
466 void snd_soc_dapm_free_widget(struct snd_soc_dapm_widget *w);
467 int snd_soc_dapm_link_dai_widgets(struct snd_soc_card *card);
468 void snd_soc_dapm_connect_dai_link_widgets(struct snd_soc_card *card);
469
470 int snd_soc_dapm_update_dai(struct snd_pcm_substream *substream,
471 struct snd_pcm_hw_params *params, struct snd_soc_dai *dai);
472 int snd_soc_dapm_widget_name_cmp(struct snd_soc_dapm_widget *widget, const char *s);
473
474 /* dapm path setup */
475 int snd_soc_dapm_new_widgets(struct snd_soc_card *card);
476 void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
477 void snd_soc_dapm_init(struct snd_soc_dapm_context *dapm,
478 struct snd_soc_card *card, struct snd_soc_component *component);
479 int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
480 const struct snd_soc_dapm_route *route, int num);
481 int snd_soc_dapm_del_routes(struct snd_soc_dapm_context *dapm,
482 const struct snd_soc_dapm_route *route, int num);
483 int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm,
484 const struct snd_soc_dapm_route *route, int num);
485 void snd_soc_dapm_free_widget(struct snd_soc_dapm_widget *w);
486
487 /* dapm events */
488 void snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd, int stream, int event);
489 void snd_soc_dapm_stream_stop(struct snd_soc_pcm_runtime *rtd, int stream);
490 void snd_soc_dapm_shutdown(struct snd_soc_card *card);
491
492 /* external DAPM widget events */
493 int snd_soc_dapm_mixer_update_power(struct snd_soc_dapm_context *dapm,
494 struct snd_kcontrol *kcontrol, int connect, struct snd_soc_dapm_update *update);
495 int snd_soc_dapm_mux_update_power(struct snd_soc_dapm_context *dapm,
496 struct snd_kcontrol *kcontrol, int mux, struct soc_enum *e,
497 struct snd_soc_dapm_update *update);
498
499 /* dapm sys fs - used by the core */
500 extern struct attribute *soc_dapm_dev_attrs[];
501 void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm, struct dentry *parent);
502
503 /* dapm audio pin control and status */
504 int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm, const char *pin);
505 int snd_soc_dapm_enable_pin_unlocked(struct snd_soc_dapm_context *dapm, const char *pin);
506 int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm, const char *pin);
507 int snd_soc_dapm_disable_pin_unlocked(struct snd_soc_dapm_context *dapm, const char *pin);
508 int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
509 int snd_soc_dapm_nc_pin_unlocked(struct snd_soc_dapm_context *dapm, const char *pin);
510 int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm, const char *pin);
511 int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
512 int snd_soc_dapm_sync_unlocked(struct snd_soc_dapm_context *dapm);
513 int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm, const char *pin);
514 int snd_soc_dapm_force_enable_pin_unlocked(struct snd_soc_dapm_context *dapm, const char *pin);
515 int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm, const char *pin);
516 unsigned int dapm_kcontrol_get_value(const struct snd_kcontrol *kcontrol);
517
518 /* Mostly internal - should not normally be used */
519 void dapm_mark_endpoints_dirty(struct snd_soc_card *card);
520
521 /* dapm path query */
522 int snd_soc_dapm_dai_get_connected_widgets(struct snd_soc_dai *dai, int stream,
523 struct snd_soc_dapm_widget_list **list,
524 bool (*custom_stop_condition)(struct snd_soc_dapm_widget *, enum snd_soc_dapm_direction));
525 void snd_soc_dapm_dai_free_widgets(struct snd_soc_dapm_widget_list **list);
526
527 struct snd_soc_dapm_context *snd_soc_dapm_kcontrol_dapm(struct snd_kcontrol *kcontrol);
528 struct snd_soc_dapm_widget *snd_soc_dapm_kcontrol_widget(struct snd_kcontrol *kcontrol);
529
530 int snd_soc_dapm_force_bias_level(struct snd_soc_dapm_context *dapm, enum snd_soc_bias_level level);
531
532 /* dapm widget types */
533 enum snd_soc_dapm_type {
534 snd_soc_dapm_input = 0, /* input pin */
535 snd_soc_dapm_output, /* output pin */
536 snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */
537 snd_soc_dapm_demux, /* connects the input to one of multiple outputs */
538 snd_soc_dapm_mixer, /* mixes several analog signals together */
539 snd_soc_dapm_mixer_named_ctl, /* mixer with named controls */
540 snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */
541 snd_soc_dapm_out_drv, /* output driver */
542 snd_soc_dapm_adc, /* analog to digital converter */
543 snd_soc_dapm_dac, /* digital to analog converter */
544 snd_soc_dapm_micbias, /* microphone bias (power) - DEPRECATED: use snd_soc_dapm_supply */
545 snd_soc_dapm_mic, /* microphone */
546 snd_soc_dapm_hp, /* headphones */
547 snd_soc_dapm_spk, /* speaker */
548 snd_soc_dapm_line, /* line input/output */
549 snd_soc_dapm_switch, /* analog switch */
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 */
553 snd_soc_dapm_supply, /* power/clock supply */
554 snd_soc_dapm_pinctrl, /* pinctrl */
555 snd_soc_dapm_regulator_supply, /* external regulator */
556 snd_soc_dapm_clock_supply, /* external clock */
557 snd_soc_dapm_aif_in, /* audio interface input */
558 snd_soc_dapm_aif_out, /* audio interface output */
559 snd_soc_dapm_siggen, /* signal generator */
560 snd_soc_dapm_sink,
561 snd_soc_dapm_dai_in, /* link to DAI structure */
562 snd_soc_dapm_dai_out,
563 snd_soc_dapm_dai_link, /* link between two DAI structures */
564 snd_soc_dapm_kcontrol, /* Auto-disabled kcontrol */
565 snd_soc_dapm_buffer, /* DSP/CODEC internal buffer */
566 snd_soc_dapm_scheduler, /* DSP/CODEC internal scheduler */
567 snd_soc_dapm_effect, /* DSP/CODEC effect component */
568 snd_soc_dapm_src, /* DSP/CODEC SRC component */
569 snd_soc_dapm_asrc, /* DSP/CODEC ASRC component */
570 snd_soc_dapm_encoder, /* FW/SW audio encoder component */
571 snd_soc_dapm_decoder, /* FW/SW audio decoder component */
572
573 /* Don't edit below this line */
574 SND_SOC_DAPM_TYPE_COUNT
575 };
576
577 /*
578 * DAPM audio route definition.
579 *
580 * Defines an audio route originating at source via control and finishing
581 * at sink.
582 */
583 struct snd_soc_dapm_route {
584 const char *sink;
585 const char *control;
586 const char *source;
587
588 /* Note: currently only supported for links where source is a supply */
589 int (*connected)(struct snd_soc_dapm_widget *source,
590 struct snd_soc_dapm_widget *sink);
591
592 struct snd_soc_dobj dobj;
593 };
594
595 /* dapm audio path between two widgets */
596 struct snd_soc_dapm_path {
597 const char *name;
598
599 /*
600 * source (input) and sink (output) widgets
601 * The union is for convience, since it is a lot nicer to type
602 * p->source, rather than p->node[SND_SOC_DAPM_DIR_IN]
603 */
604 union {
605 struct {
606 struct snd_soc_dapm_widget *source;
607 struct snd_soc_dapm_widget *sink;
608 };
609 struct snd_soc_dapm_widget *node[2];
610 };
611
612 /* status */
613 u32 connect:1; /* source and sink widgets are connected */
614 u32 walking:1; /* path is in the process of being walked */
615 u32 weak:1; /* path ignored for power management */
616 u32 is_supply:1; /* At least one of the connected widgets is a supply */
617
618 int (*connected)(struct snd_soc_dapm_widget *source,
619 struct snd_soc_dapm_widget *sink);
620
621 struct list_head list_node[2];
622 struct list_head list_kcontrol;
623 struct list_head list;
624 };
625
626 /* dapm widget */
627 struct snd_soc_dapm_widget {
628 enum snd_soc_dapm_type id;
629 const char *name; /* widget name */
630 const char *sname; /* stream name */
631 struct list_head list;
632 struct snd_soc_dapm_context *dapm;
633
634 void *priv; /* widget specific data */
635 struct regulator *regulator; /* attached regulator */
636 struct pinctrl *pinctrl; /* attached pinctrl */
637
638 /* dapm control */
639 int reg; /* negative reg = no direct dapm */
640 unsigned char shift; /* bits to shift */
641 unsigned int mask; /* non-shifted mask */
642 unsigned int on_val; /* on state value */
643 unsigned int off_val; /* off state value */
644 unsigned char power:1; /* block power status */
645 unsigned char active:1; /* active stream on DAC, ADC's */
646 unsigned char connected:1; /* connected codec pin */
647 unsigned char new:1; /* cnew complete */
648 unsigned char force:1; /* force state */
649 unsigned char ignore_suspend:1; /* kept enabled over suspend */
650 unsigned char new_power:1; /* power from this run */
651 unsigned char power_checked:1; /* power checked this run */
652 unsigned char is_supply:1; /* Widget is a supply type widget */
653 unsigned char is_ep:2; /* Widget is a endpoint type widget */
654 unsigned char no_wname_in_kcontrol_name:1; /* No widget name prefix in kcontrol name */
655 int subseq; /* sort within widget type */
656
657 int (*power_check)(struct snd_soc_dapm_widget *w);
658
659 /* external events */
660 unsigned short event_flags; /* flags to specify event types */
661 int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
662
663 /* kcontrols that relate to this widget */
664 int num_kcontrols;
665 const struct snd_kcontrol_new *kcontrol_news;
666 struct snd_kcontrol **kcontrols;
667 struct snd_soc_dobj dobj;
668
669 /* widget input and output edges */
670 struct list_head edges[2];
671
672 /* used during DAPM updates */
673 struct list_head work_list;
674 struct list_head power_list;
675 struct list_head dirty;
676 int endpoints[2];
677
678 struct clk *clk;
679
680 int channel;
681 };
682
683 struct snd_soc_dapm_update {
684 struct snd_kcontrol *kcontrol;
685 int reg;
686 int mask;
687 int val;
688 int reg2;
689 int mask2;
690 int val2;
691 bool has_second_set;
692 };
693
694 /* DAPM context */
695 struct snd_soc_dapm_context {
696 enum snd_soc_bias_level bias_level;
697
698 /* bit field */
699 unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
700 unsigned int suspend_bias_off:1; /* Use BIAS_OFF in suspend if the DAPM is idle */
701
702 struct device *dev; /* from parent - for debug */
703 struct snd_soc_component *component; /* parent component */
704 struct snd_soc_card *card; /* parent card */
705
706 /* used during DAPM updates */
707 enum snd_soc_bias_level target_bias_level;
708 struct list_head list;
709
710 struct snd_soc_dapm_widget *wcache_sink;
711 struct snd_soc_dapm_widget *wcache_source;
712
713 #ifdef CONFIG_DEBUG_FS
714 struct dentry *debugfs_dapm;
715 #endif
716 };
717
718 /* A list of widgets associated with an object, typically a snd_kcontrol */
719 struct snd_soc_dapm_widget_list {
720 int num_widgets;
721 struct snd_soc_dapm_widget *widgets[] __counted_by(num_widgets);
722 };
723
724 #define for_each_dapm_widgets(list, i, widget) \
725 for ((i) = 0; \
726 (i) < list->num_widgets && (widget = list->widgets[i]); \
727 (i)++)
728
729 struct snd_soc_dapm_stats {
730 int power_checks;
731 int path_checks;
732 int neighbour_checks;
733 };
734
735 struct snd_soc_dapm_pinctrl_priv {
736 const char *active_state;
737 const char *sleep_state;
738 };
739
740 /**
741 * snd_soc_dapm_init_bias_level() - Initialize DAPM bias level
742 * @dapm: The DAPM context to initialize
743 * @level: The DAPM level to initialize to
744 *
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.
748 * E.g. during driver probe to set the DAPM level to the one corresponding with
749 * the power-on reset state of the device.
750 *
751 * To change the DAPM state of the device use snd_soc_dapm_set_bias_level().
752 */
753 static inline void snd_soc_dapm_init_bias_level(
754 struct snd_soc_dapm_context *dapm, enum snd_soc_bias_level level)
755 {
756 dapm->bias_level = level;
757 }
758
759 /**
760 * snd_soc_dapm_get_bias_level() - Get current DAPM bias level
761 * @dapm: The context for which to get the bias level
762 *
763 * Returns: The current bias level of the passed DAPM context.
764 */
765 static inline enum snd_soc_bias_level snd_soc_dapm_get_bias_level(
766 struct snd_soc_dapm_context *dapm)
767 {
768 return dapm->bias_level;
769 }
770
771 enum snd_soc_dapm_direction {
772 SND_SOC_DAPM_DIR_IN,
773 SND_SOC_DAPM_DIR_OUT
774 };
775
776 #define SND_SOC_DAPM_DIR_TO_EP(x) BIT(x)
777
778 #define SND_SOC_DAPM_EP_SOURCE SND_SOC_DAPM_DIR_TO_EP(SND_SOC_DAPM_DIR_IN)
779 #define SND_SOC_DAPM_EP_SINK SND_SOC_DAPM_DIR_TO_EP(SND_SOC_DAPM_DIR_OUT)
780
781 /**
782 * snd_soc_dapm_widget_for_each_path - Iterates over all paths in the
783 * specified direction of a widget
784 * @w: The widget
785 * @dir: Whether to iterate over the paths where the specified widget is the
786 * incoming or outgoing widgets
787 * @p: The path iterator variable
788 */
789 #define snd_soc_dapm_widget_for_each_path(w, dir, p) \
790 list_for_each_entry(p, &w->edges[dir], list_node[dir])
791
792 /**
793 * snd_soc_dapm_widget_for_each_path_safe - Iterates over all paths in the
794 * specified direction of a widget
795 * @w: The widget
796 * @dir: Whether to iterate over the paths where the specified widget is the
797 * incoming or outgoing widgets
798 * @p: The path iterator variable
799 * @next_p: Temporary storage for the next path
800 *
801 * This function works like snd_soc_dapm_widget_for_each_path, expect that
802 * it is safe to remove the current path from the list while iterating
803 */
804 #define snd_soc_dapm_widget_for_each_path_safe(w, dir, p, next_p) \
805 list_for_each_entry_safe(p, next_p, &w->edges[dir], list_node[dir])
806
807 /**
808 * snd_soc_dapm_widget_for_each_sink_path - Iterates over all paths leaving a
809 * widget
810 * @w: The widget
811 * @p: The path iterator variable
812 */
813 #define snd_soc_dapm_widget_for_each_sink_path(w, p) \
814 snd_soc_dapm_widget_for_each_path(w, SND_SOC_DAPM_DIR_IN, p)
815
816 /**
817 * snd_soc_dapm_widget_for_each_source_path - Iterates over all paths leading to
818 * a widget
819 * @w: The widget
820 * @p: The path iterator variable
821 */
822 #define snd_soc_dapm_widget_for_each_source_path(w, p) \
823 snd_soc_dapm_widget_for_each_path(w, SND_SOC_DAPM_DIR_OUT, p)
824
825 #endif
826
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.