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