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