]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/sound/soc.h
ASoC: core: Use PTR_RET function
[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 */
460acbec 33#define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert) \
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, \
37 .invert = xinvert})
460acbec
PU
38#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
39 SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert)
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, \
a7a4ac86 55 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
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, \
71 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
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
PU
99 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
100 max, invert) }
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
PU
121 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
122 max, invert) }
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, \
f8ba0b7b 193 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
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
PU
199 .private_value = \
200 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert) }
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, \
f8ba0b7b 209 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
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
PU
218 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
219 xmax, xinvert) }
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, \
237 .info = snd_soc_info_enum_ext, \
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;
808db4a4 327struct soc_enum;
8a2cd618 328struct snd_soc_jack;
fa9879ed 329struct snd_soc_jack_zone;
8a2cd618 330struct snd_soc_jack_pin;
7a30a3db 331struct snd_soc_cache_ops;
ce6120cc 332#include <sound/soc-dapm.h>
01d7584c 333#include <sound/soc-dpcm.h>
f0fba2ad 334
ec67624d
LCM
335#ifdef CONFIG_GPIOLIB
336struct snd_soc_jack_gpio;
337#endif
808db4a4
RP
338
339typedef int (*hw_write_t)(void *,const char* ,int);
808db4a4
RP
340
341extern struct snd_ac97_bus_ops soc_ac97_ops;
342
7084a42b 343enum snd_soc_control_type {
e9c03905 344 SND_SOC_I2C = 1,
7084a42b 345 SND_SOC_SPI,
0671da18 346 SND_SOC_REGMAP,
7084a42b
MB
347};
348
7a30a3db 349enum snd_soc_compress_type {
119bd789 350 SND_SOC_FLAT_COMPRESSION = 1,
7a30a3db
DP
351};
352
b8c0dab9
LG
353enum snd_soc_pcm_subclass {
354 SND_SOC_PCM_CLASS_PCM = 0,
355 SND_SOC_PCM_CLASS_BE = 1,
356};
357
01b9d99a 358enum snd_soc_card_subclass {
6874a918
LG
359 SND_SOC_CARD_CLASS_INIT = 0,
360 SND_SOC_CARD_CLASS_RUNTIME = 1,
01b9d99a
LG
361};
362
ec4ee52a 363int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
da1c6ea6 364 int source, unsigned int freq, int dir);
ec4ee52a
MB
365int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
366 unsigned int freq_in, unsigned int freq_out);
367
70a7ca34
VK
368int snd_soc_register_card(struct snd_soc_card *card);
369int snd_soc_unregister_card(struct snd_soc_card *card);
6f8ab4ac
MB
370int snd_soc_suspend(struct device *dev);
371int snd_soc_resume(struct device *dev);
372int snd_soc_poweroff(struct device *dev);
f0fba2ad
LG
373int snd_soc_register_platform(struct device *dev,
374 struct snd_soc_platform_driver *platform_drv);
375void snd_soc_unregister_platform(struct device *dev);
376int snd_soc_register_codec(struct device *dev,
001ae4c0 377 const struct snd_soc_codec_driver *codec_drv,
f0fba2ad
LG
378 struct snd_soc_dai_driver *dai_drv, int num_dai);
379void snd_soc_unregister_codec(struct device *dev);
181e055e
MB
380int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
381 unsigned int reg);
239c9706
DP
382int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
383 unsigned int reg);
384int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
385 unsigned int reg);
17a52fd6 386int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
7084a42b
MB
387 int addr_bits, int data_bits,
388 enum snd_soc_control_type control);
7a30a3db
DP
389int snd_soc_cache_sync(struct snd_soc_codec *codec);
390int snd_soc_cache_init(struct snd_soc_codec *codec);
391int snd_soc_cache_exit(struct snd_soc_codec *codec);
392int snd_soc_cache_write(struct snd_soc_codec *codec,
393 unsigned int reg, unsigned int value);
394int snd_soc_cache_read(struct snd_soc_codec *codec,
395 unsigned int reg, unsigned int *value);
066d16c3
DP
396int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
397 unsigned int reg);
398int snd_soc_default_readable_register(struct snd_soc_codec *codec,
399 unsigned int reg);
8020454c
DP
400int snd_soc_default_writable_register(struct snd_soc_codec *codec,
401 unsigned int reg);
f1442bc1
LG
402int snd_soc_platform_read(struct snd_soc_platform *platform,
403 unsigned int reg);
404int snd_soc_platform_write(struct snd_soc_platform *platform,
405 unsigned int reg, unsigned int val);
354a2142 406int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
49681077 407int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
12a48a8c 408
47c88fff
LG
409struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
410 const char *dai_link, int stream);
411struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
412 const char *dai_link);
413
7aae816d
MB
414/* Utility functions to get clock rates from various things */
415int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
416int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
c0fa59df 417int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
7aae816d
MB
418int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
419
808db4a4
RP
420/* set runtime hw params */
421int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
422 const struct snd_pcm_hardware *hw);
808db4a4 423
07bf84aa
LG
424int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
425 int cmd, struct snd_soc_platform *platform);
426
8a2cd618 427/* Jack reporting */
f0fba2ad 428int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
8a2cd618
MB
429 struct snd_soc_jack *jack);
430void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
431int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
432 struct snd_soc_jack_pin *pins);
d5021ec9
MB
433void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
434 struct notifier_block *nb);
435void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
436 struct notifier_block *nb);
fa9879ed
VK
437int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
438 struct snd_soc_jack_zone *zones);
439int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
ec67624d
LCM
440#ifdef CONFIG_GPIOLIB
441int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
442 struct snd_soc_jack_gpio *gpios);
443void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
444 struct snd_soc_jack_gpio *gpios);
445#endif
8a2cd618 446
808db4a4
RP
447/* codec register bit access */
448int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
46f5822f 449 unsigned int mask, unsigned int value);
dd1b3d53
MB
450int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
451 unsigned short reg, unsigned int mask,
452 unsigned int value);
808db4a4 453int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
46f5822f 454 unsigned int mask, unsigned int value);
808db4a4
RP
455
456int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
457 struct snd_ac97_bus_ops *ops, int num);
458void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
459
460/*
461 *Controls
462 */
463struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
3056557f 464 void *data, const char *long_name,
efb7ac3f 465 const char *prefix);
022658be 466int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
3e8e1952 467 const struct snd_kcontrol_new *controls, int num_controls);
a491a5c8
LG
468int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
469 const struct snd_kcontrol_new *controls, int num_controls);
022658be
LG
470int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
471 const struct snd_kcontrol_new *controls, int num_controls);
472int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
473 const struct snd_kcontrol_new *controls, int num_controls);
808db4a4
RP
474int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
475 struct snd_ctl_elem_info *uinfo);
476int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
477 struct snd_ctl_elem_info *uinfo);
478int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
479 struct snd_ctl_elem_value *ucontrol);
480int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
481 struct snd_ctl_elem_value *ucontrol);
2e72f8e3
PU
482int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
483 struct snd_ctl_elem_value *ucontrol);
484int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
485 struct snd_ctl_elem_value *ucontrol);
808db4a4
RP
486int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
487 struct snd_ctl_elem_info *uinfo);
488int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
489 struct snd_ctl_elem_info *uinfo);
392abe9c 490#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
808db4a4
RP
491int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
492 struct snd_ctl_elem_value *ucontrol);
493int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
494 struct snd_ctl_elem_value *ucontrol);
a92f1394
PU
495#define snd_soc_get_volsw_2r snd_soc_get_volsw
496#define snd_soc_put_volsw_2r snd_soc_put_volsw
1d99f243
BA
497int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
498 struct snd_ctl_elem_value *ucontrol);
499int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
500 struct snd_ctl_elem_value *ucontrol);
e13ac2e9
MB
501int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
502 struct snd_ctl_elem_info *uinfo);
503int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
504 struct snd_ctl_elem_value *ucontrol);
505int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
506 struct snd_ctl_elem_value *ucontrol);
6c9d8cf6
AT
507int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
508 struct snd_ctl_elem_info *uinfo);
509int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
510 struct snd_ctl_elem_value *ucontrol);
511int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
512 struct snd_ctl_elem_value *ucontrol);
637d3847
PU
513int snd_soc_limit_volume(struct snd_soc_codec *codec,
514 const char *name, int max);
71d08516
MB
515int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
516 struct snd_ctl_elem_info *uinfo);
517int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
518 struct snd_ctl_elem_value *ucontrol);
519int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
520 struct snd_ctl_elem_value *ucontrol);
4183eed2
KK
521int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
522 struct snd_ctl_elem_info *uinfo);
523int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
524 struct snd_ctl_elem_value *ucontrol);
525int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
526 struct snd_ctl_elem_value *ucontrol);
dd7b10b3
KK
527int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
528 struct snd_ctl_elem_value *ucontrol);
529int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
530 struct snd_ctl_elem_value *ucontrol);
808db4a4 531
066d16c3
DP
532/**
533 * struct snd_soc_reg_access - Describes whether a given register is
534 * readable, writable or volatile.
535 *
536 * @reg: the register number
537 * @read: whether this register is readable
538 * @write: whether this register is writable
539 * @vol: whether this register is volatile
540 */
541struct snd_soc_reg_access {
542 u16 reg;
543 u16 read;
544 u16 write;
545 u16 vol;
546};
547
8a2cd618
MB
548/**
549 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
550 *
551 * @pin: name of the pin to update
552 * @mask: bits to check for in reported jack status
553 * @invert: if non-zero then pin is enabled when status is not reported
554 */
555struct snd_soc_jack_pin {
556 struct list_head list;
557 const char *pin;
558 int mask;
559 bool invert;
560};
561
fa9879ed
VK
562/**
563 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
564 *
565 * @min_mv: start voltage in mv
566 * @max_mv: end voltage in mv
567 * @jack_type: type of jack that is expected for this voltage
568 * @debounce_time: debounce_time for jack, codec driver should wait for this
569 * duration before reading the adc for voltages
570 * @:list: list container
571 */
572struct snd_soc_jack_zone {
573 unsigned int min_mv;
574 unsigned int max_mv;
575 unsigned int jack_type;
576 unsigned int debounce_time;
577 struct list_head list;
578};
579
ec67624d
LCM
580/**
581 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
582 *
583 * @gpio: gpio number
584 * @name: gpio name
585 * @report: value to report when jack detected
586 * @invert: report presence in low state
587 * @debouce_time: debouce time in ms
7887ab3a 588 * @wake: enable as wake source
fadddc87
MB
589 * @jack_status_check: callback function which overrides the detection
590 * to provide more complex checks (eg, reading an
591 * ADC).
ec67624d
LCM
592 */
593#ifdef CONFIG_GPIOLIB
594struct snd_soc_jack_gpio {
595 unsigned int gpio;
596 const char *name;
597 int report;
598 int invert;
599 int debounce_time;
7887ab3a
MB
600 bool wake;
601
ec67624d 602 struct snd_soc_jack *jack;
4c14d78e 603 struct delayed_work work;
c871a053
JS
604
605 int (*jack_status_check)(void);
ec67624d
LCM
606};
607#endif
608
8a2cd618 609struct snd_soc_jack {
2667b4b8 610 struct mutex mutex;
8a2cd618 611 struct snd_jack *jack;
f0fba2ad 612 struct snd_soc_codec *codec;
8a2cd618
MB
613 struct list_head pins;
614 int status;
d5021ec9 615 struct blocking_notifier_head notifier;
fa9879ed 616 struct list_head jack_zones;
8a2cd618
MB
617};
618
808db4a4
RP
619/* SoC PCM stream information */
620struct snd_soc_pcm_stream {
f0fba2ad 621 const char *stream_name;
1c433fbd
GG
622 u64 formats; /* SNDRV_PCM_FMTBIT_* */
623 unsigned int rates; /* SNDRV_PCM_RATE_* */
808db4a4
RP
624 unsigned int rate_min; /* min rate */
625 unsigned int rate_max; /* max rate */
626 unsigned int channels_min; /* min channels */
627 unsigned int channels_max; /* max channels */
58ba9b25 628 unsigned int sig_bits; /* number of bits of content */
808db4a4
RP
629};
630
631/* SoC audio ops */
632struct snd_soc_ops {
633 int (*startup)(struct snd_pcm_substream *);
634 void (*shutdown)(struct snd_pcm_substream *);
635 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
636 int (*hw_free)(struct snd_pcm_substream *);
637 int (*prepare)(struct snd_pcm_substream *);
638 int (*trigger)(struct snd_pcm_substream *, int);
639};
640
49681077
VK
641struct snd_soc_compr_ops {
642 int (*startup)(struct snd_compr_stream *);
643 void (*shutdown)(struct snd_compr_stream *);
644 int (*set_params)(struct snd_compr_stream *);
645 int (*trigger)(struct snd_compr_stream *);
646};
647
7a30a3db
DP
648/* SoC cache ops */
649struct snd_soc_cache_ops {
0d735eaa 650 const char *name;
7a30a3db
DP
651 enum snd_soc_compress_type id;
652 int (*init)(struct snd_soc_codec *codec);
653 int (*exit)(struct snd_soc_codec *codec);
654 int (*read)(struct snd_soc_codec *codec, unsigned int reg,
655 unsigned int *value);
656 int (*write)(struct snd_soc_codec *codec, unsigned int reg,
657 unsigned int value);
658 int (*sync)(struct snd_soc_codec *codec);
659};
660
f0fba2ad 661/* SoC Audio Codec device */
808db4a4 662struct snd_soc_codec {
f0fba2ad 663 const char *name;
ead9b919 664 const char *name_prefix;
f0fba2ad 665 int id;
0d0cf00a 666 struct device *dev;
001ae4c0 667 const struct snd_soc_codec_driver *driver;
0d0cf00a 668
f0fba2ad
LG
669 struct mutex mutex;
670 struct snd_soc_card *card;
0d0cf00a 671 struct list_head list;
f0fba2ad
LG
672 struct list_head card_list;
673 int num_dai;
23bbce34 674 enum snd_soc_compress_type compress_type;
aea170a0 675 size_t reg_size; /* reg_cache_size * reg_word_size */
1500b7b5
DP
676 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
677 int (*readable_register)(struct snd_soc_codec *, unsigned int);
8020454c 678 int (*writable_register)(struct snd_soc_codec *, unsigned int);
808db4a4
RP
679
680 /* runtime */
808db4a4
RP
681 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
682 unsigned int active;
dad8e7ae 683 unsigned int cache_bypass:1; /* Suppress access to the cache */
f0fba2ad
LG
684 unsigned int suspended:1; /* Codec is in suspend PM state */
685 unsigned int probed:1; /* Codec has been probed */
686 unsigned int ac97_registered:1; /* Codec has been AC97 registered */
0562f788 687 unsigned int ac97_created:1; /* Codec has been created by SoC */
f0fba2ad 688 unsigned int sysfs_registered:1; /* codec has been sysfs registered */
fdf0f54d 689 unsigned int cache_init:1; /* codec cache has been initialized */
8a713da8 690 unsigned int using_regmap:1; /* using regmap access */
aaee8ef1
MB
691 u32 cache_only; /* Suppress writes to hardware */
692 u32 cache_sync; /* Cache needs to be synced to hardware */
808db4a4
RP
693
694 /* codec IO */
695 void *control_data; /* codec control (i2c/3wire) data */
67850a89 696 enum snd_soc_control_type control_type;
808db4a4 697 hw_write_t hw_write;
afa2f106 698 unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
c3acec26
MB
699 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
700 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
5fb609d4 701 int (*bulk_write_raw)(struct snd_soc_codec *, unsigned int, const void *, size_t);
808db4a4 702 void *reg_cache;
3335ddca 703 const void *reg_def_copy;
7a30a3db
DP
704 const struct snd_soc_cache_ops *cache_ops;
705 struct mutex cache_rw_mutex;
be3ea3b9 706 int val_bytes;
a96ca338 707
808db4a4 708 /* dapm */
ce6120cc 709 struct snd_soc_dapm_context dapm;
1d69c5c5 710 unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
808db4a4 711
384c89e2 712#ifdef CONFIG_DEBUG_FS
88439ac7 713 struct dentry *debugfs_codec_root;
384c89e2 714 struct dentry *debugfs_reg;
79fb9387 715 struct dentry *debugfs_dapm;
384c89e2 716#endif
808db4a4
RP
717};
718
f0fba2ad
LG
719/* codec driver */
720struct snd_soc_codec_driver {
721
722 /* driver ops */
723 int (*probe)(struct snd_soc_codec *);
724 int (*remove)(struct snd_soc_codec *);
84b315ee 725 int (*suspend)(struct snd_soc_codec *);
f0fba2ad
LG
726 int (*resume)(struct snd_soc_codec *);
727
b7af1daf
MB
728 /* Default control and setup, added after probe() is run */
729 const struct snd_kcontrol_new *controls;
730 int num_controls;
89b95ac0
MB
731 const struct snd_soc_dapm_widget *dapm_widgets;
732 int num_dapm_widgets;
733 const struct snd_soc_dapm_route *dapm_routes;
734 int num_dapm_routes;
735
ec4ee52a
MB
736 /* codec wide operations */
737 int (*set_sysclk)(struct snd_soc_codec *codec,
da1c6ea6 738 int clk_id, int source, unsigned int freq, int dir);
ec4ee52a
MB
739 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
740 unsigned int freq_in, unsigned int freq_out);
741
f0fba2ad
LG
742 /* codec IO */
743 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
744 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
745 int (*display_register)(struct snd_soc_codec *, char *,
746 size_t, unsigned int);
d4754ec9
DP
747 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
748 int (*readable_register)(struct snd_soc_codec *, unsigned int);
8020454c 749 int (*writable_register)(struct snd_soc_codec *, unsigned int);
4a8923ba 750 unsigned int reg_cache_size;
f0fba2ad
LG
751 short reg_cache_step;
752 short reg_word_size;
753 const void *reg_cache_default;
066d16c3
DP
754 short reg_access_size;
755 const struct snd_soc_reg_access *reg_access_default;
7a30a3db 756 enum snd_soc_compress_type compress_type;
f0fba2ad
LG
757
758 /* codec bias level */
759 int (*set_bias_level)(struct snd_soc_codec *,
760 enum snd_soc_bias_level level);
33c5f969 761 bool idle_bias_off;
474b62d6
MB
762
763 void (*seq_notifier)(struct snd_soc_dapm_context *,
f85a9e0d 764 enum snd_soc_dapm_type, int);
0168bf0d 765
64a648c2
LG
766 /* codec stream completion event */
767 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
768
5124e69e
MB
769 bool ignore_pmdown_time; /* Doesn't benefit from pmdown delay */
770
0168bf0d
LG
771 /* probe ordering - for components with runtime dependencies */
772 int probe_order;
773 int remove_order;
808db4a4
RP
774};
775
776/* SoC platform interface */
f0fba2ad 777struct snd_soc_platform_driver {
808db4a4 778
f0fba2ad
LG
779 int (*probe)(struct snd_soc_platform *);
780 int (*remove)(struct snd_soc_platform *);
781 int (*suspend)(struct snd_soc_dai *dai);
782 int (*resume)(struct snd_soc_dai *dai);
808db4a4
RP
783
784 /* pcm creation and destruction */
552d1ef6 785 int (*pcm_new)(struct snd_soc_pcm_runtime *);
808db4a4
RP
786 void (*pcm_free)(struct snd_pcm *);
787
cb2cf612
LG
788 /* Default control and setup, added after probe() is run */
789 const struct snd_kcontrol_new *controls;
790 int num_controls;
791 const struct snd_soc_dapm_widget *dapm_widgets;
792 int num_dapm_widgets;
793 const struct snd_soc_dapm_route *dapm_routes;
794 int num_dapm_routes;
795
258020d0
PU
796 /*
797 * For platform caused delay reporting.
798 * Optional.
799 */
800 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
801 struct snd_soc_dai *);
802
49681077 803 /* platform stream pcm ops */
f0fba2ad 804 struct snd_pcm_ops *ops;
0168bf0d 805
49681077
VK
806 /* platform stream compress ops */
807 struct snd_compr_ops *compr_ops;
808
64a648c2
LG
809 /* platform stream completion event */
810 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
811
0168bf0d
LG
812 /* probe ordering - for components with runtime dependencies */
813 int probe_order;
814 int remove_order;
f1442bc1
LG
815
816 /* platform IO - used for platform DAPM */
817 unsigned int (*read)(struct snd_soc_platform *, unsigned int);
818 int (*write)(struct snd_soc_platform *, unsigned int, unsigned int);
07bf84aa 819 int (*bespoke_trigger)(struct snd_pcm_substream *, int);
808db4a4
RP
820};
821
f0fba2ad
LG
822struct snd_soc_platform {
823 const char *name;
824 int id;
825 struct device *dev;
826 struct snd_soc_platform_driver *driver;
cc22d37e 827 struct mutex mutex;
808db4a4 828
f0fba2ad
LG
829 unsigned int suspended:1; /* platform is suspended */
830 unsigned int probed:1;
1c433fbd 831
f0fba2ad
LG
832 struct snd_soc_card *card;
833 struct list_head list;
834 struct list_head card_list;
b7950641
LG
835
836 struct snd_soc_dapm_context dapm;
731f1ab2
SG
837
838#ifdef CONFIG_DEBUG_FS
839 struct dentry *debugfs_platform_root;
840 struct dentry *debugfs_dapm;
841#endif
f0fba2ad 842};
808db4a4 843
f0fba2ad
LG
844struct snd_soc_dai_link {
845 /* config - must be set by machine driver */
846 const char *name; /* Codec name */
847 const char *stream_name; /* Stream name */
bc92657a
SW
848 /*
849 * You MAY specify the link's CPU-side device, either by device name,
850 * or by DT/OF node, but not both. If this information is omitted,
851 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
852 * must be globally unique. These fields are currently typically used
853 * only for codec to codec links, or systems using device tree.
854 */
855 const char *cpu_name;
856 const struct device_node *cpu_of_node;
857 /*
858 * You MAY specify the DAI name of the CPU DAI. If this information is
859 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
860 * only, which only works well when that device exposes a single DAI.
861 */
f0fba2ad 862 const char *cpu_dai_name;
bc92657a
SW
863 /*
864 * You MUST specify the link's codec, either by device name, or by
865 * DT/OF node, but not both.
866 */
867 const char *codec_name;
868 const struct device_node *codec_of_node;
869 /* You MUST specify the DAI name within the codec */
f0fba2ad 870 const char *codec_dai_name;
bc92657a
SW
871 /*
872 * You MAY specify the link's platform/PCM/DMA driver, either by
873 * device name, or by DT/OF node, but not both. Some forms of link
874 * do not need a platform.
875 */
876 const char *platform_name;
877 const struct device_node *platform_of_node;
01d7584c 878 int be_id; /* optional ID for machine driver BE identification */
4ccab3e7 879
c74184ed
MB
880 const struct snd_soc_pcm_stream *params;
881
75d9ac46
MB
882 unsigned int dai_fmt; /* format to set on init */
883
01d7584c
LG
884 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
885
3efab7dc
MB
886 /* Keep DAI active over suspend */
887 unsigned int ignore_suspend:1;
888
06f409d7
MB
889 /* Symmetry requirements */
890 unsigned int symmetric_rates:1;
891
01d7584c
LG
892 /* Do not create a PCM for this DAI link (Backend link) */
893 unsigned int no_pcm:1;
894
895 /* This DAI link can route to other DAI links at runtime (Frontend)*/
896 unsigned int dynamic:1;
897
e50fad4f 898 /* pmdown_time is ignored at stop */
899 unsigned int ignore_pmdown_time:1;
900
f0fba2ad
LG
901 /* codec/machine specific init - e.g. add machine controls */
902 int (*init)(struct snd_soc_pcm_runtime *rtd);
06f409d7 903
01d7584c
LG
904 /* optional hw_params re-writing for BE and FE sync */
905 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
906 struct snd_pcm_hw_params *params);
907
f0fba2ad 908 /* machine stream operations */
13aec722
LPC
909 const struct snd_soc_ops *ops;
910 const struct snd_soc_compr_ops *compr_ops;
808db4a4
RP
911};
912
ff819b83 913struct snd_soc_codec_conf {
ead9b919 914 const char *dev_name;
ff819b83
DP
915
916 /*
917 * optional map of kcontrol, widget and path name prefixes that are
918 * associated per device
919 */
ead9b919 920 const char *name_prefix;
ff819b83
DP
921
922 /*
923 * set this to the desired compression type if you want to
924 * override the one supplied in codec->driver->compress_type
925 */
926 enum snd_soc_compress_type compress_type;
ead9b919
JN
927};
928
2eea392d
JN
929struct snd_soc_aux_dev {
930 const char *name; /* Codec name */
931 const char *codec_name; /* for multi-codec */
932
933 /* codec/machine specific init - e.g. add machine controls */
934 int (*init)(struct snd_soc_dapm_context *dapm);
935};
936
87506549
MB
937/* SoC card */
938struct snd_soc_card {
f0fba2ad 939 const char *name;
22de71ba
LG
940 const char *long_name;
941 const char *driver_name;
c5af3a2e 942 struct device *dev;
f0fba2ad
LG
943 struct snd_card *snd_card;
944 struct module *owner;
c5af3a2e
MB
945
946 struct list_head list;
f0fba2ad 947 struct mutex mutex;
a73fb2df 948 struct mutex dapm_mutex;
c5af3a2e 949
f0fba2ad 950 bool instantiated;
808db4a4 951
e7361ec4 952 int (*probe)(struct snd_soc_card *card);
28e9ad92 953 int (*late_probe)(struct snd_soc_card *card);
e7361ec4 954 int (*remove)(struct snd_soc_card *card);
808db4a4
RP
955
956 /* the pre and post PM functions are used to do any PM work before and
957 * after the codec and DAI's do any PM work. */
70b2ac12
MB
958 int (*suspend_pre)(struct snd_soc_card *card);
959 int (*suspend_post)(struct snd_soc_card *card);
960 int (*resume_pre)(struct snd_soc_card *card);
961 int (*resume_post)(struct snd_soc_card *card);
808db4a4 962
0b4d221b 963 /* callbacks */
87506549 964 int (*set_bias_level)(struct snd_soc_card *,
d4c6005f 965 struct snd_soc_dapm_context *dapm,
0be9898a 966 enum snd_soc_bias_level level);
1badabd9 967 int (*set_bias_level_post)(struct snd_soc_card *,
d4c6005f 968 struct snd_soc_dapm_context *dapm,
1badabd9 969 enum snd_soc_bias_level level);
0b4d221b 970
6c5f1fed 971 long pmdown_time;
96dd3622 972
808db4a4
RP
973 /* CPU <--> Codec DAI links */
974 struct snd_soc_dai_link *dai_link;
975 int num_links;
f0fba2ad
LG
976 struct snd_soc_pcm_runtime *rtd;
977 int num_rtd;
6308419a 978
ff819b83
DP
979 /* optional codec specific configuration */
980 struct snd_soc_codec_conf *codec_conf;
981 int num_configs;
ead9b919 982
2eea392d
JN
983 /*
984 * optional auxiliary devices such as amplifiers or codecs with DAI
985 * link unused
986 */
987 struct snd_soc_aux_dev *aux_dev;
988 int num_aux_devs;
989 struct snd_soc_pcm_runtime *rtd_aux;
990 int num_aux_rtd;
991
b7af1daf
MB
992 const struct snd_kcontrol_new *controls;
993 int num_controls;
994
b8ad29de
MB
995 /*
996 * Card-specific routes and widgets.
997 */
d06e48db 998 const struct snd_soc_dapm_widget *dapm_widgets;
b8ad29de 999 int num_dapm_widgets;
d06e48db 1000 const struct snd_soc_dapm_route *dapm_routes;
b8ad29de 1001 int num_dapm_routes;
1633281b 1002 bool fully_routed;
b8ad29de 1003
6308419a 1004 struct work_struct deferred_resume_work;
f0fba2ad
LG
1005
1006 /* lists of probed devices belonging to this card */
1007 struct list_head codec_dev_list;
1008 struct list_head platform_dev_list;
1009 struct list_head dai_dev_list;
a6052154 1010
97c866de 1011 struct list_head widgets;
8ddab3f5 1012 struct list_head paths;
7be31be8 1013 struct list_head dapm_list;
db432b41 1014 struct list_head dapm_dirty;
8ddab3f5 1015
e37a4970
MB
1016 /* Generic DAPM context for the card */
1017 struct snd_soc_dapm_context dapm;
de02d078 1018 struct snd_soc_dapm_stats dapm_stats;
e37a4970 1019
a6052154
JN
1020#ifdef CONFIG_DEBUG_FS
1021 struct dentry *debugfs_card_root;
3a45b867 1022 struct dentry *debugfs_pop_time;
a6052154 1023#endif
3a45b867 1024 u32 pop_time;
dddf3e4c
MB
1025
1026 void *drvdata;
808db4a4
RP
1027};
1028
f0fba2ad 1029/* SoC machine DAI configuration, glues a codec and cpu DAI together */
d66a327d 1030struct snd_soc_pcm_runtime {
36ae1a96 1031 struct device *dev;
87506549 1032 struct snd_soc_card *card;
f0fba2ad 1033 struct snd_soc_dai_link *dai_link;
b8c0dab9
LG
1034 struct mutex pcm_mutex;
1035 enum snd_soc_pcm_subclass pcm_subclass;
1036 struct snd_pcm_ops ops;
f0fba2ad 1037
f0fba2ad 1038 unsigned int dev_registered:1;
808db4a4 1039
01d7584c
LG
1040 /* Dynamic PCM BE runtime data */
1041 struct snd_soc_dpcm_runtime dpcm[2];
1042
f0fba2ad 1043 long pmdown_time;
9bffb1fb 1044 unsigned char pop_wait:1;
f0fba2ad
LG
1045
1046 /* runtime devices */
1047 struct snd_pcm *pcm;
49681077 1048 struct snd_compr *compr;
f0fba2ad
LG
1049 struct snd_soc_codec *codec;
1050 struct snd_soc_platform *platform;
1051 struct snd_soc_dai *codec_dai;
1052 struct snd_soc_dai *cpu_dai;
1053
1054 struct delayed_work delayed_work;
f86dcef8
LG
1055#ifdef CONFIG_DEBUG_FS
1056 struct dentry *debugfs_dpcm_root;
1057 struct dentry *debugfs_dpcm_state;
1058#endif
808db4a4
RP
1059};
1060
4eaa9819
JS
1061/* mixer control */
1062struct soc_mixer_control {
d11bb4a9 1063 int min, max, platform_max;
815ecf8d 1064 unsigned int reg, rreg, shift, rshift, invert;
4eaa9819
JS
1065};
1066
71d08516
MB
1067struct soc_bytes {
1068 int base;
1069 int num_regs;
f831b055 1070 u32 mask;
71d08516
MB
1071};
1072
4183eed2
KK
1073/* multi register control */
1074struct soc_mreg_control {
1075 long min, max;
1076 unsigned int regbase, regcount, nbits, invert;
1077};
1078
808db4a4
RP
1079/* enumerated kcontrol */
1080struct soc_enum {
2e72f8e3
PU
1081 unsigned short reg;
1082 unsigned short reg2;
1083 unsigned char shift_l;
1084 unsigned char shift_r;
1085 unsigned int max;
1086 unsigned int mask;
87023ff7 1087 const char * const *texts;
2e72f8e3 1088 const unsigned int *values;
2e72f8e3
PU
1089};
1090
5c82f567 1091/* codec IO */
c3753707
MB
1092unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1093unsigned int snd_soc_write(struct snd_soc_codec *codec,
1094 unsigned int reg, unsigned int val);
5fb609d4
DP
1095unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
1096 unsigned int reg, const void *data, size_t len);
5c82f567 1097
f0fba2ad
LG
1098/* device driver data */
1099
dddf3e4c
MB
1100static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1101 void *data)
1102{
1103 card->drvdata = data;
1104}
1105
1106static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1107{
1108 return card->drvdata;
1109}
1110
b2c812e2 1111static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
f0fba2ad 1112 void *data)
b2c812e2 1113{
f0fba2ad 1114 dev_set_drvdata(codec->dev, data);
b2c812e2
MB
1115}
1116
1117static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1118{
f0fba2ad
LG
1119 return dev_get_drvdata(codec->dev);
1120}
1121
1122static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1123 void *data)
1124{
1125 dev_set_drvdata(platform->dev, data);
1126}
1127
1128static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1129{
1130 return dev_get_drvdata(platform->dev);
1131}
1132
1133static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1134 void *data)
1135{
36ae1a96 1136 dev_set_drvdata(rtd->dev, data);
f0fba2ad
LG
1137}
1138
1139static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1140{
36ae1a96 1141 return dev_get_drvdata(rtd->dev);
b2c812e2
MB
1142}
1143
4e10bda0
VK
1144static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1145{
1146 INIT_LIST_HEAD(&card->dai_dev_list);
1147 INIT_LIST_HEAD(&card->codec_dev_list);
1148 INIT_LIST_HEAD(&card->platform_dev_list);
1149 INIT_LIST_HEAD(&card->widgets);
1150 INIT_LIST_HEAD(&card->paths);
1151 INIT_LIST_HEAD(&card->dapm_list);
1152}
1153
30d86ba4
PU
1154static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1155{
1156 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1157 return 0;
1158 /*
1159 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1160 * mc->reg != mc->rreg means that the control is
1161 * stereo (bits in one register or in two registers)
1162 */
1163 return 1;
1164}
1165
fb257897
MB
1166int snd_soc_util_init(void);
1167void snd_soc_util_exit(void);
1168
bec4fa05
SW
1169int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1170 const char *propname);
a4a54dd5
SW
1171int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1172 const char *propname);
a7930ed4
KM
1173unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1174 const char *prefix);
bec4fa05 1175
a47cbe72
MB
1176#include <sound/soc-dai.h>
1177
faff4bb0 1178#ifdef CONFIG_DEBUG_FS
8a9dab1a 1179extern struct dentry *snd_soc_debugfs_root;
faff4bb0
SW
1180#endif
1181
6f8ab4ac
MB
1182extern const struct dev_pm_ops snd_soc_pm_ops;
1183
808db4a4 1184#endif