2 * linux/sound/soc.h -- ALSA SoC Layer
4 * Author: Liam Girdwood
5 * Created: Aug 11th 2005
6 * Copyright: Wolfson Microelectronics. PLC.
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.
13 #ifndef __LINUX_SND_SOC_H
14 #define __LINUX_SND_SOC_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 #include <sound/soc-topology.h>
33 * Convenience kcontrol builders
35 #define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert, xautodisable) \
36 ((unsigned long)&(struct soc_mixer_control) \
37 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
38 .rshift = shift_right, .max = xmax, .platform_max = xmax, \
39 .invert = xinvert, .autodisable = xautodisable})
40 #define SOC_DOUBLE_S_VALUE(xreg, shift_left, shift_right, xmin, xmax, xsign_bit, xinvert, xautodisable) \
41 ((unsigned long)&(struct soc_mixer_control) \
42 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
43 .rshift = shift_right, .min = xmin, .max = xmax, .platform_max = xmax, \
44 .sign_bit = xsign_bit, .invert = xinvert, .autodisable = xautodisable})
45 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \
46 SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable)
47 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
48 ((unsigned long)&(struct soc_mixer_control) \
49 {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
50 #define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
51 ((unsigned long)&(struct soc_mixer_control) \
52 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
53 .max = xmax, .platform_max = xmax, .invert = xinvert})
54 #define SOC_DOUBLE_R_S_VALUE(xlreg, xrreg, xshift, xmin, xmax, xsign_bit, xinvert) \
55 ((unsigned long)&(struct soc_mixer_control) \
56 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
57 .max = xmax, .min = xmin, .platform_max = xmax, .sign_bit = xsign_bit, \
59 #define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
60 ((unsigned long)&(struct soc_mixer_control) \
61 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
62 .min = xmin, .max = xmax, .platform_max = xmax, .invert = xinvert})
63 #define SOC_SINGLE(xname, reg, shift, max, invert) \
64 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
65 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
66 .put = snd_soc_put_volsw, \
67 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
68 #define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
69 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
70 .info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
71 .put = snd_soc_put_volsw_range, \
72 .private_value = (unsigned long)&(struct soc_mixer_control) \
73 {.reg = xreg, .rreg = xreg, .shift = xshift, \
74 .rshift = xshift, .min = xmin, .max = xmax, \
75 .platform_max = xmax, .invert = xinvert} }
76 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
77 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
78 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
79 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
80 .tlv.p = (tlv_array), \
81 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
82 .put = snd_soc_put_volsw, \
83 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
84 #define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
85 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
86 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
87 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
88 .tlv.p = (tlv_array),\
89 .info = snd_soc_info_volsw_sx, \
90 .get = snd_soc_get_volsw_sx,\
91 .put = snd_soc_put_volsw_sx, \
92 .private_value = (unsigned long)&(struct soc_mixer_control) \
93 {.reg = xreg, .rreg = xreg, \
94 .shift = xshift, .rshift = xshift, \
95 .max = xmax, .min = xmin} }
96 #define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
97 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
98 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
99 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
100 .tlv.p = (tlv_array), \
101 .info = snd_soc_info_volsw_range, \
102 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
103 .private_value = (unsigned long)&(struct soc_mixer_control) \
104 {.reg = xreg, .rreg = xreg, .shift = xshift, \
105 .rshift = xshift, .min = xmin, .max = xmax, \
106 .platform_max = xmax, .invert = xinvert} }
107 #define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
108 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
109 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
110 .put = snd_soc_put_volsw, \
111 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
113 #define SOC_DOUBLE_STS(xname, reg, shift_left, shift_right, max, invert) \
115 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
116 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
117 .access = SNDRV_CTL_ELEM_ACCESS_READ | \
118 SNDRV_CTL_ELEM_ACCESS_VOLATILE, \
119 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
121 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
122 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
123 .info = snd_soc_info_volsw, \
124 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
125 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
127 #define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
129 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
130 .info = snd_soc_info_volsw_range, \
131 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
132 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
133 xshift, xmin, xmax, xinvert) }
134 #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
135 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
136 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
137 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
138 .tlv.p = (tlv_array), \
139 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
140 .put = snd_soc_put_volsw, \
141 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
143 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
144 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
145 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
146 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
147 .tlv.p = (tlv_array), \
148 .info = snd_soc_info_volsw, \
149 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
150 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
152 #define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
153 xmax, xinvert, tlv_array) \
154 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
155 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
156 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
157 .tlv.p = (tlv_array), \
158 .info = snd_soc_info_volsw_range, \
159 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
160 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
161 xshift, xmin, xmax, xinvert) }
162 #define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
163 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
164 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
165 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
166 .tlv.p = (tlv_array), \
167 .info = snd_soc_info_volsw_sx, \
168 .get = snd_soc_get_volsw_sx, \
169 .put = snd_soc_put_volsw_sx, \
170 .private_value = (unsigned long)&(struct soc_mixer_control) \
171 {.reg = xreg, .rreg = xrreg, \
172 .shift = xshift, .rshift = xshift, \
173 .max = xmax, .min = xmin} }
174 #define SOC_DOUBLE_R_S_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
175 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
176 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
177 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
178 .tlv.p = (tlv_array), \
179 .info = snd_soc_info_volsw, \
180 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
181 .private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
182 xmin, xmax, xsign_bit, xinvert) }
183 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
184 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
185 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
186 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
187 .tlv.p = (tlv_array), \
188 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
189 .put = snd_soc_put_volsw, \
190 .private_value = SOC_DOUBLE_S_VALUE(xreg, 0, 8, xmin, xmax, 7, 0, 0) }
191 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \
192 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
193 .items = xitems, .texts = xtexts, \
194 .mask = xitems ? roundup_pow_of_two(xitems) - 1 : 0}
195 #define SOC_ENUM_SINGLE(xreg, xshift, xitems, xtexts) \
196 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xitems, xtexts)
197 #define SOC_ENUM_SINGLE_EXT(xitems, xtexts) \
198 { .items = xitems, .texts = xtexts }
199 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xitems, xtexts, xvalues) \
200 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
201 .mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues}
202 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
203 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xitems, xtexts, xvalues)
204 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
205 { .reg = xreg, .shift_l = xshift, .shift_r = xshift, \
206 .mask = xmask, .items = xitems, .texts = xtexts, \
207 .values = xvalues, .autodisable = 1}
208 #define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \
209 SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
210 #define SOC_ENUM(xname, xenum) \
211 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
212 .info = snd_soc_info_enum_double, \
213 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
214 .private_value = (unsigned long)&xenum }
215 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
216 xhandler_get, xhandler_put) \
217 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
218 .info = snd_soc_info_volsw, \
219 .get = xhandler_get, .put = xhandler_put, \
220 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
221 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
222 xhandler_get, xhandler_put) \
223 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
224 .info = snd_soc_info_volsw, \
225 .get = xhandler_get, .put = xhandler_put, \
227 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
228 #define SOC_DOUBLE_R_EXT(xname, reg_left, reg_right, xshift, xmax, xinvert,\
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 = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
235 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
236 xhandler_get, xhandler_put, tlv_array) \
237 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
238 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
239 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
240 .tlv.p = (tlv_array), \
241 .info = snd_soc_info_volsw, \
242 .get = xhandler_get, .put = xhandler_put, \
243 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
244 #define SOC_SINGLE_RANGE_EXT_TLV(xname, xreg, xshift, xmin, xmax, xinvert, \
245 xhandler_get, xhandler_put, tlv_array) \
246 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
247 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
248 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
249 .tlv.p = (tlv_array), \
250 .info = snd_soc_info_volsw_range, \
251 .get = xhandler_get, .put = xhandler_put, \
252 .private_value = (unsigned long)&(struct soc_mixer_control) \
253 {.reg = xreg, .rreg = xreg, .shift = xshift, \
254 .rshift = xshift, .min = xmin, .max = xmax, \
255 .platform_max = xmax, .invert = xinvert} }
256 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
257 xhandler_get, xhandler_put, tlv_array) \
258 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
259 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
260 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
261 .tlv.p = (tlv_array), \
262 .info = snd_soc_info_volsw, \
263 .get = xhandler_get, .put = xhandler_put, \
264 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
266 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, 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_R_VALUE(reg_left, reg_right, xshift, \
276 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
277 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
278 .info = snd_soc_info_bool_ext, \
279 .get = xhandler_get, .put = xhandler_put, \
280 .private_value = xdata }
281 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
282 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
283 .info = snd_soc_info_enum_double, \
284 .get = xhandler_get, .put = xhandler_put, \
285 .private_value = (unsigned long)&xenum }
286 #define SOC_VALUE_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
287 SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put)
289 #define SND_SOC_BYTES(xname, xbase, xregs) \
290 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
291 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
292 .put = snd_soc_bytes_put, .private_value = \
293 ((unsigned long)&(struct soc_bytes) \
294 {.base = xbase, .num_regs = xregs }) }
296 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask) \
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, \
305 * SND_SOC_BYTES_EXT is deprecated, please USE SND_SOC_BYTES_TLV instead
307 #define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \
308 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
309 .info = snd_soc_bytes_info_ext, \
310 .get = xhandler_get, .put = xhandler_put, \
311 .private_value = (unsigned long)&(struct soc_bytes_ext) \
313 #define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \
314 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
315 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \
316 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
317 .tlv.c = (snd_soc_bytes_tlv_callback), \
318 .info = snd_soc_bytes_info_ext, \
319 .private_value = (unsigned long)&(struct soc_bytes_ext) \
320 {.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
321 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
322 xmin, xmax, xinvert) \
323 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
324 .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
325 .put = snd_soc_put_xr_sx, \
326 .private_value = (unsigned long)&(struct soc_mreg_control) \
327 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
328 .invert = xinvert, .min = xmin, .max = xmax} }
330 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
331 SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
332 snd_soc_get_strobe, snd_soc_put_strobe)
335 * Simplified versions of above macros, declaring a struct and calculating
336 * ARRAY_SIZE internally
338 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
339 const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
340 ARRAY_SIZE(xtexts), xtexts)
341 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
342 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
343 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
344 const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
345 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
346 const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
347 ARRAY_SIZE(xtexts), xtexts, xvalues)
348 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
349 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
351 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
352 const struct soc_enum name = SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, \
353 xshift, xmask, ARRAY_SIZE(xtexts), xtexts, xvalues)
355 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
356 const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
359 * Component probe and remove ordering levels for components with runtime
362 #define SND_SOC_COMP_ORDER_FIRST -2
363 #define SND_SOC_COMP_ORDER_EARLY -1
364 #define SND_SOC_COMP_ORDER_NORMAL 0
365 #define SND_SOC_COMP_ORDER_LATE 1
366 #define SND_SOC_COMP_ORDER_LAST 2
371 * @ON: Bias is fully on for audio playback and capture operations.
372 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
373 * stream start and stop operations.
374 * @STANDBY: Low power standby state when no playback/capture operations are
375 * in progress. NOTE: The transition time between STANDBY and ON
376 * should be as fast as possible and no longer than 10ms.
377 * @OFF: Power Off. No restrictions on transition times.
379 enum snd_soc_bias_level
{
380 SND_SOC_BIAS_OFF
= 0,
381 SND_SOC_BIAS_STANDBY
= 1,
382 SND_SOC_BIAS_PREPARE
= 2,
389 struct snd_soc_pcm_stream
;
391 struct snd_soc_pcm_runtime
;
393 struct snd_soc_dai_driver
;
394 struct snd_soc_platform
;
395 struct snd_soc_dai_link
;
396 struct snd_soc_platform_driver
;
397 struct snd_soc_codec
;
398 struct snd_soc_codec_driver
;
399 struct snd_soc_component
;
400 struct snd_soc_component_driver
;
403 struct snd_soc_jack_zone
;
404 struct snd_soc_jack_pin
;
405 #include <sound/soc-dapm.h>
406 #include <sound/soc-dpcm.h>
408 struct snd_soc_jack_gpio
;
410 typedef int (*hw_write_t
)(void *,const char* ,int);
412 enum snd_soc_pcm_subclass
{
413 SND_SOC_PCM_CLASS_PCM
= 0,
414 SND_SOC_PCM_CLASS_BE
= 1,
417 enum snd_soc_card_subclass
{
418 SND_SOC_CARD_CLASS_INIT
= 0,
419 SND_SOC_CARD_CLASS_RUNTIME
= 1,
422 int snd_soc_codec_set_sysclk(struct snd_soc_codec
*codec
, int clk_id
,
423 int source
, unsigned int freq
, int dir
);
424 int snd_soc_codec_set_pll(struct snd_soc_codec
*codec
, int pll_id
, int source
,
425 unsigned int freq_in
, unsigned int freq_out
);
427 int snd_soc_register_card(struct snd_soc_card
*card
);
428 int snd_soc_unregister_card(struct snd_soc_card
*card
);
429 int devm_snd_soc_register_card(struct device
*dev
, struct snd_soc_card
*card
);
430 #ifdef CONFIG_PM_SLEEP
431 int snd_soc_suspend(struct device
*dev
);
432 int snd_soc_resume(struct device
*dev
);
434 static inline int snd_soc_suspend(struct device
*dev
)
439 static inline int snd_soc_resume(struct device
*dev
)
444 int snd_soc_poweroff(struct device
*dev
);
445 int snd_soc_register_platform(struct device
*dev
,
446 const struct snd_soc_platform_driver
*platform_drv
);
447 int devm_snd_soc_register_platform(struct device
*dev
,
448 const struct snd_soc_platform_driver
*platform_drv
);
449 void snd_soc_unregister_platform(struct device
*dev
);
450 int snd_soc_add_platform(struct device
*dev
, struct snd_soc_platform
*platform
,
451 const struct snd_soc_platform_driver
*platform_drv
);
452 void snd_soc_remove_platform(struct snd_soc_platform
*platform
);
453 struct snd_soc_platform
*snd_soc_lookup_platform(struct device
*dev
);
454 int snd_soc_register_codec(struct device
*dev
,
455 const struct snd_soc_codec_driver
*codec_drv
,
456 struct snd_soc_dai_driver
*dai_drv
, int num_dai
);
457 void snd_soc_unregister_codec(struct device
*dev
);
458 int snd_soc_register_component(struct device
*dev
,
459 const struct snd_soc_component_driver
*cmpnt_drv
,
460 struct snd_soc_dai_driver
*dai_drv
, int num_dai
);
461 int devm_snd_soc_register_component(struct device
*dev
,
462 const struct snd_soc_component_driver
*cmpnt_drv
,
463 struct snd_soc_dai_driver
*dai_drv
, int num_dai
);
464 void snd_soc_unregister_component(struct device
*dev
);
465 int snd_soc_cache_init(struct snd_soc_codec
*codec
);
466 int snd_soc_cache_exit(struct snd_soc_codec
*codec
);
468 int snd_soc_platform_read(struct snd_soc_platform
*platform
,
470 int snd_soc_platform_write(struct snd_soc_platform
*platform
,
471 unsigned int reg
, unsigned int val
);
472 int soc_new_pcm(struct snd_soc_pcm_runtime
*rtd
, int num
);
473 #ifdef CONFIG_SND_SOC_COMPRESS
474 int snd_soc_new_compress(struct snd_soc_pcm_runtime
*rtd
, int num
);
477 struct snd_pcm_substream
*snd_soc_get_dai_substream(struct snd_soc_card
*card
,
478 const char *dai_link
, int stream
);
479 struct snd_soc_pcm_runtime
*snd_soc_get_pcm_runtime(struct snd_soc_card
*card
,
480 const char *dai_link
);
482 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime
*rtd
);
483 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime
*rtd
, int stream
);
484 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime
*rtd
, int stream
);
486 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime
*rtd
,
487 unsigned int dai_fmt
);
489 /* Utility functions to get clock rates from various things */
490 int snd_soc_calc_frame_size(int sample_size
, int channels
, int tdm_slots
);
491 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params
*params
);
492 int snd_soc_calc_bclk(int fs
, int sample_size
, int channels
, int tdm_slots
);
493 int snd_soc_params_to_bclk(struct snd_pcm_hw_params
*parms
);
495 /* set runtime hw params */
496 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream
*substream
,
497 const struct snd_pcm_hardware
*hw
);
499 int snd_soc_platform_trigger(struct snd_pcm_substream
*substream
,
500 int cmd
, struct snd_soc_platform
*platform
);
502 int soc_dai_hw_params(struct snd_pcm_substream
*substream
,
503 struct snd_pcm_hw_params
*params
,
504 struct snd_soc_dai
*dai
);
507 int snd_soc_card_jack_new(struct snd_soc_card
*card
, const char *id
, int type
,
508 struct snd_soc_jack
*jack
, struct snd_soc_jack_pin
*pins
,
509 unsigned int num_pins
);
511 void snd_soc_jack_report(struct snd_soc_jack
*jack
, int status
, int mask
);
512 int snd_soc_jack_add_pins(struct snd_soc_jack
*jack
, int count
,
513 struct snd_soc_jack_pin
*pins
);
514 void snd_soc_jack_notifier_register(struct snd_soc_jack
*jack
,
515 struct notifier_block
*nb
);
516 void snd_soc_jack_notifier_unregister(struct snd_soc_jack
*jack
,
517 struct notifier_block
*nb
);
518 int snd_soc_jack_add_zones(struct snd_soc_jack
*jack
, int count
,
519 struct snd_soc_jack_zone
*zones
);
520 int snd_soc_jack_get_type(struct snd_soc_jack
*jack
, int micbias_voltage
);
521 #ifdef CONFIG_GPIOLIB
522 int snd_soc_jack_add_gpios(struct snd_soc_jack
*jack
, int count
,
523 struct snd_soc_jack_gpio
*gpios
);
524 int snd_soc_jack_add_gpiods(struct device
*gpiod_dev
,
525 struct snd_soc_jack
*jack
,
526 int count
, struct snd_soc_jack_gpio
*gpios
);
527 void snd_soc_jack_free_gpios(struct snd_soc_jack
*jack
, int count
,
528 struct snd_soc_jack_gpio
*gpios
);
530 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack
*jack
, int count
,
531 struct snd_soc_jack_gpio
*gpios
)
536 static inline int snd_soc_jack_add_gpiods(struct device
*gpiod_dev
,
537 struct snd_soc_jack
*jack
,
539 struct snd_soc_jack_gpio
*gpios
)
544 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack
*jack
, int count
,
545 struct snd_soc_jack_gpio
*gpios
)
550 /* codec register bit access */
551 int snd_soc_update_bits(struct snd_soc_codec
*codec
, unsigned int reg
,
552 unsigned int mask
, unsigned int value
);
553 int snd_soc_update_bits_locked(struct snd_soc_codec
*codec
,
554 unsigned int reg
, unsigned int mask
,
556 int snd_soc_test_bits(struct snd_soc_codec
*codec
, unsigned int reg
,
557 unsigned int mask
, unsigned int value
);
559 #ifdef CONFIG_SND_SOC_AC97_BUS
560 struct snd_ac97
*snd_soc_alloc_ac97_codec(struct snd_soc_codec
*codec
);
561 struct snd_ac97
*snd_soc_new_ac97_codec(struct snd_soc_codec
*codec
,
562 unsigned int id
, unsigned int id_mask
);
563 void snd_soc_free_ac97_codec(struct snd_ac97
*ac97
);
565 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops
*ops
);
566 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops
*ops
,
567 struct platform_device
*pdev
);
569 extern struct snd_ac97_bus_ops
*soc_ac97_ops
;
571 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops
*ops
,
572 struct platform_device
*pdev
)
577 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops
*ops
)
586 struct snd_kcontrol
*snd_soc_cnew(const struct snd_kcontrol_new
*_template
,
587 void *data
, const char *long_name
,
589 struct snd_kcontrol
*snd_soc_card_get_kcontrol(struct snd_soc_card
*soc_card
,
591 int snd_soc_add_component_controls(struct snd_soc_component
*component
,
592 const struct snd_kcontrol_new
*controls
, unsigned int num_controls
);
593 int snd_soc_add_codec_controls(struct snd_soc_codec
*codec
,
594 const struct snd_kcontrol_new
*controls
, unsigned int num_controls
);
595 int snd_soc_add_platform_controls(struct snd_soc_platform
*platform
,
596 const struct snd_kcontrol_new
*controls
, unsigned int num_controls
);
597 int snd_soc_add_card_controls(struct snd_soc_card
*soc_card
,
598 const struct snd_kcontrol_new
*controls
, int num_controls
);
599 int snd_soc_add_dai_controls(struct snd_soc_dai
*dai
,
600 const struct snd_kcontrol_new
*controls
, int num_controls
);
601 int snd_soc_info_enum_double(struct snd_kcontrol
*kcontrol
,
602 struct snd_ctl_elem_info
*uinfo
);
603 int snd_soc_get_enum_double(struct snd_kcontrol
*kcontrol
,
604 struct snd_ctl_elem_value
*ucontrol
);
605 int snd_soc_put_enum_double(struct snd_kcontrol
*kcontrol
,
606 struct snd_ctl_elem_value
*ucontrol
);
607 int snd_soc_info_volsw(struct snd_kcontrol
*kcontrol
,
608 struct snd_ctl_elem_info
*uinfo
);
609 int snd_soc_info_volsw_sx(struct snd_kcontrol
*kcontrol
,
610 struct snd_ctl_elem_info
*uinfo
);
611 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
612 int snd_soc_get_volsw(struct snd_kcontrol
*kcontrol
,
613 struct snd_ctl_elem_value
*ucontrol
);
614 int snd_soc_put_volsw(struct snd_kcontrol
*kcontrol
,
615 struct snd_ctl_elem_value
*ucontrol
);
616 #define snd_soc_get_volsw_2r snd_soc_get_volsw
617 #define snd_soc_put_volsw_2r snd_soc_put_volsw
618 int snd_soc_get_volsw_sx(struct snd_kcontrol
*kcontrol
,
619 struct snd_ctl_elem_value
*ucontrol
);
620 int snd_soc_put_volsw_sx(struct snd_kcontrol
*kcontrol
,
621 struct snd_ctl_elem_value
*ucontrol
);
622 int snd_soc_info_volsw_range(struct snd_kcontrol
*kcontrol
,
623 struct snd_ctl_elem_info
*uinfo
);
624 int snd_soc_put_volsw_range(struct snd_kcontrol
*kcontrol
,
625 struct snd_ctl_elem_value
*ucontrol
);
626 int snd_soc_get_volsw_range(struct snd_kcontrol
*kcontrol
,
627 struct snd_ctl_elem_value
*ucontrol
);
628 int snd_soc_limit_volume(struct snd_soc_card
*card
,
629 const char *name
, int max
);
630 int snd_soc_bytes_info(struct snd_kcontrol
*kcontrol
,
631 struct snd_ctl_elem_info
*uinfo
);
632 int snd_soc_bytes_get(struct snd_kcontrol
*kcontrol
,
633 struct snd_ctl_elem_value
*ucontrol
);
634 int snd_soc_bytes_put(struct snd_kcontrol
*kcontrol
,
635 struct snd_ctl_elem_value
*ucontrol
);
636 int snd_soc_bytes_info_ext(struct snd_kcontrol
*kcontrol
,
637 struct snd_ctl_elem_info
*ucontrol
);
638 int snd_soc_bytes_tlv_callback(struct snd_kcontrol
*kcontrol
, int op_flag
,
639 unsigned int size
, unsigned int __user
*tlv
);
640 int snd_soc_info_xr_sx(struct snd_kcontrol
*kcontrol
,
641 struct snd_ctl_elem_info
*uinfo
);
642 int snd_soc_get_xr_sx(struct snd_kcontrol
*kcontrol
,
643 struct snd_ctl_elem_value
*ucontrol
);
644 int snd_soc_put_xr_sx(struct snd_kcontrol
*kcontrol
,
645 struct snd_ctl_elem_value
*ucontrol
);
646 int snd_soc_get_strobe(struct snd_kcontrol
*kcontrol
,
647 struct snd_ctl_elem_value
*ucontrol
);
648 int snd_soc_put_strobe(struct snd_kcontrol
*kcontrol
,
649 struct snd_ctl_elem_value
*ucontrol
);
652 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
654 * @pin: name of the pin to update
655 * @mask: bits to check for in reported jack status
656 * @invert: if non-zero then pin is enabled when status is not reported
657 * @list: internal list entry
659 struct snd_soc_jack_pin
{
660 struct list_head list
;
667 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
669 * @min_mv: start voltage in mv
670 * @max_mv: end voltage in mv
671 * @jack_type: type of jack that is expected for this voltage
672 * @debounce_time: debounce_time for jack, codec driver should wait for this
673 * duration before reading the adc for voltages
674 * @list: internal list entry
676 struct snd_soc_jack_zone
{
679 unsigned int jack_type
;
680 unsigned int debounce_time
;
681 struct list_head list
;
685 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
687 * @gpio: legacy gpio number
688 * @idx: gpio descriptor index within the function of the GPIO
690 * @gpiod_dev: GPIO consumer device
691 * @name: gpio name. Also as connection ID for the GPIO consumer
692 * device function name lookup
693 * @report: value to report when jack detected
694 * @invert: report presence in low state
695 * @debounce_time: debounce time in ms
696 * @wake: enable as wake source
697 * @jack_status_check: callback function which overrides the detection
698 * to provide more complex checks (eg, reading an
701 struct snd_soc_jack_gpio
{
704 struct device
*gpiod_dev
;
712 struct snd_soc_jack
*jack
;
713 struct delayed_work work
;
714 struct gpio_desc
*desc
;
718 int (*jack_status_check
)(void *data
);
721 struct snd_soc_jack
{
723 struct snd_jack
*jack
;
724 struct snd_soc_card
*card
;
725 struct list_head pins
;
727 struct blocking_notifier_head notifier
;
728 struct list_head jack_zones
;
731 /* SoC PCM stream information */
732 struct snd_soc_pcm_stream
{
733 const char *stream_name
;
734 u64 formats
; /* SNDRV_PCM_FMTBIT_* */
735 unsigned int rates
; /* SNDRV_PCM_RATE_* */
736 unsigned int rate_min
; /* min rate */
737 unsigned int rate_max
; /* max rate */
738 unsigned int channels_min
; /* min channels */
739 unsigned int channels_max
; /* max channels */
740 unsigned int sig_bits
; /* number of bits of content */
745 int (*startup
)(struct snd_pcm_substream
*);
746 void (*shutdown
)(struct snd_pcm_substream
*);
747 int (*hw_params
)(struct snd_pcm_substream
*, struct snd_pcm_hw_params
*);
748 int (*hw_free
)(struct snd_pcm_substream
*);
749 int (*prepare
)(struct snd_pcm_substream
*);
750 int (*trigger
)(struct snd_pcm_substream
*, int);
753 struct snd_soc_compr_ops
{
754 int (*startup
)(struct snd_compr_stream
*);
755 void (*shutdown
)(struct snd_compr_stream
*);
756 int (*set_params
)(struct snd_compr_stream
*);
757 int (*trigger
)(struct snd_compr_stream
*);
760 /* component interface */
761 struct snd_soc_component_driver
{
764 /* Default control and setup, added after probe() is run */
765 const struct snd_kcontrol_new
*controls
;
766 unsigned int num_controls
;
767 const struct snd_soc_dapm_widget
*dapm_widgets
;
768 unsigned int num_dapm_widgets
;
769 const struct snd_soc_dapm_route
*dapm_routes
;
770 unsigned int num_dapm_routes
;
772 int (*probe
)(struct snd_soc_component
*);
773 void (*remove
)(struct snd_soc_component
*);
776 int (*of_xlate_dai_name
)(struct snd_soc_component
*component
,
777 struct of_phandle_args
*args
,
778 const char **dai_name
);
779 void (*seq_notifier
)(struct snd_soc_component
*, enum snd_soc_dapm_type
,
781 int (*stream_event
)(struct snd_soc_component
*, int event
);
783 /* probe ordering - for components with runtime dependencies */
788 struct snd_soc_component
{
791 const char *name_prefix
;
793 struct snd_soc_card
*card
;
797 unsigned int ignore_pmdown_time
:1; /* pmdown_time is ignored at stop */
798 unsigned int registered_as_component
:1;
800 struct list_head list
;
802 struct snd_soc_dai_driver
*dai_drv
;
805 const struct snd_soc_component_driver
*driver
;
807 struct list_head dai_list
;
809 int (*read
)(struct snd_soc_component
*, unsigned int, unsigned int *);
810 int (*write
)(struct snd_soc_component
*, unsigned int, unsigned int);
812 struct regmap
*regmap
;
815 struct mutex io_mutex
;
817 /* attached dynamic objects */
818 struct list_head dobj_list
;
820 #ifdef CONFIG_DEBUG_FS
821 struct dentry
*debugfs_root
;
825 * DO NOT use any of the fields below in drivers, they are temporary and
826 * are going to be removed again soon. If you use them in driver code the
827 * driver will be marked as BROKEN when these fields are removed.
830 /* Don't use these, use snd_soc_component_get_dapm() */
831 struct snd_soc_dapm_context dapm
;
833 const struct snd_kcontrol_new
*controls
;
834 unsigned int num_controls
;
835 const struct snd_soc_dapm_widget
*dapm_widgets
;
836 unsigned int num_dapm_widgets
;
837 const struct snd_soc_dapm_route
*dapm_routes
;
838 unsigned int num_dapm_routes
;
839 struct snd_soc_codec
*codec
;
841 int (*probe
)(struct snd_soc_component
*);
842 void (*remove
)(struct snd_soc_component
*);
844 #ifdef CONFIG_DEBUG_FS
845 void (*init_debugfs
)(struct snd_soc_component
*component
);
846 const char *debugfs_prefix
;
850 /* SoC Audio Codec device */
851 struct snd_soc_codec
{
853 const struct snd_soc_codec_driver
*driver
;
855 struct list_head list
;
856 struct list_head card_list
;
859 unsigned int cache_bypass
:1; /* Suppress access to the cache */
860 unsigned int suspended
:1; /* Codec is in suspend PM state */
861 unsigned int cache_init
:1; /* codec cache has been initialized */
864 void *control_data
; /* codec control (i2c/3wire) data */
869 struct snd_soc_component component
;
871 #ifdef CONFIG_DEBUG_FS
872 struct dentry
*debugfs_reg
;
877 struct snd_soc_codec_driver
{
880 int (*probe
)(struct snd_soc_codec
*);
881 int (*remove
)(struct snd_soc_codec
*);
882 int (*suspend
)(struct snd_soc_codec
*);
883 int (*resume
)(struct snd_soc_codec
*);
884 struct snd_soc_component_driver component_driver
;
886 /* Default control and setup, added after probe() is run */
887 const struct snd_kcontrol_new
*controls
;
889 const struct snd_soc_dapm_widget
*dapm_widgets
;
890 int num_dapm_widgets
;
891 const struct snd_soc_dapm_route
*dapm_routes
;
894 /* codec wide operations */
895 int (*set_sysclk
)(struct snd_soc_codec
*codec
,
896 int clk_id
, int source
, unsigned int freq
, int dir
);
897 int (*set_pll
)(struct snd_soc_codec
*codec
, int pll_id
, int source
,
898 unsigned int freq_in
, unsigned int freq_out
);
901 struct regmap
*(*get_regmap
)(struct device
*);
902 unsigned int (*read
)(struct snd_soc_codec
*, unsigned int);
903 int (*write
)(struct snd_soc_codec
*, unsigned int, unsigned int);
904 unsigned int reg_cache_size
;
905 short reg_cache_step
;
907 const void *reg_cache_default
;
909 /* codec bias level */
910 int (*set_bias_level
)(struct snd_soc_codec
*,
911 enum snd_soc_bias_level level
);
913 bool suspend_bias_off
;
915 void (*seq_notifier
)(struct snd_soc_dapm_context
*,
916 enum snd_soc_dapm_type
, int);
918 bool ignore_pmdown_time
; /* Doesn't benefit from pmdown delay */
921 /* SoC platform interface */
922 struct snd_soc_platform_driver
{
924 int (*probe
)(struct snd_soc_platform
*);
925 int (*remove
)(struct snd_soc_platform
*);
926 struct snd_soc_component_driver component_driver
;
928 /* pcm creation and destruction */
929 int (*pcm_new
)(struct snd_soc_pcm_runtime
*);
930 void (*pcm_free
)(struct snd_pcm
*);
933 * For platform caused delay reporting.
936 snd_pcm_sframes_t (*delay
)(struct snd_pcm_substream
*,
937 struct snd_soc_dai
*);
939 /* platform stream pcm ops */
940 const struct snd_pcm_ops
*ops
;
942 /* platform stream compress ops */
943 const struct snd_compr_ops
*compr_ops
;
945 int (*bespoke_trigger
)(struct snd_pcm_substream
*, int);
948 struct snd_soc_dai_link_component
{
950 struct device_node
*of_node
;
951 const char *dai_name
;
954 struct snd_soc_platform
{
956 const struct snd_soc_platform_driver
*driver
;
958 struct list_head list
;
960 struct snd_soc_component component
;
963 struct snd_soc_dai_link
{
964 /* config - must be set by machine driver */
965 const char *name
; /* Codec name */
966 const char *stream_name
; /* Stream name */
968 * You MAY specify the link's CPU-side device, either by device name,
969 * or by DT/OF node, but not both. If this information is omitted,
970 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
971 * must be globally unique. These fields are currently typically used
972 * only for codec to codec links, or systems using device tree.
974 const char *cpu_name
;
975 struct device_node
*cpu_of_node
;
977 * You MAY specify the DAI name of the CPU DAI. If this information is
978 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
979 * only, which only works well when that device exposes a single DAI.
981 const char *cpu_dai_name
;
983 * You MUST specify the link's codec, either by device name, or by
984 * DT/OF node, but not both.
986 const char *codec_name
;
987 struct device_node
*codec_of_node
;
988 /* You MUST specify the DAI name within the codec */
989 const char *codec_dai_name
;
991 struct snd_soc_dai_link_component
*codecs
;
992 unsigned int num_codecs
;
995 * You MAY specify the link's platform/PCM/DMA driver, either by
996 * device name, or by DT/OF node, but not both. Some forms of link
997 * do not need a platform.
999 const char *platform_name
;
1000 struct device_node
*platform_of_node
;
1001 int be_id
; /* optional ID for machine driver BE identification */
1003 const struct snd_soc_pcm_stream
*params
;
1004 unsigned int num_params
;
1006 unsigned int dai_fmt
; /* format to set on init */
1008 enum snd_soc_dpcm_trigger trigger
[2]; /* trigger type for DPCM */
1010 /* codec/machine specific init - e.g. add machine controls */
1011 int (*init
)(struct snd_soc_pcm_runtime
*rtd
);
1013 /* optional hw_params re-writing for BE and FE sync */
1014 int (*be_hw_params_fixup
)(struct snd_soc_pcm_runtime
*rtd
,
1015 struct snd_pcm_hw_params
*params
);
1017 /* machine stream operations */
1018 const struct snd_soc_ops
*ops
;
1019 const struct snd_soc_compr_ops
*compr_ops
;
1021 /* For unidirectional dai links */
1025 /* Mark this pcm with non atomic ops */
1028 /* Keep DAI active over suspend */
1029 unsigned int ignore_suspend
:1;
1031 /* Symmetry requirements */
1032 unsigned int symmetric_rates
:1;
1033 unsigned int symmetric_channels
:1;
1034 unsigned int symmetric_samplebits
:1;
1036 /* Do not create a PCM for this DAI link (Backend link) */
1037 unsigned int no_pcm
:1;
1039 /* This DAI link can route to other DAI links at runtime (Frontend)*/
1040 unsigned int dynamic
:1;
1042 /* DPCM capture and Playback support */
1043 unsigned int dpcm_capture
:1;
1044 unsigned int dpcm_playback
:1;
1046 /* DPCM used FE & BE merged format */
1047 unsigned int dpcm_merged_format
:1;
1049 /* pmdown_time is ignored at stop */
1050 unsigned int ignore_pmdown_time
:1;
1052 struct list_head list
; /* DAI link list of the soc card */
1053 struct snd_soc_dobj dobj
; /* For topology */
1056 struct snd_soc_codec_conf
{
1058 * specify device either by device name, or by
1059 * DT/OF node, but not both.
1061 const char *dev_name
;
1062 struct device_node
*of_node
;
1065 * optional map of kcontrol, widget and path name prefixes that are
1066 * associated per device
1068 const char *name_prefix
;
1071 struct snd_soc_aux_dev
{
1072 const char *name
; /* Codec name */
1075 * specify multi-codec either by device name, or by
1076 * DT/OF node, but not both.
1078 const char *codec_name
;
1079 struct device_node
*codec_of_node
;
1081 /* codec/machine specific init - e.g. add machine controls */
1082 int (*init
)(struct snd_soc_component
*component
);
1086 struct snd_soc_card
{
1088 const char *long_name
;
1089 const char *driver_name
;
1091 struct snd_card
*snd_card
;
1092 struct module
*owner
;
1095 struct mutex dapm_mutex
;
1099 int (*probe
)(struct snd_soc_card
*card
);
1100 int (*late_probe
)(struct snd_soc_card
*card
);
1101 int (*remove
)(struct snd_soc_card
*card
);
1103 /* the pre and post PM functions are used to do any PM work before and
1104 * after the codec and DAI's do any PM work. */
1105 int (*suspend_pre
)(struct snd_soc_card
*card
);
1106 int (*suspend_post
)(struct snd_soc_card
*card
);
1107 int (*resume_pre
)(struct snd_soc_card
*card
);
1108 int (*resume_post
)(struct snd_soc_card
*card
);
1111 int (*set_bias_level
)(struct snd_soc_card
*,
1112 struct snd_soc_dapm_context
*dapm
,
1113 enum snd_soc_bias_level level
);
1114 int (*set_bias_level_post
)(struct snd_soc_card
*,
1115 struct snd_soc_dapm_context
*dapm
,
1116 enum snd_soc_bias_level level
);
1118 int (*add_dai_link
)(struct snd_soc_card
*,
1119 struct snd_soc_dai_link
*link
);
1120 void (*remove_dai_link
)(struct snd_soc_card
*,
1121 struct snd_soc_dai_link
*link
);
1125 /* CPU <--> Codec DAI links */
1126 struct snd_soc_dai_link
*dai_link
; /* predefined links only */
1127 int num_links
; /* predefined links only */
1128 struct list_head dai_link_list
; /* all links */
1131 struct list_head rtd_list
;
1134 /* optional codec specific configuration */
1135 struct snd_soc_codec_conf
*codec_conf
;
1139 * optional auxiliary devices such as amplifiers or codecs with DAI
1142 struct snd_soc_aux_dev
*aux_dev
;
1144 struct snd_soc_pcm_runtime
*rtd_aux
;
1147 const struct snd_kcontrol_new
*controls
;
1151 * Card-specific routes and widgets.
1152 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1154 const struct snd_soc_dapm_widget
*dapm_widgets
;
1155 int num_dapm_widgets
;
1156 const struct snd_soc_dapm_route
*dapm_routes
;
1157 int num_dapm_routes
;
1158 const struct snd_soc_dapm_widget
*of_dapm_widgets
;
1159 int num_of_dapm_widgets
;
1160 const struct snd_soc_dapm_route
*of_dapm_routes
;
1161 int num_of_dapm_routes
;
1164 struct work_struct deferred_resume_work
;
1166 /* lists of probed devices belonging to this card */
1167 struct list_head codec_dev_list
;
1169 struct list_head widgets
;
1170 struct list_head paths
;
1171 struct list_head dapm_list
;
1172 struct list_head dapm_dirty
;
1174 /* attached dynamic objects */
1175 struct list_head dobj_list
;
1177 /* Generic DAPM context for the card */
1178 struct snd_soc_dapm_context dapm
;
1179 struct snd_soc_dapm_stats dapm_stats
;
1180 struct snd_soc_dapm_update
*update
;
1182 #ifdef CONFIG_DEBUG_FS
1183 struct dentry
*debugfs_card_root
;
1184 struct dentry
*debugfs_pop_time
;
1191 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1192 struct snd_soc_pcm_runtime
{
1194 struct snd_soc_card
*card
;
1195 struct snd_soc_dai_link
*dai_link
;
1196 struct mutex pcm_mutex
;
1197 enum snd_soc_pcm_subclass pcm_subclass
;
1198 struct snd_pcm_ops ops
;
1200 unsigned int dev_registered
:1;
1202 /* Dynamic PCM BE runtime data */
1203 struct snd_soc_dpcm_runtime dpcm
[2];
1207 unsigned char pop_wait
:1;
1209 /* runtime devices */
1210 struct snd_pcm
*pcm
;
1211 struct snd_compr
*compr
;
1212 struct snd_soc_codec
*codec
;
1213 struct snd_soc_platform
*platform
;
1214 struct snd_soc_dai
*codec_dai
;
1215 struct snd_soc_dai
*cpu_dai
;
1216 struct snd_soc_component
*component
; /* Only valid for AUX dev rtds */
1218 struct snd_soc_dai
**codec_dais
;
1219 unsigned int num_codecs
;
1221 struct delayed_work delayed_work
;
1222 #ifdef CONFIG_DEBUG_FS
1223 struct dentry
*debugfs_dpcm_root
;
1224 struct dentry
*debugfs_dpcm_state
;
1227 unsigned int num
; /* 0-based and monotonic increasing */
1228 struct list_head list
; /* rtd list of the soc card */
1232 struct soc_mixer_control
{
1233 int min
, max
, platform_max
;
1235 unsigned int shift
, rshift
;
1236 unsigned int sign_bit
;
1237 unsigned int invert
:1;
1238 unsigned int autodisable
:1;
1239 struct snd_soc_dobj dobj
;
1248 struct soc_bytes_ext
{
1250 struct snd_soc_dobj dobj
;
1252 /* used for TLV byte control */
1253 int (*get
)(struct snd_kcontrol
*kcontrol
, unsigned int __user
*bytes
,
1255 int (*put
)(struct snd_kcontrol
*kcontrol
, const unsigned int __user
*bytes
,
1259 /* multi register control */
1260 struct soc_mreg_control
{
1262 unsigned int regbase
, regcount
, nbits
, invert
;
1265 /* enumerated kcontrol */
1268 unsigned char shift_l
;
1269 unsigned char shift_r
;
1272 const char * const *texts
;
1273 const unsigned int *values
;
1274 unsigned int autodisable
:1;
1275 struct snd_soc_dobj dobj
;
1279 * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1280 * @component: The component to cast to a CODEC
1282 * This function must only be used on components that are known to be CODECs.
1283 * Otherwise the behavior is undefined.
1285 static inline struct snd_soc_codec
*snd_soc_component_to_codec(
1286 struct snd_soc_component
*component
)
1288 return container_of(component
, struct snd_soc_codec
, component
);
1292 * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1293 * @component: The component to cast to a platform
1295 * This function must only be used on components that are known to be platforms.
1296 * Otherwise the behavior is undefined.
1298 static inline struct snd_soc_platform
*snd_soc_component_to_platform(
1299 struct snd_soc_component
*component
)
1301 return container_of(component
, struct snd_soc_platform
, component
);
1305 * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
1307 * @dapm: The DAPM context to cast to the component
1309 * This function must only be used on DAPM contexts that are known to be part of
1310 * a component (e.g. in a component driver). Otherwise the behavior is
1313 static inline struct snd_soc_component
*snd_soc_dapm_to_component(
1314 struct snd_soc_dapm_context
*dapm
)
1316 return container_of(dapm
, struct snd_soc_component
, dapm
);
1320 * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in
1321 * @dapm: The DAPM context to cast to the CODEC
1323 * This function must only be used on DAPM contexts that are known to be part of
1324 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1326 static inline struct snd_soc_codec
*snd_soc_dapm_to_codec(
1327 struct snd_soc_dapm_context
*dapm
)
1329 return snd_soc_component_to_codec(snd_soc_dapm_to_component(dapm
));
1333 * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is
1335 * @dapm: The DAPM context to cast to the platform.
1337 * This function must only be used on DAPM contexts that are known to be part of
1338 * a platform (e.g. in a platform driver). Otherwise the behavior is undefined.
1340 static inline struct snd_soc_platform
*snd_soc_dapm_to_platform(
1341 struct snd_soc_dapm_context
*dapm
)
1343 return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm
));
1347 * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
1349 * @component: The component for which to get the DAPM context
1351 static inline struct snd_soc_dapm_context
*snd_soc_component_get_dapm(
1352 struct snd_soc_component
*component
)
1354 return &component
->dapm
;
1358 * snd_soc_codec_get_dapm() - Returns the DAPM context for the CODEC
1359 * @codec: The CODEC for which to get the DAPM context
1361 * Note: Use this function instead of directly accessing the CODEC's dapm field
1363 static inline struct snd_soc_dapm_context
*snd_soc_codec_get_dapm(
1364 struct snd_soc_codec
*codec
)
1366 return snd_soc_component_get_dapm(&codec
->component
);
1370 * snd_soc_dapm_init_bias_level() - Initialize CODEC DAPM bias level
1371 * @codec: The CODEC for which to initialize the DAPM bias level
1372 * @level: The DAPM level to initialize to
1374 * Initializes the CODEC DAPM bias level. See snd_soc_dapm_init_bias_level().
1376 static inline void snd_soc_codec_init_bias_level(struct snd_soc_codec
*codec
,
1377 enum snd_soc_bias_level level
)
1379 snd_soc_dapm_init_bias_level(snd_soc_codec_get_dapm(codec
), level
);
1383 * snd_soc_dapm_get_bias_level() - Get current CODEC DAPM bias level
1384 * @codec: The CODEC for which to get the DAPM bias level
1386 * Returns: The current DAPM bias level of the CODEC.
1388 static inline enum snd_soc_bias_level
snd_soc_codec_get_bias_level(
1389 struct snd_soc_codec
*codec
)
1391 return snd_soc_dapm_get_bias_level(snd_soc_codec_get_dapm(codec
));
1395 * snd_soc_codec_force_bias_level() - Set the CODEC DAPM bias level
1396 * @codec: The CODEC for which to set the level
1397 * @level: The level to set to
1399 * Forces the CODEC bias level to a specific state. See
1400 * snd_soc_dapm_force_bias_level().
1402 static inline int snd_soc_codec_force_bias_level(struct snd_soc_codec
*codec
,
1403 enum snd_soc_bias_level level
)
1405 return snd_soc_dapm_force_bias_level(snd_soc_codec_get_dapm(codec
),
1410 * snd_soc_dapm_kcontrol_codec() - Returns the codec associated to a kcontrol
1411 * @kcontrol: The kcontrol
1413 * This function must only be used on DAPM contexts that are known to be part of
1414 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1416 static inline struct snd_soc_codec
*snd_soc_dapm_kcontrol_codec(
1417 struct snd_kcontrol
*kcontrol
)
1419 return snd_soc_dapm_to_codec(snd_soc_dapm_kcontrol_dapm(kcontrol
));
1423 unsigned int snd_soc_read(struct snd_soc_codec
*codec
, unsigned int reg
);
1424 int snd_soc_write(struct snd_soc_codec
*codec
, unsigned int reg
,
1428 * snd_soc_cache_sync() - Sync the register cache with the hardware
1429 * @codec: CODEC to sync
1431 * Note: This function will call regcache_sync()
1433 static inline int snd_soc_cache_sync(struct snd_soc_codec
*codec
)
1435 return regcache_sync(codec
->component
.regmap
);
1439 int snd_soc_component_read(struct snd_soc_component
*component
,
1440 unsigned int reg
, unsigned int *val
);
1441 int snd_soc_component_write(struct snd_soc_component
*component
,
1442 unsigned int reg
, unsigned int val
);
1443 int snd_soc_component_update_bits(struct snd_soc_component
*component
,
1444 unsigned int reg
, unsigned int mask
, unsigned int val
);
1445 int snd_soc_component_update_bits_async(struct snd_soc_component
*component
,
1446 unsigned int reg
, unsigned int mask
, unsigned int val
);
1447 void snd_soc_component_async_complete(struct snd_soc_component
*component
);
1448 int snd_soc_component_test_bits(struct snd_soc_component
*component
,
1449 unsigned int reg
, unsigned int mask
, unsigned int value
);
1451 #ifdef CONFIG_REGMAP
1453 void snd_soc_component_init_regmap(struct snd_soc_component
*component
,
1454 struct regmap
*regmap
);
1455 void snd_soc_component_exit_regmap(struct snd_soc_component
*component
);
1458 * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC
1459 * @codec: The CODEC for which to initialize the regmap instance
1460 * @regmap: The regmap instance that should be used by the CODEC
1462 * This function allows deferred assignment of the regmap instance that is
1463 * associated with the CODEC. Only use this if the regmap instance is not yet
1464 * ready when the CODEC is registered. The function must also be called before
1465 * the first IO attempt of the CODEC.
1467 static inline void snd_soc_codec_init_regmap(struct snd_soc_codec
*codec
,
1468 struct regmap
*regmap
)
1470 snd_soc_component_init_regmap(&codec
->component
, regmap
);
1474 * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC
1475 * @codec: The CODEC for which to de-initialize the regmap instance
1477 * Calls regmap_exit() on the regmap instance associated to the CODEC and
1478 * removes the regmap instance from the CODEC.
1480 * This function should only be used if snd_soc_codec_init_regmap() was used to
1481 * initialize the regmap instance.
1483 static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec
*codec
)
1485 snd_soc_component_exit_regmap(&codec
->component
);
1490 /* device driver data */
1492 static inline void snd_soc_card_set_drvdata(struct snd_soc_card
*card
,
1495 card
->drvdata
= data
;
1498 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card
*card
)
1500 return card
->drvdata
;
1503 static inline void snd_soc_component_set_drvdata(struct snd_soc_component
*c
,
1506 dev_set_drvdata(c
->dev
, data
);
1509 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component
*c
)
1511 return dev_get_drvdata(c
->dev
);
1514 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec
*codec
,
1517 snd_soc_component_set_drvdata(&codec
->component
, data
);
1520 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec
*codec
)
1522 return snd_soc_component_get_drvdata(&codec
->component
);
1525 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform
*platform
,
1528 snd_soc_component_set_drvdata(&platform
->component
, data
);
1531 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform
*platform
)
1533 return snd_soc_component_get_drvdata(&platform
->component
);
1536 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime
*rtd
,
1539 dev_set_drvdata(rtd
->dev
, data
);
1542 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime
*rtd
)
1544 return dev_get_drvdata(rtd
->dev
);
1547 static inline void snd_soc_initialize_card_lists(struct snd_soc_card
*card
)
1549 INIT_LIST_HEAD(&card
->codec_dev_list
);
1550 INIT_LIST_HEAD(&card
->widgets
);
1551 INIT_LIST_HEAD(&card
->paths
);
1552 INIT_LIST_HEAD(&card
->dapm_list
);
1555 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control
*mc
)
1557 if (mc
->reg
== mc
->rreg
&& mc
->shift
== mc
->rshift
)
1560 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1561 * mc->reg != mc->rreg means that the control is
1562 * stereo (bits in one register or in two registers)
1567 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum
*e
,
1575 for (i
= 0; i
< e
->items
; i
++)
1576 if (val
== e
->values
[i
])
1582 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum
*e
,
1588 return e
->values
[item
];
1591 static inline bool snd_soc_component_is_active(
1592 struct snd_soc_component
*component
)
1594 return component
->active
!= 0;
1597 static inline bool snd_soc_codec_is_active(struct snd_soc_codec
*codec
)
1599 return snd_soc_component_is_active(&codec
->component
);
1603 * snd_soc_kcontrol_component() - Returns the component that registered the
1605 * @kcontrol: The control for which to get the component
1607 * Note: This function will work correctly if the control has been registered
1608 * for a component. Either with snd_soc_add_codec_controls() or
1609 * snd_soc_add_platform_controls() or via table based setup for either a
1610 * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1612 static inline struct snd_soc_component
*snd_soc_kcontrol_component(
1613 struct snd_kcontrol
*kcontrol
)
1615 return snd_kcontrol_chip(kcontrol
);
1619 * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1620 * @kcontrol: The control for which to get the CODEC
1622 * Note: This function will only work correctly if the control has been
1623 * registered with snd_soc_add_codec_controls() or via table based setup of
1624 * snd_soc_codec_driver. Otherwise the behavior is undefined.
1626 static inline struct snd_soc_codec
*snd_soc_kcontrol_codec(
1627 struct snd_kcontrol
*kcontrol
)
1629 return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol
));
1633 * snd_soc_kcontrol_platform() - Returns the platform that registered the control
1634 * @kcontrol: The control for which to get the platform
1636 * Note: This function will only work correctly if the control has been
1637 * registered with snd_soc_add_platform_controls() or via table based setup of
1638 * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1640 static inline struct snd_soc_platform
*snd_soc_kcontrol_platform(
1641 struct snd_kcontrol
*kcontrol
)
1643 return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol
));
1646 int snd_soc_util_init(void);
1647 void snd_soc_util_exit(void);
1649 int snd_soc_of_parse_card_name(struct snd_soc_card
*card
,
1650 const char *propname
);
1651 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card
*card
,
1652 const char *propname
);
1653 int snd_soc_of_parse_tdm_slot(struct device_node
*np
,
1654 unsigned int *tx_mask
,
1655 unsigned int *rx_mask
,
1656 unsigned int *slots
,
1657 unsigned int *slot_width
);
1658 void snd_soc_of_parse_audio_prefix(struct snd_soc_card
*card
,
1659 struct snd_soc_codec_conf
*codec_conf
,
1660 struct device_node
*of_node
,
1661 const char *propname
);
1662 int snd_soc_of_parse_audio_routing(struct snd_soc_card
*card
,
1663 const char *propname
);
1664 unsigned int snd_soc_of_parse_daifmt(struct device_node
*np
,
1666 struct device_node
**bitclkmaster
,
1667 struct device_node
**framemaster
);
1668 int snd_soc_of_get_dai_name(struct device_node
*of_node
,
1669 const char **dai_name
);
1670 int snd_soc_of_get_dai_link_codecs(struct device
*dev
,
1671 struct device_node
*of_node
,
1672 struct snd_soc_dai_link
*dai_link
);
1674 int snd_soc_add_dai_link(struct snd_soc_card
*card
,
1675 struct snd_soc_dai_link
*dai_link
);
1676 void snd_soc_remove_dai_link(struct snd_soc_card
*card
,
1677 struct snd_soc_dai_link
*dai_link
);
1679 #include <sound/soc-dai.h>
1681 #ifdef CONFIG_DEBUG_FS
1682 extern struct dentry
*snd_soc_debugfs_root
;
1685 extern const struct dev_pm_ops snd_soc_pm_ops
;
1687 /* Helper functions */
1688 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context
*dapm
)
1690 mutex_lock_nested(&dapm
->card
->dapm_mutex
, SND_SOC_DAPM_CLASS_RUNTIME
);
1693 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context
*dapm
)
1695 mutex_unlock(&dapm
->card
->dapm_mutex
);