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