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_pcm_stream;
 226 struct snd_soc_ops;
 227 struct snd_soc_pcm_runtime;
 228 struct snd_soc_dai;
 229 struct snd_soc_dai_driver;
 230 struct snd_soc_platform;
 231 struct snd_soc_dai_link;
 232 struct snd_soc_platform_driver;
 233 struct snd_soc_codec;
 234 struct snd_soc_codec_driver;
 235 struct soc_enum;
 236 struct snd_soc_jack;
 237 struct snd_soc_jack_pin;
 238 struct snd_soc_cache_ops;
 239 #include <sound/soc-dapm.h>
 240
 241 #ifdef CONFIG_GPIOLIB
 242 struct snd_soc_jack_gpio;
 243 #endif
 244
 245 typedef int (*hw_write_t)(void *,const char* ,int);
 246
 247 extern struct snd_ac97_bus_ops soc_ac97_ops;
 248
 249 enum snd_soc_control_type {
 250         SND_SOC_CUSTOM,
 251         SND_SOC_I2C,
 252         SND_SOC_SPI,
 253 };
 254
 255 enum snd_soc_compress_type {
 256         SND_SOC_FLAT_COMPRESSION = 1,
 257         SND_SOC_LZO_COMPRESSION,
 258         SND_SOC_RBTREE_COMPRESSION
 259 };
 260
 261 int snd_soc_register_platform(struct device *dev,
 262                 struct snd_soc_platform_driver *platform_drv);
 263 void snd_soc_unregister_platform(struct device *dev);
 264 int snd_soc_register_codec(struct device *dev,
 265                 const struct snd_soc_codec_driver *codec_drv,
 266                 struct snd_soc_dai_driver *dai_drv, int num_dai);
 267 void snd_soc_unregister_codec(struct device *dev);
 268 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec, int reg);
 269 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
 270                                int addr_bits, int data_bits,
 271                                enum snd_soc_control_type control);
 272 int snd_soc_cache_sync(struct snd_soc_codec *codec);
 273 int snd_soc_cache_init(struct snd_soc_codec *codec);
 274 int snd_soc_cache_exit(struct snd_soc_codec *codec);
 275 int snd_soc_cache_write(struct snd_soc_codec *codec,
 276                         unsigned int reg, unsigned int value);
 277 int snd_soc_cache_read(struct snd_soc_codec *codec,
 278                        unsigned int reg, unsigned int *value);
 279 int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
 280                                       unsigned int reg);
 281 int snd_soc_default_readable_register(struct snd_soc_codec *codec,
 282                                       unsigned int reg);
 283
 284 /* Utility functions to get clock rates from various things */
 285 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 286 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 287 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 288 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 289
 290 /* set runtime hw params */
 291 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 292         const struct snd_pcm_hardware *hw);
 293
 294 /* Jack reporting */
 295 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
 296                      struct snd_soc_jack *jack);
 297 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 298 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 299                           struct snd_soc_jack_pin *pins);
 300 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
 301                                     struct notifier_block *nb);
 302 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
 303                                       struct notifier_block *nb);
 304 #ifdef CONFIG_GPIOLIB
 305 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 306                         struct snd_soc_jack_gpio *gpios);
 307 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 308                         struct snd_soc_jack_gpio *gpios);
 309 #endif
 310
 311 /* codec register bit access */
 312 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
 313                                 unsigned int mask, unsigned int value);
 314 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
 315                                unsigned short reg, unsigned int mask,
 316                                unsigned int value);
 317 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
 318                                 unsigned int mask, unsigned int value);
 319
 320 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
 321         struct snd_ac97_bus_ops *ops, int num);
 322 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
 323
 324 /*
 325  *Controls
 326  */
 327 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 328         void *data, char *long_name);
 329 int snd_soc_add_controls(struct snd_soc_codec *codec,
 330         const struct snd_kcontrol_new *controls, int num_controls);
 331 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 332         struct snd_ctl_elem_info *uinfo);
 333 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
 334         struct snd_ctl_elem_info *uinfo);
 335 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 336         struct snd_ctl_elem_value *ucontrol);
 337 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 338         struct snd_ctl_elem_value *ucontrol);
 339 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
 340         struct snd_ctl_elem_value *ucontrol);
 341 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
 342         struct snd_ctl_elem_value *ucontrol);
 343 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 344         struct snd_ctl_elem_info *uinfo);
 345 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
 346         struct snd_ctl_elem_info *uinfo);
 347 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 348 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 349         struct snd_ctl_elem_value *ucontrol);
 350 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 351         struct snd_ctl_elem_value *ucontrol);
 352 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
 353         struct snd_ctl_elem_info *uinfo);
 354 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
 355         struct snd_ctl_elem_value *ucontrol);
 356 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
 357         struct snd_ctl_elem_value *ucontrol);
 358 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
 359         struct snd_ctl_elem_info *uinfo);
 360 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
 361         struct snd_ctl_elem_value *ucontrol);
 362 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
 363         struct snd_ctl_elem_value *ucontrol);
 364 int snd_soc_limit_volume(struct snd_soc_codec *codec,
 365         const char *name, int max);
 366 int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol,
 367         struct snd_ctl_elem_info *uinfo);
 368 int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol,
 369         struct snd_ctl_elem_value *ucontrol);
 370 int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol,
 371         struct snd_ctl_elem_value *ucontrol);
 372
 373 /**
 374  * struct snd_soc_reg_access - Describes whether a given register is
 375  * readable, writable or volatile.
 376  *
 377  * @reg: the register number
 378  * @read: whether this register is readable
 379  * @write: whether this register is writable
 380  * @vol: whether this register is volatile
 381  */
 382 struct snd_soc_reg_access {
 383         u16 reg;
 384         u16 read;
 385         u16 write;
 386         u16 vol;
 387 };
 388
 389 /**
 390  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 391  *
 392  * @pin:    name of the pin to update
 393  * @mask:   bits to check for in reported jack status
 394  * @invert: if non-zero then pin is enabled when status is not reported
 395  */
 396 struct snd_soc_jack_pin {
 397         struct list_head list;
 398         const char *pin;
 399         int mask;
 400         bool invert;
 401 };
 402
 403 /**
 404  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 405  *
 406  * @gpio:         gpio number
 407  * @name:         gpio name
 408  * @report:       value to report when jack detected
 409  * @invert:       report presence in low state
 410  * @debouce_time: debouce time in ms
 411  */
 412 #ifdef CONFIG_GPIOLIB
 413 struct snd_soc_jack_gpio {
 414         unsigned int gpio;
 415         const char *name;
 416         int report;
 417         int invert;
 418         int debounce_time;
 419         struct snd_soc_jack *jack;
 420         struct delayed_work work;
 421
 422         int (*jack_status_check)(void);
 423 };
 424 #endif
 425
 426 struct snd_soc_jack {
 427         struct snd_jack *jack;
 428         struct snd_soc_codec *codec;
 429         struct list_head pins;
 430         int status;
 431         struct blocking_notifier_head notifier;
 432 };
 433
 434 /* SoC PCM stream information */
 435 struct snd_soc_pcm_stream {
 436         const char *stream_name;
 437         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 438         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 439         unsigned int rate_min;          /* min rate */
 440         unsigned int rate_max;          /* max rate */
 441         unsigned int channels_min;      /* min channels */
 442         unsigned int channels_max;      /* max channels */
 443 };
 444
 445 /* SoC audio ops */
 446 struct snd_soc_ops {
 447         int (*startup)(struct snd_pcm_substream *);
 448         void (*shutdown)(struct snd_pcm_substream *);
 449         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 450         int (*hw_free)(struct snd_pcm_substream *);
 451         int (*prepare)(struct snd_pcm_substream *);
 452         int (*trigger)(struct snd_pcm_substream *, int);
 453 };
 454
 455 /* SoC cache ops */
 456 struct snd_soc_cache_ops {
 457         const char *name;
 458         enum snd_soc_compress_type id;
 459         int (*init)(struct snd_soc_codec *codec);
 460         int (*exit)(struct snd_soc_codec *codec);
 461         int (*read)(struct snd_soc_codec *codec, unsigned int reg,
 462                 unsigned int *value);
 463         int (*write)(struct snd_soc_codec *codec, unsigned int reg,
 464                 unsigned int value);
 465         int (*sync)(struct snd_soc_codec *codec);
 466 };
 467
 468 /* SoC Audio Codec device */
 469 struct snd_soc_codec {
 470         const char *name;
 471         const char *name_prefix;
 472         int id;
 473         struct device *dev;
 474         const struct snd_soc_codec_driver *driver;
 475
 476         struct mutex mutex;
 477         struct snd_soc_card *card;
 478         struct list_head list;
 479         struct list_head card_list;
 480         int num_dai;
 481         enum snd_soc_compress_type compress_type;
 482         size_t reg_size;        /* reg_cache_size * reg_word_size */
 483
 484         /* runtime */
 485         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
 486         unsigned int active;
 487         unsigned int cache_only:1;  /* Suppress writes to hardware */
 488         unsigned int cache_sync:1; /* Cache needs to be synced to hardware */
 489         unsigned int suspended:1; /* Codec is in suspend PM state */
 490         unsigned int probed:1; /* Codec has been probed */
 491         unsigned int ac97_registered:1; /* Codec has been AC97 registered */
 492         unsigned int ac97_created:1; /* Codec has been created by SoC */
 493         unsigned int sysfs_registered:1; /* codec has been sysfs registered */
 494         unsigned int cache_init:1; /* codec cache has been initialized */
 495
 496         /* codec IO */
 497         void *control_data; /* codec control (i2c/3wire) data */
 498         hw_write_t hw_write;
 499         unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
 500         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 501         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 502         void *reg_cache;
 503         const void *reg_def_copy;
 504         const struct snd_soc_cache_ops *cache_ops;
 505         struct mutex cache_rw_mutex;
 506
 507         /* dapm */
 508         struct snd_soc_dapm_context dapm;
 509
 510 #ifdef CONFIG_DEBUG_FS
 511         struct dentry *debugfs_codec_root;
 512         struct dentry *debugfs_reg;
 513         struct dentry *debugfs_dapm;
 514 #endif
 515 };
 516
 517 /* codec driver */
 518 struct snd_soc_codec_driver {
 519
 520         /* driver ops */
 521         int (*probe)(struct snd_soc_codec *);
 522         int (*remove)(struct snd_soc_codec *);
 523         int (*suspend)(struct snd_soc_codec *,
 524                         pm_message_t state);
 525         int (*resume)(struct snd_soc_codec *);
 526
 527         /* codec IO */
 528         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 529         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 530         int (*display_register)(struct snd_soc_codec *, char *,
 531                                 size_t, unsigned int);
 532         int (*volatile_register)(struct snd_soc_codec *, unsigned int);
 533         int (*readable_register)(struct snd_soc_codec *, unsigned int);
 534         short reg_cache_size;
 535         short reg_cache_step;
 536         short reg_word_size;
 537         const void *reg_cache_default;
 538         short reg_access_size;
 539         const struct snd_soc_reg_access *reg_access_default;
 540         enum snd_soc_compress_type compress_type;
 541
 542         /* codec bias level */
 543         int (*set_bias_level)(struct snd_soc_codec *,
 544                               enum snd_soc_bias_level level);
 545 };
 546
 547 /* SoC platform interface */
 548 struct snd_soc_platform_driver {
 549
 550         int (*probe)(struct snd_soc_platform *);
 551         int (*remove)(struct snd_soc_platform *);
 552         int (*suspend)(struct snd_soc_dai *dai);
 553         int (*resume)(struct snd_soc_dai *dai);
 554
 555         /* pcm creation and destruction */
 556         int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
 557                 struct snd_pcm *);
 558         void (*pcm_free)(struct snd_pcm *);
 559
 560         /*
 561          * For platform caused delay reporting.
 562          * Optional.
 563          */
 564         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 565                 struct snd_soc_dai *);
 566
 567         /* platform stream ops */
 568         struct snd_pcm_ops *ops;
 569 };
 570
 571 struct snd_soc_platform {
 572         const char *name;
 573         int id;
 574         struct device *dev;
 575         struct snd_soc_platform_driver *driver;
 576
 577         unsigned int suspended:1; /* platform is suspended */
 578         unsigned int probed:1;
 579
 580         struct snd_soc_card *card;
 581         struct list_head list;
 582         struct list_head card_list;
 583 };
 584
 585 struct snd_soc_dai_link {
 586         /* config - must be set by machine driver */
 587         const char *name;                       /* Codec name */
 588         const char *stream_name;                /* Stream name */
 589         const char *codec_name;         /* for multi-codec */
 590         const char *platform_name;      /* for multi-platform */
 591         const char *cpu_dai_name;
 592         const char *codec_dai_name;
 593
 594         /* Keep DAI active over suspend */
 595         unsigned int ignore_suspend:1;
 596
 597         /* Symmetry requirements */
 598         unsigned int symmetric_rates:1;
 599
 600         /* codec/machine specific init - e.g. add machine controls */
 601         int (*init)(struct snd_soc_pcm_runtime *rtd);
 602
 603         /* machine stream operations */
 604         struct snd_soc_ops *ops;
 605 };
 606
 607 struct snd_soc_codec_conf {
 608         const char *dev_name;
 609
 610         /*
 611          * optional map of kcontrol, widget and path name prefixes that are
 612          * associated per device
 613          */
 614         const char *name_prefix;
 615
 616         /*
 617          * set this to the desired compression type if you want to
 618          * override the one supplied in codec->driver->compress_type
 619          */
 620         enum snd_soc_compress_type compress_type;
 621 };
 622
 623 struct snd_soc_aux_dev {
 624         const char *name;               /* Codec name */
 625         const char *codec_name;         /* for multi-codec */
 626
 627         /* codec/machine specific init - e.g. add machine controls */
 628         int (*init)(struct snd_soc_dapm_context *dapm);
 629 };
 630
 631 /* SoC card */
 632 struct snd_soc_card {
 633         const char *name;
 634         struct device *dev;
 635         struct snd_card *snd_card;
 636         struct module *owner;
 637
 638         struct list_head list;
 639         struct mutex mutex;
 640
 641         bool instantiated;
 642
 643         int (*probe)(struct platform_device *pdev);
 644         int (*remove)(struct platform_device *pdev);
 645
 646         /* the pre and post PM functions are used to do any PM work before and
 647          * after the codec and DAI's do any PM work. */
 648         int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
 649         int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
 650         int (*resume_pre)(struct platform_device *pdev);
 651         int (*resume_post)(struct platform_device *pdev);
 652
 653         /* callbacks */
 654         int (*set_bias_level)(struct snd_soc_card *,
 655                               enum snd_soc_bias_level level);
 656         int (*set_bias_level_post)(struct snd_soc_card *,
 657                                    enum snd_soc_bias_level level);
 658
 659         long pmdown_time;
 660
 661         /* CPU <--> Codec DAI links  */
 662         struct snd_soc_dai_link *dai_link;
 663         int num_links;
 664         struct snd_soc_pcm_runtime *rtd;
 665         int num_rtd;
 666
 667         /* optional codec specific configuration */
 668         struct snd_soc_codec_conf *codec_conf;
 669         int num_configs;
 670
 671         /*
 672          * optional auxiliary devices such as amplifiers or codecs with DAI
 673          * link unused
 674          */
 675         struct snd_soc_aux_dev *aux_dev;
 676         int num_aux_devs;
 677         struct snd_soc_pcm_runtime *rtd_aux;
 678         int num_aux_rtd;
 679
 680         struct work_struct deferred_resume_work;
 681
 682         /* lists of probed devices belonging to this card */
 683         struct list_head codec_dev_list;
 684         struct list_head platform_dev_list;
 685         struct list_head dai_dev_list;
 686
 687         struct list_head widgets;
 688         struct list_head paths;
 689         struct list_head dapm_list;
 690
 691 #ifdef CONFIG_DEBUG_FS
 692         struct dentry *debugfs_card_root;
 693         struct dentry *debugfs_pop_time;
 694 #endif
 695         u32 pop_time;
 696 };
 697
 698 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
 699 struct snd_soc_pcm_runtime  {
 700         struct device dev;
 701         struct snd_soc_card *card;
 702         struct snd_soc_dai_link *dai_link;
 703
 704         unsigned int complete:1;
 705         unsigned int dev_registered:1;
 706
 707         /* Symmetry data - only valid if symmetry is being enforced */
 708         unsigned int rate;
 709         long pmdown_time;
 710
 711         /* runtime devices */
 712         struct snd_pcm *pcm;
 713         struct snd_soc_codec *codec;
 714         struct snd_soc_platform *platform;
 715         struct snd_soc_dai *codec_dai;
 716         struct snd_soc_dai *cpu_dai;
 717
 718         struct delayed_work delayed_work;
 719 };
 720
 721 /* mixer control */
 722 struct soc_mixer_control {
 723         int min, max, platform_max;
 724         unsigned int reg, rreg, shift, rshift, invert;
 725 };
 726
 727 /* enumerated kcontrol */
 728 struct soc_enum {
 729         unsigned short reg;
 730         unsigned short reg2;
 731         unsigned char shift_l;
 732         unsigned char shift_r;
 733         unsigned int max;
 734         unsigned int mask;
 735         const char **texts;
 736         const unsigned int *values;
 737         void *dapm;
 738 };
 739
 740 /* codec IO */
 741 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
 742 unsigned int snd_soc_write(struct snd_soc_codec *codec,
 743                            unsigned int reg, unsigned int val);
 744
 745 /* device driver data */
 746
 747 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
 748                 void *data)
 749 {
 750         dev_set_drvdata(codec->dev, data);
 751 }
 752
 753 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
 754 {
 755         return dev_get_drvdata(codec->dev);
 756 }
 757
 758 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
 759                 void *data)
 760 {
 761         dev_set_drvdata(platform->dev, data);
 762 }
 763
 764 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
 765 {
 766         return dev_get_drvdata(platform->dev);
 767 }
 768
 769 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
 770                 void *data)
 771 {
 772         dev_set_drvdata(&rtd->dev, data);
 773 }
 774
 775 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
 776 {
 777         return dev_get_drvdata(&rtd->dev);
 778 }
 779
 780 #include <sound/soc-dai.h>
 781
 782 #ifdef CONFIG_DEBUG_FS
 783 extern struct dentry *snd_soc_debugfs_root;
 784 #endif
 785
 786 #endif