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/device.h>
  17 #include <linux/types.h>
  18 #include <sound/control.h>
  19
  20 /* widget has no PM register bit */
  21 #define SND_SOC_NOPM    -1
  22
  23 /*
  24  * SoC dynamic audio power management
  25  *
  26  * We can have upto 4 power domains
  27  *      1. Codec domain - VREF, VMID
  28  *     Usually controlled at codec probe/remove, although can be set
  29  *     at stream time if power is not needed for sidetone, etc.
  30  *  2. Platform/Machine domain - physically connected inputs and outputs
  31  *     Is platform/machine and user action specific, is set in the machine
  32  *     driver and by userspace e.g when HP are inserted
  33  *  3. Path domain - Internal codec path mixers
  34  *     Are automatically set when mixer and mux settings are
  35  *     changed by the user.
  36  *  4. Stream domain - DAC's and ADC's.
  37  *     Enabled when stream playback/capture is started.
  38  */
  39
  40 /* codec domain */
  41 #define SND_SOC_DAPM_VMID(wname) \
  42 {       .id = snd_soc_dapm_vmid, .name = wname, .kcontrols = NULL, \
  43         .num_kcontrols = 0}
  44
  45 /* platform domain */
  46 #define SND_SOC_DAPM_INPUT(wname) \
  47 {       .id = snd_soc_dapm_input, .name = wname, .kcontrols = NULL, \
  48         .num_kcontrols = 0}
  49 #define SND_SOC_DAPM_OUTPUT(wname) \
  50 {       .id = snd_soc_dapm_output, .name = wname, .kcontrols = NULL, \
  51         .num_kcontrols = 0}
  52 #define SND_SOC_DAPM_MIC(wname, wevent) \
  53 {       .id = snd_soc_dapm_mic, .name = wname, .kcontrols = NULL, \
  54         .num_kcontrols = 0, .event = wevent, \
  55         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
  56 #define SND_SOC_DAPM_HP(wname, wevent) \
  57 {       .id = snd_soc_dapm_hp, .name = wname, .kcontrols = NULL, \
  58         .num_kcontrols = 0, .event = wevent, \
  59         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
  60 #define SND_SOC_DAPM_SPK(wname, wevent) \
  61 {       .id = snd_soc_dapm_spk, .name = wname, .kcontrols = NULL, \
  62         .num_kcontrols = 0, .event = wevent, \
  63         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
  64 #define SND_SOC_DAPM_LINE(wname, wevent) \
  65 {       .id = snd_soc_dapm_line, .name = wname, .kcontrols = NULL, \
  66         .num_kcontrols = 0, .event = wevent, \
  67         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
  68
  69 /* path domain */
  70 #define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\
  71          wcontrols, wncontrols) \
  72 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
  73         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols}
  74 #define SND_SOC_DAPM_OUT_DRV(wname, wreg, wshift, winvert,\
  75          wcontrols, wncontrols) \
  76 {       .id = snd_soc_dapm_out_drv, .name = wname, .reg = wreg, .shift = wshift, \
  77         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols}
  78 #define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
  79          wcontrols, wncontrols)\
  80 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
  81         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols}
  82 #define SND_SOC_DAPM_MIXER_NAMED_CTL(wname, wreg, wshift, winvert, \
  83          wcontrols, wncontrols)\
  84 {       .id = snd_soc_dapm_mixer_named_ctl, .name = wname, .reg = wreg, \
  85         .shift = wshift, .invert = winvert, .kcontrols = wcontrols, \
  86         .num_kcontrols = wncontrols}
  87 #define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
  88 {       .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
  89         .invert = winvert, .kcontrols = NULL, .num_kcontrols = 0}
  90 #define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
  91 {       .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
  92         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1}
  93 #define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
  94 {       .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
  95         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1}
  96 #define SND_SOC_DAPM_VIRT_MUX(wname, wreg, wshift, winvert, wcontrols) \
  97 {       .id = snd_soc_dapm_virt_mux, .name = wname, .reg = wreg, .shift = wshift, \
  98         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1}
  99 #define SND_SOC_DAPM_VALUE_MUX(wname, wreg, wshift, winvert, wcontrols) \
 100 {       .id = snd_soc_dapm_value_mux, .name = wname, .reg = wreg, \
 101         .shift = wshift, .invert = winvert, .kcontrols = wcontrols, \
 102         .num_kcontrols = 1}
 103
 104 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
 105 #define SOC_PGA_ARRAY(wname, wreg, wshift, winvert,\
 106          wcontrols) \
 107 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
 108         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
 109 #define SOC_MIXER_ARRAY(wname, wreg, wshift, winvert, \
 110          wcontrols)\
 111 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
 112         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols)}
 113 #define SOC_MIXER_NAMED_CTL_ARRAY(wname, wreg, wshift, winvert, \
 114          wcontrols)\
 115 {       .id = snd_soc_dapm_mixer_named_ctl, .name = wname, .reg = wreg, \
 116         .shift = wshift, .invert = winvert, .kcontrols = wcontrols, \
 117         .num_kcontrols = ARRAY_SIZE(wcontrols)}
 118
 119 /* path domain with event - event handler must return 0 for success */
 120 #define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \
 121         wncontrols, wevent, wflags) \
 122 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
 123         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols, \
 124         .event = wevent, .event_flags = wflags}
 125 #define SND_SOC_DAPM_OUT_DRV_E(wname, wreg, wshift, winvert, wcontrols, \
 126         wncontrols, wevent, wflags) \
 127 {       .id = snd_soc_dapm_out_drv, .name = wname, .reg = wreg, .shift = wshift, \
 128         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols, \
 129         .event = wevent, .event_flags = wflags}
 130 #define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \
 131         wncontrols, wevent, wflags) \
 132 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
 133         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols, \
 134         .event = wevent, .event_flags = wflags}
 135 #define SND_SOC_DAPM_MIXER_NAMED_CTL_E(wname, wreg, wshift, winvert, \
 136         wcontrols, wncontrols, wevent, wflags) \
 137 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
 138         .invert = winvert, .kcontrols = wcontrols, \
 139         .num_kcontrols = wncontrols, .event = wevent, .event_flags = wflags}
 140 #define SND_SOC_DAPM_MICBIAS_E(wname, wreg, wshift, winvert, wevent, wflags) \
 141 {       .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
 142         .invert = winvert, .kcontrols = NULL, .num_kcontrols = 0, \
 143         .event = wevent, .event_flags = wflags}
 144 #define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
 145         wevent, wflags) \
 146 {       .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
 147         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1, \
 148         .event = wevent, .event_flags = wflags}
 149 #define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
 150         wevent, wflags) \
 151 {       .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
 152         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1, \
 153         .event = wevent, .event_flags = wflags}
 154 #define SND_SOC_DAPM_VIRT_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
 155         wevent, wflags) \
 156 {       .id = snd_soc_dapm_virt_mux, .name = wname, .reg = wreg, .shift = wshift, \
 157         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1, \
 158         .event = wevent, .event_flags = wflags}
 159
 160 /* Simplified versions of above macros, assuming wncontrols = ARRAY_SIZE(wcontrols) */
 161 #define SOC_PGA_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
 162         wevent, wflags) \
 163 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
 164         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
 165         .event = wevent, .event_flags = wflags}
 166 #define SOC_MIXER_E_ARRAY(wname, wreg, wshift, winvert, wcontrols, \
 167         wevent, wflags) \
 168 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
 169         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = ARRAY_SIZE(wcontrols), \
 170         .event = wevent, .event_flags = wflags}
 171 #define SOC_MIXER_NAMED_CTL_E_ARRAY(wname, wreg, wshift, winvert, \
 172         wcontrols, wevent, wflags) \
 173 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
 174         .invert = winvert, .kcontrols = wcontrols, \
 175         .num_kcontrols = ARRAY_SIZE(wcontrols), .event = wevent, .event_flags = wflags}
 176
 177 /* events that are pre and post DAPM */
 178 #define SND_SOC_DAPM_PRE(wname, wevent) \
 179 {       .id = snd_soc_dapm_pre, .name = wname, .kcontrols = NULL, \
 180         .num_kcontrols = 0, .event = wevent, \
 181         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
 182 #define SND_SOC_DAPM_POST(wname, wevent) \
 183 {       .id = snd_soc_dapm_post, .name = wname, .kcontrols = NULL, \
 184         .num_kcontrols = 0, .event = wevent, \
 185         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
 186
 187 /* stream domain */
 188 #define SND_SOC_DAPM_AIF_IN(wname, stname, wslot, wreg, wshift, winvert) \
 189 {       .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
 190         .reg = wreg, .shift = wshift, .invert = winvert }
 191 #define SND_SOC_DAPM_AIF_IN_E(wname, stname, wslot, wreg, wshift, winvert, \
 192                               wevent, wflags)                           \
 193 {       .id = snd_soc_dapm_aif_in, .name = wname, .sname = stname, \
 194         .reg = wreg, .shift = wshift, .invert = winvert, \
 195         .event = wevent, .event_flags = wflags }
 196 #define SND_SOC_DAPM_AIF_OUT(wname, stname, wslot, wreg, wshift, winvert) \
 197 {       .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
 198         .reg = wreg, .shift = wshift, .invert = winvert }
 199 #define SND_SOC_DAPM_AIF_OUT_E(wname, stname, wslot, wreg, wshift, winvert, \
 200                              wevent, wflags)                            \
 201 {       .id = snd_soc_dapm_aif_out, .name = wname, .sname = stname, \
 202         .reg = wreg, .shift = wshift, .invert = winvert, \
 203         .event = wevent, .event_flags = wflags }
 204 #define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
 205 {       .id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
 206         .shift = wshift, .invert = winvert}
 207 #define SND_SOC_DAPM_DAC_E(wname, stname, wreg, wshift, winvert, \
 208                            wevent, wflags)                              \
 209 {       .id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
 210         .shift = wshift, .invert = winvert, \
 211         .event = wevent, .event_flags = wflags}
 212 #define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
 213 {       .id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
 214         .shift = wshift, .invert = winvert}
 215 #define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \
 216                            wevent, wflags)                              \
 217 {       .id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
 218         .shift = wshift, .invert = winvert, \
 219         .event = wevent, .event_flags = wflags}
 220
 221 /* generic widgets */
 222 #define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
 223 {       .id = wid, .name = wname, .kcontrols = NULL, .num_kcontrols = 0, \
 224         .reg = -((wreg) + 1), .shift = wshift, .mask = wmask, \
 225         .on_val = won_val, .off_val = woff_val, .event = dapm_reg_event, \
 226         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
 227 #define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \
 228 {       .id = snd_soc_dapm_supply, .name = wname, .reg = wreg,  \
 229         .shift = wshift, .invert = winvert, .event = wevent, \
 230         .event_flags = wflags}
 231
 232 /* dapm kcontrol types */
 233 #define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
 234 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 235         .info = snd_soc_info_volsw, \
 236         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
 237         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
 238 #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
 239 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 240         .info = snd_soc_info_volsw, \
 241         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 242         .tlv.p = (tlv_array), \
 243         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
 244         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
 245 #define SOC_DAPM_ENUM(xname, xenum) \
 246 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 247         .info = snd_soc_info_enum_double, \
 248         .get = snd_soc_dapm_get_enum_double, \
 249         .put = snd_soc_dapm_put_enum_double, \
 250         .private_value = (unsigned long)&xenum }
 251 #define SOC_DAPM_ENUM_VIRT(xname, xenum)                    \
 252 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 253         .info = snd_soc_info_enum_double, \
 254         .get = snd_soc_dapm_get_enum_virt, \
 255         .put = snd_soc_dapm_put_enum_virt, \
 256         .private_value = (unsigned long)&xenum }
 257 #define SOC_DAPM_VALUE_ENUM(xname, xenum) \
 258 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 259         .info = snd_soc_info_enum_double, \
 260         .get = snd_soc_dapm_get_value_enum_double, \
 261         .put = snd_soc_dapm_put_value_enum_double, \
 262         .private_value = (unsigned long)&xenum }
 263 #define SOC_DAPM_PIN_SWITCH(xname) \
 264 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
 265         .info = snd_soc_dapm_info_pin_switch, \
 266         .get = snd_soc_dapm_get_pin_switch, \
 267         .put = snd_soc_dapm_put_pin_switch, \
 268         .private_value = (unsigned long)xname }
 269
 270 /* dapm stream operations */
 271 #define SND_SOC_DAPM_STREAM_NOP                 0x0
 272 #define SND_SOC_DAPM_STREAM_START               0x1
 273 #define SND_SOC_DAPM_STREAM_STOP                0x2
 274 #define SND_SOC_DAPM_STREAM_SUSPEND             0x4
 275 #define SND_SOC_DAPM_STREAM_RESUME              0x8
 276 #define SND_SOC_DAPM_STREAM_PAUSE_PUSH  0x10
 277 #define SND_SOC_DAPM_STREAM_PAUSE_RELEASE       0x20
 278
 279 /* dapm event types */
 280 #define SND_SOC_DAPM_PRE_PMU    0x1     /* before widget power up */
 281 #define SND_SOC_DAPM_POST_PMU   0x2             /* after widget power up */
 282 #define SND_SOC_DAPM_PRE_PMD    0x4     /* before widget power down */
 283 #define SND_SOC_DAPM_POST_PMD   0x8             /* after widget power down */
 284 #define SND_SOC_DAPM_PRE_REG    0x10    /* before audio path setup */
 285 #define SND_SOC_DAPM_POST_REG   0x20    /* after audio path setup */
 286 #define SND_SOC_DAPM_PRE_POST_PMD \
 287                                 (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD)
 288
 289 /* convenience event type detection */
 290 #define SND_SOC_DAPM_EVENT_ON(e)        \
 291         (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
 292 #define SND_SOC_DAPM_EVENT_OFF(e)       \
 293         (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
 294
 295 struct snd_soc_dapm_widget;
 296 enum snd_soc_dapm_type;
 297 struct snd_soc_dapm_path;
 298 struct snd_soc_dapm_pin;
 299 struct snd_soc_dapm_route;
 300 struct snd_soc_dapm_context;
 301
 302 int dapm_reg_event(struct snd_soc_dapm_widget *w,
 303                    struct snd_kcontrol *kcontrol, int event);
 304
 305 /* dapm controls */
 306 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
 307         struct snd_ctl_elem_value *ucontrol);
 308 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
 309         struct snd_ctl_elem_value *ucontrol);
 310 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
 311         struct snd_ctl_elem_value *ucontrol);
 312 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
 313         struct snd_ctl_elem_value *ucontrol);
 314 int snd_soc_dapm_get_enum_virt(struct snd_kcontrol *kcontrol,
 315         struct snd_ctl_elem_value *ucontrol);
 316 int snd_soc_dapm_put_enum_virt(struct snd_kcontrol *kcontrol,
 317         struct snd_ctl_elem_value *ucontrol);
 318 int snd_soc_dapm_get_value_enum_double(struct snd_kcontrol *kcontrol,
 319         struct snd_ctl_elem_value *ucontrol);
 320 int snd_soc_dapm_put_value_enum_double(struct snd_kcontrol *kcontrol,
 321         struct snd_ctl_elem_value *ucontrol);
 322 int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
 323         struct snd_ctl_elem_info *uinfo);
 324 int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
 325         struct snd_ctl_elem_value *uncontrol);
 326 int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
 327         struct snd_ctl_elem_value *uncontrol);
 328 int snd_soc_dapm_new_control(struct snd_soc_dapm_context *dapm,
 329         const struct snd_soc_dapm_widget *widget);
 330 int snd_soc_dapm_new_controls(struct snd_soc_dapm_context *dapm,
 331         const struct snd_soc_dapm_widget *widget,
 332         int num);
 333
 334 /* dapm path setup */
 335 int snd_soc_dapm_new_widgets(struct snd_soc_dapm_context *dapm);
 336 void snd_soc_dapm_free(struct snd_soc_dapm_context *dapm);
 337 int snd_soc_dapm_add_routes(struct snd_soc_dapm_context *dapm,
 338                             const struct snd_soc_dapm_route *route, int num);
 339
 340 /* dapm events */
 341 int snd_soc_dapm_stream_event(struct snd_soc_pcm_runtime *rtd,
 342         const char *stream, int event);
 343 void snd_soc_dapm_shutdown(struct snd_soc_card *card);
 344
 345 /* dapm sys fs - used by the core */
 346 int snd_soc_dapm_sys_add(struct device *dev);
 347 void snd_soc_dapm_debugfs_init(struct snd_soc_dapm_context *dapm);
 348
 349 /* dapm audio pin control and status */
 350 int snd_soc_dapm_enable_pin(struct snd_soc_dapm_context *dapm,
 351                             const char *pin);
 352 int snd_soc_dapm_disable_pin(struct snd_soc_dapm_context *dapm,
 353                              const char *pin);
 354 int snd_soc_dapm_nc_pin(struct snd_soc_dapm_context *dapm, const char *pin);
 355 int snd_soc_dapm_get_pin_status(struct snd_soc_dapm_context *dapm,
 356                                 const char *pin);
 357 int snd_soc_dapm_sync(struct snd_soc_dapm_context *dapm);
 358 int snd_soc_dapm_force_enable_pin(struct snd_soc_dapm_context *dapm,
 359                                   const char *pin);
 360 int snd_soc_dapm_ignore_suspend(struct snd_soc_dapm_context *dapm,
 361                                 const char *pin);
 362
 363 /* dapm widget types */
 364 enum snd_soc_dapm_type {
 365         snd_soc_dapm_input = 0,         /* input pin */
 366         snd_soc_dapm_output,            /* output pin */
 367         snd_soc_dapm_mux,                       /* selects 1 analog signal from many inputs */
 368         snd_soc_dapm_virt_mux,                  /* virtual version of snd_soc_dapm_mux */
 369         snd_soc_dapm_value_mux,                 /* selects 1 analog signal from many inputs */
 370         snd_soc_dapm_mixer,                     /* mixes several analog signals together */
 371         snd_soc_dapm_mixer_named_ctl,           /* mixer with named controls */
 372         snd_soc_dapm_pga,                       /* programmable gain/attenuation (volume) */
 373         snd_soc_dapm_out_drv,                   /* output driver */
 374         snd_soc_dapm_adc,                       /* analog to digital converter */
 375         snd_soc_dapm_dac,                       /* digital to analog converter */
 376         snd_soc_dapm_micbias,           /* microphone bias (power) */
 377         snd_soc_dapm_mic,                       /* microphone */
 378         snd_soc_dapm_hp,                        /* headphones */
 379         snd_soc_dapm_spk,                       /* speaker */
 380         snd_soc_dapm_line,                      /* line input/output */
 381         snd_soc_dapm_switch,            /* analog switch */
 382         snd_soc_dapm_vmid,                      /* codec bias/vmid - to minimise pops */
 383         snd_soc_dapm_pre,                       /* machine specific pre widget - exec first */
 384         snd_soc_dapm_post,                      /* machine specific post widget - exec last */
 385         snd_soc_dapm_supply,            /* power/clock supply */
 386         snd_soc_dapm_aif_in,            /* audio interface input */
 387         snd_soc_dapm_aif_out,           /* audio interface output */
 388 };
 389
 390 /*
 391  * DAPM audio route definition.
 392  *
 393  * Defines an audio route originating at source via control and finishing
 394  * at sink.
 395  */
 396 struct snd_soc_dapm_route {
 397         const char *sink;
 398         const char *control;
 399         const char *source;
 400
 401         /* Note: currently only supported for links where source is a supply */
 402         int (*connected)(struct snd_soc_dapm_widget *source,
 403                          struct snd_soc_dapm_widget *sink);
 404 };
 405
 406 /* dapm audio path between two widgets */
 407 struct snd_soc_dapm_path {
 408         char *name;
 409         char *long_name;
 410
 411         /* source (input) and sink (output) widgets */
 412         struct snd_soc_dapm_widget *source;
 413         struct snd_soc_dapm_widget *sink;
 414         struct snd_kcontrol *kcontrol;
 415
 416         /* status */
 417         u32 connect:1;  /* source and sink widgets are connected */
 418         u32 walked:1;   /* path has been walked */
 419
 420         int (*connected)(struct snd_soc_dapm_widget *source,
 421                          struct snd_soc_dapm_widget *sink);
 422
 423         struct list_head list_source;
 424         struct list_head list_sink;
 425         struct list_head list;
 426 };
 427
 428 /* dapm widget */
 429 struct snd_soc_dapm_widget {
 430         enum snd_soc_dapm_type id;
 431         char *name;             /* widget name */
 432         char *sname;    /* stream name */
 433         struct snd_soc_codec *codec;
 434         struct list_head list;
 435         struct snd_soc_dapm_context *dapm;
 436
 437         /* dapm control */
 438         short reg;                                              /* negative reg = no direct dapm */
 439         unsigned char shift;                    /* bits to shift */
 440         unsigned int saved_value;               /* widget saved value */
 441         unsigned int value;                             /* widget current value */
 442         unsigned int mask;                      /* non-shifted mask */
 443         unsigned int on_val;                    /* on state value */
 444         unsigned int off_val;                   /* off state value */
 445         unsigned char power:1;                  /* block power status */
 446         unsigned char invert:1;                 /* invert the power bit */
 447         unsigned char active:1;                 /* active stream on DAC, ADC's */
 448         unsigned char connected:1;              /* connected codec pin */
 449         unsigned char new:1;                    /* cnew complete */
 450         unsigned char ext:1;                    /* has external widgets */
 451         unsigned char force:1;                  /* force state */
 452         unsigned char ignore_suspend:1;         /* kept enabled over suspend */
 453
 454         int (*power_check)(struct snd_soc_dapm_widget *w);
 455
 456         /* external events */
 457         unsigned short event_flags;             /* flags to specify event types */
 458         int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
 459
 460         /* kcontrols that relate to this widget */
 461         int num_kcontrols;
 462         const struct snd_kcontrol_new *kcontrols;
 463
 464         /* widget input and outputs */
 465         struct list_head sources;
 466         struct list_head sinks;
 467
 468         /* used during DAPM updates */
 469         struct list_head power_list;
 470 };
 471
 472 struct snd_soc_dapm_update {
 473         struct snd_soc_dapm_widget *widget;
 474         struct snd_kcontrol *kcontrol;
 475         int reg;
 476         int mask;
 477         int val;
 478 };
 479
 480 /* DAPM context */
 481 struct snd_soc_dapm_context {
 482         int n_widgets; /* number of widgets in this context */
 483         enum snd_soc_bias_level bias_level;
 484         enum snd_soc_bias_level suspend_bias_level;
 485         struct delayed_work delayed_work;
 486         unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
 487
 488         struct snd_soc_dapm_update *update;
 489
 490         struct device *dev; /* from parent - for debug */
 491         struct snd_soc_codec *codec; /* parent codec */
 492         struct snd_soc_card *card; /* parent card */
 493
 494         /* used during DAPM updates */
 495         int dev_power;
 496         struct list_head list;
 497
 498 #ifdef CONFIG_DEBUG_FS
 499         struct dentry *debugfs_dapm;
 500 #endif
 501 };
 502
 503 #endif