include/sound/soc.h

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