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