]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/sound/soc.h
ASoC: core: Implement devm_snd_soc_register_component()
[mirror_ubuntu-artful-kernel.git] / include / sound / soc.h
CommitLineData
808db4a4
RP
1/*
2 * linux/sound/soc.h -- ALSA SoC Layer
3 *
4 * Author: Liam Girdwood
5 * Created: Aug 11th 2005
6 * Copyright: Wolfson Microelectronics. PLC.
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#ifndef __LINUX_SND_SOC_H
14#define __LINUX_SND_SOC_H
15
16#include <linux/platform_device.h>
17#include <linux/types.h>
d5021ec9 18#include <linux/notifier.h>
4484bb2e 19#include <linux/workqueue.h>
ec67624d
LCM
20#include <linux/interrupt.h>
21#include <linux/kernel.h>
be3ea3b9 22#include <linux/regmap.h>
86767b7d 23#include <linux/log2.h>
808db4a4
RP
24#include <sound/core.h>
25#include <sound/pcm.h>
49681077 26#include <sound/compress_driver.h>
808db4a4
RP
27#include <sound/control.h>
28#include <sound/ac97_codec.h>
29
808db4a4
RP
30/*
31 * Convenience kcontrol builders
32 */
57295073 33#define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert, xautodisable) \
4eaa9819 34 ((unsigned long)&(struct soc_mixer_control) \
30d86ba4
PU
35 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
36 .rshift = shift_right, .max = xmax, .platform_max = xmax, \
57295073
LPC
37 .invert = xinvert, .autodisable = xautodisable})
38#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \
39 SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable)
4eaa9819
JS
40#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
41 ((unsigned long)&(struct soc_mixer_control) \
d11bb4a9 42 {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
cdffa775
PU
43#define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
44 ((unsigned long)&(struct soc_mixer_control) \
45 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
46 .max = xmax, .platform_max = xmax, .invert = xinvert})
229e3fdc
MB
47#define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
48 ((unsigned long)&(struct soc_mixer_control) \
49 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
50 .min = xmin, .max = xmax, .platform_max = xmax, .invert = xinvert})
a7a4ac86 51#define SOC_SINGLE(xname, reg, shift, max, invert) \
808db4a4
RP
52{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
53 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
54 .put = snd_soc_put_volsw, \
57295073 55 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
6c9d8cf6
AT
56#define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
57{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
58 .info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
59 .put = snd_soc_put_volsw_range, \
60 .private_value = (unsigned long)&(struct soc_mixer_control) \
9bde4f0b
MB
61 {.reg = xreg, .rreg = xreg, .shift = xshift, \
62 .rshift = xshift, .min = xmin, .max = xmax, \
63 .platform_max = xmax, .invert = xinvert} }
a7a4ac86
PZ
64#define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
65{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
66 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
67 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
68 .tlv.p = (tlv_array), \
69 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
70 .put = snd_soc_put_volsw, \
57295073 71 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
1d99f243
BA
72#define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, 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, \
78 .get = snd_soc_get_volsw_sx,\
79 .put = snd_soc_put_volsw_sx, \
80 .private_value = (unsigned long)&(struct soc_mixer_control) \
81 {.reg = xreg, .rreg = xreg, \
82 .shift = xshift, .rshift = xshift, \
83 .max = xmax, .min = xmin} }
6c9d8cf6
AT
84#define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
85{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
86 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
87 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
88 .tlv.p = (tlv_array), \
89 .info = snd_soc_info_volsw_range, \
90 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
91 .private_value = (unsigned long)&(struct soc_mixer_control) \
9bde4f0b
MB
92 {.reg = xreg, .rreg = xreg, .shift = xshift, \
93 .rshift = xshift, .min = xmin, .max = xmax, \
94 .platform_max = xmax, .invert = xinvert} }
460acbec 95#define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
808db4a4
RP
96{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
97 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
98 .put = snd_soc_put_volsw, \
460acbec 99 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
57295073 100 max, invert, 0) }
4eaa9819 101#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
808db4a4 102{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
e8f5a103 103 .info = snd_soc_info_volsw, \
974815ba 104 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
cdffa775
PU
105 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
106 xmax, xinvert) }
229e3fdc
MB
107#define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
108 xmax, xinvert) \
109{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
110 .info = snd_soc_info_volsw_range, \
111 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
112 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
113 xshift, xmin, xmax, xinvert) }
460acbec 114#define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
a7a4ac86
PZ
115{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
116 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
117 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
118 .tlv.p = (tlv_array), \
119 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
120 .put = snd_soc_put_volsw, \
460acbec 121 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
57295073 122 max, invert, 0) }
4eaa9819 123#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
a7a4ac86
PZ
124{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
125 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
126 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
127 .tlv.p = (tlv_array), \
e8f5a103 128 .info = snd_soc_info_volsw, \
974815ba 129 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
cdffa775
PU
130 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
131 xmax, xinvert) }
229e3fdc
MB
132#define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
133 xmax, xinvert, 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_range, \
139 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
140 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
141 xshift, xmin, xmax, xinvert) }
1d99f243
BA
142#define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, 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_sx, \
149 .put = snd_soc_put_volsw_sx, \
150 .private_value = (unsigned long)&(struct soc_mixer_control) \
151 {.reg = xreg, .rreg = xrreg, \
152 .shift = xshift, .rshift = xshift, \
153 .max = xmax, .min = xmin} }
4eaa9819 154#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
e13ac2e9
MB
155{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
156 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
157 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
158 .tlv.p = (tlv_array), \
159 .info = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
160 .put = snd_soc_put_volsw_s8, \
4eaa9819 161 .private_value = (unsigned long)&(struct soc_mixer_control) \
d11bb4a9
PU
162 {.reg = xreg, .min = xmin, .max = xmax, \
163 .platform_max = xmax} }
f8ba0b7b 164#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
808db4a4 165{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
86767b7d
LPC
166 .max = xmax, .texts = xtexts, \
167 .mask = xmax ? roundup_pow_of_two(xmax) - 1 : 0}
f8ba0b7b
JS
168#define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
169 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
170#define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
171{ .max = xmax, .texts = xtexts }
2e72f8e3
PU
172#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
173{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
174 .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
175#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
176 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
808db4a4
RP
177#define SOC_ENUM(xname, xenum) \
178{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
179 .info = snd_soc_info_enum_double, \
180 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
181 .private_value = (unsigned long)&xenum }
2e72f8e3
PU
182#define SOC_VALUE_ENUM(xname, xenum) \
183{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
74155556 184 .info = snd_soc_info_enum_double, \
2e72f8e3
PU
185 .get = snd_soc_get_value_enum_double, \
186 .put = snd_soc_put_value_enum_double, \
187 .private_value = (unsigned long)&xenum }
f8ba0b7b 188#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
808db4a4
RP
189 xhandler_get, xhandler_put) \
190{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
1c433fbd 191 .info = snd_soc_info_volsw, \
808db4a4 192 .get = xhandler_get, .put = xhandler_put, \
57295073 193 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
460acbec 194#define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
7629ad24
DM
195 xhandler_get, xhandler_put) \
196{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
197 .info = snd_soc_info_volsw, \
198 .get = xhandler_get, .put = xhandler_put, \
460acbec 199 .private_value = \
57295073 200 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
f8ba0b7b 201#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
10144c09
MM
202 xhandler_get, xhandler_put, tlv_array) \
203{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
204 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
205 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
206 .tlv.p = (tlv_array), \
207 .info = snd_soc_info_volsw, \
208 .get = xhandler_get, .put = xhandler_put, \
57295073 209 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
d0af93db
JS
210#define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
211 xhandler_get, xhandler_put, tlv_array) \
212{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
213 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
214 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
215 .tlv.p = (tlv_array), \
216 .info = snd_soc_info_volsw, \
217 .get = xhandler_get, .put = xhandler_put, \
460acbec 218 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
57295073 219 xmax, xinvert, 0) }
3ce91d5a
JS
220#define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
221 xhandler_get, xhandler_put, tlv_array) \
222{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
223 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
224 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
225 .tlv.p = (tlv_array), \
e8f5a103 226 .info = snd_soc_info_volsw, \
3ce91d5a 227 .get = xhandler_get, .put = xhandler_put, \
cdffa775
PU
228 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
229 xmax, xinvert) }
808db4a4
RP
230#define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
231{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
232 .info = snd_soc_info_bool_ext, \
233 .get = xhandler_get, .put = xhandler_put, \
234 .private_value = xdata }
235#define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
236{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
9a953e6f 237 .info = snd_soc_info_enum_double, \
808db4a4
RP
238 .get = xhandler_get, .put = xhandler_put, \
239 .private_value = (unsigned long)&xenum }
240
71d08516
MB
241#define SND_SOC_BYTES(xname, xbase, xregs) \
242{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
243 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
244 .put = snd_soc_bytes_put, .private_value = \
245 ((unsigned long)&(struct soc_bytes) \
246 {.base = xbase, .num_regs = xregs }) }
b6f4bb38 247
f831b055
MB
248#define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask) \
249{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
250 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
251 .put = snd_soc_bytes_put, .private_value = \
252 ((unsigned long)&(struct soc_bytes) \
253 {.base = xbase, .num_regs = xregs, \
254 .mask = xmask }) }
255
4183eed2
KK
256#define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
257 xmin, xmax, xinvert) \
258{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
259 .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
260 .put = snd_soc_put_xr_sx, \
261 .private_value = (unsigned long)&(struct soc_mreg_control) \
262 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
263 .invert = xinvert, .min = xmin, .max = xmax} }
264
dd7b10b3
KK
265#define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
266 SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
267 snd_soc_get_strobe, snd_soc_put_strobe)
268
6c2fb6a8
GL
269/*
270 * Simplified versions of above macros, declaring a struct and calculating
271 * ARRAY_SIZE internally
272 */
273#define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
274 struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
275 ARRAY_SIZE(xtexts), xtexts)
276#define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
277 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
278#define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
279 struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
280#define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
281 struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
282 ARRAY_SIZE(xtexts), xtexts, xvalues)
283#define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
284 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
285
0168bf0d
LG
286/*
287 * Component probe and remove ordering levels for components with runtime
288 * dependencies.
289 */
290#define SND_SOC_COMP_ORDER_FIRST -2
291#define SND_SOC_COMP_ORDER_EARLY -1
292#define SND_SOC_COMP_ORDER_NORMAL 0
293#define SND_SOC_COMP_ORDER_LATE 1
294#define SND_SOC_COMP_ORDER_LAST 2
295
0be9898a
MB
296/*
297 * Bias levels
298 *
299 * @ON: Bias is fully on for audio playback and capture operations.
300 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
301 * stream start and stop operations.
302 * @STANDBY: Low power standby state when no playback/capture operations are
303 * in progress. NOTE: The transition time between STANDBY and ON
304 * should be as fast as possible and no longer than 10ms.
305 * @OFF: Power Off. No restrictions on transition times.
306 */
307enum snd_soc_bias_level {
56fba41f
MB
308 SND_SOC_BIAS_OFF = 0,
309 SND_SOC_BIAS_STANDBY = 1,
310 SND_SOC_BIAS_PREPARE = 2,
311 SND_SOC_BIAS_ON = 3,
0be9898a
MB
312};
313
5a504963 314struct device_node;
8a2cd618
MB
315struct snd_jack;
316struct snd_soc_card;
808db4a4
RP
317struct snd_soc_pcm_stream;
318struct snd_soc_ops;
808db4a4 319struct snd_soc_pcm_runtime;
3c4b266f 320struct snd_soc_dai;
f0fba2ad 321struct snd_soc_dai_driver;
12a48a8c 322struct snd_soc_platform;
d273ebe7 323struct snd_soc_dai_link;
f0fba2ad 324struct snd_soc_platform_driver;
808db4a4 325struct snd_soc_codec;
f0fba2ad 326struct snd_soc_codec_driver;
030e79f6
KM
327struct snd_soc_component;
328struct snd_soc_component_driver;
808db4a4 329struct soc_enum;
8a2cd618 330struct snd_soc_jack;
fa9879ed 331struct snd_soc_jack_zone;
8a2cd618 332struct snd_soc_jack_pin;
7a30a3db 333struct snd_soc_cache_ops;
ce6120cc 334#include <sound/soc-dapm.h>
01d7584c 335#include <sound/soc-dpcm.h>
f0fba2ad 336
ec67624d
LCM
337#ifdef CONFIG_GPIOLIB
338struct snd_soc_jack_gpio;
339#endif
808db4a4
RP
340
341typedef int (*hw_write_t)(void *,const char* ,int);
808db4a4 342
b047e1cc 343extern struct snd_ac97_bus_ops *soc_ac97_ops;
808db4a4 344
7084a42b 345enum snd_soc_control_type {
e9c03905 346 SND_SOC_I2C = 1,
7084a42b 347 SND_SOC_SPI,
0671da18 348 SND_SOC_REGMAP,
7084a42b
MB
349};
350
7a30a3db 351enum snd_soc_compress_type {
119bd789 352 SND_SOC_FLAT_COMPRESSION = 1,
7a30a3db
DP
353};
354
b8c0dab9
LG
355enum snd_soc_pcm_subclass {
356 SND_SOC_PCM_CLASS_PCM = 0,
357 SND_SOC_PCM_CLASS_BE = 1,
358};
359
01b9d99a 360enum snd_soc_card_subclass {
6874a918
LG
361 SND_SOC_CARD_CLASS_INIT = 0,
362 SND_SOC_CARD_CLASS_RUNTIME = 1,
01b9d99a
LG
363};
364
ec4ee52a 365int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
da1c6ea6 366 int source, unsigned int freq, int dir);
ec4ee52a
MB
367int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
368 unsigned int freq_in, unsigned int freq_out);
369
70a7ca34
VK
370int snd_soc_register_card(struct snd_soc_card *card);
371int snd_soc_unregister_card(struct snd_soc_card *card);
6f8ab4ac
MB
372int snd_soc_suspend(struct device *dev);
373int snd_soc_resume(struct device *dev);
374int snd_soc_poweroff(struct device *dev);
f0fba2ad 375int snd_soc_register_platform(struct device *dev,
d79e57db 376 const struct snd_soc_platform_driver *platform_drv);
f0fba2ad 377void snd_soc_unregister_platform(struct device *dev);
71a45cda
LPC
378int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
379 const struct snd_soc_platform_driver *platform_drv);
380void snd_soc_remove_platform(struct snd_soc_platform *platform);
381struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev);
f0fba2ad 382int snd_soc_register_codec(struct device *dev,
001ae4c0 383 const struct snd_soc_codec_driver *codec_drv,
f0fba2ad
LG
384 struct snd_soc_dai_driver *dai_drv, int num_dai);
385void snd_soc_unregister_codec(struct device *dev);
030e79f6
KM
386int snd_soc_register_component(struct device *dev,
387 const struct snd_soc_component_driver *cmpnt_drv,
388 struct snd_soc_dai_driver *dai_drv, int num_dai);
a0b03a61
MB
389int devm_snd_soc_register_component(struct device *dev,
390 const struct snd_soc_component_driver *cmpnt_drv,
391 struct snd_soc_dai_driver *dai_drv, int num_dai);
030e79f6 392void snd_soc_unregister_component(struct device *dev);
181e055e
MB
393int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
394 unsigned int reg);
239c9706
DP
395int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
396 unsigned int reg);
397int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
398 unsigned int reg);
17a52fd6 399int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
7084a42b
MB
400 int addr_bits, int data_bits,
401 enum snd_soc_control_type control);
7a30a3db
DP
402int snd_soc_cache_sync(struct snd_soc_codec *codec);
403int snd_soc_cache_init(struct snd_soc_codec *codec);
404int snd_soc_cache_exit(struct snd_soc_codec *codec);
405int snd_soc_cache_write(struct snd_soc_codec *codec,
406 unsigned int reg, unsigned int value);
407int snd_soc_cache_read(struct snd_soc_codec *codec,
408 unsigned int reg, unsigned int *value);
066d16c3
DP
409int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
410 unsigned int reg);
411int snd_soc_default_readable_register(struct snd_soc_codec *codec,
412 unsigned int reg);
8020454c
DP
413int snd_soc_default_writable_register(struct snd_soc_codec *codec,
414 unsigned int reg);
f1442bc1
LG
415int snd_soc_platform_read(struct snd_soc_platform *platform,
416 unsigned int reg);
417int snd_soc_platform_write(struct snd_soc_platform *platform,
418 unsigned int reg, unsigned int val);
354a2142 419int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
49681077 420int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
12a48a8c 421
47c88fff
LG
422struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
423 const char *dai_link, int stream);
424struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
425 const char *dai_link);
426
7aae816d
MB
427/* Utility functions to get clock rates from various things */
428int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
429int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
c0fa59df 430int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
7aae816d
MB
431int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
432
808db4a4
RP
433/* set runtime hw params */
434int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
435 const struct snd_pcm_hardware *hw);
808db4a4 436
07bf84aa
LG
437int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
438 int cmd, struct snd_soc_platform *platform);
439
8a2cd618 440/* Jack reporting */
f0fba2ad 441int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
8a2cd618
MB
442 struct snd_soc_jack *jack);
443void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
444int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
445 struct snd_soc_jack_pin *pins);
d5021ec9
MB
446void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
447 struct notifier_block *nb);
448void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
449 struct notifier_block *nb);
fa9879ed
VK
450int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
451 struct snd_soc_jack_zone *zones);
452int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
ec67624d
LCM
453#ifdef CONFIG_GPIOLIB
454int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
455 struct snd_soc_jack_gpio *gpios);
456void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
457 struct snd_soc_jack_gpio *gpios);
458#endif
8a2cd618 459
808db4a4
RP
460/* codec register bit access */
461int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
46f5822f 462 unsigned int mask, unsigned int value);
dd1b3d53
MB
463int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
464 unsigned short reg, unsigned int mask,
465 unsigned int value);
808db4a4 466int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
46f5822f 467 unsigned int mask, unsigned int value);
808db4a4
RP
468
469int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
470 struct snd_ac97_bus_ops *ops, int num);
471void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
472
b047e1cc 473int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
741a509f
MP
474int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
475 struct platform_device *pdev);
b047e1cc 476
808db4a4
RP
477/*
478 *Controls
479 */
480struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
3056557f 481 void *data, const char *long_name,
efb7ac3f 482 const char *prefix);
4fefd698
DP
483struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
484 const char *name);
022658be 485int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
3e8e1952 486 const struct snd_kcontrol_new *controls, int num_controls);
a491a5c8
LG
487int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
488 const struct snd_kcontrol_new *controls, int num_controls);
022658be
LG
489int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
490 const struct snd_kcontrol_new *controls, int num_controls);
491int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
492 const struct snd_kcontrol_new *controls, int num_controls);
808db4a4
RP
493int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
494 struct snd_ctl_elem_info *uinfo);
808db4a4
RP
495int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
496 struct snd_ctl_elem_value *ucontrol);
497int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
498 struct snd_ctl_elem_value *ucontrol);
2e72f8e3
PU
499int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
500 struct snd_ctl_elem_value *ucontrol);
501int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
502 struct snd_ctl_elem_value *ucontrol);
808db4a4 503int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
808db4a4 504 struct snd_ctl_elem_info *uinfo);
392abe9c 505#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
808db4a4
RP
506int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
507 struct snd_ctl_elem_value *ucontrol);
508int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
509 struct snd_ctl_elem_value *ucontrol);
a92f1394
PU
510#define snd_soc_get_volsw_2r snd_soc_get_volsw
511#define snd_soc_put_volsw_2r snd_soc_put_volsw
1d99f243
BA
512int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
513 struct snd_ctl_elem_value *ucontrol);
514int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
515 struct snd_ctl_elem_value *ucontrol);
e13ac2e9
MB
516int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
517 struct snd_ctl_elem_info *uinfo);
518int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
519 struct snd_ctl_elem_value *ucontrol);
520int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
521 struct snd_ctl_elem_value *ucontrol);
6c9d8cf6
AT
522int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
523 struct snd_ctl_elem_info *uinfo);
524int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
525 struct snd_ctl_elem_value *ucontrol);
526int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
527 struct snd_ctl_elem_value *ucontrol);
637d3847
PU
528int snd_soc_limit_volume(struct snd_soc_codec *codec,
529 const char *name, int max);
71d08516
MB
530int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
531 struct snd_ctl_elem_info *uinfo);
532int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
533 struct snd_ctl_elem_value *ucontrol);
534int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
535 struct snd_ctl_elem_value *ucontrol);
4183eed2
KK
536int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
537 struct snd_ctl_elem_info *uinfo);
538int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
539 struct snd_ctl_elem_value *ucontrol);
540int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
541 struct snd_ctl_elem_value *ucontrol);
dd7b10b3
KK
542int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
543 struct snd_ctl_elem_value *ucontrol);
544int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
545 struct snd_ctl_elem_value *ucontrol);
808db4a4 546
066d16c3
DP
547/**
548 * struct snd_soc_reg_access - Describes whether a given register is
549 * readable, writable or volatile.
550 *
551 * @reg: the register number
552 * @read: whether this register is readable
553 * @write: whether this register is writable
554 * @vol: whether this register is volatile
555 */
556struct snd_soc_reg_access {
557 u16 reg;
558 u16 read;
559 u16 write;
560 u16 vol;
561};
562
8a2cd618
MB
563/**
564 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
565 *
566 * @pin: name of the pin to update
567 * @mask: bits to check for in reported jack status
568 * @invert: if non-zero then pin is enabled when status is not reported
569 */
570struct snd_soc_jack_pin {
571 struct list_head list;
572 const char *pin;
573 int mask;
574 bool invert;
575};
576
fa9879ed
VK
577/**
578 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
579 *
580 * @min_mv: start voltage in mv
581 * @max_mv: end voltage in mv
582 * @jack_type: type of jack that is expected for this voltage
583 * @debounce_time: debounce_time for jack, codec driver should wait for this
584 * duration before reading the adc for voltages
585 * @:list: list container
586 */
587struct snd_soc_jack_zone {
588 unsigned int min_mv;
589 unsigned int max_mv;
590 unsigned int jack_type;
591 unsigned int debounce_time;
592 struct list_head list;
593};
594
ec67624d
LCM
595/**
596 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
597 *
598 * @gpio: gpio number
599 * @name: gpio name
600 * @report: value to report when jack detected
601 * @invert: report presence in low state
602 * @debouce_time: debouce time in ms
7887ab3a 603 * @wake: enable as wake source
fadddc87
MB
604 * @jack_status_check: callback function which overrides the detection
605 * to provide more complex checks (eg, reading an
606 * ADC).
ec67624d
LCM
607 */
608#ifdef CONFIG_GPIOLIB
609struct snd_soc_jack_gpio {
610 unsigned int gpio;
611 const char *name;
612 int report;
613 int invert;
614 int debounce_time;
7887ab3a
MB
615 bool wake;
616
ec67624d 617 struct snd_soc_jack *jack;
4c14d78e 618 struct delayed_work work;
c871a053
JS
619
620 int (*jack_status_check)(void);
ec67624d
LCM
621};
622#endif
623
8a2cd618 624struct snd_soc_jack {
2667b4b8 625 struct mutex mutex;
8a2cd618 626 struct snd_jack *jack;
f0fba2ad 627 struct snd_soc_codec *codec;
8a2cd618
MB
628 struct list_head pins;
629 int status;
d5021ec9 630 struct blocking_notifier_head notifier;
fa9879ed 631 struct list_head jack_zones;
8a2cd618
MB
632};
633
808db4a4
RP
634/* SoC PCM stream information */
635struct snd_soc_pcm_stream {
f0fba2ad 636 const char *stream_name;
1c433fbd
GG
637 u64 formats; /* SNDRV_PCM_FMTBIT_* */
638 unsigned int rates; /* SNDRV_PCM_RATE_* */
808db4a4
RP
639 unsigned int rate_min; /* min rate */
640 unsigned int rate_max; /* max rate */
641 unsigned int channels_min; /* min channels */
642 unsigned int channels_max; /* max channels */
58ba9b25 643 unsigned int sig_bits; /* number of bits of content */
808db4a4
RP
644};
645
646/* SoC audio ops */
647struct snd_soc_ops {
648 int (*startup)(struct snd_pcm_substream *);
649 void (*shutdown)(struct snd_pcm_substream *);
650 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
651 int (*hw_free)(struct snd_pcm_substream *);
652 int (*prepare)(struct snd_pcm_substream *);
653 int (*trigger)(struct snd_pcm_substream *, int);
654};
655
49681077
VK
656struct snd_soc_compr_ops {
657 int (*startup)(struct snd_compr_stream *);
658 void (*shutdown)(struct snd_compr_stream *);
659 int (*set_params)(struct snd_compr_stream *);
660 int (*trigger)(struct snd_compr_stream *);
661};
662
7a30a3db
DP
663/* SoC cache ops */
664struct snd_soc_cache_ops {
0d735eaa 665 const char *name;
7a30a3db
DP
666 enum snd_soc_compress_type id;
667 int (*init)(struct snd_soc_codec *codec);
668 int (*exit)(struct snd_soc_codec *codec);
669 int (*read)(struct snd_soc_codec *codec, unsigned int reg,
670 unsigned int *value);
671 int (*write)(struct snd_soc_codec *codec, unsigned int reg,
672 unsigned int value);
673 int (*sync)(struct snd_soc_codec *codec);
674};
675
f0fba2ad 676/* SoC Audio Codec device */
808db4a4 677struct snd_soc_codec {
f0fba2ad 678 const char *name;
ead9b919 679 const char *name_prefix;
f0fba2ad 680 int id;
0d0cf00a 681 struct device *dev;
001ae4c0 682 const struct snd_soc_codec_driver *driver;
0d0cf00a 683
f0fba2ad
LG
684 struct mutex mutex;
685 struct snd_soc_card *card;
0d0cf00a 686 struct list_head list;
f0fba2ad
LG
687 struct list_head card_list;
688 int num_dai;
23bbce34 689 enum snd_soc_compress_type compress_type;
aea170a0 690 size_t reg_size; /* reg_cache_size * reg_word_size */
1500b7b5
DP
691 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
692 int (*readable_register)(struct snd_soc_codec *, unsigned int);
8020454c 693 int (*writable_register)(struct snd_soc_codec *, unsigned int);
808db4a4
RP
694
695 /* runtime */
808db4a4
RP
696 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
697 unsigned int active;
dad8e7ae 698 unsigned int cache_bypass:1; /* Suppress access to the cache */
f0fba2ad
LG
699 unsigned int suspended:1; /* Codec is in suspend PM state */
700 unsigned int probed:1; /* Codec has been probed */
701 unsigned int ac97_registered:1; /* Codec has been AC97 registered */
0562f788 702 unsigned int ac97_created:1; /* Codec has been created by SoC */
fdf0f54d 703 unsigned int cache_init:1; /* codec cache has been initialized */
8a713da8 704 unsigned int using_regmap:1; /* using regmap access */
aaee8ef1
MB
705 u32 cache_only; /* Suppress writes to hardware */
706 u32 cache_sync; /* Cache needs to be synced to hardware */
808db4a4
RP
707
708 /* codec IO */
709 void *control_data; /* codec control (i2c/3wire) data */
808db4a4 710 hw_write_t hw_write;
afa2f106 711 unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
c3acec26
MB
712 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
713 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
5fb609d4 714 int (*bulk_write_raw)(struct snd_soc_codec *, unsigned int, const void *, size_t);
808db4a4 715 void *reg_cache;
3335ddca 716 const void *reg_def_copy;
7a30a3db
DP
717 const struct snd_soc_cache_ops *cache_ops;
718 struct mutex cache_rw_mutex;
be3ea3b9 719 int val_bytes;
a96ca338 720
808db4a4 721 /* dapm */
ce6120cc 722 struct snd_soc_dapm_context dapm;
1d69c5c5 723 unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
808db4a4 724
384c89e2 725#ifdef CONFIG_DEBUG_FS
88439ac7 726 struct dentry *debugfs_codec_root;
384c89e2 727 struct dentry *debugfs_reg;
384c89e2 728#endif
808db4a4
RP
729};
730
f0fba2ad
LG
731/* codec driver */
732struct snd_soc_codec_driver {
733
734 /* driver ops */
735 int (*probe)(struct snd_soc_codec *);
736 int (*remove)(struct snd_soc_codec *);
84b315ee 737 int (*suspend)(struct snd_soc_codec *);
f0fba2ad
LG
738 int (*resume)(struct snd_soc_codec *);
739
b7af1daf
MB
740 /* Default control and setup, added after probe() is run */
741 const struct snd_kcontrol_new *controls;
742 int num_controls;
89b95ac0
MB
743 const struct snd_soc_dapm_widget *dapm_widgets;
744 int num_dapm_widgets;
745 const struct snd_soc_dapm_route *dapm_routes;
746 int num_dapm_routes;
747
ec4ee52a
MB
748 /* codec wide operations */
749 int (*set_sysclk)(struct snd_soc_codec *codec,
da1c6ea6 750 int clk_id, int source, unsigned int freq, int dir);
ec4ee52a
MB
751 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
752 unsigned int freq_in, unsigned int freq_out);
753
f0fba2ad
LG
754 /* codec IO */
755 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
756 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
757 int (*display_register)(struct snd_soc_codec *, char *,
758 size_t, unsigned int);
d4754ec9
DP
759 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
760 int (*readable_register)(struct snd_soc_codec *, unsigned int);
8020454c 761 int (*writable_register)(struct snd_soc_codec *, unsigned int);
4a8923ba 762 unsigned int reg_cache_size;
f0fba2ad
LG
763 short reg_cache_step;
764 short reg_word_size;
765 const void *reg_cache_default;
066d16c3
DP
766 short reg_access_size;
767 const struct snd_soc_reg_access *reg_access_default;
7a30a3db 768 enum snd_soc_compress_type compress_type;
f0fba2ad
LG
769
770 /* codec bias level */
771 int (*set_bias_level)(struct snd_soc_codec *,
772 enum snd_soc_bias_level level);
33c5f969 773 bool idle_bias_off;
474b62d6
MB
774
775 void (*seq_notifier)(struct snd_soc_dapm_context *,
f85a9e0d 776 enum snd_soc_dapm_type, int);
0168bf0d 777
64a648c2
LG
778 /* codec stream completion event */
779 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
780
5124e69e
MB
781 bool ignore_pmdown_time; /* Doesn't benefit from pmdown delay */
782
0168bf0d
LG
783 /* probe ordering - for components with runtime dependencies */
784 int probe_order;
785 int remove_order;
808db4a4
RP
786};
787
788/* SoC platform interface */
f0fba2ad 789struct snd_soc_platform_driver {
808db4a4 790
f0fba2ad
LG
791 int (*probe)(struct snd_soc_platform *);
792 int (*remove)(struct snd_soc_platform *);
793 int (*suspend)(struct snd_soc_dai *dai);
794 int (*resume)(struct snd_soc_dai *dai);
808db4a4
RP
795
796 /* pcm creation and destruction */
552d1ef6 797 int (*pcm_new)(struct snd_soc_pcm_runtime *);
808db4a4
RP
798 void (*pcm_free)(struct snd_pcm *);
799
cb2cf612
LG
800 /* Default control and setup, added after probe() is run */
801 const struct snd_kcontrol_new *controls;
802 int num_controls;
803 const struct snd_soc_dapm_widget *dapm_widgets;
804 int num_dapm_widgets;
805 const struct snd_soc_dapm_route *dapm_routes;
806 int num_dapm_routes;
807
258020d0
PU
808 /*
809 * For platform caused delay reporting.
810 * Optional.
811 */
812 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
813 struct snd_soc_dai *);
814
49681077 815 /* platform stream pcm ops */
1f03f55b 816 const struct snd_pcm_ops *ops;
0168bf0d 817
49681077 818 /* platform stream compress ops */
ef03c9ae 819 const struct snd_compr_ops *compr_ops;
49681077 820
64a648c2
LG
821 /* platform stream completion event */
822 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
823
0168bf0d
LG
824 /* probe ordering - for components with runtime dependencies */
825 int probe_order;
826 int remove_order;
f1442bc1
LG
827
828 /* platform IO - used for platform DAPM */
829 unsigned int (*read)(struct snd_soc_platform *, unsigned int);
830 int (*write)(struct snd_soc_platform *, unsigned int, unsigned int);
07bf84aa 831 int (*bespoke_trigger)(struct snd_pcm_substream *, int);
808db4a4
RP
832};
833
f0fba2ad
LG
834struct snd_soc_platform {
835 const char *name;
836 int id;
837 struct device *dev;
d79e57db 838 const struct snd_soc_platform_driver *driver;
cc22d37e 839 struct mutex mutex;
808db4a4 840
f0fba2ad
LG
841 unsigned int suspended:1; /* platform is suspended */
842 unsigned int probed:1;
1c433fbd 843
f0fba2ad
LG
844 struct snd_soc_card *card;
845 struct list_head list;
846 struct list_head card_list;
b7950641
LG
847
848 struct snd_soc_dapm_context dapm;
731f1ab2
SG
849
850#ifdef CONFIG_DEBUG_FS
851 struct dentry *debugfs_platform_root;
731f1ab2 852#endif
f0fba2ad 853};
808db4a4 854
030e79f6 855struct snd_soc_component_driver {
61782e4f 856 const char *name;
030e79f6
KM
857};
858
859struct snd_soc_component {
860 const char *name;
861 int id;
862 int num_dai;
863 struct device *dev;
864 struct list_head list;
865
866 const struct snd_soc_component_driver *driver;
867};
868
f0fba2ad
LG
869struct snd_soc_dai_link {
870 /* config - must be set by machine driver */
871 const char *name; /* Codec name */
872 const char *stream_name; /* Stream name */
bc92657a
SW
873 /*
874 * You MAY specify the link's CPU-side device, either by device name,
875 * or by DT/OF node, but not both. If this information is omitted,
876 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
877 * must be globally unique. These fields are currently typically used
878 * only for codec to codec links, or systems using device tree.
879 */
880 const char *cpu_name;
881 const struct device_node *cpu_of_node;
882 /*
883 * You MAY specify the DAI name of the CPU DAI. If this information is
884 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
885 * only, which only works well when that device exposes a single DAI.
886 */
f0fba2ad 887 const char *cpu_dai_name;
bc92657a
SW
888 /*
889 * You MUST specify the link's codec, either by device name, or by
890 * DT/OF node, but not both.
891 */
892 const char *codec_name;
893 const struct device_node *codec_of_node;
894 /* You MUST specify the DAI name within the codec */
f0fba2ad 895 const char *codec_dai_name;
bc92657a
SW
896 /*
897 * You MAY specify the link's platform/PCM/DMA driver, either by
898 * device name, or by DT/OF node, but not both. Some forms of link
899 * do not need a platform.
900 */
901 const char *platform_name;
902 const struct device_node *platform_of_node;
01d7584c 903 int be_id; /* optional ID for machine driver BE identification */
4ccab3e7 904
c74184ed
MB
905 const struct snd_soc_pcm_stream *params;
906
75d9ac46
MB
907 unsigned int dai_fmt; /* format to set on init */
908
01d7584c
LG
909 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
910
3efab7dc
MB
911 /* Keep DAI active over suspend */
912 unsigned int ignore_suspend:1;
913
06f409d7
MB
914 /* Symmetry requirements */
915 unsigned int symmetric_rates:1;
916
01d7584c
LG
917 /* Do not create a PCM for this DAI link (Backend link) */
918 unsigned int no_pcm:1;
919
920 /* This DAI link can route to other DAI links at runtime (Frontend)*/
921 unsigned int dynamic:1;
922
e50fad4f 923 /* pmdown_time is ignored at stop */
924 unsigned int ignore_pmdown_time:1;
925
f0fba2ad
LG
926 /* codec/machine specific init - e.g. add machine controls */
927 int (*init)(struct snd_soc_pcm_runtime *rtd);
06f409d7 928
01d7584c
LG
929 /* optional hw_params re-writing for BE and FE sync */
930 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
931 struct snd_pcm_hw_params *params);
932
f0fba2ad 933 /* machine stream operations */
13aec722
LPC
934 const struct snd_soc_ops *ops;
935 const struct snd_soc_compr_ops *compr_ops;
d6bead02
FE
936
937 /* For unidirectional dai links */
938 bool playback_only;
939 bool capture_only;
808db4a4
RP
940};
941
ff819b83 942struct snd_soc_codec_conf {
ead9b919 943 const char *dev_name;
ff819b83
DP
944
945 /*
946 * optional map of kcontrol, widget and path name prefixes that are
947 * associated per device
948 */
ead9b919 949 const char *name_prefix;
ff819b83
DP
950
951 /*
952 * set this to the desired compression type if you want to
953 * override the one supplied in codec->driver->compress_type
954 */
955 enum snd_soc_compress_type compress_type;
ead9b919
JN
956};
957
2eea392d
JN
958struct snd_soc_aux_dev {
959 const char *name; /* Codec name */
960 const char *codec_name; /* for multi-codec */
961
962 /* codec/machine specific init - e.g. add machine controls */
963 int (*init)(struct snd_soc_dapm_context *dapm);
964};
965
87506549
MB
966/* SoC card */
967struct snd_soc_card {
f0fba2ad 968 const char *name;
22de71ba
LG
969 const char *long_name;
970 const char *driver_name;
c5af3a2e 971 struct device *dev;
f0fba2ad
LG
972 struct snd_card *snd_card;
973 struct module *owner;
c5af3a2e
MB
974
975 struct list_head list;
f0fba2ad 976 struct mutex mutex;
a73fb2df 977 struct mutex dapm_mutex;
c5af3a2e 978
f0fba2ad 979 bool instantiated;
808db4a4 980
e7361ec4 981 int (*probe)(struct snd_soc_card *card);
28e9ad92 982 int (*late_probe)(struct snd_soc_card *card);
e7361ec4 983 int (*remove)(struct snd_soc_card *card);
808db4a4
RP
984
985 /* the pre and post PM functions are used to do any PM work before and
986 * after the codec and DAI's do any PM work. */
70b2ac12
MB
987 int (*suspend_pre)(struct snd_soc_card *card);
988 int (*suspend_post)(struct snd_soc_card *card);
989 int (*resume_pre)(struct snd_soc_card *card);
990 int (*resume_post)(struct snd_soc_card *card);
808db4a4 991
0b4d221b 992 /* callbacks */
87506549 993 int (*set_bias_level)(struct snd_soc_card *,
d4c6005f 994 struct snd_soc_dapm_context *dapm,
0be9898a 995 enum snd_soc_bias_level level);
1badabd9 996 int (*set_bias_level_post)(struct snd_soc_card *,
d4c6005f 997 struct snd_soc_dapm_context *dapm,
1badabd9 998 enum snd_soc_bias_level level);
0b4d221b 999
6c5f1fed 1000 long pmdown_time;
96dd3622 1001
808db4a4
RP
1002 /* CPU <--> Codec DAI links */
1003 struct snd_soc_dai_link *dai_link;
1004 int num_links;
f0fba2ad
LG
1005 struct snd_soc_pcm_runtime *rtd;
1006 int num_rtd;
6308419a 1007
ff819b83
DP
1008 /* optional codec specific configuration */
1009 struct snd_soc_codec_conf *codec_conf;
1010 int num_configs;
ead9b919 1011
2eea392d
JN
1012 /*
1013 * optional auxiliary devices such as amplifiers or codecs with DAI
1014 * link unused
1015 */
1016 struct snd_soc_aux_dev *aux_dev;
1017 int num_aux_devs;
1018 struct snd_soc_pcm_runtime *rtd_aux;
1019 int num_aux_rtd;
1020
b7af1daf
MB
1021 const struct snd_kcontrol_new *controls;
1022 int num_controls;
1023
b8ad29de
MB
1024 /*
1025 * Card-specific routes and widgets.
1026 */
d06e48db 1027 const struct snd_soc_dapm_widget *dapm_widgets;
b8ad29de 1028 int num_dapm_widgets;
d06e48db 1029 const struct snd_soc_dapm_route *dapm_routes;
b8ad29de 1030 int num_dapm_routes;
1633281b 1031 bool fully_routed;
b8ad29de 1032
6308419a 1033 struct work_struct deferred_resume_work;
f0fba2ad
LG
1034
1035 /* lists of probed devices belonging to this card */
1036 struct list_head codec_dev_list;
1037 struct list_head platform_dev_list;
1038 struct list_head dai_dev_list;
a6052154 1039
97c866de 1040 struct list_head widgets;
8ddab3f5 1041 struct list_head paths;
7be31be8 1042 struct list_head dapm_list;
db432b41 1043 struct list_head dapm_dirty;
8ddab3f5 1044
e37a4970
MB
1045 /* Generic DAPM context for the card */
1046 struct snd_soc_dapm_context dapm;
de02d078 1047 struct snd_soc_dapm_stats dapm_stats;
564c6504 1048 struct snd_soc_dapm_update *update;
e37a4970 1049
a6052154
JN
1050#ifdef CONFIG_DEBUG_FS
1051 struct dentry *debugfs_card_root;
3a45b867 1052 struct dentry *debugfs_pop_time;
a6052154 1053#endif
3a45b867 1054 u32 pop_time;
dddf3e4c
MB
1055
1056 void *drvdata;
808db4a4
RP
1057};
1058
f0fba2ad 1059/* SoC machine DAI configuration, glues a codec and cpu DAI together */
d66a327d 1060struct snd_soc_pcm_runtime {
36ae1a96 1061 struct device *dev;
87506549 1062 struct snd_soc_card *card;
f0fba2ad 1063 struct snd_soc_dai_link *dai_link;
b8c0dab9
LG
1064 struct mutex pcm_mutex;
1065 enum snd_soc_pcm_subclass pcm_subclass;
1066 struct snd_pcm_ops ops;
f0fba2ad 1067
f0fba2ad 1068 unsigned int dev_registered:1;
808db4a4 1069
01d7584c
LG
1070 /* Dynamic PCM BE runtime data */
1071 struct snd_soc_dpcm_runtime dpcm[2];
1072
f0fba2ad 1073 long pmdown_time;
9bffb1fb 1074 unsigned char pop_wait:1;
f0fba2ad
LG
1075
1076 /* runtime devices */
1077 struct snd_pcm *pcm;
49681077 1078 struct snd_compr *compr;
f0fba2ad
LG
1079 struct snd_soc_codec *codec;
1080 struct snd_soc_platform *platform;
1081 struct snd_soc_dai *codec_dai;
1082 struct snd_soc_dai *cpu_dai;
1083
1084 struct delayed_work delayed_work;
f86dcef8
LG
1085#ifdef CONFIG_DEBUG_FS
1086 struct dentry *debugfs_dpcm_root;
1087 struct dentry *debugfs_dpcm_state;
1088#endif
808db4a4
RP
1089};
1090
4eaa9819
JS
1091/* mixer control */
1092struct soc_mixer_control {
d11bb4a9 1093 int min, max, platform_max;
57295073
LPC
1094 unsigned int reg, rreg, shift, rshift;
1095 unsigned int invert:1;
1096 unsigned int autodisable:1;
4eaa9819
JS
1097};
1098
71d08516
MB
1099struct soc_bytes {
1100 int base;
1101 int num_regs;
f831b055 1102 u32 mask;
71d08516
MB
1103};
1104
4183eed2
KK
1105/* multi register control */
1106struct soc_mreg_control {
1107 long min, max;
1108 unsigned int regbase, regcount, nbits, invert;
1109};
1110
808db4a4
RP
1111/* enumerated kcontrol */
1112struct soc_enum {
2e72f8e3
PU
1113 unsigned short reg;
1114 unsigned short reg2;
1115 unsigned char shift_l;
1116 unsigned char shift_r;
1117 unsigned int max;
1118 unsigned int mask;
87023ff7 1119 const char * const *texts;
2e72f8e3 1120 const unsigned int *values;
2e72f8e3
PU
1121};
1122
5c82f567 1123/* codec IO */
c3753707
MB
1124unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1125unsigned int snd_soc_write(struct snd_soc_codec *codec,
1126 unsigned int reg, unsigned int val);
5fb609d4
DP
1127unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
1128 unsigned int reg, const void *data, size_t len);
5c82f567 1129
f0fba2ad
LG
1130/* device driver data */
1131
dddf3e4c
MB
1132static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1133 void *data)
1134{
1135 card->drvdata = data;
1136}
1137
1138static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1139{
1140 return card->drvdata;
1141}
1142
b2c812e2 1143static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
f0fba2ad 1144 void *data)
b2c812e2 1145{
f0fba2ad 1146 dev_set_drvdata(codec->dev, data);
b2c812e2
MB
1147}
1148
1149static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1150{
f0fba2ad
LG
1151 return dev_get_drvdata(codec->dev);
1152}
1153
1154static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1155 void *data)
1156{
1157 dev_set_drvdata(platform->dev, data);
1158}
1159
1160static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1161{
1162 return dev_get_drvdata(platform->dev);
1163}
1164
1165static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1166 void *data)
1167{
36ae1a96 1168 dev_set_drvdata(rtd->dev, data);
f0fba2ad
LG
1169}
1170
1171static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1172{
36ae1a96 1173 return dev_get_drvdata(rtd->dev);
b2c812e2
MB
1174}
1175
4e10bda0
VK
1176static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1177{
1178 INIT_LIST_HEAD(&card->dai_dev_list);
1179 INIT_LIST_HEAD(&card->codec_dev_list);
1180 INIT_LIST_HEAD(&card->platform_dev_list);
1181 INIT_LIST_HEAD(&card->widgets);
1182 INIT_LIST_HEAD(&card->paths);
1183 INIT_LIST_HEAD(&card->dapm_list);
1184}
1185
30d86ba4
PU
1186static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1187{
1188 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1189 return 0;
1190 /*
1191 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1192 * mc->reg != mc->rreg means that the control is
1193 * stereo (bits in one register or in two registers)
1194 */
1195 return 1;
1196}
1197
fb257897
MB
1198int snd_soc_util_init(void);
1199void snd_soc_util_exit(void);
1200
bec4fa05
SW
1201int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1202 const char *propname);
a4a54dd5
SW
1203int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1204 const char *propname);
a7930ed4
KM
1205unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1206 const char *prefix);
bec4fa05 1207
a47cbe72
MB
1208#include <sound/soc-dai.h>
1209
faff4bb0 1210#ifdef CONFIG_DEBUG_FS
8a9dab1a 1211extern struct dentry *snd_soc_debugfs_root;
faff4bb0
SW
1212#endif
1213
6f8ab4ac
MB
1214extern const struct dev_pm_ops snd_soc_pm_ops;
1215
808db4a4 1216#endif