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}
74 #define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\
75 wcontrols, wncontrols) \
76 { .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
77 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
78 #define SND_SOC_DAPM_OUT_DRV(wname, wreg, wshift, winvert,\
79 wcontrols, wncontrols) \
80 { .id = snd_soc_dapm_out_drv, .name = wname, .reg = wreg, .shift = wshift, \
81 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
82 #define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
83 wcontrols, wncontrols)\
84 { .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
85 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
86 #define SND_SOC_DAPM_MIXER_NAMED_CTL(wname, wreg, wshift, winvert, \
87 wcontrols, wncontrols)\
88 { .id = snd_soc_dapm_mixer_named_ctl, .name = wname, .reg = wreg, \
89 .shift = wshift, .invert = winvert, .kcontrol_news = wcontrols, \
90 .num_kcontrols = wncontrols}
91 #define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
92 { .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
93 .invert = winvert, .kcontrol_news = NULL, .num_kcontrols = 0}
94 #define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
95 { .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
96 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1}
97 #define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
98 { .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
99 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1}
100 #define SND_SOC_DAPM_VIRT_MUX(wname, wreg, wshift, winvert, wcontrols) \
101 { .id = snd_soc_dapm_virt_mux, .name = wname, .reg = wreg, .shift = wshift, \
102 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1}
103 #define SND_SOC_DAPM_VALUE_MUX(wname, wreg, wshift, winvert, wcontrols) \
104 { .id = snd_soc_dapm_value_mux, .name = wname, .reg = wreg, \
105 .shift = wshift, .invert = winvert, .kcontrol_news = wcontrols, \
108 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
109 #define SOC_PGA_ARRAY(wname, wreg, wshift, winvert,\
111 { .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
112 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
113 #define SOC_MIXER_ARRAY(wname, wreg, wshift, winvert, \
115 { .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
116 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
117 #define SOC_MIXER_NAMED_CTL_ARRAY(wname, wreg, wshift, winvert, \
119 { .id = snd_soc_dapm_mixer_named_ctl, .name = wname, .reg = wreg, \
120 .shift = wshift, .invert = winvert, .kcontrol_news = wcontrols, \
121 .num_kcontrols = ARRAY_SIZE(wcontrols)}
123 /* path domain with event - event handler must return 0 for success */
124 #define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \
125 wncontrols, wevent, wflags) \
126 { .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
127 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
128 .event = wevent, .event_flags = wflags}
129 #define SND_SOC_DAPM_OUT_DRV_E(wname, wreg, wshift, winvert, wcontrols, \
130 wncontrols, wevent, wflags) \
131 { .id = snd_soc_dapm_out_drv, .name = wname, .reg = wreg, .shift = wshift, \
132 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
133 .event = wevent, .event_flags = wflags}
134 #define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \
135 wncontrols, wevent, wflags) \
136 { .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
137 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
138 .event = wevent, .event_flags = wflags}
139 #define SND_SOC_DAPM_MIXER_NAMED_CTL_E(wname, wreg, wshift, winvert, \
140 wcontrols, wncontrols, wevent, wflags) \
141 { .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
142 .invert = winvert, .kcontrol_news = wcontrols, \
143 .num_kcontrols = wncontrols, .event = wevent, .event_flags = wflags}
144 #define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
146 { .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
147 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1, \
148 .event = wevent, .event_flags = wflags}
149 #define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
151 { .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
152 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1, \
153 .event = wevent, .event_flags = wflags}
154 #define SND_SOC_DAPM_VIRT_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
156 { .id = snd_soc_dapm_virt_mux, .name = wname, .reg = wreg, .shift = wshift, \
157 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1, \
158 .event = wevent, .event_flags = wflags}
160 /* additional sequencing control within an event type */
161 #define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \
163 { .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
164 .invert = winvert, .event = wevent, .event_flags = wflags, \
166 #define SND_SOC_DAPM_SUPPLY_S(wname, wsubseq, wreg, wshift, winvert, wevent, \
168 { .id = snd_soc_dapm_supply, .name = wname, .reg = wreg, \
169 .shift = wshift, .invert = winvert, .event = wevent, \
170 .event_flags = wflags, .subseq = wsubseq}
172 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
173 #define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
175 { .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
176 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
177 .event = wevent, .event_flags = wflags}
178 #define SOC_MIXER_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
180 { .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
181 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
182 .event = wevent, .event_flags = wflags}
183 #define SOC_MIXER_NAMED_CTL_E_ARRAY(wname, wreg, wshift, winvert, \
184 wcontrols, wevent, wflags) \
185 { .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
186 .invert = winvert, .kcontrol_news = wcontrols, \
187 .num_kcontrols = ARRAY_SIZE(wcontrols), .event = wevent, .event_flags = wflags}
189 /* events that are pre and post DAPM */
190 #define SND_SOC_DAPM_PRE(wname, wevent) \
191 { .id = snd_soc_dapm_pre, .name = wname, .kcontrol_news = NULL, \
192 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
193 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
194 #define SND_SOC_DAPM_POST(wname, wevent) \
195 { .id = snd_soc_dapm_post, .name = wname, .kcontrol_news = NULL, \
196 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
197 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
200 #define SND_SOC_DAPM_AIF_IN(wname, stname, wslot, wreg, wshift, winvert) \
201 { .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
202 .reg = wreg, .shift = wshift, .invert = winvert }
203 #define SND_SOC_DAPM_AIF_IN_E(wname, stname, wslot, wreg, wshift, winvert, \
205 { .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
206 .reg = wreg, .shift = wshift, .invert = winvert, \
207 .event = wevent, .event_flags = wflags }
208 #define SND_SOC_DAPM_AIF_OUT(wname, stname, wslot, wreg, wshift, winvert) \
209 { .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
210 .reg = wreg, .shift = wshift, .invert = winvert }
211 #define SND_SOC_DAPM_AIF_OUT_E(wname, stname, wslot, wreg, wshift, winvert, \
213 { .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
214 .reg = wreg, .shift = wshift, .invert = winvert, \
215 .event = wevent, .event_flags = wflags }
216 #define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
217 { .id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
218 .shift = wshift, .invert = winvert}
219 #define SND_SOC_DAPM_DAC_E(wname, stname, wreg, wshift, winvert, \
221 { .id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
222 .shift = wshift, .invert = winvert, \
223 .event = wevent, .event_flags = wflags}
224 #define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
225 { .id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
226 .shift = wshift, .invert = winvert}
227 #define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \
229 { .id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
230 .shift = wshift, .invert = winvert, \
231 .event = wevent, .event_flags = wflags}
232 #define SND_SOC_DAPM_CLOCK_SUPPLY(wname) \
233 { .id = snd_soc_dapm_clock_supply, .name = wname, \
234 .reg = SND_SOC_NOPM, .event = dapm_clock_event, \
235 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD }
237 /* generic widgets */
238 #define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
239 { .id = wid, .name = wname, .kcontrol_news = NULL, .num_kcontrols = 0, \
240 .reg = -((wreg) + 1), .shift = wshift, .mask = wmask, \
241 .on_val = won_val, .off_val = woff_val, .event = dapm_reg_event, \
242 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
243 #define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \
244 { .id = snd_soc_dapm_supply, .name = wname, .reg = wreg, \
245 .shift = wshift, .invert = winvert, .event = wevent, \
246 .event_flags = wflags}
247 #define SND_SOC_DAPM_REGULATOR_SUPPLY(wname, wdelay) \
248 { .id = snd_soc_dapm_regulator_supply, .name = wname, \
249 .reg = SND_SOC_NOPM, .shift = wdelay, .event = dapm_regulator_event, \
250 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD }
253 /* dapm kcontrol types */
254 #define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
255 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
256 .info = snd_soc_info_volsw, \
257 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
258 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
259 #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
260 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
261 .info = snd_soc_info_volsw, \
262 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
263 .tlv.p = (tlv_array), \
264 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
265 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
266 #define SOC_DAPM_ENUM(xname, xenum) \
267 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
268 .info = snd_soc_info_enum_double, \
269 .get = snd_soc_dapm_get_enum_double, \
270 .put = snd_soc_dapm_put_enum_double, \
271 .private_value = (unsigned long)&xenum }
272 #define SOC_DAPM_ENUM_VIRT(xname, xenum) \
273 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
274 .info = snd_soc_info_enum_double, \
275 .get = snd_soc_dapm_get_enum_virt, \
276 .put = snd_soc_dapm_put_enum_virt, \
277 .private_value = (unsigned long)&xenum }
278 #define SOC_DAPM_ENUM_EXT(xname, xenum, xget, xput) \
279 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
280 .info = snd_soc_info_enum_double, \
283 .private_value = (unsigned long)&xenum }
284 #define SOC_DAPM_VALUE_ENUM(xname, xenum) \
285 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
286 .info = snd_soc_info_enum_double, \
287 .get = snd_soc_dapm_get_value_enum_double, \
288 .put = snd_soc_dapm_put_value_enum_double, \
289 .private_value = (unsigned long)&xenum }
290 #define SOC_DAPM_PIN_SWITCH(xname) \
291 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
292 .info = snd_soc_dapm_info_pin_switch, \
293 .get = snd_soc_dapm_get_pin_switch, \
294 .put = snd_soc_dapm_put_pin_switch, \
295 .private_value = (unsigned long)xname }
297 /* dapm stream operations */
298 #define SND_SOC_DAPM_STREAM_NOP 0x0
299 #define SND_SOC_DAPM_STREAM_START 0x1
300 #define SND_SOC_DAPM_STREAM_STOP 0x2
301 #define SND_SOC_DAPM_STREAM_SUSPEND 0x4
302 #define SND_SOC_DAPM_STREAM_RESUME 0x8
303 #define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10
304 #define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20
306 /* dapm event types */
307 #define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */
308 #define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */
309 #define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */
310 #define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */
311 #define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */
312 #define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */
313 #define SND_SOC_DAPM_PRE_POST_PMD \
314 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
316 /* convenience event type detection */
317 #define SND_SOC_DAPM_EVENT_ON(e) \
318 (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
319 #define SND_SOC_DAPM_EVENT_OFF(e) \
320 (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
322 struct snd_soc_dapm_widget;
323 enum snd_soc_dapm_type;
324 struct snd_soc_dapm_path;
325 struct snd_soc_dapm_pin;
326 struct snd_soc_dapm_route;
327 struct snd_soc_dapm_context;
329 struct snd_soc_dapm_widget_list;
331 int dapm_reg_event(struct snd_soc_dapm_widget *w,
332 struct snd_kcontrol *kcontrol, int event);
333 int dapm_regulator_event(struct snd_soc_dapm_widget *w,
334 struct snd_kcontrol *kcontrol, int event);
335 int dapm_clock_event(struct snd_soc_dapm_widget *w,
336 struct snd_kcontrol *kcontrol, int event);
339 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
340 struct snd_ctl_elem_value *ucontrol);
341 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
342 struct snd_ctl_elem_value *ucontrol);
343 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
344 struct snd_ctl_elem_value *ucontrol);
345 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
346 struct snd_ctl_elem_value *ucontrol);
347 int snd_soc_dapm_get_enum_virt(struct snd_kcontrol *kcontrol,
348 struct snd_ctl_elem_value *ucontrol);
349 int snd_soc_dapm_put_enum_virt(struct snd_kcontrol *kcontrol,
350 struct snd_ctl_elem_value *ucontrol);
351 int snd_soc_dapm_get_value_enum_double(struct snd_kcontrol *kcontrol,
352 struct snd_ctl_elem_value *ucontrol);
353 int snd_soc_dapm_put_value_enum_double(struct snd_kcontrol *kcontrol,
354 struct snd_ctl_elem_value *ucontrol);
355 int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
356 struct snd_ctl_elem_info *uinfo);
357 int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
358 struct snd_ctl_elem_value *uncontrol);
359 int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
360 struct snd_ctl_elem_value *uncontrol);
361 int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
362 const struct snd_soc_dapm_widget *widget,
364 int snd_soc_dapm_new_dai_widgets(struct snd_soc_dapm_context *dapm,
365 struct snd_soc_dai *dai);
366 int snd_soc_dapm_link_dai_widgets(struct snd_soc_card *card);
367 int snd_soc_dapm_new_pcm(struct snd_soc_card *card,
368 const struct snd_soc_pcm_stream *params,
369 struct snd_soc_dapm_widget *source,
370 struct snd_soc_dapm_widget *sink);
372 /* dapm path setup */
373 int snd_soc_dapm_new_widgets(struct snd_soc_dapm_context *dapm);
374 void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
375 int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
376 const struct snd_soc_dapm_route *route, int num);
377 int snd_soc_dapm_del_routes(struct snd_soc_dapm_context *dapm,
378 const struct snd_soc_dapm_route *route, int num);
379 int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm,
380 const struct snd_soc_dapm_route *route, int num);
383 void snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd, int stream,
385 void snd_soc_dapm_shutdown(struct snd_soc_card *card);
387 /* external DAPM widget events */
388 int snd_soc_dapm_mixer_update_power(struct snd_soc_dapm_widget *widget,
389 struct snd_kcontrol *kcontrol, int connect);
390 int snd_soc_dapm_mux_update_power(struct snd_soc_dapm_widget *widget,
391 struct snd_kcontrol *kcontrol, int mux, struct soc_enum *e);
393 /* dapm sys fs - used by the core */
394 int snd_soc_dapm_sys_add(struct device *dev);
395 void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm,
396 struct dentry *parent);
398 /* dapm audio pin control and status */
399 int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
401 int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
403 int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
404 int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
406 int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
407 int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
409 int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
411 void snd_soc_dapm_auto_nc_codec_pins(struct snd_soc_codec *codec);
413 /* Mostly internal - should not normally be used */
414 void dapm_mark_dirty(struct snd_soc_dapm_widget *w, const char *reason);
416 /* dapm path query */
417 int snd_soc_dapm_dai_get_connected_widgets(struct snd_soc_dai *dai, int stream,
418 struct snd_soc_dapm_widget_list **list);
420 /* dapm widget types */
421 enum snd_soc_dapm_type {
422 snd_soc_dapm_input = 0, /* input pin */
423 snd_soc_dapm_output, /* output pin */
424 snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */
425 snd_soc_dapm_virt_mux, /* virtual version of snd_soc_dapm_mux */
426 snd_soc_dapm_value_mux, /* selects 1 analog signal from many inputs */
427 snd_soc_dapm_mixer, /* mixes several analog signals together */
428 snd_soc_dapm_mixer_named_ctl, /* mixer with named controls */
429 snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */
430 snd_soc_dapm_out_drv, /* output driver */
431 snd_soc_dapm_adc, /* analog to digital converter */
432 snd_soc_dapm_dac, /* digital to analog converter */
433 snd_soc_dapm_micbias, /* microphone bias (power) */
434 snd_soc_dapm_mic, /* microphone */
435 snd_soc_dapm_hp, /* headphones */
436 snd_soc_dapm_spk, /* speaker */
437 snd_soc_dapm_line, /* line input/output */
438 snd_soc_dapm_switch, /* analog switch */
439 snd_soc_dapm_vmid, /* codec bias/vmid - to minimise pops */
440 snd_soc_dapm_pre, /* machine specific pre widget - exec first */
441 snd_soc_dapm_post, /* machine specific post widget - exec last */
442 snd_soc_dapm_supply, /* power/clock supply */
443 snd_soc_dapm_regulator_supply, /* external regulator */
444 snd_soc_dapm_clock_supply, /* external clock */
445 snd_soc_dapm_aif_in, /* audio interface input */
446 snd_soc_dapm_aif_out, /* audio interface output */
447 snd_soc_dapm_siggen, /* signal generator */
448 snd_soc_dapm_dai, /* link to DAI structure */
449 snd_soc_dapm_dai_link, /* link between two DAI structures */
452 enum snd_soc_dapm_subclass {
453 SND_SOC_DAPM_CLASS_INIT = 0,
454 SND_SOC_DAPM_CLASS_RUNTIME = 1,
458 * DAPM audio route definition.
460 * Defines an audio route originating at source via control and finishing
463 struct snd_soc_dapm_route {
468 /* Note: currently only supported for links where source is a supply */
469 int (*connected)(struct snd_soc_dapm_widget *source,
470 struct snd_soc_dapm_widget *sink);
473 /* dapm audio path between two widgets */
474 struct snd_soc_dapm_path {
476 const char *long_name;
478 /* source (input) and sink (output) widgets */
479 struct snd_soc_dapm_widget *source;
480 struct snd_soc_dapm_widget *sink;
481 struct snd_kcontrol *kcontrol;
484 u32 connect:1; /* source and sink widgets are connected */
485 u32 walked:1; /* path has been walked */
486 u32 weak:1; /* path ignored for power management */
488 int (*connected)(struct snd_soc_dapm_widget *source,
489 struct snd_soc_dapm_widget *sink);
491 struct list_head list_source;
492 struct list_head list_sink;
493 struct list_head list;
497 struct snd_soc_dapm_widget {
498 enum snd_soc_dapm_type id;
499 const char *name; /* widget name */
500 const char *sname; /* stream name */
501 struct snd_soc_codec *codec;
502 struct snd_soc_platform *platform;
503 struct list_head list;
504 struct snd_soc_dapm_context *dapm;
506 void *priv; /* widget specific data */
507 struct regulator *regulator; /* attached regulator */
508 const struct snd_soc_pcm_stream *params; /* params for dai links */
511 int reg; /* negative reg = no direct dapm */
512 unsigned char shift; /* bits to shift */
513 unsigned int saved_value; /* widget saved value */
514 unsigned int value; /* widget current value */
515 unsigned int mask; /* non-shifted mask */
516 unsigned int on_val; /* on state value */
517 unsigned int off_val; /* off state value */
518 unsigned char power:1; /* block power status */
519 unsigned char invert:1; /* invert the power bit */
520 unsigned char active:1; /* active stream on DAC, ADC's */
521 unsigned char connected:1; /* connected codec pin */
522 unsigned char new:1; /* cnew complete */
523 unsigned char ext:1; /* has external widgets */
524 unsigned char force:1; /* force state */
525 unsigned char ignore_suspend:1; /* kept enabled over suspend */
526 unsigned char new_power:1; /* power from this run */
527 unsigned char power_checked:1; /* power checked this run */
528 int subseq; /* sort within widget type */
530 int (*power_check)(struct snd_soc_dapm_widget *w);
532 /* external events */
533 unsigned short event_flags; /* flags to specify event types */
534 int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
536 /* kcontrols that relate to this widget */
538 const struct snd_kcontrol_new *kcontrol_news;
539 struct snd_kcontrol **kcontrols;
541 /* widget input and outputs */
542 struct list_head sources;
543 struct list_head sinks;
545 /* used during DAPM updates */
546 struct list_head power_list;
547 struct list_head dirty;
554 struct snd_soc_dapm_update {
555 struct snd_soc_dapm_widget *widget;
556 struct snd_kcontrol *kcontrol;
563 struct snd_soc_dapm_context {
564 int n_widgets; /* number of widgets in this context */
565 enum snd_soc_bias_level bias_level;
566 enum snd_soc_bias_level suspend_bias_level;
567 struct delayed_work delayed_work;
568 unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
570 struct snd_soc_dapm_update *update;
572 void (*seq_notifier)(struct snd_soc_dapm_context *,
573 enum snd_soc_dapm_type, int);
575 struct device *dev; /* from parent - for debug */
576 struct snd_soc_codec *codec; /* parent codec */
577 struct snd_soc_platform *platform; /* parent platform */
578 struct snd_soc_card *card; /* parent card */
580 /* used during DAPM updates */
581 enum snd_soc_bias_level target_bias_level;
582 struct list_head list;
584 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
586 #ifdef CONFIG_DEBUG_FS
587 struct dentry *debugfs_dapm;
591 /* A list of widgets associated with an object, typically a snd_kcontrol */
592 struct snd_soc_dapm_widget_list {
594 struct snd_soc_dapm_widget *widgets[0];
597 struct snd_soc_dapm_stats {
600 int neighbour_checks;