xref: /openbmc/linux/include/sound/soc-dapm.h (revision 92ed1a76)
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 #include <sound/soc.h>
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 upto 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, .kcontrols = NULL, \
44 	.num_kcontrols = 0}
45 
46 /* platform domain */
47 #define SND_SOC_DAPM_INPUT(wname) \
48 {	.id = snd_soc_dapm_input, .name = wname, .kcontrols = NULL, \
49 	.num_kcontrols = 0}
50 #define SND_SOC_DAPM_OUTPUT(wname) \
51 {	.id = snd_soc_dapm_output, .name = wname, .kcontrols = NULL, \
52 	.num_kcontrols = 0}
53 #define SND_SOC_DAPM_MIC(wname, wevent) \
54 {	.id = snd_soc_dapm_mic, .name = wname, .kcontrols = NULL, \
55 	.num_kcontrols = 0, .event = wevent, \
56 	.event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
57 #define SND_SOC_DAPM_HP(wname, wevent) \
58 {	.id = snd_soc_dapm_hp, .name = wname, .kcontrols = NULL, \
59 	.num_kcontrols = 0, .event = wevent, \
60 	.event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
61 #define SND_SOC_DAPM_SPK(wname, wevent) \
62 {	.id = snd_soc_dapm_spk, .name = wname, .kcontrols = NULL, \
63 	.num_kcontrols = 0, .event = wevent, \
64 	.event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
65 #define SND_SOC_DAPM_LINE(wname, wevent) \
66 {	.id = snd_soc_dapm_line, .name = wname, .kcontrols = NULL, \
67 	.num_kcontrols = 0, .event = wevent, \
68 	.event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
69 
70 /* path domain */
71 #define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\
72 	 wcontrols, wncontrols) \
73 {	.id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
74 	.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols}
75 #define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
76 	 wcontrols, wncontrols)\
77 {	.id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
78 	.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols}
79 #define SND_SOC_DAPM_MIXER_NAMED_CTL(wname, wreg, wshift, winvert, \
80 	 wcontrols, wncontrols)\
81 {       .id = snd_soc_dapm_mixer_named_ctl, .name = wname, .reg = wreg, \
82 	.shift = wshift, .invert = winvert, .kcontrols = wcontrols, \
83 	.num_kcontrols = wncontrols}
84 #define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
85 {	.id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
86 	.invert = winvert, .kcontrols = NULL, .num_kcontrols = 0}
87 #define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
88 {	.id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
89 	.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1}
90 #define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
91 {	.id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
92 	.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1}
93 #define SND_SOC_DAPM_VALUE_MUX(wname, wreg, wshift, winvert, wcontrols) \
94 {	.id = snd_soc_dapm_value_mux, .name = wname, .reg = wreg, \
95 	.shift = wshift, .invert = winvert, .kcontrols = wcontrols, \
96 	.num_kcontrols = 1}
97 
98 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
99 #define SOC_PGA_ARRAY(wname, wreg, wshift, winvert,\
100 	 wcontrols) \
101 {	.id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
102 	.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
103 #define SOC_MIXER_ARRAY(wname, wreg, wshift, winvert, \
104 	 wcontrols)\
105 {	.id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
106 	.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
107 #define SOC_MIXER_NAMED_CTL_ARRAY(wname, wreg, wshift, winvert, \
108 	 wcontrols)\
109 {       .id = snd_soc_dapm_mixer_named_ctl, .name = wname, .reg = wreg, \
110 	.shift = wshift, .invert = winvert, .kcontrols = wcontrols, \
111 	.num_kcontrols = ARRAY_SIZE(wcontrols)}
112 
113 /* path domain with event - event handler must return 0 for success */
114 #define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \
115 	wncontrols, wevent, wflags) \
116 {	.id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
117 	.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols, \
118 	.event = wevent, .event_flags = wflags}
119 #define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \
120 	wncontrols, wevent, wflags) \
121 {	.id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
122 	.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols, \
123 	.event = wevent, .event_flags = wflags}
124 #define SND_SOC_DAPM_MIXER_NAMED_CTL_E(wname, wreg, wshift, winvert, \
125 	wcontrols, wncontrols, wevent, wflags) \
126 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
127 	.invert = winvert, .kcontrols = wcontrols, \
128 	.num_kcontrols = wncontrols, .event = wevent, .event_flags = wflags}
129 #define SND_SOC_DAPM_MICBIAS_E(wname, wreg, wshift, winvert, wevent, wflags) \
130 {	.id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
131 	.invert = winvert, .kcontrols = NULL, .num_kcontrols = 0, \
132 	.event = wevent, .event_flags = wflags}
133 #define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
134 	wevent, wflags) \
135 {	.id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
136 	.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1, \
137 	.event = wevent, .event_flags = wflags}
138 #define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
139 	wevent, wflags) \
140 {	.id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
141 	.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1, \
142 	.event = wevent, .event_flags = wflags}
143 
144 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
145 #define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
146 	wevent, wflags) \
147 {	.id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
148 	.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
149 	.event = wevent, .event_flags = wflags}
150 #define SOC_MIXER_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
151 	wevent, wflags) \
152 {	.id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
153 	.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
154 	.event = wevent, .event_flags = wflags}
155 #define SOC_MIXER_NAMED_CTL_E_ARRAY(wname, wreg, wshift, winvert, \
156 	wcontrols, wevent, wflags) \
157 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
158 	.invert = winvert, .kcontrols = wcontrols, \
159 	.num_kcontrols = ARRAY_SIZE(wcontrols), .event = wevent, .event_flags = wflags}
160 
161 /* events that are pre and post DAPM */
162 #define SND_SOC_DAPM_PRE(wname, wevent) \
163 {	.id = snd_soc_dapm_pre, .name = wname, .kcontrols = NULL, \
164 	.num_kcontrols = 0, .event = wevent, \
165 	.event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
166 #define SND_SOC_DAPM_POST(wname, wevent) \
167 {	.id = snd_soc_dapm_post, .name = wname, .kcontrols = NULL, \
168 	.num_kcontrols = 0, .event = wevent, \
169 	.event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
170 
171 /* stream domain */
172 #define SND_SOC_DAPM_AIF_IN(wname, stname, wslot, wreg, wshift, winvert) \
173 {	.id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
174 	.reg = wreg, .shift = wshift, .invert = winvert }
175 #define SND_SOC_DAPM_AIF_IN_E(wname, stname, wslot, wreg, wshift, winvert, \
176 			      wevent, wflags)				\
177 {	.id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
178 	.reg = wreg, .shift = wshift, .invert = winvert, \
179 	.event = wevent, .event_flags = wflags }
180 #define SND_SOC_DAPM_AIF_OUT(wname, stname, wslot, wreg, wshift, winvert) \
181 {	.id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
182 	.reg = wreg, .shift = wshift, .invert = winvert }
183 #define SND_SOC_DAPM_AIF_OUT_E(wname, stname, wslot, wreg, wshift, winvert, \
184 			     wevent, wflags)				\
185 {	.id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
186 	.reg = wreg, .shift = wshift, .invert = winvert, \
187 	.event = wevent, .event_flags = wflags }
188 #define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
189 {	.id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
190 	.shift = wshift, .invert = winvert}
191 #define SND_SOC_DAPM_DAC_E(wname, stname, wreg, wshift, winvert, \
192 			   wevent, wflags)				\
193 {	.id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
194 	.shift = wshift, .invert = winvert, \
195 	.event = wevent, .event_flags = wflags}
196 #define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
197 {	.id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
198 	.shift = wshift, .invert = winvert}
199 #define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \
200 			   wevent, wflags)				\
201 {	.id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
202 	.shift = wshift, .invert = winvert, \
203 	.event = wevent, .event_flags = wflags}
204 
205 /* generic widgets */
206 #define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
207 {	.id = wid, .name = wname, .kcontrols = NULL, .num_kcontrols = 0, \
208 	.reg = -((wreg) + 1), .shift = wshift, .mask = wmask, \
209 	.on_val = won_val, .off_val = woff_val, .event = dapm_reg_event, \
210 	.event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
211 #define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \
212 {	.id = snd_soc_dapm_supply, .name = wname, .reg = wreg,	\
213 	.shift = wshift, .invert = winvert, .event = wevent, \
214 	.event_flags = wflags}
215 
216 /* dapm kcontrol types */
217 #define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
218 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
219 	.info = snd_soc_info_volsw, \
220 	.get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
221 	.private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
222 #define SOC_DAPM_DOUBLE(xname, reg, shift_left, shift_right, max, invert, \
223 	power) \
224 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
225 	.info = snd_soc_info_volsw, \
226  	.get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
227  	.private_value = (reg) | ((shift_left) << 8) | ((shift_right) << 12) |\
228 		((max) << 16) | ((invert) << 24) }
229 #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
230 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
231 	.info = snd_soc_info_volsw, \
232 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
233 	.tlv.p = (tlv_array), \
234 	.get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
235 	.private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
236 #define SOC_DAPM_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, \
237 	power, tlv_array) \
238 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
239 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
240 	.tlv.p = (tlv_array), \
241 	.info = snd_soc_info_volsw, \
242 	.get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
243 	.private_value = (reg) | ((shift_left) << 8) | ((shift_right) << 12) |\
244 		((max) << 16) | ((invert) << 24) }
245 #define SOC_DAPM_ENUM(xname, xenum) \
246 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
247 	.info = snd_soc_info_enum_double, \
248  	.get = snd_soc_dapm_get_enum_double, \
249  	.put = snd_soc_dapm_put_enum_double, \
250   	.private_value = (unsigned long)&xenum }
251 #define SOC_DAPM_ENUM_VIRT(xname, xenum)		    \
252 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
253 	.info = snd_soc_info_enum_double, \
254 	.get = snd_soc_dapm_get_enum_virt, \
255 	.put = snd_soc_dapm_put_enum_virt, \
256 	.private_value = (unsigned long)&xenum }
257 #define SOC_DAPM_VALUE_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_value_enum_double, \
261 	.put = snd_soc_dapm_put_value_enum_double, \
262 	.private_value = (unsigned long)&xenum }
263 #define SOC_DAPM_PIN_SWITCH(xname) \
264 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
265 	.info = snd_soc_dapm_info_pin_switch, \
266 	.get = snd_soc_dapm_get_pin_switch, \
267 	.put = snd_soc_dapm_put_pin_switch, \
268 	.private_value = (unsigned long)xname }
269 
270 /* dapm stream operations */
271 #define SND_SOC_DAPM_STREAM_NOP			0x0
272 #define SND_SOC_DAPM_STREAM_START		0x1
273 #define SND_SOC_DAPM_STREAM_STOP		0x2
274 #define SND_SOC_DAPM_STREAM_SUSPEND		0x4
275 #define SND_SOC_DAPM_STREAM_RESUME		0x8
276 #define SND_SOC_DAPM_STREAM_PAUSE_PUSH	0x10
277 #define SND_SOC_DAPM_STREAM_PAUSE_RELEASE	0x20
278 
279 /* dapm event types */
280 #define SND_SOC_DAPM_PRE_PMU	0x1 	/* before widget power up */
281 #define SND_SOC_DAPM_POST_PMU	0x2		/* after widget power up */
282 #define SND_SOC_DAPM_PRE_PMD	0x4 	/* before widget power down */
283 #define SND_SOC_DAPM_POST_PMD	0x8		/* after widget power down */
284 #define SND_SOC_DAPM_PRE_REG	0x10	/* before audio path setup */
285 #define SND_SOC_DAPM_POST_REG	0x20	/* after audio path setup */
286 #define SND_SOC_DAPM_PRE_POST_PMD \
287 				(SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
288 
289 /* convenience event type detection */
290 #define SND_SOC_DAPM_EVENT_ON(e)	\
291 	(e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
292 #define SND_SOC_DAPM_EVENT_OFF(e)	\
293 	(e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
294 
295 struct snd_soc_dapm_widget;
296 enum snd_soc_dapm_type;
297 struct snd_soc_dapm_path;
298 struct snd_soc_dapm_pin;
299 struct snd_soc_dapm_route;
300 
301 int dapm_reg_event(struct snd_soc_dapm_widget *w,
302 		   struct snd_kcontrol *kcontrol, int event);
303 
304 /* dapm controls */
305 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
306 	struct snd_ctl_elem_value *ucontrol);
307 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
308 	struct snd_ctl_elem_value *ucontrol);
309 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
310 	struct snd_ctl_elem_value *ucontrol);
311 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
312 	struct snd_ctl_elem_value *ucontrol);
313 int snd_soc_dapm_get_enum_virt(struct snd_kcontrol *kcontrol,
314 	struct snd_ctl_elem_value *ucontrol);
315 int snd_soc_dapm_put_enum_virt(struct snd_kcontrol *kcontrol,
316 	struct snd_ctl_elem_value *ucontrol);
317 int snd_soc_dapm_get_value_enum_double(struct snd_kcontrol *kcontrol,
318 	struct snd_ctl_elem_value *ucontrol);
319 int snd_soc_dapm_put_value_enum_double(struct snd_kcontrol *kcontrol,
320 	struct snd_ctl_elem_value *ucontrol);
321 int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
322 	struct snd_ctl_elem_info *uinfo);
323 int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
324 	struct snd_ctl_elem_value *uncontrol);
325 int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
326 	struct snd_ctl_elem_value *uncontrol);
327 int snd_soc_dapm_new_control(struct snd_soc_codec *codec,
328 	const struct snd_soc_dapm_widget *widget);
329 int snd_soc_dapm_new_controls(struct snd_soc_codec *codec,
330 	const struct snd_soc_dapm_widget *widget,
331 	int num);
332 
333 /* dapm path setup */
334 int snd_soc_dapm_new_widgets(struct snd_soc_codec *codec);
335 void snd_soc_dapm_free(struct snd_soc_codec *codec);
336 int snd_soc_dapm_add_routes(struct snd_soc_codec *codec,
337 			    const struct snd_soc_dapm_route *route, int num);
338 
339 /* dapm events */
340 int snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd,
341 	const char *stream, int event);
342 void snd_soc_dapm_shutdown(struct snd_soc_card *card);
343 
344 /* dapm sys fs - used by the core */
345 int snd_soc_dapm_sys_add(struct device *dev);
346 void snd_soc_dapm_debugfs_init(struct snd_soc_codec *codec);
347 
348 /* dapm audio pin control and status */
349 int snd_soc_dapm_enable_pin(struct snd_soc_codec *codec, const char *pin);
350 int snd_soc_dapm_disable_pin(struct snd_soc_codec *codec, const char *pin);
351 int snd_soc_dapm_nc_pin(struct snd_soc_codec *codec, const char *pin);
352 int snd_soc_dapm_get_pin_status(struct snd_soc_codec *codec, const char *pin);
353 int snd_soc_dapm_sync(struct snd_soc_codec *codec);
354 int snd_soc_dapm_force_enable_pin(struct snd_soc_codec *codec,
355 				  const char *pin);
356 int snd_soc_dapm_ignore_suspend(struct snd_soc_codec *codec, const char *pin);
357 
358 /* dapm widget types */
359 enum snd_soc_dapm_type {
360 	snd_soc_dapm_input = 0,		/* input pin */
361 	snd_soc_dapm_output,		/* output pin */
362 	snd_soc_dapm_mux,			/* selects 1 analog signal from many inputs */
363 	snd_soc_dapm_value_mux,			/* selects 1 analog signal from many inputs */
364 	snd_soc_dapm_mixer,			/* mixes several analog signals together */
365 	snd_soc_dapm_mixer_named_ctl,		/* mixer with named controls */
366 	snd_soc_dapm_pga,			/* programmable gain/attenuation (volume) */
367 	snd_soc_dapm_adc,			/* analog to digital converter */
368 	snd_soc_dapm_dac,			/* digital to analog converter */
369 	snd_soc_dapm_micbias,		/* microphone bias (power) */
370 	snd_soc_dapm_mic,			/* microphone */
371 	snd_soc_dapm_hp,			/* headphones */
372 	snd_soc_dapm_spk,			/* speaker */
373 	snd_soc_dapm_line,			/* line input/output */
374 	snd_soc_dapm_switch,		/* analog switch */
375 	snd_soc_dapm_vmid,			/* codec bias/vmid - to minimise pops */
376 	snd_soc_dapm_pre,			/* machine specific pre widget - exec first */
377 	snd_soc_dapm_post,			/* machine specific post widget - exec last */
378 	snd_soc_dapm_supply,		/* power/clock supply */
379 	snd_soc_dapm_aif_in,		/* audio interface input */
380 	snd_soc_dapm_aif_out,		/* audio interface output */
381 };
382 
383 /*
384  * DAPM audio route definition.
385  *
386  * Defines an audio route originating at source via control and finishing
387  * at sink.
388  */
389 struct snd_soc_dapm_route {
390 	const char *sink;
391 	const char *control;
392 	const char *source;
393 
394 	/* Note: currently only supported for links where source is a supply */
395 	int (*connected)(struct snd_soc_dapm_widget *source,
396 			 struct snd_soc_dapm_widget *sink);
397 };
398 
399 /* dapm audio path between two widgets */
400 struct snd_soc_dapm_path {
401 	char *name;
402 	char *long_name;
403 
404 	/* source (input) and sink (output) widgets */
405 	struct snd_soc_dapm_widget *source;
406 	struct snd_soc_dapm_widget *sink;
407 	struct snd_kcontrol *kcontrol;
408 
409 	/* status */
410 	u32 connect:1;	/* source and sink widgets are connected */
411 	u32 walked:1;	/* path has been walked */
412 
413 	int (*connected)(struct snd_soc_dapm_widget *source,
414 			 struct snd_soc_dapm_widget *sink);
415 
416 	struct list_head list_source;
417 	struct list_head list_sink;
418 	struct list_head list;
419 };
420 
421 /* dapm widget */
422 struct snd_soc_dapm_widget {
423 	enum snd_soc_dapm_type id;
424 	char *name;		/* widget name */
425 	char *sname;	/* stream name */
426 	struct snd_soc_codec *codec;
427 	struct list_head list;
428 
429 	/* dapm control */
430 	short reg;						/* negative reg = no direct dapm */
431 	unsigned char shift;			/* bits to shift */
432 	unsigned int saved_value;		/* widget saved value */
433 	unsigned int value;				/* widget current value */
434 	unsigned int mask;			/* non-shifted mask */
435 	unsigned int on_val;			/* on state value */
436 	unsigned int off_val;			/* off state value */
437 	unsigned char power:1;			/* block power status */
438 	unsigned char invert:1;			/* invert the power bit */
439 	unsigned char active:1;			/* active stream on DAC, ADC's */
440 	unsigned char connected:1;		/* connected codec pin */
441 	unsigned char new:1;			/* cnew complete */
442 	unsigned char ext:1;			/* has external widgets */
443 	unsigned char force:1;			/* force state */
444 	unsigned char ignore_suspend:1;         /* kept enabled over suspend */
445 
446 	int (*power_check)(struct snd_soc_dapm_widget *w);
447 
448 	/* external events */
449 	unsigned short event_flags;		/* flags to specify event types */
450 	int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
451 
452 	/* kcontrols that relate to this widget */
453 	int num_kcontrols;
454 	const struct snd_kcontrol_new *kcontrols;
455 
456 	/* widget input and outputs */
457 	struct list_head sources;
458 	struct list_head sinks;
459 
460 	/* used during DAPM updates */
461 	struct list_head power_list;
462 };
463 
464 #endif
465