[ALSA] soc - DAPM - Add bulk control registration
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / sound / soc-dapm.h
CommitLineData
808db4a4
RP
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#include <sound/soc.h>
20
21/* widget has no PM register bit */
22#define SND_SOC_NOPM -1
23
24/*
b7d2a803 25 * SoC dynamic audio power management
808db4a4
RP
26 *
27 * We can have upto 4 power domains
28 * 1. Codec domain - VREF, VMID
29 * Usually controlled at codec probe/remove, although can be set
30 * at stream time if power is not needed for sidetone, etc.
31 * 2. Platform/Machine domain - physically connected inputs and outputs
32 * Is platform/machine and user action specific, is set in the machine
33 * driver and by userspace e.g when HP are inserted
34 * 3. Path domain - Internal codec path mixers
35 * Are automatically set when mixer and mux settings are
36 * changed by the user.
37 * 4. Stream domain - DAC's and ADC's.
38 * Enabled when stream playback/capture is started.
39 */
40
41/* codec domain */
42#define SND_SOC_DAPM_VMID(wname) \
43{ .id = snd_soc_dapm_vmid, .name = wname, .kcontrols = NULL, \
44 .num_kcontrols = 0}
45
46/* platform domain */
47#define SND_SOC_DAPM_INPUT(wname) \
48{ .id = snd_soc_dapm_input, .name = wname, .kcontrols = NULL, \
49 .num_kcontrols = 0}
50#define SND_SOC_DAPM_OUTPUT(wname) \
51{ .id = snd_soc_dapm_output, .name = wname, .kcontrols = NULL, \
52 .num_kcontrols = 0}
53#define SND_SOC_DAPM_MIC(wname, wevent) \
54{ .id = snd_soc_dapm_mic, .name = wname, .kcontrols = NULL, \
55 .num_kcontrols = 0, .event = wevent, \
56 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
57#define SND_SOC_DAPM_HP(wname, wevent) \
58{ .id = snd_soc_dapm_hp, .name = wname, .kcontrols = NULL, \
59 .num_kcontrols = 0, .event = wevent, \
60 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
61#define SND_SOC_DAPM_SPK(wname, wevent) \
62{ .id = snd_soc_dapm_spk, .name = wname, .kcontrols = NULL, \
63 .num_kcontrols = 0, .event = wevent, \
64 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
65#define SND_SOC_DAPM_LINE(wname, wevent) \
66{ .id = snd_soc_dapm_line, .name = wname, .kcontrols = NULL, \
67 .num_kcontrols = 0, .event = wevent, \
68 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
69
70/* path domain */
71#define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\
72 wcontrols, wncontrols) \
73{ .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
74 .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols}
75#define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
76 wcontrols, wncontrols)\
77{ .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
78 .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols}
79#define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
80{ .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
81 .invert = winvert, .kcontrols = NULL, .num_kcontrols = 0}
82#define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
83{ .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
84 .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1}
85#define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
86{ .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
87 .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1}
88
89/* path domain with event - event handler must return 0 for success */
90#define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \
91 wncontrols, wevent, wflags) \
92{ .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
93 .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols, \
94 .event = wevent, .event_flags = wflags}
95#define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \
96 wncontrols, wevent, wflags) \
97{ .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
98 .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols, \
99 .event = wevent, .event_flags = wflags}
100#define SND_SOC_DAPM_MICBIAS_E(wname, wreg, wshift, winvert, wevent, wflags) \
101{ .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
102 .invert = winvert, .kcontrols = NULL, .num_kcontrols = 0, \
103 .event = wevent, .event_flags = wflags}
104#define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
105 wevent, wflags) \
106{ .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
107 .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1 \
108 .event = wevent, .event_flags = wflags}
109#define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
110 wevent, wflags) \
111{ .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
112 .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1, \
113 .event = wevent, .event_flags = wflags}
114
115/* events that are pre and post DAPM */
116#define SND_SOC_DAPM_PRE(wname, wevent) \
117{ .id = snd_soc_dapm_pre, .name = wname, .kcontrols = NULL, \
118 .num_kcontrols = 0, .event = wevent, \
119 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
120#define SND_SOC_DAPM_POST(wname, wevent) \
121{ .id = snd_soc_dapm_post, .name = wname, .kcontrols = NULL, \
122 .num_kcontrols = 0, .event = wevent, \
123 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
124
125/* stream domain */
126#define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
127{ .id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
128 .shift = wshift, .invert = winvert}
129#define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
130{ .id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
131 .shift = wshift, .invert = winvert}
132
133/* dapm kcontrol types */
a7a4ac86 134#define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
808db4a4
RP
135{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
136 .info = snd_soc_info_volsw, \
137 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
a7a4ac86
PZ
138 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
139#define SOC_DAPM_DOUBLE(xname, reg, shift_left, shift_right, max, invert, \
808db4a4
RP
140 power) \
141{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
142 .info = snd_soc_info_volsw, \
143 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
144 .private_value = (reg) | ((shift_left) << 8) | ((shift_right) << 12) |\
a7a4ac86
PZ
145 ((max) << 16) | ((invert) << 24) }
146#define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
147{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
148 .info = snd_soc_info_volsw, \
149 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
150 .tlv.p = (tlv_array), \
151 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
152 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
153#define SOC_DAPM_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, \
154 power, tlv_array) \
155{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
156 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
157 .tlv.p = (tlv_array), \
158 .info = snd_soc_info_volsw, \
159 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
160 .private_value = (reg) | ((shift_left) << 8) | ((shift_right) << 12) |\
161 ((max) << 16) | ((invert) << 24) }
808db4a4
RP
162#define SOC_DAPM_ENUM(xname, xenum) \
163{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
164 .info = snd_soc_info_enum_double, \
165 .get = snd_soc_dapm_get_enum_double, \
166 .put = snd_soc_dapm_put_enum_double, \
167 .private_value = (unsigned long)&xenum }
168
169/* dapm stream operations */
170#define SND_SOC_DAPM_STREAM_NOP 0x0
171#define SND_SOC_DAPM_STREAM_START 0x1
172#define SND_SOC_DAPM_STREAM_STOP 0x2
173#define SND_SOC_DAPM_STREAM_SUSPEND 0x4
174#define SND_SOC_DAPM_STREAM_RESUME 0x8
175#define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10
176#define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20
177
178/* dapm event types */
179#define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */
180#define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */
181#define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */
182#define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */
183#define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */
184#define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */
185
186/* convenience event type detection */
187#define SND_SOC_DAPM_EVENT_ON(e) \
188 (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
189#define SND_SOC_DAPM_EVENT_OFF(e) \
190 (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
191
192struct snd_soc_dapm_widget;
193enum snd_soc_dapm_type;
194struct snd_soc_dapm_path;
195struct snd_soc_dapm_pin;
196
197/* dapm controls */
198int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
199 struct snd_ctl_elem_value *ucontrol);
200int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
201 struct snd_ctl_elem_value *ucontrol);
202int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
203 struct snd_ctl_elem_value *ucontrol);
204int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
205 struct snd_ctl_elem_value *ucontrol);
206int snd_soc_dapm_new_control(struct snd_soc_codec *codec,
207 const struct snd_soc_dapm_widget *widget);
4ba1327a
MB
208int snd_soc_dapm_new_controls(struct snd_soc_codec *codec,
209 const struct snd_soc_dapm_widget *widget,
210 int num);
808db4a4
RP
211
212/* dapm path setup */
213int snd_soc_dapm_connect_input(struct snd_soc_codec *codec,
214 const char *sink_name, const char *control_name, const char *src_name);
215int snd_soc_dapm_new_widgets(struct snd_soc_codec *codec);
216void snd_soc_dapm_free(struct snd_soc_device *socdev);
217
218/* dapm events */
219int snd_soc_dapm_stream_event(struct snd_soc_codec *codec, char *stream,
220 int event);
0b4d221b 221int snd_soc_dapm_device_event(struct snd_soc_device *socdev, int event);
808db4a4
RP
222
223/* dapm sys fs - used by the core */
224int snd_soc_dapm_sys_add(struct device *dev);
225
226/* dapm audio endpoint control */
227int snd_soc_dapm_set_endpoint(struct snd_soc_codec *codec,
228 char *pin, int status);
eeec12bf
GG
229int snd_soc_dapm_get_endpoint_status(struct snd_soc_codec *codec,
230 char *pin);
808db4a4
RP
231int snd_soc_dapm_sync_endpoints(struct snd_soc_codec *codec);
232
233/* dapm widget types */
234enum snd_soc_dapm_type {
235 snd_soc_dapm_input = 0, /* input pin */
236 snd_soc_dapm_output, /* output pin */
237 snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */
238 snd_soc_dapm_mixer, /* mixes several analog signals together */
239 snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */
240 snd_soc_dapm_adc, /* analog to digital converter */
241 snd_soc_dapm_dac, /* digital to analog converter */
242 snd_soc_dapm_micbias, /* microphone bias (power) */
243 snd_soc_dapm_mic, /* microphone */
244 snd_soc_dapm_hp, /* headphones */
245 snd_soc_dapm_spk, /* speaker */
246 snd_soc_dapm_line, /* line input/output */
247 snd_soc_dapm_switch, /* analog switch */
248 snd_soc_dapm_vmid, /* codec bias/vmid - to minimise pops */
249 snd_soc_dapm_pre, /* machine specific pre widget - exec first */
250 snd_soc_dapm_post, /* machine specific post widget - exec last */
251};
252
253/* dapm audio path between two widgets */
254struct snd_soc_dapm_path {
255 char *name;
256 char *long_name;
257
258 /* source (input) and sink (output) widgets */
259 struct snd_soc_dapm_widget *source;
260 struct snd_soc_dapm_widget *sink;
261 struct snd_kcontrol *kcontrol;
262
263 /* status */
264 u32 connect:1; /* source and sink widgets are connected */
265 u32 walked:1; /* path has been walked */
266
267 struct list_head list_source;
268 struct list_head list_sink;
269 struct list_head list;
270};
271
272/* dapm widget */
273struct snd_soc_dapm_widget {
274 enum snd_soc_dapm_type id;
275 char *name; /* widget name */
276 char *sname; /* stream name */
277 struct snd_soc_codec *codec;
278 struct list_head list;
279
280 /* dapm control */
281 short reg; /* negative reg = no direct dapm */
282 unsigned char shift; /* bits to shift */
283 unsigned int saved_value; /* widget saved value */
284 unsigned int value; /* widget current value */
285 unsigned char power:1; /* block power status */
286 unsigned char invert:1; /* invert the power bit */
287 unsigned char active:1; /* active stream on DAC, ADC's */
288 unsigned char connected:1; /* connected codec pin */
289 unsigned char new:1; /* cnew complete */
290 unsigned char ext:1; /* has external widgets */
291 unsigned char muted:1; /* muted for pop reduction */
292 unsigned char suspend:1; /* was active before suspend */
293 unsigned char pmdown:1; /* waiting for timeout */
294
295 /* external events */
296 unsigned short event_flags; /* flags to specify event types */
9af6d956 297 int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
808db4a4
RP
298
299 /* kcontrols that relate to this widget */
300 int num_kcontrols;
301 const struct snd_kcontrol_new *kcontrols;
302
303 /* widget input and outputs */
304 struct list_head sources;
305 struct list_head sinks;
306};
307
308#endif