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_platform; 405 struct snd_soc_dai_link; 406 struct snd_soc_platform_driver; 407 struct snd_soc_codec; 408 struct snd_soc_codec_driver; 409 struct snd_soc_component; 410 struct snd_soc_component_driver; 411 struct soc_enum; 412 struct snd_soc_jack; 413 struct snd_soc_jack_zone; 414 struct snd_soc_jack_pin; 415 #include <sound/soc-dapm.h> 416 #include <sound/soc-dpcm.h> 417 #include <sound/soc-topology.h> 418 419 struct snd_soc_jack_gpio; 420 421 typedef int (*hw_write_t)(void *,const char* ,int); 422 423 enum snd_soc_pcm_subclass { 424 SND_SOC_PCM_CLASS_PCM = 0, 425 SND_SOC_PCM_CLASS_BE = 1, 426 }; 427 428 enum snd_soc_card_subclass { 429 SND_SOC_CARD_CLASS_INIT = 0, 430 SND_SOC_CARD_CLASS_RUNTIME = 1, 431 }; 432 433 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id, 434 int source, unsigned int freq, int dir); 435 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source, 436 unsigned int freq_in, unsigned int freq_out); 437 int snd_soc_codec_set_jack(struct snd_soc_codec *codec, 438 struct snd_soc_jack *jack, void *data); 439 440 int snd_soc_register_card(struct snd_soc_card *card); 441 int snd_soc_unregister_card(struct snd_soc_card *card); 442 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card); 443 #ifdef CONFIG_PM_SLEEP 444 int snd_soc_suspend(struct device *dev); 445 int snd_soc_resume(struct device *dev); 446 #else 447 static inline int snd_soc_suspend(struct device *dev) 448 { 449 return 0; 450 } 451 452 static inline int snd_soc_resume(struct device *dev) 453 { 454 return 0; 455 } 456 #endif 457 int snd_soc_poweroff(struct device *dev); 458 int snd_soc_register_platform(struct device *dev, 459 const struct snd_soc_platform_driver *platform_drv); 460 int devm_snd_soc_register_platform(struct device *dev, 461 const struct snd_soc_platform_driver *platform_drv); 462 void snd_soc_unregister_platform(struct device *dev); 463 int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform, 464 const struct snd_soc_platform_driver *platform_drv); 465 void snd_soc_remove_platform(struct snd_soc_platform *platform); 466 struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev); 467 int snd_soc_register_codec(struct device *dev, 468 const struct snd_soc_codec_driver *codec_drv, 469 struct snd_soc_dai_driver *dai_drv, int num_dai); 470 void snd_soc_unregister_codec(struct device *dev); 471 int snd_soc_add_component(struct device *dev, 472 struct snd_soc_component *component, 473 const struct snd_soc_component_driver *component_driver, 474 struct snd_soc_dai_driver *dai_drv, 475 int num_dai); 476 int snd_soc_register_component(struct device *dev, 477 const struct snd_soc_component_driver *component_driver, 478 struct snd_soc_dai_driver *dai_drv, int num_dai); 479 int devm_snd_soc_register_component(struct device *dev, 480 const struct snd_soc_component_driver *component_driver, 481 struct snd_soc_dai_driver *dai_drv, int num_dai); 482 void snd_soc_unregister_component(struct device *dev); 483 struct snd_soc_component *snd_soc_lookup_component(struct device *dev, 484 const char *driver_name); 485 int snd_soc_cache_init(struct snd_soc_codec *codec); 486 int snd_soc_cache_exit(struct snd_soc_codec *codec); 487 488 int snd_soc_platform_read(struct snd_soc_platform *platform, 489 unsigned int reg); 490 int snd_soc_platform_write(struct snd_soc_platform *platform, 491 unsigned int reg, unsigned int val); 492 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num); 493 #ifdef CONFIG_SND_SOC_COMPRESS 494 int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num); 495 #endif 496 497 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card, 498 const char *dai_link, int stream); 499 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card, 500 const char *dai_link); 501 502 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd); 503 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream); 504 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream); 505 506 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd, 507 unsigned int dai_fmt); 508 509 #ifdef CONFIG_DMI 510 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour); 511 #else 512 static inline int snd_soc_set_dmi_name(struct snd_soc_card *card, 513 const char *flavour) 514 { 515 return 0; 516 } 517 #endif 518 519 /* Utility functions to get clock rates from various things */ 520 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots); 521 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params); 522 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots); 523 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms); 524 525 /* set runtime hw params */ 526 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream, 527 const struct snd_pcm_hardware *hw); 528 529 int soc_dai_hw_params(struct snd_pcm_substream *substream, 530 struct snd_pcm_hw_params *params, 531 struct snd_soc_dai *dai); 532 533 /* Jack reporting */ 534 int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type, 535 struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins, 536 unsigned int num_pins); 537 538 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask); 539 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count, 540 struct snd_soc_jack_pin *pins); 541 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack, 542 struct notifier_block *nb); 543 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack, 544 struct notifier_block *nb); 545 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count, 546 struct snd_soc_jack_zone *zones); 547 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage); 548 #ifdef CONFIG_GPIOLIB 549 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count, 550 struct snd_soc_jack_gpio *gpios); 551 int snd_soc_jack_add_gpiods(struct device *gpiod_dev, 552 struct snd_soc_jack *jack, 553 int count, struct snd_soc_jack_gpio *gpios); 554 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count, 555 struct snd_soc_jack_gpio *gpios); 556 #else 557 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count, 558 struct snd_soc_jack_gpio *gpios) 559 { 560 return 0; 561 } 562 563 static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev, 564 struct snd_soc_jack *jack, 565 int count, 566 struct snd_soc_jack_gpio *gpios) 567 { 568 return 0; 569 } 570 571 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count, 572 struct snd_soc_jack_gpio *gpios) 573 { 574 } 575 #endif 576 577 /* codec register bit access */ 578 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned int reg, 579 unsigned int mask, unsigned int value); 580 int snd_soc_update_bits_locked(struct snd_soc_codec *codec, 581 unsigned int reg, unsigned int mask, 582 unsigned int value); 583 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned int reg, 584 unsigned int mask, unsigned int value); 585 586 #ifdef CONFIG_SND_SOC_AC97_BUS 587 struct snd_ac97 *snd_soc_alloc_ac97_codec(struct snd_soc_codec *codec); 588 struct snd_ac97 *snd_soc_new_ac97_codec(struct snd_soc_codec *codec, 589 unsigned int id, unsigned int id_mask); 590 void snd_soc_free_ac97_codec(struct snd_ac97 *ac97); 591 592 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops); 593 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops, 594 struct platform_device *pdev); 595 596 extern struct snd_ac97_bus_ops *soc_ac97_ops; 597 #else 598 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops, 599 struct platform_device *pdev) 600 { 601 return 0; 602 } 603 604 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops) 605 { 606 return 0; 607 } 608 #endif 609 610 /* 611 *Controls 612 */ 613 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template, 614 void *data, const char *long_name, 615 const char *prefix); 616 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card, 617 const char *name); 618 int snd_soc_add_component_controls(struct snd_soc_component *component, 619 const struct snd_kcontrol_new *controls, unsigned int num_controls); 620 int snd_soc_add_codec_controls(struct snd_soc_codec *codec, 621 const struct snd_kcontrol_new *controls, unsigned int num_controls); 622 int snd_soc_add_platform_controls(struct snd_soc_platform *platform, 623 const struct snd_kcontrol_new *controls, unsigned int num_controls); 624 int snd_soc_add_card_controls(struct snd_soc_card *soc_card, 625 const struct snd_kcontrol_new *controls, int num_controls); 626 int snd_soc_add_dai_controls(struct snd_soc_dai *dai, 627 const struct snd_kcontrol_new *controls, int num_controls); 628 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol, 629 struct snd_ctl_elem_info *uinfo); 630 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol, 631 struct snd_ctl_elem_value *ucontrol); 632 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol, 633 struct snd_ctl_elem_value *ucontrol); 634 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol, 635 struct snd_ctl_elem_info *uinfo); 636 int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol, 637 struct snd_ctl_elem_info *uinfo); 638 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info 639 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol, 640 struct snd_ctl_elem_value *ucontrol); 641 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol, 642 struct snd_ctl_elem_value *ucontrol); 643 #define snd_soc_get_volsw_2r snd_soc_get_volsw 644 #define snd_soc_put_volsw_2r snd_soc_put_volsw 645 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol, 646 struct snd_ctl_elem_value *ucontrol); 647 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol, 648 struct snd_ctl_elem_value *ucontrol); 649 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol, 650 struct snd_ctl_elem_info *uinfo); 651 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol, 652 struct snd_ctl_elem_value *ucontrol); 653 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol, 654 struct snd_ctl_elem_value *ucontrol); 655 int snd_soc_limit_volume(struct snd_soc_card *card, 656 const char *name, int max); 657 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol, 658 struct snd_ctl_elem_info *uinfo); 659 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol, 660 struct snd_ctl_elem_value *ucontrol); 661 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol, 662 struct snd_ctl_elem_value *ucontrol); 663 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol, 664 struct snd_ctl_elem_info *ucontrol); 665 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag, 666 unsigned int size, unsigned int __user *tlv); 667 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol, 668 struct snd_ctl_elem_info *uinfo); 669 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol, 670 struct snd_ctl_elem_value *ucontrol); 671 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol, 672 struct snd_ctl_elem_value *ucontrol); 673 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol, 674 struct snd_ctl_elem_value *ucontrol); 675 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol, 676 struct snd_ctl_elem_value *ucontrol); 677 678 /** 679 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection 680 * 681 * @pin: name of the pin to update 682 * @mask: bits to check for in reported jack status 683 * @invert: if non-zero then pin is enabled when status is not reported 684 * @list: internal list entry 685 */ 686 struct snd_soc_jack_pin { 687 struct list_head list; 688 const char *pin; 689 int mask; 690 bool invert; 691 }; 692 693 /** 694 * struct snd_soc_jack_zone - Describes voltage zones of jack detection 695 * 696 * @min_mv: start voltage in mv 697 * @max_mv: end voltage in mv 698 * @jack_type: type of jack that is expected for this voltage 699 * @debounce_time: debounce_time for jack, codec driver should wait for this 700 * duration before reading the adc for voltages 701 * @list: internal list entry 702 */ 703 struct snd_soc_jack_zone { 704 unsigned int min_mv; 705 unsigned int max_mv; 706 unsigned int jack_type; 707 unsigned int debounce_time; 708 struct list_head list; 709 }; 710 711 /** 712 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection 713 * 714 * @gpio: legacy gpio number 715 * @idx: gpio descriptor index within the function of the GPIO 716 * consumer device 717 * @gpiod_dev: GPIO consumer device 718 * @name: gpio name. Also as connection ID for the GPIO consumer 719 * device function name lookup 720 * @report: value to report when jack detected 721 * @invert: report presence in low state 722 * @debounce_time: debounce time in ms 723 * @wake: enable as wake source 724 * @jack_status_check: callback function which overrides the detection 725 * to provide more complex checks (eg, reading an 726 * ADC). 727 */ 728 struct snd_soc_jack_gpio { 729 unsigned int gpio; 730 unsigned int idx; 731 struct device *gpiod_dev; 732 const char *name; 733 int report; 734 int invert; 735 int debounce_time; 736 bool wake; 737 738 /* private: */ 739 struct snd_soc_jack *jack; 740 struct delayed_work work; 741 struct notifier_block pm_notifier; 742 struct gpio_desc *desc; 743 744 void *data; 745 /* public: */ 746 int (*jack_status_check)(void *data); 747 }; 748 749 struct snd_soc_jack { 750 struct mutex mutex; 751 struct snd_jack *jack; 752 struct snd_soc_card *card; 753 struct list_head pins; 754 int status; 755 struct blocking_notifier_head notifier; 756 struct list_head jack_zones; 757 }; 758 759 /* SoC PCM stream information */ 760 struct snd_soc_pcm_stream { 761 const char *stream_name; 762 u64 formats; /* SNDRV_PCM_FMTBIT_* */ 763 unsigned int rates; /* SNDRV_PCM_RATE_* */ 764 unsigned int rate_min; /* min rate */ 765 unsigned int rate_max; /* max rate */ 766 unsigned int channels_min; /* min channels */ 767 unsigned int channels_max; /* max channels */ 768 unsigned int sig_bits; /* number of bits of content */ 769 }; 770 771 /* SoC audio ops */ 772 struct snd_soc_ops { 773 int (*startup)(struct snd_pcm_substream *); 774 void (*shutdown)(struct snd_pcm_substream *); 775 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *); 776 int (*hw_free)(struct snd_pcm_substream *); 777 int (*prepare)(struct snd_pcm_substream *); 778 int (*trigger)(struct snd_pcm_substream *, int); 779 }; 780 781 struct snd_soc_compr_ops { 782 int (*startup)(struct snd_compr_stream *); 783 void (*shutdown)(struct snd_compr_stream *); 784 int (*set_params)(struct snd_compr_stream *); 785 int (*trigger)(struct snd_compr_stream *); 786 }; 787 788 /* component interface */ 789 struct snd_soc_component_driver { 790 const char *name; 791 792 /* Default control and setup, added after probe() is run */ 793 const struct snd_kcontrol_new *controls; 794 unsigned int num_controls; 795 const struct snd_soc_dapm_widget *dapm_widgets; 796 unsigned int num_dapm_widgets; 797 const struct snd_soc_dapm_route *dapm_routes; 798 unsigned int num_dapm_routes; 799 800 int (*probe)(struct snd_soc_component *); 801 void (*remove)(struct snd_soc_component *); 802 int (*suspend)(struct snd_soc_component *); 803 int (*resume)(struct snd_soc_component *); 804 805 /* pcm creation and destruction */ 806 int (*pcm_new)(struct snd_soc_pcm_runtime *); 807 void (*pcm_free)(struct snd_pcm *); 808 809 /* component wide operations */ 810 int (*set_sysclk)(struct snd_soc_component *component, 811 int clk_id, int source, unsigned int freq, int dir); 812 int (*set_pll)(struct snd_soc_component *component, int pll_id, 813 int source, unsigned int freq_in, unsigned int freq_out); 814 int (*set_jack)(struct snd_soc_component *component, 815 struct snd_soc_jack *jack, void *data); 816 817 /* DT */ 818 int (*of_xlate_dai_name)(struct snd_soc_component *component, 819 struct of_phandle_args *args, 820 const char **dai_name); 821 int (*of_xlate_dai_id)(struct snd_soc_component *comment, 822 struct device_node *endpoint); 823 void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type, 824 int subseq); 825 int (*stream_event)(struct snd_soc_component *, int event); 826 int (*set_bias_level)(struct snd_soc_component *component, 827 enum snd_soc_bias_level level); 828 829 const struct snd_pcm_ops *ops; 830 const struct snd_compr_ops *compr_ops; 831 832 /* probe ordering - for components with runtime dependencies */ 833 int probe_order; 834 int remove_order; 835 836 /* bits */ 837 unsigned int idle_bias_on:1; 838 unsigned int suspend_bias_off:1; 839 unsigned int pmdown_time:1; /* care pmdown_time at stop */ 840 unsigned int endianness:1; 841 unsigned int non_legacy_dai_naming:1; 842 }; 843 844 struct snd_soc_component { 845 const char *name; 846 int id; 847 const char *name_prefix; 848 struct device *dev; 849 struct snd_soc_card *card; 850 851 unsigned int active; 852 853 unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */ 854 unsigned int registered_as_component:1; 855 unsigned int suspended:1; /* is in suspend PM state */ 856 857 struct list_head list; 858 struct list_head card_aux_list; /* for auxiliary bound components */ 859 struct list_head card_list; 860 861 struct snd_soc_dai_driver *dai_drv; 862 int num_dai; 863 864 const struct snd_soc_component_driver *driver; 865 866 struct list_head dai_list; 867 868 int (*read)(struct snd_soc_component *, unsigned int, unsigned int *); 869 int (*write)(struct snd_soc_component *, unsigned int, unsigned int); 870 871 struct regmap *regmap; 872 int val_bytes; 873 874 struct mutex io_mutex; 875 876 /* attached dynamic objects */ 877 struct list_head dobj_list; 878 879 #ifdef CONFIG_DEBUG_FS 880 struct dentry *debugfs_root; 881 #endif 882 883 /* 884 * DO NOT use any of the fields below in drivers, they are temporary and 885 * are going to be removed again soon. If you use them in driver code the 886 * driver will be marked as BROKEN when these fields are removed. 887 */ 888 889 /* Don't use these, use snd_soc_component_get_dapm() */ 890 struct snd_soc_dapm_context dapm; 891 892 struct snd_soc_codec *codec; 893 894 int (*probe)(struct snd_soc_component *); 895 void (*remove)(struct snd_soc_component *); 896 int (*suspend)(struct snd_soc_component *); 897 int (*resume)(struct snd_soc_component *); 898 int (*pcm_new)(struct snd_soc_component *, struct snd_soc_pcm_runtime *); 899 void (*pcm_free)(struct snd_soc_component *, struct snd_pcm *); 900 901 int (*set_sysclk)(struct snd_soc_component *component, 902 int clk_id, int source, unsigned int freq, int dir); 903 int (*set_pll)(struct snd_soc_component *component, int pll_id, 904 int source, unsigned int freq_in, unsigned int freq_out); 905 int (*set_jack)(struct snd_soc_component *component, 906 struct snd_soc_jack *jack, void *data); 907 int (*set_bias_level)(struct snd_soc_component *component, 908 enum snd_soc_bias_level level); 909 910 /* machine specific init */ 911 int (*init)(struct snd_soc_component *component); 912 913 #ifdef CONFIG_DEBUG_FS 914 void (*init_debugfs)(struct snd_soc_component *component); 915 const char *debugfs_prefix; 916 #endif 917 }; 918 919 struct snd_soc_rtdcom_list { 920 struct snd_soc_component *component; 921 struct list_head list; /* rtd::component_list */ 922 }; 923 struct snd_soc_component* 924 snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd, 925 const char *driver_name); 926 #define for_each_rtdcom(rtd, rtdcom) \ 927 list_for_each_entry(rtdcom, &(rtd)->component_list, list) 928 #define for_each_rtdcom_safe(rtd, rtdcom1, rtdcom2) \ 929 list_for_each_entry_safe(rtdcom1, rtdcom2, &(rtd)->component_list, list) 930 931 /* SoC Audio Codec device */ 932 struct snd_soc_codec { 933 struct device *dev; 934 const struct snd_soc_codec_driver *driver; 935 936 struct list_head list; 937 938 /* runtime */ 939 unsigned int cache_init:1; /* codec cache has been initialized */ 940 941 /* codec IO */ 942 void *control_data; /* codec control (i2c/3wire) data */ 943 hw_write_t hw_write; 944 void *reg_cache; 945 946 /* component */ 947 struct snd_soc_component component; 948 }; 949 950 /* codec driver */ 951 struct snd_soc_codec_driver { 952 953 /* driver ops */ 954 int (*probe)(struct snd_soc_codec *); 955 int (*remove)(struct snd_soc_codec *); 956 int (*suspend)(struct snd_soc_codec *); 957 int (*resume)(struct snd_soc_codec *); 958 struct snd_soc_component_driver component_driver; 959 960 /* codec wide operations */ 961 int (*set_sysclk)(struct snd_soc_codec *codec, 962 int clk_id, int source, unsigned int freq, int dir); 963 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source, 964 unsigned int freq_in, unsigned int freq_out); 965 int (*set_jack)(struct snd_soc_codec *codec, 966 struct snd_soc_jack *jack, void *data); 967 968 /* codec IO */ 969 struct regmap *(*get_regmap)(struct device *); 970 unsigned int (*read)(struct snd_soc_codec *, unsigned int); 971 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int); 972 unsigned int reg_cache_size; 973 short reg_cache_step; 974 short reg_word_size; 975 const void *reg_cache_default; 976 977 /* codec bias level */ 978 int (*set_bias_level)(struct snd_soc_codec *, 979 enum snd_soc_bias_level level); 980 bool idle_bias_off; 981 bool suspend_bias_off; 982 983 void (*seq_notifier)(struct snd_soc_dapm_context *, 984 enum snd_soc_dapm_type, int); 985 986 bool ignore_pmdown_time; /* Doesn't benefit from pmdown delay */ 987 }; 988 989 /* SoC platform interface */ 990 struct snd_soc_platform_driver { 991 992 int (*probe)(struct snd_soc_platform *); 993 int (*remove)(struct snd_soc_platform *); 994 struct snd_soc_component_driver component_driver; 995 996 /* pcm creation and destruction */ 997 int (*pcm_new)(struct snd_soc_pcm_runtime *); 998 void (*pcm_free)(struct snd_pcm *); 999 1000 /* platform stream pcm ops */ 1001 const struct snd_pcm_ops *ops; 1002 1003 /* platform stream compress ops */ 1004 const struct snd_compr_ops *compr_ops; 1005 }; 1006 1007 struct snd_soc_dai_link_component { 1008 const char *name; 1009 struct device_node *of_node; 1010 const char *dai_name; 1011 }; 1012 1013 struct snd_soc_platform { 1014 struct device *dev; 1015 const struct snd_soc_platform_driver *driver; 1016 1017 struct list_head list; 1018 1019 struct snd_soc_component component; 1020 }; 1021 1022 struct snd_soc_dai_link { 1023 /* config - must be set by machine driver */ 1024 const char *name; /* Codec name */ 1025 const char *stream_name; /* Stream name */ 1026 /* 1027 * You MAY specify the link's CPU-side device, either by device name, 1028 * or by DT/OF node, but not both. If this information is omitted, 1029 * the CPU-side DAI is matched using .cpu_dai_name only, which hence 1030 * must be globally unique. These fields are currently typically used 1031 * only for codec to codec links, or systems using device tree. 1032 */ 1033 const char *cpu_name; 1034 struct device_node *cpu_of_node; 1035 /* 1036 * You MAY specify the DAI name of the CPU DAI. If this information is 1037 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node 1038 * only, which only works well when that device exposes a single DAI. 1039 */ 1040 const char *cpu_dai_name; 1041 /* 1042 * You MUST specify the link's codec, either by device name, or by 1043 * DT/OF node, but not both. 1044 */ 1045 const char *codec_name; 1046 struct device_node *codec_of_node; 1047 /* You MUST specify the DAI name within the codec */ 1048 const char *codec_dai_name; 1049 1050 struct snd_soc_dai_link_component *codecs; 1051 unsigned int num_codecs; 1052 1053 /* 1054 * You MAY specify the link's platform/PCM/DMA driver, either by 1055 * device name, or by DT/OF node, but not both. Some forms of link 1056 * do not need a platform. 1057 */ 1058 const char *platform_name; 1059 struct device_node *platform_of_node; 1060 int id; /* optional ID for machine driver link identification */ 1061 1062 const struct snd_soc_pcm_stream *params; 1063 unsigned int num_params; 1064 1065 unsigned int dai_fmt; /* format to set on init */ 1066 1067 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */ 1068 1069 /* codec/machine specific init - e.g. add machine controls */ 1070 int (*init)(struct snd_soc_pcm_runtime *rtd); 1071 1072 /* optional hw_params re-writing for BE and FE sync */ 1073 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd, 1074 struct snd_pcm_hw_params *params); 1075 1076 /* machine stream operations */ 1077 const struct snd_soc_ops *ops; 1078 const struct snd_soc_compr_ops *compr_ops; 1079 1080 /* Mark this pcm with non atomic ops */ 1081 bool nonatomic; 1082 1083 /* For unidirectional dai links */ 1084 unsigned int playback_only:1; 1085 unsigned int capture_only:1; 1086 1087 /* Keep DAI active over suspend */ 1088 unsigned int ignore_suspend:1; 1089 1090 /* Symmetry requirements */ 1091 unsigned int symmetric_rates:1; 1092 unsigned int symmetric_channels:1; 1093 unsigned int symmetric_samplebits:1; 1094 1095 /* Do not create a PCM for this DAI link (Backend link) */ 1096 unsigned int no_pcm:1; 1097 1098 /* This DAI link can route to other DAI links at runtime (Frontend)*/ 1099 unsigned int dynamic:1; 1100 1101 /* DPCM capture and Playback support */ 1102 unsigned int dpcm_capture:1; 1103 unsigned int dpcm_playback:1; 1104 1105 /* DPCM used FE & BE merged format */ 1106 unsigned int dpcm_merged_format:1; 1107 1108 /* pmdown_time is ignored at stop */ 1109 unsigned int ignore_pmdown_time:1; 1110 1111 struct list_head list; /* DAI link list of the soc card */ 1112 struct snd_soc_dobj dobj; /* For topology */ 1113 }; 1114 1115 struct snd_soc_codec_conf { 1116 /* 1117 * specify device either by device name, or by 1118 * DT/OF node, but not both. 1119 */ 1120 const char *dev_name; 1121 struct device_node *of_node; 1122 1123 /* 1124 * optional map of kcontrol, widget and path name prefixes that are 1125 * associated per device 1126 */ 1127 const char *name_prefix; 1128 }; 1129 1130 struct snd_soc_aux_dev { 1131 const char *name; /* Codec name */ 1132 1133 /* 1134 * specify multi-codec either by device name, or by 1135 * DT/OF node, but not both. 1136 */ 1137 const char *codec_name; 1138 struct device_node *codec_of_node; 1139 1140 /* codec/machine specific init - e.g. add machine controls */ 1141 int (*init)(struct snd_soc_component *component); 1142 }; 1143 1144 /* SoC card */ 1145 struct snd_soc_card { 1146 const char *name; 1147 const char *long_name; 1148 const char *driver_name; 1149 char dmi_longname[80]; 1150 1151 struct device *dev; 1152 struct snd_card *snd_card; 1153 struct module *owner; 1154 1155 struct mutex mutex; 1156 struct mutex dapm_mutex; 1157 1158 bool instantiated; 1159 1160 int (*probe)(struct snd_soc_card *card); 1161 int (*late_probe)(struct snd_soc_card *card); 1162 int (*remove)(struct snd_soc_card *card); 1163 1164 /* the pre and post PM functions are used to do any PM work before and 1165 * after the codec and DAI's do any PM work. */ 1166 int (*suspend_pre)(struct snd_soc_card *card); 1167 int (*suspend_post)(struct snd_soc_card *card); 1168 int (*resume_pre)(struct snd_soc_card *card); 1169 int (*resume_post)(struct snd_soc_card *card); 1170 1171 /* callbacks */ 1172 int (*set_bias_level)(struct snd_soc_card *, 1173 struct snd_soc_dapm_context *dapm, 1174 enum snd_soc_bias_level level); 1175 int (*set_bias_level_post)(struct snd_soc_card *, 1176 struct snd_soc_dapm_context *dapm, 1177 enum snd_soc_bias_level level); 1178 1179 int (*add_dai_link)(struct snd_soc_card *, 1180 struct snd_soc_dai_link *link); 1181 void (*remove_dai_link)(struct snd_soc_card *, 1182 struct snd_soc_dai_link *link); 1183 1184 long pmdown_time; 1185 1186 /* CPU <--> Codec DAI links */ 1187 struct snd_soc_dai_link *dai_link; /* predefined links only */ 1188 int num_links; /* predefined links only */ 1189 struct list_head dai_link_list; /* all links */ 1190 int num_dai_links; 1191 1192 struct list_head rtd_list; 1193 int num_rtd; 1194 1195 /* optional codec specific configuration */ 1196 struct snd_soc_codec_conf *codec_conf; 1197 int num_configs; 1198 1199 /* 1200 * optional auxiliary devices such as amplifiers or codecs with DAI 1201 * link unused 1202 */ 1203 struct snd_soc_aux_dev *aux_dev; 1204 int num_aux_devs; 1205 struct list_head aux_comp_list; 1206 1207 const struct snd_kcontrol_new *controls; 1208 int num_controls; 1209 1210 /* 1211 * Card-specific routes and widgets. 1212 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in. 1213 */ 1214 const struct snd_soc_dapm_widget *dapm_widgets; 1215 int num_dapm_widgets; 1216 const struct snd_soc_dapm_route *dapm_routes; 1217 int num_dapm_routes; 1218 const struct snd_soc_dapm_widget *of_dapm_widgets; 1219 int num_of_dapm_widgets; 1220 const struct snd_soc_dapm_route *of_dapm_routes; 1221 int num_of_dapm_routes; 1222 bool fully_routed; 1223 1224 struct work_struct deferred_resume_work; 1225 1226 /* lists of probed devices belonging to this card */ 1227 struct list_head component_dev_list; 1228 1229 struct list_head widgets; 1230 struct list_head paths; 1231 struct list_head dapm_list; 1232 struct list_head dapm_dirty; 1233 1234 /* attached dynamic objects */ 1235 struct list_head dobj_list; 1236 1237 /* Generic DAPM context for the card */ 1238 struct snd_soc_dapm_context dapm; 1239 struct snd_soc_dapm_stats dapm_stats; 1240 struct snd_soc_dapm_update *update; 1241 1242 #ifdef CONFIG_DEBUG_FS 1243 struct dentry *debugfs_card_root; 1244 struct dentry *debugfs_pop_time; 1245 #endif 1246 u32 pop_time; 1247 1248 void *drvdata; 1249 }; 1250 1251 /* SoC machine DAI configuration, glues a codec and cpu DAI together */ 1252 struct snd_soc_pcm_runtime { 1253 struct device *dev; 1254 struct snd_soc_card *card; 1255 struct snd_soc_dai_link *dai_link; 1256 struct mutex pcm_mutex; 1257 enum snd_soc_pcm_subclass pcm_subclass; 1258 struct snd_pcm_ops ops; 1259 1260 /* Dynamic PCM BE runtime data */ 1261 struct snd_soc_dpcm_runtime dpcm[2]; 1262 int fe_compr; 1263 1264 long pmdown_time; 1265 1266 /* runtime devices */ 1267 struct snd_pcm *pcm; 1268 struct snd_compr *compr; 1269 struct snd_soc_codec *codec; 1270 struct snd_soc_platform *platform; /* will be removed */ 1271 struct snd_soc_dai *codec_dai; 1272 struct snd_soc_dai *cpu_dai; 1273 1274 struct snd_soc_dai **codec_dais; 1275 unsigned int num_codecs; 1276 1277 struct delayed_work delayed_work; 1278 #ifdef CONFIG_DEBUG_FS 1279 struct dentry *debugfs_dpcm_root; 1280 #endif 1281 1282 unsigned int num; /* 0-based and monotonic increasing */ 1283 struct list_head list; /* rtd list of the soc card */ 1284 struct list_head component_list; /* list of connected components */ 1285 1286 /* bit field */ 1287 unsigned int dev_registered:1; 1288 unsigned int pop_wait:1; 1289 }; 1290 1291 /* mixer control */ 1292 struct soc_mixer_control { 1293 int min, max, platform_max; 1294 int reg, rreg; 1295 unsigned int shift, rshift; 1296 unsigned int sign_bit; 1297 unsigned int invert:1; 1298 unsigned int autodisable:1; 1299 struct snd_soc_dobj dobj; 1300 }; 1301 1302 struct soc_bytes { 1303 int base; 1304 int num_regs; 1305 u32 mask; 1306 }; 1307 1308 struct soc_bytes_ext { 1309 int max; 1310 struct snd_soc_dobj dobj; 1311 1312 /* used for TLV byte control */ 1313 int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes, 1314 unsigned int size); 1315 int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes, 1316 unsigned int size); 1317 }; 1318 1319 /* multi register control */ 1320 struct soc_mreg_control { 1321 long min, max; 1322 unsigned int regbase, regcount, nbits, invert; 1323 }; 1324 1325 /* enumerated kcontrol */ 1326 struct soc_enum { 1327 int reg; 1328 unsigned char shift_l; 1329 unsigned char shift_r; 1330 unsigned int items; 1331 unsigned int mask; 1332 const char * const *texts; 1333 const unsigned int *values; 1334 unsigned int autodisable:1; 1335 struct snd_soc_dobj dobj; 1336 }; 1337 1338 /** 1339 * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in 1340 * @component: The component to cast to a CODEC 1341 * 1342 * This function must only be used on components that are known to be CODECs. 1343 * Otherwise the behavior is undefined. 1344 */ 1345 static inline struct snd_soc_codec *snd_soc_component_to_codec( 1346 struct snd_soc_component *component) 1347 { 1348 return container_of(component, struct snd_soc_codec, component); 1349 } 1350 1351 /** 1352 * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in 1353 * @component: The component to cast to a platform 1354 * 1355 * This function must only be used on components that are known to be platforms. 1356 * Otherwise the behavior is undefined. 1357 */ 1358 static inline struct snd_soc_platform *snd_soc_component_to_platform( 1359 struct snd_soc_component *component) 1360 { 1361 return container_of(component, struct snd_soc_platform, component); 1362 } 1363 1364 /** 1365 * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is 1366 * embedded in 1367 * @dapm: The DAPM context to cast to the component 1368 * 1369 * This function must only be used on DAPM contexts that are known to be part of 1370 * a component (e.g. in a component driver). Otherwise the behavior is 1371 * undefined. 1372 */ 1373 static inline struct snd_soc_component *snd_soc_dapm_to_component( 1374 struct snd_soc_dapm_context *dapm) 1375 { 1376 return container_of(dapm, struct snd_soc_component, dapm); 1377 } 1378 1379 /** 1380 * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in 1381 * @dapm: The DAPM context to cast to the CODEC 1382 * 1383 * This function must only be used on DAPM contexts that are known to be part of 1384 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined. 1385 */ 1386 static inline struct snd_soc_codec *snd_soc_dapm_to_codec( 1387 struct snd_soc_dapm_context *dapm) 1388 { 1389 return snd_soc_component_to_codec(snd_soc_dapm_to_component(dapm)); 1390 } 1391 1392 /** 1393 * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is 1394 * embedded in 1395 * @dapm: The DAPM context to cast to the platform. 1396 * 1397 * This function must only be used on DAPM contexts that are known to be part of 1398 * a platform (e.g. in a platform driver). Otherwise the behavior is undefined. 1399 */ 1400 static inline struct snd_soc_platform *snd_soc_dapm_to_platform( 1401 struct snd_soc_dapm_context *dapm) 1402 { 1403 return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm)); 1404 } 1405 1406 /** 1407 * snd_soc_component_get_dapm() - Returns the DAPM context associated with a 1408 * component 1409 * @component: The component for which to get the DAPM context 1410 */ 1411 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm( 1412 struct snd_soc_component *component) 1413 { 1414 return &component->dapm; 1415 } 1416 1417 /** 1418 * snd_soc_codec_get_dapm() - Returns the DAPM context for the CODEC 1419 * @codec: The CODEC for which to get the DAPM context 1420 * 1421 * Note: Use this function instead of directly accessing the CODEC's dapm field 1422 */ 1423 static inline struct snd_soc_dapm_context *snd_soc_codec_get_dapm( 1424 struct snd_soc_codec *codec) 1425 { 1426 return snd_soc_component_get_dapm(&codec->component); 1427 } 1428 1429 /** 1430 * snd_soc_dapm_init_bias_level() - Initialize CODEC DAPM bias level 1431 * @codec: The CODEC for which to initialize the DAPM bias level 1432 * @level: The DAPM level to initialize to 1433 * 1434 * Initializes the CODEC DAPM bias level. See snd_soc_dapm_init_bias_level(). 1435 */ 1436 static inline void snd_soc_codec_init_bias_level(struct snd_soc_codec *codec, 1437 enum snd_soc_bias_level level) 1438 { 1439 snd_soc_dapm_init_bias_level(snd_soc_codec_get_dapm(codec), level); 1440 } 1441 1442 /** 1443 * snd_soc_component_init_bias_level() - Initialize COMPONENT DAPM bias level 1444 * @component: The COMPONENT for which to initialize the DAPM bias level 1445 * @level: The DAPM level to initialize to 1446 * 1447 * Initializes the COMPONENT DAPM bias level. See snd_soc_dapm_init_bias_level(). 1448 */ 1449 static inline void 1450 snd_soc_component_init_bias_level(struct snd_soc_component *component, 1451 enum snd_soc_bias_level level) 1452 { 1453 snd_soc_dapm_init_bias_level( 1454 snd_soc_component_get_dapm(component), level); 1455 } 1456 1457 /** 1458 * snd_soc_dapm_get_bias_level() - Get current CODEC DAPM bias level 1459 * @codec: The CODEC for which to get the DAPM bias level 1460 * 1461 * Returns: The current DAPM bias level of the CODEC. 1462 */ 1463 static inline enum snd_soc_bias_level snd_soc_codec_get_bias_level( 1464 struct snd_soc_codec *codec) 1465 { 1466 return snd_soc_dapm_get_bias_level(snd_soc_codec_get_dapm(codec)); 1467 } 1468 1469 /** 1470 * snd_soc_component_get_bias_level() - Get current COMPONENT DAPM bias level 1471 * @component: The COMPONENT for which to get the DAPM bias level 1472 * 1473 * Returns: The current DAPM bias level of the COMPONENT. 1474 */ 1475 static inline enum snd_soc_bias_level 1476 snd_soc_component_get_bias_level(struct snd_soc_component *component) 1477 { 1478 return snd_soc_dapm_get_bias_level( 1479 snd_soc_component_get_dapm(component)); 1480 } 1481 1482 /** 1483 * snd_soc_codec_force_bias_level() - Set the CODEC DAPM bias level 1484 * @codec: The CODEC for which to set the level 1485 * @level: The level to set to 1486 * 1487 * Forces the CODEC bias level to a specific state. See 1488 * snd_soc_dapm_force_bias_level(). 1489 */ 1490 static inline int snd_soc_codec_force_bias_level(struct snd_soc_codec *codec, 1491 enum snd_soc_bias_level level) 1492 { 1493 return snd_soc_dapm_force_bias_level(snd_soc_codec_get_dapm(codec), 1494 level); 1495 } 1496 1497 /** 1498 * snd_soc_component_force_bias_level() - Set the COMPONENT DAPM bias level 1499 * @component: The COMPONENT for which to set the level 1500 * @level: The level to set to 1501 * 1502 * Forces the COMPONENT bias level to a specific state. See 1503 * snd_soc_dapm_force_bias_level(). 1504 */ 1505 static inline int 1506 snd_soc_component_force_bias_level(struct snd_soc_component *component, 1507 enum snd_soc_bias_level level) 1508 { 1509 return snd_soc_dapm_force_bias_level( 1510 snd_soc_component_get_dapm(component), 1511 level); 1512 } 1513 1514 /** 1515 * snd_soc_dapm_kcontrol_codec() - Returns the codec associated to a kcontrol 1516 * @kcontrol: The kcontrol 1517 * 1518 * This function must only be used on DAPM contexts that are known to be part of 1519 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined. 1520 */ 1521 static inline struct snd_soc_codec *snd_soc_dapm_kcontrol_codec( 1522 struct snd_kcontrol *kcontrol) 1523 { 1524 return snd_soc_dapm_to_codec(snd_soc_dapm_kcontrol_dapm(kcontrol)); 1525 } 1526 1527 /** 1528 * snd_soc_dapm_kcontrol_component() - Returns the component associated to a kcontrol 1529 * @kcontrol: The kcontrol 1530 * 1531 * This function must only be used on DAPM contexts that are known to be part of 1532 * a COMPONENT (e.g. in a COMPONENT driver). Otherwise the behavior is undefined. 1533 */ 1534 static inline struct snd_soc_component *snd_soc_dapm_kcontrol_component( 1535 struct snd_kcontrol *kcontrol) 1536 { 1537 return snd_soc_dapm_to_component(snd_soc_dapm_kcontrol_dapm(kcontrol)); 1538 } 1539 1540 /* codec IO */ 1541 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg); 1542 int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg, 1543 unsigned int val); 1544 1545 /** 1546 * snd_soc_cache_sync() - Sync the register cache with the hardware 1547 * @codec: CODEC to sync 1548 * 1549 * Note: This function will call regcache_sync() 1550 */ 1551 static inline int snd_soc_cache_sync(struct snd_soc_codec *codec) 1552 { 1553 return regcache_sync(codec->component.regmap); 1554 } 1555 1556 /** 1557 * snd_soc_component_cache_sync() - Sync the register cache with the hardware 1558 * @component: COMPONENT to sync 1559 * 1560 * Note: This function will call regcache_sync() 1561 */ 1562 static inline int snd_soc_component_cache_sync( 1563 struct snd_soc_component *component) 1564 { 1565 return regcache_sync(component->regmap); 1566 } 1567 1568 /* component IO */ 1569 int snd_soc_component_read(struct snd_soc_component *component, 1570 unsigned int reg, unsigned int *val); 1571 unsigned int snd_soc_component_read32(struct snd_soc_component *component, 1572 unsigned int reg); 1573 int snd_soc_component_write(struct snd_soc_component *component, 1574 unsigned int reg, unsigned int val); 1575 int snd_soc_component_update_bits(struct snd_soc_component *component, 1576 unsigned int reg, unsigned int mask, unsigned int val); 1577 int snd_soc_component_update_bits_async(struct snd_soc_component *component, 1578 unsigned int reg, unsigned int mask, unsigned int val); 1579 void snd_soc_component_async_complete(struct snd_soc_component *component); 1580 int snd_soc_component_test_bits(struct snd_soc_component *component, 1581 unsigned int reg, unsigned int mask, unsigned int value); 1582 1583 /* component wide operations */ 1584 int snd_soc_component_set_sysclk(struct snd_soc_component *component, 1585 int clk_id, int source, unsigned int freq, int dir); 1586 int snd_soc_component_set_pll(struct snd_soc_component *component, int pll_id, 1587 int source, unsigned int freq_in, 1588 unsigned int freq_out); 1589 int snd_soc_component_set_jack(struct snd_soc_component *component, 1590 struct snd_soc_jack *jack, void *data); 1591 1592 #ifdef CONFIG_REGMAP 1593 1594 void snd_soc_component_init_regmap(struct snd_soc_component *component, 1595 struct regmap *regmap); 1596 void snd_soc_component_exit_regmap(struct snd_soc_component *component); 1597 1598 /** 1599 * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC 1600 * @codec: The CODEC for which to initialize the regmap instance 1601 * @regmap: The regmap instance that should be used by the CODEC 1602 * 1603 * This function allows deferred assignment of the regmap instance that is 1604 * associated with the CODEC. Only use this if the regmap instance is not yet 1605 * ready when the CODEC is registered. The function must also be called before 1606 * the first IO attempt of the CODEC. 1607 */ 1608 static inline void snd_soc_codec_init_regmap(struct snd_soc_codec *codec, 1609 struct regmap *regmap) 1610 { 1611 snd_soc_component_init_regmap(&codec->component, regmap); 1612 } 1613 1614 /** 1615 * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC 1616 * @codec: The CODEC for which to de-initialize the regmap instance 1617 * 1618 * Calls regmap_exit() on the regmap instance associated to the CODEC and 1619 * removes the regmap instance from the CODEC. 1620 * 1621 * This function should only be used if snd_soc_codec_init_regmap() was used to 1622 * initialize the regmap instance. 1623 */ 1624 static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec *codec) 1625 { 1626 snd_soc_component_exit_regmap(&codec->component); 1627 } 1628 1629 #endif 1630 1631 /* device driver data */ 1632 1633 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card, 1634 void *data) 1635 { 1636 card->drvdata = data; 1637 } 1638 1639 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card) 1640 { 1641 return card->drvdata; 1642 } 1643 1644 static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c, 1645 void *data) 1646 { 1647 dev_set_drvdata(c->dev, data); 1648 } 1649 1650 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c) 1651 { 1652 return dev_get_drvdata(c->dev); 1653 } 1654 1655 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec, 1656 void *data) 1657 { 1658 snd_soc_component_set_drvdata(&codec->component, data); 1659 } 1660 1661 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec) 1662 { 1663 return snd_soc_component_get_drvdata(&codec->component); 1664 } 1665 1666 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform, 1667 void *data) 1668 { 1669 snd_soc_component_set_drvdata(&platform->component, data); 1670 } 1671 1672 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform) 1673 { 1674 return snd_soc_component_get_drvdata(&platform->component); 1675 } 1676 1677 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card) 1678 { 1679 INIT_LIST_HEAD(&card->widgets); 1680 INIT_LIST_HEAD(&card->paths); 1681 INIT_LIST_HEAD(&card->dapm_list); 1682 INIT_LIST_HEAD(&card->aux_comp_list); 1683 INIT_LIST_HEAD(&card->component_dev_list); 1684 } 1685 1686 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc) 1687 { 1688 if (mc->reg == mc->rreg && mc->shift == mc->rshift) 1689 return 0; 1690 /* 1691 * mc->reg == mc->rreg && mc->shift != mc->rshift, or 1692 * mc->reg != mc->rreg means that the control is 1693 * stereo (bits in one register or in two registers) 1694 */ 1695 return 1; 1696 } 1697 1698 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e, 1699 unsigned int val) 1700 { 1701 unsigned int i; 1702 1703 if (!e->values) 1704 return val; 1705 1706 for (i = 0; i < e->items; i++) 1707 if (val == e->values[i]) 1708 return i; 1709 1710 return 0; 1711 } 1712 1713 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e, 1714 unsigned int item) 1715 { 1716 if (!e->values) 1717 return item; 1718 1719 return e->values[item]; 1720 } 1721 1722 static inline bool snd_soc_component_is_active( 1723 struct snd_soc_component *component) 1724 { 1725 return component->active != 0; 1726 } 1727 1728 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec) 1729 { 1730 return snd_soc_component_is_active(&codec->component); 1731 } 1732 1733 /** 1734 * snd_soc_kcontrol_component() - Returns the component that registered the 1735 * control 1736 * @kcontrol: The control for which to get the component 1737 * 1738 * Note: This function will work correctly if the control has been registered 1739 * for a component. Either with snd_soc_add_codec_controls() or 1740 * snd_soc_add_platform_controls() or via table based setup for either a 1741 * CODEC, a platform or component driver. Otherwise the behavior is undefined. 1742 */ 1743 static inline struct snd_soc_component *snd_soc_kcontrol_component( 1744 struct snd_kcontrol *kcontrol) 1745 { 1746 return snd_kcontrol_chip(kcontrol); 1747 } 1748 1749 /** 1750 * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control 1751 * @kcontrol: The control for which to get the CODEC 1752 * 1753 * Note: This function will only work correctly if the control has been 1754 * registered with snd_soc_add_codec_controls() or via table based setup of 1755 * snd_soc_codec_driver. Otherwise the behavior is undefined. 1756 */ 1757 static inline struct snd_soc_codec *snd_soc_kcontrol_codec( 1758 struct snd_kcontrol *kcontrol) 1759 { 1760 return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol)); 1761 } 1762 1763 /** 1764 * snd_soc_kcontrol_platform() - Returns the platform that registered the control 1765 * @kcontrol: The control for which to get the platform 1766 * 1767 * Note: This function will only work correctly if the control has been 1768 * registered with snd_soc_add_platform_controls() or via table based setup of 1769 * a snd_soc_platform_driver. Otherwise the behavior is undefined. 1770 */ 1771 static inline struct snd_soc_platform *snd_soc_kcontrol_platform( 1772 struct snd_kcontrol *kcontrol) 1773 { 1774 return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol)); 1775 } 1776 1777 int snd_soc_util_init(void); 1778 void snd_soc_util_exit(void); 1779 1780 int snd_soc_of_parse_card_name(struct snd_soc_card *card, 1781 const char *propname); 1782 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card, 1783 const char *propname); 1784 int snd_soc_of_parse_tdm_slot(struct device_node *np, 1785 unsigned int *tx_mask, 1786 unsigned int *rx_mask, 1787 unsigned int *slots, 1788 unsigned int *slot_width); 1789 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card, 1790 struct snd_soc_codec_conf *codec_conf, 1791 struct device_node *of_node, 1792 const char *propname); 1793 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card, 1794 const char *propname); 1795 unsigned int snd_soc_of_parse_daifmt(struct device_node *np, 1796 const char *prefix, 1797 struct device_node **bitclkmaster, 1798 struct device_node **framemaster); 1799 int snd_soc_get_dai_id(struct device_node *ep); 1800 int snd_soc_get_dai_name(struct of_phandle_args *args, 1801 const char **dai_name); 1802 int snd_soc_of_get_dai_name(struct device_node *of_node, 1803 const char **dai_name); 1804 int snd_soc_of_get_dai_link_codecs(struct device *dev, 1805 struct device_node *of_node, 1806 struct snd_soc_dai_link *dai_link); 1807 1808 int snd_soc_add_dai_link(struct snd_soc_card *card, 1809 struct snd_soc_dai_link *dai_link); 1810 void snd_soc_remove_dai_link(struct snd_soc_card *card, 1811 struct snd_soc_dai_link *dai_link); 1812 struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card, 1813 int id, const char *name, 1814 const char *stream_name); 1815 1816 int snd_soc_register_dai(struct snd_soc_component *component, 1817 struct snd_soc_dai_driver *dai_drv); 1818 1819 struct snd_soc_dai *snd_soc_find_dai( 1820 const struct snd_soc_dai_link_component *dlc); 1821 1822 #include <sound/soc-dai.h> 1823 1824 static inline 1825 struct snd_soc_dai *snd_soc_card_get_codec_dai(struct snd_soc_card *card, 1826 const char *dai_name) 1827 { 1828 struct snd_soc_pcm_runtime *rtd; 1829 1830 list_for_each_entry(rtd, &card->rtd_list, list) { 1831 if (!strcmp(rtd->codec_dai->name, dai_name)) 1832 return rtd->codec_dai; 1833 } 1834 1835 return NULL; 1836 } 1837 1838 #ifdef CONFIG_DEBUG_FS 1839 extern struct dentry *snd_soc_debugfs_root; 1840 #endif 1841 1842 extern const struct dev_pm_ops snd_soc_pm_ops; 1843 1844 /* Helper functions */ 1845 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm) 1846 { 1847 mutex_lock_nested(&dapm->card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME); 1848 } 1849 1850 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm) 1851 { 1852 mutex_unlock(&dapm->card->dapm_mutex); 1853 } 1854 1855 int snd_soc_component_enable_pin(struct snd_soc_component *component, 1856 const char *pin); 1857 int snd_soc_component_enable_pin_unlocked(struct snd_soc_component *component, 1858 const char *pin); 1859 int snd_soc_component_disable_pin(struct snd_soc_component *component, 1860 const char *pin); 1861 int snd_soc_component_disable_pin_unlocked(struct snd_soc_component *component, 1862 const char *pin); 1863 int snd_soc_component_nc_pin(struct snd_soc_component *component, 1864 const char *pin); 1865 int snd_soc_component_nc_pin_unlocked(struct snd_soc_component *component, 1866 const char *pin); 1867 int snd_soc_component_get_pin_status(struct snd_soc_component *component, 1868 const char *pin); 1869 int snd_soc_component_force_enable_pin(struct snd_soc_component *component, 1870 const char *pin); 1871 int snd_soc_component_force_enable_pin_unlocked( 1872 struct snd_soc_component *component, 1873 const char *pin); 1874 1875 #endif 1876