text: /*
   * 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/notifier.h>
  #include <linux/workqueue.h>
  #include <linux/interrupt.h>
  #include <linux/kernel.h>
  #include <linux/regmap.h>
  #include <sound/core.h>
  #include <sound/pcm.h>
  #include <sound/control.h>
  #include <sound/ac97_codec.h>
  
  /*
   * Convenience kcontrol builders
   */
  #define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert) \
  	((unsigned long)&(struct soc_mixer_control) \
  	{.reg = xreg, .rreg = xreg, .shift = shift_left, \
  	.rshift = shift_right, .max = xmax, .platform_max = xmax, \
  	.invert = xinvert})
  #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
  	SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert)
  #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
  	((unsigned long)&(struct soc_mixer_control) \
  	{.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
  #define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
  	((unsigned long)&(struct soc_mixer_control) \
  	{.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  	.max = xmax, .platform_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, reg, shift_left, shift_right, 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_DOUBLE_VALUE(reg, shift_left, shift_right, \
  					  max, invert) }
  #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, \
  	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
  	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
  					    xmax, xinvert) }
  #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, 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_DOUBLE_VALUE(reg, shift_left, shift_right, \
  					  max, invert) }
  #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, \
  	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
  	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
  					    xmax, 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, \
  		 .platform_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_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
  	 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_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert) }
  #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_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, 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_DOUBLE_VALUE(xreg, shift_left, shift_right, \
  					  xmax, xinvert) }
  #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, 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_DOUBLE_R_VALUE(reg_left, reg_right, 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 }
  
  #define SOC_DOUBLE_R_SX_TLV(xname, xreg_left, xreg_right, xshift,\
  		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_2r_sx, \
  	.get = snd_soc_get_volsw_2r_sx, \
  	.put = snd_soc_put_volsw_2r_sx, \
  	.private_value = (unsigned long)&(struct soc_mixer_control) \
  		{.reg = xreg_left, \
  		 .rreg = xreg_right, .shift = xshift, \
  		 .min = xmin, .max = xmax} }
  
  #define SND_SOC_BYTES(xname, xbase, xregs)		      \
  {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
  	.info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
  	.put = snd_soc_bytes_put, .private_value =	      \
  		((unsigned long)&(struct soc_bytes)           \
  		{.base = xbase, .num_regs = xregs }) }
  
  #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask)	      \
  {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
  	.info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
  	.put = snd_soc_bytes_put, .private_value =	      \
  		((unsigned long)&(struct soc_bytes)           \
  		{.base = xbase, .num_regs = xregs,	      \
  		 .mask = xmask }) }
  
  /*
   * Simplified versions of above macros, declaring a struct and calculating
   * ARRAY_SIZE internally
   */
  #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
  	struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
  						ARRAY_SIZE(xtexts), xtexts)
  #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
  	SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
  #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
  	struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
  #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
  	struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
  							ARRAY_SIZE(xtexts), xtexts, xvalues)
  #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
  	SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
  
  /*
   * Component probe and remove ordering levels for components with runtime
   * dependencies.
   */
  #define SND_SOC_COMP_ORDER_FIRST		-2
  #define SND_SOC_COMP_ORDER_EARLY		-1
  #define SND_SOC_COMP_ORDER_NORMAL		0
  #define SND_SOC_COMP_ORDER_LATE		1
  #define SND_SOC_COMP_ORDER_LAST		2
  
  /*
   * 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_OFF = 0,
  	SND_SOC_BIAS_STANDBY = 1,
  	SND_SOC_BIAS_PREPARE = 2,
  	SND_SOC_BIAS_ON = 3,
  };
  
  struct device_node;
  struct snd_jack;
  struct snd_soc_card;
  struct snd_soc_pcm_stream;
  struct snd_soc_ops;
  struct snd_soc_pcm_runtime;
  struct snd_soc_dai;
  struct snd_soc_dai_driver;
  struct snd_soc_platform;
  struct snd_soc_dai_link;
  struct snd_soc_platform_driver;
  struct snd_soc_codec;
  struct snd_soc_codec_driver;
  struct soc_enum;
  struct snd_soc_jack;
  struct snd_soc_jack_zone;
  struct snd_soc_jack_pin;
  struct snd_soc_cache_ops;
  #include <sound/soc-dapm.h>
  
  #ifdef CONFIG_GPIOLIB
  struct snd_soc_jack_gpio;
  #endif
  
  typedef int (*hw_write_t)(void *,const char* ,int);
  
  extern struct snd_ac97_bus_ops soc_ac97_ops;
  
  enum snd_soc_control_type {
  	SND_SOC_I2C = 1,
  	SND_SOC_SPI,
  	SND_SOC_REGMAP,
  };
  
  enum snd_soc_compress_type {
  	SND_SOC_FLAT_COMPRESSION = 1,
  };
  
  enum snd_soc_pcm_subclass {
  	SND_SOC_PCM_CLASS_PCM	= 0,
  	SND_SOC_PCM_CLASS_BE	= 1,
  };
  
  enum snd_soc_card_subclass {
  	SND_SOC_CARD_CLASS_INIT	= 0,
  	SND_SOC_CARD_CLASS_PCM	= 1,
  };
  
  int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
  			     int source, unsigned int freq, int dir);
  int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
  			  unsigned int freq_in, unsigned int freq_out);
  
  int snd_soc_register_card(struct snd_soc_card *card);
  int snd_soc_unregister_card(struct snd_soc_card *card);
  int snd_soc_suspend(struct device *dev);
  int snd_soc_resume(struct device *dev);
  int snd_soc_poweroff(struct device *dev);
  int snd_soc_register_platform(struct device *dev,
  		struct snd_soc_platform_driver *platform_drv);
  void snd_soc_unregister_platform(struct device *dev);
  int snd_soc_register_codec(struct device *dev,
  		const struct snd_soc_codec_driver *codec_drv,
  		struct snd_soc_dai_driver *dai_drv, int num_dai);
  void snd_soc_unregister_codec(struct device *dev);
  int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
  				    unsigned int reg);
  int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
  				    unsigned int reg);
  int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
  				    unsigned int reg);
  int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
  			       int addr_bits, int data_bits,
  			       enum snd_soc_control_type control);
  int snd_soc_cache_sync(struct snd_soc_codec *codec);
  int snd_soc_cache_init(struct snd_soc_codec *codec);
  int snd_soc_cache_exit(struct snd_soc_codec *codec);
  int snd_soc_cache_write(struct snd_soc_codec *codec,
  			unsigned int reg, unsigned int value);
  int snd_soc_cache_read(struct snd_soc_codec *codec,
  		       unsigned int reg, unsigned int *value);
  int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
  				      unsigned int reg);
  int snd_soc_default_readable_register(struct snd_soc_codec *codec,
  				      unsigned int reg);
  int snd_soc_default_writable_register(struct snd_soc_codec *codec,
  				      unsigned int reg);
  int snd_soc_platform_read(struct snd_soc_platform *platform,
  					unsigned int reg);
  int snd_soc_platform_write(struct snd_soc_platform *platform,
  					unsigned int reg, unsigned int val);
  int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
  
  /* Utility functions to get clock rates from various things */
  int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
  int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
  int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
  int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
  
  /* 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_codec *codec, 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);
  void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
  				    struct notifier_block *nb);
  void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
  				      struct notifier_block *nb);
  int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
  			  struct snd_soc_jack_zone *zones);
  int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
  #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 register bit access */
  int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
  				unsigned int mask, unsigned int value);
  int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
  			       unsigned short reg, unsigned int mask,
  			       unsigned int value);
  int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
  				unsigned int mask, unsigned int 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, const char *long_name,
  				  const char *prefix);
  int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
  	const struct snd_kcontrol_new *controls, int num_controls);
  int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
  	const struct snd_kcontrol_new *controls, int num_controls);
  int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
  	const struct snd_kcontrol_new *controls, int num_controls);
  int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
  	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);
  #define snd_soc_get_volsw_2r snd_soc_get_volsw
  #define snd_soc_put_volsw_2r snd_soc_put_volsw
  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);
  int snd_soc_limit_volume(struct snd_soc_codec *codec,
  	const char *name, int max);
  int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol,
  	struct snd_ctl_elem_info *uinfo);
  int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol,
  	struct snd_ctl_elem_value *ucontrol);
  int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol,
  	struct snd_ctl_elem_value *ucontrol);
  int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
  		       struct snd_ctl_elem_info *uinfo);
  int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
  		      struct snd_ctl_elem_value *ucontrol);
  int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
  		      struct snd_ctl_elem_value *ucontrol);
  
  
  /**
   * struct snd_soc_reg_access - Describes whether a given register is
   * readable, writable or volatile.
   *
   * @reg: the register number
   * @read: whether this register is readable
   * @write: whether this register is writable
   * @vol: whether this register is volatile
   */
  struct snd_soc_reg_access {
  	u16 reg;
  	u16 read;
  	u16 write;
  	u16 vol;
  };
  
  /**
   * 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_zone - Describes voltage zones of jack detection
   *
   * @min_mv: start voltage in mv
   * @max_mv: end voltage in mv
   * @jack_type: type of jack that is expected for this voltage
   * @debounce_time: debounce_time for jack, codec driver should wait for this
   *		duration before reading the adc for voltages
   * @:list: list container
   */
  struct snd_soc_jack_zone {
  	unsigned int min_mv;
  	unsigned int max_mv;
  	unsigned int jack_type;
  	unsigned int debounce_time;
  	struct list_head list;
  };
  
  /**
   * 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
   * @wake:	  enable as wake source
   * @jack_status_check: callback function which overrides the detection
   *		       to provide more complex checks (eg, reading an
   *		       ADC).
   */
  #ifdef CONFIG_GPIOLIB
  struct snd_soc_jack_gpio {
  	unsigned int gpio;
  	const char *name;
  	int report;
  	int invert;
  	int debounce_time;
  	bool wake;
  
  	struct snd_soc_jack *jack;
  	struct delayed_work work;
  
  	int (*jack_status_check)(void);
  };
  #endif
  
  struct snd_soc_jack {
  	struct snd_jack *jack;
  	struct snd_soc_codec *codec;
  	struct list_head pins;
  	int status;
  	struct blocking_notifier_head notifier;
  	struct list_head jack_zones;
  };
  
  /* SoC PCM stream information */
  struct snd_soc_pcm_stream {
  	const 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 sig_bits;		/* number of bits of content */
  };
  
  /* 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 cache ops */
  struct snd_soc_cache_ops {
  	const char *name;
  	enum snd_soc_compress_type id;
  	int (*init)(struct snd_soc_codec *codec);
  	int (*exit)(struct snd_soc_codec *codec);
  	int (*read)(struct snd_soc_codec *codec, unsigned int reg,
  		unsigned int *value);
  	int (*write)(struct snd_soc_codec *codec, unsigned int reg,
  		unsigned int value);
  	int (*sync)(struct snd_soc_codec *codec);
  };
  
  /* SoC Audio Codec device */
  struct snd_soc_codec {
  	const char *name;
  	const char *name_prefix;
  	int id;
  	struct device *dev;
  	const struct snd_soc_codec_driver *driver;
  
  	struct mutex mutex;
  	struct snd_soc_card *card;
  	struct list_head list;
  	struct list_head card_list;
  	int num_dai;
  	enum snd_soc_compress_type compress_type;
  	size_t reg_size;	/* reg_cache_size * reg_word_size */
  	int (*volatile_register)(struct snd_soc_codec *, unsigned int);
  	int (*readable_register)(struct snd_soc_codec *, unsigned int);
  	int (*writable_register)(struct snd_soc_codec *, unsigned int);
  
  	/* runtime */
  	struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
  	unsigned int active;
  	unsigned int cache_bypass:1; /* Suppress access to the cache */
  	unsigned int suspended:1; /* Codec is in suspend PM state */
  	unsigned int probed:1; /* Codec has been probed */
  	unsigned int ac97_registered:1; /* Codec has been AC97 registered */
  	unsigned int ac97_created:1; /* Codec has been created by SoC */
  	unsigned int sysfs_registered:1; /* codec has been sysfs registered */
  	unsigned int cache_init:1; /* codec cache has been initialized */
  	unsigned int using_regmap:1; /* using regmap access */
  	u32 cache_only;  /* Suppress writes to hardware */
  	u32 cache_sync; /* Cache needs to be synced to hardware */
  
  	/* codec IO */
  	void *control_data; /* codec control (i2c/3wire) data */
  	enum snd_soc_control_type control_type;
  	hw_write_t hw_write;
  	unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
  	unsigned int (*read)(struct snd_soc_codec *, unsigned int);
  	int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
  	int (*bulk_write_raw)(struct snd_soc_codec *, unsigned int, const void *, size_t);
  	void *reg_cache;
  	const void *reg_def_copy;
  	const struct snd_soc_cache_ops *cache_ops;
  	struct mutex cache_rw_mutex;
  	int val_bytes;
  
  	/* dapm */
  	struct snd_soc_dapm_context dapm;
  	unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
  
  #ifdef CONFIG_DEBUG_FS
  	struct dentry *debugfs_codec_root;
  	struct dentry *debugfs_reg;
  	struct dentry *debugfs_dapm;
  #endif
  };
  
  /* codec driver */
  struct snd_soc_codec_driver {
  
  	/* driver ops */
  	int (*probe)(struct snd_soc_codec *);
  	int (*remove)(struct snd_soc_codec *);
  	int (*suspend)(struct snd_soc_codec *);
  	int (*resume)(struct snd_soc_codec *);
  
  	/* Default control and setup, added after probe() is run */
  	const struct snd_kcontrol_new *controls;
  	int num_controls;
  	const struct snd_soc_dapm_widget *dapm_widgets;
  	int num_dapm_widgets;
  	const struct snd_soc_dapm_route *dapm_routes;
  	int num_dapm_routes;
  
  	/* codec wide operations */
  	int (*set_sysclk)(struct snd_soc_codec *codec,
  			  int clk_id, int source, unsigned int freq, int dir);
  	int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
  		unsigned int freq_in, unsigned int freq_out);
  
  	/* codec IO */
  	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);
  	int (*volatile_register)(struct snd_soc_codec *, unsigned int);
  	int (*readable_register)(struct snd_soc_codec *, unsigned int);
  	int (*writable_register)(struct snd_soc_codec *, unsigned int);
  	unsigned int reg_cache_size;
  	short reg_cache_step;
  	short reg_word_size;
  	const void *reg_cache_default;
  	short reg_access_size;
  	const struct snd_soc_reg_access *reg_access_default;
  	enum snd_soc_compress_type compress_type;
  
  	/* codec bias level */
  	int (*set_bias_level)(struct snd_soc_codec *,
  			      enum snd_soc_bias_level level);
  	bool idle_bias_off;
  
  	void (*seq_notifier)(struct snd_soc_dapm_context *,
  			     enum snd_soc_dapm_type, int);
  
  	/* codec stream completion event */
  	int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
  
  	bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */
  
  	/* probe ordering - for components with runtime dependencies */
  	int probe_order;
  	int remove_order;
  };
  
  /* SoC platform interface */
  struct snd_soc_platform_driver {
  
  	int (*probe)(struct snd_soc_platform *);
  	int (*remove)(struct snd_soc_platform *);
  	int (*suspend)(struct snd_soc_dai *dai);
  	int (*resume)(struct snd_soc_dai *dai);
  
  	/* pcm creation and destruction */
  	int (*pcm_new)(struct snd_soc_pcm_runtime *);
  	void (*pcm_free)(struct snd_pcm *);
  
  	/* Default control and setup, added after probe() is run */
  	const struct snd_kcontrol_new *controls;
  	int num_controls;
  	const struct snd_soc_dapm_widget *dapm_widgets;
  	int num_dapm_widgets;
  	const struct snd_soc_dapm_route *dapm_routes;
  	int num_dapm_routes;
  
  	/*
  	 * For platform caused delay reporting.
  	 * Optional.
  	 */
  	snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
  		struct snd_soc_dai *);
  
  	/* platform stream ops */
  	struct snd_pcm_ops *ops;
  
  	/* platform stream completion event */
  	int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
  
  	/* probe ordering - for components with runtime dependencies */
  	int probe_order;
  	int remove_order;
  
  	/* platform IO - used for platform DAPM */
  	unsigned int (*read)(struct snd_soc_platform *, unsigned int);
  	int (*write)(struct snd_soc_platform *, unsigned int, unsigned int);
  };
  
  struct snd_soc_platform {
  	const char *name;
  	int id;
  	struct device *dev;
  	struct snd_soc_platform_driver *driver;
  	struct mutex mutex;
  
  	unsigned int suspended:1; /* platform is suspended */
  	unsigned int probed:1;
  
  	struct snd_soc_card *card;
  	struct list_head list;
  	struct list_head card_list;
  
  	struct snd_soc_dapm_context dapm;
  
  #ifdef CONFIG_DEBUG_FS
  	struct dentry *debugfs_platform_root;
  	struct dentry *debugfs_dapm;
  #endif
  };
  
  struct snd_soc_dai_link {
  	/* config - must be set by machine driver */
  	const char *name;			/* Codec name */
  	const char *stream_name;		/* Stream name */
  	const char *codec_name;		/* for multi-codec */
  	const struct device_node *codec_of_node;
  	const char *platform_name;	/* for multi-platform */
  	const struct device_node *platform_of_node;
  	const char *cpu_dai_name;
  	const struct device_node *cpu_dai_of_node;
  	const char *codec_dai_name;
  
  	unsigned int dai_fmt;           /* format to set on init */
  
  	/* Keep DAI active over suspend */
  	unsigned int ignore_suspend:1;
  
  	/* Symmetry requirements */
  	unsigned int symmetric_rates:1;
  
  	/* pmdown_time is ignored at stop */
  	unsigned int ignore_pmdown_time:1;
  
  	/* codec/machine specific init - e.g. add machine controls */
  	int (*init)(struct snd_soc_pcm_runtime *rtd);
  
  	/* machine stream operations */
  	struct snd_soc_ops *ops;
  };
  
  struct snd_soc_codec_conf {
  	const char *dev_name;
  
  	/*
  	 * optional map of kcontrol, widget and path name prefixes that are
  	 * associated per device
  	 */
  	const char *name_prefix;
  
  	/*
  	 * set this to the desired compression type if you want to
  	 * override the one supplied in codec->driver->compress_type
  	 */
  	enum snd_soc_compress_type compress_type;
  };
  
  struct snd_soc_aux_dev {
  	const char *name;		/* Codec name */
  	const char *codec_name;		/* for multi-codec */
  
  	/* codec/machine specific init - e.g. add machine controls */
  	int (*init)(struct snd_soc_dapm_context *dapm);
  };
  
  /* SoC card */
  struct snd_soc_card {
  	const char *name;
  	const char *long_name;
  	const char *driver_name;
  	struct device *dev;
  	struct snd_card *snd_card;
  	struct module *owner;
  
  	struct list_head list;
  	struct mutex mutex;
  	struct mutex dapm_mutex;
  
  	bool instantiated;
  
  	int (*probe)(struct snd_soc_card *card);
  	int (*late_probe)(struct snd_soc_card *card);
  	int (*remove)(struct snd_soc_card *card);
  
  	/* 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 snd_soc_card *card);
  	int (*suspend_post)(struct snd_soc_card *card);
  	int (*resume_pre)(struct snd_soc_card *card);
  	int (*resume_post)(struct snd_soc_card *card);
  
  	/* callbacks */
  	int (*set_bias_level)(struct snd_soc_card *,
  			      struct snd_soc_dapm_context *dapm,
  			      enum snd_soc_bias_level level);
  	int (*set_bias_level_post)(struct snd_soc_card *,
  				   struct snd_soc_dapm_context *dapm,
  				   enum snd_soc_bias_level level);
  
  	long pmdown_time;
  
  	/* CPU <--> Codec DAI links  */
  	struct snd_soc_dai_link *dai_link;
  	int num_links;
  	struct snd_soc_pcm_runtime *rtd;
  	int num_rtd;
  
  	/* optional codec specific configuration */
  	struct snd_soc_codec_conf *codec_conf;
  	int num_configs;
  
  	/*
  	 * optional auxiliary devices such as amplifiers or codecs with DAI
  	 * link unused
  	 */
  	struct snd_soc_aux_dev *aux_dev;
  	int num_aux_devs;
  	struct snd_soc_pcm_runtime *rtd_aux;
  	int num_aux_rtd;
  
  	const struct snd_kcontrol_new *controls;
  	int num_controls;
  
  	/*
  	 * Card-specific routes and widgets.
  	 */
  	const struct snd_soc_dapm_widget *dapm_widgets;
  	int num_dapm_widgets;
  	const struct snd_soc_dapm_route *dapm_routes;
  	int num_dapm_routes;
  	bool fully_routed;
  
  	struct work_struct deferred_resume_work;
  
  	/* lists of probed devices belonging to this card */
  	struct list_head codec_dev_list;
  	struct list_head platform_dev_list;
  	struct list_head dai_dev_list;
  
  	struct list_head widgets;
  	struct list_head paths;
  	struct list_head dapm_list;
  	struct list_head dapm_dirty;
  
  	/* Generic DAPM context for the card */
  	struct snd_soc_dapm_context dapm;
  	struct snd_soc_dapm_stats dapm_stats;
  
  #ifdef CONFIG_DEBUG_FS
  	struct dentry *debugfs_card_root;
  	struct dentry *debugfs_pop_time;
  #endif
  	u32 pop_time;
  
  	void *drvdata;
  };
  
  /* SoC machine DAI configuration, glues a codec and cpu DAI together */
  struct snd_soc_pcm_runtime {
  	struct device *dev;
  	struct snd_soc_card *card;
  	struct snd_soc_dai_link *dai_link;
  	struct mutex pcm_mutex;
  	enum snd_soc_pcm_subclass pcm_subclass;
  	struct snd_pcm_ops ops;
  
  	unsigned int complete:1;
  	unsigned int dev_registered:1;
  
  	long pmdown_time;
  
  	/* runtime devices */
  	struct snd_pcm *pcm;
  	struct snd_soc_codec *codec;
  	struct snd_soc_platform *platform;
  	struct snd_soc_dai *codec_dai;
  	struct snd_soc_dai *cpu_dai;
  
  	struct delayed_work delayed_work;
  };
  
  /* mixer control */
  struct soc_mixer_control {
  	int min, max, platform_max;
  	unsigned int reg, rreg, shift, rshift, invert;
  };
  
  struct soc_bytes {
  	int base;
  	int num_regs;
  	u32 mask;
  };
  
  /* 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 * const *texts;
  	const unsigned int *values;
  	void *dapm;
  };
  
  /* codec IO */
  unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
  unsigned int snd_soc_write(struct snd_soc_codec *codec,
  			   unsigned int reg, unsigned int val);
  unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
  				    unsigned int reg, const void *data, size_t len);
  
  /* device driver data */
  
  static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
  		void *data)
  {
  	card->drvdata = data;
  }
  
  static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
  {
  	return card->drvdata;
  }
  
  static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
  		void *data)
  {
  	dev_set_drvdata(codec->dev, data);
  }
  
  static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
  {
  	return dev_get_drvdata(codec->dev);
  }
  
  static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
  		void *data)
  {
  	dev_set_drvdata(platform->dev, data);
  }
  
  static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
  {
  	return dev_get_drvdata(platform->dev);
  }
  
  static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
  		void *data)
  {
  	dev_set_drvdata(rtd->dev, data);
  }
  
  static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
  {
  	return dev_get_drvdata(rtd->dev);
  }
  
  static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
  {
  	INIT_LIST_HEAD(&card->dai_dev_list);
  	INIT_LIST_HEAD(&card->codec_dev_list);
  	INIT_LIST_HEAD(&card->platform_dev_list);
  	INIT_LIST_HEAD(&card->widgets);
  	INIT_LIST_HEAD(&card->paths);
  	INIT_LIST_HEAD(&card->dapm_list);
  }
  
  static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
  {
  	if (mc->reg == mc->rreg && mc->shift == mc->rshift)
  		return 0;
  	/*
  	 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
  	 * mc->reg != mc->rreg means that the control is
  	 * stereo (bits in one register or in two registers)
  	 */
  	return 1;
  }
  
  int snd_soc_util_init(void);
  void snd_soc_util_exit(void);
  
  int snd_soc_of_parse_card_name(struct snd_soc_card *card,
  			       const char *propname);
  int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
  				   const char *propname);
  
  #include <sound/soc-dai.h>
  
  #ifdef CONFIG_DEBUG_FS
  extern struct dentry *snd_soc_debugfs_root;
  #endif
  
  extern const struct dev_pm_ops snd_soc_pm_ops;
  
  #endif
  