[mirror_ubuntu-jammy-kernel.git] / include / sound / soc.h

/*
 * linux/sound/soc.h -- ALSA SoC Layer
 *
 * 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_H
#define __LINUX_SND_SOC_H

#include <linux/platform_device.h>
#include <linux/types.h>
#include <linux/workqueue.h>
#include <linux/interrupt.h>
#include <linux/kernel.h>
#include <sound/core.h>
#include <sound/pcm.h>
#include <sound/control.h>
#include <sound/ac97_codec.h>

/*
 * Convenience kcontrol builders
 */
#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
	((unsigned long)&(struct soc_mixer_control) \
	{.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \
	.invert = xinvert})
#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
	((unsigned long)&(struct soc_mixer_control) \
	{.reg = xreg, .max = xmax, .invert = xinvert})
#define SOC_SINGLE(xname, reg, shift, max, invert) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
	.put = snd_soc_put_volsw, \
	.private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
#define SOC_SINGLE_TLV(xname, reg, shift, max, invert, 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_get_volsw,\
	.put = snd_soc_put_volsw, \
	.private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
#define SOC_DOUBLE(xname, xreg, shift_left, shift_right, xmax, xinvert) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
	.put = snd_soc_put_volsw, \
	.private_value = (unsigned long)&(struct soc_mixer_control) \
		{.reg = xreg, .shift = shift_left, .rshift = shift_right, \
		 .max = xmax, .invert = xinvert} }
#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
	.info = snd_soc_info_volsw_2r, \
	.get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
	.private_value = (unsigned long)&(struct soc_mixer_control) \
		{.reg = reg_left, .rreg = reg_right, .shift = xshift, \
		.max = xmax, .invert = xinvert} }
#define SOC_DOUBLE_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert, 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_get_volsw, \
	.put = snd_soc_put_volsw, \
	.private_value = (unsigned long)&(struct soc_mixer_control) \
		{.reg = xreg, .shift = shift_left, .rshift = shift_right,\
		 .max = xmax, .invert = xinvert} }
#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, 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_2r, \
	.get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
	.private_value = (unsigned long)&(struct soc_mixer_control) \
		{.reg = reg_left, .rreg = reg_right, .shift = xshift, \
		.max = xmax, .invert = xinvert} }
#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, 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_s8, .get = snd_soc_get_volsw_s8, \
	.put    = snd_soc_put_volsw_s8, \
	.private_value = (unsigned long)&(struct soc_mixer_control) \
		{.reg = xreg, .min = xmin, .max = xmax} }
#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
{	.reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
	.max = xmax, .texts = xtexts }
#define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
	SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
#define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
{	.max = xmax, .texts = xtexts }
#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
{	.reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
	.mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
	SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
#define SOC_ENUM(xname, xenum) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
	.info = snd_soc_info_enum_double, \
	.get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
	.private_value = (unsigned long)&xenum }
#define SOC_VALUE_ENUM(xname, xenum) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
	.info = snd_soc_info_enum_double, \
	.get = snd_soc_get_value_enum_double, \
	.put = snd_soc_put_value_enum_double, \
	.private_value = (unsigned long)&xenum }
#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
	 xhandler_get, xhandler_put) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	.info = snd_soc_info_volsw, \
	.get = xhandler_get, .put = xhandler_put, \
	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
	 xhandler_get, xhandler_put, 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 = xhandler_get, .put = xhandler_put, \
	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
#define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	.info = snd_soc_info_bool_ext, \
	.get = xhandler_get, .put = xhandler_put, \
	.private_value = xdata }
#define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	.info = snd_soc_info_enum_ext, \
	.get = xhandler_get, .put = xhandler_put, \
	.private_value = (unsigned long)&xenum }

/*
 * Bias levels
 *
 * @ON:      Bias is fully on for audio playback and capture operations.
 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
 *           stream start and stop operations.
 * @STANDBY: Low power standby state when no playback/capture operations are
 *           in progress. NOTE: The transition time between STANDBY and ON
 *           should be as fast as possible and no longer than 10ms.
 * @OFF:     Power Off. No restrictions on transition times.
 */
enum snd_soc_bias_level {
	SND_SOC_BIAS_ON,
	SND_SOC_BIAS_PREPARE,
	SND_SOC_BIAS_STANDBY,
	SND_SOC_BIAS_OFF,
};

