[deliverable/linux.git] / include / sound / soc-dapm.h

/*
 * 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;

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