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 #define SND_SOC_BYTES_E(xname, xbase, xregs, xhandler_get, xhandler_put) \ 303 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 304 .info = snd_soc_bytes_info, .get = xhandler_get, \ 305 .put = xhandler_put, .private_value = \ 306 ((unsigned long)&(struct soc_bytes) \ 307 {.base = xbase, .num_regs = xregs }) } 308 309 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask) \ 310 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 311 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \ 312 .put = snd_soc_bytes_put, .private_value = \ 313 ((unsigned long)&(struct soc_bytes) \ 314 {.base = xbase, .num_regs = xregs, \ 315 .mask = xmask }) } 316 317 /* 318 * SND_SOC_BYTES_EXT is deprecated, please USE SND_SOC_BYTES_TLV instead 319 */ 320 #define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \ 321 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 322 .info = snd_soc_bytes_info_ext, \ 323 .get = xhandler_get, .put = xhandler_put, \ 324 .private_value = (unsigned long)&(struct soc_bytes_ext) \ 325 {.max = xcount} } 326 #define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \ 327 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 328 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \ 329 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \ 330 .tlv.c = (snd_soc_bytes_tlv_callback), \ 331 .info = snd_soc_bytes_info_ext, \ 332 .private_value = (unsigned long)&(struct soc_bytes_ext) \ 333 {.max = xcount, .get = xhandler_get, .put = xhandler_put, } } 334 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \ 335 xmin, xmax, xinvert) \ 336 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ 337 .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \ 338 .put = snd_soc_put_xr_sx, \ 339 .private_value = (unsigned long)&(struct soc_mreg_control) \ 340 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \ 341 .invert = xinvert, .min = xmin, .max = xmax} } 342 343 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \ 344 SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \ 345 snd_soc_get_strobe, snd_soc_put_strobe) 346 347 /* 348 * Simplified versions of above macros, declaring a struct and calculating 349 * ARRAY_SIZE internally 350 */ 351 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \ 352 const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \ 353 ARRAY_SIZE(xtexts), xtexts) 354 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \ 355 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts) 356 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \ 357 const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts) 358 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \ 359 const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \ 360 ARRAY_SIZE(xtexts), xtexts, xvalues) 361 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \ 362 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues) 363 364 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \ 365 const struct soc_enum name = SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, \ 366 xshift, xmask, ARRAY_SIZE(xtexts), xtexts, xvalues) 367 368 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \ 369 const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts) 370 371 /* 372 * Bias levels 373 * 374 * @ON: Bias is fully on for audio playback and capture operations. 375 * @PREPARE: Prepare for audio operations. Called before DAPM switching for 376 * stream start and stop operations. 377 * @STANDBY: Low power standby state when no playback/capture operations are 378 * in progress. NOTE: The transition time between STANDBY and ON 379 * should be as fast as possible and no longer than 10ms. 380 * @OFF: Power Off. No restrictions on transition times. 381 */ 382 enum snd_soc_bias_level { 383 SND_SOC_BIAS_OFF = 0, 384 SND_SOC_BIAS_STANDBY = 1, 385 SND_SOC_BIAS_PREPARE = 2, 386 SND_SOC_BIAS_ON = 3, 387 }; 388 389 struct device_node; 390 struct snd_jack; 391 struct snd_soc_card; 392 struct snd_soc_pcm_stream; 393 struct snd_soc_ops; 394 struct snd_soc_pcm_runtime; 395 struct snd_soc_dai; 396 struct snd_soc_dai_driver; 397 struct snd_soc_dai_link; 398 struct snd_soc_component; 399 struct snd_soc_component_driver; 400 struct soc_enum; 401 struct snd_soc_jack; 402 struct snd_soc_jack_zone; 403 struct snd_soc_jack_pin; 404 #include <sound/soc-dapm.h> 405 #include <sound/soc-dpcm.h> 406 #include <sound/soc-topology.h> 407 408 struct snd_soc_jack_gpio; 409 410 typedef int (*hw_write_t)(void *,const char* ,int); 411 412 enum snd_soc_pcm_subclass { 413 SND_SOC_PCM_CLASS_PCM = 0, 414 SND_SOC_PCM_CLASS_BE = 1, 415 }; 416 417 enum snd_soc_card_subclass { 418 SND_SOC_CARD_CLASS_INIT = 0, 419 SND_SOC_CARD_CLASS_RUNTIME = 1, 420 }; 421 422 int snd_soc_register_card(struct snd_soc_card *card); 423 int snd_soc_unregister_card(struct snd_soc_card *card); 424 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card); 425 #ifdef CONFIG_PM_SLEEP 426 int snd_soc_suspend(struct device *dev); 427 int snd_soc_resume(struct device *dev); 428 #else 429 static inline int snd_soc_suspend(struct device *dev) 430 { 431 return 0; 432 } 433 434 static inline int snd_soc_resume(struct device *dev) 435 { 436 return 0; 437 } 438 #endif 439 int snd_soc_poweroff(struct device *dev); 440 int snd_soc_add_component(struct device *dev, 441 struct snd_soc_component *component, 442 const struct snd_soc_component_driver *component_driver, 443 struct snd_soc_dai_driver *dai_drv, 444 int num_dai); 445 int snd_soc_register_component(struct device *dev, 446 const struct snd_soc_component_driver *component_driver, 447 struct snd_soc_dai_driver *dai_drv, int num_dai); 448 int devm_snd_soc_register_component(struct device *dev, 449 const struct snd_soc_component_driver *component_driver, 450 struct snd_soc_dai_driver *dai_drv, int num_dai); 451 void snd_soc_unregister_component(struct device *dev); 452 struct snd_soc_component *snd_soc_lookup_component(struct device *dev, 453 const char *driver_name); 454 455 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num); 456 #ifdef CONFIG_SND_SOC_COMPRESS 457 int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num); 458 #else 459 static inline int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num) 460 { 461 return 0; 462 } 463 #endif 464 465 void snd_soc_disconnect_sync(struct device *dev); 466 467 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card, 468 struct snd_soc_dai_link *dai_link); 469 470 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd); 471 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream); 472 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream); 473 474 int snd_soc_runtime_calc_hw(struct snd_soc_pcm_runtime *rtd, 475 struct snd_pcm_hardware *hw, int stream); 476 477 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd, 478 unsigned int dai_fmt); 479 480 #ifdef CONFIG_DMI 481 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour); 482 #else 483 static inline int snd_soc_set_dmi_name(struct snd_soc_card *card, 484 const char *flavour) 485 { 486 return 0; 487 } 488 #endif 489 490 /* Utility functions to get clock rates from various things */ 491 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots); 492 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params); 493 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots); 494 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms); 495 496 /* set runtime hw params */ 497 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream, 498 const struct snd_pcm_hardware *hw); 499 500 /* Jack reporting */ 501 int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type, 502 struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins, 503 unsigned int num_pins); 504 505 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask); 506 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count, 507 struct snd_soc_jack_pin *pins); 508 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack, 509 struct notifier_block *nb); 510 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack, 511 struct notifier_block *nb); 512 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count, 513 struct snd_soc_jack_zone *zones); 514 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage); 515 #ifdef CONFIG_GPIOLIB 516 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count, 517 struct snd_soc_jack_gpio *gpios); 518 int snd_soc_jack_add_gpiods(struct device *gpiod_dev, 519 struct snd_soc_jack *jack, 520 int count, struct snd_soc_jack_gpio *gpios); 521 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count, 522 struct snd_soc_jack_gpio *gpios); 523 #else 524 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count, 525 struct snd_soc_jack_gpio *gpios) 526 { 527 return 0; 528 } 529 530 static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev, 531 struct snd_soc_jack *jack, 532 int count, 533 struct snd_soc_jack_gpio *gpios) 534 { 535 return 0; 536 } 537 538 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count, 539 struct snd_soc_jack_gpio *gpios) 540 { 541 } 542 #endif 543 544 struct snd_ac97 *snd_soc_alloc_ac97_component(struct snd_soc_component *component); 545 struct snd_ac97 *snd_soc_new_ac97_component(struct snd_soc_component *component, 546 unsigned int id, unsigned int id_mask); 547 void snd_soc_free_ac97_component(struct snd_ac97 *ac97); 548 549 #ifdef CONFIG_SND_SOC_AC97_BUS 550 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops); 551 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops, 552 struct platform_device *pdev); 553 554 extern struct snd_ac97_bus_ops *soc_ac97_ops; 555 #else 556 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops, 557 struct platform_device *pdev) 558 { 559 return 0; 560 } 561 562 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops) 563 { 564 return 0; 565 } 566 #endif 567 568 /* 569 *Controls 570 */ 571 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template, 572 void *data, const char *long_name, 573 const char *prefix); 574 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card, 575 const char *name); 576 int snd_soc_add_component_controls(struct snd_soc_component *component, 577 const struct snd_kcontrol_new *controls, unsigned int num_controls); 578 int snd_soc_add_card_controls(struct snd_soc_card *soc_card, 579 const struct snd_kcontrol_new *controls, int num_controls); 580 int snd_soc_add_dai_controls(struct snd_soc_dai *dai, 581 const struct snd_kcontrol_new *controls, int num_controls); 582 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol, 583 struct snd_ctl_elem_info *uinfo); 584 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol, 585 struct snd_ctl_elem_value *ucontrol); 586 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol, 587 struct snd_ctl_elem_value *ucontrol); 588 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol, 589 struct snd_ctl_elem_info *uinfo); 590 int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol, 591 struct snd_ctl_elem_info *uinfo); 592 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info 593 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol, 594 struct snd_ctl_elem_value *ucontrol); 595 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol, 596 struct snd_ctl_elem_value *ucontrol); 597 #define snd_soc_get_volsw_2r snd_soc_get_volsw 598 #define snd_soc_put_volsw_2r snd_soc_put_volsw 599 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol, 600 struct snd_ctl_elem_value *ucontrol); 601 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol, 602 struct snd_ctl_elem_value *ucontrol); 603 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol, 604 struct snd_ctl_elem_info *uinfo); 605 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol, 606 struct snd_ctl_elem_value *ucontrol); 607 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol, 608 struct snd_ctl_elem_value *ucontrol); 609 int snd_soc_limit_volume(struct snd_soc_card *card, 610 const char *name, int max); 611 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol, 612 struct snd_ctl_elem_info *uinfo); 613 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol, 614 struct snd_ctl_elem_value *ucontrol); 615 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol, 616 struct snd_ctl_elem_value *ucontrol); 617 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol, 618 struct snd_ctl_elem_info *ucontrol); 619 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag, 620 unsigned int size, unsigned int __user *tlv); 621 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol, 622 struct snd_ctl_elem_info *uinfo); 623 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol, 624 struct snd_ctl_elem_value *ucontrol); 625 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol, 626 struct snd_ctl_elem_value *ucontrol); 627 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol, 628 struct snd_ctl_elem_value *ucontrol); 629 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol, 630 struct snd_ctl_elem_value *ucontrol); 631 632 /** 633 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection 634 * 635 * @pin: name of the pin to update 636 * @mask: bits to check for in reported jack status 637 * @invert: if non-zero then pin is enabled when status is not reported 638 * @list: internal list entry 639 */ 640 struct snd_soc_jack_pin { 641 struct list_head list; 642 const char *pin; 643 int mask; 644 bool invert; 645 }; 646 647 /** 648 * struct snd_soc_jack_zone - Describes voltage zones of jack detection 649 * 650 * @min_mv: start voltage in mv 651 * @max_mv: end voltage in mv 652 * @jack_type: type of jack that is expected for this voltage 653 * @debounce_time: debounce_time for jack, codec driver should wait for this 654 * duration before reading the adc for voltages 655 * @list: internal list entry 656 */ 657 struct snd_soc_jack_zone { 658 unsigned int min_mv; 659 unsigned int max_mv; 660 unsigned int jack_type; 661 unsigned int debounce_time; 662 struct list_head list; 663 }; 664 665 /** 666 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection 667 * 668 * @gpio: legacy gpio number 669 * @idx: gpio descriptor index within the function of the GPIO 670 * consumer device 671 * @gpiod_dev: GPIO consumer device 672 * @name: gpio name. Also as connection ID for the GPIO consumer 673 * device function name lookup 674 * @report: value to report when jack detected 675 * @invert: report presence in low state 676 * @debounce_time: debounce time in ms 677 * @wake: enable as wake source 678 * @jack_status_check: callback function which overrides the detection 679 * to provide more complex checks (eg, reading an 680 * ADC). 681 */ 682 struct snd_soc_jack_gpio { 683 unsigned int gpio; 684 unsigned int idx; 685 struct device *gpiod_dev; 686 const char *name; 687 int report; 688 int invert; 689 int debounce_time; 690 bool wake; 691 692 /* private: */ 693 struct snd_soc_jack *jack; 694 struct delayed_work work; 695 struct notifier_block pm_notifier; 696 struct gpio_desc *desc; 697 698 void *data; 699 /* public: */ 700 int (*jack_status_check)(void *data); 701 }; 702 703 struct snd_soc_jack { 704 struct mutex mutex; 705 struct snd_jack *jack; 706 struct snd_soc_card *card; 707 struct list_head pins; 708 int status; 709 struct blocking_notifier_head notifier; 710 struct list_head jack_zones; 711 }; 712 713 /* SoC PCM stream information */ 714 struct snd_soc_pcm_stream { 715 const char *stream_name; 716 u64 formats; /* SNDRV_PCM_FMTBIT_* */ 717 unsigned int rates; /* SNDRV_PCM_RATE_* */ 718 unsigned int rate_min; /* min rate */ 719 unsigned int rate_max; /* max rate */ 720 unsigned int channels_min; /* min channels */ 721 unsigned int channels_max; /* max channels */ 722 unsigned int sig_bits; /* number of bits of content */ 723 }; 724 725 /* SoC audio ops */ 726 struct snd_soc_ops { 727 int (*startup)(struct snd_pcm_substream *); 728 void (*shutdown)(struct snd_pcm_substream *); 729 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *); 730 int (*hw_free)(struct snd_pcm_substream *); 731 int (*prepare)(struct snd_pcm_substream *); 732 int (*trigger)(struct snd_pcm_substream *, int); 733 }; 734 735 struct snd_soc_compr_ops { 736 int (*startup)(struct snd_compr_stream *); 737 void (*shutdown)(struct snd_compr_stream *); 738 int (*set_params)(struct snd_compr_stream *); 739 int (*trigger)(struct snd_compr_stream *); 740 }; 741 742 struct snd_soc_component* 743 snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd, 744 const char *driver_name); 745 746 struct snd_soc_dai_link_component { 747 const char *name; 748 struct device_node *of_node; 749 const char *dai_name; 750 }; 751 752 struct snd_soc_dai_link { 753 /* config - must be set by machine driver */ 754 const char *name; /* Codec name */ 755 const char *stream_name; /* Stream name */ 756 757 /* 758 * You MAY specify the link's CPU-side device, either by device name, 759 * or by DT/OF node, but not both. If this information is omitted, 760 * the CPU-side DAI is matched using .cpu_dai_name only, which hence 761 * must be globally unique. These fields are currently typically used 762 * only for codec to codec links, or systems using device tree. 763 */ 764 /* 765 * You MAY specify the DAI name of the CPU DAI. If this information is 766 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node 767 * only, which only works well when that device exposes a single DAI. 768 */ 769 struct snd_soc_dai_link_component *cpus; 770 unsigned int num_cpus; 771 772 /* 773 * You MUST specify the link's codec, either by device name, or by 774 * DT/OF node, but not both. 775 */ 776 /* You MUST specify the DAI name within the codec */ 777 struct snd_soc_dai_link_component *codecs; 778 unsigned int num_codecs; 779 780 /* 781 * You MAY specify the link's platform/PCM/DMA driver, either by 782 * device name, or by DT/OF node, but not both. Some forms of link 783 * do not need a platform. In such case, platforms are not mandatory. 784 */ 785 struct snd_soc_dai_link_component *platforms; 786 unsigned int num_platforms; 787 788 int id; /* optional ID for machine driver link identification */ 789 790 const struct snd_soc_pcm_stream *params; 791 unsigned int num_params; 792 793 unsigned int dai_fmt; /* format to set on init */ 794 795 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */ 796 797 /* codec/machine specific init - e.g. add machine controls */ 798 int (*init)(struct snd_soc_pcm_runtime *rtd); 799 800 /* optional hw_params re-writing for BE and FE sync */ 801 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd, 802 struct snd_pcm_hw_params *params); 803 804 /* machine stream operations */ 805 const struct snd_soc_ops *ops; 806 const struct snd_soc_compr_ops *compr_ops; 807 808 /* Mark this pcm with non atomic ops */ 809 bool nonatomic; 810 811 /* For unidirectional dai links */ 812 unsigned int playback_only:1; 813 unsigned int capture_only:1; 814 815 /* Keep DAI active over suspend */ 816 unsigned int ignore_suspend:1; 817 818 /* Symmetry requirements */ 819 unsigned int symmetric_rates:1; 820 unsigned int symmetric_channels:1; 821 unsigned int symmetric_samplebits:1; 822 823 /* Do not create a PCM for this DAI link (Backend link) */ 824 unsigned int no_pcm:1; 825 826 /* This DAI link can route to other DAI links at runtime (Frontend)*/ 827 unsigned int dynamic:1; 828 829 /* DPCM capture and Playback support */ 830 unsigned int dpcm_capture:1; 831 unsigned int dpcm_playback:1; 832 833 /* DPCM used FE & BE merged format */ 834 unsigned int dpcm_merged_format:1; 835 /* DPCM used FE & BE merged channel */ 836 unsigned int dpcm_merged_chan:1; 837 /* DPCM used FE & BE merged rate */ 838 unsigned int dpcm_merged_rate:1; 839 840 /* pmdown_time is ignored at stop */ 841 unsigned int ignore_pmdown_time:1; 842 843 /* Do not create a PCM for this DAI link (Backend link) */ 844 unsigned int ignore:1; 845 846 #ifdef CONFIG_SND_SOC_TOPOLOGY 847 struct snd_soc_dobj dobj; /* For topology */ 848 #endif 849 }; 850 #define for_each_link_codecs(link, i, codec) \ 851 for ((i) = 0; \ 852 ((i) < link->num_codecs) && ((codec) = &link->codecs[i]); \ 853 (i)++) 854 855 #define for_each_link_platforms(link, i, platform) \ 856 for ((i) = 0; \ 857 ((i) < link->num_platforms) && \ 858 ((platform) = &link->platforms[i]); \ 859 (i)++) 860 861 #define for_each_link_cpus(link, i, cpu) \ 862 for ((i) = 0; \ 863 ((i) < link->num_cpus) && ((cpu) = &link->cpus[i]); \ 864 (i)++) 865 866 /* 867 * Sample 1 : Single CPU/Codec/Platform 868 * 869 * SND_SOC_DAILINK_DEFS(test, 870 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai")), 871 * DAILINK_COMP_ARRAY(COMP_CODEC("codec", "codec_dai")), 872 * DAILINK_COMP_ARRAY(COMP_PLATFORM("platform"))); 873 * 874 * struct snd_soc_dai_link link = { 875 * ... 876 * SND_SOC_DAILINK_REG(test), 877 * }; 878 * 879 * Sample 2 : Multi CPU/Codec, no Platform 880 * 881 * SND_SOC_DAILINK_DEFS(test, 882 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"), 883 * COMP_CPU("cpu_dai2")), 884 * DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"), 885 * COMP_CODEC("codec2", "codec_dai2"))); 886 * 887 * struct snd_soc_dai_link link = { 888 * ... 889 * SND_SOC_DAILINK_REG(test), 890 * }; 891 * 892 * Sample 3 : Define each CPU/Codec/Platform manually 893 * 894 * SND_SOC_DAILINK_DEF(test_cpu, 895 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"), 896 * COMP_CPU("cpu_dai2"))); 897 * SND_SOC_DAILINK_DEF(test_codec, 898 * DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"), 899 * COMP_CODEC("codec2", "codec_dai2"))); 900 * SND_SOC_DAILINK_DEF(test_platform, 901 * DAILINK_COMP_ARRAY(COMP_PLATFORM("platform"))); 902 * 903 * struct snd_soc_dai_link link = { 904 * ... 905 * SND_SOC_DAILINK_REG(test_cpu, 906 * test_codec, 907 * test_platform), 908 * }; 909 * 910 * Sample 4 : Sample3 without platform 911 * 912 * struct snd_soc_dai_link link = { 913 * ... 914 * SND_SOC_DAILINK_REG(test_cpu, 915 * test_codec); 916 * }; 917 */ 918 919 #define SND_SOC_DAILINK_REG1(name) SND_SOC_DAILINK_REG3(name##_cpus, name##_codecs, name##_platforms) 920 #define SND_SOC_DAILINK_REG2(cpu, codec) SND_SOC_DAILINK_REG3(cpu, codec, null_dailink_component) 921 #define SND_SOC_DAILINK_REG3(cpu, codec, platform) \ 922 .cpus = cpu, \ 923 .num_cpus = ARRAY_SIZE(cpu), \ 924 .codecs = codec, \ 925 .num_codecs = ARRAY_SIZE(codec), \ 926 .platforms = platform, \ 927 .num_platforms = ARRAY_SIZE(platform) 928 929 #define SND_SOC_DAILINK_REGx(_1, _2, _3, func, ...) func 930 #define SND_SOC_DAILINK_REG(...) \ 931 SND_SOC_DAILINK_REGx(__VA_ARGS__, \ 932 SND_SOC_DAILINK_REG3, \ 933 SND_SOC_DAILINK_REG2, \ 934 SND_SOC_DAILINK_REG1)(__VA_ARGS__) 935 936 #define SND_SOC_DAILINK_DEF(name, def...) \ 937 static struct snd_soc_dai_link_component name[] = { def } 938 939 #define SND_SOC_DAILINK_DEFS(name, cpu, codec, platform...) \ 940 SND_SOC_DAILINK_DEF(name##_cpus, cpu); \ 941 SND_SOC_DAILINK_DEF(name##_codecs, codec); \ 942 SND_SOC_DAILINK_DEF(name##_platforms, platform) 943 944 #define DAILINK_COMP_ARRAY(param...) param 945 #define COMP_EMPTY() { } 946 #define COMP_CPU(_dai) { .dai_name = _dai, } 947 #define COMP_CODEC(_name, _dai) { .name = _name, .dai_name = _dai, } 948 #define COMP_PLATFORM(_name) { .name = _name } 949 #define COMP_AUX(_name) { .name = _name } 950 #define COMP_CODEC_CONF(_name) { .name = _name } 951 #define COMP_DUMMY() { .name = "snd-soc-dummy", .dai_name = "snd-soc-dummy-dai", } 952 953 extern struct snd_soc_dai_link_component null_dailink_component[0]; 954 955 956 struct snd_soc_codec_conf { 957 /* 958 * specify device either by device name, or by 959 * DT/OF node, but not both. 960 */ 961 struct snd_soc_dai_link_component dlc; 962 963 /* 964 * optional map of kcontrol, widget and path name prefixes that are 965 * associated per device 966 */ 967 const char *name_prefix; 968 }; 969 970 struct snd_soc_aux_dev { 971 /* 972 * specify multi-codec either by device name, or by 973 * DT/OF node, but not both. 974 */ 975 struct snd_soc_dai_link_component dlc; 976 977 /* codec/machine specific init - e.g. add machine controls */ 978 int (*init)(struct snd_soc_component *component); 979 }; 980 981 /* SoC card */ 982 struct snd_soc_card { 983 const char *name; 984 const char *long_name; 985 const char *driver_name; 986 const char *components; 987 #ifdef CONFIG_DMI 988 char dmi_longname[80]; 989 #endif /* CONFIG_DMI */ 990 char topology_shortname[32]; 991 992 struct device *dev; 993 struct snd_card *snd_card; 994 struct module *owner; 995 996 struct mutex mutex; 997 struct mutex dapm_mutex; 998 999 /* Mutex for PCM operations */ 1000 struct mutex pcm_mutex; 1001 enum snd_soc_pcm_subclass pcm_subclass; 1002 1003 spinlock_t dpcm_lock; 1004 1005 bool instantiated; 1006 bool topology_shortname_created; 1007 1008 int (*probe)(struct snd_soc_card *card); 1009 int (*late_probe)(struct snd_soc_card *card); 1010 int (*remove)(struct snd_soc_card *card); 1011 1012 /* the pre and post PM functions are used to do any PM work before and 1013 * after the codec and DAI's do any PM work. */ 1014 int (*suspend_pre)(struct snd_soc_card *card); 1015 int (*suspend_post)(struct snd_soc_card *card); 1016 int (*resume_pre)(struct snd_soc_card *card); 1017 int (*resume_post)(struct snd_soc_card *card); 1018 1019 /* callbacks */ 1020 int (*set_bias_level)(struct snd_soc_card *, 1021 struct snd_soc_dapm_context *dapm, 1022 enum snd_soc_bias_level level); 1023 int (*set_bias_level_post)(struct snd_soc_card *, 1024 struct snd_soc_dapm_context *dapm, 1025 enum snd_soc_bias_level level); 1026 1027 int (*add_dai_link)(struct snd_soc_card *, 1028 struct snd_soc_dai_link *link); 1029 void (*remove_dai_link)(struct snd_soc_card *, 1030 struct snd_soc_dai_link *link); 1031 1032 long pmdown_time; 1033 1034 /* CPU <--> Codec DAI links */ 1035 struct snd_soc_dai_link *dai_link; /* predefined links only */ 1036 int num_links; /* predefined links only */ 1037 1038 struct list_head rtd_list; 1039 int num_rtd; 1040 1041 /* optional codec specific configuration */ 1042 struct snd_soc_codec_conf *codec_conf; 1043 int num_configs; 1044 1045 /* 1046 * optional auxiliary devices such as amplifiers or codecs with DAI 1047 * link unused 1048 */ 1049 struct snd_soc_aux_dev *aux_dev; 1050 int num_aux_devs; 1051 struct list_head aux_comp_list; 1052 1053 const struct snd_kcontrol_new *controls; 1054 int num_controls; 1055 1056 /* 1057 * Card-specific routes and widgets. 1058 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in. 1059 */ 1060 const struct snd_soc_dapm_widget *dapm_widgets; 1061 int num_dapm_widgets; 1062 const struct snd_soc_dapm_route *dapm_routes; 1063 int num_dapm_routes; 1064 const struct snd_soc_dapm_widget *of_dapm_widgets; 1065 int num_of_dapm_widgets; 1066 const struct snd_soc_dapm_route *of_dapm_routes; 1067 int num_of_dapm_routes; 1068 bool fully_routed; 1069 bool disable_route_checks; 1070 1071 /* lists of probed devices belonging to this card */ 1072 struct list_head component_dev_list; 1073 struct list_head list; 1074 1075 struct list_head widgets; 1076 struct list_head paths; 1077 struct list_head dapm_list; 1078 struct list_head dapm_dirty; 1079 1080 /* attached dynamic objects */ 1081 struct list_head dobj_list; 1082 1083 /* Generic DAPM context for the card */ 1084 struct snd_soc_dapm_context dapm; 1085 struct snd_soc_dapm_stats dapm_stats; 1086 struct snd_soc_dapm_update *update; 1087 1088 #ifdef CONFIG_DEBUG_FS 1089 struct dentry *debugfs_card_root; 1090 #endif 1091 #ifdef CONFIG_PM_SLEEP 1092 struct work_struct deferred_resume_work; 1093 #endif 1094 u32 pop_time; 1095 1096 void *drvdata; 1097 }; 1098 #define for_each_card_prelinks(card, i, link) \ 1099 for ((i) = 0; \ 1100 ((i) < (card)->num_links) && ((link) = &(card)->dai_link[i]); \ 1101 (i)++) 1102 #define for_each_card_pre_auxs(card, i, aux) \ 1103 for ((i) = 0; \ 1104 ((i) < (card)->num_aux_devs) && ((aux) = &(card)->aux_dev[i]); \ 1105 (i)++) 1106 1107 #define for_each_card_rtds(card, rtd) \ 1108 list_for_each_entry(rtd, &(card)->rtd_list, list) 1109 #define for_each_card_rtds_safe(card, rtd, _rtd) \ 1110 list_for_each_entry_safe(rtd, _rtd, &(card)->rtd_list, list) 1111 1112 #define for_each_card_auxs(card, component) \ 1113 list_for_each_entry(component, &card->aux_comp_list, card_aux_list) 1114 #define for_each_card_auxs_safe(card, component, _comp) \ 1115 list_for_each_entry_safe(component, _comp, \ 1116 &card->aux_comp_list, card_aux_list) 1117 1118 #define for_each_card_components(card, component) \ 1119 list_for_each_entry(component, &(card)->component_dev_list, card_list) 1120 1121 #define for_each_card_dapms(card, dapm) \ 1122 list_for_each_entry(dapm, &card->dapm_list, list) 1123 1124 #define for_each_card_widgets(card, w)\ 1125 list_for_each_entry(w, &card->widgets, list) 1126 #define for_each_card_widgets_safe(card, w, _w) \ 1127 list_for_each_entry_safe(w, _w, &card->widgets, list) 1128 1129 /* SoC machine DAI configuration, glues a codec and cpu DAI together */ 1130 struct snd_soc_pcm_runtime { 1131 struct device *dev; 1132 struct snd_soc_card *card; 1133 struct snd_soc_dai_link *dai_link; 1134 struct snd_pcm_ops ops; 1135 1136 unsigned int params_select; /* currently selected param for dai link */ 1137 1138 /* Dynamic PCM BE runtime data */ 1139 struct snd_soc_dpcm_runtime dpcm[2]; 1140 1141 long pmdown_time; 1142 1143 /* runtime devices */ 1144 struct snd_pcm *pcm; 1145 struct snd_compr *compr; 1146 struct snd_soc_dai *codec_dai; 1147 struct snd_soc_dai *cpu_dai; 1148 struct snd_soc_dai **dais; 1149 1150 struct snd_soc_dai **codec_dais; 1151 unsigned int num_codecs; 1152 1153 struct snd_soc_dai **cpu_dais; 1154 unsigned int num_cpus; 1155 1156 struct delayed_work delayed_work; 1157 void (*close_delayed_work_func)(struct snd_soc_pcm_runtime *rtd); 1158 #ifdef CONFIG_DEBUG_FS 1159 struct dentry *debugfs_dpcm_root; 1160 #endif 1161 1162 unsigned int num; /* 0-based and monotonic increasing */ 1163 struct list_head list; /* rtd list of the soc card */ 1164 1165 /* bit field */ 1166 unsigned int pop_wait:1; 1167 unsigned int fe_compr:1; /* for Dynamic PCM */ 1168 1169 int num_components; 1170 struct snd_soc_component *components[0]; /* CPU/Codec/Platform */ 1171 }; 1172 /* see soc_new_pcm_runtime() */ 1173 #define asoc_rtd_to_cpu(rtd, n) (rtd)->dais[n] 1174 #define asoc_rtd_to_codec(rtd, n) (rtd)->dais[n + (rtd)->num_cpus] 1175 1176 #define for_each_rtd_components(rtd, i, component) \ 1177 for ((i) = 0; \ 1178 ((i) < rtd->num_components) && ((component) = rtd->components[i]);\ 1179 (i)++) 1180 #define for_each_rtd_cpu_dais(rtd, i, dai) \ 1181 for ((i) = 0; \ 1182 ((i) < rtd->num_cpus) && ((dai) = rtd->cpu_dais[i]); \ 1183 (i)++) 1184 #define for_each_rtd_cpu_dais_rollback(rtd, i, dai) \ 1185 for (; (--(i) >= 0) && ((dai) = rtd->cpu_dais[i]);) 1186 #define for_each_rtd_codec_dais(rtd, i, dai) \ 1187 for ((i) = 0; \ 1188 ((i) < rtd->num_codecs) && ((dai) = rtd->codec_dais[i]); \ 1189 (i)++) 1190 #define for_each_rtd_codec_dais_rollback(rtd, i, dai) \ 1191 for (; (--(i) >= 0) && ((dai) = rtd->codec_dais[i]);) 1192 #define for_each_rtd_dais(rtd, i, dai) \ 1193 for ((i) = 0; \ 1194 ((i) < (rtd)->num_cpus + (rtd)->num_codecs) && \ 1195 ((dai) = (rtd)->dais[i]); \ 1196 (i)++) 1197 1198 void snd_soc_close_delayed_work(struct snd_soc_pcm_runtime *rtd); 1199 1200 /* mixer control */ 1201 struct soc_mixer_control { 1202 int min, max, platform_max; 1203 int reg, rreg; 1204 unsigned int shift, rshift; 1205 unsigned int sign_bit; 1206 unsigned int invert:1; 1207 unsigned int autodisable:1; 1208 #ifdef CONFIG_SND_SOC_TOPOLOGY 1209 struct snd_soc_dobj dobj; 1210 #endif 1211 }; 1212 1213 struct soc_bytes { 1214 int base; 1215 int num_regs; 1216 u32 mask; 1217 }; 1218 1219 struct soc_bytes_ext { 1220 int max; 1221 #ifdef CONFIG_SND_SOC_TOPOLOGY 1222 struct snd_soc_dobj dobj; 1223 #endif 1224 /* used for TLV byte control */ 1225 int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes, 1226 unsigned int size); 1227 int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes, 1228 unsigned int size); 1229 }; 1230 1231 /* multi register control */ 1232 struct soc_mreg_control { 1233 long min, max; 1234 unsigned int regbase, regcount, nbits, invert; 1235 }; 1236 1237 /* enumerated kcontrol */ 1238 struct soc_enum { 1239 int reg; 1240 unsigned char shift_l; 1241 unsigned char shift_r; 1242 unsigned int items; 1243 unsigned int mask; 1244 const char * const *texts; 1245 const unsigned int *values; 1246 unsigned int autodisable:1; 1247 #ifdef CONFIG_SND_SOC_TOPOLOGY 1248 struct snd_soc_dobj dobj; 1249 #endif 1250 }; 1251 1252 /* device driver data */ 1253 1254 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card, 1255 void *data) 1256 { 1257 card->drvdata = data; 1258 } 1259 1260 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card) 1261 { 1262 return card->drvdata; 1263 } 1264 1265 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc) 1266 { 1267 if (mc->reg == mc->rreg && mc->shift == mc->rshift) 1268 return 0; 1269 /* 1270 * mc->reg == mc->rreg && mc->shift != mc->rshift, or 1271 * mc->reg != mc->rreg means that the control is 1272 * stereo (bits in one register or in two registers) 1273 */ 1274 return 1; 1275 } 1276 1277 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e, 1278 unsigned int val) 1279 { 1280 unsigned int i; 1281 1282 if (!e->values) 1283 return val; 1284 1285 for (i = 0; i < e->items; i++) 1286 if (val == e->values[i]) 1287 return i; 1288 1289 return 0; 1290 } 1291 1292 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e, 1293 unsigned int item) 1294 { 1295 if (!e->values) 1296 return item; 1297 1298 return e->values[item]; 1299 } 1300 1301 /** 1302 * snd_soc_kcontrol_component() - Returns the component that registered the 1303 * control 1304 * @kcontrol: The control for which to get the component 1305 * 1306 * Note: This function will work correctly if the control has been registered 1307 * for a component. With snd_soc_add_codec_controls() or via table based 1308 * setup for either a CODEC or component driver. Otherwise the behavior is 1309 * undefined. 1310 */ 1311 static inline struct snd_soc_component *snd_soc_kcontrol_component( 1312 struct snd_kcontrol *kcontrol) 1313 { 1314 return snd_kcontrol_chip(kcontrol); 1315 } 1316 1317 int snd_soc_util_init(void); 1318 void snd_soc_util_exit(void); 1319 1320 int snd_soc_of_parse_card_name(struct snd_soc_card *card, 1321 const char *propname); 1322 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card, 1323 const char *propname); 1324 int snd_soc_of_get_slot_mask(struct device_node *np, 1325 const char *prop_name, 1326 unsigned int *mask); 1327 int snd_soc_of_parse_tdm_slot(struct device_node *np, 1328 unsigned int *tx_mask, 1329 unsigned int *rx_mask, 1330 unsigned int *slots, 1331 unsigned int *slot_width); 1332 void snd_soc_of_parse_node_prefix(struct device_node *np, 1333 struct snd_soc_codec_conf *codec_conf, 1334 struct device_node *of_node, 1335 const char *propname); 1336 static inline 1337 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card, 1338 struct snd_soc_codec_conf *codec_conf, 1339 struct device_node *of_node, 1340 const char *propname) 1341 { 1342 snd_soc_of_parse_node_prefix(card->dev->of_node, 1343 codec_conf, of_node, propname); 1344 } 1345 1346 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card, 1347 const char *propname); 1348 unsigned int snd_soc_of_parse_daifmt(struct device_node *np, 1349 const char *prefix, 1350 struct device_node **bitclkmaster, 1351 struct device_node **framemaster); 1352 int snd_soc_get_dai_id(struct device_node *ep); 1353 int snd_soc_get_dai_name(struct of_phandle_args *args, 1354 const char **dai_name); 1355 int snd_soc_of_get_dai_name(struct device_node *of_node, 1356 const char **dai_name); 1357 int snd_soc_of_get_dai_link_codecs(struct device *dev, 1358 struct device_node *of_node, 1359 struct snd_soc_dai_link *dai_link); 1360 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link); 1361 1362 int snd_soc_add_pcm_runtime(struct snd_soc_card *card, 1363 struct snd_soc_dai_link *dai_link); 1364 void snd_soc_remove_pcm_runtime(struct snd_soc_card *card, 1365 struct snd_soc_pcm_runtime *rtd); 1366 1367 struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component, 1368 struct snd_soc_dai_driver *dai_drv, 1369 bool legacy_dai_naming); 1370 void snd_soc_unregister_dai(struct snd_soc_dai *dai); 1371 1372 struct snd_soc_dai *snd_soc_find_dai( 1373 const struct snd_soc_dai_link_component *dlc); 1374 1375 #include <sound/soc-dai.h> 1376 1377 static inline 1378 struct snd_soc_dai *snd_soc_card_get_codec_dai(struct snd_soc_card *card, 1379 const char *dai_name) 1380 { 1381 struct snd_soc_pcm_runtime *rtd; 1382 1383 list_for_each_entry(rtd, &card->rtd_list, list) { 1384 if (!strcmp(rtd->codec_dai->name, dai_name)) 1385 return rtd->codec_dai; 1386 } 1387 1388 return NULL; 1389 } 1390 1391 static inline 1392 int snd_soc_fixup_dai_links_platform_name(struct snd_soc_card *card, 1393 const char *platform_name) 1394 { 1395 struct snd_soc_dai_link *dai_link; 1396 const char *name; 1397 int i; 1398 1399 if (!platform_name) /* nothing to do */ 1400 return 0; 1401 1402 /* set platform name for each dailink */ 1403 for_each_card_prelinks(card, i, dai_link) { 1404 name = devm_kstrdup(card->dev, platform_name, GFP_KERNEL); 1405 if (!name) 1406 return -ENOMEM; 1407 1408 if (!dai_link->platforms) 1409 return -EINVAL; 1410 1411 /* only single platform is supported for now */ 1412 dai_link->platforms->name = name; 1413 } 1414 1415 return 0; 1416 } 1417 1418 #ifdef CONFIG_DEBUG_FS 1419 extern struct dentry *snd_soc_debugfs_root; 1420 #endif 1421 1422 extern const struct dev_pm_ops snd_soc_pm_ops; 1423 1424 /* Helper functions */ 1425 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm) 1426 { 1427 mutex_lock_nested(&dapm->card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME); 1428 } 1429 1430 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm) 1431 { 1432 mutex_unlock(&dapm->card->dapm_mutex); 1433 } 1434 1435 #include <sound/soc-component.h> 1436 1437 #endif 1438