ASoC: s/w->kcontrols/w->kcontrol_news/g
[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_INPUT(wname) \
47 {       .id = snd_soc_dapm_input, .name = wname, .kcontrol_news = NULL, \
48         .num_kcontrols = 0, .reg = SND_SOC_NOPM }
49 #define SND_SOC_DAPM_OUTPUT(wname) \
50 {       .id = snd_soc_dapm_output, .name = wname, .kcontrol_news = NULL, \
51         .num_kcontrols = 0, .reg = SND_SOC_NOPM }
52 #define SND_SOC_DAPM_MIC(wname, wevent) \
53 {       .id = snd_soc_dapm_mic, .name = wname, .kcontrol_news = NULL, \
54         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
55         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
56 #define SND_SOC_DAPM_HP(wname, wevent) \
57 {       .id = snd_soc_dapm_hp, .name = wname, .kcontrol_news = NULL, \
58         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
59         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
60 #define SND_SOC_DAPM_SPK(wname, wevent) \
61 {       .id = snd_soc_dapm_spk, .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_LINE(wname, wevent) \
65 {       .id = snd_soc_dapm_line, .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
69 /* path domain */
70 #define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\
71          wcontrols, wncontrols) \
72 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
73         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
74 #define SND_SOC_DAPM_OUT_DRV(wname, wreg, wshift, winvert,\
75          wcontrols, wncontrols) \
76 {       .id = snd_soc_dapm_out_drv, .name = wname, .reg = wreg, .shift = wshift, \
77         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
78 #define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
79          wcontrols, wncontrols)\
80 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
81         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
82 #define SND_SOC_DAPM_MIXER_NAMED_CTL(wname, wreg, wshift, winvert, \
83          wcontrols, wncontrols)\
84 {       .id = snd_soc_dapm_mixer_named_ctl, .name = wname, .reg = wreg, \
85         .shift = wshift, .invert = winvert, .kcontrol_news = wcontrols, \
86         .num_kcontrols = wncontrols}
87 #define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
88 {       .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
89         .invert = winvert, .kcontrol_news = NULL, .num_kcontrols = 0}
90 #define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
91 {       .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
92         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1}
93 #define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
94 {       .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
95         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1}
96 #define SND_SOC_DAPM_VIRT_MUX(wname, wreg, wshift, winvert, wcontrols) \
97 {       .id = snd_soc_dapm_virt_mux, .name = wname, .reg = wreg, .shift = wshift, \
98         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1}
99 #define SND_SOC_DAPM_VALUE_MUX(wname, wreg, wshift, winvert, wcontrols) \
100 {       .id = snd_soc_dapm_value_mux, .name = wname, .reg = wreg, \
101         .shift = wshift, .invert = winvert, .kcontrol_news = wcontrols, \
102         .num_kcontrols = 1}
103
104 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
105 #define SOC_PGA_ARRAY(wname, wreg, wshift, winvert,\
106          wcontrols) \
107 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
108         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
109 #define SOC_MIXER_ARRAY(wname, wreg, wshift, winvert, \
110          wcontrols)\
111 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
112         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
113 #define SOC_MIXER_NAMED_CTL_ARRAY(wname, wreg, wshift, winvert, \
114          wcontrols)\
115 {       .id = snd_soc_dapm_mixer_named_ctl, .name = wname, .reg = wreg, \
116         .shift = wshift, .invert = winvert, .kcontrol_news = wcontrols, \
117         .num_kcontrols = ARRAY_SIZE(wcontrols)}
118
119 /* path domain with event - event handler must return 0 for success */
120 #define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \
121         wncontrols, wevent, wflags) \
122 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
123         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
124         .event = wevent, .event_flags = wflags}
125 #define SND_SOC_DAPM_OUT_DRV_E(wname, wreg, wshift, winvert, wcontrols, \
126         wncontrols, wevent, wflags) \
127 {       .id = snd_soc_dapm_out_drv, .name = wname, .reg = wreg, .shift = wshift, \
128         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
129         .event = wevent, .event_flags = wflags}
130 #define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \
131         wncontrols, wevent, wflags) \
132 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
133         .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
134         .event = wevent, .event_flags = wflags}
135 #define SND_SOC_DAPM_MIXER_NAMED_CTL_E(wname, wreg, wshift, winvert, \
136         wcontrols, wncontrols, wevent, wflags) \
137 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
138         .invert = winvert, .kcontrol_news = wcontrols, \
139         .num_kcontrols = wncontrols, .event = wevent, .event_flags = wflags}
140 #define SND_SOC_DAPM_MICBIAS_E(wname, wreg, wshift, winvert, wevent, wflags) \
141 {       .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
142         .invert = winvert, .kcontrol_news = NULL, .num_kcontrols = 0, \
143         .event = wevent, .event_flags = wflags}
144 #define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
145         wevent, wflags) \
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, \
150         wevent, wflags) \
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, \
155         wevent, wflags) \
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}
159
160 /* additional sequencing control within an event type */
161 #define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \
162         wevent, wflags) \
163 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
164         .invert = winvert, .event = wevent, .event_flags = wflags, \
165         .subseq = wsubseq}
166 #define SND_SOC_DAPM_SUPPLY_S(wname, wsubseq, wreg, wshift, winvert, wevent, \
167         wflags) \
168 {       .id = snd_soc_dapm_supply, .name = wname, .reg = wreg,  \
169         .shift = wshift, .invert = winvert, .event = wevent, \
170         .event_flags = wflags, .subseq = wsubseq}
171
172 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
173 #define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
174         wevent, wflags) \
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, \
179         wevent, wflags) \
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}
188
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}
198
199 /* stream domain */
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, \
204                               wevent, wflags)                           \
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, \
212                              wevent, wflags)                            \
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, \
220                            wevent, wflags)                              \
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, \
228                            wevent, wflags)                              \
229 {       .id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
230         .shift = wshift, .invert = winvert, \
231         .event = wevent, .event_flags = wflags}
232
233 /* generic widgets */
234 #define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
235 {       .id = wid, .name = wname, .kcontrol_news = NULL, .num_kcontrols = 0, \
236         .reg = -((wreg) + 1), .shift = wshift, .mask = wmask, \
237         .on_val = won_val, .off_val = woff_val, .event = dapm_reg_event, \
238         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
239 #define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \
240 {       .id = snd_soc_dapm_supply, .name = wname, .reg = wreg,  \
241         .shift = wshift, .invert = winvert, .event = wevent, \
242         .event_flags = wflags}
243
244 /* dapm kcontrol types */
245 #define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
246 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
247         .info = snd_soc_info_volsw, \
248         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
249         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
250 #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
251 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
252         .info = snd_soc_info_volsw, \
253         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
254         .tlv.p = (tlv_array), \
255         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
256         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
257 #define SOC_DAPM_ENUM(xname, xenum) \
258 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
259         .info = snd_soc_info_enum_double, \
260         .get = snd_soc_dapm_get_enum_double, \
261         .put = snd_soc_dapm_put_enum_double, \
262         .private_value = (unsigned long)&xenum }
263 #define SOC_DAPM_ENUM_VIRT(xname, xenum)                    \
264 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
265         .info = snd_soc_info_enum_double, \
266         .get = snd_soc_dapm_get_enum_virt, \
267         .put = snd_soc_dapm_put_enum_virt, \
268         .private_value = (unsigned long)&xenum }
269 #define SOC_DAPM_VALUE_ENUM(xname, xenum) \
270 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
271         .info = snd_soc_info_enum_double, \
272         .get = snd_soc_dapm_get_value_enum_double, \
273         .put = snd_soc_dapm_put_value_enum_double, \
274         .private_value = (unsigned long)&xenum }
275 #define SOC_DAPM_PIN_SWITCH(xname) \
276 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
277         .info = snd_soc_dapm_info_pin_switch, \
278         .get = snd_soc_dapm_get_pin_switch, \
279         .put = snd_soc_dapm_put_pin_switch, \
280         .private_value = (unsigned long)xname }
281
282 /* dapm stream operations */
283 #define SND_SOC_DAPM_STREAM_NOP                 0x0
284 #define SND_SOC_DAPM_STREAM_START               0x1
285 #define SND_SOC_DAPM_STREAM_STOP                0x2
286 #define SND_SOC_DAPM_STREAM_SUSPEND             0x4
287 #define SND_SOC_DAPM_STREAM_RESUME              0x8
288 #define SND_SOC_DAPM_STREAM_PAUSE_PUSH  0x10
289 #define SND_SOC_DAPM_STREAM_PAUSE_RELEASE       0x20
290
291 /* dapm event types */
292 #define SND_SOC_DAPM_PRE_PMU    0x1     /* before widget power up */
293 #define SND_SOC_DAPM_POST_PMU   0x2             /* after widget power up */
294 #define SND_SOC_DAPM_PRE_PMD    0x4     /* before widget power down */
295 #define SND_SOC_DAPM_POST_PMD   0x8             /* after widget power down */
296 #define SND_SOC_DAPM_PRE_REG    0x10    /* before audio path setup */
297 #define SND_SOC_DAPM_POST_REG   0x20    /* after audio path setup */
298 #define SND_SOC_DAPM_PRE_POST_PMD \
299                                 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
300
301 /* convenience event type detection */
302 #define SND_SOC_DAPM_EVENT_ON(e)        \
303         (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
304 #define SND_SOC_DAPM_EVENT_OFF(e)       \
305         (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
306
307 struct snd_soc_dapm_widget;
308 enum snd_soc_dapm_type;
309 struct snd_soc_dapm_path;
310 struct snd_soc_dapm_pin;
311 struct snd_soc_dapm_route;
312 struct snd_soc_dapm_context;
313
314 int dapm_reg_event(struct snd_soc_dapm_widget *w,
315                    struct snd_kcontrol *kcontrol, int event);
316
317 /* dapm controls */
318 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
319         struct snd_ctl_elem_value *ucontrol);
320 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
321         struct snd_ctl_elem_value *ucontrol);
322 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
323         struct snd_ctl_elem_value *ucontrol);
324 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
325         struct snd_ctl_elem_value *ucontrol);
326 int snd_soc_dapm_get_enum_virt(struct snd_kcontrol *kcontrol,
327         struct snd_ctl_elem_value *ucontrol);
328 int snd_soc_dapm_put_enum_virt(struct snd_kcontrol *kcontrol,
329         struct snd_ctl_elem_value *ucontrol);
330 int snd_soc_dapm_get_value_enum_double(struct snd_kcontrol *kcontrol,
331         struct snd_ctl_elem_value *ucontrol);
332 int snd_soc_dapm_put_value_enum_double(struct snd_kcontrol *kcontrol,
333         struct snd_ctl_elem_value *ucontrol);
334 int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
335         struct snd_ctl_elem_info *uinfo);
336 int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
337         struct snd_ctl_elem_value *uncontrol);
338 int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
339         struct snd_ctl_elem_value *uncontrol);
340 int snd_soc_dapm_new_control(struct snd_soc_dapm_context *dapm,
341         const struct snd_soc_dapm_widget *widget);
342 int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
343         const struct snd_soc_dapm_widget *widget,
344         int num);
345
346 /* dapm path setup */
347 int snd_soc_dapm_new_widgets(struct snd_soc_dapm_context *dapm);
348 void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
349 int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
350                             const struct snd_soc_dapm_route *route, int num);
351
352 /* dapm events */
353 int snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd,
354         const char *stream, int event);
355 void snd_soc_dapm_shutdown(struct snd_soc_card *card);
356
357 /* dapm sys fs - used by the core */
358 int snd_soc_dapm_sys_add(struct device *dev);
359 void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm,
360                                 struct dentry *parent);
361
362 /* dapm audio pin control and status */
363 int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
364                             const char *pin);
365 int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
366                              const char *pin);
367 int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
368 int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
369                                 const char *pin);
370 int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
371 int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
372                                   const char *pin);
373 int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
374                                 const char *pin);
375
376 /* dapm widget types */
377 enum snd_soc_dapm_type {
378         snd_soc_dapm_input = 0,         /* input pin */
379         snd_soc_dapm_output,            /* output pin */
380         snd_soc_dapm_mux,                       /* selects 1 analog signal from many inputs */
381         snd_soc_dapm_virt_mux,                  /* virtual version of snd_soc_dapm_mux */
382         snd_soc_dapm_value_mux,                 /* selects 1 analog signal from many inputs */
383         snd_soc_dapm_mixer,                     /* mixes several analog signals together */
384         snd_soc_dapm_mixer_named_ctl,           /* mixer with named controls */
385         snd_soc_dapm_pga,                       /* programmable gain/attenuation (volume) */
386         snd_soc_dapm_out_drv,                   /* output driver */
387         snd_soc_dapm_adc,                       /* analog to digital converter */
388         snd_soc_dapm_dac,                       /* digital to analog converter */
389         snd_soc_dapm_micbias,           /* microphone bias (power) */
390         snd_soc_dapm_mic,                       /* microphone */
391         snd_soc_dapm_hp,                        /* headphones */
392         snd_soc_dapm_spk,                       /* speaker */
393         snd_soc_dapm_line,                      /* line input/output */
394         snd_soc_dapm_switch,            /* analog switch */
395         snd_soc_dapm_vmid,                      /* codec bias/vmid - to minimise pops */
396         snd_soc_dapm_pre,                       /* machine specific pre widget - exec first */
397         snd_soc_dapm_post,                      /* machine specific post widget - exec last */
398         snd_soc_dapm_supply,            /* power/clock supply */
399         snd_soc_dapm_aif_in,            /* audio interface input */
400         snd_soc_dapm_aif_out,           /* audio interface output */
401 };
402
403 /*
404  * DAPM audio route definition.
405  *
406  * Defines an audio route originating at source via control and finishing
407  * at sink.
408  */
409 struct snd_soc_dapm_route {
410         const char *sink;
411         const char *control;
412         const char *source;
413
414         /* Note: currently only supported for links where source is a supply */
415         int (*connected)(struct snd_soc_dapm_widget *source,
416                          struct snd_soc_dapm_widget *sink);
417 };
418
419 /* dapm audio path between two widgets */
420 struct snd_soc_dapm_path {
421         char *name;
422         char *long_name;
423
424         /* source (input) and sink (output) widgets */
425         struct snd_soc_dapm_widget *source;
426         struct snd_soc_dapm_widget *sink;
427         struct snd_kcontrol *kcontrol;
428
429         /* status */
430         u32 connect:1;  /* source and sink widgets are connected */
431         u32 walked:1;   /* path has been walked */
432
433         int (*connected)(struct snd_soc_dapm_widget *source,
434                          struct snd_soc_dapm_widget *sink);
435
436         struct list_head list_source;
437         struct list_head list_sink;
438         struct list_head list;
439 };
440
441 /* dapm widget */
442 struct snd_soc_dapm_widget {
443         enum snd_soc_dapm_type id;
444         char *name;             /* widget name */
445         char *sname;    /* stream name */
446         struct snd_soc_codec *codec;
447         struct list_head list;
448         struct snd_soc_dapm_context *dapm;
449
450         /* dapm control */
451         short reg;                                              /* negative reg = no direct dapm */
452         unsigned char shift;                    /* bits to shift */
453         unsigned int saved_value;               /* widget saved value */
454         unsigned int value;                             /* widget current value */
455         unsigned int mask;                      /* non-shifted mask */
456         unsigned int on_val;                    /* on state value */
457         unsigned int off_val;                   /* off state value */
458         unsigned char power:1;                  /* block power status */
459         unsigned char invert:1;                 /* invert the power bit */
460         unsigned char active:1;                 /* active stream on DAC, ADC's */
461         unsigned char connected:1;              /* connected codec pin */
462         unsigned char new:1;                    /* cnew complete */
463         unsigned char ext:1;                    /* has external widgets */
464         unsigned char force:1;                  /* force state */
465         unsigned char ignore_suspend:1;         /* kept enabled over suspend */
466         int subseq;                             /* sort within widget type */
467
468         int (*power_check)(struct snd_soc_dapm_widget *w);
469
470         /* external events */
471         unsigned short event_flags;             /* flags to specify event types */
472         int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
473
474         /* kcontrols that relate to this widget */
475         int num_kcontrols;
476         const struct snd_kcontrol_new *kcontrol_news;
477
478         /* widget input and outputs */
479         struct list_head sources;
480         struct list_head sinks;
481
482         /* used during DAPM updates */
483         struct list_head power_list;
484 };
485
486 struct snd_soc_dapm_update {
487         struct snd_soc_dapm_widget *widget;
488         struct snd_kcontrol *kcontrol;
489         int reg;
490         int mask;
491         int val;
492 };
493
494 /* DAPM context */
495 struct snd_soc_dapm_context {
496         int n_widgets; /* number of widgets in this context */
497         enum snd_soc_bias_level bias_level;
498         enum snd_soc_bias_level suspend_bias_level;
499         struct delayed_work delayed_work;
500         unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
501
502         struct snd_soc_dapm_update *update;
503
504         void (*seq_notifier)(struct snd_soc_dapm_context *,
505                              enum snd_soc_dapm_type, int);
506
507         struct device *dev; /* from parent - for debug */
508         struct snd_soc_codec *codec; /* parent codec */
509         struct snd_soc_card *card; /* parent card */
510
511         /* used during DAPM updates */
512         int dev_power;
513         struct list_head list;
514
515 #ifdef CONFIG_DEBUG_FS
516         struct dentry *debugfs_dapm;
517 #endif
518 };
519
520 #endif