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 int snd_soc_suspend(struct device
*dev
);
391 int snd_soc_resume(struct device
*dev
);
392 int snd_soc_poweroff(struct device
*dev
);
393 int snd_soc_register_platform(struct device
*dev
,
394 const struct snd_soc_platform_driver
*platform_drv
);
395 int devm_snd_soc_register_platform(struct device
*dev
,
396 const struct snd_soc_platform_driver
*platform_drv
);
397 void snd_soc_unregister_platform(struct device
*dev
);
398 int snd_soc_add_platform(struct device
*dev
, struct snd_soc_platform
*platform
,
399 const struct snd_soc_platform_driver
*platform_drv
);
400 void snd_soc_remove_platform(struct snd_soc_platform
*platform
);
401 struct snd_soc_platform
*snd_soc_lookup_platform(struct device
*dev
);
402 int snd_soc_register_codec(struct device
*dev
,
403 const struct snd_soc_codec_driver
*codec_drv
,
404 struct snd_soc_dai_driver
*dai_drv
, int num_dai
);
405 void snd_soc_unregister_codec(struct device
*dev
);
406 int snd_soc_register_component(struct device
*dev
,
407 const struct snd_soc_component_driver
*cmpnt_drv
,
408 struct snd_soc_dai_driver
*dai_drv
, int num_dai
);
409 int devm_snd_soc_register_component(struct device
*dev
,
410 const struct snd_soc_component_driver
*cmpnt_drv
,
411 struct snd_soc_dai_driver
*dai_drv
, int num_dai
);
412 void snd_soc_unregister_component(struct device
*dev
);
413 int snd_soc_cache_init(struct snd_soc_codec
*codec
);
414 int snd_soc_cache_exit(struct snd_soc_codec
*codec
);
416 int snd_soc_platform_read(struct snd_soc_platform
*platform
,
418 int snd_soc_platform_write(struct snd_soc_platform
*platform
,
419 unsigned int reg
, unsigned int val
);
420 int soc_new_pcm(struct snd_soc_pcm_runtime
*rtd
, int num
);
421 int soc_new_compress(struct snd_soc_pcm_runtime
*rtd
, int num
);
423 struct snd_pcm_substream
*snd_soc_get_dai_substream(struct snd_soc_card
*card
,
424 const char *dai_link
, int stream
);
425 struct snd_soc_pcm_runtime
*snd_soc_get_pcm_runtime(struct snd_soc_card
*card
,
426 const char *dai_link
);
428 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime
*rtd
);
429 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime
*rtd
, int stream
);
430 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime
*rtd
, int stream
);
432 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime
*rtd
,
433 unsigned int dai_fmt
);
435 /* Utility functions to get clock rates from various things */
436 int snd_soc_calc_frame_size(int sample_size
, int channels
, int tdm_slots
);
437 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params
*params
);
438 int snd_soc_calc_bclk(int fs
, int sample_size
, int channels
, int tdm_slots
);
439 int snd_soc_params_to_bclk(struct snd_pcm_hw_params
*parms
);
441 /* set runtime hw params */
442 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream
*substream
,
443 const struct snd_pcm_hardware
*hw
);
445 int snd_soc_platform_trigger(struct snd_pcm_substream
*substream
,
446 int cmd
, struct snd_soc_platform
*platform
);
448 int soc_dai_hw_params(struct snd_pcm_substream
*substream
,
449 struct snd_pcm_hw_params
*params
,
450 struct snd_soc_dai
*dai
);
453 int snd_soc_card_jack_new(struct snd_soc_card
*card
, const char *id
, int type
,
454 struct snd_soc_jack
*jack
, struct snd_soc_jack_pin
*pins
,
455 unsigned int num_pins
);
457 void snd_soc_jack_report(struct snd_soc_jack
*jack
, int status
, int mask
);
458 int snd_soc_jack_add_pins(struct snd_soc_jack
*jack
, int count
,
459 struct snd_soc_jack_pin
*pins
);
460 void snd_soc_jack_notifier_register(struct snd_soc_jack
*jack
,
461 struct notifier_block
*nb
);
462 void snd_soc_jack_notifier_unregister(struct snd_soc_jack
*jack
,
463 struct notifier_block
*nb
);
464 int snd_soc_jack_add_zones(struct snd_soc_jack
*jack
, int count
,
465 struct snd_soc_jack_zone
*zones
);
466 int snd_soc_jack_get_type(struct snd_soc_jack
*jack
, int micbias_voltage
);
467 #ifdef CONFIG_GPIOLIB
468 int snd_soc_jack_add_gpios(struct snd_soc_jack
*jack
, int count
,
469 struct snd_soc_jack_gpio
*gpios
);
470 int snd_soc_jack_add_gpiods(struct device
*gpiod_dev
,
471 struct snd_soc_jack
*jack
,
472 int count
, struct snd_soc_jack_gpio
*gpios
);
473 void snd_soc_jack_free_gpios(struct snd_soc_jack
*jack
, int count
,
474 struct snd_soc_jack_gpio
*gpios
);
476 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack
*jack
, int count
,
477 struct snd_soc_jack_gpio
*gpios
)
482 static inline int snd_soc_jack_add_gpiods(struct device
*gpiod_dev
,
483 struct snd_soc_jack
*jack
,
485 struct snd_soc_jack_gpio
*gpios
)
490 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack
*jack
, int count
,
491 struct snd_soc_jack_gpio
*gpios
)
496 /* codec register bit access */
497 int snd_soc_update_bits(struct snd_soc_codec
*codec
, unsigned int reg
,
498 unsigned int mask
, unsigned int value
);
499 int snd_soc_update_bits_locked(struct snd_soc_codec
*codec
,
500 unsigned int reg
, unsigned int mask
,
502 int snd_soc_test_bits(struct snd_soc_codec
*codec
, unsigned int reg
,
503 unsigned int mask
, unsigned int value
);
505 #ifdef CONFIG_SND_SOC_AC97_BUS
506 struct snd_ac97
*snd_soc_alloc_ac97_codec(struct snd_soc_codec
*codec
);
507 struct snd_ac97
*snd_soc_new_ac97_codec(struct snd_soc_codec
*codec
);
508 void snd_soc_free_ac97_codec(struct snd_ac97
*ac97
);
510 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops
*ops
);
511 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops
*ops
,
512 struct platform_device
*pdev
);
514 extern struct snd_ac97_bus_ops
*soc_ac97_ops
;
516 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops
*ops
,
517 struct platform_device
*pdev
)
522 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops
*ops
)
531 struct snd_kcontrol
*snd_soc_cnew(const struct snd_kcontrol_new
*_template
,
532 void *data
, const char *long_name
,
534 struct snd_kcontrol
*snd_soc_card_get_kcontrol(struct snd_soc_card
*soc_card
,
536 int snd_soc_add_component_controls(struct snd_soc_component
*component
,
537 const struct snd_kcontrol_new
*controls
, unsigned int num_controls
);
538 int snd_soc_add_codec_controls(struct snd_soc_codec
*codec
,
539 const struct snd_kcontrol_new
*controls
, unsigned int num_controls
);
540 int snd_soc_add_platform_controls(struct snd_soc_platform
*platform
,
541 const struct snd_kcontrol_new
*controls
, unsigned int num_controls
);
542 int snd_soc_add_card_controls(struct snd_soc_card
*soc_card
,
543 const struct snd_kcontrol_new
*controls
, int num_controls
);
544 int snd_soc_add_dai_controls(struct snd_soc_dai
*dai
,
545 const struct snd_kcontrol_new
*controls
, int num_controls
);
546 int snd_soc_info_enum_double(struct snd_kcontrol
*kcontrol
,
547 struct snd_ctl_elem_info
*uinfo
);
548 int snd_soc_get_enum_double(struct snd_kcontrol
*kcontrol
,
549 struct snd_ctl_elem_value
*ucontrol
);
550 int snd_soc_put_enum_double(struct snd_kcontrol
*kcontrol
,
551 struct snd_ctl_elem_value
*ucontrol
);
552 int snd_soc_info_volsw(struct snd_kcontrol
*kcontrol
,
553 struct snd_ctl_elem_info
*uinfo
);
554 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
555 int snd_soc_get_volsw(struct snd_kcontrol
*kcontrol
,
556 struct snd_ctl_elem_value
*ucontrol
);
557 int snd_soc_put_volsw(struct snd_kcontrol
*kcontrol
,
558 struct snd_ctl_elem_value
*ucontrol
);
559 #define snd_soc_get_volsw_2r snd_soc_get_volsw
560 #define snd_soc_put_volsw_2r snd_soc_put_volsw
561 int snd_soc_get_volsw_sx(struct snd_kcontrol
*kcontrol
,
562 struct snd_ctl_elem_value
*ucontrol
);
563 int snd_soc_put_volsw_sx(struct snd_kcontrol
*kcontrol
,
564 struct snd_ctl_elem_value
*ucontrol
);
565 int snd_soc_info_volsw_range(struct snd_kcontrol
*kcontrol
,
566 struct snd_ctl_elem_info
*uinfo
);
567 int snd_soc_put_volsw_range(struct snd_kcontrol
*kcontrol
,
568 struct snd_ctl_elem_value
*ucontrol
);
569 int snd_soc_get_volsw_range(struct snd_kcontrol
*kcontrol
,
570 struct snd_ctl_elem_value
*ucontrol
);
571 int snd_soc_limit_volume(struct snd_soc_codec
*codec
,
572 const char *name
, int max
);
573 int snd_soc_bytes_info(struct snd_kcontrol
*kcontrol
,
574 struct snd_ctl_elem_info
*uinfo
);
575 int snd_soc_bytes_get(struct snd_kcontrol
*kcontrol
,
576 struct snd_ctl_elem_value
*ucontrol
);
577 int snd_soc_bytes_put(struct snd_kcontrol
*kcontrol
,
578 struct snd_ctl_elem_value
*ucontrol
);
579 int snd_soc_bytes_info_ext(struct snd_kcontrol
*kcontrol
,
580 struct snd_ctl_elem_info
*ucontrol
);
581 int snd_soc_bytes_tlv_callback(struct snd_kcontrol
*kcontrol
, int op_flag
,
582 unsigned int size
, unsigned int __user
*tlv
);
583 int snd_soc_info_xr_sx(struct snd_kcontrol
*kcontrol
,
584 struct snd_ctl_elem_info
*uinfo
);
585 int snd_soc_get_xr_sx(struct snd_kcontrol
*kcontrol
,
586 struct snd_ctl_elem_value
*ucontrol
);
587 int snd_soc_put_xr_sx(struct snd_kcontrol
*kcontrol
,
588 struct snd_ctl_elem_value
*ucontrol
);
589 int snd_soc_get_strobe(struct snd_kcontrol
*kcontrol
,
590 struct snd_ctl_elem_value
*ucontrol
);
591 int snd_soc_put_strobe(struct snd_kcontrol
*kcontrol
,
592 struct snd_ctl_elem_value
*ucontrol
);
595 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
597 * @pin: name of the pin to update
598 * @mask: bits to check for in reported jack status
599 * @invert: if non-zero then pin is enabled when status is not reported
601 struct snd_soc_jack_pin
{
602 struct list_head list
;
609 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
611 * @min_mv: start voltage in mv
612 * @max_mv: end voltage in mv
613 * @jack_type: type of jack that is expected for this voltage
614 * @debounce_time: debounce_time for jack, codec driver should wait for this
615 * duration before reading the adc for voltages
616 * @:list: list container
618 struct snd_soc_jack_zone
{
621 unsigned int jack_type
;
622 unsigned int debounce_time
;
623 struct list_head list
;
627 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
629 * @gpio: legacy gpio number
630 * @idx: gpio descriptor index within the function of the GPIO
632 * @gpiod_dev GPIO consumer device
633 * @name: gpio name. Also as connection ID for the GPIO consumer
634 * device function name lookup
635 * @report: value to report when jack detected
636 * @invert: report presence in low state
637 * @debouce_time: debouce time in ms
638 * @wake: enable as wake source
639 * @jack_status_check: callback function which overrides the detection
640 * to provide more complex checks (eg, reading an
643 struct snd_soc_jack_gpio
{
646 struct device
*gpiod_dev
;
653 struct snd_soc_jack
*jack
;
654 struct delayed_work work
;
655 struct gpio_desc
*desc
;
658 int (*jack_status_check
)(void *data
);
661 struct snd_soc_jack
{
663 struct snd_jack
*jack
;
664 struct snd_soc_card
*card
;
665 struct list_head pins
;
667 struct blocking_notifier_head notifier
;
668 struct list_head jack_zones
;
671 /* SoC PCM stream information */
672 struct snd_soc_pcm_stream
{
673 const char *stream_name
;
674 u64 formats
; /* SNDRV_PCM_FMTBIT_* */
675 unsigned int rates
; /* SNDRV_PCM_RATE_* */
676 unsigned int rate_min
; /* min rate */
677 unsigned int rate_max
; /* max rate */
678 unsigned int channels_min
; /* min channels */
679 unsigned int channels_max
; /* max channels */
680 unsigned int sig_bits
; /* number of bits of content */
685 int (*startup
)(struct snd_pcm_substream
*);
686 void (*shutdown
)(struct snd_pcm_substream
*);
687 int (*hw_params
)(struct snd_pcm_substream
*, struct snd_pcm_hw_params
*);
688 int (*hw_free
)(struct snd_pcm_substream
*);
689 int (*prepare
)(struct snd_pcm_substream
*);
690 int (*trigger
)(struct snd_pcm_substream
*, int);
693 struct snd_soc_compr_ops
{
694 int (*startup
)(struct snd_compr_stream
*);
695 void (*shutdown
)(struct snd_compr_stream
*);
696 int (*set_params
)(struct snd_compr_stream
*);
697 int (*trigger
)(struct snd_compr_stream
*);
700 /* component interface */
701 struct snd_soc_component_driver
{
704 /* Default control and setup, added after probe() is run */
705 const struct snd_kcontrol_new
*controls
;
706 unsigned int num_controls
;
707 const struct snd_soc_dapm_widget
*dapm_widgets
;
708 unsigned int num_dapm_widgets
;
709 const struct snd_soc_dapm_route
*dapm_routes
;
710 unsigned int num_dapm_routes
;
712 int (*probe
)(struct snd_soc_component
*);
713 void (*remove
)(struct snd_soc_component
*);
716 int (*of_xlate_dai_name
)(struct snd_soc_component
*component
,
717 struct of_phandle_args
*args
,
718 const char **dai_name
);
719 void (*seq_notifier
)(struct snd_soc_component
*, enum snd_soc_dapm_type
,
721 int (*stream_event
)(struct snd_soc_component
*, int event
);
723 /* probe ordering - for components with runtime dependencies */
728 struct snd_soc_component
{
731 const char *name_prefix
;
733 struct snd_soc_card
*card
;
737 unsigned int ignore_pmdown_time
:1; /* pmdown_time is ignored at stop */
738 unsigned int registered_as_component
:1;
739 unsigned int probed
:1;
741 struct list_head list
;
743 struct snd_soc_dai_driver
*dai_drv
;
746 const struct snd_soc_component_driver
*driver
;
748 struct list_head dai_list
;
750 int (*read
)(struct snd_soc_component
*, unsigned int, unsigned int *);
751 int (*write
)(struct snd_soc_component
*, unsigned int, unsigned int);
753 struct regmap
*regmap
;
756 struct mutex io_mutex
;
758 #ifdef CONFIG_DEBUG_FS
759 struct dentry
*debugfs_root
;
763 * DO NOT use any of the fields below in drivers, they are temporary and
764 * are going to be removed again soon. If you use them in driver code the
765 * driver will be marked as BROKEN when these fields are removed.
768 /* Don't use these, use snd_soc_component_get_dapm() */
769 struct snd_soc_dapm_context dapm
;
770 struct snd_soc_dapm_context
*dapm_ptr
;
772 const struct snd_kcontrol_new
*controls
;
773 unsigned int num_controls
;
774 const struct snd_soc_dapm_widget
*dapm_widgets
;
775 unsigned int num_dapm_widgets
;
776 const struct snd_soc_dapm_route
*dapm_routes
;
777 unsigned int num_dapm_routes
;
778 struct snd_soc_codec
*codec
;
780 int (*probe
)(struct snd_soc_component
*);
781 void (*remove
)(struct snd_soc_component
*);
783 #ifdef CONFIG_DEBUG_FS
784 void (*init_debugfs
)(struct snd_soc_component
*component
);
785 const char *debugfs_prefix
;
789 /* SoC Audio Codec device */
790 struct snd_soc_codec
{
792 const struct snd_soc_codec_driver
*driver
;
794 struct list_head list
;
795 struct list_head card_list
;
798 unsigned int cache_bypass
:1; /* Suppress access to the cache */
799 unsigned int suspended
:1; /* Codec is in suspend PM state */
800 unsigned int cache_init
:1; /* codec cache has been initialized */
803 void *control_data
; /* codec control (i2c/3wire) data */
808 struct snd_soc_component component
;
811 struct snd_soc_dapm_context dapm
;
813 #ifdef CONFIG_DEBUG_FS
814 struct dentry
*debugfs_reg
;
819 struct snd_soc_codec_driver
{
822 int (*probe
)(struct snd_soc_codec
*);
823 int (*remove
)(struct snd_soc_codec
*);
824 int (*suspend
)(struct snd_soc_codec
*);
825 int (*resume
)(struct snd_soc_codec
*);
826 struct snd_soc_component_driver component_driver
;
828 /* Default control and setup, added after probe() is run */
829 const struct snd_kcontrol_new
*controls
;
831 const struct snd_soc_dapm_widget
*dapm_widgets
;
832 int num_dapm_widgets
;
833 const struct snd_soc_dapm_route
*dapm_routes
;
836 /* codec wide operations */
837 int (*set_sysclk
)(struct snd_soc_codec
*codec
,
838 int clk_id
, int source
, unsigned int freq
, int dir
);
839 int (*set_pll
)(struct snd_soc_codec
*codec
, int pll_id
, int source
,
840 unsigned int freq_in
, unsigned int freq_out
);
843 struct regmap
*(*get_regmap
)(struct device
*);
844 unsigned int (*read
)(struct snd_soc_codec
*, unsigned int);
845 int (*write
)(struct snd_soc_codec
*, unsigned int, unsigned int);
846 unsigned int reg_cache_size
;
847 short reg_cache_step
;
849 const void *reg_cache_default
;
851 /* codec bias level */
852 int (*set_bias_level
)(struct snd_soc_codec
*,
853 enum snd_soc_bias_level level
);
855 bool suspend_bias_off
;
857 void (*seq_notifier
)(struct snd_soc_dapm_context
*,
858 enum snd_soc_dapm_type
, int);
860 bool ignore_pmdown_time
; /* Doesn't benefit from pmdown delay */
863 /* SoC platform interface */
864 struct snd_soc_platform_driver
{
866 int (*probe
)(struct snd_soc_platform
*);
867 int (*remove
)(struct snd_soc_platform
*);
868 struct snd_soc_component_driver component_driver
;
870 /* pcm creation and destruction */
871 int (*pcm_new
)(struct snd_soc_pcm_runtime
*);
872 void (*pcm_free
)(struct snd_pcm
*);
875 * For platform caused delay reporting.
878 snd_pcm_sframes_t (*delay
)(struct snd_pcm_substream
*,
879 struct snd_soc_dai
*);
881 /* platform stream pcm ops */
882 const struct snd_pcm_ops
*ops
;
884 /* platform stream compress ops */
885 const struct snd_compr_ops
*compr_ops
;
887 int (*bespoke_trigger
)(struct snd_pcm_substream
*, int);
890 struct snd_soc_dai_link_component
{
892 struct device_node
*of_node
;
893 const char *dai_name
;
896 struct snd_soc_platform
{
898 const struct snd_soc_platform_driver
*driver
;
900 struct list_head list
;
902 struct snd_soc_component component
;
905 struct snd_soc_dai_link
{
906 /* config - must be set by machine driver */
907 const char *name
; /* Codec name */
908 const char *stream_name
; /* Stream name */
910 * You MAY specify the link's CPU-side device, either by device name,
911 * or by DT/OF node, but not both. If this information is omitted,
912 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
913 * must be globally unique. These fields are currently typically used
914 * only for codec to codec links, or systems using device tree.
916 const char *cpu_name
;
917 struct device_node
*cpu_of_node
;
919 * You MAY specify the DAI name of the CPU DAI. If this information is
920 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
921 * only, which only works well when that device exposes a single DAI.
923 const char *cpu_dai_name
;
925 * You MUST specify the link's codec, either by device name, or by
926 * DT/OF node, but not both.
928 const char *codec_name
;
929 struct device_node
*codec_of_node
;
930 /* You MUST specify the DAI name within the codec */
931 const char *codec_dai_name
;
933 struct snd_soc_dai_link_component
*codecs
;
934 unsigned int num_codecs
;
937 * You MAY specify the link's platform/PCM/DMA driver, either by
938 * device name, or by DT/OF node, but not both. Some forms of link
939 * do not need a platform.
941 const char *platform_name
;
942 struct device_node
*platform_of_node
;
943 int be_id
; /* optional ID for machine driver BE identification */
945 const struct snd_soc_pcm_stream
*params
;
947 unsigned int dai_fmt
; /* format to set on init */
949 enum snd_soc_dpcm_trigger trigger
[2]; /* trigger type for DPCM */
951 /* Keep DAI active over suspend */
952 unsigned int ignore_suspend
:1;
954 /* Symmetry requirements */
955 unsigned int symmetric_rates
:1;
956 unsigned int symmetric_channels
:1;
957 unsigned int symmetric_samplebits
:1;
959 /* Mark this pcm with non atomic ops */
962 /* Do not create a PCM for this DAI link (Backend link) */
963 unsigned int no_pcm
:1;
965 /* This DAI link can route to other DAI links at runtime (Frontend)*/
966 unsigned int dynamic
:1;
968 /* DPCM capture and Playback support */
969 unsigned int dpcm_capture
:1;
970 unsigned int dpcm_playback
:1;
972 /* pmdown_time is ignored at stop */
973 unsigned int ignore_pmdown_time
:1;
975 /* codec/machine specific init - e.g. add machine controls */
976 int (*init
)(struct snd_soc_pcm_runtime
*rtd
);
978 /* optional hw_params re-writing for BE and FE sync */
979 int (*be_hw_params_fixup
)(struct snd_soc_pcm_runtime
*rtd
,
980 struct snd_pcm_hw_params
*params
);
982 /* machine stream operations */
983 const struct snd_soc_ops
*ops
;
984 const struct snd_soc_compr_ops
*compr_ops
;
986 /* For unidirectional dai links */
991 struct snd_soc_codec_conf
{
993 * specify device either by device name, or by
994 * DT/OF node, but not both.
996 const char *dev_name
;
997 struct device_node
*of_node
;
1000 * optional map of kcontrol, widget and path name prefixes that are
1001 * associated per device
1003 const char *name_prefix
;
1006 struct snd_soc_aux_dev
{
1007 const char *name
; /* Codec name */
1010 * specify multi-codec either by device name, or by
1011 * DT/OF node, but not both.
1013 const char *codec_name
;
1014 struct device_node
*codec_of_node
;
1016 /* codec/machine specific init - e.g. add machine controls */
1017 int (*init
)(struct snd_soc_component
*component
);
1021 struct snd_soc_card
{
1023 const char *long_name
;
1024 const char *driver_name
;
1026 struct snd_card
*snd_card
;
1027 struct module
*owner
;
1030 struct mutex dapm_mutex
;
1034 int (*probe
)(struct snd_soc_card
*card
);
1035 int (*late_probe
)(struct snd_soc_card
*card
);
1036 int (*remove
)(struct snd_soc_card
*card
);
1038 /* the pre and post PM functions are used to do any PM work before and
1039 * after the codec and DAI's do any PM work. */
1040 int (*suspend_pre
)(struct snd_soc_card
*card
);
1041 int (*suspend_post
)(struct snd_soc_card
*card
);
1042 int (*resume_pre
)(struct snd_soc_card
*card
);
1043 int (*resume_post
)(struct snd_soc_card
*card
);
1046 int (*set_bias_level
)(struct snd_soc_card
*,
1047 struct snd_soc_dapm_context
*dapm
,
1048 enum snd_soc_bias_level level
);
1049 int (*set_bias_level_post
)(struct snd_soc_card
*,
1050 struct snd_soc_dapm_context
*dapm
,
1051 enum snd_soc_bias_level level
);
1055 /* CPU <--> Codec DAI links */
1056 struct snd_soc_dai_link
*dai_link
;
1058 struct snd_soc_pcm_runtime
*rtd
;
1061 /* optional codec specific configuration */
1062 struct snd_soc_codec_conf
*codec_conf
;
1066 * optional auxiliary devices such as amplifiers or codecs with DAI
1069 struct snd_soc_aux_dev
*aux_dev
;
1071 struct snd_soc_pcm_runtime
*rtd_aux
;
1074 const struct snd_kcontrol_new
*controls
;
1078 * Card-specific routes and widgets.
1079 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1081 const struct snd_soc_dapm_widget
*dapm_widgets
;
1082 int num_dapm_widgets
;
1083 const struct snd_soc_dapm_route
*dapm_routes
;
1084 int num_dapm_routes
;
1085 const struct snd_soc_dapm_widget
*of_dapm_widgets
;
1086 int num_of_dapm_widgets
;
1087 const struct snd_soc_dapm_route
*of_dapm_routes
;
1088 int num_of_dapm_routes
;
1091 struct work_struct deferred_resume_work
;
1093 /* lists of probed devices belonging to this card */
1094 struct list_head codec_dev_list
;
1096 struct list_head widgets
;
1097 struct list_head paths
;
1098 struct list_head dapm_list
;
1099 struct list_head dapm_dirty
;
1101 /* Generic DAPM context for the card */
1102 struct snd_soc_dapm_context dapm
;
1103 struct snd_soc_dapm_stats dapm_stats
;
1104 struct snd_soc_dapm_update
*update
;
1106 #ifdef CONFIG_DEBUG_FS
1107 struct dentry
*debugfs_card_root
;
1108 struct dentry
*debugfs_pop_time
;
1115 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1116 struct snd_soc_pcm_runtime
{
1118 struct snd_soc_card
*card
;
1119 struct snd_soc_dai_link
*dai_link
;
1120 struct mutex pcm_mutex
;
1121 enum snd_soc_pcm_subclass pcm_subclass
;
1122 struct snd_pcm_ops ops
;
1124 unsigned int dev_registered
:1;
1126 /* Dynamic PCM BE runtime data */
1127 struct snd_soc_dpcm_runtime dpcm
[2];
1131 unsigned char pop_wait
:1;
1133 /* runtime devices */
1134 struct snd_pcm
*pcm
;
1135 struct snd_compr
*compr
;
1136 struct snd_soc_codec
*codec
;
1137 struct snd_soc_platform
*platform
;
1138 struct snd_soc_dai
*codec_dai
;
1139 struct snd_soc_dai
*cpu_dai
;
1140 struct snd_soc_component
*component
; /* Only valid for AUX dev rtds */
1142 struct snd_soc_dai
**codec_dais
;
1143 unsigned int num_codecs
;
1145 struct delayed_work delayed_work
;
1146 #ifdef CONFIG_DEBUG_FS
1147 struct dentry
*debugfs_dpcm_root
;
1148 struct dentry
*debugfs_dpcm_state
;
1153 struct soc_mixer_control
{
1154 int min
, max
, platform_max
;
1156 unsigned int shift
, rshift
;
1157 unsigned int sign_bit
;
1158 unsigned int invert
:1;
1159 unsigned int autodisable
:1;
1168 struct soc_bytes_ext
{
1170 /* used for TLV byte control */
1171 int (*get
)(unsigned int __user
*bytes
, unsigned int size
);
1172 int (*put
)(const unsigned int __user
*bytes
, unsigned int size
);
1175 /* multi register control */
1176 struct soc_mreg_control
{
1178 unsigned int regbase
, regcount
, nbits
, invert
;
1181 /* enumerated kcontrol */
1184 unsigned char shift_l
;
1185 unsigned char shift_r
;
1188 const char * const *texts
;
1189 const unsigned int *values
;
1193 * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1194 * @component: The component to cast to a CODEC
1196 * This function must only be used on components that are known to be CODECs.
1197 * Otherwise the behavior is undefined.
1199 static inline struct snd_soc_codec
*snd_soc_component_to_codec(
1200 struct snd_soc_component
*component
)
1202 return container_of(component
, struct snd_soc_codec
, component
);
1206 * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1207 * @component: The component to cast to a platform
1209 * This function must only be used on components that are known to be platforms.
1210 * Otherwise the behavior is undefined.
1212 static inline struct snd_soc_platform
*snd_soc_component_to_platform(
1213 struct snd_soc_component
*component
)
1215 return container_of(component
, struct snd_soc_platform
, component
);
1219 * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
1221 * @dapm: The DAPM context to cast to the component
1223 * This function must only be used on DAPM contexts that are known to be part of
1224 * a component (e.g. in a component driver). Otherwise the behavior is
1227 static inline struct snd_soc_component
*snd_soc_dapm_to_component(
1228 struct snd_soc_dapm_context
*dapm
)
1230 return container_of(dapm
, struct snd_soc_component
, dapm
);
1234 * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in
1235 * @dapm: The DAPM context to cast to the CODEC
1237 * This function must only be used on DAPM contexts that are known to be part of
1238 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1240 static inline struct snd_soc_codec
*snd_soc_dapm_to_codec(
1241 struct snd_soc_dapm_context
*dapm
)
1243 return container_of(dapm
, struct snd_soc_codec
, dapm
);
1247 * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is
1249 * @dapm: The DAPM context to cast to the platform.
1251 * This function must only be used on DAPM contexts that are known to be part of
1252 * a platform (e.g. in a platform driver). Otherwise the behavior is undefined.
1254 static inline struct snd_soc_platform
*snd_soc_dapm_to_platform(
1255 struct snd_soc_dapm_context
*dapm
)
1257 return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm
));
1261 * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
1263 * @component: The component for which to get the DAPM context
1265 static inline struct snd_soc_dapm_context
*snd_soc_component_get_dapm(
1266 struct snd_soc_component
*component
)
1268 return component
->dapm_ptr
;
1272 unsigned int snd_soc_read(struct snd_soc_codec
*codec
, unsigned int reg
);
1273 int snd_soc_write(struct snd_soc_codec
*codec
, unsigned int reg
,
1277 * snd_soc_cache_sync() - Sync the register cache with the hardware
1278 * @codec: CODEC to sync
1280 * Note: This function will call regcache_sync()
1282 static inline int snd_soc_cache_sync(struct snd_soc_codec
*codec
)
1284 return regcache_sync(codec
->component
.regmap
);
1288 int snd_soc_component_read(struct snd_soc_component
*component
,
1289 unsigned int reg
, unsigned int *val
);
1290 int snd_soc_component_write(struct snd_soc_component
*component
,
1291 unsigned int reg
, unsigned int val
);
1292 int snd_soc_component_update_bits(struct snd_soc_component
*component
,
1293 unsigned int reg
, unsigned int mask
, unsigned int val
);
1294 int snd_soc_component_update_bits_async(struct snd_soc_component
*component
,
1295 unsigned int reg
, unsigned int mask
, unsigned int val
);
1296 void snd_soc_component_async_complete(struct snd_soc_component
*component
);
1297 int snd_soc_component_test_bits(struct snd_soc_component
*component
,
1298 unsigned int reg
, unsigned int mask
, unsigned int value
);
1300 #ifdef CONFIG_REGMAP
1302 void snd_soc_component_init_regmap(struct snd_soc_component
*component
,
1303 struct regmap
*regmap
);
1304 void snd_soc_component_exit_regmap(struct snd_soc_component
*component
);
1307 * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC
1308 * @codec: The CODEC for which to initialize the regmap instance
1309 * @regmap: The regmap instance that should be used by the CODEC
1311 * This function allows deferred assignment of the regmap instance that is
1312 * associated with the CODEC. Only use this if the regmap instance is not yet
1313 * ready when the CODEC is registered. The function must also be called before
1314 * the first IO attempt of the CODEC.
1316 static inline void snd_soc_codec_init_regmap(struct snd_soc_codec
*codec
,
1317 struct regmap
*regmap
)
1319 snd_soc_component_init_regmap(&codec
->component
, regmap
);
1323 * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC
1324 * @codec: The CODEC for which to de-initialize the regmap instance
1326 * Calls regmap_exit() on the regmap instance associated to the CODEC and
1327 * removes the regmap instance from the CODEC.
1329 * This function should only be used if snd_soc_codec_init_regmap() was used to
1330 * initialize the regmap instance.
1332 static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec
*codec
)
1334 snd_soc_component_exit_regmap(&codec
->component
);
1339 /* device driver data */
1341 static inline void snd_soc_card_set_drvdata(struct snd_soc_card
*card
,
1344 card
->drvdata
= data
;
1347 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card
*card
)
1349 return card
->drvdata
;
1352 static inline void snd_soc_component_set_drvdata(struct snd_soc_component
*c
,
1355 dev_set_drvdata(c
->dev
, data
);
1358 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component
*c
)
1360 return dev_get_drvdata(c
->dev
);
1363 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec
*codec
,
1366 snd_soc_component_set_drvdata(&codec
->component
, data
);
1369 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec
*codec
)
1371 return snd_soc_component_get_drvdata(&codec
->component
);
1374 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform
*platform
,
1377 snd_soc_component_set_drvdata(&platform
->component
, data
);
1380 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform
*platform
)
1382 return snd_soc_component_get_drvdata(&platform
->component
);
1385 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime
*rtd
,
1388 dev_set_drvdata(rtd
->dev
, data
);
1391 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime
*rtd
)
1393 return dev_get_drvdata(rtd
->dev
);
1396 static inline void snd_soc_initialize_card_lists(struct snd_soc_card
*card
)
1398 INIT_LIST_HEAD(&card
->codec_dev_list
);
1399 INIT_LIST_HEAD(&card
->widgets
);
1400 INIT_LIST_HEAD(&card
->paths
);
1401 INIT_LIST_HEAD(&card
->dapm_list
);
1404 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control
*mc
)
1406 if (mc
->reg
== mc
->rreg
&& mc
->shift
== mc
->rshift
)
1409 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1410 * mc->reg != mc->rreg means that the control is
1411 * stereo (bits in one register or in two registers)
1416 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum
*e
,
1424 for (i
= 0; i
< e
->items
; i
++)
1425 if (val
== e
->values
[i
])
1431 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum
*e
,
1437 return e
->values
[item
];
1440 static inline bool snd_soc_component_is_active(
1441 struct snd_soc_component
*component
)
1443 return component
->active
!= 0;
1446 static inline bool snd_soc_codec_is_active(struct snd_soc_codec
*codec
)
1448 return snd_soc_component_is_active(&codec
->component
);
1452 * snd_soc_kcontrol_component() - Returns the component that registered the
1454 * @kcontrol: The control for which to get the component
1456 * Note: This function will work correctly if the control has been registered
1457 * for a component. Either with snd_soc_add_codec_controls() or
1458 * snd_soc_add_platform_controls() or via table based setup for either a
1459 * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1461 static inline struct snd_soc_component
*snd_soc_kcontrol_component(
1462 struct snd_kcontrol
*kcontrol
)
1464 return snd_kcontrol_chip(kcontrol
);
1468 * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1469 * @kcontrol: The control for which to get the CODEC
1471 * Note: This function will only work correctly if the control has been
1472 * registered with snd_soc_add_codec_controls() or via table based setup of
1473 * snd_soc_codec_driver. Otherwise the behavior is undefined.
1475 static inline struct snd_soc_codec
*snd_soc_kcontrol_codec(
1476 struct snd_kcontrol
*kcontrol
)
1478 return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol
));
1482 * snd_soc_kcontrol_platform() - Returns the platform that registerd the control
1483 * @kcontrol: The control for which to get the platform
1485 * Note: This function will only work correctly if the control has been
1486 * registered with snd_soc_add_platform_controls() or via table based setup of
1487 * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1489 static inline struct snd_soc_platform
*snd_soc_kcontrol_platform(
1490 struct snd_kcontrol
*kcontrol
)
1492 return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol
));
1495 int snd_soc_util_init(void);
1496 void snd_soc_util_exit(void);
1498 int snd_soc_of_parse_card_name(struct snd_soc_card
*card
,
1499 const char *propname
);
1500 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card
*card
,
1501 const char *propname
);
1502 int snd_soc_of_parse_tdm_slot(struct device_node
*np
,
1503 unsigned int *slots
,
1504 unsigned int *slot_width
);
1505 int snd_soc_of_parse_audio_routing(struct snd_soc_card
*card
,
1506 const char *propname
);
1507 unsigned int snd_soc_of_parse_daifmt(struct device_node
*np
,
1509 struct device_node
**bitclkmaster
,
1510 struct device_node
**framemaster
);
1511 int snd_soc_of_get_dai_name(struct device_node
*of_node
,
1512 const char **dai_name
);
1513 int snd_soc_of_get_dai_link_codecs(struct device
*dev
,
1514 struct device_node
*of_node
,
1515 struct snd_soc_dai_link
*dai_link
);
1517 #include <sound/soc-dai.h>
1519 #ifdef CONFIG_DEBUG_FS
1520 extern struct dentry
*snd_soc_debugfs_root
;
1523 extern const struct dev_pm_ops snd_soc_pm_ops
;
1525 /* Helper functions */
1526 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context
*dapm
)
1528 mutex_lock(&dapm
->card
->dapm_mutex
);
1531 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context
*dapm
)
1533 mutex_unlock(&dapm
->card
->dapm_mutex
);