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