2 * linux/sound/soc.h -- ALSA SoC Layer
4 * Author: Liam Girdwood
5 * Created: Aug 11th 2005
6 * Copyright: Wolfson Microelectronics. PLC.
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.
13 #ifndef __LINUX_SND_SOC_H
14 #define __LINUX_SND_SOC_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>
32 * Convenience kcontrol builders
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, \
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, \
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, \
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, \
118 #define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
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, \
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, \
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, \
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, \
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, \
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, \
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)
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 }) }
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, \
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) \
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} }
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)
300 * Simplified versions of above macros, declaring a struct and calculating
301 * ARRAY_SIZE internally
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)
319 * Component probe and remove ordering levels for components with runtime
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
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.
339 enum snd_soc_bias_level {
340 SND_SOC_BIAS_OFF = 0,
341 SND_SOC_BIAS_STANDBY = 1,
342 SND_SOC_BIAS_PREPARE = 2,
349 struct snd_soc_pcm_stream;
351 struct snd_soc_pcm_runtime;
353 struct snd_soc_dai_driver;
354 struct snd_soc_platform;
355 struct snd_soc_dai_link;
356 struct snd_soc_platform_driver;
357 struct snd_soc_codec;
358 struct snd_soc_codec_driver;
359 struct snd_soc_component;
360 struct snd_soc_component_driver;
363 struct snd_soc_jack_zone;
364 struct snd_soc_jack_pin;
365 #include <sound/soc-dapm.h>
366 #include <sound/soc-dpcm.h>
368 struct snd_soc_jack_gpio;
370 typedef int (*hw_write_t)(void *,const char* ,int);
372 enum snd_soc_pcm_subclass {
373 SND_SOC_PCM_CLASS_PCM = 0,
374 SND_SOC_PCM_CLASS_BE = 1,
377 enum snd_soc_card_subclass {
378 SND_SOC_CARD_CLASS_INIT = 0,
379 SND_SOC_CARD_CLASS_RUNTIME = 1,
382 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
383 int source, unsigned int freq, int dir);
384 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
385 unsigned int freq_in, unsigned int freq_out);
387 int snd_soc_register_card(struct snd_soc_card *card);
388 int snd_soc_unregister_card(struct snd_soc_card *card);
389 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
390 #ifdef CONFIG_PM_SLEEP
391 int snd_soc_suspend(struct device *dev);
392 int snd_soc_resume(struct device *dev);
394 static inline int snd_soc_suspend(struct device *dev)
399 static inline int snd_soc_resume(struct device *dev)
404 int snd_soc_poweroff(struct device *dev);
405 int snd_soc_register_platform(struct device *dev,
406 const struct snd_soc_platform_driver *platform_drv);
407 int devm_snd_soc_register_platform(struct device *dev,
408 const struct snd_soc_platform_driver *platform_drv);
409 void snd_soc_unregister_platform(struct device *dev);
410 int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
411 const struct snd_soc_platform_driver *platform_drv);
412 void snd_soc_remove_platform(struct snd_soc_platform *platform);
413 struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev);
414 int 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);
417 void snd_soc_unregister_codec(struct device *dev);
418 int 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);
421 int 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);
424 void snd_soc_unregister_component(struct device *dev);
425 int snd_soc_cache_init(struct snd_soc_codec *codec);
426 int snd_soc_cache_exit(struct snd_soc_codec *codec);
428 int snd_soc_platform_read(struct snd_soc_platform *platform,
430 int snd_soc_platform_write(struct snd_soc_platform *platform,
431 unsigned int reg, unsigned int val);
432 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
433 int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
435 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
436 const char *dai_link, int stream);
437 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
438 const char *dai_link);
440 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
441 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
442 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
444 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
445 unsigned int dai_fmt);
447 /* Utility functions to get clock rates from various things */
448 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
449 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
450 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
451 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
453 /* set runtime hw params */
454 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
455 const struct snd_pcm_hardware *hw);
457 int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
458 int cmd, struct snd_soc_platform *platform);
460 int soc_dai_hw_params(struct snd_pcm_substream *substream,
461 struct snd_pcm_hw_params *params,
462 struct snd_soc_dai *dai);
465 int 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);
469 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
470 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
471 struct snd_soc_jack_pin *pins);
472 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
473 struct notifier_block *nb);
474 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
475 struct notifier_block *nb);
476 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
477 struct snd_soc_jack_zone *zones);
478 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
479 #ifdef CONFIG_GPIOLIB
480 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
481 struct snd_soc_jack_gpio *gpios);
482 int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
483 struct snd_soc_jack *jack,
484 int count, struct snd_soc_jack_gpio *gpios);
485 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
486 struct snd_soc_jack_gpio *gpios);
488 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
489 struct snd_soc_jack_gpio *gpios)
494 static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
495 struct snd_soc_jack *jack,
497 struct snd_soc_jack_gpio *gpios)
502 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
503 struct snd_soc_jack_gpio *gpios)
508 /* codec register bit access */
509 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned int reg,
510 unsigned int mask, unsigned int value);
511 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
512 unsigned int reg, unsigned int mask,
514 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned int reg,
515 unsigned int mask, unsigned int value);
517 #ifdef CONFIG_SND_SOC_AC97_BUS
518 struct snd_ac97 *snd_soc_alloc_ac97_codec(struct snd_soc_codec *codec);
519 struct snd_ac97 *snd_soc_new_ac97_codec(struct snd_soc_codec *codec);
520 void snd_soc_free_ac97_codec(struct snd_ac97 *ac97);
522 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
523 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
524 struct platform_device *pdev);
526 extern struct snd_ac97_bus_ops *soc_ac97_ops;
528 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
529 struct platform_device *pdev)
534 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
543 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
544 void *data, const char *long_name,
546 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
548 int snd_soc_add_component_controls(struct snd_soc_component *component,
549 const struct snd_kcontrol_new *controls, unsigned int num_controls);
550 int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
551 const struct snd_kcontrol_new *controls, unsigned int num_controls);
552 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
553 const struct snd_kcontrol_new *controls, unsigned int num_controls);
554 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
555 const struct snd_kcontrol_new *controls, int num_controls);
556 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
557 const struct snd_kcontrol_new *controls, int num_controls);
558 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
559 struct snd_ctl_elem_info *uinfo);
560 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
561 struct snd_ctl_elem_value *ucontrol);
562 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
563 struct snd_ctl_elem_value *ucontrol);
564 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
565 struct snd_ctl_elem_info *uinfo);
566 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
567 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
568 struct snd_ctl_elem_value *ucontrol);
569 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
570 struct snd_ctl_elem_value *ucontrol);
571 #define snd_soc_get_volsw_2r snd_soc_get_volsw
572 #define snd_soc_put_volsw_2r snd_soc_put_volsw
573 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
574 struct snd_ctl_elem_value *ucontrol);
575 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
576 struct snd_ctl_elem_value *ucontrol);
577 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
578 struct snd_ctl_elem_info *uinfo);
579 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
580 struct snd_ctl_elem_value *ucontrol);
581 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
582 struct snd_ctl_elem_value *ucontrol);
583 int snd_soc_limit_volume(struct snd_soc_codec *codec,
584 const char *name, int max);
585 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
586 struct snd_ctl_elem_info *uinfo);
587 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
588 struct snd_ctl_elem_value *ucontrol);
589 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
590 struct snd_ctl_elem_value *ucontrol);
591 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
592 struct snd_ctl_elem_info *ucontrol);
593 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
594 unsigned int size, unsigned int __user *tlv);
595 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
596 struct snd_ctl_elem_info *uinfo);
597 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
598 struct snd_ctl_elem_value *ucontrol);
599 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
600 struct snd_ctl_elem_value *ucontrol);
601 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
602 struct snd_ctl_elem_value *ucontrol);
603 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
604 struct snd_ctl_elem_value *ucontrol);
607 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
609 * @pin: name of the pin to update
610 * @mask: bits to check for in reported jack status
611 * @invert: if non-zero then pin is enabled when status is not reported
613 struct snd_soc_jack_pin {
614 struct list_head list;
621 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
623 * @min_mv: start voltage in mv
624 * @max_mv: end voltage in mv
625 * @jack_type: type of jack that is expected for this voltage
626 * @debounce_time: debounce_time for jack, codec driver should wait for this
627 * duration before reading the adc for voltages
628 * @:list: list container
630 struct snd_soc_jack_zone {
633 unsigned int jack_type;
634 unsigned int debounce_time;
635 struct list_head list;
639 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
641 * @gpio: legacy gpio number
642 * @idx: gpio descriptor index within the function of the GPIO
644 * @gpiod_dev GPIO consumer device
645 * @name: gpio name. Also as connection ID for the GPIO consumer
646 * device function name lookup
647 * @report: value to report when jack detected
648 * @invert: report presence in low state
649 * @debouce_time: debouce time in ms
650 * @wake: enable as wake source
651 * @jack_status_check: callback function which overrides the detection
652 * to provide more complex checks (eg, reading an
655 struct snd_soc_jack_gpio {
658 struct device *gpiod_dev;
665 struct snd_soc_jack *jack;
666 struct delayed_work work;
667 struct gpio_desc *desc;
670 int (*jack_status_check)(void *data);
673 struct snd_soc_jack {
675 struct snd_jack *jack;
676 struct snd_soc_card *card;
677 struct list_head pins;
679 struct blocking_notifier_head notifier;
680 struct list_head jack_zones;
683 /* SoC PCM stream information */
684 struct snd_soc_pcm_stream {
685 const char *stream_name;
686 u64 formats; /* SNDRV_PCM_FMTBIT_* */
687 unsigned int rates; /* SNDRV_PCM_RATE_* */
688 unsigned int rate_min; /* min rate */
689 unsigned int rate_max; /* max rate */
690 unsigned int channels_min; /* min channels */
691 unsigned int channels_max; /* max channels */
692 unsigned int sig_bits; /* number of bits of content */
697 int (*startup)(struct snd_pcm_substream *);
698 void (*shutdown)(struct snd_pcm_substream *);
699 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
700 int (*hw_free)(struct snd_pcm_substream *);
701 int (*prepare)(struct snd_pcm_substream *);
702 int (*trigger)(struct snd_pcm_substream *, int);
705 struct snd_soc_compr_ops {
706 int (*startup)(struct snd_compr_stream *);
707 void (*shutdown)(struct snd_compr_stream *);
708 int (*set_params)(struct snd_compr_stream *);
709 int (*trigger)(struct snd_compr_stream *);
712 /* component interface */
713 struct snd_soc_component_driver {
716 /* Default control and setup, added after probe() is run */
717 const struct snd_kcontrol_new *controls;
718 unsigned int num_controls;
719 const struct snd_soc_dapm_widget *dapm_widgets;
720 unsigned int num_dapm_widgets;
721 const struct snd_soc_dapm_route *dapm_routes;
722 unsigned int num_dapm_routes;
724 int (*probe)(struct snd_soc_component *);
725 void (*remove)(struct snd_soc_component *);
728 int (*of_xlate_dai_name)(struct snd_soc_component *component,
729 struct of_phandle_args *args,
730 const char **dai_name);
731 void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type,
733 int (*stream_event)(struct snd_soc_component *, int event);
735 /* probe ordering - for components with runtime dependencies */
740 struct snd_soc_component {
743 const char *name_prefix;
745 struct snd_soc_card *card;
749 unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
750 unsigned int registered_as_component:1;
751 unsigned int probed:1;
753 struct list_head list;
755 struct snd_soc_dai_driver *dai_drv;
758 const struct snd_soc_component_driver *driver;
760 struct list_head dai_list;
762 int (*read)(struct snd_soc_component *, unsigned int, unsigned int *);
763 int (*write)(struct snd_soc_component *, unsigned int, unsigned int);
765 struct regmap *regmap;
768 struct mutex io_mutex;
770 #ifdef CONFIG_DEBUG_FS
771 struct dentry *debugfs_root;
775 * DO NOT use any of the fields below in drivers, they are temporary and
776 * are going to be removed again soon. If you use them in driver code the
777 * driver will be marked as BROKEN when these fields are removed.
780 /* Don't use these, use snd_soc_component_get_dapm() */
781 struct snd_soc_dapm_context dapm;
782 struct snd_soc_dapm_context *dapm_ptr;
784 const struct snd_kcontrol_new *controls;
785 unsigned int num_controls;
786 const struct snd_soc_dapm_widget *dapm_widgets;
787 unsigned int num_dapm_widgets;
788 const struct snd_soc_dapm_route *dapm_routes;
789 unsigned int num_dapm_routes;
790 struct snd_soc_codec *codec;
792 int (*probe)(struct snd_soc_component *);
793 void (*remove)(struct snd_soc_component *);
795 #ifdef CONFIG_DEBUG_FS
796 void (*init_debugfs)(struct snd_soc_component *component);
797 const char *debugfs_prefix;
801 /* SoC Audio Codec device */
802 struct snd_soc_codec {
804 const struct snd_soc_codec_driver *driver;
806 struct list_head list;
807 struct list_head card_list;
810 unsigned int cache_bypass:1; /* Suppress access to the cache */
811 unsigned int suspended:1; /* Codec is in suspend PM state */
812 unsigned int cache_init:1; /* codec cache has been initialized */
815 void *control_data; /* codec control (i2c/3wire) data */
820 struct snd_soc_component component;
823 struct snd_soc_dapm_context dapm;
825 #ifdef CONFIG_DEBUG_FS
826 struct dentry *debugfs_reg;
831 struct snd_soc_codec_driver {
834 int (*probe)(struct snd_soc_codec *);
835 int (*remove)(struct snd_soc_codec *);
836 int (*suspend)(struct snd_soc_codec *);
837 int (*resume)(struct snd_soc_codec *);
838 struct snd_soc_component_driver component_driver;
840 /* Default control and setup, added after probe() is run */
841 const struct snd_kcontrol_new *controls;
843 const struct snd_soc_dapm_widget *dapm_widgets;
844 int num_dapm_widgets;
845 const struct snd_soc_dapm_route *dapm_routes;
848 /* codec wide operations */
849 int (*set_sysclk)(struct snd_soc_codec *codec,
850 int clk_id, int source, unsigned int freq, int dir);
851 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
852 unsigned int freq_in, unsigned int freq_out);
855 struct regmap *(*get_regmap)(struct device *);
856 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
857 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
858 unsigned int reg_cache_size;
859 short reg_cache_step;
861 const void *reg_cache_default;
863 /* codec bias level */
864 int (*set_bias_level)(struct snd_soc_codec *,
865 enum snd_soc_bias_level level);
867 bool suspend_bias_off;
869 void (*seq_notifier)(struct snd_soc_dapm_context *,
870 enum snd_soc_dapm_type, int);
872 bool ignore_pmdown_time; /* Doesn't benefit from pmdown delay */
875 /* SoC platform interface */
876 struct snd_soc_platform_driver {
878 int (*probe)(struct snd_soc_platform *);
879 int (*remove)(struct snd_soc_platform *);
880 struct snd_soc_component_driver component_driver;
882 /* pcm creation and destruction */
883 int (*pcm_new)(struct snd_soc_pcm_runtime *);
884 void (*pcm_free)(struct snd_pcm *);
887 * For platform caused delay reporting.
890 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
891 struct snd_soc_dai *);
893 /* platform stream pcm ops */
894 const struct snd_pcm_ops *ops;
896 /* platform stream compress ops */
897 const struct snd_compr_ops *compr_ops;
899 int (*bespoke_trigger)(struct snd_pcm_substream *, int);
902 struct snd_soc_dai_link_component {
904 struct device_node *of_node;
905 const char *dai_name;
908 struct snd_soc_platform {
910 const struct snd_soc_platform_driver *driver;
912 struct list_head list;
914 struct snd_soc_component component;
917 struct snd_soc_dai_link {
918 /* config - must be set by machine driver */
919 const char *name; /* Codec name */
920 const char *stream_name; /* Stream name */
922 * You MAY specify the link's CPU-side device, either by device name,
923 * or by DT/OF node, but not both. If this information is omitted,
924 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
925 * must be globally unique. These fields are currently typically used
926 * only for codec to codec links, or systems using device tree.
928 const char *cpu_name;
929 struct device_node *cpu_of_node;
931 * You MAY specify the DAI name of the CPU DAI. If this information is
932 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
933 * only, which only works well when that device exposes a single DAI.
935 const char *cpu_dai_name;
937 * You MUST specify the link's codec, either by device name, or by
938 * DT/OF node, but not both.
940 const char *codec_name;
941 struct device_node *codec_of_node;
942 /* You MUST specify the DAI name within the codec */
943 const char *codec_dai_name;
945 struct snd_soc_dai_link_component *codecs;
946 unsigned int num_codecs;
949 * You MAY specify the link's platform/PCM/DMA driver, either by
950 * device name, or by DT/OF node, but not both. Some forms of link
951 * do not need a platform.
953 const char *platform_name;
954 struct device_node *platform_of_node;
955 int be_id; /* optional ID for machine driver BE identification */
957 const struct snd_soc_pcm_stream *params;
958 unsigned int num_params;
960 unsigned int dai_fmt; /* format to set on init */
962 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
964 /* Keep DAI active over suspend */
965 unsigned int ignore_suspend:1;
967 /* Symmetry requirements */
968 unsigned int symmetric_rates:1;
969 unsigned int symmetric_channels:1;
970 unsigned int symmetric_samplebits:1;
972 /* Mark this pcm with non atomic ops */
975 /* Do not create a PCM for this DAI link (Backend link) */
976 unsigned int no_pcm:1;
978 /* This DAI link can route to other DAI links at runtime (Frontend)*/
979 unsigned int dynamic:1;
981 /* DPCM capture and Playback support */
982 unsigned int dpcm_capture:1;
983 unsigned int dpcm_playback:1;
985 /* pmdown_time is ignored at stop */
986 unsigned int ignore_pmdown_time:1;
988 /* codec/machine specific init - e.g. add machine controls */
989 int (*init)(struct snd_soc_pcm_runtime *rtd);
991 /* optional hw_params re-writing for BE and FE sync */
992 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
993 struct snd_pcm_hw_params *params);
995 /* machine stream operations */
996 const struct snd_soc_ops *ops;
997 const struct snd_soc_compr_ops *compr_ops;
999 /* For unidirectional dai links */
1004 struct snd_soc_codec_conf {
1006 * specify device either by device name, or by
1007 * DT/OF node, but not both.
1009 const char *dev_name;
1010 struct device_node *of_node;
1013 * optional map of kcontrol, widget and path name prefixes that are
1014 * associated per device
1016 const char *name_prefix;
1019 struct snd_soc_aux_dev {
1020 const char *name; /* Codec name */
1023 * specify multi-codec either by device name, or by
1024 * DT/OF node, but not both.
1026 const char *codec_name;
1027 struct device_node *codec_of_node;
1029 /* codec/machine specific init - e.g. add machine controls */
1030 int (*init)(struct snd_soc_component *component);
1034 struct snd_soc_card {
1036 const char *long_name;
1037 const char *driver_name;
1039 struct snd_card *snd_card;
1040 struct module *owner;
1043 struct mutex dapm_mutex;
1047 int (*probe)(struct snd_soc_card *card);
1048 int (*late_probe)(struct snd_soc_card *card);
1049 int (*remove)(struct snd_soc_card *card);
1051 /* the pre and post PM functions are used to do any PM work before and
1052 * after the codec and DAI's do any PM work. */
1053 int (*suspend_pre)(struct snd_soc_card *card);
1054 int (*suspend_post)(struct snd_soc_card *card);
1055 int (*resume_pre)(struct snd_soc_card *card);
1056 int (*resume_post)(struct snd_soc_card *card);
1059 int (*set_bias_level)(struct snd_soc_card *,
1060 struct snd_soc_dapm_context *dapm,
1061 enum snd_soc_bias_level level);
1062 int (*set_bias_level_post)(struct snd_soc_card *,
1063 struct snd_soc_dapm_context *dapm,
1064 enum snd_soc_bias_level level);
1068 /* CPU <--> Codec DAI links */
1069 struct snd_soc_dai_link *dai_link;
1071 struct snd_soc_pcm_runtime *rtd;
1074 /* optional codec specific configuration */
1075 struct snd_soc_codec_conf *codec_conf;
1079 * optional auxiliary devices such as amplifiers or codecs with DAI
1082 struct snd_soc_aux_dev *aux_dev;
1084 struct snd_soc_pcm_runtime *rtd_aux;
1087 const struct snd_kcontrol_new *controls;
1091 * Card-specific routes and widgets.
1092 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1094 const struct snd_soc_dapm_widget *dapm_widgets;
1095 int num_dapm_widgets;
1096 const struct snd_soc_dapm_route *dapm_routes;
1097 int num_dapm_routes;
1098 const struct snd_soc_dapm_widget *of_dapm_widgets;
1099 int num_of_dapm_widgets;
1100 const struct snd_soc_dapm_route *of_dapm_routes;
1101 int num_of_dapm_routes;
1104 struct work_struct deferred_resume_work;
1106 /* lists of probed devices belonging to this card */
1107 struct list_head codec_dev_list;
1109 struct list_head widgets;
1110 struct list_head paths;
1111 struct list_head dapm_list;
1112 struct list_head dapm_dirty;
1114 /* Generic DAPM context for the card */
1115 struct snd_soc_dapm_context dapm;
1116 struct snd_soc_dapm_stats dapm_stats;
1117 struct snd_soc_dapm_update *update;
1119 #ifdef CONFIG_DEBUG_FS
1120 struct dentry *debugfs_card_root;
1121 struct dentry *debugfs_pop_time;
1128 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1129 struct snd_soc_pcm_runtime {
1131 struct snd_soc_card *card;
1132 struct snd_soc_dai_link *dai_link;
1133 struct mutex pcm_mutex;
1134 enum snd_soc_pcm_subclass pcm_subclass;
1135 struct snd_pcm_ops ops;
1137 unsigned int dev_registered:1;
1139 /* Dynamic PCM BE runtime data */
1140 struct snd_soc_dpcm_runtime dpcm[2];
1144 unsigned char pop_wait:1;
1146 /* runtime devices */
1147 struct snd_pcm *pcm;
1148 struct snd_compr *compr;
1149 struct snd_soc_codec *codec;
1150 struct snd_soc_platform *platform;
1151 struct snd_soc_dai *codec_dai;
1152 struct snd_soc_dai *cpu_dai;
1153 struct snd_soc_component *component; /* Only valid for AUX dev rtds */
1155 struct snd_soc_dai **codec_dais;
1156 unsigned int num_codecs;
1158 struct delayed_work delayed_work;
1159 #ifdef CONFIG_DEBUG_FS
1160 struct dentry *debugfs_dpcm_root;
1161 struct dentry *debugfs_dpcm_state;
1166 struct soc_mixer_control {
1167 int min, max, platform_max;
1169 unsigned int shift, rshift;
1170 unsigned int sign_bit;
1171 unsigned int invert:1;
1172 unsigned int autodisable:1;
1181 struct soc_bytes_ext {
1183 /* used for TLV byte control */
1184 int (*get)(unsigned int __user *bytes, unsigned int size);
1185 int (*put)(const unsigned int __user *bytes, unsigned int size);
1188 /* multi register control */
1189 struct soc_mreg_control {
1191 unsigned int regbase, regcount, nbits, invert;
1194 /* enumerated kcontrol */
1197 unsigned char shift_l;
1198 unsigned char shift_r;
1201 const char * const *texts;
1202 const unsigned int *values;
1206 * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1207 * @component: The component to cast to a CODEC
1209 * This function must only be used on components that are known to be CODECs.
1210 * Otherwise the behavior is undefined.
1212 static inline struct snd_soc_codec *snd_soc_component_to_codec(
1213 struct snd_soc_component *component)
1215 return container_of(component, struct snd_soc_codec, component);
1219 * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1220 * @component: The component to cast to a platform
1222 * This function must only be used on components that are known to be platforms.
1223 * Otherwise the behavior is undefined.
1225 static inline struct snd_soc_platform *snd_soc_component_to_platform(
1226 struct snd_soc_component *component)
1228 return container_of(component, struct snd_soc_platform, component);
1232 * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
1234 * @dapm: The DAPM context to cast to the component
1236 * This function must only be used on DAPM contexts that are known to be part of
1237 * a component (e.g. in a component driver). Otherwise the behavior is
1240 static inline struct snd_soc_component *snd_soc_dapm_to_component(
1241 struct snd_soc_dapm_context *dapm)
1243 return container_of(dapm, struct snd_soc_component, dapm);
1247 * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in
1248 * @dapm: The DAPM context to cast to the CODEC
1250 * This function must only be used on DAPM contexts that are known to be part of
1251 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1253 static inline struct snd_soc_codec *snd_soc_dapm_to_codec(
1254 struct snd_soc_dapm_context *dapm)
1256 return container_of(dapm, struct snd_soc_codec, dapm);
1260 * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is
1262 * @dapm: The DAPM context to cast to the platform.
1264 * This function must only be used on DAPM contexts that are known to be part of
1265 * a platform (e.g. in a platform driver). Otherwise the behavior is undefined.
1267 static inline struct snd_soc_platform *snd_soc_dapm_to_platform(
1268 struct snd_soc_dapm_context *dapm)
1270 return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm));
1274 * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
1276 * @component: The component for which to get the DAPM context
1278 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
1279 struct snd_soc_component *component)
1281 return component->dapm_ptr;
1285 * snd_soc_dapm_kcontrol_codec() - Returns the codec associated to a kcontrol
1286 * @kcontrol: The kcontrol
1288 * This function must only be used on DAPM contexts that are known to be part of
1289 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1291 static inline struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(
1292 struct snd_kcontrol *kcontrol)
1294 return snd_soc_dapm_to_codec(snd_soc_dapm_kcontrol_dapm(kcontrol));
1298 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1299 int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg,
1303 * snd_soc_cache_sync() - Sync the register cache with the hardware
1304 * @codec: CODEC to sync
1306 * Note: This function will call regcache_sync()
1308 static inline int snd_soc_cache_sync(struct snd_soc_codec *codec)
1310 return regcache_sync(codec->component.regmap);
1314 int snd_soc_component_read(struct snd_soc_component *component,
1315 unsigned int reg, unsigned int *val);
1316 int snd_soc_component_write(struct snd_soc_component *component,
1317 unsigned int reg, unsigned int val);
1318 int snd_soc_component_update_bits(struct snd_soc_component *component,
1319 unsigned int reg, unsigned int mask, unsigned int val);
1320 int snd_soc_component_update_bits_async(struct snd_soc_component *component,
1321 unsigned int reg, unsigned int mask, unsigned int val);
1322 void snd_soc_component_async_complete(struct snd_soc_component *component);
1323 int snd_soc_component_test_bits(struct snd_soc_component *component,
1324 unsigned int reg, unsigned int mask, unsigned int value);
1326 #ifdef CONFIG_REGMAP
1328 void snd_soc_component_init_regmap(struct snd_soc_component *component,
1329 struct regmap *regmap);
1330 void snd_soc_component_exit_regmap(struct snd_soc_component *component);
1333 * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC
1334 * @codec: The CODEC for which to initialize the regmap instance
1335 * @regmap: The regmap instance that should be used by the CODEC
1337 * This function allows deferred assignment of the regmap instance that is
1338 * associated with the CODEC. Only use this if the regmap instance is not yet
1339 * ready when the CODEC is registered. The function must also be called before
1340 * the first IO attempt of the CODEC.
1342 static inline void snd_soc_codec_init_regmap(struct snd_soc_codec *codec,
1343 struct regmap *regmap)
1345 snd_soc_component_init_regmap(&codec->component, regmap);
1349 * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC
1350 * @codec: The CODEC for which to de-initialize the regmap instance
1352 * Calls regmap_exit() on the regmap instance associated to the CODEC and
1353 * removes the regmap instance from the CODEC.
1355 * This function should only be used if snd_soc_codec_init_regmap() was used to
1356 * initialize the regmap instance.
1358 static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec *codec)
1360 snd_soc_component_exit_regmap(&codec->component);
1365 /* device driver data */
1367 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1370 card->drvdata = data;
1373 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1375 return card->drvdata;
1378 static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
1381 dev_set_drvdata(c->dev, data);
1384 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
1386 return dev_get_drvdata(c->dev);
1389 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1392 snd_soc_component_set_drvdata(&codec->component, data);
1395 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1397 return snd_soc_component_get_drvdata(&codec->component);
1400 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1403 snd_soc_component_set_drvdata(&platform->component, data);
1406 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1408 return snd_soc_component_get_drvdata(&platform->component);
1411 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1414 dev_set_drvdata(rtd->dev, data);
1417 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1419 return dev_get_drvdata(rtd->dev);
1422 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1424 INIT_LIST_HEAD(&card->codec_dev_list);
1425 INIT_LIST_HEAD(&card->widgets);
1426 INIT_LIST_HEAD(&card->paths);
1427 INIT_LIST_HEAD(&card->dapm_list);
1430 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1432 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1435 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1436 * mc->reg != mc->rreg means that the control is
1437 * stereo (bits in one register or in two registers)
1442 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1450 for (i = 0; i < e->items; i++)
1451 if (val == e->values[i])
1457 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1463 return e->values[item];
1466 static inline bool snd_soc_component_is_active(
1467 struct snd_soc_component *component)
1469 return component->active != 0;
1472 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1474 return snd_soc_component_is_active(&codec->component);
1478 * snd_soc_kcontrol_component() - Returns the component that registered the
1480 * @kcontrol: The control for which to get the component
1482 * Note: This function will work correctly if the control has been registered
1483 * for a component. Either with snd_soc_add_codec_controls() or
1484 * snd_soc_add_platform_controls() or via table based setup for either a
1485 * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1487 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1488 struct snd_kcontrol *kcontrol)
1490 return snd_kcontrol_chip(kcontrol);
1494 * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1495 * @kcontrol: The control for which to get the CODEC
1497 * Note: This function will only work correctly if the control has been
1498 * registered with snd_soc_add_codec_controls() or via table based setup of
1499 * snd_soc_codec_driver. Otherwise the behavior is undefined.
1501 static inline struct snd_soc_codec *snd_soc_kcontrol_codec(
1502 struct snd_kcontrol *kcontrol)
1504 return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol));
1508 * snd_soc_kcontrol_platform() - Returns the platform that registered the control
1509 * @kcontrol: The control for which to get the platform
1511 * Note: This function will only work correctly if the control has been
1512 * registered with snd_soc_add_platform_controls() or via table based setup of
1513 * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1515 static inline struct snd_soc_platform *snd_soc_kcontrol_platform(
1516 struct snd_kcontrol *kcontrol)
1518 return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol));
1521 int snd_soc_util_init(void);
1522 void snd_soc_util_exit(void);
1524 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1525 const char *propname);
1526 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1527 const char *propname);
1528 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1529 unsigned int *slots,
1530 unsigned int *slot_width);
1531 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1532 const char *propname);
1533 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1535 struct device_node **bitclkmaster,
1536 struct device_node **framemaster);
1537 int snd_soc_of_get_dai_name(struct device_node *of_node,
1538 const char **dai_name);
1539 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1540 struct device_node *of_node,
1541 struct snd_soc_dai_link *dai_link);
1543 #include <sound/soc-dai.h>
1545 #ifdef CONFIG_DEBUG_FS
1546 extern struct dentry *snd_soc_debugfs_root;
1549 extern const struct dev_pm_ops snd_soc_pm_ops;
1551 /* Helper functions */
1552 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1554 mutex_lock(&dapm->card->dapm_mutex);
1557 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1559 mutex_unlock(&dapm->card->dapm_mutex);