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