LXR linux/include/sound/soc-dapm.h

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