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