soc-dapm.h 22.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*
 * linux/sound/soc-dapm.h -- ALSA SoC Dynamic Audio Power Management
 *
 * Author:		Liam Girdwood
 * Created:		Aug 11th 2005
 * Copyright:	Wolfson Microelectronics. PLC.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef __LINUX_SND_SOC_DAPM_H
#define __LINUX_SND_SOC_DAPM_H

#include <linux/device.h>
#include <linux/types.h>
#include <sound/control.h>

/* widget has no PM register bit */
#define SND_SOC_NOPM	-1

/*
24
 * SoC dynamic audio power management
25
 *
L
Lucas De Marchi 已提交
26
 * We can have up to 4 power domains
L
Lu Guanqun 已提交
27
 *  1. Codec domain - VREF, VMID
28 29 30 31 32 33 34 35 36 37 38 39 40 41
 *     Usually controlled at codec probe/remove, although can be set
 *     at stream time if power is not needed for sidetone, etc.
 *  2. Platform/Machine domain - physically connected inputs and outputs
 *     Is platform/machine and user action specific, is set in the machine
 *     driver and by userspace e.g when HP are inserted
 *  3. Path domain - Internal codec path mixers
 *     Are automatically set when mixer and mux settings are
 *     changed by the user.
 *  4. Stream domain - DAC's and ADC's.
 *     Enabled when stream playback/capture is started.
 */

/* codec domain */
#define SND_SOC_DAPM_VMID(wname) \
42
{	.id = snd_soc_dapm_vmid, .name = wname, .kcontrol_news = NULL, \
43 44 45 46
	.num_kcontrols = 0}

/* platform domain */
#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 56
	.event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
#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 60
	.event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
#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 64
	.event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
#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 68 69 70 71 72
	.event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}

/* path domain */
#define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\
	 wcontrols, wncontrols) \
{	.id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
73
	.invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
74 75 76
#define SND_SOC_DAPM_OUT_DRV(wname, wreg, wshift, winvert,\
	 wcontrols, wncontrols) \
{	.id = snd_soc_dapm_out_drv, .name = wname, .reg = wreg, .shift = wshift, \
77
	.invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
78 79 80
#define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
	 wcontrols, wncontrols)\
{	.id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
81
	.invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
82 83 84
#define SND_SOC_DAPM_MIXER_NAMED_CTL(wname, wreg, wshift, winvert, \
	 wcontrols, wncontrols)\
{       .id = snd_soc_dapm_mixer_named_ctl, .name = wname, .reg = wreg, \
85
	.shift = wshift, .invert = winvert, .kcontrol_news = wcontrols, \
86
	.num_kcontrols = wncontrols}
87 88
#define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
{	.id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
89
	.invert = winvert, .kcontrol_news = NULL, .num_kcontrols = 0}
90 91
#define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
{	.id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
92
	.invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1}
93 94
#define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
{	.id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
95
	.invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1}
96 97
#define SND_SOC_DAPM_VIRT_MUX(wname, wreg, wshift, winvert, wcontrols) \
{	.id = snd_soc_dapm_virt_mux, .name = wname, .reg = wreg, .shift = wshift, \
98
	.invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1}
P
Peter Ujfalusi 已提交
99 100
#define SND_SOC_DAPM_VALUE_MUX(wname, wreg, wshift, winvert, wcontrols) \
{	.id = snd_soc_dapm_value_mux, .name = wname, .reg = wreg, \
101
	.shift = wshift, .invert = winvert, .kcontrol_news = wcontrols, \
P
Peter Ujfalusi 已提交
102
	.num_kcontrols = 1}
103

