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