Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / sound / soc-dapm.h
CommitLineData
808db4a4
RP
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
808db4a4
RP
16#include <linux/types.h>
17#include <sound/control.h>
808db4a4 18
313162d0
PG
19struct device;
20
808db4a4
RP
21/* widget has no PM register bit */
22#define SND_SOC_NOPM -1
23
24/*
b7d2a803 25 * SoC dynamic audio power management
808db4a4 26 *
25985edc 27 * We can have up to 4 power domains
28683e0f 28 * 1. Codec domain - VREF, VMID
808db4a4
RP
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) \
82cfecdc 43{ .id = snd_soc_dapm_vmid, .name = wname, .kcontrol_news = NULL, \
808db4a4
RP
44 .num_kcontrols = 0}
45
46/* platform domain */
1ab97c8c
MB
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 }
808db4a4 50#define SND_SOC_DAPM_INPUT(wname) \
82cfecdc 51{ .id = snd_soc_dapm_input, .name = wname, .kcontrol_news = NULL, \
0ca03cd7 52 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
808db4a4 53#define SND_SOC_DAPM_OUTPUT(wname) \
82cfecdc 54{ .id = snd_soc_dapm_output, .name = wname, .kcontrol_news = NULL, \
0ca03cd7 55 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
808db4a4 56#define SND_SOC_DAPM_MIC(wname, wevent) \
82cfecdc 57{ .id = snd_soc_dapm_mic, .name = wname, .kcontrol_news = NULL, \
0ca03cd7 58 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
808db4a4
RP
59 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
60#define SND_SOC_DAPM_HP(wname, wevent) \
82cfecdc 61{ .id = snd_soc_dapm_hp, .name = wname, .kcontrol_news = NULL, \
0ca03cd7 62 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
808db4a4
RP
63 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
64#define SND_SOC_DAPM_SPK(wname, wevent) \
82cfecdc 65{ .id = snd_soc_dapm_spk, .name = wname, .kcontrol_news = NULL, \
0ca03cd7 66 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
808db4a4
RP
67 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
68#define SND_SOC_DAPM_LINE(wname, wevent) \
82cfecdc 69{ .id = snd_soc_dapm_line, .name = wname, .kcontrol_news = NULL, \
0ca03cd7 70 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
808db4a4
RP
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, \
82cfecdc 77 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
d88429a6
OM
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, \
82cfecdc 81 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
808db4a4
RP
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, \
82cfecdc 85 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
ca9c1aae
IM
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, \
82cfecdc 89 .shift = wshift, .invert = winvert, .kcontrol_news = wcontrols, \
ca9c1aae 90 .num_kcontrols = wncontrols}
808db4a4
RP
91#define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
92{ .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
82cfecdc 93 .invert = winvert, .kcontrol_news = NULL, .num_kcontrols = 0}
808db4a4
RP
94#define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
95{ .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
82cfecdc 96 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1}
808db4a4
RP
97#define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
98{ .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
82cfecdc 99 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1}
24ff33ac
DP
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, \
82cfecdc 102 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1}
2e72f8e3
PU
103#define SND_SOC_DAPM_VALUE_MUX(wname, wreg, wshift, winvert, wcontrols) \
104{ .id = snd_soc_dapm_value_mux, .name = wname, .reg = wreg, \
82cfecdc 105 .shift = wshift, .invert = winvert, .kcontrol_news = wcontrols, \
2e72f8e3 106 .num_kcontrols = 1}
808db4a4 107
8484c63f
GL
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, \
82cfecdc 112 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
8484c63f
GL
113#define SOC_MIXER_ARRAY(wname, wreg, wshift, winvert, \
114 wcontrols)\
115{ .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
82cfecdc 116 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
8484c63f
GL
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, \
82cfecdc 120 .shift = wshift, .invert = winvert, .kcontrol_news = wcontrols, \
8484c63f
GL
121 .num_kcontrols = ARRAY_SIZE(wcontrols)}
122
808db4a4
RP
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, \
82cfecdc 127 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
808db4a4 128 .event = wevent, .event_flags = wflags}
d88429a6
OM
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, \
82cfecdc 132 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
d88429a6 133 .event = wevent, .event_flags = wflags}
808db4a4
RP
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, \
82cfecdc 137 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
808db4a4 138 .event = wevent, .event_flags = wflags}
ca9c1aae
IM
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, \
82cfecdc 142 .invert = winvert, .kcontrol_news = wcontrols, \
ca9c1aae 143 .num_kcontrols = wncontrols, .event = wevent, .event_flags = wflags}
808db4a4
RP
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, \
82cfecdc 147 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1, \
808db4a4
RP
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, \
82cfecdc 152 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1, \
808db4a4 153 .event = wevent, .event_flags = wflags}
24ff33ac
DP
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, \
82cfecdc 157 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1, \
24ff33ac 158 .event = wevent, .event_flags = wflags}
808db4a4 159
20e4859d 160/* additional sequencing control within an event type */
3d23c73f
MB
161#define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \
162 wevent, wflags) \
20e4859d 163{ .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
3d23c73f
MB
164 .invert = winvert, .event = wevent, .event_flags = wflags, \
165 .subseq = wsubseq}
20e4859d
MB
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
8484c63f
GL
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, \
82cfecdc 176 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
8484c63f
GL
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, \
82cfecdc 181 .invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
8484c63f
GL
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, \
82cfecdc 186 .invert = winvert, .kcontrol_news = wcontrols, \
8484c63f
GL
187 .num_kcontrols = ARRAY_SIZE(wcontrols), .event = wevent, .event_flags = wflags}
188
808db4a4
RP
189/* events that are pre and post DAPM */
190#define SND_SOC_DAPM_PRE(wname, wevent) \
82cfecdc 191{ .id = snd_soc_dapm_pre, .name = wname, .kcontrol_news = NULL, \
0ca03cd7 192 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
808db4a4
RP
193 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
194#define SND_SOC_DAPM_POST(wname, wevent) \
82cfecdc 195{ .id = snd_soc_dapm_post, .name = wname, .kcontrol_news = NULL, \
0ca03cd7 196 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
808db4a4
RP
197 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
198
199/* stream domain */
010ff262
MB
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 }
ea0d09de
MB
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 }
010ff262
MB
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 }
ea0d09de
MB
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 }
808db4a4
RP
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}
f6d655a6
MB
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}
808db4a4
RP
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}
f6d655a6
MB
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}
d7e7eb91
OL
232#define SND_SOC_DAPM_CLOCK_SUPPLY(wname) \
233{ .id = snd_soc_dapm_clock_supply, .name = wname, \
234 .reg = SND_SOC_NOPM, .event = dapm_clock_event, \
235 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD }
808db4a4 236
246d0a17 237/* generic widgets */
e2be2ccf 238#define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
82cfecdc 239{ .id = wid, .name = wname, .kcontrol_news = NULL, .num_kcontrols = 0, \
e2be2ccf
JN
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}
246d0a17
MB
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}
822b4b8d 247#define SND_SOC_DAPM_REGULATOR_SUPPLY(wname, wdelay, wflags) \
62ea874a
MB
248{ .id = snd_soc_dapm_regulator_supply, .name = wname, \
249 .reg = SND_SOC_NOPM, .shift = wdelay, .event = dapm_regulator_event, \
822b4b8d
MB
250 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD, \
251 .invert = wflags}
e2be2ccf 252
d7e7eb91 253
808db4a4 254/* dapm kcontrol types */
a7a4ac86 255#define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
808db4a4
RP
256{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
257 .info = snd_soc_info_volsw, \
258 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
a7a4ac86 259 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
a7a4ac86
PZ
260#define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
261{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
262 .info = snd_soc_info_volsw, \
263 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
264 .tlv.p = (tlv_array), \
265 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
266 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
808db4a4
RP
267#define SOC_DAPM_ENUM(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_double, \
271 .put = snd_soc_dapm_put_enum_double, \
272 .private_value = (unsigned long)&xenum }
d2b247a8
MB
273#define SOC_DAPM_ENUM_VIRT(xname, xenum) \
274{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
275 .info = snd_soc_info_enum_double, \
276 .get = snd_soc_dapm_get_enum_virt, \
277 .put = snd_soc_dapm_put_enum_virt, \
278 .private_value = (unsigned long)&xenum }
c219c809
LG
279#define SOC_DAPM_ENUM_EXT(xname, xenum, xget, xput) \
280{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
281 .info = snd_soc_info_enum_double, \
282 .get = xget, \
283 .put = xput, \
284 .private_value = (unsigned long)&xenum }
2e72f8e3
PU
285#define SOC_DAPM_VALUE_ENUM(xname, xenum) \
286{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
74155556 287 .info = snd_soc_info_enum_double, \
2e72f8e3
PU
288 .get = snd_soc_dapm_get_value_enum_double, \
289 .put = snd_soc_dapm_put_value_enum_double, \
290 .private_value = (unsigned long)&xenum }
8b37dbd2
MB
291#define SOC_DAPM_PIN_SWITCH(xname) \
292{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
293 .info = snd_soc_dapm_info_pin_switch, \
294 .get = snd_soc_dapm_get_pin_switch, \
295 .put = snd_soc_dapm_put_pin_switch, \
296 .private_value = (unsigned long)xname }
808db4a4
RP
297
298/* dapm stream operations */
299#define SND_SOC_DAPM_STREAM_NOP 0x0
300#define SND_SOC_DAPM_STREAM_START 0x1
301#define SND_SOC_DAPM_STREAM_STOP 0x2
302#define SND_SOC_DAPM_STREAM_SUSPEND 0x4
303#define SND_SOC_DAPM_STREAM_RESUME 0x8
304#define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10
305#define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20
306
307/* dapm event types */
308#define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */
309#define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */
310#define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */
311#define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */
312#define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */
313#define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */
ea762b04 314#define SND_SOC_DAPM_PRE_POST_PMD \
315 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
808db4a4
RP
316
317/* convenience event type detection */
318#define SND_SOC_DAPM_EVENT_ON(e) \
319 (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
320#define SND_SOC_DAPM_EVENT_OFF(e) \
321 (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
322
c05b84d1
MB
323/* regulator widget flags */
324#define SND_SOC_DAPM_REGULATOR_BYPASS 0x1 /* bypass when disabled */
325
808db4a4
RP
326struct snd_soc_dapm_widget;
327enum snd_soc_dapm_type;
328struct snd_soc_dapm_path;
329struct snd_soc_dapm_pin;
105f1c28 330struct snd_soc_dapm_route;
ce6120cc 331struct snd_soc_dapm_context;
a3cc056b 332struct regulator;
ec2e3031 333struct snd_soc_dapm_widget_list;
808db4a4 334
11589418
MB
335int dapm_reg_event(struct snd_soc_dapm_widget *w,
336 struct snd_kcontrol *kcontrol, int event);
62ea874a
MB
337int dapm_regulator_event(struct snd_soc_dapm_widget *w,
338 struct snd_kcontrol *kcontrol, int event);
d7e7eb91
OL
339int dapm_clock_event(struct snd_soc_dapm_widget *w,
340 struct snd_kcontrol *kcontrol, int event);
11589418 341
808db4a4
RP
342/* dapm controls */
343int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
344 struct snd_ctl_elem_value *ucontrol);
345int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
346 struct snd_ctl_elem_value *ucontrol);
347int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
348 struct snd_ctl_elem_value *ucontrol);
349int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
350 struct snd_ctl_elem_value *ucontrol);
d2b247a8
MB
351int snd_soc_dapm_get_enum_virt(struct snd_kcontrol *kcontrol,
352 struct snd_ctl_elem_value *ucontrol);
353int snd_soc_dapm_put_enum_virt(struct snd_kcontrol *kcontrol,
354 struct snd_ctl_elem_value *ucontrol);
2e72f8e3
PU
355int snd_soc_dapm_get_value_enum_double(struct snd_kcontrol *kcontrol,
356 struct snd_ctl_elem_value *ucontrol);
357int snd_soc_dapm_put_value_enum_double(struct snd_kcontrol *kcontrol,
358 struct snd_ctl_elem_value *ucontrol);
8b37dbd2
MB
359int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
360 struct snd_ctl_elem_info *uinfo);
361int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
362 struct snd_ctl_elem_value *uncontrol);
363int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
364 struct snd_ctl_elem_value *uncontrol);
ce6120cc 365int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
4ba1327a
MB
366 const struct snd_soc_dapm_widget *widget,
367 int num);
888df395
MB
368int snd_soc_dapm_new_dai_widgets(struct snd_soc_dapm_context *dapm,
369 struct snd_soc_dai *dai);
370int snd_soc_dapm_link_dai_widgets(struct snd_soc_card *card);
c74184ed
MB
371int snd_soc_dapm_new_pcm(struct snd_soc_card *card,
372 const struct snd_soc_pcm_stream *params,
373 struct snd_soc_dapm_widget *source,
374 struct snd_soc_dapm_widget *sink);
808db4a4
RP
375
376/* dapm path setup */
ce6120cc
LG
377int snd_soc_dapm_new_widgets(struct snd_soc_dapm_context *dapm);
378void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
379int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
105f1c28 380 const struct snd_soc_dapm_route *route, int num);
efcc3c61
MB
381int snd_soc_dapm_del_routes(struct snd_soc_dapm_context *dapm,
382 const struct snd_soc_dapm_route *route, int num);
bf3a9e13
MB
383int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm,
384 const struct snd_soc_dapm_route *route, int num);
808db4a4
RP
385
386/* dapm events */
d9b0951b
LG
387void snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd, int stream,
388 int event);
f0fba2ad 389void snd_soc_dapm_shutdown(struct snd_soc_card *card);
808db4a4 390
40f02cd9
LG
391/* external DAPM widget events */
392int snd_soc_dapm_mixer_update_power(struct snd_soc_dapm_widget *widget,
393 struct snd_kcontrol *kcontrol, int connect);
394int snd_soc_dapm_mux_update_power(struct snd_soc_dapm_widget *widget,
395 struct snd_kcontrol *kcontrol, int mux, struct soc_enum *e);
396
808db4a4
RP
397/* dapm sys fs - used by the core */
398int snd_soc_dapm_sys_add(struct device *dev);
8eecaf62
LPC
399void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm,
400 struct dentry *parent);
808db4a4 401
a5302181 402/* dapm audio pin control and status */
ce6120cc
LG
403int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
404 const char *pin);
405int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
406 const char *pin);
407int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
408int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
409 const char *pin);
410int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
411int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
da34183e 412 const char *pin);
ce6120cc
LG
413int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
414 const char *pin);
1633281b 415void snd_soc_dapm_auto_nc_codec_pins(struct snd_soc_codec *codec);
808db4a4 416
25c77c5f
MB
417/* Mostly internal - should not normally be used */
418void dapm_mark_dirty(struct snd_soc_dapm_widget *w, const char *reason);
e2d32ff6 419void dapm_mark_io_dirty(struct snd_soc_dapm_context *dapm);
25c77c5f 420
ec2e3031
LG
421/* dapm path query */
422int snd_soc_dapm_dai_get_connected_widgets(struct snd_soc_dai *dai, int stream,
423 struct snd_soc_dapm_widget_list **list);
424
808db4a4
RP
425/* dapm widget types */
426enum snd_soc_dapm_type {
427 snd_soc_dapm_input = 0, /* input pin */
428 snd_soc_dapm_output, /* output pin */
429 snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */
24ff33ac 430 snd_soc_dapm_virt_mux, /* virtual version of snd_soc_dapm_mux */
2e72f8e3 431 snd_soc_dapm_value_mux, /* selects 1 analog signal from many inputs */
808db4a4 432 snd_soc_dapm_mixer, /* mixes several analog signals together */
ca9c1aae 433 snd_soc_dapm_mixer_named_ctl, /* mixer with named controls */
808db4a4 434 snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */
d88429a6 435 snd_soc_dapm_out_drv, /* output driver */
808db4a4
RP
436 snd_soc_dapm_adc, /* analog to digital converter */
437 snd_soc_dapm_dac, /* digital to analog converter */
438 snd_soc_dapm_micbias, /* microphone bias (power) */
439 snd_soc_dapm_mic, /* microphone */
440 snd_soc_dapm_hp, /* headphones */
441 snd_soc_dapm_spk, /* speaker */
442 snd_soc_dapm_line, /* line input/output */
443 snd_soc_dapm_switch, /* analog switch */
444 snd_soc_dapm_vmid, /* codec bias/vmid - to minimise pops */
445 snd_soc_dapm_pre, /* machine specific pre widget - exec first */
446 snd_soc_dapm_post, /* machine specific post widget - exec last */
246d0a17 447 snd_soc_dapm_supply, /* power/clock supply */
62ea874a 448 snd_soc_dapm_regulator_supply, /* external regulator */
d7e7eb91 449 snd_soc_dapm_clock_supply, /* external clock */
010ff262
MB
450 snd_soc_dapm_aif_in, /* audio interface input */
451 snd_soc_dapm_aif_out, /* audio interface output */
1ab97c8c 452 snd_soc_dapm_siggen, /* signal generator */
4616274d
MB
453 snd_soc_dapm_dai_in, /* link to DAI structure */
454 snd_soc_dapm_dai_out,
c74184ed 455 snd_soc_dapm_dai_link, /* link between two DAI structures */
808db4a4
RP
456};
457
a73fb2df 458enum snd_soc_dapm_subclass {
3cd04343
LG
459 SND_SOC_DAPM_CLASS_INIT = 0,
460 SND_SOC_DAPM_CLASS_RUNTIME = 1,
a73fb2df
LG
461};
462
105f1c28
MB
463/*
464 * DAPM audio route definition.
465 *
466 * Defines an audio route originating at source via control and finishing
467 * at sink.
468 */
469struct snd_soc_dapm_route {
470 const char *sink;
471 const char *control;
472 const char *source;
215edda3
MB
473
474 /* Note: currently only supported for links where source is a supply */
475 int (*connected)(struct snd_soc_dapm_widget *source,
476 struct snd_soc_dapm_widget *sink);
105f1c28
MB
477};
478
808db4a4
RP
479/* dapm audio path between two widgets */
480struct snd_soc_dapm_path {
3056557f
MB
481 const char *name;
482 const char *long_name;
808db4a4
RP
483
484 /* source (input) and sink (output) widgets */
485 struct snd_soc_dapm_widget *source;
486 struct snd_soc_dapm_widget *sink;
487 struct snd_kcontrol *kcontrol;
488
489 /* status */
490 u32 connect:1; /* source and sink widgets are connected */
491 u32 walked:1; /* path has been walked */
8af294b4 492 u32 walking:1; /* path is in the process of being walked */
169d5a83 493 u32 weak:1; /* path ignored for power management */
808db4a4 494
215edda3
MB
495 int (*connected)(struct snd_soc_dapm_widget *source,
496 struct snd_soc_dapm_widget *sink);
497
808db4a4
RP
498 struct list_head list_source;
499 struct list_head list_sink;
500 struct list_head list;
501};
502
503/* dapm widget */
504struct snd_soc_dapm_widget {
505 enum snd_soc_dapm_type id;
3056557f
MB
506 const char *name; /* widget name */
507 const char *sname; /* stream name */
808db4a4 508 struct snd_soc_codec *codec;
b7950641 509 struct snd_soc_platform *platform;
808db4a4 510 struct list_head list;
ce6120cc 511 struct snd_soc_dapm_context *dapm;
808db4a4 512
62ea874a 513 void *priv; /* widget specific data */
a3cc056b 514 struct regulator *regulator; /* attached regulator */
c74184ed 515 const struct snd_soc_pcm_stream *params; /* params for dai links */
62ea874a 516
808db4a4 517 /* dapm control */
41b5b3bd 518 int reg; /* negative reg = no direct dapm */
808db4a4 519 unsigned char shift; /* bits to shift */
808db4a4 520 unsigned int value; /* widget current value */
e2be2ccf
JN
521 unsigned int mask; /* non-shifted mask */
522 unsigned int on_val; /* on state value */
523 unsigned int off_val; /* off state value */
808db4a4
RP
524 unsigned char power:1; /* block power status */
525 unsigned char invert:1; /* invert the power bit */
526 unsigned char active:1; /* active stream on DAC, ADC's */
527 unsigned char connected:1; /* connected codec pin */
528 unsigned char new:1; /* cnew complete */
529 unsigned char ext:1; /* has external widgets */
da34183e 530 unsigned char force:1; /* force state */
1547aba9 531 unsigned char ignore_suspend:1; /* kept enabled over suspend */
9b8a83b2
MB
532 unsigned char new_power:1; /* power from this run */
533 unsigned char power_checked:1; /* power checked this run */
20e4859d 534 int subseq; /* sort within widget type */
808db4a4 535
b75576d7
MB
536 int (*power_check)(struct snd_soc_dapm_widget *w);
537
808db4a4
RP
538 /* external events */
539 unsigned short event_flags; /* flags to specify event types */
9af6d956 540 int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
808db4a4
RP
541
542 /* kcontrols that relate to this widget */
543 int num_kcontrols;
82cfecdc 544 const struct snd_kcontrol_new *kcontrol_news;
fad59888 545 struct snd_kcontrol **kcontrols;
808db4a4
RP
546
547 /* widget input and outputs */
548 struct list_head sources;
549 struct list_head sinks;
6d3ddc81
MB
550
551 /* used during DAPM updates */
552 struct list_head power_list;
db432b41 553 struct list_head dirty;
024dc078
MB
554 int inputs;
555 int outputs;
d7e7eb91
OL
556
557 struct clk *clk;
808db4a4
RP
558};
559
97404f2e
MB
560struct snd_soc_dapm_update {
561 struct snd_soc_dapm_widget *widget;
562 struct snd_kcontrol *kcontrol;
563 int reg;
564 int mask;
565 int val;
566};
567
ce6120cc
LG
568/* DAPM context */
569struct snd_soc_dapm_context {
ce6120cc
LG
570 enum snd_soc_bias_level bias_level;
571 enum snd_soc_bias_level suspend_bias_level;
572 struct delayed_work delayed_work;
573 unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
574
97404f2e
MB
575 struct snd_soc_dapm_update *update;
576
474b62d6 577 void (*seq_notifier)(struct snd_soc_dapm_context *,
f85a9e0d 578 enum snd_soc_dapm_type, int);
474b62d6 579
ce6120cc
LG
580 struct device *dev; /* from parent - for debug */
581 struct snd_soc_codec *codec; /* parent codec */
b7950641 582 struct snd_soc_platform *platform; /* parent platform */
3a45b867 583 struct snd_soc_card *card; /* parent card */
7be31be8
JN
584
585 /* used during DAPM updates */
56fba41f 586 enum snd_soc_bias_level target_bias_level;
7be31be8
JN
587 struct list_head list;
588
64a648c2
LG
589 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
590
ce6120cc
LG
591#ifdef CONFIG_DEBUG_FS
592 struct dentry *debugfs_dapm;
593#endif
594};
595
fafd2176
SW
596/* A list of widgets associated with an object, typically a snd_kcontrol */
597struct snd_soc_dapm_widget_list {
598 int num_widgets;
599 struct snd_soc_dapm_widget *widgets[0];
600};
601
de02d078
MB
602struct snd_soc_dapm_stats {
603 int power_checks;
604 int path_checks;
e56235e0 605 int neighbour_checks;
de02d078
MB
606};
607
808db4a4 608#endif