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