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