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_alloc_ac97_codec(struct snd_soc_codec *codec); 502 struct snd_ac97 *snd_soc_new_ac97_codec(struct snd_soc_codec *codec); 503 void snd_soc_free_ac97_codec(struct snd_ac97 *ac97); 504 505 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops); 506 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops, 507 struct platform_device *pdev); 508 509 extern struct snd_ac97_bus_ops *soc_ac97_ops; 510 #else 511 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops, 512 struct platform_device *pdev) 513 { 514 return 0; 515 } 516 517 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops) 518 { 519 return 0; 520 } 521 #endif 522 523 /* 524 *Controls 525 */ 526 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template, 527 void *data, const char *long_name, 528 const char *prefix); 529 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card, 530 const char *name); 531 int snd_soc_add_component_controls(struct snd_soc_component *component, 532 const struct snd_kcontrol_new *controls, unsigned int num_controls); 533 int snd_soc_add_codec_controls(struct snd_soc_codec *codec, 534 const struct snd_kcontrol_new *controls, unsigned int num_controls); 535 int snd_soc_add_platform_controls(struct snd_soc_platform *platform, 536 const struct snd_kcontrol_new *controls, unsigned int num_controls); 537 int snd_soc_add_card_controls(struct snd_soc_card *soc_card, 538 const struct snd_kcontrol_new *controls, int num_controls); 539 int snd_soc_add_dai_controls(struct snd_soc_dai *dai, 540 const struct snd_kcontrol_new *controls, int num_controls); 541 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol, 542 struct snd_ctl_elem_info *uinfo); 543 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol, 544 struct snd_ctl_elem_value *ucontrol); 545 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol, 546 struct snd_ctl_elem_value *ucontrol); 547 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol, 548 struct snd_ctl_elem_info *uinfo); 549 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info 550 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol, 551 struct snd_ctl_elem_value *ucontrol); 552 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol, 553 struct snd_ctl_elem_value *ucontrol); 554 #define snd_soc_get_volsw_2r snd_soc_get_volsw 555 #define snd_soc_put_volsw_2r snd_soc_put_volsw 556 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol, 557 struct snd_ctl_elem_value *ucontrol); 558 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol, 559 struct snd_ctl_elem_value *ucontrol); 560 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol, 561 struct snd_ctl_elem_info *uinfo); 562 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol, 563 struct snd_ctl_elem_value *ucontrol); 564 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol, 565 struct snd_ctl_elem_value *ucontrol); 566 int snd_soc_limit_volume(struct snd_soc_codec *codec, 567 const char *name, int max); 568 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol, 569 struct snd_ctl_elem_info *uinfo); 570 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol, 571 struct snd_ctl_elem_value *ucontrol); 572 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol, 573 struct snd_ctl_elem_value *ucontrol); 574 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol, 575 struct snd_ctl_elem_info *ucontrol); 576 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag, 577 unsigned int size, unsigned int __user *tlv); 578 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol, 579 struct snd_ctl_elem_info *uinfo); 580 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol, 581 struct snd_ctl_elem_value *ucontrol); 582 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol, 583 struct snd_ctl_elem_value *ucontrol); 584 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol, 585 struct snd_ctl_elem_value *ucontrol); 586 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol, 587 struct snd_ctl_elem_value *ucontrol); 588 589 /** 590 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection 591 * 592 * @pin: name of the pin to update 593 * @mask: bits to check for in reported jack status 594 * @invert: if non-zero then pin is enabled when status is not reported 595 */ 596 struct snd_soc_jack_pin { 597 struct list_head list; 598 const char *pin; 599 int mask; 600 bool invert; 601 }; 602 603 /** 604 * struct snd_soc_jack_zone - Describes voltage zones of jack detection 605 * 606 * @min_mv: start voltage in mv 607 * @max_mv: end voltage in mv 608 * @jack_type: type of jack that is expected for this voltage 609 * @debounce_time: debounce_time for jack, codec driver should wait for this 610 * duration before reading the adc for voltages 611 * @:list: list container 612 */ 613 struct snd_soc_jack_zone { 614 unsigned int min_mv; 615 unsigned int max_mv; 616 unsigned int jack_type; 617 unsigned int debounce_time; 618 struct list_head list; 619 }; 620 621 /** 622 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection 623 * 624 * @gpio: legacy gpio number 625 * @idx: gpio descriptor index within the function of the GPIO 626 * consumer device 627 * @gpiod_dev GPIO consumer device 628 * @name: gpio name. Also as connection ID for the GPIO consumer 629 * device function name lookup 630 * @report: value to report when jack detected 631 * @invert: report presence in low state 632 * @debouce_time: debouce time in ms 633 * @wake: enable as wake source 634 * @jack_status_check: callback function which overrides the detection 635 * to provide more complex checks (eg, reading an 636 * ADC). 637 */ 638 struct snd_soc_jack_gpio { 639 unsigned int gpio; 640 unsigned int idx; 641 struct device *gpiod_dev; 642 const char *name; 643 int report; 644 int invert; 645 int debounce_time; 646 bool wake; 647 648 struct snd_soc_jack *jack; 649 struct delayed_work work; 650 struct gpio_desc *desc; 651 652 void *data; 653 int (*jack_status_check)(void *data); 654 }; 655 656 struct snd_soc_jack { 657 struct mutex mutex; 658 struct snd_jack *jack; 659 struct snd_soc_codec *codec; 660 struct list_head pins; 661 int status; 662 struct blocking_notifier_head notifier; 663 struct list_head jack_zones; 664 }; 665 666 /* SoC PCM stream information */ 667 struct snd_soc_pcm_stream { 668 const char *stream_name; 669 u64 formats; /* SNDRV_PCM_FMTBIT_* */ 670 unsigned int rates; /* SNDRV_PCM_RATE_* */ 671 unsigned int rate_min; /* min rate */ 672 unsigned int rate_max; /* max rate */ 673 unsigned int channels_min; /* min channels */ 674 unsigned int channels_max; /* max channels */ 675 unsigned int sig_bits; /* number of bits of content */ 676 }; 677 678 /* SoC audio ops */ 679 struct snd_soc_ops { 680 int (*startup)(struct snd_pcm_substream *); 681 void (*shutdown)(struct snd_pcm_substream *); 682 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *); 683 int (*hw_free)(struct snd_pcm_substream *); 684 int (*prepare)(struct snd_pcm_substream *); 685 int (*trigger)(struct snd_pcm_substream *, int); 686 }; 687 688 struct snd_soc_compr_ops { 689 int (*startup)(struct snd_compr_stream *); 690 void (*shutdown)(struct snd_compr_stream *); 691 int (*set_params)(struct snd_compr_stream *); 692 int (*trigger)(struct snd_compr_stream *); 693 }; 694 695 /* component interface */ 696 struct snd_soc_component_driver { 697 const char *name; 698 699 /* Default control and setup, added after probe() is run */ 700 const struct snd_kcontrol_new *controls; 701 unsigned int num_controls; 702 const struct snd_soc_dapm_widget *dapm_widgets; 703 unsigned int num_dapm_widgets; 704 const struct snd_soc_dapm_route *dapm_routes; 705 unsigned int num_dapm_routes; 706 707 int (*probe)(struct snd_soc_component *); 708 void (*remove)(struct snd_soc_component *); 709 710 /* DT */ 711 int (*of_xlate_dai_name)(struct snd_soc_component *component, 712 struct of_phandle_args *args, 713 const char **dai_name); 714 void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type, 715 int subseq); 716 int (*stream_event)(struct snd_soc_component *, int event); 717 718 /* probe ordering - for components with runtime dependencies */ 719 int probe_order; 720 int remove_order; 721 }; 722 723 struct snd_soc_component { 724 const char *name; 725 int id; 726 const char *name_prefix; 727 struct device *dev; 728 struct snd_soc_card *card; 729 730 unsigned int active; 731 732 unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */ 733 unsigned int registered_as_component:1; 734 unsigned int probed:1; 735 736 struct list_head list; 737 738 struct snd_soc_dai_driver *dai_drv; 739 int num_dai; 740 741 const struct snd_soc_component_driver *driver; 742 743 struct list_head dai_list; 744 745 int (*read)(struct snd_soc_component *, unsigned int, unsigned int *); 746 int (*write)(struct snd_soc_component *, unsigned int, unsigned int); 747 748 struct regmap *regmap; 749 int val_bytes; 750 751 struct mutex io_mutex; 752 753 #ifdef CONFIG_DEBUG_FS 754 struct dentry *debugfs_root; 755 #endif 756 757 /* 758 * DO NOT use any of the fields below in drivers, they are temporary and 759 * are going to be removed again soon. If you use them in driver code the 760 * driver will be marked as BROKEN when these fields are removed. 761 */ 762 763 /* Don't use these, use snd_soc_component_get_dapm() */ 764 struct snd_soc_dapm_context dapm; 765 struct snd_soc_dapm_context *dapm_ptr; 766 767 const struct snd_kcontrol_new *controls; 768 unsigned int num_controls; 769 const struct snd_soc_dapm_widget *dapm_widgets; 770 unsigned int num_dapm_widgets; 771 const struct snd_soc_dapm_route *dapm_routes; 772 unsigned int num_dapm_routes; 773 struct snd_soc_codec *codec; 774 775 int (*probe)(struct snd_soc_component *); 776 void (*remove)(struct snd_soc_component *); 777 778 #ifdef CONFIG_DEBUG_FS 779 void (*init_debugfs)(struct snd_soc_component *component); 780 const char *debugfs_prefix; 781 #endif 782 }; 783 784 /* SoC Audio Codec device */ 785 struct snd_soc_codec { 786 struct device *dev; 787 const struct snd_soc_codec_driver *driver; 788 789 struct list_head list; 790 struct list_head card_list; 791 792 /* runtime */ 793 unsigned int cache_bypass:1; /* Suppress access to the cache */ 794 unsigned int suspended:1; /* Codec is in suspend PM state */ 795 unsigned int cache_init:1; /* codec cache has been initialized */ 796 797 /* codec IO */ 798 void *control_data; /* codec control (i2c/3wire) data */ 799 hw_write_t hw_write; 800 void *reg_cache; 801 802 /* component */ 803 struct snd_soc_component component; 804 805 /* dapm */ 806 struct snd_soc_dapm_context dapm; 807 808 #ifdef CONFIG_DEBUG_FS 809 struct dentry *debugfs_reg; 810 #endif 811 }; 812 813 /* codec driver */ 814 struct snd_soc_codec_driver { 815 816 /* driver ops */ 817 int (*probe)(struct snd_soc_codec *); 818 int (*remove)(struct snd_soc_codec *); 819 int (*suspend)(struct snd_soc_codec *); 820 int (*resume)(struct snd_soc_codec *); 821 struct snd_soc_component_driver component_driver; 822 823 /* Default control and setup, added after probe() is run */ 824 const struct snd_kcontrol_new *controls; 825 int num_controls; 826 const struct snd_soc_dapm_widget *dapm_widgets; 827 int num_dapm_widgets; 828 const struct snd_soc_dapm_route *dapm_routes; 829 int num_dapm_routes; 830 831 /* codec wide operations */ 832 int (*set_sysclk)(struct snd_soc_codec *codec, 833 int clk_id, int source, unsigned int freq, int dir); 834 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source, 835 unsigned int freq_in, unsigned int freq_out); 836 837 /* codec IO */ 838 struct regmap *(*get_regmap)(struct device *); 839 unsigned int (*read)(struct snd_soc_codec *, unsigned int); 840 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int); 841 unsigned int reg_cache_size; 842 short reg_cache_step; 843 short reg_word_size; 844 const void *reg_cache_default; 845 846 /* codec bias level */ 847 int (*set_bias_level)(struct snd_soc_codec *, 848 enum snd_soc_bias_level level); 849 bool idle_bias_off; 850 bool suspend_bias_off; 851 852 void (*seq_notifier)(struct snd_soc_dapm_context *, 853 enum snd_soc_dapm_type, int); 854 855 bool ignore_pmdown_time; /* Doesn't benefit from pmdown delay */ 856 }; 857 858 /* SoC platform interface */ 859 struct snd_soc_platform_driver { 860 861 int (*probe)(struct snd_soc_platform *); 862 int (*remove)(struct snd_soc_platform *); 863 struct snd_soc_component_driver component_driver; 864 865 /* pcm creation and destruction */ 866 int (*pcm_new)(struct snd_soc_pcm_runtime *); 867 void (*pcm_free)(struct snd_pcm *); 868 869 /* 870 * For platform caused delay reporting. 871 * Optional. 872 */ 873 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *, 874 struct snd_soc_dai *); 875 876 /* platform stream pcm ops */ 877 const struct snd_pcm_ops *ops; 878 879 /* platform stream compress ops */ 880 const struct snd_compr_ops *compr_ops; 881 882 int (*bespoke_trigger)(struct snd_pcm_substream *, int); 883 }; 884 885 struct snd_soc_dai_link_component { 886 const char *name; 887 struct device_node *of_node; 888 const char *dai_name; 889 }; 890 891 struct snd_soc_platform { 892 struct device *dev; 893 const struct snd_soc_platform_driver *driver; 894 895 struct list_head list; 896 897 struct snd_soc_component component; 898 }; 899 900 struct snd_soc_dai_link { 901 /* config - must be set by machine driver */ 902 const char *name; /* Codec name */ 903 const char *stream_name; /* Stream name */ 904 /* 905 * You MAY specify the link's CPU-side device, either by device name, 906 * or by DT/OF node, but not both. If this information is omitted, 907 * the CPU-side DAI is matched using .cpu_dai_name only, which hence 908 * must be globally unique. These fields are currently typically used 909 * only for codec to codec links, or systems using device tree. 910 */ 911 const char *cpu_name; 912 struct device_node *cpu_of_node; 913 /* 914 * You MAY specify the DAI name of the CPU DAI. If this information is 915 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node 916 * only, which only works well when that device exposes a single DAI. 917 */ 918 const char *cpu_dai_name; 919 /* 920 * You MUST specify the link's codec, either by device name, or by 921 * DT/OF node, but not both. 922 */ 923 const char *codec_name; 924 struct device_node *codec_of_node; 925 /* You MUST specify the DAI name within the codec */ 926 const char *codec_dai_name; 927 928 struct snd_soc_dai_link_component *codecs; 929 unsigned int num_codecs; 930 931 /* 932 * You MAY specify the link's platform/PCM/DMA driver, either by 933 * device name, or by DT/OF node, but not both. Some forms of link 934 * do not need a platform. 935 */ 936 const char *platform_name; 937 struct device_node *platform_of_node; 938 int be_id; /* optional ID for machine driver BE identification */ 939 940 const struct snd_soc_pcm_stream *params; 941 942 unsigned int dai_fmt; /* format to set on init */ 943 944 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */ 945 946 /* Keep DAI active over suspend */ 947 unsigned int ignore_suspend:1; 948 949 /* Symmetry requirements */ 950 unsigned int symmetric_rates:1; 951 unsigned int symmetric_channels:1; 952 unsigned int symmetric_samplebits:1; 953 954 /* Do not create a PCM for this DAI link (Backend link) */ 955 unsigned int no_pcm:1; 956 957 /* This DAI link can route to other DAI links at runtime (Frontend)*/ 958 unsigned int dynamic:1; 959 960 /* DPCM capture and Playback support */ 961 unsigned int dpcm_capture:1; 962 unsigned int dpcm_playback:1; 963 964 /* pmdown_time is ignored at stop */ 965 unsigned int ignore_pmdown_time:1; 966 967 /* codec/machine specific init - e.g. add machine controls */ 968 int (*init)(struct snd_soc_pcm_runtime *rtd); 969 970 /* optional hw_params re-writing for BE and FE sync */ 971 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd, 972 struct snd_pcm_hw_params *params); 973 974 /* machine stream operations */ 975 const struct snd_soc_ops *ops; 976 const struct snd_soc_compr_ops *compr_ops; 977 978 /* For unidirectional dai links */ 979 bool playback_only; 980 bool capture_only; 981 }; 982 983 struct snd_soc_codec_conf { 984 /* 985 * specify device either by device name, or by 986 * DT/OF node, but not both. 987 */ 988 const char *dev_name; 989 struct device_node *of_node; 990 991 /* 992 * optional map of kcontrol, widget and path name prefixes that are 993 * associated per device 994 */ 995 const char *name_prefix; 996 }; 997 998 struct snd_soc_aux_dev { 999 const char *name; /* Codec name */ 1000 1001 /* 1002 * specify multi-codec either by device name, or by 1003 * DT/OF node, but not both. 1004 */ 1005 const char *codec_name; 1006 struct device_node *codec_of_node; 1007 1008 /* codec/machine specific init - e.g. add machine controls */ 1009 int (*init)(struct snd_soc_component *component); 1010 }; 1011 1012 /* SoC card */ 1013 struct snd_soc_card { 1014 const char *name; 1015 const char *long_name; 1016 const char *driver_name; 1017 struct device *dev; 1018 struct snd_card *snd_card; 1019 struct module *owner; 1020 1021 struct mutex mutex; 1022 struct mutex dapm_mutex; 1023 1024 bool instantiated; 1025 1026 int (*probe)(struct snd_soc_card *card); 1027 int (*late_probe)(struct snd_soc_card *card); 1028 int (*remove)(struct snd_soc_card *card); 1029 1030 /* the pre and post PM functions are used to do any PM work before and 1031 * after the codec and DAI's do any PM work. */ 1032 int (*suspend_pre)(struct snd_soc_card *card); 1033 int (*suspend_post)(struct snd_soc_card *card); 1034 int (*resume_pre)(struct snd_soc_card *card); 1035 int (*resume_post)(struct snd_soc_card *card); 1036 1037 /* callbacks */ 1038 int (*set_bias_level)(struct snd_soc_card *, 1039 struct snd_soc_dapm_context *dapm, 1040 enum snd_soc_bias_level level); 1041 int (*set_bias_level_post)(struct snd_soc_card *, 1042 struct snd_soc_dapm_context *dapm, 1043 enum snd_soc_bias_level level); 1044 1045 long pmdown_time; 1046 1047 /* CPU <--> Codec DAI links */ 1048 struct snd_soc_dai_link *dai_link; 1049 int num_links; 1050 struct snd_soc_pcm_runtime *rtd; 1051 int num_rtd; 1052 1053 /* optional codec specific configuration */ 1054 struct snd_soc_codec_conf *codec_conf; 1055 int num_configs; 1056 1057 /* 1058 * optional auxiliary devices such as amplifiers or codecs with DAI 1059 * link unused 1060 */ 1061 struct snd_soc_aux_dev *aux_dev; 1062 int num_aux_devs; 1063 struct snd_soc_pcm_runtime *rtd_aux; 1064 int num_aux_rtd; 1065 1066 const struct snd_kcontrol_new *controls; 1067 int num_controls; 1068 1069 /* 1070 * Card-specific routes and widgets. 1071 */ 1072 const struct snd_soc_dapm_widget *dapm_widgets; 1073 int num_dapm_widgets; 1074 const struct snd_soc_dapm_route *dapm_routes; 1075 int num_dapm_routes; 1076 bool fully_routed; 1077 1078 struct work_struct deferred_resume_work; 1079 1080 /* lists of probed devices belonging to this card */ 1081 struct list_head codec_dev_list; 1082 1083 struct list_head widgets; 1084 struct list_head paths; 1085 struct list_head dapm_list; 1086 struct list_head dapm_dirty; 1087 1088 /* Generic DAPM context for the card */ 1089 struct snd_soc_dapm_context dapm; 1090 struct snd_soc_dapm_stats dapm_stats; 1091 struct snd_soc_dapm_update *update; 1092 1093 #ifdef CONFIG_DEBUG_FS 1094 struct dentry *debugfs_card_root; 1095 struct dentry *debugfs_pop_time; 1096 #endif 1097 u32 pop_time; 1098 1099 void *drvdata; 1100 }; 1101 1102 /* SoC machine DAI configuration, glues a codec and cpu DAI together */ 1103 struct snd_soc_pcm_runtime { 1104 struct device *dev; 1105 struct snd_soc_card *card; 1106 struct snd_soc_dai_link *dai_link; 1107 struct mutex pcm_mutex; 1108 enum snd_soc_pcm_subclass pcm_subclass; 1109 struct snd_pcm_ops ops; 1110 1111 unsigned int dev_registered:1; 1112 1113 /* Dynamic PCM BE runtime data */ 1114 struct snd_soc_dpcm_runtime dpcm[2]; 1115 int fe_compr; 1116 1117 long pmdown_time; 1118 unsigned char pop_wait:1; 1119 1120 /* runtime devices */ 1121 struct snd_pcm *pcm; 1122 struct snd_compr *compr; 1123 struct snd_soc_codec *codec; 1124 struct snd_soc_platform *platform; 1125 struct snd_soc_dai *codec_dai; 1126 struct snd_soc_dai *cpu_dai; 1127 struct snd_soc_component *component; /* Only valid for AUX dev rtds */ 1128 1129 struct snd_soc_dai **codec_dais; 1130 unsigned int num_codecs; 1131 1132 struct delayed_work delayed_work; 1133 #ifdef CONFIG_DEBUG_FS 1134 struct dentry *debugfs_dpcm_root; 1135 struct dentry *debugfs_dpcm_state; 1136 #endif 1137 }; 1138 1139 /* mixer control */ 1140 struct soc_mixer_control { 1141 int min, max, platform_max; 1142 int reg, rreg; 1143 unsigned int shift, rshift; 1144 unsigned int sign_bit; 1145 unsigned int invert:1; 1146 unsigned int autodisable:1; 1147 }; 1148 1149 struct soc_bytes { 1150 int base; 1151 int num_regs; 1152 u32 mask; 1153 }; 1154 1155 struct soc_bytes_ext { 1156 int max; 1157 /* used for TLV byte control */ 1158 int (*get)(unsigned int __user *bytes, unsigned int size); 1159 int (*put)(const unsigned int __user *bytes, unsigned int size); 1160 }; 1161 1162 /* multi register control */ 1163 struct soc_mreg_control { 1164 long min, max; 1165 unsigned int regbase, regcount, nbits, invert; 1166 }; 1167 1168 /* enumerated kcontrol */ 1169 struct soc_enum { 1170 int reg; 1171 unsigned char shift_l; 1172 unsigned char shift_r; 1173 unsigned int items; 1174 unsigned int mask; 1175 const char * const *texts; 1176 const unsigned int *values; 1177 }; 1178 1179 /** 1180 * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in 1181 * @component: The component to cast to a CODEC 1182 * 1183 * This function must only be used on components that are known to be CODECs. 1184 * Otherwise the behavior is undefined. 1185 */ 1186 static inline struct snd_soc_codec *snd_soc_component_to_codec( 1187 struct snd_soc_component *component) 1188 { 1189 return container_of(component, struct snd_soc_codec, component); 1190 } 1191 1192 /** 1193 * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in 1194 * @component: The component to cast to a platform 1195 * 1196 * This function must only be used on components that are known to be platforms. 1197 * Otherwise the behavior is undefined. 1198 */ 1199 static inline struct snd_soc_platform *snd_soc_component_to_platform( 1200 struct snd_soc_component *component) 1201 { 1202 return container_of(component, struct snd_soc_platform, component); 1203 } 1204 1205 /** 1206 * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is 1207 * embedded in 1208 * @dapm: The DAPM context to cast to the component 1209 * 1210 * This function must only be used on DAPM contexts that are known to be part of 1211 * a component (e.g. in a component driver). Otherwise the behavior is 1212 * undefined. 1213 */ 1214 static inline struct snd_soc_component *snd_soc_dapm_to_component( 1215 struct snd_soc_dapm_context *dapm) 1216 { 1217 return container_of(dapm, struct snd_soc_component, dapm); 1218 } 1219 1220 /** 1221 * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in 1222 * @dapm: The DAPM context to cast to the CODEC 1223 * 1224 * This function must only be used on DAPM contexts that are known to be part of 1225 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined. 1226 */ 1227 static inline struct snd_soc_codec *snd_soc_dapm_to_codec( 1228 struct snd_soc_dapm_context *dapm) 1229 { 1230 return container_of(dapm, struct snd_soc_codec, dapm); 1231 } 1232 1233 /** 1234 * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is 1235 * embedded in 1236 * @dapm: The DAPM context to cast to the platform. 1237 * 1238 * This function must only be used on DAPM contexts that are known to be part of 1239 * a platform (e.g. in a platform driver). Otherwise the behavior is undefined. 1240 */ 1241 static inline struct snd_soc_platform *snd_soc_dapm_to_platform( 1242 struct snd_soc_dapm_context *dapm) 1243 { 1244 return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm)); 1245 } 1246 1247 /** 1248 * snd_soc_component_get_dapm() - Returns the DAPM context associated with a 1249 * component 1250 * @component: The component for which to get the DAPM context 1251 */ 1252 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm( 1253 struct snd_soc_component *component) 1254 { 1255 return component->dapm_ptr; 1256 } 1257 1258 /* codec IO */ 1259 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg); 1260 int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg, 1261 unsigned int val); 1262 1263 /** 1264 * snd_soc_cache_sync() - Sync the register cache with the hardware 1265 * @codec: CODEC to sync 1266 * 1267 * Note: This function will call regcache_sync() 1268 */ 1269 static inline int snd_soc_cache_sync(struct snd_soc_codec *codec) 1270 { 1271 return regcache_sync(codec->component.regmap); 1272 } 1273 1274 /* component IO */ 1275 int snd_soc_component_read(struct snd_soc_component *component, 1276 unsigned int reg, unsigned int *val); 1277 int snd_soc_component_write(struct snd_soc_component *component, 1278 unsigned int reg, unsigned int val); 1279 int snd_soc_component_update_bits(struct snd_soc_component *component, 1280 unsigned int reg, unsigned int mask, unsigned int val); 1281 int snd_soc_component_update_bits_async(struct snd_soc_component *component, 1282 unsigned int reg, unsigned int mask, unsigned int val); 1283 void snd_soc_component_async_complete(struct snd_soc_component *component); 1284 int snd_soc_component_test_bits(struct snd_soc_component *component, 1285 unsigned int reg, unsigned int mask, unsigned int value); 1286 1287 #ifdef CONFIG_REGMAP 1288 1289 void snd_soc_component_init_regmap(struct snd_soc_component *component, 1290 struct regmap *regmap); 1291 void snd_soc_component_exit_regmap(struct snd_soc_component *component); 1292 1293 /** 1294 * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC 1295 * @codec: The CODEC for which to initialize the regmap instance 1296 * @regmap: The regmap instance that should be used by the CODEC 1297 * 1298 * This function allows deferred assignment of the regmap instance that is 1299 * associated with the CODEC. Only use this if the regmap instance is not yet 1300 * ready when the CODEC is registered. The function must also be called before 1301 * the first IO attempt of the CODEC. 1302 */ 1303 static inline void snd_soc_codec_init_regmap(struct snd_soc_codec *codec, 1304 struct regmap *regmap) 1305 { 1306 snd_soc_component_init_regmap(&codec->component, regmap); 1307 } 1308 1309 /** 1310 * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC 1311 * @codec: The CODEC for which to de-initialize the regmap instance 1312 * 1313 * Calls regmap_exit() on the regmap instance associated to the CODEC and 1314 * removes the regmap instance from the CODEC. 1315 * 1316 * This function should only be used if snd_soc_codec_init_regmap() was used to 1317 * initialize the regmap instance. 1318 */ 1319 static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec *codec) 1320 { 1321 snd_soc_component_exit_regmap(&codec->component); 1322 } 1323 1324 #endif 1325 1326 /* device driver data */ 1327 1328 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card, 1329 void *data) 1330 { 1331 card->drvdata = data; 1332 } 1333 1334 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card) 1335 { 1336 return card->drvdata; 1337 } 1338 1339 static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c, 1340 void *data) 1341 { 1342 dev_set_drvdata(c->dev, data); 1343 } 1344 1345 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c) 1346 { 1347 return dev_get_drvdata(c->dev); 1348 } 1349 1350 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec, 1351 void *data) 1352 { 1353 snd_soc_component_set_drvdata(&codec->component, data); 1354 } 1355 1356 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec) 1357 { 1358 return snd_soc_component_get_drvdata(&codec->component); 1359 } 1360 1361 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform, 1362 void *data) 1363 { 1364 snd_soc_component_set_drvdata(&platform->component, data); 1365 } 1366 1367 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform) 1368 { 1369 return snd_soc_component_get_drvdata(&platform->component); 1370 } 1371 1372 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd, 1373 void *data) 1374 { 1375 dev_set_drvdata(rtd->dev, data); 1376 } 1377 1378 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd) 1379 { 1380 return dev_get_drvdata(rtd->dev); 1381 } 1382 1383 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card) 1384 { 1385 INIT_LIST_HEAD(&card->codec_dev_list); 1386 INIT_LIST_HEAD(&card->widgets); 1387 INIT_LIST_HEAD(&card->paths); 1388 INIT_LIST_HEAD(&card->dapm_list); 1389 } 1390 1391 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc) 1392 { 1393 if (mc->reg == mc->rreg && mc->shift == mc->rshift) 1394 return 0; 1395 /* 1396 * mc->reg == mc->rreg && mc->shift != mc->rshift, or 1397 * mc->reg != mc->rreg means that the control is 1398 * stereo (bits in one register or in two registers) 1399 */ 1400 return 1; 1401 } 1402 1403 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e, 1404 unsigned int val) 1405 { 1406 unsigned int i; 1407 1408 if (!e->values) 1409 return val; 1410 1411 for (i = 0; i < e->items; i++) 1412 if (val == e->values[i]) 1413 return i; 1414 1415 return 0; 1416 } 1417 1418 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e, 1419 unsigned int item) 1420 { 1421 if (!e->values) 1422 return item; 1423 1424 return e->values[item]; 1425 } 1426 1427 static inline bool snd_soc_component_is_active( 1428 struct snd_soc_component *component) 1429 { 1430 return component->active != 0; 1431 } 1432 1433 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec) 1434 { 1435 return snd_soc_component_is_active(&codec->component); 1436 } 1437 1438 /** 1439 * snd_soc_kcontrol_component() - Returns the component that registered the 1440 * control 1441 * @kcontrol: The control for which to get the component 1442 * 1443 * Note: This function will work correctly if the control has been registered 1444 * for a component. Either with snd_soc_add_codec_controls() or 1445 * snd_soc_add_platform_controls() or via table based setup for either a 1446 * CODEC, a platform or component driver. Otherwise the behavior is undefined. 1447 */ 1448 static inline struct snd_soc_component *snd_soc_kcontrol_component( 1449 struct snd_kcontrol *kcontrol) 1450 { 1451 return snd_kcontrol_chip(kcontrol); 1452 } 1453 1454 /** 1455 * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control 1456 * @kcontrol: The control for which to get the CODEC 1457 * 1458 * Note: This function will only work correctly if the control has been 1459 * registered with snd_soc_add_codec_controls() or via table based setup of 1460 * snd_soc_codec_driver. Otherwise the behavior is undefined. 1461 */ 1462 static inline struct snd_soc_codec *snd_soc_kcontrol_codec( 1463 struct snd_kcontrol *kcontrol) 1464 { 1465 return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol)); 1466 } 1467 1468 /** 1469 * snd_soc_kcontrol_platform() - Returns the platform that registerd the control 1470 * @kcontrol: The control for which to get the platform 1471 * 1472 * Note: This function will only work correctly if the control has been 1473 * registered with snd_soc_add_platform_controls() or via table based setup of 1474 * a snd_soc_platform_driver. Otherwise the behavior is undefined. 1475 */ 1476 static inline struct snd_soc_platform *snd_soc_kcontrol_platform( 1477 struct snd_kcontrol *kcontrol) 1478 { 1479 return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol)); 1480 } 1481 1482 int snd_soc_util_init(void); 1483 void snd_soc_util_exit(void); 1484 1485 int snd_soc_of_parse_card_name(struct snd_soc_card *card, 1486 const char *propname); 1487 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card, 1488 const char *propname); 1489 int snd_soc_of_parse_tdm_slot(struct device_node *np, 1490 unsigned int *slots, 1491 unsigned int *slot_width); 1492 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card, 1493 const char *propname); 1494 unsigned int snd_soc_of_parse_daifmt(struct device_node *np, 1495 const char *prefix, 1496 struct device_node **bitclkmaster, 1497 struct device_node **framemaster); 1498 int snd_soc_of_get_dai_name(struct device_node *of_node, 1499 const char **dai_name); 1500 int snd_soc_of_get_dai_link_codecs(struct device *dev, 1501 struct device_node *of_node, 1502 struct snd_soc_dai_link *dai_link); 1503 1504 #include <sound/soc-dai.h> 1505 1506 #ifdef CONFIG_DEBUG_FS 1507 extern struct dentry *snd_soc_debugfs_root; 1508 #endif 1509 1510 extern const struct dev_pm_ops snd_soc_pm_ops; 1511 1512 /* Helper functions */ 1513 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm) 1514 { 1515 mutex_lock(&dapm->card->dapm_mutex); 1516 } 1517 1518 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm) 1519 { 1520 mutex_unlock(&dapm->card->dapm_mutex); 1521 } 1522 1523 #endif 1524