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