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_DAC_E(wname, stname, wreg, wshift, winvert, \
 144                            wevent, wflags)                              \
 145 {       .id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
 146         .shift = wshift, .invert = winvert, \
 147         .event = wevent, .event_flags = wflags}
 148 #define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
 149 {       .id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
 150         .shift = wshift, .invert = winvert}
 151 #define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \
 152                            wevent, wflags)                              \
 153 {       .id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
 154         .shift = wshift, .invert = winvert, \
 155         .event = wevent, .event_flags = wflags}
 156
 157 /* generic widgets */
 158 #define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
 159 {       .id = wid, .name = wname, .kcontrols = NULL, .num_kcontrols = 0, \
 160         .reg = -((wreg) + 1), .shift = wshift, .mask = wmask, \
 161         .on_val = won_val, .off_val = woff_val, .event = dapm_reg_event, \
 162         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
 163 #define SND_SOC_DAPM_SUPPLY(wname, wreg, wshift, winvert, wevent, wflags) \
 164 {       .id = snd_soc_dapm_supply, .name = wname, .reg = wreg,  \
 165         .shift = wshift, .invert = winvert, .event = wevent, \
 166         .event_flags = wflags}
 167
 168 /* dapm kcontrol types */
 169 #define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
 170 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 171         .info = snd_soc_info_volsw, \
 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(xname, reg, shift_left, shift_right, max, invert, \
 175         power) \
 176 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 177         .info = snd_soc_info_volsw, \
 178         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
 179         .private_value = (reg) | ((shift_left) << 8) | ((shift_right) << 12) |\
 180                 ((max) << 16) | ((invert) << 24) }
 181 #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
 182 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 183         .info = snd_soc_info_volsw, \
 184         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 185         .tlv.p = (tlv_array), \
 186         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
 187         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
 188 #define SOC_DAPM_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, \
 189         power, tlv_array) \
 190 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 191         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 192         .tlv.p = (tlv_array), \
 193         .info = snd_soc_info_volsw, \
 194         .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
 195         .private_value = (reg) | ((shift_left) << 8) | ((shift_right) << 12) |\
 196                 ((max) << 16) | ((invert) << 24) }
 197 #define SOC_DAPM_ENUM(xname, xenum) \
 198 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 199         .info = snd_soc_info_enum_double, \
 200         .get = snd_soc_dapm_get_enum_double, \
 201         .put = snd_soc_dapm_put_enum_double, \
 202         .private_value = (unsigned long)&xenum }
 203 #define SOC_DAPM_VALUE_ENUM(xname, xenum) \
 204 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 205         .info = snd_soc_info_enum_double, \
 206         .get = snd_soc_dapm_get_value_enum_double, \
 207         .put = snd_soc_dapm_put_value_enum_double, \
 208         .private_value = (unsigned long)&xenum }
 209 #define SOC_DAPM_PIN_SWITCH(xname) \
 210 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
 211         .info = snd_soc_dapm_info_pin_switch, \
 212         .get = snd_soc_dapm_get_pin_switch, \
 213         .put = snd_soc_dapm_put_pin_switch, \
 214         .private_value = (unsigned long)xname }
 215
 216 /* dapm stream operations */
 217 #define SND_SOC_DAPM_STREAM_NOP                 0x0
 218 #define SND_SOC_DAPM_STREAM_START               0x1
 219 #define SND_SOC_DAPM_STREAM_STOP                0x2
 220 #define SND_SOC_DAPM_STREAM_SUSPEND             0x4
 221 #define SND_SOC_DAPM_STREAM_RESUME              0x8
 222 #define SND_SOC_DAPM_STREAM_PAUSE_PUSH  0x10
 223 #define SND_SOC_DAPM_STREAM_PAUSE_RELEASE       0x20
 224
 225 /* dapm event types */
 226 #define SND_SOC_DAPM_PRE_PMU    0x1     /* before widget power up */
 227 #define SND_SOC_DAPM_POST_PMU   0x2             /* after widget power up */
 228 #define SND_SOC_DAPM_PRE_PMD    0x4     /* before widget power down */
 229 #define SND_SOC_DAPM_POST_PMD   0x8             /* after widget power down */
 230 #define SND_SOC_DAPM_PRE_REG    0x10    /* before audio path setup */
 231 #define SND_SOC_DAPM_POST_REG   0x20    /* after audio path setup */
 232
 233 /* convenience event type detection */
 234 #define SND_SOC_DAPM_EVENT_ON(e)        \
 235         (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
 236 #define SND_SOC_DAPM_EVENT_OFF(e)       \
 237         (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
 238
 239 struct snd_soc_dapm_widget;
 240 enum snd_soc_dapm_type;
 241 struct snd_soc_dapm_path;
 242 struct snd_soc_dapm_pin;
 243 struct snd_soc_dapm_route;
 244
 245 int dapm_reg_event(struct snd_soc_dapm_widget *w,
 246                    struct snd_kcontrol *kcontrol, int event);
 247
 248 /* dapm controls */
 249 int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
 250         struct snd_ctl_elem_value *ucontrol);
 251 int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
 252         struct snd_ctl_elem_value *ucontrol);
 253 int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
 254         struct snd_ctl_elem_value *ucontrol);
 255 int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
 256         struct snd_ctl_elem_value *ucontrol);
 257 int snd_soc_dapm_get_value_enum_double(struct snd_kcontrol *kcontrol,
 258         struct snd_ctl_elem_value *ucontrol);
 259 int snd_soc_dapm_put_value_enum_double(struct snd_kcontrol *kcontrol,
 260         struct snd_ctl_elem_value *ucontrol);
 261 int snd_soc_dapm_info_pin_switch(struct snd_kcontrol *kcontrol,
 262         struct snd_ctl_elem_info *uinfo);
 263 int snd_soc_dapm_get_pin_switch(struct snd_kcontrol *kcontrol,
 264         struct snd_ctl_elem_value *uncontrol);
 265 int snd_soc_dapm_put_pin_switch(struct snd_kcontrol *kcontrol,
 266         struct snd_ctl_elem_value *uncontrol);
 267 int snd_soc_dapm_new_control(struct snd_soc_codec *codec,
 268         const struct snd_soc_dapm_widget *widget);
 269 int snd_soc_dapm_new_controls(struct snd_soc_codec *codec,
 270         const struct snd_soc_dapm_widget *widget,
 271         int num);
 272
 273 /* dapm path setup */
 274 int snd_soc_dapm_new_widgets(struct snd_soc_codec *codec);
 275 void snd_soc_dapm_free(struct snd_soc_device *socdev);
 276 int snd_soc_dapm_add_routes(struct snd_soc_codec *codec,
 277                             const struct snd_soc_dapm_route *route, int num);
 278
 279 /* dapm events */
 280 int snd_soc_dapm_stream_event(struct snd_soc_codec *codec, char *stream,
 281         int event);
 282
 283 /* dapm sys fs - used by the core */
 284 int snd_soc_dapm_sys_add(struct device *dev);
 285
 286 /* dapm audio pin control and status */
 287 int snd_soc_dapm_enable_pin(struct snd_soc_codec *codec, const char *pin);
 288 int snd_soc_dapm_disable_pin(struct snd_soc_codec *codec, const char *pin);
 289 int snd_soc_dapm_nc_pin(struct snd_soc_codec *codec, const char *pin);
 290 int snd_soc_dapm_get_pin_status(struct snd_soc_codec *codec, const char *pin);
 291 int snd_soc_dapm_sync(struct snd_soc_codec *codec);
 292
 293 /* dapm widget types */
 294 enum snd_soc_dapm_type {
 295         snd_soc_dapm_input = 0,         /* input pin */
 296         snd_soc_dapm_output,            /* output pin */
 297         snd_soc_dapm_mux,                       /* selects 1 analog signal from many inputs */
 298         snd_soc_dapm_value_mux,                 /* selects 1 analog signal from many inputs */
 299         snd_soc_dapm_mixer,                     /* mixes several analog signals together */
 300         snd_soc_dapm_mixer_named_ctl,           /* mixer with named controls */
 301         snd_soc_dapm_pga,                       /* programmable gain/attenuation (volume) */
 302         snd_soc_dapm_adc,                       /* analog to digital converter */
 303         snd_soc_dapm_dac,                       /* digital to analog converter */
 304         snd_soc_dapm_micbias,           /* microphone bias (power) */
 305         snd_soc_dapm_mic,                       /* microphone */
 306         snd_soc_dapm_hp,                        /* headphones */
 307         snd_soc_dapm_spk,                       /* speaker */
 308         snd_soc_dapm_line,                      /* line input/output */
 309         snd_soc_dapm_switch,            /* analog switch */
 310         snd_soc_dapm_vmid,                      /* codec bias/vmid - to minimise pops */
 311         snd_soc_dapm_pre,                       /* machine specific pre widget - exec first */
 312         snd_soc_dapm_post,                      /* machine specific post widget - exec last */
 313         snd_soc_dapm_supply,            /* power/clock supply */
 314 };
 315
 316 /*
 317  * DAPM audio route definition.
 318  *
 319  * Defines an audio route originating at source via control and finishing
 320  * at sink.
 321  */
 322 struct snd_soc_dapm_route {
 323         const char *sink;
 324         const char *control;
 325         const char *source;
 326 };
 327
 328 /* dapm audio path between two widgets */
 329 struct snd_soc_dapm_path {
 330         char *name;
 331         char *long_name;
 332
 333         /* source (input) and sink (output) widgets */
 334         struct snd_soc_dapm_widget *source;
 335         struct snd_soc_dapm_widget *sink;
 336         struct snd_kcontrol *kcontrol;
 337
 338         /* status */
 339         u32 connect:1;  /* source and sink widgets are connected */
 340         u32 walked:1;   /* path has been walked */
 341
 342         struct list_head list_source;
 343         struct list_head list_sink;
 344         struct list_head list;
 345 };
 346
 347 /* dapm widget */
 348 struct snd_soc_dapm_widget {
 349         enum snd_soc_dapm_type id;
 350         char *name;             /* widget name */
 351         char *sname;    /* stream name */
 352         struct snd_soc_codec *codec;
 353         struct list_head list;
 354
 355         /* dapm control */
 356         short reg;                                              /* negative reg = no direct dapm */
 357         unsigned char shift;                    /* bits to shift */
 358         unsigned int saved_value;               /* widget saved value */
 359         unsigned int value;                             /* widget current value */
 360         unsigned int mask;                      /* non-shifted mask */
 361         unsigned int on_val;                    /* on state value */
 362         unsigned int off_val;                   /* off state value */
 363         unsigned char power:1;                  /* block power status */
 364         unsigned char invert:1;                 /* invert the power bit */
 365         unsigned char active:1;                 /* active stream on DAC, ADC's */
 366         unsigned char connected:1;              /* connected codec pin */
 367         unsigned char new:1;                    /* cnew complete */
 368         unsigned char ext:1;                    /* has external widgets */
 369         unsigned char muted:1;                  /* muted for pop reduction */
 370         unsigned char suspend:1;                /* was active before suspend */
 371         unsigned char pmdown:1;                 /* waiting for timeout */
 372
 373         int (*power_check)(struct snd_soc_dapm_widget *w);
 374
 375         /* external events */
 376         unsigned short event_flags;             /* flags to specify event types */
 377         int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
 378
 379         /* kcontrols that relate to this widget */
 380         int num_kcontrols;
 381         const struct snd_kcontrol_new *kcontrols;
 382
 383         /* widget input and outputs */
 384         struct list_head sources;
 385         struct list_head sinks;
 386
 387         /* used during DAPM updates */
 388         struct list_head power_list;
 389 };
 390
 391 #endif