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