include/sound/soc.h

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