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