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