include/sound/soc.h

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