struct snd_jack;
struct snd_soc_card;
struct snd_soc_device;
struct snd_soc_pcm_stream;
struct snd_soc_ops;
struct snd_soc_dai_mode;
struct snd_soc_pcm_runtime;
struct snd_soc_dai;
struct snd_soc_platform;
struct snd_soc_codec;
struct soc_enum;
struct snd_soc_ac97_ops;
struct snd_soc_jack;
struct snd_soc_jack_pin;
#ifdef CONFIG_GPIOLIB
struct snd_soc_jack_gpio;
#endif

typedef int (*hw_write_t)(void *,const char* ,int);
typedef int (*hw_read_t)(void *,char* ,int);

extern struct snd_ac97_bus_ops soc_ac97_ops;

int snd_soc_register_platform(struct snd_soc_platform *platform);
void snd_soc_unregister_platform(struct snd_soc_platform *platform);
int snd_soc_register_codec(struct snd_soc_codec *codec);
void snd_soc_unregister_codec(struct snd_soc_codec *codec);

/* pcm <-> DAI connect */
void snd_soc_free_pcms(struct snd_soc_device *socdev);
int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid);
int snd_soc_init_card(struct snd_soc_device *socdev);

/* set runtime hw params */
int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
	const struct snd_pcm_hardware *hw);

/* Jack reporting */
int snd_soc_jack_new(struct snd_soc_card *card, const char *id, int type,
		     struct snd_soc_jack *jack);
void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
			  struct snd_soc_jack_pin *pins);
#ifdef CONFIG_GPIOLIB
int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
			struct snd_soc_jack_gpio *gpios);
void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
			struct snd_soc_jack_gpio *gpios);
#endif

/* codec IO */
#define snd_soc_read(codec, reg) codec->read(codec, reg)
#define snd_soc_write(codec, reg, value) codec->write(codec, reg, value)

/* codec register bit access */
int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
				unsigned short mask, unsigned short value);
int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
				unsigned short mask, unsigned short value);

int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
	struct snd_ac97_bus_ops *ops, int num);
void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);

/*
 *Controls
 */
struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
	void *data, char *long_name);
int snd_soc_add_controls(struct snd_soc_codec *codec,
	const struct snd_kcontrol_new *controls, int num_controls);
int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_info *uinfo);
int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_info *uinfo);
int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_info *uinfo);
int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_info *uinfo);
#define snd_soc_info_bool_ext		snd_ctl_boolean_mono_info
int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_info *uinfo);
int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_info *uinfo);
int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);

/**
 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 *
 * @pin:    name of the pin to update
 * @mask:   bits to check for in reported jack status
 * @invert: if non-zero then pin is enabled when status is not reported
 */
struct snd_soc_jack_pin {
	struct list_head list;
	const char *pin;
	int mask;
	bool invert;
};

/**
 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 *
 * @gpio:         gpio number
 * @name:         gpio name
 * @report:       value to report when jack detected
 * @invert:       report presence in low state
 * @debouce_time: debouce time in ms
 */
#ifdef CONFIG_GPIOLIB
struct snd_soc_jack_gpio {
	unsigned int gpio;
	const char *name;
	int report;
	int invert;
	int debounce_time;
	struct snd_soc_jack *jack;
	struct work_struct work;
};
#endif

struct snd_soc_jack {
	struct snd_jack *jack;
	struct snd_soc_card *card;
	struct list_head pins;
	int status;
};

/* SoC PCM stream information */
struct snd_soc_pcm_stream {
	char *stream_name;
	u64 formats;			/* SNDRV_PCM_FMTBIT_* */
	unsigned int rates;		/* SNDRV_PCM_RATE_* */
	unsigned int rate_min;		/* min rate */
	unsigned int rate_max;		/* max rate */
	unsigned int channels_min;	/* min channels */
	unsigned int channels_max;	/* max channels */
	unsigned int active:1;		/* stream is in use */
};

/* SoC audio ops */
struct snd_soc_ops {
	int (*startup)(struct snd_pcm_substream *);
	void (*shutdown)(struct snd_pcm_substream *);
	int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
	int (*hw_free)(struct snd_pcm_substream *);
	int (*prepare)(struct snd_pcm_substream *);
	int (*trigger)(struct snd_pcm_substream *, int);
};

