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/args.h>
  14 #include <linux/array_size.h>
  15 #include <linux/device.h>
  16 #include <linux/errno.h>
  17 #include <linux/interrupt.h>
  18 #include <linux/lockdep.h>
  19 #include <linux/log2.h>
  20 #include <linux/mutex.h>
  21 #include <linux/notifier.h>
  22 #include <linux/of.h>
  23 #include <linux/types.h>
  24 #include <linux/workqueue.h>
  25
  26 #include <sound/ac97_codec.h>
  27 #include <sound/compress_driver.h>
  28 #include <sound/control.h>
  29 #include <sound/core.h>
  30 #include <sound/pcm.h>
  31
  32 struct module;
  33 struct platform_device;
  34
  35 /* For the current users of sound/soc.h to avoid build issues */
  36 #include <linux/platform_device.h>
  37 #include <linux/regmap.h>
  38
  39 /*
  40  * Convenience kcontrol builders
  41  */
  42 #define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert, xautodisable) \
  43         ((unsigned long)&(struct soc_mixer_control) \
  44         {.reg = xreg, .rreg = xreg, .shift = shift_left, \
  45         .rshift = shift_right, .max = xmax, \
  46         .invert = xinvert, .autodisable = xautodisable})
  47 #define SOC_DOUBLE_S_VALUE(xreg, shift_left, shift_right, xmin, xmax, xsign_bit, xinvert, xautodisable) \
  48         ((unsigned long)&(struct soc_mixer_control) \
  49         {.reg = xreg, .rreg = xreg, .shift = shift_left, \
  50         .rshift = shift_right, .min = xmin, .max = xmax, \
  51         .sign_bit = xsign_bit, .invert = xinvert, .autodisable = xautodisable})
  52 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \
  53         SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable)
  54 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
  55         ((unsigned long)&(struct soc_mixer_control) \
  56         {.reg = xreg, .max = xmax, .invert = xinvert})
  57 #define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
  58         ((unsigned long)&(struct soc_mixer_control) \
  59         {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  60         .max = xmax, .invert = xinvert})
  61 #define SOC_DOUBLE_R_S_VALUE(xlreg, xrreg, xshift, xmin, xmax, xsign_bit, xinvert) \
  62         ((unsigned long)&(struct soc_mixer_control) \
  63         {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  64         .max = xmax, .min = xmin, .sign_bit = xsign_bit, \
  65         .invert = xinvert})
  66 #define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
  67         ((unsigned long)&(struct soc_mixer_control) \
  68         {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  69         .min = xmin, .max = xmax, .invert = xinvert})
  70 #define SOC_SINGLE(xname, reg, shift, max, invert) \
  71 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  72         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  73         .put = snd_soc_put_volsw, \
  74         .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
  75 #define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
  76 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  77         .info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
  78         .put = snd_soc_put_volsw_range, \
  79         .private_value = (unsigned long)&(struct soc_mixer_control) \
  80                 {.reg = xreg, .rreg = xreg, .shift = xshift, \
  81                  .rshift = xshift,  .min = xmin, .max = xmax, \
  82                  .invert = xinvert} }
  83 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, 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, .get = snd_soc_get_volsw,\
  89         .put = snd_soc_put_volsw, \
  90         .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
  91 #define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
  92 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  93         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
  94         SNDRV_CTL_ELEM_ACCESS_READWRITE, \
  95         .tlv.p  = (tlv_array),\
  96         .info = snd_soc_info_volsw_sx, \
  97         .get = snd_soc_get_volsw_sx,\
  98         .put = snd_soc_put_volsw_sx, \
  99         .private_value = (unsigned long)&(struct soc_mixer_control) \
 100                 {.reg = xreg, .rreg = xreg, \
 101                 .shift = xshift, .rshift = xshift, \
 102                 .max = xmax, .min = xmin} }
 103 #define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
 104 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 105         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 106                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 107         .tlv.p = (tlv_array), \
 108         .info = snd_soc_info_volsw_range, \
 109         .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
 110         .private_value = (unsigned long)&(struct soc_mixer_control) \
 111                 {.reg = xreg, .rreg = xreg, .shift = xshift, \
 112                  .rshift = xshift, .min = xmin, .max = xmax, \
 113                  .invert = xinvert} }
 114 #define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
 115 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 116         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
 117         .put = snd_soc_put_volsw, \
 118         .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
 119                                           max, invert, 0) }
 120 #define SOC_DOUBLE_STS(xname, reg, shift_left, shift_right, max, invert) \
 121 {                                                                       \
 122         .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),           \
 123         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,           \
 124         .access = SNDRV_CTL_ELEM_ACCESS_READ |                          \
 125                 SNDRV_CTL_ELEM_ACCESS_VOLATILE,                         \
 126         .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
 127                                           max, invert, 0) }
 128 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
 129 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 130         .info = snd_soc_info_volsw, \
 131         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 132         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 133                                             xmax, xinvert) }
 134 #define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
 135                            xmax, xinvert)               \
 136 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 137         .info = snd_soc_info_volsw_range, \
 138         .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
 139         .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
 140                                             xshift, xmin, xmax, xinvert) }
 141 #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
 142 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 143         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 144                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 145         .tlv.p = (tlv_array), \
 146         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
 147         .put = snd_soc_put_volsw, \
 148         .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
 149                                           max, invert, 0) }
 150 #define SOC_DOUBLE_SX_TLV(xname, xreg, shift_left, shift_right, xmin, xmax, tlv_array) \
 151 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 152         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 153         SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 154         .tlv.p  = (tlv_array), \
 155         .info = snd_soc_info_volsw_sx, \
 156         .get = snd_soc_get_volsw_sx, \
 157         .put = snd_soc_put_volsw_sx, \
 158         .private_value = (unsigned long)&(struct soc_mixer_control) \
 159                 {.reg = xreg, .rreg = xreg, \
 160                 .shift = shift_left, .rshift = shift_right, \
 161                 .max = xmax, .min = xmin} }
 162 #define SOC_DOUBLE_RANGE_TLV(xname, xreg, xshift_left, xshift_right, xmin, xmax, \
 163                              xinvert, tlv_array) \
 164 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 165         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 166                   SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 167         .tlv.p = (tlv_array), \
 168         .info = snd_soc_info_volsw, \
 169         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 170         .private_value = (unsigned long)&(struct soc_mixer_control) \
 171                 {.reg = xreg, .rreg = xreg, \
 172                  .shift = xshift_left, .rshift = xshift_right, \
 173                  .min = xmin, .max = xmax, .invert = xinvert} }
 174 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
 175 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 176         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 177                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 178         .tlv.p = (tlv_array), \
 179         .info = snd_soc_info_volsw, \
 180         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 181         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 182                                             xmax, xinvert) }
 183 #define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
 184                                xmax, xinvert, tlv_array)                \
 185 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 186         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 187                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 188         .tlv.p = (tlv_array), \
 189         .info = snd_soc_info_volsw_range, \
 190         .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
 191         .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
 192                                             xshift, xmin, xmax, xinvert) }
 193 #define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, 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_sx, \
 199         .get = snd_soc_get_volsw_sx, \
 200         .put = snd_soc_put_volsw_sx, \
 201         .private_value = (unsigned long)&(struct soc_mixer_control) \
 202                 {.reg = xreg, .rreg = xrreg, \
 203                 .shift = xshift, .rshift = xshift, \
 204                 .max = xmax, .min = xmin} }
 205 #define SOC_DOUBLE_R_S_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
 206 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 207         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 208                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 209         .tlv.p = (tlv_array), \
 210         .info = snd_soc_info_volsw, \
 211         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 212         .private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
 213                                             xmin, xmax, xsign_bit, xinvert) }
 214 #define SOC_SINGLE_S_TLV(xname, xreg, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
 215         SOC_DOUBLE_R_S_TLV(xname, xreg, xreg, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array)
 216 #define SOC_SINGLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
 217 {       .iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 218         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 219                   SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 220         .tlv.p  = (tlv_array), \
 221         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
 222         .put = snd_soc_put_volsw, \
 223         .private_value = (unsigned long)&(struct soc_mixer_control) \
 224         {.reg = xreg, .rreg = xreg,  \
 225          .min = xmin, .max = xmax, \
 226         .sign_bit = 7,} }
 227 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
 228 {       .iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 229         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 230                   SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 231         .tlv.p  = (tlv_array), \
 232         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
 233         .put = snd_soc_put_volsw, \
 234         .private_value = SOC_DOUBLE_S_VALUE(xreg, 0, 8, xmin, xmax, 7, 0, 0) }
 235 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \
 236 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 237         .items = xitems, .texts = xtexts, \
 238         .mask = xitems ? roundup_pow_of_two(xitems) - 1 : 0}
 239 #define SOC_ENUM_SINGLE(xreg, xshift, xitems, xtexts) \
 240         SOC_ENUM_DOUBLE(xreg, xshift, xshift, xitems, xtexts)
 241 #define SOC_ENUM_SINGLE_EXT(xitems, xtexts) \
 242 {       .items = xitems, .texts = xtexts }
 243 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xitems, xtexts, xvalues) \
 244 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 245         .mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues}
 246 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
 247         SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xitems, xtexts, xvalues)
 248 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
 249 {       .reg = xreg, .shift_l = xshift, .shift_r = xshift, \
 250         .mask = xmask, .items = xitems, .texts = xtexts, \
 251         .values = xvalues, .autodisable = 1}
 252 #define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \
 253         SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
 254 #define SOC_ENUM(xname, xenum) \
 255 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
 256         .info = snd_soc_info_enum_double, \
 257         .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
 258         .private_value = (unsigned long)&xenum }
 259 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
 260          xhandler_get, xhandler_put) \
 261 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 262         .info = snd_soc_info_volsw, \
 263         .get = xhandler_get, .put = xhandler_put, \
 264         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
 265 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
 266          xhandler_get, xhandler_put) \
 267 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 268         .info = snd_soc_info_volsw, \
 269         .get = xhandler_get, .put = xhandler_put, \
 270         .private_value = \
 271                 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
 272 #define SOC_DOUBLE_R_EXT(xname, reg_left, reg_right, xshift, xmax, xinvert,\
 273          xhandler_get, xhandler_put) \
 274 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 275         .info = snd_soc_info_volsw, \
 276         .get = xhandler_get, .put = xhandler_put, \
 277         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 278                                             xmax, xinvert) }
 279 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
 280          xhandler_get, xhandler_put, tlv_array) \
 281 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 282         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 283                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 284         .tlv.p = (tlv_array), \
 285         .info = snd_soc_info_volsw, \
 286         .get = xhandler_get, .put = xhandler_put, \
 287         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
 288 #define SOC_SINGLE_RANGE_EXT_TLV(xname, xreg, xshift, xmin, xmax, xinvert, \
 289                                  xhandler_get, xhandler_put, tlv_array) \
 290 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 291         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 292                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 293         .tlv.p = (tlv_array), \
 294         .info = snd_soc_info_volsw_range, \
 295         .get = xhandler_get, .put = xhandler_put, \
 296         .private_value = (unsigned long)&(struct soc_mixer_control) \
 297                 {.reg = xreg, .rreg = xreg, .shift = xshift, \
 298                  .rshift = xshift, .min = xmin, .max = xmax, \
 299                  .invert = xinvert} }
 300 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
 301          xhandler_get, xhandler_put, tlv_array) \
 302 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 303         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 304                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 305         .tlv.p = (tlv_array), \
 306         .info = snd_soc_info_volsw, \
 307         .get = xhandler_get, .put = xhandler_put, \
 308         .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
 309                                           xmax, xinvert, 0) }
 310 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
 311          xhandler_get, xhandler_put, tlv_array) \
 312 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 313         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 314                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 315         .tlv.p = (tlv_array), \
 316         .info = snd_soc_info_volsw, \
 317         .get = xhandler_get, .put = xhandler_put, \
 318         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 319                                             xmax, xinvert) }
 320 #define SOC_DOUBLE_R_S_EXT_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, \
 321                                xsign_bit, xinvert, xhandler_get, xhandler_put, \
 322                                tlv_array) \
 323 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 324         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 325                   SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 326         .tlv.p = (tlv_array), \
 327         .info = snd_soc_info_volsw, \
 328         .get = xhandler_get, .put = xhandler_put, \
 329         .private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
 330                                               xmin, xmax, xsign_bit, xinvert) }
 331 #define SOC_SINGLE_S_EXT_TLV(xname, xreg, xshift, xmin, xmax, \
 332                              xsign_bit, xinvert, xhandler_get, xhandler_put, \
 333                              tlv_array) \
 334         SOC_DOUBLE_R_S_EXT_TLV(xname, xreg, xreg, xshift, xmin, xmax, \
 335                                xsign_bit, xinvert, xhandler_get, xhandler_put, \
 336                                tlv_array)
 337 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
 338 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 339         .info = snd_soc_info_bool_ext, \
 340         .get = xhandler_get, .put = xhandler_put, \
 341         .private_value = xdata }
 342 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 343 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 344         .info = snd_soc_info_enum_double, \
 345         .get = xhandler_get, .put = xhandler_put, \
 346         .private_value = (unsigned long)&xenum }
 347 #define SOC_VALUE_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 348         SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put)
 349
 350 #define SND_SOC_BYTES(xname, xbase, xregs)                    \
 351 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
 352         .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
 353         .put = snd_soc_bytes_put, .private_value =            \
 354                 ((unsigned long)&(struct soc_bytes)           \
 355                 {.base = xbase, .num_regs = xregs }) }
 356 #define SND_SOC_BYTES_E(xname, xbase, xregs, xhandler_get, xhandler_put) \
 357 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 358         .info = snd_soc_bytes_info, .get = xhandler_get, \
 359         .put = xhandler_put, .private_value = \
 360                 ((unsigned long)&(struct soc_bytes) \
 361                 {.base = xbase, .num_regs = xregs }) }
 362
 363 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask)        \
 364 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
 365         .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
 366         .put = snd_soc_bytes_put, .private_value =            \
 367                 ((unsigned long)&(struct soc_bytes)           \
 368                 {.base = xbase, .num_regs = xregs,            \
 369                  .mask = xmask }) }
 370
 371 /*
 372  * SND_SOC_BYTES_EXT is deprecated, please USE SND_SOC_BYTES_TLV instead
 373  */
 374 #define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \
 375 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 376         .info = snd_soc_bytes_info_ext, \
 377         .get = xhandler_get, .put = xhandler_put, \
 378         .private_value = (unsigned long)&(struct soc_bytes_ext) \
 379                 {.max = xcount} }
 380 #define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \
 381 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 382         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \
 383                   SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
 384         .tlv.c = (snd_soc_bytes_tlv_callback), \
 385         .info = snd_soc_bytes_info_ext, \
 386         .private_value = (unsigned long)&(struct soc_bytes_ext) \
 387                 {.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
 388 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
 389                 xmin, xmax, xinvert) \
 390 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 391         .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
 392         .put = snd_soc_put_xr_sx, \
 393         .private_value = (unsigned long)&(struct soc_mreg_control) \
 394                 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
 395                 .invert = xinvert, .min = xmin, .max = xmax} }
 396
 397 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
 398         SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
 399                 snd_soc_get_strobe, snd_soc_put_strobe)
 400
 401 /*
 402  * Simplified versions of above macros, declaring a struct and calculating
 403  * ARRAY_SIZE internally
 404  */
 405 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
 406         const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
 407                                                 ARRAY_SIZE(xtexts), xtexts)
 408 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
 409         SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
 410 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
 411         const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
 412 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
 413         const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
 414                                                         ARRAY_SIZE(xtexts), xtexts, xvalues)
 415 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
 416         SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
 417
 418 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
 419         const struct soc_enum name = SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, \
 420                 xshift, xmask, ARRAY_SIZE(xtexts), xtexts, xvalues)
 421
 422 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
 423         const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
 424
 425 struct snd_jack;
 426 struct snd_soc_card;
 427 struct snd_soc_pcm_stream;
 428 struct snd_soc_ops;
 429 struct snd_soc_pcm_runtime;
 430 struct snd_soc_dai;
 431 struct snd_soc_dai_driver;
 432 struct snd_soc_dai_link;
 433 struct snd_soc_component;
 434 struct snd_soc_component_driver;
 435 struct soc_enum;
 436 struct snd_soc_jack;
 437 struct snd_soc_jack_zone;
 438 struct snd_soc_jack_pin;
 439
 440 #include <sound/soc-dapm.h>
 441 #include <sound/soc-dpcm.h>
 442 #include <sound/soc-topology.h>
 443
 444 struct snd_soc_jack_gpio;
 445
 446 enum snd_soc_pcm_subclass {
 447         SND_SOC_PCM_CLASS_PCM   = 0,
 448         SND_SOC_PCM_CLASS_BE    = 1,
 449 };
 450
 451 int snd_soc_register_card(struct snd_soc_card *card);
 452 void snd_soc_unregister_card(struct snd_soc_card *card);
 453 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
 454 #ifdef CONFIG_PM_SLEEP
 455 int snd_soc_suspend(struct device *dev);
 456 int snd_soc_resume(struct device *dev);
 457 #else
 458 static inline int snd_soc_suspend(struct device *dev)
 459 {
 460         return 0;
 461 }
 462
 463 static inline int snd_soc_resume(struct device *dev)
 464 {
 465         return 0;
 466 }
 467 #endif
 468 int snd_soc_poweroff(struct device *dev);
 469 int snd_soc_component_initialize(struct snd_soc_component *component,
 470                                  const struct snd_soc_component_driver *driver,
 471                                  struct device *dev);
 472 int snd_soc_add_component(struct snd_soc_component *component,
 473                           struct snd_soc_dai_driver *dai_drv,
 474                           int num_dai);
 475 int snd_soc_register_component(struct device *dev,
 476                          const struct snd_soc_component_driver *component_driver,
 477                          struct snd_soc_dai_driver *dai_drv, int num_dai);
 478 int devm_snd_soc_register_component(struct device *dev,
 479                          const struct snd_soc_component_driver *component_driver,
 480                          struct snd_soc_dai_driver *dai_drv, int num_dai);
 481 void snd_soc_unregister_component(struct device *dev);
 482 void snd_soc_unregister_component_by_driver(struct device *dev,
 483                          const struct snd_soc_component_driver *component_driver);
 484 struct snd_soc_component *snd_soc_lookup_component_nolocked(struct device *dev,
 485                                                             const char *driver_name);
 486 struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
 487                                                    const char *driver_name);
 488
 489 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
 490 #ifdef CONFIG_SND_SOC_COMPRESS
 491 int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
 492 #else
 493 static inline int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num)
 494 {
 495         return 0;
 496 }
 497 #endif
 498
 499 void snd_soc_disconnect_sync(struct device *dev);
 500
 501 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
 502                                 struct snd_soc_dai_link *dai_link);
 503
 504 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
 505
 506 void snd_soc_runtime_action(struct snd_soc_pcm_runtime *rtd,
 507                             int stream, int action);
 508 static inline void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd,
 509                                      int stream)
 510 {
 511         snd_soc_runtime_action(rtd, stream, 1);
 512 }
 513 static inline void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd,
 514                                        int stream)
 515 {
 516         snd_soc_runtime_action(rtd, stream, -1);
 517 }
 518
 519 int snd_soc_runtime_calc_hw(struct snd_soc_pcm_runtime *rtd,
 520                             struct snd_pcm_hardware *hw, int stream);
 521
 522 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
 523         unsigned int dai_fmt);
 524
 525 #ifdef CONFIG_DMI
 526 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour);
 527 #else
 528 static inline int snd_soc_set_dmi_name(struct snd_soc_card *card,
 529                                        const char *flavour)
 530 {
 531         return 0;
 532 }
 533 #endif
 534
 535 /* Utility functions to get clock rates from various things */
 536 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 537 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 538 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 539 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 540 int snd_soc_tdm_params_to_bclk(struct snd_pcm_hw_params *params,
 541                                int tdm_width, int tdm_slots, int slot_multiple);
 542
 543 /* set runtime hw params */
 544 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 545         const struct snd_pcm_hardware *hw);
 546
 547 struct snd_ac97 *snd_soc_alloc_ac97_component(struct snd_soc_component *component);
 548 struct snd_ac97 *snd_soc_new_ac97_component(struct snd_soc_component *component,
 549         unsigned int id, unsigned int id_mask);
 550 void snd_soc_free_ac97_component(struct snd_ac97 *ac97);
 551
 552 #ifdef CONFIG_SND_SOC_AC97_BUS
 553 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
 554 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 555                 struct platform_device *pdev);
 556
 557 extern struct snd_ac97_bus_ops *soc_ac97_ops;
 558 #else
 559 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 560         struct platform_device *pdev)
 561 {
 562         return 0;
 563 }
 564
 565 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
 566 {
 567         return 0;
 568 }
 569 #endif
 570
 571 /*
 572  *Controls
 573  */
 574 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 575                                   void *data, const char *long_name,
 576                                   const char *prefix);
 577 int snd_soc_add_component_controls(struct snd_soc_component *component,
 578         const struct snd_kcontrol_new *controls, unsigned int num_controls);
 579 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
 580         const struct snd_kcontrol_new *controls, int num_controls);
 581 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
 582         const struct snd_kcontrol_new *controls, int num_controls);
 583 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 584         struct snd_ctl_elem_info *uinfo);
 585 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 586         struct snd_ctl_elem_value *ucontrol);
 587 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 588         struct snd_ctl_elem_value *ucontrol);
 589 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 590         struct snd_ctl_elem_info *uinfo);
 591 int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol,
 592                           struct snd_ctl_elem_info *uinfo);
 593 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 594 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 595         struct snd_ctl_elem_value *ucontrol);
 596 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 597         struct snd_ctl_elem_value *ucontrol);
 598 #define snd_soc_get_volsw_2r snd_soc_get_volsw
 599 #define snd_soc_put_volsw_2r snd_soc_put_volsw
 600 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
 601         struct snd_ctl_elem_value *ucontrol);
 602 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
 603         struct snd_ctl_elem_value *ucontrol);
 604 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
 605         struct snd_ctl_elem_info *uinfo);
 606 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
 607         struct snd_ctl_elem_value *ucontrol);
 608 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
 609         struct snd_ctl_elem_value *ucontrol);
 610 int snd_soc_limit_volume(struct snd_soc_card *card,
 611         const char *name, int max);
 612 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
 613                        struct snd_ctl_elem_info *uinfo);
 614 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
 615                       struct snd_ctl_elem_value *ucontrol);
 616 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
 617                       struct snd_ctl_elem_value *ucontrol);
 618 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
 619         struct snd_ctl_elem_info *ucontrol);
 620 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
 621         unsigned int size, unsigned int __user *tlv);
 622 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
 623         struct snd_ctl_elem_info *uinfo);
 624 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
 625         struct snd_ctl_elem_value *ucontrol);
 626 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
 627         struct snd_ctl_elem_value *ucontrol);
 628 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
 629         struct snd_ctl_elem_value *ucontrol);
 630 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
 631         struct snd_ctl_elem_value *ucontrol);
 632
 633 enum snd_soc_trigger_order {
 634                                                 /* start                        stop                 */
 635         SND_SOC_TRIGGER_ORDER_DEFAULT   = 0,    /* Link->Component->DAI         DAI->Component->Link */
 636         SND_SOC_TRIGGER_ORDER_LDC,              /* Link->DAI->Component         Component->DAI->Link */
 637
 638         SND_SOC_TRIGGER_ORDER_MAX,
 639 };
 640
 641 /* SoC PCM stream information */
 642 struct snd_soc_pcm_stream {
 643         const char *stream_name;
 644         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 645         u32 subformats;                 /* for S32_LE format, SNDRV_PCM_SUBFMTBIT_* */
 646         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 647         unsigned int rate_min;          /* min rate */
 648         unsigned int rate_max;          /* max rate */
 649         unsigned int channels_min;      /* min channels */
 650         unsigned int channels_max;      /* max channels */
 651         unsigned int sig_bits;          /* number of bits of content */
 652 };
 653
 654 /* SoC audio ops */
 655 struct snd_soc_ops {
 656         int (*startup)(struct snd_pcm_substream *);
 657         void (*shutdown)(struct snd_pcm_substream *);
 658         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 659         int (*hw_free)(struct snd_pcm_substream *);
 660         int (*prepare)(struct snd_pcm_substream *);
 661         int (*trigger)(struct snd_pcm_substream *, int);
 662 };
 663
 664 struct snd_soc_compr_ops {
 665         int (*startup)(struct snd_compr_stream *);
 666         void (*shutdown)(struct snd_compr_stream *);
 667         int (*set_params)(struct snd_compr_stream *);
 668 };
 669
 670 struct snd_soc_component*
 671 snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
 672                        const char *driver_name);
 673
 674 struct snd_soc_dai_link_component {
 675         const char *name;
 676         struct device_node *of_node;
 677         const char *dai_name;
 678         struct of_phandle_args *dai_args;
 679 };
 680
 681 /*
 682  * [dai_link->ch_maps Image sample]
 683  *
 684  *-------------------------
 685  * CPU0 <---> Codec0
 686  *
 687  * ch-map[0].cpu = 0    ch-map[0].codec = 0
 688  *
 689  *-------------------------
 690  * CPU0 <---> Codec0
 691  * CPU1 <---> Codec1
 692  * CPU2 <---> Codec2
 693  *
 694  * ch-map[0].cpu = 0    ch-map[0].codec = 0
 695  * ch-map[1].cpu = 1    ch-map[1].codec = 1
 696  * ch-map[2].cpu = 2    ch-map[2].codec = 2
 697  *
 698  *-------------------------
 699  * CPU0 <---> Codec0
 700  * CPU1 <-+-> Codec1
 701  * CPU2 <-/
 702  *
 703  * ch-map[0].cpu = 0    ch-map[0].codec = 0
 704  * ch-map[1].cpu = 1    ch-map[1].codec = 1
 705  * ch-map[2].cpu = 2    ch-map[2].codec = 1
 706  *
 707  *-------------------------
 708  * CPU0 <---> Codec0
 709  * CPU1 <-+-> Codec1
 710  *        \-> Codec2
 711  *
 712  * ch-map[0].cpu = 0    ch-map[0].codec = 0
 713  * ch-map[1].cpu = 1    ch-map[1].codec = 1
 714  * ch-map[2].cpu = 1    ch-map[2].codec = 2
 715  *
 716  */
 717 struct snd_soc_dai_link_ch_map {
 718         unsigned int cpu;
 719         unsigned int codec;
 720         unsigned int ch_mask;
 721 };
 722
 723 struct snd_soc_dai_link {
 724         /* config - must be set by machine driver */
 725         const char *name;                       /* Codec name */
 726         const char *stream_name;                /* Stream name */
 727
 728         /*
 729          * You MAY specify the link's CPU-side device, either by device name,
 730          * or by DT/OF node, but not both. If this information is omitted,
 731          * the CPU-side DAI is matched using .cpu_dai_name only, which hence
 732          * must be globally unique. These fields are currently typically used
 733          * only for codec to codec links, or systems using device tree.
 734          */
 735         /*
 736          * You MAY specify the DAI name of the CPU DAI. If this information is
 737          * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
 738          * only, which only works well when that device exposes a single DAI.
 739          */
 740         struct snd_soc_dai_link_component *cpus;
 741         unsigned int num_cpus;
 742
 743         /*
 744          * You MUST specify the link's codec, either by device name, or by
 745          * DT/OF node, but not both.
 746          */
 747         /* You MUST specify the DAI name within the codec */
 748         struct snd_soc_dai_link_component *codecs;
 749         unsigned int num_codecs;
 750
 751         /* num_ch_maps = max(num_cpu, num_codecs) */
 752         struct snd_soc_dai_link_ch_map *ch_maps;
 753
 754         /*
 755          * You MAY specify the link's platform/PCM/DMA driver, either by
 756          * device name, or by DT/OF node, but not both. Some forms of link
 757          * do not need a platform. In such case, platforms are not mandatory.
 758          */
 759         struct snd_soc_dai_link_component *platforms;
 760         unsigned int num_platforms;
 761
 762         int id; /* optional ID for machine driver link identification */
 763
 764         /*
 765          * for Codec2Codec
 766          */
 767         const struct snd_soc_pcm_stream *c2c_params;
 768         unsigned int num_c2c_params;
 769
 770         unsigned int dai_fmt;           /* format to set on init */
 771
 772         enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
 773
 774         /* codec/machine specific init - e.g. add machine controls */
 775         int (*init)(struct snd_soc_pcm_runtime *rtd);
 776
 777         /* codec/machine specific exit - dual of init() */
 778         void (*exit)(struct snd_soc_pcm_runtime *rtd);
 779
 780         /* optional hw_params re-writing for BE and FE sync */
 781         int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
 782                         struct snd_pcm_hw_params *params);
 783
 784         /* machine stream operations */
 785         const struct snd_soc_ops *ops;
 786         const struct snd_soc_compr_ops *compr_ops;
 787
 788         /*
 789          * soc_pcm_trigger() start/stop sequence.
 790          * see also
 791          *      snd_soc_component_driver
 792          *      soc_pcm_trigger()
 793          */
 794         enum snd_soc_trigger_order trigger_start;
 795         enum snd_soc_trigger_order trigger_stop;
 796
 797         /* Mark this pcm with non atomic ops */
 798         unsigned int nonatomic:1;
 799
 800         /* For unidirectional dai links */
 801         unsigned int playback_only:1;
 802         unsigned int capture_only:1;
 803
 804         /* Keep DAI active over suspend */
 805         unsigned int ignore_suspend:1;
 806
 807         /* Symmetry requirements */
 808         unsigned int symmetric_rate:1;
 809         unsigned int symmetric_channels:1;
 810         unsigned int symmetric_sample_bits:1;
 811
 812         /* Do not create a PCM for this DAI link (Backend link) */
 813         unsigned int no_pcm:1;
 814
 815         /* This DAI link can route to other DAI links at runtime (Frontend)*/
 816         unsigned int dynamic:1;
 817
 818         /* DPCM capture and Playback support */
 819         unsigned int dpcm_capture:1;
 820         unsigned int dpcm_playback:1;
 821
 822         /* DPCM used FE & BE merged format */
 823         unsigned int dpcm_merged_format:1;
 824         /* DPCM used FE & BE merged channel */
 825         unsigned int dpcm_merged_chan:1;
 826         /* DPCM used FE & BE merged rate */
 827         unsigned int dpcm_merged_rate:1;
 828
 829         /* pmdown_time is ignored at stop */
 830         unsigned int ignore_pmdown_time:1;
 831
 832         /* Do not create a PCM for this DAI link (Backend link) */
 833         unsigned int ignore:1;
 834
 835 #ifdef CONFIG_SND_SOC_TOPOLOGY
 836         struct snd_soc_dobj dobj; /* For topology */
 837 #endif
 838 };
 839
 840 static inline int snd_soc_link_num_ch_map(struct snd_soc_dai_link *link) {
 841         return max(link->num_cpus, link->num_codecs);
 842 }
 843
 844 static inline struct snd_soc_dai_link_component*
 845 snd_soc_link_to_cpu(struct snd_soc_dai_link *link, int n) {
 846         return &(link)->cpus[n];
 847 }
 848
 849 static inline struct snd_soc_dai_link_component*
 850 snd_soc_link_to_codec(struct snd_soc_dai_link *link, int n) {
 851         return &(link)->codecs[n];
 852 }
 853
 854 static inline struct snd_soc_dai_link_component*
 855 snd_soc_link_to_platform(struct snd_soc_dai_link *link, int n) {
 856         return &(link)->platforms[n];
 857 }
 858
 859 #define for_each_link_codecs(link, i, codec)                            \
 860         for ((i) = 0;                                                   \
 861              ((i) < link->num_codecs) &&                                \
 862                      ((codec) = snd_soc_link_to_codec(link, i));                \
 863              (i)++)
 864
 865 #define for_each_link_platforms(link, i, platform)                      \
 866         for ((i) = 0;                                                   \
 867              ((i) < link->num_platforms) &&                             \
 868                      ((platform) = snd_soc_link_to_platform(link, i));  \
 869              (i)++)
 870
 871 #define for_each_link_cpus(link, i, cpu)                                \
 872         for ((i) = 0;                                                   \
 873              ((i) < link->num_cpus) &&                                  \
 874                      ((cpu) = snd_soc_link_to_cpu(link, i));            \
 875              (i)++)
 876
 877 #define for_each_link_ch_maps(link, i, ch_map)                  \
 878         for ((i) = 0;                                           \
 879              ((i) < snd_soc_link_num_ch_map(link) &&            \
 880                       ((ch_map) = link->ch_maps + i));          \
 881              (i)++)
 882
 883 /*
 884  * Sample 1 : Single CPU/Codec/Platform
 885  *
 886  * SND_SOC_DAILINK_DEFS(test,
 887  *      DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai")),
 888  *      DAILINK_COMP_ARRAY(COMP_CODEC("codec", "codec_dai")),
 889  *      DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
 890  *
 891  * struct snd_soc_dai_link link = {
 892  *      ...
 893  *      SND_SOC_DAILINK_REG(test),
 894  * };
 895  *
 896  * Sample 2 : Multi CPU/Codec, no Platform
 897  *
 898  * SND_SOC_DAILINK_DEFS(test,
 899  *      DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
 900  *                         COMP_CPU("cpu_dai2")),
 901  *      DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
 902  *                         COMP_CODEC("codec2", "codec_dai2")));
 903  *
 904  * struct snd_soc_dai_link link = {
 905  *      ...
 906  *      SND_SOC_DAILINK_REG(test),
 907  * };
 908  *
 909  * Sample 3 : Define each CPU/Codec/Platform manually
 910  *
 911  * SND_SOC_DAILINK_DEF(test_cpu,
 912  *              DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
 913  *                                 COMP_CPU("cpu_dai2")));
 914  * SND_SOC_DAILINK_DEF(test_codec,
 915  *              DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
 916  *                                 COMP_CODEC("codec2", "codec_dai2")));
 917  * SND_SOC_DAILINK_DEF(test_platform,
 918  *              DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
 919  *
 920  * struct snd_soc_dai_link link = {
 921  *      ...
 922  *      SND_SOC_DAILINK_REG(test_cpu,
 923  *                          test_codec,
 924  *                          test_platform),
 925  * };
 926  *
 927  * Sample 4 : Sample3 without platform
 928  *
 929  * struct snd_soc_dai_link link = {
 930  *      ...
 931  *      SND_SOC_DAILINK_REG(test_cpu,
 932  *                          test_codec);
 933  * };
 934  */
 935
 936 #define SND_SOC_DAILINK_REG1(name)       SND_SOC_DAILINK_REG3(name##_cpus, name##_codecs, name##_platforms)
 937 #define SND_SOC_DAILINK_REG2(cpu, codec) SND_SOC_DAILINK_REG3(cpu, codec, null_dailink_component)
 938 #define SND_SOC_DAILINK_REG3(cpu, codec, platform)      \
 939         .cpus           = cpu,                          \
 940         .num_cpus       = ARRAY_SIZE(cpu),              \
 941         .codecs         = codec,                        \
 942         .num_codecs     = ARRAY_SIZE(codec),            \
 943         .platforms      = platform,                     \
 944         .num_platforms  = ARRAY_SIZE(platform)
 945
 946 #define SND_SOC_DAILINK_REG(...) \
 947         CONCATENATE(SND_SOC_DAILINK_REG, COUNT_ARGS(__VA_ARGS__))(__VA_ARGS__)
 948
 949 #define SND_SOC_DAILINK_DEF(name, def...)               \
 950         static struct snd_soc_dai_link_component name[] = { def }
 951
 952 #define SND_SOC_DAILINK_DEFS(name, cpu, codec, platform...)     \
 953         SND_SOC_DAILINK_DEF(name##_cpus, cpu);                  \
 954         SND_SOC_DAILINK_DEF(name##_codecs, codec);              \
 955         SND_SOC_DAILINK_DEF(name##_platforms, platform)
 956
 957 #define DAILINK_COMP_ARRAY(param...)    param
 958 #define COMP_EMPTY()                    { }
 959 #define COMP_CPU(_dai)                  { .dai_name = _dai, }
 960 #define COMP_CODEC(_name, _dai)         { .name = _name, .dai_name = _dai, }
 961 #define COMP_PLATFORM(_name)            { .name = _name }
 962 #define COMP_AUX(_name)                 { .name = _name }
 963 #define COMP_CODEC_CONF(_name)          { .name = _name }
 964 #define COMP_DUMMY()                    /* see snd_soc_fill_dummy_dai() */
 965
 966 extern struct snd_soc_dai_link_component null_dailink_component[0];
 967 extern struct snd_soc_dai_link_component snd_soc_dummy_dlc;
 968
 969
 970 struct snd_soc_codec_conf {
 971         /*
 972          * specify device either by device name, or by
 973          * DT/OF node, but not both.
 974          */
 975         struct snd_soc_dai_link_component dlc;
 976
 977         /*
 978          * optional map of kcontrol, widget and path name prefixes that are
 979          * associated per device
 980          */
 981         const char *name_prefix;
 982 };
 983
 984 struct snd_soc_aux_dev {
 985         /*
 986          * specify multi-codec either by device name, or by
 987          * DT/OF node, but not both.
 988          */
 989         struct snd_soc_dai_link_component dlc;
 990
 991         /* codec/machine specific init - e.g. add machine controls */
 992         int (*init)(struct snd_soc_component *component);
 993 };
 994
 995 /* SoC card */
 996 struct snd_soc_card {
 997         const char *name;
 998         const char *long_name;
 999         const char *driver_name;
1000         const char *components;
1001 #ifdef CONFIG_DMI
1002         char dmi_longname[80];
1003 #endif /* CONFIG_DMI */
1004
1005 #ifdef CONFIG_PCI
1006         /*
1007          * PCI does not define 0 as invalid, so pci_subsystem_set indicates
1008          * whether a value has been written to these fields.
1009          */
1010         unsigned short pci_subsystem_vendor;
1011         unsigned short pci_subsystem_device;
1012         bool pci_subsystem_set;
1013 #endif /* CONFIG_PCI */
1014
1015         char topology_shortname[32];
1016
1017         struct device *dev;
1018         struct snd_card *snd_card;
1019         struct module *owner;
1020
1021         struct mutex mutex;
1022         struct mutex dapm_mutex;
1023
1024         /* Mutex for PCM operations */
1025         struct mutex pcm_mutex;
1026         enum snd_soc_pcm_subclass pcm_subclass;
1027
1028         int (*probe)(struct snd_soc_card *card);
1029         int (*late_probe)(struct snd_soc_card *card);
1030         void (*fixup_controls)(struct snd_soc_card *card);
1031         int (*remove)(struct snd_soc_card *card);
1032
1033         /* the pre and post PM functions are used to do any PM work before and
1034          * after the codec and DAI's do any PM work. */
1035         int (*suspend_pre)(struct snd_soc_card *card);
1036         int (*suspend_post)(struct snd_soc_card *card);
1037         int (*resume_pre)(struct snd_soc_card *card);
1038         int (*resume_post)(struct snd_soc_card *card);
1039
1040         /* callbacks */
1041         int (*set_bias_level)(struct snd_soc_card *,
1042                               struct snd_soc_dapm_context *dapm,
1043                               enum snd_soc_bias_level level);
1044         int (*set_bias_level_post)(struct snd_soc_card *,
1045                                    struct snd_soc_dapm_context *dapm,
1046                                    enum snd_soc_bias_level level);
1047
1048         int (*add_dai_link)(struct snd_soc_card *,
1049                             struct snd_soc_dai_link *link);
1050         void (*remove_dai_link)(struct snd_soc_card *,
1051                             struct snd_soc_dai_link *link);
1052
1053         long pmdown_time;
1054
1055         /* CPU <--> Codec DAI links  */
1056         struct snd_soc_dai_link *dai_link;  /* predefined links only */
1057         int num_links;  /* predefined links only */
1058
1059         struct list_head rtd_list;
1060         int num_rtd;
1061
1062         /* optional codec specific configuration */
1063         struct snd_soc_codec_conf *codec_conf;
1064         int num_configs;
1065
1066         /*
1067          * optional auxiliary devices such as amplifiers or codecs with DAI
1068          * link unused
1069          */
1070         struct snd_soc_aux_dev *aux_dev;
1071         int num_aux_devs;
1072         struct list_head aux_comp_list;
1073
1074         const struct snd_kcontrol_new *controls;
1075         int num_controls;
1076
1077         /*
1078          * Card-specific routes and widgets.
1079          * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1080          */
1081         const struct snd_soc_dapm_widget *dapm_widgets;
1082         int num_dapm_widgets;
1083         const struct snd_soc_dapm_route *dapm_routes;
1084         int num_dapm_routes;
1085         const struct snd_soc_dapm_widget *of_dapm_widgets;
1086         int num_of_dapm_widgets;
1087         const struct snd_soc_dapm_route *of_dapm_routes;
1088         int num_of_dapm_routes;
1089
1090         /* lists of probed devices belonging to this card */
1091         struct list_head component_dev_list;
1092         struct list_head list;
1093
1094         struct list_head widgets;
1095         struct list_head paths;
1096         struct list_head dapm_list;
1097         struct list_head dapm_dirty;
1098
1099         /* attached dynamic objects */
1100         struct list_head dobj_list;
1101
1102         /* Generic DAPM context for the card */
1103         struct snd_soc_dapm_context dapm;
1104         struct snd_soc_dapm_stats dapm_stats;
1105         struct snd_soc_dapm_update *update;
1106
1107 #ifdef CONFIG_DEBUG_FS
1108         struct dentry *debugfs_card_root;
1109 #endif
1110 #ifdef CONFIG_PM_SLEEP
1111         struct work_struct deferred_resume_work;
1112 #endif
1113         u32 pop_time;
1114
1115         /* bit field */
1116         unsigned int instantiated:1;
1117         unsigned int topology_shortname_created:1;
1118         unsigned int fully_routed:1;
1119         unsigned int disable_route_checks:1;
1120         unsigned int probed:1;
1121         unsigned int component_chaining:1;
1122
1123         void *drvdata;
1124 };
1125 #define for_each_card_prelinks(card, i, link)                           \
1126         for ((i) = 0;                                                   \
1127              ((i) < (card)->num_links) && ((link) = &(card)->dai_link[i]); \
1128              (i)++)
1129 #define for_each_card_pre_auxs(card, i, aux)                            \
1130         for ((i) = 0;                                                   \
1131              ((i) < (card)->num_aux_devs) && ((aux) = &(card)->aux_dev[i]); \
1132              (i)++)
1133
1134 #define for_each_card_rtds(card, rtd)                   \
1135         list_for_each_entry(rtd, &(card)->rtd_list, list)
1136 #define for_each_card_rtds_safe(card, rtd, _rtd)        \
1137         list_for_each_entry_safe(rtd, _rtd, &(card)->rtd_list, list)
1138
1139 #define for_each_card_auxs(card, component)                     \
1140         list_for_each_entry(component, &card->aux_comp_list, card_aux_list)
1141 #define for_each_card_auxs_safe(card, component, _comp) \
1142         list_for_each_entry_safe(component, _comp,      \
1143                                  &card->aux_comp_list, card_aux_list)
1144
1145 #define for_each_card_components(card, component)                       \
1146         list_for_each_entry(component, &(card)->component_dev_list, card_list)
1147
1148 #define for_each_card_dapms(card, dapm)                                 \
1149         list_for_each_entry(dapm, &card->dapm_list, list)
1150
1151 #define for_each_card_widgets(card, w)\
1152         list_for_each_entry(w, &card->widgets, list)
1153 #define for_each_card_widgets_safe(card, w, _w) \
1154         list_for_each_entry_safe(w, _w, &card->widgets, list)
1155
1156
1157 static inline int snd_soc_card_is_instantiated(struct snd_soc_card *card)
1158 {
1159         return card && card->instantiated;
1160 }
1161
1162 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1163 struct snd_soc_pcm_runtime {
1164         struct device *dev;
1165         struct snd_soc_card *card;
1166         struct snd_soc_dai_link *dai_link;
1167         struct snd_pcm_ops ops;
1168
1169         unsigned int c2c_params_select; /* currently selected c2c_param for dai link */
1170
1171         /* Dynamic PCM BE runtime data */
1172         struct snd_soc_dpcm_runtime dpcm[SNDRV_PCM_STREAM_LAST + 1];
1173         struct snd_soc_dapm_widget *c2c_widget[SNDRV_PCM_STREAM_LAST + 1];
1174
1175         long pmdown_time;
1176
1177         /* runtime devices */
1178         struct snd_pcm *pcm;
1179         struct snd_compr *compr;
1180
1181         /*
1182          * dais = cpu_dai + codec_dai
1183          * see
1184          *      soc_new_pcm_runtime()
1185          *      snd_soc_rtd_to_cpu()
1186          *      snd_soc_rtd_to_codec()
1187          */
1188         struct snd_soc_dai **dais;
1189
1190         struct delayed_work delayed_work;
1191         void (*close_delayed_work_func)(struct snd_soc_pcm_runtime *rtd);
1192 #ifdef CONFIG_DEBUG_FS
1193         struct dentry *debugfs_dpcm_root;
1194 #endif
1195
1196         unsigned int num; /* 0-based and monotonic increasing */
1197         struct list_head list; /* rtd list of the soc card */
1198
1199         /* function mark */
1200         struct snd_pcm_substream *mark_startup;
1201         struct snd_pcm_substream *mark_hw_params;
1202         struct snd_pcm_substream *mark_trigger;
1203         struct snd_compr_stream  *mark_compr_startup;
1204
1205         /* bit field */
1206         unsigned int pop_wait:1;
1207         unsigned int fe_compr:1; /* for Dynamic PCM */
1208
1209         bool initialized;
1210
1211         int num_components;
1212         struct snd_soc_component *components[]; /* CPU/Codec/Platform */
1213 };
1214
1215 /* see soc_new_pcm_runtime()  */
1216 #define snd_soc_rtd_to_cpu(rtd, n)   (rtd)->dais[n]
1217 #define snd_soc_rtd_to_codec(rtd, n) (rtd)->dais[n + (rtd)->dai_link->num_cpus]
1218
1219 static inline struct snd_soc_pcm_runtime *
1220 snd_soc_substream_to_rtd(const struct snd_pcm_substream *substream)
1221 {
1222         return snd_pcm_substream_chip(substream);
1223 }
1224
1225 #define for_each_rtd_components(rtd, i, component)                      \
1226         for ((i) = 0, component = NULL;                                 \
1227              ((i) < rtd->num_components) && ((component) = rtd->components[i]);\
1228              (i)++)
1229 #define for_each_rtd_cpu_dais(rtd, i, dai)                              \
1230         for ((i) = 0;                                                   \
1231              ((i) < rtd->dai_link->num_cpus) && ((dai) = snd_soc_rtd_to_cpu(rtd, i)); \
1232              (i)++)
1233 #define for_each_rtd_codec_dais(rtd, i, dai)                            \
1234         for ((i) = 0;                                                   \
1235              ((i) < rtd->dai_link->num_codecs) && ((dai) = snd_soc_rtd_to_codec(rtd, i)); \
1236              (i)++)
1237 #define for_each_rtd_dais(rtd, i, dai)                                  \
1238         for ((i) = 0;                                                   \
1239              ((i) < (rtd)->dai_link->num_cpus + (rtd)->dai_link->num_codecs) && \
1240                      ((dai) = (rtd)->dais[i]);                          \
1241              (i)++)
1242 #define for_each_rtd_dais_reverse(rtd, i, dai)                                  \
1243         for ((i) = (rtd)->dai_link->num_cpus + (rtd)->dai_link->num_codecs - 1; \
1244              (i) >= 0 && ((dai) = (rtd)->dais[i]);                              \
1245              (i)--)
1246 #define for_each_rtd_ch_maps(rtd, i, ch_maps) for_each_link_ch_maps(rtd->dai_link, i, ch_maps)
1247
1248 void snd_soc_close_delayed_work(struct snd_soc_pcm_runtime *rtd);
1249
1250 /* mixer control */
1251 struct soc_mixer_control {
1252         int min, max, platform_max;
1253         int reg, rreg;
1254         unsigned int shift, rshift;
1255         unsigned int sign_bit;
1256         unsigned int invert:1;
1257         unsigned int autodisable:1;
1258 #ifdef CONFIG_SND_SOC_TOPOLOGY
1259         struct snd_soc_dobj dobj;
1260 #endif
1261 };
1262
1263 struct soc_bytes {
1264         int base;
1265         int num_regs;
1266         u32 mask;
1267 };
1268
1269 struct soc_bytes_ext {
1270         int max;
1271 #ifdef CONFIG_SND_SOC_TOPOLOGY
1272         struct snd_soc_dobj dobj;
1273 #endif
1274         /* used for TLV byte control */
1275         int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1276                         unsigned int size);
1277         int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1278                         unsigned int size);
1279 };
1280
1281 /* multi register control */
1282 struct soc_mreg_control {
1283         long min, max;
1284         unsigned int regbase, regcount, nbits, invert;
1285 };
1286
1287 /* enumerated kcontrol */
1288 struct soc_enum {
1289         int reg;
1290         unsigned char shift_l;
1291         unsigned char shift_r;
1292         unsigned int items;
1293         unsigned int mask;
1294         const char * const *texts;
1295         const unsigned int *values;
1296         unsigned int autodisable:1;
1297 #ifdef CONFIG_SND_SOC_TOPOLOGY
1298         struct snd_soc_dobj dobj;
1299 #endif
1300 };
1301
1302 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1303 {
1304         if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1305                 return false;
1306         /*
1307          * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1308          * mc->reg != mc->rreg means that the control is
1309          * stereo (bits in one register or in two registers)
1310          */
1311         return true;
1312 }
1313
1314 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1315         unsigned int val)
1316 {
1317         unsigned int i;
1318
1319         if (!e->values)
1320                 return val;
1321
1322         for (i = 0; i < e->items; i++)
1323                 if (val == e->values[i])
1324                         return i;
1325
1326         return 0;
1327 }
1328
1329 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1330         unsigned int item)
1331 {
1332         if (!e->values)
1333                 return item;
1334
1335         return e->values[item];
1336 }
1337
1338 /**
1339  * snd_soc_kcontrol_component() - Returns the component that registered the
1340  *  control
1341  * @kcontrol: The control for which to get the component
1342  *
1343  * Note: This function will work correctly if the control has been registered
1344  * for a component. With snd_soc_add_codec_controls() or via table based
1345  * setup for either a CODEC or component driver. Otherwise the behavior is
1346  * undefined.
1347  */
1348 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1349         struct snd_kcontrol *kcontrol)
1350 {
1351         return snd_kcontrol_chip(kcontrol);
1352 }
1353
1354 int snd_soc_util_init(void);
1355 void snd_soc_util_exit(void);
1356
1357 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1358                                const char *propname);
1359 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1360                                           const char *propname);
1361 int snd_soc_of_parse_pin_switches(struct snd_soc_card *card, const char *prop);
1362 int snd_soc_of_get_slot_mask(struct device_node *np,
1363                              const char *prop_name,
1364                              unsigned int *mask);
1365 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1366                               unsigned int *tx_mask,
1367                               unsigned int *rx_mask,
1368                               unsigned int *slots,
1369                               unsigned int *slot_width);
1370 void snd_soc_of_parse_node_prefix(struct device_node *np,
1371                                    struct snd_soc_codec_conf *codec_conf,
1372                                    struct device_node *of_node,
1373                                    const char *propname);
1374 static inline
1375 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1376                                    struct snd_soc_codec_conf *codec_conf,
1377                                    struct device_node *of_node,
1378                                    const char *propname)
1379 {
1380         snd_soc_of_parse_node_prefix(card->dev->of_node,
1381                                      codec_conf, of_node, propname);
1382 }
1383
1384 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1385                                    const char *propname);
1386 int snd_soc_of_parse_aux_devs(struct snd_soc_card *card, const char *propname);
1387
1388 unsigned int snd_soc_daifmt_clock_provider_flipped(unsigned int dai_fmt);
1389 unsigned int snd_soc_daifmt_clock_provider_from_bitmap(unsigned int bit_frame);
1390
1391 unsigned int snd_soc_daifmt_parse_format(struct device_node *np, const char *prefix);
1392 unsigned int snd_soc_daifmt_parse_clock_provider_raw(struct device_node *np,
1393                                                      const char *prefix,
1394                                                      struct device_node **bitclkmaster,
1395                                                      struct device_node **framemaster);
1396 #define snd_soc_daifmt_parse_clock_provider_as_bitmap(np, prefix)       \
1397         snd_soc_daifmt_parse_clock_provider_raw(np, prefix, NULL, NULL)
1398 #define snd_soc_daifmt_parse_clock_provider_as_phandle                  \
1399         snd_soc_daifmt_parse_clock_provider_raw
1400 #define snd_soc_daifmt_parse_clock_provider_as_flag(np, prefix)         \
1401         snd_soc_daifmt_clock_provider_from_bitmap(                      \
1402                 snd_soc_daifmt_parse_clock_provider_as_bitmap(np, prefix))
1403
1404 int snd_soc_get_stream_cpu(struct snd_soc_dai_link *dai_link, int stream);
1405 int snd_soc_get_dlc(const struct of_phandle_args *args,
1406                     struct snd_soc_dai_link_component *dlc);
1407 int snd_soc_of_get_dlc(struct device_node *of_node,
1408                        struct of_phandle_args *args,
1409                        struct snd_soc_dai_link_component *dlc,
1410                        int index);
1411 int snd_soc_get_dai_id(struct device_node *ep);
1412 int snd_soc_get_dai_name(const struct of_phandle_args *args,
1413                          const char **dai_name);
1414 int snd_soc_of_get_dai_name(struct device_node *of_node,
1415                             const char **dai_name, int index);
1416 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1417                                    struct device_node *of_node,
1418                                    struct snd_soc_dai_link *dai_link);
1419 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link);
1420 int snd_soc_of_get_dai_link_cpus(struct device *dev,
1421                                  struct device_node *of_node,
1422                                  struct snd_soc_dai_link *dai_link);
1423 void snd_soc_of_put_dai_link_cpus(struct snd_soc_dai_link *dai_link);
1424
1425 int snd_soc_add_pcm_runtimes(struct snd_soc_card *card,
1426                              struct snd_soc_dai_link *dai_link,
1427                              int num_dai_link);
1428 void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
1429                                 struct snd_soc_pcm_runtime *rtd);
1430
1431 void snd_soc_dlc_use_cpu_as_platform(struct snd_soc_dai_link_component *platforms,
1432                                      struct snd_soc_dai_link_component *cpus);
1433 struct of_phandle_args *snd_soc_copy_dai_args(struct device *dev,
1434                                               const struct of_phandle_args *args);
1435 struct snd_soc_dai *snd_soc_get_dai_via_args(const struct of_phandle_args *dai_args);
1436 struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
1437                                          struct snd_soc_dai_driver *dai_drv,
1438                                          bool legacy_dai_naming);
1439 struct snd_soc_dai *devm_snd_soc_register_dai(struct device *dev,
1440                                               struct snd_soc_component *component,
1441                                               struct snd_soc_dai_driver *dai_drv,
1442                                               bool legacy_dai_naming);
1443 void snd_soc_unregister_dai(struct snd_soc_dai *dai);
1444
1445 struct snd_soc_dai *snd_soc_find_dai(
1446         const struct snd_soc_dai_link_component *dlc);
1447 struct snd_soc_dai *snd_soc_find_dai_with_mutex(
1448         const struct snd_soc_dai_link_component *dlc);
1449
1450 #include <sound/soc-dai.h>
1451
1452 static inline
1453 int snd_soc_fixup_dai_links_platform_name(struct snd_soc_card *card,
1454                                           const char *platform_name)
1455 {
1456         struct snd_soc_dai_link *dai_link;
1457         const char *name;
1458         int i;
1459
1460         if (!platform_name) /* nothing to do */
1461                 return 0;
1462
1463         /* set platform name for each dailink */
1464         for_each_card_prelinks(card, i, dai_link) {
1465                 /* only single platform is supported for now */
1466                 if (dai_link->num_platforms != 1)
1467                         return -EINVAL;
1468
1469                 if (!dai_link->platforms)
1470                         return -EINVAL;
1471
1472                 name = devm_kstrdup(card->dev, platform_name, GFP_KERNEL);
1473                 if (!name)
1474                         return -ENOMEM;
1475
1476                 /* only single platform is supported for now */
1477                 dai_link->platforms->name = name;
1478         }
1479
1480         return 0;
1481 }
1482
1483 #ifdef CONFIG_DEBUG_FS
1484 extern struct dentry *snd_soc_debugfs_root;
1485 #endif
1486
1487 extern const struct dev_pm_ops snd_soc_pm_ops;
1488
1489 /*
1490  *      DAPM helper functions
1491  */
1492 enum snd_soc_dapm_subclass {
1493         SND_SOC_DAPM_CLASS_ROOT         = 0,
1494         SND_SOC_DAPM_CLASS_RUNTIME      = 1,
1495 };
1496
1497 static inline void _snd_soc_dapm_mutex_lock_root_c(struct snd_soc_card *card)
1498 {
1499         mutex_lock_nested(&card->dapm_mutex, SND_SOC_DAPM_CLASS_ROOT);
1500 }
1501
1502 static inline void _snd_soc_dapm_mutex_lock_c(struct snd_soc_card *card)
1503 {
1504         mutex_lock_nested(&card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
1505 }
1506
1507 static inline void _snd_soc_dapm_mutex_unlock_c(struct snd_soc_card *card)
1508 {
1509         mutex_unlock(&card->dapm_mutex);
1510 }
1511
1512 static inline void _snd_soc_dapm_mutex_assert_held_c(struct snd_soc_card *card)
1513 {
1514         lockdep_assert_held(&card->dapm_mutex);
1515 }
1516
1517 static inline void _snd_soc_dapm_mutex_lock_root_d(struct snd_soc_dapm_context *dapm)
1518 {
1519         _snd_soc_dapm_mutex_lock_root_c(dapm->card);
1520 }
1521
1522 static inline void _snd_soc_dapm_mutex_lock_d(struct snd_soc_dapm_context *dapm)
1523 {
1524         _snd_soc_dapm_mutex_lock_c(dapm->card);
1525 }
1526
1527 static inline void _snd_soc_dapm_mutex_unlock_d(struct snd_soc_dapm_context *dapm)
1528 {
1529         _snd_soc_dapm_mutex_unlock_c(dapm->card);
1530 }
1531
1532 static inline void _snd_soc_dapm_mutex_assert_held_d(struct snd_soc_dapm_context *dapm)
1533 {
1534         _snd_soc_dapm_mutex_assert_held_c(dapm->card);
1535 }
1536
1537 #define snd_soc_dapm_mutex_lock_root(x) _Generic((x),                   \
1538         struct snd_soc_card * :         _snd_soc_dapm_mutex_lock_root_c, \
1539         struct snd_soc_dapm_context * : _snd_soc_dapm_mutex_lock_root_d)(x)
1540 #define snd_soc_dapm_mutex_lock(x) _Generic((x),                        \
1541         struct snd_soc_card * :         _snd_soc_dapm_mutex_lock_c,     \
1542         struct snd_soc_dapm_context * : _snd_soc_dapm_mutex_lock_d)(x)
1543 #define snd_soc_dapm_mutex_unlock(x) _Generic((x),                      \
1544         struct snd_soc_card * :         _snd_soc_dapm_mutex_unlock_c,   \
1545         struct snd_soc_dapm_context * : _snd_soc_dapm_mutex_unlock_d)(x)
1546 #define snd_soc_dapm_mutex_assert_held(x) _Generic((x),                 \
1547         struct snd_soc_card * :         _snd_soc_dapm_mutex_assert_held_c, \
1548         struct snd_soc_dapm_context * : _snd_soc_dapm_mutex_assert_held_d)(x)
1549
1550 /*
1551  *      PCM helper functions
1552  */
1553 static inline void _snd_soc_dpcm_mutex_lock_c(struct snd_soc_card *card)
1554 {
1555         mutex_lock_nested(&card->pcm_mutex, card->pcm_subclass);
1556 }
1557
1558 static inline void _snd_soc_dpcm_mutex_unlock_c(struct snd_soc_card *card)
1559 {
1560         mutex_unlock(&card->pcm_mutex);
1561 }
1562
1563 static inline void _snd_soc_dpcm_mutex_assert_held_c(struct snd_soc_card *card)
1564 {
1565         lockdep_assert_held(&card->pcm_mutex);
1566 }
1567
1568 static inline void _snd_soc_dpcm_mutex_lock_r(struct snd_soc_pcm_runtime *rtd)
1569 {
1570         _snd_soc_dpcm_mutex_lock_c(rtd->card);
1571 }
1572
1573 static inline void _snd_soc_dpcm_mutex_unlock_r(struct snd_soc_pcm_runtime *rtd)
1574 {
1575         _snd_soc_dpcm_mutex_unlock_c(rtd->card);
1576 }
1577
1578 static inline void _snd_soc_dpcm_mutex_assert_held_r(struct snd_soc_pcm_runtime *rtd)
1579 {
1580         _snd_soc_dpcm_mutex_assert_held_c(rtd->card);
1581 }
1582
1583 #define snd_soc_dpcm_mutex_lock(x) _Generic((x),                        \
1584          struct snd_soc_card * :        _snd_soc_dpcm_mutex_lock_c,     \
1585          struct snd_soc_pcm_runtime * : _snd_soc_dpcm_mutex_lock_r)(x)
1586
1587 #define snd_soc_dpcm_mutex_unlock(x) _Generic((x),                      \
1588          struct snd_soc_card * :        _snd_soc_dpcm_mutex_unlock_c,   \
1589          struct snd_soc_pcm_runtime * : _snd_soc_dpcm_mutex_unlock_r)(x)
1590
1591 #define snd_soc_dpcm_mutex_assert_held(x) _Generic((x),         \
1592         struct snd_soc_card * :         _snd_soc_dpcm_mutex_assert_held_c, \
1593         struct snd_soc_pcm_runtime * :  _snd_soc_dpcm_mutex_assert_held_r)(x)
1594
1595 #include <sound/soc-component.h>
1596 #include <sound/soc-card.h>
1597 #include <sound/soc-jack.h>
1598
1599 #endif