104 105 106 107
/* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
#define SOC_PGA_ARRAY(wname, wreg, wshift, winvert,\
	 wcontrols) \
{	.id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
108
	.invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
109 110 111
#define SOC_MIXER_ARRAY(wname, wreg, wshift, winvert, \
	 wcontrols)\
{	.id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
112
	.invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
113 114 115
#define SOC_MIXER_NAMED_CTL_ARRAY(wname, wreg, wshift, winvert, \
	 wcontrols)\
{       .id = snd_soc_dapm_mixer_named_ctl, .name = wname, .reg = wreg, \
116
	.shift = wshift, .invert = winvert, .kcontrol_news = wcontrols, \
117 118
	.num_kcontrols = ARRAY_SIZE(wcontrols)}

119 120 121 122
/* path domain with event - event handler must return 0 for success */
#define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \
	wncontrols, wevent, wflags) \
{	.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 126 127
#define SND_SOC_DAPM_OUT_DRV_E(wname, wreg, wshift, winvert, wcontrols, \
	wncontrols, wevent, wflags) \
{	.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 131 132
#define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \
	wncontrols, wevent, wflags) \
{	.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 136 137
#define SND_SOC_DAPM_MIXER_NAMED_CTL_E(wname, wreg, wshift, winvert, \
	wcontrols, wncontrols, wevent, wflags) \
{       .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 141
#define SND_SOC_DAPM_MICBIAS_E(wname, wreg, wshift, winvert, wevent, wflags) \
{	.id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
142
	.invert = winvert, .kcontrol_news = NULL, .num_kcontrols = 0, \
143 144 145 146
	.event = wevent, .event_flags = wflags}
#define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
	wevent, wflags) \
{	.id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
147
	.invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = 1, \
148 149 150 151
	.event = wevent, .event_flags = wflags}
#define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
	wevent, wflags) \
{	.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 155 156
#define SND_SOC_DAPM_VIRT_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
	wevent, wflags) \
{	.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 162
#define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \
	wevent, wflags) \
163
{	.id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
164 165
	.invert = winvert, .event = wevent, .event_flags = wflags, \
	.subseq = wsubseq}
166 167 168 169 170 171
#define SND_SOC_DAPM_SUPPLY_S(wname, wsubseq, wreg, wshift, winvert, wevent, \
	wflags)	\
{	.id = snd_soc_dapm_supply, .name = wname, .reg = wreg,	\
	.shift = wshift, .invert = winvert, .event = wevent, \
	.event_flags = wflags, .subseq = wsubseq}

172 173 174 175
/* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
#define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
	wevent, wflags) \
{	.id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
176
	.invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
177 178 179 180
	.event = wevent, .event_flags = wflags}
#define SOC_MIXER_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
	wevent, wflags) \
{	.id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
181
	.invert = winvert, .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
182 183 184 185
	.event = wevent, .event_flags = wflags}
#define SOC_MIXER_NAMED_CTL_E_ARRAY(wname, wreg, wshift, winvert, \
	wcontrols, wevent, wflags) \
{       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
186
	.invert = winvert, .kcontrol_news = wcontrols, \
187 188
	.num_kcontrols = ARRAY_SIZE(wcontrols), .event = wevent, .event_flags = wflags}

189 190
/* events that are pre and post DAPM */
#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 194
	.event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
#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 198 199
	.event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}

/* stream domain */
200 201 202
#define SND_SOC_DAPM_AIF_IN(wname, stname, wslot, wreg, wshift, winvert) \
{	.id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
	.reg = wreg, .shift = wshift, .invert = winvert }
203 204 205 206 207
#define SND_SOC_DAPM_AIF_IN_E(wname, stname, wslot, wreg, wshift, winvert, \
			      wevent, wflags)				\
{	.id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
	.reg = wreg, .shift = wshift, .invert = winvert, \
	.event = wevent, .event_flags = wflags }
208 209 210
#define SND_SOC_DAPM_AIF_OUT(wname, stname, wslot, wreg, wshift, winvert) \
{	.id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
	.reg = wreg, .shift = wshift, .invert = winvert }
211 212 213 214 215
#define SND_SOC_DAPM_AIF_OUT_E(wname, stname, wslot, wreg, wshift, winvert, \
			     wevent, wflags)				\
{	.id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
	.reg = wreg, .shift = wshift, .invert = winvert, \
	.event = wevent, .event_flags = wflags }
216 217 218
#define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
{	.id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
	.shift = wshift, .invert = winvert}
219 220 221 222 223
#define SND_SOC_DAPM_DAC_E(wname, stname, wreg, wshift, winvert, \
			   wevent, wflags)				\
{	.id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
	.shift = wshift, .invert = winvert, \
	.event = wevent, .event_flags = wflags}