/* SoC Audio Codec */
struct snd_soc_codec {
	char *name;
	struct module *owner;
	struct mutex mutex;
	struct device *dev;

	struct list_head list;

	/* callbacks */
	int (*set_bias_level)(struct snd_soc_codec *,
			      enum snd_soc_bias_level level);

	/* runtime */
	struct snd_card *card;
	struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
	unsigned int active;
	unsigned int pcm_devs;
	void *private_data;

	/* codec IO */
	void *control_data; /* codec control (i2c/3wire) data */
	unsigned int (*read)(struct snd_soc_codec *, unsigned int);
	int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
	int (*display_register)(struct snd_soc_codec *, char *,
				size_t, unsigned int);
	hw_write_t hw_write;
	hw_read_t hw_read;
	void *reg_cache;
	short reg_cache_size;
	short reg_cache_step;

	/* dapm */
	u32 pop_time;
	struct list_head dapm_widgets;
	struct list_head dapm_paths;
	enum snd_soc_bias_level bias_level;
	enum snd_soc_bias_level suspend_bias_level;
	struct delayed_work delayed_work;

	/* codec DAI's */
	struct snd_soc_dai *dai;
	unsigned int num_dai;

#ifdef CONFIG_DEBUG_FS
	struct dentry *debugfs_reg;
	struct dentry *debugfs_pop_time;
#endif
};

/* codec device */
struct snd_soc_codec_device {
	int (*probe)(struct platform_device *pdev);
	int (*remove)(struct platform_device *pdev);
	int (*suspend)(struct platform_device *pdev, pm_message_t state);
	int (*resume)(struct platform_device *pdev);
};

/* SoC platform interface */
struct snd_soc_platform {
	char *name;
	struct list_head list;

	int (*probe)(struct platform_device *pdev);
	int (*remove)(struct platform_device *pdev);
	int (*suspend)(struct snd_soc_dai *dai);
	int (*resume)(struct snd_soc_dai *dai);

	/* pcm creation and destruction */
	int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
		struct snd_pcm *);
	void (*pcm_free)(struct snd_pcm *);

	/* platform stream ops */
	struct snd_pcm_ops *pcm_ops;
};

/* SoC machine DAI configuration, glues a codec and cpu DAI together */
struct snd_soc_dai_link  {
	char *name;			/* Codec name */
	char *stream_name;		/* Stream name */

	/* DAI */
	struct snd_soc_dai *codec_dai;
	struct snd_soc_dai *cpu_dai;

	/* machine stream operations */
	struct snd_soc_ops *ops;

	/* codec/machine specific init - e.g. add machine controls */
	int (*init)(struct snd_soc_codec *codec);

	/* Symmetry requirements */
	unsigned int symmetric_rates:1;

	/* Symmetry data - only valid if symmetry is being enforced */
	unsigned int rate;

	/* DAI pcm */
	struct snd_pcm *pcm;
};

/* SoC card */
struct snd_soc_card {
	char *name;
	struct device *dev;

	struct list_head list;

	int instantiated;

	int (*probe)(struct platform_device *pdev);
	int (*remove)(struct platform_device *pdev);

	/* the pre and post PM functions are used to do any PM work before and
	 * after the codec and DAI's do any PM work. */
	int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
	int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
	int (*resume_pre)(struct platform_device *pdev);
	int (*resume_post)(struct platform_device *pdev);

	/* callbacks */
	int (*set_bias_level)(struct snd_soc_card *,
			      enum snd_soc_bias_level level);

	/* CPU <--> Codec DAI links  */
	struct snd_soc_dai_link *dai_link;
	int num_links;

	struct snd_soc_device *socdev;

	struct snd_soc_codec *codec;

	struct snd_soc_platform *platform;
	struct delayed_work delayed_work;
	struct work_struct deferred_resume_work;
};

/* SoC Device - the audio subsystem */
struct snd_soc_device {
	struct device *dev;
	struct snd_soc_card *card;
	struct snd_soc_codec_device *codec_dev;
	void *codec_data;
};

/* runtime channel data */
struct snd_soc_pcm_runtime {
	struct snd_soc_dai_link *dai;
	struct snd_soc_device *socdev;
};

/* mixer control */
struct soc_mixer_control {
	int min, max;
	unsigned int reg, rreg, shift, rshift, invert;
};

