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