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