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