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