Loading...
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#include <sound/soc-topology.h>
19#include <sound/asoc.h>
20
21struct device;
22
23/* widget has no PM register bit */
24#define SND_SOC_NOPM -1
25
26/*
27 * SoC dynamic audio power management
28 *
29 * We can have up to 4 power domains
30 * 1. Codec domain - VREF, VMID
31 * Usually controlled at codec probe/remove, although can be set
32 * at stream time if power is not needed for sidetone, etc.
33 * 2. Platform/Machine domain - physically connected inputs and outputs
34 * Is platform/machine and user action specific, is set in the machine
35 * driver and by userspace e.g when HP are inserted
36 * 3. Path domain - Internal codec path mixers
37 * Are automatically set when mixer and mux settings are
38 * changed by the user.
39 * 4. Stream domain - DAC's and ADC's.
40 * Enabled when stream playback/capture is started.
41 */
42
43/* codec domain */
44#define SND_SOC_DAPM_VMID(wname) \
45{ .id = snd_soc_dapm_vmid, .name = wname, .kcontrol_news = NULL, \
46 .num_kcontrols = 0}
47
48/* platform domain */
49#define SND_SOC_DAPM_SIGGEN(wname) \
50{ .id = snd_soc_dapm_siggen, .name = wname, .kcontrol_news = NULL, \
51 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
52#define SND_SOC_DAPM_SINK(wname) \
53{ .id = snd_soc_dapm_sink, .name = wname, .kcontrol_news = NULL, \
54 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
55#define SND_SOC_DAPM_INPUT(wname) \
56{ .id = snd_soc_dapm_input, .name = wname, .kcontrol_news = NULL, \
57 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
58#define SND_SOC_DAPM_OUTPUT(wname) \
59{ .id = snd_soc_dapm_output, .name = wname, .kcontrol_news = NULL, \
60 .num_kcontrols = 0, .reg = SND_SOC_NOPM }
61#define SND_SOC_DAPM_MIC(wname, wevent) \
62{ .id = snd_soc_dapm_mic, .name = wname, .kcontrol_news = NULL, \
63 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
64 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
65#define SND_SOC_DAPM_HP(wname, wevent) \
66{ .id = snd_soc_dapm_hp, .name = wname, .kcontrol_news = NULL, \
67 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
68 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
69#define SND_SOC_DAPM_SPK(wname, wevent) \
70{ .id = snd_soc_dapm_spk, .name = wname, .kcontrol_news = NULL, \
71 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
72 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
73#define SND_SOC_DAPM_LINE(wname, wevent) \
74{ .id = snd_soc_dapm_line, .name = wname, .kcontrol_news = NULL, \
75 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
76 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
77
78#define SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) \
79 .reg = wreg, .mask = 1, .shift = wshift, \
80 .on_val = winvert ? 0 : 1, .off_val = winvert ? 1 : 0
81
82/* path domain */
83#define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\
84 wcontrols, wncontrols) \
85{ .id = snd_soc_dapm_pga, .name = wname, \
86 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
87 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
88#define SND_SOC_DAPM_OUT_DRV(wname, wreg, wshift, winvert,\
89 wcontrols, wncontrols) \
90{ .id = snd_soc_dapm_out_drv, .name = wname, \
91 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
92 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
93#define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
94 wcontrols, wncontrols)\
95{ .id = snd_soc_dapm_mixer, .name = wname, \
96 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
97 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
98#define SND_SOC_DAPM_MIXER_NAMED_CTL(wname, wreg, wshift, winvert, \
99 wcontrols, wncontrols)\
100{ .id = snd_soc_dapm_mixer_named_ctl, .name = wname, \
101 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
102 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
103/* DEPRECATED: use SND_SOC_DAPM_SUPPLY */
104#define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
105{ .id = snd_soc_dapm_micbias, .name = wname, \
106 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
107 .kcontrol_news = NULL, .num_kcontrols = 0}
108#define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
109{ .id = snd_soc_dapm_switch, .name = wname, \
110 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
111 .kcontrol_news = wcontrols, .num_kcontrols = 1}
112#define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
113{ .id = snd_soc_dapm_mux, .name = wname, \
114 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
115 .kcontrol_news = wcontrols, .num_kcontrols = 1}
116#define SND_SOC_DAPM_DEMUX(wname, wreg, wshift, winvert, wcontrols) \
117{ .id = snd_soc_dapm_demux, .name = wname, \
118 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
119 .kcontrol_news = wcontrols, .num_kcontrols = 1}
120
121/* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
122#define SOC_PGA_ARRAY(wname, wreg, wshift, winvert,\
123 wcontrols) \
124{ .id = snd_soc_dapm_pga, .name = wname, \
125 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
126 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
127#define SOC_MIXER_ARRAY(wname, wreg, wshift, winvert, \
128 wcontrols)\
129{ .id = snd_soc_dapm_mixer, .name = wname, \
130 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
131 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
132#define SOC_MIXER_NAMED_CTL_ARRAY(wname, wreg, wshift, winvert, \
133 wcontrols)\
134{ .id = snd_soc_dapm_mixer_named_ctl, .name = wname, \
135 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
136 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
137
138/* path domain with event - event handler must return 0 for success */
139#define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \
140 wncontrols, wevent, wflags) \
141{ .id = snd_soc_dapm_pga, .name = wname, \
142 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
143 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
144 .event = wevent, .event_flags = wflags}
145#define SND_SOC_DAPM_OUT_DRV_E(wname, wreg, wshift, winvert, wcontrols, \
146 wncontrols, wevent, wflags) \
147{ .id = snd_soc_dapm_out_drv, .name = wname, \
148 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
149 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
150 .event = wevent, .event_flags = wflags}
151#define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \
152 wncontrols, wevent, wflags) \
153{ .id = snd_soc_dapm_mixer, .name = wname, \
154 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
155 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
156 .event = wevent, .event_flags = wflags}
157#define SND_SOC_DAPM_MIXER_NAMED_CTL_E(wname, wreg, wshift, winvert, \
158 wcontrols, wncontrols, wevent, wflags) \
159{ .id = snd_soc_dapm_mixer, .name = wname, \
160 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
161 .kcontrol_news = wcontrols, \
162 .num_kcontrols = wncontrols, .event = wevent, .event_flags = wflags}
163#define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
164 wevent, wflags) \
165{ .id = snd_soc_dapm_switch, .name = wname, \
166 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
167 .kcontrol_news = wcontrols, .num_kcontrols = 1, \
168 .event = wevent, .event_flags = wflags}
169#define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
170 wevent, wflags) \
171{ .id = snd_soc_dapm_mux, .name = wname, \
172 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
173 .kcontrol_news = wcontrols, .num_kcontrols = 1, \
174 .event = wevent, .event_flags = wflags}
175
176/* additional sequencing control within an event type */
177#define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \
178 wevent, wflags) \
179{ .id = snd_soc_dapm_pga, .name = wname, \
180 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
181 .event = wevent, .event_flags = wflags, \
182 .subseq = wsubseq}
183#define SND_SOC_DAPM_SUPPLY_S(wname, wsubseq, wreg, wshift, winvert, wevent, \
184 wflags) \
185{ .id = snd_soc_dapm_supply, .name = wname, \
186 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
187 .event = wevent, .event_flags = wflags, .subseq = wsubseq}
188
189/* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
190#define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
191 wevent, wflags) \
192{ .id = snd_soc_dapm_pga, .name = wname, \
193 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
194 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
195 .event = wevent, .event_flags = wflags}
196#define SOC_MIXER_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
197 wevent, wflags) \
198{ .id = snd_soc_dapm_mixer, .name = wname, \
199 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
200 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
201 .event = wevent, .event_flags = wflags}
202#define SOC_MIXER_NAMED_CTL_E_ARRAY(wname, wreg, wshift, winvert, \
203 wcontrols, wevent, wflags) \
204{ .id = snd_soc_dapm_mixer, .name = wname, \
205 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
206 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
207 .event = wevent, .event_flags = wflags}
208
209/* events that are pre and post DAPM */
210#define SND_SOC_DAPM_PRE(wname, wevent) \
211{ .id = snd_soc_dapm_pre, .name = wname, .kcontrol_news = NULL, \
212 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
213 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
214#define SND_SOC_DAPM_POST(wname, wevent) \
215{ .id = snd_soc_dapm_post, .name = wname, .kcontrol_news = NULL, \
216 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
217 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
218
219/* stream domain */
220#define SND_SOC_DAPM_AIF_IN(wname, stname, wslot, wreg, wshift, winvert) \
221{ .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
222 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
223#define SND_SOC_DAPM_AIF_IN_E(wname, stname, wslot, wreg, wshift, winvert, \
224 wevent, wflags) \
225{ .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
226 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
227 .event = wevent, .event_flags = wflags }
228#define SND_SOC_DAPM_AIF_OUT(wname, stname, wslot, wreg, wshift, winvert) \
229{ .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
230 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
231#define SND_SOC_DAPM_AIF_OUT_E(wname, stname, wslot, wreg, wshift, winvert, \
232 wevent, wflags) \
233{ .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
234 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
235 .event = wevent, .event_flags = wflags }
236#define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
237{ .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \
238 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) }
239#define SND_SOC_DAPM_DAC_E(wname, stname, wreg, wshift, winvert, \
240 wevent, wflags) \
241{ .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \
242 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
243 .event = wevent, .event_flags = wflags}
244
245#define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
246{ .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \
247 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
248#define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \
249 wevent, wflags) \
250{ .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \
251 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
252 .event = wevent, .event_flags = wflags}
253#define SND_SOC_DAPM_CLOCK_SUPPLY(wname) \
254{ .id = snd_soc_dapm_clock_supply, .name = wname, \
255 .reg = SND_SOC_NOPM, .event = dapm_clock_event, \
256 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD }
257
258/* generic widgets */
259#define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
260{ .id = wid, .name = wname, .kcontrol_news = NULL, .num_kcontrols = 0, \
261 .reg = wreg, .shift = wshift, .mask = wmask, \
262 .on_val = won_val, .off_val = woff_val, }
263#define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \
264{ .id = snd_soc_dapm_supply, .name = wname, \
265 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
266 .event = wevent, .event_flags = wflags}
267#define SND_SOC_DAPM_REGULATOR_SUPPLY(wname, wdelay, wflags) \
268{ .id = snd_soc_dapm_regulator_supply, .name = wname, \
269 .reg = SND_SOC_NOPM, .shift = wdelay, .event = dapm_regulator_event, \
270 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD, \
271 .on_val = wflags}
272
273
274/* dapm kcontrol types */
275#define SOC_DAPM_DOUBLE(xname, reg, lshift, rshift, max, invert) \
276{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
277 .info = snd_soc_info_volsw, \
278 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
279 .private_value = SOC_DOUBLE_VALUE(reg, lshift, rshift, max, invert, 0) }
280#define SOC_DAPM_DOUBLE_R(xname, lreg, rreg, shift, max, invert) \
281{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
282 .info = snd_soc_info_volsw, \
283 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
284 .private_value = SOC_DOUBLE_R_VALUE(lreg, rreg, shift, max, invert) }
285#define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
286{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
287 .info = snd_soc_info_volsw, \
288 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
289 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
290#define SOC_DAPM_SINGLE_AUTODISABLE(xname, reg, shift, max, invert) \
291{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
292 .info = snd_soc_info_volsw, \
293 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
294 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 1) }
295#define SOC_DAPM_SINGLE_VIRT(xname, max) \
296 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0)
297#define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
298{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
299 .info = snd_soc_info_volsw, \
300 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
301 .tlv.p = (tlv_array), \
302 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
303 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
304#define SOC_DAPM_SINGLE_TLV_AUTODISABLE(xname, reg, shift, max, invert, tlv_array) \
305{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
306 .info = snd_soc_info_volsw, \
307 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
308 .tlv.p = (tlv_array), \
309 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
310 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 1) }
311#define SOC_DAPM_SINGLE_TLV_VIRT(xname, max, tlv_array) \
312 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0, tlv_array)
313#define SOC_DAPM_ENUM(xname, xenum) \
314{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
315 .info = snd_soc_info_enum_double, \
316 .get = snd_soc_dapm_get_enum_double, \
317 .put = snd_soc_dapm_put_enum_double, \
318 .private_value = (unsigned long)&xenum }
319#define SOC_DAPM_ENUM_EXT(xname, xenum, xget, xput) \
320{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
321 .info = snd_soc_info_enum_double, \
322 .get = xget, \
323 .put = xput, \
324 .private_value = (unsigned long)&xenum }
325#define SOC_DAPM_PIN_SWITCH(xname) \
326{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
327 .info = snd_soc_dapm_info_pin_switch, \
328 .get = snd_soc_dapm_get_pin_switch, \
329 .put = snd_soc_dapm_put_pin_switch, \
330 .private_value = (unsigned long)xname }
331
332/* dapm stream operations */
333#define SND_SOC_DAPM_STREAM_NOP 0x0
334#define SND_SOC_DAPM_STREAM_START 0x1
335#define SND_SOC_DAPM_STREAM_STOP 0x2
336#define SND_SOC_DAPM_STREAM_SUSPEND 0x4
337#define SND_SOC_DAPM_STREAM_RESUME 0x8
338#define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10
339#define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20
340
341/* dapm event types */
342#define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */
343#define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */
344#define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */
345#define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */
346#define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */
347#define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */
348#define SND_SOC_DAPM_WILL_PMU 0x40 /* called at start of sequence */
349#define SND_SOC_DAPM_WILL_PMD 0x80 /* called at start of sequence */
350#define SND_SOC_DAPM_PRE_POST_PMD \
351 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
352
353/* convenience event type detection */
354#define SND_SOC_DAPM_EVENT_ON(e) \
355 (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
356#define SND_SOC_DAPM_EVENT_OFF(e) \
357 (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
358
359/* regulator widget flags */
360#define SND_SOC_DAPM_REGULATOR_BYPASS 0x1 /* bypass when disabled */
361
362struct snd_soc_dapm_widget;
363enum snd_soc_dapm_type;
364struct snd_soc_dapm_path;
365struct snd_soc_dapm_pin;
366struct snd_soc_dapm_route;
367struct snd_soc_dapm_context;
368struct regulator;
369struct snd_soc_dapm_widget_list;
370struct snd_soc_dapm_update;
371enum snd_soc_dapm_direction;
372
373int dapm_regulator_event(struct snd_soc_dapm_widget *w,
374 struct snd_kcontrol *kcontrol, int event);
375int dapm_clock_event(struct snd_soc_dapm_widget *w,
376 struct snd_kcontrol *kcontrol, int event);
377
378/* dapm controls */
379int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
380 struct snd_ctl_elem_value *ucontrol);
381int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
382 struct snd_ctl_elem_value *ucontrol);
383int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
384 struct snd_ctl_elem_value *ucontrol);
385int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
386 struct snd_ctl_elem_value *ucontrol);
387int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
388 struct snd_ctl_elem_info *uinfo);
389int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
390 struct snd_ctl_elem_value *uncontrol);
391int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
392 struct snd_ctl_elem_value *uncontrol);
393int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
394 const struct snd_soc_dapm_widget *widget,
395 int num);
396struct snd_soc_dapm_widget *snd_soc_dapm_new_control(
397 struct snd_soc_dapm_context *dapm,
398 const struct snd_soc_dapm_widget *widget);
399int snd_soc_dapm_new_dai_widgets(struct snd_soc_dapm_context *dapm,
400 struct snd_soc_dai *dai);
401int snd_soc_dapm_link_dai_widgets(struct snd_soc_card *card);
402void snd_soc_dapm_connect_dai_link_widgets(struct snd_soc_card *card);
403int snd_soc_dapm_new_pcm(struct snd_soc_card *card,
404 const struct snd_soc_pcm_stream *params,
405 unsigned int num_params,
406 struct snd_soc_dapm_widget *source,
407 struct snd_soc_dapm_widget *sink);
408
409/* dapm path setup */
410int snd_soc_dapm_new_widgets(struct snd_soc_card *card);
411void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
412int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
413 const struct snd_soc_dapm_route *route, int num);
414int snd_soc_dapm_del_routes(struct snd_soc_dapm_context *dapm,
415 const struct snd_soc_dapm_route *route, int num);
416int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm,
417 const struct snd_soc_dapm_route *route, int num);
418void snd_soc_dapm_free_widget(struct snd_soc_dapm_widget *w);
419void snd_soc_dapm_reset_cache(struct snd_soc_dapm_context *dapm);
420
421/* dapm events */
422void snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd, int stream,
423 int event);
424void snd_soc_dapm_shutdown(struct snd_soc_card *card);
425
426/* external DAPM widget events */
427int snd_soc_dapm_mixer_update_power(struct snd_soc_dapm_context *dapm,
428 struct snd_kcontrol *kcontrol, int connect,
429 struct snd_soc_dapm_update *update);
430int snd_soc_dapm_mux_update_power(struct snd_soc_dapm_context *dapm,
431 struct snd_kcontrol *kcontrol, int mux, struct soc_enum *e,
432 struct snd_soc_dapm_update *update);
433
434/* dapm sys fs - used by the core */
435extern struct attribute *soc_dapm_dev_attrs[];
436void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm,
437 struct dentry *parent);
438
439/* dapm audio pin control and status */
440int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
441 const char *pin);
442int snd_soc_dapm_enable_pin_unlocked(struct snd_soc_dapm_context *dapm,
443 const char *pin);
444int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
445 const char *pin);
446int snd_soc_dapm_disable_pin_unlocked(struct snd_soc_dapm_context *dapm,
447 const char *pin);
448int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
449int snd_soc_dapm_nc_pin_unlocked(struct snd_soc_dapm_context *dapm,
450 const char *pin);
451int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
452 const char *pin);
453int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
454int snd_soc_dapm_sync_unlocked(struct snd_soc_dapm_context *dapm);
455int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
456 const char *pin);
457int snd_soc_dapm_force_enable_pin_unlocked(struct snd_soc_dapm_context *dapm,
458 const char *pin);
459int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
460 const char *pin);
461unsigned int dapm_kcontrol_get_value(const struct snd_kcontrol *kcontrol);
462
463/* Mostly internal - should not normally be used */
464void dapm_mark_endpoints_dirty(struct snd_soc_card *card);
465
466/* dapm path query */
467int snd_soc_dapm_dai_get_connected_widgets(struct snd_soc_dai *dai, int stream,
468 struct snd_soc_dapm_widget_list **list,
469 bool (*custom_stop_condition)(struct snd_soc_dapm_widget *,
470 enum snd_soc_dapm_direction));
471
472struct snd_soc_dapm_context *snd_soc_dapm_kcontrol_dapm(
473 struct snd_kcontrol *kcontrol);
474
475struct snd_soc_dapm_widget *snd_soc_dapm_kcontrol_widget(
476 struct snd_kcontrol *kcontrol);
477
478int snd_soc_dapm_force_bias_level(struct snd_soc_dapm_context *dapm,
479 enum snd_soc_bias_level level);
480
481/* dapm widget types */
482enum snd_soc_dapm_type {
483 snd_soc_dapm_input = 0, /* input pin */
484 snd_soc_dapm_output, /* output pin */
485 snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */
486 snd_soc_dapm_demux, /* connects the input to one of multiple outputs */
487 snd_soc_dapm_mixer, /* mixes several analog signals together */
488 snd_soc_dapm_mixer_named_ctl, /* mixer with named controls */
489 snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */
490 snd_soc_dapm_out_drv, /* output driver */
491 snd_soc_dapm_adc, /* analog to digital converter */
492 snd_soc_dapm_dac, /* digital to analog converter */
493 snd_soc_dapm_micbias, /* microphone bias (power) - DEPRECATED: use snd_soc_dapm_supply */
494 snd_soc_dapm_mic, /* microphone */
495 snd_soc_dapm_hp, /* headphones */
496 snd_soc_dapm_spk, /* speaker */
497 snd_soc_dapm_line, /* line input/output */
498 snd_soc_dapm_switch, /* analog switch */
499 snd_soc_dapm_vmid, /* codec bias/vmid - to minimise pops */
500 snd_soc_dapm_pre, /* machine specific pre widget - exec first */
501 snd_soc_dapm_post, /* machine specific post widget - exec last */
502 snd_soc_dapm_supply, /* power/clock supply */
503 snd_soc_dapm_regulator_supply, /* external regulator */
504 snd_soc_dapm_clock_supply, /* external clock */
505 snd_soc_dapm_aif_in, /* audio interface input */
506 snd_soc_dapm_aif_out, /* audio interface output */
507 snd_soc_dapm_siggen, /* signal generator */
508 snd_soc_dapm_sink,
509 snd_soc_dapm_dai_in, /* link to DAI structure */
510 snd_soc_dapm_dai_out,
511 snd_soc_dapm_dai_link, /* link between two DAI structures */
512 snd_soc_dapm_kcontrol, /* Auto-disabled kcontrol */
513};
514
515enum snd_soc_dapm_subclass {
516 SND_SOC_DAPM_CLASS_INIT = 0,
517 SND_SOC_DAPM_CLASS_RUNTIME = 1,
518};
519
520/*
521 * DAPM audio route definition.
522 *
523 * Defines an audio route originating at source via control and finishing
524 * at sink.
525 */
526struct snd_soc_dapm_route {
527 const char *sink;
528 const char *control;
529 const char *source;
530
531 /* Note: currently only supported for links where source is a supply */
532 int (*connected)(struct snd_soc_dapm_widget *source,
533 struct snd_soc_dapm_widget *sink);
534};
535
536/* dapm audio path between two widgets */
537struct snd_soc_dapm_path {
538 const char *name;
539
540 /*
541 * source (input) and sink (output) widgets
542 * The union is for convience, since it is a lot nicer to type
543 * p->source, rather than p->node[SND_SOC_DAPM_DIR_IN]
544 */
545 union {
546 struct {
547 struct snd_soc_dapm_widget *source;
548 struct snd_soc_dapm_widget *sink;
549 };
550 struct snd_soc_dapm_widget *node[2];
551 };
552
553 /* status */
554 u32 connect:1; /* source and sink widgets are connected */
555 u32 walking:1; /* path is in the process of being walked */
556 u32 weak:1; /* path ignored for power management */
557 u32 is_supply:1; /* At least one of the connected widgets is a supply */
558
559 int (*connected)(struct snd_soc_dapm_widget *source,
560 struct snd_soc_dapm_widget *sink);
561
562 struct list_head list_node[2];
563 struct list_head list_kcontrol;
564 struct list_head list;
565};
566
567/* dapm widget */
568struct snd_soc_dapm_widget {
569 enum snd_soc_dapm_type id;
570 const char *name; /* widget name */
571 const char *sname; /* stream name */
572 struct list_head list;
573 struct snd_soc_dapm_context *dapm;
574
575 void *priv; /* widget specific data */
576 struct regulator *regulator; /* attached regulator */
577 const struct snd_soc_pcm_stream *params; /* params for dai links */
578 unsigned int num_params; /* number of params for dai links */
579 unsigned int params_select; /* currently selected param for dai link */
580
581 /* dapm control */
582 int reg; /* negative reg = no direct dapm */
583 unsigned char shift; /* bits to shift */
584 unsigned int mask; /* non-shifted mask */
585 unsigned int on_val; /* on state value */
586 unsigned int off_val; /* off state value */
587 unsigned char power:1; /* block power status */
588 unsigned char active:1; /* active stream on DAC, ADC's */
589 unsigned char connected:1; /* connected codec pin */
590 unsigned char new:1; /* cnew complete */
591 unsigned char force:1; /* force state */
592 unsigned char ignore_suspend:1; /* kept enabled over suspend */
593 unsigned char new_power:1; /* power from this run */
594 unsigned char power_checked:1; /* power checked this run */
595 unsigned char is_supply:1; /* Widget is a supply type widget */
596 unsigned char is_ep:2; /* Widget is a endpoint type widget */
597 int subseq; /* sort within widget type */
598
599 int (*power_check)(struct snd_soc_dapm_widget *w);
600
601 /* external events */
602 unsigned short event_flags; /* flags to specify event types */
603 int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
604
605 /* kcontrols that relate to this widget */
606 int num_kcontrols;
607 const struct snd_kcontrol_new *kcontrol_news;
608 struct snd_kcontrol **kcontrols;
609 struct snd_soc_dobj dobj;
610
611 /* widget input and output edges */
612 struct list_head edges[2];
613
614 /* used during DAPM updates */
615 struct list_head work_list;
616 struct list_head power_list;
617 struct list_head dirty;
618 int endpoints[2];
619
620 struct clk *clk;
621};
622
623struct snd_soc_dapm_update {
624 struct snd_kcontrol *kcontrol;
625 int reg;
626 int mask;
627 int val;
628 int reg2;
629 int mask2;
630 int val2;
631 bool has_second_set;
632};
633
634struct snd_soc_dapm_wcache {
635 struct snd_soc_dapm_widget *widget;
636};
637
638/* DAPM context */
639struct snd_soc_dapm_context {
640 enum snd_soc_bias_level bias_level;
641 unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
642 /* Go to BIAS_OFF in suspend if the DAPM context is idle */
643 unsigned int suspend_bias_off:1;
644 void (*seq_notifier)(struct snd_soc_dapm_context *,
645 enum snd_soc_dapm_type, int);
646
647 struct device *dev; /* from parent - for debug */
648 struct snd_soc_component *component; /* parent component */
649 struct snd_soc_card *card; /* parent card */
650
651 /* used during DAPM updates */
652 enum snd_soc_bias_level target_bias_level;
653 struct list_head list;
654
655 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
656 int (*set_bias_level)(struct snd_soc_dapm_context *dapm,
657 enum snd_soc_bias_level level);
658
659 struct snd_soc_dapm_wcache path_sink_cache;
660 struct snd_soc_dapm_wcache path_source_cache;
661
662#ifdef CONFIG_DEBUG_FS
663 struct dentry *debugfs_dapm;
664#endif
665};
666
667/* A list of widgets associated with an object, typically a snd_kcontrol */
668struct snd_soc_dapm_widget_list {
669 int num_widgets;
670 struct snd_soc_dapm_widget *widgets[0];
671};
672
673struct snd_soc_dapm_stats {
674 int power_checks;
675 int path_checks;
676 int neighbour_checks;
677};
678
679/**
680 * snd_soc_dapm_init_bias_level() - Initialize DAPM bias level
681 * @dapm: The DAPM context to initialize
682 * @level: The DAPM level to initialize to
683 *
684 * This function only sets the driver internal state of the DAPM level and will
685 * not modify the state of the device. Hence it should not be used during normal
686 * operation, but only to synchronize the internal state to the device state.
687 * E.g. during driver probe to set the DAPM level to the one corresponding with
688 * the power-on reset state of the device.
689 *
690 * To change the DAPM state of the device use snd_soc_dapm_set_bias_level().
691 */
692static inline void snd_soc_dapm_init_bias_level(
693 struct snd_soc_dapm_context *dapm, enum snd_soc_bias_level level)
694{
695 dapm->bias_level = level;
696}
697
698/**
699 * snd_soc_dapm_get_bias_level() - Get current DAPM bias level
700 * @dapm: The context for which to get the bias level
701 *
702 * Returns: The current bias level of the passed DAPM context.
703 */
704static inline enum snd_soc_bias_level snd_soc_dapm_get_bias_level(
705 struct snd_soc_dapm_context *dapm)
706{
707 return dapm->bias_level;
708}
709
710enum snd_soc_dapm_direction {
711 SND_SOC_DAPM_DIR_IN,
712 SND_SOC_DAPM_DIR_OUT
713};
714
715#define SND_SOC_DAPM_DIR_TO_EP(x) BIT(x)
716
717#define SND_SOC_DAPM_EP_SOURCE SND_SOC_DAPM_DIR_TO_EP(SND_SOC_DAPM_DIR_IN)
718#define SND_SOC_DAPM_EP_SINK SND_SOC_DAPM_DIR_TO_EP(SND_SOC_DAPM_DIR_OUT)
719
720/**
721 * snd_soc_dapm_widget_for_each_sink_path - Iterates over all paths in the
722 * specified direction of a widget
723 * @w: The widget
724 * @dir: Whether to iterate over the paths where the specified widget is the
725 * incoming or outgoing widgets
726 * @p: The path iterator variable
727 */
728#define snd_soc_dapm_widget_for_each_path(w, dir, p) \
729 list_for_each_entry(p, &w->edges[dir], list_node[dir])
730
731/**
732 * snd_soc_dapm_widget_for_each_sink_path_safe - Iterates over all paths in the
733 * specified direction of a widget
734 * @w: The widget
735 * @dir: Whether to iterate over the paths where the specified widget is the
736 * incoming or outgoing widgets
737 * @p: The path iterator variable
738 * @next_p: Temporary storage for the next path
739 *
740 * This function works like snd_soc_dapm_widget_for_each_sink_path, expect that
741 * it is safe to remove the current path from the list while iterating
742 */
743#define snd_soc_dapm_widget_for_each_path_safe(w, dir, p, next_p) \
744 list_for_each_entry_safe(p, next_p, &w->edges[dir], list_node[dir])
745
746/**
747 * snd_soc_dapm_widget_for_each_sink_path - Iterates over all paths leaving a
748 * widget
749 * @w: The widget
750 * @p: The path iterator variable
751 */
752#define snd_soc_dapm_widget_for_each_sink_path(w, p) \
753 snd_soc_dapm_widget_for_each_path(w, SND_SOC_DAPM_DIR_IN, p)
754
755/**
756 * snd_soc_dapm_widget_for_each_source_path - Iterates over all paths leading to
757 * a widget
758 * @w: The widget
759 * @p: The path iterator variable
760 */
761#define snd_soc_dapm_widget_for_each_source_path(w, p) \
762 snd_soc_dapm_widget_for_each_path(w, SND_SOC_DAPM_DIR_OUT, p)
763
764#endif
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
19struct 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#define SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) \
74 .reg = wreg, .mask = 1, .shift = wshift, \
75 .on_val = winvert ? 0 : 1, .off_val = winvert ? 1 : 0
76
77/* path domain */
78#define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\
79 wcontrols, wncontrols) \
80{ .id = snd_soc_dapm_pga, .name = wname, \
81 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
82 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
83#define SND_SOC_DAPM_OUT_DRV(wname, wreg, wshift, winvert,\
84 wcontrols, wncontrols) \
85{ .id = snd_soc_dapm_out_drv, .name = wname, \
86 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
87 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
88#define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
89 wcontrols, wncontrols)\
90{ .id = snd_soc_dapm_mixer, .name = wname, \
91 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
92 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
93#define SND_SOC_DAPM_MIXER_NAMED_CTL(wname, wreg, wshift, winvert, \
94 wcontrols, wncontrols)\
95{ .id = snd_soc_dapm_mixer_named_ctl, .name = wname, \
96 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
97 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
98#define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
99{ .id = snd_soc_dapm_micbias, .name = wname, \
100 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
101 .kcontrol_news = NULL, .num_kcontrols = 0}
102#define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
103{ .id = snd_soc_dapm_switch, .name = wname, \
104 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
105 .kcontrol_news = wcontrols, .num_kcontrols = 1}
106#define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
107{ .id = snd_soc_dapm_mux, .name = wname, \
108 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
109 .kcontrol_news = wcontrols, .num_kcontrols = 1}
110#define SND_SOC_DAPM_VIRT_MUX(wname, wreg, wshift, winvert, wcontrols) \
111 SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols)
112#define SND_SOC_DAPM_VALUE_MUX(wname, wreg, wshift, winvert, wcontrols) \
113 SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols)
114
115/* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
116#define SOC_PGA_ARRAY(wname, wreg, wshift, winvert,\
117 wcontrols) \
118{ .id = snd_soc_dapm_pga, .name = wname, \
119 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
120 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
121#define SOC_MIXER_ARRAY(wname, wreg, wshift, winvert, \
122 wcontrols)\
123{ .id = snd_soc_dapm_mixer, .name = wname, \
124 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
125 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
126#define SOC_MIXER_NAMED_CTL_ARRAY(wname, wreg, wshift, winvert, \
127 wcontrols)\
128{ .id = snd_soc_dapm_mixer_named_ctl, .name = wname, \
129 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
130 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
131
132/* path domain with event - event handler must return 0 for success */
133#define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \
134 wncontrols, wevent, wflags) \
135{ .id = snd_soc_dapm_pga, .name = wname, \
136 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
137 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
138 .event = wevent, .event_flags = wflags}
139#define SND_SOC_DAPM_OUT_DRV_E(wname, wreg, wshift, winvert, wcontrols, \
140 wncontrols, wevent, wflags) \
141{ .id = snd_soc_dapm_out_drv, .name = wname, \
142 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
143 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
144 .event = wevent, .event_flags = wflags}
145#define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \
146 wncontrols, wevent, wflags) \
147{ .id = snd_soc_dapm_mixer, .name = wname, \
148 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
149 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
150 .event = wevent, .event_flags = wflags}
151#define SND_SOC_DAPM_MIXER_NAMED_CTL_E(wname, wreg, wshift, winvert, \
152 wcontrols, wncontrols, wevent, wflags) \
153{ .id = snd_soc_dapm_mixer, .name = wname, \
154 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
155 .kcontrol_news = wcontrols, \
156 .num_kcontrols = wncontrols, .event = wevent, .event_flags = wflags}
157#define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
158 wevent, wflags) \
159{ .id = snd_soc_dapm_switch, .name = wname, \
160 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
161 .kcontrol_news = wcontrols, .num_kcontrols = 1, \
162 .event = wevent, .event_flags = wflags}
163#define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
164 wevent, wflags) \
165{ .id = snd_soc_dapm_mux, .name = wname, \
166 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
167 .kcontrol_news = wcontrols, .num_kcontrols = 1, \
168 .event = wevent, .event_flags = wflags}
169#define SND_SOC_DAPM_VIRT_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
170 wevent, wflags) \
171 SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, wevent, \
172 wflags)
173
174/* additional sequencing control within an event type */
175#define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \
176 wevent, wflags) \
177{ .id = snd_soc_dapm_pga, .name = wname, \
178 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
179 .event = wevent, .event_flags = wflags, \
180 .subseq = wsubseq}
181#define SND_SOC_DAPM_SUPPLY_S(wname, wsubseq, wreg, wshift, winvert, wevent, \
182 wflags) \
183{ .id = snd_soc_dapm_supply, .name = wname, \
184 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
185 .event = wevent, .event_flags = wflags, .subseq = wsubseq}
186
187/* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
188#define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
189 wevent, wflags) \
190{ .id = snd_soc_dapm_pga, .name = wname, \
191 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
192 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
193 .event = wevent, .event_flags = wflags}
194#define SOC_MIXER_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
195 wevent, wflags) \
196{ .id = snd_soc_dapm_mixer, .name = wname, \
197 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
198 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
199 .event = wevent, .event_flags = wflags}
200#define SOC_MIXER_NAMED_CTL_E_ARRAY(wname, wreg, wshift, winvert, \
201 wcontrols, wevent, wflags) \
202{ .id = snd_soc_dapm_mixer, .name = wname, \
203 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
204 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
205 .event = wevent, .event_flags = wflags}
206
207/* events that are pre and post DAPM */
208#define SND_SOC_DAPM_PRE(wname, wevent) \
209{ .id = snd_soc_dapm_pre, .name = wname, .kcontrol_news = NULL, \
210 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
211 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
212#define SND_SOC_DAPM_POST(wname, wevent) \
213{ .id = snd_soc_dapm_post, .name = wname, .kcontrol_news = NULL, \
214 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
215 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
216
217/* stream domain */
218#define SND_SOC_DAPM_AIF_IN(wname, stname, wslot, wreg, wshift, winvert) \
219{ .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
220 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
221#define SND_SOC_DAPM_AIF_IN_E(wname, stname, wslot, wreg, wshift, winvert, \
222 wevent, wflags) \
223{ .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
224 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
225 .event = wevent, .event_flags = wflags }
226#define SND_SOC_DAPM_AIF_OUT(wname, stname, wslot, wreg, wshift, winvert) \
227{ .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
228 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
229#define SND_SOC_DAPM_AIF_OUT_E(wname, stname, wslot, wreg, wshift, winvert, \
230 wevent, wflags) \
231{ .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
232 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
233 .event = wevent, .event_flags = wflags }
234#define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
235{ .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \
236 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) }
237#define SND_SOC_DAPM_DAC_E(wname, stname, wreg, wshift, winvert, \
238 wevent, wflags) \
239{ .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \
240 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
241 .event = wevent, .event_flags = wflags}
242
243#define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
244{ .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \
245 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
246#define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \
247 wevent, wflags) \
248{ .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \
249 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
250 .event = wevent, .event_flags = wflags}
251#define SND_SOC_DAPM_CLOCK_SUPPLY(wname) \
252{ .id = snd_soc_dapm_clock_supply, .name = wname, \
253 .reg = SND_SOC_NOPM, .event = dapm_clock_event, \
254 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD }
255
256/* generic widgets */
257#define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
258{ .id = wid, .name = wname, .kcontrol_news = NULL, .num_kcontrols = 0, \
259 .reg = -((wreg) + 1), .shift = wshift, .mask = wmask, \
260 .on_val = won_val, .off_val = woff_val, .event = dapm_reg_event, \
261 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
262#define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \
263{ .id = snd_soc_dapm_supply, .name = wname, \
264 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
265 .event = wevent, .event_flags = wflags}
266#define SND_SOC_DAPM_REGULATOR_SUPPLY(wname, wdelay, wflags) \
267{ .id = snd_soc_dapm_regulator_supply, .name = wname, \
268 .reg = SND_SOC_NOPM, .shift = wdelay, .event = dapm_regulator_event, \
269 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD, \
270 .on_val = wflags}
271
272
273/* dapm kcontrol types */
274#define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
275{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
276 .info = snd_soc_info_volsw, \
277 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
278 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
279#define SOC_DAPM_SINGLE_AUTODISABLE(xname, reg, shift, max, invert) \
280{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
281 .info = snd_soc_info_volsw, \
282 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
283 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 1) }
284#define SOC_DAPM_SINGLE_VIRT(xname, max) \
285 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0)
286#define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
287{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
288 .info = snd_soc_info_volsw, \
289 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
290 .tlv.p = (tlv_array), \
291 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
292 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
293#define SOC_DAPM_SINGLE_TLV_AUTODISABLE(xname, reg, shift, max, invert, tlv_array) \
294{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
295 .info = snd_soc_info_volsw, \
296 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
297 .tlv.p = (tlv_array), \
298 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
299 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
300#define SOC_DAPM_SINGLE_TLV_VIRT(xname, max, tlv_array) \
301 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0, tlv_array)
302#define SOC_DAPM_ENUM(xname, xenum) \
303{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
304 .info = snd_soc_info_enum_double, \
305 .get = snd_soc_dapm_get_enum_double, \
306 .put = snd_soc_dapm_put_enum_double, \
307 .private_value = (unsigned long)&xenum }
308#define SOC_DAPM_ENUM_VIRT(xname, xenum) \
309 SOC_DAPM_ENUM(xname, xenum)
310#define SOC_DAPM_ENUM_EXT(xname, xenum, xget, xput) \
311{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
312 .info = snd_soc_info_enum_double, \
313 .get = xget, \
314 .put = xput, \
315 .private_value = (unsigned long)&xenum }
316#define SOC_DAPM_VALUE_ENUM(xname, xenum) \
317 SOC_DAPM_ENUM(xname, xenum)
318#define SOC_DAPM_PIN_SWITCH(xname) \
319{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
320 .info = snd_soc_dapm_info_pin_switch, \
321 .get = snd_soc_dapm_get_pin_switch, \
322 .put = snd_soc_dapm_put_pin_switch, \
323 .private_value = (unsigned long)xname }
324
325/* dapm stream operations */
326#define SND_SOC_DAPM_STREAM_NOP 0x0
327#define SND_SOC_DAPM_STREAM_START 0x1
328#define SND_SOC_DAPM_STREAM_STOP 0x2
329#define SND_SOC_DAPM_STREAM_SUSPEND 0x4
330#define SND_SOC_DAPM_STREAM_RESUME 0x8
331#define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10
332#define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20
333
334/* dapm event types */
335#define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */
336#define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */
337#define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */
338#define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */
339#define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */
340#define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */
341#define SND_SOC_DAPM_WILL_PMU 0x40 /* called at start of sequence */
342#define SND_SOC_DAPM_WILL_PMD 0x80 /* called at start of sequence */
343#define SND_SOC_DAPM_PRE_POST_PMD \
344 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
345
346/* convenience event type detection */
347#define SND_SOC_DAPM_EVENT_ON(e) \
348 (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
349#define SND_SOC_DAPM_EVENT_OFF(e) \
350 (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
351
352/* regulator widget flags */
353#define SND_SOC_DAPM_REGULATOR_BYPASS 0x1 /* bypass when disabled */
354
355struct snd_soc_dapm_widget;
356enum snd_soc_dapm_type;
357struct snd_soc_dapm_path;
358struct snd_soc_dapm_pin;
359struct snd_soc_dapm_route;
360struct snd_soc_dapm_context;
361struct regulator;
362struct snd_soc_dapm_widget_list;
363struct snd_soc_dapm_update;
364
365int dapm_reg_event(struct snd_soc_dapm_widget *w,
366 struct snd_kcontrol *kcontrol, int event);
367int dapm_regulator_event(struct snd_soc_dapm_widget *w,
368 struct snd_kcontrol *kcontrol, int event);
369int dapm_clock_event(struct snd_soc_dapm_widget *w,
370 struct snd_kcontrol *kcontrol, int event);
371
372/* dapm controls */
373int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
374 struct snd_ctl_elem_value *ucontrol);
375int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
376 struct snd_ctl_elem_value *ucontrol);
377int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
378 struct snd_ctl_elem_value *ucontrol);
379int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
380 struct snd_ctl_elem_value *ucontrol);
381int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
382 struct snd_ctl_elem_info *uinfo);
383int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
384 struct snd_ctl_elem_value *uncontrol);
385int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
386 struct snd_ctl_elem_value *uncontrol);
387int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
388 const struct snd_soc_dapm_widget *widget,
389 int num);
390int snd_soc_dapm_new_dai_widgets(struct snd_soc_dapm_context *dapm,
391 struct snd_soc_dai *dai);
392int snd_soc_dapm_link_dai_widgets(struct snd_soc_card *card);
393void snd_soc_dapm_connect_dai_link_widgets(struct snd_soc_card *card);
394int snd_soc_dapm_new_pcm(struct snd_soc_card *card,
395 const struct snd_soc_pcm_stream *params,
396 struct snd_soc_dapm_widget *source,
397 struct snd_soc_dapm_widget *sink);
398
399/* dapm path setup */
400int snd_soc_dapm_new_widgets(struct snd_soc_card *card);
401void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
402int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
403 const struct snd_soc_dapm_route *route, int num);
404int snd_soc_dapm_del_routes(struct snd_soc_dapm_context *dapm,
405 const struct snd_soc_dapm_route *route, int num);
406int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm,
407 const struct snd_soc_dapm_route *route, int num);
408
409/* dapm events */
410void snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd, int stream,
411 int event);
412void snd_soc_dapm_shutdown(struct snd_soc_card *card);
413
414/* external DAPM widget events */
415int snd_soc_dapm_mixer_update_power(struct snd_soc_dapm_context *dapm,
416 struct snd_kcontrol *kcontrol, int connect,
417 struct snd_soc_dapm_update *update);
418int snd_soc_dapm_mux_update_power(struct snd_soc_dapm_context *dapm,
419 struct snd_kcontrol *kcontrol, int mux, struct soc_enum *e,
420 struct snd_soc_dapm_update *update);
421
422/* dapm sys fs - used by the core */
423int snd_soc_dapm_sys_add(struct device *dev);
424void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm,
425 struct dentry *parent);
426
427/* dapm audio pin control and status */
428int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
429 const char *pin);
430int snd_soc_dapm_enable_pin_unlocked(struct snd_soc_dapm_context *dapm,
431 const char *pin);
432int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
433 const char *pin);
434int snd_soc_dapm_disable_pin_unlocked(struct snd_soc_dapm_context *dapm,
435 const char *pin);
436int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
437int snd_soc_dapm_nc_pin_unlocked(struct snd_soc_dapm_context *dapm,
438 const char *pin);
439int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
440 const char *pin);
441int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
442int snd_soc_dapm_sync_unlocked(struct snd_soc_dapm_context *dapm);
443int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
444 const char *pin);
445int snd_soc_dapm_force_enable_pin_unlocked(struct snd_soc_dapm_context *dapm,
446 const char *pin);
447int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
448 const char *pin);
449void snd_soc_dapm_auto_nc_codec_pins(struct snd_soc_codec *codec);
450
451/* Mostly internal - should not normally be used */
452void dapm_mark_io_dirty(struct snd_soc_dapm_context *dapm);
453
454/* dapm path query */
455int snd_soc_dapm_dai_get_connected_widgets(struct snd_soc_dai *dai, int stream,
456 struct snd_soc_dapm_widget_list **list);
457
458struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(struct snd_kcontrol *kcontrol);
459
460/* dapm widget types */
461enum snd_soc_dapm_type {
462 snd_soc_dapm_input = 0, /* input pin */
463 snd_soc_dapm_output, /* output pin */
464 snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */
465 snd_soc_dapm_mixer, /* mixes several analog signals together */
466 snd_soc_dapm_mixer_named_ctl, /* mixer with named controls */
467 snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */
468 snd_soc_dapm_out_drv, /* output driver */
469 snd_soc_dapm_adc, /* analog to digital converter */
470 snd_soc_dapm_dac, /* digital to analog converter */
471 snd_soc_dapm_micbias, /* microphone bias (power) */
472 snd_soc_dapm_mic, /* microphone */
473 snd_soc_dapm_hp, /* headphones */
474 snd_soc_dapm_spk, /* speaker */
475 snd_soc_dapm_line, /* line input/output */
476 snd_soc_dapm_switch, /* analog switch */
477 snd_soc_dapm_vmid, /* codec bias/vmid - to minimise pops */
478 snd_soc_dapm_pre, /* machine specific pre widget - exec first */
479 snd_soc_dapm_post, /* machine specific post widget - exec last */
480 snd_soc_dapm_supply, /* power/clock supply */
481 snd_soc_dapm_regulator_supply, /* external regulator */
482 snd_soc_dapm_clock_supply, /* external clock */
483 snd_soc_dapm_aif_in, /* audio interface input */
484 snd_soc_dapm_aif_out, /* audio interface output */
485 snd_soc_dapm_siggen, /* signal generator */
486 snd_soc_dapm_dai_in, /* link to DAI structure */
487 snd_soc_dapm_dai_out,
488 snd_soc_dapm_dai_link, /* link between two DAI structures */
489 snd_soc_dapm_kcontrol, /* Auto-disabled kcontrol */
490};
491
492enum snd_soc_dapm_subclass {
493 SND_SOC_DAPM_CLASS_INIT = 0,
494 SND_SOC_DAPM_CLASS_RUNTIME = 1,
495};
496
497/*
498 * DAPM audio route definition.
499 *
500 * Defines an audio route originating at source via control and finishing
501 * at sink.
502 */
503struct snd_soc_dapm_route {
504 const char *sink;
505 const char *control;
506 const char *source;
507
508 /* Note: currently only supported for links where source is a supply */
509 int (*connected)(struct snd_soc_dapm_widget *source,
510 struct snd_soc_dapm_widget *sink);
511};
512
513/* dapm audio path between two widgets */
514struct snd_soc_dapm_path {
515 const char *name;
516
517 /* source (input) and sink (output) widgets */
518 struct snd_soc_dapm_widget *source;
519 struct snd_soc_dapm_widget *sink;
520
521 /* status */
522 u32 connect:1; /* source and sink widgets are connected */
523 u32 walked:1; /* path has been walked */
524 u32 walking:1; /* path is in the process of being walked */
525 u32 weak:1; /* path ignored for power management */
526
527 int (*connected)(struct snd_soc_dapm_widget *source,
528 struct snd_soc_dapm_widget *sink);
529
530 struct list_head list_source;
531 struct list_head list_sink;
532 struct list_head list_kcontrol;
533 struct list_head list;
534};
535
536/* dapm widget */
537struct snd_soc_dapm_widget {
538 enum snd_soc_dapm_type id;
539 const char *name; /* widget name */
540 const char *sname; /* stream name */
541 struct snd_soc_codec *codec;
542 struct snd_soc_platform *platform;
543 struct list_head list;
544 struct snd_soc_dapm_context *dapm;
545
546 void *priv; /* widget specific data */
547 struct regulator *regulator; /* attached regulator */
548 const struct snd_soc_pcm_stream *params; /* params for dai links */
549
550 /* dapm control */
551 int reg; /* negative reg = no direct dapm */
552 unsigned char shift; /* bits to shift */
553 unsigned int mask; /* non-shifted mask */
554 unsigned int on_val; /* on state value */
555 unsigned int off_val; /* off state value */
556 unsigned char power:1; /* block power status */
557 unsigned char active:1; /* active stream on DAC, ADC's */
558 unsigned char connected:1; /* connected codec pin */
559 unsigned char new:1; /* cnew complete */
560 unsigned char ext:1; /* has external widgets */
561 unsigned char force:1; /* force state */
562 unsigned char ignore_suspend:1; /* kept enabled over suspend */
563 unsigned char new_power:1; /* power from this run */
564 unsigned char power_checked:1; /* power checked this run */
565 int subseq; /* sort within widget type */
566
567 int (*power_check)(struct snd_soc_dapm_widget *w);
568
569 /* external events */
570 unsigned short event_flags; /* flags to specify event types */
571 int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
572
573 /* kcontrols that relate to this widget */
574 int num_kcontrols;
575 const struct snd_kcontrol_new *kcontrol_news;
576 struct snd_kcontrol **kcontrols;
577
578 /* widget input and outputs */
579 struct list_head sources;
580 struct list_head sinks;
581
582 /* used during DAPM updates */
583 struct list_head power_list;
584 struct list_head dirty;
585 int inputs;
586 int outputs;
587
588 struct clk *clk;
589};
590
591struct snd_soc_dapm_update {
592 struct snd_kcontrol *kcontrol;
593 int reg;
594 int mask;
595 int val;
596};
597
598/* DAPM context */
599struct snd_soc_dapm_context {
600 enum snd_soc_bias_level bias_level;
601 enum snd_soc_bias_level suspend_bias_level;
602 struct delayed_work delayed_work;
603 unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
604
605 void (*seq_notifier)(struct snd_soc_dapm_context *,
606 enum snd_soc_dapm_type, int);
607
608 struct device *dev; /* from parent - for debug */
609 struct snd_soc_codec *codec; /* parent codec */
610 struct snd_soc_platform *platform; /* parent platform */
611 struct snd_soc_card *card; /* parent card */
612
613 /* used during DAPM updates */
614 enum snd_soc_bias_level target_bias_level;
615 struct list_head list;
616
617 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
618
619#ifdef CONFIG_DEBUG_FS
620 struct dentry *debugfs_dapm;
621#endif
622};
623
624/* A list of widgets associated with an object, typically a snd_kcontrol */
625struct snd_soc_dapm_widget_list {
626 int num_widgets;
627 struct snd_soc_dapm_widget *widgets[0];
628};
629
630struct snd_soc_dapm_stats {
631 int power_checks;
632 int path_checks;
633 int neighbour_checks;
634};
635
636#endif