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