1 /* SPDX-License-Identifier: GPL-2.0
3 * linux/sound/soc.h -- ALSA SoC Layer
5 * Author: Liam Girdwood
6 * Created: Aug 11th 2005
7 * Copyright: Wolfson Microelectronics. PLC.
10 #ifndef __LINUX_SND_SOC_H
11 #define __LINUX_SND_SOC_H
13 #include <linux/args.h>
15 #include <linux/platform_device.h>
16 #include <linux/types.h>
17 #include <linux/notifier.h>
18 #include <linux/workqueue.h>
19 #include <linux/interrupt.h>
20 #include <linux/kernel.h>
21 #include <linux/regmap.h>
22 #include <linux/log2.h>
23 #include <sound/core.h>
24 #include <sound/pcm.h>
25 #include <sound/compress_driver.h>
26 #include <sound/control.h>
27 #include <sound/ac97_codec.h>
30 * Convenience kcontrol builders
32 #define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert, xautodisable) \
33 ((unsigned long)&(struct soc_mixer_control) \
34 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
35 .rshift = shift_right, .max = xmax, \
36 .invert = xinvert, .autodisable = xautodisable})
37 #define SOC_DOUBLE_S_VALUE(xreg, shift_left, shift_right, xmin, xmax, xsign_bit, xinvert, xautodisable) \
38 ((unsigned long)&(struct soc_mixer_control) \
39 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
40 .rshift = shift_right, .min = xmin, .max = xmax, \
41 .sign_bit = xsign_bit, .invert = xinvert, .autodisable = xautodisable})
42 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \
43 SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable)
44 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
45 ((unsigned long)&(struct soc_mixer_control) \
46 {.reg = xreg, .max = xmax, .invert = xinvert})
47 #define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
48 ((unsigned long)&(struct soc_mixer_control) \
49 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
50 .max = xmax, .invert = xinvert})
51 #define SOC_DOUBLE_R_S_VALUE(xlreg, xrreg, xshift, xmin, xmax, xsign_bit, xinvert) \
52 ((unsigned long)&(struct soc_mixer_control) \
53 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
54 .max = xmax, .min = xmin, .sign_bit = xsign_bit, \
56 #define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
57 ((unsigned long)&(struct soc_mixer_control) \
58 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
59 .min = xmin, .max = xmax, .invert = xinvert})
60 #define SOC_SINGLE(xname, reg, shift, max, invert) \
61 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
62 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
63 .put = snd_soc_put_volsw, \
64 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
65 #define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
66 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
67 .info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
68 .put = snd_soc_put_volsw_range, \
69 .private_value = (unsigned long)&(struct soc_mixer_control) \
70 {.reg = xreg, .rreg = xreg, .shift = xshift, \
71 .rshift = xshift, .min = xmin, .max = xmax, \
73 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
74 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
75 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
76 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
77 .tlv.p = (tlv_array), \
78 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
79 .put = snd_soc_put_volsw, \
80 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
81 #define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
82 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
83 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
84 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
85 .tlv.p = (tlv_array),\
86 .info = snd_soc_info_volsw_sx, \
87 .get = snd_soc_get_volsw_sx,\
88 .put = snd_soc_put_volsw_sx, \
89 .private_value = (unsigned long)&(struct soc_mixer_control) \
90 {.reg = xreg, .rreg = xreg, \
91 .shift = xshift, .rshift = xshift, \
92 .max = xmax, .min = xmin} }
93 #define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
94 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
95 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
96 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
97 .tlv.p = (tlv_array), \
98 .info = snd_soc_info_volsw_range, \
99 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
100 .private_value = (unsigned long)&(struct soc_mixer_control) \
101 {.reg = xreg, .rreg = xreg, .shift = xshift, \
102 .rshift = xshift, .min = xmin, .max = xmax, \
104 #define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
105 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
106 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
107 .put = snd_soc_put_volsw, \
108 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
110 #define SOC_DOUBLE_STS(xname, reg, shift_left, shift_right, max, invert) \
112 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
113 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
114 .access = SNDRV_CTL_ELEM_ACCESS_READ | \
115 SNDRV_CTL_ELEM_ACCESS_VOLATILE, \
116 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
118 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
119 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
120 .info = snd_soc_info_volsw, \
121 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
122 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
124 #define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
126 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
127 .info = snd_soc_info_volsw_range, \
128 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
129 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
130 xshift, xmin, xmax, xinvert) }
131 #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
132 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
133 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
134 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
135 .tlv.p = (tlv_array), \
136 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
137 .put = snd_soc_put_volsw, \
138 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
140 #define SOC_DOUBLE_SX_TLV(xname, xreg, shift_left, shift_right, xmin, xmax, tlv_array) \
141 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
142 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
143 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
144 .tlv.p = (tlv_array), \
145 .info = snd_soc_info_volsw_sx, \
146 .get = snd_soc_get_volsw_sx, \
147 .put = snd_soc_put_volsw_sx, \
148 .private_value = (unsigned long)&(struct soc_mixer_control) \
149 {.reg = xreg, .rreg = xreg, \
150 .shift = shift_left, .rshift = shift_right, \
151 .max = xmax, .min = xmin} }
152 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
153 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
154 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
155 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
156 .tlv.p = (tlv_array), \
157 .info = snd_soc_info_volsw, \
158 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
159 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
161 #define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
162 xmax, xinvert, tlv_array) \
163 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
164 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
165 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
166 .tlv.p = (tlv_array), \
167 .info = snd_soc_info_volsw_range, \
168 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
169 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
170 xshift, xmin, xmax, xinvert) }
171 #define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
172 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
173 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
174 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
175 .tlv.p = (tlv_array), \
176 .info = snd_soc_info_volsw_sx, \
177 .get = snd_soc_get_volsw_sx, \
178 .put = snd_soc_put_volsw_sx, \
179 .private_value = (unsigned long)&(struct soc_mixer_control) \
180 {.reg = xreg, .rreg = xrreg, \
181 .shift = xshift, .rshift = xshift, \
182 .max = xmax, .min = xmin} }
183 #define SOC_DOUBLE_R_S_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
184 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
185 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
186 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
187 .tlv.p = (tlv_array), \
188 .info = snd_soc_info_volsw, \
189 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
190 .private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
191 xmin, xmax, xsign_bit, xinvert) }
192 #define SOC_SINGLE_S_TLV(xname, xreg, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
193 SOC_DOUBLE_R_S_TLV(xname, xreg, xreg, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array)
194 #define SOC_SINGLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
195 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
196 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
197 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
198 .tlv.p = (tlv_array), \
199 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
200 .put = snd_soc_put_volsw, \
201 .private_value = (unsigned long)&(struct soc_mixer_control) \
202 {.reg = xreg, .rreg = xreg, \
203 .min = xmin, .max = xmax, \
205 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
206 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
207 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
208 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
209 .tlv.p = (tlv_array), \
210 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
211 .put = snd_soc_put_volsw, \
212 .private_value = SOC_DOUBLE_S_VALUE(xreg, 0, 8, xmin, xmax, 7, 0, 0) }
213 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \
214 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
215 .items = xitems, .texts = xtexts, \
216 .mask = xitems ? roundup_pow_of_two(xitems) - 1 : 0}
217 #define SOC_ENUM_SINGLE(xreg, xshift, xitems, xtexts) \
218 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xitems, xtexts)
219 #define SOC_ENUM_SINGLE_EXT(xitems, xtexts) \
220 { .items = xitems, .texts = xtexts }
221 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xitems, xtexts, xvalues) \
222 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
223 .mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues}
224 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
225 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xitems, xtexts, xvalues)
226 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
227 { .reg = xreg, .shift_l = xshift, .shift_r = xshift, \
228 .mask = xmask, .items = xitems, .texts = xtexts, \
229 .values = xvalues, .autodisable = 1}
230 #define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \
231 SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
232 #define SOC_ENUM(xname, xenum) \
233 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
234 .info = snd_soc_info_enum_double, \
235 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
236 .private_value = (unsigned long)&xenum }
237 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
238 xhandler_get, xhandler_put) \
239 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
240 .info = snd_soc_info_volsw, \
241 .get = xhandler_get, .put = xhandler_put, \
242 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
243 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
244 xhandler_get, xhandler_put) \
245 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
246 .info = snd_soc_info_volsw, \
247 .get = xhandler_get, .put = xhandler_put, \
249 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
250 #define SOC_DOUBLE_R_EXT(xname, reg_left, reg_right, xshift, xmax, xinvert,\
251 xhandler_get, xhandler_put) \
252 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
253 .info = snd_soc_info_volsw, \
254 .get = xhandler_get, .put = xhandler_put, \
255 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
257 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
258 xhandler_get, xhandler_put, tlv_array) \
259 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
260 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
261 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
262 .tlv.p = (tlv_array), \
263 .info = snd_soc_info_volsw, \
264 .get = xhandler_get, .put = xhandler_put, \
265 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
266 #define SOC_SINGLE_RANGE_EXT_TLV(xname, xreg, xshift, xmin, xmax, xinvert, \
267 xhandler_get, xhandler_put, tlv_array) \
268 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
269 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
270 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
271 .tlv.p = (tlv_array), \
272 .info = snd_soc_info_volsw_range, \
273 .get = xhandler_get, .put = xhandler_put, \
274 .private_value = (unsigned long)&(struct soc_mixer_control) \
275 {.reg = xreg, .rreg = xreg, .shift = xshift, \
276 .rshift = xshift, .min = xmin, .max = xmax, \
278 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
279 xhandler_get, xhandler_put, tlv_array) \
280 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
281 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
282 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
283 .tlv.p = (tlv_array), \
284 .info = snd_soc_info_volsw, \
285 .get = xhandler_get, .put = xhandler_put, \
286 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
288 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
289 xhandler_get, xhandler_put, tlv_array) \
290 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
291 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
292 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
293 .tlv.p = (tlv_array), \
294 .info = snd_soc_info_volsw, \
295 .get = xhandler_get, .put = xhandler_put, \
296 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
298 #define SOC_DOUBLE_R_S_EXT_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, \
299 xsign_bit, xinvert, xhandler_get, xhandler_put, \
301 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
302 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
303 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
304 .tlv.p = (tlv_array), \
305 .info = snd_soc_info_volsw, \
306 .get = xhandler_get, .put = xhandler_put, \
307 .private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
308 xmin, xmax, xsign_bit, xinvert) }
309 #define SOC_SINGLE_S_EXT_TLV(xname, xreg, xshift, xmin, xmax, \
310 xsign_bit, xinvert, xhandler_get, xhandler_put, \
312 SOC_DOUBLE_R_S_EXT_TLV(xname, xreg, xreg, xshift, xmin, xmax, \
313 xsign_bit, xinvert, xhandler_get, xhandler_put, \
315 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
316 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
317 .info = snd_soc_info_bool_ext, \
318 .get = xhandler_get, .put = xhandler_put, \
319 .private_value = xdata }
320 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
321 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
322 .info = snd_soc_info_enum_double, \
323 .get = xhandler_get, .put = xhandler_put, \
324 .private_value = (unsigned long)&xenum }
325 #define SOC_VALUE_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
326 SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put)
328 #define SND_SOC_BYTES(xname, xbase, xregs) \
329 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
330 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
331 .put = snd_soc_bytes_put, .private_value = \
332 ((unsigned long)&(struct soc_bytes) \
333 {.base = xbase, .num_regs = xregs }) }
334 #define SND_SOC_BYTES_E(xname, xbase, xregs, xhandler_get, xhandler_put) \
335 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
336 .info = snd_soc_bytes_info, .get = xhandler_get, \
337 .put = xhandler_put, .private_value = \
338 ((unsigned long)&(struct soc_bytes) \
339 {.base = xbase, .num_regs = xregs }) }
341 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask) \
342 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
343 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
344 .put = snd_soc_bytes_put, .private_value = \
345 ((unsigned long)&(struct soc_bytes) \
346 {.base = xbase, .num_regs = xregs, \
350 * SND_SOC_BYTES_EXT is deprecated, please USE SND_SOC_BYTES_TLV instead
352 #define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \
353 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
354 .info = snd_soc_bytes_info_ext, \
355 .get = xhandler_get, .put = xhandler_put, \
356 .private_value = (unsigned long)&(struct soc_bytes_ext) \
358 #define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \
359 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
360 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \
361 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
362 .tlv.c = (snd_soc_bytes_tlv_callback), \
363 .info = snd_soc_bytes_info_ext, \
364 .private_value = (unsigned long)&(struct soc_bytes_ext) \
365 {.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
366 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
367 xmin, xmax, xinvert) \
368 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
369 .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
370 .put = snd_soc_put_xr_sx, \
371 .private_value = (unsigned long)&(struct soc_mreg_control) \
372 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
373 .invert = xinvert, .min = xmin, .max = xmax} }
375 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
376 SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
377 snd_soc_get_strobe, snd_soc_put_strobe)
380 * Simplified versions of above macros, declaring a struct and calculating
381 * ARRAY_SIZE internally
383 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
384 const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
385 ARRAY_SIZE(xtexts), xtexts)
386 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
387 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
388 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
389 const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
390 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
391 const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
392 ARRAY_SIZE(xtexts), xtexts, xvalues)
393 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
394 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
396 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
397 const struct soc_enum name = SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, \
398 xshift, xmask, ARRAY_SIZE(xtexts), xtexts, xvalues)
400 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
401 const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
406 struct snd_soc_pcm_stream;
408 struct snd_soc_pcm_runtime;
410 struct snd_soc_dai_driver;
411 struct snd_soc_dai_link;
412 struct snd_soc_component;
413 struct snd_soc_component_driver;
416 struct snd_soc_jack_zone;
417 struct snd_soc_jack_pin;
418 #include <sound/soc-dapm.h>
419 #include <sound/soc-dpcm.h>
420 #include <sound/soc-topology.h>
422 struct snd_soc_jack_gpio;
424 enum snd_soc_pcm_subclass {
425 SND_SOC_PCM_CLASS_PCM = 0,
426 SND_SOC_PCM_CLASS_BE = 1,
429 int snd_soc_register_card(struct snd_soc_card *card);
430 void snd_soc_unregister_card(struct snd_soc_card *card);
431 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
432 #ifdef CONFIG_PM_SLEEP
433 int snd_soc_suspend(struct device *dev);
434 int snd_soc_resume(struct device *dev);
436 static inline int snd_soc_suspend(struct device *dev)
441 static inline int snd_soc_resume(struct device *dev)
446 int snd_soc_poweroff(struct device *dev);
447 int snd_soc_component_initialize(struct snd_soc_component *component,
448 const struct snd_soc_component_driver *driver,
450 int snd_soc_add_component(struct snd_soc_component *component,
451 struct snd_soc_dai_driver *dai_drv,
453 int snd_soc_register_component(struct device *dev,
454 const struct snd_soc_component_driver *component_driver,
455 struct snd_soc_dai_driver *dai_drv, int num_dai);
456 int devm_snd_soc_register_component(struct device *dev,
457 const struct snd_soc_component_driver *component_driver,
458 struct snd_soc_dai_driver *dai_drv, int num_dai);
459 void snd_soc_unregister_component(struct device *dev);
460 void snd_soc_unregister_component_by_driver(struct device *dev,
461 const struct snd_soc_component_driver *component_driver);
462 struct snd_soc_component *snd_soc_lookup_component_nolocked(struct device *dev,
463 const char *driver_name);
464 struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
465 const char *driver_name);
467 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
468 #ifdef CONFIG_SND_SOC_COMPRESS
469 int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
471 static inline int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num)
477 void snd_soc_disconnect_sync(struct device *dev);
479 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
480 struct snd_soc_dai_link *dai_link);
482 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
484 void snd_soc_runtime_action(struct snd_soc_pcm_runtime *rtd,
485 int stream, int action);
486 static inline void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd,
489 snd_soc_runtime_action(rtd, stream, 1);
491 static inline void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd,
494 snd_soc_runtime_action(rtd, stream, -1);
497 int snd_soc_runtime_calc_hw(struct snd_soc_pcm_runtime *rtd,
498 struct snd_pcm_hardware *hw, int stream);
500 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
501 unsigned int dai_fmt);
504 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour);
506 static inline int snd_soc_set_dmi_name(struct snd_soc_card *card,
513 /* Utility functions to get clock rates from various things */
514 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
515 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
516 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
517 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
518 int snd_soc_tdm_params_to_bclk(struct snd_pcm_hw_params *params,
519 int tdm_width, int tdm_slots, int slot_multiple);
521 /* set runtime hw params */
522 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
523 const struct snd_pcm_hardware *hw);
525 struct snd_ac97 *snd_soc_alloc_ac97_component(struct snd_soc_component *component);
526 struct snd_ac97 *snd_soc_new_ac97_component(struct snd_soc_component *component,
527 unsigned int id, unsigned int id_mask);
528 void snd_soc_free_ac97_component(struct snd_ac97 *ac97);
530 #ifdef CONFIG_SND_SOC_AC97_BUS
531 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
532 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
533 struct platform_device *pdev);
535 extern struct snd_ac97_bus_ops *soc_ac97_ops;
537 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
538 struct platform_device *pdev)
543 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
552 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
553 void *data, const char *long_name,
555 int snd_soc_add_component_controls(struct snd_soc_component *component,
556 const struct snd_kcontrol_new *controls, unsigned int num_controls);
557 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
558 const struct snd_kcontrol_new *controls, int num_controls);
559 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
560 const struct snd_kcontrol_new *controls, int num_controls);
561 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
562 struct snd_ctl_elem_info *uinfo);
563 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
564 struct snd_ctl_elem_value *ucontrol);
565 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
566 struct snd_ctl_elem_value *ucontrol);
567 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
568 struct snd_ctl_elem_info *uinfo);
569 int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol,
570 struct snd_ctl_elem_info *uinfo);
571 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
572 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
573 struct snd_ctl_elem_value *ucontrol);
574 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
575 struct snd_ctl_elem_value *ucontrol);
576 #define snd_soc_get_volsw_2r snd_soc_get_volsw
577 #define snd_soc_put_volsw_2r snd_soc_put_volsw
578 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
579 struct snd_ctl_elem_value *ucontrol);
580 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
581 struct snd_ctl_elem_value *ucontrol);
582 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
583 struct snd_ctl_elem_info *uinfo);
584 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
585 struct snd_ctl_elem_value *ucontrol);
586 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
587 struct snd_ctl_elem_value *ucontrol);
588 int snd_soc_limit_volume(struct snd_soc_card *card,
589 const char *name, int max);
590 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
591 struct snd_ctl_elem_info *uinfo);
592 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
593 struct snd_ctl_elem_value *ucontrol);
594 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
595 struct snd_ctl_elem_value *ucontrol);
596 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
597 struct snd_ctl_elem_info *ucontrol);
598 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
599 unsigned int size, unsigned int __user *tlv);
600 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
601 struct snd_ctl_elem_info *uinfo);
602 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
603 struct snd_ctl_elem_value *ucontrol);
604 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
605 struct snd_ctl_elem_value *ucontrol);
606 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
607 struct snd_ctl_elem_value *ucontrol);
608 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
609 struct snd_ctl_elem_value *ucontrol);
611 enum snd_soc_trigger_order {
613 SND_SOC_TRIGGER_ORDER_DEFAULT = 0, /* Link->Component->DAI DAI->Component->Link */
614 SND_SOC_TRIGGER_ORDER_LDC, /* Link->DAI->Component Component->DAI->Link */
616 SND_SOC_TRIGGER_ORDER_MAX,
619 /* SoC PCM stream information */
620 struct snd_soc_pcm_stream {
621 const char *stream_name;
622 u64 formats; /* SNDRV_PCM_FMTBIT_* */
623 unsigned int rates; /* SNDRV_PCM_RATE_* */
624 unsigned int rate_min; /* min rate */
625 unsigned int rate_max; /* max rate */
626 unsigned int channels_min; /* min channels */
627 unsigned int channels_max; /* max channels */
628 unsigned int sig_bits; /* number of bits of content */
633 int (*startup)(struct snd_pcm_substream *);
634 void (*shutdown)(struct snd_pcm_substream *);
635 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
636 int (*hw_free)(struct snd_pcm_substream *);
637 int (*prepare)(struct snd_pcm_substream *);
638 int (*trigger)(struct snd_pcm_substream *, int);
641 struct snd_soc_compr_ops {
642 int (*startup)(struct snd_compr_stream *);
643 void (*shutdown)(struct snd_compr_stream *);
644 int (*set_params)(struct snd_compr_stream *);
647 struct snd_soc_component*
648 snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
649 const char *driver_name);
651 struct snd_soc_dai_link_component {
653 struct device_node *of_node;
654 const char *dai_name;
655 struct of_phandle_args *dai_args;
658 struct snd_soc_dai_link_codec_ch_map {
659 unsigned int connected_cpu_id;
660 unsigned int ch_mask;
663 struct snd_soc_dai_link {
664 /* config - must be set by machine driver */
665 const char *name; /* Codec name */
666 const char *stream_name; /* Stream name */
669 * You MAY specify the link's CPU-side device, either by device name,
670 * or by DT/OF node, but not both. If this information is omitted,
671 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
672 * must be globally unique. These fields are currently typically used
673 * only for codec to codec links, or systems using device tree.
676 * You MAY specify the DAI name of the CPU DAI. If this information is
677 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
678 * only, which only works well when that device exposes a single DAI.
680 struct snd_soc_dai_link_component *cpus;
681 unsigned int num_cpus;
684 * You MUST specify the link's codec, either by device name, or by
685 * DT/OF node, but not both.
687 /* You MUST specify the DAI name within the codec */
688 struct snd_soc_dai_link_component *codecs;
689 unsigned int num_codecs;
691 struct snd_soc_dai_link_codec_ch_map *codec_ch_maps;
693 * You MAY specify the link's platform/PCM/DMA driver, either by
694 * device name, or by DT/OF node, but not both. Some forms of link
695 * do not need a platform. In such case, platforms are not mandatory.
697 struct snd_soc_dai_link_component *platforms;
698 unsigned int num_platforms;
700 int id; /* optional ID for machine driver link identification */
705 const struct snd_soc_pcm_stream *c2c_params;
706 unsigned int num_c2c_params;
708 unsigned int dai_fmt; /* format to set on init */
710 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
712 /* codec/machine specific init - e.g. add machine controls */
713 int (*init)(struct snd_soc_pcm_runtime *rtd);
715 /* codec/machine specific exit - dual of init() */
716 void (*exit)(struct snd_soc_pcm_runtime *rtd);
718 /* optional hw_params re-writing for BE and FE sync */
719 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
720 struct snd_pcm_hw_params *params);
722 /* machine stream operations */
723 const struct snd_soc_ops *ops;
724 const struct snd_soc_compr_ops *compr_ops;
727 * soc_pcm_trigger() start/stop sequence.
729 * snd_soc_component_driver
732 enum snd_soc_trigger_order trigger_start;
733 enum snd_soc_trigger_order trigger_stop;
735 /* Mark this pcm with non atomic ops */
736 unsigned int nonatomic:1;
738 /* For unidirectional dai links */
739 unsigned int playback_only:1;
740 unsigned int capture_only:1;
742 /* Keep DAI active over suspend */
743 unsigned int ignore_suspend:1;
745 /* Symmetry requirements */
746 unsigned int symmetric_rate:1;
747 unsigned int symmetric_channels:1;
748 unsigned int symmetric_sample_bits:1;
750 /* Do not create a PCM for this DAI link (Backend link) */
751 unsigned int no_pcm:1;
753 /* This DAI link can route to other DAI links at runtime (Frontend)*/
754 unsigned int dynamic:1;
756 /* DPCM capture and Playback support */
757 unsigned int dpcm_capture:1;
758 unsigned int dpcm_playback:1;
760 /* DPCM used FE & BE merged format */
761 unsigned int dpcm_merged_format:1;
762 /* DPCM used FE & BE merged channel */
763 unsigned int dpcm_merged_chan:1;
764 /* DPCM used FE & BE merged rate */
765 unsigned int dpcm_merged_rate:1;
767 /* pmdown_time is ignored at stop */
768 unsigned int ignore_pmdown_time:1;
770 /* Do not create a PCM for this DAI link (Backend link) */
771 unsigned int ignore:1;
773 #ifdef CONFIG_SND_SOC_TOPOLOGY
774 struct snd_soc_dobj dobj; /* For topology */
778 static inline struct snd_soc_dai_link_component*
779 snd_soc_link_to_cpu(struct snd_soc_dai_link *link, int n) {
780 return &(link)->cpus[n];
783 static inline struct snd_soc_dai_link_component*
784 snd_soc_link_to_codec(struct snd_soc_dai_link *link, int n) {
785 return &(link)->codecs[n];
788 static inline struct snd_soc_dai_link_component*
789 snd_soc_link_to_platform(struct snd_soc_dai_link *link, int n) {
790 return &(link)->platforms[n];
793 #define for_each_link_codecs(link, i, codec) \
795 ((i) < link->num_codecs) && \
796 ((codec) = snd_soc_link_to_codec(link, i)); \
799 #define for_each_link_platforms(link, i, platform) \
801 ((i) < link->num_platforms) && \
802 ((platform) = snd_soc_link_to_platform(link, i)); \
805 #define for_each_link_cpus(link, i, cpu) \
807 ((i) < link->num_cpus) && \
808 ((cpu) = snd_soc_link_to_cpu(link, i)); \
812 * Sample 1 : Single CPU/Codec/Platform
814 * SND_SOC_DAILINK_DEFS(test,
815 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai")),
816 * DAILINK_COMP_ARRAY(COMP_CODEC("codec", "codec_dai")),
817 * DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
819 * struct snd_soc_dai_link link = {
821 * SND_SOC_DAILINK_REG(test),
824 * Sample 2 : Multi CPU/Codec, no Platform
826 * SND_SOC_DAILINK_DEFS(test,
827 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
828 * COMP_CPU("cpu_dai2")),
829 * DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
830 * COMP_CODEC("codec2", "codec_dai2")));
832 * struct snd_soc_dai_link link = {
834 * SND_SOC_DAILINK_REG(test),
837 * Sample 3 : Define each CPU/Codec/Platform manually
839 * SND_SOC_DAILINK_DEF(test_cpu,
840 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
841 * COMP_CPU("cpu_dai2")));
842 * SND_SOC_DAILINK_DEF(test_codec,
843 * DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
844 * COMP_CODEC("codec2", "codec_dai2")));
845 * SND_SOC_DAILINK_DEF(test_platform,
846 * DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
848 * struct snd_soc_dai_link link = {
850 * SND_SOC_DAILINK_REG(test_cpu,
855 * Sample 4 : Sample3 without platform
857 * struct snd_soc_dai_link link = {
859 * SND_SOC_DAILINK_REG(test_cpu,
864 #define SND_SOC_DAILINK_REG1(name) SND_SOC_DAILINK_REG3(name##_cpus, name##_codecs, name##_platforms)
865 #define SND_SOC_DAILINK_REG2(cpu, codec) SND_SOC_DAILINK_REG3(cpu, codec, null_dailink_component)
866 #define SND_SOC_DAILINK_REG3(cpu, codec, platform) \
868 .num_cpus = ARRAY_SIZE(cpu), \
870 .num_codecs = ARRAY_SIZE(codec), \
871 .platforms = platform, \
872 .num_platforms = ARRAY_SIZE(platform)
874 #define SND_SOC_DAILINK_REG(...) \
875 CONCATENATE(SND_SOC_DAILINK_REG, COUNT_ARGS(__VA_ARGS__))(__VA_ARGS__)
877 #define SND_SOC_DAILINK_DEF(name, def...) \
878 static struct snd_soc_dai_link_component name[] = { def }
880 #define SND_SOC_DAILINK_DEFS(name, cpu, codec, platform...) \
881 SND_SOC_DAILINK_DEF(name##_cpus, cpu); \
882 SND_SOC_DAILINK_DEF(name##_codecs, codec); \
883 SND_SOC_DAILINK_DEF(name##_platforms, platform)
885 #define DAILINK_COMP_ARRAY(param...) param
886 #define COMP_EMPTY() { }
887 #define COMP_CPU(_dai) { .dai_name = _dai, }
888 #define COMP_CODEC(_name, _dai) { .name = _name, .dai_name = _dai, }
889 #define COMP_PLATFORM(_name) { .name = _name }
890 #define COMP_AUX(_name) { .name = _name }
891 #define COMP_CODEC_CONF(_name) { .name = _name }
892 #define COMP_DUMMY() { .name = "snd-soc-dummy", .dai_name = "snd-soc-dummy-dai", }
894 extern struct snd_soc_dai_link_component null_dailink_component[0];
895 extern struct snd_soc_dai_link_component snd_soc_dummy_dlc;
898 struct snd_soc_codec_conf {
900 * specify device either by device name, or by
901 * DT/OF node, but not both.
903 struct snd_soc_dai_link_component dlc;
906 * optional map of kcontrol, widget and path name prefixes that are
907 * associated per device
909 const char *name_prefix;
912 struct snd_soc_aux_dev {
914 * specify multi-codec either by device name, or by
915 * DT/OF node, but not both.
917 struct snd_soc_dai_link_component dlc;
919 /* codec/machine specific init - e.g. add machine controls */
920 int (*init)(struct snd_soc_component *component);
924 struct snd_soc_card {
926 const char *long_name;
927 const char *driver_name;
928 const char *components;
930 char dmi_longname[80];
931 #endif /* CONFIG_DMI */
935 * PCI does not define 0 as invalid, so pci_subsystem_set indicates
936 * whether a value has been written to these fields.
938 unsigned short pci_subsystem_vendor;
939 unsigned short pci_subsystem_device;
940 bool pci_subsystem_set;
941 #endif /* CONFIG_PCI */
943 char topology_shortname[32];
946 struct snd_card *snd_card;
947 struct module *owner;
950 struct mutex dapm_mutex;
952 /* Mutex for PCM operations */
953 struct mutex pcm_mutex;
954 enum snd_soc_pcm_subclass pcm_subclass;
956 int (*probe)(struct snd_soc_card *card);
957 int (*late_probe)(struct snd_soc_card *card);
958 void (*fixup_controls)(struct snd_soc_card *card);
959 int (*remove)(struct snd_soc_card *card);
961 /* the pre and post PM functions are used to do any PM work before and
962 * after the codec and DAI's do any PM work. */
963 int (*suspend_pre)(struct snd_soc_card *card);
964 int (*suspend_post)(struct snd_soc_card *card);
965 int (*resume_pre)(struct snd_soc_card *card);
966 int (*resume_post)(struct snd_soc_card *card);
969 int (*set_bias_level)(struct snd_soc_card *,
970 struct snd_soc_dapm_context *dapm,
971 enum snd_soc_bias_level level);
972 int (*set_bias_level_post)(struct snd_soc_card *,
973 struct snd_soc_dapm_context *dapm,
974 enum snd_soc_bias_level level);
976 int (*add_dai_link)(struct snd_soc_card *,
977 struct snd_soc_dai_link *link);
978 void (*remove_dai_link)(struct snd_soc_card *,
979 struct snd_soc_dai_link *link);
983 /* CPU <--> Codec DAI links */
984 struct snd_soc_dai_link *dai_link; /* predefined links only */
985 int num_links; /* predefined links only */
987 struct list_head rtd_list;
990 /* optional codec specific configuration */
991 struct snd_soc_codec_conf *codec_conf;
995 * optional auxiliary devices such as amplifiers or codecs with DAI
998 struct snd_soc_aux_dev *aux_dev;
1000 struct list_head aux_comp_list;
1002 const struct snd_kcontrol_new *controls;
1006 * Card-specific routes and widgets.
1007 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1009 const struct snd_soc_dapm_widget *dapm_widgets;
1010 int num_dapm_widgets;
1011 const struct snd_soc_dapm_route *dapm_routes;
1012 int num_dapm_routes;
1013 const struct snd_soc_dapm_widget *of_dapm_widgets;
1014 int num_of_dapm_widgets;
1015 const struct snd_soc_dapm_route *of_dapm_routes;
1016 int num_of_dapm_routes;
1018 /* lists of probed devices belonging to this card */
1019 struct list_head component_dev_list;
1020 struct list_head list;
1022 struct list_head widgets;
1023 struct list_head paths;
1024 struct list_head dapm_list;
1025 struct list_head dapm_dirty;
1027 /* attached dynamic objects */
1028 struct list_head dobj_list;
1030 /* Generic DAPM context for the card */
1031 struct snd_soc_dapm_context dapm;
1032 struct snd_soc_dapm_stats dapm_stats;
1033 struct snd_soc_dapm_update *update;
1035 #ifdef CONFIG_DEBUG_FS
1036 struct dentry *debugfs_card_root;
1038 #ifdef CONFIG_PM_SLEEP
1039 struct work_struct deferred_resume_work;
1044 unsigned int instantiated:1;
1045 unsigned int topology_shortname_created:1;
1046 unsigned int fully_routed:1;
1047 unsigned int disable_route_checks:1;
1048 unsigned int probed:1;
1049 unsigned int component_chaining:1;
1053 #define for_each_card_prelinks(card, i, link) \
1055 ((i) < (card)->num_links) && ((link) = &(card)->dai_link[i]); \
1057 #define for_each_card_pre_auxs(card, i, aux) \
1059 ((i) < (card)->num_aux_devs) && ((aux) = &(card)->aux_dev[i]); \
1062 #define for_each_card_rtds(card, rtd) \
1063 list_for_each_entry(rtd, &(card)->rtd_list, list)
1064 #define for_each_card_rtds_safe(card, rtd, _rtd) \
1065 list_for_each_entry_safe(rtd, _rtd, &(card)->rtd_list, list)
1067 #define for_each_card_auxs(card, component) \
1068 list_for_each_entry(component, &card->aux_comp_list, card_aux_list)
1069 #define for_each_card_auxs_safe(card, component, _comp) \
1070 list_for_each_entry_safe(component, _comp, \
1071 &card->aux_comp_list, card_aux_list)
1073 #define for_each_card_components(card, component) \
1074 list_for_each_entry(component, &(card)->component_dev_list, card_list)
1076 #define for_each_card_dapms(card, dapm) \
1077 list_for_each_entry(dapm, &card->dapm_list, list)
1079 #define for_each_card_widgets(card, w)\
1080 list_for_each_entry(w, &card->widgets, list)
1081 #define for_each_card_widgets_safe(card, w, _w) \
1082 list_for_each_entry_safe(w, _w, &card->widgets, list)
1085 static inline int snd_soc_card_is_instantiated(struct snd_soc_card *card)
1087 return card && card->instantiated;
1090 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1091 struct snd_soc_pcm_runtime {
1093 struct snd_soc_card *card;
1094 struct snd_soc_dai_link *dai_link;
1095 struct snd_pcm_ops ops;
1097 unsigned int c2c_params_select; /* currently selected c2c_param for dai link */
1099 /* Dynamic PCM BE runtime data */
1100 struct snd_soc_dpcm_runtime dpcm[SNDRV_PCM_STREAM_LAST + 1];
1101 struct snd_soc_dapm_widget *c2c_widget[SNDRV_PCM_STREAM_LAST + 1];
1105 /* runtime devices */
1106 struct snd_pcm *pcm;
1107 struct snd_compr *compr;
1110 * dais = cpu_dai + codec_dai
1112 * soc_new_pcm_runtime()
1113 * snd_soc_rtd_to_cpu()
1114 * snd_soc_rtd_to_codec()
1116 struct snd_soc_dai **dais;
1118 struct delayed_work delayed_work;
1119 void (*close_delayed_work_func)(struct snd_soc_pcm_runtime *rtd);
1120 #ifdef CONFIG_DEBUG_FS
1121 struct dentry *debugfs_dpcm_root;
1124 unsigned int num; /* 0-based and monotonic increasing */
1125 struct list_head list; /* rtd list of the soc card */
1128 struct snd_pcm_substream *mark_startup;
1129 struct snd_pcm_substream *mark_hw_params;
1130 struct snd_pcm_substream *mark_trigger;
1131 struct snd_compr_stream *mark_compr_startup;
1134 unsigned int pop_wait:1;
1135 unsigned int fe_compr:1; /* for Dynamic PCM */
1140 struct snd_soc_component *components[]; /* CPU/Codec/Platform */
1143 /* see soc_new_pcm_runtime() */
1144 #define snd_soc_rtd_to_cpu(rtd, n) (rtd)->dais[n]
1145 #define snd_soc_rtd_to_codec(rtd, n) (rtd)->dais[n + (rtd)->dai_link->num_cpus]
1146 #define snd_soc_substream_to_rtd(substream) \
1147 (struct snd_soc_pcm_runtime *)snd_pcm_substream_chip(substream)
1149 #define for_each_rtd_components(rtd, i, component) \
1150 for ((i) = 0, component = NULL; \
1151 ((i) < rtd->num_components) && ((component) = rtd->components[i]);\
1153 #define for_each_rtd_cpu_dais(rtd, i, dai) \
1155 ((i) < rtd->dai_link->num_cpus) && ((dai) = snd_soc_rtd_to_cpu(rtd, i)); \
1157 #define for_each_rtd_codec_dais(rtd, i, dai) \
1159 ((i) < rtd->dai_link->num_codecs) && ((dai) = snd_soc_rtd_to_codec(rtd, i)); \
1161 #define for_each_rtd_dais(rtd, i, dai) \
1163 ((i) < (rtd)->dai_link->num_cpus + (rtd)->dai_link->num_codecs) && \
1164 ((dai) = (rtd)->dais[i]); \
1167 void snd_soc_close_delayed_work(struct snd_soc_pcm_runtime *rtd);
1170 struct soc_mixer_control {
1171 int min, max, platform_max;
1173 unsigned int shift, rshift;
1174 unsigned int sign_bit;
1175 unsigned int invert:1;
1176 unsigned int autodisable:1;
1177 #ifdef CONFIG_SND_SOC_TOPOLOGY
1178 struct snd_soc_dobj dobj;
1188 struct soc_bytes_ext {
1190 #ifdef CONFIG_SND_SOC_TOPOLOGY
1191 struct snd_soc_dobj dobj;
1193 /* used for TLV byte control */
1194 int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1196 int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1200 /* multi register control */
1201 struct soc_mreg_control {
1203 unsigned int regbase, regcount, nbits, invert;
1206 /* enumerated kcontrol */
1209 unsigned char shift_l;
1210 unsigned char shift_r;
1213 const char * const *texts;
1214 const unsigned int *values;
1215 unsigned int autodisable:1;
1216 #ifdef CONFIG_SND_SOC_TOPOLOGY
1217 struct snd_soc_dobj dobj;
1221 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1223 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1226 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1227 * mc->reg != mc->rreg means that the control is
1228 * stereo (bits in one register or in two registers)
1233 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1241 for (i = 0; i < e->items; i++)
1242 if (val == e->values[i])
1248 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1254 return e->values[item];
1258 * snd_soc_kcontrol_component() - Returns the component that registered the
1260 * @kcontrol: The control for which to get the component
1262 * Note: This function will work correctly if the control has been registered
1263 * for a component. With snd_soc_add_codec_controls() or via table based
1264 * setup for either a CODEC or component driver. Otherwise the behavior is
1267 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1268 struct snd_kcontrol *kcontrol)
1270 return snd_kcontrol_chip(kcontrol);
1273 int snd_soc_util_init(void);
1274 void snd_soc_util_exit(void);
1276 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1277 const char *propname);
1278 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1279 const char *propname);
1280 int snd_soc_of_parse_pin_switches(struct snd_soc_card *card, const char *prop);
1281 int snd_soc_of_get_slot_mask(struct device_node *np,
1282 const char *prop_name,
1283 unsigned int *mask);
1284 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1285 unsigned int *tx_mask,
1286 unsigned int *rx_mask,
1287 unsigned int *slots,
1288 unsigned int *slot_width);
1289 void snd_soc_of_parse_node_prefix(struct device_node *np,
1290 struct snd_soc_codec_conf *codec_conf,
1291 struct device_node *of_node,
1292 const char *propname);
1294 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1295 struct snd_soc_codec_conf *codec_conf,
1296 struct device_node *of_node,
1297 const char *propname)
1299 snd_soc_of_parse_node_prefix(card->dev->of_node,
1300 codec_conf, of_node, propname);
1303 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1304 const char *propname);
1305 int snd_soc_of_parse_aux_devs(struct snd_soc_card *card, const char *propname);
1307 unsigned int snd_soc_daifmt_clock_provider_flipped(unsigned int dai_fmt);
1308 unsigned int snd_soc_daifmt_clock_provider_from_bitmap(unsigned int bit_frame);
1310 unsigned int snd_soc_daifmt_parse_format(struct device_node *np, const char *prefix);
1311 unsigned int snd_soc_daifmt_parse_clock_provider_raw(struct device_node *np,
1313 struct device_node **bitclkmaster,
1314 struct device_node **framemaster);
1315 #define snd_soc_daifmt_parse_clock_provider_as_bitmap(np, prefix) \
1316 snd_soc_daifmt_parse_clock_provider_raw(np, prefix, NULL, NULL)
1317 #define snd_soc_daifmt_parse_clock_provider_as_phandle \
1318 snd_soc_daifmt_parse_clock_provider_raw
1319 #define snd_soc_daifmt_parse_clock_provider_as_flag(np, prefix) \
1320 snd_soc_daifmt_clock_provider_from_bitmap( \
1321 snd_soc_daifmt_parse_clock_provider_as_bitmap(np, prefix))
1323 int snd_soc_get_stream_cpu(struct snd_soc_dai_link *dai_link, int stream);
1324 int snd_soc_get_dlc(const struct of_phandle_args *args,
1325 struct snd_soc_dai_link_component *dlc);
1326 int snd_soc_of_get_dlc(struct device_node *of_node,
1327 struct of_phandle_args *args,
1328 struct snd_soc_dai_link_component *dlc,
1330 int snd_soc_get_dai_id(struct device_node *ep);
1331 int snd_soc_get_dai_name(const struct of_phandle_args *args,
1332 const char **dai_name);
1333 int snd_soc_of_get_dai_name(struct device_node *of_node,
1334 const char **dai_name, int index);
1335 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1336 struct device_node *of_node,
1337 struct snd_soc_dai_link *dai_link);
1338 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link);
1339 int snd_soc_of_get_dai_link_cpus(struct device *dev,
1340 struct device_node *of_node,
1341 struct snd_soc_dai_link *dai_link);
1342 void snd_soc_of_put_dai_link_cpus(struct snd_soc_dai_link *dai_link);
1344 int snd_soc_add_pcm_runtimes(struct snd_soc_card *card,
1345 struct snd_soc_dai_link *dai_link,
1347 void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
1348 struct snd_soc_pcm_runtime *rtd);
1350 void snd_soc_dlc_use_cpu_as_platform(struct snd_soc_dai_link_component *platforms,
1351 struct snd_soc_dai_link_component *cpus);
1352 struct of_phandle_args *snd_soc_copy_dai_args(struct device *dev,
1353 struct of_phandle_args *args);
1354 struct snd_soc_dai *snd_soc_get_dai_via_args(struct of_phandle_args *dai_args);
1355 struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
1356 struct snd_soc_dai_driver *dai_drv,
1357 bool legacy_dai_naming);
1358 struct snd_soc_dai *devm_snd_soc_register_dai(struct device *dev,
1359 struct snd_soc_component *component,
1360 struct snd_soc_dai_driver *dai_drv,
1361 bool legacy_dai_naming);
1362 void snd_soc_unregister_dai(struct snd_soc_dai *dai);
1364 struct snd_soc_dai *snd_soc_find_dai(
1365 const struct snd_soc_dai_link_component *dlc);
1366 struct snd_soc_dai *snd_soc_find_dai_with_mutex(
1367 const struct snd_soc_dai_link_component *dlc);
1369 #include <sound/soc-dai.h>
1372 int snd_soc_fixup_dai_links_platform_name(struct snd_soc_card *card,
1373 const char *platform_name)
1375 struct snd_soc_dai_link *dai_link;
1379 if (!platform_name) /* nothing to do */
1382 /* set platform name for each dailink */
1383 for_each_card_prelinks(card, i, dai_link) {
1384 /* only single platform is supported for now */
1385 if (dai_link->num_platforms != 1)
1388 if (!dai_link->platforms)
1391 name = devm_kstrdup(card->dev, platform_name, GFP_KERNEL);
1395 /* only single platform is supported for now */
1396 dai_link->platforms->name = name;
1402 #ifdef CONFIG_DEBUG_FS
1403 extern struct dentry *snd_soc_debugfs_root;
1406 extern const struct dev_pm_ops snd_soc_pm_ops;
1409 * DAPM helper functions
1411 enum snd_soc_dapm_subclass {
1412 SND_SOC_DAPM_CLASS_ROOT = 0,
1413 SND_SOC_DAPM_CLASS_RUNTIME = 1,
1416 static inline void _snd_soc_dapm_mutex_lock_root_c(struct snd_soc_card *card)
1418 mutex_lock_nested(&card->dapm_mutex, SND_SOC_DAPM_CLASS_ROOT);
1421 static inline void _snd_soc_dapm_mutex_lock_c(struct snd_soc_card *card)
1423 mutex_lock_nested(&card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
1426 static inline void _snd_soc_dapm_mutex_unlock_c(struct snd_soc_card *card)
1428 mutex_unlock(&card->dapm_mutex);
1431 static inline void _snd_soc_dapm_mutex_assert_held_c(struct snd_soc_card *card)
1433 lockdep_assert_held(&card->dapm_mutex);
1436 static inline void _snd_soc_dapm_mutex_lock_root_d(struct snd_soc_dapm_context *dapm)
1438 _snd_soc_dapm_mutex_lock_root_c(dapm->card);
1441 static inline void _snd_soc_dapm_mutex_lock_d(struct snd_soc_dapm_context *dapm)
1443 _snd_soc_dapm_mutex_lock_c(dapm->card);
1446 static inline void _snd_soc_dapm_mutex_unlock_d(struct snd_soc_dapm_context *dapm)
1448 _snd_soc_dapm_mutex_unlock_c(dapm->card);
1451 static inline void _snd_soc_dapm_mutex_assert_held_d(struct snd_soc_dapm_context *dapm)
1453 _snd_soc_dapm_mutex_assert_held_c(dapm->card);
1456 #define snd_soc_dapm_mutex_lock_root(x) _Generic((x), \
1457 struct snd_soc_card * : _snd_soc_dapm_mutex_lock_root_c, \
1458 struct snd_soc_dapm_context * : _snd_soc_dapm_mutex_lock_root_d)(x)
1459 #define snd_soc_dapm_mutex_lock(x) _Generic((x), \
1460 struct snd_soc_card * : _snd_soc_dapm_mutex_lock_c, \
1461 struct snd_soc_dapm_context * : _snd_soc_dapm_mutex_lock_d)(x)
1462 #define snd_soc_dapm_mutex_unlock(x) _Generic((x), \
1463 struct snd_soc_card * : _snd_soc_dapm_mutex_unlock_c, \
1464 struct snd_soc_dapm_context * : _snd_soc_dapm_mutex_unlock_d)(x)
1465 #define snd_soc_dapm_mutex_assert_held(x) _Generic((x), \
1466 struct snd_soc_card * : _snd_soc_dapm_mutex_assert_held_c, \
1467 struct snd_soc_dapm_context * : _snd_soc_dapm_mutex_assert_held_d)(x)
1470 * PCM helper functions
1472 static inline void _snd_soc_dpcm_mutex_lock_c(struct snd_soc_card *card)
1474 mutex_lock_nested(&card->pcm_mutex, card->pcm_subclass);
1477 static inline void _snd_soc_dpcm_mutex_unlock_c(struct snd_soc_card *card)
1479 mutex_unlock(&card->pcm_mutex);
1482 static inline void _snd_soc_dpcm_mutex_assert_held_c(struct snd_soc_card *card)
1484 lockdep_assert_held(&card->pcm_mutex);
1487 static inline void _snd_soc_dpcm_mutex_lock_r(struct snd_soc_pcm_runtime *rtd)
1489 _snd_soc_dpcm_mutex_lock_c(rtd->card);
1492 static inline void _snd_soc_dpcm_mutex_unlock_r(struct snd_soc_pcm_runtime *rtd)
1494 _snd_soc_dpcm_mutex_unlock_c(rtd->card);
1497 static inline void _snd_soc_dpcm_mutex_assert_held_r(struct snd_soc_pcm_runtime *rtd)
1499 _snd_soc_dpcm_mutex_assert_held_c(rtd->card);
1502 #define snd_soc_dpcm_mutex_lock(x) _Generic((x), \
1503 struct snd_soc_card * : _snd_soc_dpcm_mutex_lock_c, \
1504 struct snd_soc_pcm_runtime * : _snd_soc_dpcm_mutex_lock_r)(x)
1506 #define snd_soc_dpcm_mutex_unlock(x) _Generic((x), \
1507 struct snd_soc_card * : _snd_soc_dpcm_mutex_unlock_c, \
1508 struct snd_soc_pcm_runtime * : _snd_soc_dpcm_mutex_unlock_r)(x)
1510 #define snd_soc_dpcm_mutex_assert_held(x) _Generic((x), \
1511 struct snd_soc_card * : _snd_soc_dpcm_mutex_assert_held_c, \
1512 struct snd_soc_pcm_runtime * : _snd_soc_dpcm_mutex_assert_held_r)(x)
1514 #include <sound/soc-component.h>
1515 #include <sound/soc-card.h>
1516 #include <sound/soc-jack.h>