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, \
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_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
114 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
115 .info = snd_soc_info_volsw, \
116 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
117 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
119 #define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
121 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
122 .info = snd_soc_info_volsw_range, \
123 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
124 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
125 xshift, xmin, xmax, xinvert) }
126 #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
127 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
128 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
129 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
130 .tlv.p = (tlv_array), \
131 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
132 .put = snd_soc_put_volsw, \
133 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
135 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
136 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
137 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
138 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
139 .tlv.p = (tlv_array), \
140 .info = snd_soc_info_volsw, \
141 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
142 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
144 #define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
145 xmax, xinvert, tlv_array) \
146 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
147 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
148 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
149 .tlv.p = (tlv_array), \
150 .info = snd_soc_info_volsw_range, \
151 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
152 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
153 xshift, xmin, xmax, xinvert) }
154 #define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
155 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
156 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
157 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
158 .tlv.p = (tlv_array), \
159 .info = snd_soc_info_volsw, \
160 .get = snd_soc_get_volsw_sx, \
161 .put = snd_soc_put_volsw_sx, \
162 .private_value = (unsigned long)&(struct soc_mixer_control) \
163 {.reg = xreg, .rreg = xrreg, \
164 .shift = xshift, .rshift = xshift, \
165 .max = xmax, .min = xmin} }
166 #define SOC_DOUBLE_R_S_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
167 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
168 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
169 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
170 .tlv.p = (tlv_array), \
171 .info = snd_soc_info_volsw, \
172 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
173 .private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
174 xmin, xmax, xsign_bit, xinvert) }
175 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
176 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
177 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
178 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
179 .tlv.p = (tlv_array), \
180 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
181 .put = snd_soc_put_volsw, \
182 .private_value = SOC_DOUBLE_S_VALUE(xreg, 0, 8, xmin, xmax, 7, 0, 0) }
183 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \
184 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
185 .items = xitems, .texts = xtexts, \
186 .mask = xitems ? roundup_pow_of_two(xitems) - 1 : 0}
187 #define SOC_ENUM_SINGLE(xreg, xshift, xitems, xtexts) \
188 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xitems, xtexts)
189 #define SOC_ENUM_SINGLE_EXT(xitems, xtexts) \
190 { .items = xitems, .texts = xtexts }
191 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xitems, xtexts, xvalues) \
192 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
193 .mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues}
194 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
195 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xitems, xtexts, xvalues)
196 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
197 { .reg = xreg, .shift_l = xshift, .shift_r = xshift, \
198 .mask = xmask, .items = xitems, .texts = xtexts, \
199 .values = xvalues, .autodisable = 1}
200 #define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \
201 SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
202 #define SOC_ENUM(xname, xenum) \
203 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
204 .info = snd_soc_info_enum_double, \
205 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
206 .private_value = (unsigned long)&xenum }
207 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
208 xhandler_get, xhandler_put) \
209 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
210 .info = snd_soc_info_volsw, \
211 .get = xhandler_get, .put = xhandler_put, \
212 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
213 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
214 xhandler_get, xhandler_put) \
215 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
216 .info = snd_soc_info_volsw, \
217 .get = xhandler_get, .put = xhandler_put, \
219 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
220 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
221 xhandler_get, xhandler_put, tlv_array) \
222 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
223 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
224 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
225 .tlv.p = (tlv_array), \
226 .info = snd_soc_info_volsw, \
227 .get = xhandler_get, .put = xhandler_put, \
228 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
229 #define SOC_SINGLE_RANGE_EXT_TLV(xname, xreg, xshift, xmin, xmax, xinvert, \
230 xhandler_get, xhandler_put, tlv_array) \
231 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
232 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
233 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
234 .tlv.p = (tlv_array), \
235 .info = snd_soc_info_volsw_range, \
236 .get = xhandler_get, .put = xhandler_put, \
237 .private_value = (unsigned long)&(struct soc_mixer_control) \
238 {.reg = xreg, .rreg = xreg, .shift = xshift, \
239 .rshift = xshift, .min = xmin, .max = xmax, \
240 .platform_max = xmax, .invert = xinvert} }
241 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
242 xhandler_get, xhandler_put, tlv_array) \
243 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
244 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
245 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
246 .tlv.p = (tlv_array), \
247 .info = snd_soc_info_volsw, \
248 .get = xhandler_get, .put = xhandler_put, \
249 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
251 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
252 xhandler_get, xhandler_put, tlv_array) \
253 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
254 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
255 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
256 .tlv.p = (tlv_array), \
257 .info = snd_soc_info_volsw, \
258 .get = xhandler_get, .put = xhandler_put, \
259 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
261 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
262 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
263 .info = snd_soc_info_bool_ext, \
264 .get = xhandler_get, .put = xhandler_put, \
265 .private_value = xdata }
266 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
267 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
268 .info = snd_soc_info_enum_double, \
269 .get = xhandler_get, .put = xhandler_put, \
270 .private_value = (unsigned long)&xenum }
271 #define SOC_VALUE_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
272 SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put)
274 #define SND_SOC_BYTES(xname, xbase, xregs) \
275 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
276 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
277 .put = snd_soc_bytes_put, .private_value = \
278 ((unsigned long)&(struct soc_bytes) \
279 {.base = xbase, .num_regs = xregs }) }
281 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask) \
282 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
283 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
284 .put = snd_soc_bytes_put, .private_value = \
285 ((unsigned long)&(struct soc_bytes) \
286 {.base = xbase, .num_regs = xregs, \
289 #define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \
290 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
291 .info = snd_soc_bytes_info_ext, \
292 .get = xhandler_get, .put = xhandler_put, \
293 .private_value = (unsigned long)&(struct soc_bytes_ext) \
295 #define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \
296 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
297 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \
298 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
299 .tlv.c = (snd_soc_bytes_tlv_callback), \
300 .info = snd_soc_bytes_info_ext, \
301 .private_value = (unsigned long)&(struct soc_bytes_ext) \
302 {.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
303 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
304 xmin, xmax, xinvert) \
305 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
306 .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
307 .put = snd_soc_put_xr_sx, \
308 .private_value = (unsigned long)&(struct soc_mreg_control) \
309 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
310 .invert = xinvert, .min = xmin, .max = xmax} }
312 #define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
313 SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
314 snd_soc_get_strobe, snd_soc_put_strobe)
317 * Simplified versions of above macros, declaring a struct and calculating
318 * ARRAY_SIZE internally
320 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
321 const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
322 ARRAY_SIZE(xtexts), xtexts)
323 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
324 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
325 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
326 const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
327 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
328 const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
329 ARRAY_SIZE(xtexts), xtexts, xvalues)
330 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
331 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
333 #define SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
334 const struct soc_enum name = SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, \
335 xshift, xmask, ARRAY_SIZE(xtexts), xtexts, xvalues)
337 #define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
338 const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
341 * Component probe and remove ordering levels for components with runtime
344 #define SND_SOC_COMP_ORDER_FIRST -2
345 #define SND_SOC_COMP_ORDER_EARLY -1
346 #define SND_SOC_COMP_ORDER_NORMAL 0
347 #define SND_SOC_COMP_ORDER_LATE 1
348 #define SND_SOC_COMP_ORDER_LAST 2
353 * @ON: Bias is fully on for audio playback and capture operations.
354 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
355 * stream start and stop operations.
356 * @STANDBY: Low power standby state when no playback/capture operations are
357 * in progress. NOTE: The transition time between STANDBY and ON
358 * should be as fast as possible and no longer than 10ms.
359 * @OFF: Power Off. No restrictions on transition times.
361 enum snd_soc_bias_level {
362 SND_SOC_BIAS_OFF = 0,
363 SND_SOC_BIAS_STANDBY = 1,
364 SND_SOC_BIAS_PREPARE = 2,
371 struct snd_soc_pcm_stream;
373 struct snd_soc_pcm_runtime;
375 struct snd_soc_dai_driver;
376 struct snd_soc_platform;
377 struct snd_soc_dai_link;
378 struct snd_soc_platform_driver;
379 struct snd_soc_codec;
380 struct snd_soc_codec_driver;
381 struct snd_soc_component;
382 struct snd_soc_component_driver;
385 struct snd_soc_jack_zone;
386 struct snd_soc_jack_pin;
387 #include <sound/soc-dapm.h>
388 #include <sound/soc-dpcm.h>
390 struct snd_soc_jack_gpio;
392 typedef int (*hw_write_t)(void *,const char* ,int);
394 enum snd_soc_pcm_subclass {
395 SND_SOC_PCM_CLASS_PCM = 0,
396 SND_SOC_PCM_CLASS_BE = 1,
399 enum snd_soc_card_subclass {
400 SND_SOC_CARD_CLASS_INIT = 0,
401 SND_SOC_CARD_CLASS_RUNTIME = 1,
404 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
405 int source, unsigned int freq, int dir);
406 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
407 unsigned int freq_in, unsigned int freq_out);
409 int snd_soc_register_card(struct snd_soc_card *card);
410 int snd_soc_unregister_card(struct snd_soc_card *card);
411 int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
412 #ifdef CONFIG_PM_SLEEP
413 int snd_soc_suspend(struct device *dev);
414 int snd_soc_resume(struct device *dev);
416 static inline int snd_soc_suspend(struct device *dev)
421 static inline int snd_soc_resume(struct device *dev)
426 int snd_soc_poweroff(struct device *dev);
427 int snd_soc_register_platform(struct device *dev,
428 const struct snd_soc_platform_driver *platform_drv);
429 int devm_snd_soc_register_platform(struct device *dev,
430 const struct snd_soc_platform_driver *platform_drv);
431 void snd_soc_unregister_platform(struct device *dev);
432 int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
433 const struct snd_soc_platform_driver *platform_drv);
434 void snd_soc_remove_platform(struct snd_soc_platform *platform);
435 struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev);
436 int snd_soc_register_codec(struct device *dev,
437 const struct snd_soc_codec_driver *codec_drv,
438 struct snd_soc_dai_driver *dai_drv, int num_dai);
439 void snd_soc_unregister_codec(struct device *dev);
440 int snd_soc_register_component(struct device *dev,
441 const struct snd_soc_component_driver *cmpnt_drv,
442 struct snd_soc_dai_driver *dai_drv, int num_dai);
443 int devm_snd_soc_register_component(struct device *dev,
444 const struct snd_soc_component_driver *cmpnt_drv,
445 struct snd_soc_dai_driver *dai_drv, int num_dai);
446 void snd_soc_unregister_component(struct device *dev);
447 int snd_soc_cache_init(struct snd_soc_codec *codec);
448 int snd_soc_cache_exit(struct snd_soc_codec *codec);
450 int snd_soc_platform_read(struct snd_soc_platform *platform,
452 int snd_soc_platform_write(struct snd_soc_platform *platform,
453 unsigned int reg, unsigned int val);
454 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
455 int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
457 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
458 const char *dai_link, int stream);
459 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
460 const char *dai_link);
462 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
463 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
464 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
466 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
467 unsigned int dai_fmt);
469 /* Utility functions to get clock rates from various things */
470 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
471 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
472 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
473 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
475 /* set runtime hw params */
476 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
477 const struct snd_pcm_hardware *hw);
479 int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
480 int cmd, struct snd_soc_platform *platform);
482 int soc_dai_hw_params(struct snd_pcm_substream *substream,
483 struct snd_pcm_hw_params *params,
484 struct snd_soc_dai *dai);
487 int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type,
488 struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins,
489 unsigned int num_pins);
491 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
492 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
493 struct snd_soc_jack_pin *pins);
494 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
495 struct notifier_block *nb);
496 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
497 struct notifier_block *nb);
498 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
499 struct snd_soc_jack_zone *zones);
500 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
501 #ifdef CONFIG_GPIOLIB
502 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
503 struct snd_soc_jack_gpio *gpios);
504 int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
505 struct snd_soc_jack *jack,
506 int count, struct snd_soc_jack_gpio *gpios);
507 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
508 struct snd_soc_jack_gpio *gpios);
510 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
511 struct snd_soc_jack_gpio *gpios)
516 static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
517 struct snd_soc_jack *jack,
519 struct snd_soc_jack_gpio *gpios)
524 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
525 struct snd_soc_jack_gpio *gpios)
530 /* codec register bit access */
531 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned int reg,
532 unsigned int mask, unsigned int value);
533 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
534 unsigned int reg, unsigned int mask,
536 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned int reg,
537 unsigned int mask, unsigned int value);
539 #ifdef CONFIG_SND_SOC_AC97_BUS
540 struct snd_ac97 *snd_soc_alloc_ac97_codec(struct snd_soc_codec *codec);
541 struct snd_ac97 *snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
542 unsigned int id, unsigned int id_mask);
543 void snd_soc_free_ac97_codec(struct snd_ac97 *ac97);
545 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
546 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
547 struct platform_device *pdev);
549 extern struct snd_ac97_bus_ops *soc_ac97_ops;
551 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
552 struct platform_device *pdev)
557 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
566 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
567 void *data, const char *long_name,
569 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
571 int snd_soc_add_component_controls(struct snd_soc_component *component,
572 const struct snd_kcontrol_new *controls, unsigned int num_controls);
573 int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
574 const struct snd_kcontrol_new *controls, unsigned int num_controls);
575 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
576 const struct snd_kcontrol_new *controls, unsigned int num_controls);
577 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
578 const struct snd_kcontrol_new *controls, int num_controls);
579 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
580 const struct snd_kcontrol_new *controls, int num_controls);
581 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
582 struct snd_ctl_elem_info *uinfo);
583 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
584 struct snd_ctl_elem_value *ucontrol);
585 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
586 struct snd_ctl_elem_value *ucontrol);
587 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
588 struct snd_ctl_elem_info *uinfo);
589 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
590 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
591 struct snd_ctl_elem_value *ucontrol);
592 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
593 struct snd_ctl_elem_value *ucontrol);
594 #define snd_soc_get_volsw_2r snd_soc_get_volsw
595 #define snd_soc_put_volsw_2r snd_soc_put_volsw
596 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
597 struct snd_ctl_elem_value *ucontrol);
598 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
599 struct snd_ctl_elem_value *ucontrol);
600 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
601 struct snd_ctl_elem_info *uinfo);
602 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
603 struct snd_ctl_elem_value *ucontrol);
604 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
605 struct snd_ctl_elem_value *ucontrol);
606 int snd_soc_limit_volume(struct snd_soc_codec *codec,
607 const char *name, int max);
608 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
609 struct snd_ctl_elem_info *uinfo);
610 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
611 struct snd_ctl_elem_value *ucontrol);
612 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
613 struct snd_ctl_elem_value *ucontrol);
614 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
615 struct snd_ctl_elem_info *ucontrol);
616 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
617 unsigned int size, unsigned int __user *tlv);
618 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
619 struct snd_ctl_elem_info *uinfo);
620 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
621 struct snd_ctl_elem_value *ucontrol);
622 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
623 struct snd_ctl_elem_value *ucontrol);
624 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
625 struct snd_ctl_elem_value *ucontrol);
626 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
627 struct snd_ctl_elem_value *ucontrol);
630 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
632 * @pin: name of the pin to update
633 * @mask: bits to check for in reported jack status
634 * @invert: if non-zero then pin is enabled when status is not reported
635 * @list: internal list entry
637 struct snd_soc_jack_pin {
638 struct list_head list;
645 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
647 * @min_mv: start voltage in mv
648 * @max_mv: end voltage in mv
649 * @jack_type: type of jack that is expected for this voltage
650 * @debounce_time: debounce_time for jack, codec driver should wait for this
651 * duration before reading the adc for voltages
652 * @list: internal list entry
654 struct snd_soc_jack_zone {
657 unsigned int jack_type;
658 unsigned int debounce_time;
659 struct list_head list;
663 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
665 * @gpio: legacy gpio number
666 * @idx: gpio descriptor index within the function of the GPIO
668 * @gpiod_dev: GPIO consumer device
669 * @name: gpio name. Also as connection ID for the GPIO consumer
670 * device function name lookup
671 * @report: value to report when jack detected
672 * @invert: report presence in low state
673 * @debounce_time: debounce time in ms
674 * @wake: enable as wake source
675 * @jack_status_check: callback function which overrides the detection
676 * to provide more complex checks (eg, reading an
679 struct snd_soc_jack_gpio {
682 struct device *gpiod_dev;
690 struct snd_soc_jack *jack;
691 struct delayed_work work;
692 struct gpio_desc *desc;
696 int (*jack_status_check)(void *data);
699 struct snd_soc_jack {
701 struct snd_jack *jack;
702 struct snd_soc_card *card;
703 struct list_head pins;
705 struct blocking_notifier_head notifier;
706 struct list_head jack_zones;
709 /* SoC PCM stream information */
710 struct snd_soc_pcm_stream {
711 const char *stream_name;
712 u64 formats; /* SNDRV_PCM_FMTBIT_* */
713 unsigned int rates; /* SNDRV_PCM_RATE_* */
714 unsigned int rate_min; /* min rate */
715 unsigned int rate_max; /* max rate */
716 unsigned int channels_min; /* min channels */
717 unsigned int channels_max; /* max channels */
718 unsigned int sig_bits; /* number of bits of content */
723 int (*startup)(struct snd_pcm_substream *);
724 void (*shutdown)(struct snd_pcm_substream *);
725 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
726 int (*hw_free)(struct snd_pcm_substream *);
727 int (*prepare)(struct snd_pcm_substream *);
728 int (*trigger)(struct snd_pcm_substream *, int);
731 struct snd_soc_compr_ops {
732 int (*startup)(struct snd_compr_stream *);
733 void (*shutdown)(struct snd_compr_stream *);
734 int (*set_params)(struct snd_compr_stream *);
735 int (*trigger)(struct snd_compr_stream *);
738 /* component interface */
739 struct snd_soc_component_driver {
742 /* Default control and setup, added after probe() is run */
743 const struct snd_kcontrol_new *controls;
744 unsigned int num_controls;
745 const struct snd_soc_dapm_widget *dapm_widgets;
746 unsigned int num_dapm_widgets;
747 const struct snd_soc_dapm_route *dapm_routes;
748 unsigned int num_dapm_routes;
750 int (*probe)(struct snd_soc_component *);
751 void (*remove)(struct snd_soc_component *);
754 int (*of_xlate_dai_name)(struct snd_soc_component *component,
755 struct of_phandle_args *args,
756 const char **dai_name);
757 void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type,
759 int (*stream_event)(struct snd_soc_component *, int event);
761 /* probe ordering - for components with runtime dependencies */
766 struct snd_soc_component {
769 const char *name_prefix;
771 struct snd_soc_card *card;
775 unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
776 unsigned int registered_as_component:1;
778 struct list_head list;
780 struct snd_soc_dai_driver *dai_drv;
783 const struct snd_soc_component_driver *driver;
785 struct list_head dai_list;
787 int (*read)(struct snd_soc_component *, unsigned int, unsigned int *);
788 int (*write)(struct snd_soc_component *, unsigned int, unsigned int);
790 struct regmap *regmap;
793 struct mutex io_mutex;
795 /* attached dynamic objects */
796 struct list_head dobj_list;
798 #ifdef CONFIG_DEBUG_FS
799 struct dentry *debugfs_root;
803 * DO NOT use any of the fields below in drivers, they are temporary and
804 * are going to be removed again soon. If you use them in driver code the
805 * driver will be marked as BROKEN when these fields are removed.
808 /* Don't use these, use snd_soc_component_get_dapm() */
809 struct snd_soc_dapm_context dapm;
811 const struct snd_kcontrol_new *controls;
812 unsigned int num_controls;
813 const struct snd_soc_dapm_widget *dapm_widgets;
814 unsigned int num_dapm_widgets;
815 const struct snd_soc_dapm_route *dapm_routes;
816 unsigned int num_dapm_routes;
817 struct snd_soc_codec *codec;
819 int (*probe)(struct snd_soc_component *);
820 void (*remove)(struct snd_soc_component *);
822 #ifdef CONFIG_DEBUG_FS
823 void (*init_debugfs)(struct snd_soc_component *component);
824 const char *debugfs_prefix;
828 /* SoC Audio Codec device */
829 struct snd_soc_codec {
831 const struct snd_soc_codec_driver *driver;
833 struct list_head list;
834 struct list_head card_list;
837 unsigned int cache_bypass:1; /* Suppress access to the cache */
838 unsigned int suspended:1; /* Codec is in suspend PM state */
839 unsigned int cache_init:1; /* codec cache has been initialized */
842 void *control_data; /* codec control (i2c/3wire) data */
847 struct snd_soc_component component;
849 #ifdef CONFIG_DEBUG_FS
850 struct dentry *debugfs_reg;
855 struct snd_soc_codec_driver {
858 int (*probe)(struct snd_soc_codec *);
859 int (*remove)(struct snd_soc_codec *);
860 int (*suspend)(struct snd_soc_codec *);
861 int (*resume)(struct snd_soc_codec *);
862 struct snd_soc_component_driver component_driver;
864 /* Default control and setup, added after probe() is run */
865 const struct snd_kcontrol_new *controls;
867 const struct snd_soc_dapm_widget *dapm_widgets;
868 int num_dapm_widgets;
869 const struct snd_soc_dapm_route *dapm_routes;
872 /* codec wide operations */
873 int (*set_sysclk)(struct snd_soc_codec *codec,
874 int clk_id, int source, unsigned int freq, int dir);
875 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
876 unsigned int freq_in, unsigned int freq_out);
879 struct regmap *(*get_regmap)(struct device *);
880 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
881 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
882 unsigned int reg_cache_size;
883 short reg_cache_step;
885 const void *reg_cache_default;
887 /* codec bias level */
888 int (*set_bias_level)(struct snd_soc_codec *,
889 enum snd_soc_bias_level level);
891 bool suspend_bias_off;
893 void (*seq_notifier)(struct snd_soc_dapm_context *,
894 enum snd_soc_dapm_type, int);
896 bool ignore_pmdown_time; /* Doesn't benefit from pmdown delay */
899 /* SoC platform interface */
900 struct snd_soc_platform_driver {
902 int (*probe)(struct snd_soc_platform *);
903 int (*remove)(struct snd_soc_platform *);
904 struct snd_soc_component_driver component_driver;
906 /* pcm creation and destruction */
907 int (*pcm_new)(struct snd_soc_pcm_runtime *);
908 void (*pcm_free)(struct snd_pcm *);
911 * For platform caused delay reporting.
914 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
915 struct snd_soc_dai *);
917 /* platform stream pcm ops */
918 const struct snd_pcm_ops *ops;
920 /* platform stream compress ops */
921 const struct snd_compr_ops *compr_ops;
923 int (*bespoke_trigger)(struct snd_pcm_substream *, int);
926 struct snd_soc_dai_link_component {
928 struct device_node *of_node;
929 const char *dai_name;
932 struct snd_soc_platform {
934 const struct snd_soc_platform_driver *driver;
936 struct list_head list;
938 struct snd_soc_component component;
941 struct snd_soc_dai_link {
942 /* config - must be set by machine driver */
943 const char *name; /* Codec name */
944 const char *stream_name; /* Stream name */
946 * You MAY specify the link's CPU-side device, either by device name,
947 * or by DT/OF node, but not both. If this information is omitted,
948 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
949 * must be globally unique. These fields are currently typically used
950 * only for codec to codec links, or systems using device tree.
952 const char *cpu_name;
953 struct device_node *cpu_of_node;
955 * You MAY specify the DAI name of the CPU DAI. If this information is
956 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
957 * only, which only works well when that device exposes a single DAI.
959 const char *cpu_dai_name;
961 * You MUST specify the link's codec, either by device name, or by
962 * DT/OF node, but not both.
964 const char *codec_name;
965 struct device_node *codec_of_node;
966 /* You MUST specify the DAI name within the codec */
967 const char *codec_dai_name;
969 struct snd_soc_dai_link_component *codecs;
970 unsigned int num_codecs;
973 * You MAY specify the link's platform/PCM/DMA driver, either by
974 * device name, or by DT/OF node, but not both. Some forms of link
975 * do not need a platform.
977 const char *platform_name;
978 struct device_node *platform_of_node;
979 int be_id; /* optional ID for machine driver BE identification */
981 const struct snd_soc_pcm_stream *params;
982 unsigned int num_params;
984 unsigned int dai_fmt; /* format to set on init */
986 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
988 /* codec/machine specific init - e.g. add machine controls */
989 int (*init)(struct snd_soc_pcm_runtime *rtd);
991 /* optional hw_params re-writing for BE and FE sync */
992 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
993 struct snd_pcm_hw_params *params);
995 /* machine stream operations */
996 const struct snd_soc_ops *ops;
997 const struct snd_soc_compr_ops *compr_ops;
999 /* For unidirectional dai links */
1003 /* Mark this pcm with non atomic ops */
1006 /* Keep DAI active over suspend */
1007 unsigned int ignore_suspend:1;
1009 /* Symmetry requirements */
1010 unsigned int symmetric_rates:1;
1011 unsigned int symmetric_channels:1;
1012 unsigned int symmetric_samplebits:1;
1014 /* Do not create a PCM for this DAI link (Backend link) */
1015 unsigned int no_pcm:1;
1017 /* This DAI link can route to other DAI links at runtime (Frontend)*/
1018 unsigned int dynamic:1;
1020 /* DPCM capture and Playback support */
1021 unsigned int dpcm_capture:1;
1022 unsigned int dpcm_playback:1;
1024 /* DPCM used FE & BE merged format */
1025 unsigned int dpcm_merged_format:1;
1027 /* pmdown_time is ignored at stop */
1028 unsigned int ignore_pmdown_time:1;
1031 struct snd_soc_codec_conf {
1033 * specify device either by device name, or by
1034 * DT/OF node, but not both.
1036 const char *dev_name;
1037 struct device_node *of_node;
1040 * optional map of kcontrol, widget and path name prefixes that are
1041 * associated per device
1043 const char *name_prefix;
1046 struct snd_soc_aux_dev {
1047 const char *name; /* Codec name */
1050 * specify multi-codec either by device name, or by
1051 * DT/OF node, but not both.
1053 const char *codec_name;
1054 struct device_node *codec_of_node;
1056 /* codec/machine specific init - e.g. add machine controls */
1057 int (*init)(struct snd_soc_component *component);
1061 struct snd_soc_card {
1063 const char *long_name;
1064 const char *driver_name;
1066 struct snd_card *snd_card;
1067 struct module *owner;
1070 struct mutex dapm_mutex;
1074 int (*probe)(struct snd_soc_card *card);
1075 int (*late_probe)(struct snd_soc_card *card);
1076 int (*remove)(struct snd_soc_card *card);
1078 /* the pre and post PM functions are used to do any PM work before and
1079 * after the codec and DAI's do any PM work. */
1080 int (*suspend_pre)(struct snd_soc_card *card);
1081 int (*suspend_post)(struct snd_soc_card *card);
1082 int (*resume_pre)(struct snd_soc_card *card);
1083 int (*resume_post)(struct snd_soc_card *card);
1086 int (*set_bias_level)(struct snd_soc_card *,
1087 struct snd_soc_dapm_context *dapm,
1088 enum snd_soc_bias_level level);
1089 int (*set_bias_level_post)(struct snd_soc_card *,
1090 struct snd_soc_dapm_context *dapm,
1091 enum snd_soc_bias_level level);
1095 /* CPU <--> Codec DAI links */
1096 struct snd_soc_dai_link *dai_link;
1098 struct snd_soc_pcm_runtime *rtd;
1101 /* optional codec specific configuration */
1102 struct snd_soc_codec_conf *codec_conf;
1106 * optional auxiliary devices such as amplifiers or codecs with DAI
1109 struct snd_soc_aux_dev *aux_dev;
1111 struct snd_soc_pcm_runtime *rtd_aux;
1114 const struct snd_kcontrol_new *controls;
1118 * Card-specific routes and widgets.
1119 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1121 const struct snd_soc_dapm_widget *dapm_widgets;
1122 int num_dapm_widgets;
1123 const struct snd_soc_dapm_route *dapm_routes;
1124 int num_dapm_routes;
1125 const struct snd_soc_dapm_widget *of_dapm_widgets;
1126 int num_of_dapm_widgets;
1127 const struct snd_soc_dapm_route *of_dapm_routes;
1128 int num_of_dapm_routes;
1131 struct work_struct deferred_resume_work;
1133 /* lists of probed devices belonging to this card */
1134 struct list_head codec_dev_list;
1136 struct list_head widgets;
1137 struct list_head paths;
1138 struct list_head dapm_list;
1139 struct list_head dapm_dirty;
1141 /* attached dynamic objects */
1142 struct list_head dobj_list;
1144 /* Generic DAPM context for the card */
1145 struct snd_soc_dapm_context dapm;
1146 struct snd_soc_dapm_stats dapm_stats;
1147 struct snd_soc_dapm_update *update;
1149 #ifdef CONFIG_DEBUG_FS
1150 struct dentry *debugfs_card_root;
1151 struct dentry *debugfs_pop_time;
1158 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1159 struct snd_soc_pcm_runtime {
1161 struct snd_soc_card *card;
1162 struct snd_soc_dai_link *dai_link;
1163 struct mutex pcm_mutex;
1164 enum snd_soc_pcm_subclass pcm_subclass;
1165 struct snd_pcm_ops ops;
1167 unsigned int dev_registered:1;
1169 /* Dynamic PCM BE runtime data */
1170 struct snd_soc_dpcm_runtime dpcm[2];
1174 unsigned char pop_wait:1;
1176 /* runtime devices */
1177 struct snd_pcm *pcm;
1178 struct snd_compr *compr;
1179 struct snd_soc_codec *codec;
1180 struct snd_soc_platform *platform;
1181 struct snd_soc_dai *codec_dai;
1182 struct snd_soc_dai *cpu_dai;
1183 struct snd_soc_component *component; /* Only valid for AUX dev rtds */
1185 struct snd_soc_dai **codec_dais;
1186 unsigned int num_codecs;
1188 struct delayed_work delayed_work;
1189 #ifdef CONFIG_DEBUG_FS
1190 struct dentry *debugfs_dpcm_root;
1191 struct dentry *debugfs_dpcm_state;
1196 struct soc_mixer_control {
1197 int min, max, platform_max;
1199 unsigned int shift, rshift;
1200 unsigned int sign_bit;
1201 unsigned int invert:1;
1202 unsigned int autodisable:1;
1203 struct snd_soc_dobj dobj;
1212 struct soc_bytes_ext {
1214 struct snd_soc_dobj dobj;
1216 /* used for TLV byte control */
1217 int (*get)(unsigned int __user *bytes, unsigned int size);
1218 int (*put)(const unsigned int __user *bytes, unsigned int size);
1221 /* multi register control */
1222 struct soc_mreg_control {
1224 unsigned int regbase, regcount, nbits, invert;
1227 /* enumerated kcontrol */
1230 unsigned char shift_l;
1231 unsigned char shift_r;
1234 const char * const *texts;
1235 const unsigned int *values;
1236 unsigned int autodisable:1;
1237 struct snd_soc_dobj dobj;
1241 * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1242 * @component: The component to cast to a CODEC
1244 * This function must only be used on components that are known to be CODECs.
1245 * Otherwise the behavior is undefined.
1247 static inline struct snd_soc_codec *snd_soc_component_to_codec(
1248 struct snd_soc_component *component)
1250 return container_of(component, struct snd_soc_codec, component);
1254 * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1255 * @component: The component to cast to a platform
1257 * This function must only be used on components that are known to be platforms.
1258 * Otherwise the behavior is undefined.
1260 static inline struct snd_soc_platform *snd_soc_component_to_platform(
1261 struct snd_soc_component *component)
1263 return container_of(component, struct snd_soc_platform, component);
1267 * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
1269 * @dapm: The DAPM context to cast to the component
1271 * This function must only be used on DAPM contexts that are known to be part of
1272 * a component (e.g. in a component driver). Otherwise the behavior is
1275 static inline struct snd_soc_component *snd_soc_dapm_to_component(
1276 struct snd_soc_dapm_context *dapm)
1278 return container_of(dapm, struct snd_soc_component, dapm);
1282 * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in
1283 * @dapm: The DAPM context to cast to the CODEC
1285 * This function must only be used on DAPM contexts that are known to be part of
1286 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1288 static inline struct snd_soc_codec *snd_soc_dapm_to_codec(
1289 struct snd_soc_dapm_context *dapm)
1291 return snd_soc_component_to_codec(snd_soc_dapm_to_component(dapm));
1295 * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is
1297 * @dapm: The DAPM context to cast to the platform.
1299 * This function must only be used on DAPM contexts that are known to be part of
1300 * a platform (e.g. in a platform driver). Otherwise the behavior is undefined.
1302 static inline struct snd_soc_platform *snd_soc_dapm_to_platform(
1303 struct snd_soc_dapm_context *dapm)
1305 return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm));
1309 * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
1311 * @component: The component for which to get the DAPM context
1313 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
1314 struct snd_soc_component *component)
1316 return &component->dapm;
1320 * snd_soc_codec_get_dapm() - Returns the DAPM context for the CODEC
1321 * @codec: The CODEC for which to get the DAPM context
1323 * Note: Use this function instead of directly accessing the CODEC's dapm field
1325 static inline struct snd_soc_dapm_context *snd_soc_codec_get_dapm(
1326 struct snd_soc_codec *codec)
1328 return snd_soc_component_get_dapm(&codec->component);
1332 * snd_soc_dapm_init_bias_level() - Initialize CODEC DAPM bias level
1333 * @codec: The CODEC for which to initialize the DAPM bias level
1334 * @level: The DAPM level to initialize to
1336 * Initializes the CODEC DAPM bias level. See snd_soc_dapm_init_bias_level().
1338 static inline void snd_soc_codec_init_bias_level(struct snd_soc_codec *codec,
1339 enum snd_soc_bias_level level)
1341 snd_soc_dapm_init_bias_level(snd_soc_codec_get_dapm(codec), level);
1345 * snd_soc_dapm_get_bias_level() - Get current CODEC DAPM bias level
1346 * @codec: The CODEC for which to get the DAPM bias level
1348 * Returns: The current DAPM bias level of the CODEC.
1350 static inline enum snd_soc_bias_level snd_soc_codec_get_bias_level(
1351 struct snd_soc_codec *codec)
1353 return snd_soc_dapm_get_bias_level(snd_soc_codec_get_dapm(codec));
1357 * snd_soc_codec_force_bias_level() - Set the CODEC DAPM bias level
1358 * @codec: The CODEC for which to set the level
1359 * @level: The level to set to
1361 * Forces the CODEC bias level to a specific state. See
1362 * snd_soc_dapm_force_bias_level().
1364 static inline int snd_soc_codec_force_bias_level(struct snd_soc_codec *codec,
1365 enum snd_soc_bias_level level)
1367 return snd_soc_dapm_force_bias_level(snd_soc_codec_get_dapm(codec),
1372 * snd_soc_dapm_kcontrol_codec() - Returns the codec associated to a kcontrol
1373 * @kcontrol: The kcontrol
1375 * This function must only be used on DAPM contexts that are known to be part of
1376 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1378 static inline struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(
1379 struct snd_kcontrol *kcontrol)
1381 return snd_soc_dapm_to_codec(snd_soc_dapm_kcontrol_dapm(kcontrol));
1385 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1386 int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg,
1390 * snd_soc_cache_sync() - Sync the register cache with the hardware
1391 * @codec: CODEC to sync
1393 * Note: This function will call regcache_sync()
1395 static inline int snd_soc_cache_sync(struct snd_soc_codec *codec)
1397 return regcache_sync(codec->component.regmap);
1401 int snd_soc_component_read(struct snd_soc_component *component,
1402 unsigned int reg, unsigned int *val);
1403 int snd_soc_component_write(struct snd_soc_component *component,
1404 unsigned int reg, unsigned int val);
1405 int snd_soc_component_update_bits(struct snd_soc_component *component,
1406 unsigned int reg, unsigned int mask, unsigned int val);
1407 int snd_soc_component_update_bits_async(struct snd_soc_component *component,
1408 unsigned int reg, unsigned int mask, unsigned int val);
1409 void snd_soc_component_async_complete(struct snd_soc_component *component);
1410 int snd_soc_component_test_bits(struct snd_soc_component *component,
1411 unsigned int reg, unsigned int mask, unsigned int value);
1413 #ifdef CONFIG_REGMAP
1415 void snd_soc_component_init_regmap(struct snd_soc_component *component,
1416 struct regmap *regmap);
1417 void snd_soc_component_exit_regmap(struct snd_soc_component *component);
1420 * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC
1421 * @codec: The CODEC for which to initialize the regmap instance
1422 * @regmap: The regmap instance that should be used by the CODEC
1424 * This function allows deferred assignment of the regmap instance that is
1425 * associated with the CODEC. Only use this if the regmap instance is not yet
1426 * ready when the CODEC is registered. The function must also be called before
1427 * the first IO attempt of the CODEC.
1429 static inline void snd_soc_codec_init_regmap(struct snd_soc_codec *codec,
1430 struct regmap *regmap)
1432 snd_soc_component_init_regmap(&codec->component, regmap);
1436 * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC
1437 * @codec: The CODEC for which to de-initialize the regmap instance
1439 * Calls regmap_exit() on the regmap instance associated to the CODEC and
1440 * removes the regmap instance from the CODEC.
1442 * This function should only be used if snd_soc_codec_init_regmap() was used to
1443 * initialize the regmap instance.
1445 static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec *codec)
1447 snd_soc_component_exit_regmap(&codec->component);
1452 /* device driver data */
1454 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1457 card->drvdata = data;
1460 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1462 return card->drvdata;
1465 static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
1468 dev_set_drvdata(c->dev, data);
1471 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
1473 return dev_get_drvdata(c->dev);
1476 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1479 snd_soc_component_set_drvdata(&codec->component, data);
1482 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1484 return snd_soc_component_get_drvdata(&codec->component);
1487 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1490 snd_soc_component_set_drvdata(&platform->component, data);
1493 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1495 return snd_soc_component_get_drvdata(&platform->component);
1498 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1501 dev_set_drvdata(rtd->dev, data);
1504 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1506 return dev_get_drvdata(rtd->dev);
1509 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1511 INIT_LIST_HEAD(&card->codec_dev_list);
1512 INIT_LIST_HEAD(&card->widgets);
1513 INIT_LIST_HEAD(&card->paths);
1514 INIT_LIST_HEAD(&card->dapm_list);
1517 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1519 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1522 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1523 * mc->reg != mc->rreg means that the control is
1524 * stereo (bits in one register or in two registers)
1529 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1537 for (i = 0; i < e->items; i++)
1538 if (val == e->values[i])
1544 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1550 return e->values[item];
1553 static inline bool snd_soc_component_is_active(
1554 struct snd_soc_component *component)
1556 return component->active != 0;
1559 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1561 return snd_soc_component_is_active(&codec->component);
1565 * snd_soc_kcontrol_component() - Returns the component that registered the
1567 * @kcontrol: The control for which to get the component
1569 * Note: This function will work correctly if the control has been registered
1570 * for a component. Either with snd_soc_add_codec_controls() or
1571 * snd_soc_add_platform_controls() or via table based setup for either a
1572 * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1574 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1575 struct snd_kcontrol *kcontrol)
1577 return snd_kcontrol_chip(kcontrol);
1581 * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1582 * @kcontrol: The control for which to get the CODEC
1584 * Note: This function will only work correctly if the control has been
1585 * registered with snd_soc_add_codec_controls() or via table based setup of
1586 * snd_soc_codec_driver. Otherwise the behavior is undefined.
1588 static inline struct snd_soc_codec *snd_soc_kcontrol_codec(
1589 struct snd_kcontrol *kcontrol)
1591 return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol));
1595 * snd_soc_kcontrol_platform() - Returns the platform that registered the control
1596 * @kcontrol: The control for which to get the platform
1598 * Note: This function will only work correctly if the control has been
1599 * registered with snd_soc_add_platform_controls() or via table based setup of
1600 * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1602 static inline struct snd_soc_platform *snd_soc_kcontrol_platform(
1603 struct snd_kcontrol *kcontrol)
1605 return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol));
1608 int snd_soc_util_init(void);
1609 void snd_soc_util_exit(void);
1611 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1612 const char *propname);
1613 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1614 const char *propname);
1615 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1616 unsigned int *tx_mask,
1617 unsigned int *rx_mask,
1618 unsigned int *slots,
1619 unsigned int *slot_width);
1620 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1621 struct snd_soc_codec_conf *codec_conf,
1622 struct device_node *of_node,
1623 const char *propname);
1624 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1625 const char *propname);
1626 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1628 struct device_node **bitclkmaster,
1629 struct device_node **framemaster);
1630 int snd_soc_of_get_dai_name(struct device_node *of_node,
1631 const char **dai_name);
1632 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1633 struct device_node *of_node,
1634 struct snd_soc_dai_link *dai_link);
1636 #include <sound/soc-dai.h>
1638 #ifdef CONFIG_DEBUG_FS
1639 extern struct dentry *snd_soc_debugfs_root;
1642 extern const struct dev_pm_ops snd_soc_pm_ops;
1644 /* Helper functions */
1645 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1647 mutex_lock(&dapm->card->dapm_mutex);
1650 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1652 mutex_unlock(&dapm->card->dapm_mutex);