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