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