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 managment 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, mask, 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, mask, invert) } 139#define SOC_DAPM_DOUBLE(xname, reg, shift_left, shift_right, mask, 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 ((mask) << 16) | ((invert) << 24) } 146#define SOC_DAPM_ENUM(xname, xenum) \ 147{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 148 .info = snd_soc_info_enum_double, \ 149 .get = snd_soc_dapm_get_enum_double, \ 150 .put = snd_soc_dapm_put_enum_double, \ 151 .private_value = (unsigned long)&xenum } 152 153/* dapm stream operations */ 154#define SND_SOC_DAPM_STREAM_NOP 0x0 155#define SND_SOC_DAPM_STREAM_START 0x1 156#define SND_SOC_DAPM_STREAM_STOP 0x2 157#define SND_SOC_DAPM_STREAM_SUSPEND 0x4 158#define SND_SOC_DAPM_STREAM_RESUME 0x8 159#define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10 160#define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20 161 162/* dapm event types */ 163#define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */ 164#define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */ 165#define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */ 166#define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */ 167#define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */ 168#define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */ 169 170/* convenience event type detection */ 171#define SND_SOC_DAPM_EVENT_ON(e) \ 172 (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU)) 173#define SND_SOC_DAPM_EVENT_OFF(e) \ 174 (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)) 175 176struct snd_soc_dapm_widget; 177enum snd_soc_dapm_type; 178struct snd_soc_dapm_path; 179struct snd_soc_dapm_pin; 180 181/* dapm controls */ 182int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol, 183 struct snd_ctl_elem_value *ucontrol); 184int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol, 185 struct snd_ctl_elem_value *ucontrol); 186int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol, 187 struct snd_ctl_elem_value *ucontrol); 188int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol, 189 struct snd_ctl_elem_value *ucontrol); 190int snd_soc_dapm_new_control(struct snd_soc_codec *codec, 191 const struct snd_soc_dapm_widget *widget); 192 193/* dapm path setup */ 194int snd_soc_dapm_connect_input(struct snd_soc_codec *codec, 195 const char *sink_name, const char *control_name, const char *src_name); 196int snd_soc_dapm_new_widgets(struct snd_soc_codec *codec); 197void snd_soc_dapm_free(struct snd_soc_device *socdev); 198 199/* dapm events */ 200int snd_soc_dapm_stream_event(struct snd_soc_codec *codec, char *stream, 201 int event); 202 203/* dapm sys fs - used by the core */ 204int snd_soc_dapm_sys_add(struct device *dev); 205 206/* dapm audio endpoint control */ 207int snd_soc_dapm_set_endpoint(struct snd_soc_codec *codec, 208 char *pin, int status); 209int snd_soc_dapm_sync_endpoints(struct snd_soc_codec *codec); 210 211/* dapm widget types */ 212enum snd_soc_dapm_type { 213 snd_soc_dapm_input = 0, /* input pin */ 214 snd_soc_dapm_output, /* output pin */ 215 snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */ 216 snd_soc_dapm_mixer, /* mixes several analog signals together */ 217 snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */ 218 snd_soc_dapm_adc, /* analog to digital converter */ 219 snd_soc_dapm_dac, /* digital to analog converter */ 220 snd_soc_dapm_micbias, /* microphone bias (power) */ 221 snd_soc_dapm_mic, /* microphone */ 222 snd_soc_dapm_hp, /* headphones */ 223 snd_soc_dapm_spk, /* speaker */ 224 snd_soc_dapm_line, /* line input/output */ 225 snd_soc_dapm_switch, /* analog switch */ 226 snd_soc_dapm_vmid, /* codec bias/vmid - to minimise pops */ 227 snd_soc_dapm_pre, /* machine specific pre widget - exec first */ 228 snd_soc_dapm_post, /* machine specific post widget - exec last */ 229}; 230 231/* dapm audio path between two widgets */ 232struct snd_soc_dapm_path { 233 char *name; 234 char *long_name; 235 236 /* source (input) and sink (output) widgets */ 237 struct snd_soc_dapm_widget *source; 238 struct snd_soc_dapm_widget *sink; 239 struct snd_kcontrol *kcontrol; 240 241 /* status */ 242 u32 connect:1; /* source and sink widgets are connected */ 243 u32 walked:1; /* path has been walked */ 244 245 struct list_head list_source; 246 struct list_head list_sink; 247 struct list_head list; 248}; 249 250/* dapm widget */ 251struct snd_soc_dapm_widget { 252 enum snd_soc_dapm_type id; 253 char *name; /* widget name */ 254 char *sname; /* stream name */ 255 struct snd_soc_codec *codec; 256 struct list_head list; 257 258 /* dapm control */ 259 short reg; /* negative reg = no direct dapm */ 260 unsigned char shift; /* bits to shift */ 261 unsigned int saved_value; /* widget saved value */ 262 unsigned int value; /* widget current value */ 263 unsigned char power:1; /* block power status */ 264 unsigned char invert:1; /* invert the power bit */ 265 unsigned char active:1; /* active stream on DAC, ADC's */ 266 unsigned char connected:1; /* connected codec pin */ 267 unsigned char new:1; /* cnew complete */ 268 unsigned char ext:1; /* has external widgets */ 269 unsigned char muted:1; /* muted for pop reduction */ 270 unsigned char suspend:1; /* was active before suspend */ 271 unsigned char pmdown:1; /* waiting for timeout */ 272 273 /* external events */ 274 unsigned short event_flags; /* flags to specify event types */ 275 int (*event)(struct snd_soc_dapm_widget*, int); 276 277 /* kcontrols that relate to this widget */ 278 int num_kcontrols; 279 const struct snd_kcontrol_new *kcontrols; 280 281 /* widget input and outputs */ 282 struct list_head sources; 283 struct list_head sinks; 284}; 285 286#endif 287