xref: /linux/include/sound/soc.h (revision 3859e15cc9d88c0e7b6f9a2cefdc4cbf3d6298e5)
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/args.h>
14 #include <linux/array_size.h>
15 #include <linux/device.h>
16 #include <linux/errno.h>
17 #include <linux/interrupt.h>
18 #include <linux/lockdep.h>
19 #include <linux/log2.h>
20 #include <linux/mutex.h>
21 #include <linux/notifier.h>
22 #include <linux/of.h>
23 #include <linux/types.h>
24 #include <linux/workqueue.h>
25 
26 #include <sound/ac97_codec.h>
27 #include <sound/compress_driver.h>
28 #include <sound/control.h>
29 #include <sound/core.h>
30 #include <sound/pcm.h>
31 
32 struct module;
33 struct platform_device;
34 
35 /* For the current users of sound/soc.h to avoid build issues */
36 #include <linux/platform_device.h>
37 #include <linux/regmap.h>
38 
39 /*
40  * Convenience kcontrol builders
41  */
42 #define SOC_DOUBLE_S_VALUE(xreg, shift_left, shift_right, xmin, xmax, xsign_bit, \
43 			   xinvert, xautodisable) \
44 	((unsigned long)&(struct soc_mixer_control) \
45 	{.reg = xreg, .rreg = xreg, .shift = shift_left, \
46 	.rshift = shift_right, .min = xmin, .max = xmax, \
47 	.sign_bit = xsign_bit, .invert = xinvert, .autodisable = xautodisable})
48 #define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmin, xmax, xinvert, xautodisable) \
49 	SOC_DOUBLE_S_VALUE(xreg, shift_left, shift_right, xmin, xmax, 0, xinvert, \
50 			   xautodisable)
51 #define SOC_SINGLE_VALUE(xreg, xshift, xmin, xmax, xinvert, xautodisable) \
52 	SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmin, xmax, xinvert, xautodisable)
53 #define SOC_DOUBLE_R_S_VALUE(xlreg, xrreg, xshift, xmin, xmax, xsign_bit, xinvert) \
54 	((unsigned long)&(struct soc_mixer_control) \
55 	{.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
56 	.max = xmax, .min = xmin, .sign_bit = xsign_bit, \
57 	.invert = xinvert})
58 #define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
59 	SOC_DOUBLE_R_S_VALUE(xlreg, xrreg, xshift, xmin, xmax, 0, xinvert)
60 
61 #define SOC_SINGLE(xname, reg, shift, max, invert) \
62 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
63 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
64 	.put = snd_soc_put_volsw, \
65 	.private_value = SOC_SINGLE_VALUE(reg, shift, 0, max, invert, 0) }
66 #define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
67 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
68 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
69 	.put = snd_soc_put_volsw, \
70 	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmin, xmax, xinvert, 0) }
71 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
72 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
73 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
74 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
75 	.tlv.p = (tlv_array), \
76 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
77 	.put = snd_soc_put_volsw, \
78 	.private_value = SOC_SINGLE_VALUE(reg, shift, 0, max, invert, 0) }
79 #define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
80 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
81 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
82 	SNDRV_CTL_ELEM_ACCESS_READWRITE, \
83 	.tlv.p  = (tlv_array),\
84 	.info = snd_soc_info_volsw_sx, \
85 	.get = snd_soc_get_volsw_sx,\
86 	.put = snd_soc_put_volsw_sx, \
87 	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmin, xmax, 0, 0) }
88 #define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
89 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
90 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
91 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
92 	.tlv.p = (tlv_array), \
93 	.info = snd_soc_info_volsw, \
94 	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
95 	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmin, xmax, xinvert, 0) }
96 #define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
97 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
98 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
99 	.put = snd_soc_put_volsw, \
100 	.private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
101 					  0, max, invert, 0) }
102 #define SOC_DOUBLE_STS(xname, reg, shift_left, shift_right, max, invert) \
103 {									\
104 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),		\
105 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,		\
106 	.access = SNDRV_CTL_ELEM_ACCESS_READ |				\
107 		SNDRV_CTL_ELEM_ACCESS_VOLATILE,				\
108 	.private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right,	\
109 					  0, max, invert, 0) }
110 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
111 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
112 	.info = snd_soc_info_volsw, \
113 	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
114 	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
115 					    0, xmax, xinvert) }
116 #define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
117 			   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, \
122 					    xshift, xmin, xmax, xinvert) }
123 #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
124 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
125 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
126 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
127 	.tlv.p = (tlv_array), \
128 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
129 	.put = snd_soc_put_volsw, \
130 	.private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
131 					  0, max, invert, 0) }
132 #define SOC_DOUBLE_SX_TLV(xname, xreg, shift_left, shift_right, xmin, xmax, tlv_array) \
133 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
134 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
135 	SNDRV_CTL_ELEM_ACCESS_READWRITE, \
136 	.tlv.p  = (tlv_array), \
137 	.info = snd_soc_info_volsw_sx, \
138 	.get = snd_soc_get_volsw_sx, \
139 	.put = snd_soc_put_volsw_sx, \
140 	.private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
141 					  xmin, xmax, 0, 0) }
142 #define SOC_DOUBLE_RANGE_TLV(xname, xreg, xshift_left, xshift_right, xmin, xmax, \
143 			     xinvert, tlv_array) \
144 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
145 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
146 		  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
147 	.tlv.p = (tlv_array), \
148 	.info = snd_soc_info_volsw, \
149 	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
150 	.private_value = SOC_DOUBLE_VALUE(xreg, xshift_left, xshift_right, \
151 					  xmin, xmax, xinvert, 0) }
152 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
153 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
154 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
155 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
156 	.tlv.p = (tlv_array), \
157 	.info = snd_soc_info_volsw, \
158 	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
159 	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
160 					    0, xmax, xinvert) }
161 #define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
162 			       xmax, xinvert, tlv_array)		\
163 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
164 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
165 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
166 	.tlv.p = (tlv_array), \
167 	.info = snd_soc_info_volsw, \
168 	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
169 	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, \
170 					    xshift, xmin, xmax, xinvert) }
171 #define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
172 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
173 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
174 	SNDRV_CTL_ELEM_ACCESS_READWRITE, \
175 	.tlv.p  = (tlv_array), \
176 	.info = snd_soc_info_volsw_sx, \
177 	.get = snd_soc_get_volsw_sx, \
178 	.put = snd_soc_put_volsw_sx, \
179 	.private_value = SOC_DOUBLE_R_VALUE(xreg, xrreg, xshift, xmin, xmax, 0) }
180 #define SOC_DOUBLE_R_S_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
181 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
182 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
183 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
184 	.tlv.p = (tlv_array), \
185 	.info = snd_soc_info_volsw, \
186 	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
187 	.private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
188 					    xmin, xmax, xsign_bit, xinvert) }
189 #define SOC_SINGLE_S_TLV(xname, xreg, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
190 	SOC_DOUBLE_R_S_TLV(xname, xreg, xreg, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array)
191 #define SOC_SINGLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
192 {	.iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
193 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
194 		  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
195 	.tlv.p  = (tlv_array), \
196 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
197 	.put = snd_soc_put_volsw, \
198 	.private_value = (unsigned long)&(struct soc_mixer_control) \
199 	{.reg = xreg, .rreg = xreg,  \
200 	 .min = xmin, .max = xmax, \
201 	.sign_bit = 7,} }
202 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
203 {	.iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
204 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
205 		  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
206 	.tlv.p  = (tlv_array), \
207 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
208 	.put = snd_soc_put_volsw, \
209 	.private_value = SOC_DOUBLE_S_VALUE(xreg, 0, 8, xmin, xmax, 7, 0, 0) }
210 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \
211 {	.reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
212 	.items = xitems, .texts = xtexts, \
213 	.mask = xitems ? roundup_pow_of_two(xitems) - 1 : 0}
214 #define SOC_ENUM_SINGLE(xreg, xshift, xitems, xtexts) \
215 	SOC_ENUM_DOUBLE(xreg, xshift, xshift, xitems, xtexts)
216 #define SOC_ENUM_SINGLE_EXT(xitems, xtexts) \
217 {	.items = xitems, .texts = xtexts }
218 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xitems, xtexts, xvalues) \
219 {	.reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
220 	.mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues}
221 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
222 	SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xitems, xtexts, xvalues)
223 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
224 {	.reg = xreg, .shift_l = xshift, .shift_r = xshift, \
225 	.mask = xmask, .items = xitems, .texts = xtexts, \
226 	.values = xvalues, .autodisable = 1}
227 #define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \
228 	SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
229 #define SOC_ENUM(xname, xenum) \
230 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
231 	.info = snd_soc_info_enum_double, \
232 	.get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
233 	.private_value = (unsigned long)&xenum }
234 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
235 	 xhandler_get, xhandler_put) \
236 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
237 	.info = snd_soc_info_volsw, \
238 	.get = xhandler_get, .put = xhandler_put, \
239 	.private_value = SOC_SINGLE_VALUE(xreg, xshift, 0, xmax, xinvert, 0) }
240 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
241 	 xhandler_get, xhandler_put) \
242 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
243 	.info = snd_soc_info_volsw, \
244 	.get = xhandler_get, .put = xhandler_put, \
245 	.private_value = \
246 		SOC_DOUBLE_VALUE(reg, shift_left, shift_right, 0, max, invert, 0) }
247 #define SOC_DOUBLE_R_EXT(xname, reg_left, reg_right, xshift, xmax, xinvert,\
248 	 xhandler_get, xhandler_put) \
249 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
250 	.info = snd_soc_info_volsw, \
251 	.get = xhandler_get, .put = xhandler_put, \
252 	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
253 					    0, xmax, xinvert) }
254 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
255 	 xhandler_get, xhandler_put, tlv_array) \
256 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
257 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
258 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
259 	.tlv.p = (tlv_array), \
260 	.info = snd_soc_info_volsw, \
261 	.get = xhandler_get, .put = xhandler_put, \
262 	.private_value = SOC_SINGLE_VALUE(xreg, xshift, 0, xmax, xinvert, 0) }
263 #define SOC_SINGLE_RANGE_EXT_TLV(xname, xreg, xshift, xmin, 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_SINGLE_VALUE(xreg, xshift, xmin, xmax, xinvert, 0) }
272 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
273 	 xhandler_get, xhandler_put, tlv_array) \
274 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
275 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
276 		 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
277 	.tlv.p = (tlv_array), \
278 	.info = snd_soc_info_volsw, \
279 	.get = xhandler_get, .put = xhandler_put, \
280 	.private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
281 					  0, xmax, xinvert, 0) }
282 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
283 	 xhandler_get, xhandler_put, tlv_array) \
284 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
285 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
286 		 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
287 	.tlv.p = (tlv_array), \
288 	.info = snd_soc_info_volsw, \
289 	.get = xhandler_get, .put = xhandler_put, \
290 	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
291 					    0, xmax, xinvert) }
292 #define SOC_DOUBLE_R_S_EXT_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, \
293 			       xsign_bit, xinvert, xhandler_get, xhandler_put, \
294 			       tlv_array) \
295 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
296 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
297 		  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
298 	.tlv.p = (tlv_array), \
299 	.info = snd_soc_info_volsw, \
300 	.get = xhandler_get, .put = xhandler_put, \
301 	.private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
302 					      xmin, xmax, xsign_bit, xinvert) }
303 #define SOC_SINGLE_S_EXT_TLV(xname, xreg, xshift, xmin, xmax, \
304 			     xsign_bit, xinvert, xhandler_get, xhandler_put, \
305 			     tlv_array) \
306 	SOC_DOUBLE_R_S_EXT_TLV(xname, xreg, xreg, xshift, xmin, xmax, \
307 			       xsign_bit, xinvert, xhandler_get, xhandler_put, \
308 			       tlv_array)
309 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
310 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
311 	.info = snd_soc_info_bool_ext, \
312 	.get = xhandler_get, .put = xhandler_put, \
313 	.private_value = xdata }
314 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
315 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
316 	.info = snd_soc_info_enum_double, \
317 	.get = xhandler_get, .put = xhandler_put, \
318 	.private_value = (unsigned long)&xenum }
319 #define SOC_VALUE_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
320 	SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put)
321 
322 #define SOC_ENUM_EXT_ACC(xname, xenum, xhandler_get, xhandler_put, xaccess) \
323 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
324 	.access = xaccess, \
325 	.info = snd_soc_info_enum_double, \
326 	.get = xhandler_get, .put = xhandler_put, \
327 	.private_value = (unsigned long)&xenum }
328 
329 #define SND_SOC_BYTES(xname, xbase, xregs)		      \
330 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
331 	.info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
332 	.put = snd_soc_bytes_put, .private_value =	      \
333 		((unsigned long)&(struct soc_bytes)           \
334 		{.base = xbase, .num_regs = xregs }) }
335 #define SND_SOC_BYTES_E(xname, xbase, xregs, xhandler_get, xhandler_put) \
336 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
337 	.info = snd_soc_bytes_info, .get = xhandler_get, \
338 	.put = xhandler_put, .private_value = \
339 		((unsigned long)&(struct soc_bytes) \
340 		{.base = xbase, .num_regs = xregs }) }
341 #define SND_SOC_BYTES_E_ACC(xname, xbase, xregs, xhandler_get, xhandler_put, xaccess) \
342 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
343 	.access = xaccess, \
344 	.info = snd_soc_bytes_info, .get = xhandler_get, \
345 	.put = xhandler_put, .private_value = \
346 		((unsigned long)&(struct soc_bytes) \
347 		{.base = xbase, .num_regs = xregs }) }
348 
349 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask)	      \
350 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
351 	.info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
352 	.put = snd_soc_bytes_put, .private_value =	      \
353 		((unsigned long)&(struct soc_bytes)           \
354 		{.base = xbase, .num_regs = xregs,	      \
355 		 .mask = xmask }) }
356 
357 /*
358  * SND_SOC_BYTES_EXT is deprecated, please USE SND_SOC_BYTES_TLV instead
359  */
360 #define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \
361 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
362 	.info = snd_soc_bytes_info_ext, \
363 	.get = xhandler_get, .put = xhandler_put, \
364 	.private_value = (unsigned long)&(struct soc_bytes_ext) \
365 		{.max = xcount} }
366 #define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \
367 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
368 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \
369 		  SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
370 	.tlv.c = (snd_soc_bytes_tlv_callback), \
371 	.info = snd_soc_bytes_info_ext, \
372 	.private_value = (unsigned long)&(struct soc_bytes_ext) \
373 		{.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
374 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
375 		xmin, xmax, xinvert) \
376 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
377 	.info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
378 	.put = snd_soc_put_xr_sx, \
379 	.private_value = (unsigned long)&(struct soc_mreg_control) \
380 		{.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
381 		.invert = xinvert, .min = xmin, .max = xmax} }
382 
383 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
384 	SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
385 		snd_soc_get_strobe, snd_soc_put_strobe)
386 
387 /*
388  * Simplified versions of above macros, declaring a struct and calculating
389  * ARRAY_SIZE internally
390  */
391 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
392 	const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
393 						ARRAY_SIZE(xtexts), xtexts)
394 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
395 	SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
396 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
397 	const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
398 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
399 	const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
400 							ARRAY_SIZE(xtexts), xtexts, xvalues)
401 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
402 	SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
403 
404 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
405 	const struct soc_enum name = SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, \
406 		xshift, xmask, ARRAY_SIZE(xtexts), xtexts, xvalues)
407 
408 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
409 	const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
410 
411 struct snd_soc_card;
412 struct snd_soc_pcm_runtime;
413 struct snd_soc_dai;
414 struct snd_soc_dai_driver;
415 struct snd_soc_dai_link;
416 struct snd_soc_component;
417 struct snd_soc_component_driver;
418 struct snd_soc_jack;
419 struct snd_soc_jack_pin;
420 
421 #include <sound/soc-dapm.h>
422 #include <sound/soc-dpcm.h>
423 #include <sound/soc-topology.h>
424 
425 int snd_soc_register_card(struct snd_soc_card *card);
426 void snd_soc_unregister_card(struct snd_soc_card *card);
427 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
428 int devm_snd_soc_register_deferrable_card(struct device *dev, struct snd_soc_card *card);
429 #ifdef CONFIG_PM_SLEEP
430 int snd_soc_suspend(struct device *dev);
431 int snd_soc_resume(struct device *dev);
432 #else
433 static inline int snd_soc_suspend(struct device *dev)
434 {
435 	return 0;
436 }
437 
438 static inline int snd_soc_resume(struct device *dev)
439 {
440 	return 0;
441 }
442 #endif
443 int snd_soc_poweroff(struct device *dev);
444 int snd_soc_component_initialize(struct snd_soc_component *component,
445 				 const struct snd_soc_component_driver *driver,
446 				 struct device *dev);
447 int snd_soc_add_component(struct snd_soc_component *component,
448 			  struct snd_soc_dai_driver *dai_drv,
449 			  int num_dai);
450 int snd_soc_register_component(struct device *dev,
451 			 const struct snd_soc_component_driver *component_driver,
452 			 struct snd_soc_dai_driver *dai_drv, int num_dai);
453 int devm_snd_soc_register_component(struct device *dev,
454 			 const struct snd_soc_component_driver *component_driver,
455 			 struct snd_soc_dai_driver *dai_drv, int num_dai);
456 #define snd_soc_unregister_component(dev) snd_soc_unregister_component_by_driver(dev, NULL)
457 void snd_soc_unregister_component_by_driver(struct device *dev,
458 			 const struct snd_soc_component_driver *component_driver);
459 struct snd_soc_component *snd_soc_lookup_component_nolocked(struct device *dev,
460 							    const char *driver_name);
461 struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
462 						   const char *driver_name);
463 struct snd_soc_component *snd_soc_lookup_component_by_name(const char *component_name);
464 
465 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd);
466 #ifdef CONFIG_SND_SOC_COMPRESS
467 int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd);
468 #else
469 static inline int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd)
470 {
471 	return 0;
472 }
473 #endif
474 
475 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
476 				struct snd_soc_dai_link *dai_link);
477 
478 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
479 
480 void snd_soc_runtime_action(struct snd_soc_pcm_runtime *rtd,
481 			    int stream, int action);
482 static inline void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd,
483 				     int stream)
484 {
485 	snd_soc_runtime_action(rtd, stream, 1);
486 }
487 static inline void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd,
488 				       int stream)
489 {
490 	snd_soc_runtime_action(rtd, stream, -1);
491 }
492 
493 int snd_soc_runtime_calc_hw(struct snd_soc_pcm_runtime *rtd,
494 			    struct snd_pcm_hardware *hw, int stream);
495 
496 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
497 	unsigned int dai_fmt);
498 
499 /* Utility functions to get clock rates from various things */
500 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
501 int snd_soc_params_to_frame_size(const struct snd_pcm_hw_params *params);
502 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
503 int snd_soc_params_to_bclk(const struct snd_pcm_hw_params *parms);
504 int snd_soc_tdm_params_to_bclk(const struct snd_pcm_hw_params *params,
505 			       int tdm_width, int tdm_slots, int slot_multiple);
506 int snd_soc_ret(const struct device *dev, int ret, const char *fmt, ...);
507 
508 /* set runtime hw params */
509 static inline int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
510 					       const struct snd_pcm_hardware *hw)
511 {
512 	substream->runtime->hw = *hw;
513 
514 	return 0;
515 }
516 
517 struct snd_ac97 *snd_soc_alloc_ac97_component(struct snd_soc_component *component);
518 struct snd_ac97 *snd_soc_new_ac97_component(struct snd_soc_component *component,
519 	unsigned int id, unsigned int id_mask);
520 void snd_soc_free_ac97_component(struct snd_ac97 *ac97);
521 
522 #ifdef CONFIG_SND_SOC_AC97_BUS
523 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
524 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
525 		struct platform_device *pdev);
526 
527 extern struct snd_ac97_bus_ops *soc_ac97_ops;
528 #else
529 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
530 	struct platform_device *pdev)
531 {
532 	return 0;
533 }
534 
535 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
536 {
537 	return 0;
538 }
539 #endif
540 
541 /*
542  *Controls
543  */
544 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
545 				  void *data, const char *long_name,
546 				  const char *prefix);
547 int snd_soc_add_component_controls(struct snd_soc_component *component,
548 	const struct snd_kcontrol_new *controls, unsigned int num_controls);
549 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
550 	const struct snd_kcontrol_new *controls, int num_controls);
551 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
552 	const struct snd_kcontrol_new *controls, int num_controls);
553 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
554 	struct snd_ctl_elem_info *uinfo);
555 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
556 	struct snd_ctl_elem_value *ucontrol);
557 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
558 	struct snd_ctl_elem_value *ucontrol);
559 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
560 	struct snd_ctl_elem_info *uinfo);
561 int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol,
562 			  struct snd_ctl_elem_info *uinfo);
563 #define snd_soc_info_bool_ext		snd_ctl_boolean_mono_info
564 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
565 	struct snd_ctl_elem_value *ucontrol);
566 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
567 	struct snd_ctl_elem_value *ucontrol);
568 #define snd_soc_get_volsw_2r snd_soc_get_volsw
569 #define snd_soc_put_volsw_2r snd_soc_put_volsw
570 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
571 	struct snd_ctl_elem_value *ucontrol);
572 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
573 	struct snd_ctl_elem_value *ucontrol);
574 int snd_soc_limit_volume(struct snd_soc_card *card,
575 	const char *name, int max);
576 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
577 		       struct snd_ctl_elem_info *uinfo);
578 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
579 		      struct snd_ctl_elem_value *ucontrol);
580 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
581 		      struct snd_ctl_elem_value *ucontrol);
582 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
583 	struct snd_ctl_elem_info *ucontrol);
584 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
585 	unsigned int size, unsigned int __user *tlv);
586 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
587 	struct snd_ctl_elem_info *uinfo);
588 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
589 	struct snd_ctl_elem_value *ucontrol);
590 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
591 	struct snd_ctl_elem_value *ucontrol);
592 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
593 	struct snd_ctl_elem_value *ucontrol);
594 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
595 	struct snd_ctl_elem_value *ucontrol);
596 
597 enum snd_soc_trigger_order {
598 						/* start			stop		     */
599 	SND_SOC_TRIGGER_ORDER_DEFAULT	= 0,	/* Link->Component->DAI		DAI->Component->Link */
600 	SND_SOC_TRIGGER_ORDER_LDC,		/* Link->DAI->Component		Component->DAI->Link */
601 
602 	SND_SOC_TRIGGER_ORDER_MAX,
603 };
604 
605 /* SoC PCM stream information */
606 struct snd_soc_pcm_stream {
607 	const char *stream_name;
608 	u64 formats;			/* SNDRV_PCM_FMTBIT_* */
609 	u32 subformats;			/* for S32_LE format, SNDRV_PCM_SUBFMTBIT_* */
610 	unsigned int rates;		/* SNDRV_PCM_RATE_* */
611 	unsigned int rate_min;		/* min rate */
612 	unsigned int rate_max;		/* max rate */
613 	unsigned int channels_min;	/* min channels */
614 	unsigned int channels_max;	/* max channels */
615 	unsigned int sig_bits;		/* number of bits of content */
616 };
617 
618 /* SoC audio ops */
619 struct snd_soc_ops {
620 	int (*startup)(struct snd_pcm_substream *);
621 	void (*shutdown)(struct snd_pcm_substream *);
622 	int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
623 	int (*hw_free)(struct snd_pcm_substream *);
624 	int (*prepare)(struct snd_pcm_substream *);
625 	int (*trigger)(struct snd_pcm_substream *, int);
626 };
627 
628 struct snd_soc_compr_ops {
629 	int (*startup)(struct snd_compr_stream *);
630 	void (*shutdown)(struct snd_compr_stream *);
631 	int (*set_params)(struct snd_compr_stream *);
632 };
633 
634 struct snd_soc_component*
635 snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
636 		       const char *driver_name);
637 
638 struct snd_soc_dai_link_component {
639 	const char *name;
640 	struct device_node *of_node;
641 	const char *dai_name;
642 	const struct of_phandle_args *dai_args;
643 
644 	/*
645 	 * Extra format = SND_SOC_DAIFMT_Bx_Fx
646 	 *
647 	 * [Note] it is Bx_Fx base, not CBx_CFx
648 	 *
649 	 * It will be used with dai_link->dai_fmt
650 	 * see
651 	 *	snd_soc_runtime_set_dai_fmt()
652 	 */
653 	unsigned int ext_fmt;
654 };
655 
656 /*
657  * [dai_link->ch_maps Image sample]
658  *
659  *-------------------------
660  * CPU0 <---> Codec0
661  *
662  * ch-map[0].cpu = 0	ch-map[0].codec = 0
663  *
664  *-------------------------
665  * CPU0 <---> Codec0
666  * CPU1 <---> Codec1
667  * CPU2 <---> Codec2
668  *
669  * ch-map[0].cpu = 0	ch-map[0].codec = 0
670  * ch-map[1].cpu = 1	ch-map[1].codec = 1
671  * ch-map[2].cpu = 2	ch-map[2].codec = 2
672  *
673  *-------------------------
674  * CPU0 <---> Codec0
675  * CPU1 <-+-> Codec1
676  * CPU2 <-/
677  *
678  * ch-map[0].cpu = 0	ch-map[0].codec = 0
679  * ch-map[1].cpu = 1	ch-map[1].codec = 1
680  * ch-map[2].cpu = 2	ch-map[2].codec = 1
681  *
682  *-------------------------
683  * CPU0 <---> Codec0
684  * CPU1 <-+-> Codec1
685  *	  \-> Codec2
686  *
687  * ch-map[0].cpu = 0	ch-map[0].codec = 0
688  * ch-map[1].cpu = 1	ch-map[1].codec = 1
689  * ch-map[2].cpu = 1	ch-map[2].codec = 2
690  *
691  */
692 struct snd_soc_dai_link_ch_map {
693 	unsigned int cpu;
694 	unsigned int codec;
695 	unsigned int ch_mask;
696 };
697 
698 struct snd_soc_dai_link {
699 	/* config - must be set by machine driver */
700 	const char *name;			/* Codec name */
701 	const char *stream_name;		/* Stream name */
702 
703 	/*
704 	 * You MAY specify the link's CPU-side device, either by device name,
705 	 * or by DT/OF node, but not both. If this information is omitted,
706 	 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
707 	 * must be globally unique. These fields are currently typically used
708 	 * only for codec to codec links, or systems using device tree.
709 	 */
710 	/*
711 	 * You MAY specify the DAI name of the CPU DAI. If this information is
712 	 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
713 	 * only, which only works well when that device exposes a single DAI.
714 	 */
715 	struct snd_soc_dai_link_component *cpus;
716 	unsigned int num_cpus;
717 
718 	/*
719 	 * You MUST specify the link's codec, either by device name, or by
720 	 * DT/OF node, but not both.
721 	 */
722 	/* You MUST specify the DAI name within the codec */
723 	struct snd_soc_dai_link_component *codecs;
724 	unsigned int num_codecs;
725 
726 	/* num_ch_maps = max(num_cpu, num_codecs) */
727 	struct snd_soc_dai_link_ch_map *ch_maps;
728 
729 	/*
730 	 * You MAY specify the link's platform/PCM/DMA driver, either by
731 	 * device name, or by DT/OF node, but not both. Some forms of link
732 	 * do not need a platform. In such case, platforms are not mandatory.
733 	 */
734 	struct snd_soc_dai_link_component *platforms;
735 	unsigned int num_platforms;
736 
737 	int id;	/* optional ID for machine driver link identification */
738 
739 	/*
740 	 * for Codec2Codec
741 	 */
742 	const struct snd_soc_pcm_stream *c2c_params;
743 	unsigned int num_c2c_params;
744 
745 	unsigned int dai_fmt;           /* format to set on init */
746 
747 	enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
748 
749 	/* codec/machine specific init - e.g. add machine controls */
750 	int (*init)(struct snd_soc_pcm_runtime *rtd);
751 
752 	/* codec/machine specific exit - dual of init() */
753 	void (*exit)(struct snd_soc_pcm_runtime *rtd);
754 
755 	/* optional hw_params re-writing for BE and FE sync */
756 	int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
757 			struct snd_pcm_hw_params *params);
758 
759 	/* machine stream operations */
760 	const struct snd_soc_ops *ops;
761 	const struct snd_soc_compr_ops *compr_ops;
762 
763 	/*
764 	 * soc_pcm_trigger() start/stop sequence.
765 	 * see also
766 	 *	snd_soc_component_driver
767 	 *	soc_pcm_trigger()
768 	 */
769 	enum snd_soc_trigger_order trigger_start;
770 	enum snd_soc_trigger_order trigger_stop;
771 
772 	/* Mark this pcm with non atomic ops */
773 	unsigned int nonatomic:1;
774 
775 	/* For unidirectional dai links */
776 	unsigned int playback_only:1;
777 	unsigned int capture_only:1;
778 
779 	/* Keep DAI active over suspend */
780 	unsigned int ignore_suspend:1;
781 
782 	/* Symmetry requirements */
783 	unsigned int symmetric_rate:1;
784 	unsigned int symmetric_channels:1;
785 	unsigned int symmetric_sample_bits:1;
786 
787 	/* Do not create a PCM for this DAI link (Backend link) */
788 	unsigned int no_pcm:1;
789 
790 	/* This DAI link can route to other DAI links at runtime (Frontend)*/
791 	unsigned int dynamic:1;
792 
793 	/* DPCM used FE & BE merged format */
794 	unsigned int dpcm_merged_format:1;
795 	/* DPCM used FE & BE merged channel */
796 	unsigned int dpcm_merged_chan:1;
797 	/* DPCM used FE & BE merged rate */
798 	unsigned int dpcm_merged_rate:1;
799 
800 	/* pmdown_time is ignored at stop */
801 	unsigned int ignore_pmdown_time:1;
802 
803 	/* Do not create a PCM for this DAI link (Backend link) */
804 	unsigned int ignore:1;
805 
806 #ifdef CONFIG_SND_SOC_TOPOLOGY
807 	struct snd_soc_dobj dobj; /* For topology */
808 #endif
809 };
810 
811 static inline int snd_soc_link_num_ch_map(const struct snd_soc_dai_link *link)
812 {
813 	return max(link->num_cpus, link->num_codecs);
814 }
815 
816 static inline struct snd_soc_dai_link_component*
817 snd_soc_link_to_cpu(struct snd_soc_dai_link *link, int n) {
818 	return &(link)->cpus[n];
819 }
820 
821 static inline struct snd_soc_dai_link_component*
822 snd_soc_link_to_codec(struct snd_soc_dai_link *link, int n) {
823 	return &(link)->codecs[n];
824 }
825 
826 static inline struct snd_soc_dai_link_component*
827 snd_soc_link_to_platform(struct snd_soc_dai_link *link, int n) {
828 	return &(link)->platforms[n];
829 }
830 
831 #define for_each_link_codecs(link, i, codec)				\
832 	for ((i) = 0;							\
833 	     ((i) < link->num_codecs) &&				\
834 		     ((codec) = snd_soc_link_to_codec(link, i));		\
835 	     (i)++)
836 
837 #define for_each_link_platforms(link, i, platform)			\
838 	for ((i) = 0;							\
839 	     ((i) < link->num_platforms) &&				\
840 		     ((platform) = snd_soc_link_to_platform(link, i));	\
841 	     (i)++)
842 
843 #define for_each_link_cpus(link, i, cpu)				\
844 	for ((i) = 0;							\
845 	     ((i) < link->num_cpus) &&					\
846 		     ((cpu) = snd_soc_link_to_cpu(link, i));		\
847 	     (i)++)
848 
849 #define for_each_link_ch_maps(link, i, ch_map)			\
850 	for ((i) = 0;						\
851 	     ((i) < snd_soc_link_num_ch_map(link) &&		\
852 		      ((ch_map) = link->ch_maps + i));		\
853 	     (i)++)
854 
855 /*
856  * Sample 1 : Single CPU/Codec/Platform
857  *
858  * SND_SOC_DAILINK_DEFS(test,
859  *	DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai")),
860  *	DAILINK_COMP_ARRAY(COMP_CODEC("codec", "codec_dai")),
861  *	DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
862  *
863  * struct snd_soc_dai_link link = {
864  *	...
865  *	SND_SOC_DAILINK_REG(test),
866  * };
867  *
868  * Sample 2 : Multi CPU/Codec, no Platform
869  *
870  * SND_SOC_DAILINK_DEFS(test,
871  *	DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
872  *			   COMP_CPU("cpu_dai2")),
873  *	DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
874  *			   COMP_CODEC("codec2", "codec_dai2")));
875  *
876  * struct snd_soc_dai_link link = {
877  *	...
878  *	SND_SOC_DAILINK_REG(test),
879  * };
880  *
881  * Sample 3 : Define each CPU/Codec/Platform manually
882  *
883  * SND_SOC_DAILINK_DEF(test_cpu,
884  *		DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
885  *				   COMP_CPU("cpu_dai2")));
886  * SND_SOC_DAILINK_DEF(test_codec,
887  *		DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
888  *				   COMP_CODEC("codec2", "codec_dai2")));
889  * SND_SOC_DAILINK_DEF(test_platform,
890  *		DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
891  *
892  * struct snd_soc_dai_link link = {
893  *	...
894  *	SND_SOC_DAILINK_REG(test_cpu,
895  *			    test_codec,
896  *			    test_platform),
897  * };
898  *
899  * Sample 4 : Sample3 without platform
900  *
901  * struct snd_soc_dai_link link = {
902  *	...
903  *	SND_SOC_DAILINK_REG(test_cpu,
904  *			    test_codec);
905  * };
906  */
907 
908 #define SND_SOC_DAILINK_REG1(name)	 SND_SOC_DAILINK_REG3(name##_cpus, name##_codecs, name##_platforms)
909 #define SND_SOC_DAILINK_REG2(cpu, codec) SND_SOC_DAILINK_REG3(cpu, codec, null_dailink_component)
910 #define SND_SOC_DAILINK_REG3(cpu, codec, platform)	\
911 	.cpus		= cpu,				\
912 	.num_cpus	= ARRAY_SIZE(cpu),		\
913 	.codecs		= codec,			\
914 	.num_codecs	= ARRAY_SIZE(codec),		\
915 	.platforms	= platform,			\
916 	.num_platforms	= ARRAY_SIZE(platform)
917 
918 #define SND_SOC_DAILINK_REG(...) \
919 	CONCATENATE(SND_SOC_DAILINK_REG, COUNT_ARGS(__VA_ARGS__))(__VA_ARGS__)
920 
921 #define SND_SOC_DAILINK_DEF(name, def...)		\
922 	static struct snd_soc_dai_link_component name[]	= { def }
923 
924 #define SND_SOC_DAILINK_DEFS(name, cpu, codec, platform...)	\
925 	SND_SOC_DAILINK_DEF(name##_cpus, cpu);			\
926 	SND_SOC_DAILINK_DEF(name##_codecs, codec);		\
927 	SND_SOC_DAILINK_DEF(name##_platforms, platform)
928 
929 #define DAILINK_COMP_ARRAY(param...)	param
930 #define COMP_EMPTY()			{ }
931 #define COMP_CPU(_dai)			{ .dai_name = _dai, }
932 #define COMP_CODEC(_name, _dai)		{ .name = _name, .dai_name = _dai, }
933 #define COMP_PLATFORM(_name)		{ .name = _name }
934 #define COMP_AUX(_name)			{ .name = _name }
935 #define COMP_CODEC_CONF(_name)		{ .name = _name }
936 #define COMP_DUMMY()			/* see snd_soc_fill_dummy_dai() */
937 
938 extern struct snd_soc_dai_link_component null_dailink_component[0];
939 extern struct snd_soc_dai_link_component snd_soc_dummy_dlc;
940 int snd_soc_dlc_is_dummy(struct snd_soc_dai_link_component *dlc);
941 
942 struct snd_soc_codec_conf {
943 	/*
944 	 * specify device either by device name, or by
945 	 * DT/OF node, but not both.
946 	 */
947 	struct snd_soc_dai_link_component dlc;
948 
949 	/*
950 	 * optional map of kcontrol, widget and path name prefixes that are
951 	 * associated per device
952 	 */
953 	const char *name_prefix;
954 };
955 
956 struct snd_soc_aux_dev {
957 	/*
958 	 * specify multi-codec either by device name, or by
959 	 * DT/OF node, but not both.
960 	 */
961 	struct snd_soc_dai_link_component dlc;
962 
963 	/* codec/machine specific init - e.g. add machine controls */
964 	int (*init)(struct snd_soc_component *component);
965 };
966 
967 /* SoC card */
968 struct snd_soc_card {
969 	const char *name;
970 	const char *long_name;
971 	const char *driver_name;
972 	const char *components;
973 #ifdef CONFIG_DMI
974 	char dmi_longname[80];
975 #endif /* CONFIG_DMI */
976 
977 #ifdef CONFIG_PCI
978 	/*
979 	 * PCI does not define 0 as invalid, so pci_subsystem_set indicates
980 	 * whether a value has been written to these fields.
981 	 */
982 	unsigned short pci_subsystem_vendor;
983 	unsigned short pci_subsystem_device;
984 	bool pci_subsystem_set;
985 #endif /* CONFIG_PCI */
986 
987 	char topology_shortname[32];
988 
989 	struct device *dev;
990 	struct snd_card *snd_card;
991 	struct module *owner;
992 
993 	struct mutex mutex;
994 	struct mutex dapm_mutex;
995 
996 	/* Mutex for PCM operations */
997 	struct mutex pcm_mutex;
998 
999 	int (*probe)(struct snd_soc_card *card);
1000 	int (*late_probe)(struct snd_soc_card *card);
1001 	void (*fixup_controls)(struct snd_soc_card *card);
1002 	int (*remove)(struct snd_soc_card *card);
1003 
1004 	/* the pre and post PM functions are used to do any PM work before and
1005 	 * after the codec and DAI's do any PM work. */
1006 	int (*suspend_pre)(struct snd_soc_card *card);
1007 	int (*suspend_post)(struct snd_soc_card *card);
1008 	int (*resume_pre)(struct snd_soc_card *card);
1009 	int (*resume_post)(struct snd_soc_card *card);
1010 
1011 	/* callbacks */
1012 	int (*set_bias_level)(struct snd_soc_card *,
1013 			      struct snd_soc_dapm_context *dapm,
1014 			      enum snd_soc_bias_level level);
1015 	int (*set_bias_level_post)(struct snd_soc_card *,
1016 				   struct snd_soc_dapm_context *dapm,
1017 				   enum snd_soc_bias_level level);
1018 
1019 	int (*add_dai_link)(struct snd_soc_card *,
1020 			    struct snd_soc_dai_link *link);
1021 	void (*remove_dai_link)(struct snd_soc_card *,
1022 			    struct snd_soc_dai_link *link);
1023 
1024 	long pmdown_time;
1025 
1026 	/* CPU <--> Codec DAI links  */
1027 	struct snd_soc_dai_link *dai_link;  /* predefined links only */
1028 	int num_links;  /* predefined links only */
1029 
1030 	struct list_head rtd_list;
1031 	int num_rtd;
1032 
1033 	/* optional codec specific configuration */
1034 	struct snd_soc_codec_conf *codec_conf;
1035 	int num_configs;
1036 
1037 	/*
1038 	 * optional auxiliary devices such as amplifiers or codecs with DAI
1039 	 * link unused
1040 	 */
1041 	struct snd_soc_aux_dev *aux_dev;
1042 	int num_aux_devs;
1043 	struct list_head aux_comp_list;
1044 
1045 	const struct snd_kcontrol_new *controls;
1046 	int num_controls;
1047 
1048 	/*
1049 	 * Card-specific routes and widgets.
1050 	 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1051 	 */
1052 	const struct snd_soc_dapm_widget *dapm_widgets;
1053 	int num_dapm_widgets;
1054 	const struct snd_soc_dapm_route *dapm_routes;
1055 	int num_dapm_routes;
1056 	const struct snd_soc_dapm_widget *of_dapm_widgets;
1057 	int num_of_dapm_widgets;
1058 	const struct snd_soc_dapm_route *of_dapm_routes;
1059 	int num_of_dapm_routes;
1060 
1061 	/* lists of probed devices belonging to this card */
1062 	struct list_head component_dev_list;
1063 	struct list_head list;
1064 
1065 	struct list_head widgets;
1066 	struct list_head paths;
1067 	struct list_head dapm_list;
1068 	struct list_head dapm_dirty;
1069 
1070 	/* attached dynamic objects */
1071 	struct list_head dobj_list;
1072 
1073 	/* Generic DAPM context for the card */
1074 	struct snd_soc_dapm_context *dapm;
1075 	struct snd_soc_dapm_stats dapm_stats;
1076 
1077 #ifdef CONFIG_DEBUG_FS
1078 	struct dentry *debugfs_card_root;
1079 #endif
1080 #ifdef CONFIG_PM_SLEEP
1081 	struct work_struct deferred_resume_work;
1082 #endif
1083 	u32 pop_time;
1084 
1085 	/* bit field */
1086 	unsigned int instantiated:1;
1087 	unsigned int topology_shortname_created:1;
1088 	unsigned int fully_routed:1;
1089 	unsigned int probed:1;
1090 	unsigned int component_chaining:1;
1091 	struct device *devres_dev;
1092 
1093 	void *drvdata;
1094 };
1095 #define for_each_card_prelinks(card, i, link)				\
1096 	for ((i) = 0;							\
1097 	     ((i) < (card)->num_links) && ((link) = &(card)->dai_link[i]); \
1098 	     (i)++)
1099 #define for_each_card_pre_auxs(card, i, aux)				\
1100 	for ((i) = 0;							\
1101 	     ((i) < (card)->num_aux_devs) && ((aux) = &(card)->aux_dev[i]); \
1102 	     (i)++)
1103 
1104 #define for_each_card_rtds(card, rtd)			\
1105 	list_for_each_entry(rtd, &(card)->rtd_list, list)
1106 #define for_each_card_rtds_safe(card, rtd, _rtd)	\
1107 	list_for_each_entry_safe(rtd, _rtd, &(card)->rtd_list, list)
1108 
1109 #define for_each_card_auxs(card, component)			\
1110 	list_for_each_entry(component, &card->aux_comp_list, card_aux_list)
1111 #define for_each_card_auxs_safe(card, component, _comp)	\
1112 	list_for_each_entry_safe(component, _comp,	\
1113 				 &card->aux_comp_list, card_aux_list)
1114 
1115 #define for_each_card_components(card, component)			\
1116 	list_for_each_entry(component, &(card)->component_dev_list, card_list)
1117 
1118 #define for_each_card_dapms(card, dapm)					\
1119 	list_for_each_entry(dapm, &card->dapm_list, list)
1120 
1121 #define for_each_card_widgets(card, w)\
1122 	list_for_each_entry(w, &card->widgets, list)
1123 #define for_each_card_widgets_safe(card, w, _w)	\
1124 	list_for_each_entry_safe(w, _w, &card->widgets, list)
1125 
1126 
1127 static inline int snd_soc_card_is_instantiated(struct snd_soc_card *card)
1128 {
1129 	return card && card->instantiated;
1130 }
1131 
1132 static inline struct snd_soc_dapm_context *snd_soc_card_to_dapm(struct snd_soc_card *card)
1133 {
1134 	return card->dapm;
1135 }
1136 
1137 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1138 struct snd_soc_pcm_runtime {
1139 	struct device *dev;
1140 	struct snd_soc_card *card;
1141 	struct snd_soc_dai_link *dai_link;
1142 	struct snd_pcm_ops ops;
1143 
1144 	unsigned int c2c_params_select; /* currently selected c2c_param for dai link */
1145 
1146 	/* Dynamic PCM BE runtime data */
1147 	struct snd_soc_dpcm_runtime dpcm[SNDRV_PCM_STREAM_LAST + 1];
1148 	struct snd_soc_dapm_widget *c2c_widget[SNDRV_PCM_STREAM_LAST + 1];
1149 
1150 	long pmdown_time;
1151 
1152 	/* runtime devices */
1153 	struct snd_pcm *pcm;
1154 	struct snd_compr *compr;
1155 
1156 	/*
1157 	 * dais = cpu_dai + codec_dai
1158 	 * see
1159 	 *	soc_new_pcm_runtime()
1160 	 *	snd_soc_rtd_to_cpu()
1161 	 *	snd_soc_rtd_to_codec()
1162 	 */
1163 	struct snd_soc_dai **dais;
1164 
1165 	struct delayed_work delayed_work;
1166 	void (*close_delayed_work_func)(struct snd_soc_pcm_runtime *rtd);
1167 #ifdef CONFIG_DEBUG_FS
1168 	struct dentry *debugfs_dpcm_root;
1169 #endif
1170 
1171 	unsigned int id; /* 0-based and monotonic increasing */
1172 	struct list_head list; /* rtd list of the soc card */
1173 
1174 	/* function mark */
1175 	struct snd_pcm_substream *mark_startup;
1176 	struct snd_pcm_substream *mark_hw_params;
1177 	struct snd_pcm_substream *mark_trigger;
1178 	struct snd_compr_stream  *mark_compr_startup;
1179 
1180 	/* bit field */
1181 	unsigned int pop_wait:1;
1182 	unsigned int fe_compr:1; /* for Dynamic PCM */
1183 	unsigned int initialized:1;
1184 
1185 	/* CPU/Codec/Platform */
1186 	int num_components;
1187 	struct snd_soc_component *components[] __counted_by(num_components);
1188 };
1189 
1190 /* see soc_new_pcm_runtime()  */
1191 #define snd_soc_rtd_to_cpu(rtd, n)   (rtd)->dais[n]
1192 #define snd_soc_rtd_to_codec(rtd, n) (rtd)->dais[n + (rtd)->dai_link->num_cpus]
1193 
1194 static inline struct snd_soc_pcm_runtime *
1195 snd_soc_substream_to_rtd(const struct snd_pcm_substream *substream)
1196 {
1197 	return snd_pcm_substream_chip(substream);
1198 }
1199 
1200 #define for_each_rtd_components(rtd, i, component)			\
1201 	for ((i) = 0, component = NULL;					\
1202 	     ((i) < rtd->num_components) && ((component) = rtd->components[i]);\
1203 	     (i)++)
1204 #define for_each_rtd_cpu_dais(rtd, i, dai)				\
1205 	for ((i) = 0;							\
1206 	     ((i) < rtd->dai_link->num_cpus) && ((dai) = snd_soc_rtd_to_cpu(rtd, i)); \
1207 	     (i)++)
1208 #define for_each_rtd_codec_dais(rtd, i, dai)				\
1209 	for ((i) = 0;							\
1210 	     ((i) < rtd->dai_link->num_codecs) && ((dai) = snd_soc_rtd_to_codec(rtd, i)); \
1211 	     (i)++)
1212 #define for_each_rtd_dais(rtd, i, dai)					\
1213 	for ((i) = 0;							\
1214 	     ((i) < (rtd)->dai_link->num_cpus + (rtd)->dai_link->num_codecs) &&	\
1215 		     ((dai) = (rtd)->dais[i]);				\
1216 	     (i)++)
1217 #define for_each_rtd_dais_reverse(rtd, i, dai)					\
1218 	for ((i) = (rtd)->dai_link->num_cpus + (rtd)->dai_link->num_codecs - 1;	\
1219 	     (i) >= 0 && ((dai) = (rtd)->dais[i]);				\
1220 	     (i)--)
1221 #define for_each_rtd_ch_maps(rtd, i, ch_maps) for_each_link_ch_maps(rtd->dai_link, i, ch_maps)
1222 
1223 void snd_soc_close_delayed_work(struct snd_soc_pcm_runtime *rtd);
1224 
1225 /* mixer control */
1226 struct soc_mixer_control {
1227 	/* Minimum and maximum specified as written to the hardware */
1228 	int min, max;
1229 	/* Limited maximum value specified as presented through the control */
1230 	int platform_max;
1231 	int reg, rreg;
1232 	unsigned int shift, rshift;
1233 	u32 num_channels;
1234 	unsigned int sign_bit;
1235 	unsigned int invert:1;
1236 	unsigned int autodisable:1;
1237 #ifdef CONFIG_SND_SOC_TOPOLOGY
1238 	struct snd_soc_dobj dobj;
1239 #endif
1240 };
1241 
1242 struct soc_bytes {
1243 	int base;
1244 	int num_regs;
1245 	u32 mask;
1246 };
1247 
1248 struct soc_bytes_ext {
1249 	int max;
1250 #ifdef CONFIG_SND_SOC_TOPOLOGY
1251 	struct snd_soc_dobj dobj;
1252 #endif
1253 	/* used for TLV byte control */
1254 	int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1255 			unsigned int size);
1256 	int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1257 			unsigned int size);
1258 };
1259 
1260 /* multi register control */
1261 struct soc_mreg_control {
1262 	long min, max;
1263 	unsigned int regbase, regcount, nbits, invert;
1264 };
1265 
1266 /* enumerated kcontrol */
1267 struct soc_enum {
1268 	int reg;
1269 	unsigned char shift_l;
1270 	unsigned char shift_r;
1271 	unsigned int items;
1272 	unsigned int mask;
1273 	const char * const *texts;
1274 	const unsigned int *values;
1275 	unsigned int autodisable:1;
1276 #ifdef CONFIG_SND_SOC_TOPOLOGY
1277 	struct snd_soc_dobj dobj;
1278 #endif
1279 };
1280 
1281 static inline bool snd_soc_volsw_is_stereo(const struct soc_mixer_control *mc)
1282 {
1283 	if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1284 		return false;
1285 	/*
1286 	 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1287 	 * mc->reg != mc->rreg means that the control is
1288 	 * stereo (bits in one register or in two registers)
1289 	 */
1290 	return true;
1291 }
1292 
1293 static inline unsigned int snd_soc_enum_val_to_item(const struct soc_enum *e,
1294 	unsigned int val)
1295 {
1296 	unsigned int i;
1297 
1298 	if (!e->values)
1299 		return val;
1300 
1301 	for (i = 0; i < e->items; i++)
1302 		if (val == e->values[i])
1303 			return i;
1304 
1305 	return 0;
1306 }
1307 
1308 static inline unsigned int snd_soc_enum_item_to_val(const struct soc_enum *e,
1309 	unsigned int item)
1310 {
1311 	if (!e->values)
1312 		return item;
1313 
1314 	return e->values[item];
1315 }
1316 
1317 int snd_soc_util_init(void);
1318 void snd_soc_util_exit(void);
1319 
1320 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1321 			       const char *propname);
1322 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1323 					  const char *propname);
1324 int snd_soc_of_parse_pin_switches(struct snd_soc_card *card, const char *prop);
1325 int snd_soc_of_get_slot_mask(struct device_node *np,
1326 			     const char *prop_name,
1327 			     unsigned int *mask);
1328 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1329 			      unsigned int *tx_mask,
1330 			      unsigned int *rx_mask,
1331 			      unsigned int *slots,
1332 			      unsigned int *slot_width);
1333 void snd_soc_of_parse_node_prefix(struct device_node *np,
1334 				   struct snd_soc_codec_conf *codec_conf,
1335 				   struct device_node *of_node,
1336 				   const char *propname);
1337 static inline
1338 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1339 				   struct snd_soc_codec_conf *codec_conf,
1340 				   struct device_node *of_node,
1341 				   const char *propname)
1342 {
1343 	snd_soc_of_parse_node_prefix(card->dev->of_node,
1344 				     codec_conf, of_node, propname);
1345 }
1346 
1347 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1348 				   const char *propname);
1349 int snd_soc_of_parse_aux_devs(struct snd_soc_card *card, const char *propname);
1350 
1351 unsigned int snd_soc_daifmt_clock_provider_flipped(unsigned int dai_fmt);
1352 unsigned int snd_soc_daifmt_clock_provider_from_bitmap(unsigned int bit_frame);
1353 
1354 unsigned int snd_soc_daifmt_parse_format(struct device_node *np, const char *prefix);
1355 unsigned int snd_soc_daifmt_parse_clock_provider_raw(struct device_node *np,
1356 						     const char *prefix,
1357 						     struct device_node **bitclkmaster,
1358 						     struct device_node **framemaster);
1359 #define snd_soc_daifmt_parse_clock_provider_as_bitmap(np, prefix)	\
1360 	snd_soc_daifmt_parse_clock_provider_raw(np, prefix, NULL, NULL)
1361 #define snd_soc_daifmt_parse_clock_provider_as_phandle			\
1362 	snd_soc_daifmt_parse_clock_provider_raw
1363 #define snd_soc_daifmt_parse_clock_provider_as_flag(np, prefix)		\
1364 	snd_soc_daifmt_clock_provider_from_bitmap(			\
1365 		snd_soc_daifmt_parse_clock_provider_as_bitmap(np, prefix))
1366 
1367 int snd_soc_get_stream_cpu(const struct snd_soc_dai_link *dai_link, int stream);
1368 int snd_soc_get_dlc(const struct of_phandle_args *args,
1369 		    struct snd_soc_dai_link_component *dlc);
1370 int snd_soc_of_get_dlc(struct device_node *of_node,
1371 		       struct of_phandle_args *args,
1372 		       struct snd_soc_dai_link_component *dlc,
1373 		       int index);
1374 int snd_soc_get_dai_id(struct device_node *ep);
1375 int snd_soc_get_dai_name(const struct of_phandle_args *args,
1376 			 const char **dai_name);
1377 int snd_soc_of_get_dai_name(struct device_node *of_node,
1378 			    const char **dai_name, int index);
1379 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1380 				   struct device_node *of_node,
1381 				   struct snd_soc_dai_link *dai_link);
1382 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link);
1383 int snd_soc_of_get_dai_link_cpus(struct device *dev,
1384 				 struct device_node *of_node,
1385 				 struct snd_soc_dai_link *dai_link);
1386 void snd_soc_of_put_dai_link_cpus(struct snd_soc_dai_link *dai_link);
1387 
1388 int snd_soc_add_pcm_runtimes(struct snd_soc_card *card,
1389 			     struct snd_soc_dai_link *dai_link,
1390 			     int num_dai_link);
1391 void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
1392 				struct snd_soc_pcm_runtime *rtd);
1393 
1394 void snd_soc_dlc_use_cpu_as_platform(struct snd_soc_dai_link_component *platforms,
1395 				     struct snd_soc_dai_link_component *cpus);
1396 struct of_phandle_args *snd_soc_copy_dai_args(struct device *dev,
1397 					      const struct of_phandle_args *args);
1398 struct snd_soc_dai *snd_soc_get_dai_via_args(const struct of_phandle_args *dai_args);
1399 struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
1400 					 struct snd_soc_dai_driver *dai_drv,
1401 					 bool legacy_dai_naming);
1402 void snd_soc_unregister_dai(struct snd_soc_dai *dai);
1403 
1404 struct snd_soc_dai *snd_soc_find_dai(
1405 	const struct snd_soc_dai_link_component *dlc);
1406 struct snd_soc_dai *snd_soc_find_dai_with_mutex(
1407 	const struct snd_soc_dai_link_component *dlc);
1408 
1409 void soc_pcm_set_dai_params(struct snd_soc_dai *dai,
1410 			    struct snd_pcm_hw_params *params);
1411 
1412 #include <sound/soc-dai.h>
1413 
1414 static inline
1415 int snd_soc_fixup_dai_links_platform_name(struct snd_soc_card *card,
1416 					  const char *platform_name)
1417 {
1418 	struct snd_soc_dai_link *dai_link;
1419 	const char *name;
1420 	int i;
1421 
1422 	if (!platform_name) /* nothing to do */
1423 		return 0;
1424 
1425 	/* set platform name for each dailink */
1426 	for_each_card_prelinks(card, i, dai_link) {
1427 		/* only single platform is supported for now */
1428 		if (dai_link->num_platforms != 1)
1429 			return -EINVAL;
1430 
1431 		if (!dai_link->platforms)
1432 			return -EINVAL;
1433 
1434 		name = devm_kstrdup(card->dev, platform_name, GFP_KERNEL);
1435 		if (!name)
1436 			return -ENOMEM;
1437 
1438 		/* only single platform is supported for now */
1439 		dai_link->platforms->name = name;
1440 	}
1441 
1442 	return 0;
1443 }
1444 
1445 #ifdef CONFIG_DEBUG_FS
1446 extern struct dentry *snd_soc_debugfs_root;
1447 #endif
1448 
1449 extern const struct dev_pm_ops snd_soc_pm_ops;
1450 
1451 /*
1452  *	DAPM helper functions
1453  */
1454 enum snd_soc_dapm_subclass {
1455 	SND_SOC_DAPM_CLASS_ROOT		= 0,
1456 	SND_SOC_DAPM_CLASS_RUNTIME	= 1,
1457 };
1458 
1459 static inline void _snd_soc_dapm_mutex_lock_root_c(struct snd_soc_card *card)
1460 {
1461 	mutex_lock_nested(&card->dapm_mutex, SND_SOC_DAPM_CLASS_ROOT);
1462 }
1463 
1464 static inline void _snd_soc_dapm_mutex_lock_c(struct snd_soc_card *card)
1465 {
1466 	mutex_lock_nested(&card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
1467 }
1468 
1469 static inline void _snd_soc_dapm_mutex_unlock_c(struct snd_soc_card *card)
1470 {
1471 	mutex_unlock(&card->dapm_mutex);
1472 }
1473 
1474 static inline void _snd_soc_dapm_mutex_assert_held_c(struct snd_soc_card *card)
1475 {
1476 	lockdep_assert_held(&card->dapm_mutex);
1477 }
1478 
1479 static inline void _snd_soc_dapm_mutex_lock_root_d(struct snd_soc_dapm_context *dapm)
1480 {
1481 	_snd_soc_dapm_mutex_lock_root_c(snd_soc_dapm_to_card(dapm));
1482 }
1483 
1484 static inline void _snd_soc_dapm_mutex_lock_d(struct snd_soc_dapm_context *dapm)
1485 {
1486 	_snd_soc_dapm_mutex_lock_c(snd_soc_dapm_to_card(dapm));
1487 }
1488 
1489 static inline void _snd_soc_dapm_mutex_unlock_d(struct snd_soc_dapm_context *dapm)
1490 {
1491 	_snd_soc_dapm_mutex_unlock_c(snd_soc_dapm_to_card(dapm));
1492 }
1493 
1494 static inline void _snd_soc_dapm_mutex_assert_held_d(struct snd_soc_dapm_context *dapm)
1495 {
1496 	_snd_soc_dapm_mutex_assert_held_c(snd_soc_dapm_to_card(dapm));
1497 }
1498 
1499 #define snd_soc_dapm_mutex_lock_root(x) _Generic((x),			\
1500 	struct snd_soc_card * :		_snd_soc_dapm_mutex_lock_root_c, \
1501 	struct snd_soc_dapm_context * :	_snd_soc_dapm_mutex_lock_root_d)(x)
1502 #define snd_soc_dapm_mutex_lock(x) _Generic((x),			\
1503 	struct snd_soc_card * :		_snd_soc_dapm_mutex_lock_c,	\
1504 	struct snd_soc_dapm_context * :	_snd_soc_dapm_mutex_lock_d)(x)
1505 #define snd_soc_dapm_mutex_unlock(x) _Generic((x),			\
1506 	struct snd_soc_card * :		_snd_soc_dapm_mutex_unlock_c,	\
1507 	struct snd_soc_dapm_context * :	_snd_soc_dapm_mutex_unlock_d)(x)
1508 #define snd_soc_dapm_mutex_assert_held(x) _Generic((x),			\
1509 	struct snd_soc_card * :		_snd_soc_dapm_mutex_assert_held_c, \
1510 	struct snd_soc_dapm_context * :	_snd_soc_dapm_mutex_assert_held_d)(x)
1511 
1512 /*
1513  *	PCM helper functions
1514  */
1515 static inline void _snd_soc_dpcm_mutex_lock_c(struct snd_soc_card *card)
1516 {
1517 	mutex_lock(&card->pcm_mutex);
1518 }
1519 
1520 static inline void _snd_soc_dpcm_mutex_unlock_c(struct snd_soc_card *card)
1521 {
1522 	mutex_unlock(&card->pcm_mutex);
1523 }
1524 
1525 static inline void _snd_soc_dpcm_mutex_assert_held_c(struct snd_soc_card *card)
1526 {
1527 	lockdep_assert_held(&card->pcm_mutex);
1528 }
1529 
1530 static inline void _snd_soc_dpcm_mutex_lock_r(struct snd_soc_pcm_runtime *rtd)
1531 {
1532 	_snd_soc_dpcm_mutex_lock_c(rtd->card);
1533 }
1534 
1535 static inline void _snd_soc_dpcm_mutex_unlock_r(struct snd_soc_pcm_runtime *rtd)
1536 {
1537 	_snd_soc_dpcm_mutex_unlock_c(rtd->card);
1538 }
1539 
1540 static inline void _snd_soc_dpcm_mutex_assert_held_r(struct snd_soc_pcm_runtime *rtd)
1541 {
1542 	_snd_soc_dpcm_mutex_assert_held_c(rtd->card);
1543 }
1544 
1545 #define snd_soc_dpcm_mutex_lock(x) _Generic((x),			\
1546 	 struct snd_soc_card * :	_snd_soc_dpcm_mutex_lock_c,	\
1547 	 struct snd_soc_pcm_runtime * :	_snd_soc_dpcm_mutex_lock_r)(x)
1548 
1549 #define snd_soc_dpcm_mutex_unlock(x) _Generic((x),			\
1550 	 struct snd_soc_card * :	_snd_soc_dpcm_mutex_unlock_c,	\
1551 	 struct snd_soc_pcm_runtime * :	_snd_soc_dpcm_mutex_unlock_r)(x)
1552 
1553 #define snd_soc_dpcm_mutex_assert_held(x) _Generic((x),		\
1554 	struct snd_soc_card * :		_snd_soc_dpcm_mutex_assert_held_c, \
1555 	struct snd_soc_pcm_runtime * :	_snd_soc_dpcm_mutex_assert_held_r)(x)
1556 
1557 #include <sound/soc-component.h>
1558 #include <sound/soc-card.h>
1559 #include <sound/soc-jack.h>
1560 
1561 #endif
1562