/* enumerated kcontrol */
struct soc_enum {
	unsigned short reg;
	unsigned short reg2;
	unsigned char shift_l;
	unsigned char shift_r;
	unsigned int max;
	unsigned int mask;
	const char **texts;
	const unsigned int *values;
	void *dapm;
};

#include <sound/soc-dai.h>

#endif
Commit	Line	Data
808db4a4 RP	1	/*
	2	* linux/sound/soc.h -- ALSA SoC Layer
	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_H
	14	#define __LINUX_SND_SOC_H
	15
	16	#include <linux/platform_device.h>
	17	#include <linux/types.h>
4484bb2e	18	#include <linux/workqueue.h>
ec67624d LCM	19	#include <linux/interrupt.h>
ec67624d LCM	20	#include <linux/kernel.h>
808db4a4 RP	21	#include <sound/core.h>
	22	#include <sound/pcm.h>
	23	#include <sound/control.h>
	24	#include <sound/ac97_codec.h>
	25
808db4a4 RP	26	/*
	27	* Convenience kcontrol builders
	28	*/
4eaa9819 JS	29	#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
4eaa9819 JS	30	((unsigned long)&(struct soc_mixer_control) \
762b8df7 MB	31	{.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \
762b8df7 MB	32	.invert = xinvert})
4eaa9819 JS	33	#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
	34	((unsigned long)&(struct soc_mixer_control) \
	35	{.reg = xreg, .max = xmax, .invert = xinvert})
a7a4ac86	36	#define SOC_SINGLE(xname, reg, shift, max, invert) \
808db4a4 RP	37	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	38	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
	39	.put = snd_soc_put_volsw, \
a7a4ac86 PZ	40	.private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
	41	#define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
	42	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	43	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ \|\
	44	SNDRV_CTL_ELEM_ACCESS_READWRITE,\
	45	.tlv.p = (tlv_array), \
	46	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
	47	.put = snd_soc_put_volsw, \
	48	.private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
4eaa9819	49	#define SOC_DOUBLE(xname, xreg, shift_left, shift_right, xmax, xinvert) \
808db4a4 RP	50	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
	51	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
	52	.put = snd_soc_put_volsw, \
4eaa9819 JS	53	.private_value = (unsigned long)&(struct soc_mixer_control) \
	54	{.reg = xreg, .shift = shift_left, .rshift = shift_right, \
	55	.max = xmax, .invert = xinvert} }
	56	#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
808db4a4 RP	57	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
	58	.info = snd_soc_info_volsw_2r, \
	59	.get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
4eaa9819 JS	60	.private_value = (unsigned long)&(struct soc_mixer_control) \
	61	{.reg = reg_left, .rreg = reg_right, .shift = xshift, \
	62	.max = xmax, .invert = xinvert} }
	63	#define SOC_DOUBLE_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert, tlv_array) \
a7a4ac86 PZ	64	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
	65	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ \|\
	66	SNDRV_CTL_ELEM_ACCESS_READWRITE,\
	67	.tlv.p = (tlv_array), \
	68	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
	69	.put = snd_soc_put_volsw, \
4eaa9819 JS	70	.private_value = (unsigned long)&(struct soc_mixer_control) \
	71	{.reg = xreg, .shift = shift_left, .rshift = shift_right,\
	72	.max = xmax, .invert = xinvert} }
	73	#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
a7a4ac86 PZ	74	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
	75	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ \|\
	76	SNDRV_CTL_ELEM_ACCESS_READWRITE,\
	77	.tlv.p = (tlv_array), \
	78	.info = snd_soc_info_volsw_2r, \
	79	.get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
4eaa9819 JS	80	.private_value = (unsigned long)&(struct soc_mixer_control) \
	81	{.reg = reg_left, .rreg = reg_right, .shift = xshift, \
	82	.max = xmax, .invert = xinvert} }
	83	#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
e13ac2e9 MB	84	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
	85	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ \| \
	86	SNDRV_CTL_ELEM_ACCESS_READWRITE, \
	87	.tlv.p = (tlv_array), \
	88	.info = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
	89	.put = snd_soc_put_volsw_s8, \
