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 int snd_soc_suspend(struct device *dev);
 391 int snd_soc_resume(struct device *dev);
 392 int snd_soc_poweroff(struct device *dev);
 393 int snd_soc_register_platform(struct device *dev,
 394                 const struct snd_soc_platform_driver *platform_drv);
 395 int devm_snd_soc_register_platform(struct device *dev,
 396                 const struct snd_soc_platform_driver *platform_drv);
 397 void snd_soc_unregister_platform(struct device *dev);
 398 int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
 399                 const struct snd_soc_platform_driver *platform_drv);
 400 void snd_soc_remove_platform(struct snd_soc_platform *platform);
 401 struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev);
 402 int snd_soc_register_codec(struct device *dev,
 403                 const struct snd_soc_codec_driver *codec_drv,
 404                 struct snd_soc_dai_driver *dai_drv, int num_dai);
 405 void snd_soc_unregister_codec(struct device *dev);
 406 int 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 int devm_snd_soc_register_component(struct device *dev,
 410                          const struct snd_soc_component_driver *cmpnt_drv,
 411                          struct snd_soc_dai_driver *dai_drv, int num_dai);
 412 void snd_soc_unregister_component(struct device *dev);
 413 int snd_soc_cache_init(struct snd_soc_codec *codec);
 414 int snd_soc_cache_exit(struct snd_soc_codec *codec);
 415
 416 int snd_soc_platform_read(struct snd_soc_platform *platform,
 417                                         unsigned int reg);
 418 int snd_soc_platform_write(struct snd_soc_platform *platform,
 419                                         unsigned int reg, unsigned int val);
 420 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
 421 int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
 422
 423 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
 424                 const char *dai_link, int stream);
 425 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
 426                 const char *dai_link);
 427
 428 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
 429 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
 430 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
 431
 432 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
 433         unsigned int dai_fmt);
 434
 435 /* Utility functions to get clock rates from various things */
 436 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 437 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 438 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 439 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 440
 441 /* set runtime hw params */
 442 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 443         const struct snd_pcm_hardware *hw);
 444
 445 int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
 446                 int cmd, struct snd_soc_platform *platform);
 447
 448 int soc_dai_hw_params(struct snd_pcm_substream *substream,
 449                       struct snd_pcm_hw_params *params,
 450                       struct snd_soc_dai *dai);
 451
 452 /* Jack reporting */
 453 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
 454                      struct snd_soc_jack *jack);
 455 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 456 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 457                           struct snd_soc_jack_pin *pins);
 458 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
 459                                     struct notifier_block *nb);
 460 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
 461                                       struct notifier_block *nb);
 462 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
 463                           struct snd_soc_jack_zone *zones);
 464 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
 465 #ifdef CONFIG_GPIOLIB
 466 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 467                         struct snd_soc_jack_gpio *gpios);
 468 int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
 469                             struct snd_soc_jack *jack,
 470                             int count, struct snd_soc_jack_gpio *gpios);
 471 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 472                         struct snd_soc_jack_gpio *gpios);
 473 #else
 474 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 475                                          struct snd_soc_jack_gpio *gpios)
 476 {
 477         return 0;
 478 }
 479
 480 static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
 481                                           struct snd_soc_jack *jack,
 482                                           int count,
 483                                           struct snd_soc_jack_gpio *gpios)
 484 {
 485         return 0;
 486 }
 487
 488 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 489                                            struct snd_soc_jack_gpio *gpios)
 490 {
 491 }
 492 #endif
 493
 494 /* codec register bit access */
 495 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned int reg,
 496                                 unsigned int mask, unsigned int value);
 497 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
 498                                unsigned int reg, unsigned int mask,
 499                                unsigned int value);
 500 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned int reg,
 501                                 unsigned int mask, unsigned int value);
 502
 503 #ifdef CONFIG_SND_SOC_AC97_BUS
 504 struct snd_ac97 *snd_soc_alloc_ac97_codec(struct snd_soc_codec *codec);
 505 struct snd_ac97 *snd_soc_new_ac97_codec(struct snd_soc_codec *codec);
 506 void snd_soc_free_ac97_codec(struct snd_ac97 *ac97);
 507
 508 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
 509 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 510                 struct platform_device *pdev);
 511
 512 extern struct snd_ac97_bus_ops *soc_ac97_ops;
 513 #else
 514 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 515         struct platform_device *pdev)
 516 {
 517         return 0;
 518 }
 519
 520 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
 521 {
 522         return 0;
 523 }
 524 #endif
 525
 526 /*
 527  *Controls
 528  */
 529 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 530                                   void *data, const char *long_name,
 531                                   const char *prefix);
 532 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
 533                                                const char *name);
 534 int snd_soc_add_component_controls(struct snd_soc_component *component,
 535         const struct snd_kcontrol_new *controls, unsigned int num_controls);
 536 int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
 537         const struct snd_kcontrol_new *controls, unsigned int num_controls);
 538 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
 539         const struct snd_kcontrol_new *controls, unsigned int num_controls);
 540 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
 541         const struct snd_kcontrol_new *controls, int num_controls);
 542 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
 543         const struct snd_kcontrol_new *controls, int num_controls);
 544 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 545         struct snd_ctl_elem_info *uinfo);
 546 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 547         struct snd_ctl_elem_value *ucontrol);
 548 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 549         struct snd_ctl_elem_value *ucontrol);
 550 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 551         struct snd_ctl_elem_info *uinfo);
 552 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 553 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 554         struct snd_ctl_elem_value *ucontrol);
 555 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 556         struct snd_ctl_elem_value *ucontrol);
 557 #define snd_soc_get_volsw_2r snd_soc_get_volsw
 558 #define snd_soc_put_volsw_2r snd_soc_put_volsw
 559 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
 560         struct snd_ctl_elem_value *ucontrol);
 561 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
 562         struct snd_ctl_elem_value *ucontrol);
 563 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
 564         struct snd_ctl_elem_info *uinfo);
 565 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
 566         struct snd_ctl_elem_value *ucontrol);
 567 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
 568         struct snd_ctl_elem_value *ucontrol);
 569 int snd_soc_limit_volume(struct snd_soc_codec *codec,
 570         const char *name, int max);
 571 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
 572                        struct snd_ctl_elem_info *uinfo);
 573 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
 574                       struct snd_ctl_elem_value *ucontrol);
 575 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
 576                       struct snd_ctl_elem_value *ucontrol);
 577 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
 578         struct snd_ctl_elem_info *ucontrol);
 579 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
 580         unsigned int size, unsigned int __user *tlv);
 581 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
 582         struct snd_ctl_elem_info *uinfo);
 583 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
 584         struct snd_ctl_elem_value *ucontrol);
 585 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
 586         struct snd_ctl_elem_value *ucontrol);
 587 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
 588         struct snd_ctl_elem_value *ucontrol);
 589 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
 590         struct snd_ctl_elem_value *ucontrol);
 591
 592 /**
 593  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 594  *
 595  * @pin:    name of the pin to update
 596  * @mask:   bits to check for in reported jack status
 597  * @invert: if non-zero then pin is enabled when status is not reported
 598  */
 599 struct snd_soc_jack_pin {
 600         struct list_head list;
 601         const char *pin;
 602         int mask;
 603         bool invert;
 604 };
 605
 606 /**
 607  * struct snd_soc_jack_zone - Describes voltage zones of jack detection
 608  *
 609  * @min_mv: start voltage in mv
 610  * @max_mv: end voltage in mv
 611  * @jack_type: type of jack that is expected for this voltage
 612  * @debounce_time: debounce_time for jack, codec driver should wait for this
 613  *              duration before reading the adc for voltages
 614  * @:list: list container
 615  */
 616 struct snd_soc_jack_zone {
 617         unsigned int min_mv;
 618         unsigned int max_mv;
 619         unsigned int jack_type;
 620         unsigned int debounce_time;
 621         struct list_head list;
 622 };
 623
 624 /**
 625  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 626  *
 627  * @gpio:         legacy gpio number
 628  * @idx:          gpio descriptor index within the function of the GPIO
 629  *                consumer device
 630  * @gpiod_dev     GPIO consumer device
 631  * @name:         gpio name. Also as connection ID for the GPIO consumer
 632  *                device function name lookup
 633  * @report:       value to report when jack detected
 634  * @invert:       report presence in low state
 635  * @debouce_time: debouce time in ms
 636  * @wake:         enable as wake source
 637  * @jack_status_check: callback function which overrides the detection
 638  *                     to provide more complex checks (eg, reading an
 639  *                     ADC).
 640  */
 641 struct snd_soc_jack_gpio {
 642         unsigned int gpio;
 643         unsigned int idx;
 644         struct device *gpiod_dev;
 645         const char *name;
 646         int report;
 647         int invert;
 648         int debounce_time;
 649         bool wake;
 650
 651         struct snd_soc_jack *jack;
 652         struct delayed_work work;
 653         struct gpio_desc *desc;
 654
 655         void *data;
 656         int (*jack_status_check)(void *data);
 657 };
 658
 659 struct snd_soc_jack {
 660         struct mutex mutex;
 661         struct snd_jack *jack;
 662         struct snd_soc_codec *codec;
 663         struct list_head pins;
 664         int status;
 665         struct blocking_notifier_head notifier;
 666         struct list_head jack_zones;
 667 };
 668
 669 /* SoC PCM stream information */
 670 struct snd_soc_pcm_stream {
 671         const char *stream_name;
 672         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 673         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 674         unsigned int rate_min;          /* min rate */
 675         unsigned int rate_max;          /* max rate */
 676         unsigned int channels_min;      /* min channels */
 677         unsigned int channels_max;      /* max channels */
 678         unsigned int sig_bits;          /* number of bits of content */
 679 };
 680
 681 /* SoC audio ops */
 682 struct snd_soc_ops {
 683         int (*startup)(struct snd_pcm_substream *);
 684         void (*shutdown)(struct snd_pcm_substream *);
 685         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 686         int (*hw_free)(struct snd_pcm_substream *);
 687         int (*prepare)(struct snd_pcm_substream *);
 688         int (*trigger)(struct snd_pcm_substream *, int);
 689 };
 690
 691 struct snd_soc_compr_ops {
 692         int (*startup)(struct snd_compr_stream *);
 693         void (*shutdown)(struct snd_compr_stream *);
 694         int (*set_params)(struct snd_compr_stream *);
 695         int (*trigger)(struct snd_compr_stream *);
 696 };
 697
 698 /* component interface */
 699 struct snd_soc_component_driver {
 700         const char *name;
 701
 702         /* Default control and setup, added after probe() is run */
 703         const struct snd_kcontrol_new *controls;
 704         unsigned int num_controls;
 705         const struct snd_soc_dapm_widget *dapm_widgets;
 706         unsigned int num_dapm_widgets;
 707         const struct snd_soc_dapm_route *dapm_routes;
 708         unsigned int num_dapm_routes;
 709
 710         int (*probe)(struct snd_soc_component *);
 711         void (*remove)(struct snd_soc_component *);
 712
 713         /* DT */
 714         int (*of_xlate_dai_name)(struct snd_soc_component *component,
 715                                  struct of_phandle_args *args,
 716                                  const char **dai_name);
 717         void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type,
 718                 int subseq);
 719         int (*stream_event)(struct snd_soc_component *, int event);
 720
 721         /* probe ordering - for components with runtime dependencies */
 722         int probe_order;
 723         int remove_order;
 724 };
 725
 726 struct snd_soc_component {
 727         const char *name;
 728         int id;
 729         const char *name_prefix;
 730         struct device *dev;
 731         struct snd_soc_card *card;
 732
 733         unsigned int active;
 734
 735         unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
 736         unsigned int registered_as_component:1;
 737         unsigned int probed:1;
 738
 739         struct list_head list;
 740
 741         struct snd_soc_dai_driver *dai_drv;
 742         int num_dai;
 743
 744         const struct snd_soc_component_driver *driver;
 745
 746         struct list_head dai_list;
 747
 748         int (*read)(struct snd_soc_component *, unsigned int, unsigned int *);
 749         int (*write)(struct snd_soc_component *, unsigned int, unsigned int);
 750
 751         struct regmap *regmap;
 752         int val_bytes;
 753
 754         struct mutex io_mutex;
 755
 756 #ifdef CONFIG_DEBUG_FS
 757         struct dentry *debugfs_root;
 758 #endif
 759
 760         /*
 761         * DO NOT use any of the fields below in drivers, they are temporary and
 762         * are going to be removed again soon. If you use them in driver code the
 763         * driver will be marked as BROKEN when these fields are removed.
 764         */
 765
 766         /* Don't use these, use snd_soc_component_get_dapm() */
 767         struct snd_soc_dapm_context dapm;
 768         struct snd_soc_dapm_context *dapm_ptr;
 769
 770         const struct snd_kcontrol_new *controls;
 771         unsigned int num_controls;
 772         const struct snd_soc_dapm_widget *dapm_widgets;
 773         unsigned int num_dapm_widgets;
 774         const struct snd_soc_dapm_route *dapm_routes;
 775         unsigned int num_dapm_routes;
 776         struct snd_soc_codec *codec;
 777
 778         int (*probe)(struct snd_soc_component *);
 779         void (*remove)(struct snd_soc_component *);
 780
 781 #ifdef CONFIG_DEBUG_FS
 782         void (*init_debugfs)(struct snd_soc_component *component);
 783         const char *debugfs_prefix;
 784 #endif
 785 };
 786
 787 /* SoC Audio Codec device */
 788 struct snd_soc_codec {
 789         struct device *dev;
 790         const struct snd_soc_codec_driver *driver;
 791
 792         struct list_head list;
 793         struct list_head card_list;
 794
 795         /* runtime */
 796         unsigned int cache_bypass:1; /* Suppress access to the cache */
 797         unsigned int suspended:1; /* Codec is in suspend PM state */
 798         unsigned int cache_init:1; /* codec cache has been initialized */
 799
 800         /* codec IO */
 801         void *control_data; /* codec control (i2c/3wire) data */
 802         hw_write_t hw_write;
 803         void *reg_cache;
 804
 805         /* component */
 806         struct snd_soc_component component;
 807
 808         /* dapm */
 809         struct snd_soc_dapm_context dapm;
 810
 811 #ifdef CONFIG_DEBUG_FS
 812         struct dentry *debugfs_reg;
 813 #endif
 814 };
 815
 816 /* codec driver */
 817 struct snd_soc_codec_driver {
 818
 819         /* driver ops */
 820         int (*probe)(struct snd_soc_codec *);
 821         int (*remove)(struct snd_soc_codec *);
 822         int (*suspend)(struct snd_soc_codec *);
 823         int (*resume)(struct snd_soc_codec *);
 824         struct snd_soc_component_driver component_driver;
 825
 826         /* Default control and setup, added after probe() is run */
 827         const struct snd_kcontrol_new *controls;
 828         int num_controls;
 829         const struct snd_soc_dapm_widget *dapm_widgets;
 830         int num_dapm_widgets;
 831         const struct snd_soc_dapm_route *dapm_routes;
 832         int num_dapm_routes;
 833
 834         /* codec wide operations */
 835         int (*set_sysclk)(struct snd_soc_codec *codec,
 836                           int clk_id, int source, unsigned int freq, int dir);
 837         int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
 838                 unsigned int freq_in, unsigned int freq_out);
 839
 840         /* codec IO */
 841         struct regmap *(*get_regmap)(struct device *);
 842         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 843         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 844         unsigned int reg_cache_size;
 845         short reg_cache_step;
 846         short reg_word_size;
 847         const void *reg_cache_default;
 848
 849         /* codec bias level */
 850         int (*set_bias_level)(struct snd_soc_codec *,
 851                               enum snd_soc_bias_level level);
 852         bool idle_bias_off;
 853         bool suspend_bias_off;
 854
 855         void (*seq_notifier)(struct snd_soc_dapm_context *,
 856                              enum snd_soc_dapm_type, int);
 857
 858         bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */
 859 };
 860
 861 /* SoC platform interface */
 862 struct snd_soc_platform_driver {
 863
 864         int (*probe)(struct snd_soc_platform *);
 865         int (*remove)(struct snd_soc_platform *);
 866         struct snd_soc_component_driver component_driver;
 867
 868         /* pcm creation and destruction */
 869         int (*pcm_new)(struct snd_soc_pcm_runtime *);
 870         void (*pcm_free)(struct snd_pcm *);
 871
 872         /*
 873          * For platform caused delay reporting.
 874          * Optional.
 875          */
 876         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 877                 struct snd_soc_dai *);
 878
 879         /* platform stream pcm ops */
 880         const struct snd_pcm_ops *ops;
 881
 882         /* platform stream compress ops */
 883         const struct snd_compr_ops *compr_ops;
 884
 885         int (*bespoke_trigger)(struct snd_pcm_substream *, int);
 886 };
 887
 888 struct snd_soc_dai_link_component {
 889         const char *name;
 890         struct device_node *of_node;
 891         const char *dai_name;
 892 };
 893
 894 struct snd_soc_platform {
 895         struct device *dev;
 896         const struct snd_soc_platform_driver *driver;
 897
 898         struct list_head list;
 899
 900         struct snd_soc_component component;
 901 };
 902
 903 struct snd_soc_dai_link {
 904         /* config - must be set by machine driver */
 905         const char *name;                       /* Codec name */
 906         const char *stream_name;                /* Stream name */
 907         /*
 908          * You MAY specify the link's CPU-side device, either by device name,
 909          * or by DT/OF node, but not both. If this information is omitted,
 910          * the CPU-side DAI is matched using .cpu_dai_name only, which hence
 911          * must be globally unique. These fields are currently typically used
 912          * only for codec to codec links, or systems using device tree.
 913          */
 914         const char *cpu_name;
 915         struct device_node *cpu_of_node;
 916         /*
 917          * You MAY specify the DAI name of the CPU DAI. If this information is
 918          * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
 919          * only, which only works well when that device exposes a single DAI.
 920          */
 921         const char *cpu_dai_name;
 922         /*
 923          * You MUST specify the link's codec, either by device name, or by
 924          * DT/OF node, but not both.
 925          */
 926         const char *codec_name;
 927         struct device_node *codec_of_node;
 928         /* You MUST specify the DAI name within the codec */
 929         const char *codec_dai_name;
 930
 931         struct snd_soc_dai_link_component *codecs;
 932         unsigned int num_codecs;
 933
 934         /*
 935          * You MAY specify the link's platform/PCM/DMA driver, either by
 936          * device name, or by DT/OF node, but not both. Some forms of link
 937          * do not need a platform.
 938          */
 939         const char *platform_name;
 940         struct device_node *platform_of_node;
 941         int be_id;      /* optional ID for machine driver BE identification */
 942
 943         const struct snd_soc_pcm_stream *params;
 944
 945         unsigned int dai_fmt;           /* format to set on init */
 946
 947         enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
 948
 949         /* Keep DAI active over suspend */
 950         unsigned int ignore_suspend:1;
 951
 952         /* Symmetry requirements */
 953         unsigned int symmetric_rates:1;
 954         unsigned int symmetric_channels:1;
 955         unsigned int symmetric_samplebits:1;
 956
 957         /* Do not create a PCM for this DAI link (Backend link) */
 958         unsigned int no_pcm:1;
 959
 960         /* This DAI link can route to other DAI links at runtime (Frontend)*/
 961         unsigned int dynamic:1;
 962
 963         /* DPCM capture and Playback support */
 964         unsigned int dpcm_capture:1;
 965         unsigned int dpcm_playback:1;
 966
 967         /* pmdown_time is ignored at stop */
 968         unsigned int ignore_pmdown_time:1;
 969
 970         /* codec/machine specific init - e.g. add machine controls */
 971         int (*init)(struct snd_soc_pcm_runtime *rtd);
 972
 973         /* optional hw_params re-writing for BE and FE sync */
 974         int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
 975                         struct snd_pcm_hw_params *params);
 976
 977         /* machine stream operations */
 978         const struct snd_soc_ops *ops;
 979         const struct snd_soc_compr_ops *compr_ops;
 980
 981         /* For unidirectional dai links */
 982         bool playback_only;
 983         bool capture_only;
 984 };
 985
 986 struct snd_soc_codec_conf {
 987         /*
 988          * specify device either by device name, or by
 989          * DT/OF node, but not both.
 990          */
 991         const char *dev_name;
 992         struct device_node *of_node;
 993
 994         /*
 995          * optional map of kcontrol, widget and path name prefixes that are
 996          * associated per device
 997          */
 998         const char *name_prefix;
 999 };
