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  * Bias levels
 173  *
 174  * @ON:      Bias is fully on for audio playback and capture operations.
 175  * @PREPARE: Prepare for audio operations. Called before DAPM switching for
 176  *           stream start and stop operations.
 177  * @STANDBY: Low power standby state when no playback/capture operations are
 178  *           in progress. NOTE: The transition time between STANDBY and ON
 179  *           should be as fast as possible and no longer than 10ms.
 180  * @OFF:     Power Off. No restrictions on transition times.
 181  */
 182 enum snd_soc_bias_level {
 183         SND_SOC_BIAS_ON,
 184         SND_SOC_BIAS_PREPARE,
 185         SND_SOC_BIAS_STANDBY,
 186         SND_SOC_BIAS_OFF,
 187 };
 188
 189 struct snd_jack;
 190 struct snd_soc_card;
 191 struct snd_soc_device;
 192 struct snd_soc_pcm_stream;
 193 struct snd_soc_ops;
 194 struct snd_soc_dai_mode;
 195 struct snd_soc_pcm_runtime;
 196 struct snd_soc_dai;
 197 struct snd_soc_platform;
 198 struct snd_soc_codec;
 199 struct soc_enum;
 200 struct snd_soc_ac97_ops;
 201 struct snd_soc_jack;
 202 struct snd_soc_jack_pin;
 203 #ifdef CONFIG_GPIOLIB
 204 struct snd_soc_jack_gpio;
 205 #endif
 206
 207 typedef int (*hw_write_t)(void *,const char* ,int);
 208
 209 extern struct snd_ac97_bus_ops soc_ac97_ops;
 210
 211 enum snd_soc_control_type {
 212         SND_SOC_CUSTOM,
 213         SND_SOC_I2C,
 214         SND_SOC_SPI,
 215 };
 216
 217 int snd_soc_register_platform(struct snd_soc_platform *platform);
 218 void snd_soc_unregister_platform(struct snd_soc_platform *platform);
 219 int snd_soc_register_codec(struct snd_soc_codec *codec);
 220 void snd_soc_unregister_codec(struct snd_soc_codec *codec);
 221 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec, int reg);
 222 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
 223                                int addr_bits, int data_bits,
 224                                enum snd_soc_control_type control);
 225
 226 /* pcm <-> DAI connect */
 227 void snd_soc_free_pcms(struct snd_soc_device *socdev);
 228 int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid);
 229
 230 /* set runtime hw params */
 231 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 232         const struct snd_pcm_hardware *hw);
 233
 234 /* Jack reporting */
 235 int snd_soc_jack_new(struct snd_soc_card *card, const char *id, int type,
 236                      struct snd_soc_jack *jack);
 237 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 238 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 239                           struct snd_soc_jack_pin *pins);
 240 #ifdef CONFIG_GPIOLIB
 241 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 242                         struct snd_soc_jack_gpio *gpios);
 243 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 244                         struct snd_soc_jack_gpio *gpios);
 245 #endif
 246
 247 /* codec register bit access */
 248 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
 249                                 unsigned int mask, unsigned int value);
 250 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
 251                                 unsigned int mask, unsigned int value);
 252
 253 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
 254         struct snd_ac97_bus_ops *ops, int num);
 255 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
 256
 257 /*
 258  *Controls
 259  */
 260 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 261         void *data, char *long_name);
 262 int snd_soc_add_controls(struct snd_soc_codec *codec,
 263         const struct snd_kcontrol_new *controls, int num_controls);
 264 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 265         struct snd_ctl_elem_info *uinfo);
 266 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
 267         struct snd_ctl_elem_info *uinfo);
 268 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 269         struct snd_ctl_elem_value *ucontrol);
 270 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 271         struct snd_ctl_elem_value *ucontrol);
 272 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
 273         struct snd_ctl_elem_value *ucontrol);
 274 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
 275         struct snd_ctl_elem_value *ucontrol);
 276 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 277         struct snd_ctl_elem_info *uinfo);
 278 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
 279         struct snd_ctl_elem_info *uinfo);
 280 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 281 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 282         struct snd_ctl_elem_value *ucontrol);
 283 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 284         struct snd_ctl_elem_value *ucontrol);
 285 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
 286         struct snd_ctl_elem_info *uinfo);
 287 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
 288         struct snd_ctl_elem_value *ucontrol);
 289 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
 290         struct snd_ctl_elem_value *ucontrol);
 291 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
 292         struct snd_ctl_elem_info *uinfo);
 293 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
 294         struct snd_ctl_elem_value *ucontrol);
 295 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
 296         struct snd_ctl_elem_value *ucontrol);
 297
 298 /**
 299  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 300  *
 301  * @pin:    name of the pin to update
 302  * @mask:   bits to check for in reported jack status
 303  * @invert: if non-zero then pin is enabled when status is not reported
 304  */
 305 struct snd_soc_jack_pin {
 306         struct list_head list;
 307         const char *pin;
 308         int mask;
 309         bool invert;
 310 };
 311
 312 /**
 313  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 314  *
 315  * @gpio:         gpio number
 316  * @name:         gpio name
 317  * @report:       value to report when jack detected
 318  * @invert:       report presence in low state
 319  * @debouce_time: debouce time in ms
 320  */
 321 #ifdef CONFIG_GPIOLIB
 322 struct snd_soc_jack_gpio {
 323         unsigned int gpio;
 324         const char *name;
 325         int report;
 326         int invert;
 327         int debounce_time;
 328         struct snd_soc_jack *jack;
 329         struct work_struct work;
 330 };
 331 #endif
 332
 333 struct snd_soc_jack {
 334         struct snd_jack *jack;
 335         struct snd_soc_card *card;
 336         struct list_head pins;
 337         int status;
 338 };
 339
 340 /* SoC PCM stream information */
 341 struct snd_soc_pcm_stream {
 342         char *stream_name;
 343         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 344         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 345         unsigned int rate_min;          /* min rate */
 346         unsigned int rate_max;          /* max rate */
 347         unsigned int channels_min;      /* min channels */
 348         unsigned int channels_max;      /* max channels */
 349         unsigned int active:1;          /* stream is in use */
 350 };
 351
 352 /* SoC audio ops */
 353 struct snd_soc_ops {
 354         int (*startup)(struct snd_pcm_substream *);
 355         void (*shutdown)(struct snd_pcm_substream *);
 356         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 357         int (*hw_free)(struct snd_pcm_substream *);
 358         int (*prepare)(struct snd_pcm_substream *);
 359         int (*trigger)(struct snd_pcm_substream *, int);
 360 };
 361
 362 /* SoC Audio Codec */
 363 struct snd_soc_codec {
 364         char *name;
 365         struct module *owner;
 366         struct mutex mutex;
 367         struct device *dev;
 368         struct snd_soc_device *socdev;
 369
 370         struct list_head list;
 371
 372         /* callbacks */
 373         int (*set_bias_level)(struct snd_soc_codec *,
 374                               enum snd_soc_bias_level level);
 375
 376         /* runtime */
 377         struct snd_card *card;
 378         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
 379         unsigned int active;
 380         unsigned int pcm_devs;
 381         void *private_data;
 382
 383         /* codec IO */
 384         void *control_data; /* codec control (i2c/3wire) data */
 385         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 386         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 387         int (*display_register)(struct snd_soc_codec *, char *,
 388                                 size_t, unsigned int);
 389         int (*volatile_register)(unsigned int);
 390         int (*readable_register)(unsigned int);
 391         hw_write_t hw_write;
 392         unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
 393         void *reg_cache;
 394         short reg_cache_size;
 395         short reg_cache_step;
 396
 397         /* dapm */
 398         u32 pop_time;
 399         struct list_head dapm_widgets;
 400         struct list_head dapm_paths;
 401         enum snd_soc_bias_level bias_level;
 402         enum snd_soc_bias_level suspend_bias_level;
 403         struct delayed_work delayed_work;
 404
 405         /* codec DAI's */
 406         struct snd_soc_dai *dai;
 407         unsigned int num_dai;
 408
 409 #ifdef CONFIG_DEBUG_FS
 410         struct dentry *debugfs_codec_root;
 411         struct dentry *debugfs_reg;
 412         struct dentry *debugfs_pop_time;
 413         struct dentry *debugfs_dapm;
 414 #endif
 415 };
 416
 417 /* codec device */
 418 struct snd_soc_codec_device {
 419         int (*probe)(struct platform_device *pdev);
 420         int (*remove)(struct platform_device *pdev);
 421         int (*suspend)(struct platform_device *pdev, pm_message_t state);
 422         int (*resume)(struct platform_device *pdev);
 423 };
 424
 425 /* SoC platform interface */
 426 struct snd_soc_platform {
 427         char *name;
 428         struct list_head list;
 429
 430         int (*probe)(struct platform_device *pdev);
 431         int (*remove)(struct platform_device *pdev);
 432         int (*suspend)(struct snd_soc_dai *dai);
 433         int (*resume)(struct snd_soc_dai *dai);
 434
 435         /* pcm creation and destruction */
 436         int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
 437                 struct snd_pcm *);
 438         void (*pcm_free)(struct snd_pcm *);
 439
 440         /* platform stream ops */
 441         struct snd_pcm_ops *pcm_ops;
 442 };
 443
 444 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
 445 struct snd_soc_dai_link  {
 446         char *name;                     /* Codec name */
 447         char *stream_name;              /* Stream name */
 448
 449         /* DAI */
 450         struct snd_soc_dai *codec_dai;
 451         struct snd_soc_dai *cpu_dai;
 452
 453         /* machine stream operations */
 454         struct snd_soc_ops *ops;
 455
 456         /* codec/machine specific init - e.g. add machine controls */
 457         int (*init)(struct snd_soc_codec *codec);
 458
 459         /* Symmetry requirements */
 460         unsigned int symmetric_rates:1;
 461
 462         /* Symmetry data - only valid if symmetry is being enforced */
 463         unsigned int rate;
 464
 465         /* DAI pcm */
 466         struct snd_pcm *pcm;
 467 };
 468
 469 /* SoC card */
 470 struct snd_soc_card {
 471         char *name;
 472         struct device *dev;
 473
 474         struct list_head list;
 475
 476         int instantiated;
 477
 478         int (*probe)(struct platform_device *pdev);
 479         int (*remove)(struct platform_device *pdev);
 480
 481         /* the pre and post PM functions are used to do any PM work before and
 482          * after the codec and DAI's do any PM work. */
 483         int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
 484         int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
 485         int (*resume_pre)(struct platform_device *pdev);
 486         int (*resume_post)(struct platform_device *pdev);
 487
 488         /* callbacks */
 489         int (*set_bias_level)(struct snd_soc_card *,
 490                               enum snd_soc_bias_level level);
 491
 492         /* CPU <--> Codec DAI links  */
 493         struct snd_soc_dai_link *dai_link;
 494         int num_links;
 495
 496         struct snd_soc_device *socdev;
 497
 498         struct snd_soc_codec *codec;
 499
 500         struct snd_soc_platform *platform;
 501         struct delayed_work delayed_work;
 502         struct work_struct deferred_resume_work;
 503 };
 504
 505 /* SoC Device - the audio subsystem */
 506 struct snd_soc_device {
 507         struct device *dev;
 508         struct snd_soc_card *card;
 509         struct snd_soc_codec_device *codec_dev;
 510         void *codec_data;
 511 };
 512
 513 /* runtime channel data */
 514 struct snd_soc_pcm_runtime {
 515         struct snd_soc_dai_link *dai;
 516         struct snd_soc_device *socdev;
 517 };
 518
 519 /* mixer control */
 520 struct soc_mixer_control {
 521         int min, max;
 522         unsigned int reg, rreg, shift, rshift, invert;
 523 };
 524
 525 /* enumerated kcontrol */
 526 struct soc_enum {
 527         unsigned short reg;
 528         unsigned short reg2;
 529         unsigned char shift_l;
 530         unsigned char shift_r;
 531         unsigned int max;
 532         unsigned int mask;
 533         const char **texts;
 534         const unsigned int *values;
 535         void *dapm;
 536 };
 537
 538 /* codec IO */
 539 static inline unsigned int snd_soc_read(struct snd_soc_codec *codec,
 540                                         unsigned int reg)
 541 {
 542         return codec->read(codec, reg);
 543 }
 544
 545 static inline unsigned int snd_soc_write(struct snd_soc_codec *codec,
 546                                          unsigned int reg, unsigned int val)
 547 {
 548         return codec->write(codec, reg, val);
 549 }
 550
 551 #include <sound/soc-dai.h>
 552
 553 #endif