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