d26a9b784772d797e88a529f199342f277e32390
[linux-2.6.git] / include / sound / soc-dapm.h
1 /*
2  * linux/sound/soc-dapm.h -- ALSA SoC Dynamic Audio Power Management
3  *
4  * Author:              Liam Girdwood
5  * Created:             Aug 11th 2005
6  * Copyright:   Wolfson Microelectronics. PLC.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11  */
12
13 #ifndef __LINUX_SND_SOC_DAPM_H
14 #define __LINUX_SND_SOC_DAPM_H
15
16 #include <linux/device.h>
17 #include <linux/types.h>
18 #include <sound/control.h>
19
20 /* widget has no PM register bit */
21 #define SND_SOC_NOPM    -1
22
23 /*
24  * SoC dynamic audio power management
25  *
26  * We can have up to 4 power domains
27  *  1. Codec domain - VREF, VMID
28  *     Usually controlled at codec probe/remove, although can be set
29  *     at stream time if power is not needed for sidetone, etc.
30  *  2. Platform/Machine domain - physically connected inputs and outputs
31  *     Is platform/machine and user action specific, is set in the machine
32  *     driver and by userspace e.g when HP are inserted
33  *  3. Path domain - Internal codec path mixers
34  *     Are automatically set when mixer and mux settings are
35  *     changed by the user.
36  *  4. Stream domain - DAC's and ADC's.
37  *     Enabled when stream playback/capture is started.
38  */
39
40 /* codec domain */
41 #define SND_SOC_DAPM_VMID(wname) \
42 {       .id = snd_soc_dapm_vmid, .name = wname, .kcontrol_news = NULL, \
43         .num_kcontrols = 0}
44
45 /* platform domain */
46 #define SND_SOC_DAPM_SIGGEN(wname) \
47 {       .id = snd_soc_dapm_siggen, .name = wname, .kcontrol_news = NULL, \
48         .num_kcontrols = 0, .reg = SND_SOC_NOPM }
49 #define SND_SOC_DAPM_INPUT(wname) \
50 {       .id = snd_soc_dapm_input, .name = wname, .kcontrol_news = NULL, \
51         .num_kcontrols = 0, .reg = SND_SOC_NOPM }
52 #define SND_SOC_DAPM_OUTPUT(wname) \
53 {       .id = snd_soc_dapm_output, .name = wname, .kcontrol_news = NULL, \
54         .num_kcontrols = 0, .reg = SND_SOC_NOPM }
55 #define SND_SOC_DAPM_MIC(wname, wevent) \
56 {       .id = snd_soc_dapm_mic, .name = wname, .kcontrol_news = NULL, \
57         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
58         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
59 #define SND_SOC_DAPM_HP(wname, wevent) \
60 {       .id = snd_soc_dapm_hp, .name = wname, .kcontrol_news = NULL, \
61         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
62         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
63 #define SND_SOC_DAPM_SPK(wname, wevent) \
64 {       .id = snd_soc_dapm_spk, .name = wname, .kcontrol_news = NULL, \
65         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
66         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
67 #define SND_SOC_DAPM_LINE(wname, wevent) \
68 {       .id = snd_soc_dapm_line, .name = wname, .kcontrol_news = NULL, \
69         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
70         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
71
72 /* path domain */
73 #define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\
74          wcontrols, wncontrols) \
75 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
76         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
77 #define SND_SOC_DAPM_OUT_DRV(wname, wreg, wshift, winvert,\
78          wcontrols, wncontrols) \
79 {       .id = snd_soc_dapm_out_drv, .name = wname, .reg = wreg, .shift = wshift, \
80         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
81 #define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
82          wcontrols, wncontrols)\
83 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
84         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
85 #define SND_SOC_DAPM_MIXER_NAMED_CTL(wname, wreg, wshift, winvert, \
86          wcontrols, wncontrols)\
87 {       .id = snd_soc_dapm_mixer_named_ctl, .name = wname, .reg = wreg, \
88         .shift = wshift, .invert = winvert, .kcontrol_news = wcontrols, \
89         .num_kcontrols = wncontrols}
90 #define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
91 {       .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
92         .invert = winvert, .kcontrol_news = NULL, .num_kcontrols = 0}
93 #define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
94 {       .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
95         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1}
96 #define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
97 {       .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
98         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1}
99 #define SND_SOC_DAPM_VIRT_MUX(wname, wreg, wshift, winvert, wcontrols) \
100 {       .id = snd_soc_dapm_virt_mux, .name = wname, .reg = wreg, .shift = wshift, \
101         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1}
102 #define SND_SOC_DAPM_VALUE_MUX(wname, wreg, wshift, winvert, wcontrols) \
103 {       .id = snd_soc_dapm_value_mux, .name = wname, .reg = wreg, \
104         .shift = wshift, .invert = winvert, .kcontrol_news = wcontrols, \
105         .num_kcontrols = 1}
106
107 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
108 #define SOC_PGA_ARRAY(wname, wreg, wshift, winvert,\
109          wcontrols) \
110 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
111         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
112 #define SOC_MIXER_ARRAY(wname, wreg, wshift, winvert, \
113          wcontrols)\
114 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
115         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
116 #define SOC_MIXER_NAMED_CTL_ARRAY(wname, wreg, wshift, winvert, \
117          wcontrols)\
118 {       .id = snd_soc_dapm_mixer_named_ctl, .name = wname, .reg = wreg, \
119         .shift = wshift, .invert = winvert, .kcontrol_news = wcontrols, \
120         .num_kcontrols = ARRAY_SIZE(wcontrols)}
121
122 /* path domain with event - event handler must return 0 for success */
123 #define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \
124         wncontrols, wevent, wflags) \
125 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
126         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
127         .event = wevent, .event_flags = wflags}
128 #define SND_SOC_DAPM_OUT_DRV_E(wname, wreg, wshift, winvert, wcontrols, \
129         wncontrols, wevent, wflags) \
130 {       .id = snd_soc_dapm_out_drv, .name = wname, .reg = wreg, .shift = wshift, \
131         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
132         .event = wevent, .event_flags = wflags}
133 #define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \
134         wncontrols, wevent, wflags) \
135 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
136         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
137         .event = wevent, .event_flags = wflags}
138 #define SND_SOC_DAPM_MIXER_NAMED_CTL_E(wname, wreg, wshift, winvert, \
139         wcontrols, wncontrols, wevent, wflags) \
140 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
141         .invert = winvert, .kcontrol_news = wcontrols, \
142         .num_kcontrols = wncontrols, .event = wevent, .event_flags = wflags}
143 #define SND_SOC_DAPM_MICBIAS_E(wname, wreg, wshift, winvert, wevent, wflags) \
144 {       .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
145         .invert = winvert, .kcontrol_news = NULL, .num_kcontrols = 0, \
146         .event = wevent, .event_flags = wflags}
147 #define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
148         wevent, wflags) \
149 {       .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
150         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1, \
151         .event = wevent, .event_flags = wflags}
152 #define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
153         wevent, wflags) \
154 {       .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
155         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1, \
156         .event = wevent, .event_flags = wflags}
157 #define SND_SOC_DAPM_VIRT_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
158         wevent, wflags) \
159 {       .id = snd_soc_dapm_virt_mux, .name = wname, .reg = wreg, .shift = wshift, \
160         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1, \
161         .event = wevent, .event_flags = wflags}
162
163 /* additional sequencing control within an event type */
164 #define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \
165         wevent, wflags) \
166 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
167         .invert = winvert, .event = wevent, .event_flags = wflags, \
168         .subseq = wsubseq}
169 #define SND_SOC_DAPM_SUPPLY_S(wname, wsubseq, wreg, wshift, winvert, wevent, \
170         wflags) \
171 {       .id = snd_soc_dapm_supply, .name = wname, .reg = wreg,  \
172         .shift = wshift, .invert = winvert, .event = wevent, \
173         .event_flags = wflags, .subseq = wsubseq}
174
175 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
176 #define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
177         wevent, wflags) \
178 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
179         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
180         .event = wevent, .event_flags = wflags}
181 #define SOC_MIXER_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
182         wevent, wflags) \
183 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
184         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
185         .event = wevent, .event_flags = wflags}
186 #define SOC_MIXER_NAMED_CTL_E_ARRAY(wname, wreg, wshift, winvert, \
187         wcontrols, wevent, wflags) \
188 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
189         .invert = winvert, .kcontrol_news = wcontrols, \
190         .num_kcontrols = ARRAY_SIZE(wcontrols), .event = wevent, .event_flags = wflags}
191
192 /* events that are pre and post DAPM */
193 #define SND_SOC_DAPM_PRE(wname, wevent) \
194 {       .id = snd_soc_dapm_pre, .name = wname, .kcontrol_news = NULL, \
195         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
196         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
197 #define SND_SOC_DAPM_POST(wname, wevent) \
198 {       .id = snd_soc_dapm_post, .name = wname, .kcontrol_news = NULL, \
199         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
200         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
201
202 /* stream domain */
203 #define SND_SOC_DAPM_AIF_IN(wname, stname, wslot, wreg, wshift, winvert) \
204 {       .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
205         .reg = wreg, .shift = wshift, .invert = winvert }
206 #define SND_SOC_DAPM_AIF_IN_E(wname, stname, wslot, wreg, wshift, winvert, \
207                               wevent, wflags)                           \
208 {       .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
209         .reg = wreg, .shift = wshift, .invert = winvert, \
210         .event = wevent, .event_flags = wflags }
211 #define SND_SOC_DAPM_AIF_OUT(wname, stname, wslot, wreg, wshift, winvert) \
212 {       .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
213         .reg = wreg, .shift = wshift, .invert = winvert }
214 #define SND_SOC_DAPM_AIF_OUT_E(wname, stname, wslot, wreg, wshift, winvert, \
215                              wevent, wflags)                            \
216 {       .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
217         .reg = wreg, .shift = wshift, .invert = winvert, \
218         .event = wevent, .event_flags = wflags }
219 #define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
220 {       .id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
221         .shift = wshift, .invert = winvert}
222 #define SND_SOC_DAPM_DAC_E(wname, stname, wreg, wshift, winvert, \
223                            wevent, wflags)                              \
224 {       .id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
225         .shift = wshift, .invert = winvert, \
226         .event = wevent, .event_flags = wflags}
227 #define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
228 {       .id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
229         .shift = wshift, .invert = winvert}
230 #define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \
231                            wevent, wflags)                              \
232 {       .id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
233         .shift = wshift, .invert = winvert, \
234         .event = wevent, .event_flags = wflags}
235
236 /* generic widgets */
237 #define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
238 {       .id = wid, .name = wname, .kcontrol_news = NULL, .num_kcontrols = 0, \
239         .reg = -((wreg) + 1), .shift = wshift, .mask = wmask, \
240         .on_val = won_val, .off_val = woff_val, .event = dapm_reg_event, \
241         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
242 #define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \
243 {       .id = snd_soc_dapm_supply, .name = wname, .reg = wreg,  \
244         .shift = wshift, .invert = winvert, .event = wevent, \
245         .event_flags = wflags}
246
247 /* dapm kcontrol types */
248 #define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
249 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
250         .info = snd_soc_info_volsw, \
251         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
252         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
253 #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
254 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
255         .info = snd_soc_info_volsw, \
256         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
257         .tlv.p = (tlv_array), \
258         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
259         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
260 #define SOC_DAPM_ENUM(xname, xenum) \
261 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
262         .info = snd_soc_info_enum_double, \
263         .get = snd_soc_dapm_get_enum_double, \
264         .put = snd_soc_dapm_put_enum_double, \
265         .private_value = (unsigned long)&xenum }
266 #define SOC_DAPM_ENUM_VIRT(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_virt, \
270         .put = snd_soc_dapm_put_enum_virt, \
271         .private_value = (unsigned long)&xenum }
272 #define SOC_DAPM_ENUM_EXT(xname, xenum, xget, xput) \
273 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
274         .info = snd_soc_info_enum_double, \
275         .get = xget, \
276         .put = xput, \
277         .private_value = (unsigned long)&xenum }
278 #define SOC_DAPM_VALUE_ENUM(xname, xenum) \
279 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
280         .info = snd_soc_info_enum_double, \
281         .get = snd_soc_dapm_get_value_enum_double, \
282         .put = snd_soc_dapm_put_value_enum_double, \
283         .private_value = (unsigned long)&xenum }
284 #define SOC_DAPM_PIN_SWITCH(xname) \
285 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
286         .info = snd_soc_dapm_info_pin_switch, \
287         .get = snd_soc_dapm_get_pin_switch, \
288         .put = snd_soc_dapm_put_pin_switch, \
289         .private_value = (unsigned long)xname }
290
291 /* dapm stream operations */
292 #define SND_SOC_DAPM_STREAM_NOP                 0x0
293 #define SND_SOC_DAPM_STREAM_START               0x1
294 #define SND_SOC_DAPM_STREAM_STOP                0x2
295 #define SND_SOC_DAPM_STREAM_SUSPEND             0x4
296 #define SND_SOC_DAPM_STREAM_RESUME              0x8
297 #define SND_SOC_DAPM_STREAM_PAUSE_PUSH  0x10
298 #define SND_SOC_DAPM_STREAM_PAUSE_RELEASE       0x20
299
300 /* dapm event types */
301 #define SND_SOC_DAPM_PRE_PMU    0x1     /* before widget power up */
302 #define SND_SOC_DAPM_POST_PMU   0x2             /* after widget power up */
303 #define SND_SOC_DAPM_PRE_PMD    0x4     /* before widget power down */
304 #define SND_SOC_DAPM_POST_PMD   0x8             /* after widget power down */
305 #define SND_SOC_DAPM_PRE_REG    0x10    /* before audio path setup */
306 #define SND_SOC_DAPM_POST_REG   0x20    /* after audio path setup */
307 #define SND_SOC_DAPM_PRE_POST_PMD \
308                                 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
309
310 /* convenience event type detection */
311 #define SND_SOC_DAPM_EVENT_ON(e)        \
312         (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
313 #define SND_SOC_DAPM_EVENT_OFF(e)       \
314         (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
315
316 struct snd_soc_dapm_widget;
317 enum snd_soc_dapm_type;
318 struct snd_soc_dapm_path;
319 struct snd_soc_dapm_pin;
320 struct snd_soc_dapm_route;
321 struct snd_soc_dapm_context;
322
323 int dapm_reg_event(struct snd_soc_dapm_widget *w,
324                    struct snd_kcontrol *kcontrol, int event);
325
326 /* dapm controls */
327 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
328         struct snd_ctl_elem_value *ucontrol);
329 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
330         struct snd_ctl_elem_value *ucontrol);
331 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
332         struct snd_ctl_elem_value *ucontrol);
333 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
334         struct snd_ctl_elem_value *ucontrol);
335 int snd_soc_dapm_get_enum_virt(struct snd_kcontrol *kcontrol,
336         struct snd_ctl_elem_value *ucontrol);
337 int snd_soc_dapm_put_enum_virt(struct snd_kcontrol *kcontrol,
338         struct snd_ctl_elem_value *ucontrol);
339 int snd_soc_dapm_get_value_enum_double(struct snd_kcontrol *kcontrol,
340         struct snd_ctl_elem_value *ucontrol);
341 int snd_soc_dapm_put_value_enum_double(struct snd_kcontrol *kcontrol,
342         struct snd_ctl_elem_value *ucontrol);
343 int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
344         struct snd_ctl_elem_info *uinfo);
345 int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
346         struct snd_ctl_elem_value *uncontrol);
347 int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
348         struct snd_ctl_elem_value *uncontrol);
349 int snd_soc_dapm_new_control(struct snd_soc_dapm_context *dapm,
350         const struct snd_soc_dapm_widget *widget);
351 int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
352         const struct snd_soc_dapm_widget *widget,
353         int num);
354
355 /* dapm path setup */
356 int snd_soc_dapm_new_widgets(struct snd_soc_dapm_context *dapm);
357 void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
358 int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
359                             const struct snd_soc_dapm_route *route, int num);
360 int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm,
361                              const struct snd_soc_dapm_route *route, int num);
362
363 /* dapm events */
364 int snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd,
365         const char *stream, int event);
366 void snd_soc_dapm_shutdown(struct snd_soc_card *card);
367
368 /* dapm sys fs - used by the core */
369 int snd_soc_dapm_sys_add(struct device *dev);
370 void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm,
371                                 struct dentry *parent);
372
373 /* dapm audio pin control and status */
374 int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
375                             const char *pin);
376 int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
377                              const char *pin);
378 int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
379 int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
380                                 const char *pin);
381 int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
382 int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
383                                   const char *pin);
384 int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
385                                 const char *pin);
386 void snd_soc_dapm_auto_nc_codec_pins(struct snd_soc_codec *codec);
387
388 /* Mostly internal - should not normally be used */
389 void dapm_mark_dirty(struct snd_soc_dapm_widget *w, const char *reason);
390
391 /* dapm widget types */
392 enum snd_soc_dapm_type {
393         snd_soc_dapm_input = 0,         /* input pin */
394         snd_soc_dapm_output,            /* output pin */
395         snd_soc_dapm_mux,                       /* selects 1 analog signal from many inputs */
396         snd_soc_dapm_virt_mux,                  /* virtual version of snd_soc_dapm_mux */
397         snd_soc_dapm_value_mux,                 /* selects 1 analog signal from many inputs */
398         snd_soc_dapm_mixer,                     /* mixes several analog signals together */
399         snd_soc_dapm_mixer_named_ctl,           /* mixer with named controls */
400         snd_soc_dapm_pga,                       /* programmable gain/attenuation (volume) */
401         snd_soc_dapm_out_drv,                   /* output driver */
402         snd_soc_dapm_adc,                       /* analog to digital converter */
403         snd_soc_dapm_dac,                       /* digital to analog converter */
404         snd_soc_dapm_micbias,           /* microphone bias (power) */
405         snd_soc_dapm_mic,                       /* microphone */
406         snd_soc_dapm_hp,                        /* headphones */
407         snd_soc_dapm_spk,                       /* speaker */
408         snd_soc_dapm_line,                      /* line input/output */
409         snd_soc_dapm_switch,            /* analog switch */
410         snd_soc_dapm_vmid,                      /* codec bias/vmid - to minimise pops */
411         snd_soc_dapm_pre,                       /* machine specific pre widget - exec first */
412         snd_soc_dapm_post,                      /* machine specific post widget - exec last */
413         snd_soc_dapm_supply,            /* power/clock supply */
414         snd_soc_dapm_aif_in,            /* audio interface input */
415         snd_soc_dapm_aif_out,           /* audio interface output */
416         snd_soc_dapm_siggen,            /* signal generator */
417 };
418
419 /*
420  * DAPM audio route definition.
421  *
422  * Defines an audio route originating at source via control and finishing
423  * at sink.
424  */
425 struct snd_soc_dapm_route {
426         const char *sink;
427         const char *control;
428         const char *source;
429
430         /* Note: currently only supported for links where source is a supply */
431         int (*connected)(struct snd_soc_dapm_widget *source,
432                          struct snd_soc_dapm_widget *sink);
433 };
434
435 /* dapm audio path between two widgets */
436 struct snd_soc_dapm_path {
437         char *name;
438         char *long_name;
439
440         /* source (input) and sink (output) widgets */
441         struct snd_soc_dapm_widget *source;
442         struct snd_soc_dapm_widget *sink;
443         struct snd_kcontrol *kcontrol;
444
445         /* status */
446         u32 connect:1;  /* source and sink widgets are connected */
447         u32 walked:1;   /* path has been walked */
448         u32 weak:1;     /* path ignored for power management */
449
450         int (*connected)(struct snd_soc_dapm_widget *source,
451                          struct snd_soc_dapm_widget *sink);
452
453         struct list_head list_source;
454         struct list_head list_sink;
455         struct list_head list;
456 };
457
458 /* dapm widget */
459 struct snd_soc_dapm_widget {
460         enum snd_soc_dapm_type id;
461         char *name;             /* widget name */
462         char *sname;    /* stream name */
463         struct snd_soc_codec *codec;
464         struct snd_soc_platform *platform;
465         struct list_head list;
466         struct snd_soc_dapm_context *dapm;
467
468         /* dapm control */
469         short reg;                                              /* negative reg = no direct dapm */
470         unsigned char shift;                    /* bits to shift */
471         unsigned int saved_value;               /* widget saved value */
472         unsigned int value;                             /* widget current value */
473         unsigned int mask;                      /* non-shifted mask */
474         unsigned int on_val;                    /* on state value */
475         unsigned int off_val;                   /* off state value */
476         unsigned char power:1;                  /* block power status */
477         unsigned char invert:1;                 /* invert the power bit */
478         unsigned char active:1;                 /* active stream on DAC, ADC's */
479         unsigned char connected:1;              /* connected codec pin */
480         unsigned char new:1;                    /* cnew complete */
481         unsigned char ext:1;                    /* has external widgets */
482         unsigned char force:1;                  /* force state */
483         unsigned char ignore_suspend:1;         /* kept enabled over suspend */
484         unsigned char new_power:1;              /* power from this run */
485         unsigned char power_checked:1;          /* power checked this run */
486         int subseq;                             /* sort within widget type */
487
488         int (*power_check)(struct snd_soc_dapm_widget *w);
489
490         /* external events */
491         unsigned short event_flags;             /* flags to specify event types */
492         int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
493
494         /* kcontrols that relate to this widget */
495         int num_kcontrols;
496         const struct snd_kcontrol_new *kcontrol_news;
497         struct snd_kcontrol **kcontrols;
498
499         /* widget input and outputs */
500         struct list_head sources;
501         struct list_head sinks;
502
503         /* used during DAPM updates */
504         struct list_head power_list;
505         struct list_head dirty;
506         int inputs;
507         int outputs;
508 };
509
510 struct snd_soc_dapm_update {
511         struct snd_soc_dapm_widget *widget;
512         struct snd_kcontrol *kcontrol;
513         int reg;
514         int mask;
515         int val;
516 };
517
518 /* DAPM context */
519 struct snd_soc_dapm_context {
520         int n_widgets; /* number of widgets in this context */
521         enum snd_soc_bias_level bias_level;
522         enum snd_soc_bias_level suspend_bias_level;
523         struct delayed_work delayed_work;
524         unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
525
526         struct snd_soc_dapm_update *update;
527
528         void (*seq_notifier)(struct snd_soc_dapm_context *,
529                              enum snd_soc_dapm_type, int);
530
531         struct device *dev; /* from parent - for debug */
532         struct snd_soc_codec *codec; /* parent codec */
533         struct snd_soc_platform *platform; /* parent platform */
534         struct snd_soc_card *card; /* parent card */
535
536         /* used during DAPM updates */
537         enum snd_soc_bias_level target_bias_level;
538         struct list_head list;
539
540         int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
541
542 #ifdef CONFIG_DEBUG_FS
543         struct dentry *debugfs_dapm;
544 #endif
545 };
546
547 /* A list of widgets associated with an object, typically a snd_kcontrol */
548 struct snd_soc_dapm_widget_list {
549         int num_widgets;
550         struct snd_soc_dapm_widget *widgets[0];
551 };
552
553 struct snd_soc_dapm_stats {
554         int power_checks;
555         int path_checks;
556         int neighbour_checks;
557 };
558
559 #endif