include/sound/soc.h

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