4eaa9819 JS	90	.private_value = (unsigned long)&(struct soc_mixer_control) \
4eaa9819 JS	91	{.reg = xreg, .min = xmin, .max = xmax} }
f8ba0b7b	92	#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
808db4a4	93	{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
f8ba0b7b JS	94	.max = xmax, .texts = xtexts }
	95	#define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
	96	SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
	97	#define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
	98	{ .max = xmax, .texts = xtexts }
2e72f8e3 PU	99	#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
	100	{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
	101	.mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
	102	#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
	103	SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
808db4a4 RP	104	#define SOC_ENUM(xname, xenum) \
	105	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
	106	.info = snd_soc_info_enum_double, \
	107	.get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
	108	.private_value = (unsigned long)&xenum }
2e72f8e3 PU	109	#define SOC_VALUE_ENUM(xname, xenum) \
2e72f8e3 PU	110	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
74155556	111	.info = snd_soc_info_enum_double, \
2e72f8e3 PU	112	.get = snd_soc_get_value_enum_double, \
	113	.put = snd_soc_put_value_enum_double, \
	114	.private_value = (unsigned long)&xenum }
f8ba0b7b	115	#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
808db4a4 RP	116	xhandler_get, xhandler_put) \
808db4a4 RP	117	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
1c433fbd	118	.info = snd_soc_info_volsw, \
808db4a4	119	.get = xhandler_get, .put = xhandler_put, \
f8ba0b7b JS	120	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
f8ba0b7b JS	121	#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
10144c09 MM	122	xhandler_get, xhandler_put, tlv_array) \
	123	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	124	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ \|\
	125	SNDRV_CTL_ELEM_ACCESS_READWRITE,\
	126	.tlv.p = (tlv_array), \
	127	.info = snd_soc_info_volsw, \
	128	.get = xhandler_get, .put = xhandler_put, \
f8ba0b7b	129	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
808db4a4 RP	130	#define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
	131	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	132	.info = snd_soc_info_bool_ext, \
	133	.get = xhandler_get, .put = xhandler_put, \
	134	.private_value = xdata }
	135	#define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
	136	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	137	.info = snd_soc_info_enum_ext, \
	138	.get = xhandler_get, .put = xhandler_put, \
	139	.private_value = (unsigned long)&xenum }
	140
0be9898a MB	141	/*
	142	* Bias levels
	143	*
	144	* @ON: Bias is fully on for audio playback and capture operations.
	145	* @PREPARE: Prepare for audio operations. Called before DAPM switching for
	146	* stream start and stop operations.
	147	* @STANDBY: Low power standby state when no playback/capture operations are
	148	* in progress. NOTE: The transition time between STANDBY and ON
	149	* should be as fast as possible and no longer than 10ms.
	150	* @OFF: Power Off. No restrictions on transition times.
	151	*/
	152	enum snd_soc_bias_level {
	153	SND_SOC_BIAS_ON,
	154	SND_SOC_BIAS_PREPARE,
	155	SND_SOC_BIAS_STANDBY,
	156	SND_SOC_BIAS_OFF,
	157	};
	158
8a2cd618 MB	159	struct snd_jack;
8a2cd618 MB	160	struct snd_soc_card;
808db4a4 RP	161	struct snd_soc_device;
	162	struct snd_soc_pcm_stream;
	163	struct snd_soc_ops;
	164	struct snd_soc_dai_mode;
	165	struct snd_soc_pcm_runtime;
3c4b266f	166	struct snd_soc_dai;
12a48a8c	167	struct snd_soc_platform;
808db4a4	168	struct snd_soc_codec;
808db4a4 RP	169	struct soc_enum;
808db4a4 RP	170	struct snd_soc_ac97_ops;
8a2cd618 MB	171	struct snd_soc_jack;
8a2cd618 MB	172	struct snd_soc_jack_pin;
ec67624d LCM	173	#ifdef CONFIG_GPIOLIB
	174	struct snd_soc_jack_gpio;
	175	#endif
808db4a4 RP	176
	177	typedef int (hw_write_t)(void ,const char* ,int);
	178	typedef int (hw_read_t)(void ,char* ,int);
	179
	180	extern struct snd_ac97_bus_ops soc_ac97_ops;
	181
