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_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\ 200 xhandler_get, xhandler_put) \ 201 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 202 .info = snd_soc_info_volsw, \ 203 .get = xhandler_get, .put = xhandler_put, \ 204 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) } 205 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\ 206 xhandler_get, xhandler_put) \ 207 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ 208 .info = snd_soc_info_volsw, \ 209 .get = xhandler_get, .put = xhandler_put, \ 210 .private_value = \ 211 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) } 212 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\ 213 xhandler_get, xhandler_put, tlv_array) \ 214 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 215 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\ 216 SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 217 .tlv.p = (tlv_array), \ 218 .info = snd_soc_info_volsw, \ 219 .get = xhandler_get, .put = xhandler_put, \ 220 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) } 221 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\ 222 xhandler_get, xhandler_put, tlv_array) \ 223 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ 224 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \ 225 SNDRV_CTL_ELEM_ACCESS_READWRITE, \ 226 .tlv.p = (tlv_array), \ 227 .info = snd_soc_info_volsw, \ 228 .get = xhandler_get, .put = xhandler_put, \ 229 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \ 230 xmax, xinvert, 0) } 231 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\ 232 xhandler_get, xhandler_put, tlv_array) \ 233 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ 234 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \ 235 SNDRV_CTL_ELEM_ACCESS_READWRITE, \ 236 .tlv.p = (tlv_array), \ 237 .info = snd_soc_info_volsw, \ 238 .get = xhandler_get, .put = xhandler_put, \ 239 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \ 240 xmax, xinvert) } 241 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \ 242 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 243 .info = snd_soc_info_bool_ext, \ 244 .get = xhandler_get, .put = xhandler_put, \ 245 .private_value = xdata } 246 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \ 247 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 248 .info = snd_soc_info_enum_double, \ 249 .get = xhandler_get, .put = xhandler_put, \ 250 .private_value = (unsigned long)&xenum } 251 252 #define SND_SOC_BYTES(xname, xbase, xregs) \ 253 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 254 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \ 255 .put = snd_soc_bytes_put, .private_value = \ 256 ((unsigned long)&(struct soc_bytes) \ 257 {.base = xbase, .num_regs = xregs }) } 258 259 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask) \ 260 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 261 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \ 262 .put = snd_soc_bytes_put, .private_value = \ 263 ((unsigned long)&(struct soc_bytes) \ 264 {.base = xbase, .num_regs = xregs, \ 265 .mask = xmask }) } 266 267 #define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \ 268 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 269 .info = snd_soc_bytes_info_ext, \ 270 .get = xhandler_get, .put = xhandler_put, \ 271 .private_value = (unsigned long)&(struct soc_bytes_ext) \ 272 {.max = xcount} } 273 274 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \ 275 xmin, xmax, xinvert) \ 276 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ 277 .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \ 278 .put = snd_soc_put_xr_sx, \ 279 .private_value = (unsigned long)&(struct soc_mreg_control) \ 280 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \ 281 .invert = xinvert, .min = xmin, .max = xmax} } 282 283 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \ 284 SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \ 285 snd_soc_get_strobe, snd_soc_put_strobe) 286 287 /* 288 * Simplified versions of above macros, declaring a struct and calculating 289 * ARRAY_SIZE internally 290 */ 291 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \ 292 const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \ 293 ARRAY_SIZE(xtexts), xtexts) 294 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \ 295 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts) 296 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \ 297 const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts) 298 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \ 299 const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \ 300 ARRAY_SIZE(xtexts), xtexts, xvalues) 301 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \ 302 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues) 303 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \ 304 const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts) 305 306 /* 307 * Component probe and remove ordering levels for components with runtime 308 * dependencies. 309 */ 310 #define SND_SOC_COMP_ORDER_FIRST -2 311 #define SND_SOC_COMP_ORDER_EARLY -1 312 #define SND_SOC_COMP_ORDER_NORMAL 0 313 #define SND_SOC_COMP_ORDER_LATE 1 314 #define SND_SOC_COMP_ORDER_LAST 2 315 316 /* 317 * Bias levels 318 * 319 * @ON: Bias is fully on for audio playback and capture operations. 320 * @PREPARE: Prepare for audio operations. Called before DAPM switching for 321 * stream start and stop operations. 322 * @STANDBY: Low power standby state when no playback/capture operations are 323 * in progress. NOTE: The transition time between STANDBY and ON 324 * should be as fast as possible and no longer than 10ms. 325 * @OFF: Power Off. No restrictions on transition times. 326 */ 327 enum snd_soc_bias_level { 328 SND_SOC_BIAS_OFF = 0, 329 SND_SOC_BIAS_STANDBY = 1, 330 SND_SOC_BIAS_PREPARE = 2, 331 SND_SOC_BIAS_ON = 3, 332 }; 333 334 struct device_node; 335 struct snd_jack; 336 struct snd_soc_card; 337 struct snd_soc_pcm_stream; 338 struct snd_soc_ops; 339 struct snd_soc_pcm_runtime; 340 struct snd_soc_dai; 341 struct snd_soc_dai_driver; 342 struct snd_soc_platform; 343 struct snd_soc_dai_link; 344 struct snd_soc_platform_driver; 345 struct snd_soc_codec; 346 struct snd_soc_codec_driver; 347 struct snd_soc_component; 348 struct snd_soc_component_driver; 349 struct soc_enum; 350 struct snd_soc_jack; 351 struct snd_soc_jack_zone; 352 struct snd_soc_jack_pin; 353 #include <sound/soc-dapm.h> 354 #include <sound/soc-dpcm.h> 355 356 struct snd_soc_jack_gpio; 357 358 typedef int (*hw_write_t)(void *,const char* ,int); 359 360 extern struct snd_ac97_bus_ops *soc_ac97_ops; 361 362 enum snd_soc_pcm_subclass { 363 SND_SOC_PCM_CLASS_PCM = 0, 364 SND_SOC_PCM_CLASS_BE = 1, 365 }; 366 367 enum snd_soc_card_subclass { 368 SND_SOC_CARD_CLASS_INIT = 0, 369 SND_SOC_CARD_CLASS_RUNTIME = 1, 370 }; 371 372 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id, 373 int source, unsigned int freq, int dir); 374 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source, 375 unsigned int freq_in, unsigned int freq_out); 376 377 int snd_soc_register_card(struct snd_soc_card *card); 378 int snd_soc_unregister_card(struct snd_soc_card *card); 379 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card); 380 int snd_soc_suspend(struct device *dev); 381 int snd_soc_resume(struct device *dev); 382 int snd_soc_poweroff(struct device *dev); 383 int snd_soc_register_platform(struct device *dev, 384 const struct snd_soc_platform_driver *platform_drv); 385 int devm_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 705 /* runtime */ 706 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */ 707 unsigned int cache_bypass:1; /* Suppress access to the cache */ 708 unsigned int suspended:1; /* Codec is in suspend PM state */ 709 unsigned int probed:1; /* Codec has been probed */ 710 unsigned int ac97_registered:1; /* Codec has been AC97 registered */ 711 unsigned int ac97_created:1; /* Codec has been created by SoC */ 712 unsigned int cache_init:1; /* codec cache has been initialized */ 713 u32 cache_only; /* Suppress writes to hardware */ 714 u32 cache_sync; /* Cache needs to be synced to hardware */ 715 716 /* codec IO */ 717 void *control_data; /* codec control (i2c/3wire) data */ 718 hw_write_t hw_write; 719 void *reg_cache; 720 struct mutex cache_rw_mutex; 721 722 /* component */ 723 struct snd_soc_component component; 724 725 /* dapm */ 726 struct snd_soc_dapm_context dapm; 727 728 #ifdef CONFIG_DEBUG_FS 729 struct dentry *debugfs_codec_root; 730 struct dentry *debugfs_reg; 731 #endif 732 }; 733 734 /* codec driver */ 735 struct snd_soc_codec_driver { 736 737 /* driver ops */ 738 int (*probe)(struct snd_soc_codec *); 739 int (*remove)(struct snd_soc_codec *); 740 int (*suspend)(struct snd_soc_codec *); 741 int (*resume)(struct snd_soc_codec *); 742 struct snd_soc_component_driver component_driver; 743 744 /* Default control and setup, added after probe() is run */ 745 const struct snd_kcontrol_new *controls; 746 int num_controls; 747 const struct snd_soc_dapm_widget *dapm_widgets; 748 int num_dapm_widgets; 749 const struct snd_soc_dapm_route *dapm_routes; 750 int num_dapm_routes; 751 752 /* codec wide operations */ 753 int (*set_sysclk)(struct snd_soc_codec *codec, 754 int clk_id, int source, unsigned int freq, int dir); 755 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source, 756 unsigned int freq_in, unsigned int freq_out); 757 758 /* codec IO */ 759 struct regmap *(*get_regmap)(struct device *); 760 unsigned int (*read)(struct snd_soc_codec *, unsigned int); 761 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int); 762 unsigned int reg_cache_size; 763 short reg_cache_step; 764 short reg_word_size; 765 const void *reg_cache_default; 766 767 /* codec bias level */ 768 int (*set_bias_level)(struct snd_soc_codec *, 769 enum snd_soc_bias_level level); 770 bool idle_bias_off; 771 772 void (*seq_notifier)(struct snd_soc_dapm_context *, 773 enum snd_soc_dapm_type, int); 774 775 /* codec stream completion event */ 776 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event); 777 778 bool ignore_pmdown_time; /* Doesn't benefit from pmdown delay */ 779 780 /* probe ordering - for components with runtime dependencies */ 781 int probe_order; 782 int remove_order; 783 }; 784 785 /* SoC platform interface */ 786 struct snd_soc_platform_driver { 787 788 int (*probe)(struct snd_soc_platform *); 789 int (*remove)(struct snd_soc_platform *); 790 int (*suspend)(struct snd_soc_dai *dai); 791 int (*resume)(struct snd_soc_dai *dai); 792 struct snd_soc_component_driver component_driver; 793 794 /* pcm creation and destruction */ 795 int (*pcm_new)(struct snd_soc_pcm_runtime *); 796 void (*pcm_free)(struct snd_pcm *); 797 798 /* Default control and setup, added after probe() is run */ 799 const struct snd_kcontrol_new *controls; 800 int num_controls; 801 const struct snd_soc_dapm_widget *dapm_widgets; 802 int num_dapm_widgets; 803 const struct snd_soc_dapm_route *dapm_routes; 804 int num_dapm_routes; 805 806 /* 807 * For platform caused delay reporting. 808 * Optional. 809 */ 810 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *, 811 struct snd_soc_dai *); 812 813 /* platform stream pcm ops */ 814 const struct snd_pcm_ops *ops; 815 816 /* platform stream compress ops */ 817 const struct snd_compr_ops *compr_ops; 818 819 /* platform stream completion event */ 820 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event); 821 822 /* probe ordering - for components with runtime dependencies */ 823 int probe_order; 824 int remove_order; 825 826 /* platform IO - used for platform DAPM */ 827 unsigned int (*read)(struct snd_soc_platform *, unsigned int); 828 int (*write)(struct snd_soc_platform *, unsigned int, unsigned int); 829 int (*bespoke_trigger)(struct snd_pcm_substream *, int); 830 }; 831 832 struct snd_soc_platform { 833 const char *name; 834 int id; 835 struct device *dev; 836 const struct snd_soc_platform_driver *driver; 837 838 unsigned int suspended:1; /* platform is suspended */ 839 unsigned int probed:1; 840 841 struct snd_soc_card *card; 842 struct list_head list; 843 struct list_head card_list; 844 845 struct snd_soc_component component; 846 847 struct snd_soc_dapm_context dapm; 848 849 #ifdef CONFIG_DEBUG_FS 850 struct dentry *debugfs_platform_root; 851 #endif 852 }; 853 854 struct snd_soc_dai_link { 855 /* config - must be set by machine driver */ 856 const char *name; /* Codec name */ 857 const char *stream_name; /* Stream name */ 858 /* 859 * You MAY specify the link's CPU-side device, either by device name, 860 * or by DT/OF node, but not both. If this information is omitted, 861 * the CPU-side DAI is matched using .cpu_dai_name only, which hence 862 * must be globally unique. These fields are currently typically used 863 * only for codec to codec links, or systems using device tree. 864 */ 865 const char *cpu_name; 866 const struct device_node *cpu_of_node; 867 /* 868 * You MAY specify the DAI name of the CPU DAI. If this information is 869 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node 870 * only, which only works well when that device exposes a single DAI. 871 */ 872 const char *cpu_dai_name; 873 /* 874 * You MUST specify the link's codec, either by device name, or by 875 * DT/OF node, but not both. 876 */ 877 const char *codec_name; 878 const struct device_node *codec_of_node; 879 /* You MUST specify the DAI name within the codec */ 880 const char *codec_dai_name; 881 /* 882 * You MAY specify the link's platform/PCM/DMA driver, either by 883 * device name, or by DT/OF node, but not both. Some forms of link 884 * do not need a platform. 885 */ 886 const char *platform_name; 887 const struct device_node *platform_of_node; 888 int be_id; /* optional ID for machine driver BE identification */ 889 890 const struct snd_soc_pcm_stream *params; 891 892 unsigned int dai_fmt; /* format to set on init */ 893 894 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */ 895 896 /* Keep DAI active over suspend */ 897 unsigned int ignore_suspend:1; 898 899 /* Symmetry requirements */ 900 unsigned int symmetric_rates:1; 901 unsigned int symmetric_channels:1; 902 unsigned int symmetric_samplebits:1; 903 904 /* Do not create a PCM for this DAI link (Backend link) */ 905 unsigned int no_pcm:1; 906 907 /* This DAI link can route to other DAI links at runtime (Frontend)*/ 908 unsigned int dynamic:1; 909 910 /* DPCM capture and Playback support */ 911 unsigned int dpcm_capture:1; 912 unsigned int dpcm_playback:1; 913 914 /* pmdown_time is ignored at stop */ 915 unsigned int ignore_pmdown_time:1; 916 917 /* codec/machine specific init - e.g. add machine controls */ 918 int (*init)(struct snd_soc_pcm_runtime *rtd); 919 920 /* optional hw_params re-writing for BE and FE sync */ 921 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd, 922 struct snd_pcm_hw_params *params); 923 924 /* machine stream operations */ 925 const struct snd_soc_ops *ops; 926 const struct snd_soc_compr_ops *compr_ops; 927 928 /* For unidirectional dai links */ 929 bool playback_only; 930 bool capture_only; 931 }; 932 933 struct snd_soc_codec_conf { 934 /* 935 * specify device either by device name, or by 936 * DT/OF node, but not both. 937 */ 938 const char *dev_name; 939 const struct device_node *of_node; 940 941 /* 942 * optional map of kcontrol, widget and path name prefixes that are 943 * associated per device 944 */ 945 const char *name_prefix; 946 }; 947 948 struct snd_soc_aux_dev { 949 const char *name; /* Codec name */ 950 951 /* 952 * specify multi-codec either by device name, or by 953 * DT/OF node, but not both. 954 */ 955 const char *codec_name; 956 const struct device_node *codec_of_node; 957 958 /* codec/machine specific init - e.g. add machine controls */ 959 int (*init)(struct snd_soc_dapm_context *dapm); 960 }; 961 962 /* SoC card */ 963 struct snd_soc_card { 964 const char *name; 965 const char *long_name; 966 const char *driver_name; 967 struct device *dev; 968 struct snd_card *snd_card; 969 struct module *owner; 970 971 struct mutex mutex; 972 struct mutex dapm_mutex; 973 974 bool instantiated; 975 976 int (*probe)(struct snd_soc_card *card); 977 int (*late_probe)(struct snd_soc_card *card); 978 int (*remove)(struct snd_soc_card *card); 979 980 /* the pre and post PM functions are used to do any PM work before and 981 * after the codec and DAI's do any PM work. */ 982 int (*suspend_pre)(struct snd_soc_card *card); 983 int (*suspend_post)(struct snd_soc_card *card); 984 int (*resume_pre)(struct snd_soc_card *card); 985 int (*resume_post)(struct snd_soc_card *card); 986 987 /* callbacks */ 988 int (*set_bias_level)(struct snd_soc_card *, 989 struct snd_soc_dapm_context *dapm, 990 enum snd_soc_bias_level level); 991 int (*set_bias_level_post)(struct snd_soc_card *, 992 struct snd_soc_dapm_context *dapm, 993 enum snd_soc_bias_level level); 994 995 long pmdown_time; 996 997 /* CPU <--> Codec DAI links */ 998 struct snd_soc_dai_link *dai_link; 999 int num_links; 1000 struct snd_soc_pcm_runtime *rtd; 1001 int num_rtd; 1002 1003 /* optional codec specific configuration */ 1004 struct snd_soc_codec_conf *codec_conf; 1005 int num_configs; 1006 1007 /* 1008 * optional auxiliary devices such as amplifiers or codecs with DAI 1009 * link unused 1010 */ 1011 struct snd_soc_aux_dev *aux_dev; 1012 int num_aux_devs; 1013 struct snd_soc_pcm_runtime *rtd_aux; 1014 int num_aux_rtd; 1015 1016 const struct snd_kcontrol_new *controls; 1017 int num_controls; 1018 1019 /* 1020 * Card-specific routes and widgets. 1021 */ 1022 const struct snd_soc_dapm_widget *dapm_widgets; 1023 int num_dapm_widgets; 1024 const struct snd_soc_dapm_route *dapm_routes; 1025 int num_dapm_routes; 1026 bool fully_routed; 1027 1028 struct work_struct deferred_resume_work; 1029 1030 /* lists of probed devices belonging to this card */ 1031 struct list_head codec_dev_list; 1032 struct list_head platform_dev_list; 1033 1034 struct list_head widgets; 1035 struct list_head paths; 1036 struct list_head dapm_list; 1037 struct list_head dapm_dirty; 1038 1039 /* Generic DAPM context for the card */ 1040 struct snd_soc_dapm_context dapm; 1041 struct snd_soc_dapm_stats dapm_stats; 1042 struct snd_soc_dapm_update *update; 1043 1044 #ifdef CONFIG_DEBUG_FS 1045 struct dentry *debugfs_card_root; 1046 struct dentry *debugfs_pop_time; 1047 #endif 1048 u32 pop_time; 1049 1050 void *drvdata; 1051 }; 1052 1053 /* SoC machine DAI configuration, glues a codec and cpu DAI together */ 1054 struct snd_soc_pcm_runtime { 1055 struct device *dev; 1056 struct snd_soc_card *card; 1057 struct snd_soc_dai_link *dai_link; 1058 struct mutex pcm_mutex; 1059 enum snd_soc_pcm_subclass pcm_subclass; 1060 struct snd_pcm_ops ops; 1061 1062 unsigned int dev_registered:1; 1063 1064 /* Dynamic PCM BE runtime data */ 1065 struct snd_soc_dpcm_runtime dpcm[2]; 1066 int fe_compr; 1067 1068 long pmdown_time; 1069 unsigned char pop_wait:1; 1070 1071 /* runtime devices */ 1072 struct snd_pcm *pcm; 1073 struct snd_compr *compr; 1074 struct snd_soc_codec *codec; 1075 struct snd_soc_platform *platform; 1076 struct snd_soc_dai *codec_dai; 1077 struct snd_soc_dai *cpu_dai; 1078 1079 struct delayed_work delayed_work; 1080 #ifdef CONFIG_DEBUG_FS 1081 struct dentry *debugfs_dpcm_root; 1082 struct dentry *debugfs_dpcm_state; 1083 #endif 1084 }; 1085 1086 /* mixer control */ 1087 struct soc_mixer_control { 1088 int min, max, platform_max; 1089 int reg, rreg; 1090 unsigned int shift, rshift; 1091 unsigned int sign_bit; 1092 unsigned int invert:1; 1093 unsigned int autodisable:1; 1094 }; 1095 1096 struct soc_bytes { 1097 int base; 1098 int num_regs; 1099 u32 mask; 1100 }; 1101 1102 struct soc_bytes_ext { 1103 int max; 1104 }; 1105 1106 /* multi register control */ 1107 struct soc_mreg_control { 1108 long min, max; 1109 unsigned int regbase, regcount, nbits, invert; 1110 }; 1111 1112 /* enumerated kcontrol */ 1113 struct soc_enum { 1114 int reg; 1115 unsigned char shift_l; 1116 unsigned char shift_r; 1117 unsigned int items; 1118 unsigned int mask; 1119 const char * const *texts; 1120 const unsigned int *values; 1121 }; 1122 1123 /** 1124 * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in 1125 * @component: The component to cast to a CODEC 1126 * 1127 * This function must only be used on components that are known to be CODECs. 1128 * Otherwise the behavior is undefined. 1129 */ 1130 static inline struct snd_soc_codec *snd_soc_component_to_codec( 1131 struct snd_soc_component *component) 1132 { 1133 return container_of(component, struct snd_soc_codec, component); 1134 } 1135 1136 /** 1137 * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in 1138 * @component: The component to cast to a platform 1139 * 1140 * This function must only be used on components that are known to be platforms. 1141 * Otherwise the behavior is undefined. 1142 */ 1143 static inline struct snd_soc_platform *snd_soc_component_to_platform( 1144 struct snd_soc_component *component) 1145 { 1146 return container_of(component, struct snd_soc_platform, component); 1147 } 1148 1149 /* codec IO */ 1150 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg); 1151 int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg, 1152 unsigned int val); 1153 1154 /* component IO */ 1155 int snd_soc_component_read(struct snd_soc_component *component, 1156 unsigned int reg, unsigned int *val); 1157 int snd_soc_component_write(struct snd_soc_component *component, 1158 unsigned int reg, unsigned int val); 1159 int snd_soc_component_update_bits(struct snd_soc_component *component, 1160 unsigned int reg, unsigned int mask, unsigned int val); 1161 int snd_soc_component_update_bits_async(struct snd_soc_component *component, 1162 unsigned int reg, unsigned int mask, unsigned int val); 1163 void snd_soc_component_async_complete(struct snd_soc_component *component); 1164 int snd_soc_component_test_bits(struct snd_soc_component *component, 1165 unsigned int reg, unsigned int mask, unsigned int value); 1166 1167 int snd_soc_component_init_io(struct snd_soc_component *component, 1168 struct regmap *regmap); 1169 1170 /* device driver data */ 1171 1172 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card, 1173 void *data) 1174 { 1175 card->drvdata = data; 1176 } 1177 1178 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card) 1179 { 1180 return card->drvdata; 1181 } 1182 1183 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec, 1184 void *data) 1185 { 1186 dev_set_drvdata(codec->dev, data); 1187 } 1188 1189 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec) 1190 { 1191 return dev_get_drvdata(codec->dev); 1192 } 1193 1194 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform, 1195 void *data) 1196 { 1197 dev_set_drvdata(platform->dev, data); 1198 } 1199 1200 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform) 1201 { 1202 return dev_get_drvdata(platform->dev); 1203 } 1204 1205 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd, 1206 void *data) 1207 { 1208 dev_set_drvdata(rtd->dev, data); 1209 } 1210 1211 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd) 1212 { 1213 return dev_get_drvdata(rtd->dev); 1214 } 1215 1216 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card) 1217 { 1218 INIT_LIST_HEAD(&card->codec_dev_list); 1219 INIT_LIST_HEAD(&card->platform_dev_list); 1220 INIT_LIST_HEAD(&card->widgets); 1221 INIT_LIST_HEAD(&card->paths); 1222 INIT_LIST_HEAD(&card->dapm_list); 1223 } 1224 1225 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc) 1226 { 1227 if (mc->reg == mc->rreg && mc->shift == mc->rshift) 1228 return 0; 1229 /* 1230 * mc->reg == mc->rreg && mc->shift != mc->rshift, or 1231 * mc->reg != mc->rreg means that the control is 1232 * stereo (bits in one register or in two registers) 1233 */ 1234 return 1; 1235 } 1236 1237 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e, 1238 unsigned int val) 1239 { 1240 unsigned int i; 1241 1242 if (!e->values) 1243 return val; 1244 1245 for (i = 0; i < e->items; i++) 1246 if (val == e->values[i]) 1247 return i; 1248 1249 return 0; 1250 } 1251 1252 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e, 1253 unsigned int item) 1254 { 1255 if (!e->values) 1256 return item; 1257 1258 return e->values[item]; 1259 } 1260 1261 static inline bool snd_soc_component_is_active( 1262 struct snd_soc_component *component) 1263 { 1264 return component->active != 0; 1265 } 1266 1267 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec) 1268 { 1269 return snd_soc_component_is_active(&codec->component); 1270 } 1271 1272 /** 1273 * snd_soc_kcontrol_component() - Returns the component that registered the 1274 * control 1275 * @kcontrol: The control for which to get the component 1276 * 1277 * Note: This function will work correctly if the control has been registered 1278 * for a component. Either with snd_soc_add_codec_controls() or 1279 * snd_soc_add_platform_controls() or via table based setup for either a 1280 * CODEC, a platform or component driver. Otherwise the behavior is undefined. 1281 */ 1282 static inline struct snd_soc_component *snd_soc_kcontrol_component( 1283 struct snd_kcontrol *kcontrol) 1284 { 1285 return snd_kcontrol_chip(kcontrol); 1286 } 1287 1288 /** 1289 * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control 1290 * @kcontrol: The control for which to get the CODEC 1291 * 1292 * Note: This function will only work correctly if the control has been 1293 * registered with snd_soc_add_codec_controls() or via table based setup of 1294 * snd_soc_codec_driver. Otherwise the behavior is undefined. 1295 */ 1296 static inline struct snd_soc_codec *snd_soc_kcontrol_codec( 1297 struct snd_kcontrol *kcontrol) 1298 { 1299 return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol)); 1300 } 1301 1302 /** 1303 * snd_soc_kcontrol_platform() - Returns the platform that registerd the control 1304 * @kcontrol: The control for which to get the platform 1305 * 1306 * Note: This function will only work correctly if the control has been 1307 * registered with snd_soc_add_platform_controls() or via table based setup of 1308 * a snd_soc_platform_driver. Otherwise the behavior is undefined. 1309 */ 1310 static inline struct snd_soc_platform *snd_soc_kcontrol_platform( 1311 struct snd_kcontrol *kcontrol) 1312 { 1313 return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol)); 1314 } 1315 1316 int snd_soc_util_init(void); 1317 void snd_soc_util_exit(void); 1318 1319 int snd_soc_of_parse_card_name(struct snd_soc_card *card, 1320 const char *propname); 1321 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card, 1322 const char *propname); 1323 int snd_soc_of_parse_tdm_slot(struct device_node *np, 1324 unsigned int *slots, 1325 unsigned int *slot_width); 1326 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card, 1327 const char *propname); 1328 unsigned int snd_soc_of_parse_daifmt(struct device_node *np, 1329 const char *prefix, 1330 struct device_node **bitclkmaster, 1331 struct device_node **framemaster); 1332 int snd_soc_of_get_dai_name(struct device_node *of_node, 1333 const char **dai_name); 1334 1335 #include <sound/soc-dai.h> 1336 1337 #ifdef CONFIG_DEBUG_FS 1338 extern struct dentry *snd_soc_debugfs_root; 1339 #endif 1340 1341 extern const struct dev_pm_ops snd_soc_pm_ops; 1342 1343 /* Helper functions */ 1344 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm) 1345 { 1346 mutex_lock(&dapm->card->dapm_mutex); 1347 } 1348 1349 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm) 1350 { 1351 mutex_unlock(&dapm->card->dapm_mutex); 1352 } 1353 1354 #endif 1355