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  * @list:   internal list entry
 624  */
 625 struct snd_soc_jack_pin {
 626         struct list_head list;
 627         const char *pin;
 628         int mask;
 629         bool invert;
 630 };
 631
 632 /**
 633  * struct snd_soc_jack_zone - Describes voltage zones of jack detection
 634  *
 635  * @min_mv: start voltage in mv
 636  * @max_mv: end voltage in mv
 637  * @jack_type: type of jack that is expected for this voltage
 638  * @debounce_time: debounce_time for jack, codec driver should wait for this
 639  *              duration before reading the adc for voltages
 640  * @list:   internal list entry
 641  */
 642 struct snd_soc_jack_zone {
 643         unsigned int min_mv;
 644         unsigned int max_mv;
 645         unsigned int jack_type;
 646         unsigned int debounce_time;
 647         struct list_head list;
 648 };
 649
 650 /**
 651  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 652  *
 653  * @gpio:         legacy gpio number
 654  * @idx:          gpio descriptor index within the function of the GPIO
 655  *                consumer device
 656  * @gpiod_dev:    GPIO consumer device
 657  * @name:         gpio name. Also as connection ID for the GPIO consumer
 658  *                device function name lookup
 659  * @report:       value to report when jack detected
 660  * @invert:       report presence in low state
 661  * @debounce_time: debounce time in ms
 662  * @wake:         enable as wake source
 663  * @jack_status_check: callback function which overrides the detection
 664  *                     to provide more complex checks (eg, reading an
 665  *                     ADC).
 666  */
 667 struct snd_soc_jack_gpio {
 668         unsigned int gpio;
 669         unsigned int idx;
 670         struct device *gpiod_dev;
 671         const char *name;
 672         int report;
 673         int invert;
 674         int debounce_time;
 675         bool wake;
 676
 677         /* private: */
 678         struct snd_soc_jack *jack;
 679         struct delayed_work work;
 680         struct gpio_desc *desc;
 681
 682         void *data;
 683         /* public: */
 684         int (*jack_status_check)(void *data);
 685 };
 686
 687 struct snd_soc_jack {
 688         struct mutex mutex;
 689         struct snd_jack *jack;
 690         struct snd_soc_card *card;
 691         struct list_head pins;
 692         int status;
 693         struct blocking_notifier_head notifier;
 694         struct list_head jack_zones;
 695 };
 696
 697 /* SoC PCM stream information */
 698 struct snd_soc_pcm_stream {
 699         const char *stream_name;
 700         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 701         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 702         unsigned int rate_min;          /* min rate */
 703         unsigned int rate_max;          /* max rate */
 704         unsigned int channels_min;      /* min channels */
 705         unsigned int channels_max;      /* max channels */
 706         unsigned int sig_bits;          /* number of bits of content */
 707 };
 708
 709 /* SoC audio ops */
 710 struct snd_soc_ops {
 711         int (*startup)(struct snd_pcm_substream *);
 712         void (*shutdown)(struct snd_pcm_substream *);
 713         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 714         int (*hw_free)(struct snd_pcm_substream *);
 715         int (*prepare)(struct snd_pcm_substream *);
 716         int (*trigger)(struct snd_pcm_substream *, int);
 717 };
 718
 719 struct snd_soc_compr_ops {
 720         int (*startup)(struct snd_compr_stream *);
 721         void (*shutdown)(struct snd_compr_stream *);
 722         int (*set_params)(struct snd_compr_stream *);
 723         int (*trigger)(struct snd_compr_stream *);
 724 };
 725
 726 /* component interface */
 727 struct snd_soc_component_driver {
 728         const char *name;
 729
 730         /* Default control and setup, added after probe() is run */
 731         const struct snd_kcontrol_new *controls;
 732         unsigned int num_controls;
 733         const struct snd_soc_dapm_widget *dapm_widgets;
 734         unsigned int num_dapm_widgets;
 735         const struct snd_soc_dapm_route *dapm_routes;
 736         unsigned int num_dapm_routes;
 737
 738         int (*probe)(struct snd_soc_component *);
 739         void (*remove)(struct snd_soc_component *);
 740
 741         /* DT */
 742         int (*of_xlate_dai_name)(struct snd_soc_component *component,
 743                                  struct of_phandle_args *args,
 744                                  const char **dai_name);
 745         void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type,
 746                 int subseq);
 747         int (*stream_event)(struct snd_soc_component *, int event);
 748
 749         /* probe ordering - for components with runtime dependencies */
 750         int probe_order;
 751         int remove_order;
 752 };
 753
 754 struct snd_soc_component {
 755         const char *name;
 756         int id;
 757         const char *name_prefix;
 758         struct device *dev;
 759         struct snd_soc_card *card;
 760
 761         unsigned int active;
 762
 763         unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
 764         unsigned int registered_as_component:1;
 765
 766         struct list_head list;
 767
 768         struct snd_soc_dai_driver *dai_drv;
 769         int num_dai;
 770
 771         const struct snd_soc_component_driver *driver;
 772
 773         struct list_head dai_list;
 774
 775         int (*read)(struct snd_soc_component *, unsigned int, unsigned int *);
 776         int (*write)(struct snd_soc_component *, unsigned int, unsigned int);
 777
 778         struct regmap *regmap;
 779         int val_bytes;
 780
 781         struct mutex io_mutex;
 782
 783         /* attached dynamic objects */
 784         struct list_head dobj_list;
 785
 786 #ifdef CONFIG_DEBUG_FS
 787         struct dentry *debugfs_root;
 788 #endif
 789
 790         /*
 791         * DO NOT use any of the fields below in drivers, they are temporary and
 792         * are going to be removed again soon. If you use them in driver code the
 793         * driver will be marked as BROKEN when these fields are removed.
 794         */
 795
 796         /* Don't use these, use snd_soc_component_get_dapm() */
 797         struct snd_soc_dapm_context dapm;
 798
 799         const struct snd_kcontrol_new *controls;
 800         unsigned int num_controls;
 801         const struct snd_soc_dapm_widget *dapm_widgets;
 802         unsigned int num_dapm_widgets;
 803         const struct snd_soc_dapm_route *dapm_routes;
 804         unsigned int num_dapm_routes;
 805         struct snd_soc_codec *codec;
 806
 807         int (*probe)(struct snd_soc_component *);
 808         void (*remove)(struct snd_soc_component *);
 809
 810 #ifdef CONFIG_DEBUG_FS
 811         void (*init_debugfs)(struct snd_soc_component *component);
 812         const char *debugfs_prefix;
 813 #endif
 814 };
 815
 816 /* SoC Audio Codec device */
 817 struct snd_soc_codec {
 818         struct device *dev;
 819         const struct snd_soc_codec_driver *driver;
 820
 821         struct list_head list;
 822         struct list_head card_list;
 823
 824         /* runtime */
 825         unsigned int cache_bypass:1; /* Suppress access to the cache */
 826         unsigned int suspended:1; /* Codec is in suspend PM state */
 827         unsigned int cache_init:1; /* codec cache has been initialized */
 828
 829         /* codec IO */
 830         void *control_data; /* codec control (i2c/3wire) data */
 831         hw_write_t hw_write;
 832         void *reg_cache;
 833
 834         /* component */
 835         struct snd_soc_component component;
 836
 837 #ifdef CONFIG_DEBUG_FS
 838         struct dentry *debugfs_reg;
 839 #endif
 840 };
 841
 842 /* codec driver */
 843 struct snd_soc_codec_driver {
 844
 845         /* driver ops */
 846         int (*probe)(struct snd_soc_codec *);
 847         int (*remove)(struct snd_soc_codec *);
 848         int (*suspend)(struct snd_soc_codec *);
 849         int (*resume)(struct snd_soc_codec *);
 850         struct snd_soc_component_driver component_driver;
 851
 852         /* Default control and setup, added after probe() is run */
 853         const struct snd_kcontrol_new *controls;
 854         int num_controls;
 855         const struct snd_soc_dapm_widget *dapm_widgets;
 856         int num_dapm_widgets;
 857         const struct snd_soc_dapm_route *dapm_routes;
 858         int num_dapm_routes;
 859
 860         /* codec wide operations */
 861         int (*set_sysclk)(struct snd_soc_codec *codec,
 862                           int clk_id, int source, unsigned int freq, int dir);
 863         int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
 864                 unsigned int freq_in, unsigned int freq_out);
 865
 866         /* codec IO */
 867         struct regmap *(*get_regmap)(struct device *);
 868         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 869         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 870         unsigned int reg_cache_size;
 871         short reg_cache_step;
 872         short reg_word_size;
 873         const void *reg_cache_default;
 874
 875         /* codec bias level */
 876         int (*set_bias_level)(struct snd_soc_codec *,
 877                               enum snd_soc_bias_level level);
 878         bool idle_bias_off;
 879         bool suspend_bias_off;
 880
 881         void (*seq_notifier)(struct snd_soc_dapm_context *,
 882                              enum snd_soc_dapm_type, int);
 883
 884         bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */
 885 };
 886
 887 /* SoC platform interface */
 888 struct snd_soc_platform_driver {
 889
 890         int (*probe)(struct snd_soc_platform *);
 891         int (*remove)(struct snd_soc_platform *);
 892         struct snd_soc_component_driver component_driver;
 893
 894         /* pcm creation and destruction */
 895         int (*pcm_new)(struct snd_soc_pcm_runtime *);
 896         void (*pcm_free)(struct snd_pcm *);
 897
 898         /*
 899          * For platform caused delay reporting.
 900          * Optional.
 901          */
 902         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 903                 struct snd_soc_dai *);
 904
 905         /* platform stream pcm ops */
 906         const struct snd_pcm_ops *ops;
 907
 908         /* platform stream compress ops */
 909         const struct snd_compr_ops *compr_ops;
 910
 911         int (*bespoke_trigger)(struct snd_pcm_substream *, int);
 912 };
 913
 914 struct snd_soc_dai_link_component {
 915         const char *name;
 916         struct device_node *of_node;
 917         const char *dai_name;
 918 };
 919
 920 struct snd_soc_platform {
 921         struct device *dev;
 922         const struct snd_soc_platform_driver *driver;
 923
 924         struct list_head list;
 925
 926         struct snd_soc_component component;
 927 };
 928
 929 struct snd_soc_dai_link {
 930         /* config - must be set by machine driver */
 931         const char *name;                       /* Codec name */
 932         const char *stream_name;                /* Stream name */
 933         /*
 934          * You MAY specify the link's CPU-side device, either by device name,
 935          * or by DT/OF node, but not both. If this information is omitted,
 936          * the CPU-side DAI is matched using .cpu_dai_name only, which hence
 937          * must be globally unique. These fields are currently typically used
 938          * only for codec to codec links, or systems using device tree.
 939          */
 940         const char *cpu_name;
 941         struct device_node *cpu_of_node;
 942         /*
 943          * You MAY specify the DAI name of the CPU DAI. If this information is
 944          * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
 945          * only, which only works well when that device exposes a single DAI.
 946          */
 947         const char *cpu_dai_name;
 948         /*
 949          * You MUST specify the link's codec, either by device name, or by
 950          * DT/OF node, but not both.
 951          */
 952         const char *codec_name;
 953         struct device_node *codec_of_node;
 954         /* You MUST specify the DAI name within the codec */
 955         const char *codec_dai_name;
 956
 957         struct snd_soc_dai_link_component *codecs;
 958         unsigned int num_codecs;
 959
 960         /*
 961          * You MAY specify the link's platform/PCM/DMA driver, either by
 962          * device name, or by DT/OF node, but not both. Some forms of link
 963          * do not need a platform.
 964          */
 965         const char *platform_name;
 966         struct device_node *platform_of_node;
 967         int be_id;      /* optional ID for machine driver BE identification */
 968
 969         const struct snd_soc_pcm_stream *params;
 970         unsigned int num_params;
 971
 972         unsigned int dai_fmt;           /* format to set on init */
 973
 974         enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
 975
 976         /* codec/machine specific init - e.g. add machine controls */
 977         int (*init)(struct snd_soc_pcm_runtime *rtd);
 978
 979         /* optional hw_params re-writing for BE and FE sync */
 980         int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
 981                         struct snd_pcm_hw_params *params);
 982
 983         /* machine stream operations */
 984         const struct snd_soc_ops *ops;
 985         const struct snd_soc_compr_ops *compr_ops;
 986
 987         /* For unidirectional dai links */
 988         bool playback_only;
 989         bool capture_only;
 990
 991         /* Mark this pcm with non atomic ops */
 992         bool nonatomic;
 993
 994         /* Keep DAI active over suspend */
 995         unsigned int ignore_suspend:1;
 996
 997         /* Symmetry requirements */
 998         unsigned int symmetric_rates:1;
 999         unsigned int symmetric_channels:1;
