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