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 <linux/regmap.h>
  23 #include <sound/core.h>
  24 #include <sound/pcm.h>
  25 #include <sound/control.h>
  26 #include <sound/ac97_codec.h>
  27
  28 /*
  29  * Convenience kcontrol builders
  30  */
  31 #define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert) \
  32         ((unsigned long)&(struct soc_mixer_control) \
  33         {.reg = xreg, .rreg = xreg, .shift = shift_left, \
  34         .rshift = shift_right, .max = xmax, .platform_max = xmax, \
  35         .invert = xinvert})
  36 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
  37         SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert)
  38 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
  39         ((unsigned long)&(struct soc_mixer_control) \
  40         {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
  41 #define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
  42         ((unsigned long)&(struct soc_mixer_control) \
  43         {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  44         .max = xmax, .platform_max = xmax, .invert = xinvert})
  45 #define SOC_SINGLE(xname, reg, shift, max, invert) \
  46 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  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_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
  51 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  52         .info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
  53         .put = snd_soc_put_volsw_range, \
  54         .private_value = (unsigned long)&(struct soc_mixer_control) \
  55                 {.reg = xreg, .shift = xshift, .min = xmin,\
  56                  .max = xmax, .platform_max = xmax, .invert = xinvert} }
  57 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
  58 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  59         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  60                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  61         .tlv.p = (tlv_array), \
  62         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  63         .put = snd_soc_put_volsw, \
  64         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
  65 #define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
  66 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  67         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
  68         SNDRV_CTL_ELEM_ACCESS_READWRITE, \
  69         .tlv.p  = (tlv_array),\
  70         .info = snd_soc_info_volsw, \
  71         .get = snd_soc_get_volsw_sx,\
  72         .put = snd_soc_put_volsw_sx, \
  73         .private_value = (unsigned long)&(struct soc_mixer_control) \
  74                 {.reg = xreg, .rreg = xreg, \
  75                 .shift = xshift, .rshift = xshift, \
  76                 .max = xmax, .min = xmin} }
  77 #define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
  78 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  79         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  80                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  81         .tlv.p = (tlv_array), \
  82         .info = snd_soc_info_volsw_range, \
  83         .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
  84         .private_value = (unsigned long)&(struct soc_mixer_control) \
  85                 {.reg = xreg, .shift = xshift, .min = xmin,\
  86                  .max = xmax, .platform_max = xmax, .invert = xinvert} }
  87 #define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
  88 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  89         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
  90         .put = snd_soc_put_volsw, \
  91         .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
  92                                           max, invert) }
  93 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
  94 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
  95         .info = snd_soc_info_volsw, \
  96         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
  97         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
  98                                             xmax, xinvert) }
  99 #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
 100 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 101         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 102                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 103         .tlv.p = (tlv_array), \
 104         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
 105         .put = snd_soc_put_volsw, \
 106         .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
 107                                           max, invert) }
 108 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
 109 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 110         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 111                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 112         .tlv.p = (tlv_array), \
 113         .info = snd_soc_info_volsw, \
 114         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 115         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 116                                             xmax, xinvert) }
 117 #define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
 118 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 119         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 120         SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 121         .tlv.p  = (tlv_array), \
 122         .info = snd_soc_info_volsw, \
 123         .get = snd_soc_get_volsw_sx, \
 124         .put = snd_soc_put_volsw_sx, \
 125         .private_value = (unsigned long)&(struct soc_mixer_control) \
 126                 {.reg = xreg, .rreg = xrreg, \
 127                 .shift = xshift, .rshift = xshift, \
 128                 .max = xmax, .min = xmin} }
 129 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
 130 {       .iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 131         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 132                   SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 133         .tlv.p  = (tlv_array), \
 134         .info   = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
 135         .put    = snd_soc_put_volsw_s8, \
 136         .private_value = (unsigned long)&(struct soc_mixer_control) \
 137                 {.reg = xreg, .min = xmin, .max = xmax, \
 138                  .platform_max = xmax} }
 139 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
 140 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 141         .max = xmax, .texts = xtexts }
 142 #define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
 143         SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
 144 #define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
 145 {       .max = xmax, .texts = xtexts }
 146 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
 147 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 148         .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
 149 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
 150         SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
 151 #define SOC_ENUM(xname, xenum) \
 152 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
 153         .info = snd_soc_info_enum_double, \
 154         .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
 155         .private_value = (unsigned long)&xenum }
 156 #define SOC_VALUE_ENUM(xname, xenum) \
 157 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
 158         .info = snd_soc_info_enum_double, \
 159         .get = snd_soc_get_value_enum_double, \
 160         .put = snd_soc_put_value_enum_double, \
 161         .private_value = (unsigned long)&xenum }
 162 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
 163          xhandler_get, xhandler_put) \
 164 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 165         .info = snd_soc_info_volsw, \
 166         .get = xhandler_get, .put = xhandler_put, \
 167         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
 168 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
 169          xhandler_get, xhandler_put) \
 170 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 171         .info = snd_soc_info_volsw, \
 172         .get = xhandler_get, .put = xhandler_put, \
 173         .private_value = \
 174                 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert) }
 175 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
 176          xhandler_get, xhandler_put, tlv_array) \
 177 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 178         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 179                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 180         .tlv.p = (tlv_array), \
 181         .info = snd_soc_info_volsw, \
 182         .get = xhandler_get, .put = xhandler_put, \
 183         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
 184 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
 185          xhandler_get, xhandler_put, tlv_array) \
 186 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 187         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 188                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 189         .tlv.p = (tlv_array), \
 190         .info = snd_soc_info_volsw, \
 191         .get = xhandler_get, .put = xhandler_put, \
 192         .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
 193                                           xmax, xinvert) }
 194 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
 195          xhandler_get, xhandler_put, tlv_array) \
 196 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 197         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 198                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 199         .tlv.p = (tlv_array), \
 200         .info = snd_soc_info_volsw, \
 201         .get = xhandler_get, .put = xhandler_put, \
 202         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 203                                             xmax, xinvert) }
 204 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
 205 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 206         .info = snd_soc_info_bool_ext, \
 207         .get = xhandler_get, .put = xhandler_put, \
 208         .private_value = xdata }
 209 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 210 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 211         .info = snd_soc_info_enum_ext, \
 212         .get = xhandler_get, .put = xhandler_put, \
 213         .private_value = (unsigned long)&xenum }
 214
 215 #define SND_SOC_BYTES(xname, xbase, xregs)                    \
 216 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
 217         .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
 218         .put = snd_soc_bytes_put, .private_value =            \
 219                 ((unsigned long)&(struct soc_bytes)           \
 220                 {.base = xbase, .num_regs = xregs }) }
 221
 222 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask)        \
 223 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
 224         .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
 225         .put = snd_soc_bytes_put, .private_value =            \
 226                 ((unsigned long)&(struct soc_bytes)           \
 227                 {.base = xbase, .num_regs = xregs,            \
 228                  .mask = xmask }) }
 229
 230 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
 231                 xmin, xmax, xinvert) \
 232 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 233         .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
 234         .put = snd_soc_put_xr_sx, \
 235         .private_value = (unsigned long)&(struct soc_mreg_control) \
 236                 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
 237                 .invert = xinvert, .min = xmin, .max = xmax} }
 238
 239 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
 240         SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
 241                 snd_soc_get_strobe, snd_soc_put_strobe)
 242
 243 /*
 244  * Simplified versions of above macros, declaring a struct and calculating
 245  * ARRAY_SIZE internally
 246  */
 247 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
 248         struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
 249                                                 ARRAY_SIZE(xtexts), xtexts)
 250 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
 251         SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
 252 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
 253         struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
 254 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
 255         struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
 256                                                         ARRAY_SIZE(xtexts), xtexts, xvalues)
 257 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
 258         SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
 259
 260 /*
 261  * Component probe and remove ordering levels for components with runtime
 262  * dependencies.
 263  */
 264 #define SND_SOC_COMP_ORDER_FIRST                -2
 265 #define SND_SOC_COMP_ORDER_EARLY                -1
 266 #define SND_SOC_COMP_ORDER_NORMAL               0
 267 #define SND_SOC_COMP_ORDER_LATE         1
 268 #define SND_SOC_COMP_ORDER_LAST         2
 269
 270 /*
 271  * Bias levels
 272  *
 273  * @ON:      Bias is fully on for audio playback and capture operations.
 274  * @PREPARE: Prepare for audio operations. Called before DAPM switching for
 275  *           stream start and stop operations.
 276  * @STANDBY: Low power standby state when no playback/capture operations are
 277  *           in progress. NOTE: The transition time between STANDBY and ON
 278  *           should be as fast as possible and no longer than 10ms.
 279  * @OFF:     Power Off. No restrictions on transition times.
 280  */
 281 enum snd_soc_bias_level {
 282         SND_SOC_BIAS_OFF = 0,
 283         SND_SOC_BIAS_STANDBY = 1,
 284         SND_SOC_BIAS_PREPARE = 2,
 285         SND_SOC_BIAS_ON = 3,
 286 };
 287
 288 struct device_node;
 289 struct snd_jack;
 290 struct snd_soc_card;
 291 struct snd_soc_pcm_stream;
 292 struct snd_soc_ops;
 293 struct snd_soc_pcm_runtime;
 294 struct snd_soc_dai;
 295 struct snd_soc_dai_driver;
 296 struct snd_soc_platform;
 297 struct snd_soc_dai_link;
 298 struct snd_soc_platform_driver;
 299 struct snd_soc_codec;
 300 struct snd_soc_codec_driver;
 301 struct soc_enum;
 302 struct snd_soc_jack;
 303 struct snd_soc_jack_zone;
 304 struct snd_soc_jack_pin;
 305 struct snd_soc_cache_ops;
 306 #include <sound/soc-dapm.h>
 307 #include <sound/soc-dpcm.h>
 308
 309 #ifdef CONFIG_GPIOLIB
 310 struct snd_soc_jack_gpio;
 311 #endif
 312
 313 typedef int (*hw_write_t)(void *,const char* ,int);
 314
 315 extern struct snd_ac97_bus_ops soc_ac97_ops;
 316
 317 enum snd_soc_control_type {
 318         SND_SOC_I2C = 1,
 319         SND_SOC_SPI,
 320         SND_SOC_REGMAP,
 321 };
 322
 323 enum snd_soc_compress_type {
 324         SND_SOC_FLAT_COMPRESSION = 1,
 325 };
 326
 327 enum snd_soc_pcm_subclass {
 328         SND_SOC_PCM_CLASS_PCM   = 0,
 329         SND_SOC_PCM_CLASS_BE    = 1,
 330 };
 331
 332 enum snd_soc_card_subclass {
 333         SND_SOC_CARD_CLASS_INIT         = 0,
 334         SND_SOC_CARD_CLASS_RUNTIME      = 1,
 335 };
 336
 337 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
 338                              int source, unsigned int freq, int dir);
 339 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
 340                           unsigned int freq_in, unsigned int freq_out);
 341
 342 int snd_soc_register_card(struct snd_soc_card *card);
 343 int snd_soc_unregister_card(struct snd_soc_card *card);
 344 int snd_soc_suspend(struct device *dev);
 345 int snd_soc_resume(struct device *dev);
 346 int snd_soc_poweroff(struct device *dev);
 347 int snd_soc_register_platform(struct device *dev,
 348                 struct snd_soc_platform_driver *platform_drv);
 349 void snd_soc_unregister_platform(struct device *dev);
 350 int snd_soc_register_codec(struct device *dev,
 351                 const struct snd_soc_codec_driver *codec_drv,
 352                 struct snd_soc_dai_driver *dai_drv, int num_dai);
 353 void snd_soc_unregister_codec(struct device *dev);
 354 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
 355                                     unsigned int reg);
 356 int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
 357                                     unsigned int reg);
 358 int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
 359                                     unsigned int reg);
 360 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
 361                                int addr_bits, int data_bits,
 362                                enum snd_soc_control_type control);
 363 int snd_soc_cache_sync(struct snd_soc_codec *codec);
 364 int snd_soc_cache_init(struct snd_soc_codec *codec);
 365 int snd_soc_cache_exit(struct snd_soc_codec *codec);
 366 int snd_soc_cache_write(struct snd_soc_codec *codec,
 367                         unsigned int reg, unsigned int value);
 368 int snd_soc_cache_read(struct snd_soc_codec *codec,
 369                        unsigned int reg, unsigned int *value);
 370 int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
 371                                       unsigned int reg);
 372 int snd_soc_default_readable_register(struct snd_soc_codec *codec,
 373                                       unsigned int reg);
 374 int snd_soc_default_writable_register(struct snd_soc_codec *codec,
 375                                       unsigned int reg);
 376 int snd_soc_platform_read(struct snd_soc_platform *platform,
 377                                         unsigned int reg);
 378 int snd_soc_platform_write(struct snd_soc_platform *platform,
 379                                         unsigned int reg, unsigned int val);
 380 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
 381
 382 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
 383                 const char *dai_link, int stream);
 384 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
 385                 const char *dai_link);
 386
 387 /* Utility functions to get clock rates from various things */
 388 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 389 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 390 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 391 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 392
 393 /* set runtime hw params */
 394 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 395         const struct snd_pcm_hardware *hw);
 396
 397 int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
 398                 int cmd, struct snd_soc_platform *platform);
 399
 400 /* Jack reporting */
 401 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
 402                      struct snd_soc_jack *jack);
 403 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 404 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 405                           struct snd_soc_jack_pin *pins);
 406 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
 407                                     struct notifier_block *nb);
 408 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
 409                                       struct notifier_block *nb);
 410 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
 411                           struct snd_soc_jack_zone *zones);
 412 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
 413 #ifdef CONFIG_GPIOLIB
 414 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 415                         struct snd_soc_jack_gpio *gpios);
 416 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 417                         struct snd_soc_jack_gpio *gpios);
 418 #endif
 419
 420 /* codec register bit access */
 421 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
 422                                 unsigned int mask, unsigned int value);
 423 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
 424                                unsigned short reg, unsigned int mask,
 425                                unsigned int value);
 426 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
 427                                 unsigned int mask, unsigned int value);
 428
 429 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
 430         struct snd_ac97_bus_ops *ops, int num);
 431 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
 432
 433 /*
 434  *Controls
 435  */
 436 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 437                                   void *data, const char *long_name,
 438                                   const char *prefix);
 439 int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
 440         const struct snd_kcontrol_new *controls, int num_controls);
 441 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
 442         const struct snd_kcontrol_new *controls, int num_controls);
 443 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
 444         const struct snd_kcontrol_new *controls, int num_controls);
 445 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
 446         const struct snd_kcontrol_new *controls, int num_controls);
 447 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 448         struct snd_ctl_elem_info *uinfo);
 449 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
 450         struct snd_ctl_elem_info *uinfo);
 451 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 452         struct snd_ctl_elem_value *ucontrol);
 453 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 454         struct snd_ctl_elem_value *ucontrol);
 455 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
 456         struct snd_ctl_elem_value *ucontrol);
 457 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
 458         struct snd_ctl_elem_value *ucontrol);
 459 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 460         struct snd_ctl_elem_info *uinfo);
 461 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
 462         struct snd_ctl_elem_info *uinfo);
 463 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 464 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 465         struct snd_ctl_elem_value *ucontrol);
 466 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 467         struct snd_ctl_elem_value *ucontrol);
 468 #define snd_soc_get_volsw_2r snd_soc_get_volsw
 469 #define snd_soc_put_volsw_2r snd_soc_put_volsw
 470 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
 471         struct snd_ctl_elem_value *ucontrol);
 472 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
 473         struct snd_ctl_elem_value *ucontrol);
 474 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
 475         struct snd_ctl_elem_info *uinfo);
 476 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
 477         struct snd_ctl_elem_value *ucontrol);
 478 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
 479         struct snd_ctl_elem_value *ucontrol);
 480 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
 481         struct snd_ctl_elem_info *uinfo);
 482 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
 483         struct snd_ctl_elem_value *ucontrol);
 484 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
 485         struct snd_ctl_elem_value *ucontrol);
 486 int snd_soc_limit_volume(struct snd_soc_codec *codec,
 487         const char *name, int max);
 488 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
 489                        struct snd_ctl_elem_info *uinfo);
 490 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
 491                       struct snd_ctl_elem_value *ucontrol);
 492 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
 493                       struct snd_ctl_elem_value *ucontrol);
 494 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
 495         struct snd_ctl_elem_info *uinfo);
 496 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
 497         struct snd_ctl_elem_value *ucontrol);
 498 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
 499         struct snd_ctl_elem_value *ucontrol);
 500 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
 501         struct snd_ctl_elem_value *ucontrol);
 502 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
 503         struct snd_ctl_elem_value *ucontrol);
 504
 505 /**
 506  * struct snd_soc_reg_access - Describes whether a given register is
 507  * readable, writable or volatile.
 508  *
 509  * @reg: the register number
 510  * @read: whether this register is readable
 511  * @write: whether this register is writable
 512  * @vol: whether this register is volatile
 513  */
 514 struct snd_soc_reg_access {
 515         u16 reg;
 516         u16 read;
 517         u16 write;
 518         u16 vol;
 519 };
 520
 521 /**
 522  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 523  *
 524  * @pin:    name of the pin to update
 525  * @mask:   bits to check for in reported jack status
 526  * @invert: if non-zero then pin is enabled when status is not reported
 527  */
 528 struct snd_soc_jack_pin {
 529         struct list_head list;
 530         const char *pin;
 531         int mask;
 532         bool invert;
 533 };
 534
 535 /**
 536  * struct snd_soc_jack_zone - Describes voltage zones of jack detection
 537  *
 538  * @min_mv: start voltage in mv
 539  * @max_mv: end voltage in mv
 540  * @jack_type: type of jack that is expected for this voltage
 541  * @debounce_time: debounce_time for jack, codec driver should wait for this
 542  *              duration before reading the adc for voltages
 543  * @:list: list container
 544  */
 545 struct snd_soc_jack_zone {
 546         unsigned int min_mv;
 547         unsigned int max_mv;
 548         unsigned int jack_type;
 549         unsigned int debounce_time;
 550         struct list_head list;
 551 };
 552
 553 /**
 554  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 555  *
 556  * @gpio:         gpio number
 557  * @name:         gpio name
 558  * @report:       value to report when jack detected
 559  * @invert:       report presence in low state
 560  * @debouce_time: debouce time in ms
 561  * @wake:         enable as wake source
 562  * @jack_status_check: callback function which overrides the detection
 563  *                     to provide more complex checks (eg, reading an
 564  *                     ADC).
 565  */
 566 #ifdef CONFIG_GPIOLIB
 567 struct snd_soc_jack_gpio {
 568         unsigned int gpio;
 569         const char *name;
 570         int report;
 571         int invert;
 572         int debounce_time;
 573         bool wake;
 574
 575         struct snd_soc_jack *jack;
 576         struct delayed_work work;
 577
 578         int (*jack_status_check)(void);
 579 };
 580 #endif
 581
 582 struct snd_soc_jack {
 583         struct mutex mutex;
 584         struct snd_jack *jack;
 585         struct snd_soc_codec *codec;
 586         struct list_head pins;
 587         int status;
 588         struct blocking_notifier_head notifier;
 589         struct list_head jack_zones;
 590 };
 591
 592 /* SoC PCM stream information */
 593 struct snd_soc_pcm_stream {
 594         const char *stream_name;
 595         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 596         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 597         unsigned int rate_min;          /* min rate */
 598         unsigned int rate_max;          /* max rate */
 599         unsigned int channels_min;      /* min channels */
 600         unsigned int channels_max;      /* max channels */
 601         unsigned int sig_bits;          /* number of bits of content */
 602 };
 603
 604 /* SoC audio ops */
 605 struct snd_soc_ops {
 606         int (*startup)(struct snd_pcm_substream *);
 607         void (*shutdown)(struct snd_pcm_substream *);
 608         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 609         int (*hw_free)(struct snd_pcm_substream *);
 610         int (*prepare)(struct snd_pcm_substream *);
 611         int (*trigger)(struct snd_pcm_substream *, int);
 612 };
 613
 614 /* SoC cache ops */
 615 struct snd_soc_cache_ops {
 616         const char *name;
 617         enum snd_soc_compress_type id;
 618         int (*init)(struct snd_soc_codec *codec);
 619         int (*exit)(struct snd_soc_codec *codec);
 620         int (*read)(struct snd_soc_codec *codec, unsigned int reg,
 621                 unsigned int *value);
 622         int (*write)(struct snd_soc_codec *codec, unsigned int reg,
 623                 unsigned int value);
 624         int (*sync)(struct snd_soc_codec *codec);
 625 };
 626
 627 /* SoC Audio Codec device */
 628 struct snd_soc_codec {
 629         const char *name;
 630         const char *name_prefix;
 631         int id;
 632         struct device *dev;
 633         const struct snd_soc_codec_driver *driver;
 634
 635         struct mutex mutex;
 636         struct snd_soc_card *card;
 637         struct list_head list;
 638         struct list_head card_list;
 639         int num_dai;
 640         enum snd_soc_compress_type compress_type;
 641         size_t reg_size;        /* reg_cache_size * reg_word_size */
 642         int (*volatile_register)(struct snd_soc_codec *, unsigned int);
 643         int (*readable_register)(struct snd_soc_codec *, unsigned int);
 644         int (*writable_register)(struct snd_soc_codec *, unsigned int);
 645
 646         /* runtime */
 647         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
 648         unsigned int active;
 649         unsigned int cache_bypass:1; /* Suppress access to the cache */
 650         unsigned int suspended:1; /* Codec is in suspend PM state */
 651         unsigned int probed:1; /* Codec has been probed */
 652         unsigned int ac97_registered:1; /* Codec has been AC97 registered */
 653         unsigned int ac97_created:1; /* Codec has been created by SoC */
 654         unsigned int sysfs_registered:1; /* codec has been sysfs registered */
 655         unsigned int cache_init:1; /* codec cache has been initialized */
 656         unsigned int using_regmap:1; /* using regmap access */
 657         u32 cache_only;  /* Suppress writes to hardware */
 658         u32 cache_sync; /* Cache needs to be synced to hardware */
 659
 660         /* codec IO */
 661         void *control_data; /* codec control (i2c/3wire) data */
 662         enum snd_soc_control_type control_type;
 663         hw_write_t hw_write;
 664         unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
 665         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 666         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 667         int (*bulk_write_raw)(struct snd_soc_codec *, unsigned int, const void *, size_t);
 668         void *reg_cache;
 669         const void *reg_def_copy;
 670         const struct snd_soc_cache_ops *cache_ops;
 671         struct mutex cache_rw_mutex;
 672         int val_bytes;
 673
 674         /* dapm */
 675         struct snd_soc_dapm_context dapm;
 676         unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
 677
 678 #ifdef CONFIG_DEBUG_FS
 679         struct dentry *debugfs_codec_root;
 680         struct dentry *debugfs_reg;
 681         struct dentry *debugfs_dapm;
 682 #endif
 683 };
 684
 685 /* codec driver */
 686 struct snd_soc_codec_driver {
 687
 688         /* driver ops */
 689         int (*probe)(struct snd_soc_codec *);
 690         int (*remove)(struct snd_soc_codec *);
 691         int (*suspend)(struct snd_soc_codec *);
 692         int (*resume)(struct snd_soc_codec *);
 693
 694         /* Default control and setup, added after probe() is run */
 695         const struct snd_kcontrol_new *controls;
 696         int num_controls;
 697         const struct snd_soc_dapm_widget *dapm_widgets;
 698         int num_dapm_widgets;
 699         const struct snd_soc_dapm_route *dapm_routes;
 700         int num_dapm_routes;
 701
 702         /* codec wide operations */
 703         int (*set_sysclk)(struct snd_soc_codec *codec,
 704                           int clk_id, int source, unsigned int freq, int dir);
 705         int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
 706                 unsigned int freq_in, unsigned int freq_out);
 707
 708         /* codec IO */
 709         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 710         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 711         int (*display_register)(struct snd_soc_codec *, char *,
 712                                 size_t, unsigned int);
 713         int (*volatile_register)(struct snd_soc_codec *, unsigned int);
 714         int (*readable_register)(struct snd_soc_codec *, unsigned int);
 715         int (*writable_register)(struct snd_soc_codec *, unsigned int);
 716         unsigned int reg_cache_size;
 717         short reg_cache_step;
 718         short reg_word_size;
 719         const void *reg_cache_default;
 720         short reg_access_size;
 721         const struct snd_soc_reg_access *reg_access_default;
 722         enum snd_soc_compress_type compress_type;
 723
 724         /* codec bias level */
 725         int (*set_bias_level)(struct snd_soc_codec *,
 726                               enum snd_soc_bias_level level);
 727         bool idle_bias_off;
 728
 729         void (*seq_notifier)(struct snd_soc_dapm_context *,
 730                              enum snd_soc_dapm_type, int);
 731
 732         /* codec stream completion event */
 733         int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
 734
 735         bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */
 736
 737         /* probe ordering - for components with runtime dependencies */
 738         int probe_order;
 739         int remove_order;
 740 };
 741
 742 /* SoC platform interface */
 743 struct snd_soc_platform_driver {
 744
 745         int (*probe)(struct snd_soc_platform *);
 746         int (*remove)(struct snd_soc_platform *);
 747         int (*suspend)(struct snd_soc_dai *dai);
 748         int (*resume)(struct snd_soc_dai *dai);
 749
 750         /* pcm creation and destruction */
 751         int (*pcm_new)(struct snd_soc_pcm_runtime *);
 752         void (*pcm_free)(struct snd_pcm *);
 753
 754         /* Default control and setup, added after probe() is run */
 755         const struct snd_kcontrol_new *controls;
 756         int num_controls;
 757         const struct snd_soc_dapm_widget *dapm_widgets;
 758         int num_dapm_widgets;
 759         const struct snd_soc_dapm_route *dapm_routes;
 760         int num_dapm_routes;
 761
 762         /*
 763          * For platform caused delay reporting.
 764          * Optional.
 765          */
 766         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 767                 struct snd_soc_dai *);
 768
 769         /* platform stream ops */
 770         struct snd_pcm_ops *ops;
 771
 772         /* platform stream completion event */
 773         int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
 774
 775         /* probe ordering - for components with runtime dependencies */
 776         int probe_order;
 777         int remove_order;
 778
 779         /* platform IO - used for platform DAPM */
 780         unsigned int (*read)(struct snd_soc_platform *, unsigned int);
 781         int (*write)(struct snd_soc_platform *, unsigned int, unsigned int);
 782         int (*bespoke_trigger)(struct snd_pcm_substream *, int);
 783 };
 784
 785 struct snd_soc_platform {
 786         const char *name;
 787         int id;
 788         struct device *dev;
 789         struct snd_soc_platform_driver *driver;
 790         struct mutex mutex;
 791
 792         unsigned int suspended:1; /* platform is suspended */
 793         unsigned int probed:1;
 794
 795         struct snd_soc_card *card;
 796         struct list_head list;
 797         struct list_head card_list;
 798
 799         struct snd_soc_dapm_context dapm;
 800
 801 #ifdef CONFIG_DEBUG_FS
 802         struct dentry *debugfs_platform_root;
 803         struct dentry *debugfs_dapm;
 804 #endif
 805 };
 806
 807 struct snd_soc_dai_link {
 808         /* config - must be set by machine driver */
 809         const char *name;                       /* Codec name */
 810         const char *stream_name;                /* Stream name */
 811         /*
 812          * You MAY specify the link's CPU-side device, either by device name,
 813          * or by DT/OF node, but not both. If this information is omitted,
 814          * the CPU-side DAI is matched using .cpu_dai_name only, which hence
 815          * must be globally unique. These fields are currently typically used
 816          * only for codec to codec links, or systems using device tree.
 817          */
 818         const char *cpu_name;
 819         const struct device_node *cpu_of_node;
 820         /*
 821          * You MAY specify the DAI name of the CPU DAI. If this information is
 822          * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
 823          * only, which only works well when that device exposes a single DAI.
 824          */
 825         const char *cpu_dai_name;
 826         /*
 827          * You MUST specify the link's codec, either by device name, or by
 828          * DT/OF node, but not both.
 829          */
 830         const char *codec_name;
 831         const struct device_node *codec_of_node;
 832         /* You MUST specify the DAI name within the codec */
 833         const char *codec_dai_name;
 834         /*
 835          * You MAY specify the link's platform/PCM/DMA driver, either by
 836          * device name, or by DT/OF node, but not both. Some forms of link
 837          * do not need a platform.
 838          */
 839         const char *platform_name;
 840         const struct device_node *platform_of_node;
 841         int be_id;      /* optional ID for machine driver BE identification */
 842
 843         const struct snd_soc_pcm_stream *params;
 844
 845         unsigned int dai_fmt;           /* format to set on init */
 846
 847         enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
 848
 849         /* Keep DAI active over suspend */
 850         unsigned int ignore_suspend:1;
 851
 852         /* Symmetry requirements */
 853         unsigned int symmetric_rates:1;
 854
 855         /* Do not create a PCM for this DAI link (Backend link) */
 856         unsigned int no_pcm:1;
 857
 858         /* This DAI link can route to other DAI links at runtime (Frontend)*/
 859         unsigned int dynamic:1;
 860
 861         /* pmdown_time is ignored at stop */
 862         unsigned int ignore_pmdown_time:1;
 863
 864         /* codec/machine specific init - e.g. add machine controls */
 865         int (*init)(struct snd_soc_pcm_runtime *rtd);
 866
 867         /* optional hw_params re-writing for BE and FE sync */
 868         int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
 869                         struct snd_pcm_hw_params *params);
 870
 871         /* machine stream operations */
 872         struct snd_soc_ops *ops;
 873 };
 874
 875 struct snd_soc_codec_conf {
 876         const char *dev_name;
 877
 878         /*
 879          * optional map of kcontrol, widget and path name prefixes that are
 880          * associated per device
 881          */
 882         const char *name_prefix;
 883
 884         /*
 885          * set this to the desired compression type if you want to
 886          * override the one supplied in codec->driver->compress_type
 887          */
 888         enum snd_soc_compress_type compress_type;
 889 };
 890
 891 struct snd_soc_aux_dev {
 892         const char *name;               /* Codec name */
 893         const char *codec_name;         /* for multi-codec */
 894
 895         /* codec/machine specific init - e.g. add machine controls */
 896         int (*init)(struct snd_soc_dapm_context *dapm);
 897 };
 898
 899 /* SoC card */
 900 struct snd_soc_card {
 901         const char *name;
 902         const char *long_name;
 903         const char *driver_name;
 904         struct device *dev;
 905         struct snd_card *snd_card;
 906         struct module *owner;
 907
 908         struct list_head list;
 909         struct mutex mutex;
 910         struct mutex dapm_mutex;
 911
 912         bool instantiated;
 913
 914         int (*probe)(struct snd_soc_card *card);
 915         int (*late_probe)(struct snd_soc_card *card);
 916         int (*remove)(struct snd_soc_card *card);
 917
 918         /* the pre and post PM functions are used to do any PM work before and
 919          * after the codec and DAI's do any PM work. */
 920         int (*suspend_pre)(struct snd_soc_card *card);
 921         int (*suspend_post)(struct snd_soc_card *card);
 922         int (*resume_pre)(struct snd_soc_card *card);
 923         int (*resume_post)(struct snd_soc_card *card);
 924
 925         /* callbacks */
 926         int (*set_bias_level)(struct snd_soc_card *,
 927                               struct snd_soc_dapm_context *dapm,
 928                               enum snd_soc_bias_level level);
 929         int (*set_bias_level_post)(struct snd_soc_card *,
 930                                    struct snd_soc_dapm_context *dapm,
 931                                    enum snd_soc_bias_level level);
 932
 933         long pmdown_time;
 934
 935         /* CPU <--> Codec DAI links  */
 936         struct snd_soc_dai_link *dai_link;
 937         int num_links;
 938         struct snd_soc_pcm_runtime *rtd;
 939         int num_rtd;
 940
 941         /* optional codec specific configuration */
 942         struct snd_soc_codec_conf *codec_conf;
 943         int num_configs;
 944
 945         /*
 946          * optional auxiliary devices such as amplifiers or codecs with DAI
 947          * link unused
 948          */
 949         struct snd_soc_aux_dev *aux_dev;
 950         int num_aux_devs;
 951         struct snd_soc_pcm_runtime *rtd_aux;
 952         int num_aux_rtd;
 953
 954         const struct snd_kcontrol_new *controls;
 955         int num_controls;
 956
 957         /*
 958          * Card-specific routes and widgets.
 959          */
 960         const struct snd_soc_dapm_widget *dapm_widgets;
 961         int num_dapm_widgets;
 962         const struct snd_soc_dapm_route *dapm_routes;
 963         int num_dapm_routes;
 964         bool fully_routed;
 965
 966         struct work_struct deferred_resume_work;
 967
 968         /* lists of probed devices belonging to this card */
 969         struct list_head codec_dev_list;
 970         struct list_head platform_dev_list;
 971         struct list_head dai_dev_list;
 972
 973         struct list_head widgets;
 974         struct list_head paths;
 975         struct list_head dapm_list;
 976         struct list_head dapm_dirty;
 977
 978         /* Generic DAPM context for the card */
 979         struct snd_soc_dapm_context dapm;
 980         struct snd_soc_dapm_stats dapm_stats;
 981
 982 #ifdef CONFIG_DEBUG_FS
 983         struct dentry *debugfs_card_root;
 984         struct dentry *debugfs_pop_time;
 985 #endif
 986         u32 pop_time;
 987
 988         void *drvdata;
 989 };
 990
 991 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
 992 struct snd_soc_pcm_runtime {
 993         struct device *dev;
 994         struct snd_soc_card *card;
 995         struct snd_soc_dai_link *dai_link;
 996         struct mutex pcm_mutex;
 997         enum snd_soc_pcm_subclass pcm_subclass;
 998         struct snd_pcm_ops ops;
 999
1000         unsigned int dev_registered:1;
1001
1002         /* Dynamic PCM BE runtime data */
1003         struct snd_soc_dpcm_runtime dpcm[2];
1004
1005         long pmdown_time;
1006
1007         /* runtime devices */
1008         struct snd_pcm *pcm;
1009         struct snd_soc_codec *codec;
1010         struct snd_soc_platform *platform;
1011         struct snd_soc_dai *codec_dai;
1012         struct snd_soc_dai *cpu_dai;
1013
1014         struct delayed_work delayed_work;
1015 #ifdef CONFIG_DEBUG_FS
1016         struct dentry *debugfs_dpcm_root;
1017         struct dentry *debugfs_dpcm_state;
1018 #endif
1019 };
1020
1021 /* mixer control */
1022 struct soc_mixer_control {
1023         int min, max, platform_max;
1024         unsigned int reg, rreg, shift, rshift, invert;
1025 };
1026
1027 struct soc_bytes {
1028         int base;
1029         int num_regs;
1030         u32 mask;
1031 };
1032
1033 /* multi register control */
1034 struct soc_mreg_control {
1035         long min, max;
1036         unsigned int regbase, regcount, nbits, invert;
1037 };
1038
1039 /* enumerated kcontrol */
1040 struct soc_enum {
1041         unsigned short reg;
1042         unsigned short reg2;
1043         unsigned char shift_l;
1044         unsigned char shift_r;
1045         unsigned int max;
1046         unsigned int mask;
1047         const char * const *texts;
1048         const unsigned int *values;
1049         void *dapm;
1050 };
1051
1052 /* codec IO */
1053 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1054 unsigned int snd_soc_write(struct snd_soc_codec *codec,
1055                            unsigned int reg, unsigned int val);
1056 unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
1057                                     unsigned int reg, const void *data, size_t len);
1058
1059 /* device driver data */
1060
1061 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1062                 void *data)
1063 {
1064         card->drvdata = data;
1065 }
1066
1067 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1068 {
1069         return card->drvdata;
1070 }
1071
1072 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1073                 void *data)
1074 {
1075         dev_set_drvdata(codec->dev, data);
1076 }
1077
1078 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1079 {
1080         return dev_get_drvdata(codec->dev);
1081 }
1082
1083 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1084                 void *data)
1085 {
1086         dev_set_drvdata(platform->dev, data);
1087 }
1088
1089 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1090 {
1091         return dev_get_drvdata(platform->dev);
1092 }
1093
1094 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1095                 void *data)
1096 {
1097         dev_set_drvdata(rtd->dev, data);
1098 }
1099
1100 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1101 {
1102         return dev_get_drvdata(rtd->dev);
1103 }
1104
1105 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1106 {
1107         INIT_LIST_HEAD(&card->dai_dev_list);
1108         INIT_LIST_HEAD(&card->codec_dev_list);
1109         INIT_LIST_HEAD(&card->platform_dev_list);
1110         INIT_LIST_HEAD(&card->widgets);
1111         INIT_LIST_HEAD(&card->paths);
1112         INIT_LIST_HEAD(&card->dapm_list);
1113 }
1114
1115 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1116 {
1117         if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1118                 return 0;
1119         /*
1120          * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1121          * mc->reg != mc->rreg means that the control is
1122          * stereo (bits in one register or in two registers)
1123          */
1124         return 1;
1125 }
1126
1127 int snd_soc_util_init(void);
1128 void snd_soc_util_exit(void);
1129
1130 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1131                                const char *propname);
1132 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1133                                    const char *propname);
1134
1135 #include <sound/soc-dai.h>
1136
1137 #ifdef CONFIG_DEBUG_FS
1138 extern struct dentry *snd_soc_debugfs_root;
1139 #endif
1140
1141 extern const struct dev_pm_ops snd_soc_pm_ops;
1142
1143 #endif