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 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
 262                              unsigned int freq, int dir);
 263 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
 264                           unsigned int freq_in, unsigned int freq_out);
 265
 266 int snd_soc_register_card(struct snd_soc_card *card);
 267 int snd_soc_unregister_card(struct snd_soc_card *card);
 268 int snd_soc_suspend(struct device *dev);
 269 int snd_soc_resume(struct device *dev);
 270 int snd_soc_poweroff(struct device *dev);
 271 int snd_soc_register_platform(struct device *dev,
 272                 struct snd_soc_platform_driver *platform_drv);
 273 void snd_soc_unregister_platform(struct device *dev);
 274 int snd_soc_register_codec(struct device *dev,
 275                 const struct snd_soc_codec_driver *codec_drv,
 276                 struct snd_soc_dai_driver *dai_drv, int num_dai);
 277 void snd_soc_unregister_codec(struct device *dev);
 278 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
 279                                     unsigned int reg);
 280 int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
 281                                     unsigned int reg);
 282 int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
 283                                     unsigned int reg);
 284 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
 285                                int addr_bits, int data_bits,
 286                                enum snd_soc_control_type control);
 287 int snd_soc_cache_sync(struct snd_soc_codec *codec);
 288 int snd_soc_cache_init(struct snd_soc_codec *codec);
 289 int snd_soc_cache_exit(struct snd_soc_codec *codec);
 290 int snd_soc_cache_write(struct snd_soc_codec *codec,
 291                         unsigned int reg, unsigned int value);
 292 int snd_soc_cache_read(struct snd_soc_codec *codec,
 293                        unsigned int reg, unsigned int *value);
 294 int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
 295                                       unsigned int reg);
 296 int snd_soc_default_readable_register(struct snd_soc_codec *codec,
 297                                       unsigned int reg);
 298 int snd_soc_default_writable_register(struct snd_soc_codec *codec,
 299                                       unsigned int reg);
 300
 301 /* Utility functions to get clock rates from various things */
 302 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 303 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 304 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 305 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 306
 307 /* set runtime hw params */
 308 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 309         const struct snd_pcm_hardware *hw);
 310
 311 /* Jack reporting */
 312 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
 313                      struct snd_soc_jack *jack);
 314 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 315 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 316                           struct snd_soc_jack_pin *pins);
 317 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
 318                                     struct notifier_block *nb);
 319 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
 320                                       struct notifier_block *nb);
 321 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
 322                           struct snd_soc_jack_zone *zones);
 323 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
 324 #ifdef CONFIG_GPIOLIB
 325 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 326                         struct snd_soc_jack_gpio *gpios);
 327 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 328                         struct snd_soc_jack_gpio *gpios);
 329 #endif
 330
 331 /* codec register bit access */
 332 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
 333                                 unsigned int mask, unsigned int value);
 334 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
 335                                unsigned short reg, unsigned int mask,
 336                                unsigned int value);
 337 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
 338                                 unsigned int mask, unsigned int value);
 339
 340 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
 341         struct snd_ac97_bus_ops *ops, int num);
 342 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
 343
 344 /*
 345  *Controls
 346  */
 347 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 348                                   void *data, char *long_name,
 349                                   const char *prefix);
 350 int snd_soc_add_controls(struct snd_soc_codec *codec,
 351         const struct snd_kcontrol_new *controls, int num_controls);
 352 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 353         struct snd_ctl_elem_info *uinfo);
 354 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
 355         struct snd_ctl_elem_info *uinfo);
 356 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 357         struct snd_ctl_elem_value *ucontrol);
 358 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 359         struct snd_ctl_elem_value *ucontrol);
 360 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
 361         struct snd_ctl_elem_value *ucontrol);
 362 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
 363         struct snd_ctl_elem_value *ucontrol);
 364 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 365         struct snd_ctl_elem_info *uinfo);
 366 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
 367         struct snd_ctl_elem_info *uinfo);
 368 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 369 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 370         struct snd_ctl_elem_value *ucontrol);
 371 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 372         struct snd_ctl_elem_value *ucontrol);
 373 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
 374         struct snd_ctl_elem_info *uinfo);
 375 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
 376         struct snd_ctl_elem_value *ucontrol);
 377 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
 378         struct snd_ctl_elem_value *ucontrol);
 379 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
 380         struct snd_ctl_elem_info *uinfo);
 381 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
 382         struct snd_ctl_elem_value *ucontrol);
 383 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
 384         struct snd_ctl_elem_value *ucontrol);
 385 int snd_soc_limit_volume(struct snd_soc_codec *codec,
 386         const char *name, int max);
 387 int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol,
 388         struct snd_ctl_elem_info *uinfo);
 389 int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol,
 390         struct snd_ctl_elem_value *ucontrol);
 391 int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol,
 392         struct snd_ctl_elem_value *ucontrol);
 393
 394 /**
 395  * struct snd_soc_reg_access - Describes whether a given register is
 396  * readable, writable or volatile.
 397  *
 398  * @reg: the register number
 399  * @read: whether this register is readable
 400  * @write: whether this register is writable
 401  * @vol: whether this register is volatile
 402  */
 403 struct snd_soc_reg_access {
 404         u16 reg;
 405         u16 read;
 406         u16 write;
 407         u16 vol;
 408 };
 409
 410 /**
 411  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 412  *
 413  * @pin:    name of the pin to update
 414  * @mask:   bits to check for in reported jack status
 415  * @invert: if non-zero then pin is enabled when status is not reported
 416  */
 417 struct snd_soc_jack_pin {
 418         struct list_head list;
 419         const char *pin;
 420         int mask;
 421         bool invert;
 422 };
 423
 424 /**
 425  * struct snd_soc_jack_zone - Describes voltage zones of jack detection
 426  *
 427  * @min_mv: start voltage in mv
 428  * @max_mv: end voltage in mv
 429  * @jack_type: type of jack that is expected for this voltage
 430  * @debounce_time: debounce_time for jack, codec driver should wait for this
 431  *              duration before reading the adc for voltages
 432  * @:list: list container
 433  */
 434 struct snd_soc_jack_zone {
 435         unsigned int min_mv;
 436         unsigned int max_mv;
 437         unsigned int jack_type;
 438         unsigned int debounce_time;
 439         struct list_head list;
 440 };
 441
 442 /**
 443  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 444  *
 445  * @gpio:         gpio number
 446  * @name:         gpio name
 447  * @report:       value to report when jack detected
 448  * @invert:       report presence in low state
 449  * @debouce_time: debouce time in ms
 450  * @wake:         enable as wake source
 451  * @jack_status_check: callback function which overrides the detection
 452  *                     to provide more complex checks (eg, reading an
 453  *                     ADC).
 454  */
 455 #ifdef CONFIG_GPIOLIB
 456 struct snd_soc_jack_gpio {
 457         unsigned int gpio;
 458         const char *name;
 459         int report;
 460         int invert;
 461         int debounce_time;
 462         bool wake;
 463
 464         struct snd_soc_jack *jack;
 465         struct delayed_work work;
 466
 467         int (*jack_status_check)(void);
 468 };
 469 #endif
 470
 471 struct snd_soc_jack {
 472         struct snd_jack *jack;
 473         struct snd_soc_codec *codec;
 474         struct list_head pins;
 475         int status;
 476         struct blocking_notifier_head notifier;
 477         struct list_head jack_zones;
 478 };
 479
 480 /* SoC PCM stream information */
 481 struct snd_soc_pcm_stream {
 482         const char *stream_name;
 483         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 484         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 485         unsigned int rate_min;          /* min rate */
 486         unsigned int rate_max;          /* max rate */
 487         unsigned int channels_min;      /* min channels */
 488         unsigned int channels_max;      /* max channels */
 489 };
 490
 491 /* SoC audio ops */
 492 struct snd_soc_ops {
 493         int (*startup)(struct snd_pcm_substream *);
 494         void (*shutdown)(struct snd_pcm_substream *);
 495         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 496         int (*hw_free)(struct snd_pcm_substream *);
 497         int (*prepare)(struct snd_pcm_substream *);
 498         int (*trigger)(struct snd_pcm_substream *, int);
 499 };
 500
 501 /* SoC cache ops */
 502 struct snd_soc_cache_ops {
 503         const char *name;
 504         enum snd_soc_compress_type id;
 505         int (*init)(struct snd_soc_codec *codec);
 506         int (*exit)(struct snd_soc_codec *codec);
 507         int (*read)(struct snd_soc_codec *codec, unsigned int reg,
 508                 unsigned int *value);
 509         int (*write)(struct snd_soc_codec *codec, unsigned int reg,
 510                 unsigned int value);
 511         int (*sync)(struct snd_soc_codec *codec);
 512 };
 513
 514 /* SoC Audio Codec device */
 515 struct snd_soc_codec {
 516         const char *name;
 517         const char *name_prefix;
 518         int id;
 519         struct device *dev;
 520         const struct snd_soc_codec_driver *driver;
 521
 522         struct mutex mutex;
 523         struct snd_soc_card *card;
 524         struct list_head list;
 525         struct list_head card_list;
 526         int num_dai;
 527         enum snd_soc_compress_type compress_type;
 528         size_t reg_size;        /* reg_cache_size * reg_word_size */
 529         int (*volatile_register)(struct snd_soc_codec *, unsigned int);
 530         int (*readable_register)(struct snd_soc_codec *, unsigned int);
 531         int (*writable_register)(struct snd_soc_codec *, unsigned int);
 532
 533         /* runtime */
 534         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
 535         unsigned int active;
 536         unsigned int cache_bypass:1; /* Suppress access to the cache */
 537         unsigned int suspended:1; /* Codec is in suspend PM state */
 538         unsigned int probed:1; /* Codec has been probed */
 539         unsigned int ac97_registered:1; /* Codec has been AC97 registered */
 540         unsigned int ac97_created:1; /* Codec has been created by SoC */
 541         unsigned int sysfs_registered:1; /* codec has been sysfs registered */
 542         unsigned int cache_init:1; /* codec cache has been initialized */
 543         u32 cache_only;  /* Suppress writes to hardware */
 544         u32 cache_sync; /* Cache needs to be synced to hardware */
 545
 546         /* codec IO */
 547         void *control_data; /* codec control (i2c/3wire) data */
 548         enum snd_soc_control_type control_type;
 549         hw_write_t hw_write;
 550         unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
 551         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 552         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 553         int (*bulk_write_raw)(struct snd_soc_codec *, unsigned int, const void *, size_t);
 554         void *reg_cache;
 555         const void *reg_def_copy;
 556         const struct snd_soc_cache_ops *cache_ops;
 557         struct mutex cache_rw_mutex;
 558
 559         /* dapm */
 560         struct snd_soc_dapm_context dapm;
 561
 562 #ifdef CONFIG_DEBUG_FS
 563         struct dentry *debugfs_codec_root;
 564         struct dentry *debugfs_reg;
 565         struct dentry *debugfs_dapm;
 566 #endif
 567 };
 568
 569 /* codec driver */
 570 struct snd_soc_codec_driver {
 571
 572         /* driver ops */
 573         int (*probe)(struct snd_soc_codec *);
 574         int (*remove)(struct snd_soc_codec *);
 575         int (*suspend)(struct snd_soc_codec *,
 576                         pm_message_t state);
 577         int (*resume)(struct snd_soc_codec *);
 578
 579         /* Default control and setup, added after probe() is run */
 580         const struct snd_kcontrol_new *controls;
 581         int num_controls;
 582         const struct snd_soc_dapm_widget *dapm_widgets;
 583         int num_dapm_widgets;
 584         const struct snd_soc_dapm_route *dapm_routes;
 585         int num_dapm_routes;
 586
 587         /* codec wide operations */
 588         int (*set_sysclk)(struct snd_soc_codec *codec,
 589                           int clk_id, unsigned int freq, int dir);
 590         int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
 591                 unsigned int freq_in, unsigned int freq_out);
 592
 593         /* codec IO */
 594         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 595         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 596         int (*display_register)(struct snd_soc_codec *, char *,
 597                                 size_t, unsigned int);
 598         int (*volatile_register)(struct snd_soc_codec *, unsigned int);
 599         int (*readable_register)(struct snd_soc_codec *, unsigned int);
 600         int (*writable_register)(struct snd_soc_codec *, unsigned int);
 601         short reg_cache_size;
 602         short reg_cache_step;
 603         short reg_word_size;
 604         const void *reg_cache_default;
 605         short reg_access_size;
 606         const struct snd_soc_reg_access *reg_access_default;
 607         enum snd_soc_compress_type compress_type;
 608
 609         /* codec bias level */
 610         int (*set_bias_level)(struct snd_soc_codec *,
 611                               enum snd_soc_bias_level level);
 612
 613         void (*seq_notifier)(struct snd_soc_dapm_context *,
 614                              enum snd_soc_dapm_type, int);
 615 };
 616
 617 /* SoC platform interface */
 618 struct snd_soc_platform_driver {
 619
 620         int (*probe)(struct snd_soc_platform *);
 621         int (*remove)(struct snd_soc_platform *);
 622         int (*suspend)(struct snd_soc_dai *dai);
 623         int (*resume)(struct snd_soc_dai *dai);
 624
 625         /* pcm creation and destruction */
 626         int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
 627                 struct snd_pcm *);
 628         void (*pcm_free)(struct snd_pcm *);
 629
 630         /*
 631          * For platform caused delay reporting.
 632          * Optional.
 633          */
 634         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 635                 struct snd_soc_dai *);
 636
 637         /* platform stream ops */
 638         struct snd_pcm_ops *ops;
 639 };
 640
 641 struct snd_soc_platform {
 642         const char *name;
 643         int id;
 644         struct device *dev;
 645         struct snd_soc_platform_driver *driver;
 646
 647         unsigned int suspended:1; /* platform is suspended */
 648         unsigned int probed:1;
 649
 650         struct snd_soc_card *card;
 651         struct list_head list;
 652         struct list_head card_list;
 653 };
 654
 655 struct snd_soc_dai_link {
 656         /* config - must be set by machine driver */
 657         const char *name;                       /* Codec name */
 658         const char *stream_name;                /* Stream name */
 659         const char *codec_name;         /* for multi-codec */
 660         const char *platform_name;      /* for multi-platform */
 661         const char *cpu_dai_name;
 662         const char *codec_dai_name;
 663
 664         /* Keep DAI active over suspend */
 665         unsigned int ignore_suspend:1;
 666
 667         /* Symmetry requirements */
 668         unsigned int symmetric_rates:1;
 669
 670         /* codec/machine specific init - e.g. add machine controls */
 671         int (*init)(struct snd_soc_pcm_runtime *rtd);
 672
 673         /* machine stream operations */
 674         struct snd_soc_ops *ops;
 675 };
 676
 677 struct snd_soc_codec_conf {
 678         const char *dev_name;
 679
 680         /*
 681          * optional map of kcontrol, widget and path name prefixes that are
 682          * associated per device
 683          */
 684         const char *name_prefix;
 685
 686         /*
 687          * set this to the desired compression type if you want to
 688          * override the one supplied in codec->driver->compress_type
 689          */
 690         enum snd_soc_compress_type compress_type;
 691 };
 692
 693 struct snd_soc_aux_dev {
 694         const char *name;               /* Codec name */
 695         const char *codec_name;         /* for multi-codec */
 696
 697         /* codec/machine specific init - e.g. add machine controls */
 698         int (*init)(struct snd_soc_dapm_context *dapm);
 699 };
 700
 701 /* SoC card */
 702 struct snd_soc_card {
 703         const char *name;
 704         const char *long_name;
 705         const char *driver_name;
 706         struct device *dev;
 707         struct snd_card *snd_card;
 708         struct module *owner;
 709
 710         struct list_head list;
 711         struct mutex mutex;
 712
 713         bool instantiated;
 714
 715         int (*probe)(struct snd_soc_card *card);
 716         int (*late_probe)(struct snd_soc_card *card);
 717         int (*remove)(struct snd_soc_card *card);
 718
 719         /* the pre and post PM functions are used to do any PM work before and
 720          * after the codec and DAI's do any PM work. */
 721         int (*suspend_pre)(struct snd_soc_card *card);
 722         int (*suspend_post)(struct snd_soc_card *card);
 723         int (*resume_pre)(struct snd_soc_card *card);
 724         int (*resume_post)(struct snd_soc_card *card);
 725
 726         /* callbacks */
 727         int (*set_bias_level)(struct snd_soc_card *,
 728                               enum snd_soc_bias_level level);
 729         int (*set_bias_level_post)(struct snd_soc_card *,
 730                                    enum snd_soc_bias_level level);
 731
 732         long pmdown_time;
 733
 734         /* CPU <--> Codec DAI links  */
 735         struct snd_soc_dai_link *dai_link;
 736         int num_links;
 737         struct snd_soc_pcm_runtime *rtd;
 738         int num_rtd;
 739
 740         /* optional codec specific configuration */
 741         struct snd_soc_codec_conf *codec_conf;
 742         int num_configs;
 743
 744         /*
 745          * optional auxiliary devices such as amplifiers or codecs with DAI
 746          * link unused
 747          */
 748         struct snd_soc_aux_dev *aux_dev;
 749         int num_aux_devs;
 750         struct snd_soc_pcm_runtime *rtd_aux;
 751         int num_aux_rtd;
 752
 753         const struct snd_kcontrol_new *controls;
 754         int num_controls;
 755
 756         /*
 757          * Card-specific routes and widgets.
 758          */
 759         const struct snd_soc_dapm_widget *dapm_widgets;
 760         int num_dapm_widgets;
 761         const struct snd_soc_dapm_route *dapm_routes;
 762         int num_dapm_routes;
 763
 764         struct work_struct deferred_resume_work;
 765
 766         /* lists of probed devices belonging to this card */
 767         struct list_head codec_dev_list;
 768         struct list_head platform_dev_list;
 769         struct list_head dai_dev_list;
 770
 771         struct list_head widgets;
 772         struct list_head paths;
 773         struct list_head dapm_list;
 774
 775         /* Generic DAPM context for the card */
 776         struct snd_soc_dapm_context dapm;
 777
 778 #ifdef CONFIG_DEBUG_FS
 779         struct dentry *debugfs_card_root;
 780         struct dentry *debugfs_pop_time;
 781 #endif
 782         u32 pop_time;
 783
 784         void *drvdata;
 785 };
 786
 787 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
 788 struct snd_soc_pcm_runtime  {
 789         struct device dev;
 790         struct snd_soc_card *card;
 791         struct snd_soc_dai_link *dai_link;
 792
 793         unsigned int complete:1;
 794         unsigned int dev_registered:1;
 795
 796         /* Symmetry data - only valid if symmetry is being enforced */
 797         unsigned int rate;
 798         long pmdown_time;
 799
 800         /* runtime devices */
 801         struct snd_pcm *pcm;
 802         struct snd_soc_codec *codec;
 803         struct snd_soc_platform *platform;
 804         struct snd_soc_dai *codec_dai;
 805         struct snd_soc_dai *cpu_dai;
 806
 807         struct delayed_work delayed_work;
 808 };
 809
 810 /* mixer control */
 811 struct soc_mixer_control {
 812         int min, max, platform_max;
 813         unsigned int reg, rreg, shift, rshift, invert;
 814 };
 815
 816 /* enumerated kcontrol */
 817 struct soc_enum {
 818         unsigned short reg;
 819         unsigned short reg2;
 820         unsigned char shift_l;
 821         unsigned char shift_r;
 822         unsigned int max;
 823         unsigned int mask;
 824         const char * const *texts;
 825         const unsigned int *values;
 826         void *dapm;
 827 };
 828
 829 /* codec IO */
 830 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
 831 unsigned int snd_soc_write(struct snd_soc_codec *codec,
 832                            unsigned int reg, unsigned int val);
 833 unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
 834                                     unsigned int reg, const void *data, size_t len);
 835
 836 /* device driver data */
 837
 838 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
 839                 void *data)
 840 {
 841         card->drvdata = data;
 842 }
 843
 844 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
 845 {
 846         return card->drvdata;
 847 }
 848
 849 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
 850                 void *data)
 851 {
 852         dev_set_drvdata(codec->dev, data);
 853 }
 854
 855 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
 856 {
 857         return dev_get_drvdata(codec->dev);
 858 }
 859
 860 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
 861                 void *data)
 862 {
 863         dev_set_drvdata(platform->dev, data);
 864 }
 865
 866 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
 867 {
 868         return dev_get_drvdata(platform->dev);
 869 }
 870
 871 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
 872                 void *data)
 873 {
 874         dev_set_drvdata(&rtd->dev, data);
 875 }
 876
 877 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
 878 {
 879         return dev_get_drvdata(&rtd->dev);
 880 }
 881
 882 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
 883 {
 884         INIT_LIST_HEAD(&card->dai_dev_list);
 885         INIT_LIST_HEAD(&card->codec_dev_list);
 886         INIT_LIST_HEAD(&card->platform_dev_list);
 887         INIT_LIST_HEAD(&card->widgets);
 888         INIT_LIST_HEAD(&card->paths);
 889         INIT_LIST_HEAD(&card->dapm_list);
 890 }
 891
 892 int snd_soc_util_init(void);
 893 void snd_soc_util_exit(void);
 894
 895 #include <sound/soc-dai.h>
 896
 897 #ifdef CONFIG_DEBUG_FS
 898 extern struct dentry *snd_soc_debugfs_root;
 899 #endif
 900
 901 extern const struct dev_pm_ops snd_soc_pm_ops;
 902
 903 #endif