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/workqueue.h> 19 #include <linux/interrupt.h> 20 #include <linux/kernel.h> 21 #include <sound/core.h> 22 #include <sound/pcm.h> 23 #include <sound/control.h> 24 #include <sound/ac97_codec.h> 25 26 /* 27 * Convenience kcontrol builders 28 */ 29 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \ 30 ((unsigned long)&(struct soc_mixer_control) \ 31 {.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \ 32 .invert = xinvert}) 33 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \ 34 ((unsigned long)&(struct soc_mixer_control) \ 35 {.reg = xreg, .max = xmax, .invert = xinvert}) 36 #define SOC_SINGLE(xname, reg, shift, max, invert) \ 37 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 38 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\ 39 .put = snd_soc_put_volsw, \ 40 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) } 41 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \ 42 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 43 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\ 44 SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 45 .tlv.p = (tlv_array), \ 46 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\ 47 .put = snd_soc_put_volsw, \ 48 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) } 49 #define SOC_DOUBLE(xname, xreg, shift_left, shift_right, xmax, xinvert) \ 50 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ 51 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \ 52 .put = snd_soc_put_volsw, \ 53 .private_value = (unsigned long)&(struct soc_mixer_control) \ 54 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \ 55 .max = xmax, .invert = xinvert} } 56 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \ 57 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ 58 .info = snd_soc_info_volsw_2r, \ 59 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \ 60 .private_value = (unsigned long)&(struct soc_mixer_control) \ 61 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \ 62 .max = xmax, .invert = xinvert} } 63 #define SOC_DOUBLE_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert, tlv_array) \ 64 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ 65 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\ 66 SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 67 .tlv.p = (tlv_array), \ 68 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \ 69 .put = snd_soc_put_volsw, \ 70 .private_value = (unsigned long)&(struct soc_mixer_control) \ 71 {.reg = xreg, .shift = shift_left, .rshift = shift_right,\ 72 .max = xmax, .invert = xinvert} } 73 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \ 74 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ 75 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\ 76 SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 77 .tlv.p = (tlv_array), \ 78 .info = snd_soc_info_volsw_2r, \ 79 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \ 80 .private_value = (unsigned long)&(struct soc_mixer_control) \ 81 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \ 82 .max = xmax, .invert = xinvert} } 83 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \ 84 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ 85 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \ 86 SNDRV_CTL_ELEM_ACCESS_READWRITE, \ 87 .tlv.p = (tlv_array), \ 88 .info = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \ 89 .put = snd_soc_put_volsw_s8, \ 90 .private_value = (unsigned long)&(struct soc_mixer_control) \ 91 {.reg = xreg, .min = xmin, .max = xmax} } 92 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \ 93 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \ 94 .max = xmax, .texts = xtexts } 95 #define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \ 96 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts) 97 #define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \ 98 { .max = xmax, .texts = xtexts } 99 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \ 100 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \ 101 .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues} 102 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \ 103 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues) 104 #define SOC_ENUM(xname, xenum) \ 105 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\ 106 .info = snd_soc_info_enum_double, \ 107 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \ 108 .private_value = (unsigned long)&xenum } 109 #define SOC_VALUE_ENUM(xname, xenum) \ 110 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\ 111 .info = snd_soc_info_enum_double, \ 112 .get = snd_soc_get_value_enum_double, \ 113 .put = snd_soc_put_value_enum_double, \ 114 .private_value = (unsigned long)&xenum } 115 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\ 116 xhandler_get, xhandler_put) \ 117 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 118 .info = snd_soc_info_volsw, \ 119 .get = xhandler_get, .put = xhandler_put, \ 120 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) } 121 #define SOC_DOUBLE_EXT(xname, xreg, shift_left, shift_right, xmax, xinvert,\ 122 xhandler_get, xhandler_put) \ 123 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ 124 .info = snd_soc_info_volsw, \ 125 .get = xhandler_get, .put = xhandler_put, \ 126 .private_value = (unsigned long)&(struct soc_mixer_control) \ 127 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \ 128 .max = xmax, .invert = xinvert} } 129 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\ 130 xhandler_get, xhandler_put, tlv_array) \ 131 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 132 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\ 133 SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 134 .tlv.p = (tlv_array), \ 135 .info = snd_soc_info_volsw, \ 136 .get = xhandler_get, .put = xhandler_put, \ 137 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) } 138 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \ 139 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 140 .info = snd_soc_info_bool_ext, \ 141 .get = xhandler_get, .put = xhandler_put, \ 142 .private_value = xdata } 143 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \ 144 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 145 .info = snd_soc_info_enum_ext, \ 146 .get = xhandler_get, .put = xhandler_put, \ 147 .private_value = (unsigned long)&xenum } 148 149 /* 150 * Bias levels 151 * 152 * @ON: Bias is fully on for audio playback and capture operations. 153 * @PREPARE: Prepare for audio operations. Called before DAPM switching for 154 * stream start and stop operations. 155 * @STANDBY: Low power standby state when no playback/capture operations are 156 * in progress. NOTE: The transition time between STANDBY and ON 157 * should be as fast as possible and no longer than 10ms. 158 * @OFF: Power Off. No restrictions on transition times. 159 */ 160 enum snd_soc_bias_level { 161 SND_SOC_BIAS_ON, 162 SND_SOC_BIAS_PREPARE, 163 SND_SOC_BIAS_STANDBY, 164 SND_SOC_BIAS_OFF, 165 }; 166 167 struct snd_jack; 168 struct snd_soc_card; 169 struct snd_soc_device; 170 struct snd_soc_pcm_stream; 171 struct snd_soc_ops; 172 struct snd_soc_dai_mode; 173 struct snd_soc_pcm_runtime; 174 struct snd_soc_dai; 175 struct snd_soc_platform; 176 struct snd_soc_codec; 177 struct soc_enum; 178 struct snd_soc_ac97_ops; 179 struct snd_soc_jack; 180 struct snd_soc_jack_pin; 181 #ifdef CONFIG_GPIOLIB 182 struct snd_soc_jack_gpio; 183 #endif 184 185 typedef int (*hw_write_t)(void *,const char* ,int); 186 typedef int (*hw_read_t)(void *,char* ,int); 187 188 extern struct snd_ac97_bus_ops soc_ac97_ops; 189 190 int snd_soc_register_platform(struct snd_soc_platform *platform); 191 void snd_soc_unregister_platform(struct snd_soc_platform *platform); 192 int snd_soc_register_codec(struct snd_soc_codec *codec); 193 void snd_soc_unregister_codec(struct snd_soc_codec *codec); 194 195 /* pcm <-> DAI connect */ 196 void snd_soc_free_pcms(struct snd_soc_device *socdev); 197 int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid); 198 int snd_soc_init_card(struct snd_soc_device *socdev); 199 200 /* set runtime hw params */ 201 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream, 202 const struct snd_pcm_hardware *hw); 203 204 /* Jack reporting */ 205 int snd_soc_jack_new(struct snd_soc_card *card, const char *id, int type, 206 struct snd_soc_jack *jack); 207 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask); 208 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count, 209 struct snd_soc_jack_pin *pins); 210 #ifdef CONFIG_GPIOLIB 211 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count, 212 struct snd_soc_jack_gpio *gpios); 213 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count, 214 struct snd_soc_jack_gpio *gpios); 215 #endif 216 217 /* codec register bit access */ 218 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg, 219 unsigned short mask, unsigned short value); 220 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg, 221 unsigned short mask, unsigned short value); 222 223 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec, 224 struct snd_ac97_bus_ops *ops, int num); 225 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec); 226 227 /* 228 *Controls 229 */ 230 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template, 231 void *data, char *long_name); 232 int snd_soc_add_controls(struct snd_soc_codec *codec, 233 const struct snd_kcontrol_new *controls, int num_controls); 234 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol, 235 struct snd_ctl_elem_info *uinfo); 236 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol, 237 struct snd_ctl_elem_info *uinfo); 238 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol, 239 struct snd_ctl_elem_value *ucontrol); 240 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol, 241 struct snd_ctl_elem_value *ucontrol); 242 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol, 243 struct snd_ctl_elem_value *ucontrol); 244 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol, 245 struct snd_ctl_elem_value *ucontrol); 246 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol, 247 struct snd_ctl_elem_info *uinfo); 248 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol, 249 struct snd_ctl_elem_info *uinfo); 250 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info 251 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol, 252 struct snd_ctl_elem_value *ucontrol); 253 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol, 254 struct snd_ctl_elem_value *ucontrol); 255 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol, 256 struct snd_ctl_elem_info *uinfo); 257 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol, 258 struct snd_ctl_elem_value *ucontrol); 259 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol, 260 struct snd_ctl_elem_value *ucontrol); 261 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol, 262 struct snd_ctl_elem_info *uinfo); 263 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol, 264 struct snd_ctl_elem_value *ucontrol); 265 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol, 266 struct snd_ctl_elem_value *ucontrol); 267 268 /** 269 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection 270 * 271 * @pin: name of the pin to update 272 * @mask: bits to check for in reported jack status 273 * @invert: if non-zero then pin is enabled when status is not reported 274 */ 275 struct snd_soc_jack_pin { 276 struct list_head list; 277 const char *pin; 278 int mask; 279 bool invert; 280 }; 281 282 /** 283 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection 284 * 285 * @gpio: gpio number 286 * @name: gpio name 287 * @report: value to report when jack detected 288 * @invert: report presence in low state 289 * @debouce_time: debouce time in ms 290 */ 291 #ifdef CONFIG_GPIOLIB 292 struct snd_soc_jack_gpio { 293 unsigned int gpio; 294 const char *name; 295 int report; 296 int invert; 297 int debounce_time; 298 struct snd_soc_jack *jack; 299 struct work_struct work; 300 }; 301 #endif 302 303 struct snd_soc_jack { 304 struct snd_jack *jack; 305 struct snd_soc_card *card; 306 struct list_head pins; 307 int status; 308 }; 309 310 /* SoC PCM stream information */ 311 struct snd_soc_pcm_stream { 312 char *stream_name; 313 u64 formats; /* SNDRV_PCM_FMTBIT_* */ 314 unsigned int rates; /* SNDRV_PCM_RATE_* */ 315 unsigned int rate_min; /* min rate */ 316 unsigned int rate_max; /* max rate */ 317 unsigned int channels_min; /* min channels */ 318 unsigned int channels_max; /* max channels */ 319 unsigned int active:1; /* stream is in use */ 320 }; 321 322 /* SoC audio ops */ 323 struct snd_soc_ops { 324 int (*startup)(struct snd_pcm_substream *); 325 void (*shutdown)(struct snd_pcm_substream *); 326 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *); 327 int (*hw_free)(struct snd_pcm_substream *); 328 int (*prepare)(struct snd_pcm_substream *); 329 int (*trigger)(struct snd_pcm_substream *, int); 330 }; 331 332 /* SoC Audio Codec */ 333 struct snd_soc_codec { 334 char *name; 335 struct module *owner; 336 struct mutex mutex; 337 struct device *dev; 338 struct snd_soc_device *socdev; 339 340 struct list_head list; 341 342 /* callbacks */ 343 int (*set_bias_level)(struct snd_soc_codec *, 344 enum snd_soc_bias_level level); 345 346 /* runtime */ 347 struct snd_card *card; 348 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */ 349 unsigned int active; 350 unsigned int pcm_devs; 351 void *private_data; 352 353 /* codec IO */ 354 void *control_data; /* codec control (i2c/3wire) data */ 355 unsigned int (*read)(struct snd_soc_codec *, unsigned int); 356 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int); 357 int (*display_register)(struct snd_soc_codec *, char *, 358 size_t, unsigned int); 359 hw_write_t hw_write; 360 hw_read_t hw_read; 361 void *reg_cache; 362 short reg_cache_size; 363 short reg_cache_step; 364 365 /* dapm */ 366 u32 pop_time; 367 struct list_head dapm_widgets; 368 struct list_head dapm_paths; 369 enum snd_soc_bias_level bias_level; 370 enum snd_soc_bias_level suspend_bias_level; 371 struct delayed_work delayed_work; 372 struct list_head up_list; 373 struct list_head down_list; 374 375 /* codec DAI's */ 376 struct snd_soc_dai *dai; 377 unsigned int num_dai; 378 379 #ifdef CONFIG_DEBUG_FS 380 struct dentry *debugfs_reg; 381 struct dentry *debugfs_pop_time; 382 #endif 383 }; 384 385 /* codec device */ 386 struct snd_soc_codec_device { 387 int (*probe)(struct platform_device *pdev); 388 int (*remove)(struct platform_device *pdev); 389 int (*suspend)(struct platform_device *pdev, pm_message_t state); 390 int (*resume)(struct platform_device *pdev); 391 }; 392 393 /* SoC platform interface */ 394 struct snd_soc_platform { 395 char *name; 396 struct list_head list; 397 398 int (*probe)(struct platform_device *pdev); 399 int (*remove)(struct platform_device *pdev); 400 int (*suspend)(struct snd_soc_dai *dai); 401 int (*resume)(struct snd_soc_dai *dai); 402 403 /* pcm creation and destruction */ 404 int (*pcm_new)(struct snd_card *, struct snd_soc_dai *, 405 struct snd_pcm *); 406 void (*pcm_free)(struct snd_pcm *); 407 408 /* platform stream ops */ 409 struct snd_pcm_ops *pcm_ops; 410 }; 411 412 /* SoC machine DAI configuration, glues a codec and cpu DAI together */ 413 struct snd_soc_dai_link { 414 char *name; /* Codec name */ 415 char *stream_name; /* Stream name */ 416 417 /* DAI */ 418 struct snd_soc_dai *codec_dai; 419 struct snd_soc_dai *cpu_dai; 420 421 /* machine stream operations */ 422 struct snd_soc_ops *ops; 423 424 /* codec/machine specific init - e.g. add machine controls */ 425 int (*init)(struct snd_soc_codec *codec); 426 427 /* Symmetry requirements */ 428 unsigned int symmetric_rates:1; 429 430 /* Symmetry data - only valid if symmetry is being enforced */ 431 unsigned int rate; 432 433 /* DAI pcm */ 434 struct snd_pcm *pcm; 435 }; 436 437 /* SoC card */ 438 struct snd_soc_card { 439 char *name; 440 struct device *dev; 441 442 struct list_head list; 443 444 int instantiated; 445 446 int (*probe)(struct platform_device *pdev); 447 int (*remove)(struct platform_device *pdev); 448 449 /* the pre and post PM functions are used to do any PM work before and 450 * after the codec and DAI's do any PM work. */ 451 int (*suspend_pre)(struct platform_device *pdev, pm_message_t state); 452 int (*suspend_post)(struct platform_device *pdev, pm_message_t state); 453 int (*resume_pre)(struct platform_device *pdev); 454 int (*resume_post)(struct platform_device *pdev); 455 456 /* callbacks */ 457 int (*set_bias_level)(struct snd_soc_card *, 458 enum snd_soc_bias_level level); 459 460 /* CPU <--> Codec DAI links */ 461 struct snd_soc_dai_link *dai_link; 462 int num_links; 463 464 struct snd_soc_device *socdev; 465 466 struct snd_soc_codec *codec; 467 468 struct snd_soc_platform *platform; 469 struct delayed_work delayed_work; 470 struct work_struct deferred_resume_work; 471 }; 472 473 /* SoC Device - the audio subsystem */ 474 struct snd_soc_device { 475 struct device *dev; 476 struct snd_soc_card *card; 477 struct snd_soc_codec_device *codec_dev; 478 void *codec_data; 479 }; 480 481 /* runtime channel data */ 482 struct snd_soc_pcm_runtime { 483 struct snd_soc_dai_link *dai; 484 struct snd_soc_device *socdev; 485 }; 486 487 /* mixer control */ 488 struct soc_mixer_control { 489 int min, max; 490 unsigned int reg, rreg, shift, rshift, invert; 491 }; 492 493 /* enumerated kcontrol */ 494 struct soc_enum { 495 unsigned short reg; 496 unsigned short reg2; 497 unsigned char shift_l; 498 unsigned char shift_r; 499 unsigned int max; 500 unsigned int mask; 501 const char **texts; 502 const unsigned int *values; 503 void *dapm; 504 }; 505 506 /* codec IO */ 507 static inline unsigned int snd_soc_read(struct snd_soc_codec *codec, 508 unsigned int reg) 509 { 510 return codec->read(codec, reg); 511 } 512 513 static inline unsigned int snd_soc_write(struct snd_soc_codec *codec, 514 unsigned int reg, unsigned int val) 515 { 516 return codec->write(codec, reg, val); 517 } 518 519 #include <sound/soc-dai.h> 520 521 #endif 522