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 * Bias levels 207 * 208 * @ON: Bias is fully on for audio playback and capture operations. 209 * @PREPARE: Prepare for audio operations. Called before DAPM switching for 210 * stream start and stop operations. 211 * @STANDBY: Low power standby state when no playback/capture operations are 212 * in progress. NOTE: The transition time between STANDBY and ON 213 * should be as fast as possible and no longer than 10ms. 214 * @OFF: Power Off. No restrictions on transition times. 215 */ 216 enum snd_soc_bias_level { 217 SND_SOC_BIAS_OFF, 218 SND_SOC_BIAS_STANDBY, 219 SND_SOC_BIAS_PREPARE, 220 SND_SOC_BIAS_ON, 221 }; 222 223 struct snd_jack; 224 struct snd_soc_card; 225 struct snd_soc_device; 226 struct snd_soc_pcm_stream; 227 struct snd_soc_ops; 228 struct snd_soc_dai_mode; 229 struct snd_soc_pcm_runtime; 230 struct snd_soc_dai; 231 struct snd_soc_dai_driver; 232 struct snd_soc_platform; 233 struct snd_soc_dai_link; 234 struct snd_soc_platform_driver; 235 struct snd_soc_codec; 236 struct snd_soc_codec_driver; 237 struct soc_enum; 238 struct snd_soc_ac97_ops; 239 struct snd_soc_jack; 240 struct snd_soc_jack_pin; 241 242 #ifdef CONFIG_GPIOLIB 243 struct snd_soc_jack_gpio; 244 #endif 245 246 typedef int (*hw_write_t)(void *,const char* ,int); 247 248 extern struct snd_ac97_bus_ops soc_ac97_ops; 249 250 enum snd_soc_control_type { 251 SND_SOC_CUSTOM, 252 SND_SOC_I2C, 253 SND_SOC_SPI, 254 }; 255 256 int snd_soc_register_platform(struct device *dev, 257 struct snd_soc_platform_driver *platform_drv); 258 void snd_soc_unregister_platform(struct device *dev); 259 int snd_soc_register_codec(struct device *dev, 260 struct snd_soc_codec_driver *codec_drv, 261 struct snd_soc_dai_driver *dai_drv, int num_dai); 262 void snd_soc_unregister_codec(struct device *dev); 263 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec, int reg); 264 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec, 265 int addr_bits, int data_bits, 266 enum snd_soc_control_type control); 267 268 /* Utility functions to get clock rates from various things */ 269 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots); 270 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params); 271 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots); 272 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms); 273 274 /* set runtime hw params */ 275 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream, 276 const struct snd_pcm_hardware *hw); 277 278 /* Jack reporting */ 279 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type, 280 struct snd_soc_jack *jack); 281 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask); 282 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count, 283 struct snd_soc_jack_pin *pins); 284 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack, 285 struct notifier_block *nb); 286 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack, 287 struct notifier_block *nb); 288 #ifdef CONFIG_GPIOLIB 289 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count, 290 struct snd_soc_jack_gpio *gpios); 291 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count, 292 struct snd_soc_jack_gpio *gpios); 293 #endif 294 295 /* codec register bit access */ 296 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg, 297 unsigned int mask, unsigned int value); 298 int snd_soc_update_bits_locked(struct snd_soc_codec *codec, 299 unsigned short reg, unsigned int mask, 300 unsigned int value); 301 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg, 302 unsigned int mask, unsigned int value); 303 304 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec, 305 struct snd_ac97_bus_ops *ops, int num); 306 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec); 307 308 /* 309 *Controls 310 */ 311 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template, 312 void *data, char *long_name); 313 int snd_soc_add_controls(struct snd_soc_codec *codec, 314 const struct snd_kcontrol_new *controls, int num_controls); 315 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol, 316 struct snd_ctl_elem_info *uinfo); 317 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol, 318 struct snd_ctl_elem_info *uinfo); 319 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol, 320 struct snd_ctl_elem_value *ucontrol); 321 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol, 322 struct snd_ctl_elem_value *ucontrol); 323 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol, 324 struct snd_ctl_elem_value *ucontrol); 325 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol, 326 struct snd_ctl_elem_value *ucontrol); 327 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol, 328 struct snd_ctl_elem_info *uinfo); 329 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol, 330 struct snd_ctl_elem_info *uinfo); 331 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info 332 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol, 333 struct snd_ctl_elem_value *ucontrol); 334 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol, 335 struct snd_ctl_elem_value *ucontrol); 336 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol, 337 struct snd_ctl_elem_info *uinfo); 338 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol, 339 struct snd_ctl_elem_value *ucontrol); 340 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol, 341 struct snd_ctl_elem_value *ucontrol); 342 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol, 343 struct snd_ctl_elem_info *uinfo); 344 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol, 345 struct snd_ctl_elem_value *ucontrol); 346 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol, 347 struct snd_ctl_elem_value *ucontrol); 348 int snd_soc_limit_volume(struct snd_soc_codec *codec, 349 const char *name, int max); 350 int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol, 351 struct snd_ctl_elem_info *uinfo); 352 int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol, 353 struct snd_ctl_elem_value *ucontrol); 354 int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol, 355 struct snd_ctl_elem_value *ucontrol); 356 357 /** 358 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection 359 * 360 * @pin: name of the pin to update 361 * @mask: bits to check for in reported jack status 362 * @invert: if non-zero then pin is enabled when status is not reported 363 */ 364 struct snd_soc_jack_pin { 365 struct list_head list; 366 const char *pin; 367 int mask; 368 bool invert; 369 }; 370 371 /** 372 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection 373 * 374 * @gpio: gpio number 375 * @name: gpio name 376 * @report: value to report when jack detected 377 * @invert: report presence in low state 378 * @debouce_time: debouce time in ms 379 */ 380 #ifdef CONFIG_GPIOLIB 381 struct snd_soc_jack_gpio { 382 unsigned int gpio; 383 const char *name; 384 int report; 385 int invert; 386 int debounce_time; 387 struct snd_soc_jack *jack; 388 struct delayed_work work; 389 390 int (*jack_status_check)(void); 391 }; 392 #endif 393 394 struct snd_soc_jack { 395 struct snd_jack *jack; 396 struct snd_soc_codec *codec; 397 struct list_head pins; 398 int status; 399 struct blocking_notifier_head notifier; 400 }; 401 402 /* SoC PCM stream information */ 403 struct snd_soc_pcm_stream { 404 const char *stream_name; 405 u64 formats; /* SNDRV_PCM_FMTBIT_* */ 406 unsigned int rates; /* SNDRV_PCM_RATE_* */ 407 unsigned int rate_min; /* min rate */ 408 unsigned int rate_max; /* max rate */ 409 unsigned int channels_min; /* min channels */ 410 unsigned int channels_max; /* max channels */ 411 }; 412 413 /* SoC audio ops */ 414 struct snd_soc_ops { 415 int (*startup)(struct snd_pcm_substream *); 416 void (*shutdown)(struct snd_pcm_substream *); 417 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *); 418 int (*hw_free)(struct snd_pcm_substream *); 419 int (*prepare)(struct snd_pcm_substream *); 420 int (*trigger)(struct snd_pcm_substream *, int); 421 }; 422 423 /* SoC Audio Codec device */ 424 struct snd_soc_codec { 425 const char *name; 426 int id; 427 struct device *dev; 428 struct snd_soc_codec_driver *driver; 429 430 struct mutex mutex; 431 struct snd_soc_card *card; 432 struct list_head list; 433 struct list_head card_list; 434 int num_dai; 435 436 /* runtime */ 437 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */ 438 unsigned int active; 439 unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */ 440 unsigned int cache_only:1; /* Suppress writes to hardware */ 441 unsigned int cache_sync:1; /* Cache needs to be synced to hardware */ 442 unsigned int suspended:1; /* Codec is in suspend PM state */ 443 unsigned int probed:1; /* Codec has been probed */ 444 unsigned int ac97_registered:1; /* Codec has been AC97 registered */ 445 unsigned int ac97_created:1; /* Codec has been created by SoC */ 446 unsigned int sysfs_registered:1; /* codec has been sysfs registered */ 447 448 /* codec IO */ 449 void *control_data; /* codec control (i2c/3wire) data */ 450 hw_write_t hw_write; 451 unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int); 452 void *reg_cache; 453 454 /* dapm */ 455 u32 pop_time; 456 struct list_head dapm_widgets; 457 struct list_head dapm_paths; 458 enum snd_soc_bias_level bias_level; 459 enum snd_soc_bias_level suspend_bias_level; 460 struct delayed_work delayed_work; 461 462 #ifdef CONFIG_DEBUG_FS 463 struct dentry *debugfs_codec_root; 464 struct dentry *debugfs_reg; 465 struct dentry *debugfs_pop_time; 466 struct dentry *debugfs_dapm; 467 #endif 468 }; 469 470 /* codec driver */ 471 struct snd_soc_codec_driver { 472 473 /* driver ops */ 474 int (*probe)(struct snd_soc_codec *); 475 int (*remove)(struct snd_soc_codec *); 476 int (*suspend)(struct snd_soc_codec *, 477 pm_message_t state); 478 int (*resume)(struct snd_soc_codec *); 479 480 /* codec IO */ 481 unsigned int (*read)(struct snd_soc_codec *, unsigned int); 482 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int); 483 int (*display_register)(struct snd_soc_codec *, char *, 484 size_t, unsigned int); 485 int (*volatile_register)(unsigned int); 486 int (*readable_register)(unsigned int); 487 short reg_cache_size; 488 short reg_cache_step; 489 short reg_word_size; 490 const void *reg_cache_default; 491 492 /* codec bias level */ 493 int (*set_bias_level)(struct snd_soc_codec *, 494 enum snd_soc_bias_level level); 495 }; 496 497 /* SoC platform interface */ 498 struct snd_soc_platform_driver { 499 500 int (*probe)(struct snd_soc_platform *); 501 int (*remove)(struct snd_soc_platform *); 502 int (*suspend)(struct snd_soc_dai *dai); 503 int (*resume)(struct snd_soc_dai *dai); 504 505 /* pcm creation and destruction */ 506 int (*pcm_new)(struct snd_card *, struct snd_soc_dai *, 507 struct snd_pcm *); 508 void (*pcm_free)(struct snd_pcm *); 509 510 /* 511 * For platform caused delay reporting. 512 * Optional. 513 */ 514 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *, 515 struct snd_soc_dai *); 516 517 /* platform stream ops */ 518 struct snd_pcm_ops *ops; 519 }; 520 521 struct snd_soc_platform { 522 const char *name; 523 int id; 524 struct device *dev; 525 struct snd_soc_platform_driver *driver; 526 527 unsigned int suspended:1; /* platform is suspended */ 528 unsigned int probed:1; 529 530 struct snd_soc_card *card; 531 struct list_head list; 532 struct list_head card_list; 533 }; 534 535 struct snd_soc_dai_link { 536 /* config - must be set by machine driver */ 537 const char *name; /* Codec name */ 538 const char *stream_name; /* Stream name */ 539 const char *codec_name; /* for multi-codec */ 540 const char *platform_name; /* for multi-platform */ 541 const char *cpu_dai_name; 542 const char *codec_dai_name; 543 544 /* Keep DAI active over suspend */ 545 unsigned int ignore_suspend:1; 546 547 /* Symmetry requirements */ 548 unsigned int symmetric_rates:1; 549 550 /* codec/machine specific init - e.g. add machine controls */ 551 int (*init)(struct snd_soc_pcm_runtime *rtd); 552 553 /* machine stream operations */ 554 struct snd_soc_ops *ops; 555 }; 556 557 /* SoC card */ 558 struct snd_soc_card { 559 const char *name; 560 struct device *dev; 561 struct snd_card *snd_card; 562 struct module *owner; 563 564 struct list_head list; 565 struct mutex mutex; 566 567 bool instantiated; 568 569 int (*probe)(struct platform_device *pdev); 570 int (*remove)(struct platform_device *pdev); 571 572 /* the pre and post PM functions are used to do any PM work before and 573 * after the codec and DAI's do any PM work. */ 574 int (*suspend_pre)(struct platform_device *pdev, pm_message_t state); 575 int (*suspend_post)(struct platform_device *pdev, pm_message_t state); 576 int (*resume_pre)(struct platform_device *pdev); 577 int (*resume_post)(struct platform_device *pdev); 578 579 /* callbacks */ 580 int (*set_bias_level)(struct snd_soc_card *, 581 enum snd_soc_bias_level level); 582 583 long pmdown_time; 584 585 /* CPU <--> Codec DAI links */ 586 struct snd_soc_dai_link *dai_link; 587 int num_links; 588 struct snd_soc_pcm_runtime *rtd; 589 int num_rtd; 590 591 struct work_struct deferred_resume_work; 592 593 /* lists of probed devices belonging to this card */ 594 struct list_head codec_dev_list; 595 struct list_head platform_dev_list; 596 struct list_head dai_dev_list; 597 }; 598 599 /* SoC machine DAI configuration, glues a codec and cpu DAI together */ 600 struct snd_soc_pcm_runtime { 601 struct device dev; 602 struct snd_soc_card *card; 603 struct snd_soc_dai_link *dai_link; 604 605 unsigned int complete:1; 606 unsigned int dev_registered:1; 607 608 /* Symmetry data - only valid if symmetry is being enforced */ 609 unsigned int rate; 610 long pmdown_time; 611 612 /* runtime devices */ 613 struct snd_pcm *pcm; 614 struct snd_soc_codec *codec; 615 struct snd_soc_platform *platform; 616 struct snd_soc_dai *codec_dai; 617 struct snd_soc_dai *cpu_dai; 618 619 struct delayed_work delayed_work; 620 }; 621 622 /* mixer control */ 623 struct soc_mixer_control { 624 int min, max, platform_max; 625 unsigned int reg, rreg, shift, rshift, invert; 626 }; 627 628 /* enumerated kcontrol */ 629 struct soc_enum { 630 unsigned short reg; 631 unsigned short reg2; 632 unsigned char shift_l; 633 unsigned char shift_r; 634 unsigned int max; 635 unsigned int mask; 636 const char **texts; 637 const unsigned int *values; 638 void *dapm; 639 }; 640 641 /* codec IO */ 642 static inline unsigned int snd_soc_read(struct snd_soc_codec *codec, 643 unsigned int reg) 644 { 645 return codec->driver->read(codec, reg); 646 } 647 648 static inline unsigned int snd_soc_write(struct snd_soc_codec *codec, 649 unsigned int reg, unsigned int val) 650 { 651 return codec->driver->write(codec, reg, val); 652 } 653 654 /* device driver data */ 655 656 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec, 657 void *data) 658 { 659 dev_set_drvdata(codec->dev, data); 660 } 661 662 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec) 663 { 664 return dev_get_drvdata(codec->dev); 665 } 666 667 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform, 668 void *data) 669 { 670 dev_set_drvdata(platform->dev, data); 671 } 672 673 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform) 674 { 675 return dev_get_drvdata(platform->dev); 676 } 677 678 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd, 679 void *data) 680 { 681 dev_set_drvdata(&rtd->dev, data); 682 } 683 684 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd) 685 { 686 return dev_get_drvdata(&rtd->dev); 687 } 688 689 #include <sound/soc-dai.h> 690 691 #endif 692