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_ON,
 218         SND_SOC_BIAS_PREPARE,
 219         SND_SOC_BIAS_STANDBY,
 220         SND_SOC_BIAS_OFF,
 221 };
 222
 223 struct snd_jack;
 224 struct snd_soc_card;
 225 struct snd_soc_device;
 226 struct snd_soc_pcm_stream;
 227 struct snd_soc_ops;
 228 struct snd_soc_dai_mode;
 229 struct snd_soc_pcm_runtime;
 230 struct snd_soc_dai;
 231 struct snd_soc_platform;
 232 struct snd_soc_dai_link;
 233 struct snd_soc_codec;
 234 struct soc_enum;
 235 struct snd_soc_ac97_ops;
 236 struct snd_soc_jack;
 237 struct snd_soc_jack_pin;
 238 #ifdef CONFIG_GPIOLIB
 239 struct snd_soc_jack_gpio;
 240 #endif
 241
 242 typedef int (*hw_write_t)(void *,const char* ,int);
 243
 244 extern struct snd_ac97_bus_ops soc_ac97_ops;
 245
 246 enum snd_soc_control_type {
 247         SND_SOC_CUSTOM,
 248         SND_SOC_I2C,
 249         SND_SOC_SPI,
 250 };
 251
 252 int snd_soc_register_platform(struct snd_soc_platform *platform);
 253 void snd_soc_unregister_platform(struct snd_soc_platform *platform);
 254 int snd_soc_register_codec(struct snd_soc_codec *codec);
 255 void snd_soc_unregister_codec(struct snd_soc_codec *codec);
 256 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec, int reg);
 257 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
 258                                int addr_bits, int data_bits,
 259                                enum snd_soc_control_type control);
 260
 261 /* pcm <-> DAI connect */
 262 void snd_soc_free_pcms(struct snd_soc_device *socdev);
 263 int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid);
 264
 265 /* Utility functions to get clock rates from various things */
 266 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 267 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 268 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 269 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 270
 271 /* set runtime hw params */
 272 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 273         const struct snd_pcm_hardware *hw);
 274
 275 /* Jack reporting */
 276 int snd_soc_jack_new(struct snd_soc_card *card, const char *id, int type,
 277                      struct snd_soc_jack *jack);
 278 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 279 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 280                           struct snd_soc_jack_pin *pins);
 281 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
 282                                     struct notifier_block *nb);
 283 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
 284                                       struct notifier_block *nb);
 285 #ifdef CONFIG_GPIOLIB
 286 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 287                         struct snd_soc_jack_gpio *gpios);
 288 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 289                         struct snd_soc_jack_gpio *gpios);
 290 #endif
 291
 292 /* codec register bit access */
 293 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
 294                                 unsigned int mask, unsigned int value);
 295 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
 296                                unsigned short reg, unsigned int mask,
 297                                unsigned int value);
 298 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
 299                                 unsigned int mask, unsigned int value);
 300
 301 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
 302         struct snd_ac97_bus_ops *ops, int num);
 303 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
 304
 305 /*
 306  *Controls
 307  */
 308 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 309         void *data, char *long_name);
 310 int snd_soc_add_controls(struct snd_soc_codec *codec,
 311         const struct snd_kcontrol_new *controls, int num_controls);
 312 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 313         struct snd_ctl_elem_info *uinfo);
 314 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
 315         struct snd_ctl_elem_info *uinfo);
 316 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 317         struct snd_ctl_elem_value *ucontrol);
 318 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 319         struct snd_ctl_elem_value *ucontrol);
 320 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
 321         struct snd_ctl_elem_value *ucontrol);
 322 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
 323         struct snd_ctl_elem_value *ucontrol);
 324 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 325         struct snd_ctl_elem_info *uinfo);
 326 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
 327         struct snd_ctl_elem_info *uinfo);
 328 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 329 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 330         struct snd_ctl_elem_value *ucontrol);
 331 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 332         struct snd_ctl_elem_value *ucontrol);
 333 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
 334         struct snd_ctl_elem_info *uinfo);
 335 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
 336         struct snd_ctl_elem_value *ucontrol);
 337 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
 338         struct snd_ctl_elem_value *ucontrol);
 339 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
 340         struct snd_ctl_elem_info *uinfo);
 341 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
 342         struct snd_ctl_elem_value *ucontrol);
 343 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
 344         struct snd_ctl_elem_value *ucontrol);
 345 int snd_soc_limit_volume(struct snd_soc_codec *codec,
 346         const char *name, int max);
 347 int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol,
 348         struct snd_ctl_elem_info *uinfo);
 349 int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol,
 350         struct snd_ctl_elem_value *ucontrol);
 351 int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol,
 352         struct snd_ctl_elem_value *ucontrol);
 353
 354 /**
 355  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 356  *
 357  * @pin:    name of the pin to update
 358  * @mask:   bits to check for in reported jack status
 359  * @invert: if non-zero then pin is enabled when status is not reported
 360  */
 361 struct snd_soc_jack_pin {
 362         struct list_head list;
 363         const char *pin;
 364         int mask;
 365         bool invert;
 366 };
 367
 368 /**
 369  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 370  *
 371  * @gpio:         gpio number
 372  * @name:         gpio name
 373  * @report:       value to report when jack detected
 374  * @invert:       report presence in low state
 375  * @debouce_time: debouce time in ms
 376  */
 377 #ifdef CONFIG_GPIOLIB
 378 struct snd_soc_jack_gpio {
 379         unsigned int gpio;
 380         const char *name;
 381         int report;
 382         int invert;
 383         int debounce_time;
 384         struct snd_soc_jack *jack;
 385         struct work_struct work;
 386
 387         int (*jack_status_check)(void);
 388 };
 389 #endif
 390
 391 struct snd_soc_jack {
 392         struct snd_jack *jack;
 393         struct snd_soc_card *card;
 394         struct list_head pins;
 395         int status;
 396         struct blocking_notifier_head notifier;
 397 };
 398
 399 /* SoC PCM stream information */
 400 struct snd_soc_pcm_stream {
 401         char *stream_name;
 402         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 403         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 404         unsigned int rate_min;          /* min rate */
 405         unsigned int rate_max;          /* max rate */
 406         unsigned int channels_min;      /* min channels */
 407         unsigned int channels_max;      /* max channels */
 408         unsigned int active;            /* stream is in use */
 409         void *dma_data;                 /* used by platform code */
 410 };
 411
 412 /* SoC audio ops */
 413 struct snd_soc_ops {
 414         int (*startup)(struct snd_pcm_substream *);
 415         void (*shutdown)(struct snd_pcm_substream *);
 416         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 417         int (*hw_free)(struct snd_pcm_substream *);
 418         int (*prepare)(struct snd_pcm_substream *);
 419         int (*trigger)(struct snd_pcm_substream *, int);
 420 };
 421
 422 /* SoC Audio Codec */
 423 struct snd_soc_codec {
 424         char *name;
 425         struct module *owner;
 426         struct mutex mutex;
 427         struct device *dev;
 428         struct snd_soc_device *socdev;
 429
 430         struct list_head list;
 431
 432         /* callbacks */
 433         int (*set_bias_level)(struct snd_soc_codec *,
 434                               enum snd_soc_bias_level level);
 435
 436         /* runtime */
 437         struct snd_card *card;
 438         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
 439         unsigned int active;
 440         unsigned int pcm_devs;
 441         void *drvdata;
 442
 443         /* codec IO */
 444         void *control_data; /* codec control (i2c/3wire) data */
 445         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 446         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 447         int (*display_register)(struct snd_soc_codec *, char *,
 448                                 size_t, unsigned int);
 449         int (*volatile_register)(unsigned int);
 450         int (*readable_register)(unsigned int);
 451         hw_write_t hw_write;
 452         unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
 453         void *reg_cache;
 454         short reg_cache_size;
 455         short reg_cache_step;
 456
 457         unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
 458         unsigned int cache_only:1;  /* Suppress writes to hardware */
 459         unsigned int cache_sync:1; /* Cache needs to be synced to hardware */
 460
 461         /* dapm */
 462         u32 pop_time;
 463         struct list_head dapm_widgets;
 464         struct list_head dapm_paths;
 465         enum snd_soc_bias_level bias_level;
 466         enum snd_soc_bias_level suspend_bias_level;
 467         struct delayed_work delayed_work;
 468
 469         /* codec DAI's */
 470         struct snd_soc_dai *dai;
 471         unsigned int num_dai;
 472
 473 #ifdef CONFIG_DEBUG_FS
 474         struct dentry *debugfs_codec_root;
 475         struct dentry *debugfs_reg;
 476         struct dentry *debugfs_pop_time;
 477         struct dentry *debugfs_dapm;
 478 #endif
 479 };
 480
 481 /* codec device */
 482 struct snd_soc_codec_device {
 483         int (*probe)(struct platform_device *pdev);
 484         int (*remove)(struct platform_device *pdev);
 485         int (*suspend)(struct platform_device *pdev, pm_message_t state);
 486         int (*resume)(struct platform_device *pdev);
 487 };
 488
 489 /* SoC platform interface */
 490 struct snd_soc_platform {
 491         char *name;
 492         struct list_head list;
 493
 494         int (*probe)(struct platform_device *pdev);
 495         int (*remove)(struct platform_device *pdev);
 496         int (*suspend)(struct snd_soc_dai_link *dai_link);
 497         int (*resume)(struct snd_soc_dai_link *dai_link);
 498
 499         /* pcm creation and destruction */
 500         int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
 501                 struct snd_pcm *);
 502         void (*pcm_free)(struct snd_pcm *);
 503
 504         /*
 505          * For platform caused delay reporting.
 506          * Optional.
 507          */
 508         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 509                 struct snd_soc_dai *);
 510
 511         /* platform stream ops */
 512         struct snd_pcm_ops *pcm_ops;
 513 };
 514
 515 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
 516 struct snd_soc_dai_link  {
 517         char *name;                     /* Codec name */
 518         char *stream_name;              /* Stream name */
 519
 520         /* DAI */
 521         struct snd_soc_dai *codec_dai;
 522         struct snd_soc_dai *cpu_dai;
 523
 524         /* machine stream operations */
 525         struct snd_soc_ops *ops;
 526
 527         /* codec/machine specific init - e.g. add machine controls */
 528         int (*init)(struct snd_soc_codec *codec);
 529
 530         /* Keep DAI active over suspend */
 531         unsigned int ignore_suspend:1;
 532
 533         /* Symmetry requirements */
 534         unsigned int symmetric_rates:1;
 535
 536         /* Symmetry data - only valid if symmetry is being enforced */
 537         unsigned int rate;
 538
 539         /* DAI pcm */
 540         struct snd_pcm *pcm;
 541 };
 542
 543 /* SoC card */
 544 struct snd_soc_card {
 545         char *name;
 546         struct device *dev;
 547
 548         struct list_head list;
 549
 550         int instantiated;
 551
 552         int (*probe)(struct platform_device *pdev);
 553         int (*remove)(struct platform_device *pdev);
 554
 555         /* the pre and post PM functions are used to do any PM work before and
 556          * after the codec and DAI's do any PM work. */
 557         int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
 558         int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
 559         int (*resume_pre)(struct platform_device *pdev);
 560         int (*resume_post)(struct platform_device *pdev);
 561
 562         /* callbacks */
 563         int (*set_bias_level)(struct snd_soc_card *,
 564                               enum snd_soc_bias_level level);
 565
 566         long pmdown_time;
 567
 568         /* CPU <--> Codec DAI links  */
 569         struct snd_soc_dai_link *dai_link;
 570         int num_links;
 571
 572         struct snd_soc_device *socdev;
 573
 574         struct snd_soc_codec *codec;
 575
 576         struct snd_soc_platform *platform;
 577         struct delayed_work delayed_work;
 578         struct work_struct deferred_resume_work;
 579 };
 580
 581 /* SoC Device - the audio subsystem */
 582 struct snd_soc_device {
 583         struct device *dev;
 584         struct snd_soc_card *card;
 585         struct snd_soc_codec_device *codec_dev;
 586         void *codec_data;
 587 };
 588
 589 /* runtime channel data */
 590 struct snd_soc_pcm_runtime {
 591         struct snd_soc_dai_link *dai;
 592         struct snd_soc_device *socdev;
 593 };
 594
 595 /* mixer control */
 596 struct soc_mixer_control {
 597         int min, max, platform_max;
 598         unsigned int reg, rreg, shift, rshift, invert;
 599 };
 600
 601 /* enumerated kcontrol */
 602 struct soc_enum {
 603         unsigned short reg;
 604         unsigned short reg2;
 605         unsigned char shift_l;
 606         unsigned char shift_r;
 607         unsigned int max;
 608         unsigned int mask;
 609         const char **texts;
 610         const unsigned int *values;
 611         void *dapm;
 612 };
 613
 614 /* codec IO */
 615 static inline unsigned int snd_soc_read(struct snd_soc_codec *codec,
 616                                         unsigned int reg)
 617 {
 618         return codec->read(codec, reg);
 619 }
 620
 621 static inline unsigned int snd_soc_write(struct snd_soc_codec *codec,
 622                                          unsigned int reg, unsigned int val)
 623 {
 624         return codec->write(codec, reg, val);
 625 }
 626
 627 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
 628                                              void *data)
 629 {
 630         codec->drvdata = data;
 631 }
 632
 633 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
 634 {
 635         return codec->drvdata;
 636 }
 637
 638 #include <sound/soc-dai.h>
 639
 640 #endif