224 225 226
#define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
{	.id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
	.shift = wshift, .invert = winvert}
227 228 229 230 231
#define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \
			   wevent, wflags)				\
{	.id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
	.shift = wshift, .invert = winvert, \
	.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 237 238
	.reg = -((wreg) + 1), .shift = wshift, .mask = wmask, \
	.on_val = won_val, .off_val = woff_val, .event = dapm_reg_event, \
	.event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
239 240 241 242
#define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \
{	.id = snd_soc_dapm_supply, .name = wname, .reg = wreg,	\
	.shift = wshift, .invert = winvert, .event = wevent, \
	.event_flags = wflags}
243

244
/* dapm kcontrol types */
P
Philipp Zabel 已提交
245
#define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
246 247 248
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	.info = snd_soc_info_volsw, \
	.get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
P
Philipp Zabel 已提交
249 250 251 252 253 254 255 256
	.private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
#define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	.info = snd_soc_info_volsw, \
	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
	.tlv.p = (tlv_array), \
	.get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
	.private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
257 258 259 260 261 262
#define SOC_DAPM_ENUM(xname, xenum) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	.info = snd_soc_info_enum_double, \
 	.get = snd_soc_dapm_get_enum_double, \
 	.put = snd_soc_dapm_put_enum_double, \
  	.private_value = (unsigned long)&xenum }
263 264 265 266 267 268
#define SOC_DAPM_ENUM_VIRT(xname, xenum)		    \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	.info = snd_soc_info_enum_double, \
	.get = snd_soc_dapm_get_enum_virt, \
	.put = snd_soc_dapm_put_enum_virt, \
	.private_value = (unsigned long)&xenum }
P
Peter Ujfalusi 已提交
269 270
#define SOC_DAPM_VALUE_ENUM(xname, xenum) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
271
	.info = snd_soc_info_enum_double, \
P
Peter Ujfalusi 已提交
272 273 274
	.get = snd_soc_dapm_get_value_enum_double, \
	.put = snd_soc_dapm_put_value_enum_double, \
	.private_value = (unsigned long)&xenum }
275 276 277 278 279 280
#define SOC_DAPM_PIN_SWITCH(xname) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
	.info = snd_soc_dapm_info_pin_switch, \
	.get = snd_soc_dapm_get_pin_switch, \
	.put = snd_soc_dapm_put_pin_switch, \
	.private_value = (unsigned long)xname }
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297

/* dapm stream operations */
#define SND_SOC_DAPM_STREAM_NOP			0x0
#define SND_SOC_DAPM_STREAM_START		0x1
#define SND_SOC_DAPM_STREAM_STOP		0x2
#define SND_SOC_DAPM_STREAM_SUSPEND		0x4
#define SND_SOC_DAPM_STREAM_RESUME		0x8
#define SND_SOC_DAPM_STREAM_PAUSE_PUSH	0x10
#define SND_SOC_DAPM_STREAM_PAUSE_RELEASE	0x20

/* dapm event types */
#define SND_SOC_DAPM_PRE_PMU	0x1 	/* before widget power up */
#define SND_SOC_DAPM_POST_PMU	0x2		/* after widget power up */
#define SND_SOC_DAPM_PRE_PMD	0x4 	/* before widget power down */
#define SND_SOC_DAPM_POST_PMD	0x8		/* after widget power down */
#define SND_SOC_DAPM_PRE_REG	0x10	/* before audio path setup */
#define SND_SOC_DAPM_POST_REG	0x20	/* after audio path setup */
298 299
#define SND_SOC_DAPM_PRE_POST_PMD \
				(SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
300 301 302 303 304 305 306 307 308 309 310

/* convenience event type detection */
#define SND_SOC_DAPM_EVENT_ON(e)	\
	(e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
#define SND_SOC_DAPM_EVENT_OFF(e)	\
	(e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))

struct snd_soc_dapm_widget;
enum snd_soc_dapm_type;
struct snd_soc_dapm_path;
struct snd_soc_dapm_pin;
311
struct snd_soc_dapm_route;
L
Liam Girdwood 已提交
312
struct snd_soc_dapm_context;
313

314 315 316
int dapm_reg_event(struct snd_soc_dapm_widget *w,
		   struct snd_kcontrol *kcontrol, int event);

317 318 319 320 321 322 323 324 325
/* dapm controls */
int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
326 327 328 329
int snd_soc_dapm_get_enum_virt(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_dapm_put_enum_virt(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
P
Peter Ujfalusi 已提交
330 331 332 333
int snd_soc_dapm_get_value_enum_double(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_dapm_put_value_enum_double(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
334 335 336 337 338 339
int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_info *uinfo);
int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *uncontrol);
int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *uncontrol);
L
Liam Girdwood 已提交
340
int snd_soc_dapm_new_control(struct snd_soc_dapm_context *dapm,
341
	const struct snd_soc_dapm_widget *widget);
L
Liam Girdwood 已提交
342
int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
343 344
	const struct snd_soc_dapm_widget *widget,
	int num);
345 346

/* dapm path setup */
L
Liam Girdwood 已提交
347 348 349
int snd_soc_dapm_new_widgets(struct snd_soc_dapm_context *dapm);
void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
350
			    const struct snd_soc_dapm_route *route, int num);
