5817b52a29
Add a new API call snd_soc_dapm_nc_pin() which allows machine drivers to mark pins as being permanently disabled. At present this is identical to snd_soc_dapm_disable_pin() except in terms of improving the internal documentation of machine drivers that use it. The intention is that in future it will be extended to provide additional features such as hiding controls that are only relevant to paths using the disconnected pin. Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
337 lines
14 KiB
C
337 lines
14 KiB
C
/*
|
|
* linux/sound/soc-dapm.h -- ALSA SoC Dynamic Audio Power Management
|
|
*
|
|
* Author: Liam Girdwood
|
|
* Created: Aug 11th 2005
|
|
* Copyright: Wolfson Microelectronics. PLC.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License version 2 as
|
|
* published by the Free Software Foundation.
|
|
*/
|
|
|
|
#ifndef __LINUX_SND_SOC_DAPM_H
|
|
#define __LINUX_SND_SOC_DAPM_H
|
|
|
|
#include <linux/device.h>
|
|
#include <linux/types.h>
|
|
#include <sound/control.h>
|
|
#include <sound/soc.h>
|
|
|
|
/* widget has no PM register bit */
|
|
#define SND_SOC_NOPM -1
|
|
|
|
/*
|
|
* SoC dynamic audio power management
|
|
*
|
|
* We can have upto 4 power domains
|
|
* 1. Codec domain - VREF, VMID
|
|
* Usually controlled at codec probe/remove, although can be set
|
|
* at stream time if power is not needed for sidetone, etc.
|
|
* 2. Platform/Machine domain - physically connected inputs and outputs
|
|
* Is platform/machine and user action specific, is set in the machine
|
|
* driver and by userspace e.g when HP are inserted
|
|
* 3. Path domain - Internal codec path mixers
|
|
* Are automatically set when mixer and mux settings are
|
|
* changed by the user.
|
|
* 4. Stream domain - DAC's and ADC's.
|
|
* Enabled when stream playback/capture is started.
|
|
*/
|
|
|
|
/* codec domain */
|
|
#define SND_SOC_DAPM_VMID(wname) \
|
|
{ .id = snd_soc_dapm_vmid, .name = wname, .kcontrols = NULL, \
|
|
.num_kcontrols = 0}
|
|
|
|
/* platform domain */
|
|
#define SND_SOC_DAPM_INPUT(wname) \
|
|
{ .id = snd_soc_dapm_input, .name = wname, .kcontrols = NULL, \
|
|
.num_kcontrols = 0}
|
|
#define SND_SOC_DAPM_OUTPUT(wname) \
|
|
{ .id = snd_soc_dapm_output, .name = wname, .kcontrols = NULL, \
|
|
.num_kcontrols = 0}
|
|
#define SND_SOC_DAPM_MIC(wname, wevent) \
|
|
{ .id = snd_soc_dapm_mic, .name = wname, .kcontrols = NULL, \
|
|
.num_kcontrols = 0, .event = wevent, \
|
|
.event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
|
|
#define SND_SOC_DAPM_HP(wname, wevent) \
|
|
{ .id = snd_soc_dapm_hp, .name = wname, .kcontrols = NULL, \
|
|
.num_kcontrols = 0, .event = wevent, \
|
|
.event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
|
|
#define SND_SOC_DAPM_SPK(wname, wevent) \
|
|
{ .id = snd_soc_dapm_spk, .name = wname, .kcontrols = NULL, \
|
|
.num_kcontrols = 0, .event = wevent, \
|
|
.event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
|
|
#define SND_SOC_DAPM_LINE(wname, wevent) \
|
|
{ .id = snd_soc_dapm_line, .name = wname, .kcontrols = NULL, \
|
|
.num_kcontrols = 0, .event = wevent, \
|
|
.event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
|
|
|
|
/* path domain */
|
|
#define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\
|
|
wcontrols, wncontrols) \
|
|
{ .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
|
|
.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols}
|
|
#define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
|
|
wcontrols, wncontrols)\
|
|
{ .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
|
|
.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols}
|
|
#define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
|
|
{ .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
|
|
.invert = winvert, .kcontrols = NULL, .num_kcontrols = 0}
|
|
#define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
|
|
{ .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
|
|
.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1}
|
|
#define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
|
|
{ .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
|
|
.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1}
|
|
|
|
/* path domain with event - event handler must return 0 for success */
|
|
#define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \
|
|
wncontrols, wevent, wflags) \
|
|
{ .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
|
|
.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols, \
|
|
.event = wevent, .event_flags = wflags}
|
|
#define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \
|
|
wncontrols, wevent, wflags) \
|
|
{ .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
|
|
.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols, \
|
|
.event = wevent, .event_flags = wflags}
|
|
#define SND_SOC_DAPM_MICBIAS_E(wname, wreg, wshift, winvert, wevent, wflags) \
|
|
{ .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
|
|
.invert = winvert, .kcontrols = NULL, .num_kcontrols = 0, \
|
|
.event = wevent, .event_flags = wflags}
|
|
#define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
|
|
wevent, wflags) \
|
|
{ .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
|
|
.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1 \
|
|
.event = wevent, .event_flags = wflags}
|
|
#define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
|
|
wevent, wflags) \
|
|
{ .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
|
|
.invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1, \
|
|
.event = wevent, .event_flags = wflags}
|
|
|
|
/* events that are pre and post DAPM */
|
|
#define SND_SOC_DAPM_PRE(wname, wevent) \
|
|
{ .id = snd_soc_dapm_pre, .name = wname, .kcontrols = NULL, \
|
|
.num_kcontrols = 0, .event = wevent, \
|
|
.event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
|
|
#define SND_SOC_DAPM_POST(wname, wevent) \
|
|
{ .id = snd_soc_dapm_post, .name = wname, .kcontrols = NULL, \
|
|
.num_kcontrols = 0, .event = wevent, \
|
|
.event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
|
|
|
|
/* stream domain */
|
|
#define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
|
|
{ .id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
|
|
.shift = wshift, .invert = winvert}
|
|
#define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
|
|
{ .id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
|
|
.shift = wshift, .invert = winvert}
|
|
|
|
/* generic register modifier widget */
|
|
#define SND_SOC_DAPM_REG(wid, wname, wreg, wshift, wmask, won_val, woff_val) \
|
|
{ .id = wid, .name = wname, .kcontrols = NULL, .num_kcontrols = 0, \
|
|
.reg = -((wreg) + 1), .shift = wshift, .mask = wmask, \
|
|
.on_val = won_val, .off_val = woff_val, .event = dapm_reg_event, \
|
|
.event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
|
|
|
|
/* dapm kcontrol types */
|
|
#define SOC_DAPM_SINGLE(xname, reg, shift, max, invert) \
|
|
{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
|
|
.info = snd_soc_info_volsw, \
|
|
.get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
|
|
.private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
|
|
#define SOC_DAPM_DOUBLE(xname, reg, shift_left, shift_right, max, invert, \
|
|
power) \
|
|
{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
|
|
.info = snd_soc_info_volsw, \
|
|
.get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
|
|
.private_value = (reg) | ((shift_left) << 8) | ((shift_right) << 12) |\
|
|
((max) << 16) | ((invert) << 24) }
|
|
#define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
|
|
{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
|
|
.info = snd_soc_info_volsw, \
|
|
.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
|
|
.tlv.p = (tlv_array), \
|
|
.get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
|
|
.private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
|
|
#define SOC_DAPM_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, \
|
|
power, tlv_array) \
|
|
{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
|
|
.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
|
|
.tlv.p = (tlv_array), \
|
|
.info = snd_soc_info_volsw, \
|
|
.get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
|
|
.private_value = (reg) | ((shift_left) << 8) | ((shift_right) << 12) |\
|
|
((max) << 16) | ((invert) << 24) }
|
|
#define SOC_DAPM_ENUM(xname, xenum) \
|
|
{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
|
|
.info = snd_soc_info_enum_double, \
|
|
.get = snd_soc_dapm_get_enum_double, \
|
|
.put = snd_soc_dapm_put_enum_double, \
|
|
.private_value = (unsigned long)&xenum }
|
|
|
|
/* dapm stream operations */
|
|
#define SND_SOC_DAPM_STREAM_NOP 0x0
|
|
#define SND_SOC_DAPM_STREAM_START 0x1
|
|
#define SND_SOC_DAPM_STREAM_STOP 0x2
|
|
#define SND_SOC_DAPM_STREAM_SUSPEND 0x4
|
|
#define SND_SOC_DAPM_STREAM_RESUME 0x8
|
|
#define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10
|
|
#define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20
|
|
|
|
/* dapm event types */
|
|
#define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */
|
|
#define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */
|
|
#define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */
|
|
#define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */
|
|
#define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */
|
|
#define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */
|
|
|
|
/* convenience event type detection */
|
|
#define SND_SOC_DAPM_EVENT_ON(e) \
|
|
(e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
|
|
#define SND_SOC_DAPM_EVENT_OFF(e) \
|
|
(e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
|
|
|
|
struct snd_soc_dapm_widget;
|
|
enum snd_soc_dapm_type;
|
|
struct snd_soc_dapm_path;
|
|
struct snd_soc_dapm_pin;
|
|
struct snd_soc_dapm_route;
|
|
|
|
int dapm_reg_event(struct snd_soc_dapm_widget *w,
|
|
struct snd_kcontrol *kcontrol, int event);
|
|
|
|
/* dapm controls */
|
|
int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
|
|
struct snd_ctl_elem_value *ucontrol);
|
|
int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
|
|
struct snd_ctl_elem_value *ucontrol);
|
|
int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
|
|
struct snd_ctl_elem_value *ucontrol);
|
|
int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
|
|
struct snd_ctl_elem_value *ucontrol);
|
|
int snd_soc_dapm_new_control(struct snd_soc_codec *codec,
|
|
const struct snd_soc_dapm_widget *widget);
|
|
int snd_soc_dapm_new_controls(struct snd_soc_codec *codec,
|
|
const struct snd_soc_dapm_widget *widget,
|
|
int num);
|
|
|
|
/* dapm path setup */
|
|
int __deprecated snd_soc_dapm_connect_input(struct snd_soc_codec *codec,
|
|
const char *sink_name, const char *control_name, const char *src_name);
|
|
int snd_soc_dapm_new_widgets(struct snd_soc_codec *codec);
|
|
void snd_soc_dapm_free(struct snd_soc_device *socdev);
|
|
int snd_soc_dapm_add_routes(struct snd_soc_codec *codec,
|
|
const struct snd_soc_dapm_route *route, int num);
|
|
|
|
/* dapm events */
|
|
int snd_soc_dapm_stream_event(struct snd_soc_codec *codec, char *stream,
|
|
int event);
|
|
int snd_soc_dapm_set_bias_level(struct snd_soc_device *socdev,
|
|
enum snd_soc_bias_level level);
|
|
|
|
/* dapm sys fs - used by the core */
|
|
int snd_soc_dapm_sys_add(struct device *dev);
|
|
|
|
/* dapm audio pin control and status */
|
|
int snd_soc_dapm_enable_pin(struct snd_soc_codec *codec, char *pin);
|
|
int snd_soc_dapm_disable_pin(struct snd_soc_codec *codec, char *pin);
|
|
int snd_soc_dapm_nc_pin(struct snd_soc_codec *codec, char *pin);
|
|
int snd_soc_dapm_get_pin_status(struct snd_soc_codec *codec, char *pin);
|
|
int snd_soc_dapm_sync(struct snd_soc_codec *codec);
|
|
|
|
/* dapm widget types */
|
|
enum snd_soc_dapm_type {
|
|
snd_soc_dapm_input = 0, /* input pin */
|
|
snd_soc_dapm_output, /* output pin */
|
|
snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */
|
|
snd_soc_dapm_mixer, /* mixes several analog signals together */
|
|
snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */
|
|
snd_soc_dapm_adc, /* analog to digital converter */
|
|
snd_soc_dapm_dac, /* digital to analog converter */
|
|
snd_soc_dapm_micbias, /* microphone bias (power) */
|
|
snd_soc_dapm_mic, /* microphone */
|
|
snd_soc_dapm_hp, /* headphones */
|
|
snd_soc_dapm_spk, /* speaker */
|
|
snd_soc_dapm_line, /* line input/output */
|
|
snd_soc_dapm_switch, /* analog switch */
|
|
snd_soc_dapm_vmid, /* codec bias/vmid - to minimise pops */
|
|
snd_soc_dapm_pre, /* machine specific pre widget - exec first */
|
|
snd_soc_dapm_post, /* machine specific post widget - exec last */
|
|
};
|
|
|
|
/*
|
|
* DAPM audio route definition.
|
|
*
|
|
* Defines an audio route originating at source via control and finishing
|
|
* at sink.
|
|
*/
|
|
struct snd_soc_dapm_route {
|
|
const char *sink;
|
|
const char *control;
|
|
const char *source;
|
|
};
|
|
|
|
/* dapm audio path between two widgets */
|
|
struct snd_soc_dapm_path {
|
|
char *name;
|
|
char *long_name;
|
|
|
|
/* source (input) and sink (output) widgets */
|
|
struct snd_soc_dapm_widget *source;
|
|
struct snd_soc_dapm_widget *sink;
|
|
struct snd_kcontrol *kcontrol;
|
|
|
|
/* status */
|
|
u32 connect:1; /* source and sink widgets are connected */
|
|
u32 walked:1; /* path has been walked */
|
|
|
|
struct list_head list_source;
|
|
struct list_head list_sink;
|
|
struct list_head list;
|
|
};
|
|
|
|
/* dapm widget */
|
|
struct snd_soc_dapm_widget {
|
|
enum snd_soc_dapm_type id;
|
|
char *name; /* widget name */
|
|
char *sname; /* stream name */
|
|
struct snd_soc_codec *codec;
|
|
struct list_head list;
|
|
|
|
/* dapm control */
|
|
short reg; /* negative reg = no direct dapm */
|
|
unsigned char shift; /* bits to shift */
|
|
unsigned int saved_value; /* widget saved value */
|
|
unsigned int value; /* widget current value */
|
|
unsigned int mask; /* non-shifted mask */
|
|
unsigned int on_val; /* on state value */
|
|
unsigned int off_val; /* off state value */
|
|
unsigned char power:1; /* block power status */
|
|
unsigned char invert:1; /* invert the power bit */
|
|
unsigned char active:1; /* active stream on DAC, ADC's */
|
|
unsigned char connected:1; /* connected codec pin */
|
|
unsigned char new:1; /* cnew complete */
|
|
unsigned char ext:1; /* has external widgets */
|
|
unsigned char muted:1; /* muted for pop reduction */
|
|
unsigned char suspend:1; /* was active before suspend */
|
|
unsigned char pmdown:1; /* waiting for timeout */
|
|
|
|
/* external events */
|
|
unsigned short event_flags; /* flags to specify event types */
|
|
int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
|
|
|
|
/* kcontrols that relate to this widget */
|
|
int num_kcontrols;
|
|
const struct snd_kcontrol_new *kcontrols;
|
|
|
|
/* widget input and outputs */
|
|
struct list_head sources;
|
|
struct list_head sinks;
|
|
};
|
|
|
|
#endif
|