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
14 #include <linux/platform_device.h>
15 #include <linux/types.h>
16 #include <linux/notifier.h>
17 #include <linux/workqueue.h>
18 #include <linux/interrupt.h>
19 #include <linux/kernel.h>
20 #include <linux/regmap.h>
21 #include <linux/log2.h>
22 #include <sound/core.h>
23 #include <sound/pcm.h>
24 #include <sound/compress_driver.h>
25 #include <sound/control.h>
26 #include <sound/ac97_codec.h>
29 * Convenience kcontrol builders
31 #define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert, xautodisable) \
32 ((unsigned long)&(struct soc_mixer_control) \
33 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
34 .rshift = shift_right, .max = xmax, .platform_max = xmax, \
35 .invert = xinvert, .autodisable = xautodisable})
36 #define SOC_DOUBLE_S_VALUE(xreg, shift_left, shift_right, xmin, xmax, xsign_bit, xinvert, xautodisable) \
37 ((unsigned long)&(struct soc_mixer_control) \
38 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
39 .rshift = shift_right, .min = xmin, .max = xmax, .platform_max = xmax, \
40 .sign_bit = xsign_bit, .invert = xinvert, .autodisable = xautodisable})
41 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \
42 SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable)
43 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
44 ((unsigned long)&(struct soc_mixer_control) \
45 {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
46 #define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
47 ((unsigned long)&(struct soc_mixer_control) \
48 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
49 .max = xmax, .platform_max = xmax, .invert = xinvert})
50 #define SOC_DOUBLE_R_S_VALUE(xlreg, xrreg, xshift, xmin, xmax, xsign_bit, xinvert) \
51 ((unsigned long)&(struct soc_mixer_control) \
52 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
53 .max = xmax, .min = xmin, .platform_max = xmax, .sign_bit = xsign_bit, \
55 #define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
56 ((unsigned long)&(struct soc_mixer_control) \
57 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
58 .min = xmin, .max = xmax, .platform_max = xmax, .invert = xinvert})
59 #define SOC_SINGLE(xname, reg, shift, max, invert) \
60 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
61 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
62 .put = snd_soc_put_volsw, \
63 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
64 #define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
65 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
66 .info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
67 .put = snd_soc_put_volsw_range, \
68 .private_value = (unsigned long)&(struct soc_mixer_control) \
69 {.reg = xreg, .rreg = xreg, .shift = xshift, \
70 .rshift = xshift, .min = xmin, .max = xmax, \
71 .platform_max = xmax, .invert = xinvert} }
72 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
73 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
74 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
75 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
76 .tlv.p = (tlv_array), \
77 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
78 .put = snd_soc_put_volsw, \
79 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
80 #define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
81 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
82 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
83 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
84 .tlv.p = (tlv_array),\
85 .info = snd_soc_info_volsw_sx, \
86 .get = snd_soc_get_volsw_sx,\
87 .put = snd_soc_put_volsw_sx, \
88 .private_value = (unsigned long)&(struct soc_mixer_control) \
89 {.reg = xreg, .rreg = xreg, \
90 .shift = xshift, .rshift = xshift, \
91 .max = xmax, .min = xmin} }
92 #define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
93 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
94 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
95 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
96 .tlv.p = (tlv_array), \
97 .info = snd_soc_info_volsw_range, \
98 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
99 .private_value = (unsigned long)&(struct soc_mixer_control) \
100 {.reg = xreg, .rreg = xreg, .shift = xshift, \
101 .rshift = xshift, .min = xmin, .max = xmax, \
102 .platform_max = xmax, .invert = xinvert} }
103 #define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
104 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
105 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
106 .put = snd_soc_put_volsw, \
107 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
109 #define SOC_DOUBLE_STS(xname, reg, shift_left, shift_right, max, invert) \
111 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
112 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
113 .access = SNDRV_CTL_ELEM_ACCESS_READ | \
114 SNDRV_CTL_ELEM_ACCESS_VOLATILE, \
115 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
117 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
118 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
119 .info = snd_soc_info_volsw, \
120 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
121 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
123 #define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
125 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
126 .info = snd_soc_info_volsw_range, \
127 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
128 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
129 xshift, xmin, xmax, xinvert) }
130 #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
131 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
132 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
133 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
134 .tlv.p = (tlv_array), \
135 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
136 .put = snd_soc_put_volsw, \
137 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
139 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
140 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
141 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
142 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
143 .tlv.p = (tlv_array), \
144 .info = snd_soc_info_volsw, \
145 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
146 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
148 #define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
149 xmax, xinvert, tlv_array) \
150 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
151 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
152 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
153 .tlv.p = (tlv_array), \
154 .info = snd_soc_info_volsw_range, \
155 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
156 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
157 xshift, xmin, xmax, xinvert) }
158 #define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
159 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
160 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
161 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
162 .tlv.p = (tlv_array), \
163 .info = snd_soc_info_volsw_sx, \
164 .get = snd_soc_get_volsw_sx, \
165 .put = snd_soc_put_volsw_sx, \
166 .private_value = (unsigned long)&(struct soc_mixer_control) \
167 {.reg = xreg, .rreg = xrreg, \
168 .shift = xshift, .rshift = xshift, \
169 .max = xmax, .min = xmin} }
170 #define SOC_DOUBLE_R_S_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
171 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
172 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
173 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
174 .tlv.p = (tlv_array), \
175 .info = snd_soc_info_volsw, \
176 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
177 .private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
178 xmin, xmax, xsign_bit, xinvert) }
179 #define SOC_SINGLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
180 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
181 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
182 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
183 .tlv.p = (tlv_array), \
184 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
185 .put = snd_soc_put_volsw, \
186 .private_value = (unsigned long)&(struct soc_mixer_control) \
187 {.reg = xreg, .rreg = xreg, \
188 .min = xmin, .max = xmax, .platform_max = xmax, \
190 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
191 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
192 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
193 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
194 .tlv.p = (tlv_array), \
195 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
196 .put = snd_soc_put_volsw, \
197 .private_value = SOC_DOUBLE_S_VALUE(xreg, 0, 8, xmin, xmax, 7, 0, 0) }
198 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \
199 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
200 .items = xitems, .texts = xtexts, \
201 .mask = xitems ? roundup_pow_of_two(xitems) - 1 : 0}
202 #define SOC_ENUM_SINGLE(xreg, xshift, xitems, xtexts) \
203 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xitems, xtexts)
204 #define SOC_ENUM_SINGLE_EXT(xitems, xtexts) \
205 { .items = xitems, .texts = xtexts }
206 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xitems, xtexts, xvalues) \
207 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
208 .mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues}
209 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
210 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xitems, xtexts, xvalues)
211 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
212 { .reg = xreg, .shift_l = xshift, .shift_r = xshift, \
213 .mask = xmask, .items = xitems, .texts = xtexts, \
214 .values = xvalues, .autodisable = 1}
215 #define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \
216 SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
217 #define SOC_ENUM(xname, xenum) \
218 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
219 .info = snd_soc_info_enum_double, \
220 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
221 .private_value = (unsigned long)&xenum }
222 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
223 xhandler_get, xhandler_put) \
224 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
225 .info = snd_soc_info_volsw, \
226 .get = xhandler_get, .put = xhandler_put, \
227 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
228 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
229 xhandler_get, xhandler_put) \
230 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
231 .info = snd_soc_info_volsw, \
232 .get = xhandler_get, .put = xhandler_put, \
234 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
235 #define SOC_DOUBLE_R_EXT(xname, reg_left, reg_right, xshift, xmax, xinvert,\
236 xhandler_get, xhandler_put) \
237 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
238 .info = snd_soc_info_volsw, \
239 .get = xhandler_get, .put = xhandler_put, \
240 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
242 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
243 xhandler_get, xhandler_put, tlv_array) \
244 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
245 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
246 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
247 .tlv.p = (tlv_array), \
248 .info = snd_soc_info_volsw, \
249 .get = xhandler_get, .put = xhandler_put, \
250 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
251 #define SOC_SINGLE_RANGE_EXT_TLV(xname, xreg, xshift, xmin, xmax, xinvert, \
252 xhandler_get, xhandler_put, tlv_array) \
253 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
254 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
255 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
256 .tlv.p = (tlv_array), \
257 .info = snd_soc_info_volsw_range, \
258 .get = xhandler_get, .put = xhandler_put, \
259 .private_value = (unsigned long)&(struct soc_mixer_control) \
260 {.reg = xreg, .rreg = xreg, .shift = xshift, \
261 .rshift = xshift, .min = xmin, .max = xmax, \
262 .platform_max = xmax, .invert = xinvert} }
263 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
264 xhandler_get, xhandler_put, tlv_array) \
265 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
266 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
267 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
268 .tlv.p = (tlv_array), \
269 .info = snd_soc_info_volsw, \
270 .get = xhandler_get, .put = xhandler_put, \
271 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
273 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
274 xhandler_get, xhandler_put, tlv_array) \
275 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
276 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
277 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
278 .tlv.p = (tlv_array), \
279 .info = snd_soc_info_volsw, \
280 .get = xhandler_get, .put = xhandler_put, \
281 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
283 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
284 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
285 .info = snd_soc_info_bool_ext, \
286 .get = xhandler_get, .put = xhandler_put, \
287 .private_value = xdata }
288 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
289 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
290 .info = snd_soc_info_enum_double, \
291 .get = xhandler_get, .put = xhandler_put, \
292 .private_value = (unsigned long)&xenum }
293 #define SOC_VALUE_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
294 SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put)
296 #define SND_SOC_BYTES(xname, xbase, xregs) \
297 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
298 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
299 .put = snd_soc_bytes_put, .private_value = \
300 ((unsigned long)&(struct soc_bytes) \
301 {.base = xbase, .num_regs = xregs }) }
302 #define SND_SOC_BYTES_E(xname, xbase, xregs, xhandler_get, xhandler_put) \
303 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
304 .info = snd_soc_bytes_info, .get = xhandler_get, \
305 .put = xhandler_put, .private_value = \
306 ((unsigned long)&(struct soc_bytes) \
307 {.base = xbase, .num_regs = xregs }) }
309 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask) \
310 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
311 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
312 .put = snd_soc_bytes_put, .private_value = \
313 ((unsigned long)&(struct soc_bytes) \
314 {.base = xbase, .num_regs = xregs, \
318 * SND_SOC_BYTES_EXT is deprecated, please USE SND_SOC_BYTES_TLV instead
320 #define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \
321 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
322 .info = snd_soc_bytes_info_ext, \
323 .get = xhandler_get, .put = xhandler_put, \
324 .private_value = (unsigned long)&(struct soc_bytes_ext) \
326 #define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \
327 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
328 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \
329 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
330 .tlv.c = (snd_soc_bytes_tlv_callback), \
331 .info = snd_soc_bytes_info_ext, \
332 .private_value = (unsigned long)&(struct soc_bytes_ext) \
333 {.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
334 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
335 xmin, xmax, xinvert) \
336 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
337 .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
338 .put = snd_soc_put_xr_sx, \
339 .private_value = (unsigned long)&(struct soc_mreg_control) \
340 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
341 .invert = xinvert, .min = xmin, .max = xmax} }
343 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
344 SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
345 snd_soc_get_strobe, snd_soc_put_strobe)
348 * Simplified versions of above macros, declaring a struct and calculating
349 * ARRAY_SIZE internally
351 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
352 const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
353 ARRAY_SIZE(xtexts), xtexts)
354 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
355 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
356 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
357 const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
358 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
359 const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
360 ARRAY_SIZE(xtexts), xtexts, xvalues)
361 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
362 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
364 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
365 const struct soc_enum name = SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, \
366 xshift, xmask, ARRAY_SIZE(xtexts), xtexts, xvalues)
368 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
369 const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
374 * @ON: Bias is fully on for audio playback and capture operations.
375 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
376 * stream start and stop operations.
377 * @STANDBY: Low power standby state when no playback/capture operations are
378 * in progress. NOTE: The transition time between STANDBY and ON
379 * should be as fast as possible and no longer than 10ms.
380 * @OFF: Power Off. No restrictions on transition times.
382 enum snd_soc_bias_level {
383 SND_SOC_BIAS_OFF = 0,
384 SND_SOC_BIAS_STANDBY = 1,
385 SND_SOC_BIAS_PREPARE = 2,
392 struct snd_soc_pcm_stream;
394 struct snd_soc_pcm_runtime;
396 struct snd_soc_dai_driver;
397 struct snd_soc_dai_link;
398 struct snd_soc_component;
399 struct snd_soc_component_driver;
402 struct snd_soc_jack_zone;
403 struct snd_soc_jack_pin;
404 #include <sound/soc-dapm.h>
405 #include <sound/soc-dpcm.h>
406 #include <sound/soc-topology.h>
408 struct snd_soc_jack_gpio;
410 typedef int (*hw_write_t)(void *,const char* ,int);
412 enum snd_soc_pcm_subclass {
413 SND_SOC_PCM_CLASS_PCM = 0,
414 SND_SOC_PCM_CLASS_BE = 1,
417 int snd_soc_register_card(struct snd_soc_card *card);
418 int snd_soc_unregister_card(struct snd_soc_card *card);
419 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
420 #ifdef CONFIG_PM_SLEEP
421 int snd_soc_suspend(struct device *dev);
422 int snd_soc_resume(struct device *dev);
424 static inline int snd_soc_suspend(struct device *dev)
429 static inline int snd_soc_resume(struct device *dev)
434 int snd_soc_poweroff(struct device *dev);
435 int snd_soc_add_component(struct device *dev,
436 struct snd_soc_component *component,
437 const struct snd_soc_component_driver *component_driver,
438 struct snd_soc_dai_driver *dai_drv,
440 int snd_soc_register_component(struct device *dev,
441 const struct snd_soc_component_driver *component_driver,
442 struct snd_soc_dai_driver *dai_drv, int num_dai);
443 int devm_snd_soc_register_component(struct device *dev,
444 const struct snd_soc_component_driver *component_driver,
445 struct snd_soc_dai_driver *dai_drv, int num_dai);
446 void snd_soc_unregister_component(struct device *dev);
447 void snd_soc_unregister_component_by_driver(struct device *dev,
448 const struct snd_soc_component_driver *component_driver);
449 struct snd_soc_component *snd_soc_lookup_component_nolocked(struct device *dev,
450 const char *driver_name);
451 struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
452 const char *driver_name);
454 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
455 #ifdef CONFIG_SND_SOC_COMPRESS
456 int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
458 static inline int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num)
464 void snd_soc_disconnect_sync(struct device *dev);
466 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
467 struct snd_soc_dai_link *dai_link);
469 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
471 void snd_soc_runtime_action(struct snd_soc_pcm_runtime *rtd,
472 int stream, int action);
473 static inline void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd,
476 snd_soc_runtime_action(rtd, stream, 1);
478 static inline void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd,
481 snd_soc_runtime_action(rtd, stream, -1);
484 int snd_soc_runtime_calc_hw(struct snd_soc_pcm_runtime *rtd,
485 struct snd_pcm_hardware *hw, int stream);
487 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
488 unsigned int dai_fmt);
491 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour);
493 static inline int snd_soc_set_dmi_name(struct snd_soc_card *card,
500 /* Utility functions to get clock rates from various things */
501 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
502 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
503 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
504 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
506 /* set runtime hw params */
507 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
508 const struct snd_pcm_hardware *hw);
511 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
512 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
513 struct snd_soc_jack_pin *pins);
514 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
515 struct notifier_block *nb);
516 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
517 struct notifier_block *nb);
518 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
519 struct snd_soc_jack_zone *zones);
520 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
521 #ifdef CONFIG_GPIOLIB
522 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
523 struct snd_soc_jack_gpio *gpios);
524 int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
525 struct snd_soc_jack *jack,
526 int count, struct snd_soc_jack_gpio *gpios);
527 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
528 struct snd_soc_jack_gpio *gpios);
530 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
531 struct snd_soc_jack_gpio *gpios)
536 static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
537 struct snd_soc_jack *jack,
539 struct snd_soc_jack_gpio *gpios)
544 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
545 struct snd_soc_jack_gpio *gpios)
550 struct snd_ac97 *snd_soc_alloc_ac97_component(struct snd_soc_component *component);
551 struct snd_ac97 *snd_soc_new_ac97_component(struct snd_soc_component *component,
552 unsigned int id, unsigned int id_mask);
553 void snd_soc_free_ac97_component(struct snd_ac97 *ac97);
555 #ifdef CONFIG_SND_SOC_AC97_BUS
556 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
557 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
558 struct platform_device *pdev);
560 extern struct snd_ac97_bus_ops *soc_ac97_ops;
562 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
563 struct platform_device *pdev)
568 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
577 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
578 void *data, const char *long_name,
580 int snd_soc_add_component_controls(struct snd_soc_component *component,
581 const struct snd_kcontrol_new *controls, unsigned int num_controls);
582 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
583 const struct snd_kcontrol_new *controls, int num_controls);
584 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
585 const struct snd_kcontrol_new *controls, int num_controls);
586 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
587 struct snd_ctl_elem_info *uinfo);
588 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
589 struct snd_ctl_elem_value *ucontrol);
590 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
591 struct snd_ctl_elem_value *ucontrol);
592 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
593 struct snd_ctl_elem_info *uinfo);
594 int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol,
595 struct snd_ctl_elem_info *uinfo);
596 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
597 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
598 struct snd_ctl_elem_value *ucontrol);
599 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
600 struct snd_ctl_elem_value *ucontrol);
601 #define snd_soc_get_volsw_2r snd_soc_get_volsw
602 #define snd_soc_put_volsw_2r snd_soc_put_volsw
603 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
604 struct snd_ctl_elem_value *ucontrol);
605 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
606 struct snd_ctl_elem_value *ucontrol);
607 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
608 struct snd_ctl_elem_info *uinfo);
609 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
610 struct snd_ctl_elem_value *ucontrol);
611 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
612 struct snd_ctl_elem_value *ucontrol);
613 int snd_soc_limit_volume(struct snd_soc_card *card,
614 const char *name, int max);
615 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
616 struct snd_ctl_elem_info *uinfo);
617 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
618 struct snd_ctl_elem_value *ucontrol);
619 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
620 struct snd_ctl_elem_value *ucontrol);
621 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
622 struct snd_ctl_elem_info *ucontrol);
623 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
624 unsigned int size, unsigned int __user *tlv);
625 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
626 struct snd_ctl_elem_info *uinfo);
627 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
628 struct snd_ctl_elem_value *ucontrol);
629 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
630 struct snd_ctl_elem_value *ucontrol);
631 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
632 struct snd_ctl_elem_value *ucontrol);
633 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
634 struct snd_ctl_elem_value *ucontrol);
637 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
639 * @pin: name of the pin to update
640 * @mask: bits to check for in reported jack status
641 * @invert: if non-zero then pin is enabled when status is not reported
642 * @list: internal list entry
644 struct snd_soc_jack_pin {
645 struct list_head list;
652 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
654 * @min_mv: start voltage in mv
655 * @max_mv: end voltage in mv
656 * @jack_type: type of jack that is expected for this voltage
657 * @debounce_time: debounce_time for jack, codec driver should wait for this
658 * duration before reading the adc for voltages
659 * @list: internal list entry
661 struct snd_soc_jack_zone {
664 unsigned int jack_type;
665 unsigned int debounce_time;
666 struct list_head list;
670 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
672 * @gpio: legacy gpio number
673 * @idx: gpio descriptor index within the function of the GPIO
675 * @gpiod_dev: GPIO consumer device
676 * @name: gpio name. Also as connection ID for the GPIO consumer
677 * device function name lookup
678 * @report: value to report when jack detected
679 * @invert: report presence in low state
680 * @debounce_time: debounce time in ms
681 * @wake: enable as wake source
682 * @jack_status_check: callback function which overrides the detection
683 * to provide more complex checks (eg, reading an
686 struct snd_soc_jack_gpio {
689 struct device *gpiod_dev;
697 struct snd_soc_jack *jack;
698 struct delayed_work work;
699 struct notifier_block pm_notifier;
700 struct gpio_desc *desc;
704 int (*jack_status_check)(void *data);
707 struct snd_soc_jack {
709 struct snd_jack *jack;
710 struct snd_soc_card *card;
711 struct list_head pins;
713 struct blocking_notifier_head notifier;
714 struct list_head jack_zones;
717 /* SoC PCM stream information */
718 struct snd_soc_pcm_stream {
719 const char *stream_name;
720 u64 formats; /* SNDRV_PCM_FMTBIT_* */
721 unsigned int rates; /* SNDRV_PCM_RATE_* */
722 unsigned int rate_min; /* min rate */
723 unsigned int rate_max; /* max rate */
724 unsigned int channels_min; /* min channels */
725 unsigned int channels_max; /* max channels */
726 unsigned int sig_bits; /* number of bits of content */
731 int (*startup)(struct snd_pcm_substream *);
732 void (*shutdown)(struct snd_pcm_substream *);
733 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
734 int (*hw_free)(struct snd_pcm_substream *);
735 int (*prepare)(struct snd_pcm_substream *);
736 int (*trigger)(struct snd_pcm_substream *, int);
739 struct snd_soc_compr_ops {
740 int (*startup)(struct snd_compr_stream *);
741 void (*shutdown)(struct snd_compr_stream *);
742 int (*set_params)(struct snd_compr_stream *);
743 int (*trigger)(struct snd_compr_stream *);
746 struct snd_soc_component*
747 snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
748 const char *driver_name);
750 struct snd_soc_dai_link_component {
752 struct device_node *of_node;
753 const char *dai_name;
756 struct snd_soc_dai_link {
757 /* config - must be set by machine driver */
758 const char *name; /* Codec name */
759 const char *stream_name; /* Stream name */
762 * You MAY specify the link's CPU-side device, either by device name,
763 * or by DT/OF node, but not both. If this information is omitted,
764 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
765 * must be globally unique. These fields are currently typically used
766 * only for codec to codec links, or systems using device tree.
769 * You MAY specify the DAI name of the CPU DAI. If this information is
770 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
771 * only, which only works well when that device exposes a single DAI.
773 struct snd_soc_dai_link_component *cpus;
774 unsigned int num_cpus;
777 * You MUST specify the link's codec, either by device name, or by
778 * DT/OF node, but not both.
780 /* You MUST specify the DAI name within the codec */
781 struct snd_soc_dai_link_component *codecs;
782 unsigned int num_codecs;
785 * You MAY specify the link's platform/PCM/DMA driver, either by
786 * device name, or by DT/OF node, but not both. Some forms of link
787 * do not need a platform. In such case, platforms are not mandatory.
789 struct snd_soc_dai_link_component *platforms;
790 unsigned int num_platforms;
792 int id; /* optional ID for machine driver link identification */
794 const struct snd_soc_pcm_stream *params;
795 unsigned int num_params;
797 struct snd_soc_dapm_widget *playback_widget;
798 struct snd_soc_dapm_widget *capture_widget;
800 unsigned int dai_fmt; /* format to set on init */
802 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
804 /* codec/machine specific init - e.g. add machine controls */
805 int (*init)(struct snd_soc_pcm_runtime *rtd);
807 /* optional hw_params re-writing for BE and FE sync */
808 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
809 struct snd_pcm_hw_params *params);
811 /* machine stream operations */
812 const struct snd_soc_ops *ops;
813 const struct snd_soc_compr_ops *compr_ops;
815 /* Mark this pcm with non atomic ops */
816 unsigned int nonatomic:1;
818 /* For unidirectional dai links */
819 unsigned int playback_only:1;
820 unsigned int capture_only:1;
822 /* Keep DAI active over suspend */
823 unsigned int ignore_suspend:1;
825 /* Symmetry requirements */
826 unsigned int symmetric_rates:1;
827 unsigned int symmetric_channels:1;
828 unsigned int symmetric_samplebits:1;
830 /* Do not create a PCM for this DAI link (Backend link) */
831 unsigned int no_pcm:1;
833 /* This DAI link can route to other DAI links at runtime (Frontend)*/
834 unsigned int dynamic:1;
836 /* DPCM capture and Playback support */
837 unsigned int dpcm_capture:1;
838 unsigned int dpcm_playback:1;
840 /* DPCM used FE & BE merged format */
841 unsigned int dpcm_merged_format:1;
842 /* DPCM used FE & BE merged channel */
843 unsigned int dpcm_merged_chan:1;
844 /* DPCM used FE & BE merged rate */
845 unsigned int dpcm_merged_rate:1;
847 /* pmdown_time is ignored at stop */
848 unsigned int ignore_pmdown_time:1;
850 /* Do not create a PCM for this DAI link (Backend link) */
851 unsigned int ignore:1;
853 #ifdef CONFIG_SND_SOC_TOPOLOGY
854 struct snd_soc_dobj dobj; /* For topology */
857 #define for_each_link_codecs(link, i, codec) \
859 ((i) < link->num_codecs) && ((codec) = &link->codecs[i]); \
862 #define for_each_link_platforms(link, i, platform) \
864 ((i) < link->num_platforms) && \
865 ((platform) = &link->platforms[i]); \
868 #define for_each_link_cpus(link, i, cpu) \
870 ((i) < link->num_cpus) && ((cpu) = &link->cpus[i]); \
874 * Sample 1 : Single CPU/Codec/Platform
876 * SND_SOC_DAILINK_DEFS(test,
877 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai")),
878 * DAILINK_COMP_ARRAY(COMP_CODEC("codec", "codec_dai")),
879 * DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
881 * struct snd_soc_dai_link link = {
883 * SND_SOC_DAILINK_REG(test),
886 * Sample 2 : Multi CPU/Codec, no Platform
888 * SND_SOC_DAILINK_DEFS(test,
889 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
890 * COMP_CPU("cpu_dai2")),
891 * DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
892 * COMP_CODEC("codec2", "codec_dai2")));
894 * struct snd_soc_dai_link link = {
896 * SND_SOC_DAILINK_REG(test),
899 * Sample 3 : Define each CPU/Codec/Platform manually
901 * SND_SOC_DAILINK_DEF(test_cpu,
902 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
903 * COMP_CPU("cpu_dai2")));
904 * SND_SOC_DAILINK_DEF(test_codec,
905 * DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
906 * COMP_CODEC("codec2", "codec_dai2")));
907 * SND_SOC_DAILINK_DEF(test_platform,
908 * DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
910 * struct snd_soc_dai_link link = {
912 * SND_SOC_DAILINK_REG(test_cpu,
917 * Sample 4 : Sample3 without platform
919 * struct snd_soc_dai_link link = {
921 * SND_SOC_DAILINK_REG(test_cpu,
926 #define SND_SOC_DAILINK_REG1(name) SND_SOC_DAILINK_REG3(name##_cpus, name##_codecs, name##_platforms)
927 #define SND_SOC_DAILINK_REG2(cpu, codec) SND_SOC_DAILINK_REG3(cpu, codec, null_dailink_component)
928 #define SND_SOC_DAILINK_REG3(cpu, codec, platform) \
930 .num_cpus = ARRAY_SIZE(cpu), \
932 .num_codecs = ARRAY_SIZE(codec), \
933 .platforms = platform, \
934 .num_platforms = ARRAY_SIZE(platform)
936 #define SND_SOC_DAILINK_REGx(_1, _2, _3, func, ...) func
937 #define SND_SOC_DAILINK_REG(...) \
938 SND_SOC_DAILINK_REGx(__VA_ARGS__, \
939 SND_SOC_DAILINK_REG3, \
940 SND_SOC_DAILINK_REG2, \
941 SND_SOC_DAILINK_REG1)(__VA_ARGS__)
943 #define SND_SOC_DAILINK_DEF(name, def...) \
944 static struct snd_soc_dai_link_component name[] = { def }
946 #define SND_SOC_DAILINK_DEFS(name, cpu, codec, platform...) \
947 SND_SOC_DAILINK_DEF(name##_cpus, cpu); \
948 SND_SOC_DAILINK_DEF(name##_codecs, codec); \
949 SND_SOC_DAILINK_DEF(name##_platforms, platform)
951 #define DAILINK_COMP_ARRAY(param...) param
952 #define COMP_EMPTY() { }
953 #define COMP_CPU(_dai) { .dai_name = _dai, }
954 #define COMP_CODEC(_name, _dai) { .name = _name, .dai_name = _dai, }
955 #define COMP_PLATFORM(_name) { .name = _name }
956 #define COMP_AUX(_name) { .name = _name }
957 #define COMP_CODEC_CONF(_name) { .name = _name }
958 #define COMP_DUMMY() { .name = "snd-soc-dummy", .dai_name = "snd-soc-dummy-dai", }
960 extern struct snd_soc_dai_link_component null_dailink_component[0];
963 struct snd_soc_codec_conf {
965 * specify device either by device name, or by
966 * DT/OF node, but not both.
968 struct snd_soc_dai_link_component dlc;
971 * optional map of kcontrol, widget and path name prefixes that are
972 * associated per device
974 const char *name_prefix;
977 struct snd_soc_aux_dev {
979 * specify multi-codec either by device name, or by
980 * DT/OF node, but not both.
982 struct snd_soc_dai_link_component dlc;
984 /* codec/machine specific init - e.g. add machine controls */
985 int (*init)(struct snd_soc_component *component);
989 struct snd_soc_card {
991 const char *long_name;
992 const char *driver_name;
993 const char *components;
995 char dmi_longname[80];
996 #endif /* CONFIG_DMI */
997 char topology_shortname[32];
1000 struct snd_card *snd_card;
1001 struct module *owner;
1004 struct mutex dapm_mutex;
1006 /* Mutex for PCM operations */
1007 struct mutex pcm_mutex;
1008 enum snd_soc_pcm_subclass pcm_subclass;
1010 spinlock_t dpcm_lock;
1012 int (*probe)(struct snd_soc_card *card);
1013 int (*late_probe)(struct snd_soc_card *card);
1014 int (*remove)(struct snd_soc_card *card);
1016 /* the pre and post PM functions are used to do any PM work before and
1017 * after the codec and DAI's do any PM work. */
1018 int (*suspend_pre)(struct snd_soc_card *card);
1019 int (*suspend_post)(struct snd_soc_card *card);
1020 int (*resume_pre)(struct snd_soc_card *card);
1021 int (*resume_post)(struct snd_soc_card *card);
1024 int (*set_bias_level)(struct snd_soc_card *,
1025 struct snd_soc_dapm_context *dapm,
1026 enum snd_soc_bias_level level);
1027 int (*set_bias_level_post)(struct snd_soc_card *,
1028 struct snd_soc_dapm_context *dapm,
1029 enum snd_soc_bias_level level);
1031 int (*add_dai_link)(struct snd_soc_card *,
1032 struct snd_soc_dai_link *link);
1033 void (*remove_dai_link)(struct snd_soc_card *,
1034 struct snd_soc_dai_link *link);
1038 /* CPU <--> Codec DAI links */
1039 struct snd_soc_dai_link *dai_link; /* predefined links only */
1040 int num_links; /* predefined links only */
1042 struct list_head rtd_list;
1045 /* optional codec specific configuration */
1046 struct snd_soc_codec_conf *codec_conf;
1050 * optional auxiliary devices such as amplifiers or codecs with DAI
1053 struct snd_soc_aux_dev *aux_dev;
1055 struct list_head aux_comp_list;
1057 const struct snd_kcontrol_new *controls;
1061 * Card-specific routes and widgets.
1062 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1064 const struct snd_soc_dapm_widget *dapm_widgets;
1065 int num_dapm_widgets;
1066 const struct snd_soc_dapm_route *dapm_routes;
1067 int num_dapm_routes;
1068 const struct snd_soc_dapm_widget *of_dapm_widgets;
1069 int num_of_dapm_widgets;
1070 const struct snd_soc_dapm_route *of_dapm_routes;
1071 int num_of_dapm_routes;
1073 /* lists of probed devices belonging to this card */
1074 struct list_head component_dev_list;
1075 struct list_head list;
1077 struct list_head widgets;
1078 struct list_head paths;
1079 struct list_head dapm_list;
1080 struct list_head dapm_dirty;
1082 /* attached dynamic objects */
1083 struct list_head dobj_list;
1085 /* Generic DAPM context for the card */
1086 struct snd_soc_dapm_context dapm;
1087 struct snd_soc_dapm_stats dapm_stats;
1088 struct snd_soc_dapm_update *update;
1090 #ifdef CONFIG_DEBUG_FS
1091 struct dentry *debugfs_card_root;
1093 #ifdef CONFIG_PM_SLEEP
1094 struct work_struct deferred_resume_work;
1099 unsigned int instantiated:1;
1100 unsigned int topology_shortname_created:1;
1101 unsigned int fully_routed:1;
1102 unsigned int disable_route_checks:1;
1103 unsigned int probed:1;
1107 #define for_each_card_prelinks(card, i, link) \
1109 ((i) < (card)->num_links) && ((link) = &(card)->dai_link[i]); \
1111 #define for_each_card_pre_auxs(card, i, aux) \
1113 ((i) < (card)->num_aux_devs) && ((aux) = &(card)->aux_dev[i]); \
1116 #define for_each_card_rtds(card, rtd) \
1117 list_for_each_entry(rtd, &(card)->rtd_list, list)
1118 #define for_each_card_rtds_safe(card, rtd, _rtd) \
1119 list_for_each_entry_safe(rtd, _rtd, &(card)->rtd_list, list)
1121 #define for_each_card_auxs(card, component) \
1122 list_for_each_entry(component, &card->aux_comp_list, card_aux_list)
1123 #define for_each_card_auxs_safe(card, component, _comp) \
1124 list_for_each_entry_safe(component, _comp, \
1125 &card->aux_comp_list, card_aux_list)
1127 #define for_each_card_components(card, component) \
1128 list_for_each_entry(component, &(card)->component_dev_list, card_list)
1130 #define for_each_card_dapms(card, dapm) \
1131 list_for_each_entry(dapm, &card->dapm_list, list)
1133 #define for_each_card_widgets(card, w)\
1134 list_for_each_entry(w, &card->widgets, list)
1135 #define for_each_card_widgets_safe(card, w, _w) \
1136 list_for_each_entry_safe(w, _w, &card->widgets, list)
1138 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1139 struct snd_soc_pcm_runtime {
1141 struct snd_soc_card *card;
1142 struct snd_soc_dai_link *dai_link;
1143 struct snd_pcm_ops ops;
1145 unsigned int params_select; /* currently selected param for dai link */
1147 /* Dynamic PCM BE runtime data */
1148 struct snd_soc_dpcm_runtime dpcm[2];
1152 /* runtime devices */
1153 struct snd_pcm *pcm;
1154 struct snd_compr *compr;
1157 * dais = cpu_dai + codec_dai
1159 * soc_new_pcm_runtime()
1161 * asoc_rtd_to_codec()
1163 struct snd_soc_dai **dais;
1164 unsigned int num_codecs;
1165 unsigned int num_cpus;
1167 struct delayed_work delayed_work;
1168 void (*close_delayed_work_func)(struct snd_soc_pcm_runtime *rtd);
1169 #ifdef CONFIG_DEBUG_FS
1170 struct dentry *debugfs_dpcm_root;
1173 unsigned int num; /* 0-based and monotonic increasing */
1174 struct list_head list; /* rtd list of the soc card */
1177 unsigned int pop_wait:1;
1178 unsigned int fe_compr:1; /* for Dynamic PCM */
1181 struct snd_soc_component *components[]; /* CPU/Codec/Platform */
1183 /* see soc_new_pcm_runtime() */
1184 #define asoc_rtd_to_cpu(rtd, n) (rtd)->dais[n]
1185 #define asoc_rtd_to_codec(rtd, n) (rtd)->dais[n + (rtd)->num_cpus]
1187 #define for_each_rtd_components(rtd, i, component) \
1188 for ((i) = 0, component = NULL; \
1189 ((i) < rtd->num_components) && ((component) = rtd->components[i]);\
1191 #define for_each_rtd_cpu_dais(rtd, i, dai) \
1193 ((i) < rtd->num_cpus) && ((dai) = asoc_rtd_to_cpu(rtd, i)); \
1195 #define for_each_rtd_cpu_dais_rollback(rtd, i, dai) \
1196 for (; (--(i) >= 0) && ((dai) = asoc_rtd_to_cpu(rtd, i));)
1197 #define for_each_rtd_codec_dais(rtd, i, dai) \
1199 ((i) < rtd->num_codecs) && ((dai) = asoc_rtd_to_codec(rtd, i)); \
1201 #define for_each_rtd_codec_dais_rollback(rtd, i, dai) \
1202 for (; (--(i) >= 0) && ((dai) = asoc_rtd_to_codec(rtd, i));)
1203 #define for_each_rtd_dais(rtd, i, dai) \
1205 ((i) < (rtd)->num_cpus + (rtd)->num_codecs) && \
1206 ((dai) = (rtd)->dais[i]); \
1209 void snd_soc_close_delayed_work(struct snd_soc_pcm_runtime *rtd);
1212 struct soc_mixer_control {
1213 int min, max, platform_max;
1215 unsigned int shift, rshift;
1216 unsigned int sign_bit;
1217 unsigned int invert:1;
1218 unsigned int autodisable:1;
1219 #ifdef CONFIG_SND_SOC_TOPOLOGY
1220 struct snd_soc_dobj dobj;
1230 struct soc_bytes_ext {
1232 #ifdef CONFIG_SND_SOC_TOPOLOGY
1233 struct snd_soc_dobj dobj;
1235 /* used for TLV byte control */
1236 int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1238 int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1242 /* multi register control */
1243 struct soc_mreg_control {
1245 unsigned int regbase, regcount, nbits, invert;
1248 /* enumerated kcontrol */
1251 unsigned char shift_l;
1252 unsigned char shift_r;
1255 const char * const *texts;
1256 const unsigned int *values;
1257 unsigned int autodisable:1;
1258 #ifdef CONFIG_SND_SOC_TOPOLOGY
1259 struct snd_soc_dobj dobj;
1263 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1265 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1268 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1269 * mc->reg != mc->rreg means that the control is
1270 * stereo (bits in one register or in two registers)
1275 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1283 for (i = 0; i < e->items; i++)
1284 if (val == e->values[i])
1290 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1296 return e->values[item];
1300 * snd_soc_kcontrol_component() - Returns the component that registered the
1302 * @kcontrol: The control for which to get the component
1304 * Note: This function will work correctly if the control has been registered
1305 * for a component. With snd_soc_add_codec_controls() or via table based
1306 * setup for either a CODEC or component driver. Otherwise the behavior is
1309 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1310 struct snd_kcontrol *kcontrol)
1312 return snd_kcontrol_chip(kcontrol);
1315 int snd_soc_util_init(void);
1316 void snd_soc_util_exit(void);
1318 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1319 const char *propname);
1320 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1321 const char *propname);
1322 int snd_soc_of_get_slot_mask(struct device_node *np,
1323 const char *prop_name,
1324 unsigned int *mask);
1325 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1326 unsigned int *tx_mask,
1327 unsigned int *rx_mask,
1328 unsigned int *slots,
1329 unsigned int *slot_width);
1330 void snd_soc_of_parse_node_prefix(struct device_node *np,
1331 struct snd_soc_codec_conf *codec_conf,
1332 struct device_node *of_node,
1333 const char *propname);
1335 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1336 struct snd_soc_codec_conf *codec_conf,
1337 struct device_node *of_node,
1338 const char *propname)
1340 snd_soc_of_parse_node_prefix(card->dev->of_node,
1341 codec_conf, of_node, propname);
1344 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1345 const char *propname);
1346 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1348 struct device_node **bitclkmaster,
1349 struct device_node **framemaster);
1350 int snd_soc_get_dai_id(struct device_node *ep);
1351 int snd_soc_get_dai_name(struct of_phandle_args *args,
1352 const char **dai_name);
1353 int snd_soc_of_get_dai_name(struct device_node *of_node,
1354 const char **dai_name);
1355 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1356 struct device_node *of_node,
1357 struct snd_soc_dai_link *dai_link);
1358 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link);
1360 int snd_soc_add_pcm_runtime(struct snd_soc_card *card,
1361 struct snd_soc_dai_link *dai_link);
1362 void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
1363 struct snd_soc_pcm_runtime *rtd);
1365 struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
1366 struct snd_soc_dai_driver *dai_drv,
1367 bool legacy_dai_naming);
1368 struct snd_soc_dai *devm_snd_soc_register_dai(struct device *dev,
1369 struct snd_soc_component *component,
1370 struct snd_soc_dai_driver *dai_drv,
1371 bool legacy_dai_naming);
1372 void snd_soc_unregister_dai(struct snd_soc_dai *dai);
1374 struct snd_soc_dai *snd_soc_find_dai(
1375 const struct snd_soc_dai_link_component *dlc);
1377 #include <sound/soc-dai.h>
1380 int snd_soc_fixup_dai_links_platform_name(struct snd_soc_card *card,
1381 const char *platform_name)
1383 struct snd_soc_dai_link *dai_link;
1387 if (!platform_name) /* nothing to do */
1390 /* set platform name for each dailink */
1391 for_each_card_prelinks(card, i, dai_link) {
1392 name = devm_kstrdup(card->dev, platform_name, GFP_KERNEL);
1396 if (!dai_link->platforms)
1399 /* only single platform is supported for now */
1400 dai_link->platforms->name = name;
1406 #ifdef CONFIG_DEBUG_FS
1407 extern struct dentry *snd_soc_debugfs_root;
1410 extern const struct dev_pm_ops snd_soc_pm_ops;
1412 /* Helper functions */
1413 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1415 mutex_lock_nested(&dapm->card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
1418 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1420 mutex_unlock(&dapm->card->dapm_mutex);
1423 #include <sound/soc-component.h>
1424 #include <sound/soc-card.h>