xref: /openbmc/linux/include/sound/soc-dapm.h (revision ee89bd6b)
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_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 #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 }
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 #define SND_SOC_DAPM_REGULATOR_SUPPLY(wname, wdelay, wflags)	    \
248 {	.id = snd_soc_dapm_regulator_supply, .name = wname, \
249 	.reg = SND_SOC_NOPM, .shift = wdelay, .event = dapm_regulator_event, \
250 	.event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD, \
251 	.invert = wflags}
252 
253 
254 /* dapm kcontrol types */
255 #define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
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, \
259 	.private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
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) }
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 }
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 }
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 }
285 #define SOC_DAPM_VALUE_ENUM(xname, xenum) \
286 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
287 	.info = snd_soc_info_enum_double, \
288 	.get = snd_soc_dapm_get_value_enum_double, \
289 	.put = snd_soc_dapm_put_value_enum_double, \
290 	.private_value = (unsigned long)&xenum }
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 }
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 */
314 #define SND_SOC_DAPM_PRE_POST_PMD \
315 				(SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
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 
323 /* regulator widget flags */
324 #define SND_SOC_DAPM_REGULATOR_BYPASS     0x1     /* bypass when disabled */
325 
326 struct snd_soc_dapm_widget;
327 enum snd_soc_dapm_type;
328 struct snd_soc_dapm_path;
329 struct snd_soc_dapm_pin;
330 struct snd_soc_dapm_route;
331 struct snd_soc_dapm_context;
332 struct regulator;
333 struct snd_soc_dapm_widget_list;
334 
335 int dapm_reg_event(struct snd_soc_dapm_widget *w,
336 		   struct snd_kcontrol *kcontrol, int event);
337 int dapm_regulator_event(struct snd_soc_dapm_widget *w,
338 			 struct snd_kcontrol *kcontrol, int event);
339 int dapm_clock_event(struct snd_soc_dapm_widget *w,
340 			 struct snd_kcontrol *kcontrol, int event);
341 
342 /* dapm controls */
343 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
344 	struct snd_ctl_elem_value *ucontrol);
345 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
346 	struct snd_ctl_elem_value *ucontrol);
347 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
348 	struct snd_ctl_elem_value *ucontrol);
349 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
350 	struct snd_ctl_elem_value *ucontrol);
351 int snd_soc_dapm_get_enum_virt(struct snd_kcontrol *kcontrol,
352 	struct snd_ctl_elem_value *ucontrol);
353 int snd_soc_dapm_put_enum_virt(struct snd_kcontrol *kcontrol,
354 	struct snd_ctl_elem_value *ucontrol);
355 int snd_soc_dapm_get_value_enum_double(struct snd_kcontrol *kcontrol,
356 	struct snd_ctl_elem_value *ucontrol);
357 int snd_soc_dapm_put_value_enum_double(struct snd_kcontrol *kcontrol,
358 	struct snd_ctl_elem_value *ucontrol);
359 int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
360 	struct snd_ctl_elem_info *uinfo);
361 int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
362 	struct snd_ctl_elem_value *uncontrol);
363 int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
364 	struct snd_ctl_elem_value *uncontrol);
365 int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
366 	const struct snd_soc_dapm_widget *widget,
367 	int num);
368 int snd_soc_dapm_new_dai_widgets(struct snd_soc_dapm_context *dapm,
369 				 struct snd_soc_dai *dai);
370 int snd_soc_dapm_link_dai_widgets(struct snd_soc_card *card);
371 int 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);
375 
376 /* dapm path setup */
377 int snd_soc_dapm_new_widgets(struct snd_soc_dapm_context *dapm);
378 void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
379 int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
380 			    const struct snd_soc_dapm_route *route, int num);
381 int snd_soc_dapm_del_routes(struct snd_soc_dapm_context *dapm,
382 			    const struct snd_soc_dapm_route *route, int num);
383 int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm,
384 			     const struct snd_soc_dapm_route *route, int num);
385 
386 /* dapm events */
387 void snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd, int stream,
388 	int event);
389 void snd_soc_dapm_shutdown(struct snd_soc_card *card);
390 
391 /* external DAPM widget events */
392 int snd_soc_dapm_mixer_update_power(struct snd_soc_dapm_widget *widget,
393 		struct snd_kcontrol *kcontrol, int connect);
394 int snd_soc_dapm_mux_update_power(struct snd_soc_dapm_widget *widget,
395 				 struct snd_kcontrol *kcontrol, int mux, struct soc_enum *e);
396 
397 /* dapm sys fs - used by the core */
398 int snd_soc_dapm_sys_add(struct device *dev);
399 void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm,
400 				struct dentry *parent);
401 
402 /* dapm audio pin control and status */
403 int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
404 			    const char *pin);
405 int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
406 			     const char *pin);
407 int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
408 int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
409 				const char *pin);
410 int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
411 int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
412 				  const char *pin);
413 int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
414 				const char *pin);
415 void snd_soc_dapm_auto_nc_codec_pins(struct snd_soc_codec *codec);
416 
417 /* Mostly internal - should not normally be used */
418 void dapm_mark_dirty(struct snd_soc_dapm_widget *w, const char *reason);
419 void dapm_mark_io_dirty(struct snd_soc_dapm_context *dapm);
420 
421 /* dapm path query */
422 int snd_soc_dapm_dai_get_connected_widgets(struct snd_soc_dai *dai, int stream,
423 	struct snd_soc_dapm_widget_list **list);
424 
425 /* dapm widget types */
426 enum 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 */
430 	snd_soc_dapm_virt_mux,			/* virtual version of snd_soc_dapm_mux */
431 	snd_soc_dapm_value_mux,			/* selects 1 analog signal from many inputs */
432 	snd_soc_dapm_mixer,			/* mixes several analog signals together */
433 	snd_soc_dapm_mixer_named_ctl,		/* mixer with named controls */
434 	snd_soc_dapm_pga,			/* programmable gain/attenuation (volume) */
435 	snd_soc_dapm_out_drv,			/* output driver */
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 */
447 	snd_soc_dapm_supply,		/* power/clock supply */
448 	snd_soc_dapm_regulator_supply,	/* external regulator */
449 	snd_soc_dapm_clock_supply,	/* external clock */
450 	snd_soc_dapm_aif_in,		/* audio interface input */
451 	snd_soc_dapm_aif_out,		/* audio interface output */
452 	snd_soc_dapm_siggen,		/* signal generator */
453 	snd_soc_dapm_dai,		/* link to DAI structure */
454 	snd_soc_dapm_dai_link,		/* link between two DAI structures */
455 };
456 
457 enum snd_soc_dapm_subclass {
458 	SND_SOC_DAPM_CLASS_INIT		= 0,
459 	SND_SOC_DAPM_CLASS_RUNTIME	= 1,
460 };
461 
462 /*
463  * DAPM audio route definition.
464  *
465  * Defines an audio route originating at source via control and finishing
466  * at sink.
467  */
468 struct snd_soc_dapm_route {
469 	const char *sink;
470 	const char *control;
471 	const char *source;
472 
473 	/* Note: currently only supported for links where source is a supply */
474 	int (*connected)(struct snd_soc_dapm_widget *source,
475 			 struct snd_soc_dapm_widget *sink);
476 };
477 
478 /* dapm audio path between two widgets */
479 struct snd_soc_dapm_path {
480 	const char *name;
481 	const char *long_name;
482 
483 	/* source (input) and sink (output) widgets */
484 	struct snd_soc_dapm_widget *source;
485 	struct snd_soc_dapm_widget *sink;
486 	struct snd_kcontrol *kcontrol;
487 
488 	/* status */
489 	u32 connect:1;	/* source and sink widgets are connected */
490 	u32 walked:1;	/* path has been walked */
491 	u32 walking:1;  /* path is in the process of being walked */
492 	u32 weak:1;	/* path ignored for power management */
493 
494 	int (*connected)(struct snd_soc_dapm_widget *source,
495 			 struct snd_soc_dapm_widget *sink);
496 
497 	struct list_head list_source;
498 	struct list_head list_sink;
499 	struct list_head list;
500 };
501 
502 /* dapm widget */
503 struct snd_soc_dapm_widget {
504 	enum snd_soc_dapm_type id;
505 	const char *name;		/* widget name */
506 	const char *sname;	/* stream name */
507 	struct snd_soc_codec *codec;
508 	struct snd_soc_platform *platform;
509 	struct list_head list;
510 	struct snd_soc_dapm_context *dapm;
511 
512 	void *priv;				/* widget specific data */
513 	struct regulator *regulator;		/* attached regulator */
514 	const struct snd_soc_pcm_stream *params; /* params for dai links */
515 
516 	/* dapm control */
517 	int reg;				/* negative reg = no direct dapm */
518 	unsigned char shift;			/* bits to shift */
519 	unsigned int value;				/* widget current value */
520 	unsigned int mask;			/* non-shifted mask */
521 	unsigned int on_val;			/* on state value */
522 	unsigned int off_val;			/* off state value */
523 	unsigned char power:1;			/* block power status */
524 	unsigned char invert:1;			/* invert the power bit */
525 	unsigned char active:1;			/* active stream on DAC, ADC's */
526 	unsigned char connected:1;		/* connected codec pin */
527 	unsigned char new:1;			/* cnew complete */
528 	unsigned char ext:1;			/* has external widgets */
529 	unsigned char force:1;			/* force state */
530 	unsigned char ignore_suspend:1;         /* kept enabled over suspend */
531 	unsigned char new_power:1;		/* power from this run */
532 	unsigned char power_checked:1;		/* power checked this run */
533 	int subseq;				/* sort within widget type */
534 
535 	int (*power_check)(struct snd_soc_dapm_widget *w);
536 
537 	/* external events */
538 	unsigned short event_flags;		/* flags to specify event types */
539 	int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
540 
541 	/* kcontrols that relate to this widget */
542 	int num_kcontrols;
543 	const struct snd_kcontrol_new *kcontrol_news;
544 	struct snd_kcontrol **kcontrols;
545 
546 	/* widget input and outputs */
547 	struct list_head sources;
548 	struct list_head sinks;
549 
550 	/* used during DAPM updates */
551 	struct list_head power_list;
552 	struct list_head dirty;
553 	int inputs;
554 	int outputs;
555 
556 	struct clk *clk;
557 };
558 
559 struct snd_soc_dapm_update {
560 	struct snd_soc_dapm_widget *widget;
561 	struct snd_kcontrol *kcontrol;
562 	int reg;
563 	int mask;
564 	int val;
565 };
566 
567 /* DAPM context */
568 struct snd_soc_dapm_context {
569 	enum snd_soc_bias_level bias_level;
570 	enum snd_soc_bias_level suspend_bias_level;
571 	struct delayed_work delayed_work;
572 	unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
573 
574 	struct snd_soc_dapm_update *update;
575 
576 	void (*seq_notifier)(struct snd_soc_dapm_context *,
577 			     enum snd_soc_dapm_type, int);
578 
579 	struct device *dev; /* from parent - for debug */
580 	struct snd_soc_codec *codec; /* parent codec */
581 	struct snd_soc_platform *platform; /* parent platform */
582 	struct snd_soc_card *card; /* parent card */
583 
584 	/* used during DAPM updates */
585 	enum snd_soc_bias_level target_bias_level;
586 	struct list_head list;
587 
588 	int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
589 
590 #ifdef CONFIG_DEBUG_FS
591 	struct dentry *debugfs_dapm;
592 #endif
593 };
594 
595 /* A list of widgets associated with an object, typically a snd_kcontrol */
596 struct snd_soc_dapm_widget_list {
597 	int num_widgets;
598 	struct snd_soc_dapm_widget *widgets[0];
599 };
600 
601 struct snd_soc_dapm_stats {
602 	int power_checks;
603 	int path_checks;
604 	int neighbour_checks;
605 };
606 
607 #endif
608