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