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