include/sound/soc-dapm.h

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