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