12a48a8c MB	182	int snd_soc_register_platform(struct snd_soc_platform *platform);
12a48a8c MB	183	void snd_soc_unregister_platform(struct snd_soc_platform *platform);
0d0cf00a MB	184	int snd_soc_register_codec(struct snd_soc_codec *codec);
0d0cf00a MB	185	void snd_soc_unregister_codec(struct snd_soc_codec *codec);
12a48a8c	186
808db4a4 RP	187	/* pcm <-> DAI connect */
	188	void snd_soc_free_pcms(struct snd_soc_device *socdev);
	189	int snd_soc_new_pcms(struct snd_soc_device socdev, int idx, const char xid);
968a6025	190	int snd_soc_init_card(struct snd_soc_device *socdev);
808db4a4 RP	191
	192	/* set runtime hw params */
	193	int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
	194	const struct snd_pcm_hardware *hw);
808db4a4	195
8a2cd618 MB	196	/* Jack reporting */
	197	int snd_soc_jack_new(struct snd_soc_card card, const char id, int type,
	198	struct snd_soc_jack *jack);
	199	void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
	200	int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
	201	struct snd_soc_jack_pin *pins);
ec67624d LCM	202	#ifdef CONFIG_GPIOLIB
	203	int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
	204	struct snd_soc_jack_gpio *gpios);
	205	void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
	206	struct snd_soc_jack_gpio *gpios);
	207	#endif
8a2cd618	208
808db4a4 RP	209	/* codec IO */
	210	#define snd_soc_read(codec, reg) codec->read(codec, reg)
	211	#define snd_soc_write(codec, reg, value) codec->write(codec, reg, value)
	212
	213	/* codec register bit access */
	214	int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
	215	unsigned short mask, unsigned short value);
	216	int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
	217	unsigned short mask, unsigned short value);
	218
	219	int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
	220	struct snd_ac97_bus_ops *ops, int num);
	221	void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
	222
	223	/*
	224	*Controls
	225	*/
	226	struct snd_kcontrol snd_soc_cnew(const struct snd_kcontrol_new _template,
	227	void data, char long_name);
3e8e1952 IM	228	int snd_soc_add_controls(struct snd_soc_codec *codec,
3e8e1952 IM	229	const struct snd_kcontrol_new *controls, int num_controls);
808db4a4 RP	230	int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
	231	struct snd_ctl_elem_info *uinfo);
	232	int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
	233	struct snd_ctl_elem_info *uinfo);
	234	int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
	235	struct snd_ctl_elem_value *ucontrol);
	236	int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
	237	struct snd_ctl_elem_value *ucontrol);
2e72f8e3 PU	238	int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
	239	struct snd_ctl_elem_value *ucontrol);
	240	int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
	241	struct snd_ctl_elem_value *ucontrol);
808db4a4 RP	242	int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
	243	struct snd_ctl_elem_info *uinfo);
	244	int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
	245	struct snd_ctl_elem_info *uinfo);
392abe9c	246	#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
808db4a4 RP	247	int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
	248	struct snd_ctl_elem_value *ucontrol);
	249	int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
	250	struct snd_ctl_elem_value *ucontrol);
	251	int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
	252	struct snd_ctl_elem_info *uinfo);
	253	int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
	254	struct snd_ctl_elem_value *ucontrol);
	255	int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
	256	struct snd_ctl_elem_value *ucontrol);
e13ac2e9 MB	257	int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
	258	struct snd_ctl_elem_info *uinfo);
	259	int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
	260	struct snd_ctl_elem_value *ucontrol);
	261	int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
	262	struct snd_ctl_elem_value *ucontrol);
808db4a4	263
8a2cd618 MB	264	/**
	265	* struct snd_soc_jack_pin - Describes a pin to update based on jack detection
	266	*
	267	* @pin: name of the pin to update
	268	* @mask: bits to check for in reported jack status
	269	* @invert: if non-zero then pin is enabled when status is not reported
	270	*/
	271	struct snd_soc_jack_pin {
	272	struct list_head list;
	273	const char *pin;
	274	int mask;
	275	bool invert;
	276	};
	277
ec67624d LCM	278	/**
	279	* struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
	280	*
	281	* @gpio: gpio number
	282	* @name: gpio name
	283	* @report: value to report when jack detected
	284	* @invert: report presence in low state
	285	* @debouce_time: debouce time in ms
	286	*/
	287	#ifdef CONFIG_GPIOLIB
	288	struct snd_soc_jack_gpio {
	289	unsigned int gpio;
	290	const char *name;
	291	int report;
	292	int invert;
	293	int debounce_time;
	294	struct snd_soc_jack *jack;
	295	struct work_struct work;
	296	};
	297	#endif
	298
