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/workqueue.h>
  19 #include <linux/interrupt.h>
  20 #include <linux/kernel.h>
  21 #include <sound/core.h>
  22 #include <sound/pcm.h>
  23 #include <sound/control.h>
  24 #include <sound/ac97_codec.h>
  25
  26 /*
  27  * Convenience kcontrol builders
  28  */
  29 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
  30         ((unsigned long)&(struct soc_mixer_control) \
  31         {.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \
  32         .invert = xinvert})
  33 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
  34         ((unsigned long)&(struct soc_mixer_control) \
  35         {.reg = xreg, .max = xmax, .invert = xinvert})
  36 #define SOC_SINGLE(xname, reg, shift, max, invert) \
  37 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  38         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  39         .put = snd_soc_put_volsw, \
  40         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
  41 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
  42 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  43         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  44                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  45         .tlv.p = (tlv_array), \
  46         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  47         .put = snd_soc_put_volsw, \
  48         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
  49 #define SOC_DOUBLE(xname, xreg, shift_left, shift_right, xmax, xinvert) \
  50 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  51         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
  52         .put = snd_soc_put_volsw, \
  53         .private_value = (unsigned long)&(struct soc_mixer_control) \
  54                 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
  55                  .max = xmax, .invert = xinvert} }
  56 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
  57 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
  58         .info = snd_soc_info_volsw_2r, \
  59         .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
  60         .private_value = (unsigned long)&(struct soc_mixer_control) \
  61                 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
  62                 .max = xmax, .invert = xinvert} }
  63 #define SOC_DOUBLE_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert, tlv_array) \
  64 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  65         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  66                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  67         .tlv.p = (tlv_array), \
  68         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
  69         .put = snd_soc_put_volsw, \
  70         .private_value = (unsigned long)&(struct soc_mixer_control) \
  71                 {.reg = xreg, .shift = shift_left, .rshift = shift_right,\
  72                  .max = xmax, .invert = xinvert} }
  73 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
  74 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  75         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  76                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  77         .tlv.p = (tlv_array), \
  78         .info = snd_soc_info_volsw_2r, \
  79         .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
  80         .private_value = (unsigned long)&(struct soc_mixer_control) \
  81                 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
  82                 .max = xmax, .invert = xinvert} }
  83 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
  84 {       .iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
  85         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
  86                   SNDRV_CTL_ELEM_ACCESS_READWRITE, \
  87         .tlv.p  = (tlv_array), \
  88         .info   = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
  89         .put    = snd_soc_put_volsw_s8, \
  90         .private_value = (unsigned long)&(struct soc_mixer_control) \
  91                 {.reg = xreg, .min = xmin, .max = xmax} }
  92 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
  93 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
  94         .max = xmax, .texts = xtexts }
  95 #define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
  96         SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
  97 #define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
  98 {       .max = xmax, .texts = xtexts }
  99 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
 100 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 101         .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
 102 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
 103         SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
 104 #define SOC_ENUM(xname, xenum) \
 105 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
 106         .info = snd_soc_info_enum_double, \
 107         .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
 108         .private_value = (unsigned long)&xenum }
 109 #define SOC_VALUE_ENUM(xname, xenum) \
 110 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
 111         .info = snd_soc_info_enum_double, \
 112         .get = snd_soc_get_value_enum_double, \
 113         .put = snd_soc_put_value_enum_double, \
 114         .private_value = (unsigned long)&xenum }
 115 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
 116          xhandler_get, xhandler_put) \
 117 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 118         .info = snd_soc_info_volsw, \
 119         .get = xhandler_get, .put = xhandler_put, \
 120         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
 121 #define SOC_DOUBLE_EXT(xname, xreg, shift_left, shift_right, xmax, xinvert,\
 122          xhandler_get, xhandler_put) \
 123 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 124         .info = snd_soc_info_volsw, \
 125         .get = xhandler_get, .put = xhandler_put, \
 126         .private_value = (unsigned long)&(struct soc_mixer_control) \
 127                 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
 128                  .max = xmax, .invert = xinvert} }
 129 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
 130          xhandler_get, xhandler_put, tlv_array) \
 131 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 132         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 133                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 134         .tlv.p = (tlv_array), \
 135         .info = snd_soc_info_volsw, \
 136         .get = xhandler_get, .put = xhandler_put, \
 137         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
 138 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
 139          xhandler_get, xhandler_put, tlv_array) \
 140 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 141         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 142                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 143         .tlv.p = (tlv_array), \
 144         .info = snd_soc_info_volsw, \
 145         .get = xhandler_get, .put = xhandler_put, \
 146         .private_value = (unsigned long)&(struct soc_mixer_control) \
 147                 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
 148                 .max = xmax, .invert = xinvert} }
 149 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
 150          xhandler_get, xhandler_put, tlv_array) \
 151 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 152         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 153                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 154         .tlv.p = (tlv_array), \
 155         .info = snd_soc_info_volsw_2r, \
 156         .get = xhandler_get, .put = xhandler_put, \
 157         .private_value = (unsigned long)&(struct soc_mixer_control) \
 158                 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
 159                 .max = xmax, .invert = xinvert} }
 160 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
 161 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 162         .info = snd_soc_info_bool_ext, \
 163         .get = xhandler_get, .put = xhandler_put, \
 164         .private_value = xdata }
 165 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 166 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 167         .info = snd_soc_info_enum_ext, \
 168         .get = xhandler_get, .put = xhandler_put, \
 169         .private_value = (unsigned long)&xenum }
 170
 171 /*
 172  * Simplified versions of above macros, declaring a struct and calculating
 173  * ARRAY_SIZE internally
 174  */
 175 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
 176         struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
 177                                                 ARRAY_SIZE(xtexts), xtexts)
 178 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
 179         SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
 180 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
 181         struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
 182 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
 183         struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
 184                                                         ARRAY_SIZE(xtexts), xtexts, xvalues)
 185 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
 186         SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
 187
 188 /*
 189  * Bias levels
 190  *
 191  * @ON:      Bias is fully on for audio playback and capture operations.
 192  * @PREPARE: Prepare for audio operations. Called before DAPM switching for
 193  *           stream start and stop operations.
 194  * @STANDBY: Low power standby state when no playback/capture operations are
 195  *           in progress. NOTE: The transition time between STANDBY and ON
 196  *           should be as fast as possible and no longer than 10ms.
 197  * @OFF:     Power Off. No restrictions on transition times.
 198  */
 199 enum snd_soc_bias_level {
 200         SND_SOC_BIAS_ON,
 201         SND_SOC_BIAS_PREPARE,
 202         SND_SOC_BIAS_STANDBY,
 203         SND_SOC_BIAS_OFF,
 204 };
 205
 206 struct snd_jack;
 207 struct snd_soc_card;
 208 struct snd_soc_device;
 209 struct snd_soc_pcm_stream;
 210 struct snd_soc_ops;
 211 struct snd_soc_dai_mode;
 212 struct snd_soc_pcm_runtime;
 213 struct snd_soc_dai;
 214 struct snd_soc_platform;
 215 struct snd_soc_dai_link;
 216 struct snd_soc_codec;
 217 struct soc_enum;
 218 struct snd_soc_ac97_ops;
 219 struct snd_soc_jack;
 220 struct snd_soc_jack_pin;
 221 #ifdef CONFIG_GPIOLIB
 222 struct snd_soc_jack_gpio;
 223 #endif
 224
 225 typedef int (*hw_write_t)(void *,const char* ,int);
 226
 227 extern struct snd_ac97_bus_ops soc_ac97_ops;
 228
 229 enum snd_soc_control_type {
 230         SND_SOC_CUSTOM,
 231         SND_SOC_I2C,
 232         SND_SOC_SPI,
 233 };
 234
 235 int snd_soc_register_platform(struct snd_soc_platform *platform);
 236 void snd_soc_unregister_platform(struct snd_soc_platform *platform);
 237 int snd_soc_register_codec(struct snd_soc_codec *codec);
 238 void snd_soc_unregister_codec(struct snd_soc_codec *codec);
 239 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec, int reg);
 240 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
 241                                int addr_bits, int data_bits,
 242                                enum snd_soc_control_type control);
 243
 244 /* pcm <-> DAI connect */
 245 void snd_soc_free_pcms(struct snd_soc_device *socdev);
 246 int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid);
 247
 248 /* Utility functions to get clock rates from various things */
 249 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 250 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 251 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 252 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 253
 254 /* set runtime hw params */
 255 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 256         const struct snd_pcm_hardware *hw);
 257
 258 /* Jack reporting */
 259 int snd_soc_jack_new(struct snd_soc_card *card, const char *id, int type,
 260                      struct snd_soc_jack *jack);
 261 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 262 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 263                           struct snd_soc_jack_pin *pins);
 264 #ifdef CONFIG_GPIOLIB
 265 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 266                         struct snd_soc_jack_gpio *gpios);
 267 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 268                         struct snd_soc_jack_gpio *gpios);
 269 #endif
 270
 271 /* codec register bit access */
 272 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
 273                                 unsigned int mask, unsigned int value);
 274 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
 275                                unsigned short reg, unsigned int mask,
 276                                unsigned int value);
 277 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
 278                                 unsigned int mask, unsigned int value);
 279
 280 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
 281         struct snd_ac97_bus_ops *ops, int num);
 282 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
 283
 284 /*
 285  *Controls
 286  */
 287 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 288         void *data, char *long_name);
 289 int snd_soc_add_controls(struct snd_soc_codec *codec,
 290         const struct snd_kcontrol_new *controls, int num_controls);
 291 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 292         struct snd_ctl_elem_info *uinfo);
 293 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
 294         struct snd_ctl_elem_info *uinfo);
 295 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 296         struct snd_ctl_elem_value *ucontrol);
 297 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 298         struct snd_ctl_elem_value *ucontrol);
 299 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
 300         struct snd_ctl_elem_value *ucontrol);
 301 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
 302         struct snd_ctl_elem_value *ucontrol);
 303 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 304         struct snd_ctl_elem_info *uinfo);
 305 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
 306         struct snd_ctl_elem_info *uinfo);
 307 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 308 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 309         struct snd_ctl_elem_value *ucontrol);
 310 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 311         struct snd_ctl_elem_value *ucontrol);
 312 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
 313         struct snd_ctl_elem_info *uinfo);
 314 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
 315         struct snd_ctl_elem_value *ucontrol);
 316 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
 317         struct snd_ctl_elem_value *ucontrol);
 318 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
 319         struct snd_ctl_elem_info *uinfo);
 320 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
 321         struct snd_ctl_elem_value *ucontrol);
 322 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
 323         struct snd_ctl_elem_value *ucontrol);
 324
 325 /**
 326  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 327  *
 328  * @pin:    name of the pin to update
 329  * @mask:   bits to check for in reported jack status
 330  * @invert: if non-zero then pin is enabled when status is not reported
 331  */
 332 struct snd_soc_jack_pin {
 333         struct list_head list;
 334         const char *pin;
 335         int mask;
 336         bool invert;
 337 };
 338
 339 /**
 340  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 341  *
 342  * @gpio:         gpio number
 343  * @name:         gpio name
 344  * @report:       value to report when jack detected
 345  * @invert:       report presence in low state
 346  * @debouce_time: debouce time in ms
 347  */
 348 #ifdef CONFIG_GPIOLIB
 349 struct snd_soc_jack_gpio {
 350         unsigned int gpio;
 351         const char *name;
 352         int report;
 353         int invert;
 354         int debounce_time;
 355         struct snd_soc_jack *jack;
 356         struct work_struct work;
 357
 358         int (*jack_status_check)(void);
 359 };
 360 #endif
 361
 362 struct snd_soc_jack {
 363         struct snd_jack *jack;
 364         struct snd_soc_card *card;
 365         struct list_head pins;
 366         int status;
 367 };
 368
 369 /* SoC PCM stream information */
 370 struct snd_soc_pcm_stream {
 371         char *stream_name;
 372         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 373         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 374         unsigned int rate_min;          /* min rate */
 375         unsigned int rate_max;          /* max rate */
 376         unsigned int channels_min;      /* min channels */
 377         unsigned int channels_max;      /* max channels */
 378         unsigned int active;            /* num of active users of the stream */
 379         void *dma_data;                 /* used by platform code */
 380 };
 381
 382 /* SoC audio ops */
 383 struct snd_soc_ops {
 384         int (*startup)(struct snd_pcm_substream *);
 385         void (*shutdown)(struct snd_pcm_substream *);
 386         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 387         int (*hw_free)(struct snd_pcm_substream *);
 388         int (*prepare)(struct snd_pcm_substream *);
 389         int (*trigger)(struct snd_pcm_substream *, int);
 390 };
 391
 392 /* SoC Audio Codec */
 393 struct snd_soc_codec {
 394         char *name;
 395         struct module *owner;
 396         struct mutex mutex;
 397         struct device *dev;
 398         struct snd_soc_device *socdev;
 399
 400         struct list_head list;
 401
 402         /* callbacks */
 403         int (*set_bias_level)(struct snd_soc_codec *,
 404                               enum snd_soc_bias_level level);
 405
 406         /* runtime */
 407         struct snd_card *card;
 408         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
 409         unsigned int active;
 410         unsigned int pcm_devs;
 411         void *private_data;
 412
 413         /* codec IO */
 414         void *control_data; /* codec control (i2c/3wire) data */
 415         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 416         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 417         int (*display_register)(struct snd_soc_codec *, char *,
 418                                 size_t, unsigned int);
 419         int (*volatile_register)(unsigned int);
 420         int (*readable_register)(unsigned int);
 421         hw_write_t hw_write;
 422         unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
 423         void *reg_cache;
 424         short reg_cache_size;
 425         short reg_cache_step;
 426
 427         unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
 428         unsigned int cache_only:1;  /* Suppress writes to hardware */
 429         unsigned int cache_sync:1; /* Cache needs to be synced to hardware */
 430
 431         /* dapm */
 432         u32 pop_time;
 433         struct list_head dapm_widgets;
 434         struct list_head dapm_paths;
 435         enum snd_soc_bias_level bias_level;
 436         enum snd_soc_bias_level suspend_bias_level;
 437         struct delayed_work delayed_work;
 438
 439         /* codec DAI's */
 440         struct snd_soc_dai *dai;
 441         unsigned int num_dai;
 442
 443 #ifdef CONFIG_DEBUG_FS
 444         struct dentry *debugfs_codec_root;
 445         struct dentry *debugfs_reg;
 446         struct dentry *debugfs_pop_time;
 447         struct dentry *debugfs_dapm;
 448 #endif
 449 };
 450
 451 /* codec device */
 452 struct snd_soc_codec_device {
 453         int (*probe)(struct platform_device *pdev);
 454         int (*remove)(struct platform_device *pdev);
 455         int (*suspend)(struct platform_device *pdev, pm_message_t state);
 456         int (*resume)(struct platform_device *pdev);
 457 };
 458
 459 /* SoC platform interface */
 460 struct snd_soc_platform {
 461         char *name;
 462         struct list_head list;
 463
 464         int (*probe)(struct platform_device *pdev);
 465         int (*remove)(struct platform_device *pdev);
 466         int (*suspend)(struct snd_soc_dai_link *dai_link);
 467         int (*resume)(struct snd_soc_dai_link *dai_link);
 468
 469         /* pcm creation and destruction */
 470         int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
 471                 struct snd_pcm *);
 472         void (*pcm_free)(struct snd_pcm *);
 473
 474         /*
 475          * For platform caused delay reporting.
 476          * Optional.
 477          */
 478         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 479                 struct snd_soc_dai *);
 480
 481         /* platform stream ops */
 482         struct snd_pcm_ops *pcm_ops;
 483 };
 484
 485 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
 486 struct snd_soc_dai_link  {
 487         char *name;                     /* Codec name */
 488         char *stream_name;              /* Stream name */
 489
 490         /* DAI */
 491         struct snd_soc_dai *codec_dai;
 492         struct snd_soc_dai *cpu_dai;
 493
 494         /* machine stream operations */
 495         struct snd_soc_ops *ops;
 496
 497         /* codec/machine specific init - e.g. add machine controls */
 498         int (*init)(struct snd_soc_codec *codec);
 499
 500         /* Symmetry requirements */
 501         unsigned int symmetric_rates:1;
 502
 503         /* Symmetry data - only valid if symmetry is being enforced */
 504         unsigned int rate;
 505
 506         /* DAI pcm */
 507         struct snd_pcm *pcm;
 508 };
 509
 510 /* SoC card */
 511 struct snd_soc_card {
 512         char *name;
 513         struct device *dev;
 514
 515         struct list_head list;
 516
 517         int instantiated;
 518
 519         int (*probe)(struct platform_device *pdev);
 520         int (*remove)(struct platform_device *pdev);
 521
 522         /* the pre and post PM functions are used to do any PM work before and
 523          * after the codec and DAI's do any PM work. */
 524         int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
 525         int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
 526         int (*resume_pre)(struct platform_device *pdev);
 527         int (*resume_post)(struct platform_device *pdev);
 528
 529         /* callbacks */
 530         int (*set_bias_level)(struct snd_soc_card *,
 531                               enum snd_soc_bias_level level);
 532
 533         long pmdown_time;
 534
 535         /* CPU <--> Codec DAI links  */
 536         struct snd_soc_dai_link *dai_link;
 537         int num_links;
 538
 539         struct snd_soc_device *socdev;
 540
 541         struct snd_soc_codec *codec;
 542
 543         struct snd_soc_platform *platform;
 544         struct delayed_work delayed_work;
 545         struct work_struct deferred_resume_work;
 546 };
 547
 548 /* SoC Device - the audio subsystem */
 549 struct snd_soc_device {
 550         struct device *dev;
 551         struct snd_soc_card *card;
 552         struct snd_soc_codec_device *codec_dev;
 553         void *codec_data;
 554 };
 555
 556 /* runtime channel data */
 557 struct snd_soc_pcm_runtime {
 558         struct snd_soc_dai_link *dai;
 559         struct snd_soc_device *socdev;
 560 };
 561
 562 /* mixer control */
 563 struct soc_mixer_control {
 564         int min, max;
 565         unsigned int reg, rreg, shift, rshift, invert;
 566 };
 567
 568 /* enumerated kcontrol */
 569 struct soc_enum {
 570         unsigned short reg;
 571         unsigned short reg2;
 572         unsigned char shift_l;
 573         unsigned char shift_r;
 574         unsigned int max;
 575         unsigned int mask;
 576         const char **texts;
 577         const unsigned int *values;
 578         void *dapm;
 579 };
 580
 581 /* codec IO */
 582 static inline unsigned int snd_soc_read(struct snd_soc_codec *codec,
 583                                         unsigned int reg)
 584 {
 585         return codec->read(codec, reg);
 586 }
 587
 588 static inline unsigned int snd_soc_write(struct snd_soc_codec *codec,
 589                                          unsigned int reg, unsigned int val)
 590 {
 591         return codec->write(codec, reg, val);
 592 }
 593
 594 #include <sound/soc-dai.h>
 595
 596 #endif