xref: /linux/include/sound/soc.h (revision 0787a08ae785366b9473905fc8bf23f165a08b8d)
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 SND_SOC_BYTES(xname, xbase, xregs)		      \
323 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
324 	.info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
325 	.put = snd_soc_bytes_put, .private_value =	      \
326 		((unsigned long)&(struct soc_bytes)           \
327 		{.base = xbase, .num_regs = xregs }) }
328 #define SND_SOC_BYTES_E(xname, xbase, xregs, xhandler_get, xhandler_put) \
329 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
330 	.info = snd_soc_bytes_info, .get = xhandler_get, \
331 	.put = xhandler_put, .private_value = \
332 		((unsigned long)&(struct soc_bytes) \
333 		{.base = xbase, .num_regs = xregs }) }
334 
335 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask)	      \
336 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
337 	.info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
338 	.put = snd_soc_bytes_put, .private_value =	      \
339 		((unsigned long)&(struct soc_bytes)           \
340 		{.base = xbase, .num_regs = xregs,	      \
341 		 .mask = xmask }) }
342 
343 /*
344  * SND_SOC_BYTES_EXT is deprecated, please USE SND_SOC_BYTES_TLV instead
345  */
346 #define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \
347 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
348 	.info = snd_soc_bytes_info_ext, \
349 	.get = xhandler_get, .put = xhandler_put, \
350 	.private_value = (unsigned long)&(struct soc_bytes_ext) \
351 		{.max = xcount} }
352 #define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \
353 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
354 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \
355 		  SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
356 	.tlv.c = (snd_soc_bytes_tlv_callback), \
357 	.info = snd_soc_bytes_info_ext, \
358 	.private_value = (unsigned long)&(struct soc_bytes_ext) \
359 		{.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
360 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
361 		xmin, xmax, xinvert) \
362 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
363 	.info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
364 	.put = snd_soc_put_xr_sx, \
365 	.private_value = (unsigned long)&(struct soc_mreg_control) \
366 		{.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
367 		.invert = xinvert, .min = xmin, .max = xmax} }
368 
369 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
370 	SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
371 		snd_soc_get_strobe, snd_soc_put_strobe)
372 
373 /*
374  * Simplified versions of above macros, declaring a struct and calculating
375  * ARRAY_SIZE internally
376  */
377 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
378 	const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
379 						ARRAY_SIZE(xtexts), xtexts)
380 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
381 	SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
382 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
383 	const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
384 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
385 	const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
386 							ARRAY_SIZE(xtexts), xtexts, xvalues)
387 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
388 	SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
389 
390 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
391 	const struct soc_enum name = SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, \
392 		xshift, xmask, ARRAY_SIZE(xtexts), xtexts, xvalues)
393 
394 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
395 	const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
396 
397 struct snd_jack;
398 struct snd_soc_card;
399 struct snd_soc_pcm_stream;
400 struct snd_soc_ops;
401 struct snd_soc_pcm_runtime;
402 struct snd_soc_dai;
403 struct snd_soc_dai_driver;
404 struct snd_soc_dai_link;
405 struct snd_soc_component;
406 struct snd_soc_component_driver;
407 struct soc_enum;
408 struct snd_soc_jack;
409 struct snd_soc_jack_zone;
410 struct snd_soc_jack_pin;
411 
412 #include <sound/soc-dapm.h>
413 #include <sound/soc-dpcm.h>
414 #include <sound/soc-topology.h>
415 
416 struct snd_soc_jack_gpio;
417 
418 enum snd_soc_pcm_subclass {
419 	SND_SOC_PCM_CLASS_PCM	= 0,
420 	SND_SOC_PCM_CLASS_BE	= 1,
421 };
422 
423 int snd_soc_register_card(struct snd_soc_card *card);
424 void snd_soc_unregister_card(struct snd_soc_card *card);
425 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
426 int devm_snd_soc_register_deferrable_card(struct device *dev, struct snd_soc_card *card);
427 #ifdef CONFIG_PM_SLEEP
428 int snd_soc_suspend(struct device *dev);
429 int snd_soc_resume(struct device *dev);
430 #else
431 static inline int snd_soc_suspend(struct device *dev)
432 {
433 	return 0;
434 }
435 
436 static inline int snd_soc_resume(struct device *dev)
437 {
438 	return 0;
439 }
440 #endif
441 int snd_soc_poweroff(struct device *dev);
442 int snd_soc_component_initialize(struct snd_soc_component *component,
443 				 const struct snd_soc_component_driver *driver,
444 				 struct device *dev);
445 int snd_soc_add_component(struct snd_soc_component *component,
446 			  struct snd_soc_dai_driver *dai_drv,
447 			  int num_dai);
448 int snd_soc_register_component(struct device *dev,
449 			 const struct snd_soc_component_driver *component_driver,
450 			 struct snd_soc_dai_driver *dai_drv, int num_dai);
451 int devm_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 void snd_soc_unregister_component(struct device *dev);
455 void snd_soc_unregister_component_by_driver(struct device *dev,
456 			 const struct snd_soc_component_driver *component_driver);
457 struct snd_soc_component *snd_soc_lookup_component_nolocked(struct device *dev,
458 							    const char *driver_name);
459 struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
460 						   const char *driver_name);
461 
462 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd);
463 #ifdef CONFIG_SND_SOC_COMPRESS
464 int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd);
465 #else
466 static inline int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd)
467 {
468 	return 0;
469 }
470 #endif
471 
472 void snd_soc_disconnect_sync(struct device *dev);
473 
474 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
475 				struct snd_soc_dai_link *dai_link);
476 
477 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
478 
479 void snd_soc_runtime_action(struct snd_soc_pcm_runtime *rtd,
480 			    int stream, int action);
481 static inline void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd,
482 				     int stream)
483 {
484 	snd_soc_runtime_action(rtd, stream, 1);
485 }
486 static inline void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd,
487 				       int stream)
488 {
489 	snd_soc_runtime_action(rtd, stream, -1);
490 }
491 
492 int snd_soc_runtime_calc_hw(struct snd_soc_pcm_runtime *rtd,
493 			    struct snd_pcm_hardware *hw, int stream);
494 
495 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
496 	unsigned int dai_fmt);
497 
498 /* Utility functions to get clock rates from various things */
499 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
500 int snd_soc_params_to_frame_size(const struct snd_pcm_hw_params *params);
501 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
502 int snd_soc_params_to_bclk(const struct snd_pcm_hw_params *parms);
503 int snd_soc_tdm_params_to_bclk(const struct snd_pcm_hw_params *params,
504 			       int tdm_width, int tdm_slots, int slot_multiple);
505 int snd_soc_ret(const struct device *dev, int ret, const char *fmt, ...);
506 
507 /* set runtime hw params */
508 static inline int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
509 					       const struct snd_pcm_hardware *hw)
510 {
511 	substream->runtime->hw = *hw;
512 
513 	return 0;
514 }
515 
516 struct snd_ac97 *snd_soc_alloc_ac97_component(struct snd_soc_component *component);
517 struct snd_ac97 *snd_soc_new_ac97_component(struct snd_soc_component *component,
518 	unsigned int id, unsigned int id_mask);
519 void snd_soc_free_ac97_component(struct snd_ac97 *ac97);
520 
521 #ifdef CONFIG_SND_SOC_AC97_BUS
522 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
523 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
524 		struct platform_device *pdev);
525 
526 extern struct snd_ac97_bus_ops *soc_ac97_ops;
527 #else
528 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
529 	struct platform_device *pdev)
530 {
531 	return 0;
532 }
533 
534 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
535 {
536 	return 0;
537 }
538 #endif
539 
540 /*
541  *Controls
542  */
543 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
544 				  void *data, const char *long_name,
545 				  const char *prefix);
546 int snd_soc_add_component_controls(struct snd_soc_component *component,
547 	const struct snd_kcontrol_new *controls, unsigned int num_controls);
548 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
549 	const struct snd_kcontrol_new *controls, int num_controls);
550 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
551 	const struct snd_kcontrol_new *controls, int num_controls);
552 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
553 	struct snd_ctl_elem_info *uinfo);
554 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
555 	struct snd_ctl_elem_value *ucontrol);
556 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
557 	struct snd_ctl_elem_value *ucontrol);
558 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
559 	struct snd_ctl_elem_info *uinfo);
560 int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol,
561 			  struct snd_ctl_elem_info *uinfo);
562 #define snd_soc_info_bool_ext		snd_ctl_boolean_mono_info
563 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
564 	struct snd_ctl_elem_value *ucontrol);
565 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
566 	struct snd_ctl_elem_value *ucontrol);
567 #define snd_soc_get_volsw_2r snd_soc_get_volsw
568 #define snd_soc_put_volsw_2r snd_soc_put_volsw
569 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
570 	struct snd_ctl_elem_value *ucontrol);
571 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
572 	struct snd_ctl_elem_value *ucontrol);
573 int snd_soc_limit_volume(struct snd_soc_card *card,
574 	const char *name, int max);
575 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
576 		       struct snd_ctl_elem_info *uinfo);
577 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
578 		      struct snd_ctl_elem_value *ucontrol);
579 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
580 		      struct snd_ctl_elem_value *ucontrol);
581 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
582 	struct snd_ctl_elem_info *ucontrol);
583 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
584 	unsigned int size, unsigned int __user *tlv);
585 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
586 	struct snd_ctl_elem_info *uinfo);
587 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
588 	struct snd_ctl_elem_value *ucontrol);
589 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
590 	struct snd_ctl_elem_value *ucontrol);
591 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
592 	struct snd_ctl_elem_value *ucontrol);
593 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
594 	struct snd_ctl_elem_value *ucontrol);
595 
596 enum snd_soc_trigger_order {
597 						/* start			stop		     */
598 	SND_SOC_TRIGGER_ORDER_DEFAULT	= 0,	/* Link->Component->DAI		DAI->Component->Link */
599 	SND_SOC_TRIGGER_ORDER_LDC,		/* Link->DAI->Component		Component->DAI->Link */
600 
601 	SND_SOC_TRIGGER_ORDER_MAX,
602 };
603 
604 /* SoC PCM stream information */
605 struct snd_soc_pcm_stream {
606 	const char *stream_name;
607 	u64 formats;			/* SNDRV_PCM_FMTBIT_* */
608 	u32 subformats;			/* for S32_LE format, SNDRV_PCM_SUBFMTBIT_* */
609 	unsigned int rates;		/* SNDRV_PCM_RATE_* */
610 	unsigned int rate_min;		/* min rate */
611 	unsigned int rate_max;		/* max rate */
612 	unsigned int channels_min;	/* min channels */
613 	unsigned int channels_max;	/* max channels */
614 	unsigned int sig_bits;		/* number of bits of content */
615 };
616 
617 /* SoC audio ops */
618 struct snd_soc_ops {
619 	int (*startup)(struct snd_pcm_substream *);
620 	void (*shutdown)(struct snd_pcm_substream *);
621 	int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
622 	int (*hw_free)(struct snd_pcm_substream *);
623 	int (*prepare)(struct snd_pcm_substream *);
624 	int (*trigger)(struct snd_pcm_substream *, int);
625 };
626 
627 struct snd_soc_compr_ops {
628 	int (*startup)(struct snd_compr_stream *);
629 	void (*shutdown)(struct snd_compr_stream *);
630 	int (*set_params)(struct snd_compr_stream *);
631 };
632 
633 struct snd_soc_component*
634 snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
635 		       const char *driver_name);
636 
637 struct snd_soc_dai_link_component {
638 	const char *name;
639 	struct device_node *of_node;
640 	const char *dai_name;
641 	const struct of_phandle_args *dai_args;
642 
643 	/*
644 	 * Extra format = SND_SOC_DAIFMT_Bx_Fx
645 	 *
646 	 * [Note] it is Bx_Fx base, not CBx_CFx
647 	 *
648 	 * It will be used with dai_link->dai_fmt
649 	 * see
650 	 *	snd_soc_runtime_set_dai_fmt()
651 	 */
652 	unsigned int ext_fmt;
653 };
654 
655 /*
656  * [dai_link->ch_maps Image sample]
657  *
658  *-------------------------
659  * CPU0 <---> Codec0
660  *
661  * ch-map[0].cpu = 0	ch-map[0].codec = 0
662  *
663  *-------------------------
664  * CPU0 <---> Codec0
665  * CPU1 <---> Codec1
666  * CPU2 <---> Codec2
667  *
668  * ch-map[0].cpu = 0	ch-map[0].codec = 0
669  * ch-map[1].cpu = 1	ch-map[1].codec = 1
670  * ch-map[2].cpu = 2	ch-map[2].codec = 2
671  *
672  *-------------------------
673  * CPU0 <---> Codec0
674  * CPU1 <-+-> Codec1
675  * CPU2 <-/
676  *
677  * ch-map[0].cpu = 0	ch-map[0].codec = 0
678  * ch-map[1].cpu = 1	ch-map[1].codec = 1
679  * ch-map[2].cpu = 2	ch-map[2].codec = 1
680  *
681  *-------------------------
682  * CPU0 <---> Codec0
683  * CPU1 <-+-> Codec1
684  *	  \-> Codec2
685  *
686  * ch-map[0].cpu = 0	ch-map[0].codec = 0
687  * ch-map[1].cpu = 1	ch-map[1].codec = 1
688  * ch-map[2].cpu = 1	ch-map[2].codec = 2
689  *
690  */
691 struct snd_soc_dai_link_ch_map {
692 	unsigned int cpu;
693 	unsigned int codec;
694 	unsigned int ch_mask;
695 };
696 
697 struct snd_soc_dai_link {
698 	/* config - must be set by machine driver */
699 	const char *name;			/* Codec name */
700 	const char *stream_name;		/* Stream name */
701 
702 	/*
703 	 * You MAY specify the link's CPU-side device, either by device name,
704 	 * or by DT/OF node, but not both. If this information is omitted,
705 	 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
706 	 * must be globally unique. These fields are currently typically used
707 	 * only for codec to codec links, or systems using device tree.
708 	 */
709 	/*
710 	 * You MAY specify the DAI name of the CPU DAI. If this information is
711 	 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
712 	 * only, which only works well when that device exposes a single DAI.
713 	 */
714 	struct snd_soc_dai_link_component *cpus;
715 	unsigned int num_cpus;
716 
717 	/*
718 	 * You MUST specify the link's codec, either by device name, or by
719 	 * DT/OF node, but not both.
720 	 */
721 	/* You MUST specify the DAI name within the codec */
722 	struct snd_soc_dai_link_component *codecs;
723 	unsigned int num_codecs;
724 
725 	/* num_ch_maps = max(num_cpu, num_codecs) */
726 	struct snd_soc_dai_link_ch_map *ch_maps;
727 
728 	/*
729 	 * You MAY specify the link's platform/PCM/DMA driver, either by
730 	 * device name, or by DT/OF node, but not both. Some forms of link
731 	 * do not need a platform. In such case, platforms are not mandatory.
732 	 */
733 	struct snd_soc_dai_link_component *platforms;
734 	unsigned int num_platforms;
735 
736 	int id;	/* optional ID for machine driver link identification */
737 
738 	/*
739 	 * for Codec2Codec
740 	 */
741 	const struct snd_soc_pcm_stream *c2c_params;
742 	unsigned int num_c2c_params;
743 
744 	unsigned int dai_fmt;           /* format to set on init */
745 
746 	enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
747 
748 	/* codec/machine specific init - e.g. add machine controls */
749 	int (*init)(struct snd_soc_pcm_runtime *rtd);
750 
751 	/* codec/machine specific exit - dual of init() */
752 	void (*exit)(struct snd_soc_pcm_runtime *rtd);
753 
754 	/* optional hw_params re-writing for BE and FE sync */
755 	int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
756 			struct snd_pcm_hw_params *params);
757 
758 	/* machine stream operations */
759 	const struct snd_soc_ops *ops;
760 	const struct snd_soc_compr_ops *compr_ops;
761 
762 	/*
763 	 * soc_pcm_trigger() start/stop sequence.
764 	 * see also
765 	 *	snd_soc_component_driver
766 	 *	soc_pcm_trigger()
767 	 */
768 	enum snd_soc_trigger_order trigger_start;
769 	enum snd_soc_trigger_order trigger_stop;
770 
771 	/* Mark this pcm with non atomic ops */
772 	unsigned int nonatomic:1;
773 
774 	/* For unidirectional dai links */
775 	unsigned int playback_only:1;
776 	unsigned int capture_only:1;
777 
778 	/* Keep DAI active over suspend */
779 	unsigned int ignore_suspend:1;
780 
781 	/* Symmetry requirements */
782 	unsigned int symmetric_rate:1;
783 	unsigned int symmetric_channels:1;
784 	unsigned int symmetric_sample_bits:1;
785 
786 	/* Do not create a PCM for this DAI link (Backend link) */
787 	unsigned int no_pcm:1;
788 
789 	/* This DAI link can route to other DAI links at runtime (Frontend)*/
790 	unsigned int dynamic:1;
791 
792 	/* DPCM used FE & BE merged format */
793 	unsigned int dpcm_merged_format:1;
794 	/* DPCM used FE & BE merged channel */
795 	unsigned int dpcm_merged_chan:1;
796 	/* DPCM used FE & BE merged rate */
797 	unsigned int dpcm_merged_rate:1;
798 
799 	/* pmdown_time is ignored at stop */
800 	unsigned int ignore_pmdown_time:1;
801 
802 	/* Do not create a PCM for this DAI link (Backend link) */
803 	unsigned int ignore:1;
804 
805 #ifdef CONFIG_SND_SOC_TOPOLOGY
806 	struct snd_soc_dobj dobj; /* For topology */
807 #endif
808 };
809 
810 static inline int snd_soc_link_num_ch_map(const struct snd_soc_dai_link *link)
811 {
812 	return max(link->num_cpus, link->num_codecs);
813 }
814 
815 static inline struct snd_soc_dai_link_component*
816 snd_soc_link_to_cpu(struct snd_soc_dai_link *link, int n) {
817 	return &(link)->cpus[n];
818 }
819 
820 static inline struct snd_soc_dai_link_component*
821 snd_soc_link_to_codec(struct snd_soc_dai_link *link, int n) {
822 	return &(link)->codecs[n];
823 }
824 
825 static inline struct snd_soc_dai_link_component*
826 snd_soc_link_to_platform(struct snd_soc_dai_link *link, int n) {
827 	return &(link)->platforms[n];
828 }
829 
830 #define for_each_link_codecs(link, i, codec)				\
831 	for ((i) = 0;							\
832 	     ((i) < link->num_codecs) &&				\
833 		     ((codec) = snd_soc_link_to_codec(link, i));		\
834 	     (i)++)
835 
836 #define for_each_link_platforms(link, i, platform)			\
837 	for ((i) = 0;							\
838 	     ((i) < link->num_platforms) &&				\
839 		     ((platform) = snd_soc_link_to_platform(link, i));	\
840 	     (i)++)
841 
842 #define for_each_link_cpus(link, i, cpu)				\
843 	for ((i) = 0;							\
844 	     ((i) < link->num_cpus) &&					\
845 		     ((cpu) = snd_soc_link_to_cpu(link, i));		\
846 	     (i)++)
847 
848 #define for_each_link_ch_maps(link, i, ch_map)			\
849 	for ((i) = 0;						\
850 	     ((i) < snd_soc_link_num_ch_map(link) &&		\
851 		      ((ch_map) = link->ch_maps + i));		\
852 	     (i)++)
853 
854 /*
855  * Sample 1 : Single CPU/Codec/Platform
856  *
857  * SND_SOC_DAILINK_DEFS(test,
858  *	DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai")),
859  *	DAILINK_COMP_ARRAY(COMP_CODEC("codec", "codec_dai")),
860  *	DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
861  *
862  * struct snd_soc_dai_link link = {
863  *	...
864  *	SND_SOC_DAILINK_REG(test),
865  * };
866  *
867  * Sample 2 : Multi CPU/Codec, no Platform
868  *
869  * SND_SOC_DAILINK_DEFS(test,
870  *	DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
871  *			   COMP_CPU("cpu_dai2")),
872  *	DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
873  *			   COMP_CODEC("codec2", "codec_dai2")));
874  *
875  * struct snd_soc_dai_link link = {
876  *	...
877  *	SND_SOC_DAILINK_REG(test),
878  * };
879  *
880  * Sample 3 : Define each CPU/Codec/Platform manually
881  *
882  * SND_SOC_DAILINK_DEF(test_cpu,
883  *		DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
884  *				   COMP_CPU("cpu_dai2")));
885  * SND_SOC_DAILINK_DEF(test_codec,
886  *		DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
887  *				   COMP_CODEC("codec2", "codec_dai2")));
888  * SND_SOC_DAILINK_DEF(test_platform,
889  *		DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
890  *
891  * struct snd_soc_dai_link link = {
892  *	...
893  *	SND_SOC_DAILINK_REG(test_cpu,
894  *			    test_codec,
895  *			    test_platform),
896  * };
897  *
898  * Sample 4 : Sample3 without platform
899  *
900  * struct snd_soc_dai_link link = {
901  *	...
902  *	SND_SOC_DAILINK_REG(test_cpu,
903  *			    test_codec);
904  * };
905  */
906 
907 #define SND_SOC_DAILINK_REG1(name)	 SND_SOC_DAILINK_REG3(name##_cpus, name##_codecs, name##_platforms)
908 #define SND_SOC_DAILINK_REG2(cpu, codec) SND_SOC_DAILINK_REG3(cpu, codec, null_dailink_component)
909 #define SND_SOC_DAILINK_REG3(cpu, codec, platform)	\
910 	.cpus		= cpu,				\
911 	.num_cpus	= ARRAY_SIZE(cpu),		\
912 	.codecs		= codec,			\
913 	.num_codecs	= ARRAY_SIZE(codec),		\
914 	.platforms	= platform,			\
915 	.num_platforms	= ARRAY_SIZE(platform)
916 
917 #define SND_SOC_DAILINK_REG(...) \
918 	CONCATENATE(SND_SOC_DAILINK_REG, COUNT_ARGS(__VA_ARGS__))(__VA_ARGS__)
919 
920 #define SND_SOC_DAILINK_DEF(name, def...)		\
921 	static struct snd_soc_dai_link_component name[]	= { def }
922 
923 #define SND_SOC_DAILINK_DEFS(name, cpu, codec, platform...)	\
924 	SND_SOC_DAILINK_DEF(name##_cpus, cpu);			\
925 	SND_SOC_DAILINK_DEF(name##_codecs, codec);		\
926 	SND_SOC_DAILINK_DEF(name##_platforms, platform)
927 
928 #define DAILINK_COMP_ARRAY(param...)	param
929 #define COMP_EMPTY()			{ }
930 #define COMP_CPU(_dai)			{ .dai_name = _dai, }
931 #define COMP_CODEC(_name, _dai)		{ .name = _name, .dai_name = _dai, }
932 #define COMP_PLATFORM(_name)		{ .name = _name }
933 #define COMP_AUX(_name)			{ .name = _name }
934 #define COMP_CODEC_CONF(_name)		{ .name = _name }
935 #define COMP_DUMMY()			/* see snd_soc_fill_dummy_dai() */
936 
937 extern struct snd_soc_dai_link_component null_dailink_component[0];
938 extern struct snd_soc_dai_link_component snd_soc_dummy_dlc;
939 
940 
941 struct snd_soc_codec_conf {
942 	/*
943 	 * specify device either by device name, or by
944 	 * DT/OF node, but not both.
945 	 */
946 	struct snd_soc_dai_link_component dlc;
947 
948 	/*
949 	 * optional map of kcontrol, widget and path name prefixes that are
950 	 * associated per device
951 	 */
952 	const char *name_prefix;
953 };
954 
955 struct snd_soc_aux_dev {
956 	/*
957 	 * specify multi-codec either by device name, or by
958 	 * DT/OF node, but not both.
959 	 */
960 	struct snd_soc_dai_link_component dlc;
961 
962 	/* codec/machine specific init - e.g. add machine controls */
963 	int (*init)(struct snd_soc_component *component);
964 };
965 
966 /* SoC card */
967 struct snd_soc_card {
968 	const char *name;
969 	const char *long_name;
970 	const char *driver_name;
971 	const char *components;
972 #ifdef CONFIG_DMI
973 	char dmi_longname[80];
974 #endif /* CONFIG_DMI */
975 
976 #ifdef CONFIG_PCI
977 	/*
978 	 * PCI does not define 0 as invalid, so pci_subsystem_set indicates
979 	 * whether a value has been written to these fields.
980 	 */
981 	unsigned short pci_subsystem_vendor;
982 	unsigned short pci_subsystem_device;
983 	bool pci_subsystem_set;
984 #endif /* CONFIG_PCI */
985 
986 	char topology_shortname[32];
987 
988 	struct device *dev;
989 	struct snd_card *snd_card;
990 	struct module *owner;
991 
992 	struct mutex mutex;
993 	struct mutex dapm_mutex;
994 
995 	/* Mutex for PCM operations */
996 	struct mutex pcm_mutex;
997 	enum snd_soc_pcm_subclass pcm_subclass;
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 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1133 struct snd_soc_pcm_runtime {
1134 	struct device *dev;
1135 	struct snd_soc_card *card;
1136 	struct snd_soc_dai_link *dai_link;
1137 	struct snd_pcm_ops ops;
1138 
1139 	unsigned int c2c_params_select; /* currently selected c2c_param for dai link */
1140 
1141 	/* Dynamic PCM BE runtime data */
1142 	struct snd_soc_dpcm_runtime dpcm[SNDRV_PCM_STREAM_LAST + 1];
1143 	struct snd_soc_dapm_widget *c2c_widget[SNDRV_PCM_STREAM_LAST + 1];
1144 
1145 	long pmdown_time;
1146 
1147 	/* runtime devices */
1148 	struct snd_pcm *pcm;
1149 	struct snd_compr *compr;
1150 
1151 	/*
1152 	 * dais = cpu_dai + codec_dai
1153 	 * see
1154 	 *	soc_new_pcm_runtime()
1155 	 *	snd_soc_rtd_to_cpu()
1156 	 *	snd_soc_rtd_to_codec()
1157 	 */
1158 	struct snd_soc_dai **dais;
1159 
1160 	struct delayed_work delayed_work;
1161 	void (*close_delayed_work_func)(struct snd_soc_pcm_runtime *rtd);
1162 #ifdef CONFIG_DEBUG_FS
1163 	struct dentry *debugfs_dpcm_root;
1164 #endif
1165 
1166 	unsigned int id; /* 0-based and monotonic increasing */
1167 	struct list_head list; /* rtd list of the soc card */
1168 
1169 	/* function mark */
1170 	struct snd_pcm_substream *mark_startup;
1171 	struct snd_pcm_substream *mark_hw_params;
1172 	struct snd_pcm_substream *mark_trigger;
1173 	struct snd_compr_stream  *mark_compr_startup;
1174 
1175 	/* bit field */
1176 	unsigned int pop_wait:1;
1177 	unsigned int fe_compr:1; /* for Dynamic PCM */
1178 	unsigned int initialized:1;
1179 
1180 	/* CPU/Codec/Platform */
1181 	int num_components;
1182 	struct snd_soc_component *components[] __counted_by(num_components);
1183 };
1184 
1185 /* see soc_new_pcm_runtime()  */
1186 #define snd_soc_rtd_to_cpu(rtd, n)   (rtd)->dais[n]
1187 #define snd_soc_rtd_to_codec(rtd, n) (rtd)->dais[n + (rtd)->dai_link->num_cpus]
1188 
1189 static inline struct snd_soc_pcm_runtime *
1190 snd_soc_substream_to_rtd(const struct snd_pcm_substream *substream)
1191 {
1192 	return snd_pcm_substream_chip(substream);
1193 }
1194 
1195 #define for_each_rtd_components(rtd, i, component)			\
1196 	for ((i) = 0, component = NULL;					\
1197 	     ((i) < rtd->num_components) && ((component) = rtd->components[i]);\
1198 	     (i)++)
1199 #define for_each_rtd_cpu_dais(rtd, i, dai)				\
1200 	for ((i) = 0;							\
1201 	     ((i) < rtd->dai_link->num_cpus) && ((dai) = snd_soc_rtd_to_cpu(rtd, i)); \
1202 	     (i)++)
1203 #define for_each_rtd_codec_dais(rtd, i, dai)				\
1204 	for ((i) = 0;							\
1205 	     ((i) < rtd->dai_link->num_codecs) && ((dai) = snd_soc_rtd_to_codec(rtd, i)); \
1206 	     (i)++)
1207 #define for_each_rtd_dais(rtd, i, dai)					\
1208 	for ((i) = 0;							\
1209 	     ((i) < (rtd)->dai_link->num_cpus + (rtd)->dai_link->num_codecs) &&	\
1210 		     ((dai) = (rtd)->dais[i]);				\
1211 	     (i)++)
1212 #define for_each_rtd_dais_reverse(rtd, i, dai)					\
1213 	for ((i) = (rtd)->dai_link->num_cpus + (rtd)->dai_link->num_codecs - 1;	\
1214 	     (i) >= 0 && ((dai) = (rtd)->dais[i]);				\
1215 	     (i)--)
1216 #define for_each_rtd_ch_maps(rtd, i, ch_maps) for_each_link_ch_maps(rtd->dai_link, i, ch_maps)
1217 
1218 void snd_soc_close_delayed_work(struct snd_soc_pcm_runtime *rtd);
1219 
1220 /* mixer control */
1221 struct soc_mixer_control {
1222 	/* Minimum and maximum specified as written to the hardware */
1223 	int min, max;
1224 	/* Limited maximum value specified as presented through the control */
1225 	int platform_max;
1226 	int reg, rreg;
1227 	unsigned int shift, rshift;
1228 	u32 num_channels;
1229 	unsigned int sign_bit;
1230 	unsigned int invert:1;
1231 	unsigned int autodisable:1;
1232 #ifdef CONFIG_SND_SOC_TOPOLOGY
1233 	struct snd_soc_dobj dobj;
1234 #endif
1235 };
1236 
1237 struct soc_bytes {
1238 	int base;
1239 	int num_regs;
1240 	u32 mask;
1241 };
1242 
1243 struct soc_bytes_ext {
1244 	int max;
1245 #ifdef CONFIG_SND_SOC_TOPOLOGY
1246 	struct snd_soc_dobj dobj;
1247 #endif
1248 	/* used for TLV byte control */
1249 	int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1250 			unsigned int size);
1251 	int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1252 			unsigned int size);
1253 };
1254 
1255 /* multi register control */
1256 struct soc_mreg_control {
1257 	long min, max;
1258 	unsigned int regbase, regcount, nbits, invert;
1259 };
1260 
1261 /* enumerated kcontrol */
1262 struct soc_enum {
1263 	int reg;
1264 	unsigned char shift_l;
1265 	unsigned char shift_r;
1266 	unsigned int items;
1267 	unsigned int mask;
1268 	const char * const *texts;
1269 	const unsigned int *values;
1270 	unsigned int autodisable:1;
1271 #ifdef CONFIG_SND_SOC_TOPOLOGY
1272 	struct snd_soc_dobj dobj;
1273 #endif
1274 };
1275 
1276 static inline bool snd_soc_volsw_is_stereo(const struct soc_mixer_control *mc)
1277 {
1278 	if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1279 		return false;
1280 	/*
1281 	 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1282 	 * mc->reg != mc->rreg means that the control is
1283 	 * stereo (bits in one register or in two registers)
1284 	 */
1285 	return true;
1286 }
1287 
1288 static inline unsigned int snd_soc_enum_val_to_item(const struct soc_enum *e,
1289 	unsigned int val)
1290 {
1291 	unsigned int i;
1292 
1293 	if (!e->values)
1294 		return val;
1295 
1296 	for (i = 0; i < e->items; i++)
1297 		if (val == e->values[i])
1298 			return i;
1299 
1300 	return 0;
1301 }
1302 
1303 static inline unsigned int snd_soc_enum_item_to_val(const struct soc_enum *e,
1304 	unsigned int item)
1305 {
1306 	if (!e->values)
1307 		return item;
1308 
1309 	return e->values[item];
1310 }
1311 
1312 /**
1313  * snd_soc_kcontrol_component() - Returns the component that registered the
1314  *  control
1315  * @kcontrol: The control for which to get the component
1316  *
1317  * Note: This function will work correctly if the control has been registered
1318  * for a component. With snd_soc_add_codec_controls() or via table based
1319  * setup for either a CODEC or component driver. Otherwise the behavior is
1320  * undefined.
1321  */
1322 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1323 	struct snd_kcontrol *kcontrol)
1324 {
1325 	return snd_kcontrol_chip(kcontrol);
1326 }
1327 
1328 int snd_soc_util_init(void);
1329 void snd_soc_util_exit(void);
1330 
1331 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1332 			       const char *propname);
1333 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1334 					  const char *propname);
1335 int snd_soc_of_parse_pin_switches(struct snd_soc_card *card, const char *prop);
1336 int snd_soc_of_get_slot_mask(struct device_node *np,
1337 			     const char *prop_name,
1338 			     unsigned int *mask);
1339 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1340 			      unsigned int *tx_mask,
1341 			      unsigned int *rx_mask,
1342 			      unsigned int *slots,
1343 			      unsigned int *slot_width);
1344 void snd_soc_of_parse_node_prefix(struct device_node *np,
1345 				   struct snd_soc_codec_conf *codec_conf,
1346 				   struct device_node *of_node,
1347 				   const char *propname);
1348 static inline
1349 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1350 				   struct snd_soc_codec_conf *codec_conf,
1351 				   struct device_node *of_node,
1352 				   const char *propname)
1353 {
1354 	snd_soc_of_parse_node_prefix(card->dev->of_node,
1355 				     codec_conf, of_node, propname);
1356 }
1357 
1358 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1359 				   const char *propname);
1360 int snd_soc_of_parse_aux_devs(struct snd_soc_card *card, const char *propname);
1361 
1362 unsigned int snd_soc_daifmt_clock_provider_flipped(unsigned int dai_fmt);
1363 unsigned int snd_soc_daifmt_clock_provider_from_bitmap(unsigned int bit_frame);
1364 
1365 unsigned int snd_soc_daifmt_parse_format(struct device_node *np, const char *prefix);
1366 unsigned int snd_soc_daifmt_parse_clock_provider_raw(struct device_node *np,
1367 						     const char *prefix,
1368 						     struct device_node **bitclkmaster,
1369 						     struct device_node **framemaster);
1370 #define snd_soc_daifmt_parse_clock_provider_as_bitmap(np, prefix)	\
1371 	snd_soc_daifmt_parse_clock_provider_raw(np, prefix, NULL, NULL)
1372 #define snd_soc_daifmt_parse_clock_provider_as_phandle			\
1373 	snd_soc_daifmt_parse_clock_provider_raw
1374 #define snd_soc_daifmt_parse_clock_provider_as_flag(np, prefix)		\
1375 	snd_soc_daifmt_clock_provider_from_bitmap(			\
1376 		snd_soc_daifmt_parse_clock_provider_as_bitmap(np, prefix))
1377 
1378 int snd_soc_get_stream_cpu(const struct snd_soc_dai_link *dai_link, int stream);
1379 int snd_soc_get_dlc(const struct of_phandle_args *args,
1380 		    struct snd_soc_dai_link_component *dlc);
1381 int snd_soc_of_get_dlc(struct device_node *of_node,
1382 		       struct of_phandle_args *args,
1383 		       struct snd_soc_dai_link_component *dlc,
1384 		       int index);
1385 int snd_soc_get_dai_id(struct device_node *ep);
1386 int snd_soc_get_dai_name(const struct of_phandle_args *args,
1387 			 const char **dai_name);
1388 int snd_soc_of_get_dai_name(struct device_node *of_node,
1389 			    const char **dai_name, int index);
1390 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1391 				   struct device_node *of_node,
1392 				   struct snd_soc_dai_link *dai_link);
1393 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link);
1394 int snd_soc_of_get_dai_link_cpus(struct device *dev,
1395 				 struct device_node *of_node,
1396 				 struct snd_soc_dai_link *dai_link);
1397 void snd_soc_of_put_dai_link_cpus(struct snd_soc_dai_link *dai_link);
1398 
1399 int snd_soc_add_pcm_runtimes(struct snd_soc_card *card,
1400 			     struct snd_soc_dai_link *dai_link,
1401 			     int num_dai_link);
1402 void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
1403 				struct snd_soc_pcm_runtime *rtd);
1404 
1405 void snd_soc_dlc_use_cpu_as_platform(struct snd_soc_dai_link_component *platforms,
1406 				     struct snd_soc_dai_link_component *cpus);
1407 struct of_phandle_args *snd_soc_copy_dai_args(struct device *dev,
1408 					      const struct of_phandle_args *args);
1409 struct snd_soc_dai *snd_soc_get_dai_via_args(const struct of_phandle_args *dai_args);
1410 struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
1411 					 struct snd_soc_dai_driver *dai_drv,
1412 					 bool legacy_dai_naming);
1413 void snd_soc_unregister_dai(struct snd_soc_dai *dai);
1414 
1415 struct snd_soc_dai *snd_soc_find_dai(
1416 	const struct snd_soc_dai_link_component *dlc);
1417 struct snd_soc_dai *snd_soc_find_dai_with_mutex(
1418 	const struct snd_soc_dai_link_component *dlc);
1419 
1420 #include <sound/soc-dai.h>
1421 
1422 static inline
1423 int snd_soc_fixup_dai_links_platform_name(struct snd_soc_card *card,
1424 					  const char *platform_name)
1425 {
1426 	struct snd_soc_dai_link *dai_link;
1427 	const char *name;
1428 	int i;
1429 
1430 	if (!platform_name) /* nothing to do */
1431 		return 0;
1432 
1433 	/* set platform name for each dailink */
1434 	for_each_card_prelinks(card, i, dai_link) {
1435 		/* only single platform is supported for now */
1436 		if (dai_link->num_platforms != 1)
1437 			return -EINVAL;
1438 
1439 		if (!dai_link->platforms)
1440 			return -EINVAL;
1441 
1442 		name = devm_kstrdup(card->dev, platform_name, GFP_KERNEL);
1443 		if (!name)
1444 			return -ENOMEM;
1445 
1446 		/* only single platform is supported for now */
1447 		dai_link->platforms->name = name;
1448 	}
1449 
1450 	return 0;
1451 }
1452 
1453 #ifdef CONFIG_DEBUG_FS
1454 extern struct dentry *snd_soc_debugfs_root;
1455 #endif
1456 
1457 extern const struct dev_pm_ops snd_soc_pm_ops;
1458 
1459 /*
1460  *	DAPM helper functions
1461  */
1462 enum snd_soc_dapm_subclass {
1463 	SND_SOC_DAPM_CLASS_ROOT		= 0,
1464 	SND_SOC_DAPM_CLASS_RUNTIME	= 1,
1465 };
1466 
1467 static inline void _snd_soc_dapm_mutex_lock_root_c(struct snd_soc_card *card)
1468 {
1469 	mutex_lock_nested(&card->dapm_mutex, SND_SOC_DAPM_CLASS_ROOT);
1470 }
1471 
1472 static inline void _snd_soc_dapm_mutex_lock_c(struct snd_soc_card *card)
1473 {
1474 	mutex_lock_nested(&card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
1475 }
1476 
1477 static inline void _snd_soc_dapm_mutex_unlock_c(struct snd_soc_card *card)
1478 {
1479 	mutex_unlock(&card->dapm_mutex);
1480 }
1481 
1482 static inline void _snd_soc_dapm_mutex_assert_held_c(struct snd_soc_card *card)
1483 {
1484 	lockdep_assert_held(&card->dapm_mutex);
1485 }
1486 
1487 static inline void _snd_soc_dapm_mutex_lock_root_d(struct snd_soc_dapm_context *dapm)
1488 {
1489 	_snd_soc_dapm_mutex_lock_root_c(dapm->card);
1490 }
1491 
1492 static inline void _snd_soc_dapm_mutex_lock_d(struct snd_soc_dapm_context *dapm)
1493 {
1494 	_snd_soc_dapm_mutex_lock_c(dapm->card);
1495 }
1496 
1497 static inline void _snd_soc_dapm_mutex_unlock_d(struct snd_soc_dapm_context *dapm)
1498 {
1499 	_snd_soc_dapm_mutex_unlock_c(dapm->card);
1500 }
1501 
1502 static inline void _snd_soc_dapm_mutex_assert_held_d(struct snd_soc_dapm_context *dapm)
1503 {
1504 	_snd_soc_dapm_mutex_assert_held_c(dapm->card);
1505 }
1506 
1507 #define snd_soc_dapm_mutex_lock_root(x) _Generic((x),			\
1508 	struct snd_soc_card * :		_snd_soc_dapm_mutex_lock_root_c, \
1509 	struct snd_soc_dapm_context * :	_snd_soc_dapm_mutex_lock_root_d)(x)
1510 #define snd_soc_dapm_mutex_lock(x) _Generic((x),			\
1511 	struct snd_soc_card * :		_snd_soc_dapm_mutex_lock_c,	\
1512 	struct snd_soc_dapm_context * :	_snd_soc_dapm_mutex_lock_d)(x)
1513 #define snd_soc_dapm_mutex_unlock(x) _Generic((x),			\
1514 	struct snd_soc_card * :		_snd_soc_dapm_mutex_unlock_c,	\
1515 	struct snd_soc_dapm_context * :	_snd_soc_dapm_mutex_unlock_d)(x)
1516 #define snd_soc_dapm_mutex_assert_held(x) _Generic((x),			\
1517 	struct snd_soc_card * :		_snd_soc_dapm_mutex_assert_held_c, \
1518 	struct snd_soc_dapm_context * :	_snd_soc_dapm_mutex_assert_held_d)(x)
1519 
1520 /*
1521  *	PCM helper functions
1522  */
1523 static inline void _snd_soc_dpcm_mutex_lock_c(struct snd_soc_card *card)
1524 {
1525 	mutex_lock_nested(&card->pcm_mutex, card->pcm_subclass);
1526 }
1527 
1528 static inline void _snd_soc_dpcm_mutex_unlock_c(struct snd_soc_card *card)
1529 {
1530 	mutex_unlock(&card->pcm_mutex);
1531 }
1532 
1533 static inline void _snd_soc_dpcm_mutex_assert_held_c(struct snd_soc_card *card)
1534 {
1535 	lockdep_assert_held(&card->pcm_mutex);
1536 }
1537 
1538 static inline void _snd_soc_dpcm_mutex_lock_r(struct snd_soc_pcm_runtime *rtd)
1539 {
1540 	_snd_soc_dpcm_mutex_lock_c(rtd->card);
1541 }
1542 
1543 static inline void _snd_soc_dpcm_mutex_unlock_r(struct snd_soc_pcm_runtime *rtd)
1544 {
1545 	_snd_soc_dpcm_mutex_unlock_c(rtd->card);
1546 }
1547 
1548 static inline void _snd_soc_dpcm_mutex_assert_held_r(struct snd_soc_pcm_runtime *rtd)
1549 {
1550 	_snd_soc_dpcm_mutex_assert_held_c(rtd->card);
1551 }
1552 
1553 #define snd_soc_dpcm_mutex_lock(x) _Generic((x),			\
1554 	 struct snd_soc_card * :	_snd_soc_dpcm_mutex_lock_c,	\
1555 	 struct snd_soc_pcm_runtime * :	_snd_soc_dpcm_mutex_lock_r)(x)
1556 
1557 #define snd_soc_dpcm_mutex_unlock(x) _Generic((x),			\
1558 	 struct snd_soc_card * :	_snd_soc_dpcm_mutex_unlock_c,	\
1559 	 struct snd_soc_pcm_runtime * :	_snd_soc_dpcm_mutex_unlock_r)(x)
1560 
1561 #define snd_soc_dpcm_mutex_assert_held(x) _Generic((x),		\
1562 	struct snd_soc_card * :		_snd_soc_dpcm_mutex_assert_held_c, \
1563 	struct snd_soc_pcm_runtime * :	_snd_soc_dpcm_mutex_assert_held_r)(x)
1564 
1565 #include <sound/soc-component.h>
1566 #include <sound/soc-card.h>
1567 #include <sound/soc-jack.h>
1568 
1569 #endif
1570