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