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