351 352
int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm,
			     const struct snd_soc_dapm_route *route, int num);
353 354

/* dapm events */
355 356 357
int snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd,
	const char *stream, int event);
void snd_soc_dapm_shutdown(struct snd_soc_card *card);
358 359 360

/* dapm sys fs - used by the core */
int snd_soc_dapm_sys_add(struct device *dev);
361 362
void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm,
				struct dentry *parent);
363

364
/* dapm audio pin control and status */
L
Liam Girdwood 已提交
365 366 367 368 369 370 371 372 373
int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
			    const char *pin);
int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
			     const char *pin);
int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
				const char *pin);
int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
374
				  const char *pin);
L
Liam Girdwood 已提交
375 376
int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
				const char *pin);
377 378 379 380 381 382

/* dapm widget types */
enum snd_soc_dapm_type {
	snd_soc_dapm_input = 0,		/* input pin */
	snd_soc_dapm_output,		/* output pin */
	snd_soc_dapm_mux,			/* selects 1 analog signal from many inputs */
383
	snd_soc_dapm_virt_mux,			/* virtual version of snd_soc_dapm_mux */
P
Peter Ujfalusi 已提交
384
	snd_soc_dapm_value_mux,			/* selects 1 analog signal from many inputs */
385
	snd_soc_dapm_mixer,			/* mixes several analog signals together */
386
	snd_soc_dapm_mixer_named_ctl,		/* mixer with named controls */
387
	snd_soc_dapm_pga,			/* programmable gain/attenuation (volume) */
388
	snd_soc_dapm_out_drv,			/* output driver */
389 390 391 392 393 394 395 396 397 398 399
	snd_soc_dapm_adc,			/* analog to digital converter */
	snd_soc_dapm_dac,			/* digital to analog converter */
	snd_soc_dapm_micbias,		/* microphone bias (power) */
	snd_soc_dapm_mic,			/* microphone */
	snd_soc_dapm_hp,			/* headphones */
	snd_soc_dapm_spk,			/* speaker */
	snd_soc_dapm_line,			/* line input/output */
	snd_soc_dapm_switch,		/* analog switch */
	snd_soc_dapm_vmid,			/* codec bias/vmid - to minimise pops */
	snd_soc_dapm_pre,			/* machine specific pre widget - exec first */
	snd_soc_dapm_post,			/* machine specific post widget - exec last */
400
	snd_soc_dapm_supply,		/* power/clock supply */
401 402
	snd_soc_dapm_aif_in,		/* audio interface input */
	snd_soc_dapm_aif_out,		/* audio interface output */
403 404
};

405 406 407 408 409 410 411 412 413 414
/*
 * DAPM audio route definition.
 *
 * Defines an audio route originating at source via control and finishing
 * at sink.
 */
struct snd_soc_dapm_route {
	const char *sink;
	const char *control;
	const char *source;
415 416 417 418

	/* Note: currently only supported for links where source is a supply */
	int (*connected)(struct snd_soc_dapm_widget *source,
			 struct snd_soc_dapm_widget *sink);
419 420
};

