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