xref: /linux/include/sound/soc.h (revision b85d45947951d23cb22d90caecf4c1eb81342c96)
1 /*
2  * linux/sound/soc.h -- ALSA SoC Layer
3  *
4  * Author:		Liam Girdwood
5  * Created:		Aug 11th 2005
6  * Copyright:	Wolfson Microelectronics. PLC.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11  */
12 
13 #ifndef __LINUX_SND_SOC_H
14 #define __LINUX_SND_SOC_H
15 
16 #include <linux/of.h>
17 #include <linux/platform_device.h>
18 #include <linux/types.h>
19 #include <linux/notifier.h>
20 #include <linux/workqueue.h>
21 #include <linux/interrupt.h>
22 #include <linux/kernel.h>
23 #include <linux/regmap.h>
24 #include <linux/log2.h>
25 #include <sound/core.h>
26 #include <sound/pcm.h>
27 #include <sound/compress_driver.h>
28 #include <sound/control.h>
29 #include <sound/ac97_codec.h>
30 #include <sound/soc-topology.h>
31 
32 /*
33  * Convenience kcontrol builders
34  */
35 #define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert, xautodisable) \
36 	((unsigned long)&(struct soc_mixer_control) \
37 	{.reg = xreg, .rreg = xreg, .shift = shift_left, \
38 	.rshift = shift_right, .max = xmax, .platform_max = xmax, \
39 	.invert = xinvert, .autodisable = xautodisable})
40 #define SOC_DOUBLE_S_VALUE(xreg, shift_left, shift_right, xmin, xmax, xsign_bit, xinvert, xautodisable) \
41 	((unsigned long)&(struct soc_mixer_control) \
42 	{.reg = xreg, .rreg = xreg, .shift = shift_left, \
43 	.rshift = shift_right, .min = xmin, .max = xmax, .platform_max = xmax, \
44 	.sign_bit = xsign_bit, .invert = xinvert, .autodisable = xautodisable})
45 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \
46 	SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable)
47 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
48 	((unsigned long)&(struct soc_mixer_control) \
49 	{.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
50 #define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
51 	((unsigned long)&(struct soc_mixer_control) \
52 	{.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
53 	.max = xmax, .platform_max = xmax, .invert = xinvert})
54 #define SOC_DOUBLE_R_S_VALUE(xlreg, xrreg, xshift, xmin, xmax, xsign_bit, xinvert) \
55 	((unsigned long)&(struct soc_mixer_control) \
56 	{.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
57 	.max = xmax, .min = xmin, .platform_max = xmax, .sign_bit = xsign_bit, \
58 	.invert = xinvert})
59 #define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
60 	((unsigned long)&(struct soc_mixer_control) \
61 	{.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
62 	.min = xmin, .max = xmax, .platform_max = xmax, .invert = xinvert})
63 #define SOC_SINGLE(xname, reg, shift, max, invert) \
64 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
65 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
66 	.put = snd_soc_put_volsw, \
67 	.private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
68 #define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
69 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
70 	.info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
71 	.put = snd_soc_put_volsw_range, \
72 	.private_value = (unsigned long)&(struct soc_mixer_control) \
73 		{.reg = xreg, .rreg = xreg, .shift = xshift, \
74 		 .rshift = xshift,  .min = xmin, .max = xmax, \
75 		 .platform_max = xmax, .invert = xinvert} }
76 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
77 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
78 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
79 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
80 	.tlv.p = (tlv_array), \
81 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
82 	.put = snd_soc_put_volsw, \
83 	.private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
84 #define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
85 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
86 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
87 	SNDRV_CTL_ELEM_ACCESS_READWRITE, \
88 	.tlv.p  = (tlv_array),\
89 	.info = snd_soc_info_volsw_sx, \
90 	.get = snd_soc_get_volsw_sx,\
91 	.put = snd_soc_put_volsw_sx, \
92 	.private_value = (unsigned long)&(struct soc_mixer_control) \
93 		{.reg = xreg, .rreg = xreg, \
94 		.shift = xshift, .rshift = xshift, \
95 		.max = xmax, .min = xmin} }
96 #define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
97 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
98 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
99 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
100 	.tlv.p = (tlv_array), \
101 	.info = snd_soc_info_volsw_range, \
102 	.get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
103 	.private_value = (unsigned long)&(struct soc_mixer_control) \
104 		{.reg = xreg, .rreg = xreg, .shift = xshift, \
105 		 .rshift = xshift, .min = xmin, .max = xmax, \
106 		 .platform_max = xmax, .invert = xinvert} }
107 #define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
108 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
109 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
110 	.put = snd_soc_put_volsw, \
111 	.private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
112 					  max, invert, 0) }
113 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
114 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
115 	.info = snd_soc_info_volsw, \
116 	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
117 	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
118 					    xmax, xinvert) }
119 #define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
120 			   xmax, xinvert)		\
121 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
122 	.info = snd_soc_info_volsw_range, \
123 	.get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
124 	.private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
125 					    xshift, xmin, xmax, xinvert) }
126 #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
127 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
128 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
129 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
130 	.tlv.p = (tlv_array), \
131 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
132 	.put = snd_soc_put_volsw, \
133 	.private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
134 					  max, invert, 0) }
135 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
136 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
137 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
138 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
139 	.tlv.p = (tlv_array), \
140 	.info = snd_soc_info_volsw, \
141 	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
142 	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
143 					    xmax, xinvert) }
144 #define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
145 			       xmax, xinvert, tlv_array)		\
146 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
147 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
148 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
149 	.tlv.p = (tlv_array), \
150 	.info = snd_soc_info_volsw_range, \
151 	.get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
152 	.private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
153 					    xshift, xmin, xmax, xinvert) }
154 #define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
155 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
156 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
157 	SNDRV_CTL_ELEM_ACCESS_READWRITE, \
158 	.tlv.p  = (tlv_array), \
159 	.info = snd_soc_info_volsw_sx, \
160 	.get = snd_soc_get_volsw_sx, \
161 	.put = snd_soc_put_volsw_sx, \
162 	.private_value = (unsigned long)&(struct soc_mixer_control) \
163 		{.reg = xreg, .rreg = xrreg, \
164 		.shift = xshift, .rshift = xshift, \
165 		.max = xmax, .min = xmin} }
166 #define SOC_DOUBLE_R_S_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
167 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
168 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
169 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
170 	.tlv.p = (tlv_array), \
171 	.info = snd_soc_info_volsw, \
172 	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
173 	.private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
174 					    xmin, xmax, xsign_bit, xinvert) }
175 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
176 {	.iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
177 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
178 		  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
179 	.tlv.p  = (tlv_array), \
180 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
181 	.put = snd_soc_put_volsw, \
182 	.private_value = SOC_DOUBLE_S_VALUE(xreg, 0, 8, xmin, xmax, 7, 0, 0) }
183 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \
184 {	.reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
185 	.items = xitems, .texts = xtexts, \
186 	.mask = xitems ? roundup_pow_of_two(xitems) - 1 : 0}
187 #define SOC_ENUM_SINGLE(xreg, xshift, xitems, xtexts) \
188 	SOC_ENUM_DOUBLE(xreg, xshift, xshift, xitems, xtexts)
189 #define SOC_ENUM_SINGLE_EXT(xitems, xtexts) \
190 {	.items = xitems, .texts = xtexts }
191 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xitems, xtexts, xvalues) \
192 {	.reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
193 	.mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues}
194 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
195 	SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xitems, xtexts, xvalues)
196 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
197 {	.reg = xreg, .shift_l = xshift, .shift_r = xshift, \
198 	.mask = xmask, .items = xitems, .texts = xtexts, \
199 	.values = xvalues, .autodisable = 1}
200 #define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \
201 	SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
202 #define SOC_ENUM(xname, xenum) \
203 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
204 	.info = snd_soc_info_enum_double, \
205 	.get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
206 	.private_value = (unsigned long)&xenum }
207 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
208 	 xhandler_get, xhandler_put) \
209 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
210 	.info = snd_soc_info_volsw, \
211 	.get = xhandler_get, .put = xhandler_put, \
212 	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
213 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
214 	 xhandler_get, xhandler_put) \
215 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
216 	.info = snd_soc_info_volsw, \
217 	.get = xhandler_get, .put = xhandler_put, \
218 	.private_value = \
219 		SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
220 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
221 	 xhandler_get, xhandler_put, tlv_array) \
222 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
223 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
224 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
225 	.tlv.p = (tlv_array), \
226 	.info = snd_soc_info_volsw, \
227 	.get = xhandler_get, .put = xhandler_put, \
228 	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
229 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
230 	 xhandler_get, xhandler_put, tlv_array) \
231 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
232 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
233 		 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
234 	.tlv.p = (tlv_array), \
235 	.info = snd_soc_info_volsw, \
236 	.get = xhandler_get, .put = xhandler_put, \
237 	.private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
238 					  xmax, xinvert, 0) }
239 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
240 	 xhandler_get, xhandler_put, tlv_array) \
241 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
242 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
243 		 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
244 	.tlv.p = (tlv_array), \
245 	.info = snd_soc_info_volsw, \
246 	.get = xhandler_get, .put = xhandler_put, \
247 	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
248 					    xmax, xinvert) }
249 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
250 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
251 	.info = snd_soc_info_bool_ext, \
252 	.get = xhandler_get, .put = xhandler_put, \
253 	.private_value = xdata }
254 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
255 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
256 	.info = snd_soc_info_enum_double, \
257 	.get = xhandler_get, .put = xhandler_put, \
258 	.private_value = (unsigned long)&xenum }
259 #define SOC_VALUE_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
260 	SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put)
261 
262 #define SND_SOC_BYTES(xname, xbase, xregs)		      \
263 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
264 	.info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
265 	.put = snd_soc_bytes_put, .private_value =	      \
266 		((unsigned long)&(struct soc_bytes)           \
267 		{.base = xbase, .num_regs = xregs }) }
268 
269 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask)	      \
270 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
271 	.info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
272 	.put = snd_soc_bytes_put, .private_value =	      \
273 		((unsigned long)&(struct soc_bytes)           \
274 		{.base = xbase, .num_regs = xregs,	      \
275 		 .mask = xmask }) }
276 
277 #define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \
278 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
279 	.info = snd_soc_bytes_info_ext, \
280 	.get = xhandler_get, .put = xhandler_put, \
281 	.private_value = (unsigned long)&(struct soc_bytes_ext) \
282 		{.max = xcount} }
283 #define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \
284 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
285 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \
286 		  SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
287 	.tlv.c = (snd_soc_bytes_tlv_callback), \
288 	.info = snd_soc_bytes_info_ext, \
289 	.private_value = (unsigned long)&(struct soc_bytes_ext) \
290 		{.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
291 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
292 		xmin, xmax, xinvert) \
293 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
294 	.info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
295 	.put = snd_soc_put_xr_sx, \
296 	.private_value = (unsigned long)&(struct soc_mreg_control) \
297 		{.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
298 		.invert = xinvert, .min = xmin, .max = xmax} }
299 
300 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
301 	SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
302 		snd_soc_get_strobe, snd_soc_put_strobe)
303 
304 /*
305  * Simplified versions of above macros, declaring a struct and calculating
306  * ARRAY_SIZE internally
307  */
308 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
309 	const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
310 						ARRAY_SIZE(xtexts), xtexts)
311 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
312 	SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
313 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
314 	const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
315 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
316 	const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
317 							ARRAY_SIZE(xtexts), xtexts, xvalues)
318 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
319 	SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
320 
321 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
322 	const struct soc_enum name = SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, \
323 		xshift, xmask, ARRAY_SIZE(xtexts), xtexts, xvalues)
324 
325 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
326 	const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
327 
328 /*
329  * Component probe and remove ordering levels for components with runtime
330  * dependencies.
331  */
332 #define SND_SOC_COMP_ORDER_FIRST		-2
333 #define SND_SOC_COMP_ORDER_EARLY		-1
334 #define SND_SOC_COMP_ORDER_NORMAL		0
335 #define SND_SOC_COMP_ORDER_LATE		1
336 #define SND_SOC_COMP_ORDER_LAST		2
337 
338 /*
339  * Bias levels
340  *
341  * @ON:      Bias is fully on for audio playback and capture operations.
342  * @PREPARE: Prepare for audio operations. Called before DAPM switching for
343  *           stream start and stop operations.
344  * @STANDBY: Low power standby state when no playback/capture operations are
345  *           in progress. NOTE: The transition time between STANDBY and ON
346  *           should be as fast as possible and no longer than 10ms.
347  * @OFF:     Power Off. No restrictions on transition times.
348  */
349 enum snd_soc_bias_level {
350 	SND_SOC_BIAS_OFF = 0,
351 	SND_SOC_BIAS_STANDBY = 1,
352 	SND_SOC_BIAS_PREPARE = 2,
353 	SND_SOC_BIAS_ON = 3,
354 };
355 
356 struct device_node;
357 struct snd_jack;
358 struct snd_soc_card;
359 struct snd_soc_pcm_stream;
360 struct snd_soc_ops;
361 struct snd_soc_pcm_runtime;
362 struct snd_soc_dai;
363 struct snd_soc_dai_driver;
364 struct snd_soc_platform;
365 struct snd_soc_dai_link;
366 struct snd_soc_platform_driver;
367 struct snd_soc_codec;
368 struct snd_soc_codec_driver;
369 struct snd_soc_component;
370 struct snd_soc_component_driver;
371 struct soc_enum;
372 struct snd_soc_jack;
373 struct snd_soc_jack_zone;
374 struct snd_soc_jack_pin;
375 #include <sound/soc-dapm.h>
376 #include <sound/soc-dpcm.h>
377 
378 struct snd_soc_jack_gpio;
379 
380 typedef int (*hw_write_t)(void *,const char* ,int);
381 
382 enum snd_soc_pcm_subclass {
383 	SND_SOC_PCM_CLASS_PCM	= 0,
384 	SND_SOC_PCM_CLASS_BE	= 1,
385 };
386 
387 enum snd_soc_card_subclass {
388 	SND_SOC_CARD_CLASS_INIT		= 0,
389 	SND_SOC_CARD_CLASS_RUNTIME	= 1,
390 };
391 
392 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
393 			     int source, unsigned int freq, int dir);
394 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
395 			  unsigned int freq_in, unsigned int freq_out);
396 
397 int snd_soc_register_card(struct snd_soc_card *card);
398 int snd_soc_unregister_card(struct snd_soc_card *card);
399 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
400 #ifdef CONFIG_PM_SLEEP
401 int snd_soc_suspend(struct device *dev);
402 int snd_soc_resume(struct device *dev);
403 #else
404 static inline int snd_soc_suspend(struct device *dev)
405 {
406 	return 0;
407 }
408 
409 static inline int snd_soc_resume(struct device *dev)
410 {
411 	return 0;
412 }
413 #endif
414 int snd_soc_poweroff(struct device *dev);
415 int snd_soc_register_platform(struct device *dev,
416 		const struct snd_soc_platform_driver *platform_drv);
417 int devm_snd_soc_register_platform(struct device *dev,
418 		const struct snd_soc_platform_driver *platform_drv);
419 void snd_soc_unregister_platform(struct device *dev);
420 int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
421 		const struct snd_soc_platform_driver *platform_drv);
422 void snd_soc_remove_platform(struct snd_soc_platform *platform);
423 struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev);
424 int snd_soc_register_codec(struct device *dev,
425 		const struct snd_soc_codec_driver *codec_drv,
426 		struct snd_soc_dai_driver *dai_drv, int num_dai);
427 void snd_soc_unregister_codec(struct device *dev);
428 int snd_soc_register_component(struct device *dev,
429 			 const struct snd_soc_component_driver *cmpnt_drv,
430 			 struct snd_soc_dai_driver *dai_drv, int num_dai);
431 int devm_snd_soc_register_component(struct device *dev,
432 			 const struct snd_soc_component_driver *cmpnt_drv,
433 			 struct snd_soc_dai_driver *dai_drv, int num_dai);
434 void snd_soc_unregister_component(struct device *dev);
435 int snd_soc_cache_init(struct snd_soc_codec *codec);
436 int snd_soc_cache_exit(struct snd_soc_codec *codec);
437 
438 int snd_soc_platform_read(struct snd_soc_platform *platform,
439 					unsigned int reg);
440 int snd_soc_platform_write(struct snd_soc_platform *platform,
441 					unsigned int reg, unsigned int val);
442 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
443 int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
444 
445 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
446 		const char *dai_link, int stream);
447 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
448 		const char *dai_link);
449 
450 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
451 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
452 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
453 
454 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
455 	unsigned int dai_fmt);
456 
457 /* Utility functions to get clock rates from various things */
458 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
459 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
460 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
461 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
462 
463 /* set runtime hw params */
464 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
465 	const struct snd_pcm_hardware *hw);
466 
467 int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
468 		int cmd, struct snd_soc_platform *platform);
469 
470 int soc_dai_hw_params(struct snd_pcm_substream *substream,
471 		      struct snd_pcm_hw_params *params,
472 		      struct snd_soc_dai *dai);
473 
474 /* Jack reporting */
475 int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type,
476 	struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins,
477 	unsigned int num_pins);
478 
479 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
480 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
481 			  struct snd_soc_jack_pin *pins);
482 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
483 				    struct notifier_block *nb);
484 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
485 				      struct notifier_block *nb);
486 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
487 			  struct snd_soc_jack_zone *zones);
488 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
489 #ifdef CONFIG_GPIOLIB
490 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
491 			struct snd_soc_jack_gpio *gpios);
492 int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
493 			    struct snd_soc_jack *jack,
494 			    int count, struct snd_soc_jack_gpio *gpios);
495 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
496 			struct snd_soc_jack_gpio *gpios);
497 #else
498 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
499 					 struct snd_soc_jack_gpio *gpios)
500 {
501 	return 0;
502 }
503 
504 static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
505 					  struct snd_soc_jack *jack,
506 					  int count,
507 					  struct snd_soc_jack_gpio *gpios)
508 {
509 	return 0;
510 }
511 
512 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
513 					   struct snd_soc_jack_gpio *gpios)
514 {
515 }
516 #endif
517 
518 /* codec register bit access */
519 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned int reg,
520 				unsigned int mask, unsigned int value);
521 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
522 			       unsigned int reg, unsigned int mask,
523 			       unsigned int value);
524 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned int reg,
525 				unsigned int mask, unsigned int value);
526 
527 #ifdef CONFIG_SND_SOC_AC97_BUS
528 struct snd_ac97 *snd_soc_alloc_ac97_codec(struct snd_soc_codec *codec);
529 struct snd_ac97 *snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
530 	unsigned int id, unsigned int id_mask);
531 void snd_soc_free_ac97_codec(struct snd_ac97 *ac97);
532 
533 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
534 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
535 		struct platform_device *pdev);
536 
537 extern struct snd_ac97_bus_ops *soc_ac97_ops;
538 #else
539 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
540 	struct platform_device *pdev)
541 {
542 	return 0;
543 }
544 
545 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
546 {
547 	return 0;
548 }
549 #endif
550 
551 /*
552  *Controls
553  */
554 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
555 				  void *data, const char *long_name,
556 				  const char *prefix);
557 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
558 					       const char *name);
559 int snd_soc_add_component_controls(struct snd_soc_component *component,
560 	const struct snd_kcontrol_new *controls, unsigned int num_controls);
561 int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
562 	const struct snd_kcontrol_new *controls, unsigned int num_controls);
563 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
564 	const struct snd_kcontrol_new *controls, unsigned int num_controls);
565 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
566 	const struct snd_kcontrol_new *controls, int num_controls);
567 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
568 	const struct snd_kcontrol_new *controls, int num_controls);
569 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
570 	struct snd_ctl_elem_info *uinfo);
571 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
572 	struct snd_ctl_elem_value *ucontrol);
573 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
574 	struct snd_ctl_elem_value *ucontrol);
575 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
576 	struct snd_ctl_elem_info *uinfo);
577 int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol,
578 			  struct snd_ctl_elem_info *uinfo);
579 #define snd_soc_info_bool_ext		snd_ctl_boolean_mono_info
580 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
581 	struct snd_ctl_elem_value *ucontrol);
582 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
583 	struct snd_ctl_elem_value *ucontrol);
584 #define snd_soc_get_volsw_2r snd_soc_get_volsw
585 #define snd_soc_put_volsw_2r snd_soc_put_volsw
586 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
587 	struct snd_ctl_elem_value *ucontrol);
588 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
589 	struct snd_ctl_elem_value *ucontrol);
590 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
591 	struct snd_ctl_elem_info *uinfo);
592 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
593 	struct snd_ctl_elem_value *ucontrol);
594 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
595 	struct snd_ctl_elem_value *ucontrol);
596 int snd_soc_limit_volume(struct snd_soc_codec *codec,
597 	const char *name, int max);
598 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
599 		       struct snd_ctl_elem_info *uinfo);
600 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
601 		      struct snd_ctl_elem_value *ucontrol);
602 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
603 		      struct snd_ctl_elem_value *ucontrol);
604 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
605 	struct snd_ctl_elem_info *ucontrol);
606 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
607 	unsigned int size, unsigned int __user *tlv);
608 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
609 	struct snd_ctl_elem_info *uinfo);
610 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
611 	struct snd_ctl_elem_value *ucontrol);
612 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
613 	struct snd_ctl_elem_value *ucontrol);
614 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
615 	struct snd_ctl_elem_value *ucontrol);
616 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
617 	struct snd_ctl_elem_value *ucontrol);
618 
619 /**
620  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
621  *
622  * @pin:    name of the pin to update
623  * @mask:   bits to check for in reported jack status
624  * @invert: if non-zero then pin is enabled when status is not reported
625  * @list:   internal list entry
626  */
627 struct snd_soc_jack_pin {
628 	struct list_head list;
629 	const char *pin;
630 	int mask;
631 	bool invert;
632 };
633 
634 /**
635  * struct snd_soc_jack_zone - Describes voltage zones of jack detection
636  *
637  * @min_mv: start voltage in mv
638  * @max_mv: end voltage in mv
639  * @jack_type: type of jack that is expected for this voltage
640  * @debounce_time: debounce_time for jack, codec driver should wait for this
641  *		duration before reading the adc for voltages
642  * @list:   internal list entry
643  */
644 struct snd_soc_jack_zone {
645 	unsigned int min_mv;
646 	unsigned int max_mv;
647 	unsigned int jack_type;
648 	unsigned int debounce_time;
649 	struct list_head list;
650 };
651 
652 /**
653  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
654  *
655  * @gpio:         legacy gpio number
656  * @idx:          gpio descriptor index within the function of the GPIO
657  *                consumer device
658  * @gpiod_dev:    GPIO consumer device
659  * @name:         gpio name. Also as connection ID for the GPIO consumer
660  *                device function name lookup
661  * @report:       value to report when jack detected
662  * @invert:       report presence in low state
663  * @debounce_time: debounce time in ms
664  * @wake:	  enable as wake source
665  * @jack_status_check: callback function which overrides the detection
666  *		       to provide more complex checks (eg, reading an
667  *		       ADC).
668  */
669 struct snd_soc_jack_gpio {
670 	unsigned int gpio;
671 	unsigned int idx;
672 	struct device *gpiod_dev;
673 	const char *name;
674 	int report;
675 	int invert;
676 	int debounce_time;
677 	bool wake;
678 
679 	/* private: */
680 	struct snd_soc_jack *jack;
681 	struct delayed_work work;
682 	struct gpio_desc *desc;
683 
684 	void *data;
685 	/* public: */
686 	int (*jack_status_check)(void *data);
687 };
688 
689 struct snd_soc_jack {
690 	struct mutex mutex;
691 	struct snd_jack *jack;
692 	struct snd_soc_card *card;
693 	struct list_head pins;
694 	int status;
695 	struct blocking_notifier_head notifier;
696 	struct list_head jack_zones;
697 };
698 
699 /* SoC PCM stream information */
700 struct snd_soc_pcm_stream {
701 	const char *stream_name;
702 	u64 formats;			/* SNDRV_PCM_FMTBIT_* */
703 	unsigned int rates;		/* SNDRV_PCM_RATE_* */
704 	unsigned int rate_min;		/* min rate */
705 	unsigned int rate_max;		/* max rate */
706 	unsigned int channels_min;	/* min channels */
707 	unsigned int channels_max;	/* max channels */
708 	unsigned int sig_bits;		/* number of bits of content */
709 };
710 
711 /* SoC audio ops */
712 struct snd_soc_ops {
713 	int (*startup)(struct snd_pcm_substream *);
714 	void (*shutdown)(struct snd_pcm_substream *);
715 	int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
716 	int (*hw_free)(struct snd_pcm_substream *);
717 	int (*prepare)(struct snd_pcm_substream *);
718 	int (*trigger)(struct snd_pcm_substream *, int);
719 };
720 
721 struct snd_soc_compr_ops {
722 	int (*startup)(struct snd_compr_stream *);
723 	void (*shutdown)(struct snd_compr_stream *);
724 	int (*set_params)(struct snd_compr_stream *);
725 	int (*trigger)(struct snd_compr_stream *);
726 };
727 
728 /* component interface */
729 struct snd_soc_component_driver {
730 	const char *name;
731 
732 	/* Default control and setup, added after probe() is run */
733 	const struct snd_kcontrol_new *controls;
734 	unsigned int num_controls;
735 	const struct snd_soc_dapm_widget *dapm_widgets;
736 	unsigned int num_dapm_widgets;
737 	const struct snd_soc_dapm_route *dapm_routes;
738 	unsigned int num_dapm_routes;
739 
740 	int (*probe)(struct snd_soc_component *);
741 	void (*remove)(struct snd_soc_component *);
742 
743 	/* DT */
744 	int (*of_xlate_dai_name)(struct snd_soc_component *component,
745 				 struct of_phandle_args *args,
746 				 const char **dai_name);
747 	void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type,
748 		int subseq);
749 	int (*stream_event)(struct snd_soc_component *, int event);
750 
751 	/* probe ordering - for components with runtime dependencies */
752 	int probe_order;
753 	int remove_order;
754 };
755 
756 struct snd_soc_component {
757 	const char *name;
758 	int id;
759 	const char *name_prefix;
760 	struct device *dev;
761 	struct snd_soc_card *card;
762 
763 	unsigned int active;
764 
765 	unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
766 	unsigned int registered_as_component:1;
767 
768 	struct list_head list;
769 
770 	struct snd_soc_dai_driver *dai_drv;
771 	int num_dai;
772 
773 	const struct snd_soc_component_driver *driver;
774 
775 	struct list_head dai_list;
776 
777 	int (*read)(struct snd_soc_component *, unsigned int, unsigned int *);
778 	int (*write)(struct snd_soc_component *, unsigned int, unsigned int);
779 
780 	struct regmap *regmap;
781 	int val_bytes;
782 
783 	struct mutex io_mutex;
784 
785 	/* attached dynamic objects */
786 	struct list_head dobj_list;
787 
788 #ifdef CONFIG_DEBUG_FS
789 	struct dentry *debugfs_root;
790 #endif
791 
792 	/*
793 	* DO NOT use any of the fields below in drivers, they are temporary and
794 	* are going to be removed again soon. If you use them in driver code the
795 	* driver will be marked as BROKEN when these fields are removed.
796 	*/
797 
798 	/* Don't use these, use snd_soc_component_get_dapm() */
799 	struct snd_soc_dapm_context dapm;
800 
801 	const struct snd_kcontrol_new *controls;
802 	unsigned int num_controls;
803 	const struct snd_soc_dapm_widget *dapm_widgets;
804 	unsigned int num_dapm_widgets;
805 	const struct snd_soc_dapm_route *dapm_routes;
806 	unsigned int num_dapm_routes;
807 	struct snd_soc_codec *codec;
808 
809 	int (*probe)(struct snd_soc_component *);
810 	void (*remove)(struct snd_soc_component *);
811 
812 #ifdef CONFIG_DEBUG_FS
813 	void (*init_debugfs)(struct snd_soc_component *component);
814 	const char *debugfs_prefix;
815 #endif
816 };
817 
818 /* SoC Audio Codec device */
819 struct snd_soc_codec {
820 	struct device *dev;
821 	const struct snd_soc_codec_driver *driver;
822 
823 	struct list_head list;
824 	struct list_head card_list;
825 
826 	/* runtime */
827 	unsigned int cache_bypass:1; /* Suppress access to the cache */
828 	unsigned int suspended:1; /* Codec is in suspend PM state */
829 	unsigned int cache_init:1; /* codec cache has been initialized */
830 
831 	/* codec IO */
832 	void *control_data; /* codec control (i2c/3wire) data */
833 	hw_write_t hw_write;
834 	void *reg_cache;
835 
836 	/* component */
837 	struct snd_soc_component component;
838 
839 #ifdef CONFIG_DEBUG_FS
840 	struct dentry *debugfs_reg;
841 #endif
842 };
843 
844 /* codec driver */
845 struct snd_soc_codec_driver {
846 
847 	/* driver ops */
848 	int (*probe)(struct snd_soc_codec *);
849 	int (*remove)(struct snd_soc_codec *);
850 	int (*suspend)(struct snd_soc_codec *);
851 	int (*resume)(struct snd_soc_codec *);
852 	struct snd_soc_component_driver component_driver;
853 
854 	/* Default control and setup, added after probe() is run */
855 	const struct snd_kcontrol_new *controls;
856 	int num_controls;
857 	const struct snd_soc_dapm_widget *dapm_widgets;
858 	int num_dapm_widgets;
859 	const struct snd_soc_dapm_route *dapm_routes;
860 	int num_dapm_routes;
861 
862 	/* codec wide operations */
863 	int (*set_sysclk)(struct snd_soc_codec *codec,
864 			  int clk_id, int source, unsigned int freq, int dir);
865 	int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
866 		unsigned int freq_in, unsigned int freq_out);
867 
868 	/* codec IO */
869 	struct regmap *(*get_regmap)(struct device *);
870 	unsigned int (*read)(struct snd_soc_codec *, unsigned int);
871 	int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
872 	unsigned int reg_cache_size;
873 	short reg_cache_step;
874 	short reg_word_size;
875 	const void *reg_cache_default;
876 
877 	/* codec bias level */
878 	int (*set_bias_level)(struct snd_soc_codec *,
879 			      enum snd_soc_bias_level level);
880 	bool idle_bias_off;
881 	bool suspend_bias_off;
882 
883 	void (*seq_notifier)(struct snd_soc_dapm_context *,
884 			     enum snd_soc_dapm_type, int);
885 
886 	bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */
887 };
888 
889 /* SoC platform interface */
890 struct snd_soc_platform_driver {
891 
892 	int (*probe)(struct snd_soc_platform *);
893 	int (*remove)(struct snd_soc_platform *);
894 	struct snd_soc_component_driver component_driver;
895 
896 	/* pcm creation and destruction */
897 	int (*pcm_new)(struct snd_soc_pcm_runtime *);
898 	void (*pcm_free)(struct snd_pcm *);
899 
900 	/*
901 	 * For platform caused delay reporting.
902 	 * Optional.
903 	 */
904 	snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
905 		struct snd_soc_dai *);
906 
907 	/* platform stream pcm ops */
908 	const struct snd_pcm_ops *ops;
909 
910 	/* platform stream compress ops */
911 	const struct snd_compr_ops *compr_ops;
912 
913 	int (*bespoke_trigger)(struct snd_pcm_substream *, int);
914 };
915 
916 struct snd_soc_dai_link_component {
917 	const char *name;
918 	struct device_node *of_node;
919 	const char *dai_name;
920 };
921 
922 struct snd_soc_platform {
923 	struct device *dev;
924 	const struct snd_soc_platform_driver *driver;
925 
926 	struct list_head list;
927 
928 	struct snd_soc_component component;
929 };
930 
931 struct snd_soc_dai_link {
932 	/* config - must be set by machine driver */
933 	const char *name;			/* Codec name */
934 	const char *stream_name;		/* Stream name */
935 	/*
936 	 * You MAY specify the link's CPU-side device, either by device name,
937 	 * or by DT/OF node, but not both. If this information is omitted,
938 	 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
939 	 * must be globally unique. These fields are currently typically used
940 	 * only for codec to codec links, or systems using device tree.
941 	 */
942 	const char *cpu_name;
943 	struct device_node *cpu_of_node;
944 	/*
945 	 * You MAY specify the DAI name of the CPU DAI. If this information is
946 	 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
947 	 * only, which only works well when that device exposes a single DAI.
948 	 */
949 	const char *cpu_dai_name;
950 	/*
951 	 * You MUST specify the link's codec, either by device name, or by
952 	 * DT/OF node, but not both.
953 	 */
954 	const char *codec_name;
955 	struct device_node *codec_of_node;
956 	/* You MUST specify the DAI name within the codec */
957 	const char *codec_dai_name;
958 
959 	struct snd_soc_dai_link_component *codecs;
960 	unsigned int num_codecs;
961 
962 	/*
963 	 * You MAY specify the link's platform/PCM/DMA driver, either by
964 	 * device name, or by DT/OF node, but not both. Some forms of link
965 	 * do not need a platform.
966 	 */
967 	const char *platform_name;
968 	struct device_node *platform_of_node;
969 	int be_id;	/* optional ID for machine driver BE identification */
970 
971 	const struct snd_soc_pcm_stream *params;
972 	unsigned int num_params;
973 
974 	unsigned int dai_fmt;           /* format to set on init */
975 
976 	enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
977 
978 	/* codec/machine specific init - e.g. add machine controls */
979 	int (*init)(struct snd_soc_pcm_runtime *rtd);
980 
981 	/* optional hw_params re-writing for BE and FE sync */
982 	int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
983 			struct snd_pcm_hw_params *params);
984 
985 	/* machine stream operations */
986 	const struct snd_soc_ops *ops;
987 	const struct snd_soc_compr_ops *compr_ops;
988 
989 	/* For unidirectional dai links */
990 	bool playback_only;
991 	bool capture_only;
992 
993 	/* Mark this pcm with non atomic ops */
994 	bool nonatomic;
995 
996 	/* Keep DAI active over suspend */
997 	unsigned int ignore_suspend:1;
998 
999 	/* Symmetry requirements */
1000 	unsigned int symmetric_rates:1;
1001 	unsigned int symmetric_channels:1;
1002 	unsigned int symmetric_samplebits:1;
1003 
1004 	/* Do not create a PCM for this DAI link (Backend link) */
1005 	unsigned int no_pcm:1;
1006 
1007 	/* This DAI link can route to other DAI links at runtime (Frontend)*/
1008 	unsigned int dynamic:1;
1009 
1010 	/* DPCM capture and Playback support */
1011 	unsigned int dpcm_capture:1;
1012 	unsigned int dpcm_playback:1;
1013 
1014 	/* DPCM used FE & BE merged format */
1015 	unsigned int dpcm_merged_format:1;
1016 
1017 	/* pmdown_time is ignored at stop */
1018 	unsigned int ignore_pmdown_time:1;
1019 };
1020 
1021 struct snd_soc_codec_conf {
1022 	/*
1023 	 * specify device either by device name, or by
1024 	 * DT/OF node, but not both.
1025 	 */
1026 	const char *dev_name;
1027 	struct device_node *of_node;
1028 
1029 	/*
1030 	 * optional map of kcontrol, widget and path name prefixes that are
1031 	 * associated per device
1032 	 */
1033 	const char *name_prefix;
1034 };
1035 
1036 struct snd_soc_aux_dev {
1037 	const char *name;		/* Codec name */
1038 
1039 	/*
1040 	 * specify multi-codec either by device name, or by
1041 	 * DT/OF node, but not both.
1042 	 */
1043 	const char *codec_name;
1044 	struct device_node *codec_of_node;
1045 
1046 	/* codec/machine specific init - e.g. add machine controls */
1047 	int (*init)(struct snd_soc_component *component);
1048 };
1049 
1050 /* SoC card */
1051 struct snd_soc_card {
1052 	const char *name;
1053 	const char *long_name;
1054 	const char *driver_name;
1055 	struct device *dev;
1056 	struct snd_card *snd_card;
1057 	struct module *owner;
1058 
1059 	struct mutex mutex;
1060 	struct mutex dapm_mutex;
1061 
1062 	bool instantiated;
1063 
1064 	int (*probe)(struct snd_soc_card *card);
1065 	int (*late_probe)(struct snd_soc_card *card);
1066 	int (*remove)(struct snd_soc_card *card);
1067 
1068 	/* the pre and post PM functions are used to do any PM work before and
1069 	 * after the codec and DAI's do any PM work. */
1070 	int (*suspend_pre)(struct snd_soc_card *card);
1071 	int (*suspend_post)(struct snd_soc_card *card);
1072 	int (*resume_pre)(struct snd_soc_card *card);
1073 	int (*resume_post)(struct snd_soc_card *card);
1074 
1075 	/* callbacks */
1076 	int (*set_bias_level)(struct snd_soc_card *,
1077 			      struct snd_soc_dapm_context *dapm,
1078 			      enum snd_soc_bias_level level);
1079 	int (*set_bias_level_post)(struct snd_soc_card *,
1080 				   struct snd_soc_dapm_context *dapm,
1081 				   enum snd_soc_bias_level level);
1082 
1083 	long pmdown_time;
1084 
1085 	/* CPU <--> Codec DAI links  */
1086 	struct snd_soc_dai_link *dai_link;
1087 	int num_links;
1088 	struct snd_soc_pcm_runtime *rtd;
1089 	int num_rtd;
1090 
1091 	/* optional codec specific configuration */
1092 	struct snd_soc_codec_conf *codec_conf;
1093 	int num_configs;
1094 
1095 	/*
1096 	 * optional auxiliary devices such as amplifiers or codecs with DAI
1097 	 * link unused
1098 	 */
1099 	struct snd_soc_aux_dev *aux_dev;
1100 	int num_aux_devs;
1101 	struct snd_soc_pcm_runtime *rtd_aux;
1102 	int num_aux_rtd;
1103 
1104 	const struct snd_kcontrol_new *controls;
1105 	int num_controls;
1106 
1107 	/*
1108 	 * Card-specific routes and widgets.
1109 	 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1110 	 */
1111 	const struct snd_soc_dapm_widget *dapm_widgets;
1112 	int num_dapm_widgets;
1113 	const struct snd_soc_dapm_route *dapm_routes;
1114 	int num_dapm_routes;
1115 	const struct snd_soc_dapm_widget *of_dapm_widgets;
1116 	int num_of_dapm_widgets;
1117 	const struct snd_soc_dapm_route *of_dapm_routes;
1118 	int num_of_dapm_routes;
1119 	bool fully_routed;
1120 
1121 	struct work_struct deferred_resume_work;
1122 
1123 	/* lists of probed devices belonging to this card */
1124 	struct list_head codec_dev_list;
1125 
1126 	struct list_head widgets;
1127 	struct list_head paths;
1128 	struct list_head dapm_list;
1129 	struct list_head dapm_dirty;
1130 
1131 	/* attached dynamic objects */
1132 	struct list_head dobj_list;
1133 
1134 	/* Generic DAPM context for the card */
1135 	struct snd_soc_dapm_context dapm;
1136 	struct snd_soc_dapm_stats dapm_stats;
1137 	struct snd_soc_dapm_update *update;
1138 
1139 #ifdef CONFIG_DEBUG_FS
1140 	struct dentry *debugfs_card_root;
1141 	struct dentry *debugfs_pop_time;
1142 #endif
1143 	u32 pop_time;
1144 
1145 	void *drvdata;
1146 };
1147 
1148 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1149 struct snd_soc_pcm_runtime {
1150 	struct device *dev;
1151 	struct snd_soc_card *card;
1152 	struct snd_soc_dai_link *dai_link;
1153 	struct mutex pcm_mutex;
1154 	enum snd_soc_pcm_subclass pcm_subclass;
1155 	struct snd_pcm_ops ops;
1156 
1157 	unsigned int dev_registered:1;
1158 
1159 	/* Dynamic PCM BE runtime data */
1160 	struct snd_soc_dpcm_runtime dpcm[2];
1161 	int fe_compr;
1162 
1163 	long pmdown_time;
1164 	unsigned char pop_wait:1;
1165 
1166 	/* runtime devices */
1167 	struct snd_pcm *pcm;
1168 	struct snd_compr *compr;
1169 	struct snd_soc_codec *codec;
1170 	struct snd_soc_platform *platform;
1171 	struct snd_soc_dai *codec_dai;
1172 	struct snd_soc_dai *cpu_dai;
1173 	struct snd_soc_component *component; /* Only valid for AUX dev rtds */
1174 
1175 	struct snd_soc_dai **codec_dais;
1176 	unsigned int num_codecs;
1177 
1178 	struct delayed_work delayed_work;
1179 #ifdef CONFIG_DEBUG_FS
1180 	struct dentry *debugfs_dpcm_root;
1181 	struct dentry *debugfs_dpcm_state;
1182 #endif
1183 };
1184 
1185 /* mixer control */
1186 struct soc_mixer_control {
1187 	int min, max, platform_max;
1188 	int reg, rreg;
1189 	unsigned int shift, rshift;
1190 	unsigned int sign_bit;
1191 	unsigned int invert:1;
1192 	unsigned int autodisable:1;
1193 	struct snd_soc_dobj dobj;
1194 };
1195 
1196 struct soc_bytes {
1197 	int base;
1198 	int num_regs;
1199 	u32 mask;
1200 };
1201 
1202 struct soc_bytes_ext {
1203 	int max;
1204 	struct snd_soc_dobj dobj;
1205 
1206 	/* used for TLV byte control */
1207 	int (*get)(unsigned int __user *bytes, unsigned int size);
1208 	int (*put)(const unsigned int __user *bytes, unsigned int size);
1209 };
1210 
1211 /* multi register control */
1212 struct soc_mreg_control {
1213 	long min, max;
1214 	unsigned int regbase, regcount, nbits, invert;
1215 };
1216 
1217 /* enumerated kcontrol */
1218 struct soc_enum {
1219 	int reg;
1220 	unsigned char shift_l;
1221 	unsigned char shift_r;
1222 	unsigned int items;
1223 	unsigned int mask;
1224 	const char * const *texts;
1225 	const unsigned int *values;
1226 	unsigned int autodisable:1;
1227 	struct snd_soc_dobj dobj;
1228 };
1229 
1230 /**
1231  * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1232  * @component: The component to cast to a CODEC
1233  *
1234  * This function must only be used on components that are known to be CODECs.
1235  * Otherwise the behavior is undefined.
1236  */
1237 static inline struct snd_soc_codec *snd_soc_component_to_codec(
1238 	struct snd_soc_component *component)
1239 {
1240 	return container_of(component, struct snd_soc_codec, component);
1241 }
1242 
1243 /**
1244  * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1245  * @component: The component to cast to a platform
1246  *
1247  * This function must only be used on components that are known to be platforms.
1248  * Otherwise the behavior is undefined.
1249  */
1250 static inline struct snd_soc_platform *snd_soc_component_to_platform(
1251 	struct snd_soc_component *component)
1252 {
1253 	return container_of(component, struct snd_soc_platform, component);
1254 }
1255 
1256 /**
1257  * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
1258  *  embedded in
1259  * @dapm: The DAPM context to cast to the component
1260  *
1261  * This function must only be used on DAPM contexts that are known to be part of
1262  * a component (e.g. in a component driver). Otherwise the behavior is
1263  * undefined.
1264  */
1265 static inline struct snd_soc_component *snd_soc_dapm_to_component(
1266 	struct snd_soc_dapm_context *dapm)
1267 {
1268 	return container_of(dapm, struct snd_soc_component, dapm);
1269 }
1270 
1271 /**
1272  * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in
1273  * @dapm: The DAPM context to cast to the CODEC
1274  *
1275  * This function must only be used on DAPM contexts that are known to be part of
1276  * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1277  */
1278 static inline struct snd_soc_codec *snd_soc_dapm_to_codec(
1279 	struct snd_soc_dapm_context *dapm)
1280 {
1281 	return snd_soc_component_to_codec(snd_soc_dapm_to_component(dapm));
1282 }
1283 
1284 /**
1285  * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is
1286  *  embedded in
1287  * @dapm: The DAPM context to cast to the platform.
1288  *
1289  * This function must only be used on DAPM contexts that are known to be part of
1290  * a platform (e.g. in a platform driver). Otherwise the behavior is undefined.
1291  */
1292 static inline struct snd_soc_platform *snd_soc_dapm_to_platform(
1293 	struct snd_soc_dapm_context *dapm)
1294 {
1295 	return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm));
1296 }
1297 
1298 /**
1299  * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
1300  *  component
1301  * @component: The component for which to get the DAPM context
1302  */
1303 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
1304 	struct snd_soc_component *component)
1305 {
1306 	return &component->dapm;
1307 }
1308 
1309 /**
1310  * snd_soc_codec_get_dapm() - Returns the DAPM context for the CODEC
1311  * @codec: The CODEC for which to get the DAPM context
1312  *
1313  * Note: Use this function instead of directly accessing the CODEC's dapm field
1314  */
1315 static inline struct snd_soc_dapm_context *snd_soc_codec_get_dapm(
1316 	struct snd_soc_codec *codec)
1317 {
1318 	return snd_soc_component_get_dapm(&codec->component);
1319 }
1320 
1321 /**
1322  * snd_soc_dapm_init_bias_level() - Initialize CODEC DAPM bias level
1323  * @codec: The CODEC for which to initialize the DAPM bias level
1324  * @level: The DAPM level to initialize to
1325  *
1326  * Initializes the CODEC DAPM bias level. See snd_soc_dapm_init_bias_level().
1327  */
1328 static inline void snd_soc_codec_init_bias_level(struct snd_soc_codec *codec,
1329 	enum snd_soc_bias_level level)
1330 {
1331 	snd_soc_dapm_init_bias_level(snd_soc_codec_get_dapm(codec), level);
1332 }
1333 
1334 /**
1335  * snd_soc_dapm_get_bias_level() - Get current CODEC DAPM bias level
1336  * @codec: The CODEC for which to get the DAPM bias level
1337  *
1338  * Returns: The current DAPM bias level of the CODEC.
1339  */
1340 static inline enum snd_soc_bias_level snd_soc_codec_get_bias_level(
1341 	struct snd_soc_codec *codec)
1342 {
1343 	return snd_soc_dapm_get_bias_level(snd_soc_codec_get_dapm(codec));
1344 }
1345 
1346 /**
1347  * snd_soc_codec_force_bias_level() - Set the CODEC DAPM bias level
1348  * @codec: The CODEC for which to set the level
1349  * @level: The level to set to
1350  *
1351  * Forces the CODEC bias level to a specific state. See
1352  * snd_soc_dapm_force_bias_level().
1353  */
1354 static inline int snd_soc_codec_force_bias_level(struct snd_soc_codec *codec,
1355 	enum snd_soc_bias_level level)
1356 {
1357 	return snd_soc_dapm_force_bias_level(snd_soc_codec_get_dapm(codec),
1358 		level);
1359 }
1360 
1361 /**
1362  * snd_soc_dapm_kcontrol_codec() - Returns the codec associated to a kcontrol
1363  * @kcontrol: The kcontrol
1364  *
1365  * This function must only be used on DAPM contexts that are known to be part of
1366  * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1367  */
1368 static inline struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(
1369 	struct snd_kcontrol *kcontrol)
1370 {
1371 	return snd_soc_dapm_to_codec(snd_soc_dapm_kcontrol_dapm(kcontrol));
1372 }
1373 
1374 /* codec IO */
1375 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1376 int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg,
1377 	unsigned int val);
1378 
1379 /**
1380  * snd_soc_cache_sync() - Sync the register cache with the hardware
1381  * @codec: CODEC to sync
1382  *
1383  * Note: This function will call regcache_sync()
1384  */
1385 static inline int snd_soc_cache_sync(struct snd_soc_codec *codec)
1386 {
1387 	return regcache_sync(codec->component.regmap);
1388 }
1389 
1390 /* component IO */
1391 int snd_soc_component_read(struct snd_soc_component *component,
1392 	unsigned int reg, unsigned int *val);
1393 int snd_soc_component_write(struct snd_soc_component *component,
1394 	unsigned int reg, unsigned int val);
1395 int snd_soc_component_update_bits(struct snd_soc_component *component,
1396 	unsigned int reg, unsigned int mask, unsigned int val);
1397 int snd_soc_component_update_bits_async(struct snd_soc_component *component,
1398 	unsigned int reg, unsigned int mask, unsigned int val);
1399 void snd_soc_component_async_complete(struct snd_soc_component *component);
1400 int snd_soc_component_test_bits(struct snd_soc_component *component,
1401 	unsigned int reg, unsigned int mask, unsigned int value);
1402 
1403 #ifdef CONFIG_REGMAP
1404 
1405 void snd_soc_component_init_regmap(struct snd_soc_component *component,
1406 	struct regmap *regmap);
1407 void snd_soc_component_exit_regmap(struct snd_soc_component *component);
1408 
1409 /**
1410  * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC
1411  * @codec: The CODEC for which to initialize the regmap instance
1412  * @regmap: The regmap instance that should be used by the CODEC
1413  *
1414  * This function allows deferred assignment of the regmap instance that is
1415  * associated with the CODEC. Only use this if the regmap instance is not yet
1416  * ready when the CODEC is registered. The function must also be called before
1417  * the first IO attempt of the CODEC.
1418  */
1419 static inline void snd_soc_codec_init_regmap(struct snd_soc_codec *codec,
1420 	struct regmap *regmap)
1421 {
1422 	snd_soc_component_init_regmap(&codec->component, regmap);
1423 }
1424 
1425 /**
1426  * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC
1427  * @codec: The CODEC for which to de-initialize the regmap instance
1428  *
1429  * Calls regmap_exit() on the regmap instance associated to the CODEC and
1430  * removes the regmap instance from the CODEC.
1431  *
1432  * This function should only be used if snd_soc_codec_init_regmap() was used to
1433  * initialize the regmap instance.
1434  */
1435 static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec *codec)
1436 {
1437 	snd_soc_component_exit_regmap(&codec->component);
1438 }
1439 
1440 #endif
1441 
1442 /* device driver data */
1443 
1444 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1445 		void *data)
1446 {
1447 	card->drvdata = data;
1448 }
1449 
1450 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1451 {
1452 	return card->drvdata;
1453 }
1454 
1455 static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
1456 		void *data)
1457 {
1458 	dev_set_drvdata(c->dev, data);
1459 }
1460 
1461 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
1462 {
1463 	return dev_get_drvdata(c->dev);
1464 }
1465 
1466 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1467 		void *data)
1468 {
1469 	snd_soc_component_set_drvdata(&codec->component, data);
1470 }
1471 
1472 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1473 {
1474 	return snd_soc_component_get_drvdata(&codec->component);
1475 }
1476 
1477 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1478 		void *data)
1479 {
1480 	snd_soc_component_set_drvdata(&platform->component, data);
1481 }
1482 
1483 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1484 {
1485 	return snd_soc_component_get_drvdata(&platform->component);
1486 }
1487 
1488 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1489 		void *data)
1490 {
1491 	dev_set_drvdata(rtd->dev, data);
1492 }
1493 
1494 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1495 {
1496 	return dev_get_drvdata(rtd->dev);
1497 }
1498 
1499 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1500 {
1501 	INIT_LIST_HEAD(&card->codec_dev_list);
1502 	INIT_LIST_HEAD(&card->widgets);
1503 	INIT_LIST_HEAD(&card->paths);
1504 	INIT_LIST_HEAD(&card->dapm_list);
1505 }
1506 
1507 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1508 {
1509 	if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1510 		return 0;
1511 	/*
1512 	 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1513 	 * mc->reg != mc->rreg means that the control is
1514 	 * stereo (bits in one register or in two registers)
1515 	 */
1516 	return 1;
1517 }
1518 
1519 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1520 	unsigned int val)
1521 {
1522 	unsigned int i;
1523 
1524 	if (!e->values)
1525 		return val;
1526 
1527 	for (i = 0; i < e->items; i++)
1528 		if (val == e->values[i])
1529 			return i;
1530 
1531 	return 0;
1532 }
1533 
1534 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1535 	unsigned int item)
1536 {
1537 	if (!e->values)
1538 		return item;
1539 
1540 	return e->values[item];
1541 }
1542 
1543 static inline bool snd_soc_component_is_active(
1544 	struct snd_soc_component *component)
1545 {
1546 	return component->active != 0;
1547 }
1548 
1549 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1550 {
1551 	return snd_soc_component_is_active(&codec->component);
1552 }
1553 
1554 /**
1555  * snd_soc_kcontrol_component() - Returns the component that registered the
1556  *  control
1557  * @kcontrol: The control for which to get the component
1558  *
1559  * Note: This function will work correctly if the control has been registered
1560  * for a component. Either with snd_soc_add_codec_controls() or
1561  * snd_soc_add_platform_controls() or via  table based setup for either a
1562  * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1563  */
1564 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1565 	struct snd_kcontrol *kcontrol)
1566 {
1567 	return snd_kcontrol_chip(kcontrol);
1568 }
1569 
1570 /**
1571  * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1572  * @kcontrol: The control for which to get the CODEC
1573  *
1574  * Note: This function will only work correctly if the control has been
1575  * registered with snd_soc_add_codec_controls() or via table based setup of
1576  * snd_soc_codec_driver. Otherwise the behavior is undefined.
1577  */
1578 static inline struct snd_soc_codec *snd_soc_kcontrol_codec(
1579 	struct snd_kcontrol *kcontrol)
1580 {
1581 	return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol));
1582 }
1583 
1584 /**
1585  * snd_soc_kcontrol_platform() - Returns the platform that registered the control
1586  * @kcontrol: The control for which to get the platform
1587  *
1588  * Note: This function will only work correctly if the control has been
1589  * registered with snd_soc_add_platform_controls() or via table based setup of
1590  * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1591  */
1592 static inline struct snd_soc_platform *snd_soc_kcontrol_platform(
1593 	struct snd_kcontrol *kcontrol)
1594 {
1595 	return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol));
1596 }
1597 
1598 int snd_soc_util_init(void);
1599 void snd_soc_util_exit(void);
1600 
1601 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1602 			       const char *propname);
1603 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1604 					  const char *propname);
1605 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1606 			      unsigned int *slots,
1607 			      unsigned int *slot_width);
1608 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1609 				   struct snd_soc_codec_conf *codec_conf,
1610 				   struct device_node *of_node,
1611 				   const char *propname);
1612 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1613 				   const char *propname);
1614 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1615 				     const char *prefix,
1616 				     struct device_node **bitclkmaster,
1617 				     struct device_node **framemaster);
1618 int snd_soc_of_get_dai_name(struct device_node *of_node,
1619 			    const char **dai_name);
1620 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1621 				   struct device_node *of_node,
1622 				   struct snd_soc_dai_link *dai_link);
1623 
1624 #include <sound/soc-dai.h>
1625 
1626 #ifdef CONFIG_DEBUG_FS
1627 extern struct dentry *snd_soc_debugfs_root;
1628 #endif
1629 
1630 extern const struct dev_pm_ops snd_soc_pm_ops;
1631 
1632 /* Helper functions */
1633 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1634 {
1635 	mutex_lock(&dapm->card->dapm_mutex);
1636 }
1637 
1638 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1639 {
1640 	mutex_unlock(&dapm->card->dapm_mutex);
1641 }
1642 
1643 #endif
1644