include/sound/soc.h

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