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