8a2cd618 MB	299	struct snd_soc_jack {
	300	struct snd_jack *jack;
	301	struct snd_soc_card *card;
	302	struct list_head pins;
	303	int status;
	304	};
	305
808db4a4 RP	306	/* SoC PCM stream information */
	307	struct snd_soc_pcm_stream {
	308	char *stream_name;
1c433fbd GG	309	u64 formats; /* SNDRV_PCM_FMTBIT_* */
1c433fbd GG	310	unsigned int rates; /* SNDRV_PCM_RATE_* */
808db4a4 RP	311	unsigned int rate_min; /* min rate */
	312	unsigned int rate_max; /* max rate */
	313	unsigned int channels_min; /* min channels */
	314	unsigned int channels_max; /* max channels */
	315	unsigned int active:1; /* stream is in use */
	316	};
	317
	318	/* SoC audio ops */
	319	struct snd_soc_ops {
	320	int (startup)(struct snd_pcm_substream );
	321	void (shutdown)(struct snd_pcm_substream );
	322	int (hw_params)(struct snd_pcm_substream , struct snd_pcm_hw_params *);
	323	int (hw_free)(struct snd_pcm_substream );
	324	int (prepare)(struct snd_pcm_substream );
	325	int (trigger)(struct snd_pcm_substream , int);
	326	};
	327
