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 #include <sound/soc.h>
  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 upto 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, .kcontrols = NULL, \
  44         .num_kcontrols = 0}
  45
  46 /* platform domain */
  47 #define SND_SOC_DAPM_INPUT(wname) \
  48 {       .id = snd_soc_dapm_input, .name = wname, .kcontrols = NULL, \
  49         .num_kcontrols = 0}
  50 #define SND_SOC_DAPM_OUTPUT(wname) \
  51 {       .id = snd_soc_dapm_output, .name = wname, .kcontrols = NULL, \
  52         .num_kcontrols = 0}
  53 #define SND_SOC_DAPM_MIC(wname, wevent) \
  54 {       .id = snd_soc_dapm_mic, .name = wname, .kcontrols = NULL, \
  55         .num_kcontrols = 0, .event = wevent, \
  56         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
  57 #define SND_SOC_DAPM_HP(wname, wevent) \
  58 {       .id = snd_soc_dapm_hp, .name = wname, .kcontrols = NULL, \
  59         .num_kcontrols = 0, .event = wevent, \
  60         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
  61 #define SND_SOC_DAPM_SPK(wname, wevent) \
  62 {       .id = snd_soc_dapm_spk, .name = wname, .kcontrols = NULL, \
  63         .num_kcontrols = 0, .event = wevent, \
  64         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
  65 #define SND_SOC_DAPM_LINE(wname, wevent) \
  66 {       .id = snd_soc_dapm_line, .name = wname, .kcontrols = NULL, \
  67         .num_kcontrols = 0, .event = wevent, \
  68         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
  69
  70 /* path domain */
  71 #define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\
  72          wcontrols, wncontrols) \
  73 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
  74         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols}
  75 #define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
  76          wcontrols, wncontrols)\
  77 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
  78         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols}
  79 #define SND_SOC_DAPM_MIXER_NAMED_CTL(wname, wreg, wshift, winvert, \
  80          wcontrols, wncontrols)\
  81 {       .id = snd_soc_dapm_mixer_named_ctl, .name = wname, .reg = wreg, \
  82         .shift = wshift, .invert = winvert, .kcontrols = wcontrols, \
  83         .num_kcontrols = wncontrols}
  84 #define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
  85 {       .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
  86         .invert = winvert, .kcontrols = NULL, .num_kcontrols = 0}
  87 #define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
  88 {       .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
  89         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1}
  90 #define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
  91 {       .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
  92         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1}
  93 #define SND_SOC_DAPM_VALUE_MUX(wname, wreg, wshift, winvert, wcontrols) \
  94 {       .id = snd_soc_dapm_value_mux, .name = wname, .reg = wreg, \
  95         .shift = wshift, .invert = winvert, .kcontrols = wcontrols, \
  96         .num_kcontrols = 1}
  97
  98 /* path domain with event - event handler must return 0 for success */
  99 #define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \
 100         wncontrols, wevent, wflags) \
 101 {       .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
 102         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols, \
 103         .event = wevent, .event_flags = wflags}
 104 #define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \
 105         wncontrols, wevent, wflags) \
 106 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
 107         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols, \
 108         .event = wevent, .event_flags = wflags}
 109 #define SND_SOC_DAPM_MIXER_NAMED_CTL_E(wname, wreg, wshift, winvert, \
 110         wcontrols, wncontrols, wevent, wflags) \
 111 {       .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
 112         .invert = winvert, .kcontrols = wcontrols, \
 113         .num_kcontrols = wncontrols, .event = wevent, .event_flags = wflags}
 114 #define SND_SOC_DAPM_MICBIAS_E(wname, wreg, wshift, winvert, wevent, wflags) \
 115 {       .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
 116         .invert = winvert, .kcontrols = NULL, .num_kcontrols = 0, \
 117         .event = wevent, .event_flags = wflags}
 118 #define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
 119         wevent, wflags) \
 120 {       .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
 121         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1, \
 122         .event = wevent, .event_flags = wflags}
 123 #define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
 124         wevent, wflags) \
 125 {       .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
 126         .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1, \
 127         .event = wevent, .event_flags = wflags}
 128
 129 /* events that are pre and post DAPM */
 130 #define SND_SOC_DAPM_PRE(wname, wevent) \
 131 {       .id = snd_soc_dapm_pre, .name = wname, .kcontrols = NULL, \
 132         .num_kcontrols = 0, .event = wevent, \
 133         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
 134 #define SND_SOC_DAPM_POST(wname, wevent) \
 135 {       .id = snd_soc_dapm_post, .name = wname, .kcontrols = NULL, \
 136         .num_kcontrols = 0, .event = wevent, \
 137         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
 138
 139 /* stream domain */
 140 #define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
 141 {       .id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
 142         .shift = wshift, .invert = winvert}
 143 #define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
 144 {       .id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
 145         .shift = wshift, .invert = winvert}
 146
 147 /* generic register modifier widget */
 148 #define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
 149 {       .id = wid, .name = wname, .kcontrols = NULL, .num_kcontrols = 0, \
 150         .reg = -((wreg) + 1), .shift = wshift, .mask = wmask, \
 151         .on_val = won_val, .off_val = woff_val, .event = dapm_reg_event, \
 152         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
 153
 154 /* dapm kcontrol types */
 155 #define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
 156 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 157         .info = snd_soc_info_volsw, \
 158         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
 159         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
 160 #define SOC_DAPM_DOUBLE(xname, reg, shift_left, shift_right, max, invert, \
 161         power) \
 162 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 163         .info = snd_soc_info_volsw, \
 164         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
 165         .private_value = (reg) | ((shift_left) << 8) | ((shift_right) << 12) |\
 166                 ((max) << 16) | ((invert) << 24) }
 167 #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
 168 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 169         .info = snd_soc_info_volsw, \
 170         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 171         .tlv.p = (tlv_array), \
 172         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
 173         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
 174 #define SOC_DAPM_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, \
 175         power, tlv_array) \
 176 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 177         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 178         .tlv.p = (tlv_array), \
 179         .info = snd_soc_info_volsw, \
 180         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
 181         .private_value = (reg) | ((shift_left) << 8) | ((shift_right) << 12) |\
 182                 ((max) << 16) | ((invert) << 24) }
 183 #define SOC_DAPM_ENUM(xname, xenum) \
 184 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 185         .info = snd_soc_info_enum_double, \
 186         .get = snd_soc_dapm_get_enum_double, \
 187         .put = snd_soc_dapm_put_enum_double, \
 188         .private_value = (unsigned long)&xenum }
 189 #define SOC_DAPM_VALUE_ENUM(xname, xenum) \
 190 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 191         .info = snd_soc_info_enum_double, \
 192         .get = snd_soc_dapm_get_value_enum_double, \
 193         .put = snd_soc_dapm_put_value_enum_double, \
 194         .private_value = (unsigned long)&xenum }
 195
 196 /* dapm stream operations */
 197 #define SND_SOC_DAPM_STREAM_NOP                 0x0
 198 #define SND_SOC_DAPM_STREAM_START               0x1
 199 #define SND_SOC_DAPM_STREAM_STOP                0x2
 200 #define SND_SOC_DAPM_STREAM_SUSPEND             0x4
 201 #define SND_SOC_DAPM_STREAM_RESUME              0x8
 202 #define SND_SOC_DAPM_STREAM_PAUSE_PUSH  0x10
 203 #define SND_SOC_DAPM_STREAM_PAUSE_RELEASE       0x20
 204
 205 /* dapm event types */
 206 #define SND_SOC_DAPM_PRE_PMU    0x1     /* before widget power up */
 207 #define SND_SOC_DAPM_POST_PMU   0x2             /* after widget power up */
 208 #define SND_SOC_DAPM_PRE_PMD    0x4     /* before widget power down */
 209 #define SND_SOC_DAPM_POST_PMD   0x8             /* after widget power down */
 210 #define SND_SOC_DAPM_PRE_REG    0x10    /* before audio path setup */
 211 #define SND_SOC_DAPM_POST_REG   0x20    /* after audio path setup */
 212
 213 /* convenience event type detection */
 214 #define SND_SOC_DAPM_EVENT_ON(e)        \
 215         (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
 216 #define SND_SOC_DAPM_EVENT_OFF(e)       \
 217         (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
 218
 219 struct snd_soc_dapm_widget;
 220 enum snd_soc_dapm_type;
 221 struct snd_soc_dapm_path;
 222 struct snd_soc_dapm_pin;
 223 struct snd_soc_dapm_route;
 224
 225 int dapm_reg_event(struct snd_soc_dapm_widget *w,
 226                    struct snd_kcontrol *kcontrol, int event);
 227
 228 /* dapm controls */
 229 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
 230         struct snd_ctl_elem_value *ucontrol);
 231 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
 232         struct snd_ctl_elem_value *ucontrol);
 233 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
 234         struct snd_ctl_elem_value *ucontrol);
 235 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
 236         struct snd_ctl_elem_value *ucontrol);
 237 int snd_soc_dapm_get_value_enum_double(struct snd_kcontrol *kcontrol,
 238         struct snd_ctl_elem_value *ucontrol);
 239 int snd_soc_dapm_put_value_enum_double(struct snd_kcontrol *kcontrol,
 240         struct snd_ctl_elem_value *ucontrol);
 241 int snd_soc_dapm_new_control(struct snd_soc_codec *codec,
 242         const struct snd_soc_dapm_widget *widget);
 243 int snd_soc_dapm_new_controls(struct snd_soc_codec *codec,
 244         const struct snd_soc_dapm_widget *widget,
 245         int num);
 246
 247 /* dapm path setup */
 248 int snd_soc_dapm_new_widgets(struct snd_soc_codec *codec);
 249 void snd_soc_dapm_free(struct snd_soc_device *socdev);
 250 int snd_soc_dapm_add_routes(struct snd_soc_codec *codec,
 251                             const struct snd_soc_dapm_route *route, int num);
 252
 253 /* dapm events */
 254 int snd_soc_dapm_stream_event(struct snd_soc_codec *codec, char *stream,
 255         int event);
 256 int snd_soc_dapm_set_bias_level(struct snd_soc_device *socdev,
 257         enum snd_soc_bias_level level);
 258
 259 /* dapm sys fs - used by the core */
 260 int snd_soc_dapm_sys_add(struct device *dev);
 261
 262 /* dapm audio pin control and status */
 263 int snd_soc_dapm_enable_pin(struct snd_soc_codec *codec, const char *pin);
 264 int snd_soc_dapm_disable_pin(struct snd_soc_codec *codec, const char *pin);
 265 int snd_soc_dapm_nc_pin(struct snd_soc_codec *codec, const char *pin);
 266 int snd_soc_dapm_get_pin_status(struct snd_soc_codec *codec, const char *pin);
 267 int snd_soc_dapm_sync(struct snd_soc_codec *codec);
 268
 269 /* dapm widget types */
 270 enum snd_soc_dapm_type {
 271         snd_soc_dapm_input = 0,         /* input pin */
 272         snd_soc_dapm_output,            /* output pin */
 273         snd_soc_dapm_mux,                       /* selects 1 analog signal from many inputs */
 274         snd_soc_dapm_value_mux,                 /* selects 1 analog signal from many inputs */
 275         snd_soc_dapm_mixer,                     /* mixes several analog signals together */
 276         snd_soc_dapm_mixer_named_ctl,           /* mixer with named controls */
 277         snd_soc_dapm_pga,                       /* programmable gain/attenuation (volume) */
 278         snd_soc_dapm_adc,                       /* analog to digital converter */
 279         snd_soc_dapm_dac,                       /* digital to analog converter */
 280         snd_soc_dapm_micbias,           /* microphone bias (power) */
 281         snd_soc_dapm_mic,                       /* microphone */
 282         snd_soc_dapm_hp,                        /* headphones */
 283         snd_soc_dapm_spk,                       /* speaker */
 284         snd_soc_dapm_line,                      /* line input/output */
 285         snd_soc_dapm_switch,            /* analog switch */
 286         snd_soc_dapm_vmid,                      /* codec bias/vmid - to minimise pops */
 287         snd_soc_dapm_pre,                       /* machine specific pre widget - exec first */
 288         snd_soc_dapm_post,                      /* machine specific post widget - exec last */
 289 };
 290
 291 /*
 292  * DAPM audio route definition.
 293  *
 294  * Defines an audio route originating at source via control and finishing
 295  * at sink.
 296  */
 297 struct snd_soc_dapm_route {
 298         const char *sink;
 299         const char *control;
 300         const char *source;
 301 };
 302
 303 /* dapm audio path between two widgets */
 304 struct snd_soc_dapm_path {
 305         char *name;
 306         char *long_name;
 307
 308         /* source (input) and sink (output) widgets */
 309         struct snd_soc_dapm_widget *source;
 310         struct snd_soc_dapm_widget *sink;
 311         struct snd_kcontrol *kcontrol;
 312
 313         /* status */
 314         u32 connect:1;  /* source and sink widgets are connected */
 315         u32 walked:1;   /* path has been walked */
 316
 317         struct list_head list_source;
 318         struct list_head list_sink;
 319         struct list_head list;
 320 };
 321
 322 /* dapm widget */
 323 struct snd_soc_dapm_widget {
 324         enum snd_soc_dapm_type id;
 325         char *name;             /* widget name */
 326         char *sname;    /* stream name */
 327         struct snd_soc_codec *codec;
 328         struct list_head list;
 329
 330         /* dapm control */
 331         short reg;                                              /* negative reg = no direct dapm */
 332         unsigned char shift;                    /* bits to shift */
 333         unsigned int saved_value;               /* widget saved value */
 334         unsigned int value;                             /* widget current value */
 335         unsigned int mask;                      /* non-shifted mask */
 336         unsigned int on_val;                    /* on state value */
 337         unsigned int off_val;                   /* off state value */
 338         unsigned char power:1;                  /* block power status */
 339         unsigned char invert:1;                 /* invert the power bit */
 340         unsigned char active:1;                 /* active stream on DAC, ADC's */
 341         unsigned char connected:1;              /* connected codec pin */
 342         unsigned char new:1;                    /* cnew complete */
 343         unsigned char ext:1;                    /* has external widgets */
 344         unsigned char muted:1;                  /* muted for pop reduction */
 345         unsigned char suspend:1;                /* was active before suspend */
 346         unsigned char pmdown:1;                 /* waiting for timeout */
 347
 348         /* external events */
 349         unsigned short event_flags;             /* flags to specify event types */
 350         int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
 351
 352         /* kcontrols that relate to this widget */
 353         int num_kcontrols;
 354         const struct snd_kcontrol_new *kcontrols;
 355
 356         /* widget input and outputs */
 357         struct list_head sources;
 358         struct list_head sinks;
 359 };
 360
 361 #endif