xref: /openbmc/linux/include/sound/soc.h (revision 6db6b729)
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 static inline struct snd_soc_dai_link_component*
778 asoc_link_to_cpu(struct snd_soc_dai_link *link, int n) {
779 	return &(link)->cpus[n];
780 }
781 
782 static inline struct snd_soc_dai_link_component*
783 asoc_link_to_codec(struct snd_soc_dai_link *link, int n) {
784 	return &(link)->codecs[n];
785 }
786 
787 static inline struct snd_soc_dai_link_component*
788 asoc_link_to_platform(struct snd_soc_dai_link *link, int n) {
789 	return &(link)->platforms[n];
790 }
791 
792 #define for_each_link_codecs(link, i, codec)				\
793 	for ((i) = 0;							\
794 	     ((i) < link->num_codecs) &&				\
795 		     ((codec) = asoc_link_to_codec(link, i));		\
796 	     (i)++)
797 
798 #define for_each_link_platforms(link, i, platform)			\
799 	for ((i) = 0;							\
800 	     ((i) < link->num_platforms) &&				\
801 		     ((platform) = asoc_link_to_platform(link, i));	\
802 	     (i)++)
803 
804 #define for_each_link_cpus(link, i, cpu)				\
805 	for ((i) = 0;							\
806 	     ((i) < link->num_cpus) &&					\
807 		     ((cpu) = asoc_link_to_cpu(link, i));		\
808 	     (i)++)
809 
810 /*
811  * Sample 1 : Single CPU/Codec/Platform
812  *
813  * SND_SOC_DAILINK_DEFS(test,
814  *	DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai")),
815  *	DAILINK_COMP_ARRAY(COMP_CODEC("codec", "codec_dai")),
816  *	DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
817  *
818  * struct snd_soc_dai_link link = {
819  *	...
820  *	SND_SOC_DAILINK_REG(test),
821  * };
822  *
823  * Sample 2 : Multi CPU/Codec, no Platform
824  *
825  * SND_SOC_DAILINK_DEFS(test,
826  *	DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
827  *			   COMP_CPU("cpu_dai2")),
828  *	DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
829  *			   COMP_CODEC("codec2", "codec_dai2")));
830  *
831  * struct snd_soc_dai_link link = {
832  *	...
833  *	SND_SOC_DAILINK_REG(test),
834  * };
835  *
836  * Sample 3 : Define each CPU/Codec/Platform manually
837  *
838  * SND_SOC_DAILINK_DEF(test_cpu,
839  *		DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
840  *				   COMP_CPU("cpu_dai2")));
841  * SND_SOC_DAILINK_DEF(test_codec,
842  *		DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
843  *				   COMP_CODEC("codec2", "codec_dai2")));
844  * SND_SOC_DAILINK_DEF(test_platform,
845  *		DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
846  *
847  * struct snd_soc_dai_link link = {
848  *	...
849  *	SND_SOC_DAILINK_REG(test_cpu,
850  *			    test_codec,
851  *			    test_platform),
852  * };
853  *
854  * Sample 4 : Sample3 without platform
855  *
856  * struct snd_soc_dai_link link = {
857  *	...
858  *	SND_SOC_DAILINK_REG(test_cpu,
859  *			    test_codec);
860  * };
861  */
862 
863 #define SND_SOC_DAILINK_REG1(name)	 SND_SOC_DAILINK_REG3(name##_cpus, name##_codecs, name##_platforms)
864 #define SND_SOC_DAILINK_REG2(cpu, codec) SND_SOC_DAILINK_REG3(cpu, codec, null_dailink_component)
865 #define SND_SOC_DAILINK_REG3(cpu, codec, platform)	\
866 	.cpus		= cpu,				\
867 	.num_cpus	= ARRAY_SIZE(cpu),		\
868 	.codecs		= codec,			\
869 	.num_codecs	= ARRAY_SIZE(codec),		\
870 	.platforms	= platform,			\
871 	.num_platforms	= ARRAY_SIZE(platform)
872 
873 #define SND_SOC_DAILINK_REGx(_1, _2, _3, func, ...) func
874 #define SND_SOC_DAILINK_REG(...) \
875 	SND_SOC_DAILINK_REGx(__VA_ARGS__,		\
876 			SND_SOC_DAILINK_REG3,	\
877 			SND_SOC_DAILINK_REG2,	\
878 			SND_SOC_DAILINK_REG1)(__VA_ARGS__)
879 
880 #define SND_SOC_DAILINK_DEF(name, def...)		\
881 	static struct snd_soc_dai_link_component name[]	= { def }
882 
883 #define SND_SOC_DAILINK_DEFS(name, cpu, codec, platform...)	\
884 	SND_SOC_DAILINK_DEF(name##_cpus, cpu);			\
885 	SND_SOC_DAILINK_DEF(name##_codecs, codec);		\
886 	SND_SOC_DAILINK_DEF(name##_platforms, platform)
887 
888 #define DAILINK_COMP_ARRAY(param...)	param
889 #define COMP_EMPTY()			{ }
890 #define COMP_CPU(_dai)			{ .dai_name = _dai, }
891 #define COMP_CODEC(_name, _dai)		{ .name = _name, .dai_name = _dai, }
892 #define COMP_PLATFORM(_name)		{ .name = _name }
893 #define COMP_AUX(_name)			{ .name = _name }
894 #define COMP_CODEC_CONF(_name)		{ .name = _name }
895 #define COMP_DUMMY()			{ .name = "snd-soc-dummy", .dai_name = "snd-soc-dummy-dai", }
896 
897 extern struct snd_soc_dai_link_component null_dailink_component[0];
898 extern struct snd_soc_dai_link_component asoc_dummy_dlc;
899 
900 
901 struct snd_soc_codec_conf {
902 	/*
903 	 * specify device either by device name, or by
904 	 * DT/OF node, but not both.
905 	 */
906 	struct snd_soc_dai_link_component dlc;
907 
908 	/*
909 	 * optional map of kcontrol, widget and path name prefixes that are
910 	 * associated per device
911 	 */
912 	const char *name_prefix;
913 };
914 
915 struct snd_soc_aux_dev {
916 	/*
917 	 * specify multi-codec either by device name, or by
918 	 * DT/OF node, but not both.
919 	 */
920 	struct snd_soc_dai_link_component dlc;
921 
922 	/* codec/machine specific init - e.g. add machine controls */
923 	int (*init)(struct snd_soc_component *component);
924 };
925 
926 /* SoC card */
927 struct snd_soc_card {
928 	const char *name;
929 	const char *long_name;
930 	const char *driver_name;
931 	const char *components;
932 #ifdef CONFIG_DMI
933 	char dmi_longname[80];
934 #endif /* CONFIG_DMI */
935 	char topology_shortname[32];
936 
937 	struct device *dev;
938 	struct snd_card *snd_card;
939 	struct module *owner;
940 
941 	struct mutex mutex;
942 	struct mutex dapm_mutex;
943 
944 	/* Mutex for PCM operations */
945 	struct mutex pcm_mutex;
946 	enum snd_soc_pcm_subclass pcm_subclass;
947 
948 	int (*probe)(struct snd_soc_card *card);
949 	int (*late_probe)(struct snd_soc_card *card);
950 	void (*fixup_controls)(struct snd_soc_card *card);
951 	int (*remove)(struct snd_soc_card *card);
952 
953 	/* the pre and post PM functions are used to do any PM work before and
954 	 * after the codec and DAI's do any PM work. */
955 	int (*suspend_pre)(struct snd_soc_card *card);
956 	int (*suspend_post)(struct snd_soc_card *card);
957 	int (*resume_pre)(struct snd_soc_card *card);
958 	int (*resume_post)(struct snd_soc_card *card);
959 
960 	/* callbacks */
961 	int (*set_bias_level)(struct snd_soc_card *,
962 			      struct snd_soc_dapm_context *dapm,
963 			      enum snd_soc_bias_level level);
964 	int (*set_bias_level_post)(struct snd_soc_card *,
965 				   struct snd_soc_dapm_context *dapm,
966 				   enum snd_soc_bias_level level);
967 
968 	int (*add_dai_link)(struct snd_soc_card *,
969 			    struct snd_soc_dai_link *link);
970 	void (*remove_dai_link)(struct snd_soc_card *,
971 			    struct snd_soc_dai_link *link);
972 
973 	long pmdown_time;
974 
975 	/* CPU <--> Codec DAI links  */
976 	struct snd_soc_dai_link *dai_link;  /* predefined links only */
977 	int num_links;  /* predefined links only */
978 
979 	struct list_head rtd_list;
980 	int num_rtd;
981 
982 	/* optional codec specific configuration */
983 	struct snd_soc_codec_conf *codec_conf;
984 	int num_configs;
985 
986 	/*
987 	 * optional auxiliary devices such as amplifiers or codecs with DAI
988 	 * link unused
989 	 */
990 	struct snd_soc_aux_dev *aux_dev;
991 	int num_aux_devs;
992 	struct list_head aux_comp_list;
993 
994 	const struct snd_kcontrol_new *controls;
995 	int num_controls;
996 
997 	/*
998 	 * Card-specific routes and widgets.
999 	 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1000 	 */
1001 	const struct snd_soc_dapm_widget *dapm_widgets;
1002 	int num_dapm_widgets;
1003 	const struct snd_soc_dapm_route *dapm_routes;
1004 	int num_dapm_routes;
1005 	const struct snd_soc_dapm_widget *of_dapm_widgets;
1006 	int num_of_dapm_widgets;
1007 	const struct snd_soc_dapm_route *of_dapm_routes;
1008 	int num_of_dapm_routes;
1009 
1010 	/* lists of probed devices belonging to this card */
1011 	struct list_head component_dev_list;
1012 	struct list_head list;
1013 
1014 	struct list_head widgets;
1015 	struct list_head paths;
1016 	struct list_head dapm_list;
1017 	struct list_head dapm_dirty;
1018 
1019 	/* attached dynamic objects */
1020 	struct list_head dobj_list;
1021 
1022 	/* Generic DAPM context for the card */
1023 	struct snd_soc_dapm_context dapm;
1024 	struct snd_soc_dapm_stats dapm_stats;
1025 	struct snd_soc_dapm_update *update;
1026 
1027 #ifdef CONFIG_DEBUG_FS
1028 	struct dentry *debugfs_card_root;
1029 #endif
1030 #ifdef CONFIG_PM_SLEEP
1031 	struct work_struct deferred_resume_work;
1032 #endif
1033 	u32 pop_time;
1034 
1035 	/* bit field */
1036 	unsigned int instantiated:1;
1037 	unsigned int topology_shortname_created:1;
1038 	unsigned int fully_routed:1;
1039 	unsigned int disable_route_checks:1;
1040 	unsigned int probed:1;
1041 	unsigned int component_chaining:1;
1042 
1043 	void *drvdata;
1044 };
1045 #define for_each_card_prelinks(card, i, link)				\
1046 	for ((i) = 0;							\
1047 	     ((i) < (card)->num_links) && ((link) = &(card)->dai_link[i]); \
1048 	     (i)++)
1049 #define for_each_card_pre_auxs(card, i, aux)				\
1050 	for ((i) = 0;							\
1051 	     ((i) < (card)->num_aux_devs) && ((aux) = &(card)->aux_dev[i]); \
1052 	     (i)++)
1053 
1054 #define for_each_card_rtds(card, rtd)			\
1055 	list_for_each_entry(rtd, &(card)->rtd_list, list)
1056 #define for_each_card_rtds_safe(card, rtd, _rtd)	\
1057 	list_for_each_entry_safe(rtd, _rtd, &(card)->rtd_list, list)
1058 
1059 #define for_each_card_auxs(card, component)			\
1060 	list_for_each_entry(component, &card->aux_comp_list, card_aux_list)
1061 #define for_each_card_auxs_safe(card, component, _comp)	\
1062 	list_for_each_entry_safe(component, _comp,	\
1063 				 &card->aux_comp_list, card_aux_list)
1064 
1065 #define for_each_card_components(card, component)			\
1066 	list_for_each_entry(component, &(card)->component_dev_list, card_list)
1067 
1068 #define for_each_card_dapms(card, dapm)					\
1069 	list_for_each_entry(dapm, &card->dapm_list, list)
1070 
1071 #define for_each_card_widgets(card, w)\
1072 	list_for_each_entry(w, &card->widgets, list)
1073 #define for_each_card_widgets_safe(card, w, _w)	\
1074 	list_for_each_entry_safe(w, _w, &card->widgets, list)
1075 
1076 
1077 static inline int snd_soc_card_is_instantiated(struct snd_soc_card *card)
1078 {
1079 	return card && card->instantiated;
1080 }
1081 
1082 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1083 struct snd_soc_pcm_runtime {
1084 	struct device *dev;
1085 	struct snd_soc_card *card;
1086 	struct snd_soc_dai_link *dai_link;
1087 	struct snd_pcm_ops ops;
1088 
1089 	unsigned int c2c_params_select; /* currently selected c2c_param for dai link */
1090 
1091 	/* Dynamic PCM BE runtime data */
1092 	struct snd_soc_dpcm_runtime dpcm[SNDRV_PCM_STREAM_LAST + 1];
1093 	struct snd_soc_dapm_widget *c2c_widget[SNDRV_PCM_STREAM_LAST + 1];
1094 
1095 	long pmdown_time;
1096 
1097 	/* runtime devices */
1098 	struct snd_pcm *pcm;
1099 	struct snd_compr *compr;
1100 
1101 	/*
1102 	 * dais = cpu_dai + codec_dai
1103 	 * see
1104 	 *	soc_new_pcm_runtime()
1105 	 *	asoc_rtd_to_cpu()
1106 	 *	asoc_rtd_to_codec()
1107 	 */
1108 	struct snd_soc_dai **dais;
1109 
1110 	struct delayed_work delayed_work;
1111 	void (*close_delayed_work_func)(struct snd_soc_pcm_runtime *rtd);
1112 #ifdef CONFIG_DEBUG_FS
1113 	struct dentry *debugfs_dpcm_root;
1114 #endif
1115 
1116 	unsigned int num; /* 0-based and monotonic increasing */
1117 	struct list_head list; /* rtd list of the soc card */
1118 
1119 	/* function mark */
1120 	struct snd_pcm_substream *mark_startup;
1121 	struct snd_pcm_substream *mark_hw_params;
1122 	struct snd_pcm_substream *mark_trigger;
1123 	struct snd_compr_stream  *mark_compr_startup;
1124 
1125 	/* bit field */
1126 	unsigned int pop_wait:1;
1127 	unsigned int fe_compr:1; /* for Dynamic PCM */
1128 
1129 	bool initialized;
1130 
1131 	int num_components;
1132 	struct snd_soc_component *components[]; /* CPU/Codec/Platform */
1133 };
1134 /* see soc_new_pcm_runtime()  */
1135 #define asoc_rtd_to_cpu(rtd, n)   (rtd)->dais[n]
1136 #define asoc_rtd_to_codec(rtd, n) (rtd)->dais[n + (rtd)->dai_link->num_cpus]
1137 #define asoc_substream_to_rtd(substream) \
1138 	(struct snd_soc_pcm_runtime *)snd_pcm_substream_chip(substream)
1139 
1140 #define for_each_rtd_components(rtd, i, component)			\
1141 	for ((i) = 0, component = NULL;					\
1142 	     ((i) < rtd->num_components) && ((component) = rtd->components[i]);\
1143 	     (i)++)
1144 #define for_each_rtd_cpu_dais(rtd, i, dai)				\
1145 	for ((i) = 0;							\
1146 	     ((i) < rtd->dai_link->num_cpus) && ((dai) = asoc_rtd_to_cpu(rtd, i)); \
1147 	     (i)++)
1148 #define for_each_rtd_codec_dais(rtd, i, dai)				\
1149 	for ((i) = 0;							\
1150 	     ((i) < rtd->dai_link->num_codecs) && ((dai) = asoc_rtd_to_codec(rtd, i)); \
1151 	     (i)++)
1152 #define for_each_rtd_dais(rtd, i, dai)					\
1153 	for ((i) = 0;							\
1154 	     ((i) < (rtd)->dai_link->num_cpus + (rtd)->dai_link->num_codecs) &&	\
1155 		     ((dai) = (rtd)->dais[i]);				\
1156 	     (i)++)
1157 
1158 void snd_soc_close_delayed_work(struct snd_soc_pcm_runtime *rtd);
1159 
1160 /* mixer control */
1161 struct soc_mixer_control {
1162 	int min, max, platform_max;
1163 	int reg, rreg;
1164 	unsigned int shift, rshift;
1165 	unsigned int sign_bit;
1166 	unsigned int invert:1;
1167 	unsigned int autodisable:1;
1168 #ifdef CONFIG_SND_SOC_TOPOLOGY
1169 	struct snd_soc_dobj dobj;
1170 #endif
1171 };
1172 
1173 struct soc_bytes {
1174 	int base;
1175 	int num_regs;
1176 	u32 mask;
1177 };
1178 
1179 struct soc_bytes_ext {
1180 	int max;
1181 #ifdef CONFIG_SND_SOC_TOPOLOGY
1182 	struct snd_soc_dobj dobj;
1183 #endif
1184 	/* used for TLV byte control */
1185 	int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1186 			unsigned int size);
1187 	int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1188 			unsigned int size);
1189 };
1190 
1191 /* multi register control */
1192 struct soc_mreg_control {
1193 	long min, max;
1194 	unsigned int regbase, regcount, nbits, invert;
1195 };
1196 
1197 /* enumerated kcontrol */
1198 struct soc_enum {
1199 	int reg;
1200 	unsigned char shift_l;
1201 	unsigned char shift_r;
1202 	unsigned int items;
1203 	unsigned int mask;
1204 	const char * const *texts;
1205 	const unsigned int *values;
1206 	unsigned int autodisable:1;
1207 #ifdef CONFIG_SND_SOC_TOPOLOGY
1208 	struct snd_soc_dobj dobj;
1209 #endif
1210 };
1211 
1212 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1213 {
1214 	if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1215 		return false;
1216 	/*
1217 	 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1218 	 * mc->reg != mc->rreg means that the control is
1219 	 * stereo (bits in one register or in two registers)
1220 	 */
1221 	return true;
1222 }
1223 
1224 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1225 	unsigned int val)
1226 {
1227 	unsigned int i;
1228 
1229 	if (!e->values)
1230 		return val;
1231 
1232 	for (i = 0; i < e->items; i++)
1233 		if (val == e->values[i])
1234 			return i;
1235 
1236 	return 0;
1237 }
1238 
1239 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1240 	unsigned int item)
1241 {
1242 	if (!e->values)
1243 		return item;
1244 
1245 	return e->values[item];
1246 }
1247 
1248 /**
1249  * snd_soc_kcontrol_component() - Returns the component that registered the
1250  *  control
1251  * @kcontrol: The control for which to get the component
1252  *
1253  * Note: This function will work correctly if the control has been registered
1254  * for a component. With snd_soc_add_codec_controls() or via table based
1255  * setup for either a CODEC or component driver. Otherwise the behavior is
1256  * undefined.
1257  */
1258 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1259 	struct snd_kcontrol *kcontrol)
1260 {
1261 	return snd_kcontrol_chip(kcontrol);
1262 }
1263 
1264 int snd_soc_util_init(void);
1265 void snd_soc_util_exit(void);
1266 
1267 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1268 			       const char *propname);
1269 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1270 					  const char *propname);
1271 int snd_soc_of_parse_pin_switches(struct snd_soc_card *card, const char *prop);
1272 int snd_soc_of_get_slot_mask(struct device_node *np,
1273 			     const char *prop_name,
1274 			     unsigned int *mask);
1275 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1276 			      unsigned int *tx_mask,
1277 			      unsigned int *rx_mask,
1278 			      unsigned int *slots,
1279 			      unsigned int *slot_width);
1280 void snd_soc_of_parse_node_prefix(struct device_node *np,
1281 				   struct snd_soc_codec_conf *codec_conf,
1282 				   struct device_node *of_node,
1283 				   const char *propname);
1284 static inline
1285 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1286 				   struct snd_soc_codec_conf *codec_conf,
1287 				   struct device_node *of_node,
1288 				   const char *propname)
1289 {
1290 	snd_soc_of_parse_node_prefix(card->dev->of_node,
1291 				     codec_conf, of_node, propname);
1292 }
1293 
1294 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1295 				   const char *propname);
1296 int snd_soc_of_parse_aux_devs(struct snd_soc_card *card, const char *propname);
1297 
1298 unsigned int snd_soc_daifmt_clock_provider_flipped(unsigned int dai_fmt);
1299 unsigned int snd_soc_daifmt_clock_provider_from_bitmap(unsigned int bit_frame);
1300 
1301 unsigned int snd_soc_daifmt_parse_format(struct device_node *np, const char *prefix);
1302 unsigned int snd_soc_daifmt_parse_clock_provider_raw(struct device_node *np,
1303 						     const char *prefix,
1304 						     struct device_node **bitclkmaster,
1305 						     struct device_node **framemaster);
1306 #define snd_soc_daifmt_parse_clock_provider_as_bitmap(np, prefix)	\
1307 	snd_soc_daifmt_parse_clock_provider_raw(np, prefix, NULL, NULL)
1308 #define snd_soc_daifmt_parse_clock_provider_as_phandle			\
1309 	snd_soc_daifmt_parse_clock_provider_raw
1310 #define snd_soc_daifmt_parse_clock_provider_as_flag(np, prefix)		\
1311 	snd_soc_daifmt_clock_provider_from_bitmap(			\
1312 		snd_soc_daifmt_parse_clock_provider_as_bitmap(np, prefix))
1313 
1314 int snd_soc_get_stream_cpu(struct snd_soc_dai_link *dai_link, int stream);
1315 int snd_soc_get_dlc(const struct of_phandle_args *args,
1316 		    struct snd_soc_dai_link_component *dlc);
1317 int snd_soc_of_get_dlc(struct device_node *of_node,
1318 		       struct of_phandle_args *args,
1319 		       struct snd_soc_dai_link_component *dlc,
1320 		       int index);
1321 int snd_soc_get_dai_id(struct device_node *ep);
1322 int snd_soc_get_dai_name(const struct of_phandle_args *args,
1323 			 const char **dai_name);
1324 int snd_soc_of_get_dai_name(struct device_node *of_node,
1325 			    const char **dai_name, int index);
1326 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1327 				   struct device_node *of_node,
1328 				   struct snd_soc_dai_link *dai_link);
1329 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link);
1330 int snd_soc_of_get_dai_link_cpus(struct device *dev,
1331 				 struct device_node *of_node,
1332 				 struct snd_soc_dai_link *dai_link);
1333 void snd_soc_of_put_dai_link_cpus(struct snd_soc_dai_link *dai_link);
1334 
1335 int snd_soc_add_pcm_runtimes(struct snd_soc_card *card,
1336 			     struct snd_soc_dai_link *dai_link,
1337 			     int num_dai_link);
1338 void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
1339 				struct snd_soc_pcm_runtime *rtd);
1340 
1341 void snd_soc_dlc_use_cpu_as_platform(struct snd_soc_dai_link_component *platforms,
1342 				     struct snd_soc_dai_link_component *cpus);
1343 struct of_phandle_args *snd_soc_copy_dai_args(struct device *dev,
1344 					      struct of_phandle_args *args);
1345 struct snd_soc_dai *snd_soc_get_dai_via_args(struct of_phandle_args *dai_args);
1346 struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
1347 					 struct snd_soc_dai_driver *dai_drv,
1348 					 bool legacy_dai_naming);
1349 struct snd_soc_dai *devm_snd_soc_register_dai(struct device *dev,
1350 					      struct snd_soc_component *component,
1351 					      struct snd_soc_dai_driver *dai_drv,
1352 					      bool legacy_dai_naming);
1353 void snd_soc_unregister_dai(struct snd_soc_dai *dai);
1354 
1355 struct snd_soc_dai *snd_soc_find_dai(
1356 	const struct snd_soc_dai_link_component *dlc);
1357 struct snd_soc_dai *snd_soc_find_dai_with_mutex(
1358 	const struct snd_soc_dai_link_component *dlc);
1359 
1360 #include <sound/soc-dai.h>
1361 
1362 static inline
1363 int snd_soc_fixup_dai_links_platform_name(struct snd_soc_card *card,
1364 					  const char *platform_name)
1365 {
1366 	struct snd_soc_dai_link *dai_link;
1367 	const char *name;
1368 	int i;
1369 
1370 	if (!platform_name) /* nothing to do */
1371 		return 0;
1372 
1373 	/* set platform name for each dailink */
1374 	for_each_card_prelinks(card, i, dai_link) {
1375 		/* only single platform is supported for now */
1376 		if (dai_link->num_platforms != 1)
1377 			return -EINVAL;
1378 
1379 		if (!dai_link->platforms)
1380 			return -EINVAL;
1381 
1382 		name = devm_kstrdup(card->dev, platform_name, GFP_KERNEL);
1383 		if (!name)
1384 			return -ENOMEM;
1385 
1386 		/* only single platform is supported for now */
1387 		dai_link->platforms->name = name;
1388 	}
1389 
1390 	return 0;
1391 }
1392 
1393 #ifdef CONFIG_DEBUG_FS
1394 extern struct dentry *snd_soc_debugfs_root;
1395 #endif
1396 
1397 extern const struct dev_pm_ops snd_soc_pm_ops;
1398 
1399 /*
1400  *	DAPM helper functions
1401  */
1402 enum snd_soc_dapm_subclass {
1403 	SND_SOC_DAPM_CLASS_ROOT		= 0,
1404 	SND_SOC_DAPM_CLASS_RUNTIME	= 1,
1405 };
1406 
1407 static inline void _snd_soc_dapm_mutex_lock_root_c(struct snd_soc_card *card)
1408 {
1409 	mutex_lock_nested(&card->dapm_mutex, SND_SOC_DAPM_CLASS_ROOT);
1410 }
1411 
1412 static inline void _snd_soc_dapm_mutex_lock_c(struct snd_soc_card *card)
1413 {
1414 	mutex_lock_nested(&card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
1415 }
1416 
1417 static inline void _snd_soc_dapm_mutex_unlock_c(struct snd_soc_card *card)
1418 {
1419 	mutex_unlock(&card->dapm_mutex);
1420 }
1421 
1422 static inline void _snd_soc_dapm_mutex_assert_held_c(struct snd_soc_card *card)
1423 {
1424 	lockdep_assert_held(&card->dapm_mutex);
1425 }
1426 
1427 static inline void _snd_soc_dapm_mutex_lock_root_d(struct snd_soc_dapm_context *dapm)
1428 {
1429 	_snd_soc_dapm_mutex_lock_root_c(dapm->card);
1430 }
1431 
1432 static inline void _snd_soc_dapm_mutex_lock_d(struct snd_soc_dapm_context *dapm)
1433 {
1434 	_snd_soc_dapm_mutex_lock_c(dapm->card);
1435 }
1436 
1437 static inline void _snd_soc_dapm_mutex_unlock_d(struct snd_soc_dapm_context *dapm)
1438 {
1439 	_snd_soc_dapm_mutex_unlock_c(dapm->card);
1440 }
1441 
1442 static inline void _snd_soc_dapm_mutex_assert_held_d(struct snd_soc_dapm_context *dapm)
1443 {
1444 	_snd_soc_dapm_mutex_assert_held_c(dapm->card);
1445 }
1446 
1447 #define snd_soc_dapm_mutex_lock_root(x) _Generic((x),			\
1448 	struct snd_soc_card * :		_snd_soc_dapm_mutex_lock_root_c, \
1449 	struct snd_soc_dapm_context * :	_snd_soc_dapm_mutex_lock_root_d)(x)
1450 #define snd_soc_dapm_mutex_lock(x) _Generic((x),			\
1451 	struct snd_soc_card * :		_snd_soc_dapm_mutex_lock_c,	\
1452 	struct snd_soc_dapm_context * :	_snd_soc_dapm_mutex_lock_d)(x)
1453 #define snd_soc_dapm_mutex_unlock(x) _Generic((x),			\
1454 	struct snd_soc_card * :		_snd_soc_dapm_mutex_unlock_c,	\
1455 	struct snd_soc_dapm_context * :	_snd_soc_dapm_mutex_unlock_d)(x)
1456 #define snd_soc_dapm_mutex_assert_held(x) _Generic((x),			\
1457 	struct snd_soc_card * :		_snd_soc_dapm_mutex_assert_held_c, \
1458 	struct snd_soc_dapm_context * :	_snd_soc_dapm_mutex_assert_held_d)(x)
1459 
1460 /*
1461  *	PCM helper functions
1462  */
1463 static inline void _snd_soc_dpcm_mutex_lock_c(struct snd_soc_card *card)
1464 {
1465 	mutex_lock_nested(&card->pcm_mutex, card->pcm_subclass);
1466 }
1467 
1468 static inline void _snd_soc_dpcm_mutex_unlock_c(struct snd_soc_card *card)
1469 {
1470 	mutex_unlock(&card->pcm_mutex);
1471 }
1472 
1473 static inline void _snd_soc_dpcm_mutex_assert_held_c(struct snd_soc_card *card)
1474 {
1475 	lockdep_assert_held(&card->pcm_mutex);
1476 }
1477 
1478 static inline void _snd_soc_dpcm_mutex_lock_r(struct snd_soc_pcm_runtime *rtd)
1479 {
1480 	_snd_soc_dpcm_mutex_lock_c(rtd->card);
1481 }
1482 
1483 static inline void _snd_soc_dpcm_mutex_unlock_r(struct snd_soc_pcm_runtime *rtd)
1484 {
1485 	_snd_soc_dpcm_mutex_unlock_c(rtd->card);
1486 }
1487 
1488 static inline void _snd_soc_dpcm_mutex_assert_held_r(struct snd_soc_pcm_runtime *rtd)
1489 {
1490 	_snd_soc_dpcm_mutex_assert_held_c(rtd->card);
1491 }
1492 
1493 #define snd_soc_dpcm_mutex_lock(x) _Generic((x),			\
1494 	 struct snd_soc_card * :	_snd_soc_dpcm_mutex_lock_c,	\
1495 	 struct snd_soc_pcm_runtime * :	_snd_soc_dpcm_mutex_lock_r)(x)
1496 
1497 #define snd_soc_dpcm_mutex_unlock(x) _Generic((x),			\
1498 	 struct snd_soc_card * :	_snd_soc_dpcm_mutex_unlock_c,	\
1499 	 struct snd_soc_pcm_runtime * :	_snd_soc_dpcm_mutex_unlock_r)(x)
1500 
1501 #define snd_soc_dpcm_mutex_assert_held(x) _Generic((x),		\
1502 	struct snd_soc_card * :		_snd_soc_dpcm_mutex_assert_held_c, \
1503 	struct snd_soc_pcm_runtime * :	_snd_soc_dpcm_mutex_assert_held_r)(x)
1504 
1505 #include <sound/soc-component.h>
1506 #include <sound/soc-card.h>
1507 #include <sound/soc-jack.h>
1508 
1509 #endif
1510