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