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_DOUBLE_S_VALUE(xreg, shift_left, shift_right, xmin, xmax, xsign_bit, xinvert, xautodisable) \
  40         ((unsigned long)&(struct soc_mixer_control) \
  41         {.reg = xreg, .rreg = xreg, .shift = shift_left, \
  42         .rshift = shift_right, .min = xmin, .max = xmax, .platform_max = xmax, \
  43         .sign_bit = xsign_bit, .invert = xinvert, .autodisable = xautodisable})
  44 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \
  45         SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable)
  46 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
  47         ((unsigned long)&(struct soc_mixer_control) \
  48         {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
  49 #define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
  50         ((unsigned long)&(struct soc_mixer_control) \
  51         {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  52         .max = xmax, .platform_max = xmax, .invert = xinvert})
  53 #define SOC_DOUBLE_R_S_VALUE(xlreg, xrreg, xshift, xmin, xmax, xsign_bit, xinvert) \
  54         ((unsigned long)&(struct soc_mixer_control) \
  55         {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  56         .max = xmax, .min = xmin, .platform_max = xmax, .sign_bit = xsign_bit, \
  57         .invert = xinvert})
  58 #define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
  59         ((unsigned long)&(struct soc_mixer_control) \
  60         {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  61         .min = xmin, .max = xmax, .platform_max = xmax, .invert = xinvert})
  62 #define SOC_SINGLE(xname, reg, shift, max, invert) \
  63 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  64         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  65         .put = snd_soc_put_volsw, \
  66         .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
  67 #define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
  68 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  69         .info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
  70         .put = snd_soc_put_volsw_range, \
  71         .private_value = (unsigned long)&(struct soc_mixer_control) \
  72                 {.reg = xreg, .rreg = xreg, .shift = xshift, \
  73                  .rshift = xshift,  .min = xmin, .max = xmax, \
  74                  .platform_max = xmax, .invert = xinvert} }
  75 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
  76 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  77         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  78                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  79         .tlv.p = (tlv_array), \
  80         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  81         .put = snd_soc_put_volsw, \
  82         .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
  83 #define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
  84 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  85         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
  86         SNDRV_CTL_ELEM_ACCESS_READWRITE, \
  87         .tlv.p  = (tlv_array),\
  88         .info = snd_soc_info_volsw_sx, \
  89         .get = snd_soc_get_volsw_sx,\
  90         .put = snd_soc_put_volsw_sx, \
  91         .private_value = (unsigned long)&(struct soc_mixer_control) \
  92                 {.reg = xreg, .rreg = xreg, \
  93                 .shift = xshift, .rshift = xshift, \
  94                 .max = xmax, .min = xmin} }
  95 #define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
  96 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  97         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  98                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  99         .tlv.p = (tlv_array), \
 100         .info = snd_soc_info_volsw_range, \
 101         .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
 102         .private_value = (unsigned long)&(struct soc_mixer_control) \
 103                 {.reg = xreg, .rreg = xreg, .shift = xshift, \
 104                  .rshift = xshift, .min = xmin, .max = xmax, \
 105                  .platform_max = xmax, .invert = xinvert} }
 106 #define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
 107 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 108         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
 109         .put = snd_soc_put_volsw, \
 110         .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
 111                                           max, invert, 0) }
 112 #define SOC_DOUBLE_STS(xname, reg, shift_left, shift_right, max, invert) \
 113 {                                                                       \
 114         .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),           \
 115         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,           \
 116         .access = SNDRV_CTL_ELEM_ACCESS_READ |                          \
 117                 SNDRV_CTL_ELEM_ACCESS_VOLATILE,                         \
 118         .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
 119                                           max, invert, 0) }
 120 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
 121 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 122         .info = snd_soc_info_volsw, \
 123         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 124         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 125                                             xmax, xinvert) }
 126 #define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
 127                            xmax, xinvert)               \
 128 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 129         .info = snd_soc_info_volsw_range, \
 130         .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
 131         .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
 132                                             xshift, xmin, xmax, xinvert) }
 133 #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
 134 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 135         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 136                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 137         .tlv.p = (tlv_array), \
 138         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
 139         .put = snd_soc_put_volsw, \
 140         .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
 141                                           max, invert, 0) }
 142 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
 143 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 144         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 145                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 146         .tlv.p = (tlv_array), \
 147         .info = snd_soc_info_volsw, \
 148         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 149         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 150                                             xmax, xinvert) }
 151 #define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
 152                                xmax, xinvert, tlv_array)                \
 153 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 154         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 155                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 156         .tlv.p = (tlv_array), \
 157         .info = snd_soc_info_volsw_range, \
 158         .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
 159         .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
 160                                             xshift, xmin, xmax, xinvert) }
 161 #define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
 162 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 163         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 164         SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 165         .tlv.p  = (tlv_array), \
 166         .info = snd_soc_info_volsw_sx, \
 167         .get = snd_soc_get_volsw_sx, \
 168         .put = snd_soc_put_volsw_sx, \
 169         .private_value = (unsigned long)&(struct soc_mixer_control) \
 170                 {.reg = xreg, .rreg = xrreg, \
 171                 .shift = xshift, .rshift = xshift, \
 172                 .max = xmax, .min = xmin} }
 173 #define SOC_DOUBLE_R_S_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
 174 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 175         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 176                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 177         .tlv.p = (tlv_array), \
 178         .info = snd_soc_info_volsw, \
 179         .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 180         .private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
 181                                             xmin, xmax, xsign_bit, xinvert) }
 182 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
 183 {       .iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 184         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 185                   SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 186         .tlv.p  = (tlv_array), \
 187         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
 188         .put = snd_soc_put_volsw, \
 189         .private_value = SOC_DOUBLE_S_VALUE(xreg, 0, 8, xmin, xmax, 7, 0, 0) }
 190 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \
 191 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 192         .items = xitems, .texts = xtexts, \
 193         .mask = xitems ? roundup_pow_of_two(xitems) - 1 : 0}
 194 #define SOC_ENUM_SINGLE(xreg, xshift, xitems, xtexts) \
 195         SOC_ENUM_DOUBLE(xreg, xshift, xshift, xitems, xtexts)
 196 #define SOC_ENUM_SINGLE_EXT(xitems, xtexts) \
 197 {       .items = xitems, .texts = xtexts }
 198 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xitems, xtexts, xvalues) \
 199 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 200         .mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues}
 201 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
 202         SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xitems, xtexts, xvalues)
 203 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
 204 {       .reg = xreg, .shift_l = xshift, .shift_r = xshift, \
 205         .mask = xmask, .items = xitems, .texts = xtexts, \
 206         .values = xvalues, .autodisable = 1}
 207 #define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \
 208         SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
 209 #define SOC_ENUM(xname, xenum) \
 210 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
 211         .info = snd_soc_info_enum_double, \
 212         .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
 213         .private_value = (unsigned long)&xenum }
 214 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
 215          xhandler_get, xhandler_put) \
 216 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 217         .info = snd_soc_info_volsw, \
 218         .get = xhandler_get, .put = xhandler_put, \
 219         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
 220 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
 221          xhandler_get, xhandler_put) \
 222 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 223         .info = snd_soc_info_volsw, \
 224         .get = xhandler_get, .put = xhandler_put, \
 225         .private_value = \
 226                 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
 227 #define SOC_DOUBLE_R_EXT(xname, reg_left, reg_right, xshift, xmax, xinvert,\
 228          xhandler_get, xhandler_put) \
 229 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 230         .info = snd_soc_info_volsw, \
 231         .get = xhandler_get, .put = xhandler_put, \
 232         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 233                                             xmax, xinvert) }
 234 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
 235          xhandler_get, xhandler_put, tlv_array) \
 236 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 237         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 238                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 239         .tlv.p = (tlv_array), \
 240         .info = snd_soc_info_volsw, \
 241         .get = xhandler_get, .put = xhandler_put, \
 242         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
 243 #define SOC_SINGLE_RANGE_EXT_TLV(xname, xreg, xshift, xmin, xmax, xinvert, \
 244                                  xhandler_get, xhandler_put, tlv_array) \
 245 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 246         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 247                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 248         .tlv.p = (tlv_array), \
 249         .info = snd_soc_info_volsw_range, \
 250         .get = xhandler_get, .put = xhandler_put, \
 251         .private_value = (unsigned long)&(struct soc_mixer_control) \
 252                 {.reg = xreg, .rreg = xreg, .shift = xshift, \
 253                  .rshift = xshift, .min = xmin, .max = xmax, \
 254                  .platform_max = xmax, .invert = xinvert} }
 255 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
 256          xhandler_get, xhandler_put, tlv_array) \
 257 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 258         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 259                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 260         .tlv.p = (tlv_array), \
 261         .info = snd_soc_info_volsw, \
 262         .get = xhandler_get, .put = xhandler_put, \
 263         .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
 264                                           xmax, xinvert, 0) }
 265 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
 266          xhandler_get, xhandler_put, tlv_array) \
 267 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 268         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 269                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 270         .tlv.p = (tlv_array), \
 271         .info = snd_soc_info_volsw, \
 272         .get = xhandler_get, .put = xhandler_put, \
 273         .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 274                                             xmax, xinvert) }
 275 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
 276 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 277         .info = snd_soc_info_bool_ext, \
 278         .get = xhandler_get, .put = xhandler_put, \
 279         .private_value = xdata }
 280 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 281 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 282         .info = snd_soc_info_enum_double, \
 283         .get = xhandler_get, .put = xhandler_put, \
 284         .private_value = (unsigned long)&xenum }
 285 #define SOC_VALUE_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 286         SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put)
 287
 288 #define SND_SOC_BYTES(xname, xbase, xregs)                    \
 289 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
 290         .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
 291         .put = snd_soc_bytes_put, .private_value =            \
 292                 ((unsigned long)&(struct soc_bytes)           \
 293                 {.base = xbase, .num_regs = xregs }) }
 294
 295 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask)        \
 296 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
 297         .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
 298         .put = snd_soc_bytes_put, .private_value =            \
 299                 ((unsigned long)&(struct soc_bytes)           \
 300                 {.base = xbase, .num_regs = xregs,            \
 301                  .mask = xmask }) }
 302
 303 /*
 304  * SND_SOC_BYTES_EXT is deprecated, please USE SND_SOC_BYTES_TLV instead
 305  */
 306 #define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \
 307 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 308         .info = snd_soc_bytes_info_ext, \
 309         .get = xhandler_get, .put = xhandler_put, \
 310         .private_value = (unsigned long)&(struct soc_bytes_ext) \
 311                 {.max = xcount} }
 312 #define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \
 313 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 314         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \
 315                   SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
 316         .tlv.c = (snd_soc_bytes_tlv_callback), \
 317         .info = snd_soc_bytes_info_ext, \
 318         .private_value = (unsigned long)&(struct soc_bytes_ext) \
 319                 {.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
 320 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
 321                 xmin, xmax, xinvert) \
 322 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 323         .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
 324         .put = snd_soc_put_xr_sx, \
 325         .private_value = (unsigned long)&(struct soc_mreg_control) \
 326                 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
 327                 .invert = xinvert, .min = xmin, .max = xmax} }
 328
 329 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
 330         SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
 331                 snd_soc_get_strobe, snd_soc_put_strobe)
 332
 333 /*
 334  * Simplified versions of above macros, declaring a struct and calculating
 335  * ARRAY_SIZE internally
 336  */
 337 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
 338         const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
 339                                                 ARRAY_SIZE(xtexts), xtexts)
 340 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
 341         SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
 342 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
 343         const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
 344 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
 345         const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
 346                                                         ARRAY_SIZE(xtexts), xtexts, xvalues)
 347 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
 348         SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
 349
 350 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
 351         const struct soc_enum name = SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, \
 352                 xshift, xmask, ARRAY_SIZE(xtexts), xtexts, xvalues)
 353
 354 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
 355         const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
 356
 357 /*
 358  * Component probe and remove ordering levels for components with runtime
 359  * dependencies.
 360  */
 361 #define SND_SOC_COMP_ORDER_FIRST                -2
 362 #define SND_SOC_COMP_ORDER_EARLY                -1
 363 #define SND_SOC_COMP_ORDER_NORMAL               0
 364 #define SND_SOC_COMP_ORDER_LATE         1
 365 #define SND_SOC_COMP_ORDER_LAST         2
 366
 367 /*
 368  * Bias levels
 369  *
 370  * @ON:      Bias is fully on for audio playback and capture operations.
 371  * @PREPARE: Prepare for audio operations. Called before DAPM switching for
 372  *           stream start and stop operations.
 373  * @STANDBY: Low power standby state when no playback/capture operations are
 374  *           in progress. NOTE: The transition time between STANDBY and ON
 375  *           should be as fast as possible and no longer than 10ms.
 376  * @OFF:     Power Off. No restrictions on transition times.
 377  */
 378 enum snd_soc_bias_level {
 379         SND_SOC_BIAS_OFF = 0,
 380         SND_SOC_BIAS_STANDBY = 1,
 381         SND_SOC_BIAS_PREPARE = 2,
 382         SND_SOC_BIAS_ON = 3,
 383 };
 384
 385 struct device_node;
 386 struct snd_jack;
 387 struct snd_soc_card;
 388 struct snd_soc_pcm_stream;
 389 struct snd_soc_ops;
 390 struct snd_soc_pcm_runtime;
 391 struct snd_soc_dai;
 392 struct snd_soc_dai_driver;
 393 struct snd_soc_platform;
 394 struct snd_soc_dai_link;
 395 struct snd_soc_platform_driver;
 396 struct snd_soc_codec;
 397 struct snd_soc_codec_driver;
 398 struct snd_soc_component;
 399 struct snd_soc_component_driver;
 400 struct soc_enum;
 401 struct snd_soc_jack;
 402 struct snd_soc_jack_zone;
 403 struct snd_soc_jack_pin;
 404 #include <sound/soc-dapm.h>
 405 #include <sound/soc-dpcm.h>
 406 #include <sound/soc-topology.h>
 407
 408 struct snd_soc_jack_gpio;
 409
 410 typedef int (*hw_write_t)(void *,const char* ,int);
 411
 412 enum snd_soc_pcm_subclass {
 413         SND_SOC_PCM_CLASS_PCM   = 0,
 414         SND_SOC_PCM_CLASS_BE    = 1,
 415 };
 416
 417 enum snd_soc_card_subclass {
 418         SND_SOC_CARD_CLASS_INIT         = 0,
 419         SND_SOC_CARD_CLASS_RUNTIME      = 1,
 420 };
 421
 422 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
 423                              int source, unsigned int freq, int dir);
 424 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
 425                           unsigned int freq_in, unsigned int freq_out);
 426
 427 int snd_soc_register_card(struct snd_soc_card *card);
 428 int snd_soc_unregister_card(struct snd_soc_card *card);
 429 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
 430 #ifdef CONFIG_PM_SLEEP
 431 int snd_soc_suspend(struct device *dev);
 432 int snd_soc_resume(struct device *dev);
 433 #else
 434 static inline int snd_soc_suspend(struct device *dev)
 435 {
 436         return 0;
 437 }
 438
 439 static inline int snd_soc_resume(struct device *dev)
 440 {
 441         return 0;
 442 }
 443 #endif
 444 int snd_soc_poweroff(struct device *dev);
 445 int snd_soc_register_platform(struct device *dev,
 446                 const struct snd_soc_platform_driver *platform_drv);
 447 int devm_snd_soc_register_platform(struct device *dev,
 448                 const struct snd_soc_platform_driver *platform_drv);
 449 void snd_soc_unregister_platform(struct device *dev);
 450 int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
 451                 const struct snd_soc_platform_driver *platform_drv);
 452 void snd_soc_remove_platform(struct snd_soc_platform *platform);
 453 struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev);
 454 int snd_soc_register_codec(struct device *dev,
 455                 const struct snd_soc_codec_driver *codec_drv,
 456                 struct snd_soc_dai_driver *dai_drv, int num_dai);
 457 void snd_soc_unregister_codec(struct device *dev);
 458 int snd_soc_register_component(struct device *dev,
 459                          const struct snd_soc_component_driver *cmpnt_drv,
 460                          struct snd_soc_dai_driver *dai_drv, int num_dai);
 461 int devm_snd_soc_register_component(struct device *dev,
 462                          const struct snd_soc_component_driver *cmpnt_drv,
 463                          struct snd_soc_dai_driver *dai_drv, int num_dai);
 464 void snd_soc_unregister_component(struct device *dev);
 465 int snd_soc_cache_init(struct snd_soc_codec *codec);
 466 int snd_soc_cache_exit(struct snd_soc_codec *codec);
 467
 468 int snd_soc_platform_read(struct snd_soc_platform *platform,
 469                                         unsigned int reg);
 470 int snd_soc_platform_write(struct snd_soc_platform *platform,
 471                                         unsigned int reg, unsigned int val);
 472 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
 473 #ifdef CONFIG_SND_SOC_COMPRESS
 474 int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
 475 #endif
 476
 477 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
 478                 const char *dai_link, int stream);
 479 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
 480                 const char *dai_link);
 481
 482 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
 483 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
 484 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
 485
 486 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
 487         unsigned int dai_fmt);
 488
 489 /* Utility functions to get clock rates from various things */
 490 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 491 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 492 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 493 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 494
 495 /* set runtime hw params */
 496 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 497         const struct snd_pcm_hardware *hw);
 498
 499 int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
 500                 int cmd, struct snd_soc_platform *platform);
 501
 502 int soc_dai_hw_params(struct snd_pcm_substream *substream,
 503                       struct snd_pcm_hw_params *params,
 504                       struct snd_soc_dai *dai);
 505
 506 /* Jack reporting */
 507 int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type,
 508         struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins,
 509         unsigned int num_pins);
 510
 511 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 512 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 513                           struct snd_soc_jack_pin *pins);
 514 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
 515                                     struct notifier_block *nb);
 516 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
 517                                       struct notifier_block *nb);
 518 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
 519                           struct snd_soc_jack_zone *zones);
 520 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
 521 #ifdef CONFIG_GPIOLIB
 522 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 523                         struct snd_soc_jack_gpio *gpios);
 524 int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
 525                             struct snd_soc_jack *jack,
 526                             int count, struct snd_soc_jack_gpio *gpios);
 527 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 528                         struct snd_soc_jack_gpio *gpios);
 529 #else
 530 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 531                                          struct snd_soc_jack_gpio *gpios)
 532 {
 533         return 0;
 534 }
 535
 536 static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
 537                                           struct snd_soc_jack *jack,
 538                                           int count,
 539                                           struct snd_soc_jack_gpio *gpios)
 540 {
 541         return 0;
 542 }
 543
 544 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 545                                            struct snd_soc_jack_gpio *gpios)
 546 {
 547 }
 548 #endif
 549
 550 /* codec register bit access */
 551 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned int reg,
 552                                 unsigned int mask, unsigned int value);
 553 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
 554                                unsigned int reg, unsigned int mask,
 555                                unsigned int value);
 556 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned int reg,
 557                                 unsigned int mask, unsigned int value);
 558
 559 #ifdef CONFIG_SND_SOC_AC97_BUS
 560 struct snd_ac97 *snd_soc_alloc_ac97_codec(struct snd_soc_codec *codec);
 561 struct snd_ac97 *snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
 562         unsigned int id, unsigned int id_mask);
 563 void snd_soc_free_ac97_codec(struct snd_ac97 *ac97);
 564
 565 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
 566 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 567                 struct platform_device *pdev);
 568
 569 extern struct snd_ac97_bus_ops *soc_ac97_ops;
 570 #else
 571 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 572         struct platform_device *pdev)
 573 {
 574         return 0;
 575 }
 576
 577 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
 578 {
 579         return 0;
 580 }
 581 #endif
 582
 583 /*
 584  *Controls
 585  */
 586 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 587                                   void *data, const char *long_name,
 588                                   const char *prefix);
 589 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
 590                                                const char *name);
 591 int snd_soc_add_component_controls(struct snd_soc_component *component,
 592         const struct snd_kcontrol_new *controls, unsigned int num_controls);
 593 int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
 594         const struct snd_kcontrol_new *controls, unsigned int num_controls);
 595 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
 596         const struct snd_kcontrol_new *controls, unsigned int num_controls);
 597 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
 598         const struct snd_kcontrol_new *controls, int num_controls);
 599 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
 600         const struct snd_kcontrol_new *controls, int num_controls);
 601 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 602         struct snd_ctl_elem_info *uinfo);
 603 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 604         struct snd_ctl_elem_value *ucontrol);
 605 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 606         struct snd_ctl_elem_value *ucontrol);
 607 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 608         struct snd_ctl_elem_info *uinfo);
 609 int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol,
 610                           struct snd_ctl_elem_info *uinfo);
 611 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 612 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 613         struct snd_ctl_elem_value *ucontrol);
 614 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 615         struct snd_ctl_elem_value *ucontrol);
 616 #define snd_soc_get_volsw_2r snd_soc_get_volsw
 617 #define snd_soc_put_volsw_2r snd_soc_put_volsw
 618 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
 619         struct snd_ctl_elem_value *ucontrol);
 620 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
 621         struct snd_ctl_elem_value *ucontrol);
 622 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
 623         struct snd_ctl_elem_info *uinfo);
 624 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
 625         struct snd_ctl_elem_value *ucontrol);
 626 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
 627         struct snd_ctl_elem_value *ucontrol);
 628 int snd_soc_limit_volume(struct snd_soc_card *card,
 629         const char *name, int max);
 630 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
 631                        struct snd_ctl_elem_info *uinfo);
 632 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
 633                       struct snd_ctl_elem_value *ucontrol);
 634 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
 635                       struct snd_ctl_elem_value *ucontrol);
 636 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
 637         struct snd_ctl_elem_info *ucontrol);
 638 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
 639         unsigned int size, unsigned int __user *tlv);
 640 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
 641         struct snd_ctl_elem_info *uinfo);
 642 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
 643         struct snd_ctl_elem_value *ucontrol);
 644 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
 645         struct snd_ctl_elem_value *ucontrol);
 646 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
 647         struct snd_ctl_elem_value *ucontrol);
 648 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
 649         struct snd_ctl_elem_value *ucontrol);
 650
 651 /**
 652  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 653  *
 654  * @pin:    name of the pin to update
 655  * @mask:   bits to check for in reported jack status
 656  * @invert: if non-zero then pin is enabled when status is not reported
 657  * @list:   internal list entry
 658  */
 659 struct snd_soc_jack_pin {
 660         struct list_head list;
 661         const char *pin;
 662         int mask;
 663         bool invert;
 664 };
 665
 666 /**
 667  * struct snd_soc_jack_zone - Describes voltage zones of jack detection
 668  *
 669  * @min_mv: start voltage in mv
 670  * @max_mv: end voltage in mv
 671  * @jack_type: type of jack that is expected for this voltage
 672  * @debounce_time: debounce_time for jack, codec driver should wait for this
 673  *              duration before reading the adc for voltages
 674  * @list:   internal list entry
 675  */
 676 struct snd_soc_jack_zone {
 677         unsigned int min_mv;
 678         unsigned int max_mv;
 679         unsigned int jack_type;
 680         unsigned int debounce_time;
 681         struct list_head list;
 682 };
 683
 684 /**
 685  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 686  *
 687  * @gpio:         legacy gpio number
 688  * @idx:          gpio descriptor index within the function of the GPIO
 689  *                consumer device
 690  * @gpiod_dev:    GPIO consumer device
 691  * @name:         gpio name. Also as connection ID for the GPIO consumer
 692  *                device function name lookup
 693  * @report:       value to report when jack detected
 694  * @invert:       report presence in low state
 695  * @debounce_time: debounce time in ms
 696  * @wake:         enable as wake source
 697  * @jack_status_check: callback function which overrides the detection
 698  *                     to provide more complex checks (eg, reading an
 699  *                     ADC).
 700  */
 701 struct snd_soc_jack_gpio {
 702         unsigned int gpio;
 703         unsigned int idx;
 704         struct device *gpiod_dev;
 705         const char *name;
 706         int report;
 707         int invert;
 708         int debounce_time;
 709         bool wake;
 710
 711         /* private: */
 712         struct snd_soc_jack *jack;
 713         struct delayed_work work;
 714         struct gpio_desc *desc;
 715
 716         void *data;
 717         /* public: */
 718         int (*jack_status_check)(void *data);
 719 };
 720
 721 struct snd_soc_jack {
 722         struct mutex mutex;
 723         struct snd_jack *jack;
 724         struct snd_soc_card *card;
 725         struct list_head pins;
 726         int status;
 727         struct blocking_notifier_head notifier;
 728         struct list_head jack_zones;
 729 };
 730
 731 /* SoC PCM stream information */
 732 struct snd_soc_pcm_stream {
 733         const char *stream_name;
 734         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 735         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 736         unsigned int rate_min;          /* min rate */
 737         unsigned int rate_max;          /* max rate */
 738         unsigned int channels_min;      /* min channels */
 739         unsigned int channels_max;      /* max channels */
 740         unsigned int sig_bits;          /* number of bits of content */
 741 };
 742
 743 /* SoC audio ops */
 744 struct snd_soc_ops {
 745         int (*startup)(struct snd_pcm_substream *);
 746         void (*shutdown)(struct snd_pcm_substream *);
 747         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 748         int (*hw_free)(struct snd_pcm_substream *);
 749         int (*prepare)(struct snd_pcm_substream *);
 750         int (*trigger)(struct snd_pcm_substream *, int);
 751 };
 752
 753 struct snd_soc_compr_ops {
 754         int (*startup)(struct snd_compr_stream *);
 755         void (*shutdown)(struct snd_compr_stream *);
 756         int (*set_params)(struct snd_compr_stream *);
 757         int (*trigger)(struct snd_compr_stream *);
 758 };
 759
 760 /* component interface */
 761 struct snd_soc_component_driver {
 762         const char *name;
 763
 764         /* Default control and setup, added after probe() is run */
 765         const struct snd_kcontrol_new *controls;
 766         unsigned int num_controls;
 767         const struct snd_soc_dapm_widget *dapm_widgets;
 768         unsigned int num_dapm_widgets;
 769         const struct snd_soc_dapm_route *dapm_routes;
 770         unsigned int num_dapm_routes;
 771
 772         int (*probe)(struct snd_soc_component *);
 773         void (*remove)(struct snd_soc_component *);
 774
 775         /* DT */
 776         int (*of_xlate_dai_name)(struct snd_soc_component *component,
 777                                  struct of_phandle_args *args,
 778                                  const char **dai_name);
 779         void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type,
 780                 int subseq);
 781         int (*stream_event)(struct snd_soc_component *, int event);
 782
 783         /* probe ordering - for components with runtime dependencies */
 784         int probe_order;
 785         int remove_order;
 786 };
 787
 788 struct snd_soc_component {
 789         const char *name;
 790         int id;
 791         const char *name_prefix;
 792         struct device *dev;
 793         struct snd_soc_card *card;
 794
 795         unsigned int active;
 796
 797         unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
 798         unsigned int registered_as_component:1;
 799
 800         struct list_head list;
 801         struct list_head list_aux; /* for auxiliary component of the card */
 802
 803         struct snd_soc_dai_driver *dai_drv;
 804         int num_dai;
 805
 806         const struct snd_soc_component_driver *driver;
 807
 808         struct list_head dai_list;
 809
 810         int (*read)(struct snd_soc_component *, unsigned int, unsigned int *);
 811         int (*write)(struct snd_soc_component *, unsigned int, unsigned int);
 812
 813         struct regmap *regmap;
 814         int val_bytes;
 815
 816         struct mutex io_mutex;
 817
 818         /* attached dynamic objects */
 819         struct list_head dobj_list;
 820
 821 #ifdef CONFIG_DEBUG_FS
 822         struct dentry *debugfs_root;
 823 #endif
 824
 825         /*
 826         * DO NOT use any of the fields below in drivers, they are temporary and
 827         * are going to be removed again soon. If you use them in driver code the
 828         * driver will be marked as BROKEN when these fields are removed.
 829         */
 830
 831         /* Don't use these, use snd_soc_component_get_dapm() */
 832         struct snd_soc_dapm_context dapm;
 833
 834         const struct snd_kcontrol_new *controls;
 835         unsigned int num_controls;
 836         const struct snd_soc_dapm_widget *dapm_widgets;
 837         unsigned int num_dapm_widgets;
 838         const struct snd_soc_dapm_route *dapm_routes;
 839         unsigned int num_dapm_routes;
 840         struct snd_soc_codec *codec;
 841
 842         int (*probe)(struct snd_soc_component *);
 843         void (*remove)(struct snd_soc_component *);
 844
 845         /* machine specific init */
 846         int (*init)(struct snd_soc_component *component);
 847
 848 #ifdef CONFIG_DEBUG_FS
 849         void (*init_debugfs)(struct snd_soc_component *component);
 850         const char *debugfs_prefix;
 851 #endif
 852 };
 853
 854 /* SoC Audio Codec device */
 855 struct snd_soc_codec {
 856         struct device *dev;
 857         const struct snd_soc_codec_driver *driver;
 858
 859         struct list_head list;
 860         struct list_head card_list;
 861
 862         /* runtime */
 863         unsigned int cache_bypass:1; /* Suppress access to the cache */
 864         unsigned int suspended:1; /* Codec is in suspend PM state */
 865         unsigned int cache_init:1; /* codec cache has been initialized */
 866
 867         /* codec IO */
 868         void *control_data; /* codec control (i2c/3wire) data */
 869         hw_write_t hw_write;
 870         void *reg_cache;
 871
 872         /* component */
 873         struct snd_soc_component component;
 874
 875 #ifdef CONFIG_DEBUG_FS
 876         struct dentry *debugfs_reg;
 877 #endif
 878 };
 879
 880 /* codec driver */
 881 struct snd_soc_codec_driver {
 882
 883         /* driver ops */
 884         int (*probe)(struct snd_soc_codec *);
 885         int (*remove)(struct snd_soc_codec *);
 886         int (*suspend)(struct snd_soc_codec *);
 887         int (*resume)(struct snd_soc_codec *);
 888         struct snd_soc_component_driver component_driver;
 889
 890         /* Default control and setup, added after probe() is run */
 891         const struct snd_kcontrol_new *controls;
 892         int num_controls;
 893         const struct snd_soc_dapm_widget *dapm_widgets;
 894         int num_dapm_widgets;
 895         const struct snd_soc_dapm_route *dapm_routes;
 896         int num_dapm_routes;
 897
 898         /* codec wide operations */
 899         int (*set_sysclk)(struct snd_soc_codec *codec,
 900                           int clk_id, int source, unsigned int freq, int dir);
 901         int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
 902                 unsigned int freq_in, unsigned int freq_out);
 903
 904         /* codec IO */
 905         struct regmap *(*get_regmap)(struct device *);
 906         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 907         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 908         unsigned int reg_cache_size;
 909         short reg_cache_step;
 910         short reg_word_size;
 911         const void *reg_cache_default;
 912
 913         /* codec bias level */
 914         int (*set_bias_level)(struct snd_soc_codec *,
 915                               enum snd_soc_bias_level level);
 916         bool idle_bias_off;
 917         bool suspend_bias_off;
 918
 919         void (*seq_notifier)(struct snd_soc_dapm_context *,
 920                              enum snd_soc_dapm_type, int);
 921
 922         bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */
 923 };
 924
 925 /* SoC platform interface */
 926 struct snd_soc_platform_driver {
 927
 928         int (*probe)(struct snd_soc_platform *);
 929         int (*remove)(struct snd_soc_platform *);
 930         struct snd_soc_component_driver component_driver;
 931
 932         /* pcm creation and destruction */
 933         int (*pcm_new)(struct snd_soc_pcm_runtime *);
 934         void (*pcm_free)(struct snd_pcm *);
 935
 936         /*
 937          * For platform caused delay reporting.
 938          * Optional.
 939          */
 940         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 941                 struct snd_soc_dai *);
 942
 943         /* platform stream pcm ops */
 944         const struct snd_pcm_ops *ops;
 945
 946         /* platform stream compress ops */
 947         const struct snd_compr_ops *compr_ops;
 948
 949         int (*bespoke_trigger)(struct snd_pcm_substream *, int);
 950 };
 951
 952 struct snd_soc_dai_link_component {
 953         const char *name;
 954         struct device_node *of_node;
 955         const char *dai_name;
 956 };
 957
 958 struct snd_soc_platform {
 959         struct device *dev;
 960         const struct snd_soc_platform_driver *driver;
 961
 962         struct list_head list;
 963
 964         struct snd_soc_component component;
 965 };
 966
 967 struct snd_soc_dai_link {
 968         /* config - must be set by machine driver */
 969         const char *name;                       /* Codec name */
 970         const char *stream_name;                /* Stream name */
 971         /*
 972          * You MAY specify the link's CPU-side device, either by device name,
 973          * or by DT/OF node, but not both. If this information is omitted,
 974          * the CPU-side DAI is matched using .cpu_dai_name only, which hence
 975          * must be globally unique. These fields are currently typically used
 976          * only for codec to codec links, or systems using device tree.
 977          */
 978         const char *cpu_name;
 979         struct device_node *cpu_of_node;
 980         /*
 981          * You MAY specify the DAI name of the CPU DAI. If this information is
 982          * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
 983          * only, which only works well when that device exposes a single DAI.
 984          */
 985         const char *cpu_dai_name;
 986         /*
 987          * You MUST specify the link's codec, either by device name, or by
 988          * DT/OF node, but not both.
 989          */
 990         const char *codec_name;
 991         struct device_node *codec_of_node;
 992         /* You MUST specify the DAI name within the codec */
 993         const char *codec_dai_name;
 994
 995         struct snd_soc_dai_link_component *codecs;
 996         unsigned int num_codecs;
 997
 998         /*
 999          * You MAY specify the link's platform/PCM/DMA driver, either by
1000          * device name, or by DT/OF node, but not both. Some forms of link
1001          * do not need a platform.
1002          */
1003         const char *platform_name;
1004         struct device_node *platform_of_node;
1005         int be_id;      /* optional ID for machine driver BE identification */
1006
1007         const struct snd_soc_pcm_stream *params;
1008         unsigned int num_params;
1009
1010         unsigned int dai_fmt;           /* format to set on init */
1011
1012         enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
1013
1014         /* codec/machine specific init - e.g. add machine controls */
1015         int (*init)(struct snd_soc_pcm_runtime *rtd);
1016
1017         /* optional hw_params re-writing for BE and FE sync */
1018         int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
1019                         struct snd_pcm_hw_params *params);
1020
1021         /* machine stream operations */
1022         const struct snd_soc_ops *ops;
1023         const struct snd_soc_compr_ops *compr_ops;
1024
1025         /* For unidirectional dai links */
1026         bool playback_only;
1027         bool capture_only;
1028
1029         /* Mark this pcm with non atomic ops */
1030         bool nonatomic;
1031
1032         /* Keep DAI active over suspend */
1033         unsigned int ignore_suspend:1;
1034
1035         /* Symmetry requirements */
1036         unsigned int symmetric_rates:1;
1037         unsigned int symmetric_channels:1;
1038         unsigned int symmetric_samplebits:1;
1039
1040         /* Do not create a PCM for this DAI link (Backend link) */
1041         unsigned int no_pcm:1;
1042
1043         /* This DAI link can route to other DAI links at runtime (Frontend)*/
1044         unsigned int dynamic:1;
1045
1046         /* DPCM capture and Playback support */
1047         unsigned int dpcm_capture:1;
1048         unsigned int dpcm_playback:1;
1049
1050         /* DPCM used FE & BE merged format */
1051         unsigned int dpcm_merged_format:1;
1052
1053         /* pmdown_time is ignored at stop */
1054         unsigned int ignore_pmdown_time:1;
1055
1056         struct list_head list; /* DAI link list of the soc card */
1057         struct snd_soc_dobj dobj; /* For topology */
1058 };
1059
1060 struct snd_soc_codec_conf {
1061         /*
1062          * specify device either by device name, or by
1063          * DT/OF node, but not both.
1064          */
1065         const char *dev_name;
1066         struct device_node *of_node;
1067
1068         /*
1069          * optional map of kcontrol, widget and path name prefixes that are
1070          * associated per device
1071          */
1072         const char *name_prefix;
1073 };
1074
1075 struct snd_soc_aux_dev {
1076         const char *name;               /* Codec name */
1077
1078         /*
1079          * specify multi-codec either by device name, or by
1080          * DT/OF node, but not both.
1081          */
1082         const char *codec_name;
1083         struct device_node *codec_of_node;
1084
1085         /* codec/machine specific init - e.g. add machine controls */
1086         int (*init)(struct snd_soc_component *component);
1087 };
1088
1089 /* SoC card */
1090 struct snd_soc_card {
1091         const char *name;
1092         const char *long_name;
1093         const char *driver_name;
1094         struct device *dev;
1095         struct snd_card *snd_card;
1096         struct module *owner;
1097
1098         struct mutex mutex;
1099         struct mutex dapm_mutex;
1100
1101         bool instantiated;
1102
1103         int (*probe)(struct snd_soc_card *card);
1104         int (*late_probe)(struct snd_soc_card *card);
1105         int (*remove)(struct snd_soc_card *card);
1106
1107         /* the pre and post PM functions are used to do any PM work before and
1108          * after the codec and DAI's do any PM work. */
1109         int (*suspend_pre)(struct snd_soc_card *card);
1110         int (*suspend_post)(struct snd_soc_card *card);
1111         int (*resume_pre)(struct snd_soc_card *card);
1112         int (*resume_post)(struct snd_soc_card *card);
1113
1114         /* callbacks */
1115         int (*set_bias_level)(struct snd_soc_card *,
1116                               struct snd_soc_dapm_context *dapm,
1117                               enum snd_soc_bias_level level);
1118         int (*set_bias_level_post)(struct snd_soc_card *,
1119                                    struct snd_soc_dapm_context *dapm,
1120                                    enum snd_soc_bias_level level);
1121
1122         int (*add_dai_link)(struct snd_soc_card *,
1123                             struct snd_soc_dai_link *link);
1124         void (*remove_dai_link)(struct snd_soc_card *,
1125                             struct snd_soc_dai_link *link);
1126
1127         long pmdown_time;
1128
1129         /* CPU <--> Codec DAI links  */
1130         struct snd_soc_dai_link *dai_link;  /* predefined links only */
1131         int num_links;  /* predefined links only */
1132         struct list_head dai_link_list; /* all links */
1133         int num_dai_links;
1134
1135         struct list_head rtd_list;
1136         int num_rtd;
1137
1138         /* optional codec specific configuration */
1139         struct snd_soc_codec_conf *codec_conf;
1140         int num_configs;
1141
1142         /*
1143          * optional auxiliary devices such as amplifiers or codecs with DAI
1144          * link unused
1145          */
1146         struct snd_soc_aux_dev *aux_dev;
1147         int num_aux_devs;
1148         struct list_head aux_comp_list;
1149
1150         const struct snd_kcontrol_new *controls;
1151         int num_controls;
1152
1153         /*
1154          * Card-specific routes and widgets.
1155          * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1156          */
1157         const struct snd_soc_dapm_widget *dapm_widgets;
1158         int num_dapm_widgets;
1159         const struct snd_soc_dapm_route *dapm_routes;
1160         int num_dapm_routes;
1161         const struct snd_soc_dapm_widget *of_dapm_widgets;
1162         int num_of_dapm_widgets;
1163         const struct snd_soc_dapm_route *of_dapm_routes;
1164         int num_of_dapm_routes;
1165         bool fully_routed;
1166
1167         struct work_struct deferred_resume_work;
1168
1169         /* lists of probed devices belonging to this card */
1170         struct list_head codec_dev_list;
1171
1172         struct list_head widgets;
1173         struct list_head paths;
1174         struct list_head dapm_list;
1175         struct list_head dapm_dirty;
1176
1177         /* attached dynamic objects */
1178         struct list_head dobj_list;
1179
1180         /* Generic DAPM context for the card */
1181         struct snd_soc_dapm_context dapm;
1182         struct snd_soc_dapm_stats dapm_stats;
1183         struct snd_soc_dapm_update *update;
1184
1185 #ifdef CONFIG_DEBUG_FS
1186         struct dentry *debugfs_card_root;
1187         struct dentry *debugfs_pop_time;
1188 #endif
1189         u32 pop_time;
1190
1191         void *drvdata;
1192 };
1193
1194 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1195 struct snd_soc_pcm_runtime {
1196         struct device *dev;
1197         struct snd_soc_card *card;
1198         struct snd_soc_dai_link *dai_link;
1199         struct mutex pcm_mutex;
1200         enum snd_soc_pcm_subclass pcm_subclass;
1201         struct snd_pcm_ops ops;
1202
1203         unsigned int dev_registered:1;
1204
1205         /* Dynamic PCM BE runtime data */
1206         struct snd_soc_dpcm_runtime dpcm[2];
1207         int fe_compr;
1208
1209         long pmdown_time;
1210         unsigned char pop_wait:1;
1211
1212         /* runtime devices */
1213         struct snd_pcm *pcm;
1214         struct snd_compr *compr;
1215         struct snd_soc_codec *codec;
1216         struct snd_soc_platform *platform;
1217         struct snd_soc_dai *codec_dai;
1218         struct snd_soc_dai *cpu_dai;
1219         struct snd_soc_component *component; /* Only valid for AUX dev rtds */
1220
1221         struct snd_soc_dai **codec_dais;
1222         unsigned int num_codecs;
1223
1224         struct delayed_work delayed_work;
1225 #ifdef CONFIG_DEBUG_FS
1226         struct dentry *debugfs_dpcm_root;
1227         struct dentry *debugfs_dpcm_state;
1228 #endif
1229
1230         unsigned int num; /* 0-based and monotonic increasing */
1231         struct list_head list; /* rtd list of the soc card */
1232 };
1233
1234 /* mixer control */
1235 struct soc_mixer_control {
1236         int min, max, platform_max;
1237         int reg, rreg;
1238         unsigned int shift, rshift;
1239         unsigned int sign_bit;
1240         unsigned int invert:1;
1241         unsigned int autodisable:1;
1242         struct snd_soc_dobj dobj;
1243 };
1244
1245 struct soc_bytes {
1246         int base;
1247         int num_regs;
1248         u32 mask;
1249 };
1250
1251 struct soc_bytes_ext {
1252         int max;
1253         struct snd_soc_dobj dobj;
1254
1255         /* used for TLV byte control */
1256         int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1257                         unsigned int size);
1258         int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1259                         unsigned int size);
1260 };
1261
1262 /* multi register control */
1263 struct soc_mreg_control {
1264         long min, max;
1265         unsigned int regbase, regcount, nbits, invert;
1266 };
1267
1268 /* enumerated kcontrol */
1269 struct soc_enum {
1270         int reg;
1271         unsigned char shift_l;
1272         unsigned char shift_r;
1273         unsigned int items;
1274         unsigned int mask;
1275         const char * const *texts;
1276         const unsigned int *values;
1277         unsigned int autodisable:1;
1278         struct snd_soc_dobj dobj;
1279 };
1280
1281 /**
1282  * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1283  * @component: The component to cast to a CODEC
1284  *
1285  * This function must only be used on components that are known to be CODECs.
1286  * Otherwise the behavior is undefined.
1287  */
1288 static inline struct snd_soc_codec *snd_soc_component_to_codec(
1289         struct snd_soc_component *component)
1290 {
1291         return container_of(component, struct snd_soc_codec, component);
1292 }
1293
1294 /**
1295  * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1296  * @component: The component to cast to a platform
1297  *
1298  * This function must only be used on components that are known to be platforms.
1299  * Otherwise the behavior is undefined.
1300  */
1301 static inline struct snd_soc_platform *snd_soc_component_to_platform(
1302         struct snd_soc_component *component)
1303 {
1304         return container_of(component, struct snd_soc_platform, component);
1305 }
1306
1307 /**
1308  * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
1309  *  embedded in
1310  * @dapm: The DAPM context to cast to the component
1311  *
1312  * This function must only be used on DAPM contexts that are known to be part of
1313  * a component (e.g. in a component driver). Otherwise the behavior is
1314  * undefined.
1315  */
1316 static inline struct snd_soc_component *snd_soc_dapm_to_component(
1317         struct snd_soc_dapm_context *dapm)
1318 {
1319         return container_of(dapm, struct snd_soc_component, dapm);
1320 }
1321
1322 /**
1323  * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in
1324  * @dapm: The DAPM context to cast to the CODEC
1325  *
1326  * This function must only be used on DAPM contexts that are known to be part of
1327  * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1328  */
1329 static inline struct snd_soc_codec *snd_soc_dapm_to_codec(
1330         struct snd_soc_dapm_context *dapm)
1331 {
1332         return snd_soc_component_to_codec(snd_soc_dapm_to_component(dapm));
1333 }
1334
1335 /**
1336  * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is
1337  *  embedded in
1338  * @dapm: The DAPM context to cast to the platform.
1339  *
1340  * This function must only be used on DAPM contexts that are known to be part of
1341  * a platform (e.g. in a platform driver). Otherwise the behavior is undefined.
1342  */
1343 static inline struct snd_soc_platform *snd_soc_dapm_to_platform(
1344         struct snd_soc_dapm_context *dapm)
1345 {
1346         return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm));
1347 }
1348
1349 /**
1350  * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
1351  *  component
1352  * @component: The component for which to get the DAPM context
1353  */
1354 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
1355         struct snd_soc_component *component)
1356 {
1357         return &component->dapm;
1358 }
1359
1360 /**
1361  * snd_soc_codec_get_dapm() - Returns the DAPM context for the CODEC
1362  * @codec: The CODEC for which to get the DAPM context
1363  *
1364  * Note: Use this function instead of directly accessing the CODEC's dapm field
1365  */
1366 static inline struct snd_soc_dapm_context *snd_soc_codec_get_dapm(
1367         struct snd_soc_codec *codec)
1368 {
1369         return snd_soc_component_get_dapm(&codec->component);
1370 }
1371
1372 /**
1373  * snd_soc_dapm_init_bias_level() - Initialize CODEC DAPM bias level
1374  * @codec: The CODEC for which to initialize the DAPM bias level
1375  * @level: The DAPM level to initialize to
1376  *
1377  * Initializes the CODEC DAPM bias level. See snd_soc_dapm_init_bias_level().
1378  */
1379 static inline void snd_soc_codec_init_bias_level(struct snd_soc_codec *codec,
1380         enum snd_soc_bias_level level)
1381 {
1382         snd_soc_dapm_init_bias_level(snd_soc_codec_get_dapm(codec), level);
1383 }
1384
1385 /**
1386  * snd_soc_dapm_get_bias_level() - Get current CODEC DAPM bias level
1387  * @codec: The CODEC for which to get the DAPM bias level
1388  *
1389  * Returns: The current DAPM bias level of the CODEC.
1390  */
1391 static inline enum snd_soc_bias_level snd_soc_codec_get_bias_level(
1392         struct snd_soc_codec *codec)
1393 {
1394         return snd_soc_dapm_get_bias_level(snd_soc_codec_get_dapm(codec));
1395 }
1396
1397 /**
1398  * snd_soc_codec_force_bias_level() - Set the CODEC DAPM bias level
1399  * @codec: The CODEC for which to set the level
1400  * @level: The level to set to
1401  *
1402  * Forces the CODEC bias level to a specific state. See
1403  * snd_soc_dapm_force_bias_level().
1404  */
1405 static inline int snd_soc_codec_force_bias_level(struct snd_soc_codec *codec,
1406         enum snd_soc_bias_level level)
1407 {
1408         return snd_soc_dapm_force_bias_level(snd_soc_codec_get_dapm(codec),
1409                 level);
1410 }
1411
1412 /**
1413  * snd_soc_dapm_kcontrol_codec() - Returns the codec associated to a kcontrol
1414  * @kcontrol: The kcontrol
1415  *
1416  * This function must only be used on DAPM contexts that are known to be part of
1417  * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1418  */
1419 static inline struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(
1420         struct snd_kcontrol *kcontrol)
1421 {
1422         return snd_soc_dapm_to_codec(snd_soc_dapm_kcontrol_dapm(kcontrol));
1423 }
1424
1425 /* codec IO */
1426 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1427 int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg,
1428         unsigned int val);
1429
1430 /**
1431  * snd_soc_cache_sync() - Sync the register cache with the hardware
1432  * @codec: CODEC to sync
1433  *
1434  * Note: This function will call regcache_sync()
1435  */
1436 static inline int snd_soc_cache_sync(struct snd_soc_codec *codec)
1437 {
1438         return regcache_sync(codec->component.regmap);
1439 }
1440
1441 /* component IO */
1442 int snd_soc_component_read(struct snd_soc_component *component,
1443         unsigned int reg, unsigned int *val);
1444 int snd_soc_component_write(struct snd_soc_component *component,
1445         unsigned int reg, unsigned int val);
1446 int snd_soc_component_update_bits(struct snd_soc_component *component,
1447         unsigned int reg, unsigned int mask, unsigned int val);
1448 int snd_soc_component_update_bits_async(struct snd_soc_component *component,
1449         unsigned int reg, unsigned int mask, unsigned int val);
1450 void snd_soc_component_async_complete(struct snd_soc_component *component);
1451 int snd_soc_component_test_bits(struct snd_soc_component *component,
1452         unsigned int reg, unsigned int mask, unsigned int value);
1453
1454 #ifdef CONFIG_REGMAP
1455
1456 void snd_soc_component_init_regmap(struct snd_soc_component *component,
1457         struct regmap *regmap);
1458 void snd_soc_component_exit_regmap(struct snd_soc_component *component);
1459
1460 /**
1461  * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC
1462  * @codec: The CODEC for which to initialize the regmap instance
1463  * @regmap: The regmap instance that should be used by the CODEC
1464  *
1465  * This function allows deferred assignment of the regmap instance that is
1466  * associated with the CODEC. Only use this if the regmap instance is not yet
1467  * ready when the CODEC is registered. The function must also be called before
1468  * the first IO attempt of the CODEC.
1469  */
1470 static inline void snd_soc_codec_init_regmap(struct snd_soc_codec *codec,
1471         struct regmap *regmap)
1472 {
1473         snd_soc_component_init_regmap(&codec->component, regmap);
1474 }
1475
1476 /**
1477  * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC
1478  * @codec: The CODEC for which to de-initialize the regmap instance
1479  *
1480  * Calls regmap_exit() on the regmap instance associated to the CODEC and
1481  * removes the regmap instance from the CODEC.
1482  *
1483  * This function should only be used if snd_soc_codec_init_regmap() was used to
1484  * initialize the regmap instance.
1485  */
1486 static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec *codec)
1487 {
1488         snd_soc_component_exit_regmap(&codec->component);
1489 }
1490
1491 #endif
1492
1493 /* device driver data */
1494
1495 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1496                 void *data)
1497 {
1498         card->drvdata = data;
1499 }
1500
1501 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1502 {
1503         return card->drvdata;
1504 }
1505
1506 static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
1507                 void *data)
1508 {
1509         dev_set_drvdata(c->dev, data);
1510 }
1511
1512 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
1513 {
1514         return dev_get_drvdata(c->dev);
1515 }
1516
1517 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1518                 void *data)
1519 {
1520         snd_soc_component_set_drvdata(&codec->component, data);
1521 }
1522
1523 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1524 {
1525         return snd_soc_component_get_drvdata(&codec->component);
1526 }
1527
1528 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1529                 void *data)
1530 {
1531         snd_soc_component_set_drvdata(&platform->component, data);
1532 }
1533
1534 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1535 {
1536         return snd_soc_component_get_drvdata(&platform->component);
1537 }
1538
1539 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1540                 void *data)
1541 {
1542         dev_set_drvdata(rtd->dev, data);
1543 }
1544
1545 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1546 {
1547         return dev_get_drvdata(rtd->dev);
1548 }
1549
1550 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1551 {
1552         INIT_LIST_HEAD(&card->codec_dev_list);
1553         INIT_LIST_HEAD(&card->widgets);
1554         INIT_LIST_HEAD(&card->paths);
1555         INIT_LIST_HEAD(&card->dapm_list);
1556         INIT_LIST_HEAD(&card->aux_comp_list);
1557 }
1558
1559 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1560 {
1561         if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1562                 return 0;
1563         /*
1564          * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1565          * mc->reg != mc->rreg means that the control is
1566          * stereo (bits in one register or in two registers)
1567          */
1568         return 1;
1569 }
1570
1571 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1572         unsigned int val)
1573 {
1574         unsigned int i;
1575
1576         if (!e->values)
1577                 return val;
1578
1579         for (i = 0; i < e->items; i++)
1580                 if (val == e->values[i])
1581                         return i;
1582
1583         return 0;
1584 }
1585
1586 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1587         unsigned int item)
1588 {
1589         if (!e->values)
1590                 return item;
1591
1592         return e->values[item];
1593 }
1594
1595 static inline bool snd_soc_component_is_active(
1596         struct snd_soc_component *component)
1597 {
1598         return component->active != 0;
1599 }
1600
1601 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1602 {
1603         return snd_soc_component_is_active(&codec->component);
1604 }
1605
1606 /**
1607  * snd_soc_kcontrol_component() - Returns the component that registered the
1608  *  control
1609  * @kcontrol: The control for which to get the component
1610  *
1611  * Note: This function will work correctly if the control has been registered
1612  * for a component. Either with snd_soc_add_codec_controls() or
1613  * snd_soc_add_platform_controls() or via  table based setup for either a
1614  * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1615  */
1616 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1617         struct snd_kcontrol *kcontrol)
1618 {
1619         return snd_kcontrol_chip(kcontrol);
1620 }
1621
1622 /**
1623  * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1624  * @kcontrol: The control for which to get the CODEC
1625  *
1626  * Note: This function will only work correctly if the control has been
1627  * registered with snd_soc_add_codec_controls() or via table based setup of
1628  * snd_soc_codec_driver. Otherwise the behavior is undefined.
1629  */
1630 static inline struct snd_soc_codec *snd_soc_kcontrol_codec(
1631         struct snd_kcontrol *kcontrol)
1632 {
1633         return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol));
1634 }
1635
1636 /**
1637  * snd_soc_kcontrol_platform() - Returns the platform that registered the control
1638  * @kcontrol: The control for which to get the platform
1639  *
1640  * Note: This function will only work correctly if the control has been
1641  * registered with snd_soc_add_platform_controls() or via table based setup of
1642  * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1643  */
1644 static inline struct snd_soc_platform *snd_soc_kcontrol_platform(
1645         struct snd_kcontrol *kcontrol)
1646 {
1647         return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol));
1648 }
1649
1650 int snd_soc_util_init(void);
1651 void snd_soc_util_exit(void);
1652
1653 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1654                                const char *propname);
1655 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1656                                           const char *propname);
1657 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1658                               unsigned int *tx_mask,
1659                               unsigned int *rx_mask,
1660                               unsigned int *slots,
1661                               unsigned int *slot_width);
1662 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1663                                    struct snd_soc_codec_conf *codec_conf,
1664                                    struct device_node *of_node,
1665                                    const char *propname);
1666 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1667                                    const char *propname);
1668 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1669                                      const char *prefix,
1670                                      struct device_node **bitclkmaster,
1671                                      struct device_node **framemaster);
1672 int snd_soc_of_get_dai_name(struct device_node *of_node,
1673                             const char **dai_name);
1674 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1675                                    struct device_node *of_node,
1676                                    struct snd_soc_dai_link *dai_link);
1677
1678 int snd_soc_add_dai_link(struct snd_soc_card *card,
1679                                 struct snd_soc_dai_link *dai_link);
1680 void snd_soc_remove_dai_link(struct snd_soc_card *card,
1681                              struct snd_soc_dai_link *dai_link);
1682
1683 int snd_soc_register_dai(struct snd_soc_component *component,
1684         struct snd_soc_dai_driver *dai_drv);
1685
1686 #include <sound/soc-dai.h>
1687
1688 #ifdef CONFIG_DEBUG_FS
1689 extern struct dentry *snd_soc_debugfs_root;
1690 #endif
1691
1692 extern const struct dev_pm_ops snd_soc_pm_ops;
1693
1694 /* Helper functions */
1695 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1696 {
1697         mutex_lock_nested(&dapm->card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
1698 }
1699
1700 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1701 {
1702         mutex_unlock(&dapm->card->dapm_mutex);
1703 }
1704
1705 #endif