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/types.h> 17 #include <sound/control.h> 18 19 struct device; 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 up to 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, .kcontrol_news = NULL, \ 44 .num_kcontrols = 0} 45 46 /* platform domain */ 47 #define SND_SOC_DAPM_SIGGEN(wname) \ 48 { .id = snd_soc_dapm_siggen, .name = wname, .kcontrol_news = NULL, \ 49 .num_kcontrols = 0, .reg = SND_SOC_NOPM } 50 #define SND_SOC_DAPM_INPUT(wname) \ 51 { .id = snd_soc_dapm_input, .name = wname, .kcontrol_news = NULL, \ 52 .num_kcontrols = 0, .reg = SND_SOC_NOPM } 53 #define SND_SOC_DAPM_OUTPUT(wname) \ 54 { .id = snd_soc_dapm_output, .name = wname, .kcontrol_news = NULL, \ 55 .num_kcontrols = 0, .reg = SND_SOC_NOPM } 56 #define SND_SOC_DAPM_MIC(wname, wevent) \ 57 { .id = snd_soc_dapm_mic, .name = wname, .kcontrol_news = NULL, \ 58 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \ 59 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD} 60 #define SND_SOC_DAPM_HP(wname, wevent) \ 61 { .id = snd_soc_dapm_hp, .name = wname, .kcontrol_news = NULL, \ 62 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \ 63 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD} 64 #define SND_SOC_DAPM_SPK(wname, wevent) \ 65 { .id = snd_soc_dapm_spk, .name = wname, .kcontrol_news = NULL, \ 66 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \ 67 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD} 68 #define SND_SOC_DAPM_LINE(wname, wevent) \ 69 { .id = snd_soc_dapm_line, .name = wname, .kcontrol_news = NULL, \ 70 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \ 71 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD} 72 73 #define SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) \ 74 .reg = wreg, .mask = 1, .shift = wshift, \ 75 .on_val = winvert ? 0 : 1, .off_val = winvert ? 1 : 0 76 77 /* path domain */ 78 #define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\ 79 wcontrols, wncontrols) \ 80 { .id = snd_soc_dapm_pga, .name = wname, \ 81 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 82 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols} 83 #define SND_SOC_DAPM_OUT_DRV(wname, wreg, wshift, winvert,\ 84 wcontrols, wncontrols) \ 85 { .id = snd_soc_dapm_out_drv, .name = wname, \ 86 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 87 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols} 88 #define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \ 89 wcontrols, wncontrols)\ 90 { .id = snd_soc_dapm_mixer, .name = wname, \ 91 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 92 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols} 93 #define SND_SOC_DAPM_MIXER_NAMED_CTL(wname, wreg, wshift, winvert, \ 94 wcontrols, wncontrols)\ 95 { .id = snd_soc_dapm_mixer_named_ctl, .name = wname, \ 96 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 97 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols} 98 #define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \ 99 { .id = snd_soc_dapm_micbias, .name = wname, \ 100 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 101 .kcontrol_news = NULL, .num_kcontrols = 0} 102 #define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \ 103 { .id = snd_soc_dapm_switch, .name = wname, \ 104 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 105 .kcontrol_news = wcontrols, .num_kcontrols = 1} 106 #define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \ 107 { .id = snd_soc_dapm_mux, .name = wname, \ 108 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 109 .kcontrol_news = wcontrols, .num_kcontrols = 1} 110 #define SND_SOC_DAPM_VIRT_MUX(wname, wreg, wshift, winvert, wcontrols) \ 111 SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) 112 #define SND_SOC_DAPM_VALUE_MUX(wname, wreg, wshift, winvert, wcontrols) \ 113 SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) 114 115 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */ 116 #define SOC_PGA_ARRAY(wname, wreg, wshift, winvert,\ 117 wcontrols) \ 118 { .id = snd_soc_dapm_pga, .name = wname, \ 119 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 120 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)} 121 #define SOC_MIXER_ARRAY(wname, wreg, wshift, winvert, \ 122 wcontrols)\ 123 { .id = snd_soc_dapm_mixer, .name = wname, \ 124 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 125 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)} 126 #define SOC_MIXER_NAMED_CTL_ARRAY(wname, wreg, wshift, winvert, \ 127 wcontrols)\ 128 { .id = snd_soc_dapm_mixer_named_ctl, .name = wname, \ 129 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 130 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)} 131 132 /* path domain with event - event handler must return 0 for success */ 133 #define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \ 134 wncontrols, wevent, wflags) \ 135 { .id = snd_soc_dapm_pga, .name = wname, \ 136 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 137 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \ 138 .event = wevent, .event_flags = wflags} 139 #define SND_SOC_DAPM_OUT_DRV_E(wname, wreg, wshift, winvert, wcontrols, \ 140 wncontrols, wevent, wflags) \ 141 { .id = snd_soc_dapm_out_drv, .name = wname, \ 142 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 143 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \ 144 .event = wevent, .event_flags = wflags} 145 #define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \ 146 wncontrols, wevent, wflags) \ 147 { .id = snd_soc_dapm_mixer, .name = wname, \ 148 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 149 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \ 150 .event = wevent, .event_flags = wflags} 151 #define SND_SOC_DAPM_MIXER_NAMED_CTL_E(wname, wreg, wshift, winvert, \ 152 wcontrols, wncontrols, wevent, wflags) \ 153 { .id = snd_soc_dapm_mixer, .name = wname, \ 154 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 155 .kcontrol_news = wcontrols, \ 156 .num_kcontrols = wncontrols, .event = wevent, .event_flags = wflags} 157 #define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \ 158 wevent, wflags) \ 159 { .id = snd_soc_dapm_switch, .name = wname, \ 160 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 161 .kcontrol_news = wcontrols, .num_kcontrols = 1, \ 162 .event = wevent, .event_flags = wflags} 163 #define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \ 164 wevent, wflags) \ 165 { .id = snd_soc_dapm_mux, .name = wname, \ 166 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 167 .kcontrol_news = wcontrols, .num_kcontrols = 1, \ 168 .event = wevent, .event_flags = wflags} 169 #define SND_SOC_DAPM_VIRT_MUX_E(wname, wreg, wshift, winvert, wcontrols, \ 170 wevent, wflags) \ 171 SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, wevent, \ 172 wflags) 173 174 /* additional sequencing control within an event type */ 175 #define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \ 176 wevent, wflags) \ 177 { .id = snd_soc_dapm_pga, .name = wname, \ 178 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 179 .event = wevent, .event_flags = wflags, \ 180 .subseq = wsubseq} 181 #define SND_SOC_DAPM_SUPPLY_S(wname, wsubseq, wreg, wshift, winvert, wevent, \ 182 wflags) \ 183 { .id = snd_soc_dapm_supply, .name = wname, \ 184 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 185 .event = wevent, .event_flags = wflags, .subseq = wsubseq} 186 187 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */ 188 #define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \ 189 wevent, wflags) \ 190 { .id = snd_soc_dapm_pga, .name = wname, \ 191 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 192 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \ 193 .event = wevent, .event_flags = wflags} 194 #define SOC_MIXER_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \ 195 wevent, wflags) \ 196 { .id = snd_soc_dapm_mixer, .name = wname, \ 197 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 198 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \ 199 .event = wevent, .event_flags = wflags} 200 #define SOC_MIXER_NAMED_CTL_E_ARRAY(wname, wreg, wshift, winvert, \ 201 wcontrols, wevent, wflags) \ 202 { .id = snd_soc_dapm_mixer, .name = wname, \ 203 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 204 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \ 205 .event = wevent, .event_flags = wflags} 206 207 /* events that are pre and post DAPM */ 208 #define SND_SOC_DAPM_PRE(wname, wevent) \ 209 { .id = snd_soc_dapm_pre, .name = wname, .kcontrol_news = NULL, \ 210 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \ 211 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD} 212 #define SND_SOC_DAPM_POST(wname, wevent) \ 213 { .id = snd_soc_dapm_post, .name = wname, .kcontrol_news = NULL, \ 214 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \ 215 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD} 216 217 /* stream domain */ 218 #define SND_SOC_DAPM_AIF_IN(wname, stname, wslot, wreg, wshift, winvert) \ 219 { .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \ 220 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), } 221 #define SND_SOC_DAPM_AIF_IN_E(wname, stname, wslot, wreg, wshift, winvert, \ 222 wevent, wflags) \ 223 { .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \ 224 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 225 .event = wevent, .event_flags = wflags } 226 #define SND_SOC_DAPM_AIF_OUT(wname, stname, wslot, wreg, wshift, winvert) \ 227 { .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \ 228 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), } 229 #define SND_SOC_DAPM_AIF_OUT_E(wname, stname, wslot, wreg, wshift, winvert, \ 230 wevent, wflags) \ 231 { .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \ 232 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 233 .event = wevent, .event_flags = wflags } 234 #define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \ 235 { .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \ 236 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) } 237 #define SND_SOC_DAPM_DAC_E(wname, stname, wreg, wshift, winvert, \ 238 wevent, wflags) \ 239 { .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \ 240 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 241 .event = wevent, .event_flags = wflags} 242 243 #define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \ 244 { .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \ 245 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), } 246 #define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \ 247 wevent, wflags) \ 248 { .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \ 249 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 250 .event = wevent, .event_flags = wflags} 251 #define SND_SOC_DAPM_CLOCK_SUPPLY(wname) \ 252 { .id = snd_soc_dapm_clock_supply, .name = wname, \ 253 .reg = SND_SOC_NOPM, .event = dapm_clock_event, \ 254 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD } 255 256 /* generic widgets */ 257 #define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \ 258 { .id = wid, .name = wname, .kcontrol_news = NULL, .num_kcontrols = 0, \ 259 .reg = -((wreg) + 1), .shift = wshift, .mask = wmask, \ 260 .on_val = won_val, .off_val = woff_val, .event = dapm_reg_event, \ 261 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD} 262 #define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \ 263 { .id = snd_soc_dapm_supply, .name = wname, \ 264 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 265 .event = wevent, .event_flags = wflags} 266 #define SND_SOC_DAPM_REGULATOR_SUPPLY(wname, wdelay, wflags) \ 267 { .id = snd_soc_dapm_regulator_supply, .name = wname, \ 268 .reg = SND_SOC_NOPM, .shift = wdelay, .event = dapm_regulator_event, \ 269 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD, \ 270 .on_val = wflags} 271 272 273 /* dapm kcontrol types */ 274 #define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \ 275 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 276 .info = snd_soc_info_volsw, \ 277 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \ 278 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) } 279 #define SOC_DAPM_SINGLE_AUTODISABLE(xname, reg, shift, max, invert) \ 280 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 281 .info = snd_soc_info_volsw, \ 282 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \ 283 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 1) } 284 #define SOC_DAPM_SINGLE_VIRT(xname, max) \ 285 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0) 286 #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \ 287 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 288 .info = snd_soc_info_volsw, \ 289 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 290 .tlv.p = (tlv_array), \ 291 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \ 292 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) } 293 #define SOC_DAPM_SINGLE_TLV_AUTODISABLE(xname, reg, shift, max, invert, tlv_array) \ 294 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 295 .info = snd_soc_info_volsw, \ 296 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 297 .tlv.p = (tlv_array), \ 298 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \ 299 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) } 300 #define SOC_DAPM_SINGLE_TLV_VIRT(xname, max, tlv_array) \ 301 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0, tlv_array) 302 #define SOC_DAPM_ENUM(xname, xenum) \ 303 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 304 .info = snd_soc_info_enum_double, \ 305 .get = snd_soc_dapm_get_enum_double, \ 306 .put = snd_soc_dapm_put_enum_double, \ 307 .private_value = (unsigned long)&xenum } 308 #define SOC_DAPM_ENUM_VIRT(xname, xenum) \ 309 SOC_DAPM_ENUM(xname, xenum) 310 #define SOC_DAPM_ENUM_EXT(xname, xenum, xget, xput) \ 311 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 312 .info = snd_soc_info_enum_double, \ 313 .get = xget, \ 314 .put = xput, \ 315 .private_value = (unsigned long)&xenum } 316 #define SOC_DAPM_VALUE_ENUM(xname, xenum) \ 317 SOC_DAPM_ENUM(xname, xenum) 318 #define SOC_DAPM_PIN_SWITCH(xname) \ 319 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \ 320 .info = snd_soc_dapm_info_pin_switch, \ 321 .get = snd_soc_dapm_get_pin_switch, \ 322 .put = snd_soc_dapm_put_pin_switch, \ 323 .private_value = (unsigned long)xname } 324 325 /* dapm stream operations */ 326 #define SND_SOC_DAPM_STREAM_NOP 0x0 327 #define SND_SOC_DAPM_STREAM_START 0x1 328 #define SND_SOC_DAPM_STREAM_STOP 0x2 329 #define SND_SOC_DAPM_STREAM_SUSPEND 0x4 330 #define SND_SOC_DAPM_STREAM_RESUME 0x8 331 #define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10 332 #define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20 333 334 /* dapm event types */ 335 #define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */ 336 #define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */ 337 #define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */ 338 #define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */ 339 #define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */ 340 #define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */ 341 #define SND_SOC_DAPM_WILL_PMU 0x40 /* called at start of sequence */ 342 #define SND_SOC_DAPM_WILL_PMD 0x80 /* called at start of sequence */ 343 #define SND_SOC_DAPM_PRE_POST_PMD \ 344 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD) 345 346 /* convenience event type detection */ 347 #define SND_SOC_DAPM_EVENT_ON(e) \ 348 (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU)) 349 #define SND_SOC_DAPM_EVENT_OFF(e) \ 350 (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)) 351 352 /* regulator widget flags */ 353 #define SND_SOC_DAPM_REGULATOR_BYPASS 0x1 /* bypass when disabled */ 354 355 struct snd_soc_dapm_widget; 356 enum snd_soc_dapm_type; 357 struct snd_soc_dapm_path; 358 struct snd_soc_dapm_pin; 359 struct snd_soc_dapm_route; 360 struct snd_soc_dapm_context; 361 struct regulator; 362 struct snd_soc_dapm_widget_list; 363 struct snd_soc_dapm_update; 364 365 int dapm_reg_event(struct snd_soc_dapm_widget *w, 366 struct snd_kcontrol *kcontrol, int event); 367 int dapm_regulator_event(struct snd_soc_dapm_widget *w, 368 struct snd_kcontrol *kcontrol, int event); 369 int dapm_clock_event(struct snd_soc_dapm_widget *w, 370 struct snd_kcontrol *kcontrol, int event); 371 372 /* dapm controls */ 373 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol, 374 struct snd_ctl_elem_value *ucontrol); 375 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol, 376 struct snd_ctl_elem_value *ucontrol); 377 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol, 378 struct snd_ctl_elem_value *ucontrol); 379 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol, 380 struct snd_ctl_elem_value *ucontrol); 381 int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol, 382 struct snd_ctl_elem_info *uinfo); 383 int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol, 384 struct snd_ctl_elem_value *uncontrol); 385 int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol, 386 struct snd_ctl_elem_value *uncontrol); 387 int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm, 388 const struct snd_soc_dapm_widget *widget, 389 int num); 390 int snd_soc_dapm_new_dai_widgets(struct snd_soc_dapm_context *dapm, 391 struct snd_soc_dai *dai); 392 int snd_soc_dapm_link_dai_widgets(struct snd_soc_card *card); 393 void snd_soc_dapm_connect_dai_link_widgets(struct snd_soc_card *card); 394 int snd_soc_dapm_new_pcm(struct snd_soc_card *card, 395 const struct snd_soc_pcm_stream *params, 396 struct snd_soc_dapm_widget *source, 397 struct snd_soc_dapm_widget *sink); 398 399 /* dapm path setup */ 400 int snd_soc_dapm_new_widgets(struct snd_soc_card *card); 401 void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm); 402 int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm, 403 const struct snd_soc_dapm_route *route, int num); 404 int snd_soc_dapm_del_routes(struct snd_soc_dapm_context *dapm, 405 const struct snd_soc_dapm_route *route, int num); 406 int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm, 407 const struct snd_soc_dapm_route *route, int num); 408 409 /* dapm events */ 410 void snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd, int stream, 411 int event); 412 void snd_soc_dapm_shutdown(struct snd_soc_card *card); 413 414 /* external DAPM widget events */ 415 int snd_soc_dapm_mixer_update_power(struct snd_soc_dapm_context *dapm, 416 struct snd_kcontrol *kcontrol, int connect, 417 struct snd_soc_dapm_update *update); 418 int snd_soc_dapm_mux_update_power(struct snd_soc_dapm_context *dapm, 419 struct snd_kcontrol *kcontrol, int mux, struct soc_enum *e, 420 struct snd_soc_dapm_update *update); 421 422 /* dapm sys fs - used by the core */ 423 int snd_soc_dapm_sys_add(struct device *dev); 424 void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm, 425 struct dentry *parent); 426 427 /* dapm audio pin control and status */ 428 int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm, 429 const char *pin); 430 int snd_soc_dapm_enable_pin_unlocked(struct snd_soc_dapm_context *dapm, 431 const char *pin); 432 int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm, 433 const char *pin); 434 int snd_soc_dapm_disable_pin_unlocked(struct snd_soc_dapm_context *dapm, 435 const char *pin); 436 int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin); 437 int snd_soc_dapm_nc_pin_unlocked(struct snd_soc_dapm_context *dapm, 438 const char *pin); 439 int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm, 440 const char *pin); 441 int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm); 442 int snd_soc_dapm_sync_unlocked(struct snd_soc_dapm_context *dapm); 443 int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm, 444 const char *pin); 445 int snd_soc_dapm_force_enable_pin_unlocked(struct snd_soc_dapm_context *dapm, 446 const char *pin); 447 int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm, 448 const char *pin); 449 void snd_soc_dapm_auto_nc_codec_pins(struct snd_soc_codec *codec); 450 451 /* Mostly internal - should not normally be used */ 452 void dapm_mark_io_dirty(struct snd_soc_dapm_context *dapm); 453 454 /* dapm path query */ 455 int snd_soc_dapm_dai_get_connected_widgets(struct snd_soc_dai *dai, int stream, 456 struct snd_soc_dapm_widget_list **list); 457 458 struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(struct snd_kcontrol *kcontrol); 459 460 /* dapm widget types */ 461 enum snd_soc_dapm_type { 462 snd_soc_dapm_input = 0, /* input pin */ 463 snd_soc_dapm_output, /* output pin */ 464 snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */ 465 snd_soc_dapm_mixer, /* mixes several analog signals together */ 466 snd_soc_dapm_mixer_named_ctl, /* mixer with named controls */ 467 snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */ 468 snd_soc_dapm_out_drv, /* output driver */ 469 snd_soc_dapm_adc, /* analog to digital converter */ 470 snd_soc_dapm_dac, /* digital to analog converter */ 471 snd_soc_dapm_micbias, /* microphone bias (power) */ 472 snd_soc_dapm_mic, /* microphone */ 473 snd_soc_dapm_hp, /* headphones */ 474 snd_soc_dapm_spk, /* speaker */ 475 snd_soc_dapm_line, /* line input/output */ 476 snd_soc_dapm_switch, /* analog switch */ 477 snd_soc_dapm_vmid, /* codec bias/vmid - to minimise pops */ 478 snd_soc_dapm_pre, /* machine specific pre widget - exec first */ 479 snd_soc_dapm_post, /* machine specific post widget - exec last */ 480 snd_soc_dapm_supply, /* power/clock supply */ 481 snd_soc_dapm_regulator_supply, /* external regulator */ 482 snd_soc_dapm_clock_supply, /* external clock */ 483 snd_soc_dapm_aif_in, /* audio interface input */ 484 snd_soc_dapm_aif_out, /* audio interface output */ 485 snd_soc_dapm_siggen, /* signal generator */ 486 snd_soc_dapm_dai_in, /* link to DAI structure */ 487 snd_soc_dapm_dai_out, 488 snd_soc_dapm_dai_link, /* link between two DAI structures */ 489 snd_soc_dapm_kcontrol, /* Auto-disabled kcontrol */ 490 }; 491 492 enum snd_soc_dapm_subclass { 493 SND_SOC_DAPM_CLASS_INIT = 0, 494 SND_SOC_DAPM_CLASS_RUNTIME = 1, 495 }; 496 497 /* 498 * DAPM audio route definition. 499 * 500 * Defines an audio route originating at source via control and finishing 501 * at sink. 502 */ 503 struct snd_soc_dapm_route { 504 const char *sink; 505 const char *control; 506 const char *source; 507 508 /* Note: currently only supported for links where source is a supply */ 509 int (*connected)(struct snd_soc_dapm_widget *source, 510 struct snd_soc_dapm_widget *sink); 511 }; 512 513 /* dapm audio path between two widgets */ 514 struct snd_soc_dapm_path { 515 const char *name; 516 517 /* source (input) and sink (output) widgets */ 518 struct snd_soc_dapm_widget *source; 519 struct snd_soc_dapm_widget *sink; 520 521 /* status */ 522 u32 connect:1; /* source and sink widgets are connected */ 523 u32 walked:1; /* path has been walked */ 524 u32 walking:1; /* path is in the process of being walked */ 525 u32 weak:1; /* path ignored for power management */ 526 527 int (*connected)(struct snd_soc_dapm_widget *source, 528 struct snd_soc_dapm_widget *sink); 529 530 struct list_head list_source; 531 struct list_head list_sink; 532 struct list_head list_kcontrol; 533 struct list_head list; 534 }; 535 536 /* dapm widget */ 537 struct snd_soc_dapm_widget { 538 enum snd_soc_dapm_type id; 539 const char *name; /* widget name */ 540 const char *sname; /* stream name */ 541 struct snd_soc_codec *codec; 542 struct snd_soc_platform *platform; 543 struct list_head list; 544 struct snd_soc_dapm_context *dapm; 545 546 void *priv; /* widget specific data */ 547 struct regulator *regulator; /* attached regulator */ 548 const struct snd_soc_pcm_stream *params; /* params for dai links */ 549 550 /* dapm control */ 551 int reg; /* negative reg = no direct dapm */ 552 unsigned char shift; /* bits to shift */ 553 unsigned int mask; /* non-shifted mask */ 554 unsigned int on_val; /* on state value */ 555 unsigned int off_val; /* off state value */ 556 unsigned char power:1; /* block power status */ 557 unsigned char active:1; /* active stream on DAC, ADC's */ 558 unsigned char connected:1; /* connected codec pin */ 559 unsigned char new:1; /* cnew complete */ 560 unsigned char ext:1; /* has external widgets */ 561 unsigned char force:1; /* force state */ 562 unsigned char ignore_suspend:1; /* kept enabled over suspend */ 563 unsigned char new_power:1; /* power from this run */ 564 unsigned char power_checked:1; /* power checked this run */ 565 int subseq; /* sort within widget type */ 566 567 int (*power_check)(struct snd_soc_dapm_widget *w); 568 569 /* external events */ 570 unsigned short event_flags; /* flags to specify event types */ 571 int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int); 572 573 /* kcontrols that relate to this widget */ 574 int num_kcontrols; 575 const struct snd_kcontrol_new *kcontrol_news; 576 struct snd_kcontrol **kcontrols; 577 578 /* widget input and outputs */ 579 struct list_head sources; 580 struct list_head sinks; 581 582 /* used during DAPM updates */ 583 struct list_head power_list; 584 struct list_head dirty; 585 int inputs; 586 int outputs; 587 588 struct clk *clk; 589 }; 590 591 struct snd_soc_dapm_update { 592 struct snd_kcontrol *kcontrol; 593 int reg; 594 int mask; 595 int val; 596 }; 597 598 /* DAPM context */ 599 struct snd_soc_dapm_context { 600 enum snd_soc_bias_level bias_level; 601 enum snd_soc_bias_level suspend_bias_level; 602 struct delayed_work delayed_work; 603 unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */ 604 605 void (*seq_notifier)(struct snd_soc_dapm_context *, 606 enum snd_soc_dapm_type, int); 607 608 struct device *dev; /* from parent - for debug */ 609 struct snd_soc_codec *codec; /* parent codec */ 610 struct snd_soc_platform *platform; /* parent platform */ 611 struct snd_soc_card *card; /* parent card */ 612 613 /* used during DAPM updates */ 614 enum snd_soc_bias_level target_bias_level; 615 struct list_head list; 616 617 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event); 618 619 #ifdef CONFIG_DEBUG_FS 620 struct dentry *debugfs_dapm; 621 #endif 622 }; 623 624 /* A list of widgets associated with an object, typically a snd_kcontrol */ 625 struct snd_soc_dapm_widget_list { 626 int num_widgets; 627 struct snd_soc_dapm_widget *widgets[0]; 628 }; 629 630 struct snd_soc_dapm_stats { 631 int power_checks; 632 int path_checks; 633 int neighbour_checks; 634 }; 635 636 #endif 637