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 #include <sound/soc-topology.h>
  31
  32 /*
  33  * Convenience kcontrol builders
  34  */
  35 #define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert, xautodisable) \
  36         ((unsigned long)&(struct soc_mixer_control) \
  37         {.reg = xreg, .rreg = xreg, .shift = shift_left, \
  38         .rshift = shift_right, .max = xmax, .platform_max = xmax, \
  39         .invert = xinvert, .autodisable = xautodisable})
  40 #define SOC_DOUBLE_S_VALUE(xreg, shift_left, shift_right, xmin, xmax, xsign_bit, xinvert, xautodisable) \
  41         ((unsigned long)&(struct soc_mixer_control) \
  42         {.reg = xreg, .rreg = xreg, .shift = shift_left, \
  43         .rshift = shift_right, .min = xmin, .max = xmax, .platform_max = xmax, \
  44         .sign_bit = xsign_bit, .invert = xinvert, .autodisable = xautodisable})
  45 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \
  46         SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable)
  47 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
  48         ((unsigned long)&(struct soc_mixer_control) \
  49         {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
  50 #define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
  51         ((unsigned long)&(struct soc_mixer_control) \
  52         {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  53         .max = xmax, .platform_max = xmax, .invert = xinvert})
  54 #define SOC_DOUBLE_R_S_VALUE(xlreg, xrreg, xshift, xmin, xmax, xsign_bit, xinvert) \
  55         ((unsigned long)&(struct soc_mixer_control) \
  56         {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  57         .max = xmax, .min = xmin, .platform_max = xmax, .sign_bit = xsign_bit, \
  58         .invert = xinvert})
  59 #define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
  60         ((unsigned long)&(struct soc_mixer_control) \
  61         {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  62         .min = xmin, .max = xmax, .platform_max = xmax, .invert = xinvert})
  63 #define SOC_SINGLE(xname, reg, shift, max, invert) \
  64 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  65         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  66         .put = snd_soc_put_volsw, \
  67         .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
  68 #define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
  69 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  70         .info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
  71         .put = snd_soc_put_volsw_range, \
  72         .private_value = (unsigned long)&(struct soc_mixer_control) \
  73                 {.reg = xreg, .rreg = xreg, .shift = xshift, \
  74                  .rshift = xshift,  .min = xmin, .max = xmax, \
  75                  .platform_max = xmax, .invert = xinvert} }
  76 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
  77 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  78         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  79                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  80         .tlv.p = (tlv_array), \
  81         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  82         .put = snd_soc_put_volsw, \
  83         .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
  84 #define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
  85 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  86         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
  87         SNDRV_CTL_ELEM_ACCESS_READWRITE, \
  88         .tlv.p  = (tlv_array),\
  89         .info = snd_soc_info_volsw, \
  90         .get = snd_soc_get_volsw_sx,\
  91         .put = snd_soc_put_volsw_sx, \
  92         .private_value = (unsigned long)&(struct soc_mixer_control) \
  93                 {.reg = xreg, .rreg = xreg, \
  94                 .shift = xshift, .rshift = xshift, \
  95                 .max = xmax, .min = xmin} }
  96 #define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
  97 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  98         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  99                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 100         .tlv.p = (tlv_array), \
 101         .info = snd_soc_info_volsw_range, \
 102         .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
 103         .private_value = (unsigned long)&(struct soc_mixer_control) \
 104                 {.reg = xreg, .rreg = xreg, .shift = xshift, \
 105                  .rshift = xshift, .min = xmin, .max = xmax, \
 106                  .platform_max = xmax, .invert = xinvert} }
 107 #define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
 108 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 109         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
 110         .put = snd_soc_put_volsw, \
 111         .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
 112                                           max, invert, 0) }
 113 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
 114 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 115         .info = snd_soc_info_volsw, \
 116         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 117         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 118                                             xmax, xinvert) }
 119 #define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
 120                            xmax, xinvert)               \
 121 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 122         .info = snd_soc_info_volsw_range, \
 123         .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
 124         .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
 125                                             xshift, xmin, xmax, xinvert) }
 126 #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
 127 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 128         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 129                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 130         .tlv.p = (tlv_array), \
 131         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
 132         .put = snd_soc_put_volsw, \
 133         .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
 134                                           max, invert, 0) }
 135 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
 136 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 137         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 138                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 139         .tlv.p = (tlv_array), \
 140         .info = snd_soc_info_volsw, \
 141         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 142         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 143                                             xmax, xinvert) }
 144 #define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
 145                                xmax, xinvert, tlv_array)                \
 146 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 147         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 148                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 149         .tlv.p = (tlv_array), \
 150         .info = snd_soc_info_volsw_range, \
 151         .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
 152         .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
 153                                             xshift, xmin, xmax, xinvert) }
 154 #define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
 155 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 156         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 157         SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 158         .tlv.p  = (tlv_array), \
 159         .info = snd_soc_info_volsw, \
 160         .get = snd_soc_get_volsw_sx, \
 161         .put = snd_soc_put_volsw_sx, \
 162         .private_value = (unsigned long)&(struct soc_mixer_control) \
 163                 {.reg = xreg, .rreg = xrreg, \
 164                 .shift = xshift, .rshift = xshift, \
 165                 .max = xmax, .min = xmin} }
 166 #define SOC_DOUBLE_R_S_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
 167 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 168         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 169                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 170         .tlv.p = (tlv_array), \
 171         .info = snd_soc_info_volsw, \
 172         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 173         .private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
 174                                             xmin, xmax, xsign_bit, xinvert) }
 175 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
 176 {       .iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 177         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 178                   SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 179         .tlv.p  = (tlv_array), \
 180         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
 181         .put = snd_soc_put_volsw, \
 182         .private_value = SOC_DOUBLE_S_VALUE(xreg, 0, 8, xmin, xmax, 7, 0, 0) }
 183 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \
 184 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 185         .items = xitems, .texts = xtexts, \
 186         .mask = xitems ? roundup_pow_of_two(xitems) - 1 : 0}
 187 #define SOC_ENUM_SINGLE(xreg, xshift, xitems, xtexts) \
 188         SOC_ENUM_DOUBLE(xreg, xshift, xshift, xitems, xtexts)
 189 #define SOC_ENUM_SINGLE_EXT(xitems, xtexts) \
 190 {       .items = xitems, .texts = xtexts }
 191 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xitems, xtexts, xvalues) \
 192 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 193         .mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues}
 194 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
 195         SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xitems, xtexts, xvalues)
 196 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
 197 {       .reg = xreg, .shift_l = xshift, .shift_r = xshift, \
 198         .mask = xmask, .items = xitems, .texts = xtexts, \
 199         .values = xvalues, .autodisable = 1}
 200 #define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \
 201         SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
 202 #define SOC_ENUM(xname, xenum) \
 203 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
 204         .info = snd_soc_info_enum_double, \
 205         .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
 206         .private_value = (unsigned long)&xenum }
 207 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
 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 = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
 213 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
 214          xhandler_get, xhandler_put) \
 215 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 216         .info = snd_soc_info_volsw, \
 217         .get = xhandler_get, .put = xhandler_put, \
 218         .private_value = \
 219                 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
 220 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
 221          xhandler_get, xhandler_put, tlv_array) \
 222 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 223         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 224                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 225         .tlv.p = (tlv_array), \
 226         .info = snd_soc_info_volsw, \
 227         .get = xhandler_get, .put = xhandler_put, \
 228         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
 229 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
 230          xhandler_get, xhandler_put, tlv_array) \
 231 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 232         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 233                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 234         .tlv.p = (tlv_array), \
 235         .info = snd_soc_info_volsw, \
 236         .get = xhandler_get, .put = xhandler_put, \
 237         .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
 238                                           xmax, xinvert, 0) }
 239 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
 240          xhandler_get, xhandler_put, tlv_array) \
 241 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 242         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 243                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 244         .tlv.p = (tlv_array), \
 245         .info = snd_soc_info_volsw, \
 246         .get = xhandler_get, .put = xhandler_put, \
 247         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 248                                             xmax, xinvert) }
 249 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
 250 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 251         .info = snd_soc_info_bool_ext, \
 252         .get = xhandler_get, .put = xhandler_put, \
 253         .private_value = xdata }
 254 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 255 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 256         .info = snd_soc_info_enum_double, \
 257         .get = xhandler_get, .put = xhandler_put, \
 258         .private_value = (unsigned long)&xenum }
 259 #define SOC_VALUE_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 260         SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put)
 261
 262 #define SND_SOC_BYTES(xname, xbase, xregs)                    \
 263 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
 264         .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
 265         .put = snd_soc_bytes_put, .private_value =            \
 266                 ((unsigned long)&(struct soc_bytes)           \
 267                 {.base = xbase, .num_regs = xregs }) }
 268
 269 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask)        \
 270 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
 271         .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
 272         .put = snd_soc_bytes_put, .private_value =            \
 273                 ((unsigned long)&(struct soc_bytes)           \
 274                 {.base = xbase, .num_regs = xregs,            \
 275                  .mask = xmask }) }
 276
 277 #define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \
 278 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 279         .info = snd_soc_bytes_info_ext, \
 280         .get = xhandler_get, .put = xhandler_put, \
 281         .private_value = (unsigned long)&(struct soc_bytes_ext) \
 282                 {.max = xcount} }
 283 #define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \
 284 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 285         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \
 286                   SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
 287         .tlv.c = (snd_soc_bytes_tlv_callback), \
 288         .info = snd_soc_bytes_info_ext, \
 289         .private_value = (unsigned long)&(struct soc_bytes_ext) \
 290                 {.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
 291 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
 292                 xmin, xmax, xinvert) \
 293 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 294         .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
 295         .put = snd_soc_put_xr_sx, \
 296         .private_value = (unsigned long)&(struct soc_mreg_control) \
 297                 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
 298                 .invert = xinvert, .min = xmin, .max = xmax} }
 299
 300 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
 301         SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
 302                 snd_soc_get_strobe, snd_soc_put_strobe)
 303
 304 /*
 305  * Simplified versions of above macros, declaring a struct and calculating
 306  * ARRAY_SIZE internally
 307  */
 308 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
 309         const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
 310                                                 ARRAY_SIZE(xtexts), xtexts)
 311 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
 312         SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
 313 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
 314         const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
 315 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
 316         const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
 317                                                         ARRAY_SIZE(xtexts), xtexts, xvalues)
 318 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
 319         SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
 320
 321 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
 322         const struct soc_enum name = SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, \
 323                 xshift, xmask, ARRAY_SIZE(xtexts), xtexts, xvalues)
 324
 325 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
 326         const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
 327
 328 /*
 329  * Component probe and remove ordering levels for components with runtime
 330  * dependencies.
 331  */
 332 #define SND_SOC_COMP_ORDER_FIRST                -2
 333 #define SND_SOC_COMP_ORDER_EARLY                -1
 334 #define SND_SOC_COMP_ORDER_NORMAL               0
 335 #define SND_SOC_COMP_ORDER_LATE         1
 336 #define SND_SOC_COMP_ORDER_LAST         2
 337
 338 /*
 339  * Bias levels
 340  *
 341  * @ON:      Bias is fully on for audio playback and capture operations.
 342  * @PREPARE: Prepare for audio operations. Called before DAPM switching for
 343  *           stream start and stop operations.
 344  * @STANDBY: Low power standby state when no playback/capture operations are
 345  *           in progress. NOTE: The transition time between STANDBY and ON
 346  *           should be as fast as possible and no longer than 10ms.
 347  * @OFF:     Power Off. No restrictions on transition times.
 348  */
 349 enum snd_soc_bias_level {
 350         SND_SOC_BIAS_OFF = 0,
 351         SND_SOC_BIAS_STANDBY = 1,
 352         SND_SOC_BIAS_PREPARE = 2,
 353         SND_SOC_BIAS_ON = 3,
 354 };
 355
 356 struct device_node;
 357 struct snd_jack;
 358 struct snd_soc_card;
 359 struct snd_soc_pcm_stream;
 360 struct snd_soc_ops;
 361 struct snd_soc_pcm_runtime;
 362 struct snd_soc_dai;
 363 struct snd_soc_dai_driver;
 364 struct snd_soc_platform;
 365 struct snd_soc_dai_link;
 366 struct snd_soc_platform_driver;
 367 struct snd_soc_codec;
 368 struct snd_soc_codec_driver;
 369 struct snd_soc_component;
 370 struct snd_soc_component_driver;
 371 struct soc_enum;
 372 struct snd_soc_jack;
 373 struct snd_soc_jack_zone;
 374 struct snd_soc_jack_pin;
 375 #include <sound/soc-dapm.h>
 376 #include <sound/soc-dpcm.h>
 377
 378 struct snd_soc_jack_gpio;
 379
 380 typedef int (*hw_write_t)(void *,const char* ,int);
 381
 382 enum snd_soc_pcm_subclass {
 383         SND_SOC_PCM_CLASS_PCM   = 0,
 384         SND_SOC_PCM_CLASS_BE    = 1,
 385 };
 386
 387 enum snd_soc_card_subclass {
 388         SND_SOC_CARD_CLASS_INIT         = 0,
 389         SND_SOC_CARD_CLASS_RUNTIME      = 1,
 390 };
 391
 392 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
 393                              int source, unsigned int freq, int dir);
 394 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
 395                           unsigned int freq_in, unsigned int freq_out);
 396
 397 int snd_soc_register_card(struct snd_soc_card *card);
 398 int snd_soc_unregister_card(struct snd_soc_card *card);
 399 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
 400 #ifdef CONFIG_PM_SLEEP
 401 int snd_soc_suspend(struct device *dev);
 402 int snd_soc_resume(struct device *dev);
 403 #else
 404 static inline int snd_soc_suspend(struct device *dev)
 405 {
 406         return 0;
 407 }
 408
 409 static inline int snd_soc_resume(struct device *dev)
 410 {
 411         return 0;
 412 }
 413 #endif
 414 int snd_soc_poweroff(struct device *dev);
 415 int snd_soc_register_platform(struct device *dev,
 416                 const struct snd_soc_platform_driver *platform_drv);
 417 int devm_snd_soc_register_platform(struct device *dev,
 418                 const struct snd_soc_platform_driver *platform_drv);
 419 void snd_soc_unregister_platform(struct device *dev);
 420 int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
 421                 const struct snd_soc_platform_driver *platform_drv);
 422 void snd_soc_remove_platform(struct snd_soc_platform *platform);
 423 struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev);
 424 int snd_soc_register_codec(struct device *dev,
 425                 const struct snd_soc_codec_driver *codec_drv,
 426                 struct snd_soc_dai_driver *dai_drv, int num_dai);
 427 void snd_soc_unregister_codec(struct device *dev);
 428 int snd_soc_register_component(struct device *dev,
 429                          const struct snd_soc_component_driver *cmpnt_drv,
 430                          struct snd_soc_dai_driver *dai_drv, int num_dai);
 431 int devm_snd_soc_register_component(struct device *dev,
 432                          const struct snd_soc_component_driver *cmpnt_drv,
 433                          struct snd_soc_dai_driver *dai_drv, int num_dai);
 434 void snd_soc_unregister_component(struct device *dev);
 435 int snd_soc_cache_init(struct snd_soc_codec *codec);
 436 int snd_soc_cache_exit(struct snd_soc_codec *codec);
 437
 438 int snd_soc_platform_read(struct snd_soc_platform *platform,
 439                                         unsigned int reg);
 440 int snd_soc_platform_write(struct snd_soc_platform *platform,
 441                                         unsigned int reg, unsigned int val);
 442 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
 443 int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
 444
 445 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
 446                 const char *dai_link, int stream);
 447 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
 448                 const char *dai_link);
 449
 450 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
 451 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
 452 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
 453
 454 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
 455         unsigned int dai_fmt);
 456
 457 /* Utility functions to get clock rates from various things */
 458 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 459 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 460 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 461 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 462
 463 /* set runtime hw params */
 464 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 465         const struct snd_pcm_hardware *hw);
 466
 467 int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
 468                 int cmd, struct snd_soc_platform *platform);
 469
 470 int soc_dai_hw_params(struct snd_pcm_substream *substream,
 471                       struct snd_pcm_hw_params *params,
 472                       struct snd_soc_dai *dai);
 473
 474 /* Jack reporting */
 475 int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type,
 476         struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins,
 477         unsigned int num_pins);
 478
 479 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 480 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 481                           struct snd_soc_jack_pin *pins);
 482 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
 483                                     struct notifier_block *nb);
 484 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
 485                                       struct notifier_block *nb);
 486 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
 487                           struct snd_soc_jack_zone *zones);
 488 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
 489 #ifdef CONFIG_GPIOLIB
 490 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 491                         struct snd_soc_jack_gpio *gpios);
 492 int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
 493                             struct snd_soc_jack *jack,
 494                             int count, struct snd_soc_jack_gpio *gpios);
 495 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 496                         struct snd_soc_jack_gpio *gpios);
 497 #else
 498 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 499                                          struct snd_soc_jack_gpio *gpios)
 500 {
 501         return 0;
 502 }
 503
 504 static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
 505                                           struct snd_soc_jack *jack,
 506                                           int count,
 507                                           struct snd_soc_jack_gpio *gpios)
 508 {
 509         return 0;
 510 }
 511
 512 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 513                                            struct snd_soc_jack_gpio *gpios)
 514 {
 515 }
 516 #endif
 517
 518 /* codec register bit access */
 519 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned int reg,
 520                                 unsigned int mask, unsigned int value);
 521 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
 522                                unsigned int reg, unsigned int mask,
 523                                unsigned int value);
 524 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned int reg,
 525                                 unsigned int mask, unsigned int value);
 526
 527 #ifdef CONFIG_SND_SOC_AC97_BUS
 528 struct snd_ac97 *snd_soc_alloc_ac97_codec(struct snd_soc_codec *codec);
 529 struct snd_ac97 *snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
 530         unsigned int id, unsigned int id_mask);
 531 void snd_soc_free_ac97_codec(struct snd_ac97 *ac97);
 532
 533 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
 534 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 535                 struct platform_device *pdev);
 536
 537 extern struct snd_ac97_bus_ops *soc_ac97_ops;
 538 #else
 539 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 540         struct platform_device *pdev)
 541 {
 542         return 0;
 543 }
 544
 545 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
 546 {
 547         return 0;
 548 }
 549 #endif
 550
 551 /*
 552  *Controls
 553  */
 554 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 555                                   void *data, const char *long_name,
 556                                   const char *prefix);
 557 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
 558                                                const char *name);
 559 int snd_soc_add_component_controls(struct snd_soc_component *component,
 560         const struct snd_kcontrol_new *controls, unsigned int num_controls);
 561 int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
 562         const struct snd_kcontrol_new *controls, unsigned int num_controls);
 563 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
 564         const struct snd_kcontrol_new *controls, unsigned int num_controls);
 565 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
 566         const struct snd_kcontrol_new *controls, int num_controls);
 567 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
 568         const struct snd_kcontrol_new *controls, int num_controls);
 569 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 570         struct snd_ctl_elem_info *uinfo);
 571 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 572         struct snd_ctl_elem_value *ucontrol);
 573 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 574         struct snd_ctl_elem_value *ucontrol);
 575 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 576         struct snd_ctl_elem_info *uinfo);
 577 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 578 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 579         struct snd_ctl_elem_value *ucontrol);
 580 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 581         struct snd_ctl_elem_value *ucontrol);
 582 #define snd_soc_get_volsw_2r snd_soc_get_volsw
 583 #define snd_soc_put_volsw_2r snd_soc_put_volsw
 584 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
 585         struct snd_ctl_elem_value *ucontrol);
 586 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
 587         struct snd_ctl_elem_value *ucontrol);
 588 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
 589         struct snd_ctl_elem_info *uinfo);
 590 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
 591         struct snd_ctl_elem_value *ucontrol);
 592 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
 593         struct snd_ctl_elem_value *ucontrol);
 594 int snd_soc_limit_volume(struct snd_soc_codec *codec,
 595         const char *name, int max);
 596 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
 597                        struct snd_ctl_elem_info *uinfo);
 598 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
 599                       struct snd_ctl_elem_value *ucontrol);
 600 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
 601                       struct snd_ctl_elem_value *ucontrol);
 602 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
 603         struct snd_ctl_elem_info *ucontrol);
 604 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
 605         unsigned int size, unsigned int __user *tlv);
 606 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
 607         struct snd_ctl_elem_info *uinfo);
 608 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
 609         struct snd_ctl_elem_value *ucontrol);
 610 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
 611         struct snd_ctl_elem_value *ucontrol);
 612 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
 613         struct snd_ctl_elem_value *ucontrol);
 614 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
 615         struct snd_ctl_elem_value *ucontrol);
 616
 617 /**
 618  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 619  *
 620  * @pin:    name of the pin to update
 621  * @mask:   bits to check for in reported jack status
 622  * @invert: if non-zero then pin is enabled when status is not reported
 623  */
 624 struct snd_soc_jack_pin {
 625         struct list_head list;
 626         const char *pin;
 627         int mask;
 628         bool invert;
 629 };
 630
 631 /**
 632  * struct snd_soc_jack_zone - Describes voltage zones of jack detection
 633  *
 634  * @min_mv: start voltage in mv
 635  * @max_mv: end voltage in mv
 636  * @jack_type: type of jack that is expected for this voltage
 637  * @debounce_time: debounce_time for jack, codec driver should wait for this
 638  *              duration before reading the adc for voltages
 639  * @:list: list container
 640  */
 641 struct snd_soc_jack_zone {
 642         unsigned int min_mv;
 643         unsigned int max_mv;
 644         unsigned int jack_type;
 645         unsigned int debounce_time;
 646         struct list_head list;
 647 };
 648
 649 /**
 650  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 651  *
 652  * @gpio:         legacy gpio number
 653  * @idx:          gpio descriptor index within the function of the GPIO
 654  *                consumer device
 655  * @gpiod_dev     GPIO consumer device
 656  * @name:         gpio name. Also as connection ID for the GPIO consumer
 657  *                device function name lookup
 658  * @report:       value to report when jack detected
 659  * @invert:       report presence in low state
 660  * @debouce_time: debouce time in ms
 661  * @wake:         enable as wake source
 662  * @jack_status_check: callback function which overrides the detection
 663  *                     to provide more complex checks (eg, reading an
 664  *                     ADC).
 665  */
 666 struct snd_soc_jack_gpio {
 667         unsigned int gpio;
 668         unsigned int idx;
 669         struct device *gpiod_dev;
 670         const char *name;
 671         int report;
 672         int invert;
 673         int debounce_time;
 674         bool wake;
 675
 676         struct snd_soc_jack *jack;
 677         struct delayed_work work;
 678         struct gpio_desc *desc;
 679
 680         void *data;
 681         int (*jack_status_check)(void *data);
 682 };
 683
 684 struct snd_soc_jack {
 685         struct mutex mutex;
 686         struct snd_jack *jack;
 687         struct snd_soc_card *card;
 688         struct list_head pins;
 689         int status;
 690         struct blocking_notifier_head notifier;
 691         struct list_head jack_zones;
 692 };
 693
 694 /* SoC PCM stream information */
 695 struct snd_soc_pcm_stream {
 696         const char *stream_name;
 697         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 698         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 699         unsigned int rate_min;          /* min rate */
 700         unsigned int rate_max;          /* max rate */
 701         unsigned int channels_min;      /* min channels */
 702         unsigned int channels_max;      /* max channels */
 703         unsigned int sig_bits;          /* number of bits of content */
 704 };
 705
 706 /* SoC audio ops */
 707 struct snd_soc_ops {
 708         int (*startup)(struct snd_pcm_substream *);
 709         void (*shutdown)(struct snd_pcm_substream *);
 710         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 711         int (*hw_free)(struct snd_pcm_substream *);
 712         int (*prepare)(struct snd_pcm_substream *);
 713         int (*trigger)(struct snd_pcm_substream *, int);
 714 };
 715
 716 struct snd_soc_compr_ops {
 717         int (*startup)(struct snd_compr_stream *);
 718         void (*shutdown)(struct snd_compr_stream *);
 719         int (*set_params)(struct snd_compr_stream *);
 720         int (*trigger)(struct snd_compr_stream *);
 721 };
 722
 723 /* component interface */
 724 struct snd_soc_component_driver {
 725         const char *name;
 726
 727         /* Default control and setup, added after probe() is run */
 728         const struct snd_kcontrol_new *controls;
 729         unsigned int num_controls;
 730         const struct snd_soc_dapm_widget *dapm_widgets;
 731         unsigned int num_dapm_widgets;
 732         const struct snd_soc_dapm_route *dapm_routes;
 733         unsigned int num_dapm_routes;
 734
 735         int (*probe)(struct snd_soc_component *);
 736         void (*remove)(struct snd_soc_component *);
 737
 738         /* DT */
 739         int (*of_xlate_dai_name)(struct snd_soc_component *component,
 740                                  struct of_phandle_args *args,
 741                                  const char **dai_name);
 742         void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type,
 743                 int subseq);
 744         int (*stream_event)(struct snd_soc_component *, int event);
 745
 746         /* probe ordering - for components with runtime dependencies */
 747         int probe_order;
 748         int remove_order;
 749 };
 750
 751 struct snd_soc_component {
 752         const char *name;
 753         int id;
 754         const char *name_prefix;
 755         struct device *dev;
 756         struct snd_soc_card *card;
 757
 758         unsigned int active;
 759
 760         unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
 761         unsigned int registered_as_component:1;
 762
 763         struct list_head list;
 764
 765         struct snd_soc_dai_driver *dai_drv;
 766         int num_dai;
 767
 768         const struct snd_soc_component_driver *driver;
 769
 770         struct list_head dai_list;
 771
 772         int (*read)(struct snd_soc_component *, unsigned int, unsigned int *);
 773         int (*write)(struct snd_soc_component *, unsigned int, unsigned int);
 774
 775         struct regmap *regmap;
 776         int val_bytes;
 777
 778         struct mutex io_mutex;
 779
 780         /* attached dynamic objects */
 781         struct list_head dobj_list;
 782
 783 #ifdef CONFIG_DEBUG_FS
 784         struct dentry *debugfs_root;
 785 #endif
 786
 787         /*
 788         * DO NOT use any of the fields below in drivers, they are temporary and
 789         * are going to be removed again soon. If you use them in driver code the
 790         * driver will be marked as BROKEN when these fields are removed.
 791         */
 792
 793         /* Don't use these, use snd_soc_component_get_dapm() */
 794         struct snd_soc_dapm_context dapm;
 795
 796         const struct snd_kcontrol_new *controls;
 797         unsigned int num_controls;
 798         const struct snd_soc_dapm_widget *dapm_widgets;
 799         unsigned int num_dapm_widgets;
 800         const struct snd_soc_dapm_route *dapm_routes;
 801         unsigned int num_dapm_routes;
 802         struct snd_soc_codec *codec;
 803
 804         int (*probe)(struct snd_soc_component *);
 805         void (*remove)(struct snd_soc_component *);
 806
 807 #ifdef CONFIG_DEBUG_FS
 808         void (*init_debugfs)(struct snd_soc_component *component);
 809         const char *debugfs_prefix;
 810 #endif
 811 };
 812
 813 /* SoC Audio Codec device */
 814 struct snd_soc_codec {
 815         struct device *dev;
 816         const struct snd_soc_codec_driver *driver;
 817
 818         struct list_head list;
 819         struct list_head card_list;
 820
 821         /* runtime */
 822         unsigned int cache_bypass:1; /* Suppress access to the cache */
 823         unsigned int suspended:1; /* Codec is in suspend PM state */
 824         unsigned int cache_init:1; /* codec cache has been initialized */
 825
 826         /* codec IO */
 827         void *control_data; /* codec control (i2c/3wire) data */
 828         hw_write_t hw_write;
 829         void *reg_cache;
 830
 831         /* component */
 832         struct snd_soc_component component;
 833
 834 #ifdef CONFIG_DEBUG_FS
 835         struct dentry *debugfs_reg;
 836 #endif
 837 };
 838
 839 /* codec driver */
 840 struct snd_soc_codec_driver {
 841
 842         /* driver ops */
 843         int (*probe)(struct snd_soc_codec *);
 844         int (*remove)(struct snd_soc_codec *);
 845         int (*suspend)(struct snd_soc_codec *);
 846         int (*resume)(struct snd_soc_codec *);
 847         struct snd_soc_component_driver component_driver;
 848
 849         /* Default control and setup, added after probe() is run */
 850         const struct snd_kcontrol_new *controls;
 851         int num_controls;
 852         const struct snd_soc_dapm_widget *dapm_widgets;
 853         int num_dapm_widgets;
 854         const struct snd_soc_dapm_route *dapm_routes;
 855         int num_dapm_routes;
 856
 857         /* codec wide operations */
 858         int (*set_sysclk)(struct snd_soc_codec *codec,
 859                           int clk_id, int source, unsigned int freq, int dir);
 860         int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
 861                 unsigned int freq_in, unsigned int freq_out);
 862
 863         /* codec IO */
 864         struct regmap *(*get_regmap)(struct device *);
 865         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 866         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 867         unsigned int reg_cache_size;
 868         short reg_cache_step;
 869         short reg_word_size;
 870         const void *reg_cache_default;
 871
 872         /* codec bias level */
 873         int (*set_bias_level)(struct snd_soc_codec *,
 874                               enum snd_soc_bias_level level);
 875         bool idle_bias_off;
 876         bool suspend_bias_off;
 877
 878         void (*seq_notifier)(struct snd_soc_dapm_context *,
 879                              enum snd_soc_dapm_type, int);
 880
 881         bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */
 882 };
 883
 884 /* SoC platform interface */
 885 struct snd_soc_platform_driver {
 886
 887         int (*probe)(struct snd_soc_platform *);
 888         int (*remove)(struct snd_soc_platform *);
 889         struct snd_soc_component_driver component_driver;
 890
 891         /* pcm creation and destruction */
 892         int (*pcm_new)(struct snd_soc_pcm_runtime *);
 893         void (*pcm_free)(struct snd_pcm *);
 894
 895         /*
 896          * For platform caused delay reporting.
 897          * Optional.
 898          */
 899         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 900                 struct snd_soc_dai *);
 901
 902         /* platform stream pcm ops */
 903         const struct snd_pcm_ops *ops;
 904
 905         /* platform stream compress ops */
 906         const struct snd_compr_ops *compr_ops;
 907
 908         int (*bespoke_trigger)(struct snd_pcm_substream *, int);
 909 };
 910
 911 struct snd_soc_dai_link_component {
 912         const char *name;
 913         struct device_node *of_node;
 914         const char *dai_name;
 915 };
 916
 917 struct snd_soc_platform {
 918         struct device *dev;
 919         const struct snd_soc_platform_driver *driver;
 920
 921         struct list_head list;
 922
 923         struct snd_soc_component component;
 924 };
 925
 926 struct snd_soc_dai_link {
 927         /* config - must be set by machine driver */
 928         const char *name;                       /* Codec name */
 929         const char *stream_name;                /* Stream name */
 930         /*
 931          * You MAY specify the link's CPU-side device, either by device name,
 932          * or by DT/OF node, but not both. If this information is omitted,
 933          * the CPU-side DAI is matched using .cpu_dai_name only, which hence
 934          * must be globally unique. These fields are currently typically used
 935          * only for codec to codec links, or systems using device tree.
 936          */
 937         const char *cpu_name;
 938         struct device_node *cpu_of_node;
 939         /*
 940          * You MAY specify the DAI name of the CPU DAI. If this information is
 941          * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
 942          * only, which only works well when that device exposes a single DAI.
 943          */
 944         const char *cpu_dai_name;
 945         /*
 946          * You MUST specify the link's codec, either by device name, or by
 947          * DT/OF node, but not both.
 948          */
 949         const char *codec_name;
 950         struct device_node *codec_of_node;
 951         /* You MUST specify the DAI name within the codec */
 952         const char *codec_dai_name;
 953
 954         struct snd_soc_dai_link_component *codecs;
 955         unsigned int num_codecs;
 956
 957         /*
 958          * You MAY specify the link's platform/PCM/DMA driver, either by
 959          * device name, or by DT/OF node, but not both. Some forms of link
 960          * do not need a platform.
 961          */
 962         const char *platform_name;
 963         struct device_node *platform_of_node;
 964         int be_id;      /* optional ID for machine driver BE identification */
 965
 966         const struct snd_soc_pcm_stream *params;
 967         unsigned int num_params;
 968
 969         unsigned int dai_fmt;           /* format to set on init */
 970
 971         enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
 972
 973         /* codec/machine specific init - e.g. add machine controls */
 974         int (*init)(struct snd_soc_pcm_runtime *rtd);
 975
 976         /* optional hw_params re-writing for BE and FE sync */
 977         int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
 978                         struct snd_pcm_hw_params *params);
 979
 980         /* machine stream operations */
 981         const struct snd_soc_ops *ops;
 982         const struct snd_soc_compr_ops *compr_ops;
 983
 984         /* For unidirectional dai links */
 985         bool playback_only;
 986         bool capture_only;
 987
 988         /* Mark this pcm with non atomic ops */
 989         bool nonatomic;
 990
 991         /* Keep DAI active over suspend */
 992         unsigned int ignore_suspend:1;
 993
 994         /* Symmetry requirements */
 995         unsigned int symmetric_rates:1;
 996         unsigned int symmetric_channels:1;
 997         unsigned int symmetric_samplebits:1;
 998
 999         /* Do not create a PCM for this DAI link (Backend link) */
