include/sound/soc.h

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