device.h: audit and cleanup users in main include dir
[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/types.h>
17 #include <sound/control.h>
18
19 struct device;
20
21 /* widget has no PM register bit */
22 #define SND_SOC_NOPM    -1
23
24 /*
25  * SoC dynamic audio power management
26  *
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.
39  */
40
41 /* codec domain */
42 #define SND_SOC_DAPM_VMID(wname) \
43 {       .id = snd_soc_dapm_vmid, .name = wname, .kcontrol_news = NULL, \
44         .num_kcontrols = 0}
45
46 /* platform domain */
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}
72
73 /* path domain */
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, \
106         .num_kcontrols = 1}
107
108 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
109 #define SOC_PGA_ARRAY(wname, wreg, wshift, winvert,\
110          wcontrols) \
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, \
114          wcontrols)\
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, \
118          wcontrols)\
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)}
122
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_MICBIAS_E(wname, wreg, wshift, winvert, wevent, wflags) \
145 {       .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
146         .invert = winvert, .kcontrol_news = NULL, .num_kcontrols = 0, \
147         .event = wevent, .event_flags = wflags}
148 #define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
149         wevent, wflags) \
150 {       .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
151         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1, \
152         .event = wevent, .event_flags = wflags}
153 #define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
154         wevent, wflags) \
155 {       .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
156         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1, \
157         .event = wevent, .event_flags = wflags}
158 #define SND_SOC_DAPM_VIRT_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
159         wevent, wflags) \
160 {       .id = snd_soc_dapm_virt_mux, .name = wname, .reg = wreg, .shift = wshift, \
161         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1, \
162         .event = wevent, .event_flags = wflags}
163
164 /* additional sequencing control within an event type */
165 #define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \
166         wevent, wflags) \
167 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
168         .invert = winvert, .event = wevent, .event_flags = wflags, \
169         .subseq = wsubseq}
170 #define SND_SOC_DAPM_SUPPLY_S(wname, wsubseq, wreg, wshift, winvert, wevent, \
171         wflags) \
172 {       .id = snd_soc_dapm_supply, .name = wname, .reg = wreg,  \
173         .shift = wshift, .invert = winvert, .event = wevent, \
174         .event_flags = wflags, .subseq = wsubseq}
175
176 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
177 #define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
178         wevent, wflags) \
179 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
180         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
181         .event = wevent, .event_flags = wflags}
182 #define SOC_MIXER_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
183         wevent, wflags) \
184 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
185         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
186         .event = wevent, .event_flags = wflags}
187 #define SOC_MIXER_NAMED_CTL_E_ARRAY(wname, wreg, wshift, winvert, \
188         wcontrols, wevent, wflags) \
189 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
190         .invert = winvert, .kcontrol_news = wcontrols, \
191         .num_kcontrols = ARRAY_SIZE(wcontrols), .event = wevent, .event_flags = wflags}
192
193 /* events that are pre and post DAPM */
194 #define SND_SOC_DAPM_PRE(wname, wevent) \
195 {       .id = snd_soc_dapm_pre, .name = wname, .kcontrol_news = NULL, \
196         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
197         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
198 #define SND_SOC_DAPM_POST(wname, wevent) \
199 {       .id = snd_soc_dapm_post, .name = wname, .kcontrol_news = NULL, \
200         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
201         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
202
203 /* stream domain */
204 #define SND_SOC_DAPM_AIF_IN(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 #define SND_SOC_DAPM_AIF_IN_E(wname, stname, wslot, wreg, wshift, winvert, \
208                               wevent, wflags)                           \
209 {       .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
210         .reg = wreg, .shift = wshift, .invert = winvert, \
211         .event = wevent, .event_flags = wflags }
212 #define SND_SOC_DAPM_AIF_OUT(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 #define SND_SOC_DAPM_AIF_OUT_E(wname, stname, wslot, wreg, wshift, winvert, \
216                              wevent, wflags)                            \
217 {       .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
218         .reg = wreg, .shift = wshift, .invert = winvert, \
219         .event = wevent, .event_flags = wflags }
220 #define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
221 {       .id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
222         .shift = wshift, .invert = winvert}
223 #define SND_SOC_DAPM_DAC_E(wname, stname, wreg, wshift, winvert, \
224                            wevent, wflags)                              \
225 {       .id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
226         .shift = wshift, .invert = winvert, \
227         .event = wevent, .event_flags = wflags}
228 #define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
229 {       .id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
230         .shift = wshift, .invert = winvert}
231 #define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \
232                            wevent, wflags)                              \
233 {       .id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
234         .shift = wshift, .invert = winvert, \
235         .event = wevent, .event_flags = wflags}
236
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
248 /* dapm kcontrol types */
249 #define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
250 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
251         .info = snd_soc_info_volsw, \
252         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
253         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
254 #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
255 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
256         .info = snd_soc_info_volsw, \
257         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
258         .tlv.p = (tlv_array), \
259         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
260         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
261 #define SOC_DAPM_ENUM(xname, xenum) \
262 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
263         .info = snd_soc_info_enum_double, \
264         .get = snd_soc_dapm_get_enum_double, \
265         .put = snd_soc_dapm_put_enum_double, \
266         .private_value = (unsigned long)&xenum }
267 #define SOC_DAPM_ENUM_VIRT(xname, xenum)                    \
268 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
269         .info = snd_soc_info_enum_double, \
270         .get = snd_soc_dapm_get_enum_virt, \
271         .put = snd_soc_dapm_put_enum_virt, \
272         .private_value = (unsigned long)&xenum }
273 #define SOC_DAPM_ENUM_EXT(xname, xenum, xget, xput) \
274 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
275         .info = snd_soc_info_enum_double, \
276         .get = xget, \
277         .put = xput, \
278         .private_value = (unsigned long)&xenum }
279 #define SOC_DAPM_VALUE_ENUM(xname, xenum) \
280 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
281         .info = snd_soc_info_enum_double, \
282         .get = snd_soc_dapm_get_value_enum_double, \
283         .put = snd_soc_dapm_put_value_enum_double, \
284         .private_value = (unsigned long)&xenum }
285 #define SOC_DAPM_PIN_SWITCH(xname) \
286 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
287         .info = snd_soc_dapm_info_pin_switch, \
288         .get = snd_soc_dapm_get_pin_switch, \
289         .put = snd_soc_dapm_put_pin_switch, \
290         .private_value = (unsigned long)xname }
291
292 /* dapm stream operations */
293 #define SND_SOC_DAPM_STREAM_NOP                 0x0
294 #define SND_SOC_DAPM_STREAM_START               0x1
295 #define SND_SOC_DAPM_STREAM_STOP                0x2
296 #define SND_SOC_DAPM_STREAM_SUSPEND             0x4
297 #define SND_SOC_DAPM_STREAM_RESUME              0x8
298 #define SND_SOC_DAPM_STREAM_PAUSE_PUSH  0x10
299 #define SND_SOC_DAPM_STREAM_PAUSE_RELEASE       0x20
300
301 /* dapm event types */
302 #define SND_SOC_DAPM_PRE_PMU    0x1     /* before widget power up */
303 #define SND_SOC_DAPM_POST_PMU   0x2             /* after widget power up */
304 #define SND_SOC_DAPM_PRE_PMD    0x4     /* before widget power down */
305 #define SND_SOC_DAPM_POST_PMD   0x8             /* after widget power down */
306 #define SND_SOC_DAPM_PRE_REG    0x10    /* before audio path setup */
307 #define SND_SOC_DAPM_POST_REG   0x20    /* after audio path setup */
308 #define SND_SOC_DAPM_PRE_POST_PMD \
309                                 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
310
311 /* convenience event type detection */
312 #define SND_SOC_DAPM_EVENT_ON(e)        \
313         (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
314 #define SND_SOC_DAPM_EVENT_OFF(e)       \
315         (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
316
317 struct snd_soc_dapm_widget;
318 enum snd_soc_dapm_type;
319 struct snd_soc_dapm_path;
320 struct snd_soc_dapm_pin;
321 struct snd_soc_dapm_route;
322 struct snd_soc_dapm_context;
323
324 int dapm_reg_event(struct snd_soc_dapm_widget *w,
325                    struct snd_kcontrol *kcontrol, int event);
326
327 /* dapm controls */
328 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
329         struct snd_ctl_elem_value *ucontrol);
330 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
331         struct snd_ctl_elem_value *ucontrol);
332 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
333         struct snd_ctl_elem_value *ucontrol);
334 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
335         struct snd_ctl_elem_value *ucontrol);
336 int snd_soc_dapm_get_enum_virt(struct snd_kcontrol *kcontrol,
337         struct snd_ctl_elem_value *ucontrol);
338 int snd_soc_dapm_put_enum_virt(struct snd_kcontrol *kcontrol,
339         struct snd_ctl_elem_value *ucontrol);
340 int snd_soc_dapm_get_value_enum_double(struct snd_kcontrol *kcontrol,
341         struct snd_ctl_elem_value *ucontrol);
342 int snd_soc_dapm_put_value_enum_double(struct snd_kcontrol *kcontrol,
343         struct snd_ctl_elem_value *ucontrol);
344 int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
345         struct snd_ctl_elem_info *uinfo);
346 int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
347         struct snd_ctl_elem_value *uncontrol);
348 int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
349         struct snd_ctl_elem_value *uncontrol);
350 int snd_soc_dapm_new_control(struct snd_soc_dapm_context *dapm,
351         const struct snd_soc_dapm_widget *widget);
352 int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
353         const struct snd_soc_dapm_widget *widget,
354         int num);
355
356 /* dapm path setup */
357 int snd_soc_dapm_new_widgets(struct snd_soc_dapm_context *dapm);
358 void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
359 int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
360                             const struct snd_soc_dapm_route *route, int num);
361 int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm,
362                              const struct snd_soc_dapm_route *route, int num);
363
364 /* dapm events */
365 int snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd,
366         const char *stream, int event);
367 void snd_soc_dapm_shutdown(struct snd_soc_card *card);
368
369 /* dapm sys fs - used by the core */
370 int snd_soc_dapm_sys_add(struct device *dev);
371 void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm,
372                                 struct dentry *parent);
373
374 /* dapm audio pin control and status */
375 int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
376                             const char *pin);
377 int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
378                              const char *pin);
379 int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
380 int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
381                                 const char *pin);
382 int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
383 int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
384                                   const char *pin);
385 int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
386                                 const char *pin);
387 void snd_soc_dapm_auto_nc_codec_pins(struct snd_soc_codec *codec);
388
389 /* Mostly internal - should not normally be used */
390 void dapm_mark_dirty(struct snd_soc_dapm_widget *w, const char *reason);
391
392 /* dapm widget types */
393 enum snd_soc_dapm_type {
394         snd_soc_dapm_input = 0,         /* input pin */
395         snd_soc_dapm_output,            /* output pin */
396         snd_soc_dapm_mux,                       /* selects 1 analog signal from many inputs */
397         snd_soc_dapm_virt_mux,                  /* virtual version of snd_soc_dapm_mux */
398         snd_soc_dapm_value_mux,                 /* selects 1 analog signal from many inputs */
399         snd_soc_dapm_mixer,                     /* mixes several analog signals together */
400         snd_soc_dapm_mixer_named_ctl,           /* mixer with named controls */
401         snd_soc_dapm_pga,                       /* programmable gain/attenuation (volume) */
402         snd_soc_dapm_out_drv,                   /* output driver */
403         snd_soc_dapm_adc,                       /* analog to digital converter */
404         snd_soc_dapm_dac,                       /* digital to analog converter */
405         snd_soc_dapm_micbias,           /* microphone bias (power) */
406         snd_soc_dapm_mic,                       /* microphone */
407         snd_soc_dapm_hp,                        /* headphones */
408         snd_soc_dapm_spk,                       /* speaker */
409         snd_soc_dapm_line,                      /* line input/output */
410         snd_soc_dapm_switch,            /* analog switch */
411         snd_soc_dapm_vmid,                      /* codec bias/vmid - to minimise pops */
412         snd_soc_dapm_pre,                       /* machine specific pre widget - exec first */
413         snd_soc_dapm_post,                      /* machine specific post widget - exec last */
414         snd_soc_dapm_supply,            /* power/clock supply */
415         snd_soc_dapm_aif_in,            /* audio interface input */
416         snd_soc_dapm_aif_out,           /* audio interface output */
417         snd_soc_dapm_siggen,            /* signal generator */
418 };
419
420 /*
421  * DAPM audio route definition.
422  *
423  * Defines an audio route originating at source via control and finishing
424  * at sink.
425  */
426 struct snd_soc_dapm_route {
427         const char *sink;
428         const char *control;
429         const char *source;
430
431         /* Note: currently only supported for links where source is a supply */
432         int (*connected)(struct snd_soc_dapm_widget *source,
433                          struct snd_soc_dapm_widget *sink);
434 };
435
436 /* dapm audio path between two widgets */
437 struct snd_soc_dapm_path {
438         char *name;
439         char *long_name;
440
441         /* source (input) and sink (output) widgets */
442         struct snd_soc_dapm_widget *source;
443         struct snd_soc_dapm_widget *sink;
444         struct snd_kcontrol *kcontrol;
445
446         /* status */
447         u32 connect:1;  /* source and sink widgets are connected */
448         u32 walked:1;   /* path has been walked */
449         u32 weak:1;     /* path ignored for power management */
450
451         int (*connected)(struct snd_soc_dapm_widget *source,
452                          struct snd_soc_dapm_widget *sink);
453
454         struct list_head list_source;
455         struct list_head list_sink;
456         struct list_head list;
457 };
458
459 /* dapm widget */
460 struct snd_soc_dapm_widget {
461         enum snd_soc_dapm_type id;
462         char *name;             /* widget name */
463         char *sname;    /* stream name */
464         struct snd_soc_codec *codec;
465         struct snd_soc_platform *platform;
466         struct list_head list;
467         struct snd_soc_dapm_context *dapm;
468
469         /* dapm control */
470         short reg;                                              /* negative reg = no direct dapm */
471         unsigned char shift;                    /* bits to shift */
472         unsigned int saved_value;               /* widget saved value */
473         unsigned int value;                             /* widget current value */
474         unsigned int mask;                      /* non-shifted mask */
475         unsigned int on_val;                    /* on state value */
476         unsigned int off_val;                   /* off state value */
477         unsigned char power:1;                  /* block power status */
478         unsigned char invert:1;                 /* invert the power bit */
479         unsigned char active:1;                 /* active stream on DAC, ADC's */
480         unsigned char connected:1;              /* connected codec pin */
481         unsigned char new:1;                    /* cnew complete */
482         unsigned char ext:1;                    /* has external widgets */
483         unsigned char force:1;                  /* force state */
484         unsigned char ignore_suspend:1;         /* kept enabled over suspend */
485         unsigned char new_power:1;              /* power from this run */
486         unsigned char power_checked:1;          /* power checked this run */
487         int subseq;                             /* sort within widget type */
488
489         int (*power_check)(struct snd_soc_dapm_widget *w);
490
491         /* external events */
492         unsigned short event_flags;             /* flags to specify event types */
493         int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
494
495         /* kcontrols that relate to this widget */
496         int num_kcontrols;
497         const struct snd_kcontrol_new *kcontrol_news;
498         struct snd_kcontrol **kcontrols;
499
500         /* widget input and outputs */
501         struct list_head sources;
502         struct list_head sinks;
503
504         /* used during DAPM updates */
505         struct list_head power_list;
506         struct list_head dirty;
507         int inputs;
508         int outputs;
509 };
510
511 struct snd_soc_dapm_update {
512         struct snd_soc_dapm_widget *widget;
513         struct snd_kcontrol *kcontrol;
514         int reg;
515         int mask;
516         int val;
517 };
518
519 /* DAPM context */
520 struct snd_soc_dapm_context {
521         int n_widgets; /* number of widgets in this context */
522         enum snd_soc_bias_level bias_level;
523         enum snd_soc_bias_level suspend_bias_level;
524         struct delayed_work delayed_work;
525         unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
526
527         struct snd_soc_dapm_update *update;
528
529         void (*seq_notifier)(struct snd_soc_dapm_context *,
530                              enum snd_soc_dapm_type, int);
531
532         struct device *dev; /* from parent - for debug */
533         struct snd_soc_codec *codec; /* parent codec */
534         struct snd_soc_platform *platform; /* parent platform */
535         struct snd_soc_card *card; /* parent card */
536
537         /* used during DAPM updates */
538         enum snd_soc_bias_level target_bias_level;
539         struct list_head list;
540
541         int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
542
543 #ifdef CONFIG_DEBUG_FS
544         struct dentry *debugfs_dapm;
545 #endif
546 };
547
548 /* A list of widgets associated with an object, typically a snd_kcontrol */
549 struct snd_soc_dapm_widget_list {
550         int num_widgets;
551         struct snd_soc_dapm_widget *widgets[0];
552 };
553
554 struct snd_soc_dapm_stats {
555         int power_checks;
556         int path_checks;
557         int neighbour_checks;
558 };
559
560 #endif