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