1000         unsigned int no_pcm:1;
1001
1002         /* This DAI link can route to other DAI links at runtime (Frontend)*/
1003         unsigned int dynamic:1;
1004
1005         /* DPCM capture and Playback support */
1006         unsigned int dpcm_capture:1;
1007         unsigned int dpcm_playback:1;
1008
1009         /* DPCM used FE & BE merged format */
1010         unsigned int dpcm_merged_format:1;
1011
1012         /* pmdown_time is ignored at stop */
1013         unsigned int ignore_pmdown_time:1;
1014 };
1015
1016 struct snd_soc_codec_conf {
1017         /*
1018          * specify device either by device name, or by
1019          * DT/OF node, but not both.
1020          */
1021         const char *dev_name;
1022         struct device_node *of_node;
1023
1024         /*
1025          * optional map of kcontrol, widget and path name prefixes that are
1026          * associated per device
1027          */
1028         const char *name_prefix;
1029 };
1030
1031 struct snd_soc_aux_dev {
1032         const char *name;               /* Codec name */
1033
1034         /*
1035          * specify multi-codec either by device name, or by
1036          * DT/OF node, but not both.
1037          */
1038         const char *codec_name;
1039         struct device_node *codec_of_node;
1040
1041         /* codec/machine specific init - e.g. add machine controls */
1042         int (*init)(struct snd_soc_component *component);
1043 };
1044
1045 /* SoC card */
1046 struct snd_soc_card {
1047         const char *name;
1048         const char *long_name;
1049         const char *driver_name;
1050         struct device *dev;
1051         struct snd_card *snd_card;
1052         struct module *owner;
1053
1054         struct mutex mutex;
1055         struct mutex dapm_mutex;
1056
1057         bool instantiated;
1058
1059         int (*probe)(struct snd_soc_card *card);
1060         int (*late_probe)(struct snd_soc_card *card);
1061         int (*remove)(struct snd_soc_card *card);
1062
1063         /* the pre and post PM functions are used to do any PM work before and
1064          * after the codec and DAI's do any PM work. */
1065         int (*suspend_pre)(struct snd_soc_card *card);
1066         int (*suspend_post)(struct snd_soc_card *card);
1067         int (*resume_pre)(struct snd_soc_card *card);
1068         int (*resume_post)(struct snd_soc_card *card);
1069
1070         /* callbacks */
1071         int (*set_bias_level)(struct snd_soc_card *,
1072                               struct snd_soc_dapm_context *dapm,
1073                               enum snd_soc_bias_level level);
1074         int (*set_bias_level_post)(struct snd_soc_card *,
1075                                    struct snd_soc_dapm_context *dapm,
1076                                    enum snd_soc_bias_level level);
1077
1078         long pmdown_time;
1079
1080         /* CPU <--> Codec DAI links  */
1081         struct snd_soc_dai_link *dai_link;
1082         int num_links;
1083         struct snd_soc_pcm_runtime *rtd;
1084         int num_rtd;
1085
1086         /* optional codec specific configuration */
1087         struct snd_soc_codec_conf *codec_conf;
1088         int num_configs;
1089
1090         /*
1091          * optional auxiliary devices such as amplifiers or codecs with DAI
1092          * link unused
1093          */
1094         struct snd_soc_aux_dev *aux_dev;
1095         int num_aux_devs;
1096         struct snd_soc_pcm_runtime *rtd_aux;
1097         int num_aux_rtd;
1098
1099         const struct snd_kcontrol_new *controls;
1100         int num_controls;
1101
1102         /*
1103          * Card-specific routes and widgets.
1104          * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1105          */
1106         const struct snd_soc_dapm_widget *dapm_widgets;
1107         int num_dapm_widgets;
1108         const struct snd_soc_dapm_route *dapm_routes;
1109         int num_dapm_routes;
1110         const struct snd_soc_dapm_widget *of_dapm_widgets;
1111         int num_of_dapm_widgets;
1112         const struct snd_soc_dapm_route *of_dapm_routes;
1113         int num_of_dapm_routes;
1114         bool fully_routed;
1115
1116         struct work_struct deferred_resume_work;
1117
1118         /* lists of probed devices belonging to this card */
1119         struct list_head codec_dev_list;
1120
1121         struct list_head widgets;
1122         struct list_head paths;
1123         struct list_head dapm_list;
1124         struct list_head dapm_dirty;
1125
1126         /* attached dynamic objects */
1127         struct list_head dobj_list;
1128
1129         /* Generic DAPM context for the card */
1130         struct snd_soc_dapm_context dapm;
1131         struct snd_soc_dapm_stats dapm_stats;
1132         struct snd_soc_dapm_update *update;
1133
1134 #ifdef CONFIG_DEBUG_FS
1135         struct dentry *debugfs_card_root;
1136         struct dentry *debugfs_pop_time;
1137 #endif
1138         u32 pop_time;
1139
1140         void *drvdata;
1141 };
1142
1143 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1144 struct snd_soc_pcm_runtime {
1145         struct device *dev;
1146         struct snd_soc_card *card;
1147         struct snd_soc_dai_link *dai_link;
1148         struct mutex pcm_mutex;
1149         enum snd_soc_pcm_subclass pcm_subclass;
1150         struct snd_pcm_ops ops;
1151
1152         unsigned int dev_registered:1;
1153
1154         /* Dynamic PCM BE runtime data */
1155         struct snd_soc_dpcm_runtime dpcm[2];
1156         int fe_compr;
1157
1158         long pmdown_time;
1159         unsigned char pop_wait:1;
1160
1161         /* runtime devices */
1162         struct snd_pcm *pcm;
1163         struct snd_compr *compr;
1164         struct snd_soc_codec *codec;
1165         struct snd_soc_platform *platform;
1166         struct snd_soc_dai *codec_dai;
1167         struct snd_soc_dai *cpu_dai;
1168         struct snd_soc_component *component; /* Only valid for AUX dev rtds */
1169
1170         struct snd_soc_dai **codec_dais;
1171         unsigned int num_codecs;
1172
1173         struct delayed_work delayed_work;
1174 #ifdef CONFIG_DEBUG_FS
1175         struct dentry *debugfs_dpcm_root;
1176         struct dentry *debugfs_dpcm_state;
1177 #endif
1178 };
1179
1180 /* mixer control */
1181 struct soc_mixer_control {
1182         int min, max, platform_max;
1183         int reg, rreg;
1184         unsigned int shift, rshift;
1185         unsigned int sign_bit;
1186         unsigned int invert:1;
1187         unsigned int autodisable:1;
1188         struct snd_soc_dobj dobj;
1189 };
1190
1191 struct soc_bytes {
1192         int base;
1193         int num_regs;
1194         u32 mask;
1195 };
1196
1197 struct soc_bytes_ext {
1198         int max;
1199         struct snd_soc_dobj dobj;
1200
1201         /* used for TLV byte control */
1202         int (*get)(unsigned int __user *bytes, unsigned int size);
1203         int (*put)(const unsigned int __user *bytes, unsigned int size);
1204 };
1205
1206 /* multi register control */
1207 struct soc_mreg_control {
1208         long min, max;
1209         unsigned int regbase, regcount, nbits, invert;
1210 };
1211
1212 /* enumerated kcontrol */
1213 struct soc_enum {
1214         int reg;
1215         unsigned char shift_l;
1216         unsigned char shift_r;
1217         unsigned int items;
1218         unsigned int mask;
1219         const char * const *texts;
1220         const unsigned int *values;
1221         unsigned int autodisable:1;
1222         struct snd_soc_dobj dobj;
1223 };
1224
1225 /**
1226  * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1227  * @component: The component to cast to a CODEC
1228  *
1229  * This function must only be used on components that are known to be CODECs.
1230  * Otherwise the behavior is undefined.
1231  */
1232 static inline struct snd_soc_codec *snd_soc_component_to_codec(
1233         struct snd_soc_component *component)
1234 {
1235         return container_of(component, struct snd_soc_codec, component);
1236 }
1237
1238 /**
1239  * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1240  * @component: The component to cast to a platform
1241  *
1242  * This function must only be used on components that are known to be platforms.
1243  * Otherwise the behavior is undefined.
1244  */
1245 static inline struct snd_soc_platform *snd_soc_component_to_platform(
1246         struct snd_soc_component *component)
1247 {
1248         return container_of(component, struct snd_soc_platform, component);
1249 }
1250
1251 /**
1252  * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
1253  *  embedded in
1254  * @dapm: The DAPM context to cast to the component
1255  *
1256  * This function must only be used on DAPM contexts that are known to be part of
1257  * a component (e.g. in a component driver). Otherwise the behavior is
1258  * undefined.
1259  */
1260 static inline struct snd_soc_component *snd_soc_dapm_to_component(
1261         struct snd_soc_dapm_context *dapm)
1262 {
1263         return container_of(dapm, struct snd_soc_component, dapm);
1264 }
1265
1266 /**
1267  * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in
1268  * @dapm: The DAPM context to cast to the CODEC
1269  *
1270  * This function must only be used on DAPM contexts that are known to be part of
1271  * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1272  */
1273 static inline struct snd_soc_codec *snd_soc_dapm_to_codec(
1274         struct snd_soc_dapm_context *dapm)
1275 {
1276         return snd_soc_component_to_codec(snd_soc_dapm_to_component(dapm));
1277 }
1278
1279 /**
1280  * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is
1281  *  embedded in
1282  * @dapm: The DAPM context to cast to the platform.
1283  *
1284  * This function must only be used on DAPM contexts that are known to be part of
1285  * a platform (e.g. in a platform driver). Otherwise the behavior is undefined.
1286  */
1287 static inline struct snd_soc_platform *snd_soc_dapm_to_platform(
1288         struct snd_soc_dapm_context *dapm)
1289 {
1290         return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm));
1291 }
1292
1293 /**
1294  * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
1295  *  component
1296  * @component: The component for which to get the DAPM context
1297  */
1298 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
1299         struct snd_soc_component *component)
1300 {
1301         return &component->dapm;
1302 }
1303
1304 /**
1305  * snd_soc_codec_get_dapm() - Returns the DAPM context for the CODEC
1306  * @codec: The CODEC for which to get the DAPM context
1307  *
1308  * Note: Use this function instead of directly accessing the CODEC's dapm field
1309  */
1310 static inline struct snd_soc_dapm_context *snd_soc_codec_get_dapm(
1311         struct snd_soc_codec *codec)
1312 {
1313         return snd_soc_component_get_dapm(&codec->component);
1314 }
1315
1316 /**
1317  * snd_soc_dapm_init_bias_level() - Initialize CODEC DAPM bias level
1318  * @dapm: The CODEC for which to initialize the DAPM bias level
1319  * @level: The DAPM level to initialize to
1320  *
1321  * Initializes the CODEC DAPM bias level. See snd_soc_dapm_init_bias_level().
1322  */
1323 static inline void snd_soc_codec_init_bias_level(struct snd_soc_codec *codec,
1324         enum snd_soc_bias_level level)
1325 {
1326         snd_soc_dapm_init_bias_level(snd_soc_codec_get_dapm(codec), level);
1327 }
1328
1329 /**
1330  * snd_soc_dapm_get_bias_level() - Get current CODEC DAPM bias level
1331  * @codec: The CODEC for which to get the DAPM bias level
1332  *
1333  * Returns: The current DAPM bias level of the CODEC.
1334  */
1335 static inline enum snd_soc_bias_level snd_soc_codec_get_bias_level(
1336         struct snd_soc_codec *codec)
1337 {
1338         return snd_soc_dapm_get_bias_level(snd_soc_codec_get_dapm(codec));
1339 }
1340
1341 /**
1342  * snd_soc_codec_force_bias_level() - Set the CODEC DAPM bias level
1343  * @codec: The CODEC for which to set the level
1344  * @level: The level to set to
1345  *
1346  * Forces the CODEC bias level to a specific state. See
1347  * snd_soc_dapm_force_bias_level().
1348  */
1349 static inline int snd_soc_codec_force_bias_level(struct snd_soc_codec *codec,
1350         enum snd_soc_bias_level level)
1351 {
1352         return snd_soc_dapm_force_bias_level(snd_soc_codec_get_dapm(codec),
1353                 level);
1354 }
1355
1356 /**
1357  * snd_soc_dapm_kcontrol_codec() - Returns the codec associated to a kcontrol
1358  * @kcontrol: The kcontrol
1359  *
1360  * This function must only be used on DAPM contexts that are known to be part of
1361  * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1362  */
1363 static inline struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(
1364         struct snd_kcontrol *kcontrol)
1365 {
1366         return snd_soc_dapm_to_codec(snd_soc_dapm_kcontrol_dapm(kcontrol));
1367 }
1368
1369 /* codec IO */
1370 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1371 int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg,
1372         unsigned int val);
1373
1374 /**
1375  * snd_soc_cache_sync() - Sync the register cache with the hardware
1376  * @codec: CODEC to sync
1377  *
1378  * Note: This function will call regcache_sync()
1379  */
1380 static inline int snd_soc_cache_sync(struct snd_soc_codec *codec)
1381 {
1382         return regcache_sync(codec->component.regmap);
1383 }
1384
1385 /* component IO */
1386 int snd_soc_component_read(struct snd_soc_component *component,
1387         unsigned int reg, unsigned int *val);
1388 int snd_soc_component_write(struct snd_soc_component *component,
1389         unsigned int reg, unsigned int val);
1390 int snd_soc_component_update_bits(struct snd_soc_component *component,
1391         unsigned int reg, unsigned int mask, unsigned int val);
1392 int snd_soc_component_update_bits_async(struct snd_soc_component *component,
1393         unsigned int reg, unsigned int mask, unsigned int val);
1394 void snd_soc_component_async_complete(struct snd_soc_component *component);
1395 int snd_soc_component_test_bits(struct snd_soc_component *component,
1396         unsigned int reg, unsigned int mask, unsigned int value);
1397
1398 #ifdef CONFIG_REGMAP
1399
1400 void snd_soc_component_init_regmap(struct snd_soc_component *component,
1401         struct regmap *regmap);
1402 void snd_soc_component_exit_regmap(struct snd_soc_component *component);
1403
1404 /**
1405  * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC
1406  * @codec: The CODEC for which to initialize the regmap instance
1407  * @regmap: The regmap instance that should be used by the CODEC
1408  *
1409  * This function allows deferred assignment of the regmap instance that is
1410  * associated with the CODEC. Only use this if the regmap instance is not yet
1411  * ready when the CODEC is registered. The function must also be called before
1412  * the first IO attempt of the CODEC.
1413  */
1414 static inline void snd_soc_codec_init_regmap(struct snd_soc_codec *codec,
1415         struct regmap *regmap)
1416 {
1417         snd_soc_component_init_regmap(&codec->component, regmap);
1418 }
1419
1420 /**
1421  * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC
1422  * @codec: The CODEC for which to de-initialize the regmap instance
1423  *
1424  * Calls regmap_exit() on the regmap instance associated to the CODEC and
1425  * removes the regmap instance from the CODEC.
1426  *
1427  * This function should only be used if snd_soc_codec_init_regmap() was used to
1428  * initialize the regmap instance.
1429  */
1430 static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec *codec)
1431 {
1432         snd_soc_component_exit_regmap(&codec->component);
1433 }
1434
1435 #endif
1436
1437 /* device driver data */
1438
1439 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1440                 void *data)
1441 {
1442         card->drvdata = data;
1443 }
1444
1445 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1446 {
1447         return card->drvdata;
1448 }
1449
1450 static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
1451                 void *data)
1452 {
1453         dev_set_drvdata(c->dev, data);
1454 }
1455
1456 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
1457 {
1458         return dev_get_drvdata(c->dev);
1459 }
1460
1461 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1462                 void *data)
1463 {
1464         snd_soc_component_set_drvdata(&codec->component, data);
1465 }
1466
1467 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1468 {
1469         return snd_soc_component_get_drvdata(&codec->component);
1470 }
1471
1472 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1473                 void *data)
1474 {
1475         snd_soc_component_set_drvdata(&platform->component, data);
1476 }
1477
1478 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1479 {
1480         return snd_soc_component_get_drvdata(&platform->component);
1481 }
1482
1483 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1484                 void *data)
1485 {
1486         dev_set_drvdata(rtd->dev, data);
1487 }
1488
1489 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1490 {
1491         return dev_get_drvdata(rtd->dev);
1492 }
1493
1494 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1495 {
1496         INIT_LIST_HEAD(&card->codec_dev_list);
1497         INIT_LIST_HEAD(&card->widgets);
1498         INIT_LIST_HEAD(&card->paths);
1499         INIT_LIST_HEAD(&card->dapm_list);
1500 }
1501
1502 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1503 {
1504         if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1505                 return 0;
1506         /*
1507          * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1508          * mc->reg != mc->rreg means that the control is
1509          * stereo (bits in one register or in two registers)
1510          */
1511         return 1;
1512 }
1513
1514 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1515         unsigned int val)
1516 {
1517         unsigned int i;
1518
1519         if (!e->values)
1520                 return val;
1521
1522         for (i = 0; i < e->items; i++)
1523                 if (val == e->values[i])
1524                         return i;
1525
1526         return 0;
1527 }
1528
1529 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1530         unsigned int item)
1531 {
1532         if (!e->values)
1533                 return item;
1534
1535         return e->values[item];
1536 }
1537
1538 static inline bool snd_soc_component_is_active(
1539         struct snd_soc_component *component)
1540 {
1541         return component->active != 0;
1542 }
1543
1544 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1545 {
1546         return snd_soc_component_is_active(&codec->component);
1547 }
1548
1549 /**
1550  * snd_soc_kcontrol_component() - Returns the component that registered the
1551  *  control
1552  * @kcontrol: The control for which to get the component
1553  *
1554  * Note: This function will work correctly if the control has been registered
1555  * for a component. Either with snd_soc_add_codec_controls() or
1556  * snd_soc_add_platform_controls() or via  table based setup for either a
1557  * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1558  */
1559 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1560         struct snd_kcontrol *kcontrol)
1561 {
1562         return snd_kcontrol_chip(kcontrol);
1563 }
1564
1565 /**
1566  * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1567  * @kcontrol: The control for which to get the CODEC
1568  *
1569  * Note: This function will only work correctly if the control has been
1570  * registered with snd_soc_add_codec_controls() or via table based setup of
1571  * snd_soc_codec_driver. Otherwise the behavior is undefined.
1572  */
1573 static inline struct snd_soc_codec *snd_soc_kcontrol_codec(
1574         struct snd_kcontrol *kcontrol)
1575 {
1576         return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol));
1577 }
1578
1579 /**
1580  * snd_soc_kcontrol_platform() - Returns the platform that registered the control
1581  * @kcontrol: The control for which to get the platform
1582  *
1583  * Note: This function will only work correctly if the control has been
1584  * registered with snd_soc_add_platform_controls() or via table based setup of
1585  * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1586  */
1587 static inline struct snd_soc_platform *snd_soc_kcontrol_platform(
1588         struct snd_kcontrol *kcontrol)
1589 {
1590         return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol));
1591 }
1592
1593 int snd_soc_util_init(void);
1594 void snd_soc_util_exit(void);
1595
1596 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1597                                const char *propname);
1598 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1599                                           const char *propname);
1600 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1601                               unsigned int *slots,
1602                               unsigned int *slot_width);
1603 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1604                                    const char *propname);
1605 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1606                                      const char *prefix,
1607                                      struct device_node **bitclkmaster,
1608                                      struct device_node **framemaster);
1609 int snd_soc_of_get_dai_name(struct device_node *of_node,
1610                             const char **dai_name);
1611 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1612                                    struct device_node *of_node,
1613                                    struct snd_soc_dai_link *dai_link);
1614
1615 #include <sound/soc-dai.h>
1616
1617 #ifdef CONFIG_DEBUG_FS
1618 extern struct dentry *snd_soc_debugfs_root;
1619 #endif
1620
1621 extern const struct dev_pm_ops snd_soc_pm_ops;
1622
1623 /* Helper functions */
1624 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1625 {
1626         mutex_lock(&dapm->card->dapm_mutex);
1627 }
1628
1629 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1630 {
1631         mutex_unlock(&dapm->card->dapm_mutex);
1632 }
1633
1634 #endif