1000
1001 struct snd_soc_aux_dev {
1002         const char *name;               /* Codec name */
1003
1004         /*
1005          * specify multi-codec either by device name, or by
1006          * DT/OF node, but not both.
1007          */
1008         const char *codec_name;
1009         struct device_node *codec_of_node;
1010
1011         /* codec/machine specific init - e.g. add machine controls */
1012         int (*init)(struct snd_soc_component *component);
1013 };
1014
1015 /* SoC card */
1016 struct snd_soc_card {
1017         const char *name;
1018         const char *long_name;
1019         const char *driver_name;
1020         struct device *dev;
1021         struct snd_card *snd_card;
1022         struct module *owner;
1023
1024         struct mutex mutex;
1025         struct mutex dapm_mutex;
1026
1027         bool instantiated;
1028
1029         int (*probe)(struct snd_soc_card *card);
1030         int (*late_probe)(struct snd_soc_card *card);
1031         int (*remove)(struct snd_soc_card *card);
1032
1033         /* the pre and post PM functions are used to do any PM work before and
1034          * after the codec and DAI's do any PM work. */
1035         int (*suspend_pre)(struct snd_soc_card *card);
1036         int (*suspend_post)(struct snd_soc_card *card);
1037         int (*resume_pre)(struct snd_soc_card *card);
1038         int (*resume_post)(struct snd_soc_card *card);
1039
1040         /* callbacks */
1041         int (*set_bias_level)(struct snd_soc_card *,
1042                               struct snd_soc_dapm_context *dapm,
1043                               enum snd_soc_bias_level level);
1044         int (*set_bias_level_post)(struct snd_soc_card *,
1045                                    struct snd_soc_dapm_context *dapm,
1046                                    enum snd_soc_bias_level level);
1047
1048         long pmdown_time;
1049
1050         /* CPU <--> Codec DAI links  */
1051         struct snd_soc_dai_link *dai_link;
1052         int num_links;
1053         struct snd_soc_pcm_runtime *rtd;
1054         int num_rtd;
1055
1056         /* optional codec specific configuration */
1057         struct snd_soc_codec_conf *codec_conf;
1058         int num_configs;
1059
1060         /*
1061          * optional auxiliary devices such as amplifiers or codecs with DAI
1062          * link unused
1063          */
1064         struct snd_soc_aux_dev *aux_dev;
1065         int num_aux_devs;
1066         struct snd_soc_pcm_runtime *rtd_aux;
1067         int num_aux_rtd;
1068
1069         const struct snd_kcontrol_new *controls;
1070         int num_controls;
1071
1072         /*
1073          * Card-specific routes and widgets.
1074          */
1075         const struct snd_soc_dapm_widget *dapm_widgets;
1076         int num_dapm_widgets;
1077         const struct snd_soc_dapm_route *dapm_routes;
1078         int num_dapm_routes;
1079         bool fully_routed;
1080
1081         struct work_struct deferred_resume_work;
1082
1083         /* lists of probed devices belonging to this card */
1084         struct list_head codec_dev_list;
1085
1086         struct list_head widgets;
1087         struct list_head paths;
1088         struct list_head dapm_list;
1089         struct list_head dapm_dirty;
1090
1091         /* Generic DAPM context for the card */
1092         struct snd_soc_dapm_context dapm;
1093         struct snd_soc_dapm_stats dapm_stats;
1094         struct snd_soc_dapm_update *update;
1095
1096 #ifdef CONFIG_DEBUG_FS
1097         struct dentry *debugfs_card_root;
1098         struct dentry *debugfs_pop_time;
1099 #endif
1100         u32 pop_time;
1101
1102         void *drvdata;
1103 };
1104
1105 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1106 struct snd_soc_pcm_runtime {
1107         struct device *dev;
1108         struct snd_soc_card *card;
1109         struct snd_soc_dai_link *dai_link;
1110         struct mutex pcm_mutex;
1111         enum snd_soc_pcm_subclass pcm_subclass;
1112         struct snd_pcm_ops ops;
1113
1114         unsigned int dev_registered:1;
1115
1116         /* Dynamic PCM BE runtime data */
1117         struct snd_soc_dpcm_runtime dpcm[2];
1118         int fe_compr;
1119
1120         long pmdown_time;
1121         unsigned char pop_wait:1;
1122
1123         /* runtime devices */
1124         struct snd_pcm *pcm;
1125         struct snd_compr *compr;
1126         struct snd_soc_codec *codec;
1127         struct snd_soc_platform *platform;
1128         struct snd_soc_dai *codec_dai;
1129         struct snd_soc_dai *cpu_dai;
1130         struct snd_soc_component *component; /* Only valid for AUX dev rtds */
1131
1132         struct snd_soc_dai **codec_dais;
1133         unsigned int num_codecs;
1134
1135         struct delayed_work delayed_work;
1136 #ifdef CONFIG_DEBUG_FS
1137         struct dentry *debugfs_dpcm_root;
1138         struct dentry *debugfs_dpcm_state;
1139 #endif
1140 };
1141
1142 /* mixer control */
1143 struct soc_mixer_control {
1144         int min, max, platform_max;
1145         int reg, rreg;
1146         unsigned int shift, rshift;
1147         unsigned int sign_bit;
1148         unsigned int invert:1;
1149         unsigned int autodisable:1;
1150 };
1151
1152 struct soc_bytes {
1153         int base;
1154         int num_regs;
1155         u32 mask;
1156 };
1157
1158 struct soc_bytes_ext {
1159         int max;
1160         /* used for TLV byte control */
1161         int (*get)(unsigned int __user *bytes, unsigned int size);
1162         int (*put)(const unsigned int __user *bytes, unsigned int size);
1163 };
1164
1165 /* multi register control */
1166 struct soc_mreg_control {
1167         long min, max;
1168         unsigned int regbase, regcount, nbits, invert;
1169 };
1170
1171 /* enumerated kcontrol */
1172 struct soc_enum {
1173         int reg;
1174         unsigned char shift_l;
1175         unsigned char shift_r;
1176         unsigned int items;
1177         unsigned int mask;
1178         const char * const *texts;
1179         const unsigned int *values;
1180 };
1181
1182 /**
1183  * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1184  * @component: The component to cast to a CODEC
1185  *
1186  * This function must only be used on components that are known to be CODECs.
1187  * Otherwise the behavior is undefined.
1188  */
1189 static inline struct snd_soc_codec *snd_soc_component_to_codec(
1190         struct snd_soc_component *component)
1191 {
1192         return container_of(component, struct snd_soc_codec, component);
1193 }
1194
1195 /**
1196  * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1197  * @component: The component to cast to a platform
1198  *
1199  * This function must only be used on components that are known to be platforms.
1200  * Otherwise the behavior is undefined.
1201  */
1202 static inline struct snd_soc_platform *snd_soc_component_to_platform(
1203         struct snd_soc_component *component)
1204 {
1205         return container_of(component, struct snd_soc_platform, component);
1206 }
1207
1208 /**
1209  * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
1210  *  embedded in
1211  * @dapm: The DAPM context to cast to the component
1212  *
1213  * This function must only be used on DAPM contexts that are known to be part of
1214  * a component (e.g. in a component driver). Otherwise the behavior is
1215  * undefined.
1216  */
1217 static inline struct snd_soc_component *snd_soc_dapm_to_component(
1218         struct snd_soc_dapm_context *dapm)
1219 {
1220         return container_of(dapm, struct snd_soc_component, dapm);
1221 }
1222
1223 /**
1224  * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in
1225  * @dapm: The DAPM context to cast to the CODEC
1226  *
1227  * This function must only be used on DAPM contexts that are known to be part of
1228  * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1229  */
1230 static inline struct snd_soc_codec *snd_soc_dapm_to_codec(
1231         struct snd_soc_dapm_context *dapm)
1232 {
1233         return container_of(dapm, struct snd_soc_codec, dapm);
1234 }
1235
1236 /**
1237  * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is
1238  *  embedded in
1239  * @dapm: The DAPM context to cast to the platform.
1240  *
1241  * This function must only be used on DAPM contexts that are known to be part of
1242  * a platform (e.g. in a platform driver). Otherwise the behavior is undefined.
1243  */
1244 static inline struct snd_soc_platform *snd_soc_dapm_to_platform(
1245         struct snd_soc_dapm_context *dapm)
1246 {
1247         return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm));
1248 }
1249
1250 /**
1251  * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
1252  *  component
1253  * @component: The component for which to get the DAPM context
1254  */
1255 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
1256         struct snd_soc_component *component)
1257 {
1258         return component->dapm_ptr;
1259 }
1260
1261 /* codec IO */
1262 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1263 int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg,
1264         unsigned int val);
1265
1266 /**
1267  * snd_soc_cache_sync() - Sync the register cache with the hardware
1268  * @codec: CODEC to sync
1269  *
1270  * Note: This function will call regcache_sync()
1271  */
1272 static inline int snd_soc_cache_sync(struct snd_soc_codec *codec)
1273 {
1274         return regcache_sync(codec->component.regmap);
1275 }
1276
1277 /* component IO */
1278 int snd_soc_component_read(struct snd_soc_component *component,
1279         unsigned int reg, unsigned int *val);
1280 int snd_soc_component_write(struct snd_soc_component *component,
1281         unsigned int reg, unsigned int val);
1282 int snd_soc_component_update_bits(struct snd_soc_component *component,
1283         unsigned int reg, unsigned int mask, unsigned int val);
1284 int snd_soc_component_update_bits_async(struct snd_soc_component *component,
1285         unsigned int reg, unsigned int mask, unsigned int val);
1286 void snd_soc_component_async_complete(struct snd_soc_component *component);
1287 int snd_soc_component_test_bits(struct snd_soc_component *component,
1288         unsigned int reg, unsigned int mask, unsigned int value);
1289
1290 #ifdef CONFIG_REGMAP
1291
1292 void snd_soc_component_init_regmap(struct snd_soc_component *component,
1293         struct regmap *regmap);
1294 void snd_soc_component_exit_regmap(struct snd_soc_component *component);
1295
1296 /**
1297  * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC
1298  * @codec: The CODEC for which to initialize the regmap instance
1299  * @regmap: The regmap instance that should be used by the CODEC
1300  *
1301  * This function allows deferred assignment of the regmap instance that is
1302  * associated with the CODEC. Only use this if the regmap instance is not yet
1303  * ready when the CODEC is registered. The function must also be called before
1304  * the first IO attempt of the CODEC.
1305  */
1306 static inline void snd_soc_codec_init_regmap(struct snd_soc_codec *codec,
1307         struct regmap *regmap)
1308 {
1309         snd_soc_component_init_regmap(&codec->component, regmap);
1310 }
1311
1312 /**
1313  * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC
1314  * @codec: The CODEC for which to de-initialize the regmap instance
1315  *
1316  * Calls regmap_exit() on the regmap instance associated to the CODEC and
1317  * removes the regmap instance from the CODEC.
1318  *
1319  * This function should only be used if snd_soc_codec_init_regmap() was used to
1320  * initialize the regmap instance.
1321  */
1322 static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec *codec)
1323 {
1324         snd_soc_component_exit_regmap(&codec->component);
1325 }
1326
1327 #endif
1328
1329 /* device driver data */
1330
1331 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1332                 void *data)
1333 {
1334         card->drvdata = data;
1335 }
1336
1337 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1338 {
1339         return card->drvdata;
1340 }
1341
1342 static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
1343                 void *data)
1344 {
1345         dev_set_drvdata(c->dev, data);
1346 }
1347
1348 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
1349 {
1350         return dev_get_drvdata(c->dev);
1351 }
1352
1353 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1354                 void *data)
1355 {
1356         snd_soc_component_set_drvdata(&codec->component, data);
1357 }
1358
1359 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1360 {
1361         return snd_soc_component_get_drvdata(&codec->component);
1362 }
1363
1364 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1365                 void *data)
1366 {
1367         snd_soc_component_set_drvdata(&platform->component, data);
1368 }
1369
1370 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1371 {
1372         return snd_soc_component_get_drvdata(&platform->component);
1373 }
1374
1375 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1376                 void *data)
1377 {
1378         dev_set_drvdata(rtd->dev, data);
1379 }
1380
1381 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1382 {
1383         return dev_get_drvdata(rtd->dev);
1384 }
1385
1386 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1387 {
1388         INIT_LIST_HEAD(&card->codec_dev_list);
1389         INIT_LIST_HEAD(&card->widgets);
1390         INIT_LIST_HEAD(&card->paths);
1391         INIT_LIST_HEAD(&card->dapm_list);
1392 }
1393
1394 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1395 {
1396         if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1397                 return 0;
1398         /*
1399          * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1400          * mc->reg != mc->rreg means that the control is
1401          * stereo (bits in one register or in two registers)
1402          */
1403         return 1;
1404 }
1405
1406 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1407         unsigned int val)
1408 {
1409         unsigned int i;
1410
1411         if (!e->values)
1412                 return val;
1413
1414         for (i = 0; i < e->items; i++)
1415                 if (val == e->values[i])
1416                         return i;
1417
1418         return 0;
1419 }
1420
1421 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1422         unsigned int item)
1423 {
1424         if (!e->values)
1425                 return item;
1426
1427         return e->values[item];
1428 }
1429
1430 static inline bool snd_soc_component_is_active(
1431         struct snd_soc_component *component)
1432 {
1433         return component->active != 0;
1434 }
1435
1436 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1437 {
1438         return snd_soc_component_is_active(&codec->component);
1439 }
1440
1441 /**
1442  * snd_soc_kcontrol_component() - Returns the component that registered the
1443  *  control
1444  * @kcontrol: The control for which to get the component
1445  *
1446  * Note: This function will work correctly if the control has been registered
1447  * for a component. Either with snd_soc_add_codec_controls() or
1448  * snd_soc_add_platform_controls() or via  table based setup for either a
1449  * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1450  */
1451 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1452         struct snd_kcontrol *kcontrol)
1453 {
1454         return snd_kcontrol_chip(kcontrol);
1455 }
1456
1457 /**
1458  * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1459  * @kcontrol: The control for which to get the CODEC
1460  *
1461  * Note: This function will only work correctly if the control has been
1462  * registered with snd_soc_add_codec_controls() or via table based setup of
1463  * snd_soc_codec_driver. Otherwise the behavior is undefined.
1464  */
1465 static inline struct snd_soc_codec *snd_soc_kcontrol_codec(
1466         struct snd_kcontrol *kcontrol)
1467 {
1468         return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol));
1469 }
1470
1471 /**
1472  * snd_soc_kcontrol_platform() - Returns the platform that registerd the control
1473  * @kcontrol: The control for which to get the platform
1474  *
1475  * Note: This function will only work correctly if the control has been
1476  * registered with snd_soc_add_platform_controls() or via table based setup of
1477  * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1478  */
1479 static inline struct snd_soc_platform *snd_soc_kcontrol_platform(
1480         struct snd_kcontrol *kcontrol)
1481 {
1482         return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol));
1483 }
1484
1485 int snd_soc_util_init(void);
1486 void snd_soc_util_exit(void);
1487
1488 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1489                                const char *propname);
1490 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1491                                           const char *propname);
1492 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1493                               unsigned int *slots,
1494                               unsigned int *slot_width);
1495 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1496                                    const char *propname);
1497 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1498                                      const char *prefix,
1499                                      struct device_node **bitclkmaster,
1500                                      struct device_node **framemaster);
1501 int snd_soc_of_get_dai_name(struct device_node *of_node,
1502                             const char **dai_name);
1503 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1504                                    struct device_node *of_node,
1505                                    struct snd_soc_dai_link *dai_link);
1506
1507 #include <sound/soc-dai.h>
1508
1509 #ifdef CONFIG_DEBUG_FS
1510 extern struct dentry *snd_soc_debugfs_root;
1511 #endif
1512
1513 extern const struct dev_pm_ops snd_soc_pm_ops;
1514
1515 /* Helper functions */
1516 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1517 {
1518         mutex_lock(&dapm->card->dapm_mutex);
1519 }
1520
1521 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1522 {
1523         mutex_unlock(&dapm->card->dapm_mutex);
1524 }
1525
1526 #endif