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 #include <sound/soc-topology.h> 19 #include <sound/asoc.h> 20 21 struct device; 22 23 /* widget has no PM register bit */ 24 #define SND_SOC_NOPM -1 25 26 /* 27 * SoC dynamic audio power management 28 * 29 * We can have up to 4 power domains 30 * 1. Codec domain - VREF, VMID 31 * Usually controlled at codec probe/remove, although can be set 32 * at stream time if power is not needed for sidetone, etc. 33 * 2. Platform/Machine domain - physically connected inputs and outputs 34 * Is platform/machine and user action specific, is set in the machine 35 * driver and by userspace e.g when HP are inserted 36 * 3. Path domain - Internal codec path mixers 37 * Are automatically set when mixer and mux settings are 38 * changed by the user. 39 * 4. Stream domain - DAC's and ADC's. 40 * Enabled when stream playback/capture is started. 41 */ 42 43 /* codec domain */ 44 #define SND_SOC_DAPM_VMID(wname) \ 45 { .id = snd_soc_dapm_vmid, .name = wname, .kcontrol_news = NULL, \ 46 .num_kcontrols = 0} 47 48 /* platform domain */ 49 #define SND_SOC_DAPM_SIGGEN(wname) \ 50 { .id = snd_soc_dapm_siggen, .name = wname, .kcontrol_news = NULL, \ 51 .num_kcontrols = 0, .reg = SND_SOC_NOPM } 52 #define SND_SOC_DAPM_SINK(wname) \ 53 { .id = snd_soc_dapm_sink, .name = wname, .kcontrol_news = NULL, \ 54 .num_kcontrols = 0, .reg = SND_SOC_NOPM } 55 #define SND_SOC_DAPM_INPUT(wname) \ 56 { .id = snd_soc_dapm_input, .name = wname, .kcontrol_news = NULL, \ 57 .num_kcontrols = 0, .reg = SND_SOC_NOPM } 58 #define SND_SOC_DAPM_OUTPUT(wname) \ 59 { .id = snd_soc_dapm_output, .name = wname, .kcontrol_news = NULL, \ 60 .num_kcontrols = 0, .reg = SND_SOC_NOPM } 61 #define SND_SOC_DAPM_MIC(wname, wevent) \ 62 { .id = snd_soc_dapm_mic, .name = wname, .kcontrol_news = NULL, \ 63 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \ 64 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD} 65 #define SND_SOC_DAPM_HP(wname, wevent) \ 66 { .id = snd_soc_dapm_hp, .name = wname, .kcontrol_news = NULL, \ 67 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \ 68 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD} 69 #define SND_SOC_DAPM_SPK(wname, wevent) \ 70 { .id = snd_soc_dapm_spk, .name = wname, .kcontrol_news = NULL, \ 71 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \ 72 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD} 73 #define SND_SOC_DAPM_LINE(wname, wevent) \ 74 { .id = snd_soc_dapm_line, .name = wname, .kcontrol_news = NULL, \ 75 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \ 76 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD} 77 78 #define SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) \ 79 .reg = wreg, .mask = 1, .shift = wshift, \ 80 .on_val = winvert ? 0 : 1, .off_val = winvert ? 1 : 0 81 82 /* path domain */ 83 #define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\ 84 wcontrols, wncontrols) \ 85 { .id = snd_soc_dapm_pga, .name = wname, \ 86 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 87 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols} 88 #define SND_SOC_DAPM_OUT_DRV(wname, wreg, wshift, winvert,\ 89 wcontrols, wncontrols) \ 90 { .id = snd_soc_dapm_out_drv, .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(wname, wreg, wshift, winvert, \ 94 wcontrols, wncontrols)\ 95 { .id = snd_soc_dapm_mixer, .name = wname, \ 96 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 97 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols} 98 #define SND_SOC_DAPM_MIXER_NAMED_CTL(wname, wreg, wshift, winvert, \ 99 wcontrols, wncontrols)\ 100 { .id = snd_soc_dapm_mixer_named_ctl, .name = wname, \ 101 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 102 .kcontrol_news = wcontrols, .num_kcontrols = wncontrols} 103 /* DEPRECATED: use SND_SOC_DAPM_SUPPLY */ 104 #define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \ 105 { .id = snd_soc_dapm_micbias, .name = wname, \ 106 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 107 .kcontrol_news = NULL, .num_kcontrols = 0} 108 #define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \ 109 { .id = snd_soc_dapm_switch, .name = wname, \ 110 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 111 .kcontrol_news = wcontrols, .num_kcontrols = 1} 112 #define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \ 113 { .id = snd_soc_dapm_mux, .name = wname, \ 114 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 115 .kcontrol_news = wcontrols, .num_kcontrols = 1} 116 #define SND_SOC_DAPM_DEMUX(wname, wreg, wshift, winvert, wcontrols) \ 117 { .id = snd_soc_dapm_demux, .name = wname, \ 118 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 119 .kcontrol_news = wcontrols, .num_kcontrols = 1} 120 121 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */ 122 #define SOC_PGA_ARRAY(wname, wreg, wshift, winvert,\ 123 wcontrols) \ 124 { .id = snd_soc_dapm_pga, .name = wname, \ 125 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 126 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)} 127 #define SOC_MIXER_ARRAY(wname, wreg, wshift, winvert, \ 128 wcontrols)\ 129 { .id = snd_soc_dapm_mixer, .name = wname, \ 130 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 131 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)} 132 #define SOC_MIXER_NAMED_CTL_ARRAY(wname, wreg, wshift, winvert, \ 133 wcontrols)\ 134 { .id = snd_soc_dapm_mixer_named_ctl, .name = wname, \ 135 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 136 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)} 137 138 /* path domain with event - event handler must return 0 for success */ 139 #define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \ 140 wncontrols, wevent, wflags) \ 141 { .id = snd_soc_dapm_pga, .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_OUT_DRV_E(wname, wreg, wshift, winvert, wcontrols, \ 146 wncontrols, wevent, wflags) \ 147 { .id = snd_soc_dapm_out_drv, .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_E(wname, wreg, wshift, winvert, wcontrols, \ 152 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, .num_kcontrols = wncontrols, \ 156 .event = wevent, .event_flags = wflags} 157 #define SND_SOC_DAPM_MIXER_NAMED_CTL_E(wname, wreg, wshift, winvert, \ 158 wcontrols, wncontrols, wevent, wflags) \ 159 { .id = snd_soc_dapm_mixer, .name = wname, \ 160 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 161 .kcontrol_news = wcontrols, \ 162 .num_kcontrols = wncontrols, .event = wevent, .event_flags = wflags} 163 #define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \ 164 wevent, wflags) \ 165 { .id = snd_soc_dapm_switch, .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_MUX_E(wname, wreg, wshift, winvert, wcontrols, \ 170 wevent, wflags) \ 171 { .id = snd_soc_dapm_mux, .name = wname, \ 172 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 173 .kcontrol_news = wcontrols, .num_kcontrols = 1, \ 174 .event = wevent, .event_flags = wflags} 175 176 /* additional sequencing control within an event type */ 177 #define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \ 178 wevent, wflags) \ 179 { .id = snd_soc_dapm_pga, .name = wname, \ 180 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 181 .event = wevent, .event_flags = wflags, \ 182 .subseq = wsubseq} 183 #define SND_SOC_DAPM_SUPPLY_S(wname, wsubseq, wreg, wshift, winvert, wevent, \ 184 wflags) \ 185 { .id = snd_soc_dapm_supply, .name = wname, \ 186 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 187 .event = wevent, .event_flags = wflags, .subseq = wsubseq} 188 189 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */ 190 #define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \ 191 wevent, wflags) \ 192 { .id = snd_soc_dapm_pga, .name = wname, \ 193 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 194 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \ 195 .event = wevent, .event_flags = wflags} 196 #define SOC_MIXER_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \ 197 wevent, wflags) \ 198 { .id = snd_soc_dapm_mixer, .name = wname, \ 199 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 200 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \ 201 .event = wevent, .event_flags = wflags} 202 #define SOC_MIXER_NAMED_CTL_E_ARRAY(wname, wreg, wshift, winvert, \ 203 wcontrols, wevent, wflags) \ 204 { .id = snd_soc_dapm_mixer, .name = wname, \ 205 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 206 .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \ 207 .event = wevent, .event_flags = wflags} 208 209 /* events that are pre and post DAPM */ 210 #define SND_SOC_DAPM_PRE(wname, wevent) \ 211 { .id = snd_soc_dapm_pre, .name = wname, .kcontrol_news = NULL, \ 212 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \ 213 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD} 214 #define SND_SOC_DAPM_POST(wname, wevent) \ 215 { .id = snd_soc_dapm_post, .name = wname, .kcontrol_news = NULL, \ 216 .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \ 217 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD} 218 219 /* stream domain */ 220 #define SND_SOC_DAPM_AIF_IN(wname, stname, wslot, wreg, wshift, winvert) \ 221 { .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \ 222 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), } 223 #define SND_SOC_DAPM_AIF_IN_E(wname, stname, wslot, wreg, wshift, winvert, \ 224 wevent, wflags) \ 225 { .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \ 226 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 227 .event = wevent, .event_flags = wflags } 228 #define SND_SOC_DAPM_AIF_OUT(wname, stname, wslot, wreg, wshift, winvert) \ 229 { .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \ 230 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), } 231 #define SND_SOC_DAPM_AIF_OUT_E(wname, stname, wslot, wreg, wshift, winvert, \ 232 wevent, wflags) \ 233 { .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \ 234 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 235 .event = wevent, .event_flags = wflags } 236 #define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \ 237 { .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \ 238 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) } 239 #define SND_SOC_DAPM_DAC_E(wname, stname, wreg, wshift, winvert, \ 240 wevent, wflags) \ 241 { .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \ 242 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 243 .event = wevent, .event_flags = wflags} 244 245 #define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \ 246 { .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \ 247 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), } 248 #define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \ 249 wevent, wflags) \ 250 { .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \ 251 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 252 .event = wevent, .event_flags = wflags} 253 #define SND_SOC_DAPM_CLOCK_SUPPLY(wname) \ 254 { .id = snd_soc_dapm_clock_supply, .name = wname, \ 255 .reg = SND_SOC_NOPM, .event = dapm_clock_event, \ 256 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD } 257 258 /* generic widgets */ 259 #define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \ 260 { .id = wid, .name = wname, .kcontrol_news = NULL, .num_kcontrols = 0, \ 261 .reg = wreg, .shift = wshift, .mask = wmask, \ 262 .on_val = won_val, .off_val = woff_val, } 263 #define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \ 264 { .id = snd_soc_dapm_supply, .name = wname, \ 265 SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \ 266 .event = wevent, .event_flags = wflags} 267 #define SND_SOC_DAPM_REGULATOR_SUPPLY(wname, wdelay, wflags) \ 268 { .id = snd_soc_dapm_regulator_supply, .name = wname, \ 269 .reg = SND_SOC_NOPM, .shift = wdelay, .event = dapm_regulator_event, \ 270 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD, \ 271 .on_val = wflags} 272 273 274 /* dapm kcontrol types */ 275 #define SOC_DAPM_DOUBLE(xname, reg, lshift, rshift, max, invert) \ 276 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 277 .info = snd_soc_info_volsw, \ 278 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \ 279 .private_value = SOC_DOUBLE_VALUE(reg, lshift, rshift, max, invert, 0) } 280 #define SOC_DAPM_DOUBLE_R(xname, lreg, rreg, shift, max, invert) \ 281 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 282 .info = snd_soc_info_volsw, \ 283 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \ 284 .private_value = SOC_DOUBLE_R_VALUE(lreg, rreg, shift, max, invert) } 285 #define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \ 286 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 287 .info = snd_soc_info_volsw, \ 288 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \ 289 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) } 290 #define SOC_DAPM_SINGLE_AUTODISABLE(xname, reg, shift, max, invert) \ 291 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 292 .info = snd_soc_info_volsw, \ 293 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \ 294 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 1) } 295 #define SOC_DAPM_SINGLE_VIRT(xname, max) \ 296 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0) 297 #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \ 298 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 299 .info = snd_soc_info_volsw, \ 300 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 301 .tlv.p = (tlv_array), \ 302 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \ 303 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) } 304 #define SOC_DAPM_SINGLE_TLV_AUTODISABLE(xname, reg, shift, max, invert, tlv_array) \ 305 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 306 .info = snd_soc_info_volsw, \ 307 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 308 .tlv.p = (tlv_array), \ 309 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \ 310 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 1) } 311 #define SOC_DAPM_SINGLE_TLV_VIRT(xname, max, tlv_array) \ 312 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0, tlv_array) 313 #define SOC_DAPM_ENUM(xname, xenum) \ 314 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 315 .info = snd_soc_info_enum_double, \ 316 .get = snd_soc_dapm_get_enum_double, \ 317 .put = snd_soc_dapm_put_enum_double, \ 318 .private_value = (unsigned long)&xenum } 319 #define SOC_DAPM_ENUM_EXT(xname, xenum, xget, xput) \ 320 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 321 .info = snd_soc_info_enum_double, \ 322 .get = xget, \ 323 .put = xput, \ 324 .private_value = (unsigned long)&xenum } 325 #define SOC_DAPM_PIN_SWITCH(xname) \ 326 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \ 327 .info = snd_soc_dapm_info_pin_switch, \ 328 .get = snd_soc_dapm_get_pin_switch, \ 329 .put = snd_soc_dapm_put_pin_switch, \ 330 .private_value = (unsigned long)xname } 331 332 /* dapm stream operations */ 333 #define SND_SOC_DAPM_STREAM_NOP 0x0 334 #define SND_SOC_DAPM_STREAM_START 0x1 335 #define SND_SOC_DAPM_STREAM_STOP 0x2 336 #define SND_SOC_DAPM_STREAM_SUSPEND 0x4 337 #define SND_SOC_DAPM_STREAM_RESUME 0x8 338 #define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10 339 #define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20 340 341 /* dapm event types */ 342 #define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */ 343 #define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */ 344 #define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */ 345 #define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */ 346 #define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */ 347 #define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */ 348 #define SND_SOC_DAPM_WILL_PMU 0x40 /* called at start of sequence */ 349 #define SND_SOC_DAPM_WILL_PMD 0x80 /* called at start of sequence */ 350 #define SND_SOC_DAPM_PRE_POST_PMD \ 351 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD) 352 353 /* convenience event type detection */ 354 #define SND_SOC_DAPM_EVENT_ON(e) \ 355 (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU)) 356 #define SND_SOC_DAPM_EVENT_OFF(e) \ 357 (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)) 358 359 /* regulator widget flags */ 360 #define SND_SOC_DAPM_REGULATOR_BYPASS 0x1 /* bypass when disabled */ 361 362 struct snd_soc_dapm_widget; 363 enum snd_soc_dapm_type; 364 struct snd_soc_dapm_path; 365 struct snd_soc_dapm_pin; 366 struct snd_soc_dapm_route; 367 struct snd_soc_dapm_context; 368 struct regulator; 369 struct snd_soc_dapm_widget_list; 370 struct snd_soc_dapm_update; 371 enum snd_soc_dapm_direction; 372 373 int dapm_regulator_event(struct snd_soc_dapm_widget *w, 374 struct snd_kcontrol *kcontrol, int event); 375 int dapm_clock_event(struct snd_soc_dapm_widget *w, 376 struct snd_kcontrol *kcontrol, int event); 377 378 /* dapm controls */ 379 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol, 380 struct snd_ctl_elem_value *ucontrol); 381 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol, 382 struct snd_ctl_elem_value *ucontrol); 383 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol, 384 struct snd_ctl_elem_value *ucontrol); 385 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol, 386 struct snd_ctl_elem_value *ucontrol); 387 int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol, 388 struct snd_ctl_elem_info *uinfo); 389 int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol, 390 struct snd_ctl_elem_value *uncontrol); 391 int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol, 392 struct snd_ctl_elem_value *uncontrol); 393 int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm, 394 const struct snd_soc_dapm_widget *widget, 395 int num); 396 struct snd_soc_dapm_widget *snd_soc_dapm_new_control( 397 struct snd_soc_dapm_context *dapm, 398 const struct snd_soc_dapm_widget *widget); 399 int snd_soc_dapm_new_dai_widgets(struct snd_soc_dapm_context *dapm, 400 struct snd_soc_dai *dai); 401 int snd_soc_dapm_link_dai_widgets(struct snd_soc_card *card); 402 void snd_soc_dapm_connect_dai_link_widgets(struct snd_soc_card *card); 403 int snd_soc_dapm_new_pcm(struct snd_soc_card *card, 404 const struct snd_soc_pcm_stream *params, 405 unsigned int num_params, 406 struct snd_soc_dapm_widget *source, 407 struct snd_soc_dapm_widget *sink); 408 409 /* dapm path setup */ 410 int snd_soc_dapm_new_widgets(struct snd_soc_card *card); 411 void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm); 412 int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm, 413 const struct snd_soc_dapm_route *route, int num); 414 int snd_soc_dapm_del_routes(struct snd_soc_dapm_context *dapm, 415 const struct snd_soc_dapm_route *route, int num); 416 int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm, 417 const struct snd_soc_dapm_route *route, int num); 418 void snd_soc_dapm_free_widget(struct snd_soc_dapm_widget *w); 419 void snd_soc_dapm_reset_cache(struct snd_soc_dapm_context *dapm); 420 421 /* dapm events */ 422 void snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd, int stream, 423 int event); 424 void snd_soc_dapm_shutdown(struct snd_soc_card *card); 425 426 /* external DAPM widget events */ 427 int snd_soc_dapm_mixer_update_power(struct snd_soc_dapm_context *dapm, 428 struct snd_kcontrol *kcontrol, int connect, 429 struct snd_soc_dapm_update *update); 430 int snd_soc_dapm_mux_update_power(struct snd_soc_dapm_context *dapm, 431 struct snd_kcontrol *kcontrol, int mux, struct soc_enum *e, 432 struct snd_soc_dapm_update *update); 433 434 /* dapm sys fs - used by the core */ 435 extern struct attribute *soc_dapm_dev_attrs[]; 436 void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm, 437 struct dentry *parent); 438 439 /* dapm audio pin control and status */ 440 int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm, 441 const char *pin); 442 int snd_soc_dapm_enable_pin_unlocked(struct snd_soc_dapm_context *dapm, 443 const char *pin); 444 int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm, 445 const char *pin); 446 int snd_soc_dapm_disable_pin_unlocked(struct snd_soc_dapm_context *dapm, 447 const char *pin); 448 int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin); 449 int snd_soc_dapm_nc_pin_unlocked(struct snd_soc_dapm_context *dapm, 450 const char *pin); 451 int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm, 452 const char *pin); 453 int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm); 454 int snd_soc_dapm_sync_unlocked(struct snd_soc_dapm_context *dapm); 455 int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm, 456 const char *pin); 457 int snd_soc_dapm_force_enable_pin_unlocked(struct snd_soc_dapm_context *dapm, 458 const char *pin); 459 int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm, 460 const char *pin); 461 unsigned int dapm_kcontrol_get_value(const struct snd_kcontrol *kcontrol); 462 463 /* Mostly internal - should not normally be used */ 464 void dapm_mark_endpoints_dirty(struct snd_soc_card *card); 465 466 /* dapm path query */ 467 int snd_soc_dapm_dai_get_connected_widgets(struct snd_soc_dai *dai, int stream, 468 struct snd_soc_dapm_widget_list **list, 469 bool (*custom_stop_condition)(struct snd_soc_dapm_widget *, 470 enum snd_soc_dapm_direction)); 471 472 struct snd_soc_dapm_context *snd_soc_dapm_kcontrol_dapm( 473 struct snd_kcontrol *kcontrol); 474 475 struct snd_soc_dapm_widget *snd_soc_dapm_kcontrol_widget( 476 struct snd_kcontrol *kcontrol); 477 478 int snd_soc_dapm_force_bias_level(struct snd_soc_dapm_context *dapm, 479 enum snd_soc_bias_level level); 480 481 /* dapm widget types */ 482 enum snd_soc_dapm_type { 483 snd_soc_dapm_input = 0, /* input pin */ 484 snd_soc_dapm_output, /* output pin */ 485 snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */ 486 snd_soc_dapm_demux, /* connects the input to one of multiple outputs */ 487 snd_soc_dapm_mixer, /* mixes several analog signals together */ 488 snd_soc_dapm_mixer_named_ctl, /* mixer with named controls */ 489 snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */ 490 snd_soc_dapm_out_drv, /* output driver */ 491 snd_soc_dapm_adc, /* analog to digital converter */ 492 snd_soc_dapm_dac, /* digital to analog converter */ 493 snd_soc_dapm_micbias, /* microphone bias (power) - DEPRECATED: use snd_soc_dapm_supply */ 494 snd_soc_dapm_mic, /* microphone */ 495 snd_soc_dapm_hp, /* headphones */ 496 snd_soc_dapm_spk, /* speaker */ 497 snd_soc_dapm_line, /* line input/output */ 498 snd_soc_dapm_switch, /* analog switch */ 499 snd_soc_dapm_vmid, /* codec bias/vmid - to minimise pops */ 500 snd_soc_dapm_pre, /* machine specific pre widget - exec first */ 501 snd_soc_dapm_post, /* machine specific post widget - exec last */ 502 snd_soc_dapm_supply, /* power/clock supply */ 503 snd_soc_dapm_regulator_supply, /* external regulator */ 504 snd_soc_dapm_clock_supply, /* external clock */ 505 snd_soc_dapm_aif_in, /* audio interface input */ 506 snd_soc_dapm_aif_out, /* audio interface output */ 507 snd_soc_dapm_siggen, /* signal generator */ 508 snd_soc_dapm_sink, 509 snd_soc_dapm_dai_in, /* link to DAI structure */ 510 snd_soc_dapm_dai_out, 511 snd_soc_dapm_dai_link, /* link between two DAI structures */ 512 snd_soc_dapm_kcontrol, /* Auto-disabled kcontrol */ 513 snd_soc_dapm_buffer, /* DSP/CODEC internal buffer */ 514 snd_soc_dapm_scheduler, /* DSP/CODEC internal scheduler */ 515 snd_soc_dapm_effect, /* DSP/CODEC effect component */ 516 snd_soc_dapm_src, /* DSP/CODEC SRC component */ 517 snd_soc_dapm_asrc, /* DSP/CODEC ASRC component */ 518 snd_soc_dapm_encoder, /* FW/SW audio encoder component */ 519 snd_soc_dapm_decoder, /* FW/SW audio decoder component */ 520 }; 521 522 enum snd_soc_dapm_subclass { 523 SND_SOC_DAPM_CLASS_INIT = 0, 524 SND_SOC_DAPM_CLASS_RUNTIME = 1, 525 }; 526 527 /* 528 * DAPM audio route definition. 529 * 530 * Defines an audio route originating at source via control and finishing 531 * at sink. 532 */ 533 struct snd_soc_dapm_route { 534 const char *sink; 535 const char *control; 536 const char *source; 537 538 /* Note: currently only supported for links where source is a supply */ 539 int (*connected)(struct snd_soc_dapm_widget *source, 540 struct snd_soc_dapm_widget *sink); 541 }; 542 543 /* dapm audio path between two widgets */ 544 struct snd_soc_dapm_path { 545 const char *name; 546 547 /* 548 * source (input) and sink (output) widgets 549 * The union is for convience, since it is a lot nicer to type 550 * p->source, rather than p->node[SND_SOC_DAPM_DIR_IN] 551 */ 552 union { 553 struct { 554 struct snd_soc_dapm_widget *source; 555 struct snd_soc_dapm_widget *sink; 556 }; 557 struct snd_soc_dapm_widget *node[2]; 558 }; 559 560 /* status */ 561 u32 connect:1; /* source and sink widgets are connected */ 562 u32 walking:1; /* path is in the process of being walked */ 563 u32 weak:1; /* path ignored for power management */ 564 u32 is_supply:1; /* At least one of the connected widgets is a supply */ 565 566 int (*connected)(struct snd_soc_dapm_widget *source, 567 struct snd_soc_dapm_widget *sink); 568 569 struct list_head list_node[2]; 570 struct list_head list_kcontrol; 571 struct list_head list; 572 }; 573 574 /* dapm widget */ 575 struct snd_soc_dapm_widget { 576 enum snd_soc_dapm_type id; 577 const char *name; /* widget name */ 578 const char *sname; /* stream name */ 579 struct list_head list; 580 struct snd_soc_dapm_context *dapm; 581 582 void *priv; /* widget specific data */ 583 struct regulator *regulator; /* attached regulator */ 584 const struct snd_soc_pcm_stream *params; /* params for dai links */ 585 unsigned int num_params; /* number of params for dai links */ 586 unsigned int params_select; /* currently selected param for dai link */ 587 588 /* dapm control */ 589 int reg; /* negative reg = no direct dapm */ 590 unsigned char shift; /* bits to shift */ 591 unsigned int mask; /* non-shifted mask */ 592 unsigned int on_val; /* on state value */ 593 unsigned int off_val; /* off state value */ 594 unsigned char power:1; /* block power status */ 595 unsigned char active:1; /* active stream on DAC, ADC's */ 596 unsigned char connected:1; /* connected codec pin */ 597 unsigned char new:1; /* cnew complete */ 598 unsigned char force:1; /* force state */ 599 unsigned char ignore_suspend:1; /* kept enabled over suspend */ 600 unsigned char new_power:1; /* power from this run */ 601 unsigned char power_checked:1; /* power checked this run */ 602 unsigned char is_supply:1; /* Widget is a supply type widget */ 603 unsigned char is_ep:2; /* Widget is a endpoint type widget */ 604 int subseq; /* sort within widget type */ 605 606 int (*power_check)(struct snd_soc_dapm_widget *w); 607 608 /* external events */ 609 unsigned short event_flags; /* flags to specify event types */ 610 int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int); 611 612 /* kcontrols that relate to this widget */ 613 int num_kcontrols; 614 const struct snd_kcontrol_new *kcontrol_news; 615 struct snd_kcontrol **kcontrols; 616 struct snd_soc_dobj dobj; 617 618 /* widget input and output edges */ 619 struct list_head edges[2]; 620 621 /* used during DAPM updates */ 622 struct list_head work_list; 623 struct list_head power_list; 624 struct list_head dirty; 625 int endpoints[2]; 626 627 struct clk *clk; 628 }; 629 630 struct snd_soc_dapm_update { 631 struct snd_kcontrol *kcontrol; 632 int reg; 633 int mask; 634 int val; 635 int reg2; 636 int mask2; 637 int val2; 638 bool has_second_set; 639 }; 640 641 struct snd_soc_dapm_wcache { 642 struct snd_soc_dapm_widget *widget; 643 }; 644 645 /* DAPM context */ 646 struct snd_soc_dapm_context { 647 enum snd_soc_bias_level bias_level; 648 unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */ 649 /* Go to BIAS_OFF in suspend if the DAPM context is idle */ 650 unsigned int suspend_bias_off:1; 651 void (*seq_notifier)(struct snd_soc_dapm_context *, 652 enum snd_soc_dapm_type, int); 653 654 struct device *dev; /* from parent - for debug */ 655 struct snd_soc_component *component; /* parent component */ 656 struct snd_soc_card *card; /* parent card */ 657 658 /* used during DAPM updates */ 659 enum snd_soc_bias_level target_bias_level; 660 struct list_head list; 661 662 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event); 663 int (*set_bias_level)(struct snd_soc_dapm_context *dapm, 664 enum snd_soc_bias_level level); 665 666 struct snd_soc_dapm_wcache path_sink_cache; 667 struct snd_soc_dapm_wcache path_source_cache; 668 669 #ifdef CONFIG_DEBUG_FS 670 struct dentry *debugfs_dapm; 671 #endif 672 }; 673 674 /* A list of widgets associated with an object, typically a snd_kcontrol */ 675 struct snd_soc_dapm_widget_list { 676 int num_widgets; 677 struct snd_soc_dapm_widget *widgets[0]; 678 }; 679 680 struct snd_soc_dapm_stats { 681 int power_checks; 682 int path_checks; 683 int neighbour_checks; 684 }; 685 686 /** 687 * snd_soc_dapm_init_bias_level() - Initialize DAPM bias level 688 * @dapm: The DAPM context to initialize 689 * @level: The DAPM level to initialize to 690 * 691 * This function only sets the driver internal state of the DAPM level and will 692 * not modify the state of the device. Hence it should not be used during normal 693 * operation, but only to synchronize the internal state to the device state. 694 * E.g. during driver probe to set the DAPM level to the one corresponding with 695 * the power-on reset state of the device. 696 * 697 * To change the DAPM state of the device use snd_soc_dapm_set_bias_level(). 698 */ 699 static inline void snd_soc_dapm_init_bias_level( 700 struct snd_soc_dapm_context *dapm, enum snd_soc_bias_level level) 701 { 702 dapm->bias_level = level; 703 } 704 705 /** 706 * snd_soc_dapm_get_bias_level() - Get current DAPM bias level 707 * @dapm: The context for which to get the bias level 708 * 709 * Returns: The current bias level of the passed DAPM context. 710 */ 711 static inline enum snd_soc_bias_level snd_soc_dapm_get_bias_level( 712 struct snd_soc_dapm_context *dapm) 713 { 714 return dapm->bias_level; 715 } 716 717 enum snd_soc_dapm_direction { 718 SND_SOC_DAPM_DIR_IN, 719 SND_SOC_DAPM_DIR_OUT 720 }; 721 722 #define SND_SOC_DAPM_DIR_TO_EP(x) BIT(x) 723 724 #define SND_SOC_DAPM_EP_SOURCE SND_SOC_DAPM_DIR_TO_EP(SND_SOC_DAPM_DIR_IN) 725 #define SND_SOC_DAPM_EP_SINK SND_SOC_DAPM_DIR_TO_EP(SND_SOC_DAPM_DIR_OUT) 726 727 /** 728 * snd_soc_dapm_widget_for_each_sink_path - Iterates over all paths in the 729 * specified direction of a widget 730 * @w: The widget 731 * @dir: Whether to iterate over the paths where the specified widget is the 732 * incoming or outgoing widgets 733 * @p: The path iterator variable 734 */ 735 #define snd_soc_dapm_widget_for_each_path(w, dir, p) \ 736 list_for_each_entry(p, &w->edges[dir], list_node[dir]) 737 738 /** 739 * snd_soc_dapm_widget_for_each_sink_path_safe - Iterates over all paths in the 740 * specified direction of a widget 741 * @w: The widget 742 * @dir: Whether to iterate over the paths where the specified widget is the 743 * incoming or outgoing widgets 744 * @p: The path iterator variable 745 * @next_p: Temporary storage for the next path 746 * 747 * This function works like snd_soc_dapm_widget_for_each_sink_path, expect that 748 * it is safe to remove the current path from the list while iterating 749 */ 750 #define snd_soc_dapm_widget_for_each_path_safe(w, dir, p, next_p) \ 751 list_for_each_entry_safe(p, next_p, &w->edges[dir], list_node[dir]) 752 753 /** 754 * snd_soc_dapm_widget_for_each_sink_path - Iterates over all paths leaving a 755 * widget 756 * @w: The widget 757 * @p: The path iterator variable 758 */ 759 #define snd_soc_dapm_widget_for_each_sink_path(w, p) \ 760 snd_soc_dapm_widget_for_each_path(w, SND_SOC_DAPM_DIR_IN, p) 761 762 /** 763 * snd_soc_dapm_widget_for_each_source_path - Iterates over all paths leading to 764 * a widget 765 * @w: The widget 766 * @p: The path iterator variable 767 */ 768 #define snd_soc_dapm_widget_for_each_source_path(w, p) \ 769 snd_soc_dapm_widget_for_each_path(w, SND_SOC_DAPM_DIR_OUT, p) 770 771 #endif 772