2 * linux/sound/soc.h -- ALSA SoC Layer
4 * Author: Liam Girdwood
5 * Created: Aug 11th 2005
6 * Copyright: Wolfson Microelectronics. PLC.
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.
13 #ifndef __LINUX_SND_SOC_H
14 #define __LINUX_SND_SOC_H
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>
29 * Convenience kcontrol builders
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, \
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, \
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, \
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, \
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, \
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, \
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, \
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, \
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 }
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 }) }
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, \
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} }
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)
227 * Simplified versions of above macros, declaring a struct and calculating
228 * ARRAY_SIZE internally
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)
244 * Component probe and remove ordering levels for components with runtime
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
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.
264 enum snd_soc_bias_level {
265 SND_SOC_BIAS_OFF = 0,
266 SND_SOC_BIAS_STANDBY = 1,
267 SND_SOC_BIAS_PREPARE = 2,
274 struct snd_soc_pcm_stream;
276 struct snd_soc_pcm_runtime;
278 struct snd_soc_dai_driver;
279 struct snd_soc_platform;
280 struct snd_soc_dai_link;
281 struct snd_soc_platform_driver;
282 struct snd_soc_codec;
283 struct snd_soc_codec_driver;
286 struct snd_soc_jack_zone;
287 struct snd_soc_jack_pin;
288 struct snd_soc_cache_ops;
289 #include <sound/soc-dapm.h>
290 #include <sound/soc-dpcm.h>
292 #ifdef CONFIG_GPIOLIB
293 struct snd_soc_jack_gpio;
296 typedef int (*hw_write_t)(void *,const char* ,int);
298 extern struct snd_ac97_bus_ops soc_ac97_ops;
300 enum snd_soc_control_type {
306 enum snd_soc_compress_type {
307 SND_SOC_FLAT_COMPRESSION = 1,
310 enum snd_soc_pcm_subclass {
311 SND_SOC_PCM_CLASS_PCM = 0,
312 SND_SOC_PCM_CLASS_BE = 1,
315 enum snd_soc_card_subclass {
316 SND_SOC_CARD_CLASS_INIT = 0,
317 SND_SOC_CARD_CLASS_RUNTIME = 1,
320 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
321 int source, unsigned int freq, int dir);
322 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
323 unsigned int freq_in, unsigned int freq_out);
325 int snd_soc_register_card(struct snd_soc_card *card);
326 int snd_soc_unregister_card(struct snd_soc_card *card);
327 int snd_soc_suspend(struct device *dev);
328 int snd_soc_resume(struct device *dev);
329 int snd_soc_poweroff(struct device *dev);
330 int snd_soc_register_platform(struct device *dev,
331 struct snd_soc_platform_driver *platform_drv);
332 void snd_soc_unregister_platform(struct device *dev);
333 int 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);
336 void snd_soc_unregister_codec(struct device *dev);
337 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
339 int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
341 int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
343 int 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);
346 int snd_soc_cache_sync(struct snd_soc_codec *codec);
347 int snd_soc_cache_init(struct snd_soc_codec *codec);
348 int snd_soc_cache_exit(struct snd_soc_codec *codec);
349 int snd_soc_cache_write(struct snd_soc_codec *codec,
350 unsigned int reg, unsigned int value);
351 int snd_soc_cache_read(struct snd_soc_codec *codec,
352 unsigned int reg, unsigned int *value);
353 int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
355 int snd_soc_default_readable_register(struct snd_soc_codec *codec,
357 int snd_soc_default_writable_register(struct snd_soc_codec *codec,
359 int snd_soc_platform_read(struct snd_soc_platform *platform,
361 int snd_soc_platform_write(struct snd_soc_platform *platform,
362 unsigned int reg, unsigned int val);
363 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
365 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
366 const char *dai_link, int stream);
367 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
368 const char *dai_link);
370 /* Utility functions to get clock rates from various things */
371 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
372 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
373 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
374 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
376 /* set runtime hw params */
377 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
378 const struct snd_pcm_hardware *hw);
380 int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
381 int cmd, struct snd_soc_platform *platform);
384 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
385 struct snd_soc_jack *jack);
386 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
387 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
388 struct snd_soc_jack_pin *pins);
389 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
390 struct notifier_block *nb);
391 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
392 struct notifier_block *nb);
393 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
394 struct snd_soc_jack_zone *zones);
395 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
396 #ifdef CONFIG_GPIOLIB
397 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
398 struct snd_soc_jack_gpio *gpios);
399 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
400 struct snd_soc_jack_gpio *gpios);
403 /* codec register bit access */
404 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
405 unsigned int mask, unsigned int value);
406 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
407 unsigned short reg, unsigned int mask,
409 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
410 unsigned int mask, unsigned int value);
412 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
413 struct snd_ac97_bus_ops *ops, int num);
414 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
419 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
420 void *data, const char *long_name,
422 int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
423 const struct snd_kcontrol_new *controls, int num_controls);
424 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
425 const struct snd_kcontrol_new *controls, int num_controls);
426 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
427 const struct snd_kcontrol_new *controls, int num_controls);
428 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
429 const struct snd_kcontrol_new *controls, int num_controls);
430 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
431 struct snd_ctl_elem_info *uinfo);
432 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
433 struct snd_ctl_elem_info *uinfo);
434 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
435 struct snd_ctl_elem_value *ucontrol);
436 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
437 struct snd_ctl_elem_value *ucontrol);
438 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
439 struct snd_ctl_elem_value *ucontrol);
440 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
441 struct snd_ctl_elem_value *ucontrol);
442 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
443 struct snd_ctl_elem_info *uinfo);
444 int 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
447 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
448 struct snd_ctl_elem_value *ucontrol);
449 int 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
453 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
454 struct snd_ctl_elem_value *ucontrol);
455 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
456 struct snd_ctl_elem_value *ucontrol);
457 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
458 struct snd_ctl_elem_info *uinfo);
459 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
460 struct snd_ctl_elem_value *ucontrol);
461 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
462 struct snd_ctl_elem_value *ucontrol);
463 int snd_soc_limit_volume(struct snd_soc_codec *codec,
464 const char *name, int max);
465 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
466 struct snd_ctl_elem_info *uinfo);
467 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
468 struct snd_ctl_elem_value *ucontrol);
469 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
470 struct snd_ctl_elem_value *ucontrol);
471 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
472 struct snd_ctl_elem_info *uinfo);
473 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
474 struct snd_ctl_elem_value *ucontrol);
475 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
476 struct snd_ctl_elem_value *ucontrol);
477 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
478 struct snd_ctl_elem_value *ucontrol);
479 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
480 struct snd_ctl_elem_value *ucontrol);
483 * struct snd_soc_reg_access - Describes whether a given register is
484 * readable, writable or volatile.
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
491 struct snd_soc_reg_access {
499 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
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
505 struct snd_soc_jack_pin {
506 struct list_head list;
513 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
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
522 struct snd_soc_jack_zone {
525 unsigned int jack_type;
526 unsigned int debounce_time;
527 struct list_head list;
531 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
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
543 #ifdef CONFIG_GPIOLIB
544 struct snd_soc_jack_gpio {
552 struct snd_soc_jack *jack;
553 struct delayed_work work;
555 int (*jack_status_check)(void);
559 struct snd_soc_jack {
561 struct snd_jack *jack;
562 struct snd_soc_codec *codec;
563 struct list_head pins;
565 struct blocking_notifier_head notifier;
566 struct list_head jack_zones;
569 /* SoC PCM stream information */
570 struct 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 */
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);
592 struct snd_soc_cache_ops {
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,
601 int (*sync)(struct snd_soc_codec *codec);
604 /* SoC Audio Codec device */
605 struct snd_soc_codec {
607 const char *name_prefix;
610 const struct snd_soc_codec_driver *driver;
613 struct snd_soc_card *card;
614 struct list_head list;
615 struct list_head card_list;
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);
624 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
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 */
638 void *control_data; /* codec control (i2c/3wire) data */
639 enum snd_soc_control_type control_type;
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);
646 const void *reg_def_copy;
647 const struct snd_soc_cache_ops *cache_ops;
648 struct mutex cache_rw_mutex;
652 struct snd_soc_dapm_context dapm;
653 unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
655 #ifdef CONFIG_DEBUG_FS
656 struct dentry *debugfs_codec_root;
657 struct dentry *debugfs_reg;
658 struct dentry *debugfs_dapm;
663 struct snd_soc_codec_driver {
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 *);
671 /* Default control and setup, added after probe() is run */
672 const struct snd_kcontrol_new *controls;
674 const struct snd_soc_dapm_widget *dapm_widgets;
675 int num_dapm_widgets;
676 const struct snd_soc_dapm_route *dapm_routes;
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);
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;
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;
701 /* codec bias level */
702 int (*set_bias_level)(struct snd_soc_codec *,
703 enum snd_soc_bias_level level);
706 void (*seq_notifier)(struct snd_soc_dapm_context *,
707 enum snd_soc_dapm_type, int);
709 /* codec stream completion event */
710 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
712 bool ignore_pmdown_time; /* Doesn't benefit from pmdown delay */
714 /* probe ordering - for components with runtime dependencies */
719 /* SoC platform interface */
720 struct snd_soc_platform_driver {
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);
727 /* pcm creation and destruction */
728 int (*pcm_new)(struct snd_soc_pcm_runtime *);
729 void (*pcm_free)(struct snd_pcm *);
731 /* Default control and setup, added after probe() is run */
732 const struct snd_kcontrol_new *controls;
734 const struct snd_soc_dapm_widget *dapm_widgets;
735 int num_dapm_widgets;
736 const struct snd_soc_dapm_route *dapm_routes;
740 * For platform caused delay reporting.
743 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
744 struct snd_soc_dai *);
746 /* platform stream ops */
747 struct snd_pcm_ops *ops;
749 /* platform stream completion event */
750 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
752 /* probe ordering - for components with runtime dependencies */
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);
762 struct snd_soc_platform {
766 struct snd_soc_platform_driver *driver;
769 unsigned int suspended:1; /* platform is suspended */
770 unsigned int probed:1;
772 struct snd_soc_card *card;
773 struct list_head list;
774 struct list_head card_list;
776 struct snd_soc_dapm_context dapm;
778 #ifdef CONFIG_DEBUG_FS
779 struct dentry *debugfs_platform_root;
780 struct dentry *debugfs_dapm;
784 struct 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 */
789 * You MAY specify the link's CPU-side device, either by device name,
790 * or by DT/OF node, but not both. If this information is omitted,
791 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
792 * must be globally unique. These fields are currently typically used
793 * only for codec to codec links, or systems using device tree.
795 const char *cpu_name;
796 const struct device_node *cpu_of_node;
798 * You MAY specify the DAI name of the CPU DAI. If this information is
799 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
800 * only, which only works well when that device exposes a single DAI.
802 const char *cpu_dai_name;
804 * You MUST specify the link's codec, either by device name, or by
805 * DT/OF node, but not both.
807 const char *codec_name;
808 const struct device_node *codec_of_node;
809 /* You MUST specify the DAI name within the codec */
810 const char *codec_dai_name;
812 * You MAY specify the link's platform/PCM/DMA driver, either by
813 * device name, or by DT/OF node, but not both. Some forms of link
814 * do not need a platform.
816 const char *platform_name;
817 const struct device_node *platform_of_node;
818 int be_id; /* optional ID for machine driver BE identification */
820 const struct snd_soc_pcm_stream *params;
822 unsigned int dai_fmt; /* format to set on init */
824 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
826 /* Keep DAI active over suspend */
827 unsigned int ignore_suspend:1;
829 /* Symmetry requirements */
830 unsigned int symmetric_rates:1;
832 /* Do not create a PCM for this DAI link (Backend link) */
833 unsigned int no_pcm:1;
835 /* This DAI link can route to other DAI links at runtime (Frontend)*/
836 unsigned int dynamic:1;
838 /* pmdown_time is ignored at stop */
839 unsigned int ignore_pmdown_time:1;
841 /* codec/machine specific init - e.g. add machine controls */
842 int (*init)(struct snd_soc_pcm_runtime *rtd);
844 /* optional hw_params re-writing for BE and FE sync */
845 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
846 struct snd_pcm_hw_params *params);
848 /* machine stream operations */
849 struct snd_soc_ops *ops;
852 struct snd_soc_codec_conf {
853 const char *dev_name;
856 * optional map of kcontrol, widget and path name prefixes that are
857 * associated per device
859 const char *name_prefix;
862 * set this to the desired compression type if you want to
863 * override the one supplied in codec->driver->compress_type
865 enum snd_soc_compress_type compress_type;
868 struct snd_soc_aux_dev {
869 const char *name; /* Codec name */
870 const char *codec_name; /* for multi-codec */
872 /* codec/machine specific init - e.g. add machine controls */
873 int (*init)(struct snd_soc_dapm_context *dapm);
877 struct snd_soc_card {
879 const char *long_name;
880 const char *driver_name;
882 struct snd_card *snd_card;
883 struct module *owner;
885 struct list_head list;
887 struct mutex dapm_mutex;
891 int (*probe)(struct snd_soc_card *card);
892 int (*late_probe)(struct snd_soc_card *card);
893 int (*remove)(struct snd_soc_card *card);
895 /* the pre and post PM functions are used to do any PM work before and
896 * after the codec and DAI's do any PM work. */
897 int (*suspend_pre)(struct snd_soc_card *card);
898 int (*suspend_post)(struct snd_soc_card *card);
899 int (*resume_pre)(struct snd_soc_card *card);
900 int (*resume_post)(struct snd_soc_card *card);
903 int (*set_bias_level)(struct snd_soc_card *,
904 struct snd_soc_dapm_context *dapm,
905 enum snd_soc_bias_level level);
906 int (*set_bias_level_post)(struct snd_soc_card *,
907 struct snd_soc_dapm_context *dapm,
908 enum snd_soc_bias_level level);
912 /* CPU <--> Codec DAI links */
913 struct snd_soc_dai_link *dai_link;
915 struct snd_soc_pcm_runtime *rtd;
918 /* optional codec specific configuration */
919 struct snd_soc_codec_conf *codec_conf;
923 * optional auxiliary devices such as amplifiers or codecs with DAI
926 struct snd_soc_aux_dev *aux_dev;
928 struct snd_soc_pcm_runtime *rtd_aux;
931 const struct snd_kcontrol_new *controls;
935 * Card-specific routes and widgets.
937 const struct snd_soc_dapm_widget *dapm_widgets;
938 int num_dapm_widgets;
939 const struct snd_soc_dapm_route *dapm_routes;
943 struct work_struct deferred_resume_work;
945 /* lists of probed devices belonging to this card */
946 struct list_head codec_dev_list;
947 struct list_head platform_dev_list;
948 struct list_head dai_dev_list;
950 struct list_head widgets;
951 struct list_head paths;
952 struct list_head dapm_list;
953 struct list_head dapm_dirty;
955 /* Generic DAPM context for the card */
956 struct snd_soc_dapm_context dapm;
957 struct snd_soc_dapm_stats dapm_stats;
959 #ifdef CONFIG_DEBUG_FS
960 struct dentry *debugfs_card_root;
961 struct dentry *debugfs_pop_time;
968 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
969 struct snd_soc_pcm_runtime {
971 struct snd_soc_card *card;
972 struct snd_soc_dai_link *dai_link;
973 struct mutex pcm_mutex;
974 enum snd_soc_pcm_subclass pcm_subclass;
975 struct snd_pcm_ops ops;
977 unsigned int dev_registered:1;
979 /* Dynamic PCM BE runtime data */
980 struct snd_soc_dpcm_runtime dpcm[2];
984 /* runtime devices */
986 struct snd_soc_codec *codec;
987 struct snd_soc_platform *platform;
988 struct snd_soc_dai *codec_dai;
989 struct snd_soc_dai *cpu_dai;
991 struct delayed_work delayed_work;
992 #ifdef CONFIG_DEBUG_FS
993 struct dentry *debugfs_dpcm_root;
994 struct dentry *debugfs_dpcm_state;
999 struct soc_mixer_control {
1000 int min, max, platform_max;
1001 unsigned int reg, rreg, shift, rshift, invert;
1010 /* multi register control */
1011 struct soc_mreg_control {
1013 unsigned int regbase, regcount, nbits, invert;
1016 /* enumerated kcontrol */
1019 unsigned short reg2;
1020 unsigned char shift_l;
1021 unsigned char shift_r;
1024 const char * const *texts;
1025 const unsigned int *values;
1030 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1031 unsigned int snd_soc_write(struct snd_soc_codec *codec,
1032 unsigned int reg, unsigned int val);
1033 unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
1034 unsigned int reg, const void *data, size_t len);
1036 /* device driver data */
1038 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1041 card->drvdata = data;
1044 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1046 return card->drvdata;
1049 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1052 dev_set_drvdata(codec->dev, data);
1055 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1057 return dev_get_drvdata(codec->dev);
1060 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1063 dev_set_drvdata(platform->dev, data);
1066 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1068 return dev_get_drvdata(platform->dev);
1071 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1074 dev_set_drvdata(rtd->dev, data);
1077 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1079 return dev_get_drvdata(rtd->dev);
1082 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1084 INIT_LIST_HEAD(&card->dai_dev_list);
1085 INIT_LIST_HEAD(&card->codec_dev_list);
1086 INIT_LIST_HEAD(&card->platform_dev_list);
1087 INIT_LIST_HEAD(&card->widgets);
1088 INIT_LIST_HEAD(&card->paths);
1089 INIT_LIST_HEAD(&card->dapm_list);
1092 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1094 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1097 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1098 * mc->reg != mc->rreg means that the control is
1099 * stereo (bits in one register or in two registers)
1104 int snd_soc_util_init(void);
1105 void snd_soc_util_exit(void);
1107 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1108 const char *propname);
1109 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1110 const char *propname);
1112 #include <sound/soc-dai.h>
1114 #ifdef CONFIG_DEBUG_FS
1115 extern struct dentry *snd_soc_debugfs_root;
1118 extern const struct dev_pm_ops snd_soc_pm_ops;