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