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