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
snd_soc_suspend(struct device * dev)445 static inline int snd_soc_suspend(struct device *dev)
446 {
447 return 0;
448 }
449
snd_soc_resume(struct device * dev)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
snd_soc_jack_add_gpios(struct snd_soc_jack * jack,int count,struct snd_soc_jack_gpio * gpios)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
snd_soc_jack_add_gpiods(struct device * gpiod_dev,struct snd_soc_jack * jack,int count,struct snd_soc_jack_gpio * gpios)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
snd_soc_jack_free_gpios(struct snd_soc_jack * jack,int count,struct snd_soc_jack_gpio * gpios)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
snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops * ops,struct platform_device * pdev)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
snd_soc_set_ac97_ops(struct snd_ac97_bus_ops * ops)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
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 void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type,
791 int subseq);
792 int (*stream_event)(struct snd_soc_component *, int event);
793
794 /* probe ordering - for components with runtime dependencies */
795 int probe_order;
796 int remove_order;
797 };
798
799 struct snd_soc_component {
800 const char *name;
801 int id;
802 const char *name_prefix;
803 struct device *dev;
804 struct snd_soc_card *card;
805
806 unsigned int active;
807
808 unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
809 unsigned int registered_as_component:1;
810
811 struct list_head list;
812 struct list_head list_aux; /* for auxiliary component of the card */
813
814 struct snd_soc_dai_driver *dai_drv;
815 int num_dai;
816
817 const struct snd_soc_component_driver *driver;
818
819 struct list_head dai_list;
820
821 int (*read)(struct snd_soc_component *, unsigned int, unsigned int *);
822 int (*write)(struct snd_soc_component *, unsigned int, unsigned int);
823
824 struct regmap *regmap;
825 int val_bytes;
826
827 struct mutex io_mutex;
828
829 /* attached dynamic objects */
830 struct list_head dobj_list;
831
832 #ifdef CONFIG_DEBUG_FS
833 struct dentry *debugfs_root;
834 #endif
835
836 /*
837 * DO NOT use any of the fields below in drivers, they are temporary and
838 * are going to be removed again soon. If you use them in driver code the
839 * driver will be marked as BROKEN when these fields are removed.
840 */
841
842 /* Don't use these, use snd_soc_component_get_dapm() */
843 struct snd_soc_dapm_context dapm;
844
845 const struct snd_kcontrol_new *controls;
846 unsigned int num_controls;
847 const struct snd_soc_dapm_widget *dapm_widgets;
848 unsigned int num_dapm_widgets;
849 const struct snd_soc_dapm_route *dapm_routes;
850 unsigned int num_dapm_routes;
851 struct snd_soc_codec *codec;
852
853 int (*probe)(struct snd_soc_component *);
854 void (*remove)(struct snd_soc_component *);
855
856 /* machine specific init */
857 int (*init)(struct snd_soc_component *component);
858
859 #ifdef CONFIG_DEBUG_FS
860 void (*init_debugfs)(struct snd_soc_component *component);
861 const char *debugfs_prefix;
862 #endif
863 };
864
865 /* SoC Audio Codec device */
866 struct snd_soc_codec {
867 struct device *dev;
868 const struct snd_soc_codec_driver *driver;
869
870 struct list_head list;
871 struct list_head card_list;
872
873 /* runtime */
874 unsigned int cache_bypass:1; /* Suppress access to the cache */
875 unsigned int suspended:1; /* Codec is in suspend PM state */
876 unsigned int cache_init:1; /* codec cache has been initialized */
877
878 /* codec IO */
879 void *control_data; /* codec control (i2c/3wire) data */
880 hw_write_t hw_write;
881 void *reg_cache;
882
883 /* component */
884 struct snd_soc_component component;
885
886 #ifdef CONFIG_DEBUG_FS
887 struct dentry *debugfs_reg;
888 #endif
889 };
890
891 /* codec driver */
892 struct snd_soc_codec_driver {
893
894 /* driver ops */
895 int (*probe)(struct snd_soc_codec *);
896 int (*remove)(struct snd_soc_codec *);
897 int (*suspend)(struct snd_soc_codec *);
898 int (*resume)(struct snd_soc_codec *);
899 struct snd_soc_component_driver component_driver;
900
901 /* codec wide operations */
902 int (*set_sysclk)(struct snd_soc_codec *codec,
903 int clk_id, int source, unsigned int freq, int dir);
904 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
905 unsigned int freq_in, unsigned int freq_out);
906
907 /* codec IO */
908 struct regmap *(*get_regmap)(struct device *);
909 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
910 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
911 unsigned int reg_cache_size;
912 short reg_cache_step;
913 short reg_word_size;
914 const void *reg_cache_default;
915
916 /* codec bias level */
917 int (*set_bias_level)(struct snd_soc_codec *,
918 enum snd_soc_bias_level level);
919 bool idle_bias_off;
920 bool suspend_bias_off;
921
922 void (*seq_notifier)(struct snd_soc_dapm_context *,
923 enum snd_soc_dapm_type, int);
924
925 bool ignore_pmdown_time; /* Doesn't benefit from pmdown delay */
926 };
927
928 /* SoC platform interface */
929 struct snd_soc_platform_driver {
930
931 int (*probe)(struct snd_soc_platform *);
932 int (*remove)(struct snd_soc_platform *);
933 struct snd_soc_component_driver component_driver;
934
935 /* pcm creation and destruction */
936 int (*pcm_new)(struct snd_soc_pcm_runtime *);
937 void (*pcm_free)(struct snd_pcm *);
938
939 /*
940 * For platform caused delay reporting.
941 * Optional.
942 */
943 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
944 struct snd_soc_dai *);
945
946 /* platform stream pcm ops */
947 const struct snd_pcm_ops *ops;
948
949 /* platform stream compress ops */
950 const struct snd_compr_ops *compr_ops;
951
952 int (*bespoke_trigger)(struct snd_pcm_substream *, int);
953 };
954
955 struct snd_soc_dai_link_component {
956 const char *name;
957 struct device_node *of_node;
958 const char *dai_name;
959 };
960
961 struct snd_soc_platform {
962 struct device *dev;
963 const struct snd_soc_platform_driver *driver;
964
965 struct list_head list;
966
967 struct snd_soc_component component;
968 };
969
970 struct snd_soc_dai_link {
971 /* config - must be set by machine driver */
972 const char *name; /* Codec name */
973 const char *stream_name; /* Stream name */
974 /*
975 * You MAY specify the link's CPU-side device, either by device name,
976 * or by DT/OF node, but not both. If this information is omitted,
977 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
978 * must be globally unique. These fields are currently typically used
979 * only for codec to codec links, or systems using device tree.
980 */
981 const char *cpu_name;
982 struct device_node *cpu_of_node;
983 /*
984 * You MAY specify the DAI name of the CPU DAI. If this information is
985 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
986 * only, which only works well when that device exposes a single DAI.
987 */
988 const char *cpu_dai_name;
989 /*
990 * You MUST specify the link's codec, either by device name, or by
991 * DT/OF node, but not both.
992 */
993 const char *codec_name;
994 struct device_node *codec_of_node;
995 /* You MUST specify the DAI name within the codec */
996 const char *codec_dai_name;
997
998 struct snd_soc_dai_link_component *codecs;
999 unsigned int num_codecs;
1000
1001 /*
1002 * You MAY specify the link's platform/PCM/DMA driver, either by
1003 * device name, or by DT/OF node, but not both. Some forms of link
1004 * do not need a platform.
1005 */
1006 const char *platform_name;
1007 struct device_node *platform_of_node;
1008 int id; /* optional ID for machine driver link identification */
1009
1010 const struct snd_soc_pcm_stream *params;
1011 unsigned int num_params;
1012
1013 unsigned int dai_fmt; /* format to set on init */
1014
1015 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
1016
1017 /* codec/machine specific init - e.g. add machine controls */
1018 int (*init)(struct snd_soc_pcm_runtime *rtd);
1019
1020 /* optional hw_params re-writing for BE and FE sync */
1021 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
1022 struct snd_pcm_hw_params *params);
1023
1024 /* machine stream operations */
1025 const struct snd_soc_ops *ops;
1026 const struct snd_soc_compr_ops *compr_ops;
1027
1028 /* For unidirectional dai links */
1029 bool playback_only;
1030 bool capture_only;
1031
1032 /* Mark this pcm with non atomic ops */
1033 bool nonatomic;
1034
1035 /* Keep DAI active over suspend */
1036 unsigned int ignore_suspend:1;
1037
1038 /* Symmetry requirements */
1039 unsigned int symmetric_rates:1;
1040 unsigned int symmetric_channels:1;
1041 unsigned int symmetric_samplebits:1;
1042
1043 /* Do not create a PCM for this DAI link (Backend link) */
1044 unsigned int no_pcm:1;
1045
1046 /* This DAI link can route to other DAI links at runtime (Frontend)*/
1047 unsigned int dynamic:1;
1048
1049 /* DPCM capture and Playback support */
1050 unsigned int dpcm_capture:1;
1051 unsigned int dpcm_playback:1;
1052
1053 /* DPCM used FE & BE merged format */
1054 unsigned int dpcm_merged_format:1;
1055
1056 /* pmdown_time is ignored at stop */
1057 unsigned int ignore_pmdown_time:1;
1058
1059 struct list_head list; /* DAI link list of the soc card */
1060 struct snd_soc_dobj dobj; /* For topology */
1061 };
1062
1063 struct snd_soc_codec_conf {
1064 /*
1065 * specify device either by device name, or by
1066 * DT/OF node, but not both.
1067 */
1068 const char *dev_name;
1069 struct device_node *of_node;
1070
1071 /*
1072 * optional map of kcontrol, widget and path name prefixes that are
1073 * associated per device
1074 */
1075 const char *name_prefix;
1076 };
1077
1078 struct snd_soc_aux_dev {
1079 const char *name; /* Codec name */
1080
1081 /*
1082 * specify multi-codec either by device name, or by
1083 * DT/OF node, but not both.
1084 */
1085 const char *codec_name;
1086 struct device_node *codec_of_node;
1087
1088 /* codec/machine specific init - e.g. add machine controls */
1089 int (*init)(struct snd_soc_component *component);
1090 };
1091
1092 /* SoC card */
1093 struct snd_soc_card {
1094 const char *name;
1095 const char *long_name;
1096 const char *driver_name;
1097 struct device *dev;
1098 struct snd_card *snd_card;
1099 struct module *owner;
1100
1101 struct mutex mutex;
1102 struct mutex dapm_mutex;
1103
1104 bool instantiated;
1105
1106 int (*probe)(struct snd_soc_card *card);
1107 int (*late_probe)(struct snd_soc_card *card);
1108 int (*remove)(struct snd_soc_card *card);
1109
1110 /* the pre and post PM functions are used to do any PM work before and
1111 * after the codec and DAI's do any PM work. */
1112 int (*suspend_pre)(struct snd_soc_card *card);
1113 int (*suspend_post)(struct snd_soc_card *card);
1114 int (*resume_pre)(struct snd_soc_card *card);
1115 int (*resume_post)(struct snd_soc_card *card);
1116
1117 /* callbacks */
1118 int (*set_bias_level)(struct snd_soc_card *,
1119 struct snd_soc_dapm_context *dapm,
1120 enum snd_soc_bias_level level);
1121 int (*set_bias_level_post)(struct snd_soc_card *,
1122 struct snd_soc_dapm_context *dapm,
1123 enum snd_soc_bias_level level);
1124
1125 int (*add_dai_link)(struct snd_soc_card *,
1126 struct snd_soc_dai_link *link);
1127 void (*remove_dai_link)(struct snd_soc_card *,
1128 struct snd_soc_dai_link *link);
1129
1130 long pmdown_time;
1131
1132 /* CPU <--> Codec DAI links */
1133 struct snd_soc_dai_link *dai_link; /* predefined links only */
1134 int num_links; /* predefined links only */
1135 struct list_head dai_link_list; /* all links */
1136 int num_dai_links;
1137
1138 struct list_head rtd_list;
1139 int num_rtd;
1140
1141 /* optional codec specific configuration */
1142 struct snd_soc_codec_conf *codec_conf;
1143 int num_configs;
1144
1145 /*
1146 * optional auxiliary devices such as amplifiers or codecs with DAI
1147 * link unused
1148 */
1149 struct snd_soc_aux_dev *aux_dev;
1150 int num_aux_devs;
1151 struct list_head aux_comp_list;
1152
1153 const struct snd_kcontrol_new *controls;
1154 int num_controls;
1155
1156 /*
1157 * Card-specific routes and widgets.
1158 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1159 */
1160 const struct snd_soc_dapm_widget *dapm_widgets;
1161 int num_dapm_widgets;
1162 const struct snd_soc_dapm_route *dapm_routes;
1163 int num_dapm_routes;
1164 const struct snd_soc_dapm_widget *of_dapm_widgets;
1165 int num_of_dapm_widgets;
1166 const struct snd_soc_dapm_route *of_dapm_routes;
1167 int num_of_dapm_routes;
1168 bool fully_routed;
1169
1170 struct work_struct deferred_resume_work;
1171
1172 /* lists of probed devices belonging to this card */
1173 struct list_head codec_dev_list;
1174
1175 struct list_head widgets;
1176 struct list_head paths;
1177 struct list_head dapm_list;
1178 struct list_head dapm_dirty;
1179
1180 /* attached dynamic objects */
1181 struct list_head dobj_list;
1182
1183 /* Generic DAPM context for the card */
1184 struct snd_soc_dapm_context dapm;
1185 struct snd_soc_dapm_stats dapm_stats;
1186 struct snd_soc_dapm_update *update;
1187
1188 #ifdef CONFIG_DEBUG_FS
1189 struct dentry *debugfs_card_root;
1190 struct dentry *debugfs_pop_time;
1191 #endif
1192 u32 pop_time;
1193
1194 void *drvdata;
1195 };
1196
1197 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1198 struct snd_soc_pcm_runtime {
1199 struct device *dev;
1200 struct snd_soc_card *card;
1201 struct snd_soc_dai_link *dai_link;
1202 struct mutex pcm_mutex;
1203 enum snd_soc_pcm_subclass pcm_subclass;
1204 struct snd_pcm_ops ops;
1205
1206 unsigned int dev_registered:1;
1207
1208 /* Dynamic PCM BE runtime data */
1209 struct snd_soc_dpcm_runtime dpcm[2];
1210 int fe_compr;
1211
1212 long pmdown_time;
1213 unsigned char pop_wait:1;
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 struct snd_soc_component *component; /* Only valid for AUX dev rtds */
1223
1224 struct snd_soc_dai **codec_dais;
1225 unsigned int num_codecs;
1226
1227 struct delayed_work delayed_work;
1228 #ifdef CONFIG_DEBUG_FS
1229 struct dentry *debugfs_dpcm_root;
1230 struct dentry *debugfs_dpcm_state;
1231 #endif
1232
1233 unsigned int num; /* 0-based and monotonic increasing */
1234 struct list_head list; /* rtd list of the soc card */
1235 };
1236
1237 /* mixer control */
1238 struct soc_mixer_control {
1239 int min, max, platform_max;
1240 int reg, rreg;
1241 unsigned int shift, rshift;
1242 unsigned int sign_bit;
1243 unsigned int invert:1;
1244 unsigned int autodisable:1;
1245 struct snd_soc_dobj dobj;
1246 };
1247
1248 struct soc_bytes {
1249 int base;
1250 int num_regs;
1251 u32 mask;
1252 };
1253
1254 struct soc_bytes_ext {
1255 int max;
1256 struct snd_soc_dobj dobj;
1257
1258 /* used for TLV byte control */
1259 int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1260 unsigned int size);
1261 int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1262 unsigned int size);
1263 };
1264
1265 /* multi register control */
1266 struct soc_mreg_control {
1267 long min, max;
1268 unsigned int regbase, regcount, nbits, invert;
1269 };
1270
1271 /* enumerated kcontrol */
1272 struct soc_enum {
1273 int reg;
1274 unsigned char shift_l;
1275 unsigned char shift_r;
1276 unsigned int items;
1277 unsigned int mask;
1278 const char * const *texts;
1279 const unsigned int *values;
1280 unsigned int autodisable:1;
1281 struct snd_soc_dobj dobj;
1282 };
1283
1284 /**
1285 * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1286 * @component: The component to cast to a CODEC
1287 *
1288 * This function must only be used on components that are known to be CODECs.
1289 * Otherwise the behavior is undefined.
1290 */
snd_soc_component_to_codec(struct snd_soc_component * component)1291 static inline struct snd_soc_codec *snd_soc_component_to_codec(
1292 struct snd_soc_component *component)
1293 {
1294 return container_of(component, struct snd_soc_codec, component);
1295 }
1296
1297 /**
1298 * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1299 * @component: The component to cast to a platform
1300 *
1301 * This function must only be used on components that are known to be platforms.
1302 * Otherwise the behavior is undefined.
1303 */
snd_soc_component_to_platform(struct snd_soc_component * component)1304 static inline struct snd_soc_platform *snd_soc_component_to_platform(
1305 struct snd_soc_component *component)
1306 {
1307 return container_of(component, struct snd_soc_platform, component);
1308 }
1309
1310 /**
1311 * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
1312 * embedded in
1313 * @dapm: The DAPM context to cast to the component
1314 *
1315 * This function must only be used on DAPM contexts that are known to be part of
1316 * a component (e.g. in a component driver). Otherwise the behavior is
1317 * undefined.
1318 */
snd_soc_dapm_to_component(struct snd_soc_dapm_context * dapm)1319 static inline struct snd_soc_component *snd_soc_dapm_to_component(
1320 struct snd_soc_dapm_context *dapm)
1321 {
1322 return container_of(dapm, struct snd_soc_component, dapm);
1323 }
1324
1325 /**
1326 * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in
1327 * @dapm: The DAPM context to cast to the CODEC
1328 *
1329 * This function must only be used on DAPM contexts that are known to be part of
1330 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1331 */
snd_soc_dapm_to_codec(struct snd_soc_dapm_context * dapm)1332 static inline struct snd_soc_codec *snd_soc_dapm_to_codec(
1333 struct snd_soc_dapm_context *dapm)
1334 {
1335 return snd_soc_component_to_codec(snd_soc_dapm_to_component(dapm));
1336 }
1337
1338 /**
1339 * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is
1340 * embedded in
1341 * @dapm: The DAPM context to cast to the platform.
1342 *
1343 * This function must only be used on DAPM contexts that are known to be part of
1344 * a platform (e.g. in a platform driver). Otherwise the behavior is undefined.
1345 */
snd_soc_dapm_to_platform(struct snd_soc_dapm_context * dapm)1346 static inline struct snd_soc_platform *snd_soc_dapm_to_platform(
1347 struct snd_soc_dapm_context *dapm)
1348 {
1349 return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm));
1350 }
1351
1352 /**
1353 * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
1354 * component
1355 * @component: The component for which to get the DAPM context
1356 */
snd_soc_component_get_dapm(struct snd_soc_component * component)1357 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
1358 struct snd_soc_component *component)
1359 {
1360 return &component->dapm;
1361 }
1362
1363 /**
1364 * snd_soc_codec_get_dapm() - Returns the DAPM context for the CODEC
1365 * @codec: The CODEC for which to get the DAPM context
1366 *
1367 * Note: Use this function instead of directly accessing the CODEC's dapm field
1368 */
snd_soc_codec_get_dapm(struct snd_soc_codec * codec)1369 static inline struct snd_soc_dapm_context *snd_soc_codec_get_dapm(
1370 struct snd_soc_codec *codec)
1371 {
1372 return snd_soc_component_get_dapm(&codec->component);
1373 }
1374
1375 /**
1376 * snd_soc_dapm_init_bias_level() - Initialize CODEC DAPM bias level
1377 * @codec: The CODEC for which to initialize the DAPM bias level
1378 * @level: The DAPM level to initialize to
1379 *
1380 * Initializes the CODEC DAPM bias level. See snd_soc_dapm_init_bias_level().
1381 */
snd_soc_codec_init_bias_level(struct snd_soc_codec * codec,enum snd_soc_bias_level level)1382 static inline void snd_soc_codec_init_bias_level(struct snd_soc_codec *codec,
1383 enum snd_soc_bias_level level)
1384 {
1385 snd_soc_dapm_init_bias_level(snd_soc_codec_get_dapm(codec), level);
1386 }
1387
1388 /**
1389 * snd_soc_dapm_get_bias_level() - Get current CODEC DAPM bias level
1390 * @codec: The CODEC for which to get the DAPM bias level
1391 *
1392 * Returns: The current DAPM bias level of the CODEC.
1393 */
snd_soc_codec_get_bias_level(struct snd_soc_codec * codec)1394 static inline enum snd_soc_bias_level snd_soc_codec_get_bias_level(
1395 struct snd_soc_codec *codec)
1396 {
1397 return snd_soc_dapm_get_bias_level(snd_soc_codec_get_dapm(codec));
1398 }
1399
1400 /**
1401 * snd_soc_codec_force_bias_level() - Set the CODEC DAPM bias level
1402 * @codec: The CODEC for which to set the level
1403 * @level: The level to set to
1404 *
1405 * Forces the CODEC bias level to a specific state. See
1406 * snd_soc_dapm_force_bias_level().
1407 */
snd_soc_codec_force_bias_level(struct snd_soc_codec * codec,enum snd_soc_bias_level level)1408 static inline int snd_soc_codec_force_bias_level(struct snd_soc_codec *codec,
1409 enum snd_soc_bias_level level)
1410 {
1411 return snd_soc_dapm_force_bias_level(snd_soc_codec_get_dapm(codec),
1412 level);
1413 }
1414
1415 /**
1416 * snd_soc_dapm_kcontrol_codec() - Returns the codec associated to a kcontrol
1417 * @kcontrol: The kcontrol
1418 *
1419 * This function must only be used on DAPM contexts that are known to be part of
1420 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1421 */
snd_soc_dapm_kcontrol_codec(struct snd_kcontrol * kcontrol)1422 static inline struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(
1423 struct snd_kcontrol *kcontrol)
1424 {
1425 return snd_soc_dapm_to_codec(snd_soc_dapm_kcontrol_dapm(kcontrol));
1426 }
1427
1428 /* codec IO */
1429 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1430 int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg,
1431 unsigned int val);
1432
1433 /**
1434 * snd_soc_cache_sync() - Sync the register cache with the hardware
1435 * @codec: CODEC to sync
1436 *
1437 * Note: This function will call regcache_sync()
1438 */
snd_soc_cache_sync(struct snd_soc_codec * codec)1439 static inline int snd_soc_cache_sync(struct snd_soc_codec *codec)
1440 {
1441 return regcache_sync(codec->component.regmap);
1442 }
1443
1444 /* component IO */
1445 int snd_soc_component_read(struct snd_soc_component *component,
1446 unsigned int reg, unsigned int *val);
1447 int snd_soc_component_write(struct snd_soc_component *component,
1448 unsigned int reg, unsigned int val);
1449 int snd_soc_component_update_bits(struct snd_soc_component *component,
1450 unsigned int reg, unsigned int mask, unsigned int val);
1451 int snd_soc_component_update_bits_async(struct snd_soc_component *component,
1452 unsigned int reg, unsigned int mask, unsigned int val);
1453 void snd_soc_component_async_complete(struct snd_soc_component *component);
1454 int snd_soc_component_test_bits(struct snd_soc_component *component,
1455 unsigned int reg, unsigned int mask, unsigned int value);
1456
1457 #ifdef CONFIG_REGMAP
1458
1459 void snd_soc_component_init_regmap(struct snd_soc_component *component,
1460 struct regmap *regmap);
1461 void snd_soc_component_exit_regmap(struct snd_soc_component *component);
1462
1463 /**
1464 * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC
1465 * @codec: The CODEC for which to initialize the regmap instance
1466 * @regmap: The regmap instance that should be used by the CODEC
1467 *
1468 * This function allows deferred assignment of the regmap instance that is
1469 * associated with the CODEC. Only use this if the regmap instance is not yet
1470 * ready when the CODEC is registered. The function must also be called before
1471 * the first IO attempt of the CODEC.
1472 */
snd_soc_codec_init_regmap(struct snd_soc_codec * codec,struct regmap * regmap)1473 static inline void snd_soc_codec_init_regmap(struct snd_soc_codec *codec,
1474 struct regmap *regmap)
1475 {
1476 snd_soc_component_init_regmap(&codec->component, regmap);
1477 }
1478
1479 /**
1480 * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC
1481 * @codec: The CODEC for which to de-initialize the regmap instance
1482 *
1483 * Calls regmap_exit() on the regmap instance associated to the CODEC and
1484 * removes the regmap instance from the CODEC.
1485 *
1486 * This function should only be used if snd_soc_codec_init_regmap() was used to
1487 * initialize the regmap instance.
1488 */
snd_soc_codec_exit_regmap(struct snd_soc_codec * codec)1489 static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec *codec)
1490 {
1491 snd_soc_component_exit_regmap(&codec->component);
1492 }
1493
1494 #endif
1495
1496 /* device driver data */
1497
snd_soc_card_set_drvdata(struct snd_soc_card * card,void * data)1498 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1499 void *data)
1500 {
1501 card->drvdata = data;
1502 }
1503
snd_soc_card_get_drvdata(struct snd_soc_card * card)1504 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1505 {
1506 return card->drvdata;
1507 }
1508
snd_soc_component_set_drvdata(struct snd_soc_component * c,void * data)1509 static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
1510 void *data)
1511 {
1512 dev_set_drvdata(c->dev, data);
1513 }
1514
snd_soc_component_get_drvdata(struct snd_soc_component * c)1515 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
1516 {
1517 return dev_get_drvdata(c->dev);
1518 }
1519
snd_soc_codec_set_drvdata(struct snd_soc_codec * codec,void * data)1520 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1521 void *data)
1522 {
1523 snd_soc_component_set_drvdata(&codec->component, data);
1524 }
1525
snd_soc_codec_get_drvdata(struct snd_soc_codec * codec)1526 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1527 {
1528 return snd_soc_component_get_drvdata(&codec->component);
1529 }
1530
snd_soc_platform_set_drvdata(struct snd_soc_platform * platform,void * data)1531 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1532 void *data)
1533 {
1534 snd_soc_component_set_drvdata(&platform->component, data);
1535 }
1536
snd_soc_platform_get_drvdata(struct snd_soc_platform * platform)1537 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1538 {
1539 return snd_soc_component_get_drvdata(&platform->component);
1540 }
1541
snd_soc_initialize_card_lists(struct snd_soc_card * card)1542 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1543 {
1544 INIT_LIST_HEAD(&card->codec_dev_list);
1545 INIT_LIST_HEAD(&card->widgets);
1546 INIT_LIST_HEAD(&card->paths);
1547 INIT_LIST_HEAD(&card->dapm_list);
1548 INIT_LIST_HEAD(&card->aux_comp_list);
1549 }
1550
snd_soc_volsw_is_stereo(struct soc_mixer_control * mc)1551 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1552 {
1553 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1554 return 0;
1555 /*
1556 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1557 * mc->reg != mc->rreg means that the control is
1558 * stereo (bits in one register or in two registers)
1559 */
1560 return 1;
1561 }
1562
snd_soc_enum_val_to_item(struct soc_enum * e,unsigned int val)1563 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1564 unsigned int val)
1565 {
1566 unsigned int i;
1567
1568 if (!e->values)
1569 return val;
1570
1571 for (i = 0; i < e->items; i++)
1572 if (val == e->values[i])
1573 return i;
1574
1575 return 0;
1576 }
1577
snd_soc_enum_item_to_val(struct soc_enum * e,unsigned int item)1578 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1579 unsigned int item)
1580 {
1581 if (!e->values)
1582 return item;
1583
1584 return e->values[item];
1585 }
1586
snd_soc_component_is_active(struct snd_soc_component * component)1587 static inline bool snd_soc_component_is_active(
1588 struct snd_soc_component *component)
1589 {
1590 return component->active != 0;
1591 }
1592
snd_soc_codec_is_active(struct snd_soc_codec * codec)1593 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1594 {
1595 return snd_soc_component_is_active(&codec->component);
1596 }
1597
1598 /**
1599 * snd_soc_kcontrol_component() - Returns the component that registered the
1600 * control
1601 * @kcontrol: The control for which to get the component
1602 *
1603 * Note: This function will work correctly if the control has been registered
1604 * for a component. Either with snd_soc_add_codec_controls() or
1605 * snd_soc_add_platform_controls() or via table based setup for either a
1606 * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1607 */
snd_soc_kcontrol_component(struct snd_kcontrol * kcontrol)1608 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1609 struct snd_kcontrol *kcontrol)
1610 {
1611 return snd_kcontrol_chip(kcontrol);
1612 }
1613
1614 /**
1615 * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1616 * @kcontrol: The control for which to get the CODEC
1617 *
1618 * Note: This function will only work correctly if the control has been
1619 * registered with snd_soc_add_codec_controls() or via table based setup of
1620 * snd_soc_codec_driver. Otherwise the behavior is undefined.
1621 */
snd_soc_kcontrol_codec(struct snd_kcontrol * kcontrol)1622 static inline struct snd_soc_codec *snd_soc_kcontrol_codec(
1623 struct snd_kcontrol *kcontrol)
1624 {
1625 return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol));
1626 }
1627
1628 /**
1629 * snd_soc_kcontrol_platform() - Returns the platform that registered the control
1630 * @kcontrol: The control for which to get the platform
1631 *
1632 * Note: This function will only work correctly if the control has been
1633 * registered with snd_soc_add_platform_controls() or via table based setup of
1634 * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1635 */
snd_soc_kcontrol_platform(struct snd_kcontrol * kcontrol)1636 static inline struct snd_soc_platform *snd_soc_kcontrol_platform(
1637 struct snd_kcontrol *kcontrol)
1638 {
1639 return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol));
1640 }
1641
1642 int snd_soc_util_init(void);
1643 void snd_soc_util_exit(void);
1644
1645 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1646 const char *propname);
1647 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1648 const char *propname);
1649 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1650 unsigned int *tx_mask,
1651 unsigned int *rx_mask,
1652 unsigned int *slots,
1653 unsigned int *slot_width);
1654 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1655 struct snd_soc_codec_conf *codec_conf,
1656 struct device_node *of_node,
1657 const char *propname);
1658 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1659 const char *propname);
1660 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1661 const char *prefix,
1662 struct device_node **bitclkmaster,
1663 struct device_node **framemaster);
1664 int snd_soc_of_get_dai_name(struct device_node *of_node,
1665 const char **dai_name);
1666 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1667 struct device_node *of_node,
1668 struct snd_soc_dai_link *dai_link);
1669
1670 int snd_soc_add_dai_link(struct snd_soc_card *card,
1671 struct snd_soc_dai_link *dai_link);
1672 void snd_soc_remove_dai_link(struct snd_soc_card *card,
1673 struct snd_soc_dai_link *dai_link);
1674
1675 int snd_soc_register_dai(struct snd_soc_component *component,
1676 struct snd_soc_dai_driver *dai_drv);
1677
1678 struct snd_soc_dai *snd_soc_find_dai(
1679 const struct snd_soc_dai_link_component *dlc);
1680
1681 #include <sound/soc-dai.h>
1682
1683 #ifdef CONFIG_DEBUG_FS
1684 extern struct dentry *snd_soc_debugfs_root;
1685 #endif
1686
1687 extern const struct dev_pm_ops snd_soc_pm_ops;
1688
1689 /* Helper functions */
snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context * dapm)1690 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1691 {
1692 mutex_lock_nested(&dapm->card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
1693 }
1694
snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context * dapm)1695 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1696 {
1697 mutex_unlock(&dapm->card->dapm_mutex);
1698 }
1699
1700 #endif
1701