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, .reg = wreg, \
 108         .kcontrol_news = wcontrols, .num_kcontrols = 1}
 109 #define SND_SOC_DAPM_VIRT_MUX(wname, wreg, wshift, winvert, wcontrols) \
 110 {       .id = snd_soc_dapm_virt_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_VALUE_MUX(wname, wreg, wshift, winvert, wcontrols) \
 114 {       .id = snd_soc_dapm_value_mux, .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 #define SND_SOC_DAPM_VIRT_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
 173         wevent, wflags) \
 174 {       .id = snd_soc_dapm_virt_mux, .name = wname, \
 175         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 176         .kcontrol_news = wcontrols, .num_kcontrols = 1, \
 177         .event = wevent, .event_flags = wflags}
 178
 179 /* additional sequencing control within an event type */
 180 #define SND_SOC_DAPM_PGA_S(wname, wsubseq, wreg, wshift, winvert, \
 181         wevent, wflags) \
 182 {       .id = snd_soc_dapm_pga, .name = wname, \
 183         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 184         .event = wevent, .event_flags = wflags, \
 185         .subseq = wsubseq}
 186 #define SND_SOC_DAPM_SUPPLY_S(wname, wsubseq, wreg, wshift, winvert, wevent, \
 187         wflags) \
 188 {       .id = snd_soc_dapm_supply, .name = wname, \
 189         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 190         .event = wevent, .event_flags = wflags, .subseq = wsubseq}
 191
 192 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
 193 #define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
 194         wevent, wflags) \
 195 {       .id = snd_soc_dapm_pga, .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_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
 200         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 #define SOC_MIXER_NAMED_CTL_E_ARRAY(wname, wreg, wshift, winvert, \
 206         wcontrols, wevent, wflags) \
 207 {       .id = snd_soc_dapm_mixer, .name = wname, \
 208         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 209         .kcontrol_news = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
 210         .event = wevent, .event_flags = wflags}
 211
 212 /* events that are pre and post DAPM */
 213 #define SND_SOC_DAPM_PRE(wname, wevent) \
 214 {       .id = snd_soc_dapm_pre, .name = wname, .kcontrol_news = NULL, \
 215         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
 216         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
 217 #define SND_SOC_DAPM_POST(wname, wevent) \
 218 {       .id = snd_soc_dapm_post, .name = wname, .kcontrol_news = NULL, \
 219         .num_kcontrols = 0, .reg = SND_SOC_NOPM, .event = wevent, \
 220         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
 221
 222 /* stream domain */
 223 #define SND_SOC_DAPM_AIF_IN(wname, stname, wslot, wreg, wshift, winvert) \
 224 {       .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
 225         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
 226 #define SND_SOC_DAPM_AIF_IN_E(wname, stname, wslot, wreg, wshift, winvert, \
 227                               wevent, wflags)                           \
 228 {       .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
 229         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 230         .event = wevent, .event_flags = wflags }
 231 #define SND_SOC_DAPM_AIF_OUT(wname, stname, wslot, wreg, wshift, winvert) \
 232 {       .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
 233         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
 234 #define SND_SOC_DAPM_AIF_OUT_E(wname, stname, wslot, wreg, wshift, winvert, \
 235                              wevent, wflags)                            \
 236 {       .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
 237         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 238         .event = wevent, .event_flags = wflags }
 239 #define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
 240 {       .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \
 241         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert) }
 242 #define SND_SOC_DAPM_DAC_E(wname, stname, wreg, wshift, winvert, \
 243                            wevent, wflags)                              \
 244 {       .id = snd_soc_dapm_dac, .name = wname, .sname = stname, \
 245         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 246         .event = wevent, .event_flags = wflags}
 247
 248 #define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
 249 {       .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \
 250         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), }
 251 #define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \
 252                            wevent, wflags)                              \
 253 {       .id = snd_soc_dapm_adc, .name = wname, .sname = stname, \
 254         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 255         .event = wevent, .event_flags = wflags}
 256 #define SND_SOC_DAPM_CLOCK_SUPPLY(wname) \
 257 {       .id = snd_soc_dapm_clock_supply, .name = wname, \
 258         .reg = SND_SOC_NOPM, .event = dapm_clock_event, \
 259         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD }
 260
 261 /* generic widgets */
 262 #define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
 263 {       .id = wid, .name = wname, .kcontrol_news = NULL, .num_kcontrols = 0, \
 264         .reg = -((wreg) + 1), .shift = wshift, .mask = wmask, \
 265         .on_val = won_val, .off_val = woff_val, .event = dapm_reg_event, \
 266         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
 267 #define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \
 268 {       .id = snd_soc_dapm_supply, .name = wname, \
 269         SND_SOC_DAPM_INIT_REG_VAL(wreg, wshift, winvert), \
 270         .event = wevent, .event_flags = wflags}
 271 #define SND_SOC_DAPM_REGULATOR_SUPPLY(wname, wdelay, wflags)        \
 272 {       .id = snd_soc_dapm_regulator_supply, .name = wname, \
 273         .reg = SND_SOC_NOPM, .shift = wdelay, .event = dapm_regulator_event, \
 274         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD, \
 275         .on_val = wflags}
 276
 277
 278 /* dapm kcontrol types */
 279 #define SOC_DAPM_SINGLE(xname, reg, shift, 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_SINGLE_VALUE(reg, shift, max, invert, 0) }
 284 #define SOC_DAPM_SINGLE_AUTODISABLE(xname, reg, 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_SINGLE_VALUE(reg, shift, max, invert, 1) }
 289 #define SOC_DAPM_SINGLE_VIRT(xname, max) \
 290         SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0)
 291 #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
 292 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 293         .info = snd_soc_info_volsw, \
 294         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 295         .tlv.p = (tlv_array), \
 296         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
 297         .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
 298 #define SOC_DAPM_SINGLE_TLV_AUTODISABLE(xname, reg, shift, max, invert, tlv_array) \
 299 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 300         .info = snd_soc_info_volsw, \
 301         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 302         .tlv.p = (tlv_array), \
 303         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
 304         .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
 305 #define SOC_DAPM_SINGLE_TLV_VIRT(xname, max, tlv_array) \
 306         SOC_DAPM_SINGLE(xname, SND_SOC_NOPM, 0, max, 0, tlv_array)
 307 #define SOC_DAPM_ENUM(xname, xenum) \
 308 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 309         .info = snd_soc_info_enum_double, \
 310         .get = snd_soc_dapm_get_enum_double, \
 311         .put = snd_soc_dapm_put_enum_double, \
 312         .private_value = (unsigned long)&xenum }
 313 #define SOC_DAPM_ENUM_VIRT(xname, xenum)                    \
 314 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 315         .info = snd_soc_info_enum_double, \
 316         .get = snd_soc_dapm_get_enum_virt, \
 317         .put = snd_soc_dapm_put_enum_virt, \
 318         .private_value = (unsigned long)&xenum }
 319 #define SOC_DAPM_ENUM_EXT(xname, xenum, xget, xput) \
 320 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 321         .info = snd_soc_info_enum_double, \
 322         .get = xget, \
 323         .put = xput, \
 324         .private_value = (unsigned long)&xenum }
 325 #define SOC_DAPM_VALUE_ENUM(xname, xenum) \
 326 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 327         .info = snd_soc_info_enum_double, \
 328         .get = snd_soc_dapm_get_value_enum_double, \
 329         .put = snd_soc_dapm_put_value_enum_double, \
 330         .private_value = (unsigned long)&xenum }
 331 #define SOC_DAPM_PIN_SWITCH(xname) \
 332 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
 333         .info = snd_soc_dapm_info_pin_switch, \
 334         .get = snd_soc_dapm_get_pin_switch, \
 335         .put = snd_soc_dapm_put_pin_switch, \
 336         .private_value = (unsigned long)xname }
 337
 338 /* dapm stream operations */
 339 #define SND_SOC_DAPM_STREAM_NOP                 0x0
 340 #define SND_SOC_DAPM_STREAM_START               0x1
 341 #define SND_SOC_DAPM_STREAM_STOP                0x2
 342 #define SND_SOC_DAPM_STREAM_SUSPEND             0x4
 343 #define SND_SOC_DAPM_STREAM_RESUME              0x8
 344 #define SND_SOC_DAPM_STREAM_PAUSE_PUSH  0x10
 345 #define SND_SOC_DAPM_STREAM_PAUSE_RELEASE       0x20
 346
 347 /* dapm event types */
 348 #define SND_SOC_DAPM_PRE_PMU    0x1     /* before widget power up */
 349 #define SND_SOC_DAPM_POST_PMU   0x2             /* after widget power up */
 350 #define SND_SOC_DAPM_PRE_PMD    0x4     /* before widget power down */
 351 #define SND_SOC_DAPM_POST_PMD   0x8             /* after widget power down */
 352 #define SND_SOC_DAPM_PRE_REG    0x10    /* before audio path setup */
 353 #define SND_SOC_DAPM_POST_REG   0x20    /* after audio path setup */
 354 #define SND_SOC_DAPM_WILL_PMU   0x40    /* called at start of sequence */
 355 #define SND_SOC_DAPM_WILL_PMD   0x80    /* called at start of sequence */
 356 #define SND_SOC_DAPM_PRE_POST_PMD \
 357                                 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
 358
 359 /* convenience event type detection */
 360 #define SND_SOC_DAPM_EVENT_ON(e)        \
 361         (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
 362 #define SND_SOC_DAPM_EVENT_OFF(e)       \
 363         (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
 364
 365 /* regulator widget flags */
 366 #define SND_SOC_DAPM_REGULATOR_BYPASS     0x1     /* bypass when disabled */
 367
 368 struct snd_soc_dapm_widget;
 369 enum snd_soc_dapm_type;
 370 struct snd_soc_dapm_path;
 371 struct snd_soc_dapm_pin;
 372 struct snd_soc_dapm_route;
 373 struct snd_soc_dapm_context;
 374 struct regulator;
 375 struct snd_soc_dapm_widget_list;
 376 struct snd_soc_dapm_update;
 377
 378 int dapm_reg_event(struct snd_soc_dapm_widget *w,
 379                    struct snd_kcontrol *kcontrol, int event);
 380 int dapm_regulator_event(struct snd_soc_dapm_widget *w,
 381                          struct snd_kcontrol *kcontrol, int event);
 382 int dapm_clock_event(struct snd_soc_dapm_widget *w,
 383                          struct snd_kcontrol *kcontrol, int event);
 384
 385 /* dapm controls */
 386 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
 387         struct snd_ctl_elem_value *ucontrol);
 388 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
 389         struct snd_ctl_elem_value *ucontrol);
 390 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
 391         struct snd_ctl_elem_value *ucontrol);
 392 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
 393         struct snd_ctl_elem_value *ucontrol);
 394 int snd_soc_dapm_get_enum_virt(struct snd_kcontrol *kcontrol,
 395         struct snd_ctl_elem_value *ucontrol);
 396 int snd_soc_dapm_put_enum_virt(struct snd_kcontrol *kcontrol,
 397         struct snd_ctl_elem_value *ucontrol);
 398 int snd_soc_dapm_get_value_enum_double(struct snd_kcontrol *kcontrol,
 399         struct snd_ctl_elem_value *ucontrol);
 400 int snd_soc_dapm_put_value_enum_double(struct snd_kcontrol *kcontrol,
 401         struct snd_ctl_elem_value *ucontrol);
 402 int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
 403         struct snd_ctl_elem_info *uinfo);
 404 int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
 405         struct snd_ctl_elem_value *uncontrol);
 406 int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
 407         struct snd_ctl_elem_value *uncontrol);
 408 int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
 409         const struct snd_soc_dapm_widget *widget,
 410         int num);
 411 int snd_soc_dapm_new_dai_widgets(struct snd_soc_dapm_context *dapm,
 412                                  struct snd_soc_dai *dai);
 413 int snd_soc_dapm_link_dai_widgets(struct snd_soc_card *card);
 414 int snd_soc_dapm_new_pcm(struct snd_soc_card *card,
 415                          const struct snd_soc_pcm_stream *params,
 416                          struct snd_soc_dapm_widget *source,
 417                          struct snd_soc_dapm_widget *sink);
 418
 419 /* dapm path setup */
 420 int snd_soc_dapm_new_widgets(struct snd_soc_card *card);
 421 void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
 422 int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
 423                             const struct snd_soc_dapm_route *route, int num);
 424 int snd_soc_dapm_del_routes(struct snd_soc_dapm_context *dapm,
 425                             const struct snd_soc_dapm_route *route, int num);
 426 int snd_soc_dapm_weak_routes(struct snd_soc_dapm_context *dapm,
 427                              const struct snd_soc_dapm_route *route, int num);
 428
 429 /* dapm events */
 430 void snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd, int stream,
 431         int event);
 432 void snd_soc_dapm_shutdown(struct snd_soc_card *card);
 433
 434 /* external DAPM widget events */
 435 int snd_soc_dapm_mixer_update_power(struct snd_soc_dapm_context *dapm,
 436                 struct snd_kcontrol *kcontrol, int connect,
 437                 struct snd_soc_dapm_update *update);
 438 int snd_soc_dapm_mux_update_power(struct snd_soc_dapm_context *dapm,
 439                 struct snd_kcontrol *kcontrol, int mux, struct soc_enum *e,
 440                 struct snd_soc_dapm_update *update);
 441
 442 /* dapm sys fs - used by the core */
 443 int snd_soc_dapm_sys_add(struct device *dev);
 444 void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm,
 445                                 struct dentry *parent);
 446
 447 /* dapm audio pin control and status */
 448 int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
 449                             const char *pin);
 450 int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
 451                              const char *pin);
 452 int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
 453 int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
 454                                 const char *pin);
 455 int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
 456 int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
 457                                   const char *pin);
 458 int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
 459                                 const char *pin);
 460 void snd_soc_dapm_auto_nc_codec_pins(struct snd_soc_codec *codec);
 461
 462 /* Mostly internal - should not normally be used */
 463 void dapm_mark_dirty(struct snd_soc_dapm_widget *w, const char *reason);
 464 void dapm_mark_io_dirty(struct snd_soc_dapm_context *dapm);
 465
 466 /* dapm path query */
 467 int snd_soc_dapm_dai_get_connected_widgets(struct snd_soc_dai *dai, int stream,
 468         struct snd_soc_dapm_widget_list **list);
 469
 470 struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(struct snd_kcontrol *kcontrol);
 471
 472 /* dapm widget types */
 473 enum snd_soc_dapm_type {
 474         snd_soc_dapm_input = 0,         /* input pin */
 475         snd_soc_dapm_output,            /* output pin */
 476         snd_soc_dapm_mux,                       /* selects 1 analog signal from many inputs */
 477         snd_soc_dapm_virt_mux,                  /* virtual version of snd_soc_dapm_mux */
 478         snd_soc_dapm_value_mux,                 /* selects 1 analog signal from many inputs */
 479         snd_soc_dapm_mixer,                     /* mixes several analog signals together */
 480         snd_soc_dapm_mixer_named_ctl,           /* mixer with named controls */
 481         snd_soc_dapm_pga,                       /* programmable gain/attenuation (volume) */
 482         snd_soc_dapm_out_drv,                   /* output driver */
 483         snd_soc_dapm_adc,                       /* analog to digital converter */
 484         snd_soc_dapm_dac,                       /* digital to analog converter */
 485         snd_soc_dapm_micbias,           /* microphone bias (power) */
 486         snd_soc_dapm_mic,                       /* microphone */
 487         snd_soc_dapm_hp,                        /* headphones */
 488         snd_soc_dapm_spk,                       /* speaker */
 489         snd_soc_dapm_line,                      /* line input/output */
 490         snd_soc_dapm_switch,            /* analog switch */
 491         snd_soc_dapm_vmid,                      /* codec bias/vmid - to minimise pops */
 492         snd_soc_dapm_pre,                       /* machine specific pre widget - exec first */
 493         snd_soc_dapm_post,                      /* machine specific post widget - exec last */
 494         snd_soc_dapm_supply,            /* power/clock supply */
 495         snd_soc_dapm_regulator_supply,  /* external regulator */
 496         snd_soc_dapm_clock_supply,      /* external clock */
 497         snd_soc_dapm_aif_in,            /* audio interface input */
 498         snd_soc_dapm_aif_out,           /* audio interface output */
 499         snd_soc_dapm_siggen,            /* signal generator */
 500         snd_soc_dapm_dai_in,            /* link to DAI structure */
 501         snd_soc_dapm_dai_out,
 502         snd_soc_dapm_dai_link,          /* link between two DAI structures */
 503         snd_soc_dapm_kcontrol,          /* Auto-disabled kcontrol */
 504 };
 505
 506 enum snd_soc_dapm_subclass {
 507         SND_SOC_DAPM_CLASS_INIT         = 0,
 508         SND_SOC_DAPM_CLASS_RUNTIME      = 1,
 509 };
 510
 511 /*
 512  * DAPM audio route definition.
 513  *
 514  * Defines an audio route originating at source via control and finishing
 515  * at sink.
 516  */
 517 struct snd_soc_dapm_route {
 518         const char *sink;
 519         const char *control;
 520         const char *source;
 521
 522         /* Note: currently only supported for links where source is a supply */
 523         int (*connected)(struct snd_soc_dapm_widget *source,
 524                          struct snd_soc_dapm_widget *sink);
 525 };
 526
 527 /* dapm audio path between two widgets */
 528 struct snd_soc_dapm_path {
 529         const char *name;
 530
 531         /* source (input) and sink (output) widgets */
 532         struct snd_soc_dapm_widget *source;
 533         struct snd_soc_dapm_widget *sink;
 534
 535         /* status */
 536         u32 connect:1;  /* source and sink widgets are connected */
 537         u32 walked:1;   /* path has been walked */
 538         u32 walking:1;  /* path is in the process of being walked */
 539         u32 weak:1;     /* path ignored for power management */
 540
 541         int (*connected)(struct snd_soc_dapm_widget *source,
 542                          struct snd_soc_dapm_widget *sink);
 543
 544         struct list_head list_source;
 545         struct list_head list_sink;
 546         struct list_head list_kcontrol;
 547         struct list_head list;
 548 };
 549
 550 /* dapm widget */
 551 struct snd_soc_dapm_widget {
 552         enum snd_soc_dapm_type id;
 553         const char *name;               /* widget name */
 554         const char *sname;      /* stream name */
 555         struct snd_soc_codec *codec;
 556         struct snd_soc_platform *platform;
 557         struct list_head list;
 558         struct snd_soc_dapm_context *dapm;
 559
 560         void *priv;                             /* widget specific data */
 561         struct regulator *regulator;            /* attached regulator */
 562         const struct snd_soc_pcm_stream *params; /* params for dai links */
 563
 564         /* dapm control */
 565         int reg;                                /* negative reg = no direct dapm */
 566         unsigned char shift;                    /* bits to shift */
 567         unsigned int mask;                      /* non-shifted mask */
 568         unsigned int on_val;                    /* on state value */
 569         unsigned int off_val;                   /* off state value */
 570         unsigned char power:1;                  /* block power status */
 571         unsigned char active:1;                 /* active stream on DAC, ADC's */
 572         unsigned char connected:1;              /* connected codec pin */
 573         unsigned char new:1;                    /* cnew complete */
 574         unsigned char ext:1;                    /* has external widgets */
 575         unsigned char force:1;                  /* force state */
 576         unsigned char ignore_suspend:1;         /* kept enabled over suspend */
 577         unsigned char new_power:1;              /* power from this run */
 578         unsigned char power_checked:1;          /* power checked this run */
 579         int subseq;                             /* sort within widget type */
 580
 581         int (*power_check)(struct snd_soc_dapm_widget *w);
 582
 583         /* external events */
 584         unsigned short event_flags;             /* flags to specify event types */
 585         int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
 586
 587         /* kcontrols that relate to this widget */
 588         int num_kcontrols;
 589         const struct snd_kcontrol_new *kcontrol_news;
 590         struct snd_kcontrol **kcontrols;
 591
 592         /* widget input and outputs */
 593         struct list_head sources;
 594         struct list_head sinks;
 595
 596         /* used during DAPM updates */
 597         struct list_head power_list;
 598         struct list_head dirty;
 599         int inputs;
 600         int outputs;
 601
 602         struct clk *clk;
 603 };
 604
 605 struct snd_soc_dapm_update {
 606         struct snd_kcontrol *kcontrol;
 607         int reg;
 608         int mask;
 609         int val;
 610 };
 611
 612 /* DAPM context */
 613 struct snd_soc_dapm_context {
 614         enum snd_soc_bias_level bias_level;
 615         enum snd_soc_bias_level suspend_bias_level;
 616         struct delayed_work delayed_work;
 617         unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
 618
 619         void (*seq_notifier)(struct snd_soc_dapm_context *,
 620                              enum snd_soc_dapm_type, int);
 621
 622         struct device *dev; /* from parent - for debug */
 623         struct snd_soc_codec *codec; /* parent codec */
 624         struct snd_soc_platform *platform; /* parent platform */
 625         struct snd_soc_card *card; /* parent card */
 626
 627         /* used during DAPM updates */
 628         enum snd_soc_bias_level target_bias_level;
 629         struct list_head list;
 630
 631         int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
 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 #endif