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_pcm_subclass {
 358         SND_SOC_PCM_CLASS_PCM   = 0,
 359         SND_SOC_PCM_CLASS_BE    = 1,
 360 };
 361
 362 enum snd_soc_card_subclass {
 363         SND_SOC_CARD_CLASS_INIT         = 0,
 364         SND_SOC_CARD_CLASS_RUNTIME      = 1,
 365 };
 366
 367 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
 368                              int source, unsigned int freq, int dir);
 369 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
 370                           unsigned int freq_in, unsigned int freq_out);
 371
 372 int snd_soc_register_card(struct snd_soc_card *card);
 373 int snd_soc_unregister_card(struct snd_soc_card *card);
 374 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
 375 int snd_soc_suspend(struct device *dev);
 376 int snd_soc_resume(struct device *dev);
 377 int snd_soc_poweroff(struct device *dev);
 378 int snd_soc_register_platform(struct device *dev,
 379                 const struct snd_soc_platform_driver *platform_drv);
 380 void snd_soc_unregister_platform(struct device *dev);
 381 int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
 382                 const struct snd_soc_platform_driver *platform_drv);
 383 void snd_soc_remove_platform(struct snd_soc_platform *platform);
 384 struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev);
 385 int snd_soc_register_codec(struct device *dev,
 386                 const struct snd_soc_codec_driver *codec_drv,
 387                 struct snd_soc_dai_driver *dai_drv, int num_dai);
 388 void snd_soc_unregister_codec(struct device *dev);
 389 int snd_soc_register_component(struct device *dev,
 390                          const struct snd_soc_component_driver *cmpnt_drv,
 391                          struct snd_soc_dai_driver *dai_drv, int num_dai);
 392 int devm_snd_soc_register_component(struct device *dev,
 393                          const struct snd_soc_component_driver *cmpnt_drv,
 394                          struct snd_soc_dai_driver *dai_drv, int num_dai);
 395 void snd_soc_unregister_component(struct device *dev);
 396 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
 397                                struct regmap *regmap);
 398 int snd_soc_cache_sync(struct snd_soc_codec *codec);
 399 int snd_soc_cache_init(struct snd_soc_codec *codec);
 400 int snd_soc_cache_exit(struct snd_soc_codec *codec);
 401 int snd_soc_cache_write(struct snd_soc_codec *codec,
 402                         unsigned int reg, unsigned int value);
 403 int snd_soc_cache_read(struct snd_soc_codec *codec,
 404                        unsigned int reg, unsigned int *value);
 405 int snd_soc_platform_read(struct snd_soc_platform *platform,
 406                                         unsigned int reg);
 407 int snd_soc_platform_write(struct snd_soc_platform *platform,
 408                                         unsigned int reg, unsigned int val);
 409 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
 410 int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
 411
 412 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
 413                 const char *dai_link, int stream);
 414 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
 415                 const char *dai_link);
 416
 417 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
 418 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
 419 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
 420
 421 /* Utility functions to get clock rates from various things */
 422 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 423 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 424 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 425 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 426
 427 /* set runtime hw params */
 428 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 429         const struct snd_pcm_hardware *hw);
 430
 431 int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
 432                 int cmd, struct snd_soc_platform *platform);
 433
 434 /* Jack reporting */
 435 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
 436                      struct snd_soc_jack *jack);
 437 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 438 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 439                           struct snd_soc_jack_pin *pins);
 440 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
 441                                     struct notifier_block *nb);
 442 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
 443                                       struct notifier_block *nb);
 444 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
 445                           struct snd_soc_jack_zone *zones);
 446 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
 447 #ifdef CONFIG_GPIOLIB
 448 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 449                         struct snd_soc_jack_gpio *gpios);
 450 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 451                         struct snd_soc_jack_gpio *gpios);
 452 #else
 453 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 454                                          struct snd_soc_jack_gpio *gpios)
 455 {
 456         return 0;
 457 }
 458
 459 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 460                                            struct snd_soc_jack_gpio *gpios)
 461 {
 462 }
 463 #endif
 464
 465 /* codec register bit access */
 466 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
 467                                 unsigned int mask, unsigned int value);
 468 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
 469                                unsigned short reg, unsigned int mask,
 470                                unsigned int value);
 471 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
 472                                 unsigned int mask, unsigned int value);
 473
 474 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
 475         struct snd_ac97_bus_ops *ops, int num);
 476 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
 477
 478 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
 479 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 480                 struct platform_device *pdev);
 481
 482 /*
 483  *Controls
 484  */
 485 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 486                                   void *data, const char *long_name,
 487                                   const char *prefix);
 488 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
 489                                                const char *name);
 490 int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
 491         const struct snd_kcontrol_new *controls, int num_controls);
 492 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
 493         const struct snd_kcontrol_new *controls, int num_controls);
 494 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
 495         const struct snd_kcontrol_new *controls, int num_controls);
 496 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
 497         const struct snd_kcontrol_new *controls, int num_controls);
 498 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 499         struct snd_ctl_elem_info *uinfo);
 500 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 501         struct snd_ctl_elem_value *ucontrol);
 502 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 503         struct snd_ctl_elem_value *ucontrol);
 504 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 505         struct snd_ctl_elem_info *uinfo);
 506 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 507 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 508         struct snd_ctl_elem_value *ucontrol);
 509 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 510         struct snd_ctl_elem_value *ucontrol);
 511 #define snd_soc_get_volsw_2r snd_soc_get_volsw
 512 #define snd_soc_put_volsw_2r snd_soc_put_volsw
 513 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
 514         struct snd_ctl_elem_value *ucontrol);
 515 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
 516         struct snd_ctl_elem_value *ucontrol);
 517 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
 518         struct snd_ctl_elem_info *uinfo);
 519 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
 520         struct snd_ctl_elem_value *ucontrol);
 521 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
 522         struct snd_ctl_elem_value *ucontrol);
 523 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
 524         struct snd_ctl_elem_info *uinfo);
 525 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
 526         struct snd_ctl_elem_value *ucontrol);
 527 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
 528         struct snd_ctl_elem_value *ucontrol);
 529 int snd_soc_limit_volume(struct snd_soc_codec *codec,
 530         const char *name, int max);
 531 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
 532                        struct snd_ctl_elem_info *uinfo);
 533 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
 534                       struct snd_ctl_elem_value *ucontrol);
 535 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
 536                       struct snd_ctl_elem_value *ucontrol);
 537 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
 538         struct snd_ctl_elem_info *uinfo);
 539 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
 540         struct snd_ctl_elem_value *ucontrol);
 541 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
 542         struct snd_ctl_elem_value *ucontrol);
 543 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
 544         struct snd_ctl_elem_value *ucontrol);
 545 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
 546         struct snd_ctl_elem_value *ucontrol);
 547
 548 /**
 549  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 550  *
 551  * @pin:    name of the pin to update
 552  * @mask:   bits to check for in reported jack status
 553  * @invert: if non-zero then pin is enabled when status is not reported
 554  */
 555 struct snd_soc_jack_pin {
 556         struct list_head list;
 557         const char *pin;
 558         int mask;
 559         bool invert;
 560 };
 561
 562 /**
 563  * struct snd_soc_jack_zone - Describes voltage zones of jack detection
 564  *
 565  * @min_mv: start voltage in mv
 566  * @max_mv: end voltage in mv
 567  * @jack_type: type of jack that is expected for this voltage
 568  * @debounce_time: debounce_time for jack, codec driver should wait for this
 569  *              duration before reading the adc for voltages
 570  * @:list: list container
 571  */
 572 struct snd_soc_jack_zone {
 573         unsigned int min_mv;
 574         unsigned int max_mv;
 575         unsigned int jack_type;
 576         unsigned int debounce_time;
 577         struct list_head list;
 578 };
 579
 580 /**
 581  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 582  *
 583  * @gpio:         gpio number
 584  * @name:         gpio name
 585  * @report:       value to report when jack detected
 586  * @invert:       report presence in low state
 587  * @debouce_time: debouce time in ms
 588  * @wake:         enable as wake source
 589  * @jack_status_check: callback function which overrides the detection
 590  *                     to provide more complex checks (eg, reading an
 591  *                     ADC).
 592  */
 593 struct snd_soc_jack_gpio {
 594         unsigned int gpio;
 595         const char *name;
 596         int report;
 597         int invert;
 598         int debounce_time;
 599         bool wake;
 600
 601         struct snd_soc_jack *jack;
 602         struct delayed_work work;
 603
 604         void *data;
 605         int (*jack_status_check)(void *data);
 606 };
 607
 608 struct snd_soc_jack {
 609         struct mutex mutex;
 610         struct snd_jack *jack;
 611         struct snd_soc_codec *codec;
 612         struct list_head pins;
 613         int status;
 614         struct blocking_notifier_head notifier;
 615         struct list_head jack_zones;
 616 };
 617
 618 /* SoC PCM stream information */
 619 struct snd_soc_pcm_stream {
 620         const char *stream_name;
 621         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 622         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 623         unsigned int rate_min;          /* min rate */
 624         unsigned int rate_max;          /* max rate */
 625         unsigned int channels_min;      /* min channels */
 626         unsigned int channels_max;      /* max channels */
 627         unsigned int sig_bits;          /* number of bits of content */
 628 };
 629
 630 /* SoC audio ops */
 631 struct snd_soc_ops {
 632         int (*startup)(struct snd_pcm_substream *);
 633         void (*shutdown)(struct snd_pcm_substream *);
 634         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 635         int (*hw_free)(struct snd_pcm_substream *);
 636         int (*prepare)(struct snd_pcm_substream *);
 637         int (*trigger)(struct snd_pcm_substream *, int);
 638 };
 639
 640 struct snd_soc_compr_ops {
 641         int (*startup)(struct snd_compr_stream *);
 642         void (*shutdown)(struct snd_compr_stream *);
 643         int (*set_params)(struct snd_compr_stream *);
 644         int (*trigger)(struct snd_compr_stream *);
 645 };
 646
 647 /* component interface */
 648 struct snd_soc_component_driver {
 649         const char *name;
 650
 651         /* DT */
 652         int (*of_xlate_dai_name)(struct snd_soc_component *component,
 653                                  struct of_phandle_args *args,
 654                                  const char **dai_name);
 655 };
 656
 657 struct snd_soc_component {
 658         const char *name;
 659         int id;
 660         struct device *dev;
 661
 662         unsigned int active;
 663
 664         unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
 665         unsigned int registered_as_component:1;
 666
 667         struct list_head list;
 668
 669         struct snd_soc_dai_driver *dai_drv;
 670         int num_dai;
 671
 672         const struct snd_soc_component_driver *driver;
 673
 674         struct list_head dai_list;
 675 };
 676
 677 /* SoC Audio Codec device */
 678 struct snd_soc_codec {
 679         const char *name;
 680         const char *name_prefix;
 681         int id;
 682         struct device *dev;
 683         const struct snd_soc_codec_driver *driver;
 684
 685         struct mutex mutex;
 686         struct snd_soc_card *card;
 687         struct list_head list;
 688         struct list_head card_list;
 689         int num_dai;
 690
 691         /* runtime */
 692         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
 693         unsigned int cache_bypass:1; /* Suppress access to the cache */
 694         unsigned int suspended:1; /* Codec is in suspend PM state */
 695         unsigned int probed:1; /* Codec has been probed */
 696         unsigned int ac97_registered:1; /* Codec has been AC97 registered */
 697         unsigned int ac97_created:1; /* Codec has been created by SoC */
 698         unsigned int cache_init:1; /* codec cache has been initialized */
 699         unsigned int using_regmap:1; /* using regmap access */
 700         u32 cache_only;  /* Suppress writes to hardware */
 701         u32 cache_sync; /* Cache needs to be synced to hardware */
 702
 703         /* codec IO */
 704         void *control_data; /* codec control (i2c/3wire) data */
 705         hw_write_t hw_write;
 706         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 707         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 708         void *reg_cache;
 709         struct mutex cache_rw_mutex;
 710         int val_bytes;
 711
 712         /* component */
 713         struct snd_soc_component component;
 714
 715         /* dapm */
 716         struct snd_soc_dapm_context dapm;
 717
 718 #ifdef CONFIG_DEBUG_FS
 719         struct dentry *debugfs_codec_root;
 720         struct dentry *debugfs_reg;
 721 #endif
 722 };
 723
 724 /* codec driver */
 725 struct snd_soc_codec_driver {
 726
 727         /* driver ops */
 728         int (*probe)(struct snd_soc_codec *);
 729         int (*remove)(struct snd_soc_codec *);
 730         int (*suspend)(struct snd_soc_codec *);
 731         int (*resume)(struct snd_soc_codec *);
 732         struct snd_soc_component_driver component_driver;
 733
 734         /* Default control and setup, added after probe() is run */
 735         const struct snd_kcontrol_new *controls;
 736         int num_controls;
 737         const struct snd_soc_dapm_widget *dapm_widgets;
 738         int num_dapm_widgets;
 739         const struct snd_soc_dapm_route *dapm_routes;
 740         int num_dapm_routes;
 741
 742         /* codec wide operations */
 743         int (*set_sysclk)(struct snd_soc_codec *codec,
 744                           int clk_id, int source, unsigned int freq, int dir);
 745         int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
 746                 unsigned int freq_in, unsigned int freq_out);
 747
 748         /* codec IO */
 749         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 750         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 751         unsigned int reg_cache_size;
 752         short reg_cache_step;
 753         short reg_word_size;
 754         const void *reg_cache_default;
 755
 756         /* codec bias level */
 757         int (*set_bias_level)(struct snd_soc_codec *,
 758                               enum snd_soc_bias_level level);
 759         bool idle_bias_off;
 760
 761         void (*seq_notifier)(struct snd_soc_dapm_context *,
 762                              enum snd_soc_dapm_type, int);
 763
 764         /* codec stream completion event */
 765         int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
 766
 767         bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */
 768
 769         /* probe ordering - for components with runtime dependencies */
 770         int probe_order;
 771         int remove_order;
 772 };
 773
 774 /* SoC platform interface */
 775 struct snd_soc_platform_driver {
 776
 777         int (*probe)(struct snd_soc_platform *);
 778         int (*remove)(struct snd_soc_platform *);
 779         int (*suspend)(struct snd_soc_dai *dai);
 780         int (*resume)(struct snd_soc_dai *dai);
 781         struct snd_soc_component_driver component_driver;
 782
 783         /* pcm creation and destruction */
 784         int (*pcm_new)(struct snd_soc_pcm_runtime *);
 785         void (*pcm_free)(struct snd_pcm *);
 786
 787         /* Default control and setup, added after probe() is run */
 788         const struct snd_kcontrol_new *controls;
 789         int num_controls;
 790         const struct snd_soc_dapm_widget *dapm_widgets;
 791         int num_dapm_widgets;
 792         const struct snd_soc_dapm_route *dapm_routes;
 793         int num_dapm_routes;
 794
 795         /*
 796          * For platform caused delay reporting.
 797          * Optional.
 798          */
 799         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 800                 struct snd_soc_dai *);
 801
 802         /* platform stream pcm ops */
 803         const struct snd_pcm_ops *ops;
 804
 805         /* platform stream compress ops */
 806         const struct snd_compr_ops *compr_ops;
 807
 808         /* platform stream completion event */
 809         int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
 810
 811         /* probe ordering - for components with runtime dependencies */
 812         int probe_order;
 813         int remove_order;
 814
 815         /* platform IO - used for platform DAPM */
 816         unsigned int (*read)(struct snd_soc_platform *, unsigned int);
 817         int (*write)(struct snd_soc_platform *, unsigned int, unsigned int);
 818         int (*bespoke_trigger)(struct snd_pcm_substream *, int);
 819 };
 820
 821 struct snd_soc_platform {
 822         const char *name;
 823         int id;
 824         struct device *dev;
 825         const struct snd_soc_platform_driver *driver;
 826         struct mutex mutex;
 827
 828         unsigned int suspended:1; /* platform is suspended */
 829         unsigned int probed:1;
 830
 831         struct snd_soc_card *card;
 832         struct list_head list;
 833         struct list_head card_list;
 834
 835         struct snd_soc_component component;
 836
 837         struct snd_soc_dapm_context dapm;
 838
 839 #ifdef CONFIG_DEBUG_FS
 840         struct dentry *debugfs_platform_root;
 841 #endif
 842 };
 843
 844 struct snd_soc_dai_link {
 845         /* config - must be set by machine driver */
 846         const char *name;                       /* Codec name */
 847         const char *stream_name;                /* Stream name */
 848         /*
 849          * You MAY specify the link's CPU-side device, either by device name,
 850          * or by DT/OF node, but not both. If this information is omitted,
 851          * the CPU-side DAI is matched using .cpu_dai_name only, which hence
 852          * must be globally unique. These fields are currently typically used
 853          * only for codec to codec links, or systems using device tree.
 854          */
 855         const char *cpu_name;
 856         const struct device_node *cpu_of_node;
 857         /*
 858          * You MAY specify the DAI name of the CPU DAI. If this information is
 859          * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
 860          * only, which only works well when that device exposes a single DAI.
 861          */
 862         const char *cpu_dai_name;
 863         /*
 864          * You MUST specify the link's codec, either by device name, or by
 865          * DT/OF node, but not both.
 866          */
 867         const char *codec_name;
 868         const struct device_node *codec_of_node;
 869         /* You MUST specify the DAI name within the codec */
 870         const char *codec_dai_name;
 871         /*
 872          * You MAY specify the link's platform/PCM/DMA driver, either by
 873          * device name, or by DT/OF node, but not both. Some forms of link
 874          * do not need a platform.
 875          */
 876         const char *platform_name;
 877         const struct device_node *platform_of_node;
 878         int be_id;      /* optional ID for machine driver BE identification */
 879
 880         const struct snd_soc_pcm_stream *params;
 881
 882         unsigned int dai_fmt;           /* format to set on init */
 883
 884         enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
 885
 886         /* Keep DAI active over suspend */
 887         unsigned int ignore_suspend:1;
 888
 889         /* Symmetry requirements */
 890         unsigned int symmetric_rates:1;
 891         unsigned int symmetric_channels:1;
 892         unsigned int symmetric_samplebits:1;
 893
 894         /* Do not create a PCM for this DAI link (Backend link) */
 895         unsigned int no_pcm:1;
 896
 897         /* This DAI link can route to other DAI links at runtime (Frontend)*/
 898         unsigned int dynamic:1;
 899
 900         /* DPCM capture and Playback support */
 901         unsigned int dpcm_capture:1;
 902         unsigned int dpcm_playback:1;
 903
 904         /* pmdown_time is ignored at stop */
 905         unsigned int ignore_pmdown_time:1;
 906
 907         /* codec/machine specific init - e.g. add machine controls */
 908         int (*init)(struct snd_soc_pcm_runtime *rtd);
 909
 910         /* optional hw_params re-writing for BE and FE sync */
 911         int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
 912                         struct snd_pcm_hw_params *params);
 913
 914         /* machine stream operations */
 915         const struct snd_soc_ops *ops;
 916         const struct snd_soc_compr_ops *compr_ops;
 917
 918         /* For unidirectional dai links */
 919         bool playback_only;
 920         bool capture_only;
 921 };
 922
 923 struct snd_soc_codec_conf {
 924         const char *dev_name;
 925
 926         /*
 927          * optional map of kcontrol, widget and path name prefixes that are
 928          * associated per device
 929          */
 930         const char *name_prefix;
 931 };
 932
 933 struct snd_soc_aux_dev {
 934         const char *name;               /* Codec name */
 935         const char *codec_name;         /* for multi-codec */
 936
 937         /* codec/machine specific init - e.g. add machine controls */
 938         int (*init)(struct snd_soc_dapm_context *dapm);
 939 };
 940
 941 /* SoC card */
 942 struct snd_soc_card {
 943         const char *name;
 944         const char *long_name;
 945         const char *driver_name;
 946         struct device *dev;
 947         struct snd_card *snd_card;
 948         struct module *owner;
 949
 950         struct list_head list;
 951         struct mutex mutex;
 952         struct mutex dapm_mutex;
 953
 954         bool instantiated;
 955
 956         int (*probe)(struct snd_soc_card *card);
 957         int (*late_probe)(struct snd_soc_card *card);
 958         int (*remove)(struct snd_soc_card *card);
 959
 960         /* the pre and post PM functions are used to do any PM work before and
 961          * after the codec and DAI's do any PM work. */
 962         int (*suspend_pre)(struct snd_soc_card *card);
 963         int (*suspend_post)(struct snd_soc_card *card);
 964         int (*resume_pre)(struct snd_soc_card *card);
 965         int (*resume_post)(struct snd_soc_card *card);
 966
 967         /* callbacks */
 968         int (*set_bias_level)(struct snd_soc_card *,
 969                               struct snd_soc_dapm_context *dapm,
 970                               enum snd_soc_bias_level level);
 971         int (*set_bias_level_post)(struct snd_soc_card *,
 972                                    struct snd_soc_dapm_context *dapm,
 973                                    enum snd_soc_bias_level level);
 974
 975         long pmdown_time;
 976
 977         /* CPU <--> Codec DAI links  */
 978         struct snd_soc_dai_link *dai_link;
 979         int num_links;
 980         struct snd_soc_pcm_runtime *rtd;
 981         int num_rtd;
 982
 983         /* optional codec specific configuration */
 984         struct snd_soc_codec_conf *codec_conf;
 985         int num_configs;
 986
 987         /*
 988          * optional auxiliary devices such as amplifiers or codecs with DAI
 989          * link unused
 990          */
 991         struct snd_soc_aux_dev *aux_dev;
 992         int num_aux_devs;
 993         struct snd_soc_pcm_runtime *rtd_aux;
 994         int num_aux_rtd;
 995
 996         const struct snd_kcontrol_new *controls;
 997         int num_controls;
 998
 999         /*
1000          * Card-specific routes and widgets.
1001          */
1002         const struct snd_soc_dapm_widget *dapm_widgets;
1003         int num_dapm_widgets;
1004         const struct snd_soc_dapm_route *dapm_routes;
1005         int num_dapm_routes;
1006         bool fully_routed;
1007
1008         struct work_struct deferred_resume_work;
1009
1010         /* lists of probed devices belonging to this card */
1011         struct list_head codec_dev_list;
1012         struct list_head platform_dev_list;
1013         struct list_head dai_dev_list;
1014
1015         struct list_head widgets;
1016         struct list_head paths;
1017         struct list_head dapm_list;
1018         struct list_head dapm_dirty;
1019
1020         /* Generic DAPM context for the card */
1021         struct snd_soc_dapm_context dapm;
1022         struct snd_soc_dapm_stats dapm_stats;
1023         struct snd_soc_dapm_update *update;
1024
1025 #ifdef CONFIG_DEBUG_FS
1026         struct dentry *debugfs_card_root;
1027         struct dentry *debugfs_pop_time;
1028 #endif
1029         u32 pop_time;
1030
1031         void *drvdata;
1032 };
1033
1034 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1035 struct snd_soc_pcm_runtime {
1036         struct device *dev;
1037         struct snd_soc_card *card;
1038         struct snd_soc_dai_link *dai_link;
1039         struct mutex pcm_mutex;
1040         enum snd_soc_pcm_subclass pcm_subclass;
1041         struct snd_pcm_ops ops;
1042
1043         unsigned int dev_registered:1;
1044
1045         /* Dynamic PCM BE runtime data */
1046         struct snd_soc_dpcm_runtime dpcm[2];
1047         int fe_compr;
1048
1049         long pmdown_time;
1050         unsigned char pop_wait:1;
1051
1052         /* runtime devices */
1053         struct snd_pcm *pcm;
1054         struct snd_compr *compr;
1055         struct snd_soc_codec *codec;
1056         struct snd_soc_platform *platform;
1057         struct snd_soc_dai *codec_dai;
1058         struct snd_soc_dai *cpu_dai;
1059
1060         struct delayed_work delayed_work;
1061 #ifdef CONFIG_DEBUG_FS
1062         struct dentry *debugfs_dpcm_root;
1063         struct dentry *debugfs_dpcm_state;
1064 #endif
1065 };
1066
1067 /* mixer control */
1068 struct soc_mixer_control {
1069         int min, max, platform_max;
1070         int reg, rreg;
1071         unsigned int shift, rshift;
1072         unsigned int sign_bit;
1073         unsigned int invert:1;
1074         unsigned int autodisable:1;
1075 };
1076
1077 struct soc_bytes {
1078         int base;
1079         int num_regs;
1080         u32 mask;
1081 };
1082
1083 /* multi register control */
1084 struct soc_mreg_control {
1085         long min, max;
1086         unsigned int regbase, regcount, nbits, invert;
1087 };
1088
1089 /* enumerated kcontrol */
1090 struct soc_enum {
1091         int reg;
1092         unsigned char shift_l;
1093         unsigned char shift_r;
1094         unsigned int items;
1095         unsigned int mask;
1096         const char * const *texts;
1097         const unsigned int *values;
1098 };
1099
1100 /**
1101  * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1102  * @component: The component to cast to a CODEC
1103  *
1104  * This function must only be used on components that are known to be CODECs.
1105  * Otherwise the behavior is undefined.
1106  */
1107 static inline struct snd_soc_codec *snd_soc_component_to_codec(
1108         struct snd_soc_component *component)
1109 {
1110         return container_of(component, struct snd_soc_codec, component);
1111 }
1112
1113 /**
1114  * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1115  * @component: The component to cast to a platform
1116  *
1117  * This function must only be used on components that are known to be platforms.
1118  * Otherwise the behavior is undefined.
1119  */
1120 static inline struct snd_soc_platform *snd_soc_component_to_platform(
1121         struct snd_soc_component *component)
1122 {
1123         return container_of(component, struct snd_soc_platform, component);
1124 }
1125
1126 /* codec IO */
1127 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1128 unsigned int snd_soc_write(struct snd_soc_codec *codec,
1129                            unsigned int reg, unsigned int val);
1130
1131 /* device driver data */
1132
1133 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1134                 void *data)
1135 {
1136         card->drvdata = data;
1137 }
1138
1139 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1140 {
1141         return card->drvdata;
1142 }
1143
1144 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1145                 void *data)
1146 {
1147         dev_set_drvdata(codec->dev, data);
1148 }
1149
1150 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1151 {
1152         return dev_get_drvdata(codec->dev);
1153 }
1154
1155 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1156                 void *data)
1157 {
1158         dev_set_drvdata(platform->dev, data);
1159 }
1160
1161 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1162 {
1163         return dev_get_drvdata(platform->dev);
1164 }
1165
1166 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1167                 void *data)
1168 {
1169         dev_set_drvdata(rtd->dev, data);
1170 }
1171
1172 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1173 {
1174         return dev_get_drvdata(rtd->dev);
1175 }
1176
1177 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1178 {
1179         INIT_LIST_HEAD(&card->dai_dev_list);
1180         INIT_LIST_HEAD(&card->codec_dev_list);
1181         INIT_LIST_HEAD(&card->platform_dev_list);
1182         INIT_LIST_HEAD(&card->widgets);
1183         INIT_LIST_HEAD(&card->paths);
1184         INIT_LIST_HEAD(&card->dapm_list);
1185 }
1186
1187 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1188 {
1189         if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1190                 return 0;
1191         /*
1192          * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1193          * mc->reg != mc->rreg means that the control is
1194          * stereo (bits in one register or in two registers)
1195          */
1196         return 1;
1197 }
1198
1199 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1200         unsigned int val)
1201 {
1202         unsigned int i;
1203
1204         if (!e->values)
1205                 return val;
1206
1207         for (i = 0; i < e->items; i++)
1208                 if (val == e->values[i])
1209                         return i;
1210
1211         return 0;
1212 }
1213
1214 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1215         unsigned int item)
1216 {
1217         if (!e->values)
1218                 return item;
1219
1220         return e->values[item];
1221 }
1222
1223 static inline bool snd_soc_component_is_active(
1224         struct snd_soc_component *component)
1225 {
1226         return component->active != 0;
1227 }
1228
1229 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1230 {
1231         return snd_soc_component_is_active(&codec->component);
1232 }
1233
1234 /**
1235  * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1236  * @kcontrol: The control for which to get the CODEC
1237  *
1238  * Note: This function will only work correctly if the control has been
1239  * registered with snd_soc_add_codec_controls() or via table based setup of
1240  * snd_soc_codec_driver. Otherwise the behavior is undefined.
1241  */
1242 static inline struct snd_soc_codec *snd_soc_kcontrol_codec(
1243         struct snd_kcontrol *kcontrol)
1244 {
1245         return snd_kcontrol_chip(kcontrol);
1246 }
1247
1248 /**
1249  * snd_soc_kcontrol_platform() - Returns the platform that registerd the control
1250  * @kcontrol: The control for which to get the platform
1251  *
1252  * Note: This function will only work correctly if the control has been
1253  * registered with snd_soc_add_platform_controls() or via table based setup of
1254  * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1255  */
1256 static inline struct snd_soc_platform *snd_soc_kcontrol_platform(
1257         struct snd_kcontrol *kcontrol)
1258 {
1259         return snd_kcontrol_chip(kcontrol);
1260 }
1261
1262 int snd_soc_util_init(void);
1263 void snd_soc_util_exit(void);
1264
1265 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1266                                const char *propname);
1267 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1268                                           const char *propname);
1269 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1270                               unsigned int *slots,
1271                               unsigned int *slot_width);
1272 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1273                                    const char *propname);
1274 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1275                                      const char *prefix);
1276 int snd_soc_of_get_dai_name(struct device_node *of_node,
1277                             const char **dai_name);
1278
1279 #include <sound/soc-dai.h>
1280
1281 #ifdef CONFIG_DEBUG_FS
1282 extern struct dentry *snd_soc_debugfs_root;
1283 #endif
1284
1285 extern const struct dev_pm_ops snd_soc_pm_ops;
1286
1287 /* Helper functions */
1288 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1289 {
1290         mutex_lock(&dapm->card->dapm_mutex);
1291 }
1292
1293 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1294 {
1295         mutex_unlock(&dapm->card->dapm_mutex);
1296 }
1297
1298 #endif