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 /*
 372  * Bias levels
 373  *
 374  * @ON:      Bias is fully on for audio playback and capture operations.
 375  * @PREPARE: Prepare for audio operations. Called before DAPM switching for
 376  *           stream start and stop operations.
 377  * @STANDBY: Low power standby state when no playback/capture operations are
 378  *           in progress. NOTE: The transition time between STANDBY and ON
 379  *           should be as fast as possible and no longer than 10ms.
 380  * @OFF:     Power Off. No restrictions on transition times.
 381  */
 382 enum snd_soc_bias_level {
 383         SND_SOC_BIAS_OFF = 0,
 384         SND_SOC_BIAS_STANDBY = 1,
 385         SND_SOC_BIAS_PREPARE = 2,
 386         SND_SOC_BIAS_ON = 3,
 387 };
 388
 389 struct device_node;
 390 struct snd_jack;
 391 struct snd_soc_card;
 392 struct snd_soc_pcm_stream;
 393 struct snd_soc_ops;
 394 struct snd_soc_pcm_runtime;
 395 struct snd_soc_dai;
 396 struct snd_soc_dai_driver;
 397 struct snd_soc_dai_link;
 398 struct snd_soc_component;
 399 struct snd_soc_component_driver;
 400 struct soc_enum;
 401 struct snd_soc_jack;
 402 struct snd_soc_jack_zone;
 403 struct snd_soc_jack_pin;
 404 #include <sound/soc-dapm.h>
 405 #include <sound/soc-dpcm.h>
 406 #include <sound/soc-topology.h>
 407
 408 struct snd_soc_jack_gpio;
 409
 410 typedef int (*hw_write_t)(void *,const char* ,int);
 411
 412 enum snd_soc_pcm_subclass {
 413         SND_SOC_PCM_CLASS_PCM   = 0,
 414         SND_SOC_PCM_CLASS_BE    = 1,
 415 };
 416
 417 int snd_soc_register_card(struct snd_soc_card *card);
 418 int snd_soc_unregister_card(struct snd_soc_card *card);
 419 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
 420 #ifdef CONFIG_PM_SLEEP
 421 int snd_soc_suspend(struct device *dev);
 422 int snd_soc_resume(struct device *dev);
 423 #else
 424 static inline int snd_soc_suspend(struct device *dev)
 425 {
 426         return 0;
 427 }
 428
 429 static inline int snd_soc_resume(struct device *dev)
 430 {
 431         return 0;
 432 }
 433 #endif
 434 int snd_soc_poweroff(struct device *dev);
 435 int snd_soc_add_component(struct device *dev,
 436                 struct snd_soc_component *component,
 437                 const struct snd_soc_component_driver *component_driver,
 438                 struct snd_soc_dai_driver *dai_drv,
 439                 int num_dai);
 440 int snd_soc_register_component(struct device *dev,
 441                          const struct snd_soc_component_driver *component_driver,
 442                          struct snd_soc_dai_driver *dai_drv, int num_dai);
 443 int devm_snd_soc_register_component(struct device *dev,
 444                          const struct snd_soc_component_driver *component_driver,
 445                          struct snd_soc_dai_driver *dai_drv, int num_dai);
 446 void snd_soc_unregister_component(struct device *dev);
 447 struct snd_soc_component *snd_soc_lookup_component_nolocked(struct device *dev,
 448                                                             const char *driver_name);
 449 struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
 450                                                    const char *driver_name);
 451
 452 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
 453 #ifdef CONFIG_SND_SOC_COMPRESS
 454 int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
 455 #else
 456 static inline int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num)
 457 {
 458         return 0;
 459 }
 460 #endif
 461
 462 void snd_soc_disconnect_sync(struct device *dev);
 463
 464 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
 465                                 struct snd_soc_dai_link *dai_link);
 466
 467 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
 468
 469 void snd_soc_runtime_action(struct snd_soc_pcm_runtime *rtd,
 470                             int stream, int action);
 471 static inline void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd,
 472                                      int stream)
 473 {
 474         snd_soc_runtime_action(rtd, stream, 1);
 475 }
 476 static inline void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd,
 477                                        int stream)
 478 {
 479         snd_soc_runtime_action(rtd, stream, -1);
 480 }
 481
 482 int snd_soc_runtime_calc_hw(struct snd_soc_pcm_runtime *rtd,
 483                             struct snd_pcm_hardware *hw, int stream);
 484
 485 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
 486         unsigned int dai_fmt);
 487
 488 #ifdef CONFIG_DMI
 489 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour);
 490 #else
 491 static inline int snd_soc_set_dmi_name(struct snd_soc_card *card,
 492                                        const char *flavour)
 493 {
 494         return 0;
 495 }
 496 #endif
 497
 498 /* Utility functions to get clock rates from various things */
 499 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 500 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 501 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 502 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 503
 504 /* set runtime hw params */
 505 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 506         const struct snd_pcm_hardware *hw);
 507
 508 /* Jack reporting */
 509 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 510 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 511                           struct snd_soc_jack_pin *pins);
 512 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
 513                                     struct notifier_block *nb);
 514 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
 515                                       struct notifier_block *nb);
 516 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
 517                           struct snd_soc_jack_zone *zones);
 518 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
 519 #ifdef CONFIG_GPIOLIB
 520 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 521                         struct snd_soc_jack_gpio *gpios);
 522 int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
 523                             struct snd_soc_jack *jack,
 524                             int count, struct snd_soc_jack_gpio *gpios);
 525 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 526                         struct snd_soc_jack_gpio *gpios);
 527 #else
 528 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 529                                          struct snd_soc_jack_gpio *gpios)
 530 {
 531         return 0;
 532 }
 533
 534 static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
 535                                           struct snd_soc_jack *jack,
 536                                           int count,
 537                                           struct snd_soc_jack_gpio *gpios)
 538 {
 539         return 0;
 540 }
 541
 542 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 543                                            struct snd_soc_jack_gpio *gpios)
 544 {
 545 }
 546 #endif
 547
 548 struct snd_ac97 *snd_soc_alloc_ac97_component(struct snd_soc_component *component);
 549 struct snd_ac97 *snd_soc_new_ac97_component(struct snd_soc_component *component,
 550         unsigned int id, unsigned int id_mask);
 551 void snd_soc_free_ac97_component(struct snd_ac97 *ac97);
 552
 553 #ifdef CONFIG_SND_SOC_AC97_BUS
 554 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
 555 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 556                 struct platform_device *pdev);
 557
 558 extern struct snd_ac97_bus_ops *soc_ac97_ops;
 559 #else
 560 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 561         struct platform_device *pdev)
 562 {
 563         return 0;
 564 }
 565
 566 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
 567 {
 568         return 0;
 569 }
 570 #endif
 571
 572 /*
 573  *Controls
 574  */
 575 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 576                                   void *data, const char *long_name,
 577                                   const char *prefix);
 578 int snd_soc_add_component_controls(struct snd_soc_component *component,
 579         const struct snd_kcontrol_new *controls, unsigned int num_controls);
 580 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
 581         const struct snd_kcontrol_new *controls, int num_controls);
 582 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
 583         const struct snd_kcontrol_new *controls, int num_controls);
 584 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 585         struct snd_ctl_elem_info *uinfo);
 586 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 587         struct snd_ctl_elem_value *ucontrol);
 588 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 589         struct snd_ctl_elem_value *ucontrol);
 590 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 591         struct snd_ctl_elem_info *uinfo);
 592 int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol,
 593                           struct snd_ctl_elem_info *uinfo);
 594 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 595 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 596         struct snd_ctl_elem_value *ucontrol);
 597 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 598         struct snd_ctl_elem_value *ucontrol);
 599 #define snd_soc_get_volsw_2r snd_soc_get_volsw
 600 #define snd_soc_put_volsw_2r snd_soc_put_volsw
 601 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
 602         struct snd_ctl_elem_value *ucontrol);
 603 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
 604         struct snd_ctl_elem_value *ucontrol);
 605 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
 606         struct snd_ctl_elem_info *uinfo);
 607 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
 608         struct snd_ctl_elem_value *ucontrol);
 609 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
 610         struct snd_ctl_elem_value *ucontrol);
 611 int snd_soc_limit_volume(struct snd_soc_card *card,
 612         const char *name, int max);
 613 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
 614                        struct snd_ctl_elem_info *uinfo);
 615 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
 616                       struct snd_ctl_elem_value *ucontrol);
 617 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
 618                       struct snd_ctl_elem_value *ucontrol);
 619 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
 620         struct snd_ctl_elem_info *ucontrol);
 621 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
 622         unsigned int size, unsigned int __user *tlv);
 623 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
 624         struct snd_ctl_elem_info *uinfo);
 625 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
 626         struct snd_ctl_elem_value *ucontrol);
 627 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
 628         struct snd_ctl_elem_value *ucontrol);
 629 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
 630         struct snd_ctl_elem_value *ucontrol);
 631 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
 632         struct snd_ctl_elem_value *ucontrol);
 633
 634 /**
 635  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 636  *
 637  * @pin:    name of the pin to update
 638  * @mask:   bits to check for in reported jack status
 639  * @invert: if non-zero then pin is enabled when status is not reported
 640  * @list:   internal list entry
 641  */
 642 struct snd_soc_jack_pin {
 643         struct list_head list;
 644         const char *pin;
 645         int mask;
 646         bool invert;
 647 };
 648
 649 /**
 650  * struct snd_soc_jack_zone - Describes voltage zones of jack detection
 651  *
 652  * @min_mv: start voltage in mv
 653  * @max_mv: end voltage in mv
 654  * @jack_type: type of jack that is expected for this voltage
 655  * @debounce_time: debounce_time for jack, codec driver should wait for this
 656  *              duration before reading the adc for voltages
 657  * @list:   internal list entry
 658  */
 659 struct snd_soc_jack_zone {
 660         unsigned int min_mv;
 661         unsigned int max_mv;
 662         unsigned int jack_type;
 663         unsigned int debounce_time;
 664         struct list_head list;
 665 };
 666
 667 /**
 668  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 669  *
 670  * @gpio:         legacy gpio number
 671  * @idx:          gpio descriptor index within the function of the GPIO
 672  *                consumer device
 673  * @gpiod_dev:    GPIO consumer device
 674  * @name:         gpio name. Also as connection ID for the GPIO consumer
 675  *                device function name lookup
 676  * @report:       value to report when jack detected
 677  * @invert:       report presence in low state
 678  * @debounce_time: debounce time in ms
 679  * @wake:         enable as wake source
 680  * @jack_status_check: callback function which overrides the detection
 681  *                     to provide more complex checks (eg, reading an
 682  *                     ADC).
 683  */
 684 struct snd_soc_jack_gpio {
 685         unsigned int gpio;
 686         unsigned int idx;
 687         struct device *gpiod_dev;
 688         const char *name;
 689         int report;
 690         int invert;
 691         int debounce_time;
 692         bool wake;
 693
 694         /* private: */
 695         struct snd_soc_jack *jack;
 696         struct delayed_work work;
 697         struct notifier_block pm_notifier;
 698         struct gpio_desc *desc;
 699
 700         void *data;
 701         /* public: */
 702         int (*jack_status_check)(void *data);
 703 };
 704
 705 struct snd_soc_jack {
 706         struct mutex mutex;
 707         struct snd_jack *jack;
 708         struct snd_soc_card *card;
 709         struct list_head pins;
 710         int status;
 711         struct blocking_notifier_head notifier;
 712         struct list_head jack_zones;
 713 };
 714
 715 /* SoC PCM stream information */
 716 struct snd_soc_pcm_stream {
 717         const char *stream_name;
 718         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 719         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 720         unsigned int rate_min;          /* min rate */
 721         unsigned int rate_max;          /* max rate */
 722         unsigned int channels_min;      /* min channels */
 723         unsigned int channels_max;      /* max channels */
 724         unsigned int sig_bits;          /* number of bits of content */
 725 };
 726
 727 /* SoC audio ops */
 728 struct snd_soc_ops {
 729         int (*startup)(struct snd_pcm_substream *);
 730         void (*shutdown)(struct snd_pcm_substream *);
 731         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 732         int (*hw_free)(struct snd_pcm_substream *);
 733         int (*prepare)(struct snd_pcm_substream *);
 734         int (*trigger)(struct snd_pcm_substream *, int);
 735 };
 736
 737 struct snd_soc_compr_ops {
 738         int (*startup)(struct snd_compr_stream *);
 739         void (*shutdown)(struct snd_compr_stream *);
 740         int (*set_params)(struct snd_compr_stream *);
 741         int (*trigger)(struct snd_compr_stream *);
 742 };
 743
 744 struct snd_soc_component*
 745 snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
 746                        const char *driver_name);
 747
 748 struct snd_soc_dai_link_component {
 749         const char *name;
 750         struct device_node *of_node;
 751         const char *dai_name;
 752 };
 753
 754 struct snd_soc_dai_link {
 755         /* config - must be set by machine driver */
 756         const char *name;                       /* Codec name */
 757         const char *stream_name;                /* Stream name */
 758
 759         /*
 760          * You MAY specify the link's CPU-side device, either by device name,
 761          * or by DT/OF node, but not both. If this information is omitted,
 762          * the CPU-side DAI is matched using .cpu_dai_name only, which hence
 763          * must be globally unique. These fields are currently typically used
 764          * only for codec to codec links, or systems using device tree.
 765          */
 766         /*
 767          * You MAY specify the DAI name of the CPU DAI. If this information is
 768          * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
 769          * only, which only works well when that device exposes a single DAI.
 770          */
 771         struct snd_soc_dai_link_component *cpus;
 772         unsigned int num_cpus;
 773
 774         /*
 775          * You MUST specify the link's codec, either by device name, or by
 776          * DT/OF node, but not both.
 777          */
 778         /* You MUST specify the DAI name within the codec */
 779         struct snd_soc_dai_link_component *codecs;
 780         unsigned int num_codecs;
 781
 782         /*
 783          * You MAY specify the link's platform/PCM/DMA driver, either by
 784          * device name, or by DT/OF node, but not both. Some forms of link
 785          * do not need a platform. In such case, platforms are not mandatory.
 786          */
 787         struct snd_soc_dai_link_component *platforms;
 788         unsigned int num_platforms;
 789
 790         int id; /* optional ID for machine driver link identification */
 791
 792         const struct snd_soc_pcm_stream *params;
 793         unsigned int num_params;
 794
 795         unsigned int dai_fmt;           /* format to set on init */
 796
 797         enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
 798
 799         /* codec/machine specific init - e.g. add machine controls */
 800         int (*init)(struct snd_soc_pcm_runtime *rtd);
 801
 802         /* optional hw_params re-writing for BE and FE sync */
 803         int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
 804                         struct snd_pcm_hw_params *params);
 805
 806         /* machine stream operations */
 807         const struct snd_soc_ops *ops;
 808         const struct snd_soc_compr_ops *compr_ops;
 809
 810         /* Mark this pcm with non atomic ops */
 811         unsigned int nonatomic:1;
 812
 813         /* For unidirectional dai links */
 814         unsigned int playback_only:1;
 815         unsigned int capture_only:1;
 816
 817         /* Keep DAI active over suspend */
 818         unsigned int ignore_suspend:1;
 819
 820         /* Symmetry requirements */
 821         unsigned int symmetric_rates:1;
 822         unsigned int symmetric_channels:1;
 823         unsigned int symmetric_samplebits:1;
 824
 825         /* Do not create a PCM for this DAI link (Backend link) */
 826         unsigned int no_pcm:1;
 827
 828         /* This DAI link can route to other DAI links at runtime (Frontend)*/
 829         unsigned int dynamic:1;
 830
 831         /* DPCM capture and Playback support */
 832         unsigned int dpcm_capture:1;
 833         unsigned int dpcm_playback:1;
 834
 835         /* DPCM used FE & BE merged format */
 836         unsigned int dpcm_merged_format:1;
 837         /* DPCM used FE & BE merged channel */
 838         unsigned int dpcm_merged_chan:1;
 839         /* DPCM used FE & BE merged rate */
 840         unsigned int dpcm_merged_rate:1;
 841
 842         /* pmdown_time is ignored at stop */
 843         unsigned int ignore_pmdown_time:1;
 844
 845         /* Do not create a PCM for this DAI link (Backend link) */
 846         unsigned int ignore:1;
 847
 848 #ifdef CONFIG_SND_SOC_TOPOLOGY
 849         struct snd_soc_dobj dobj; /* For topology */
 850 #endif
 851 };
 852 #define for_each_link_codecs(link, i, codec)                            \
 853         for ((i) = 0;                                                   \
 854              ((i) < link->num_codecs) && ((codec) = &link->codecs[i]);  \
 855              (i)++)
 856
 857 #define for_each_link_platforms(link, i, platform)                      \
 858         for ((i) = 0;                                                   \
 859              ((i) < link->num_platforms) &&                             \
 860              ((platform) = &link->platforms[i]);                        \
 861              (i)++)
 862
 863 #define for_each_link_cpus(link, i, cpu)                                \
 864         for ((i) = 0;                                                   \
 865              ((i) < link->num_cpus) && ((cpu) = &link->cpus[i]);        \
 866              (i)++)
 867
 868 /*
 869  * Sample 1 : Single CPU/Codec/Platform
 870  *
 871  * SND_SOC_DAILINK_DEFS(test,
 872  *      DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai")),
 873  *      DAILINK_COMP_ARRAY(COMP_CODEC("codec", "codec_dai")),
 874  *      DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
 875  *
 876  * struct snd_soc_dai_link link = {
 877  *      ...
 878  *      SND_SOC_DAILINK_REG(test),
 879  * };
 880  *
 881  * Sample 2 : Multi CPU/Codec, no Platform
 882  *
 883  * SND_SOC_DAILINK_DEFS(test,
 884  *      DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
 885  *                         COMP_CPU("cpu_dai2")),
 886  *      DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
 887  *                         COMP_CODEC("codec2", "codec_dai2")));
 888  *
 889  * struct snd_soc_dai_link link = {
 890  *      ...
 891  *      SND_SOC_DAILINK_REG(test),
 892  * };
 893  *
 894  * Sample 3 : Define each CPU/Codec/Platform manually
 895  *
 896  * SND_SOC_DAILINK_DEF(test_cpu,
 897  *              DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
 898  *                                 COMP_CPU("cpu_dai2")));
 899  * SND_SOC_DAILINK_DEF(test_codec,
 900  *              DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
 901  *                                 COMP_CODEC("codec2", "codec_dai2")));
 902  * SND_SOC_DAILINK_DEF(test_platform,
 903  *              DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
 904  *
 905  * struct snd_soc_dai_link link = {
 906  *      ...
 907  *      SND_SOC_DAILINK_REG(test_cpu,
 908  *                          test_codec,
 909  *                          test_platform),
 910  * };
 911  *
 912  * Sample 4 : Sample3 without platform
 913  *
 914  * struct snd_soc_dai_link link = {
 915  *      ...
 916  *      SND_SOC_DAILINK_REG(test_cpu,
 917  *                          test_codec);
 918  * };
 919  */
 920
 921 #define SND_SOC_DAILINK_REG1(name)       SND_SOC_DAILINK_REG3(name##_cpus, name##_codecs, name##_platforms)
 922 #define SND_SOC_DAILINK_REG2(cpu, codec) SND_SOC_DAILINK_REG3(cpu, codec, null_dailink_component)
 923 #define SND_SOC_DAILINK_REG3(cpu, codec, platform)      \
 924         .cpus           = cpu,                          \
 925         .num_cpus       = ARRAY_SIZE(cpu),              \
 926         .codecs         = codec,                        \
 927         .num_codecs     = ARRAY_SIZE(codec),            \
 928         .platforms      = platform,                     \
 929         .num_platforms  = ARRAY_SIZE(platform)
 930
 931 #define SND_SOC_DAILINK_REGx(_1, _2, _3, func, ...) func
 932 #define SND_SOC_DAILINK_REG(...) \
 933         SND_SOC_DAILINK_REGx(__VA_ARGS__,               \
 934                         SND_SOC_DAILINK_REG3,   \
 935                         SND_SOC_DAILINK_REG2,   \
 936                         SND_SOC_DAILINK_REG1)(__VA_ARGS__)
 937
 938 #define SND_SOC_DAILINK_DEF(name, def...)               \
 939         static struct snd_soc_dai_link_component name[] = { def }
 940
 941 #define SND_SOC_DAILINK_DEFS(name, cpu, codec, platform...)     \
 942         SND_SOC_DAILINK_DEF(name##_cpus, cpu);                  \
 943         SND_SOC_DAILINK_DEF(name##_codecs, codec);              \
 944         SND_SOC_DAILINK_DEF(name##_platforms, platform)
 945
 946 #define DAILINK_COMP_ARRAY(param...)    param
 947 #define COMP_EMPTY()                    { }
 948 #define COMP_CPU(_dai)                  { .dai_name = _dai, }
 949 #define COMP_CODEC(_name, _dai)         { .name = _name, .dai_name = _dai, }
 950 #define COMP_PLATFORM(_name)            { .name = _name }
 951 #define COMP_AUX(_name)                 { .name = _name }
 952 #define COMP_CODEC_CONF(_name)          { .name = _name }
 953 #define COMP_DUMMY()                    { .name = "snd-soc-dummy", .dai_name = "snd-soc-dummy-dai", }
 954
 955 extern struct snd_soc_dai_link_component null_dailink_component[0];
 956
 957
 958 struct snd_soc_codec_conf {
 959         /*
 960          * specify device either by device name, or by
 961          * DT/OF node, but not both.
 962          */
 963         struct snd_soc_dai_link_component dlc;
 964
 965         /*
 966          * optional map of kcontrol, widget and path name prefixes that are
 967          * associated per device
 968          */
 969         const char *name_prefix;
 970 };
 971
 972 struct snd_soc_aux_dev {
 973         /*
 974          * specify multi-codec either by device name, or by
 975          * DT/OF node, but not both.
 976          */
 977         struct snd_soc_dai_link_component dlc;
 978
 979         /* codec/machine specific init - e.g. add machine controls */
 980         int (*init)(struct snd_soc_component *component);
 981 };
 982
 983 /* SoC card */
 984 struct snd_soc_card {
 985         const char *name;
 986         const char *long_name;
 987         const char *driver_name;
 988         const char *components;
 989 #ifdef CONFIG_DMI
 990         char dmi_longname[80];
 991 #endif /* CONFIG_DMI */
 992         char topology_shortname[32];
 993
 994         struct device *dev;
 995         struct snd_card *snd_card;
 996         struct module *owner;
 997
 998         struct mutex mutex;
 999         struct mutex dapm_mutex;
1000
1001         /* Mutex for PCM operations */
1002         struct mutex pcm_mutex;
1003         enum snd_soc_pcm_subclass pcm_subclass;
1004
1005         spinlock_t dpcm_lock;
1006
1007         int (*probe)(struct snd_soc_card *card);
1008         int (*late_probe)(struct snd_soc_card *card);
1009         int (*remove)(struct snd_soc_card *card);
1010
1011         /* the pre and post PM functions are used to do any PM work before and
1012          * after the codec and DAI's do any PM work. */
1013         int (*suspend_pre)(struct snd_soc_card *card);
1014         int (*suspend_post)(struct snd_soc_card *card);
1015         int (*resume_pre)(struct snd_soc_card *card);
1016         int (*resume_post)(struct snd_soc_card *card);
1017
1018         /* callbacks */
1019         int (*set_bias_level)(struct snd_soc_card *,
1020                               struct snd_soc_dapm_context *dapm,
1021                               enum snd_soc_bias_level level);
1022         int (*set_bias_level_post)(struct snd_soc_card *,
1023                                    struct snd_soc_dapm_context *dapm,
1024                                    enum snd_soc_bias_level level);
1025
1026         int (*add_dai_link)(struct snd_soc_card *,
1027                             struct snd_soc_dai_link *link);
1028         void (*remove_dai_link)(struct snd_soc_card *,
1029                             struct snd_soc_dai_link *link);
1030
1031         long pmdown_time;
1032
1033         /* CPU <--> Codec DAI links  */
1034         struct snd_soc_dai_link *dai_link;  /* predefined links only */
1035         int num_links;  /* predefined links only */
1036
1037         struct list_head rtd_list;
1038         int num_rtd;
1039
1040         /* optional codec specific configuration */
1041         struct snd_soc_codec_conf *codec_conf;
1042         int num_configs;
1043
1044         /*
1045          * optional auxiliary devices such as amplifiers or codecs with DAI
1046          * link unused
1047          */
1048         struct snd_soc_aux_dev *aux_dev;
1049         int num_aux_devs;
1050         struct list_head aux_comp_list;
1051
1052         const struct snd_kcontrol_new *controls;
1053         int num_controls;
1054
1055         /*
1056          * Card-specific routes and widgets.
1057          * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1058          */
1059         const struct snd_soc_dapm_widget *dapm_widgets;
1060         int num_dapm_widgets;
1061         const struct snd_soc_dapm_route *dapm_routes;
1062         int num_dapm_routes;
1063         const struct snd_soc_dapm_widget *of_dapm_widgets;
1064         int num_of_dapm_widgets;
1065         const struct snd_soc_dapm_route *of_dapm_routes;
1066         int num_of_dapm_routes;
1067
1068         /* lists of probed devices belonging to this card */
1069         struct list_head component_dev_list;
1070         struct list_head list;
1071
1072         struct list_head widgets;
1073         struct list_head paths;
1074         struct list_head dapm_list;
1075         struct list_head dapm_dirty;
1076
1077         /* attached dynamic objects */
1078         struct list_head dobj_list;
1079
1080         /* Generic DAPM context for the card */
1081         struct snd_soc_dapm_context dapm;
1082         struct snd_soc_dapm_stats dapm_stats;
1083         struct snd_soc_dapm_update *update;
1084
1085 #ifdef CONFIG_DEBUG_FS
1086         struct dentry *debugfs_card_root;
1087 #endif
1088 #ifdef CONFIG_PM_SLEEP
1089         struct work_struct deferred_resume_work;
1090 #endif
1091         u32 pop_time;
1092
1093         /* bit field */
1094         unsigned int instantiated:1;
1095         unsigned int topology_shortname_created:1;
1096         unsigned int fully_routed:1;
1097         unsigned int disable_route_checks:1;
1098         unsigned int probed:1;
1099
1100         void *drvdata;
1101 };
1102 #define for_each_card_prelinks(card, i, link)                           \
1103         for ((i) = 0;                                                   \
1104              ((i) < (card)->num_links) && ((link) = &(card)->dai_link[i]); \
1105              (i)++)
1106 #define for_each_card_pre_auxs(card, i, aux)                            \
1107         for ((i) = 0;                                                   \
1108              ((i) < (card)->num_aux_devs) && ((aux) = &(card)->aux_dev[i]); \
1109              (i)++)
1110
1111 #define for_each_card_rtds(card, rtd)                   \
1112         list_for_each_entry(rtd, &(card)->rtd_list, list)
1113 #define for_each_card_rtds_safe(card, rtd, _rtd)        \
1114         list_for_each_entry_safe(rtd, _rtd, &(card)->rtd_list, list)
1115
1116 #define for_each_card_auxs(card, component)                     \
1117         list_for_each_entry(component, &card->aux_comp_list, card_aux_list)
1118 #define for_each_card_auxs_safe(card, component, _comp) \
1119         list_for_each_entry_safe(component, _comp,      \
1120                                  &card->aux_comp_list, card_aux_list)
1121
1122 #define for_each_card_components(card, component)                       \
1123         list_for_each_entry(component, &(card)->component_dev_list, card_list)
1124
1125 #define for_each_card_dapms(card, dapm)                                 \
1126         list_for_each_entry(dapm, &card->dapm_list, list)
1127
1128 #define for_each_card_widgets(card, w)\
1129         list_for_each_entry(w, &card->widgets, list)
1130 #define for_each_card_widgets_safe(card, w, _w) \
1131         list_for_each_entry_safe(w, _w, &card->widgets, list)
1132
1133 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1134 struct snd_soc_pcm_runtime {
1135         struct device *dev;
1136         struct snd_soc_card *card;
1137         struct snd_soc_dai_link *dai_link;
1138         struct snd_pcm_ops ops;
1139
1140         unsigned int params_select; /* currently selected param for dai link */
1141
1142         /* Dynamic PCM BE runtime data */
1143         struct snd_soc_dpcm_runtime dpcm[2];
1144
1145         long pmdown_time;
1146
1147         /* runtime devices */
1148         struct snd_pcm *pcm;
1149         struct snd_compr *compr;
1150
1151         /*
1152          * dais = cpu_dai + codec_dai
1153          * see
1154          *      soc_new_pcm_runtime()
1155          *      asoc_rtd_to_cpu()
1156          *      asoc_rtd_to_codec()
1157          */
1158         struct snd_soc_dai **dais;
1159         unsigned int num_codecs;
1160         unsigned int num_cpus;
1161
1162         struct snd_soc_dapm_widget *playback_widget;
1163         struct snd_soc_dapm_widget *capture_widget;
1164
1165         struct delayed_work delayed_work;
1166         void (*close_delayed_work_func)(struct snd_soc_pcm_runtime *rtd);
1167 #ifdef CONFIG_DEBUG_FS
1168         struct dentry *debugfs_dpcm_root;
1169 #endif
1170
1171         unsigned int num; /* 0-based and monotonic increasing */
1172         struct list_head list; /* rtd list of the soc card */
1173
1174         /* bit field */
1175         unsigned int pop_wait:1;
1176         unsigned int fe_compr:1; /* for Dynamic PCM */
1177
1178         int num_components;
1179         struct snd_soc_component *components[]; /* CPU/Codec/Platform */
1180 };
1181 /* see soc_new_pcm_runtime()  */
1182 #define asoc_rtd_to_cpu(rtd, n)   (rtd)->dais[n]
1183 #define asoc_rtd_to_codec(rtd, n) (rtd)->dais[n + (rtd)->num_cpus]
1184
1185 #define for_each_rtd_components(rtd, i, component)                      \
1186         for ((i) = 0, component = NULL;                                 \
1187              ((i) < rtd->num_components) && ((component) = rtd->components[i]);\
1188              (i)++)
1189 #define for_each_rtd_cpu_dais(rtd, i, dai)                              \
1190         for ((i) = 0;                                                   \
1191              ((i) < rtd->num_cpus) && ((dai) = asoc_rtd_to_cpu(rtd, i)); \
1192              (i)++)
1193 #define for_each_rtd_cpu_dais_rollback(rtd, i, dai)             \
1194         for (; (--(i) >= 0) && ((dai) = asoc_rtd_to_cpu(rtd, i));)
1195 #define for_each_rtd_codec_dais(rtd, i, dai)                            \
1196         for ((i) = 0;                                                   \
1197              ((i) < rtd->num_codecs) && ((dai) = asoc_rtd_to_codec(rtd, i)); \
1198              (i)++)
1199 #define for_each_rtd_codec_dais_rollback(rtd, i, dai)           \
1200         for (; (--(i) >= 0) && ((dai) = asoc_rtd_to_codec(rtd, i));)
1201 #define for_each_rtd_dais(rtd, i, dai)                                  \
1202         for ((i) = 0;                                                   \
1203              ((i) < (rtd)->num_cpus + (rtd)->num_codecs) &&             \
1204                      ((dai) = (rtd)->dais[i]);                          \
1205              (i)++)
1206
1207 void snd_soc_close_delayed_work(struct snd_soc_pcm_runtime *rtd);
1208
1209 /* mixer control */
1210 struct soc_mixer_control {
1211         int min, max, platform_max;
1212         int reg, rreg;
1213         unsigned int shift, rshift;
1214         unsigned int sign_bit;
1215         unsigned int invert:1;
1216         unsigned int autodisable:1;
1217 #ifdef CONFIG_SND_SOC_TOPOLOGY
1218         struct snd_soc_dobj dobj;
1219 #endif
1220 };
1221
1222 struct soc_bytes {
1223         int base;
1224         int num_regs;
1225         u32 mask;
1226 };
1227
1228 struct soc_bytes_ext {
1229         int max;
1230 #ifdef CONFIG_SND_SOC_TOPOLOGY
1231         struct snd_soc_dobj dobj;
1232 #endif
1233         /* used for TLV byte control */
1234         int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1235                         unsigned int size);
1236         int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1237                         unsigned int size);
1238 };
1239
1240 /* multi register control */
1241 struct soc_mreg_control {
1242         long min, max;
1243         unsigned int regbase, regcount, nbits, invert;
1244 };
1245
1246 /* enumerated kcontrol */
1247 struct soc_enum {
1248         int reg;
1249         unsigned char shift_l;
1250         unsigned char shift_r;
1251         unsigned int items;
1252         unsigned int mask;
1253         const char * const *texts;
1254         const unsigned int *values;
1255         unsigned int autodisable:1;
1256 #ifdef CONFIG_SND_SOC_TOPOLOGY
1257         struct snd_soc_dobj dobj;
1258 #endif
1259 };
1260
1261 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1262 {
1263         if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1264                 return false;
1265         /*
1266          * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1267          * mc->reg != mc->rreg means that the control is
1268          * stereo (bits in one register or in two registers)
1269          */
1270         return true;
1271 }
1272
1273 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1274         unsigned int val)
1275 {
1276         unsigned int i;
1277
1278         if (!e->values)
1279                 return val;
1280
1281         for (i = 0; i < e->items; i++)
1282                 if (val == e->values[i])
1283                         return i;
1284
1285         return 0;
1286 }
1287
1288 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1289         unsigned int item)
1290 {
1291         if (!e->values)
1292                 return item;
1293
1294         return e->values[item];
1295 }
1296
1297 /**
1298  * snd_soc_kcontrol_component() - Returns the component that registered the
1299  *  control
1300  * @kcontrol: The control for which to get the component
1301  *
1302  * Note: This function will work correctly if the control has been registered
1303  * for a component. With snd_soc_add_codec_controls() or via table based
1304  * setup for either a CODEC or component driver. Otherwise the behavior is
1305  * undefined.
1306  */
1307 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1308         struct snd_kcontrol *kcontrol)
1309 {
1310         return snd_kcontrol_chip(kcontrol);
1311 }
1312
1313 int snd_soc_util_init(void);
1314 void snd_soc_util_exit(void);
1315
1316 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1317                                const char *propname);
1318 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1319                                           const char *propname);
1320 int snd_soc_of_get_slot_mask(struct device_node *np,
1321                              const char *prop_name,
1322                              unsigned int *mask);
1323 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1324                               unsigned int *tx_mask,
1325                               unsigned int *rx_mask,
1326                               unsigned int *slots,
1327                               unsigned int *slot_width);
1328 void snd_soc_of_parse_node_prefix(struct device_node *np,
1329                                    struct snd_soc_codec_conf *codec_conf,
1330                                    struct device_node *of_node,
1331                                    const char *propname);
1332 static inline
1333 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1334                                    struct snd_soc_codec_conf *codec_conf,
1335                                    struct device_node *of_node,
1336                                    const char *propname)
1337 {
1338         snd_soc_of_parse_node_prefix(card->dev->of_node,
1339                                      codec_conf, of_node, propname);
1340 }
1341
1342 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1343                                    const char *propname);
1344 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1345                                      const char *prefix,
1346                                      struct device_node **bitclkmaster,
1347                                      struct device_node **framemaster);
1348 int snd_soc_get_dai_id(struct device_node *ep);
1349 int snd_soc_get_dai_name(struct of_phandle_args *args,
1350                          const char **dai_name);
1351 int snd_soc_of_get_dai_name(struct device_node *of_node,
1352                             const char **dai_name);
1353 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1354                                    struct device_node *of_node,
1355                                    struct snd_soc_dai_link *dai_link);
1356 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link);
1357
1358 int snd_soc_add_pcm_runtime(struct snd_soc_card *card,
1359                             struct snd_soc_dai_link *dai_link);
1360 void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
1361                                 struct snd_soc_pcm_runtime *rtd);
1362
1363 struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
1364                                          struct snd_soc_dai_driver *dai_drv,
1365                                          bool legacy_dai_naming);
1366 struct snd_soc_dai *devm_snd_soc_register_dai(struct device *dev,
1367                                               struct snd_soc_component *component,
1368                                               struct snd_soc_dai_driver *dai_drv,
1369                                               bool legacy_dai_naming);
1370 void snd_soc_unregister_dai(struct snd_soc_dai *dai);
1371
1372 struct snd_soc_dai *snd_soc_find_dai(
1373         const struct snd_soc_dai_link_component *dlc);
1374
1375 #include <sound/soc-dai.h>
1376
1377 static inline
1378 int snd_soc_fixup_dai_links_platform_name(struct snd_soc_card *card,
1379                                           const char *platform_name)
1380 {
1381         struct snd_soc_dai_link *dai_link;
1382         const char *name;
1383         int i;
1384
1385         if (!platform_name) /* nothing to do */
1386                 return 0;
1387
1388         /* set platform name for each dailink */
1389         for_each_card_prelinks(card, i, dai_link) {
1390                 name = devm_kstrdup(card->dev, platform_name, GFP_KERNEL);
1391                 if (!name)
1392                         return -ENOMEM;
1393
1394                 if (!dai_link->platforms)
1395                         return -EINVAL;
1396
1397                 /* only single platform is supported for now */
1398                 dai_link->platforms->name = name;
1399         }
1400
1401         return 0;
1402 }
1403
1404 #ifdef CONFIG_DEBUG_FS
1405 extern struct dentry *snd_soc_debugfs_root;
1406 #endif
1407
1408 extern const struct dev_pm_ops snd_soc_pm_ops;
1409
1410 /* Helper functions */
1411 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1412 {
1413         mutex_lock_nested(&dapm->card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
1414 }
1415
1416 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1417 {
1418         mutex_unlock(&dapm->card->dapm_mutex);
1419 }
1420
1421 #include <sound/soc-component.h>
1422 #include <sound/soc-card.h>
1423
1424 #endif