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