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);
 490 #ifdef CONFIG_SND_SOC_COMPRESS
 491 int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd);
 492 #else
 493 static inline int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd)
 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(const 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(const struct snd_pcm_hw_params *parms);
 540 int snd_soc_tdm_params_to_bclk(const struct snd_pcm_hw_params *params,
 541                                int tdm_width, int tdm_slots, int slot_multiple);
 542
 543 /* set runtime hw params */
 544 static inline int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 545                                                const struct snd_pcm_hardware *hw)
 546 {
 547         substream->runtime->hw = *hw;
 548
 549         return 0;
 550 }
 551
 552 struct snd_ac97 *snd_soc_alloc_ac97_component(struct snd_soc_component *component);
 553 struct snd_ac97 *snd_soc_new_ac97_component(struct snd_soc_component *component,
 554         unsigned int id, unsigned int id_mask);
 555 void snd_soc_free_ac97_component(struct snd_ac97 *ac97);
 556
 557 #ifdef CONFIG_SND_SOC_AC97_BUS
 558 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
 559 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 560                 struct platform_device *pdev);
 561
 562 extern struct snd_ac97_bus_ops *soc_ac97_ops;
 563 #else
 564 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 565         struct platform_device *pdev)
 566 {
 567         return 0;
 568 }
 569
 570 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
 571 {
 572         return 0;
 573 }
 574 #endif
 575
 576 /*
 577  *Controls
 578  */
 579 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 580                                   void *data, const char *long_name,
 581                                   const char *prefix);
 582 int snd_soc_add_component_controls(struct snd_soc_component *component,
 583         const struct snd_kcontrol_new *controls, unsigned int num_controls);
 584 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
 585         const struct snd_kcontrol_new *controls, int num_controls);
 586 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
 587         const struct snd_kcontrol_new *controls, int num_controls);
 588 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 589         struct snd_ctl_elem_info *uinfo);
 590 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 591         struct snd_ctl_elem_value *ucontrol);
 592 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 593         struct snd_ctl_elem_value *ucontrol);
 594 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 595         struct snd_ctl_elem_info *uinfo);
 596 int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol,
 597                           struct snd_ctl_elem_info *uinfo);
 598 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 599 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 600         struct snd_ctl_elem_value *ucontrol);
 601 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 602         struct snd_ctl_elem_value *ucontrol);
 603 #define snd_soc_get_volsw_2r snd_soc_get_volsw
 604 #define snd_soc_put_volsw_2r snd_soc_put_volsw
 605 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
 606         struct snd_ctl_elem_value *ucontrol);
 607 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
 608         struct snd_ctl_elem_value *ucontrol);
 609 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
 610         struct snd_ctl_elem_info *uinfo);
 611 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
 612         struct snd_ctl_elem_value *ucontrol);
 613 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
 614         struct snd_ctl_elem_value *ucontrol);
 615 int snd_soc_limit_volume(struct snd_soc_card *card,
 616         const char *name, int max);
 617 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
 618                        struct snd_ctl_elem_info *uinfo);
 619 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
 620                       struct snd_ctl_elem_value *ucontrol);
 621 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
 622                       struct snd_ctl_elem_value *ucontrol);
 623 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
 624         struct snd_ctl_elem_info *ucontrol);
 625 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
 626         unsigned int size, unsigned int __user *tlv);
 627 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
 628         struct snd_ctl_elem_info *uinfo);
 629 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
 630         struct snd_ctl_elem_value *ucontrol);
 631 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
 632         struct snd_ctl_elem_value *ucontrol);
 633 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
 634         struct snd_ctl_elem_value *ucontrol);
 635 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
 636         struct snd_ctl_elem_value *ucontrol);
 637
 638 enum snd_soc_trigger_order {
 639                                                 /* start                        stop                 */
 640         SND_SOC_TRIGGER_ORDER_DEFAULT   = 0,    /* Link->Component->DAI         DAI->Component->Link */
 641         SND_SOC_TRIGGER_ORDER_LDC,              /* Link->DAI->Component         Component->DAI->Link */
 642
 643         SND_SOC_TRIGGER_ORDER_MAX,
 644 };
 645
 646 /* SoC PCM stream information */
 647 struct snd_soc_pcm_stream {
 648         const char *stream_name;
 649         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 650         u32 subformats;                 /* for S32_LE format, SNDRV_PCM_SUBFMTBIT_* */
 651         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 652         unsigned int rate_min;          /* min rate */
 653         unsigned int rate_max;          /* max rate */
 654         unsigned int channels_min;      /* min channels */
 655         unsigned int channels_max;      /* max channels */
 656         unsigned int sig_bits;          /* number of bits of content */
 657 };
 658
 659 /* SoC audio ops */
 660 struct snd_soc_ops {
 661         int (*startup)(struct snd_pcm_substream *);
 662         void (*shutdown)(struct snd_pcm_substream *);
 663         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 664         int (*hw_free)(struct snd_pcm_substream *);
 665         int (*prepare)(struct snd_pcm_substream *);
 666         int (*trigger)(struct snd_pcm_substream *, int);
 667 };
 668
 669 struct snd_soc_compr_ops {
 670         int (*startup)(struct snd_compr_stream *);
 671         void (*shutdown)(struct snd_compr_stream *);
 672         int (*set_params)(struct snd_compr_stream *);
 673 };
 674
 675 struct snd_soc_component*
 676 snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
 677                        const char *driver_name);
 678
 679 struct snd_soc_dai_link_component {
 680         const char *name;
 681         struct device_node *of_node;
 682         const char *dai_name;
 683         const struct of_phandle_args *dai_args;
 684
 685         /*
 686          * Extra format = SND_SOC_DAIFMT_Bx_Fx
 687          *
 688          * [Note] it is Bx_Fx base, not CBx_CFx
 689          *
 690          * It will be used with dai_link->dai_fmt
 691          * see
 692          *      snd_soc_runtime_set_dai_fmt()
 693          */
 694         unsigned int ext_fmt;
 695 };
 696
 697 /*
 698  * [dai_link->ch_maps Image sample]
 699  *
 700  *-------------------------
 701  * CPU0 <---> Codec0
 702  *
 703  * ch-map[0].cpu = 0    ch-map[0].codec = 0
 704  *
 705  *-------------------------
 706  * CPU0 <---> Codec0
 707  * CPU1 <---> Codec1
 708  * CPU2 <---> Codec2
 709  *
 710  * ch-map[0].cpu = 0    ch-map[0].codec = 0
 711  * ch-map[1].cpu = 1    ch-map[1].codec = 1
 712  * ch-map[2].cpu = 2    ch-map[2].codec = 2
 713  *
 714  *-------------------------
 715  * CPU0 <---> Codec0
 716  * CPU1 <-+-> Codec1
 717  * CPU2 <-/
 718  *
 719  * ch-map[0].cpu = 0    ch-map[0].codec = 0
 720  * ch-map[1].cpu = 1    ch-map[1].codec = 1
 721  * ch-map[2].cpu = 2    ch-map[2].codec = 1
 722  *
 723  *-------------------------
 724  * CPU0 <---> Codec0
 725  * CPU1 <-+-> Codec1
 726  *        \-> Codec2
 727  *
 728  * ch-map[0].cpu = 0    ch-map[0].codec = 0
 729  * ch-map[1].cpu = 1    ch-map[1].codec = 1
 730  * ch-map[2].cpu = 1    ch-map[2].codec = 2
 731  *
 732  */
 733 struct snd_soc_dai_link_ch_map {
 734         unsigned int cpu;
 735         unsigned int codec;
 736         unsigned int ch_mask;
 737 };
 738
 739 struct snd_soc_dai_link {
 740         /* config - must be set by machine driver */
 741         const char *name;                       /* Codec name */
 742         const char *stream_name;                /* Stream name */
 743
 744         /*
 745          * You MAY specify the link's CPU-side device, either by device name,
 746          * or by DT/OF node, but not both. If this information is omitted,
 747          * the CPU-side DAI is matched using .cpu_dai_name only, which hence
 748          * must be globally unique. These fields are currently typically used
 749          * only for codec to codec links, or systems using device tree.
 750          */
 751         /*
 752          * You MAY specify the DAI name of the CPU DAI. If this information is
 753          * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
 754          * only, which only works well when that device exposes a single DAI.
 755          */
 756         struct snd_soc_dai_link_component *cpus;
 757         unsigned int num_cpus;
 758
 759         /*
 760          * You MUST specify the link's codec, either by device name, or by
 761          * DT/OF node, but not both.
 762          */
 763         /* You MUST specify the DAI name within the codec */
 764         struct snd_soc_dai_link_component *codecs;
 765         unsigned int num_codecs;
 766
 767         /* num_ch_maps = max(num_cpu, num_codecs) */
 768         struct snd_soc_dai_link_ch_map *ch_maps;
 769
 770         /*
 771          * You MAY specify the link's platform/PCM/DMA driver, either by
 772          * device name, or by DT/OF node, but not both. Some forms of link
 773          * do not need a platform. In such case, platforms are not mandatory.
 774          */
 775         struct snd_soc_dai_link_component *platforms;
 776         unsigned int num_platforms;
 777
 778         int id; /* optional ID for machine driver link identification */
 779
 780         /*
 781          * for Codec2Codec
 782          */
 783         const struct snd_soc_pcm_stream *c2c_params;
 784         unsigned int num_c2c_params;
 785
 786         unsigned int dai_fmt;           /* format to set on init */
 787
 788         enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
 789
 790         /* codec/machine specific init - e.g. add machine controls */
 791         int (*init)(struct snd_soc_pcm_runtime *rtd);
 792
 793         /* codec/machine specific exit - dual of init() */
 794         void (*exit)(struct snd_soc_pcm_runtime *rtd);
 795
 796         /* optional hw_params re-writing for BE and FE sync */
 797         int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
 798                         struct snd_pcm_hw_params *params);
 799
 800         /* machine stream operations */
 801         const struct snd_soc_ops *ops;
 802         const struct snd_soc_compr_ops *compr_ops;
 803
 804         /*
 805          * soc_pcm_trigger() start/stop sequence.
 806          * see also
 807          *      snd_soc_component_driver
 808          *      soc_pcm_trigger()
 809          */
 810         enum snd_soc_trigger_order trigger_start;
 811         enum snd_soc_trigger_order trigger_stop;
 812
 813         /* Mark this pcm with non atomic ops */
 814         unsigned int nonatomic:1;
 815
 816         /* For unidirectional dai links */
 817         unsigned int playback_only:1;
 818         unsigned int capture_only:1;
 819
 820         /* Keep DAI active over suspend */
 821         unsigned int ignore_suspend:1;
 822
 823         /* Symmetry requirements */
 824         unsigned int symmetric_rate:1;
 825         unsigned int symmetric_channels:1;
 826         unsigned int symmetric_sample_bits:1;
 827
 828         /* Do not create a PCM for this DAI link (Backend link) */
 829         unsigned int no_pcm:1;
 830
 831         /* This DAI link can route to other DAI links at runtime (Frontend)*/
 832         unsigned int dynamic:1;
 833
 834         /* DPCM used FE & BE merged format */
 835         unsigned int dpcm_merged_format:1;
 836         /* DPCM used FE & BE merged channel */
 837         unsigned int dpcm_merged_chan:1;
 838         /* DPCM used FE & BE merged rate */
 839         unsigned int dpcm_merged_rate:1;
 840
 841         /* pmdown_time is ignored at stop */
 842         unsigned int ignore_pmdown_time:1;
 843
 844         /* Do not create a PCM for this DAI link (Backend link) */
 845         unsigned int ignore:1;
 846
 847 #ifdef CONFIG_SND_SOC_TOPOLOGY
 848         struct snd_soc_dobj dobj; /* For topology */
 849 #endif
 850 };
 851
 852 static inline int snd_soc_link_num_ch_map(const struct snd_soc_dai_link *link)
 853 {
 854         return max(link->num_cpus, link->num_codecs);
 855 }
 856
 857 static inline struct snd_soc_dai_link_component*
 858 snd_soc_link_to_cpu(struct snd_soc_dai_link *link, int n) {
 859         return &(link)->cpus[n];
 860 }
 861
 862 static inline struct snd_soc_dai_link_component*
 863 snd_soc_link_to_codec(struct snd_soc_dai_link *link, int n) {
 864         return &(link)->codecs[n];
 865 }
 866
 867 static inline struct snd_soc_dai_link_component*
 868 snd_soc_link_to_platform(struct snd_soc_dai_link *link, int n) {
 869         return &(link)->platforms[n];
 870 }
 871
 872 #define for_each_link_codecs(link, i, codec)                            \
 873         for ((i) = 0;                                                   \
 874              ((i) < link->num_codecs) &&                                \
 875                      ((codec) = snd_soc_link_to_codec(link, i));                \
 876              (i)++)
 877
 878 #define for_each_link_platforms(link, i, platform)                      \
 879         for ((i) = 0;                                                   \
 880              ((i) < link->num_platforms) &&                             \
 881                      ((platform) = snd_soc_link_to_platform(link, i));  \
 882              (i)++)
 883
 884 #define for_each_link_cpus(link, i, cpu)                                \
 885         for ((i) = 0;                                                   \
 886              ((i) < link->num_cpus) &&                                  \
 887                      ((cpu) = snd_soc_link_to_cpu(link, i));            \
 888              (i)++)
 889
 890 #define for_each_link_ch_maps(link, i, ch_map)                  \
 891         for ((i) = 0;                                           \
 892              ((i) < snd_soc_link_num_ch_map(link) &&            \
 893                       ((ch_map) = link->ch_maps + i));          \
 894              (i)++)
 895
 896 /*
 897  * Sample 1 : Single CPU/Codec/Platform
 898  *
 899  * SND_SOC_DAILINK_DEFS(test,
 900  *      DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai")),
 901  *      DAILINK_COMP_ARRAY(COMP_CODEC("codec", "codec_dai")),
 902  *      DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
 903  *
 904  * struct snd_soc_dai_link link = {
 905  *      ...
 906  *      SND_SOC_DAILINK_REG(test),
 907  * };
 908  *
 909  * Sample 2 : Multi CPU/Codec, no Platform
 910  *
 911  * SND_SOC_DAILINK_DEFS(test,
 912  *      DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
 913  *                         COMP_CPU("cpu_dai2")),
 914  *      DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
 915  *                         COMP_CODEC("codec2", "codec_dai2")));
 916  *
 917  * struct snd_soc_dai_link link = {
 918  *      ...
 919  *      SND_SOC_DAILINK_REG(test),
 920  * };
 921  *
 922  * Sample 3 : Define each CPU/Codec/Platform manually
 923  *
 924  * SND_SOC_DAILINK_DEF(test_cpu,
 925  *              DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
 926  *                                 COMP_CPU("cpu_dai2")));
 927  * SND_SOC_DAILINK_DEF(test_codec,
 928  *              DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
 929  *                                 COMP_CODEC("codec2", "codec_dai2")));
 930  * SND_SOC_DAILINK_DEF(test_platform,
 931  *              DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
 932  *
 933  * struct snd_soc_dai_link link = {
 934  *      ...
 935  *      SND_SOC_DAILINK_REG(test_cpu,
 936  *                          test_codec,
 937  *                          test_platform),
 938  * };
 939  *
 940  * Sample 4 : Sample3 without platform
 941  *
 942  * struct snd_soc_dai_link link = {
 943  *      ...
 944  *      SND_SOC_DAILINK_REG(test_cpu,
 945  *                          test_codec);
 946  * };
 947  */
 948
 949 #define SND_SOC_DAILINK_REG1(name)       SND_SOC_DAILINK_REG3(name##_cpus, name##_codecs, name##_platforms)
 950 #define SND_SOC_DAILINK_REG2(cpu, codec) SND_SOC_DAILINK_REG3(cpu, codec, null_dailink_component)
 951 #define SND_SOC_DAILINK_REG3(cpu, codec, platform)      \
 952         .cpus           = cpu,                          \
 953         .num_cpus       = ARRAY_SIZE(cpu),              \
 954         .codecs         = codec,                        \
 955         .num_codecs     = ARRAY_SIZE(codec),            \
 956         .platforms      = platform,                     \
 957         .num_platforms  = ARRAY_SIZE(platform)
 958
 959 #define SND_SOC_DAILINK_REG(...) \
 960         CONCATENATE(SND_SOC_DAILINK_REG, COUNT_ARGS(__VA_ARGS__))(__VA_ARGS__)
 961
 962 #define SND_SOC_DAILINK_DEF(name, def...)               \
 963         static struct snd_soc_dai_link_component name[] = { def }
 964
 965 #define SND_SOC_DAILINK_DEFS(name, cpu, codec, platform...)     \
 966         SND_SOC_DAILINK_DEF(name##_cpus, cpu);                  \
 967         SND_SOC_DAILINK_DEF(name##_codecs, codec);              \
 968         SND_SOC_DAILINK_DEF(name##_platforms, platform)
 969
 970 #define DAILINK_COMP_ARRAY(param...)    param
 971 #define COMP_EMPTY()                    { }
 972 #define COMP_CPU(_dai)                  { .dai_name = _dai, }
 973 #define COMP_CODEC(_name, _dai)         { .name = _name, .dai_name = _dai, }
 974 #define COMP_PLATFORM(_name)            { .name = _name }
 975 #define COMP_AUX(_name)                 { .name = _name }
 976 #define COMP_CODEC_CONF(_name)          { .name = _name }
 977 #define COMP_DUMMY()                    /* see snd_soc_fill_dummy_dai() */
 978
 979 extern struct snd_soc_dai_link_component null_dailink_component[0];
 980 extern struct snd_soc_dai_link_component snd_soc_dummy_dlc;
 981
 982
 983 struct snd_soc_codec_conf {
 984         /*
 985          * specify device either by device name, or by
 986          * DT/OF node, but not both.
 987          */
 988         struct snd_soc_dai_link_component dlc;
 989
 990         /*
 991          * optional map of kcontrol, widget and path name prefixes that are
 992          * associated per device
 993          */
 994         const char *name_prefix;
 995 };
 996
 997 struct snd_soc_aux_dev {
 998         /*
 999          * specify multi-codec either by device name, or by
1000          * DT/OF node, but not both.
1001          */
1002         struct snd_soc_dai_link_component dlc;
1003
1004         /* codec/machine specific init - e.g. add machine controls */
1005         int (*init)(struct snd_soc_component *component);
1006 };
1007
1008 /* SoC card */
1009 struct snd_soc_card {
1010         const char *name;
1011         const char *long_name;
1012         const char *driver_name;
1013         const char *components;
1014 #ifdef CONFIG_DMI
1015         char dmi_longname[80];
1016 #endif /* CONFIG_DMI */
1017
1018 #ifdef CONFIG_PCI
1019         /*
1020          * PCI does not define 0 as invalid, so pci_subsystem_set indicates
1021          * whether a value has been written to these fields.
1022          */
1023         unsigned short pci_subsystem_vendor;
1024         unsigned short pci_subsystem_device;
1025         bool pci_subsystem_set;
1026 #endif /* CONFIG_PCI */
1027
1028         char topology_shortname[32];
1029
1030         struct device *dev;
1031         struct snd_card *snd_card;
1032         struct module *owner;
1033
1034         struct mutex mutex;
1035         struct mutex dapm_mutex;
1036
1037         /* Mutex for PCM operations */
1038         struct mutex pcm_mutex;
1039         enum snd_soc_pcm_subclass pcm_subclass;
1040
1041         int (*probe)(struct snd_soc_card *card);
1042         int (*late_probe)(struct snd_soc_card *card);
1043         void (*fixup_controls)(struct snd_soc_card *card);
1044         int (*remove)(struct snd_soc_card *card);
1045
1046         /* the pre and post PM functions are used to do any PM work before and
1047          * after the codec and DAI's do any PM work. */
1048         int (*suspend_pre)(struct snd_soc_card *card);
1049         int (*suspend_post)(struct snd_soc_card *card);
1050         int (*resume_pre)(struct snd_soc_card *card);
1051         int (*resume_post)(struct snd_soc_card *card);
1052
1053         /* callbacks */
1054         int (*set_bias_level)(struct snd_soc_card *,
1055                               struct snd_soc_dapm_context *dapm,
1056                               enum snd_soc_bias_level level);
1057         int (*set_bias_level_post)(struct snd_soc_card *,
1058                                    struct snd_soc_dapm_context *dapm,
1059                                    enum snd_soc_bias_level level);
1060
1061         int (*add_dai_link)(struct snd_soc_card *,
1062                             struct snd_soc_dai_link *link);
1063         void (*remove_dai_link)(struct snd_soc_card *,
1064                             struct snd_soc_dai_link *link);
1065
1066         long pmdown_time;
1067
1068         /* CPU <--> Codec DAI links  */
1069         struct snd_soc_dai_link *dai_link;  /* predefined links only */
1070         int num_links;  /* predefined links only */
1071
1072         struct list_head rtd_list;
1073         int num_rtd;
1074
1075         /* optional codec specific configuration */
1076         struct snd_soc_codec_conf *codec_conf;
1077         int num_configs;
1078
1079         /*
1080          * optional auxiliary devices such as amplifiers or codecs with DAI
1081          * link unused
1082          */
1083         struct snd_soc_aux_dev *aux_dev;
1084         int num_aux_devs;
1085         struct list_head aux_comp_list;
1086
1087         const struct snd_kcontrol_new *controls;
1088         int num_controls;
1089
1090         /*
1091          * Card-specific routes and widgets.
1092          * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1093          */
1094         const struct snd_soc_dapm_widget *dapm_widgets;
1095         int num_dapm_widgets;
1096         const struct snd_soc_dapm_route *dapm_routes;
1097         int num_dapm_routes;
1098         const struct snd_soc_dapm_widget *of_dapm_widgets;
1099         int num_of_dapm_widgets;
1100         const struct snd_soc_dapm_route *of_dapm_routes;
1101         int num_of_dapm_routes;
1102
1103         /* lists of probed devices belonging to this card */
1104         struct list_head component_dev_list;
1105         struct list_head list;
1106
1107         struct list_head widgets;
1108         struct list_head paths;
1109         struct list_head dapm_list;
1110         struct list_head dapm_dirty;
1111
1112         /* attached dynamic objects */
1113         struct list_head dobj_list;
1114
1115         /* Generic DAPM context for the card */
1116         struct snd_soc_dapm_context dapm;
1117         struct snd_soc_dapm_stats dapm_stats;
1118         struct snd_soc_dapm_update *update;
1119
1120 #ifdef CONFIG_DEBUG_FS
1121         struct dentry *debugfs_card_root;
1122 #endif
1123 #ifdef CONFIG_PM_SLEEP
1124         struct work_struct deferred_resume_work;
1125 #endif
1126         u32 pop_time;
1127
1128         /* bit field */
1129         unsigned int instantiated:1;
1130         unsigned int topology_shortname_created:1;
1131         unsigned int fully_routed:1;
1132         unsigned int probed:1;
1133         unsigned int component_chaining:1;
1134
1135         void *drvdata;
1136 };
1137 #define for_each_card_prelinks(card, i, link)                           \
1138         for ((i) = 0;                                                   \
1139              ((i) < (card)->num_links) && ((link) = &(card)->dai_link[i]); \
1140              (i)++)
1141 #define for_each_card_pre_auxs(card, i, aux)                            \
1142         for ((i) = 0;                                                   \
1143              ((i) < (card)->num_aux_devs) && ((aux) = &(card)->aux_dev[i]); \
1144              (i)++)
1145
1146 #define for_each_card_rtds(card, rtd)                   \
1147         list_for_each_entry(rtd, &(card)->rtd_list, list)
1148 #define for_each_card_rtds_safe(card, rtd, _rtd)        \
1149         list_for_each_entry_safe(rtd, _rtd, &(card)->rtd_list, list)
1150
1151 #define for_each_card_auxs(card, component)                     \
1152         list_for_each_entry(component, &card->aux_comp_list, card_aux_list)
1153 #define for_each_card_auxs_safe(card, component, _comp) \
1154         list_for_each_entry_safe(component, _comp,      \
1155                                  &card->aux_comp_list, card_aux_list)
1156
1157 #define for_each_card_components(card, component)                       \
1158         list_for_each_entry(component, &(card)->component_dev_list, card_list)
1159
1160 #define for_each_card_dapms(card, dapm)                                 \
1161         list_for_each_entry(dapm, &card->dapm_list, list)
1162
1163 #define for_each_card_widgets(card, w)\
1164         list_for_each_entry(w, &card->widgets, list)
1165 #define for_each_card_widgets_safe(card, w, _w) \
1166         list_for_each_entry_safe(w, _w, &card->widgets, list)
1167
1168
1169 static inline int snd_soc_card_is_instantiated(struct snd_soc_card *card)
1170 {
1171         return card && card->instantiated;
1172 }
1173
1174 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1175 struct snd_soc_pcm_runtime {
1176         struct device *dev;
1177         struct snd_soc_card *card;
1178         struct snd_soc_dai_link *dai_link;
1179         struct snd_pcm_ops ops;
1180
1181         unsigned int c2c_params_select; /* currently selected c2c_param for dai link */
1182
1183         /* Dynamic PCM BE runtime data */
1184         struct snd_soc_dpcm_runtime dpcm[SNDRV_PCM_STREAM_LAST + 1];
1185         struct snd_soc_dapm_widget *c2c_widget[SNDRV_PCM_STREAM_LAST + 1];
1186
1187         long pmdown_time;
1188
1189         /* runtime devices */
1190         struct snd_pcm *pcm;
1191         struct snd_compr *compr;
1192
1193         /*
1194          * dais = cpu_dai + codec_dai
1195          * see
1196          *      soc_new_pcm_runtime()
1197          *      snd_soc_rtd_to_cpu()
1198          *      snd_soc_rtd_to_codec()
1199          */
1200         struct snd_soc_dai **dais;
1201
1202         struct delayed_work delayed_work;
1203         void (*close_delayed_work_func)(struct snd_soc_pcm_runtime *rtd);
1204 #ifdef CONFIG_DEBUG_FS
1205         struct dentry *debugfs_dpcm_root;
1206 #endif
1207
1208         unsigned int id; /* 0-based and monotonic increasing */
1209         struct list_head list; /* rtd list of the soc card */
1210
1211         /* function mark */
1212         struct snd_pcm_substream *mark_startup;
1213         struct snd_pcm_substream *mark_hw_params;
1214         struct snd_pcm_substream *mark_trigger;
1215         struct snd_compr_stream  *mark_compr_startup;
1216
1217         /* bit field */
1218         unsigned int pop_wait:1;
1219         unsigned int fe_compr:1; /* for Dynamic PCM */
1220         unsigned int initialized:1;
1221
1222         /* CPU/Codec/Platform */
1223         int num_components;
1224         struct snd_soc_component *components[] __counted_by(num_components);
1225 };
1226
1227 /* see soc_new_pcm_runtime()  */
1228 #define snd_soc_rtd_to_cpu(rtd, n)   (rtd)->dais[n]
1229 #define snd_soc_rtd_to_codec(rtd, n) (rtd)->dais[n + (rtd)->dai_link->num_cpus]
1230
1231 static inline struct snd_soc_pcm_runtime *
1232 snd_soc_substream_to_rtd(const struct snd_pcm_substream *substream)
1233 {
1234         return snd_pcm_substream_chip(substream);
1235 }
1236
1237 #define for_each_rtd_components(rtd, i, component)                      \
1238         for ((i) = 0, component = NULL;                                 \
1239              ((i) < rtd->num_components) && ((component) = rtd->components[i]);\
1240              (i)++)
1241 #define for_each_rtd_cpu_dais(rtd, i, dai)                              \
1242         for ((i) = 0;                                                   \
1243              ((i) < rtd->dai_link->num_cpus) && ((dai) = snd_soc_rtd_to_cpu(rtd, i)); \
1244              (i)++)
1245 #define for_each_rtd_codec_dais(rtd, i, dai)                            \
1246         for ((i) = 0;                                                   \
1247              ((i) < rtd->dai_link->num_codecs) && ((dai) = snd_soc_rtd_to_codec(rtd, i)); \
1248              (i)++)
1249 #define for_each_rtd_dais(rtd, i, dai)                                  \
1250         for ((i) = 0;                                                   \
1251              ((i) < (rtd)->dai_link->num_cpus + (rtd)->dai_link->num_codecs) && \
1252                      ((dai) = (rtd)->dais[i]);                          \
1253              (i)++)
1254 #define for_each_rtd_dais_reverse(rtd, i, dai)                                  \
1255         for ((i) = (rtd)->dai_link->num_cpus + (rtd)->dai_link->num_codecs - 1; \
1256              (i) >= 0 && ((dai) = (rtd)->dais[i]);                              \
1257              (i)--)
1258 #define for_each_rtd_ch_maps(rtd, i, ch_maps) for_each_link_ch_maps(rtd->dai_link, i, ch_maps)
1259
1260 void snd_soc_close_delayed_work(struct snd_soc_pcm_runtime *rtd);
1261
1262 /* mixer control */
1263 struct soc_mixer_control {
1264         int min, max, platform_max;
1265         int reg, rreg;
1266         unsigned int shift, rshift;
1267         unsigned int sign_bit;
1268         unsigned int invert:1;
1269         unsigned int autodisable:1;
1270 #ifdef CONFIG_SND_SOC_TOPOLOGY
1271         struct snd_soc_dobj dobj;
1272 #endif
1273 };
1274
1275 struct soc_bytes {
1276         int base;
1277         int num_regs;
1278         u32 mask;
1279 };
1280
1281 struct soc_bytes_ext {
1282         int max;
1283 #ifdef CONFIG_SND_SOC_TOPOLOGY
1284         struct snd_soc_dobj dobj;
1285 #endif
1286         /* used for TLV byte control */
1287         int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1288                         unsigned int size);
1289         int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1290                         unsigned int size);
1291 };
1292
1293 /* multi register control */
1294 struct soc_mreg_control {
1295         long min, max;
1296         unsigned int regbase, regcount, nbits, invert;
1297 };
1298
1299 /* enumerated kcontrol */
1300 struct soc_enum {
1301         int reg;
1302         unsigned char shift_l;
1303         unsigned char shift_r;
1304         unsigned int items;
1305         unsigned int mask;
1306         const char * const *texts;
1307         const unsigned int *values;
1308         unsigned int autodisable:1;
1309 #ifdef CONFIG_SND_SOC_TOPOLOGY
1310         struct snd_soc_dobj dobj;
1311 #endif
1312 };
1313
1314 static inline bool snd_soc_volsw_is_stereo(const struct soc_mixer_control *mc)
1315 {
1316         if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1317                 return false;
1318         /*
1319          * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1320          * mc->reg != mc->rreg means that the control is
1321          * stereo (bits in one register or in two registers)
1322          */
1323         return true;
1324 }
1325
1326 static inline unsigned int snd_soc_enum_val_to_item(const struct soc_enum *e,
1327         unsigned int val)
1328 {
1329         unsigned int i;
1330
1331         if (!e->values)
1332                 return val;
1333
1334         for (i = 0; i < e->items; i++)
1335                 if (val == e->values[i])
1336                         return i;
1337
1338         return 0;
1339 }
1340
1341 static inline unsigned int snd_soc_enum_item_to_val(const struct soc_enum *e,
1342         unsigned int item)
1343 {
1344         if (!e->values)
1345                 return item;
1346
1347         return e->values[item];
1348 }
1349
1350 /**
1351  * snd_soc_kcontrol_component() - Returns the component that registered the
1352  *  control
1353  * @kcontrol: The control for which to get the component
1354  *
1355  * Note: This function will work correctly if the control has been registered
1356  * for a component. With snd_soc_add_codec_controls() or via table based
1357  * setup for either a CODEC or component driver. Otherwise the behavior is
1358  * undefined.
1359  */
1360 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1361         struct snd_kcontrol *kcontrol)
1362 {
1363         return snd_kcontrol_chip(kcontrol);
1364 }
1365
1366 int snd_soc_util_init(void);
1367 void snd_soc_util_exit(void);
1368
1369 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1370                                const char *propname);
1371 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1372                                           const char *propname);
1373 int snd_soc_of_parse_pin_switches(struct snd_soc_card *card, const char *prop);
1374 int snd_soc_of_get_slot_mask(struct device_node *np,
1375                              const char *prop_name,
1376                              unsigned int *mask);
1377 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1378                               unsigned int *tx_mask,
1379                               unsigned int *rx_mask,
1380                               unsigned int *slots,
1381                               unsigned int *slot_width);
1382 void snd_soc_of_parse_node_prefix(struct device_node *np,
1383                                    struct snd_soc_codec_conf *codec_conf,
1384                                    struct device_node *of_node,
1385                                    const char *propname);
1386 static inline
1387 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1388                                    struct snd_soc_codec_conf *codec_conf,
1389                                    struct device_node *of_node,
1390                                    const char *propname)
1391 {
1392         snd_soc_of_parse_node_prefix(card->dev->of_node,
1393                                      codec_conf, of_node, propname);
1394 }
1395
1396 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1397                                    const char *propname);
1398 int snd_soc_of_parse_aux_devs(struct snd_soc_card *card, const char *propname);
1399
1400 unsigned int snd_soc_daifmt_clock_provider_flipped(unsigned int dai_fmt);
1401 unsigned int snd_soc_daifmt_clock_provider_from_bitmap(unsigned int bit_frame);
1402
1403 unsigned int snd_soc_daifmt_parse_format(struct device_node *np, const char *prefix);
1404 unsigned int snd_soc_daifmt_parse_clock_provider_raw(struct device_node *np,
1405                                                      const char *prefix,
1406                                                      struct device_node **bitclkmaster,
1407                                                      struct device_node **framemaster);
1408 #define snd_soc_daifmt_parse_clock_provider_as_bitmap(np, prefix)       \
1409         snd_soc_daifmt_parse_clock_provider_raw(np, prefix, NULL, NULL)
1410 #define snd_soc_daifmt_parse_clock_provider_as_phandle                  \
1411         snd_soc_daifmt_parse_clock_provider_raw
1412 #define snd_soc_daifmt_parse_clock_provider_as_flag(np, prefix)         \
1413         snd_soc_daifmt_clock_provider_from_bitmap(                      \
1414                 snd_soc_daifmt_parse_clock_provider_as_bitmap(np, prefix))
1415
1416 int snd_soc_get_stream_cpu(const struct snd_soc_dai_link *dai_link, int stream);
1417 int snd_soc_get_dlc(const struct of_phandle_args *args,
1418                     struct snd_soc_dai_link_component *dlc);
1419 int snd_soc_of_get_dlc(struct device_node *of_node,
1420                        struct of_phandle_args *args,
1421                        struct snd_soc_dai_link_component *dlc,
1422                        int index);
1423 int snd_soc_get_dai_id(struct device_node *ep);
1424 int snd_soc_get_dai_name(const struct of_phandle_args *args,
1425                          const char **dai_name);
1426 int snd_soc_of_get_dai_name(struct device_node *of_node,
1427                             const char **dai_name, int index);
1428 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1429                                    struct device_node *of_node,
1430                                    struct snd_soc_dai_link *dai_link);
1431 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link);
1432 int snd_soc_of_get_dai_link_cpus(struct device *dev,
1433                                  struct device_node *of_node,
1434                                  struct snd_soc_dai_link *dai_link);
1435 void snd_soc_of_put_dai_link_cpus(struct snd_soc_dai_link *dai_link);
1436
1437 int snd_soc_add_pcm_runtimes(struct snd_soc_card *card,
1438                              struct snd_soc_dai_link *dai_link,
1439                              int num_dai_link);
1440 void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
1441                                 struct snd_soc_pcm_runtime *rtd);
1442
1443 void snd_soc_dlc_use_cpu_as_platform(struct snd_soc_dai_link_component *platforms,
1444                                      struct snd_soc_dai_link_component *cpus);
1445 struct of_phandle_args *snd_soc_copy_dai_args(struct device *dev,
1446                                               const struct of_phandle_args *args);
1447 struct snd_soc_dai *snd_soc_get_dai_via_args(const struct of_phandle_args *dai_args);
1448 struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
1449                                          struct snd_soc_dai_driver *dai_drv,
1450                                          bool legacy_dai_naming);
1451 void snd_soc_unregister_dai(struct snd_soc_dai *dai);
1452
1453 struct snd_soc_dai *snd_soc_find_dai(
1454         const struct snd_soc_dai_link_component *dlc);
1455 struct snd_soc_dai *snd_soc_find_dai_with_mutex(
1456         const struct snd_soc_dai_link_component *dlc);
1457
1458 #include <sound/soc-dai.h>
1459
1460 static inline
1461 int snd_soc_fixup_dai_links_platform_name(struct snd_soc_card *card,
1462                                           const char *platform_name)
1463 {
1464         struct snd_soc_dai_link *dai_link;
1465         const char *name;
1466         int i;
1467
1468         if (!platform_name) /* nothing to do */
1469                 return 0;
1470
1471         /* set platform name for each dailink */
1472         for_each_card_prelinks(card, i, dai_link) {
1473                 /* only single platform is supported for now */
1474                 if (dai_link->num_platforms != 1)
1475                         return -EINVAL;
1476
1477                 if (!dai_link->platforms)
1478                         return -EINVAL;
1479
1480                 name = devm_kstrdup(card->dev, platform_name, GFP_KERNEL);
1481                 if (!name)
1482                         return -ENOMEM;
1483
1484                 /* only single platform is supported for now */
1485                 dai_link->platforms->name = name;
1486         }
1487
1488         return 0;
1489 }
1490
1491 #ifdef CONFIG_DEBUG_FS
1492 extern struct dentry *snd_soc_debugfs_root;
1493 #endif
1494
1495 extern const struct dev_pm_ops snd_soc_pm_ops;
1496
1497 /*
1498  *      DAPM helper functions
1499  */
1500 enum snd_soc_dapm_subclass {
1501         SND_SOC_DAPM_CLASS_ROOT         = 0,
1502         SND_SOC_DAPM_CLASS_RUNTIME      = 1,
1503 };
1504
1505 static inline void _snd_soc_dapm_mutex_lock_root_c(struct snd_soc_card *card)
1506 {
1507         mutex_lock_nested(&card->dapm_mutex, SND_SOC_DAPM_CLASS_ROOT);
1508 }
1509
1510 static inline void _snd_soc_dapm_mutex_lock_c(struct snd_soc_card *card)
1511 {
1512         mutex_lock_nested(&card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
1513 }
1514
1515 static inline void _snd_soc_dapm_mutex_unlock_c(struct snd_soc_card *card)
1516 {
1517         mutex_unlock(&card->dapm_mutex);
1518 }
1519
1520 static inline void _snd_soc_dapm_mutex_assert_held_c(struct snd_soc_card *card)
1521 {
1522         lockdep_assert_held(&card->dapm_mutex);
1523 }
1524
1525 static inline void _snd_soc_dapm_mutex_lock_root_d(struct snd_soc_dapm_context *dapm)
1526 {
1527         _snd_soc_dapm_mutex_lock_root_c(dapm->card);
1528 }
1529
1530 static inline void _snd_soc_dapm_mutex_lock_d(struct snd_soc_dapm_context *dapm)
1531 {
1532         _snd_soc_dapm_mutex_lock_c(dapm->card);
1533 }
1534
1535 static inline void _snd_soc_dapm_mutex_unlock_d(struct snd_soc_dapm_context *dapm)
1536 {
1537         _snd_soc_dapm_mutex_unlock_c(dapm->card);
1538 }
1539
1540 static inline void _snd_soc_dapm_mutex_assert_held_d(struct snd_soc_dapm_context *dapm)
1541 {
1542         _snd_soc_dapm_mutex_assert_held_c(dapm->card);
1543 }
1544
1545 #define snd_soc_dapm_mutex_lock_root(x) _Generic((x),                   \
1546         struct snd_soc_card * :         _snd_soc_dapm_mutex_lock_root_c, \
1547         struct snd_soc_dapm_context * : _snd_soc_dapm_mutex_lock_root_d)(x)
1548 #define snd_soc_dapm_mutex_lock(x) _Generic((x),                        \
1549         struct snd_soc_card * :         _snd_soc_dapm_mutex_lock_c,     \
1550         struct snd_soc_dapm_context * : _snd_soc_dapm_mutex_lock_d)(x)
1551 #define snd_soc_dapm_mutex_unlock(x) _Generic((x),                      \
1552         struct snd_soc_card * :         _snd_soc_dapm_mutex_unlock_c,   \
1553         struct snd_soc_dapm_context * : _snd_soc_dapm_mutex_unlock_d)(x)
1554 #define snd_soc_dapm_mutex_assert_held(x) _Generic((x),                 \
1555         struct snd_soc_card * :         _snd_soc_dapm_mutex_assert_held_c, \
1556         struct snd_soc_dapm_context * : _snd_soc_dapm_mutex_assert_held_d)(x)
1557
1558 /*
1559  *      PCM helper functions
1560  */
1561 static inline void _snd_soc_dpcm_mutex_lock_c(struct snd_soc_card *card)
1562 {
1563         mutex_lock_nested(&card->pcm_mutex, card->pcm_subclass);
1564 }
1565
1566 static inline void _snd_soc_dpcm_mutex_unlock_c(struct snd_soc_card *card)
1567 {
1568         mutex_unlock(&card->pcm_mutex);
1569 }
1570
1571 static inline void _snd_soc_dpcm_mutex_assert_held_c(struct snd_soc_card *card)
1572 {
1573         lockdep_assert_held(&card->pcm_mutex);
1574 }
1575
1576 static inline void _snd_soc_dpcm_mutex_lock_r(struct snd_soc_pcm_runtime *rtd)
1577 {
1578         _snd_soc_dpcm_mutex_lock_c(rtd->card);
1579 }
1580
1581 static inline void _snd_soc_dpcm_mutex_unlock_r(struct snd_soc_pcm_runtime *rtd)
1582 {
1583         _snd_soc_dpcm_mutex_unlock_c(rtd->card);
1584 }
1585
1586 static inline void _snd_soc_dpcm_mutex_assert_held_r(struct snd_soc_pcm_runtime *rtd)
1587 {
1588         _snd_soc_dpcm_mutex_assert_held_c(rtd->card);
1589 }
1590
1591 #define snd_soc_dpcm_mutex_lock(x) _Generic((x),                        \
1592          struct snd_soc_card * :        _snd_soc_dpcm_mutex_lock_c,     \
1593          struct snd_soc_pcm_runtime * : _snd_soc_dpcm_mutex_lock_r)(x)
1594
1595 #define snd_soc_dpcm_mutex_unlock(x) _Generic((x),                      \
1596          struct snd_soc_card * :        _snd_soc_dpcm_mutex_unlock_c,   \
1597          struct snd_soc_pcm_runtime * : _snd_soc_dpcm_mutex_unlock_r)(x)
1598
1599 #define snd_soc_dpcm_mutex_assert_held(x) _Generic((x),         \
1600         struct snd_soc_card * :         _snd_soc_dpcm_mutex_assert_held_c, \
1601         struct snd_soc_pcm_runtime * :  _snd_soc_dpcm_mutex_assert_held_r)(x)
1602
1603 #include <sound/soc-component.h>
1604 #include <sound/soc-card.h>
1605 #include <sound/soc-jack.h>
1606
1607 #endif