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