blob: 979ed84e07d65a78fb24798a72e2bd3976d5ec10 [file] [log] [blame]
Richard Purdie808db4a2006-10-06 18:20:14 +02001/*
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>
Richard Purdie808db4a2006-10-06 18:20:14 +020019
20/* widget has no PM register bit */
21#define SND_SOC_NOPM -1
22
23/*
Joe Perchesb7d2a802007-12-18 13:14:21 +010024 * SoC dynamic audio power management
Richard Purdie808db4a2006-10-06 18:20:14 +020025 *
26 * We can have upto 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, .kcontrols = NULL, \
43 .num_kcontrols = 0}
44
45/* platform domain */
46#define SND_SOC_DAPM_INPUT(wname) \
47{ .id = snd_soc_dapm_input, .name = wname, .kcontrols = NULL, \
48 .num_kcontrols = 0}
49#define SND_SOC_DAPM_OUTPUT(wname) \
50{ .id = snd_soc_dapm_output, .name = wname, .kcontrols = NULL, \
51 .num_kcontrols = 0}
52#define SND_SOC_DAPM_MIC(wname, wevent) \
53{ .id = snd_soc_dapm_mic, .name = wname, .kcontrols = NULL, \
54 .num_kcontrols = 0, .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, .kcontrols = NULL, \
58 .num_kcontrols = 0, .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, .kcontrols = NULL, \
62 .num_kcontrols = 0, .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, .kcontrols = NULL, \
66 .num_kcontrols = 0, .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, .kcontrols = wcontrols, .num_kcontrols = wncontrols}
Olaya, Margaritad88429a2010-12-10 21:11:44 -060074#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, .kcontrols = wcontrols, .num_kcontrols = wncontrols}
Richard Purdie808db4a2006-10-06 18:20:14 +020078#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, .kcontrols = wcontrols, .num_kcontrols = wncontrols}
Ian Moltonca9c1aa2009-01-06 20:11:51 +000082#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, .kcontrols = wcontrols, \
86 .num_kcontrols = wncontrols}
Richard Purdie808db4a2006-10-06 18:20:14 +020087#define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
88{ .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
89 .invert = winvert, .kcontrols = 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, .kcontrols = 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, .kcontrols = wcontrols, .num_kcontrols = 1}
Dimitris Papastamos24ff33a2010-12-16 15:53:39 +000096#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, .kcontrols = wcontrols, .num_kcontrols = 1}
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +020099#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, .kcontrols = wcontrols, \
102 .num_kcontrols = 1}
Richard Purdie808db4a2006-10-06 18:20:14 +0200103
Guennadi Liakhovetski8484c632010-01-21 21:10:47 +0100104/* 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, .kcontrols = 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, .kcontrols = 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, .kcontrols = wcontrols, \
117 .num_kcontrols = ARRAY_SIZE(wcontrols)}
118
Richard Purdie808db4a2006-10-06 18:20:14 +0200119/* 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, .kcontrols = wcontrols, .num_kcontrols = wncontrols, \
124 .event = wevent, .event_flags = wflags}
Olaya, Margaritad88429a2010-12-10 21:11:44 -0600125#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, .kcontrols = wcontrols, .num_kcontrols = wncontrols, \
129 .event = wevent, .event_flags = wflags}
Richard Purdie808db4a2006-10-06 18:20:14 +0200130#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, .kcontrols = wcontrols, .num_kcontrols = wncontrols, \
134 .event = wevent, .event_flags = wflags}
Ian Moltonca9c1aa2009-01-06 20:11:51 +0000135#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, .kcontrols = wcontrols, \
139 .num_kcontrols = wncontrols, .event = wevent, .event_flags = wflags}
Richard Purdie808db4a2006-10-06 18:20:14 +0200140#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, .kcontrols = 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, \
Peter Ujfalusi43d50802009-01-23 10:08:35 +0200147 .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200148 .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, .kcontrols = wcontrols, .num_kcontrols = 1, \
153 .event = wevent, .event_flags = wflags}
Dimitris Papastamos24ff33a2010-12-16 15:53:39 +0000154#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, .kcontrols = wcontrols, .num_kcontrols = 1, \
158 .event = wevent, .event_flags = wflags}
Richard Purdie808db4a2006-10-06 18:20:14 +0200159
Mark Brown20e48592011-01-15 13:40:50 +0000160/* additional sequencing control within an event type */
Mark Brown3d23c732011-01-24 21:51:25 +0000161#define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \
162 wevent, wflags) \
Mark Brown20e48592011-01-15 13:40:50 +0000163{ .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
Mark Brown3d23c732011-01-24 21:51:25 +0000164 .invert = winvert, .event = wevent, .event_flags = wflags, \
165 .subseq = wsubseq}
Mark Brown20e48592011-01-15 13:40:50 +0000166#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
Guennadi Liakhovetski8484c632010-01-21 21:10:47 +0100172/* 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, .kcontrols = 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, .kcontrols = 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, .kcontrols = wcontrols, \
187 .num_kcontrols = ARRAY_SIZE(wcontrols), .event = wevent, .event_flags = wflags}
188
Richard Purdie808db4a2006-10-06 18:20:14 +0200189/* events that are pre and post DAPM */
190#define SND_SOC_DAPM_PRE(wname, wevent) \
191{ .id = snd_soc_dapm_pre, .name = wname, .kcontrols = NULL, \
192 .num_kcontrols = 0, .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, .kcontrols = NULL, \
196 .num_kcontrols = 0, .event = wevent, \
197 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
198
199/* stream domain */
Mark Brown010ff262009-08-17 17:39:22 +0100200#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 }
Mark Brownea0d09d2010-09-03 19:36:28 +0100203#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 }
Mark Brown010ff262009-08-17 17:39:22 +0100208#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 }
Mark Brownea0d09d2010-09-03 19:36:28 +0100211#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 }
Richard Purdie808db4a2006-10-06 18:20:14 +0200216#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}
Mark Brownf6d655a2009-04-13 11:27:03 +0100219#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}
Richard Purdie808db4a2006-10-06 18:20:14 +0200224#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}
Mark Brownf6d655a2009-04-13 11:27:03 +0100227#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}
Richard Purdie808db4a2006-10-06 18:20:14 +0200232
Mark Brown246d0a12009-04-22 18:24:55 +0100233/* generic widgets */
Jarkko Nikulae2be2cc2008-06-25 14:42:07 +0300234#define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
235{ .id = wid, .name = wname, .kcontrols = 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}
Mark Brown246d0a12009-04-22 18:24:55 +0100239#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}
Jarkko Nikulae2be2cc2008-06-25 14:42:07 +0300243
Richard Purdie808db4a2006-10-06 18:20:14 +0200244/* dapm kcontrol types */
Philipp Zabela7a4ac82008-01-10 14:37:42 +0100245#define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +0200246{ .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, \
Philipp Zabela7a4ac82008-01-10 14:37:42 +0100249 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
Philipp Zabela7a4ac82008-01-10 14:37:42 +0100250#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) }
Richard Purdie808db4a2006-10-06 18:20:14 +0200257#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 }
Mark Brownd2b247a2009-10-06 15:21:04 +0100263#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 }
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200269#define SOC_DAPM_VALUE_ENUM(xname, xenum) \
270{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
Peter Ujfalusi74155552009-01-08 13:34:29 +0200271 .info = snd_soc_info_enum_double, \
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200272 .get = snd_soc_dapm_get_value_enum_double, \
273 .put = snd_soc_dapm_put_value_enum_double, \
274 .private_value = (unsigned long)&xenum }
Mark Brown8b37dbd2009-02-28 21:14:20 +0000275#define SOC_DAPM_PIN_SWITCH(xname) \
276{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
277 .info = snd_soc_dapm_info_pin_switch, \
278 .get = snd_soc_dapm_get_pin_switch, \
279 .put = snd_soc_dapm_put_pin_switch, \
280 .private_value = (unsigned long)xname }
Richard Purdie808db4a2006-10-06 18:20:14 +0200281
282/* dapm stream operations */
283#define SND_SOC_DAPM_STREAM_NOP 0x0
284#define SND_SOC_DAPM_STREAM_START 0x1
285#define SND_SOC_DAPM_STREAM_STOP 0x2
286#define SND_SOC_DAPM_STREAM_SUSPEND 0x4
287#define SND_SOC_DAPM_STREAM_RESUME 0x8
288#define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10
289#define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20
290
291/* dapm event types */
292#define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */
293#define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */
294#define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */
295#define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */
296#define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */
297#define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */
apatard@mandriva.comea762b02010-05-27 14:57:40 +0200298#define SND_SOC_DAPM_PRE_POST_PMD \
299 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
Richard Purdie808db4a2006-10-06 18:20:14 +0200300
301/* convenience event type detection */
302#define SND_SOC_DAPM_EVENT_ON(e) \
303 (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
304#define SND_SOC_DAPM_EVENT_OFF(e) \
305 (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
306
307struct snd_soc_dapm_widget;
308enum snd_soc_dapm_type;
309struct snd_soc_dapm_path;
310struct snd_soc_dapm_pin;
Mark Brown105f1c22008-05-13 14:52:19 +0200311struct snd_soc_dapm_route;
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200312struct snd_soc_dapm_context;
Richard Purdie808db4a2006-10-06 18:20:14 +0200313
Mark Brown11589412008-07-29 11:42:23 +0100314int dapm_reg_event(struct snd_soc_dapm_widget *w,
315 struct snd_kcontrol *kcontrol, int event);
316
Richard Purdie808db4a2006-10-06 18:20:14 +0200317/* dapm controls */
318int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
319 struct snd_ctl_elem_value *ucontrol);
320int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
321 struct snd_ctl_elem_value *ucontrol);
322int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
323 struct snd_ctl_elem_value *ucontrol);
324int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
325 struct snd_ctl_elem_value *ucontrol);
Mark Brownd2b247a2009-10-06 15:21:04 +0100326int snd_soc_dapm_get_enum_virt(struct snd_kcontrol *kcontrol,
327 struct snd_ctl_elem_value *ucontrol);
328int snd_soc_dapm_put_enum_virt(struct snd_kcontrol *kcontrol,
329 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200330int snd_soc_dapm_get_value_enum_double(struct snd_kcontrol *kcontrol,
331 struct snd_ctl_elem_value *ucontrol);
332int snd_soc_dapm_put_value_enum_double(struct snd_kcontrol *kcontrol,
333 struct snd_ctl_elem_value *ucontrol);
Mark Brown8b37dbd2009-02-28 21:14:20 +0000334int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
335 struct snd_ctl_elem_info *uinfo);
336int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
337 struct snd_ctl_elem_value *uncontrol);
338int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
339 struct snd_ctl_elem_value *uncontrol);
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200340int snd_soc_dapm_new_control(struct snd_soc_dapm_context *dapm,
Richard Purdie808db4a2006-10-06 18:20:14 +0200341 const struct snd_soc_dapm_widget *widget);
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200342int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
Mark Brown4ba13272008-05-13 14:51:19 +0200343 const struct snd_soc_dapm_widget *widget,
344 int num);
Richard Purdie808db4a2006-10-06 18:20:14 +0200345
346/* dapm path setup */
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200347int snd_soc_dapm_new_widgets(struct snd_soc_dapm_context *dapm);
348void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
349int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
Mark Brown105f1c22008-05-13 14:52:19 +0200350 const struct snd_soc_dapm_route *route, int num);
Richard Purdie808db4a2006-10-06 18:20:14 +0200351
352/* dapm events */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000353int snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd,
354 const char *stream, int event);
355void snd_soc_dapm_shutdown(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +0200356
357/* dapm sys fs - used by the core */
358int snd_soc_dapm_sys_add(struct device *dev);
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200359void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm);
Richard Purdie808db4a2006-10-06 18:20:14 +0200360
Liam Girdwooda5302182008-07-07 13:35:17 +0100361/* dapm audio pin control and status */
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200362int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
363 const char *pin);
364int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
365 const char *pin);
366int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
367int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
368 const char *pin);
369int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
370int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
Mark Brownda341832010-03-15 19:23:37 +0000371 const char *pin);
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200372int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
373 const char *pin);
Richard Purdie808db4a2006-10-06 18:20:14 +0200374
375/* dapm widget types */
376enum snd_soc_dapm_type {
377 snd_soc_dapm_input = 0, /* input pin */
378 snd_soc_dapm_output, /* output pin */
379 snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */
Dimitris Papastamos24ff33a2010-12-16 15:53:39 +0000380 snd_soc_dapm_virt_mux, /* virtual version of snd_soc_dapm_mux */
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200381 snd_soc_dapm_value_mux, /* selects 1 analog signal from many inputs */
Richard Purdie808db4a2006-10-06 18:20:14 +0200382 snd_soc_dapm_mixer, /* mixes several analog signals together */
Ian Moltonca9c1aa2009-01-06 20:11:51 +0000383 snd_soc_dapm_mixer_named_ctl, /* mixer with named controls */
Richard Purdie808db4a2006-10-06 18:20:14 +0200384 snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */
Olaya, Margaritad88429a2010-12-10 21:11:44 -0600385 snd_soc_dapm_out_drv, /* output driver */
Richard Purdie808db4a2006-10-06 18:20:14 +0200386 snd_soc_dapm_adc, /* analog to digital converter */
387 snd_soc_dapm_dac, /* digital to analog converter */
388 snd_soc_dapm_micbias, /* microphone bias (power) */
389 snd_soc_dapm_mic, /* microphone */
390 snd_soc_dapm_hp, /* headphones */
391 snd_soc_dapm_spk, /* speaker */
392 snd_soc_dapm_line, /* line input/output */
393 snd_soc_dapm_switch, /* analog switch */
394 snd_soc_dapm_vmid, /* codec bias/vmid - to minimise pops */
395 snd_soc_dapm_pre, /* machine specific pre widget - exec first */
396 snd_soc_dapm_post, /* machine specific post widget - exec last */
Mark Brown246d0a12009-04-22 18:24:55 +0100397 snd_soc_dapm_supply, /* power/clock supply */
Mark Brown010ff262009-08-17 17:39:22 +0100398 snd_soc_dapm_aif_in, /* audio interface input */
399 snd_soc_dapm_aif_out, /* audio interface output */
Richard Purdie808db4a2006-10-06 18:20:14 +0200400};
401
Mark Brown105f1c22008-05-13 14:52:19 +0200402/*
403 * DAPM audio route definition.
404 *
405 * Defines an audio route originating at source via control and finishing
406 * at sink.
407 */
408struct snd_soc_dapm_route {
409 const char *sink;
410 const char *control;
411 const char *source;
Mark Brown215edda2009-09-08 18:59:05 +0100412
413 /* Note: currently only supported for links where source is a supply */
414 int (*connected)(struct snd_soc_dapm_widget *source,
415 struct snd_soc_dapm_widget *sink);
Mark Brown105f1c22008-05-13 14:52:19 +0200416};
417
Richard Purdie808db4a2006-10-06 18:20:14 +0200418/* dapm audio path between two widgets */
419struct snd_soc_dapm_path {
420 char *name;
421 char *long_name;
422
423 /* source (input) and sink (output) widgets */
424 struct snd_soc_dapm_widget *source;
425 struct snd_soc_dapm_widget *sink;
426 struct snd_kcontrol *kcontrol;
427
428 /* status */
429 u32 connect:1; /* source and sink widgets are connected */
430 u32 walked:1; /* path has been walked */
431
Mark Brown215edda2009-09-08 18:59:05 +0100432 int (*connected)(struct snd_soc_dapm_widget *source,
433 struct snd_soc_dapm_widget *sink);
434
Richard Purdie808db4a2006-10-06 18:20:14 +0200435 struct list_head list_source;
436 struct list_head list_sink;
437 struct list_head list;
438};
439
440/* dapm widget */
441struct snd_soc_dapm_widget {
442 enum snd_soc_dapm_type id;
443 char *name; /* widget name */
444 char *sname; /* stream name */
445 struct snd_soc_codec *codec;
446 struct list_head list;
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200447 struct snd_soc_dapm_context *dapm;
Richard Purdie808db4a2006-10-06 18:20:14 +0200448
449 /* dapm control */
450 short reg; /* negative reg = no direct dapm */
451 unsigned char shift; /* bits to shift */
452 unsigned int saved_value; /* widget saved value */
453 unsigned int value; /* widget current value */
Jarkko Nikulae2be2cc2008-06-25 14:42:07 +0300454 unsigned int mask; /* non-shifted mask */
455 unsigned int on_val; /* on state value */
456 unsigned int off_val; /* off state value */
Richard Purdie808db4a2006-10-06 18:20:14 +0200457 unsigned char power:1; /* block power status */
458 unsigned char invert:1; /* invert the power bit */
459 unsigned char active:1; /* active stream on DAC, ADC's */
460 unsigned char connected:1; /* connected codec pin */
461 unsigned char new:1; /* cnew complete */
462 unsigned char ext:1; /* has external widgets */
Mark Brownda341832010-03-15 19:23:37 +0000463 unsigned char force:1; /* force state */
Mark Brown1547aba2010-05-07 21:11:40 +0100464 unsigned char ignore_suspend:1; /* kept enabled over suspend */
Mark Brown20e48592011-01-15 13:40:50 +0000465 int subseq; /* sort within widget type */
Richard Purdie808db4a2006-10-06 18:20:14 +0200466
Mark Brownb75576d2009-04-20 17:56:13 +0100467 int (*power_check)(struct snd_soc_dapm_widget *w);
468
Richard Purdie808db4a2006-10-06 18:20:14 +0200469 /* external events */
470 unsigned short event_flags; /* flags to specify event types */
Laim Girdwood9af6d952008-01-10 14:41:02 +0100471 int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200472
473 /* kcontrols that relate to this widget */
474 int num_kcontrols;
475 const struct snd_kcontrol_new *kcontrols;
476
477 /* widget input and outputs */
478 struct list_head sources;
479 struct list_head sinks;
Mark Brown6d3ddc82009-05-16 17:47:29 +0100480
481 /* used during DAPM updates */
482 struct list_head power_list;
Richard Purdie808db4a2006-10-06 18:20:14 +0200483};
484
Mark Brown97404f22010-12-14 16:13:57 +0000485struct snd_soc_dapm_update {
486 struct snd_soc_dapm_widget *widget;
487 struct snd_kcontrol *kcontrol;
488 int reg;
489 int mask;
490 int val;
491};
492
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200493/* DAPM context */
494struct snd_soc_dapm_context {
Jarkko Nikula97c866d2010-12-14 12:18:31 +0200495 int n_widgets; /* number of widgets in this context */
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200496 enum snd_soc_bias_level bias_level;
497 enum snd_soc_bias_level suspend_bias_level;
498 struct delayed_work delayed_work;
499 unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
500
Mark Brown97404f22010-12-14 16:13:57 +0000501 struct snd_soc_dapm_update *update;
502
Mark Brown474b62d2011-01-18 16:14:44 +0000503 void (*seq_notifier)(struct snd_soc_dapm_context *,
Mark Brownf85a9e02011-01-26 21:41:28 +0000504 enum snd_soc_dapm_type, int);
Mark Brown474b62d2011-01-18 16:14:44 +0000505
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200506 struct device *dev; /* from parent - for debug */
507 struct snd_soc_codec *codec; /* parent codec */
Jarkko Nikula3a45b862010-11-05 20:35:21 +0200508 struct snd_soc_card *card; /* parent card */
Jarkko Nikula7be31be82010-12-14 12:18:32 +0200509
510 /* used during DAPM updates */
511 int dev_power;
512 struct list_head list;
513
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200514#ifdef CONFIG_DEBUG_FS
515 struct dentry *debugfs_dapm;
516#endif
517};
518
Richard Purdie808db4a2006-10-06 18:20:14 +0200519#endif