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 enum snd_soc_card_subclass
{
418 SND_SOC_CARD_CLASS_INIT
= 0,
419 SND_SOC_CARD_CLASS_RUNTIME
= 1,
422 int snd_soc_register_card(struct snd_soc_card
*card
);
423 int snd_soc_unregister_card(struct snd_soc_card
*card
);
424 int devm_snd_soc_register_card(struct device
*dev
, struct snd_soc_card
*card
);
425 #ifdef CONFIG_PM_SLEEP
426 int snd_soc_suspend(struct device
*dev
);
427 int snd_soc_resume(struct device
*dev
);
429 static inline int snd_soc_suspend(struct device
*dev
)
434 static inline int snd_soc_resume(struct device
*dev
)
439 int snd_soc_poweroff(struct device
*dev
);
440 int snd_soc_add_component(struct device
*dev
,
441 struct snd_soc_component
*component
,
442 const struct snd_soc_component_driver
*component_driver
,
443 struct snd_soc_dai_driver
*dai_drv
,
445 int snd_soc_register_component(struct device
*dev
,
446 const struct snd_soc_component_driver
*component_driver
,
447 struct snd_soc_dai_driver
*dai_drv
, int num_dai
);
448 int devm_snd_soc_register_component(struct device
*dev
,
449 const struct snd_soc_component_driver
*component_driver
,
450 struct snd_soc_dai_driver
*dai_drv
, int num_dai
);
451 void snd_soc_unregister_component(struct device
*dev
);
452 struct snd_soc_component
*snd_soc_lookup_component(struct device
*dev
,
453 const char *driver_name
);
455 int soc_new_pcm(struct snd_soc_pcm_runtime
*rtd
, int num
);
456 #ifdef CONFIG_SND_SOC_COMPRESS
457 int snd_soc_new_compress(struct snd_soc_pcm_runtime
*rtd
, int num
);
459 static inline int snd_soc_new_compress(struct snd_soc_pcm_runtime
*rtd
, int num
)
465 void snd_soc_disconnect_sync(struct device
*dev
);
467 struct snd_pcm_substream
*snd_soc_get_dai_substream(struct snd_soc_card
*card
,
468 const char *dai_link
, int stream
);
469 struct snd_soc_pcm_runtime
*snd_soc_get_pcm_runtime(struct snd_soc_card
*card
,
470 const char *dai_link
);
472 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime
*rtd
);
473 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime
*rtd
, int stream
);
474 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime
*rtd
, int stream
);
476 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime
*rtd
,
477 unsigned int dai_fmt
);
480 int snd_soc_set_dmi_name(struct snd_soc_card
*card
, const char *flavour
);
482 static inline int snd_soc_set_dmi_name(struct snd_soc_card
*card
,
489 /* Utility functions to get clock rates from various things */
490 int snd_soc_calc_frame_size(int sample_size
, int channels
, int tdm_slots
);
491 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params
*params
);
492 int snd_soc_calc_bclk(int fs
, int sample_size
, int channels
, int tdm_slots
);
493 int snd_soc_params_to_bclk(struct snd_pcm_hw_params
*parms
);
495 /* set runtime hw params */
496 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream
*substream
,
497 const struct snd_pcm_hardware
*hw
);
500 int snd_soc_card_jack_new(struct snd_soc_card
*card
, const char *id
, int type
,
501 struct snd_soc_jack
*jack
, struct snd_soc_jack_pin
*pins
,
502 unsigned int num_pins
);
504 void snd_soc_jack_report(struct snd_soc_jack
*jack
, int status
, int mask
);
505 int snd_soc_jack_add_pins(struct snd_soc_jack
*jack
, int count
,
506 struct snd_soc_jack_pin
*pins
);
507 void snd_soc_jack_notifier_register(struct snd_soc_jack
*jack
,
508 struct notifier_block
*nb
);
509 void snd_soc_jack_notifier_unregister(struct snd_soc_jack
*jack
,
510 struct notifier_block
*nb
);
511 int snd_soc_jack_add_zones(struct snd_soc_jack
*jack
, int count
,
512 struct snd_soc_jack_zone
*zones
);
513 int snd_soc_jack_get_type(struct snd_soc_jack
*jack
, int micbias_voltage
);
514 #ifdef CONFIG_GPIOLIB
515 int snd_soc_jack_add_gpios(struct snd_soc_jack
*jack
, int count
,
516 struct snd_soc_jack_gpio
*gpios
);
517 int snd_soc_jack_add_gpiods(struct device
*gpiod_dev
,
518 struct snd_soc_jack
*jack
,
519 int count
, struct snd_soc_jack_gpio
*gpios
);
520 void snd_soc_jack_free_gpios(struct snd_soc_jack
*jack
, int count
,
521 struct snd_soc_jack_gpio
*gpios
);
523 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack
*jack
, int count
,
524 struct snd_soc_jack_gpio
*gpios
)
529 static inline int snd_soc_jack_add_gpiods(struct device
*gpiod_dev
,
530 struct snd_soc_jack
*jack
,
532 struct snd_soc_jack_gpio
*gpios
)
537 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack
*jack
, int count
,
538 struct snd_soc_jack_gpio
*gpios
)
543 struct snd_ac97
*snd_soc_alloc_ac97_component(struct snd_soc_component
*component
);
544 struct snd_ac97
*snd_soc_new_ac97_component(struct snd_soc_component
*component
,
545 unsigned int id
, unsigned int id_mask
);
546 void snd_soc_free_ac97_component(struct snd_ac97
*ac97
);
548 #ifdef CONFIG_SND_SOC_AC97_BUS
549 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops
*ops
);
550 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops
*ops
,
551 struct platform_device
*pdev
);
553 extern struct snd_ac97_bus_ops
*soc_ac97_ops
;
555 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops
*ops
,
556 struct platform_device
*pdev
)
561 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops
*ops
)
570 struct snd_kcontrol
*snd_soc_cnew(const struct snd_kcontrol_new
*_template
,
571 void *data
, const char *long_name
,
573 struct snd_kcontrol
*snd_soc_card_get_kcontrol(struct snd_soc_card
*soc_card
,
575 int snd_soc_add_component_controls(struct snd_soc_component
*component
,
576 const struct snd_kcontrol_new
*controls
, unsigned int num_controls
);
577 int snd_soc_add_card_controls(struct snd_soc_card
*soc_card
,
578 const struct snd_kcontrol_new
*controls
, int num_controls
);
579 int snd_soc_add_dai_controls(struct snd_soc_dai
*dai
,
580 const struct snd_kcontrol_new
*controls
, int num_controls
);
581 int snd_soc_info_enum_double(struct snd_kcontrol
*kcontrol
,
582 struct snd_ctl_elem_info
*uinfo
);
583 int snd_soc_get_enum_double(struct snd_kcontrol
*kcontrol
,
584 struct snd_ctl_elem_value
*ucontrol
);
585 int snd_soc_put_enum_double(struct snd_kcontrol
*kcontrol
,
586 struct snd_ctl_elem_value
*ucontrol
);
587 int snd_soc_info_volsw(struct snd_kcontrol
*kcontrol
,
588 struct snd_ctl_elem_info
*uinfo
);
589 int snd_soc_info_volsw_sx(struct snd_kcontrol
*kcontrol
,
590 struct snd_ctl_elem_info
*uinfo
);
591 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
592 int snd_soc_get_volsw(struct snd_kcontrol
*kcontrol
,
593 struct snd_ctl_elem_value
*ucontrol
);
594 int snd_soc_put_volsw(struct snd_kcontrol
*kcontrol
,
595 struct snd_ctl_elem_value
*ucontrol
);
596 #define snd_soc_get_volsw_2r snd_soc_get_volsw
597 #define snd_soc_put_volsw_2r snd_soc_put_volsw
598 int snd_soc_get_volsw_sx(struct snd_kcontrol
*kcontrol
,
599 struct snd_ctl_elem_value
*ucontrol
);
600 int snd_soc_put_volsw_sx(struct snd_kcontrol
*kcontrol
,
601 struct snd_ctl_elem_value
*ucontrol
);
602 int snd_soc_info_volsw_range(struct snd_kcontrol
*kcontrol
,
603 struct snd_ctl_elem_info
*uinfo
);
604 int snd_soc_put_volsw_range(struct snd_kcontrol
*kcontrol
,
605 struct snd_ctl_elem_value
*ucontrol
);
606 int snd_soc_get_volsw_range(struct snd_kcontrol
*kcontrol
,
607 struct snd_ctl_elem_value
*ucontrol
);
608 int snd_soc_limit_volume(struct snd_soc_card
*card
,
609 const char *name
, int max
);
610 int snd_soc_bytes_info(struct snd_kcontrol
*kcontrol
,
611 struct snd_ctl_elem_info
*uinfo
);
612 int snd_soc_bytes_get(struct snd_kcontrol
*kcontrol
,
613 struct snd_ctl_elem_value
*ucontrol
);
614 int snd_soc_bytes_put(struct snd_kcontrol
*kcontrol
,
615 struct snd_ctl_elem_value
*ucontrol
);
616 int snd_soc_bytes_info_ext(struct snd_kcontrol
*kcontrol
,
617 struct snd_ctl_elem_info
*ucontrol
);
618 int snd_soc_bytes_tlv_callback(struct snd_kcontrol
*kcontrol
, int op_flag
,
619 unsigned int size
, unsigned int __user
*tlv
);
620 int snd_soc_info_xr_sx(struct snd_kcontrol
*kcontrol
,
621 struct snd_ctl_elem_info
*uinfo
);
622 int snd_soc_get_xr_sx(struct snd_kcontrol
*kcontrol
,
623 struct snd_ctl_elem_value
*ucontrol
);
624 int snd_soc_put_xr_sx(struct snd_kcontrol
*kcontrol
,
625 struct snd_ctl_elem_value
*ucontrol
);
626 int snd_soc_get_strobe(struct snd_kcontrol
*kcontrol
,
627 struct snd_ctl_elem_value
*ucontrol
);
628 int snd_soc_put_strobe(struct snd_kcontrol
*kcontrol
,
629 struct snd_ctl_elem_value
*ucontrol
);
632 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
634 * @pin: name of the pin to update
635 * @mask: bits to check for in reported jack status
636 * @invert: if non-zero then pin is enabled when status is not reported
637 * @list: internal list entry
639 struct snd_soc_jack_pin
{
640 struct list_head list
;
647 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
649 * @min_mv: start voltage in mv
650 * @max_mv: end voltage in mv
651 * @jack_type: type of jack that is expected for this voltage
652 * @debounce_time: debounce_time for jack, codec driver should wait for this
653 * duration before reading the adc for voltages
654 * @list: internal list entry
656 struct snd_soc_jack_zone
{
659 unsigned int jack_type
;
660 unsigned int debounce_time
;
661 struct list_head list
;
665 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
667 * @gpio: legacy gpio number
668 * @idx: gpio descriptor index within the function of the GPIO
670 * @gpiod_dev: GPIO consumer device
671 * @name: gpio name. Also as connection ID for the GPIO consumer
672 * device function name lookup
673 * @report: value to report when jack detected
674 * @invert: report presence in low state
675 * @debounce_time: debounce time in ms
676 * @wake: enable as wake source
677 * @jack_status_check: callback function which overrides the detection
678 * to provide more complex checks (eg, reading an
681 struct snd_soc_jack_gpio
{
684 struct device
*gpiod_dev
;
692 struct snd_soc_jack
*jack
;
693 struct delayed_work work
;
694 struct notifier_block pm_notifier
;
695 struct gpio_desc
*desc
;
699 int (*jack_status_check
)(void *data
);
702 struct snd_soc_jack
{
704 struct snd_jack
*jack
;
705 struct snd_soc_card
*card
;
706 struct list_head pins
;
708 struct blocking_notifier_head notifier
;
709 struct list_head jack_zones
;
712 /* SoC PCM stream information */
713 struct snd_soc_pcm_stream
{
714 const char *stream_name
;
715 u64 formats
; /* SNDRV_PCM_FMTBIT_* */
716 unsigned int rates
; /* SNDRV_PCM_RATE_* */
717 unsigned int rate_min
; /* min rate */
718 unsigned int rate_max
; /* max rate */
719 unsigned int channels_min
; /* min channels */
720 unsigned int channels_max
; /* max channels */
721 unsigned int sig_bits
; /* number of bits of content */
726 int (*startup
)(struct snd_pcm_substream
*);
727 void (*shutdown
)(struct snd_pcm_substream
*);
728 int (*hw_params
)(struct snd_pcm_substream
*, struct snd_pcm_hw_params
*);
729 int (*hw_free
)(struct snd_pcm_substream
*);
730 int (*prepare
)(struct snd_pcm_substream
*);
731 int (*trigger
)(struct snd_pcm_substream
*, int);
734 struct snd_soc_compr_ops
{
735 int (*startup
)(struct snd_compr_stream
*);
736 void (*shutdown
)(struct snd_compr_stream
*);
737 int (*set_params
)(struct snd_compr_stream
*);
738 int (*trigger
)(struct snd_compr_stream
*);
741 struct snd_soc_rtdcom_list
{
742 struct snd_soc_component
*component
;
743 struct list_head list
; /* rtd::component_list */
745 struct snd_soc_component
*
746 snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime
*rtd
,
747 const char *driver_name
);
748 #define for_each_rtd_components(rtd, rtdcom, _component) \
749 for (rtdcom = list_first_entry(&(rtd)->component_list, \
750 typeof(*rtdcom), list); \
751 (&rtdcom->list != &(rtd)->component_list) && \
752 (_component = rtdcom->component); \
753 rtdcom = list_next_entry(rtdcom, list))
755 struct snd_soc_dai_link_component
{
757 struct device_node
*of_node
;
758 const char *dai_name
;
761 struct snd_soc_dai_link
{
762 /* config - must be set by machine driver */
763 const char *name
; /* Codec name */
764 const char *stream_name
; /* Stream name */
767 * You MAY specify the link's CPU-side device, either by device name,
768 * or by DT/OF node, but not both. If this information is omitted,
769 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
770 * must be globally unique. These fields are currently typically used
771 * only for codec to codec links, or systems using device tree.
774 * You MAY specify the DAI name of the CPU DAI. If this information is
775 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
776 * only, which only works well when that device exposes a single DAI.
778 struct snd_soc_dai_link_component
*cpus
;
779 unsigned int num_cpus
;
782 * You MUST specify the link's codec, either by device name, or by
783 * DT/OF node, but not both.
785 /* You MUST specify the DAI name within the codec */
786 struct snd_soc_dai_link_component
*codecs
;
787 unsigned int num_codecs
;
790 * You MAY specify the link's platform/PCM/DMA driver, either by
791 * device name, or by DT/OF node, but not both. Some forms of link
792 * do not need a platform. In such case, platforms are not mandatory.
794 struct snd_soc_dai_link_component
*platforms
;
795 unsigned int num_platforms
;
797 int id
; /* optional ID for machine driver link identification */
799 const struct snd_soc_pcm_stream
*params
;
800 unsigned int num_params
;
802 unsigned int dai_fmt
; /* format to set on init */
804 enum snd_soc_dpcm_trigger trigger
[2]; /* trigger type for DPCM */
806 /* codec/machine specific init - e.g. add machine controls */
807 int (*init
)(struct snd_soc_pcm_runtime
*rtd
);
809 /* optional hw_params re-writing for BE and FE sync */
810 int (*be_hw_params_fixup
)(struct snd_soc_pcm_runtime
*rtd
,
811 struct snd_pcm_hw_params
*params
);
813 /* machine stream operations */
814 const struct snd_soc_ops
*ops
;
815 const struct snd_soc_compr_ops
*compr_ops
;
817 /* Mark this pcm with non atomic ops */
820 /* For unidirectional dai links */
821 unsigned int playback_only
:1;
822 unsigned int capture_only
:1;
824 /* Keep DAI active over suspend */
825 unsigned int ignore_suspend
:1;
827 /* Symmetry requirements */
828 unsigned int symmetric_rates
:1;
829 unsigned int symmetric_channels
:1;
830 unsigned int symmetric_samplebits
:1;
832 /* Do not create a PCM for this DAI link (Backend link) */
833 unsigned int no_pcm
:1;
835 /* This DAI link can route to other DAI links at runtime (Frontend)*/
836 unsigned int dynamic
:1;
838 /* DPCM capture and Playback support */
839 unsigned int dpcm_capture
:1;
840 unsigned int dpcm_playback
:1;
842 /* DPCM used FE & BE merged format */
843 unsigned int dpcm_merged_format
:1;
844 /* DPCM used FE & BE merged channel */
845 unsigned int dpcm_merged_chan
:1;
846 /* DPCM used FE & BE merged rate */
847 unsigned int dpcm_merged_rate
:1;
849 /* pmdown_time is ignored at stop */
850 unsigned int ignore_pmdown_time
:1;
852 /* Do not create a PCM for this DAI link (Backend link) */
853 unsigned int ignore
:1;
855 struct list_head list
; /* DAI link list of the soc card */
856 #ifdef CONFIG_SND_SOC_TOPOLOGY
857 struct snd_soc_dobj dobj
; /* For topology */
860 #define for_each_link_codecs(link, i, codec) \
862 ((i) < link->num_codecs) && ((codec) = &link->codecs[i]); \
865 #define for_each_link_platforms(link, i, platform) \
867 ((i) < link->num_platforms) && \
868 ((platform) = &link->platforms[i]); \
872 * Sample 1 : Single CPU/Codec/Platform
874 * SND_SOC_DAILINK_DEFS(test,
875 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai")),
876 * DAILINK_COMP_ARRAY(COMP_CODEC("codec", "codec_dai")),
877 * DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
879 * struct snd_soc_dai_link link = {
881 * SND_SOC_DAILINK_REG(test),
884 * Sample 2 : Multi CPU/Codec, no Platform
886 * SND_SOC_DAILINK_DEFS(test,
887 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
888 * COMP_CPU("cpu_dai2")),
889 * DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
890 * COMP_CODEC("codec2", "codec_dai2")));
892 * struct snd_soc_dai_link link = {
894 * SND_SOC_DAILINK_REG(test),
897 * Sample 3 : Define each CPU/Codec/Platform manually
899 * SND_SOC_DAILINK_DEF(test_cpu,
900 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
901 * COMP_CPU("cpu_dai2")));
902 * SND_SOC_DAILINK_DEF(test_codec,
903 * DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
904 * COMP_CODEC("codec2", "codec_dai2")));
905 * SND_SOC_DAILINK_DEF(test_platform,
906 * DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
908 * struct snd_soc_dai_link link = {
910 * SND_SOC_DAILINK_REG(test_cpu,
915 * Sample 4 : Sample3 without platform
917 * struct snd_soc_dai_link link = {
919 * SND_SOC_DAILINK_REG(test_cpu,
924 #define SND_SOC_DAILINK_REG1(name) SND_SOC_DAILINK_REG3(name##_cpus, name##_codecs, name##_platforms)
925 #define SND_SOC_DAILINK_REG2(cpu, codec) SND_SOC_DAILINK_REG3(cpu, codec, null_dailink_component)
926 #define SND_SOC_DAILINK_REG3(cpu, codec, platform) \
928 .num_cpus = ARRAY_SIZE(cpu), \
930 .num_codecs = ARRAY_SIZE(codec), \
931 .platforms = platform, \
932 .num_platforms = ARRAY_SIZE(platform)
934 #define SND_SOC_DAILINK_REGx(_1, _2, _3, func, ...) func
935 #define SND_SOC_DAILINK_REG(...) \
936 SND_SOC_DAILINK_REGx(__VA_ARGS__, \
937 SND_SOC_DAILINK_REG3, \
938 SND_SOC_DAILINK_REG2, \
939 SND_SOC_DAILINK_REG1)(__VA_ARGS__)
941 #define SND_SOC_DAILINK_DEF(name, def...) \
942 static struct snd_soc_dai_link_component name[] = { def }
944 #define SND_SOC_DAILINK_DEFS(name, cpu, codec, platform...) \
945 SND_SOC_DAILINK_DEF(name##_cpus, cpu); \
946 SND_SOC_DAILINK_DEF(name##_codecs, codec); \
947 SND_SOC_DAILINK_DEF(name##_platforms, platform)
949 #define DAILINK_COMP_ARRAY(param...) param
950 #define COMP_EMPTY() { }
951 #define COMP_CPU(_dai) { .dai_name = _dai, }
952 #define COMP_CODEC(_name, _dai) { .name = _name, .dai_name = _dai, }
953 #define COMP_PLATFORM(_name) { .name = _name }
954 #define COMP_AUX(_name) { .name = _name }
955 #define COMP_DUMMY() { .name = "snd-soc-dummy", .dai_name = "snd-soc-dummy-dai", }
957 extern struct snd_soc_dai_link_component null_dailink_component
[0];
960 struct snd_soc_codec_conf
{
962 * specify device either by device name, or by
963 * DT/OF node, but not both.
965 const char *dev_name
;
966 struct device_node
*of_node
;
969 * optional map of kcontrol, widget and path name prefixes that are
970 * associated per device
972 const char *name_prefix
;
975 struct snd_soc_aux_dev
{
977 * specify multi-codec either by device name, or by
978 * DT/OF node, but not both.
980 struct snd_soc_dai_link_component dlc
;
982 /* codec/machine specific init - e.g. add machine controls */
983 int (*init
)(struct snd_soc_component
*component
);
987 struct snd_soc_card
{
989 const char *long_name
;
990 const char *driver_name
;
991 const char *components
;
992 char dmi_longname
[80];
993 char topology_shortname
[32];
996 struct snd_card
*snd_card
;
997 struct module
*owner
;
1000 struct mutex dapm_mutex
;
1002 /* Mutex for PCM operations */
1003 struct mutex pcm_mutex
;
1004 enum snd_soc_pcm_subclass pcm_subclass
;
1006 spinlock_t dpcm_lock
;
1009 bool topology_shortname_created
;
1011 int (*probe
)(struct snd_soc_card
*card
);
1012 int (*late_probe
)(struct snd_soc_card
*card
);
1013 int (*remove
)(struct snd_soc_card
*card
);
1015 /* the pre and post PM functions are used to do any PM work before and
1016 * after the codec and DAI's do any PM work. */
1017 int (*suspend_pre
)(struct snd_soc_card
*card
);
1018 int (*suspend_post
)(struct snd_soc_card
*card
);
1019 int (*resume_pre
)(struct snd_soc_card
*card
);
1020 int (*resume_post
)(struct snd_soc_card
*card
);
1023 int (*set_bias_level
)(struct snd_soc_card
*,
1024 struct snd_soc_dapm_context
*dapm
,
1025 enum snd_soc_bias_level level
);
1026 int (*set_bias_level_post
)(struct snd_soc_card
*,
1027 struct snd_soc_dapm_context
*dapm
,
1028 enum snd_soc_bias_level level
);
1030 int (*add_dai_link
)(struct snd_soc_card
*,
1031 struct snd_soc_dai_link
*link
);
1032 void (*remove_dai_link
)(struct snd_soc_card
*,
1033 struct snd_soc_dai_link
*link
);
1037 /* CPU <--> Codec DAI links */
1038 struct snd_soc_dai_link
*dai_link
; /* predefined links only */
1039 int num_links
; /* predefined links only */
1040 struct list_head dai_link_list
; /* all links */
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
;
1074 /* lists of probed devices belonging to this card */
1075 struct list_head component_dev_list
;
1076 struct list_head list
;
1078 struct list_head widgets
;
1079 struct list_head paths
;
1080 struct list_head dapm_list
;
1081 struct list_head dapm_dirty
;
1083 /* attached dynamic objects */
1084 struct list_head dobj_list
;
1086 /* Generic DAPM context for the card */
1087 struct snd_soc_dapm_context dapm
;
1088 struct snd_soc_dapm_stats dapm_stats
;
1089 struct snd_soc_dapm_update
*update
;
1091 #ifdef CONFIG_DEBUG_FS
1092 struct dentry
*debugfs_card_root
;
1094 #ifdef CONFIG_PM_SLEEP
1095 struct work_struct deferred_resume_work
;
1101 #define for_each_card_prelinks(card, i, link) \
1103 ((i) < (card)->num_links) && ((link) = &(card)->dai_link[i]); \
1105 #define for_each_card_pre_auxs(card, i, aux) \
1107 ((i) < (card)->num_aux_devs) && ((aux) = &(card)->aux_dev[i]); \
1110 #define for_each_card_links(card, link) \
1111 list_for_each_entry(link, &(card)->dai_link_list, list)
1112 #define for_each_card_links_safe(card, link, _link) \
1113 list_for_each_entry_safe(link, _link, &(card)->dai_link_list, list)
1115 #define for_each_card_rtds(card, rtd) \
1116 list_for_each_entry(rtd, &(card)->rtd_list, list)
1117 #define for_each_card_rtds_safe(card, rtd, _rtd) \
1118 list_for_each_entry_safe(rtd, _rtd, &(card)->rtd_list, list)
1120 #define for_each_card_auxs(card, component) \
1121 list_for_each_entry(component, &card->aux_comp_list, card_aux_list)
1122 #define for_each_card_auxs_safe(card, component, _comp) \
1123 list_for_each_entry_safe(component, _comp, \
1124 &card->aux_comp_list, card_aux_list)
1126 #define for_each_card_components(card, component) \
1127 list_for_each_entry(component, &(card)->component_dev_list, card_list)
1129 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1130 struct snd_soc_pcm_runtime
{
1132 struct snd_soc_card
*card
;
1133 struct snd_soc_dai_link
*dai_link
;
1134 struct snd_pcm_ops ops
;
1136 unsigned int params_select
; /* currently selected param for dai link */
1138 /* Dynamic PCM BE runtime data */
1139 struct snd_soc_dpcm_runtime dpcm
[2];
1143 /* runtime devices */
1144 struct snd_pcm
*pcm
;
1145 struct snd_compr
*compr
;
1146 struct snd_soc_dai
*codec_dai
;
1147 struct snd_soc_dai
*cpu_dai
;
1149 struct snd_soc_dai
**codec_dais
;
1150 unsigned int num_codecs
;
1152 struct delayed_work delayed_work
;
1153 #ifdef CONFIG_DEBUG_FS
1154 struct dentry
*debugfs_dpcm_root
;
1157 unsigned int num
; /* 0-based and monotonic increasing */
1158 struct list_head list
; /* rtd list of the soc card */
1159 struct list_head component_list
; /* list of connected components */
1162 unsigned int pop_wait
:1;
1163 unsigned int fe_compr
:1; /* for Dynamic PCM */
1165 #define for_each_rtd_codec_dai(rtd, i, dai)\
1167 ((i) < rtd->num_codecs) && ((dai) = rtd->codec_dais[i]); \
1169 #define for_each_rtd_codec_dai_rollback(rtd, i, dai) \
1170 for (; ((--i) >= 0) && ((dai) = rtd->codec_dais[i]);)
1174 struct soc_mixer_control
{
1175 int min
, max
, platform_max
;
1177 unsigned int shift
, rshift
;
1178 unsigned int sign_bit
;
1179 unsigned int invert
:1;
1180 unsigned int autodisable
:1;
1181 #ifdef CONFIG_SND_SOC_TOPOLOGY
1182 struct snd_soc_dobj dobj
;
1192 struct soc_bytes_ext
{
1194 #ifdef CONFIG_SND_SOC_TOPOLOGY
1195 struct snd_soc_dobj dobj
;
1197 /* used for TLV byte control */
1198 int (*get
)(struct snd_kcontrol
*kcontrol
, unsigned int __user
*bytes
,
1200 int (*put
)(struct snd_kcontrol
*kcontrol
, const unsigned int __user
*bytes
,
1204 /* multi register control */
1205 struct soc_mreg_control
{
1207 unsigned int regbase
, regcount
, nbits
, invert
;
1210 /* enumerated kcontrol */
1213 unsigned char shift_l
;
1214 unsigned char shift_r
;
1217 const char * const *texts
;
1218 const unsigned int *values
;
1219 unsigned int autodisable
:1;
1220 #ifdef CONFIG_SND_SOC_TOPOLOGY
1221 struct snd_soc_dobj dobj
;
1225 /* device driver data */
1227 static inline void snd_soc_card_set_drvdata(struct snd_soc_card
*card
,
1230 card
->drvdata
= data
;
1233 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card
*card
)
1235 return card
->drvdata
;
1238 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control
*mc
)
1240 if (mc
->reg
== mc
->rreg
&& mc
->shift
== mc
->rshift
)
1243 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1244 * mc->reg != mc->rreg means that the control is
1245 * stereo (bits in one register or in two registers)
1250 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum
*e
,
1258 for (i
= 0; i
< e
->items
; i
++)
1259 if (val
== e
->values
[i
])
1265 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum
*e
,
1271 return e
->values
[item
];
1275 * snd_soc_kcontrol_component() - Returns the component that registered the
1277 * @kcontrol: The control for which to get the component
1279 * Note: This function will work correctly if the control has been registered
1280 * for a component. With snd_soc_add_codec_controls() or via table based
1281 * setup for either a CODEC or component driver. Otherwise the behavior is
1284 static inline struct snd_soc_component
*snd_soc_kcontrol_component(
1285 struct snd_kcontrol
*kcontrol
)
1287 return snd_kcontrol_chip(kcontrol
);
1290 int snd_soc_util_init(void);
1291 void snd_soc_util_exit(void);
1293 int snd_soc_of_parse_card_name(struct snd_soc_card
*card
,
1294 const char *propname
);
1295 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card
*card
,
1296 const char *propname
);
1297 int snd_soc_of_get_slot_mask(struct device_node
*np
,
1298 const char *prop_name
,
1299 unsigned int *mask
);
1300 int snd_soc_of_parse_tdm_slot(struct device_node
*np
,
1301 unsigned int *tx_mask
,
1302 unsigned int *rx_mask
,
1303 unsigned int *slots
,
1304 unsigned int *slot_width
);
1305 void snd_soc_of_parse_node_prefix(struct device_node
*np
,
1306 struct snd_soc_codec_conf
*codec_conf
,
1307 struct device_node
*of_node
,
1308 const char *propname
);
1310 void snd_soc_of_parse_audio_prefix(struct snd_soc_card
*card
,
1311 struct snd_soc_codec_conf
*codec_conf
,
1312 struct device_node
*of_node
,
1313 const char *propname
)
1315 snd_soc_of_parse_node_prefix(card
->dev
->of_node
,
1316 codec_conf
, of_node
, propname
);
1319 int snd_soc_of_parse_audio_routing(struct snd_soc_card
*card
,
1320 const char *propname
);
1321 unsigned int snd_soc_of_parse_daifmt(struct device_node
*np
,
1323 struct device_node
**bitclkmaster
,
1324 struct device_node
**framemaster
);
1325 int snd_soc_get_dai_id(struct device_node
*ep
);
1326 int snd_soc_get_dai_name(struct of_phandle_args
*args
,
1327 const char **dai_name
);
1328 int snd_soc_of_get_dai_name(struct device_node
*of_node
,
1329 const char **dai_name
);
1330 int snd_soc_of_get_dai_link_codecs(struct device
*dev
,
1331 struct device_node
*of_node
,
1332 struct snd_soc_dai_link
*dai_link
);
1333 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link
*dai_link
);
1335 int snd_soc_add_dai_link(struct snd_soc_card
*card
,
1336 struct snd_soc_dai_link
*dai_link
);
1337 void snd_soc_remove_dai_link(struct snd_soc_card
*card
,
1338 struct snd_soc_dai_link
*dai_link
);
1339 struct snd_soc_dai_link
*snd_soc_find_dai_link(struct snd_soc_card
*card
,
1340 int id
, const char *name
,
1341 const char *stream_name
);
1343 struct snd_soc_dai
*snd_soc_register_dai(struct snd_soc_component
*component
,
1344 struct snd_soc_dai_driver
*dai_drv
,
1345 bool legacy_dai_naming
);
1346 void snd_soc_unregister_dai(struct snd_soc_dai
*dai
);
1348 struct snd_soc_dai
*snd_soc_find_dai(
1349 const struct snd_soc_dai_link_component
*dlc
);
1351 #include <sound/soc-dai.h>
1354 struct snd_soc_dai
*snd_soc_card_get_codec_dai(struct snd_soc_card
*card
,
1355 const char *dai_name
)
1357 struct snd_soc_pcm_runtime
*rtd
;
1359 list_for_each_entry(rtd
, &card
->rtd_list
, list
) {
1360 if (!strcmp(rtd
->codec_dai
->name
, dai_name
))
1361 return rtd
->codec_dai
;
1368 int snd_soc_fixup_dai_links_platform_name(struct snd_soc_card
*card
,
1369 const char *platform_name
)
1371 struct snd_soc_dai_link
*dai_link
;
1375 if (!platform_name
) /* nothing to do */
1378 /* set platform name for each dailink */
1379 for_each_card_prelinks(card
, i
, dai_link
) {
1380 name
= devm_kstrdup(card
->dev
, platform_name
, GFP_KERNEL
);
1384 if (!dai_link
->platforms
)
1387 /* only single platform is supported for now */
1388 dai_link
->platforms
->name
= name
;
1394 #ifdef CONFIG_DEBUG_FS
1395 extern struct dentry
*snd_soc_debugfs_root
;
1398 extern const struct dev_pm_ops snd_soc_pm_ops
;
1400 /* Helper functions */
1401 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context
*dapm
)
1403 mutex_lock_nested(&dapm
->card
->dapm_mutex
, SND_SOC_DAPM_CLASS_RUNTIME
);
1406 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context
*dapm
)
1408 mutex_unlock(&dapm
->card
->dapm_mutex
);
1412 int snd_soc_pcm_lib_ioctl(struct snd_soc_component
*component
,
1413 struct snd_pcm_substream
*substream
,
1414 unsigned int cmd
, void *arg
);
1416 #include <sound/soc-component.h>