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
  19 struct device;
  20
  21 /* widget has no PM register bit */
  22 #define SND_SOC_NOPM    -1
  23
  24 /*
  25  * SoC dynamic audio power management
  26  *
  27  * We can have up to 4 power domains
  28  *  1. Codec domain - VREF, VMID
  29  *     Usually controlled at codec probe/remove, although can be set
  30  *     at stream time if power is not needed for sidetone, etc.
  31  *  2. Platform/Machine domain - physically connected inputs and outputs
  32  *     Is platform/machine and user action specific, is set in the machine
  33  *     driver and by userspace e.g when HP are inserted
  34  *  3. Path domain - Internal codec path mixers
  35  *     Are automatically set when mixer and mux settings are
  36  *     changed by the user.
  37  *  4. Stream domain - DAC's and ADC's.
  38  *     Enabled when stream playback/capture is started.
  39  */
  40
  41 /* codec domain */
  42 #define SND_SOC_DAPM_VMID(wname) \
  43 {       .id = snd_soc_dapm_vmid, .name = wname, .kcontrol_news = NULL, \
  44         .num_kcontrols = 0}
  45
  46 /* platform domain */
  47 #define SND_SOC_DAPM_SIGGEN(wname) \
  48 {       .id = snd_soc_dapm_siggen, .name = wname, .kcontrol_news = NULL, \
  49         .num_kcontrols = 0, .reg = SND_SOC_NOPM }
  50 #define SND_SOC_DAPM_INPUT(wname) \
  51 {       .id = snd_soc_dapm_input, .name = wname, .kcontrol_news = NULL, \
  52         .num_kcontrols = 0, .reg = SND_SOC_NOPM }
  53 #define SND_SOC_DAPM_OUTPUT(wname) \
  54 {       .id = snd_soc_dapm_output, .name = wname, .kcontrol_news = NULL, \
  55         .num_kcontrols = 0, .reg = SND_SOC_NOPM }
  56 #define SND_SOC_DAPM_MIC(wname, wevent) \
  57 {       .id = snd_soc_dapm_mic, .name = wname, .kcontrol_news = NULL, \
  58         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
  59         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
  60 #define SND_SOC_DAPM_HP(wname, wevent) \
  61 {       .id = snd_soc_dapm_hp, .name = wname, .kcontrol_news = NULL, \
  62         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
  63         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
  64 #define SND_SOC_DAPM_SPK(wname, wevent) \
  65 {       .id = snd_soc_dapm_spk, .name = wname, .kcontrol_news = NULL, \
  66         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
  67         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
  68 #define SND_SOC_DAPM_LINE(wname, wevent) \
  69 {       .id = snd_soc_dapm_line, .name = wname, .kcontrol_news = NULL, \
  70         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
  71         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
  72
  73 #define SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) \
  74         .reg = wreg, .mask = 1, .shift = wshift, \
  75         .on_val = winvert ? 0 : 1, .off_val = winvert ? 1 : 0
  76
  77 /* path domain */
  78 #define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\
  79          wcontrols, wncontrols) \
  80 {       .id = snd_soc_dapm_pga, .name = wname, \
  81         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
  82         .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
  83 #define SND_SOC_DAPM_OUT_DRV(wname, wreg, wshift, winvert,\
  84          wcontrols, wncontrols) \
  85 {       .id = snd_soc_dapm_out_drv, .name = wname, \
  86         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
  87         .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
  88 #define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
  89          wcontrols, wncontrols)\
  90 {       .id = snd_soc_dapm_mixer, .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_NAMED_CTL(wname, wreg, wshift, winvert, \
  94          wcontrols, wncontrols)\
  95 {       .id = snd_soc_dapm_mixer_named_ctl, .name = wname, \
  96         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
  97         .kcontrol_news = wcontrols, .num_kcontrols = wncontrols}
  98 #define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
  99 {       .id = snd_soc_dapm_micbias, .name = wname, \
 100         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 101         .kcontrol_news = NULL, .num_kcontrols = 0}
 102 #define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
 103 {       .id = snd_soc_dapm_switch, .name = wname, \
 104         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 105         .kcontrol_news = wcontrols, .num_kcontrols = 1}
 106 #define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
 107 {       .id = snd_soc_dapm_mux, .name = wname, \
 108         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 109         .kcontrol_news = wcontrols, .num_kcontrols = 1}
 110 #define SND_SOC_DAPM_VIRT_MUX(wname, wreg, wshift, winvert, wcontrols) \
 111 {       .id = snd_soc_dapm_virt_mux, .name = wname, \
 112         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 113         .kcontrol_news = wcontrols, .num_kcontrols = 1}
 114 #define SND_SOC_DAPM_VALUE_MUX(wname, wreg, wshift, winvert, wcontrols) \
 115 {       .id = snd_soc_dapm_value_mux, .name = wname, \
 116         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 117         .kcontrol_news = wcontrols, .num_kcontrols = 1}
 118
 119 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
 120 #define SOC_PGA_ARRAY(wname, wreg, wshift, winvert,\
 121          wcontrols) \
 122 {       .id = snd_soc_dapm_pga, .name = wname, \
 123         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 124         .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
 125 #define SOC_MIXER_ARRAY(wname, wreg, wshift, winvert, \
 126          wcontrols)\
 127 {       .id = snd_soc_dapm_mixer, .name = wname, \
 128         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 129         .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
 130 #define SOC_MIXER_NAMED_CTL_ARRAY(wname, wreg, wshift, winvert, \
 131          wcontrols)\
 132 {       .id = snd_soc_dapm_mixer_named_ctl, .name = wname, \
 133         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 134         .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
 135
 136 /* path domain with event - event handler must return 0 for success */
 137 #define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \
 138         wncontrols, wevent, wflags) \
 139 {       .id = snd_soc_dapm_pga, .name = wname, \
 140         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 141         .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
 142         .event = wevent, .event_flags = wflags}
 143 #define SND_SOC_DAPM_OUT_DRV_E(wname, wreg, wshift, winvert, wcontrols, \
 144         wncontrols, wevent, wflags) \
 145 {       .id = snd_soc_dapm_out_drv, .name = wname, \
 146         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 147         .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
 148         .event = wevent, .event_flags = wflags}
 149 #define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \
 150         wncontrols, wevent, wflags) \
 151 {       .id = snd_soc_dapm_mixer, .name = wname, \
 152         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 153         .kcontrol_news = wcontrols, .num_kcontrols = wncontrols, \
 154         .event = wevent, .event_flags = wflags}
 155 #define SND_SOC_DAPM_MIXER_NAMED_CTL_E(wname, wreg, wshift, winvert, \
 156         wcontrols, wncontrols, wevent, wflags) \
 157 {       .id = snd_soc_dapm_mixer, .name = wname, \
 158         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 159         .kcontrol_news = wcontrols, \
 160         .num_kcontrols = wncontrols, .event = wevent, .event_flags = wflags}
 161 #define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
 162         wevent, wflags) \
 163 {       .id = snd_soc_dapm_switch, .name = wname, \
 164         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 165         .kcontrol_news = wcontrols, .num_kcontrols = 1, \
 166         .event = wevent, .event_flags = wflags}
 167 #define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
 168         wevent, wflags) \
 169 {       .id = snd_soc_dapm_mux, .name = wname, \
 170         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 171         .kcontrol_news = wcontrols, .num_kcontrols = 1, \
 172         .event = wevent, .event_flags = wflags}
 173 #define SND_SOC_DAPM_VIRT_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
 174         wevent, wflags) \
 175 {       .id = snd_soc_dapm_virt_mux, .name = wname, \
 176         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 177         .kcontrol_news = wcontrols, .num_kcontrols = 1, \
 178         .event = wevent, .event_flags = wflags}
 179
 180 /* additional sequencing control within an event type */
 181 #define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \
 182         wevent, wflags) \
 183 {       .id = snd_soc_dapm_pga, .name = wname, \
 184         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 185         .event = wevent, .event_flags = wflags, \
 186         .subseq = wsubseq}
 187 #define SND_SOC_DAPM_SUPPLY_S(wname, wsubseq, wreg, wshift, winvert, wevent, \
 188         wflags) \
 189 {       .id = snd_soc_dapm_supply, .name = wname, \
 190         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 191         .event = wevent, .event_flags = wflags, .subseq = wsubseq}
 192
 193 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
 194 #define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
 195         wevent, wflags) \
 196 {       .id = snd_soc_dapm_pga, .name = wname, \
 197         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 198         .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
 199         .event = wevent, .event_flags = wflags}
 200 #define SOC_MIXER_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
 201         wevent, wflags) \
 202 {       .id = snd_soc_dapm_mixer, .name = wname, \
 203         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 204         .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
 205         .event = wevent, .event_flags = wflags}
 206 #define SOC_MIXER_NAMED_CTL_E_ARRAY(wname, wreg, wshift, winvert, \
 207         wcontrols, wevent, wflags) \
 208 {       .id = snd_soc_dapm_mixer, .name = wname, \
 209         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 210         .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
 211         .event = wevent, .event_flags = wflags}
 212
 213 /* events that are pre and post DAPM */
 214 #define SND_SOC_DAPM_PRE(wname, wevent) \
 215 {       .id = snd_soc_dapm_pre, .name = wname, .kcontrol_news = NULL, \
 216         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
 217         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
 218 #define SND_SOC_DAPM_POST(wname, wevent) \
 219 {       .id = snd_soc_dapm_post, .name = wname, .kcontrol_news = NULL, \
 220         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
 221         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
 222
 223 /* stream domain */
 224 #define SND_SOC_DAPM_AIF_IN(wname, stname, wslot, wreg, wshift, winvert) \
 225 {       .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
 226         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
 227 #define SND_SOC_DAPM_AIF_IN_E(wname, stname, wslot, wreg, wshift, winvert, \
 228                               wevent, wflags)                           \
 229 {       .id = snd_soc_dapm_aif_in, .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_AIF_OUT(wname, stname, wslot, wreg, wshift, winvert) \
 233 {       .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
 234         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
 235 #define SND_SOC_DAPM_AIF_OUT_E(wname, stname, wslot, wreg, wshift, winvert, \
 236                              wevent, wflags)                            \
 237 {       .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
 238         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 239         .event = wevent, .event_flags = wflags }
 240 #define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
 241 {       .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \
 242         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) }
 243 #define SND_SOC_DAPM_DAC_E(wname, stname, wreg, wshift, winvert, \
 244                            wevent, wflags)                              \
 245 {       .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \
 246         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 247         .event = wevent, .event_flags = wflags}
 248
 249 #define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
 250 {       .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \
 251         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
 252 #define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \
 253                            wevent, wflags)                              \
 254 {       .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \
 255         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 256         .event = wevent, .event_flags = wflags}
 257 #define SND_SOC_DAPM_CLOCK_SUPPLY(wname) \
 258 {       .id = snd_soc_dapm_clock_supply, .name = wname, \
 259         .reg = SND_SOC_NOPM, .event = dapm_clock_event, \
 260         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD }
 261
 262 /* generic widgets */
 263 #define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
 264 {       .id = wid, .name = wname, .kcontrol_news = NULL, .num_kcontrols = 0, \
 265         .reg = -((wreg) + 1), .shift = wshift, .mask = wmask, \
 266         .on_val = won_val, .off_val = woff_val, .event = dapm_reg_event, \
 267         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
 268 #define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \
 269 {       .id = snd_soc_dapm_supply, .name = wname, \
 270         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 271         .event = wevent, .event_flags = wflags}
 272 #define SND_SOC_DAPM_REGULATOR_SUPPLY(wname, wdelay, wflags)        \
 273 {       .id = snd_soc_dapm_regulator_supply, .name = wname, \
 274         .reg = SND_SOC_NOPM, .shift = wdelay, .event = dapm_regulator_event, \
 275         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD, \
 276         .on_val = wflags}
 277
 278
 279 /* dapm kcontrol types */
 280 #define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
 281 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 282         .info = snd_soc_info_volsw, \
 283         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
 284         .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
 285 #define SOC_DAPM_SINGLE_AUTODISABLE(xname, reg, shift, max, invert) \
 286 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 287         .info = snd_soc_info_volsw, \
 288         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
 289         .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 1) }
 290 #define SOC_DAPM_SINGLE_VIRT(xname, max) \
 291         SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0)
 292 #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
 293 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 294         .info = snd_soc_info_volsw, \
 295         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 296         .tlv.p = (tlv_array), \
 297         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
 298         .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
 299 #define SOC_DAPM_SINGLE_TLV_AUTODISABLE(xname, reg, shift, max, invert, tlv_array) \
 300 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 301         .info = snd_soc_info_volsw, \
 302         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 303         .tlv.p = (tlv_array), \
 304         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
 305         .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
 306 #define SOC_DAPM_SINGLE_TLV_VIRT(xname, max, tlv_array) \
 307         SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0, tlv_array)
 308 #define SOC_DAPM_ENUM(xname, xenum) \
 309 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 310         .info = snd_soc_info_enum_double, \
 311         .get = snd_soc_dapm_get_enum_double, \
 312         .put = snd_soc_dapm_put_enum_double, \
 313         .private_value = (unsigned long)&xenum }
 314 #define SOC_DAPM_ENUM_VIRT(xname, xenum)                    \
 315 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 316         .info = snd_soc_info_enum_double, \
 317         .get = snd_soc_dapm_get_enum_virt, \
 318         .put = snd_soc_dapm_put_enum_virt, \
 319         .private_value = (unsigned long)&xenum }
 320 #define SOC_DAPM_ENUM_EXT(xname, xenum, xget, xput) \
 321 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 322         .info = snd_soc_info_enum_double, \
 323         .get = xget, \
 324         .put = xput, \
 325         .private_value = (unsigned long)&xenum }
 326 #define SOC_DAPM_VALUE_ENUM(xname, xenum) \
 327 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 328         .info = snd_soc_info_enum_double, \
 329         .get = snd_soc_dapm_get_value_enum_double, \
 330         .put = snd_soc_dapm_put_value_enum_double, \
 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
 360 /* convenience event type detection */
 361 #define SND_SOC_DAPM_EVENT_ON(e)        \
 362         (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
 363 #define SND_SOC_DAPM_EVENT_OFF(e)       \
 364         (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
 365
 366 /* regulator widget flags */
 367 #define SND_SOC_DAPM_REGULATOR_BYPASS     0x1     /* bypass when disabled */
 368
 369 struct snd_soc_dapm_widget;
 370 enum snd_soc_dapm_type;
 371 struct snd_soc_dapm_path;
 372 struct snd_soc_dapm_pin;
 373 struct snd_soc_dapm_route;
 374 struct snd_soc_dapm_context;
 375 struct regulator;
 376 struct snd_soc_dapm_widget_list;
 377 struct snd_soc_dapm_update;
 378
 379 int dapm_reg_event(struct snd_soc_dapm_widget *w,
 380                    struct snd_kcontrol *kcontrol, int event);
 381 int dapm_regulator_event(struct snd_soc_dapm_widget *w,
 382                          struct snd_kcontrol *kcontrol, int event);
 383 int dapm_clock_event(struct snd_soc_dapm_widget *w,
 384                          struct snd_kcontrol *kcontrol, int event);
 385
 386 /* dapm controls */
 387 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
 388         struct snd_ctl_elem_value *ucontrol);
 389 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
 390         struct snd_ctl_elem_value *ucontrol);
 391 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
 392         struct snd_ctl_elem_value *ucontrol);
 393 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
 394         struct snd_ctl_elem_value *ucontrol);
 395 int snd_soc_dapm_get_enum_virt(struct snd_kcontrol *kcontrol,
 396         struct snd_ctl_elem_value *ucontrol);
 397 int snd_soc_dapm_put_enum_virt(struct snd_kcontrol *kcontrol,
 398         struct snd_ctl_elem_value *ucontrol);
 399 int snd_soc_dapm_get_value_enum_double(struct snd_kcontrol *kcontrol,
 400         struct snd_ctl_elem_value *ucontrol);
 401 int snd_soc_dapm_put_value_enum_double(struct snd_kcontrol *kcontrol,
 402         struct snd_ctl_elem_value *ucontrol);
 403 int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
 404         struct snd_ctl_elem_info *uinfo);
 405 int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
 406         struct snd_ctl_elem_value *uncontrol);
 407 int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
 408         struct snd_ctl_elem_value *uncontrol);
 409 int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
 410         const struct snd_soc_dapm_widget *widget,
 411         int num);
 412 int snd_soc_dapm_new_dai_widgets(struct snd_soc_dapm_context *dapm,
 413                                  struct snd_soc_dai *dai);
 414 int snd_soc_dapm_link_dai_widgets(struct snd_soc_card *card);
 415 int snd_soc_dapm_new_pcm(struct snd_soc_card *card,
 416                          const struct snd_soc_pcm_stream *params,
 417                          struct snd_soc_dapm_widget *source,
 418                          struct snd_soc_dapm_widget *sink);
 419
 420 /* dapm path setup */
 421 int snd_soc_dapm_new_widgets(struct snd_soc_card *card);
 422 void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
 423 int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
 424                             const struct snd_soc_dapm_route *route, int num);
 425 int snd_soc_dapm_del_routes(struct snd_soc_dapm_context *dapm,
 426                             const struct snd_soc_dapm_route *route, int num);
 427 int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm,
 428                              const struct snd_soc_dapm_route *route, int num);
 429
 430 /* dapm events */
 431 void snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd, int stream,
 432         int event);
 433 void snd_soc_dapm_shutdown(struct snd_soc_card *card);
 434
 435 /* external DAPM widget events */
 436 int snd_soc_dapm_mixer_update_power(struct snd_soc_dapm_context *dapm,
 437                 struct snd_kcontrol *kcontrol, int connect,
 438                 struct snd_soc_dapm_update *update);
 439 int snd_soc_dapm_mux_update_power(struct snd_soc_dapm_context *dapm,
 440                 struct snd_kcontrol *kcontrol, int mux, struct soc_enum *e,
 441                 struct snd_soc_dapm_update *update);
 442
 443 /* dapm sys fs - used by the core */
 444 int snd_soc_dapm_sys_add(struct device *dev);
 445 void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm,
 446                                 struct dentry *parent);
 447
 448 /* dapm audio pin control and status */
 449 int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
 450                             const char *pin);
 451 int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
 452                              const char *pin);
 453 int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
 454 int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
 455                                 const char *pin);
 456 int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
 457 int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
 458                                   const char *pin);
 459 int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
 460                                 const char *pin);
 461 void snd_soc_dapm_auto_nc_codec_pins(struct snd_soc_codec *codec);
 462
 463 /* Mostly internal - should not normally be used */
 464 void dapm_mark_dirty(struct snd_soc_dapm_widget *w, const char *reason);
 465 void dapm_mark_io_dirty(struct snd_soc_dapm_context *dapm);
 466
 467 /* dapm path query */
 468 int snd_soc_dapm_dai_get_connected_widgets(struct snd_soc_dai *dai, int stream,
 469         struct snd_soc_dapm_widget_list **list);
 470
 471 struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(struct snd_kcontrol *kcontrol);
 472
 473 /* dapm widget types */
 474 enum snd_soc_dapm_type {
 475         snd_soc_dapm_input = 0,         /* input pin */
 476         snd_soc_dapm_output,            /* output pin */
 477         snd_soc_dapm_mux,                       /* selects 1 analog signal from many inputs */
 478         snd_soc_dapm_virt_mux,                  /* virtual version of snd_soc_dapm_mux */
 479         snd_soc_dapm_value_mux,                 /* selects 1 analog signal from many inputs */
 480         snd_soc_dapm_mixer,                     /* mixes several analog signals together */
 481         snd_soc_dapm_mixer_named_ctl,           /* mixer with named controls */
 482         snd_soc_dapm_pga,                       /* programmable gain/attenuation (volume) */
 483         snd_soc_dapm_out_drv,                   /* output driver */
 484         snd_soc_dapm_adc,                       /* analog to digital converter */
 485         snd_soc_dapm_dac,                       /* digital to analog converter */
 486         snd_soc_dapm_micbias,           /* microphone bias (power) */
 487         snd_soc_dapm_mic,                       /* microphone */
 488         snd_soc_dapm_hp,                        /* headphones */
 489         snd_soc_dapm_spk,                       /* speaker */
 490         snd_soc_dapm_line,                      /* line input/output */
 491         snd_soc_dapm_switch,            /* analog switch */
 492         snd_soc_dapm_vmid,                      /* codec bias/vmid - to minimise pops */
 493         snd_soc_dapm_pre,                       /* machine specific pre widget - exec first */
 494         snd_soc_dapm_post,                      /* machine specific post widget - exec last */
 495         snd_soc_dapm_supply,            /* power/clock supply */
 496         snd_soc_dapm_regulator_supply,  /* external regulator */
 497         snd_soc_dapm_clock_supply,      /* external clock */
 498         snd_soc_dapm_aif_in,            /* audio interface input */
 499         snd_soc_dapm_aif_out,           /* audio interface output */
 500         snd_soc_dapm_siggen,            /* signal generator */
 501         snd_soc_dapm_dai_in,            /* link to DAI structure */
 502         snd_soc_dapm_dai_out,
 503         snd_soc_dapm_dai_link,          /* link between two DAI structures */
 504         snd_soc_dapm_kcontrol,          /* Auto-disabled kcontrol */
 505 };
 506
 507 enum snd_soc_dapm_subclass {
 508         SND_SOC_DAPM_CLASS_INIT         = 0,
 509         SND_SOC_DAPM_CLASS_RUNTIME      = 1,
 510 };
 511
 512 /*
 513  * DAPM audio route definition.
 514  *
 515  * Defines an audio route originating at source via control and finishing
 516  * at sink.
 517  */
 518 struct snd_soc_dapm_route {
 519         const char *sink;
 520         const char *control;
 521         const char *source;
 522
 523         /* Note: currently only supported for links where source is a supply */
 524         int (*connected)(struct snd_soc_dapm_widget *source,
 525                          struct snd_soc_dapm_widget *sink);
 526 };
 527
 528 /* dapm audio path between two widgets */
 529 struct snd_soc_dapm_path {
 530         const char *name;
 531
 532         /* source (input) and sink (output) widgets */
 533         struct snd_soc_dapm_widget *source;
 534         struct snd_soc_dapm_widget *sink;
 535
 536         /* status */
 537         u32 connect:1;  /* source and sink widgets are connected */
 538         u32 walked:1;   /* path has been walked */
 539         u32 walking:1;  /* path is in the process of being walked */
 540         u32 weak:1;     /* path ignored for power management */
 541
 542         int (*connected)(struct snd_soc_dapm_widget *source,
 543                          struct snd_soc_dapm_widget *sink);
 544
 545         struct list_head list_source;
 546         struct list_head list_sink;
 547         struct list_head list_kcontrol;
 548         struct list_head list;
 549 };
 550
 551 /* dapm widget */
 552 struct snd_soc_dapm_widget {
 553         enum snd_soc_dapm_type id;
 554         const char *name;               /* widget name */
 555         const char *sname;      /* stream name */
 556         struct snd_soc_codec *codec;
 557         struct snd_soc_platform *platform;
 558         struct list_head list;
 559         struct snd_soc_dapm_context *dapm;
 560
 561         void *priv;                             /* widget specific data */
 562         struct regulator *regulator;            /* attached regulator */
 563         const struct snd_soc_pcm_stream *params; /* params for dai links */
 564
 565         /* dapm control */
 566         int reg;                                /* negative reg = no direct dapm */
 567         unsigned char shift;                    /* bits to shift */
 568         unsigned int mask;                      /* non-shifted mask */
 569         unsigned int on_val;                    /* on state value */
 570         unsigned int off_val;                   /* off state value */
 571         unsigned char power:1;                  /* block power status */
 572         unsigned char active:1;                 /* active stream on DAC, ADC's */
 573         unsigned char connected:1;              /* connected codec pin */
 574         unsigned char new:1;                    /* cnew complete */
 575         unsigned char ext:1;                    /* has external widgets */
 576         unsigned char force:1;                  /* force state */
 577         unsigned char ignore_suspend:1;         /* kept enabled over suspend */
 578         unsigned char new_power:1;              /* power from this run */
 579         unsigned char power_checked:1;          /* power checked this run */
 580         int subseq;                             /* sort within widget type */
 581
 582         int (*power_check)(struct snd_soc_dapm_widget *w);
 583
 584         /* external events */
 585         unsigned short event_flags;             /* flags to specify event types */
 586         int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
 587
 588         /* kcontrols that relate to this widget */
 589         int num_kcontrols;
 590         const struct snd_kcontrol_new *kcontrol_news;
 591         struct snd_kcontrol **kcontrols;
 592
 593         /* widget input and outputs */
 594         struct list_head sources;
 595         struct list_head sinks;
 596
 597         /* used during DAPM updates */
 598         struct list_head power_list;
 599         struct list_head dirty;
 600         int inputs;
 601         int outputs;
 602
 603         struct clk *clk;
 604 };
 605
 606 struct snd_soc_dapm_update {
 607         struct snd_kcontrol *kcontrol;
 608         int reg;
 609         int mask;
 610         int val;
 611 };
 612
 613 /* DAPM context */
 614 struct snd_soc_dapm_context {
 615         enum snd_soc_bias_level bias_level;
 616         enum snd_soc_bias_level suspend_bias_level;
 617         struct delayed_work delayed_work;
 618         unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
 619
 620         void (*seq_notifier)(struct snd_soc_dapm_context *,
 621                              enum snd_soc_dapm_type, int);
 622
 623         struct device *dev; /* from parent - for debug */
 624         struct snd_soc_codec *codec; /* parent codec */
 625         struct snd_soc_platform *platform; /* parent platform */
 626         struct snd_soc_card *card; /* parent card */
 627
 628         /* used during DAPM updates */
 629         enum snd_soc_bias_level target_bias_level;
 630         struct list_head list;
 631
 632         int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
 633
 634 #ifdef CONFIG_DEBUG_FS
 635         struct dentry *debugfs_dapm;
 636 #endif
 637 };
 638
 639 /* A list of widgets associated with an object, typically a snd_kcontrol */
 640 struct snd_soc_dapm_widget_list {
 641         int num_widgets;
 642         struct snd_soc_dapm_widget *widgets[0];
 643 };
 644
 645 struct snd_soc_dapm_stats {
 646         int power_checks;
 647         int path_checks;
 648         int neighbour_checks;
 649 };
 650
 651 #endif