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_VIRT_MUX(wname, wreg, wshift, winvert, wcontrols) \
111 SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols)
112 #define SND_SOC_DAPM_VALUE_MUX(wname, wreg, wshift, winvert, wcontrols) \
113 SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols)
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}
169 #define SND_SOC_DAPM_VIRT_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
171 SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, wevent, \
174 /* additional sequencing control within an event type */
175 #define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \
177 { .id = snd_soc_dapm_pga, .name = wname, \
178 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
179 .event = wevent, .event_flags = wflags, \
181 #define SND_SOC_DAPM_SUPPLY_S(wname, wsubseq, wreg, wshift, winvert, wevent, \
183 { .id = snd_soc_dapm_supply, .name = wname, \
184 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
185 .event = wevent, .event_flags = wflags, .subseq = wsubseq}
187 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
188 #define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
190 { .id = snd_soc_dapm_pga, .name = wname, \
191 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
192 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
193 .event = wevent, .event_flags = wflags}
194 #define SOC_MIXER_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
196 { .id = snd_soc_dapm_mixer, .name = wname, \
197 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
198 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
199 .event = wevent, .event_flags = wflags}
200 #define SOC_MIXER_NAMED_CTL_E_ARRAY(wname, wreg, wshift, winvert, \
201 wcontrols, wevent, wflags) \
202 { .id = snd_soc_dapm_mixer, .name = wname, \
203 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
204 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
205 .event = wevent, .event_flags = wflags}
207 /* events that are pre and post DAPM */
208 #define SND_SOC_DAPM_PRE(wname, wevent) \
209 { .id = snd_soc_dapm_pre, .name = wname, .kcontrol_news = NULL, \
210 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
211 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
212 #define SND_SOC_DAPM_POST(wname, wevent) \
213 { .id = snd_soc_dapm_post, .name = wname, .kcontrol_news = NULL, \
214 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
215 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
218 #define SND_SOC_DAPM_AIF_IN(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 #define SND_SOC_DAPM_AIF_IN_E(wname, stname, wslot, wreg, wshift, winvert, \
223 { .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
224 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
225 .event = wevent, .event_flags = wflags }
226 #define SND_SOC_DAPM_AIF_OUT(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 #define SND_SOC_DAPM_AIF_OUT_E(wname, stname, wslot, wreg, wshift, winvert, \
231 { .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
232 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
233 .event = wevent, .event_flags = wflags }
234 #define SND_SOC_DAPM_DAC(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 #define SND_SOC_DAPM_DAC_E(wname, stname, wreg, wshift, winvert, \
239 { .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \
240 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
241 .event = wevent, .event_flags = wflags}
243 #define SND_SOC_DAPM_ADC(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 #define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \
248 { .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \
249 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
250 .event = wevent, .event_flags = wflags}
251 #define SND_SOC_DAPM_CLOCK_SUPPLY(wname) \
252 { .id = snd_soc_dapm_clock_supply, .name = wname, \
253 .reg = SND_SOC_NOPM, .event = dapm_clock_event, \
254 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD }
256 /* generic widgets */
257 #define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
258 { .id = wid, .name = wname, .kcontrol_news = NULL, .num_kcontrols = 0, \
259 .reg = wreg, .shift = wshift, .mask = wmask, \
260 .on_val = won_val, .off_val = woff_val, }
261 #define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \
262 { .id = snd_soc_dapm_supply, .name = wname, \
263 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
264 .event = wevent, .event_flags = wflags}
265 #define SND_SOC_DAPM_REGULATOR_SUPPLY(wname, wdelay, wflags) \
266 { .id = snd_soc_dapm_regulator_supply, .name = wname, \
267 .reg = SND_SOC_NOPM, .shift = wdelay, .event = dapm_regulator_event, \
268 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD, \
272 /* dapm kcontrol types */
273 #define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
274 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
275 .info = snd_soc_info_volsw, \
276 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
277 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
278 #define SOC_DAPM_SINGLE_AUTODISABLE(xname, reg, shift, max, invert) \
279 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
280 .info = snd_soc_info_volsw, \
281 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
282 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 1) }
283 #define SOC_DAPM_SINGLE_VIRT(xname, max) \
284 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0)
285 #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
286 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
287 .info = snd_soc_info_volsw, \
288 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
289 .tlv.p = (tlv_array), \
290 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
291 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
292 #define SOC_DAPM_SINGLE_TLV_AUTODISABLE(xname, reg, shift, max, invert, tlv_array) \
293 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
294 .info = snd_soc_info_volsw, \
295 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
296 .tlv.p = (tlv_array), \
297 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
298 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
299 #define SOC_DAPM_SINGLE_TLV_VIRT(xname, max, tlv_array) \
300 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0, tlv_array)
301 #define SOC_DAPM_ENUM(xname, xenum) \
302 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
303 .info = snd_soc_info_enum_double, \
304 .get = snd_soc_dapm_get_enum_double, \
305 .put = snd_soc_dapm_put_enum_double, \
306 .private_value = (unsigned long)&xenum }
307 #define SOC_DAPM_ENUM_VIRT(xname, xenum) \
308 SOC_DAPM_ENUM(xname, xenum)
309 #define SOC_DAPM_ENUM_EXT(xname, xenum, xget, xput) \
310 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
311 .info = snd_soc_info_enum_double, \
314 .private_value = (unsigned long)&xenum }
315 #define SOC_DAPM_VALUE_ENUM(xname, xenum) \
316 SOC_DAPM_ENUM(xname, xenum)
317 #define SOC_DAPM_PIN_SWITCH(xname) \
318 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
319 .info = snd_soc_dapm_info_pin_switch, \
320 .get = snd_soc_dapm_get_pin_switch, \
321 .put = snd_soc_dapm_put_pin_switch, \
322 .private_value = (unsigned long)xname }
324 /* dapm stream operations */
325 #define SND_SOC_DAPM_STREAM_NOP 0x0
326 #define SND_SOC_DAPM_STREAM_START 0x1
327 #define SND_SOC_DAPM_STREAM_STOP 0x2
328 #define SND_SOC_DAPM_STREAM_SUSPEND 0x4
329 #define SND_SOC_DAPM_STREAM_RESUME 0x8
330 #define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10
331 #define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20
333 /* dapm event types */
334 #define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */
335 #define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */
336 #define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */
337 #define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */
338 #define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */
339 #define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */
340 #define SND_SOC_DAPM_WILL_PMU 0x40 /* called at start of sequence */
341 #define SND_SOC_DAPM_WILL_PMD 0x80 /* called at start of sequence */
342 #define SND_SOC_DAPM_PRE_POST_PMD \
343 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
345 /* convenience event type detection */
346 #define SND_SOC_DAPM_EVENT_ON(e) \
347 (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
348 #define SND_SOC_DAPM_EVENT_OFF(e) \
349 (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
351 /* regulator widget flags */
352 #define SND_SOC_DAPM_REGULATOR_BYPASS 0x1 /* bypass when disabled */
354 struct snd_soc_dapm_widget;
355 enum snd_soc_dapm_type;
356 struct snd_soc_dapm_path;
357 struct snd_soc_dapm_pin;
358 struct snd_soc_dapm_route;
359 struct snd_soc_dapm_context;
361 struct snd_soc_dapm_widget_list;
362 struct snd_soc_dapm_update;
364 int dapm_regulator_event(struct snd_soc_dapm_widget *w,
365 struct snd_kcontrol *kcontrol, int event);
366 int dapm_clock_event(struct snd_soc_dapm_widget *w,
367 struct snd_kcontrol *kcontrol, int event);
370 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
371 struct snd_ctl_elem_value *ucontrol);
372 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
373 struct snd_ctl_elem_value *ucontrol);
374 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
375 struct snd_ctl_elem_value *ucontrol);
376 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
377 struct snd_ctl_elem_value *ucontrol);
378 int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
379 struct snd_ctl_elem_info *uinfo);
380 int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
381 struct snd_ctl_elem_value *uncontrol);
382 int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
383 struct snd_ctl_elem_value *uncontrol);
384 int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
385 const struct snd_soc_dapm_widget *widget,
387 int snd_soc_dapm_new_dai_widgets(struct snd_soc_dapm_context *dapm,
388 struct snd_soc_dai *dai);
389 int snd_soc_dapm_link_dai_widgets(struct snd_soc_card *card);
390 void snd_soc_dapm_connect_dai_link_widgets(struct snd_soc_card *card);
391 int snd_soc_dapm_new_pcm(struct snd_soc_card *card,
392 const struct snd_soc_pcm_stream *params,
393 struct snd_soc_dapm_widget *source,
394 struct snd_soc_dapm_widget *sink);
396 /* dapm path setup */
397 int snd_soc_dapm_new_widgets(struct snd_soc_card *card);
398 void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
399 int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
400 const struct snd_soc_dapm_route *route, int num);
401 int snd_soc_dapm_del_routes(struct snd_soc_dapm_context *dapm,
402 const struct snd_soc_dapm_route *route, int num);
403 int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm,
404 const struct snd_soc_dapm_route *route, int num);
407 void snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd, int stream,
409 void snd_soc_dapm_shutdown(struct snd_soc_card *card);
411 /* external DAPM widget events */
412 int snd_soc_dapm_mixer_update_power(struct snd_soc_dapm_context *dapm,
413 struct snd_kcontrol *kcontrol, int connect,
414 struct snd_soc_dapm_update *update);
415 int snd_soc_dapm_mux_update_power(struct snd_soc_dapm_context *dapm,
416 struct snd_kcontrol *kcontrol, int mux, struct soc_enum *e,
417 struct snd_soc_dapm_update *update);
419 /* dapm sys fs - used by the core */
420 int snd_soc_dapm_sys_add(struct device *dev);
421 void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm,
422 struct dentry *parent);
424 /* dapm audio pin control and status */
425 int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
427 int snd_soc_dapm_enable_pin_unlocked(struct snd_soc_dapm_context *dapm,
429 int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
431 int snd_soc_dapm_disable_pin_unlocked(struct snd_soc_dapm_context *dapm,
433 int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
434 int snd_soc_dapm_nc_pin_unlocked(struct snd_soc_dapm_context *dapm,
436 int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
438 int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
439 int snd_soc_dapm_sync_unlocked(struct snd_soc_dapm_context *dapm);
440 int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
442 int snd_soc_dapm_force_enable_pin_unlocked(struct snd_soc_dapm_context *dapm,
444 int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
446 void snd_soc_dapm_auto_nc_codec_pins(struct snd_soc_codec *codec);
448 /* Mostly internal - should not normally be used */
449 void dapm_mark_io_dirty(struct snd_soc_dapm_context *dapm);
451 /* dapm path query */
452 int snd_soc_dapm_dai_get_connected_widgets(struct snd_soc_dai *dai, int stream,
453 struct snd_soc_dapm_widget_list **list);
455 struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(struct snd_kcontrol *kcontrol);
457 /* dapm widget types */
458 enum snd_soc_dapm_type {
459 snd_soc_dapm_input = 0, /* input pin */
460 snd_soc_dapm_output, /* output pin */
461 snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */
462 snd_soc_dapm_mixer, /* mixes several analog signals together */
463 snd_soc_dapm_mixer_named_ctl, /* mixer with named controls */
464 snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */
465 snd_soc_dapm_out_drv, /* output driver */
466 snd_soc_dapm_adc, /* analog to digital converter */
467 snd_soc_dapm_dac, /* digital to analog converter */
468 snd_soc_dapm_micbias, /* microphone bias (power) */
469 snd_soc_dapm_mic, /* microphone */
470 snd_soc_dapm_hp, /* headphones */
471 snd_soc_dapm_spk, /* speaker */
472 snd_soc_dapm_line, /* line input/output */
473 snd_soc_dapm_switch, /* analog switch */
474 snd_soc_dapm_vmid, /* codec bias/vmid - to minimise pops */
475 snd_soc_dapm_pre, /* machine specific pre widget - exec first */
476 snd_soc_dapm_post, /* machine specific post widget - exec last */
477 snd_soc_dapm_supply, /* power/clock supply */
478 snd_soc_dapm_regulator_supply, /* external regulator */
479 snd_soc_dapm_clock_supply, /* external clock */
480 snd_soc_dapm_aif_in, /* audio interface input */
481 snd_soc_dapm_aif_out, /* audio interface output */
482 snd_soc_dapm_siggen, /* signal generator */
483 snd_soc_dapm_dai_in, /* link to DAI structure */
484 snd_soc_dapm_dai_out,
485 snd_soc_dapm_dai_link, /* link between two DAI structures */
486 snd_soc_dapm_kcontrol, /* Auto-disabled kcontrol */
489 enum snd_soc_dapm_subclass {
490 SND_SOC_DAPM_CLASS_INIT = 0,
491 SND_SOC_DAPM_CLASS_RUNTIME = 1,
495 * DAPM audio route definition.
497 * Defines an audio route originating at source via control and finishing
500 struct snd_soc_dapm_route {
505 /* Note: currently only supported for links where source is a supply */
506 int (*connected)(struct snd_soc_dapm_widget *source,
507 struct snd_soc_dapm_widget *sink);
510 /* dapm audio path between two widgets */
511 struct snd_soc_dapm_path {
514 /* source (input) and sink (output) widgets */
515 struct snd_soc_dapm_widget *source;
516 struct snd_soc_dapm_widget *sink;
519 u32 connect:1; /* source and sink widgets are connected */
520 u32 walked:1; /* path has been walked */
521 u32 walking:1; /* path is in the process of being walked */
522 u32 weak:1; /* path ignored for power management */
524 int (*connected)(struct snd_soc_dapm_widget *source,
525 struct snd_soc_dapm_widget *sink);
527 struct list_head list_source;
528 struct list_head list_sink;
529 struct list_head list_kcontrol;
530 struct list_head list;
534 struct snd_soc_dapm_widget {
535 enum snd_soc_dapm_type id;
536 const char *name; /* widget name */
537 const char *sname; /* stream name */
538 struct snd_soc_codec *codec;
539 struct snd_soc_platform *platform;
540 struct list_head list;
541 struct snd_soc_dapm_context *dapm;
543 void *priv; /* widget specific data */
544 struct regulator *regulator; /* attached regulator */
545 const struct snd_soc_pcm_stream *params; /* params for dai links */
548 int reg; /* negative reg = no direct dapm */
549 unsigned char shift; /* bits to shift */
550 unsigned int mask; /* non-shifted mask */
551 unsigned int on_val; /* on state value */
552 unsigned int off_val; /* off state value */
553 unsigned char power:1; /* block power status */
554 unsigned char active:1; /* active stream on DAC, ADC's */
555 unsigned char connected:1; /* connected codec pin */
556 unsigned char new:1; /* cnew complete */
557 unsigned char ext:1; /* has external widgets */
558 unsigned char force:1; /* force state */
559 unsigned char ignore_suspend:1; /* kept enabled over suspend */
560 unsigned char new_power:1; /* power from this run */
561 unsigned char power_checked:1; /* power checked this run */
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 power_list;
581 struct list_head dirty;
588 struct snd_soc_dapm_update {
589 struct snd_kcontrol *kcontrol;
596 struct snd_soc_dapm_context {
597 enum snd_soc_bias_level bias_level;
598 enum snd_soc_bias_level suspend_bias_level;
599 struct delayed_work delayed_work;
600 unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
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_codec *codec; /* parent codec */
608 struct snd_soc_platform *platform; /* parent platform */
609 struct snd_soc_card *card; /* parent card */
611 /* used during DAPM updates */
612 enum snd_soc_bias_level target_bias_level;
613 struct list_head list;
615 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
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;