2 * linux/sound/soc-dapm.h -- ALSA SoC Dynamic Audio Power Management
4 * Author: Liam Girdwood
5 * Created: Aug 11th 2005
6 * Copyright: Wolfson Microelectronics. PLC.
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.
13 #ifndef __LINUX_SND_SOC_DAPM_H
14 #define __LINUX_SND_SOC_DAPM_H
16 #include <linux/types.h>
17 #include <sound/control.h>
21 /* widget has no PM register bit */
22 #define SND_SOC_NOPM -1
25 * SoC dynamic audio power management
27 * We can have up to 4 power domains
28 * 1. Codec domain - VREF, VMID
29 * Usually controlled at codec probe/remove, although can be set
30 * at stream time if power is not needed for sidetone, etc.
31 * 2. Platform/Machine domain - physically connected inputs and outputs
32 * Is platform/machine and user action specific, is set in the machine
33 * driver and by userspace e.g when HP are inserted
34 * 3. Path domain - Internal codec path mixers
35 * Are automatically set when mixer and mux settings are
36 * changed by the user.
37 * 4. Stream domain - DAC's and ADC's.
38 * Enabled when stream playback/capture is started.
42 #define SND_SOC_DAPM_VMID(wname) \
43 { .id = snd_soc_dapm_vmid, .name = wname, .kcontrol_news = NULL, \
47 #define SND_SOC_DAPM_SIGGEN(wname) \
48 { .id = snd_soc_dapm_siggen, .name = wname, .kcontrol_news = NULL, \
49 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
50 #define SND_SOC_DAPM_INPUT(wname) \
51 { .id = snd_soc_dapm_input, .name = wname, .kcontrol_news = NULL, \
52 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
53 #define SND_SOC_DAPM_OUTPUT(wname) \
54 { .id = snd_soc_dapm_output, .name = wname, .kcontrol_news = NULL, \
55 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
56 #define SND_SOC_DAPM_MIC(wname, wevent) \
57 { .id = snd_soc_dapm_mic, .name = wname, .kcontrol_news = NULL, \
58 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
59 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
60 #define SND_SOC_DAPM_HP(wname, wevent) \
61 { .id = snd_soc_dapm_hp, .name = wname, .kcontrol_news = NULL, \
62 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
63 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
64 #define SND_SOC_DAPM_SPK(wname, wevent) \
65 { .id = snd_soc_dapm_spk, .name = wname, .kcontrol_news = NULL, \
66 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
67 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
68 #define SND_SOC_DAPM_LINE(wname, wevent) \
69 { .id = snd_soc_dapm_line, .name = wname, .kcontrol_news = NULL, \
70 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
71 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
73 #define SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) \
74 .reg = wreg, .mask = 1, .shift = wshift, \
75 .on_val = winvert ? 0 : 1, .off_val = winvert ? 1 : 0
78 #define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\
79 wcontrols, wncontrols) \
80 { .id = snd_soc_dapm_pga, .name = wname, \
81 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
82 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
83 #define SND_SOC_DAPM_OUT_DRV(wname, wreg, wshift, winvert,\
84 wcontrols, wncontrols) \
85 { .id = snd_soc_dapm_out_drv, .name = wname, \
86 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
87 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
88 #define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
89 wcontrols, wncontrols)\
90 { .id = snd_soc_dapm_mixer, .name = wname, \
91 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
92 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
93 #define SND_SOC_DAPM_MIXER_NAMED_CTL(wname, wreg, wshift, winvert, \
94 wcontrols, wncontrols)\
95 { .id = snd_soc_dapm_mixer_named_ctl, .name = wname, \
96 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
97 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
98 #define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
99 { .id = snd_soc_dapm_micbias, .name = wname, \
100 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
101 .kcontrol_news = NULL, .num_kcontrols = 0}
102 #define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
103 { .id = snd_soc_dapm_switch, .name = wname, \
104 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
105 .kcontrol_news = wcontrols, .num_kcontrols = 1}
106 #define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
107 { .id = snd_soc_dapm_mux, .name = wname, \
108 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
109 .kcontrol_news = wcontrols, .num_kcontrols = 1}
110 #define SND_SOC_DAPM_DEMUX(wname, wreg, wshift, winvert, wcontrols) \
111 { .id = snd_soc_dapm_demux, .name = wname, \
112 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
113 .kcontrol_news = wcontrols, .num_kcontrols = 1}
115 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
116 #define SOC_PGA_ARRAY(wname, wreg, wshift, winvert,\
118 { .id = snd_soc_dapm_pga, .name = wname, \
119 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
120 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
121 #define SOC_MIXER_ARRAY(wname, wreg, wshift, winvert, \
123 { .id = snd_soc_dapm_mixer, .name = wname, \
124 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
125 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
126 #define SOC_MIXER_NAMED_CTL_ARRAY(wname, wreg, wshift, winvert, \
128 { .id = snd_soc_dapm_mixer_named_ctl, .name = wname, \
129 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
130 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
132 /* path domain with event - event handler must return 0 for success */
133 #define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \
134 wncontrols, wevent, wflags) \
135 { .id = snd_soc_dapm_pga, .name = wname, \
136 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
137 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
138 .event = wevent, .event_flags = wflags}
139 #define SND_SOC_DAPM_OUT_DRV_E(wname, wreg, wshift, winvert, wcontrols, \
140 wncontrols, wevent, wflags) \
141 { .id = snd_soc_dapm_out_drv, .name = wname, \
142 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
143 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
144 .event = wevent, .event_flags = wflags}
145 #define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \
146 wncontrols, wevent, wflags) \
147 { .id = snd_soc_dapm_mixer, .name = wname, \
148 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
149 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
150 .event = wevent, .event_flags = wflags}
151 #define SND_SOC_DAPM_MIXER_NAMED_CTL_E(wname, wreg, wshift, winvert, \
152 wcontrols, wncontrols, wevent, wflags) \
153 { .id = snd_soc_dapm_mixer, .name = wname, \
154 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
155 .kcontrol_news = wcontrols, \
156 .num_kcontrols = wncontrols, .event = wevent, .event_flags = wflags}
157 #define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
159 { .id = snd_soc_dapm_switch, .name = wname, \
160 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
161 .kcontrol_news = wcontrols, .num_kcontrols = 1, \
162 .event = wevent, .event_flags = wflags}
163 #define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
165 { .id = snd_soc_dapm_mux, .name = wname, \
166 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
167 .kcontrol_news = wcontrols, .num_kcontrols = 1, \
168 .event = wevent, .event_flags = wflags}
170 /* additional sequencing control within an event type */
171 #define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \
173 { .id = snd_soc_dapm_pga, .name = wname, \
174 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
175 .event = wevent, .event_flags = wflags, \
177 #define SND_SOC_DAPM_SUPPLY_S(wname, wsubseq, wreg, wshift, winvert, wevent, \
179 { .id = snd_soc_dapm_supply, .name = wname, \
180 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
181 .event = wevent, .event_flags = wflags, .subseq = wsubseq}
183 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
184 #define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
186 { .id = snd_soc_dapm_pga, .name = wname, \
187 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
188 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
189 .event = wevent, .event_flags = wflags}
190 #define SOC_MIXER_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
192 { .id = snd_soc_dapm_mixer, .name = wname, \
193 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
194 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
195 .event = wevent, .event_flags = wflags}
196 #define SOC_MIXER_NAMED_CTL_E_ARRAY(wname, wreg, wshift, winvert, \
197 wcontrols, wevent, wflags) \
198 { .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), \
201 .event = wevent, .event_flags = wflags}
203 /* events that are pre and post DAPM */
204 #define SND_SOC_DAPM_PRE(wname, wevent) \
205 { .id = snd_soc_dapm_pre, .name = wname, .kcontrol_news = NULL, \
206 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
207 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
208 #define SND_SOC_DAPM_POST(wname, wevent) \
209 { .id = snd_soc_dapm_post, .name = wname, .kcontrol_news = NULL, \
210 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
211 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
214 #define SND_SOC_DAPM_AIF_IN(wname, stname, wslot, wreg, wshift, winvert) \
215 { .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
216 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
217 #define SND_SOC_DAPM_AIF_IN_E(wname, stname, wslot, wreg, wshift, winvert, \
219 { .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
220 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
221 .event = wevent, .event_flags = wflags }
222 #define SND_SOC_DAPM_AIF_OUT(wname, stname, wslot, wreg, wshift, winvert) \
223 { .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
224 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
225 #define SND_SOC_DAPM_AIF_OUT_E(wname, stname, wslot, wreg, wshift, winvert, \
227 { .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
228 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
229 .event = wevent, .event_flags = wflags }
230 #define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
231 { .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \
232 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) }
233 #define SND_SOC_DAPM_DAC_E(wname, stname, wreg, wshift, winvert, \
235 { .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \
236 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
237 .event = wevent, .event_flags = wflags}
239 #define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
240 { .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \
241 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
242 #define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \
244 { .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \
245 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
246 .event = wevent, .event_flags = wflags}
247 #define SND_SOC_DAPM_CLOCK_SUPPLY(wname) \
248 { .id = snd_soc_dapm_clock_supply, .name = wname, \
249 .reg = SND_SOC_NOPM, .event = dapm_clock_event, \
250 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD }
252 /* generic widgets */
253 #define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
254 { .id = wid, .name = wname, .kcontrol_news = NULL, .num_kcontrols = 0, \
255 .reg = wreg, .shift = wshift, .mask = wmask, \
256 .on_val = won_val, .off_val = woff_val, }
257 #define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \
258 { .id = snd_soc_dapm_supply, .name = wname, \
259 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
260 .event = wevent, .event_flags = wflags}
261 #define SND_SOC_DAPM_REGULATOR_SUPPLY(wname, wdelay, wflags) \
262 { .id = snd_soc_dapm_regulator_supply, .name = wname, \
263 .reg = SND_SOC_NOPM, .shift = wdelay, .event = dapm_regulator_event, \
264 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD, \
268 /* dapm kcontrol types */
269 #define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
270 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
271 .info = snd_soc_info_volsw, \
272 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
273 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
274 #define SOC_DAPM_SINGLE_AUTODISABLE(xname, reg, shift, max, invert) \
275 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
276 .info = snd_soc_info_volsw, \
277 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
278 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 1) }
279 #define SOC_DAPM_SINGLE_VIRT(xname, max) \
280 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0)
281 #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
282 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
283 .info = snd_soc_info_volsw, \
284 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
285 .tlv.p = (tlv_array), \
286 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
287 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
288 #define SOC_DAPM_SINGLE_TLV_AUTODISABLE(xname, reg, shift, max, invert, tlv_array) \
289 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
290 .info = snd_soc_info_volsw, \
291 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
292 .tlv.p = (tlv_array), \
293 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
294 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
295 #define SOC_DAPM_SINGLE_TLV_VIRT(xname, max, tlv_array) \
296 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0, tlv_array)
297 #define SOC_DAPM_ENUM(xname, xenum) \
298 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
299 .info = snd_soc_info_enum_double, \
300 .get = snd_soc_dapm_get_enum_double, \
301 .put = snd_soc_dapm_put_enum_double, \
302 .private_value = (unsigned long)&xenum }
303 #define SOC_DAPM_ENUM_EXT(xname, xenum, xget, xput) \
304 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
305 .info = snd_soc_info_enum_double, \
308 .private_value = (unsigned long)&xenum }
309 #define SOC_DAPM_PIN_SWITCH(xname) \
310 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
311 .info = snd_soc_dapm_info_pin_switch, \
312 .get = snd_soc_dapm_get_pin_switch, \
313 .put = snd_soc_dapm_put_pin_switch, \
314 .private_value = (unsigned long)xname }
316 /* dapm stream operations */
317 #define SND_SOC_DAPM_STREAM_NOP 0x0
318 #define SND_SOC_DAPM_STREAM_START 0x1
319 #define SND_SOC_DAPM_STREAM_STOP 0x2
320 #define SND_SOC_DAPM_STREAM_SUSPEND 0x4
321 #define SND_SOC_DAPM_STREAM_RESUME 0x8
322 #define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10
323 #define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20
325 /* dapm event types */
326 #define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */
327 #define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */
328 #define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */
329 #define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */
330 #define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */
331 #define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */
332 #define SND_SOC_DAPM_WILL_PMU 0x40 /* called at start of sequence */
333 #define SND_SOC_DAPM_WILL_PMD 0x80 /* called at start of sequence */
334 #define SND_SOC_DAPM_PRE_POST_PMD \
335 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
337 /* convenience event type detection */
338 #define SND_SOC_DAPM_EVENT_ON(e) \
339 (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
340 #define SND_SOC_DAPM_EVENT_OFF(e) \
341 (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
343 /* regulator widget flags */
344 #define SND_SOC_DAPM_REGULATOR_BYPASS 0x1 /* bypass when disabled */
346 struct snd_soc_dapm_widget;
347 enum snd_soc_dapm_type;
348 struct snd_soc_dapm_path;
349 struct snd_soc_dapm_pin;
350 struct snd_soc_dapm_route;
351 struct snd_soc_dapm_context;
353 struct snd_soc_dapm_widget_list;
354 struct snd_soc_dapm_update;
356 int dapm_regulator_event(struct snd_soc_dapm_widget *w,
357 struct snd_kcontrol *kcontrol, int event);
358 int dapm_clock_event(struct snd_soc_dapm_widget *w,
359 struct snd_kcontrol *kcontrol, int event);
362 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
363 struct snd_ctl_elem_value *ucontrol);
364 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
365 struct snd_ctl_elem_value *ucontrol);
366 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
367 struct snd_ctl_elem_value *ucontrol);
368 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
369 struct snd_ctl_elem_value *ucontrol);
370 int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
371 struct snd_ctl_elem_info *uinfo);
372 int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
373 struct snd_ctl_elem_value *uncontrol);
374 int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
375 struct snd_ctl_elem_value *uncontrol);
376 int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
377 const struct snd_soc_dapm_widget *widget,
379 int snd_soc_dapm_new_dai_widgets(struct snd_soc_dapm_context *dapm,
380 struct snd_soc_dai *dai);
381 int snd_soc_dapm_link_dai_widgets(struct snd_soc_card *card);
382 void snd_soc_dapm_connect_dai_link_widgets(struct snd_soc_card *card);
383 int snd_soc_dapm_new_pcm(struct snd_soc_card *card,
384 const struct snd_soc_pcm_stream *params,
385 unsigned int num_params,
386 struct snd_soc_dapm_widget *source,
387 struct snd_soc_dapm_widget *sink);
389 /* dapm path setup */
390 int snd_soc_dapm_new_widgets(struct snd_soc_card *card);
391 void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
392 int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
393 const struct snd_soc_dapm_route *route, int num);
394 int snd_soc_dapm_del_routes(struct snd_soc_dapm_context *dapm,
395 const struct snd_soc_dapm_route *route, int num);
396 int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm,
397 const struct snd_soc_dapm_route *route, int num);
400 void snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd, int stream,
402 void snd_soc_dapm_shutdown(struct snd_soc_card *card);
404 /* external DAPM widget events */
405 int snd_soc_dapm_mixer_update_power(struct snd_soc_dapm_context *dapm,
406 struct snd_kcontrol *kcontrol, int connect,
407 struct snd_soc_dapm_update *update);
408 int snd_soc_dapm_mux_update_power(struct snd_soc_dapm_context *dapm,
409 struct snd_kcontrol *kcontrol, int mux, struct soc_enum *e,
410 struct snd_soc_dapm_update *update);
412 /* dapm sys fs - used by the core */
413 extern struct attribute *soc_dapm_dev_attrs[];
414 void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm,
415 struct dentry *parent);
417 /* dapm audio pin control and status */
418 int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
420 int snd_soc_dapm_enable_pin_unlocked(struct snd_soc_dapm_context *dapm,
422 int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
424 int snd_soc_dapm_disable_pin_unlocked(struct snd_soc_dapm_context *dapm,
426 int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
427 int snd_soc_dapm_nc_pin_unlocked(struct snd_soc_dapm_context *dapm,
429 int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
431 int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
432 int snd_soc_dapm_sync_unlocked(struct snd_soc_dapm_context *dapm);
433 int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
435 int snd_soc_dapm_force_enable_pin_unlocked(struct snd_soc_dapm_context *dapm,
437 int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
439 unsigned int dapm_kcontrol_get_value(const struct snd_kcontrol *kcontrol);
441 /* Mostly internal - should not normally be used */
442 void dapm_mark_endpoints_dirty(struct snd_soc_card *card);
444 /* dapm path query */
445 int snd_soc_dapm_dai_get_connected_widgets(struct snd_soc_dai *dai, int stream,
446 struct snd_soc_dapm_widget_list **list);
448 struct snd_soc_dapm_context *snd_soc_dapm_kcontrol_dapm(
449 struct snd_kcontrol *kcontrol);
451 int snd_soc_dapm_force_bias_level(struct snd_soc_dapm_context *dapm,
452 enum snd_soc_bias_level level);
454 /* dapm widget types */
455 enum snd_soc_dapm_type {
456 snd_soc_dapm_input = 0, /* input pin */
457 snd_soc_dapm_output, /* output pin */
458 snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */
459 snd_soc_dapm_demux, /* connects the input to one of multiple outputs */
460 snd_soc_dapm_mixer, /* mixes several analog signals together */
461 snd_soc_dapm_mixer_named_ctl, /* mixer with named controls */
462 snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */
463 snd_soc_dapm_out_drv, /* output driver */
464 snd_soc_dapm_adc, /* analog to digital converter */
465 snd_soc_dapm_dac, /* digital to analog converter */
466 snd_soc_dapm_micbias, /* microphone bias (power) */
467 snd_soc_dapm_mic, /* microphone */
468 snd_soc_dapm_hp, /* headphones */
469 snd_soc_dapm_spk, /* speaker */
470 snd_soc_dapm_line, /* line input/output */
471 snd_soc_dapm_switch, /* analog switch */
472 snd_soc_dapm_vmid, /* codec bias/vmid - to minimise pops */
473 snd_soc_dapm_pre, /* machine specific pre widget - exec first */
474 snd_soc_dapm_post, /* machine specific post widget - exec last */
475 snd_soc_dapm_supply, /* power/clock supply */
476 snd_soc_dapm_regulator_supply, /* external regulator */
477 snd_soc_dapm_clock_supply, /* external clock */
478 snd_soc_dapm_aif_in, /* audio interface input */
479 snd_soc_dapm_aif_out, /* audio interface output */
480 snd_soc_dapm_siggen, /* signal generator */
481 snd_soc_dapm_dai_in, /* link to DAI structure */
482 snd_soc_dapm_dai_out,
483 snd_soc_dapm_dai_link, /* link between two DAI structures */
484 snd_soc_dapm_kcontrol, /* Auto-disabled kcontrol */
487 enum snd_soc_dapm_subclass {
488 SND_SOC_DAPM_CLASS_INIT = 0,
489 SND_SOC_DAPM_CLASS_RUNTIME = 1,
493 * DAPM audio route definition.
495 * Defines an audio route originating at source via control and finishing
498 struct snd_soc_dapm_route {
503 /* Note: currently only supported for links where source is a supply */
504 int (*connected)(struct snd_soc_dapm_widget *source,
505 struct snd_soc_dapm_widget *sink);
508 /* dapm audio path between two widgets */
509 struct snd_soc_dapm_path {
512 /* source (input) and sink (output) widgets */
513 struct snd_soc_dapm_widget *source;
514 struct snd_soc_dapm_widget *sink;
517 u32 connect:1; /* source and sink widgets are connected */
518 u32 walking:1; /* path is in the process of being walked */
519 u32 weak:1; /* path ignored for power management */
520 u32 is_supply:1; /* At least one of the connected widgets is a supply */
522 int (*connected)(struct snd_soc_dapm_widget *source,
523 struct snd_soc_dapm_widget *sink);
525 struct list_head list_source;
526 struct list_head list_sink;
527 struct list_head list_kcontrol;
528 struct list_head list;
532 struct snd_soc_dapm_widget {
533 enum snd_soc_dapm_type id;
534 const char *name; /* widget name */
535 const char *sname; /* stream name */
536 struct list_head list;
537 struct snd_soc_dapm_context *dapm;
539 void *priv; /* widget specific data */
540 struct regulator *regulator; /* attached regulator */
541 const struct snd_soc_pcm_stream *params; /* params for dai links */
542 unsigned int num_params; /* number of params for dai links */
543 unsigned int params_select; /* currently selected param for dai link */
546 int reg; /* negative reg = no direct dapm */
547 unsigned char shift; /* bits to shift */
548 unsigned int mask; /* non-shifted mask */
549 unsigned int on_val; /* on state value */
550 unsigned int off_val; /* off state value */
551 unsigned char power:1; /* block power status */
552 unsigned char active:1; /* active stream on DAC, ADC's */
553 unsigned char connected:1; /* connected codec pin */
554 unsigned char new:1; /* cnew complete */
555 unsigned char force:1; /* force state */
556 unsigned char ignore_suspend:1; /* kept enabled over suspend */
557 unsigned char new_power:1; /* power from this run */
558 unsigned char power_checked:1; /* power checked this run */
559 unsigned char is_supply:1; /* Widget is a supply type widget */
560 unsigned char is_sink:1; /* Widget is a sink type widget */
561 unsigned char is_source:1; /* Widget is a source type widget */
562 int subseq; /* sort within widget type */
564 int (*power_check)(struct snd_soc_dapm_widget *w);
566 /* external events */
567 unsigned short event_flags; /* flags to specify event types */
568 int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
570 /* kcontrols that relate to this widget */
572 const struct snd_kcontrol_new *kcontrol_news;
573 struct snd_kcontrol **kcontrols;
575 /* widget input and outputs */
576 struct list_head sources;
577 struct list_head sinks;
579 /* used during DAPM updates */
580 struct list_head work_list;
581 struct list_head power_list;
582 struct list_head dirty;
589 struct snd_soc_dapm_update {
590 struct snd_kcontrol *kcontrol;
597 struct snd_soc_dapm_context {
598 enum snd_soc_bias_level bias_level;
599 unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
600 /* Go to BIAS_OFF in suspend if the DAPM context is idle */
601 unsigned int suspend_bias_off:1;
602 void (*seq_notifier)(struct snd_soc_dapm_context *,
603 enum snd_soc_dapm_type, int);
605 struct device *dev; /* from parent - for debug */
606 struct snd_soc_component *component; /* parent component */
607 struct snd_soc_card *card; /* parent card */
609 /* used during DAPM updates */
610 enum snd_soc_bias_level target_bias_level;
611 struct list_head list;
613 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
614 int (*set_bias_level)(struct snd_soc_dapm_context *dapm,
615 enum snd_soc_bias_level level);
617 #ifdef CONFIG_DEBUG_FS
618 struct dentry *debugfs_dapm;
622 /* A list of widgets associated with an object, typically a snd_kcontrol */
623 struct snd_soc_dapm_widget_list {
625 struct snd_soc_dapm_widget *widgets[0];
628 struct snd_soc_dapm_stats {
631 int neighbour_checks;
635 * snd_soc_dapm_init_bias_level() - Initialize DAPM bias level
636 * @dapm: The DAPM context to initialize
637 * @level: The DAPM level to initialize to
639 * This function only sets the driver internal state of the DAPM level and will
640 * not modify the state of the device. Hence it should not be used during normal
641 * operation, but only to synchronize the internal state to the device state.
642 * E.g. during driver probe to set the DAPM level to the one corresponding with
643 * the power-on reset state of the device.
645 * To change the DAPM state of the device use snd_soc_dapm_set_bias_level().
647 static inline void snd_soc_dapm_init_bias_level(
648 struct snd_soc_dapm_context *dapm, enum snd_soc_bias_level level)
650 dapm->bias_level = level;
654 * snd_soc_dapm_get_bias_level() - Get current DAPM bias level
655 * @dapm: The context for which to get the bias level
657 * Returns: The current bias level of the passed DAPM context.
659 static inline enum snd_soc_bias_level snd_soc_dapm_get_bias_level(
660 struct snd_soc_dapm_context *dapm)
662 return dapm->bias_level;