include/sound/soc-dapm.h

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