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 <sound/driver.h> 19 #include <sound/core.h> 20 #include <sound/pcm.h> 21 #include <sound/control.h> 22 #include <sound/ac97_codec.h> 23 24 #define SND_SOC_VERSION "0.11.8" 25 26 /* 27 * Convenience kcontrol builders 28 */ 29 #define SOC_SINGLE_VALUE(reg,shift,mask,invert) ((reg) | ((shift) << 8) |\ 30 ((shift) << 12) | ((mask) << 16) | ((invert) << 24)) 31 #define SOC_SINGLE_VALUE_EXT(reg,mask,invert) ((reg) | ((mask) << 16) |\ 32 ((invert) << 31)) 33 #define SOC_SINGLE(xname, reg, shift, mask, invert) \ 34 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 35 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\ 36 .put = snd_soc_put_volsw, \ 37 .private_value = SOC_SINGLE_VALUE(reg, shift, mask, invert) } 38 #define SOC_DOUBLE(xname, reg, shift_left, shift_right, mask, invert) \ 39 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ 40 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \ 41 .put = snd_soc_put_volsw, \ 42 .private_value = (reg) | ((shift_left) << 8) | \ 43 ((shift_right) << 12) | ((mask) << 16) | ((invert) << 24) } 44 #define SOC_DOUBLE_R(xname, reg_left, reg_right, shift, mask, invert) \ 45 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ 46 .info = snd_soc_info_volsw_2r, \ 47 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \ 48 .private_value = (reg_left) | ((shift) << 8) | \ 49 ((mask) << 12) | ((invert) << 20) | ((reg_right) << 24) } 50 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xtexts) \ 51 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \ 52 .mask = xmask, .texts = xtexts } 53 #define SOC_ENUM_SINGLE(xreg, xshift, xmask, xtexts) \ 54 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xtexts) 55 #define SOC_ENUM_SINGLE_EXT(xmask, xtexts) \ 56 { .mask = xmask, .texts = xtexts } 57 #define SOC_ENUM(xname, xenum) \ 58 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\ 59 .info = snd_soc_info_enum_double, \ 60 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \ 61 .private_value = (unsigned long)&xenum } 62 #define SOC_SINGLE_EXT(xname, xreg, xmask, xinvert,\ 63 xhandler_get, xhandler_put) \ 64 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 65 .info = snd_soc_info_volsw_ext, \ 66 .get = xhandler_get, .put = xhandler_put, \ 67 .private_value = SOC_SINGLE_VALUE_EXT(xreg, xmask, xinvert) } 68 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \ 69 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 70 .info = snd_soc_info_bool_ext, \ 71 .get = xhandler_get, .put = xhandler_put, \ 72 .private_value = xdata } 73 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \ 74 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 75 .info = snd_soc_info_enum_ext, \ 76 .get = xhandler_get, .put = xhandler_put, \ 77 .private_value = (unsigned long)&xenum } 78 79 /* 80 * Digital Audio Interface (DAI) types 81 */ 82 #define SND_SOC_DAI_AC97 0x1 83 #define SND_SOC_DAI_I2S 0x2 84 #define SND_SOC_DAI_PCM 0x4 85 86 /* 87 * DAI hardware audio formats 88 */ 89 #define SND_SOC_DAIFMT_I2S (1 << 0) /* I2S mode */ 90 #define SND_SOC_DAIFMT_RIGHT_J (1 << 1) /* Right justified mode */ 91 #define SND_SOC_DAIFMT_LEFT_J (1 << 2) /* Left Justified mode */ 92 #define SND_SOC_DAIFMT_DSP_A (1 << 3) /* L data msb after FRM or LRC */ 93 #define SND_SOC_DAIFMT_DSP_B (1 << 4) /* L data msb during FRM or LRC */ 94 #define SND_SOC_DAIFMT_AC97 (1 << 5) /* AC97 */ 95 96 /* 97 * DAI hardware signal inversions 98 */ 99 #define SND_SOC_DAIFMT_NB_NF (1 << 8) /* normal bit clock + frame */ 100 #define SND_SOC_DAIFMT_NB_IF (1 << 9) /* normal bclk + inv frm */ 101 #define SND_SOC_DAIFMT_IB_NF (1 << 10) /* invert bclk + nor frm */ 102 #define SND_SOC_DAIFMT_IB_IF (1 << 11) /* invert bclk + frm */ 103 104 /* 105 * DAI hardware clock masters 106 * This is wrt the codec, the inverse is true for the interface 107 * i.e. if the codec is clk and frm master then the interface is 108 * clk and frame slave. 109 */ 110 #define SND_SOC_DAIFMT_CBM_CFM (1 << 12) /* codec clk & frm master */ 111 #define SND_SOC_DAIFMT_CBS_CFM (1 << 13) /* codec clk slave & frm master */ 112 #define SND_SOC_DAIFMT_CBM_CFS (1 << 14) /* codec clk master & frame slave */ 113 #define SND_SOC_DAIFMT_CBS_CFS (1 << 15) /* codec clk & frm slave */ 114 115 #define SND_SOC_DAIFMT_FORMAT_MASK 0x00ff 116 #define SND_SOC_DAIFMT_INV_MASK 0x0f00 117 #define SND_SOC_DAIFMT_CLOCK_MASK 0xf000 118 119 /* 120 * DAI hardware audio direction 121 */ 122 #define SND_SOC_DAIDIR_PLAYBACK 0x1 123 #define SND_SOC_DAIDIR_CAPTURE 0x2 124 125 /* 126 * DAI hardware Time Division Multiplexing (TDM) Slots 127 * Left and Right data word positions 128 * This is measured in words (sample size) and not bits. 129 */ 130 #define SND_SOC_DAITDM_LRDW(l,r) ((l << 8) | r) 131 132 /* 133 * DAI hardware clock ratios 134 * bit clock can either be a generated by dividing mclk or 135 * by multiplying sample rate, hence there are 2 definitions below 136 * depending on codec type. 137 */ 138 /* ratio of sample rate to mclk/sysclk */ 139 #define SND_SOC_FS_ALL 0xffff /* all mclk supported */ 140 141 /* bit clock dividers */ 142 #define SND_SOC_FSBD(x) (1 << (x - 1)) /* ratio mclk:bclk */ 143 #define SND_SOC_FSBD_REAL(x) (ffs(x)) 144 #define SND_SOC_FSBD_ALL 0xffff /* all bit clock dividers supported */ 145 146 /* bit clock ratio to sample rate */ 147 #define SND_SOC_FSB(x) (1 << ((x - 16) / 16)) 148 #define SND_SOC_FSB_REAL(x) (((ffs(x) - 1) * 16) + 16) 149 /* all bclk ratios supported */ 150 #define SND_SOC_FSB_ALL SND_SOC_FSBD_ALL 151 152 /* 153 * DAI hardware flags 154 */ 155 /* use bfs mclk divider mode, else sample rate ratio */ 156 #define SND_SOC_DAI_BFS_DIV 0x1 157 158 /* 159 * AC97 codec ID's bitmask 160 */ 161 #define SND_SOC_DAI_AC97_ID0 (1 << 0) 162 #define SND_SOC_DAI_AC97_ID1 (1 << 1) 163 #define SND_SOC_DAI_AC97_ID2 (1 << 2) 164 #define SND_SOC_DAI_AC97_ID3 (1 << 3) 165 166 struct snd_soc_device; 167 struct snd_soc_pcm_stream; 168 struct snd_soc_ops; 169 struct snd_soc_dai_mode; 170 struct snd_soc_pcm_runtime; 171 struct snd_soc_codec_dai; 172 struct snd_soc_cpu_dai; 173 struct snd_soc_codec; 174 struct snd_soc_machine_config; 175 struct soc_enum; 176 struct snd_soc_ac97_ops; 177 struct snd_soc_clock_info; 178 179 typedef int (*hw_write_t)(void *,const char* ,int); 180 typedef int (*hw_read_t)(void *,char* ,int); 181 182 extern struct snd_ac97_bus_ops soc_ac97_ops; 183 184 /* pcm <-> DAI connect */ 185 void snd_soc_free_pcms(struct snd_soc_device *socdev); 186 int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid); 187 int snd_soc_register_card(struct snd_soc_device *socdev); 188 189 /* set runtime hw params */ 190 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream, 191 const struct snd_pcm_hardware *hw); 192 int snd_soc_get_rate(int rate); 193 194 /* codec IO */ 195 #define snd_soc_read(codec, reg) codec->read(codec, reg) 196 #define snd_soc_write(codec, reg, value) codec->write(codec, reg, value) 197 198 /* codec register bit access */ 199 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg, 200 unsigned short mask, unsigned short value); 201 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg, 202 unsigned short mask, unsigned short value); 203 204 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec, 205 struct snd_ac97_bus_ops *ops, int num); 206 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec); 207 208 /* 209 *Controls 210 */ 211 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template, 212 void *data, char *long_name); 213 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol, 214 struct snd_ctl_elem_info *uinfo); 215 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol, 216 struct snd_ctl_elem_info *uinfo); 217 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol, 218 struct snd_ctl_elem_value *ucontrol); 219 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol, 220 struct snd_ctl_elem_value *ucontrol); 221 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol, 222 struct snd_ctl_elem_info *uinfo); 223 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol, 224 struct snd_ctl_elem_info *uinfo); 225 int snd_soc_info_bool_ext(struct snd_kcontrol *kcontrol, 226 struct snd_ctl_elem_info *uinfo); 227 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol, 228 struct snd_ctl_elem_value *ucontrol); 229 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol, 230 struct snd_ctl_elem_value *ucontrol); 231 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol, 232 struct snd_ctl_elem_info *uinfo); 233 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol, 234 struct snd_ctl_elem_value *ucontrol); 235 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol, 236 struct snd_ctl_elem_value *ucontrol); 237 238 /* SoC PCM stream information */ 239 struct snd_soc_pcm_stream { 240 char *stream_name; 241 unsigned int rate_min; /* min rate */ 242 unsigned int rate_max; /* max rate */ 243 unsigned int channels_min; /* min channels */ 244 unsigned int channels_max; /* max channels */ 245 unsigned int active:1; /* stream is in use */ 246 }; 247 248 /* SoC audio ops */ 249 struct snd_soc_ops { 250 int (*startup)(struct snd_pcm_substream *); 251 void (*shutdown)(struct snd_pcm_substream *); 252 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *); 253 int (*hw_free)(struct snd_pcm_substream *); 254 int (*prepare)(struct snd_pcm_substream *); 255 int (*trigger)(struct snd_pcm_substream *, int); 256 }; 257 258 /* SoC DAI hardware mode */ 259 struct snd_soc_dai_mode { 260 u16 fmt; /* SND_SOC_DAIFMT_* */ 261 u16 tdm; /* SND_SOC_HWTDM_* */ 262 u64 pcmfmt; /* SNDRV_PCM_FMTBIT_* */ 263 u16 pcmrate; /* SND_SOC_HWRATE_* */ 264 u16 pcmdir:2; /* SND_SOC_HWDIR_* */ 265 u16 flags:8; /* hw flags */ 266 u16 fs; /* mclk to rate divider */ 267 u32 bfs; /* mclk to bclk dividers */ 268 unsigned long priv; /* private mode data */ 269 }; 270 271 /* DAI capabilities */ 272 struct snd_soc_dai_cap { 273 int num_modes; /* number of DAI modes */ 274 struct snd_soc_dai_mode *mode; /* array of supported DAI modes */ 275 }; 276 277 /* SoC Codec DAI */ 278 struct snd_soc_codec_dai { 279 char *name; 280 int id; 281 282 /* DAI capabilities */ 283 struct snd_soc_pcm_stream playback; 284 struct snd_soc_pcm_stream capture; 285 struct snd_soc_dai_cap caps; 286 287 /* DAI runtime info */ 288 struct snd_soc_dai_mode dai_runtime; 289 struct snd_soc_ops ops; 290 unsigned int (*config_sysclk)(struct snd_soc_codec_dai*, 291 struct snd_soc_clock_info *info, unsigned int clk); 292 int (*digital_mute)(struct snd_soc_codec *, 293 struct snd_soc_codec_dai*, int); 294 unsigned int mclk; /* the audio master clock */ 295 unsigned int pll_in; /* the PLL input clock */ 296 unsigned int pll_out; /* the PLL output clock */ 297 unsigned int clk_div; /* internal clock divider << 1 (for fractions) */ 298 unsigned int active; 299 unsigned char pop_wait:1; 300 301 /* DAI private data */ 302 void *private_data; 303 }; 304 305 /* SoC CPU DAI */ 306 struct snd_soc_cpu_dai { 307 308 /* DAI description */ 309 char *name; 310 unsigned int id; 311 unsigned char type; 312 313 /* DAI callbacks */ 314 int (*probe)(struct platform_device *pdev); 315 void (*remove)(struct platform_device *pdev); 316 int (*suspend)(struct platform_device *pdev, 317 struct snd_soc_cpu_dai *cpu_dai); 318 int (*resume)(struct platform_device *pdev, 319 struct snd_soc_cpu_dai *cpu_dai); 320 unsigned int (*config_sysclk)(struct snd_soc_cpu_dai *cpu_dai, 321 struct snd_soc_clock_info *info, unsigned int clk); 322 323 /* DAI capabilities */ 324 struct snd_soc_pcm_stream capture; 325 struct snd_soc_pcm_stream playback; 326 struct snd_soc_dai_cap caps; 327 328 /* DAI runtime info */ 329 struct snd_soc_dai_mode dai_runtime; 330 struct snd_soc_ops ops; 331 struct snd_pcm_runtime *runtime; 332 unsigned char active:1; 333 unsigned int mclk; 334 void *dma_data; 335 336 /* DAI private data */ 337 void *private_data; 338 }; 339 340 /* SoC Audio Codec */ 341 struct snd_soc_codec { 342 char *name; 343 struct module *owner; 344 struct mutex mutex; 345 346 /* callbacks */ 347 int (*dapm_event)(struct snd_soc_codec *codec, int event); 348 349 /* runtime */ 350 struct snd_card *card; 351 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */ 352 unsigned int active; 353 unsigned int pcm_devs; 354 void *private_data; 355 356 /* codec IO */ 357 void *control_data; /* codec control (i2c/3wire) data */ 358 unsigned int (*read)(struct snd_soc_codec *, unsigned int); 359 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int); 360 hw_write_t hw_write; 361 hw_read_t hw_read; 362 void *reg_cache; 363 short reg_cache_size; 364 short reg_cache_step; 365 366 /* dapm */ 367 struct list_head dapm_widgets; 368 struct list_head dapm_paths; 369 unsigned int dapm_state; 370 unsigned int suspend_dapm_state; 371 372 /* codec DAI's */ 373 struct snd_soc_codec_dai *dai; 374 unsigned int num_dai; 375 }; 376 377 /* codec device */ 378 struct snd_soc_codec_device { 379 int (*probe)(struct platform_device *pdev); 380 int (*remove)(struct platform_device *pdev); 381 int (*suspend)(struct platform_device *pdev, pm_message_t state); 382 int (*resume)(struct platform_device *pdev); 383 }; 384 385 /* SoC platform interface */ 386 struct snd_soc_platform { 387 char *name; 388 389 int (*probe)(struct platform_device *pdev); 390 int (*remove)(struct platform_device *pdev); 391 int (*suspend)(struct platform_device *pdev, 392 struct snd_soc_cpu_dai *cpu_dai); 393 int (*resume)(struct platform_device *pdev, 394 struct snd_soc_cpu_dai *cpu_dai); 395 396 /* pcm creation and destruction */ 397 int (*pcm_new)(struct snd_card *, struct snd_soc_codec_dai *, 398 struct snd_pcm *); 399 void (*pcm_free)(struct snd_pcm *); 400 401 /* platform stream ops */ 402 struct snd_pcm_ops *pcm_ops; 403 }; 404 405 /* SoC machine DAI configuration, glues a codec and cpu DAI together */ 406 struct snd_soc_dai_link { 407 char *name; /* Codec name */ 408 char *stream_name; /* Stream name */ 409 410 /* DAI */ 411 struct snd_soc_codec_dai *codec_dai; 412 struct snd_soc_cpu_dai *cpu_dai; 413 u32 flags; /* DAI config preference flags */ 414 415 /* codec/machine specific init - e.g. add machine controls */ 416 int (*init)(struct snd_soc_codec *codec); 417 418 /* audio sysclock configuration */ 419 unsigned int (*config_sysclk)(struct snd_soc_pcm_runtime *rtd, 420 struct snd_soc_clock_info *info); 421 }; 422 423 /* SoC machine */ 424 struct snd_soc_machine { 425 char *name; 426 427 int (*probe)(struct platform_device *pdev); 428 int (*remove)(struct platform_device *pdev); 429 430 /* the pre and post PM functions are used to do any PM work before and 431 * after the codec and DAI's do any PM work. */ 432 int (*suspend_pre)(struct platform_device *pdev, pm_message_t state); 433 int (*suspend_post)(struct platform_device *pdev, pm_message_t state); 434 int (*resume_pre)(struct platform_device *pdev); 435 int (*resume_post)(struct platform_device *pdev); 436 437 /* machine stream operations */ 438 struct snd_soc_ops *ops; 439 440 /* CPU <--> Codec DAI links */ 441 struct snd_soc_dai_link *dai_link; 442 int num_links; 443 }; 444 445 /* SoC Device - the audio subsystem */ 446 struct snd_soc_device { 447 struct device *dev; 448 struct snd_soc_machine *machine; 449 struct snd_soc_platform *platform; 450 struct snd_soc_codec *codec; 451 struct snd_soc_codec_device *codec_dev; 452 void *codec_data; 453 }; 454 455 /* runtime channel data */ 456 struct snd_soc_pcm_runtime { 457 struct snd_soc_codec_dai *codec_dai; 458 struct snd_soc_cpu_dai *cpu_dai; 459 struct snd_soc_device *socdev; 460 }; 461 462 /* enumerated kcontrol */ 463 struct soc_enum { 464 unsigned short reg; 465 unsigned short reg2; 466 unsigned char shift_l; 467 unsigned char shift_r; 468 unsigned int mask; 469 const char **texts; 470 void *dapm; 471 }; 472 473 /* clocking configuration data */ 474 struct snd_soc_clock_info { 475 unsigned int rate; 476 unsigned int fs; 477 unsigned int bclk_master; 478 }; 479 480 #endif 481