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