tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0
2 *
3 * linux/sound/soc.h -- ALSA SoC Layer
4 *
5 * Author: Liam Girdwood
6 * Created: Aug 11th 2005
7 * Copyright: Wolfson Microelectronics. PLC.
8 */
9
10#ifndef __LINUX_SND_SOC_H
11#define __LINUX_SND_SOC_H
12
13#include <linux/of.h>
14#include <linux/platform_device.h>
15#include <linux/types.h>
16#include <linux/notifier.h>
17#include <linux/workqueue.h>
18#include <linux/interrupt.h>
19#include <linux/kernel.h>
20#include <linux/regmap.h>
21#include <linux/log2.h>
22#include <sound/core.h>
23#include <sound/pcm.h>
24#include <sound/compress_driver.h>
25#include <sound/control.h>
26#include <sound/ac97_codec.h>
27
28/*
29 * Convenience kcontrol builders
30 */
31#define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert, xautodisable) \
32 ((unsigned long)&(struct soc_mixer_control) \
33 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
34 .rshift = shift_right, .max = xmax, \
35 .invert = xinvert, .autodisable = xautodisable})
36#define SOC_DOUBLE_S_VALUE(xreg, shift_left, shift_right, xmin, xmax, xsign_bit, xinvert, xautodisable) \
37 ((unsigned long)&(struct soc_mixer_control) \
38 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
39 .rshift = shift_right, .min = xmin, .max = xmax, \
40 .sign_bit = xsign_bit, .invert = xinvert, .autodisable = xautodisable})
41#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \
42 SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable)
43#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
44 ((unsigned long)&(struct soc_mixer_control) \
45 {.reg = xreg, .max = xmax, .invert = xinvert})
46#define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
47 ((unsigned long)&(struct soc_mixer_control) \
48 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
49 .max = xmax, .invert = xinvert})
50#define SOC_DOUBLE_R_S_VALUE(xlreg, xrreg, xshift, xmin, xmax, xsign_bit, xinvert) \
51 ((unsigned long)&(struct soc_mixer_control) \
52 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
53 .max = xmax, .min = xmin, .sign_bit = xsign_bit, \
54 .invert = xinvert})
55#define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
56 ((unsigned long)&(struct soc_mixer_control) \
57 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
58 .min = xmin, .max = xmax, .invert = xinvert})
59#define SOC_SINGLE(xname, reg, shift, max, invert) \
60{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
61 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
62 .put = snd_soc_put_volsw, \
63 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
64#define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
65{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
66 .info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
67 .put = snd_soc_put_volsw_range, \
68 .private_value = (unsigned long)&(struct soc_mixer_control) \
69 {.reg = xreg, .rreg = xreg, .shift = xshift, \
70 .rshift = xshift, .min = xmin, .max = xmax, \
71 .invert = xinvert} }
72#define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
73{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
74 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
75 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
76 .tlv.p = (tlv_array), \
77 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
78 .put = snd_soc_put_volsw, \
79 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
80#define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
81{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
82 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
83 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
84 .tlv.p = (tlv_array),\
85 .info = snd_soc_info_volsw_sx, \
86 .get = snd_soc_get_volsw_sx,\
87 .put = snd_soc_put_volsw_sx, \
88 .private_value = (unsigned long)&(struct soc_mixer_control) \
89 {.reg = xreg, .rreg = xreg, \
90 .shift = xshift, .rshift = xshift, \
91 .max = xmax, .min = xmin} }
92#define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
93{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
94 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
95 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
96 .tlv.p = (tlv_array), \
97 .info = snd_soc_info_volsw_range, \
98 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
99 .private_value = (unsigned long)&(struct soc_mixer_control) \
100 {.reg = xreg, .rreg = xreg, .shift = xshift, \
101 .rshift = xshift, .min = xmin, .max = xmax, \
102 .invert = xinvert} }
103#define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
104{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
105 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
106 .put = snd_soc_put_volsw, \
107 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
108 max, invert, 0) }
109#define SOC_DOUBLE_STS(xname, reg, shift_left, shift_right, max, invert) \
110{ \
111 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
112 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
113 .access = SNDRV_CTL_ELEM_ACCESS_READ | \
114 SNDRV_CTL_ELEM_ACCESS_VOLATILE, \
115 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
116 max, invert, 0) }
117#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
118{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
119 .info = snd_soc_info_volsw, \
120 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
121 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
122 xmax, xinvert) }
123#define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
124 xmax, xinvert) \
125{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
126 .info = snd_soc_info_volsw_range, \
127 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
128 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
129 xshift, xmin, xmax, xinvert) }
130#define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
131{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
132 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
133 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
134 .tlv.p = (tlv_array), \
135 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
136 .put = snd_soc_put_volsw, \
137 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
138 max, invert, 0) }
139#define SOC_DOUBLE_SX_TLV(xname, xreg, shift_left, shift_right, xmin, xmax, tlv_array) \
140{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
141 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
142 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
143 .tlv.p = (tlv_array), \
144 .info = snd_soc_info_volsw_sx, \
145 .get = snd_soc_get_volsw_sx, \
146 .put = snd_soc_put_volsw_sx, \
147 .private_value = (unsigned long)&(struct soc_mixer_control) \
148 {.reg = xreg, .rreg = xreg, \
149 .shift = shift_left, .rshift = shift_right, \
150 .max = xmax, .min = xmin} }
151#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
152{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
153 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
154 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
155 .tlv.p = (tlv_array), \
156 .info = snd_soc_info_volsw, \
157 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
158 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
159 xmax, xinvert) }
160#define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
161 xmax, xinvert, tlv_array) \
162{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
163 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
164 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
165 .tlv.p = (tlv_array), \
166 .info = snd_soc_info_volsw_range, \
167 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
168 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
169 xshift, xmin, xmax, xinvert) }
170#define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
171{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
172 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
173 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
174 .tlv.p = (tlv_array), \
175 .info = snd_soc_info_volsw_sx, \
176 .get = snd_soc_get_volsw_sx, \
177 .put = snd_soc_put_volsw_sx, \
178 .private_value = (unsigned long)&(struct soc_mixer_control) \
179 {.reg = xreg, .rreg = xrreg, \
180 .shift = xshift, .rshift = xshift, \
181 .max = xmax, .min = xmin} }
182#define SOC_DOUBLE_R_S_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
183{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
184 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
185 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
186 .tlv.p = (tlv_array), \
187 .info = snd_soc_info_volsw, \
188 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
189 .private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
190 xmin, xmax, xsign_bit, xinvert) }
191#define SOC_SINGLE_S_TLV(xname, xreg, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
192 SOC_DOUBLE_R_S_TLV(xname, xreg, xreg, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array)
193#define SOC_SINGLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
194{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
195 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
196 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
197 .tlv.p = (tlv_array), \
198 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
199 .put = snd_soc_put_volsw, \
200 .private_value = (unsigned long)&(struct soc_mixer_control) \
201 {.reg = xreg, .rreg = xreg, \
202 .min = xmin, .max = xmax, \
203 .sign_bit = 7,} }
204#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
205{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
206 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
207 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
208 .tlv.p = (tlv_array), \
209 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
210 .put = snd_soc_put_volsw, \
211 .private_value = SOC_DOUBLE_S_VALUE(xreg, 0, 8, xmin, xmax, 7, 0, 0) }
212#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \
213{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
214 .items = xitems, .texts = xtexts, \
215 .mask = xitems ? roundup_pow_of_two(xitems) - 1 : 0}
216#define SOC_ENUM_SINGLE(xreg, xshift, xitems, xtexts) \
217 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xitems, xtexts)
218#define SOC_ENUM_SINGLE_EXT(xitems, xtexts) \
219{ .items = xitems, .texts = xtexts }
220#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xitems, xtexts, xvalues) \
221{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
222 .mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues}
223#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
224 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xitems, xtexts, xvalues)
225#define SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
226{ .reg = xreg, .shift_l = xshift, .shift_r = xshift, \
227 .mask = xmask, .items = xitems, .texts = xtexts, \
228 .values = xvalues, .autodisable = 1}
229#define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \
230 SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
231#define SOC_ENUM(xname, xenum) \
232{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
233 .info = snd_soc_info_enum_double, \
234 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
235 .private_value = (unsigned long)&xenum }
236#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
237 xhandler_get, xhandler_put) \
238{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
239 .info = snd_soc_info_volsw, \
240 .get = xhandler_get, .put = xhandler_put, \
241 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
242#define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
243 xhandler_get, xhandler_put) \
244{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
245 .info = snd_soc_info_volsw, \
246 .get = xhandler_get, .put = xhandler_put, \
247 .private_value = \
248 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
249#define SOC_DOUBLE_R_EXT(xname, reg_left, reg_right, xshift, xmax, xinvert,\
250 xhandler_get, xhandler_put) \
251{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
252 .info = snd_soc_info_volsw, \
253 .get = xhandler_get, .put = xhandler_put, \
254 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
255 xmax, xinvert) }
256#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, 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_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
265#define SOC_SINGLE_RANGE_EXT_TLV(xname, xreg, xshift, xmin, xmax, xinvert, \
266 xhandler_get, xhandler_put, tlv_array) \
267{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
268 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
269 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
270 .tlv.p = (tlv_array), \
271 .info = snd_soc_info_volsw_range, \
272 .get = xhandler_get, .put = xhandler_put, \
273 .private_value = (unsigned long)&(struct soc_mixer_control) \
274 {.reg = xreg, .rreg = xreg, .shift = xshift, \
275 .rshift = xshift, .min = xmin, .max = xmax, \
276 .invert = xinvert} }
277#define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
278 xhandler_get, xhandler_put, tlv_array) \
279{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
280 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
281 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
282 .tlv.p = (tlv_array), \
283 .info = snd_soc_info_volsw, \
284 .get = xhandler_get, .put = xhandler_put, \
285 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
286 xmax, xinvert, 0) }
287#define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
288 xhandler_get, xhandler_put, tlv_array) \
289{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
290 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
291 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
292 .tlv.p = (tlv_array), \
293 .info = snd_soc_info_volsw, \
294 .get = xhandler_get, .put = xhandler_put, \
295 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
296 xmax, xinvert) }
297#define SOC_DOUBLE_R_S_EXT_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, \
298 xsign_bit, xinvert, xhandler_get, xhandler_put, \
299 tlv_array) \
300{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
301 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
302 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
303 .tlv.p = (tlv_array), \
304 .info = snd_soc_info_volsw, \
305 .get = xhandler_get, .put = xhandler_put, \
306 .private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
307 xmin, xmax, xsign_bit, xinvert) }
308#define SOC_SINGLE_S_EXT_TLV(xname, xreg, xshift, xmin, xmax, \
309 xsign_bit, xinvert, xhandler_get, xhandler_put, \
310 tlv_array) \
311 SOC_DOUBLE_R_S_EXT_TLV(xname, xreg, xreg, xshift, xmin, xmax, \
312 xsign_bit, xinvert, xhandler_get, xhandler_put, \
313 tlv_array)
314#define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
315{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
316 .info = snd_soc_info_bool_ext, \
317 .get = xhandler_get, .put = xhandler_put, \
318 .private_value = xdata }
319#define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
320{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
321 .info = snd_soc_info_enum_double, \
322 .get = xhandler_get, .put = xhandler_put, \
323 .private_value = (unsigned long)&xenum }
324#define SOC_VALUE_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
325 SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put)
326
327#define SND_SOC_BYTES(xname, xbase, xregs) \
328{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
329 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
330 .put = snd_soc_bytes_put, .private_value = \
331 ((unsigned long)&(struct soc_bytes) \
332 {.base = xbase, .num_regs = xregs }) }
333#define SND_SOC_BYTES_E(xname, xbase, xregs, xhandler_get, xhandler_put) \
334{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
335 .info = snd_soc_bytes_info, .get = xhandler_get, \
336 .put = xhandler_put, .private_value = \
337 ((unsigned long)&(struct soc_bytes) \
338 {.base = xbase, .num_regs = xregs }) }
339
340#define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask) \
341{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
342 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
343 .put = snd_soc_bytes_put, .private_value = \
344 ((unsigned long)&(struct soc_bytes) \
345 {.base = xbase, .num_regs = xregs, \
346 .mask = xmask }) }
347
348/*
349 * SND_SOC_BYTES_EXT is deprecated, please USE SND_SOC_BYTES_TLV instead
350 */
351#define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \
352{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
353 .info = snd_soc_bytes_info_ext, \
354 .get = xhandler_get, .put = xhandler_put, \
355 .private_value = (unsigned long)&(struct soc_bytes_ext) \
356 {.max = xcount} }
357#define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \
358{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
359 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \
360 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
361 .tlv.c = (snd_soc_bytes_tlv_callback), \
362 .info = snd_soc_bytes_info_ext, \
363 .private_value = (unsigned long)&(struct soc_bytes_ext) \
364 {.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
365#define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
366 xmin, xmax, xinvert) \
367{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
368 .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
369 .put = snd_soc_put_xr_sx, \
370 .private_value = (unsigned long)&(struct soc_mreg_control) \
371 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
372 .invert = xinvert, .min = xmin, .max = xmax} }
373
374#define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
375 SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
376 snd_soc_get_strobe, snd_soc_put_strobe)
377
378/*
379 * Simplified versions of above macros, declaring a struct and calculating
380 * ARRAY_SIZE internally
381 */
382#define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
383 const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
384 ARRAY_SIZE(xtexts), xtexts)
385#define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
386 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
387#define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
388 const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
389#define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
390 const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
391 ARRAY_SIZE(xtexts), xtexts, xvalues)
392#define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
393 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
394
395#define SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
396 const struct soc_enum name = SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, \
397 xshift, xmask, ARRAY_SIZE(xtexts), xtexts, xvalues)
398
399#define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
400 const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
401
402struct device_node;
403struct snd_jack;
404struct snd_soc_card;
405struct snd_soc_pcm_stream;
406struct snd_soc_ops;
407struct snd_soc_pcm_runtime;
408struct snd_soc_dai;
409struct snd_soc_dai_driver;
410struct snd_soc_dai_link;
411struct snd_soc_component;
412struct snd_soc_component_driver;
413struct soc_enum;
414struct snd_soc_jack;
415struct snd_soc_jack_zone;
416struct snd_soc_jack_pin;
417#include <sound/soc-dapm.h>
418#include <sound/soc-dpcm.h>
419#include <sound/soc-topology.h>
420
421struct snd_soc_jack_gpio;
422
423enum snd_soc_pcm_subclass {
424 SND_SOC_PCM_CLASS_PCM = 0,
425 SND_SOC_PCM_CLASS_BE = 1,
426};
427
428int snd_soc_register_card(struct snd_soc_card *card);
429void snd_soc_unregister_card(struct snd_soc_card *card);
430int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
431#ifdef CONFIG_PM_SLEEP
432int snd_soc_suspend(struct device *dev);
433int snd_soc_resume(struct device *dev);
434#else
435static inline int snd_soc_suspend(struct device *dev)
436{
437 return 0;
438}
439
440static inline int snd_soc_resume(struct device *dev)
441{
442 return 0;
443}
444#endif
445int snd_soc_poweroff(struct device *dev);
446int snd_soc_component_initialize(struct snd_soc_component *component,
447 const struct snd_soc_component_driver *driver,
448 struct device *dev);
449int snd_soc_add_component(struct snd_soc_component *component,
450 struct snd_soc_dai_driver *dai_drv,
451 int num_dai);
452int snd_soc_register_component(struct device *dev,
453 const struct snd_soc_component_driver *component_driver,
454 struct snd_soc_dai_driver *dai_drv, int num_dai);
455int devm_snd_soc_register_component(struct device *dev,
456 const struct snd_soc_component_driver *component_driver,
457 struct snd_soc_dai_driver *dai_drv, int num_dai);
458void snd_soc_unregister_component(struct device *dev);
459void snd_soc_unregister_component_by_driver(struct device *dev,
460 const struct snd_soc_component_driver *component_driver);
461struct snd_soc_component *snd_soc_lookup_component_nolocked(struct device *dev,
462 const char *driver_name);
463struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
464 const char *driver_name);
465
466int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
467#ifdef CONFIG_SND_SOC_COMPRESS
468int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
469#else
470static inline int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num)
471{
472 return 0;
473}
474#endif
475
476void snd_soc_disconnect_sync(struct device *dev);
477
478struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
479 struct snd_soc_dai_link *dai_link);
480
481bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
482
483void snd_soc_runtime_action(struct snd_soc_pcm_runtime *rtd,
484 int stream, int action);
485static inline void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd,
486 int stream)
487{
488 snd_soc_runtime_action(rtd, stream, 1);
489}
490static inline void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd,
491 int stream)
492{
493 snd_soc_runtime_action(rtd, stream, -1);
494}
495
496int snd_soc_runtime_calc_hw(struct snd_soc_pcm_runtime *rtd,
497 struct snd_pcm_hardware *hw, int stream);
498
499int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
500 unsigned int dai_fmt);
501
502#ifdef CONFIG_DMI
503int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour);
504#else
505static inline int snd_soc_set_dmi_name(struct snd_soc_card *card,
506 const char *flavour)
507{
508 return 0;
509}
510#endif
511
512/* Utility functions to get clock rates from various things */
513int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
514int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
515int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
516int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
517int snd_soc_tdm_params_to_bclk(struct snd_pcm_hw_params *params,
518 int tdm_width, int tdm_slots, int slot_multiple);
519
520/* set runtime hw params */
521int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
522 const struct snd_pcm_hardware *hw);
523
524struct snd_ac97 *snd_soc_alloc_ac97_component(struct snd_soc_component *component);
525struct snd_ac97 *snd_soc_new_ac97_component(struct snd_soc_component *component,
526 unsigned int id, unsigned int id_mask);
527void snd_soc_free_ac97_component(struct snd_ac97 *ac97);
528
529#ifdef CONFIG_SND_SOC_AC97_BUS
530int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
531int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
532 struct platform_device *pdev);
533
534extern struct snd_ac97_bus_ops *soc_ac97_ops;
535#else
536static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
537 struct platform_device *pdev)
538{
539 return 0;
540}
541
542static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
543{
544 return 0;
545}
546#endif
547
548/*
549 *Controls
550 */
551struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
552 void *data, const char *long_name,
553 const char *prefix);
554int snd_soc_add_component_controls(struct snd_soc_component *component,
555 const struct snd_kcontrol_new *controls, unsigned int num_controls);
556int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
557 const struct snd_kcontrol_new *controls, int num_controls);
558int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
559 const struct snd_kcontrol_new *controls, int num_controls);
560int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
561 struct snd_ctl_elem_info *uinfo);
562int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
563 struct snd_ctl_elem_value *ucontrol);
564int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
565 struct snd_ctl_elem_value *ucontrol);
566int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
567 struct snd_ctl_elem_info *uinfo);
568int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol,
569 struct snd_ctl_elem_info *uinfo);
570#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
571int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
572 struct snd_ctl_elem_value *ucontrol);
573int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
574 struct snd_ctl_elem_value *ucontrol);
575#define snd_soc_get_volsw_2r snd_soc_get_volsw
576#define snd_soc_put_volsw_2r snd_soc_put_volsw
577int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
578 struct snd_ctl_elem_value *ucontrol);
579int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
580 struct snd_ctl_elem_value *ucontrol);
581int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
582 struct snd_ctl_elem_info *uinfo);
583int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
584 struct snd_ctl_elem_value *ucontrol);
585int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
586 struct snd_ctl_elem_value *ucontrol);
587int snd_soc_limit_volume(struct snd_soc_card *card,
588 const char *name, int max);
589int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
590 struct snd_ctl_elem_info *uinfo);
591int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
592 struct snd_ctl_elem_value *ucontrol);
593int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
594 struct snd_ctl_elem_value *ucontrol);
595int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
596 struct snd_ctl_elem_info *ucontrol);
597int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
598 unsigned int size, unsigned int __user *tlv);
599int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
600 struct snd_ctl_elem_info *uinfo);
601int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
602 struct snd_ctl_elem_value *ucontrol);
603int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
604 struct snd_ctl_elem_value *ucontrol);
605int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
606 struct snd_ctl_elem_value *ucontrol);
607int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
608 struct snd_ctl_elem_value *ucontrol);
609
610/* SoC PCM stream information */
611struct snd_soc_pcm_stream {
612 const char *stream_name;
613 u64 formats; /* SNDRV_PCM_FMTBIT_* */
614 unsigned int rates; /* SNDRV_PCM_RATE_* */
615 unsigned int rate_min; /* min rate */
616 unsigned int rate_max; /* max rate */
617 unsigned int channels_min; /* min channels */
618 unsigned int channels_max; /* max channels */
619 unsigned int sig_bits; /* number of bits of content */
620};
621
622/* SoC audio ops */
623struct snd_soc_ops {
624 int (*startup)(struct snd_pcm_substream *);
625 void (*shutdown)(struct snd_pcm_substream *);
626 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
627 int (*hw_free)(struct snd_pcm_substream *);
628 int (*prepare)(struct snd_pcm_substream *);
629 int (*trigger)(struct snd_pcm_substream *, int);
630};
631
632struct snd_soc_compr_ops {
633 int (*startup)(struct snd_compr_stream *);
634 void (*shutdown)(struct snd_compr_stream *);
635 int (*set_params)(struct snd_compr_stream *);
636 int (*trigger)(struct snd_compr_stream *);
637};
638
639struct snd_soc_component*
640snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
641 const char *driver_name);
642
643struct snd_soc_dai_link_component {
644 const char *name;
645 struct device_node *of_node;
646 const char *dai_name;
647};
648
649struct snd_soc_dai_link {
650 /* config - must be set by machine driver */
651 const char *name; /* Codec name */
652 const char *stream_name; /* Stream name */
653
654 /*
655 * You MAY specify the link's CPU-side device, either by device name,
656 * or by DT/OF node, but not both. If this information is omitted,
657 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
658 * must be globally unique. These fields are currently typically used
659 * only for codec to codec links, or systems using device tree.
660 */
661 /*
662 * You MAY specify the DAI name of the CPU DAI. If this information is
663 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
664 * only, which only works well when that device exposes a single DAI.
665 */
666 struct snd_soc_dai_link_component *cpus;
667 unsigned int num_cpus;
668
669 /*
670 * You MUST specify the link's codec, either by device name, or by
671 * DT/OF node, but not both.
672 */
673 /* You MUST specify the DAI name within the codec */
674 struct snd_soc_dai_link_component *codecs;
675 unsigned int num_codecs;
676
677 /*
678 * You MAY specify the link's platform/PCM/DMA driver, either by
679 * device name, or by DT/OF node, but not both. Some forms of link
680 * do not need a platform. In such case, platforms are not mandatory.
681 */
682 struct snd_soc_dai_link_component *platforms;
683 unsigned int num_platforms;
684
685 int id; /* optional ID for machine driver link identification */
686
687 const struct snd_soc_pcm_stream *params;
688 unsigned int num_params;
689
690 unsigned int dai_fmt; /* format to set on init */
691
692 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
693
694 /* codec/machine specific init - e.g. add machine controls */
695 int (*init)(struct snd_soc_pcm_runtime *rtd);
696
697 /* codec/machine specific exit - dual of init() */
698 void (*exit)(struct snd_soc_pcm_runtime *rtd);
699
700 /* optional hw_params re-writing for BE and FE sync */
701 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
702 struct snd_pcm_hw_params *params);
703
704 /* machine stream operations */
705 const struct snd_soc_ops *ops;
706 const struct snd_soc_compr_ops *compr_ops;
707
708 /* Mark this pcm with non atomic ops */
709 unsigned int nonatomic:1;
710
711 /* For unidirectional dai links */
712 unsigned int playback_only:1;
713 unsigned int capture_only:1;
714
715 /* Keep DAI active over suspend */
716 unsigned int ignore_suspend:1;
717
718 /* Symmetry requirements */
719 unsigned int symmetric_rate:1;
720 unsigned int symmetric_channels:1;
721 unsigned int symmetric_sample_bits:1;
722
723 /* Do not create a PCM for this DAI link (Backend link) */
724 unsigned int no_pcm:1;
725
726 /* This DAI link can route to other DAI links at runtime (Frontend)*/
727 unsigned int dynamic:1;
728
729 /* DPCM capture and Playback support */
730 unsigned int dpcm_capture:1;
731 unsigned int dpcm_playback:1;
732
733 /* DPCM used FE & BE merged format */
734 unsigned int dpcm_merged_format:1;
735 /* DPCM used FE & BE merged channel */
736 unsigned int dpcm_merged_chan:1;
737 /* DPCM used FE & BE merged rate */
738 unsigned int dpcm_merged_rate:1;
739
740 /* pmdown_time is ignored at stop */
741 unsigned int ignore_pmdown_time:1;
742
743 /* Do not create a PCM for this DAI link (Backend link) */
744 unsigned int ignore:1;
745
746 /* This flag will reorder stop sequence. By enabling this flag
747 * DMA controller stop sequence will be invoked first followed by
748 * CPU DAI driver stop sequence
749 */
750 unsigned int stop_dma_first:1;
751
752#ifdef CONFIG_SND_SOC_TOPOLOGY
753 struct snd_soc_dobj dobj; /* For topology */
754#endif
755};
756
757static inline struct snd_soc_dai_link_component*
758asoc_link_to_cpu(struct snd_soc_dai_link *link, int n) {
759 return &(link)->cpus[n];
760}
761
762static inline struct snd_soc_dai_link_component*
763asoc_link_to_codec(struct snd_soc_dai_link *link, int n) {
764 return &(link)->codecs[n];
765}
766
767static inline struct snd_soc_dai_link_component*
768asoc_link_to_platform(struct snd_soc_dai_link *link, int n) {
769 return &(link)->platforms[n];
770}
771
772#define for_each_link_codecs(link, i, codec) \
773 for ((i) = 0; \
774 ((i) < link->num_codecs) && \
775 ((codec) = asoc_link_to_codec(link, i)); \
776 (i)++)
777
778#define for_each_link_platforms(link, i, platform) \
779 for ((i) = 0; \
780 ((i) < link->num_platforms) && \
781 ((platform) = asoc_link_to_platform(link, i)); \
782 (i)++)
783
784#define for_each_link_cpus(link, i, cpu) \
785 for ((i) = 0; \
786 ((i) < link->num_cpus) && \
787 ((cpu) = asoc_link_to_cpu(link, i)); \
788 (i)++)
789
790/*
791 * Sample 1 : Single CPU/Codec/Platform
792 *
793 * SND_SOC_DAILINK_DEFS(test,
794 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai")),
795 * DAILINK_COMP_ARRAY(COMP_CODEC("codec", "codec_dai")),
796 * DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
797 *
798 * struct snd_soc_dai_link link = {
799 * ...
800 * SND_SOC_DAILINK_REG(test),
801 * };
802 *
803 * Sample 2 : Multi CPU/Codec, no Platform
804 *
805 * SND_SOC_DAILINK_DEFS(test,
806 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
807 * COMP_CPU("cpu_dai2")),
808 * DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
809 * COMP_CODEC("codec2", "codec_dai2")));
810 *
811 * struct snd_soc_dai_link link = {
812 * ...
813 * SND_SOC_DAILINK_REG(test),
814 * };
815 *
816 * Sample 3 : Define each CPU/Codec/Platform manually
817 *
818 * SND_SOC_DAILINK_DEF(test_cpu,
819 * DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
820 * COMP_CPU("cpu_dai2")));
821 * SND_SOC_DAILINK_DEF(test_codec,
822 * DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
823 * COMP_CODEC("codec2", "codec_dai2")));
824 * SND_SOC_DAILINK_DEF(test_platform,
825 * DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
826 *
827 * struct snd_soc_dai_link link = {
828 * ...
829 * SND_SOC_DAILINK_REG(test_cpu,
830 * test_codec,
831 * test_platform),
832 * };
833 *
834 * Sample 4 : Sample3 without platform
835 *
836 * struct snd_soc_dai_link link = {
837 * ...
838 * SND_SOC_DAILINK_REG(test_cpu,
839 * test_codec);
840 * };
841 */
842
843#define SND_SOC_DAILINK_REG1(name) SND_SOC_DAILINK_REG3(name##_cpus, name##_codecs, name##_platforms)
844#define SND_SOC_DAILINK_REG2(cpu, codec) SND_SOC_DAILINK_REG3(cpu, codec, null_dailink_component)
845#define SND_SOC_DAILINK_REG3(cpu, codec, platform) \
846 .cpus = cpu, \
847 .num_cpus = ARRAY_SIZE(cpu), \
848 .codecs = codec, \
849 .num_codecs = ARRAY_SIZE(codec), \
850 .platforms = platform, \
851 .num_platforms = ARRAY_SIZE(platform)
852
853#define SND_SOC_DAILINK_REGx(_1, _2, _3, func, ...) func
854#define SND_SOC_DAILINK_REG(...) \
855 SND_SOC_DAILINK_REGx(__VA_ARGS__, \
856 SND_SOC_DAILINK_REG3, \
857 SND_SOC_DAILINK_REG2, \
858 SND_SOC_DAILINK_REG1)(__VA_ARGS__)
859
860#define SND_SOC_DAILINK_DEF(name, def...) \
861 static struct snd_soc_dai_link_component name[] = { def }
862
863#define SND_SOC_DAILINK_DEFS(name, cpu, codec, platform...) \
864 SND_SOC_DAILINK_DEF(name##_cpus, cpu); \
865 SND_SOC_DAILINK_DEF(name##_codecs, codec); \
866 SND_SOC_DAILINK_DEF(name##_platforms, platform)
867
868#define DAILINK_COMP_ARRAY(param...) param
869#define COMP_EMPTY() { }
870#define COMP_CPU(_dai) { .dai_name = _dai, }
871#define COMP_CODEC(_name, _dai) { .name = _name, .dai_name = _dai, }
872#define COMP_PLATFORM(_name) { .name = _name }
873#define COMP_AUX(_name) { .name = _name }
874#define COMP_CODEC_CONF(_name) { .name = _name }
875#define COMP_DUMMY() { .name = "snd-soc-dummy", .dai_name = "snd-soc-dummy-dai", }
876
877extern struct snd_soc_dai_link_component null_dailink_component[0];
878
879
880struct snd_soc_codec_conf {
881 /*
882 * specify device either by device name, or by
883 * DT/OF node, but not both.
884 */
885 struct snd_soc_dai_link_component dlc;
886
887 /*
888 * optional map of kcontrol, widget and path name prefixes that are
889 * associated per device
890 */
891 const char *name_prefix;
892};
893
894struct snd_soc_aux_dev {
895 /*
896 * specify multi-codec either by device name, or by
897 * DT/OF node, but not both.
898 */
899 struct snd_soc_dai_link_component dlc;
900
901 /* codec/machine specific init - e.g. add machine controls */
902 int (*init)(struct snd_soc_component *component);
903};
904
905/* SoC card */
906struct snd_soc_card {
907 const char *name;
908 const char *long_name;
909 const char *driver_name;
910 const char *components;
911#ifdef CONFIG_DMI
912 char dmi_longname[80];
913#endif /* CONFIG_DMI */
914 char topology_shortname[32];
915
916 struct device *dev;
917 struct snd_card *snd_card;
918 struct module *owner;
919
920 struct mutex mutex;
921 struct mutex dapm_mutex;
922
923 /* Mutex for PCM operations */
924 struct mutex pcm_mutex;
925 enum snd_soc_pcm_subclass pcm_subclass;
926
927 int (*probe)(struct snd_soc_card *card);
928 int (*late_probe)(struct snd_soc_card *card);
929 void (*fixup_controls)(struct snd_soc_card *card);
930 int (*remove)(struct snd_soc_card *card);
931
932 /* the pre and post PM functions are used to do any PM work before and
933 * after the codec and DAI's do any PM work. */
934 int (*suspend_pre)(struct snd_soc_card *card);
935 int (*suspend_post)(struct snd_soc_card *card);
936 int (*resume_pre)(struct snd_soc_card *card);
937 int (*resume_post)(struct snd_soc_card *card);
938
939 /* callbacks */
940 int (*set_bias_level)(struct snd_soc_card *,
941 struct snd_soc_dapm_context *dapm,
942 enum snd_soc_bias_level level);
943 int (*set_bias_level_post)(struct snd_soc_card *,
944 struct snd_soc_dapm_context *dapm,
945 enum snd_soc_bias_level level);
946
947 int (*add_dai_link)(struct snd_soc_card *,
948 struct snd_soc_dai_link *link);
949 void (*remove_dai_link)(struct snd_soc_card *,
950 struct snd_soc_dai_link *link);
951
952 long pmdown_time;
953
954 /* CPU <--> Codec DAI links */
955 struct snd_soc_dai_link *dai_link; /* predefined links only */
956 int num_links; /* predefined links only */
957
958 struct list_head rtd_list;
959 int num_rtd;
960
961 /* optional codec specific configuration */
962 struct snd_soc_codec_conf *codec_conf;
963 int num_configs;
964
965 /*
966 * optional auxiliary devices such as amplifiers or codecs with DAI
967 * link unused
968 */
969 struct snd_soc_aux_dev *aux_dev;
970 int num_aux_devs;
971 struct list_head aux_comp_list;
972
973 const struct snd_kcontrol_new *controls;
974 int num_controls;
975
976 /*
977 * Card-specific routes and widgets.
978 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
979 */
980 const struct snd_soc_dapm_widget *dapm_widgets;
981 int num_dapm_widgets;
982 const struct snd_soc_dapm_route *dapm_routes;
983 int num_dapm_routes;
984 const struct snd_soc_dapm_widget *of_dapm_widgets;
985 int num_of_dapm_widgets;
986 const struct snd_soc_dapm_route *of_dapm_routes;
987 int num_of_dapm_routes;
988
989 /* lists of probed devices belonging to this card */
990 struct list_head component_dev_list;
991 struct list_head list;
992
993 struct list_head widgets;
994 struct list_head paths;
995 struct list_head dapm_list;
996 struct list_head dapm_dirty;
997
998 /* attached dynamic objects */
999 struct list_head dobj_list;
1000
1001 /* Generic DAPM context for the card */
1002 struct snd_soc_dapm_context dapm;
1003 struct snd_soc_dapm_stats dapm_stats;
1004 struct snd_soc_dapm_update *update;
1005
1006#ifdef CONFIG_DEBUG_FS
1007 struct dentry *debugfs_card_root;
1008#endif
1009#ifdef CONFIG_PM_SLEEP
1010 struct work_struct deferred_resume_work;
1011#endif
1012 u32 pop_time;
1013
1014 /* bit field */
1015 unsigned int instantiated:1;
1016 unsigned int topology_shortname_created:1;
1017 unsigned int fully_routed:1;
1018 unsigned int disable_route_checks:1;
1019 unsigned int probed:1;
1020 unsigned int component_chaining:1;
1021
1022 void *drvdata;
1023};
1024#define for_each_card_prelinks(card, i, link) \
1025 for ((i) = 0; \
1026 ((i) < (card)->num_links) && ((link) = &(card)->dai_link[i]); \
1027 (i)++)
1028#define for_each_card_pre_auxs(card, i, aux) \
1029 for ((i) = 0; \
1030 ((i) < (card)->num_aux_devs) && ((aux) = &(card)->aux_dev[i]); \
1031 (i)++)
1032
1033#define for_each_card_rtds(card, rtd) \
1034 list_for_each_entry(rtd, &(card)->rtd_list, list)
1035#define for_each_card_rtds_safe(card, rtd, _rtd) \
1036 list_for_each_entry_safe(rtd, _rtd, &(card)->rtd_list, list)
1037
1038#define for_each_card_auxs(card, component) \
1039 list_for_each_entry(component, &card->aux_comp_list, card_aux_list)
1040#define for_each_card_auxs_safe(card, component, _comp) \
1041 list_for_each_entry_safe(component, _comp, \
1042 &card->aux_comp_list, card_aux_list)
1043
1044#define for_each_card_components(card, component) \
1045 list_for_each_entry(component, &(card)->component_dev_list, card_list)
1046
1047#define for_each_card_dapms(card, dapm) \
1048 list_for_each_entry(dapm, &card->dapm_list, list)
1049
1050#define for_each_card_widgets(card, w)\
1051 list_for_each_entry(w, &card->widgets, list)
1052#define for_each_card_widgets_safe(card, w, _w) \
1053 list_for_each_entry_safe(w, _w, &card->widgets, list)
1054
1055/* SoC machine DAI configuration, glues a codec and cpu DAI together */
1056struct snd_soc_pcm_runtime {
1057 struct device *dev;
1058 struct snd_soc_card *card;
1059 struct snd_soc_dai_link *dai_link;
1060 struct snd_pcm_ops ops;
1061
1062 unsigned int params_select; /* currently selected param for dai link */
1063
1064 /* Dynamic PCM BE runtime data */
1065 struct snd_soc_dpcm_runtime dpcm[SNDRV_PCM_STREAM_LAST + 1];
1066 struct snd_soc_dapm_widget *c2c_widget[SNDRV_PCM_STREAM_LAST + 1];
1067
1068 long pmdown_time;
1069
1070 /* runtime devices */
1071 struct snd_pcm *pcm;
1072 struct snd_compr *compr;
1073
1074 /*
1075 * dais = cpu_dai + codec_dai
1076 * see
1077 * soc_new_pcm_runtime()
1078 * asoc_rtd_to_cpu()
1079 * asoc_rtd_to_codec()
1080 */
1081 struct snd_soc_dai **dais;
1082
1083 struct delayed_work delayed_work;
1084 void (*close_delayed_work_func)(struct snd_soc_pcm_runtime *rtd);
1085#ifdef CONFIG_DEBUG_FS
1086 struct dentry *debugfs_dpcm_root;
1087#endif
1088
1089 unsigned int num; /* 0-based and monotonic increasing */
1090 struct list_head list; /* rtd list of the soc card */
1091
1092 /* function mark */
1093 struct snd_pcm_substream *mark_startup;
1094 struct snd_pcm_substream *mark_hw_params;
1095 struct snd_pcm_substream *mark_trigger;
1096 struct snd_compr_stream *mark_compr_startup;
1097
1098 /* bit field */
1099 unsigned int pop_wait:1;
1100 unsigned int fe_compr:1; /* for Dynamic PCM */
1101
1102 int num_components;
1103 struct snd_soc_component *components[]; /* CPU/Codec/Platform */
1104};
1105/* see soc_new_pcm_runtime() */
1106#define asoc_rtd_to_cpu(rtd, n) (rtd)->dais[n]
1107#define asoc_rtd_to_codec(rtd, n) (rtd)->dais[n + (rtd)->dai_link->num_cpus]
1108#define asoc_substream_to_rtd(substream) \
1109 (struct snd_soc_pcm_runtime *)snd_pcm_substream_chip(substream)
1110
1111#define for_each_rtd_components(rtd, i, component) \
1112 for ((i) = 0, component = NULL; \
1113 ((i) < rtd->num_components) && ((component) = rtd->components[i]);\
1114 (i)++)
1115#define for_each_rtd_cpu_dais(rtd, i, dai) \
1116 for ((i) = 0; \
1117 ((i) < rtd->dai_link->num_cpus) && ((dai) = asoc_rtd_to_cpu(rtd, i)); \
1118 (i)++)
1119#define for_each_rtd_codec_dais(rtd, i, dai) \
1120 for ((i) = 0; \
1121 ((i) < rtd->dai_link->num_codecs) && ((dai) = asoc_rtd_to_codec(rtd, i)); \
1122 (i)++)
1123#define for_each_rtd_dais(rtd, i, dai) \
1124 for ((i) = 0; \
1125 ((i) < (rtd)->dai_link->num_cpus + (rtd)->dai_link->num_codecs) && \
1126 ((dai) = (rtd)->dais[i]); \
1127 (i)++)
1128
1129void snd_soc_close_delayed_work(struct snd_soc_pcm_runtime *rtd);
1130
1131/* mixer control */
1132struct soc_mixer_control {
1133 int min, max, platform_max;
1134 int reg, rreg;
1135 unsigned int shift, rshift;
1136 unsigned int sign_bit;
1137 unsigned int invert:1;
1138 unsigned int autodisable:1;
1139#ifdef CONFIG_SND_SOC_TOPOLOGY
1140 struct snd_soc_dobj dobj;
1141#endif
1142};
1143
1144struct soc_bytes {
1145 int base;
1146 int num_regs;
1147 u32 mask;
1148};
1149
1150struct soc_bytes_ext {
1151 int max;
1152#ifdef CONFIG_SND_SOC_TOPOLOGY
1153 struct snd_soc_dobj dobj;
1154#endif
1155 /* used for TLV byte control */
1156 int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1157 unsigned int size);
1158 int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1159 unsigned int size);
1160};
1161
1162/* multi register control */
1163struct soc_mreg_control {
1164 long min, max;
1165 unsigned int regbase, regcount, nbits, invert;
1166};
1167
1168/* enumerated kcontrol */
1169struct soc_enum {
1170 int reg;
1171 unsigned char shift_l;
1172 unsigned char shift_r;
1173 unsigned int items;
1174 unsigned int mask;
1175 const char * const *texts;
1176 const unsigned int *values;
1177 unsigned int autodisable:1;
1178#ifdef CONFIG_SND_SOC_TOPOLOGY
1179 struct snd_soc_dobj dobj;
1180#endif
1181};
1182
1183static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1184{
1185 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1186 return false;
1187 /*
1188 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1189 * mc->reg != mc->rreg means that the control is
1190 * stereo (bits in one register or in two registers)
1191 */
1192 return true;
1193}
1194
1195static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1196 unsigned int val)
1197{
1198 unsigned int i;
1199
1200 if (!e->values)
1201 return val;
1202
1203 for (i = 0; i < e->items; i++)
1204 if (val == e->values[i])
1205 return i;
1206
1207 return 0;
1208}
1209
1210static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1211 unsigned int item)
1212{
1213 if (!e->values)
1214 return item;
1215
1216 return e->values[item];
1217}
1218
1219/**
1220 * snd_soc_kcontrol_component() - Returns the component that registered the
1221 * control
1222 * @kcontrol: The control for which to get the component
1223 *
1224 * Note: This function will work correctly if the control has been registered
1225 * for a component. With snd_soc_add_codec_controls() or via table based
1226 * setup for either a CODEC or component driver. Otherwise the behavior is
1227 * undefined.
1228 */
1229static inline struct snd_soc_component *snd_soc_kcontrol_component(
1230 struct snd_kcontrol *kcontrol)
1231{
1232 return snd_kcontrol_chip(kcontrol);
1233}
1234
1235int snd_soc_util_init(void);
1236void snd_soc_util_exit(void);
1237
1238int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1239 const char *propname);
1240int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1241 const char *propname);
1242int snd_soc_of_parse_pin_switches(struct snd_soc_card *card, const char *prop);
1243int snd_soc_of_get_slot_mask(struct device_node *np,
1244 const char *prop_name,
1245 unsigned int *mask);
1246int snd_soc_of_parse_tdm_slot(struct device_node *np,
1247 unsigned int *tx_mask,
1248 unsigned int *rx_mask,
1249 unsigned int *slots,
1250 unsigned int *slot_width);
1251void snd_soc_of_parse_node_prefix(struct device_node *np,
1252 struct snd_soc_codec_conf *codec_conf,
1253 struct device_node *of_node,
1254 const char *propname);
1255static inline
1256void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1257 struct snd_soc_codec_conf *codec_conf,
1258 struct device_node *of_node,
1259 const char *propname)
1260{
1261 snd_soc_of_parse_node_prefix(card->dev->of_node,
1262 codec_conf, of_node, propname);
1263}
1264
1265int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1266 const char *propname);
1267int snd_soc_of_parse_aux_devs(struct snd_soc_card *card, const char *propname);
1268
1269unsigned int snd_soc_daifmt_clock_provider_flipped(unsigned int dai_fmt);
1270unsigned int snd_soc_daifmt_clock_provider_from_bitmap(unsigned int bit_frame);
1271
1272unsigned int snd_soc_daifmt_parse_format(struct device_node *np, const char *prefix);
1273unsigned int snd_soc_daifmt_parse_clock_provider_raw(struct device_node *np,
1274 const char *prefix,
1275 struct device_node **bitclkmaster,
1276 struct device_node **framemaster);
1277#define snd_soc_daifmt_parse_clock_provider_as_bitmap(np, prefix) \
1278 snd_soc_daifmt_parse_clock_provider_raw(np, prefix, NULL, NULL)
1279#define snd_soc_daifmt_parse_clock_provider_as_phandle \
1280 snd_soc_daifmt_parse_clock_provider_raw
1281#define snd_soc_daifmt_parse_clock_provider_as_flag(np, prefix) \
1282 snd_soc_daifmt_clock_provider_from_bitmap( \
1283 snd_soc_daifmt_parse_clock_provider_as_bitmap(np, prefix))
1284
1285int snd_soc_get_dai_id(struct device_node *ep);
1286int snd_soc_get_dai_name(const struct of_phandle_args *args,
1287 const char **dai_name);
1288int snd_soc_of_get_dai_name(struct device_node *of_node,
1289 const char **dai_name);
1290int snd_soc_of_get_dai_link_codecs(struct device *dev,
1291 struct device_node *of_node,
1292 struct snd_soc_dai_link *dai_link);
1293void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link);
1294int snd_soc_of_get_dai_link_cpus(struct device *dev,
1295 struct device_node *of_node,
1296 struct snd_soc_dai_link *dai_link);
1297void snd_soc_of_put_dai_link_cpus(struct snd_soc_dai_link *dai_link);
1298
1299int snd_soc_add_pcm_runtime(struct snd_soc_card *card,
1300 struct snd_soc_dai_link *dai_link);
1301void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
1302 struct snd_soc_pcm_runtime *rtd);
1303
1304struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
1305 struct snd_soc_dai_driver *dai_drv,
1306 bool legacy_dai_naming);
1307struct snd_soc_dai *devm_snd_soc_register_dai(struct device *dev,
1308 struct snd_soc_component *component,
1309 struct snd_soc_dai_driver *dai_drv,
1310 bool legacy_dai_naming);
1311void snd_soc_unregister_dai(struct snd_soc_dai *dai);
1312
1313struct snd_soc_dai *snd_soc_find_dai(
1314 const struct snd_soc_dai_link_component *dlc);
1315struct snd_soc_dai *snd_soc_find_dai_with_mutex(
1316 const struct snd_soc_dai_link_component *dlc);
1317
1318#include <sound/soc-dai.h>
1319
1320static inline
1321int snd_soc_fixup_dai_links_platform_name(struct snd_soc_card *card,
1322 const char *platform_name)
1323{
1324 struct snd_soc_dai_link *dai_link;
1325 const char *name;
1326 int i;
1327
1328 if (!platform_name) /* nothing to do */
1329 return 0;
1330
1331 /* set platform name for each dailink */
1332 for_each_card_prelinks(card, i, dai_link) {
1333 /* only single platform is supported for now */
1334 if (dai_link->num_platforms != 1)
1335 return -EINVAL;
1336
1337 if (!dai_link->platforms)
1338 return -EINVAL;
1339
1340 name = devm_kstrdup(card->dev, platform_name, GFP_KERNEL);
1341 if (!name)
1342 return -ENOMEM;
1343
1344 /* only single platform is supported for now */
1345 dai_link->platforms->name = name;
1346 }
1347
1348 return 0;
1349}
1350
1351#ifdef CONFIG_DEBUG_FS
1352extern struct dentry *snd_soc_debugfs_root;
1353#endif
1354
1355extern const struct dev_pm_ops snd_soc_pm_ops;
1356
1357/* Helper functions */
1358static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1359{
1360 mutex_lock_nested(&dapm->card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
1361}
1362
1363static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1364{
1365 mutex_unlock(&dapm->card->dapm_mutex);
1366}
1367
1368#include <sound/soc-component.h>
1369#include <sound/soc-card.h>
1370#include <sound/soc-jack.h>
1371
1372#endif