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_SINGLE_VIRT(xitems, xtexts) \
 193         SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
 194 #define SOC_ENUM(xname, xenum) \
 195 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
 196         .info = snd_soc_info_enum_double, \
 197         .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
 198         .private_value = (unsigned long)&xenum }
 199 #define SOC_VALUE_ENUM(xname, xenum) \
 200         SOC_ENUM(xname, xenum)
 201 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
 202          xhandler_get, xhandler_put) \
 203 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 204         .info = snd_soc_info_volsw, \
 205         .get = xhandler_get, .put = xhandler_put, \
 206         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
 207 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
 208          xhandler_get, xhandler_put) \
 209 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 210         .info = snd_soc_info_volsw, \
 211         .get = xhandler_get, .put = xhandler_put, \
 212         .private_value = \
 213                 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
 214 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
 215          xhandler_get, xhandler_put, tlv_array) \
 216 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 217         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 218                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 219         .tlv.p = (tlv_array), \
 220         .info = snd_soc_info_volsw, \
 221         .get = xhandler_get, .put = xhandler_put, \
 222         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
 223 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
 224          xhandler_get, xhandler_put, tlv_array) \
 225 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 226         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 227                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 228         .tlv.p = (tlv_array), \
 229         .info = snd_soc_info_volsw, \
 230         .get = xhandler_get, .put = xhandler_put, \
 231         .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
 232                                           xmax, xinvert, 0) }
 233 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
 234          xhandler_get, xhandler_put, tlv_array) \
 235 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 236         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 237                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 238         .tlv.p = (tlv_array), \
 239         .info = snd_soc_info_volsw, \
 240         .get = xhandler_get, .put = xhandler_put, \
 241         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 242                                             xmax, xinvert) }
 243 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
 244 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 245         .info = snd_soc_info_bool_ext, \
 246         .get = xhandler_get, .put = xhandler_put, \
 247         .private_value = xdata }
 248 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 249 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 250         .info = snd_soc_info_enum_double, \
 251         .get = xhandler_get, .put = xhandler_put, \
 252         .private_value = (unsigned long)&xenum }
 253
 254 #define SND_SOC_BYTES(xname, xbase, xregs)                    \
 255 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
 256         .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
 257         .put = snd_soc_bytes_put, .private_value =            \
 258                 ((unsigned long)&(struct soc_bytes)           \
 259                 {.base = xbase, .num_regs = xregs }) }
 260
 261 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask)        \
 262 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
 263         .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
 264         .put = snd_soc_bytes_put, .private_value =            \
 265                 ((unsigned long)&(struct soc_bytes)           \
 266                 {.base = xbase, .num_regs = xregs,            \
 267                  .mask = xmask }) }
 268
 269 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
 270                 xmin, xmax, xinvert) \
 271 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 272         .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
 273         .put = snd_soc_put_xr_sx, \
 274         .private_value = (unsigned long)&(struct soc_mreg_control) \
 275                 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
 276                 .invert = xinvert, .min = xmin, .max = xmax} }
 277
 278 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
 279         SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
 280                 snd_soc_get_strobe, snd_soc_put_strobe)
 281
 282 /*
 283  * Simplified versions of above macros, declaring a struct and calculating
 284  * ARRAY_SIZE internally
 285  */
 286 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
 287         const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
 288                                                 ARRAY_SIZE(xtexts), xtexts)
 289 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
 290         SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
 291 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
 292         const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
 293 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
 294         const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
 295                                                         ARRAY_SIZE(xtexts), xtexts, xvalues)
 296 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
 297         SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
 298 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
 299         const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
 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 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
 431 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
 432 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
 433
 434 /* Utility functions to get clock rates from various things */
 435 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 436 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 437 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 438 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 439
 440 /* set runtime hw params */
 441 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 442         const struct snd_pcm_hardware *hw);
 443
 444 int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
 445                 int cmd, struct snd_soc_platform *platform);
 446
 447 /* Jack reporting */
 448 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
 449                      struct snd_soc_jack *jack);
 450 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 451 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 452                           struct snd_soc_jack_pin *pins);
 453 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
 454                                     struct notifier_block *nb);
 455 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
 456                                       struct notifier_block *nb);
 457 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
 458                           struct snd_soc_jack_zone *zones);
 459 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
 460 #ifdef CONFIG_GPIOLIB
 461 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 462                         struct snd_soc_jack_gpio *gpios);
 463 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 464                         struct snd_soc_jack_gpio *gpios);
 465 #else
 466 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 467                                          struct snd_soc_jack_gpio *gpios)
 468 {
 469         return 0;
 470 }
 471
 472 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 473                                            struct snd_soc_jack_gpio *gpios)
 474 {
 475 }
 476 #endif
 477
 478 /* codec register bit access */
 479 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
 480                                 unsigned int mask, unsigned int value);
 481 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
 482                                unsigned short reg, unsigned int mask,
 483                                unsigned int value);
 484 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
 485                                 unsigned int mask, unsigned int value);
 486
 487 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
 488         struct snd_ac97_bus_ops *ops, int num);
 489 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
 490
 491 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
 492 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 493                 struct platform_device *pdev);
 494
 495 /*
 496  *Controls
 497  */
 498 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 499                                   void *data, const char *long_name,
 500                                   const char *prefix);
 501 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
 502                                                const char *name);
 503 int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
 504         const struct snd_kcontrol_new *controls, int num_controls);
 505 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
 506         const struct snd_kcontrol_new *controls, int num_controls);
 507 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
 508         const struct snd_kcontrol_new *controls, int num_controls);
 509 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
 510         const struct snd_kcontrol_new *controls, int num_controls);
 511 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 512         struct snd_ctl_elem_info *uinfo);
 513 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 514         struct snd_ctl_elem_value *ucontrol);
 515 int snd_soc_put_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
 674         unsigned int active;
 675
 676         unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
 677
 678         struct list_head list;
 679
 680         struct snd_soc_dai_driver *dai_drv;
 681         int num_dai;
 682
 683         const struct snd_soc_component_driver *driver;
 684 };
 685
 686 /* SoC Audio Codec device */
 687 struct snd_soc_codec {
 688         const char *name;
 689         const char *name_prefix;
 690         int id;
 691         struct device *dev;
 692         const struct snd_soc_codec_driver *driver;
 693
 694         struct mutex mutex;
 695         struct snd_soc_card *card;
 696         struct list_head list;
 697         struct list_head card_list;
 698         int num_dai;
 699         int (*volatile_register)(struct snd_soc_codec *, unsigned int);
 700         int (*readable_register)(struct snd_soc_codec *, unsigned int);
 701         int (*writable_register)(struct snd_soc_codec *, unsigned int);
 702
 703         /* runtime */
 704         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
 705         unsigned int cache_bypass:1; /* Suppress access to the cache */
 706         unsigned int suspended:1; /* Codec is in suspend PM state */
 707         unsigned int probed:1; /* Codec has been probed */
 708         unsigned int ac97_registered:1; /* Codec has been AC97 registered */
 709         unsigned int ac97_created:1; /* Codec has been created by SoC */
 710         unsigned int cache_init:1; /* codec cache has been initialized */
 711         unsigned int using_regmap:1; /* using regmap access */
 712         u32 cache_only;  /* Suppress writes to hardware */
 713         u32 cache_sync; /* Cache needs to be synced to hardware */
 714
 715         /* codec IO */
 716         void *control_data; /* codec control (i2c/3wire) data */
 717         hw_write_t hw_write;
 718         unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
 719         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 720         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 721         void *reg_cache;
 722         struct mutex cache_rw_mutex;
 723         int val_bytes;
 724
 725         /* component */
 726         struct snd_soc_component component;
 727
 728         /* dapm */
 729         struct snd_soc_dapm_context dapm;
 730
 731 #ifdef CONFIG_DEBUG_FS
 732         struct dentry *debugfs_codec_root;
 733         struct dentry *debugfs_reg;
 734 #endif
 735 };
 736
 737 /* codec driver */
 738 struct snd_soc_codec_driver {
 739
 740         /* driver ops */
 741         int (*probe)(struct snd_soc_codec *);
 742         int (*remove)(struct snd_soc_codec *);
 743         int (*suspend)(struct snd_soc_codec *);
 744         int (*resume)(struct snd_soc_codec *);
 745         struct snd_soc_component_driver component_driver;
 746
 747         /* Default control and setup, added after probe() is run */
 748         const struct snd_kcontrol_new *controls;
 749         int num_controls;
 750         const struct snd_soc_dapm_widget *dapm_widgets;
 751         int num_dapm_widgets;
 752         const struct snd_soc_dapm_route *dapm_routes;
 753         int num_dapm_routes;
 754
 755         /* codec wide operations */
 756         int (*set_sysclk)(struct snd_soc_codec *codec,
 757                           int clk_id, int source, unsigned int freq, int dir);
 758         int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
 759                 unsigned int freq_in, unsigned int freq_out);
 760
 761         /* codec IO */
 762         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 763         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 764         int (*display_register)(struct snd_soc_codec *, char *,
 765                                 size_t, unsigned int);
 766         int (*volatile_register)(struct snd_soc_codec *, unsigned int);
 767         int (*readable_register)(struct snd_soc_codec *, unsigned int);
 768         int (*writable_register)(struct snd_soc_codec *, unsigned int);
 769         unsigned int reg_cache_size;
 770         short reg_cache_step;
 771         short reg_word_size;
 772         const void *reg_cache_default;
 773
 774         /* codec bias level */
 775         int (*set_bias_level)(struct snd_soc_codec *,
 776                               enum snd_soc_bias_level level);
 777         bool idle_bias_off;
 778
 779         void (*seq_notifier)(struct snd_soc_dapm_context *,
 780                              enum snd_soc_dapm_type, int);
 781
 782         /* codec stream completion event */
 783         int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
 784
 785         bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */
 786
 787         /* probe ordering - for components with runtime dependencies */
 788         int probe_order;
 789         int remove_order;
 790 };
 791
 792 /* SoC platform interface */
 793 struct snd_soc_platform_driver {
 794
 795         int (*probe)(struct snd_soc_platform *);
 796         int (*remove)(struct snd_soc_platform *);
 797         int (*suspend)(struct snd_soc_dai *dai);
 798         int (*resume)(struct snd_soc_dai *dai);
 799
 800         /* pcm creation and destruction */
 801         int (*pcm_new)(struct snd_soc_pcm_runtime *);
 802         void (*pcm_free)(struct snd_pcm *);
 803
 804         /* Default control and setup, added after probe() is run */
 805         const struct snd_kcontrol_new *controls;
 806         int num_controls;
 807         const struct snd_soc_dapm_widget *dapm_widgets;
 808         int num_dapm_widgets;
 809         const struct snd_soc_dapm_route *dapm_routes;
 810         int num_dapm_routes;
 811
 812         /*
 813          * For platform caused delay reporting.
 814          * Optional.
 815          */
 816         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 817                 struct snd_soc_dai *);
 818
 819         /* platform stream pcm ops */
 820         const struct snd_pcm_ops *ops;
 821
 822         /* platform stream compress ops */
 823         const struct snd_compr_ops *compr_ops;
 824
 825         /* platform stream completion event */
 826         int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
 827
 828         /* probe ordering - for components with runtime dependencies */
 829         int probe_order;
 830         int remove_order;
 831
 832         /* platform IO - used for platform DAPM */
 833         unsigned int (*read)(struct snd_soc_platform *, unsigned int);
 834         int (*write)(struct snd_soc_platform *, unsigned int, unsigned int);
 835         int (*bespoke_trigger)(struct snd_pcm_substream *, int);
 836 };
 837
 838 struct snd_soc_platform {
 839         const char *name;
 840         int id;
 841         struct device *dev;
 842         const struct snd_soc_platform_driver *driver;
 843         struct mutex mutex;
 844
 845         unsigned int suspended:1; /* platform is suspended */
 846         unsigned int probed:1;
 847
 848         struct snd_soc_card *card;
 849         struct list_head list;
 850         struct list_head card_list;
 851
 852         struct snd_soc_dapm_context dapm;
 853
 854 #ifdef CONFIG_DEBUG_FS
 855         struct dentry *debugfs_platform_root;
 856 #endif
 857 };
 858
 859 struct snd_soc_dai_link {
 860         /* config - must be set by machine driver */
 861         const char *name;                       /* Codec name */
 862         const char *stream_name;                /* Stream name */
 863         /*
 864          * You MAY specify the link's CPU-side device, either by device name,
 865          * or by DT/OF node, but not both. If this information is omitted,
 866          * the CPU-side DAI is matched using .cpu_dai_name only, which hence
 867          * must be globally unique. These fields are currently typically used
 868          * only for codec to codec links, or systems using device tree.
 869          */
 870         const char *cpu_name;
 871         const struct device_node *cpu_of_node;
 872         /*
 873          * You MAY specify the DAI name of the CPU DAI. If this information is
 874          * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
 875          * only, which only works well when that device exposes a single DAI.
 876          */
 877         const char *cpu_dai_name;
 878         /*
 879          * You MUST specify the link's codec, either by device name, or by
 880          * DT/OF node, but not both.
 881          */
 882         const char *codec_name;
 883         const struct device_node *codec_of_node;
 884         /* You MUST specify the DAI name within the codec */
 885         const char *codec_dai_name;
 886         /*
 887          * You MAY specify the link's platform/PCM/DMA driver, either by
 888          * device name, or by DT/OF node, but not both. Some forms of link
 889          * do not need a platform.
 890          */
 891         const char *platform_name;
 892         const struct device_node *platform_of_node;
 893         int be_id;      /* optional ID for machine driver BE identification */
 894
 895         const struct snd_soc_pcm_stream *params;
 896
 897         unsigned int dai_fmt;           /* format to set on init */
 898
 899         enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
 900
 901         /* Keep DAI active over suspend */
 902         unsigned int ignore_suspend:1;
 903
 904         /* Symmetry requirements */
 905         unsigned int symmetric_rates:1;
 906         unsigned int symmetric_channels:1;
 907         unsigned int symmetric_samplebits:1;
 908
 909         /* Do not create a PCM for this DAI link (Backend link) */
 910         unsigned int no_pcm:1;
 911
 912         /* This DAI link can route to other DAI links at runtime (Frontend)*/
 913         unsigned int dynamic:1;
 914
 915         /* DPCM capture and Playback support */
 916         unsigned int dpcm_capture:1;
 917         unsigned int dpcm_playback:1;
 918
 919         /* pmdown_time is ignored at stop */
 920         unsigned int ignore_pmdown_time:1;
 921
 922         /* codec/machine specific init - e.g. add machine controls */
 923         int (*init)(struct snd_soc_pcm_runtime *rtd);
 924
 925         /* optional hw_params re-writing for BE and FE sync */
 926         int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
 927                         struct snd_pcm_hw_params *params);
 928
 929         /* machine stream operations */
 930         const struct snd_soc_ops *ops;
 931         const struct snd_soc_compr_ops *compr_ops;
 932
 933         /* For unidirectional dai links */
 934         bool playback_only;
 935         bool capture_only;
 936 };
 937
 938 struct snd_soc_codec_conf {
 939         const char *dev_name;
 940
 941         /*
 942          * optional map of kcontrol, widget and path name prefixes that are
 943          * associated per device
 944          */
 945         const char *name_prefix;
 946 };
 947
 948 struct snd_soc_aux_dev {
 949         const char *name;               /* Codec name */
 950         const char *codec_name;         /* for multi-codec */
 951
 952         /* codec/machine specific init - e.g. add machine controls */
 953         int (*init)(struct snd_soc_dapm_context *dapm);
 954 };
 955
 956 /* SoC card */
 957 struct snd_soc_card {
 958         const char *name;
 959         const char *long_name;
 960         const char *driver_name;
 961         struct device *dev;
 962         struct snd_card *snd_card;
 963         struct module *owner;
 964
 965         struct list_head list;
 966         struct mutex mutex;
 967         struct mutex dapm_mutex;
 968
 969         bool instantiated;
 970
 971         int (*probe)(struct snd_soc_card *card);
 972         int (*late_probe)(struct snd_soc_card *card);
 973         int (*remove)(struct snd_soc_card *card);
 974
 975         /* the pre and post PM functions are used to do any PM work before and
 976          * after the codec and DAI's do any PM work. */
 977         int (*suspend_pre)(struct snd_soc_card *card);
 978         int (*suspend_post)(struct snd_soc_card *card);
 979         int (*resume_pre)(struct snd_soc_card *card);
 980         int (*resume_post)(struct snd_soc_card *card);
 981
 982         /* callbacks */
 983         int (*set_bias_level)(struct snd_soc_card *,
 984                               struct snd_soc_dapm_context *dapm,
 985                               enum snd_soc_bias_level level);
 986         int (*set_bias_level_post)(struct snd_soc_card *,
 987                                    struct snd_soc_dapm_context *dapm,
 988                                    enum snd_soc_bias_level level);
 989
 990         long pmdown_time;
 991
 992         /* CPU <--> Codec DAI links  */
 993         struct snd_soc_dai_link *dai_link;
 994         int num_links;
 995         struct snd_soc_pcm_runtime *rtd;
 996         int num_rtd;
 997
 998         /* optional codec specific configuration */
 999         struct snd_soc_codec_conf *codec_conf;
1000         int num_configs;
1001
1002         /*
1003          * optional auxiliary devices such as amplifiers or codecs with DAI
1004          * link unused
1005          */
1006         struct snd_soc_aux_dev *aux_dev;
1007         int num_aux_devs;
1008         struct snd_soc_pcm_runtime *rtd_aux;
1009         int num_aux_rtd;
1010
1011         const struct snd_kcontrol_new *controls;
1012         int num_controls;
1013
1014         /*
1015          * Card-specific routes and widgets.
1016          */
1017         const struct snd_soc_dapm_widget *dapm_widgets;
1018         int num_dapm_widgets;
1019         const struct snd_soc_dapm_route *dapm_routes;
1020         int num_dapm_routes;
1021         bool fully_routed;
1022
1023         struct work_struct deferred_resume_work;
1024
1025         /* lists of probed devices belonging to this card */
1026         struct list_head codec_dev_list;
1027         struct list_head platform_dev_list;
1028         struct list_head dai_dev_list;
1029
1030         struct list_head widgets;
1031         struct list_head paths;
1032         struct list_head dapm_list;
1033         struct list_head dapm_dirty;
1034
1035         /* Generic DAPM context for the card */
1036         struct snd_soc_dapm_context dapm;
1037         struct snd_soc_dapm_stats dapm_stats;
1038         struct snd_soc_dapm_update *update;
1039
1040 #ifdef CONFIG_DEBUG_FS
1041         struct dentry *debugfs_card_root;
1042         struct dentry *debugfs_pop_time;
1043 #endif
1044         u32 pop_time;
1045
1046         void *drvdata;
1047 };
1048
1049 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1050 struct snd_soc_pcm_runtime {
1051         struct device *dev;
1052         struct snd_soc_card *card;
1053         struct snd_soc_dai_link *dai_link;
1054         struct mutex pcm_mutex;
1055         enum snd_soc_pcm_subclass pcm_subclass;
1056         struct snd_pcm_ops ops;
1057
1058         unsigned int dev_registered:1;
1059
1060         /* Dynamic PCM BE runtime data */
1061         struct snd_soc_dpcm_runtime dpcm[2];
1062         int fe_compr;
1063
1064         long pmdown_time;
1065         unsigned char pop_wait:1;
1066
1067         /* runtime devices */
1068         struct snd_pcm *pcm;
1069         struct snd_compr *compr;
1070         struct snd_soc_codec *codec;
1071         struct snd_soc_platform *platform;
1072         struct snd_soc_dai *codec_dai;
1073         struct snd_soc_dai *cpu_dai;
1074
1075         struct delayed_work delayed_work;
1076 #ifdef CONFIG_DEBUG_FS
1077         struct dentry *debugfs_dpcm_root;
1078         struct dentry *debugfs_dpcm_state;
1079 #endif
1080 };
1081
1082 /* mixer control */
1083 struct soc_mixer_control {
1084         int min, max, platform_max;
1085         int reg, rreg;
1086         unsigned int shift, rshift;
1087         unsigned int sign_bit;
1088         unsigned int invert:1;
1089         unsigned int autodisable:1;
1090 };
1091
1092 struct soc_bytes {
1093         int base;
1094         int num_regs;
1095         u32 mask;
1096 };
1097
1098 /* multi register control */
1099 struct soc_mreg_control {
1100         long min, max;
1101         unsigned int regbase, regcount, nbits, invert;
1102 };
1103
1104 /* enumerated kcontrol */
1105 struct soc_enum {
1106         int reg;
1107         unsigned char shift_l;
1108         unsigned char shift_r;
1109         unsigned int items;
1110         unsigned int mask;
1111         const char * const *texts;
1112         const unsigned int *values;
1113 };
1114
1115 /* codec IO */
1116 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1117 unsigned int snd_soc_write(struct snd_soc_codec *codec,
1118                            unsigned int reg, unsigned int val);
1119
1120 /* device driver data */
1121
1122 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1123                 void *data)
1124 {
1125         card->drvdata = data;
1126 }
1127
1128 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1129 {
1130         return card->drvdata;
1131 }
1132
1133 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1134                 void *data)
1135 {
1136         dev_set_drvdata(codec->dev, data);
1137 }
1138
1139 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1140 {
1141         return dev_get_drvdata(codec->dev);
1142 }
1143
1144 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1145                 void *data)
1146 {
1147         dev_set_drvdata(platform->dev, data);
1148 }
1149
1150 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1151 {
1152         return dev_get_drvdata(platform->dev);
1153 }
1154
1155 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1156                 void *data)
1157 {
1158         dev_set_drvdata(rtd->dev, data);
1159 }
1160
1161 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1162 {
1163         return dev_get_drvdata(rtd->dev);
1164 }
1165
1166 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1167 {
1168         INIT_LIST_HEAD(&card->dai_dev_list);
1169         INIT_LIST_HEAD(&card->codec_dev_list);
1170         INIT_LIST_HEAD(&card->platform_dev_list);
1171         INIT_LIST_HEAD(&card->widgets);
1172         INIT_LIST_HEAD(&card->paths);
1173         INIT_LIST_HEAD(&card->dapm_list);
1174 }
1175
1176 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1177 {
1178         if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1179                 return 0;
1180         /*
1181          * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1182          * mc->reg != mc->rreg means that the control is
1183          * stereo (bits in one register or in two registers)
1184          */
1185         return 1;
1186 }
1187
1188 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1189         unsigned int val)
1190 {
1191         unsigned int i;
1192
1193         if (!e->values)
1194                 return val;
1195
1196         for (i = 0; i < e->items; i++)
1197                 if (val == e->values[i])
1198                         return i;
1199
1200         return 0;
1201 }
1202
1203 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1204         unsigned int item)
1205 {
1206         if (!e->values)
1207                 return item;
1208
1209         return e->values[item];
1210 }
1211
1212 static inline bool snd_soc_component_is_active(
1213         struct snd_soc_component *component)
1214 {
1215         return component->active != 0;
1216 }
1217
1218 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1219 {
1220         return snd_soc_component_is_active(&codec->component);
1221 }
1222
1223 int snd_soc_util_init(void);
1224 void snd_soc_util_exit(void);
1225
1226 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1227                                const char *propname);
1228 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1229                                    const char *propname);
1230 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1231                                      const char *prefix);
1232 int snd_soc_of_get_dai_name(struct device_node *of_node,
1233                             const char **dai_name);
1234
1235 #include <sound/soc-dai.h>
1236
1237 #ifdef CONFIG_DEBUG_FS
1238 extern struct dentry *snd_soc_debugfs_root;
1239 #endif
1240
1241 extern const struct dev_pm_ops snd_soc_pm_ops;
1242
1243 /* Helper functions */
1244 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1245 {
1246         mutex_lock(&dapm->card->dapm_mutex);
1247 }
1248
1249 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1250 {
1251         mutex_unlock(&dapm->card->dapm_mutex);
1252 }
1253
1254 #endif