include/sound/soc.h

   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>
  18 #include <linux/notifier.h>
  19 #include <linux/workqueue.h>
  20 #include <linux/interrupt.h>
  21 #include <linux/kernel.h>
  22 #include <sound/core.h>
  23 #include <sound/pcm.h>
  24 #include <sound/control.h>
  25 #include <sound/ac97_codec.h>
  26
  27 /*
  28  * Convenience kcontrol builders
  29  */
  30 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
  31         ((unsigned long)&(struct soc_mixer_control) \
  32         {.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \
  33         .platform_max = xmax, .invert = xinvert})
  34 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
  35         ((unsigned long)&(struct soc_mixer_control) \
  36         {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
  37 #define SOC_SINGLE(xname, reg, shift, max, invert) \
  38 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  39         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  40         .put = snd_soc_put_volsw, \
  41         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
  42 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
  43 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  44         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  45                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  46         .tlv.p = (tlv_array), \
  47         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  48         .put = snd_soc_put_volsw, \
  49         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
  50 #define SOC_DOUBLE(xname, xreg, shift_left, shift_right, xmax, xinvert) \
  51 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  52         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
  53         .put = snd_soc_put_volsw, \
  54         .private_value = (unsigned long)&(struct soc_mixer_control) \
  55                 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
  56                  .max = xmax, .platform_max = xmax, .invert = xinvert} }
  57 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
  58 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
  59         .info = snd_soc_info_volsw_2r, \
  60         .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
  61         .private_value = (unsigned long)&(struct soc_mixer_control) \
  62                 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
  63                 .max = xmax, .platform_max = xmax, .invert = xinvert} }
  64 #define SOC_DOUBLE_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert, tlv_array) \
  65 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  66         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  67                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  68         .tlv.p = (tlv_array), \
  69         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
  70         .put = snd_soc_put_volsw, \
  71         .private_value = (unsigned long)&(struct soc_mixer_control) \
  72                 {.reg = xreg, .shift = shift_left, .rshift = shift_right,\
  73                  .max = xmax, .platform_max = xmax, .invert = xinvert} }
  74 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
  75 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  76         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  77                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  78         .tlv.p = (tlv_array), \
  79         .info = snd_soc_info_volsw_2r, \
  80         .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
  81         .private_value = (unsigned long)&(struct soc_mixer_control) \
  82                 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
  83                 .max = xmax, .platform_max = xmax, .invert = xinvert} }
  84 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
  85 {       .iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
  86         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
  87                   SNDRV_CTL_ELEM_ACCESS_READWRITE, \
  88         .tlv.p  = (tlv_array), \
  89         .info   = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
  90         .put    = snd_soc_put_volsw_s8, \
  91         .private_value = (unsigned long)&(struct soc_mixer_control) \
  92                 {.reg = xreg, .min = xmin, .max = xmax, \
  93                  .platform_max = xmax} }
  94 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
  95 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
  96         .max = xmax, .texts = xtexts }
  97 #define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
  98         SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
  99 #define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
 100 {       .max = xmax, .texts = xtexts }
 101 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
 102 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 103         .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
 104 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
 105         SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
 106 #define SOC_ENUM(xname, xenum) \
 107 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
 108         .info = snd_soc_info_enum_double, \
 109         .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
 110         .private_value = (unsigned long)&xenum }
 111 #define SOC_VALUE_ENUM(xname, xenum) \
 112 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
 113         .info = snd_soc_info_enum_double, \
 114         .get = snd_soc_get_value_enum_double, \
 115         .put = snd_soc_put_value_enum_double, \
 116         .private_value = (unsigned long)&xenum }
 117 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
 118          xhandler_get, xhandler_put) \
 119 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 120         .info = snd_soc_info_volsw, \
 121         .get = xhandler_get, .put = xhandler_put, \
 122         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
 123 #define SOC_DOUBLE_EXT(xname, xreg, shift_left, shift_right, xmax, xinvert,\
 124          xhandler_get, xhandler_put) \
 125 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 126         .info = snd_soc_info_volsw, \
 127         .get = xhandler_get, .put = xhandler_put, \
 128         .private_value = (unsigned long)&(struct soc_mixer_control) \
 129                 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
 130                  .max = xmax, .platform_max = xmax, .invert = xinvert} }
 131 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
 132          xhandler_get, xhandler_put, tlv_array) \
 133 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 134         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 135                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 136         .tlv.p = (tlv_array), \
 137         .info = snd_soc_info_volsw, \
 138         .get = xhandler_get, .put = xhandler_put, \
 139         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
 140 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
 141          xhandler_get, xhandler_put, tlv_array) \
 142 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 143         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 144                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 145         .tlv.p = (tlv_array), \
 146         .info = snd_soc_info_volsw, \
 147         .get = xhandler_get, .put = xhandler_put, \
 148         .private_value = (unsigned long)&(struct soc_mixer_control) \
 149                 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
 150                 .max = xmax, .platform_max = xmax, .invert = xinvert} }
 151 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
 152          xhandler_get, xhandler_put, tlv_array) \
 153 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 154         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 155                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 156         .tlv.p = (tlv_array), \
 157         .info = snd_soc_info_volsw_2r, \
 158         .get = xhandler_get, .put = xhandler_put, \
 159         .private_value = (unsigned long)&(struct soc_mixer_control) \
 160                 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
 161                 .max = xmax, .platform_max = xmax, .invert = xinvert} }
 162 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
 163 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 164         .info = snd_soc_info_bool_ext, \
 165         .get = xhandler_get, .put = xhandler_put, \
 166         .private_value = xdata }
 167 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 168 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 169         .info = snd_soc_info_enum_ext, \
 170         .get = xhandler_get, .put = xhandler_put, \
 171         .private_value = (unsigned long)&xenum }
 172
 173 #define SOC_DOUBLE_R_SX_TLV(xname, xreg_left, xreg_right, xshift,\
 174                 xmin, xmax, tlv_array) \
 175 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 176         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 177                   SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 178         .tlv.p = (tlv_array), \
 179         .info = snd_soc_info_volsw_2r_sx, \
 180         .get = snd_soc_get_volsw_2r_sx, \
 181         .put = snd_soc_put_volsw_2r_sx, \
 182         .private_value = (unsigned long)&(struct soc_mixer_control) \
 183                 {.reg = xreg_left, \
 184                  .rreg = xreg_right, .shift = xshift, \
 185                  .min = xmin, .max = xmax} }
 186
 187
 188 /*
 189  * Simplified versions of above macros, declaring a struct and calculating
 190  * ARRAY_SIZE internally
 191  */
 192 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
 193         struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
 194                                                 ARRAY_SIZE(xtexts), xtexts)
 195 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
 196         SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
 197 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
 198         struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
 199 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
 200         struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
 201                                                         ARRAY_SIZE(xtexts), xtexts, xvalues)
 202 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
 203         SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
 204
 205 /*
 206  * Bias levels
 207  *
 208  * @ON:      Bias is fully on for audio playback and capture operations.
 209  * @PREPARE: Prepare for audio operations. Called before DAPM switching for
 210  *           stream start and stop operations.
 211  * @STANDBY: Low power standby state when no playback/capture operations are
 212  *           in progress. NOTE: The transition time between STANDBY and ON
 213  *           should be as fast as possible and no longer than 10ms.
 214  * @OFF:     Power Off. No restrictions on transition times.
 215  */
 216 enum snd_soc_bias_level {
 217         SND_SOC_BIAS_OFF,
 218         SND_SOC_BIAS_STANDBY,
 219         SND_SOC_BIAS_PREPARE,
 220         SND_SOC_BIAS_ON,
 221 };
 222
 223 struct snd_jack;
 224 struct snd_soc_card;
 225 struct snd_soc_pcm_stream;
 226 struct snd_soc_ops;
 227 struct snd_soc_pcm_runtime;
 228 struct snd_soc_dai;
 229 struct snd_soc_dai_driver;
 230 struct snd_soc_platform;
 231 struct snd_soc_dai_link;
 232 struct snd_soc_platform_driver;
 233 struct snd_soc_codec;
 234 struct snd_soc_codec_driver;
 235 struct soc_enum;
 236 struct snd_soc_jack;
 237 struct snd_soc_jack_zone;
 238 struct snd_soc_jack_pin;
 239 struct snd_soc_cache_ops;
 240 #include <sound/soc-dapm.h>
 241
 242 #ifdef CONFIG_GPIOLIB
 243 struct snd_soc_jack_gpio;
 244 #endif
 245
 246 typedef int (*hw_write_t)(void *,const char* ,int);
 247
 248 extern struct snd_ac97_bus_ops soc_ac97_ops;
 249
 250 enum snd_soc_control_type {
 251         SND_SOC_I2C = 1,
 252         SND_SOC_SPI,
 253 };
 254
 255 enum snd_soc_compress_type {
 256         SND_SOC_FLAT_COMPRESSION = 1,
 257         SND_SOC_LZO_COMPRESSION,
 258         SND_SOC_RBTREE_COMPRESSION
 259 };
 260
 261 #ifdef CONFIG_PHONE_INCALL_IS_SUSPEND
 262 int snd_soc_incall_status(int read_or_write, int status);
 263 #endif
 264
 265
 266 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
 267                              unsigned int freq, int dir);
 268 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
 269                           unsigned int freq_in, unsigned int freq_out);
 270
 271 int snd_soc_register_card(struct snd_soc_card *card);
 272 int snd_soc_unregister_card(struct snd_soc_card *card);
 273 int snd_soc_suspend(struct device *dev);
 274 int snd_soc_resume(struct device *dev);
 275 int snd_soc_poweroff(struct device *dev);
 276 int snd_soc_register_platform(struct device *dev,
 277                 struct snd_soc_platform_driver *platform_drv);
 278 void snd_soc_unregister_platform(struct device *dev);
 279 int snd_soc_register_codec(struct device *dev,
 280                 const struct snd_soc_codec_driver *codec_drv,
 281                 struct snd_soc_dai_driver *dai_drv, int num_dai);
 282 void snd_soc_unregister_codec(struct device *dev);
 283 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
 284                                     unsigned int reg);
 285 int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
 286                                     unsigned int reg);
 287 int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
 288                                     unsigned int reg);
 289 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
 290                                int addr_bits, int data_bits,
 291                                enum snd_soc_control_type control);
 292 int snd_soc_cache_sync(struct snd_soc_codec *codec);
 293 int snd_soc_cache_init(struct snd_soc_codec *codec);
 294 int snd_soc_cache_exit(struct snd_soc_codec *codec);
 295 int snd_soc_cache_write(struct snd_soc_codec *codec,
 296                         unsigned int reg, unsigned int value);
 297 int snd_soc_cache_read(struct snd_soc_codec *codec,
 298                        unsigned int reg, unsigned int *value);
 299 int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
 300                                       unsigned int reg);
 301 int snd_soc_default_readable_register(struct snd_soc_codec *codec,
 302                                       unsigned int reg);
 303 int snd_soc_default_writable_register(struct snd_soc_codec *codec,
 304                                       unsigned int reg);
 305
 306 /* Utility functions to get clock rates from various things */
 307 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 308 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 309 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 310 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 311
 312 /* set runtime hw params */
 313 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 314         const struct snd_pcm_hardware *hw);
 315
 316 /* Jack reporting */
 317 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
 318                      struct snd_soc_jack *jack);
 319 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 320 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 321                           struct snd_soc_jack_pin *pins);
 322 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
 323                                     struct notifier_block *nb);
 324 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
 325                                       struct notifier_block *nb);
 326 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
 327                           struct snd_soc_jack_zone *zones);
 328 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
 329 #ifdef CONFIG_GPIOLIB
 330 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 331                         struct snd_soc_jack_gpio *gpios);
 332 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 333                         struct snd_soc_jack_gpio *gpios);
 334 #endif
 335
 336 /* codec register bit access */
 337 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
 338                                 unsigned int mask, unsigned int value);
 339 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
 340                                unsigned short reg, unsigned int mask,
 341                                unsigned int value);
 342 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
 343                                 unsigned int mask, unsigned int value);
 344
 345 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
 346         struct snd_ac97_bus_ops *ops, int num);
 347 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
 348
 349 /*
 350  *Controls
 351  */
 352 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 353                                   void *data, char *long_name,
 354                                   const char *prefix);
 355 int snd_soc_add_controls(struct snd_soc_codec *codec,
 356         const struct snd_kcontrol_new *controls, int num_controls);
 357 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 358         struct snd_ctl_elem_info *uinfo);
 359 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
 360         struct snd_ctl_elem_info *uinfo);
 361 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 362         struct snd_ctl_elem_value *ucontrol);
 363 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 364         struct snd_ctl_elem_value *ucontrol);
 365 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
 366         struct snd_ctl_elem_value *ucontrol);
 367 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
 368         struct snd_ctl_elem_value *ucontrol);
 369 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 370         struct snd_ctl_elem_info *uinfo);
 371 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
 372         struct snd_ctl_elem_info *uinfo);
 373 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 374 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 375         struct snd_ctl_elem_value *ucontrol);
 376 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 377         struct snd_ctl_elem_value *ucontrol);
 378 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
 379         struct snd_ctl_elem_info *uinfo);
 380 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
 381         struct snd_ctl_elem_value *ucontrol);
 382 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
 383         struct snd_ctl_elem_value *ucontrol);
 384 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
 385         struct snd_ctl_elem_info *uinfo);
 386 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
 387         struct snd_ctl_elem_value *ucontrol);
 388 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
 389         struct snd_ctl_elem_value *ucontrol);
 390 int snd_soc_limit_volume(struct snd_soc_codec *codec,
 391         const char *name, int max);
 392 int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol,
 393         struct snd_ctl_elem_info *uinfo);
 394 int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol,
 395         struct snd_ctl_elem_value *ucontrol);
 396 int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol,
 397         struct snd_ctl_elem_value *ucontrol);
 398
 399 /**
 400  * struct snd_soc_reg_access - Describes whether a given register is
 401  * readable, writable or volatile.
 402  *
 403  * @reg: the register number
 404  * @read: whether this register is readable
 405  * @write: whether this register is writable
 406  * @vol: whether this register is volatile
 407  */
 408 struct snd_soc_reg_access {
 409         u16 reg;
 410         u16 read;
 411         u16 write;
 412         u16 vol;
 413 };
 414
 415 /**
 416  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 417  *
 418  * @pin:    name of the pin to update
 419  * @mask:   bits to check for in reported jack status
 420  * @invert: if non-zero then pin is enabled when status is not reported
 421  */
 422 struct snd_soc_jack_pin {
 423         struct list_head list;
 424         const char *pin;
 425         int mask;
 426         bool invert;
 427 };
 428
 429 /**
 430  * struct snd_soc_jack_zone - Describes voltage zones of jack detection
 431  *
 432  * @min_mv: start voltage in mv
 433  * @max_mv: end voltage in mv
 434  * @jack_type: type of jack that is expected for this voltage
 435  * @debounce_time: debounce_time for jack, codec driver should wait for this
 436  *              duration before reading the adc for voltages
 437  * @:list: list container
 438  */
 439 struct snd_soc_jack_zone {
 440         unsigned int min_mv;
 441         unsigned int max_mv;
 442         unsigned int jack_type;
 443         unsigned int debounce_time;
 444         struct list_head list;
 445 };
 446
 447 /**
 448  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 449  *
 450  * @gpio:         gpio number
 451  * @name:         gpio name
 452  * @report:       value to report when jack detected
 453  * @invert:       report presence in low state
 454  * @debouce_time: debouce time in ms
 455  * @wake:         enable as wake source
 456  * @jack_status_check: callback function which overrides the detection
 457  *                     to provide more complex checks (eg, reading an
 458  *                     ADC).
 459  */
 460 #ifdef CONFIG_GPIOLIB
 461 struct snd_soc_jack_gpio {
 462         unsigned int gpio;
 463         const char *name;
 464         int report;
 465         int invert;
 466         int debounce_time;
 467         bool wake;
 468
 469         struct snd_soc_jack *jack;
 470         struct delayed_work work;
 471
 472         int (*jack_status_check)(void);
 473 };
 474 #endif
 475
 476 struct snd_soc_jack {
 477         struct snd_jack *jack;
 478         struct snd_soc_codec *codec;
 479         struct list_head pins;
 480         int status;
 481         struct blocking_notifier_head notifier;
 482         struct list_head jack_zones;
 483 };
 484
 485 /* SoC PCM stream information */
 486 struct snd_soc_pcm_stream {
 487         const char *stream_name;
 488         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 489         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 490         unsigned int rate_min;          /* min rate */
 491         unsigned int rate_max;          /* max rate */
 492         unsigned int channels_min;      /* min channels */
 493         unsigned int channels_max;      /* max channels */
 494 };
 495
 496 /* SoC audio ops */
 497 struct snd_soc_ops {
 498         int (*startup)(struct snd_pcm_substream *);
 499         void (*shutdown)(struct snd_pcm_substream *);
 500         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 501         int (*hw_free)(struct snd_pcm_substream *);
 502         int (*prepare)(struct snd_pcm_substream *);
 503         int (*trigger)(struct snd_pcm_substream *, int);
 504     /* set volume,add by qiuen*/
 505         void (*set_volume)(unsigned char mode,unsigned char volume);
 506 };
 507
 508 /* SoC cache ops */
 509 struct snd_soc_cache_ops {
 510         const char *name;
 511         enum snd_soc_compress_type id;
 512         int (*init)(struct snd_soc_codec *codec);
 513         int (*exit)(struct snd_soc_codec *codec);
 514         int (*read)(struct snd_soc_codec *codec, unsigned int reg,
 515                 unsigned int *value);
 516         int (*write)(struct snd_soc_codec *codec, unsigned int reg,
 517                 unsigned int value);
 518         int (*sync)(struct snd_soc_codec *codec);
 519 };
 520
 521 /* SoC Audio Codec device */
 522 struct snd_soc_codec {
 523         const char *name;
 524         const char *name_prefix;
 525         int id;
 526         struct device *dev;
 527         const struct snd_soc_codec_driver *driver;
 528
 529         struct mutex mutex;
 530         struct snd_soc_card *card;
 531         struct list_head list;
 532         struct list_head card_list;
 533         int num_dai;
 534         enum snd_soc_compress_type compress_type;
 535         size_t reg_size;        /* reg_cache_size * reg_word_size */
 536         int (*volatile_register)(struct snd_soc_codec *, unsigned int);
 537         int (*readable_register)(struct snd_soc_codec *, unsigned int);
 538         int (*writable_register)(struct snd_soc_codec *, unsigned int);
 539
 540         /* runtime */
 541         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
 542         unsigned int active;
 543         unsigned int cache_bypass:1; /* Suppress access to the cache */
 544         unsigned int suspended:1; /* Codec is in suspend PM state */
 545         unsigned int probed:1; /* Codec has been probed */
 546         unsigned int ac97_registered:1; /* Codec has been AC97 registered */
 547         unsigned int ac97_created:1; /* Codec has been created by SoC */
 548         unsigned int sysfs_registered:1; /* codec has been sysfs registered */
 549         unsigned int cache_init:1; /* codec cache has been initialized */
 550         u32 cache_only;  /* Suppress writes to hardware */
 551         u32 cache_sync; /* Cache needs to be synced to hardware */
 552
 553         /* codec IO */
 554         void *control_data; /* codec control (i2c/3wire) data */
 555         enum snd_soc_control_type control_type;
 556         hw_write_t hw_write;
 557         unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
 558         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 559         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 560         int (*bulk_write_raw)(struct snd_soc_codec *, unsigned int, const void *, size_t);
 561         void *reg_cache;
 562         const void *reg_def_copy;
 563         const struct snd_soc_cache_ops *cache_ops;
 564         struct mutex cache_rw_mutex;
 565
 566         /* dapm */
 567         struct snd_soc_dapm_context dapm;
 568
 569 #ifdef CONFIG_DEBUG_FS
 570         struct dentry *debugfs_codec_root;
 571         struct dentry *debugfs_reg;
 572         struct dentry *debugfs_dapm;
 573 #endif
 574 };
 575
 576 /* codec driver */
 577 struct snd_soc_codec_driver {
 578
 579         /* driver ops */
 580         int (*probe)(struct snd_soc_codec *);
 581         int (*remove)(struct snd_soc_codec *);
 582         int (*suspend)(struct snd_soc_codec *,
 583                         pm_message_t state);
 584         int (*resume)(struct snd_soc_codec *);
 585
 586         /* Default control and setup, added after probe() is run */
 587         const struct snd_kcontrol_new *controls;
 588         int num_controls;
 589         const struct snd_soc_dapm_widget *dapm_widgets;
 590         int num_dapm_widgets;
 591         const struct snd_soc_dapm_route *dapm_routes;
 592         int num_dapm_routes;
 593
 594         /* codec wide operations */
 595         int (*set_sysclk)(struct snd_soc_codec *codec,
 596                           int clk_id, unsigned int freq, int dir);
 597         int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
 598                 unsigned int freq_in, unsigned int freq_out);
 599
 600         /* codec IO */
 601         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 602         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 603         int (*display_register)(struct snd_soc_codec *, char *,
 604                                 size_t, unsigned int);
 605         int (*volatile_register)(struct snd_soc_codec *, unsigned int);
 606         int (*readable_register)(struct snd_soc_codec *, unsigned int);
 607         int (*writable_register)(struct snd_soc_codec *, unsigned int);
 608         short reg_cache_size;
 609         short reg_cache_step;
 610         short reg_word_size;
 611         const void *reg_cache_default;
 612         short reg_access_size;
 613         const struct snd_soc_reg_access *reg_access_default;
 614         enum snd_soc_compress_type compress_type;
 615
 616         /* codec bias level */
 617         int (*set_bias_level)(struct snd_soc_codec *,
 618                               enum snd_soc_bias_level level);
 619
 620         void (*seq_notifier)(struct snd_soc_dapm_context *,
 621                              enum snd_soc_dapm_type, int);
 622 };
 623
 624 /* SoC platform interface */
 625 struct snd_soc_platform_driver {
 626
 627         int (*probe)(struct snd_soc_platform *);
 628         int (*remove)(struct snd_soc_platform *);
 629         int (*suspend)(struct snd_soc_dai *dai);
 630         int (*resume)(struct snd_soc_dai *dai);
 631
 632         /* pcm creation and destruction */
 633         int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
 634                 struct snd_pcm *);
 635         void (*pcm_free)(struct snd_pcm *);
 636
 637         /*
 638          * For platform caused delay reporting.
 639          * Optional.
 640          */
 641         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 642                 struct snd_soc_dai *);
 643
 644         /* platform stream ops */
 645         struct snd_pcm_ops *ops;
 646 };
 647
 648 struct snd_soc_platform {
 649         const char *name;
 650         int id;
 651         struct device *dev;
 652         struct snd_soc_platform_driver *driver;
 653
 654         unsigned int suspended:1; /* platform is suspended */
 655         unsigned int probed:1;
 656
 657         struct snd_soc_card *card;
 658         struct list_head list;
 659         struct list_head card_list;
 660 };
 661
 662 struct snd_soc_dai_link {
 663         /* config - must be set by machine driver */
 664         const char *name;                       /* Codec name */
 665         const char *stream_name;                /* Stream name */
 666         const char *codec_name;         /* for multi-codec */
 667         const char *platform_name;      /* for multi-platform */
 668         const char *cpu_dai_name;
 669         const char *codec_dai_name;
 670
 671         /* Keep DAI active over suspend */
 672         unsigned int ignore_suspend:1;
 673
 674         /* Symmetry requirements */
 675         unsigned int symmetric_rates:1;
 676
 677         /* codec/machine specific init - e.g. add machine controls */
 678         int (*init)(struct snd_soc_pcm_runtime *rtd);
 679
 680         /* machine stream operations */
 681         struct snd_soc_ops *ops;
 682 };
 683
 684 struct snd_soc_codec_conf {
 685         const char *dev_name;
 686
 687         /*
 688          * optional map of kcontrol, widget and path name prefixes that are
 689          * associated per device
 690          */
 691         const char *name_prefix;
 692
 693         /*
 694          * set this to the desired compression type if you want to
 695          * override the one supplied in codec->driver->compress_type
 696          */
 697         enum snd_soc_compress_type compress_type;
 698 };
 699
 700 struct snd_soc_aux_dev {
 701         const char *name;               /* Codec name */
 702         const char *codec_name;         /* for multi-codec */
 703
 704         /* codec/machine specific init - e.g. add machine controls */
 705         int (*init)(struct snd_soc_dapm_context *dapm);
 706 };
 707
 708 /* SoC card */
 709 struct snd_soc_card {
 710         const char *name;
 711         const char *long_name;
 712         const char *driver_name;
 713         struct device *dev;
 714         struct snd_card *snd_card;
 715         struct module *owner;
 716
 717         struct list_head list;
 718         struct mutex mutex;
 719
 720         bool instantiated;
 721
 722         int (*probe)(struct snd_soc_card *card);
 723         int (*late_probe)(struct snd_soc_card *card);
 724         int (*remove)(struct snd_soc_card *card);
 725
 726         /* the pre and post PM functions are used to do any PM work before and
 727          * after the codec and DAI's do any PM work. */
 728         int (*suspend_pre)(struct snd_soc_card *card);
 729         int (*suspend_post)(struct snd_soc_card *card);
 730         int (*resume_pre)(struct snd_soc_card *card);
 731         int (*resume_post)(struct snd_soc_card *card);
 732
 733         /* callbacks */
 734         int (*set_bias_level)(struct snd_soc_card *,
 735                               enum snd_soc_bias_level level);
 736         int (*set_bias_level_post)(struct snd_soc_card *,
 737                                    enum snd_soc_bias_level level);
 738
 739         long pmdown_time;
 740
 741         /* CPU <--> Codec DAI links  */
 742         struct snd_soc_dai_link *dai_link;
 743         int num_links;
 744         struct snd_soc_pcm_runtime *rtd;
 745         int num_rtd;
 746
 747         /* optional codec specific configuration */
 748         struct snd_soc_codec_conf *codec_conf;
 749         int num_configs;
 750
 751         /*
 752          * optional auxiliary devices such as amplifiers or codecs with DAI
 753          * link unused
 754          */
 755         struct snd_soc_aux_dev *aux_dev;
 756         int num_aux_devs;
 757         struct snd_soc_pcm_runtime *rtd_aux;
 758         int num_aux_rtd;
 759
 760         const struct snd_kcontrol_new *controls;
 761         int num_controls;
 762
 763         /*
 764          * Card-specific routes and widgets.
 765          */
 766         const struct snd_soc_dapm_widget *dapm_widgets;
 767         int num_dapm_widgets;
 768         const struct snd_soc_dapm_route *dapm_routes;
 769         int num_dapm_routes;
 770
 771         struct work_struct deferred_resume_work;
 772
 773         /* lists of probed devices belonging to this card */
 774         struct list_head codec_dev_list;
 775         struct list_head platform_dev_list;
 776         struct list_head dai_dev_list;
 777
 778         struct list_head widgets;
 779         struct list_head paths;
 780         struct list_head dapm_list;
 781
 782         /* Generic DAPM context for the card */
 783         struct snd_soc_dapm_context dapm;
 784
 785 #ifdef CONFIG_DEBUG_FS
 786         struct dentry *debugfs_card_root;
 787         struct dentry *debugfs_pop_time;
 788 #endif
 789         u32 pop_time;
 790
 791         void *drvdata;
 792 };
 793
 794 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
 795 struct snd_soc_pcm_runtime  {
 796         struct device dev;
 797         struct snd_soc_card *card;
 798         struct snd_soc_dai_link *dai_link;
 799
 800         unsigned int complete:1;
 801         unsigned int dev_registered:1;
 802
 803         /* Symmetry data - only valid if symmetry is being enforced */
 804         unsigned int rate;
 805         long pmdown_time;
 806
 807         /* runtime devices */
 808         struct snd_pcm *pcm;
 809         struct snd_soc_codec *codec;
 810         struct snd_soc_platform *platform;
 811         struct snd_soc_dai *codec_dai;
 812         struct snd_soc_dai *cpu_dai;
 813
 814         struct delayed_work delayed_work;
 815 };
 816
 817 /* mixer control */
 818 struct soc_mixer_control {
 819         int min, max, platform_max;
 820         unsigned int reg, rreg, shift, rshift, invert;
 821 };
 822
 823 /* enumerated kcontrol */
 824 struct soc_enum {
 825         unsigned short reg;
 826         unsigned short reg2;
 827         unsigned char shift_l;
 828         unsigned char shift_r;
 829         unsigned int max;
 830         unsigned int mask;
 831         const char * const *texts;
 832         const unsigned int *values;
 833         void *dapm;
 834 };
 835
 836 /* codec IO */
 837 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
 838 unsigned int snd_soc_write(struct snd_soc_codec *codec,
 839                            unsigned int reg, unsigned int val);
 840 unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
 841                                     unsigned int reg, const void *data, size_t len);
 842
 843 /* device driver data */
 844
 845 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
 846                 void *data)
 847 {
 848         card->drvdata = data;
 849 }
 850
 851 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
 852 {
 853         return card->drvdata;
 854 }
 855
 856 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
 857                 void *data)
 858 {
 859         dev_set_drvdata(codec->dev, data);
 860 }
 861
 862 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
 863 {
 864         return dev_get_drvdata(codec->dev);
 865 }
 866
 867 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
 868                 void *data)
 869 {
 870         dev_set_drvdata(platform->dev, data);
 871 }
 872
 873 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
 874 {
 875         return dev_get_drvdata(platform->dev);
 876 }
 877
 878 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
 879                 void *data)
 880 {
 881         dev_set_drvdata(&rtd->dev, data);
 882 }
 883
 884 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
 885 {
 886         return dev_get_drvdata(&rtd->dev);
 887 }
 888
 889 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
 890 {
 891         INIT_LIST_HEAD(&card->dai_dev_list);
 892         INIT_LIST_HEAD(&card->codec_dev_list);
 893         INIT_LIST_HEAD(&card->platform_dev_list);
 894         INIT_LIST_HEAD(&card->widgets);
 895         INIT_LIST_HEAD(&card->paths);
 896         INIT_LIST_HEAD(&card->dapm_list);
 897 }
 898
 899 int snd_soc_util_init(void);
 900 void snd_soc_util_exit(void);
 901
 902 #include <sound/soc-dai.h>
 903
 904 #ifdef CONFIG_DEBUG_FS
 905 extern struct dentry *snd_soc_debugfs_root;
 906 #endif
 907
 908 extern const struct dev_pm_ops snd_soc_pm_ops;
 909
 910 #endif