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