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