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_VALUE_ENUM(xname, xenum) \
 200         SOC_ENUM(xname, xenum)
 201 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
 202          xhandler_get, xhandler_put) \
 203 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 204         .info = snd_soc_info_volsw, \
 205         .get = xhandler_get, .put = xhandler_put, \
 206         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
 207 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
 208          xhandler_get, xhandler_put) \
 209 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 210         .info = snd_soc_info_volsw, \
 211         .get = xhandler_get, .put = xhandler_put, \
 212         .private_value = \
 213                 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
 214 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
 215          xhandler_get, xhandler_put, tlv_array) \
 216 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 217         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 218                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 219         .tlv.p = (tlv_array), \
 220         .info = snd_soc_info_volsw, \
 221         .get = xhandler_get, .put = xhandler_put, \
 222         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
 223 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
 224          xhandler_get, xhandler_put, tlv_array) \
 225 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 226         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 227                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 228         .tlv.p = (tlv_array), \
 229         .info = snd_soc_info_volsw, \
 230         .get = xhandler_get, .put = xhandler_put, \
 231         .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
 232                                           xmax, xinvert, 0) }
 233 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
 234          xhandler_get, xhandler_put, tlv_array) \
 235 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 236         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 237                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 238         .tlv.p = (tlv_array), \
 239         .info = snd_soc_info_volsw, \
 240         .get = xhandler_get, .put = xhandler_put, \
 241         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 242                                             xmax, xinvert) }
 243 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
 244 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 245         .info = snd_soc_info_bool_ext, \
 246         .get = xhandler_get, .put = xhandler_put, \
 247         .private_value = xdata }
 248 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 249 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 250         .info = snd_soc_info_enum_double, \
 251         .get = xhandler_get, .put = xhandler_put, \
 252         .private_value = (unsigned long)&xenum }
 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 SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
 270                 xmin, xmax, xinvert) \
 271 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 272         .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
 273         .put = snd_soc_put_xr_sx, \
 274         .private_value = (unsigned long)&(struct soc_mreg_control) \
 275                 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
 276                 .invert = xinvert, .min = xmin, .max = xmax} }
 277
 278 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
 279         SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
 280                 snd_soc_get_strobe, snd_soc_put_strobe)
 281
 282 /*
 283  * Simplified versions of above macros, declaring a struct and calculating
 284  * ARRAY_SIZE internally
 285  */
 286 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
 287         const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
 288                                                 ARRAY_SIZE(xtexts), xtexts)
 289 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
 290         SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
 291 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
 292         const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
 293 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
 294         const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
 295                                                         ARRAY_SIZE(xtexts), xtexts, xvalues)
 296 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
 297         SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
 298 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
 299         const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
 300
 301 /*
 302  * Component probe and remove ordering levels for components with runtime
 303  * dependencies.
 304  */
 305 #define SND_SOC_COMP_ORDER_FIRST                -2
 306 #define SND_SOC_COMP_ORDER_EARLY                -1
 307 #define SND_SOC_COMP_ORDER_NORMAL               0
 308 #define SND_SOC_COMP_ORDER_LATE         1
 309 #define SND_SOC_COMP_ORDER_LAST         2
 310
 311 /*
 312  * Bias levels
 313  *
 314  * @ON:      Bias is fully on for audio playback and capture operations.
 315  * @PREPARE: Prepare for audio operations. Called before DAPM switching for
 316  *           stream start and stop operations.
 317  * @STANDBY: Low power standby state when no playback/capture operations are
 318  *           in progress. NOTE: The transition time between STANDBY and ON
 319  *           should be as fast as possible and no longer than 10ms.
 320  * @OFF:     Power Off. No restrictions on transition times.
 321  */
 322 enum snd_soc_bias_level {
 323         SND_SOC_BIAS_OFF = 0,
 324         SND_SOC_BIAS_STANDBY = 1,
 325         SND_SOC_BIAS_PREPARE = 2,
 326         SND_SOC_BIAS_ON = 3,
 327 };
 328
 329 struct device_node;
 330 struct snd_jack;
 331 struct snd_soc_card;
 332 struct snd_soc_pcm_stream;
 333 struct snd_soc_ops;
 334 struct snd_soc_pcm_runtime;
 335 struct snd_soc_dai;
 336 struct snd_soc_dai_driver;
 337 struct snd_soc_platform;
 338 struct snd_soc_dai_link;
 339 struct snd_soc_platform_driver;
 340 struct snd_soc_codec;
 341 struct snd_soc_codec_driver;
 342 struct snd_soc_component;
 343 struct snd_soc_component_driver;
 344 struct soc_enum;
 345 struct snd_soc_jack;
 346 struct snd_soc_jack_zone;
 347 struct snd_soc_jack_pin;
 348 #include <sound/soc-dapm.h>
 349 #include <sound/soc-dpcm.h>
 350
 351 struct snd_soc_jack_gpio;
 352
 353 typedef int (*hw_write_t)(void *,const char* ,int);
 354
 355 extern struct snd_ac97_bus_ops *soc_ac97_ops;
 356
 357 enum snd_soc_pcm_subclass {
 358         SND_SOC_PCM_CLASS_PCM   = 0,
 359         SND_SOC_PCM_CLASS_BE    = 1,
 360 };
 361
 362 enum snd_soc_card_subclass {
 363         SND_SOC_CARD_CLASS_INIT         = 0,
 364         SND_SOC_CARD_CLASS_RUNTIME      = 1,
 365 };
 366
 367 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
 368                              int source, unsigned int freq, int dir);
 369 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
 370                           unsigned int freq_in, unsigned int freq_out);
 371
 372 int snd_soc_register_card(struct snd_soc_card *card);
 373 int snd_soc_unregister_card(struct snd_soc_card *card);
 374 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
 375 int snd_soc_suspend(struct device *dev);
 376 int snd_soc_resume(struct device *dev);
 377 int snd_soc_poweroff(struct device *dev);
 378 int snd_soc_register_platform(struct device *dev,
 379                 const struct snd_soc_platform_driver *platform_drv);
 380 void snd_soc_unregister_platform(struct device *dev);
 381 int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
 382                 const struct snd_soc_platform_driver *platform_drv);
 383 void snd_soc_remove_platform(struct snd_soc_platform *platform);
 384 struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev);
 385 int snd_soc_register_codec(struct device *dev,
 386                 const struct snd_soc_codec_driver *codec_drv,
 387                 struct snd_soc_dai_driver *dai_drv, int num_dai);
 388 void snd_soc_unregister_codec(struct device *dev);
 389 int snd_soc_register_component(struct device *dev,
 390                          const struct snd_soc_component_driver *cmpnt_drv,
 391                          struct snd_soc_dai_driver *dai_drv, int num_dai);
 392 int devm_snd_soc_register_component(struct device *dev,
 393                          const struct snd_soc_component_driver *cmpnt_drv,
 394                          struct snd_soc_dai_driver *dai_drv, int num_dai);
 395 void snd_soc_unregister_component(struct device *dev);
 396 int snd_soc_cache_sync(struct snd_soc_codec *codec);
 397 int snd_soc_cache_init(struct snd_soc_codec *codec);
 398 int snd_soc_cache_exit(struct snd_soc_codec *codec);
 399 int snd_soc_cache_write(struct snd_soc_codec *codec,
 400                         unsigned int reg, unsigned int value);
 401 int snd_soc_cache_read(struct snd_soc_codec *codec,
 402                        unsigned int reg, unsigned int *value);
 403 int snd_soc_platform_read(struct snd_soc_platform *platform,
 404                                         unsigned int reg);
 405 int snd_soc_platform_write(struct snd_soc_platform *platform,
 406                                         unsigned int reg, unsigned int val);
 407 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
 408 int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
 409
 410 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
 411                 const char *dai_link, int stream);
 412 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
 413                 const char *dai_link);
 414
 415 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
 416 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
 417 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
 418
 419 /* Utility functions to get clock rates from various things */
 420 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 421 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 422 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 423 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 424
 425 /* set runtime hw params */
 426 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 427         const struct snd_pcm_hardware *hw);
 428
 429 int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
 430                 int cmd, struct snd_soc_platform *platform);
 431
 432 /* Jack reporting */
 433 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
 434                      struct snd_soc_jack *jack);
 435 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 436 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 437                           struct snd_soc_jack_pin *pins);
 438 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
 439                                     struct notifier_block *nb);
 440 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
 441                                       struct notifier_block *nb);
 442 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
 443                           struct snd_soc_jack_zone *zones);
 444 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
 445 #ifdef CONFIG_GPIOLIB
 446 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 447                         struct snd_soc_jack_gpio *gpios);
 448 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 449                         struct snd_soc_jack_gpio *gpios);
 450 #else
 451 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 452                                          struct snd_soc_jack_gpio *gpios)
 453 {
 454         return 0;
 455 }
 456
 457 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 458                                            struct snd_soc_jack_gpio *gpios)
 459 {
 460 }
 461 #endif
 462
 463 /* codec register bit access */
 464 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned int reg,
 465                                 unsigned int mask, unsigned int value);
 466 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
 467                                unsigned int reg, unsigned int mask,
 468                                unsigned int value);
 469 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned int reg,
 470                                 unsigned int mask, unsigned int value);
 471
 472 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
 473         struct snd_ac97_bus_ops *ops, int num);
 474 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
 475
 476 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
 477 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 478                 struct platform_device *pdev);
 479
 480 /*
 481  *Controls
 482  */
 483 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 484                                   void *data, const char *long_name,
 485                                   const char *prefix);
 486 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
 487                                                const char *name);
 488 int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
 489         const struct snd_kcontrol_new *controls, int num_controls);
 490 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
 491         const struct snd_kcontrol_new *controls, int num_controls);
 492 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
 493         const struct snd_kcontrol_new *controls, int num_controls);
 494 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
 495         const struct snd_kcontrol_new *controls, int num_controls);
 496 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 497         struct snd_ctl_elem_info *uinfo);
 498 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 499         struct snd_ctl_elem_value *ucontrol);
 500 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 501         struct snd_ctl_elem_value *ucontrol);
 502 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 503         struct snd_ctl_elem_info *uinfo);
 504 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 505 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 506         struct snd_ctl_elem_value *ucontrol);
 507 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 508         struct snd_ctl_elem_value *ucontrol);
 509 #define snd_soc_get_volsw_2r snd_soc_get_volsw
 510 #define snd_soc_put_volsw_2r snd_soc_put_volsw
 511 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
 512         struct snd_ctl_elem_value *ucontrol);
 513 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
 514         struct snd_ctl_elem_value *ucontrol);
 515 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
 516         struct snd_ctl_elem_info *uinfo);
 517 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
 518         struct snd_ctl_elem_value *ucontrol);
 519 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
 520         struct snd_ctl_elem_value *ucontrol);
 521 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
 522         struct snd_ctl_elem_info *uinfo);
 523 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
 524         struct snd_ctl_elem_value *ucontrol);
 525 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
 526         struct snd_ctl_elem_value *ucontrol);
 527 int snd_soc_limit_volume(struct snd_soc_codec *codec,
 528         const char *name, int max);
 529 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
 530                        struct snd_ctl_elem_info *uinfo);
 531 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
 532                       struct snd_ctl_elem_value *ucontrol);
 533 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
 534                       struct snd_ctl_elem_value *ucontrol);
 535 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
 536         struct snd_ctl_elem_info *uinfo);
 537 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
 538         struct snd_ctl_elem_value *ucontrol);
 539 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
 540         struct snd_ctl_elem_value *ucontrol);
 541 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
 542         struct snd_ctl_elem_value *ucontrol);
 543 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
 544         struct snd_ctl_elem_value *ucontrol);
 545
 546 /**
 547  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 548  *
 549  * @pin:    name of the pin to update
 550  * @mask:   bits to check for in reported jack status
 551  * @invert: if non-zero then pin is enabled when status is not reported
 552  */
 553 struct snd_soc_jack_pin {
 554         struct list_head list;
 555         const char *pin;
 556         int mask;
 557         bool invert;
 558 };
 559
 560 /**
 561  * struct snd_soc_jack_zone - Describes voltage zones of jack detection
 562  *
 563  * @min_mv: start voltage in mv
 564  * @max_mv: end voltage in mv
 565  * @jack_type: type of jack that is expected for this voltage
 566  * @debounce_time: debounce_time for jack, codec driver should wait for this
 567  *              duration before reading the adc for voltages
 568  * @:list: list container
 569  */
 570 struct snd_soc_jack_zone {
 571         unsigned int min_mv;
 572         unsigned int max_mv;
 573         unsigned int jack_type;
 574         unsigned int debounce_time;
 575         struct list_head list;
 576 };
 577
 578 /**
 579  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 580  *
 581  * @gpio:         gpio number
 582  * @name:         gpio name
 583  * @report:       value to report when jack detected
 584  * @invert:       report presence in low state
 585  * @debouce_time: debouce time in ms
 586  * @wake:         enable as wake source
 587  * @jack_status_check: callback function which overrides the detection
 588  *                     to provide more complex checks (eg, reading an
 589  *                     ADC).
 590  */
 591 struct snd_soc_jack_gpio {
 592         unsigned int gpio;
 593         const char *name;
 594         int report;
 595         int invert;
 596         int debounce_time;
 597         bool wake;
 598
 599         struct snd_soc_jack *jack;
 600         struct delayed_work work;
 601
 602         void *data;
 603         int (*jack_status_check)(void *data);
 604 };
 605
 606 struct snd_soc_jack {
 607         struct mutex mutex;
 608         struct snd_jack *jack;
 609         struct snd_soc_codec *codec;
 610         struct list_head pins;
 611         int status;
 612         struct blocking_notifier_head notifier;
 613         struct list_head jack_zones;
 614 };
 615
 616 /* SoC PCM stream information */
 617 struct snd_soc_pcm_stream {
 618         const char *stream_name;
 619         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 620         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 621         unsigned int rate_min;          /* min rate */
 622         unsigned int rate_max;          /* max rate */
 623         unsigned int channels_min;      /* min channels */
 624         unsigned int channels_max;      /* max channels */
 625         unsigned int sig_bits;          /* number of bits of content */
 626 };
 627
 628 /* SoC audio ops */
 629 struct snd_soc_ops {
 630         int (*startup)(struct snd_pcm_substream *);
 631         void (*shutdown)(struct snd_pcm_substream *);
 632         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 633         int (*hw_free)(struct snd_pcm_substream *);
 634         int (*prepare)(struct snd_pcm_substream *);
 635         int (*trigger)(struct snd_pcm_substream *, int);
 636 };
 637
 638 struct snd_soc_compr_ops {
 639         int (*startup)(struct snd_compr_stream *);
 640         void (*shutdown)(struct snd_compr_stream *);
 641         int (*set_params)(struct snd_compr_stream *);
 642         int (*trigger)(struct snd_compr_stream *);
 643 };
 644
 645 /* component interface */
 646 struct snd_soc_component_driver {
 647         const char *name;
 648
 649         /* DT */
 650         int (*of_xlate_dai_name)(struct snd_soc_component *component,
 651                                  struct of_phandle_args *args,
 652                                  const char **dai_name);
 653 };
 654
 655 struct snd_soc_component {
 656         const char *name;
 657         int id;
 658         struct device *dev;
 659
 660         unsigned int active;
 661
 662         unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
 663         unsigned int registered_as_component:1;
 664
 665         struct list_head list;
 666
 667         struct snd_soc_dai_driver *dai_drv;
 668         int num_dai;
 669
 670         const struct snd_soc_component_driver *driver;
 671
 672         struct list_head dai_list;
 673
 674         int (*read)(struct snd_soc_component *, unsigned int, unsigned int *);
 675         int (*write)(struct snd_soc_component *, unsigned int, unsigned int);
 676
 677         struct regmap *regmap;
 678         int val_bytes;
 679
 680         struct mutex io_mutex;
 681 };
 682
 683 /* SoC Audio Codec device */
 684 struct snd_soc_codec {
 685         const char *name;
 686         const char *name_prefix;
 687         int id;
 688         struct device *dev;
 689         const struct snd_soc_codec_driver *driver;
 690
 691         struct mutex mutex;
 692         struct snd_soc_card *card;
 693         struct list_head list;
 694         struct list_head card_list;
 695         int num_dai;
 696
 697         /* runtime */
 698         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
 699         unsigned int cache_bypass:1; /* Suppress access to the cache */
 700         unsigned int suspended:1; /* Codec is in suspend PM state */
 701         unsigned int probed:1; /* Codec has been probed */
 702         unsigned int ac97_registered:1; /* Codec has been AC97 registered */
 703         unsigned int ac97_created:1; /* Codec has been created by SoC */
 704         unsigned int cache_init:1; /* codec cache has been initialized */
 705         u32 cache_only;  /* Suppress writes to hardware */
 706         u32 cache_sync; /* Cache needs to be synced to hardware */
 707
 708         /* codec IO */
 709         void *control_data; /* codec control (i2c/3wire) data */
 710         hw_write_t hw_write;
 711         void *reg_cache;
 712         struct mutex cache_rw_mutex;
 713
 714         /* component */
 715         struct snd_soc_component component;
 716
 717         /* dapm */
 718         struct snd_soc_dapm_context dapm;
 719
 720 #ifdef CONFIG_DEBUG_FS
 721         struct dentry *debugfs_codec_root;
 722         struct dentry *debugfs_reg;
 723 #endif
 724 };
 725
 726 /* codec driver */
 727 struct snd_soc_codec_driver {
 728
 729         /* driver ops */
 730         int (*probe)(struct snd_soc_codec *);
 731         int (*remove)(struct snd_soc_codec *);
 732         int (*suspend)(struct snd_soc_codec *);
 733         int (*resume)(struct snd_soc_codec *);
 734         struct snd_soc_component_driver component_driver;
 735
 736         /* Default control and setup, added after probe() is run */
 737         const struct snd_kcontrol_new *controls;
 738         int num_controls;
 739         const struct snd_soc_dapm_widget *dapm_widgets;
 740         int num_dapm_widgets;
 741         const struct snd_soc_dapm_route *dapm_routes;
 742         int num_dapm_routes;
 743
 744         /* codec wide operations */
 745         int (*set_sysclk)(struct snd_soc_codec *codec,
 746                           int clk_id, int source, unsigned int freq, int dir);
 747         int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
 748                 unsigned int freq_in, unsigned int freq_out);
 749
 750         /* codec IO */
 751         struct regmap *(*get_regmap)(struct device *);
 752         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 753         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 754         unsigned int reg_cache_size;
 755         short reg_cache_step;
 756         short reg_word_size;
 757         const void *reg_cache_default;
 758
 759         /* codec bias level */
 760         int (*set_bias_level)(struct snd_soc_codec *,
 761                               enum snd_soc_bias_level level);
 762         bool idle_bias_off;
 763
 764         void (*seq_notifier)(struct snd_soc_dapm_context *,
 765                              enum snd_soc_dapm_type, int);
 766
 767         /* codec stream completion event */
 768         int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
 769
 770         bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */
 771
 772         /* probe ordering - for components with runtime dependencies */
 773         int probe_order;
 774         int remove_order;
 775 };
 776
 777 /* SoC platform interface */
 778 struct snd_soc_platform_driver {
 779
 780         int (*probe)(struct snd_soc_platform *);
 781         int (*remove)(struct snd_soc_platform *);
 782         int (*suspend)(struct snd_soc_dai *dai);
 783         int (*resume)(struct snd_soc_dai *dai);
 784         struct snd_soc_component_driver component_driver;
 785
 786         /* pcm creation and destruction */
 787         int (*pcm_new)(struct snd_soc_pcm_runtime *);
 788         void (*pcm_free)(struct snd_pcm *);
 789
 790         /* Default control and setup, added after probe() is run */
 791         const struct snd_kcontrol_new *controls;
 792         int num_controls;
 793         const struct snd_soc_dapm_widget *dapm_widgets;
 794         int num_dapm_widgets;
 795         const struct snd_soc_dapm_route *dapm_routes;
 796         int num_dapm_routes;
 797
 798         /*
 799          * For platform caused delay reporting.
 800          * Optional.
 801          */
 802         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 803                 struct snd_soc_dai *);
 804
 805         /* platform stream pcm ops */
 806         const struct snd_pcm_ops *ops;
 807
 808         /* platform stream compress ops */
 809         const struct snd_compr_ops *compr_ops;
 810
 811         /* platform stream completion event */
 812         int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
 813
 814         /* probe ordering - for components with runtime dependencies */
 815         int probe_order;
 816         int remove_order;
 817
 818         /* platform IO - used for platform DAPM */
 819         unsigned int (*read)(struct snd_soc_platform *, unsigned int);
 820         int (*write)(struct snd_soc_platform *, unsigned int, unsigned int);
 821         int (*bespoke_trigger)(struct snd_pcm_substream *, int);
 822 };
 823
 824 struct snd_soc_platform {
 825         const char *name;
 826         int id;
 827         struct device *dev;
 828         const struct snd_soc_platform_driver *driver;
 829
 830         unsigned int suspended:1; /* platform is suspended */
 831         unsigned int probed:1;
 832
 833         struct snd_soc_card *card;
 834         struct list_head list;
 835         struct list_head card_list;
 836
 837         struct snd_soc_component component;
 838
 839         struct snd_soc_dapm_context dapm;
 840
 841 #ifdef CONFIG_DEBUG_FS
 842         struct dentry *debugfs_platform_root;
 843 #endif
 844 };
 845
 846 struct snd_soc_dai_link {
 847         /* config - must be set by machine driver */
 848         const char *name;                       /* Codec name */
 849         const char *stream_name;                /* Stream name */
 850         /*
 851          * You MAY specify the link's CPU-side device, either by device name,
 852          * or by DT/OF node, but not both. If this information is omitted,
 853          * the CPU-side DAI is matched using .cpu_dai_name only, which hence
 854          * must be globally unique. These fields are currently typically used
 855          * only for codec to codec links, or systems using device tree.
 856          */
 857         const char *cpu_name;
 858         const struct device_node *cpu_of_node;
 859         /*
 860          * You MAY specify the DAI name of the CPU DAI. If this information is
 861          * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
 862          * only, which only works well when that device exposes a single DAI.
 863          */
 864         const char *cpu_dai_name;
 865         /*
 866          * You MUST specify the link's codec, either by device name, or by
 867          * DT/OF node, but not both.
 868          */
 869         const char *codec_name;
 870         const struct device_node *codec_of_node;
 871         /* You MUST specify the DAI name within the codec */
 872         const char *codec_dai_name;
 873         /*
 874          * You MAY specify the link's platform/PCM/DMA driver, either by
 875          * device name, or by DT/OF node, but not both. Some forms of link
 876          * do not need a platform.
 877          */
 878         const char *platform_name;
 879         const struct device_node *platform_of_node;
 880         int be_id;      /* optional ID for machine driver BE identification */
 881
 882         const struct snd_soc_pcm_stream *params;
 883
 884         unsigned int dai_fmt;           /* format to set on init */
 885
 886         enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
 887
 888         /* Keep DAI active over suspend */
 889         unsigned int ignore_suspend:1;
 890
 891         /* Symmetry requirements */
 892         unsigned int symmetric_rates:1;
 893         unsigned int symmetric_channels:1;
 894         unsigned int symmetric_samplebits:1;
 895
 896         /* Do not create a PCM for this DAI link (Backend link) */
 897         unsigned int no_pcm:1;
 898
 899         /* This DAI link can route to other DAI links at runtime (Frontend)*/
 900         unsigned int dynamic:1;
 901
 902         /* DPCM capture and Playback support */
 903         unsigned int dpcm_capture:1;
 904         unsigned int dpcm_playback:1;
 905
 906         /* pmdown_time is ignored at stop */
 907         unsigned int ignore_pmdown_time:1;
 908
 909         /* codec/machine specific init - e.g. add machine controls */
 910         int (*init)(struct snd_soc_pcm_runtime *rtd);
 911
 912         /* optional hw_params re-writing for BE and FE sync */
 913         int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
 914                         struct snd_pcm_hw_params *params);
 915
 916         /* machine stream operations */
 917         const struct snd_soc_ops *ops;
 918         const struct snd_soc_compr_ops *compr_ops;
 919
 920         /* For unidirectional dai links */
 921         bool playback_only;
 922         bool capture_only;
 923 };
 924
 925 struct snd_soc_codec_conf {
 926         const char *dev_name;
 927
 928         /*
 929          * optional map of kcontrol, widget and path name prefixes that are
 930          * associated per device
 931          */
 932         const char *name_prefix;
 933 };
 934
 935 struct snd_soc_aux_dev {
 936         const char *name;               /* Codec name */
 937         const char *codec_name;         /* for multi-codec */
 938
 939         /* codec/machine specific init - e.g. add machine controls */
 940         int (*init)(struct snd_soc_dapm_context *dapm);
 941 };
 942
 943 /* SoC card */
 944 struct snd_soc_card {
 945         const char *name;
 946         const char *long_name;
 947         const char *driver_name;
 948         struct device *dev;
 949         struct snd_card *snd_card;
 950         struct module *owner;
 951
 952         struct list_head list;
 953         struct mutex mutex;
 954         struct mutex dapm_mutex;
 955
 956         bool instantiated;
 957
 958         int (*probe)(struct snd_soc_card *card);
 959         int (*late_probe)(struct snd_soc_card *card);
 960         int (*remove)(struct snd_soc_card *card);
 961
 962         /* the pre and post PM functions are used to do any PM work before and
 963          * after the codec and DAI's do any PM work. */
 964         int (*suspend_pre)(struct snd_soc_card *card);
 965         int (*suspend_post)(struct snd_soc_card *card);
 966         int (*resume_pre)(struct snd_soc_card *card);
 967         int (*resume_post)(struct snd_soc_card *card);
 968
 969         /* callbacks */
 970         int (*set_bias_level)(struct snd_soc_card *,
 971                               struct snd_soc_dapm_context *dapm,
 972                               enum snd_soc_bias_level level);
 973         int (*set_bias_level_post)(struct snd_soc_card *,
 974                                    struct snd_soc_dapm_context *dapm,
 975                                    enum snd_soc_bias_level level);
 976
 977         long pmdown_time;
 978
 979         /* CPU <--> Codec DAI links  */
 980         struct snd_soc_dai_link *dai_link;
 981         int num_links;
 982         struct snd_soc_pcm_runtime *rtd;
 983         int num_rtd;
 984
 985         /* optional codec specific configuration */
 986         struct snd_soc_codec_conf *codec_conf;
 987         int num_configs;
 988
 989         /*
 990          * optional auxiliary devices such as amplifiers or codecs with DAI
 991          * link unused
 992          */
 993         struct snd_soc_aux_dev *aux_dev;
 994         int num_aux_devs;
 995         struct snd_soc_pcm_runtime *rtd_aux;
 996         int num_aux_rtd;
 997
 998         const struct snd_kcontrol_new *controls;
 999         int num_controls;
1000
1001         /*
1002          * Card-specific routes and widgets.
1003          */
1004         const struct snd_soc_dapm_widget *dapm_widgets;
1005         int num_dapm_widgets;
1006         const struct snd_soc_dapm_route *dapm_routes;
1007         int num_dapm_routes;
1008         bool fully_routed;
1009
1010         struct work_struct deferred_resume_work;
1011
1012         /* lists of probed devices belonging to this card */
1013         struct list_head codec_dev_list;
1014         struct list_head platform_dev_list;
1015         struct list_head dai_dev_list;
1016
1017         struct list_head widgets;
1018         struct list_head paths;
1019         struct list_head dapm_list;
1020         struct list_head dapm_dirty;
1021
1022         /* Generic DAPM context for the card */
1023         struct snd_soc_dapm_context dapm;
1024         struct snd_soc_dapm_stats dapm_stats;
1025         struct snd_soc_dapm_update *update;
1026
1027 #ifdef CONFIG_DEBUG_FS
1028         struct dentry *debugfs_card_root;
1029         struct dentry *debugfs_pop_time;
1030 #endif
1031         u32 pop_time;
1032
1033         void *drvdata;
1034 };
1035
1036 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1037 struct snd_soc_pcm_runtime {
1038         struct device *dev;
1039         struct snd_soc_card *card;
1040         struct snd_soc_dai_link *dai_link;
1041         struct mutex pcm_mutex;
1042         enum snd_soc_pcm_subclass pcm_subclass;
1043         struct snd_pcm_ops ops;
1044
1045         unsigned int dev_registered:1;
1046
1047         /* Dynamic PCM BE runtime data */
1048         struct snd_soc_dpcm_runtime dpcm[2];
1049         int fe_compr;
1050
1051         long pmdown_time;
1052         unsigned char pop_wait:1;
1053
1054         /* runtime devices */
1055         struct snd_pcm *pcm;
1056         struct snd_compr *compr;
1057         struct snd_soc_codec *codec;
1058         struct snd_soc_platform *platform;
1059         struct snd_soc_dai *codec_dai;
1060         struct snd_soc_dai *cpu_dai;
1061
1062         struct delayed_work delayed_work;
1063 #ifdef CONFIG_DEBUG_FS
1064         struct dentry *debugfs_dpcm_root;
1065         struct dentry *debugfs_dpcm_state;
1066 #endif
1067 };
1068
1069 /* mixer control */
1070 struct soc_mixer_control {
1071         int min, max, platform_max;
1072         int reg, rreg;
1073         unsigned int shift, rshift;
1074         unsigned int sign_bit;
1075         unsigned int invert:1;
1076         unsigned int autodisable:1;
1077 };
1078
1079 struct soc_bytes {
1080         int base;
1081         int num_regs;
1082         u32 mask;
1083 };
1084
1085 /* multi register control */
1086 struct soc_mreg_control {
1087         long min, max;
1088         unsigned int regbase, regcount, nbits, invert;
1089 };
1090
1091 /* enumerated kcontrol */
1092 struct soc_enum {
1093         int reg;
1094         unsigned char shift_l;
1095         unsigned char shift_r;
1096         unsigned int items;
1097         unsigned int mask;
1098         const char * const *texts;
1099         const unsigned int *values;
1100 };
1101
1102 /**
1103  * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1104  * @component: The component to cast to a CODEC
1105  *
1106  * This function must only be used on components that are known to be CODECs.
1107  * Otherwise the behavior is undefined.
1108  */
1109 static inline struct snd_soc_codec *snd_soc_component_to_codec(
1110         struct snd_soc_component *component)
1111 {
1112         return container_of(component, struct snd_soc_codec, component);
1113 }
1114
1115 /**
1116  * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1117  * @component: The component to cast to a platform
1118  *
1119  * This function must only be used on components that are known to be platforms.
1120  * Otherwise the behavior is undefined.
1121  */
1122 static inline struct snd_soc_platform *snd_soc_component_to_platform(
1123         struct snd_soc_component *component)
1124 {
1125         return container_of(component, struct snd_soc_platform, component);
1126 }
1127
1128 /* codec IO */
1129 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1130 int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg,
1131         unsigned int val);
1132
1133 /* component IO */
1134 int snd_soc_component_read(struct snd_soc_component *component,
1135         unsigned int reg, unsigned int *val);
1136 int snd_soc_component_write(struct snd_soc_component *component,
1137         unsigned int reg, unsigned int val);
1138 int snd_soc_component_update_bits(struct snd_soc_component *component,
1139         unsigned int reg, unsigned int mask, unsigned int val);
1140 int snd_soc_component_update_bits_async(struct snd_soc_component *component,
1141         unsigned int reg, unsigned int mask, unsigned int val);
1142 void snd_soc_component_async_complete(struct snd_soc_component *component);
1143 int snd_soc_component_test_bits(struct snd_soc_component *component,
1144         unsigned int reg, unsigned int mask, unsigned int value);
1145
1146 int snd_soc_component_init_io(struct snd_soc_component *component,
1147         struct regmap *regmap);
1148
1149 /* device driver data */
1150
1151 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1152                 void *data)
1153 {
1154         card->drvdata = data;
1155 }
1156
1157 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1158 {
1159         return card->drvdata;
1160 }
1161
1162 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1163                 void *data)
1164 {
1165         dev_set_drvdata(codec->dev, data);
1166 }
1167
1168 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1169 {
1170         return dev_get_drvdata(codec->dev);
1171 }
1172
1173 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1174                 void *data)
1175 {
1176         dev_set_drvdata(platform->dev, data);
1177 }
1178
1179 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1180 {
1181         return dev_get_drvdata(platform->dev);
1182 }
1183
1184 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1185                 void *data)
1186 {
1187         dev_set_drvdata(rtd->dev, data);
1188 }
1189
1190 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1191 {
1192         return dev_get_drvdata(rtd->dev);
1193 }
1194
1195 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1196 {
1197         INIT_LIST_HEAD(&card->dai_dev_list);
1198         INIT_LIST_HEAD(&card->codec_dev_list);
1199         INIT_LIST_HEAD(&card->platform_dev_list);
1200         INIT_LIST_HEAD(&card->widgets);
1201         INIT_LIST_HEAD(&card->paths);
1202         INIT_LIST_HEAD(&card->dapm_list);
1203 }
1204
1205 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1206 {
1207         if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1208                 return 0;
1209         /*
1210          * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1211          * mc->reg != mc->rreg means that the control is
1212          * stereo (bits in one register or in two registers)
1213          */
1214         return 1;
1215 }
1216
1217 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1218         unsigned int val)
1219 {
1220         unsigned int i;
1221
1222         if (!e->values)
1223                 return val;
1224
1225         for (i = 0; i < e->items; i++)
1226                 if (val == e->values[i])
1227                         return i;
1228
1229         return 0;
1230 }
1231
1232 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1233         unsigned int item)
1234 {
1235         if (!e->values)
1236                 return item;
1237
1238         return e->values[item];
1239 }
1240
1241 static inline bool snd_soc_component_is_active(
1242         struct snd_soc_component *component)
1243 {
1244         return component->active != 0;
1245 }
1246
1247 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1248 {
1249         return snd_soc_component_is_active(&codec->component);
1250 }
1251
1252 /**
1253  * snd_soc_kcontrol_component() - Returns the component that registered the
1254  *  control
1255  * @kcontrol: The control for which to get the component
1256  *
1257  * Note: This function will work correctly if the control has been registered
1258  * for a component. Either with snd_soc_add_codec_controls() or
1259  * snd_soc_add_platform_controls() or via  table based setup for either a
1260  * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1261  */
1262 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1263         struct snd_kcontrol *kcontrol)
1264 {
1265         return snd_kcontrol_chip(kcontrol);
1266 }
1267
1268 /**
1269  * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1270  * @kcontrol: The control for which to get the CODEC
1271  *
1272  * Note: This function will only work correctly if the control has been
1273  * registered with snd_soc_add_codec_controls() or via table based setup of
1274  * snd_soc_codec_driver. Otherwise the behavior is undefined.
1275  */
1276 static inline struct snd_soc_codec *snd_soc_kcontrol_codec(
1277         struct snd_kcontrol *kcontrol)
1278 {
1279         return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol));
1280 }
1281
1282 /**
1283  * snd_soc_kcontrol_platform() - Returns the platform that registerd the control
1284  * @kcontrol: The control for which to get the platform
1285  *
1286  * Note: This function will only work correctly if the control has been
1287  * registered with snd_soc_add_platform_controls() or via table based setup of
1288  * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1289  */
1290 static inline struct snd_soc_platform *snd_soc_kcontrol_platform(
1291         struct snd_kcontrol *kcontrol)
1292 {
1293         return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol));
1294 }
1295
1296 int snd_soc_util_init(void);
1297 void snd_soc_util_exit(void);
1298
1299 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1300                                const char *propname);
1301 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1302                                           const char *propname);
1303 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1304                               unsigned int *slots,
1305                               unsigned int *slot_width);
1306 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1307                                    const char *propname);
1308 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1309                                      const char *prefix);
1310 int snd_soc_of_get_dai_name(struct device_node *of_node,
1311                             const char **dai_name);
1312
1313 #include <sound/soc-dai.h>
1314
1315 #ifdef CONFIG_DEBUG_FS
1316 extern struct dentry *snd_soc_debugfs_root;
1317 #endif
1318
1319 extern const struct dev_pm_ops snd_soc_pm_ops;
1320
1321 /* Helper functions */
1322 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1323 {
1324         mutex_lock(&dapm->card->dapm_mutex);
1325 }
1326
1327 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1328 {
1329         mutex_unlock(&dapm->card->dapm_mutex);
1330 }
1331
1332 #endif