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