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