include/sound/soc.h

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