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