808db4a4 RP	328	/* SoC Audio Codec */
	329	struct snd_soc_codec {
	330	char *name;
	331	struct module *owner;
	332	struct mutex mutex;
0d0cf00a MB	333	struct device *dev;
	334
	335	struct list_head list;
808db4a4 RP	336
808db4a4 RP	337	/* callbacks */
0be9898a MB	338	int (set_bias_level)(struct snd_soc_codec ,
0be9898a MB	339	enum snd_soc_bias_level level);
808db4a4 RP	340
	341	/* runtime */
	342	struct snd_card *card;
	343	struct snd_ac97 ac97; / for ad-hoc ac97 devices */
	344	unsigned int active;
	345	unsigned int pcm_devs;
	346	void *private_data;
	347
	348	/* codec IO */
	349	void control_data; / codec control (i2c/3wire) data */
	350	unsigned int (read)(struct snd_soc_codec , unsigned int);
	351	int (write)(struct snd_soc_codec , unsigned int, unsigned int);
58cd33c0 MB	352	int (display_register)(struct snd_soc_codec , char *,
58cd33c0 MB	353	size_t, unsigned int);
808db4a4 RP	354	hw_write_t hw_write;
	355	hw_read_t hw_read;
	356	void *reg_cache;
	357	short reg_cache_size;
	358	short reg_cache_step;
	359
	360	/* dapm */
12ef193d	361	u32 pop_time;
808db4a4 RP	362	struct list_head dapm_widgets;
808db4a4 RP	363	struct list_head dapm_paths;
0be9898a MB	364	enum snd_soc_bias_level bias_level;
0be9898a MB	365	enum snd_soc_bias_level suspend_bias_level;
1321b160	366	struct delayed_work delayed_work;
808db4a4 RP	367
808db4a4 RP	368	/* codec DAI's */
3c4b266f	369	struct snd_soc_dai *dai;
808db4a4	370	unsigned int num_dai;
384c89e2 MB	371
	372	#ifdef CONFIG_DEBUG_FS
	373	struct dentry *debugfs_reg;
	374	struct dentry *debugfs_pop_time;
	375	#endif
808db4a4 RP	376	};
	377
	378	/* codec device */
	379	struct snd_soc_codec_device {
	380	int (probe)(struct platform_device pdev);
	381	int (remove)(struct platform_device pdev);
	382	int (suspend)(struct platform_device pdev, pm_message_t state);
	383	int (resume)(struct platform_device pdev);
	384	};
	385
	386	/* SoC platform interface */
	387	struct snd_soc_platform {
	388	char *name;
12a48a8c	389	struct list_head list;
808db4a4 RP	390
	391	int (probe)(struct platform_device pdev);
	392	int (remove)(struct platform_device pdev);
07c84d04 MB	393	int (suspend)(struct snd_soc_dai dai);
07c84d04 MB	394	int (resume)(struct snd_soc_dai dai);
808db4a4 RP	395
808db4a4 RP	396	/* pcm creation and destruction */
3c4b266f	397	int (pcm_new)(struct snd_card , struct snd_soc_dai *,
808db4a4 RP	398	struct snd_pcm *);
	399	void (pcm_free)(struct snd_pcm );
	400
	401	/* platform stream ops */
	402	struct snd_pcm_ops *pcm_ops;
	403	};
	404
	405	/* SoC machine DAI configuration, glues a codec and cpu DAI together */
	406	struct snd_soc_dai_link {
	407	char name; / Codec name */
	408	char stream_name; / Stream name */
	409
	410	/* DAI */
3c4b266f LG	411	struct snd_soc_dai *codec_dai;
3c4b266f LG	412	struct snd_soc_dai *cpu_dai;
1c433fbd GG	413
	414	/* machine stream operations */
	415	struct snd_soc_ops *ops;
808db4a4 RP	416
	417	/* codec/machine specific init - e.g. add machine controls */
	418	int (init)(struct snd_soc_codec codec);
4ccab3e7	419
06f409d7 MB	420	/* Symmetry requirements */
	421	unsigned int symmetric_rates:1;
	422
	423	/* Symmetry data - only valid if symmetry is being enforced */
	424	unsigned int rate;
	425
4ccab3e7 LG	426	/* DAI pcm */
4ccab3e7 LG	427	struct snd_pcm *pcm;
808db4a4 RP	428	};
808db4a4 RP	429
87506549 MB	430	/* SoC card */
87506549 MB	431	struct snd_soc_card {
808db4a4	432	char *name;
c5af3a2e MB	433	struct device *dev;
	434
	435	struct list_head list;
	436
	437	int instantiated;
808db4a4 RP	438
	439	int (probe)(struct platform_device pdev);
	440	int (remove)(struct platform_device pdev);
	441
	442	/* the pre and post PM functions are used to do any PM work before and
	443	* after the codec and DAI's do any PM work. */
	444	int (suspend_pre)(struct platform_device pdev, pm_message_t state);
	445	int (suspend_post)(struct platform_device pdev, pm_message_t state);
	446	int (resume_pre)(struct platform_device pdev);
	447	int (resume_post)(struct platform_device pdev);
	448
0b4d221b	449	/* callbacks */
87506549	450	int (set_bias_level)(struct snd_soc_card ,
0be9898a	451	enum snd_soc_bias_level level);
0b4d221b	452
808db4a4 RP	453	/* CPU <--> Codec DAI links */
	454	struct snd_soc_dai_link *dai_link;
	455	int num_links;
6308419a MB	456
	457	struct snd_soc_device *socdev;
	458
6627a653 MB	459	struct snd_soc_codec *codec;
6627a653 MB	460
87689d56	461	struct snd_soc_platform *platform;
6308419a MB	462	struct delayed_work delayed_work;
6308419a MB	463	struct work_struct deferred_resume_work;
808db4a4 RP	464	};
	465
	466	/* SoC Device - the audio subsystem */
	467	struct snd_soc_device {
	468	struct device *dev;
87506549	469	struct snd_soc_card *card;
808db4a4 RP	470	struct snd_soc_codec_device *codec_dev;
	471	void *codec_data;
	472	};
	473
	474	/* runtime channel data */
	475	struct snd_soc_pcm_runtime {
1c433fbd	476	struct snd_soc_dai_link *dai;
808db4a4 RP	477	struct snd_soc_device *socdev;
	478	};
	479
4eaa9819 JS	480	/* mixer control */
	481	struct soc_mixer_control {
	482	int min, max;
815ecf8d	483	unsigned int reg, rreg, shift, rshift, invert;
4eaa9819 JS	484	};
4eaa9819 JS	485
808db4a4 RP	486	/* enumerated kcontrol */
808db4a4 RP	487	struct soc_enum {
2e72f8e3 PU	488	unsigned short reg;
	489	unsigned short reg2;
	490	unsigned char shift_l;
	491	unsigned char shift_r;
	492	unsigned int max;
	493	unsigned int mask;
	494	const char **texts;
	495	const unsigned int *values;
	496	void *dapm;
	497	};
	498
a47cbe72 MB	499	#include <sound/soc-dai.h>
a47cbe72 MB	500
808db4a4	501	#endif