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