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/of.h> 17 #include <linux/platform_device.h> 18 #include <linux/types.h> 19 #include <linux/notifier.h> 20 #include <linux/workqueue.h> 21 #include <linux/interrupt.h> 22 #include <linux/kernel.h> 23 #include <linux/regmap.h> 24 #include <linux/log2.h> 25 #include <sound/core.h> 26 #include <sound/pcm.h> 27 #include <sound/compress_driver.h> 28 #include <sound/control.h> 29 #include <sound/ac97_codec.h> 30 31 /* 32 * Convenience kcontrol builders 33 */ 34 #define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert, xautodisable) \ 35 ((unsigned long)&(struct soc_mixer_control) \ 36 {.reg = xreg, .rreg = xreg, .shift = shift_left, \ 37 .rshift = shift_right, .max = xmax, .platform_max = xmax, \ 38 .invert = xinvert, .autodisable = xautodisable}) 39 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \ 40 SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable) 41 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \ 42 ((unsigned long)&(struct soc_mixer_control) \ 43 {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert}) 44 #define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \ 45 ((unsigned long)&(struct soc_mixer_control) \ 46 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \ 47 .max = xmax, .platform_max = xmax, .invert = xinvert}) 48 #define SOC_DOUBLE_R_S_VALUE(xlreg, xrreg, xshift, xmin, xmax, xsign_bit, xinvert) \ 49 ((unsigned long)&(struct soc_mixer_control) \ 50 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \ 51 .max = xmax, .min = xmin, .platform_max = xmax, .sign_bit = xsign_bit, \ 52 .invert = xinvert}) 53 #define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \ 54 ((unsigned long)&(struct soc_mixer_control) \ 55 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \ 56 .min = xmin, .max = xmax, .platform_max = xmax, .invert = xinvert}) 57 #define SOC_SINGLE(xname, reg, shift, max, invert) \ 58 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 59 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\ 60 .put = snd_soc_put_volsw, \ 61 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) } 62 #define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \ 63 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ 64 .info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \ 65 .put = snd_soc_put_volsw_range, \ 66 .private_value = (unsigned long)&(struct soc_mixer_control) \ 67 {.reg = xreg, .rreg = xreg, .shift = xshift, \ 68 .rshift = xshift, .min = xmin, .max = xmax, \ 69 .platform_max = xmax, .invert = xinvert} } 70 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \ 71 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 72 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\ 73 SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 74 .tlv.p = (tlv_array), \ 75 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\ 76 .put = snd_soc_put_volsw, \ 77 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) } 78 #define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \ 79 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 80 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \ 81 SNDRV_CTL_ELEM_ACCESS_READWRITE, \ 82 .tlv.p = (tlv_array),\ 83 .info = snd_soc_info_volsw, \ 84 .get = snd_soc_get_volsw_sx,\ 85 .put = snd_soc_put_volsw_sx, \ 86 .private_value = (unsigned long)&(struct soc_mixer_control) \ 87 {.reg = xreg, .rreg = xreg, \ 88 .shift = xshift, .rshift = xshift, \ 89 .max = xmax, .min = xmin} } 90 #define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \ 91 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ 92 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\ 93 SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 94 .tlv.p = (tlv_array), \ 95 .info = snd_soc_info_volsw_range, \ 96 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \ 97 .private_value = (unsigned long)&(struct soc_mixer_control) \ 98 {.reg = xreg, .rreg = xreg, .shift = xshift, \ 99 .rshift = xshift, .min = xmin, .max = xmax, \ 100 .platform_max = xmax, .invert = xinvert} } 101 #define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \ 102 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ 103 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \ 104 .put = snd_soc_put_volsw, \ 105 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \ 106 max, invert, 0) } 107 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \ 108 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ 109 .info = snd_soc_info_volsw, \ 110 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \ 111 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \ 112 xmax, xinvert) } 113 #define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \ 114 xmax, xinvert) \ 115 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ 116 .info = snd_soc_info_volsw_range, \ 117 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \ 118 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \ 119 xshift, xmin, xmax, xinvert) } 120 #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \ 121 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ 122 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\ 123 SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 124 .tlv.p = (tlv_array), \ 125 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \ 126 .put = snd_soc_put_volsw, \ 127 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \ 128 max, invert, 0) } 129 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \ 130 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ 131 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\ 132 SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 133 .tlv.p = (tlv_array), \ 134 .info = snd_soc_info_volsw, \ 135 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \ 136 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \ 137 xmax, xinvert) } 138 #define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \ 139 xmax, xinvert, tlv_array) \ 140 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ 141 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\ 142 SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 143 .tlv.p = (tlv_array), \ 144 .info = snd_soc_info_volsw_range, \ 145 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \ 146 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \ 147 xshift, xmin, xmax, xinvert) } 148 #define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \ 149 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ 150 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \ 151 SNDRV_CTL_ELEM_ACCESS_READWRITE, \ 152 .tlv.p = (tlv_array), \ 153 .info = snd_soc_info_volsw, \ 154 .get = snd_soc_get_volsw_sx, \ 155 .put = snd_soc_put_volsw_sx, \ 156 .private_value = (unsigned long)&(struct soc_mixer_control) \ 157 {.reg = xreg, .rreg = xrreg, \ 158 .shift = xshift, .rshift = xshift, \ 159 .max = xmax, .min = xmin} } 160 #define SOC_DOUBLE_R_S_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \ 161 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ 162 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\ 163 SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 164 .tlv.p = (tlv_array), \ 165 .info = snd_soc_info_volsw, \ 166 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \ 167 .private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \ 168 xmin, xmax, xsign_bit, xinvert) } 169 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \ 170 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ 171 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \ 172 SNDRV_CTL_ELEM_ACCESS_READWRITE, \ 173 .tlv.p = (tlv_array), \ 174 .info = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \ 175 .put = snd_soc_put_volsw_s8, \ 176 .private_value = (unsigned long)&(struct soc_mixer_control) \ 177 {.reg = xreg, .min = xmin, .max = xmax, \ 178 .platform_max = xmax} } 179 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \ 180 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \ 181 .items = xitems, .texts = xtexts, \ 182 .mask = xitems ? roundup_pow_of_two(xitems) - 1 : 0} 183 #define SOC_ENUM_SINGLE(xreg, xshift, xitems, xtexts) \ 184 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xitems, xtexts) 185 #define SOC_ENUM_SINGLE_EXT(xitems, xtexts) \ 186 { .items = xitems, .texts = xtexts } 187 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xitems, xtexts, xvalues) \ 188 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \ 189 .mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues} 190 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xnitmes, xtexts, xvalues) \ 191 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xnitmes, xtexts, xvalues) 192 #define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \ 193 SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts) 194 #define SOC_ENUM(xname, xenum) \ 195 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\ 196 .info = snd_soc_info_enum_double, \ 197 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \ 198 .private_value = (unsigned long)&xenum } 199 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\ 200 xhandler_get, xhandler_put) \ 201 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 202 .info = snd_soc_info_volsw, \ 203 .get = xhandler_get, .put = xhandler_put, \ 204 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) } 205 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\ 206 xhandler_get, xhandler_put) \ 207 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ 208 .info = snd_soc_info_volsw, \ 209 .get = xhandler_get, .put = xhandler_put, \ 210 .private_value = \ 211 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) } 212 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\ 213 xhandler_get, xhandler_put, tlv_array) \ 214 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 215 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\ 216 SNDRV_CTL_ELEM_ACCESS_READWRITE,\ 217 .tlv.p = (tlv_array), \ 218 .info = snd_soc_info_volsw, \ 219 .get = xhandler_get, .put = xhandler_put, \ 220 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) } 221 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\ 222 xhandler_get, xhandler_put, tlv_array) \ 223 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ 224 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \ 225 SNDRV_CTL_ELEM_ACCESS_READWRITE, \ 226 .tlv.p = (tlv_array), \ 227 .info = snd_soc_info_volsw, \ 228 .get = xhandler_get, .put = xhandler_put, \ 229 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \ 230 xmax, xinvert, 0) } 231 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\ 232 xhandler_get, xhandler_put, tlv_array) \ 233 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ 234 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \ 235 SNDRV_CTL_ELEM_ACCESS_READWRITE, \ 236 .tlv.p = (tlv_array), \ 237 .info = snd_soc_info_volsw, \ 238 .get = xhandler_get, .put = xhandler_put, \ 239 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \ 240 xmax, xinvert) } 241 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \ 242 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 243 .info = snd_soc_info_bool_ext, \ 244 .get = xhandler_get, .put = xhandler_put, \ 245 .private_value = xdata } 246 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \ 247 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 248 .info = snd_soc_info_enum_double, \ 249 .get = xhandler_get, .put = xhandler_put, \ 250 .private_value = (unsigned long)&xenum } 251 252 #define SND_SOC_BYTES(xname, xbase, xregs) \ 253 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 254 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \ 255 .put = snd_soc_bytes_put, .private_value = \ 256 ((unsigned long)&(struct soc_bytes) \ 257 {.base = xbase, .num_regs = xregs }) } 258 259 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask) \ 260 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 261 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \ 262 .put = snd_soc_bytes_put, .private_value = \ 263 ((unsigned long)&(struct soc_bytes) \ 264 {.base = xbase, .num_regs = xregs, \ 265 .mask = xmask }) } 266 267 #define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \ 268 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 269 .info = snd_soc_bytes_info_ext, \ 270 .get = xhandler_get, .put = xhandler_put, \ 271 .private_value = (unsigned long)&(struct soc_bytes_ext) \ 272 {.max = xcount} } 273 274 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \ 275 xmin, xmax, xinvert) \ 276 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ 277 .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \ 278 .put = snd_soc_put_xr_sx, \ 279 .private_value = (unsigned long)&(struct soc_mreg_control) \ 280 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \ 281 .invert = xinvert, .min = xmin, .max = xmax} } 282 283 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \ 284 SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \ 285 snd_soc_get_strobe, snd_soc_put_strobe) 286 287 /* 288 * Simplified versions of above macros, declaring a struct and calculating 289 * ARRAY_SIZE internally 290 */ 291 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \ 292 const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \ 293 ARRAY_SIZE(xtexts), xtexts) 294 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \ 295 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts) 296 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \ 297 const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts) 298 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \ 299 const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \ 300 ARRAY_SIZE(xtexts), xtexts, xvalues) 301 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \ 302 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues) 303 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \ 304 const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts) 305 306 /* 307 * Component probe and remove ordering levels for components with runtime 308 * dependencies. 309 */ 310 #define SND_SOC_COMP_ORDER_FIRST -2 311 #define SND_SOC_COMP_ORDER_EARLY -1 312 #define SND_SOC_COMP_ORDER_NORMAL 0 313 #define SND_SOC_COMP_ORDER_LATE 1 314 #define SND_SOC_COMP_ORDER_LAST 2 315 316 /* 317 * Bias levels 318 * 319 * @ON: Bias is fully on for audio playback and capture operations. 320 * @PREPARE: Prepare for audio operations. Called before DAPM switching for 321 * stream start and stop operations. 322 * @STANDBY: Low power standby state when no playback/capture operations are 323 * in progress. NOTE: The transition time between STANDBY and ON 324 * should be as fast as possible and no longer than 10ms. 325 * @OFF: Power Off. No restrictions on transition times. 326 */ 327 enum snd_soc_bias_level { 328 SND_SOC_BIAS_OFF = 0, 329 SND_SOC_BIAS_STANDBY = 1, 330 SND_SOC_BIAS_PREPARE = 2, 331 SND_SOC_BIAS_ON = 3, 332 }; 333 334 struct device_node; 335 struct snd_jack; 336 struct snd_soc_card; 337 struct snd_soc_pcm_stream; 338 struct snd_soc_ops; 339 struct snd_soc_pcm_runtime; 340 struct snd_soc_dai; 341 struct snd_soc_dai_driver; 342 struct snd_soc_platform; 343 struct snd_soc_dai_link; 344 struct snd_soc_platform_driver; 345 struct snd_soc_codec; 346 struct snd_soc_codec_driver; 347 struct snd_soc_component; 348 struct snd_soc_component_driver; 349 struct soc_enum; 350 struct snd_soc_jack; 351 struct snd_soc_jack_zone; 352 struct snd_soc_jack_pin; 353 #include <sound/soc-dapm.h> 354 #include <sound/soc-dpcm.h> 355 356 struct snd_soc_jack_gpio; 357 358 typedef int (*hw_write_t)(void *,const char* ,int); 359 360 extern struct snd_ac97_bus_ops *soc_ac97_ops; 361 362 enum snd_soc_pcm_subclass { 363 SND_SOC_PCM_CLASS_PCM = 0, 364 SND_SOC_PCM_CLASS_BE = 1, 365 }; 366 367 enum snd_soc_card_subclass { 368 SND_SOC_CARD_CLASS_INIT = 0, 369 SND_SOC_CARD_CLASS_RUNTIME = 1, 370 }; 371 372 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id, 373 int source, unsigned int freq, int dir); 374 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source, 375 unsigned int freq_in, unsigned int freq_out); 376 377 int snd_soc_register_card(struct snd_soc_card *card); 378 int snd_soc_unregister_card(struct snd_soc_card *card); 379 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card); 380 int snd_soc_suspend(struct device *dev); 381 int snd_soc_resume(struct device *dev); 382 int snd_soc_poweroff(struct device *dev); 383 int snd_soc_register_platform(struct device *dev, 384 const struct snd_soc_platform_driver *platform_drv); 385 int devm_snd_soc_register_platform(struct device *dev, 386 const struct snd_soc_platform_driver *platform_drv); 387 void snd_soc_unregister_platform(struct device *dev); 388 int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform, 389 const struct snd_soc_platform_driver *platform_drv); 390 void snd_soc_remove_platform(struct snd_soc_platform *platform); 391 struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev); 392 int snd_soc_register_codec(struct device *dev, 393 const struct snd_soc_codec_driver *codec_drv, 394 struct snd_soc_dai_driver *dai_drv, int num_dai); 395 void snd_soc_unregister_codec(struct device *dev); 396 int snd_soc_register_component(struct device *dev, 397 const struct snd_soc_component_driver *cmpnt_drv, 398 struct snd_soc_dai_driver *dai_drv, int num_dai); 399 int devm_snd_soc_register_component(struct device *dev, 400 const struct snd_soc_component_driver *cmpnt_drv, 401 struct snd_soc_dai_driver *dai_drv, int num_dai); 402 void snd_soc_unregister_component(struct device *dev); 403 int snd_soc_cache_sync(struct snd_soc_codec *codec); 404 int snd_soc_cache_init(struct snd_soc_codec *codec); 405 int snd_soc_cache_exit(struct snd_soc_codec *codec); 406 int snd_soc_cache_write(struct snd_soc_codec *codec, 407 unsigned int reg, unsigned int value); 408 int snd_soc_cache_read(struct snd_soc_codec *codec, 409 unsigned int reg, unsigned int *value); 410 int snd_soc_platform_read(struct snd_soc_platform *platform, 411 unsigned int reg); 412 int snd_soc_platform_write(struct snd_soc_platform *platform, 413 unsigned int reg, unsigned int val); 414 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num); 415 int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num); 416 417 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card, 418 const char *dai_link, int stream); 419 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card, 420 const char *dai_link); 421 422 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd); 423 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream); 424 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream); 425 426 /* Utility functions to get clock rates from various things */ 427 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots); 428 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params); 429 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots); 430 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms); 431 432 /* set runtime hw params */ 433 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream, 434 const struct snd_pcm_hardware *hw); 435 436 int snd_soc_platform_trigger(struct snd_pcm_substream *substream, 437 int cmd, struct snd_soc_platform *platform); 438 439 int soc_dai_hw_params(struct snd_pcm_substream *substream, 440 struct snd_pcm_hw_params *params, 441 struct snd_soc_dai *dai); 442 443 /* Jack reporting */ 444 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type, 445 struct snd_soc_jack *jack); 446 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask); 447 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count, 448 struct snd_soc_jack_pin *pins); 449 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack, 450 struct notifier_block *nb); 451 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack, 452 struct notifier_block *nb); 453 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count, 454 struct snd_soc_jack_zone *zones); 455 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage); 456 #ifdef CONFIG_GPIOLIB 457 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count, 458 struct snd_soc_jack_gpio *gpios); 459 int snd_soc_jack_add_gpiods(struct device *gpiod_dev, 460 struct snd_soc_jack *jack, 461 int count, struct snd_soc_jack_gpio *gpios); 462 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count, 463 struct snd_soc_jack_gpio *gpios); 464 #else 465 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count, 466 struct snd_soc_jack_gpio *gpios) 467 { 468 return 0; 469 } 470 471 static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev, 472 struct snd_soc_jack *jack, 473 int count, 474 struct snd_soc_jack_gpio *gpios) 475 { 476 return 0; 477 } 478 479 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count, 480 struct snd_soc_jack_gpio *gpios) 481 { 482 } 483 #endif 484 485 /* codec register bit access */ 486 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned int reg, 487 unsigned int mask, unsigned int value); 488 int snd_soc_update_bits_locked(struct snd_soc_codec *codec, 489 unsigned int reg, unsigned int mask, 490 unsigned int value); 491 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned int reg, 492 unsigned int mask, unsigned int value); 493 494 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec, 495 struct snd_ac97_bus_ops *ops, int num); 496 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec); 497 498 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops); 499 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops, 500 struct platform_device *pdev); 501 502 /* 503 *Controls 504 */ 505 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template, 506 void *data, const char *long_name, 507 const char *prefix); 508 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card, 509 const char *name); 510 int snd_soc_add_component_controls(struct snd_soc_component *component, 511 const struct snd_kcontrol_new *controls, unsigned int num_controls); 512 int snd_soc_add_codec_controls(struct snd_soc_codec *codec, 513 const struct snd_kcontrol_new *controls, unsigned int num_controls); 514 int snd_soc_add_platform_controls(struct snd_soc_platform *platform, 515 const struct snd_kcontrol_new *controls, unsigned int num_controls); 516 int snd_soc_add_card_controls(struct snd_soc_card *soc_card, 517 const struct snd_kcontrol_new *controls, int num_controls); 518 int snd_soc_add_dai_controls(struct snd_soc_dai *dai, 519 const struct snd_kcontrol_new *controls, int num_controls); 520 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol, 521 struct snd_ctl_elem_info *uinfo); 522 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol, 523 struct snd_ctl_elem_value *ucontrol); 524 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol, 525 struct snd_ctl_elem_value *ucontrol); 526 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol, 527 struct snd_ctl_elem_info *uinfo); 528 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info 529 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol, 530 struct snd_ctl_elem_value *ucontrol); 531 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol, 532 struct snd_ctl_elem_value *ucontrol); 533 #define snd_soc_get_volsw_2r snd_soc_get_volsw 534 #define snd_soc_put_volsw_2r snd_soc_put_volsw 535 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol, 536 struct snd_ctl_elem_value *ucontrol); 537 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol, 538 struct snd_ctl_elem_value *ucontrol); 539 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol, 540 struct snd_ctl_elem_info *uinfo); 541 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol, 542 struct snd_ctl_elem_value *ucontrol); 543 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol, 544 struct snd_ctl_elem_value *ucontrol); 545 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol, 546 struct snd_ctl_elem_info *uinfo); 547 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol, 548 struct snd_ctl_elem_value *ucontrol); 549 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol, 550 struct snd_ctl_elem_value *ucontrol); 551 int snd_soc_limit_volume(struct snd_soc_codec *codec, 552 const char *name, int max); 553 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol, 554 struct snd_ctl_elem_info *uinfo); 555 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol, 556 struct snd_ctl_elem_value *ucontrol); 557 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol, 558 struct snd_ctl_elem_value *ucontrol); 559 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol, 560 struct snd_ctl_elem_info *ucontrol); 561 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol, 562 struct snd_ctl_elem_info *uinfo); 563 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol, 564 struct snd_ctl_elem_value *ucontrol); 565 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol, 566 struct snd_ctl_elem_value *ucontrol); 567 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol, 568 struct snd_ctl_elem_value *ucontrol); 569 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol, 570 struct snd_ctl_elem_value *ucontrol); 571 572 /** 573 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection 574 * 575 * @pin: name of the pin to update 576 * @mask: bits to check for in reported jack status 577 * @invert: if non-zero then pin is enabled when status is not reported 578 */ 579 struct snd_soc_jack_pin { 580 struct list_head list; 581 const char *pin; 582 int mask; 583 bool invert; 584 }; 585 586 /** 587 * struct snd_soc_jack_zone - Describes voltage zones of jack detection 588 * 589 * @min_mv: start voltage in mv 590 * @max_mv: end voltage in mv 591 * @jack_type: type of jack that is expected for this voltage 592 * @debounce_time: debounce_time for jack, codec driver should wait for this 593 * duration before reading the adc for voltages 594 * @:list: list container 595 */ 596 struct snd_soc_jack_zone { 597 unsigned int min_mv; 598 unsigned int max_mv; 599 unsigned int jack_type; 600 unsigned int debounce_time; 601 struct list_head list; 602 }; 603 604 /** 605 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection 606 * 607 * @gpio: legacy gpio number 608 * @idx: gpio descriptor index within the function of the GPIO 609 * consumer device 610 * @gpiod_dev GPIO consumer device 611 * @name: gpio name. Also as connection ID for the GPIO consumer 612 * device function name lookup 613 * @report: value to report when jack detected 614 * @invert: report presence in low state 615 * @debouce_time: debouce time in ms 616 * @wake: enable as wake source 617 * @jack_status_check: callback function which overrides the detection 618 * to provide more complex checks (eg, reading an 619 * ADC). 620 */ 621 struct snd_soc_jack_gpio { 622 unsigned int gpio; 623 unsigned int idx; 624 struct device *gpiod_dev; 625 const char *name; 626 int report; 627 int invert; 628 int debounce_time; 629 bool wake; 630 631 struct snd_soc_jack *jack; 632 struct delayed_work work; 633 struct gpio_desc *desc; 634 635 void *data; 636 int (*jack_status_check)(void *data); 637 }; 638 639 struct snd_soc_jack { 640 struct mutex mutex; 641 struct snd_jack *jack; 642 struct snd_soc_codec *codec; 643 struct list_head pins; 644 int status; 645 struct blocking_notifier_head notifier; 646 struct list_head jack_zones; 647 }; 648 649 /* SoC PCM stream information */ 650 struct snd_soc_pcm_stream { 651 const char *stream_name; 652 u64 formats; /* SNDRV_PCM_FMTBIT_* */ 653 unsigned int rates; /* SNDRV_PCM_RATE_* */ 654 unsigned int rate_min; /* min rate */ 655 unsigned int rate_max; /* max rate */ 656 unsigned int channels_min; /* min channels */ 657 unsigned int channels_max; /* max channels */ 658 unsigned int sig_bits; /* number of bits of content */ 659 }; 660 661 /* SoC audio ops */ 662 struct snd_soc_ops { 663 int (*startup)(struct snd_pcm_substream *); 664 void (*shutdown)(struct snd_pcm_substream *); 665 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *); 666 int (*hw_free)(struct snd_pcm_substream *); 667 int (*prepare)(struct snd_pcm_substream *); 668 int (*trigger)(struct snd_pcm_substream *, int); 669 }; 670 671 struct snd_soc_compr_ops { 672 int (*startup)(struct snd_compr_stream *); 673 void (*shutdown)(struct snd_compr_stream *); 674 int (*set_params)(struct snd_compr_stream *); 675 int (*trigger)(struct snd_compr_stream *); 676 }; 677 678 /* component interface */ 679 struct snd_soc_component_driver { 680 const char *name; 681 682 /* DT */ 683 int (*of_xlate_dai_name)(struct snd_soc_component *component, 684 struct of_phandle_args *args, 685 const char **dai_name); 686 void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type, 687 int subseq); 688 int (*stream_event)(struct snd_soc_component *, int event); 689 }; 690 691 struct snd_soc_component { 692 const char *name; 693 int id; 694 const char *name_prefix; 695 struct device *dev; 696 struct snd_soc_card *card; 697 698 unsigned int active; 699 700 unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */ 701 unsigned int registered_as_component:1; 702 703 struct list_head list; 704 705 struct snd_soc_dai_driver *dai_drv; 706 int num_dai; 707 708 const struct snd_soc_component_driver *driver; 709 710 struct list_head dai_list; 711 712 int (*read)(struct snd_soc_component *, unsigned int, unsigned int *); 713 int (*write)(struct snd_soc_component *, unsigned int, unsigned int); 714 715 struct regmap *regmap; 716 int val_bytes; 717 718 struct mutex io_mutex; 719 720 /* Don't use these, use snd_soc_component_get_dapm() */ 721 struct snd_soc_dapm_context dapm; 722 struct snd_soc_dapm_context *dapm_ptr; 723 }; 724 725 /* SoC Audio Codec device */ 726 struct snd_soc_codec { 727 struct device *dev; 728 const struct snd_soc_codec_driver *driver; 729 730 struct mutex mutex; 731 struct list_head list; 732 struct list_head card_list; 733 734 /* runtime */ 735 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */ 736 unsigned int cache_bypass:1; /* Suppress access to the cache */ 737 unsigned int suspended:1; /* Codec is in suspend PM state */ 738 unsigned int probed:1; /* Codec has been probed */ 739 unsigned int ac97_registered:1; /* Codec has been AC97 registered */ 740 unsigned int ac97_created:1; /* Codec has been created by SoC */ 741 unsigned int cache_init:1; /* codec cache has been initialized */ 742 u32 cache_only; /* Suppress writes to hardware */ 743 u32 cache_sync; /* Cache needs to be synced to hardware */ 744 745 /* codec IO */ 746 void *control_data; /* codec control (i2c/3wire) data */ 747 hw_write_t hw_write; 748 void *reg_cache; 749 struct mutex cache_rw_mutex; 750 751 /* component */ 752 struct snd_soc_component component; 753 754 /* dapm */ 755 struct snd_soc_dapm_context dapm; 756 757 #ifdef CONFIG_DEBUG_FS 758 struct dentry *debugfs_codec_root; 759 struct dentry *debugfs_reg; 760 #endif 761 }; 762 763 /* codec driver */ 764 struct snd_soc_codec_driver { 765 766 /* driver ops */ 767 int (*probe)(struct snd_soc_codec *); 768 int (*remove)(struct snd_soc_codec *); 769 int (*suspend)(struct snd_soc_codec *); 770 int (*resume)(struct snd_soc_codec *); 771 struct snd_soc_component_driver component_driver; 772 773 /* Default control and setup, added after probe() is run */ 774 const struct snd_kcontrol_new *controls; 775 int num_controls; 776 const struct snd_soc_dapm_widget *dapm_widgets; 777 int num_dapm_widgets; 778 const struct snd_soc_dapm_route *dapm_routes; 779 int num_dapm_routes; 780 781 /* codec wide operations */ 782 int (*set_sysclk)(struct snd_soc_codec *codec, 783 int clk_id, int source, unsigned int freq, int dir); 784 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source, 785 unsigned int freq_in, unsigned int freq_out); 786 787 /* codec IO */ 788 struct regmap *(*get_regmap)(struct device *); 789 unsigned int (*read)(struct snd_soc_codec *, unsigned int); 790 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int); 791 unsigned int reg_cache_size; 792 short reg_cache_step; 793 short reg_word_size; 794 const void *reg_cache_default; 795 796 /* codec bias level */ 797 int (*set_bias_level)(struct snd_soc_codec *, 798 enum snd_soc_bias_level level); 799 bool idle_bias_off; 800 801 void (*seq_notifier)(struct snd_soc_dapm_context *, 802 enum snd_soc_dapm_type, int); 803 804 bool ignore_pmdown_time; /* Doesn't benefit from pmdown delay */ 805 806 /* probe ordering - for components with runtime dependencies */ 807 int probe_order; 808 int remove_order; 809 }; 810 811 /* SoC platform interface */ 812 struct snd_soc_platform_driver { 813 814 int (*probe)(struct snd_soc_platform *); 815 int (*remove)(struct snd_soc_platform *); 816 int (*suspend)(struct snd_soc_dai *dai); 817 int (*resume)(struct snd_soc_dai *dai); 818 struct snd_soc_component_driver component_driver; 819 820 /* pcm creation and destruction */ 821 int (*pcm_new)(struct snd_soc_pcm_runtime *); 822 void (*pcm_free)(struct snd_pcm *); 823 824 /* Default control and setup, added after probe() is run */ 825 const struct snd_kcontrol_new *controls; 826 int num_controls; 827 const struct snd_soc_dapm_widget *dapm_widgets; 828 int num_dapm_widgets; 829 const struct snd_soc_dapm_route *dapm_routes; 830 int num_dapm_routes; 831 832 /* 833 * For platform caused delay reporting. 834 * Optional. 835 */ 836 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *, 837 struct snd_soc_dai *); 838 839 /* platform stream pcm ops */ 840 const struct snd_pcm_ops *ops; 841 842 /* platform stream compress ops */ 843 const struct snd_compr_ops *compr_ops; 844 845 /* probe ordering - for components with runtime dependencies */ 846 int probe_order; 847 int remove_order; 848 849 /* platform IO - used for platform DAPM */ 850 unsigned int (*read)(struct snd_soc_platform *, unsigned int); 851 int (*write)(struct snd_soc_platform *, unsigned int, unsigned int); 852 int (*bespoke_trigger)(struct snd_pcm_substream *, int); 853 }; 854 855 struct snd_soc_dai_link_component { 856 const char *name; 857 const struct device_node *of_node; 858 const char *dai_name; 859 }; 860 861 struct snd_soc_platform { 862 struct device *dev; 863 const struct snd_soc_platform_driver *driver; 864 865 unsigned int suspended:1; /* platform is suspended */ 866 unsigned int probed:1; 867 868 struct list_head list; 869 870 struct snd_soc_component component; 871 872 #ifdef CONFIG_DEBUG_FS 873 struct dentry *debugfs_platform_root; 874 #endif 875 }; 876 877 struct snd_soc_dai_link { 878 /* config - must be set by machine driver */ 879 const char *name; /* Codec name */ 880 const char *stream_name; /* Stream name */ 881 /* 882 * You MAY specify the link's CPU-side device, either by device name, 883 * or by DT/OF node, but not both. If this information is omitted, 884 * the CPU-side DAI is matched using .cpu_dai_name only, which hence 885 * must be globally unique. These fields are currently typically used 886 * only for codec to codec links, or systems using device tree. 887 */ 888 const char *cpu_name; 889 const struct device_node *cpu_of_node; 890 /* 891 * You MAY specify the DAI name of the CPU DAI. If this information is 892 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node 893 * only, which only works well when that device exposes a single DAI. 894 */ 895 const char *cpu_dai_name; 896 /* 897 * You MUST specify the link's codec, either by device name, or by 898 * DT/OF node, but not both. 899 */ 900 const char *codec_name; 901 const struct device_node *codec_of_node; 902 /* You MUST specify the DAI name within the codec */ 903 const char *codec_dai_name; 904 905 struct snd_soc_dai_link_component *codecs; 906 unsigned int num_codecs; 907 908 /* 909 * You MAY specify the link's platform/PCM/DMA driver, either by 910 * device name, or by DT/OF node, but not both. Some forms of link 911 * do not need a platform. 912 */ 913 const char *platform_name; 914 const struct device_node *platform_of_node; 915 int be_id; /* optional ID for machine driver BE identification */ 916 917 const struct snd_soc_pcm_stream *params; 918 919 unsigned int dai_fmt; /* format to set on init */ 920 921 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */ 922 923 /* Keep DAI active over suspend */ 924 unsigned int ignore_suspend:1; 925 926 /* Symmetry requirements */ 927 unsigned int symmetric_rates:1; 928 unsigned int symmetric_channels:1; 929 unsigned int symmetric_samplebits:1; 930 931 /* Do not create a PCM for this DAI link (Backend link) */ 932 unsigned int no_pcm:1; 933 934 /* This DAI link can route to other DAI links at runtime (Frontend)*/ 935 unsigned int dynamic:1; 936 937 /* DPCM capture and Playback support */ 938 unsigned int dpcm_capture:1; 939 unsigned int dpcm_playback:1; 940 941 /* pmdown_time is ignored at stop */ 942 unsigned int ignore_pmdown_time:1; 943 944 /* codec/machine specific init - e.g. add machine controls */ 945 int (*init)(struct snd_soc_pcm_runtime *rtd); 946 947 /* optional hw_params re-writing for BE and FE sync */ 948 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd, 949 struct snd_pcm_hw_params *params); 950 951 /* machine stream operations */ 952 const struct snd_soc_ops *ops; 953 const struct snd_soc_compr_ops *compr_ops; 954 955 /* For unidirectional dai links */ 956 bool playback_only; 957 bool capture_only; 958 }; 959 960 struct snd_soc_codec_conf { 961 /* 962 * specify device either by device name, or by 963 * DT/OF node, but not both. 964 */ 965 const char *dev_name; 966 const struct device_node *of_node; 967 968 /* 969 * optional map of kcontrol, widget and path name prefixes that are 970 * associated per device 971 */ 972 const char *name_prefix; 973 }; 974 975 struct snd_soc_aux_dev { 976 const char *name; /* Codec name */ 977 978 /* 979 * specify multi-codec either by device name, or by 980 * DT/OF node, but not both. 981 */ 982 const char *codec_name; 983 const struct device_node *codec_of_node; 984 985 /* codec/machine specific init - e.g. add machine controls */ 986 int (*init)(struct snd_soc_dapm_context *dapm); 987 }; 988 989 /* SoC card */ 990 struct snd_soc_card { 991 const char *name; 992 const char *long_name; 993 const char *driver_name; 994 struct device *dev; 995 struct snd_card *snd_card; 996 struct module *owner; 997 998 struct mutex mutex; 999 struct mutex dapm_mutex; 1000 1001 bool instantiated; 1002 1003 int (*probe)(struct snd_soc_card *card); 1004 int (*late_probe)(struct snd_soc_card *card); 1005 int (*remove)(struct snd_soc_card *card); 1006 1007 /* the pre and post PM functions are used to do any PM work before and 1008 * after the codec and DAI's do any PM work. */ 1009 int (*suspend_pre)(struct snd_soc_card *card); 1010 int (*suspend_post)(struct snd_soc_card *card); 1011 int (*resume_pre)(struct snd_soc_card *card); 1012 int (*resume_post)(struct snd_soc_card *card); 1013 1014 /* callbacks */ 1015 int (*set_bias_level)(struct snd_soc_card *, 1016 struct snd_soc_dapm_context *dapm, 1017 enum snd_soc_bias_level level); 1018 int (*set_bias_level_post)(struct snd_soc_card *, 1019 struct snd_soc_dapm_context *dapm, 1020 enum snd_soc_bias_level level); 1021 1022 long pmdown_time; 1023 1024 /* CPU <--> Codec DAI links */ 1025 struct snd_soc_dai_link *dai_link; 1026 int num_links; 1027 struct snd_soc_pcm_runtime *rtd; 1028 int num_rtd; 1029 1030 /* optional codec specific configuration */ 1031 struct snd_soc_codec_conf *codec_conf; 1032 int num_configs; 1033 1034 /* 1035 * optional auxiliary devices such as amplifiers or codecs with DAI 1036 * link unused 1037 */ 1038 struct snd_soc_aux_dev *aux_dev; 1039 int num_aux_devs; 1040 struct snd_soc_pcm_runtime *rtd_aux; 1041 int num_aux_rtd; 1042 1043 const struct snd_kcontrol_new *controls; 1044 int num_controls; 1045 1046 /* 1047 * Card-specific routes and widgets. 1048 */ 1049 const struct snd_soc_dapm_widget *dapm_widgets; 1050 int num_dapm_widgets; 1051 const struct snd_soc_dapm_route *dapm_routes; 1052 int num_dapm_routes; 1053 bool fully_routed; 1054 1055 struct work_struct deferred_resume_work; 1056 1057 /* lists of probed devices belonging to this card */ 1058 struct list_head codec_dev_list; 1059 1060 struct list_head widgets; 1061 struct list_head paths; 1062 struct list_head dapm_list; 1063 struct list_head dapm_dirty; 1064 1065 /* Generic DAPM context for the card */ 1066 struct snd_soc_dapm_context dapm; 1067 struct snd_soc_dapm_stats dapm_stats; 1068 struct snd_soc_dapm_update *update; 1069 1070 #ifdef CONFIG_DEBUG_FS 1071 struct dentry *debugfs_card_root; 1072 struct dentry *debugfs_pop_time; 1073 #endif 1074 u32 pop_time; 1075 1076 void *drvdata; 1077 }; 1078 1079 /* SoC machine DAI configuration, glues a codec and cpu DAI together */ 1080 struct snd_soc_pcm_runtime { 1081 struct device *dev; 1082 struct snd_soc_card *card; 1083 struct snd_soc_dai_link *dai_link; 1084 struct mutex pcm_mutex; 1085 enum snd_soc_pcm_subclass pcm_subclass; 1086 struct snd_pcm_ops ops; 1087 1088 unsigned int dev_registered:1; 1089 1090 /* Dynamic PCM BE runtime data */ 1091 struct snd_soc_dpcm_runtime dpcm[2]; 1092 int fe_compr; 1093 1094 long pmdown_time; 1095 unsigned char pop_wait:1; 1096 1097 /* runtime devices */ 1098 struct snd_pcm *pcm; 1099 struct snd_compr *compr; 1100 struct snd_soc_codec *codec; 1101 struct snd_soc_platform *platform; 1102 struct snd_soc_dai *codec_dai; 1103 struct snd_soc_dai *cpu_dai; 1104 1105 struct snd_soc_dai **codec_dais; 1106 unsigned int num_codecs; 1107 1108 struct delayed_work delayed_work; 1109 #ifdef CONFIG_DEBUG_FS 1110 struct dentry *debugfs_dpcm_root; 1111 struct dentry *debugfs_dpcm_state; 1112 #endif 1113 }; 1114 1115 /* mixer control */ 1116 struct soc_mixer_control { 1117 int min, max, platform_max; 1118 int reg, rreg; 1119 unsigned int shift, rshift; 1120 unsigned int sign_bit; 1121 unsigned int invert:1; 1122 unsigned int autodisable:1; 1123 }; 1124 1125 struct soc_bytes { 1126 int base; 1127 int num_regs; 1128 u32 mask; 1129 }; 1130 1131 struct soc_bytes_ext { 1132 int max; 1133 }; 1134 1135 /* multi register control */ 1136 struct soc_mreg_control { 1137 long min, max; 1138 unsigned int regbase, regcount, nbits, invert; 1139 }; 1140 1141 /* enumerated kcontrol */ 1142 struct soc_enum { 1143 int reg; 1144 unsigned char shift_l; 1145 unsigned char shift_r; 1146 unsigned int items; 1147 unsigned int mask; 1148 const char * const *texts; 1149 const unsigned int *values; 1150 }; 1151 1152 /** 1153 * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in 1154 * @component: The component to cast to a CODEC 1155 * 1156 * This function must only be used on components that are known to be CODECs. 1157 * Otherwise the behavior is undefined. 1158 */ 1159 static inline struct snd_soc_codec *snd_soc_component_to_codec( 1160 struct snd_soc_component *component) 1161 { 1162 return container_of(component, struct snd_soc_codec, component); 1163 } 1164 1165 /** 1166 * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in 1167 * @component: The component to cast to a platform 1168 * 1169 * This function must only be used on components that are known to be platforms. 1170 * Otherwise the behavior is undefined. 1171 */ 1172 static inline struct snd_soc_platform *snd_soc_component_to_platform( 1173 struct snd_soc_component *component) 1174 { 1175 return container_of(component, struct snd_soc_platform, component); 1176 } 1177 1178 /** 1179 * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is 1180 * embedded in 1181 * @dapm: The DAPM context to cast to the component 1182 * 1183 * This function must only be used on DAPM contexts that are known to be part of 1184 * a component (e.g. in a component driver). Otherwise the behavior is 1185 * undefined. 1186 */ 1187 static inline struct snd_soc_component *snd_soc_dapm_to_component( 1188 struct snd_soc_dapm_context *dapm) 1189 { 1190 return container_of(dapm, struct snd_soc_component, dapm); 1191 } 1192 1193 /** 1194 * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in 1195 * @dapm: The DAPM context to cast to the CODEC 1196 * 1197 * This function must only be used on DAPM contexts that are known to be part of 1198 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined. 1199 */ 1200 static inline struct snd_soc_codec *snd_soc_dapm_to_codec( 1201 struct snd_soc_dapm_context *dapm) 1202 { 1203 return container_of(dapm, struct snd_soc_codec, dapm); 1204 } 1205 1206 /** 1207 * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is 1208 * embedded in 1209 * @dapm: The DAPM context to cast to the platform. 1210 * 1211 * This function must only be used on DAPM contexts that are known to be part of 1212 * a platform (e.g. in a platform driver). Otherwise the behavior is undefined. 1213 */ 1214 static inline struct snd_soc_platform *snd_soc_dapm_to_platform( 1215 struct snd_soc_dapm_context *dapm) 1216 { 1217 return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm)); 1218 } 1219 1220 /** 1221 * snd_soc_component_get_dapm() - Returns the DAPM context associated with a 1222 * component 1223 * @component: The component for which to get the DAPM context 1224 */ 1225 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm( 1226 struct snd_soc_component *component) 1227 { 1228 return component->dapm_ptr; 1229 } 1230 1231 /* codec IO */ 1232 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg); 1233 int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg, 1234 unsigned int val); 1235 1236 /* component IO */ 1237 int snd_soc_component_read(struct snd_soc_component *component, 1238 unsigned int reg, unsigned int *val); 1239 int snd_soc_component_write(struct snd_soc_component *component, 1240 unsigned int reg, unsigned int val); 1241 int snd_soc_component_update_bits(struct snd_soc_component *component, 1242 unsigned int reg, unsigned int mask, unsigned int val); 1243 int snd_soc_component_update_bits_async(struct snd_soc_component *component, 1244 unsigned int reg, unsigned int mask, unsigned int val); 1245 void snd_soc_component_async_complete(struct snd_soc_component *component); 1246 int snd_soc_component_test_bits(struct snd_soc_component *component, 1247 unsigned int reg, unsigned int mask, unsigned int value); 1248 1249 int snd_soc_component_init_io(struct snd_soc_component *component, 1250 struct regmap *regmap); 1251 1252 /* device driver data */ 1253 1254 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card, 1255 void *data) 1256 { 1257 card->drvdata = data; 1258 } 1259 1260 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card) 1261 { 1262 return card->drvdata; 1263 } 1264 1265 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec, 1266 void *data) 1267 { 1268 dev_set_drvdata(codec->dev, data); 1269 } 1270 1271 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec) 1272 { 1273 return dev_get_drvdata(codec->dev); 1274 } 1275 1276 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform, 1277 void *data) 1278 { 1279 dev_set_drvdata(platform->dev, data); 1280 } 1281 1282 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform) 1283 { 1284 return dev_get_drvdata(platform->dev); 1285 } 1286 1287 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd, 1288 void *data) 1289 { 1290 dev_set_drvdata(rtd->dev, data); 1291 } 1292 1293 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd) 1294 { 1295 return dev_get_drvdata(rtd->dev); 1296 } 1297 1298 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card) 1299 { 1300 INIT_LIST_HEAD(&card->codec_dev_list); 1301 INIT_LIST_HEAD(&card->widgets); 1302 INIT_LIST_HEAD(&card->paths); 1303 INIT_LIST_HEAD(&card->dapm_list); 1304 } 1305 1306 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc) 1307 { 1308 if (mc->reg == mc->rreg && mc->shift == mc->rshift) 1309 return 0; 1310 /* 1311 * mc->reg == mc->rreg && mc->shift != mc->rshift, or 1312 * mc->reg != mc->rreg means that the control is 1313 * stereo (bits in one register or in two registers) 1314 */ 1315 return 1; 1316 } 1317 1318 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e, 1319 unsigned int val) 1320 { 1321 unsigned int i; 1322 1323 if (!e->values) 1324 return val; 1325 1326 for (i = 0; i < e->items; i++) 1327 if (val == e->values[i]) 1328 return i; 1329 1330 return 0; 1331 } 1332 1333 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e, 1334 unsigned int item) 1335 { 1336 if (!e->values) 1337 return item; 1338 1339 return e->values[item]; 1340 } 1341 1342 static inline bool snd_soc_component_is_active( 1343 struct snd_soc_component *component) 1344 { 1345 return component->active != 0; 1346 } 1347 1348 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec) 1349 { 1350 return snd_soc_component_is_active(&codec->component); 1351 } 1352 1353 /** 1354 * snd_soc_kcontrol_component() - Returns the component that registered the 1355 * control 1356 * @kcontrol: The control for which to get the component 1357 * 1358 * Note: This function will work correctly if the control has been registered 1359 * for a component. Either with snd_soc_add_codec_controls() or 1360 * snd_soc_add_platform_controls() or via table based setup for either a 1361 * CODEC, a platform or component driver. Otherwise the behavior is undefined. 1362 */ 1363 static inline struct snd_soc_component *snd_soc_kcontrol_component( 1364 struct snd_kcontrol *kcontrol) 1365 { 1366 return snd_kcontrol_chip(kcontrol); 1367 } 1368 1369 /** 1370 * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control 1371 * @kcontrol: The control for which to get the CODEC 1372 * 1373 * Note: This function will only work correctly if the control has been 1374 * registered with snd_soc_add_codec_controls() or via table based setup of 1375 * snd_soc_codec_driver. Otherwise the behavior is undefined. 1376 */ 1377 static inline struct snd_soc_codec *snd_soc_kcontrol_codec( 1378 struct snd_kcontrol *kcontrol) 1379 { 1380 return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol)); 1381 } 1382 1383 /** 1384 * snd_soc_kcontrol_platform() - Returns the platform that registerd the control 1385 * @kcontrol: The control for which to get the platform 1386 * 1387 * Note: This function will only work correctly if the control has been 1388 * registered with snd_soc_add_platform_controls() or via table based setup of 1389 * a snd_soc_platform_driver. Otherwise the behavior is undefined. 1390 */ 1391 static inline struct snd_soc_platform *snd_soc_kcontrol_platform( 1392 struct snd_kcontrol *kcontrol) 1393 { 1394 return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol)); 1395 } 1396 1397 int snd_soc_util_init(void); 1398 void snd_soc_util_exit(void); 1399 1400 int snd_soc_of_parse_card_name(struct snd_soc_card *card, 1401 const char *propname); 1402 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card, 1403 const char *propname); 1404 int snd_soc_of_parse_tdm_slot(struct device_node *np, 1405 unsigned int *slots, 1406 unsigned int *slot_width); 1407 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card, 1408 const char *propname); 1409 unsigned int snd_soc_of_parse_daifmt(struct device_node *np, 1410 const char *prefix, 1411 struct device_node **bitclkmaster, 1412 struct device_node **framemaster); 1413 int snd_soc_of_get_dai_name(struct device_node *of_node, 1414 const char **dai_name); 1415 1416 #include <sound/soc-dai.h> 1417 1418 #ifdef CONFIG_DEBUG_FS 1419 extern struct dentry *snd_soc_debugfs_root; 1420 #endif 1421 1422 extern const struct dev_pm_ops snd_soc_pm_ops; 1423 1424 /* Helper functions */ 1425 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm) 1426 { 1427 mutex_lock(&dapm->card->dapm_mutex); 1428 } 1429 1430 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm) 1431 { 1432 mutex_unlock(&dapm->card->dapm_mutex); 1433 } 1434 1435 #endif 1436