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_SINGLE(xname, reg, shift, 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_SINGLE_VALUE(reg, shift, max, invert, 0) } 280 #define SOC_DAPM_SINGLE_AUTODISABLE(xname, reg, 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_SINGLE_VALUE(reg, shift, max, invert, 1) } 285 #define SOC_DAPM_SINGLE_VIRT(xname, max) \ 286 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0) 287 #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \ 288 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 289 .info = snd_soc_info_volsw, \ 290 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 291 .tlv.p = (tlv_array), \ 292 .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \ 293 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) } 294 #define SOC_DAPM_SINGLE_TLV_AUTODISABLE(xname, reg, shift, max, invert, tlv_array) \ 295 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 296 .info = snd_soc_info_volsw, \ 297 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 298 .tlv.p = (tlv_array), \ 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_TLV_VIRT(xname, max, tlv_array) \ 302 SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0, tlv_array) 303 #define SOC_DAPM_ENUM(xname, xenum) \ 304 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 305 .info = snd_soc_info_enum_double, \ 306 .get = snd_soc_dapm_get_enum_double, \ 307 .put = snd_soc_dapm_put_enum_double, \ 308 .private_value = (unsigned long)&xenum } 309 #define SOC_DAPM_ENUM_EXT(xname, xenum, xget, xput) \ 310 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 311 .info = snd_soc_info_enum_double, \ 312 .get = xget, \ 313 .put = xput, \ 314 .private_value = (unsigned long)&xenum } 315 #define SOC_DAPM_PIN_SWITCH(xname) \ 316 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \ 317 .info = snd_soc_dapm_info_pin_switch, \ 318 .get = snd_soc_dapm_get_pin_switch, \ 319 .put = snd_soc_dapm_put_pin_switch, \ 320 .private_value = (unsigned long)xname } 321 322 /* dapm stream operations */ 323 #define SND_SOC_DAPM_STREAM_NOP 0x0 324 #define SND_SOC_DAPM_STREAM_START 0x1 325 #define SND_SOC_DAPM_STREAM_STOP 0x2 326 #define SND_SOC_DAPM_STREAM_SUSPEND 0x4 327 #define SND_SOC_DAPM_STREAM_RESUME 0x8 328 #define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10 329 #define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20 330 331 /* dapm event types */ 332 #define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */ 333 #define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */ 334 #define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */ 335 #define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */ 336 #define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */ 337 #define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */ 338 #define SND_SOC_DAPM_WILL_PMU 0x40 /* called at start of sequence */ 339 #define SND_SOC_DAPM_WILL_PMD 0x80 /* called at start of sequence */ 340 #define SND_SOC_DAPM_PRE_POST_PMD \ 341 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD) 342 343 /* convenience event type detection */ 344 #define SND_SOC_DAPM_EVENT_ON(e) \ 345 (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU)) 346 #define SND_SOC_DAPM_EVENT_OFF(e) \ 347 (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)) 348 349 /* regulator widget flags */ 350 #define SND_SOC_DAPM_REGULATOR_BYPASS 0x1 /* bypass when disabled */ 351 352 struct snd_soc_dapm_widget; 353 enum snd_soc_dapm_type; 354 struct snd_soc_dapm_path; 355 struct snd_soc_dapm_pin; 356 struct snd_soc_dapm_route; 357 struct snd_soc_dapm_context; 358 struct regulator; 359 struct snd_soc_dapm_widget_list; 360 struct snd_soc_dapm_update; 361 362 int dapm_regulator_event(struct snd_soc_dapm_widget *w, 363 struct snd_kcontrol *kcontrol, int event); 364 int dapm_clock_event(struct snd_soc_dapm_widget *w, 365 struct snd_kcontrol *kcontrol, int event); 366 367 /* dapm controls */ 368 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol, 369 struct snd_ctl_elem_value *ucontrol); 370 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol, 371 struct snd_ctl_elem_value *ucontrol); 372 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol, 373 struct snd_ctl_elem_value *ucontrol); 374 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol, 375 struct snd_ctl_elem_value *ucontrol); 376 int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol, 377 struct snd_ctl_elem_info *uinfo); 378 int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol, 379 struct snd_ctl_elem_value *uncontrol); 380 int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol, 381 struct snd_ctl_elem_value *uncontrol); 382 int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm, 383 const struct snd_soc_dapm_widget *widget, 384 int num); 385 int snd_soc_dapm_new_dai_widgets(struct snd_soc_dapm_context *dapm, 386 struct snd_soc_dai *dai); 387 int snd_soc_dapm_link_dai_widgets(struct snd_soc_card *card); 388 void snd_soc_dapm_connect_dai_link_widgets(struct snd_soc_card *card); 389 int snd_soc_dapm_new_pcm(struct snd_soc_card *card, 390 const struct snd_soc_pcm_stream *params, 391 unsigned int num_params, 392 struct snd_soc_dapm_widget *source, 393 struct snd_soc_dapm_widget *sink); 394 395 /* dapm path setup */ 396 int snd_soc_dapm_new_widgets(struct snd_soc_card *card); 397 void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm); 398 int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm, 399 const struct snd_soc_dapm_route *route, int num); 400 int snd_soc_dapm_del_routes(struct snd_soc_dapm_context *dapm, 401 const struct snd_soc_dapm_route *route, int num); 402 int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm, 403 const struct snd_soc_dapm_route *route, int num); 404 void snd_soc_dapm_free_widget(struct snd_soc_dapm_widget *w); 405 void snd_soc_dapm_reset_cache(struct snd_soc_dapm_context *dapm); 406 407 /* dapm events */ 408 void snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd, int stream, 409 int event); 410 void snd_soc_dapm_shutdown(struct snd_soc_card *card); 411 412 /* external DAPM widget events */ 413 int snd_soc_dapm_mixer_update_power(struct snd_soc_dapm_context *dapm, 414 struct snd_kcontrol *kcontrol, int connect, 415 struct snd_soc_dapm_update *update); 416 int snd_soc_dapm_mux_update_power(struct snd_soc_dapm_context *dapm, 417 struct snd_kcontrol *kcontrol, int mux, struct soc_enum *e, 418 struct snd_soc_dapm_update *update); 419 420 /* dapm sys fs - used by the core */ 421 extern struct attribute *soc_dapm_dev_attrs[]; 422 void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm, 423 struct dentry *parent); 424 425 /* dapm audio pin control and status */ 426 int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm, 427 const char *pin); 428 int snd_soc_dapm_enable_pin_unlocked(struct snd_soc_dapm_context *dapm, 429 const char *pin); 430 int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm, 431 const char *pin); 432 int snd_soc_dapm_disable_pin_unlocked(struct snd_soc_dapm_context *dapm, 433 const char *pin); 434 int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin); 435 int snd_soc_dapm_nc_pin_unlocked(struct snd_soc_dapm_context *dapm, 436 const char *pin); 437 int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm, 438 const char *pin); 439 int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm); 440 int snd_soc_dapm_sync_unlocked(struct snd_soc_dapm_context *dapm); 441 int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm, 442 const char *pin); 443 int snd_soc_dapm_force_enable_pin_unlocked(struct snd_soc_dapm_context *dapm, 444 const char *pin); 445 int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm, 446 const char *pin); 447 unsigned int dapm_kcontrol_get_value(const struct snd_kcontrol *kcontrol); 448 449 /* Mostly internal - should not normally be used */ 450 void dapm_mark_endpoints_dirty(struct snd_soc_card *card); 451 452 /* dapm path query */ 453 int snd_soc_dapm_dai_get_connected_widgets(struct snd_soc_dai *dai, int stream, 454 struct snd_soc_dapm_widget_list **list); 455 456 struct snd_soc_dapm_context *snd_soc_dapm_kcontrol_dapm( 457 struct snd_kcontrol *kcontrol); 458 459 struct snd_soc_dapm_widget *snd_soc_dapm_kcontrol_widget( 460 struct snd_kcontrol *kcontrol); 461 462 int snd_soc_dapm_force_bias_level(struct snd_soc_dapm_context *dapm, 463 enum snd_soc_bias_level level); 464 465 /* dapm widget types */ 466 enum snd_soc_dapm_type { 467 snd_soc_dapm_input = 0, /* input pin */ 468 snd_soc_dapm_output, /* output pin */ 469 snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */ 470 snd_soc_dapm_demux, /* connects the input to one of multiple outputs */ 471 snd_soc_dapm_mixer, /* mixes several analog signals together */ 472 snd_soc_dapm_mixer_named_ctl, /* mixer with named controls */ 473 snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */ 474 snd_soc_dapm_out_drv, /* output driver */ 475 snd_soc_dapm_adc, /* analog to digital converter */ 476 snd_soc_dapm_dac, /* digital to analog converter */ 477 snd_soc_dapm_micbias, /* microphone bias (power) - DEPRECATED: use snd_soc_dapm_supply */ 478 snd_soc_dapm_mic, /* microphone */ 479 snd_soc_dapm_hp, /* headphones */ 480 snd_soc_dapm_spk, /* speaker */ 481 snd_soc_dapm_line, /* line input/output */ 482 snd_soc_dapm_switch, /* analog switch */ 483 snd_soc_dapm_vmid, /* codec bias/vmid - to minimise pops */ 484 snd_soc_dapm_pre, /* machine specific pre widget - exec first */ 485 snd_soc_dapm_post, /* machine specific post widget - exec last */ 486 snd_soc_dapm_supply, /* power/clock supply */ 487 snd_soc_dapm_regulator_supply, /* external regulator */ 488 snd_soc_dapm_clock_supply, /* external clock */ 489 snd_soc_dapm_aif_in, /* audio interface input */ 490 snd_soc_dapm_aif_out, /* audio interface output */ 491 snd_soc_dapm_siggen, /* signal generator */ 492 snd_soc_dapm_sink, 493 snd_soc_dapm_dai_in, /* link to DAI structure */ 494 snd_soc_dapm_dai_out, 495 snd_soc_dapm_dai_link, /* link between two DAI structures */ 496 snd_soc_dapm_kcontrol, /* Auto-disabled kcontrol */ 497 }; 498 499 enum snd_soc_dapm_subclass { 500 SND_SOC_DAPM_CLASS_INIT = 0, 501 SND_SOC_DAPM_CLASS_RUNTIME = 1, 502 }; 503 504 /* 505 * DAPM audio route definition. 506 * 507 * Defines an audio route originating at source via control and finishing 508 * at sink. 509 */ 510 struct snd_soc_dapm_route { 511 const char *sink; 512 const char *control; 513 const char *source; 514 515 /* Note: currently only supported for links where source is a supply */ 516 int (*connected)(struct snd_soc_dapm_widget *source, 517 struct snd_soc_dapm_widget *sink); 518 }; 519 520 /* dapm audio path between two widgets */ 521 struct snd_soc_dapm_path { 522 const char *name; 523 524 /* 525 * source (input) and sink (output) widgets 526 * The union is for convience, since it is a lot nicer to type 527 * p->source, rather than p->node[SND_SOC_DAPM_DIR_IN] 528 */ 529 union { 530 struct { 531 struct snd_soc_dapm_widget *source; 532 struct snd_soc_dapm_widget *sink; 533 }; 534 struct snd_soc_dapm_widget *node[2]; 535 }; 536 537 /* status */ 538 u32 connect:1; /* source and sink widgets are connected */ 539 u32 walking:1; /* path is in the process of being walked */ 540 u32 weak:1; /* path ignored for power management */ 541 u32 is_supply:1; /* At least one of the connected widgets is a supply */ 542 543 int (*connected)(struct snd_soc_dapm_widget *source, 544 struct snd_soc_dapm_widget *sink); 545 546 struct list_head list_node[2]; 547 struct list_head list_kcontrol; 548 struct list_head list; 549 }; 550 551 /* dapm widget */ 552 struct snd_soc_dapm_widget { 553 enum snd_soc_dapm_type id; 554 const char *name; /* widget name */ 555 const char *sname; /* stream name */ 556 struct list_head list; 557 struct snd_soc_dapm_context *dapm; 558 559 void *priv; /* widget specific data */ 560 struct regulator *regulator; /* attached regulator */ 561 const struct snd_soc_pcm_stream *params; /* params for dai links */ 562 unsigned int num_params; /* number of params for dai links */ 563 unsigned int params_select; /* currently selected param for dai link */ 564 565 /* dapm control */ 566 int reg; /* negative reg = no direct dapm */ 567 unsigned char shift; /* bits to shift */ 568 unsigned int mask; /* non-shifted mask */ 569 unsigned int on_val; /* on state value */ 570 unsigned int off_val; /* off state value */ 571 unsigned char power:1; /* block power status */ 572 unsigned char active:1; /* active stream on DAC, ADC's */ 573 unsigned char connected:1; /* connected codec pin */ 574 unsigned char new:1; /* cnew complete */ 575 unsigned char force:1; /* force state */ 576 unsigned char ignore_suspend:1; /* kept enabled over suspend */ 577 unsigned char new_power:1; /* power from this run */ 578 unsigned char power_checked:1; /* power checked this run */ 579 unsigned char is_supply:1; /* Widget is a supply type widget */ 580 unsigned char is_ep:2; /* Widget is a endpoint type widget */ 581 int subseq; /* sort within widget type */ 582 583 int (*power_check)(struct snd_soc_dapm_widget *w); 584 585 /* external events */ 586 unsigned short event_flags; /* flags to specify event types */ 587 int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int); 588 589 /* kcontrols that relate to this widget */ 590 int num_kcontrols; 591 const struct snd_kcontrol_new *kcontrol_news; 592 struct snd_kcontrol **kcontrols; 593 struct snd_soc_dobj dobj; 594 595 /* widget input and output edges */ 596 struct list_head edges[2]; 597 598 /* used during DAPM updates */ 599 struct list_head work_list; 600 struct list_head power_list; 601 struct list_head dirty; 602 int endpoints[2]; 603 604 struct clk *clk; 605 }; 606 607 struct snd_soc_dapm_update { 608 struct snd_kcontrol *kcontrol; 609 int reg; 610 int mask; 611 int val; 612 }; 613 614 struct snd_soc_dapm_wcache { 615 struct snd_soc_dapm_widget *widget; 616 }; 617 618 /* DAPM context */ 619 struct snd_soc_dapm_context { 620 enum snd_soc_bias_level bias_level; 621 unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */ 622 /* Go to BIAS_OFF in suspend if the DAPM context is idle */ 623 unsigned int suspend_bias_off:1; 624 void (*seq_notifier)(struct snd_soc_dapm_context *, 625 enum snd_soc_dapm_type, int); 626 627 struct device *dev; /* from parent - for debug */ 628 struct snd_soc_component *component; /* parent component */ 629 struct snd_soc_card *card; /* parent card */ 630 631 /* used during DAPM updates */ 632 enum snd_soc_bias_level target_bias_level; 633 struct list_head list; 634 635 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event); 636 int (*set_bias_level)(struct snd_soc_dapm_context *dapm, 637 enum snd_soc_bias_level level); 638 639 struct snd_soc_dapm_wcache path_sink_cache; 640 struct snd_soc_dapm_wcache path_source_cache; 641 642 #ifdef CONFIG_DEBUG_FS 643 struct dentry *debugfs_dapm; 644 #endif 645 }; 646 647 /* A list of widgets associated with an object, typically a snd_kcontrol */ 648 struct snd_soc_dapm_widget_list { 649 int num_widgets; 650 struct snd_soc_dapm_widget *widgets[0]; 651 }; 652 653 struct snd_soc_dapm_stats { 654 int power_checks; 655 int path_checks; 656 int neighbour_checks; 657 }; 658 659 /** 660 * snd_soc_dapm_init_bias_level() - Initialize DAPM bias level 661 * @dapm: The DAPM context to initialize 662 * @level: The DAPM level to initialize to 663 * 664 * This function only sets the driver internal state of the DAPM level and will 665 * not modify the state of the device. Hence it should not be used during normal 666 * operation, but only to synchronize the internal state to the device state. 667 * E.g. during driver probe to set the DAPM level to the one corresponding with 668 * the power-on reset state of the device. 669 * 670 * To change the DAPM state of the device use snd_soc_dapm_set_bias_level(). 671 */ 672 static inline void snd_soc_dapm_init_bias_level( 673 struct snd_soc_dapm_context *dapm, enum snd_soc_bias_level level) 674 { 675 dapm->bias_level = level; 676 } 677 678 /** 679 * snd_soc_dapm_get_bias_level() - Get current DAPM bias level 680 * @dapm: The context for which to get the bias level 681 * 682 * Returns: The current bias level of the passed DAPM context. 683 */ 684 static inline enum snd_soc_bias_level snd_soc_dapm_get_bias_level( 685 struct snd_soc_dapm_context *dapm) 686 { 687 return dapm->bias_level; 688 } 689 690 enum snd_soc_dapm_direction { 691 SND_SOC_DAPM_DIR_IN, 692 SND_SOC_DAPM_DIR_OUT 693 }; 694 695 #define SND_SOC_DAPM_DIR_TO_EP(x) BIT(x) 696 697 #define SND_SOC_DAPM_EP_SOURCE SND_SOC_DAPM_DIR_TO_EP(SND_SOC_DAPM_DIR_IN) 698 #define SND_SOC_DAPM_EP_SINK SND_SOC_DAPM_DIR_TO_EP(SND_SOC_DAPM_DIR_OUT) 699 700 /** 701 * snd_soc_dapm_widget_for_each_sink_path - Iterates over all paths in the 702 * specified direction of a widget 703 * @w: The widget 704 * @dir: Whether to iterate over the paths where the specified widget is the 705 * incoming or outgoing widgets 706 * @p: The path iterator variable 707 */ 708 #define snd_soc_dapm_widget_for_each_path(w, dir, p) \ 709 list_for_each_entry(p, &w->edges[dir], list_node[dir]) 710 711 /** 712 * snd_soc_dapm_widget_for_each_sink_path_safe - Iterates over all paths in the 713 * specified direction of a widget 714 * @w: The widget 715 * @dir: Whether to iterate over the paths where the specified widget is the 716 * incoming or outgoing widgets 717 * @p: The path iterator variable 718 * @next_p: Temporary storage for the next path 719 * 720 * This function works like snd_soc_dapm_widget_for_each_sink_path, expect that 721 * it is safe to remove the current path from the list while iterating 722 */ 723 #define snd_soc_dapm_widget_for_each_path_safe(w, dir, p, next_p) \ 724 list_for_each_entry_safe(p, next_p, &w->edges[dir], list_node[dir]) 725 726 /** 727 * snd_soc_dapm_widget_for_each_sink_path - Iterates over all paths leaving a 728 * widget 729 * @w: The widget 730 * @p: The path iterator variable 731 */ 732 #define snd_soc_dapm_widget_for_each_sink_path(w, p) \ 733 snd_soc_dapm_widget_for_each_path(w, SND_SOC_DAPM_DIR_IN, p) 734 735 /** 736 * snd_soc_dapm_widget_for_each_source_path - Iterates over all paths leading to 737 * a widget 738 * @w: The widget 739 * @p: The path iterator variable 740 */ 741 #define snd_soc_dapm_widget_for_each_source_path(w, p) \ 742 snd_soc_dapm_widget_for_each_path(w, SND_SOC_DAPM_DIR_OUT, p) 743 744 #endif 745