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