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