[ALSA] soc - DAPM - Bulk route registration
[linux-2.6.git] / include / sound / soc-dapm.h
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 /*
25  * SoC dynamic audio power management
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 */
134 #define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
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, \
138         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
139 #define SOC_DAPM_DOUBLE(xname, reg, shift_left, shift_right, max, invert, \
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) |\
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) }
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
192 struct snd_soc_dapm_widget;
193 enum snd_soc_dapm_type;
194 struct snd_soc_dapm_path;
195 struct snd_soc_dapm_pin;
196 struct snd_soc_dapm_route;
197
198 /* dapm controls */
199 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
200         struct snd_ctl_elem_value *ucontrol);
201 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
202         struct snd_ctl_elem_value *ucontrol);
203 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
204         struct snd_ctl_elem_value *ucontrol);
205 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
206         struct snd_ctl_elem_value *ucontrol);
207 int snd_soc_dapm_new_control(struct snd_soc_codec *codec,
208         const struct snd_soc_dapm_widget *widget);
209 int snd_soc_dapm_new_controls(struct snd_soc_codec *codec,
210         const struct snd_soc_dapm_widget *widget,
211         int num);
212
213 /* dapm path setup */
214 int  __deprecated snd_soc_dapm_connect_input(struct snd_soc_codec *codec,
215         const char *sink_name, const char *control_name, const char *src_name);
216 int snd_soc_dapm_new_widgets(struct snd_soc_codec *codec);
217 void snd_soc_dapm_free(struct snd_soc_device *socdev);
218 int snd_soc_dapm_add_routes(struct snd_soc_codec *codec,
219                             const struct snd_soc_dapm_route *route, int num);
220
221 /* dapm events */
222 int snd_soc_dapm_stream_event(struct snd_soc_codec *codec, char *stream,
223         int event);
224 int snd_soc_dapm_device_event(struct snd_soc_device *socdev, int event);
225
226 /* dapm sys fs - used by the core */
227 int snd_soc_dapm_sys_add(struct device *dev);
228
229 /* dapm audio endpoint control */
230 int snd_soc_dapm_set_endpoint(struct snd_soc_codec *codec,
231         char *pin, int status);
232 int snd_soc_dapm_get_endpoint_status(struct snd_soc_codec *codec,
233         char *pin);
234 int snd_soc_dapm_sync_endpoints(struct snd_soc_codec *codec);
235
236 /* dapm widget types */
237 enum snd_soc_dapm_type {
238         snd_soc_dapm_input = 0,         /* input pin */
239         snd_soc_dapm_output,            /* output pin */
240         snd_soc_dapm_mux,                       /* selects 1 analog signal from many inputs */
241         snd_soc_dapm_mixer,                     /* mixes several analog signals together */
242         snd_soc_dapm_pga,                       /* programmable gain/attenuation (volume) */
243         snd_soc_dapm_adc,                       /* analog to digital converter */
244         snd_soc_dapm_dac,                       /* digital to analog converter */
245         snd_soc_dapm_micbias,           /* microphone bias (power) */
246         snd_soc_dapm_mic,                       /* microphone */
247         snd_soc_dapm_hp,                        /* headphones */
248         snd_soc_dapm_spk,                       /* speaker */
249         snd_soc_dapm_line,                      /* line input/output */
250         snd_soc_dapm_switch,            /* analog switch */
251         snd_soc_dapm_vmid,                      /* codec bias/vmid - to minimise pops */
252         snd_soc_dapm_pre,                       /* machine specific pre widget - exec first */
253         snd_soc_dapm_post,                      /* machine specific post widget - exec last */
254 };
255
256 /*
257  * DAPM audio route definition.
258  *
259  * Defines an audio route originating at source via control and finishing
260  * at sink.
261  */
262 struct snd_soc_dapm_route {
263         const char *sink;
264         const char *control;
265         const char *source;
266 };
267
268 /* dapm audio path between two widgets */
269 struct snd_soc_dapm_path {
270         char *name;
271         char *long_name;
272
273         /* source (input) and sink (output) widgets */
274         struct snd_soc_dapm_widget *source;
275         struct snd_soc_dapm_widget *sink;
276         struct snd_kcontrol *kcontrol;
277
278         /* status */
279         u32 connect:1;  /* source and sink widgets are connected */
280         u32 walked:1;   /* path has been walked */
281
282         struct list_head list_source;
283         struct list_head list_sink;
284         struct list_head list;
285 };
286
287 /* dapm widget */
288 struct snd_soc_dapm_widget {
289         enum snd_soc_dapm_type id;
290         char *name;             /* widget name */
291         char *sname;    /* stream name */
292         struct snd_soc_codec *codec;
293         struct list_head list;
294
295         /* dapm control */
296         short reg;                                              /* negative reg = no direct dapm */
297         unsigned char shift;                    /* bits to shift */
298         unsigned int saved_value;               /* widget saved value */
299         unsigned int value;                             /* widget current value */
300         unsigned char power:1;                  /* block power status */
301         unsigned char invert:1;                 /* invert the power bit */
302         unsigned char active:1;                 /* active stream on DAC, ADC's */
303         unsigned char connected:1;              /* connected codec pin */
304         unsigned char new:1;                    /* cnew complete */
305         unsigned char ext:1;                    /* has external widgets */
306         unsigned char muted:1;                  /* muted for pop reduction */
307         unsigned char suspend:1;                /* was active before suspend */
308         unsigned char pmdown:1;                 /* waiting for timeout */
309
310         /* external events */
311         unsigned short event_flags;             /* flags to specify event types */
312         int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
313
314         /* kcontrols that relate to this widget */
315         int num_kcontrols;
316         const struct snd_kcontrol_new *kcontrols;
317
318         /* widget input and outputs */
319         struct list_head sources;
320         struct list_head sinks;
321 };
322
323 #endif