1000         unsigned int symmetric_samplebits:1;
1001
1002         /* Do not create a PCM for this DAI link (Backend link) */
1003         unsigned int no_pcm:1;
1004
1005         /* This DAI link can route to other DAI links at runtime (Frontend)*/
1006         unsigned int dynamic:1;
1007
1008         /* DPCM capture and Playback support */
1009         unsigned int dpcm_capture:1;
1010         unsigned int dpcm_playback:1;
1011
1012         /* DPCM used FE & BE merged format */
1013         unsigned int dpcm_merged_format:1;
1014
1015         /* pmdown_time is ignored at stop */
1016         unsigned int ignore_pmdown_time:1;
1017 };
1018
1019 struct snd_soc_codec_conf {
1020         /*
1021          * specify device either by device name, or by
1022          * DT/OF node, but not both.
1023          */
1024         const char *dev_name;
1025         struct device_node *of_node;
1026
1027         /*
1028          * optional map of kcontrol, widget and path name prefixes that are
1029          * associated per device
1030          */
1031         const char *name_prefix;
1032 };
1033
1034 struct snd_soc_aux_dev {
1035         const char *name;               /* Codec name */
1036
1037         /*
1038          * specify multi-codec either by device name, or by
1039          * DT/OF node, but not both.
1040          */
1041         const char *codec_name;
1042         struct device_node *codec_of_node;
1043
1044         /* codec/machine specific init - e.g. add machine controls */
1045         int (*init)(struct snd_soc_component *component);
1046 };
1047
1048 /* SoC card */
1049 struct snd_soc_card {
1050         const char *name;
1051         const char *long_name;
1052         const char *driver_name;
1053         struct device *dev;
1054         struct snd_card *snd_card;
1055         struct module *owner;
1056
1057         struct mutex mutex;
1058         struct mutex dapm_mutex;
1059
1060         bool instantiated;
1061
1062         int (*probe)(struct snd_soc_card *card);
1063         int (*late_probe)(struct snd_soc_card *card);
1064         int (*remove)(struct snd_soc_card *card);
1065
1066         /* the pre and post PM functions are used to do any PM work before and
1067          * after the codec and DAI's do any PM work. */
1068         int (*suspend_pre)(struct snd_soc_card *card);
1069         int (*suspend_post)(struct snd_soc_card *card);
1070         int (*resume_pre)(struct snd_soc_card *card);
1071         int (*resume_post)(struct snd_soc_card *card);
1072
1073         /* callbacks */
1074         int (*set_bias_level)(struct snd_soc_card *,
1075                               struct snd_soc_dapm_context *dapm,
1076                               enum snd_soc_bias_level level);
1077         int (*set_bias_level_post)(struct snd_soc_card *,
1078                                    struct snd_soc_dapm_context *dapm,
1079                                    enum snd_soc_bias_level level);
1080
1081         long pmdown_time;
1082
1083         /* CPU <--> Codec DAI links  */
1084         struct snd_soc_dai_link *dai_link;
1085         int num_links;
1086         struct snd_soc_pcm_runtime *rtd;
1087         int num_rtd;
1088
1089         /* optional codec specific configuration */
1090         struct snd_soc_codec_conf *codec_conf;
1091         int num_configs;
1092
1093         /*
1094          * optional auxiliary devices such as amplifiers or codecs with DAI
1095          * link unused
1096          */
1097         struct snd_soc_aux_dev *aux_dev;
1098         int num_aux_devs;
1099         struct snd_soc_pcm_runtime *rtd_aux;
1100         int num_aux_rtd;
1101
1102         const struct snd_kcontrol_new *controls;
1103         int num_controls;
1104
1105         /*
1106          * Card-specific routes and widgets.
1107          * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1108          */
1109         const struct snd_soc_dapm_widget *dapm_widgets;
1110         int num_dapm_widgets;
1111         const struct snd_soc_dapm_route *dapm_routes;
1112         int num_dapm_routes;
1113         const struct snd_soc_dapm_widget *of_dapm_widgets;
1114         int num_of_dapm_widgets;
1115         const struct snd_soc_dapm_route *of_dapm_routes;
1116         int num_of_dapm_routes;
1117         bool fully_routed;
1118
1119         struct work_struct deferred_resume_work;
1120
1121         /* lists of probed devices belonging to this card */
1122         struct list_head codec_dev_list;
1123
1124         struct list_head widgets;
1125         struct list_head paths;
1126         struct list_head dapm_list;
1127         struct list_head dapm_dirty;
1128
1129         /* attached dynamic objects */
1130         struct list_head dobj_list;
1131
1132         /* Generic DAPM context for the card */
1133         struct snd_soc_dapm_context dapm;
1134         struct snd_soc_dapm_stats dapm_stats;
1135         struct snd_soc_dapm_update *update;
1136
1137 #ifdef CONFIG_DEBUG_FS
1138         struct dentry *debugfs_card_root;
1139         struct dentry *debugfs_pop_time;
1140 #endif
1141         u32 pop_time;
1142
1143         void *drvdata;
1144 };
1145
1146 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1147 struct snd_soc_pcm_runtime {
1148         struct device *dev;
1149         struct snd_soc_card *card;
1150         struct snd_soc_dai_link *dai_link;
1151         struct mutex pcm_mutex;
1152         enum snd_soc_pcm_subclass pcm_subclass;
1153         struct snd_pcm_ops ops;
1154
1155         unsigned int dev_registered:1;
1156
1157         /* Dynamic PCM BE runtime data */
1158         struct snd_soc_dpcm_runtime dpcm[2];
1159         int fe_compr;
1160
1161         long pmdown_time;
1162         unsigned char pop_wait:1;
1163
1164         /* runtime devices */
1165         struct snd_pcm *pcm;
1166         struct snd_compr *compr;
1167         struct snd_soc_codec *codec;
1168         struct snd_soc_platform *platform;
1169         struct snd_soc_dai *codec_dai;
1170         struct snd_soc_dai *cpu_dai;
1171         struct snd_soc_component *component; /* Only valid for AUX dev rtds */
1172
1173         struct snd_soc_dai **codec_dais;
1174         unsigned int num_codecs;
1175
1176         struct delayed_work delayed_work;
1177 #ifdef CONFIG_DEBUG_FS
1178         struct dentry *debugfs_dpcm_root;
1179         struct dentry *debugfs_dpcm_state;
1180 #endif
1181 };
1182
1183 /* mixer control */
1184 struct soc_mixer_control {
1185         int min, max, platform_max;
1186         int reg, rreg;
1187         unsigned int shift, rshift;
1188         unsigned int sign_bit;
1189         unsigned int invert:1;
1190         unsigned int autodisable:1;
1191         struct snd_soc_dobj dobj;
1192 };
1193
1194 struct soc_bytes {
1195         int base;
1196         int num_regs;
1197         u32 mask;
1198 };
1199
1200 struct soc_bytes_ext {
1201         int max;
1202         struct snd_soc_dobj dobj;
1203
1204         /* used for TLV byte control */
1205         int (*get)(unsigned int __user *bytes, unsigned int size);
1206         int (*put)(const unsigned int __user *bytes, unsigned int size);
1207 };
1208
1209 /* multi register control */
1210 struct soc_mreg_control {
1211         long min, max;
1212         unsigned int regbase, regcount, nbits, invert;
1213 };
1214
1215 /* enumerated kcontrol */
1216 struct soc_enum {
1217         int reg;
1218         unsigned char shift_l;
1219         unsigned char shift_r;
1220         unsigned int items;
1221         unsigned int mask;
1222         const char * const *texts;
1223         const unsigned int *values;
1224         unsigned int autodisable:1;
1225         struct snd_soc_dobj dobj;
1226 };
1227
1228 /**
1229  * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1230  * @component: The component to cast to a CODEC
1231  *
1232  * This function must only be used on components that are known to be CODECs.
1233  * Otherwise the behavior is undefined.
1234  */
1235 static inline struct snd_soc_codec *snd_soc_component_to_codec(
1236         struct snd_soc_component *component)
1237 {
1238         return container_of(component, struct snd_soc_codec, component);
1239 }
1240
1241 /**
1242  * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1243  * @component: The component to cast to a platform
1244  *
1245  * This function must only be used on components that are known to be platforms.
1246  * Otherwise the behavior is undefined.
1247  */
1248 static inline struct snd_soc_platform *snd_soc_component_to_platform(
1249         struct snd_soc_component *component)
1250 {
1251         return container_of(component, struct snd_soc_platform, component);
1252 }
1253
1254 /**
1255  * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
1256  *  embedded in
1257  * @dapm: The DAPM context to cast to the component
1258  *
1259  * This function must only be used on DAPM contexts that are known to be part of
1260  * a component (e.g. in a component driver). Otherwise the behavior is
1261  * undefined.
1262  */
1263 static inline struct snd_soc_component *snd_soc_dapm_to_component(
1264         struct snd_soc_dapm_context *dapm)
1265 {
1266         return container_of(dapm, struct snd_soc_component, dapm);
1267 }
1268
1269 /**
1270  * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in
1271  * @dapm: The DAPM context to cast to the CODEC
1272  *
1273  * This function must only be used on DAPM contexts that are known to be part of
1274  * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1275  */
1276 static inline struct snd_soc_codec *snd_soc_dapm_to_codec(
1277         struct snd_soc_dapm_context *dapm)
1278 {
1279         return snd_soc_component_to_codec(snd_soc_dapm_to_component(dapm));
1280 }
1281
1282 /**
1283  * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is
1284  *  embedded in
1285  * @dapm: The DAPM context to cast to the platform.
1286  *
1287  * This function must only be used on DAPM contexts that are known to be part of
1288  * a platform (e.g. in a platform driver). Otherwise the behavior is undefined.
1289  */
1290 static inline struct snd_soc_platform *snd_soc_dapm_to_platform(
1291         struct snd_soc_dapm_context *dapm)
1292 {
1293         return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm));
1294 }
1295
1296 /**
1297  * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
1298  *  component
1299  * @component: The component for which to get the DAPM context
1300  */
1301 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
1302         struct snd_soc_component *component)
1303 {
1304         return &component->dapm;
1305 }
1306
1307 /**
1308  * snd_soc_codec_get_dapm() - Returns the DAPM context for the CODEC
1309  * @codec: The CODEC for which to get the DAPM context
1310  *
1311  * Note: Use this function instead of directly accessing the CODEC's dapm field
1312  */
1313 static inline struct snd_soc_dapm_context *snd_soc_codec_get_dapm(
1314         struct snd_soc_codec *codec)
1315 {
1316         return snd_soc_component_get_dapm(&codec->component);
1317 }
1318
1319 /**
1320  * snd_soc_dapm_init_bias_level() - Initialize CODEC DAPM bias level
1321  * @codec: The CODEC for which to initialize the DAPM bias level
1322  * @level: The DAPM level to initialize to
1323  *
1324  * Initializes the CODEC DAPM bias level. See snd_soc_dapm_init_bias_level().
1325  */
1326 static inline void snd_soc_codec_init_bias_level(struct snd_soc_codec *codec,
1327         enum snd_soc_bias_level level)
1328 {
1329         snd_soc_dapm_init_bias_level(snd_soc_codec_get_dapm(codec), level);
1330 }
1331
1332 /**
1333  * snd_soc_dapm_get_bias_level() - Get current CODEC DAPM bias level
1334  * @codec: The CODEC for which to get the DAPM bias level
1335  *
1336  * Returns: The current DAPM bias level of the CODEC.
1337  */
1338 static inline enum snd_soc_bias_level snd_soc_codec_get_bias_level(
1339         struct snd_soc_codec *codec)
1340 {
1341         return snd_soc_dapm_get_bias_level(snd_soc_codec_get_dapm(codec));
1342 }
1343
1344 /**
1345  * snd_soc_codec_force_bias_level() - Set the CODEC DAPM bias level
1346  * @codec: The CODEC for which to set the level
1347  * @level: The level to set to
1348  *
1349  * Forces the CODEC bias level to a specific state. See
1350  * snd_soc_dapm_force_bias_level().
1351  */
1352 static inline int snd_soc_codec_force_bias_level(struct snd_soc_codec *codec,
1353         enum snd_soc_bias_level level)
1354 {
1355         return snd_soc_dapm_force_bias_level(snd_soc_codec_get_dapm(codec),
1356                 level);
1357 }
1358
1359 /**
1360  * snd_soc_dapm_kcontrol_codec() - Returns the codec associated to a kcontrol
1361  * @kcontrol: The kcontrol
1362  *
1363  * This function must only be used on DAPM contexts that are known to be part of
1364  * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1365  */
1366 static inline struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(
1367         struct snd_kcontrol *kcontrol)
1368 {
1369         return snd_soc_dapm_to_codec(snd_soc_dapm_kcontrol_dapm(kcontrol));
1370 }
1371
1372 /* codec IO */
1373 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1374 int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg,
1375         unsigned int val);
1376
1377 /**
1378  * snd_soc_cache_sync() - Sync the register cache with the hardware
1379  * @codec: CODEC to sync
1380  *
1381  * Note: This function will call regcache_sync()
1382  */
1383 static inline int snd_soc_cache_sync(struct snd_soc_codec *codec)
1384 {
1385         return regcache_sync(codec->component.regmap);
1386 }
1387
1388 /* component IO */
1389 int snd_soc_component_read(struct snd_soc_component *component,
1390         unsigned int reg, unsigned int *val);
1391 int snd_soc_component_write(struct snd_soc_component *component,
1392         unsigned int reg, unsigned int val);
1393 int snd_soc_component_update_bits(struct snd_soc_component *component,
1394         unsigned int reg, unsigned int mask, unsigned int val);
1395 int snd_soc_component_update_bits_async(struct snd_soc_component *component,
1396         unsigned int reg, unsigned int mask, unsigned int val);
1397 void snd_soc_component_async_complete(struct snd_soc_component *component);
1398 int snd_soc_component_test_bits(struct snd_soc_component *component,
1399         unsigned int reg, unsigned int mask, unsigned int value);
1400
1401 #ifdef CONFIG_REGMAP
1402
1403 void snd_soc_component_init_regmap(struct snd_soc_component *component,
1404         struct regmap *regmap);
1405 void snd_soc_component_exit_regmap(struct snd_soc_component *component);
1406
1407 /**
1408  * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC
1409  * @codec: The CODEC for which to initialize the regmap instance
1410  * @regmap: The regmap instance that should be used by the CODEC
1411  *
1412  * This function allows deferred assignment of the regmap instance that is
1413  * associated with the CODEC. Only use this if the regmap instance is not yet
1414  * ready when the CODEC is registered. The function must also be called before
1415  * the first IO attempt of the CODEC.
1416  */
1417 static inline void snd_soc_codec_init_regmap(struct snd_soc_codec *codec,
1418         struct regmap *regmap)
1419 {
1420         snd_soc_component_init_regmap(&codec->component, regmap);
1421 }
1422
1423 /**
1424  * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC
1425  * @codec: The CODEC for which to de-initialize the regmap instance
1426  *
1427  * Calls regmap_exit() on the regmap instance associated to the CODEC and
1428  * removes the regmap instance from the CODEC.
1429  *
1430  * This function should only be used if snd_soc_codec_init_regmap() was used to
1431  * initialize the regmap instance.
1432  */
1433 static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec *codec)
1434 {
1435         snd_soc_component_exit_regmap(&codec->component);
1436 }
1437
1438 #endif
1439
1440 /* device driver data */
1441
1442 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1443                 void *data)
1444 {
1445         card->drvdata = data;
1446 }
1447
1448 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1449 {
1450         return card->drvdata;
1451 }
1452
1453 static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
1454                 void *data)
1455 {
1456         dev_set_drvdata(c->dev, data);
1457 }
1458
1459 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
1460 {
1461         return dev_get_drvdata(c->dev);
1462 }
1463
1464 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1465                 void *data)
1466 {
1467         snd_soc_component_set_drvdata(&codec->component, data);
1468 }
1469
1470 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1471 {
1472         return snd_soc_component_get_drvdata(&codec->component);
1473 }
1474
1475 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1476                 void *data)
1477 {
1478         snd_soc_component_set_drvdata(&platform->component, data);
1479 }
1480
1481 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1482 {
1483         return snd_soc_component_get_drvdata(&platform->component);
1484 }
1485
1486 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1487                 void *data)
1488 {
1489         dev_set_drvdata(rtd->dev, data);
1490 }
1491
1492 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1493 {
1494         return dev_get_drvdata(rtd->dev);
1495 }
1496
1497 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1498 {
1499         INIT_LIST_HEAD(&card->codec_dev_list);
1500         INIT_LIST_HEAD(&card->widgets);
1501         INIT_LIST_HEAD(&card->paths);
1502         INIT_LIST_HEAD(&card->dapm_list);
1503 }
1504
1505 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1506 {
1507         if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1508                 return 0;
1509         /*
1510          * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1511          * mc->reg != mc->rreg means that the control is
1512          * stereo (bits in one register or in two registers)
1513          */
1514         return 1;
1515 }
1516
1517 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1518         unsigned int val)
1519 {
1520         unsigned int i;
1521
1522         if (!e->values)
1523                 return val;
1524
1525         for (i = 0; i < e->items; i++)
1526                 if (val == e->values[i])
1527                         return i;
1528
1529         return 0;
1530 }
1531
1532 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1533         unsigned int item)
1534 {
1535         if (!e->values)
1536                 return item;
1537
1538         return e->values[item];
1539 }
1540
1541 static inline bool snd_soc_component_is_active(
1542         struct snd_soc_component *component)
1543 {
1544         return component->active != 0;
1545 }
1546
1547 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1548 {
1549         return snd_soc_component_is_active(&codec->component);
1550 }
1551
1552 /**
1553  * snd_soc_kcontrol_component() - Returns the component that registered the
1554  *  control
1555  * @kcontrol: The control for which to get the component
1556  *
1557  * Note: This function will work correctly if the control has been registered
1558  * for a component. Either with snd_soc_add_codec_controls() or
1559  * snd_soc_add_platform_controls() or via  table based setup for either a
1560  * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1561  */
1562 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1563         struct snd_kcontrol *kcontrol)
1564 {
1565         return snd_kcontrol_chip(kcontrol);
1566 }
1567
1568 /**
1569  * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1570  * @kcontrol: The control for which to get the CODEC
1571  *
1572  * Note: This function will only work correctly if the control has been
1573  * registered with snd_soc_add_codec_controls() or via table based setup of
1574  * snd_soc_codec_driver. Otherwise the behavior is undefined.
1575  */
1576 static inline struct snd_soc_codec *snd_soc_kcontrol_codec(
1577         struct snd_kcontrol *kcontrol)
1578 {
1579         return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol));
1580 }
1581
1582 /**
1583  * snd_soc_kcontrol_platform() - Returns the platform that registered the control
1584  * @kcontrol: The control for which to get the platform
1585  *
1586  * Note: This function will only work correctly if the control has been
1587  * registered with snd_soc_add_platform_controls() or via table based setup of
1588  * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1589  */
1590 static inline struct snd_soc_platform *snd_soc_kcontrol_platform(
1591         struct snd_kcontrol *kcontrol)
1592 {
1593         return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol));
1594 }
1595
1596 int snd_soc_util_init(void);
1597 void snd_soc_util_exit(void);
1598
1599 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1600                                const char *propname);
1601 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1602                                           const char *propname);
1603 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1604                               unsigned int *slots,
1605                               unsigned int *slot_width);
1606 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1607                                    struct snd_soc_codec_conf *codec_conf,
1608                                    struct device_node *of_node,
1609                                    const char *propname);
1610 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1611                                    const char *propname);
1612 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1613                                      const char *prefix,
1614                                      struct device_node **bitclkmaster,
1615                                      struct device_node **framemaster);
1616 int snd_soc_of_get_dai_name(struct device_node *of_node,
1617                             const char **dai_name);
1618 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1619                                    struct device_node *of_node,
1620                                    struct snd_soc_dai_link *dai_link);
1621
1622 #include <sound/soc-dai.h>
1623
1624 #ifdef CONFIG_DEBUG_FS
1625 extern struct dentry *snd_soc_debugfs_root;
1626 #endif
1627
1628 extern const struct dev_pm_ops snd_soc_pm_ops;
1629
1630 /* Helper functions */
1631 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1632 {
1633         mutex_lock(&dapm->card->dapm_mutex);
1634 }
1635
1636 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1637 {
1638         mutex_unlock(&dapm->card->dapm_mutex);
1639 }
1640
1641 #endif