[mirror_ubuntu-bionic-kernel.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_MIXER_NAMED_CTL(wname, wreg, wshift, winvert, \
	 wcontrols, wncontrols)\
{       .id = snd_soc_dapm_mixer_named_ctl, .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}
#define SND_SOC_DAPM_VALUE_MUX(wname, wreg, wshift, winvert, wcontrols) \
{	.id = snd_soc_dapm_value_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_MIXER_NAMED_CTL_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_DAC_E(wname, stname, wreg, wshift, winvert, \
			   wevent, wflags)				\
{	.id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
	.shift = wshift, .invert = winvert, \
	.event = wevent, .event_flags = wflags}
#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}
#define SND_SOC_DAPM_ADC_E(wname, stname, wreg, wshift, winvert, \
			   wevent, wflags)				\
{	.id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
	.shift = wshift, .invert = winvert, \
	.event = wevent, .event_flags = wflags}

/* 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 }
#define SOC_DAPM_VALUE_ENUM(xname, xenum) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	.info = snd_soc_info_enum_double, \
	.get = snd_soc_dapm_get_value_enum_double, \
	.put = snd_soc_dapm_put_value_enum_double, \
	.private_value = (unsigned long)&xenum }
#define SOC_DAPM_PIN_SWITCH(xname) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname " Switch", \
	.info = snd_soc_dapm_info_pin_switch, \
	.get = snd_soc_dapm_get_pin_switch, \
	.put = snd_soc_dapm_put_pin_switch, \
	.private_value = (unsigned long)xname }

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