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