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#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#define SND_SOC_DAPM_PINCTRL(wname, active, sleep) \
273{ .id = snd_soc_dapm_pinctrl, .name = wname, \
274 .priv = (&(struct snd_soc_dapm_pinctrl_priv) \
275 { .active_state = active, .sleep_state = sleep,}), \
276 .reg = SND_SOC_NOPM, .event = dapm_pinctrl_event, \
277 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD }
278
279
280
281/* dapm kcontrol types */
282#define SOC_DAPM_DOUBLE(xname, reg, lshift, rshift, max, invert) \
283{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
284 .info = snd_soc_info_volsw, \
285 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
286 .private_value = SOC_DOUBLE_VALUE(reg, lshift, rshift, max, invert, 0) }
287#define SOC_DAPM_DOUBLE_R(xname, lreg, rreg, shift, max, invert) \
288{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
289 .info = snd_soc_info_volsw, \
290 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
291 .private_value = SOC_DOUBLE_R_VALUE(lreg, rreg, shift, max, invert) }
292#define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
293{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
294 .info = snd_soc_info_volsw, \
295 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
296 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
297#define SOC_DAPM_SINGLE_AUTODISABLE(xname, reg, shift, max, invert) \
298{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
299 .info = snd_soc_info_volsw, \
300 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
301 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 1) }
302#define SOC_DAPM_SINGLE_VIRT(xname, max) \
303 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0)
304#define SOC_DAPM_SINGLE_TLV(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, 0) }
311#define SOC_DAPM_SINGLE_TLV_AUTODISABLE(xname, reg, shift, max, invert, tlv_array) \
312{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
313 .info = snd_soc_info_volsw, \
314 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
315 .tlv.p = (tlv_array), \
316 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
317 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 1) }
318#define SOC_DAPM_SINGLE_TLV_VIRT(xname, max, tlv_array) \
319 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0, tlv_array)
320#define SOC_DAPM_ENUM(xname, xenum) \
321{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
322 .info = snd_soc_info_enum_double, \
323 .get = snd_soc_dapm_get_enum_double, \
324 .put = snd_soc_dapm_put_enum_double, \
325 .private_value = (unsigned long)&xenum }
326#define SOC_DAPM_ENUM_EXT(xname, xenum, xget, xput) \
327{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
328 .info = snd_soc_info_enum_double, \
329 .get = xget, \
330 .put = xput, \
331 .private_value = (unsigned long)&xenum }
332#define SOC_DAPM_PIN_SWITCH(xname) \
333{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
334 .info = snd_soc_dapm_info_pin_switch, \
335 .get = snd_soc_dapm_get_pin_switch, \
336 .put = snd_soc_dapm_put_pin_switch, \
337 .private_value = (unsigned long)xname }
338
339/* dapm stream operations */
340#define SND_SOC_DAPM_STREAM_NOP 0x0
341#define SND_SOC_DAPM_STREAM_START 0x1
342#define SND_SOC_DAPM_STREAM_STOP 0x2
343#define SND_SOC_DAPM_STREAM_SUSPEND 0x4
344#define SND_SOC_DAPM_STREAM_RESUME 0x8
345#define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10
346#define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20
347
348/* dapm event types */
349#define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */
350#define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */
351#define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */
352#define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */
353#define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */
354#define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */
355#define SND_SOC_DAPM_WILL_PMU 0x40 /* called at start of sequence */
356#define SND_SOC_DAPM_WILL_PMD 0x80 /* called at start of sequence */
357#define SND_SOC_DAPM_PRE_POST_PMD \
358 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
359
360/* convenience event type detection */
361#define SND_SOC_DAPM_EVENT_ON(e) \
362 (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
363#define SND_SOC_DAPM_EVENT_OFF(e) \
364 (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
365
366/* regulator widget flags */
367#define SND_SOC_DAPM_REGULATOR_BYPASS 0x1 /* bypass when disabled */
368
369struct snd_soc_dapm_widget;
370enum snd_soc_dapm_type;
371struct snd_soc_dapm_path;
372struct snd_soc_dapm_pin;
373struct snd_soc_dapm_route;
374struct snd_soc_dapm_context;
375struct regulator;
376struct snd_soc_dapm_widget_list;
377struct snd_soc_dapm_update;
378enum snd_soc_dapm_direction;
379
380int dapm_regulator_event(struct snd_soc_dapm_widget *w,
381 struct snd_kcontrol *kcontrol, int event);
382int dapm_clock_event(struct snd_soc_dapm_widget *w,
383 struct snd_kcontrol *kcontrol, int event);
384int dapm_pinctrl_event(struct snd_soc_dapm_widget *w,
385 struct snd_kcontrol *kcontrol, int event);
386
387/* dapm controls */
388int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
389 struct snd_ctl_elem_value *ucontrol);
390int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
391 struct snd_ctl_elem_value *ucontrol);
392int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
393 struct snd_ctl_elem_value *ucontrol);
394int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
395 struct snd_ctl_elem_value *ucontrol);
396int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
397 struct snd_ctl_elem_info *uinfo);
398int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
399 struct snd_ctl_elem_value *uncontrol);
400int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
401 struct snd_ctl_elem_value *uncontrol);
402int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
403 const struct snd_soc_dapm_widget *widget,
404 int num);
405struct snd_soc_dapm_widget *snd_soc_dapm_new_control(
406 struct snd_soc_dapm_context *dapm,
407 const struct snd_soc_dapm_widget *widget);
408int snd_soc_dapm_new_dai_widgets(struct snd_soc_dapm_context *dapm,
409 struct snd_soc_dai *dai);
410int snd_soc_dapm_link_dai_widgets(struct snd_soc_card *card);
411void snd_soc_dapm_connect_dai_link_widgets(struct snd_soc_card *card);
412int snd_soc_dapm_new_pcm(struct snd_soc_card *card,
413 const struct snd_soc_pcm_stream *params,
414 unsigned int num_params,
415 struct snd_soc_dapm_widget *source,
416 struct snd_soc_dapm_widget *sink);
417
418/* dapm path setup */
419int snd_soc_dapm_new_widgets(struct snd_soc_card *card);
420void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
421int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
422 const struct snd_soc_dapm_route *route, int num);
423int snd_soc_dapm_del_routes(struct snd_soc_dapm_context *dapm,
424 const struct snd_soc_dapm_route *route, int num);
425int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm,
426 const struct snd_soc_dapm_route *route, int num);
427void snd_soc_dapm_free_widget(struct snd_soc_dapm_widget *w);
428void snd_soc_dapm_reset_cache(struct snd_soc_dapm_context *dapm);
429
430/* dapm events */
431void snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd, int stream,
432 int event);
433void snd_soc_dapm_shutdown(struct snd_soc_card *card);
434
435/* external DAPM widget events */
436int snd_soc_dapm_mixer_update_power(struct snd_soc_dapm_context *dapm,
437 struct snd_kcontrol *kcontrol, int connect,
438 struct snd_soc_dapm_update *update);
439int snd_soc_dapm_mux_update_power(struct snd_soc_dapm_context *dapm,
440 struct snd_kcontrol *kcontrol, int mux, struct soc_enum *e,
441 struct snd_soc_dapm_update *update);
442
443/* dapm sys fs - used by the core */
444extern struct attribute *soc_dapm_dev_attrs[];
445void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm,
446 struct dentry *parent);
447
448/* dapm audio pin control and status */
449int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
450 const char *pin);
451int snd_soc_dapm_enable_pin_unlocked(struct snd_soc_dapm_context *dapm,
452 const char *pin);
453int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
454 const char *pin);
455int snd_soc_dapm_disable_pin_unlocked(struct snd_soc_dapm_context *dapm,
456 const char *pin);
457int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
458int snd_soc_dapm_nc_pin_unlocked(struct snd_soc_dapm_context *dapm,
459 const char *pin);
460int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
461 const char *pin);
462int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
463int snd_soc_dapm_sync_unlocked(struct snd_soc_dapm_context *dapm);
464int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
465 const char *pin);
466int snd_soc_dapm_force_enable_pin_unlocked(struct snd_soc_dapm_context *dapm,
467 const char *pin);
468int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
469 const char *pin);
470unsigned int dapm_kcontrol_get_value(const struct snd_kcontrol *kcontrol);
471
472/* Mostly internal - should not normally be used */
473void dapm_mark_endpoints_dirty(struct snd_soc_card *card);
474
475/* dapm path query */
476int snd_soc_dapm_dai_get_connected_widgets(struct snd_soc_dai *dai, int stream,
477 struct snd_soc_dapm_widget_list **list,
478 bool (*custom_stop_condition)(struct snd_soc_dapm_widget *,
479 enum snd_soc_dapm_direction));
480
481struct snd_soc_dapm_context *snd_soc_dapm_kcontrol_dapm(
482 struct snd_kcontrol *kcontrol);
483
484struct snd_soc_dapm_widget *snd_soc_dapm_kcontrol_widget(
485 struct snd_kcontrol *kcontrol);
486
487int snd_soc_dapm_force_bias_level(struct snd_soc_dapm_context *dapm,
488 enum snd_soc_bias_level level);
489
490/* dapm widget types */
491enum snd_soc_dapm_type {
492 snd_soc_dapm_input = 0, /* input pin */
493 snd_soc_dapm_output, /* output pin */
494 snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */
495 snd_soc_dapm_demux, /* connects the input to one of multiple outputs */
496 snd_soc_dapm_mixer, /* mixes several analog signals together */
497 snd_soc_dapm_mixer_named_ctl, /* mixer with named controls */
498 snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */
499 snd_soc_dapm_out_drv, /* output driver */
500 snd_soc_dapm_adc, /* analog to digital converter */
501 snd_soc_dapm_dac, /* digital to analog converter */
502 snd_soc_dapm_micbias, /* microphone bias (power) - DEPRECATED: use snd_soc_dapm_supply */
503 snd_soc_dapm_mic, /* microphone */
504 snd_soc_dapm_hp, /* headphones */
505 snd_soc_dapm_spk, /* speaker */
506 snd_soc_dapm_line, /* line input/output */
507 snd_soc_dapm_switch, /* analog switch */
508 snd_soc_dapm_vmid, /* codec bias/vmid - to minimise pops */
509 snd_soc_dapm_pre, /* machine specific pre widget - exec first */
510 snd_soc_dapm_post, /* machine specific post widget - exec last */
511 snd_soc_dapm_supply, /* power/clock supply */
512 snd_soc_dapm_pinctrl, /* pinctrl */
513 snd_soc_dapm_regulator_supply, /* external regulator */
514 snd_soc_dapm_clock_supply, /* external clock */
515 snd_soc_dapm_aif_in, /* audio interface input */
516 snd_soc_dapm_aif_out, /* audio interface output */
517 snd_soc_dapm_siggen, /* signal generator */
518 snd_soc_dapm_sink,
519 snd_soc_dapm_dai_in, /* link to DAI structure */
520 snd_soc_dapm_dai_out,
521 snd_soc_dapm_dai_link, /* link between two DAI structures */
522 snd_soc_dapm_kcontrol, /* Auto-disabled kcontrol */
523 snd_soc_dapm_buffer, /* DSP/CODEC internal buffer */
524 snd_soc_dapm_scheduler, /* DSP/CODEC internal scheduler */
525 snd_soc_dapm_effect, /* DSP/CODEC effect component */
526 snd_soc_dapm_src, /* DSP/CODEC SRC component */
527 snd_soc_dapm_asrc, /* DSP/CODEC ASRC component */
528 snd_soc_dapm_encoder, /* FW/SW audio encoder component */
529 snd_soc_dapm_decoder, /* FW/SW audio decoder component */
530};
531
532enum snd_soc_dapm_subclass {
533 SND_SOC_DAPM_CLASS_INIT = 0,
534 SND_SOC_DAPM_CLASS_RUNTIME = 1,
535};
536
537/*
538 * DAPM audio route definition.
539 *
540 * Defines an audio route originating at source via control and finishing
541 * at sink.
542 */
543struct snd_soc_dapm_route {
544 const char *sink;
545 const char *control;
546 const char *source;
547
548 /* Note: currently only supported for links where source is a supply */
549 int (*connected)(struct snd_soc_dapm_widget *source,
550 struct snd_soc_dapm_widget *sink);
551};
552
553/* dapm audio path between two widgets */
554struct snd_soc_dapm_path {
555 const char *name;
556
557 /*
558 * source (input) and sink (output) widgets
559 * The union is for convience, since it is a lot nicer to type
560 * p->source, rather than p->node[SND_SOC_DAPM_DIR_IN]
561 */
562 union {
563 struct {
564 struct snd_soc_dapm_widget *source;
565 struct snd_soc_dapm_widget *sink;
566 };
567 struct snd_soc_dapm_widget *node[2];
568 };
569
570 /* status */
571 u32 connect:1; /* source and sink widgets are connected */
572 u32 walking:1; /* path is in the process of being walked */
573 u32 weak:1; /* path ignored for power management */
574 u32 is_supply:1; /* At least one of the connected widgets is a supply */
575
576 int (*connected)(struct snd_soc_dapm_widget *source,
577 struct snd_soc_dapm_widget *sink);
578
579 struct list_head list_node[2];
580 struct list_head list_kcontrol;
581 struct list_head list;
582};
583
584/* dapm widget */
585struct snd_soc_dapm_widget {
586 enum snd_soc_dapm_type id;
587 const char *name; /* widget name */
588 const char *sname; /* stream name */
589 struct list_head list;
590 struct snd_soc_dapm_context *dapm;
591
592 void *priv; /* widget specific data */
593 struct regulator *regulator; /* attached regulator */
594 struct pinctrl *pinctrl; /* attached pinctrl */
595 const struct snd_soc_pcm_stream *params; /* params for dai links */
596 unsigned int num_params; /* number of params for dai links */
597 unsigned int params_select; /* currently selected param for dai link */
598
599 /* dapm control */
600 int reg; /* negative reg = no direct dapm */
601 unsigned char shift; /* bits to shift */
602 unsigned int mask; /* non-shifted mask */
603 unsigned int on_val; /* on state value */
604 unsigned int off_val; /* off state value */
605 unsigned char power:1; /* block power status */
606 unsigned char active:1; /* active stream on DAC, ADC's */
607 unsigned char connected:1; /* connected codec pin */
608 unsigned char new:1; /* cnew complete */
609 unsigned char force:1; /* force state */
610 unsigned char ignore_suspend:1; /* kept enabled over suspend */
611 unsigned char new_power:1; /* power from this run */
612 unsigned char power_checked:1; /* power checked this run */
613 unsigned char is_supply:1; /* Widget is a supply type widget */
614 unsigned char is_ep:2; /* Widget is a endpoint type widget */
615 int subseq; /* sort within widget type */
616
617 int (*power_check)(struct snd_soc_dapm_widget *w);
618
619 /* external events */
620 unsigned short event_flags; /* flags to specify event types */
621 int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
622
623 /* kcontrols that relate to this widget */
624 int num_kcontrols;
625 const struct snd_kcontrol_new *kcontrol_news;
626 struct snd_kcontrol **kcontrols;
627 struct snd_soc_dobj dobj;
628
629 /* widget input and output edges */
630 struct list_head edges[2];
631
632 /* used during DAPM updates */
633 struct list_head work_list;
634 struct list_head power_list;
635 struct list_head dirty;
636 int endpoints[2];
637
638 struct clk *clk;
639};
640
641struct snd_soc_dapm_update {
642 struct snd_kcontrol *kcontrol;
643 int reg;
644 int mask;
645 int val;
646 int reg2;
647 int mask2;
648 int val2;
649 bool has_second_set;
650};
651
652struct snd_soc_dapm_wcache {
653 struct snd_soc_dapm_widget *widget;
654};
655
656/* DAPM context */
657struct snd_soc_dapm_context {
658 enum snd_soc_bias_level bias_level;
659 unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
660 /* Go to BIAS_OFF in suspend if the DAPM context is idle */
661 unsigned int suspend_bias_off:1;
662 void (*seq_notifier)(struct snd_soc_dapm_context *,
663 enum snd_soc_dapm_type, int);
664
665 struct device *dev; /* from parent - for debug */
666 struct snd_soc_component *component; /* parent component */
667 struct snd_soc_card *card; /* parent card */
668
669 /* used during DAPM updates */
670 enum snd_soc_bias_level target_bias_level;
671 struct list_head list;
672
673 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
674 int (*set_bias_level)(struct snd_soc_dapm_context *dapm,
675 enum snd_soc_bias_level level);
676
677 struct snd_soc_dapm_wcache path_sink_cache;
678 struct snd_soc_dapm_wcache path_source_cache;
679
680#ifdef CONFIG_DEBUG_FS
681 struct dentry *debugfs_dapm;
682#endif
683};
684
685/* A list of widgets associated with an object, typically a snd_kcontrol */
686struct snd_soc_dapm_widget_list {
687 int num_widgets;
688 struct snd_soc_dapm_widget *widgets[0];
689};
690
691struct snd_soc_dapm_stats {
692 int power_checks;
693 int path_checks;
694 int neighbour_checks;
695};
696
697struct snd_soc_dapm_pinctrl_priv {
698 const char *active_state;
699 const char *sleep_state;
700};
701
702/**
703 * snd_soc_dapm_init_bias_level() - Initialize DAPM bias level
704 * @dapm: The DAPM context to initialize
705 * @level: The DAPM level to initialize to
706 *
707 * This function only sets the driver internal state of the DAPM level and will
708 * not modify the state of the device. Hence it should not be used during normal
709 * operation, but only to synchronize the internal state to the device state.
710 * E.g. during driver probe to set the DAPM level to the one corresponding with
711 * the power-on reset state of the device.
712 *
713 * To change the DAPM state of the device use snd_soc_dapm_set_bias_level().
714 */
715static inline void snd_soc_dapm_init_bias_level(
716 struct snd_soc_dapm_context *dapm, enum snd_soc_bias_level level)
717{
718 dapm->bias_level = level;
719}
720
721/**
722 * snd_soc_dapm_get_bias_level() - Get current DAPM bias level
723 * @dapm: The context for which to get the bias level
724 *
725 * Returns: The current bias level of the passed DAPM context.
726 */
727static inline enum snd_soc_bias_level snd_soc_dapm_get_bias_level(
728 struct snd_soc_dapm_context *dapm)
729{
730 return dapm->bias_level;
731}
732
733enum snd_soc_dapm_direction {
734 SND_SOC_DAPM_DIR_IN,
735 SND_SOC_DAPM_DIR_OUT
736};
737
738#define SND_SOC_DAPM_DIR_TO_EP(x) BIT(x)
739
740#define SND_SOC_DAPM_EP_SOURCE SND_SOC_DAPM_DIR_TO_EP(SND_SOC_DAPM_DIR_IN)
741#define SND_SOC_DAPM_EP_SINK SND_SOC_DAPM_DIR_TO_EP(SND_SOC_DAPM_DIR_OUT)
742
743/**
744 * snd_soc_dapm_widget_for_each_sink_path - Iterates over all paths in the
745 * specified direction of a widget
746 * @w: The widget
747 * @dir: Whether to iterate over the paths where the specified widget is the
748 * incoming or outgoing widgets
749 * @p: The path iterator variable
750 */
751#define snd_soc_dapm_widget_for_each_path(w, dir, p) \
752 list_for_each_entry(p, &w->edges[dir], list_node[dir])
753
754/**
755 * snd_soc_dapm_widget_for_each_sink_path_safe - Iterates over all paths in the
756 * specified direction of a widget
757 * @w: The widget
758 * @dir: Whether to iterate over the paths where the specified widget is the
759 * incoming or outgoing widgets
760 * @p: The path iterator variable
761 * @next_p: Temporary storage for the next path
762 *
763 * This function works like snd_soc_dapm_widget_for_each_sink_path, expect that
764 * it is safe to remove the current path from the list while iterating
765 */
766#define snd_soc_dapm_widget_for_each_path_safe(w, dir, p, next_p) \
767 list_for_each_entry_safe(p, next_p, &w->edges[dir], list_node[dir])
768
769/**
770 * snd_soc_dapm_widget_for_each_sink_path - Iterates over all paths leaving a
771 * widget
772 * @w: The widget
773 * @p: The path iterator variable
774 */
775#define snd_soc_dapm_widget_for_each_sink_path(w, p) \
776 snd_soc_dapm_widget_for_each_path(w, SND_SOC_DAPM_DIR_IN, p)
777
778/**
779 * snd_soc_dapm_widget_for_each_source_path - Iterates over all paths leading to
780 * a widget
781 * @w: The widget
782 * @p: The path iterator variable
783 */
784#define snd_soc_dapm_widget_for_each_source_path(w, p) \
785 snd_soc_dapm_widget_for_each_path(w, SND_SOC_DAPM_DIR_OUT, p)
786
787#endif