1 /* SPDX-License-Identifier: GPL-2.0
2 *
3 * linux/sound/soc.h -- ALSA SoC Layer
4 *
5 * Author: Liam Girdwood
6 * Created: Aug 11th 2005
7 * Copyright: Wolfson Microelectronics. PLC.
8 */
9
10 #ifndef __LINUX_SND_SOC_H
11 #define __LINUX_SND_SOC_H
12
13 #include <linux/of.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>
27
28 /*
29 * Convenience kcontrol builders
30 */
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, \
54 .invert = xinvert})
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, \
108 max, invert, 0) }
109 #define SOC_DOUBLE_STS(xname, reg, shift_left, shift_right, max, invert) \
110 { \
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, \
116 max, invert, 0) }
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, \
122 xmax, xinvert) }
123 #define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
124 xmax, xinvert) \
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, \
138 max, invert, 0) }
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, \
147 xmax, xinvert) }
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, \
189 .sign_bit = 7,} }
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, \
233 .private_value = \
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, \
241 xmax, xinvert) }
242 #define SOC_SINGLE_MULTI_EXT(xname, xreg, xshift, xmax, xinvert, xcount,\
243 xhandler_get, xhandler_put) \
244 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
245 .info = snd_soc_info_multi_ext, \
246 .get = xhandler_get, .put = xhandler_put, \
247 .private_value = (unsigned long)&(struct soc_multi_mixer_control) \
248 {.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \
249 .count = xcount, .platform_max = xmax, .invert = xinvert} }
250 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
251 xhandler_get, xhandler_put, tlv_array) \
252 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
253 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
254 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
255 .tlv.p = (tlv_array), \
256 .info = snd_soc_info_volsw, \
257 .get = xhandler_get, .put = xhandler_put, \
258 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
259 #define SOC_SINGLE_RANGE_EXT_TLV(xname, xreg, xshift, xmin, xmax, xinvert, \
260 xhandler_get, xhandler_put, tlv_array) \
261 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
262 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
263 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
264 .tlv.p = (tlv_array), \
265 .info = snd_soc_info_volsw_range, \
266 .get = xhandler_get, .put = xhandler_put, \
267 .private_value = (unsigned long)&(struct soc_mixer_control) \
268 {.reg = xreg, .rreg = xreg, .shift = xshift, \
269 .rshift = xshift, .min = xmin, .max = xmax, \
270 .platform_max = xmax, .invert = xinvert} }
271 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
272 xhandler_get, xhandler_put, tlv_array) \
273 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
274 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
275 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
276 .tlv.p = (tlv_array), \
277 .info = snd_soc_info_volsw, \
278 .get = xhandler_get, .put = xhandler_put, \
279 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
280 xmax, xinvert, 0) }
281 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
282 xhandler_get, xhandler_put, tlv_array) \
283 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
284 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
285 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
286 .tlv.p = (tlv_array), \
287 .info = snd_soc_info_volsw, \
288 .get = xhandler_get, .put = xhandler_put, \
289 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
290 xmax, xinvert) }
291 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
292 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
293 .info = snd_soc_info_bool_ext, \
294 .get = xhandler_get, .put = xhandler_put, \
295 .private_value = xdata }
296 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
297 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
298 .info = snd_soc_info_enum_double, \
299 .get = xhandler_get, .put = xhandler_put, \
300 .private_value = (unsigned long)&xenum }
301 #define SOC_VALUE_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
302 SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put)
303
304 #define SND_SOC_BYTES(xname, xbase, xregs) \
305 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
306 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
307 .put = snd_soc_bytes_put, .private_value = \
308 ((unsigned long)&(struct soc_bytes) \
309 {.base = xbase, .num_regs = xregs }) }
310
311 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask) \
312 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
313 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
314 .put = snd_soc_bytes_put, .private_value = \
315 ((unsigned long)&(struct soc_bytes) \
316 {.base = xbase, .num_regs = xregs, \
317 .mask = xmask }) }
318
319 /*
320 * SND_SOC_BYTES_EXT is deprecated, please USE SND_SOC_BYTES_TLV instead
321 */
322 #define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \
323 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
324 .info = snd_soc_bytes_info_ext, \
325 .get = xhandler_get, .put = xhandler_put, \
326 .private_value = (unsigned long)&(struct soc_bytes_ext) \
327 {.max = xcount} }
328 #define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \
329 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
330 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \
331 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
332 .tlv.c = (snd_soc_bytes_tlv_callback), \
333 .info = snd_soc_bytes_info_ext, \
334 .private_value = (unsigned long)&(struct soc_bytes_ext) \
335 {.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
336 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
337 xmin, xmax, xinvert) \
338 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
339 .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
340 .put = snd_soc_put_xr_sx, \
341 .private_value = (unsigned long)&(struct soc_mreg_control) \
342 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
343 .invert = xinvert, .min = xmin, .max = xmax} }
344
345 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
346 SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
347 snd_soc_get_strobe, snd_soc_put_strobe)
348
349 /*
350 * Simplified versions of above macros, declaring a struct and calculating
351 * ARRAY_SIZE internally
352 */
353 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
354 const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
355 ARRAY_SIZE(xtexts), xtexts)
356 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
357 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
358 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
359 const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
360 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
361 const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
362 ARRAY_SIZE(xtexts), xtexts, xvalues)
363 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
364 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
365
366 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
367 const struct soc_enum name = SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, \
368 xshift, xmask, ARRAY_SIZE(xtexts), xtexts, xvalues)
369
370 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
371 const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
372
373 /* DAI Link Host Mode Support */
374 #define SND_SOC_DAI_LINK_NO_HOST 0x1
375 #define SND_SOC_DAI_LINK_OPT_HOST 0x2
376
377 /*
378 * Bias levels
379 *
380 * @ON: Bias is fully on for audio playback and capture operations.
381 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
382 * stream start and stop operations.
383 * @STANDBY: Low power standby state when no playback/capture operations are
384 * in progress. NOTE: The transition time between STANDBY and ON
385 * should be as fast as possible and no longer than 10ms.
386 * @OFF: Power Off. No restrictions on transition times.
387 */
388 enum snd_soc_bias_level {
389 SND_SOC_BIAS_OFF = 0,
390 SND_SOC_BIAS_STANDBY = 1,
391 SND_SOC_BIAS_PREPARE = 2,
392 SND_SOC_BIAS_ON = 3,
393 };
394
395 struct device_node;
396 struct snd_jack;
397 struct snd_soc_card;
398 struct snd_soc_pcm_stream;
399 struct snd_soc_ops;
400 struct snd_soc_pcm_runtime;
401 struct snd_soc_dai;
402 struct snd_soc_dai_driver;
403 struct snd_soc_dai_link;
404 struct snd_soc_component;
405 struct snd_soc_component_driver;
406 struct soc_enum;
407 struct snd_soc_jack;
408 struct snd_soc_jack_zone;
409 struct snd_soc_jack_pin;
410 #include <sound/soc-dapm.h>
411 #include <sound/soc-dpcm.h>
412 #include <sound/soc-topology.h>
413
414 struct snd_soc_jack_gpio;
415
416 typedef int (*hw_write_t)(void *,const char* ,int);
417
418 enum snd_soc_pcm_subclass {
419 SND_SOC_PCM_CLASS_PCM = 0,
420 SND_SOC_PCM_CLASS_BE = 1,
421 };
422
423 enum snd_soc_card_subclass {
424 SND_SOC_CARD_CLASS_INIT = 0,
425 SND_SOC_CARD_CLASS_RUNTIME = 1,
426 };
427
428 int snd_soc_register_card(struct snd_soc_card *card);
429 int snd_soc_unregister_card(struct snd_soc_card *card);
430 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
431 #ifdef CONFIG_PM_SLEEP
432 int snd_soc_suspend(struct device *dev);
433 int snd_soc_resume(struct device *dev);
434 #else
snd_soc_suspend(struct device * dev)435 static inline int snd_soc_suspend(struct device *dev)
436 {
437 return 0;
438 }
439
snd_soc_resume(struct device * dev)440 static inline int snd_soc_resume(struct device *dev)
441 {
442 return 0;
443 }
444 #endif
445 int snd_soc_poweroff(struct device *dev);
446 int snd_soc_add_component(struct device *dev,
447 struct snd_soc_component *component,
448 const struct snd_soc_component_driver *component_driver,
449 struct snd_soc_dai_driver *dai_drv,
450 int num_dai);
451 int snd_soc_register_component(struct device *dev,
452 const struct snd_soc_component_driver *component_driver,
453 struct snd_soc_dai_driver *dai_drv, int num_dai);
454 int devm_snd_soc_register_component(struct device *dev,
455 const struct snd_soc_component_driver *component_driver,
456 struct snd_soc_dai_driver *dai_drv, int num_dai);
457 void snd_soc_unregister_component(struct device *dev);
458 struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
459 const char *driver_name);
460
461 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
462 #ifdef CONFIG_SND_SOC_COMPRESS
463 int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
464 #else
snd_soc_new_compress(struct snd_soc_pcm_runtime * rtd,int num)465 static inline int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num)
466 {
467 return 0;
468 }
469 #endif
470
471 void snd_soc_disconnect_sync(struct device *dev);
472
473 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
474 const char *dai_link, int stream);
475 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
476 const char *dai_link);
477
478 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
479 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
480 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
481
482 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
483 unsigned int dai_fmt);
484
485 #ifdef CONFIG_DMI
486 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour);
487 #else
snd_soc_set_dmi_name(struct snd_soc_card * card,const char * flavour)488 static inline int snd_soc_set_dmi_name(struct snd_soc_card *card,
489 const char *flavour)
490 {
491 return 0;
492 }
493 #endif
494
495 /* Utility functions to get clock rates from various things */
496 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
497 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
498 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
499 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
500
501 /* set runtime hw params */
502 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
503 const struct snd_pcm_hardware *hw);
504
505 /* Jack reporting */
506 int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type,
507 struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins,
508 unsigned int num_pins);
509
510 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
511 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
512 struct snd_soc_jack_pin *pins);
513 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
514 struct notifier_block *nb);
515 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
516 struct notifier_block *nb);
517 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
518 struct snd_soc_jack_zone *zones);
519 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
520 #ifdef CONFIG_GPIOLIB
521 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
522 struct snd_soc_jack_gpio *gpios);
523 int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
524 struct snd_soc_jack *jack,
525 int count, struct snd_soc_jack_gpio *gpios);
526 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
527 struct snd_soc_jack_gpio *gpios);
528 #else
snd_soc_jack_add_gpios(struct snd_soc_jack * jack,int count,struct snd_soc_jack_gpio * gpios)529 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
530 struct snd_soc_jack_gpio *gpios)
531 {
532 return 0;
533 }
534
snd_soc_jack_add_gpiods(struct device * gpiod_dev,struct snd_soc_jack * jack,int count,struct snd_soc_jack_gpio * gpios)535 static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
536 struct snd_soc_jack *jack,
537 int count,
538 struct snd_soc_jack_gpio *gpios)
539 {
540 return 0;
541 }
542
snd_soc_jack_free_gpios(struct snd_soc_jack * jack,int count,struct snd_soc_jack_gpio * gpios)543 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
544 struct snd_soc_jack_gpio *gpios)
545 {
546 }
547 #endif
548
549 struct snd_ac97 *snd_soc_alloc_ac97_component(struct snd_soc_component *component);
550 struct snd_ac97 *snd_soc_new_ac97_component(struct snd_soc_component *component,
551 unsigned int id, unsigned int id_mask);
552 void snd_soc_free_ac97_component(struct snd_ac97 *ac97);
553
554 #ifdef CONFIG_SND_SOC_AC97_BUS
555 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
556 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
557 struct platform_device *pdev);
558
559 extern struct snd_ac97_bus_ops *soc_ac97_ops;
560 #else
snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops * ops,struct platform_device * pdev)561 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
562 struct platform_device *pdev)
563 {
564 return 0;
565 }
566
snd_soc_set_ac97_ops(struct snd_ac97_bus_ops * ops)567 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
568 {
569 return 0;
570 }
571 #endif
572
573 /*
574 *Controls
575 */
576 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
577 void *data, const char *long_name,
578 const char *prefix);
579 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
580 const char *name);
581 int snd_soc_add_component_controls(struct snd_soc_component *component,
582 const struct snd_kcontrol_new *controls, unsigned int num_controls);
583 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
584 const struct snd_kcontrol_new *controls, int num_controls);
585 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
586 const struct snd_kcontrol_new *controls, int num_controls);
587 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
588 struct snd_ctl_elem_info *uinfo);
589 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
590 struct snd_ctl_elem_value *ucontrol);
591 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
592 struct snd_ctl_elem_value *ucontrol);
593 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
594 struct snd_ctl_elem_info *uinfo);
595 int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol,
596 struct snd_ctl_elem_info *uinfo);
597 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
598 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
599 struct snd_ctl_elem_value *ucontrol);
600 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
601 struct snd_ctl_elem_value *ucontrol);
602 #define snd_soc_get_volsw_2r snd_soc_get_volsw
603 #define snd_soc_put_volsw_2r snd_soc_put_volsw
604 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
605 struct snd_ctl_elem_value *ucontrol);
606 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
607 struct snd_ctl_elem_value *ucontrol);
608 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
609 struct snd_ctl_elem_info *uinfo);
610 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
611 struct snd_ctl_elem_value *ucontrol);
612 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
613 struct snd_ctl_elem_value *ucontrol);
614 int snd_soc_limit_volume(struct snd_soc_card *card,
615 const char *name, int max);
616 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
617 struct snd_ctl_elem_info *uinfo);
618 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
619 struct snd_ctl_elem_value *ucontrol);
620 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
621 struct snd_ctl_elem_value *ucontrol);
622 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
623 struct snd_ctl_elem_info *ucontrol);
624 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
625 unsigned int size, unsigned int __user *tlv);
626 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
627 struct snd_ctl_elem_info *uinfo);
628 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
629 struct snd_ctl_elem_value *ucontrol);
630 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
631 struct snd_ctl_elem_value *ucontrol);
632 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
633 struct snd_ctl_elem_value *ucontrol);
634 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
635 struct snd_ctl_elem_value *ucontrol);
636 int snd_soc_info_multi_ext(struct snd_kcontrol *kcontrol,
637 struct snd_ctl_elem_info *uinfo);
638
639 /**
640 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
641 *
642 * @pin: name of the pin to update
643 * @mask: bits to check for in reported jack status
644 * @invert: if non-zero then pin is enabled when status is not reported
645 * @list: internal list entry
646 */
647 struct snd_soc_jack_pin {
648 struct list_head list;
649 const char *pin;
650 int mask;
651 bool invert;
652 };
653
654 /**
655 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
656 *
657 * @min_mv: start voltage in mv
658 * @max_mv: end voltage in mv
659 * @jack_type: type of jack that is expected for this voltage
660 * @debounce_time: debounce_time for jack, codec driver should wait for this
661 * duration before reading the adc for voltages
662 * @list: internal list entry
663 */
664 struct snd_soc_jack_zone {
665 unsigned int min_mv;
666 unsigned int max_mv;
667 unsigned int jack_type;
668 unsigned int debounce_time;
669 struct list_head list;
670 };
671
672 /**
673 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
674 *
675 * @gpio: legacy gpio number
676 * @idx: gpio descriptor index within the function of the GPIO
677 * consumer device
678 * @gpiod_dev: GPIO consumer device
679 * @name: gpio name. Also as connection ID for the GPIO consumer
680 * device function name lookup
681 * @report: value to report when jack detected
682 * @invert: report presence in low state
683 * @debounce_time: debounce time in ms
684 * @wake: enable as wake source
685 * @jack_status_check: callback function which overrides the detection
686 * to provide more complex checks (eg, reading an
687 * ADC).
688 */
689 struct snd_soc_jack_gpio {
690 unsigned int gpio;
691 unsigned int idx;
692 struct device *gpiod_dev;
693 const char *name;
694 int report;
695 int invert;
696 int debounce_time;
697 bool wake;
698
699 /* private: */
700 struct snd_soc_jack *jack;
701 struct delayed_work work;
702 struct notifier_block pm_notifier;
703 struct gpio_desc *desc;
704
705 void *data;
706 /* public: */
707 int (*jack_status_check)(void *data);
708 };
709
710 struct snd_soc_jack {
711 struct mutex mutex;
712 struct snd_jack *jack;
713 struct snd_soc_card *card;
714 struct list_head pins;
715 int status;
716 struct blocking_notifier_head notifier;
717 struct list_head jack_zones;
718 };
719
720 /* SoC PCM stream information */
721 struct snd_soc_pcm_stream {
722 const char *stream_name;
723 u64 formats; /* SNDRV_PCM_FMTBIT_* */
724 unsigned int rates; /* SNDRV_PCM_RATE_* */
725 unsigned int rate_min; /* min rate */
726 unsigned int rate_max; /* max rate */
727 unsigned int channels_min; /* min channels */
728 unsigned int channels_max; /* max channels */
729 unsigned int sig_bits; /* number of bits of content */
730 const char *aif_name; /* DAPM AIF widget name */
731 };
732
733 /* SoC audio ops */
734 struct snd_soc_ops {
735 int (*startup)(struct snd_pcm_substream *);
736 void (*shutdown)(struct snd_pcm_substream *);
737 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
738 int (*hw_free)(struct snd_pcm_substream *);
739 int (*prepare)(struct snd_pcm_substream *);
740 int (*trigger)(struct snd_pcm_substream *, int);
741 };
742
743 struct snd_soc_compr_ops {
744 int (*startup)(struct snd_compr_stream *);
745 void (*shutdown)(struct snd_compr_stream *);
746 int (*set_params)(struct snd_compr_stream *);
747 int (*trigger)(struct snd_compr_stream *);
748 };
749
750 struct snd_soc_rtdcom_list {
751 struct snd_soc_component *component;
752 struct list_head list; /* rtd::component_list */
753 };
754 struct snd_soc_component*
755 snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
756 const char *driver_name);
757 #define for_each_rtdcom(rtd, rtdcom) \
758 list_for_each_entry(rtdcom, &(rtd)->component_list, list)
759 #define for_each_rtdcom_safe(rtd, rtdcom1, rtdcom2) \
760 list_for_each_entry_safe(rtdcom1, rtdcom2, &(rtd)->component_list, list)
761
762 struct snd_soc_dai_link_component {
763 const char *name;
764 struct device_node *of_node;
765 const char *dai_name;
766 };
767
768 struct snd_soc_dai_link {
769 /* config - must be set by machine driver */
770 const char *name; /* Codec name */
771 const char *stream_name; /* Stream name */
772
773 /*
774 * You MAY specify the link's CPU-side device, either by device name,
775 * or by DT/OF node, but not both. If this information is omitted,
776 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
777 * must be globally unique. These fields are currently typically used
778 * only for codec to codec links, or systems using device tree.
779 */
780 /*
781 * You MAY specify the DAI name of the CPU DAI. If this information is
782 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
783 * only, which only works well when that device exposes a single DAI.
784 */
785 struct snd_soc_dai_link_component *cpus;
786 unsigned int num_cpus;
787
788 /*
789 * You MUST specify the link's codec, either by device name, or by
790 * DT/OF node, but not both.
791 */
792 /* You MUST specify the DAI name within the codec */
793 struct snd_soc_dai_link_component *codecs;
794 unsigned int num_codecs;
795
796 /*
797 * You MAY specify the link's platform/PCM/DMA driver, either by
798 * device name, or by DT/OF node, but not both. Some forms of link
799 * do not need a platform. In such case, platforms are not mandatory.
800 */
801 struct snd_soc_dai_link_component *platforms;
802 unsigned int num_platforms;
803
804 int id; /* optional ID for machine driver link identification */
805
806 const struct snd_soc_pcm_stream *params;
807 unsigned int num_params;
808
809 unsigned int dai_fmt; /* format to set on init */
810
811 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
812
813 /* codec/machine specific init - e.g. add machine controls */
814 int (*init)(struct snd_soc_pcm_runtime *rtd);
815
816 /* optional hw_params re-writing for BE and FE sync */
817 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
818 struct snd_pcm_hw_params *params);
819
820 /* machine stream operations */
821 const struct snd_soc_ops *ops;
822 const struct snd_soc_compr_ops *compr_ops;
823
824 /* Mark this pcm with non atomic ops */
825 bool nonatomic;
826
827 /* For unidirectional dai links */
828 unsigned int playback_only:1;
829 unsigned int capture_only:1;
830
831 /* Keep DAI active over suspend */
832 unsigned int ignore_suspend:1;
833
834 /* Symmetry requirements */
835 unsigned int symmetric_rates:1;
836 unsigned int symmetric_channels:1;
837 unsigned int symmetric_samplebits:1;
838
839 /* Do not create a PCM for this DAI link (Backend link) */
840 unsigned int no_pcm:1;
841
842 /* This DAI link can route to other DAI links at runtime (Frontend)*/
843 unsigned int dynamic:1;
844
845 /*
846 * This DAI can support no host IO (no pcm data is
847 * copied to from host)
848 */
849 unsigned int no_host_mode:2;
850
851 /* DPCM capture and Playback support */
852 unsigned int dpcm_capture:1;
853 unsigned int dpcm_playback:1;
854
855 /* DPCM used FE & BE merged format */
856 unsigned int dpcm_merged_format:1;
857 /* DPCM used FE & BE merged channel */
858 unsigned int dpcm_merged_chan:1;
859 /* DPCM used FE & BE merged rate */
860 unsigned int dpcm_merged_rate:1;
861
862 /* pmdown_time is ignored at stop */
863 unsigned int ignore_pmdown_time:1;
864
865 /* Do not create a PCM for this DAI link (Backend link) */
866 unsigned int ignore:1;
867
868 struct list_head list; /* DAI link list of the soc card */
869 struct snd_soc_dobj dobj; /* For topology */
870 };
871 #define for_each_link_codecs(link, i, codec) \
872 for ((i) = 0; \
873 ((i) < link->num_codecs) && ((codec) = &link->codecs[i]); \
874 (i)++)
875
876 #define for_each_link_platforms(link, i, platform) \
877 for ((i) = 0; \
878 ((i) < link->num_platforms) && \
879 ((platform) = &link->platforms[i]); \
880 (i)++)
881
882 /*
883 * Sample 1 : Single CPU/Codec/Platform
884 *
885 * SND_SOC_DAILINK_DEFS(test,
886 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai")),
887 * DAILINK_COMP_ARRAY(COMP_CODEC("codec", "codec_dai")),
888 * DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
889 *
890 * struct snd_soc_dai_link link = {
891 * ...
892 * SND_SOC_DAILINK_REG(test),
893 * };
894 *
895 * Sample 2 : Multi CPU/Codec, no Platform
896 *
897 * SND_SOC_DAILINK_DEFS(test,
898 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
899 * COMP_CPU("cpu_dai2")),
900 * DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
901 * COMP_CODEC("codec2", "codec_dai2")));
902 *
903 * struct snd_soc_dai_link link = {
904 * ...
905 * SND_SOC_DAILINK_REG(test),
906 * };
907 *
908 * Sample 3 : Define each CPU/Codec/Platform manually
909 *
910 * SND_SOC_DAILINK_DEF(test_cpu,
911 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
912 * COMP_CPU("cpu_dai2")));
913 * SND_SOC_DAILINK_DEF(test_codec,
914 * DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
915 * COMP_CODEC("codec2", "codec_dai2")));
916 * SND_SOC_DAILINK_DEF(test_platform,
917 * DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
918 *
919 * struct snd_soc_dai_link link = {
920 * ...
921 * SND_SOC_DAILINK_REG(test_cpu,
922 * test_codec,
923 * test_platform),
924 * };
925 *
926 * Sample 4 : Sample3 without platform
927 *
928 * struct snd_soc_dai_link link = {
929 * ...
930 * SND_SOC_DAILINK_REG(test_cpu,
931 * test_codec);
932 * };
933 */
934
935 #define SND_SOC_DAILINK_REG1(name) SND_SOC_DAILINK_REG3(name##_cpus, name##_codecs, name##_platforms)
936 #define SND_SOC_DAILINK_REG2(cpu, codec) SND_SOC_DAILINK_REG3(cpu, codec, null_dailink_component)
937 #define SND_SOC_DAILINK_REG3(cpu, codec, platform) \
938 .cpus = cpu, \
939 .num_cpus = ARRAY_SIZE(cpu), \
940 .codecs = codec, \
941 .num_codecs = ARRAY_SIZE(codec), \
942 .platforms = platform, \
943 .num_platforms = ARRAY_SIZE(platform)
944
945 #define SND_SOC_DAILINK_REGx(_1, _2, _3, func, ...) func
946 #define SND_SOC_DAILINK_REG(...) \
947 SND_SOC_DAILINK_REGx(__VA_ARGS__, \
948 SND_SOC_DAILINK_REG3, \
949 SND_SOC_DAILINK_REG2, \
950 SND_SOC_DAILINK_REG1)(__VA_ARGS__)
951
952 #define SND_SOC_DAILINK_DEF(name, def...) \
953 static struct snd_soc_dai_link_component name[] = { def }
954
955 #define SND_SOC_DAILINK_DEFS(name, cpu, codec, platform...) \
956 SND_SOC_DAILINK_DEF(name##_cpus, cpu); \
957 SND_SOC_DAILINK_DEF(name##_codecs, codec); \
958 SND_SOC_DAILINK_DEF(name##_platforms, platform)
959
960 #define DAILINK_COMP_ARRAY(param...) param
961 #define COMP_EMPTY() { }
962 #define COMP_CPU(_dai) { .dai_name = _dai, }
963 #define COMP_CODEC(_name, _dai) { .name = _name, .dai_name = _dai, }
964 #define COMP_PLATFORM(_name) { .name = _name }
965 #define COMP_AUX(_name) { .name = _name }
966 #define COMP_DUMMY() { .name = "snd-soc-dummy", .dai_name = "snd-soc-dummy-dai", }
967
968 extern struct snd_soc_dai_link_component null_dailink_component[0];
969
970
971 struct snd_soc_codec_conf {
972 /*
973 * specify device either by device name, or by
974 * DT/OF node, but not both.
975 */
976 const char *dev_name;
977 struct device_node *of_node;
978
979 /*
980 * optional map of kcontrol, widget and path name prefixes that are
981 * associated per device
982 */
983 const char *name_prefix;
984 };
985
986 struct snd_soc_aux_dev {
987 /*
988 * specify multi-codec either by device name, or by
989 * DT/OF node, but not both.
990 */
991 struct snd_soc_dai_link_component dlc;
992
993 /* codec/machine specific init - e.g. add machine controls */
994 int (*init)(struct snd_soc_component *component);
995 };
996
997 /* SoC card */
998 struct snd_soc_card {
999 const char *name;
1000 const char *long_name;
1001 const char *driver_name;
1002 char dmi_longname[80];
1003 char topology_shortname[32];
1004
1005 struct device *dev;
1006 struct snd_card *snd_card;
1007 struct module *owner;
1008
1009 struct mutex mutex;
1010 struct mutex dapm_mutex;
1011
1012 /* Mutex for PCM operations */
1013 struct mutex pcm_mutex;
1014 enum snd_soc_pcm_subclass pcm_subclass;
1015
1016 spinlock_t dpcm_lock;
1017
1018 bool instantiated;
1019 bool topology_shortname_created;
1020
1021 int (*probe)(struct snd_soc_card *card);
1022 int (*late_probe)(struct snd_soc_card *card);
1023 int (*remove)(struct snd_soc_card *card);
1024
1025 /* the pre and post PM functions are used to do any PM work before and
1026 * after the codec and DAI's do any PM work. */
1027 int (*suspend_pre)(struct snd_soc_card *card);
1028 int (*suspend_post)(struct snd_soc_card *card);
1029 int (*resume_pre)(struct snd_soc_card *card);
1030 int (*resume_post)(struct snd_soc_card *card);
1031
1032 /* callbacks */
1033 int (*set_bias_level)(struct snd_soc_card *,
1034 struct snd_soc_dapm_context *dapm,
1035 enum snd_soc_bias_level level);
1036 int (*set_bias_level_post)(struct snd_soc_card *,
1037 struct snd_soc_dapm_context *dapm,
1038 enum snd_soc_bias_level level);
1039
1040 int (*add_dai_link)(struct snd_soc_card *,
1041 struct snd_soc_dai_link *link);
1042 void (*remove_dai_link)(struct snd_soc_card *,
1043 struct snd_soc_dai_link *link);
1044
1045 long pmdown_time;
1046
1047 /* CPU <--> Codec DAI links */
1048 struct snd_soc_dai_link *dai_link; /* predefined links only */
1049 int num_links; /* predefined links only */
1050 struct list_head dai_link_list; /* all links */
1051
1052 struct list_head rtd_list;
1053 int num_rtd;
1054
1055 /* optional codec specific configuration */
1056 struct snd_soc_codec_conf *codec_conf;
1057 int num_configs;
1058
1059 /*
1060 * optional auxiliary devices such as amplifiers or codecs with DAI
1061 * link unused
1062 */
1063 struct snd_soc_aux_dev *aux_dev;
1064 int num_aux_devs;
1065 struct list_head aux_comp_list;
1066
1067 const struct snd_kcontrol_new *controls;
1068 int num_controls;
1069
1070 /*
1071 * Card-specific routes and widgets.
1072 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1073 */
1074 const struct snd_soc_dapm_widget *dapm_widgets;
1075 int num_dapm_widgets;
1076 const struct snd_soc_dapm_route *dapm_routes;
1077 int num_dapm_routes;
1078 const struct snd_soc_dapm_widget *of_dapm_widgets;
1079 int num_of_dapm_widgets;
1080 const struct snd_soc_dapm_route *of_dapm_routes;
1081 int num_of_dapm_routes;
1082 bool fully_routed;
1083
1084 /* lists of probed devices belonging to this card */
1085 struct list_head component_dev_list;
1086 struct list_head list;
1087
1088 struct list_head widgets;
1089 struct list_head paths;
1090 struct list_head dapm_list;
1091 struct list_head dapm_dirty;
1092
1093 /* attached dynamic objects */
1094 struct list_head dobj_list;
1095
1096 /* Generic DAPM context for the card */
1097 struct snd_soc_dapm_context dapm;
1098 struct snd_soc_dapm_stats dapm_stats;
1099 struct snd_soc_dapm_update *update;
1100
1101 #ifdef CONFIG_DEBUG_FS
1102 struct dentry *debugfs_card_root;
1103 #endif
1104 #ifdef CONFIG_PM_SLEEP
1105 struct work_struct deferred_resume_work;
1106 #endif
1107 u32 pop_time;
1108
1109 void *drvdata;
1110 };
1111 #define for_each_card_prelinks(card, i, link) \
1112 for ((i) = 0; \
1113 ((i) < (card)->num_links) && ((link) = &(card)->dai_link[i]); \
1114 (i)++)
1115 #define for_each_card_pre_auxs(card, i, aux) \
1116 for ((i) = 0; \
1117 ((i) < (card)->num_aux_devs) && ((aux) = &(card)->aux_dev[i]); \
1118 (i)++)
1119
1120 #define for_each_card_links(card, link) \
1121 list_for_each_entry(link, &(card)->dai_link_list, list)
1122 #define for_each_card_links_safe(card, link, _link) \
1123 list_for_each_entry_safe(link, _link, &(card)->dai_link_list, list)
1124
1125 #define for_each_card_rtds(card, rtd) \
1126 list_for_each_entry(rtd, &(card)->rtd_list, list)
1127 #define for_each_card_rtds_safe(card, rtd, _rtd) \
1128 list_for_each_entry_safe(rtd, _rtd, &(card)->rtd_list, list)
1129
1130 #define for_each_card_auxs(card, component) \
1131 list_for_each_entry(component, &card->aux_comp_list, card_aux_list)
1132 #define for_each_card_auxs_safe(card, component, _comp) \
1133 list_for_each_entry_safe(component, _comp, \
1134 &card->aux_comp_list, card_aux_list)
1135
1136 #define for_each_card_components(card, component) \
1137 list_for_each_entry(component, &(card)->component_dev_list, card_list)
1138
1139 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1140 struct snd_soc_pcm_runtime {
1141 struct device *dev;
1142 struct snd_soc_card *card;
1143 struct snd_soc_dai_link *dai_link;
1144 struct snd_pcm_ops ops;
1145
1146 unsigned int params_select; /* currently selected param for dai link */
1147
1148 /* Dynamic PCM BE runtime data */
1149 struct snd_soc_dpcm_runtime dpcm[2];
1150
1151 long pmdown_time;
1152
1153 /* runtime devices */
1154 struct snd_pcm *pcm;
1155 struct snd_compr *compr;
1156 struct snd_soc_dai *codec_dai;
1157 struct snd_soc_dai *cpu_dai;
1158
1159 struct snd_soc_dai **codec_dais;
1160 unsigned int num_codecs;
1161
1162 struct delayed_work delayed_work;
1163 #ifdef CONFIG_DEBUG_FS
1164 struct dentry *debugfs_dpcm_root;
1165 #endif
1166
1167 unsigned int num; /* 0-based and monotonic increasing */
1168 struct list_head list; /* rtd list of the soc card */
1169 struct list_head component_list; /* list of connected components */
1170
1171 /* bit field */
1172 unsigned int dev_registered:1;
1173 unsigned int pop_wait:1;
1174 unsigned int fe_compr:1; /* for Dynamic PCM */
1175 };
1176 #define for_each_rtd_codec_dai(rtd, i, dai)\
1177 for ((i) = 0; \
1178 ((i) < rtd->num_codecs) && ((dai) = rtd->codec_dais[i]); \
1179 (i)++)
1180 #define for_each_rtd_codec_dai_rollback(rtd, i, dai) \
1181 for (; ((--i) >= 0) && ((dai) = rtd->codec_dais[i]);)
1182
1183
1184 /* mixer control */
1185 struct soc_mixer_control {
1186 int min, max, platform_max;
1187 int reg, rreg;
1188 unsigned int shift, rshift;
1189 unsigned int sign_bit;
1190 unsigned int invert:1;
1191 unsigned int autodisable:1;
1192 struct snd_soc_dobj dobj;
1193 };
1194
1195 struct soc_bytes {
1196 int base;
1197 int num_regs;
1198 u32 mask;
1199 };
1200
1201 struct soc_bytes_ext {
1202 int max;
1203 struct snd_soc_dobj dobj;
1204
1205 /* used for TLV byte control */
1206 int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1207 unsigned int size);
1208 int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1209 unsigned int size);
1210 };
1211
1212 /* multi register control */
1213 struct soc_mreg_control {
1214 long min, max;
1215 unsigned int regbase, regcount, nbits, invert;
1216 };
1217
1218 struct soc_multi_mixer_control {
1219 int min, max, platform_max, count;
1220 unsigned int reg, rreg, shift, rshift, invert;
1221 };
1222
1223 /* enumerated kcontrol */
1224 struct soc_enum {
1225 int reg;
1226 unsigned char shift_l;
1227 unsigned char shift_r;
1228 unsigned int items;
1229 unsigned int mask;
1230 const char * const *texts;
1231 const unsigned int *values;
1232 unsigned int autodisable:1;
1233 struct snd_soc_dobj dobj;
1234 };
1235
1236 /* device driver data */
1237
snd_soc_card_set_drvdata(struct snd_soc_card * card,void * data)1238 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1239 void *data)
1240 {
1241 card->drvdata = data;
1242 }
1243
snd_soc_card_get_drvdata(struct snd_soc_card * card)1244 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1245 {
1246 return card->drvdata;
1247 }
1248
snd_soc_volsw_is_stereo(struct soc_mixer_control * mc)1249 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1250 {
1251 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1252 return 0;
1253 /*
1254 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1255 * mc->reg != mc->rreg means that the control is
1256 * stereo (bits in one register or in two registers)
1257 */
1258 return 1;
1259 }
1260
snd_soc_enum_val_to_item(struct soc_enum * e,unsigned int val)1261 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1262 unsigned int val)
1263 {
1264 unsigned int i;
1265
1266 if (!e->values)
1267 return val;
1268
1269 for (i = 0; i < e->items; i++)
1270 if (val == e->values[i])
1271 return i;
1272
1273 return 0;
1274 }
1275
snd_soc_enum_item_to_val(struct soc_enum * e,unsigned int item)1276 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1277 unsigned int item)
1278 {
1279 if (!e->values)
1280 return item;
1281
1282 return e->values[item];
1283 }
1284
1285 /**
1286 * snd_soc_kcontrol_component() - Returns the component that registered the
1287 * control
1288 * @kcontrol: The control for which to get the component
1289 *
1290 * Note: This function will work correctly if the control has been registered
1291 * for a component. With snd_soc_add_codec_controls() or via table based
1292 * setup for either a CODEC or component driver. Otherwise the behavior is
1293 * undefined.
1294 */
snd_soc_kcontrol_component(struct snd_kcontrol * kcontrol)1295 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1296 struct snd_kcontrol *kcontrol)
1297 {
1298 return snd_kcontrol_chip(kcontrol);
1299 }
1300
1301 int snd_soc_util_init(void);
1302 void snd_soc_util_exit(void);
1303
1304 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1305 const char *propname);
1306 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1307 const char *propname);
1308 int snd_soc_of_get_slot_mask(struct device_node *np,
1309 const char *prop_name,
1310 unsigned int *mask);
1311 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1312 unsigned int *tx_mask,
1313 unsigned int *rx_mask,
1314 unsigned int *slots,
1315 unsigned int *slot_width);
1316 void snd_soc_of_parse_node_prefix(struct device_node *np,
1317 struct snd_soc_codec_conf *codec_conf,
1318 struct device_node *of_node,
1319 const char *propname);
1320 static inline
snd_soc_of_parse_audio_prefix(struct snd_soc_card * card,struct snd_soc_codec_conf * codec_conf,struct device_node * of_node,const char * propname)1321 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1322 struct snd_soc_codec_conf *codec_conf,
1323 struct device_node *of_node,
1324 const char *propname)
1325 {
1326 snd_soc_of_parse_node_prefix(card->dev->of_node,
1327 codec_conf, of_node, propname);
1328 }
1329
1330 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1331 const char *propname);
1332 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1333 const char *prefix,
1334 struct device_node **bitclkmaster,
1335 struct device_node **framemaster);
1336 int snd_soc_get_dai_id(struct device_node *ep);
1337 int snd_soc_get_dai_name(struct of_phandle_args *args,
1338 const char **dai_name);
1339 int snd_soc_of_get_dai_name(struct device_node *of_node,
1340 const char **dai_name);
1341 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1342 struct device_node *of_node,
1343 struct snd_soc_dai_link *dai_link);
1344 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link);
1345
1346 int snd_soc_add_dai_link(struct snd_soc_card *card,
1347 struct snd_soc_dai_link *dai_link);
1348 void snd_soc_remove_dai_link(struct snd_soc_card *card,
1349 struct snd_soc_dai_link *dai_link);
1350 struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
1351 int id, const char *name,
1352 const char *stream_name);
1353
1354 int snd_soc_register_dai(struct snd_soc_component *component,
1355 struct snd_soc_dai_driver *dai_drv);
1356
1357 struct snd_soc_dai *snd_soc_find_dai(
1358 const struct snd_soc_dai_link_component *dlc);
1359
1360 #include <sound/soc-dai.h>
1361
1362 static inline
snd_soc_card_get_codec_dai(struct snd_soc_card * card,const char * dai_name)1363 struct snd_soc_dai *snd_soc_card_get_codec_dai(struct snd_soc_card *card,
1364 const char *dai_name)
1365 {
1366 struct snd_soc_pcm_runtime *rtd;
1367
1368 list_for_each_entry(rtd, &card->rtd_list, list) {
1369 if (!strcmp(rtd->codec_dai->name, dai_name))
1370 return rtd->codec_dai;
1371 }
1372
1373 return NULL;
1374 }
1375
1376 static inline
snd_soc_fixup_dai_links_platform_name(struct snd_soc_card * card,const char * platform_name)1377 int snd_soc_fixup_dai_links_platform_name(struct snd_soc_card *card,
1378 const char *platform_name)
1379 {
1380 struct snd_soc_dai_link *dai_link;
1381 const char *name;
1382 int i;
1383
1384 if (!platform_name) /* nothing to do */
1385 return 0;
1386
1387 /* set platform name for each dailink */
1388 for_each_card_prelinks(card, i, dai_link) {
1389 name = devm_kstrdup(card->dev, platform_name, GFP_KERNEL);
1390 if (!name)
1391 return -ENOMEM;
1392
1393 if (!dai_link->platforms)
1394 return -EINVAL;
1395
1396 /* only single platform is supported for now */
1397 dai_link->platforms->name = name;
1398 }
1399
1400 return 0;
1401 }
1402
1403 #ifdef CONFIG_DEBUG_FS
1404 extern struct dentry *snd_soc_debugfs_root;
1405 #endif
1406
1407 extern const struct dev_pm_ops snd_soc_pm_ops;
1408
1409 /* Helper functions */
snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context * dapm)1410 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1411 {
1412 mutex_lock_nested(&dapm->card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
1413 }
1414
snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context * dapm)1415 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1416 {
1417 mutex_unlock(&dapm->card->dapm_mutex);
1418 }
1419
1420 #include <sound/soc-component.h>
1421
1422 #endif
1423