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_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert) \
  32         ((unsigned long)&(struct soc_mixer_control) \
  33         {.reg = xreg, .rreg = xreg, .shift = shift_left, \
  34         .rshift = shift_right, .max = xmax, .platform_max = xmax, \
  35         .invert = xinvert})
  36 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
  37         SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert)
  38 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
  39         ((unsigned long)&(struct soc_mixer_control) \
  40         {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
  41 #define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
  42         ((unsigned long)&(struct soc_mixer_control) \
  43         {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  44         .max = xmax, .platform_max = xmax, .invert = xinvert})
  45 #define SOC_SINGLE(xname, reg, shift, max, invert) \
  46 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  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_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
  51 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  52         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  53                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  54         .tlv.p = (tlv_array), \
  55         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  56         .put = snd_soc_put_volsw, \
  57         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
  58 #define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
  59 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  60         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
  61         .put = snd_soc_put_volsw, \
  62         .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
  63                                           max, invert) }
  64 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
  65 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
  66         .info = snd_soc_info_volsw, \
  67         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
  68         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
  69                                             xmax, xinvert) }
  70 #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
  71 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  72         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  73                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  74         .tlv.p = (tlv_array), \
  75         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
  76         .put = snd_soc_put_volsw, \
  77         .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
  78                                           max, invert) }
  79 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
  80 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  81         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  82                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  83         .tlv.p = (tlv_array), \
  84         .info = snd_soc_info_volsw, \
  85         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
  86         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
  87                                             xmax, xinvert) }
  88 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
  89 {       .iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
  90         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
  91                   SNDRV_CTL_ELEM_ACCESS_READWRITE, \
  92         .tlv.p  = (tlv_array), \
  93         .info   = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
  94         .put    = snd_soc_put_volsw_s8, \
  95         .private_value = (unsigned long)&(struct soc_mixer_control) \
  96                 {.reg = xreg, .min = xmin, .max = xmax, \
  97                  .platform_max = xmax} }
  98 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
  99 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 100         .max = xmax, .texts = xtexts }
 101 #define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
 102         SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
 103 #define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
 104 {       .max = xmax, .texts = xtexts }
 105 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
 106 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 107         .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
 108 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
 109         SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
 110 #define SOC_ENUM(xname, xenum) \
 111 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
 112         .info = snd_soc_info_enum_double, \
 113         .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
 114         .private_value = (unsigned long)&xenum }
 115 #define SOC_VALUE_ENUM(xname, xenum) \
 116 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
 117         .info = snd_soc_info_enum_double, \
 118         .get = snd_soc_get_value_enum_double, \
 119         .put = snd_soc_put_value_enum_double, \
 120         .private_value = (unsigned long)&xenum }
 121 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
 122          xhandler_get, xhandler_put) \
 123 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 124         .info = snd_soc_info_volsw, \
 125         .get = xhandler_get, .put = xhandler_put, \
 126         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
 127 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
 128          xhandler_get, xhandler_put) \
 129 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 130         .info = snd_soc_info_volsw, \
 131         .get = xhandler_get, .put = xhandler_put, \
 132         .private_value = \
 133                 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert) }
 134 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
 135          xhandler_get, xhandler_put, tlv_array) \
 136 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 137         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 138                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 139         .tlv.p = (tlv_array), \
 140         .info = snd_soc_info_volsw, \
 141         .get = xhandler_get, .put = xhandler_put, \
 142         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
 143 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
 144          xhandler_get, xhandler_put, tlv_array) \
 145 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 146         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 147                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 148         .tlv.p = (tlv_array), \
 149         .info = snd_soc_info_volsw, \
 150         .get = xhandler_get, .put = xhandler_put, \
 151         .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
 152                                           xmax, xinvert) }
 153 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
 154          xhandler_get, xhandler_put, tlv_array) \
 155 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 156         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 157                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 158         .tlv.p = (tlv_array), \
 159         .info = snd_soc_info_volsw, \
 160         .get = xhandler_get, .put = xhandler_put, \
 161         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 162                                             xmax, 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_RBTREE_COMPRESSION
 270 };
 271
 272 enum snd_soc_pcm_subclass {
 273         SND_SOC_PCM_CLASS_PCM   = 0,
 274         SND_SOC_PCM_CLASS_BE    = 1,
 275 };
 276
 277 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
 278                              int source, unsigned int freq, int dir);
 279 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
 280                           unsigned int freq_in, unsigned int freq_out);
 281
 282 int snd_soc_register_card(struct snd_soc_card *card);
 283 int snd_soc_unregister_card(struct snd_soc_card *card);
 284 int snd_soc_suspend(struct device *dev);
 285 int snd_soc_resume(struct device *dev);
 286 int snd_soc_poweroff(struct device *dev);
 287 int snd_soc_register_platform(struct device *dev,
 288                 struct snd_soc_platform_driver *platform_drv);
 289 void snd_soc_unregister_platform(struct device *dev);
 290 int snd_soc_register_codec(struct device *dev,
 291                 const struct snd_soc_codec_driver *codec_drv,
 292                 struct snd_soc_dai_driver *dai_drv, int num_dai);
 293 void snd_soc_unregister_codec(struct device *dev);
 294 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
 295                                     unsigned int reg);
 296 int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
 297                                     unsigned int reg);
 298 int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
 299                                     unsigned int reg);
 300 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
 301                                int addr_bits, int data_bits,
 302                                enum snd_soc_control_type control);
 303 int snd_soc_cache_sync(struct snd_soc_codec *codec);
 304 int snd_soc_cache_init(struct snd_soc_codec *codec);
 305 int snd_soc_cache_exit(struct snd_soc_codec *codec);
 306 int snd_soc_cache_write(struct snd_soc_codec *codec,
 307                         unsigned int reg, unsigned int value);
 308 int snd_soc_cache_read(struct snd_soc_codec *codec,
 309                        unsigned int reg, unsigned int *value);
 310 int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
 311                                       unsigned int reg);
 312 int snd_soc_default_readable_register(struct snd_soc_codec *codec,
 313                                       unsigned int reg);
 314 int snd_soc_default_writable_register(struct snd_soc_codec *codec,
 315                                       unsigned int reg);
 316 int snd_soc_platform_read(struct snd_soc_platform *platform,
 317                                         unsigned int reg);
 318 int snd_soc_platform_write(struct snd_soc_platform *platform,
 319                                         unsigned int reg, unsigned int val);
 320
 321 /* Utility functions to get clock rates from various things */
 322 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 323 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 324 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 325 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 326
 327 /* set runtime hw params */
 328 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 329         const struct snd_pcm_hardware *hw);
 330
 331 /* Jack reporting */
 332 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
 333                      struct snd_soc_jack *jack);
 334 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 335 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 336                           struct snd_soc_jack_pin *pins);
 337 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
 338                                     struct notifier_block *nb);
 339 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
 340                                       struct notifier_block *nb);
 341 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
 342                           struct snd_soc_jack_zone *zones);
 343 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
 344 #ifdef CONFIG_GPIOLIB
 345 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 346                         struct snd_soc_jack_gpio *gpios);
 347 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 348                         struct snd_soc_jack_gpio *gpios);
 349 #endif
 350
 351 /* codec register bit access */
 352 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
 353                                 unsigned int mask, unsigned int value);
 354 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
 355                                unsigned short reg, unsigned int mask,
 356                                unsigned int value);
 357 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
 358                                 unsigned int mask, unsigned int value);
 359
 360 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
 361         struct snd_ac97_bus_ops *ops, int num);
 362 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
 363
 364 /*
 365  *Controls
 366  */
 367 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 368                                   void *data, char *long_name,
 369                                   const char *prefix);
 370 int snd_soc_add_controls(struct snd_soc_codec *codec,
 371         const struct snd_kcontrol_new *controls, int num_controls);
 372 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
 373         const struct snd_kcontrol_new *controls, int num_controls);
 374 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 375         struct snd_ctl_elem_info *uinfo);
 376 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
 377         struct snd_ctl_elem_info *uinfo);
 378 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 379         struct snd_ctl_elem_value *ucontrol);
 380 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 381         struct snd_ctl_elem_value *ucontrol);
 382 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
 383         struct snd_ctl_elem_value *ucontrol);
 384 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
 385         struct snd_ctl_elem_value *ucontrol);
 386 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 387         struct snd_ctl_elem_info *uinfo);
 388 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
 389         struct snd_ctl_elem_info *uinfo);
 390 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 391 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 392         struct snd_ctl_elem_value *ucontrol);
 393 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 394         struct snd_ctl_elem_value *ucontrol);
 395 #define snd_soc_get_volsw_2r snd_soc_get_volsw
 396 #define snd_soc_put_volsw_2r snd_soc_put_volsw
 397 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
 398         struct snd_ctl_elem_info *uinfo);
 399 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
 400         struct snd_ctl_elem_value *ucontrol);
 401 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
 402         struct snd_ctl_elem_value *ucontrol);
 403 int snd_soc_limit_volume(struct snd_soc_codec *codec,
 404         const char *name, int max);
 405 int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol,
 406         struct snd_ctl_elem_info *uinfo);
 407 int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol,
 408         struct snd_ctl_elem_value *ucontrol);
 409 int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol,
 410         struct snd_ctl_elem_value *ucontrol);
 411
 412 /**
 413  * struct snd_soc_reg_access - Describes whether a given register is
 414  * readable, writable or volatile.
 415  *
 416  * @reg: the register number
 417  * @read: whether this register is readable
 418  * @write: whether this register is writable
 419  * @vol: whether this register is volatile
 420  */
 421 struct snd_soc_reg_access {
 422         u16 reg;
 423         u16 read;
 424         u16 write;
 425         u16 vol;
 426 };
 427
 428 /**
 429  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 430  *
 431  * @pin:    name of the pin to update
 432  * @mask:   bits to check for in reported jack status
 433  * @invert: if non-zero then pin is enabled when status is not reported
 434  */
 435 struct snd_soc_jack_pin {
 436         struct list_head list;
 437         const char *pin;
 438         int mask;
 439         bool invert;
 440 };
 441
 442 /**
 443  * struct snd_soc_jack_zone - Describes voltage zones of jack detection
 444  *
 445  * @min_mv: start voltage in mv
 446  * @max_mv: end voltage in mv
 447  * @jack_type: type of jack that is expected for this voltage
 448  * @debounce_time: debounce_time for jack, codec driver should wait for this
 449  *              duration before reading the adc for voltages
 450  * @:list: list container
 451  */
 452 struct snd_soc_jack_zone {
 453         unsigned int min_mv;
 454         unsigned int max_mv;
 455         unsigned int jack_type;
 456         unsigned int debounce_time;
 457         struct list_head list;
 458 };
 459
 460 /**
 461  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 462  *
 463  * @gpio:         gpio number
 464  * @name:         gpio name
 465  * @report:       value to report when jack detected
 466  * @invert:       report presence in low state
 467  * @debouce_time: debouce time in ms
 468  * @wake:         enable as wake source
 469  * @jack_status_check: callback function which overrides the detection
 470  *                     to provide more complex checks (eg, reading an
 471  *                     ADC).
 472  */
 473 #ifdef CONFIG_GPIOLIB
 474 struct snd_soc_jack_gpio {
 475         unsigned int gpio;
 476         const char *name;
 477         int report;
 478         int invert;
 479         int debounce_time;
 480         bool wake;
 481
 482         struct snd_soc_jack *jack;
 483         struct delayed_work work;
 484
 485         int (*jack_status_check)(void);
 486 };
 487 #endif
 488
 489 struct snd_soc_jack {
 490         struct snd_jack *jack;
 491         struct snd_soc_codec *codec;
 492         struct list_head pins;
 493         int status;
 494         struct blocking_notifier_head notifier;
 495         struct list_head jack_zones;
 496 };
 497
 498 /* SoC PCM stream information */
 499 struct snd_soc_pcm_stream {
 500         const char *stream_name;
 501         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 502         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 503         unsigned int rate_min;          /* min rate */
 504         unsigned int rate_max;          /* max rate */
 505         unsigned int channels_min;      /* min channels */
 506         unsigned int channels_max;      /* max channels */
 507 };
 508
 509 /* SoC audio ops */
 510 struct snd_soc_ops {
 511         int (*startup)(struct snd_pcm_substream *);
 512         void (*shutdown)(struct snd_pcm_substream *);
 513         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 514         int (*hw_free)(struct snd_pcm_substream *);
 515         int (*prepare)(struct snd_pcm_substream *);
 516         int (*trigger)(struct snd_pcm_substream *, int);
 517 };
 518
 519 /* SoC cache ops */
 520 struct snd_soc_cache_ops {
 521         const char *name;
 522         enum snd_soc_compress_type id;
 523         int (*init)(struct snd_soc_codec *codec);
 524         int (*exit)(struct snd_soc_codec *codec);
 525         int (*read)(struct snd_soc_codec *codec, unsigned int reg,
 526                 unsigned int *value);
 527         int (*write)(struct snd_soc_codec *codec, unsigned int reg,
 528                 unsigned int value);
 529         int (*sync)(struct snd_soc_codec *codec);
 530 };
 531
 532 /* SoC Audio Codec device */
 533 struct snd_soc_codec {
 534         const char *name;
 535         const char *name_prefix;
 536         int id;
 537         struct device *dev;
 538         const struct snd_soc_codec_driver *driver;
 539
 540         struct mutex mutex;
 541         struct snd_soc_card *card;
 542         struct list_head list;
 543         struct list_head card_list;
 544         int num_dai;
 545         enum snd_soc_compress_type compress_type;
 546         size_t reg_size;        /* reg_cache_size * reg_word_size */
 547         int (*volatile_register)(struct snd_soc_codec *, unsigned int);
 548         int (*readable_register)(struct snd_soc_codec *, unsigned int);
 549         int (*writable_register)(struct snd_soc_codec *, unsigned int);
 550
 551         /* runtime */
 552         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
 553         unsigned int active;
 554         unsigned int cache_bypass:1; /* Suppress access to the cache */
 555         unsigned int suspended:1; /* Codec is in suspend PM state */
 556         unsigned int probed:1; /* Codec has been probed */
 557         unsigned int ac97_registered:1; /* Codec has been AC97 registered */
 558         unsigned int ac97_created:1; /* Codec has been created by SoC */
 559         unsigned int sysfs_registered:1; /* codec has been sysfs registered */
 560         unsigned int cache_init:1; /* codec cache has been initialized */
 561         u32 cache_only;  /* Suppress writes to hardware */
 562         u32 cache_sync; /* Cache needs to be synced to hardware */
 563
 564         /* codec IO */
 565         void *control_data; /* codec control (i2c/3wire) data */
 566         enum snd_soc_control_type control_type;
 567         hw_write_t hw_write;
 568         unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
 569         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 570         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 571         int (*bulk_write_raw)(struct snd_soc_codec *, unsigned int, const void *, size_t);
 572         void *reg_cache;
 573         const void *reg_def_copy;
 574         const struct snd_soc_cache_ops *cache_ops;
 575         struct mutex cache_rw_mutex;
 576         int val_bytes;
 577
 578         /* dapm */
 579         struct snd_soc_dapm_context dapm;
 580         unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
 581
 582 #ifdef CONFIG_DEBUG_FS
 583         struct dentry *debugfs_codec_root;
 584         struct dentry *debugfs_reg;
 585         struct dentry *debugfs_dapm;
 586 #endif
 587 };
 588
 589 /* codec driver */
 590 struct snd_soc_codec_driver {
 591
 592         /* driver ops */
 593         int (*probe)(struct snd_soc_codec *);
 594         int (*remove)(struct snd_soc_codec *);
 595         int (*suspend)(struct snd_soc_codec *);
 596         int (*resume)(struct snd_soc_codec *);
 597
 598         /* Default control and setup, added after probe() is run */
 599         const struct snd_kcontrol_new *controls;
 600         int num_controls;
 601         const struct snd_soc_dapm_widget *dapm_widgets;
 602         int num_dapm_widgets;
 603         const struct snd_soc_dapm_route *dapm_routes;
 604         int num_dapm_routes;
 605
 606         /* codec wide operations */
 607         int (*set_sysclk)(struct snd_soc_codec *codec,
 608                           int clk_id, int source, unsigned int freq, int dir);
 609         int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
 610                 unsigned int freq_in, unsigned int freq_out);
 611
 612         /* codec IO */
 613         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 614         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 615         int (*display_register)(struct snd_soc_codec *, char *,
 616                                 size_t, unsigned int);
 617         int (*volatile_register)(struct snd_soc_codec *, unsigned int);
 618         int (*readable_register)(struct snd_soc_codec *, unsigned int);
 619         int (*writable_register)(struct snd_soc_codec *, unsigned int);
 620         unsigned int reg_cache_size;
 621         short reg_cache_step;
 622         short reg_word_size;
 623         const void *reg_cache_default;
 624         short reg_access_size;
 625         const struct snd_soc_reg_access *reg_access_default;
 626         enum snd_soc_compress_type compress_type;
 627
 628         /* codec bias level */
 629         int (*set_bias_level)(struct snd_soc_codec *,
 630                               enum snd_soc_bias_level level);
 631         bool idle_bias_off;
 632
 633         void (*seq_notifier)(struct snd_soc_dapm_context *,
 634                              enum snd_soc_dapm_type, int);
 635
 636         /* codec stream completion event */
 637         int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
 638
 639         /* probe ordering - for components with runtime dependencies */
 640         int probe_order;
 641         int remove_order;
 642 };
 643
 644 /* SoC platform interface */
 645 struct snd_soc_platform_driver {
 646
 647         int (*probe)(struct snd_soc_platform *);
 648         int (*remove)(struct snd_soc_platform *);
 649         int (*suspend)(struct snd_soc_dai *dai);
 650         int (*resume)(struct snd_soc_dai *dai);
 651
 652         /* pcm creation and destruction */
 653         int (*pcm_new)(struct snd_soc_pcm_runtime *);
 654         void (*pcm_free)(struct snd_pcm *);
 655
 656         /* Default control and setup, added after probe() is run */
 657         const struct snd_kcontrol_new *controls;
 658         int num_controls;
 659         const struct snd_soc_dapm_widget *dapm_widgets;
 660         int num_dapm_widgets;
 661         const struct snd_soc_dapm_route *dapm_routes;
 662         int num_dapm_routes;
 663
 664         /*
 665          * For platform caused delay reporting.
 666          * Optional.
 667          */
 668         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 669                 struct snd_soc_dai *);
 670
 671         /* platform stream ops */
 672         struct snd_pcm_ops *ops;
 673
 674         /* platform stream completion event */
 675         int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
 676
 677         /* probe ordering - for components with runtime dependencies */
 678         int probe_order;
 679         int remove_order;
 680
 681         /* platform IO - used for platform DAPM */
 682         unsigned int (*read)(struct snd_soc_platform *, unsigned int);
 683         int (*write)(struct snd_soc_platform *, unsigned int, unsigned int);
 684 };
 685
 686 struct snd_soc_platform {
 687         const char *name;
 688         int id;
 689         struct device *dev;
 690         struct snd_soc_platform_driver *driver;
 691
 692         unsigned int suspended:1; /* platform is suspended */
 693         unsigned int probed:1;
 694
 695         struct snd_soc_card *card;
 696         struct list_head list;
 697         struct list_head card_list;
 698
 699         struct snd_soc_dapm_context dapm;
 700 };
 701
 702 struct snd_soc_dai_link {
 703         /* config - must be set by machine driver */
 704         const char *name;                       /* Codec name */
 705         const char *stream_name;                /* Stream name */
 706         const char *codec_name;         /* for multi-codec */
 707         const char *platform_name;      /* for multi-platform */
 708         const char *cpu_dai_name;
 709         const char *codec_dai_name;
 710
 711         unsigned int dai_fmt;           /* format to set on init */
 712
 713         /* Keep DAI active over suspend */
 714         unsigned int ignore_suspend:1;
 715
 716         /* Symmetry requirements */
 717         unsigned int symmetric_rates:1;
 718
 719         /* pmdown_time is ignored at stop */
 720         unsigned int ignore_pmdown_time: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         bool fully_routed;
 818
 819         struct work_struct deferred_resume_work;
 820
 821         /* lists of probed devices belonging to this card */
 822         struct list_head codec_dev_list;
 823         struct list_head platform_dev_list;
 824         struct list_head dai_dev_list;
 825
 826         struct list_head widgets;
 827         struct list_head paths;
 828         struct list_head dapm_list;
 829         struct list_head dapm_dirty;
 830
 831         /* Generic DAPM context for the card */
 832         struct snd_soc_dapm_context dapm;
 833         struct snd_soc_dapm_stats dapm_stats;
 834
 835 #ifdef CONFIG_DEBUG_FS
 836         struct dentry *debugfs_card_root;
 837         struct dentry *debugfs_pop_time;
 838 #endif
 839         u32 pop_time;
 840
 841         void *drvdata;
 842 };
 843
 844 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
 845 struct snd_soc_pcm_runtime {
 846         struct device dev;
 847         struct snd_soc_card *card;
 848         struct snd_soc_dai_link *dai_link;
 849         struct mutex pcm_mutex;
 850         enum snd_soc_pcm_subclass pcm_subclass;
 851         struct snd_pcm_ops ops;
 852
 853         unsigned int complete:1;
 854         unsigned int dev_registered:1;
 855
 856         long pmdown_time;
 857
 858         /* runtime devices */
 859         struct snd_pcm *pcm;
 860         struct snd_soc_codec *codec;
 861         struct snd_soc_platform *platform;
 862         struct snd_soc_dai *codec_dai;
 863         struct snd_soc_dai *cpu_dai;
 864
 865         struct delayed_work delayed_work;
 866 };
 867
 868 /* mixer control */
 869 struct soc_mixer_control {
 870         int min, max, platform_max;
 871         unsigned int reg, rreg, shift, rshift, invert;
 872 };
 873
 874 /* enumerated kcontrol */
 875 struct soc_enum {
 876         unsigned short reg;
 877         unsigned short reg2;
 878         unsigned char shift_l;
 879         unsigned char shift_r;
 880         unsigned int max;
 881         unsigned int mask;
 882         const char * const *texts;
 883         const unsigned int *values;
 884         void *dapm;
 885 };
 886
 887 /* codec IO */
 888 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
 889 unsigned int snd_soc_write(struct snd_soc_codec *codec,
 890                            unsigned int reg, unsigned int val);
 891 unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
 892                                     unsigned int reg, const void *data, size_t len);
 893
 894 /* device driver data */
 895
 896 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
 897                 void *data)
 898 {
 899         card->drvdata = data;
 900 }
 901
 902 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
 903 {
 904         return card->drvdata;
 905 }
 906
 907 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
 908                 void *data)
 909 {
 910         dev_set_drvdata(codec->dev, data);
 911 }
 912
 913 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
 914 {
 915         return dev_get_drvdata(codec->dev);
 916 }
 917
 918 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
 919                 void *data)
 920 {
 921         dev_set_drvdata(platform->dev, data);
 922 }
 923
 924 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
 925 {
 926         return dev_get_drvdata(platform->dev);
 927 }
 928
 929 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
 930                 void *data)
 931 {
 932         dev_set_drvdata(&rtd->dev, data);
 933 }
 934
 935 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
 936 {
 937         return dev_get_drvdata(&rtd->dev);
 938 }
 939
 940 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
 941 {
 942         INIT_LIST_HEAD(&card->dai_dev_list);
 943         INIT_LIST_HEAD(&card->codec_dev_list);
 944         INIT_LIST_HEAD(&card->platform_dev_list);
 945         INIT_LIST_HEAD(&card->widgets);
 946         INIT_LIST_HEAD(&card->paths);
 947         INIT_LIST_HEAD(&card->dapm_list);
 948 }
 949
 950 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
 951 {
 952         if (mc->reg == mc->rreg && mc->shift == mc->rshift)
 953                 return 0;
 954         /*
 955          * mc->reg == mc->rreg && mc->shift != mc->rshift, or
 956          * mc->reg != mc->rreg means that the control is
 957          * stereo (bits in one register or in two registers)
 958          */
 959         return 1;
 960 }
 961
 962 int snd_soc_util_init(void);
 963 void snd_soc_util_exit(void);
 964
 965 #include <sound/soc-dai.h>
 966
 967 #ifdef CONFIG_DEBUG_FS
 968 extern struct dentry *snd_soc_debugfs_root;
 969 #endif
 970
 971 extern const struct dev_pm_ops snd_soc_pm_ops;
 972
 973 #endif