421 422 423 424 425 426 427 428 429 430 431 432 433
/* dapm audio path between two widgets */
struct snd_soc_dapm_path {
	char *name;
	char *long_name;

	/* source (input) and sink (output) widgets */
	struct snd_soc_dapm_widget *source;
	struct snd_soc_dapm_widget *sink;
	struct snd_kcontrol *kcontrol;

	/* status */
	u32 connect:1;	/* source and sink widgets are connected */
	u32 walked:1;	/* path has been walked */
434
	u32 weak:1;	/* path ignored for power management */
435

436 437 438
	int (*connected)(struct snd_soc_dapm_widget *source,
			 struct snd_soc_dapm_widget *sink);

439 440 441 442 443 444 445 446 447 448 449 450
	struct list_head list_source;
	struct list_head list_sink;
	struct list_head list;
};

/* dapm widget */
struct snd_soc_dapm_widget {
	enum snd_soc_dapm_type id;
	char *name;		/* widget name */
	char *sname;	/* stream name */
	struct snd_soc_codec *codec;
	struct list_head list;
L
Liam Girdwood 已提交
451
	struct snd_soc_dapm_context *dapm;
452 453 454 455 456 457

	/* dapm control */
	short reg;						/* negative reg = no direct dapm */
	unsigned char shift;			/* bits to shift */
	unsigned int saved_value;		/* widget saved value */
	unsigned int value;				/* widget current value */
458 459 460
	unsigned int mask;			/* non-shifted mask */
	unsigned int on_val;			/* on state value */
	unsigned int off_val;			/* off state value */
461 462 463 464 465 466
	unsigned char power:1;			/* block power status */
	unsigned char invert:1;			/* invert the power bit */
	unsigned char active:1;			/* active stream on DAC, ADC's */
	unsigned char connected:1;		/* connected codec pin */
	unsigned char new:1;			/* cnew complete */
	unsigned char ext:1;			/* has external widgets */
467
	unsigned char force:1;			/* force state */
468
	unsigned char ignore_suspend:1;         /* kept enabled over suspend */
469
	int subseq;				/* sort within widget type */
470

471 472
	int (*power_check)(struct snd_soc_dapm_widget *w);

473 474
	/* external events */
	unsigned short event_flags;		/* flags to specify event types */
475
	int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
476 477 478

	/* kcontrols that relate to this widget */
	int num_kcontrols;
479
	const struct snd_kcontrol_new *kcontrol_news;
480
	struct snd_kcontrol **kcontrols;
481 482 483 484

	/* widget input and outputs */
	struct list_head sources;
	struct list_head sinks;
485 486 487

	/* used during DAPM updates */
	struct list_head power_list;
488 489
};

490 491 492 493 494 495 496 497
struct snd_soc_dapm_update {
	struct snd_soc_dapm_widget *widget;
	struct snd_kcontrol *kcontrol;
	int reg;
	int mask;
	int val;
};

L
Liam Girdwood 已提交
498 499
/* DAPM context */
struct snd_soc_dapm_context {
500
	int n_widgets; /* number of widgets in this context */
L
Liam Girdwood 已提交
501 502 503 504 505
	enum snd_soc_bias_level bias_level;
	enum snd_soc_bias_level suspend_bias_level;
	struct delayed_work delayed_work;
	unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */

506 507
	struct snd_soc_dapm_update *update;

508
	void (*seq_notifier)(struct snd_soc_dapm_context *,
509
			     enum snd_soc_dapm_type, int);
510

L
Liam Girdwood 已提交
511 512
	struct device *dev; /* from parent - for debug */
	struct snd_soc_codec *codec; /* parent codec */
513
	struct snd_soc_card *card; /* parent card */
514 515

	/* used during DAPM updates */
516
	enum snd_soc_bias_level target_bias_level;
517 518
	struct list_head list;

L
Liam Girdwood 已提交
519 520 521 522 523
#ifdef CONFIG_DEBUG_FS
	struct dentry *debugfs_dapm;
#endif
};

524 525 526 527 528 529
/* A list of widgets associated with an object, typically a snd_kcontrol */
struct snd_soc_dapm_widget_list {
	int num_widgets;
	struct snd_soc_dapm_widget *widgets[0];
};

530
#endif