include/sound/soc.h

   1 /*
   2  * linux/sound/soc.h -- ALSA SoC Layer
   3  *
   4  * Author:              Liam Girdwood
   5  * Created:             Aug 11th 2005
   6  * Copyright:   Wolfson Microelectronics. PLC.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  */
  12
  13 #ifndef __LINUX_SND_SOC_H
  14 #define __LINUX_SND_SOC_H
  15
  16 #include <linux/of.h>
  17 #include <linux/platform_device.h>
  18 #include <linux/types.h>
  19 #include <linux/notifier.h>
  20 #include <linux/workqueue.h>
  21 #include <linux/interrupt.h>
  22 #include <linux/kernel.h>
  23 #include <linux/regmap.h>
  24 #include <linux/log2.h>
  25 #include <sound/core.h>
  26 #include <sound/pcm.h>
  27 #include <sound/compress_driver.h>
  28 #include <sound/control.h>
  29 #include <sound/ac97_codec.h>
  30
  31 /*
  32  * Convenience kcontrol builders
  33  */
  34 #define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert, xautodisable) \
  35         ((unsigned long)&(struct soc_mixer_control) \
  36         {.reg = xreg, .rreg = xreg, .shift = shift_left, \
  37         .rshift = shift_right, .max = xmax, .platform_max = xmax, \
  38         .invert = xinvert, .autodisable = xautodisable})
  39 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \
  40         SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable)
  41 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
  42         ((unsigned long)&(struct soc_mixer_control) \
  43         {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
  44 #define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
  45         ((unsigned long)&(struct soc_mixer_control) \
  46         {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  47         .max = xmax, .platform_max = xmax, .invert = xinvert})
  48 #define SOC_DOUBLE_R_S_VALUE(xlreg, xrreg, xshift, xmin, xmax, xsign_bit, xinvert) \
  49         ((unsigned long)&(struct soc_mixer_control) \
  50         {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  51         .max = xmax, .min = xmin, .platform_max = xmax, .sign_bit = xsign_bit, \
  52         .invert = xinvert})
  53 #define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
  54         ((unsigned long)&(struct soc_mixer_control) \
  55         {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  56         .min = xmin, .max = xmax, .platform_max = xmax, .invert = xinvert})
  57 #define SOC_SINGLE(xname, reg, shift, max, invert) \
  58 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  59         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  60         .put = snd_soc_put_volsw, \
  61         .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
  62 #define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
  63 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  64         .info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
  65         .put = snd_soc_put_volsw_range, \
  66         .private_value = (unsigned long)&(struct soc_mixer_control) \
  67                 {.reg = xreg, .rreg = xreg, .shift = xshift, \
  68                  .rshift = xshift,  .min = xmin, .max = xmax, \
  69                  .platform_max = xmax, .invert = xinvert} }
  70 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
  71 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  72         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  73                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  74         .tlv.p = (tlv_array), \
  75         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  76         .put = snd_soc_put_volsw, \
  77         .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
  78 #define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
  79 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  80         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
  81         SNDRV_CTL_ELEM_ACCESS_READWRITE, \
  82         .tlv.p  = (tlv_array),\
  83         .info = snd_soc_info_volsw, \
  84         .get = snd_soc_get_volsw_sx,\
  85         .put = snd_soc_put_volsw_sx, \
  86         .private_value = (unsigned long)&(struct soc_mixer_control) \
  87                 {.reg = xreg, .rreg = xreg, \
  88                 .shift = xshift, .rshift = xshift, \
  89                 .max = xmax, .min = xmin} }
  90 #define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
  91 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  92         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  93                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  94         .tlv.p = (tlv_array), \
  95         .info = snd_soc_info_volsw_range, \
  96         .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
  97         .private_value = (unsigned long)&(struct soc_mixer_control) \
  98                 {.reg = xreg, .rreg = xreg, .shift = xshift, \
  99                  .rshift = xshift, .min = xmin, .max = xmax, \
 100                  .platform_max = xmax, .invert = xinvert} }
 101 #define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
 102 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 103         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
 104         .put = snd_soc_put_volsw, \
 105         .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
 106                                           max, invert, 0) }
 107 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
 108 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 109         .info = snd_soc_info_volsw, \
 110         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 111         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 112                                             xmax, xinvert) }
 113 #define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
 114                            xmax, xinvert)               \
 115 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 116         .info = snd_soc_info_volsw_range, \
 117         .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
 118         .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
 119                                             xshift, xmin, xmax, xinvert) }
 120 #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
 121 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 122         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 123                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 124         .tlv.p = (tlv_array), \
 125         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
 126         .put = snd_soc_put_volsw, \
 127         .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
 128                                           max, invert, 0) }
 129 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
 130 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 131         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 132                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 133         .tlv.p = (tlv_array), \
 134         .info = snd_soc_info_volsw, \
 135         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 136         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 137                                             xmax, xinvert) }
 138 #define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
 139                                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_range, \
 145         .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
 146         .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
 147                                             xshift, xmin, xmax, xinvert) }
 148 #define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
 149 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 150         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 151         SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 152         .tlv.p  = (tlv_array), \
 153         .info = snd_soc_info_volsw, \
 154         .get = snd_soc_get_volsw_sx, \
 155         .put = snd_soc_put_volsw_sx, \
 156         .private_value = (unsigned long)&(struct soc_mixer_control) \
 157                 {.reg = xreg, .rreg = xrreg, \
 158                 .shift = xshift, .rshift = xshift, \
 159                 .max = xmax, .min = xmin} }
 160 #define SOC_DOUBLE_R_S_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
 161 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 162         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 163                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 164         .tlv.p = (tlv_array), \
 165         .info = snd_soc_info_volsw, \
 166         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 167         .private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
 168                                             xmin, xmax, xsign_bit, xinvert) }
 169 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
 170 {       .iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 171         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 172                   SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 173         .tlv.p  = (tlv_array), \
 174         .info   = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
 175         .put    = snd_soc_put_volsw_s8, \
 176         .private_value = (unsigned long)&(struct soc_mixer_control) \
 177                 {.reg = xreg, .min = xmin, .max = xmax, \
 178                  .platform_max = xmax} }
 179 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \
 180 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 181         .items = xitems, .texts = xtexts, \
 182         .mask = xitems ? roundup_pow_of_two(xitems) - 1 : 0}
 183 #define SOC_ENUM_SINGLE(xreg, xshift, xitems, xtexts) \
 184         SOC_ENUM_DOUBLE(xreg, xshift, xshift, xitems, xtexts)
 185 #define SOC_ENUM_SINGLE_EXT(xitems, xtexts) \
 186 {       .items = xitems, .texts = xtexts }
 187 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xitems, xtexts, xvalues) \
 188 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 189         .mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues}
 190 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xnitmes, xtexts, xvalues) \
 191         SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xnitmes, xtexts, xvalues)
 192 #define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \
 193         SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
 194 #define SOC_ENUM(xname, xenum) \
 195 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
 196         .info = snd_soc_info_enum_double, \
 197         .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
 198         .private_value = (unsigned long)&xenum }
 199 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
 200          xhandler_get, xhandler_put) \
 201 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 202         .info = snd_soc_info_volsw, \
 203         .get = xhandler_get, .put = xhandler_put, \
 204         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
 205 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
 206          xhandler_get, xhandler_put) \
 207 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 208         .info = snd_soc_info_volsw, \
 209         .get = xhandler_get, .put = xhandler_put, \
 210         .private_value = \
 211                 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
 212 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
 213          xhandler_get, xhandler_put, tlv_array) \
 214 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 215         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 216                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 217         .tlv.p = (tlv_array), \
 218         .info = snd_soc_info_volsw, \
 219         .get = xhandler_get, .put = xhandler_put, \
 220         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
 221 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
 222          xhandler_get, xhandler_put, tlv_array) \
 223 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 224         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 225                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 226         .tlv.p = (tlv_array), \
 227         .info = snd_soc_info_volsw, \
 228         .get = xhandler_get, .put = xhandler_put, \
 229         .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
 230                                           xmax, xinvert, 0) }
 231 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
 232          xhandler_get, xhandler_put, tlv_array) \
 233 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 234         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 235                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 236         .tlv.p = (tlv_array), \
 237         .info = snd_soc_info_volsw, \
 238         .get = xhandler_get, .put = xhandler_put, \
 239         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 240                                             xmax, xinvert) }
 241 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
 242 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 243         .info = snd_soc_info_bool_ext, \
 244         .get = xhandler_get, .put = xhandler_put, \
 245         .private_value = xdata }
 246 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 247 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 248         .info = snd_soc_info_enum_double, \
 249         .get = xhandler_get, .put = xhandler_put, \
 250         .private_value = (unsigned long)&xenum }
 251 #define SOC_VALUE_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 252         SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put)
 253
 254 #define SND_SOC_BYTES(xname, xbase, xregs)                    \
 255 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
 256         .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
 257         .put = snd_soc_bytes_put, .private_value =            \
 258                 ((unsigned long)&(struct soc_bytes)           \
 259                 {.base = xbase, .num_regs = xregs }) }
 260
 261 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask)        \
 262 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
 263         .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
 264         .put = snd_soc_bytes_put, .private_value =            \
 265                 ((unsigned long)&(struct soc_bytes)           \
 266                 {.base = xbase, .num_regs = xregs,            \
 267                  .mask = xmask }) }
 268
 269 #define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \
 270 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 271         .info = snd_soc_bytes_info_ext, \
 272         .get = xhandler_get, .put = xhandler_put, \
 273         .private_value = (unsigned long)&(struct soc_bytes_ext) \
 274                 {.max = xcount} }
 275 #define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \
 276 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 277         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \
 278                   SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
 279         .tlv.c = (snd_soc_bytes_tlv_callback), \
 280         .info = snd_soc_bytes_info_ext, \
 281         .private_value = (unsigned long)&(struct soc_bytes_ext) \
 282                 {.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
 283 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
 284                 xmin, xmax, xinvert) \
 285 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 286         .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
 287         .put = snd_soc_put_xr_sx, \
 288         .private_value = (unsigned long)&(struct soc_mreg_control) \
 289                 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
 290                 .invert = xinvert, .min = xmin, .max = xmax} }
 291
 292 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
 293         SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
 294                 snd_soc_get_strobe, snd_soc_put_strobe)
 295
 296 /*
 297  * Simplified versions of above macros, declaring a struct and calculating
 298  * ARRAY_SIZE internally
 299  */
 300 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
 301         const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
 302                                                 ARRAY_SIZE(xtexts), xtexts)
 303 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
 304         SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
 305 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
 306         const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
 307 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
 308         const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
 309                                                         ARRAY_SIZE(xtexts), xtexts, xvalues)
 310 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
 311         SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
 312 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
 313         const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
 314
 315 /*
 316  * Component probe and remove ordering levels for components with runtime
 317  * dependencies.
 318  */
 319 #define SND_SOC_COMP_ORDER_FIRST                -2
 320 #define SND_SOC_COMP_ORDER_EARLY                -1
 321 #define SND_SOC_COMP_ORDER_NORMAL               0
 322 #define SND_SOC_COMP_ORDER_LATE         1
 323 #define SND_SOC_COMP_ORDER_LAST         2
 324
 325 /*
 326  * Bias levels
 327  *
 328  * @ON:      Bias is fully on for audio playback and capture operations.
 329  * @PREPARE: Prepare for audio operations. Called before DAPM switching for
 330  *           stream start and stop operations.
 331  * @STANDBY: Low power standby state when no playback/capture operations are
 332  *           in progress. NOTE: The transition time between STANDBY and ON
 333  *           should be as fast as possible and no longer than 10ms.
 334  * @OFF:     Power Off. No restrictions on transition times.
 335  */
 336 enum snd_soc_bias_level {
 337         SND_SOC_BIAS_OFF = 0,
 338         SND_SOC_BIAS_STANDBY = 1,
 339         SND_SOC_BIAS_PREPARE = 2,
 340         SND_SOC_BIAS_ON = 3,
 341 };
 342
 343 struct device_node;
 344 struct snd_jack;
 345 struct snd_soc_card;
 346 struct snd_soc_pcm_stream;
 347 struct snd_soc_ops;
 348 struct snd_soc_pcm_runtime;
 349 struct snd_soc_dai;
 350 struct snd_soc_dai_driver;
 351 struct snd_soc_platform;
 352 struct snd_soc_dai_link;
 353 struct snd_soc_platform_driver;
 354 struct snd_soc_codec;
 355 struct snd_soc_codec_driver;
 356 struct snd_soc_component;
 357 struct snd_soc_component_driver;
 358 struct soc_enum;
 359 struct snd_soc_jack;
 360 struct snd_soc_jack_zone;
 361 struct snd_soc_jack_pin;
 362 #include <sound/soc-dapm.h>
 363 #include <sound/soc-dpcm.h>
 364
 365 struct snd_soc_jack_gpio;
 366
 367 typedef int (*hw_write_t)(void *,const char* ,int);
 368
 369 enum snd_soc_pcm_subclass {
 370         SND_SOC_PCM_CLASS_PCM   = 0,
 371         SND_SOC_PCM_CLASS_BE    = 1,
 372 };
 373
 374 enum snd_soc_card_subclass {
 375         SND_SOC_CARD_CLASS_INIT         = 0,
 376         SND_SOC_CARD_CLASS_RUNTIME      = 1,
 377 };
 378
 379 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
 380                              int source, unsigned int freq, int dir);
 381 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
 382                           unsigned int freq_in, unsigned int freq_out);
 383
 384 int snd_soc_register_card(struct snd_soc_card *card);
 385 int snd_soc_unregister_card(struct snd_soc_card *card);
 386 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
 387 int snd_soc_suspend(struct device *dev);
 388 int snd_soc_resume(struct device *dev);
 389 int snd_soc_poweroff(struct device *dev);
 390 int snd_soc_register_platform(struct device *dev,
 391                 const struct snd_soc_platform_driver *platform_drv);
 392 int devm_snd_soc_register_platform(struct device *dev,
 393                 const struct snd_soc_platform_driver *platform_drv);
 394 void snd_soc_unregister_platform(struct device *dev);
 395 int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
 396                 const struct snd_soc_platform_driver *platform_drv);
 397 void snd_soc_remove_platform(struct snd_soc_platform *platform);
 398 struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev);
 399 int snd_soc_register_codec(struct device *dev,
 400                 const struct snd_soc_codec_driver *codec_drv,
 401                 struct snd_soc_dai_driver *dai_drv, int num_dai);
 402 void snd_soc_unregister_codec(struct device *dev);
 403 int snd_soc_register_component(struct device *dev,
 404                          const struct snd_soc_component_driver *cmpnt_drv,
 405                          struct snd_soc_dai_driver *dai_drv, int num_dai);
 406 int devm_snd_soc_register_component(struct device *dev,
 407                          const struct snd_soc_component_driver *cmpnt_drv,
 408                          struct snd_soc_dai_driver *dai_drv, int num_dai);
 409 void snd_soc_unregister_component(struct device *dev);
 410 int snd_soc_cache_sync(struct snd_soc_codec *codec);
 411 int snd_soc_cache_init(struct snd_soc_codec *codec);
 412 int snd_soc_cache_exit(struct snd_soc_codec *codec);
 413 int snd_soc_cache_write(struct snd_soc_codec *codec,
 414                         unsigned int reg, unsigned int value);
 415 int snd_soc_cache_read(struct snd_soc_codec *codec,
 416                        unsigned int reg, unsigned int *value);
 417 int snd_soc_platform_read(struct snd_soc_platform *platform,
 418                                         unsigned int reg);
 419 int snd_soc_platform_write(struct snd_soc_platform *platform,
 420                                         unsigned int reg, unsigned int val);
 421 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
 422 int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
 423
 424 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
 425                 const char *dai_link, int stream);
 426 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
 427                 const char *dai_link);
 428
 429 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
 430 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
 431 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
 432
 433 /* Utility functions to get clock rates from various things */
 434 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 435 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 436 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 437 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 438
 439 /* set runtime hw params */
 440 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 441         const struct snd_pcm_hardware *hw);
 442
 443 int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
 444                 int cmd, struct snd_soc_platform *platform);
 445
 446 int soc_dai_hw_params(struct snd_pcm_substream *substream,
 447                       struct snd_pcm_hw_params *params,
 448                       struct snd_soc_dai *dai);
 449
 450 /* Jack reporting */
 451 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
 452                      struct snd_soc_jack *jack);
 453 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 454 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 455                           struct snd_soc_jack_pin *pins);
 456 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
 457                                     struct notifier_block *nb);
 458 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
 459                                       struct notifier_block *nb);
 460 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
 461                           struct snd_soc_jack_zone *zones);
 462 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
 463 #ifdef CONFIG_GPIOLIB
 464 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 465                         struct snd_soc_jack_gpio *gpios);
 466 int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
 467                             struct snd_soc_jack *jack,
 468                             int count, struct snd_soc_jack_gpio *gpios);
 469 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 470                         struct snd_soc_jack_gpio *gpios);
 471 #else
 472 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 473                                          struct snd_soc_jack_gpio *gpios)
 474 {
 475         return 0;
 476 }
 477
 478 static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
 479                                           struct snd_soc_jack *jack,
 480                                           int count,
 481                                           struct snd_soc_jack_gpio *gpios)
 482 {
 483         return 0;
 484 }
 485
 486 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 487                                            struct snd_soc_jack_gpio *gpios)
 488 {
 489 }
 490 #endif
 491
 492 /* codec register bit access */
 493 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned int reg,
 494                                 unsigned int mask, unsigned int value);
 495 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
 496                                unsigned int reg, unsigned int mask,
 497                                unsigned int value);
 498 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned int reg,
 499                                 unsigned int mask, unsigned int value);
 500
 501 #ifdef CONFIG_SND_SOC_AC97_BUS
 502 struct snd_ac97 *snd_soc_new_ac97_codec(struct snd_soc_codec *codec);
 503 void snd_soc_free_ac97_codec(struct snd_ac97 *ac97);
 504
 505 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
 506 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 507                 struct platform_device *pdev);
 508
 509 extern struct snd_ac97_bus_ops *soc_ac97_ops;
 510 #else
 511 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 512         struct platform_device *pdev)
 513 {
 514         return 0;
 515 }
 516
 517 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
 518 {
 519         return 0;
 520 }
 521 #endif
 522
 523 /*
 524  *Controls
 525  */
 526 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 527                                   void *data, const char *long_name,
 528                                   const char *prefix);
 529 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
 530                                                const char *name);
 531 int snd_soc_add_component_controls(struct snd_soc_component *component,
 532         const struct snd_kcontrol_new *controls, unsigned int num_controls);
 533 int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
 534         const struct snd_kcontrol_new *controls, unsigned int num_controls);
 535 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
 536         const struct snd_kcontrol_new *controls, unsigned int num_controls);
 537 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
 538         const struct snd_kcontrol_new *controls, int num_controls);
 539 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
 540         const struct snd_kcontrol_new *controls, int num_controls);
 541 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 542         struct snd_ctl_elem_info *uinfo);
 543 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 544         struct snd_ctl_elem_value *ucontrol);
 545 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 546         struct snd_ctl_elem_value *ucontrol);
 547 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 548         struct snd_ctl_elem_info *uinfo);
 549 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 550 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 551         struct snd_ctl_elem_value *ucontrol);
 552 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 553         struct snd_ctl_elem_value *ucontrol);
 554 #define snd_soc_get_volsw_2r snd_soc_get_volsw
 555 #define snd_soc_put_volsw_2r snd_soc_put_volsw
 556 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
 557         struct snd_ctl_elem_value *ucontrol);
 558 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
 559         struct snd_ctl_elem_value *ucontrol);
 560 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
 561         struct snd_ctl_elem_info *uinfo);
 562 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
 563         struct snd_ctl_elem_value *ucontrol);
 564 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
 565         struct snd_ctl_elem_value *ucontrol);
 566 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
 567         struct snd_ctl_elem_info *uinfo);
 568 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
 569         struct snd_ctl_elem_value *ucontrol);
 570 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
 571         struct snd_ctl_elem_value *ucontrol);
 572 int snd_soc_limit_volume(struct snd_soc_codec *codec,
 573         const char *name, int max);
 574 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
 575                        struct snd_ctl_elem_info *uinfo);
 576 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
 577                       struct snd_ctl_elem_value *ucontrol);
 578 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
 579                       struct snd_ctl_elem_value *ucontrol);
 580 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
 581         struct snd_ctl_elem_info *ucontrol);
 582 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
 583         unsigned int size, unsigned int __user *tlv);
 584 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
 585         struct snd_ctl_elem_info *uinfo);
 586 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
 587         struct snd_ctl_elem_value *ucontrol);
 588 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
 589         struct snd_ctl_elem_value *ucontrol);
 590 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
 591         struct snd_ctl_elem_value *ucontrol);
 592 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
 593         struct snd_ctl_elem_value *ucontrol);
 594
 595 /**
 596  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 597  *
 598  * @pin:    name of the pin to update
 599  * @mask:   bits to check for in reported jack status
 600  * @invert: if non-zero then pin is enabled when status is not reported
 601  */
 602 struct snd_soc_jack_pin {
 603         struct list_head list;
 604         const char *pin;
 605         int mask;
 606         bool invert;
 607 };
 608
 609 /**
 610  * struct snd_soc_jack_zone - Describes voltage zones of jack detection
 611  *
 612  * @min_mv: start voltage in mv
 613  * @max_mv: end voltage in mv
 614  * @jack_type: type of jack that is expected for this voltage
 615  * @debounce_time: debounce_time for jack, codec driver should wait for this
 616  *              duration before reading the adc for voltages
 617  * @:list: list container
 618  */
 619 struct snd_soc_jack_zone {
 620         unsigned int min_mv;
 621         unsigned int max_mv;
 622         unsigned int jack_type;
 623         unsigned int debounce_time;
 624         struct list_head list;
 625 };
 626
 627 /**
 628  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 629  *
 630  * @gpio:         legacy gpio number
 631  * @idx:          gpio descriptor index within the function of the GPIO
 632  *                consumer device
 633  * @gpiod_dev     GPIO consumer device
 634  * @name:         gpio name. Also as connection ID for the GPIO consumer
 635  *                device function name lookup
 636  * @report:       value to report when jack detected
 637  * @invert:       report presence in low state
 638  * @debouce_time: debouce time in ms
 639  * @wake:         enable as wake source
 640  * @jack_status_check: callback function which overrides the detection
 641  *                     to provide more complex checks (eg, reading an
 642  *                     ADC).
 643  */
 644 struct snd_soc_jack_gpio {
 645         unsigned int gpio;
 646         unsigned int idx;
 647         struct device *gpiod_dev;
 648         const char *name;
 649         int report;
 650         int invert;
 651         int debounce_time;
 652         bool wake;
 653
 654         struct snd_soc_jack *jack;
 655         struct delayed_work work;
 656         struct gpio_desc *desc;
 657
 658         void *data;
 659         int (*jack_status_check)(void *data);
 660 };
 661
 662 struct snd_soc_jack {
 663         struct mutex mutex;
 664         struct snd_jack *jack;
 665         struct snd_soc_codec *codec;
 666         struct list_head pins;
 667         int status;
 668         struct blocking_notifier_head notifier;
 669         struct list_head jack_zones;
 670 };
 671
 672 /* SoC PCM stream information */
 673 struct snd_soc_pcm_stream {
 674         const char *stream_name;
 675         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 676         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 677         unsigned int rate_min;          /* min rate */
 678         unsigned int rate_max;          /* max rate */
 679         unsigned int channels_min;      /* min channels */
 680         unsigned int channels_max;      /* max channels */
 681         unsigned int sig_bits;          /* number of bits of content */
 682 };
 683
 684 /* SoC audio ops */
 685 struct snd_soc_ops {
 686         int (*startup)(struct snd_pcm_substream *);
 687         void (*shutdown)(struct snd_pcm_substream *);
 688         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 689         int (*hw_free)(struct snd_pcm_substream *);
 690         int (*prepare)(struct snd_pcm_substream *);
 691         int (*trigger)(struct snd_pcm_substream *, int);
 692 };
 693
 694 struct snd_soc_compr_ops {
 695         int (*startup)(struct snd_compr_stream *);
 696         void (*shutdown)(struct snd_compr_stream *);
 697         int (*set_params)(struct snd_compr_stream *);
 698         int (*trigger)(struct snd_compr_stream *);
 699 };
 700
 701 /* component interface */
 702 struct snd_soc_component_driver {
 703         const char *name;
 704
 705         /* Default control and setup, added after probe() is run */
 706         const struct snd_kcontrol_new *controls;
 707         unsigned int num_controls;
 708         const struct snd_soc_dapm_widget *dapm_widgets;
 709         unsigned int num_dapm_widgets;
 710         const struct snd_soc_dapm_route *dapm_routes;
 711         unsigned int num_dapm_routes;
 712
 713         int (*probe)(struct snd_soc_component *);
 714         void (*remove)(struct snd_soc_component *);
 715
 716         /* DT */
 717         int (*of_xlate_dai_name)(struct snd_soc_component *component,
 718                                  struct of_phandle_args *args,
 719                                  const char **dai_name);
 720         void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type,
 721                 int subseq);
 722         int (*stream_event)(struct snd_soc_component *, int event);
 723
 724         /* probe ordering - for components with runtime dependencies */
 725         int probe_order;
 726         int remove_order;
 727 };
 728
 729 struct snd_soc_component {
 730         const char *name;
 731         int id;
 732         const char *name_prefix;
 733         struct device *dev;
 734         struct snd_soc_card *card;
 735
 736         unsigned int active;
 737
 738         unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
 739         unsigned int registered_as_component:1;
 740         unsigned int probed:1;
 741
 742         struct list_head list;
 743
 744         struct snd_soc_dai_driver *dai_drv;
 745         int num_dai;
 746
 747         const struct snd_soc_component_driver *driver;
 748
 749         struct list_head dai_list;
 750
 751         int (*read)(struct snd_soc_component *, unsigned int, unsigned int *);
 752         int (*write)(struct snd_soc_component *, unsigned int, unsigned int);
 753
 754         struct regmap *regmap;
 755         int val_bytes;
 756
 757         struct mutex io_mutex;
 758
 759 #ifdef CONFIG_DEBUG_FS
 760         struct dentry *debugfs_root;
 761 #endif
 762
 763         /*
 764         * DO NOT use any of the fields below in drivers, they are temporary and
 765         * are going to be removed again soon. If you use them in driver code the
 766         * driver will be marked as BROKEN when these fields are removed.
 767         */
 768
 769         /* Don't use these, use snd_soc_component_get_dapm() */
 770         struct snd_soc_dapm_context dapm;
 771         struct snd_soc_dapm_context *dapm_ptr;
 772
 773         const struct snd_kcontrol_new *controls;
 774         unsigned int num_controls;
 775         const struct snd_soc_dapm_widget *dapm_widgets;
 776         unsigned int num_dapm_widgets;
 777         const struct snd_soc_dapm_route *dapm_routes;
 778         unsigned int num_dapm_routes;
 779         struct snd_soc_codec *codec;
 780
 781         int (*probe)(struct snd_soc_component *);
 782         void (*remove)(struct snd_soc_component *);
 783
 784 #ifdef CONFIG_DEBUG_FS
 785         void (*init_debugfs)(struct snd_soc_component *component);
 786         const char *debugfs_prefix;
 787 #endif
 788 };
 789
 790 /* SoC Audio Codec device */
 791 struct snd_soc_codec {
 792         struct device *dev;
 793         const struct snd_soc_codec_driver *driver;
 794
 795         struct mutex mutex;
 796         struct list_head list;
 797         struct list_head card_list;
 798
 799         /* runtime */
 800         unsigned int cache_bypass:1; /* Suppress access to the cache */
 801         unsigned int suspended:1; /* Codec is in suspend PM state */
 802         unsigned int cache_init:1; /* codec cache has been initialized */
 803         u32 cache_sync; /* Cache needs to be synced to hardware */
 804
 805         /* codec IO */
 806         void *control_data; /* codec control (i2c/3wire) data */
 807         hw_write_t hw_write;
 808         void *reg_cache;
 809         struct mutex cache_rw_mutex;
 810
 811         /* component */
 812         struct snd_soc_component component;
 813
 814         /* dapm */
 815         struct snd_soc_dapm_context dapm;
 816
 817 #ifdef CONFIG_DEBUG_FS
 818         struct dentry *debugfs_reg;
 819 #endif
 820 };
 821
 822 /* codec driver */
 823 struct snd_soc_codec_driver {
 824
 825         /* driver ops */
 826         int (*probe)(struct snd_soc_codec *);
 827         int (*remove)(struct snd_soc_codec *);
 828         int (*suspend)(struct snd_soc_codec *);
 829         int (*resume)(struct snd_soc_codec *);
 830         struct snd_soc_component_driver component_driver;
 831
 832         /* Default control and setup, added after probe() is run */
 833         const struct snd_kcontrol_new *controls;
 834         int num_controls;
 835         const struct snd_soc_dapm_widget *dapm_widgets;
 836         int num_dapm_widgets;
 837         const struct snd_soc_dapm_route *dapm_routes;
 838         int num_dapm_routes;
 839
 840         /* codec wide operations */
 841         int (*set_sysclk)(struct snd_soc_codec *codec,
 842                           int clk_id, int source, unsigned int freq, int dir);
 843         int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
 844                 unsigned int freq_in, unsigned int freq_out);
 845
 846         /* codec IO */
 847         struct regmap *(*get_regmap)(struct device *);
 848         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 849         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 850         unsigned int reg_cache_size;
 851         short reg_cache_step;
 852         short reg_word_size;
 853         const void *reg_cache_default;
 854
 855         /* codec bias level */
 856         int (*set_bias_level)(struct snd_soc_codec *,
 857                               enum snd_soc_bias_level level);
 858         bool idle_bias_off;
 859         bool suspend_bias_off;
 860
 861         void (*seq_notifier)(struct snd_soc_dapm_context *,
 862                              enum snd_soc_dapm_type, int);
 863
 864         bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */
 865 };
 866
 867 /* SoC platform interface */
 868 struct snd_soc_platform_driver {
 869
 870         int (*probe)(struct snd_soc_platform *);
 871         int (*remove)(struct snd_soc_platform *);
 872         int (*suspend)(struct snd_soc_dai *dai);
 873         int (*resume)(struct snd_soc_dai *dai);
 874         struct snd_soc_component_driver component_driver;
 875
 876         /* pcm creation and destruction */
 877         int (*pcm_new)(struct snd_soc_pcm_runtime *);
 878         void (*pcm_free)(struct snd_pcm *);
 879
 880         /*
 881          * For platform caused delay reporting.
 882          * Optional.
 883          */
 884         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 885                 struct snd_soc_dai *);
 886
 887         /* platform stream pcm ops */
 888         const struct snd_pcm_ops *ops;
 889
 890         /* platform stream compress ops */
 891         const struct snd_compr_ops *compr_ops;
 892
 893         int (*bespoke_trigger)(struct snd_pcm_substream *, int);
 894 };
 895
 896 struct snd_soc_dai_link_component {
 897         const char *name;
 898         const struct device_node *of_node;
 899         const char *dai_name;
 900 };
 901
 902 struct snd_soc_platform {
 903         struct device *dev;
 904         const struct snd_soc_platform_driver *driver;
 905
 906         unsigned int suspended:1; /* platform is suspended */
 907
 908         struct list_head list;
 909
 910         struct snd_soc_component component;
 911 };
 912
 913 struct snd_soc_dai_link {
 914         /* config - must be set by machine driver */
 915         const char *name;                       /* Codec name */
 916         const char *stream_name;                /* Stream name */
 917         /*
 918          * You MAY specify the link's CPU-side device, either by device name,
 919          * or by DT/OF node, but not both. If this information is omitted,
 920          * the CPU-side DAI is matched using .cpu_dai_name only, which hence
 921          * must be globally unique. These fields are currently typically used
 922          * only for codec to codec links, or systems using device tree.
 923          */
 924         const char *cpu_name;
 925         struct device_node *cpu_of_node;
 926         /*
 927          * You MAY specify the DAI name of the CPU DAI. If this information is
 928          * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
 929          * only, which only works well when that device exposes a single DAI.
 930          */
 931         const char *cpu_dai_name;
 932         /*
 933          * You MUST specify the link's codec, either by device name, or by
 934          * DT/OF node, but not both.
 935          */
 936         const char *codec_name;
 937         struct device_node *codec_of_node;
 938         /* You MUST specify the DAI name within the codec */
 939         const char *codec_dai_name;
 940
 941         struct snd_soc_dai_link_component *codecs;
 942         unsigned int num_codecs;
 943
 944         /*
 945          * You MAY specify the link's platform/PCM/DMA driver, either by
 946          * device name, or by DT/OF node, but not both. Some forms of link
 947          * do not need a platform.
 948          */
 949         const char *platform_name;
 950         struct device_node *platform_of_node;
 951         int be_id;      /* optional ID for machine driver BE identification */
 952
 953         const struct snd_soc_pcm_stream *params;
 954
 955         unsigned int dai_fmt;           /* format to set on init */
 956
 957         enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
 958
 959         /* Keep DAI active over suspend */
 960         unsigned int ignore_suspend:1;
 961
 962         /* Symmetry requirements */
 963         unsigned int symmetric_rates:1;
 964         unsigned int symmetric_channels:1;
 965         unsigned int symmetric_samplebits:1;
 966
 967         /* Do not create a PCM for this DAI link (Backend link) */
 968         unsigned int no_pcm:1;
 969
 970         /* This DAI link can route to other DAI links at runtime (Frontend)*/
 971         unsigned int dynamic:1;
 972
 973         /* DPCM capture and Playback support */
 974         unsigned int dpcm_capture:1;
 975         unsigned int dpcm_playback:1;
 976
 977         /* pmdown_time is ignored at stop */
 978         unsigned int ignore_pmdown_time:1;
 979
 980         /* codec/machine specific init - e.g. add machine controls */
 981         int (*init)(struct snd_soc_pcm_runtime *rtd);
 982
 983         /* optional hw_params re-writing for BE and FE sync */
 984         int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
 985                         struct snd_pcm_hw_params *params);
 986
 987         /* machine stream operations */
 988         const struct snd_soc_ops *ops;
 989         const struct snd_soc_compr_ops *compr_ops;
 990
 991         /* For unidirectional dai links */
 992         bool playback_only;
 993         bool capture_only;
 994 };
 995
 996 struct snd_soc_codec_conf {
 997         /*
 998          * specify device either by device name, or by
 999          * DT/OF node, but not both.
1000          */
1001         const char *dev_name;
1002         const struct device_node *of_node;
1003
1004         /*
1005          * optional map of kcontrol, widget and path name prefixes that are
1006          * associated per device
1007          */
1008         const char *name_prefix;
1009 };
1010
1011 struct snd_soc_aux_dev {
1012         const char *name;               /* Codec name */
1013
1014         /*
1015          * specify multi-codec either by device name, or by
1016          * DT/OF node, but not both.
1017          */
1018         const char *codec_name;
1019         const struct device_node *codec_of_node;
1020
1021         /* codec/machine specific init - e.g. add machine controls */
1022         int (*init)(struct snd_soc_component *component);
1023 };
1024
1025 /* SoC card */
1026 struct snd_soc_card {
1027         const char *name;
1028         const char *long_name;
1029         const char *driver_name;
1030         struct device *dev;
1031         struct snd_card *snd_card;
1032         struct module *owner;
1033
1034         struct mutex mutex;
1035         struct mutex dapm_mutex;
1036
1037         bool instantiated;
1038
1039         int (*probe)(struct snd_soc_card *card);
1040         int (*late_probe)(struct snd_soc_card *card);
1041         int (*remove)(struct snd_soc_card *card);
1042
1043         /* the pre and post PM functions are used to do any PM work before and
1044          * after the codec and DAI's do any PM work. */
1045         int (*suspend_pre)(struct snd_soc_card *card);
1046         int (*suspend_post)(struct snd_soc_card *card);
1047         int (*resume_pre)(struct snd_soc_card *card);
1048         int (*resume_post)(struct snd_soc_card *card);
1049
1050         /* callbacks */
1051         int (*set_bias_level)(struct snd_soc_card *,
1052                               struct snd_soc_dapm_context *dapm,
1053                               enum snd_soc_bias_level level);
1054         int (*set_bias_level_post)(struct snd_soc_card *,
1055                                    struct snd_soc_dapm_context *dapm,
1056                                    enum snd_soc_bias_level level);
1057
1058         long pmdown_time;
1059
1060         /* CPU <--> Codec DAI links  */
1061         struct snd_soc_dai_link *dai_link;
1062         int num_links;
1063         struct snd_soc_pcm_runtime *rtd;
1064         int num_rtd;
1065
1066         /* optional codec specific configuration */
1067         struct snd_soc_codec_conf *codec_conf;
1068         int num_configs;
1069
1070         /*
1071          * optional auxiliary devices such as amplifiers or codecs with DAI
1072          * link unused
1073          */
1074         struct snd_soc_aux_dev *aux_dev;
1075         int num_aux_devs;
1076         struct snd_soc_pcm_runtime *rtd_aux;
1077         int num_aux_rtd;
1078
1079         const struct snd_kcontrol_new *controls;
1080         int num_controls;
1081
1082         /*
1083          * Card-specific routes and widgets.
1084          */
1085         const struct snd_soc_dapm_widget *dapm_widgets;
1086         int num_dapm_widgets;
1087         const struct snd_soc_dapm_route *dapm_routes;
1088         int num_dapm_routes;
1089         bool fully_routed;
1090
1091         struct work_struct deferred_resume_work;
1092
1093         /* lists of probed devices belonging to this card */
1094         struct list_head codec_dev_list;
1095
1096         struct list_head widgets;
1097         struct list_head paths;
1098         struct list_head dapm_list;
1099         struct list_head dapm_dirty;
1100
1101         /* Generic DAPM context for the card */
1102         struct snd_soc_dapm_context dapm;
1103         struct snd_soc_dapm_stats dapm_stats;
1104         struct snd_soc_dapm_update *update;
1105
1106 #ifdef CONFIG_DEBUG_FS
1107         struct dentry *debugfs_card_root;
1108         struct dentry *debugfs_pop_time;
1109 #endif
1110         u32 pop_time;
1111
1112         void *drvdata;
1113 };
1114
1115 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1116 struct snd_soc_pcm_runtime {
1117         struct device *dev;
1118         struct snd_soc_card *card;
1119         struct snd_soc_dai_link *dai_link;
1120         struct mutex pcm_mutex;
1121         enum snd_soc_pcm_subclass pcm_subclass;
1122         struct snd_pcm_ops ops;
1123
1124         unsigned int dev_registered:1;
1125
1126         /* Dynamic PCM BE runtime data */
1127         struct snd_soc_dpcm_runtime dpcm[2];
1128         int fe_compr;
1129
1130         long pmdown_time;
1131         unsigned char pop_wait:1;
1132
1133         /* runtime devices */
1134         struct snd_pcm *pcm;
1135         struct snd_compr *compr;
1136         struct snd_soc_codec *codec;
1137         struct snd_soc_platform *platform;
1138         struct snd_soc_dai *codec_dai;
1139         struct snd_soc_dai *cpu_dai;
1140         struct snd_soc_component *component; /* Only valid for AUX dev rtds */
1141
1142         struct snd_soc_dai **codec_dais;
1143         unsigned int num_codecs;
1144
1145         struct delayed_work delayed_work;
1146 #ifdef CONFIG_DEBUG_FS
1147         struct dentry *debugfs_dpcm_root;
1148         struct dentry *debugfs_dpcm_state;
1149 #endif
1150 };
1151
1152 /* mixer control */
1153 struct soc_mixer_control {
1154         int min, max, platform_max;
1155         int reg, rreg;
1156         unsigned int shift, rshift;
1157         unsigned int sign_bit;
1158         unsigned int invert:1;
1159         unsigned int autodisable:1;
1160 };
1161
1162 struct soc_bytes {
1163         int base;
1164         int num_regs;
1165         u32 mask;
1166 };
1167
1168 struct soc_bytes_ext {
1169         int max;
1170         /* used for TLV byte control */
1171         int (*get)(unsigned int __user *bytes, unsigned int size);
1172         int (*put)(const unsigned int __user *bytes, unsigned int size);
1173 };
1174
1175 /* multi register control */
1176 struct soc_mreg_control {
1177         long min, max;
1178         unsigned int regbase, regcount, nbits, invert;
1179 };
1180
1181 /* enumerated kcontrol */
1182 struct soc_enum {
1183         int reg;
1184         unsigned char shift_l;
1185         unsigned char shift_r;
1186         unsigned int items;
1187         unsigned int mask;
1188         const char * const *texts;
1189         const unsigned int *values;
1190 };
1191
1192 /**
1193  * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1194  * @component: The component to cast to a CODEC
1195  *
1196  * This function must only be used on components that are known to be CODECs.
1197  * Otherwise the behavior is undefined.
1198  */
1199 static inline struct snd_soc_codec *snd_soc_component_to_codec(
1200         struct snd_soc_component *component)
1201 {
1202         return container_of(component, struct snd_soc_codec, component);
1203 }
1204
1205 /**
1206  * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1207  * @component: The component to cast to a platform
1208  *
1209  * This function must only be used on components that are known to be platforms.
1210  * Otherwise the behavior is undefined.
1211  */
1212 static inline struct snd_soc_platform *snd_soc_component_to_platform(
1213         struct snd_soc_component *component)
1214 {
1215         return container_of(component, struct snd_soc_platform, component);
1216 }
1217
1218 /**
1219  * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
1220  *  embedded in
1221  * @dapm: The DAPM context to cast to the component
1222  *
1223  * This function must only be used on DAPM contexts that are known to be part of
1224  * a component (e.g. in a component driver). Otherwise the behavior is
1225  * undefined.
1226  */
1227 static inline struct snd_soc_component *snd_soc_dapm_to_component(
1228         struct snd_soc_dapm_context *dapm)
1229 {
1230         return container_of(dapm, struct snd_soc_component, dapm);
1231 }
1232
1233 /**
1234  * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in
1235  * @dapm: The DAPM context to cast to the CODEC
1236  *
1237  * This function must only be used on DAPM contexts that are known to be part of
1238  * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1239  */
1240 static inline struct snd_soc_codec *snd_soc_dapm_to_codec(
1241         struct snd_soc_dapm_context *dapm)
1242 {
1243         return container_of(dapm, struct snd_soc_codec, dapm);
1244 }
1245
1246 /**
1247  * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is
1248  *  embedded in
1249  * @dapm: The DAPM context to cast to the platform.
1250  *
1251  * This function must only be used on DAPM contexts that are known to be part of
1252  * a platform (e.g. in a platform driver). Otherwise the behavior is undefined.
1253  */
1254 static inline struct snd_soc_platform *snd_soc_dapm_to_platform(
1255         struct snd_soc_dapm_context *dapm)
1256 {
1257         return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm));
1258 }
1259
1260 /**
1261  * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
1262  *  component
1263  * @component: The component for which to get the DAPM context
1264  */
1265 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
1266         struct snd_soc_component *component)
1267 {
1268         return component->dapm_ptr;
1269 }
1270
1271 /* codec IO */
1272 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1273 int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg,
1274         unsigned int val);
1275
1276 /* component IO */
1277 int snd_soc_component_read(struct snd_soc_component *component,
1278         unsigned int reg, unsigned int *val);
1279 int snd_soc_component_write(struct snd_soc_component *component,
1280         unsigned int reg, unsigned int val);
1281 int snd_soc_component_update_bits(struct snd_soc_component *component,
1282         unsigned int reg, unsigned int mask, unsigned int val);
1283 int snd_soc_component_update_bits_async(struct snd_soc_component *component,
1284         unsigned int reg, unsigned int mask, unsigned int val);
1285 void snd_soc_component_async_complete(struct snd_soc_component *component);
1286 int snd_soc_component_test_bits(struct snd_soc_component *component,
1287         unsigned int reg, unsigned int mask, unsigned int value);
1288
1289 void snd_soc_component_init_regmap(struct snd_soc_component *component,
1290         struct regmap *regmap);
1291 void snd_soc_component_exit_regmap(struct snd_soc_component *component);
1292
1293 /**
1294  * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC
1295  * @codec: The CODEC for which to initialize the regmap instance
1296  * @regmap: The regmap instance that should be used by the CODEC
1297  *
1298  * This function allows deferred assignment of the regmap instance that is
1299  * associated with the CODEC. Only use this if the regmap instance is not yet
1300  * ready when the CODEC is registered. The function must also be called before
1301  * the first IO attempt of the CODEC.
1302  */
1303 static inline void snd_soc_codec_init_regmap(struct snd_soc_codec *codec,
1304         struct regmap *regmap)
1305 {
1306         snd_soc_component_init_regmap(&codec->component, regmap);
1307 }
1308
1309 /**
1310  * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC
1311  * @codec: The CODEC for which to de-initialize the regmap instance
1312  *
1313  * Calls regmap_exit() on the regmap instance associated to the CODEC and
1314  * removes the regmap instance from the CODEC.
1315  *
1316  * This function should only be used if snd_soc_codec_init_regmap() was used to
1317  * initialize the regmap instance.
1318  */
1319 static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec *codec)
1320 {
1321         snd_soc_component_exit_regmap(&codec->component);
1322 }
1323
1324 /* device driver data */
1325
1326 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1327                 void *data)
1328 {
1329         card->drvdata = data;
1330 }
1331
1332 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1333 {
1334         return card->drvdata;
1335 }
1336
1337 static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
1338                 void *data)
1339 {
1340         dev_set_drvdata(c->dev, data);
1341 }
1342
1343 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
1344 {
1345         return dev_get_drvdata(c->dev);
1346 }
1347
1348 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1349                 void *data)
1350 {
1351         snd_soc_component_set_drvdata(&codec->component, data);
1352 }
1353
1354 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1355 {
1356         return snd_soc_component_get_drvdata(&codec->component);
1357 }
1358
1359 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1360                 void *data)
1361 {
1362         snd_soc_component_set_drvdata(&platform->component, data);
1363 }
1364
1365 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1366 {
1367         return snd_soc_component_get_drvdata(&platform->component);
1368 }
1369
1370 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1371                 void *data)
1372 {
1373         dev_set_drvdata(rtd->dev, data);
1374 }
1375
1376 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1377 {
1378         return dev_get_drvdata(rtd->dev);
1379 }
1380
1381 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1382 {
1383         INIT_LIST_HEAD(&card->codec_dev_list);
1384         INIT_LIST_HEAD(&card->widgets);
1385         INIT_LIST_HEAD(&card->paths);
1386         INIT_LIST_HEAD(&card->dapm_list);
1387 }
1388
1389 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1390 {
1391         if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1392                 return 0;
1393         /*
1394          * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1395          * mc->reg != mc->rreg means that the control is
1396          * stereo (bits in one register or in two registers)
1397          */
1398         return 1;
1399 }
1400
1401 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1402         unsigned int val)
1403 {
1404         unsigned int i;
1405
1406         if (!e->values)
1407                 return val;
1408
1409         for (i = 0; i < e->items; i++)
1410                 if (val == e->values[i])
1411                         return i;
1412
1413         return 0;
1414 }
1415
1416 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1417         unsigned int item)
1418 {
1419         if (!e->values)
1420                 return item;
1421
1422         return e->values[item];
1423 }
1424
1425 static inline bool snd_soc_component_is_active(
1426         struct snd_soc_component *component)
1427 {
1428         return component->active != 0;
1429 }
1430
1431 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1432 {
1433         return snd_soc_component_is_active(&codec->component);
1434 }
1435
1436 /**
1437  * snd_soc_kcontrol_component() - Returns the component that registered the
1438  *  control
1439  * @kcontrol: The control for which to get the component
1440  *
1441  * Note: This function will work correctly if the control has been registered
1442  * for a component. Either with snd_soc_add_codec_controls() or
1443  * snd_soc_add_platform_controls() or via  table based setup for either a
1444  * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1445  */
1446 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1447         struct snd_kcontrol *kcontrol)
1448 {
1449         return snd_kcontrol_chip(kcontrol);
1450 }
1451
1452 /**
1453  * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1454  * @kcontrol: The control for which to get the CODEC
1455  *
1456  * Note: This function will only work correctly if the control has been
1457  * registered with snd_soc_add_codec_controls() or via table based setup of
1458  * snd_soc_codec_driver. Otherwise the behavior is undefined.
1459  */
1460 static inline struct snd_soc_codec *snd_soc_kcontrol_codec(
1461         struct snd_kcontrol *kcontrol)
1462 {
1463         return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol));
1464 }
1465
1466 /**
1467  * snd_soc_kcontrol_platform() - Returns the platform that registerd the control
1468  * @kcontrol: The control for which to get the platform
1469  *
1470  * Note: This function will only work correctly if the control has been
1471  * registered with snd_soc_add_platform_controls() or via table based setup of
1472  * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1473  */
1474 static inline struct snd_soc_platform *snd_soc_kcontrol_platform(
1475         struct snd_kcontrol *kcontrol)
1476 {
1477         return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol));
1478 }
1479
1480 int snd_soc_util_init(void);
1481 void snd_soc_util_exit(void);
1482
1483 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1484                                const char *propname);
1485 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1486                                           const char *propname);
1487 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1488                               unsigned int *slots,
1489                               unsigned int *slot_width);
1490 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1491                                    const char *propname);
1492 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1493                                      const char *prefix,
1494                                      struct device_node **bitclkmaster,
1495                                      struct device_node **framemaster);
1496 int snd_soc_of_get_dai_name(struct device_node *of_node,
1497                             const char **dai_name);
1498
1499 #include <sound/soc-dai.h>
1500
1501 #ifdef CONFIG_DEBUG_FS
1502 extern struct dentry *snd_soc_debugfs_root;
1503 #endif
1504
1505 extern const struct dev_pm_ops snd_soc_pm_ops;
1506
1507 /* Helper functions */
1508 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1509 {
1510         mutex_lock(&dapm->card->dapm_mutex);
1511 }
1512
1513 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1514 {
1515         mutex_unlock(&dapm->card->dapm_mutex);
1516 }
1517
1518 #endif