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 #endif 466 467 void snd_soc_disconnect_sync(struct device *dev); 468 469 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card, 470 const char *dai_link, int stream); 471 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card, 472 const char *dai_link); 473 474 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd); 475 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream); 476 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream); 477 478 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd, 479 unsigned int dai_fmt); 480 481 #ifdef CONFIG_DMI 482 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour); 483 #else 484 static inline int snd_soc_set_dmi_name(struct snd_soc_card *card, 485 const char *flavour) 486 { 487 return 0; 488 } 489 #endif 490 491 /* Utility functions to get clock rates from various things */ 492 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots); 493 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params); 494 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots); 495 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms); 496 497 /* set runtime hw params */ 498 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream, 499 const struct snd_pcm_hardware *hw); 500 501 int soc_dai_hw_params(struct snd_pcm_substream *substream, 502 struct snd_pcm_hw_params *params, 503 struct snd_soc_dai *dai); 504 505 /* Jack reporting */ 506 int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type, 507 struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins, 508 unsigned int num_pins); 509 510 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask); 511 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count, 512 struct snd_soc_jack_pin *pins); 513 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack, 514 struct notifier_block *nb); 515 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack, 516 struct notifier_block *nb); 517 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count, 518 struct snd_soc_jack_zone *zones); 519 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage); 520 #ifdef CONFIG_GPIOLIB 521 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count, 522 struct snd_soc_jack_gpio *gpios); 523 int snd_soc_jack_add_gpiods(struct device *gpiod_dev, 524 struct snd_soc_jack *jack, 525 int count, struct snd_soc_jack_gpio *gpios); 526 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count, 527 struct snd_soc_jack_gpio *gpios); 528 #else 529 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count, 530 struct snd_soc_jack_gpio *gpios) 531 { 532 return 0; 533 } 534 535 static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev, 536 struct snd_soc_jack *jack, 537 int count, 538 struct snd_soc_jack_gpio *gpios) 539 { 540 return 0; 541 } 542 543 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count, 544 struct snd_soc_jack_gpio *gpios) 545 { 546 } 547 #endif 548 549 #ifdef CONFIG_SND_SOC_AC97_BUS 550 struct snd_ac97 *snd_soc_alloc_ac97_component(struct snd_soc_component *component); 551 struct snd_ac97 *snd_soc_new_ac97_component(struct snd_soc_component *component, 552 unsigned int id, unsigned int id_mask); 553 void snd_soc_free_ac97_component(struct snd_ac97 *ac97); 554 555 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops); 556 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops, 557 struct platform_device *pdev); 558 559 extern struct snd_ac97_bus_ops *soc_ac97_ops; 560 #else 561 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops, 562 struct platform_device *pdev) 563 { 564 return 0; 565 } 566 567 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops) 568 { 569 return 0; 570 } 571 #endif 572 573 /* 574 *Controls 575 */ 576 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template, 577 void *data, const char *long_name, 578 const char *prefix); 579 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card, 580 const char *name); 581 int snd_soc_add_component_controls(struct snd_soc_component *component, 582 const struct snd_kcontrol_new *controls, unsigned int num_controls); 583 int snd_soc_add_card_controls(struct snd_soc_card *soc_card, 584 const struct snd_kcontrol_new *controls, int num_controls); 585 int snd_soc_add_dai_controls(struct snd_soc_dai *dai, 586 const struct snd_kcontrol_new *controls, int num_controls); 587 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol, 588 struct snd_ctl_elem_info *uinfo); 589 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol, 590 struct snd_ctl_elem_value *ucontrol); 591 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol, 592 struct snd_ctl_elem_value *ucontrol); 593 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol, 594 struct snd_ctl_elem_info *uinfo); 595 int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol, 596 struct snd_ctl_elem_info *uinfo); 597 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info 598 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol, 599 struct snd_ctl_elem_value *ucontrol); 600 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol, 601 struct snd_ctl_elem_value *ucontrol); 602 #define snd_soc_get_volsw_2r snd_soc_get_volsw 603 #define snd_soc_put_volsw_2r snd_soc_put_volsw 604 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol, 605 struct snd_ctl_elem_value *ucontrol); 606 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol, 607 struct snd_ctl_elem_value *ucontrol); 608 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol, 609 struct snd_ctl_elem_info *uinfo); 610 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol, 611 struct snd_ctl_elem_value *ucontrol); 612 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol, 613 struct snd_ctl_elem_value *ucontrol); 614 int snd_soc_limit_volume(struct snd_soc_card *card, 615 const char *name, int max); 616 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol, 617 struct snd_ctl_elem_info *uinfo); 618 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol, 619 struct snd_ctl_elem_value *ucontrol); 620 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol, 621 struct snd_ctl_elem_value *ucontrol); 622 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol, 623 struct snd_ctl_elem_info *ucontrol); 624 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag, 625 unsigned int size, unsigned int __user *tlv); 626 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol, 627 struct snd_ctl_elem_info *uinfo); 628 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol, 629 struct snd_ctl_elem_value *ucontrol); 630 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol, 631 struct snd_ctl_elem_value *ucontrol); 632 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol, 633 struct snd_ctl_elem_value *ucontrol); 634 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol, 635 struct snd_ctl_elem_value *ucontrol); 636 637 /** 638 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection 639 * 640 * @pin: name of the pin to update 641 * @mask: bits to check for in reported jack status 642 * @invert: if non-zero then pin is enabled when status is not reported 643 * @list: internal list entry 644 */ 645 struct snd_soc_jack_pin { 646 struct list_head list; 647 const char *pin; 648 int mask; 649 bool invert; 650 }; 651 652 /** 653 * struct snd_soc_jack_zone - Describes voltage zones of jack detection 654 * 655 * @min_mv: start voltage in mv 656 * @max_mv: end voltage in mv 657 * @jack_type: type of jack that is expected for this voltage 658 * @debounce_time: debounce_time for jack, codec driver should wait for this 659 * duration before reading the adc for voltages 660 * @list: internal list entry 661 */ 662 struct snd_soc_jack_zone { 663 unsigned int min_mv; 664 unsigned int max_mv; 665 unsigned int jack_type; 666 unsigned int debounce_time; 667 struct list_head list; 668 }; 669 670 /** 671 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection 672 * 673 * @gpio: legacy gpio number 674 * @idx: gpio descriptor index within the function of the GPIO 675 * consumer device 676 * @gpiod_dev: GPIO consumer device 677 * @name: gpio name. Also as connection ID for the GPIO consumer 678 * device function name lookup 679 * @report: value to report when jack detected 680 * @invert: report presence in low state 681 * @debounce_time: debounce time in ms 682 * @wake: enable as wake source 683 * @jack_status_check: callback function which overrides the detection 684 * to provide more complex checks (eg, reading an 685 * ADC). 686 */ 687 struct snd_soc_jack_gpio { 688 unsigned int gpio; 689 unsigned int idx; 690 struct device *gpiod_dev; 691 const char *name; 692 int report; 693 int invert; 694 int debounce_time; 695 bool wake; 696 697 /* private: */ 698 struct snd_soc_jack *jack; 699 struct delayed_work work; 700 struct notifier_block pm_notifier; 701 struct gpio_desc *desc; 702 703 void *data; 704 /* public: */ 705 int (*jack_status_check)(void *data); 706 }; 707 708 struct snd_soc_jack { 709 struct mutex mutex; 710 struct snd_jack *jack; 711 struct snd_soc_card *card; 712 struct list_head pins; 713 int status; 714 struct blocking_notifier_head notifier; 715 struct list_head jack_zones; 716 }; 717 718 /* SoC PCM stream information */ 719 struct snd_soc_pcm_stream { 720 const char *stream_name; 721 u64 formats; /* SNDRV_PCM_FMTBIT_* */ 722 unsigned int rates; /* SNDRV_PCM_RATE_* */ 723 unsigned int rate_min; /* min rate */ 724 unsigned int rate_max; /* max rate */ 725 unsigned int channels_min; /* min channels */ 726 unsigned int channels_max; /* max channels */ 727 unsigned int sig_bits; /* number of bits of content */ 728 }; 729 730 /* SoC audio ops */ 731 struct snd_soc_ops { 732 int (*startup)(struct snd_pcm_substream *); 733 void (*shutdown)(struct snd_pcm_substream *); 734 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *); 735 int (*hw_free)(struct snd_pcm_substream *); 736 int (*prepare)(struct snd_pcm_substream *); 737 int (*trigger)(struct snd_pcm_substream *, int); 738 }; 739 740 struct snd_soc_compr_ops { 741 int (*startup)(struct snd_compr_stream *); 742 void (*shutdown)(struct snd_compr_stream *); 743 int (*set_params)(struct snd_compr_stream *); 744 int (*trigger)(struct snd_compr_stream *); 745 }; 746 747 /* component interface */ 748 struct snd_soc_component_driver { 749 const char *name; 750 751 /* Default control and setup, added after probe() is run */ 752 const struct snd_kcontrol_new *controls; 753 unsigned int num_controls; 754 const struct snd_soc_dapm_widget *dapm_widgets; 755 unsigned int num_dapm_widgets; 756 const struct snd_soc_dapm_route *dapm_routes; 757 unsigned int num_dapm_routes; 758 759 int (*probe)(struct snd_soc_component *); 760 void (*remove)(struct snd_soc_component *); 761 int (*suspend)(struct snd_soc_component *); 762 int (*resume)(struct snd_soc_component *); 763 764 unsigned int (*read)(struct snd_soc_component *, unsigned int); 765 int (*write)(struct snd_soc_component *, unsigned int, unsigned int); 766 767 /* pcm creation and destruction */ 768 int (*pcm_new)(struct snd_soc_pcm_runtime *); 769 void (*pcm_free)(struct snd_pcm *); 770 771 /* component wide operations */ 772 int (*set_sysclk)(struct snd_soc_component *component, 773 int clk_id, int source, unsigned int freq, int dir); 774 int (*set_pll)(struct snd_soc_component *component, int pll_id, 775 int source, unsigned int freq_in, unsigned int freq_out); 776 int (*set_jack)(struct snd_soc_component *component, 777 struct snd_soc_jack *jack, void *data); 778 779 /* DT */ 780 int (*of_xlate_dai_name)(struct snd_soc_component *component, 781 struct of_phandle_args *args, 782 const char **dai_name); 783 int (*of_xlate_dai_id)(struct snd_soc_component *comment, 784 struct device_node *endpoint); 785 void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type, 786 int subseq); 787 int (*stream_event)(struct snd_soc_component *, int event); 788 int (*set_bias_level)(struct snd_soc_component *component, 789 enum snd_soc_bias_level level); 790 791 const struct snd_pcm_ops *ops; 792 const struct snd_compr_ops *compr_ops; 793 794 /* probe ordering - for components with runtime dependencies */ 795 int probe_order; 796 int remove_order; 797 798 /* bits */ 799 unsigned int idle_bias_on:1; 800 unsigned int suspend_bias_off:1; 801 unsigned int use_pmdown_time:1; /* care pmdown_time at stop */ 802 unsigned int endianness:1; 803 unsigned int non_legacy_dai_naming:1; 804 }; 805 806 struct snd_soc_component { 807 const char *name; 808 int id; 809 const char *name_prefix; 810 struct device *dev; 811 struct snd_soc_card *card; 812 813 unsigned int active; 814 815 unsigned int suspended:1; /* is in suspend PM state */ 816 817 struct list_head list; 818 struct list_head card_aux_list; /* for auxiliary bound components */ 819 struct list_head card_list; 820 821 const struct snd_soc_component_driver *driver; 822 823 struct list_head dai_list; 824 int num_dai; 825 826 struct regmap *regmap; 827 int val_bytes; 828 829 struct mutex io_mutex; 830 831 /* attached dynamic objects */ 832 struct list_head dobj_list; 833 834 /* 835 * DO NOT use any of the fields below in drivers, they are temporary and 836 * are going to be removed again soon. If you use them in driver code the 837 * driver will be marked as BROKEN when these fields are removed. 838 */ 839 840 /* Don't use these, use snd_soc_component_get_dapm() */ 841 struct snd_soc_dapm_context dapm; 842 843 /* machine specific init */ 844 int (*init)(struct snd_soc_component *component); 845 846 #ifdef CONFIG_DEBUG_FS 847 struct dentry *debugfs_root; 848 const char *debugfs_prefix; 849 #endif 850 }; 851 852 struct snd_soc_rtdcom_list { 853 struct snd_soc_component *component; 854 struct list_head list; /* rtd::component_list */ 855 }; 856 struct snd_soc_component* 857 snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd, 858 const char *driver_name); 859 #define for_each_rtdcom(rtd, rtdcom) \ 860 list_for_each_entry(rtdcom, &(rtd)->component_list, list) 861 #define for_each_rtdcom_safe(rtd, rtdcom1, rtdcom2) \ 862 list_for_each_entry_safe(rtdcom1, rtdcom2, &(rtd)->component_list, list) 863 864 struct snd_soc_dai_link_component { 865 const char *name; 866 struct device_node *of_node; 867 const char *dai_name; 868 }; 869 870 struct snd_soc_dai_link { 871 /* config - must be set by machine driver */ 872 const char *name; /* Codec name */ 873 const char *stream_name; /* Stream name */ 874 /* 875 * You MAY specify the link's CPU-side device, either by device name, 876 * or by DT/OF node, but not both. If this information is omitted, 877 * the CPU-side DAI is matched using .cpu_dai_name only, which hence 878 * must be globally unique. These fields are currently typically used 879 * only for codec to codec links, or systems using device tree. 880 */ 881 const char *cpu_name; 882 struct device_node *cpu_of_node; 883 /* 884 * You MAY specify the DAI name of the CPU DAI. If this information is 885 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node 886 * only, which only works well when that device exposes a single DAI. 887 */ 888 const char *cpu_dai_name; 889 /* 890 * You MUST specify the link's codec, either by device name, or by 891 * DT/OF node, but not both. 892 */ 893 const char *codec_name; 894 struct device_node *codec_of_node; 895 /* You MUST specify the DAI name within the codec */ 896 const char *codec_dai_name; 897 898 struct snd_soc_dai_link_component *codecs; 899 unsigned int num_codecs; 900 901 /* 902 * You MAY specify the link's platform/PCM/DMA driver, either by 903 * device name, or by DT/OF node, but not both. Some forms of link 904 * do not need a platform. 905 */ 906 const char *platform_name; 907 struct device_node *platform_of_node; 908 int id; /* optional ID for machine driver link identification */ 909 910 const struct snd_soc_pcm_stream *params; 911 unsigned int num_params; 912 913 unsigned int dai_fmt; /* format to set on init */ 914 915 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */ 916 917 /* codec/machine specific init - e.g. add machine controls */ 918 int (*init)(struct snd_soc_pcm_runtime *rtd); 919 920 /* optional hw_params re-writing for BE and FE sync */ 921 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd, 922 struct snd_pcm_hw_params *params); 923 924 /* machine stream operations */ 925 const struct snd_soc_ops *ops; 926 const struct snd_soc_compr_ops *compr_ops; 927 928 /* Mark this pcm with non atomic ops */ 929 bool nonatomic; 930 931 /* For unidirectional dai links */ 932 unsigned int playback_only:1; 933 unsigned int capture_only:1; 934 935 /* Keep DAI active over suspend */ 936 unsigned int ignore_suspend:1; 937 938 /* Symmetry requirements */ 939 unsigned int symmetric_rates:1; 940 unsigned int symmetric_channels:1; 941 unsigned int symmetric_samplebits:1; 942 943 /* Do not create a PCM for this DAI link (Backend link) */ 944 unsigned int no_pcm:1; 945 946 /* This DAI link can route to other DAI links at runtime (Frontend)*/ 947 unsigned int dynamic:1; 948 949 /* DPCM capture and Playback support */ 950 unsigned int dpcm_capture:1; 951 unsigned int dpcm_playback:1; 952 953 /* DPCM used FE & BE merged format */ 954 unsigned int dpcm_merged_format:1; 955 956 /* pmdown_time is ignored at stop */ 957 unsigned int ignore_pmdown_time:1; 958 959 struct list_head list; /* DAI link list of the soc card */ 960 struct snd_soc_dobj dobj; /* For topology */ 961 }; 962 963 struct snd_soc_codec_conf { 964 /* 965 * specify device either by device name, or by 966 * DT/OF node, but not both. 967 */ 968 const char *dev_name; 969 struct device_node *of_node; 970 971 /* 972 * optional map of kcontrol, widget and path name prefixes that are 973 * associated per device 974 */ 975 const char *name_prefix; 976 }; 977 978 struct snd_soc_aux_dev { 979 const char *name; /* Codec name */ 980 981 /* 982 * specify multi-codec either by device name, or by 983 * DT/OF node, but not both. 984 */ 985 const char *codec_name; 986 struct device_node *codec_of_node; 987 988 /* codec/machine specific init - e.g. add machine controls */ 989 int (*init)(struct snd_soc_component *component); 990 }; 991 992 /* SoC card */ 993 struct snd_soc_card { 994 const char *name; 995 const char *long_name; 996 const char *driver_name; 997 char dmi_longname[80]; 998 999 struct device *dev; 1000 struct snd_card *snd_card; 1001 struct module *owner; 1002 1003 struct mutex mutex; 1004 struct mutex dapm_mutex; 1005 1006 bool instantiated; 1007 1008 int (*probe)(struct snd_soc_card *card); 1009 int (*late_probe)(struct snd_soc_card *card); 1010 int (*remove)(struct snd_soc_card *card); 1011 1012 /* the pre and post PM functions are used to do any PM work before and 1013 * after the codec and DAI's do any PM work. */ 1014 int (*suspend_pre)(struct snd_soc_card *card); 1015 int (*suspend_post)(struct snd_soc_card *card); 1016 int (*resume_pre)(struct snd_soc_card *card); 1017 int (*resume_post)(struct snd_soc_card *card); 1018 1019 /* callbacks */ 1020 int (*set_bias_level)(struct snd_soc_card *, 1021 struct snd_soc_dapm_context *dapm, 1022 enum snd_soc_bias_level level); 1023 int (*set_bias_level_post)(struct snd_soc_card *, 1024 struct snd_soc_dapm_context *dapm, 1025 enum snd_soc_bias_level level); 1026 1027 int (*add_dai_link)(struct snd_soc_card *, 1028 struct snd_soc_dai_link *link); 1029 void (*remove_dai_link)(struct snd_soc_card *, 1030 struct snd_soc_dai_link *link); 1031 1032 long pmdown_time; 1033 1034 /* CPU <--> Codec DAI links */ 1035 struct snd_soc_dai_link *dai_link; /* predefined links only */ 1036 int num_links; /* predefined links only */ 1037 struct list_head dai_link_list; /* all links */ 1038 int num_dai_links; 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 struct work_struct deferred_resume_work; 1073 1074 /* lists of probed devices belonging to this card */ 1075 struct list_head component_dev_list; 1076 1077 struct list_head widgets; 1078 struct list_head paths; 1079 struct list_head dapm_list; 1080 struct list_head dapm_dirty; 1081 1082 /* attached dynamic objects */ 1083 struct list_head dobj_list; 1084 1085 /* Generic DAPM context for the card */ 1086 struct snd_soc_dapm_context dapm; 1087 struct snd_soc_dapm_stats dapm_stats; 1088 struct snd_soc_dapm_update *update; 1089 1090 #ifdef CONFIG_DEBUG_FS 1091 struct dentry *debugfs_card_root; 1092 struct dentry *debugfs_pop_time; 1093 #endif 1094 u32 pop_time; 1095 1096 void *drvdata; 1097 }; 1098 1099 /* SoC machine DAI configuration, glues a codec and cpu DAI together */ 1100 struct snd_soc_pcm_runtime { 1101 struct device *dev; 1102 struct snd_soc_card *card; 1103 struct snd_soc_dai_link *dai_link; 1104 struct mutex pcm_mutex; 1105 enum snd_soc_pcm_subclass pcm_subclass; 1106 struct snd_pcm_ops ops; 1107 1108 /* Dynamic PCM BE runtime data */ 1109 struct snd_soc_dpcm_runtime dpcm[2]; 1110 int fe_compr; 1111 1112 long pmdown_time; 1113 1114 /* runtime devices */ 1115 struct snd_pcm *pcm; 1116 struct snd_compr *compr; 1117 struct snd_soc_dai *codec_dai; 1118 struct snd_soc_dai *cpu_dai; 1119 1120 struct snd_soc_dai **codec_dais; 1121 unsigned int num_codecs; 1122 1123 struct delayed_work delayed_work; 1124 #ifdef CONFIG_DEBUG_FS 1125 struct dentry *debugfs_dpcm_root; 1126 #endif 1127 1128 unsigned int num; /* 0-based and monotonic increasing */ 1129 struct list_head list; /* rtd list of the soc card */ 1130 struct list_head component_list; /* list of connected components */ 1131 1132 /* bit field */ 1133 unsigned int dev_registered:1; 1134 unsigned int pop_wait:1; 1135 }; 1136 1137 /* mixer control */ 1138 struct soc_mixer_control { 1139 int min, max, platform_max; 1140 int reg, rreg; 1141 unsigned int shift, rshift; 1142 unsigned int sign_bit; 1143 unsigned int invert:1; 1144 unsigned int autodisable:1; 1145 struct snd_soc_dobj dobj; 1146 }; 1147 1148 struct soc_bytes { 1149 int base; 1150 int num_regs; 1151 u32 mask; 1152 }; 1153 1154 struct soc_bytes_ext { 1155 int max; 1156 struct snd_soc_dobj dobj; 1157 1158 /* used for TLV byte control */ 1159 int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes, 1160 unsigned int size); 1161 int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes, 1162 unsigned int size); 1163 }; 1164 1165 /* multi register control */ 1166 struct soc_mreg_control { 1167 long min, max; 1168 unsigned int regbase, regcount, nbits, invert; 1169 }; 1170 1171 /* enumerated kcontrol */ 1172 struct soc_enum { 1173 int reg; 1174 unsigned char shift_l; 1175 unsigned char shift_r; 1176 unsigned int items; 1177 unsigned int mask; 1178 const char * const *texts; 1179 const unsigned int *values; 1180 unsigned int autodisable:1; 1181 struct snd_soc_dobj dobj; 1182 }; 1183 1184 /** 1185 * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is 1186 * embedded in 1187 * @dapm: The DAPM context to cast to the component 1188 * 1189 * This function must only be used on DAPM contexts that are known to be part of 1190 * a component (e.g. in a component driver). Otherwise the behavior is 1191 * undefined. 1192 */ 1193 static inline struct snd_soc_component *snd_soc_dapm_to_component( 1194 struct snd_soc_dapm_context *dapm) 1195 { 1196 return container_of(dapm, struct snd_soc_component, dapm); 1197 } 1198 1199 /** 1200 * snd_soc_component_get_dapm() - Returns the DAPM context associated with a 1201 * component 1202 * @component: The component for which to get the DAPM context 1203 */ 1204 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm( 1205 struct snd_soc_component *component) 1206 { 1207 return &component->dapm; 1208 } 1209 1210 /** 1211 * snd_soc_component_init_bias_level() - Initialize COMPONENT DAPM bias level 1212 * @component: The COMPONENT for which to initialize the DAPM bias level 1213 * @level: The DAPM level to initialize to 1214 * 1215 * Initializes the COMPONENT DAPM bias level. See snd_soc_dapm_init_bias_level(). 1216 */ 1217 static inline void 1218 snd_soc_component_init_bias_level(struct snd_soc_component *component, 1219 enum snd_soc_bias_level level) 1220 { 1221 snd_soc_dapm_init_bias_level( 1222 snd_soc_component_get_dapm(component), level); 1223 } 1224 1225 /** 1226 * snd_soc_component_get_bias_level() - Get current COMPONENT DAPM bias level 1227 * @component: The COMPONENT for which to get the DAPM bias level 1228 * 1229 * Returns: The current DAPM bias level of the COMPONENT. 1230 */ 1231 static inline enum snd_soc_bias_level 1232 snd_soc_component_get_bias_level(struct snd_soc_component *component) 1233 { 1234 return snd_soc_dapm_get_bias_level( 1235 snd_soc_component_get_dapm(component)); 1236 } 1237 1238 /** 1239 * snd_soc_component_force_bias_level() - Set the COMPONENT DAPM bias level 1240 * @component: The COMPONENT for which to set the level 1241 * @level: The level to set to 1242 * 1243 * Forces the COMPONENT bias level to a specific state. See 1244 * snd_soc_dapm_force_bias_level(). 1245 */ 1246 static inline int 1247 snd_soc_component_force_bias_level(struct snd_soc_component *component, 1248 enum snd_soc_bias_level level) 1249 { 1250 return snd_soc_dapm_force_bias_level( 1251 snd_soc_component_get_dapm(component), 1252 level); 1253 } 1254 1255 /** 1256 * snd_soc_dapm_kcontrol_component() - Returns the component associated to a kcontrol 1257 * @kcontrol: The kcontrol 1258 * 1259 * This function must only be used on DAPM contexts that are known to be part of 1260 * a COMPONENT (e.g. in a COMPONENT driver). Otherwise the behavior is undefined. 1261 */ 1262 static inline struct snd_soc_component *snd_soc_dapm_kcontrol_component( 1263 struct snd_kcontrol *kcontrol) 1264 { 1265 return snd_soc_dapm_to_component(snd_soc_dapm_kcontrol_dapm(kcontrol)); 1266 } 1267 1268 /** 1269 * snd_soc_component_cache_sync() - Sync the register cache with the hardware 1270 * @component: COMPONENT to sync 1271 * 1272 * Note: This function will call regcache_sync() 1273 */ 1274 static inline int snd_soc_component_cache_sync( 1275 struct snd_soc_component *component) 1276 { 1277 return regcache_sync(component->regmap); 1278 } 1279 1280 /* component IO */ 1281 int snd_soc_component_read(struct snd_soc_component *component, 1282 unsigned int reg, unsigned int *val); 1283 unsigned int snd_soc_component_read32(struct snd_soc_component *component, 1284 unsigned int reg); 1285 int snd_soc_component_write(struct snd_soc_component *component, 1286 unsigned int reg, unsigned int val); 1287 int snd_soc_component_update_bits(struct snd_soc_component *component, 1288 unsigned int reg, unsigned int mask, unsigned int val); 1289 int snd_soc_component_update_bits_async(struct snd_soc_component *component, 1290 unsigned int reg, unsigned int mask, unsigned int val); 1291 void snd_soc_component_async_complete(struct snd_soc_component *component); 1292 int snd_soc_component_test_bits(struct snd_soc_component *component, 1293 unsigned int reg, unsigned int mask, unsigned int value); 1294 1295 /* component wide operations */ 1296 int snd_soc_component_set_sysclk(struct snd_soc_component *component, 1297 int clk_id, int source, unsigned int freq, int dir); 1298 int snd_soc_component_set_pll(struct snd_soc_component *component, int pll_id, 1299 int source, unsigned int freq_in, 1300 unsigned int freq_out); 1301 int snd_soc_component_set_jack(struct snd_soc_component *component, 1302 struct snd_soc_jack *jack, void *data); 1303 1304 #ifdef CONFIG_REGMAP 1305 1306 void snd_soc_component_init_regmap(struct snd_soc_component *component, 1307 struct regmap *regmap); 1308 void snd_soc_component_exit_regmap(struct snd_soc_component *component); 1309 1310 #endif 1311 1312 /* device driver data */ 1313 1314 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card, 1315 void *data) 1316 { 1317 card->drvdata = data; 1318 } 1319 1320 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card) 1321 { 1322 return card->drvdata; 1323 } 1324 1325 static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c, 1326 void *data) 1327 { 1328 dev_set_drvdata(c->dev, data); 1329 } 1330 1331 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c) 1332 { 1333 return dev_get_drvdata(c->dev); 1334 } 1335 1336 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card) 1337 { 1338 INIT_LIST_HEAD(&card->widgets); 1339 INIT_LIST_HEAD(&card->paths); 1340 INIT_LIST_HEAD(&card->dapm_list); 1341 INIT_LIST_HEAD(&card->aux_comp_list); 1342 INIT_LIST_HEAD(&card->component_dev_list); 1343 } 1344 1345 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc) 1346 { 1347 if (mc->reg == mc->rreg && mc->shift == mc->rshift) 1348 return 0; 1349 /* 1350 * mc->reg == mc->rreg && mc->shift != mc->rshift, or 1351 * mc->reg != mc->rreg means that the control is 1352 * stereo (bits in one register or in two registers) 1353 */ 1354 return 1; 1355 } 1356 1357 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e, 1358 unsigned int val) 1359 { 1360 unsigned int i; 1361 1362 if (!e->values) 1363 return val; 1364 1365 for (i = 0; i < e->items; i++) 1366 if (val == e->values[i]) 1367 return i; 1368 1369 return 0; 1370 } 1371 1372 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e, 1373 unsigned int item) 1374 { 1375 if (!e->values) 1376 return item; 1377 1378 return e->values[item]; 1379 } 1380 1381 static inline bool snd_soc_component_is_active( 1382 struct snd_soc_component *component) 1383 { 1384 return component->active != 0; 1385 } 1386 1387 /** 1388 * snd_soc_kcontrol_component() - Returns the component that registered the 1389 * control 1390 * @kcontrol: The control for which to get the component 1391 * 1392 * Note: This function will work correctly if the control has been registered 1393 * for a component. With snd_soc_add_codec_controls() or via table based 1394 * setup for either a CODEC or component driver. Otherwise the behavior is 1395 * undefined. 1396 */ 1397 static inline struct snd_soc_component *snd_soc_kcontrol_component( 1398 struct snd_kcontrol *kcontrol) 1399 { 1400 return snd_kcontrol_chip(kcontrol); 1401 } 1402 1403 int snd_soc_util_init(void); 1404 void snd_soc_util_exit(void); 1405 1406 int snd_soc_of_parse_card_name(struct snd_soc_card *card, 1407 const char *propname); 1408 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card, 1409 const char *propname); 1410 int snd_soc_of_parse_tdm_slot(struct device_node *np, 1411 unsigned int *tx_mask, 1412 unsigned int *rx_mask, 1413 unsigned int *slots, 1414 unsigned int *slot_width); 1415 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card, 1416 struct snd_soc_codec_conf *codec_conf, 1417 struct device_node *of_node, 1418 const char *propname); 1419 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card, 1420 const char *propname); 1421 unsigned int snd_soc_of_parse_daifmt(struct device_node *np, 1422 const char *prefix, 1423 struct device_node **bitclkmaster, 1424 struct device_node **framemaster); 1425 int snd_soc_get_dai_id(struct device_node *ep); 1426 int snd_soc_get_dai_name(struct of_phandle_args *args, 1427 const char **dai_name); 1428 int snd_soc_of_get_dai_name(struct device_node *of_node, 1429 const char **dai_name); 1430 int snd_soc_of_get_dai_link_codecs(struct device *dev, 1431 struct device_node *of_node, 1432 struct snd_soc_dai_link *dai_link); 1433 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link); 1434 1435 int snd_soc_add_dai_link(struct snd_soc_card *card, 1436 struct snd_soc_dai_link *dai_link); 1437 void snd_soc_remove_dai_link(struct snd_soc_card *card, 1438 struct snd_soc_dai_link *dai_link); 1439 struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card, 1440 int id, const char *name, 1441 const char *stream_name); 1442 1443 int snd_soc_register_dai(struct snd_soc_component *component, 1444 struct snd_soc_dai_driver *dai_drv); 1445 1446 struct snd_soc_dai *snd_soc_find_dai( 1447 const struct snd_soc_dai_link_component *dlc); 1448 1449 #include <sound/soc-dai.h> 1450 1451 static inline 1452 struct snd_soc_dai *snd_soc_card_get_codec_dai(struct snd_soc_card *card, 1453 const char *dai_name) 1454 { 1455 struct snd_soc_pcm_runtime *rtd; 1456 1457 list_for_each_entry(rtd, &card->rtd_list, list) { 1458 if (!strcmp(rtd->codec_dai->name, dai_name)) 1459 return rtd->codec_dai; 1460 } 1461 1462 return NULL; 1463 } 1464 1465 #ifdef CONFIG_DEBUG_FS 1466 extern struct dentry *snd_soc_debugfs_root; 1467 #endif 1468 1469 extern const struct dev_pm_ops snd_soc_pm_ops; 1470 1471 /* Helper functions */ 1472 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm) 1473 { 1474 mutex_lock_nested(&dapm->card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME); 1475 } 1476 1477 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm) 1478 { 1479 mutex_unlock(&dapm->card->dapm_mutex); 1480 } 1481 1482 int snd_soc_component_enable_pin(struct snd_soc_component *component, 1483 const char *pin); 1484 int snd_soc_component_enable_pin_unlocked(struct snd_soc_component *component, 1485 const char *pin); 1486 int snd_soc_component_disable_pin(struct snd_soc_component *component, 1487 const char *pin); 1488 int snd_soc_component_disable_pin_unlocked(struct snd_soc_component *component, 1489 const char *pin); 1490 int snd_soc_component_nc_pin(struct snd_soc_component *component, 1491 const char *pin); 1492 int snd_soc_component_nc_pin_unlocked(struct snd_soc_component *component, 1493 const char *pin); 1494 int snd_soc_component_get_pin_status(struct snd_soc_component *component, 1495 const char *pin); 1496 int snd_soc_component_force_enable_pin(struct snd_soc_component *component, 1497 const char *pin); 1498 int snd_soc_component_force_enable_pin_unlocked( 1499 struct snd_soc_component *component, 1500 const char *pin); 1501 1502 #endif 1503