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